node-v4.8.2/000755 000766 000024 00000000000 13070706740 012754 5ustar00iojsstaff000000 000000 node-v4.8.2/.editorconfig000644 000766 000024 00000001264 13070706727 015441 0ustar00iojsstaff000000 000000 root = true [*] end_of_line = lf charset = utf-8 trim_trailing_whitespace = true insert_final_newline = true [vcbuild.bat] end_of_line = crlf [*.{md,markdown}] trim_trailing_whitespace = false [{lib,src,test}/**.js] indent_style = space indent_size = 2 [src/**.{h,cc}] indent_style = space indent_size = 2 [test/*.py] indent_style = space indent_size = 2 [configure] indent_style = space indent_size = 2 [Makefile] indent_style = tab indent_size = 8 [{deps,tools}/**] indent_style = ignore indent_size = ignore end_of_line = ignore trim_trailing_whitespace = ignore charset = ignore [{test/fixtures,deps,tools/eslint,tools/gyp,tools/icu,tools/msvs}/**] insert_final_newline = false node-v4.8.2/.eslintignore000644 000766 000024 00000000223 13070706727 015461 0ustar00iojsstaff000000 000000 lib/internal/v8_prof_polyfill.js lib/punycode.js test/addons/??_*/ test/fixtures test/disabled test/tmp*/ tools/eslint node_modules benchmark/tmp/ node-v4.8.2/.eslintrc.yaml000644 000766 000024 00000006364 13070706727 015557 0ustar00iojsstaff000000 000000 env: node: true es6: true rules: # Possible Errors # http://eslint.org/docs/rules/#possible-errors comma-dangle: [2, "only-multiline"] no-control-regex: 2 no-debugger: 2 no-dupe-args: 2 no-dupe-keys: 2 no-duplicate-case: 2 no-empty-character-class: 2 no-ex-assign: 2 no-extra-boolean-cast: 2 no-extra-parens: [2, "functions"] no-extra-semi: 2 no-func-assign: 2 no-invalid-regexp: 2 no-irregular-whitespace: 2 no-negated-in-lhs: 2 no-obj-calls: 2 no-proto: 2 no-unexpected-multiline: 2 no-unreachable: 2 use-isnan: 2 valid-typeof: 2 # Best Practices # http://eslint.org/docs/rules/#best-practices no-fallthrough: 2 no-octal: 2 no-redeclare: 2 no-self-assign: 2 no-unused-labels: 2 # Strict Mode # http://eslint.org/docs/rules/#strict-mode strict: [2, "global"] # Variables # http://eslint.org/docs/rules/#variables no-delete-var: 2 no-undef: 2 no-unused-vars: [2, {"args": "none"}] # Node.js and CommonJS # http://eslint.org/docs/rules/#nodejs-and-commonjs no-mixed-requires: 2 no-new-require: 2 no-path-concat: 2 no-restricted-modules: [2, "sys", "_linklist"] # Stylistic Issues # http://eslint.org/docs/rules/#stylistic-issues brace-style: [2, "1tbs", {allowSingleLine: true}] comma-spacing: 2 eol-last: 2 indent: [2, 2, {SwitchCase: 1}] key-spacing: [2, {mode: "minimum"}] keyword-spacing: 2 max-len: [2, 80, 2] new-parens: 2 no-mixed-spaces-and-tabs: 2 no-multiple-empty-lines: [2, {max: 2}] no-trailing-spaces: 2 operator-linebreak: [2, after, {overrides: {'?': ignore, ':': ignore}}] quotes: [2, "single", "avoid-escape"] semi: 2 space-before-blocks: [2, "always"] space-before-function-paren: [2, "never"] space-in-parens: [2, "never"] space-infix-ops: 2 space-unary-ops: 2 # ECMAScript 6 # http://eslint.org/docs/rules/#ecmascript-6 arrow-parens: [2, "always"] arrow-spacing: [2, {"before": true, "after": true}] constructor-super: 2 no-class-assign: 2 no-confusing-arrow: 2 no-const-assign: 2 no-dupe-class-members: 2 no-new-symbol: 2 no-this-before-super: 2 prefer-const: 2 # Custom rules in tools/eslint-rules align-function-arguments: 2 align-multiline-assignment: 2 assert-fail-single-argument: 2 assert-throws-arguments: [2, { requireTwo: false }] new-with-error: [2, "Error", "RangeError", "TypeError", "SyntaxError", "ReferenceError"] # Global scoped method and vars globals: DTRACE_HTTP_CLIENT_REQUEST : false LTTNG_HTTP_CLIENT_REQUEST : false COUNTER_HTTP_CLIENT_REQUEST : false DTRACE_HTTP_CLIENT_RESPONSE : false LTTNG_HTTP_CLIENT_RESPONSE : false COUNTER_HTTP_CLIENT_RESPONSE : false DTRACE_HTTP_SERVER_REQUEST : false LTTNG_HTTP_SERVER_REQUEST : false COUNTER_HTTP_SERVER_REQUEST : false DTRACE_HTTP_SERVER_RESPONSE : false LTTNG_HTTP_SERVER_RESPONSE : false COUNTER_HTTP_SERVER_RESPONSE : false DTRACE_NET_STREAM_END : false LTTNG_NET_STREAM_END : false COUNTER_NET_SERVER_CONNECTION_CLOSE : false DTRACE_NET_SERVER_CONNECTION : false LTTNG_NET_SERVER_CONNECTION : false COUNTER_NET_SERVER_CONNECTION : false node-v4.8.2/.gitattributes000644 000766 000024 00000000060 13070706727 015650 0ustar00iojsstaff000000 000000 test/fixtures/* -text vcbuild.bat text eol=crlf node-v4.8.2/.gitignore000644 000766 000024 00000002613 13070706727 014753 0ustar00iojsstaff000000 000000 # Whitelist dotfiles .* !deps/**/.* !test/fixtures/**/.* !tools/eslint/**/.* !tools/doc/node_modules/**/.* !.editorconfig !.eslintignore !.eslintrc !.gitattributes !.github !.gitignore !.gitkeep !.mailmap !.remarkrc core vgcore.* v8*.log perf.data perf.data.old .waf* tags .lock-wscript *.pyc doc/api.xml tmp/ test/tmp*/ iojs iojs_g node node_g *.swp .benchmark_reports icu_config.gypi /out # various stuff that VC++ produces/uses Debug/ !**/node_modules/debug/ Release/ !doc/blog/** *.sln !nodemsi.sln *.suo *.vcproj *.vcxproj !custom_actions.vcxproj *.vcxproj.user *.vcxproj.filters UpgradeLog*.XML _UpgradeReport_Files/ ipch/ *.sdf *.opensdf *.VC.opendb .vs/ .vscode/ /config.mk /config.gypi /config_fips.gypi *-nodegyp* /gyp-mac-tool /dist-osx /npm.wxs /tools/msvs/npm.wixobj /tools/osx-pkg.pmdoc/index.xml /test/addons/??_*/ email.md deps/v8-* deps/icu deps/icu*.zip deps/icu*.tgz deps/icu-tmp ./node_modules android-toolchain/ .svn/ # generated by gyp on Windows deps/openssl/openssl.props deps/openssl/openssl.targets deps/openssl/openssl.xml # generated by gyp on android /*.target.mk /*.host.mk deps/openssl/openssl.target.mk deps/zlib/zlib.target.mk # not needed and causes issues for distro packagers deps/npm/node_modules/.bin/ # build/release artifacts /*.tar.* /SHASUMS*.txt* # test artifacts tools/faketime icu_config.gypi *.tap # Xcode workspaces and project folders *.xcodeproj *.xcworkspace node-v4.8.2/.mailmap000644 000766 000024 00000021534 13070706727 014407 0ustar00iojsstaff000000 000000 Aaron Heckmann Abe Fettig Alex Hultman Alex Kocharin Alex Kocharin Alexey Kupershtokh Alexis Campailla Alexis Sellier Alexis Sellier Andy Bettisworth Anna Henningsen Aria Stewart Arlo Breault Artem Zaytsev Arnout Kazemier <3rd-Eden@users.noreply.github.com> Atsuo Fukaya Ben Noordhuis Ben Taber Bert Belder Bert Belder Bert Belder Brandon Benvie Brian White Brian White Caleb Boyd Charles Chew Choon Keat Charles Rudolph Chris Johnson Claudio Rodriguez Colin Ihrig Christopher Lenz Dan Kaplun Daniel Berger Daniel Chcouri <333222@gmail.com> Daniel Gröber Daniel Gröber Daniel Pihlström Daniel Wang Danny Nemer Dave Pacheco David Siegel Domenic Denicola Domenic Denicola Eduard Burtescu Einar Otto Stangvik Elliott Cable Eric Phetteplace EungJun Yi Evan Larkin Evan Lucas Evan Lucas Farid Neshat Fedor Indutny Felix Böhm Felix Geisendörfer Felix Geisendörfer Friedemann Altrock Fuji Goro Gabriel de Perthuis Gil Pedersen Henry Chin Herbert Vojčík Icer Liang Igor Soarez Igor Zinkovsky Imran Iqbal Isaac Z. Schlueter Isaac Z. Schlueter Jake Verbaten James Hartig James M Snell Jan Krems Jered Schmidt Jeremiah Senkpiel Jerry Chin Joe Shaw Johan Bergström Johan Dahlberg Johann Hofmann Jonas Pfenniger Jonathan Ong Jonathan Persson Jonathan Rentzsch Josh Erickson Joshua S. Weinstein Juan Soto Junliang Yan Junliang Yan Jérémy Lal Jérémy Lal Kai Sasaki Lewuathe Karl Skomski Kazuyuki Yamada Keith M Wesolowski Kelsey Breseman Koichi Kobayashi Kris Kowal Kyle Robinson Young Luke Bayes Maciej Małecki Malte-Thorben Bruns Malte-Thorben Bruns Marcin Cieślak Marcin Cieślak Marti Martz Martial James Jefferson Mathias Pettersson Matthew Lye Michael Bernstein Michael Wilber Michaël Zasso Micheil Smith Micleusanu Nicu Mikael Bourges-Sevenier Miroslav Bajtoš Mitar Milutinovic Nebu Pookins Nicholas Kinsey Nikolai Vavilov Onne Gorter Paul Querna Peter Flannery Phillip Johnsen Ratikesh Misra Ray Morgan Ray Solomon Raymond Feng Rick Olson Roman Klauke Roman Reiss Ron Korving Ryan Dahl Ryan Emery Sakthipriyan Vairamani Sam Mikes Sam P Gallagher-Bishop Sam Shull Sam Shull Sambasiva Suda Sam Roberts San-Tai Hsu Scott Blomquist Sergey Kryzhanovsky Shannen Saez Shigeki Ohtsu Siddharth Mahendraker Simon Willison Stanislav Opichal Stefan Budeanu Stefan Bühler Steve Mao Steven R. Loomis Todd Kennedy TJ Holowaychuk TJ Holowaychuk Tadashi SAWADA Takahiro ANDO Ted Young Thomas Lee Thomas Reggi Tim Caswell Tim Price Tim Smart Tim Smart Tom Hughes Tom Hughes-Croucher Trevor Burnham Tyler Larson Vincent Voyer Vladimir de Turckheim Willi Eggeling Yazhong Liu Yazhong Liu Yazhong Liu Yorkie Yazhong Liu Yorkie Yoshihiro KIKUCHI Yosuke Furukawa Yuichiro MASUI Zachary Scott Zoran Tomicic # These people didn't contribute patches to node directly, # but we've landed their v8 patches in the node repository: Daniel Clifford Erik Corry Jakob Kummerow Kevin Millikin Lasse R.H. Nielsen Michael Starzinger Toon Verwaest Vyacheslav Egorov Yang Guo node-v4.8.2/.remarkrc000644 000766 000024 00000002166 13070706727 014575 0ustar00iojsstaff000000 000000 { "plugins": { "remark-lint": { "code-block-style": false, "definition-case": false, "emphasis-marker": false, "first-heading-level": false, "heading-increment": false, "list-item-content-indent": false, "list-item-bullet-indent": false, "list-item-indent": false, "list-item-spacing": false, "maximum-heading-length": false, "maximum-line-length": false, "no-consecutive-blank-lines": false, "no-duplicate-headings": false, "no-emphasis-as-heading": false, "no-file-name-articles": false, "no-file-name-irregular-characters": false, "no-heading-punctuation": false, "no-html": false, "no-inline-padding": false, "no-shell-dollars": false, "no-shortcut-reference-link": false, "no-literal-urls": false, "no-missing-blank-lines": false, "no-multiple-toplevel-headings": false, "no-undefined-references": false, "ordered-list-marker-style": false, "ordered-list-marker-value": false, "table-pipe-alignment": false, "unordered-list-marker-style": false } } } node-v4.8.2/android-configure000755 000766 000024 00000003172 13070706730 016303 0ustar00iojsstaff000000 000000 #!/bin/bash # In order to cross-compile node for Android using NDK, run: # source android-configure [arch] # # By running android-configure with source, will allow environment variables to # be persistent in current session. This is useful for installing native node # modules with npm. Also, don't forget to set the arch in npm config using # 'npm config set arch=' if [ -z "$2" ]; then ARCH=arm else ARCH="$2" fi CC_VER="4.9" case $ARCH in arm) DEST_CPU="$ARCH" SUFFIX="$ARCH-linux-androideabi" TOOLCHAIN_NAME="$SUFFIX" ;; x86) DEST_CPU="ia32" SUFFIX="i686-linux-android" TOOLCHAIN_NAME="$ARCH" ;; x86_64) DEST_CPU="ia32" SUFFIX="$ARCH-linux-android" TOOLCHAIN_NAME="$ARCH" ;; *) echo "Unsupported architecture provided: $ARCH" exit 1 ;; esac export TOOLCHAIN=$PWD/android-toolchain mkdir -p $TOOLCHAIN $1/build/tools/make-standalone-toolchain.sh \ --toolchain=$TOOLCHAIN_NAME-$CC_VER \ --arch=$ARCH \ --install-dir=$TOOLCHAIN \ --platform=android-21 export PATH=$TOOLCHAIN/bin:$PATH export AR=$TOOLCHAIN/bin/$SUFFIX-ar export CC=$TOOLCHAIN/bin/$SUFFIX-gcc export CXX=$TOOLCHAIN/bin/$SUFFIX-g++ export LINK=$TOOLCHAIN/bin/$SUFFIX-g++ GYP_DEFINES="target_arch=$ARCH" GYP_DEFINES+=" v8_target_arch=$ARCH" GYP_DEFINES+=" android_target_arch=$ARCH" GYP_DEFINES+=" host_os=linux OS=android" export GYP_DEFINES if [ -f "configure" ]; then ./configure \ --dest-cpu=$DEST_CPU \ --dest-os=android \ --without-snapshot \ --openssl-no-asm fi node-v4.8.2/AUTHORS000644 000766 000024 00000117177 13070706727 014047 0ustar00iojsstaff000000 000000 # Authors ordered by first contribution. Ryan Dahl Urban Hafner Joshaven Potter Abe Fettig Kevin van Zonneveld Michael Carter Jeff Smick Jon Crosby Felix Geisendörfer Ray Morgan Jérémy Lal Isaac Z. Schlueter Brandon Beacher Tim Caswell Connor Dunn Johan Sørensen Friedemann Altrock Onne Gorter Rhys Jones Jan Lehnardt Simon Willison Chew Choon Keat Jered Schmidt Michaeljohn Clement Karl Guertin Xavier Shay Christopher Lenz TJ Holowaychuk Johan Dahlberg Simon Cornelius P. Umacob Ryan McGrath Rasmus Andersson Micheil Smith Jonas Pfenniger David Sklar Charles Lehner Elliott Cable Benjamin Thomas San-Tai Hsu Ben Williamson Joseph Pecoraro Alexis Sellier Blaine Cook Stanislav Opichal Aaron Heckmann Mikeal Rogers Matt Brubeck Michael Stillwell Yuichiro MASUI Mark Hansen Zoran Tomicic Jeremy Ashkenas Scott González James Duncan Arlo Breault Kris Kowal Jacek Becela Rob Ellis Tim Smart Herbert Vojčík Krishna Rajendran Nicholas Kinsey Scott Taylor Carson McDonald Matt Ranney James Herdman Julian Lamb Brian Hammond Mathias Pettersson Thomas Lee Daniel Berger Paulo Matias Peter Griess Jonathan Knezek Jonathan Rentzsch Ben Noordhuis Elijah Insua Andrew Johnston Brian White Aapo Laitinen Sam Hughes Orlando Vazquez Raffaele Sena Brian McKenna Paul Querna Ben Lowery Peter Dekkers David Siegel Marshall Culpepper Ruben Rodriguez Dmitry Baranovskiy Blake Mizerany Jerome Etienne Dmitriy Shalashov Adam Wiggins Rick Olson Sergey Kryzhanovsky Marco Rogers Benjamin Fritsch Jan Kassens Robert Keizer Sam Shull Chandra Sekar S Andrew Naylor Benjamin Kramer Danny Coates Nick Stenning Bert Belder Trent Mick Fedor Indutny Illarionov Oleg Aria Stewart Johan Euphrosine Russell Haering Bradley Meck Tobie Langel Tony Metzidis Mark Nottingham Sam Stephenson Jorge Chamorro Bieling Evan Larkin Sean Coates Tom Hughes Joshua Peek Nathan Rajlich Peteris Krumins AJ ONeal Sami Samhuri Nikhil Marathe Vitali Lovich Stéphan Kochen Oleg Efimov Guillaume Tuton Tim Cooijmans Dan Søndergaard Silas Sewell Wade Simmons Daniel Gröber Travis Swicegood Oleg Slobodskoi Jeremy Martin Michael Wilber Sean Braithwaite Anders Conbere Devin Torres Theo Schlossnagle Kai Chen Daniel Chcouri <333222@gmail.com> Mihai Călin Bazon Ali Farhadi Daniel Ennis Carter Allen Greg Hughes David Trejo Joe Walnes Koichi Kobayashi Konstantin Käfer Richard Rodger Andreas Reich Tony Huang Dean McNamee Trevor Burnham Zachary Scott Arnout Kazemier George Stagas Ben Weaver Scott McWhirter Jakub Lekstan Nick Campbell Nebu Pookins Tim Baumann Robert Mustacchi George Miroshnykov Mark Cavage Håvard Stranden Marcel Laverdet Alexandre Marangone Ryan Petrello Fuji Goro Siddharth Mahendraker Dave Pacheco Mathias Buus Henry Rawas Yoshihiro KIKUCHI Brett Kiefer Mariano Iglesias Jörn Horstmann Joe Shaw Niklas Fiekas Adam Luikart Artem Zaytsev Alex Xu Jeremy Selier Igor Zinkovsky Kip Gebhardt Stefan Rusu Shigeki Ohtsu Wojciech Wnętrzak Devon Govett Steve Engledow Pierre-Alexandre St-Jean Reid Burke Vicente Jimenez Aguilar Tadashi SAWADA Jeroen Janssen Daniel Pihlström Stefan Bühler Alexander Uvarov Aku Kotkavuo Peter Bright Logan Smyth Christopher Wright Glen Low Thomas Shinnick Mickaël Delahaye Antranig Basman Maciej Małecki Evan Martin Peter Lyons Jann Horn Abimanyu Raja Karl Skomski Niclas Hoyer Michael Jackson Ashok Mudukutore Sean Cunningham Vitor Balocco Ben Leslie Eric Lovett Christian Tellnes Colton Baker Tyler Larson Tomasz Janczuk Ilya Dmitrichenko Simen Brekken Guglielmo Ferri <44gatti@gmail.com> Thomas Parslow Ryan Emery Jordan Sissel Matt Robenolt Jacob H.C. Kragh Benjamin Pasero Scott Anderson Yoji SHIDARA Mathias Bynens Łukasz Walukiewicz Artur Adib E. Azer Koçulu Paddy Byers Roman Shtylman Kyle Robinson Young Tim Oxley Eduard Burtescu Ingmar Runge Russ Bradberry Andreas Madsen Adam Malcontenti-Wilson Avi Flax Pedro Teixeira Johan Bergström James Hartig Shannen Saez Seong-Rak Choi Dave Irvine Ju-yeong Park Phil Sung Damon Oehlman Mikael Bourges-Sevenier Emerson Macedo Ryunosuke SATO Michael Bernstein Guillermo Rauch Dan Williams Brandon Benvie Nicolas LaCasse Dan VerWeire Matthew Fitzsimmons Philip Tellis Christopher Jeffrey Seth Fitzsimmons Einar Otto Stangvik Paul Vorbach Luke Gallagher Tomasz Buchert Myles Byrne T.C. Hollingsworth Cam Pedersen Roly Fentanes Ted Young Joshua Holbrook Blake Miner Vincent Ollivier Jimb Esser Sambasiva Suda Sadique Ali Dmitry Nizovtsev Alex Kocharin Ming Liu Shea Levy Nao Iizuka Christian Ress Rod Vagg Matt Ezell Charlie McConnell Farid Neshat Johannes Wüller Erik Lundin Bryan Cantrill Yosef Dinerstein Nathan Friedly Aaron Jacobs Mustansir Golawala Atsuo Fukaya Domenic Denicola Joshua S. Weinstein Dane Springmeyer Erik Dubbelboer Malte-Thorben Bruns Michael Thomas Garen Torikian EungJun Yi Vincent Voyer Takahiro ANDO Brian Schroeder J. Lee Coltrane Javier Hernández James Koval Kevin Gadd Ray Solomon Kevin Bowman Erwin van der Koogh Matt Gollob Simon Sturmer Joel Brandt Marc Harter Nuno Job Ben Kelly Felix Böhm George Shank Gabriel de Perthuis Vladimir Beloborodov Tim Macfarlane Jonas Westerlund Dominic Tarr Justin Plock Toshihiro Nakamura Ivan Torres Philipp Hagemeister Mike Morearty Pavel Lang Peter Rybin Timothy J Fontaine Joe Andaverde Tom Hughes-Croucher Eugen Dueck Gil Pedersen Tyler Neylon Josh Erickson Golo Roden Ron Korving Brandon Wilson Ian Babrou Bearice Ren Ankur Oberoi Atsuya Takagi Pooya Karimian Frédéric Germain Robin Lee Kazuyuki Yamada Adam Blackburn Willi Eggeling Paul Serby Andrew Paprocki Ricky Ng-Adam Aaditya Bhatia Max Ogden Igor Soarez Olivier Lalonde Scott Blomquist Francois Marier Brandon Philips Frederico Silva Jan Wynholds Girish Ramakrishnan Anthony Pesch Stephen Gallagher Trevor Norris Sergey Kholodilov Tim Kuijsten Michael Axiak Chad Rhyner Kai Sasaki Lewuathe Nicolas Chambrier Ben Taber Luke Arduini Luke Bayes Tim Bradshaw Nirk Niggler Johannes Ewald James Hight Mike Harsch Chris Dent Alexandr Emelin James Campos Dan Milon Dave Olszewski Tim Price Jake Verbaten Jacob Gable Andy Burke Sugendran Ganess Rick Yakubowski Jim Schubert Victor Costan Dan Kohn Arianit Uka Andrei Sedoi Eugene Girshov Evan Oxfeld Lars-Magnus Skog Raymond Feng Aaron Cannon Xidorn Quan Paolo Fragomeni Henry Chin Julian Gruber JeongHoon Byun Iskren Ivov Chernev Alexey Kupershtokh Manav Rathi Benjamin Ruston Marcin Kostrzewa Suwon Chae David Braun Mitar Milutinovic Michael Hart Andrew Hart Rafael Garcia Tobias Müllerleile Stanislav Ochotnicky Ryan Graham Kelly Gerber Ryan Doenges Sean Silva Miroslav Bajtoš Olof Johansson Sam Roberts Kevin Locke Daniel Moore Robert Kowalski Nick Sullivan Benoit Vallée Ryuichi Okumura Brandon Frohs Nathan Zadoks Rafael Henrique Moreira Daniel G. Taylor Kiyoshi Nomo Nick Desaulniers Veres Lajos Yuan Chuan Krzysztof Chrapka Linus Mårtensson Peter Rust Jeff Barczewski Shuan Wang Wyatt Preul David Björklund Dav Glass Andrew Chilton Antony Bailey Forrest L Norvell Evan Solomon Eran Hammer Matthias Bartelmeß Daniel Chatfield Eivind Uggedal Edward Hutchins James Halliday ChrisWren Duan Yao Matthew Aynalem Vsevolod Strukchinsky Jay Beavers Mathias Buus Eric Schrock Jeff Switzer Glen Mailer Jason Gerfen Patrik Stutz Zarko Stankovic Maxim Bogushevich Phillip Alexander Thom Seddon Nick Simmons Jacob Groundwater Jackson Tian fengmk2 Tim Wood Linus Unnebäck Vladimir Kurchatkin David Chan Alexis Campailla Nikolai Vavilov Michael Ridgway Yazhong Liu Gabriel Falkenberg Kai Groner Lalit Kapoor Steven Kabbes Gabriel Farrell Nicolas Kaiser Ahamed Nafeez Cam Swords Paul Loyd Benjamin Waters Lev Gimelfarb Peter Flannery Tuğrul Topuz Lorenz Leutgeb ayanamist gluxon Tom Gallacher Jo Liss Jun Ma Jacob Hoffman-Andrews Keith M Wesolowski Maxime Quandalle Oguz Bastemur Yuriy Nemtsov Benjamin Waters iamdoron Austin Moran Kenan Sulayman Christian Pedro Ballesteros Anton Khlynovskiy Nicolas Talle Mike Pennisi Maxwell Krohn Saúl Ibarra Corretgé Greg Brail Shuhei Kagawa Josh Dague Goh Yisheng (Andrew) James Pickard Andrew Low Nick Apperson C. Scott Ananian Yuki KAN Evan Carroll William Bert goussardg Geir Hauge Farrin Reid Ben Noordhuis Denys Zariaiev Sean McArthur Rasmus Christian Pedersen Forrest L Norvell Adrian Lang Feross Aboukhadijeh Refael Ackermann Taojie Greg Sabia Tucker Dan Kaplun Colin Ihrig Greg Sabia Tucker Mark Stosberg Calvin Metcalf Ryan Cole Kevin Decker Rohini Harendra Chris Barber Michael Kebe Nick Muerdter Roman Klauke Xavi Magrinyà Euan Ed Morley Charles Jan Krems Fred K. Schott Chris Dickinson Jonathan Reem Refael Ackermann Ionică Bizău Eli Skeggs Andrius Bentkus Ed Umansky Maurice Butler John Albietz Andrew Oppenlander Julien Gilli Gabriel Wicke Jakob Gillich Lucio M. Tato Herman Lee Kevin Simper Thorsten Lorenz Ezequiel Rabinovich Cheng Zhao Tristan Berger Isaac Burns Jesús Leganés Combarro "piranna Majid Arif Siddiqui Trevor Livingston Mathias Schreck Adam Lippai Guilherme de Souza Mickael van der Beek Andrew Teich Kang-Hao Kenny Patrick Mooney Jicheng Li James Ferguson Julien Fontanet Steven R. Loomis gyson Steve Sharp Victor Widell Evan Rutledge Borden Johnny Ray Steve Mao Stiliyan Lazarov Wang Xinyong Ray Donnelly dead-horse Luis Reis Jackson Tian sudodoki Steven Loomis haoxin Artur Cistov MK Safi Rory Bradford Calvin Metcalf Nathan Woltman James Cowgill Jamund Ferguson Jonathan Johnson Martin Cozzi Carlos Campderrós Leonardo Balter Bryce Kahle The Gitter Badger Brendan Ashworth Jose Luis Rivas Evan Lucas Vincent Weevers Tyler Kellen Evan Torrie Juanjo brian m. carlson Kevin O'Hara Micleusanu Nicu Alejandro Oviedo Ben Burns Julian Duque teppeis Rudi Cilibrasi Tim Ruffles CGavrila Aleksey Smolenchuk Caitlin Potter Calvin Metcalf Eric Mill pkcs James M Snell Cydox Steven Rockarts Vladimir Guguiev Yosuke Furukawa Tiago Ribeiro Rui Marinho Jesse cogollo Chris Alley Michal Tehnik Aaron Bieber Phil Hughes Jongyeol Choi Brenard Cubacub Thomas Jensen Jay Jaeho Lee Roman Reiss Glen Keane Xiaowei Li <446240525@qq.com> toastynerd Todd Kennedy Icer Liang Stephen Belanger Jeremiah Senkpiel Brendan Ashworth Andres Suarez Jonathan Ong ttrfwork Johnny Ray Austin Mathias Küsel Qasim Zaidi Sam Newman Zach Bruggeman Michaël Zasso Haoliang Gao Rudolf Meijering Ryan Seys Omer Wazir Dan Dascalescu Jan Schär Debjeet Biswas Amir Saboury Charmander <~@charmander.me> Jimmy Hsu jigsaw Emily Rose Shinnosuke Watanabe Bruno Jouhier René Kooi Petka Antonov Ryan Scheel Benjamin Gruenbaum Pavel Medvedev Russell Dempsey &! (bitandbang) h7lin Michael Dawson Ruben Verborgh Ken Perkins Malte-Thorben Bruns Santiago Gimeno Ali Ijaz Sheikh FangDun Cai Alex Yursha Steven Vercruysse Aleksanteri Negru-Vode Mathieu Darse Connor Peet Mayhem Olov Lassus Phillip Lamplugh Kohei TAKATA Giovanny Andres Gongora Granada Jeffrey Jagoda Kelsey Breseman Peter Petrov Andrew Crites Marat Abdullin Dan Varga Nick Raienko Guilherme Souza Chris Yip Christopher Monsanto Alexander Gromnitsky Сковорода Никита Андреевич Sakthipriyan Vairamani AQNOUCH Mohammed Ivan Kozik Oleg Elifantiev Mike MacCana Josh Gummersall Sam Mikes Frederic Hemberger Sharat M R Rich Trott Felipe Batista Rebecca Turner Tyler Anton João Reis Kat Marchán Ryan Petschek Pierre Inglebert Ivan Yan Sangmin Yoon Mark Plomer Phillip Johnsen Matteo Collina jomo Gireesh Punathil Lucien Greathouse Chad Johnston Sam Stites Matthew Lye Matt Loring P.S.V.R Jacob Edelman Mike Atkins hackerjs <4141095@qq.com> Minwoo Jung Marcin Cieślak Anne-Gaelle Colom Oleksandr Chekhovskyi Tristian Flanagan Mike Tunnicliffe Ionică Bizău Danny Nemer Sven Slootweg Dmitry Vasilyev Malcolm Ahoy Imran Iqbal Stewart Addison Matt Harrison Christopher J. Brody Salman Aljammaz Thomas Reggi Laurent Fortin Fabio Oliveira Michał Gołębiowski Johann Hofmann Charles Rudolph Dave Eddy Justin Chase Jeremy Whitlock Rod Machen Martial James Jefferson Doug Shamoo Junliang Yan Dave Hodder Jason Karns Balázs Galambosi David Boivin Liang-Chi Hsieh Timothy Gu Fábio Santos Myles Borins Jonas Dohse Коренберг Марк Caleb Boyd Yuval Brik Claudio Rodriguez Ido Ben-Yair Kyle Smith Marti Martz Stefan Budeanu Emily Aviva Kapor-Mater Sam P Gallagher-Bishop David Woods Ashok Suthar Ömer Fadıl Usta Jerry Chin Hemanth.HM Hugues Malphettes Tyler Henkel Zheng Chaoping Ashley Williams Bryan English Devin Nakamura Vladimir Varankin Manuel B Jesse McCarthy Craig Cavalier Michael Cornacchia Markus Tzoe Martin Forsberg Carl Lei Lewis Cowper Bryon Leung Chunyang Dai Jonathan Persson Dave Luigi Pinca Peter A. Bigot Zirak Scott Buchanan Rebecca Turner Bryce Baril Super Zheng Rafał Pocztarski Michael Ruddy Andy Bettisworth Jörg Krause Alexander Martin Prince J Wesley janriemer Arthur Gautier Martin von Gagern Hideki Yamamura Lenny Markus Nelson Pecora Graham Fairweather Ron Korving Xotic750 Nicholas Young Chris Johnson Bo Borgerson Mudit Ameta Adri Van Houdt Max Barinov Damian Schenkelman iamchenxin Nik Nyby Ben Ripkens Ryan Sobol jona Anna Henningsen Martin Bark José F. Romaniello Richard Sun Sequoia McDowell zoubin Robert Jefe Lindstaedt Saquib Daniel Sellers Julien Waechter Vitor Cortez Michael Theriot Peter Geiss Santiago Gimeno Richard Lau José Moreira Tom Atkinson Glen Arrowsmith Jeff Harris Alexander Makarenko Drew Folta Myles Borins Jimb Esser Dmitriy Lazarev Adam Langley Kári Tristan Helgason Manuel Valls Prayag Verma Gibson Fahnestock Alan Cohen Christophe Naud-Dulude Matthias Bastian Phillip Kovalev Rainer Oviir HUANG Wei DC Daniel Turing Julie Pagano Ruben Bridgewater Felix Becker Igor Klopov Tsarevich Dmitry Ojas Shirekar Noah Rose Ledesma Rafael Cepeda Chinedu Francis Nwafili Braydon Fuller Jiho Choi Dirceu Pereira Tiegs Marc Cuva Chris Dew Tristan Slominski Hugo Wood Owen Smith Anton Andesen Aayush Naik Netto Farah Daniel Wang Craig Akimoto Michael Barrett Alexander Marchenko Steve Mao Robert C Jensen Vaibhav Stefano Vozza Daijiro Wachi Kirill Fomichev Mithun Patel Alexander Penev Andrea Giammarchi Lance Ball Jarrett Widman Florian Margaine Wolfgang Steiner Bill Automata Robert Chiras Corey Kosak John Eversole Gareth Ellis Eugene Obrezkov Kyle Simpson Bogdan Lobor Mihai Potra Brendon Pierson Brad Hill Mike Kaufman Igor Kalashnikov Amery James Reggio Joran Dirk Greef Matthew Douglass William Kapke Yuta Hiroto Ilya Shaisultanov James Lal Josh Leder Surya Panikkal vsemozhetbyt Eugene Obrezkov Alex Lamar Ian Kronquist DavidCai Patrick Mueller Ben Page Juan Soto Allen Hernandez Eric Phetteplace William Luo Siobhan O'Donovan Kevin Donahue Jenna Vuong Anchika Agarwal Jean Regisser Fangshi He Blake Embrey Alex J Burke Faiz Halde Rumkin Arve Seljebu Devon Rifkin Doug Wade Mohsen Marian Justin Sprigg Bryan Hughes Ehsan Akhgari Ingvar Stepanyan Adrian Estrada Matt Lavin Joao Andrade Bartosz Sosnowski Nicolas Romer David A. Wheeler Italo A. Casas Jonathan Montane Ilkka Myller kimown Natanael Copa David Halls Greyson Parrelli Daniel Bevenius Bryce Simonds Tushar Mathur Kyle E. Mitchell akki Josh Gavant Sartrey Lee Guy Fraser Ruslan Iusupov Michael Wain Zach Bjornson Andras Chuck Langford Ryan Lewis Tarun Garg Diosney Sarmiento Quentin Headen Alex Hultman Saad Quadri Hargobind S. Khalsa Joran Siu Vitaly Tomilov Ratikesh Misra Alex Perkins Bethany N Griggs Joe Esposito Erin Spiceland Ravindra Barthwal Joey Cozza Vladimir de Turckheim Taehee Kang Igor Savin Pat Pannuto Haojian Wu John Gardner Aleksei Koziatinskii Adrian Nitu Ben Gourley Kunal Pathak Tracy Hinds lazlojuly Arnaud Lefebvre not-an-aardvark Junshu Okamoto Shahid Shaikh Simen Bekkhus Jason Hedrick David Keeler Zwb Paul Grock # Generated by tools/update-authors.sh node-v4.8.2/benchmark/000755 000766 000024 00000000000 13070706730 014705 5ustar00iojsstaff000000 000000 node-v4.8.2/BSDmakefile000644 000766 000024 00000000407 13070706727 015013 0ustar00iojsstaff000000 000000 # pmake might add -J (private) FLAGS=${.MAKEFLAGS:C/\-J ([0-9]+,?)+//W} all: .DEFAULT .DEFAULT: @which gmake > /dev/null 2>&1 ||\ (echo "GMake is required for node.js to build.\ Install and try again" && exit 1) @gmake ${.FLAGS} ${.TARGETS} .PHONY: test node-v4.8.2/BUILDING.md000644 000766 000024 00000020101 13070706730 014464 0ustar00iojsstaff000000 000000 ## Building Node.js Depending on what platform or features you require the build process may differ slightly. After you've successfully built a binary, running the test suite to validate that the binary works as intended is a good next step. If you consistently can reproduce a test failure, search for it in the [Node.js issue tracker](https://github.com/nodejs/node/issues) or file a new issue. ### Unix / OS X Prerequisites: * `gcc` and `g++` 4.8 or newer, or * `clang` and `clang++` 3.4 or newer * Python 2.6 or 2.7 * GNU Make 3.81 or newer On OS X, you will also need: * [Xcode](https://developer.apple.com/xcode/download/) * You also need to install the `Command Line Tools` via Xcode. You can find this under the menu `Xcode -> Preferences -> Downloads` * This step will install `gcc` and the related toolchain containing `make` * After building, you may want to setup [firewall rules](tools/macosx-firewall.sh) to avoid popups asking to accept incoming network connections when running tests: ```console $ sudo ./tools/macosx-firewall.sh ``` Running this script will add rules for the executable `node` in the out directory and the symbolic `node` link in the projects root directory. On FreeBSD and OpenBSD, you may also need: * libexecinfo (FreeBSD and OpenBSD only) ```text $ ./configure $ make $ [sudo] make install ``` If your Python binary is in a non-standard location or has a non-standard name, run the following instead: ```text $ export PYTHON=/path/to/python $ $PYTHON ./configure $ make $ [sudo] make install ``` To run the tests: ```text $ make test ``` To run the native module tests: ```text $ make test-addons ``` To run the npm test suite: *note: to run the suite on node v4 or earlier you must first* *run `make install`* ``` $ make test-npm ``` To build the documentation: This will build Node.js first (if necessary) and then use it to build the docs: ```text $ make doc ``` If you have an existing Node.js you can build just the docs with: ```text $ NODE=node make doc-only ``` (Where `node` is the path to your executable.) To read the documentation: ```text $ man doc/node.1 ``` To test if Node.js was built correctly: ``` $ node -e "console.log('Hello from Node.js ' + process.version)" ``` ### Windows Prerequisites: * [Python 2.6 or 2.7](https://www.python.org/downloads/) * One of: * [Visual C++ Build Tools](http://landinghub.visualstudio.com/visual-cpp-build-tools) * [Visual Studio](https://www.visualstudio.com/) 2013 / 2015, all editions including the Community edition * [Visual Studio](https://www.visualstudio.com/) Express 2013 / 2015 for Desktop * Basic Unix tools required for some tests, [Git for Windows](http://git-scm.com/download/win) includes Git Bash and tools which can be included in the global `PATH`. ```text > .\vcbuild nosign ``` To run the tests: ```text > .\vcbuild nosign test ``` To test if Node.js was built correctly: ```text > Release\node -e "console.log('Hello from Node.js', process.version)" ``` ### Android / Android-based devices (e.g. Firefox OS) Although these instructions for building on Android are provided, please note that Android is not an officially supported platform at this time. Patches to improve the Android build are accepted. However, there is no testing on Android in the current continuous integration environment. The participation of people dedicated and determined to improve Android building, testing, and support is encouraged. Be sure you have downloaded and extracted [Android NDK] (https://developer.android.com/tools/sdk/ndk/index.html) before in a folder. Then run: ``` $ ./android-configure /path/to/your/android-ndk $ make ``` ### `Intl` (ECMA-402) support: [Intl](https://github.com/nodejs/node/wiki/Intl) support is not enabled by default. #### "small" (English only) support This option will build with "small" (English only) support, but the full `Intl` (ECMA-402) APIs. With `--download=all` it will download the ICU library as needed. ##### Unix / OS X: ```text $ ./configure --with-intl=small-icu --download=all ``` ##### Windows: ```text > .\vcbuild nosign small-icu download-all ``` The `small-icu` mode builds with English-only data. You can add full data at runtime. *Note:* more docs are on [the node wiki](https://github.com/nodejs/node/wiki/Intl). #### Build with full ICU support (all locales supported by ICU): With the `--download=all`, this may download ICU if you don't have an ICU in `deps/icu`. ##### Unix / OS X: ```text $ ./configure --with-intl=full-icu --download=all ``` ##### Windows: ```text > .\vcbuild nosign full-icu download-all ``` #### Building without Intl support The `Intl` object will not be available. This is the default at present, so this option is not normally needed. ##### Unix / OS X: ```text $ ./configure --with-intl=none ``` ##### Windows: ```text > .\vcbuild nosign intl-none ``` #### Use existing installed ICU (Unix / OS X only): ```text $ pkg-config --modversion icu-i18n && ./configure --with-intl=system-icu ``` If you are cross compiling, your `pkg-config` must be able to supply a path that works for both your host and target environments. #### Build with a specific ICU: You can find other ICU releases at [the ICU homepage](http://icu-project.org/download). Download the file named something like `icu4c-**##.#**-src.tgz` (or `.zip`). ##### Unix / OS X ```text # from an already-unpacked ICU: $ ./configure --with-intl=[small-icu,full-icu] --with-icu-source=/path/to/icu # from a local ICU tarball $ ./configure --with-intl=[small-icu,full-icu] --with-icu-source=/path/to/icu.tgz # from a tarball URL $ ./configure --with-intl=full-icu --with-icu-source=http://url/to/icu.tgz ``` ##### Windows First unpack latest ICU to `deps/icu` [icu4c-**##.#**-src.tgz](http://icu-project.org/download) (or `.zip`) as `deps/icu` (You'll have: `deps/icu/source/...`) ```text > .\vcbuild nosign full-icu ``` ## Building Node.js with FIPS-compliant OpenSSL NOTE: Windows is not yet supported It is possible to build Node.js with [OpenSSL FIPS module](https://www.openssl.org/docs/fips/fipsnotes.html). **Note**: building in this way does **not** allow you to claim that the runtime is FIPS 140-2 validated. Instead you can indicate that the runtime uses a validated module. See the [security policy](http://csrc.nist.gov/groups/STM/cmvp/documents/140-1/140sp/140sp1747.pdf) page 60 for more details. In addition, the validation for the underlying module is only valid if it is deployed in accordance with its [security policy](http://csrc.nist.gov/groups/STM/cmvp/documents/140-1/140sp/140sp1747.pdf). If you need FIPS validated cryptography it is recommended that you read both the [security policy](http://csrc.nist.gov/groups/STM/cmvp/documents/140-1/140sp/140sp1747.pdf) and [user guide](https://openssl.org/docs/fips/UserGuide-2.0.pdf). ### Instructions 1. Obtain a copy of openssl-fips-x.x.x.tar.gz. To comply with the security policy you must ensure the path through which you get the file complies with the requirements for a "secure installation" as described in section 6.6 in the [user guide](https://openssl.org/docs/fips/UserGuide-2.0.pdf). For evaluation/experimentation you can simply download and verify `openssl-fips-x.x.x.tar.gz` from https://www.openssl.org/source/ 2. Extract source to `openssl-fips` folder and `cd openssl-fips` 3. `./config` 4. `make` 5. `make install` (NOTE: to comply with the security policy you must use the exact commands in steps 3-5 without any additional options as per Appendix A in the [security policy](http://csrc.nist.gov/groups/STM/cmvp/documents/140-1/140sp/140sp1747.pdf). The only exception is that `./config no-asm` can be used in place of `./config`, and the FIPSDIR environment variable may be used to specify a non-standard install folder for the validated module, as per User Guide sections 4.2.1, 4.2.2, and 4.2.3. 6. Get into Node.js checkout folder 7. `./configure --openssl-fips=/path/to/openssl-fips/installdir` For example on ubuntu 12 the installation directory was /usr/local/ssl/fips-2.0 8. Build Node.js with `make -j` 9. Verify with `node -p "process.versions.openssl"` (`1.0.2a-fips`) node-v4.8.2/CHANGELOG.md000644 000766 000024 00003620057 13070706730 014601 0ustar00iojsstaff000000 000000 # Node.js ChangeLog ## 2017-04-04, Version 4.8.2 'Argon' (Maintenance), @MylesBorins This is a maintenance release to fix a memory leak that was introduced in 4.8.1. It also includes an upgrade to zlib 1.2.11 to fix a [number of low severity CVEs](http://seclists.org/oss-sec/2016/q4/602) that were present in zlib 1.2.8. ### Notable Changes * **crypto**: - fix memory leak if certificate is revoked (Tom Atkinson) [#12089](https://github.com/nodejs/node/pull/12089) * **deps**: - upgrade zlib to 1.2.11 (Sam Roberts) [#10980](https://github.com/nodejs/node/pull/10980) ### Commits * [[`9d7fba4de2`](https://github.com/nodejs/node/commit/9d7fba4de2)] - **crypto**: fix memory leak if certificate is revoked (Tom Atkinson) [#12089](https://github.com/nodejs/node/pull/12089) * [[`253980ff38`](https://github.com/nodejs/node/commit/253980ff38)] - **deps**: fix CLEAR_HASH macro to be usable as a single statement (Sam Roberts) [#11616](https://github.com/nodejs/node/pull/11616) * [[`2e52a2699b`](https://github.com/nodejs/node/commit/2e52a2699b)] - **deps**: upgrade zlib to 1.2.11 (Sam Roberts) [#10980](https://github.com/nodejs/node/pull/10980) ## 2017-03-21, Version 4.8.1 'Argon' (LTS), @MylesBorins This LTS release comes with 147 commits. This includes 55 which are test related, 41 which are doc related, 11 which are build / tool related, and 1 commits which are updates to dependencies. ### Notable Changes * **buffer**: The performance of `.toJSON()` is now up to 2859% faster on average. (Brian White) [#10895](https://github.com/nodejs/node/pull/10895) * **IPC**: Batched writes have been enabled for process IPC on platforms that support Unix Domain Sockets. (Alexey Orlenko) [#10677](https://github.com/nodejs/node/pull/10677) - Performance gains may be up to 40% for some workloads. * **http**: - Control characters are now always rejected when using `http.request()`. (Ben Noordhuis) [#8923](https://github.com/nodejs/node/pull/8923) * **node**: Heap statistics now support values larger than 4GB. (Ben Noordhuis) [#10186](https://github.com/nodejs/node/pull/10186) ### Commits * [[`77f23ec5af`](https://github.com/nodejs/node/commit/77f23ec5af)] - **assert**: unlock the assert API (Rich Trott) [#11304](https://github.com/nodejs/node/pull/11304) * [[`090037a41a`](https://github.com/nodejs/node/commit/090037a41a)] - **assert**: remove unneeded condition (Rich Trott) [#11314](https://github.com/nodejs/node/pull/11314) * [[`75af859af7`](https://github.com/nodejs/node/commit/75af859af7)] - **assert**: apply minor refactoring (Rich Trott) [#11511](https://github.com/nodejs/node/pull/11511) * [[`994f562858`](https://github.com/nodejs/node/commit/994f562858)] - **assert**: update comments (Kai Cataldo) [#10579](https://github.com/nodejs/node/pull/10579) * [[`14e57c1102`](https://github.com/nodejs/node/commit/14e57c1102)] - **benchmark**: add more thorough timers benchmarks (Jeremiah Senkpiel) [#10925](https://github.com/nodejs/node/pull/10925) * [[`850f85d96e`](https://github.com/nodejs/node/commit/850f85d96e)] - **benchmark**: add benchmark for object properties (Michaël Zasso) [#10949](https://github.com/nodejs/node/pull/10949) * [[`626875f2e4`](https://github.com/nodejs/node/commit/626875f2e4)] - **benchmark**: don't lint autogenerated modules (Brian White) [#10756](https://github.com/nodejs/node/pull/10756) * [[`9da6ebd73f`](https://github.com/nodejs/node/commit/9da6ebd73f)] - **benchmark**: add dgram bind(+/- params) benchmark (Vse Mozhet Byt) [#11313](https://github.com/nodejs/node/pull/11313) * [[`a597c11ba4`](https://github.com/nodejs/node/commit/a597c11ba4)] - **benchmark**: improve readability of net benchmarks (Brian White) [#10446](https://github.com/nodejs/node/pull/10446) * [[`22c25dee92`](https://github.com/nodejs/node/commit/22c25dee92)] - **buffer**: improve toJSON() performance (Brian White) [#10895](https://github.com/nodejs/node/pull/10895) * [[`af3c21197d`](https://github.com/nodejs/node/commit/af3c21197d)] - **build**: move source files from headers section (Daniel Bevenius) [#10850](https://github.com/nodejs/node/pull/10850) * [[`4bb61553f0`](https://github.com/nodejs/node/commit/4bb61553f0)] - **build**: disable C4267 conversion compiler warning (Ben Noordhuis) [#11205](https://github.com/nodejs/node/pull/11205) * [[`6a45ac0ea9`](https://github.com/nodejs/node/commit/6a45ac0ea9)] - **build**: fix newlines in addon build output (Brian White) [#11466](https://github.com/nodejs/node/pull/11466) * [[`bfc553d55d`](https://github.com/nodejs/node/commit/bfc553d55d)] - **build**: fail on CI if leftover processes (Rich Trott) [#11269](https://github.com/nodejs/node/pull/11269) * [[`094bfe66aa`](https://github.com/nodejs/node/commit/094bfe66aa)] - **build**: fix node_g target (Daniel Bevenius) [#10153](https://github.com/nodejs/node/pull/10153) * [[`87db4f7225`](https://github.com/nodejs/node/commit/87db4f7225)] - **build**: Don't regenerate node symlink (sxa555) [#9827](https://github.com/nodejs/node/pull/9827) * [[`e0dc0ceb37`](https://github.com/nodejs/node/commit/e0dc0ceb37)] - **build**: don't squash signal handlers with --shared (Stewart X Addison) [#10539](https://github.com/nodejs/node/pull/10539) * [[`4676eec382`](https://github.com/nodejs/node/commit/4676eec382)] - **child_process**: remove empty if condition (cjihrig) [#11427](https://github.com/nodejs/node/pull/11427) * [[`2b867d2ae5`](https://github.com/nodejs/node/commit/2b867d2ae5)] - **child_process**: refactor internal/child_process.js (Arseniy Maximov) [#11366](https://github.com/nodejs/node/pull/11366) * [[`c9a92ff494`](https://github.com/nodejs/node/commit/c9a92ff494)] - **crypto**: return the retval of HMAC_Update (Travis Meisenheimer) [#10891](https://github.com/nodejs/node/pull/10891) * [[`9c53e402d7`](https://github.com/nodejs/node/commit/9c53e402d7)] - **crypto**: freelist_max_len is gone in OpenSSL 1.1.0 (Adam Langley) [#10859](https://github.com/nodejs/node/pull/10859) * [[`c6f6b029a1`](https://github.com/nodejs/node/commit/c6f6b029a1)] - **crypto**: add cert check issued by StartCom/WoSign (Shigeki Ohtsu) [#9469](https://github.com/nodejs/node/pull/9469) * [[`c56719f47a`](https://github.com/nodejs/node/commit/c56719f47a)] - **crypto**: Remove expired certs from CNNIC whitelist (Shigeki Ohtsu) [#9469](https://github.com/nodejs/node/pull/9469) * [[`b48f6ffc63`](https://github.com/nodejs/node/commit/b48f6ffc63)] - **crypto**: use CHECK_NE instead of ABORT or abort (Sam Roberts) [#10413](https://github.com/nodejs/node/pull/10413) * [[`35a660ee70`](https://github.com/nodejs/node/commit/35a660ee70)] - **crypto**: fix handling of root_cert_store. (Adam Langley) [#9409](https://github.com/nodejs/node/pull/9409) * [[`3516f35b77`](https://github.com/nodejs/node/commit/3516f35b77)] - **deps**: backport 7c3748a from upstream V8 (Cristian Cavalli) [#10873](https://github.com/nodejs/node/pull/10873) * [[`f9e121ead8`](https://github.com/nodejs/node/commit/f9e121ead8)] - **dgram**: fix possibly deoptimizing use of arguments (Vse Mozhet Byt) * [[`fc2bb2c8ef`](https://github.com/nodejs/node/commit/fc2bb2c8ef)] - **doc**: remove Chris Dickinson from active releasers (Ben Noordhuis) [#11011](https://github.com/nodejs/node/pull/11011) * [[`725a89606b`](https://github.com/nodejs/node/commit/725a89606b)] - **doc**: remove duplicate properties bullet in readme (Javis Sullivan) [#10741](https://github.com/nodejs/node/pull/10741) * [[`db03294c41`](https://github.com/nodejs/node/commit/db03294c41)] - **doc**: fix typo in http.md (Peter Mescalchin) [#10975](https://github.com/nodejs/node/pull/10975) * [[`15188900b8`](https://github.com/nodejs/node/commit/15188900b8)] - **doc**: add who to CC list for dgram (cjihrig) [#11035](https://github.com/nodejs/node/pull/11035) * [[`a0742902bd`](https://github.com/nodejs/node/commit/a0742902bd)] - **doc**: correct and complete dgram's Socket.bind docs (Alex Jordan) [#11025](https://github.com/nodejs/node/pull/11025) * [[`f464dd837f`](https://github.com/nodejs/node/commit/f464dd837f)] - **doc**: edit CONTRIBUTING.md for clarity (Rich Trott) [#11045](https://github.com/nodejs/node/pull/11045) * [[`07dfed8f45`](https://github.com/nodejs/node/commit/07dfed8f45)] - **doc**: fix confusing example in dns.md (Vse Mozhet Byt) [#11022](https://github.com/nodejs/node/pull/11022) * [[`d55d760086`](https://github.com/nodejs/node/commit/d55d760086)] - **doc**: add personal pronouns option (Rich Trott) [#11089](https://github.com/nodejs/node/pull/11089) * [[`b86843a463`](https://github.com/nodejs/node/commit/b86843a463)] - **doc**: clarify msg when doc/api/cli.md not updated (Stewart X Addison) [#10872](https://github.com/nodejs/node/pull/10872) * [[`c2d70908e6`](https://github.com/nodejs/node/commit/c2d70908e6)] - **doc**: edit stability text for clarity and style (Rich Trott) [#11112](https://github.com/nodejs/node/pull/11112) * [[`115448ec94`](https://github.com/nodejs/node/commit/115448ec94)] - **doc**: remove assertions about assert (Rich Trott) [#11113](https://github.com/nodejs/node/pull/11113) * [[`e90317d739`](https://github.com/nodejs/node/commit/e90317d739)] - **doc**: fix "initial delay" link in http.md (Timo Tijhof) [#11108](https://github.com/nodejs/node/pull/11108) * [[`788d736ab6`](https://github.com/nodejs/node/commit/788d736ab6)] - **doc**: typographical fixes in COLLABORATOR_GUIDE.md (Anna Henningsen) [#11163](https://github.com/nodejs/node/pull/11163) * [[`2016aa4e07`](https://github.com/nodejs/node/commit/2016aa4e07)] - **doc**: add not-an-aardvark as ESLint contact (Rich Trott) [#11169](https://github.com/nodejs/node/pull/11169) * [[`2b6ee39264`](https://github.com/nodejs/node/commit/2b6ee39264)] - **doc**: improve testing guide (Joyee Cheung) [#11150](https://github.com/nodejs/node/pull/11150) * [[`aae768c599`](https://github.com/nodejs/node/commit/aae768c599)] - **doc**: remove extraneous paragraph from assert doc (Rich Trott) [#11174](https://github.com/nodejs/node/pull/11174) * [[`ca4b2f6154`](https://github.com/nodejs/node/commit/ca4b2f6154)] - **doc**: fix typo in dgram doc (Rich Trott) [#11186](https://github.com/nodejs/node/pull/11186) * [[`bb1e97c31a`](https://github.com/nodejs/node/commit/bb1e97c31a)] - **doc**: add and fix System Error properties (Daiki Arai) [#10986](https://github.com/nodejs/node/pull/10986) * [[`e1e02efac5`](https://github.com/nodejs/node/commit/e1e02efac5)] - **doc**: clarify the behavior of Buffer.byteLength (Nikolai Vavilov) [#11238](https://github.com/nodejs/node/pull/11238) * [[`30d9202f54`](https://github.com/nodejs/node/commit/30d9202f54)] - **doc**: improve consistency in documentation titles (Vse Mozhet Byt) [#11230](https://github.com/nodejs/node/pull/11230) * [[`10afa8befc`](https://github.com/nodejs/node/commit/10afa8befc)] - **doc**: drop "and io.js" from release section (Ben Noordhuis) [#11054](https://github.com/nodejs/node/pull/11054) * [[`6f1db35e27`](https://github.com/nodejs/node/commit/6f1db35e27)] - **doc**: update email and add personal pronoun (JungMinu) [#11318](https://github.com/nodejs/node/pull/11318) * [[`61ac3346ba`](https://github.com/nodejs/node/commit/61ac3346ba)] - **doc**: update code examples in domain.md (Vse Mozhet Byt) [#11110](https://github.com/nodejs/node/pull/11110) * [[`0c9ea4fe8b`](https://github.com/nodejs/node/commit/0c9ea4fe8b)] - **doc**: dns examples implied string args were arrays (Sam Roberts) [#11350](https://github.com/nodejs/node/pull/11350) * [[`485ec6c180`](https://github.com/nodejs/node/commit/485ec6c180)] - **doc**: change STYLE-GUIDE to STYLE_GUIDE (Dean Coakley) [#11460](https://github.com/nodejs/node/pull/11460) * [[`41bf266b0a`](https://github.com/nodejs/node/commit/41bf266b0a)] - **doc**: add STYLE_GUIDE (moved from nodejs/docs) (Gibson Fahnestock) [#11321](https://github.com/nodejs/node/pull/11321) * [[`6abfcd560b`](https://github.com/nodejs/node/commit/6abfcd560b)] - **doc**: add comment for net.Server's error event (QianJin2013) [#11136](https://github.com/nodejs/node/pull/11136) * [[`f4bc12dd11`](https://github.com/nodejs/node/commit/f4bc12dd11)] - **doc**: note message event listeners ref IPC channels (Diego Rodríguez Baquero) [#11494](https://github.com/nodejs/node/pull/11494) * [[`09c9105a79`](https://github.com/nodejs/node/commit/09c9105a79)] - **doc**: argument types for assert methods (Amelia Clarke) [#11548](https://github.com/nodejs/node/pull/11548) * [[`d622b67302`](https://github.com/nodejs/node/commit/d622b67302)] - **doc**: document clientRequest.aborted (Zach Bjornson) [#11544](https://github.com/nodejs/node/pull/11544) * [[`d0dbf12884`](https://github.com/nodejs/node/commit/d0dbf12884)] - **doc**: update TheAlphaNerd to MylesBorins (Myles Borins) [#10586](https://github.com/nodejs/node/pull/10586) * [[`05273c5a4e`](https://github.com/nodejs/node/commit/05273c5a4e)] - **doc**: update AUTHORS list to fix name (Noah Rose Ledesma) [#10945](https://github.com/nodejs/node/pull/10945) * [[`79f700c891`](https://github.com/nodejs/node/commit/79f700c891)] - **doc**: add TimothyGu to collaborators (Timothy Gu) [#10954](https://github.com/nodejs/node/pull/10954) * [[`e656a4244a`](https://github.com/nodejs/node/commit/e656a4244a)] - **doc**: add edsadr to collaborators (Adrian Estrada) [#10883](https://github.com/nodejs/node/pull/10883) * [[`6d0e1621e5`](https://github.com/nodejs/node/commit/6d0e1621e5)] - **doc**: clarifying variables in fs.write() (Jessica Quynh Tran) [#9792](https://github.com/nodejs/node/pull/9792) * [[`7287dddd69`](https://github.com/nodejs/node/commit/7287dddd69)] - **doc**: add links for zlib convenience methods (Anna Henningsen) [#10829](https://github.com/nodejs/node/pull/10829) * [[`b10842ac77`](https://github.com/nodejs/node/commit/b10842ac77)] - **doc**: sort require statements in tests (Sam Roberts) [#10616](https://github.com/nodejs/node/pull/10616) * [[`8f0e31b2d9`](https://github.com/nodejs/node/commit/8f0e31b2d9)] - **doc**: add test naming information to guide (Rich Trott) [#10584](https://github.com/nodejs/node/pull/10584) * [[`56b779db93`](https://github.com/nodejs/node/commit/56b779db93)] - **doc**: "s/git apply/git am -3" in V8 guide (Myles Borins) [#10665](https://github.com/nodejs/node/pull/10665) * [[`3be7a7adb5`](https://github.com/nodejs/node/commit/3be7a7adb5)] - **doc**: update LTS info for current releases (Evan Lucas) [#10720](https://github.com/nodejs/node/pull/10720) * [[`530adfdb2a`](https://github.com/nodejs/node/commit/530adfdb2a)] - **doc**: improve rinfo object documentation (Matt Crummey) [#10050](https://github.com/nodejs/node/pull/10050) * [[`48b5097ea8`](https://github.com/nodejs/node/commit/48b5097ea8)] - **http**: make request.abort() destroy the socket (Luigi Pinca) [#10818](https://github.com/nodejs/node/pull/10818) * [[`15231aa6e5`](https://github.com/nodejs/node/commit/15231aa6e5)] - **http**: reject control characters in http.request() (Ben Noordhuis) [#8923](https://github.com/nodejs/node/pull/8923) * [[`fc2cd63998`](https://github.com/nodejs/node/commit/fc2cd63998)] - **lib,src**: support values \> 4GB in heap statistics (Ben Noordhuis) [#10186](https://github.com/nodejs/node/pull/10186) * [[`533d2bf0a9`](https://github.com/nodejs/node/commit/533d2bf0a9)] - **meta**: add explicit deprecation and semver-major policy (James M Snell) [#7964](https://github.com/nodejs/node/pull/7964) * [[`923309adef`](https://github.com/nodejs/node/commit/923309adef)] - **meta**: remove Chris Dickinson from CTC (Chris Dickinson) [#11267](https://github.com/nodejs/node/pull/11267) * [[`342c3e2bb4`](https://github.com/nodejs/node/commit/342c3e2bb4)] - **meta**: adding Italo A. Casas PGP Fingerprint (Italo A. Casas) [#11202](https://github.com/nodejs/node/pull/11202) * [[`434b00be8a`](https://github.com/nodejs/node/commit/434b00be8a)] - **meta**: decharter the http working group (James M Snell) [#10604](https://github.com/nodejs/node/pull/10604) * [[`a7df345921`](https://github.com/nodejs/node/commit/a7df345921)] - **net**: prefer === to == (Arseniy Maximov) [#11513](https://github.com/nodejs/node/pull/11513) * [[`396688f075`](https://github.com/nodejs/node/commit/396688f075)] - **readline**: refactor construct Interface (Jackson Tian) [#4740](https://github.com/nodejs/node/pull/4740) * [[`a40f8429e6`](https://github.com/nodejs/node/commit/a40f8429e6)] - **readline**: update 6 comparions to strict (Umair Ishaq) [#11078](https://github.com/nodejs/node/pull/11078) * [[`90d8e118fb`](https://github.com/nodejs/node/commit/90d8e118fb)] - **src**: add a missing space in node_os.cc (Alexey Orlenko) [#10931](https://github.com/nodejs/node/pull/10931) * [[`279cb09cc3`](https://github.com/nodejs/node/commit/279cb09cc3)] - **src**: enable writev for pipe handles on Unix (Alexey Orlenko) [#10677](https://github.com/nodejs/node/pull/10677) * [[`a557d6ce1d`](https://github.com/nodejs/node/commit/a557d6ce1d)] - **src**: unconsume stream fix in internal http impl (Roee Kasher) [#11015](https://github.com/nodejs/node/pull/11015) * [[`c4e1af712e`](https://github.com/nodejs/node/commit/c4e1af712e)] - **src**: remove unused typedef (Ben Noordhuis) [#11322](https://github.com/nodejs/node/pull/11322) * [[`da2adb7133`](https://github.com/nodejs/node/commit/da2adb7133)] - **src**: update http-parser link (Daniel Bevenius) [#11477](https://github.com/nodejs/node/pull/11477) * [[`2f48001574`](https://github.com/nodejs/node/commit/2f48001574)] - **src**: use ABORT() macro instead of abort() (Evan Lucas) [#9613](https://github.com/nodejs/node/pull/9613) * [[`a9eb093ce3`](https://github.com/nodejs/node/commit/a9eb093ce3)] - **src**: fix memory leak introduced in 34febfbf4 (Ben Noordhuis) [#9604](https://github.com/nodejs/node/pull/9604) * [[`f854d8c789`](https://github.com/nodejs/node/commit/f854d8c789)] - **test**: increase setMulticastLoopback() coverage (cjihrig) [#11277](https://github.com/nodejs/node/pull/11277) * [[`1df09f9d37`](https://github.com/nodejs/node/commit/1df09f9d37)] - **test**: add known_issues test for #10223 (AnnaMag) [#11024](https://github.com/nodejs/node/pull/11024) * [[`be34b629de`](https://github.com/nodejs/node/commit/be34b629de)] - **test**: increase coverage for stream's duplex (abouthiroppy) [#10963](https://github.com/nodejs/node/pull/10963) * [[`dc24127e5c`](https://github.com/nodejs/node/commit/dc24127e5c)] - **test**: allow for slow hosts in spawnSync() test (Rich Trott) [#10998](https://github.com/nodejs/node/pull/10998) * [[`2f4b6bda97`](https://github.com/nodejs/node/commit/2f4b6bda97)] - **test**: expand test coverage of fs.js (Vinícius do Carmo) [#10947](https://github.com/nodejs/node/pull/10947) * [[`3f6a2dbc2f`](https://github.com/nodejs/node/commit/3f6a2dbc2f)] - **test**: enhance test-timers (Rich Trott) [#10960](https://github.com/nodejs/node/pull/10960) * [[`6ca9901d8b`](https://github.com/nodejs/node/commit/6ca9901d8b)] - **test**: add process.assert's test (abouthiroppy) [#10911](https://github.com/nodejs/node/pull/10911) * [[`d8af5a7431`](https://github.com/nodejs/node/commit/d8af5a7431)] - **test**: improve code in test-crypto-verify (Adrian Estrada) [#10845](https://github.com/nodejs/node/pull/10845) * [[`4d1f7b1df8`](https://github.com/nodejs/node/commit/4d1f7b1df8)] - **test**: add dgram.Socket.prototype.bind's test (abouthiroppy) [#10894](https://github.com/nodejs/node/pull/10894) * [[`6c1d82c68a`](https://github.com/nodejs/node/commit/6c1d82c68a)] - **test**: improving coverage for dgram (abouthiroppy) [#10783](https://github.com/nodejs/node/pull/10783) * [[`017afd48fd`](https://github.com/nodejs/node/commit/017afd48fd)] - **test**: improve code in test-console-instance (Adrian Estrada) [#10813](https://github.com/nodejs/node/pull/10813) * [[`1b1ba741c3`](https://github.com/nodejs/node/commit/1b1ba741c3)] - **test**: improve code in test-domain-multi (Adrian Estrada) [#10798](https://github.com/nodejs/node/pull/10798) * [[`ee27917a65`](https://github.com/nodejs/node/commit/ee27917a65)] - **test**: improve test-stream2-large-read-stall (stefan judis) [#10725](https://github.com/nodejs/node/pull/10725) * [[`9ac2316595`](https://github.com/nodejs/node/commit/9ac2316595)] - **test**: improve code in test-http-host-headers (Adrian Estrada) [#10830](https://github.com/nodejs/node/pull/10830) * [[`a9278a063f`](https://github.com/nodejs/node/commit/a9278a063f)] - **test**: refactor cluster-preload.js (abouthiroppy) [#10701](https://github.com/nodejs/node/pull/10701) * [[`db60d92e15`](https://github.com/nodejs/node/commit/db60d92e15)] - **test**: test hmac binding robustness (Sam Roberts) [#10923](https://github.com/nodejs/node/pull/10923) * [[`a1a850f066`](https://github.com/nodejs/node/commit/a1a850f066)] - **test**: don't connect to :: (use localhost instead) (Gibson Fahnestock) * [[`b3a8e95af3`](https://github.com/nodejs/node/commit/b3a8e95af3)] - **test**: improve test-assert (richnologies) [#10916](https://github.com/nodejs/node/pull/10916) * [[`56970efe51`](https://github.com/nodejs/node/commit/56970efe51)] - **test**: increase coverage for punycode's decode (abouthiroppy) [#10940](https://github.com/nodejs/node/pull/10940) * [[`df69c2148a`](https://github.com/nodejs/node/commit/df69c2148a)] - **test**: check fd 0,1,2 are used, not access mode (John Barboza) [#10339](https://github.com/nodejs/node/pull/10339) * [[`7bceb4fb48`](https://github.com/nodejs/node/commit/7bceb4fb48)] - **test**: add message verification on assert.throws (Travis Meisenheimer) [#10890](https://github.com/nodejs/node/pull/10890) * [[`1c223ecc70`](https://github.com/nodejs/node/commit/1c223ecc70)] - **test**: add http-common's test (abouthiroppy) [#10832](https://github.com/nodejs/node/pull/10832) * [[`89e9da6b6d`](https://github.com/nodejs/node/commit/89e9da6b6d)] - **test**: tests for _readableStream.awaitDrain (Mark) [#8914](https://github.com/nodejs/node/pull/8914) * [[`53b0f413cd`](https://github.com/nodejs/node/commit/53b0f413cd)] - **test**: improve the code in test-process-cpuUsage (Adrian Estrada) [#10714](https://github.com/nodejs/node/pull/10714) * [[`b3d1700d1f`](https://github.com/nodejs/node/commit/b3d1700d1f)] - **test**: improve tests in pummel/test-exec (Chase Starr) [#10757](https://github.com/nodejs/node/pull/10757) * [[`6e7dfb1f45`](https://github.com/nodejs/node/commit/6e7dfb1f45)] - **test**: fix temp-dir option in tools/test.py (Gibson Fahnestock) [#10723](https://github.com/nodejs/node/pull/10723) * [[`9abde3ac6e`](https://github.com/nodejs/node/commit/9abde3ac6e)] - **test**: use realpath for NODE_TEST_DIR in common.js (Gibson Fahnestock) [#10723](https://github.com/nodejs/node/pull/10723) * [[`f86c64a13a`](https://github.com/nodejs/node/commit/f86c64a13a)] - **test**: refactor the code of test-keep-alive.js (sivaprasanna) [#10684](https://github.com/nodejs/node/pull/10684) * [[`4d51db87dc`](https://github.com/nodejs/node/commit/4d51db87dc)] - **test**: refactor test-doctool-html.js (abouthiroppy) [#10696](https://github.com/nodejs/node/pull/10696) * [[`ab65429e44`](https://github.com/nodejs/node/commit/ab65429e44)] - **test**: refactor test-watch-file.js (sivaprasanna) [#10679](https://github.com/nodejs/node/pull/10679) * [[`4453c0c1dc`](https://github.com/nodejs/node/commit/4453c0c1dc)] - **test**: refactor the code in test-child-process-spawn-loop.js (sivaprasanna) [#10605](https://github.com/nodejs/node/pull/10605) * [[`42b86ea968`](https://github.com/nodejs/node/commit/42b86ea968)] - **test**: improve test-http-chunked-304 (Adrian Estrada) [#10462](https://github.com/nodejs/node/pull/10462) * [[`1ae95e64ee`](https://github.com/nodejs/node/commit/1ae95e64ee)] - **test**: improve test-fs-readfile-zero-byte-liar (Adrian Estrada) [#10570](https://github.com/nodejs/node/pull/10570) * [[`3f3c78d785`](https://github.com/nodejs/node/commit/3f3c78d785)] - **test**: refactor test-fs-utimes (Junshu Okamoto) [#9290](https://github.com/nodejs/node/pull/9290) * [[`50a868b3f7`](https://github.com/nodejs/node/commit/50a868b3f7)] - **test**: require handler to be run in sigwinch test (Rich Trott) [#11068](https://github.com/nodejs/node/pull/11068) * [[`c1f45ec2d0`](https://github.com/nodejs/node/commit/c1f45ec2d0)] - **test**: add 2nd argument to throws in test-assert (Marlena Compton) [#11061](https://github.com/nodejs/node/pull/11061) * [[`f24aa7e071`](https://github.com/nodejs/node/commit/f24aa7e071)] - **test**: improve error messages in test-npm-install (Gonen Dukas) [#11027](https://github.com/nodejs/node/pull/11027) * [[`1db89d4009`](https://github.com/nodejs/node/commit/1db89d4009)] - **test**: improve coverage on removeListeners functions (matsuda-koushi) [#11140](https://github.com/nodejs/node/pull/11140) * [[`c532c16e53`](https://github.com/nodejs/node/commit/c532c16e53)] - **test**: increase specificity in dgram test (Rich Trott) [#11187](https://github.com/nodejs/node/pull/11187) * [[`cb81ae8eea`](https://github.com/nodejs/node/commit/cb81ae8eea)] - **test**: add vm module edge cases (Franziska Hinkelmann) [#11265](https://github.com/nodejs/node/pull/11265) * [[`8629c956c3`](https://github.com/nodejs/node/commit/8629c956c3)] - **test**: improve punycode test coverage (Sebastian Van Sande) [#11144](https://github.com/nodejs/node/pull/11144) * [[`caf1ba15f9`](https://github.com/nodejs/node/commit/caf1ba15f9)] - **test**: add coverage for dgram _createSocketHandle() (cjihrig) [#11291](https://github.com/nodejs/node/pull/11291) * [[`d729e52ef3`](https://github.com/nodejs/node/commit/d729e52ef3)] - **test**: improve crypto coverage (Akito Ito) [#11280](https://github.com/nodejs/node/pull/11280) * [[`d1a8588cab`](https://github.com/nodejs/node/commit/d1a8588cab)] - **test**: improve message in net-connect-local-error (Rich Trott) [#11393](https://github.com/nodejs/node/pull/11393) * [[`f2fb4143b4`](https://github.com/nodejs/node/commit/f2fb4143b4)] - **test**: refactor test-dgram-membership (Rich Trott) [#11388](https://github.com/nodejs/node/pull/11388) * [[`bf4703d66f`](https://github.com/nodejs/node/commit/bf4703d66f)] - **test**: remove unused args and comparison fix (Alexander) [#11396](https://github.com/nodejs/node/pull/11396) * [[`28471c23ff`](https://github.com/nodejs/node/commit/28471c23ff)] - **test**: refactor test-http-response-splitting (Arseniy Maximov) [#11429](https://github.com/nodejs/node/pull/11429) * [[`cd3e17e248`](https://github.com/nodejs/node/commit/cd3e17e248)] - **test**: improve coverage in test-crypto.dh (Eric Christie) [#11253](https://github.com/nodejs/node/pull/11253) * [[`fa681ea55a`](https://github.com/nodejs/node/commit/fa681ea55a)] - **test**: add regex check to test-module-loading (Tarang Hirani) [#11413](https://github.com/nodejs/node/pull/11413) * [[`f0eee61a93`](https://github.com/nodejs/node/commit/f0eee61a93)] - **test**: throw check in test-zlib-write-after-close (Jason Wilson) [#11482](https://github.com/nodejs/node/pull/11482) * [[`f0c7c7fad4`](https://github.com/nodejs/node/commit/f0c7c7fad4)] - **test**: fix flaky test-vm-timeout-rethrow (Kunal Pathak) [#11530](https://github.com/nodejs/node/pull/11530) * [[`53f2848dc8`](https://github.com/nodejs/node/commit/53f2848dc8)] - **test**: favor assertions over console logging (Rich Trott) [#11547](https://github.com/nodejs/node/pull/11547) * [[`0109321fd8`](https://github.com/nodejs/node/commit/0109321fd8)] - **test**: refactor test-https-truncate (Rich Trott) [#10225](https://github.com/nodejs/node/pull/10225) * [[`536733697c`](https://github.com/nodejs/node/commit/536733697c)] - **test**: simplify test-http-client-unescaped-path (Rod Vagg) [#9649](https://github.com/nodejs/node/pull/9649) * [[`4ce9bfb4e7`](https://github.com/nodejs/node/commit/4ce9bfb4e7)] - **test**: exclude pseudo-tty test pertinent to #11541 (Gireesh Punathil) [#11602](https://github.com/nodejs/node/pull/11602) * [[`53dd1a8539`](https://github.com/nodejs/node/commit/53dd1a8539)] - **tls**: do not crash on STARTTLS when OCSP requested (Fedor Indutny) [#10706](https://github.com/nodejs/node/pull/10706) * [[`e607ff52fa`](https://github.com/nodejs/node/commit/e607ff52fa)] - **tools**: rename eslintrc to an undeprecated format (Sakthipriyan Vairamani) [#7699](https://github.com/nodejs/node/pull/7699) * [[`6648b729b7`](https://github.com/nodejs/node/commit/6648b729b7)] - **tools**: add compile_commands.json gyp generator (Ben Noordhuis) [#7986](https://github.com/nodejs/node/pull/7986) * [[`8f49962f47`](https://github.com/nodejs/node/commit/8f49962f47)] - **tools**: suggest python2 command in configure (Roman Reiss) [#11375](https://github.com/nodejs/node/pull/11375) * [[`4b83a83c06`](https://github.com/nodejs/node/commit/4b83a83c06)] - **tools,doc**: add Google Analytics tracking. (Phillip Johnsen) [#6601](https://github.com/nodejs/node/pull/6601) * [[`ef63af6006`](https://github.com/nodejs/node/commit/ef63af6006)] - **tty**: avoid oob warning in TTYWrap::GetWindowSize() (Dmitry Tsvettsikh) [#11454](https://github.com/nodejs/node/pull/11454) * [[`2c84601062`](https://github.com/nodejs/node/commit/2c84601062)] - **util**: don't init Debug if it's not needed yet (Bryan English) [#8452](https://github.com/nodejs/node/pull/8452) ## 2017-02-21, Version 4.8.0 'Argon' (LTS), @MylesBorins This LTS release comes with 118 commits. This includes 73 which are doc related, 19 which are test related, 6 which are build / tool related, and 5 commits which are updates to dependencies. ### Notable Changes * **child_process**: add shell option to spawn() (cjihrig) [#4598](https://github.com/nodejs/node/pull/4598) * **deps**: * **v8**: expose statistics about heap spaces (Ben Ripkens) [#4463](https://github.com/nodejs/node/pull/4463) * **crypto**: * add ALPN Support (Shigeki Ohtsu) [#2564](https://github.com/nodejs/node/pull/2564) * allow adding extra certs to well-known CAs (Sam Roberts) [#9139](https://github.com/nodejs/node/pull/9139) * **fs**: add the fs.mkdtemp() function. (Florian MARGAINE) [#5333](https://github.com/nodejs/node/pull/5333) * **process**: * add `externalMemory` to `process` (Fedor Indutny) [#9587](https://github.com/nodejs/node/pull/9587) * add process.cpuUsage() (Patrick Mueller) [#10796](https://github.com/nodejs/node/pull/10796) ### Commits * [[`78010aa0cd`](https://github.com/nodejs/node/commit/78010aa0cd)] - **build**: add /opt/freeware/... to AIX library path (Stewart X Addison) [#10128](https://github.com/nodejs/node/pull/10128) * [[`0bb77f24fa`](https://github.com/nodejs/node/commit/0bb77f24fa)] - **build**: add (not) cross-compiled configure flags (Jesús Leganés-Combarro 'piranna) [#10287](https://github.com/nodejs/node/pull/10287) * [[`58245225ef`](https://github.com/nodejs/node/commit/58245225ef)] - **(SEMVER-MINOR)** **child_process**: add shell option to spawn() (cjihrig) [#4598](https://github.com/nodejs/node/pull/4598) * [[`1595328b44`](https://github.com/nodejs/node/commit/1595328b44)] - **(SEMVER-MINOR)** **crypto**: allow adding extra certs to well-known CAs (Sam Roberts) [#9139](https://github.com/nodejs/node/pull/9139) * [[`bf882fba35`](https://github.com/nodejs/node/commit/bf882fba35)] - **crypto**: Use reference count to manage cert_store (Adam Majer) [#9409](https://github.com/nodejs/node/pull/9409) * [[`4cf7dcff99`](https://github.com/nodejs/node/commit/4cf7dcff99)] - **crypto**: remove unnecessary variables of alpn/npn (Shigeki Ohtsu) [#10831](https://github.com/nodejs/node/pull/10831) * [[`d8b902f787`](https://github.com/nodejs/node/commit/d8b902f787)] - **debugger**: call `this.resume()` after `this.run()` (Lance Ball) [#10099](https://github.com/nodejs/node/pull/10099) * [[`4e07bd45d6`](https://github.com/nodejs/node/commit/4e07bd45d6)] - **deps**: update patch level in V8 (Myles Borins) [#10668](https://github.com/nodejs/node/pull/10668) * [[`a234d445c4`](https://github.com/nodejs/node/commit/a234d445c4)] - **deps**: backport a715957 from V8 upstream (Myles Borins) [#10668](https://github.com/nodejs/node/pull/10668) * [[`ce66c8e424`](https://github.com/nodejs/node/commit/ce66c8e424)] - **deps**: backport 7a88ff3 from V8 upstream (Myles Borins) [#10668](https://github.com/nodejs/node/pull/10668) * [[`8bd3d83e01`](https://github.com/nodejs/node/commit/8bd3d83e01)] - **deps**: backport d800a65 from V8 upstream (Myles Borins) [#10668](https://github.com/nodejs/node/pull/10668) * [[`81e9a3bfcb`](https://github.com/nodejs/node/commit/81e9a3bfcb)] - **deps**: V8: fix debug backtrace for symbols (Ali Ijaz Sheikh) [#10732](https://github.com/nodejs/node/pull/10732) * [[`d8961bdb3b`](https://github.com/nodejs/node/commit/d8961bdb3b)] - **doc**: correct vcbuild options for windows testing (Jonathan Boarman) [#10686](https://github.com/nodejs/node/pull/10686) * [[`d3c5bc1c63`](https://github.com/nodejs/node/commit/d3c5bc1c63)] - **doc**: update BUILDING.md (rainabba) [#8704](https://github.com/nodejs/node/pull/8704) * [[`d61c181085`](https://github.com/nodejs/node/commit/d61c181085)] - **doc**: unify dirname and filename description (Sam Roberts) [#10527](https://github.com/nodejs/node/pull/10527) * [[`8eeccd82d2`](https://github.com/nodejs/node/commit/8eeccd82d2)] - **doc**: killSignal option accepts integer values (Sakthipriyan Vairamani (thefourtheye)) [#10424](https://github.com/nodejs/node/pull/10424) * [[`7db7e47d7b`](https://github.com/nodejs/node/commit/7db7e47d7b)] - **doc**: change logical to bitwise OR in dns lookup (Sakthipriyan Vairamani (thefourtheye)) [#11037](https://github.com/nodejs/node/pull/11037) * [[`28b707ba42`](https://github.com/nodejs/node/commit/28b707ba42)] - **doc**: replace newlines in deprecation with space (Sakthipriyan Vairamani (thefourtheye)) [#11074](https://github.com/nodejs/node/pull/11074) * [[`79d49866f2`](https://github.com/nodejs/node/commit/79d49866f2)] - **doc**: update CONTRIBUTING.MD with link to V8 guide (sarahmeyer) [#10070](https://github.com/nodejs/node/pull/10070) * [[`acbe4d3516`](https://github.com/nodejs/node/commit/acbe4d3516)] - **doc**: add joyeecheung to collaborators (Joyee Cheung) [#10603](https://github.com/nodejs/node/pull/10603) * [[`c7378c4d5f`](https://github.com/nodejs/node/commit/c7378c4d5f)] - **doc**: warn about unvalidated input in child_process (Matthew Garrett) [#10466](https://github.com/nodejs/node/pull/10466) * [[`08e924e45c`](https://github.com/nodejs/node/commit/08e924e45c)] - **doc**: require two-factor authentication (Rich Trott) [#10529](https://github.com/nodejs/node/pull/10529) * [[`d260fb2e7e`](https://github.com/nodejs/node/commit/d260fb2e7e)] - **doc**: use "Node.js" in V8 guide (Rich Trott) [#10438](https://github.com/nodejs/node/pull/10438) * [[`4f168a4a31`](https://github.com/nodejs/node/commit/4f168a4a31)] - **doc**: require() tries first core not native modules (Vicente Jimenez Aguilar) [#10324](https://github.com/nodejs/node/pull/10324) * [[`5777c79c52`](https://github.com/nodejs/node/commit/5777c79c52)] - **doc**: clarify the review and landing process (Joyee Cheung) [#10202](https://github.com/nodejs/node/pull/10202) * [[`d3a7fb8a9e`](https://github.com/nodejs/node/commit/d3a7fb8a9e)] - **doc**: redirect 'Start a Working Group' to TSC repo (William Kapke) [#9655](https://github.com/nodejs/node/pull/9655) * [[`0e51cbb827`](https://github.com/nodejs/node/commit/0e51cbb827)] - **doc**: add Working Group dissolution text (William Kapke) [#9656](https://github.com/nodejs/node/pull/9656) * [[`919e0cb8f2`](https://github.com/nodejs/node/commit/919e0cb8f2)] - **doc**: more efficient example in the console.md (Vse Mozhet Byt) [#10451](https://github.com/nodejs/node/pull/10451) * [[`70ea38f2ee`](https://github.com/nodejs/node/commit/70ea38f2ee)] - **doc**: var -> const / let in the console.md (Vse Mozhet Byt) [#10451](https://github.com/nodejs/node/pull/10451) * [[`dda777bf9e`](https://github.com/nodejs/node/commit/dda777bf9e)] - **doc**: consistent 'Returns:' part two (Myles Borins) [#10391](https://github.com/nodejs/node/pull/10391) * [[`3b252a69a0`](https://github.com/nodejs/node/commit/3b252a69a0)] - **doc**: clarify macosx-firewall suggestion BUILDING (Chase Starr) [#10311](https://github.com/nodejs/node/pull/10311) * [[`c4df02c815`](https://github.com/nodejs/node/commit/c4df02c815)] - **doc**: add Michaël Zasso to the CTC (Michaël Zasso) * [[`2269d7db0f`](https://github.com/nodejs/node/commit/2269d7db0f)] - **(SEMVER-MINOR)** **fs**: add the fs.mkdtemp() function. (Florian MARGAINE) [#5333](https://github.com/nodejs/node/pull/5333) * [[`2eda3c7c75`](https://github.com/nodejs/node/commit/2eda3c7c75)] - **lib,test**: use consistent operator linebreak style (Michaël Zasso) [#10178](https://github.com/nodejs/node/pull/10178) * [[`7505b86d2f`](https://github.com/nodejs/node/commit/7505b86d2f)] - **os**: fix os.release() for aix and add test (jBarz) [#10245](https://github.com/nodejs/node/pull/10245) * [[`7a9c8d8f10`](https://github.com/nodejs/node/commit/7a9c8d8f10)] - **(SEMVER-MINOR)** **process**: add process.cpuUsage() - implementation, doc, tests (Patrick Mueller) [#10796](https://github.com/nodejs/node/pull/10796) * [[`23a573f7cb`](https://github.com/nodejs/node/commit/23a573f7cb)] - **(SEMVER-MINOR)** **process**: add `process.memoryUsage.external` (Fedor Indutny) [#9587](https://github.com/nodejs/node/pull/9587) * [[`be6203715a`](https://github.com/nodejs/node/commit/be6203715a)] - **src**: describe what NODE_MODULE_VERSION is for (Sam Roberts) [#10414](https://github.com/nodejs/node/pull/10414) * [[`3f29cbb5bc`](https://github.com/nodejs/node/commit/3f29cbb5bc)] - **src**: fix string format mistake for 32 bit node (Alex Newman) [#10082](https://github.com/nodejs/node/pull/10082) * [[`271f5783fe`](https://github.com/nodejs/node/commit/271f5783fe)] - **stream, test**: test _readableState.emittedReadable (Joyee Cheung) [#10249](https://github.com/nodejs/node/pull/10249) * [[`c279cbe6a9`](https://github.com/nodejs/node/commit/c279cbe6a9)] - **test**: fix test.py command line options processing (Julien Gilli) [#11153](https://github.com/nodejs/node/pull/11153) * [[`0f5d82e583`](https://github.com/nodejs/node/commit/0f5d82e583)] - **test**: add --abort-on-timeout option to test.py (Julien Gilli) [#11086](https://github.com/nodejs/node/pull/11086) * [[`735119c6fb`](https://github.com/nodejs/node/commit/735119c6fb)] - **test**: cleanup stream tests (Italo A. Casas) [#8668](https://github.com/nodejs/node/pull/8668) * [[`f9f8e4ee3e`](https://github.com/nodejs/node/commit/f9f8e4ee3e)] - **test**: refactor test-preload (Rich Trott) [#9803](https://github.com/nodejs/node/pull/9803) * [[`e7c4dfb83b`](https://github.com/nodejs/node/commit/e7c4dfb83b)] - **test**: invalid package.json causes error when require()ing in directory (Sam Shull) [#10044](https://github.com/nodejs/node/pull/10044) * [[`22226fa900`](https://github.com/nodejs/node/commit/22226fa900)] - **test**: refactoring test-pipe-head (Travis Bretton) [#10036](https://github.com/nodejs/node/pull/10036) * [[`11115c0d85`](https://github.com/nodejs/node/commit/11115c0d85)] - **test**: add second argument to assert.throws() (Ken Russo) [#9987](https://github.com/nodejs/node/pull/9987) * [[`96ca40bdd8`](https://github.com/nodejs/node/commit/96ca40bdd8)] - **test**: refactor test-tls-0-dns-altname (Richard Karmazin) [#9948](https://github.com/nodejs/node/pull/9948) * [[`98496b6d3e`](https://github.com/nodejs/node/commit/98496b6d3e)] - **test**: test: refactor test-sync-fileread (Jason Wohlgemuth) [#9941](https://github.com/nodejs/node/pull/9941) * [[`324c82b1c9`](https://github.com/nodejs/node/commit/324c82b1c9)] - **test**: use common.fixturesDir almost everywhere (Bryan English) [#6997](https://github.com/nodejs/node/pull/6997) * [[`ce91bb21ba`](https://github.com/nodejs/node/commit/ce91bb21ba)] - **test**: refactor test-repl-mode.js (Cesar Hernandez) [#10061](https://github.com/nodejs/node/pull/10061) * [[`61cbc202a1`](https://github.com/nodejs/node/commit/61cbc202a1)] - **test**: refactor test-net-dns-custom-lookup (Kent.Fan) [#10071](https://github.com/nodejs/node/pull/10071) * [[`812c6361ff`](https://github.com/nodejs/node/commit/812c6361ff)] - **test**: refactor test-tls-server-verify (Hutson Betts) [#10076](https://github.com/nodejs/node/pull/10076) * [[`19907c27a6`](https://github.com/nodejs/node/commit/19907c27a6)] - **test**: use mustCall() for simple flow tracking (cjihrig) [#7753](https://github.com/nodejs/node/pull/7753) * [[`42da81e6cc`](https://github.com/nodejs/node/commit/42da81e6cc)] - **test**: set stdin too for pseudo-tty tests (Anna Henningsen) [#10149](https://github.com/nodejs/node/pull/10149) * [[`53404dbc1f`](https://github.com/nodejs/node/commit/53404dbc1f)] - **test**: add stdin-setrawmode.out file (Jonathan Darling) [#10149](https://github.com/nodejs/node/pull/10149) * [[`1fac431307`](https://github.com/nodejs/node/commit/1fac431307)] - **test**: add tests for clearBuffer state machine (Safia Abdalla) [#9922](https://github.com/nodejs/node/pull/9922) * [[`37a362275e`](https://github.com/nodejs/node/commit/37a362275e)] - **test**: update test-cluster-shared-handle-bind-error (cjihrig) [#10547](https://github.com/nodejs/node/pull/10547) * [[`f5e54f5d5f`](https://github.com/nodejs/node/commit/f5e54f5d5f)] - **test**: avoid assigning this to variables (cjihrig) [#10548](https://github.com/nodejs/node/pull/10548) * [[`28a5ce10af`](https://github.com/nodejs/node/commit/28a5ce10af)] - **test**: improve test-http-allow-req-after-204-res (Adrian Estrada) [#10503](https://github.com/nodejs/node/pull/10503) * [[`52edebc8f3`](https://github.com/nodejs/node/commit/52edebc8f3)] - **test**: improve test-fs-empty-readStream.js (Adrian Estrada) [#10479](https://github.com/nodejs/node/pull/10479) * [[`b74bc517a6`](https://github.com/nodejs/node/commit/b74bc517a6)] - **test**: use strictEqual in test-http-server (Fabrice Tatieze) [#10478](https://github.com/nodejs/node/pull/10478) * [[`a9cd1d1267`](https://github.com/nodejs/node/commit/a9cd1d1267)] - **test**: refactor test-stream2-unpipe-drain (Chris Story) [#10033](https://github.com/nodejs/node/pull/10033) * [[`7020e9fd8b`](https://github.com/nodejs/node/commit/7020e9fd8b)] - **test**: add test for SIGWINCH handling by stdio.js (Sarah Meyer) [#10063](https://github.com/nodejs/node/pull/10063) * [[`56b193a9c2`](https://github.com/nodejs/node/commit/56b193a9c2)] - **test**: improve code in test-vm-preserves-property (Adrian Estrada) [#10428](https://github.com/nodejs/node/pull/10428) * [[`8a26ba142f`](https://github.com/nodejs/node/commit/8a26ba142f)] - **test**: fix flaky test-https-timeout (Rich Trott) [#10404](https://github.com/nodejs/node/pull/10404) * [[`eeb2d7885a`](https://github.com/nodejs/node/commit/eeb2d7885a)] - **test**: improve test-cluster-worker-constructor.js (Adrian Estrada) [#10396](https://github.com/nodejs/node/pull/10396) * [[`fd195b47d6`](https://github.com/nodejs/node/commit/fd195b47d6)] - **test**: stream readable resumeScheduled state (Italo A. Casas) [#10299](https://github.com/nodejs/node/pull/10299) * [[`135a7c9e19`](https://github.com/nodejs/node/commit/135a7c9e19)] - **test**: stream readable needReadable state (Joyee Cheung) [#10241](https://github.com/nodejs/node/pull/10241) * [[`f412b1fcfd`](https://github.com/nodejs/node/commit/f412b1fcfd)] - **test**: clean up domain-no-error-handler test (weyj4) [#10291](https://github.com/nodejs/node/pull/10291) * [[`14c28ebcf1`](https://github.com/nodejs/node/commit/14c28ebcf1)] - **test**: update test-domain-uncaught-exception.js (Andy Chen) [#10193](https://github.com/nodejs/node/pull/10193) * [[`928291c652`](https://github.com/nodejs/node/commit/928291c652)] - **test**: refactor test-domain.js (Siddhartha Sahai) [#10207](https://github.com/nodejs/node/pull/10207) * [[`13c6cec433`](https://github.com/nodejs/node/commit/13c6cec433)] - **test**: fail for missing output files (Anna Henningsen) [#10150](https://github.com/nodejs/node/pull/10150) * [[`544920f77b`](https://github.com/nodejs/node/commit/544920f77b)] - **test**: stream readableState readingMore state (Gregory) [#9868](https://github.com/nodejs/node/pull/9868) * [[`2f8bc9a7bc`](https://github.com/nodejs/node/commit/2f8bc9a7bc)] - **test**: s/ASSERT/assert/ (cjihrig) [#10544](https://github.com/nodejs/node/pull/10544) * [[`380a5d5e12`](https://github.com/nodejs/node/commit/380a5d5e12)] - **test**: fix flaky test-http-client-timeout-with-data (Rich Trott) [#10431](https://github.com/nodejs/node/pull/10431) * [[`14e07c96e1`](https://github.com/nodejs/node/commit/14e07c96e1)] - **test**: refactor test-stdin-from-file (Rob Adelmann) [#10331](https://github.com/nodejs/node/pull/10331) * [[`424c86139d`](https://github.com/nodejs/node/commit/424c86139d)] - **test**: refactor the code in test-fs-chmod (Adrian Estrada) [#10440](https://github.com/nodejs/node/pull/10440) * [[`31aa877003`](https://github.com/nodejs/node/commit/31aa877003)] - **test**: improve the code in test-pipe.js (Adrian Estrada) [#10452](https://github.com/nodejs/node/pull/10452) * [[`4bbd50ee07`](https://github.com/nodejs/node/commit/4bbd50ee07)] - **test**: improve code in test-fs-readfile-error (Adrian Estrada) [#10367](https://github.com/nodejs/node/pull/10367) * [[`9840f505f0`](https://github.com/nodejs/node/commit/9840f505f0)] - **test**: improve code in test-vm-symbols (Adrian Estrada) [#10429](https://github.com/nodejs/node/pull/10429) * [[`4efdbafeb3`](https://github.com/nodejs/node/commit/4efdbafeb3)] - **test**: refactor test-child-process-ipc (malen) [#9990](https://github.com/nodejs/node/pull/9990) * [[`dbfec29663`](https://github.com/nodejs/node/commit/dbfec29663)] - **test**: fix and improve debug-break-on-uncaught (Sakthipriyan Vairamani (thefourtheye)) [#10370](https://github.com/nodejs/node/pull/10370) * [[`80f4a37023`](https://github.com/nodejs/node/commit/80f4a37023)] - **test**: refactor test-pipe-file-to-http (Josh Mays) [#10054](https://github.com/nodejs/node/pull/10054) * [[`a983400ac2`](https://github.com/nodejs/node/commit/a983400ac2)] - **test**: refactor test-tls-interleave (Brian Chirgwin) [#10017](https://github.com/nodejs/node/pull/10017) * [[`6db76da2c8`](https://github.com/nodejs/node/commit/6db76da2c8)] - **test**: refactor test-cluster-send-handle-twice.js (Amar Zavery) [#10049](https://github.com/nodejs/node/pull/10049) * [[`19b314e40a`](https://github.com/nodejs/node/commit/19b314e40a)] - **test**: update test-tls-check-server-identity.js (Kevin Cox) [#9986](https://github.com/nodejs/node/pull/9986) * [[`ab3e4c6a9b`](https://github.com/nodejs/node/commit/ab3e4c6a9b)] - **test**: improve test-cluster-net-listen.js (Rico Cai) [#9953](https://github.com/nodejs/node/pull/9953) * [[`fb9a0ad6c0`](https://github.com/nodejs/node/commit/fb9a0ad6c0)] - **test**: refactor test-child-process-stdin (Segu Riluvan) [#10420](https://github.com/nodejs/node/pull/10420) * [[`122917df5a`](https://github.com/nodejs/node/commit/122917df5a)] - **test**: change var declarations, add mustCall check (Daniel Sims) [#9962](https://github.com/nodejs/node/pull/9962) * [[`d5e911c51e`](https://github.com/nodejs/node/commit/d5e911c51e)] - **test**: refactoring test-cluster-worker-constructor (Christopher Rokita) [#9956](https://github.com/nodejs/node/pull/9956) * [[`7d61bbf647`](https://github.com/nodejs/node/commit/7d61bbf647)] - **test**: refactor test-stdin-script-child (Emanuel Buholzer) [#10321](https://github.com/nodejs/node/pull/10321) * [[`76bb3cbff9`](https://github.com/nodejs/node/commit/76bb3cbff9)] - **test**: refactor test-stream2-writable (Rich Trott) [#10353](https://github.com/nodejs/node/pull/10353) * [[`b87ee26b96`](https://github.com/nodejs/node/commit/b87ee26b96)] - **test**: change assert.strict to assert.strictEqual() (Ashita Nagesh) [#9988](https://github.com/nodejs/node/pull/9988) * [[`4514fd78f4`](https://github.com/nodejs/node/commit/4514fd78f4)] - **test**: refactor the code in test-http-keep-alive (Adrian Estrada) [#10350](https://github.com/nodejs/node/pull/10350) * [[`f301df405a`](https://github.com/nodejs/node/commit/f301df405a)] - **test**: use strictEqual in test-cwd-enoent-repl.js (Neeraj Sharma) [#9952](https://github.com/nodejs/node/pull/9952) * [[`3b67001c99`](https://github.com/nodejs/node/commit/3b67001c99)] - **test**: refactor test-net-reconnect-error (Duy Le) [#9903](https://github.com/nodejs/node/pull/9903) * [[`34861efff6`](https://github.com/nodejs/node/commit/34861efff6)] - **test**: add test-require-invalid-package (Duy Le) [#9903](https://github.com/nodejs/node/pull/9903) * [[`90a79b3967`](https://github.com/nodejs/node/commit/90a79b3967)] - **test**: refactor test-timers-this (Rich Trott) [#10315](https://github.com/nodejs/node/pull/10315) * [[`5335b0a0d1`](https://github.com/nodejs/node/commit/5335b0a0d1)] - **test**: refactor test-tls-ecdh-disable (Aaron Williams) [#9989](https://github.com/nodejs/node/pull/9989) * [[`0f8a323546`](https://github.com/nodejs/node/commit/0f8a323546)] - **test**: cleanup test-stdout-close-catch.js (Travis Bretton) [#10006](https://github.com/nodejs/node/pull/10006) * [[`fc67a955e2`](https://github.com/nodejs/node/commit/fc67a955e2)] - **test**: use const/let and common.mustCall (Outsider) [#9959](https://github.com/nodejs/node/pull/9959) * [[`2f44d7f367`](https://github.com/nodejs/node/commit/2f44d7f367)] - **test**: refactor test-crypto-random (Rich Trott) [#10232](https://github.com/nodejs/node/pull/10232) * [[`730c3b29e8`](https://github.com/nodejs/node/commit/730c3b29e8)] - **test**: refactor test-fs-fsync (Rob Adelmann) [#10176](https://github.com/nodejs/node/pull/10176) * [[`9c9d422433`](https://github.com/nodejs/node/commit/9c9d422433)] - **test**: refactor test-http-after-connect.js (larissayvette) [#10229](https://github.com/nodejs/node/pull/10229) * [[`827bbe7985`](https://github.com/nodejs/node/commit/827bbe7985)] - **test**: refactor assert.equal, update syntax to ES6 (Prieto, Marcos) * [[`121b68a283`](https://github.com/nodejs/node/commit/121b68a283)] - **test**: refactor http pipelined socket test (Rich Trott) [#10189](https://github.com/nodejs/node/pull/10189) * [[`7ca31e38fb`](https://github.com/nodejs/node/commit/7ca31e38fb)] - **test**: fix alpn tests for openssl1.0.2h (Shigeki Ohtsu) [#6550](https://github.com/nodejs/node/pull/6550) * [[`278d718a93`](https://github.com/nodejs/node/commit/278d718a93)] - **test**: refactor test-handle-wrap-close-abort (Rich Trott) [#10188](https://github.com/nodejs/node/pull/10188) * [[`f12bab65b8`](https://github.com/nodejs/node/commit/f12bab65b8)] - **test**: stream readableListening internal state (Italo A. Casas) [#9864](https://github.com/nodejs/node/pull/9864) * [[`210290dfba`](https://github.com/nodejs/node/commit/210290dfba)] - **test**: check for error on invalid signal (Matt Phillips) [#10026](https://github.com/nodejs/node/pull/10026) * [[`4f5f0e4975`](https://github.com/nodejs/node/commit/4f5f0e4975)] - **test**: refactor test-net-keepalive.js (Kyle Corsi) [#9995](https://github.com/nodejs/node/pull/9995) * [[`cfa2b87b5d`](https://github.com/nodejs/node/commit/cfa2b87b5d)] - **test,lib,benchmark**: match function names (Rich Trott) [#9113](https://github.com/nodejs/node/pull/9113) * [[`a67ada7d32`](https://github.com/nodejs/node/commit/a67ada7d32)] - **tls**: copy the Buffer object before using (Sakthipriyan Vairamani) [#8055](https://github.com/nodejs/node/pull/8055) * [[`e750f142ce`](https://github.com/nodejs/node/commit/e750f142ce)] - **(SEMVER-MINOR)** **tls, crypto**: add ALPN Support (Shigeki Ohtsu) [#2564](https://github.com/nodejs/node/pull/2564) * [[`ef547f3325`](https://github.com/nodejs/node/commit/ef547f3325)] - **(SEMVER-MINOR)** **tls,crypto**: move NPN protcol data to hidden value (Shigeki Ohtsu) [#2564](https://github.com/nodejs/node/pull/2564) * [[`31434a1202`](https://github.com/nodejs/node/commit/31434a1202)] - **tools**: enforce consistent operator linebreak style (Michaël Zasso) [#10178](https://github.com/nodejs/node/pull/10178) * [[`9f13b5f7d5`](https://github.com/nodejs/node/commit/9f13b5f7d5)] - **tools**: forbid template literals in assert.throws (Michaël Zasso) [#10301](https://github.com/nodejs/node/pull/10301) * [[`c801de9814`](https://github.com/nodejs/node/commit/c801de9814)] - **tools**: add ESLint rule for assert.throws arguments (Michaël Zasso) [#10089](https://github.com/nodejs/node/pull/10089) * [[`b5e18f207f`](https://github.com/nodejs/node/commit/b5e18f207f)] - **tools**: add macosx-firwall script to avoid popups (Daniel Bevenius) [#10114](https://github.com/nodejs/node/pull/10114) * [[`30d60cf81c`](https://github.com/nodejs/node/commit/30d60cf81c)] - **(SEMVER-MINOR)** **v8,src**: expose statistics about heap spaces (Ben Ripkens) [#4463](https://github.com/nodejs/node/pull/4463) * [[`9556ef3241`](https://github.com/nodejs/node/commit/9556ef3241)] - **vm**: add error message if we abort (Franziska Hinkelmann) [#8634](https://github.com/nodejs/node/pull/8634) * [[`fa11f4b1fc`](https://github.com/nodejs/node/commit/fa11f4b1fc)] - **win,msi**: add required UIRef for localized strings (Bill Ticehurst) [#8884](https://github.com/nodejs/node/pull/8884) ## 2017-01-31, Version 4.7.3 'Argon' (LTS), @MylesBorins This is a security release of the 'Argon' release line to upgrade OpenSSL to version 1.0.2k Although the OpenSSL team have determined a maximum severity rating of "moderate", the Node.js crypto team (Ben Noordhuis, Shigeki Ohtsu and Fedor Indutny) have determined the impact to Node users is "low". Details on this determination can be found [on the Nodejs.org website](https://nodejs.org/en/blog/vulnerability/openssl-january-2017/). ### Notable Changes * **deps**: upgrade openssl sources to 1.0.2k (Shigeki Ohtsu) [#11021](https://github.com/nodejs/node/pull/11021) ### Commits * [[`8029f64135`](https://github.com/nodejs/node/commit/8029f64135)] - **deps**: update openssl asm and asm_obsolete files (Shigeki Ohtsu) [#11021](https://github.com/nodejs/node/pull/11021) * [[`0081659a41`](https://github.com/nodejs/node/commit/0081659a41)] - **deps**: add -no_rand_screen to openssl s_client (Shigeki Ohtsu) [nodejs/io.js#1836](https://github.com/nodejs/io.js/pull/1836) * [[`e55c3f4e21`](https://github.com/nodejs/node/commit/e55c3f4e21)] - **deps**: fix asm build error of openssl in x86_win32 (Shigeki Ohtsu) [iojs/io.js#1389](https://github.com/iojs/io.js/pull/1389) * [[`24640f9278`](https://github.com/nodejs/node/commit/24640f9278)] - **deps**: fix openssl assembly error on ia32 win32 (Fedor Indutny) [iojs/io.js#1389](https://github.com/iojs/io.js/pull/1389) * [[`6c7bdf58e0`](https://github.com/nodejs/node/commit/6c7bdf58e0)] - **deps**: copy all openssl header files to include dir (Shigeki Ohtsu) [#11021](https://github.com/nodejs/node/pull/11021) * [[`c80844769c`](https://github.com/nodejs/node/commit/c80844769c)] - **deps**: upgrade openssl sources to 1.0.2k (Shigeki Ohtsu) [#11021](https://github.com/nodejs/node/pull/11021) * [[`e3915a415b`](https://github.com/nodejs/node/commit/e3915a415b)] - **openssl**: fix keypress requirement in apps on win32 (Shigeki Ohtsu) [iojs/io.js#1389](https://github.com/iojs/io.js/pull/1389) ## 2017-01-05, Version 4.7.2 'Argon' (LTS), @MylesBorins This is a special release that contains 0 commits. While promoting additional platforms for v4.7.1 after the release, the tarballs on the release server were overwritten and now have different shasums. In order to remove any ambiguity around the release we have opted to do a semver patch release with no changes. ### Notable Changes N/A ### Commits N/A ## 2017-01-03, Version 4.7.1 'Argon' (LTS), @MylesBorins This LTS release comes with 180 commits. This includes 117 which are test related, 34 which are doc related, 15 which are build / tool related, and 1 commit which is an update to dependencies. ### Notable Changes * **build**: shared library support is now working for AIX builds (Stewart Addison) [#9675](https://github.com/nodejs/node/pull/9675) * **repl**: Passing options to the repl will no longer overwrite defaults (cjihrig) [#7826](https://github.com/nodejs/node/pull/7826) * **timers**: Re canceling a cancelled timers will no longer throw (Jeremiah Senkpiel) [#9685](https://github.com/nodejs/node/pull/9685) ### Commits * [[`c5f82b8421`](https://github.com/nodejs/node/commit/c5f82b8421)] - **assert**: fix deepEqual/deepStrictEqual on equivalent typed arrays (Feross Aboukhadijeh) [#8002](https://github.com/nodejs/node/pull/8002) * [[`60883de30f`](https://github.com/nodejs/node/commit/60883de30f)] - **async_wrap**: call destroy() callback in uv_idle_t (Trevor Norris) * [[`28dbc460c6`](https://github.com/nodejs/node/commit/28dbc460c6)] - **async_wrap**: make Initialize a static class member (Trevor Norris) * [[`bb05cd13db`](https://github.com/nodejs/node/commit/bb05cd13db)] - **async_wrap**: mode constructor/destructor to .cc (Trevor Norris) * [[`b1075f6193`](https://github.com/nodejs/node/commit/b1075f6193)] - **benchmark**: split timers benchmark and refactor (Rich Trott) [#9497](https://github.com/nodejs/node/pull/9497) * [[`7b4268b889`](https://github.com/nodejs/node/commit/7b4268b889)] - **benchmark,lib,test,tools**: remove unneeded . escape (Rich Trott) [#9449](https://github.com/nodejs/node/pull/9449) * [[`54f2ce8ea0`](https://github.com/nodejs/node/commit/54f2ce8ea0)] - **build**: prioritise --shared-X-Y over pkg-config (Rod Vagg) [#9368](https://github.com/nodejs/node/pull/9368) * [[`61d377ddcd`](https://github.com/nodejs/node/commit/61d377ddcd)] - **build**: Make configure file parseable on python3 (kalrover) [#9657](https://github.com/nodejs/node/pull/9657) * [[`38e0f95d24`](https://github.com/nodejs/node/commit/38e0f95d24)] - **build**: add MAKEFLAGS="-j1" to node-gyp (Daniel Bevenius) [#9450](https://github.com/nodejs/node/pull/9450) * [[`d1b6407395`](https://github.com/nodejs/node/commit/d1b6407395)] - **build**: make node-gyp output silent (Sakthipriyan Vairamani (thefourtheye)) [#8990](https://github.com/nodejs/node/pull/8990) * [[`ae2eff2997`](https://github.com/nodejs/node/commit/ae2eff2997)] - **build**: start comments at beginning of line (Sakthipriyan Vairamani (thefourtheye)) [#9375](https://github.com/nodejs/node/pull/9375) * [[`6f1f955b33`](https://github.com/nodejs/node/commit/6f1f955b33)] - **build**: default to ppc64 on AIX (Gibson Fahnestock) [#9645](https://github.com/nodejs/node/pull/9645) * [[`f8d4577762`](https://github.com/nodejs/node/commit/f8d4577762)] - **build**: Add option to compile for coverage reports (Wayne Andrews) [#9463](https://github.com/nodejs/node/pull/9463) * [[`f2b00985f0`](https://github.com/nodejs/node/commit/f2b00985f0)] - **build**: add shared library support to AIX build (Stewart Addison) [#9675](https://github.com/nodejs/node/pull/9675) * [[`e2c5f41ddf`](https://github.com/nodejs/node/commit/e2c5f41ddf)] - **crypto**: use SSL_get_servername. (Adam Langley) [#9347](https://github.com/nodejs/node/pull/9347) * [[`724910a991`](https://github.com/nodejs/node/commit/724910a991)] - **debugger**: refactor _debugger.js (Rich Trott) [#9860](https://github.com/nodejs/node/pull/9860) * [[`52f14931a2`](https://github.com/nodejs/node/commit/52f14931a2)] - **deps**: backport GYP fix to fix AIX shared suffix (Stewart Addison) [#9675](https://github.com/nodejs/node/pull/9675) * [[`c77ba8ce14`](https://github.com/nodejs/node/commit/c77ba8ce14)] - **doc**: consistent 'Returns:' (Roman Reiss) [#9554](https://github.com/nodejs/node/pull/9554) * [[`aecb2cac37`](https://github.com/nodejs/node/commit/aecb2cac37)] - **doc**: adding missing - in README (Italo A. Casas) [#10170](https://github.com/nodejs/node/pull/10170) * [[`52c022992e`](https://github.com/nodejs/node/commit/52c022992e)] - **doc**: removing extra space in README (Italo A. Casas) [#10168](https://github.com/nodejs/node/pull/10168) * [[`e8c57bbe77`](https://github.com/nodejs/node/commit/e8c57bbe77)] - **doc**: add people to cc for async_wrap (Anna Henningsen) [#9471](https://github.com/nodejs/node/pull/9471) * [[`b5eae4463c`](https://github.com/nodejs/node/commit/b5eae4463c)] - **doc**: add link to `net.Server` in tls.md (Devon Rifkin) [#10109](https://github.com/nodejs/node/pull/10109) * [[`ad841a29d1`](https://github.com/nodejs/node/commit/ad841a29d1)] - **doc**: clarify fs.createReadStream options (Wes Tyler) [#10078](https://github.com/nodejs/node/pull/10078) * [[`338014ef24`](https://github.com/nodejs/node/commit/338014ef24)] - **doc**: rename writing_tests.md to writing-tests.md (Safia Abdalla) [#9867](https://github.com/nodejs/node/pull/9867) * [[`b06b2343bc`](https://github.com/nodejs/node/commit/b06b2343bc)] - **doc**: it’s -> its in api/child_process.md (Devon Rifkin) [#10090](https://github.com/nodejs/node/pull/10090) * [[`4885573080`](https://github.com/nodejs/node/commit/4885573080)] - **doc**: update Collaborators list in README (Rich Trott) [#9846](https://github.com/nodejs/node/pull/9846) * [[`3105becb2c`](https://github.com/nodejs/node/commit/3105becb2c)] - **doc**: remove minor contradiction in debugger doc (Rich Trott) [#9832](https://github.com/nodejs/node/pull/9832) * [[`a858e98921`](https://github.com/nodejs/node/commit/a858e98921)] - **doc**: clarify introductory module material (Rich Trott) [#9816](https://github.com/nodejs/node/pull/9816) * [[`18c38819fe`](https://github.com/nodejs/node/commit/18c38819fe)] - **doc**: improve description of module `exports` (Sam Roberts) [#9622](https://github.com/nodejs/node/pull/9622) * [[`9e68b8d329`](https://github.com/nodejs/node/commit/9e68b8d329)] - **doc**: fix crypto Verify cut-n-paste from Sign (子丶言) [#9796](https://github.com/nodejs/node/pull/9796) * [[`fd1a48c9c9`](https://github.com/nodejs/node/commit/fd1a48c9c9)] - **doc**: minor fixes event-loop-timers-and-nexttick.md (Dan Koster) [#9126](https://github.com/nodejs/node/pull/9126) * [[`107735a6e1`](https://github.com/nodejs/node/commit/107735a6e1)] - **doc**: changed order of invocations in https.request() example. (atrioom) [#9614](https://github.com/nodejs/node/pull/9614) * [[`eb5972fe9b`](https://github.com/nodejs/node/commit/eb5972fe9b)] - **doc**: fix crypto "decipher.setAAD()" typo (子丶言) [#9782](https://github.com/nodejs/node/pull/9782) * [[`dc4c348ea3`](https://github.com/nodejs/node/commit/dc4c348ea3)] - **doc**: fix typo in assert code example (Vse Mozhet Byt) [#9704](https://github.com/nodejs/node/pull/9704) * [[`16e97ab6c6`](https://github.com/nodejs/node/commit/16e97ab6c6)] - **doc**: fix typo in BUILDING.md (monkick) [#9569](https://github.com/nodejs/node/pull/9569) * [[`4f2e25441e`](https://github.com/nodejs/node/commit/4f2e25441e)] - **doc**: remove backtick escaping for manpage refs (Anna Henningsen) [#9632](https://github.com/nodejs/node/pull/9632) * [[`c0d44dfcc7`](https://github.com/nodejs/node/commit/c0d44dfcc7)] - **doc**: remove invalid padding from privateEncrypt (JungMinu) [#9611](https://github.com/nodejs/node/pull/9611) * [[`0f523583c3`](https://github.com/nodejs/node/commit/0f523583c3)] - **doc**: remove Sam Roberts from release team (Sam Roberts) [#9862](https://github.com/nodejs/node/pull/9862) * [[`4eeac8eb8c`](https://github.com/nodejs/node/commit/4eeac8eb8c)] - **doc**: add guide for maintaining V8 (Ali Ijaz Sheikh) [#9777](https://github.com/nodejs/node/pull/9777) * [[`34405ddb83`](https://github.com/nodejs/node/commit/34405ddb83)] - **doc**: move TSC and CTC meeting minutes out of core repo (James M Snell) [#9503](https://github.com/nodejs/node/pull/9503) * [[`198463a0ff`](https://github.com/nodejs/node/commit/198463a0ff)] - **doc**: fix a typo in the assert.md (Vse Mozhet Byt) [#9598](https://github.com/nodejs/node/pull/9598) * [[`aca0ede0d3`](https://github.com/nodejs/node/commit/aca0ede0d3)] - **doc**: fix typo e.g., => e.g. (Daijiro Yamada) [#9563](https://github.com/nodejs/node/pull/9563) * [[`c7997939f2`](https://github.com/nodejs/node/commit/c7997939f2)] - **doc**: fix typo about cluster doc, (eg. -> e.g.) (YutamaKotaro) [#9568](https://github.com/nodejs/node/pull/9568) * [[`229fa6921f`](https://github.com/nodejs/node/commit/229fa6921f)] - **doc**: fix e.g., to e.g. in doc/http.md (ikasumi_wt) [#9564](https://github.com/nodejs/node/pull/9564) * [[`3ad7430f12`](https://github.com/nodejs/node/commit/3ad7430f12)] - **doc**: fix the index order in pseudocode of modules (kohta ito) [#9562](https://github.com/nodejs/node/pull/9562) * [[`06732babd3`](https://github.com/nodejs/node/commit/06732babd3)] - **doc**: remove Roadmap Working Group (William Kapke) [#9545](https://github.com/nodejs/node/pull/9545) * [[`6775163a94`](https://github.com/nodejs/node/commit/6775163a94)] - **doc**: fix minor style issue in code examples (Daniel Bevenius) [#9482](https://github.com/nodejs/node/pull/9482) * [[`aa25c74fe6`](https://github.com/nodejs/node/commit/aa25c74fe6)] - **doc**: grammar and structure revisions of wg doc (Ryan Lewis) [#9495](https://github.com/nodejs/node/pull/9495) * [[`1e06ed7e9d`](https://github.com/nodejs/node/commit/1e06ed7e9d)] - **doc**: clarify the exit code part of writing_tests (Jeremiah Senkpiel) [#9502](https://github.com/nodejs/node/pull/9502) * [[`3f39a39657`](https://github.com/nodejs/node/commit/3f39a39657)] - **doc**: Fix inaccuracy in https.request docs (Andreas Lind) [#9453](https://github.com/nodejs/node/pull/9453) * [[`8380154e22`](https://github.com/nodejs/node/commit/8380154e22)] - **doc**: add npm link to README (Oscar Morrison) [#7894](https://github.com/nodejs/node/pull/7894) * [[`65e134ff12`](https://github.com/nodejs/node/commit/65e134ff12)] - **meta**: whitelist dotfiles in .gitignore (Claudio Rodriguez) [#8016](https://github.com/nodejs/node/pull/8016) * [[`698bf2e829`](https://github.com/nodejs/node/commit/698bf2e829)] - **repl**: don't override all internal repl defaults (cjihrig) [#7826](https://github.com/nodejs/node/pull/7826) * [[`3d45b35f73`](https://github.com/nodejs/node/commit/3d45b35f73)] - **repl**: refactor lib/repl.js (Rich Trott) [#9374](https://github.com/nodejs/node/pull/9374) * [[`f5b952b221`](https://github.com/nodejs/node/commit/f5b952b221)] - **test**: refactor and fix test-dns (Michaël Zasso) [#9811](https://github.com/nodejs/node/pull/9811) * [[`8b733dca05`](https://github.com/nodejs/node/commit/8b733dca05)] - **test**: refactor test-crypto-binary-default (Michaël Zasso) [#9810](https://github.com/nodejs/node/pull/9810) * [[`45af7857d7`](https://github.com/nodejs/node/commit/45af7857d7)] - **test**: refactor and fix test-crypto (Michaël Zasso) [#9807](https://github.com/nodejs/node/pull/9807) * [[`e0c8aafad8`](https://github.com/nodejs/node/commit/e0c8aafad8)] - **test**: fix test-buffer-slow (Michaël Zasso) [#9809](https://github.com/nodejs/node/pull/9809) * [[`e72dfce2c8`](https://github.com/nodejs/node/commit/e72dfce2c8)] - **test**: added validation regex argument to test (Avery, Frank) [#9918](https://github.com/nodejs/node/pull/9918) * [[`a779e7ffec`](https://github.com/nodejs/node/commit/a779e7ffec)] - **test**: clean up repl-reset-event file (Kailean Courtney) [#9931](https://github.com/nodejs/node/pull/9931) * [[`4022579b6e`](https://github.com/nodejs/node/commit/4022579b6e)] - **test**: improve domain-top-level-error-handler-throw (CodeVana) [#9950](https://github.com/nodejs/node/pull/9950) * [[`d3edaa3dc3`](https://github.com/nodejs/node/commit/d3edaa3dc3)] - **test**: replace var with const in test-require-dot (Amar Zavery) [#9916](https://github.com/nodejs/node/pull/9916) * [[`8694811ef0`](https://github.com/nodejs/node/commit/8694811ef0)] - **test**: refactor test-net-pingpong (Michaël Zasso) [#9812](https://github.com/nodejs/node/pull/9812) * [[`e849dd0ff3`](https://github.com/nodejs/node/commit/e849dd0ff3)] - **test**: Use strictEqual in test-tls-writewrap-leak (Aaron Petcoff) [#9666](https://github.com/nodejs/node/pull/9666) * [[`0662429268`](https://github.com/nodejs/node/commit/0662429268)] - **test**: fix test-tls-connect-address-family (mkamakura) [#9573](https://github.com/nodejs/node/pull/9573) * [[`420e7f17d9`](https://github.com/nodejs/node/commit/420e7f17d9)] - **test**: fix test-http-status-reason-invalid-chars (Yosuke Saito) [#9572](https://github.com/nodejs/node/pull/9572) * [[`13cace140f`](https://github.com/nodejs/node/commit/13cace140f)] - **test**: fix helper-debugger-repl.js (Rich Trott) [#9486](https://github.com/nodejs/node/pull/9486) * [[`aebbc965f9`](https://github.com/nodejs/node/commit/aebbc965f9)] - **test**: refactor large event emitter tests (cjihrig) [#6446](https://github.com/nodejs/node/pull/6446) * [[`b5012f3de2`](https://github.com/nodejs/node/commit/b5012f3de2)] - **test**: add expectWarning to common (Michaël Zasso) [#8662](https://github.com/nodejs/node/pull/8662) * [[`b98813d97c`](https://github.com/nodejs/node/commit/b98813d97c)] - **test**: refactor test-fs-non-number-arguments-throw (Michaël Zasso) [#9844](https://github.com/nodejs/node/pull/9844) * [[`80a752708a`](https://github.com/nodejs/node/commit/80a752708a)] - **test**: refactor test-dgram-exclusive-implicit-bind (Cesar Hernandez) [#10066](https://github.com/nodejs/node/pull/10066) * [[`9b974b4d54`](https://github.com/nodejs/node/commit/9b974b4d54)] - **test**: use `assert.strictEqual` (anoff) [#9975](https://github.com/nodejs/node/pull/9975) * [[`bc125bd729`](https://github.com/nodejs/node/commit/bc125bd729)] - **test**: change assert.equal to assert.strictEqual (Aileen) [#9946](https://github.com/nodejs/node/pull/9946) * [[`5049a10278`](https://github.com/nodejs/node/commit/5049a10278)] - **test**: changed assert.equal to assert.strictEqual (vazina robertson) [#10015](https://github.com/nodejs/node/pull/10015) * [[`b5c60edeed`](https://github.com/nodejs/node/commit/b5c60edeed)] - **test**: renamed assert.Equal to assert.strictEqual (Jared Young) * [[`f44e828a36`](https://github.com/nodejs/node/commit/f44e828a36)] - **test**: improves test-tls-client-verify (Paul Graham) [#10051](https://github.com/nodejs/node/pull/10051) * [[`a1e3967f69`](https://github.com/nodejs/node/commit/a1e3967f69)] - **test**: refactor test-https-agent-session-reuse (Diego Paez) [#10105](https://github.com/nodejs/node/pull/10105) * [[`9e46af6412`](https://github.com/nodejs/node/commit/9e46af6412)] - **test**: refactor test-beforeexit-event (Rob Adelmann) [#10121](https://github.com/nodejs/node/pull/10121) * [[`adcd6ea66f`](https://github.com/nodejs/node/commit/adcd6ea66f)] - **test**: refactor test-domain-from-timer (Daniel Sims) [#9889](https://github.com/nodejs/node/pull/9889) * [[`1377ea87eb`](https://github.com/nodejs/node/commit/1377ea87eb)] - **test**: refactor test-domain-exit-dispose-again (Ethan Arrowood) [#10003](https://github.com/nodejs/node/pull/10003) * [[`8a9af6843d`](https://github.com/nodejs/node/commit/8a9af6843d)] - **test**: use const and strictEqual in test-os-homedir-no-envvar (CodeVana) [#9899](https://github.com/nodejs/node/pull/9899) * [[`ee038c0e71`](https://github.com/nodejs/node/commit/ee038c0e71)] - **test**: refactor test-dgram-bind-default-address (Michael-Bryant Choa) [#9947](https://github.com/nodejs/node/pull/9947) * [[`a090899e93`](https://github.com/nodejs/node/commit/a090899e93)] - **test**: assert.throws() should include a RegExp (Chris Bystrek) [#9976](https://github.com/nodejs/node/pull/997://github.com/nodejs/node/pull/9976) * [[`542b40f410`](https://github.com/nodejs/node/commit/542b40f410)] - **test**: refactor test-event-emitter-method-names (Rodrigo Palma) [#10027](https://github.com/nodejs/node/pull/10027) * [[`a2023a9d97`](https://github.com/nodejs/node/commit/a2023a9d97)] - **test**: refactor tls-ticket-cluster (Yojan Shrestha) [#10023](https://github.com/nodejs/node/pull/10023) * [[`a64f40680f`](https://github.com/nodejs/node/commit/a64f40680f)] - **test**: refactor test-domain-exit-dispose (Chris Henney) [#9938](https://github.com/nodejs/node/pull/9938) * [[`a896d4ed36`](https://github.com/nodejs/node/commit/a896d4ed36)] - **test**: refactor test-stdin-from-file.js (amrios) [#10012](https://github.com/nodejs/node/pull/10012) * [[`ce14c1e51f`](https://github.com/nodejs/node/commit/ce14c1e51f)] - **test**: refactor test-require-extensions-main (Daryl Thayil) [#9912](https://github.com/nodejs/node/pull/9912) * [[`b9c45026f7`](https://github.com/nodejs/node/commit/b9c45026f7)] - **test**: clean up tls junk test (Danny Guo) [#9940](https://github.com/nodejs/node/pull/9940) * [[`e3712334a3`](https://github.com/nodejs/node/commit/e3712334a3)] - **test**: update test-stdout-to-file (scalkpdev) [#9939](https://github.com/nodejs/node/pull/9939) * [[`63f571e69c`](https://github.com/nodejs/node/commit/63f571e69c)] - **test**: changed assert.Equal to asset.strictEqual (Paul Chin) [#9973](https://github.com/nodejs/node/pull/9973) * [[`c3a3480606`](https://github.com/nodejs/node/commit/c3a3480606)] - **test**: refactor test-domain-multi (Wes Tyler) [#9963](https://github.com/nodejs/node/pull/9963) * [[`ad27555ff8`](https://github.com/nodejs/node/commit/ad27555ff8)] - **test**: use assert.strictEqual in test-cli-eval (Nigel Kibodeaux) [#9919](https://github.com/nodejs/node/pull/9919) * [[`cffd51e815`](https://github.com/nodejs/node/commit/cffd51e815)] - **test**: refactor test-tls-connect-simple (Russell Sherman) [#9934](https://github.com/nodejs/node/pull/9934) * [[`1424c25f3e`](https://github.com/nodejs/node/commit/1424c25f3e)] - **test**: refactor test-signal-unregister (mark hughes) [#9920](https://github.com/nodejs/node/pull/9920) * [[`920737180f`](https://github.com/nodejs/node/commit/920737180f)] - **test**: refactor test-require-resolve (blugavere) [#10120](https://github.com/nodejs/node/pull/10120) * [[`71ab88cc80`](https://github.com/nodejs/node/commit/71ab88cc80)] - **test**: refactor test-fs-read-stream-resume (Matt Webb) [#9927](https://github.com/nodejs/node/pull/9927) * [[`6a485da87c`](https://github.com/nodejs/node/commit/6a485da87c)] - **test**: replace equal with strictEqual (Tracy Hinds) [#10011](https://github.com/nodejs/node/pull/10011) * [[`b5d87569e1`](https://github.com/nodejs/node/commit/b5d87569e1)] - **test**: use strictEqual instead of equal (Uttam Pawar) [#9921](https://github.com/nodejs/node/pull/9921) * [[`c94c2fde8a`](https://github.com/nodejs/node/commit/c94c2fde8a)] - **test**: using const and strictEqual (Fabrice Tatieze) [#9926](https://github.com/nodejs/node/pull/9926) * [[`16164b5b44`](https://github.com/nodejs/node/commit/16164b5b44)] - **test**: test-file-write-stream3.js refactor (Richard Karmazin) [#10035](https://github.com/nodejs/node/pull/10035) * [[`7391983729`](https://github.com/nodejs/node/commit/7391983729)] - **test**: implemented es6 conventions (Erez Weiss) [#9669](https://github.com/nodejs/node/pull/9669) * [[`50ce3f91d7`](https://github.com/nodejs/node/commit/50ce3f91d7)] - **test**: update assert.equal() to assert.strictEqual() (Peter Diaz) [#10024](https://github.com/nodejs/node/pull/10024) * [[`3f9d75c481`](https://github.com/nodejs/node/commit/3f9d75c481)] - **test**: use const or let and assert.strictEqual (Christopher Rokita) [#10001](https://github.com/nodejs/node/pull/10001) * [[`98afba5676`](https://github.com/nodejs/node/commit/98afba5676)] - **test**: use strictEqual() domain-http (cdnadmin) [#9996](https://github.com/nodejs/node/pull/9996) * [[`07680b65fe`](https://github.com/nodejs/node/commit/07680b65fe)] - **test**: refactor test-cluster-worker-events (fmizzell) [#9994](https://github.com/nodejs/node/pull/9994) * [[`a3db54416f`](https://github.com/nodejs/node/commit/a3db54416f)] - **test**: update repl tests (makenova) [#9991](https://github.com/nodejs/node/pull/9991) * [[`db3cdd2449`](https://github.com/nodejs/node/commit/db3cdd2449)] - **test**: adding strictEqual to test-buffer-indexof.js (Eric Gonzalez) [#9955](https://github.com/nodejs/node/pull/9955) * [[`f670b05603`](https://github.com/nodejs/node/commit/f670b05603)] - **test**: strictEqual in test-beforeexit-event.js (CodeTheInternet) [#10004](https://github.com/nodejs/node/pull/10004) * [[`70b4d7d3a2`](https://github.com/nodejs/node/commit/70b4d7d3a2)] - **test**: refactor test-child-process-double-pipe (Dan Villa) [#9930](https://github.com/nodejs/node/pull/9930) * [[`1e53cf4764`](https://github.com/nodejs/node/commit/1e53cf4764)] - **test**: updated test-stream-pipe-unpipe-stream (Raja Panidepu) [#10100](https://github.com/nodejs/node/pull/10100) * [[`57d48ac3f4`](https://github.com/nodejs/node/commit/57d48ac3f4)] - **test**: refactor test-crypto-ecb (michael6) [#10029](https://github.com/nodejs/node/pull/10029) * [[`89feb8dc4d`](https://github.com/nodejs/node/commit/89feb8dc4d)] - **test**: refactor test-require-exceptions (Oscar Martinez) [#9882](https://github.com/nodejs/node/pull/9882) * [[`59f259c487`](https://github.com/nodejs/node/commit/59f259c487)] - **test**: refactor test-crypto-certificate (Josh Mays) [#9911](https://github.com/nodejs/node/pull/9911) * [[`815715d850`](https://github.com/nodejs/node/commit/815715d850)] - **test**: refactor test-domain (Johnny Reading) [#9890](https://github.com/nodejs/node/pull/9890) * [[`08cc269338`](https://github.com/nodejs/node/commit/08cc269338)] - **test**: refactor test-cli-syntax (Exlipse7) [#10057](https://github.com/nodejs/node/pull/10057) * [[`91d27ce4db`](https://github.com/nodejs/node/commit/91d27ce4db)] - **test**: refactor test-child-process-constructor (k3kathy) [#10060](https://github.com/nodejs/node/pull/10060) * [[`ae9e2a21c1`](https://github.com/nodejs/node/commit/ae9e2a21c1)] - **test**: var to const, assert.equal to assert.strictEqual in net (Sean Villars) [#9907](https://github.com/nodejs/node/pull/9907) * [[`30c9474286`](https://github.com/nodejs/node/commit/30c9474286)] - **test**: changed vars to const in test-net-better-error-messages-listen-path.js (anoff) [#9905](https://github.com/nodejs/node/pull/9905) * [[`bcbf50d9ba`](https://github.com/nodejs/node/commit/bcbf50d9ba)] - **test**: refactor test-http-dns-error (Outsider) [#10062](https://github.com/nodejs/node/pull/10062) * [[`00f08640ce`](https://github.com/nodejs/node/commit/00f08640ce)] - **test**: assert.equal -> assert.strictEqual (davidmarkclements) [#10065](https://github.com/nodejs/node/pull/10065) * [[`d9cca393e9`](https://github.com/nodejs/node/commit/d9cca393e9)] - **test**: assert.equal -> assert.strictEqual (davidmarkclements) [#10067](https://github.com/nodejs/node/pull/10067) * [[`6c64f6c445`](https://github.com/nodejs/node/commit/6c64f6c445)] - **test**: improve test for crypto padding (Julian Duque) [#9906](https://github.com/nodejs/node/pull/9906) * [[`37d734ae36`](https://github.com/nodejs/node/commit/37d734ae36)] - **test**: polish test-net-better-error-messages-listen (Hitesh Kanwathirtha) [#10087](https://github.com/nodejs/node/pull/10087) * [[`f126b44a3a`](https://github.com/nodejs/node/commit/f126b44a3a)] - **test**: change var to const in test-tls-key-mismatch.js (bjdelro) [#9897](https://github.com/nodejs/node/pull/9897) * [[`7538dd5c93`](https://github.com/nodejs/node/commit/7538dd5c93)] - **test**: use strictEqual in cwd-enoent (JDHarmon) [#10077](https://github.com/nodejs/node/pull/10077) * [[`39816a43af`](https://github.com/nodejs/node/commit/39816a43af)] - **test**: refactor test-fs-read-stream-inherit.js (Jonathan Darling) [#9894](https://github.com/nodejs/node/pull/9894) * [[`7615a0f2cd`](https://github.com/nodejs/node/commit/7615a0f2cd)] - **test**: refactor test-child-process-stdio-inherit (Wes Tyler) [#9893](https://github.com/nodejs/node/pull/9893) * [[`2a9ab8ea2a`](https://github.com/nodejs/node/commit/2a9ab8ea2a)] - **test**: change var to const for require and strict equality checks (Harish Tejwani) [#9892](https://github.com/nodejs/node/pull/9892) * [[`5cd7e7aaf1`](https://github.com/nodejs/node/commit/5cd7e7aaf1)] - **test**: Update to const and use regex for assertions (Daniel Flores) [#9891](https://github.com/nodejs/node/pull/9891) * [[`1a73cc5357`](https://github.com/nodejs/node/commit/1a73cc5357)] - **test**: swap var->const/let and equal->strictEqual (Peter Masucci) [#9888](https://github.com/nodejs/node/pull/9888) * [[`552169e950`](https://github.com/nodejs/node/commit/552169e950)] - **test**: replace equal with strictEqual in crypto (Julian Duque) [#9886](https://github.com/nodejs/node/pull/9886) * [[`49900e78b0`](https://github.com/nodejs/node/commit/49900e78b0)] - **test**: replace equal with strictEqual (Julian Duque) [#9879](https://github.com/nodejs/node/pull/9879) * [[`998db3a003`](https://github.com/nodejs/node/commit/998db3a003)] - **test**: refactor test-tls-timeout-server-2 (Devon Rifkin) [#9876](https://github.com/nodejs/node/pull/9876) * [[`aaab51047f`](https://github.com/nodejs/node/commit/aaab51047f)] - **test**: Changed assert.equal to assert.strictEqual (Daniel Pittman) [#9902](https://github.com/nodejs/node/pull/9902) * [[`a4488c3cbd`](https://github.com/nodejs/node/commit/a4488c3cbd)] - **test**: refactor test-vm-syntax-error-stderr.js (Jay Brownlee) [#9900](https://github.com/nodejs/node/pull/9900) * [[`cff80a5c0e`](https://github.com/nodejs/node/commit/cff80a5c0e)] - **test**: refactor test-tls-destroy-whilst-write (Chris Bystrek) [#10064](https://github.com/nodejs/node/pull/10064) * [[`8257671bdc`](https://github.com/nodejs/node/commit/8257671bdc)] - **test**: refactor test-https-truncate (davidmarkclements) [#10074](https://github.com/nodejs/node/pull/10074) * [[`457af874b5`](https://github.com/nodejs/node/commit/457af874b5)] - **test**: use strictEqual in test-cli-eval-event.js (Richard Karmazin) [#9964](https://github.com/nodejs/node/pull/9964) * [[`2890f0d904`](https://github.com/nodejs/node/commit/2890f0d904)] - **test**: refactor test-tls-friendly-error-message.js (Adrian Estrada) [#9967](https://github.com/nodejs/node/pull/9967) * [[`c37ae4a1b6`](https://github.com/nodejs/node/commit/c37ae4a1b6)] - **test**: refactor test-vm-static-this.js (David Bradford) [#9887](https://github.com/nodejs/node/pull/9887) * [[`9473fc6c2f`](https://github.com/nodejs/node/commit/9473fc6c2f)] - **test**: refactor test-crypto-cipheriv-decipheriv (Aileen) [#10018](https://github.com/nodejs/node/pull/10018) * [[`6ecc4ffb1c`](https://github.com/nodejs/node/commit/6ecc4ffb1c)] - **test**: refactor test for crypto cipher/decipher iv (Julian Duque) [#9943](https://github.com/nodejs/node/pull/9943) * [[`a486f6bad4`](https://github.com/nodejs/node/commit/a486f6bad4)] - **test**: refactor test-cluster-setup-master-argv (Oscar Martinez) [#9960](https://github.com/nodejs/node/pull/9960) * [[`384c954698`](https://github.com/nodejs/node/commit/384c954698)] - **test**: refactor test-cluster-setup-master-argv (Christine Hong) [#9993](https://github.com/nodejs/node/pull/9993) * [[`76645e8781`](https://github.com/nodejs/node/commit/76645e8781)] - **test**: use assert.strictEqual in test-crypto-ecb (Daniel Pittman) [#9980](https://github.com/nodejs/node/pull/9980) * [[`9103c3d3fe`](https://github.com/nodejs/node/commit/9103c3d3fe)] - **test**: update to const iin cluster test (Greg Valdez) [#10007](https://github.com/nodejs/node/pull/10007) * [[`27c9171586`](https://github.com/nodejs/node/commit/27c9171586)] - **test**: use assert.strictEqual() cluster test (Bidur Adhikari) [#10042](https://github.com/nodejs/node/pull/10042) * [[`2453d64aa7`](https://github.com/nodejs/node/commit/2453d64aa7)] - **test**: var -> let/const, .equal -> .strictEqual (shiya) [#9913](https://github.com/nodejs/node/pull/9913) * [[`1467c964a4`](https://github.com/nodejs/node/commit/1467c964a4)] - **test**: increase coverage for timers (lrlna) [#10068](https://github.com/nodejs/node/pull/10068) * [[`e47195cf78`](https://github.com/nodejs/node/commit/e47195cf78)] - **test**: change equal to strictEqual (Kevin Zurawel) [#9872](https://github.com/nodejs/node/pull/9872) * [[`33da22aba1`](https://github.com/nodejs/node/commit/33da22aba1)] - **test**: add toASCII and toUnicode punycode tests (Claudio Rodriguez) [#9741](https://github.com/nodejs/node/pull/9741) * [[`4c5d24b632`](https://github.com/nodejs/node/commit/4c5d24b632)] - **test**: refine test-http-status-reason-invalid-chars (Rich Trott) [#9802](https://github.com/nodejs/node/pull/9802) * [[`81d49aaeb2`](https://github.com/nodejs/node/commit/81d49aaeb2)] - **test**: exclude no_interleaved_stdio test for AIX (Michael Dawson) [#9772](https://github.com/nodejs/node/pull/9772) * [[`b59cf582e4`](https://github.com/nodejs/node/commit/b59cf582e4)] - **test**: refactor test-async-wrap-* (Rich Trott) [#9663](https://github.com/nodejs/node/pull/9663) * [[`57cc5cb277`](https://github.com/nodejs/node/commit/57cc5cb277)] - **test**: use setImmediate() in test of stream2 (masashi.g) [#9583](https://github.com/nodejs/node/pull/9583) * [[`8345ffb0a0`](https://github.com/nodejs/node/commit/8345ffb0a0)] - **test**: add test case of PassThrough (Yoshiya Hinosawa) [#9581](https://github.com/nodejs/node/pull/9581) * [[`beb147a08b`](https://github.com/nodejs/node/commit/beb147a08b)] - **test**: check that `process.execPath` is a realpath (Anna Henningsen) [#9229](https://github.com/nodejs/node/pull/9229) * [[`cef5b1fa14`](https://github.com/nodejs/node/commit/cef5b1fa14)] - **test**: add test for broken child process stdio (cjihrig) [#9528](https://github.com/nodejs/node/pull/9528) * [[`29ab76b791`](https://github.com/nodejs/node/commit/29ab76b791)] - **test**: ensure nextTick is not scheduled in exit (Jeremiah Senkpiel) [#9555](https://github.com/nodejs/node/pull/9555) * [[`b87fe250d2`](https://github.com/nodejs/node/commit/b87fe250d2)] - **test**: change from setTimeout to setImmediate (MURAKAMI Masahiko) [#9578](https://github.com/nodejs/node/pull/9578) * [[`eca12d4316`](https://github.com/nodejs/node/commit/eca12d4316)] - **test**: improve test-stream2-objects.js (Yoshiya Hinosawa) [#9565](https://github.com/nodejs/node/pull/9565) * [[`4e36a14c15`](https://github.com/nodejs/node/commit/4e36a14c15)] - **test**: refactor test-next-tick-error-spin (Rich Trott) [#9537](https://github.com/nodejs/node/pull/9537) * [[`b2b2bc2293`](https://github.com/nodejs/node/commit/b2b2bc2293)] - **test**: move timer-dependent test to sequential (Rich Trott) [#9487](https://github.com/nodejs/node/pull/9487) * [[`1436fd70f5`](https://github.com/nodejs/node/commit/1436fd70f5)] - **test**: convert assert.equal to assert.strictEqual (Jonathan Darling) [#9925](https://github.com/nodejs/node/pull/9925) * [[`c9ed49da6e`](https://github.com/nodejs/node/commit/c9ed49da6e)] - **test**: run cpplint on files in test/cctest (Ben Noordhuis) [#9787](https://github.com/nodejs/node/pull/9787) * [[`10d4f470f8`](https://github.com/nodejs/node/commit/10d4f470f8)] - **test**: enable addons test to pass with debug build (Daniel Bevenius) [#8836](https://github.com/nodejs/node/pull/8836) * [[`550393dc78`](https://github.com/nodejs/node/commit/550393dc78)] - **test**: add new.target add-on regression test (Ben Noordhuis) [#9689](https://github.com/nodejs/node/pull/9689) * [[`76245b2156`](https://github.com/nodejs/node/commit/76245b2156)] - **test**: refactor large event emitter tests (cjihrig) [#6446](https://github.com/nodejs/node/pull/6446) * [[`02e8187751`](https://github.com/nodejs/node/commit/02e8187751)] - **test**: allow globals to be whitelisted (cjihrig) [#7826](https://github.com/nodejs/node/pull/7826) * [[`c0c5608bfc`](https://github.com/nodejs/node/commit/c0c5608bfc)] - **test,assert**: add deepEqual/deepStrictEqual tests for typed arrays (Feross Aboukhadijeh) [#8002](https://github.com/nodejs/node/pull/8002) * [[`759e8fdd18`](https://github.com/nodejs/node/commit/759e8fdd18)] - **timers**: bail from intervals if _repeat is bad (Jeremiah Senkpiel) [#10365](https://github.com/nodejs/node/pull/10365) * [[`553d95da15`](https://github.com/nodejs/node/commit/553d95da15)] - **timers**: use consistent checks for canceled timers (Jeremiah Senkpiel) [#9685](https://github.com/nodejs/node/pull/9685) * [[`5c6d908dd7`](https://github.com/nodejs/node/commit/5c6d908dd7)] - **tools**: enable final newline in .editorconfig (Roman Reiss) [#9410](https://github.com/nodejs/node/pull/9410) * [[`06e8120928`](https://github.com/nodejs/node/commit/06e8120928)] - **tools**: remove unneeded escaping in generate.js (Rich Trott) [#9781](https://github.com/nodejs/node/pull/9781) * [[`fd6b305421`](https://github.com/nodejs/node/commit/fd6b305421)] - **tools**: use better regexp for manpage references (Anna Henningsen) [#9632](https://github.com/nodejs/node/pull/9632) * [[`9b36469a3c`](https://github.com/nodejs/node/commit/9b36469a3c)] - **tools**: improve docopen target in Makefile (Sakthipriyan Vairamani (thefourtheye)) [#9436](https://github.com/nodejs/node/pull/9436) * [[`e3dc05d01b`](https://github.com/nodejs/node/commit/e3dc05d01b)] - **tools**: make run-valgrind.py useful (Ben Noordhuis) [#9520](https://github.com/nodejs/node/pull/9520) * [[`7b1b11a11c`](https://github.com/nodejs/node/commit/7b1b11a11c)] - **tools**: fix run-valgrind.py script (Ben Noordhuis) [#9520](https://github.com/nodejs/node/pull/9520) * [[`011ee0ba8b`](https://github.com/nodejs/node/commit/011ee0ba8b)] - **tools**: copy run-valgrind.py to tools/ (Ben Noordhuis) [#9520](https://github.com/nodejs/node/pull/9520) ## 2016-12-06, Version 4.7.0 'Argon' (LTS), @thealphanerd This LTS release comes with 108 commits. This includes 30 which are doc related, 28 which are test related, 16 which are build / tool related, and 4 commits which are updates to dependencies. ### Notable Changes The SEMVER-MINOR changes include: * **build**: export openssl symbols on Windows making it possible to build addons linking against the bundled version of openssl (Alex Hultman) [#7576](https://github.com/nodejs/node/pull/7576) * **debugger**: make listen address configurable in the debugger server (Ben Noordhuis) [#3316](https://github.com/nodejs/node/pull/3316) * **dgram**: generalized send queue to handle close fixing a potential throw when dgram socket is closed in the listening event handler. (Matteo Collina) [#7066](https://github.com/nodejs/node/pull/7066) * **http**: Introduce the 451 status code "Unavailable For Legal Reasons" (Max Barinov) [#4377](https://github.com/nodejs/node/pull/4377) * **tls**: introduce `secureContext` for `tls.connect` which is useful for caching client certificates, key, and CA certificates. (Fedor Indutny) [#4246](https://github.com/nodejs/node/pull/4246) Notable SEMVER-PATCH changes include: * **build**: - introduce the configure --shared option for embedders (sxa555) [#6994](https://github.com/nodejs/node/pull/6994) * **gtest**: the test reporter now outputs tap comments as yamlish (Johan Bergström) [#9262](https://github.com/nodejs/node/pull/9262) * **src**: node no longer aborts when c-ares initialization fails (Ben Noordhuis) [#8710](https://github.com/nodejs/node/pull/8710) * **tls**: fix memory leak when writing data to TLSWrap instance during handshake (Fedor Indutny) [#9586](https://github.com/nodejs/node/pull/9586) ### Commits * [[`ed31f9cc30`](https://github.com/nodejs/node/commit/ed31f9cc30)] - **benchmark**: add microbenchmarks for ES Map (Rod Vagg) [#7581](https://github.com/nodejs/node/pull/7581) * [[`c5181eda4b`](https://github.com/nodejs/node/commit/c5181eda4b)] - **build**: reduce noise from doc target (Daniel Bevenius) [#9457](https://github.com/nodejs/node/pull/9457) * [[`59d821debe`](https://github.com/nodejs/node/commit/59d821debe)] - **build**: use wxneeded on openbsd (Aaron Bieber) [#9232](https://github.com/nodejs/node/pull/9232) * [[`7c73105606`](https://github.com/nodejs/node/commit/7c73105606)] - **build**: run cctests as part of test-ci target (Ben Noordhuis) [#8034](https://github.com/nodejs/node/pull/8034) * [[`3919edb47e`](https://github.com/nodejs/node/commit/3919edb47e)] - **build**: don't build icu with -fno-rtti (Ben Noordhuis) [#8886](https://github.com/nodejs/node/pull/8886) * [[`e97723b18c`](https://github.com/nodejs/node/commit/e97723b18c)] - **build**: abstract out shared library suffix (Stewart Addison) [#9385](https://github.com/nodejs/node/pull/9385) * [[`0138b4db7c`](https://github.com/nodejs/node/commit/0138b4db7c)] - **build**: windows sharedlib support (Stewart Addison) [#9385](https://github.com/nodejs/node/pull/9385) * [[`f21c2b9d3b`](https://github.com/nodejs/node/commit/f21c2b9d3b)] - **build**: configure --shared (sxa555) [#6994](https://github.com/nodejs/node/pull/6994) * [[`bb2fdf58f7`](https://github.com/nodejs/node/commit/bb2fdf58f7)] - **build**: cherry pick V8 change for windows DLL support (Stefan Budeanu) [#8084](https://github.com/nodejs/node/pull/8084) * [[`84849f186f`](https://github.com/nodejs/node/commit/84849f186f)] - **(SEMVER-MINOR)** **build**: export more openssl symbols on Windows (Alex Hultman) [#7576](https://github.com/nodejs/node/pull/7576) * [[`3cefd65e90`](https://github.com/nodejs/node/commit/3cefd65e90)] - **build**: export openssl symbols on windows (Ben Noordhuis) [#6274](https://github.com/nodejs/node/pull/6274) * [[`4de7a6e291`](https://github.com/nodejs/node/commit/4de7a6e291)] - **build**: fix config.gypi target (Daniel Bevenius) [#9053](https://github.com/nodejs/node/pull/9053) * [[`9389572cbc`](https://github.com/nodejs/node/commit/9389572cbc)] - **crypto**: fix faulty logic in iv size check (Ben Noordhuis) [#9032](https://github.com/nodejs/node/pull/9032) * [[`748e424163`](https://github.com/nodejs/node/commit/748e424163)] - **(SEMVER-MINOR)** **debugger**: make listen address configurable (Ben Noordhuis) [#3316](https://github.com/nodejs/node/pull/3316) * [[`c1effb1255`](https://github.com/nodejs/node/commit/c1effb1255)] - **deps**: fix build with libc++ 3.8.0 (Johan Bergström) [#9763](https://github.com/nodejs/node/pull/9763) * [[`eb34f687d5`](https://github.com/nodejs/node/commit/eb34f687d5)] - **deps**: revert default gtest reporter change (Brian White) [#8948](https://github.com/nodejs/node/pull/8948) * [[`4c47446133`](https://github.com/nodejs/node/commit/4c47446133)] - **deps**: make gtest output tap (Ben Noordhuis) [#8034](https://github.com/nodejs/node/pull/8034) * [[`91fce10aee`](https://github.com/nodejs/node/commit/91fce10aee)] - **deps**: back port OpenBSD fix in c-ares/c-ares (Aaron Bieber) [#9232](https://github.com/nodejs/node/pull/9232) * [[`4571c84c67`](https://github.com/nodejs/node/commit/4571c84c67)] - **(SEMVER-MINOR)** **dgram**: generalized send queue to handle close (Matteo Collina) [#7066](https://github.com/nodejs/node/pull/7066) * [[`d3c25c19ef`](https://github.com/nodejs/node/commit/d3c25c19ef)] - **doc**: update minute-taking procedure for CTC (Rich Trott) [#9425](https://github.com/nodejs/node/pull/9425) * [[`861b689c01`](https://github.com/nodejs/node/commit/861b689c01)] - **doc**: update GOVERNANCE.md to use "meeting chair" (Rich Trott) [#9432](https://github.com/nodejs/node/pull/9432) * [[`5e820ae746`](https://github.com/nodejs/node/commit/5e820ae746)] - **doc**: update Diagnostics WG info (Josh Gavant) [#9329](https://github.com/nodejs/node/pull/9329) * [[`e08173a2f1`](https://github.com/nodejs/node/commit/e08173a2f1)] - **doc**: fix outdate ninja link (Yangyang Liu) [#9278](https://github.com/nodejs/node/pull/9278) * [[`462c640a51`](https://github.com/nodejs/node/commit/462c640a51)] - **doc**: fix typo in email address in README (Rich Trott) [#8941](https://github.com/nodejs/node/pull/8941) * [[`fc77cbb5b1`](https://github.com/nodejs/node/commit/fc77cbb5b1)] - **doc**: make node(1) more consistent with tradition (Alex Jordan) [#8902](https://github.com/nodejs/node/pull/8902) * [[`66e26cd253`](https://github.com/nodejs/node/commit/66e26cd253)] - **doc**: child_process.execSync .stdio default is pipe (Kenneth Skovhus) [#9701](https://github.com/nodejs/node/pull/9701) * [[`524ebfb5dd`](https://github.com/nodejs/node/commit/524ebfb5dd)] - **doc**: child_process .stdio accepts a String type (Kenneth Skovhus) [#9701](https://github.com/nodejs/node/pull/9701) * [[`475fe96852`](https://github.com/nodejs/node/commit/475fe96852)] - **doc**: simplify process.memoryUsage() example code (Thomas Watson Steen) [#9560](https://github.com/nodejs/node/pull/9560) * [[`c48c318806`](https://github.com/nodejs/node/commit/c48c318806)] - **doc**: change ./node to node in debugger.md (AnnaMag) [#8943](https://github.com/nodejs/node/pull/8943) * [[`00a178257c`](https://github.com/nodejs/node/commit/00a178257c)] - **doc**: update CONTRIBUTING.md to address editing PRs (Gibson Fahnestock) [#9259](https://github.com/nodejs/node/pull/9259) * [[`2b2dde855a`](https://github.com/nodejs/node/commit/2b2dde855a)] - **doc**: add italoacasas to collaborators (Italo A. Casas) [#9677](https://github.com/nodejs/node/pull/9677) * [[`0f41058e41`](https://github.com/nodejs/node/commit/0f41058e41)] - **doc**: clarify relation between a file and a module (marzelin) [#9026](https://github.com/nodejs/node/pull/9026) * [[`d1d207bd75`](https://github.com/nodejs/node/commit/d1d207bd75)] - **doc**: add Sakthipriyan to the CTC (Rod Vagg) [#9427](https://github.com/nodejs/node/pull/9427) * [[`9dad98bdf1`](https://github.com/nodejs/node/commit/9dad98bdf1)] - **doc**: add 2016-10-26 CTC meeting minutes (Rich Trott) [#9348](https://github.com/nodejs/node/pull/9348) * [[`824009296a`](https://github.com/nodejs/node/commit/824009296a)] - **doc**: add 2016-10-05 CTC meeting minutes (Josh Gavant) [#9326](https://github.com/nodejs/node/pull/9326) * [[`1a701f1723`](https://github.com/nodejs/node/commit/1a701f1723)] - **doc**: add 2016-09-28 CTC meeting minutes (Josh Gavant) [#9325](https://github.com/nodejs/node/pull/9325) * [[`e9c6aff113`](https://github.com/nodejs/node/commit/e9c6aff113)] - **doc**: add 2016-10-19 CTC meeting minutes (Josh Gavant) [#9193](https://github.com/nodejs/node/pull/9193) * [[`c1e5e663a9`](https://github.com/nodejs/node/commit/c1e5e663a9)] - **doc**: improve header styling for API docs (Jeremiah Senkpiel) [#8811](https://github.com/nodejs/node/pull/8811) * [[`279e30c3ee`](https://github.com/nodejs/node/commit/279e30c3ee)] - **doc**: add CTC meeting minutes for 2016-10-12 (Michael Dawson) [#9070](https://github.com/nodejs/node/pull/9070) * [[`3b839d1855`](https://github.com/nodejs/node/commit/3b839d1855)] - **doc**: remove confusing reference in governance doc (Rich Trott) [#9073](https://github.com/nodejs/node/pull/9073) * [[`e564cb6af4`](https://github.com/nodejs/node/commit/e564cb6af4)] - **doc**: add ctc-review label information (Rich Trott) [#9072](https://github.com/nodejs/node/pull/9072) * [[`68ccc7a512`](https://github.com/nodejs/node/commit/68ccc7a512)] - **doc**: update reference to list hash algorithms in crypto.md (scott stern) [#9043](https://github.com/nodejs/node/pull/9043) * [[`132425a058`](https://github.com/nodejs/node/commit/132425a058)] - **doc**: specify that errno is a number, not a string (John Vilk) [#9007](https://github.com/nodejs/node/pull/9007) * [[`695ee1e77b`](https://github.com/nodejs/node/commit/695ee1e77b)] - **doc**: highlight deprecated API in ToC (Ilya Frolov) [#7189](https://github.com/nodejs/node/pull/7189) * [[`4f8bf1bcf8`](https://github.com/nodejs/node/commit/4f8bf1bcf8)] - **doc**: explains why Reviewed-By is added in PRs (jessicaquynh) [#9044](https://github.com/nodejs/node/pull/9044) * [[`af645a0553`](https://github.com/nodejs/node/commit/af645a0553)] - **doc**: explain why GitHub merge button is not used (jessicaquynh) [#9044](https://github.com/nodejs/node/pull/9044) * [[`f472c09e90`](https://github.com/nodejs/node/commit/f472c09e90)] - **doc**: reference signal(7) for the list of signals (Emanuele DelBono) [#9323](https://github.com/nodejs/node/pull/9323) * [[`88079817c2`](https://github.com/nodejs/node/commit/88079817c2)] - **doc**: fix typo in http.md (anu0012) [#9144](https://github.com/nodejs/node/pull/9144) * [[`9f0ef5a4f2`](https://github.com/nodejs/node/commit/9f0ef5a4f2)] - **doc**: fix heading type for v4.6.2 changelog (Myles Borins) [#9515](https://github.com/nodejs/node/pull/9515) * [[`f6f0b387ea`](https://github.com/nodejs/node/commit/f6f0b387ea)] - **events**: pass the original listener added by once (DavidCai) [#6394](https://github.com/nodejs/node/pull/6394) * [[`02e6c84de2`](https://github.com/nodejs/node/commit/02e6c84de2)] - **gitignore**: ignore all tap files (Johan Bergström) [#9262](https://github.com/nodejs/node/pull/9262) * [[`a7ae8876f9`](https://github.com/nodejs/node/commit/a7ae8876f9)] - **governance**: expand use of CTC issue tracker (Rich Trott) [#8945](https://github.com/nodejs/node/pull/8945) * [[`36abbbe736`](https://github.com/nodejs/node/commit/36abbbe736)] - **gtest**: output tap comments as yamlish (Johan Bergström) [#9262](https://github.com/nodejs/node/pull/9262) * [[`50a4471aff`](https://github.com/nodejs/node/commit/50a4471aff)] - **http**: fix connection upgrade checks (Brian White) [#8238](https://github.com/nodejs/node/pull/8238) * [[`c94482b167`](https://github.com/nodejs/node/commit/c94482b167)] - **(SEMVER-MINOR)** **http**: 451 status code "Unavailable For Legal Reasons" (Max Barinov) [#4377](https://github.com/nodejs/node/pull/4377) * [[`12da2581a8`](https://github.com/nodejs/node/commit/12da2581a8)] - **https**: fix memory leak with https.request() (Ilkka Myller) [#8647](https://github.com/nodejs/node/pull/8647) * [[`3b448a7f12`](https://github.com/nodejs/node/commit/3b448a7f12)] - **lib**: changed var to const in linkedlist (Adri Van Houdt) [#8609](https://github.com/nodejs/node/pull/8609) * [[`a3a184d40a`](https://github.com/nodejs/node/commit/a3a184d40a)] - **lib**: fix TypeError in v8-polyfill (Wyatt Preul) [#8863](https://github.com/nodejs/node/pull/8863) * [[`423846053b`](https://github.com/nodejs/node/commit/423846053b)] - **lib**: remove let from for loops (Myles Borins) [#8873](https://github.com/nodejs/node/pull/8873) * [[`9a192a9683`](https://github.com/nodejs/node/commit/9a192a9683)] - **net**: fix ambiguity in EOF handling (Fedor Indutny) [#9066](https://github.com/nodejs/node/pull/9066) * [[`62e83b363e`](https://github.com/nodejs/node/commit/62e83b363e)] - **src**: Malloc/Calloc size 0 returns non-null pointer (Rich Trott) [#8572](https://github.com/nodejs/node/pull/8572) * [[`51e09d00c4`](https://github.com/nodejs/node/commit/51e09d00c4)] - **src**: normalize malloc, realloc (Michael Dawson) [#7564](https://github.com/nodejs/node/pull/7564) * [[`3b5cedebd1`](https://github.com/nodejs/node/commit/3b5cedebd1)] - **src**: renaming ares_task struct to node_ares_task (Daniel Bevenius) [#7345](https://github.com/nodejs/node/pull/7345) * [[`e5d2a95d68`](https://github.com/nodejs/node/commit/e5d2a95d68)] - **src**: remove out-of-date TODO comment (Daniel Bevenius) [#9000](https://github.com/nodejs/node/pull/9000) * [[`b4353e9017`](https://github.com/nodejs/node/commit/b4353e9017)] - **src**: fix typo in #endif comment (Juan Andres Andrango) [#8989](https://github.com/nodejs/node/pull/8989) * [[`f0192ec195`](https://github.com/nodejs/node/commit/f0192ec195)] - **src**: don't abort when c-ares initialization fails (Ben Noordhuis) [#8710](https://github.com/nodejs/node/pull/8710) * [[`f669a08b76`](https://github.com/nodejs/node/commit/f669a08b76)] - **src**: fix typo rval to value (Miguel Angel Asencio Hurtado) [#9023](https://github.com/nodejs/node/pull/9023) * [[`9b9762ccec`](https://github.com/nodejs/node/commit/9b9762ccec)] - **streams**: fix regression in `unpipe()` (Anna Henningsen) [#9171](https://github.com/nodejs/node/pull/9171) * [[`cc36a63205`](https://github.com/nodejs/node/commit/cc36a63205)] - **test**: remove watchdog in test-debug-signal-cluster (Rich Trott) [#9476](https://github.com/nodejs/node/pull/9476) * [[`9144d373ba`](https://github.com/nodejs/node/commit/9144d373ba)] - **test**: cleanup test-dgram-error-message-address (Michael Macherey) [#8938](https://github.com/nodejs/node/pull/8938) * [[`96bdfae041`](https://github.com/nodejs/node/commit/96bdfae041)] - **test**: improve test-debugger-util-regression (Santiago Gimeno) [#9490](https://github.com/nodejs/node/pull/9490) * [[`2c758861c0`](https://github.com/nodejs/node/commit/2c758861c0)] - **test**: move timer-dependent test to sequential (Rich Trott) [#9431](https://github.com/nodejs/node/pull/9431) * [[`d9955fbb17`](https://github.com/nodejs/node/commit/d9955fbb17)] - **test**: add test for HTTP client "aborted" event (Kyle E. Mitchell) [#7376](https://github.com/nodejs/node/pull/7376) * [[`b0476c5590`](https://github.com/nodejs/node/commit/b0476c5590)] - **test**: fix flaky test-fs-watch-recursive on OS X (Rich Trott) [#9303](https://github.com/nodejs/node/pull/9303) * [[`bcd156f4ab`](https://github.com/nodejs/node/commit/bcd156f4ab)] - **test**: refactor test-async-wrap-check-providers (Gerges Beshay) [#9297](https://github.com/nodejs/node/pull/9297) * [[`9d5e7f5c85`](https://github.com/nodejs/node/commit/9d5e7f5c85)] - **test**: use strict assertions in module loader test (Ben Noordhuis) [#9263](https://github.com/nodejs/node/pull/9263) * [[`6d742b3fdd`](https://github.com/nodejs/node/commit/6d742b3fdd)] - **test**: remove err timer from test-http-set-timeout (BethGriggs) [#9264](https://github.com/nodejs/node/pull/9264) * [[`51b251d8eb`](https://github.com/nodejs/node/commit/51b251d8eb)] - **test**: add coverage for spawnSync() killSignal (cjihrig) [#8960](https://github.com/nodejs/node/pull/8960) * [[`fafffd4f99`](https://github.com/nodejs/node/commit/fafffd4f99)] - **test**: fix test-child-process-fork-regr-gh-2847 (Santiago Gimeno) [#8954](https://github.com/nodejs/node/pull/8954) * [[`a2621a25e5`](https://github.com/nodejs/node/commit/a2621a25e5)] - **test**: remove FIXME pummel/test-tls-securepair-client (Alfred Cepeda) [#8757](https://github.com/nodejs/node/pull/8757) * [[`747013bc39`](https://github.com/nodejs/node/commit/747013bc39)] - **test**: output tap13 instead of almost-tap (Johan Bergström) [#9262](https://github.com/nodejs/node/pull/9262) * [[`790406661d`](https://github.com/nodejs/node/commit/790406661d)] - **test**: refactor test-net-server-max-connections (Rich Trott) [#8931](https://github.com/nodejs/node/pull/8931) * [[`347547a97e`](https://github.com/nodejs/node/commit/347547a97e)] - **test**: expand test coverage for url.js (Junshu Okamoto) [#8859](https://github.com/nodejs/node/pull/8859) * [[`cec5e36df7`](https://github.com/nodejs/node/commit/cec5e36df7)] - **test**: fix test-cluster-worker-init.js flakyness (Ilkka Myller) [#8703](https://github.com/nodejs/node/pull/8703) * [[`b3fccc2536`](https://github.com/nodejs/node/commit/b3fccc2536)] - **test**: enable cyrillic punycode test case (Ben Noordhuis) [#8695](https://github.com/nodejs/node/pull/8695) * [[`03f703177f`](https://github.com/nodejs/node/commit/03f703177f)] - **test**: remove call to `net.Socket.resume()` (Alfred Cepeda) [#8679](https://github.com/nodejs/node/pull/8679) * [[`527db40932`](https://github.com/nodejs/node/commit/527db40932)] - **test**: add coverage for execFileSync() errors (cjihrig) [#9211](https://github.com/nodejs/node/pull/9211) * [[`40ef23969d`](https://github.com/nodejs/node/commit/40ef23969d)] - **test**: writable stream needDrain state (Italo A. Casas) [#8799](https://github.com/nodejs/node/pull/8799) * [[`ba4a3ede56`](https://github.com/nodejs/node/commit/ba4a3ede56)] - **test**: writable stream ending state (Italo A. Casas) [#8707](https://github.com/nodejs/node/pull/8707) * [[`80a26c7540`](https://github.com/nodejs/node/commit/80a26c7540)] - **test**: writable stream finished state (Italo A. Casas) [#8791](https://github.com/nodejs/node/pull/8791) * [[`a64af39c83`](https://github.com/nodejs/node/commit/a64af39c83)] - **test**: remove duplicate required module (Rich Trott) [#9169](https://github.com/nodejs/node/pull/9169) * [[`a038fcc307`](https://github.com/nodejs/node/commit/a038fcc307)] - **test**: add regression test for instanceof (Franziska Hinkelmann) [#9178](https://github.com/nodejs/node/pull/9178) * [[`bd99b2d4e4`](https://github.com/nodejs/node/commit/bd99b2d4e4)] - **test**: checking if error constructor is assert.AssertionError (larissayvette) [#9119](https://github.com/nodejs/node/pull/9119) * [[`4a6bd8683f`](https://github.com/nodejs/node/commit/4a6bd8683f)] - **test**: fix flaky test-child-process-fork-dgram (Rich Trott) [#9098](https://github.com/nodejs/node/pull/9098) * [[`d9c33646e6`](https://github.com/nodejs/node/commit/d9c33646e6)] - **test**: add regression test for `unpipe()` (Niels Nielsen) [#9171](https://github.com/nodejs/node/pull/9171) * [[`f9b24f42ba`](https://github.com/nodejs/node/commit/f9b24f42ba)] - **test**: use npm sandbox in test-npm-install (João Reis) [#9079](https://github.com/nodejs/node/pull/9079) * [[`54c38eb22e`](https://github.com/nodejs/node/commit/54c38eb22e)] - **tickprocessor**: apply c++filt manually on mac (Fedor Indutny) [#8480](https://github.com/nodejs/node/pull/8480) * [[`bf25994308`](https://github.com/nodejs/node/commit/bf25994308)] - **tls**: fix leak of WriteWrap+TLSWrap combination (Fedor Indutny) [#9586](https://github.com/nodejs/node/pull/9586) * [[`9049c1f6b6`](https://github.com/nodejs/node/commit/9049c1f6b6)] - **(SEMVER-MINOR)** **tls**: introduce `secureContext` for `tls.connect` (Fedor Indutny) [#4246](https://github.com/nodejs/node/pull/4246) * [[`b1bd1c42c0`](https://github.com/nodejs/node/commit/b1bd1c42c0)] - **tools**: allow test.py to use full paths of tests (Francis Gulotta) [#9694](https://github.com/nodejs/node/pull/9694) * [[`533ce48b6a`](https://github.com/nodejs/node/commit/533ce48b6a)] - **tools**: make --repeat work with -j in test.py (Rich Trott) [#9249](https://github.com/nodejs/node/pull/9249) * [[`f9baa1119f`](https://github.com/nodejs/node/commit/f9baa1119f)] - **tools**: remove dangling eslint symlink (Sam Roberts) [#9299](https://github.com/nodejs/node/pull/9299) * [[`c8dccf29dd`](https://github.com/nodejs/node/commit/c8dccf29dd)] - **tools**: avoid let in for loops (jessicaquynh) [#9049](https://github.com/nodejs/node/pull/9049) * [[`620cdc5ce8`](https://github.com/nodejs/node/commit/620cdc5ce8)] - **tools**: fix release script on macOS 10.12 (Evan Lucas) [#8824](https://github.com/nodejs/node/pull/8824) * [[`f18f3b61e3`](https://github.com/nodejs/node/commit/f18f3b61e3)] - **util**: use template strings (Alejandro Oviedo Garcia) [#9120](https://github.com/nodejs/node/pull/9120) * [[`1dfb5b5a09`](https://github.com/nodejs/node/commit/1dfb5b5a09)] - **v8**: update make-v8.sh to use git (Jaideep Bajwa) [#9393](https://github.com/nodejs/node/pull/9393) * [[`bdb6cf92c7`](https://github.com/nodejs/node/commit/bdb6cf92c7)] - **win,msi**: mark INSTALLDIR property as secure (João Reis) [#8795](https://github.com/nodejs/node/pull/8795) * [[`9a02414a29`](https://github.com/nodejs/node/commit/9a02414a29)] - **zlib**: fix raw inflate with custom dictionary (Tarjei Husøy) ## 2016-11-08, Version 4.6.2 'Argon' (LTS), @thealphanerd This LTS release comes with 219 commits. This includes 80 commits that are docs related, 58 commits that are test related, 20 commits that are build / tool related, and 9 commits that are updates to dependencies. ### Notable Changes * **build**: It is now possible to build the documentation from the release tarball (Anna Henningsen) [#8413](https://github.com/nodejs/node/pull/8413) * **buffer**: Buffer.alloc() will no longer incorrectly return a zero filled buffer when an encoding is passed (Teddy Katz) [#9238](https://github.com/nodejs/node/pull/9238) * **deps**: upgrade npm in LTS to 2.15.11 (Kat Marchán) [#8928](https://github.com/nodejs/node/pull/8928) * **repl**: Enable tab completion for global properties (Lance Ball) [#7369](https://github.com/nodejs/node/pull/7369) * **url**: `url.format()` will now encode all `#` in `search` (Ilkka Myller) [#8072](https://github.com/nodejs/node/pull/8072) ### Commits * [[`06a1c9bf80`](https://github.com/nodejs/node/commit/06a1c9bf80)] - **assert**: remove code that is never reached (Rich Trott) [#8132](https://github.com/nodejs/node/pull/8132) * [[`861e584d46`](https://github.com/nodejs/node/commit/861e584d46)] - **async_wrap**: add a missing case to test-async-wrap-throw-no-init (yorkie) [#8198](https://github.com/nodejs/node/pull/8198) * [[`a3d08025fa`](https://github.com/nodejs/node/commit/a3d08025fa)] - **benchmark**: add benches for fs.stat & fs.statSync (Anna Henningsen) [#8338](https://github.com/nodejs/node/pull/8338) * [[`408a585261`](https://github.com/nodejs/node/commit/408a585261)] - **buffer**: fix `fill` with encoding in Buffer.alloc() (Teddy Katz) [#9238](https://github.com/nodejs/node/pull/9238) * [[`17c4187949`](https://github.com/nodejs/node/commit/17c4187949)] - **buffer**: optimize hex_decode (Christopher Jeffrey) [#7602](https://github.com/nodejs/node/pull/7602) * [[`50cfea0081`](https://github.com/nodejs/node/commit/50cfea0081)] - **build**: run `npm install` for doc builds in tarball (Anna Henningsen) [#8413](https://github.com/nodejs/node/pull/8413) * [[`c4be179064`](https://github.com/nodejs/node/commit/c4be179064)] - **build**: add missing files to zip and 7z packages (Richard Lau) [#8069](https://github.com/nodejs/node/pull/8069) * [[`41e27f6a6a`](https://github.com/nodejs/node/commit/41e27f6a6a)] - **build**: don't link against liblog on host system (Ben Noordhuis) [#7762](https://github.com/nodejs/node/pull/7762) * [[`7766997f7e`](https://github.com/nodejs/node/commit/7766997f7e)] - **build**: add conflict marker check during CI lint (Brian White) [#7625](https://github.com/nodejs/node/pull/7625) * [[`2a66ddbcbb`](https://github.com/nodejs/node/commit/2a66ddbcbb)] - **build**: re-add --ninja option to configure (Ehsan Akhgari) [#6780](https://github.com/nodejs/node/pull/6780) * [[`950cc1df83`](https://github.com/nodejs/node/commit/950cc1df83)] - **build**: adding config.gypi dep to addons/.buildstamp (Daniel Bevenius) [#7893](https://github.com/nodejs/node/pull/7893) * [[`e64063c344`](https://github.com/nodejs/node/commit/e64063c344)] - **build**: don't require processing docs for nightlies (Johan Bergström) [#8325](https://github.com/nodejs/node/pull/8325) * [[`00ea7388cb`](https://github.com/nodejs/node/commit/00ea7388cb)] - **build**: fix dependencies on AIX (Michael Dawson) [#8285](https://github.com/nodejs/node/pull/8285) * [[`8dfab3ad68`](https://github.com/nodejs/node/commit/8dfab3ad68)] - **build**: fix dependencies on AIX (Michael Dawson) [#8272](https://github.com/nodejs/node/pull/8272) * [[`1b5f35f1be`](https://github.com/nodejs/node/commit/1b5f35f1be)] - **build**: turn on thin static archives (Ben Noordhuis) [#7957](https://github.com/nodejs/node/pull/7957) * [[`c41efe4d68`](https://github.com/nodejs/node/commit/c41efe4d68)] - **build**: add node_module_version to config.gypi (Marcin Cieślak) [#8171](https://github.com/nodejs/node/pull/8171) * [[`f556b43e3e`](https://github.com/nodejs/node/commit/f556b43e3e)] - **build**: add --enable-d8 configure option (Ben Noordhuis) [#7538](https://github.com/nodejs/node/pull/7538) * [[`612dfeb647`](https://github.com/nodejs/node/commit/612dfeb647)] - **child_process**: Check stderr before accessing it (Robert Chiras) [#6877](https://github.com/nodejs/node/pull/6877) * [[`5ed5142158`](https://github.com/nodejs/node/commit/5ed5142158)] - **child_process**: workaround fd passing issue on OS X (Santiago Gimeno) [#7572](https://github.com/nodejs/node/pull/7572) * [[`227db0ab21`](https://github.com/nodejs/node/commit/227db0ab21)] - **cluster**: remove bind() and self (cjihrig) [#7710](https://github.com/nodejs/node/pull/7710) * [[`3003131e9a`](https://github.com/nodejs/node/commit/3003131e9a)] - **configure**: reword help for --without-npm (BlackYoup) [#7471](https://github.com/nodejs/node/pull/7471) * [[`2b933339d0`](https://github.com/nodejs/node/commit/2b933339d0)] - **debugger**: use arrow function for lexical `this` (Guy Fraser) [#7415](https://github.com/nodejs/node/pull/7415) * [[`52cba4147d`](https://github.com/nodejs/node/commit/52cba4147d)] - **deps**: backport 2bcbe2f from V8 upstream (ofrobots) [#7814](https://github.com/nodejs/node/pull/7814) * [[`2b01bc8e55`](https://github.com/nodejs/node/commit/2b01bc8e55)] - **deps**: backport a76d133 from v8 upstream (Matt Loring) [#7689](https://github.com/nodejs/node/pull/7689) * [[`e1f12fb358`](https://github.com/nodejs/node/commit/e1f12fb358)] - **deps**: cherry-pick b93c80a from v8 upstream (Matt Loring) [#7689](https://github.com/nodejs/node/pull/7689) * [[`2d07fd71ee`](https://github.com/nodejs/node/commit/2d07fd71ee)] - **deps**: backport e093a04, 09db540 from upstream V8 (Ali Ijaz Sheikh) [#7689](https://github.com/nodejs/node/pull/7689) * [[`4369055878`](https://github.com/nodejs/node/commit/4369055878)] - **deps**: cherry-pick 1f53e42 from v8 upstream (Ben Noordhuis) [#7612](https://github.com/nodejs/node/pull/7612) * [[`05d40d9573`](https://github.com/nodejs/node/commit/05d40d9573)] - **deps**: upgrade npm in LTS to 2.15.11 (Kat Marchán) [#8928](https://github.com/nodejs/node/pull/8928) * [[`36b3ff0cfc`](https://github.com/nodejs/node/commit/36b3ff0cfc)] - **deps**: float gyp patch for long filenames (Anna Henningsen) [#7963](https://github.com/nodejs/node/pull/7963) * [[`9ddc615d0e`](https://github.com/nodejs/node/commit/9ddc615d0e)] - **deps**: no /safeseh for ml64.exe (Fedor Indutny) [#7759](https://github.com/nodejs/node/pull/7759) * [[`ea36c61eda`](https://github.com/nodejs/node/commit/ea36c61eda)] - **deps**: `MASM.UseSafeExceptionHandlers` for OpenSSL (Fedor Indutny) [#7427](https://github.com/nodejs/node/pull/7427) * [[`0b87b1a095`](https://github.com/nodejs/node/commit/0b87b1a095)] - **dns**: tweak regex for IPv6 addresses (Luigi Pinca) [#8665](https://github.com/nodejs/node/pull/8665) * [[`0e2aba96bc`](https://github.com/nodejs/node/commit/0e2aba96bc)] - **doc**: make sure links are correctly passed to marked (Timothy Gu) [#8494](https://github.com/nodejs/node/pull/8494) * [[`3a43b0d981`](https://github.com/nodejs/node/commit/3a43b0d981)] - **doc**: correct metadata of `Buffer.from` (Anna Henningsen) [#9167](https://github.com/nodejs/node/pull/9167) * [[`880ca99847`](https://github.com/nodejs/node/commit/880ca99847)] - **doc**: fix broken link in dgram doc (Brian White) [#8365](https://github.com/nodejs/node/pull/8365) * [[`65ca2af471`](https://github.com/nodejs/node/commit/65ca2af471)] - **doc**: add missing semicolon (Ravindra barthwal) [#7915](https://github.com/nodejs/node/pull/7915) * [[`da3b938be3`](https://github.com/nodejs/node/commit/da3b938be3)] - **doc**: add `added:` information for globals (Luigi Pinca) [#8901](https://github.com/nodejs/node/pull/8901) * [[`b4ba4af525`](https://github.com/nodejs/node/commit/b4ba4af525)] - **doc**: add CTC meeting minutes 2016-09-07 (Josh Gavant) [#8499](https://github.com/nodejs/node/pull/8499) * [[`4b49b0e30c`](https://github.com/nodejs/node/commit/4b49b0e30c)] - **doc**: add CTC meeting minutes 2016-09-14 (Josh Gavant) [#8726](https://github.com/nodejs/node/pull/8726) * [[`88b0067229`](https://github.com/nodejs/node/commit/88b0067229)] - **doc**: add CTC meeting minutes 2016-09-21 (Josh Gavant) [#8727](https://github.com/nodejs/node/pull/8727) * [[`f7c4e9489f`](https://github.com/nodejs/node/commit/f7c4e9489f)] - **doc**: update npm LICENSE using license-builder.sh (Kat Marchán) [#8928](https://github.com/nodejs/node/pull/8928) * [[`6effc4aadc`](https://github.com/nodejs/node/commit/6effc4aadc)] - **doc**: add `added:` information for crypto (Luigi Pinca) [#8281](https://github.com/nodejs/node/pull/8281) * [[`d750fc6336`](https://github.com/nodejs/node/commit/d750fc6336)] - **doc**: add `added:` information for dgram (Luigi Pinca) [#8196](https://github.com/nodejs/node/pull/8196) * [[`b92e3fc72e`](https://github.com/nodejs/node/commit/b92e3fc72e)] - **doc**: add `added:` information for util (Luigi Pinca) [#8206](https://github.com/nodejs/node/pull/8206) * [[`578bf511f9`](https://github.com/nodejs/node/commit/578bf511f9)] - **doc**: add `added:` information for events (Luigi Pinca) [#7822](https://github.com/nodejs/node/pull/7822) * [[`6ef58e7211`](https://github.com/nodejs/node/commit/6ef58e7211)] - **doc**: add gibfahn to collaborators (Gibson Fahnestock) [#8533](https://github.com/nodejs/node/pull/8533) * [[`5ff1fc7d86`](https://github.com/nodejs/node/commit/5ff1fc7d86)] - **doc**: add imyller to collaborators (Ilkka Myller) [#8530](https://github.com/nodejs/node/pull/8530) * [[`88bb65dd74`](https://github.com/nodejs/node/commit/88bb65dd74)] - **doc**: add not-an-aardvark to collaborators (not-an-aardvark) [#8525](https://github.com/nodejs/node/pull/8525) * [[`5bec1eb0d4`](https://github.com/nodejs/node/commit/5bec1eb0d4)] - **doc**: update onboarding PR landing info (Rich Trott) [#8479](https://github.com/nodejs/node/pull/8479) * [[`ecd2b52982`](https://github.com/nodejs/node/commit/ecd2b52982)] - **doc**: encourage 2FA before onboarding (Rich Trott) [#8776](https://github.com/nodejs/node/pull/8776) * [[`2adbd53837`](https://github.com/nodejs/node/commit/2adbd53837)] - **doc**: add commit formats for release blog posts (fen) [#8631](https://github.com/nodejs/node/pull/8631) * [[`764502bb37`](https://github.com/nodejs/node/commit/764502bb37)] - **doc**: add CTC meeting minutes 2016-08-24 (Josh Gavant) [#8423](https://github.com/nodejs/node/pull/8423) * [[`3037a9da08`](https://github.com/nodejs/node/commit/3037a9da08)] - **doc**: add eugeneo to collaborators (Eugene Ostroukhov) [#8696](https://github.com/nodejs/node/pull/8696) * [[`0fd1d8dfd7`](https://github.com/nodejs/node/commit/0fd1d8dfd7)] - **doc**: add ak239 to collaborators (Aleksey Kozyatinskiy) [#8676](https://github.com/nodejs/node/pull/8676) * [[`64c4bb30fe`](https://github.com/nodejs/node/commit/64c4bb30fe)] - **doc**: add link to help repo in README (Rich Trott) [#8570](https://github.com/nodejs/node/pull/8570) * [[`d123fc1307`](https://github.com/nodejs/node/commit/d123fc1307)] - **doc**: update exercise portion of onboarding doc (Rich Trott) [#8559](https://github.com/nodejs/node/pull/8559) * [[`c6b622f6b3`](https://github.com/nodejs/node/commit/c6b622f6b3)] - **doc**: add CTC meeting minutes 2016-08-31 (Josh Gavant) [#8424](https://github.com/nodejs/node/pull/8424) * [[`055d39c724`](https://github.com/nodejs/node/commit/055d39c724)] - **doc**: add CI help/support info to onboarding doc (Rich Trott) [#8407](https://github.com/nodejs/node/pull/8407) * [[`a7e6fc08d8`](https://github.com/nodejs/node/commit/a7e6fc08d8)] - **doc**: add 2016-08-17 CTC meeting minutes (Josh Gavant) [#8245](https://github.com/nodejs/node/pull/8245) * [[`ca63c127c7`](https://github.com/nodejs/node/commit/ca63c127c7)] - **doc**: add 2016-08-10 CTC meeting minutes (Josh Gavant) [#8229](https://github.com/nodejs/node/pull/8229) * [[`3f2e3dfb32`](https://github.com/nodejs/node/commit/3f2e3dfb32)] - **doc**: update CI content in onboarding doc (Rich Trott) [#8374](https://github.com/nodejs/node/pull/8374) * [[`9e1325c42e`](https://github.com/nodejs/node/commit/9e1325c42e)] - **doc**: update authors list (James M Snell) [#8346](https://github.com/nodejs/node/pull/8346) * [[`c529bf5521`](https://github.com/nodejs/node/commit/c529bf5521)] - **doc**: add return type of clientRequest.setTimeout (Mike Ralphson) [#8356](https://github.com/nodejs/node/pull/8356) * [[`c094b2a51c`](https://github.com/nodejs/node/commit/c094b2a51c)] - **doc**: update targos email in readme per request (James M Snell) [#8389](https://github.com/nodejs/node/pull/8389) * [[`5c417ee25b`](https://github.com/nodejs/node/commit/5c417ee25b)] - **doc**: update landing pr info in onboarding doc (Rich Trott) [#8344](https://github.com/nodejs/node/pull/8344) * [[`763fa85ccf`](https://github.com/nodejs/node/commit/763fa85ccf)] - **doc**: bad/better examples for fs.access() and fs.exists() (Dan Fabulich) [#7832](https://github.com/nodejs/node/pull/7832) * [[`0c933e5bab`](https://github.com/nodejs/node/commit/0c933e5bab)] - **doc**: adding danbev to collaborators (Daniel Bevenius) [#8359](https://github.com/nodejs/node/pull/8359) * [[`e069dc45b0`](https://github.com/nodejs/node/commit/e069dc45b0)] - **doc**: add lpinca to collaborators (Luigi Pinca) [#8331](https://github.com/nodejs/node/pull/8331) * [[`e5f4367da5`](https://github.com/nodejs/node/commit/e5f4367da5)] - **doc**: readline write() is processed as input (James M Snell) [#8295](https://github.com/nodejs/node/pull/8295) * [[`b3617fcc7d`](https://github.com/nodejs/node/commit/b3617fcc7d)] - **doc**: add `added:` information for modules (Luigi Pinca) [#8250](https://github.com/nodejs/node/pull/8250) * [[`0b605636c5`](https://github.com/nodejs/node/commit/0b605636c5)] - **doc**: add Myles Borins to the CTC (Rod Vagg) [#8260](https://github.com/nodejs/node/pull/8260) * [[`a8a8f0a6f1`](https://github.com/nodejs/node/commit/a8a8f0a6f1)] - **doc**: add `added:` information for cluster (Anna Henningsen) [#7640](https://github.com/nodejs/node/pull/7640) * [[`2a2971b26e`](https://github.com/nodejs/node/commit/2a2971b26e)] - **doc**: use blockquotes for Stability: markers (Anna Henningsen) [#7757](https://github.com/nodejs/node/pull/7757) * [[`3a3fde69c7`](https://github.com/nodejs/node/commit/3a3fde69c7)] - **doc**: fix variable scoping bug in server example code (lazlojuly) [#8124](https://github.com/nodejs/node/pull/8124) * [[`f1e14e4227`](https://github.com/nodejs/node/commit/f1e14e4227)] - **doc**: fix cluster message event docs (Zach Bjornson) [#8017](https://github.com/nodejs/node/pull/8017) * [[`9b29cfc3a6`](https://github.com/nodejs/node/commit/9b29cfc3a6)] - **doc**: Clean up roff source in manpage (Alhadis) [#7819](https://github.com/nodejs/node/pull/7819) * [[`364af49e0f`](https://github.com/nodejs/node/commit/364af49e0f)] - **doc**: add CTC meeting minutes 2016-06-22 (Josh Gavant) [#7390](https://github.com/nodejs/node/pull/7390) * [[`9892a5ddc3`](https://github.com/nodejs/node/commit/9892a5ddc3)] - **doc**: remove extra spaces and concats in examples (Joe Esposito) [#7885](https://github.com/nodejs/node/pull/7885) * [[`3ad74089f5`](https://github.com/nodejs/node/commit/3ad74089f5)] - **doc**: correct sample output of buf.compare (Hargobind S. Khalsa) [#7777](https://github.com/nodejs/node/pull/7777) * [[`26e695c46c`](https://github.com/nodejs/node/commit/26e695c46c)] - **doc**: remove "feature branch" jargon (Rich Trott) [#8194](https://github.com/nodejs/node/pull/8194) * [[`d676467208`](https://github.com/nodejs/node/commit/d676467208)] - **doc**: remove outdated LTS info from ROADMAP.md (Rich Trott) [#8161](https://github.com/nodejs/node/pull/8161) * [[`b3545e148d`](https://github.com/nodejs/node/commit/b3545e148d)] - **doc**: update release announce instruction to tweet (Tracy Hinds) [#8126](https://github.com/nodejs/node/pull/8126) * [[`2032bba65f`](https://github.com/nodejs/node/commit/2032bba65f)] - **doc**: add @joshgav to collaborators (Josh Gavant) [#8146](https://github.com/nodejs/node/pull/8146) * [[`727c24f3a2`](https://github.com/nodejs/node/commit/727c24f3a2)] - **doc**: update Reviewing section of onboarding doc (Rich Trott) * [[`04515b891a`](https://github.com/nodejs/node/commit/04515b891a)] - **doc**: move orangemocha to collaborators list (Rich Trott) [#8062](https://github.com/nodejs/node/pull/8062) * [[`d3344aa216`](https://github.com/nodejs/node/commit/d3344aa216)] - **doc**: Add fhinkel to collaborators (Franziska Hinkelmann) [#8052](https://github.com/nodejs/node/pull/8052) * [[`532bbde4bf`](https://github.com/nodejs/node/commit/532bbde4bf)] - **doc**: add CTC meeting minutes 2016-08-03 (Josh Gavant) [#7980](https://github.com/nodejs/node/pull/7980) * [[`98fe74fbc8`](https://github.com/nodejs/node/commit/98fe74fbc8)] - **doc**: fix a markdown error in CTC meeting minutes (Сковорода Никита Андреевич) [#7729](https://github.com/nodejs/node/pull/7729) * [[`e74daadeb6`](https://github.com/nodejs/node/commit/e74daadeb6)] - **doc**: clarify collaborators & ctc members relationships (yorkie) [#7996](https://github.com/nodejs/node/pull/7996) * [[`6bfdc92860`](https://github.com/nodejs/node/commit/6bfdc92860)] - **doc**: clarify "Reviewed-By" iff "LGTM" (Bryan English) [#7183](https://github.com/nodejs/node/pull/7183) * [[`94a82cd0a7`](https://github.com/nodejs/node/commit/94a82cd0a7)] - **doc**: add CTC meeting minutes 2016-07-13 (Josh Gavant) [#7968](https://github.com/nodejs/node/pull/7968) * [[`012ccf010e`](https://github.com/nodejs/node/commit/012ccf010e)] - **doc**: add CTC meeting minutes 2016-07-20 (Josh Gavant) [#7970](https://github.com/nodejs/node/pull/7970) * [[`08111e84b1`](https://github.com/nodejs/node/commit/08111e84b1)] - **doc**: use consistent markdown in README (Rich Trott) [#7971](https://github.com/nodejs/node/pull/7971) * [[`009df788de`](https://github.com/nodejs/node/commit/009df788de)] - **doc**: use `git-secure-tag` for release tags (Fedor Indutny) [#7603](https://github.com/nodejs/node/pull/7603) * [[`abefdca5ae`](https://github.com/nodejs/node/commit/abefdca5ae)] - **doc**: piscisaureus has stepped-down from the CTC (James M Snell) [#7969](https://github.com/nodejs/node/pull/7969) * [[`9700660d2b`](https://github.com/nodejs/node/commit/9700660d2b)] - **doc**: add @addaleax to the CTC (Anna Henningsen) [#7966](https://github.com/nodejs/node/pull/7966) * [[`f255180853`](https://github.com/nodejs/node/commit/f255180853)] - **doc**: add CTC meeting minutes 2016-07-06 (Josh Gavant) [#7570](https://github.com/nodejs/node/pull/7570) * [[`b60473fac7`](https://github.com/nodejs/node/commit/b60473fac7)] - **doc**: add CTC meeting minutes 2016-06-29 (Josh Gavant) [#7571](https://github.com/nodejs/node/pull/7571) * [[`ac40b2a9b6`](https://github.com/nodejs/node/commit/ac40b2a9b6)] - **doc**: add CTC meeting minutes 2016-07-27 (William Kapke) [#7900](https://github.com/nodejs/node/pull/7900) * [[`bbbbb19658`](https://github.com/nodejs/node/commit/bbbbb19658)] - **doc**: add information about CTC quorum rules (Rich Trott) [#7813](https://github.com/nodejs/node/pull/7813) * [[`d759d4e0a6`](https://github.com/nodejs/node/commit/d759d4e0a6)] - **doc**: remove platform assumption from CONTRIBUTING (Bethany N Griggs) [#7783](https://github.com/nodejs/node/pull/7783) * [[`b01854dd9d`](https://github.com/nodejs/node/commit/b01854dd9d)] - **doc**: add princejwesley to collaborators (Prince J Wesley) [#7877](https://github.com/nodejs/node/pull/7877) * [[`26f5168c02`](https://github.com/nodejs/node/commit/26f5168c02)] - **doc**: clarify that the node.js irc channel is not under tsc oversight (James M Snell) [#7810](https://github.com/nodejs/node/pull/7810) * [[`506e367062`](https://github.com/nodejs/node/commit/506e367062)] - **doc**: update readme with andrasq as a collaborator (Andras) [#7801](https://github.com/nodejs/node/pull/7801) * [[`590c52a309`](https://github.com/nodejs/node/commit/590c52a309)] - **doc**: update CTC governance information (Rich Trott) [#7719](https://github.com/nodejs/node/pull/7719) * [[`fdff642e0b`](https://github.com/nodejs/node/commit/fdff642e0b)] - **doc**: fix util.deprecate() example (Evan Lucas) [#7674](https://github.com/nodejs/node/pull/7674) * [[`8fec02ffb8`](https://github.com/nodejs/node/commit/8fec02ffb8)] - **doc**: delete non-existing zlib constants (Franziska Hinkelmann) [#7520](https://github.com/nodejs/node/pull/7520) * [[`d6c2e383a2`](https://github.com/nodejs/node/commit/d6c2e383a2)] - **doc**: minor updates to onboarding doc (Rich Trott) [#8060](https://github.com/nodejs/node/pull/8060) * [[`e46d1e026e`](https://github.com/nodejs/node/commit/e46d1e026e)] - **doc**: add POST_STATUS_TO_PR info to onboarding doc (Rich Trott) [#8059](https://github.com/nodejs/node/pull/8059) * [[`4f3107190d`](https://github.com/nodejs/node/commit/4f3107190d)] - **doc**: add `added:` info for dgram.*Membership() (Rich Trott) [#6753](https://github.com/nodejs/node/pull/6753) * [[`0e52861629`](https://github.com/nodejs/node/commit/0e52861629)] - **doc**: grammar fixes to event loop guide (Ryan Lewis) [#7479](https://github.com/nodejs/node/pull/7479) * [[`29139bff65`](https://github.com/nodejs/node/commit/29139bff65)] - **doc**: improve server.listen() random port (Phillip Johnsen) [#8025](https://github.com/nodejs/node/pull/8025) * [[`b680eb99ad`](https://github.com/nodejs/node/commit/b680eb99ad)] - **doctool**: improve the title of pages in doc (yorkie) * [[`3d6f107a2f`](https://github.com/nodejs/node/commit/3d6f107a2f)] - **fs**: fix handling of `uv_stat_t` fields (Anna Henningsen) [#8515](https://github.com/nodejs/node/pull/8515) * [[`2e29b76666`](https://github.com/nodejs/node/commit/2e29b76666)] - **intl**: Don't crash if v8BreakIterator not available (Steven R. Loomis) [#4253](https://github.com/nodejs/node/pull/4253) * [[`f6e332da2d`](https://github.com/nodejs/node/commit/f6e332da2d)] - **lib**: implement consistent brace style (Rich Trott) [#8348](https://github.com/nodejs/node/pull/8348) * [[`9d9bcd7c55`](https://github.com/nodejs/node/commit/9d9bcd7c55)] - **meta**: clarify process for breaking changes (Rich Trott) [#7955](https://github.com/nodejs/node/pull/7955) * [[`6d49f22e35`](https://github.com/nodejs/node/commit/6d49f22e35)] - **meta**: include a minimal CTC removal policy (Rich Trott) [#7720](https://github.com/nodejs/node/pull/7720) * [[`7faf6dc0da`](https://github.com/nodejs/node/commit/7faf6dc0da)] - **meta**: provide example activities (Rich Trott) [#7744](https://github.com/nodejs/node/pull/7744) * [[`fe48415c60`](https://github.com/nodejs/node/commit/fe48415c60)] - **net**: add length check when normalizing args (Brian White) [#8112](https://github.com/nodejs/node/pull/8112) * [[`3906206ecc`](https://github.com/nodejs/node/commit/3906206ecc)] - **net**: remove unnecessary variables (Brian White) [#8112](https://github.com/nodejs/node/pull/8112) * [[`9f1b790f79`](https://github.com/nodejs/node/commit/9f1b790f79)] - **net**: make holding the buffer in memory more robust (Anna Henningsen) [#8252](https://github.com/nodejs/node/pull/8252) * [[`b630be2309`](https://github.com/nodejs/node/commit/b630be2309)] - **net**: export isIPv4, isIPv6 directly from cares (Sakthipriyan Vairamani) [#7481](https://github.com/nodejs/node/pull/7481) * [[`c235708bef`](https://github.com/nodejs/node/commit/c235708bef)] - **readline**: keypress trigger for escape character (Prince J Wesley) [#7382](https://github.com/nodejs/node/pull/7382) * [[`8198dbc5a4`](https://github.com/nodejs/node/commit/8198dbc5a4)] - **repl**: Enable tab completion for global properties (Lance Ball) [#7369](https://github.com/nodejs/node/pull/7369) * [[`12300626d7`](https://github.com/nodejs/node/commit/12300626d7)] - **src**: no abort from getter if object isn't wrapped (Trevor Norris) [#6184](https://github.com/nodejs/node/pull/6184) * [[`166a9b85d9`](https://github.com/nodejs/node/commit/166a9b85d9)] - **src**: always clear wrap before persistent Reset() (Trevor Norris) [#6184](https://github.com/nodejs/node/pull/6184) * [[`b3149cee8c`](https://github.com/nodejs/node/commit/b3149cee8c)] - **src**: inherit first from AsyncWrap (Trevor Norris) [#6184](https://github.com/nodejs/node/pull/6184) * [[`8b93fddd1b`](https://github.com/nodejs/node/commit/8b93fddd1b)] - **src**: disable stdio buffering (Ben Noordhuis) [#7610](https://github.com/nodejs/node/pull/7610) * [[`72be320962`](https://github.com/nodejs/node/commit/72be320962)] - **src**: suppress coverity message (cjihrig) [#7587](https://github.com/nodejs/node/pull/7587) * [[`6ba3ad5d34`](https://github.com/nodejs/node/commit/6ba3ad5d34)] - **src**: guard against overflow in ParseArrayIndex() (Ben Noordhuis) [#7497](https://github.com/nodejs/node/pull/7497) * [[`e1f961d050`](https://github.com/nodejs/node/commit/e1f961d050)] - **src**: move ParseArrayIndex() to src/node_buffer.cc (Ben Noordhuis) [#7497](https://github.com/nodejs/node/pull/7497) * [[`57921ebec5`](https://github.com/nodejs/node/commit/57921ebec5)] - **src**: remove unnecessary HandleScopes (Ben Noordhuis) [#7711](https://github.com/nodejs/node/pull/7711) * [[`6838ad5f8e`](https://github.com/nodejs/node/commit/6838ad5f8e)] - **src**: fix handle leak in UDPWrap::Instantiate() (Ben Noordhuis) [#7711](https://github.com/nodejs/node/pull/7711) * [[`dadcf6b263`](https://github.com/nodejs/node/commit/dadcf6b263)] - **src**: fix handle leak in BuildStatsObject() (Ben Noordhuis) [#7711](https://github.com/nodejs/node/pull/7711) * [[`7aa268922a`](https://github.com/nodejs/node/commit/7aa268922a)] - **src**: fix handle leak in Buffer::New() (Ben Noordhuis) [#7711](https://github.com/nodejs/node/pull/7711) * [[`606deecd16`](https://github.com/nodejs/node/commit/606deecd16)] - **src**: don't include a null character in the WriteConsoleW call (Nikolai Vavilov) [#7764](https://github.com/nodejs/node/pull/7764) * [[`a5b6c2cdd7`](https://github.com/nodejs/node/commit/a5b6c2cdd7)] - **src**: use RAII for mutexes and condition variables (Ben Noordhuis) [#7334](https://github.com/nodejs/node/pull/7334) * [[`19d6f06058`](https://github.com/nodejs/node/commit/19d6f06058)] - **stream_base**: always use Base template class (Trevor Norris) [#6184](https://github.com/nodejs/node/pull/6184) * [[`d5f03db819`](https://github.com/nodejs/node/commit/d5f03db819)] - **test**: fix test-cluster-dgram-1 flakiness (Santiago Gimeno) * [[`a83bbaa5a3`](https://github.com/nodejs/node/commit/a83bbaa5a3)] - **test**: refactor test-tick-processor (Rich Trott) [#8180](https://github.com/nodejs/node/pull/8180) * [[`1c81c078c2`](https://github.com/nodejs/node/commit/1c81c078c2)] - **test**: add assert.notDeepStrictEqual() tests (Rich Trott) [#8177](https://github.com/nodejs/node/pull/8177) * [[`57c98f18a9`](https://github.com/nodejs/node/commit/57c98f18a9)] - **test**: favor `===` over `==` in crypto tests (Rich Trott) [#8176](https://github.com/nodejs/node/pull/8176) * [[`11f761ab1a`](https://github.com/nodejs/node/commit/11f761ab1a)] - **test**: refactor pummel/test-dtrace-jsstack (Rich Trott) [#8175](https://github.com/nodejs/node/pull/8175) * [[`2997b79fcc`](https://github.com/nodejs/node/commit/2997b79fcc)] - **test**: favor strict equality in test-exec (Rich Trott) [#8173](https://github.com/nodejs/node/pull/8173) * [[`558f7d999c`](https://github.com/nodejs/node/commit/558f7d999c)] - **test**: add assert.notDeepEqual() tests (Rich Trott) [#8156](https://github.com/nodejs/node/pull/8156) * [[`49c488625d`](https://github.com/nodejs/node/commit/49c488625d)] - **test**: add missing assert.deepEqual() test case (Rich Trott) [#8152](https://github.com/nodejs/node/pull/8152) * [[`eec078cd66`](https://github.com/nodejs/node/commit/eec078cd66)] - **test**: favor strict equality in http tests (Rich Trott) [#8151](https://github.com/nodejs/node/pull/8151) * [[`e3669f8c21`](https://github.com/nodejs/node/commit/e3669f8c21)] - **test**: favor strict equality in pummel net tests (Rich Trott) [#8135](https://github.com/nodejs/node/pull/8135) * [[`ac83d199fb`](https://github.com/nodejs/node/commit/ac83d199fb)] - **test**: confirm that assert truncates long values (Rich Trott) [#8134](https://github.com/nodejs/node/pull/8134) * [[`9c826beef7`](https://github.com/nodejs/node/commit/9c826beef7)] - **test**: favor `===` over `==` in test-timers.js (Rich Trott) [#8131](https://github.com/nodejs/node/pull/8131) * [[`af02d2a642`](https://github.com/nodejs/node/commit/af02d2a642)] - **test**: favor strict equality check (Rich Trott) [#8130](https://github.com/nodejs/node/pull/8130) * [[`30034048b0`](https://github.com/nodejs/node/commit/30034048b0)] - **test**: fix assertion in test-watch-file.js (Rich Trott) [#8129](https://github.com/nodejs/node/pull/8129) * [[`b063dc90b1`](https://github.com/nodejs/node/commit/b063dc90b1)] - **test**: use strict equality in regression test (Rich Trott) [#8098](https://github.com/nodejs/node/pull/8098) * [[`dc7bc2e679`](https://github.com/nodejs/node/commit/dc7bc2e679)] - **test**: add test for debug usage message (Rich Trott) [#8061](https://github.com/nodejs/node/pull/8061) * [[`ce2cfbdc3a`](https://github.com/nodejs/node/commit/ce2cfbdc3a)] - **test**: console constructor missing new keyword (Rich Trott) [#8003](https://github.com/nodejs/node/pull/8003) * [[`69f4edd368`](https://github.com/nodejs/node/commit/69f4edd368)] - **test**: speed up test-net-reconnect-error (Rich Trott) [#7886](https://github.com/nodejs/node/pull/7886) * [[`50acf72d80`](https://github.com/nodejs/node/commit/50acf72d80)] - **test**: increase RAM requirement for intensive tests (Rich Trott) [#7772](https://github.com/nodejs/node/pull/7772) * [[`924ea0a2bd`](https://github.com/nodejs/node/commit/924ea0a2bd)] - **test**: fix flaky test-http-server-consumed-timeout (Rich Trott) [#7717](https://github.com/nodejs/node/pull/7717) * [[`97a3d89c80`](https://github.com/nodejs/node/commit/97a3d89c80)] - **test**: improve coverage of the util module (Michaël Zasso) [#8633](https://github.com/nodejs/node/pull/8633) * [[`52bb37734b`](https://github.com/nodejs/node/commit/52bb37734b)] - **test**: mark test-child-process-fork-dgram as flaky (Michael Dawson) [#8274](https://github.com/nodejs/node/pull/8274) * [[`97c68ddaad`](https://github.com/nodejs/node/commit/97c68ddaad)] - **test**: improve error message in test-tick-processor (Rich Trott) [#7693](https://github.com/nodejs/node/pull/7693) * [[`cd9e8e0361`](https://github.com/nodejs/node/commit/cd9e8e0361)] - **test**: fix old tty tests (Jeremiah Senkpiel) [#7613](https://github.com/nodejs/node/pull/7613) * [[`22990d8851`](https://github.com/nodejs/node/commit/22990d8851)] - **test**: move parallel/test-tty-* to pseudo-tty/ (Jeremiah Senkpiel) [#7613](https://github.com/nodejs/node/pull/7613) * [[`afee32fed5`](https://github.com/nodejs/node/commit/afee32fed5)] - **test**: fix `fs-watch-recursive` flakiness on OS X (Santiago Gimeno) [#4629](https://github.com/nodejs/node/pull/4629) * [[`c543f4a879`](https://github.com/nodejs/node/commit/c543f4a879)] - **test**: stream writable ended state (Italo A. Casas) [#8778](https://github.com/nodejs/node/pull/8778) * [[`f46a04cc6d`](https://github.com/nodejs/node/commit/f46a04cc6d)] - **test**: add tests for add/remove header after sent (Niklas Ingholt) [#8682](https://github.com/nodejs/node/pull/8682) * [[`e79351c3ac`](https://github.com/nodejs/node/commit/e79351c3ac)] - **test**: improve test-https-agent.js (Dan.Williams) [#8517](https://github.com/nodejs/node/pull/8517) * [[`9ffb2f3c0d`](https://github.com/nodejs/node/commit/9ffb2f3c0d)] - **test**: add coverage for client._addHandle() (Rich Trott) [#8518](https://github.com/nodejs/node/pull/8518) * [[`8da2dcb70a`](https://github.com/nodejs/node/commit/8da2dcb70a)] - **test**: refector parallel/test-http.js (Junshu Okamoto) [#8471](https://github.com/nodejs/node/pull/8471) * [[`69404ec473`](https://github.com/nodejs/node/commit/69404ec473)] - **test**: fix flaky test-force-repl (Rich Trott) [#8484](https://github.com/nodejs/node/pull/8484) * [[`5a07bb62ea`](https://github.com/nodejs/node/commit/5a07bb62ea)] - **test**: swapped == and equal to === and strictEqual (Christopher Dunavan) [#8472](https://github.com/nodejs/node/pull/8472) * [[`ad1230e731`](https://github.com/nodejs/node/commit/ad1230e731)] - **test**: skip pseudo-tty/no_dropped_stdio test (Michael Dawson) [#8470](https://github.com/nodejs/node/pull/8470) * [[`6d03170751`](https://github.com/nodejs/node/commit/6d03170751)] - **test**: clean up net server try ports test (Thomas Hunter II) [#8458](https://github.com/nodejs/node/pull/8458) * [[`775c84ec38`](https://github.com/nodejs/node/commit/775c84ec38)] - **test**: add test-debug-protocol-execute (Rich Trott) [#8454](https://github.com/nodejs/node/pull/8454) * [[`0d1082426a`](https://github.com/nodejs/node/commit/0d1082426a)] - **test**: mark pseudo-tty/no_dropped_stdio as flaky (Michael Dawson) [#8385](https://github.com/nodejs/node/pull/8385) * [[`c034c861bb`](https://github.com/nodejs/node/commit/c034c861bb)] - **test**: test non-buffer/string with zlib (Rich Trott) [#8350](https://github.com/nodejs/node/pull/8350) * [[`bb8690433c`](https://github.com/nodejs/node/commit/bb8690433c)] - **test**: fix ::1 error in test-dns-ipv6 (Gibson Fahnestock) [#8254](https://github.com/nodejs/node/pull/8254) * [[`2f458ea663`](https://github.com/nodejs/node/commit/2f458ea663)] - **test**: add test for zlib.create*Raw() (Rich Trott) [#8306](https://github.com/nodejs/node/pull/8306) * [[`a368ea673c`](https://github.com/nodejs/node/commit/a368ea673c)] - **test**: refactor test-debug-signal-cluster (Rich Trott) [#8289](https://github.com/nodejs/node/pull/8289) * [[`a48469f098`](https://github.com/nodejs/node/commit/a48469f098)] - **test**: add check in test-signal-handler (Rich Trott) [#8248](https://github.com/nodejs/node/pull/8248) * [[`cadb2612c6`](https://github.com/nodejs/node/commit/cadb2612c6)] - **test**: add test for attempted multiple IPC channels (cjihrig) [#8159](https://github.com/nodejs/node/pull/8159) * [[`21c1b8467e`](https://github.com/nodejs/node/commit/21c1b8467e)] - **test**: decrease inconsistency in the common.js (Vse Mozhet Byt) [#7758](https://github.com/nodejs/node/pull/7758) * [[`d40873ddcd`](https://github.com/nodejs/node/commit/d40873ddcd)] - **test**: ensure stream preprocessing order (Vse Mozhet Byt) [#7741](https://github.com/nodejs/node/pull/7741) * [[`0e1f098b09`](https://github.com/nodejs/node/commit/0e1f098b09)] - **test**: avoid usage of mixed IPV6 addresses (Gireesh Punathil) [#7702](https://github.com/nodejs/node/pull/7702) * [[`741373cb49`](https://github.com/nodejs/node/commit/741373cb49)] - **test**: clean up test-buffer-badhex (Jeremiah Senkpiel) [#7773](https://github.com/nodejs/node/pull/7773) * [[`58f3fa17eb`](https://github.com/nodejs/node/commit/58f3fa17eb)] - **test**: s/assert.fail/common.fail as appropriate (cjihrig) [#7735](https://github.com/nodejs/node/pull/7735) * [[`b0e2f9a37a`](https://github.com/nodejs/node/commit/b0e2f9a37a)] - **test**: add common.rootDir (cjihrig) [#7685](https://github.com/nodejs/node/pull/7685) * [[`c94f3a5784`](https://github.com/nodejs/node/commit/c94f3a5784)] - **test**: handle IPv6 localhost issues within tests (Rich Trott) [#7766](https://github.com/nodejs/node/pull/7766) * [[`b64828d8df`](https://github.com/nodejs/node/commit/b64828d8df)] - **test**: accept expected AIX result test-stdio-closed (Rich Trott) [#8755](https://github.com/nodejs/node/pull/8755) * [[`3dbcc3d2d9`](https://github.com/nodejs/node/commit/3dbcc3d2d9)] - **test**: fix flaky test-*-connect-address-family (Rich Trott) [#7605](https://github.com/nodejs/node/pull/7605) * [[`733233d3ea`](https://github.com/nodejs/node/commit/733233d3ea)] - **test**: add uncaught exception test for debugger (Rich Trott) [#8087](https://github.com/nodejs/node/pull/8087) * [[`c9af24d2a7`](https://github.com/nodejs/node/commit/c9af24d2a7)] - **test**: add test for assert.notStrictEqual() (Rich Trott) [#8091](https://github.com/nodejs/node/pull/8091) * [[`337d2dd381`](https://github.com/nodejs/node/commit/337d2dd381)] - **test**: implement consistent braces (Rich Trott) [#8348](https://github.com/nodejs/node/pull/8348) * [[`77df523264`](https://github.com/nodejs/node/commit/77df523264)] - **test**: exclude tests for AIX (Michael Dawson) [#8076](https://github.com/nodejs/node/pull/8076) * [[`50ae37e350`](https://github.com/nodejs/node/commit/50ae37e350)] - **test**: add --repeat option to tools/test.py (Michael Dawson) [#6700](https://github.com/nodejs/node/pull/6700) * [[`ea72e9f143`](https://github.com/nodejs/node/commit/ea72e9f143)] - **test,doc**: clarify `buf.indexOf(num)` input range (Anna Henningsen) [#7611](https://github.com/nodejs/node/pull/7611) * [[`c841b5a6b9`](https://github.com/nodejs/node/commit/c841b5a6b9)] - **tls**: copy the Buffer object before using (Sakthipriyan Vairamani) [#8055](https://github.com/nodejs/node/pull/8055) * [[`6076293d6c`](https://github.com/nodejs/node/commit/6076293d6c)] - **tls_wrap**: do not abort on new TLSWrap() (Trevor Norris) [#6184](https://github.com/nodejs/node/pull/6184) * [[`6e5906c7f1`](https://github.com/nodejs/node/commit/6e5906c7f1)] - **tools**: use long format for gpg fingerprint (Myles Borins) [#9258](https://github.com/nodejs/node/pull/9258) * [[`7409c332b8`](https://github.com/nodejs/node/commit/7409c332b8)] - **tools**: check tag is on github before release (Rod Vagg) [#9142](https://github.com/nodejs/node/pull/9142) * [[`b632badda2`](https://github.com/nodejs/node/commit/b632badda2)] - **tools**: make detached SHASUM .sig file for releases (Rod Vagg) [#9071](https://github.com/nodejs/node/pull/9071) * [[`5867ffe27e`](https://github.com/nodejs/node/commit/5867ffe27e)] - **tools**: explicitly set digest algo for SHASUM to 256 (Rod Vagg) [#9071](https://github.com/nodejs/node/pull/9071) * [[`bdfa3b388b`](https://github.com/nodejs/node/commit/bdfa3b388b)] - **tools**: favor === over == in license2rtf.js (Rich Trott) * [[`d7e3edc744`](https://github.com/nodejs/node/commit/d7e3edc744)] - **tools**: add remark-lint configuration in .remarkrc (Сковорода Никита Андреевич) [#7729](https://github.com/nodejs/node/pull/7729) * [[`afbfbc04c9`](https://github.com/nodejs/node/commit/afbfbc04c9)] - **tools**: add .vscode folder to .gitignore (Josh Gavant) [#7967](https://github.com/nodejs/node/pull/7967) * [[`3f4a5fe61e`](https://github.com/nodejs/node/commit/3f4a5fe61e)] - **tools**: increase lint coverage (Rich Trott) [#7647](https://github.com/nodejs/node/pull/7647) * [[`d1a50b3ed2`](https://github.com/nodejs/node/commit/d1a50b3ed2)] - **tools**: enforce JS brace style with linting (Rich Trott) [#8348](https://github.com/nodejs/node/pull/8348) * [[`76b8d81f38`](https://github.com/nodejs/node/commit/76b8d81f38)] - **tools,test**: show signal code when test crashes (Santiago Gimeno) [#7859](https://github.com/nodejs/node/pull/7859) * [[`389a6d2cc2`](https://github.com/nodejs/node/commit/389a6d2cc2)] - **url**: fix off-by-one error in loop handling dots (Luigi Pinca) [#8420](https://github.com/nodejs/node/pull/8420) * [[`be9d9bd7c3`](https://github.com/nodejs/node/commit/be9d9bd7c3)] - **url**: fix inconsistent port in url.resolveObject (Ilkka Myller) [#8214](https://github.com/nodejs/node/pull/8214) * [[`96cfa926bd`](https://github.com/nodejs/node/commit/96cfa926bd)] - **url**: `url.format()` encodes all `#` in `search` (Ilkka Myller) [#8072](https://github.com/nodejs/node/pull/8072) * [[`f7796f23e3`](https://github.com/nodejs/node/commit/f7796f23e3)] - **util**: inspect boxed symbols like other primitives (Anna Henningsen) [#7641](https://github.com/nodejs/node/pull/7641) * [[`410e083d7c`](https://github.com/nodejs/node/commit/410e083d7c)] - **win,build**: forward release_urlbase to configure (João Reis) [#8430](https://github.com/nodejs/node/pull/8430) * [[`26e73740e9`](https://github.com/nodejs/node/commit/26e73740e9)] - **win,build**: exit when addons fail to build (João Reis) [#8412](https://github.com/nodejs/node/pull/8412) * [[`30e751f38b`](https://github.com/nodejs/node/commit/30e751f38b)] - **win,build**: skip finding VS when not needed (João Reis) [#8412](https://github.com/nodejs/node/pull/8412) * [[`b3090f8e64`](https://github.com/nodejs/node/commit/b3090f8e64)] - **win,build**: fail on invalid option in vcbuild (João Reis) [#8412](https://github.com/nodejs/node/pull/8412) * [[`1b5213bfc3`](https://github.com/nodejs/node/commit/1b5213bfc3)] - **win,msi**: fix inclusion of translations (João Reis) [#7798](https://github.com/nodejs/node/pull/7798) * [[`e8be413d0d`](https://github.com/nodejs/node/commit/e8be413d0d)] - **win,msi**: add zh-CN translations for the installer (Minqi Pan) [#2569](https://github.com/nodejs/node/pull/2569) * [[`99f85b8340`](https://github.com/nodejs/node/commit/99f85b8340)] - **win,msi**: Added Italian translation (Matteo Collina) [#4647](https://github.com/nodejs/node/pull/4647) ## 2016-10-18, Version 4.6.1 'Argon' (LTS), @rvagg This is a security release. All Node.js users should consult the security release summary at https://nodejs.org/en/blog/vulnerability/october-2016-security-releases/ for details on patched vulnerabilities. ### Notable Changes * **c-ares**: fix for single-byte buffer overwrite, CVE-2016-5180, more information at https://c-ares.haxx.se/adv_20160929.html (Daniel Stenberg) ### Commits * [[`f3c63e7ccf`](https://github.com/nodejs/node/commit/f3c63e7ccf)] - **deps**: avoid single-byte buffer overwrite (Daniel Stenberg) [#8849](https://github.com/nodejs/node/pull/8849) * [[`5a0daa6c2f`](https://github.com/nodejs/node/commit/5a0daa6c2f)] - **win,build**: try multiple timeservers when signing (Rod Vagg) [#9155](https://github.com/nodejs/node/pull/9155) ## 2016-09-27, Version 4.6.0 'Argon' (LTS), @rvagg This is a security release. All Node.js users should consult the security release summary at https://nodejs.org/en/blog/vulnerability/september-2016-security-releases/ for details on patched vulnerabilities. ### Notable Changes Semver Minor: * **openssl**: - Upgrade to 1.0.2i, fixes a number of defects impacting Node.js: CVE-2016-6304 ("OCSP Status Request extension unbounded memory growth", high severity), CVE-2016-2183, CVE-2016-6303, CVE-2016-2178 and CVE-2016-6306. (Shigeki Ohtsu) [#8714](https://github.com/nodejs/node/pull/8714) - Upgrade to 1.0.2j, fixes a defect included in 1.0.2i resulting in a crash when using CRLs, CVE-2016-7052. (Shigeki Ohtsu) [#8786](https://github.com/nodejs/node/pull/8786) - Remove support for loading dynamic third-party engine modules. An attacker may be able to hide malicious code to be inserted into Node.js at runtime by masquerading as one of the dynamic engine modules. Originally reported by Ahmed Zaki (Skype). (Ben Noordhuis) [nodejs/node-private#70](https://github.com/nodejs/node-private/pull/70) * **http**: CVE-2016-5325 - Properly validate for allowable characters in the `reason` argument in `ServerResponse#writeHead()`. Fixes a possible response splitting attack vector. This introduces a new case where `throw` may occur when configuring HTTP responses, users should already be adopting try/catch here. Originally reported independently by Evan Lucas and Romain Gaucher. (Evan Lucas) [nodejs/node-private#46](https://github.com/nodejs/node-private/pull/46) Semver Patch: * **buffer**: Zero-fill excess bytes in new `Buffer` objects created with `Buffer.concat()` while providing a `totalLength` parameter that exceeds the total length of the original `Buffer` objects being concatenated. (Сковорода Никита Андреевич) [nodejs/node-private#65](https://github.com/nodejs/node-private/pull/65) * **tls**: CVE-2016-7099 - Fix invalid wildcard certificate validation check whereby a TLS server may be able to serve an invalid wildcard certificate for its hostname due to improper validation of `*.` in the wildcard string. Originally reported by Alexander Minozhenko and James Bunton (Atlassian). (Ben Noordhuis) [nodejs/node-private#63](https://github.com/nodejs/node-private/pull/63) ### Commits * [[`93b10fbec2`](https://github.com/nodejs/node/commit/93b10fbec2)] - **buffer**: zero-fill uninitialized bytes in .concat() (Сковорода Никита Андреевич) [nodejs/node-private#65](https://github.com/nodejs/node-private/pull/65) * [[`c214e8847d`](https://github.com/nodejs/node/commit/c214e8847d)] - **crypto**: don't build hardware engines (Ben Noordhuis) [nodejs/node-private#70](https://github.com/nodejs/node-private/pull/70) * [[`af9dda152c`](https://github.com/nodejs/node/commit/af9dda152c)] - **deps**: add -no_rand_screen to openssl s_client (Shigeki Ohtsu) [nodejs/node#1836](https://github.com/nodejs/node/pull/1836) * [[`6bb9749c33`](https://github.com/nodejs/node/commit/6bb9749c33)] - **deps**: fix asm build error of openssl in x86_win32 (Shigeki Ohtsu) [nodejs/node#1389](https://github.com/nodejs/node/pull/1389) * [[`5176a8ad57`](https://github.com/nodejs/node/commit/5176a8ad57)] - **deps**: fix openssl assembly error on ia32 win32 (Fedor Indutny) [nodejs/node#1389](https://github.com/nodejs/node/pull/1389) * [[`aa9ed60a51`](https://github.com/nodejs/node/commit/aa9ed60a51)] - **deps**: copy all openssl header files to include dir (Shigeki Ohtsu) [#8786](https://github.com/nodejs/node/pull/8786) * [[`0c74e2ad35`](https://github.com/nodejs/node/commit/0c74e2ad35)] - **deps**: upgrade openssl sources to 1.0.2j (Shigeki Ohtsu) [#8786](https://github.com/nodejs/node/pull/8786) * [[`8f3d6760cf`](https://github.com/nodejs/node/commit/8f3d6760cf)] - **deps**: update openssl asm and asm_obsolete files (Shigeki Ohtsu) [#8714](https://github.com/nodejs/node/pull/8714) * [[`e8f29e2ba8`](https://github.com/nodejs/node/commit/e8f29e2ba8)] - **deps**: add -no_rand_screen to openssl s_client (Shigeki Ohtsu) [nodejs/node#1836](https://github.com/nodejs/node/pull/1836) * [[`01cf5b0ae7`](https://github.com/nodejs/node/commit/01cf5b0ae7)] - **deps**: fix asm build error of openssl in x86_win32 (Shigeki Ohtsu) [nodejs/node#1389](https://github.com/nodejs/node/pull/1389) * [[`19ae4e8ae1`](https://github.com/nodejs/node/commit/19ae4e8ae1)] - **deps**: fix openssl assembly error on ia32 win32 (Fedor Indutny) [nodejs/node#1389](https://github.com/nodejs/node/pull/1389) * [[`cbed5e64be`](https://github.com/nodejs/node/commit/cbed5e64be)] - **deps**: copy all openssl header files to include dir (Shigeki Ohtsu) [#8714](https://github.com/nodejs/node/pull/8714) * [[`e7fdace18f`](https://github.com/nodejs/node/commit/e7fdace18f)] - **deps**: upgrade openssl sources to 1.0.2i (Shigeki Ohtsu) [#8714](https://github.com/nodejs/node/pull/8714) * [[`b5c57ff772`](https://github.com/nodejs/node/commit/b5c57ff772)] - **http**: check reason chars in writeHead (Evan Lucas) [nodejs/node-private#46](https://github.com/nodejs/node-private/pull/46) * [[`3ff82deb2c`](https://github.com/nodejs/node/commit/3ff82deb2c)] - **lib**: make tls.checkServerIdentity() more strict (Ben Noordhuis) [nodejs/node-private#63](https://github.com/nodejs/node-private/pull/63) * [[`7c696e201a`](https://github.com/nodejs/node/commit/7c696e201a)] - **openssl**: fix keypress requirement in apps on win32 (Shigeki Ohtsu) [nodejs/node#1389](https://github.com/nodejs/node/pull/1389) * [[`44e5776c0f`](https://github.com/nodejs/node/commit/44e5776c0f)] - **openssl**: fix keypress requirement in apps on win32 (Shigeki Ohtsu) [nodejs/node#1389](https://github.com/nodejs/node/pull/1389) * [[`c7a601c090`](https://github.com/nodejs/node/commit/c7a601c090)] - **test**: remove openssl options of -no_ (Shigeki Ohtsu) [#8714](https://github.com/nodejs/node/pull/8714) ## 2016-08-15, Version 4.5.0 'Argon' (LTS), @thealphanerd ### Notable Changes Semver Minor: * **buffer**: * backport new buffer constructor APIs to v4.x (Сковорода Никита Андреевич) [#7562](https://github.com/nodejs/node/pull/7562) * backport --zero-fill-buffers cli option (James M Snell) [#5745](https://github.com/nodejs/node/pull/5745) * **build**: * add Intel Vtune profiling support (Chunyang Dai) [#5527](https://github.com/nodejs/node/pull/5527) * **repl**: * copying tabs shouldn't trigger completion (Eugene Obrezkov) [#5958](https://github.com/nodejs/node/pull/5958) * **src**: * add node::FreeEnvironment public API (Cheng Zhao) [#3098](https://github.com/nodejs/node/pull/3098) * **test**: * run v8 tests from node tree (Bryon Leung) [#4704](https://github.com/nodejs/node/pull/4704) * **V8**: * Add post mortem data to improve object inspection and function's context variables inspection (Fedor Indutny) [#3779](https://github.com/nodejs/node/pull/3779) Semver Patch: * **buffer**: * ignore negative allocation lengths (Anna Henningsen) [#7562](https://github.com/nodejs/node/pull/7562) * **crypto**: * update root certificates (Ben Noordhuis) [#7363](https://github.com/nodejs/node/pull/7363) * **libuv**: * upgrade libuv to 1.9.1 (Saúl Ibarra Corretgé) [#6796](https://github.com/nodejs/node/pull/6796) * upgrade libuv to 1.9.0 (Saúl Ibarra Corretgé) [#5994](https://github.com/nodejs/node/pull/5994) * **npm**: * upgrade to 2.15.9 (Kat Marchán) [#7692](https://github.com/nodejs/node/pull/7692) ### Commits * [[`a4888926a2`](https://github.com/nodejs/node/commit/a4888926a2)] - **assert**: remove unneeded arguments special handling (Rich Trott) [#7413](https://github.com/nodejs/node/pull/7413) * [[`39e24742f8`](https://github.com/nodejs/node/commit/39e24742f8)] - **assert**: allow circular references (Rich Trott) [#6432](https://github.com/nodejs/node/pull/6432) * [[`271927f29e`](https://github.com/nodejs/node/commit/271927f29e)] - **async_wrap**: pass uid to JS as double (Trevor Norris) [#7096](https://github.com/nodejs/node/pull/7096) * [[`747f107188`](https://github.com/nodejs/node/commit/747f107188)] - **async_wrap**: don't abort on callback exception (Trevor Norris) [#5756](https://github.com/nodejs/node/pull/5756) * [[`c06e2b07b6`](https://github.com/nodejs/node/commit/c06e2b07b6)] - **async_wrap**: notify post if intercepted exception (Trevor Norris) [#5756](https://github.com/nodejs/node/pull/5756) * [[`0642a146b3`](https://github.com/nodejs/node/commit/0642a146b3)] - **async_wrap**: setupHooks now accepts object (Trevor Norris) [#5756](https://github.com/nodejs/node/pull/5756) * [[`75ecf8eb07`](https://github.com/nodejs/node/commit/75ecf8eb07)] - **async_wrap**: add parent uid to init hook (Andreas Madsen) [#4600](https://github.com/nodejs/node/pull/4600) * [[`e10eebffa5`](https://github.com/nodejs/node/commit/e10eebffa5)] - **async_wrap**: make uid the first argument in init (Andreas Madsen) [#4600](https://github.com/nodejs/node/pull/4600) * [[`13d465bcf6`](https://github.com/nodejs/node/commit/13d465bcf6)] - **async_wrap**: add uid to all asyncWrap hooks (Andreas Madsen) [#4600](https://github.com/nodejs/node/pull/4600) * [[`046d651118`](https://github.com/nodejs/node/commit/046d651118)] - **benchmark**: fix child-process-exec-stdout on win (Bartosz Sosnowski) [#7178](https://github.com/nodejs/node/pull/7178) * [[`4b464ce4bf`](https://github.com/nodejs/node/commit/4b464ce4bf)] - **benchmark**: remove unused variables (Rich Trott) [#7600](https://github.com/nodejs/node/pull/7600) * [[`b95e5d7948`](https://github.com/nodejs/node/commit/b95e5d7948)] - **benchmark**: add benchmark for url.format() (Rich Trott) [#7250](https://github.com/nodejs/node/pull/7250) * [[`1bd62c7c34`](https://github.com/nodejs/node/commit/1bd62c7c34)] - **benchmark**: add benchmark for Buffer.concat (Anna Henningsen) [#7054](https://github.com/nodejs/node/pull/7054) * [[`08cd81b050`](https://github.com/nodejs/node/commit/08cd81b050)] - **benchmark**: add util.format benchmark (Evan Lucas) [#5360](https://github.com/nodejs/node/pull/5360) * [[`7dbb0d0084`](https://github.com/nodejs/node/commit/7dbb0d0084)] - **buffer**: fix dataview-set benchmark (Ingvar Stepanyan) [#6922](https://github.com/nodejs/node/pull/6922) * [[`200429e9e1`](https://github.com/nodejs/node/commit/200429e9e1)] - **buffer**: ignore negative allocation lengths (Anna Henningsen) [#7562](https://github.com/nodejs/node/pull/7562) * [[`709048134c`](https://github.com/nodejs/node/commit/709048134c)] - **(SEMVER-MINOR)** **buffer**: backport new buffer constructor APIs to v4.x (Сковорода Никита Андреевич) [#7562](https://github.com/nodejs/node/pull/7562) * [[`fb03e57de2`](https://github.com/nodejs/node/commit/fb03e57de2)] - **(SEMVER-MINOR)** **buffer**: backport --zero-fill-buffers cli option (James M Snell) [#5745](https://github.com/nodejs/node/pull/5745) * [[`236491e698`](https://github.com/nodejs/node/commit/236491e698)] - **build**: update build-addons when node-gyp changes (Lance Ball) [#6787](https://github.com/nodejs/node/pull/6787) * [[`8a7c5fdbd2`](https://github.com/nodejs/node/commit/8a7c5fdbd2)] - **build**: add REPLACEME tag for version info in docs (Ben Noordhuis) [#6864](https://github.com/nodejs/node/pull/6864) * [[`da1e13fde7`](https://github.com/nodejs/node/commit/da1e13fde7)] - **build**: add Make `doc-only` target (Jesse McCarthy) [#3888](https://github.com/nodejs/node/pull/3888) * [[`0db3aa9afa`](https://github.com/nodejs/node/commit/0db3aa9afa)] - **build**: remove unused files from CPPLINT_FILES (Ben Noordhuis) [#7462](https://github.com/nodejs/node/pull/7462) * [[`5290c9d38c`](https://github.com/nodejs/node/commit/5290c9d38c)] - **build**: use BUILDTYPE when building V8 in Makefile (Michaël Zasso) [#7482](https://github.com/nodejs/node/pull/7482) * [[`79bd39c202`](https://github.com/nodejs/node/commit/79bd39c202)] - **build**: add v8 requirement to test-v8* in Makefile (Michaël Zasso) [#7482](https://github.com/nodejs/node/pull/7482) * [[`65b75b51a6`](https://github.com/nodejs/node/commit/65b75b51a6)] - **build**: unbreak configure with python 2.6 (Ben Noordhuis) [#6874](https://github.com/nodejs/node/pull/6874) * [[`8513232c82`](https://github.com/nodejs/node/commit/8513232c82)] - **build**: split CI rules in Makefile (João Reis) [#7317](https://github.com/nodejs/node/pull/7317) * [[`13d0e463b0`](https://github.com/nodejs/node/commit/13d0e463b0)] - **build**: enable compilation for linuxOne (Michael Dawson) [#5941](https://github.com/nodejs/node/pull/5941) * [[`834ea2c5c0`](https://github.com/nodejs/node/commit/834ea2c5c0)] - **(SEMVER-MINOR)** **build,src**: add Intel Vtune profiling support (Chunyang Dai) [#5527](https://github.com/nodejs/node/pull/5527) * [[`ea20796e9d`](https://github.com/nodejs/node/commit/ea20796e9d)] - **build,test**: fix build-addons dependency chain (Ben Noordhuis) [#6652](https://github.com/nodejs/node/pull/6652) * [[`6a08535dd1`](https://github.com/nodejs/node/commit/6a08535dd1)] - **child_process**: preserve argument type (Rich Trott) [#7391](https://github.com/nodejs/node/pull/7391) * [[`fd05b0b289`](https://github.com/nodejs/node/commit/fd05b0b289)] - ***Revert*** "**child_process**: measure buffer length in bytes" (Rich Trott) [#7391](https://github.com/nodejs/node/pull/7391) * [[`8eb18e4289`](https://github.com/nodejs/node/commit/8eb18e4289)] - **child_process**: measure buffer length in bytes (Rich Trott) [#6764](https://github.com/nodejs/node/pull/6764) * [[`4ee863d956`](https://github.com/nodejs/node/commit/4ee863d956)] - **child_process**: allow buffer encoding in spawnSync (cjihrig) [#6939](https://github.com/nodejs/node/pull/6939) * [[`0b8124f205`](https://github.com/nodejs/node/commit/0b8124f205)] - **child_process**: emit IPC messages on next tick (cjihrig) [#6909](https://github.com/nodejs/node/pull/6909) * [[`20d3378969`](https://github.com/nodejs/node/commit/20d3378969)] - **cluster**: reset handle index on close (Santiago Gimeno) [#6981](https://github.com/nodejs/node/pull/6981) * [[`09349a8b92`](https://github.com/nodejs/node/commit/09349a8b92)] - **cluster**: don't send messages if no IPC channel (Santiago Gimeno) [#7132](https://github.com/nodejs/node/pull/7132) * [[`6ece2a0322`](https://github.com/nodejs/node/commit/6ece2a0322)] - **cluster**: rewrite debug ports consistently (cjihrig) [#7050](https://github.com/nodejs/node/pull/7050) * [[`8cba3b2f72`](https://github.com/nodejs/node/commit/8cba3b2f72)] - **cluster**: guard against undefined message handlers (cjihrig) [#6902](https://github.com/nodejs/node/pull/6902) * [[`f152adf5b7`](https://github.com/nodejs/node/commit/f152adf5b7)] - **cluster**: close ownerless handles on disconnect() (cjihrig) [#6909](https://github.com/nodejs/node/pull/6909) * [[`65624440bf`](https://github.com/nodejs/node/commit/65624440bf)] - **crypto**: allow GCM ciphers to have longer IV length (Michael Wain) [#6376](https://github.com/nodejs/node/pull/6376) * [[`1e0cede3a6`](https://github.com/nodejs/node/commit/1e0cede3a6)] - **crypto**: update root certificates (Ben Noordhuis) [#7363](https://github.com/nodejs/node/pull/7363) * [[`3be5cdcd43`](https://github.com/nodejs/node/commit/3be5cdcd43)] - **debugger**: remove obsolete setTimeout (Rich Trott) [#7154](https://github.com/nodejs/node/pull/7154) * [[`74a5e911c0`](https://github.com/nodejs/node/commit/74a5e911c0)] - **debugger**: propagate --debug-port= to debuggee (Ben Noordhuis) [#3470](https://github.com/nodejs/node/pull/3470) * [[`af4940d63b`](https://github.com/nodejs/node/commit/af4940d63b)] - **deps**: upgrade npm in LTS to 2.15.9 (Kat Marchán) [#7692](https://github.com/nodejs/node/pull/7692) * [[`da7b74b9bc`](https://github.com/nodejs/node/commit/da7b74b9bc)] - **deps**: upgrade libuv to 1.9.1 (Saúl Ibarra Corretgé) [#6796](https://github.com/nodejs/node/pull/6796) * [[`94eb980ca5`](https://github.com/nodejs/node/commit/94eb980ca5)] - **deps**: upgrade libuv to 1.9.0 (Saúl Ibarra Corretgé) [#5994](https://github.com/nodejs/node/pull/5994) * [[`4107b5d200`](https://github.com/nodejs/node/commit/4107b5d200)] - **deps**: backport 22c5e46 from V8 (Julien Gilli) [#7584](https://github.com/nodejs/node/pull/7584) * [[`e06ab64705`](https://github.com/nodejs/node/commit/e06ab64705)] - **deps**: update to http-parser 2.7.0 (Fedor Indutny) [#6279](https://github.com/nodejs/node/pull/6279) * [[`1164f542db`](https://github.com/nodejs/node/commit/1164f542db)] - **deps**: fix segfault during gc (Ali Ijaz Sheikh) [#7303](https://github.com/nodejs/node/pull/7303) * [[`d9e9d9fb11`](https://github.com/nodejs/node/commit/d9e9d9fb11)] - **deps**: backport e7cc609 from upstream V8 (Ali Ijaz Sheikh) [#7303](https://github.com/nodejs/node/pull/7303) * [[`9809992436`](https://github.com/nodejs/node/commit/9809992436)] - **(SEMVER-MINOR)** **deps**: backport 9c927d0f01 from V8 upstream (Myles Borins) [#7451](https://github.com/nodejs/node/pull/7451) * [[`da9595fc47`](https://github.com/nodejs/node/commit/da9595fc47)] - **(SEMVER-MINOR)** **deps**: cherry-pick 68e89fb from v8's upstream (Fedor Indutny) [#3779](https://github.com/nodejs/node/pull/3779) * [[`e9ff0f8fb2`](https://github.com/nodejs/node/commit/e9ff0f8fb2)] - **doc**: make doc-only -> fallback to user binary (Robert Jefe Lindstaedt) [#6906](https://github.com/nodejs/node/pull/6906) * [[`b869cdb876`](https://github.com/nodejs/node/commit/b869cdb876)] - **doc**: fix deprecation warnings in addon examples (Ben Noordhuis) [#6652](https://github.com/nodejs/node/pull/6652) * [[`ec25f38120`](https://github.com/nodejs/node/commit/ec25f38120)] - **doc**: add `added:` information for buffer (Anna Henningsen) [#6495](https://github.com/nodejs/node/pull/6495) * [[`1e86d16812`](https://github.com/nodejs/node/commit/1e86d16812)] - **doc**: buffers are not sent over IPC with a socket (Tim Kuijsten) [#6951](https://github.com/nodejs/node/pull/6951) * [[`5c1d8e1f0f`](https://github.com/nodejs/node/commit/5c1d8e1f0f)] - **doc**: add `added:` information for http (Anna Henningsen) [#7392](https://github.com/nodejs/node/pull/7392) * [[`60c054bc11`](https://github.com/nodejs/node/commit/60c054bc11)] - **doc**: add information for IncomingMessage.destroy() (Rich Trott) [#7237](https://github.com/nodejs/node/pull/7237) * [[`1a5c025f32`](https://github.com/nodejs/node/commit/1a5c025f32)] - **doc**: remove superfluos backticks in process.md (Anna Henningsen) [#7681](https://github.com/nodejs/node/pull/7681) * [[`fcb4e410e4`](https://github.com/nodejs/node/commit/fcb4e410e4)] - **doc**: add `added:` information for process (Bryan English) [#6589](https://github.com/nodejs/node/pull/6589) * [[`9b8565c42a`](https://github.com/nodejs/node/commit/9b8565c42a)] - **doc**: add `added:` information for tls (Italo A. Casas) [#7018](https://github.com/nodejs/node/pull/7018) * [[`fd4aa6c16a`](https://github.com/nodejs/node/commit/fd4aa6c16a)] - **doc**: correct `added:` information for fs.access (Richard Lau) [#7299](https://github.com/nodejs/node/pull/7299) * [[`1e9d27cbcc`](https://github.com/nodejs/node/commit/1e9d27cbcc)] - **doc**: add `added:` information for fs (Anna Henningsen) [#6717](https://github.com/nodejs/node/pull/6717) * [[`2244a3c250`](https://github.com/nodejs/node/commit/2244a3c250)] - **doc**: adds 'close' events to fs.ReadStream and fs.WriteStream (Jenna Vuong) [#6499](https://github.com/nodejs/node/pull/6499) * [[`88f46b886a`](https://github.com/nodejs/node/commit/88f46b886a)] - **doc**: add `added:` information for timers (Anna Henningsen) [#7493](https://github.com/nodejs/node/pull/7493) * [[`a53253a232`](https://github.com/nodejs/node/commit/a53253a232)] - **doc**: add `added:` information for zlib (Anna Henningsen) [#6840](https://github.com/nodejs/node/pull/6840) * [[`7abfb6e8dc`](https://github.com/nodejs/node/commit/7abfb6e8dc)] - **doc**: add `added:` information for vm (Anna Henningsen) [#7011](https://github.com/nodejs/node/pull/7011) * [[`3e3471fb5f`](https://github.com/nodejs/node/commit/3e3471fb5f)] - **doc**: add `added:` information for v8 (Rich Trott) [#6684](https://github.com/nodejs/node/pull/6684) * [[`1758f02ec1`](https://github.com/nodejs/node/commit/1758f02ec1)] - **doc**: add `added:` information for url (Bryan English) [#6593](https://github.com/nodejs/node/pull/6593) * [[`3c8f19fcdf`](https://github.com/nodejs/node/commit/3c8f19fcdf)] - **doc**: add `added:` in for `tty` (Rich Trott) [#6783](https://github.com/nodejs/node/pull/6783) * [[`5b50b1c255`](https://github.com/nodejs/node/commit/5b50b1c255)] - **doc**: add `added:` info for `string_decoder` (Rich Trott) [#6741](https://github.com/nodejs/node/pull/6741) * [[`4474e83b78`](https://github.com/nodejs/node/commit/4474e83b78)] - **doc**: add `added:` information for repl (Anna Henningsen) [#7256](https://github.com/nodejs/node/pull/7256) * [[`e6d7bfcbe7`](https://github.com/nodejs/node/commit/e6d7bfcbe7)] - **doc**: add `added:` information for readline (Julian Duque) [#6996](https://github.com/nodejs/node/pull/6996) * [[`eec0c635ee`](https://github.com/nodejs/node/commit/eec0c635ee)] - **doc**: add `added:` information for querystring (Bryan English) [#6593](https://github.com/nodejs/node/pull/6593) * [[`a870cdcd1f`](https://github.com/nodejs/node/commit/a870cdcd1f)] - **doc**: add `added:` information for punycode (Daniel Wang) [#6805](https://github.com/nodejs/node/pull/6805) * [[`f1a37ad749`](https://github.com/nodejs/node/commit/f1a37ad749)] - **doc**: add `added:` information for path (Julian Duque) [#6985](https://github.com/nodejs/node/pull/6985) * [[`8b53f4b27c`](https://github.com/nodejs/node/commit/8b53f4b27c)] - **doc**: add `added:` information for os (Bryan English) [#6609](https://github.com/nodejs/node/pull/6609) * [[`78d361b22b`](https://github.com/nodejs/node/commit/78d361b22b)] - **doc**: add `added` information for net (Italo A. Casas) [#7038](https://github.com/nodejs/node/pull/7038) * [[`b08ff33c01`](https://github.com/nodejs/node/commit/b08ff33c01)] - **doc**: add `added:` information for https (Anna Henningsen) [#7392](https://github.com/nodejs/node/pull/7392) * [[`1d99059bb1`](https://github.com/nodejs/node/commit/1d99059bb1)] - **doc**: add `added:` information for dns (Julian Duque) [#7021](https://github.com/nodejs/node/pull/7021) * [[`a0ca24b798`](https://github.com/nodejs/node/commit/a0ca24b798)] - **doc**: add `added:` information for console (Adrian Estrada) [#6995](https://github.com/nodejs/node/pull/6995) * [[`eb08c17a20`](https://github.com/nodejs/node/commit/eb08c17a20)] - **doc**: add `added: ` data for cli.md (Rich Trott) [#6960](https://github.com/nodejs/node/pull/6960) * [[`ec9038478f`](https://github.com/nodejs/node/commit/ec9038478f)] - **doc**: add `added:` information for child_process (Anna Henningsen) [#6927](https://github.com/nodejs/node/pull/6927) * [[`e52b2b07d7`](https://github.com/nodejs/node/commit/e52b2b07d7)] - **doc**: add `added:` information for assert (Rich Trott) [#6688](https://github.com/nodejs/node/pull/6688) * [[`75e4f74c54`](https://github.com/nodejs/node/commit/75e4f74c54)] - **doc**: fix cluster worker 'message' event (cjihrig) [#7309](https://github.com/nodejs/node/pull/7309) * [[`de5e2357fc`](https://github.com/nodejs/node/commit/de5e2357fc)] - **doc**: dns.resolve fix callback argument description (Quentin Headen) [#7532](https://github.com/nodejs/node/pull/7532) * [[`0f903bb722`](https://github.com/nodejs/node/commit/0f903bb722)] - **doc**: add benchmark who-to-CC info (Rich Trott) [#7604](https://github.com/nodejs/node/pull/7604) * [[`700c6d9be8`](https://github.com/nodejs/node/commit/700c6d9be8)] - **doc**: added information on how to run the linter. (Diosney Sarmiento) [#7534](https://github.com/nodejs/node/pull/7534) * [[`537f33351e`](https://github.com/nodejs/node/commit/537f33351e)] - **doc**: fix minor style issues in http.md (Rich Trott) [#7528](https://github.com/nodejs/node/pull/7528) * [[`33a08b0414`](https://github.com/nodejs/node/commit/33a08b0414)] - **doc**: add bartosz sosnowski to colaborators (Bartosz Sosnowski) [#7567](https://github.com/nodejs/node/pull/7567) * [[`186af29298`](https://github.com/nodejs/node/commit/186af29298)] - **doc**: fix detached child stdio example (cjihrig) [#7540](https://github.com/nodejs/node/pull/7540) * [[`066cefb6de`](https://github.com/nodejs/node/commit/066cefb6de)] - **doc**: improve usage of `zero`/`0` (Rich Trott) [#7466](https://github.com/nodejs/node/pull/7466) * [[`6c94c67b73`](https://github.com/nodejs/node/commit/6c94c67b73)] - **doc**: fix "sign.verify" typo in crypto doc. (Ruslan Iusupov) [#7411](https://github.com/nodejs/node/pull/7411) * [[`35ee35cba2`](https://github.com/nodejs/node/commit/35ee35cba2)] - **doc**: clarify child_process stdout/stderr types (sartrey) [#7361](https://github.com/nodejs/node/pull/7361) * [[`71ef71cff8`](https://github.com/nodejs/node/commit/71ef71cff8)] - **doc**: add CTC meeting minutes 2016-06-15 (Josh Gavant) [#7320](https://github.com/nodejs/node/pull/7320) * [[`13d60cab7c`](https://github.com/nodejs/node/commit/13d60cab7c)] - **doc**: add lance to collaborators (Lance Ball) [#7407](https://github.com/nodejs/node/pull/7407) * [[`9122b3b665`](https://github.com/nodejs/node/commit/9122b3b665)] - **doc**: update "who to cc in issues" chart (Jeremiah Senkpiel) [#6694](https://github.com/nodejs/node/pull/6694) * [[`ccb278d330`](https://github.com/nodejs/node/commit/ccb278d330)] - **doc**: mention http request "aborted" events (Kyle E. Mitchell) [#7270](https://github.com/nodejs/node/pull/7270) * [[`868af29f2b`](https://github.com/nodejs/node/commit/868af29f2b)] - **doc**: add RReverser to collaborators (Ingvar Stepanyan) [#7370](https://github.com/nodejs/node/pull/7370) * [[`f8fe474825`](https://github.com/nodejs/node/commit/f8fe474825)] - **doc**: fixing minor typo in AtExit hooks section (Daniel Bevenius) [#7485](https://github.com/nodejs/node/pull/7485) * [[`4a7e333287`](https://github.com/nodejs/node/commit/4a7e333287)] - **doc**: use `Buffer.byteLength` for Content-Length (kimown) [#7274](https://github.com/nodejs/node/pull/7274) * [[`85f70b36e4`](https://github.com/nodejs/node/commit/85f70b36e4)] - **doc**: clarify use of `0` port value (Rich Trott) [#7206](https://github.com/nodejs/node/pull/7206) * [[`57ba51ec46`](https://github.com/nodejs/node/commit/57ba51ec46)] - **doc**: fix IRC link (Ilkka Myller) [#7210](https://github.com/nodejs/node/pull/7210) * [[`ef37a2e80f`](https://github.com/nodejs/node/commit/ef37a2e80f)] - **doc**: add internal link in GOVERNANCE.md (Rich Trott) [#7279](https://github.com/nodejs/node/pull/7279) * [[`c9ef04a1b2`](https://github.com/nodejs/node/commit/c9ef04a1b2)] - **doc**: fix events typo (Greyson Parrelli) [#7329](https://github.com/nodejs/node/pull/7329) * [[`0013af61de`](https://github.com/nodejs/node/commit/0013af61de)] - **doc**: fix header depth of util.isSymbol (James M Snell) [#7138](https://github.com/nodejs/node/pull/7138) * [[`96de3f8820`](https://github.com/nodejs/node/commit/96de3f8820)] - **doc**: Add CII Best Practices badge to README.md (David A. Wheeler) [#6819](https://github.com/nodejs/node/pull/6819) * [[`146cba1f60`](https://github.com/nodejs/node/commit/146cba1f60)] - **doc**: improve debugger doc prose (Rich Trott) [#7007](https://github.com/nodejs/node/pull/7007) * [[`694e34458b`](https://github.com/nodejs/node/commit/694e34458b)] - **doc**: fix typos in WORKING_GROUPS.md (Joao Andrade) [#7032](https://github.com/nodejs/node/pull/7032) * [[`fbdc16a8a4`](https://github.com/nodejs/node/commit/fbdc16a8a4)] - **doc**: update labels and CI info in onboarding doc (Rich Trott) [#7006](https://github.com/nodejs/node/pull/7006) * [[`1c65f1e3f6`](https://github.com/nodejs/node/commit/1c65f1e3f6)] - **doc**: add info on what's used for fswatch on AIX (Michael Dawson) [#6837](https://github.com/nodejs/node/pull/6837) * [[`72e8ee570a`](https://github.com/nodejs/node/commit/72e8ee570a)] - **doc**: improve server.listen() documentation prose (Rich Trott) [#7000](https://github.com/nodejs/node/pull/7000) * [[`649d201d63`](https://github.com/nodejs/node/commit/649d201d63)] - **doc**: improve `server.address()` doc text (Rich Trott) [#7001](https://github.com/nodejs/node/pull/7001) * [[`e2e85ced1d`](https://github.com/nodejs/node/commit/e2e85ced1d)] - **doc**: clarified use of sexual language in the CoC (Bryan Hughes) [#6973](https://github.com/nodejs/node/pull/6973) * [[`f395f6f5b2`](https://github.com/nodejs/node/commit/f395f6f5b2)] - **doc**: add yorkie to collaborators (Yazhong Liu) [#7004](https://github.com/nodejs/node/pull/7004) * [[`c5051ef643`](https://github.com/nodejs/node/commit/c5051ef643)] - **doc**: add firedfox to collaborators (Daniel Wang) [#6961](https://github.com/nodejs/node/pull/6961) * [[`2ef08323c6`](https://github.com/nodejs/node/commit/2ef08323c6)] - **doc**: add bmeck to collaborators (Bradley Meck) [#6962](https://github.com/nodejs/node/pull/6962) * [[`d1a0a146b3`](https://github.com/nodejs/node/commit/d1a0a146b3)] - **doc**: Add CTC meeting minutes for 2016-05-04 (Michael Dawson) [#6579](https://github.com/nodejs/node/pull/6579) * [[`0a85987899`](https://github.com/nodejs/node/commit/0a85987899)] - **doc**: update build instructions for Windows (João Reis) [#7285](https://github.com/nodejs/node/pull/7285) * [[`629a76f9fb`](https://github.com/nodejs/node/commit/629a76f9fb)] - **doc**: remove cluster.setupMaster() myth (cjihrig) [#7179](https://github.com/nodejs/node/pull/7179) * [[`5b807ac791`](https://github.com/nodejs/node/commit/5b807ac791)] - **doc**: specify how to link issues in commit log (Luigi Pinca) [#7161](https://github.com/nodejs/node/pull/7161) * [[`350f4cf292`](https://github.com/nodejs/node/commit/350f4cf292)] - **doc**: server.listen truncates socket path on unix (Jean Regisser) [#6659](https://github.com/nodejs/node/pull/6659) * [[`7813af7f16`](https://github.com/nodejs/node/commit/7813af7f16)] - **doc**: Add resolveNaptr and naptr rrtype docs (Doug Wade) [#6586](https://github.com/nodejs/node/pull/6586) * [[`5380743208`](https://github.com/nodejs/node/commit/5380743208)] - **doc**: document socket.destroyed (Tushar Mathur) [#6128](https://github.com/nodejs/node/pull/6128) * [[`f0edf87df1`](https://github.com/nodejs/node/commit/f0edf87df1)] - **doc**: add vm example, be able to require modules (Robert Jefe Lindstaedt) [#5323](https://github.com/nodejs/node/pull/5323) * [[`9121e94e62`](https://github.com/nodejs/node/commit/9121e94e62)] - **doc**: note that process.config can and will be changed (James M Snell) [#6266](https://github.com/nodejs/node/pull/6266) * [[`c237ac3d68`](https://github.com/nodejs/node/commit/c237ac3d68)] - **doc**: git mv to .md (Robert Jefe Lindstaedt) [#4747](https://github.com/nodejs/node/pull/4747) * [[`6324723cc1`](https://github.com/nodejs/node/commit/6324723cc1)] - **doc,dgram**: fix addMembership documentation (Santiago Gimeno) [#7244](https://github.com/nodejs/node/pull/7244) * [[`15bb0beab2`](https://github.com/nodejs/node/commit/15bb0beab2)] - **doc,test**: add `How to write a Node.js test` guide (Santiago Gimeno) [#6984](https://github.com/nodejs/node/pull/6984) * [[`9d13337183`](https://github.com/nodejs/node/commit/9d13337183)] - **http**: wait for both prefinish/end to keepalive (Fedor Indutny) [#7149](https://github.com/nodejs/node/pull/7149) * [[`ece428ea63`](https://github.com/nodejs/node/commit/ece428ea63)] - **http**: fix no dumping after `maybeReadMore` (Fedor Indutny) [#7211](https://github.com/nodejs/node/pull/7211) * [[`07fd52e5aa`](https://github.com/nodejs/node/commit/07fd52e5aa)] - **http**: skip body and next message of CONNECT res (Fedor Indutny) [#6279](https://github.com/nodejs/node/pull/6279) * [[`6f312b3a91`](https://github.com/nodejs/node/commit/6f312b3a91)] - **http_parser**: use `MakeCallback` (Trevor Norris) [#5419](https://github.com/nodejs/node/pull/5419) * [[`373ffc5bad`](https://github.com/nodejs/node/commit/373ffc5bad)] - **installer**: don't install node_internals.h (Ben Noordhuis) [#6913](https://github.com/nodejs/node/pull/6913) * [[`5782ec2427`](https://github.com/nodejs/node/commit/5782ec2427)] - **module**: don't cache uninitialized builtins (Anna Henningsen) [#6907](https://github.com/nodejs/node/pull/6907) * [[`c8e9adb135`](https://github.com/nodejs/node/commit/c8e9adb135)] - **repl**: fix tab completion for defined commands (Prince J Wesley) [#7364](https://github.com/nodejs/node/pull/7364) * [[`a3fa5db5ca`](https://github.com/nodejs/node/commit/a3fa5db5ca)] - **(SEMVER-MINOR)** **repl**: copying tabs shouldn't trigger completion (Eugene Obrezkov) [#5958](https://github.com/nodejs/node/pull/5958) * [[`d86332799c`](https://github.com/nodejs/node/commit/d86332799c)] - **src**: clean up string_search (Brian White) [#7174](https://github.com/nodejs/node/pull/7174) * [[`3eea55167d`](https://github.com/nodejs/node/commit/3eea55167d)] - **src**: fix memory leak in WriteBuffers() error path (Ben Noordhuis) [#7374](https://github.com/nodejs/node/pull/7374) * [[`23797eb037`](https://github.com/nodejs/node/commit/23797eb037)] - **src**: remove obsolete NOLINT comments (Ben Noordhuis) [#7462](https://github.com/nodejs/node/pull/7462) * [[`5aff60e832`](https://github.com/nodejs/node/commit/5aff60e832)] - **src**: lint v8abbr.h (Ben Noordhuis) [#7462](https://github.com/nodejs/node/pull/7462) * [[`42e7c9d266`](https://github.com/nodejs/node/commit/42e7c9d266)] - **src**: lint node_lttng_tp.h (Ben Noordhuis) [#7462](https://github.com/nodejs/node/pull/7462) * [[`27c2d25be6`](https://github.com/nodejs/node/commit/27c2d25be6)] - **src**: lint node_win32_perfctr_provider.cc (Ben Noordhuis) [#7462](https://github.com/nodejs/node/pull/7462) * [[`4f4d3e77ef`](https://github.com/nodejs/node/commit/4f4d3e77ef)] - **src**: fix whitespace/indent cpplint warnings (Ben Noordhuis) [#7462](https://github.com/nodejs/node/pull/7462) * [[`066064d65f`](https://github.com/nodejs/node/commit/066064d65f)] - **src**: fix whitespace/blank_line cpplint warnings (Ben Noordhuis) [#7462](https://github.com/nodejs/node/pull/7462) * [[`44cbe0356d`](https://github.com/nodejs/node/commit/44cbe0356d)] - **src**: fix runtime/references cpplint warnings (Ben Noordhuis) [#7462](https://github.com/nodejs/node/pull/7462) * [[`f530a36c65`](https://github.com/nodejs/node/commit/f530a36c65)] - **src**: fix runtime/int cpplint warnings (Ben Noordhuis) [#7462](https://github.com/nodejs/node/pull/7462) * [[`d6595adcdb`](https://github.com/nodejs/node/commit/d6595adcdb)] - **src**: fix runtime/indentation_namespace warnings (Ben Noordhuis) [#7462](https://github.com/nodejs/node/pull/7462) * [[`68db091aba`](https://github.com/nodejs/node/commit/68db091aba)] - **src**: fix readability/nolint cpplint warnings (Ben Noordhuis) [#7462](https://github.com/nodejs/node/pull/7462) * [[`4748bed736`](https://github.com/nodejs/node/commit/4748bed736)] - **src**: fix readability/namespace cpplint warnings (Ben Noordhuis) [#7462](https://github.com/nodejs/node/pull/7462) * [[`785211702a`](https://github.com/nodejs/node/commit/785211702a)] - **src**: fix readability/inheritance cpplint warnings (Ben Noordhuis) [#7462](https://github.com/nodejs/node/pull/7462) * [[`c90ae7fb72`](https://github.com/nodejs/node/commit/c90ae7fb72)] - **src**: fix readability/constructors cpplint warnings (Ben Noordhuis) [#7462](https://github.com/nodejs/node/pull/7462) * [[`16f2497994`](https://github.com/nodejs/node/commit/16f2497994)] - **src**: fix readability/braces cpplint warnings (Ben Noordhuis) [#7462](https://github.com/nodejs/node/pull/7462) * [[`c8f78a2682`](https://github.com/nodejs/node/commit/c8f78a2682)] - **src**: fix build/header_guard cpplint warnings (Ben Noordhuis) [#7462](https://github.com/nodejs/node/pull/7462) * [[`ccc701e1d5`](https://github.com/nodejs/node/commit/ccc701e1d5)] - **src**: fix build/c++tr1 cpplint warnings (Ben Noordhuis) [#7462](https://github.com/nodejs/node/pull/7462) * [[`dda81b44b0`](https://github.com/nodejs/node/commit/dda81b44b0)] - **src**: unify implementations of Utf8Value etc. (Anna Henningsen) [#6357](https://github.com/nodejs/node/pull/6357) * [[`db2b23f06f`](https://github.com/nodejs/node/commit/db2b23f06f)] - **src**: fix sporadic deadlock in SIGUSR1 handler (Ben Noordhuis) [#5904](https://github.com/nodejs/node/pull/5904) * [[`53a67ed6d7`](https://github.com/nodejs/node/commit/53a67ed6d7)] - **src**: fix bad logic in uid/gid checks (Ben Noordhuis) [#7374](https://github.com/nodejs/node/pull/7374) * [[`e6a27a70d8`](https://github.com/nodejs/node/commit/e6a27a70d8)] - **src**: fix use-after-return in zlib bindings (Ben Noordhuis) [#7374](https://github.com/nodejs/node/pull/7374) * [[`61de6e9b47`](https://github.com/nodejs/node/commit/61de6e9b47)] - **src**: remove deprecated HMAC_Init, use HMAC_Init_ex (Ben Noordhuis) [#7374](https://github.com/nodejs/node/pull/7374) * [[`7305e7b9d2`](https://github.com/nodejs/node/commit/7305e7b9d2)] - **src**: remove duplicate HMAC_Init calls (Ben Noordhuis) [#7374](https://github.com/nodejs/node/pull/7374) * [[`38baf6a0b7`](https://github.com/nodejs/node/commit/38baf6a0b7)] - **src**: remove unused md_ data members (Ben Noordhuis) [#7374](https://github.com/nodejs/node/pull/7374) * [[`e103044b68`](https://github.com/nodejs/node/commit/e103044b68)] - **src**: remove unused data member write_queue_size_ (Ben Noordhuis) [#7374](https://github.com/nodejs/node/pull/7374) * [[`67937bca0a`](https://github.com/nodejs/node/commit/67937bca0a)] - **src**: guard against starting fs watcher twice (Ben Noordhuis) [#7374](https://github.com/nodejs/node/pull/7374) * [[`c03bd57ac6`](https://github.com/nodejs/node/commit/c03bd57ac6)] - **src**: check uv_async_init() return value (Ben Noordhuis) [#7374](https://github.com/nodejs/node/pull/7374) * [[`2b0dce5a5b`](https://github.com/nodejs/node/commit/2b0dce5a5b)] - **src**: don't use locale-sensitive strcasecmp() (Ben Noordhuis) [#6582](https://github.com/nodejs/node/pull/6582) * [[`9c31c738fc`](https://github.com/nodejs/node/commit/9c31c738fc)] - **src**: remove unused #include statement (Ben Noordhuis) [#6582](https://github.com/nodejs/node/pull/6582) * [[`426aa0a5e8`](https://github.com/nodejs/node/commit/426aa0a5e8)] - **src**: fix Windows segfault with `--eval` (Bryce Simonds) [#6938](https://github.com/nodejs/node/pull/6938) * [[`b21d145c2a`](https://github.com/nodejs/node/commit/b21d145c2a)] - **(SEMVER-MINOR)** **src**: add node::FreeEnvironment public API (Cheng Zhao) [#3098](https://github.com/nodejs/node/pull/3098) * [[`b9136c0c03`](https://github.com/nodejs/node/commit/b9136c0c03)] - **src**: add process.binding('config') (James M Snell) [#6266](https://github.com/nodejs/node/pull/6266) * [[`c3d87eee49`](https://github.com/nodejs/node/commit/c3d87eee49)] - **src**: reword command and add ternary (Trevor Norris) [#5756](https://github.com/nodejs/node/pull/5756) * [[`68f391bf3b`](https://github.com/nodejs/node/commit/68f391bf3b)] - **src**: remove unnecessary check (Brian White) [#5233](https://github.com/nodejs/node/pull/5233) * [[`981bbcd925`](https://github.com/nodejs/node/commit/981bbcd925)] - **src**: remove TryCatch in MakeCallback (Trevor Norris) [#4507](https://github.com/nodejs/node/pull/4507) * [[`48b7b71352`](https://github.com/nodejs/node/commit/48b7b71352)] - **src**: remove unused TickInfo::in_tick() (Trevor Norris) [#4507](https://github.com/nodejs/node/pull/4507) * [[`d77b28c6b3`](https://github.com/nodejs/node/commit/d77b28c6b3)] - **src**: remove unused of TickInfo::last_threw() (Trevor Norris) [#4507](https://github.com/nodejs/node/pull/4507) * [[`cb291d5c7f`](https://github.com/nodejs/node/commit/cb291d5c7f)] - **src**: add AsyncCallbackScope (Trevor Norris) [#4507](https://github.com/nodejs/node/pull/4507) * [[`2eb097f212`](https://github.com/nodejs/node/commit/2eb097f212)] - **src**: fix MakeCallback error handling (Trevor Norris) [#4507](https://github.com/nodejs/node/pull/4507) * [[`63356df39c`](https://github.com/nodejs/node/commit/63356df39c)] - **src,http**: fix uncaughtException miss in http (Trevor Norris) [#5591](https://github.com/nodejs/node/pull/5591) * [[`ee7040568d`](https://github.com/nodejs/node/commit/ee7040568d)] - **src,http_parser**: remove KickNextTick call (Trevor Norris) [#5756](https://github.com/nodejs/node/pull/5756) * [[`9a8acad6ff`](https://github.com/nodejs/node/commit/9a8acad6ff)] - **test**: use random ports where possible (Brian White) [#7045](https://github.com/nodejs/node/pull/7045) * [[`223c0e2010`](https://github.com/nodejs/node/commit/223c0e2010)] - **test**: skip doctool tests when js-yaml is missing (Anna Henningsen) [#7218](https://github.com/nodejs/node/pull/7218) * [[`3681b9b868`](https://github.com/nodejs/node/commit/3681b9b868)] - **test**: refactor doctool tests (Rich Trott) [#6719](https://github.com/nodejs/node/pull/6719) * [[`686d7b329c`](https://github.com/nodejs/node/commit/686d7b329c)] - **test**: build addons with V8_DEPRECATION_WARNINGS=1 (Ben Noordhuis) [#6652](https://github.com/nodejs/node/pull/6652) * [[`8404e34665`](https://github.com/nodejs/node/commit/8404e34665)] - ***Revert*** "**test**: mark test-vm-timeout flaky on windows" (Anna Henningsen) [#7373](https://github.com/nodejs/node/pull/7373) * [[`eab9ced2ee`](https://github.com/nodejs/node/commit/eab9ced2ee)] - **test**: fix flaky test-vm-timeout (Anna Henningsen) [#7373](https://github.com/nodejs/node/pull/7373) * [[`a31d3161f5`](https://github.com/nodejs/node/commit/a31d3161f5)] - **test**: add test for exec() known issue (Rich Trott) [#7375](https://github.com/nodejs/node/pull/7375) * [[`1baa145a16`](https://github.com/nodejs/node/commit/1baa145a16)] - **test**: remove internet/test-tls-connnect-cnnic (Ben Noordhuis) [#7363](https://github.com/nodejs/node/pull/7363) * [[`e3097b7cdf`](https://github.com/nodejs/node/commit/e3097b7cdf)] - **test**: test isFullWidthCodePoint with invalid input (Rich Trott) [#7422](https://github.com/nodejs/node/pull/7422) * [[`f0b0fc49f9`](https://github.com/nodejs/node/commit/f0b0fc49f9)] - **test**: update weak module for gc tests (Rich Trott) [#7014](https://github.com/nodejs/node/pull/7014) * [[`1d100f6853`](https://github.com/nodejs/node/commit/1d100f6853)] - **test**: remove unused vars from http/https tests (Rich Trott) [#7598](https://github.com/nodejs/node/pull/7598) * [[`3241536d95`](https://github.com/nodejs/node/commit/3241536d95)] - **test**: remove unused var in net-server-try-ports (Rich Trott) [#7597](https://github.com/nodejs/node/pull/7597) * [[`7bd7c235fa`](https://github.com/nodejs/node/commit/7bd7c235fa)] - **test**: remove unused var from stream2 test (Rich Trott) [#7596](https://github.com/nodejs/node/pull/7596) * [[`4d36a67738`](https://github.com/nodejs/node/commit/4d36a67738)] - **test**: remove unused var from child-process-fork (Rich Trott) [#7599](https://github.com/nodejs/node/pull/7599) * [[`b5e516a42c`](https://github.com/nodejs/node/commit/b5e516a42c)] - **test**: remove unused var in test-tls-server-verify (Rich Trott) [#7595](https://github.com/nodejs/node/pull/7595) * [[`db35efa6c1`](https://github.com/nodejs/node/commit/db35efa6c1)] - **test**: fix flaky test-net-write-slow (Rich Trott) [#7555](https://github.com/nodejs/node/pull/7555) * [[`8273824ca3`](https://github.com/nodejs/node/commit/8273824ca3)] - **test**: remove common.PORT from http tests (Rich Trott) [#7467](https://github.com/nodejs/node/pull/7467) * [[`5129f3f2cd`](https://github.com/nodejs/node/commit/5129f3f2cd)] - **test**: mark test-vm-timeout flaky on windows (Rich Trott) [#7359](https://github.com/nodejs/node/pull/7359) * [[`79b45886c1`](https://github.com/nodejs/node/commit/79b45886c1)] - **test**: add tests for some stream.Readable uses (Anna Henningsen) [#7260](https://github.com/nodejs/node/pull/7260) * [[`65b5cccee9`](https://github.com/nodejs/node/commit/65b5cccee9)] - **test**: fix spawn on windows (Brian White) [#7049](https://github.com/nodejs/node/pull/7049) * [[`96ed883d2f`](https://github.com/nodejs/node/commit/96ed883d2f)] - **test**: enable test-debug-brk-no-arg (Rich Trott) [#7143](https://github.com/nodejs/node/pull/7143) * [[`8724c442f3`](https://github.com/nodejs/node/commit/8724c442f3)] - **test**: add test for uid/gid setting in spawn (Rich Trott) [#7084](https://github.com/nodejs/node/pull/7084) * [[`042e858dfb`](https://github.com/nodejs/node/commit/042e858dfb)] - **test**: make test-child-process-fork-net more robust (Rich Trott) [#7033](https://github.com/nodejs/node/pull/7033) * [[`2a59e4e73d`](https://github.com/nodejs/node/commit/2a59e4e73d)] - **test**: improve debug-break-on-uncaught reliability (Rich Trott) [#6793](https://github.com/nodejs/node/pull/6793) * [[`77325d585e`](https://github.com/nodejs/node/commit/77325d585e)] - **test**: remove disabled eio race test (Rich Trott) [#7083](https://github.com/nodejs/node/pull/7083) * [[`5b1f54678b`](https://github.com/nodejs/node/commit/5b1f54678b)] - **test**: remove non-incremental common.PORT changes (Rich Trott) [#7055](https://github.com/nodejs/node/pull/7055) * [[`44228dfdef`](https://github.com/nodejs/node/commit/44228dfdef)] - **test**: remove `common.PORT` from gc tests (Rich Trott) [#7013](https://github.com/nodejs/node/pull/7013) * [[`644bfe14a6`](https://github.com/nodejs/node/commit/644bfe14a6)] - **test**: fix test-debug-port-numbers on OS X (Santiago Gimeno) [#7046](https://github.com/nodejs/node/pull/7046) * [[`cde3014f78`](https://github.com/nodejs/node/commit/cde3014f78)] - **test**: remove modifcation to common.PORT (Rich Trott) [#6990](https://github.com/nodejs/node/pull/6990) * [[`8c412af7ac`](https://github.com/nodejs/node/commit/8c412af7ac)] - **test**: verify cluster worker exit (cjihrig) [#6993](https://github.com/nodejs/node/pull/6993) * [[`7d6acefbcc`](https://github.com/nodejs/node/commit/7d6acefbcc)] - **test**: listen on and connect to 127.0.0.1 (Ben Noordhuis) [#7524](https://github.com/nodejs/node/pull/7524) * [[`ecf5c1cb25`](https://github.com/nodejs/node/commit/ecf5c1cb25)] - **test**: refactor spawnSync() cwd test (cjihrig) [#6939](https://github.com/nodejs/node/pull/6939) * [[`9cccaa3c80`](https://github.com/nodejs/node/commit/9cccaa3c80)] - **test**: fix component printing on windows (Ben Noordhuis) [#6915](https://github.com/nodejs/node/pull/6915) * [[`af4b56d6be`](https://github.com/nodejs/node/commit/af4b56d6be)] - **test**: pass python path to node-gyp (hefangshi) [#6646](https://github.com/nodejs/node/pull/6646) * [[`7c55f59214`](https://github.com/nodejs/node/commit/7c55f59214)] - **test**: make stdout buffer test more robust (Rich Trott) [#6633](https://github.com/nodejs/node/pull/6633) * [[`3aef9b813f`](https://github.com/nodejs/node/commit/3aef9b813f)] - **test**: unmark test-http-regr-gh-2928 as flaky (Rich Trott) [#6540](https://github.com/nodejs/node/pull/6540) * [[`2259e5db69`](https://github.com/nodejs/node/commit/2259e5db69)] - **test**: avoid test-cluster-master-* flakiness (Stefan Budeanu) [#6531](https://github.com/nodejs/node/pull/6531) * [[`5f444ed6a3`](https://github.com/nodejs/node/commit/5f444ed6a3)] - **test**: add tests for stream3 buffering using cork (Alex J Burke) [#6493](https://github.com/nodejs/node/pull/6493) * [[`01b314d165`](https://github.com/nodejs/node/commit/01b314d165)] - **test**: test TTY problems by fakeing a TTY using openpty (Jeremiah Senkpiel) [#6895](https://github.com/nodejs/node/pull/6895) * [[`55f8689711`](https://github.com/nodejs/node/commit/55f8689711)] - **test**: add test for responses to HTTP CONNECT req (Josh Leder) [#6279](https://github.com/nodejs/node/pull/6279) * [[`9aec1ddb4f`](https://github.com/nodejs/node/commit/9aec1ddb4f)] - **test**: test cluster worker disconnection on error (Santiago Gimeno) [#6909](https://github.com/nodejs/node/pull/6909) * [[`c0a42bc040`](https://github.com/nodejs/node/commit/c0a42bc040)] - **test**: verify IPC messages are emitted on next tick (Santiago Gimeno) [#6909](https://github.com/nodejs/node/pull/6909) * [[`9606f768ea`](https://github.com/nodejs/node/commit/9606f768ea)] - **(SEMVER-MINOR)** **test**: run v8 tests from node tree (Bryon Leung) [#4704](https://github.com/nodejs/node/pull/4704) * [[`efdeb69c9a`](https://github.com/nodejs/node/commit/efdeb69c9a)] - **test**: work around debugger not killing inferior (Ben Noordhuis) [#7037](https://github.com/nodejs/node/pull/7037) * [[`e3f9bc893f`](https://github.com/nodejs/node/commit/e3f9bc893f)] - **test**: use strictEqual consistently in agent test (Ben Noordhuis) [#6654](https://github.com/nodejs/node/pull/6654) * [[`1186b7a401`](https://github.com/nodejs/node/commit/1186b7a401)] - **test**: add addons test for MakeCallback (Trevor Norris) [#4507](https://github.com/nodejs/node/pull/4507) * [[`8f76d7db03`](https://github.com/nodejs/node/commit/8f76d7db03)] - **test,tools**: test yaml parsing of doctool (Anna Henningsen) [#6495](https://github.com/nodejs/node/pull/6495) * [[`e544b1c40c`](https://github.com/nodejs/node/commit/e544b1c40c)] - **test,win**: skip addons/load-long-path on WOW64 (Alexis Campailla) [#6675](https://github.com/nodejs/node/pull/6675) * [[`b956635e41`](https://github.com/nodejs/node/commit/b956635e41)] - **tls**: catch `certCbDone` exceptions (Fedor Indutny) [#6887](https://github.com/nodejs/node/pull/6887) * [[`06327e5eed`](https://github.com/nodejs/node/commit/06327e5eed)] - **tls**: use process.binding('config') to detect fips mode (James M Snell) [#7551](https://github.com/nodejs/node/pull/7551) * [[`c807287e80`](https://github.com/nodejs/node/commit/c807287e80)] - **tls,https**: respect address family when connecting (Ben Noordhuis) [#6654](https://github.com/nodejs/node/pull/6654) * [[`9ef6e23088`](https://github.com/nodejs/node/commit/9ef6e23088)] - **tools**: make sure doctool anchors respect includes (Anna Henningsen) [#6943](https://github.com/nodejs/node/pull/6943) * [[`f9f85a006f`](https://github.com/nodejs/node/commit/f9f85a006f)] - **tools**: restore change of signatures to opts hashes (Jesse McCarthy) [#6690](https://github.com/nodejs/node/pull/6690) * [[`607173bbac`](https://github.com/nodejs/node/commit/607173bbac)] - **tools**: fix regression in doctool (Myles Borins) [#6680](https://github.com/nodejs/node/pull/6680) * [[`ed193ad8ae`](https://github.com/nodejs/node/commit/ed193ad8ae)] - **tools**: fix tools/doc/addon-verify.js regression (Anna Henningsen) [#6652](https://github.com/nodejs/node/pull/6652) * [[`8b88c384f0`](https://github.com/nodejs/node/commit/8b88c384f0)] - **tools**: lint for object literal spacing (Rich Trott) [#6592](https://github.com/nodejs/node/pull/6592) * [[`96b5aa8710`](https://github.com/nodejs/node/commit/96b5aa8710)] - **tools**: update marked dependency (Daniel Wang) [#6396](https://github.com/nodejs/node/pull/6396) * [[`ea137637b7`](https://github.com/nodejs/node/commit/ea137637b7)] - **tools**: allow multiple added: version entries (Anna Henningsen) [#6495](https://github.com/nodejs/node/pull/6495) * [[`2832a60426`](https://github.com/nodejs/node/commit/2832a60426)] - **tools**: parse documentation metadata (Tristian Flanagan) [#6495](https://github.com/nodejs/node/pull/6495) * [[`0149cb0577`](https://github.com/nodejs/node/commit/0149cb0577)] - **tools**: add mock-y js-yaml dependency to doctool (Anna Henningsen) [#6495](https://github.com/nodejs/node/pull/6495) * [[`68e9fd47c6`](https://github.com/nodejs/node/commit/68e9fd47c6)] - **tools**: fix -Wunused-variable warning (Ben Noordhuis) [#7462](https://github.com/nodejs/node/pull/7462) * [[`4a2bd2d515`](https://github.com/nodejs/node/commit/4a2bd2d515)] - **tools**: allow cpplint to run outside git repo (Ben Noordhuis) [#7462](https://github.com/nodejs/node/pull/7462) * [[`09e98a4457`](https://github.com/nodejs/node/commit/09e98a4457)] - **tools**: add back --mode=tap to cpplint (Ben Noordhuis) [#7462](https://github.com/nodejs/node/pull/7462) * [[`e74f199fe2`](https://github.com/nodejs/node/commit/e74f199fe2)] - **tools**: disable unwanted cpplint rules again (Ben Noordhuis) [#7462](https://github.com/nodejs/node/pull/7462) * [[`391fc80487`](https://github.com/nodejs/node/commit/391fc80487)] - **tools**: update cpplint to r456 (Ben Noordhuis) [#7462](https://github.com/nodejs/node/pull/7462) * [[`efadf7639f`](https://github.com/nodejs/node/commit/efadf7639f)] - **tools**: update certdata.txt (Ben Noordhuis) [#7363](https://github.com/nodejs/node/pull/7363) * [[`d7ce99214d`](https://github.com/nodejs/node/commit/d7ce99214d)] - **tools**: update ESLint, fix unused vars bug (Rich Trott) [#7601](https://github.com/nodejs/node/pull/7601) * [[`242d6c7323`](https://github.com/nodejs/node/commit/242d6c7323)] - **tools**: remove unused variable (Rich Trott) [#7594](https://github.com/nodejs/node/pull/7594) * [[`7182f5f876`](https://github.com/nodejs/node/commit/7182f5f876)] - **tools**: fix license builder to work with icu-small (Myles Borins) [#7119](https://github.com/nodejs/node/pull/7119) * [[`140b84dd7d`](https://github.com/nodejs/node/commit/140b84dd7d)] - **tools**: print stderr on bad test.py `vmArch` check (Jeremiah Senkpiel) [#6786](https://github.com/nodejs/node/pull/6786) * [[`4c423e649c`](https://github.com/nodejs/node/commit/4c423e649c)] - **tools**: explicit path for V8 test tap output (Myles Borins) [#7460](https://github.com/nodejs/node/pull/7460) * [[`d50f16969d`](https://github.com/nodejs/node/commit/d50f16969d)] - **tools,doc**: add example usage for REPLACEME tag (Anna Henningsen) [#6864](https://github.com/nodejs/node/pull/6864) * [[`b07c3a6ea6`](https://github.com/nodejs/node/commit/b07c3a6ea6)] - **tty**: use blocking mode on OS X (Jeremiah Senkpiel) [#6895](https://github.com/nodejs/node/pull/6895) * [[`a1719a94e9`](https://github.com/nodejs/node/commit/a1719a94e9)] - **udp**: use libuv API to get file descriptor (Saúl Ibarra Corretgé) [#6908](https://github.com/nodejs/node/pull/6908) * [[`7779639a11`](https://github.com/nodejs/node/commit/7779639a11)] - **unix,stream**: fix getting the correct fd for a handle (Saúl Ibarra Corretgé) [#6753](https://github.com/nodejs/node/pull/6753) * [[`d0bf09d3ad`](https://github.com/nodejs/node/commit/d0bf09d3ad)] - **util**: improve format() performance further (Brian White) [#5360](https://github.com/nodejs/node/pull/5360) * [[`72fb281961`](https://github.com/nodejs/node/commit/72fb281961)] - **util**: improve util.format performance (Evan Lucas) [#5360](https://github.com/nodejs/node/pull/5360) * [[`855759757a`](https://github.com/nodejs/node/commit/855759757a)] - **vm**: don't print out arrow message for custom error (Anna Henningsen) [#7398](https://github.com/nodejs/node/pull/7398) * [[`b9dfdfe1d3`](https://github.com/nodejs/node/commit/b9dfdfe1d3)] - **vm**: don't abort process when stack space runs out (Anna Henningsen) [#6907](https://github.com/nodejs/node/pull/6907) * [[`0bfedd13a9`](https://github.com/nodejs/node/commit/0bfedd13a9)] - **win,build**: add creation of zip and 7z package (Bartosz Sosnowski) [#5995](https://github.com/nodejs/node/pull/5995) * [[`7d66752f1f`](https://github.com/nodejs/node/commit/7d66752f1f)] - **zlib**: release callback and buffer after processing (Matt Lavin) [#6955](https://github.com/nodejs/node/pull/6955) ## 2016-06-28, Version 4.4.7 'Argon' (LTS), @thealphanerd This LTS release comes with 89 commits. This includes 46 commits that are docs related, 11 commits that are test related, 8 commits that are build related, and 4 commits that are benchmark related. ### Notable Changes - **debugger**: - All properties of an array (aside from length) can now be printed in the repl (cjihrig) [#6448](https://github.com/nodejs/node/pull/6448) - **npm**: - Upgrade npm to 2.15.8 (Rebecca Turner) [#7412](https://github.com/nodejs/node/pull/7412) - **stream**: - Fix for a bug that became more prevalent with the stream changes that landed in v4.4.5. (Anna Henningsen) [#7160](https://github.com/nodejs/node/pull/7160) - **V8**: - Fix for a bug in crankshaft that was causing crashes on arm64 (Myles Borins) [#7442](https://github.com/nodejs/node/pull/7442) - Add missing classes to postmortem info such as JSMap and JSSet (evan.lucas) [#3792](https://github.com/nodejs/node/pull/3792) ### Commits * [[`87cdb83a96`](https://github.com/nodejs/node/commit/87cdb83a96)] - **benchmark**: merge url.js with url-resolve.js (Andreas Madsen) [#5177](https://github.com/nodejs/node/pull/5177) * [[`921e8568d5`](https://github.com/nodejs/node/commit/921e8568d5)] - **benchmark**: move misc to categorized directories (Andreas Madsen) [#5177](https://github.com/nodejs/node/pull/5177) * [[`c189eec14e`](https://github.com/nodejs/node/commit/c189eec14e)] - **benchmark**: fix configuation parameters (Andreas Madsen) [#5177](https://github.com/nodejs/node/pull/5177) * [[`58ad451f0b`](https://github.com/nodejs/node/commit/58ad451f0b)] - **benchmark**: move string-decoder to its own category (Andreas Madsen) [#5177](https://github.com/nodejs/node/pull/5177) * [[`a01caa3166`](https://github.com/nodejs/node/commit/a01caa3166)] - **build**: don't compile with -B, redux (Ben Noordhuis) [#6650](https://github.com/nodejs/node/pull/6650) * [[`37606caeaf`](https://github.com/nodejs/node/commit/37606caeaf)] - **build**: don't compile with -B (Ben Noordhuis) [#6393](https://github.com/nodejs/node/pull/6393) * [[`64fb7a1929`](https://github.com/nodejs/node/commit/64fb7a1929)] - **build**: update android-configure script for npm (Robert Chiras) [#6349](https://github.com/nodejs/node/pull/6349) * [[`43ce6fc8d2`](https://github.com/nodejs/node/commit/43ce6fc8d2)] - **build**: fix DESTCPU detection for binary target (Richard Lau) [#6310](https://github.com/nodejs/node/pull/6310) * [[`6dfe7aeed5`](https://github.com/nodejs/node/commit/6dfe7aeed5)] - **cares**: Support malloc(0) scenarios for AIX (Gireesh Punathil) [#6305](https://github.com/nodejs/node/pull/6305) * [[`2389006720`](https://github.com/nodejs/node/commit/2389006720)] - **debugger**: display array contents in repl (cjihrig) [#6448](https://github.com/nodejs/node/pull/6448) * [[`1c6809ce75`](https://github.com/nodejs/node/commit/1c6809ce75)] - **debugger**: introduce exec method for debugger (Jackson Tian) * [[`200b3ca9ed`](https://github.com/nodejs/node/commit/200b3ca9ed)] - **deps**: upgrade npm in LTS to 2.15.8 (Rebecca Turner) [#7412](https://github.com/nodejs/node/pull/7412) * [[`49921e8819`](https://github.com/nodejs/node/commit/49921e8819)] - **deps**: backport 102e3e87e7 from V8 upstream (Myles Borins) [#7442](https://github.com/nodejs/node/pull/7442) * [[`de00f91041`](https://github.com/nodejs/node/commit/de00f91041)] - **deps**: backport bc2e393 from v8 upstream (evan.lucas) [#3792](https://github.com/nodejs/node/pull/3792) * [[`1549899531`](https://github.com/nodejs/node/commit/1549899531)] - **dgram,test**: add addMembership/dropMembership tests (Rich Trott) [#6753](https://github.com/nodejs/node/pull/6753) * [[`0ba3c2ca66`](https://github.com/nodejs/node/commit/0ba3c2ca66)] - **doc**: fix layout problem in v4 changelog (Myles Borins) [#7394](https://github.com/nodejs/node/pull/7394) * [[`98469ad84d`](https://github.com/nodejs/node/commit/98469ad84d)] - **doc**: correct args for cluster message event (Colin Ihrig) [#7297](https://github.com/nodejs/node/pull/7297) * [[`67863f110b`](https://github.com/nodejs/node/commit/67863f110b)] - **doc**: update licenses (Myles Borins) [#7127](https://github.com/nodejs/node/pull/7127) * [[`c31eaad42d`](https://github.com/nodejs/node/commit/c31eaad42d)] - **doc**: clarify buffer class (Steve Mao) [#6914](https://github.com/nodejs/node/pull/6914) * [[`e0dd476fe5`](https://github.com/nodejs/node/commit/e0dd476fe5)] - **doc**: fix typos in timers topic to aid readability (Kevin Donahue) [#6916](https://github.com/nodejs/node/pull/6916) * [[`a8391bc9fc`](https://github.com/nodejs/node/commit/a8391bc9fc)] - **doc**: add jhamhader to collaborators (Yuval Brik) [#6946](https://github.com/nodejs/node/pull/6946) * [[`22ca7b877b`](https://github.com/nodejs/node/commit/22ca7b877b)] - **doc**: add @othiym23 to list of collaborators (Forrest L Norvell) [#6945](https://github.com/nodejs/node/pull/6945) * [[`2c3c4e5819`](https://github.com/nodejs/node/commit/2c3c4e5819)] - **doc**: reference list of language-specific globals (Anna Henningsen) [#6900](https://github.com/nodejs/node/pull/6900) * [[`5a1a0b5ed1`](https://github.com/nodejs/node/commit/5a1a0b5ed1)] - **doc**: make the api doc print-friendly (Marian) [#6748](https://github.com/nodejs/node/pull/6748) * [[`03db88e012`](https://github.com/nodejs/node/commit/03db88e012)] - **doc**: add bengl to collaborators (Bryan English) [#6921](https://github.com/nodejs/node/pull/6921) * [[`fbf95dde94`](https://github.com/nodejs/node/commit/fbf95dde94)] - **doc**: Update DCO to v1.1 (William Kapke) [#6353](https://github.com/nodejs/node/pull/6353) * [[`f23a9c39c0`](https://github.com/nodejs/node/commit/f23a9c39c0)] - **doc**: fix typo in Error.captureStackTrace (Mohsen) [#6811](https://github.com/nodejs/node/pull/6811) * [[`30ab6a890c`](https://github.com/nodejs/node/commit/30ab6a890c)] - **doc**: fix name to match git log (Robert Jefe Lindstaedt) [#6880](https://github.com/nodejs/node/pull/6880) * [[`2b0f40ca16`](https://github.com/nodejs/node/commit/2b0f40ca16)] - **doc**: add note for fs.watch virtualized env (Robert Jefe Lindstaedt) [#6809](https://github.com/nodejs/node/pull/6809) * [[`3b461870be`](https://github.com/nodejs/node/commit/3b461870be)] - **doc**: Backport ee.once doc clarifications to 4.x. (Lance Ball) [#7103](https://github.com/nodejs/node/pull/7103) * [[`eadb7e5b20`](https://github.com/nodejs/node/commit/eadb7e5b20)] - **doc**: subdivide TOC, add auxiliary links (Jeremiah Senkpiel) [#6167](https://github.com/nodejs/node/pull/6167) * [[`107839c5dd`](https://github.com/nodejs/node/commit/107839c5dd)] - **doc**: no Node.js(1) (Jeremiah Senkpiel) [#6167](https://github.com/nodejs/node/pull/6167) * [[`401325f9e2`](https://github.com/nodejs/node/commit/401325f9e2)] - **doc**: better example & synopsis (Jeremiah Senkpiel) [#6167](https://github.com/nodejs/node/pull/6167) * [[`c654184f28`](https://github.com/nodejs/node/commit/c654184f28)] - **doc**: remove link to Sign in crypto.md (Kirill Fomichev) [#6812](https://github.com/nodejs/node/pull/6812) * [[`3e9288e466`](https://github.com/nodejs/node/commit/3e9288e466)] - **doc**: fix exec example in child_process (Evan Lucas) [#6660](https://github.com/nodejs/node/pull/6660) * [[`3d820e45b4`](https://github.com/nodejs/node/commit/3d820e45b4)] - **doc**: "a" -> "an" in api/documentation.md (Anchika Agarwal) [#6689](https://github.com/nodejs/node/pull/6689) * [[`352496daa2`](https://github.com/nodejs/node/commit/352496daa2)] - **doc**: move the readme newcomers section (Jeremiah Senkpiel) [#6681](https://github.com/nodejs/node/pull/6681) * [[`ac6b921ce5`](https://github.com/nodejs/node/commit/ac6b921ce5)] - **doc**: mention existence/purpose of module wrapper (Matt Harrison) [#6433](https://github.com/nodejs/node/pull/6433) * [[`97d1fc0fc6`](https://github.com/nodejs/node/commit/97d1fc0fc6)] - **doc**: improve onboarding-extras.md formatting (Jeremiah Senkpiel) [#6548](https://github.com/nodejs/node/pull/6548) * [[`c9b144ddd4`](https://github.com/nodejs/node/commit/c9b144ddd4)] - **doc**: linkify remaining references to fs.Stats object (Kevin Donahue) [#6485](https://github.com/nodejs/node/pull/6485) * [[`d909c25a33`](https://github.com/nodejs/node/commit/d909c25a33)] - **doc**: fix the lint of an example in cluster.md (yorkie) [#6516](https://github.com/nodejs/node/pull/6516) * [[`21d02f460f`](https://github.com/nodejs/node/commit/21d02f460f)] - **doc**: add missing underscore for markdown italics (Kevin Donahue) [#6529](https://github.com/nodejs/node/pull/6529) * [[`18ecc779bb`](https://github.com/nodejs/node/commit/18ecc779bb)] - **doc**: ensure consistent grammar in node.1 file (justshiv) [#6426](https://github.com/nodejs/node/pull/6426) * [[`52d9e7b61d`](https://github.com/nodejs/node/commit/52d9e7b61d)] - **doc**: fix a typo in __dirname section (William Luo) [#6473](https://github.com/nodejs/node/pull/6473) * [[`de20235235`](https://github.com/nodejs/node/commit/de20235235)] - **doc**: remove all scrollbar styling (Claudio Rodriguez) [#6479](https://github.com/nodejs/node/pull/6479) * [[`a6f45b4eda`](https://github.com/nodejs/node/commit/a6f45b4eda)] - **doc**: Remove extra space in REPL example (Juan) [#6447](https://github.com/nodejs/node/pull/6447) * [[`feda15b2b8`](https://github.com/nodejs/node/commit/feda15b2b8)] - **doc**: update build instructions for OS X (Rich Trott) [#6309](https://github.com/nodejs/node/pull/6309) * [[`3d1a3e4a30`](https://github.com/nodejs/node/commit/3d1a3e4a30)] - **doc**: change references to Stable to Current (Myles Borins) [#6318](https://github.com/nodejs/node/pull/6318) * [[`e28598b1ef`](https://github.com/nodejs/node/commit/e28598b1ef)] - **doc**: update authors (James M Snell) [#6373](https://github.com/nodejs/node/pull/6373) * [[`0f3a94acbd`](https://github.com/nodejs/node/commit/0f3a94acbd)] - **doc**: add JacksonTian to collaborators (Jackson Tian) [#6388](https://github.com/nodejs/node/pull/6388) * [[`d7d54c8fd2`](https://github.com/nodejs/node/commit/d7d54c8fd2)] - **doc**: add Minqi Pan to collaborators (Minqi Pan) [#6387](https://github.com/nodejs/node/pull/6387) * [[`83721c6fd2`](https://github.com/nodejs/node/commit/83721c6fd2)] - **doc**: add eljefedelrodeodeljefe to collaborators (Robert Jefe Lindstaedt) [#6389](https://github.com/nodejs/node/pull/6389) * [[`b112fd1b4e`](https://github.com/nodejs/node/commit/b112fd1b4e)] - **doc**: add ronkorving to collaborators (ronkorving) [#6385](https://github.com/nodejs/node/pull/6385) * [[`ac60d9cc86`](https://github.com/nodejs/node/commit/ac60d9cc86)] - **doc**: add estliberitas to collaborators (Alexander Makarenko) [#6386](https://github.com/nodejs/node/pull/6386) * [[`435cd56de5`](https://github.com/nodejs/node/commit/435cd56de5)] - **doc**: DCO anchor that doesn't change (William Kapke) [#6257](https://github.com/nodejs/node/pull/6257) * [[`7d8141dd1b`](https://github.com/nodejs/node/commit/7d8141dd1b)] - **doc**: add stefanmb to collaborators (Stefan Budeanu) [#6227](https://github.com/nodejs/node/pull/6227) * [[`6dfc96326d`](https://github.com/nodejs/node/commit/6dfc96326d)] - **doc**: add iWuzHere to collaborators (Imran Iqbal) [#6226](https://github.com/nodejs/node/pull/6226) * [[`3dbcc73159`](https://github.com/nodejs/node/commit/3dbcc73159)] - **doc**: add santigimeno to collaborators (Santiago Gimeno) [#6225](https://github.com/nodejs/node/pull/6225) * [[`ae3eb24a3d`](https://github.com/nodejs/node/commit/ae3eb24a3d)] - **doc**: add addaleax to collaborators (Anna Henningsen) [#6224](https://github.com/nodejs/node/pull/6224) * [[`46ee7bb4ba`](https://github.com/nodejs/node/commit/46ee7bb4ba)] - **doc**: fix incorrect references in buffer docs (Amery) [#6194](https://github.com/nodejs/node/pull/6194) * [[`e3f78eb7c1`](https://github.com/nodejs/node/commit/e3f78eb7c1)] - **doc**: improve rendering of v4.4.5 changelog entry (Myles Borins) [#6958](https://github.com/nodejs/node/pull/6958) * [[`bac87d01d9`](https://github.com/nodejs/node/commit/bac87d01d9)] - **gitignore**: adding .vs/ directory to .gitignore (Mike Kaufman) [#6070](https://github.com/nodejs/node/pull/6070) * [[`93f2314dc2`](https://github.com/nodejs/node/commit/93f2314dc2)] - **gitignore**: ignore VS 2015 *.VC.opendb files (Mike Kaufman) [#6070](https://github.com/nodejs/node/pull/6070) * [[`c98aaf59bf`](https://github.com/nodejs/node/commit/c98aaf59bf)] - **http**: speed up checkIsHttpToken (Jackson Tian) [#4790](https://github.com/nodejs/node/pull/4790) * [[`552e25cb6b`](https://github.com/nodejs/node/commit/552e25cb6b)] - **lib,test**: update in preparation for linter update (Rich Trott) [#6498](https://github.com/nodejs/node/pull/6498) * [[`aaeeec4765`](https://github.com/nodejs/node/commit/aaeeec4765)] - **lib,test,tools**: alignment on variable assignments (Rich Trott) [#6869](https://github.com/nodejs/node/pull/6869) * [[`b3acbc5648`](https://github.com/nodejs/node/commit/b3acbc5648)] - **net**: replace __defineGetter__ with defineProperty (Fedor Indutny) [#6284](https://github.com/nodejs/node/pull/6284) * [[`4c1eb5bf03`](https://github.com/nodejs/node/commit/4c1eb5bf03)] - **repl**: create history file with mode 0600 (Carl Lei) [#3394](https://github.com/nodejs/node/pull/3394) * [[`90306bb81d`](https://github.com/nodejs/node/commit/90306bb81d)] - **src**: use size_t for http parser array size fields (Ben Noordhuis) [#5969](https://github.com/nodejs/node/pull/5969) * [[`af41a63d0f`](https://github.com/nodejs/node/commit/af41a63d0f)] - **src**: replace ARRAY_SIZE with typesafe arraysize (Ben Noordhuis) [#5969](https://github.com/nodejs/node/pull/5969) * [[`037291e31f`](https://github.com/nodejs/node/commit/037291e31f)] - **src**: make sure Utf8Value always zero-terminates (Anna Henningsen) [#7101](https://github.com/nodejs/node/pull/7101) * [[`a08a0179e9`](https://github.com/nodejs/node/commit/a08a0179e9)] - **stream**: ensure awaitDrain is increased once (David Halls) [#7292](https://github.com/nodejs/node/pull/7292) * [[`b73ec46dcb`](https://github.com/nodejs/node/commit/b73ec46dcb)] - **stream**: reset awaitDrain after manual .resume() (Anna Henningsen) [#7160](https://github.com/nodejs/node/pull/7160) * [[`55319fe798`](https://github.com/nodejs/node/commit/55319fe798)] - **stream_base**: expose `bytesRead` getter (Fedor Indutny) [#6284](https://github.com/nodejs/node/pull/6284) * [[`0414d882ce`](https://github.com/nodejs/node/commit/0414d882ce)] - **test**: fix test-net-* error code check for getaddrinfo(3) (Natanael Copa) [#5099](https://github.com/nodejs/node/pull/5099) * [[`be0bb5f5fc`](https://github.com/nodejs/node/commit/be0bb5f5fc)] - **test**: fix unreliable known_issues test (Rich Trott) [#6555](https://github.com/nodejs/node/pull/6555) * [[`ab50e82f42`](https://github.com/nodejs/node/commit/ab50e82f42)] - **test**: fix test-process-exec-argv flakiness (Santiago Gimeno) [#7128](https://github.com/nodejs/node/pull/7128) * [[`4e38655d5f`](https://github.com/nodejs/node/commit/4e38655d5f)] - **test**: refactor test-tls-reuse-host-from-socket (Rich Trott) [#6756](https://github.com/nodejs/node/pull/6756) * [[`1c4549a31e`](https://github.com/nodejs/node/commit/1c4549a31e)] - **test**: fix flaky test-stdout-close-catch (Santiago Gimeno) [#6808](https://github.com/nodejs/node/pull/6808) * [[`3b94e31245`](https://github.com/nodejs/node/commit/3b94e31245)] - **test**: robust handling of env for npm-test-install (Myles Borins) [#6797](https://github.com/nodejs/node/pull/6797) * [[`4067cde7ee`](https://github.com/nodejs/node/commit/4067cde7ee)] - **test**: abstract skip functionality to common (Jeremiah Senkpiel) [#7114](https://github.com/nodejs/node/pull/7114) * [[`8b396e3d71`](https://github.com/nodejs/node/commit/8b396e3d71)] - **test**: fix test-debugger-repl-break-in-module (Rich Trott) [#6686](https://github.com/nodejs/node/pull/6686) * [[`847b29c050`](https://github.com/nodejs/node/commit/847b29c050)] - **test**: fix test-debugger-repl-term (Rich Trott) [#6682](https://github.com/nodejs/node/pull/6682) * [[`1d68bdbe3f`](https://github.com/nodejs/node/commit/1d68bdbe3f)] - **test**: fix error message checks in test-module-loading (James M Snell) [#5986](https://github.com/nodejs/node/pull/5986) * [[`7e739ae159`](https://github.com/nodejs/node/commit/7e739ae159)] - **test,tools**: adjust function argument alignment (Rich Trott) [#7100](https://github.com/nodejs/node/pull/7100) * [[`216486c2b6`](https://github.com/nodejs/node/commit/216486c2b6)] - **tools**: lint for function argument alignment (Rich Trott) [#7100](https://github.com/nodejs/node/pull/7100) * [[`6a76485ad7`](https://github.com/nodejs/node/commit/6a76485ad7)] - **tools**: update ESLint to 2.9.0 (Rich Trott) [#6498](https://github.com/nodejs/node/pull/6498) * [[`a31153c02c`](https://github.com/nodejs/node/commit/a31153c02c)] - **tools**: remove the minifying logic (Sakthipriyan Vairamani) [#6636](https://github.com/nodejs/node/pull/6636) * [[`10bd1a73fd`](https://github.com/nodejs/node/commit/10bd1a73fd)] - **tools**: fix license-builder.sh again for ICU (Steven R. Loomis) [#6068](https://github.com/nodejs/node/pull/6068) * [[`0f6146c6c0`](https://github.com/nodejs/node/commit/0f6146c6c0)] - **tools**: add tests for the doctool (Ian Kronquist) [#6031](https://github.com/nodejs/node/pull/6031) * [[`cc3645cff3`](https://github.com/nodejs/node/commit/cc3645cff3)] - **tools**: lint for alignment of variable assignments (Rich Trott) [#6869](https://github.com/nodejs/node/pull/6869) ## 2016-06-22, Version 4.4.6 'Argon' (LTS), @thealphanerd ### Notable Changes This is an important security release. All Node.js users should consult the security release summary at nodejs.org for details on patched vulnerabilities. This release is specifically related to a Buffer overflow vulnerability discovered in v8, more details can be found [in the CVE](https://www.cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2016-1669) ### Commits * [[`134c3b3977`](https://github.com/nodejs/node/commit/134c3b3977)] - **deps**: backport 3a9bfec from v8 upstream (Ben Noordhuis) [nodejs/node-private#38](https://github.com/nodejs/node-private/pull/38) ## 2016-05-24, Version 4.4.5 'Argon' (LTS), @thealphanerd ### Notable Changes - **buffer**: - Buffer.indexOf now returns correct values for all UTF-16 input (Anna Henningsen) [#6511](https://github.com/nodejs/node/pull/6511) - **contextify**: - Context objects are now properly garbage collected, this solves a problem some individuals were experiencing with extreme memory growth (Ali Ijaz Sheikh) [#6871](https://github.com/nodejs/node/pull/6871) - **deps**: - update npm to 2.15.5 (Rebecca Turner) [#6663](https://github.com/nodejs/node/pull/6663) - **http**: - Invalid status codes can no longer be sent. Limited to 3 digit numbers between 100 - 999 (Brian White) [#6291](https://github.com/nodejs/node/pull/6291) ### Commits * [[`59a977dd22`](https://github.com/nodejs/node/commit/59a977dd22)] - **assert**: respect assert.doesNotThrow message. (Ilya Shaisultanov) [#2407](https://github.com/nodejs/node/pull/2407) * [[`8b077faa82`](https://github.com/nodejs/node/commit/8b077faa82)] - **buffer**: fix UCS2 indexOf for odd buffer length (Anna Henningsen) [#6511](https://github.com/nodejs/node/pull/6511) * [[`12a9699fcf`](https://github.com/nodejs/node/commit/12a9699fcf)] - **buffer**: fix needle length misestimation for UCS2 (Anna Henningsen) [#6511](https://github.com/nodejs/node/pull/6511) * [[`292b1b733e`](https://github.com/nodejs/node/commit/292b1b733e)] - **build**: fix make tar-headers for Linux (Gibson Fahnestock) [#5978](https://github.com/nodejs/node/pull/5978) * [[`918d33ad4b`](https://github.com/nodejs/node/commit/918d33ad4b)] - **build**: add script to create Android .mk files (Robert Chiras) [#5544](https://github.com/nodejs/node/pull/5544) * [[`4ad71847bc`](https://github.com/nodejs/node/commit/4ad71847bc)] - **build**: add suport for x86 architecture (Robert Chiras) [#5544](https://github.com/nodejs/node/pull/5544) * [[`6ad85914b1`](https://github.com/nodejs/node/commit/6ad85914b1)] - **child_process**: add nullptr checks after allocs (Anna Henningsen) [#6256](https://github.com/nodejs/node/pull/6256) * [[`823f726f66`](https://github.com/nodejs/node/commit/823f726f66)] - **contextify**: tie lifetimes of context & sandbox (Ali Ijaz Sheikh) [#5800](https://github.com/nodejs/node/pull/5800) * [[`9ddb44ba61`](https://github.com/nodejs/node/commit/9ddb44ba61)] - **contextify**: cache sandbox and context in locals (Ali Ijaz Sheikh) [#5392](https://github.com/nodejs/node/pull/5392) * [[`8ebdcd65b0`](https://github.com/nodejs/node/commit/8ebdcd65b0)] - **contextify**: replace deprecated SetWeak usage (Ali Ijaz Sheikh) [#5392](https://github.com/nodejs/node/pull/5392) * [[`9e6d8170f7`](https://github.com/nodejs/node/commit/9e6d8170f7)] - **contextify**: cleanup weak ref for sandbox (Ali Ijaz Sheikh) [#5392](https://github.com/nodejs/node/pull/5392) * [[`b6fc15347d`](https://github.com/nodejs/node/commit/b6fc15347d)] - **contextify**: cleanup weak ref for global proxy (Ali Ijaz Sheikh) [#5392](https://github.com/nodejs/node/pull/5392) * [[`0dc875e2c7`](https://github.com/nodejs/node/commit/0dc875e2c7)] - **deps**: upgrade npm in LTS to 2.15.5 (Rebecca Turner) * [[`3c50350f41`](https://github.com/nodejs/node/commit/3c50350f41)] - **deps**: fix null pointer checks in v8 (Michaël Zasso) [#6669](https://github.com/nodejs/node/pull/6669) * [[`a40730b4b4`](https://github.com/nodejs/node/commit/a40730b4b4)] - **deps**: backport IsValid changes from 4e8736d in V8 (Michaël Zasso) [#6669](https://github.com/nodejs/node/pull/6669) * [[`855604c53a`](https://github.com/nodejs/node/commit/855604c53a)] - **deps**: upgrade npm in LTS to 2.15.4 (Rebecca Turner) [#6663](https://github.com/nodejs/node/pull/6663) * [[`433fb9a968`](https://github.com/nodejs/node/commit/433fb9a968)] - **deps**: cherry-pick 1383d00 from v8 upstream (Fedor Indutny) [#6179](https://github.com/nodejs/node/pull/6179) * [[`d1fca27ef8`](https://github.com/nodejs/node/commit/d1fca27ef8)] - **deps**: backport 125ac66 from v8 upstream (Myles Borins) [#6086](https://github.com/nodejs/node/pull/6086) * [[`df299019a0`](https://github.com/nodejs/node/commit/df299019a0)] - **deps**: upgrade npm in LTS to 2.15.2 (Kat Marchán) * [[`50f02bd8d6`](https://github.com/nodejs/node/commit/50f02bd8d6)] - **doc**: update vm.runInDebugContext() example (Ben Noordhuis) [#6757](https://github.com/nodejs/node/pull/6757) * [[`b872feade3`](https://github.com/nodejs/node/commit/b872feade3)] - **doc**: replace functions with arrow functions (abouthiroppy) [#6203](https://github.com/nodejs/node/pull/6203) * [[`7160229be4`](https://github.com/nodejs/node/commit/7160229be4)] - **doc**: note that zlib.flush acts after pending writes (Anna Henningsen) [#6172](https://github.com/nodejs/node/pull/6172) * [[`d069f2de8c`](https://github.com/nodejs/node/commit/d069f2de8c)] - **doc**: add full example for zlib.flush() (Anna Henningsen) [#6172](https://github.com/nodejs/node/pull/6172) * [[`59814acfef`](https://github.com/nodejs/node/commit/59814acfef)] - **doc**: describe child.kill() pitfalls on linux (Robert Jefe Lindstaedt) [#2098](https://github.com/nodejs/node/issues/2098) * [[`840c09492d`](https://github.com/nodejs/node/commit/840c09492d)] - **doc**: update openssl.org hash links (silverwind) [#6817](https://github.com/nodejs/node/pull/6817) * [[`126fdc3171`](https://github.com/nodejs/node/commit/126fdc3171)] - **doc**: fix issues related to page scrolling (Roman Reiss) * [[`29e25d8489`](https://github.com/nodejs/node/commit/29e25d8489)] - **doc**: add steps for running addons + npm tests (Myles Borins) [#6231](https://github.com/nodejs/node/pull/6231) * [[`fcc6a347f7`](https://github.com/nodejs/node/commit/fcc6a347f7)] - **doc**: get rid of sneaky hard tabs in CHANGELOG (Myles Borins) [#6608](https://github.com/nodejs/node/pull/6608) * [[`369569018e`](https://github.com/nodejs/node/commit/369569018e)] - **doc**: revert backported commits (Myles Borins) [#6530](https://github.com/nodejs/node/pull/6530) * [[`4ec9ae8a1c`](https://github.com/nodejs/node/commit/4ec9ae8a1c)] - **doc**: explain differences in console.assert between node and browsers (James M Snell) [#6169](https://github.com/nodejs/node/pull/6169) * [[`df5ce6fad4`](https://github.com/nodejs/node/commit/df5ce6fad4)] - **doc**: native module reloading is not supported (Bryan English) [#6168](https://github.com/nodejs/node/pull/6168) * [[`30f354f72b`](https://github.com/nodejs/node/commit/30f354f72b)] - **doc**: clarify fs.watch() and inodes on linux, os x (Joran Dirk Greef) [#6099](https://github.com/nodejs/node/pull/6099) * [[`29f821b73d`](https://github.com/nodejs/node/commit/29f821b73d)] - **doc**: clarifies http.serverResponse implementation (Allen Hernandez) [#6072](https://github.com/nodejs/node/pull/6072) * [[`6d560094f4`](https://github.com/nodejs/node/commit/6d560094f4)] - **doc**: minor argument formatting in stream.markdown (James M Snell) [#6016](https://github.com/nodejs/node/pull/6016) * [[`6a197ec617`](https://github.com/nodejs/node/commit/6a197ec617)] - **doc**: fix http response event, Agent#getName (Matthew Douglass) [#5993](https://github.com/nodejs/node/pull/5993) * [[`620a261240`](https://github.com/nodejs/node/commit/620a261240)] - **http**: disallow sending obviously invalid status codes (Brian White) [#6291](https://github.com/nodejs/node/pull/6291) * [[`9a8b53124d`](https://github.com/nodejs/node/commit/9a8b53124d)] - **http**: unref socket timer on parser execute (Fedor Indutny) [#6286](https://github.com/nodejs/node/pull/6286) * [[`b28e44deb2`](https://github.com/nodejs/node/commit/b28e44deb2)] - **http**: Corrects IPv6 address in Host header (Mihai Potra) [#5314](https://github.com/nodejs/node/pull/5314) * [[`2fac15ba94`](https://github.com/nodejs/node/commit/2fac15ba94)] - **src**: fix FindFirstCharacter argument alignment (Anna Henningsen) [#6511](https://github.com/nodejs/node/pull/6511) * [[`2942cff069`](https://github.com/nodejs/node/commit/2942cff069)] - **src**: add missing 'inline' keywords (Ben Noordhuis) [#6056](https://github.com/nodejs/node/pull/6056) * [[`e0eebf412e`](https://github.com/nodejs/node/commit/e0eebf412e)] - **src,tools**: remove null sentinel from source array (Ben Noordhuis) [#5418](https://github.com/nodejs/node/pull/5418) * [[`8f18414cd5`](https://github.com/nodejs/node/commit/8f18414cd5)] - **src,tools**: drop nul byte from built-in source code (Ben Noordhuis) [#5418](https://github.com/nodejs/node/pull/5418) * [[`d7a3ea457b`](https://github.com/nodejs/node/commit/d7a3ea457b)] - **src,tools**: allow utf-8 in built-in js source code (Ben Noordhuis) [#5418](https://github.com/nodejs/node/pull/5418) * [[`51c0808b55`](https://github.com/nodejs/node/commit/51c0808b55)] - **stream**: Fix readableState.awaitDrain mechanism (Anna Henningsen) [#6023](https://github.com/nodejs/node/pull/6023) * [[`49a5941d30`](https://github.com/nodejs/node/commit/49a5941d30)] - **test**: fix test-debug-port-cluster flakiness (Rich Trott) [#6769](https://github.com/nodejs/node/pull/6769) * [[`f8144e4c4a`](https://github.com/nodejs/node/commit/f8144e4c4a)] - **test**: add logging for test-debug-port-cluster (Rich Trott) [#6769](https://github.com/nodejs/node/pull/6769) * [[`773ea20d0e`](https://github.com/nodejs/node/commit/773ea20d0e)] - **test**: include component in tap output (Ben Noordhuis) [#6653](https://github.com/nodejs/node/pull/6653) * [[`333369e1ff`](https://github.com/nodejs/node/commit/333369e1ff)] - **test**: increase the platform timeout for AIX (Michael Dawson) [#6342](https://github.com/nodejs/node/pull/6342) * [[`06e5fafe84`](https://github.com/nodejs/node/commit/06e5fafe84)] - **test**: add tests for console.assert (Evan Lucas) [#6302](https://github.com/nodejs/node/pull/6302) * [[`f60ba54811`](https://github.com/nodejs/node/commit/f60ba54811)] - **test**: add zlib close-after-error regression test (Anna Henningsen) [#6270](https://github.com/nodejs/node/pull/6270) * [[`24ac16f4be`](https://github.com/nodejs/node/commit/24ac16f4be)] - **test**: fix flaky test-http-set-timeout-server (Santiago Gimeno) [#6248](https://github.com/nodejs/node/pull/6248) * [[`5002a71357`](https://github.com/nodejs/node/commit/5002a71357)] - **test**: assert - fixed error messages to match the tests (surya panikkal) [#6241](https://github.com/nodejs/node/pull/6241) * [[`0f9405dd33`](https://github.com/nodejs/node/commit/0f9405dd33)] - **test**: move more tests from sequential to parallel (Santiago Gimeno) [#6187](https://github.com/nodejs/node/pull/6187) * [[`37cc249218`](https://github.com/nodejs/node/commit/37cc249218)] - **test**: fix test-net-settimeout flakiness (Santiago Gimeno) [#6166](https://github.com/nodejs/node/pull/6166) * [[`69dcbb642f`](https://github.com/nodejs/node/commit/69dcbb642f)] - **test**: fix flaky test-child-process-fork-net (Rich Trott) [#6138](https://github.com/nodejs/node/pull/6138) * [[`a97a6a9d69`](https://github.com/nodejs/node/commit/a97a6a9d69)] - **test**: fix issues for ESLint 2.7.0 (silverwind) [#6132](https://github.com/nodejs/node/pull/6132) * [[`a865975909`](https://github.com/nodejs/node/commit/a865975909)] - **test**: fix flaky test-http-client-abort (Rich Trott) [#6124](https://github.com/nodejs/node/pull/6124) * [[`25d4b5b1e9`](https://github.com/nodejs/node/commit/25d4b5b1e9)] - **test**: move some test from sequential to parallel (Santiago Gimeno) [#6087](https://github.com/nodejs/node/pull/6087) * [[`28040ccf49`](https://github.com/nodejs/node/commit/28040ccf49)] - **test**: refactor test-file-write-stream3 (Rich Trott) [#6050](https://github.com/nodejs/node/pull/6050) * [[`3a67a05ed4`](https://github.com/nodejs/node/commit/3a67a05ed4)] - **test**: enforce strict mode for test-domain-crypto (Rich Trott) [#6047](https://github.com/nodejs/node/pull/6047) * [[`0b376cb3f9`](https://github.com/nodejs/node/commit/0b376cb3f9)] - **test**: fix pummel test failures (Rich Trott) [#6012](https://github.com/nodejs/node/pull/6012) * [[`7b60b8f8e9`](https://github.com/nodejs/node/commit/7b60b8f8e9)] - **test**: fix flakiness of stringbytes-external (Ali Ijaz Sheikh) [#6705](https://github.com/nodejs/node/pull/6705) * [[`cc4c5187ed`](https://github.com/nodejs/node/commit/cc4c5187ed)] - **test**: ensure test-npm-install uses correct node (Myles Borins) [#6658](https://github.com/nodejs/node/pull/6658) * [[`3d4d5777bc`](https://github.com/nodejs/node/commit/3d4d5777bc)] - **test**: refactor http-end-throw-socket-handling (Santiago Gimeno) [#5676](https://github.com/nodejs/node/pull/5676) * [[`c76f214b90`](https://github.com/nodejs/node/commit/c76f214b90)] - **test,tools**: enable linting for undefined vars (Rich Trott) [#6255](https://github.com/nodejs/node/pull/6255) * [[`9222689215`](https://github.com/nodejs/node/commit/9222689215)] - **test,vm**: enable strict mode for vm tests (Rich Trott) [#6209](https://github.com/nodejs/node/pull/6209) * [[`b8c9d6b64e`](https://github.com/nodejs/node/commit/b8c9d6b64e)] - **tools**: enable linting for v8_prof_processor.js (Rich Trott) [#6262](https://github.com/nodejs/node/pull/6262) * [[`8fa202947d`](https://github.com/nodejs/node/commit/8fa202947d)] - **tools**: lint rule for assert.fail() (Rich Trott) [#6261](https://github.com/nodejs/node/pull/6261) * [[`1aa6c5b7a9`](https://github.com/nodejs/node/commit/1aa6c5b7a9)] - **tools**: update ESLint to 2.7.0 (silverwind) [#6132](https://github.com/nodejs/node/pull/6132) * [[`68c7de4372`](https://github.com/nodejs/node/commit/68c7de4372)] - **tools**: remove simplejson dependency (Sakthipriyan Vairamani) [#6101](https://github.com/nodejs/node/pull/6101) * [[`4fb4ba98a8`](https://github.com/nodejs/node/commit/4fb4ba98a8)] - **tools**: remove disabling of already-disabled rule (Rich Trott) [#6013](https://github.com/nodejs/node/pull/6013) * [[`4e6ea7f01a`](https://github.com/nodejs/node/commit/4e6ea7f01a)] - **tools**: remove obsolete npm test-legacy command (Kat Marchán) * [[`4c73ab4302`](https://github.com/nodejs/node/commit/4c73ab4302)] - **tools,doc**: fix json for grouped optional params (firedfox) [#5977](https://github.com/nodejs/node/pull/5977) * [[`c893cd33d1`](https://github.com/nodejs/node/commit/c893cd33d1)] - **tools,doc**: parse types in braces everywhere (Alexander Makarenko) [#5329](https://github.com/nodejs/node/pull/5329) * [[`48684af55f`](https://github.com/nodejs/node/commit/48684af55f)] - **zlib**: fix use after null when calling .close (James Lal) [#5982](https://github.com/nodejs/node/pull/5982) ## 2016-05-05, Version 4.4.4 'Argon' (LTS), @thealphanerd ### Notable changes * **deps**: * update openssl to 1.0.2h. (Shigeki Ohtsu) [#6551](https://github.com/nodejs/node/pull/6551) - Please see our [blog post](https://nodejs.org/en/blog/vulnerability/openssl-may-2016/) for more info on the security contents of this release. ### Commits * [[`f46952e727`](https://github.com/nodejs/node/commit/f46952e727)] - **buffer**: safeguard against accidental kNoZeroFill (Сковорода Никита Андреевич) [nodejs/node-private#30](https://github.com/nodejs/node-private/pull/30) * [[`4f1c82f995`](https://github.com/nodejs/node/commit/4f1c82f995)] - **streams**: support unlimited synchronous cork/uncork cycles (Matteo Collina) [#6164](https://github.com/nodejs/node/pull/6164) * [[`1efd96c767`](https://github.com/nodejs/node/commit/1efd96c767)] - **deps**: update openssl asm and asm_obsolete files (Shigeki Ohtsu) [#6551](https://github.com/nodejs/node/pull/6551) * [[`c450f4a293`](https://github.com/nodejs/node/commit/c450f4a293)] - **deps**: add -no_rand_screen to openssl s_client (Shigeki Ohtsu) [nodejs/io.js#1836](https://github.com/nodejs/io.js/pull/1836) * [[`baedfbae6a`](https://github.com/nodejs/node/commit/baedfbae6a)] - **openssl**: fix keypress requirement in apps on win32 (Shigeki Ohtsu) [iojs/io.js#1389](https://github.com/iojs/io.js/pull/1389) * [[`ff3045e40b`](https://github.com/nodejs/node/commit/ff3045e40b)] - **deps**: fix asm build error of openssl in x86_win32 (Shigeki Ohtsu) [iojs/io.js#1389](https://github.com/iojs/io.js/pull/1389) * [[`dc8dc97db3`](https://github.com/nodejs/node/commit/dc8dc97db3)] - **deps**: fix openssl assembly error on ia32 win32 (Fedor Indutny) [iojs/io.js#1389](https://github.com/iojs/io.js/pull/1389) * [[`2dfeb01213`](https://github.com/nodejs/node/commit/2dfeb01213)] - **deps**: copy all openssl header files to include dir (Shigeki Ohtsu) [#6551](https://github.com/nodejs/node/pull/6551) * [[`72f9952516`](https://github.com/nodejs/node/commit/72f9952516)] - **deps**: upgrade openssl sources to 1.0.2h (Shigeki Ohtsu) [#6551](https://github.com/nodejs/node/pull/6551) ## 2016-04-12, Version 4.4.3 'Argon' (LTS), @thealphanerd ### Notable Changes * **deps**: - Fix `--gdbjit` for embedders. Backported from v8 upstream. (Ben Noordhuis) [#5577](https://github.com/nodejs/node/pull/5577) * **etw**: - Correctly display descriptors for ETW events 9 and 23 on the windows platform. (João Reis) [#5742](https://github.com/nodejs/node/pull/5742) * **querystring**: - Restore throw when attempting to stringify bad surrogate pair. (Brian White) [#5858](https://github.com/nodejs/node/pull/5858) ### Commits * [[`f949c273cd`](https://github.com/nodejs/node/commit/f949c273cd)] - **assert**: Check typed array view type in deepEqual (Anna Henningsen) [#5910](https://github.com/nodejs/node/pull/5910) * [[`132acea0d4`](https://github.com/nodejs/node/commit/132acea0d4)] - **build**: introduce ci targets for lint/benchmark (Johan Bergström) [#5921](https://github.com/nodejs/node/pull/5921) * [[`9a8f922dee`](https://github.com/nodejs/node/commit/9a8f922dee)] - **build**: add missing `openssl_fips%` to common.gypi (Fedor Indutny) [#5919](https://github.com/nodejs/node/pull/5919) * [[`d275cdf202`](https://github.com/nodejs/node/commit/d275cdf202)] - **child_process**: refactor self=this in socket_list (Benjamin Gruenbaum) [#5860](https://github.com/nodejs/node/pull/5860) * [[`aadf356aa2`](https://github.com/nodejs/node/commit/aadf356aa2)] - **deps**: backport 8d00c2c from v8 upstream (Ben Noordhuis) [#5577](https://github.com/nodejs/node/pull/5577) * [[`200f763c43`](https://github.com/nodejs/node/commit/200f763c43)] - **deps**: completely upgrade npm in LTS to 2.15.1 (Forrest L Norvell) [#5989](https://github.com/nodejs/node/pull/5989) * [[`86e3903626`](https://github.com/nodejs/node/commit/86e3903626)] - **dns**: Use object without protoype for map (Benjamin Gruenbaum) [#5843](https://github.com/nodejs/node/pull/5843) * [[`9a33f43f73`](https://github.com/nodejs/node/commit/9a33f43f73)] - **doc**: update openssl LICENSE using license-builder.sh (Steven R. Loomis) [#6065](https://github.com/nodejs/node/pull/6065) * [[`9679e2dc70`](https://github.com/nodejs/node/commit/9679e2dc70)] - **doc**: clarify that __dirname is module local (James M Snell) [#6018](https://github.com/nodejs/node/pull/6018) * [[`86d2af58d6`](https://github.com/nodejs/node/commit/86d2af58d6)] - **doc**: simple doc typo fix (Brendon Pierson) [#6041](https://github.com/nodejs/node/pull/6041) * [[`f16802f3ca`](https://github.com/nodejs/node/commit/f16802f3ca)] - **doc**: note about Android support (Rich Trott) [#6040](https://github.com/nodejs/node/pull/6040) * [[`8c2befe176`](https://github.com/nodejs/node/commit/8c2befe176)] - **doc**: note assert.throws() pitfall (Rich Trott) [#6029](https://github.com/nodejs/node/pull/6029) * [[`0870ac65f2`](https://github.com/nodejs/node/commit/0870ac65f2)] - **doc**: use HTTPS for links where possible (Rich Trott) [#6019](https://github.com/nodejs/node/pull/6019) * [[`56755de96e`](https://github.com/nodejs/node/commit/56755de96e)] - **doc**: clarify stdout/stderr arguments to callback (James M Snell) [#6015](https://github.com/nodejs/node/pull/6015) * [[`bb603b89a2`](https://github.com/nodejs/node/commit/bb603b89a2)] - **doc**: add 'Command Line Options' to 'View on single page' (firedfox) [#6011](https://github.com/nodejs/node/pull/6011) * [[`c91f3d897a`](https://github.com/nodejs/node/commit/c91f3d897a)] - **doc**: add copy about how to curl SHA256.txt (Myles Borins) [#6120](https://github.com/nodejs/node/pull/6120) * [[`f9cf232284`](https://github.com/nodejs/node/commit/f9cf232284)] - **doc**: add example using algorithms not directly exposed (Brad Hill) [#6108](https://github.com/nodejs/node/pull/6108) * [[`f60ce1078d`](https://github.com/nodejs/node/commit/f60ce1078d)] - **doc**: document unspecified behavior for buf.write* methods (James M Snell) [#5925](https://github.com/nodejs/node/pull/5925) * [[`02401a6cbd`](https://github.com/nodejs/node/commit/02401a6cbd)] - **doc**: fix scrolling on iOS devices (Luigi Pinca) [#5878](https://github.com/nodejs/node/pull/5878) * [[`aed22d0855`](https://github.com/nodejs/node/commit/aed22d0855)] - **doc**: path.format provide more examples (John Eversole) [#5838](https://github.com/nodejs/node/pull/5838) * [[`6e2bfbe1fd`](https://github.com/nodejs/node/commit/6e2bfbe1fd)] - **doc**: fix doc for Buffer.readInt32LE() (ghaiklor) [#5890](https://github.com/nodejs/node/pull/5890) * [[`940d204401`](https://github.com/nodejs/node/commit/940d204401)] - **doc**: consolidate timers docs in timers.markdown (Bryan English) [#5837](https://github.com/nodejs/node/pull/5837) * [[`505faf6360`](https://github.com/nodejs/node/commit/505faf6360)] - **doc**: refine child_process detach behaviour (Robert Jefe Lindstaedt) [#5330](https://github.com/nodejs/node/pull/5330) * [[`feedca7879`](https://github.com/nodejs/node/commit/feedca7879)] - **doc**: add topic - event loop, timers, `nextTick()` (Jeff Harris) [#4936](https://github.com/nodejs/node/pull/4936) * [[`6d3822c12b`](https://github.com/nodejs/node/commit/6d3822c12b)] - **etw**: fix descriptors of events 9 and 23 (João Reis) [#5742](https://github.com/nodejs/node/pull/5742) * [[`56dda6f336`](https://github.com/nodejs/node/commit/56dda6f336)] - **fs**: Remove unused branches (Benjamin Gruenbaum) [#5289](https://github.com/nodejs/node/pull/5289) * [[`dfe9e157c1`](https://github.com/nodejs/node/commit/dfe9e157c1)] - **governance**: remove target size for CTC (Rich Trott) [#5879](https://github.com/nodejs/node/pull/5879) * [[`c4103b154f`](https://github.com/nodejs/node/commit/c4103b154f)] - **lib**: refactor code with startsWith/endsWith (Jackson Tian) [#5753](https://github.com/nodejs/node/pull/5753) * [[`16216a81de`](https://github.com/nodejs/node/commit/16216a81de)] - **meta**: add "joining a wg" section to WORKING_GROUPS.md (Matteo Collina) [#5488](https://github.com/nodejs/node/pull/5488) * [[`65fc4e36ce`](https://github.com/nodejs/node/commit/65fc4e36ce)] - **querystring**: don't stringify bad surrogate pair (Brian White) [#5858](https://github.com/nodejs/node/pull/5858) * [[`4f683ab912`](https://github.com/nodejs/node/commit/4f683ab912)] - **src,tools**: use template literals (Rich Trott) [#5778](https://github.com/nodejs/node/pull/5778) * [[`ac40a4510d`](https://github.com/nodejs/node/commit/ac40a4510d)] - **test**: explicitly set global in test-repl (Rich Trott) [#6026](https://github.com/nodejs/node/pull/6026) * [[`a7b3a7533a`](https://github.com/nodejs/node/commit/a7b3a7533a)] - **test**: be explicit about polluting of `global` (Rich Trott) [#6017](https://github.com/nodejs/node/pull/6017) * [[`73e3b7b9a8`](https://github.com/nodejs/node/commit/73e3b7b9a8)] - **test**: make use of globals explicit (Rich Trott) [#6014](https://github.com/nodejs/node/pull/6014) * [[`e7877e61b6`](https://github.com/nodejs/node/commit/e7877e61b6)] - **test**: fix flaky test-net-socket-timeout-unref (Rich Trott) [#6003](https://github.com/nodejs/node/pull/6003) * [[`a39051f5b3`](https://github.com/nodejs/node/commit/a39051f5b3)] - **test**: make arch available in status files (Santiago Gimeno) [#5997](https://github.com/nodejs/node/pull/5997) * [[`ccf90b651a`](https://github.com/nodejs/node/commit/ccf90b651a)] - **test**: fix test-dns.js flakiness (Rich Trott) [#5996](https://github.com/nodejs/node/pull/5996) * [[`1994ac0912`](https://github.com/nodejs/node/commit/1994ac0912)] - **test**: add test for piping large input from stdin (Anna Henningsen) [#5949](https://github.com/nodejs/node/pull/5949) * [[`cc1aab9f6a`](https://github.com/nodejs/node/commit/cc1aab9f6a)] - **test**: mitigate flaky test-https-agent (Rich Trott) [#5939](https://github.com/nodejs/node/pull/5939) * [[`10fe79b809`](https://github.com/nodejs/node/commit/10fe79b809)] - **test**: fix offending max-len linter error (Sakthipriyan Vairamani) [#5980](https://github.com/nodejs/node/pull/5980) * [[`63d82960fd`](https://github.com/nodejs/node/commit/63d82960fd)] - **test**: stdin is not always a net.Socket (Jeremiah Senkpiel) [#5935](https://github.com/nodejs/node/pull/5935) * [[`fe0233b923`](https://github.com/nodejs/node/commit/fe0233b923)] - **test**: add known_issues test for GH-2148 (Rich Trott) [#5920](https://github.com/nodejs/node/pull/5920) * [[`d59be4d248`](https://github.com/nodejs/node/commit/d59be4d248)] - **test**: ensure _handle property existence (Rich Trott) [#5916](https://github.com/nodejs/node/pull/5916) * [[`9702153107`](https://github.com/nodejs/node/commit/9702153107)] - **test**: fix flaky test-repl (Brian White) [#5914](https://github.com/nodejs/node/pull/5914) * [[`a0a2e69097`](https://github.com/nodejs/node/commit/a0a2e69097)] - **test**: move dns test to test/internet (Ben Noordhuis) [#5905](https://github.com/nodejs/node/pull/5905) * [[`8462d8f465`](https://github.com/nodejs/node/commit/8462d8f465)] - **test**: fix flaky test-net-socket-timeout (Brian White) [#5902](https://github.com/nodejs/node/pull/5902) * [[`e0b283af73`](https://github.com/nodejs/node/commit/e0b283af73)] - **test**: fix flaky test-http-set-timeout (Rich Trott) [#5856](https://github.com/nodejs/node/pull/5856) * [[`5853fec36f`](https://github.com/nodejs/node/commit/5853fec36f)] - **test**: fix test-debugger-client.js (Rich Trott) [#5851](https://github.com/nodejs/node/pull/5851) * [[`ea83c382f9`](https://github.com/nodejs/node/commit/ea83c382f9)] - **test**: ensure win32.isAbsolute() is consistent (Brian White) [#6043](https://github.com/nodejs/node/pull/6043) * [[`c33a23fd1e`](https://github.com/nodejs/node/commit/c33a23fd1e)] - **tools**: fix json doc generation (firedfox) [#5943](https://github.com/nodejs/node/pull/5943) * [[`6f0bd64122`](https://github.com/nodejs/node/commit/6f0bd64122)] - **tools,doc**: fix incomplete json produced by doctool (firedfox) [#5966](https://github.com/nodejs/node/pull/5966) * [[`f7eb48302c`](https://github.com/nodejs/node/commit/f7eb48302c)] - **win,build**: build and test add-ons on test-ci (Bogdan Lobor) [#5886](https://github.com/nodejs/node/pull/5886) ## 2016-03-31, Version 4.4.2 'Argon' (LTS), @thealphanerd ### Notable Changes * **https**: - Under certain conditions ssl sockets may have been causing a memory leak when keepalive is enabled. This is no longer the case. (Alexander Penev) [#5713](https://github.com/nodejs/node/pull/5713) * **lib**: - The way that we were internally passing arguments was causing a potential leak. By copying the arguments into an array we can avoid this. (Nathan Woltman) [#4361](https://github.com/nodejs/node/pull/4361) * **npm**: - Upgrade to v2.15.1. Fixes a security flaw in the use of authentication tokens in HTTP requests that would allow an attacker to set up a server that could collect tokens from users of the command-line interface. Authentication tokens have previously been sent with every request made by the CLI for logged-in users, regardless of the destination of the request. This update fixes this by only including those tokens for requests made against the registry or registries used for the current install. (Forrest L Norvell) * **repl**: - Previously if you were using the repl in strict mode the column number would be wrong in a stack trace. This is no longer an issue. (Prince J Wesley) [#5416](https://github.com/nodejs/node/pull/5416) ### Commits * [[`96e163a79f`](https://github.com/nodejs/node/commit/96e163a79f)] - **buffer**: changing let in for loops back to var (Gareth Ellis) [#5819](https://github.com/nodejs/node/pull/5819) * [[`0c6f6742f2`](https://github.com/nodejs/node/commit/0c6f6742f2)] - **console**: check that stderr is writable (Rich Trott) [#5635](https://github.com/nodejs/node/pull/5635) * [[`55c3f804c4`](https://github.com/nodejs/node/commit/55c3f804c4)] - **deps**: upgrade npm in LTS to 2.15.1 (Forrest L Norvell) * [[`1d0e4a987d`](https://github.com/nodejs/node/commit/1d0e4a987d)] - **deps**: remove unused openssl files (Ben Noordhuis) [#5619](https://github.com/nodejs/node/pull/5619) * [[`d55599f4d8`](https://github.com/nodejs/node/commit/d55599f4d8)] - **dns**: use template literals (Benjamin Gruenbaum) [#5809](https://github.com/nodejs/node/pull/5809) * [[`42bbdc9dd1`](https://github.com/nodejs/node/commit/42bbdc9dd1)] - **doc** Add @mhdawson back to the CTC (James M Snell) [#5633](https://github.com/nodejs/node/pull/5633) * [[`8d86d232e7`](https://github.com/nodejs/node/commit/8d86d232e7)] - **doc**: typo: interal->internal. (Corey Kosak) [#5849](https://github.com/nodejs/node/pull/5849) * [[`60ddab841e`](https://github.com/nodejs/node/commit/60ddab841e)] - **doc**: add instructions to only sign a release (Jeremiah Senkpiel) [#5876](https://github.com/nodejs/node/pull/5876) * [[`040263e0f3`](https://github.com/nodejs/node/commit/040263e0f3)] - **doc**: grammar, clarity and links in timers doc (Bryan English) [#5792](https://github.com/nodejs/node/pull/5792) * [[`8c24bd25a6`](https://github.com/nodejs/node/commit/8c24bd25a6)] - **doc**: fix order of end tags of list after heading (firedfox) [#5874](https://github.com/nodejs/node/pull/5874) * [[`7c837028da`](https://github.com/nodejs/node/commit/7c837028da)] - **doc**: use consistent event name parameter (Benjamin Gruenbaum) [#5850](https://github.com/nodejs/node/pull/5850) * [[`20faf9097d`](https://github.com/nodejs/node/commit/20faf9097d)] - **doc**: explain error message on missing main file (Wolfgang Steiner) [#5812](https://github.com/nodejs/node/pull/5812) * [[`79d26ae196`](https://github.com/nodejs/node/commit/79d26ae196)] - **doc**: explain path.format expected properties (John Eversole) [#5801](https://github.com/nodejs/node/pull/5801) * [[`e43e8e3a31`](https://github.com/nodejs/node/commit/e43e8e3a31)] - **doc**: add a cli options doc page (Jeremiah Senkpiel) [#5787](https://github.com/nodejs/node/pull/5787) * [[`c0a24e4a1d`](https://github.com/nodejs/node/commit/c0a24e4a1d)] - **doc**: fix multiline return comments in querystring (Claudio Rodriguez) [#5705](https://github.com/nodejs/node/pull/5705) * [[`bf1fe4693c`](https://github.com/nodejs/node/commit/bf1fe4693c)] - **doc**: Add windows example for Path.format (Mithun Patel) [#5700](https://github.com/nodejs/node/pull/5700) * [[`3b8fc4fddc`](https://github.com/nodejs/node/commit/3b8fc4fddc)] - **doc**: update crypto docs to use good defaults (Bill Automata) [#5505](https://github.com/nodejs/node/pull/5505) * [[`a6ec8a6cb7`](https://github.com/nodejs/node/commit/a6ec8a6cb7)] - **doc**: fix crypto update() signatures (Brian White) [#5500](https://github.com/nodejs/node/pull/5500) * [[`eb0ed46665`](https://github.com/nodejs/node/commit/eb0ed46665)] - **doc**: reformat & improve node.1 manual page (Jeremiah Senkpiel) [#5497](https://github.com/nodejs/node/pull/5497) * [[`b70ca4a4b4`](https://github.com/nodejs/node/commit/b70ca4a4b4)] - **doc**: updated fs #5862 removed irrelevant data in fs.markdown (topal) [#5877](https://github.com/nodejs/node/pull/5877) * [[`81876612f7`](https://github.com/nodejs/node/commit/81876612f7)] - **https**: fix ssl socket leak when keepalive is used (Alexander Penev) [#5713](https://github.com/nodejs/node/pull/5713) * [[`6daebdbd9b`](https://github.com/nodejs/node/commit/6daebdbd9b)] - **lib**: simplify code with String.prototype.repeat() (Jackson Tian) [#5359](https://github.com/nodejs/node/pull/5359) * [[`108fc90dd7`](https://github.com/nodejs/node/commit/108fc90dd7)] - **lib**: reduce usage of `self = this` (Jackson Tian) [#5231](https://github.com/nodejs/node/pull/5231) * [[`3c8e59c396`](https://github.com/nodejs/node/commit/3c8e59c396)] - **lib**: copy arguments object instead of leaking it (Nathan Woltman) [#4361](https://github.com/nodejs/node/pull/4361) * [[`8648420586`](https://github.com/nodejs/node/commit/8648420586)] - **net**: make `isIPv4` and `isIPv6` more efficient (Vladimir Kurchatkin) [#5478](https://github.com/nodejs/node/pull/5478) * [[`07b7172d76`](https://github.com/nodejs/node/commit/07b7172d76)] - **net**: remove unused `var self = this` from old code (Benjamin Gruenbaum) [#5224](https://github.com/nodejs/node/pull/5224) * [[`acbce4b72b`](https://github.com/nodejs/node/commit/acbce4b72b)] - **repl**: fix stack trace column number in strict mode (Prince J Wesley) [#5416](https://github.com/nodejs/node/pull/5416) * [[`0a1eb168e0`](https://github.com/nodejs/node/commit/0a1eb168e0)] - **test**: fix `test-cluster-worker-kill` (Santiago Gimeno) [#5814](https://github.com/nodejs/node/pull/5814) * [[`86b876fe7b`](https://github.com/nodejs/node/commit/86b876fe7b)] - **test**: smaller chunk size for smaller person.jpg (Jérémy Lal) [#5813](https://github.com/nodejs/node/pull/5813) * [[`1135ee97e7`](https://github.com/nodejs/node/commit/1135ee97e7)] - **test**: strip non-free icc profile from person.jpg (Jérémy Lal) [#5813](https://github.com/nodejs/node/pull/5813) * [[`0836d7e2fb`](https://github.com/nodejs/node/commit/0836d7e2fb)] - **test**: fix flaky test-cluster-shared-leak (Claudio Rodriguez) [#5802](https://github.com/nodejs/node/pull/5802) * [[`e57355c2f4`](https://github.com/nodejs/node/commit/e57355c2f4)] - **test**: make test-net-connect-options-ipv6.js better (Michael Dawson) [#5791](https://github.com/nodejs/node/pull/5791) * [[`1b266fc15c`](https://github.com/nodejs/node/commit/1b266fc15c)] - **test**: remove the use of curl in the test suite (Santiago Gimeno) [#5750](https://github.com/nodejs/node/pull/5750) * [[`7e45d4f076`](https://github.com/nodejs/node/commit/7e45d4f076)] - **test**: minimize test-http-get-pipeline-problem (Rich Trott) [#5728](https://github.com/nodejs/node/pull/5728) * [[`78effc3484`](https://github.com/nodejs/node/commit/78effc3484)] - **test**: add batch of known issue tests (cjihrig) [#5653](https://github.com/nodejs/node/pull/5653) * [[`d506eea4b7`](https://github.com/nodejs/node/commit/d506eea4b7)] - **test**: improve test-npm-install (Santiago Gimeno) [#5613](https://github.com/nodejs/node/pull/5613) * [[`7520100e8b`](https://github.com/nodejs/node/commit/7520100e8b)] - **test**: add test-npm-install to parallel tests suite (Myles Borins) [#5166](https://github.com/nodejs/node/pull/5166) * [[`b258dddb8c`](https://github.com/nodejs/node/commit/b258dddb8c)] - **test**: repl tab completion test (Santiago Gimeno) [#5534](https://github.com/nodejs/node/pull/5534) * [[`f209effe8b`](https://github.com/nodejs/node/commit/f209effe8b)] - **test**: remove timer from test-http-1.0 (Santiago Gimeno) [#5129](https://github.com/nodejs/node/pull/5129) * [[`3a901b0e3e`](https://github.com/nodejs/node/commit/3a901b0e3e)] - **tools**: remove unused imports (Sakthipriyan Vairamani) [#5765](https://github.com/nodejs/node/pull/5765) ## 2016-03-22, Version 4.4.1 'Argon' (LTS), @thealphanerd This LTS release comes with 113 commits, 56 of which are doc related, 18 of which are build / tooling related, 16 of which are test related and 7 which are benchmark related. ### Notable Changes * **build**: - Updated Logos for the OSX + Windows installers - (Rod Vagg) [#5401](https://github.com/nodejs/node/pull/5401) - (Robert Jefe Lindstaedt) [#5531](https://github.com/nodejs/node/pull/5531) - New option to select your VS Version in the Windows installer - (julien.waechter) [#4645](https://github.com/nodejs/node/pull/4645) - Support Visual C++ Build Tools 2015 - (João Reis) [#5627](https://github.com/nodejs/node/pull/5627) * **tools**: - Gyp now works on OSX without XCode - (Shigeki Ohtsu) [nodejs/node#1325](https://github.com/nodejs/node/pull/1325) ### Commits * [[`df283f8a03`](https://github.com/nodejs/node/commit/df283f8a03)] - **benchmark**: fix linting issues (Rich Trott) [#5773](https://github.com/nodejs/node/pull/5773) * [[`c901741c60`](https://github.com/nodejs/node/commit/c901741c60)] - **benchmark**: use strict mode (Rich Trott) [#5773](https://github.com/nodejs/node/pull/5773) * [[`4be2065dbc`](https://github.com/nodejs/node/commit/4be2065dbc)] - **benchmark**: refactor to eliminate redeclared vars (Rich Trott) [#5773](https://github.com/nodejs/node/pull/5773) * [[`ddac368533`](https://github.com/nodejs/node/commit/ddac368533)] - **benchmark**: fix lint errors (Rich Trott) [#5773](https://github.com/nodejs/node/pull/5773) * [[`03b20a73b9`](https://github.com/nodejs/node/commit/03b20a73b9)] - **benchmark**: add benchmark for buf.compare() (Rich Trott) [#5441](https://github.com/nodejs/node/pull/5441) * [[`b816044845`](https://github.com/nodejs/node/commit/b816044845)] - **buffer**: remove duplicated code in fromObject (HUANG Wei) [#4948](https://github.com/nodejs/node/pull/4948) * [[`067ce9b905`](https://github.com/nodejs/node/commit/067ce9b905)] - **build**: don't install github templates (Johan Bergström) [#5612](https://github.com/nodejs/node/pull/5612) * [[`a1772dc515`](https://github.com/nodejs/node/commit/a1772dc515)] - **build**: update Node.js logo on OSX installer (Rod Vagg) [#5401](https://github.com/nodejs/node/pull/5401) * [[`9058fc0383`](https://github.com/nodejs/node/commit/9058fc0383)] - **build**: correctly detect clang version (Stefan Budeanu) [#5553](https://github.com/nodejs/node/pull/5553) * [[`1165ecc6f7`](https://github.com/nodejs/node/commit/1165ecc6f7)] - **build**: update Node.js logo on Win installer (Robert Jefe Lindstaedt) [#5531](https://github.com/nodejs/node/pull/5531) * [[`4990ddad72`](https://github.com/nodejs/node/commit/4990ddad72)] - **build**: remove --quiet from eslint invocation (firedfox) [#5519](https://github.com/nodejs/node/pull/5519) * [[`46a5d519dd`](https://github.com/nodejs/node/commit/46a5d519dd)] - **build**: skip msi build if WiX is not found (Tsarevich Dmitry) [#5220](https://github.com/nodejs/node/pull/5220) * [[`dac4e64491`](https://github.com/nodejs/node/commit/dac4e64491)] - **build**: add option to select VS version (julien.waechter) [#4645](https://github.com/nodejs/node/pull/4645) * [[`7a10fd3a56`](https://github.com/nodejs/node/commit/7a10fd3a56)] - **collaborator_guide**: clarify commit message rules (Wyatt Preul) [#5661](https://github.com/nodejs/node/pull/5661) * [[`97e95d04c2`](https://github.com/nodejs/node/commit/97e95d04c2)] - **crypto**: PBKDF2 works with `int` not `ssize_t` (Fedor Indutny) [#5397](https://github.com/nodejs/node/pull/5397) * [[`57b02e6a3e`](https://github.com/nodejs/node/commit/57b02e6a3e)] - **debugger**: remove unneeded callback check (Rich Trott) [#5319](https://github.com/nodejs/node/pull/5319) * [[`19ae308867`](https://github.com/nodejs/node/commit/19ae308867)] - **deps**: update openssl config (Shigeki Ohtsu) [#5630](https://github.com/nodejs/node/pull/5630) * [[`d7b81b5bc7`](https://github.com/nodejs/node/commit/d7b81b5bc7)] - **deps**: cherry-pick 2e4da65 from v8's 4.8 upstream (Michael Dawson) [#5293](https://github.com/nodejs/node/pull/5293) * [[`1e05f371d6`](https://github.com/nodejs/node/commit/1e05f371d6)] - **doc**: fix typo in synchronous randomBytes example (Andrea Giammarchi) [#5781](https://github.com/nodejs/node/pull/5781) * [[`5f54bd2088`](https://github.com/nodejs/node/commit/5f54bd2088)] - **doc**: topic blocking vs non-blocking (Jarrett Widman) [#5326](https://github.com/nodejs/node/pull/5326) * [[`0943001563`](https://github.com/nodejs/node/commit/0943001563)] - **doc**: fix invalid path doc comments (Rich Trott) [#5797](https://github.com/nodejs/node/pull/5797) * [[`bb423bb1e6`](https://github.com/nodejs/node/commit/bb423bb1e6)] - **doc**: update release tweet template (Jeremiah Senkpiel) [#5628](https://github.com/nodejs/node/pull/5628) * [[`1e877f10aa`](https://github.com/nodejs/node/commit/1e877f10aa)] - **doc**: fix typo in child_process docs (Benjamin Gruenbaum) [#5681](https://github.com/nodejs/node/pull/5681) * [[`d53dcc599b`](https://github.com/nodejs/node/commit/d53dcc599b)] - **doc**: update fansworld-claudio username on README (Claudio Rodriguez) [#5680](https://github.com/nodejs/node/pull/5680) * [[`4332f8011e`](https://github.com/nodejs/node/commit/4332f8011e)] - **doc**: fix return value of write methods (Felix Böhm) [#5736](https://github.com/nodejs/node/pull/5736) * [[`e572542de5`](https://github.com/nodejs/node/commit/e572542de5)] - **doc**: Add note about use of JSON.stringify() (Mithun Patel) [#5723](https://github.com/nodejs/node/pull/5723) * [[`daf3ef66ef`](https://github.com/nodejs/node/commit/daf3ef66ef)] - **doc**: explain path.format() algorithm (Rich Trott) [#5688](https://github.com/nodejs/node/pull/5688) * [[`f6d4982aa0`](https://github.com/nodejs/node/commit/f6d4982aa0)] - **doc**: clarify type of first argument in zlib (Kirill Fomichev) [#5685](https://github.com/nodejs/node/pull/5685) * [[`07e71b2d44`](https://github.com/nodejs/node/commit/07e71b2d44)] - **doc**: fix typo in api/addons (Daijiro Wachi) [#5678](https://github.com/nodejs/node/pull/5678) * [[`c6dc56175b`](https://github.com/nodejs/node/commit/c6dc56175b)] - **doc**: remove non-standard use of hyphens (Stefano Vozza) * [[`4c92316972`](https://github.com/nodejs/node/commit/4c92316972)] - **doc**: add fansworld-claudio to collaborators (Claudio Rodriguez) [#5668](https://github.com/nodejs/node/pull/5668) * [[`0a6e883f85`](https://github.com/nodejs/node/commit/0a6e883f85)] - **doc**: add thekemkid to collaborators (Glen Keane) [#5667](https://github.com/nodejs/node/pull/5667) * [[`39c7d8a972`](https://github.com/nodejs/node/commit/39c7d8a972)] - **doc**: add AndreasMadsen to collaborators (Andreas Madsen) [#5666](https://github.com/nodejs/node/pull/5666) * [[`eec3008970`](https://github.com/nodejs/node/commit/eec3008970)] - **doc**: add whitlockjc to collaborators (Jeremy Whitlock) [#5665](https://github.com/nodejs/node/pull/5665) * [[`e5f254d83c`](https://github.com/nodejs/node/commit/e5f254d83c)] - **doc**: add benjamingr to collaborator list (Benjamin Gruenbaum) [#5664](https://github.com/nodejs/node/pull/5664) * [[`3f718643c9`](https://github.com/nodejs/node/commit/3f718643c9)] - **doc**: add phillipj to collaborators (Phillip Johnsen) [#5663](https://github.com/nodejs/node/pull/5663) * [[`2d5527fe69`](https://github.com/nodejs/node/commit/2d5527fe69)] - **doc**: add mattloring to collaborators (Matt Loring) [#5662](https://github.com/nodejs/node/pull/5662) * [[`51763462bc`](https://github.com/nodejs/node/commit/51763462bc)] - **doc**: include typo in 'unhandledRejection' example (Robert C Jensen) [#5654](https://github.com/nodejs/node/pull/5654) * [[`cae5da2f0a`](https://github.com/nodejs/node/commit/cae5da2f0a)] - **doc**: fix markdown links (Steve Mao) [#5641](https://github.com/nodejs/node/pull/5641) * [[`b1b17efcb7`](https://github.com/nodejs/node/commit/b1b17efcb7)] - **doc**: move build instructions to a new document (Johan Bergström) [#5634](https://github.com/nodejs/node/pull/5634) * [[`13a8bde1fa`](https://github.com/nodejs/node/commit/13a8bde1fa)] - **doc**: fix dns.resolveCname description typo (axvm) [#5622](https://github.com/nodejs/node/pull/5622) * [[`1faea43c40`](https://github.com/nodejs/node/commit/1faea43c40)] - **doc**: fix typo in fs.symlink (Michaël Zasso) [#5560](https://github.com/nodejs/node/pull/5560) * [[`98a1bb6989`](https://github.com/nodejs/node/commit/98a1bb6989)] - **doc**: document directories in test directory (Michael Barrett) [#5557](https://github.com/nodejs/node/pull/5557) * [[`04d3f8a741`](https://github.com/nodejs/node/commit/04d3f8a741)] - **doc**: update link green to match homepage (silverwind) [#5548](https://github.com/nodejs/node/pull/5548) * [[`1afab6ac9c`](https://github.com/nodejs/node/commit/1afab6ac9c)] - **doc**: add clarification on birthtime in fs stat (Kári Tristan Helgason) [#5479](https://github.com/nodejs/node/pull/5479) * [[`d871ae2349`](https://github.com/nodejs/node/commit/d871ae2349)] - **doc**: fix typo in child_process documentation (Evan Lucas) [#5474](https://github.com/nodejs/node/pull/5474) * [[`97a18bdbad`](https://github.com/nodejs/node/commit/97a18bdbad)] - **doc**: update NAN urls in ROADMAP.md and doc/releases.md (ronkorving) [#5472](https://github.com/nodejs/node/pull/5472) * [[`d4a1fc7acd`](https://github.com/nodejs/node/commit/d4a1fc7acd)] - **doc**: add Testing WG (Rich Trott) [#5461](https://github.com/nodejs/node/pull/5461) * [[`1642078580`](https://github.com/nodejs/node/commit/1642078580)] - **doc**: fix crypto function indentation level (Brian White) [#5460](https://github.com/nodejs/node/pull/5460) * [[`2b0c7ad985`](https://github.com/nodejs/node/commit/2b0c7ad985)] - **doc**: fix links in tls, cluster docs (Alexander Makarenko) [#5364](https://github.com/nodejs/node/pull/5364) * [[`901dbabea6`](https://github.com/nodejs/node/commit/901dbabea6)] - **doc**: fix relative links in net docs (Evan Lucas) [#5358](https://github.com/nodejs/node/pull/5358) * [[`38d429172d`](https://github.com/nodejs/node/commit/38d429172d)] - **doc**: fix typo in pbkdf2Sync code sample (Marc Cuva) [#5306](https://github.com/nodejs/node/pull/5306) * [[`d4cfc6f97c`](https://github.com/nodejs/node/commit/d4cfc6f97c)] - **doc**: add missing property in cluster example (Rafael Cepeda) [#5305](https://github.com/nodejs/node/pull/5305) * [[`b66d6b1458`](https://github.com/nodejs/node/commit/b66d6b1458)] - **doc**: improve httpVersionMajor / httpVersionMajor (Jackson Tian) [#5296](https://github.com/nodejs/node/pull/5296) * [[`70c872c9c4`](https://github.com/nodejs/node/commit/70c872c9c4)] - **doc**: improve unhandledException doc copy (James M Snell) [#5287](https://github.com/nodejs/node/pull/5287) * [[`ba5e0b6110`](https://github.com/nodejs/node/commit/ba5e0b6110)] - **doc**: fix buf.readInt16LE output (Chinedu Francis Nwafili) [#5282](https://github.com/nodejs/node/pull/5282) * [[`1624d5b049`](https://github.com/nodejs/node/commit/1624d5b049)] - **doc**: document base64url encoding support (Tristan Slominski) [#5243](https://github.com/nodejs/node/pull/5243) * [[`b1d580c9d2`](https://github.com/nodejs/node/commit/b1d580c9d2)] - **doc**: update removeListener behaviour (Vaibhav) [#5201](https://github.com/nodejs/node/pull/5201) * [[`ca17f91ba8`](https://github.com/nodejs/node/commit/ca17f91ba8)] - **doc**: add note for binary safe string reading (Anton Andesen) [#5155](https://github.com/nodejs/node/pull/5155) * [[`0830bb4950`](https://github.com/nodejs/node/commit/0830bb4950)] - **doc**: clarify when writable.write callback is called (Kevin Locke) [#4810](https://github.com/nodejs/node/pull/4810) * [[`17a74305c8`](https://github.com/nodejs/node/commit/17a74305c8)] - **doc**: add info to docs on how to submit docs patch (Sequoia McDowell) [#4591](https://github.com/nodejs/node/pull/4591) * [[`470a9ca909`](https://github.com/nodejs/node/commit/470a9ca909)] - **doc**: add onboarding resources (Jeremiah Senkpiel) [#3726](https://github.com/nodejs/node/pull/3726) * [[`3168e6b486`](https://github.com/nodejs/node/commit/3168e6b486)] - **doc**: update V8 URL (Craig Akimoto) [#5530](https://github.com/nodejs/node/pull/5530) * [[`04d16eb7e8`](https://github.com/nodejs/node/commit/04d16eb7e8)] - **doc**: document fs.datasync(Sync) (Ron Korving) [#5402](https://github.com/nodejs/node/pull/5402) * [[`29646200f8`](https://github.com/nodejs/node/commit/29646200f8)] - **doc**: add Evan Lucas to the CTC (Rod Vagg) * [[`a2a32b7810`](https://github.com/nodejs/node/commit/a2a32b7810)] - **doc**: add Rich Trott to the CTC (Rod Vagg) [#5276](https://github.com/nodejs/node/pull/5276) * [[`4e469d5e47`](https://github.com/nodejs/node/commit/4e469d5e47)] - **doc**: add Ali Ijaz Sheikh to the CTC (Rod Vagg) [#5277](https://github.com/nodejs/node/pull/5277) * [[`d09b44f59b`](https://github.com/nodejs/node/commit/d09b44f59b)] - **doc**: add Сковорода Никита Андреевич to the CTC (Rod Vagg) [#5278](https://github.com/nodejs/node/pull/5278) * [[`ebbc64bc97`](https://github.com/nodejs/node/commit/ebbc64bc97)] - **doc**: add "building node with ninja" guide (Jeremiah Senkpiel) [#4767](https://github.com/nodejs/node/pull/4767) * [[`67245fa0e3`](https://github.com/nodejs/node/commit/67245fa0e3)] - **doc**: clarify code of conduct reporting (Julie Pagano) [#5107](https://github.com/nodejs/node/pull/5107) * [[`cd78ff9706`](https://github.com/nodejs/node/commit/cd78ff9706)] - **doc**: fix links in Addons docs (Alexander Makarenko) [#5072](https://github.com/nodejs/node/pull/5072) * [[`20539954ff`](https://github.com/nodejs/node/commit/20539954ff)] - **docs**: fix man pages link if tok type is code (Mithun Patel) [#5721](https://github.com/nodejs/node/pull/5721) * [[`38d7b0b6ea`](https://github.com/nodejs/node/commit/38d7b0b6ea)] - **docs**: update link to iojs+release ci job (Myles Borins) [#5632](https://github.com/nodejs/node/pull/5632) * [[`f982632f90`](https://github.com/nodejs/node/commit/f982632f90)] - **http**: remove old, confusing comment (Brian White) [#5233](https://github.com/nodejs/node/pull/5233) * [[`ca5d7a8bb6`](https://github.com/nodejs/node/commit/ca5d7a8bb6)] - **http**: remove unnecessary check (Brian White) [#5233](https://github.com/nodejs/node/pull/5233) * [[`2ce83bd8f9`](https://github.com/nodejs/node/commit/2ce83bd8f9)] - **http,util**: fix typos in comments (Alexander Makarenko) [#5279](https://github.com/nodejs/node/pull/5279) * [[`b690916e5a`](https://github.com/nodejs/node/commit/b690916e5a)] - **lib**: freelist: use .pop() for allocation (Anton Khlynovskiy) [#2174](https://github.com/nodejs/node/pull/2174) * [[`e7f45f0a17`](https://github.com/nodejs/node/commit/e7f45f0a17)] - **repl**: handle quotes within regexp literal (Prince J Wesley) [#5117](https://github.com/nodejs/node/pull/5117) * [[`7c3b844f78`](https://github.com/nodejs/node/commit/7c3b844f78)] - **src**: return UV_EAI_NODATA on empty lookup (cjihrig) [#4715](https://github.com/nodejs/node/pull/4715) * [[`242a65e930`](https://github.com/nodejs/node/commit/242a65e930)] - **stream**: prevent object map change in TransformState (Evan Lucas) [#5032](https://github.com/nodejs/node/pull/5032) * [[`fb5ba6b928`](https://github.com/nodejs/node/commit/fb5ba6b928)] - **stream**: prevent object map change in ReadableState (Evan Lucas) [#4761](https://github.com/nodejs/node/pull/4761) * [[`04db9efd78`](https://github.com/nodejs/node/commit/04db9efd78)] - **stream**: fix no data on partial decode (Brian White) [#5226](https://github.com/nodejs/node/pull/5226) * [[`cc0e36ff98`](https://github.com/nodejs/node/commit/cc0e36ff98)] - **string_decoder**: fix performance regression (Brian White) [#5134](https://github.com/nodejs/node/pull/5134) * [[`666d3690d8`](https://github.com/nodejs/node/commit/666d3690d8)] - **test**: eval a strict function (Kári Tristan Helgason) [#5250](https://github.com/nodejs/node/pull/5250) * [[`9952bcf203`](https://github.com/nodejs/node/commit/9952bcf203)] - **test**: bug repro for vm function redefinition (cjihrig) [#5528](https://github.com/nodejs/node/pull/5528) * [[`063f22f1f0`](https://github.com/nodejs/node/commit/063f22f1f0)] - **test**: check memoryUsage properties The properties on memoryUsage were not checked before, this commit checks them. (Wyatt Preul) [#5546](https://github.com/nodejs/node/pull/5546) * [[`7a0fcfc127`](https://github.com/nodejs/node/commit/7a0fcfc127)] - **test**: remove broken debugger scenarios (Rich Trott) [#5532](https://github.com/nodejs/node/pull/5532) * [[`ba9ad2662c`](https://github.com/nodejs/node/commit/ba9ad2662c)] - **test**: apply Linux workaround to Linux only (Rich Trott) [#5471](https://github.com/nodejs/node/pull/5471) * [[`4aa2c03d31`](https://github.com/nodejs/node/commit/4aa2c03d31)] - **test**: increase timeout for test-tls-fast-writing (Rich Trott) [#5466](https://github.com/nodejs/node/pull/5466) * [[`b4ef644ce4`](https://github.com/nodejs/node/commit/b4ef644ce4)] - **test**: retry on known SmartOS bug (Rich Trott) [#5454](https://github.com/nodejs/node/pull/5454) * [[`d681bf24b5`](https://github.com/nodejs/node/commit/d681bf24b5)] - **test**: fix flaky child-process-fork-regr-gh-2847 (Santiago Gimeno) [#5422](https://github.com/nodejs/node/pull/5422) * [[`b4fbe04514`](https://github.com/nodejs/node/commit/b4fbe04514)] - **test**: fix test-timers.reliability on OS X (Rich Trott) [#5379](https://github.com/nodejs/node/pull/5379) * [[`99269ffdbf`](https://github.com/nodejs/node/commit/99269ffdbf)] - **test**: increase timeouts on some unref timers tests (Jeremiah Senkpiel) [#5352](https://github.com/nodejs/node/pull/5352) * [[`85f927a774`](https://github.com/nodejs/node/commit/85f927a774)] - **test**: prevent flakey test on pi2 (Trevor Norris) [#5537](https://github.com/nodejs/node/pull/5537) * [[`c86902d800`](https://github.com/nodejs/node/commit/c86902d800)] - **test**: mitigate flaky test-http-agent (Rich Trott) [#5346](https://github.com/nodejs/node/pull/5346) * [[`f242e62817`](https://github.com/nodejs/node/commit/f242e62817)] - **test**: remove flaky designation from fixed tests (Rich Trott) [#5459](https://github.com/nodejs/node/pull/5459) * [[`a39aacf035`](https://github.com/nodejs/node/commit/a39aacf035)] - **test**: refactor test-dgram-udp4 (Santiago Gimeno) [#5339](https://github.com/nodejs/node/pull/5339) * [[`6386f62221`](https://github.com/nodejs/node/commit/6386f62221)] - **test**: remove unneeded bind() and related comments (Aayush Naik) [#5023](https://github.com/nodejs/node/pull/5023) * [[`068b0cbd12`](https://github.com/nodejs/node/commit/068b0cbd12)] - **test**: move cluster tests to parallel (Rich Trott) [#4774](https://github.com/nodejs/node/pull/4774) * [[`a673c9ae2d`](https://github.com/nodejs/node/commit/a673c9ae2d)] - **tls**: fix assert in context._external accessor (Ben Noordhuis) [#5521](https://github.com/nodejs/node/pull/5521) * [[`8ffef48fee`](https://github.com/nodejs/node/commit/8ffef48fee)] - **tools**: fix gyp to work on MacOSX without XCode (Shigeki Ohtsu) [nodejs/node#1325](https://github.com/nodejs/node/pull/1325) * [[`4b6a8f4321`](https://github.com/nodejs/node/commit/4b6a8f4321)] - **tools**: update gyp to b3cef02 (Imran Iqbal) [#3487](https://github.com/nodejs/node/pull/3487) * [[`7501ddc878`](https://github.com/nodejs/node/commit/7501ddc878)] - **tools**: support testing known issues (cjihrig) [#5528](https://github.com/nodejs/node/pull/5528) * [[`10ec1d2a6b`](https://github.com/nodejs/node/commit/10ec1d2a6b)] - **tools**: enable linting for benchmarks (Rich Trott) [#5773](https://github.com/nodejs/node/pull/5773) * [[`deec8bc5f5`](https://github.com/nodejs/node/commit/deec8bc5f5)] - **tools**: reduce verbosity of cpplint (Sakthipriyan Vairamani) [#5578](https://github.com/nodejs/node/pull/5578) * [[`64d5752711`](https://github.com/nodejs/node/commit/64d5752711)] - **tools**: enable no-self-assign ESLint rule (Rich Trott) [#5552](https://github.com/nodejs/node/pull/5552) * [[`131ed494e2`](https://github.com/nodejs/node/commit/131ed494e2)] - **tools**: enable no-extra-parens in ESLint (Rich Trott) [#5512](https://github.com/nodejs/node/pull/5512) * [[`d4b9f02fdc`](https://github.com/nodejs/node/commit/d4b9f02fdc)] - **tools**: apply custom buffer lint rule to /lib only (Rich Trott) [#5371](https://github.com/nodejs/node/pull/5371) * [[`6867bed4c4`](https://github.com/nodejs/node/commit/6867bed4c4)] - **tools**: enable additional lint rules (Rich Trott) [#5357](https://github.com/nodejs/node/pull/5357) * [[`5e6b7605ee`](https://github.com/nodejs/node/commit/5e6b7605ee)] - **tools**: add Node.js-specific ESLint rules (Rich Trott) [#5320](https://github.com/nodejs/node/pull/5320) * [[`6dc49ae203`](https://github.com/nodejs/node/commit/6dc49ae203)] - **tools,benchmark**: increase lint compliance (Rich Trott) [#5773](https://github.com/nodejs/node/pull/5773) * [[`dff7091fce`](https://github.com/nodejs/node/commit/dff7091fce)] - **url**: group slashed protocols by protocol name (nettofarah) [#5380](https://github.com/nodejs/node/pull/5380) * [[`0e97a3ea51`](https://github.com/nodejs/node/commit/0e97a3ea51)] - **win,build**: support Visual C++ Build Tools 2015 (João Reis) [#5627](https://github.com/nodejs/node/pull/5627) ## 2016-03-08, Version 4.4.0 'Argon' (LTS), @thealphanerd In December we announced that we would be doing a minor release in order to get a number of voted on SEMVER-MINOR changes into LTS. Our ability to release this was delayed due to the unforeseen security release v4.3. We are quickly bumping to v4.4 in order to bring you the features that we had committed to releasing. This release also includes over 70 fixes to our docs and over 50 fixes to tests. ### Notable changes The SEMVER-MINOR changes include: * **deps**: - An update to v8 that introduces a new flag --perf_basic_prof_only_functions (Ali Ijaz Sheikh) [#3609](https://github.com/nodejs/node/pull/3609) * **http**: - A new feature in http(s) agent that catches errors on *keep alived* connections (José F. Romaniello) [#4482](https://github.com/nodejs/node/pull/4482) * **src**: - Better support for Big-Endian systems (Bryon Leung) [#3410](https://github.com/nodejs/node/pull/3410) * **tls**: - A new feature that allows you to pass common SSL options to `tls.createSecurePair` (Коренберг Марк) [#2441](https://github.com/nodejs/node/pull/2441) * **tools**: - a new flag `--prof-process` which will execute the tick processor on the provided isolate files (Matt Loring) [#4021](https://github.com/nodejs/node/pull/4021) Notable semver patch changes include: * **buld**: - Support python path that includes spaces. This should be of particular interest to our Windows users who may have python living in `c:/Program Files` (Felix Becker) [#4841](https://github.com/nodejs/node/pull/4841) * **https**: - A potential fix for [#3692](https://github.com/nodejs/node/issues/3692) HTTP/HTTPS client requests throwing EPROTO (Fedor Indutny) [#4982](https://github.com/nodejs/node/pull/4982) * **installer**: - More readable profiling information from isolate tick logs (Matt Loring) [#3032](https://github.com/nodejs/node/pull/3032) * **npm**: - upgrade to npm 2.14.20 (Kat Marchán) [#5510](https://github.com/nodejs/node/pull/5510) * **process**: - Add support for symbols in event emitters. Symbols didn't exist when it was written ¯\_(ツ)_/¯ (cjihrig) [#4798](https://github.com/nodejs/node/pull/4798) * **querystring**: - querystring.parse() is now 13-22% faster! (Brian White) [#4675](https://github.com/nodejs/node/pull/4675) * **streams**: - performance improvements for moving small buffers that shows a 5% throughput gain. IoT projects have been seen to be as much as 10% faster with this change! (Matteo Collina) [#4354](https://github.com/nodejs/node/pull/4354) * **tools**: - eslint has been updated to version 2.1.0 (Rich Trott) [#5214](https://github.com/nodejs/node/pull/5214) ### Commits * [[`360e04fd5a`](https://github.com/nodejs/node/commit/360e04fd5a)] - internal/child_process: call postSend on error (Fedor Indutny) [#4752](https://github.com/nodejs/node/pull/4752) * [[`a29f501aa2`](https://github.com/nodejs/node/commit/a29f501aa2)] - **benchmark**: add a constant declaration for `net` (Minwoo Jung) [#3950](https://github.com/nodejs/node/pull/3950) * [[`85e06a2e34`](https://github.com/nodejs/node/commit/85e06a2e34)] - **(SEMVER-MINOR)** **buffer**: allow encoding param to collapse (Trevor Norris) [#4803](https://github.com/nodejs/node/pull/4803) * [[`fe893a8ebc`](https://github.com/nodejs/node/commit/fe893a8ebc)] - **(SEMVER-MINOR)** **buffer**: properly retrieve binary length of needle (Trevor Norris) [#4803](https://github.com/nodejs/node/pull/4803) * [[`fae7c9db3f`](https://github.com/nodejs/node/commit/fae7c9db3f)] - **buffer**: refactor redeclared variables (Rich Trott) [#4886](https://github.com/nodejs/node/pull/4886) * [[`4a6e2b26f7`](https://github.com/nodejs/node/commit/4a6e2b26f7)] - **build**: treat aarch64 as arm64 (Johan Bergström) [#5191](https://github.com/nodejs/node/pull/5191) * [[`bc2536dfc6`](https://github.com/nodejs/node/commit/bc2536dfc6)] - **build**: add a help message and removed a TODO. (Ojas Shirekar) [#5080](https://github.com/nodejs/node/pull/5080) * [[`f6416be5d2`](https://github.com/nodejs/node/commit/f6416be5d2)] - **build**: remove redundant TODO in configure (Ojas Shirekar) [#5080](https://github.com/nodejs/node/pull/5080) * [[`6deb7a6eb8`](https://github.com/nodejs/node/commit/6deb7a6eb8)] - **build**: remove Makefile.build (Ojas Shirekar) [#5080](https://github.com/nodejs/node/pull/5080) * [[`66d1115555`](https://github.com/nodejs/node/commit/66d1115555)] - **build**: fix build when python path contains spaces (Felix Becker) [#4841](https://github.com/nodejs/node/pull/4841) * [[`29951cf36a`](https://github.com/nodejs/node/commit/29951cf36a)] - **child_process**: fix data loss with readable event (Brian White) [#5036](https://github.com/nodejs/node/pull/5036) * [[`81d4127279`](https://github.com/nodejs/node/commit/81d4127279)] - **cluster**: dont rely on `this` in `fork` (Igor Klopov) [#5216](https://github.com/nodejs/node/pull/5216) * [[`de4c07b29e`](https://github.com/nodejs/node/commit/de4c07b29e)] - **console**: apply null as `this` for util.format (Jackson Tian) [#5222](https://github.com/nodejs/node/pull/5222) * [[`4e0755cab3`](https://github.com/nodejs/node/commit/4e0755cab3)] - **crypto**: have fixed NodeBIOs return EOF (Adam Langley) [#5105](https://github.com/nodejs/node/pull/5105) * [[`a7955d5071`](https://github.com/nodejs/node/commit/a7955d5071)] - **crypto**: fix memory leak in LoadPKCS12 (Fedor Indutny) [#5109](https://github.com/nodejs/node/pull/5109) * [[`5d9c1cf001`](https://github.com/nodejs/node/commit/5d9c1cf001)] - **crypto**: add `pfx` certs as CA certs too (Fedor Indutny) [#5109](https://github.com/nodejs/node/pull/5109) * [[`ab5cb0539b`](https://github.com/nodejs/node/commit/ab5cb0539b)] - **crypto**: use SSL_CTX_clear_extra_chain_certs. (Adam Langley) [#4919](https://github.com/nodejs/node/pull/4919) * [[`198928eb9f`](https://github.com/nodejs/node/commit/198928eb9f)] - **crypto**: fix build when OCSP-stapling not provided (Adam Langley) [#4914](https://github.com/nodejs/node/pull/4914) * [[`b8e1089df0`](https://github.com/nodejs/node/commit/b8e1089df0)] - **crypto**: use a const SSL_CIPHER (Adam Langley) [#4913](https://github.com/nodejs/node/pull/4913) * [[`139d6d9284`](https://github.com/nodejs/node/commit/139d6d9284)] - **debugger**: assert test before accessing this.binding (Prince J Wesley) [#5145](https://github.com/nodejs/node/pull/5145) * [[`9c8f2ab546`](https://github.com/nodejs/node/commit/9c8f2ab546)] - **deps**: upgrade to npm 2.14.20 (Kat Marchán) [#5510](https://github.com/nodejs/node/pull/5510) * [[`e591a0927f`](https://github.com/nodejs/node/commit/e591a0927f)] - **deps**: upgrade to npm 2.14.19 (Kat Marchán) [#5335](https://github.com/nodejs/node/pull/5335) * [[`a5ce67a0aa`](https://github.com/nodejs/node/commit/a5ce67a0aa)] - **deps**: upgrade to npm 2.14.18 (Kat Marchán) [#5245](https://github.com/nodejs/node/pull/5245) * [[`469db021f7`](https://github.com/nodejs/node/commit/469db021f7)] - **(SEMVER-MINOR)** **deps**: backport 9da3ab6 from V8 upstream (Ali Ijaz Sheikh) [#3609](https://github.com/nodejs/node/pull/3609) * [[`3ca04a5de9`](https://github.com/nodejs/node/commit/3ca04a5de9)] - **deps**: backport 8d00c2c from v8 upstream (Gibson Fahnestock) [#5024](https://github.com/nodejs/node/pull/5024) * [[`60e0bd4be9`](https://github.com/nodejs/node/commit/60e0bd4be9)] - **deps**: upgrade to npm 2.14.17 (Kat Marchán) [#5110](https://github.com/nodejs/node/pull/5110) * [[`976b9a9ab3`](https://github.com/nodejs/node/commit/976b9a9ab3)] - **deps**: upgrade to npm 2.14.16 (Kat Marchán) [#4960](https://github.com/nodejs/node/pull/4960) * [[`38b370abea`](https://github.com/nodejs/node/commit/38b370abea)] - **deps**: upgrade to npm 2.14.15 (Kat Marchán) [#4872](https://github.com/nodejs/node/pull/4872) * [[`82f549ef81`](https://github.com/nodejs/node/commit/82f549ef81)] - **dgram**: scope redeclared variables (Rich Trott) [#4940](https://github.com/nodejs/node/pull/4940) * [[`063e14b568`](https://github.com/nodejs/node/commit/063e14b568)] - **dns**: throw a TypeError in lookupService with invalid port (Evan Lucas) [#4839](https://github.com/nodejs/node/pull/4839) * [[`a2613aefae`](https://github.com/nodejs/node/commit/a2613aefae)] - **doc**: remove out-of-date matter from internal docs (Rich Trott) [#5421](https://github.com/nodejs/node/pull/5421) * [[`394743f4b3`](https://github.com/nodejs/node/commit/394743f4b3)] - **doc**: explicit about VS 2015 support in readme (Phillip Johnsen) [#5406](https://github.com/nodejs/node/pull/5406) * [[`da6b26fbfb`](https://github.com/nodejs/node/commit/da6b26fbfb)] - **doc**: copyedit util doc (Rich Trott) [#5399](https://github.com/nodejs/node/pull/5399) * [[`7070ad0cc0`](https://github.com/nodejs/node/commit/7070ad0cc0)] - **doc**: mention prototype check in deepStrictEqual() (cjihrig) [#5367](https://github.com/nodejs/node/pull/5367) * [[`d4789fc5fd`](https://github.com/nodejs/node/commit/d4789fc5fd)] - **doc**: s/http/https in Myles Borins' GitHub link (Rod Vagg) [#5356](https://github.com/nodejs/node/pull/5356) * [[`b86540d1eb`](https://github.com/nodejs/node/commit/b86540d1eb)] - **doc**: clarify error handling in net.createServer (Dirceu Pereira Tiegs) [#5353](https://github.com/nodejs/node/pull/5353) * [[`3106297037`](https://github.com/nodejs/node/commit/3106297037)] - **doc**: `require` behavior on case-insensitive systems (Hugo Wood) * [[`e0b45e4315`](https://github.com/nodejs/node/commit/e0b45e4315)] - **doc**: update repo docs to use 'CTC' (Alexis Campailla) [#5304](https://github.com/nodejs/node/pull/5304) * [[`e355f13989`](https://github.com/nodejs/node/commit/e355f13989)] - **doc**: improvements to crypto.markdown copy (Alexander Makarenko) [#5230](https://github.com/nodejs/node/pull/5230) * [[`a9035b5e1d`](https://github.com/nodejs/node/commit/a9035b5e1d)] - **doc**: link to man pages (dcposch@dcpos.ch) [#5073](https://github.com/nodejs/node/pull/5073) * [[`2043e6a63c`](https://github.com/nodejs/node/commit/2043e6a63c)] - **doc**: clarify child_process.execFile{,Sync} file arg (Kevin Locke) [#5310](https://github.com/nodejs/node/pull/5310) * [[`8c732ad1e1`](https://github.com/nodejs/node/commit/8c732ad1e1)] - **doc**: fix buf.length slice example (Chinedu Francis Nwafili) [#5259](https://github.com/nodejs/node/pull/5259) * [[`6c27c78b8b`](https://github.com/nodejs/node/commit/6c27c78b8b)] - **doc**: fix buffer\[index\] example (Chinedu Francis Nwafili) [#5253](https://github.com/nodejs/node/pull/5253) * [[`7765f99683`](https://github.com/nodejs/node/commit/7765f99683)] - **doc**: fix template string (Rafael Cepeda) [#5240](https://github.com/nodejs/node/pull/5240) * [[`d15ef20162`](https://github.com/nodejs/node/commit/d15ef20162)] - **doc**: improvements to console.markdown copy (Alexander Makarenko) [#5225](https://github.com/nodejs/node/pull/5225) * [[`593206a752`](https://github.com/nodejs/node/commit/593206a752)] - **doc**: fix net.createConnection() example (Brian White) [#5219](https://github.com/nodejs/node/pull/5219) * [[`464636b5c5`](https://github.com/nodejs/node/commit/464636b5c5)] - **doc**: improve scrolling, various CSS tweaks (Roman Reiss) [#5198](https://github.com/nodejs/node/pull/5198) * [[`f615cd5b0b`](https://github.com/nodejs/node/commit/f615cd5b0b)] - **doc**: console is asynchronous unless it's a file (Ben Noordhuis) [#5133](https://github.com/nodejs/node/pull/5133) * [[`fbed0d11f1`](https://github.com/nodejs/node/commit/fbed0d11f1)] - **doc**: merging behavior of writeHead vs setHeader (Alejandro Oviedo) [#5081](https://github.com/nodejs/node/pull/5081) * [[`b0bb42bd7d`](https://github.com/nodejs/node/commit/b0bb42bd7d)] - **doc**: fix reference to API `hash.final` (Minwoo Jung) [#5050](https://github.com/nodejs/node/pull/5050) * [[`dee5045221`](https://github.com/nodejs/node/commit/dee5045221)] - **doc**: uppercase 'RSA-SHA256' in crypto.markdown (Rainer Oviir) [#5044](https://github.com/nodejs/node/pull/5044) * [[`498052a017`](https://github.com/nodejs/node/commit/498052a017)] - **doc**: consistent styling for functions in TLS docs (Alexander Makarenko) [#5000](https://github.com/nodejs/node/pull/5000) * [[`031277e6f8`](https://github.com/nodejs/node/commit/031277e6f8)] - **doc**: apply consistent styling for functions (Rich Trott) [#4974](https://github.com/nodejs/node/pull/4974) * [[`808fe0ea48`](https://github.com/nodejs/node/commit/808fe0ea48)] - **doc**: fix `notDeepEqual` API (Minwoo Jung) [#4971](https://github.com/nodejs/node/pull/4971) * [[`5b9025689f`](https://github.com/nodejs/node/commit/5b9025689f)] - **doc**: show links consistently in deprecations (Sakthipriyan Vairamani) [#4907](https://github.com/nodejs/node/pull/4907) * [[`3a1865db5e`](https://github.com/nodejs/node/commit/3a1865db5e)] - **doc**: don't use "interface" as a variable name (ChALkeR) [#4900](https://github.com/nodejs/node/pull/4900) * [[`90715c3d68`](https://github.com/nodejs/node/commit/90715c3d68)] - **doc**: keep the names in sorted order (Sakthipriyan Vairamani) [#4876](https://github.com/nodejs/node/pull/4876) * [[`d8b3b25c9c`](https://github.com/nodejs/node/commit/d8b3b25c9c)] - **doc**: fix JSON generation for aliased methods (Timothy Gu) [#4871](https://github.com/nodejs/node/pull/4871) * [[`7b763c8d25`](https://github.com/nodejs/node/commit/7b763c8d25)] - **doc**: fix code type of markdowns (Jackson Tian) [#4858](https://github.com/nodejs/node/pull/4858) * [[`37d4e7afc2`](https://github.com/nodejs/node/commit/37d4e7afc2)] - **doc**: check for errors in 'listen' event (Benjamin Gruenbaum) [#4834](https://github.com/nodejs/node/pull/4834) * [[`3f876b104c`](https://github.com/nodejs/node/commit/3f876b104c)] - **doc**: Examples work when data exceeds buffer size (Glen Arrowsmith) [#4811](https://github.com/nodejs/node/pull/4811) * [[`e3e20422a7`](https://github.com/nodejs/node/commit/e3e20422a7)] - **doc**: harmonize $ node command line notation (Robert Jefe Lindstaedt) [#4806](https://github.com/nodejs/node/pull/4806) * [[`73e0195cef`](https://github.com/nodejs/node/commit/73e0195cef)] - **doc**: fix type references for link gen, link css (Claudio Rodriguez) [#4741](https://github.com/nodejs/node/pull/4741) * [[`0bdac429e1`](https://github.com/nodejs/node/commit/0bdac429e1)] - **doc**: multiple improvements in Stream docs (Alexander Makarenko) [#5009](https://github.com/nodejs/node/pull/5009) * [[`693c16fb6b`](https://github.com/nodejs/node/commit/693c16fb6b)] - **doc**: fix anchor links from stream to http and events (piepmatz) [#5007](https://github.com/nodejs/node/pull/5007) * [[`5fb533522c`](https://github.com/nodejs/node/commit/5fb533522c)] - **doc**: replace function expressions with arrows (Benjamin Gruenbaum) [#4832](https://github.com/nodejs/node/pull/4832) * [[`e3572fb809`](https://github.com/nodejs/node/commit/e3572fb809)] - **doc**: fix links order in Buffer doc (Alexander Makarenko) [#5076](https://github.com/nodejs/node/pull/5076) * [[`5c936ab765`](https://github.com/nodejs/node/commit/5c936ab765)] - **doc**: clarify optional arguments of Buffer methods (Michaël Zasso) [#5008](https://github.com/nodejs/node/pull/5008) * [[`6df350c2b3`](https://github.com/nodejs/node/commit/6df350c2b3)] - **doc**: improve styling consistency in Buffer docs (Alexander Makarenko) [#5001](https://github.com/nodejs/node/pull/5001) * [[`047f4a157f`](https://github.com/nodejs/node/commit/047f4a157f)] - **doc**: make buffer methods styles consistent (Timothy Gu) [#4873](https://github.com/nodejs/node/pull/4873) * [[`4cfc017b90`](https://github.com/nodejs/node/commit/4cfc017b90)] - **doc**: fix nonsensical grammar in Buffer::write (Jimb Esser) [#4863](https://github.com/nodejs/node/pull/4863) * [[`9087f6daca`](https://github.com/nodejs/node/commit/9087f6daca)] - **doc**: fix named anchors in addons.markdown and http.markdown (Michael Theriot) [#4708](https://github.com/nodejs/node/pull/4708) * [[`4c8713ce58`](https://github.com/nodejs/node/commit/4c8713ce58)] - **doc**: add buf.indexOf encoding param with example (Karl Skomski) [#3373](https://github.com/nodejs/node/pull/3373) * [[`1819d74491`](https://github.com/nodejs/node/commit/1819d74491)] - **doc**: fenced all code blocks, typo fixes (Robert Jefe Lindstaedt) [#4733](https://github.com/nodejs/node/pull/4733) * [[`961735e645`](https://github.com/nodejs/node/commit/961735e645)] - **doc**: make references clickable (Roman Klauke) [#4654](https://github.com/nodejs/node/pull/4654) * [[`7e80442483`](https://github.com/nodejs/node/commit/7e80442483)] - **doc**: improve child_process.execFile() code example (Ryan Sobol) [#4504](https://github.com/nodejs/node/pull/4504) * [[`de9ad5b39d`](https://github.com/nodejs/node/commit/de9ad5b39d)] - **doc**: remove "above" and "below" references (Richard Sun) [#4499](https://github.com/nodejs/node/pull/4499) * [[`c549ca3b69`](https://github.com/nodejs/node/commit/c549ca3b69)] - **doc**: fix heading level error in Buffer doc (Shigeki Ohtsu) [#4537](https://github.com/nodejs/node/pull/4537) * [[`a613bae14c`](https://github.com/nodejs/node/commit/a613bae14c)] - **doc**: improvements to crypto.markdown copy (James M Snell) [#4435](https://github.com/nodejs/node/pull/4435) * [[`18f580d0c1`](https://github.com/nodejs/node/commit/18f580d0c1)] - **doc**: improve child_process.markdown copy (James M Snell) [#4383](https://github.com/nodejs/node/pull/4383) * [[`a929837311`](https://github.com/nodejs/node/commit/a929837311)] - **doc**: improvements to buffer.markdown copy (James M Snell) [#4370](https://github.com/nodejs/node/pull/4370) * [[`a22f688407`](https://github.com/nodejs/node/commit/a22f688407)] - **doc**: improve addons.markdown copy (James M Snell) [#4320](https://github.com/nodejs/node/pull/4320) * [[`94c2de47b1`](https://github.com/nodejs/node/commit/94c2de47b1)] - **doc**: update process.send() signature (cjihrig) [#5284](https://github.com/nodejs/node/pull/5284) * [[`4e1926cb08`](https://github.com/nodejs/node/commit/4e1926cb08)] - **doc**: replace node-forward link in CONTRIBUTING.md (Ben Noordhuis) [#5227](https://github.com/nodejs/node/pull/5227) * [[`e1713e81e5`](https://github.com/nodejs/node/commit/e1713e81e5)] - **doc**: fix minor inconsistencies in repl doc (Rich Trott) [#5193](https://github.com/nodejs/node/pull/5193) * [[`b2e72c0d92`](https://github.com/nodejs/node/commit/b2e72c0d92)] - **doc**: clarify exceptions during uncaughtException (Noah Rose) [#5180](https://github.com/nodejs/node/pull/5180) * [[`c3c549836a`](https://github.com/nodejs/node/commit/c3c549836a)] - **doc**: update DCO to v1.1 (Mikeal Rogers) [#5170](https://github.com/nodejs/node/pull/5170) * [[`9dd35ad594`](https://github.com/nodejs/node/commit/9dd35ad594)] - **doc**: fix dgram doc indentation (Rich Trott) [#5118](https://github.com/nodejs/node/pull/5118) * [[`eed830702c`](https://github.com/nodejs/node/commit/eed830702c)] - **doc**: fix typo in dgram doc (Rich Trott) [#5114](https://github.com/nodejs/node/pull/5114) * [[`abfb2f5864`](https://github.com/nodejs/node/commit/abfb2f5864)] - **doc**: fix link in cluster documentation (Timothy Gu) [#5068](https://github.com/nodejs/node/pull/5068) * [[`8b040b5bb2`](https://github.com/nodejs/node/commit/8b040b5bb2)] - **doc**: fix minor typo in process doc (Prayag Verma) [#5018](https://github.com/nodejs/node/pull/5018) * [[`47eebe1d80`](https://github.com/nodejs/node/commit/47eebe1d80)] - **doc**: fix typo in Readme.md (Prayag Verma) [#5017](https://github.com/nodejs/node/pull/5017) * [[`2b97ff89a6`](https://github.com/nodejs/node/commit/2b97ff89a6)] - **doc**: minor improvement in OS docs (Alexander Makarenko) [#5006](https://github.com/nodejs/node/pull/5006) * [[`9a5d58b89e`](https://github.com/nodejs/node/commit/9a5d58b89e)] - **doc**: improve styling consistency in VM docs (Alexander Makarenko) [#5005](https://github.com/nodejs/node/pull/5005) * [[`960e1bab98`](https://github.com/nodejs/node/commit/960e1bab98)] - **doc**: minor improvement to HTTPS doc (Alexander Makarenko) [#5002](https://github.com/nodejs/node/pull/5002) * [[`6048b011e8`](https://github.com/nodejs/node/commit/6048b011e8)] - **doc**: spell writable consistently (Peter Lyons) [#4954](https://github.com/nodejs/node/pull/4954) * [[`7b8f904167`](https://github.com/nodejs/node/commit/7b8f904167)] - **doc**: update eol handling in readline (Kári Tristan Helgason) [#4927](https://github.com/nodejs/node/pull/4927) * [[`83efd0d4d1`](https://github.com/nodejs/node/commit/83efd0d4d1)] - **doc**: add more details to process.env (Evan Lucas) [#4924](https://github.com/nodejs/node/pull/4924) * [[`b2d2c0b588`](https://github.com/nodejs/node/commit/b2d2c0b588)] - **doc**: undo move http.IncomingMessage.statusMessage (Jeff Harris) [#4822](https://github.com/nodejs/node/pull/4822) * [[`b091c41b53`](https://github.com/nodejs/node/commit/b091c41b53)] - **doc**: proper markdown escaping -> \_\_, \*, \_ (Robert Jefe Lindstaedt) [#4805](https://github.com/nodejs/node/pull/4805) * [[`0887208290`](https://github.com/nodejs/node/commit/0887208290)] - **doc**: remove unnecessary bind(this) (Dmitriy Lazarev) [#4797](https://github.com/nodejs/node/pull/4797) * [[`f3e3c70bca`](https://github.com/nodejs/node/commit/f3e3c70bca)] - **doc**: Update small error in LICENSE for npm (Kat Marchán) [#4872](https://github.com/nodejs/node/pull/4872) * [[`e703b180b3`](https://github.com/nodejs/node/commit/e703b180b3)] - **doc,tools,test**: lint doc-based addon tests (Rich Trott) [#5427](https://github.com/nodejs/node/pull/5427) * [[`0f3b8ca192`](https://github.com/nodejs/node/commit/0f3b8ca192)] - **fs**: refactor redeclared variables (Rich Trott) [#4959](https://github.com/nodejs/node/pull/4959) * [[`152c6b6b8d`](https://github.com/nodejs/node/commit/152c6b6b8d)] - **http**: remove reference to onParserExecute (Tom Atkinson) [#4773](https://github.com/nodejs/node/pull/4773) * [[`6a0571cd72`](https://github.com/nodejs/node/commit/6a0571cd72)] - **http**: do not emit `upgrade` on advertisement (Fedor Indutny) [#4337](https://github.com/nodejs/node/pull/4337) * [[`567ced9ef0`](https://github.com/nodejs/node/commit/567ced9ef0)] - **(SEMVER-MINOR)** **http**: handle errors on idle sockets (José F. Romaniello) [#4482](https://github.com/nodejs/node/pull/4482) * [[`de5177ccb8`](https://github.com/nodejs/node/commit/de5177ccb8)] - **https**: evict cached sessions on error (Fedor Indutny) [#4982](https://github.com/nodejs/node/pull/4982) * [[`77a6036264`](https://github.com/nodejs/node/commit/77a6036264)] - **installer**: install the tick processor (Matt Loring) [#3032](https://github.com/nodejs/node/pull/3032) * [[`ea16d8d7c5`](https://github.com/nodejs/node/commit/ea16d8d7c5)] - **lib**: remove string_decoder.js var redeclarations (Rich Trott) [#4978](https://github.com/nodejs/node/pull/4978) * [[`1389660ab3`](https://github.com/nodejs/node/commit/1389660ab3)] - **lib**: scope loop variables (Rich Trott) [#4965](https://github.com/nodejs/node/pull/4965) * [[`59255d7218`](https://github.com/nodejs/node/commit/59255d7218)] - **lib**: use arrow functions instead of bind (Minwoo Jung) [#3622](https://github.com/nodejs/node/pull/3622) * [[`fd26960aab`](https://github.com/nodejs/node/commit/fd26960aab)] - **lib,test**: remove extra semicolons (Michaël Zasso) [#2205](https://github.com/nodejs/node/pull/2205) * [[`9646d26ffd`](https://github.com/nodejs/node/commit/9646d26ffd)] - **module**: refactor redeclared variable (Rich Trott) [#4962](https://github.com/nodejs/node/pull/4962) * [[`09311128e8`](https://github.com/nodejs/node/commit/09311128e8)] - **net**: use `_server` for internal book-keeping (Fedor Indutny) [#5262](https://github.com/nodejs/node/pull/5262) * [[`824c402174`](https://github.com/nodejs/node/commit/824c402174)] - **net**: refactor redeclared variables (Rich Trott) [#4963](https://github.com/nodejs/node/pull/4963) * [[`96f306f3cf`](https://github.com/nodejs/node/commit/96f306f3cf)] - **net**: move isLegalPort to internal/net (Evan Lucas) [#4882](https://github.com/nodejs/node/pull/4882) * [[`78d64889bd`](https://github.com/nodejs/node/commit/78d64889bd)] - **node**: set process._eventsCount to 0 on startup (Evan Lucas) [#5208](https://github.com/nodejs/node/pull/5208) * [[`7a2e8f4356`](https://github.com/nodejs/node/commit/7a2e8f4356)] - **process**: support symbol events (cjihrig) [#4798](https://github.com/nodejs/node/pull/4798) * [[`c9e2dce247`](https://github.com/nodejs/node/commit/c9e2dce247)] - **querystring**: improve parse() performance (Brian White) [#4675](https://github.com/nodejs/node/pull/4675) * [[`18542c41fe`](https://github.com/nodejs/node/commit/18542c41fe)] - **repl**: remove variable redeclaration (Rich Trott) [#4977](https://github.com/nodejs/node/pull/4977) * [[`10be8dc360`](https://github.com/nodejs/node/commit/10be8dc360)] - **src**: force line buffering for stderr (Rich Trott) [#3701](https://github.com/nodejs/node/pull/3701) * [[`7958664e85`](https://github.com/nodejs/node/commit/7958664e85)] - **src**: clean up usage of __proto__ (Jackson Tian) [#5069](https://github.com/nodejs/node/pull/5069) * [[`4e0a0d51b3`](https://github.com/nodejs/node/commit/4e0a0d51b3)] - **src**: remove no longer relevant comments (Chris911) [#4843](https://github.com/nodejs/node/pull/4843) * [[`51c8bc8abc`](https://github.com/nodejs/node/commit/51c8bc8abc)] - **src**: remove __builtin_bswap16 call (Ben Noordhuis) [#4290](https://github.com/nodejs/node/pull/4290) * [[`5e1976e37c`](https://github.com/nodejs/node/commit/5e1976e37c)] - **src**: remove unused BITS_PER_LONG macro (Ben Noordhuis) [#4290](https://github.com/nodejs/node/pull/4290) * [[`c18ef54d88`](https://github.com/nodejs/node/commit/c18ef54d88)] - **(SEMVER-MINOR)** **src**: add BE support to StringBytes::Encode() (Bryon Leung) [#3410](https://github.com/nodejs/node/pull/3410) * [[`be9e7610b5`](https://github.com/nodejs/node/commit/be9e7610b5)] - **src,test,tools**: modify for more stringent linting (Rich Trott) [#5214](https://github.com/nodejs/node/pull/5214) * [[`538c4756a7`](https://github.com/nodejs/node/commit/538c4756a7)] - **stream**: refactor redeclared variables (Rich Trott) [#4816](https://github.com/nodejs/node/pull/4816) * [[`4fa22e4126`](https://github.com/nodejs/node/commit/4fa22e4126)] - **streams**: 5% throughput gain when sending small chunks (Matteo Collina) [#4354](https://github.com/nodejs/node/pull/4354) * [[`b6bd87495f`](https://github.com/nodejs/node/commit/b6bd87495f)] - **test**: remove flaky mark for test-debug-no-context (Rich Trott) [#5317](https://github.com/nodejs/node/pull/5317) * [[`7705360e35`](https://github.com/nodejs/node/commit/7705360e35)] - **test**: add test for https server close event (Braydon Fuller) [#5106](https://github.com/nodejs/node/pull/5106) * [[`9d6623e1d1`](https://github.com/nodejs/node/commit/9d6623e1d1)] - **test**: use String.prototype.repeat() for clarity (Rich Trott) [#5311](https://github.com/nodejs/node/pull/5311) * [[`18e3987e2e`](https://github.com/nodejs/node/commit/18e3987e2e)] - **test**: mitigate flaky test-debug-no-context (Rich Trott) [#5269](https://github.com/nodejs/node/pull/5269) * [[`058db07ce8`](https://github.com/nodejs/node/commit/058db07ce8)] - **test**: refactor test-dgram-send-callback-recursive (Santiago Gimeno) [#5079](https://github.com/nodejs/node/pull/5079) * [[`1647113d7a`](https://github.com/nodejs/node/commit/1647113d7a)] - **test**: refactor test-http-destroyed-socket-write2 (Santiago Gimeno) [#4970](https://github.com/nodejs/node/pull/4970) * [[`07dc2b50e2`](https://github.com/nodejs/node/commit/07dc2b50e2)] - **test**: shorten path for bogus socket (Rich Trott) [#4478](https://github.com/nodejs/node/pull/4478) * [[`47e7c8c359`](https://github.com/nodejs/node/commit/47e7c8c359)] - **test**: mark test-http-regr-gh-2928 flaky (Rich Trott) [#5280](https://github.com/nodejs/node/pull/5280) * [[`9dbd66f7ef`](https://github.com/nodejs/node/commit/9dbd66f7ef)] - **test**: mark test-http-agent flaky (Rich Trott) [#5209](https://github.com/nodejs/node/pull/5209) * [[`98049876b5`](https://github.com/nodejs/node/commit/98049876b5)] - **test**: minimal repl eval option test (Rich Trott) [#5192](https://github.com/nodejs/node/pull/5192) * [[`ae3185b8ac`](https://github.com/nodejs/node/commit/ae3185b8ac)] - **test**: disable fs watch tests for AIX (Michael Dawson) [#5187](https://github.com/nodejs/node/pull/5187) * [[`b639c3345b`](https://github.com/nodejs/node/commit/b639c3345b)] - **test**: fix child-process-fork-regr-gh-2847 again (Santiago Gimeno) [#5179](https://github.com/nodejs/node/pull/5179) * [[`8be3afc474`](https://github.com/nodejs/node/commit/8be3afc474)] - **test**: fix flaky test-http-regr-gh-2928 (Rich Trott) [#5154](https://github.com/nodejs/node/pull/5154) * [[`46dc12bdcc`](https://github.com/nodejs/node/commit/46dc12bdcc)] - **test**: enable to work pkcs12 test in FIPS mode (Shigeki Ohtsu) [#5150](https://github.com/nodejs/node/pull/5150) * [[`e19b8ea692`](https://github.com/nodejs/node/commit/e19b8ea692)] - **test**: remove unneeded common.indirectInstanceOf() (Rich Trott) [#5149](https://github.com/nodejs/node/pull/5149) * [[`6072d2e15e`](https://github.com/nodejs/node/commit/6072d2e15e)] - **test**: disable gh-5100 test when in FIPS mode (Fedor Indutny) [#5144](https://github.com/nodejs/node/pull/5144) * [[`a8417a2787`](https://github.com/nodejs/node/commit/a8417a2787)] - **test**: fix flaky test-dgram-pingpong (Rich Trott) [#5125](https://github.com/nodejs/node/pull/5125) * [[`9db67a6a44`](https://github.com/nodejs/node/commit/9db67a6a44)] - **test**: fix child-process-fork-regr-gh-2847 (Santiago Gimeno) [#5121](https://github.com/nodejs/node/pull/5121) * [[`69150caedc`](https://github.com/nodejs/node/commit/69150caedc)] - **test**: don't run test-tick-processor.js on Aix (Michael Dawson) [#5093](https://github.com/nodejs/node/pull/5093) * [[`4a492b96b1`](https://github.com/nodejs/node/commit/4a492b96b1)] - **test**: mark flaky tests on Raspberry Pi (Rich Trott) [#5082](https://github.com/nodejs/node/pull/5082) * [[`4301f2cdc2`](https://github.com/nodejs/node/commit/4301f2cdc2)] - **test**: fix inconsistent styling in test-url (Brian White) [#5014](https://github.com/nodejs/node/pull/5014) * [[`865baaed60`](https://github.com/nodejs/node/commit/865baaed60)] - **test**: fix redeclared vars in sequential tests (Rich Trott) [#4999](https://github.com/nodejs/node/pull/4999) * [[`663e852c1b`](https://github.com/nodejs/node/commit/663e852c1b)] - **test**: pummel test fixes (Rich Trott) [#4998](https://github.com/nodejs/node/pull/4998) * [[`72d38a4a38`](https://github.com/nodejs/node/commit/72d38a4a38)] - **test**: fix redeclared vars in test-vm-* (Rich Trott) [#4997](https://github.com/nodejs/node/pull/4997) * [[`97ddfa2b6e`](https://github.com/nodejs/node/commit/97ddfa2b6e)] - **test**: fix redeclared vars in test-url (Rich Trott) [#4993](https://github.com/nodejs/node/pull/4993) * [[`43d4db4314`](https://github.com/nodejs/node/commit/43d4db4314)] - **test**: fix redeclared test-util-* vars (Rich Trott) [#4994](https://github.com/nodejs/node/pull/4994) * [[`88fae38d0c`](https://github.com/nodejs/node/commit/88fae38d0c)] - **test**: fix variable redeclarations (Rich Trott) [#4992](https://github.com/nodejs/node/pull/4992) * [[`58595f146a`](https://github.com/nodejs/node/commit/58595f146a)] - **test**: fix redeclared test-path vars (Rich Trott) [#4991](https://github.com/nodejs/node/pull/4991) * [[`2b711d51fa`](https://github.com/nodejs/node/commit/2b711d51fa)] - **test**: fix var redeclarations in test-os (Rich Trott) [#4990](https://github.com/nodejs/node/pull/4990) * [[`bd9e2c31d6`](https://github.com/nodejs/node/commit/bd9e2c31d6)] - **test**: fix test-net-* variable redeclarations (Rich Trott) [#4989](https://github.com/nodejs/node/pull/4989) * [[`d67ab81882`](https://github.com/nodejs/node/commit/d67ab81882)] - **test**: fix redeclared test-intl var (Rich Trott) [#4988](https://github.com/nodejs/node/pull/4988) * [[`d6dbb2fae7`](https://github.com/nodejs/node/commit/d6dbb2fae7)] - **test**: fix redeclared test-http-* vars (Rich Trott) [#4987](https://github.com/nodejs/node/pull/4987) * [[`ecaa89a8cb`](https://github.com/nodejs/node/commit/ecaa89a8cb)] - **test**: fix redeclared test-event-emitter-* vars (Rich Trott) [#4985](https://github.com/nodejs/node/pull/4985) * [[`299c729371`](https://github.com/nodejs/node/commit/299c729371)] - **test**: remove redeclared var in test-domain (Rich Trott) [#4984](https://github.com/nodejs/node/pull/4984) * [[`35a4a203bf`](https://github.com/nodejs/node/commit/35a4a203bf)] - **test**: remove var redeclarations in test-crypto-* (Rich Trott) [#4981](https://github.com/nodejs/node/pull/4981) * [[`1d56b74af0`](https://github.com/nodejs/node/commit/1d56b74af0)] - **test**: remove test-cluster-* var redeclarations (Rich Trott) [#4980](https://github.com/nodejs/node/pull/4980) * [[`0ce12cc1ec`](https://github.com/nodejs/node/commit/0ce12cc1ec)] - **test**: fix test-http-extra-response flakiness (Santiago Gimeno) [#4979](https://github.com/nodejs/node/pull/4979) * [[`c6b4bf138c`](https://github.com/nodejs/node/commit/c6b4bf138c)] - **test**: scope redeclared vars in test-child-process* (Rich Trott) [#4944](https://github.com/nodejs/node/pull/4944) * [[`7654c171c7`](https://github.com/nodejs/node/commit/7654c171c7)] - **test**: refactor switch (Rich Trott) [#4870](https://github.com/nodejs/node/pull/4870) * [[`226dfef690`](https://github.com/nodejs/node/commit/226dfef690)] - **test**: add common.platformTimeout() to dgram test (Rich Trott) [#4938](https://github.com/nodejs/node/pull/4938) * [[`fb14bac662`](https://github.com/nodejs/node/commit/fb14bac662)] - **test**: fix flaky cluster test on Windows 10 (Rich Trott) [#4934](https://github.com/nodejs/node/pull/4934) * [[`f5d29d7ac4`](https://github.com/nodejs/node/commit/f5d29d7ac4)] - **test**: Add assertion for TLS peer certificate fingerprint (Alan Cohen) [#4923](https://github.com/nodejs/node/pull/4923) * [[`618427cea6`](https://github.com/nodejs/node/commit/618427cea6)] - **test**: fix test-tls-zero-clear-in flakiness (Santiago Gimeno) [#4888](https://github.com/nodejs/node/pull/4888) * [[`8700c39c70`](https://github.com/nodejs/node/commit/8700c39c70)] - **test**: fix irregular whitespace issue (Roman Reiss) [#4864](https://github.com/nodejs/node/pull/4864) * [[`2b026c9d5a`](https://github.com/nodejs/node/commit/2b026c9d5a)] - **test**: fs.link() test runs on same device (Drew Folta) [#4861](https://github.com/nodejs/node/pull/4861) * [[`80a637ac4d`](https://github.com/nodejs/node/commit/80a637ac4d)] - **test**: scope redeclared variable (Rich Trott) [#4854](https://github.com/nodejs/node/pull/4854) * [[`8c4903d4ef`](https://github.com/nodejs/node/commit/8c4903d4ef)] - **test**: update arrow function style (cjihrig) [#4813](https://github.com/nodejs/node/pull/4813) * [[`0a44e6a447`](https://github.com/nodejs/node/commit/0a44e6a447)] - **test**: mark test-tick-processor flaky (Rich Trott) [#4809](https://github.com/nodejs/node/pull/4809) * [[`363460616c`](https://github.com/nodejs/node/commit/363460616c)] - **test**: refactor test-net-settimeout (Rich Trott) [#4799](https://github.com/nodejs/node/pull/4799) * [[`6841d82c22`](https://github.com/nodejs/node/commit/6841d82c22)] - **test**: remove race condition in http flood test (Rich Trott) [#4793](https://github.com/nodejs/node/pull/4793) * [[`b5bae32847`](https://github.com/nodejs/node/commit/b5bae32847)] - **test**: remove test-http-exit-delay (Rich Trott) [#4786](https://github.com/nodejs/node/pull/4786) * [[`60514f9521`](https://github.com/nodejs/node/commit/60514f9521)] - **test**: refactor test-fs-watch (Rich Trott) [#4776](https://github.com/nodejs/node/pull/4776) * [[`2a3a431119`](https://github.com/nodejs/node/commit/2a3a431119)] - **test**: fix `net-socket-timeout-unref` flakiness (Santiago Gimeno) [#4772](https://github.com/nodejs/node/pull/4772) * [[`9e6f3632a1`](https://github.com/nodejs/node/commit/9e6f3632a1)] - **test**: remove Object.observe from tests (Vladimir Kurchatkin) [#4769](https://github.com/nodejs/node/pull/4769) * [[`f78daa67b8`](https://github.com/nodejs/node/commit/f78daa67b8)] - **test**: make npm tests work on prerelease node versions (Kat Marchán) [#4960](https://github.com/nodejs/node/pull/4960) * [[`1c03191b6a`](https://github.com/nodejs/node/commit/1c03191b6a)] - **test**: make npm tests work on prerelease node versions (Kat Marchán) [#4872](https://github.com/nodejs/node/pull/4872) * [[`d9c22cc896`](https://github.com/nodejs/node/commit/d9c22cc896)] - **test,buffer**: refactor redeclarations (Rich Trott) [#4893](https://github.com/nodejs/node/pull/4893) * [[`5c4960468a`](https://github.com/nodejs/node/commit/5c4960468a)] - **tls**: nullify `.ssl` on handle close (Fedor Indutny) [#5168](https://github.com/nodejs/node/pull/5168) * [[`c0f5f01c9c`](https://github.com/nodejs/node/commit/c0f5f01c9c)] - **tls**: scope loop vars with let (Rich Trott) [#4853](https://github.com/nodejs/node/pull/4853) * [[`c86627e0d1`](https://github.com/nodejs/node/commit/c86627e0d1)] - **(SEMVER-MINOR)** **tls**: add `options` argument to createSecurePair (Коренберг Марк) [#2441](https://github.com/nodejs/node/pull/2441) * [[`c908ff36f4`](https://github.com/nodejs/node/commit/c908ff36f4)] - **tls_wrap**: reach error reporting for UV_EPROTO (Fedor Indutny) [#4885](https://github.com/nodejs/node/pull/4885) * [[`cebe3b95e3`](https://github.com/nodejs/node/commit/cebe3b95e3)] - **tools**: run tick processor without forking (Matt Loring) [#4224](https://github.com/nodejs/node/pull/4224) * [[`70d8827714`](https://github.com/nodejs/node/commit/70d8827714)] - **(SEMVER-MINOR)** **tools**: add --prof-process flag to node binary (Matt Loring) [#4021](https://github.com/nodejs/node/pull/4021) * [[`a43b9291c7`](https://github.com/nodejs/node/commit/a43b9291c7)] - **tools**: replace obsolete ESLint rules (Rich Trott) [#5214](https://github.com/nodejs/node/pull/5214) * [[`a89c6f58f1`](https://github.com/nodejs/node/commit/a89c6f58f1)] - **tools**: update ESLint to version 2.1.0 (Rich Trott) [#5214](https://github.com/nodejs/node/pull/5214) * [[`789f62196a`](https://github.com/nodejs/node/commit/789f62196a)] - **tools**: remove obsolete lint rules (Rich Trott) [#5214](https://github.com/nodejs/node/pull/5214) * [[`154772cfa8`](https://github.com/nodejs/node/commit/154772cfa8)] - **tools**: parse types into links in doc html gen (Claudio Rodriguez) [#4741](https://github.com/nodejs/node/pull/4741) * [[`9237b6e38a`](https://github.com/nodejs/node/commit/9237b6e38a)] - **tools**: fix warning in doc parsing (Shigeki Ohtsu) [#4537](https://github.com/nodejs/node/pull/4537) * [[`c653cc0c03`](https://github.com/nodejs/node/commit/c653cc0c03)] - **tools**: add recommended ES6 lint rules (Rich Trott) [#5210](https://github.com/nodejs/node/pull/5210) * [[`993d9b7df0`](https://github.com/nodejs/node/commit/993d9b7df0)] - **tools**: add recommended linting rules (Rich Trott) [#5188](https://github.com/nodejs/node/pull/5188) * [[`8423125223`](https://github.com/nodejs/node/commit/8423125223)] - **tools**: remove excessive comments from .eslintrc (Rich Trott) [#5151](https://github.com/nodejs/node/pull/5151) * [[`4c687c98e4`](https://github.com/nodejs/node/commit/4c687c98e4)] - **tools**: enable no-proto rule for linter (Jackson Tian) [#5140](https://github.com/nodejs/node/pull/5140) * [[`28e4e6f312`](https://github.com/nodejs/node/commit/28e4e6f312)] - **tools**: disallow mixed spaces and tabs for indents (Rich Trott) [#5135](https://github.com/nodejs/node/pull/5135) * [[`50c6fe8604`](https://github.com/nodejs/node/commit/50c6fe8604)] - **tools**: alphabetize eslint stylistic issues section (Rich Trott) * [[`ee594f1ed7`](https://github.com/nodejs/node/commit/ee594f1ed7)] - **tools**: lint for empty character classes in regex (Rich Trott) [#5115](https://github.com/nodejs/node/pull/5115) * [[`bf0e239e99`](https://github.com/nodejs/node/commit/bf0e239e99)] - **tools**: lint for spacing around unary operators (Rich Trott) [#5063](https://github.com/nodejs/node/pull/5063) * [[`6345acb792`](https://github.com/nodejs/node/commit/6345acb792)] - **tools**: enable no-redeclare rule for linter (Rich Trott) [#5047](https://github.com/nodejs/node/pull/5047) * [[`1dae175b62`](https://github.com/nodejs/node/commit/1dae175b62)] - **tools**: fix redeclared vars in doc/json.js (Rich Trott) [#5047](https://github.com/nodejs/node/pull/5047) * [[`d1d220a1cf`](https://github.com/nodejs/node/commit/d1d220a1cf)] - **tools**: apply linting to doc tools (Rich Trott) [#4973](https://github.com/nodejs/node/pull/4973) * [[`eddde1f60c`](https://github.com/nodejs/node/commit/eddde1f60c)] - **tools**: fix detecting constructor for JSON doc (Timothy Gu) [#4966](https://github.com/nodejs/node/pull/4966) * [[`bcb327c8dd`](https://github.com/nodejs/node/commit/bcb327c8dd)] - **tools**: add property types in JSON documentation (Timothy Gu) [#4884](https://github.com/nodejs/node/pull/4884) * [[`9a06a4c116`](https://github.com/nodejs/node/commit/9a06a4c116)] - **tools**: enable assorted ESLint error rules (Roman Reiss) [#4864](https://github.com/nodejs/node/pull/4864) * [[`38474cfd49`](https://github.com/nodejs/node/commit/38474cfd49)] - **tools**: add arrow function rules to eslint (cjihrig) [#4813](https://github.com/nodejs/node/pull/4813) * [[`f898abaa4f`](https://github.com/nodejs/node/commit/f898abaa4f)] - **tools**: fix setting path containing an ampersand (Brian White) [#4804](https://github.com/nodejs/node/pull/4804) * [[`d10bee8e79`](https://github.com/nodejs/node/commit/d10bee8e79)] - **tools**: enable no-extra-semi rule in eslint (Michaël Zasso) [#2205](https://github.com/nodejs/node/pull/2205) * [[`01006392cf`](https://github.com/nodejs/node/commit/01006392cf)] - **tools,doc**: fix linting errors (Rich Trott) [#5161](https://github.com/nodejs/node/pull/5161) * [[`57a5f8731a`](https://github.com/nodejs/node/commit/57a5f8731a)] - **url**: change scoping of variables with let (Kári Tristan Helgason) [#4867](https://github.com/nodejs/node/pull/4867) ## 2016-03-02, Version 4.3.2 'Argon' (LTS), @thealphanerd This is a security release with only a single commit, an update to openssl due to a recent security advisory. You can read more about the security advisory on [the Node.js website](https://nodejs.org/en/blog/vulnerability/openssl-march-2016/) ### Notable changes * **openssl**: Upgrade from 1.0.2f to 1.0.2g (Ben Noordhuis) [#5507](https://github.com/nodejs/node/pull/5507) - Fix a double-free defect in parsing malformed DSA keys that may potentially be used for DoS or memory corruption attacks. It is likely to be very difficult to use this defect for a practical attack and is therefore considered low severity for Node.js users. More info is available at [CVE-2016-0705](https://www.openssl.org/news/vulnerabilities.html#2016-0705). - Fix a defect that can cause memory corruption in certain very rare cases relating to the internal `BN_hex2bn()` and `BN_dec2bn()` functions. It is believed that Node.js is not invoking the code paths that use these functions so practical attacks via Node.js using this defect are _unlikely_ to be possible. More info is available at [CVE-2016-0797](https://www.openssl.org/news/vulnerabilities.html#2016-0797). - Fix a defect that makes the _[CacheBleed Attack](https://ssrg.nicta.com.au/projects/TS/cachebleed/)_ possible. This defect enables attackers to execute side-channel attacks leading to the potential recovery of entire RSA private keys. It only affects the Intel Sandy Bridge (and possibly older) microarchitecture when using hyper-threading. Newer microarchitectures, including Haswell, are unaffected. More info is available at [CVE-2016-0702](https://www.openssl.org/news/vulnerabilities.html#2016-0702). ## Commits * [[`c133797d09`](https://github.com/nodejs/node/commit/c133797d09)] - **deps**: upgrade openssl to 1.0.2g (Ben Noordhuis) [#5507](https://github.com/nodejs/node/pull/5507) ## 2016-02-16, Version 4.3.1 'Argon' (LTS), @thealphanerd ### Notable changes * **buffer** * make byteLength work with Buffer correctly (Jackson Tian) - [#4738](https://github.com/nodejs/node/pull/4738) * **debugger** * guard against call from non-node context (Ben Noordhuis) - [#4328](https://github.com/nodejs/node/pull/4328) - fixes segfaults in debugger * do not incept debug context (Myles Borins) - [#4819](https://github.com/nodejs/node/pull/4819) - fixes crash in debugger when using util methods * **deps** * update to http-parser 2.5.2 (James Snell) - [#5238](https://github.com/nodejs/node/pull/5238) ### Commits * [[`748d2b4de1`](https://github.com/nodejs/node/commit/748d2b4de1)] - **buffer**: make byteLength work with Buffer correctly (Jackson Tian) [#4738](https://github.com/nodejs/node/pull/4738) * [[`fb615bdaf4`](https://github.com/nodejs/node/commit/fb615bdaf4)] - **buffer**: remove unnecessary TODO comments (Peter Geiss) [#4719](https://github.com/nodejs/node/pull/4719) * [[`b8213ba7e1`](https://github.com/nodejs/node/commit/b8213ba7e1)] - **cluster**: ignore queryServer msgs on disconnection (Santiago Gimeno) [#4465](https://github.com/nodejs/node/pull/4465) * [[`f8a676ed59`](https://github.com/nodejs/node/commit/f8a676ed59)] - **cluster**: fix race condition setting suicide prop (Santiago Gimeno) [#4349](https://github.com/nodejs/node/pull/4349) * [[`9d4a226dad`](https://github.com/nodejs/node/commit/9d4a226dad)] - **crypto**: clear error stack in ECDH::Initialize (Fedor Indutny) [#4689](https://github.com/nodejs/node/pull/4689) * [[`583f3347d8`](https://github.com/nodejs/node/commit/583f3347d8)] - **debugger**: remove variable redeclarations (Rich Trott) [#4633](https://github.com/nodejs/node/pull/4633) * [[`667f7a7ab3`](https://github.com/nodejs/node/commit/667f7a7ab3)] - **debugger**: guard against call from non-node context (Ben Noordhuis) [#4328](https://github.com/nodejs/node/pull/4328) * [[`188cff3c31`](https://github.com/nodejs/node/commit/188cff3c31)] - **deps**: update to http-parser 2.5.2 (James Snell) [#5238](https://github.com/nodejs/node/pull/5238) * [[`6e829b44e3`](https://github.com/nodejs/node/commit/6e829b44e3)] - **dgram**: prevent disabled optimization of bind() (Brian White) [#4613](https://github.com/nodejs/node/pull/4613) * [[`c3956d05b1`](https://github.com/nodejs/node/commit/c3956d05b1)] - **doc**: update list of personal traits in CoC (Kat Marchán) [#4801](https://github.com/nodejs/node/pull/4801) * [[`39cb69ca21`](https://github.com/nodejs/node/commit/39cb69ca21)] - **doc**: style fixes for the TOC (Roman Reiss) [#4748](https://github.com/nodejs/node/pull/4748) * [[`cb5986da81`](https://github.com/nodejs/node/commit/cb5986da81)] - **doc**: add `servername` parameter docs (Alexander Makarenko) [#4729](https://github.com/nodejs/node/pull/4729) * [[`91066b5f34`](https://github.com/nodejs/node/commit/91066b5f34)] - **doc**: update branch-diff arguments in release doc (Rod Vagg) [#4691](https://github.com/nodejs/node/pull/4691) * [[`9ca24de41d`](https://github.com/nodejs/node/commit/9ca24de41d)] - **doc**: add docs for more stream options (zoubin) [#4639](https://github.com/nodejs/node/pull/4639) * [[`437d0e336d`](https://github.com/nodejs/node/commit/437d0e336d)] - **doc**: mention that http.Server inherits from net.Server (Ryan Sobol) [#4455](https://github.com/nodejs/node/pull/4455) * [[`393e569160`](https://github.com/nodejs/node/commit/393e569160)] - **doc**: copyedit setTimeout() documentation (Rich Trott) [#4434](https://github.com/nodejs/node/pull/4434) * [[`e2a682ecc3`](https://github.com/nodejs/node/commit/e2a682ecc3)] - **doc**: fix formatting in process.markdown (Rich Trott) [#4433](https://github.com/nodejs/node/pull/4433) * [[`75b0ea85bd`](https://github.com/nodejs/node/commit/75b0ea85bd)] - **doc**: add path property to Write/ReadStream in fs.markdown (Claudio Rodriguez) [#4368](https://github.com/nodejs/node/pull/4368) * [[`48c2783421`](https://github.com/nodejs/node/commit/48c2783421)] - **doc**: add docs working group (Bryan English) [#4244](https://github.com/nodejs/node/pull/4244) * [[`c0432e9f56`](https://github.com/nodejs/node/commit/c0432e9f56)] - **doc**: restore ICU third-party software licenses (Richard Lau) [#4762](https://github.com/nodejs/node/pull/4762) * [[`36a4159dab`](https://github.com/nodejs/node/commit/36a4159dab)] - **doc**: rebuild LICENSE using tools/license-builder.sh (Rod Vagg) [#4194](https://github.com/nodejs/node/pull/4194) * [[`a2998a1bce`](https://github.com/nodejs/node/commit/a2998a1bce)] - **gitignore**: never ignore debug module (Michaël Zasso) [#2286](https://github.com/nodejs/node/pull/2286) * [[`661b2557d9`](https://github.com/nodejs/node/commit/661b2557d9)] - **http**: remove variable redeclaration (Rich Trott) [#4612](https://github.com/nodejs/node/pull/4612) * [[`1bb2967d48`](https://github.com/nodejs/node/commit/1bb2967d48)] - **http**: fix non-string header value concatenation (Brian White) [#4460](https://github.com/nodejs/node/pull/4460) * [[`15ed64e34c`](https://github.com/nodejs/node/commit/15ed64e34c)] - **lib**: fix style issues after eslint update (Michaël Zasso) [nodejs/io.js#2286](https://github.com/nodejs/io.js/pull/2286) * [[`2e92a1a6b4`](https://github.com/nodejs/node/commit/2e92a1a6b4)] - **module**: move unnecessary work for early return (Andres Suarez) [#3579](https://github.com/nodejs/node/pull/3579) * [[`40c8e6d75d`](https://github.com/nodejs/node/commit/40c8e6d75d)] - **net**: remove hot path comment from connect (Evan Lucas) [#4648](https://github.com/nodejs/node/pull/4648) * [[`8ed0c1c22c`](https://github.com/nodejs/node/commit/8ed0c1c22c)] - **net**: fix dns lookup for android (Josh Dague) [#4580](https://github.com/nodejs/node/pull/4580) * [[`15fa555204`](https://github.com/nodejs/node/commit/15fa555204)] - **net, doc**: fix line wrapping lint in net.js (James M Snell) [#4588](https://github.com/nodejs/node/pull/4588) * [[`1b070e48e0`](https://github.com/nodejs/node/commit/1b070e48e0)] - **node_contextify**: do not incept debug context (Myles Borins) [#4815](https://github.com/nodejs/node/issues/4815) * [[`4fbcb47fe9`](https://github.com/nodejs/node/commit/4fbcb47fe9)] - **readline**: Remove XXX and output debuglog (Kohei TAKATA) [#4690](https://github.com/nodejs/node/pull/4690) * [[`26f02405d0`](https://github.com/nodejs/node/commit/26f02405d0)] - **repl**: make sure historyPath is trimmed (Evan Lucas) [#4539](https://github.com/nodejs/node/pull/4539) * [[`5990ba2a0a`](https://github.com/nodejs/node/commit/5990ba2a0a)] - **src**: remove redeclarations of variables (Rich Trott) [#4605](https://github.com/nodejs/node/pull/4605) * [[`c41ed59dbc`](https://github.com/nodejs/node/commit/c41ed59dbc)] - **src**: don't check failure with ERR_peek_error() (Ben Noordhuis) [#4731](https://github.com/nodejs/node/pull/4731) * [[`d71f9992f9`](https://github.com/nodejs/node/commit/d71f9992f9)] - **stream**: remove useless if test in transform (zoubin) [#4617](https://github.com/nodejs/node/pull/4617) * [[`f205e9920e`](https://github.com/nodejs/node/commit/f205e9920e)] - **test**: fix tls-no-rsa-key flakiness (Santiago Gimeno) [#4043](https://github.com/nodejs/node/pull/4043) * [[`447347cd62`](https://github.com/nodejs/node/commit/447347cd62)] - **test**: fix issues for space-in-parens ESLint rule (Roman Reiss) [#4753](https://github.com/nodejs/node/pull/4753) * [[`be8274508c`](https://github.com/nodejs/node/commit/be8274508c)] - **test**: improve test-cluster-disconnect-suicide-race (Rich Trott) [#4739](https://github.com/nodejs/node/pull/4739) * [[`0178001163`](https://github.com/nodejs/node/commit/0178001163)] - **test**: make test-cluster-disconnect-leak reliable (Rich Trott) [#4736](https://github.com/nodejs/node/pull/4736) * [[`d615757da2`](https://github.com/nodejs/node/commit/d615757da2)] - **test**: fix flaky test-net-socket-local-address (cjihrig) [#4650](https://github.com/nodejs/node/pull/4650) * [[`baa0a3dff5`](https://github.com/nodejs/node/commit/baa0a3dff5)] - **test**: fix race in test-net-server-pause-on-connect (Rich Trott) [#4637](https://github.com/nodejs/node/pull/4637) * [[`909b5167cb`](https://github.com/nodejs/node/commit/909b5167cb)] - **test**: remove 1 second delay from test (Rich Trott) [#4616](https://github.com/nodejs/node/pull/4616) * [[`8ea76608ed`](https://github.com/nodejs/node/commit/8ea76608ed)] - **test**: move resource intensive tests to sequential (Rich Trott) [#4615](https://github.com/nodejs/node/pull/4615) * [[`7afcdd358e`](https://github.com/nodejs/node/commit/7afcdd358e)] - **test**: require common module only once (Rich Trott) [#4611](https://github.com/nodejs/node/pull/4611) * [[`0e02eb0bbe`](https://github.com/nodejs/node/commit/0e02eb0bbe)] - **test**: only include http module once (Rich Trott) [#4606](https://github.com/nodejs/node/pull/4606) * [[`34d9e48bb6`](https://github.com/nodejs/node/commit/34d9e48bb6)] - **test**: fix `http-upgrade-client` flakiness (Santiago Gimeno) [#4602](https://github.com/nodejs/node/pull/4602) * [[`556703d531`](https://github.com/nodejs/node/commit/556703d531)] - **test**: fix flaky unrefed timers test (Rich Trott) [#4599](https://github.com/nodejs/node/pull/4599) * [[`3d5bc69796`](https://github.com/nodejs/node/commit/3d5bc69796)] - **test**: fix `http-upgrade-agent` flakiness (Santiago Gimeno) [#4520](https://github.com/nodejs/node/pull/4520) * [[`ec24d3767b`](https://github.com/nodejs/node/commit/ec24d3767b)] - **test**: fix flaky test-cluster-shared-leak (Rich Trott) [#4510](https://github.com/nodejs/node/pull/4510) * [[`a256790327`](https://github.com/nodejs/node/commit/a256790327)] - **test**: fix flaky cluster-net-send (Brian White) [#4444](https://github.com/nodejs/node/pull/4444) * [[`6809c2be1a`](https://github.com/nodejs/node/commit/6809c2be1a)] - **test**: fix flaky child-process-fork-regr-gh-2847 (Brian White) [#4442](https://github.com/nodejs/node/pull/4442) * [[`e6448aa36b`](https://github.com/nodejs/node/commit/e6448aa36b)] - **test**: use addon.md block headings as test dir names (Rod Vagg) [#4412](https://github.com/nodejs/node/pull/4412) * [[`305d340fca`](https://github.com/nodejs/node/commit/305d340fca)] - **test**: test each block in addon.md contains js & cc (Rod Vagg) [#4411](https://github.com/nodejs/node/pull/4411) * [[`f213406575`](https://github.com/nodejs/node/commit/f213406575)] - **test**: fix tls-multi-key race condition (Santiago Gimeno) [#3966](https://github.com/nodejs/node/pull/3966) * [[`607f545568`](https://github.com/nodejs/node/commit/607f545568)] - **test**: fix style issues after eslint update (Michaël Zasso) [nodejs/io.js#2286](https://github.com/nodejs/io.js/pull/2286) * [[`aefb20a94f`](https://github.com/nodejs/node/commit/aefb20a94f)] - **tls**: copy client CAs and cert store on CertCb (Fedor Indutny) [#3537](https://github.com/nodejs/node/pull/3537) * [[`7821b3e305`](https://github.com/nodejs/node/commit/7821b3e305)] - **tls_legacy**: do not read on OpenSSL's stack (Fedor Indutny) [#4624](https://github.com/nodejs/node/pull/4624) * [[`b66db49f94`](https://github.com/nodejs/node/commit/b66db49f94)] - **tools**: add support for subkeys in release tools (Myles Borins) [#4807](https://github.com/nodejs/node/pull/4807) * [[`837ebd1985`](https://github.com/nodejs/node/commit/837ebd1985)] - **tools**: enable space-in-parens ESLint rule (Roman Reiss) [#4753](https://github.com/nodejs/node/pull/4753) * [[`066d5e7da2`](https://github.com/nodejs/node/commit/066d5e7da2)] - **tools**: fix style issue after eslint update (Michaël Zasso) [nodejs/io.js#2286](https://github.com/nodejs/io.js/pull/2286) * [[`b20ea69f46`](https://github.com/nodejs/node/commit/b20ea69f46)] - **tools**: update eslint config (Michaël Zasso) [nodejs/io.js#2286](https://github.com/nodejs/io.js/pull/2286) * [[`2e0352d50c`](https://github.com/nodejs/node/commit/2e0352d50c)] - **tools**: update eslint to v1.10.3 (Michaël Zasso) [nodejs/io.js#2286](https://github.com/nodejs/io.js/pull/2286) * [[`c96800a432`](https://github.com/nodejs/node/commit/c96800a432)] - **tools**: fix license-builder.sh for ICU (Richard Lau) [#4762](https://github.com/nodejs/node/pull/4762) * [[`720b03dca7`](https://github.com/nodejs/node/commit/720b03dca7)] - **tools**: add license-builder.sh to construct LICENSE (Rod Vagg) [#4194](https://github.com/nodejs/node/pull/4194) ## 2016-02-09, Version 4.3.0 'Argon' (LTS), @jasnell This is an important security release. All Node.js users should consult the security release summary at nodejs.org for details on patched vulnerabilities. Note that this release includes a non-backward compatible change to address a security issue. This change increases the version of the LTS v4.x line to v4.3.0. There will be *no further updates* to v4.2.x. ### Notable changes * **http**: fix defects in HTTP header parsing for requests and responses that can allow request smuggling (CVE-2016-2086) or response splitting (CVE-2016-2216). HTTP header parsing now aligns more closely with the HTTP spec including restricting the acceptable characters. * **http-parser**: upgrade from 2.5.0 to 2.5.1 * **openssl**: upgrade from 1.0.2e to 1.0.2f. To mitigate against the Logjam attack, TLS clients now reject Diffie-Hellman handshakes with parameters shorter than 1024-bits, up from the previous limit of 768-bits. * **src**: - introduce new `--security-revert={cvenum}` command line flag for selective reversion of specific CVE fixes - allow the fix for CVE-2016-2216 to be selectively reverted using `--security-revert=CVE-2016-2216` ### Commits * [[`d94f864abd`](https://github.com/nodejs/node/commit/d94f864abd0933c125afeb84b6f72ec709c63b43)] - **deps**: add -no_rand_screen to openssl s_client (Shigeki Ohtsu) [#1836](https://github.com/nodejs/node/pull/1836) * [[`136295e202`](https://github.com/nodejs/node/commit/136295e202)] - **deps**: upgrade openssl sources to 1.0.2f (Myles Borins) [#4961](https://github.com/nodejs/node/pull/4961) * [[`0eae95eae3`](https://github.com/nodejs/node/commit/0eae95eae3)] - **(SEMVER-MINOR)** **deps**: update http-parser to version 2.5.1 (James M Snell) * [[`cf2b714b02`](https://github.com/nodejs/node/commit/cf2b714b02)] - **(SEMVER-MINOR)** **http**: strictly forbid invalid characters from headers (James M Snell) * [[`49ae2e0334`](https://github.com/nodejs/node/commit/49ae2e0334)] - **src**: avoid compiler warning in node_revert.cc (James M Snell) * [[`da3750f981`](https://github.com/nodejs/node/commit/da3750f981)] - **(SEMVER-MAJOR)** **src**: add --security-revert command line flag (James M Snell) ## 2016-01-21, Version 4.2.6 'Argon' (LTS), @TheAlphaNerd ### Notable changes * Fix regression in debugger and profiler functionality ### Known issues * Some problems with unreferenced timers running during `beforeExit` are still to be resolved. See [#1264](https://github.com/nodejs/node/issues/1264). * Surrogate pair in REPL can freeze terminal. [#690](https://github.com/nodejs/node/issues/690) * Calling `dns.setServers()` while a DNS query is in progress can cause the process to crash on a failed assertion. [#894](https://github.com/nodejs/node/issues/894) * `url.resolve` may transfer the auth portion of the url when resolving between two full hosts, see [#1435](https://github.com/nodejs/node/issues/1435). ### Commits * [[`1408f7abb1`](https://github.com/nodejs/node/commit/1408f7abb1)] - **module,src**: do not wrap modules with -1 lineOffset (cjihrig) [#4298](https://github.com/nodejs/node/pull/4298) * [[`1f8e1472cc`](https://github.com/nodejs/node/commit/1f8e1472cc)] - **test**: add test for debugging one line files (cjihrig) [#4298](https://github.com/nodejs/node/pull/4298) ## 2016-01-20, Version 4.2.5 'Argon' (LTS), @TheAlphaNerd Maintenance update. ### Notable changes * **assert** * accommodate ES6 classes that extend Error (Rich Trott) [#4166](https://github.com/nodejs/node/pull/4166) * **build** * add "--partly-static" build options (Super Zheng) [#4152](https://github.com/nodejs/node/pull/4152) * **deps** * backport 066747e from upstream V8 (Ali Ijaz Sheikh) [#4655](https://github.com/nodejs/node/pull/4655) * backport 200315c from V8 upstream (Vladimir Kurchatkin) [#4128](https://github.com/nodejs/node/pull/4128) * upgrade libuv to 1.8.0 (Saúl Ibarra Corretgé) * **docs** * various updates landed in 70 different commits! * **repl** * attach location info to syntax errors (cjihrig) [#4013](https://github.com/nodejs/node/pull/4013) * display error message when loading directory (Prince J Wesley) [#4170](https://github.com/nodejs/node/pull/4170) * **tests** * various updates landed in over 50 commits * **tools** * add tap output to cpplint (Johan Bergström) [#3448](https://github.com/nodejs/node/pull/3448) * **util** * allow lookup of hidden values (cjihrig) [#3988](https://github.com/nodejs/node/pull/3988) ### Known issues * Some problems with unreferenced timers running during `beforeExit` are still to be resolved. See [#1264](https://github.com/nodejs/node/issues/1264). * Surrogate pair in REPL can freeze terminal. [#690](https://github.com/nodejs/node/issues/690) * Calling `dns.setServers()` while a DNS query is in progress can cause the process to crash on a failed assertion. [#894](https://github.com/nodejs/node/issues/894) * `url.resolve` may transfer the auth portion of the url when resolving between two full hosts, see [#1435](https://github.com/nodejs/node/issues/1435). ### Commits * [[`87181cd74c`](https://github.com/nodejs/node/commit/87181cd74c)] - **assert**: accommodate ES6 classes that extend Error (Rich Trott) [#4166](https://github.com/nodejs/node/pull/4166) * [[`901172a783`](https://github.com/nodejs/node/commit/901172a783)] - **assert**: typed array deepequal performance fix (Claudio Rodriguez) [#4330](https://github.com/nodejs/node/pull/4330) * [[`55336810ee`](https://github.com/nodejs/node/commit/55336810ee)] - **async_wrap**: call callback in destructor (Trevor Norris) [#3461](https://github.com/nodejs/node/pull/3461) * [[`a8b45e9e96`](https://github.com/nodejs/node/commit/a8b45e9e96)] - **async_wrap**: new instances get uid (Trevor Norris) [#3461](https://github.com/nodejs/node/pull/3461) * [[`49f16d77c4`](https://github.com/nodejs/node/commit/49f16d77c4)] - **async_wrap**: allow some hooks to be optional (Trevor Norris) [#3461](https://github.com/nodejs/node/pull/3461) * [[`44ee33f945`](https://github.com/nodejs/node/commit/44ee33f945)] - **buffer**: refactor create buffer (Jackson Tian) [#4340](https://github.com/nodejs/node/pull/4340) * [[`138d004ac0`](https://github.com/nodejs/node/commit/138d004ac0)] - **buffer**: faster case for create Buffer from new Buffer(0) (Jackson Tian) [#4326](https://github.com/nodejs/node/pull/4326) * [[`c6dc2a1609`](https://github.com/nodejs/node/commit/c6dc2a1609)] - **buffer**: Prevent Buffer constructor deopt (Bryce Baril) [#4158](https://github.com/nodejs/node/pull/4158) * [[`a320045e68`](https://github.com/nodejs/node/commit/a320045e68)] - **buffer**: default to UTF8 in byteLength() (Tom Gallacher) [#4010](https://github.com/nodejs/node/pull/4010) * [[`c5f71ac771`](https://github.com/nodejs/node/commit/c5f71ac771)] - **build**: add "--partly-static" build options (Super Zheng) [#4152](https://github.com/nodejs/node/pull/4152) * [[`e6c25335ea`](https://github.com/nodejs/node/commit/e6c25335ea)] - **build**: omit -gline-tables-only for --enable-asan (Ben Noordhuis) [#3680](https://github.com/nodejs/node/pull/3680) * [[`80b4ba286c`](https://github.com/nodejs/node/commit/80b4ba286c)] - **build**: Updates for AIX npm support - part 1 (Michael Dawson) [#3114](https://github.com/nodejs/node/pull/3114) * [[`35e32985ca`](https://github.com/nodejs/node/commit/35e32985ca)] - **child_process**: guard against race condition (Rich Trott) [#4418](https://github.com/nodejs/node/pull/4418) * [[`48564204f0`](https://github.com/nodejs/node/commit/48564204f0)] - **child_process**: flush consuming streams (Dave) [#4071](https://github.com/nodejs/node/pull/4071) * [[`481d59a74c`](https://github.com/nodejs/node/commit/481d59a74c)] - **configure**: fix arm vfpv2 (Jörg Krause) [#4203](https://github.com/nodejs/node/pull/4203) * [[`d19da6638d`](https://github.com/nodejs/node/commit/d19da6638d)] - **crypto**: load PFX chain the same way as regular one (Fedor Indutny) [#4165](https://github.com/nodejs/node/pull/4165) * [[`b8e75de1f3`](https://github.com/nodejs/node/commit/b8e75de1f3)] - **crypto**: fix native module compilation with FIPS (Stefan Budeanu) [#4023](https://github.com/nodejs/node/pull/4023) * [[`b7c3fb7f75`](https://github.com/nodejs/node/commit/b7c3fb7f75)] - **crypto**: disable crypto.createCipher in FIPS mode (Stefan Budeanu) [#3754](https://github.com/nodejs/node/pull/3754) * [[`31b4091a1e`](https://github.com/nodejs/node/commit/31b4091a1e)] - **debugger**: also exit when the repl emits 'exit' (Felix Böhm) [#2369](https://github.com/nodejs/node/pull/2369) * [[`9baa5618f5`](https://github.com/nodejs/node/commit/9baa5618f5)] - **deps**: backport 066747e from upstream V8 (Ali Ijaz Sheikh) [#4655](https://github.com/nodejs/node/pull/4655) * [[`c3a9d8a62e`](https://github.com/nodejs/node/commit/c3a9d8a62e)] - **deps**: backport 200315c from V8 upstream (Vladimir Kurchatkin) [#4128](https://github.com/nodejs/node/pull/4128) * [[`1ebb0c0fdf`](https://github.com/nodejs/node/commit/1ebb0c0fdf)] - **deps**: upgrade libuv to 1.8.0 (Saúl Ibarra Corretgé) [#4276](https://github.com/nodejs/node/pull/4276) * [[`253fe3e7c8`](https://github.com/nodejs/node/commit/253fe3e7c8)] - **dns**: remove nonexistant exports.ADNAME (Roman Reiss) [#3051](https://github.com/nodejs/node/pull/3051) * [[`8c2b65ad82`](https://github.com/nodejs/node/commit/8c2b65ad82)] - **doc**: clarify protocol default in http.request() (cjihrig) [#4714](https://github.com/nodejs/node/pull/4714) * [[`33e72e135f`](https://github.com/nodejs/node/commit/33e72e135f)] - **doc**: update links to use https where possible (jpersson) [#4054](https://github.com/nodejs/node/pull/4054) * [[`5f4aa79410`](https://github.com/nodejs/node/commit/5f4aa79410)] - **doc**: clarify explanation of first stream section (Vitor Cortez) [#4234](https://github.com/nodejs/node/pull/4234) * [[`295ca5bfb2`](https://github.com/nodejs/node/commit/295ca5bfb2)] - **doc**: add branch-diff example to releases.md (Myles Borins) [#4636](https://github.com/nodejs/node/pull/4636) * [[`18f5cd8710`](https://github.com/nodejs/node/commit/18f5cd8710)] - **doc**: update stylesheet to match frontpage (Roman Reiss) [#4621](https://github.com/nodejs/node/pull/4621) * [[`2f40715f08`](https://github.com/nodejs/node/commit/2f40715f08)] - **doc**: adds usage of readline line-by-line parsing (Robert Jefe Lindstaedt) [#4609](https://github.com/nodejs/node/pull/4609) * [[`5b45a464ee`](https://github.com/nodejs/node/commit/5b45a464ee)] - **doc**: document http's server.listen return value (Sequoia McDowell) [#4590](https://github.com/nodejs/node/pull/4590) * [[`bd31740339`](https://github.com/nodejs/node/commit/bd31740339)] - **doc**: label http.IncomingMessage as a Class (Sequoia McDowell) [#4589](https://github.com/nodejs/node/pull/4589) * [[`bcd2cbbb93`](https://github.com/nodejs/node/commit/bcd2cbbb93)] - **doc**: fix description about the latest-codename (Minwoo Jung) [#4583](https://github.com/nodejs/node/pull/4583) * [[`0b12bcb35d`](https://github.com/nodejs/node/commit/0b12bcb35d)] - **doc**: add Evan Lucas to Release Team (Evan Lucas) [#4579](https://github.com/nodejs/node/pull/4579) * [[`e20b1f6f10`](https://github.com/nodejs/node/commit/e20b1f6f10)] - **doc**: add Myles Borins to Release Team (Myles Borins) [#4578](https://github.com/nodejs/node/pull/4578) * [[`54977e63eb`](https://github.com/nodejs/node/commit/54977e63eb)] - **doc**: add missing backtick for readline (Brian White) [#4549](https://github.com/nodejs/node/pull/4549) * [[`5d6bed895c`](https://github.com/nodejs/node/commit/5d6bed895c)] - **doc**: bring releases.md up to date (cjihrig) [#4540](https://github.com/nodejs/node/pull/4540) * [[`0cd2252e85`](https://github.com/nodejs/node/commit/0cd2252e85)] - **doc**: fix numbering in stream.markdown (Richard Sun) [#4538](https://github.com/nodejs/node/pull/4538) * [[`8574d91f27`](https://github.com/nodejs/node/commit/8574d91f27)] - **doc**: stronger suggestion for userland assert (Wyatt Preul) [#4535](https://github.com/nodejs/node/pull/4535) * [[`a7bcf8b84d`](https://github.com/nodejs/node/commit/a7bcf8b84d)] - **doc**: close backtick in process.title description (Dave) [#4534](https://github.com/nodejs/node/pull/4534) * [[`0ceb3148b0`](https://github.com/nodejs/node/commit/0ceb3148b0)] - **doc**: improvements to events.markdown copy (James M Snell) [#4468](https://github.com/nodejs/node/pull/4468) * [[`bf56d509b9`](https://github.com/nodejs/node/commit/bf56d509b9)] - **doc**: explain ClientRequest#setTimeout time unit (Ben Ripkens) [#4458](https://github.com/nodejs/node/pull/4458) * [[`d927c51be3`](https://github.com/nodejs/node/commit/d927c51be3)] - **doc**: improvements to errors.markdown copy (James M Snell) [#4454](https://github.com/nodejs/node/pull/4454) * [[`ceea6df581`](https://github.com/nodejs/node/commit/ceea6df581)] - **doc**: improvements to dns.markdown copy (James M Snell) [#4449](https://github.com/nodejs/node/pull/4449) * [[`506f2f8ed1`](https://github.com/nodejs/node/commit/506f2f8ed1)] - **doc**: add anchors for _transform _flush _writev in stream.markdown (iamchenxin) [#4448](https://github.com/nodejs/node/pull/4448) * [[`74bcad0b78`](https://github.com/nodejs/node/commit/74bcad0b78)] - **doc**: improvements to dgram.markdown copy (James M Snell) [#4437](https://github.com/nodejs/node/pull/4437) * [[`e244d560c9`](https://github.com/nodejs/node/commit/e244d560c9)] - **doc**: improvements to debugger.markdown copy (James M Snell) [#4436](https://github.com/nodejs/node/pull/4436) * [[`df7e1281a5`](https://github.com/nodejs/node/commit/df7e1281a5)] - **doc**: improvements to console.markdown copy (James M Snell) [#4428](https://github.com/nodejs/node/pull/4428) * [[`abb17cc6c1`](https://github.com/nodejs/node/commit/abb17cc6c1)] - **doc**: fix spelling error in lib/url.js comment (Nik Nyby) [#4390](https://github.com/nodejs/node/pull/4390) * [[`823269db2d`](https://github.com/nodejs/node/commit/823269db2d)] - **doc**: improve assert.markdown copy (James M Snell) [#4360](https://github.com/nodejs/node/pull/4360) * [[`2b1804f6cb`](https://github.com/nodejs/node/commit/2b1804f6cb)] - **doc**: copyedit releases.md (Rich Trott) [#4384](https://github.com/nodejs/node/pull/4384) * [[`2b142fd876`](https://github.com/nodejs/node/commit/2b142fd876)] - **doc**: catch the WORKING_GROUPS.md bootstrap docs up to date (James M Snell) [#4367](https://github.com/nodejs/node/pull/4367) * [[`ed87873de3`](https://github.com/nodejs/node/commit/ed87873de3)] - **doc**: fix link in addons.markdown (Nicholas Young) [#4331](https://github.com/nodejs/node/pull/4331) * [[`fe693b7a4f`](https://github.com/nodejs/node/commit/fe693b7a4f)] - **doc**: Typo in buffer.markdown referencing buf.write() (chrisjohn404) [#4324](https://github.com/nodejs/node/pull/4324) * [[`764df2166e`](https://github.com/nodejs/node/commit/764df2166e)] - **doc**: document the cache parameter for fs.realpathSync (Jackson Tian) [#4285](https://github.com/nodejs/node/pull/4285) * [[`61f91b2f29`](https://github.com/nodejs/node/commit/61f91b2f29)] - **doc**: fix, modernize examples in docs (James M Snell) [#4282](https://github.com/nodejs/node/pull/4282) * [[`d87ad302ce`](https://github.com/nodejs/node/commit/d87ad302ce)] - **doc**: clarify error events in HTTP module documentation (Lenny Markus) [#4275](https://github.com/nodejs/node/pull/4275) * [[`7983577e41`](https://github.com/nodejs/node/commit/7983577e41)] - **doc**: fix improper http.get sample code (Hideki Yamamura) [#4263](https://github.com/nodejs/node/pull/4263) * [[`6c30d087e5`](https://github.com/nodejs/node/commit/6c30d087e5)] - **doc**: Fixing broken links to the v8 wiki (Tom Gallacher) [#4241](https://github.com/nodejs/node/pull/4241) * [[`cf214e56e4`](https://github.com/nodejs/node/commit/cf214e56e4)] - **doc**: move description of 'equals' method to right place (janriemer) [#4227](https://github.com/nodejs/node/pull/4227) * [[`fb8e8dbb92`](https://github.com/nodejs/node/commit/fb8e8dbb92)] - **doc**: copyedit console doc (Rich Trott) [#4225](https://github.com/nodejs/node/pull/4225) * [[`4ccf04c229`](https://github.com/nodejs/node/commit/4ccf04c229)] - **doc**: add mcollina to collaborators (Matteo Collina) [#4220](https://github.com/nodejs/node/pull/4220) * [[`59654c21d4`](https://github.com/nodejs/node/commit/59654c21d4)] - **doc**: add rmg to collaborators (Ryan Graham) [#4219](https://github.com/nodejs/node/pull/4219) * [[`bfe1a6bd2b`](https://github.com/nodejs/node/commit/bfe1a6bd2b)] - **doc**: add calvinmetcalf to collaborators (Calvin Metcalf) [#4218](https://github.com/nodejs/node/pull/4218) * [[`5140c404ae`](https://github.com/nodejs/node/commit/5140c404ae)] - **doc**: harmonize description of `ca` argument (Ben Noordhuis) [#4213](https://github.com/nodejs/node/pull/4213) * [[`2e642051cf`](https://github.com/nodejs/node/commit/2e642051cf)] - **doc**: copyedit child_process doc (Rich Trott) [#4188](https://github.com/nodejs/node/pull/4188) * [[`7920f8dbde`](https://github.com/nodejs/node/commit/7920f8dbde)] - **doc**: copyedit buffer doc (Rich Trott) [#4187](https://github.com/nodejs/node/pull/4187) * [[`c35a409cbe`](https://github.com/nodejs/node/commit/c35a409cbe)] - **doc**: clarify assert.fail doc (Rich Trott) [#4186](https://github.com/nodejs/node/pull/4186) * [[`6235fdf72e`](https://github.com/nodejs/node/commit/6235fdf72e)] - **doc**: copyedit addons doc (Rich Trott) [#4185](https://github.com/nodejs/node/pull/4185) * [[`990e7ff93e`](https://github.com/nodejs/node/commit/990e7ff93e)] - **doc**: update AUTHORS list (Rod Vagg) [#4183](https://github.com/nodejs/node/pull/4183) * [[`8d676ef55e`](https://github.com/nodejs/node/commit/8d676ef55e)] - **doc**: change references from node to Node.js (Roman Klauke) [#4177](https://github.com/nodejs/node/pull/4177) * [[`1c34b139a2`](https://github.com/nodejs/node/commit/1c34b139a2)] - **doc**: add brief Node.js overview to README (wurde) [#4174](https://github.com/nodejs/node/pull/4174) * [[`27b9b72ab0`](https://github.com/nodejs/node/commit/27b9b72ab0)] - **doc**: add iarna to collaborators (Rebecca Turner) [#4144](https://github.com/nodejs/node/pull/4144) * [[`683d8dd564`](https://github.com/nodejs/node/commit/683d8dd564)] - **doc**: add JungMinu to collaborators (Minwoo Jung) [#4143](https://github.com/nodejs/node/pull/4143) * [[`17b06dfa94`](https://github.com/nodejs/node/commit/17b06dfa94)] - **doc**: add zkat to collaborators (Kat Marchán) [#4142](https://github.com/nodejs/node/pull/4142) * [[`39364c4c72`](https://github.com/nodejs/node/commit/39364c4c72)] - **doc**: improve child_process.markdown wording (yorkie) [#4138](https://github.com/nodejs/node/pull/4138) * [[`abe452835f`](https://github.com/nodejs/node/commit/abe452835f)] - **doc**: url.format - true slash postfix behaviour (fansworld-claudio) [#4119](https://github.com/nodejs/node/pull/4119) * [[`6dd375cfe2`](https://github.com/nodejs/node/commit/6dd375cfe2)] - **doc**: document backlog for server.listen() variants (Jan Schär) [#4025](https://github.com/nodejs/node/pull/4025) * [[`b71a3b363a`](https://github.com/nodejs/node/commit/b71a3b363a)] - **doc**: fixup socket.remoteAddress (Arthur Gautier) [#4198](https://github.com/nodejs/node/pull/4198) * [[`e2fe214857`](https://github.com/nodejs/node/commit/e2fe214857)] - **doc**: add links and backticks around names (jpersson) [#4054](https://github.com/nodejs/node/pull/4054) * [[`bb158f8aed`](https://github.com/nodejs/node/commit/bb158f8aed)] - **doc**: s/node.js/Node.js in readme (Rod Vagg) [#3998](https://github.com/nodejs/node/pull/3998) * [[`f55491ad47`](https://github.com/nodejs/node/commit/f55491ad47)] - **doc**: move fs.existsSync() deprecation message (Martin Forsberg) [#3942](https://github.com/nodejs/node/pull/3942) * [[`8c5b847f5b`](https://github.com/nodejs/node/commit/8c5b847f5b)] - **doc**: Describe FIPSDIR environment variable (Stefan Budeanu) [#3752](https://github.com/nodejs/node/pull/3752) * [[`70c95ea0e5`](https://github.com/nodejs/node/commit/70c95ea0e5)] - **doc**: add warning about Windows process groups (Roman Klauke) [#3681](https://github.com/nodejs/node/pull/3681) * [[`46c59b7256`](https://github.com/nodejs/node/commit/46c59b7256)] - **doc**: add CTC meeting minutes 2015-10-28 (Rod Vagg) [#3661](https://github.com/nodejs/node/pull/3661) * [[`7ffd299a1d`](https://github.com/nodejs/node/commit/7ffd299a1d)] - **doc**: add final full stop in CONTRIBUTING.md (Emily Aviva Kapor-Mater) [#3576](https://github.com/nodejs/node/pull/3576) * [[`1f78bff7ce`](https://github.com/nodejs/node/commit/1f78bff7ce)] - **doc**: add TSC meeting minutes 2015-10-21 (Rod Vagg) [#3480](https://github.com/nodejs/node/pull/3480) * [[`2e623ff024`](https://github.com/nodejs/node/commit/2e623ff024)] - **doc**: add TSC meeting minutes 2015-10-14 (Rod Vagg) [#3463](https://github.com/nodejs/node/pull/3463) * [[`b9c69964bb`](https://github.com/nodejs/node/commit/b9c69964bb)] - **doc**: add TSC meeting minutes 2015-10-07 (Rod Vagg) [#3364](https://github.com/nodejs/node/pull/3364) * [[`f31d23c724`](https://github.com/nodejs/node/commit/f31d23c724)] - **doc**: add TSC meeting minutes 2015-09-30 (Rod Vagg) [#3235](https://github.com/nodejs/node/pull/3235) * [[`ae8e3af178`](https://github.com/nodejs/node/commit/ae8e3af178)] - **doc**: update irc channels: #node.js and #node-dev (Nelson Pecora) [#2743](https://github.com/nodejs/node/pull/2743) * [[`830caeb1bd`](https://github.com/nodejs/node/commit/830caeb1bd)] - **doc, test**: symbols as event names (Bryan English) [#4151](https://github.com/nodejs/node/pull/4151) * [[`82cbfcdcbe`](https://github.com/nodejs/node/commit/82cbfcdcbe)] - **docs**: update gpg key for Myles Borins (Myles Borins) [#4657](https://github.com/nodejs/node/pull/4657) * [[`50b72aa5a3`](https://github.com/nodejs/node/commit/50b72aa5a3)] - **docs**: fix npm command in releases.md (Myles Borins) [#4656](https://github.com/nodejs/node/pull/4656) * [[`5bf56882e1`](https://github.com/nodejs/node/commit/5bf56882e1)] - **fs,doc**: use `target` instead of `destination` (yorkie) [#3912](https://github.com/nodejs/node/pull/3912) * [[`41fcda840c`](https://github.com/nodejs/node/commit/41fcda840c)] - **http**: use `self.keepAlive` instead of `self.options.keepAlive` (Damian Schenkelman) [#4407](https://github.com/nodejs/node/pull/4407) * [[`3ff237333d`](https://github.com/nodejs/node/commit/3ff237333d)] - **http**: Remove an unnecessary assignment (Bo Borgerson) [#4323](https://github.com/nodejs/node/pull/4323) * [[`39dc054572`](https://github.com/nodejs/node/commit/39dc054572)] - **http**: remove excess calls to removeSocket (Dave) [#4172](https://github.com/nodejs/node/pull/4172) * [[`751fbd84dd`](https://github.com/nodejs/node/commit/751fbd84dd)] - **https**: use `servername` in agent key (Fedor Indutny) [#4389](https://github.com/nodejs/node/pull/4389) * [[`7a1a0a0055`](https://github.com/nodejs/node/commit/7a1a0a0055)] - **lib**: remove unused modules (Rich Trott) [#4683](https://github.com/nodejs/node/pull/4683) * [[`3d81ea99bb`](https://github.com/nodejs/node/commit/3d81ea99bb)] - **lib,test**: update let to const where applicable (Sakthipriyan Vairamani) [#3152](https://github.com/nodejs/node/pull/3152) * [[`8a9869eeab`](https://github.com/nodejs/node/commit/8a9869eeab)] - **module**: fix column offsets in errors (Tristian Flanagan) [#2867](https://github.com/nodejs/node/pull/2867) * [[`0ae90ecd3d`](https://github.com/nodejs/node/commit/0ae90ecd3d)] - **module,repl**: remove repl require() hack (Ben Noordhuis) [#4026](https://github.com/nodejs/node/pull/4026) * [[`a7367fdc1e`](https://github.com/nodejs/node/commit/a7367fdc1e)] - **net**: small code cleanup (Jan Schär) [#3943](https://github.com/nodejs/node/pull/3943) * [[`03e9495cc2`](https://github.com/nodejs/node/commit/03e9495cc2)] - **node**: remove unused variables in AppendExceptionLine (Yazhong Liu) [#4264](https://github.com/nodejs/node/pull/4264) * [[`06113b8711`](https://github.com/nodejs/node/commit/06113b8711)] - **node**: s/doNTCallbackX/nextTickCallbackWithXArgs/ (Rod Vagg) [#4167](https://github.com/nodejs/node/pull/4167) * [[`8ce6843fe4`](https://github.com/nodejs/node/commit/8ce6843fe4)] - **os**: fix crash in GetInterfaceAddresses (Martin Bark) [#4272](https://github.com/nodejs/node/pull/4272) * [[`53dcbb6aa4`](https://github.com/nodejs/node/commit/53dcbb6aa4)] - **repl**: remove unused function (Rich Trott) * [[`db0e906fc1`](https://github.com/nodejs/node/commit/db0e906fc1)] - **repl**: Fixed node repl history edge case. (Mudit Ameta) [#4108](https://github.com/nodejs/node/pull/4108) * [[`9855fab05f`](https://github.com/nodejs/node/commit/9855fab05f)] - **repl**: use String#repeat instead of Array#join (Evan Lucas) [#3900](https://github.com/nodejs/node/pull/3900) * [[`41882e4077`](https://github.com/nodejs/node/commit/41882e4077)] - **repl**: fix require('3rdparty') regression (Ben Noordhuis) [#4215](https://github.com/nodejs/node/pull/4215) * [[`93afc39d4a`](https://github.com/nodejs/node/commit/93afc39d4a)] - **repl**: attach location info to syntax errors (cjihrig) [#4013](https://github.com/nodejs/node/pull/4013) * [[`d4806675a6`](https://github.com/nodejs/node/commit/d4806675a6)] - **repl**: display error message when loading directory (Prince J Wesley) [#4170](https://github.com/nodejs/node/pull/4170) * [[`3080bdc7d7`](https://github.com/nodejs/node/commit/3080bdc7d7)] - **src**: define Is* util functions with macros (cjihrig) [#4118](https://github.com/nodejs/node/pull/4118) * [[`2b8a32a13b`](https://github.com/nodejs/node/commit/2b8a32a13b)] - **src**: refactor vcbuild configure args creation (Rod Vagg) [#3399](https://github.com/nodejs/node/pull/3399) * [[`d47f6ba768`](https://github.com/nodejs/node/commit/d47f6ba768)] - **src**: fix deprecation message for ErrnoException (Martin von Gagern) [#4269](https://github.com/nodejs/node/pull/4269) * [[`5ba08fbf76`](https://github.com/nodejs/node/commit/5ba08fbf76)] - **src**: fix line numbers on core errors (cjihrig) [#4254](https://github.com/nodejs/node/pull/4254) * [[`70974e9362`](https://github.com/nodejs/node/commit/70974e9362)] - **src**: use GetCurrentProcessId() for process.pid (Ben Noordhuis) [#4163](https://github.com/nodejs/node/pull/4163) * [[`c96eca164f`](https://github.com/nodejs/node/commit/c96eca164f)] - **src**: don't print garbage errors (cjihrig) [#4112](https://github.com/nodejs/node/pull/4112) * [[`f61412c753`](https://github.com/nodejs/node/commit/f61412c753)] - **test**: mark test-debug-no-context is flaky (Rich Trott) [#4421](https://github.com/nodejs/node/pull/4421) * [[`46d8c93ed2`](https://github.com/nodejs/node/commit/46d8c93ed2)] - **test**: don't use cwd for relative path (Johan Bergström) [#4477](https://github.com/nodejs/node/pull/4477) * [[`b6124ea39c`](https://github.com/nodejs/node/commit/b6124ea39c)] - **test**: write to tmp dir rather than fixture dir (Rich Trott) [#4489](https://github.com/nodejs/node/pull/4489) * [[`350fa664bb`](https://github.com/nodejs/node/commit/350fa664bb)] - **test**: don't assume a certain folder structure (Johan Bergström) [#3325](https://github.com/nodejs/node/pull/3325) * [[`6b2ef0efac`](https://github.com/nodejs/node/commit/6b2ef0efac)] - **test**: make temp path customizable (Johan Bergström) [#3325](https://github.com/nodejs/node/pull/3325) * [[`f1837703a9`](https://github.com/nodejs/node/commit/f1837703a9)] - **test**: remove unused vars from parallel tests (Rich Trott) [#4511](https://github.com/nodejs/node/pull/4511) * [[`b4964b099a`](https://github.com/nodejs/node/commit/b4964b099a)] - **test**: remove unused variables form http tests (Rich Trott) [#4422](https://github.com/nodejs/node/pull/4422) * [[`0d5a508dfb`](https://github.com/nodejs/node/commit/0d5a508dfb)] - **test**: extend timeout in Debug mode (Rich Trott) [#4431](https://github.com/nodejs/node/pull/4431) * [[`6e4598d5da`](https://github.com/nodejs/node/commit/6e4598d5da)] - **test**: remove unused variables from TLS tests (Rich Trott) [#4424](https://github.com/nodejs/node/pull/4424) * [[`7b1aa045a0`](https://github.com/nodejs/node/commit/7b1aa045a0)] - **test**: remove unused variables from HTTPS tests (Rich Trott) [#4426](https://github.com/nodejs/node/pull/4426) * [[`da9e5c1b01`](https://github.com/nodejs/node/commit/da9e5c1b01)] - **test**: remove unused variables from net tests (Rich Trott) [#4430](https://github.com/nodejs/node/pull/4430) * [[`13241bd24b`](https://github.com/nodejs/node/commit/13241bd24b)] - **test**: remove unused vars in ChildProcess tests (Rich Trott) [#4425](https://github.com/nodejs/node/pull/4425) * [[`2f4538ddda`](https://github.com/nodejs/node/commit/2f4538ddda)] - **test**: remove unused vars (Rich Trott) [#4536](https://github.com/nodejs/node/pull/4536) * [[`dffe83ccd6`](https://github.com/nodejs/node/commit/dffe83ccd6)] - **test**: remove unused modules (Rich Trott) [#4684](https://github.com/nodejs/node/pull/4684) * [[`c4eeb88ba1`](https://github.com/nodejs/node/commit/c4eeb88ba1)] - **test**: fix flaky cluster-disconnect-race (Brian White) [#4457](https://github.com/nodejs/node/pull/4457) * [[`7caf87bf6c`](https://github.com/nodejs/node/commit/7caf87bf6c)] - **test**: fix flaky test-http-agent-keepalive (Rich Trott) [#4524](https://github.com/nodejs/node/pull/4524) * [[`25c41d084d`](https://github.com/nodejs/node/commit/25c41d084d)] - **test**: remove flaky designations for tests (Rich Trott) [#4519](https://github.com/nodejs/node/pull/4519) * [[`b8f097ece2`](https://github.com/nodejs/node/commit/b8f097ece2)] - **test**: fix flaky streams test (Rich Trott) [#4516](https://github.com/nodejs/node/pull/4516) * [[`c24fa1437c`](https://github.com/nodejs/node/commit/c24fa1437c)] - **test**: inherit JOBS from environment (Johan Bergström) [#4495](https://github.com/nodejs/node/pull/4495) * [[`7dc90e9e7f`](https://github.com/nodejs/node/commit/7dc90e9e7f)] - **test**: remove time check (Rich Trott) [#4494](https://github.com/nodejs/node/pull/4494) * [[`7ca3c6c388`](https://github.com/nodejs/node/commit/7ca3c6c388)] - **test**: refactor test-fs-empty-readStream (Rich Trott) [#4490](https://github.com/nodejs/node/pull/4490) * [[`610727dea7`](https://github.com/nodejs/node/commit/610727dea7)] - **test**: clarify role of domains in test (Rich Trott) [#4474](https://github.com/nodejs/node/pull/4474) * [[`1ae0e355b9`](https://github.com/nodejs/node/commit/1ae0e355b9)] - **test**: improve assert message (Rich Trott) [#4461](https://github.com/nodejs/node/pull/4461) * [[`e70c88df56`](https://github.com/nodejs/node/commit/e70c88df56)] - **test**: remove unused assert module imports (Rich Trott) [#4438](https://github.com/nodejs/node/pull/4438) * [[`c77fc71f9b`](https://github.com/nodejs/node/commit/c77fc71f9b)] - **test**: remove unused var from test-assert.js (Rich Trott) [#4405](https://github.com/nodejs/node/pull/4405) * [[`f613b3033f`](https://github.com/nodejs/node/commit/f613b3033f)] - **test**: add test-domain-exit-dispose-again back (Julien Gilli) [#4256](https://github.com/nodejs/node/pull/4256) * [[`f5bfacd858`](https://github.com/nodejs/node/commit/f5bfacd858)] - **test**: remove unused `util` imports (Rich Trott) [#4562](https://github.com/nodejs/node/pull/4562) * [[`d795301025`](https://github.com/nodejs/node/commit/d795301025)] - **test**: remove unnecessary assignments (Rich Trott) [#4563](https://github.com/nodejs/node/pull/4563) * [[`acc3d66934`](https://github.com/nodejs/node/commit/acc3d66934)] - **test**: move ArrayStream to common (cjihrig) [#4027](https://github.com/nodejs/node/pull/4027) * [[`6c0021361c`](https://github.com/nodejs/node/commit/6c0021361c)] - **test**: refactor test-net-connect-options-ipv6 (Rich Trott) [#4395](https://github.com/nodejs/node/pull/4395) * [[`29804e00ad`](https://github.com/nodejs/node/commit/29804e00ad)] - **test**: use platformTimeout() in more places (Brian White) [#4387](https://github.com/nodejs/node/pull/4387) * [[`761af37d0e`](https://github.com/nodejs/node/commit/761af37d0e)] - **test**: fix race condition in test-http-client-onerror (Devin Nakamura) [#4346](https://github.com/nodejs/node/pull/4346) * [[`980852165f`](https://github.com/nodejs/node/commit/980852165f)] - **test**: fix flaky test-net-error-twice (Brian White) [#4342](https://github.com/nodejs/node/pull/4342) * [[`1bc44e79d3`](https://github.com/nodejs/node/commit/1bc44e79d3)] - **test**: try other ipv6 localhost alternatives (Brian White) [#4325](https://github.com/nodejs/node/pull/4325) * [[`44dbe15640`](https://github.com/nodejs/node/commit/44dbe15640)] - **test**: fix debug-port-cluster flakiness (Ben Noordhuis) [#4310](https://github.com/nodejs/node/pull/4310) * [[`73e781172b`](https://github.com/nodejs/node/commit/73e781172b)] - **test**: add test for tls.parseCertString (Evan Lucas) [#4283](https://github.com/nodejs/node/pull/4283) * [[`15c295a21b`](https://github.com/nodejs/node/commit/15c295a21b)] - **test**: use regular timeout times for ARMv8 (Jeremiah Senkpiel) [#4248](https://github.com/nodejs/node/pull/4248) * [[`fd250b8fab`](https://github.com/nodejs/node/commit/fd250b8fab)] - **test**: parallelize test-repl-persistent-history (Jeremiah Senkpiel) [#4247](https://github.com/nodejs/node/pull/4247) * [[`9a0f156e5a`](https://github.com/nodejs/node/commit/9a0f156e5a)] - **test**: fix domain-top-level-error-handler-throw (Santiago Gimeno) [#4364](https://github.com/nodejs/node/pull/4364) * [[`6bc1b1c259`](https://github.com/nodejs/node/commit/6bc1b1c259)] - **test**: don't assume openssl s_client supports -ssl3 (Ben Noordhuis) [#4204](https://github.com/nodejs/node/pull/4204) * [[`d00b9fc66f`](https://github.com/nodejs/node/commit/d00b9fc66f)] - **test**: fix tls-inception flakiness (Santiago Gimeno) [#4195](https://github.com/nodejs/node/pull/4195) * [[`c41b280a2b`](https://github.com/nodejs/node/commit/c41b280a2b)] - **test**: fix tls-inception (Santiago Gimeno) [#4195](https://github.com/nodejs/node/pull/4195) * [[`6f4ab1d1ab`](https://github.com/nodejs/node/commit/6f4ab1d1ab)] - **test**: mark test-cluster-shared-leak flaky (Rich Trott) [#4162](https://github.com/nodejs/node/pull/4162) * [[`90498e2a68`](https://github.com/nodejs/node/commit/90498e2a68)] - **test**: skip long path tests on non-Windows (Rafał Pocztarski) [#4116](https://github.com/nodejs/node/pull/4116) * [[`c9100d78f3`](https://github.com/nodejs/node/commit/c9100d78f3)] - **test**: fix flaky test-net-socket-local-address (Rich Trott) [#4109](https://github.com/nodejs/node/pull/4109) * [[`ac939d51d9`](https://github.com/nodejs/node/commit/ac939d51d9)] - **test**: improve cluster-disconnect-handles test (Brian White) [#4084](https://github.com/nodejs/node/pull/4084) * [[`22ba1b4115`](https://github.com/nodejs/node/commit/22ba1b4115)] - **test**: eliminate multicast test FreeBSD flakiness (Rich Trott) [#4042](https://github.com/nodejs/node/pull/4042) * [[`2ee7853bb7`](https://github.com/nodejs/node/commit/2ee7853bb7)] - **test**: fix http-many-ended-pipelines flakiness (Santiago Gimeno) [#4041](https://github.com/nodejs/node/pull/4041) * [[`a77dcfec06`](https://github.com/nodejs/node/commit/a77dcfec06)] - **test**: use platform-based timeout for reliability (Rich Trott) [#4015](https://github.com/nodejs/node/pull/4015) * [[`3f0ff879cf`](https://github.com/nodejs/node/commit/3f0ff879cf)] - **test**: fix time resolution constraint (Gireesh Punathil) [#3981](https://github.com/nodejs/node/pull/3981) * [[`22b88e1c48`](https://github.com/nodejs/node/commit/22b88e1c48)] - **test**: add TAP diagnostic message for retried tests (Rich Trott) [#3960](https://github.com/nodejs/node/pull/3960) * [[`22d2887b1c`](https://github.com/nodejs/node/commit/22d2887b1c)] - **test**: add OS X to module loading error test (Evan Lucas) [#3901](https://github.com/nodejs/node/pull/3901) * [[`e2141cb75e`](https://github.com/nodejs/node/commit/e2141cb75e)] - **test**: skip instead of fail when mem constrained (Michael Cornacchia) [#3697](https://github.com/nodejs/node/pull/3697) * [[`166523d0ed`](https://github.com/nodejs/node/commit/166523d0ed)] - **test**: fix race condition in unrefd interval test (Michael Cornacchia) [#3550](https://github.com/nodejs/node/pull/3550) * [[`86b47e8dc0`](https://github.com/nodejs/node/commit/86b47e8dc0)] - **timers**: optimize callback call: bind -> arrow (Andrei Sedoi) [#4038](https://github.com/nodejs/node/pull/4038) * [[`4d37472ea7`](https://github.com/nodejs/node/commit/4d37472ea7)] - **tls_wrap**: clear errors on return (Fedor Indutny) [#4709](https://github.com/nodejs/node/pull/4709) * [[`5b695d0343`](https://github.com/nodejs/node/commit/5b695d0343)] - **tls_wrap**: inherit from the `AsyncWrap` first (Fedor Indutny) [#4268](https://github.com/nodejs/node/pull/4268) * [[`0efc35e6d8`](https://github.com/nodejs/node/commit/0efc35e6d8)] - **tls_wrap**: slice buffer properly in `ClearOut` (Fedor Indutny) [#4184](https://github.com/nodejs/node/pull/4184) * [[`628cb8657c`](https://github.com/nodejs/node/commit/628cb8657c)] - **tools**: add .editorconfig (ronkorving) [#2993](https://github.com/nodejs/node/pull/2993) * [[`69fef19624`](https://github.com/nodejs/node/commit/69fef19624)] - **tools**: implement no-unused-vars for eslint (Rich Trott) [#4536](https://github.com/nodejs/node/pull/4536) * [[`3ee16706f2`](https://github.com/nodejs/node/commit/3ee16706f2)] - **tools**: enforce `throw new Error()` with lint rule (Rich Trott) [#3714](https://github.com/nodejs/node/pull/3714) * [[`32801de4ef`](https://github.com/nodejs/node/commit/32801de4ef)] - **tools**: Use `throw new Error()` consistently (Rich Trott) [#3714](https://github.com/nodejs/node/pull/3714) * [[`f413fae0cd`](https://github.com/nodejs/node/commit/f413fae0cd)] - **tools**: add tap output to cpplint (Johan Bergström) [#3448](https://github.com/nodejs/node/pull/3448) * [[`efa30dd2f0`](https://github.com/nodejs/node/commit/efa30dd2f0)] - **tools**: enable prefer-const eslint rule (Sakthipriyan Vairamani) [#3152](https://github.com/nodejs/node/pull/3152) * [[`dd0c925896`](https://github.com/nodejs/node/commit/dd0c925896)] - **udp**: remove a needless instanceof Buffer check (ronkorving) [#4301](https://github.com/nodejs/node/pull/4301) * [[`f4414102ed`](https://github.com/nodejs/node/commit/f4414102ed)] - **util**: faster arrayToHash (Jackson Tian) * [[`b421119984`](https://github.com/nodejs/node/commit/b421119984)] - **util**: determine object types in C++ (cjihrig) [#4100](https://github.com/nodejs/node/pull/4100) * [[`6a7c9d9293`](https://github.com/nodejs/node/commit/6a7c9d9293)] - **util**: move .decorateErrorStack to internal/util (Ben Noordhuis) [#4026](https://github.com/nodejs/node/pull/4026) * [[`422a865d46`](https://github.com/nodejs/node/commit/422a865d46)] - **util**: add decorateErrorStack() (cjihrig) [#4013](https://github.com/nodejs/node/pull/4013) * [[`2d5380ea25`](https://github.com/nodejs/node/commit/2d5380ea25)] - **util**: fix constructor/instanceof checks (Brian White) [#3385](https://github.com/nodejs/node/pull/3385) * [[`1bf84b9d41`](https://github.com/nodejs/node/commit/1bf84b9d41)] - **util,src**: allow lookup of hidden values (cjihrig) [#3988](https://github.com/nodejs/node/pull/3988) ## 2015-12-23, Version 4.2.4 'Argon' (LTS), @jasnell Maintenance update. ### Notable changes * Roughly 78% of the commits are documentation and test improvements * **domains**: ** Fix handling of uncaught exceptions (Julien Gilli) [#3884](https://github.com/nodejs/node/pull/3884) * **deps**: ** Upgrade to npm 2.14.12 (Kat Marchán) [#4110](https://github.com/nodejs/node/pull/4110) ** Backport 819b40a from V8 upstream (Michaël Zasso) [#3938](https://github.com/nodejs/node/pull/3938) ** Updated node LICENSE file with new npm license (Kat Marchán) [#4110](https://github.com/nodejs/node/pull/4110) ### Known issues * Some problems with unreferenced timers running during `beforeExit` are still to be resolved. See [#1264](https://github.com/nodejs/node/issues/1264). * Surrogate pair in REPL can freeze terminal. [#690](https://github.com/nodejs/node/issues/690) * Calling `dns.setServers()` while a DNS query is in progress can cause the process to crash on a failed assertion. [#894](https://github.com/nodejs/node/issues/894) * `url.resolve` may transfer the auth portion of the url when resolving between two full hosts, see [#1435](https://github.com/nodejs/node/issues/1435). ### Commits * [[`907a13a07f`](https://github.com/nodejs/node/commit/907a13a07f)] - Add missing va_end before return (Ömer Fadıl Usta) [#3565](https://github.com/nodejs/node/pull/3565) * [[`7ffc01756f`](https://github.com/nodejs/node/commit/7ffc01756f)] - **buffer**: fix writeInt{B,L}E for some neg values (Peter A. Bigot) [#3994](https://github.com/nodejs/node/pull/3994) * [[`db0186e435`](https://github.com/nodejs/node/commit/db0186e435)] - **buffer**: let WriteFloatGeneric silently drop values (P.S.V.R) * [[`5c6740865a`](https://github.com/nodejs/node/commit/5c6740865a)] - **build**: update signtool description, add url (Rod Vagg) [#4011](https://github.com/nodejs/node/pull/4011) * [[`60dda70f89`](https://github.com/nodejs/node/commit/60dda70f89)] - **build**: fix --with-intl=system-icu for x-compile (Steven R. Loomis) [#3808](https://github.com/nodejs/node/pull/3808) * [[`22208b067c`](https://github.com/nodejs/node/commit/22208b067c)] - **build**: fix configuring with prebuilt libraries (Markus Tzoe) [#3135](https://github.com/nodejs/node/pull/3135) * [[`914caf9c69`](https://github.com/nodejs/node/commit/914caf9c69)] - **child_process**: add safety checks on stdio access (cjihrig) [#3799](https://github.com/nodejs/node/pull/3799) * [[`236ad90a84`](https://github.com/nodejs/node/commit/236ad90a84)] - **child_process**: don't fork bomb ourselves from -e (Ben Noordhuis) [#3575](https://github.com/nodejs/node/pull/3575) * [[`f28f69dac4`](https://github.com/nodejs/node/commit/f28f69dac4)] - **cluster**: remove handles when disconnecting worker (Ben Noordhuis) [#3677](https://github.com/nodejs/node/pull/3677) * [[`f5c5e8bf91`](https://github.com/nodejs/node/commit/f5c5e8bf91)] - **cluster**: send suicide message on disconnect (cjihrig) [#3720](https://github.com/nodejs/node/pull/3720) * [[`629d5d18d7`](https://github.com/nodejs/node/commit/629d5d18d7)] - **configure**: `v8_use_snapshot` should be `true` (Fedor Indutny) [#3962](https://github.com/nodejs/node/pull/3962) * [[`3094464871`](https://github.com/nodejs/node/commit/3094464871)] - **configure**: use __ARM_ARCH to determine arm version (João Reis) [#4123](https://github.com/nodejs/node/pull/4123) * [[`1e1173fc5c`](https://github.com/nodejs/node/commit/1e1173fc5c)] - **configure**: respect CC_host in host arch detection (João Reis) [#4117](https://github.com/nodejs/node/pull/4117) * [[`2e9b886fbf`](https://github.com/nodejs/node/commit/2e9b886fbf)] - **crypto**: DSA parameter validation in FIPS mode (Stefan Budeanu) [#3756](https://github.com/nodejs/node/pull/3756) * [[`00b77d9e84`](https://github.com/nodejs/node/commit/00b77d9e84)] - **crypto**: Improve error checking and reporting (Stefan Budeanu) [#3753](https://github.com/nodejs/node/pull/3753) * [[`3dd90ddc73`](https://github.com/nodejs/node/commit/3dd90ddc73)] - **deps**: upgrade to npm 2.14.12 (Kat Marchán) [#4110](https://github.com/nodejs/node/pull/4110) * [[`51ae8d10b3`](https://github.com/nodejs/node/commit/51ae8d10b3)] - **deps**: Updated node LICENSE file with new npm license (Kat Marchán) [#4110](https://github.com/nodejs/node/pull/4110) * [[`9e1edead22`](https://github.com/nodejs/node/commit/9e1edead22)] - **deps**: backport 819b40a from V8 upstream (Michaël Zasso) [#3938](https://github.com/nodejs/node/pull/3938) * [[`a2ce3843cc`](https://github.com/nodejs/node/commit/a2ce3843cc)] - **deps**: upgrade npm to 2.14.9 (Forrest L Norvell) [#3686](https://github.com/nodejs/node/pull/3686) * [[`b140cb29f4`](https://github.com/nodejs/node/commit/b140cb29f4)] - **dns**: prevent undefined values in results (Junliang Yan) [#3696](https://github.com/nodejs/node/pull/3696) * [[`8aafa2ecc0`](https://github.com/nodejs/node/commit/8aafa2ecc0)] - **doc**: standardize references to node.js in docs (Scott Buchanan) [#4136](https://github.com/nodejs/node/pull/4136) * [[`72f43a263a`](https://github.com/nodejs/node/commit/72f43a263a)] - **doc**: fix internal link to child.send() (Luigi Pinca) [#4089](https://github.com/nodejs/node/pull/4089) * [[`dcfdbac457`](https://github.com/nodejs/node/commit/dcfdbac457)] - **doc**: reword https.Agent example text (Jan Krems) [#4075](https://github.com/nodejs/node/pull/4075) * [[`f93d268dec`](https://github.com/nodejs/node/commit/f93d268dec)] - **doc**: add HTTP working group (James M Snell) [#3919](https://github.com/nodejs/node/pull/3919) * [[`beee0553ca`](https://github.com/nodejs/node/commit/beee0553ca)] - **doc**: update WORKING_GROUPS.md - add missing groups (Michael Dawson) [#3450](https://github.com/nodejs/node/pull/3450) * [[`3327415fc4`](https://github.com/nodejs/node/commit/3327415fc4)] - **doc**: fix the exception description (yorkie) [#3658](https://github.com/nodejs/node/pull/3658) * [[`da8d012c88`](https://github.com/nodejs/node/commit/da8d012c88)] - **doc**: clarify v4.2.3 notable items (Rod Vagg) [#4155](https://github.com/nodejs/node/pull/4155) * [[`44a2d8ca24`](https://github.com/nodejs/node/commit/44a2d8ca24)] - **doc**: fix color of linked code blocks (jpersson) [#4068](https://github.com/nodejs/node/pull/4068) * [[`bebde48ebc`](https://github.com/nodejs/node/commit/bebde48ebc)] - **doc**: fix typo in README (Rich Trott) [#4000](https://github.com/nodejs/node/pull/4000) * [[`b48d5ec301`](https://github.com/nodejs/node/commit/b48d5ec301)] - **doc**: message.header duplication correction (Bryan English) [#3997](https://github.com/nodejs/node/pull/3997) * [[`6ef3625456`](https://github.com/nodejs/node/commit/6ef3625456)] - **doc**: replace sane with reasonable (Lewis Cowper) [#3980](https://github.com/nodejs/node/pull/3980) * [[`c5be3c63f0`](https://github.com/nodejs/node/commit/c5be3c63f0)] - **doc**: fix rare case of misaligned columns (Roman Reiss) [#3948](https://github.com/nodejs/node/pull/3948) * [[`bd82fb06ff`](https://github.com/nodejs/node/commit/bd82fb06ff)] - **doc**: fix broken references (Alexander Gromnitsky) [#3944](https://github.com/nodejs/node/pull/3944) * [[`8eb28c3d50`](https://github.com/nodejs/node/commit/8eb28c3d50)] - **doc**: add reference for buffer.inspect() (cjihrig) [#3921](https://github.com/nodejs/node/pull/3921) * [[`4bc71e0078`](https://github.com/nodejs/node/commit/4bc71e0078)] - **doc**: clarify module loading behavior (cjihrig) [#3920](https://github.com/nodejs/node/pull/3920) * [[`4c382e7aaa`](https://github.com/nodejs/node/commit/4c382e7aaa)] - **doc**: numeric flags to fs.open (Carl Lei) [#3641](https://github.com/nodejs/node/pull/3641) * [[`5207099dc9`](https://github.com/nodejs/node/commit/5207099dc9)] - **doc**: clarify that fs streams expect blocking fd (Carl Lei) [#3641](https://github.com/nodejs/node/pull/3641) * [[`753c5071ea`](https://github.com/nodejs/node/commit/753c5071ea)] - **doc**: Adding best practises for crypto.pbkdf2 (Tom Gallacher) [#3290](https://github.com/nodejs/node/pull/3290) * [[`8f0291beba`](https://github.com/nodejs/node/commit/8f0291beba)] - **doc**: update WORKING_GROUPS.md to include Intl (Steven R. Loomis) [#3251](https://github.com/nodejs/node/pull/3251) * [[`c31d472487`](https://github.com/nodejs/node/commit/c31d472487)] - **doc**: sort repl alphabetically (Tristian Flanagan) [#3859](https://github.com/nodejs/node/pull/3859) * [[`6b172d9fe8`](https://github.com/nodejs/node/commit/6b172d9fe8)] - **doc**: consistent reference-style links (Bryan English) [#3845](https://github.com/nodejs/node/pull/3845) * [[`ffd3335e29`](https://github.com/nodejs/node/commit/ffd3335e29)] - **doc**: address use of profanity in code of conduct (James M Snell) [#3827](https://github.com/nodejs/node/pull/3827) * [[`a36a5b63cf`](https://github.com/nodejs/node/commit/a36a5b63cf)] - **doc**: reword message.headers to indicate they are not read-only (Tristian Flanagan) [#3814](https://github.com/nodejs/node/pull/3814) * [[`6de77cd320`](https://github.com/nodejs/node/commit/6de77cd320)] - **doc**: clarify duplicate header handling (Bryan English) [#3810](https://github.com/nodejs/node/pull/3810) * [[`b22973af81`](https://github.com/nodejs/node/commit/b22973af81)] - **doc**: replace head of readme with updated text (Rod Vagg) [#3482](https://github.com/nodejs/node/pull/3482) * [[`eab0d56ea9`](https://github.com/nodejs/node/commit/eab0d56ea9)] - **doc**: repl: add defineComand and displayPrompt (Bryan English) [#3765](https://github.com/nodejs/node/pull/3765) * [[`15fb02985f`](https://github.com/nodejs/node/commit/15fb02985f)] - **doc**: document release types in readme (Rod Vagg) [#3482](https://github.com/nodejs/node/pull/3482) * [[`29f26b882f`](https://github.com/nodejs/node/commit/29f26b882f)] - **doc**: add link to \[customizing util.inspect colors\]. (Jesse McCarthy) [#3749](https://github.com/nodejs/node/pull/3749) * [[`90fdb4f7b3`](https://github.com/nodejs/node/commit/90fdb4f7b3)] - **doc**: sort tls alphabetically (Tristian Flanagan) [#3662](https://github.com/nodejs/node/pull/3662) * [[`39fa9fa85c`](https://github.com/nodejs/node/commit/39fa9fa85c)] - **doc**: sort stream alphabetically (Tristian Flanagan) [#3662](https://github.com/nodejs/node/pull/3662) * [[`e98e8afb2b`](https://github.com/nodejs/node/commit/e98e8afb2b)] - **doc**: sort net alphabetically (Tristian Flanagan) [#3662](https://github.com/nodejs/node/pull/3662) * [[`6de887483d`](https://github.com/nodejs/node/commit/6de887483d)] - **doc**: sort process alphabetically (Tristian Flanagan) [#3662](https://github.com/nodejs/node/pull/3662) * [[`37033dcb71`](https://github.com/nodejs/node/commit/37033dcb71)] - **doc**: sort zlib alphabetically (Tristian Flanagan) [#3662](https://github.com/nodejs/node/pull/3662) * [[`9878034567`](https://github.com/nodejs/node/commit/9878034567)] - **doc**: sort util alphabetically (Tristian Flanagan) [#3662](https://github.com/nodejs/node/pull/3662) * [[`48fc765eb6`](https://github.com/nodejs/node/commit/48fc765eb6)] - **doc**: sort https alphabetically (Tristian Flanagan) [#3662](https://github.com/nodejs/node/pull/3662) * [[`3546eb4f40`](https://github.com/nodejs/node/commit/3546eb4f40)] - **doc**: sort http alphabetically (Tristian Flanagan) [#3662](https://github.com/nodejs/node/pull/3662) * [[`dedfb1156a`](https://github.com/nodejs/node/commit/dedfb1156a)] - **doc**: sort modules alphabetically (Tristian Flanagan) [#3662](https://github.com/nodejs/node/pull/3662) * [[`71722fe1a1`](https://github.com/nodejs/node/commit/71722fe1a1)] - **doc**: sort readline alphabetically (Tristian Flanagan) [#3662](https://github.com/nodejs/node/pull/3662) * [[`660062bf9e`](https://github.com/nodejs/node/commit/660062bf9e)] - **doc**: sort repl alphabetically (Tristian Flanagan) [#3662](https://github.com/nodejs/node/pull/3662) * [[`34b8d28725`](https://github.com/nodejs/node/commit/34b8d28725)] - **doc**: sort string_decoder alphabetically (Tristian Flanagan) [#3662](https://github.com/nodejs/node/pull/3662) * [[`3f3b9ed7d7`](https://github.com/nodejs/node/commit/3f3b9ed7d7)] - **doc**: sort timers alphabetically (Tristian Flanagan) [#3662](https://github.com/nodejs/node/pull/3662) * [[`af876ddc64`](https://github.com/nodejs/node/commit/af876ddc64)] - **doc**: sort tty alphabetically (Tristian Flanagan) [#3662](https://github.com/nodejs/node/pull/3662) * [[`3c2068704a`](https://github.com/nodejs/node/commit/3c2068704a)] - **doc**: sort url alphabetically (Tristian Flanagan) [#3662](https://github.com/nodejs/node/pull/3662) * [[`363692fd0c`](https://github.com/nodejs/node/commit/363692fd0c)] - **doc**: sort vm alphabetically (Tristian Flanagan) [#3662](https://github.com/nodejs/node/pull/3662) * [[`ca41b55166`](https://github.com/nodejs/node/commit/ca41b55166)] - **doc**: sort querystring alphabetically (Tristian Flanagan) [#3662](https://github.com/nodejs/node/pull/3662) * [[`f37ff22b9f`](https://github.com/nodejs/node/commit/f37ff22b9f)] - **doc**: sort punycode alphabetically (Tristian Flanagan) [#3662](https://github.com/nodejs/node/pull/3662) * [[`4d569607af`](https://github.com/nodejs/node/commit/4d569607af)] - **doc**: sort path alphabetically (Tristian Flanagan) [#3662](https://github.com/nodejs/node/pull/3662) * [[`daa62447d1`](https://github.com/nodejs/node/commit/daa62447d1)] - **doc**: sort os alphabetically (Tristian Flanagan) [#3662](https://github.com/nodejs/node/pull/3662) * [[`0906f9a8bb`](https://github.com/nodejs/node/commit/0906f9a8bb)] - **doc**: sort globals alphabetically (Tristian Flanagan) [#3662](https://github.com/nodejs/node/pull/3662) * [[`6cd06c1319`](https://github.com/nodejs/node/commit/6cd06c1319)] - **doc**: sort fs alphabetically (Tristian Flanagan) [#3662](https://github.com/nodejs/node/pull/3662) * [[`5b310f8d9e`](https://github.com/nodejs/node/commit/5b310f8d9e)] - **doc**: sort events alphabetically (Tristian Flanagan) [#3662](https://github.com/nodejs/node/pull/3662) * [[`782cb7d15b`](https://github.com/nodejs/node/commit/782cb7d15b)] - **doc**: sort errors alphabetically (Tristian Flanagan) [#3662](https://github.com/nodejs/node/pull/3662) * [[`c39eabbec4`](https://github.com/nodejs/node/commit/c39eabbec4)] - **doc**: sort dgram alphabetically (Tristian Flanagan) [#3662](https://github.com/nodejs/node/pull/3662) * [[`261e0f3a21`](https://github.com/nodejs/node/commit/261e0f3a21)] - **doc**: sort crypto alphabetically (Tristian Flanagan) [#3662](https://github.com/nodejs/node/pull/3662) * [[`0e6121d04d`](https://github.com/nodejs/node/commit/0e6121d04d)] - **doc**: sort dns alphabetically (Tristian Flanagan) [#3662](https://github.com/nodejs/node/pull/3662) * [[`435ffb79f7`](https://github.com/nodejs/node/commit/435ffb79f7)] - **doc**: sort console alphabetically (Tristian Flanagan) [#3662](https://github.com/nodejs/node/pull/3662) * [[`28935a10d6`](https://github.com/nodejs/node/commit/28935a10d6)] - **doc**: sort cluster alphabetically (Tristian Flanagan) [#3662](https://github.com/nodejs/node/pull/3662) * [[`5e79dc4406`](https://github.com/nodejs/node/commit/5e79dc4406)] - **doc**: sort child_process alphabetically (Tristian Flanagan) [#3662](https://github.com/nodejs/node/pull/3662) * [[`af0bf1a72c`](https://github.com/nodejs/node/commit/af0bf1a72c)] - **doc**: sort buffer alphabetically (Tristian Flanagan) [#3662](https://github.com/nodejs/node/pull/3662) * [[`f43a0330aa`](https://github.com/nodejs/node/commit/f43a0330aa)] - **doc**: sort assert alphabetically (Tristian Flanagan) [#3662](https://github.com/nodejs/node/pull/3662) * [[`1bbc3b3ff8`](https://github.com/nodejs/node/commit/1bbc3b3ff8)] - **doc**: add note on tls connection meta data methods (Tyler Henkel) [#3746](https://github.com/nodejs/node/pull/3746) * [[`3c415bbb12`](https://github.com/nodejs/node/commit/3c415bbb12)] - **doc**: add note to util.isBuffer (Evan Lucas) [#3790](https://github.com/nodejs/node/pull/3790) * [[`7b5e4574fd`](https://github.com/nodejs/node/commit/7b5e4574fd)] - **doc**: add romankl to collaborators (Roman Klauke) [#3725](https://github.com/nodejs/node/pull/3725) * [[`4f7c638a7a`](https://github.com/nodejs/node/commit/4f7c638a7a)] - **doc**: add saghul as a collaborator (Saúl Ibarra Corretgé) * [[`523251270a`](https://github.com/nodejs/node/commit/523251270a)] - **doc**: add thealphanerd to collaborators (Myles Borins) [#3723](https://github.com/nodejs/node/pull/3723) * [[`488e74f27d`](https://github.com/nodejs/node/commit/488e74f27d)] - **doc**: update lts description in the collaborator guide (James M Snell) [#3668](https://github.com/nodejs/node/pull/3668) * [[`fe3ae3cea4`](https://github.com/nodejs/node/commit/fe3ae3cea4)] - **doc**: add LTS info to COLLABORATOR_GUIDE.md (Myles Borins) [#3442](https://github.com/nodejs/node/pull/3442) * [[`daa10a345e`](https://github.com/nodejs/node/commit/daa10a345e)] - **doc**: typo fix in readme.md (Sam P Gallagher-Bishop) [#3649](https://github.com/nodejs/node/pull/3649) * [[`eca5720761`](https://github.com/nodejs/node/commit/eca5720761)] - **doc**: fix wrong date and known issue in changelog.md (James M Snell) [#3650](https://github.com/nodejs/node/pull/3650) * [[`83494f8f3e`](https://github.com/nodejs/node/commit/83494f8f3e)] - **doc**: rename iojs-* groups to nodejs-* (Steven R. Loomis) [#3634](https://github.com/nodejs/node/pull/3634) * [[`347fb65aee`](https://github.com/nodejs/node/commit/347fb65aee)] - **doc**: fix crypto spkac function descriptions (Jason Gerfen) [#3614](https://github.com/nodejs/node/pull/3614) * [[`11d2050d63`](https://github.com/nodejs/node/commit/11d2050d63)] - **doc**: Updated streams simplified constructor API (Tom Gallacher) [#3602](https://github.com/nodejs/node/pull/3602) * [[`6db4392bfb`](https://github.com/nodejs/node/commit/6db4392bfb)] - **doc**: made code spans more visible in the API docs (phijohns) [#3573](https://github.com/nodejs/node/pull/3573) * [[`8a7dd73af1`](https://github.com/nodejs/node/commit/8a7dd73af1)] - **doc**: added what buf.copy returns (Manuel B) [#3555](https://github.com/nodejs/node/pull/3555) * [[`cf4b65c2d6`](https://github.com/nodejs/node/commit/cf4b65c2d6)] - **doc**: fix function param order in assert doc (David Woods) [#3533](https://github.com/nodejs/node/pull/3533) * [[`a2efe4c72b`](https://github.com/nodejs/node/commit/a2efe4c72b)] - **doc**: add note about timeout delay > TIMEOUT_MAX (Guilherme Souza) [#3512](https://github.com/nodejs/node/pull/3512) * [[`d1b5833476`](https://github.com/nodejs/node/commit/d1b5833476)] - **doc**: add caveats of algs and key size in crypto (Shigeki Ohtsu) [#3479](https://github.com/nodejs/node/pull/3479) * [[`12cdf6fcf3`](https://github.com/nodejs/node/commit/12cdf6fcf3)] - **doc**: add method links in events.markdown (Alejandro Oviedo) [#3187](https://github.com/nodejs/node/pull/3187) * [[`f50f19e384`](https://github.com/nodejs/node/commit/f50f19e384)] - **doc**: stdout/stderr can block when directed to file (Ben Noordhuis) [#3170](https://github.com/nodejs/node/pull/3170) * [[`b2cc1302e0`](https://github.com/nodejs/node/commit/b2cc1302e0)] - **docs**: improve discoverability of Code of Conduct (Ashley Williams) [#3774](https://github.com/nodejs/node/pull/3774) * [[`fa1ab497f1`](https://github.com/nodejs/node/commit/fa1ab497f1)] - **docs**: fs - change links to buffer encoding to Buffer class anchor (fansworld-claudio) [#2796](https://github.com/nodejs/node/pull/2796) * [[`34e64e5390`](https://github.com/nodejs/node/commit/34e64e5390)] - **domains**: fix handling of uncaught exceptions (Julien Gilli) [#3884](https://github.com/nodejs/node/pull/3884) * [[`0311836e7a`](https://github.com/nodejs/node/commit/0311836e7a)] - **meta**: remove use of profanity in source (Myles Borins) [#4122](https://github.com/nodejs/node/pull/4122) * [[`971762ada9`](https://github.com/nodejs/node/commit/971762ada9)] - **module**: cache regular expressions (Evan Lucas) [#3869](https://github.com/nodejs/node/pull/3869) * [[`d80fa2c77c`](https://github.com/nodejs/node/commit/d80fa2c77c)] - **module**: remove unnecessary JSON.stringify (Andres Suarez) [#3578](https://github.com/nodejs/node/pull/3578) * [[`aa85d62f09`](https://github.com/nodejs/node/commit/aa85d62f09)] - **net**: add local address/port for better errors (Jan Schär) [#3946](https://github.com/nodejs/node/pull/3946) * [[`803a56de52`](https://github.com/nodejs/node/commit/803a56de52)] - **querystring**: Parse multiple separator characters (Yosuke Furukawa) [#3807](https://github.com/nodejs/node/pull/3807) * [[`ff02b295fc`](https://github.com/nodejs/node/commit/ff02b295fc)] - **repl**: don't crash if cannot open history file (Evan Lucas) [#3630](https://github.com/nodejs/node/pull/3630) * [[`329e88e545`](https://github.com/nodejs/node/commit/329e88e545)] - **repl**: To exit, press ^C again or type .exit. (Hemanth.HM) [#3368](https://github.com/nodejs/node/pull/3368) * [[`9b05905361`](https://github.com/nodejs/node/commit/9b05905361)] - **src**: Revert "nix stdin _readableState.reading" (Roman Reiss) [#3490](https://github.com/nodejs/node/pull/3490) * [[`957c1f2543`](https://github.com/nodejs/node/commit/957c1f2543)] - **stream_wrap**: error if stream has StringDecoder (Fedor Indutny) [#4031](https://github.com/nodejs/node/pull/4031) * [[`43e3b69dae`](https://github.com/nodejs/node/commit/43e3b69dae)] - **test**: refactor test-http-exit-delay (Rich Trott) [#4055](https://github.com/nodejs/node/pull/4055) * [[`541d0d21be`](https://github.com/nodejs/node/commit/541d0d21be)] - **test**: fix cluster-disconnect-handles flakiness (Santiago Gimeno) [#4009](https://github.com/nodejs/node/pull/4009) * [[`5f66d66e84`](https://github.com/nodejs/node/commit/5f66d66e84)] - **test**: don't check the # of chunks in test-http-1.0 (Santiago Gimeno) [#3961](https://github.com/nodejs/node/pull/3961) * [[`355edf585b`](https://github.com/nodejs/node/commit/355edf585b)] - **test**: fix cluster-worker-isdead (Santiago Gimeno) [#3954](https://github.com/nodejs/node/pull/3954) * [[`4e46e04002`](https://github.com/nodejs/node/commit/4e46e04002)] - **test**: add test for repl.defineCommand() (Bryan English) [#3908](https://github.com/nodejs/node/pull/3908) * [[`4ea1a69c53`](https://github.com/nodejs/node/commit/4ea1a69c53)] - **test**: mark test flaky on FreeBSD (Rich Trott) [#4016](https://github.com/nodejs/node/pull/4016) * [[`05b64c11f5`](https://github.com/nodejs/node/commit/05b64c11f5)] - **test**: mark cluster-net-send test flaky on windows (Rich Trott) [#4006](https://github.com/nodejs/node/pull/4006) * [[`695015579b`](https://github.com/nodejs/node/commit/695015579b)] - **test**: remove flaky designation from ls-no-sslv3 (Rich Trott) [#3620](https://github.com/nodejs/node/pull/3620) * [[`abbd87b273`](https://github.com/nodejs/node/commit/abbd87b273)] - **test**: mark fork regression test flaky on windows (Rich Trott) [#4005](https://github.com/nodejs/node/pull/4005) * [[`38ba152a7a`](https://github.com/nodejs/node/commit/38ba152a7a)] - **test**: skip test if in FreeBSD jail (Rich Trott) [#3995](https://github.com/nodejs/node/pull/3995) * [[`cc24f0ea58`](https://github.com/nodejs/node/commit/cc24f0ea58)] - **test**: fix test-domain-exit-dispose-again (Julien Gilli) [#3990](https://github.com/nodejs/node/pull/3990) * [[`b2f1014d26`](https://github.com/nodejs/node/commit/b2f1014d26)] - **test**: remove flaky status for cluster test (Rich Trott) [#3975](https://github.com/nodejs/node/pull/3975) * [[`e66794fd30`](https://github.com/nodejs/node/commit/e66794fd30)] - **test**: address flaky test-http-client-timeout-event (Rich Trott) [#3968](https://github.com/nodejs/node/pull/3968) * [[`5a2727421a`](https://github.com/nodejs/node/commit/5a2727421a)] - **test**: retry on smartos if ECONNREFUSED (Rich Trott) [#3941](https://github.com/nodejs/node/pull/3941) * [[`dbc85a275c`](https://github.com/nodejs/node/commit/dbc85a275c)] - **test**: avoid test timeouts on rpi (Stefan Budeanu) [#3902](https://github.com/nodejs/node/pull/3902) * [[`b9d7378d20`](https://github.com/nodejs/node/commit/b9d7378d20)] - **test**: fix flaky test-child-process-spawnsync-input (Rich Trott) [#3889](https://github.com/nodejs/node/pull/3889) * [[`cca216a034`](https://github.com/nodejs/node/commit/cca216a034)] - **test**: move test-specific function out of common (Rich Trott) [#3871](https://github.com/nodejs/node/pull/3871) * [[`fb8df8d6c2`](https://github.com/nodejs/node/commit/fb8df8d6c2)] - **test**: module loading error fix solaris #3798 (fansworld-claudio) [#3855](https://github.com/nodejs/node/pull/3855) * [[`9ea6bc1e0f`](https://github.com/nodejs/node/commit/9ea6bc1e0f)] - **test**: skip test if FreeBSD jail will break it (Rich Trott) [#3839](https://github.com/nodejs/node/pull/3839) * [[`150f126618`](https://github.com/nodejs/node/commit/150f126618)] - **test**: fix flaky SmartOS test (Rich Trott) [#3830](https://github.com/nodejs/node/pull/3830) * [[`603a6f5405`](https://github.com/nodejs/node/commit/603a6f5405)] - **test**: run pipeline flood test in parallel (Rich Trott) [#3811](https://github.com/nodejs/node/pull/3811) * [[`4a26f74ee3`](https://github.com/nodejs/node/commit/4a26f74ee3)] - **test**: skip/replace weak crypto tests in FIPS mode (Stefan Budeanu) [#3757](https://github.com/nodejs/node/pull/3757) * [[`3f9562b6bd`](https://github.com/nodejs/node/commit/3f9562b6bd)] - **test**: stronger crypto in test fixtures (Stefan Budeanu) [#3759](https://github.com/nodejs/node/pull/3759) * [[`1f83eebec5`](https://github.com/nodejs/node/commit/1f83eebec5)] - **test**: increase crypto strength for FIPS standard (Stefan Budeanu) [#3758](https://github.com/nodejs/node/pull/3758) * [[`7c5fbf7850`](https://github.com/nodejs/node/commit/7c5fbf7850)] - **test**: add hasFipsCrypto to test/common.js (Stefan Budeanu) [#3756](https://github.com/nodejs/node/pull/3756) * [[`f30214f135`](https://github.com/nodejs/node/commit/f30214f135)] - **test**: add test for invalid DSA key size (Stefan Budeanu) [#3756](https://github.com/nodejs/node/pull/3756) * [[`9a6c9faafb`](https://github.com/nodejs/node/commit/9a6c9faafb)] - **test**: numeric flags to fs.open (Carl Lei) [#3641](https://github.com/nodejs/node/pull/3641) * [[`93d1d3cfcd`](https://github.com/nodejs/node/commit/93d1d3cfcd)] - **test**: refactor test-http-pipeline-flood (Rich Trott) [#3636](https://github.com/nodejs/node/pull/3636) * [[`6c23f67504`](https://github.com/nodejs/node/commit/6c23f67504)] - **test**: fix flaky test test-http-pipeline-flood (Devin Nakamura) [#3636](https://github.com/nodejs/node/pull/3636) * [[`4e5cae4360`](https://github.com/nodejs/node/commit/4e5cae4360)] - **test**: use really invalid hostname (Sakthipriyan Vairamani) [#3711](https://github.com/nodejs/node/pull/3711) * [[`da189f793b`](https://github.com/nodejs/node/commit/da189f793b)] - **test**: Fix test-cluster-worker-exit.js for AIX (Imran Iqbal) [#3666](https://github.com/nodejs/node/pull/3666) * [[`7b4194a863`](https://github.com/nodejs/node/commit/7b4194a863)] - **test**: fix test-module-loading-error for musl (Hugues Malphettes) [#3657](https://github.com/nodejs/node/pull/3657) * [[`3dc52e99df`](https://github.com/nodejs/node/commit/3dc52e99df)] - **test**: fix test-net-persistent-keepalive for AIX (Imran Iqbal) [#3646](https://github.com/nodejs/node/pull/3646) * [[`0e8eb66a78`](https://github.com/nodejs/node/commit/0e8eb66a78)] - **test**: fix path to module for repl test on Windows (Michael Cornacchia) [#3608](https://github.com/nodejs/node/pull/3608) * [[`3aecbc86d2`](https://github.com/nodejs/node/commit/3aecbc86d2)] - **test**: add test-zlib-flush-drain (Myles Borins) [#3534](https://github.com/nodejs/node/pull/3534) * [[`542d05cbe1`](https://github.com/nodejs/node/commit/542d05cbe1)] - **test**: enhance fs-watch-recursive test (Sakthipriyan Vairamani) [#2599](https://github.com/nodejs/node/pull/2599) * [[`0eb0119d64`](https://github.com/nodejs/node/commit/0eb0119d64)] - **tls**: Use SHA1 for sessionIdContext in FIPS mode (Stefan Budeanu) [#3755](https://github.com/nodejs/node/pull/3755) * [[`c10c08604c`](https://github.com/nodejs/node/commit/c10c08604c)] - **tls**: remove util and calls to util.format (Myles Borins) [#3456](https://github.com/nodejs/node/pull/3456) * [[`a558a570c0`](https://github.com/nodejs/node/commit/a558a570c0)] - **util**: use regexp instead of str.replace().join() (qinjia) [#3689](https://github.com/nodejs/node/pull/3689) * [[`47bb94a0c3`](https://github.com/nodejs/node/commit/47bb94a0c3)] - **zlib**: only apply drain listener if given callback (Craig Cavalier) [#3534](https://github.com/nodejs/node/pull/3534) * [[`4733a60158`](https://github.com/nodejs/node/commit/4733a60158)] - **zlib**: pass kind to recursive calls to flush (Myles Borins) [#3534](https://github.com/nodejs/node/pull/3534) ## 2015-12-04, Version 4.2.3 'Argon' (LTS), @rvagg Security Update ### Notable changes * **http**: Fix CVE-2015-8027, a bug whereby an HTTP socket may no longer have a parser associated with it but a pipelined request attempts to trigger a pause or resume on the non-existent parser, a potential denial-of-service vulnerability. (Fedor Indutny) * **openssl**: Upgrade to 1.0.2e, containing fixes for: - CVE-2015-3193 "BN_mod_exp may produce incorrect results on x86_64", an attack may be possible against a Node.js TLS server using DHE key exchange. Details are available at . - CVE-2015-3194 "Certificate verify crash with missing PSS parameter", a potential denial-of-service vector for Node.js TLS servers using client certificate authentication; TLS clients are also impacted. Details are available at . (Shigeki Ohtsu) [#4134](https://github.com/nodejs/node/pull/4134) * **v8**: Backport fix for CVE-2015-6764, a bug in `JSON.stringify()` that can result in out-of-bounds reads for arrays. (Ben Noordhuis) ### Known issues * Some problems with unreferenced timers running during `beforeExit` are still to be resolved. See [#1264](https://github.com/nodejs/node/issues/1264). * Surrogate pair in REPL can freeze terminal. [#690](https://github.com/nodejs/node/issues/690) * Calling `dns.setServers()` while a DNS query is in progress can cause the process to crash on a failed assertion. [#894](https://github.com/nodejs/node/issues/894) * `url.resolve` may transfer the auth portion of the url when resolving between two full hosts, see [#1435](https://github.com/nodejs/node/issues/1435). ### Commits * [[`49bbd563be`](https://github.com/nodejs/node/commit/49bbd563be)] - **deps**: upgrade openssl sources to 1.0.2e (Shigeki Ohtsu) [#4134](https://github.com/nodejs/node/pull/4134) * [[`9a063fd492`](https://github.com/nodejs/node/commit/9a063fd492)] - **deps**: backport a7e50a5 from upstream v8 (Ben Noordhuis) * [[`07233206e9`](https://github.com/nodejs/node/commit/07233206e9)] - **deps**: backport 6df9a1d from upstream v8 (Ben Noordhuis) * [[`1c8e6de78e`](https://github.com/nodejs/node/commit/1c8e6de78e)] - **http**: fix pipeline regression (Fedor Indutny) ## 2015-11-03, Version 4.2.2 'Argon' (LTS), @jasnell ### Notable changes This is an LTS maintenance release that addresses a number of issues: * [[`1d0f2cbf87`](https://github.com/nodejs/node/commit/1d0f2cbf87)] - **buffer**: fix value check for writeUInt{B,L}E (Trevor Norris) [#3500](https://github.com/nodejs/node/pull/3500) * [[`2a45b72b4a`](https://github.com/nodejs/node/commit/2a45b72b4a)] - **buffer**: don't CHECK on zero-sized realloc (Ben Noordhuis) [#3499](https://github.com/nodejs/node/pull/3499) * [[`a6469e901a`](https://github.com/nodejs/node/commit/a6469e901a)] - **deps**: backport 010897c from V8 upstream (Ali Ijaz Sheikh) [#3520](https://github.com/nodejs/node/pull/3520) * [[`cadee67c25`](https://github.com/nodejs/node/commit/cadee67c25)] - **deps**: backport 8d6a228 from the v8's upstream (Fedor Indutny) [#3549](https://github.com/nodejs/node/pull/3549) * [[`46c8c94055`](https://github.com/nodejs/node/commit/46c8c94055)] - **fs**: reduced duplicate code in fs.write() (ronkorving) [#2947](https://github.com/nodejs/node/pull/2947) * [[`0427cdf094`](https://github.com/nodejs/node/commit/0427cdf094)] - **http**: fix stalled pipeline bug (Fedor Indutny) [#3342](https://github.com/nodejs/node/pull/3342) * [[`2109708186`](https://github.com/nodejs/node/commit/2109708186)] - **lib**: fix cluster handle leak (Rich Trott) [#3510](https://github.com/nodejs/node/pull/3510) * [[`f49c7c6955`](https://github.com/nodejs/node/commit/f49c7c6955)] - **lib**: avoid REPL exit on completion error (Rich Trott) [#3358](https://github.com/nodejs/node/pull/3358) * [[`8a2c4aeeaa`](https://github.com/nodejs/node/commit/8a2c4aeeaa)] - **repl**: handle comments properly (Sakthipriyan Vairamani) [#3515](https://github.com/nodejs/node/pull/3515) * [[`a04408acce`](https://github.com/nodejs/node/commit/a04408acce)] - **repl**: limit persistent history correctly on load (Jeremiah Senkpiel) [#2356](https://github.com/nodejs/node/pull/2356) * [[`3bafe1a59b`](https://github.com/nodejs/node/commit/3bafe1a59b)] - **src**: fix race condition in debug signal on exit (Ben Noordhuis) [#3528](https://github.com/nodejs/node/pull/3528) * [[`fe01d0df7a`](https://github.com/nodejs/node/commit/fe01d0df7a)] - **src**: fix exception message encoding on Windows (Brian White) [#3288](https://github.com/nodejs/node/pull/3288) * [[`4bac5d9ddf`](https://github.com/nodejs/node/commit/4bac5d9ddf)] - **stream**: avoid unnecessary concat of a single buffer. (Calvin Metcalf) [#3300](https://github.com/nodejs/node/pull/3300) * [[`8d78d687d5`](https://github.com/nodejs/node/commit/8d78d687d5)] - **timers**: reuse timer in `setTimeout().unref()` (Fedor Indutny) [#3407](https://github.com/nodejs/node/pull/3407) * [[`e69c869399`](https://github.com/nodejs/node/commit/e69c869399)] - **tls**: TLSSocket options default isServer false (Yuval Brik) [#2614](https://github.com/nodejs/node/pull/2614) ### Known issues * Surrogate pair in REPL can freeze terminal. [#690](https://github.com/nodejs/node/issues/690) * Calling `dns.setServers()` while a DNS query is in progress can cause the process to crash on a failed assertion. [#894](https://github.com/nodejs/node/issues/894) * `url.resolve` may transfer the auth portion of the url when resolving between two full hosts, see [#1435](https://github.com/nodejs/node/issues/1435). ### Commits * [[`1d0f2cbf87`](https://github.com/nodejs/node/commit/1d0f2cbf87)] - **buffer**: fix value check for writeUInt{B,L}E (Trevor Norris) [#3500](https://github.com/nodejs/node/pull/3500) * [[`2a45b72b4a`](https://github.com/nodejs/node/commit/2a45b72b4a)] - **buffer**: don't CHECK on zero-sized realloc (Ben Noordhuis) [#3499](https://github.com/nodejs/node/pull/3499) * [[`dc655e1dd2`](https://github.com/nodejs/node/commit/dc655e1dd2)] - **build**: rectify --link-module help text (P.S.V.R) [#3379](https://github.com/nodejs/node/pull/3379) * [[`a6469e901a`](https://github.com/nodejs/node/commit/a6469e901a)] - **deps**: backport 010897c from V8 upstream (Ali Ijaz Sheikh) [#3520](https://github.com/nodejs/node/pull/3520) * [[`cadee67c25`](https://github.com/nodejs/node/commit/cadee67c25)] - **deps**: backport 8d6a228 from the v8's upstream (Fedor Indutny) [#3549](https://github.com/nodejs/node/pull/3549) * [[`1ebd35550b`](https://github.com/nodejs/node/commit/1ebd35550b)] - **doc**: fix typos in changelog (reggi) [#3291](https://github.com/nodejs/node/pull/3291) * [[`fbd93d4c1c`](https://github.com/nodejs/node/commit/fbd93d4c1c)] - **doc**: more use-cases for promise events (Domenic Denicola) [#3438](https://github.com/nodejs/node/pull/3438) * [[`6ceb9af407`](https://github.com/nodejs/node/commit/6ceb9af407)] - **doc**: remove old note, 'cluster' is marked stable (Balázs Galambosi) [#3314](https://github.com/nodejs/node/pull/3314) * [[`a5f0d64ddc`](https://github.com/nodejs/node/commit/a5f0d64ddc)] - **doc**: createServer's key option can be an array (Sakthipriyan Vairamani) [#3123](https://github.com/nodejs/node/pull/3123) * [[`317e0ec6b3`](https://github.com/nodejs/node/commit/317e0ec6b3)] - **doc**: binary encoding is not deprecated (Trevor Norris) [#3441](https://github.com/nodejs/node/pull/3441) * [[`b422f6ee1a`](https://github.com/nodejs/node/commit/b422f6ee1a)] - **doc**: mention the behaviour if URL is invalid (Sakthipriyan Vairamani) [#2966](https://github.com/nodejs/node/pull/2966) * [[`bc29aad22b`](https://github.com/nodejs/node/commit/bc29aad22b)] - **doc**: fix indent in tls resumption example (Roman Reiss) [#3372](https://github.com/nodejs/node/pull/3372) * [[`313877bd8f`](https://github.com/nodejs/node/commit/313877bd8f)] - **doc**: fix typo in changelog (Timothy Gu) [#3353](https://github.com/nodejs/node/pull/3353) * [[`4be432862a`](https://github.com/nodejs/node/commit/4be432862a)] - **doc**: show keylen in pbkdf2 as a byte length (calebboyd) [#3334](https://github.com/nodejs/node/pull/3334) * [[`23a1140ddb`](https://github.com/nodejs/node/commit/23a1140ddb)] - **doc**: add information about Assert behavior and maintenance (Rich Trott) [#3330](https://github.com/nodejs/node/pull/3330) * [[`e04cb1e1fc`](https://github.com/nodejs/node/commit/e04cb1e1fc)] - **doc**: clarify API buffer.concat (Martii) [#3255](https://github.com/nodejs/node/pull/3255) * [[`eae714c370`](https://github.com/nodejs/node/commit/eae714c370)] - **doc**: clarify the use of `option.detached` (Kyle Smith) [#3250](https://github.com/nodejs/node/pull/3250) * [[`b884899e67`](https://github.com/nodejs/node/commit/b884899e67)] - **doc**: label v4.2.1 as LTS in changelog heading (Phillip Johnsen) [#3360](https://github.com/nodejs/node/pull/3360) * [[`9120a04981`](https://github.com/nodejs/node/commit/9120a04981)] - **docs**: add missing shell option to execSync (fansworld-claudio) [#3440](https://github.com/nodejs/node/pull/3440) * [[`46c8c94055`](https://github.com/nodejs/node/commit/46c8c94055)] - **fs**: reduced duplicate code in fs.write() (ronkorving) [#2947](https://github.com/nodejs/node/pull/2947) * [[`0427cdf094`](https://github.com/nodejs/node/commit/0427cdf094)] - **http**: fix stalled pipeline bug (Fedor Indutny) [#3342](https://github.com/nodejs/node/pull/3342) * [[`2109708186`](https://github.com/nodejs/node/commit/2109708186)] - **lib**: fix cluster handle leak (Rich Trott) [#3510](https://github.com/nodejs/node/pull/3510) * [[`f49c7c6955`](https://github.com/nodejs/node/commit/f49c7c6955)] - **lib**: avoid REPL exit on completion error (Rich Trott) [#3358](https://github.com/nodejs/node/pull/3358) * [[`8a2c4aeeaa`](https://github.com/nodejs/node/commit/8a2c4aeeaa)] - **repl**: handle comments properly (Sakthipriyan Vairamani) [#3515](https://github.com/nodejs/node/pull/3515) * [[`a04408acce`](https://github.com/nodejs/node/commit/a04408acce)] - **repl**: limit persistent history correctly on load (Jeremiah Senkpiel) [#2356](https://github.com/nodejs/node/pull/2356) * [[`5d1f1c5fa8`](https://github.com/nodejs/node/commit/5d1f1c5fa8)] - **src**: wrap source before doing syntax check (Evan Lucas) [#3587](https://github.com/nodejs/node/pull/3587) * [[`3bafe1a59b`](https://github.com/nodejs/node/commit/3bafe1a59b)] - **src**: fix race condition in debug signal on exit (Ben Noordhuis) [#3528](https://github.com/nodejs/node/pull/3528) * [[`fe01d0df7a`](https://github.com/nodejs/node/commit/fe01d0df7a)] - **src**: fix exception message encoding on Windows (Brian White) [#3288](https://github.com/nodejs/node/pull/3288) * [[`4bac5d9ddf`](https://github.com/nodejs/node/commit/4bac5d9ddf)] - **stream**: avoid unnecessary concat of a single buffer. (Calvin Metcalf) [#3300](https://github.com/nodejs/node/pull/3300) * [[`117fb47a16`](https://github.com/nodejs/node/commit/117fb47a16)] - **stream**: fix signature of _write() in a comment (Fábio Santos) [#3248](https://github.com/nodejs/node/pull/3248) * [[`c563a34427`](https://github.com/nodejs/node/commit/c563a34427)] - **test**: split independent tests into separate files (Rich Trott) [#3548](https://github.com/nodejs/node/pull/3548) * [[`3f62952d42`](https://github.com/nodejs/node/commit/3f62952d42)] - **test**: add node::MakeCallback() test coverage (Ben Noordhuis) [#3478](https://github.com/nodejs/node/pull/3478) * [[`6b75f10d8a`](https://github.com/nodejs/node/commit/6b75f10d8a)] - **test**: use port number from env in tls socket test (Stefan Budeanu) [#3557](https://github.com/nodejs/node/pull/3557) * [[`39ff44e94f`](https://github.com/nodejs/node/commit/39ff44e94f)] - **test**: fix heap-profiler link error LNK1194 on win (Junliang Yan) [#3572](https://github.com/nodejs/node/pull/3572) * [[`a2786dd408`](https://github.com/nodejs/node/commit/a2786dd408)] - **test**: fix missing unistd.h on windows (Junliang Yan) [#3532](https://github.com/nodejs/node/pull/3532) * [[`5e6f7c9a23`](https://github.com/nodejs/node/commit/5e6f7c9a23)] - **test**: add regression test for --debug-brk -e 0 (Ben Noordhuis) [#3585](https://github.com/nodejs/node/pull/3585) * [[`7cad182cb6`](https://github.com/nodejs/node/commit/7cad182cb6)] - **test**: port domains regression test from v0.10 (Jonas Dohse) [#3356](https://github.com/nodejs/node/pull/3356) * [[`78d854c6ce`](https://github.com/nodejs/node/commit/78d854c6ce)] - **test**: remove util from common (Rich Trott) [#3324](https://github.com/nodejs/node/pull/3324) * [[`c566c8b8c0`](https://github.com/nodejs/node/commit/c566c8b8c0)] - **test**: remove util properties from common (Rich Trott) [#3304](https://github.com/nodejs/node/pull/3304) * [[`eb7c3fb2f4`](https://github.com/nodejs/node/commit/eb7c3fb2f4)] - **test**: split up buffer tests for reliability (Rich Trott) [#3323](https://github.com/nodejs/node/pull/3323) * [[`b398a85e19`](https://github.com/nodejs/node/commit/b398a85e19)] - **test**: parallelize long-running test (Rich Trott) [#3287](https://github.com/nodejs/node/pull/3287) * [[`b5f3b4956b`](https://github.com/nodejs/node/commit/b5f3b4956b)] - **test**: change call to deprecated util.isError() (Rich Trott) [#3084](https://github.com/nodejs/node/pull/3084) * [[`32149cacb5`](https://github.com/nodejs/node/commit/32149cacb5)] - **test**: improve tests for util.inherits (Michaël Zasso) [#3507](https://github.com/nodejs/node/pull/3507) * [[`5be686fab8`](https://github.com/nodejs/node/commit/5be686fab8)] - **test**: print helpful err msg on test-dns-ipv6.js (Junliang Yan) [#3501](https://github.com/nodejs/node/pull/3501) * [[`0429131e32`](https://github.com/nodejs/node/commit/0429131e32)] - **test**: fix domain with abort-on-uncaught on PPC (Julien Gilli) [#3354](https://github.com/nodejs/node/pull/3354) * [[`788106eee9`](https://github.com/nodejs/node/commit/788106eee9)] - **test**: cleanup, improve repl-persistent-history (Jeremiah Senkpiel) [#2356](https://github.com/nodejs/node/pull/2356) * [[`ea58fa0bac`](https://github.com/nodejs/node/commit/ea58fa0bac)] - **test**: add Symbol test for assert.deepEqual() (Rich Trott) [#3327](https://github.com/nodejs/node/pull/3327) * [[`d409ac473b`](https://github.com/nodejs/node/commit/d409ac473b)] - **test**: disable test-tick-processor - aix and be ppc (Michael Dawson) [#3491](https://github.com/nodejs/node/pull/3491) * [[`c1623039dd`](https://github.com/nodejs/node/commit/c1623039dd)] - **test**: harden test-child-process-fork-regr-gh-2847 (Michael Dawson) [#3459](https://github.com/nodejs/node/pull/3459) * [[`3bb4437abb`](https://github.com/nodejs/node/commit/3bb4437abb)] - **test**: fix test-net-keepalive for AIX (Imran Iqbal) [#3458](https://github.com/nodejs/node/pull/3458) * [[`af55641a69`](https://github.com/nodejs/node/commit/af55641a69)] - **test**: wrap assert.fail when passed to callback (Myles Borins) [#3453](https://github.com/nodejs/node/pull/3453) * [[`7c7ef01e65`](https://github.com/nodejs/node/commit/7c7ef01e65)] - **test**: skip test-dns-ipv6.js if ipv6 is unavailable (Junliang Yan) [#3444](https://github.com/nodejs/node/pull/3444) * [[`a4d1510ba4`](https://github.com/nodejs/node/commit/a4d1510ba4)] - **test**: repl-persistent-history is no longer flaky (Jeremiah Senkpiel) [#3437](https://github.com/nodejs/node/pull/3437) * [[`a5d968b8a2`](https://github.com/nodejs/node/commit/a5d968b8a2)] - **test**: fix flaky test-child-process-emfile (Rich Trott) [#3430](https://github.com/nodejs/node/pull/3430) * [[`eac2acca76`](https://github.com/nodejs/node/commit/eac2acca76)] - **test**: remove flaky status from eval_messages test (Rich Trott) [#3420](https://github.com/nodejs/node/pull/3420) * [[`155c778584`](https://github.com/nodejs/node/commit/155c778584)] - **test**: fix flaky test for symlinks (Rich Trott) [#3418](https://github.com/nodejs/node/pull/3418) * [[`74eb632483`](https://github.com/nodejs/node/commit/74eb632483)] - **test**: apply correct assert.fail() arguments (Rich Trott) [#3378](https://github.com/nodejs/node/pull/3378) * [[`0a4323dd82`](https://github.com/nodejs/node/commit/0a4323dd82)] - **test**: replace util with backtick strings (Myles Borins) [#3359](https://github.com/nodejs/node/pull/3359) * [[`93847694ec`](https://github.com/nodejs/node/commit/93847694ec)] - **test**: add test-child-process-emfile fail message (Rich Trott) [#3335](https://github.com/nodejs/node/pull/3335) * [[`8d78d687d5`](https://github.com/nodejs/node/commit/8d78d687d5)] - **timers**: reuse timer in `setTimeout().unref()` (Fedor Indutny) [#3407](https://github.com/nodejs/node/pull/3407) * [[`e69c869399`](https://github.com/nodejs/node/commit/e69c869399)] - **tls**: TLSSocket options default isServer false (Yuval Brik) [#2614](https://github.com/nodejs/node/pull/2614) * [[`0b32bbbf69`](https://github.com/nodejs/node/commit/0b32bbbf69)] - **v8**: pull fix for builtin code size on PPC (Michael Dawson) [#3474](https://github.com/nodejs/node/pull/3474) ## 2015-10-13, Version 4.2.1 'Argon' (LTS), @jasnell ### Notable changes * Includes fixes for two regressions - Assertion error in WeakCallback - see [#3329](https://github.com/nodejs/node/pull/3329) - Undefined timeout regression - see [#3331](https://github.com/nodejs/node/pull/3331) ### Known issues * When a server queues a large amount of data to send to a client over a pipelined HTTP connection, the underlying socket may be destroyed. See [#3332](https://github.com/nodejs/node/issues/3332) and [#3342](https://github.com/nodejs/node/pull/3342). * Some problems with unreferenced timers running during `beforeExit` are still to be resolved. See [#1264](https://github.com/nodejs/node/issues/1264). * Surrogate pair in REPL can freeze terminal. [#690](https://github.com/nodejs/node/issues/690) * Calling `dns.setServers()` while a DNS query is in progress can cause the process to crash on a failed assertion. [#894](https://github.com/nodejs/node/issues/894) * `url.resolve` may transfer the auth portion of the url when resolving between two full hosts, see [#1435](https://github.com/nodejs/node/issues/1435). ### Commits * [[`b3cbd13340`](https://github.com/nodejs/node/commit/b3cbd13340)] - **buffer**: fix assertion error in WeakCallback (Fedor Indutny) [#3329](https://github.com/nodejs/node/pull/3329) * [[`102cb7288c`](https://github.com/nodejs/node/commit/102cb7288c)] - **doc**: label v4.2.0 as LTS in changelog heading (Rod Vagg) [#3343](https://github.com/nodejs/node/pull/3343) * [[`c245a199a7`](https://github.com/nodejs/node/commit/c245a199a7)] - **lib**: fix undefined timeout regression (Ryan Graham) [#3331](https://github.com/nodejs/node/pull/3331) ## 2015-10-07, Version 4.2.0 'Argon' (LTS), @jasnell ### Notable changes The first Node.js LTS release! See https://github.com/nodejs/LTS/ for details of the LTS process. * **icu**: Updated to version 56 with significant performance improvements (Steven R. Loomis) [#3281](https://github.com/nodejs/node/pull/3281) * **node**: - Added new `-c` (or `--check`) command line argument for checking script syntax without executing the code (Dave Eddy) [#2411](https://github.com/nodejs/node/pull/2411) - Added `process.versions.icu` to hold the current ICU library version (Evan Lucas) [#3102](https://github.com/nodejs/node/pull/3102) - Added `process.release.lts` to hold the current LTS codename when the binary is from an active LTS release line (Rod Vagg) [#3212](https://github.com/nodejs/node/pull/3212) * **npm**: Upgraded to npm 2.14.7 from 2.14.4, see [release notes](https://github.com/npm/npm/releases/tag/v2.14.7) for full details (Kat Marchán) [#3299](https://github.com/nodejs/node/pull/3299) ### Known issues See https://github.com/nodejs/node/labels/confirmed-bug for complete and current list of known issues. * Some problems with unreferenced timers running during `beforeExit` are still to be resolved. See [#1264](https://github.com/nodejs/node/issues/1264). * Surrogate pair in REPL can freeze terminal. [#690](https://github.com/nodejs/node/issues/690) * Calling `dns.setServers()` while a DNS query is in progress can cause the process to crash on a failed assertion. [#894](https://github.com/nodejs/node/issues/894) * `url.resolve` may transfer the auth portion of the url when resolving between two full hosts, see [#1435](https://github.com/nodejs/node/issues/1435). ### Commits * [[`8383c4fe00`](https://github.com/nodejs/node/commit/8383c4fe00)] - **assert**: support arrow functions in .throws() (Ben Noordhuis) [#3276](https://github.com/nodejs/node/pull/3276) * [[`3eaa593a32`](https://github.com/nodejs/node/commit/3eaa593a32)] - **async_wrap**: correctly pass parent to init callback (Trevor Norris) [#3216](https://github.com/nodejs/node/pull/3216) * [[`54795620f6`](https://github.com/nodejs/node/commit/54795620f6)] - **buffer**: don't abort on prototype getters (Trevor Norris) [#3302](https://github.com/nodejs/node/pull/3302) * [[`660f7591c8`](https://github.com/nodejs/node/commit/660f7591c8)] - **buffer**: FreeCallback should be tied to ArrayBuffer (Fedor Indutny) [#3198](https://github.com/nodejs/node/pull/3198) * [[`651a5b51eb`](https://github.com/nodejs/node/commit/651a5b51eb)] - **buffer**: only check if instance is Uint8Array (Trevor Norris) [#3080](https://github.com/nodejs/node/pull/3080) * [[`d5a1b1ad7c`](https://github.com/nodejs/node/commit/d5a1b1ad7c)] - **buffer**: clean up usage of __proto__ (Trevor Norris) [#3080](https://github.com/nodejs/node/pull/3080) * [[`af24376e18`](https://github.com/nodejs/node/commit/af24376e18)] - **build**: Intl: deps: bump ICU to 56.1 (GA) (Steven R. Loomis) [#3281](https://github.com/nodejs/node/pull/3281) * [[`9136359d57`](https://github.com/nodejs/node/commit/9136359d57)] - **build**: make icu download path customizable (Johan Bergström) [#3200](https://github.com/nodejs/node/pull/3200) * [[`b3c5ad10a8`](https://github.com/nodejs/node/commit/b3c5ad10a8)] - **build**: add --with-arm-fpu option (Jérémy Lal) [#3228](https://github.com/nodejs/node/pull/3228) * [[`f00f3268e4`](https://github.com/nodejs/node/commit/f00f3268e4)] - **build**: intl: avoid 'duplicate main()' on ICU 56 (Steven R. Loomis) [#3066](https://github.com/nodejs/node/pull/3066) * [[`071c72a6a3`](https://github.com/nodejs/node/commit/071c72a6a3)] - **deps**: upgrade to npm 2.14.7 (Kat Marchán) [#3299](https://github.com/nodejs/node/pull/3299) * [[`8b50e95f06`](https://github.com/nodejs/node/commit/8b50e95f06)] - **(SEMVER-MINOR)** **deps**: backport 1ee712a from V8 upstream (Julien Gilli) [#3036](https://github.com/nodejs/node/pull/3036) * [[`747271372f`](https://github.com/nodejs/node/commit/747271372f)] - **doc**: update the assert module summary (David Boivin) [#2799](https://github.com/nodejs/node/pull/2799) * [[`0d506556b0`](https://github.com/nodejs/node/commit/0d506556b0)] - **doc**: replace node-gyp link with nodejs/node-gyp (Roman Klauke) [#3320](https://github.com/nodejs/node/pull/3320) * [[`40a159e4f4`](https://github.com/nodejs/node/commit/40a159e4f4)] - **doc**: Amend capitalization of word JavaScript (Dave Hodder) [#3285](https://github.com/nodejs/node/pull/3285) * [[`6dd34761fd`](https://github.com/nodejs/node/commit/6dd34761fd)] - **doc**: add method links in dns.markdown (Alejandro Oviedo) [#3196](https://github.com/nodejs/node/pull/3196) * [[`333e8336be`](https://github.com/nodejs/node/commit/333e8336be)] - **doc**: add method links in child_process.markdown (Alejandro Oviedo) [#3186](https://github.com/nodejs/node/pull/3186) * [[`0cfc6d39ca`](https://github.com/nodejs/node/commit/0cfc6d39ca)] - **doc**: recommend Infinity on emitter.setMaxListeners (Jason Karns) [#2559](https://github.com/nodejs/node/pull/2559) * [[`d4fc6d93ef`](https://github.com/nodejs/node/commit/d4fc6d93ef)] - **doc**: add help repo link to CONTRIBUTING.md (Doug Shamoo) [#3233](https://github.com/nodejs/node/pull/3233) * [[`28aac7f19d`](https://github.com/nodejs/node/commit/28aac7f19d)] - **doc**: add TLS session resumption example (Roman Reiss) [#3147](https://github.com/nodejs/node/pull/3147) * [[`365cf22cce`](https://github.com/nodejs/node/commit/365cf22cce)] - **doc**: update AUTHORS list (Rod Vagg) [#3211](https://github.com/nodejs/node/pull/3211) * [[`d4399613b7`](https://github.com/nodejs/node/commit/d4399613b7)] - **doc**: standardize references to userland (Martial) [#3192](https://github.com/nodejs/node/pull/3192) * [[`75de258376`](https://github.com/nodejs/node/commit/75de258376)] - **doc**: fix spelling in Buffer documentation (Rod Machen) [#3226](https://github.com/nodejs/node/pull/3226) * [[`725c7276dd`](https://github.com/nodejs/node/commit/725c7276dd)] - **doc**: fix README.md link to joyent/node intl wiki (Steven R. Loomis) [#3067](https://github.com/nodejs/node/pull/3067) * [[`4a35ba4966`](https://github.com/nodejs/node/commit/4a35ba4966)] - **(SEMVER-MINOR)** **fs**: include filename in watch errors (charlierudolph) [#2748](https://github.com/nodejs/node/pull/2748) * [[`2ddbbfd164`](https://github.com/nodejs/node/commit/2ddbbfd164)] - **http**: cork/uncork before flushing pipelined res (Fedor Indutny) [#3172](https://github.com/nodejs/node/pull/3172) * [[`f638402e2f`](https://github.com/nodejs/node/commit/f638402e2f)] - **http**: add comment about `outputSize` in res/server (Fedor Indutny) [#3128](https://github.com/nodejs/node/pull/3128) * [[`1850879b0e`](https://github.com/nodejs/node/commit/1850879b0e)] - **js_stream**: prevent abort if isalive doesn't exist (Trevor Norris) [#3282](https://github.com/nodejs/node/pull/3282) * [[`63644dd1cd`](https://github.com/nodejs/node/commit/63644dd1cd)] - **lib**: remove redundant code, add tests in timers.js (Rich Trott) [#3143](https://github.com/nodejs/node/pull/3143) * [[`74f443583c`](https://github.com/nodejs/node/commit/74f443583c)] - **module**: use UNC paths when loading native addons (Justin Chase) [#2965](https://github.com/nodejs/node/pull/2965) * [[`01cb3fc36b`](https://github.com/nodejs/node/commit/01cb3fc36b)] - **net**: don't throw on bytesWritten access (Trevor Norris) [#3305](https://github.com/nodejs/node/pull/3305) * [[`9d65528b01`](https://github.com/nodejs/node/commit/9d65528b01)] - **(SEMVER-MINOR)** **node**: add -c|--check CLI arg to syntax check script (Dave Eddy) [#2411](https://github.com/nodejs/node/pull/2411) * [[`42b936e78d`](https://github.com/nodejs/node/commit/42b936e78d)] - **(SEMVER-MINOR)** **src**: add process.release.lts property (Rod Vagg) [#3212](https://github.com/nodejs/node/pull/3212) * [[`589287b2e3`](https://github.com/nodejs/node/commit/589287b2e3)] - **src**: convert BE-utf16-string to LE before search (Karl Skomski) [#3295](https://github.com/nodejs/node/pull/3295) * [[`2314378f06`](https://github.com/nodejs/node/commit/2314378f06)] - **src**: fix u-a-free if uv returns err in ASYNC_CALL (Karl Skomski) [#3049](https://github.com/nodejs/node/pull/3049) * [[`d99336a391`](https://github.com/nodejs/node/commit/d99336a391)] - **(SEMVER-MINOR)** **src**: replace naive search in Buffer::IndexOf (Karl Skomski) [#2539](https://github.com/nodejs/node/pull/2539) * [[`546e8333ba`](https://github.com/nodejs/node/commit/546e8333ba)] - **(SEMVER-MINOR)** **src**: fix --abort-on-uncaught-exception (Jeremy Whitlock) [#3036](https://github.com/nodejs/node/pull/3036) * [[`7271cb047c`](https://github.com/nodejs/node/commit/7271cb047c)] - **(SEMVER-MINOR)** **src**: add process.versions.icu (Evan Lucas) [#3102](https://github.com/nodejs/node/pull/3102) * [[`7b9f78acb2`](https://github.com/nodejs/node/commit/7b9f78acb2)] - **stream**: avoid pause with unpipe in buffered write (Brian White) [#2325](https://github.com/nodejs/node/pull/2325) * [[`f0f8afd879`](https://github.com/nodejs/node/commit/f0f8afd879)] - **test**: remove common.inspect() (Rich Trott) [#3257](https://github.com/nodejs/node/pull/3257) * [[`5ca4f6f8bd`](https://github.com/nodejs/node/commit/5ca4f6f8bd)] - **test**: test `util` rather than `common` (Rich Trott) [#3256](https://github.com/nodejs/node/pull/3256) * [[`7a5ae34345`](https://github.com/nodejs/node/commit/7a5ae34345)] - **test**: refresh temp directory when using pipe (Rich Trott) [#3231](https://github.com/nodejs/node/pull/3231) * [[`7c85557ef0`](https://github.com/nodejs/node/commit/7c85557ef0)] - **test**: Fix test-fs-read-stream-fd-leak race cond (Junliang Yan) [#3218](https://github.com/nodejs/node/pull/3218) * [[`26a7ec6960`](https://github.com/nodejs/node/commit/26a7ec6960)] - **test**: fix losing original env vars issue (Junliang Yan) [#3190](https://github.com/nodejs/node/pull/3190) * [[`e922716192`](https://github.com/nodejs/node/commit/e922716192)] - **test**: remove deprecated error logging (Rich Trott) [#3079](https://github.com/nodejs/node/pull/3079) * [[`8f29d95a8c`](https://github.com/nodejs/node/commit/8f29d95a8c)] - **test**: report timeout in TapReporter (Karl Skomski) [#2647](https://github.com/nodejs/node/pull/2647) * [[`2d0fe4c657`](https://github.com/nodejs/node/commit/2d0fe4c657)] - **test**: linting for buffer-free-callback test (Rich Trott) [#3230](https://github.com/nodejs/node/pull/3230) * [[`70c9e4337e`](https://github.com/nodejs/node/commit/70c9e4337e)] - **test**: make common.js mandatory via linting rule (Rich Trott) [#3157](https://github.com/nodejs/node/pull/3157) * [[`b7179562aa`](https://github.com/nodejs/node/commit/b7179562aa)] - **test**: load common.js in all tests (Rich Trott) [#3157](https://github.com/nodejs/node/pull/3157) * [[`bab555a1c1`](https://github.com/nodejs/node/commit/bab555a1c1)] - **test**: speed up stringbytes-external test (Evan Lucas) [#3005](https://github.com/nodejs/node/pull/3005) * [[`ddf258376d`](https://github.com/nodejs/node/commit/ddf258376d)] - **test**: use normalize() for unicode paths (Roman Reiss) [#3007](https://github.com/nodejs/node/pull/3007) * [[`46876d519c`](https://github.com/nodejs/node/commit/46876d519c)] - **test**: remove arguments.callee usage (Roman Reiss) [#3167](https://github.com/nodejs/node/pull/3167) * [[`af10df6108`](https://github.com/nodejs/node/commit/af10df6108)] - **tls**: use parent handle's close callback (Fedor Indutny) [#2991](https://github.com/nodejs/node/pull/2991) * [[`9c2748bad1`](https://github.com/nodejs/node/commit/9c2748bad1)] - **tools**: remove leftover license boilerplate (Nathan Rajlich) [#3225](https://github.com/nodejs/node/pull/3225) * [[`5d9f83ff2a`](https://github.com/nodejs/node/commit/5d9f83ff2a)] - **tools**: apply linting to custom rules code (Rich Trott) [#3195](https://github.com/nodejs/node/pull/3195) * [[`18a8b2ec73`](https://github.com/nodejs/node/commit/18a8b2ec73)] - **tools**: remove unused gflags module (Ben Noordhuis) [#3220](https://github.com/nodejs/node/pull/3220) * [[`e0fffca836`](https://github.com/nodejs/node/commit/e0fffca836)] - **util**: fix for inspecting promises (Evan Lucas) [#3221](https://github.com/nodejs/node/pull/3221) * [[`8dfdee3733`](https://github.com/nodejs/node/commit/8dfdee3733)] - **util**: correctly inspect Map/Set Iterators (Evan Lucas) [#3119](https://github.com/nodejs/node/pull/3119) * [[`b5c51fdba0`](https://github.com/nodejs/node/commit/b5c51fdba0)] - **util**: fix check for Array constructor (Evan Lucas) [#3119](https://github.com/nodejs/node/pull/3119) ## 2015-10-05, Version 4.1.2 (Stable), @rvagg ### Notable changes * **http**: - Fix out-of-order 'finish' event bug in pipelining that can abort execution, fixes DoS vulnerability [CVE-2015-7384](https://github.com/nodejs/node/issues/3138) (Fedor Indutny) [#3128](https://github.com/nodejs/node/pull/3128) - Account for pending response data instead of just the data on the current request to decide whether pause the socket or not (Fedor Indutny) [#3128](https://github.com/nodejs/node/pull/3128) * **libuv**: Upgraded from v1.7.4 to v1.7.5, see [release notes](https://github.com/libuv/libuv/releases/tag/v1.7.5) for details (Saúl Ibarra Corretgé) [#3010](https://github.com/nodejs/node/pull/3010) - A better rwlock implementation for all Windows versions - Improved AIX support * **v8**: - Upgraded from v4.5.103.33 to v4.5.103.35 (Ali Ijaz Sheikh) [#3117](https://github.com/nodejs/node/pull/3117) - Backported [f782159](https://codereview.chromium.org/1367123003) from v8's upstream to help speed up Promise introspection (Ben Noordhuis) [#3130](https://github.com/nodejs/node/pull/3130) - Backported [c281c15](https://codereview.chromium.org/1363683002) from v8's upstream to add JSTypedArray length in post-mortem metadata (Julien Gilli) [#3031](https://github.com/nodejs/node/pull/3031) ### Known issues See https://github.com/nodejs/node/labels/confirmed-bug for complete and current list of known issues. * Some problems with unreferenced timers running during `beforeExit` are still to be resolved. See [#1264](https://github.com/nodejs/node/issues/1264). * Surrogate pair in REPL can freeze terminal. [#690](https://github.com/nodejs/node/issues/690) * Calling `dns.setServers()` while a DNS query is in progress can cause the process to crash on a failed assertion. [#894](https://github.com/nodejs/node/issues/894) * `url.resolve` may transfer the auth portion of the url when resolving between two full hosts, see [#1435](https://github.com/nodejs/node/issues/1435). ### Commits * [[`39b8730e8b`](https://github.com/nodejs/node/commit/39b8730e8b)] - **async_wrap**: ensure all objects have internal field (Trevor Norris) [#3139](https://github.com/nodejs/node/pull/3139) * [[`99e66074d7`](https://github.com/nodejs/node/commit/99e66074d7)] - **async_wrap**: update providers and add test (Trevor Norris) [#3139](https://github.com/nodejs/node/pull/3139) * [[`7a58157d4e`](https://github.com/nodejs/node/commit/7a58157d4e)] - **benchmark**: update comment in common.js (Minwoo Jung) [#2399](https://github.com/nodejs/node/pull/2399) * [[`9e9bfa4dc0`](https://github.com/nodejs/node/commit/9e9bfa4dc0)] - **build**: iojs -> nodejs of release-urlbase (P.S.V.R) [#3015](https://github.com/nodejs/node/pull/3015) * [[`8335ec7191`](https://github.com/nodejs/node/commit/8335ec7191)] - **build**: fix some typos inside the configure script (P.S.V.R) [#3016](https://github.com/nodejs/node/pull/3016) * [[`d6ac547d5d`](https://github.com/nodejs/node/commit/d6ac547d5d)] - **build,win**: fix node.exe resource version (João Reis) [#3053](https://github.com/nodejs/node/pull/3053) * [[`798dad24f4`](https://github.com/nodejs/node/commit/798dad24f4)] - **child_process**: `null` channel handle on close (Fedor Indutny) [#3041](https://github.com/nodejs/node/pull/3041) * [[`e5615854ea`](https://github.com/nodejs/node/commit/e5615854ea)] - **contextify**: use CHECK instead of `if` (Oguz Bastemur) [#3125](https://github.com/nodejs/node/pull/3125) * [[`f055a66a38`](https://github.com/nodejs/node/commit/f055a66a38)] - **crypto**: enable FIPS only when configured with it (Fedor Indutny) [#3153](https://github.com/nodejs/node/pull/3153) * [[`4c8d96bc30`](https://github.com/nodejs/node/commit/4c8d96bc30)] - **crypto**: add more keylen sanity checks in pbkdf2 (Johann) [#3029](https://github.com/nodejs/node/pull/3029) * [[`4c5940776c`](https://github.com/nodejs/node/commit/4c5940776c)] - **deps**: upgrade libuv to 1.7.5 (Saúl Ibarra Corretgé) [#3010](https://github.com/nodejs/node/pull/3010) * [[`5a9e795577`](https://github.com/nodejs/node/commit/5a9e795577)] - **deps**: upgrade V8 to 4.5.103.35 (Ali Ijaz Sheikh) [#3117](https://github.com/nodejs/node/pull/3117) * [[`925b29f959`](https://github.com/nodejs/node/commit/925b29f959)] - **deps**: backport f782159 from v8's upstream (Ben Noordhuis) [#3130](https://github.com/nodejs/node/pull/3130) * [[`039f73fa83`](https://github.com/nodejs/node/commit/039f73fa83)] - **deps**: remove and gitignore .bin directory (Ben Noordhuis) [#3004](https://github.com/nodejs/node/pull/3004) * [[`5fbb24812d`](https://github.com/nodejs/node/commit/5fbb24812d)] - **deps**: backport c281c15 from V8's upstream (Julien Gilli) [#3031](https://github.com/nodejs/node/pull/3031) * [[`6ee5d0f69f`](https://github.com/nodejs/node/commit/6ee5d0f69f)] - **dns**: add missing exports.BADNAME (Roman Reiss) [#3051](https://github.com/nodejs/node/pull/3051) * [[`f92aee7170`](https://github.com/nodejs/node/commit/f92aee7170)] - **doc**: fix outdated 'try/catch' statement in sync (Minwoo Jung) [#3087](https://github.com/nodejs/node/pull/3087) * [[`c7161f39e8`](https://github.com/nodejs/node/commit/c7161f39e8)] - **doc**: add TSC meeting minutes 2015-09-16 (Rod Vagg) [#3023](https://github.com/nodejs/node/pull/3023) * [[`928166c4a8`](https://github.com/nodejs/node/commit/928166c4a8)] - **doc**: copyedit fs.watch() information (Rich Trott) [#3097](https://github.com/nodejs/node/pull/3097) * [[`75d5dcea76`](https://github.com/nodejs/node/commit/75d5dcea76)] - **doc**: jenkins-iojs.nodesource.com -> ci.nodejs.org (Michał Gołębiowski) [#2886](https://github.com/nodejs/node/pull/2886) * [[`5c3f50b21d`](https://github.com/nodejs/node/commit/5c3f50b21d)] - **doc**: rearrange execSync and execFileSync (Laurent Fortin) [#2940](https://github.com/nodejs/node/pull/2940) * [[`4fc33ac11a`](https://github.com/nodejs/node/commit/4fc33ac11a)] - **doc**: make execFileSync in line with execFile (Laurent Fortin) [#2940](https://github.com/nodejs/node/pull/2940) * [[`a366e84b17`](https://github.com/nodejs/node/commit/a366e84b17)] - **doc**: fix typos in cluster & errors (reggi) [#3011](https://github.com/nodejs/node/pull/3011) * [[`52031e1bf1`](https://github.com/nodejs/node/commit/52031e1bf1)] - **doc**: switch LICENSE from closure-linter to eslint (P.S.V.R) [#3018](https://github.com/nodejs/node/pull/3018) * [[`b28f6a53bc`](https://github.com/nodejs/node/commit/b28f6a53bc)] - **docs**: Clarify assert.doesNotThrow behavior (Fabio Oliveira) [#2807](https://github.com/nodejs/node/pull/2807) * [[`99943e189d`](https://github.com/nodejs/node/commit/99943e189d)] - **http**: fix out-of-order 'finish' bug in pipelining (Fedor Indutny) [#3128](https://github.com/nodejs/node/pull/3128) * [[`fb7a491d1c`](https://github.com/nodejs/node/commit/fb7a491d1c)] - **http_server**: pause socket properly (Fedor Indutny) [#3128](https://github.com/nodejs/node/pull/3128) * [[`a0b35bfcf3`](https://github.com/nodejs/node/commit/a0b35bfcf3)] - **i18n**: add caller to removal list for bidi in ICU55 (Michael Dawson) [#3115](https://github.com/nodejs/node/pull/3115) * [[`ac2bce0b0c`](https://github.com/nodejs/node/commit/ac2bce0b0c)] - **path**: improve posixSplitPath performance (Evan Lucas) [#3034](https://github.com/nodejs/node/pull/3034) * [[`37cdeafa2f`](https://github.com/nodejs/node/commit/37cdeafa2f)] - **smalloc**: remove module (Brendan Ashworth) [#3099](https://github.com/nodejs/node/pull/3099) * [[`5ec5d0aa8b`](https://github.com/nodejs/node/commit/5ec5d0aa8b)] - **src**: internalize binding function property names (Ben Noordhuis) [#3060](https://github.com/nodejs/node/pull/3060) * [[`c8175fc2af`](https://github.com/nodejs/node/commit/c8175fc2af)] - **src**: internalize per-isolate string properties (Ben Noordhuis) [#3060](https://github.com/nodejs/node/pull/3060) * [[`9a593abc47`](https://github.com/nodejs/node/commit/9a593abc47)] - **src**: include signal.h in util.h (Cheng Zhao) [#3058](https://github.com/nodejs/node/pull/3058) * [[`fde0c6f321`](https://github.com/nodejs/node/commit/fde0c6f321)] - **src**: fix function and variable names in comments (Sakthipriyan Vairamani) [#3039](https://github.com/nodejs/node/pull/3039) * [[`1cc7b41ba4`](https://github.com/nodejs/node/commit/1cc7b41ba4)] - **stream_wrap**: support empty `TryWrite`s (Fedor Indutny) [#3128](https://github.com/nodejs/node/pull/3128) * [[`9faf4c6fcf`](https://github.com/nodejs/node/commit/9faf4c6fcf)] - **test**: load common.js to test for global leaks (Rich Trott) [#3095](https://github.com/nodejs/node/pull/3095) * [[`0858c86374`](https://github.com/nodejs/node/commit/0858c86374)] - **test**: fix invalid variable name (Sakthipriyan Vairamani) [#3150](https://github.com/nodejs/node/pull/3150) * [[`1167171004`](https://github.com/nodejs/node/commit/1167171004)] - **test**: change calls to deprecated util.print() (Rich Trott) [#3083](https://github.com/nodejs/node/pull/3083) * [[`5ada45bf28`](https://github.com/nodejs/node/commit/5ada45bf28)] - **test**: replace deprecated util.debug() calls (Rich Trott) [#3082](https://github.com/nodejs/node/pull/3082) * [[`d8ab4e185d`](https://github.com/nodejs/node/commit/d8ab4e185d)] - **util**: optimize promise introspection (Ben Noordhuis) [#3130](https://github.com/nodejs/node/pull/3130) ## 2015-09-22, Version 4.1.1 (Stable), @rvagg ### Notable changes * **buffer**: Fixed a bug introduced in v4.1.0 where allocating a new zero-length buffer can result in the _next_ allocation of a TypedArray in JavaScript not being zero-filled. In certain circumstances this could result in data leakage via reuse of memory space in TypedArrays, breaking the normally safe assumption that TypedArrays should be always zero-filled. (Trevor Norris) [#2931](https://github.com/nodejs/node/pull/2931). * **http**: Guard against response-splitting of HTTP trailing headers added via [`response.addTrailers()`](https://nodejs.org/api/http.html#http_response_addtrailers_headers) by removing new-line (`[\r\n]`) characters from values. Note that standard header values are already stripped of new-line characters. The expected security impact is low because trailing headers are rarely used. (Ben Noordhuis) [#2945](https://github.com/nodejs/node/pull/2945). * **npm**: Upgrade to npm 2.14.4 from 2.14.3, see [release notes](https://github.com/npm/npm/releases/tag/v2.14.4) for full details (Kat Marchán) [#2958](https://github.com/nodejs/node/pull/2958) - Upgrades `graceful-fs` on multiple dependencies to no longer rely on monkey-patching `fs` - Fix `npm link` for pre-release / RC builds of Node * **v8**: Update post-mortem metadata to allow post-mortem debugging tools to find and inspect: - JavaScript objects that use dictionary properties (Julien Gilli) [#2959](https://github.com/nodejs/node/pull/2959) - ScopeInfo and thus closures (Julien Gilli) [#2974](https://github.com/nodejs/node/pull/2974) ### Known issues See https://github.com/nodejs/node/labels/confirmed-bug for complete and current list of known issues. * Some problems with unreferenced timers running during `beforeExit` are still to be resolved. See [#1264](https://github.com/nodejs/node/issues/1264). * Surrogate pair in REPL can freeze terminal. [#690](https://github.com/nodejs/node/issues/690) * Calling `dns.setServers()` while a DNS query is in progress can cause the process to crash on a failed assertion. [#894](https://github.com/nodejs/node/issues/894) * `url.resolve` may transfer the auth portion of the url when resolving between two full hosts, see [#1435](https://github.com/nodejs/node/issues/1435). ### Commits * [[`d63e02e08d`](https://github.com/nodejs/node/commit/d63e02e08d)] - **buffer**: don't set zero fill for zero-length buffer (Trevor Norris) [#2931](https://github.com/nodejs/node/pull/2931) * [[`5905b14bff`](https://github.com/nodejs/node/commit/5905b14bff)] - **build**: fix icutrim when building small-icu on BE (Stewart Addison) [#2602](https://github.com/nodejs/node/pull/2602) * [[`f010cb5d96`](https://github.com/nodejs/node/commit/f010cb5d96)] - **configure**: detect mipsel host (Jérémy Lal) [#2971](https://github.com/nodejs/node/pull/2971) * [[`b93ad5abbd`](https://github.com/nodejs/node/commit/b93ad5abbd)] - **deps**: backport 357e6b9 from V8's upstream (Julien Gilli) [#2974](https://github.com/nodejs/node/pull/2974) * [[`8da3da4d41`](https://github.com/nodejs/node/commit/8da3da4d41)] - **deps**: backport ff7d70b from V8's upstream (Julien Gilli) [#2959](https://github.com/nodejs/node/pull/2959) * [[`2600fb8ae6`](https://github.com/nodejs/node/commit/2600fb8ae6)] - **deps**: upgraded to node-gyp@3.0.3 in npm (Kat Marchán) [#2958](https://github.com/nodejs/node/pull/2958) * [[`793aad2d7a`](https://github.com/nodejs/node/commit/793aad2d7a)] - **deps**: upgrade to npm 2.14.4 (Kat Marchán) [#2958](https://github.com/nodejs/node/pull/2958) * [[`43e2b7f836`](https://github.com/nodejs/node/commit/43e2b7f836)] - **doc**: remove usage of events.EventEmitter (Sakthipriyan Vairamani) [#2921](https://github.com/nodejs/node/pull/2921) * [[`9c59d2f16a`](https://github.com/nodejs/node/commit/9c59d2f16a)] - **doc**: remove extra using v8::HandleScope statement (Christopher J. Brody) [#2983](https://github.com/nodejs/node/pull/2983) * [[`f7edbab367`](https://github.com/nodejs/node/commit/f7edbab367)] - **doc**: clarify description of assert.ifError() (Rich Trott) [#2941](https://github.com/nodejs/node/pull/2941) * [[`b2ddf0f9a2`](https://github.com/nodejs/node/commit/b2ddf0f9a2)] - **doc**: refine process.kill() and exit explanations (Rich Trott) [#2918](https://github.com/nodejs/node/pull/2918) * [[`f68fed2e6f`](https://github.com/nodejs/node/commit/f68fed2e6f)] - **http**: remove redundant code in _deferToConnect (Malcolm Ahoy) [#2769](https://github.com/nodejs/node/pull/2769) * [[`f542e74c93`](https://github.com/nodejs/node/commit/f542e74c93)] - **http**: guard against response splitting in trailers (Ben Noordhuis) [#2945](https://github.com/nodejs/node/pull/2945) * [[`bc9f629387`](https://github.com/nodejs/node/commit/bc9f629387)] - **http_parser**: do not dealloc during kOnExecute (Fedor Indutny) [#2956](https://github.com/nodejs/node/pull/2956) * [[`1860e0cebd`](https://github.com/nodejs/node/commit/1860e0cebd)] - **lib,src**: remove usage of events.EventEmitter (Sakthipriyan Vairamani) [#2921](https://github.com/nodejs/node/pull/2921) * [[`d4cd5ac407`](https://github.com/nodejs/node/commit/d4cd5ac407)] - **readline**: fix tab completion bug (Matt Harrison) [#2816](https://github.com/nodejs/node/pull/2816) * [[`9760e04839`](https://github.com/nodejs/node/commit/9760e04839)] - **repl**: don't use tty control codes when $TERM is set to "dumb" (Salman Aljammaz) [#2712](https://github.com/nodejs/node/pull/2712) * [[`cb971cc97d`](https://github.com/nodejs/node/commit/cb971cc97d)] - **repl**: backslash bug fix (Sakthipriyan Vairamani) [#2968](https://github.com/nodejs/node/pull/2968) * [[`2034f68668`](https://github.com/nodejs/node/commit/2034f68668)] - **src**: honor --abort_on_uncaught_exception flag (Evan Lucas) [#2776](https://github.com/nodejs/node/pull/2776) * [[`0b1ca4a9ef`](https://github.com/nodejs/node/commit/0b1ca4a9ef)] - **src**: Add ABORT macro (Evan Lucas) [#2776](https://github.com/nodejs/node/pull/2776) * [[`4519dd00f9`](https://github.com/nodejs/node/commit/4519dd00f9)] - **test**: test sync version of mkdir & rmdir (Sakthipriyan Vairamani) [#2588](https://github.com/nodejs/node/pull/2588) * [[`816f609c8b`](https://github.com/nodejs/node/commit/816f609c8b)] - **test**: use tmpDir instead of fixtures in readdir (Sakthipriyan Vairamani) [#2587](https://github.com/nodejs/node/pull/2587) * [[`2084f52585`](https://github.com/nodejs/node/commit/2084f52585)] - **test**: test more http response splitting scenarios (Ben Noordhuis) [#2945](https://github.com/nodejs/node/pull/2945) * [[`fa08d1d8a1`](https://github.com/nodejs/node/commit/fa08d1d8a1)] - **test**: add test-spawn-cmd-named-pipe (Alexis Campailla) [#2770](https://github.com/nodejs/node/pull/2770) * [[`71b5d80682`](https://github.com/nodejs/node/commit/71b5d80682)] - **test**: make cluster tests more time tolerant (Michael Dawson) [#2891](https://github.com/nodejs/node/pull/2891) * [[`3e09dcfc32`](https://github.com/nodejs/node/commit/3e09dcfc32)] - **test**: update cwd-enoent tests for AIX (Imran Iqbal) [#2909](https://github.com/nodejs/node/pull/2909) * [[`6ea8ec1c59`](https://github.com/nodejs/node/commit/6ea8ec1c59)] - **tools**: single, cross-platform tick processor (Matt Loring) [#2868](https://github.com/nodejs/node/pull/2868) ## 2015-09-17, Version 4.1.0 (Stable), @Fishrock123 ### Notable changes * **buffer**: - Buffers are now created in JavaScript, rather than C++. This increases the speed of buffer creation (Trevor Norris) [#2866](https://github.com/nodejs/node/pull/2866). - `Buffer#slice()` now uses `Uint8Array#subarray()` internally, increasing `slice()` performance (Karl Skomski) [#2777](https://github.com/nodejs/node/pull/2777). * **fs**: - `fs.utimes()` now properly converts numeric strings, `NaN`, and `Infinity` (Yazhong Liu) [#2387](https://github.com/nodejs/node/pull/2387). - `fs.WriteStream` now implements `_writev`, allowing for super-fast bulk writes (Ron Korving) [#2167](https://github.com/nodejs/node/pull/2167). * **http**: Fixed an issue with certain `write()` sizes causing errors when using `http.request()` (Fedor Indutny) [#2824](https://github.com/nodejs/node/pull/2824). * **npm**: Upgrade to version 2.14.3, see https://github.com/npm/npm/releases/tag/v2.14.3 for more details (Kat Marchán) [#2822](https://github.com/nodejs/node/pull/2822). * **src**: V8 cpu profiling no longer erroneously shows idle time (Oleksandr Chekhovskyi) [#2324](https://github.com/nodejs/node/pull/2324). * **timers**: `#ref()` and `#unref()` now return the timer they belong to (Sam Roberts) [#2905](https://github.com/nodejs/node/pull/2905). * **v8**: Lateral upgrade to 4.5.103.33 from 4.5.103.30, contains minor fixes (Ali Ijaz Sheikh) [#2870](https://github.com/nodejs/node/pull/2870). - This fixes a previously known bug where some computed object shorthand properties did not work correctly ([#2507](https://github.com/nodejs/node/issues/2507)). ### Known issues See https://github.com/nodejs/node/labels/confirmed-bug for complete and current list of known issues. * Some problems with unreferenced timers running during `beforeExit` are still to be resolved. See [#1264](https://github.com/nodejs/node/issues/1264). * Surrogate pair in REPL can freeze terminal. [#690](https://github.com/nodejs/node/issues/690) * Calling `dns.setServers()` while a DNS query is in progress can cause the process to crash on a failed assertion. [#894](https://github.com/nodejs/node/issues/894) * `url.resolve` may transfer the auth portion of the url when resolving between two full hosts, see [#1435](https://github.com/nodejs/node/issues/1435). ### Commits * [[`b1abe812cd`](https://github.com/nodejs/node/commit/b1abe812cd)] - Working on 4.0.1 (Rod Vagg) * [[`f9f8378853`](https://github.com/nodejs/node/commit/f9f8378853)] - 2015-09-08, Version 4.0.0 (Stable) Release (Rod Vagg) * [[`9683e5df51`](https://github.com/nodejs/node/commit/9683e5df51)] - **bindings**: close after reading module struct (Fedor Indutny) [#2792](https://github.com/nodejs/node/pull/2792) * [[`4b4cfa2d44`](https://github.com/nodejs/node/commit/4b4cfa2d44)] - **buffer**: always allocate typed arrays outside heap (Trevor Norris) [#2893](https://github.com/nodejs/node/pull/2893) * [[`7df018a29b`](https://github.com/nodejs/node/commit/7df018a29b)] - **buffer**: construct Uint8Array in JS (Trevor Norris) [#2866](https://github.com/nodejs/node/pull/2866) * [[`43397b204e`](https://github.com/nodejs/node/commit/43397b204e)] - **(SEMVER-MINOR)** **build**: Updates to enable AIX support (Michael Dawson) [#2364](https://github.com/nodejs/node/pull/2364) * [[`e35b1fd610`](https://github.com/nodejs/node/commit/e35b1fd610)] - **build**: clean up the generated tap file (Sakthipriyan Vairamani) [#2837](https://github.com/nodejs/node/pull/2837) * [[`96670ebe37`](https://github.com/nodejs/node/commit/96670ebe37)] - **deps**: backport 6d32be2 from v8's upstream (Michaël Zasso) [#2916](https://github.com/nodejs/node/pull/2916) * [[`94972d5b13`](https://github.com/nodejs/node/commit/94972d5b13)] - **deps**: backport 0d01728 from v8's upstream (Fedor Indutny) [#2912](https://github.com/nodejs/node/pull/2912) * [[`7ebd881c29`](https://github.com/nodejs/node/commit/7ebd881c29)] - **deps**: upgrade V8 to 4.5.103.33 (Ali Ijaz Sheikh) [#2870](https://github.com/nodejs/node/pull/2870) * [[`ed47ab6e44`](https://github.com/nodejs/node/commit/ed47ab6e44)] - **deps**: upgraded to node-gyp@3.0.3 in npm (Kat Marchán) [#2822](https://github.com/nodejs/node/pull/2822) * [[`f4641ae875`](https://github.com/nodejs/node/commit/f4641ae875)] - **deps**: upgrade to npm 2.14.3 (Kat Marchán) [#2822](https://github.com/nodejs/node/pull/2822) * [[`8119693a3d`](https://github.com/nodejs/node/commit/8119693a3d)] - **deps**: update libuv to version 1.7.4 (Saúl Ibarra Corretgé) [#2817](https://github.com/nodejs/node/pull/2817) * [[`6098504685`](https://github.com/nodejs/node/commit/6098504685)] - **deps**: cherry-pick 6da51b4 from v8's upstream (Fedor Indutny) [#2801](https://github.com/nodejs/node/pull/2801) * [[`bf42cc8dba`](https://github.com/nodejs/node/commit/bf42cc8dba)] - **doc**: process exit event is not guaranteed to fire (Rich Trott) [#2861](https://github.com/nodejs/node/pull/2861) * [[`bb0f869f67`](https://github.com/nodejs/node/commit/bb0f869f67)] - **doc**: remove incorrect reference to TCP in net docs (Sam Roberts) [#2903](https://github.com/nodejs/node/pull/2903) * [[`302d59dce8`](https://github.com/nodejs/node/commit/302d59dce8)] - **doc**: correct buffer.slice arg syntax (Sam Roberts) [#2903](https://github.com/nodejs/node/pull/2903) * [[`74db9637b7`](https://github.com/nodejs/node/commit/74db9637b7)] - **doc**: describe spawn option.detached (Sam Roberts) [#2903](https://github.com/nodejs/node/pull/2903) * [[`a7bd897273`](https://github.com/nodejs/node/commit/a7bd897273)] - **doc**: rename from iojs(1) to node(1) in benchmarks (Dmitry Vasilyev) [#2884](https://github.com/nodejs/node/pull/2884) * [[`cd643d7c37`](https://github.com/nodejs/node/commit/cd643d7c37)] - **doc**: add missing backtick in buffer.markdown (Sven Slootweg) [#2881](https://github.com/nodejs/node/pull/2881) * [[`e8a206e802`](https://github.com/nodejs/node/commit/e8a206e802)] - **doc**: fix broken link in repl.markdown (Danny Nemer) [#2827](https://github.com/nodejs/node/pull/2827) * [[`7ee36d61f7`](https://github.com/nodejs/node/commit/7ee36d61f7)] - **doc**: fix typos in README (Ionică Bizău) [#2852](https://github.com/nodejs/node/pull/2852) * [[`4d1ae26196`](https://github.com/nodejs/node/commit/4d1ae26196)] - **doc**: add tunniclm as a collaborator (Mike Tunnicliffe) [#2826](https://github.com/nodejs/node/pull/2826) * [[`2d77d03643`](https://github.com/nodejs/node/commit/2d77d03643)] - **doc**: fix two doc errors in stream and process (Jeremiah Senkpiel) [#2549](https://github.com/nodejs/node/pull/2549) * [[`55ac24f721`](https://github.com/nodejs/node/commit/55ac24f721)] - **doc**: fixed io.js references in process.markdown (Tristian Flanagan) [#2846](https://github.com/nodejs/node/pull/2846) * [[`cd1297fb57`](https://github.com/nodejs/node/commit/cd1297fb57)] - **doc**: use "Calls" over "Executes" for consistency (Minwoo Jung) [#2800](https://github.com/nodejs/node/pull/2800) * [[`d664b95581`](https://github.com/nodejs/node/commit/d664b95581)] - **doc**: use US English for consistency (Anne-Gaelle Colom) [#2784](https://github.com/nodejs/node/pull/2784) * [[`82ba1839fb`](https://github.com/nodejs/node/commit/82ba1839fb)] - **doc**: use 3rd person singular for consistency (Anne-Gaelle Colom) [#2765](https://github.com/nodejs/node/pull/2765) * [[`432cce6e95`](https://github.com/nodejs/node/commit/432cce6e95)] - **doc**: describe process API for IPC (Sam Roberts) [#1978](https://github.com/nodejs/node/pull/1978) * [[`1d75012b9d`](https://github.com/nodejs/node/commit/1d75012b9d)] - **doc**: fix comma splice in Assertion Testing doc (Rich Trott) [#2728](https://github.com/nodejs/node/pull/2728) * [[`6108ea9bb4`](https://github.com/nodejs/node/commit/6108ea9bb4)] - **fs**: consider NaN/Infinity in toUnixTimestamp (Yazhong Liu) [#2387](https://github.com/nodejs/node/pull/2387) * [[`2b6aa9415f`](https://github.com/nodejs/node/commit/2b6aa9415f)] - **(SEMVER-MINOR)** **fs**: implemented WriteStream#writev (Ron Korving) [#2167](https://github.com/nodejs/node/pull/2167) * [[`431bf74c55`](https://github.com/nodejs/node/commit/431bf74c55)] - **http**: default Agent.getName to 'localhost' (Malcolm Ahoy) [#2825](https://github.com/nodejs/node/pull/2825) * [[`ea15d71c16`](https://github.com/nodejs/node/commit/ea15d71c16)] - **http_server**: fix resume after socket close (Fedor Indutny) [#2824](https://github.com/nodejs/node/pull/2824) * [[`8e5843405b`](https://github.com/nodejs/node/commit/8e5843405b)] - **src**: null env_ field from constructor (Trevor Norris) [#2913](https://github.com/nodejs/node/pull/2913) * [[`0a5f80a11f`](https://github.com/nodejs/node/commit/0a5f80a11f)] - **src**: use subarray() in Buffer#slice() for speedup (Karl Skomski) [#2777](https://github.com/nodejs/node/pull/2777) * [[`57707e2490`](https://github.com/nodejs/node/commit/57707e2490)] - **src**: use ZCtxt as a source for v8::Isolates (Roman Klauke) [#2547](https://github.com/nodejs/node/pull/2547) * [[`b0df2273ab`](https://github.com/nodejs/node/commit/b0df2273ab)] - **src**: fix v8::CpuProfiler idle sampling (Oleksandr Chekhovskyi) [#2324](https://github.com/nodejs/node/pull/2324) * [[`eaa8e60b91`](https://github.com/nodejs/node/commit/eaa8e60b91)] - **streams**: refactor LazyTransform to internal/ (Brendan Ashworth) [#2566](https://github.com/nodejs/node/pull/2566) * [[`648c003e14`](https://github.com/nodejs/node/commit/648c003e14)] - **test**: use tmp directory in chdir test (Sakthipriyan Vairamani) [#2589](https://github.com/nodejs/node/pull/2589) * [[`079a2173d4`](https://github.com/nodejs/node/commit/079a2173d4)] - **test**: fix Buffer OOM error message (Trevor Norris) [#2915](https://github.com/nodejs/node/pull/2915) * [[`52019a1b21`](https://github.com/nodejs/node/commit/52019a1b21)] - **test**: fix default value for additional param (Sakthipriyan Vairamani) [#2553](https://github.com/nodejs/node/pull/2553) * [[`5df5d0423a`](https://github.com/nodejs/node/commit/5df5d0423a)] - **test**: remove disabled test (Rich Trott) [#2841](https://github.com/nodejs/node/pull/2841) * [[`9e5f0995bd`](https://github.com/nodejs/node/commit/9e5f0995bd)] - **test**: split up internet dns tests (Rich Trott) [#2802](https://github.com/nodejs/node/pull/2802) * [[`41f2dde51a`](https://github.com/nodejs/node/commit/41f2dde51a)] - **test**: increase dgram timeout for armv6 (Rich Trott) [#2808](https://github.com/nodejs/node/pull/2808) * [[`6e2fe1c21a`](https://github.com/nodejs/node/commit/6e2fe1c21a)] - **test**: remove valid hostname check in test-dns.js (Rich Trott) [#2785](https://github.com/nodejs/node/pull/2785) * [[`779e14f1a7`](https://github.com/nodejs/node/commit/779e14f1a7)] - **test**: expect error for test_lookup_ipv6_hint on FreeBSD (Rich Trott) [#2724](https://github.com/nodejs/node/pull/2724) * [[`f931b9dd95`](https://github.com/nodejs/node/commit/f931b9dd95)] - **(SEMVER-MINOR)** **timer**: ref/unref return self (Sam Roberts) [#2905](https://github.com/nodejs/node/pull/2905) * [[`59d03738cc`](https://github.com/nodejs/node/commit/59d03738cc)] - **tools**: enable arrow functions in .eslintrc (Sakthipriyan Vairamani) [#2840](https://github.com/nodejs/node/pull/2840) * [[`69e7b875a2`](https://github.com/nodejs/node/commit/69e7b875a2)] - **tools**: open `test.tap` file in write-binary mode (Sakthipriyan Vairamani) [#2837](https://github.com/nodejs/node/pull/2837) * [[`ff6d30d784`](https://github.com/nodejs/node/commit/ff6d30d784)] - **tools**: add missing tick processor polyfill (Matt Loring) [#2694](https://github.com/nodejs/node/pull/2694) * [[`519caba021`](https://github.com/nodejs/node/commit/519caba021)] - **tools**: fix flakiness in test-tick-processor (Matt Loring) [#2694](https://github.com/nodejs/node/pull/2694) * [[`ac004b8555`](https://github.com/nodejs/node/commit/ac004b8555)] - **tools**: remove hyphen in TAP result (Sakthipriyan Vairamani) [#2718](https://github.com/nodejs/node/pull/2718) * [[`ba47511976`](https://github.com/nodejs/node/commit/ba47511976)] - **tsc**: adjust TSC membership for IBM+StrongLoop (James M Snell) [#2858](https://github.com/nodejs/node/pull/2858) * [[`e035266805`](https://github.com/nodejs/node/commit/e035266805)] - **win,msi**: fix documentation shortcut url (Brian White) [#2781](https://github.com/nodejs/node/pull/2781) ## 2015-09-08, Version 4.0.0 (Stable), @rvagg ### Notable changes This list of changes is relative to the last io.js v3.x branch release, v3.3.0. Please see the list of notable changes in the v3.x, v2.x and v1.x releases for a more complete list of changes from 0.12.x. Note, that some changes in the v3.x series as well as major breaking changes in this release constitute changes required for full convergence of the Node.js and io.js projects. * **child_process**: `ChildProcess.prototype.send()` and `process.send()` operate asynchronously across all platforms so an optional callback parameter has been introduced that will be invoked once the message has been sent, i.e. `.send(message[, sendHandle][, callback])` (Ben Noordhuis) [#2620](https://github.com/nodejs/node/pull/2620). * **node**: Rename "io.js" code to "Node.js" (cjihrig) [#2367](https://github.com/nodejs/node/pull/2367). * **node-gyp**: This release bundles an updated version of node-gyp that works with all versions of Node.js and io.js including nightly and release candidate builds. From io.js v3 and Node.js v4 onward, it will only download a headers tarball when building addons rather than the entire source. (Rod Vagg) [#2700](https://github.com/nodejs/node/pull/2700) * **npm**: Upgrade to version 2.14.2 from 2.13.3, includes a security update, see https://github.com/npm/npm/releases/tag/v2.14.2 for more details, (Kat Marchán) [#2696](https://github.com/nodejs/node/pull/2696). * **timers**: Improved timer performance from porting the 0.12 implementation, plus minor fixes (Jeremiah Senkpiel) [#2540](https://github.com/nodejs/node/pull/2540), (Julien Gilli) [nodejs/node-v0.x-archive#8751](https://github.com/nodejs/node-v0.x-archive/pull/8751) [nodejs/node-v0.x-archive#8905](https://github.com/nodejs/node-v0.x-archive/pull/8905) * **util**: The `util.is*()` functions have been deprecated, beginning with deprecation warnings in the documentation for this release, users are encouraged to seek more robust alternatives in the npm registry, (Sakthipriyan Vairamani) [#2447](https://github.com/nodejs/node/pull/2447). * **v8**: Upgrade to version 4.5.103.30 from 4.4.63.30 (Ali Ijaz Sheikh) [#2632](https://github.com/nodejs/node/pull/2632). - Implement new `TypedArray` prototype methods: `copyWithin()`, `every()`, `fill()`, `filter()`, `find()`, `findIndex()`, `forEach()`, `indexOf()`, `join()`, `lastIndexOf()`, `map()`, `reduce()`, `reduceRight()`, `reverse()`, `slice()`, `some()`, `sort()`. See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray for further information. - Implement new `TypedArray.from()` and `TypedArray.of()` functions. See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray for further information. - Implement arrow functions, see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Functions/Arrow_functions for further information. - Full ChangeLog available at https://github.com/v8/v8-git-mirror/blob/4.5.103/ChangeLog ### Known issues See https://github.com/nodejs/node/labels/confirmed-bug for complete and current list of known issues. * Some uses of computed object shorthand properties are not handled correctly by the current version of V8. e.g. `[{ [prop]: val }]` evaluates to `[{}]`. [#2507](https://github.com/nodejs/node/issues/2507) * Some problems with unreferenced timers running during `beforeExit` are still to be resolved. See [#1264](https://github.com/nodejs/node/issues/1264). * Surrogate pair in REPL can freeze terminal. [#690](https://github.com/nodejs/node/issues/690) * Calling `dns.setServers()` while a DNS query is in progress can cause the process to crash on a failed assertion. [#894](https://github.com/nodejs/node/issues/894) * `url.resolve` may transfer the auth portion of the url when resolving between two full hosts, see [#1435](https://github.com/nodejs/node/issues/1435). ### Commits * [[`4f50d3fb90`](https://github.com/nodejs/node/commit/4f50d3fb90)] - **(SEMVER-MAJOR)** This commit sets the value of process.release.name to "node". (cjihrig) [#2367](https://github.com/nodejs/node/pull/2367) * [[`d3178d8b1b`](https://github.com/nodejs/node/commit/d3178d8b1b)] - **buffer**: SlowBuffer only accept valid numeric values (Michaël Zasso) [#2635](https://github.com/nodejs/node/pull/2635) * [[`0cb0f4a6e4`](https://github.com/nodejs/node/commit/0cb0f4a6e4)] - **build**: fix v8_enable_handle_zapping override (Karl Skomski) [#2731](https://github.com/nodejs/node/pull/2731) * [[`a7596d7efc`](https://github.com/nodejs/node/commit/a7596d7efc)] - **build**: remote commands on staging in single session (Rod Vagg) [#2717](https://github.com/nodejs/node/pull/2717) * [[`be427e9efa`](https://github.com/nodejs/node/commit/be427e9efa)] - **build**: make .msi install to "nodejs", not "node" (Rod Vagg) [#2701](https://github.com/nodejs/node/pull/2701) * [[`5652ce0dbc`](https://github.com/nodejs/node/commit/5652ce0dbc)] - **build**: fix .pkg creation tooling (Rod Vagg) [#2687](https://github.com/nodejs/node/pull/2687) * [[`101db80111`](https://github.com/nodejs/node/commit/101db80111)] - **build**: add --enable-asan with builtin leakcheck (Karl Skomski) [#2376](https://github.com/nodejs/node/pull/2376) * [[`2c3939c9c0`](https://github.com/nodejs/node/commit/2c3939c9c0)] - **child_process**: use stdio.fd even if it is 0 (Evan Lucas) [#2727](https://github.com/nodejs/node/pull/2727) * [[`609db5a1dd`](https://github.com/nodejs/node/commit/609db5a1dd)] - **child_process**: check execFile and fork args (James M Snell) [#2667](https://github.com/nodejs/node/pull/2667) * [[`d010568c23`](https://github.com/nodejs/node/commit/d010568c23)] - **(SEMVER-MAJOR)** **child_process**: add callback parameter to .send() (Ben Noordhuis) [#2620](https://github.com/nodejs/node/pull/2620) * [[`c60857a81a`](https://github.com/nodejs/node/commit/c60857a81a)] - **cluster**: allow shared reused dgram sockets (Fedor Indutny) [#2548](https://github.com/nodejs/node/pull/2548) * [[`b2ecbb6191`](https://github.com/nodejs/node/commit/b2ecbb6191)] - **contextify**: ignore getters during initialization (Fedor Indutny) [#2091](https://github.com/nodejs/node/pull/2091) * [[`3711934095`](https://github.com/nodejs/node/commit/3711934095)] - **cpplint**: make it possible to run outside git repo (Ben Noordhuis) [#2710](https://github.com/nodejs/node/pull/2710) * [[`03f900ab25`](https://github.com/nodejs/node/commit/03f900ab25)] - **crypto**: replace rwlocks with simple mutexes (Ben Noordhuis) [#2723](https://github.com/nodejs/node/pull/2723) * [[`847459c29b`](https://github.com/nodejs/node/commit/847459c29b)] - **(SEMVER-MAJOR)** **crypto**: show exponent in decimal and hex (Chad Johnston) [#2320](https://github.com/nodejs/node/pull/2320) * [[`e1c976184d`](https://github.com/nodejs/node/commit/e1c976184d)] - **deps**: improve ArrayBuffer performance in v8 (Fedor Indutny) [#2732](https://github.com/nodejs/node/pull/2732) * [[`cc0ab17a23`](https://github.com/nodejs/node/commit/cc0ab17a23)] - **deps**: float node-gyp v3.0.0 (Rod Vagg) [#2700](https://github.com/nodejs/node/pull/2700) * [[`b2c3c6d727`](https://github.com/nodejs/node/commit/b2c3c6d727)] - **deps**: create .npmrc during npm tests (Kat Marchán) [#2696](https://github.com/nodejs/node/pull/2696) * [[`babdbfdbd5`](https://github.com/nodejs/node/commit/babdbfdbd5)] - **deps**: upgrade to npm 2.14.2 (Kat Marchán) [#2696](https://github.com/nodejs/node/pull/2696) * [[`155783d876`](https://github.com/nodejs/node/commit/155783d876)] - **deps**: backport 75e43a6 from v8 upstream (again) (saper) [#2692](https://github.com/nodejs/node/pull/2692) * [[`5424d6fcf0`](https://github.com/nodejs/node/commit/5424d6fcf0)] - **deps**: upgrade V8 to 4.5.103.30 (Ali Ijaz Sheikh) [#2632](https://github.com/nodejs/node/pull/2632) * [[`c43172578e`](https://github.com/nodejs/node/commit/c43172578e)] - **(SEMVER-MAJOR)** **deps**: upgrade V8 to 4.5.103.24 (Ali Ijaz Sheikh) [#2509](https://github.com/nodejs/node/pull/2509) * [[`714e96e8b9`](https://github.com/nodejs/node/commit/714e96e8b9)] - **deps**: backport 75e43a6 from v8 upstream (saper) [#2636](https://github.com/nodejs/node/pull/2636) * [[`8637755cbf`](https://github.com/nodejs/node/commit/8637755cbf)] - **doc**: add TSC meeting minutes 2015-09-02 (Rod Vagg) [#2674](https://github.com/nodejs/node/pull/2674) * [[`d3d5b93214`](https://github.com/nodejs/node/commit/d3d5b93214)] - **doc**: update environment vars in manpage and --help (Roman Reiss) [#2690](https://github.com/nodejs/node/pull/2690) * [[`29f586ac0a`](https://github.com/nodejs/node/commit/29f586ac0a)] - **doc**: update url doc to account for escaping (Jeremiah Senkpiel) [#2605](https://github.com/nodejs/node/pull/2605) * [[`ba50cfebef`](https://github.com/nodejs/node/commit/ba50cfebef)] - **doc**: reorder collaborators by their usernames (Johan Bergström) [#2322](https://github.com/nodejs/node/pull/2322) * [[`8a9a3bf798`](https://github.com/nodejs/node/commit/8a9a3bf798)] - **doc**: update changelog for io.js v3.3.0 (Rod Vagg) [#2653](https://github.com/nodejs/node/pull/2653) * [[`6cd0e2664b`](https://github.com/nodejs/node/commit/6cd0e2664b)] - **doc**: update io.js reference (Ben Noordhuis) [#2580](https://github.com/nodejs/node/pull/2580) * [[`f9539c19e8`](https://github.com/nodejs/node/commit/f9539c19e8)] - **doc**: update changelog for io.js v3.2.0 (Rod Vagg) [#2512](https://github.com/nodejs/node/pull/2512) * [[`cded6e7993`](https://github.com/nodejs/node/commit/cded6e7993)] - **doc**: fix CHANGELOG.md on master (Roman Reiss) [#2513](https://github.com/nodejs/node/pull/2513) * [[`93e2830686`](https://github.com/nodejs/node/commit/93e2830686)] - **(SEMVER-MINOR)** **doc**: document deprecation of util.is* functions (Sakthipriyan Vairamani) [#2447](https://github.com/nodejs/node/pull/2447) * [[`7038388558`](https://github.com/nodejs/node/commit/7038388558)] - **doc,test**: enable recursive file watching in Windows (Sakthipriyan Vairamani) [#2649](https://github.com/nodejs/node/pull/2649) * [[`f3696f64a1`](https://github.com/nodejs/node/commit/f3696f64a1)] - **events,lib**: don't require EE#listenerCount() (Jeremiah Senkpiel) [#2661](https://github.com/nodejs/node/pull/2661) * [[`45a2046f5d`](https://github.com/nodejs/node/commit/45a2046f5d)] - **(SEMVER-MAJOR)** **installer**: fix installers for node.js rename (Frederic Hemberger) [#2367](https://github.com/nodejs/node/pull/2367) * [[`7a999a1376`](https://github.com/nodejs/node/commit/7a999a1376)] - **(SEMVER-MAJOR)** **lib**: add net.Socket#localFamily property (Ben Noordhuis) [#956](https://github.com/nodejs/node/pull/956) * [[`de88255b0f`](https://github.com/nodejs/node/commit/de88255b0f)] - ***Revert*** "**lib,src**: add unix socket getsockname/getpeername" (Ben Noordhuis) [#2584](https://github.com/nodejs/node/pull/2584) * [[`f337595441`](https://github.com/nodejs/node/commit/f337595441)] - **(SEMVER-MAJOR)** **lib,src**: add unix socket getsockname/getpeername (Ben Noordhuis) [#956](https://github.com/nodejs/node/pull/956) * [[`3b602527d1`](https://github.com/nodejs/node/commit/3b602527d1)] - **(SEMVER-MAJOR)** **node**: additional cleanup for node rename (cjihrig) [#2367](https://github.com/nodejs/node/pull/2367) * [[`a69ab27ab4`](https://github.com/nodejs/node/commit/a69ab27ab4)] - **(SEMVER-MAJOR)** **node**: rename from io.js to node (cjihrig) [#2367](https://github.com/nodejs/node/pull/2367) * [[`9358eee9dd`](https://github.com/nodejs/node/commit/9358eee9dd)] - **node-gyp**: float 3.0.1, minor fix for download url (Rod Vagg) [#2737](https://github.com/nodejs/node/pull/2737) * [[`d2d981252b`](https://github.com/nodejs/node/commit/d2d981252b)] - **src**: s/ia32/x86 for process.release.libUrl for win (Rod Vagg) [#2699](https://github.com/nodejs/node/pull/2699) * [[`eba3d3dccd`](https://github.com/nodejs/node/commit/eba3d3dccd)] - **src**: use standard conform snprintf on windows (Karl Skomski) [#2404](https://github.com/nodejs/node/pull/2404) * [[`cddbec231f`](https://github.com/nodejs/node/commit/cddbec231f)] - **src**: fix buffer overflow for long exception lines (Karl Skomski) [#2404](https://github.com/nodejs/node/pull/2404) * [[`dd3f3417c7`](https://github.com/nodejs/node/commit/dd3f3417c7)] - **src**: re-enable fast math on arm (Michaël Zasso) [#2592](https://github.com/nodejs/node/pull/2592) * [[`e137c1177c`](https://github.com/nodejs/node/commit/e137c1177c)] - **(SEMVER-MAJOR)** **src**: enable vector ics on arm again (Ali Ijaz Sheikh) [#2509](https://github.com/nodejs/node/pull/2509) * [[`7ce749d722`](https://github.com/nodejs/node/commit/7ce749d722)] - **src**: replace usage of v8::Handle with v8::Local (Michaël Zasso) [#2202](https://github.com/nodejs/node/pull/2202) * [[`b1a2d9509f`](https://github.com/nodejs/node/commit/b1a2d9509f)] - **src**: enable v8 deprecation warnings and fix them (Ben Noordhuis) [#2091](https://github.com/nodejs/node/pull/2091) * [[`808de0da03`](https://github.com/nodejs/node/commit/808de0da03)] - **(SEMVER-MAJOR)** **src**: apply debug force load fixups from 41e63fb (Ali Ijaz Sheikh) [#2509](https://github.com/nodejs/node/pull/2509) * [[`5201cb0ff1`](https://github.com/nodejs/node/commit/5201cb0ff1)] - **src**: fix memory leak in ExternString (Karl Skomski) [#2402](https://github.com/nodejs/node/pull/2402) * [[`2308a27c0a`](https://github.com/nodejs/node/commit/2308a27c0a)] - **src**: only set v8 flags if argc > 1 (Evan Lucas) [#2646](https://github.com/nodejs/node/pull/2646) * [[`384effed20`](https://github.com/nodejs/node/commit/384effed20)] - **test**: fix use of `common` before required (Rod Vagg) [#2685](https://github.com/nodejs/node/pull/2685) * [[`f146f686b7`](https://github.com/nodejs/node/commit/f146f686b7)] - **(SEMVER-MAJOR)** **test**: fix test-repl-tab-complete.js for V8 4.5 (Ali Ijaz Sheikh) [#2509](https://github.com/nodejs/node/pull/2509) * [[`fe4b309fd3`](https://github.com/nodejs/node/commit/fe4b309fd3)] - **test**: refactor to eliminate flaky test (Rich Trott) [#2609](https://github.com/nodejs/node/pull/2609) * [[`619721e6b8`](https://github.com/nodejs/node/commit/619721e6b8)] - **test**: mark eval_messages as flaky (Alexis Campailla) [#2648](https://github.com/nodejs/node/pull/2648) * [[`93ba585b66`](https://github.com/nodejs/node/commit/93ba585b66)] - **test**: mark test-vm-syntax-error-stderr as flaky (João Reis) [#2662](https://github.com/nodejs/node/pull/2662) * [[`367140bca0`](https://github.com/nodejs/node/commit/367140bca0)] - **test**: mark test-repl-persistent-history as flaky (João Reis) [#2659](https://github.com/nodejs/node/pull/2659) * [[`f6b093343d`](https://github.com/nodejs/node/commit/f6b093343d)] - **timers**: minor `_unrefActive` fixes and improvements (Jeremiah Senkpiel) [#2540](https://github.com/nodejs/node/pull/2540) * [[`403d7ee7d1`](https://github.com/nodejs/node/commit/403d7ee7d1)] - **timers**: don't mutate unref list while iterating it (Julien Gilli) [#2540](https://github.com/nodejs/node/pull/2540) * [[`7a8c3e08c3`](https://github.com/nodejs/node/commit/7a8c3e08c3)] - **timers**: Avoid linear scan in `_unrefActive`. (Julien Gilli) [#2540](https://github.com/nodejs/node/pull/2540) * [[`b630ebaf43`](https://github.com/nodejs/node/commit/b630ebaf43)] - **win,msi**: Upgrade from old upgrade code (João Reis) [#2439](https://github.com/nodejs/node/pull/2439) ## 2015-09-02, Version 3.3.0, @rvagg ### Notable changes * **build**: Add a `--link-module` option to `configure` that can be used to bundle additional JavaScript modules into a built binary (Bradley Meck) [#2497](https://github.com/nodejs/node/pull/2497) * **docs**: Merge outstanding doc updates from joyent/node (James M Snell) [#2378](https://github.com/nodejs/node/pull/2378) * **http_parser**: Significant performance improvement by having `http.Server` consume all initial data from its `net.Socket` and parsing directly without having to enter JavaScript. Any `'data'` listeners on the `net.Socket` will result in the data being "unconsumed" into JavaScript, thereby undoing any performance gains. (Fedor Indutny) [#2355](https://github.com/nodejs/node/pull/2355) * **libuv**: Upgrade to 1.7.3 (from 1.6.1), see [ChangeLog](https://github.com/libuv/libuv/blob/v1.x/ChangeLog) for details (Saúl Ibarra Corretgé) [#2310](https://github.com/nodejs/node/pull/2310) * **V8**: Upgrade to 4.4.63.30 (from 4.4.63.26) (Michaël Zasso) [#2482](https://github.com/nodejs/node/pull/2482) ### Known issues See https://github.com/nodejs/io.js/labels/confirmed-bug for complete and current list of known issues. * Some uses of computed object shorthand properties are not handled correctly by the current version of V8. e.g. `[{ [prop]: val }]` evaluates to `[{}]`. [#2507](https://github.com/nodejs/node/issues/2507) * Some problems with unreferenced timers running during `beforeExit` are still to be resolved. See [#1264](https://github.com/nodejs/io.js/issues/1264). * Surrogate pair in REPL can freeze terminal. [#690](https://github.com/nodejs/io.js/issues/690) * `process.send()` is not synchronous as the docs suggest, a regression introduced in 1.0.2, see [#760](https://github.com/nodejs/io.js/issues/760). * Calling `dns.setServers()` while a DNS query is in progress can cause the process to crash on a failed assertion. [#894](https://github.com/nodejs/io.js/issues/894) * `url.resolve` may transfer the auth portion of the url when resolving between two full hosts, see [#1435](https://github.com/nodejs/io.js/issues/1435). ### Commits * [[`1a531b4e44`](https://github.com/nodejs/node/commit/1a531b4e44)] - **(SEMVER-MINOR)** Introduce --link-module to ./configure (Bradley Meck) [#2497](https://github.com/nodejs/node/pull/2497) * [[`d2f314c190`](https://github.com/nodejs/node/commit/d2f314c190)] - **build**: fix borked chmod call for release uploads (Rod Vagg) [#2645](https://github.com/nodejs/node/pull/2645) * [[`3172e9c541`](https://github.com/nodejs/node/commit/3172e9c541)] - **build**: set file permissions before uploading (Rod Vagg) [#2623](https://github.com/nodejs/node/pull/2623) * [[`a860d7fae1`](https://github.com/nodejs/node/commit/a860d7fae1)] - **build**: change staging directory on new server (Rod Vagg) [#2623](https://github.com/nodejs/node/pull/2623) * [[`50c0baa8d7`](https://github.com/nodejs/node/commit/50c0baa8d7)] - **build**: rename 'doc' directory to 'docs' for upload (Rod Vagg) [#2623](https://github.com/nodejs/node/pull/2623) * [[`0a0577cf5f`](https://github.com/nodejs/node/commit/0a0577cf5f)] - **build**: fix bad cherry-pick for vcbuild.bat build-release (Rod Vagg) [#2625](https://github.com/nodejs/node/pull/2625) * [[`34de90194b`](https://github.com/nodejs/node/commit/34de90194b)] - **build**: only define NODE_V8_OPTIONS if not empty (Evan Lucas) [#2532](https://github.com/nodejs/node/pull/2532) * [[`944174b189`](https://github.com/nodejs/node/commit/944174b189)] - **build**: make ci test addons in test/addons (Ben Noordhuis) [#2428](https://github.com/nodejs/node/pull/2428) * [[`e955f9a1b0`](https://github.com/nodejs/node/commit/e955f9a1b0)] - **crypto**: Use OPENSSL_cleanse to shred the data. (Сковорода Никита Андреевич) [#2575](https://github.com/nodejs/node/pull/2575) * [[`395d736b9d`](https://github.com/nodejs/node/commit/395d736b9d)] - **debugger**: use strict equality comparison (Minwoo Jung) [#2558](https://github.com/nodejs/node/pull/2558) * [[`1d0e5210a8`](https://github.com/nodejs/node/commit/1d0e5210a8)] - **deps**: upgrade libuv to 1.7.3 (Saúl Ibarra Corretgé) [#2310](https://github.com/nodejs/node/pull/2310) * [[`34ef53364f`](https://github.com/nodejs/node/commit/34ef53364f)] - **deps**: update V8 to 4.4.63.30 (Michaël Zasso) [#2482](https://github.com/nodejs/node/pull/2482) * [[`23579a5f4a`](https://github.com/nodejs/node/commit/23579a5f4a)] - **doc**: add TSC meeting minutes 2015-08-12 (Rod Vagg) [#2438](https://github.com/nodejs/node/pull/2438) * [[`0cc59299a4`](https://github.com/nodejs/node/commit/0cc59299a4)] - **doc**: add TSC meeting minutes 2015-08-26 (Rod Vagg) [#2591](https://github.com/nodejs/node/pull/2591) * [[`6efa96e33a`](https://github.com/nodejs/node/commit/6efa96e33a)] - **doc**: merge CHANGELOG.md with joyent/node ChangeLog (P.S.V.R) [#2536](https://github.com/nodejs/node/pull/2536) * [[`f75d54607b`](https://github.com/nodejs/node/commit/f75d54607b)] - **doc**: clarify cluster behaviour with no workers (Jeremiah Senkpiel) [#2606](https://github.com/nodejs/node/pull/2606) * [[`8936302121`](https://github.com/nodejs/node/commit/8936302121)] - **doc**: minor clarification in buffer.markdown (Сковорода Никита Андреевич) [#2574](https://github.com/nodejs/node/pull/2574) * [[`0db0e53753`](https://github.com/nodejs/node/commit/0db0e53753)] - **doc**: add @jasnell and @sam-github to release team (Rod Vagg) [#2455](https://github.com/nodejs/node/pull/2455) * [[`c16e100593`](https://github.com/nodejs/node/commit/c16e100593)] - **doc**: reorg release team to separate section (Rod Vagg) [#2455](https://github.com/nodejs/node/pull/2455) * [[`e3e00143fd`](https://github.com/nodejs/node/commit/e3e00143fd)] - **doc**: fix bad merge on modules.markdown (James M Snell) * [[`2f62455880`](https://github.com/nodejs/node/commit/2f62455880)] - **doc**: minor additional corrections and improvements (James M Snell) [#2378](https://github.com/nodejs/node/pull/2378) * [[`3bd08aac4b`](https://github.com/nodejs/node/commit/3bd08aac4b)] - **doc**: minor grammatical update in crypto.markdown (James M Snell) [#2378](https://github.com/nodejs/node/pull/2378) * [[`f707189370`](https://github.com/nodejs/node/commit/f707189370)] - **doc**: minor grammatical update (James M Snell) [#2378](https://github.com/nodejs/node/pull/2378) * [[`6c98cf0266`](https://github.com/nodejs/node/commit/6c98cf0266)] - **doc**: remove repeated statement in globals.markdown (James M Snell) [#2378](https://github.com/nodejs/node/pull/2378) * [[`48e6ccf8c2`](https://github.com/nodejs/node/commit/48e6ccf8c2)] - **doc**: remove 'dudes' from documentation (James M Snell) [#2378](https://github.com/nodejs/node/pull/2378) * [[`b5d68f8076`](https://github.com/nodejs/node/commit/b5d68f8076)] - **doc**: update tense in child_process.markdown (James M Snell) [#2378](https://github.com/nodejs/node/pull/2378) * [[`242e3fe3ba`](https://github.com/nodejs/node/commit/242e3fe3ba)] - **doc**: fixed worker.id type (James M Snell) [#2378](https://github.com/nodejs/node/pull/2378) * [[`ea9ee15c21`](https://github.com/nodejs/node/commit/ea9ee15c21)] - **doc**: port is optional for socket.bind() (James M Snell) [#2378](https://github.com/nodejs/node/pull/2378) * [[`0ff6657a50`](https://github.com/nodejs/node/commit/0ff6657a50)] - **doc**: fix minor types and grammar in fs docs (James M Snell) [#2378](https://github.com/nodejs/node/pull/2378) * [[`94d83c04f2`](https://github.com/nodejs/node/commit/94d83c04f2)] - **doc**: update parameter name in net.markdown (James M Snell) [#2378](https://github.com/nodejs/node/pull/2378) * [[`04111ce40f`](https://github.com/nodejs/node/commit/04111ce40f)] - **doc**: small typo in domain.markdown (James M Snell) [#2378](https://github.com/nodejs/node/pull/2378) * [[`c9fdd1bbbf`](https://github.com/nodejs/node/commit/c9fdd1bbbf)] - **doc**: fixed typo in net.markdown (missing comma) (James M Snell) [#2378](https://github.com/nodejs/node/pull/2378) * [[`27c07b3f8e`](https://github.com/nodejs/node/commit/27c07b3f8e)] - **doc**: update description of fs.exists in fs.markdown (James M Snell) [#2378](https://github.com/nodejs/node/pull/2378) * [[`52018e73d9`](https://github.com/nodejs/node/commit/52018e73d9)] - **doc**: clarification on the 'close' event (James M Snell) [#2378](https://github.com/nodejs/node/pull/2378) * [[`f6d3b87a25`](https://github.com/nodejs/node/commit/f6d3b87a25)] - **doc**: improve working in stream.markdown (James M Snell) [#2378](https://github.com/nodejs/node/pull/2378) * [[`b5da89431a`](https://github.com/nodejs/node/commit/b5da89431a)] - **doc**: update path.extname documentation (James M Snell) [#2378](https://github.com/nodejs/node/pull/2378) * [[`1d4ea609db`](https://github.com/nodejs/node/commit/1d4ea609db)] - **doc**: small clarifications to modules.markdown (James M Snell) [#2378](https://github.com/nodejs/node/pull/2378) * [[`c888985591`](https://github.com/nodejs/node/commit/c888985591)] - **doc**: code style cleanups in repl.markdown (James M Snell) [#2378](https://github.com/nodejs/node/pull/2378) * [[`105b493595`](https://github.com/nodejs/node/commit/105b493595)] - **doc**: correct grammar in cluster.markdown (James M Snell) [#2378](https://github.com/nodejs/node/pull/2378) * [[`51b86ccac7`](https://github.com/nodejs/node/commit/51b86ccac7)] - **doc**: Clarify the module.parent is set once (James M Snell) [#2378](https://github.com/nodejs/node/pull/2378) * [[`d2ffecba2d`](https://github.com/nodejs/node/commit/d2ffecba2d)] - **doc**: add internal modules notice (Jeremiah Senkpiel) [#2523](https://github.com/nodejs/node/pull/2523) * [[`b36debd5cb`](https://github.com/nodejs/node/commit/b36debd5cb)] - **env**: introduce `KickNextTick` (Fedor Indutny) [#2355](https://github.com/nodejs/node/pull/2355) * [[`1bc446863f`](https://github.com/nodejs/node/commit/1bc446863f)] - **http_parser**: consume StreamBase instance (Fedor Indutny) [#2355](https://github.com/nodejs/node/pull/2355) * [[`ce04b735cc`](https://github.com/nodejs/node/commit/ce04b735cc)] - **src**: only memcmp if length > 0 in Buffer::Compare (Karl Skomski) [#2544](https://github.com/nodejs/node/pull/2544) * [[`31823e37c7`](https://github.com/nodejs/node/commit/31823e37c7)] - **src**: DRY getsockname/getpeername code (Ben Noordhuis) [#956](https://github.com/nodejs/node/pull/956) * [[`13fd96dda3`](https://github.com/nodejs/node/commit/13fd96dda3)] - **src**: missing Exception::Error in node_http_parser (Jeremiah Senkpiel) [#2550](https://github.com/nodejs/node/pull/2550) * [[`42e075ae02`](https://github.com/nodejs/node/commit/42e075ae02)] - **test**: improve performance of stringbytes test (Trevor Norris) [#2544](https://github.com/nodejs/node/pull/2544) * [[`fc726399fd`](https://github.com/nodejs/node/commit/fc726399fd)] - **test**: unmark test-process-argv-0.js as flaky (Rich Trott) [#2613](https://github.com/nodejs/node/pull/2613) * [[`7727ba1394`](https://github.com/nodejs/node/commit/7727ba1394)] - **test**: lint and refactor to avoid autocrlf issue (Roman Reiss) [#2494](https://github.com/nodejs/node/pull/2494) * [[`c56aa829f0`](https://github.com/nodejs/node/commit/c56aa829f0)] - **test**: use tmpDir instead of fixturesDir (Sakthipriyan Vairamani) [#2583](https://github.com/nodejs/node/pull/2583) * [[`5e65181ea4`](https://github.com/nodejs/node/commit/5e65181ea4)] - **test**: handling failure cases properly (Sakthipriyan Vairamani) [#2206](https://github.com/nodejs/node/pull/2206) * [[`c48b95e847`](https://github.com/nodejs/node/commit/c48b95e847)] - **test**: initial list of flaky tests (Alexis Campailla) [#2424](https://github.com/nodejs/node/pull/2424) * [[`94e88498ba`](https://github.com/nodejs/node/commit/94e88498ba)] - **test**: pass args to test-ci via env variable (Alexis Campailla) [#2424](https://github.com/nodejs/node/pull/2424) * [[`09987c7a1c`](https://github.com/nodejs/node/commit/09987c7a1c)] - **test**: support flaky tests in test-ci (Alexis Campailla) [#2424](https://github.com/nodejs/node/pull/2424) * [[`08b83c8b45`](https://github.com/nodejs/node/commit/08b83c8b45)] - **test**: add test configuration templates (Alexis Campailla) [#2424](https://github.com/nodejs/node/pull/2424) * [[`8f8ab6fa57`](https://github.com/nodejs/node/commit/8f8ab6fa57)] - **test**: runner should return 0 on flaky tests (Alexis Campailla) [#2424](https://github.com/nodejs/node/pull/2424) * [[`0cfd3be9c6`](https://github.com/nodejs/node/commit/0cfd3be9c6)] - **test**: runner support for flaky tests (Alexis Campailla) [#2424](https://github.com/nodejs/node/pull/2424) * [[`3492d2d4c6`](https://github.com/nodejs/node/commit/3492d2d4c6)] - **test**: make test-process-argv-0 robust (Rich Trott) [#2541](https://github.com/nodejs/node/pull/2541) * [[`a96cc31710`](https://github.com/nodejs/node/commit/a96cc31710)] - **test**: speed up test-child-process-spawnsync.js (Rich Trott) [#2542](https://github.com/nodejs/node/pull/2542) * [[`856baf4c67`](https://github.com/nodejs/node/commit/856baf4c67)] - **test**: make spawnSync() test robust (Rich Trott) [#2535](https://github.com/nodejs/node/pull/2535) * [[`3aa6bbb648`](https://github.com/nodejs/node/commit/3aa6bbb648)] - **tools**: update release.sh to work with new website (Rod Vagg) [#2623](https://github.com/nodejs/node/pull/2623) * [[`f2f0fe45ff`](https://github.com/nodejs/node/commit/f2f0fe45ff)] - **tools**: make add-on scraper print filenames (Ben Noordhuis) [#2428](https://github.com/nodejs/node/pull/2428) * [[`bb24c4a418`](https://github.com/nodejs/node/commit/bb24c4a418)] - **win,msi**: correct installation path registry keys (João Reis) [#2565](https://github.com/nodejs/node/pull/2565) * [[`752977b888`](https://github.com/nodejs/node/commit/752977b888)] - **win,msi**: change InstallScope to perMachine (João Reis) [#2565](https://github.com/nodejs/node/pull/2565) ## 2015-08-25, Version 3.2.0, @rvagg ### Notable changes * **events**: Added `EventEmitter#listenerCount(event)` as a replacement for `EventEmitter.listenerCount(emitter, event)`, which has now been marked as deprecated in the docs. (Sakthipriyan Vairamani) [#2349](https://github.com/nodejs/node/pull/2349) * **module**: Fixed an error with preloaded modules when the current working directory doesn't exist. (Bradley Meck) [#2353](https://github.com/nodejs/node/pull/2353) * **node**: Startup time is now about 5% faster when not passing V8 flags. (Evan Lucas) [#2483](https://github.com/nodejs/node/pull/2483) * **repl**: Tab-completion now works better with arrays. (James M Snell) [#2409](https://github.com/nodejs/node/pull/2409) * **string_bytes**: Fixed an unaligned write in the handling of UCS2 encoding. (Fedor Indutny) [#2480](https://github.com/nodejs/node/pull/2480) * **tls**: Added a new `--tls-cipher-list` flag that can be used to override the built-in default cipher list. (James M Snell) [#2412](https://github.com/nodejs/node/pull/2412) _Note: it is suggested you use the built-in cipher list as it has been carefully selected to reflect current security best practices and risk mitigation._ ### Known issues See https://github.com/nodejs/io.js/labels/confirmed-bug for complete and current list of known issues. * Some uses of computed object shorthand properties are not handled correctly by the current version of V8. e.g. `[{ [prop]: val }]` evaluates to `[{}]`. [#2507](https://github.com/nodejs/node/issues/2507) * Some problems with unreferenced timers running during `beforeExit` are still to be resolved. See [#1264](https://github.com/nodejs/io.js/issues/1264). * Surrogate pair in REPL can freeze terminal. [#690](https://github.com/nodejs/io.js/issues/690) * `process.send()` is not synchronous as the docs suggest, a regression introduced in 1.0.2, see [#760](https://github.com/nodejs/io.js/issues/760). * Calling `dns.setServers()` while a DNS query is in progress can cause the process to crash on a failed assertion. [#894](https://github.com/nodejs/io.js/issues/894) * `url.resolve` may transfer the auth portion of the url when resolving between two full hosts, see [#1435](https://github.com/nodejs/io.js/issues/1435). ### Commits * [[`1cd794f129`](https://github.com/nodejs/node/commit/1cd794f129)] - **buffer**: reapply 07c0667 (Fedor Indutny) [#2487](https://github.com/nodejs/node/pull/2487) * [[`156781dedd`](https://github.com/nodejs/node/commit/156781dedd)] - **build**: use required platform in android-configure (Evan Lucas) [#2501](https://github.com/nodejs/node/pull/2501) * [[`77075ec906`](https://github.com/nodejs/node/commit/77075ec906)] - **crypto**: fix mem {de}allocation in ExportChallenge (Karl Skomski) [#2359](https://github.com/nodejs/node/pull/2359) * [[`cb30414d9e`](https://github.com/nodejs/node/commit/cb30414d9e)] - **doc**: sync CHANGELOG.md from master (Roman Reiss) [#2524](https://github.com/nodejs/node/pull/2524) * [[`9330f5ef45`](https://github.com/nodejs/node/commit/9330f5ef45)] - **doc**: make the deprecations consistent (Sakthipriyan Vairamani) [#2450](https://github.com/nodejs/node/pull/2450) * [[`09437e0146`](https://github.com/nodejs/node/commit/09437e0146)] - **doc**: fix comments in tls_wrap.cc and _http_client.js (Minwoo Jung) [#2489](https://github.com/nodejs/node/pull/2489) * [[`c9867fed29`](https://github.com/nodejs/node/commit/c9867fed29)] - **doc**: document response.finished in http.markdown (hackerjs) [#2414](https://github.com/nodejs/node/pull/2414) * [[`7f23a83c42`](https://github.com/nodejs/node/commit/7f23a83c42)] - **doc**: update AUTHORS list (Rod Vagg) [#2505](https://github.com/nodejs/node/pull/2505) * [[`cd0c362f67`](https://github.com/nodejs/node/commit/cd0c362f67)] - **doc**: update AUTHORS list (Rod Vagg) [#2318](https://github.com/nodejs/node/pull/2318) * [[`2c7b9257ea`](https://github.com/nodejs/node/commit/2c7b9257ea)] - **doc**: add TSC meeting minutes 2015-07-29 (Rod Vagg) [#2437](https://github.com/nodejs/node/pull/2437) * [[`aaefde793e`](https://github.com/nodejs/node/commit/aaefde793e)] - **doc**: add TSC meeting minutes 2015-08-19 (Rod Vagg) [#2460](https://github.com/nodejs/node/pull/2460) * [[`51ef9106f5`](https://github.com/nodejs/node/commit/51ef9106f5)] - **doc**: add TSC meeting minutes 2015-06-03 (Rod Vagg) [#2453](https://github.com/nodejs/node/pull/2453) * [[`7130b4cf1d`](https://github.com/nodejs/node/commit/7130b4cf1d)] - **doc**: fix links to original converged repo (Rod Vagg) [#2454](https://github.com/nodejs/node/pull/2454) * [[`14f2aee1df`](https://github.com/nodejs/node/commit/14f2aee1df)] - **doc**: fix links to original gh issues for TSC meetings (Rod Vagg) [#2454](https://github.com/nodejs/node/pull/2454) * [[`87a9ef0a40`](https://github.com/nodejs/node/commit/87a9ef0a40)] - **doc**: add audio recording links to TSC meeting minutes (Rod Vagg) [#2454](https://github.com/nodejs/node/pull/2454) * [[`f5cf24afbc`](https://github.com/nodejs/node/commit/f5cf24afbc)] - **doc**: add TSC meeting minutes 2015-07-22 (Rod Vagg) [#2436](https://github.com/nodejs/node/pull/2436) * [[`3f821b96eb`](https://github.com/nodejs/node/commit/3f821b96eb)] - **doc**: fix spelling mistake in node.js comment (Jacob Edelman) [#2391](https://github.com/nodejs/node/pull/2391) * [[`3e6a6fcdd6`](https://github.com/nodejs/node/commit/3e6a6fcdd6)] - **(SEMVER-MINOR)** **events**: deprecate static listenerCount function (Sakthipriyan Vairamani) [#2349](https://github.com/nodejs/node/pull/2349) * [[`023386c852`](https://github.com/nodejs/node/commit/023386c852)] - **fs**: replace bad_args macro with concrete error msg (Roman Klauke) [#2495](https://github.com/nodejs/node/pull/2495) * [[`d1c27b2e29`](https://github.com/nodejs/node/commit/d1c27b2e29)] - **module**: fix module preloading when cwd is ENOENT (Bradley Meck) [#2353](https://github.com/nodejs/node/pull/2353) * [[`5d7486941b`](https://github.com/nodejs/node/commit/5d7486941b)] - **repl**: filter integer keys from repl tab complete list (James M Snell) [#2409](https://github.com/nodejs/node/pull/2409) * [[`7f02443a9a`](https://github.com/nodejs/node/commit/7f02443a9a)] - **repl**: dont throw ENOENT on NODE_REPL_HISTORY_FILE (Todd Kennedy) [#2451](https://github.com/nodejs/node/pull/2451) * [[`56a2ae9cef`](https://github.com/nodejs/node/commit/56a2ae9cef)] - **src**: improve startup time (Evan Lucas) [#2483](https://github.com/nodejs/node/pull/2483) * [[`14653c7429`](https://github.com/nodejs/node/commit/14653c7429)] - **stream**: rename poorly named function (Ben Noordhuis) [#2479](https://github.com/nodejs/node/pull/2479) * [[`1c6e014bfa`](https://github.com/nodejs/node/commit/1c6e014bfa)] - **stream**: micro-optimize high water mark calculation (Ben Noordhuis) [#2479](https://github.com/nodejs/node/pull/2479) * [[`f1f4b4c46d`](https://github.com/nodejs/node/commit/f1f4b4c46d)] - **stream**: fix off-by-factor-16 error in comment (Ben Noordhuis) [#2479](https://github.com/nodejs/node/pull/2479) * [[`2d3f09bd76`](https://github.com/nodejs/node/commit/2d3f09bd76)] - **stream_base**: various improvements (Fedor Indutny) [#2351](https://github.com/nodejs/node/pull/2351) * [[`c1ce423b35`](https://github.com/nodejs/node/commit/c1ce423b35)] - **string_bytes**: fix unaligned write in UCS2 (Fedor Indutny) [#2480](https://github.com/nodejs/node/pull/2480) * [[`e4d0e86165`](https://github.com/nodejs/node/commit/e4d0e86165)] - **test**: refactor test-https-simple.js (Rich Trott) [#2433](https://github.com/nodejs/node/pull/2433) * [[`0ea5c8d737`](https://github.com/nodejs/node/commit/0ea5c8d737)] - **test**: remove test-timers-first-fire (João Reis) [#2458](https://github.com/nodejs/node/pull/2458) * [[`536c3d0537`](https://github.com/nodejs/node/commit/536c3d0537)] - **test**: use reserved IP in test-net-connect-timeout (Rich Trott) [#2257](https://github.com/nodejs/node/pull/2257) * [[`5df06fd8df`](https://github.com/nodejs/node/commit/5df06fd8df)] - **test**: add spaces after keywords (Brendan Ashworth) * [[`e714b5620e`](https://github.com/nodejs/node/commit/e714b5620e)] - **test**: remove unreachable code (Michaël Zasso) [#2289](https://github.com/nodejs/node/pull/2289) * [[`3579f3a2a4`](https://github.com/nodejs/node/commit/3579f3a2a4)] - **test**: disallow unreachable code (Michaël Zasso) [#2289](https://github.com/nodejs/node/pull/2289) * [[`3545e236fc`](https://github.com/nodejs/node/commit/3545e236fc)] - **test**: reduce timeouts in test-net-keepalive (Brendan Ashworth) [#2429](https://github.com/nodejs/node/pull/2429) * [[`b60e690023`](https://github.com/nodejs/node/commit/b60e690023)] - **test**: improve test-net-server-pause-on-connect (Brendan Ashworth) [#2429](https://github.com/nodejs/node/pull/2429) * [[`11d1b8fcaf`](https://github.com/nodejs/node/commit/11d1b8fcaf)] - **test**: improve test-net-pingpong (Brendan Ashworth) [#2429](https://github.com/nodejs/node/pull/2429) * [[`5fef5c6562`](https://github.com/nodejs/node/commit/5fef5c6562)] - **(SEMVER-MINOR)** **tls**: add --tls-cipher-list command line switch (James M Snell) [#2412](https://github.com/nodejs/node/pull/2412) * [[`d9b70f9cbf`](https://github.com/nodejs/node/commit/d9b70f9cbf)] - **tls**: handle empty cert in checkServerIndentity (Mike Atkins) [#2343](https://github.com/nodejs/node/pull/2343) * [[`4f8e34c202`](https://github.com/nodejs/node/commit/4f8e34c202)] - **tools**: add license boilerplate to check-imports.sh (James M Snell) [#2386](https://github.com/nodejs/node/pull/2386) * [[`b76b9197f9`](https://github.com/nodejs/node/commit/b76b9197f9)] - **tools**: enable space-after-keywords in eslint (Brendan Ashworth) * [[`64a8f30a70`](https://github.com/nodejs/node/commit/64a8f30a70)] - **tools**: fix anchors in generated documents (Sakthipriyan Vairamani) [#2491](https://github.com/nodejs/node/pull/2491) * [[`22e344ea10`](https://github.com/nodejs/node/commit/22e344ea10)] - **win**: fix custom actions for WiX older than 3.9 (João Reis) [#2365](https://github.com/nodejs/node/pull/2365) * [[`b5bd3ebfc8`](https://github.com/nodejs/node/commit/b5bd3ebfc8)] - **win**: fix custom actions on Visual Studio != 2013 (Julien Gilli) [#2365](https://github.com/nodejs/node/pull/2365) ## 2015-08-18, Version 3.1.0, @Fishrock123 ### Notable changes * **buffer**: Fixed a couple large memory leaks (Ben Noordhuis) [#2352](https://github.com/nodejs/node/pull/2352). * **crypto**: - Fixed a couple of minor memory leaks (Karl Skomski) [#2375](https://github.com/nodejs/node/pull/2375). - Signing now checks for OpenSSL errors (P.S.V.R) [#2342](https://github.com/nodejs/node/pull/2342). **Note that this may expose previously hidden errors in user code.** * **intl**: Intl support using small-icu is now enabled by default in builds (Steven R. Loomis) [#2264](https://github.com/nodejs/node/pull/2264). - [`String#normalize()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/normalize) can now be used for unicode normalization. - The [`Intl`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Intl) object and various `String` and `Number` methods are present, but only support the English locale. - For support of all locales, node must be built with [full-icu](https://github.com/nodejs/node#build-with-full-icu-support-all-locales-supported-by-icu). * **tls**: Fixed tls throughput being much lower after an incorrect merge (Fedor Indutny) [#2381](https://github.com/nodejs/node/pull/2381). * **tools**: The v8 tick processor now comes bundled with node (Matt Loring) [#2090](https://github.com/nodejs/node/pull/2090). - This can be used by producing performance profiling output by running node with `--perf`, then running your appropriate platform's script on the output as found in [tools/v8-prof](https://github.com/nodejs/node/tree/master/tools/v8-prof). * **util**: `util.inspect(obj)` now prints the constructor name of the object if there is one (Christopher Monsanto) [#1935](https://github.com/nodejs/io.js/pull/1935). ### Known issues See https://github.com/nodejs/io.js/labels/confirmed-bug for complete and current list of known issues. * Some problems with unreferenced timers running during `beforeExit` are still to be resolved. See [#1264](https://github.com/nodejs/io.js/issues/1264). * Surrogate pair in REPL can freeze terminal. [#690](https://github.com/nodejs/io.js/issues/690) * `process.send()` is not synchronous as the docs suggest, a regression introduced in 1.0.2, see [#760](https://github.com/nodejs/io.js/issues/760). * Calling `dns.setServers()` while a DNS query is in progress can cause the process to crash on a failed assertion. [#894](https://github.com/nodejs/io.js/issues/894) * `url.resolve` may transfer the auth portion of the url when resolving between two full hosts, see [#1435](https://github.com/nodejs/io.js/issues/1435). ### Commits * [[`3645dc62ed`](https://github.com/nodejs/node/commit/3645dc62ed)] - **build**: work around VS2015 issue in ICU <56 (Steven R. Loomis) [#2283](https://github.com/nodejs/node/pull/2283) * [[`1f12e03266`](https://github.com/nodejs/node/commit/1f12e03266)] - **(SEMVER-MINOR)** **build**: intl: converge from joyent/node (Steven R. Loomis) [#2264](https://github.com/nodejs/node/pull/2264) * [[`071640abdd`](https://github.com/nodejs/node/commit/071640abdd)] - **build**: Intl: bump ICU4C from 54 to 55 (Steven R. Loomis) [#2293](https://github.com/nodejs/node/pull/2293) * [[`07a88b0c8b`](https://github.com/nodejs/node/commit/07a88b0c8b)] - **build**: update manifest to include Windows 10 (Lucien Greathouse) [#2332](https://github.com/nodejs/io.js/pull/2332) * [[`0bb099f444`](https://github.com/nodejs/node/commit/0bb099f444)] - **build**: expand ~ in install prefix early (Ben Noordhuis) [#2307](https://github.com/nodejs/io.js/pull/2307) * [[`7fe6dd8f5d`](https://github.com/nodejs/node/commit/7fe6dd8f5d)] - **crypto**: check for OpenSSL errors when signing (P.S.V.R) [#2342](https://github.com/nodejs/node/pull/2342) * [[`605f6ee904`](https://github.com/nodejs/node/commit/605f6ee904)] - **crypto**: fix memory leak in PBKDF2Request (Karl Skomski) [#2375](https://github.com/nodejs/node/pull/2375) * [[`ba6eb8af12`](https://github.com/nodejs/node/commit/ba6eb8af12)] - **crypto**: fix memory leak in ECDH::SetPrivateKey (Karl Skomski) [#2375](https://github.com/nodejs/node/pull/2375) * [[`6a16368611`](https://github.com/nodejs/node/commit/6a16368611)] - **crypto**: fix memory leak in PublicKeyCipher::Cipher (Karl Skomski) [#2375](https://github.com/nodejs/node/pull/2375) * [[`a760a87803`](https://github.com/nodejs/node/commit/a760a87803)] - **crypto**: fix memory leak in SafeX509ExtPrint (Karl Skomski) [#2375](https://github.com/nodejs/node/pull/2375) * [[`f45487cd6e`](https://github.com/nodejs/node/commit/f45487cd6e)] - **crypto**: fix memory leak in SetDHParam (Karl Skomski) [#2375](https://github.com/nodejs/node/pull/2375) * [[`2ff183dd86`](https://github.com/nodejs/node/commit/2ff183dd86)] - **doc**: Update FIPS instructions in README.md (Michael Dawson) [#2278](https://github.com/nodejs/node/pull/2278) * [[`6483bc2e8f`](https://github.com/nodejs/node/commit/6483bc2e8f)] - **doc**: clarify options for fs.watchFile() (Rich Trott) [#2425](https://github.com/nodejs/node/pull/2425) * [[`e76822f454`](https://github.com/nodejs/node/commit/e76822f454)] - **doc**: multiple documentation updates cherry picked from v0.12 (James M Snell) [#2302](https://github.com/nodejs/io.js/pull/2302) * [[`1738c9680b`](https://github.com/nodejs/node/commit/1738c9680b)] - **net**: ensure Socket reported address is current (Ryan Graham) [#2095](https://github.com/nodejs/io.js/pull/2095) * [[`844d3f0e3e`](https://github.com/nodejs/node/commit/844d3f0e3e)] - **path**: use '===' instead of '==' for comparison (Sam Stites) [#2388](https://github.com/nodejs/node/pull/2388) * [[`7118b8a882`](https://github.com/nodejs/node/commit/7118b8a882)] - **path**: remove dead code in favor of unit tests (Nathan Woltman) [#2282](https://github.com/nodejs/io.js/pull/2282) * [[`34f2cfa806`](https://github.com/nodejs/node/commit/34f2cfa806)] - **src**: better error message on failed Buffer malloc (Karl Skomski) [#2422](https://github.com/nodejs/node/pull/2422) * [[`b196c1da3c`](https://github.com/nodejs/node/commit/b196c1da3c)] - **src**: fix memory leak in DLOpen (Karl Skomski) [#2375](https://github.com/nodejs/node/pull/2375) * [[`d1307b2995`](https://github.com/nodejs/node/commit/d1307b2995)] - **src**: don't use fopen() in require() fast path (Ben Noordhuis) [#2377](https://github.com/nodejs/node/pull/2377) * [[`455ec570d1`](https://github.com/nodejs/node/commit/455ec570d1)] - **src**: rename Buffer::Use() to Buffer::New() (Ben Noordhuis) [#2352](https://github.com/nodejs/node/pull/2352) * [[`fd63e1ce2b`](https://github.com/nodejs/node/commit/fd63e1ce2b)] - **src**: introduce internal Buffer::Copy() function (Ben Noordhuis) [#2352](https://github.com/nodejs/node/pull/2352) * [[`5586ceca13`](https://github.com/nodejs/node/commit/5586ceca13)] - **src**: move internal functions out of node_buffer.h (Ben Noordhuis) [#2352](https://github.com/nodejs/node/pull/2352) * [[`bff9bcddb6`](https://github.com/nodejs/node/commit/bff9bcddb6)] - **src**: plug memory leaks (Ben Noordhuis) [#2352](https://github.com/nodejs/node/pull/2352) * [[`ccf12df4f3`](https://github.com/nodejs/node/commit/ccf12df4f3)] - **(SEMVER-MINOR)** **src**: add total_available_size to v8 statistics (Roman Klauke) [#2348](https://github.com/nodejs/io.js/pull/2348) * [[`194eeb841b`](https://github.com/nodejs/node/commit/194eeb841b)] - **test**: drop Isolate::GetCurrent() from addon tests (Ben Noordhuis) [#2427](https://github.com/nodejs/node/pull/2427) * [[`46cdb2f6e2`](https://github.com/nodejs/node/commit/46cdb2f6e2)] - **test**: lint addon tests (Ben Noordhuis) [#2427](https://github.com/nodejs/node/pull/2427) * [[`850c794882`](https://github.com/nodejs/node/commit/850c794882)] - **test**: refactor test-fs-watchfile.js (Rich Trott) [#2393](https://github.com/nodejs/node/pull/2393) * [[`a3160c0a33`](https://github.com/nodejs/node/commit/a3160c0a33)] - **test**: correct spelling of 'childProcess' (muddletoes) [#2389](https://github.com/nodejs/node/pull/2389) * [[`e51f90d747`](https://github.com/nodejs/node/commit/e51f90d747)] - **test**: option to run a subset of tests (João Reis) [#2260](https://github.com/nodejs/io.js/pull/2260) * [[`cc46d3bca3`](https://github.com/nodejs/node/commit/cc46d3bca3)] - **test**: clarify dropMembership() call (Rich Trott) [#2062](https://github.com/nodejs/io.js/pull/2062) * [[`0ee4df9c7a`](https://github.com/nodejs/node/commit/0ee4df9c7a)] - **test**: make listen-fd-cluster/server more robust (Sam Roberts) [#1944](https://github.com/nodejs/io.js/pull/1944) * [[`cf9ba81398`](https://github.com/nodejs/node/commit/cf9ba81398)] - **test**: address timing issues in simple http tests (Gireesh Punathil) [#2294](https://github.com/nodejs/io.js/pull/2294) * [[`cbb75c4f86`](https://github.com/nodejs/node/commit/cbb75c4f86)] - **tls**: fix throughput issues after incorrect merge (Fedor Indutny) [#2381](https://github.com/nodejs/node/pull/2381) * [[`94b765f409`](https://github.com/nodejs/node/commit/94b765f409)] - **tls**: fix check for reused session (Fedor Indutny) [#2312](https://github.com/nodejs/io.js/pull/2312) * [[`e83a41ad65`](https://github.com/nodejs/node/commit/e83a41ad65)] - **tls**: introduce internal `onticketkeycallback` (Fedor Indutny) [#2312](https://github.com/nodejs/io.js/pull/2312) * [[`fb0f5d733f`](https://github.com/nodejs/node/commit/fb0f5d733f)] - **(SEMVER-MINOR)** **tools**: run the tick processor without building v8 (Matt Loring) [#2090](https://github.com/nodejs/node/pull/2090) * [[`7606bdb897`](https://github.com/nodejs/node/commit/7606bdb897)] - **(SEMVER-MINOR)** **util**: display constructor when inspecting objects (Christopher Monsanto) [#1935](https://github.com/nodejs/io.js/pull/1935) ## 2015-08-04, Version 3.0.0, @rvagg ### Notable changes * **buffer**: - Due to changes in V8, it has been necessary to reimplement `Buffer` on top of V8's `Uint8Array`. Every effort has been made to minimize the performance impact, however `Buffer` instantiation is measurably slower. Access operations may be faster in some circumstances but the exact performance profile and difference over previous versions will depend on how `Buffer` is used within applications. (Trevor Norris) [#1825](https://github.com/nodejs/node/pull/1825). - `Buffer` can now take `ArrayBuffer`s as a constructor argument (Trevor Norris) [#2002](https://github.com/nodejs/node/pull/2002). - When a single buffer is passed to `Buffer.concat()`, a new, copied `Buffer` object will be returned; previous behavior was to return the original `Buffer` object (Sakthipriyan Vairamani) [#1937](https://github.com/nodejs/node/pull/1937). * **build**: PPC support has been added to core to allow compiling on pLinux BE and LE (AIX support coming soon) (Michael Dawson) [#2124](https://github.com/nodejs/node/pull/2124). * **dgram**: If an error occurs within `socket.send()` and a callback has been provided, the error is only passed as the first argument to the callback and not emitted on the `socket` object; previous behavior was to do both (Matteo Collina & Chris Dickinson) [#1796](https://github.com/nodejs/node/pull/1796) * **freelist**: Deprecate the undocumented `freelist` core module (Sakthipriyan Vairamani) [#2176](https://github.com/nodejs/node/pull/2176). * **http**: - Status codes now all use the official [IANA names](http://www.iana.org/assignments/http-status-codes) as per [RFC7231](https://tools.ietf.org/html/rfc7231), e.g. `http.STATUS_CODES[414]` now returns `'URI Too Long'` rather than `'Request-URI Too Large'` (jomo) [#1470](https://github.com/nodejs/node/pull/1470). - Calling .getName() on an HTTP agent no longer returns a trailing colon, HTTPS agents will no longer return an extra colon near the middle of the string (Brendan Ashworth) [#1617](https://github.com/nodejs/node/pull/1617). * **node**: - `NODE_MODULE_VERSION` has been bumped to `45` to reflect the break in ABI (Rod Vagg) [#2096](https://github.com/nodejs/node/pull/2096). - Introduce a new `process.release` object that contains a `name` property set to `'io.js'` and `sourceUrl`, `headersUrl` and `libUrl` (Windows only) properties containing URLs for the relevant resources; this is intended to be used by node-gyp (Rod Vagg) [#2154](https://github.com/nodejs/node/pull/2154). - The version of node-gyp bundled with io.js now downloads and uses a tarball of header files from iojs.org rather than the full source for compiling native add-ons; it is hoped this is a temporary floating patch and the change will be upstreamed to node-gyp soon (Rod Vagg) [#2066](https://github.com/nodejs/node/pull/2066). * **repl**: Persistent history is now enabled by default. The history file is located at ~/.node_repl_history, which can be overridden by the new environment variable `NODE_REPL_HISTORY`. This deprecates the previous `NODE_REPL_HISTORY_FILE` variable. Additionally, the format of the file has been changed to plain text to better handle file corruption. (Jeremiah Senkpiel) [#2224](https://github.com/nodejs/node/pull/2224). * **smalloc**: The `smalloc` module has been removed as it is no longer possible to provide the API due to changes in V8 (Ben Noordhuis) [#2022](https://github.com/nodejs/node/pull/2022). * **tls**: Add `server.getTicketKeys()` and `server.setTicketKeys()` methods for [TLS session key](https://www.ietf.org/rfc/rfc5077.txt) rotation (Fedor Indutny) [#2227](https://github.com/nodejs/node/pull/2227). * **v8**: Upgraded to 4.4.63.26 - ES6: Enabled [computed property names](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Object_initializer#Computed_property_names) - ES6: `Array` can now be subclassed in strict mode - ES6: Implement [rest parameters](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Functions/rest_parameters) in staging, use the `--harmony-rest-parameters` command line flag - ES6: Implement the [spread operator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Spread_operator) in staging, use the `--harmony-spreadcalls` command line flag - Removed `SetIndexedPropertiesToExternalArrayData` and related APIs, forcing a shift to `Buffer` to be reimplemented based on `Uint8Array` - Introduction of `Maybe` and `MaybeLocal` C++ API for objects which _may_ or _may not_ have a value. - Added support for PPC See also https://github.com/nodejs/node/wiki/Breaking-Changes#300-from-2x for a summary of the breaking changes (SEMVER-MAJOR). ### Known issues See https://github.com/nodejs/node/labels/confirmed-bug for complete and current list of known issues. * Some problems with unreferenced timers running during `beforeExit` are still to be resolved. See [#1264](https://github.com/nodejs/node/issues/1264). * Surrogate pair in REPL can freeze terminal. [#690](https://github.com/nodejs/node/issues/690) * `process.send()` is not synchronous as the docs suggest, a regression introduced in 1.0.2, see [#760](https://github.com/nodejs/node/issues/760). * Calling `dns.setServers()` while a DNS query is in progress can cause the process to crash on a failed assertion. [#894](https://github.com/nodejs/node/issues/894) * `url.resolve` may transfer the auth portion of the url when resolving between two full hosts, see [#1435](https://github.com/nodejs/node/issues/1435). ### Commits * [[`60a974d200`](https://github.com/nodejs/node/commit/60a974d200)] - **buffer**: fix missing null/undefined check (Trevor Norris) [#2195](https://github.com/nodejs/node/pull/2195) * [[`e6ab2d92bc`](https://github.com/nodejs/node/commit/e6ab2d92bc)] - **buffer**: fix not return on error (Trevor Norris) [#2225](https://github.com/nodejs/node/pull/2225) * [[`1057d1186b`](https://github.com/nodejs/node/commit/1057d1186b)] - **buffer**: rename internal/buffer_new.js to buffer.js (Ben Noordhuis) [#2022](https://github.com/nodejs/node/pull/2022) * [[`4643b8b667`](https://github.com/nodejs/node/commit/4643b8b667)] - **(SEMVER-MINOR)** **buffer**: allow ArrayBuffer as Buffer argument (Trevor Norris) [#2002](https://github.com/nodejs/node/pull/2002) * [[`e5ada116cd`](https://github.com/nodejs/node/commit/e5ada116cd)] - **buffer**: minor cleanup from rebase (Trevor Norris) [#2003](https://github.com/nodejs/node/pull/2003) * [[`b625ab4242`](https://github.com/nodejs/node/commit/b625ab4242)] - **buffer**: fix usage of kMaxLength (Trevor Norris) [#2003](https://github.com/nodejs/node/pull/2003) * [[`eea66e2a7b`](https://github.com/nodejs/node/commit/eea66e2a7b)] - **(SEMVER-MAJOR)** **buffer**: fix case of one buffer passed to concat (Sakthipriyan Vairamani) [#1937](https://github.com/nodejs/node/pull/1937) * [[`8664084166`](https://github.com/nodejs/node/commit/8664084166)] - **buffer**: make additional changes to native API (Trevor Norris) [#1825](https://github.com/nodejs/node/pull/1825) * [[`36f78f4c1c`](https://github.com/nodejs/node/commit/36f78f4c1c)] - **buffer**: switch API to return MaybeLocal (Trevor Norris) [#1825](https://github.com/nodejs/node/pull/1825) * [[`571ec13841`](https://github.com/nodejs/node/commit/571ec13841)] - **buffer**: switch to using Maybe API (Trevor Norris) [#1825](https://github.com/nodejs/node/pull/1825) * [[`d75f5c8d0e`](https://github.com/nodejs/node/commit/d75f5c8d0e)] - **buffer**: finish implementing FreeCallback (Trevor Norris) [#1825](https://github.com/nodejs/node/pull/1825) * [[`63da0dfd3a`](https://github.com/nodejs/node/commit/63da0dfd3a)] - **buffer**: implement Uint8Array backed Buffer (Trevor Norris) [#1825](https://github.com/nodejs/node/pull/1825) * [[`23be6ca189`](https://github.com/nodejs/node/commit/23be6ca189)] - **buffer**: allow ARGS_THIS to accept a name (Trevor Norris) [#1825](https://github.com/nodejs/node/pull/1825) * [[`971de5e417`](https://github.com/nodejs/node/commit/971de5e417)] - **build**: prepare Windows installer for i18n support (Frederic Hemberger) [#2247](https://github.com/nodejs/node/pull/2247) * [[`2ba8b23661`](https://github.com/nodejs/node/commit/2ba8b23661)] - **build**: add 'x86' option back in to configure (Rod Vagg) [#2233](https://github.com/nodejs/node/pull/2233) * [[`b4226e797a`](https://github.com/nodejs/node/commit/b4226e797a)] - **build**: first set of updates to enable PPC support (Michael Dawson) [#2124](https://github.com/nodejs/node/pull/2124) * [[`24dd016deb`](https://github.com/nodejs/node/commit/24dd016deb)] - **build**: produce symbol map files on windows (Ali Ijaz Sheikh) [#2243](https://github.com/nodejs/node/pull/2243) * [[`423d8944ce`](https://github.com/nodejs/node/commit/423d8944ce)] - **cluster**: do not unconditionally set --debug-port (cjihrig) [#1949](https://github.com/nodejs/node/pull/1949) * [[`fa98b97171`](https://github.com/nodejs/node/commit/fa98b97171)] - **cluster**: add handle ref/unref stubs in rr mode (Ben Noordhuis) [#2274](https://github.com/nodejs/node/pull/2274) * [[`944f68046c`](https://github.com/nodejs/node/commit/944f68046c)] - **crypto**: remove kMaxLength on randomBytes() (Trevor Norris) [#1825](https://github.com/nodejs/node/pull/1825) * [[`3d3c687012`](https://github.com/nodejs/node/commit/3d3c687012)] - **deps**: update V8 to 4.4.63.26 (Michaël Zasso) [#2220](https://github.com/nodejs/node/pull/2220) * [[`3aad4fa89a`](https://github.com/nodejs/node/commit/3aad4fa89a)] - **deps**: upgrade v8 to 4.4.63.12 (Ben Noordhuis) [#2092](https://github.com/nodejs/node/pull/2092) * [[`70d1f32f56`](https://github.com/nodejs/node/commit/70d1f32f56)] - **(SEMVER-MAJOR)** **deps**: update v8 to 4.4.63.9 (Ben Noordhuis) [#2022](https://github.com/nodejs/node/pull/2022) * [[`deb7ee93a7`](https://github.com/nodejs/node/commit/deb7ee93a7)] - **deps**: backport 7b24219346 from v8 upstream (Rod Vagg) [#1805](https://github.com/nodejs/node/pull/1805) * [[`d58e780504`](https://github.com/nodejs/node/commit/d58e780504)] - **(SEMVER-MAJOR)** **deps**: update v8 to 4.3.61.21 (Chris Dickinson) [iojs/io.js#1632](https://github.com/iojs/io.js/pull/1632) * [[`2a63cf612b`](https://github.com/nodejs/node/commit/2a63cf612b)] - **deps**: make node-gyp work with io.js (cjihrig) [iojs/io.js#990](https://github.com/iojs/io.js/pull/990) * [[`bf63266460`](https://github.com/nodejs/node/commit/bf63266460)] - **deps**: upgrade to npm 2.13.3 (Kat Marchán) [#2284](https://github.com/nodejs/node/pull/2284) * [[`ef2c8cd4ec`](https://github.com/nodejs/node/commit/ef2c8cd4ec)] - **(SEMVER-MAJOR)** **dgram**: make send cb act as "error" event handler (Matteo Collina) [#1796](https://github.com/nodejs/node/pull/1796) * [[`3da057fef6`](https://github.com/nodejs/node/commit/3da057fef6)] - **(SEMVER-MAJOR)** **dgram**: make send cb act as "error" event handler (Chris Dickinson) [#1796](https://github.com/nodejs/node/pull/1796) * [[`df1994fe53`](https://github.com/nodejs/node/commit/df1994fe53)] - ***Revert*** "**dns**: remove AI_V4MAPPED hint flag on FreeBSD" (cjihrig) [iojs/io.js#1555](https://github.com/iojs/io.js/pull/1555) * [[`1721968b22`](https://github.com/nodejs/node/commit/1721968b22)] - **doc**: document repl persistent history changes (Jeremiah Senkpiel) [#2224](https://github.com/nodejs/node/pull/2224) * [[`d12df7f159`](https://github.com/nodejs/node/commit/d12df7f159)] - **doc**: update v8 flags in man page (Michaël Zasso) [iojs/io.js#1701](https://github.com/iojs/io.js/pull/1701) * [[`d168d01b04`](https://github.com/nodejs/node/commit/d168d01b04)] - **doc**: properly inheriting from EventEmitter (Sakthipriyan Vairamani) [#2168](https://github.com/nodejs/node/pull/2168) * [[`500f2538cc`](https://github.com/nodejs/node/commit/500f2538cc)] - **doc**: a listener, not "an" listener (Sam Roberts) [#1025](https://github.com/nodejs/node/pull/1025) * [[`54627a919d`](https://github.com/nodejs/node/commit/54627a919d)] - **doc**: server close event does not have an argument (Sam Roberts) [#1025](https://github.com/nodejs/node/pull/1025) * [[`ed85c95a9c`](https://github.com/nodejs/node/commit/ed85c95a9c)] - **doc,test**: documents behaviour of non-existent file (Sakthipriyan Vairamani) [#2169](https://github.com/nodejs/node/pull/2169) * [[`2965442308`](https://github.com/nodejs/node/commit/2965442308)] - **(SEMVER-MAJOR)** **http**: fix agent.getName() and add tests (Brendan Ashworth) [#1617](https://github.com/nodejs/node/pull/1617) * [[`2d9456e3e6`](https://github.com/nodejs/node/commit/2d9456e3e6)] - **(SEMVER-MAJOR)** **http**: use official IANA Status Codes (jomo) [#1470](https://github.com/nodejs/node/pull/1470) * [[`11e4249227`](https://github.com/nodejs/node/commit/11e4249227)] - **(SEMVER-MAJOR)** **http_server**: `prefinish` vs `finish` (Fedor Indutny) [#1411](https://github.com/nodejs/node/pull/1411) * [[`9bc2e26720`](https://github.com/nodejs/node/commit/9bc2e26720)] - **net**: do not set V4MAPPED on FreeBSD (Julien Gilli) [iojs/io.js#1555](https://github.com/iojs/io.js/pull/1555) * [[`ba9ccf227e`](https://github.com/nodejs/node/commit/ba9ccf227e)] - **node**: remove redundant --use-old-buffer (Rod Vagg) [#2275](https://github.com/nodejs/node/pull/2275) * [[`ef65321083`](https://github.com/nodejs/node/commit/ef65321083)] - **(SEMVER-MAJOR)** **node**: do not override `message`/`stack` of error (Fedor Indutny) [#2108](https://github.com/nodejs/node/pull/2108) * [[`9f727f5e03`](https://github.com/nodejs/node/commit/9f727f5e03)] - **node-gyp**: detect RC build with x.y.z-rc.n format (Rod Vagg) [#2171](https://github.com/nodejs/node/pull/2171) * [[`e52f963632`](https://github.com/nodejs/node/commit/e52f963632)] - **node-gyp**: download header tarball for compile (Rod Vagg) [#2066](https://github.com/nodejs/node/pull/2066) * [[`902c9ca51d`](https://github.com/nodejs/node/commit/902c9ca51d)] - **node-gyp**: make aware of nightly, next-nightly & rc (Rod Vagg) [#2066](https://github.com/nodejs/node/pull/2066) * [[`4cffaa3f55`](https://github.com/nodejs/node/commit/4cffaa3f55)] - **(SEMVER-MINOR)** **readline**: allow tabs in input (Rich Trott) [#1761](https://github.com/nodejs/node/pull/1761) * [[`ed6c249104`](https://github.com/nodejs/node/commit/ed6c249104)] - **(SEMVER-MAJOR)** **repl**: persist history in plain text (Jeremiah Senkpiel) [#2224](https://github.com/nodejs/node/pull/2224) * [[`f7d5e4c618`](https://github.com/nodejs/node/commit/f7d5e4c618)] - **(SEMVER-MINOR)** **repl**: default persistence to ~/.node_repl_history (Jeremiah Senkpiel) [#2224](https://github.com/nodejs/node/pull/2224) * [[`ea05e760cd`](https://github.com/nodejs/node/commit/ea05e760cd)] - **repl**: don't clobber RegExp.$ properties (Sakthipriyan Vairamani) [#2137](https://github.com/nodejs/node/pull/2137) * [[`d20093246b`](https://github.com/nodejs/node/commit/d20093246b)] - **src**: disable vector ICs on arm (Michaël Zasso) [#2220](https://github.com/nodejs/node/pull/2220) * [[`04fd4fad46`](https://github.com/nodejs/node/commit/04fd4fad46)] - **(SEMVER-MINOR)** **src**: introduce process.release object (Rod Vagg) [#2154](https://github.com/nodejs/node/pull/2154) * [[`9d34bd1147`](https://github.com/nodejs/node/commit/9d34bd1147)] - **src**: increment NODE_MODULE_VERSION to 45 (Rod Vagg) [#2096](https://github.com/nodejs/node/pull/2096) * [[`ceee8d2807`](https://github.com/nodejs/node/commit/ceee8d2807)] - **test**: add tests for persistent repl history (Jeremiah Senkpiel) [#2224](https://github.com/nodejs/node/pull/2224) * [[`8e1a8ffe24`](https://github.com/nodejs/node/commit/8e1a8ffe24)] - **test**: remove two obsolete pummel tests (Ben Noordhuis) [#2022](https://github.com/nodejs/node/pull/2022) * [[`ae731ec0fa`](https://github.com/nodejs/node/commit/ae731ec0fa)] - **test**: don't use arguments.callee (Ben Noordhuis) [#2022](https://github.com/nodejs/node/pull/2022) * [[`21d31c08e7`](https://github.com/nodejs/node/commit/21d31c08e7)] - **test**: remove obsolete harmony flags (Chris Dickinson) * [[`64cf71195c`](https://github.com/nodejs/node/commit/64cf71195c)] - **test**: change the hostname to an invalid name (Sakthipriyan Vairamani) [#2287](https://github.com/nodejs/node/pull/2287) * [[`80a1cf7425`](https://github.com/nodejs/node/commit/80a1cf7425)] - **test**: fix messages and use return to skip tests (Sakthipriyan Vairamani) [#2290](https://github.com/nodejs/node/pull/2290) * [[`d5ab92bcc1`](https://github.com/nodejs/node/commit/d5ab92bcc1)] - **test**: use common.isWindows consistently (Sakthipriyan Vairamani) [#2269](https://github.com/nodejs/node/pull/2269) * [[`bc733f7065`](https://github.com/nodejs/node/commit/bc733f7065)] - **test**: fix fs.readFile('/dev/stdin') tests (Ben Noordhuis) [#2265](https://github.com/nodejs/node/pull/2265) * [[`3cbb5870e5`](https://github.com/nodejs/node/commit/3cbb5870e5)] - **tools**: expose skip output to test runner (Johan Bergström) [#2130](https://github.com/nodejs/node/pull/2130) * [[`3b021efe11`](https://github.com/nodejs/node/commit/3b021efe11)] - **vm**: fix symbol access (Domenic Denicola) [#1773](https://github.com/nodejs/node/pull/1773) * [[`7b81e4ba36`](https://github.com/nodejs/node/commit/7b81e4ba36)] - **vm**: remove unnecessary access checks (Domenic Denicola) [#1773](https://github.com/nodejs/node/pull/1773) * [[`659dadd410`](https://github.com/nodejs/node/commit/659dadd410)] - **vm**: fix property descriptors of sandbox properties (Domenic Denicola) [#1773](https://github.com/nodejs/node/pull/1773) * [[`9bac1dbae9`](https://github.com/nodejs/node/commit/9bac1dbae9)] - **win,node-gyp**: enable delay-load hook by default (Bert Belder) [iojs/io.js#1433](https://github.com/iojs/io.js/pull/1433) ## 2015-07-28, Version 2.5.0, @cjihrig ### Notable changes * **https**: TLS sessions in Agent are reused (Fedor Indutny) [#2228](https://github.com/nodejs/node/pull/2228) * **src**: base64 decoding is now 50% faster (Ben Noordhuis) [#2193](https://github.com/nodejs/node/pull/2193) * **npm**: Upgraded to v2.13.2, release notes can be found in (Kat Marchán) [#2241](https://github.com/nodejs/node/pull/2241). ### Known issues See https://github.com/nodejs/node/labels/confirmed-bug for complete and current list of known issues. * Using multiple REPL instances in parallel may cause some REPL history corruption or loss. [#1634](https://github.com/nodejs/node/issues/1634) * Some problems with unreferenced timers running during `beforeExit` are still to be resolved. See [#1264](https://github.com/nodejs/node/issues/1264). * Surrogate pair in REPL can freeze terminal. [#690](https://github.com/nodejs/node/issues/690) * `process.send()` is not synchronous as the docs suggest, a regression introduced in 1.0.2, see [#760](https://github.com/nodejs/node/issues/760). * Calling `dns.setServers()` while a DNS query is in progress can cause the process to crash on a failed assertion. [#894](https://github.com/nodejs/node/issues/894) * `url.resolve` may transfer the auth portion of the url when resolving between two full hosts, see [#1435](https://github.com/nodejs/node/issues/1435). ### Commits * [[`bf2cd225a8`](https://github.com/nodejs/node/commit/bf2cd225a8)] - **process**: resize stderr on SIGWINCH (Jeremiah Senkpiel) [#2231](https://github.com/nodejs/node/pull/2231) * [[`99d9d7e716`](https://github.com/nodejs/node/commit/99d9d7e716)] - **benchmark**: add remaining path benchmarks & optimize (Nathan Woltman) [#2103](https://github.com/nodejs/node/pull/2103) * [[`66fc8ca22b`](https://github.com/nodejs/node/commit/66fc8ca22b)] - **(SEMVER-MINOR)** **cluster**: emit 'message' event on cluster master (Sam Roberts) [#861](https://github.com/nodejs/node/pull/861) * [[`eb35968de7`](https://github.com/nodejs/node/commit/eb35968de7)] - **crypto**: fix legacy SNICallback (Fedor Indutny) [#1720](https://github.com/nodejs/node/pull/1720) * [[`fef190cea6`](https://github.com/nodejs/node/commit/fef190cea6)] - **deps**: make node-gyp work with io.js (cjihrig) [iojs/io.js#990](https://github.com/iojs/io.js/pull/990) * [[`b73a7465c5`](https://github.com/nodejs/node/commit/b73a7465c5)] - **deps**: upgrade to npm 2.13.2 (Kat Marchán) [#2241](https://github.com/nodejs/node/pull/2241) * [[`0a7bf81d2f`](https://github.com/nodejs/node/commit/0a7bf81d2f)] - **deps**: update V8 to 4.2.77.21 (Ali Ijaz Sheikh) [#2238](https://github.com/nodejs/node/issues/2238) * [[`73cdcdd581`](https://github.com/nodejs/node/commit/73cdcdd581)] - **deps**: make node-gyp work with io.js (cjihrig) [iojs/io.js#990](https://github.com/iojs/io.js/pull/990) * [[`04893a736d`](https://github.com/nodejs/node/commit/04893a736d)] - **deps**: upgrade to npm 2.13.1 (Kat Marchán) [#2210](https://github.com/nodejs/node/pull/2210) * [[`a3c1b9720e`](https://github.com/nodejs/node/commit/a3c1b9720e)] - **doc**: add GPG fingerprint for cjihrig (cjihrig) [#2217](https://github.com/nodejs/node/pull/2217) * [[`d9f857df3b`](https://github.com/nodejs/node/commit/d9f857df3b)] - **doc**: note about custom inspect functions (Sakthipriyan Vairamani) [#2142](https://github.com/nodejs/node/pull/2142) * [[`4ef2b5fbfb`](https://github.com/nodejs/node/commit/4ef2b5fbfb)] - **doc**: Replace util.debug with console.error (Yosuke Furukawa) [#2214](https://github.com/nodejs/node/pull/2214) * [[`b612f085ec`](https://github.com/nodejs/node/commit/b612f085ec)] - **doc**: add joaocgreis as a collaborator (João Reis) [#2208](https://github.com/nodejs/node/pull/2208) * [[`6b85d5a4b3`](https://github.com/nodejs/node/commit/6b85d5a4b3)] - **doc**: add TSC meeting minutes 2015-07-15 (Rod Vagg) [#2191](https://github.com/nodejs/node/pull/2191) * [[`c7d8b09162`](https://github.com/nodejs/node/commit/c7d8b09162)] - **doc**: recompile before testing core module changes (Phillip Johnsen) [#2051](https://github.com/nodejs/node/pull/2051) * [[`9afee6785e`](https://github.com/nodejs/node/commit/9afee6785e)] - **http**: Check this.connection before using it (Sakthipriyan Vairamani) [#2172](https://github.com/nodejs/node/pull/2172) * [[`2ca5a3db47`](https://github.com/nodejs/node/commit/2ca5a3db47)] - **https**: reuse TLS sessions in Agent (Fedor Indutny) [#2228](https://github.com/nodejs/node/pull/2228) * [[`fef87fee1d`](https://github.com/nodejs/node/commit/fef87fee1d)] - **(SEMVER-MINOR)** **lib,test**: add freelist deprecation and test (Sakthipriyan Vairamani) [#2176](https://github.com/nodejs/node/pull/2176) * [[`503b089dd8`](https://github.com/nodejs/node/commit/503b089dd8)] - **net**: don't throw on immediately destroyed socket (Evan Lucas) [#2251](https://github.com/nodejs/node/pull/2251) * [[`93660c8b8e`](https://github.com/nodejs/node/commit/93660c8b8e)] - **node**: remove bad fn call and check (Trevor Norris) [#2157](https://github.com/nodejs/node/pull/2157) * [[`afd7e37ee0`](https://github.com/nodejs/node/commit/afd7e37ee0)] - **repl**: better empty line handling (Sakthipriyan Vairamani) [#2163](https://github.com/nodejs/node/pull/2163) * [[`81ea52aa01`](https://github.com/nodejs/node/commit/81ea52aa01)] - **repl**: improving line continuation handling (Sakthipriyan Vairamani) [#2163](https://github.com/nodejs/node/pull/2163) * [[`30edb5aee9`](https://github.com/nodejs/node/commit/30edb5aee9)] - **repl**: preventing REPL crash with inherited properties (Sakthipriyan Vairamani) [#2163](https://github.com/nodejs/node/pull/2163) * [[`77fa385e5d`](https://github.com/nodejs/node/commit/77fa385e5d)] - **repl**: fixing `undefined` in invalid REPL keyword error (Sakthipriyan Vairamani) [#2163](https://github.com/nodejs/node/pull/2163) * [[`8fd3ce100e`](https://github.com/nodejs/node/commit/8fd3ce100e)] - **src**: make base64 decoding 50% faster (Ben Noordhuis) [#2193](https://github.com/nodejs/node/pull/2193) * [[`c786d6341d`](https://github.com/nodejs/node/commit/c786d6341d)] - **test**: do not use public IPs for timeout testing (Rich Trott) [#2057](https://github.com/nodejs/node/pull/2057) * [[`4e78cd71c0`](https://github.com/nodejs/node/commit/4e78cd71c0)] - **test**: skip IPv6 part before testing it (Sakthipriyan Vairamani) [#2226](https://github.com/nodejs/node/pull/2226) * [[`ac70bc8240`](https://github.com/nodejs/node/commit/ac70bc8240)] - **test**: fix valgrind uninitialized memory warning (Ben Noordhuis) [#2193](https://github.com/nodejs/node/pull/2193) * [[`ac7d3fa0d9`](https://github.com/nodejs/node/commit/ac7d3fa0d9)] - **test**: add -no_rand_screen to s_client opts on Win (Shigeki Ohtsu) [#2209](https://github.com/nodejs/node/pull/2209) * [[`79c865a53f`](https://github.com/nodejs/node/commit/79c865a53f)] - **test**: changing process.exit to return while skipping tests (Sakthipriyan Vairamani) [#2109](https://github.com/nodejs/node/pull/2109) * [[`69298d36cf`](https://github.com/nodejs/node/commit/69298d36cf)] - **test**: formatting skip messages for TAP parsing (Sakthipriyan Vairamani) [#2109](https://github.com/nodejs/node/pull/2109) * [[`543dabb609`](https://github.com/nodejs/node/commit/543dabb609)] - **timers**: improve Timer.now() performance (Ben Noordhuis) [#2256](https://github.com/nodejs/node/pull/2256) * [[`3663b124e6`](https://github.com/nodejs/node/commit/3663b124e6)] - **timers**: remove unused Timer.again() (Ben Noordhuis) [#2256](https://github.com/nodejs/node/pull/2256) * [[`bcce5cf9bb`](https://github.com/nodejs/node/commit/bcce5cf9bb)] - **timers**: remove unused Timer.getRepeat() (Ben Noordhuis) [#2256](https://github.com/nodejs/node/pull/2256) * [[`f2c83bd202`](https://github.com/nodejs/node/commit/f2c83bd202)] - **timers**: remove unused Timer.setRepeat() (Ben Noordhuis) [#2256](https://github.com/nodejs/node/pull/2256) * [[`e11fc67225`](https://github.com/nodejs/node/commit/e11fc67225)] - **(SEMVER-MINOR)** **tls**: add `getTicketKeys()`/`setTicketKeys()` (Fedor Indutny) [#2227](https://github.com/nodejs/node/pull/2227) * [[`68b06e94e3`](https://github.com/nodejs/node/commit/68b06e94e3)] - **tools**: use local or specified $NODE for test-npm (Jeremiah Senkpiel) [#1984](https://github.com/nodejs/node/pull/1984) * [[`ab479659c7`](https://github.com/nodejs/node/commit/ab479659c7)] - **util**: delay creation of debug context (Ali Ijaz Sheikh) [#2248](https://github.com/nodejs/node/pull/2248) * [[`6391f4d2fd`](https://github.com/nodejs/node/commit/6391f4d2fd)] - **util**: removing redundant checks in is* functions (Sakthipriyan Vairamani) [#2179](https://github.com/nodejs/node/pull/2179) * [[`b148c0dff3`](https://github.com/nodejs/node/commit/b148c0dff3)] - **win,node-gyp**: enable delay-load hook by default (Bert Belder) [iojs/io.js#1433](https://github.com/iojs/io.js/pull/1433) * [[`f90f1e75bb`](https://github.com/nodejs/node/commit/f90f1e75bb)] - **win,node-gyp**: enable delay-load hook by default (Bert Belder) [iojs/io.js#1433](https://github.com/iojs/io.js/pull/1433) ## 2015-07-17, Version 2.4.0, @Fishrock123 ### Notable changes * **src**: Added a new `--track-heap-objects` flag to track heap object allocations for heap snapshots (Bradley Meck) [#2135](https://github.com/nodejs/node/pull/2135). * **readline**: Fixed a freeze that affected the repl if the keypress event handler threw (Alex Kocharin) [#2107](https://github.com/nodejs/node/pull/2107). * **npm**: Upgraded to v2.13.0, release notes can be found in (Forrest L Norvell) [#2152](https://github.com/nodejs/node/pull/2152). ### Known issues See https://github.com/nodejs/node/labels/confirmed-bug for complete and current list of known issues. * Some problems with unreferenced timers running during `beforeExit` are still to be resolved. See [#1264](https://github.com/nodejs/node/issues/1264). * Surrogate pair in REPL can freeze terminal. [#690](https://github.com/nodejs/node/issues/690) * `process.send()` is not synchronous as the docs suggest, a regression introduced in 1.0.2, see [#760](https://github.com/nodejs/node/issues/760). * Calling `dns.setServers()` while a DNS query is in progress can cause the process to crash on a failed assertion. [#894](https://github.com/nodejs/node/issues/894) * `url.resolve` may transfer the auth portion of the url when resolving between two full hosts, see [#1435](https://github.com/nodejs/node/issues/1435). ### Commits * [[`f95f9ef6ea`](https://github.com/nodejs/node/commit/f95f9ef6ea)] - **build**: always use prefix=/ for tar-headers (Rod Vagg) [#2082](https://github.com/nodejs/node/pull/2082) * [[`12bc397207`](https://github.com/nodejs/node/commit/12bc397207)] - **build**: run-ci makefile rule (Alexis Campailla) [#2134](https://github.com/nodejs/node/pull/2134) * [[`84012c99e0`](https://github.com/nodejs/node/commit/84012c99e0)] - **build**: fix vcbuild merge issues (Alexis Campailla) [#2131](https://github.com/nodejs/node/pull/2131) * [[`47e2c5c828`](https://github.com/nodejs/node/commit/47e2c5c828)] - **build**: bail early if clean is invoked (Johan Bergström) [#2127](https://github.com/nodejs/node/pull/2127) * [[`5acad6b163`](https://github.com/nodejs/node/commit/5acad6b163)] - **child_process**: fix arguments comments (Roman Reiss) [#2161](https://github.com/nodejs/node/pull/2161) * [[`3c4121c418`](https://github.com/nodejs/node/commit/3c4121c418)] - **deps**: make node-gyp work with io.js (cjihrig) [iojs/io.js#990](https://github.com/iojs/io.js/pull/990) * [[`938cc757bb`](https://github.com/nodejs/node/commit/938cc757bb)] - **deps**: upgrade to npm 2.13.0 (Forrest L Norvell) [#2152](https://github.com/nodejs/node/pull/2152) * [[`6f306e0ed2`](https://github.com/nodejs/node/commit/6f306e0ed2)] - **doc**: add targos as a collaborator (Michaël Zasso) [#2200](https://github.com/nodejs/node/pull/2200) * [[`c019d9a239`](https://github.com/nodejs/node/commit/c019d9a239)] - **doc**: add thefourtheye as a collaborator (Sakthipriyan Vairamani) [#2199](https://github.com/nodejs/node/pull/2199) * [[`4e92dbc26b`](https://github.com/nodejs/node/commit/4e92dbc26b)] - **doc**: add TSC members from the combined project (Jeremiah Senkpiel) [#2085](https://github.com/nodejs/node/pull/2085) * [[`6c3aabf455`](https://github.com/nodejs/node/commit/6c3aabf455)] - **doc**: add TSC meeting minutes 2015-07-08 (Rod Vagg) [#2184](https://github.com/nodejs/node/pull/2184) * [[`30a0d47d51`](https://github.com/nodejs/node/commit/30a0d47d51)] - **doc**: add TSC meeting minutes 2015-07-01 (Rod Vagg) [#2132](https://github.com/nodejs/node/pull/2132) * [[`23efb05cc3`](https://github.com/nodejs/node/commit/23efb05cc3)] - **doc**: document fs.watchFile behaviour on ENOENT (Brendan Ashworth) [#2093](https://github.com/nodejs/node/pull/2093) * [[`65963ec26f`](https://github.com/nodejs/node/commit/65963ec26f)] - **doc,test**: empty strings in path module (Sakthipriyan Vairamani) [#2106](https://github.com/nodejs/node/pull/2106) * [[`0ab81e6f58`](https://github.com/nodejs/node/commit/0ab81e6f58)] - **docs**: link to more up-to-date v8 docs (Jeremiah Senkpiel) [#2196](https://github.com/nodejs/node/pull/2196) * [[`1afc0c9e86`](https://github.com/nodejs/node/commit/1afc0c9e86)] - **fs**: fix error on bad listener type (Brendan Ashworth) [#2093](https://github.com/nodejs/node/pull/2093) * [[`2ba84606a6`](https://github.com/nodejs/node/commit/2ba84606a6)] - **path**: assert path.join() arguments equally (Phillip Johnsen) [#2159](https://github.com/nodejs/node/pull/2159) * [[`bd01603201`](https://github.com/nodejs/node/commit/bd01603201)] - **readline**: fix freeze if `keypress` event throws (Alex Kocharin) [#2107](https://github.com/nodejs/node/pull/2107) * [[`59f6b5da2a`](https://github.com/nodejs/node/commit/59f6b5da2a)] - **repl**: Prevent crash when tab-completed with Proxy (Sakthipriyan Vairamani) [#2120](https://github.com/nodejs/node/pull/2120) * [[`cf14a2427c`](https://github.com/nodejs/node/commit/cf14a2427c)] - **(SEMVER-MINOR)** **src**: add --track-heap-objects (Bradley Meck) [#2135](https://github.com/nodejs/node/pull/2135) * [[`2b4b600660`](https://github.com/nodejs/node/commit/2b4b600660)] - **test**: fix test-debug-port-from-cmdline (João Reis) [#2186](https://github.com/nodejs/node/pull/2186) * [[`d4ceb16da2`](https://github.com/nodejs/node/commit/d4ceb16da2)] - **test**: properly clean up temp directory (Roman Reiss) [#2164](https://github.com/nodejs/node/pull/2164) * [[`842eb5b853`](https://github.com/nodejs/node/commit/842eb5b853)] - **test**: add test for dgram.setTTL (Evan Lucas) [#2121](https://github.com/nodejs/node/pull/2121) * [[`cff7300a57`](https://github.com/nodejs/node/commit/cff7300a57)] - **win,node-gyp**: enable delay-load hook by default (Bert Belder) [iojs/io.js#1433](https://github.com/iojs/io.js/pull/1433) ## 2015-07-09, Version 2.3.4, @Fishrock123 ### Notable changes * **openssl**: Upgrade to 1.0.2d, fixes CVE-2015-1793 (Alternate Chains Certificate Forgery) (Shigeki Ohtsu) [#2141](https://github.com/nodejs/node/pull/2141). * **npm**: Upgraded to v2.12.1, release notes can be found in and (Kat Marchán) [#2112](https://github.com/nodejs/node/pull/2112). ### Known issues See https://github.com/nodejs/node/labels/confirmed-bug for complete and current list of known issues. * Some problems with unreferenced timers running during `beforeExit` are still to be resolved. See [#1264](https://github.com/nodejs/node/issues/1264). * Surrogate pair in REPL can freeze terminal. [#690](https://github.com/nodejs/node/issues/690) * `process.send()` is not synchronous as the docs suggest, a regression introduced in 1.0.2, see [#760](https://github.com/nodejs/node/issues/760). * Calling `dns.setServers()` while a DNS query is in progress can cause the process to crash on a failed assertion. [#894](https://github.com/nodejs/node/issues/894) * `url.resolve` may transfer the auth portion of the url when resolving between two full hosts, see [#1435](https://github.com/nodejs/node/issues/1435). ### Commits * [[`0d15161c24`](https://github.com/nodejs/node/commit/0d15161c24)] - **benchmark**: Add some path benchmarks for #1778 (Nathan Woltman) [#1778](https://github.com/nodejs/node/pull/1778) * [[`c70e68fa32`](https://github.com/nodejs/node/commit/c70e68fa32)] - **deps**: update deps/openssl/conf/arch/*/opensslconf.h (Shigeki Ohtsu) [#2141](https://github.com/nodejs/node/pull/2141) * [[`ca93f7f2e6`](https://github.com/nodejs/node/commit/ca93f7f2e6)] - **deps**: upgrade openssl sources to 1.0.2d (Shigeki Ohtsu) [#2141](https://github.com/nodejs/node/pull/2141) * [[`b18c841ec1`](https://github.com/nodejs/node/commit/b18c841ec1)] - **deps**: make node-gyp work with io.js (cjihrig) [iojs/io.js#990](https://github.com/iojs/io.js/pull/990) * [[`863cdbdd08`](https://github.com/nodejs/node/commit/863cdbdd08)] - **deps**: upgrade to npm 2.12.1 (Kat Marchán) [#2112](https://github.com/nodejs/node/pull/2112) * [[`84b3915764`](https://github.com/nodejs/node/commit/84b3915764)] - **doc**: document current release procedure (Rod Vagg) [#2099](https://github.com/nodejs/node/pull/2099) * [[`46140334cd`](https://github.com/nodejs/node/commit/46140334cd)] - **doc**: update AUTHORS list (Rod Vagg) [#2100](https://github.com/nodejs/node/pull/2100) * [[`bca53dce76`](https://github.com/nodejs/node/commit/bca53dce76)] - **path**: refactor for performance and consistency (Nathan Woltman) [#1778](https://github.com/nodejs/node/pull/1778) * [[`6bef15afe7`](https://github.com/nodejs/node/commit/6bef15afe7)] - **src**: remove traceSyncIO property from process (Bradley Meck) [#2143](https://github.com/nodejs/node/pull/2143) * [[`2ba1740ba1`](https://github.com/nodejs/node/commit/2ba1740ba1)] - **test**: add missing crypto checks (Johan Bergström) [#2129](https://github.com/nodejs/node/pull/2129) * [[`180fd392ca`](https://github.com/nodejs/node/commit/180fd392ca)] - **test**: refactor test-repl-tab-complete (Sakthipriyan Vairamani) [#2122](https://github.com/nodejs/node/pull/2122) * [[`fb05c8e27d`](https://github.com/nodejs/node/commit/fb05c8e27d)] - ***Revert*** "**test**: add test for missing `close`/`finish` event" (Fedor Indutny) * [[`9436a860cb`](https://github.com/nodejs/node/commit/9436a860cb)] - **test**: add test for missing `close`/`finish` event (Mark Plomer) [iojs/io.js#1373](https://github.com/iojs/io.js/pull/1373) * [[`ee3ce2ed88`](https://github.com/nodejs/node/commit/ee3ce2ed88)] - **tools**: install gdbinit from v8 to $PREFIX/share (Ali Ijaz Sheikh) [#2123](https://github.com/nodejs/node/pull/2123) * [[`dd523c75da`](https://github.com/nodejs/node/commit/dd523c75da)] - **win,node-gyp**: enable delay-load hook by default (Bert Belder) [iojs/io.js#1433](https://github.com/iojs/io.js/pull/1433) ## 2015-07-09, Version 0.12.7 (Stable) ### Commits * [[`0cf9f27703`](https://github.com/nodejs/node/commit/0cf9f27703)] - **deps**: upgrade openssl sources to 1.0.1p [#25654](https://github.com/joyent/node/pull/25654) * [[`8917e430b8`](https://github.com/nodejs/node/commit/8917e430b8)] - **deps**: upgrade to npm 2.11.3 [#25545](https://github.com/joyent/node/pull/25545) * [[`88a27a9621`](https://github.com/nodejs/node/commit/88a27a9621)] - **V8**: cherry-pick JitCodeEvent patch from upstream (Ben Noordhuis) [#25589](https://github.com/joyent/node/pull/25589) * [[`18d413d299`](https://github.com/nodejs/node/commit/18d413d299)] - **win,msi**: create npm folder in AppData directory (Steven Rockarts) [#8838](https://github.com/joyent/node/pull/8838) ## 2015-07-09, Version 0.10.40 (Maintenance) ### Commits * [[`0cf9f27703`](https://github.com/nodejs/node/commit/0cf9f27703)] - **openssl**: upgrade to 1.0.1p [#25654](https://github.com/joyent/node/pull/25654) * [[`5a60e0d904`](https://github.com/nodejs/node/commit/5a60e0d904)] - **V8**: back-port JitCodeEvent patch from upstream (Ben Noordhuis) [#25588](https://github.com/joyent/node/pull/25588) * [[`18d413d299`](https://github.com/nodejs/node/commit/18d413d299)] - **win,msi**: create npm folder in AppData directory (Steven Rockarts) [#8838](https://github.com/joyent/node/pull/8838) ## 2015-07-04, Version 2.3.3, @Fishrock123 ### Notable changes * **deps**: Fixed an out-of-band write in utf8 decoder. **This is an important security update** as it can be used to cause a denial of service attack. ### Known issues See https://github.com/nodejs/node/labels/confirmed-bug for complete and current list of known issues. * Some problems with unreferenced timers running during `beforeExit` are still to be resolved. See [#1264](https://github.com/nodejs/node/issues/1264). * Surrogate pair in REPL can freeze terminal. [#690](https://github.com/nodejs/node/issues/690) * `process.send()` is not synchronous as the docs suggest, a regression introduced in 1.0.2, see [#760](https://github.com/nodejs/node/issues/760). * Calling `dns.setServers()` while a DNS query is in progress can cause the process to crash on a failed assertion. [#894](https://github.com/nodejs/node/issues/894) * `url.resolve` may transfer the auth portion of the url when resolving between two full hosts, see [#1435](https://github.com/nodejs/node/issues/1435). ## Commits * [[`030f8045c7`](https://github.com/nodejs/node/commit/030f8045c7)] - **deps**: fix out-of-band write in utf8 decoder (Fedor Indutny) * [[`0f09b8db28`](https://github.com/nodejs/node/commit/0f09b8db28)] - **doc**: don't recommend domains for error handling (Benjamin Gruenbaum) [#2056](https://github.com/nodejs/node/pull/2056) * [[`9cd44bb2b6`](https://github.com/nodejs/node/commit/9cd44bb2b6)] - **util**: prepend '(node) ' to deprecation messages (Sakthipriyan Vairamani) [#1892](https://github.com/nodejs/node/pull/1892) ## 2015-07-03, Version 0.12.6 (Stable) ### Notable changes * **deps**: Fixed an out-of-band write in utf8 decoder. **This is an important security update** as it can be used to cause a denial of service attack. ### Commits * [[`78b0e30954`](https://github.com/nodejs/node/commit/78b0e30954)] - **deps**: fix out-of-band write in utf8 decoder (Fedor Indutny) ## 2015-07-01, Version 2.3.2, @rvagg ### Notable changes * **build**: - Added support for compiling with Microsoft Visual C++ 2015 - Started building and distributing headers-only tarballs along with binaries ### Known issues See https://github.com/nodejs/node/labels/confirmed-bug for complete and current list of known issues. * Some problems with unreferenced timers running during `beforeExit` are still to be resolved. See [#1264](https://github.com/nodejs/node/issues/1264). * Surrogate pair in REPL can freeze terminal [#690](https://github.com/nodejs/node/issues/690) * `process.send()` is not synchronous as the docs suggest, a regression introduced in 1.0.2, see [#760](https://github.com/nodejs/node/issues/760) and fix in [#774](https://github.com/nodejs/node/issues/774) * Calling `dns.setServers()` while a DNS query is in progress can cause the process to crash on a failed assertion [#894](https://github.com/nodejs/node/issues/894) * `url.resolve` may transfer the auth portion of the url when resolving between two full hosts, see [#1435](https://github.com/nodejs/node/issues/1435). ## Commits * [[`9180140231`](https://github.com/nodejs/node/commit/9180140231)] - **_stream_wrap**: prevent use after free in TLS (Fedor Indutny) [#1910](https://github.com/nodejs/node/pull/1910) * [[`05a73c0f25`](https://github.com/nodejs/node/commit/05a73c0f25)] - **benchmark**: make concurrent requests configurable (Rich Trott) [#2068](https://github.com/nodejs/node/pull/2068) * [[`f52d73352e`](https://github.com/nodejs/node/commit/f52d73352e)] - **benchmark**: fix typo in README (Rich Trott) [#2067](https://github.com/nodejs/node/pull/2067) * [[`1cd9eeb556`](https://github.com/nodejs/node/commit/1cd9eeb556)] - **buffer**: prevent abort on bad proto (Trevor Norris) [#2012](https://github.com/nodejs/node/pull/2012) * [[`8350f3a3a2`](https://github.com/nodejs/node/commit/8350f3a3a2)] - **buffer**: optimize Buffer#toString() (Ben Noordhuis) [#2027](https://github.com/nodejs/node/pull/2027) * [[`628a3ab093`](https://github.com/nodejs/node/commit/628a3ab093)] - **build**: add tar-headers target for headers-only tar (Rod Vagg) [#1975](https://github.com/nodejs/node/pull/1975) * [[`dcbb9e1da6`](https://github.com/nodejs/node/commit/dcbb9e1da6)] - **build**: update build targets for io.js (Rod Vagg) [#1938](https://github.com/nodejs/node/pull/1938) * [[`c87c34c242`](https://github.com/nodejs/node/commit/c87c34c242)] - **build**: fix cherry-pick ooops, fix comment wording (Rod Vagg) [#2036](https://github.com/nodejs/node/pull/2036) * [[`4208dc4fef`](https://github.com/nodejs/node/commit/4208dc4fef)] - **build**: add MSVS 2015 support (Rod Vagg) [#2036](https://github.com/nodejs/node/pull/2036) * [[`834a365113`](https://github.com/nodejs/node/commit/834a365113)] - **build**: DTrace is enabled by default on darwin (Evan Lucas) [#2019](https://github.com/nodejs/node/pull/2019) * [[`c0c0d73269`](https://github.com/nodejs/node/commit/c0c0d73269)] - **build,win**: set env before generating projects (Alexis Campailla) [joyent/node#20109](https://github.com/joyent/node/pull/20109) * [[`9e890fe8b4`](https://github.com/nodejs/node/commit/9e890fe8b4)] - **crypto**: fix VerifyCallback in case of verify error (Shigeki Ohtsu) [#2064](https://github.com/nodejs/node/pull/2064) * [[`1f371e3988`](https://github.com/nodejs/node/commit/1f371e3988)] - **deps**: copy all openssl header files to include dir (Shigeki Ohtsu) [#2016](https://github.com/nodejs/node/pull/2016) * [[`c370bd3aea`](https://github.com/nodejs/node/commit/c370bd3aea)] - **doc**: make the abbreviation 1MM clear (Ivan Yan) [#2053](https://github.com/nodejs/node/pull/2053) * [[`54d5437566`](https://github.com/nodejs/node/commit/54d5437566)] - **doc**: Added sample command to test iojs build (Jimmy Hsu) [#850](https://github.com/nodejs/node/pull/850) * [[`f1f1b7e597`](https://github.com/nodejs/node/commit/f1f1b7e597)] - **doc**: add TSC meeting minutes 2015-06-17 (Rod Vagg) [#2048](https://github.com/nodejs/node/pull/2048) * [[`dbd5dc932d`](https://github.com/nodejs/node/commit/dbd5dc932d)] - **doc**: clarify prerequisites in benchmark/README.md (Jeremiah Senkpiel) [#2034](https://github.com/nodejs/node/pull/2034) * [[`50dbc8e143`](https://github.com/nodejs/node/commit/50dbc8e143)] - **doc**: add TSC meeting minutes 2015-05-27 (Rod Vagg) [#2037](https://github.com/nodejs/node/pull/2037) * [[`941ad362a7`](https://github.com/nodejs/node/commit/941ad362a7)] - **doc**: archive io.js TC minutes (Rod Vagg) * [[`644b2eaa89`](https://github.com/nodejs/node/commit/644b2eaa89)] - **doc**: rename tc-meetings to tsc-meetings (Rod Vagg) * [[`1330ee3b27`](https://github.com/nodejs/node/commit/1330ee3b27)] - **doc**: add TC meeting 2015-05-13 minutes (Rod Vagg) [#1700](https://github.com/nodejs/node/pull/1700) * [[`392e8fd64e`](https://github.com/nodejs/node/commit/392e8fd64e)] - **doc**: add @shigeki and @mscdex to TC (Rod Vagg) [#2008](https://github.com/nodejs/node/pull/2008) * [[`af249fa8a1`](https://github.com/nodejs/node/commit/af249fa8a1)] - **net**: wrap connect in nextTick (Evan Lucas) [#2054](https://github.com/nodejs/node/pull/2054) * [[`7f63449fde`](https://github.com/nodejs/node/commit/7f63449fde)] - **net**: fix debug for dnsopts (Evan Lucas) [#2059](https://github.com/nodejs/node/pull/2059) * [[`eabed2f518`](https://github.com/nodejs/node/commit/eabed2f518)] - **repl**: remove obsolete TODO (Rich Trott) [#2081](https://github.com/nodejs/node/pull/2081) * [[`a198c68b56`](https://github.com/nodejs/node/commit/a198c68b56)] - **repl**: make 'Unexpected token' errors recoverable (Julien Gilli) [#2052](https://github.com/nodejs/node/pull/2052) * [[`d735b2c6ef`](https://github.com/nodejs/node/commit/d735b2c6ef)] - **repl**: fix tab completion for a non-global context (Sangmin Yoon) [#2052](https://github.com/nodejs/node/pull/2052) * [[`8cee8f54fc`](https://github.com/nodejs/node/commit/8cee8f54fc)] - **src**: nix stdin _readableState.reading manipulation (Chris Dickinson) [#454](https://github.com/nodejs/node/pull/454) * [[`856c11f8c8`](https://github.com/nodejs/node/commit/856c11f8c8)] - **test**: purge stale disabled tests (Rich Trott) [#2045](https://github.com/nodejs/node/pull/2045) * [[`4d5089e181`](https://github.com/nodejs/node/commit/4d5089e181)] - **test**: do not swallow OpenSSL support error (Rich Trott) [#2042](https://github.com/nodejs/node/pull/2042) * [[`06721fe005`](https://github.com/nodejs/node/commit/06721fe005)] - **test**: fix test-repl-tab-complete.js (cjihrig) [#2052](https://github.com/nodejs/node/pull/2052) * [[`8e9089ac35`](https://github.com/nodejs/node/commit/8e9089ac35)] - **test**: check for error on Windows (Rich Trott) [#2035](https://github.com/nodejs/node/pull/2035) * [[`776a65ebcd`](https://github.com/nodejs/node/commit/776a65ebcd)] - **test**: remove obsolete TODO comments (Rich Trott) [#2033](https://github.com/nodejs/node/pull/2033) * [[`bdfeb798ad`](https://github.com/nodejs/node/commit/bdfeb798ad)] - **test**: remove obsolete TODO comments (Rich Trott) [#2032](https://github.com/nodejs/node/pull/2032) * [[`58e914f9bc`](https://github.com/nodejs/node/commit/58e914f9bc)] - **tools**: fix gyp to work on MacOSX without XCode (Shigeki Ohtsu) [iojs/io.js#1325](https://github.com/iojs/io.js/pull/1325) * [[`99cbbc0a13`](https://github.com/nodejs/node/commit/99cbbc0a13)] - **tools**: update gyp to 25ed9ac (Ben Noordhuis) [#2074](https://github.com/nodejs/node/pull/2074) * [[`e3f9335c40`](https://github.com/nodejs/node/commit/e3f9335c40)] - **tools**: re-enable comma-spacing linter rule (Roman Reiss) [#2072](https://github.com/nodejs/node/pull/2072) * [[`d91e10b3bd`](https://github.com/nodejs/node/commit/d91e10b3bd)] - **tools**: update eslint to 0.24.0 (Roman Reiss) [#2072](https://github.com/nodejs/node/pull/2072) * [[`6c61ca5325`](https://github.com/nodejs/node/commit/6c61ca5325)] - **url**: fix typo in comment (Rich Trott) [#2071](https://github.com/nodejs/node/pull/2071) * [[`1a51f0058c`](https://github.com/nodejs/node/commit/1a51f0058c)] - **v8**: cherry-pick JitCodeEvent patch from upstream (Ben Noordhuis) [#2075](https://github.com/nodejs/node/pull/2075) ## 2015-06-23, Version 2.3.1, @rvagg ### Notable changes * **module**: The number of syscalls made during a `require()` have been significantly reduced again (see [#1801](https://github.com/nodejs/node/pull/1801) from v2.2.0 for previous work), which should lead to a performance improvement (Pierre Inglebert) [#1920](https://github.com/nodejs/node/pull/1920). * **npm**: * Upgrade to [v2.11.2](https://github.com/npm/npm/releases/tag/v2.11.2) (Rebecca Turner) [#1956](https://github.com/nodejs/node/pull/1956). * Upgrade to [v2.11.3](https://github.com/npm/npm/releases/tag/v2.11.3) (Forrest L Norvell) [#2018](https://github.com/nodejs/node/pull/2018). * **zlib**: A bug was discovered where the process would abort if the final part of a zlib decompression results in a buffer that would exceed the maximum length of `0x3fffffff` bytes (~1GiB). This was likely to only occur during buffered decompression (rather than streaming). This is now fixed and will instead result in a thrown `RangeError` (Michaël Zasso) [#1811](https://github.com/nodejs/node/pull/1811). ### Known issues See https://github.com/nodejs/node/labels/confirmed-bug for complete and current list of known issues. * Some problems with unreferenced timers running during `beforeExit` are still to be resolved. See [#1264](https://github.com/nodejs/node/issues/1264). * Surrogate pair in REPL can freeze terminal [#690](https://github.com/nodejs/node/issues/690) * `process.send()` is not synchronous as the docs suggest, a regression introduced in 1.0.2, see [#760](https://github.com/nodejs/node/issues/760) and fix in [#774](https://github.com/nodejs/node/issues/774) * Calling `dns.setServers()` while a DNS query is in progress can cause the process to crash on a failed assertion [#894](https://github.com/nodejs/node/issues/894) * `url.resolve` may transfer the auth portion of the url when resolving between two full hosts, see [#1435](https://github.com/nodejs/node/issues/1435). ## Commits * [[`e56758a5e0`](https://github.com/nodejs/node/commit/e56758a5e0)] - **async-wrap**: add provider id and object info cb (Trevor Norris) [#1896](https://github.com/nodejs/node/pull/1896) * [[`d5637e67c9`](https://github.com/nodejs/node/commit/d5637e67c9)] - **buffer**: fix cyclic dependency with util (Brendan Ashworth) [#1988](https://github.com/nodejs/node/pull/1988) * [[`c5353d7c62`](https://github.com/nodejs/node/commit/c5353d7c62)] - **build**: remove lint from test-ci on windows (Johan Bergström) [#2004](https://github.com/nodejs/node/pull/2004) * [[`c207e8d223`](https://github.com/nodejs/node/commit/c207e8d223)] - **build**: fix pkg-config output parsing in configure (Ben Noordhuis) [#1986](https://github.com/nodejs/node/pull/1986) * [[`8d8a26e8f7`](https://github.com/nodejs/node/commit/8d8a26e8f7)] - **build**: don't run lint from test-ci (Johan Bergström) [#1965](https://github.com/nodejs/node/pull/1965) * [[`1ec53c044d`](https://github.com/nodejs/node/commit/1ec53c044d)] - **build**: simplify execution of built binary (Johan Bergström) [#1955](https://github.com/nodejs/node/pull/1955) * [[`3beb880716`](https://github.com/nodejs/node/commit/3beb880716)] - **crypto**: add cert check to CNNIC Whitelist (Shigeki Ohtsu) [#1895](https://github.com/nodejs/node/pull/1895) * [[`48c0fb8b1a`](https://github.com/nodejs/node/commit/48c0fb8b1a)] - **deps**: make node-gyp work with io.js (cjihrig) [iojs/io.js#990](https://github.com/iojs/io.js/pull/990) * [[`6a359b1ce9`](https://github.com/nodejs/node/commit/6a359b1ce9)] - **deps**: upgrade to npm 2.11.3 (Forrest L Norvell) [#2018](https://github.com/nodejs/node/pull/2018) * [[`6aab2f3b9a`](https://github.com/nodejs/node/commit/6aab2f3b9a)] - **deps**: make node-gyp work with io.js (cjihrig) [iojs/io.js#990](https://github.com/iojs/io.js/pull/990) * [[`3e12561b55`](https://github.com/nodejs/node/commit/3e12561b55)] - **deps**: upgrade to npm 2.11.2 (Rebecca Turner) [#1956](https://github.com/nodejs/node/pull/1956) * [[`8ac50819b6`](https://github.com/nodejs/node/commit/8ac50819b6)] - **doc**: add security section to README.md (Rod Vagg) [#1948](https://github.com/nodejs/node/pull/1948) * [[`1f93b63b11`](https://github.com/nodejs/node/commit/1f93b63b11)] - **doc**: change the info to the same as in gitconfig (Christian Tellnes) [#2000](https://github.com/nodejs/node/pull/2000) * [[`0cf94e6856`](https://github.com/nodejs/node/commit/0cf94e6856)] - **doc**: mention CI in Collaborator Guide (Rich Trott) [#1995](https://github.com/nodejs/node/pull/1995) * [[`7a3006efe4`](https://github.com/nodejs/node/commit/7a3006efe4)] - **doc**: add TOC links to Collaborator Guide (Rich Trott) [#1994](https://github.com/nodejs/node/pull/1994) * [[`30638b150f`](https://github.com/nodejs/node/commit/30638b150f)] - **doc**: add TSC meeting notes 2015-06-10 (Bert Belder) [#1943](https://github.com/nodejs/node/pull/1943) * [[`c4ec04136b`](https://github.com/nodejs/node/commit/c4ec04136b)] - **doc**: reformat authors section (Johan Bergström) [#1966](https://github.com/nodejs/node/pull/1966) * [[`96165f9be2`](https://github.com/nodejs/node/commit/96165f9be2)] - **doc**: minor clarification in the modules API doc. (Сковорода Никита Андреевич) [#1983](https://github.com/nodejs/node/pull/1983) * [[`5c2707c1b2`](https://github.com/nodejs/node/commit/5c2707c1b2)] - **doc**: benchmark/README.md copyedit (Rich Trott) [#1970](https://github.com/nodejs/node/pull/1970) * [[`74fdf732d0`](https://github.com/nodejs/node/commit/74fdf732d0)] - **doc**: copyedit COLLABORATOR_GUIDE.md (Rich Trott) [#1964](https://github.com/nodejs/node/pull/1964) * [[`5fe6e83640`](https://github.com/nodejs/node/commit/5fe6e83640)] - **doc**: copyedit GOVERNANCE.md (Rich Trott) [#1963](https://github.com/nodejs/node/pull/1963) * [[`428526544c`](https://github.com/nodejs/node/commit/428526544c)] - **doc**: add ChALkeR as collaborator (Сковорода Никита Андреевич) [#1927](https://github.com/nodejs/node/pull/1927) * [[`5dfe0d5d61`](https://github.com/nodejs/node/commit/5dfe0d5d61)] - **doc**: remove irrelevant SEMVER-MINOR & MAJOR (Rod Vagg) * [[`fb8811d95e`](https://github.com/nodejs/node/commit/fb8811d95e)] - **lib,test**: fix whitespace issues (Roman Reiss) [#1971](https://github.com/nodejs/node/pull/1971) * [[`a4f4909f3d`](https://github.com/nodejs/node/commit/a4f4909f3d)] - **module**: fix stat with long paths on Windows (Michaël Zasso) [#2013](https://github.com/nodejs/node/pull/2013) * [[`a71ee93afe`](https://github.com/nodejs/node/commit/a71ee93afe)] - **module**: reduce syscalls during require search (Pierre Inglebert) [#1920](https://github.com/nodejs/node/pull/1920) * [[`671e64ac73`](https://github.com/nodejs/node/commit/671e64ac73)] - **module**: allow long paths for require on Windows (Michaël Zasso) * [[`061342a500`](https://github.com/nodejs/node/commit/061342a500)] - **net**: Defer reading until listeners could be added (James Hartig) [#1496](https://github.com/nodejs/node/pull/1496) * [[`5d2b846d11`](https://github.com/nodejs/node/commit/5d2b846d11)] - **test**: assert tmp and fixture dirs different (Rich Trott) [#2015](https://github.com/nodejs/node/pull/2015) * [[`b0990ef45d`](https://github.com/nodejs/node/commit/b0990ef45d)] - **test**: confirm symlink (Rich Trott) [#2014](https://github.com/nodejs/node/pull/2014) * [[`3ba4f71fc4`](https://github.com/nodejs/node/commit/3ba4f71fc4)] - **test**: check result as early as possible (Rich Trott) [#2007](https://github.com/nodejs/node/pull/2007) * [[`0abcf44d6b`](https://github.com/nodejs/node/commit/0abcf44d6b)] - **test**: add Buffer slice UTF-8 test (Rich Trott) [#1989](https://github.com/nodejs/node/pull/1989) * [[`88c1831ff4`](https://github.com/nodejs/node/commit/88c1831ff4)] - **test**: tmpdir creation failures should fail tests (Rich Trott) [#1976](https://github.com/nodejs/node/pull/1976) * [[`52a822d944`](https://github.com/nodejs/node/commit/52a822d944)] - **test**: fix test-cluster-worker-disconnect (Santiago Gimeno) [#1919](https://github.com/nodejs/node/pull/1919) * [[`7c79490bfb`](https://github.com/nodejs/node/commit/7c79490bfb)] - **test**: only refresh tmpDir for tests that need it (Rich Trott) [#1954](https://github.com/nodejs/node/pull/1954) * [[`88d7904c0b`](https://github.com/nodejs/node/commit/88d7904c0b)] - **test**: remove test repetition (Rich Trott) [#1874](https://github.com/nodejs/node/pull/1874) * [[`91dfb5e094`](https://github.com/nodejs/node/commit/91dfb5e094)] - **tools**: make test-npm work without global npm (Jeremiah Senkpiel) [#1926](https://github.com/nodejs/node/pull/1926) * [[`3777f41562`](https://github.com/nodejs/node/commit/3777f41562)] - **tools**: enable whitespace related rules in eslint (Roman Reiss) [#1971](https://github.com/nodejs/node/pull/1971) * [[`626432d843`](https://github.com/nodejs/node/commit/626432d843)] - **util**: dont repeat isBuffer (Brendan Ashworth) [#1988](https://github.com/nodejs/node/pull/1988) * [[`1d79f572f1`](https://github.com/nodejs/node/commit/1d79f572f1)] - **util**: move deprecate() to internal module (Brendan Ashworth) [#1988](https://github.com/nodejs/node/pull/1988) * [[`4b4b1760b5`](https://github.com/nodejs/node/commit/4b4b1760b5)] - **v8**: cherry-pick uclibc build patch from upstream (Ben Noordhuis) [#1974](https://github.com/nodejs/node/pull/1974) * [[`5d0cee46bb`](https://github.com/nodejs/node/commit/5d0cee46bb)] - **vm**: remove unnecessary HandleScopes (Ben Noordhuis) [#2001](https://github.com/nodejs/node/pull/2001) * [[`0ecf9457b5`](https://github.com/nodejs/node/commit/0ecf9457b5)] - **win,node-gyp**: enable delay-load hook by default (Bert Belder) [iojs/io.js#1433](https://github.com/iojs/io.js/pull/1433) * [[`953b3e75e8`](https://github.com/nodejs/node/commit/953b3e75e8)] - **win,node-gyp**: enable delay-load hook by default (Bert Belder) [iojs/io.js#1433](https://github.com/iojs/io.js/pull/1433) * [[`3806d875d3`](https://github.com/nodejs/node/commit/3806d875d3)] - **zlib**: prevent uncaught exception in zlibBuffer (Michaël Zasso) [#1811](https://github.com/nodejs/node/pull/1811) ## 2015-06-22, Version 0.12.5 (Stable) ### Commits * [[`456c22f63f`](https://github.com/nodejs/node/commit/456c22f63f)] - **openssl**: upgrade to 1.0.1o (Addressing multiple CVEs) [#25523](https://github.com/joyent/node/pull/25523) * [[`20d8db1a42`](https://github.com/nodejs/node/commit/20d8db1a42)] - **npm**: upgrade to 2.11.2 [#25517](https://github.com/joyent/node/pull/25517) * [[`50f961596d`](https://github.com/nodejs/node/commit/50f961596d)] - **uv**: upgrade to 1.6.1 [#25475](https://github.com/joyent/node/pull/25475) * [[`b81a643f9a`](https://github.com/nodejs/node/commit/b81a643f9a)] - **V8**: avoid deadlock when profiling is active (Dmitri Melikyan) [#25309](https://github.com/joyent/node/pull/25309) * [[`9d19dfbfdb`](https://github.com/nodejs/node/commit/9d19dfbfdb)] - **install**: fix source path for openssl headers (Oguz Bastemur) [#14089](https://github.com/joyent/node/pull/14089) * [[`4028669531`](https://github.com/nodejs/node/commit/4028669531)] - **install**: make sure opensslconf.h is overwritten (Oguz Bastemur) [#14089](https://github.com/joyent/node/pull/14089) * [[`d38e865fce`](https://github.com/nodejs/node/commit/d38e865fce)] - **timers**: fix timeout when added in timer's callback (Julien Gilli) [#17203](https://github.com/joyent/node/pull/17203) * [[`e7c84f82c7`](https://github.com/nodejs/node/commit/e7c84f82c7)] - **windows**: broadcast WM_SETTINGCHANGE after install (Mathias Küsel) [#25100](https://github.com/joyent/node/pull/25100) ## 2015-06-18, Version 0.10.39 (Maintenance) ### Commits * [[`456c22f63f`](https://github.com/nodejs/node/commit/456c22f63f)] - **openssl**: upgrade to 1.0.1o (Addressing multiple CVEs) [#25523](https://github.com/joyent/node/pull/25523) * [[`9d19dfbfdb`](https://github.com/nodejs/node/commit/9d19dfbfdb)] - **install**: fix source path for openssl headers (Oguz Bastemur) [#14089](https://github.com/joyent/node/pull/14089) * [[`4028669531`](https://github.com/nodejs/node/commit/4028669531)] - **install**: make sure opensslconf.h is overwritten (Oguz Bastemur) [#14089](https://github.com/joyent/node/pull/14089) * [[`d38e865fce`](https://github.com/nodejs/node/commit/d38e865fce)] - **timers**: fix timeout when added in timer's callback (Julien Gilli) [#17203](https://github.com/joyent/node/pull/17203) * [[`e7c84f82c7`](https://github.com/nodejs/node/commit/e7c84f82c7)] - **windows**: broadcast WM_SETTINGCHANGE after install (Mathias Küsel) [#25100](https://github.com/joyent/node/pull/25100) ## 2015-06-13, Version 2.3.0, @rvagg ### Notable changes * **libuv**: Upgraded to 1.6.0 and 1.6.1, see [full ChangeLog](https://github.com/libuv/libuv/blob/60e515d9e6f3d86c0eedad583805201f32ea3aed/ChangeLog#L1-L36) for details. (Saúl Ibarra Corretgé) [#1905](https://github.com/nodejs/node/pull/1905) [#1889](https://github.com/nodejs/node/pull/1889). Highlights include: - Fix TTY becoming blocked on OS X - Fix UDP send callbacks to not to be synchronous - Add `uv_os_homedir()` (exposed as `os.homedir()`, see below) * **npm**: See full [release notes](https://github.com/npm/npm/releases/tag/v2.11.1) for details. (Kat Marchán) [#1899](https://github.com/nodejs/node/pull/1899). Highlight: - Use GIT_SSH_COMMAND (available as of Git 2.3) * **openssl**: - Upgrade to 1.0.2b and 1.0.2c, introduces DHE man-in-the-middle protection (Logjam) and fixes malformed ECParameters causing infinite loop (CVE-2015-1788). See the [security advisory](https://www.openssl.org/news/secadv_20150611.txt) for full details. (Shigeki Ohtsu) [#1950](https://github.com/nodejs/node/pull/1950) [#1958](https://github.com/nodejs/node/pull/1958) - Support [FIPS](https://en.wikipedia.org/wiki/Federal_Information_Processing_Standards) mode of OpenSSL, see [README](https://github.com/nodejs/node#building-iojs-with-fips-compliant-openssl) for instructions. (Fedor Indutny) [#1890](https://github.com/nodejs/node/pull/1890) * **os**: Add `os.homedir()` method. (Colin Ihrig) [#1791](https://github.com/nodejs/node/pull/1791) * **smalloc**: Deprecate whole module. (Vladimir Kurchatkin) [#1822](https://github.com/nodejs/node/pull/1822) * Add new collaborators: - Alex Kocharin ([@rlidwka](https://github.com/rlidwka)) - Christopher Monsanto ([@monsanto](https://github.com/monsanto)) - Ali Ijaz Sheikh ([@ofrobots](https://github.com/ofrobots)) - Oleg Elifantiev ([@Olegas](https://github.com/Olegas)) - Domenic Denicola ([@domenic](https://github.com/domenic)) - Rich Trott ([@Trott](https://github.com/Trott)) ### Known issues See https://github.com/nodejs/node/labels/confirmed-bug for complete and current list of known issues. * Some problems with unreferenced timers running during `beforeExit` are still to be resolved. See [#1264](https://github.com/nodejs/node/issues/1264). * Surrogate pair in REPL can freeze terminal [#690](https://github.com/nodejs/node/issues/690) * `process.send()` is not synchronous as the docs suggest, a regression introduced in 1.0.2, see [#760](https://github.com/nodejs/node/issues/760) and fix in [#774](https://github.com/nodejs/node/issues/774) * Calling `dns.setServers()` while a DNS query is in progress can cause the process to crash on a failed assertion [#894](https://github.com/nodejs/node/issues/894) * `url.resolve` may transfer the auth portion of the url when resolving between two full hosts, see [#1435](https://github.com/nodejs/node/issues/1435). ## Commits * [[`9c0a1b8cfc`](https://github.com/nodejs/node/commit/9c0a1b8cfc)] - **cluster**: wait on servers closing before disconnect (Oleg Elifantiev) [#1400](https://github.com/nodejs/node/pull/1400) * [[`0f68377f69`](https://github.com/nodejs/node/commit/0f68377f69)] - **crypto**: support FIPS mode of OpenSSL (Fedor Indutny) [#1890](https://github.com/nodejs/node/pull/1890) * [[`38d1afc24d`](https://github.com/nodejs/node/commit/38d1afc24d)] - **(SEMVER-MINOR)** **crypto**: add getCurves() to get supported ECs (Brian White) [#1914](https://github.com/nodejs/node/pull/1914) * [[`a4dbf45b59`](https://github.com/nodejs/node/commit/a4dbf45b59)] - **crypto**: update root certificates (Ben Noordhuis) [#1833](https://github.com/nodejs/node/pull/1833) * [[`81029c639a`](https://github.com/nodejs/node/commit/81029c639a)] - **debugger**: improve ESRCH error message (Jackson Tian) [#1863](https://github.com/nodejs/node/pull/1863) * [[`2a7fd0ad32`](https://github.com/nodejs/node/commit/2a7fd0ad32)] - **deps**: update UPGRADING.md doc to openssl-1.0.2c (Shigeki Ohtsu) [#1958](https://github.com/nodejs/node/pull/1958) * [[`6b3df929e0`](https://github.com/nodejs/node/commit/6b3df929e0)] - **deps**: replace all headers in openssl (Shigeki Ohtsu) [#1958](https://github.com/nodejs/node/pull/1958) * [[`664a659696`](https://github.com/nodejs/node/commit/664a659696)] - **deps**: add -no_rand_screen to openssl s_client (Shigeki Ohtsu) [#1836](https://github.com/nodejs/node/pull/1836) * [[`42a8de2ac6`](https://github.com/nodejs/node/commit/42a8de2ac6)] - **deps**: fix asm build error of openssl in x86_win32 (Shigeki Ohtsu) [iojs/io.js#1389](https://github.com/iojs/io.js/pull/1389) * [[`c66c3d9fa3`](https://github.com/nodejs/node/commit/c66c3d9fa3)] - **deps**: fix openssl assembly error on ia32 win32 (Fedor Indutny) [iojs/io.js#1389](https://github.com/iojs/io.js/pull/1389) * [[`86737cf0a0`](https://github.com/nodejs/node/commit/86737cf0a0)] - **deps**: upgrade openssl sources to 1.0.2c (Shigeki Ohtsu) [#1958](https://github.com/nodejs/node/pull/1958) * [[`94804969b7`](https://github.com/nodejs/node/commit/94804969b7)] - **deps**: update asm files for openssl-1.0.2b (Shigeki Ohtsu) [#1950](https://github.com/nodejs/node/pull/1950) * [[`38444915e0`](https://github.com/nodejs/node/commit/38444915e0)] - **deps**: replace all headers in openssl (Shigeki Ohtsu) [#1950](https://github.com/nodejs/node/pull/1950) * [[`f62b613252`](https://github.com/nodejs/node/commit/f62b613252)] - **deps**: add -no_rand_screen to openssl s_client (Shigeki Ohtsu) [#1836](https://github.com/nodejs/node/pull/1836) * [[`f624d0122c`](https://github.com/nodejs/node/commit/f624d0122c)] - **deps**: fix asm build error of openssl in x86_win32 (Shigeki Ohtsu) [iojs/io.js#1389](https://github.com/iojs/io.js/pull/1389) * [[`dcd67cc8d7`](https://github.com/nodejs/node/commit/dcd67cc8d7)] - **deps**: fix openssl assembly error on ia32 win32 (Fedor Indutny) [iojs/io.js#1389](https://github.com/iojs/io.js/pull/1389) * [[`c21b24decf`](https://github.com/nodejs/node/commit/c21b24decf)] - **deps**: upgrade openssl sources to 1.0.2b (Shigeki Ohtsu) [#1950](https://github.com/nodejs/node/pull/1950) * [[`2dc819b09a`](https://github.com/nodejs/node/commit/2dc819b09a)] - **deps**: make node-gyp work with io.js (cjihrig) [iojs/io.js#990](https://github.com/iojs/io.js/pull/990) * [[`f41b7f12b5`](https://github.com/nodejs/node/commit/f41b7f12b5)] - **deps**: upgrade to npm 2.11.1 (Kat Marchán) [#1899](https://github.com/nodejs/node/pull/1899) * [[`a5bd466440`](https://github.com/nodejs/node/commit/a5bd466440)] - **deps**: update libuv to version 1.6.1 (Saúl Ibarra Corretgé) [#1905](https://github.com/nodejs/node/pull/1905) * [[`aa33db3238`](https://github.com/nodejs/node/commit/aa33db3238)] - **deps**: update libuv to version 1.6.0 (Saúl Ibarra Corretgé) [#1889](https://github.com/nodejs/node/pull/1889) * [[`0ee497f0b4`](https://github.com/nodejs/node/commit/0ee497f0b4)] - **deps**: add -no_rand_screen to openssl s_client (Shigeki Ohtsu) [#1836](https://github.com/nodejs/node/pull/1836) * [[`b5cd2f0986`](https://github.com/nodejs/node/commit/b5cd2f0986)] - **dgram**: partially revert 18d457b (Saúl Ibarra Corretgé) [#1889](https://github.com/nodejs/node/pull/1889) * [[`a3cc43d0a4`](https://github.com/nodejs/node/commit/a3cc43d0a4)] - **doc**: add Trott as collaborator (Rich Trott) [#1962](https://github.com/nodejs/node/pull/1962) * [[`cf5020fc02`](https://github.com/nodejs/node/commit/cf5020fc02)] - **doc**: add domenic as collaborator (Domenic Denicola) [#1942](https://github.com/nodejs/node/pull/1942) * [[`11ed5f31ab`](https://github.com/nodejs/node/commit/11ed5f31ab)] - **doc**: add Olegas as collaborator (Oleg Elifantiev) [#1930](https://github.com/nodejs/node/pull/1930) * [[`f500e1833b`](https://github.com/nodejs/node/commit/f500e1833b)] - **doc**: add ofrobots as collaborator (Ali Ijaz Sheikh) * [[`717724611a`](https://github.com/nodejs/node/commit/717724611a)] - **doc**: add monsanto as collaborator (Christopher Monsanto) [#1932](https://github.com/nodejs/node/pull/1932) * [[`7192b6688c`](https://github.com/nodejs/node/commit/7192b6688c)] - **doc**: add rlidwka as collaborator (Alex Kocharin) [#1929](https://github.com/nodejs/node/pull/1929) * [[`9f3a03f0d4`](https://github.com/nodejs/node/commit/9f3a03f0d4)] - **doc**: add references to crypto.getCurves() (Roman Reiss) [#1918](https://github.com/nodejs/node/pull/1918) * [[`ff39ecb914`](https://github.com/nodejs/node/commit/ff39ecb914)] - **doc**: remove comma splice (Rich Trott) [#1900](https://github.com/nodejs/node/pull/1900) * [[`deb8b87dc9`](https://github.com/nodejs/node/commit/deb8b87dc9)] - **doc**: add note about available ECC curves (Ryan Petschek) [#1913](https://github.com/nodejs/node/pull/1913) * [[`89a5b9040e`](https://github.com/nodejs/node/commit/89a5b9040e)] - **doc**: fix http.IncomingMessage.socket documentation (Сковорода Никита Андреевич) [#1867](https://github.com/nodejs/node/pull/1867) * [[`d29034b34b`](https://github.com/nodejs/node/commit/d29034b34b)] - **doc**: adjust changelog to clarify `client` revert (Rod Vagg) [#1859](https://github.com/nodejs/node/pull/1859) * [[`a79dece8ad`](https://github.com/nodejs/node/commit/a79dece8ad)] - **docs**: add return value for sync fs functions (Tyler Anton) [#1770](https://github.com/nodejs/node/pull/1770) * [[`1cb72c14c4`](https://github.com/nodejs/node/commit/1cb72c14c4)] - **docs**: delete unused/duplicate css files (Robert Kowalski) [#1770](https://github.com/nodejs/node/pull/1770) * [[`53a4eb3198`](https://github.com/nodejs/node/commit/53a4eb3198)] - **fs**: make SyncWriteStream non-enumerable (Sakthipriyan Vairamani) [#1870](https://github.com/nodejs/node/pull/1870) * [[`a011c3243f`](https://github.com/nodejs/node/commit/a011c3243f)] - **fs**: minor refactoring (Sakthipriyan Vairamani) [#1870](https://github.com/nodejs/node/pull/1870) * [[`8841132f30`](https://github.com/nodejs/node/commit/8841132f30)] - **fs**: remove inStatWatchers and use Map for lookup (Sakthipriyan Vairamani) [#1870](https://github.com/nodejs/node/pull/1870) * [[`67a11b9bcc`](https://github.com/nodejs/node/commit/67a11b9bcc)] - **fs**: removing unnecessary nullCheckCallNT (Sakthipriyan Vairamani) [#1870](https://github.com/nodejs/node/pull/1870) * [[`09f2a67bd8`](https://github.com/nodejs/node/commit/09f2a67bd8)] - **fs**: improve error message descriptions (Sakthipriyan Vairamani) [#1870](https://github.com/nodejs/node/pull/1870) * [[`2dcef83b5f`](https://github.com/nodejs/node/commit/2dcef83b5f)] - **fs**: use `kMaxLength` from binding (Vladimir Kurchatkin) [#1903](https://github.com/nodejs/node/pull/1903) * [[`353e26e3c7`](https://github.com/nodejs/node/commit/353e26e3c7)] - **(SEMVER-MINOR)** **fs**: Add string encoding option for Stream method (Yosuke Furukawa) [#1845](https://github.com/nodejs/node/pull/1845) * [[`8357c5084b`](https://github.com/nodejs/node/commit/8357c5084b)] - **fs**: set encoding on fs.createWriteStream (Yosuke Furukawa) [#1844](https://github.com/nodejs/node/pull/1844) * [[`02c345020a`](https://github.com/nodejs/node/commit/02c345020a)] - **gitignore**: don't ignore the debug npm module (Kat Marchán) [#1908](https://github.com/nodejs/node/pull/1908) * [[`b5b8ff117c`](https://github.com/nodejs/node/commit/b5b8ff117c)] - **lib**: don't use global Buffer (Roman Reiss) [#1794](https://github.com/nodejs/node/pull/1794) * [[`a251657058`](https://github.com/nodejs/node/commit/a251657058)] - **node**: mark promises as handled as soon as possible (Vladimir Kurchatkin) [#1952](https://github.com/nodejs/node/pull/1952) * [[`2eb170874a`](https://github.com/nodejs/node/commit/2eb170874a)] - **openssl**: fix keypress requirement in apps on win32 (Shigeki Ohtsu) [iojs/io.js#1389](https://github.com/iojs/io.js/pull/1389) * [[`a130132c8f`](https://github.com/nodejs/node/commit/a130132c8f)] - **openssl**: fix keypress requirement in apps on win32 (Shigeki Ohtsu) [iojs/io.js#1389](https://github.com/iojs/io.js/pull/1389) * [[`6e78e5feaa`](https://github.com/nodejs/node/commit/6e78e5feaa)] - **(SEMVER-MINOR)** **os**: add homedir() (cjihrig) [#1791](https://github.com/nodejs/node/pull/1791) * [[`d9e250295b`](https://github.com/nodejs/node/commit/d9e250295b)] - ***Revert*** "**readline**: allow tabs in input" (Jeremiah Senkpiel) [#1961](https://github.com/nodejs/node/pull/1961) * [[`4b3d493c4b`](https://github.com/nodejs/node/commit/4b3d493c4b)] - **readline**: allow tabs in input (Rich Trott) [#1761](https://github.com/nodejs/node/pull/1761) * [[`6d95f4ff92`](https://github.com/nodejs/node/commit/6d95f4ff92)] - **(SEMVER-MINOR)** **smalloc**: deprecate whole module (Vladimir Kurchatkin) [#1822](https://github.com/nodejs/node/pull/1822) * [[`8c71a9241d`](https://github.com/nodejs/node/commit/8c71a9241d)] - **src**: hide InitializeICUDirectory symbol (Ben Noordhuis) [#1815](https://github.com/nodejs/node/pull/1815) * [[`5b6f575c1f`](https://github.com/nodejs/node/commit/5b6f575c1f)] - ***Revert*** "**src**: add getopt option parser" (Evan Lucas) [#1862](https://github.com/nodejs/node/pull/1862) * [[`c0e7bf2d8c`](https://github.com/nodejs/node/commit/c0e7bf2d8c)] - **src**: add getopt option parser (Evan Lucas) [#1804](https://github.com/nodejs/node/pull/1804) * [[`8ea6844d26`](https://github.com/nodejs/node/commit/8ea6844d26)] - **test**: add test for failed save in REPL (Rich Trott) [#1818](https://github.com/nodejs/node/pull/1818) * [[`03ce84dfa1`](https://github.com/nodejs/node/commit/03ce84dfa1)] - **test**: fix cluster-worker-wait-server-close races (Sam Roberts) [#1953](https://github.com/nodejs/node/pull/1953) * [[`a6b8ee19b8`](https://github.com/nodejs/node/commit/a6b8ee19b8)] - **test**: create temp dir in common.js (Rich Trott) [#1877](https://github.com/nodejs/node/pull/1877) * [[`ff8202c6f4`](https://github.com/nodejs/node/commit/ff8202c6f4)] - **test**: fix undeclared variable access (Roman Reiss) [#1794](https://github.com/nodejs/node/pull/1794) * [[`d9ddd7d345`](https://github.com/nodejs/node/commit/d9ddd7d345)] - **test**: remove TODO comment (Rich Trott) [#1820](https://github.com/nodejs/node/pull/1820) * [[`6537fd4b55`](https://github.com/nodejs/node/commit/6537fd4b55)] - **test**: remove TODO (Rich Trott) [#1875](https://github.com/nodejs/node/pull/1875) * [[`a804026c9b`](https://github.com/nodejs/node/commit/a804026c9b)] - **test**: fix broken FreeBSD test (Santiago Gimeno) [#1881](https://github.com/nodejs/node/pull/1881) * [[`43a82f8a71`](https://github.com/nodejs/node/commit/43a82f8a71)] - **test**: fix test-sync-io-option (Evan Lucas) [#1840](https://github.com/nodejs/node/pull/1840) * [[`4ed25f664d`](https://github.com/nodejs/node/commit/4ed25f664d)] - **test**: add -no_rand_screen for tls-server-verify (Shigeki Ohtsu) [#1836](https://github.com/nodejs/node/pull/1836) * [[`4cf323d23d`](https://github.com/nodejs/node/commit/4cf323d23d)] - **test**: kill child in tls-server-verify for speed up (Shigeki Ohtsu) [#1836](https://github.com/nodejs/node/pull/1836) * [[`e6ccdcc1fe`](https://github.com/nodejs/node/commit/e6ccdcc1fe)] - **test**: improve console output of tls-server-verify (João Reis) [#1836](https://github.com/nodejs/node/pull/1836) * [[`975e5956f0`](https://github.com/nodejs/node/commit/975e5956f0)] - **test**: run tls-server-verify servers in parallel (João Reis) [#1836](https://github.com/nodejs/node/pull/1836) * [[`b18604ba2c`](https://github.com/nodejs/node/commit/b18604ba2c)] - **test**: running tls-server-verify clients in parallel (João Reis) [#1836](https://github.com/nodejs/node/pull/1836) * [[`f78c722df5`](https://github.com/nodejs/node/commit/f78c722df5)] - **test**: remove hardwired references to 'iojs' (Rod Vagg) [#1882](https://github.com/nodejs/node/pull/1882) * [[`bd99e8de8e`](https://github.com/nodejs/node/commit/bd99e8de8e)] - **test**: more test coverage for maxConnections (Rich Trott) [#1855](https://github.com/nodejs/node/pull/1855) * [[`b9267189a5`](https://github.com/nodejs/node/commit/b9267189a5)] - **test**: fix test-child-process-stdout-flush-exit (Santiago Gimeno) [#1868](https://github.com/nodejs/node/pull/1868) * [[`d20f018dcf`](https://github.com/nodejs/node/commit/d20f018dcf)] - **test**: loosen condition to detect infinite loop (Yosuke Furukawa) [#1857](https://github.com/nodejs/node/pull/1857) * [[`e0e96acc6f`](https://github.com/nodejs/node/commit/e0e96acc6f)] - **test**: remove smalloc add-on test (Ben Noordhuis) [#1835](https://github.com/nodejs/node/pull/1835) * [[`8704c58fc4`](https://github.com/nodejs/node/commit/8704c58fc4)] - **test**: remove unneeded comment task (Rich Trott) [#1858](https://github.com/nodejs/node/pull/1858) * [[`8732977536`](https://github.com/nodejs/node/commit/8732977536)] - **tls**: fix references to undefined `cb` (Fedor Indutny) [#1951](https://github.com/nodejs/node/pull/1951) * [[`75930bb38c`](https://github.com/nodejs/node/commit/75930bb38c)] - **tls**: prevent use-after-free (Fedor Indutny) [#1702](https://github.com/nodejs/node/pull/1702) * [[`5795e835a1`](https://github.com/nodejs/node/commit/5795e835a1)] - **tls**: emit errors on close whilst async action (Fedor Indutny) [#1702](https://github.com/nodejs/node/pull/1702) * [[`59d9734e21`](https://github.com/nodejs/node/commit/59d9734e21)] - **tls_wrap**: invoke queued callbacks in DestroySSL (Fedor Indutny) [#1702](https://github.com/nodejs/node/pull/1702) * [[`6e4d30286d`](https://github.com/nodejs/node/commit/6e4d30286d)] - **tools**: enable/add additional eslint rules (Roman Reiss) [#1794](https://github.com/nodejs/node/pull/1794) * [[`098354a9f8`](https://github.com/nodejs/node/commit/098354a9f8)] - **tools**: update certdata.txt (Ben Noordhuis) [#1833](https://github.com/nodejs/node/pull/1833) * [[`a2d921d6a0`](https://github.com/nodejs/node/commit/a2d921d6a0)] - **tools**: customize mk-ca-bundle.pl (Ben Noordhuis) [#1833](https://github.com/nodejs/node/pull/1833) * [[`5be9efca40`](https://github.com/nodejs/node/commit/5be9efca40)] - **tools**: update mk-ca-bundle.pl to HEAD of upstream (Ben Noordhuis) [#1833](https://github.com/nodejs/node/pull/1833) * [[`1baba0580d`](https://github.com/nodejs/node/commit/1baba0580d)] - **tools**: Fix copying contents of deps/npm (thefourtheye) [#1853](https://github.com/nodejs/node/pull/1853) * [[`628845b816`](https://github.com/nodejs/node/commit/628845b816)] - **(SEMVER-MINOR)** **util**: introduce `printDeprecationMessage` function (Vladimir Kurchatkin) [#1822](https://github.com/nodejs/node/pull/1822) * [[`91d0a8b19c`](https://github.com/nodejs/node/commit/91d0a8b19c)] - **win,node-gyp**: enable delay-load hook by default (Bert Belder) [iojs/io.js#1433](https://github.com/iojs/io.js/pull/1433) ## 2015-06-01, Version 2.2.1, @rvagg ### Notable changes * **http**: Reverts the move of the `client` property of `IncomingMessage` to its prototype. Although undocumented, this property was used and assumed to be an "own property" in the wild, most notably by [request](https://github.com/request/request) which is used by npm. (Michaël Zasso) [#1852](https://github.com/nodejs/node/pull/1852). ### Known issues See https://github.com/nodejs/node/labels/confirmed-bug for complete and current list of known issues. * Some problems with unreferenced timers running during `beforeExit` are still to be resolved. See [#1264](https://github.com/nodejs/node/issues/1264). * Surrogate pair in REPL can freeze terminal [#690](https://github.com/nodejs/node/issues/690) * `process.send()` is not synchronous as the docs suggest, a regression introduced in 1.0.2, see [#760](https://github.com/nodejs/node/issues/760) and fix in [#774](https://github.com/nodejs/node/issues/774) * Calling `dns.setServers()` while a DNS query is in progress can cause the process to crash on a failed assertion [#894](https://github.com/nodejs/node/issues/894) * `url.resolve` may transfer the auth portion of the url when resolving between two full hosts, see [#1435](https://github.com/nodejs/node/issues/1435). ### Commits * [[`c5a1009903`](https://github.com/nodejs/node/commit/c5a1009903)] - **build**: avoid passing empty strings to build flags (Johan Bergström) [#1789](https://github.com/nodejs/node/pull/1789) * [[`5d83401086`](https://github.com/nodejs/node/commit/5d83401086)] - **doc**: put SEMVER-MINOR on pre-load module fix 2.2.0 (Rod Vagg) * [[`4d6b768e5d`](https://github.com/nodejs/node/commit/4d6b768e5d)] - **http**: revert deprecation of client property (Michaël Zasso) [#1852](https://github.com/nodejs/node/pull/1852) ## 2015-05-31, Version 2.2.0, @rvagg ### Notable changes * **node**: Speed-up `require()` by replacing usage of `fs.statSync()` and `fs.readFileSync()` with internal variants that are faster for this use-case and do not create as many objects for the garbage collector to clean up. The primary two benefits are: significant increase in application start-up time on typical applications and better start-up time for the debugger by eliminating almost all of the thousands of exception events. (Ben Noordhuis) [#1801](https://github.com/nodejs/node/pull/1801). * **node**: Resolution of pre-load modules (`-r` or `--require`) now follows the standard `require()` rules rather than just resolving paths, so you can now pre-load modules in node_modules. (Ali Ijaz Sheikh) [#1812](https://github.com/nodejs/node/pull/1812). * **npm**: Upgraded npm to v2.11.0. New hooks for `preversion`, `version`, and `postversion` lifecycle events, some SPDX-related license changes and license file inclusions. See the [release notes](https://github.com/npm/npm/releases/tag/v2.11.0) for full details. ### Known issues See https://github.com/nodejs/node/labels/confirmed-bug for complete and current list of known issues. * Some problems with unreferenced timers running during `beforeExit` are still to be resolved. See [#1264](https://github.com/nodejs/node/issues/1264). * Surrogate pair in REPL can freeze terminal [#690](https://github.com/nodejs/node/issues/690) * `process.send()` is not synchronous as the docs suggest, a regression introduced in 1.0.2, see [#760](https://github.com/nodejs/node/issues/760) and fix in [#774](https://github.com/nodejs/node/issues/774) * Calling `dns.setServers()` while a DNS query is in progress can cause the process to crash on a failed assertion [#894](https://github.com/nodejs/node/issues/894) * `url.resolve` may transfer the auth portion of the url when resolving between two full hosts, see [#1435](https://github.com/nodejs/node/issues/1435). ### Commits * [[`a77c330c32`](https://github.com/nodejs/node/commit/a77c330c32)] - **(SEMVER-MINOR)** **child_process**: expose ChildProcess constructor (Evan Lucas) [#1760](https://github.com/nodejs/node/pull/1760) * [[`3a1bc067d4`](https://github.com/nodejs/node/commit/3a1bc067d4)] - ***Revert*** "**core**: set PROVIDER type as Persistent class id" (Ben Noordhuis) [#1827](https://github.com/nodejs/node/pull/1827) * [[`f9fd554500`](https://github.com/nodejs/node/commit/f9fd554500)] - **deps**: make node-gyp work with io.js (cjihrig) [iojs/io.js#990](https://github.com/iojs/io.js/pull/990) * [[`c1afa53648`](https://github.com/nodejs/node/commit/c1afa53648)] - **deps**: upgrade npm to 2.11.0 (Forrest L Norvell) [iojs/io.js#1829](https://github.com/iojs/io.js/pull/1829) * [[`ff794498e7`](https://github.com/nodejs/node/commit/ff794498e7)] - **doc**: `fs.*File()` also accept encoding strings (Rich Trott) [#1806](https://github.com/nodejs/node/pull/1806) * [[`98649fd31a`](https://github.com/nodejs/node/commit/98649fd31a)] - **doc**: add documentation for AtExit hook (Steve Sharp) [#1014](https://github.com/nodejs/node/pull/1014) * [[`eb1856dfd1`](https://github.com/nodejs/node/commit/eb1856dfd1)] - **doc**: clarify stability of fs.watch and relatives (Rich Trott) [#1775](https://github.com/nodejs/node/pull/1775) * [[`a74c2c9458`](https://github.com/nodejs/node/commit/a74c2c9458)] - **doc**: state url decoding behavior (Josh Gummersall) [#1731](https://github.com/nodejs/node/pull/1731) * [[`ba76a9d872`](https://github.com/nodejs/node/commit/ba76a9d872)] - **doc**: remove bad semver-major entry from CHANGELOG (Rod Vagg) [#1782](https://github.com/nodejs/node/pull/1782) * [[`a6a3f8c78d`](https://github.com/nodejs/node/commit/a6a3f8c78d)] - **doc**: fix changelog s/2.0.3/2.1.0 (Rod Vagg) * [[`2c686fd3ce`](https://github.com/nodejs/node/commit/2c686fd3ce)] - **http**: flush stored header (Vladimir Kurchatkin) [#1695](https://github.com/nodejs/node/pull/1695) * [[`1eec5f091a`](https://github.com/nodejs/node/commit/1eec5f091a)] - **http**: simplify code and remove unused properties (Brian White) [#1572](https://github.com/nodejs/node/pull/1572) * [[`1bbf8d0720`](https://github.com/nodejs/node/commit/1bbf8d0720)] - **lib**: speed up require(), phase 2 (Ben Noordhuis) [#1801](https://github.com/nodejs/node/pull/1801) * [[`b14fd1a720`](https://github.com/nodejs/node/commit/b14fd1a720)] - **lib**: speed up require(), phase 1 (Ben Noordhuis) [#1801](https://github.com/nodejs/node/pull/1801) * [[`5abd4ac079`](https://github.com/nodejs/node/commit/5abd4ac079)] - **lib**: simplify nextTick() usage (Brian White) [#1612](https://github.com/nodejs/node/pull/1612) * [[`5759722cfa`](https://github.com/nodejs/node/commit/5759722cfa)] - **(SEMVER-MINOR)** **src**: fix module search path for preload modules (Ali Ijaz Sheikh) [#1812](https://github.com/nodejs/node/pull/1812) * [[`a65762cab6`](https://github.com/nodejs/node/commit/a65762cab6)] - **src**: remove old code (Brendan Ashworth) [#1819](https://github.com/nodejs/node/pull/1819) * [[`93a44d5228`](https://github.com/nodejs/node/commit/93a44d5228)] - **src**: fix deferred events not working with -e (Ben Noordhuis) [#1793](https://github.com/nodejs/node/pull/1793) * [[`8059393934`](https://github.com/nodejs/node/commit/8059393934)] - **test**: check error type from net.Server.listen() (Rich Trott) [#1821](https://github.com/nodejs/node/pull/1821) * [[`4e90c82cdb`](https://github.com/nodejs/node/commit/4e90c82cdb)] - **test**: add heap profiler add-on regression test (Ben Noordhuis) [#1828](https://github.com/nodejs/node/pull/1828) * [[`6dfca71af0`](https://github.com/nodejs/node/commit/6dfca71af0)] - **test**: don't lint autogenerated test/addons/doc-*/ (Ben Noordhuis) [#1793](https://github.com/nodejs/node/pull/1793) * [[`c2b8b30836`](https://github.com/nodejs/node/commit/c2b8b30836)] - **test**: remove stray copyright notices (Ben Noordhuis) [#1793](https://github.com/nodejs/node/pull/1793) * [[`280fb01daf`](https://github.com/nodejs/node/commit/280fb01daf)] - **test**: fix deprecation warning in addons test (Ben Noordhuis) [#1793](https://github.com/nodejs/node/pull/1793) * [[`8606793999`](https://github.com/nodejs/node/commit/8606793999)] - **tools**: pass constant to logger instead of string (Johan Bergström) [#1842](https://github.com/nodejs/node/pull/1842) * [[`fbd2b59716`](https://github.com/nodejs/node/commit/fbd2b59716)] - **tools**: add objectLiteralShorthandProperties to .eslintrc (Evan Lucas) [#1760](https://github.com/nodejs/node/pull/1760) * [[`53e98cc1b4`](https://github.com/nodejs/node/commit/53e98cc1b4)] - **win,node-gyp**: enable delay-load hook by default (Bert Belder) [#1763](https://github.com/nodejs/node/pull/1763) ## 2015-05-24, Version 2.1.0, @rvagg ### Notable changes * **crypto**: Diffie-Hellman key exchange (DHE) parameters (`'dhparams'`) must now be 1024 bits or longer or an error will be thrown. A warning will also be printed to the console if you supply less than 2048 bits. See https://weakdh.org/ for further context on this security concern. (Shigeki Ohtsu) [#1739](https://github.com/nodejs/node/pull/1739). * **node**: A new `--trace-sync-io` command line flag will print a warning and a stack trace whenever a synchronous API is used. This can be used to track down synchronous calls that may be slowing down an application. (Trevor Norris) [#1707](https://github.com/nodejs/node/pull/1707). * **node**: To allow for chaining of methods, the `setTimeout()`, `setKeepAlive()`, `setNoDelay()`, `ref()` and `unref()` methods used in `'net'`, `'dgram'`, `'http'`, `'https'` and `'tls'` now return the current instance instead of `undefined` (Roman Reiss & Evan Lucas) [#1699](https://github.com/nodejs/node/pull/1699) [#1768](https://github.com/nodejs/node/pull/1768) [#1779](https://github.com/nodejs/node/pull/1779). * **npm**: Upgraded to v2.10.1, release notes can be found in and . * **util**: A significant speed-up (in the order of 35%) for the common-case of a single string argument to `util.format()`, used by `console.log()` (Сковорода Никита Андреевич) [#1749](https://github.com/nodejs/node/pull/1749). ### Known issues See https://github.com/nodejs/node/labels/confirmed-bug for complete and current list of known issues. * Some problems with unreferenced timers running during `beforeExit` are still to be resolved. See [#1264](https://github.com/nodejs/node/issues/1264). * Surrogate pair in REPL can freeze terminal [#690](https://github.com/nodejs/node/issues/690) * `process.send()` is not synchronous as the docs suggest, a regression introduced in 1.0.2, see [#760](https://github.com/nodejs/node/issues/760) and fix in [#774](https://github.com/nodejs/node/issues/774) * Calling `dns.setServers()` while a DNS query is in progress can cause the process to crash on a failed assertion [#894](https://github.com/nodejs/node/issues/894) * `url.resolve` may transfer the auth portion of the url when resolving between two full hosts, see [#1435](https://github.com/nodejs/node/issues/1435). ### Commits * [[`9da168b71f`](https://github.com/nodejs/node/commit/9da168b71f)] - **buffer**: optimize Buffer.byteLength (Brendan Ashworth) [#1713](https://github.com/nodejs/node/pull/1713) * [[`2b1c01c2cc`](https://github.com/nodejs/node/commit/2b1c01c2cc)] - **build**: refactor pkg-config for shared libraries (Johan Bergström) [#1603](https://github.com/nodejs/node/pull/1603) * [[`3c44100558`](https://github.com/nodejs/node/commit/3c44100558)] - **core**: set PROVIDER type as Persistent class id (Trevor Norris) [#1730](https://github.com/nodejs/node/pull/1730) * [[`c1de6d249e`](https://github.com/nodejs/node/commit/c1de6d249e)] - **(SEMVER-MINOR)** **core**: implement runtime flag to trace sync io (Trevor Norris) [#1707](https://github.com/nodejs/node/pull/1707) * [[`9e7099fa4e`](https://github.com/nodejs/node/commit/9e7099fa4e)] - **deps**: make node-gyp work with io.js (cjihrig) [iojs/io.js#990](https://github.com/iojs/io.js/pull/990) * [[`c54d057598`](https://github.com/nodejs/node/commit/c54d057598)] - **deps**: upgrade to npm 2.10.1 (Rebecca Turner) [#1763](https://github.com/nodejs/node/pull/1763) * [[`367ffd167d`](https://github.com/nodejs/node/commit/367ffd167d)] - **doc**: update AUTHORS list (Rod Vagg) [#1776](https://github.com/nodejs/node/pull/1776) * [[`2bb2f06b3e`](https://github.com/nodejs/node/commit/2bb2f06b3e)] - **doc**: fix typo in CONTRIBUTING.md (Rich Trott) [#1755](https://github.com/nodejs/node/pull/1755) * [[`515afc6367`](https://github.com/nodejs/node/commit/515afc6367)] - **doc**: path is ignored in url.format (Maurice Butler) [#1753](https://github.com/nodejs/node/pull/1753) * [[`f0a8bc3f84`](https://github.com/nodejs/node/commit/f0a8bc3f84)] - **doc**: fix spelling in CHANGELOG (Felipe Batista) * [[`86dd244d9b`](https://github.com/nodejs/node/commit/86dd244d9b)] - **doc**: add notes to child_process.fork() and .exec() (Rich Trott) [#1718](https://github.com/nodejs/node/pull/1718) * [[`066274794c`](https://github.com/nodejs/node/commit/066274794c)] - **doc**: update links from iojs/io.js to nodejs/io.js (Frederic Hemberger) [#1715](https://github.com/nodejs/node/pull/1715) * [[`cb381fe3e0`](https://github.com/nodejs/node/commit/cb381fe3e0)] - **(SEMVER-MINOR)** **net**: return this from setNoDelay and setKeepAlive (Roman Reiss) [#1779](https://github.com/nodejs/node/pull/1779) * [[`85d9983009`](https://github.com/nodejs/node/commit/85d9983009)] - **net**: persist net.Socket options before connect (Evan Lucas) [#1518](https://github.com/nodejs/node/pull/1518) * [[`39dde3222e`](https://github.com/nodejs/node/commit/39dde3222e)] - **(SEMVER-MINOR)** **net,dgram**: return this from ref and unref methods (Roman Reiss) [#1768](https://github.com/nodejs/node/pull/1768) * [[`5773438913`](https://github.com/nodejs/node/commit/5773438913)] - **test**: fix jslint error (Michaël Zasso) [#1743](https://github.com/nodejs/node/pull/1743) * [[`867631986f`](https://github.com/nodejs/node/commit/867631986f)] - **test**: fix test-sync-io-option (Santiago Gimeno) [#1734](https://github.com/nodejs/node/pull/1734) * [[`f29762f4dd`](https://github.com/nodejs/node/commit/f29762f4dd)] - **test**: enable linting for tests (Roman Reiss) [#1721](https://github.com/nodejs/node/pull/1721) * [[`2a71f02988`](https://github.com/nodejs/node/commit/2a71f02988)] - **tls**: emit errors happening before handshake finish (Malte-Thorben Bruns) [#1769](https://github.com/nodejs/node/pull/1769) * [[`80342f649d`](https://github.com/nodejs/node/commit/80342f649d)] - **tls**: use `.destroy(err)` instead of destroy+emit (Fedor Indutny) [#1711](https://github.com/nodejs/node/pull/1711) * [[`9b35be5810`](https://github.com/nodejs/node/commit/9b35be5810)] - **tls**: make server not use DHE in less than 1024bits (Shigeki Ohtsu) [#1739](https://github.com/nodejs/node/pull/1739) * [[`214d02040e`](https://github.com/nodejs/node/commit/214d02040e)] - **util**: speed up common case of formatting string (Сковорода Никита Андреевич) [#1749](https://github.com/nodejs/node/pull/1749) * [[`d144e96fbf`](https://github.com/nodejs/node/commit/d144e96fbf)] - **win,node-gyp**: enable delay-load hook by default (Bert Belder) [#1763](https://github.com/nodejs/node/pull/1763) * [[`0d6d3dda95`](https://github.com/nodejs/node/commit/0d6d3dda95)] - **win,node-gyp**: make delay-load hook C89 compliant (Sharat M R) [TooTallNate/node-gyp#616](https://github.com/TooTallNate/node-gyp/pull/616) ## 2015-05-22, Version 0.12.4 (Stable) ### Commits * [[`202c18bbc3`](https://github.com/nodejs/node/commit/202c18bbc3)] - **npm**: upgrade to 2.10.1 [#25364](https://github.com/joyent/node/pull/25364) * [[`6157697bd5`](https://github.com/nodejs/node/commit/6157697bd5)] - **V8**: revert v8 Array.prototype.values() removal (cjihrig) [#25328](https://github.com/joyent/node/pull/25328) * [[`3122052890`](https://github.com/nodejs/node/commit/3122052890)] - **win**: bring back xp/2k3 support (Bert Belder) [#25367](https://github.com/joyent/node/pull/25367) ## 2015-05-15, Version 2.0.2, @Fishrock123 ### Notable changes * **win,node-gyp**: the delay-load hook for windows addons has now been correctly enabled by default, it had wrongly defaulted to off in the release version of 2.0.0 (Bert Belder) [#1433](https://github.com/nodejs/node/pull/1433) * **os**: `tmpdir()`'s trailing slash stripping has been refined to fix an issue when the temp directory is at '/'. Also considers which slash is used by the operating system. (cjihrig) [#1673](https://github.com/nodejs/node/pull/1673) * **tls**: default ciphers have been updated to use gcm and aes128 (Mike MacCana) [#1660](https://github.com/nodejs/node/pull/1660) * **build**: v8 snapshots have been re-enabled by default as suggested by the v8 team, since prior security issues have been resolved. This should give some perf improvements to both startup and vm context creation. (Trevor Norris) [#1663](https://github.com/nodejs/node/pull/1663) * **src**: fixed preload modules not working when other flags were used before `--require` (Yosuke Furukawa) [#1694](https://github.com/nodejs/node/pull/1694) * **dgram**: fixed `send()`'s callback not being asynchronous (Yosuke Furukawa) [#1313](https://github.com/nodejs/node/pull/1313) * **readline**: emitKeys now keeps buffering data until it has enough to parse. This fixes an issue with parsing split escapes. (Alex Kocharin) [#1601](https://github.com/nodejs/node/pull/1601) * **cluster**: works now properly emit 'disconnect' to `cluser.worker` (Oleg Elifantiev) [#1386](https://github.com/nodejs/node/pull/1386) * **events**: uncaught errors now provide some context (Evan Lucas) [#1654](https://github.com/nodejs/node/pull/1654) ### Known issues See https://github.com/nodejs/node/labels/confirmed-bug for complete and current list of known issues. * Some problems with unreferenced timers running during `beforeExit` are still to be resolved. See [#1264](https://github.com/nodejs/node/issues/1264). * Surrogate pair in REPL can freeze terminal [#690](https://github.com/nodejs/node/issues/690) * `process.send()` is not synchronous as the docs suggest, a regression introduced in 1.0.2, see [#760](https://github.com/nodejs/node/issues/760) and fix in [#774](https://github.com/nodejs/node/issues/774) * Calling `dns.setServers()` while a DNS query is in progress can cause the process to crash on a failed assertion [#894](https://github.com/nodejs/node/issues/894) * `url.resolve` may transfer the auth portion of the url when resolving between two full hosts, see [#1435](https://github.com/nodejs/node/issues/1435). ### Commits * [[`8a0e5295b4`](https://github.com/nodejs/node/commit/8a0e5295b4)] - **build**: use backslashes for paths on windows (Johan Bergström) [#1698](https://github.com/nodejs/node/pull/1698) * [[`20c9a52227`](https://github.com/nodejs/node/commit/20c9a52227)] - **build**: move --with-intl to intl optgroup (Johan Bergström) [#1680](https://github.com/nodejs/node/pull/1680) * [[`36cdc7c8ac`](https://github.com/nodejs/node/commit/36cdc7c8ac)] - **build**: re-enable V8 snapshots (Trevor Norris) [#1663](https://github.com/nodejs/node/pull/1663) * [[`5883a59b21`](https://github.com/nodejs/node/commit/5883a59b21)] - **cluster**: disconnect event not emitted correctly (Oleg Elifantiev) [#1386](https://github.com/nodejs/node/pull/1386) * [[`0f850f7ae7`](https://github.com/nodejs/node/commit/0f850f7ae7)] - **deps**: provide TXT chunk info in c-ares (Fedor Indutny) * [[`7e1c0e75ed`](https://github.com/nodejs/node/commit/7e1c0e75ed)] - **deps**: sync with upstream bagder/c-ares@bba4dc5 (Ben Noordhuis) [#1678](https://github.com/nodejs/node/pull/1678) * [[`18d457bd34`](https://github.com/nodejs/node/commit/18d457bd34)] - **dgram**: call send callback asynchronously (Yosuke Furukawa) [#1313](https://github.com/nodejs/node/pull/1313) * [[`8b9a1537ad`](https://github.com/nodejs/node/commit/8b9a1537ad)] - **events**: provide better error message for unhandled error (Evan Lucas) [#1654](https://github.com/nodejs/node/pull/1654) * [[`19ffb5cf1c`](https://github.com/nodejs/node/commit/19ffb5cf1c)] - **lib**: fix eslint styles (Yosuke Furukawa) [#1539](https://github.com/nodejs/node/pull/1539) * [[`76937051f8`](https://github.com/nodejs/node/commit/76937051f8)] - **os**: refine tmpdir() trailing slash stripping (cjihrig) [#1673](https://github.com/nodejs/node/pull/1673) * [[`aed6bce906`](https://github.com/nodejs/node/commit/aed6bce906)] - **readline**: turn emitKeys into a streaming parser (Alex Kocharin) [#1601](https://github.com/nodejs/node/pull/1601) * [[`0a461e5360`](https://github.com/nodejs/node/commit/0a461e5360)] - **src**: fix preload when used with prior flags (Yosuke Furukawa) [#1694](https://github.com/nodejs/node/pull/1694) * [[`931a0d4634`](https://github.com/nodejs/node/commit/931a0d4634)] - **src**: add type check to v8.setFlagsFromString() (Roman Klauke) [#1652](https://github.com/nodejs/node/pull/1652) * [[`08d08668c9`](https://github.com/nodejs/node/commit/08d08668c9)] - **src,deps**: replace LoadLibrary by LoadLibraryW (Cheng Zhao) [#226](https://github.com/nodejs/node/pull/226) * [[`4e2f999a62`](https://github.com/nodejs/node/commit/4e2f999a62)] - **test**: fix infinite loop detection (Yosuke Furukawa) [#1681](https://github.com/nodejs/node/pull/1681) * [[`5755fc099f`](https://github.com/nodejs/node/commit/5755fc099f)] - **tls**: update default ciphers to use gcm and aes128 (Mike MacCana) [#1660](https://github.com/nodejs/node/pull/1660) * [[`966acb9916`](https://github.com/nodejs/node/commit/966acb9916)] - **tools**: remove closure_linter to eslint on windows (Yosuke Furukawa) [#1685](https://github.com/nodejs/node/pull/1685) * [[`c58264e58b`](https://github.com/nodejs/node/commit/c58264e58b)] - **tools**: make eslint work on subdirectories (Roman Reiss) [#1686](https://github.com/nodejs/node/pull/1686) * [[`0b21ab13b7`](https://github.com/nodejs/node/commit/0b21ab13b7)] - **tools**: refactor `make test-npm` into test-npm.sh (Jeremiah Senkpiel) [#1662](https://github.com/nodejs/node/pull/1662) * [[`f07b3b600b`](https://github.com/nodejs/node/commit/f07b3b600b)] - **tools**: set eslint comma-spacing to 'warn' (Roman Reiss) [#1672](https://github.com/nodejs/node/pull/1672) * [[`f9dd34d301`](https://github.com/nodejs/node/commit/f9dd34d301)] - **tools**: replace closure-linter with eslint (Yosuke Furukawa) [#1539](https://github.com/nodejs/node/pull/1539) * [[`64d3210c98`](https://github.com/nodejs/node/commit/64d3210c98)] - **win,node-gyp**: enable delay-load hook by default (Bert Belder) [#1667](https://github.com/nodejs/node/issues/1667) ## 2015-05-13, Version 0.12.3 (Stable) ### Commits * [[`32166a90cf`](https://github.com/nodejs/node/commit/32166a90cf)] - **V8**: update to 3.28.71.19 [#18206](https://github.com/joyent/node/pull/18206) * [[`84f1ab6114`](https://github.com/nodejs/node/commit/84f1ab6114)] - **uv**: upgrade to 1.5.0 [#25141](https://github.com/joyent/node/pull/25141) * [[`03cfbd65fb`](https://github.com/nodejs/node/commit/03cfbd65fb)] - **npm**: upgrade to 2.9.1 [#25289](https://github.com/joyent/node/pull/25289) * [[`80cdae855f`](https://github.com/nodejs/node/commit/80cdae855f)] - **V8**: don't busy loop in v8 cpu profiler thread (Mike Tunnicliffe) [#25268](https://github.com/joyent/node/pull/25268) * [[`2a5f4bd7ce`](https://github.com/nodejs/node/commit/2a5f4bd7ce)] - **V8**: fix issue with let bindings in for loops (adamk) [#23948](https://github.com/joyent/node/pull/23948) * [[`f0ef597e09`](https://github.com/nodejs/node/commit/f0ef597e09)] - **debugger**: don't spawn child process in remote mode (Jackson Tian) [#14172](https://github.com/joyent/node/pull/14172) * [[`0e392f3b68`](https://github.com/nodejs/node/commit/0e392f3b68)] - **net**: do not set V4MAPPED on FreeBSD (Julien Gilli) [#18204](https://github.com/joyent/node/pull/18204) * [[`101e103e3b`](https://github.com/nodejs/node/commit/101e103e3b)] - **repl**: make 'Unexpected token' errors recoverable (Julien Gilli) [#8875](https://github.com/joyent/node/pull/8875) * [[`d5b32246fb`](https://github.com/nodejs/node/commit/d5b32246fb)] - **src**: backport ignore ENOTCONN on shutdown race (Ben Noordhuis) [#14480](https://github.com/joyent/node/pull/14480) * [[`f99eaefe75`](https://github.com/nodejs/node/commit/f99eaefe75)] - **src**: fix backport of SIGINT crash fix on FreeBSD (Julien Gilli) [#14819](https://github.com/joyent/node/pull/14819) ## 2015-05-07, Version 2.0.1, @rvagg ### Notable changes * **async_wrap**: (Trevor Norris) [#1614](https://github.com/nodejs/node/pull/1614) - it is now possible to filter by providers - bit flags have been removed and replaced with method calls on the binding object - _note that this is an unstable API so feature additions and breaking changes won't change io.js semver_ * **libuv**: resolves numerous io.js issues: - [#862](https://github.com/nodejs/node/issues/862) prevent spawning child processes with invalid stdio file descriptors - [#1397](https://github.com/nodejs/node/issues/1397) fix EPERM error with fs.access(W_OK) on Windows - [#1621](https://github.com/nodejs/node/issues/1621) build errors associated with the bundled libuv - [#1512](https://github.com/nodejs/node/issues/1512) should properly fix Windows termination errors * **addons**: the `NODE_DEPRECATED` macro was causing problems when compiling addons with older compilers, this should now be resolved (Ben Noordhuis) [#1626](https://github.com/nodejs/node/pull/1626) * **V8**: upgrade V8 from 4.2.77.18 to 4.2.77.20 with minor fixes, including a bug preventing builds on FreeBSD ### Known issues See https://github.com/nodejs/node/labels/confirmed-bug for complete and current list of known issues. * Some problems with unreferenced timers running during `beforeExit` are still to be resolved. See [#1264](https://github.com/nodejs/node/issues/1264). * Surrogate pair in REPL can freeze terminal [#690](https://github.com/nodejs/node/issues/690) * `process.send()` is not synchronous as the docs suggest, a regression introduced in 1.0.2, see [#760](https://github.com/nodejs/node/issues/760) and fix in [#774](https://github.com/nodejs/node/issues/774) * Calling `dns.setServers()` while a DNS query is in progress can cause the process to crash on a failed assertion [#894](https://github.com/nodejs/node/issues/894) * `url.resolve` may transfer the auth portion of the url when resolving between two full hosts, see [#1435](https://github.com/nodejs/node/issues/1435). * readline: split escapes are processed incorrectly, see [#1403](https://github.com/nodejs/node/issues/1403) ### Commits * [[`7dde95a8bd`](https://github.com/nodejs/node/commit/7dde95a8bd)] - **async-wrap**: remove before/after calls in init (Trevor Norris) [#1614](https://github.com/nodejs/node/pull/1614) * [[`bd42ba056a`](https://github.com/nodejs/node/commit/bd42ba056a)] - **async-wrap**: set flags using functions (Trevor Norris) [#1614](https://github.com/nodejs/node/pull/1614) * [[`4b2c786449`](https://github.com/nodejs/node/commit/4b2c786449)] - **async-wrap**: pass PROVIDER as first arg to init (Trevor Norris) [#1614](https://github.com/nodejs/node/pull/1614) * [[`84bf609fd2`](https://github.com/nodejs/node/commit/84bf609fd2)] - **async-wrap**: don't call init callback unnecessarily (Trevor Norris) [#1614](https://github.com/nodejs/node/pull/1614) * [[`04cc03b029`](https://github.com/nodejs/node/commit/04cc03b029)] - **deps**: update libuv to 1.5.0 (Saúl Ibarra Corretgé) [#1646](https://github.com/nodejs/node/pull/1646) * [[`b16d9c28e8`](https://github.com/nodejs/node/commit/b16d9c28e8)] - **deps**: upgrade v8 to 4.2.77.20 (Ben Noordhuis) [#1639](https://github.com/nodejs/node/pull/1639) * [[`9ec3109272`](https://github.com/nodejs/node/commit/9ec3109272)] - **doc**: add TC meeting 2015-04-29 minutes (Rod Vagg) [#1585](https://github.com/nodejs/node/pull/1585) * [[`2c7206254c`](https://github.com/nodejs/node/commit/2c7206254c)] - **doc**: fix typo in readme.md (AQNOUCH Mohammed) [#1643](https://github.com/nodejs/node/pull/1643) * [[`71dc7152ee`](https://github.com/nodejs/node/commit/71dc7152ee)] - **doc**: fix PR link in CHANGELOG (Brian White) [#1624](https://github.com/nodejs/node/pull/1624) * [[`b97b96d05a`](https://github.com/nodejs/node/commit/b97b96d05a)] - **install**: fix NameError (thefourtheye) [#1628](https://github.com/nodejs/node/pull/1628) * [[`6ccbe75384`](https://github.com/nodejs/node/commit/6ccbe75384)] - **js_stream**: fix buffer index in DoWrite (Shigeki Ohtsu) [#1635](https://github.com/nodejs/node/pull/1635) * [[`c43855c49c`](https://github.com/nodejs/node/commit/c43855c49c)] - **src**: export the ParseEncoding function on Windows (Ivan Kozik) [#1596](https://github.com/nodejs/node/pull/1596) * [[`8315b22390`](https://github.com/nodejs/node/commit/8315b22390)] - **src**: fix pedantic cpplint whitespace warnings (Ben Noordhuis) [#1640](https://github.com/nodejs/node/pull/1640) * [[`b712af79a7`](https://github.com/nodejs/node/commit/b712af79a7)] - **src**: fix NODE_DEPRECATED macro with old compilers (Ben Noordhuis) [#1626](https://github.com/nodejs/node/pull/1626) * [[`2ed10f1349`](https://github.com/nodejs/node/commit/2ed10f1349)] - **src**: fix minor inefficiency in Buffer::New() call (Ben Noordhuis) [#1577](https://github.com/nodejs/node/pull/1577) * [[`f696c9efab`](https://github.com/nodejs/node/commit/f696c9efab)] - **src**: fix deprecated use of Buffer::New() (Ben Noordhuis) [#1577](https://github.com/nodejs/node/pull/1577) * [[`0c8f13df8f`](https://github.com/nodejs/node/commit/0c8f13df8f)] - **tools**: remove unused GuessWordSize function (thefourtheye) [#1638](https://github.com/nodejs/node/pull/1638) ## 2015-05-04, Version 2.0.0, @rvagg ### Breaking changes Full details at https://github.com/nodejs/node/wiki/Breaking-Changes#200-from-1x * V8 upgrade to 4.2, minor changes to C++ API * `os.tmpdir()` is now cross-platform consistent and no longer returns a path with a trailing slash on any platform * While not a *breaking change* the 'smalloc' module has been deprecated in anticipation of it becoming unsupportable with a future upgrade to V8 4.4. See [#1451](https://github.com/nodejs/node/issues/1451) for further information. _Note: a new version of the 'url' module was reverted prior to release as it was decided the potential for breakage across the npm ecosystem was too great and that more compatibility work needed to be done before releasing it. See [#1602](https://github.com/nodejs/node/pull/1602) for further information._ ### Notable changes * **crypto**: significantly reduced memory usage for TLS (Fedor Indutny & Сковорода Никита Андреевич) [#1529](https://github.com/nodejs/node/pull/1529) * **net**: `socket.connect()` now accepts a `'lookup'` option for a custom DNS resolution mechanism, defaults to `dns.lookup()` (Evan Lucas) [#1505](https://github.com/nodejs/node/pull/1505) * **npm**: Upgrade npm to 2.9.0. See the [v2.8.4](https://github.com/npm/npm/releases/tag/v2.8.4) and [v2.9.0](https://github.com/npm/npm/releases/tag/v2.9.0) release notes for details. Notable items: - Add support for default author field to make `npm init -y` work without user-input (@othiym23) [npm/npm/d8eee6cf9d](https://github.com/npm/npm/commit/d8eee6cf9d2ff7aca68dfaed2de76824a3e0d9af) - Include local modules in `npm outdated` and `npm update` (@ArnaudRinquin) [npm/npm#7426](https://github.com/npm/npm/issues/7426) - The prefix used before the version number on `npm version` is now configurable via `tag-version-prefix` (@kkragenbrink) [npm/npm#8014](https://github.com/npm/npm/issues/8014) * **os**: `os.tmpdir()` is now cross-platform consistent and will no longer returns a path with a trailing slash on any platform (Christian Tellnes) [#747](https://github.com/nodejs/node/pull/747) * **process**: - `process.nextTick()` performance has been improved by between 2-42% across the benchmark suite, notable because this is heavily used across core (Brian White) [#1571](https://github.com/nodejs/node/pull/1571) - New `process.geteuid()`, `process.seteuid(id)`, `process.getegid()` and `process.setegid(id)` methods allow you to get and set effective UID and GID of the process (Evan Lucas) [#1536](https://github.com/nodejs/node/pull/1536) * **repl**: - REPL history can be persisted across sessions if the `NODE_REPL_HISTORY_FILE` environment variable is set to a user accessible file, `NODE_REPL_HISTORY_SIZE` can set the maximum history size and defaults to `1000` (Chris Dickinson) [#1513](https://github.com/nodejs/node/pull/1513) - The REPL can be placed in to one of three modes using the `NODE_REPL_MODE` environment variable: `sloppy`, `strict` or `magic` (default); the new `magic` mode will automatically run "strict mode only" statements in strict mode (Chris Dickinson) [#1513](https://github.com/nodejs/node/pull/1513) * **smalloc**: the 'smalloc' module has been deprecated due to changes coming in V8 4.4 that will render it unusable * **util**: add Promise, Map and Set inspection support (Christopher Monsanto) [#1471](https://github.com/nodejs/node/pull/1471) * **V8**: upgrade to 4.2.77.18, see the [ChangeLog](https://chromium.googlesource.com/v8/v8/+/refs/heads/4.2.77/ChangeLog) for full details. Notable items: - Classes have moved out of staging; the `class` keyword is now usable in strict mode without flags - Object literal enhancements have moved out of staging; shorthand method and property syntax is now usable (`{ method() { }, property }`) - Rest parameters (`function(...args) {}`) are implemented in staging behind the `--harmony-rest-parameters` flag - Computed property names (`{['foo'+'bar']:'bam'}`) are implemented in staging behind the `--harmony-computed-property-names` flag - Unicode escapes (`'\u{xxxx}'`) are implemented in staging behind the `--harmony_unicode` flag and the `--harmony_unicode_regexps` flag for use in regular expressions * **Windows**: - Random process termination on Windows fixed (Fedor Indutny) [#1512](https://github.com/nodejs/node/issues/1512) / [#1563](https://github.com/nodejs/node/pull/1563) - The delay-load hook introduced to fix issues with process naming (iojs.exe / node.exe) has been made opt-out for native add-ons. Native add-ons should include `'win_delay_load_hook': 'false'` in their binding.gyp to disable this feature if they experience problems . (Bert Belder) [#1433](https://github.com/nodejs/node/pull/1433) * **Governance**: - Rod Vagg (@rvagg) was added to the Technical Committee (TC) - Jeremiah Senkpiel (@Fishrock123) was added to the Technical Committee (TC) ### Known issues See https://github.com/nodejs/node/labels/confirmed-bug for complete and current list of known issues. * Some problems with unreferenced timers running during `beforeExit` are still to be resolved. See [#1264](https://github.com/nodejs/node/issues/1264). * Surrogate pair in REPL can freeze terminal [#690](https://github.com/nodejs/node/issues/690) * `process.send()` is not synchronous as the docs suggest, a regression introduced in 1.0.2, see [#760](https://github.com/nodejs/node/issues/760) and fix in [#774](https://github.com/nodejs/node/issues/774) * Calling `dns.setServers()` while a DNS query is in progress can cause the process to crash on a failed assertion [#894](https://github.com/nodejs/node/issues/894) * `url.resolve` may transfer the auth portion of the url when resolving between two full hosts, see [#1435](https://github.com/nodejs/node/issues/1435). * readline: split escapes are processed incorrectly, see [#1403](https://github.com/nodejs/node/issues/1403) ### Commits * [[`5404cbc745`](https://github.com/nodejs/node/commit/5404cbc745)] - **buffer**: fix copy() segfault with zero arguments (Trevor Norris) [#1520](https://github.com/nodejs/node/pull/1520) * [[`3d3083b91f`](https://github.com/nodejs/node/commit/3d3083b91f)] - **buffer**: little improve for Buffer.concat method (Jackson Tian) [#1437](https://github.com/nodejs/node/pull/1437) * [[`e67542ae17`](https://github.com/nodejs/node/commit/e67542ae17)] - **build**: disable -Og when building with clang (Ben Noordhuis) [#1609](https://github.com/nodejs/node/pull/1609) * [[`78f4b038f8`](https://github.com/nodejs/node/commit/78f4b038f8)] - **build**: turn on debug-safe optimizations with -Og (Ben Noordhuis) [#1569](https://github.com/nodejs/node/pull/1569) * [[`a5dcff827a`](https://github.com/nodejs/node/commit/a5dcff827a)] - **build**: Use option groups in configure output (Johan Bergström) [#1533](https://github.com/nodejs/node/pull/1533) * [[`2a3c8c187e`](https://github.com/nodejs/node/commit/2a3c8c187e)] - **build**: remove -J from test-ci (Rod Vagg) [#1544](https://github.com/nodejs/node/pull/1544) * [[`e6874dd0f9`](https://github.com/nodejs/node/commit/e6874dd0f9)] - **crypto**: track external memory for SSL structures (Fedor Indutny) [#1529](https://github.com/nodejs/node/pull/1529) * [[`935c9d3fa7`](https://github.com/nodejs/node/commit/935c9d3fa7)] - **deps**: make node-gyp work with io.js (cjihrig) [#990](https://github.com/nodejs/node/pull/990) * [[`56e4255382`](https://github.com/nodejs/node/commit/56e4255382)] - **deps**: upgrade npm to 2.9.0 (Forrest L Norvell) [#1573](https://github.com/nodejs/node/pull/1573) * [[`509b59ea7c`](https://github.com/nodejs/node/commit/509b59ea7c)] - **deps**: enable v8 postmortem debugging again (Ben Noordhuis) [#1232](https://github.com/nodejs/node/pull/1232) * [[`01652c7709`](https://github.com/nodejs/node/commit/01652c7709)] - **deps**: upgrade v8 to 4.2.77.18 (Chris Dickinson) [#1506](https://github.com/nodejs/node/pull/1506) * [[`01e6632d70`](https://github.com/nodejs/node/commit/01e6632d70)] - **deps**: upgrade v8 to 4.2.77.15 (Ben Noordhuis) [#1399](https://github.com/nodejs/node/pull/1399) * [[`db4ded5903`](https://github.com/nodejs/node/commit/db4ded5903)] - **deps**: enable v8 postmortem debugging again (Ben Noordhuis) [#1232](https://github.com/nodejs/node/pull/1232) * [[`36cd5fb9d2`](https://github.com/nodejs/node/commit/36cd5fb9d2)] - **(SEMVER-MAJOR)** **deps**: upgrade v8 to 4.2.77.13 (Ben Noordhuis) [#1232](https://github.com/nodejs/node/pull/1232) * [[`b3a7da1091`](https://github.com/nodejs/node/commit/b3a7da1091)] - **deps**: update http_parser to 2.5.0 (Fedor Indutny) [#1517](https://github.com/nodejs/node/pull/1517) * [[`ac1fb39ce8`](https://github.com/nodejs/node/commit/ac1fb39ce8)] - **doc**: add rvagg to the TC (Rod Vagg) [#1613](https://github.com/nodejs/node/pull/1613) * [[`dacc1fa35c`](https://github.com/nodejs/node/commit/dacc1fa35c)] - **doc**: update AUTHORS list (Rod Vagg) [#1586](https://github.com/nodejs/node/pull/1586) * [[`2a3a1909ab`](https://github.com/nodejs/node/commit/2a3a1909ab)] - **doc**: add require() lines to child.stdio example (Nick Raienko) [#1504](https://github.com/nodejs/node/pull/1504) * [[`02388dbf40`](https://github.com/nodejs/node/commit/02388dbf40)] - **doc**: fix some cross-references (Alexander Gromnitsky) [#1584](https://github.com/nodejs/node/pull/1584) * [[`57c4cc26e2`](https://github.com/nodejs/node/commit/57c4cc26e2)] - **doc**: add TC meeting 2015-04-22 minutes (Rod Vagg) [#1556](https://github.com/nodejs/node/pull/1556) * [[`b4ad5d7050`](https://github.com/nodejs/node/commit/b4ad5d7050)] - **doc**: improve http.request and https.request opts (Roman Reiss) [#1551](https://github.com/nodejs/node/pull/1551) * [[`7dc8eec0a6`](https://github.com/nodejs/node/commit/7dc8eec0a6)] - **doc**: deprecate smalloc module (Ben Noordhuis) [#1566](https://github.com/nodejs/node/pull/1566) * [[`1bcdf46ca7`](https://github.com/nodejs/node/commit/1bcdf46ca7)] - **doc**: add TC meeting 2015-04-15 minutes (Rod Vagg) [#1498](https://github.com/nodejs/node/pull/1498) * [[`391cae3595`](https://github.com/nodejs/node/commit/391cae3595)] - **doc**: Add Known issues to v1.7.0/1.7.1 CHANGELOG (Yosuke Furukawa) [#1473](https://github.com/nodejs/node/pull/1473) * [[`e55fdc47a7`](https://github.com/nodejs/node/commit/e55fdc47a7)] - **doc**: fix util.deprecate example (Nick Raienko) [#1535](https://github.com/nodejs/node/pull/1535) * [[`5178f93bc0`](https://github.com/nodejs/node/commit/5178f93bc0)] - **doc**: Add Addon API (NAN) to working group list (Julian Duque) [#1523](https://github.com/nodejs/node/pull/1523) * [[`f3cc50f811`](https://github.com/nodejs/node/commit/f3cc50f811)] - **doc**: add TC meeting 2015-04-08 minutes (Rod Vagg) [#1497](https://github.com/nodejs/node/pull/1497) * [[`bb254b533b`](https://github.com/nodejs/node/commit/bb254b533b)] - **doc**: update branch to master (Roman Reiss) [#1511](https://github.com/nodejs/node/pull/1511) * [[`22aafa5597`](https://github.com/nodejs/node/commit/22aafa5597)] - **doc**: add Fishrock123 to the TC (Jeremiah Senkpiel) [#1507](https://github.com/nodejs/node/pull/1507) * [[`b16a328ede`](https://github.com/nodejs/node/commit/b16a328ede)] - **doc**: add spaces to child.kill example (Nick Raienko) [#1503](https://github.com/nodejs/node/pull/1503) * [[`26327757f8`](https://github.com/nodejs/node/commit/26327757f8)] - **doc**: update AUTHORS list (Rod Vagg) [#1476](https://github.com/nodejs/node/pull/1476) * [[`f9c681cf62`](https://github.com/nodejs/node/commit/f9c681cf62)] - **fs**: validate fd on fs.write (Julian Duque) [#1553](https://github.com/nodejs/node/pull/1553) * [[`801b47acc5`](https://github.com/nodejs/node/commit/801b47acc5)] - **gitignore**: ignore xcode workspaces and projects (Roman Klauke) [#1562](https://github.com/nodejs/node/pull/1562) * [[`d5ce47e433`](https://github.com/nodejs/node/commit/d5ce47e433)] - **(SEMVER-MINOR)** **lib**: deprecate the smalloc module (Ben Noordhuis) [#1564](https://github.com/nodejs/node/pull/1564) * [[`7384ca83f9`](https://github.com/nodejs/node/commit/7384ca83f9)] - **module**: remove '' from Module.globalPaths (Chris Yip) [#1488](https://github.com/nodejs/node/pull/1488) * [[`b4f5898395`](https://github.com/nodejs/node/commit/b4f5898395)] - **net**: ensure Write/ShutdownWrap references handle (Fedor Indutny) [#1590](https://github.com/nodejs/node/pull/1590) * [[`4abe2fa1cf`](https://github.com/nodejs/node/commit/4abe2fa1cf)] - **(SEMVER-MINOR)** **net**: add lookup option to Socket.prototype.connect (Evan Lucas) [#1505](https://github.com/nodejs/node/pull/1505) * [[`1bef717476`](https://github.com/nodejs/node/commit/1bef717476)] - **(SEMVER-MINOR)** **net**: cleanup connect logic (Evan Lucas) [#1505](https://github.com/nodejs/node/pull/1505) * [[`c7782c0af8`](https://github.com/nodejs/node/commit/c7782c0af8)] - **node**: improve nextTick performance (Brian White) [#1571](https://github.com/nodejs/node/pull/1571) * [[`b57cc51d8d`](https://github.com/nodejs/node/commit/b57cc51d8d)] - **(SEMVER-MAJOR)** **os**: remove trailing slash from os.tmpdir() (Christian Tellnes) [#747](https://github.com/nodejs/node/pull/747) * [[`ca219b00d1`](https://github.com/nodejs/node/commit/ca219b00d1)] - **repl**: fix for a+ fd clearing the file on read (Chris Dickinson) [#1605](https://github.com/nodejs/node/pull/1605) * [[`051d482b15`](https://github.com/nodejs/node/commit/051d482b15)] - **repl**: fix \_debugger by properly proxying repl (Chris Dickinson) [#1605](https://github.com/nodejs/node/pull/1605) * [[`2e2fce0502`](https://github.com/nodejs/node/commit/2e2fce0502)] - **repl**: fix persistent history and env variable name (Roman Reiss) [#1593](https://github.com/nodejs/node/pull/1593) * [[`ea5195ccaf`](https://github.com/nodejs/node/commit/ea5195ccaf)] - **repl**: do not save history for non-terminal repl (Fedor Indutny) [#1575](https://github.com/nodejs/node/pull/1575) * [[`0450ce7db2`](https://github.com/nodejs/node/commit/0450ce7db2)] - **repl**: add mode detection, cli persistent history (Chris Dickinson) [#1513](https://github.com/nodejs/node/pull/1513) * [[`af9fe3bbc7`](https://github.com/nodejs/node/commit/af9fe3bbc7)] - **(SEMVER-MAJOR)** **src**: bump NODE_MODULE_VERSION due to V8 API (Rod Vagg) [#1532](https://github.com/nodejs/node/pull/1532) * [[`279f6116aa`](https://github.com/nodejs/node/commit/279f6116aa)] - **src**: fix -Wmissing-field-initializers warning (Ben Noordhuis) [#1606](https://github.com/nodejs/node/pull/1606) * [[`73062521a4`](https://github.com/nodejs/node/commit/73062521a4)] - **src**: deprecate smalloc public functions (Ben Noordhuis) [#1565](https://github.com/nodejs/node/pull/1565) * [[`ccb199af17`](https://github.com/nodejs/node/commit/ccb199af17)] - **src**: fix deprecation warnings (Ben Noordhuis) [#1565](https://github.com/nodejs/node/pull/1565) * [[`609fa0de03`](https://github.com/nodejs/node/commit/609fa0de03)] - **src**: fix NODE_DEPRECATED macro (Ben Noordhuis) [#1565](https://github.com/nodejs/node/pull/1565) * [[`3c92ca2b5c`](https://github.com/nodejs/node/commit/3c92ca2b5c)] - **(SEMVER-MINOR)** **src**: add ability to get/set effective uid/gid (Evan Lucas) [#1536](https://github.com/nodejs/node/pull/1536) * [[`30b7349176`](https://github.com/nodejs/node/commit/30b7349176)] - **stream_base**: dispatch reqs in the stream impl (Fedor Indutny) [#1563](https://github.com/nodejs/node/pull/1563) * [[`0fa6c4a6fc`](https://github.com/nodejs/node/commit/0fa6c4a6fc)] - **string_decoder**: don't cache Buffer.isEncoding (Brian White) [#1548](https://github.com/nodejs/node/pull/1548) * [[`f9b226c1c1`](https://github.com/nodejs/node/commit/f9b226c1c1)] - **test**: extend timeouts for ARMv6 (Rod Vagg) [#1554](https://github.com/nodejs/node/pull/1554) * [[`bfae8236b1`](https://github.com/nodejs/node/commit/bfae8236b1)] - **test**: fix test-net-dns-custom-lookup test assertion (Evan Lucas) [#1531](https://github.com/nodejs/node/pull/1531) * [[`547213913b`](https://github.com/nodejs/node/commit/547213913b)] - **test**: adjust Makefile/test-ci, add to vcbuild.bat (Rod Vagg) [#1530](https://github.com/nodejs/node/pull/1530) * [[`550c2638c0`](https://github.com/nodejs/node/commit/550c2638c0)] - **tls**: use `SSL_set_cert_cb` for async SNI/OCSP (Fedor Indutny) [#1464](https://github.com/nodejs/node/pull/1464) * [[`1787416376`](https://github.com/nodejs/node/commit/1787416376)] - **tls**: destroy singleUse context immediately (Fedor Indutny) [#1529](https://github.com/nodejs/node/pull/1529) * [[`2684c902c4`](https://github.com/nodejs/node/commit/2684c902c4)] - **tls**: zero SSL_CTX freelist for a singleUse socket (Fedor Indutny) [#1529](https://github.com/nodejs/node/pull/1529) * [[`2d241b3b82`](https://github.com/nodejs/node/commit/2d241b3b82)] - **tls**: destroy SSL once it is out of use (Fedor Indutny) [#1529](https://github.com/nodejs/node/pull/1529) * [[`f7620fb96d`](https://github.com/nodejs/node/commit/f7620fb96d)] - **tls_wrap**: Unlink TLSWrap and SecureContext objects (Сковорода Никита Андреевич) [#1580](https://github.com/nodejs/node/pull/1580) * [[`a7d74633f2`](https://github.com/nodejs/node/commit/a7d74633f2)] - **tls_wrap**: use localhost if options.host is empty (Guilherme Souza) [#1493](https://github.com/nodejs/node/pull/1493) * [[`702997c1f0`](https://github.com/nodejs/node/commit/702997c1f0)] - ***Revert*** "**url**: significantly improve the performance of the url module" (Rod Vagg) [#1602](https://github.com/nodejs/node/pull/1602) * [[`0daed24883`](https://github.com/nodejs/node/commit/0daed24883)] - ***Revert*** "**url**: delete href cache on all setter code paths" (Rod Vagg) [#1602](https://github.com/nodejs/node/pull/1602) * [[`0f39ef4ca1`](https://github.com/nodejs/node/commit/0f39ef4ca1)] - ***Revert*** "**url**: fix treatment of some values as non-empty" (Rod Vagg) [#1602](https://github.com/nodejs/node/pull/1602) * [[`66877216bd`](https://github.com/nodejs/node/commit/66877216bd)] - **url**: fix treatment of some values as non-empty (Petka Antonov) [#1589](https://github.com/nodejs/node/pull/1589) * [[`dbdd81a91b`](https://github.com/nodejs/node/commit/dbdd81a91b)] - **url**: delete href cache on all setter code paths (Petka Antonov) [#1589](https://github.com/nodejs/node/pull/1589) * [[`3fd7fc429c`](https://github.com/nodejs/node/commit/3fd7fc429c)] - **url**: significantly improve the performance of the url module (Petka Antonov) [#1561](https://github.com/nodejs/node/pull/1561) * [[`bf7ac08dd0`](https://github.com/nodejs/node/commit/bf7ac08dd0)] - **util**: add Map and Set inspection support (Christopher Monsanto) [#1471](https://github.com/nodejs/node/pull/1471) * [[`30e83d2e84`](https://github.com/nodejs/node/commit/30e83d2e84)] - **win,node-gyp**: optionally allow node.exe/iojs.exe to be renamed (Bert Belder) [#1266](https://github.com/nodejs/node/pull/1266) * [[`3bda6cbfa4`](https://github.com/nodejs/node/commit/3bda6cbfa4)] - **(SEMVER-MAJOR)** **win,node-gyp**: enable delay-load hook by default (Bert Belder) [#1433](https://github.com/nodejs/node/pull/1433) ## 2015-04-20, Version 1.8.1, @chrisdickinson ### Notable changes * **NOTICE**: Skipped v1.8.0 due to problems with release tooling. See [#1436](https://github.com/nodejs/node/issues/1436) for details. * **build**: Support for building io.js as a static library (Marat Abdullin) [#1341](https://github.com/nodejs/node/pull/1341) * **deps**: Upgrade openssl to 1.0.2a (Shigeki Ohtsu) [#1389](https://github.com/nodejs/node/pull/1389) * Users should see performance improvements when using the crypto API. See [here](https://github.com/nodejs/node/wiki/Crypto-Performance-Notes-for-OpenSSL-1.0.2a-on-iojs-v1.8.0) for details. * **npm**: Upgrade npm to 2.8.3. See the [release notes](https://github.com/npm/npm/releases/tag/v2.8.3) for details. Includes improved git support. Summary: * [`387f889`](https://github.com/npm/npm/commit/387f889c0e8fb617d9cc9a42ed0a3ec49424ab5d) [#7961](https://github.com/npm/npm/issues/7961) Ensure that hosted git SSH URLs always have a valid protocol when stored in `resolved` fields in `npm-shrinkwrap.json`. ([@othiym23](https://github.com/othiym23)) * [`394c2f5`](https://github.com/npm/npm/commit/394c2f5a1227232c0baf42fbba1402aafe0d6ffb) Switch the order in which hosted Git providers are checked to `git:`, `git+https:`, then `git+ssh:` (from `git:`, `git+ssh:`, then `git+https:`) in an effort to go from most to least likely to succeed, to make for less confusing error message. ([@othiym23](https://github.com/othiym23)) * [`431c3bf`](https://github.com/npm/npm/commit/431c3bf6cdec50f9f0c735f478cb2f3f337d3313) [#7699](https://github.com/npm/npm/issues/7699) `npm-registry-client@6.3.2`: Don't send body with HTTP GET requests when logging in. ([@smikes](https://github.com/smikes)) * [`15efe12`](https://github.com/npm/npm/commit/15efe124753257728a0ddc64074fa5a4b9c2eb30) [#7872](https://github.com/npm/npm/issues/7872) Use the new version of `hosted-git-info` to pass along credentials embedded in git URLs. Test it. Test it a lot. ([@othiym23](https://github.com/othiym23)) * [`b027319`](https://github.com/npm/npm/commit/b0273190c71eba14395ddfdd1d9f7ba625297523) [#7920](https://github.com/npm/npm/issues/7920) Scoped packages with `peerDependencies` were installing the `peerDependencies` into the wrong directory. ([@ewie](https://github.com/ewie)) * [`6b0f588`](https://github.com/npm/npm/commit/6b0f58877f37df9904490ffbaaad33862bd36dce) [#7867](https://github.com/npm/npm/issues/7867) Use git shorthand and git URLs as presented by user. Support new `hosted-git-info` shortcut syntax. Save shorthand in `package.json`. Try cloning via `git:`, `git+ssh:`, and `git+https:`, in that order, when supported by the underlying hosting provider. ([@othiym23](https://github.com/othiym23)) * **src**: Allow multiple arguments to be passed to process.nextTick (Trevor Norris) [#1077](https://github.com/nodejs/node/pull/1077) * **module**: The interaction of `require('.')` with `NODE_PATH` has been restored and deprecated. This functionality will be removed at a later point. (Roman Reiss) [#1363](https://github.com/nodejs/node/pull/1363) ### Known issues * Some problems with unreferenced timers running during `beforeExit` are still to be resolved. See [#1264](https://github.com/nodejs/node/issues/1264). * Surrogate pair in REPL can freeze terminal [#690](https://github.com/nodejs/node/issues/690) * `process.send()` is not synchronous as the docs suggest, a regression introduced in 1.0.2, see [#760](https://github.com/nodejs/node/issues/760) and fix in [#774](https://github.com/nodejs/node/issues/774) * Calling `dns.setServers()` while a DNS query is in progress can cause the process to crash on a failed assertion [#894](https://github.com/nodejs/node/issues/894) * `url.resolve` may transfer the auth portion of the url when resolving between two full hosts, see [#1435](https://github.com/nodejs/node/issues/1435). * readline: split escapes are processed incorrectly, see [#1403](https://github.com/nodejs/node/issues/1403) ### Commits * [[`53ed89d927`](https://github.com/nodejs/node/commit/53ed89d927)] - ***Revert*** "**build**: use %PYTHON% instead of python" (Rod Vagg) [#1475](https://github.com/nodejs/node/pull/1475) * [[`2b744b0ab7`](https://github.com/nodejs/node/commit/2b744b0ab7)] - **src**: revert NODE_MODULE_VERSION to 43 (Chris Dickinson) [#1460](https://github.com/nodejs/node/pull/1460) * [[`431673ebd1`](https://github.com/nodejs/node/commit/431673ebd1)] - **buffer**: fast-case for empty string in byteLength (Jackson Tian) [#1441](https://github.com/nodejs/node/pull/1441) * [[`1b22bad35f`](https://github.com/nodejs/node/commit/1b22bad35f)] - **build**: fix logic for shared library flags (Jeremiah Senkpiel) [#1454](https://github.com/nodejs/node/pull/1454) * [[`91943a99d5`](https://github.com/nodejs/node/commit/91943a99d5)] - **build**: use %PYTHON% instead of python (Rod Vagg) [#1444](https://github.com/nodejs/node/pull/1444) * [[`c7769d417b`](https://github.com/nodejs/node/commit/c7769d417b)] - **build**: Expose xz compression level (Johan Bergström) [#1428](https://github.com/nodejs/node/pull/1428) * [[`a530b2baf1`](https://github.com/nodejs/node/commit/a530b2baf1)] - **build**: fix error message in configure (Shigeki Ohtsu) [#1389](https://github.com/nodejs/node/pull/1389) * [[`92dfb794f9`](https://github.com/nodejs/node/commit/92dfb794f9)] - **build**: enable ssl support on arm64 (Shigeki Ohtsu) [#1389](https://github.com/nodejs/node/pull/1389) * [[`7de0dcde83`](https://github.com/nodejs/node/commit/7de0dcde83)] - **deps**: make node-gyp work with io.js (cjihrig) [#990](https://github.com/nodejs/node/pull/990) * [[`4870213f9e`](https://github.com/nodejs/node/commit/4870213f9e)] - **deps**: upgrade npm to 2.8.3 (Forrest L Norvell) * [[`49bb7ded2c`](https://github.com/nodejs/node/commit/49bb7ded2c)] - **deps**: fix git case sensitivity issue in npm (Chris Dickinson) [#1456](https://github.com/nodejs/node/pull/1456) * [[`4830b4bce8`](https://github.com/nodejs/node/commit/4830b4bce8)] - **deps**: add docs to upgrade openssl (Shigeki Ohtsu) [#1389](https://github.com/nodejs/node/pull/1389) * [[`11bec72c87`](https://github.com/nodejs/node/commit/11bec72c87)] - **deps**: update asm files for openssl-1.0.2a (Shigeki Ohtsu) [#1389](https://github.com/nodejs/node/pull/1389) * [[`53924d8ebe`](https://github.com/nodejs/node/commit/53924d8ebe)] - **deps**: update asm Makefile for openssl-1.0.2a (Shigeki Ohtsu) [#1389](https://github.com/nodejs/node/pull/1389) * [[`418e839456`](https://github.com/nodejs/node/commit/418e839456)] - **deps**: update openssl.gyp/gypi for openssl-1.0.2a (Shigeki Ohtsu) [#1389](https://github.com/nodejs/node/pull/1389) * [[`02f12ab666`](https://github.com/nodejs/node/commit/02f12ab666)] - **deps**: update opensslconf.h for 1.0.2a (Shigeki Ohtsu) [#1389](https://github.com/nodejs/node/pull/1389) * [[`eb7a23595f`](https://github.com/nodejs/node/commit/eb7a23595f)] - **deps**: add x32 and arm64 support for opensslconf.h (Shigeki Ohtsu) [#1389](https://github.com/nodejs/node/pull/1389) * [[`033a663127`](https://github.com/nodejs/node/commit/033a663127)] - **deps**: replace all headers in openssl (Shigeki Ohtsu) [#1389](https://github.com/nodejs/node/pull/1389) * [[`ae8831f240`](https://github.com/nodejs/node/commit/ae8831f240)] - **deps**: backport openssl patch of alt cert chains 1 (Shigeki Ohtsu) [#1389](https://github.com/nodejs/node/pull/1389) * [[`71316c46d9`](https://github.com/nodejs/node/commit/71316c46d9)] - **deps**: fix asm build error of openssl in x86_win32 (Shigeki Ohtsu) [#1389](https://github.com/nodejs/node/pull/1389) * [[`d293a4f096`](https://github.com/nodejs/node/commit/d293a4f096)] - **deps**: fix openssl assembly error on ia32 win32 (Fedor Indutny) [#1389](https://github.com/nodejs/node/pull/1389) * [[`e4872d7405`](https://github.com/nodejs/node/commit/e4872d7405)] - **deps**: upgrade openssl to 1.0.2a (Shigeki Ohtsu) [#1389](https://github.com/nodejs/node/pull/1389) * [[`a1c9ef3142`](https://github.com/nodejs/node/commit/a1c9ef3142)] - **deps, build**: add support older assembler (Shigeki Ohtsu) [#1389](https://github.com/nodejs/node/pull/1389) * [[`76f219c128`](https://github.com/nodejs/node/commit/76f219c128)] - **doc**: Document forced pushing with git (Johan Bergström) [#1420](https://github.com/nodejs/node/pull/1420) * [[`12e51d56c1`](https://github.com/nodejs/node/commit/12e51d56c1)] - **doc**: add Addon API WG (Rod Vagg) [#1226](https://github.com/nodejs/node/pull/1226) * [[`7956a13dad`](https://github.com/nodejs/node/commit/7956a13dad)] - **http**: logically respect maxSockets (fengmk2) [#1242](https://github.com/nodejs/node/pull/1242) * [[`5b844e140b`](https://github.com/nodejs/node/commit/5b844e140b)] - **module**: fix style (Roman Reiss) [#1453](https://github.com/nodejs/node/pull/1453) * [[`3ad82c335d`](https://github.com/nodejs/node/commit/3ad82c335d)] - **(SEMVER-MINOR)** **module**: handle NODE_PATH in require('.') (Roman Reiss) [#1363](https://github.com/nodejs/node/pull/1363) * [[`cd60ff0328`](https://github.com/nodejs/node/commit/cd60ff0328)] - **net**: add fd into listen2 debug info (Jackson Tian) [#1442](https://github.com/nodejs/node/pull/1442) * [[`10e31ba56c`](https://github.com/nodejs/node/commit/10e31ba56c)] - **(SEMVER-MINOR)** **node**: allow multiple arguments passed to nextTick (Trevor Norris) [#1077](https://github.com/nodejs/node/pull/1077) * [[`116c54692a`](https://github.com/nodejs/node/commit/116c54692a)] - **openssl**: fix keypress requirement in apps on win32 (Shigeki Ohtsu) [#1389](https://github.com/nodejs/node/pull/1389) * [[`62f5f4cec9`](https://github.com/nodejs/node/commit/62f5f4cec9)] - **src**: remove duplicate byteLength from Buffer (Jackson Tian) [#1438](https://github.com/nodejs/node/pull/1438) * [[`51d0808c90`](https://github.com/nodejs/node/commit/51d0808c90)] - **stream**: remove duplicated expression (Yazhong Liu) [#1444](https://github.com/nodejs/node/pull/1444) * [[`deb9d23d7b`](https://github.com/nodejs/node/commit/deb9d23d7b)] - **test**: fix error message check for openssl-1.0.2a (Shigeki Ohtsu) [#1389](https://github.com/nodejs/node/pull/1389) * [[`ca8c9ec2c8`](https://github.com/nodejs/node/commit/ca8c9ec2c8)] - **win,node-gyp**: optionally allow node.exe/iojs.exe to be renamed (Bert Belder) [#1266](https://github.com/nodejs/node/pull/1266) ## 2015-04-14, Version 1.7.1, @rvagg ### Notable changes * **build**: A syntax error in the Makefile for release builds caused 1.7.0 to be DOA and unreleased. (Rod Vagg) [#1421](https://github.com/nodejs/node/pull/1421). ### Known issues * Some problems with unreferenced timers running during `beforeExit` are still to be resolved. See [#1264](https://github.com/nodejs/node/issues/1264). * Surrogate pair in REPL can freeze terminal [#690](https://github.com/nodejs/node/issues/690) * `process.send()` is not synchronous as the docs suggest, a regression introduced in 1.0.2, see [#760](https://github.com/nodejs/node/issues/760) and fix in [#774](https://github.com/nodejs/node/issues/774) * Calling `dns.setServers()` while a DNS query is in progress can cause the process to crash on a failed assertion [#894](https://github.com/nodejs/node/issues/894) * readline: split escapes are processed incorrectly, see [#1403](https://github.com/nodejs/node/issues/1403) ### Commits * [[`aee86a21f2`](https://github.com/nodejs/node/commit/aee86a21f2)] - **build**: fix RELEASE check (Rod Vagg) [#1421](https://github.com/nodejs/node/pull/1421) ## 2015-04-14, Version 1.7.0, @rvagg ### Notable changes * **C++ API**: Fedor Indutny contributed a feature to V8 which has been backported to the V8 bundled in io.js. `SealHandleScope` allows a C++ add-on author to _seal_ a `HandleScope` to prevent further, unintended allocations within it. Currently only enabled for debug builds of io.js. This feature helped detect the leak in [#1075](https://github.com/nodejs/node/issues/1075) and is now activated on the root `HandleScope` in io.js. (Fedor Indutny) [#1395](https://github.com/nodejs/node/pull/1395). * **ARM**: This release includes significant work to improve the state of ARM support for builds and tests. The io.js CI cluster's ARMv6, ARMv7 and ARMv8 build servers are now all (mostly) reporting passing builds and tests. * ARMv8 64-bit (AARCH64) is now properly supported, including a backported fix in libuv that was mistakenly detecting the existence of `epoll_wait()`. (Ben Noordhuis) [#1365](https://github.com/nodejs/node/pull/1365). * ARMv6: [#1376](https://github.com/nodejs/node/issues/1376) reported a problem with `Math.exp()` on ARMv6 (incl Raspberry Pi). The culprit is erroneous codegen for ARMv6 when using the "fast math" feature of V8. `--nofast_math` has been turned on for all ARMv6 variants by default to avoid this, fast math can be turned back on with `--fast_math`. (Ben Noordhuis) [#1398](https://github.com/nodejs/node/pull/1398). * Tests: timeouts have been tuned specifically for slower platforms, detected as ARMv6 and ARMv7. (Roman Reiss) [#1366](https://github.com/nodejs/node/pull/1366). * **npm**: Upgrade npm to 2.7.6. See the [release notes](https://github.com/npm/npm/releases/tag/v2.7.6) for details. Summary: * [`b747593`](https://github.com/npm/npm/commit/b7475936f473f029e6a027ba1b16277523747d0b)[#7630](https://github.com/npm/npm/issues/7630) Don't automatically log all git failures as errors. `maybeGithub` needs to be able to fail without logging to support its fallback logic. ([@othiym23](https://github.com/othiym23)) * [`78005eb`](https://github.com/npm/npm/commit/78005ebb6f4103c20f077669c3929b7ea46a4c0d)[#7743](https://github.com/npm/npm/issues/7743) Always quote arguments passed to `npm run-script`. This allows build systems and the like to safely escape glob patterns passed as arguments to `run-scripts` with `npm run-script `; } // handle general body-text replacements // for example, link man page references to the actual page function parseText(lexed) { lexed.forEach(function(tok) { if (tok.text && tok.type !== 'code') { tok.text = linkManPages(tok.text); tok.text = linkJsTypeDocs(tok.text); } }); } // just update the list item text in-place. // lists that come right after a heading are what we're after. function parseLists(input) { var state = null; var savedState = []; var depth = 0; var output = []; let headingIndex = -1; let heading = null; output.links = input.links; input.forEach(function(tok, index) { if (tok.type === 'blockquote_start') { savedState.push(state); state = 'MAYBE_STABILITY_BQ'; return; } if (tok.type === 'blockquote_end' && state === 'MAYBE_STABILITY_BQ') { state = savedState.pop(); return; } if ((tok.type === 'paragraph' && state === 'MAYBE_STABILITY_BQ') || tok.type === 'code') { if (tok.text.match(/Stability:.*/g)) { const stabilityMatch = tok.text.match(STABILITY_TEXT_REG_EXP); const stability = Number(stabilityMatch[2]); const isStabilityIndex = index - 2 === headingIndex || // general index - 3 === headingIndex; // with api_metadata block if (heading && isStabilityIndex) { heading.stability = stability; headingIndex = -1; heading = null; } tok.text = parseAPIHeader(tok.text).replace(/\n/g, ' '); output.push({ type: 'html', text: tok.text }); return; } else if (state === 'MAYBE_STABILITY_BQ') { output.push({ type: 'blockquote_start' }); state = savedState.pop(); } } if (state === null || (state === 'AFTERHEADING' && tok.type === 'heading')) { if (tok.type === 'heading') { headingIndex = index; heading = tok; state = 'AFTERHEADING'; } output.push(tok); return; } if (state === 'AFTERHEADING') { if (tok.type === 'list_start') { state = 'LIST'; if (depth === 0) { output.push({ type: 'html', text: '
' }); } depth++; output.push(tok); return; } if (tok.type === 'html' && common.isYAMLBlock(tok.text)) { tok.text = parseYAML(tok.text); } state = null; output.push(tok); return; } if (state === 'LIST') { if (tok.type === 'list_start') { depth++; output.push(tok); return; } if (tok.type === 'list_end') { depth--; output.push(tok); if (depth === 0) { state = null; output.push({ type: 'html', text: '
' }); } return; } } output.push(tok); }); return output; } function parseYAML(text) { const meta = common.extractAndParseYAML(text); const html = ['
']; if (meta.added) { html.push(`Added in: ${meta.added.join(', ')}`); } if (meta.deprecated) { html.push(`Deprecated since: ${meta.deprecated.join(', ')} `); } html.push('
'); return html.join('\n'); } // Syscalls which appear in the docs, but which only exist in BSD / OSX var BSD_ONLY_SYSCALLS = new Set(['lchmod']); // Handle references to man pages, eg "open(2)" or "lchmod(2)" // Returns modified text, with such refs replace with HTML links, for example // 'open(2)' function linkManPages(text) { return text.replace(/ ([a-z.]+)\((\d)\)/gm, function(match, name, number) { // name consists of lowercase letters, number is a single digit var displayAs = name + '(' + number + ')'; if (BSD_ONLY_SYSCALLS.has(name)) { return ' ' + displayAs + ''; } else { return ' ' + displayAs + ''; } }); } function linkJsTypeDocs(text) { var parts = text.split('`'); var i; var typeMatches; // Handle types, for example the source Markdown might say // "This argument should be a {Number} or {String}" for (i = 0; i < parts.length; i += 2) { typeMatches = parts[i].match(/\{([^\}]+)\}/g); if (typeMatches) { typeMatches.forEach(function(typeMatch) { parts[i] = parts[i].replace(typeMatch, typeParser.toLink(typeMatch)); }); } } //XXX maybe put more stuff here? return parts.join('`'); } function parseAPIHeader(text) { text = text.replace( STABILITY_TEXT_REG_EXP, '
$1 $2$3
' ); return text; } // section is just the first heading function getSection(lexed) { for (var i = 0, l = lexed.length; i < l; i++) { var tok = lexed[i]; if (tok.type === 'heading') return tok.text; } return ''; } function buildToc(lexed, filename, cb) { var toc = []; var depth = 0; const startIncludeRefRE = /^\s*\s*$/; const endIncludeRefRE = /^\s*\s*$/; const realFilenames = [filename]; lexed.forEach(function(tok) { // Keep track of the current filename along @include directives. if (tok.type === 'html') { let match; if ((match = tok.text.match(startIncludeRefRE)) !== null) realFilenames.unshift(match[1]); else if (tok.text.match(endIncludeRefRE)) realFilenames.shift(); } if (tok.type !== 'heading') return; if (tok.depth - depth > 1) { return cb(new Error('Inappropriate heading level\n' + JSON.stringify(tok))); } depth = tok.depth; const realFilename = path.basename(realFilenames[0], '.md'); const id = getId(realFilename + '_' + tok.text.trim()); toc.push(new Array((depth - 1) * 2 + 1).join(' ') + '* ' + '' + tok.text + ''); tok.text += '#'; }); toc = marked.parse(toc.join('\n')); cb(null, toc); } var idCounters = {}; function getId(text) { text = text.toLowerCase(); text = text.replace(/[^a-z0-9]+/g, '_'); text = text.replace(/^_+|_+$/, ''); text = text.replace(/^([^a-z])/, '_$1'); if (idCounters.hasOwnProperty(text)) { text += '_' + (++idCounters[text]); } else { idCounters[text] = 0; } return text; } node-v4.8.2/tools/doc/json.js000644 000766 000024 00000041020 13070706737 016173 0ustar00iojsstaff000000 000000 'use strict'; module.exports = doJSON; // Take the lexed input, and return a JSON-encoded object // A module looks like this: https://gist.github.com/1777387 const common = require('./common.js'); const marked = require('marked'); // customized heading without id attribute var renderer = new marked.Renderer(); renderer.heading = function(text, level) { return '' + text + '\n'; }; marked.setOptions({ renderer: renderer }); function doJSON(input, filename, cb) { var root = {source: filename}; var stack = [root]; var depth = 0; var current = root; var state = null; var lexed = marked.lexer(input); lexed.forEach(function(tok) { var type = tok.type; var text = tok.text; // // This is for cases where the markdown semantic structure is lacking. if (type === 'paragraph' || type === 'html') { var metaExpr = /\n*/g; text = text.replace(metaExpr, function(_0, k, v) { current[k.trim()] = v.trim(); return ''; }); text = text.trim(); if (!text) return; } if (type === 'heading' && !text.trim().match(/^example/i)) { if (tok.depth - depth > 1) { return cb(new Error('Inappropriate heading level\n' + JSON.stringify(tok))); } // Sometimes we have two headings with a single // blob of description. Treat as a clone. if (current && state === 'AFTERHEADING' && depth === tok.depth) { var clone = current; current = newSection(tok); current.clone = clone; // don't keep it around on the stack. stack.pop(); } else { // if the level is greater than the current depth, // then it's a child, so we should just leave the stack // as it is. // However, if it's a sibling or higher, then it implies // the closure of the other sections that came before. // root is always considered the level=0 section, // and the lowest heading is 1, so this should always // result in having a valid parent node. var d = tok.depth; while (d <= depth) { finishSection(stack.pop(), stack[stack.length - 1]); d++; } current = newSection(tok); } depth = tok.depth; stack.push(current); state = 'AFTERHEADING'; return; } // heading // Immediately after a heading, we can expect the following // // { type: 'blockquote_start' } // { type: 'paragraph', text: 'Stability: ...' }, // { type: 'blockquote_end' } // // a list: starting with list_start, ending with list_end, // maybe containing other nested lists in each item. // // If one of these isn't found, then anything that comes between // here and the next heading should be parsed as the desc. var stability; if (state === 'AFTERHEADING') { if (type === 'blockquote_start') { state = 'AFTERHEADING_BLOCKQUOTE'; return; } else if (type === 'list_start' && !tok.ordered) { state = 'AFTERHEADING_LIST'; current.list = current.list || []; current.list.push(tok); current.list.level = 1; } else if (type === 'html' && common.isYAMLBlock(tok.text)) { current.meta = parseYAML(tok.text); } else { current.desc = current.desc || []; if (!Array.isArray(current.desc)) { current.shortDesc = current.desc; current.desc = []; } current.desc.links = lexed.links; current.desc.push(tok); state = 'DESC'; } return; } if (state === 'AFTERHEADING_LIST') { current.list.push(tok); if (type === 'list_start') { current.list.level++; } else if (type === 'list_end') { current.list.level--; } if (current.list.level === 0) { state = 'AFTERHEADING'; processList(current); } return; } if (state === 'AFTERHEADING_BLOCKQUOTE') { if (type === 'blockquote_end') { state = 'AFTERHEADING'; return; } if (type === 'paragraph' && (stability = text.match(/^Stability: ([0-5])(?:\s*-\s*)?(.*)$/))) { current.stability = parseInt(stability[1], 10); current.stabilityText = stability[2].trim(); return; } } current.desc = current.desc || []; current.desc.links = lexed.links; current.desc.push(tok); }); // finish any sections left open while (root !== (current = stack.pop())) { finishSection(current, stack[stack.length - 1]); } return cb(null, root); } // go from something like this: // [ { type: 'list_item_start' }, // { type: 'text', // text: '`settings` Object, Optional' }, // { type: 'list_start', ordered: false }, // { type: 'list_item_start' }, // { type: 'text', // text: 'exec: String, file path to worker file. Default: `__filename`' }, // { type: 'list_item_end' }, // { type: 'list_item_start' }, // { type: 'text', // text: 'args: Array, string arguments passed to worker.' }, // { type: 'text', // text: 'Default: `process.argv.slice(2)`' }, // { type: 'list_item_end' }, // { type: 'list_item_start' }, // { type: 'text', // text: 'silent: Boolean, whether to send output to parent\'s stdio.' }, // { type: 'text', text: 'Default: `false`' }, // { type: 'space' }, // { type: 'list_item_end' }, // { type: 'list_end' }, // { type: 'list_item_end' }, // { type: 'list_end' } ] // to something like: // [ { name: 'settings', // type: 'object', // optional: true, // settings: // [ { name: 'exec', // type: 'string', // desc: 'file path to worker file', // default: '__filename' }, // { name: 'args', // type: 'array', // default: 'process.argv.slice(2)', // desc: 'string arguments passed to worker.' }, // { name: 'silent', // type: 'boolean', // desc: 'whether to send output to parent\'s stdio.', // default: 'false' } ] } ] function processList(section) { var list = section.list; var values = []; var current; var stack = []; // for now, *just* build the heirarchical list list.forEach(function(tok) { var type = tok.type; if (type === 'space') return; if (type === 'list_item_start' || type === 'loose_item_start') { var n = {}; if (!current) { values.push(n); current = n; } else { current.options = current.options || []; stack.push(current); current.options.push(n); current = n; } return; } else if (type === 'list_item_end') { if (!current) { throw new Error('invalid list - end without current item\n' + JSON.stringify(tok) + '\n' + JSON.stringify(list)); } current = stack.pop(); } else if (type === 'text') { if (!current) { throw new Error('invalid list - text without current item\n' + JSON.stringify(tok) + '\n' + JSON.stringify(list)); } current.textRaw = current.textRaw || ''; current.textRaw += tok.text + ' '; } }); // shove the name in there for properties, since they are always // just going to be the value etc. if (section.type === 'property' && values[0]) { values[0].textRaw = '`' + section.name + '` ' + values[0].textRaw; } // now pull the actual values out of the text bits. values.forEach(parseListItem); // Now figure out what this list actually means. // depending on the section type, the list could be different things. switch (section.type) { case 'ctor': case 'classMethod': case 'method': // each item is an argument, unless the name is 'return', // in which case it's the return value. section.signatures = section.signatures || []; var sig = {}; section.signatures.push(sig); sig.params = values.filter(function(v) { if (v.name === 'return') { sig.return = v; return false; } return true; }); parseSignature(section.textRaw, sig); break; case 'property': // there should be only one item, which is the value. // copy the data up to the section. var value = values[0] || {}; delete value.name; section.typeof = value.type || section.typeof; delete value.type; Object.keys(value).forEach(function(k) { section[k] = value[k]; }); break; case 'event': // event: each item is an argument. section.params = values; break; default: if (section.list.length > 0) { section.desc = section.desc || []; for (var i = 0; i < section.list.length; i++) { section.desc.push(section.list[i]); } } } // section.listParsed = values; delete section.list; } function parseYAML(text) { return common.extractAndParseYAML(text); } // textRaw = "someobject.someMethod(a[, b=100][, c])" function parseSignature(text, sig) { var params = text.match(paramExpr); if (!params) return; params = params[1]; params = params.split(/,/); var optionalLevel = 0; var optionalCharDict = {'[': 1, ' ': 0, ']': -1}; params.forEach(function(p, i, _) { p = p.trim(); if (!p) return; var param = sig.params[i]; var optional = false; var def; // for grouped optional params such as someMethod(a[, b[, c]]) var pos; for (pos = 0; pos < p.length; pos++) { if (optionalCharDict[p[pos]] === undefined) { break; } optionalLevel += optionalCharDict[p[pos]]; } p = p.substring(pos); optional = (optionalLevel > 0); for (pos = p.length - 1; pos >= 0; pos--) { if (optionalCharDict[p[pos]] === undefined) { break; } optionalLevel += optionalCharDict[p[pos]]; } p = p.substring(0, pos + 1); var eq = p.indexOf('='); if (eq !== -1) { def = p.substr(eq + 1); p = p.substr(0, eq); } if (!param) { param = sig.params[i] = { name: p }; } // at this point, the name should match. if (p !== param.name) { console.error('Warning: invalid param "%s"', p); console.error(' > ' + JSON.stringify(param)); console.error(' > ' + text); } if (optional) param.optional = true; if (def !== undefined) param.default = def; }); } function parseListItem(item) { if (item.options) item.options.forEach(parseListItem); if (!item.textRaw) return; // the goal here is to find the name, type, default, and optional. // anything left over is 'desc' var text = item.textRaw.trim(); // text = text.replace(/^(Argument|Param)s?\s*:?\s*/i, ''); text = text.replace(/^, /, '').trim(); var retExpr = /^returns?\s*:?\s*/i; var ret = text.match(retExpr); if (ret) { item.name = 'return'; text = text.replace(retExpr, ''); } else { var nameExpr = /^['`"]?([^'`": \{]+)['`"]?\s*:?\s*/; var name = text.match(nameExpr); if (name) { item.name = name[1]; text = text.replace(nameExpr, ''); } } text = text.trim(); var defaultExpr = /\(default\s*[:=]?\s*['"`]?([^, '"`]*)['"`]?\)/i; var def = text.match(defaultExpr); if (def) { item.default = def[1]; text = text.replace(defaultExpr, ''); } text = text.trim(); var typeExpr = /^\{([^\}]+)\}/; var type = text.match(typeExpr); if (type) { item.type = type[1]; text = text.replace(typeExpr, ''); } text = text.trim(); var optExpr = /^Optional\.|(?:, )?Optional$/; var optional = text.match(optExpr); if (optional) { item.optional = true; text = text.replace(optExpr, ''); } text = text.replace(/^\s*-\s*/, ''); text = text.trim(); if (text) item.desc = text; } function finishSection(section, parent) { if (!section || !parent) { throw new Error('Invalid finishSection call\n' + JSON.stringify(section) + '\n' + JSON.stringify(parent)); } if (!section.type) { section.type = 'module'; if (parent && (parent.type === 'misc')) { section.type = 'misc'; } section.displayName = section.name; section.name = section.name.toLowerCase() .trim().replace(/\s+/g, '_'); } if (section.desc && Array.isArray(section.desc)) { section.desc.links = section.desc.links || []; section.desc = marked.parser(section.desc); } if (!section.list) section.list = []; processList(section); // classes sometimes have various 'ctor' children // which are actually just descriptions of a constructor // class signature. // Merge them into the parent. if (section.type === 'class' && section.ctors) { section.signatures = section.signatures || []; var sigs = section.signatures; section.ctors.forEach(function(ctor) { ctor.signatures = ctor.signatures || [{}]; ctor.signatures.forEach(function(sig) { sig.desc = ctor.desc; }); sigs.push.apply(sigs, ctor.signatures); }); delete section.ctors; } // properties are a bit special. // their "type" is the type of object, not "property" if (section.properties) { section.properties.forEach(function(p) { if (p.typeof) p.type = p.typeof; else delete p.type; delete p.typeof; }); } // handle clones if (section.clone) { var clone = section.clone; delete section.clone; delete clone.clone; deepCopy(section, clone); finishSection(clone, parent); } var plur; if (section.type.slice(-1) === 's') { plur = section.type + 'es'; } else if (section.type.slice(-1) === 'y') { plur = section.type.replace(/y$/, 'ies'); } else { plur = section.type + 's'; } // if the parent's type is 'misc', then it's just a random // collection of stuff, like the "globals" section. // Make the children top-level items. if (section.type === 'misc') { Object.keys(section).forEach(function(k) { switch (k) { case 'textRaw': case 'name': case 'type': case 'desc': case 'miscs': return; default: if (parent.type === 'misc') { return; } if (Array.isArray(k) && parent[k]) { parent[k] = parent[k].concat(section[k]); } else if (!parent[k]) { parent[k] = section[k]; } else { // parent already has, and it's not an array. return; } } }); } parent[plur] = parent[plur] || []; parent[plur].push(section); } // Not a general purpose deep copy. // But sufficient for these basic things. function deepCopy(src, dest) { Object.keys(src).filter(function(k) { return !dest.hasOwnProperty(k); }).forEach(function(k) { dest[k] = deepCopy_(src[k]); }); } function deepCopy_(src) { if (!src) return src; if (Array.isArray(src)) { const c = new Array(src.length); src.forEach(function(v, i) { c[i] = deepCopy_(v); }); return c; } if (typeof src === 'object') { const c = {}; Object.keys(src).forEach(function(k) { c[k] = deepCopy_(src[k]); }); return c; } return src; } // these parse out the contents of an H# tag var eventExpr = /^Event(?::|\s)+['"]?([^"']+).*$/i; var classExpr = /^Class:\s*([^ ]+).*?$/i; var propExpr = /^(?:property:?\s*)?[^.]+\.([^ .()]+)\s*?$/i; var braceExpr = /^(?:property:?\s*)?[^.\[]+(\[[^\]]+\])\s*?$/i; var classMethExpr = /^class\s*method\s*:?[^.]+\.([^ .()]+)\([^)]*\)\s*?$/i; var methExpr = /^(?:method:?\s*)?(?:[^.]+\.)?([^ .()]+)\([^)]*\)\s*?$/i; var newExpr = /^new ([A-Z][a-zA-Z]+)\([^\)]*\)\s*?$/; var paramExpr = /\((.*)\);?$/; function newSection(tok) { var section = {}; // infer the type from the text. var text = section.textRaw = tok.text; if (text.match(eventExpr)) { section.type = 'event'; section.name = text.replace(eventExpr, '$1'); } else if (text.match(classExpr)) { section.type = 'class'; section.name = text.replace(classExpr, '$1'); } else if (text.match(braceExpr)) { section.type = 'property'; section.name = text.replace(braceExpr, '$1'); } else if (text.match(propExpr)) { section.type = 'property'; section.name = text.replace(propExpr, '$1'); } else if (text.match(classMethExpr)) { section.type = 'classMethod'; section.name = text.replace(classMethExpr, '$1'); } else if (text.match(methExpr)) { section.type = 'method'; section.name = text.replace(methExpr, '$1'); } else if (text.match(newExpr)) { section.type = 'ctor'; section.name = text.replace(newExpr, '$1'); } else { section.name = text; } return section; } node-v4.8.2/tools/doc/LICENSE000644 000766 000024 00000002110 13070706737 015666 0ustar00iojsstaff000000 000000 Copyright Joyent, Inc. and other Node contributors. All rights reserved. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. node-v4.8.2/tools/doc/node_modules/000755 000766 000024 00000000000 13070706737 017344 5ustar00iojsstaff000000 000000 node-v4.8.2/tools/doc/package.json000644 000766 000024 00000000603 13070706737 017154 0ustar00iojsstaff000000 000000 { "author": "Isaac Z. Schlueter (http://blog.izs.me/)", "name": "node-doc-generator", "description": "Internal tool for generating Node.js API docs", "version": "0.0.0", "engines": { "node": ">=0.6.10" }, "dependencies": { "marked": "^0.3.5", "js-yaml": "^3.5.2" }, "devDependencies": {}, "optionalDependencies": {}, "bin": "./generate.js" } node-v4.8.2/tools/doc/preprocess.js000644 000766 000024 00000003454 13070706737 017420 0ustar00iojsstaff000000 000000 'use strict'; module.exports = preprocess; var path = require('path'); var fs = require('fs'); var includeExpr = /^@include\s+([A-Za-z0-9-_]+)(?:\.)?([a-zA-Z]*)$/gmi; var includeData = {}; function preprocess(inputFile, input, cb) { input = stripComments(input); processIncludes(inputFile, input, function(err, data) { if (err) return cb(err); cb(null, data); }); } function stripComments(input) { return input.replace(/^@\/\/.*$/gmi, ''); } function processIncludes(inputFile, input, cb) { var includes = input.match(includeExpr); if (includes === null) return cb(null, input); var errState = null; console.error(includes); var incCount = includes.length; if (incCount === 0) cb(null, input); includes.forEach(function(include) { var fname = include.replace(/^@include\s+/, ''); if (!fname.match(/\.md$/)) fname += '.md'; if (includeData.hasOwnProperty(fname)) { input = input.split(include).join(includeData[fname]); incCount--; if (incCount === 0) { return cb(null, input); } } var fullFname = path.resolve(path.dirname(inputFile), fname); fs.readFile(fullFname, 'utf8', function(er, inc) { if (errState) return; if (er) return cb(errState = er); preprocess(inputFile, inc, function(er, inc) { if (errState) return; if (er) return cb(errState = er); incCount--; // Add comments to let the HTML generator know how the anchors for // headings should look like. includeData[fname] = `\n` + inc + `\n\n`; input = input.split(include + '\n').join(includeData[fname] + '\n'); if (incCount === 0) { return cb(null, input); } }); }); }); } node-v4.8.2/tools/doc/README.md000644 000766 000024 00000004227 13070706737 016153 0ustar00iojsstaff000000 000000 Here's how the node docs work. 1:1 relationship from `lib/.js` to `doc/api/.md` Each type of heading has a description block. ## module > Stability: 3 - Stable description and examples. ### module.property * Type description of the property. ### module.someFunction(x, y, [z=100]) * `x` {String} the description of the string * `y` {Boolean} Should I stay or should I go? * `z` {Number} How many zebras to bring. A description of the function. ### module.someNewFunction(x) * `x` {String} the description of the string This feature is not in a release yet. ### Event: 'blerg' * Argument: SomeClass object. Modules don't usually raise events on themselves. `cluster` is the only exception. ## Class: SomeClass description of the class. ### Class Method: SomeClass.classMethod(anArg) * `anArg` {Object} Just an argument * `field` {String} anArg can have this field. * `field2` {Boolean} Another field. Default: `false`. * Return: {Boolean} `true` if it worked. Description of the method for humans. ### someClass.nextSibling() * Return: {SomeClass object | null} The next someClass in line. ### someClass.someProperty * String The indication of what someProperty is. ### Event: 'grelb' * `isBlerg` {Boolean} This event is emitted on instances of SomeClass, not on the module itself. * Classes have (description, Properties, Methods, Events) * Events have (list of arguments, description) * Functions have (list of arguments, description) * Methods have (list of arguments, description) * Modules have (description, Properties, Functions, Classes, Examples) * Properties have (type, description) node-v4.8.2/tools/doc/type-parser.js000644 000766 000024 00000004424 13070706737 017504 0ustar00iojsstaff000000 000000 'use strict'; const nodeDocUrl = ''; const jsDocUrl = 'https://developer.mozilla.org/en-US/docs/Web/JavaScript/' + 'Reference/Global_Objects/'; const jsPrimitiveUrl = 'https://developer.mozilla.org/en-US/docs/Web/' + 'JavaScript/Data_structures'; const jsPrimitives = [ 'Number', 'String', 'Boolean', 'Null', 'Symbol' ]; const jsGlobalTypes = [ 'Error', 'Object', 'Function', 'Array', 'Uint8Array', 'Uint16Array', 'Uint32Array', 'Int8Array', 'Int16Array', 'Int32Array', 'Uint8ClampedArray', 'Float32Array', 'Float64Array', 'Date', 'RegExp', 'ArrayBuffer', 'DataView', 'Promise', 'EvalError', 'RangeError', 'ReferenceError', 'SyntaxError', 'TypeError', 'URIError' ]; const typeMap = { 'Buffer': 'buffer.html#buffer_class_buffer', 'Handle': 'net.html#net_server_listen_handle_backlog_callback', 'Stream': 'stream.html#stream_stream', 'stream.Writable': 'stream.html#stream_class_stream_writable', 'stream.Readable': 'stream.html#stream_class_stream_readable', 'ChildProcess': 'child_process.html#child_process_class_childprocess', 'cluster.Worker': 'cluster.html#cluster_class_worker', 'dgram.Socket': 'dgram.html#dgram_class_dgram_socket', 'net.Socket': 'net.html#net_class_net_socket', 'EventEmitter': 'events.html#events_class_events_eventemitter', 'Timer': 'timers.html#timers_timers' }; module.exports = { toLink: function(typeInput) { const typeLinks = []; typeInput = typeInput.replace('{', '').replace('}', ''); const typeTexts = typeInput.split('|'); typeTexts.forEach(function(typeText) { typeText = typeText.trim(); if (typeText) { let typeUrl = null; if (jsPrimitives.indexOf(typeText) !== -1) { typeUrl = jsPrimitiveUrl + '#' + typeText + '_type'; } else if (jsGlobalTypes.indexOf(typeText) !== -1) { typeUrl = jsDocUrl + typeText; } else if (typeMap[typeText]) { typeUrl = nodeDocUrl + typeMap[typeText]; } if (typeUrl) { typeLinks.push('<' + typeText + '>'); } else { typeLinks.push('<' + typeText + '>'); } } }); return typeLinks.length ? typeLinks.join(' | ') : typeInput; } }; node-v4.8.2/tools/doc/node_modules/.bin/000755 000766 000024 00000000000 13070706741 020165 5ustar00iojsstaff000000 000000 node-v4.8.2/tools/doc/node_modules/js-yaml/000755 000766 000024 00000000000 13070706737 020720 5ustar00iojsstaff000000 000000 node-v4.8.2/tools/doc/node_modules/js-yaml/index.js000644 000766 000024 00000000447 13070706737 022372 0ustar00iojsstaff000000 000000 'use strict'; // Hack to load the js-yaml module from eslint. // No other reason than that it’s huge. const path = require('path'); const realJSYaml = path.resolve( __dirname, '..', '..', '..', // tools/ 'eslint', 'node_modules', 'js-yaml' ); module.exports = require(realJSYaml); node-v4.8.2/tools/configure.d/nodedownload.py000644 000766 000024 00000010211 13070706737 021347 0ustar00iojsstaff000000 000000 #!/usr/bin/env python # Moved some utilities here from ../../configure import urllib import hashlib import sys import zipfile import tarfile import fpformat import contextlib def formatSize(amt): """Format a size as a string in MB""" return fpformat.fix(amt / 1024000., 1) def spin(c): """print out an ASCII 'spinner' based on the value of counter 'c'""" spin = ".:|'" return (spin[c % len(spin)]) class ConfigOpener(urllib.FancyURLopener): """fancy opener used by retrievefile. Set a UA""" # append to existing version (UA) version = '%s node.js/configure' % urllib.URLopener.version def reporthook(count, size, total): """internal hook used by retrievefile""" sys.stdout.write(' Fetch: %c %sMB total, %sMB downloaded \r' % (spin(count), formatSize(total), formatSize(count*size))) def retrievefile(url, targetfile): """fetch file 'url' as 'targetfile'. Return targetfile or throw.""" try: sys.stdout.write(' <%s>\nConnecting...\r' % url) sys.stdout.flush() msg = ConfigOpener().retrieve(url, targetfile, reporthook=reporthook) print '' # clear the line return targetfile except: print ' ** Error occurred while downloading\n <%s>' % url raise def md5sum(targetfile): """md5sum a file. Return the hex digest.""" digest = hashlib.md5() with open(targetfile, 'rb') as f: chunk = f.read(1024) while chunk != "": digest.update(chunk) chunk = f.read(1024) return digest.hexdigest() def unpack(packedfile, parent_path): """Unpacks packedfile into parent_path. Assumes .zip. Returns parent_path""" if zipfile.is_zipfile(packedfile): with contextlib.closing(zipfile.ZipFile(packedfile, 'r')) as icuzip: print ' Extracting zipfile: %s' % packedfile icuzip.extractall(parent_path) return parent_path elif tarfile.is_tarfile(packedfile): with tarfile.TarFile.open(packedfile, 'r') as icuzip: print ' Extracting tarfile: %s' % packedfile icuzip.extractall(parent_path) return parent_path else: packedsuffix = packedfile.lower().split('.')[-1] # .zip, .tgz etc raise Exception('Error: Don\'t know how to unpack %s with extension %s' % (packedfile, packedsuffix)) # List of possible "--download=" types. download_types = set(['icu']) # Default options for --download. download_default = "none" def help(): """This function calculates the '--help' text for '--download'.""" return """Select which packages may be auto-downloaded. valid values are: none, all, %s. (default is "%s").""" % (", ".join(download_types), download_default) def set2dict(keys, value=None): """Convert some keys (iterable) to a dict.""" return dict((key, value) for (key) in keys) def parse(opt): """This function parses the options to --download and returns a set such as { icu: true }, etc. """ if not opt: opt = download_default theOpts = set(opt.split(',')) if 'all' in theOpts: # all on return set2dict(download_types, True) elif 'none' in theOpts: # all off return set2dict(download_types, False) # OK. Now, process each of the opts. theRet = set2dict(download_types, False) for anOpt in opt.split(','): if not anOpt or anOpt == "": # ignore stray commas, etc. continue elif anOpt is 'all': # all on theRet = dict((key, True) for (key) in download_types) else: # turn this one on if anOpt in download_types: theRet[anOpt] = True else: # future proof: ignore unknown types print 'Warning: ignoring unknown --download= type "%s"' % anOpt # all done return theRet def candownload(auto_downloads, package): if not (package in auto_downloads.keys()): raise Exception('Internal error: "%s" is not in the --downloads list. Check nodedownload.py' % package) if auto_downloads[package]: return True else: print """Warning: Not downloading package "%s". You could pass "--download=all" (Windows: "download-all") to try auto-downloading it.""" % package return False node-v4.8.2/test/.eslintrc.yaml000644 000766 000024 00000000207 13070706736 016524 0ustar00iojsstaff000000 000000 ## Test-specific linter rules rules: ## common module is mandatory in tests required-modules: [2, "common"] globals: gc: false node-v4.8.2/test/abort/000755 000766 000024 00000000000 13070706736 015047 5ustar00iojsstaff000000 000000 node-v4.8.2/test/addons/000755 000766 000024 00000000000 13070706736 015210 5ustar00iojsstaff000000 000000 node-v4.8.2/test/cctest/000755 000766 000024 00000000000 13070706736 015225 5ustar00iojsstaff000000 000000 node-v4.8.2/test/common.js000644 000766 000024 00000035562 13070706736 015601 0ustar00iojsstaff000000 000000 /* eslint-disable required-modules */ 'use strict'; var path = require('path'); var fs = require('fs'); var assert = require('assert'); var os = require('os'); var child_process = require('child_process'); const stream = require('stream'); const util = require('util'); const testRoot = process.env.NODE_TEST_DIR ? fs.realpathSync(process.env.NODE_TEST_DIR) : __dirname; exports.testDir = __dirname; exports.fixturesDir = path.join(exports.testDir, 'fixtures'); exports.libDir = path.join(exports.testDir, '../lib'); exports.tmpDirName = 'tmp'; exports.PORT = +process.env.NODE_COMMON_PORT || 12346; exports.isWindows = process.platform === 'win32'; exports.isWOW64 = exports.isWindows && (process.env.PROCESSOR_ARCHITEW6432 !== undefined); exports.isAix = process.platform === 'aix'; exports.isLinuxPPCBE = (process.platform === 'linux') && (process.arch === 'ppc64') && (os.endianness() === 'BE'); exports.isSunOS = process.platform === 'sunos'; exports.isFreeBSD = process.platform === 'freebsd'; exports.enoughTestMem = os.totalmem() > 0x40000000; /* 1 Gb */ exports.rootDir = exports.isWindows ? 'c:\\' : '/'; exports.buildType = process.config.target_defaults.default_configuration; function rimrafSync(p) { try { var st = fs.lstatSync(p); } catch (e) { if (e.code === 'ENOENT') return; } try { if (st && st.isDirectory()) rmdirSync(p, null); else fs.unlinkSync(p); } catch (e) { if (e.code === 'ENOENT') return; if (e.code === 'EPERM') return rmdirSync(p, e); if (e.code !== 'EISDIR') throw e; rmdirSync(p, e); } } function rmdirSync(p, originalEr) { try { fs.rmdirSync(p); } catch (e) { if (e.code === 'ENOTDIR') throw originalEr; if (e.code === 'ENOTEMPTY' || e.code === 'EEXIST' || e.code === 'EPERM') { fs.readdirSync(p).forEach(function(f) { rimrafSync(path.join(p, f)); }); fs.rmdirSync(p); } } } exports.refreshTmpDir = function() { rimrafSync(exports.tmpDir); fs.mkdirSync(exports.tmpDir); }; if (process.env.TEST_THREAD_ID) { exports.PORT += process.env.TEST_THREAD_ID * 100; exports.tmpDirName += '.' + process.env.TEST_THREAD_ID; } exports.tmpDir = path.join(testRoot, exports.tmpDirName); var opensslCli = null; var inFreeBSDJail = null; var localhostIPv4 = null; exports.localIPv6Hosts = ['localhost']; if (process.platform === 'linux') { exports.localIPv6Hosts = [ // Debian/Ubuntu 'ip6-localhost', 'ip6-loopback', // SUSE 'ipv6-localhost', 'ipv6-loopback', // Typically universal 'localhost', ]; } Object.defineProperty(exports, 'inFreeBSDJail', { get: function() { if (inFreeBSDJail !== null) return inFreeBSDJail; if (process.platform === 'freebsd' && child_process.execSync('sysctl -n security.jail.jailed').toString() === '1\n') { inFreeBSDJail = true; } else { inFreeBSDJail = false; } return inFreeBSDJail; } }); Object.defineProperty(exports, 'localhostIPv4', { get: function() { if (localhostIPv4 !== null) return localhostIPv4; if (exports.inFreeBSDJail) { // Jailed network interfaces are a bit special - since we need to jump // through loops, as well as this being an exception case, assume the // user will provide this instead. if (process.env.LOCALHOST) { localhostIPv4 = process.env.LOCALHOST; } else { console.error('Looks like we\'re in a FreeBSD Jail. ' + 'Please provide your default interface address ' + 'as LOCALHOST or expect some tests to fail.'); } } if (localhostIPv4 === null) localhostIPv4 = '127.0.0.1'; return localhostIPv4; } }); // opensslCli defined lazily to reduce overhead of spawnSync Object.defineProperty(exports, 'opensslCli', {get: function() { if (opensslCli !== null) return opensslCli; if (process.config.variables.node_shared_openssl) { // use external command opensslCli = 'openssl'; } else { // use command built from sources included in Node.js repository opensslCli = path.join(path.dirname(process.execPath), 'openssl-cli'); } if (exports.isWindows) opensslCli += '.exe'; var openssl_cmd = child_process.spawnSync(opensslCli, ['version']); if (openssl_cmd.status !== 0 || openssl_cmd.error !== undefined) { // openssl command cannot be executed opensslCli = false; } return opensslCli; }, enumerable: true }); Object.defineProperty(exports, 'hasCrypto', { get: function() { return process.versions.openssl ? true : false; } }); Object.defineProperty(exports, 'hasFipsCrypto', { get: function() { return process.config.variables.openssl_fips ? true : false; } }); if (exports.isWindows) { exports.PIPE = '\\\\.\\pipe\\libuv-test'; if (process.env.TEST_THREAD_ID) { exports.PIPE += '.' + process.env.TEST_THREAD_ID; } } else { exports.PIPE = exports.tmpDir + '/test.sock'; } if (exports.isWindows) { exports.faketimeCli = false; } else { exports.faketimeCli = path.join(__dirname, '..', 'tools', 'faketime', 'src', 'faketime'); } var ifaces = os.networkInterfaces(); exports.hasIPv6 = Object.keys(ifaces).some(function(name) { return /lo/.test(name) && ifaces[name].some(function(info) { return info.family === 'IPv6'; }); }); exports.ddCommand = function(filename, kilobytes) { if (exports.isWindows) { var p = path.resolve(exports.fixturesDir, 'create-file.js'); return '"' + process.argv[0] + '" "' + p + '" "' + filename + '" ' + (kilobytes * 1024); } else { return 'dd if=/dev/zero of="' + filename + '" bs=1024 count=' + kilobytes; } }; exports.spawnCat = function(options) { var spawn = require('child_process').spawn; if (exports.isWindows) { return spawn('more', [], options); } else { return spawn('cat', [], options); } }; exports.spawnSyncCat = function(options) { var spawnSync = require('child_process').spawnSync; if (exports.isWindows) { return spawnSync('more', [], options); } else { return spawnSync('cat', [], options); } }; exports.spawnPwd = function(options) { var spawn = require('child_process').spawn; if (exports.isWindows) { return spawn('cmd.exe', ['/c', 'cd'], options); } else { return spawn('pwd', [], options); } }; exports.spawnSyncPwd = function(options) { const spawnSync = require('child_process').spawnSync; if (exports.isWindows) { return spawnSync('cmd.exe', ['/c', 'cd'], options); } else { return spawnSync('pwd', [], options); } }; exports.platformTimeout = function(ms) { if (process.config.target_defaults.default_configuration === 'Debug') ms = 2 * ms; if (exports.isAix) return 2 * ms; // default localhost speed is slower on AIX if (process.arch !== 'arm') return ms; const armv = process.config.variables.arm_version; if (armv === '6') return 7 * ms; // ARMv6 if (armv === '7') return 2 * ms; // ARMv7 return ms; // ARMv8+ }; var knownGlobals = [setTimeout, setInterval, setImmediate, clearTimeout, clearInterval, clearImmediate, console, constructor, // Enumerable in V8 3.21. Buffer, process, global]; if (global.gc) { knownGlobals.push(gc); } if (global.DTRACE_HTTP_SERVER_RESPONSE) { knownGlobals.push(DTRACE_HTTP_SERVER_RESPONSE); knownGlobals.push(DTRACE_HTTP_SERVER_REQUEST); knownGlobals.push(DTRACE_HTTP_CLIENT_RESPONSE); knownGlobals.push(DTRACE_HTTP_CLIENT_REQUEST); knownGlobals.push(DTRACE_NET_STREAM_END); knownGlobals.push(DTRACE_NET_SERVER_CONNECTION); } if (global.COUNTER_NET_SERVER_CONNECTION) { knownGlobals.push(COUNTER_NET_SERVER_CONNECTION); knownGlobals.push(COUNTER_NET_SERVER_CONNECTION_CLOSE); knownGlobals.push(COUNTER_HTTP_SERVER_REQUEST); knownGlobals.push(COUNTER_HTTP_SERVER_RESPONSE); knownGlobals.push(COUNTER_HTTP_CLIENT_REQUEST); knownGlobals.push(COUNTER_HTTP_CLIENT_RESPONSE); } if (global.LTTNG_HTTP_SERVER_RESPONSE) { knownGlobals.push(LTTNG_HTTP_SERVER_RESPONSE); knownGlobals.push(LTTNG_HTTP_SERVER_REQUEST); knownGlobals.push(LTTNG_HTTP_CLIENT_RESPONSE); knownGlobals.push(LTTNG_HTTP_CLIENT_REQUEST); knownGlobals.push(LTTNG_NET_STREAM_END); knownGlobals.push(LTTNG_NET_SERVER_CONNECTION); } if (global.ArrayBuffer) { knownGlobals.push(ArrayBuffer); knownGlobals.push(Int8Array); knownGlobals.push(Uint8Array); knownGlobals.push(Uint8ClampedArray); knownGlobals.push(Int16Array); knownGlobals.push(Uint16Array); knownGlobals.push(Int32Array); knownGlobals.push(Uint32Array); knownGlobals.push(Float32Array); knownGlobals.push(Float64Array); knownGlobals.push(DataView); } // Harmony features. if (global.Proxy) { knownGlobals.push(Proxy); } if (global.Symbol) { knownGlobals.push(Symbol); } function allowGlobals() { knownGlobals = knownGlobals.concat(Array.from(arguments)); } exports.allowGlobals = allowGlobals; function leakedGlobals() { var leaked = []; for (var val in global) if (-1 === knownGlobals.indexOf(global[val])) leaked.push(val); return leaked; } exports.leakedGlobals = leakedGlobals; // Turn this off if the test should not check for global leaks. exports.globalCheck = true; process.on('exit', function() { if (!exports.globalCheck) return; var leaked = leakedGlobals(); if (leaked.length > 0) { exports.fail(`Unexpected global(s) found: ${leaked.join(', ')}`); } }); var mustCallChecks = []; function runCallChecks(exitCode) { if (exitCode !== 0) return; var failed = mustCallChecks.filter(function(context) { return context.actual !== context.expected; }); failed.forEach(function(context) { console.log('Mismatched %s function calls. Expected %d, actual %d.', context.name, context.expected, context.actual); console.log(context.stack.split('\n').slice(2).join('\n')); }); if (failed.length) process.exit(1); } exports.mustCall = function(fn, expected) { if (typeof expected !== 'number') expected = 1; var context = { expected: expected, actual: 0, stack: (new Error()).stack, name: fn.name || '' }; // add the exit listener only once to avoid listener leak warnings if (mustCallChecks.length === 0) process.on('exit', runCallChecks); mustCallChecks.push(context); return function() { context.actual++; return fn.apply(this, arguments); }; }; var etcServicesFileName = path.join('/etc', 'services'); if (exports.isWindows) { etcServicesFileName = path.join(process.env.SystemRoot, 'System32', 'drivers', 'etc', 'services'); } /* * Returns a string that represents the service name associated * to the service bound to port "port" and using protocol "protocol". * * If the service is not defined in the services file, it returns * the port number as a string. * * Returns undefined if /etc/services (or its equivalent on non-UNIX * platforms) can't be read. */ exports.getServiceName = function getServiceName(port, protocol) { if (port == null) { throw new Error('Missing port number'); } if (typeof protocol !== 'string') { throw new Error('Protocol must be a string'); } /* * By default, if a service can't be found in /etc/services, * its name is considered to be its port number. */ var serviceName = port.toString(); try { var servicesContent = fs.readFileSync(etcServicesFileName, { encoding: 'utf8'}); var regexp = `^(\\w+)\\s+\\s${port}/${protocol}\\s`; var re = new RegExp(regexp, 'm'); var matches = re.exec(servicesContent); if (matches && matches.length > 1) { serviceName = matches[1]; } } catch (e) { console.error('Cannot read file: ', etcServicesFileName); return undefined; } return serviceName; }; exports.hasMultiLocalhost = function hasMultiLocalhost() { var TCP = process.binding('tcp_wrap').TCP; var t = new TCP(); var ret = t.bind('127.0.0.2', exports.PORT); t.close(); return ret === 0; }; exports.fileExists = function(pathname) { try { fs.accessSync(pathname); return true; } catch (err) { return false; } }; exports.fail = function(msg) { assert.fail(null, null, msg); }; exports.skip = function(msg) { console.log(`1..0 # Skipped: ${msg}`); }; // Returns true if the exit code "exitCode" and/or signal name "signal" // represent the exit code and/or signal name of a node process that aborted, // false otherwise. exports.nodeProcessAborted = function nodeProcessAborted(exitCode, signal) { // Depending on the compiler used, node will exit with either // exit code 132 (SIGILL), 133 (SIGTRAP) or 134 (SIGABRT). var expectedExitCodes = [132, 133, 134]; // On platforms using KSH as the default shell (like SmartOS), // when a process aborts, KSH exits with an exit code that is // greater than 256, and thus the exit code emitted with the 'exit' // event is null and the signal is set to either SIGILL, SIGTRAP, // or SIGABRT (depending on the compiler). const expectedSignals = ['SIGILL', 'SIGTRAP', 'SIGABRT']; // On Windows, v8's base::OS::Abort triggers an access violation, // which corresponds to exit code 3221225477 (0xC0000005) if (process.platform === 'win32') expectedExitCodes = [3221225477]; // When using --abort-on-uncaught-exception, V8 will use // base::OS::Abort to terminate the process. // Depending on the compiler used, the shell or other aspects of // the platform used to build the node binary, this will actually // make V8 exit by aborting or by raising a signal. In any case, // one of them (exit code or signal) needs to be set to one of // the expected exit codes or signals. if (signal !== null) { return expectedSignals.indexOf(signal) > -1; } else { return expectedExitCodes.indexOf(exitCode) > -1; } }; // A stream to push an array into a REPL function ArrayStream() { this.run = function(data) { data.forEach((line) => { this.emit('data', line + '\n'); }); }; } util.inherits(ArrayStream, stream.Stream); exports.ArrayStream = ArrayStream; ArrayStream.prototype.readable = true; ArrayStream.prototype.writable = true; ArrayStream.prototype.pause = function() {}; ArrayStream.prototype.resume = function() {}; ArrayStream.prototype.write = function() {}; exports.expectWarning = function(name, expected) { if (typeof expected === 'string') expected = [expected]; process.on('warning', exports.mustCall((warning) => { assert.strictEqual(warning.name, name); assert.ok(expected.includes(warning.message), `unexpected error message: "${warning.message}"`); // Remove a warning message after it is seen so that we guarantee that we // get each message only once. expected.splice(expected.indexOf(warning.message), 1); }, expected.length)); }; node-v4.8.2/test/debugger/000755 000766 000024 00000000000 13070706736 015524 5ustar00iojsstaff000000 000000 node-v4.8.2/test/disabled/000755 000766 000024 00000000000 13070706736 015507 5ustar00iojsstaff000000 000000 node-v4.8.2/test/doctool/000755 000766 000024 00000000000 13070706736 015403 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/000755 000766 000024 00000000000 13070706736 015611 5ustar00iojsstaff000000 000000 node-v4.8.2/test/gc/000755 000766 000024 00000000000 13070706736 014331 5ustar00iojsstaff000000 000000 node-v4.8.2/test/internet/000755 000766 000024 00000000000 13070706736 015570 5ustar00iojsstaff000000 000000 node-v4.8.2/test/known_issues/000755 000766 000024 00000000000 13070706736 016467 5ustar00iojsstaff000000 000000 node-v4.8.2/test/message/000755 000766 000024 00000000000 13070706736 015364 5ustar00iojsstaff000000 000000 node-v4.8.2/test/parallel/000755 000766 000024 00000000000 13070706737 015535 5ustar00iojsstaff000000 000000 node-v4.8.2/test/pseudo-tty/000755 000766 000024 00000000000 13070706737 016056 5ustar00iojsstaff000000 000000 node-v4.8.2/test/pummel/000755 000766 000024 00000000000 13070706737 015240 5ustar00iojsstaff000000 000000 node-v4.8.2/test/README.md000644 000766 000024 00000003720 13070706736 015221 0ustar00iojsstaff000000 000000 # Tests ### abort Tests for when the `--abort-on-uncaught-exception` flag is used. | Runs on CI | |:----------:| | No | ### addons Tests for [addon](https://nodejs.org/api/addons.html) functionality along with some tests that require an addon to function properly. | Runs on CI | |:----------:| | Yes | ### cctest C++ test that is run as part of the build process. | Runs on CI | |:----------:| | Yes | ### debugger Tests for [debugger](https://nodejs.org/api/debugger.html) functionality. | Runs on CI | |:----------:| | No | ### disabled Tests that have been disabled from running for various reasons. | Runs on CI | |:----------:| | No | ### fixtures Test fixtures used in various tests throughout the test suite. ### gc Tests for garbage collection related functionality. | Runs on CI | |:----------:| | No | ### internet Tests that make real outbound connections (mainly networking related modules). Tests for networking related modules may also be present in other directories, but those tests do not make outbound connections. | Runs on CI | |:----------:| | No | ### known_issues Tests reproducing known issues within the system. | Runs on CI | |:----------:| | No | ### message Tests for messages that are output for various conditions (`console.log`, error messages etc.) | Runs on CI | |:----------:| | Yes | ### parallel Various tests that are able to be run in parallel. | Runs on CI | |:----------:| | Yes | ### pummel Various tests for various modules / system functionality operating under load. | Runs on CI | |:----------:| | No | ### sequential Various tests that are run sequentially. | Runs on CI | |:----------:| | Yes | ### testpy Test configuration utility used by various test suites. ### timers Tests for [timing utilities](https://nodejs.org/api/timers.html) (`setTimeout` and `setInterval`). | Runs on CI | |:----------:| | No | node-v4.8.2/test/sequential/000755 000766 000024 00000000000 13070706737 016113 5ustar00iojsstaff000000 000000 node-v4.8.2/test/testpy/000755 000766 000024 00000000000 13070706737 015271 5ustar00iojsstaff000000 000000 node-v4.8.2/test/timers/000755 000766 000024 00000000000 13070706737 015244 5ustar00iojsstaff000000 000000 node-v4.8.2/test/timers/test-timers-reliability.js000644 000766 000024 00000003175 13070706737 022377 0ustar00iojsstaff000000 000000 'use strict'; // FaketimeFlags: --exclude-monotonic -f '2014-07-21 09:00:00' require('../common'); var Timer = process.binding('timer_wrap').Timer; var assert = require('assert'); var timerFired = false; var intervalFired = false; /* * This test case aims at making sure that timing utilities such * as setTimeout and setInterval are not vulnerable to time * drifting or inconsistent time changes (such as ntp time sync * in the past, etc.). * * It is run using faketime so that we change how * non-monotonic clocks perceive time movement. We freeze * non-monotonic time, and check if setTimeout and setInterval * work properly in that situation. * * We check this by setting a timer based on a monotonic clock * to fire after setTimeout's callback is supposed to be called. * This monotonic timer, by definition, is not subject to time drifting * and inconsistent time changes, so it can be considered as a solid * reference. * * When the monotonic timer fires, if the setTimeout's callback * hasn't been called yet, it means that setTimeout's underlying timer * is vulnerable to time drift or inconsistent time changes. */ var monoTimer = new Timer(); monoTimer[Timer.kOnTimeout] = function() { /* * Make sure that setTimeout's and setInterval's callbacks have * already fired, otherwise it means that they are vulnerable to * time drifting or inconsistent time changes. */ assert(timerFired); assert(intervalFired); }; monoTimer.start(300, 0); setTimeout(function() { timerFired = true; }, 200); var interval = setInterval(function() { intervalFired = true; clearInterval(interval); }, 200); node-v4.8.2/test/timers/testcfg.py000644 000766 000024 00000007307 13070706737 017264 0ustar00iojsstaff000000 000000 # Copyright 2008 the V8 project authors. All rights reserved. # Redistribution and use in source and binary forms, with or without # modification, are permitted provided that the following conditions are # met: # # * Redistributions of source code must retain the above copyright # notice, this list of conditions and the following disclaimer. # * Redistributions in binary form must reproduce the above # copyright notice, this list of conditions and the following # disclaimer in the documentation and/or other materials provided # with the distribution. # * Neither the name of Google Inc. nor the names of its # contributors may be used to endorse or promote products derived # from this software without specific prior written permission. # # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. import test import os import shutil from shutil import rmtree from os import mkdir from glob import glob from os.path import join, dirname, exists import re import shlex FAKETIME_FLAGS_PATTERN = re.compile(r"//\s+FaketimeFlags:(.*)") FAKETIME_BIN_PATH = os.path.join("tools", "faketime", "src", "faketime") class TimersTestCase(test.TestCase): def __init__(self, path, file, arch, mode, context, config): super(TimersTestCase, self).__init__(context, path, arch, mode) self.file = file self.config = config self.arch = arch self.mode = mode def GetLabel(self): return "%s %s" % (self.mode, self.GetName()) def GetName(self): return self.path[-1] def GetCommand(self): result = [FAKETIME_BIN_PATH]; source = open(self.file).read() faketime_flags_match = FAKETIME_FLAGS_PATTERN.search(source) if faketime_flags_match: result += shlex.split(faketime_flags_match.group(1).strip()) result += [self.config.context.GetVm(self.arch, self.mode)] result += [self.file] return result def GetSource(self): return open(self.file).read() class TimersTestConfiguration(test.TestConfiguration): def __init__(self, context, root): super(TimersTestConfiguration, self).__init__(context, root) def Ls(self, path): def SelectTest(name): return name.startswith('test-') and name.endswith('.js') return [f[:-3] for f in os.listdir(path) if SelectTest(f)] def ListTests(self, current_path, path, arch, mode): all_tests = [current_path + [t] for t in self.Ls(join(self.root))] result = [] for test in all_tests: if self.Contains(path, test): file_path = join(self.root, reduce(join, test[1:], "") + ".js") result.append(TimersTestCase(test, file_path, arch, mode, self.context, self)) return result def GetBuildRequirements(self): return ['sample', 'sample=shell'] def GetTestStatus(self, sections, defs): status_file = join(self.root, 'simple.status') if exists(status_file): test.ReadConfigurationInto(status_file, sections, defs) def GetConfiguration(context, root): return TimersTestConfiguration(context, root) node-v4.8.2/test/testpy/__init__.py000644 000766 000024 00000013050 13070706737 017401 0ustar00iojsstaff000000 000000 # Copyright 2008 the V8 project authors. All rights reserved. # Redistribution and use in source and binary forms, with or without # modification, are permitted provided that the following conditions are # met: # # * Redistributions of source code must retain the above copyright # notice, this list of conditions and the following disclaimer. # * Redistributions in binary form must reproduce the above # copyright notice, this list of conditions and the following # disclaimer in the documentation and/or other materials provided # with the distribution. # * Neither the name of Google Inc. nor the names of its # contributors may be used to endorse or promote products derived # from this software without specific prior written permission. # # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. import test import os import shutil from os import mkdir from glob import glob from os.path import join, dirname, exists import re FLAGS_PATTERN = re.compile(r"//\s+Flags:(.*)") FILES_PATTERN = re.compile(r"//\s+Files:(.*)") class SimpleTestCase(test.TestCase): def __init__(self, path, file, arch, mode, context, config, additional=None): super(SimpleTestCase, self).__init__(context, path, arch, mode) self.file = file self.config = config self.arch = arch self.mode = mode self.tmpdir = join(dirname(self.config.root), 'tmp') if additional is not None: self.additional_flags = additional else: self.additional_flags = [] def GetLabel(self): return "%s %s" % (self.mode, self.GetName()) def GetName(self): return self.path[-1] def GetCommand(self): result = [self.config.context.GetVm(self.arch, self.mode)] source = open(self.file).read() flags_match = FLAGS_PATTERN.search(source) if flags_match: result += flags_match.group(1).strip().split() files_match = FILES_PATTERN.search(source); additional_files = [] if files_match: additional_files += files_match.group(1).strip().split() for a_file in additional_files: result.append(join(dirname(self.config.root), '..', a_file)) if self.additional_flags: result += self.additional_flags result += [self.file] return result def GetSource(self): return open(self.file).read() class SimpleTestConfiguration(test.TestConfiguration): def __init__(self, context, root, section, additional=None): super(SimpleTestConfiguration, self).__init__(context, root) self.section = section if additional is not None: self.additional_flags = additional else: self.additional_flags = [] def Ls(self, path): def SelectTest(name): return name.startswith('test-') and name.endswith('.js') return [f[:-3] for f in os.listdir(path) if SelectTest(f)] def ListTests(self, current_path, path, arch, mode): all_tests = [current_path + [t] for t in self.Ls(join(self.root))] result = [] for test in all_tests: if self.Contains(path, test): file_path = join(self.root, reduce(join, test[1:], "") + ".js") result.append(SimpleTestCase(test, file_path, arch, mode, self.context, self, self.additional_flags)) return result def GetBuildRequirements(self): return ['sample', 'sample=shell'] def GetTestStatus(self, sections, defs): status_file = join(self.root, '%s.status' % (self.section)) if exists(status_file): test.ReadConfigurationInto(status_file, sections, defs) class ParallelTestConfiguration(SimpleTestConfiguration): def __init__(self, context, root, section, additional=None): super(ParallelTestConfiguration, self).__init__(context, root, section, additional) def ListTests(self, current_path, path, arch, mode): result = super(ParallelTestConfiguration, self).ListTests( current_path, path, arch, mode) for test in result: test.parallel = True return result class AddonTestConfiguration(SimpleTestConfiguration): def __init__(self, context, root, section, additional=None): super(AddonTestConfiguration, self).__init__(context, root, section, additional) def Ls(self, path): def SelectTest(name): return name.endswith('.js') result = [] for subpath in os.listdir(path): if os.path.isdir(join(path, subpath)): for f in os.listdir(join(path, subpath)): if SelectTest(f): result.append([subpath, f[:-3]]) return result def ListTests(self, current_path, path, arch, mode): all_tests = [current_path + t for t in self.Ls(join(self.root))] result = [] for test in all_tests: if self.Contains(path, test): file_path = join(self.root, reduce(join, test[1:], "") + ".js") result.append( SimpleTestCase(test, file_path, arch, mode, self.context, self)) return result node-v4.8.2/test/sequential/sequential.status000644 000766 000024 00000001225 13070706737 021532 0ustar00iojsstaff000000 000000 prefix sequential # To mark a test as flaky, list the test name in the appropriate section # below, without ".js", followed by ": PASS,FLAKY". Example: # sample-test : PASS,FLAKY [true] # This section applies to all platforms [$system==win32] [$system==linux] [$system==macos] [$system==solaris] # Also applies to SmartOS [$system==freebsd] # fs-watch currently needs special configuration on AIX and we # want to improve under https://github.com/nodejs/node/issues/5085. # Tests are disabled so CI can be green and we can spot other # regressions until this work is complete [$system==aix] test-fs-watch : FAIL,PASS node-v4.8.2/test/sequential/test-child-process-emfile.js000644 000766 000024 00000002553 13070706737 023431 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const child_process = require('child_process'); const fs = require('fs'); if (common.isWindows) { common.skip('no RLIMIT_NOFILE on Windows'); return; } const ulimit = Number(child_process.execSync('ulimit -Hn')); if (ulimit > 64 || Number.isNaN(ulimit)) { // Sorry about this nonsense. It can be replaced if // https://github.com/nodejs/node-v0.x-archive/pull/2143#issuecomment-2847886 // ever happens. const result = child_process.spawnSync( '/bin/sh', ['-c', `ulimit -n 64 && '${process.execPath}' '${__filename}'`] ); assert.strictEqual(result.stdout.toString(), ''); assert.strictEqual(result.stderr.toString(), ''); assert.strictEqual(result.status, 0); assert.strictEqual(result.error, undefined); return; } const openFds = []; for (;;) { try { openFds.push(fs.openSync(__filename, 'r')); } catch (err) { assert(err.code === 'EMFILE'); break; } } // Should emit an error, not throw. const proc = child_process.spawn(process.execPath, ['-e', '0']); proc.on('error', common.mustCall(function(err) { assert.strictEqual(err.code, 'EMFILE'); })); proc.on('exit', function() { common.fail('"exit" should not be emitted (the process never spawned!)'); }); // close one fd for LSan if (openFds.length >= 1) { fs.closeSync(openFds.pop()); } node-v4.8.2/test/sequential/test-child-process-execsync.js000644 000766 000024 00000005361 13070706737 024011 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var execSync = require('child_process').execSync; var execFileSync = require('child_process').execFileSync; var TIMER = 200; var SLEEP = 2000; var start = Date.now(); var err; var caught = false; // Verify that stderr is not accessed when a bad shell is used assert.throws( function() { execSync('exit -1', {shell: 'bad_shell'}); }, /ENOENT/, 'execSync did not throw the expected exception!' ); assert.throws( function() { execFileSync('exit -1', {shell: 'bad_shell'}); }, /ENOENT/, 'execFileSync did not throw the expected exception!' ); try { var cmd = `"${process.execPath}" -e "setTimeout(function(){}, ${SLEEP});"`; var ret = execSync(cmd, {timeout: TIMER}); } catch (e) { caught = true; assert.strictEqual(e.errno, 'ETIMEDOUT'); err = e; } finally { assert.strictEqual(ret, undefined, 'we should not have a return value'); assert.strictEqual(caught, true, 'execSync should throw'); var end = Date.now() - start; assert(end < SLEEP); assert(err.status > 128 || err.signal); } assert.throws(function() { execSync('iamabadcommand'); }, /Command failed: iamabadcommand/); var msg = 'foobar'; var msgBuf = new Buffer(msg + '\n'); // console.log ends every line with just '\n', even on Windows. cmd = `"${process.execPath}" -e "console.log(\'${msg}\');"`; ret = execSync(cmd); assert.strictEqual(ret.length, msgBuf.length); assert.deepEqual(ret, msgBuf, 'execSync result buffer should match'); ret = execSync(cmd, { encoding: 'utf8' }); assert.strictEqual(ret, msg + '\n', 'execSync encoding result should match'); var args = [ '-e', `console.log("${msg}");` ]; ret = execFileSync(process.execPath, args); assert.deepEqual(ret, msgBuf); ret = execFileSync(process.execPath, args, { encoding: 'utf8' }); assert.strictEqual(ret, msg + '\n', 'execFileSync encoding result should match'); // Verify that the cwd option works - GH #7824 { const cwd = common.rootDir; const cmd = common.isWindows ? 'echo %cd%' : 'pwd'; const response = execSync(cmd, {cwd}); assert.strictEqual(response.toString().trim(), cwd); } // Verify that stderr is not accessed when stdio = 'ignore' - GH #7966 (function() { assert.throws(function() { execSync('exit -1', {stdio: 'ignore'}); }, /Command failed: exit -1/); })(); // Verify the execFileSync() behavior when the child exits with a non-zero code. { const args = ['-e', 'process.exit(1)']; assert.throws(() => { execFileSync(process.execPath, args); }, (err) => { const msg = `Command failed: ${process.execPath} ${args.join(' ')}`; assert(err instanceof Error); assert.strictEqual(err.message.trim(), msg); assert.strictEqual(err.status, 1); return true; }); } node-v4.8.2/test/sequential/test-child-process-fork-getconnections.js000644 000766 000024 00000004525 13070706737 026152 0ustar00iojsstaff000000 000000 'use strict'; const assert = require('assert'); const common = require('../common'); const fork = require('child_process').fork; const net = require('net'); const count = 12; if (process.argv[2] === 'child') { const sockets = []; process.on('message', function(m, socket) { function sendClosed(id) { process.send({ id: id, status: 'closed'}); } if (m.cmd === 'new') { assert(socket); assert(socket instanceof net.Socket, 'should be a net.Socket'); sockets.push(socket); } if (m.cmd === 'close') { assert.equal(socket, undefined); if (sockets[m.id].destroyed) { // Workaround for https://github.com/nodejs/node/issues/2610 sendClosed(m.id); // End of workaround. When bug is fixed, this code can be used instead: // throw new Error('socket destroyed unexpectedly!'); } else { sockets[m.id].once('close', sendClosed.bind(null, m.id)); sockets[m.id].destroy(); } } }); } else { const child = fork(process.argv[1], ['child']); child.on('exit', function(code, signal) { if (!childKilled) throw new Error('child died unexpectedly!'); }); const server = net.createServer(); const sockets = []; let sent = 0; server.on('connection', function(socket) { child.send({ cmd: 'new' }, socket); sockets.push(socket); if (sockets.length === count) { closeSockets(0); } }); let disconnected = 0; server.on('listening', function() { let j = count; while (j--) { const client = net.connect(common.PORT, '127.0.0.1'); client.on('close', function() { disconnected += 1; }); } }); let childKilled = false; function closeSockets(i) { if (i === count) { childKilled = true; server.close(); child.kill(); return; } child.once('message', function(m) { assert(m.status === 'closed'); server.getConnections(function(err, num) { closeSockets(i + 1); }); }); sent++; child.send({ id: i, cmd: 'close' }); } let closeEmitted = false; server.on('close', function() { closeEmitted = true; }); server.listen(common.PORT, '127.0.0.1'); process.on('exit', function() { assert.equal(sent, count); assert.equal(disconnected, count); assert.ok(closeEmitted); console.log('ok'); }); } node-v4.8.2/test/sequential/test-child-process-pass-fd.js000644 000766 000024 00000002520 13070706737 023517 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const fork = require('child_process').fork; const net = require('net'); if ((process.config.variables.arm_version === '6') || (process.config.variables.arm_version === '7')) { common.skip('Too slow for armv6 and armv7 bots'); return; } const N = 80; if (process.argv[2] !== 'child') { for (let i = 0; i < N; ++i) { const worker = fork(__filename, ['child', common.PORT + i]); worker.once('message', common.mustCall((msg, handle) => { assert.strictEqual(msg, 'handle'); assert.ok(handle); worker.send('got'); let recvData = ''; handle.on('data', common.mustCall((data) => { recvData += data; })); handle.on('end', () => { assert.strictEqual(recvData, 'hello'); worker.kill(); }); })); } } else { let socket; const port = process.argv[3]; let cbcalls = 0; function socketConnected() { if (++cbcalls === 2) process.send('handle', socket); } const server = net.createServer((c) => { process.once('message', function(msg) { assert.strictEqual(msg, 'got'); c.end('hello'); }); socketConnected(); }); server.listen(port, common.localhostIPv4, () => { socket = net.connect(port, common.localhostIPv4, socketConnected); }); } node-v4.8.2/test/sequential/test-debug-host-port.js000644 000766 000024 00000003357 13070706737 022461 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const spawn = require('child_process').spawn; let run = () => {}; function test(args, re) { const next = run; run = () => { const options = {encoding: 'utf8'}; const proc = spawn(process.execPath, args.concat(['-e', '0']), options); let stderr = ''; proc.stderr.setEncoding('utf8'); proc.stderr.on('data', (data) => { stderr += data; if (re.test(stderr)) proc.kill(); }); proc.on('exit', common.mustCall(() => { assert(re.test(stderr)); next(); })); }; } test(['--debug-brk'], /Debugger listening on (\[::\]|0\.0\.0\.0):5858/); test(['--debug-brk=1234'], /Debugger listening on (\[::\]|0\.0\.0\.0):1234/); test(['--debug-brk=127.0.0.1'], /Debugger listening on 127\.0\.0\.1:5858/); test(['--debug-brk=127.0.0.1:1234'], /Debugger listening on 127\.0\.0\.1:1234/); test(['--debug-brk=localhost'], /Debugger listening on (\[::\]|127\.0\.0\.1):5858/); test(['--debug-brk=localhost:1234'], /Debugger listening on (\[::\]|127\.0\.0\.1):1234/); if (common.hasIPv6) { test(['--debug-brk=::'], /Debug port must be in range 1024 to 65535/); test(['--debug-brk=::0'], /Debug port must be in range 1024 to 65535/); test(['--debug-brk=::1'], /Debug port must be in range 1024 to 65535/); test(['--debug-brk=[::]'], /Debugger listening on \[::\]:5858/); test(['--debug-brk=[::0]'], /Debugger listening on \[::\]:5858/); test(['--debug-brk=[::]:1234'], /Debugger listening on \[::\]:1234/); test(['--debug-brk=[::0]:1234'], /Debugger listening on \[::\]:1234/); test(['--debug-brk=[::ffff:127.0.0.1]:1234'], /Debugger listening on \[::ffff:127\.0\.0\.1\]:1234/); } run(); // Runs tests in reverse order. node-v4.8.2/test/sequential/test-deprecation-flags.js000644 000766 000024 00000003276 13070706737 023025 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var execFile = require('child_process').execFile; var depmod = require.resolve('../fixtures/deprecated.js'); var node = process.execPath; var depUserland = require.resolve(common.fixturesDir + '/deprecated-userland-function.js'); var normal = [depmod]; var noDep = ['--no-deprecation', depmod]; var traceDep = ['--trace-deprecation', depmod]; execFile(node, normal, function(er, stdout, stderr) { console.error('normal: show deprecation warning'); assert.equal(er, null); assert.equal(stdout, ''); assert.equal(stderr, '(node) util.p is deprecated. Use console.error ' + 'instead.\n\'This is deprecated\'\n'); console.log('normal ok'); }); execFile(node, noDep, function(er, stdout, stderr) { console.error('--no-deprecation: silence deprecations'); assert.equal(er, null); assert.equal(stdout, ''); assert.equal(stderr, '\'This is deprecated\'\n'); console.log('silent ok'); }); execFile(node, traceDep, function(er, stdout, stderr) { console.error('--trace-deprecation: show stack'); assert.equal(er, null); assert.equal(stdout, ''); var stack = stderr.trim().split('\n'); // just check the top and bottom. assert.equal(stack[0], 'Trace: util.p is deprecated. Use console.error instead.'); assert.equal(stack.pop(), '\'This is deprecated\''); console.log('trace ok'); }); execFile(node, [depUserland], function(er, stdout, stderr) { console.error('normal: testing deprecated userland function'); assert.equal(er, null); assert.equal(stdout, ''); assert.equal(0, stderr.indexOf('deprecatedFunction is deprecated.')); console.error('normal: ok'); }); node-v4.8.2/test/sequential/test-dgram-pingpong.js000644 000766 000024 00000002111 13070706737 022332 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const dgram = require('dgram'); function pingPongTest(port, host) { const server = dgram.createSocket('udp4', common.mustCall((msg, rinfo) => { assert.strictEqual('PING', msg.toString('ascii')); server.send('PONG', 0, 4, rinfo.port, rinfo.address); })); server.on('error', function(e) { throw e; }); server.on('listening', function() { console.log('server listening on ' + port); const client = dgram.createSocket('udp4'); client.on('message', function(msg) { assert.strictEqual('PONG', msg.toString('ascii')); client.close(); server.close(); }); client.on('error', function(e) { throw e; }); console.log('Client sending to ' + port); function clientSend() { client.send('PING', 0, 4, port, 'localhost'); } clientSend(); }); server.bind(port, host); return server; } const server = pingPongTest(common.PORT, 'localhost'); server.on('close', common.mustCall(pingPongTest.bind(undefined, common.PORT))); node-v4.8.2/test/sequential/test-fs-watch.js000644 000766 000024 00000006006 13070706737 021144 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var path = require('path'); var fs = require('fs'); var expectFilePath = common.isWindows || process.platform === 'linux' || process.platform === 'darwin'; var watchSeenOne = 0; var watchSeenTwo = 0; var watchSeenThree = 0; var testDir = common.tmpDir; var filenameOne = 'watch.txt'; var filepathOne = path.join(testDir, filenameOne); var filenameTwo = 'hasOwnProperty'; var filepathTwo = filenameTwo; var filepathTwoAbs = path.join(testDir, filenameTwo); var filenameThree = 'newfile.txt'; var testsubdir = path.join(testDir, 'testsubdir'); var filepathThree = path.join(testsubdir, filenameThree); process.on('exit', function() { assert.ok(watchSeenOne > 0); assert.ok(watchSeenTwo > 0); assert.ok(watchSeenThree > 0); }); common.refreshTmpDir(); fs.writeFileSync(filepathOne, 'hello'); assert.doesNotThrow( function() { var watcher = fs.watch(filepathOne); watcher.on('change', function(event, filename) { assert.equal('change', event); if (expectFilePath) { assert.equal('watch.txt', filename); } watcher.close(); ++watchSeenOne; }); } ); setImmediate(function() { fs.writeFileSync(filepathOne, 'world'); }); process.chdir(testDir); fs.writeFileSync(filepathTwoAbs, 'howdy'); assert.doesNotThrow( function() { var watcher = fs.watch(filepathTwo, function(event, filename) { assert.equal('change', event); if (expectFilePath) { assert.equal('hasOwnProperty', filename); } watcher.close(); ++watchSeenTwo; }); } ); setImmediate(function() { fs.writeFileSync(filepathTwoAbs, 'pardner'); }); fs.mkdirSync(testsubdir, 0o700); assert.doesNotThrow( function() { var watcher = fs.watch(testsubdir, function(event, filename) { var renameEv = common.isSunOS ? 'change' : 'rename'; assert.equal(renameEv, event); if (expectFilePath) { assert.equal('newfile.txt', filename); } else { assert.equal(null, filename); } watcher.close(); ++watchSeenThree; }); } ); setImmediate(function() { var fd = fs.openSync(filepathThree, 'w'); fs.closeSync(fd); }); // https://github.com/joyent/node/issues/2293 - non-persistent watcher should // not block the event loop fs.watch(__filename, {persistent: false}, function() { assert(0); }); // whitebox test to ensure that wrapped FSEvent is safe // https://github.com/joyent/node/issues/6690 var oldhandle; assert.throws(function() { var w = fs.watch(__filename, function(event, filename) { }); oldhandle = w._handle; w._handle = { close: w._handle.close }; w.close(); }, TypeError); oldhandle.close(); // clean up assert.throws(function() { var w = fs.watchFile(__filename, {persistent: false}, function() {}); oldhandle = w._handle; w._handle = { stop: w._handle.stop }; w.stop(); }, TypeError); oldhandle.stop(); // clean up node-v4.8.2/test/sequential/test-http-regr-gh-2928.js000644 000766 000024 00000003205 13070706737 022340 0ustar00iojsstaff000000 000000 // This test is designed to fail with a segmentation fault in Node.js 4.1.0 and // execute without issues in Node.js 4.1.1 and up. 'use strict'; const common = require('../common'); const assert = require('assert'); const httpCommon = require('_http_common'); const HTTPParser = process.binding('http_parser').HTTPParser; const net = require('net'); const COUNT = httpCommon.parsers.max + 1; const parsers = new Array(COUNT); for (var i = 0; i < parsers.length; i++) parsers[i] = httpCommon.parsers.alloc(); var gotRequests = 0; var gotResponses = 0; function execAndClose() { if (parsers.length === 0) return; process.stdout.write('.'); const parser = parsers.pop(); parser.reinitialize(HTTPParser.RESPONSE); const socket = net.connect(common.PORT); socket.on('error', (e) => { // If SmartOS and ECONNREFUSED, then retry. See // https://github.com/nodejs/node/issues/2663. if (common.isSunOS && e.code === 'ECONNREFUSED') { parsers.push(parser); socket.destroy(); setImmediate(execAndClose); return; } throw e; }); parser.consume(socket._handle._externalStream); parser.onIncoming = function onIncoming() { process.stdout.write('+'); gotResponses++; parser.unconsume(socket._handle._externalStream); httpCommon.freeParser(parser); socket.destroy(); setImmediate(execAndClose); }; } var server = net.createServer(function(c) { if (++gotRequests === COUNT) server.close(); c.end('HTTP/1.1 200 OK\r\n\r\n', function() { c.destroySoon(); }); }).listen(common.PORT, execAndClose); process.on('exit', function() { assert.equal(gotResponses, COUNT); }); node-v4.8.2/test/sequential/test-init.js000644 000766 000024 00000003377 13070706737 020403 0ustar00iojsstaff000000 000000 'use strict'; (function() { const assert = require('assert'); const child = require('child_process'); const util = require('util'); const common = require('../common'); if (process.env['TEST_INIT']) { util.print('Loaded successfully!'); } else { // change CWD as we do this test so its not dependant on current CWD // being in the test folder process.chdir(__dirname); // slow but simple var envCopy = JSON.parse(JSON.stringify(process.env)); envCopy.TEST_INIT = 1; child.exec('"' + process.execPath + '" test-init', {env: envCopy}, function(err, stdout, stderr) { assert.equal(stdout, 'Loaded successfully!', '`node test-init` failed!'); }); child.exec('"' + process.execPath + '" test-init.js', {env: envCopy}, function(err, stdout, stderr) { assert.equal(stdout, 'Loaded successfully!', '`node test-init.js` failed!'); }); // test-init-index is in fixtures dir as requested by ry, so go there process.chdir(common.fixturesDir); child.exec('"' + process.execPath + '" test-init-index', {env: envCopy}, function(err, stdout, stderr) { assert.equal(stdout, 'Loaded successfully!', '`node test-init-index failed!'); }); // ensures that `node fs` does not mistakenly load the native 'fs' module // instead of the desired file and that the fs module loads as // expected in node process.chdir(common.fixturesDir + '/test-init-native/'); child.exec('"' + process.execPath + '" fs', {env: envCopy}, function(err, stdout, stderr) { assert.equal(stdout, 'fs loaded successfully', '`node fs` failed!'); }); } })(); node-v4.8.2/test/sequential/test-module-loading.js000644 000766 000024 00000023273 13070706737 022335 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var path = require('path'); var fs = require('fs'); console.error('load test-module-loading.js'); // assert that this is the main module. assert.strictEqual(require.main.id, '.', 'main module should have id of \'.\''); assert.strictEqual(require.main, module, 'require.main should === module'); assert.strictEqual(process.mainModule, module, 'process.mainModule should === module'); // assert that it's *not* the main module in the required module. require('../fixtures/not-main-module.js'); // require a file with a request that includes the extension var a_js = require('../fixtures/a.js'); assert.strictEqual(42, a_js.number); // require a file without any extensions var foo_no_ext = require('../fixtures/foo'); assert.strictEqual('ok', foo_no_ext.foo); var a = require('../fixtures/a'); var c = require('../fixtures/b/c'); var d = require('../fixtures/b/d'); var d2 = require('../fixtures/b/d'); // Absolute var d3 = require(path.join(__dirname, '../fixtures/b/d')); // Relative var d4 = require('../fixtures/b/d'); assert.strictEqual(false, false, 'testing the test program.'); assert.ok(a.A instanceof Function); assert.strictEqual('A', a.A()); assert.ok(a.C instanceof Function); assert.strictEqual('C', a.C()); assert.ok(a.D instanceof Function); assert.strictEqual('D', a.D()); assert.ok(d.D instanceof Function); assert.strictEqual('D', d.D()); assert.ok(d2.D instanceof Function); assert.strictEqual('D', d2.D()); assert.ok(d3.D instanceof Function); assert.strictEqual('D', d3.D()); assert.ok(d4.D instanceof Function); assert.strictEqual('D', d4.D()); assert.ok((new a.SomeClass()) instanceof c.SomeClass); console.error('test index.js modules ids and relative loading'); const one = require('../fixtures/nested-index/one'); const two = require('../fixtures/nested-index/two'); assert.notStrictEqual(one.hello, two.hello); console.error('test index.js in a folder with a trailing slash'); const three = require('../fixtures/nested-index/three'); const threeFolder = require('../fixtures/nested-index/three/'); const threeIndex = require('../fixtures/nested-index/three/index.js'); assert.strictEqual(threeFolder, threeIndex); assert.notStrictEqual(threeFolder, three); console.error('test package.json require() loading'); assert.throws( function() { require('../fixtures/packages/invalid'); }, /^SyntaxError: Error parsing \S+: Unexpected token ,$/ ); assert.strictEqual(require('../fixtures/packages/main').ok, 'ok', 'Failed loading package'); assert.strictEqual(require('../fixtures/packages/main-index').ok, 'ok', 'Failed loading package with index.js in main subdir'); console.error('test cycles containing a .. path'); const root = require('../fixtures/cycles/root'); const foo = require('../fixtures/cycles/folder/foo'); assert.strictEqual(root.foo, foo); assert.strictEqual(root.sayHello(), root.hello); console.error('test node_modules folders'); // asserts are in the fixtures files themselves, // since they depend on the folder structure. require('../fixtures/node_modules/foo'); console.error('test name clashes'); // this one exists and should import the local module var my_path = require('../fixtures/path'); assert.ok(my_path.path_func instanceof Function); // this one does not exist and should throw assert.throws(function() { require('./utils'); }, /^Error: Cannot find module '.\/utils'$/); var errorThrown = false; try { require('../fixtures/throws_error'); } catch (e) { errorThrown = true; assert.strictEqual('blah', e.message); } assert.strictEqual(require('path').dirname(__filename), __dirname); console.error('load custom file types with extensions'); require.extensions['.test'] = function(module, filename) { var content = fs.readFileSync(filename).toString(); assert.strictEqual('this is custom source\n', content); content = content.replace('this is custom source', 'exports.test = \'passed\''); module._compile(content, filename); }; assert.strictEqual(require('../fixtures/registerExt').test, 'passed'); // unknown extension, load as .js assert.strictEqual(require('../fixtures/registerExt.hello.world').test, 'passed'); console.error('load custom file types that return non-strings'); require.extensions['.test'] = function(module) { module.exports = { custom: 'passed' }; }; assert.strictEqual(require('../fixtures/registerExt2').custom, 'passed'); assert.strictEqual(require('../fixtures/foo').foo, 'ok', 'require module with no extension'); assert.throws(function() { require.paths; }, /removed/, 'Accessing require.paths should throw.'); // Should not attempt to load a directory try { require('../fixtures/empty'); } catch (err) { assert.strictEqual(err.message, 'Cannot find module \'../fixtures/empty\''); } // Check load order is as expected console.error('load order'); const loadOrder = '../fixtures/module-load-order/'; const msg = 'Load order incorrect.'; require.extensions['.reg'] = require.extensions['.js']; require.extensions['.reg2'] = require.extensions['.js']; assert.strictEqual(require(loadOrder + 'file1').file1, 'file1', msg); assert.strictEqual(require(loadOrder + 'file2').file2, 'file2.js', msg); try { require(loadOrder + 'file3'); } catch (e) { // Not a real .node module, but we know we require'd the right thing. assert.ok(e.message.replace(/\\/g, '/').match(/file3\.node/)); } assert.strictEqual(require(loadOrder + 'file4').file4, 'file4.reg', msg); assert.strictEqual(require(loadOrder + 'file5').file5, 'file5.reg2', msg); assert.strictEqual(require(loadOrder + 'file6').file6, 'file6/index.js', msg); try { require(loadOrder + 'file7'); } catch (e) { assert.ok(e.message.replace(/\\/g, '/').match(/file7\/index\.node/)); } assert.strictEqual(require(loadOrder + 'file8').file8, 'file8/index.reg', msg); assert.strictEqual(require(loadOrder + 'file9').file9, 'file9/index.reg2', msg); // make sure that module.require() is the same as // doing require() inside of that module. var parent = require('../fixtures/module-require/parent/'); var child = require('../fixtures/module-require/child/'); assert.strictEqual(child.loaded, parent.loaded); // #1357 Loading JSON files with require() var json = require('../fixtures/packages/main/package.json'); assert.deepEqual(json, { name: 'package-name', version: '1.2.3', main: 'package-main-module' }); // now verify that module.children contains all the different // modules that we've required, and that all of them contain // the appropriate children, and so on. var children = module.children.reduce(function red(set, child) { var id = path.relative(path.dirname(__dirname), child.id); id = id.replace(/\\/g, '/'); set[id] = child.children.reduce(red, {}); return set; }, {}); assert.deepEqual(children, { 'common.js': {}, 'fixtures/not-main-module.js': {}, 'fixtures/a.js': { 'fixtures/b/c.js': { 'fixtures/b/d.js': {}, 'fixtures/b/package/index.js': {} } }, 'fixtures/foo': {}, 'fixtures/nested-index/one/index.js': { 'fixtures/nested-index/one/hello.js': {} }, 'fixtures/nested-index/two/index.js': { 'fixtures/nested-index/two/hello.js': {} }, 'fixtures/nested-index/three.js': {}, 'fixtures/nested-index/three/index.js': {}, 'fixtures/packages/main/package-main-module.js': {}, 'fixtures/packages/main-index/package-main-module/index.js': {}, 'fixtures/cycles/root.js': { 'fixtures/cycles/folder/foo.js': {} }, 'fixtures/node_modules/foo.js': { 'fixtures/node_modules/baz/index.js': { 'fixtures/node_modules/bar.js': {}, 'fixtures/node_modules/baz/node_modules/asdf.js': {} } }, 'fixtures/path.js': {}, 'fixtures/throws_error.js': {}, 'fixtures/registerExt.test': {}, 'fixtures/registerExt.hello.world': {}, 'fixtures/registerExt2.test': {}, 'fixtures/empty.js': {}, 'fixtures/module-load-order/file1': {}, 'fixtures/module-load-order/file2.js': {}, 'fixtures/module-load-order/file3.node': {}, 'fixtures/module-load-order/file4.reg': {}, 'fixtures/module-load-order/file5.reg2': {}, 'fixtures/module-load-order/file6/index.js': {}, 'fixtures/module-load-order/file7/index.node': {}, 'fixtures/module-load-order/file8/index.reg': {}, 'fixtures/module-load-order/file9/index.reg2': {}, 'fixtures/module-require/parent/index.js': { 'fixtures/module-require/child/index.js': { 'fixtures/module-require/child/node_modules/target.js': {} } }, 'fixtures/packages/main/package.json': {} }); // require() must take string, and must be truthy assert.throws(function() { console.error('require non-string'); require({ foo: 'bar' }); }, /path must be a string/); assert.throws(function() { console.error('require empty string'); require(''); }, /missing path/); process.on('exit', function() { assert.ok(a.A instanceof Function); assert.strictEqual('A done', a.A()); assert.ok(a.C instanceof Function); assert.strictEqual('C done', a.C()); assert.ok(a.D instanceof Function); assert.strictEqual('D done', a.D()); assert.ok(d.D instanceof Function); assert.strictEqual('D done', d.D()); assert.ok(d2.D instanceof Function); assert.strictEqual('D done', d2.D()); assert.strictEqual(true, errorThrown); console.log('exit'); }); // #1440 Loading files with a byte order marker. assert.strictEqual(42, require('../fixtures/utf8-bom.js')); assert.strictEqual(42, require('../fixtures/utf8-bom.json')); // Error on the first line of a module should // have the correct line number assert.throws(function() { require('../fixtures/test-error-first-line-offset.js'); }, function(err) { return /test-error-first-line-offset.js:1:/.test(err.stack); }, 'Expected appearance of proper offset in Error stack'); node-v4.8.2/test/sequential/test-net-GH-5504.js000644 000766 000024 00000004344 13070706737 021110 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); // this test only fails with CentOS 6.3 using kernel version 2.6.32 // On other linuxes and darwin, the `read` call gets an ECONNRESET in // that case. On sunos, the `write` call fails with EPIPE. // // However, old CentOS will occasionally send an EOF instead of a // ECONNRESET or EPIPE when the client has been destroyed abruptly. // // Make sure we don't keep trying to write or read more in that case. switch (process.argv[2]) { case 'server': return server(); case 'client': return client(); case undefined: return parent(); default: throw new Error('wtf'); } function server() { var net = require('net'); var content = new Buffer(64 * 1024 * 1024); content.fill('#'); net.createServer(function(socket) { this.close(); socket.on('end', function() { console.error('end'); }); socket.on('_socketEnd', function() { console.error('_socketEnd'); }); socket.write(content); }).listen(common.PORT, common.localhostIPv4, function() { console.log('listening'); }); } function client() { var net = require('net'); var client = net.connect({ host: common.localhostIPv4, port: common.PORT }, function() { client.destroy(); }); } function parent() { var spawn = require('child_process').spawn; var node = process.execPath; setTimeout(function() { if (s) s.kill(); if (c) c.kill(); setTimeout(function() { throw new Error('hang'); }); }, common.platformTimeout(2000)).unref(); var s = spawn(node, [__filename, 'server'], { env: Object.assign(process.env, { NODE_DEBUG: 'net' }) }); var c; wrap(s.stderr, process.stderr, 'SERVER 2>'); wrap(s.stdout, process.stdout, 'SERVER 1>'); s.on('exit', common.mustCall(function(c) {})); s.stdout.once('data', common.mustCall(function() { c = spawn(node, [__filename, 'client']); wrap(c.stderr, process.stderr, 'CLIENT 2>'); wrap(c.stdout, process.stdout, 'CLIENT 1>'); c.on('exit', common.mustCall(function(c) {})); })); function wrap(inp, out, w) { inp.setEncoding('utf8'); inp.on('data', function(c) { c = c.trim(); if (!c) return; out.write(w + c.split('\n').join('\n' + w) + '\n'); }); } } node-v4.8.2/test/sequential/test-net-server-address.js000644 000766 000024 00000005461 13070706737 023151 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var net = require('net'); // Test on IPv4 Server var family_ipv4 = 'IPv4'; var server_ipv4 = net.createServer(); server_ipv4.on('error', function(e) { console.log('Error on ipv4 socket: ' + e.toString()); }); server_ipv4.listen(common.PORT, common.localhostIPv4, function() { var address_ipv4 = server_ipv4.address(); assert.strictEqual(address_ipv4.address, common.localhostIPv4); assert.strictEqual(address_ipv4.port, common.PORT); assert.strictEqual(address_ipv4.family, family_ipv4); server_ipv4.close(); }); if (!common.hasIPv6) { common.skip('ipv6 part of test, no IPv6 support'); return; } // Test on IPv6 Server var localhost_ipv6 = '::1'; var family_ipv6 = 'IPv6'; var server_ipv6 = net.createServer(); server_ipv6.on('error', function(e) { console.log('Error on ipv6 socket: ' + e.toString()); }); server_ipv6.listen(common.PORT, localhost_ipv6, function() { var address_ipv6 = server_ipv6.address(); assert.strictEqual(address_ipv6.address, localhost_ipv6); assert.strictEqual(address_ipv6.port, common.PORT); assert.strictEqual(address_ipv6.family, family_ipv6); server_ipv6.close(); }); // Test without hostname or ip var anycast_ipv6 = '::'; var server1 = net.createServer(); server1.on('error', function(e) { console.log('Error on ip socket: ' + e.toString()); }); // Specify the port number server1.listen(common.PORT, function() { var address = server1.address(); assert.strictEqual(address.address, anycast_ipv6); assert.strictEqual(address.port, common.PORT); assert.strictEqual(address.family, family_ipv6); server1.close(); }); // Test without hostname or port var server2 = net.createServer(); server2.on('error', function(e) { console.log('Error on ip socket: ' + e.toString()); }); // Don't specify the port number server2.listen(function() { var address = server2.address(); assert.strictEqual(address.address, anycast_ipv6); assert.strictEqual(address.family, family_ipv6); server2.close(); }); // Test without hostname, but with a false-y port var server3 = net.createServer(); server3.on('error', function(e) { console.log('Error on ip socket: ' + e.toString()); }); // Specify a false-y port number server3.listen(0, function() { var address = server3.address(); assert.strictEqual(address.address, anycast_ipv6); assert.strictEqual(address.family, family_ipv6); server3.close(); }); // Test without hostname, but with port -1 var server4 = net.createServer(); server4.on('error', function(e) { console.log('Error on ip socket: ' + e.toString()); }); // Specify -1 as port number server4.listen(-1, function() { var address = server4.address(); assert.strictEqual(address.address, anycast_ipv6); assert.strictEqual(address.family, family_ipv6); server4.close(); }); node-v4.8.2/test/sequential/test-next-tick-error-spin.js000644 000766 000024 00000002034 13070706737 023431 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); if (process.argv[2] !== 'child') { const spawn = require('child_process').spawn; const child = spawn(process.execPath, [__filename, 'child'], { stdio: 'pipe'//'inherit' }); const timer = setTimeout(function() { throw new Error('child is hung'); }, common.platformTimeout(3000)); child.on('exit', common.mustCall(function(code) { assert.strictEqual(code, 0); clearTimeout(timer); })); } else { const domain = require('domain'); const d = domain.create(); process.maxTickDepth = 10; // in the error handler, we trigger several MakeCallback events d.on('error', function(e) { console.log('a'); console.log('b'); console.log('c'); console.log('d'); console.log('e'); f(); }); function f() { process.nextTick(function() { d.run(function() { throw new Error('x'); }); }); } f(); setImmediate(function() { console.error('broke in!'); process.exit(0); }); } node-v4.8.2/test/sequential/test-pipe.js000644 000766 000024 00000003473 13070706737 020372 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const http = require('http'); const net = require('net'); const webPort = common.PORT; const tcpPort = webPort + 1; const bufferSize = 5 * 1024 * 1024; let listenCount = 0; let gotThanks = false; let tcpLengthSeen = 0; /* * 5MB of random buffer. */ const buffer = Buffer.allocUnsafe(bufferSize); for (let i = 0; i < buffer.length; i++) { buffer[i] = parseInt(Math.random() * 10000) % 256; } const web = http.Server(common.mustCall((req, res) => { web.close(); const socket = net.Stream(); socket.connect(tcpPort); socket.on('connect', common.mustCall(() => {})); req.pipe(socket); req.on('end', common.mustCall(() => { res.writeHead(200); res.write('thanks'); res.end(); })); req.connection.on('error', (e) => { assert.ifError(e); }); })); web.listen(webPort, startClient); const tcp = net.Server(common.mustCall((s) => { tcp.close(); let i = 0; s.on('data', (d) => { tcpLengthSeen += d.length; for (let j = 0; j < d.length; j++) { assert.strictEqual(buffer[i], d[j]); i++; } }); s.on('end', common.mustCall(() => { s.end(); })); s.on('error', (e) => { assert.ifError(e); }); })); tcp.listen(tcpPort, startClient); function startClient() { listenCount++; if (listenCount < 2) return; const req = http.request({ port: common.PORT, method: 'GET', path: '/', headers: { 'content-length': buffer.length } }, common.mustCall((res) => { res.setEncoding('utf8'); res.on('data', common.mustCall((string) => { assert.strictEqual('thanks', string); gotThanks = true; })); })); req.write(buffer); req.end(); } process.on('exit', () => { assert.ok(gotThanks); assert.strictEqual(bufferSize, tcpLengthSeen); }); node-v4.8.2/test/sequential/test-pump-file2tcp-noexist.js000644 000766 000024 00000001726 13070706737 023612 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var net = require('net'); var fs = require('fs'); var util = require('util'); var path = require('path'); var fn = path.join(common.fixturesDir, 'does_not_exist.txt'); var got_error = false; var conn_closed = false; var server = net.createServer(function(stream) { util.pump(fs.createReadStream(fn), stream, function(err) { if (err) { got_error = true; } else { // util.pump's callback fired with no error // this shouldn't happen as the file doesn't exist... assert.equal(true, false); } server.close(); }); }); server.listen(common.PORT, function() { var conn = net.createConnection(common.PORT); conn.setEncoding('utf8'); conn.on('end', function() { conn.end(); }); conn.on('close', function() { conn_closed = true; }); }); process.on('exit', function() { assert.equal(true, got_error); assert.equal(true, conn_closed); }); node-v4.8.2/test/sequential/test-pump-file2tcp.js000644 000766 000024 00000001430 13070706737 022113 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var net = require('net'); var fs = require('fs'); var util = require('util'); var path = require('path'); var fn = path.join(common.fixturesDir, 'elipses.txt'); var expected = fs.readFileSync(fn, 'utf8'); var server = net.createServer(function(stream) { util.pump(fs.createReadStream(fn), stream, function() { server.close(); }); }); server.listen(common.PORT, function() { var conn = net.createConnection(common.PORT); conn.setEncoding('utf8'); conn.on('data', function(chunk) { buffer += chunk; }); conn.on('end', function() { conn.end(); }); }); var buffer = ''; server.on('listening', function() { }); process.on('exit', function() { assert.equal(expected, buffer); }); node-v4.8.2/test/sequential/test-regress-GH-1697.js000644 000766 000024 00000002263 13070706737 022003 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const net = require('net'); const cp = require('child_process'); if (process.argv[2] === 'server') { // Server var server = net.createServer(function(conn) { conn.on('data', function(data) { console.log('server received ' + data.length + ' bytes'); }); conn.on('close', function() { server.close(); }); }); server.listen(common.PORT, '127.0.0.1', function() { console.log('Server running.'); }); } else { // Client var serverProcess = cp.spawn(process.execPath, [process.argv[1], 'server']); serverProcess.stdout.pipe(process.stdout); serverProcess.stderr.pipe(process.stdout); serverProcess.stdout.once('data', function() { var client = net.createConnection(common.PORT, '127.0.0.1'); client.on('connect', function() { const alot = new Buffer(1024); const alittle = new Buffer(1); for (var i = 0; i < 100; i++) { client.write(alot); } // Block the event loop for 1 second var start = (new Date()).getTime(); while ((new Date()).getTime() < start + 1000) {} client.write(alittle); client.destroySoon(); }); }); } node-v4.8.2/test/sequential/test-regress-GH-1726.js000644 000766 000024 00000002024 13070706737 021767 0ustar00iojsstaff000000 000000 'use strict'; // Open a chain of five Node processes each a child of the next. The final // process exits immediately. Each process in the chain is instructed to // exit when its child exits. // https://github.com/joyent/node/issues/1726 require('../common'); var assert = require('assert'); var ch = require('child_process'); var gen = +(process.argv[2] || 0); var maxGen = 5; if (gen === maxGen) { console.error('hit maxGen, exiting', maxGen); return; } var child = ch.spawn(process.execPath, [__filename, gen + 1], { stdio: [ 'ignore', 'pipe', 'ignore' ] }); assert.ok(!child.stdin); assert.ok(child.stdout); assert.ok(!child.stderr); console.error('gen=%d, pid=%d', gen, process.pid); /* var timer = setTimeout(function() { throw new Error('timeout! gen='+gen); }, 1000); */ child.on('exit', function(code) { console.error('exit %d from gen %d', code, gen + 1); //clearTimeout(timer); }); child.stdout.pipe(process.stdout); child.stdout.on('close', function() { console.error('child.stdout close gen=%d', gen); }); node-v4.8.2/test/sequential/test-regress-GH-4015.js000644 000766 000024 00000000536 13070706737 021767 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var exec = require('child_process').exec; var cmd = '"' + process.execPath + '" ' + '"' + common.fixturesDir + '/test-regress-GH-4015.js"'; exec(cmd, function(err, stdout, stderr) { assert(/RangeError: Maximum call stack size exceeded/.test(stderr)); }); node-v4.8.2/test/sequential/test-regress-GH-4027.js000644 000766 000024 00000000752 13070706737 021772 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var path = require('path'); var fs = require('fs'); common.refreshTmpDir(); var filename = path.join(common.tmpDir, 'watched'); fs.writeFileSync(filename, 'quis custodiet ipsos custodes'); setTimeout(fs.unlinkSync, 100, filename); fs.watchFile(filename, { interval: 50 }, common.mustCall(function(curr, prev) { assert.equal(prev.nlink, 1); assert.equal(curr.nlink, 0); fs.unwatchFile(filename); })); node-v4.8.2/test/sequential/test-regress-GH-784.js000644 000766 000024 00000005277 13070706737 021727 0ustar00iojsstaff000000 000000 'use strict'; // Regression test for GH-784 // https://github.com/joyent/node/issues/784 // // The test works by making a total of 8 requests to the server. The first // two are made with the server off - they should come back as ECONNREFUSED. // The next two are made with server on - they should come back successful. // The next two are made with the server off - and so on. Without the fix // we were experiencing parse errors and instead of ECONNREFUSED. var common = require('../common'); var http = require('http'); var assert = require('assert'); var server = http.createServer(function(req, res) { var body = ''; req.setEncoding('utf8'); req.on('data', function(chunk) { body += chunk; }); req.on('end', function() { assert.equal('PING', body); res.writeHead(200); res.end('PONG'); }); }); server.on('listening', pingping); function serverOn() { console.error('Server ON'); server.listen(common.PORT); } function serverOff() { console.error('Server OFF'); server.close(); pingping(); } var responses = []; function afterPing(result) { responses.push(result); console.error('afterPing. responses.length = ' + responses.length); switch (responses.length) { case 2: assert.ok(/ECONNREFUSED/.test(responses[0])); assert.ok(/ECONNREFUSED/.test(responses[1])); serverOn(); break; case 4: assert.ok(/success/.test(responses[2])); assert.ok(/success/.test(responses[3])); serverOff(); break; case 6: assert.ok(/ECONNREFUSED/.test(responses[4])); assert.ok(/ECONNREFUSED/.test(responses[5])); serverOn(); break; case 8: assert.ok(/success/.test(responses[6])); assert.ok(/success/.test(responses[7])); server.close(); // we should go to process.on('exit') from here. break; } } function ping() { console.error('making req'); var opt = { port: common.PORT, path: '/ping', method: 'POST' }; var req = http.request(opt, function(res) { var body = ''; res.setEncoding('utf8'); res.on('data', function(chunk) { body += chunk; }); res.on('end', function() { assert.equal('PONG', body); assert.ok(!hadError); gotEnd = true; afterPing('success'); }); }); req.end('PING'); var gotEnd = false; var hadError = false; req.on('error', function(error) { console.log('Error making ping req: ' + error); hadError = true; assert.ok(!gotEnd); afterPing(error.message); }); } function pingping() { ping(); ping(); } pingping(); process.on('exit', function() { console.error("process.on('exit')"); console.error(responses); assert.equal(8, responses.length); }); node-v4.8.2/test/sequential/test-regress-GH-877.js000644 000766 000024 00000002317 13070706737 021722 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var http = require('http'); var assert = require('assert'); var N = 20; var responses = 0; var maxQueued = 0; var agent = http.globalAgent; agent.maxSockets = 10; var server = http.createServer(function(req, res) { res.writeHead(200); res.end('Hello World\n'); }); var addrString = agent.getName({ host: '127.0.0.1', port: common.PORT }); server.listen(common.PORT, '127.0.0.1', function() { for (var i = 0; i < N; i++) { var options = { host: '127.0.0.1', port: common.PORT }; var req = http.get(options, function(res) { if (++responses === N) { server.close(); } res.resume(); }); assert.equal(req.agent, agent); console.log('Socket: ' + agent.sockets[addrString].length + '/' + agent.maxSockets + ' queued: ' + (agent.requests[addrString] ? agent.requests[addrString].length : 0)); var agentRequests = agent.requests[addrString] ? agent.requests[addrString].length : 0; if (maxQueued < agentRequests) { maxQueued = agentRequests; } } }); process.on('exit', function() { assert.strictEqual(responses, N); assert.ok(maxQueued <= 10); }); node-v4.8.2/test/sequential/test-regress-GH-897.js000644 000766 000024 00000001046 13070706737 021722 0ustar00iojsstaff000000 000000 'use strict'; // Test for bug where a timer duration greater than 0 ms but less than 1 ms // resulted in the duration being set for 1000 ms. The expected behavior is // that the timeout would be set for 1 ms, and thus fire more-or-less // immediately. // // Ref: https://github.com/nodejs/node-v0.x-archive/pull/897 const common = require('../common'); const assert = require('assert'); const t = Date.now(); setTimeout(common.mustCall(function() { const diff = Date.now() - t; assert.ok(diff < 100, `timer fired after ${diff} ms`); }), 0.1); node-v4.8.2/test/sequential/test-repl-timeout-throw.js000644 000766 000024 00000003373 13070706737 023223 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const spawn = require('child_process').spawn; const child = spawn(process.execPath, [ '-i' ], { stdio: [null, null, 2] }); var stdout = ''; child.stdout.setEncoding('utf8'); child.stdout.on('data', function(c) { process.stdout.write(c); stdout += c; }); child.stdin.write = function(original) { return function(c) { process.stderr.write(c); return original.call(child.stdin, c); }; }(child.stdin.write); child.stdout.once('data', function() { child.stdin.write('var throws = 0;'); child.stdin.write('process.on("exit",function(){console.log(throws)});'); child.stdin.write('function thrower(){console.log("THROW",throws++);XXX};'); child.stdin.write('setTimeout(thrower);""\n'); setTimeout(fsTest, 50); function fsTest() { var f = JSON.stringify(__filename); child.stdin.write('fs.readFile(' + f + ', thrower);\n'); setTimeout(eeTest, 50); } function eeTest() { child.stdin.write('setTimeout(function() {\n' + ' var events = require("events");\n' + ' var e = new events.EventEmitter;\n' + ' process.nextTick(function() {\n' + ' e.on("x", thrower);\n' + ' setTimeout(function() {\n' + ' e.emit("x");\n' + ' });\n' + ' });\n' + '});"";\n'); setTimeout(child.stdin.end.bind(child.stdin), common.platformTimeout(200)); } }); child.on('close', function(c) { assert.strictEqual(c, 0); // make sure we got 3 throws, in the end. var lastLine = stdout.trim().split(/\r?\n/).pop(); assert.strictEqual(lastLine, '> 3'); }); node-v4.8.2/test/sequential/test-require-cache-without-stat.js000644 000766 000024 00000002446 13070706737 024623 0ustar00iojsstaff000000 000000 'use strict'; // We've experienced a regression where the module loader stats a bunch of // directories on require() even if it's been called before. The require() // should caching the request. var common = require('../common'); var fs = require('fs'); var assert = require('assert'); var counter = 0; // Switch out the two stat implementations so that they increase a counter // each time they are called. var _statSync = fs.statSync; var _stat = fs.stat; fs.statSync = function() { counter++; return _statSync.apply(this, arguments); }; fs.stat = function() { counter++; return _stat.apply(this, arguments); }; // Load the module 'a' and 'http' once. It should become cached. require(common.fixturesDir + '/a'); require('../fixtures/a.js'); require('./../fixtures/a.js'); require('http'); console.log('counterBefore = %d', counter); var counterBefore = counter; // Now load the module a bunch of times with equivalent paths. // stat should not be called. for (let i = 0; i < 100; i++) { require(common.fixturesDir + '/a'); require('../fixtures/a.js'); require('./../fixtures/a.js'); } // Do the same with a built-in module for (let i = 0; i < 100; i++) { require('http'); } console.log('counterAfter = %d', counter); var counterAfter = counter; assert.equal(counterBefore, counterAfter); node-v4.8.2/test/sequential/test-stream2-fs.js000644 000766 000024 00000001744 13070706737 021417 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var fs = require('fs'); var FSReadable = fs.ReadStream; var path = require('path'); var file = path.resolve(common.fixturesDir, 'x1024.txt'); var size = fs.statSync(file).size; var expectLengths = [1024]; var util = require('util'); var Stream = require('stream'); util.inherits(TestWriter, Stream); function TestWriter() { Stream.apply(this); this.buffer = []; this.length = 0; } TestWriter.prototype.write = function(c) { this.buffer.push(c.toString()); this.length += c.length; return true; }; TestWriter.prototype.end = function(c) { if (c) this.buffer.push(c.toString()); this.emit('results', this.buffer); }; var r = new FSReadable(file); var w = new TestWriter(); w.on('results', function(res) { console.error(res, w.length); assert.equal(w.length, size); assert.deepEqual(res.map(function(c) { return c.length; }), expectLengths); console.log('ok'); }); r.pipe(w); node-v4.8.2/test/sequential/test-stream2-stderr-sync.js000644 000766 000024 00000003047 13070706737 023262 0ustar00iojsstaff000000 000000 'use strict'; // Make sure that sync writes to stderr get processed before exiting. require('../common'); function parent() { var spawn = require('child_process').spawn; var assert = require('assert'); var i = 0; children.forEach(function(_, c) { var child = spawn(process.execPath, [__filename, '' + c]); var err = ''; child.stderr.on('data', function(c) { err += c; }); child.on('close', function() { assert.equal(err, 'child ' + c + '\nfoo\nbar\nbaz\n'); console.log('ok %d child #%d', ++i, c); if (i === children.length) console.log('1..' + i); }); }); } // using console.error function child0() { console.error('child 0'); console.error('foo'); console.error('bar'); console.error('baz'); } // using process.stderr function child1() { process.stderr.write('child 1\n'); process.stderr.write('foo\n'); process.stderr.write('bar\n'); process.stderr.write('baz\n'); } // using a net socket function child2() { var net = require('net'); var socket = new net.Socket({ fd: 2, readable: false, writable: true}); socket.write('child 2\n'); socket.write('foo\n'); socket.write('bar\n'); socket.write('baz\n'); } function child3() { console.error('child 3\nfoo\nbar\nbaz'); } function child4() { process.stderr.write('child 4\nfoo\nbar\nbaz\n'); } var children = [ child0, child1, child2, child3, child4 ]; if (!process.argv[2]) { parent(); } else { children[process.argv[2]](); // immediate process.exit to kill any waiting stuff. process.exit(); } node-v4.8.2/test/sequential/test-util-debug.js000644 000766 000024 00000002640 13070706737 021471 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); if (process.argv[2] === 'child') child(); else parent(); function parent() { test('foo,tud,bar', true); test('foo,tud', true); test('tud,bar', true); test('tud', true); test('foo,bar', false); test('', false); } function test(environ, shouldWrite) { var expectErr = ''; if (shouldWrite) { expectErr = 'TUD %PID%: this { is: \'a\' } /debugging/\n' + 'TUD %PID%: number=1234 string=asdf obj={"foo":"bar"}\n'; } var expectOut = 'ok\n'; var spawn = require('child_process').spawn; var child = spawn(process.execPath, [__filename, 'child'], { env: Object.assign(process.env, { NODE_DEBUG: environ }) }); expectErr = expectErr.split('%PID%').join(child.pid); var err = ''; child.stderr.setEncoding('utf8'); child.stderr.on('data', function(c) { err += c; }); var out = ''; child.stdout.setEncoding('utf8'); child.stdout.on('data', function(c) { out += c; }); child.on('close', common.mustCall(function(c) { assert(!c); assert.equal(err, expectErr); assert.equal(out, expectOut); console.log('ok %j %j', environ, shouldWrite); })); } function child() { var util = require('util'); var debug = util.debuglog('tud'); debug('this', { is: 'a' }, /debugging/); debug('number=%d string=%s obj=%j', 1234, 'asdf', { foo: 'bar' }); console.log('ok'); } node-v4.8.2/test/sequential/test-vm-timeout-rethrow.js000644 000766 000024 00000001046 13070706737 023225 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var vm = require('vm'); var spawn = require('child_process').spawn; if (process.argv[2] === 'child') { const code = 'while(true);'; const ctx = vm.createContext(); vm.runInContext(code, ctx, { timeout: 1 }); } else { var proc = spawn(process.execPath, process.argv.slice(1).concat('child')); var err = ''; proc.stderr.on('data', function(data) { err += data; }); process.on('exit', function() { assert.ok(/Script execution timed out/.test(err)); }); } node-v4.8.2/test/sequential/testcfg.py000644 000766 000024 00000000307 13070706737 020124 0ustar00iojsstaff000000 000000 import sys, os sys.path.append(os.path.join(os.path.dirname(__file__), '..')) import testpy def GetConfiguration(context, root): return testpy.SimpleTestConfiguration(context, root, 'sequential') node-v4.8.2/test/pummel/test-abort-fatal-error.js000644 000766 000024 00000001317 13070706737 022100 0ustar00iojsstaff000000 000000 'use strict'; var assert = require('assert'); var common = require('../common'); if (common.isWindows) { common.skip('no RLIMIT_NOFILE on Windows'); return; } var exec = require('child_process').exec; var cmdline = 'ulimit -c 0; ' + process.execPath; cmdline += ' --max-old-space-size=4 --max-semi-space-size=1'; cmdline += ' -e "a = []; for (i = 0; i < 1e9; i++) { a.push({}) }"'; exec(cmdline, function(err, stdout, stderr) { if (!err) { console.log(stdout); console.log(stderr); assert(false, 'this test should fail'); return; } if (err.code !== 134 && err.signal !== 'SIGABRT') { console.log(stdout); console.log(stderr); console.log(err); assert(false, err); } }); node-v4.8.2/test/pummel/test-child-process-spawn-loop.js000644 000766 000024 00000001424 13070706737 023410 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var spawn = require('child_process').spawn; const SIZE = 1000 * 1024; const N = 40; let finished = false; function doSpawn(i) { const child = spawn('python', ['-c', 'print ' + SIZE + ' * "C"']); let count = 0; child.stdout.setEncoding('ascii'); child.stdout.on('data', (chunk) => { count += chunk.length; }); child.stderr.on('data', (chunk) => { console.log('stderr: ' + chunk); }); child.on('close', () => { // + 1 for \n or + 2 for \r\n on Windows assert.strictEqual(SIZE + (common.isWindows ? 2 : 1), count); if (i < N) { doSpawn(i + 1); } else { finished = true; } }); } doSpawn(0); process.on('exit', () => { assert.ok(finished); }); node-v4.8.2/test/pummel/test-crypto-dh.js000644 000766 000024 00000004267 13070706737 020475 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); try { var crypto = require('crypto'); } catch (e) { common.skip('node compiled without OpenSSL.'); return; } assert.throws( function() { crypto.getDiffieHellman('unknown-group'); }, /^Error: Unknown group$/, 'crypto.getDiffieHellman(\'unknown-group\') ' + 'failed to throw the expected error.' ); assert.throws( function() { crypto.getDiffieHellman('modp1').setPrivateKey(''); }, new RegExp('^TypeError: crypto\\.getDiffieHellman\\(\\.\\.\\.\\)\\.' + 'setPrivateKey is not a function$'), 'crypto.getDiffieHellman(\'modp1\').setPrivateKey(\'\') ' + 'failed to throw the expected error.' ); assert.throws( function() { crypto.getDiffieHellman('modp1').setPublicKey(''); }, new RegExp('^TypeError: crypto\\.getDiffieHellman\\(\\.\\.\\.\\)\\.' + 'setPublicKey is not a function$'), 'crypto.getDiffieHellman(\'modp1\').setPublicKey(\'\') ' + 'failed to throw the expected error.' ); var hashes = { modp1: '630e9acd2cc63f7e80d8507624ba60ac0757201a', modp2: '18f7aa964484137f57bca64b21917a385b6a0b60', modp5: 'c0a8eec0c2c8a5ec2f9c26f9661eb339a010ec61', modp14: 'af5455606fe74cec49782bb374e4c63c9b1d132c', modp15: '7bdd39e5cdbb9748113933e5c2623b559c534e74', modp16: 'daea5277a7ad0116e734a8e0d2f297ef759d1161', modp17: '3b62aaf0142c2720f0bf26a9589b0432c00eadc1', modp18: 'a870b491bbbec9b131ae9878d07449d32e54f160' }; for (const name in hashes) { var group = crypto.getDiffieHellman(name); var private_key = group.getPrime('hex'); var hash1 = hashes[name]; var hash2 = crypto.createHash('sha1') .update(private_key.toUpperCase()).digest('hex'); assert.equal(hash1, hash2); assert.equal(group.getGenerator('hex'), '02'); } for (const name in hashes) { // modp1 is 768 bits, FIPS requires >= 1024 if (name === 'modp1' && common.hasFipsCrypto) continue; var group1 = crypto.getDiffieHellman(name); var group2 = crypto.getDiffieHellman(name); group1.generateKeys(); group2.generateKeys(); var key1 = group1.computeSecret(group2.getPublicKey()); var key2 = group2.computeSecret(group1.getPublicKey()); assert.deepEqual(key1, key2); } node-v4.8.2/test/pummel/test-dh-regr.js000644 000766 000024 00000001030 13070706737 020075 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var crypto = require('crypto'); var p = crypto.createDiffieHellman(1024).getPrime(); for (var i = 0; i < 2000; i++) { const a = crypto.createDiffieHellman(p); const b = crypto.createDiffieHellman(p); a.generateKeys(); b.generateKeys(); assert.deepEqual( a.computeSecret(b.getPublicKey()), b.computeSecret(a.getPublicKey()), 'secrets should be equal!' ); } node-v4.8.2/test/pummel/test-dtrace-jsstack.js000644 000766 000024 00000003525 13070706737 021462 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var os = require('os'); if (!common.isSunOS) { common.skip('no DTRACE support'); return; } /* * Some functions to create a recognizable stack. */ var frames = [ 'stalloogle', 'bagnoogle', 'doogle' ]; var stalloogle = function(str) { global.expected = str; os.loadavg(); }; var bagnoogle = function(arg0, arg1) { stalloogle(arg0 + ' is ' + arg1 + ' except that it is read-only'); }; var done = false; var doogle = function() { if (!done) setTimeout(doogle, 10); bagnoogle('The bfs command', '(almost) like ed(1)'); }; var spawn = require('child_process').spawn; /* * We're going to use DTrace to stop us, gcore us, and set us running again * when we call getloadavg() -- with the implicit assumption that our * deepest function is the only caller of os.loadavg(). */ var dtrace = spawn('dtrace', [ '-qwn', 'syscall::getloadavg:entry/pid == ' + process.pid + '/{ustack(100, 8192); exit(0); }' ]); var output = ''; dtrace.stderr.on('data', function(data) { console.log('dtrace: ' + data); }); dtrace.stdout.on('data', function(data) { output += data; }); dtrace.on('exit', function(code) { if (code !== 0) { console.error('dtrace exited with code ' + code); process.exit(code); } done = true; var sentinel = '(anon) as '; var lines = output.split('\n'); for (var i = 0; i < lines.length; i++) { var line = lines[i]; if (line.indexOf(sentinel) === -1 || frames.length === 0) continue; var frame = line.substr(line.indexOf(sentinel) + sentinel.length); var top = frames.shift(); assert.equal(frame.indexOf(top), 0, 'unexpected frame where ' + top + ' was expected'); } assert.equal(frames.length, 0, 'did not find expected frame ' + frames[0]); process.exit(0); }); setTimeout(doogle, 10); node-v4.8.2/test/pummel/test-exec.js000644 000766 000024 00000006217 13070706737 017505 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var exec = require('child_process').exec; var SLEEP3_COMMAND; if (!common.isWindows) { // Unix. SLEEP3_COMMAND = 'sleep 3'; } else { // Windows: `choice` is a command built into cmd.exe. Use another cmd process // to create a process tree, so we can catch bugs related to it. SLEEP3_COMMAND = 'cmd /c choice /t 3 /c X /d X'; } var success_count = 0; var error_count = 0; exec( '"' + process.execPath + '" -p -e process.versions', function(err, stdout, stderr) { if (err) { error_count++; console.log('error!: ' + err.code); console.log('stdout: ' + JSON.stringify(stdout)); console.log('stderr: ' + JSON.stringify(stderr)); assert.strictEqual(false, err.killed); } else { success_count++; console.dir(stdout); } } ); exec('thisisnotavalidcommand', function(err, stdout, stderr) { if (err) { error_count++; assert.strictEqual('', stdout); assert.strictEqual(typeof err.code, 'number'); assert.notStrictEqual(err.code, 0); assert.strictEqual(false, err.killed); assert.strictEqual(null, err.signal); console.log('error code: ' + err.code); console.log('stdout: ' + JSON.stringify(stdout)); console.log('stderr: ' + JSON.stringify(stderr)); } else { success_count++; console.dir(stdout); assert.strictEqual(typeof stdout, 'string'); assert.notStrictEqual(stdout, ''); } }); var sleeperStart = new Date(); exec(SLEEP3_COMMAND, { timeout: 50 }, function(err, stdout, stderr) { var diff = (new Date()) - sleeperStart; console.log('\'sleep 3\' with timeout 50 took %d ms', diff); assert.ok(diff < 500); assert.ok(err); assert.ok(err.killed); assert.strictEqual(err.signal, 'SIGTERM'); assert.strictEqual(stdout, ''); assert.strictEqual(stderr, ''); }); var startSleep3 = new Date(); var killMeTwice = exec(SLEEP3_COMMAND, {timeout: 1000}, killMeTwiceCallback); process.nextTick(function() { console.log('kill pid %d', killMeTwice.pid); // make sure there is no race condition in starting the process // the PID SHOULD exist directly following the exec() call. assert.strictEqual('number', typeof killMeTwice._handle.pid); // Kill the process killMeTwice.kill(); }); function killMeTwiceCallback(err, stdout, stderr) { var diff = (new Date()) - startSleep3; // We should have already killed this process. Assert that the timeout still // works and that we are getting the proper callback parameters. assert.ok(err); assert.ok(err.killed); assert.strictEqual(err.signal, 'SIGTERM'); assert.strictEqual(stdout, ''); assert.strictEqual(stderr, ''); // the timeout should still be in effect console.log('\'sleep 3\' was already killed. Took %d ms', diff); assert.ok(diff < 1500); } exec('python -c "print 200000*\'C\'"', {maxBuffer: 1000}, function(err, stdout, stderr) { assert.ok(err); assert.ok(/maxBuffer/.test(err.message)); assert.strictEqual(stdout, ''); assert.strictEqual(stderr, ''); }); process.on('exit', function() { assert.strictEqual(1, success_count); assert.strictEqual(1, error_count); }); node-v4.8.2/test/pummel/test-fs-watch-file-slow.js000644 000766 000024 00000002234 13070706737 022167 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var path = require('path'); var fs = require('fs'); var FILENAME = path.join(common.tmpDir, 'watch-me'); var TIMEOUT = 1300; var nevents = 0; try { fs.unlinkSync(FILENAME); } catch (e) { // swallow } fs.watchFile(FILENAME, {interval: TIMEOUT - 250}, function(curr, prev) { console.log([curr, prev]); switch (++nevents) { case 1: assert.equal(common.fileExists(FILENAME), false); break; case 2: case 3: assert.equal(common.fileExists(FILENAME), true); break; case 4: assert.equal(common.fileExists(FILENAME), false); fs.unwatchFile(FILENAME); break; default: assert(0); } }); process.on('exit', function() { assert.equal(nevents, 4); }); setTimeout(createFile, TIMEOUT); function createFile() { console.log('creating file'); fs.writeFileSync(FILENAME, 'test'); setTimeout(touchFile, TIMEOUT); } function touchFile() { console.log('touch file'); fs.writeFileSync(FILENAME, 'test'); setTimeout(removeFile, TIMEOUT); } function removeFile() { console.log('remove file'); fs.unlinkSync(FILENAME); } node-v4.8.2/test/pummel/test-fs-watch-file.js000644 000766 000024 00000005335 13070706737 021212 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var path = require('path'); var fs = require('fs'); var watchSeenOne = 0; var watchSeenTwo = 0; var watchSeenThree = 0; var watchSeenFour = 0; var testDir = common.tmpDir; var filenameOne = 'watch.txt'; var filepathOne = path.join(testDir, filenameOne); var filenameTwo = 'hasOwnProperty'; var filepathTwo = filenameTwo; var filepathTwoAbs = path.join(testDir, filenameTwo); var filenameThree = 'charm'; // because the third time is var filenameFour = 'get'; process.on('exit', function() { fs.unlinkSync(filepathOne); fs.unlinkSync(filepathTwoAbs); fs.unlinkSync(filenameThree); fs.unlinkSync(filenameFour); assert.equal(1, watchSeenOne); assert.equal(2, watchSeenTwo); assert.equal(1, watchSeenThree); assert.equal(1, watchSeenFour); }); fs.writeFileSync(filepathOne, 'hello'); assert.throws( function() { fs.watchFile(filepathOne); }, function(e) { return e.message === 'watchFile requires a listener function'; } ); assert.doesNotThrow( function() { fs.watchFile(filepathOne, function(curr, prev) { fs.unwatchFile(filepathOne); ++watchSeenOne; }); } ); setTimeout(function() { fs.writeFileSync(filepathOne, 'world'); }, 1000); process.chdir(testDir); fs.writeFileSync(filepathTwoAbs, 'howdy'); assert.throws( function() { fs.watchFile(filepathTwo); }, function(e) { return e.message === 'watchFile requires a listener function'; } ); assert.doesNotThrow( function() { function a(curr, prev) { fs.unwatchFile(filepathTwo, a); ++watchSeenTwo; } function b(curr, prev) { fs.unwatchFile(filepathTwo, b); ++watchSeenTwo; } fs.watchFile(filepathTwo, a); fs.watchFile(filepathTwo, b); } ); setTimeout(function() { fs.writeFileSync(filepathTwoAbs, 'pardner'); }, 1000); assert.doesNotThrow( function() { function a(curr, prev) { assert.ok(0); // should not run } function b(curr, prev) { fs.unwatchFile(filenameThree, b); ++watchSeenThree; } fs.watchFile(filenameThree, a); fs.watchFile(filenameThree, b); fs.unwatchFile(filenameThree, a); } ); setTimeout(function() { fs.writeFileSync(filenameThree, 'pardner'); }, 1000); setTimeout(function() { fs.writeFileSync(filenameFour, 'hey'); }, 200); setTimeout(function() { fs.writeFileSync(filenameFour, 'hey'); }, 500); assert.doesNotThrow( function() { function a(curr, prev) { ++watchSeenFour; assert.equal(1, watchSeenFour); fs.unwatchFile('.' + path.sep + filenameFour, a); } fs.watchFile(filenameFour, a); } ); node-v4.8.2/test/pummel/test-fs-watch-non-recursive.js000644 000766 000024 00000001370 13070706737 023065 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var path = require('path'); var fs = require('fs'); var testDir = common.tmpDir; var testsubdir = path.join(testDir, 'testsubdir'); var filepath = path.join(testsubdir, 'watch.txt'); function cleanup() { try { fs.unlinkSync(filepath); } catch (e) { } try { fs.rmdirSync(testsubdir); } catch (e) { } } process.on('exit', cleanup); cleanup(); try { fs.mkdirSync(testsubdir, 0o700); } catch (e) {} // Need a grace period, else the mkdirSync() above fires off an event. setTimeout(function() { var watcher = fs.watch(testDir, { persistent: true }, common.fail); setTimeout(function() { fs.writeFileSync(filepath, 'test'); }, 100); setTimeout(function() { watcher.close(); }, 500); }, 50); node-v4.8.2/test/pummel/test-http-client-reconnect-bug.js000644 000766 000024 00000001227 13070706737 023541 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const net = require('net'); const http = require('http'); var server = net.createServer(function(socket) { socket.end(); }); server.on('listening', common.mustCall(function() { var client = http.createClient(common.PORT); client.on('error', common.mustCall(function(err) {})); client.on('end', common.mustCall(function() {})); var request = client.request('GET', '/', {'host': 'localhost'}); request.end(); request.on('response', function(response) { console.log('STATUS: ' + response.statusCode); }); })); server.listen(common.PORT); setTimeout(function() { server.close(); }, 500); node-v4.8.2/test/pummel/test-http-many-keep-alive-connections.js000644 000766 000024 00000001733 13070706737 025040 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var http = require('http'); var expected = 10000; var responses = 0; var requests = 0; var connection; var server = http.Server(function(req, res) { requests++; assert.equal(req.connection, connection); res.writeHead(200); res.end('hello world\n'); }); server.once('connection', function(c) { connection = c; }); server.listen(common.PORT, function connect() { var request = http.get({ port: common.PORT, path: '/', headers: { 'Connection': 'Keep-alive' } }, function(res) { res.on('end', function() { if (++responses < expected) { connect(); } else { server.close(); } }); res.resume(); }).on('error', function(e) { console.log(e.message); process.exit(1); }); request.agent.maxSockets = 1; }); process.on('exit', function() { assert.equal(expected, responses); assert.equal(expected, requests); }); node-v4.8.2/test/pummel/test-http-upload-timeout.js000644 000766 000024 00000002332 13070706737 022500 0ustar00iojsstaff000000 000000 'use strict'; // This tests setTimeout() by having multiple clients connecting and sending // data in random intervals. Clients are also randomly disconnecting until there // are no more clients left. If no false timeout occurs, this test has passed. const common = require('../common'); const http = require('http'); const server = http.createServer(); let connections = 0; server.on('request', function(req, res) { req.socket.setTimeout(1000); req.socket.on('timeout', function() { throw new Error('Unexpected timeout'); }); req.on('end', function() { connections--; res.writeHead(200); res.end('done\n'); if (connections === 0) { server.close(); } }); req.resume(); }); server.listen(common.PORT, '127.0.0.1', function() { for (var i = 0; i < 10; i++) { connections++; setTimeout(function() { var request = http.request({ port: common.PORT, method: 'POST', path: '/' }); function ping() { var nextPing = (Math.random() * 900).toFixed(); if (nextPing > 600) { request.end(); return; } request.write('ping'); setTimeout(ping, nextPing); } ping(); }, i * 50); } }); node-v4.8.2/test/pummel/test-https-ci-reneg-attack.js000644 000766 000024 00000004650 13070706737 022656 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var spawn = require('child_process').spawn; if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var https = require('https'); var fs = require('fs'); if (!common.opensslCli) { common.skip('node compiled without OpenSSL CLI.'); return; } // renegotiation limits to test var LIMITS = [0, 1, 2, 3, 5, 10, 16]; (function() { var n = 0; function next() { if (n >= LIMITS.length) return; tls.CLIENT_RENEG_LIMIT = LIMITS[n++]; test(next); } next(); })(); function test(next) { var options = { cert: fs.readFileSync(common.fixturesDir + '/test_cert.pem'), key: fs.readFileSync(common.fixturesDir + '/test_key.pem') }; var seenError = false; var server = https.createServer(options, function(req, res) { var conn = req.connection; conn.on('error', function(err) { console.error('Caught exception: ' + err); assert(/TLS session renegotiation attack/.test(err)); conn.destroy(); seenError = true; }); res.end('ok'); }); server.listen(common.PORT, function() { var args = ('s_client -connect 127.0.0.1:' + common.PORT).split(' '); var child = spawn(common.opensslCli, args); //child.stdout.pipe(process.stdout); //child.stderr.pipe(process.stderr); child.stdout.resume(); child.stderr.resume(); // count handshakes, start the attack after the initial handshake is done var handshakes = 0; var renegs = 0; child.stderr.on('data', function(data) { if (seenError) return; handshakes += (('' + data).match(/verify return:1/g) || []).length; if (handshakes === 2) spam(); renegs += (('' + data).match(/RENEGOTIATING/g) || []).length; }); child.on('exit', function() { assert.equal(renegs, tls.CLIENT_RENEG_LIMIT + 1); server.close(); process.nextTick(next); }); var closed = false; child.stdin.on('error', function(err) { switch (err.code) { case 'ECONNRESET': case 'EPIPE': break; default: assert.equal(err.code, 'ECONNRESET'); break; } closed = true; }); child.stdin.on('close', function() { closed = true; }); // simulate renegotiation attack function spam() { if (closed) return; child.stdin.write('R\n'); setTimeout(spam, 50); } }); } node-v4.8.2/test/pummel/test-https-large-response.js000644 000766 000024 00000002461 13070706737 022644 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var fs = require('fs'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var https = require('https'); var options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }; process.stdout.write('build body...'); var body = 'hello world\n'.repeat(1024 * 1024); process.stdout.write('done\n'); var server = https.createServer(options, common.mustCall(function(req, res) { console.log('got request'); res.writeHead(200, { 'content-type': 'text/plain' }); res.end(body); })); server.listen(common.PORT, common.mustCall(function() { https.get({ port: common.PORT, rejectUnauthorized: false }, common.mustCall(function(res) { console.log('response!'); var count = 0; res.on('data', function(d) { process.stdout.write('.'); count += d.length; res.pause(); process.nextTick(function() { res.resume(); }); }); res.on('end', common.mustCall(function(d) { process.stdout.write('\n'); console.log('expected: ', body.length); console.log(' got: ', count); server.close(); assert.strictEqual(count, body.length); })); })); })); node-v4.8.2/test/pummel/test-https-no-reader.js000644 000766 000024 00000002030 13070706737 021562 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var https = require('https'); var Buffer = require('buffer').Buffer; var fs = require('fs'); var path = require('path'); var options = { key: fs.readFileSync(path.join(common.fixturesDir, 'test_key.pem')), cert: fs.readFileSync(path.join(common.fixturesDir, 'test_cert.pem')) }; var buf = new Buffer(1024 * 1024); var server = https.createServer(options, function(req, res) { res.writeHead(200); for (var i = 0; i < 50; i++) { res.write(buf); } res.end(); }); server.listen(common.PORT, function() { var req = https.request({ method: 'POST', port: common.PORT, rejectUnauthorized: false }, function(res) { res.read(0); setTimeout(function() { // Read buffer should be somewhere near high watermark // (i.e. should not leak) assert(res._readableState.length < 100 * 1024); process.exit(0); }, 2000); }); req.end(); }); node-v4.8.2/test/pummel/test-keep-alive.js000644 000766 000024 00000003763 13070706737 020606 0ustar00iojsstaff000000 000000 'use strict'; // This test requires the program 'wrk' var common = require('../common'); var assert = require('assert'); var spawn = require('child_process').spawn; var http = require('http'); var url = require('url'); if (common.isWindows) { common.skip('no `wrk` on windows'); return; } const body = 'hello world\n'; const server = http.createServer(function(req, res) { res.writeHead(200, { 'Content-Length': body.length, 'Content-Type': 'text/plain' }); res.write(body); res.end(); }); let keepAliveReqSec = 0; let normalReqSec = 0; function runAb(opts, callback) { const args = [ '-c', opts.concurrent || 100, '-t', opts.threads || 2, '-d', opts.duration || '10s', ]; if (!opts.keepalive) { args.push('-H'); args.push('Connection: close'); } args.push(url.format({ hostname: '127.0.0.1', port: common.PORT, protocol: 'http'})); const child = spawn('wrk', args); child.stderr.pipe(process.stderr); child.stdout.setEncoding('utf8'); let stdout; child.stdout.on('data', function(data) { stdout += data; }); child.on('close', function(code, signal) { if (code) { console.error(code, signal); process.exit(code); return; } let matches = /Requests\/sec:\s*(\d+)\./mi.exec(stdout); const reqSec = parseInt(matches[1]); matches = /Keep-Alive requests:\s*(\d+)/mi.exec(stdout); let keepAliveRequests; if (matches) { keepAliveRequests = parseInt(matches[1]); } else { keepAliveRequests = 0; } callback(reqSec, keepAliveRequests); }); } server.listen(common.PORT, () => { runAb({ keepalive: true }, (reqSec) => { keepAliveReqSec = reqSec; runAb({ keepalive: false }, function(reqSec) { normalReqSec = reqSec; server.close(); }); }); }); process.on('exit', function() { assert.strictEqual(true, normalReqSec > 50); assert.strictEqual(true, keepAliveReqSec > 50); assert.strictEqual(true, normalReqSec < keepAliveReqSec); }); node-v4.8.2/test/pummel/test-net-connect-econnrefused.js000644 000766 000024 00000001763 13070706737 023455 0ustar00iojsstaff000000 000000 'use strict'; // verify that connect reqs are properly cleaned up var common = require('../common'); var assert = require('assert'); var net = require('net'); var ROUNDS = 10; var ATTEMPTS_PER_ROUND = 100; var rounds = 1; var reqs = 0; pummel(); function pummel() { console.log('Round', rounds, '/', ROUNDS); for (var pending = 0; pending < ATTEMPTS_PER_ROUND; pending++) { net.createConnection(common.PORT).on('error', function(err) { assert.equal(err.code, 'ECONNREFUSED'); if (--pending > 0) return; if (rounds === ROUNDS) return check(); rounds++; pummel(); }); reqs++; } } function check() { setTimeout(function() { assert.equal(process._getActiveRequests().length, 0); assert.equal(process._getActiveHandles().length, 1); // the timer check_called = true; }, 0); } var check_called = false; process.on('exit', function() { assert.equal(rounds, ROUNDS); assert.equal(reqs, ROUNDS * ATTEMPTS_PER_ROUND); assert(check_called); }); node-v4.8.2/test/pummel/test-net-connect-memleak.js000644 000766 000024 00000001514 13070706737 022402 0ustar00iojsstaff000000 000000 'use strict'; // Flags: --expose-gc var common = require('../common'); var assert = require('assert'); var net = require('net'); assert(typeof gc === 'function', 'Run this test with --expose-gc'); net.createServer(function() {}).listen(common.PORT); var before = 0; (function() { // 2**26 == 64M entries gc(); for (var i = 0, junk = [0]; i < 26; ++i) junk = junk.concat(junk); before = process.memoryUsage().rss; net.createConnection(common.PORT, '127.0.0.1', function() { assert.notStrictEqual(junk.length, 0); // keep reference alive setTimeout(done, 10); gc(); }); })(); function done() { gc(); var after = process.memoryUsage().rss; var reclaimed = (before - after) / 1024; console.log('%d kB reclaimed', reclaimed); assert(reclaimed > 128 * 1024); // It's around 256 MB on x64. process.exit(); } node-v4.8.2/test/pummel/test-net-many-clients.js000644 000766 000024 00000003112 13070706737 021737 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var net = require('net'); // settings var bytes = 1024 * 40; var concurrency = 100; var connections_per_client = 5; // measured var total_connections = 0; var body = 'C'.repeat(bytes); var server = net.createServer(function(c) { console.log('connected'); total_connections++; console.log('#'); c.write(body); c.end(); }); function runClient(callback) { var client = net.createConnection(common.PORT); client.connections = 0; client.setEncoding('utf8'); client.on('connect', function() { console.log('c'); client.recved = ''; client.connections += 1; }); client.on('data', function(chunk) { this.recved += chunk; }); client.on('end', function() { client.end(); }); client.on('error', function(e) { console.log('\n\nERROOOOOr'); throw e; }); client.on('close', function(had_error) { console.log('.'); assert.equal(false, had_error); assert.equal(bytes, client.recved.length); if (client.fd) { console.log(client.fd); } assert.ok(!client.fd); if (this.connections < connections_per_client) { this.connect(common.PORT); } else { callback(); } }); } server.listen(common.PORT, function() { var finished_clients = 0; for (var i = 0; i < concurrency; i++) { runClient(function() { if (++finished_clients === concurrency) server.close(); }); } }); process.on('exit', function() { assert.equal(connections_per_client * concurrency, total_connections); console.log('\nokay!'); }); node-v4.8.2/test/pummel/test-net-pause.js000644 000766 000024 00000002704 13070706737 020457 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var net = require('net'); var N = 200; var recv = '', chars_recved = 0; var server = net.createServer(function(connection) { function write(j) { if (j >= N) { connection.end(); return; } setTimeout(function() { connection.write('C'); write(j + 1); }, 10); } write(0); }); server.on('listening', function() { var client = net.createConnection(common.PORT); client.setEncoding('ascii'); client.on('data', function(d) { console.log(d); recv += d; }); setTimeout(function() { chars_recved = recv.length; console.log('pause at: ' + chars_recved); assert.equal(true, chars_recved > 1); client.pause(); setTimeout(function() { console.log('resume at: ' + chars_recved); assert.equal(chars_recved, recv.length); client.resume(); setTimeout(function() { chars_recved = recv.length; console.log('pause at: ' + chars_recved); client.pause(); setTimeout(function() { console.log('resume at: ' + chars_recved); assert.equal(chars_recved, recv.length); client.resume(); }, 500); }, 500); }, 500); }, 500); client.on('end', function() { server.close(); client.end(); }); }); server.listen(common.PORT); process.on('exit', function() { assert.equal(N, recv.length); console.error('Exit'); }); node-v4.8.2/test/pummel/test-net-pingpong-delay.js000644 000766 000024 00000004262 13070706737 022260 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var net = require('net'); function pingPongTest(port, host, on_complete) { var N = 100; var DELAY = 1; var count = 0; var client_ended = false; var server = net.createServer({ allowHalfOpen: true }, function(socket) { socket.setEncoding('utf8'); socket.on('data', function(data) { console.log(data); assert.equal('PING', data); assert.equal('open', socket.readyState); assert.equal(true, count <= N); setTimeout(function() { assert.equal('open', socket.readyState); socket.write('PONG'); }, DELAY); }); socket.on('timeout', function() { console.error('server-side timeout!!'); assert.equal(false, true); }); socket.on('end', function() { console.log('server-side socket EOF'); assert.equal('writeOnly', socket.readyState); socket.end(); }); socket.on('close', function(had_error) { console.log('server-side socket.end'); assert.equal(false, had_error); assert.equal('closed', socket.readyState); socket.server.close(); }); }); server.listen(port, host, common.mustCall(function() { var client = net.createConnection(port, host); client.setEncoding('utf8'); client.on('connect', function() { assert.equal('open', client.readyState); client.write('PING'); }); client.on('data', function(data) { console.log(data); assert.equal('PONG', data); assert.equal('open', client.readyState); setTimeout(function() { assert.equal('open', client.readyState); if (count++ < N) { client.write('PING'); } else { console.log('closing client'); client.end(); client_ended = true; } }, DELAY); }); client.on('timeout', function() { console.error('client-side timeout!!'); assert.equal(false, true); }); client.on('close', common.mustCall(function() { console.log('client.end'); assert.equal(N + 1, count); assert.ok(client_ended); if (on_complete) on_complete(); })); })); } pingPongTest(common.PORT); node-v4.8.2/test/pummel/test-net-pingpong.js000644 000766 000024 00000005210 13070706737 021156 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var net = require('net'); var tests_run = 0; function pingPongTest(port, host, on_complete) { var N = 1000; var count = 0; var sent_final_ping = false; var server = net.createServer({ allowHalfOpen: true }, function(socket) { assert.equal(true, socket.remoteAddress !== null); assert.equal(true, socket.remoteAddress !== undefined); var address = socket.remoteAddress; if (host === '127.0.0.1') { assert.equal(address, '127.0.0.1'); } else if (host == null || host === 'localhost') { assert(address === '127.0.0.1' || address === '::ffff:127.0.0.1'); } else { console.log('host = ' + host + ', remoteAddress = ' + address); assert.equal(address, '::1'); } socket.setEncoding('utf8'); socket.setNoDelay(); socket.timeout = 0; socket.on('data', function(data) { console.log('server got: ' + JSON.stringify(data)); assert.equal('open', socket.readyState); assert.equal(true, count <= N); if (/PING/.exec(data)) { socket.write('PONG'); } }); socket.on('end', function() { assert.equal('writeOnly', socket.readyState); socket.end(); }); socket.on('close', function(had_error) { assert.equal(false, had_error); assert.equal('closed', socket.readyState); socket.server.close(); }); }); server.listen(port, host, function() { var client = net.createConnection(port, host); client.setEncoding('utf8'); client.on('connect', function() { assert.equal('open', client.readyState); client.write('PING'); }); client.on('data', function(data) { console.log('client got: ' + data); assert.equal('PONG', data); count += 1; if (sent_final_ping) { assert.equal('readOnly', client.readyState); return; } else { assert.equal('open', client.readyState); } if (count < N) { client.write('PING'); } else { sent_final_ping = true; client.write('PING'); client.end(); } }); client.on('close', function() { assert.equal(N + 1, count); assert.equal(true, sent_final_ping); if (on_complete) on_complete(); tests_run += 1; }); }); } /* All are run at once, so run on different ports */ pingPongTest(common.PORT, 'localhost'); pingPongTest(common.PORT + 1, null); // This IPv6 isn't working on Solaris var solaris = /sunos/i.test(process.platform); if (!solaris) pingPongTest(common.PORT + 2, '::1'); process.on('exit', function() { assert.equal(solaris ? 2 : 3, tests_run); }); node-v4.8.2/test/pummel/test-net-throttle.js000644 000766 000024 00000002674 13070706737 021215 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const net = require('net'); const N = 1024 * 1024; const part_N = N / 3; var chars_recved = 0; var npauses = 0; console.log('build big string'); const body = 'C'.repeat(N); console.log('start server on port ' + common.PORT); var server = net.createServer(function(connection) { connection.write(body.slice(0, part_N)); connection.write(body.slice(part_N, 2 * part_N)); assert.equal(false, connection.write(body.slice(2 * part_N, N))); console.log('bufferSize: ' + connection.bufferSize, 'expecting', N); assert.ok(0 <= connection.bufferSize && connection._writableState.length <= N); connection.end(); }); server.listen(common.PORT, function() { var paused = false; var client = net.createConnection(common.PORT); client.setEncoding('ascii'); client.on('data', function(d) { chars_recved += d.length; console.log('got ' + chars_recved); if (!paused) { client.pause(); npauses += 1; paused = true; console.log('pause'); var x = chars_recved; setTimeout(function() { assert.equal(chars_recved, x); client.resume(); console.log('resume'); paused = false; }, 100); } }); client.on('end', function() { server.close(); client.end(); }); }); process.on('exit', function() { assert.equal(N, chars_recved); assert.equal(true, npauses > 2); }); node-v4.8.2/test/pummel/test-net-timeout.js000644 000766 000024 00000004051 13070706737 021025 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var net = require('net'); var exchanges = 0; var starttime = null; var timeouttime = null; var timeout = 1000; var echo_server = net.createServer(function(socket) { socket.setTimeout(timeout); socket.on('timeout', function() { console.log('server timeout'); timeouttime = new Date(); console.dir(timeouttime); socket.destroy(); }); socket.on('error', function(e) { throw new Error('Server side socket should not get error. ' + 'We disconnect willingly.'); }); socket.on('data', function(d) { console.log(d); socket.write(d); }); socket.on('end', function() { socket.end(); }); }); echo_server.listen(common.PORT, function() { console.log('server listening at ' + common.PORT); var client = net.createConnection(common.PORT); client.setEncoding('UTF8'); client.setTimeout(0); // disable the timeout for client client.on('connect', function() { console.log('client connected.'); client.write('hello\r\n'); }); client.on('data', function(chunk) { assert.equal('hello\r\n', chunk); if (exchanges++ < 5) { setTimeout(function() { console.log('client write "hello"'); client.write('hello\r\n'); }, 500); if (exchanges === 5) { console.log('wait for timeout - should come in ' + timeout + ' ms'); starttime = new Date(); console.dir(starttime); } } }); client.on('timeout', function() { throw new Error("client timeout - this shouldn't happen"); }); client.on('end', function() { console.log('client end'); client.end(); }); client.on('close', function() { console.log('client disconnect'); echo_server.close(); }); }); process.on('exit', function() { assert.ok(starttime != null); assert.ok(timeouttime != null); var diff = timeouttime - starttime; console.log('diff = ' + diff); assert.ok(timeout < diff); // Allow for 800 milliseconds more assert.ok(diff < timeout + 800); }); node-v4.8.2/test/pummel/test-net-timeout2.js000644 000766 000024 00000001262 13070706737 021110 0ustar00iojsstaff000000 000000 'use strict'; // socket.write was not resetting the timeout timer. See // https://github.com/joyent/node/issues/2002 var common = require('../common'); var net = require('net'); var seconds = 5; var counter = 0; var server = net.createServer(function(socket) { socket.setTimeout((seconds / 2) * 1000, common.fail); var interval = setInterval(function() { counter++; if (counter === seconds) { clearInterval(interval); server.close(); socket.destroy(); } if (socket.writable) { socket.write(Date.now() + '\n'); } }, 1000); }); server.listen(common.PORT, function() { var s = net.connect(common.PORT); s.pipe(process.stdout); }); node-v4.8.2/test/pummel/test-net-write-callbacks.js000644 000766 000024 00000002051 13070706737 022404 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var net = require('net'); var assert = require('assert'); var cbcount = 0; var N = 500000; var server = net.Server(function(socket) { socket.on('data', function(d) { console.error('got %d bytes', d.length); }); socket.on('end', function() { console.error('end'); socket.destroy(); server.close(); }); }); var lastCalled = -1; function makeCallback(c) { var called = false; return function() { if (called) throw new Error('called callback #' + c + ' more than once'); called = true; if (c < lastCalled) throw new Error('callbacks out of order. last=' + lastCalled + ' current=' + c); lastCalled = c; cbcount++; }; } server.listen(common.PORT, function() { var client = net.createConnection(common.PORT); client.on('connect', function() { for (var i = 0; i < N; i++) { client.write('hello world', makeCallback(i)); } client.end(); }); }); process.on('exit', function() { assert.equal(N, cbcount); }); node-v4.8.2/test/pummel/test-next-tick-infinite-calls.js000644 000766 000024 00000000525 13070706737 023362 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var complete = 0; // This will fail with: // FATAL ERROR: JS Allocation failed - process out of memory // if the depth counter doesn't clear the nextTickQueue properly. (function runner() { if (1e8 > ++complete) process.nextTick(runner); }()); setImmediate(function() { console.log('ok'); }); node-v4.8.2/test/pummel/test-process-cpuUsage.js000644 000766 000024 00000001701 13070706737 022002 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const start = process.cpuUsage(); // Run a busy-loop for specified # of milliseconds. const RUN_FOR_MS = 500; // Define slop factor for checking maximum expected diff values. const SLOP_FACTOR = 2; // Run a busy loop. const now = Date.now(); while (Date.now() - now < RUN_FOR_MS); // Get a diff reading from when we started. const diff = process.cpuUsage(start); const MICROSECONDS_PER_SECOND = 1000 * 1000; // Diff usages should be >= 0, <= ~RUN_FOR_MS millis. // Let's be generous with the slop factor, defined above, in case other things // are happening on this CPU. The <= check may be invalid if the node process // is making use of multiple CPUs, in which case, just remove it. assert(diff.user >= 0); assert(diff.user <= SLOP_FACTOR * RUN_FOR_MS * MICROSECONDS_PER_SECOND); assert(diff.system >= 0); assert(diff.system <= SLOP_FACTOR * RUN_FOR_MS * MICROSECONDS_PER_SECOND); node-v4.8.2/test/pummel/test-process-hrtime.js000644 000766 000024 00000000737 13070706737 021526 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var start = process.hrtime(); // process.hrtime() should return an Array assert(Array.isArray(start)); // busy-loop for 2 seconds var now = Date.now(); while (Date.now() - now < 2000); // get a diff reading var diff = process.hrtime(start); // should be at least 1 second, at most 2 seconds later // (the while loop will usually exit a few nanoseconds before 2) assert(diff[0] >= 1); assert(diff[0] <= 2); node-v4.8.2/test/pummel/test-process-uptime.js000644 000766 000024 00000000625 13070706737 021535 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); console.error(process.uptime()); assert.ok(process.uptime() <= 2); var original = process.uptime(); setTimeout(function() { var uptime = process.uptime(); // some wiggle room to account for timer // granularity, processor speed, and scheduling assert.ok(uptime >= original + 2); assert.ok(uptime <= original + 3); }, 2000); node-v4.8.2/test/pummel/test-regress-GH-814.js000644 000766 000024 00000002553 13070706737 021040 0ustar00iojsstaff000000 000000 'use strict'; // Flags: --expose_gc function newBuffer(size, value) { var buffer = new Buffer(size); while (size--) { buffer[size] = value; } //buffer[buffer.length-2]= 0x0d; buffer[buffer.length - 1] = 0x0a; return buffer; } var common = require('../common'); var fs = require('fs'); var testFileName = require('path').join(common.tmpDir, 'GH-814_testFile.txt'); var testFileFD = fs.openSync(testFileName, 'w'); console.log(testFileName); var kBufSize = 128 * 1024; var PASS = true; var neverWrittenBuffer = newBuffer(kBufSize, 0x2e); //0x2e === '.' var bufPool = []; var tail = require('child_process').spawn('tail', ['-f', testFileName]); tail.stdout.on('data', tailCB); function tailCB(data) { PASS = data.toString().indexOf('.') < 0; } var timeToQuit = Date.now() + 8e3; //Test during no more than this seconds. (function main() { if (PASS) { fs.write(testFileFD, newBuffer(kBufSize, 0x61), 0, kBufSize, -1, cb); gc(); var nuBuf = new Buffer(kBufSize); neverWrittenBuffer.copy(nuBuf); if (bufPool.push(nuBuf) > 100) { bufPool.length = 0; } } else { throw new Error("Buffer GC'ed test -> FAIL"); } if (Date.now() < timeToQuit) { process.nextTick(main); } else { tail.kill(); console.log("Buffer GC'ed test -> PASS (OK)"); } })(); function cb(err, written) { if (err) { throw err; } } node-v4.8.2/test/pummel/test-regress-GH-814_2.js000644 000766 000024 00000003400 13070706737 021251 0ustar00iojsstaff000000 000000 'use strict'; // Flags: --expose_gc var common = require('../common'); var fs = require('fs'); var testFileName = require('path').join(common.tmpDir, 'GH-814_test.txt'); var testFD = fs.openSync(testFileName, 'w'); console.error(testFileName + '\n'); var tailProc = require('child_process').spawn('tail', ['-f', testFileName]); tailProc.stdout.on('data', tailCB); function tailCB(data) { PASS = data.toString().indexOf('.') < 0; if (PASS) { //console.error('i'); } else { console.error('[FAIL]\n DATA -> '); console.error(data); console.error('\n'); throw new Error('Buffers GC test -> FAIL'); } } var PASS = true; var bufPool = []; var kBufSize = 16 * 1024 * 1024; var neverWrittenBuffer = newBuffer(kBufSize, 0x2e); //0x2e === '.' var timeToQuit = Date.now() + 5e3; //Test should last no more than this. writer(); function writer() { if (PASS) { if (Date.now() > timeToQuit) { setTimeout(function() { process.kill(tailProc.pid); console.error('\nBuffers GC test -> PASS (OK)\n'); }, 555); } else { fs.write(testFD, newBuffer(kBufSize, 0x61), 0, kBufSize, -1, writerCB); gc(); gc(); gc(); gc(); gc(); gc(); var nuBuf = new Buffer(kBufSize); neverWrittenBuffer.copy(nuBuf); if (bufPool.push(nuBuf) > 100) { bufPool.length = 0; } process.nextTick(writer); //console.error('o'); } } } function writerCB(err, written) { //console.error('cb.'); if (err) { throw err; } } // ******************* UTILITIES function newBuffer(size, value) { var buffer = new Buffer(size); while (size--) { buffer[size] = value; } buffer[buffer.length - 1] = 0x0d; buffer[buffer.length - 1] = 0x0a; return buffer; } node-v4.8.2/test/pummel/test-regress-GH-892.js000644 000766 000024 00000005232 13070706737 021043 0ustar00iojsstaff000000 000000 'use strict'; // Uploading a big file via HTTPS causes node to drop out of the event loop. // https://github.com/joyent/node/issues/892 // In this test we set up an HTTPS in this process and launch a subprocess // to POST a 32mb file to us. A bug in the pause/resume functionality of the // TLS server causes the child process to exit cleanly before having sent // the entire buffer. var common = require('../common'); var assert = require('assert'); var spawn = require('child_process').spawn; if (!common.hasCrypto) { common.skip('missing crypto'); return; } var https = require('https'); var fs = require('fs'); var bytesExpected = 1024 * 1024 * 32; var started = false; var childScript = require('path').join(common.fixturesDir, 'GH-892-request.js'); function makeRequest() { if (started) return; started = true; var stderrBuffer = ''; // Pass along --trace-deprecation/--throw-deprecation in // process.execArgv to track down nextTick recursion errors // more easily. Also, this is handy when using this test to // view V8 opt/deopt behavior. var args = process.execArgv.concat([ childScript, common.PORT, bytesExpected ]); var child = spawn(process.execPath, args); child.on('exit', function(code) { assert.ok(/DONE/.test(stderrBuffer)); assert.equal(0, code); }); // The following two lines forward the stdio from the child // to parent process for debugging. child.stderr.pipe(process.stderr); child.stdout.pipe(process.stdout); // Buffer the stderr so that we can check that it got 'DONE' child.stderr.setEncoding('ascii'); child.stderr.on('data', function(d) { stderrBuffer += d; }); } var serverOptions = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }; var uploadCount = 0; var server = https.Server(serverOptions, function(req, res) { // Close the server immediately. This test is only doing a single upload. // We need to make sure the server isn't keeping the event loop alive // while the upload is in progress. server.close(); req.on('data', function(d) { process.stderr.write('.'); uploadCount += d.length; }); req.on('end', function() { assert.equal(bytesExpected, uploadCount); res.writeHead(200, {'content-type': 'text/plain'}); res.end('successful upload\n'); }); }); server.listen(common.PORT, function() { console.log('expecting %d bytes', bytesExpected); makeRequest(); }); process.on('exit', function() { console.error('got %d bytes', uploadCount); assert.equal(uploadCount, bytesExpected); }); node-v4.8.2/test/pummel/test-stream-pipe-multi.js000644 000766 000024 00000003726 13070706737 022141 0ustar00iojsstaff000000 000000 'use strict'; // Test that having a bunch of streams piping in parallel // doesn't break anything. require('../common'); var assert = require('assert'); var Stream = require('stream').Stream; var rr = []; var ww = []; var cnt = 100; var chunks = 1000; var chunkSize = 250; var data = new Buffer(chunkSize); var wclosed = 0; var rclosed = 0; function FakeStream() { Stream.apply(this); this.wait = false; this.writable = true; this.readable = true; } FakeStream.prototype = Object.create(Stream.prototype); FakeStream.prototype.write = function(chunk) { console.error(this.ID, 'write', this.wait); if (this.wait) { process.nextTick(this.emit.bind(this, 'drain')); } this.wait = !this.wait; return this.wait; }; FakeStream.prototype.end = function() { this.emit('end'); process.nextTick(this.close.bind(this)); }; // noop - closes happen automatically on end. FakeStream.prototype.close = function() { this.emit('close'); }; // expect all streams to close properly. process.on('exit', function() { assert.equal(cnt, wclosed, 'writable streams closed'); assert.equal(cnt, rclosed, 'readable streams closed'); }); for (let i = 0; i < chunkSize; i++) { data[i] = i; } for (let i = 0; i < cnt; i++) { var r = new FakeStream(); r.on('close', function() { console.error(this.ID, 'read close'); rclosed++; }); rr.push(r); var w = new FakeStream(); w.on('close', function() { console.error(this.ID, 'write close'); wclosed++; }); ww.push(w); r.ID = w.ID = i; r.pipe(w); } // now start passing through data // simulate a relatively fast async stream. rr.forEach(function(r) { var cnt = chunks; var paused = false; r.on('pause', function() { paused = true; }); r.on('resume', function() { paused = false; step(); }); function step() { r.emit('data', data); if (--cnt === 0) { r.end(); return; } if (paused) return; process.nextTick(step); } process.nextTick(step); }); node-v4.8.2/test/pummel/test-stream2-basic.js000644 000766 000024 00000022112 13070706737 021205 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var R = require('_stream_readable'); var assert = require('assert'); var util = require('util'); var EE = require('events').EventEmitter; function TestReader(n) { R.apply(this); this._buffer = new Buffer(n || 100); this._buffer.fill('x'); this._pos = 0; this._bufs = 10; } util.inherits(TestReader, R); TestReader.prototype._read = function(n) { var max = this._buffer.length - this._pos; n = Math.max(n, 0); var toRead = Math.min(n, max); if (toRead === 0) { // simulate the read buffer filling up with some more bytes some time // in the future. setTimeout(function() { this._pos = 0; this._bufs -= 1; if (this._bufs <= 0) { // read them all! if (!this.ended) this.push(null); } else { // now we have more. // kinda cheating by calling _read, but whatever, // it's just fake anyway. this._read(n); } }.bind(this), 10); return; } var ret = this._buffer.slice(this._pos, this._pos + toRead); this._pos += toRead; this.push(ret); }; ///// function TestWriter() { EE.apply(this); this.received = []; this.flush = false; } util.inherits(TestWriter, EE); TestWriter.prototype.write = function(c) { this.received.push(c.toString()); this.emit('write', c); return true; }; TestWriter.prototype.end = function(c) { if (c) this.write(c); this.emit('end', this.received); }; //////// // tiny node-tap lookalike. var tests = []; var count = 0; function test(name, fn) { count++; tests.push([name, fn]); } function run() { var next = tests.shift(); if (!next) return console.error('ok'); var name = next[0]; var fn = next[1]; console.log('# %s', name); fn({ same: assert.deepEqual, ok: assert, equal: assert.equal, end: function() { count--; run(); } }); } // ensure all tests have run process.on('exit', function() { assert.equal(count, 0); }); process.nextTick(run); test('a most basic test', function(t) { var r = new TestReader(20); var reads = []; var expect = [ 'x', 'xx', 'xxx', 'xxxx', 'xxxxx', 'xxxxxxxxx', 'xxxxxxxxxx', 'xxxxxxxxxxxx', 'xxxxxxxxxxxxx', 'xxxxxxxxxxxxxxx', 'xxxxxxxxxxxxxxxxx', 'xxxxxxxxxxxxxxxxxxx', 'xxxxxxxxxxxxxxxxxxxxx', 'xxxxxxxxxxxxxxxxxxxxxxx', 'xxxxxxxxxxxxxxxxxxxxxxxxx', 'xxxxxxxxxxxxxxxxxxxxx' ]; r.on('end', function() { t.same(reads, expect); t.end(); }); var readSize = 1; function flow() { var res; while (null !== (res = r.read(readSize++))) { reads.push(res.toString()); } r.once('readable', flow); } flow(); }); test('pipe', function(t) { var r = new TestReader(5); var expect = [ 'xxxxx', 'xxxxx', 'xxxxx', 'xxxxx', 'xxxxx', 'xxxxx', 'xxxxx', 'xxxxx', 'xxxxx', 'xxxxx' ]; var w = new TestWriter(); w.on('end', function(received) { t.same(received, expect); t.end(); }); r.pipe(w); }); [1, 2, 3, 4, 5, 6, 7, 8, 9].forEach(function(SPLIT) { test('unpipe', function(t) { var r = new TestReader(5); // unpipe after 3 writes, then write to another stream instead. var expect = [ 'xxxxx', 'xxxxx', 'xxxxx', 'xxxxx', 'xxxxx', 'xxxxx', 'xxxxx', 'xxxxx', 'xxxxx', 'xxxxx' ]; expect = [ expect.slice(0, SPLIT), expect.slice(SPLIT) ]; var w = [ new TestWriter(), new TestWriter() ]; var writes = SPLIT; w[0].on('write', function() { if (--writes === 0) { r.unpipe(); t.equal(r._readableState.pipes, null); w[0].end(); r.pipe(w[1]); t.equal(r._readableState.pipes, w[1]); } }); var ended = 0; var ended0 = false; var ended1 = false; w[0].on('end', function(results) { t.equal(ended0, false); ended0 = true; ended++; t.same(results, expect[0]); }); w[1].on('end', function(results) { t.equal(ended1, false); ended1 = true; ended++; t.equal(ended, 2); t.same(results, expect[1]); t.end(); }); r.pipe(w[0]); }); }); // both writers should get the same exact data. test('multipipe', function(t) { var r = new TestReader(5); var w = [ new TestWriter(), new TestWriter() ]; var expect = [ 'xxxxx', 'xxxxx', 'xxxxx', 'xxxxx', 'xxxxx', 'xxxxx', 'xxxxx', 'xxxxx', 'xxxxx', 'xxxxx' ]; var c = 2; w[0].on('end', function(received) { t.same(received, expect, 'first'); if (--c === 0) t.end(); }); w[1].on('end', function(received) { t.same(received, expect, 'second'); if (--c === 0) t.end(); }); r.pipe(w[0]); r.pipe(w[1]); }); [1, 2, 3, 4, 5, 6, 7, 8, 9].forEach(function(SPLIT) { test('multi-unpipe', function(t) { var r = new TestReader(5); // unpipe after 3 writes, then write to another stream instead. var expect = [ 'xxxxx', 'xxxxx', 'xxxxx', 'xxxxx', 'xxxxx', 'xxxxx', 'xxxxx', 'xxxxx', 'xxxxx', 'xxxxx' ]; expect = [ expect.slice(0, SPLIT), expect.slice(SPLIT) ]; var w = [ new TestWriter(), new TestWriter(), new TestWriter() ]; var writes = SPLIT; w[0].on('write', function() { if (--writes === 0) { r.unpipe(); w[0].end(); r.pipe(w[1]); } }); var ended = 0; w[0].on('end', function(results) { ended++; t.same(results, expect[0]); }); w[1].on('end', function(results) { ended++; t.equal(ended, 2); t.same(results, expect[1]); t.end(); }); r.pipe(w[0]); r.pipe(w[2]); }); }); test('back pressure respected', function(t) { function noop() {} var r = new R({ objectMode: true }); r._read = noop; var counter = 0; r.push(['one']); r.push(['two']); r.push(['three']); r.push(['four']); r.push(null); var w1 = new R(); w1.write = function(chunk) { console.error('w1.emit("close")'); assert.equal(chunk[0], 'one'); w1.emit('close'); process.nextTick(function() { r.pipe(w2); r.pipe(w3); }); }; w1.end = noop; r.pipe(w1); var expected = ['two', 'two', 'three', 'three', 'four', 'four']; var w2 = new R(); w2.write = function(chunk) { console.error('w2 write', chunk, counter); assert.equal(chunk[0], expected.shift()); assert.equal(counter, 0); counter++; if (chunk[0] === 'four') { return true; } setTimeout(function() { counter--; console.error('w2 drain'); w2.emit('drain'); }, 10); return false; }; w2.end = noop; var w3 = new R(); w3.write = function(chunk) { console.error('w3 write', chunk, counter); assert.equal(chunk[0], expected.shift()); assert.equal(counter, 1); counter++; if (chunk[0] === 'four') { return true; } setTimeout(function() { counter--; console.error('w3 drain'); w3.emit('drain'); }, 50); return false; }; w3.end = function() { assert.equal(counter, 2); assert.equal(expected.length, 0); t.end(); }; }); test('read(0) for ended streams', function(t) { var r = new R(); var written = false; var ended = false; r._read = function(n) {}; r.push(new Buffer('foo')); r.push(null); var v = r.read(0); assert.equal(v, null); var w = new R(); w.write = function(buffer) { written = true; assert.equal(ended, false); assert.equal(buffer.toString(), 'foo'); }; w.end = function() { ended = true; assert.equal(written, true); t.end(); }; r.pipe(w); }); test('sync _read ending', function(t) { var r = new R(); var called = false; r._read = function(n) { r.push(null); }; r.once('end', function() { called = true; }); r.read(); process.nextTick(function() { assert.equal(called, true); t.end(); }); }); test('adding readable triggers data flow', function(t) { var r = new R({ highWaterMark: 5 }); var onReadable = false; var readCalled = 0; r._read = function(n) { if (readCalled++ === 2) r.push(null); else r.push(new Buffer('asdf')); }; r.on('readable', function() { onReadable = true; r.read(); }); r.on('end', function() { t.equal(readCalled, 3); t.ok(onReadable); t.end(); }); }); test('chainable', function(t) { var r = new R(); r._read = function() {}; var r2 = r.setEncoding('utf8').pause().resume().pause(); t.equal(r, r2); t.end(); }); node-v4.8.2/test/pummel/test-timer-wrap.js000644 000766 000024 00000000412 13070706737 020637 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var Timer = process.binding('timer_wrap').Timer; var kOnTimeout = Timer.kOnTimeout; var t = new Timer(); t.start(1000, 0); t[kOnTimeout] = common.mustCall(function() { console.log('timeout'); t.close(); }); node-v4.8.2/test/pummel/test-timer-wrap2.js000644 000766 000024 00000000265 13070706737 020727 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); // Test that allocating a timer does not increase the loop's reference // count. var Timer = process.binding('timer_wrap').Timer; new Timer(); node-v4.8.2/test/pummel/test-timers.js000644 000766 000024 00000004473 13070706737 020066 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var WINDOW = 200; // why is does this need to be so big? var interval_count = 0; // check that these don't blow up. clearTimeout(null); clearInterval(null); assert.equal(true, setTimeout instanceof Function); var starttime = new Date(); setTimeout(common.mustCall(function() { var endtime = new Date(); var diff = endtime - starttime; assert.ok(diff > 0); console.error('diff: ' + diff); assert.equal(true, 1000 - WINDOW < diff && diff < 1000 + WINDOW); }), 1000); // this timer shouldn't execute var id = setTimeout(function() { assert.equal(true, false); }, 500); clearTimeout(id); setInterval(function() { interval_count += 1; var endtime = new Date(); var diff = endtime - starttime; assert.ok(diff > 0); console.error('diff: ' + diff); var t = interval_count * 1000; assert.equal(true, t - WINDOW < diff && diff < t + WINDOW); assert.equal(true, interval_count <= 3); if (interval_count === 3) clearInterval(this); }, 1000); // Single param: setTimeout(function(param) { assert.equal('test param', param); }, 1000, 'test param'); var interval_count2 = 0; setInterval(function(param) { ++interval_count2; assert.equal('test param', param); if (interval_count2 === 3) clearInterval(this); }, 1000, 'test param'); // Multiple param setTimeout(function(param1, param2) { assert.equal('param1', param1); assert.equal('param2', param2); }, 1000, 'param1', 'param2'); var interval_count3 = 0; setInterval(function(param1, param2) { ++interval_count3; assert.equal('param1', param1); assert.equal('param2', param2); if (interval_count3 === 3) clearInterval(this); }, 1000, 'param1', 'param2'); // setInterval(cb, 0) should be called multiple times. var count4 = 0; var interval4 = setInterval(function() { if (++count4 > 10) clearInterval(interval4); }, 0); // we should be able to clearTimeout multiple times without breakage. var expectedTimeouts = 3; function t() { expectedTimeouts--; } setTimeout(t, 200); setTimeout(t, 200); var y = setTimeout(t, 200); clearTimeout(y); setTimeout(t, 200); clearTimeout(y); process.on('exit', function() { assert.equal(3, interval_count); assert.equal(11, count4); assert.equal(0, expectedTimeouts, 'clearTimeout cleared too many timeouts'); }); node-v4.8.2/test/pummel/test-tls-ci-reneg-attack.js000644 000766 000024 00000004547 13070706737 022323 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var spawn = require('child_process').spawn; if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var fs = require('fs'); if (!common.opensslCli) { common.skip('node compiled without OpenSSL CLI.'); return; } // renegotiation limits to test var LIMITS = [0, 1, 2, 3, 5, 10, 16]; (function() { var n = 0; function next() { if (n >= LIMITS.length) return; tls.CLIENT_RENEG_LIMIT = LIMITS[n++]; test(next); } next(); })(); function test(next) { var options = { cert: fs.readFileSync(common.fixturesDir + '/test_cert.pem'), key: fs.readFileSync(common.fixturesDir + '/test_key.pem') }; var seenError = false; var server = tls.createServer(options, function(conn) { conn.on('error', function(err) { console.error('Caught exception: ' + err); assert(/TLS session renegotiation attack/.test(err)); conn.destroy(); seenError = true; }); conn.pipe(conn); }); server.listen(common.PORT, function() { var args = ('s_client -connect 127.0.0.1:' + common.PORT).split(' '); var child = spawn(common.opensslCli, args); //child.stdout.pipe(process.stdout); //child.stderr.pipe(process.stderr); child.stdout.resume(); child.stderr.resume(); // count handshakes, start the attack after the initial handshake is done var handshakes = 0; var renegs = 0; child.stderr.on('data', function(data) { if (seenError) return; handshakes += (('' + data).match(/verify return:1/g) || []).length; if (handshakes === 2) spam(); renegs += (('' + data).match(/RENEGOTIATING/g) || []).length; }); child.on('exit', function() { assert.equal(renegs, tls.CLIENT_RENEG_LIMIT + 1); server.close(); process.nextTick(next); }); var closed = false; child.stdin.on('error', function(err) { switch (err.code) { case 'ECONNRESET': case 'EPIPE': break; default: assert.equal(err.code, 'ECONNRESET'); break; } closed = true; }); child.stdin.on('close', function() { closed = true; }); // simulate renegotiation attack function spam() { if (closed) return; child.stdin.write('R\n'); setTimeout(spam, 50); } }); } node-v4.8.2/test/pummel/test-tls-connect-memleak.js000644 000766 000024 00000002073 13070706737 022417 0ustar00iojsstaff000000 000000 'use strict'; // Flags: --expose-gc var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var fs = require('fs'); assert(typeof gc === 'function', 'Run this test with --expose-gc'); tls.createServer({ cert: fs.readFileSync(common.fixturesDir + '/test_cert.pem'), key: fs.readFileSync(common.fixturesDir + '/test_key.pem') }).listen(common.PORT); (function() { // 2**26 == 64M entries for (var i = 0, junk = [0]; i < 26; ++i) junk = junk.concat(junk); var options = { rejectUnauthorized: false }; tls.connect(common.PORT, '127.0.0.1', options, function() { assert.notStrictEqual(junk.length, 0); // keep reference alive setTimeout(done, 10); gc(); }); })(); function done() { var before = process.memoryUsage().rss; gc(); var after = process.memoryUsage().rss; var reclaimed = (before - after) / 1024; console.log('%d kB reclaimed', reclaimed); assert(reclaimed > 256 * 1024); // it's more like 512M on x64 process.exit(); } node-v4.8.2/test/pummel/test-tls-securepair-client.js000644 000766 000024 00000007756 13070706737 023010 0ustar00iojsstaff000000 000000 'use strict'; // var common = require('../common'); if (!common.opensslCli) { common.skip('node compiled without OpenSSL CLI.'); return; } if (!common.hasCrypto) { common.skip('missing crypto'); return; } var join = require('path').join; var net = require('net'); var assert = require('assert'); var fs = require('fs'); var tls = require('tls'); var spawn = require('child_process').spawn; test1(); // simple/test-tls-securepair-client function test1() { test('agent.key', 'agent.crt', null, test2); } // simple/test-tls-ext-key-usage function test2() { function check(pair) { // "TLS Web Client Authentication" assert.equal(pair.cleartext.getPeerCertificate().ext_key_usage.length, 1); assert.equal(pair.cleartext.getPeerCertificate().ext_key_usage[0], '1.3.6.1.5.5.7.3.2'); } test('keys/agent4-key.pem', 'keys/agent4-cert.pem', check); } function test(keyfn, certfn, check, next) { keyfn = join(common.fixturesDir, keyfn); var key = fs.readFileSync(keyfn).toString(); certfn = join(common.fixturesDir, certfn); var cert = fs.readFileSync(certfn).toString(); var server = spawn(common.opensslCli, ['s_server', '-accept', common.PORT, '-cert', certfn, '-key', keyfn]); server.stdout.pipe(process.stdout); server.stderr.pipe(process.stdout); var state = 'WAIT-ACCEPT'; var serverStdoutBuffer = ''; server.stdout.setEncoding('utf8'); server.stdout.on('data', function(s) { serverStdoutBuffer += s; console.error(state); switch (state) { case 'WAIT-ACCEPT': if (/ACCEPT/g.test(serverStdoutBuffer)) { // Give s_server half a second to start up. setTimeout(startClient, 500); state = 'WAIT-HELLO'; } break; case 'WAIT-HELLO': if (/hello/g.test(serverStdoutBuffer)) { // End the current SSL connection and exit. // See s_server(1ssl). server.stdin.write('Q'); state = 'WAIT-SERVER-CLOSE'; } break; default: break; } }); var timeout = setTimeout(function() { server.kill(); process.exit(1); }, 5000); var gotWriteCallback = false; var serverExitCode = -1; server.on('exit', function(code) { serverExitCode = code; clearTimeout(timeout); if (next) next(); }); function startClient() { var s = new net.Stream(); var sslcontext = tls.createSecureContext({key: key, cert: cert}); sslcontext.context.setCiphers('RC4-SHA:AES128-SHA:AES256-SHA'); var pair = tls.createSecurePair(sslcontext, false); assert.ok(pair.encrypted.writable); assert.ok(pair.cleartext.writable); pair.encrypted.pipe(s); s.pipe(pair.encrypted); s.connect(common.PORT); s.on('connect', function() { console.log('client connected'); }); pair.on('secure', function() { console.log('client: connected+secure!'); console.log('client pair.cleartext.getPeerCertificate(): %j', pair.cleartext.getPeerCertificate()); console.log('client pair.cleartext.getCipher(): %j', pair.cleartext.getCipher()); if (check) check(pair); setTimeout(function() { pair.cleartext.write('hello\r\n', function() { gotWriteCallback = true; }); }, 500); }); pair.cleartext.on('data', function(d) { console.log('cleartext: %s', d.toString()); }); s.on('close', function() { console.log('client close'); }); pair.encrypted.on('error', function(err) { console.log('encrypted error: ' + err); }); s.on('error', function(err) { console.log('socket error: ' + err); }); pair.on('error', function(err) { console.log('secure error: ' + err); }); } process.on('exit', function() { assert.equal(0, serverExitCode); assert.equal('WAIT-SERVER-CLOSE', state); assert.ok(gotWriteCallback); }); } node-v4.8.2/test/pummel/test-tls-server-large-request.js000644 000766 000024 00000002223 13070706737 023436 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var fs = require('fs'); var stream = require('stream'); var util = require('util'); var request = new Buffer(new Array(1024 * 256).join('ABCD')); // 1mb var options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }; function Mediator() { stream.Writable.call(this); this.buf = ''; } util.inherits(Mediator, stream.Writable); Mediator.prototype._write = function _write(data, enc, cb) { this.buf += data; setTimeout(cb, 0); if (this.buf.length >= request.length) { assert.equal(this.buf, request.toString()); server.close(); } }; var mediator = new Mediator(); var server = tls.Server(options, common.mustCall(function(socket) { socket.pipe(mediator); })); server.listen(common.PORT, common.mustCall(function() { var client1 = tls.connect({ port: common.PORT, rejectUnauthorized: false }, common.mustCall(function() { client1.end(request); })); })); node-v4.8.2/test/pummel/test-tls-session-timeout.js000644 000766 000024 00000006503 13070706737 022526 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); if (!common.opensslCli) { common.skip('node compiled without OpenSSL CLI.'); return; } if (!common.hasCrypto) { common.skip('missing crypto'); return; } doTest(); // This test consists of three TLS requests -- // * The first one should result in a new connection because we don't have // a valid session ticket. // * The second one should result in connection resumption because we used // the session ticket we saved from the first connection. // * The third one should result in a new connection because the ticket // that we used has expired by now. function doTest() { var assert = require('assert'); var tls = require('tls'); var fs = require('fs'); var join = require('path').join; var spawn = require('child_process').spawn; var SESSION_TIMEOUT = 1; var keyFile = join(common.fixturesDir, 'agent.key'); var certFile = join(common.fixturesDir, 'agent.crt'); var key = fs.readFileSync(keyFile); var cert = fs.readFileSync(certFile); var options = { key: key, cert: cert, ca: [cert], sessionTimeout: SESSION_TIMEOUT }; // We need to store a sample session ticket in the fixtures directory because // `s_client` behaves incorrectly if we do not pass in both the `-sess_in` // and the `-sess_out` flags, and the `-sess_in` argument must point to a // file containing a proper serialization of a session ticket. // To avoid a source control diff, we copy the ticket to a temporary file. var sessionFileName = (function() { var ticketFileName = 'tls-session-ticket.txt'; var fixturesPath = join(common.fixturesDir, ticketFileName); var tmpPath = join(common.tmpDir, ticketFileName); fs.writeFileSync(tmpPath, fs.readFileSync(fixturesPath)); return tmpPath; }()); // Expects a callback -- cb(connectionType : enum ['New'|'Reused']) var Client = function(cb) { var flags = [ 's_client', '-connect', 'localhost:' + common.PORT, '-sess_in', sessionFileName, '-sess_out', sessionFileName ]; var client = spawn(common.opensslCli, flags, { stdio: ['ignore', 'pipe', 'ignore'] }); var clientOutput = ''; client.stdout.on('data', function(data) { clientOutput += data.toString(); }); client.on('exit', function(code) { var connectionType; var grepConnectionType = function(line) { var matches = line.match(/(New|Reused), /); if (matches) { connectionType = matches[1]; return true; } }; var lines = clientOutput.split('\n'); if (!lines.some(grepConnectionType)) { throw new Error('unexpected output from openssl client'); } cb(connectionType); }); }; var server = tls.createServer(options, function(cleartext) { cleartext.on('error', function(er) { if (er.code !== 'ECONNRESET') throw er; }); cleartext.end(); }); server.listen(common.PORT, function() { Client(function(connectionType) { assert(connectionType === 'New'); Client(function(connectionType) { assert(connectionType === 'Reused'); setTimeout(function() { Client(function(connectionType) { assert(connectionType === 'New'); server.close(); }); }, (SESSION_TIMEOUT + 1) * 1000); }); }); }); } node-v4.8.2/test/pummel/test-tls-throttle.js000644 000766 000024 00000002636 13070706737 021227 0ustar00iojsstaff000000 000000 'use strict'; // Server sends a large string. Client counts bytes and pauses every few // seconds. Makes sure that pause and resume work properly. var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var fs = require('fs'); process.stdout.write('build body...'); var body = 'hello world\n'.repeat(1024 * 1024); process.stdout.write('done\n'); var options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent2-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent2-cert.pem') }; var server = tls.Server(options, common.mustCall(function(socket) { socket.end(body); })); var recvCount = 0; server.listen(common.PORT, function() { var client = tls.connect({ port: common.PORT, rejectUnauthorized: false }); client.on('data', function(d) { process.stdout.write('.'); recvCount += d.length; client.pause(); process.nextTick(function() { client.resume(); }); }); client.on('close', function() { console.error('close'); server.close(); clearTimeout(timeout); }); }); function displayCounts() { console.log('body.length: %d', body.length); console.log(' recvCount: %d', recvCount); } var timeout = setTimeout(displayCounts, 10 * 1000); process.on('exit', function() { displayCounts(); assert.equal(body.length, recvCount); }); node-v4.8.2/test/pummel/test-vm-memleak.js000644 000766 000024 00000001542 13070706737 020610 0ustar00iojsstaff000000 000000 'use strict'; // Flags: --max_old_space_size=32 require('../common'); var assert = require('assert'); var start = Date.now(); var maxMem = 0; var ok = process.execArgv.some(function(arg) { return arg === '--max_old_space_size=32'; }); assert(ok, 'Run this test with --max_old_space_size=32.'); var interval = setInterval(function() { try { require('vm').runInNewContext('throw 1;'); } catch (e) { } var rss = process.memoryUsage().rss; maxMem = Math.max(rss, maxMem); if (Date.now() - start > 5 * 1000) { // wait 10 seconds. clearInterval(interval); testContextLeak(); } }, 1); function testContextLeak() { for (var i = 0; i < 1000; i++) require('vm').createContext({}); } process.on('exit', function() { console.error('max mem: %dmb', Math.round(maxMem / (1024 * 1024))); assert.ok(maxMem < 64 * 1024 * 1024); }); node-v4.8.2/test/pummel/test-watch-file.js000644 000766 000024 00000001060 13070706737 020573 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var fs = require('fs'); var path = require('path'); const f = path.join(common.fixturesDir, 'x.txt'); let changes = 0; function watchFile() { fs.watchFile(f, (curr, prev) => { changes++; assert.notDeepStrictEqual(curr.mtime, prev.mtime); fs.unwatchFile(f); watchFile(); fs.unwatchFile(f); }); } watchFile(); const fd = fs.openSync(f, 'w+'); fs.writeSync(fd, 'xyz\n'); fs.closeSync(fd); process.on('exit', function() { assert.ok(changes > 0); }); node-v4.8.2/test/pummel/testcfg.py000644 000766 000024 00000000303 13070706737 017245 0ustar00iojsstaff000000 000000 import sys, os sys.path.append(os.path.join(os.path.dirname(__file__), '..')) import testpy def GetConfiguration(context, root): return testpy.SimpleTestConfiguration(context, root, 'pummel') node-v4.8.2/test/pseudo-tty/no_dropped_stdio.js000644 000766 000024 00000001025 13070706737 021745 0ustar00iojsstaff000000 000000 // https://github.com/nodejs/node/issues/6456#issuecomment-219320599 // https://gist.github.com/isaacs/1495b91ec66b21d30b10572d72ad2cdd 'use strict'; require('../common'); // 1000 bytes wrapped at 50 columns // \n turns into a double-byte character // (48 + {2}) * 20 = 1000 var out = ('o'.repeat(48) + '\n').repeat(20); // Add the remaining 24 bytes and terminate with an 'O'. // This results in 1025 bytes, just enough to overflow the 1kb OS X TTY buffer. out += 'o'.repeat(24) + 'O'; process.stdout.write(out); process.exit(0); node-v4.8.2/test/pseudo-tty/no_dropped_stdio.out000644 000766 000024 00000001756 13070706737 022153 0ustar00iojsstaff000000 000000 oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo ooooooooooooooooooooooooO node-v4.8.2/test/pseudo-tty/no_interleaved_stdio.js000644 000766 000024 00000001107 13070706737 022613 0ustar00iojsstaff000000 000000 // https://github.com/nodejs/node/issues/6456#issuecomment-219320599 // https://gist.github.com/isaacs/1495b91ec66b21d30b10572d72ad2cdd 'use strict'; require('../common'); // 1000 bytes wrapped at 50 columns // \n turns into a double-byte character // (48 + {2}) * 20 = 1000 var out = ('o'.repeat(48) + '\n').repeat(20); // Add the remaining 24 bytes and terminate with an 'O'. // This results in 1025 bytes, just enough to overflow the 1kb OS X TTY buffer. out += 'o'.repeat(24) + 'O'; const err = '__This is some stderr__'; process.stdout.write(out); process.stderr.write(err); node-v4.8.2/test/pseudo-tty/no_interleaved_stdio.out000644 000766 000024 00000002005 13070706737 023004 0ustar00iojsstaff000000 000000 oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo oooooooooooooooooooooooooooooooooooooooooooooooo ooooooooooooooooooooooooO__This is some stderr__ node-v4.8.2/test/pseudo-tty/pseudo-tty.status000644 000766 000024 00000000457 13070706737 021446 0ustar00iojsstaff000000 000000 prefix pseudo-tty [$system==aix] # test issue only, covered under https://github.com/nodejs/node/issues/7973 no_dropped_stdio : SKIP no_interleaved_stdio : SKIP # test issue: https://github.com/nodejs/node/issues/11541 test-stderr-stdout-handle-sigwinch : SKIP node-v4.8.2/test/pseudo-tty/stdin-setrawmode.out000644 000766 000024 00000000000 13070706737 022066 0ustar00iojsstaff000000 000000 node-v4.8.2/test/pseudo-tty/test-stderr-stdout-handle-sigwinch.js000644 000766 000024 00000002032 13070706737 025253 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const originalRefreshSizeStderr = process.stderr._refreshSize; const originalRefreshSizeStdout = process.stdout._refreshSize; const wrap = (fn, ioStream, string) => { const wrapped = common.mustCall(() => { // The console.log() call prints a string that is in the .out file. In other // words, the console.log() is part of the test, not extraneous debugging. console.log(string); try { fn.call(ioStream); } catch (e) { // EINVAL happens on SmartOS if emulation is incomplete if (!common.isSunOS || e.code !== 'EINVAL') throw e; } }); return wrapped; }; process.stderr._refreshSize = wrap(originalRefreshSizeStderr, process.stderr, 'calling stderr._refreshSize'); process.stdout._refreshSize = wrap(originalRefreshSizeStdout, process.stdout, 'calling stdout._refreshSize'); process.emit('SIGWINCH'); node-v4.8.2/test/pseudo-tty/test-stderr-stdout-handle-sigwinch.out000644 000766 000024 00000000070 13070706737 025446 0ustar00iojsstaff000000 000000 calling stdout._refreshSize calling stderr._refreshSize node-v4.8.2/test/pseudo-tty/test-tty-stdout-end.js000644 000766 000024 00000000454 13070706737 022300 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const shouldThrow = function() { process.stdout.end(); }; const validateError = function(e) { return e instanceof Error && e.message === 'process.stdout cannot be closed.'; }; assert.throws(shouldThrow, validateError); node-v4.8.2/test/pseudo-tty/test-tty-stdout-end.out000644 000766 000024 00000000000 13070706737 022456 0ustar00iojsstaff000000 000000 node-v4.8.2/test/pseudo-tty/test-tty-wrap.js000644 000766 000024 00000000472 13070706737 021163 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const TTY = process.binding('tty_wrap').TTY; const WriteWrap = process.binding('stream_wrap').WriteWrap; const handle = new TTY(1); const req = new WriteWrap(); handle.writeBuffer(req, Buffer.from('hello world 1\n')); handle.writeBuffer(req, Buffer.from('hello world 2\n')); node-v4.8.2/test/pseudo-tty/test-tty-wrap.out000644 000766 000024 00000000034 13070706737 021350 0ustar00iojsstaff000000 000000 hello world 1 hello world 2 node-v4.8.2/test/pseudo-tty/testcfg.py000644 000766 000024 00000013367 13070706737 020101 0ustar00iojsstaff000000 000000 # Copyright 2008 the V8 project authors. All rights reserved. # Redistribution and use in source and binary forms, with or without # modification, are permitted provided that the following conditions are # met: # # * Redistributions of source code must retain the above copyright # notice, this list of conditions and the following disclaimer. # * Redistributions in binary form must reproduce the above # copyright notice, this list of conditions and the following # disclaimer in the documentation and/or other materials provided # with the distribution. # * Neither the name of Google Inc. nor the names of its # contributors may be used to endorse or promote products derived # from this software without specific prior written permission. # # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. import test import os from os.path import join, exists, basename, isdir import re import utils FLAGS_PATTERN = re.compile(r"//\s+Flags:(.*)") class TTYTestCase(test.TestCase): def __init__(self, path, file, expected, arch, mode, context, config): super(TTYTestCase, self).__init__(context, path, arch, mode) self.file = file self.expected = expected self.config = config self.arch = arch self.mode = mode def IgnoreLine(self, str): """Ignore empty lines and valgrind output.""" if not str.strip(): return True else: return str.startswith('==') or str.startswith('**') def IsFailureOutput(self, output): f = file(self.expected) # Convert output lines to regexps that we can match env = { 'basename': basename(self.file) } patterns = [ ] for line in f: if not line.strip(): continue pattern = re.escape(line.rstrip() % env) pattern = pattern.replace('\\*', '.*') pattern = '^%s$' % pattern patterns.append(pattern) # Compare actual output with the expected raw_lines = (output.stdout + output.stderr).split('\n') outlines = [ s.strip() for s in raw_lines if not self.IgnoreLine(s) ] if len(outlines) != len(patterns): print "length differs." print "expect=%d" % len(patterns) print "actual=%d" % len(outlines) print "patterns:" for i in xrange(len(patterns)): print "pattern = %s" % patterns[i] print "outlines:" for i in xrange(len(outlines)): print "outline = %s" % outlines[i] return True for i in xrange(len(patterns)): if not re.match(patterns[i], outlines[i]): print "match failed" print "line=%d" % i print "expect=%s" % patterns[i] print "actual=%s" % outlines[i] return True return False def GetLabel(self): return "%s %s" % (self.mode, self.GetName()) def GetName(self): return self.path[-1] def GetCommand(self): result = [self.config.context.GetVm(self.arch, self.mode)] source = open(self.file).read() flags_match = FLAGS_PATTERN.search(source) if flags_match: result += flags_match.group(1).strip().split() result.append(self.file) return result def GetSource(self): return (open(self.file).read() + "\n--- expected output ---\n" + open(self.expected).read()) def RunCommand(self, command, env): full_command = self.context.processor(command) output = test.Execute(full_command, self.context, self.context.GetTimeout(self.mode), env, True) self.Cleanup() return test.TestOutput(self, full_command, output, self.context.store_unexpected_output) class TTYTestConfiguration(test.TestConfiguration): def __init__(self, context, root): super(TTYTestConfiguration, self).__init__(context, root) def Ls(self, path): if isdir(path): return [f[:-3] for f in os.listdir(path) if f.endswith('.js')] else: return [] def ListTests(self, current_path, path, arch, mode): all_tests = [current_path + [t] for t in self.Ls(self.root)] result = [] # Skip these tests on Windows, as pseudo terminals are not available if utils.IsWindows(): print ("Skipping pseudo-tty tests, as pseudo terminals are not available" " on Windows.") return result for test in all_tests: if self.Contains(path, test): file_prefix = join(self.root, reduce(join, test[1:], "")) file_path = file_prefix + ".js" output_path = file_prefix + ".out" if not exists(output_path): raise Exception("Could not find %s" % output_path) result.append(TTYTestCase(test, file_path, output_path, arch, mode, self.context, self)) return result def GetBuildRequirements(self): return ['sample', 'sample=shell'] def GetTestStatus(self, sections, defs): status_file = join(self.root, 'pseudo-tty.status') if exists(status_file): test.ReadConfigurationInto(status_file, sections, defs) def GetConfiguration(context, root): return TTYTestConfiguration(context, root) node-v4.8.2/test/parallel/parallel.status000644 000766 000024 00000002360 13070706736 020576 0ustar00iojsstaff000000 000000 prefix parallel # To mark a test as flaky, list the test name in the appropriate section # below, without ".js", followed by ": PASS,FLAKY". Example: # sample-test : PASS,FLAKY [true] # This section applies to all platforms [$system==win32] test-tick-processor : PASS,FLAKY [$system==linux] test-tick-processor : PASS,FLAKY [$system==macos] [$system==solaris] # Also applies to SmartOS test-debug-signal-cluster : PASS,FLAKY [$system==freebsd] # fs-watch currently needs special configuration on AIX and we # want to improve under https://github.com/nodejs/node/issues/5085. # Tests are disabled so CI can be green and we can spot other # regressions until this work is complete [$system==aix] test-fs-watch-enoent : FAIL, PASS # Disable so we don't get failures now that AIX has been # added to regular CI runs test-regress-GH-1899 : FAIL, PASS # Flaky until https://github.com/nodejs/build/issues/415 is resolved. # On some of the buildbots, AAAA queries for localhost don't resolve # to an address and neither do any of the alternatives from the # localIPv6Hosts list from test/common.js. test-https-connect-address-family : PASS,FLAKY test-tls-connect-address-family : PASS,FLAKY node-v4.8.2/test/parallel/test-arm-math-exp-regress-1376.js000644 000766 000024 00000001141 13070706736 023412 0ustar00iojsstaff000000 000000 'use strict'; // See https://github.com/nodejs/node/issues/1376 // and https://code.google.com/p/v8/issues/detail?id=4019 require('../common'); Math.abs(-0.5); Math.acos(-0.5); Math.acosh(-0.5); Math.asin(-0.5); Math.asinh(-0.5); Math.atan(-0.5); Math.atanh(-0.5); Math.cbrt(-0.5); Math.ceil(-0.5); Math.cos(-0.5); Math.cosh(-0.5); Math.exp(-0.5); Math.expm1(-0.5); Math.floor(-0.5); Math.fround(-0.5); Math.log(-0.5); Math.log10(-0.5); Math.log1p(-0.5); Math.log2(-0.5); Math.round(-0.5); Math.sign(-0.5); Math.sin(-0.5); Math.sinh(-0.5); Math.sqrt(-0.5); Math.tan(-0.5); Math.tanh(-0.5); Math.trunc(-0.5); node-v4.8.2/test/parallel/test-assert-typedarray-deepequal.js000644 000766 000024 00000003757 13070706736 024511 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const a = require('assert'); function makeBlock(f) { var args = Array.prototype.slice.call(arguments, 1); return function() { return f.apply(this, args); }; } const equalArrayPairs = [ [new Uint8Array(1e5), new Uint8Array(1e5)], [new Uint16Array(1e5), new Uint16Array(1e5)], [new Uint32Array(1e5), new Uint32Array(1e5)], [new Uint8ClampedArray(1e5), new Uint8ClampedArray(1e5)], [new Int8Array(1e5), new Int8Array(1e5)], [new Int16Array(1e5), new Int16Array(1e5)], [new Int32Array(1e5), new Int32Array(1e5)], [new Float32Array(1e5), new Float32Array(1e5)], [new Float64Array(1e5), new Float64Array(1e5)], [new Int16Array(256), new Uint16Array(256)], [new Int16Array([256]), new Uint16Array([256])], [new Float32Array([+0.0]), new Float32Array([-0.0])], [new Float64Array([+0.0]), new Float32Array([-0.0])], [new Float64Array([+0.0]), new Float64Array([-0.0])], [new Uint8Array([1, 2, 3, 4]).subarray(1), new Uint8Array([2, 3, 4])], [new Uint16Array([1, 2, 3, 4]).subarray(1), new Uint16Array([2, 3, 4])], [new Uint32Array([1, 2, 3, 4]).subarray(1, 3), new Uint32Array([2, 3])] ]; const notEqualArrayPairs = [ [new Uint8Array(2), new Uint8Array(3)], [new Uint8Array([1, 2, 3]), new Uint8Array([4, 5, 6])], [new Uint8ClampedArray([300, 2, 3]), new Uint8Array([300, 2, 3])], [new Uint16Array([2]), new Uint16Array([3])], [new Uint16Array([0]), new Uint16Array([256])], [new Int16Array([0]), new Uint16Array([256])], [new Int16Array([-256]), new Uint16Array([0xff00])], // same bits [new Int32Array([-256]), new Uint32Array([0xffffff00])], // ditto [new Float32Array([0.1]), new Float32Array([0.0])], [new Float64Array([0.1]), new Float64Array([0.0])] ]; equalArrayPairs.forEach((arrayPair) => { assert.deepEqual(arrayPair[0], arrayPair[1]); }); notEqualArrayPairs.forEach((arrayPair) => { assert.throws( makeBlock(a.deepEqual, arrayPair[0], arrayPair[1]), a.AssertionError ); }); node-v4.8.2/test/parallel/test-assert.js000644 000766 000024 00000044504 13070706736 020357 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var a = require('assert'); function makeBlock(f) { var args = Array.prototype.slice.call(arguments, 1); return function() { return f.apply(this, args); }; } assert.ok(a.AssertionError.prototype instanceof Error, 'a.AssertionError instanceof Error'); assert.throws(makeBlock(a, false), a.AssertionError, 'ok(false)'); assert.doesNotThrow(makeBlock(a, true), a.AssertionError, 'ok(true)'); assert.doesNotThrow(makeBlock(a, 'test', 'ok(\'test\')')); assert.throws(makeBlock(a.ok, false), a.AssertionError, 'ok(false)'); assert.doesNotThrow(makeBlock(a.ok, true), a.AssertionError, 'ok(true)'); assert.doesNotThrow(makeBlock(a.ok, 'test'), 'ok(\'test\')'); assert.throws(makeBlock(a.equal, true, false), a.AssertionError, 'equal(true, false)'); assert.doesNotThrow(makeBlock(a.equal, null, null), 'equal(null, null)'); assert.doesNotThrow(makeBlock(a.equal, undefined, undefined), 'equal(undefined, undefined)'); assert.doesNotThrow(makeBlock(a.equal, null, undefined), 'equal(null, undefined)'); assert.doesNotThrow(makeBlock(a.equal, true, true), 'equal(true, true)'); assert.doesNotThrow(makeBlock(a.equal, 2, '2'), 'equal(2, \'2\')'); assert.doesNotThrow(makeBlock(a.notEqual, true, false), 'notEqual(true, false)'); assert.throws(makeBlock(a.notEqual, true, true), a.AssertionError, 'notEqual(true, true)'); assert.throws(makeBlock(a.strictEqual, 2, '2'), a.AssertionError, 'strictEqual(2, \'2\')'); assert.throws(makeBlock(a.strictEqual, null, undefined), a.AssertionError, 'strictEqual(null, undefined)'); assert.throws(makeBlock(a.notStrictEqual, 2, 2), a.AssertionError, 'notStrictEqual(2, 2)'); assert.doesNotThrow(makeBlock(a.notStrictEqual, 2, '2'), 'notStrictEqual(2, \'2\')'); // deepEqual joy! // 7.2 assert.doesNotThrow(makeBlock(a.deepEqual, new Date(2000, 3, 14), new Date(2000, 3, 14)), 'deepEqual(new Date(2000, 3, 14), new Date(2000, 3, 14))'); assert.throws(makeBlock(a.deepEqual, new Date(), new Date(2000, 3, 14)), a.AssertionError, 'deepEqual(new Date(), new Date(2000, 3, 14))'); assert.throws(makeBlock( a.notDeepEqual, new Date(2000, 3, 14), new Date(2000, 3, 14)), a.AssertionError, 'notDeepEqual(new Date(2000, 3, 14), new Date(2000, 3, 14))' ); assert.doesNotThrow(makeBlock( a.notDeepEqual, new Date(), new Date(2000, 3, 14)), 'notDeepEqual(new Date(), new Date(2000, 3, 14))' ); // 7.3 assert.doesNotThrow(makeBlock(a.deepEqual, /a/, /a/)); assert.doesNotThrow(makeBlock(a.deepEqual, /a/g, /a/g)); assert.doesNotThrow(makeBlock(a.deepEqual, /a/i, /a/i)); assert.doesNotThrow(makeBlock(a.deepEqual, /a/m, /a/m)); assert.doesNotThrow(makeBlock(a.deepEqual, /a/igm, /a/igm)); assert.throws(makeBlock(a.deepEqual, /ab/, /a/), /^AssertionError: \/ab\/ deepEqual \/a\/$/); assert.throws(makeBlock(a.deepEqual, /a/g, /a/), /^AssertionError: \/a\/g deepEqual \/a\/$/); assert.throws(makeBlock(a.deepEqual, /a/i, /a/), /^AssertionError: \/a\/i deepEqual \/a\/$/); assert.throws(makeBlock(a.deepEqual, /a/m, /a/), /^AssertionError: \/a\/m deepEqual \/a\/$/); assert.throws(makeBlock(a.deepEqual, /a/igm, /a/im), /^AssertionError: \/a\/gim deepEqual \/a\/im$/); { const re1 = /a/g; re1.lastIndex = 3; assert.throws(makeBlock(a.deepEqual, re1, /a/g), /^AssertionError: \/a\/g deepEqual \/a\/g$/); } // 7.4 assert.doesNotThrow(makeBlock(a.deepEqual, 4, '4'), 'deepEqual(4, \'4\')'); assert.doesNotThrow(makeBlock(a.deepEqual, true, 1), 'deepEqual(true, 1)'); assert.throws(makeBlock(a.deepEqual, 4, '5'), a.AssertionError, 'deepEqual( 4, \'5\')'); // 7.5 // having the same number of owned properties && the same set of keys assert.doesNotThrow(makeBlock(a.deepEqual, {a: 4}, {a: 4})); assert.doesNotThrow(makeBlock(a.deepEqual, {a: 4, b: '2'}, {a: 4, b: '2'})); assert.doesNotThrow(makeBlock(a.deepEqual, [4], ['4'])); assert.throws(makeBlock(a.deepEqual, {a: 4}, {a: 4, b: true}), a.AssertionError); assert.doesNotThrow(makeBlock(a.deepEqual, ['a'], {0: 'a'})); //(although not necessarily the same order), assert.doesNotThrow(makeBlock(a.deepEqual, {a: 4, b: '1'}, {b: '1', a: 4})); var a1 = [1, 2, 3]; var a2 = [1, 2, 3]; a1.a = 'test'; a1.b = true; a2.b = true; a2.a = 'test'; assert.throws(makeBlock(a.deepEqual, Object.keys(a1), Object.keys(a2)), a.AssertionError); assert.doesNotThrow(makeBlock(a.deepEqual, a1, a2)); // having an identical prototype property var nbRoot = { toString: function() { return this.first + ' ' + this.last; } }; function nameBuilder(first, last) { this.first = first; this.last = last; return this; } nameBuilder.prototype = nbRoot; function nameBuilder2(first, last) { this.first = first; this.last = last; return this; } nameBuilder2.prototype = nbRoot; var nb1 = new nameBuilder('Ryan', 'Dahl'); var nb2 = new nameBuilder2('Ryan', 'Dahl'); assert.doesNotThrow(makeBlock(a.deepEqual, nb1, nb2)); nameBuilder2.prototype = Object; nb2 = new nameBuilder2('Ryan', 'Dahl'); assert.doesNotThrow(makeBlock(a.deepEqual, nb1, nb2)); // primitives and object assert.throws(makeBlock(a.deepEqual, null, {}), a.AssertionError); assert.throws(makeBlock(a.deepEqual, undefined, {}), a.AssertionError); assert.throws(makeBlock(a.deepEqual, 'a', ['a']), a.AssertionError); assert.throws(makeBlock(a.deepEqual, 'a', {0: 'a'}), a.AssertionError); assert.throws(makeBlock(a.deepEqual, 1, {}), a.AssertionError); assert.throws(makeBlock(a.deepEqual, true, {}), a.AssertionError); assert.throws(makeBlock(a.deepEqual, Symbol(), {}), a.AssertionError); // primitive wrappers and object assert.doesNotThrow(makeBlock(a.deepEqual, new String('a'), ['a']), a.AssertionError); assert.doesNotThrow(makeBlock(a.deepEqual, new String('a'), {0: 'a'}), a.AssertionError); assert.doesNotThrow(makeBlock(a.deepEqual, new Number(1), {}), a.AssertionError); assert.doesNotThrow(makeBlock(a.deepEqual, new Boolean(true), {}), a.AssertionError); // same number of keys but different key names assert.throws(makeBlock(a.deepEqual, {a: 1}, {b: 1}), a.AssertionError); //deepStrictEqual assert.doesNotThrow( makeBlock(a.deepStrictEqual, new Date(2000, 3, 14), new Date(2000, 3, 14)), 'deepStrictEqual(new Date(2000, 3, 14), new Date(2000, 3, 14))' ); assert.throws( makeBlock(a.deepStrictEqual, new Date(), new Date(2000, 3, 14)), a.AssertionError, 'deepStrictEqual(new Date(), new Date(2000, 3, 14))' ); assert.throws( makeBlock(a.notDeepStrictEqual, new Date(2000, 3, 14), new Date(2000, 3, 14)), a.AssertionError, 'notDeepStrictEqual(new Date(2000, 3, 14), new Date(2000, 3, 14))' ); assert.doesNotThrow( makeBlock(a.notDeepStrictEqual, new Date(), new Date(2000, 3, 14)), 'notDeepStrictEqual(new Date(), new Date(2000, 3, 14))' ); // 7.3 - strict assert.doesNotThrow(makeBlock(a.deepStrictEqual, /a/, /a/)); assert.doesNotThrow(makeBlock(a.deepStrictEqual, /a/g, /a/g)); assert.doesNotThrow(makeBlock(a.deepStrictEqual, /a/i, /a/i)); assert.doesNotThrow(makeBlock(a.deepStrictEqual, /a/m, /a/m)); assert.doesNotThrow(makeBlock(a.deepStrictEqual, /a/igm, /a/igm)); assert.throws( makeBlock(a.deepStrictEqual, /ab/, /a/), /^AssertionError: \/ab\/ deepStrictEqual \/a\/$/ ); assert.throws( makeBlock(a.deepStrictEqual, /a/g, /a/), /^AssertionError: \/a\/g deepStrictEqual \/a\/$/ ); assert.throws( makeBlock(a.deepStrictEqual, /a/i, /a/), /^AssertionError: \/a\/i deepStrictEqual \/a\/$/ ); assert.throws( makeBlock(a.deepStrictEqual, /a/m, /a/), /^AssertionError: \/a\/m deepStrictEqual \/a\/$/ ); assert.throws( makeBlock(a.deepStrictEqual, /a/igm, /a/im), /^AssertionError: \/a\/gim deepStrictEqual \/a\/im$/ ); { const re1 = /a/; re1.lastIndex = 3; assert.throws(makeBlock(a.deepStrictEqual, re1, /a/)); } // 7.4 - strict assert.throws(makeBlock(a.deepStrictEqual, 4, '4'), a.AssertionError, 'deepStrictEqual(4, \'4\')'); assert.throws(makeBlock(a.deepStrictEqual, true, 1), a.AssertionError, 'deepStrictEqual(true, 1)'); assert.throws(makeBlock(a.deepStrictEqual, 4, '5'), a.AssertionError, 'deepStrictEqual(4, \'5\')'); // 7.5 - strict // having the same number of owned properties && the same set of keys assert.doesNotThrow(makeBlock(a.deepStrictEqual, {a: 4}, {a: 4})); assert.doesNotThrow(makeBlock(a.deepStrictEqual, {a: 4, b: '2'}, {a: 4, b: '2'})); assert.throws(makeBlock(a.deepStrictEqual, [4], ['4'])); assert.throws(makeBlock(a.deepStrictEqual, {a: 4}, {a: 4, b: true}), a.AssertionError); assert.throws(makeBlock(a.deepStrictEqual, ['a'], {0: 'a'})); //(although not necessarily the same order), assert.doesNotThrow(makeBlock(a.deepStrictEqual, {a: 4, b: '1'}, {b: '1', a: 4})); assert.throws(makeBlock(a.deepStrictEqual, [0, 1, 2, 'a', 'b'], [0, 1, 2, 'b', 'a']), a.AssertionError); assert.doesNotThrow(makeBlock(a.deepStrictEqual, a1, a2)); // Prototype check function Constructor1(first, last) { this.first = first; this.last = last; } function Constructor2(first, last) { this.first = first; this.last = last; } var obj1 = new Constructor1('Ryan', 'Dahl'); var obj2 = new Constructor2('Ryan', 'Dahl'); assert.throws(makeBlock(a.deepStrictEqual, obj1, obj2), a.AssertionError); Constructor2.prototype = Constructor1.prototype; obj2 = new Constructor2('Ryan', 'Dahl'); assert.doesNotThrow(makeBlock(a.deepStrictEqual, obj1, obj2)); // primitives assert.throws(makeBlock(assert.deepStrictEqual, 4, '4'), a.AssertionError); assert.throws(makeBlock(assert.deepStrictEqual, true, 1), a.AssertionError); assert.throws(makeBlock(assert.deepStrictEqual, Symbol(), Symbol()), a.AssertionError); var s = Symbol(); assert.doesNotThrow(makeBlock(assert.deepStrictEqual, s, s)); // primitives and object assert.throws(makeBlock(a.deepStrictEqual, null, {}), a.AssertionError); assert.throws(makeBlock(a.deepStrictEqual, undefined, {}), a.AssertionError); assert.throws(makeBlock(a.deepStrictEqual, 'a', ['a']), a.AssertionError); assert.throws(makeBlock(a.deepStrictEqual, 'a', {0: 'a'}), a.AssertionError); assert.throws(makeBlock(a.deepStrictEqual, 1, {}), a.AssertionError); assert.throws(makeBlock(a.deepStrictEqual, true, {}), a.AssertionError); assert.throws(makeBlock(assert.deepStrictEqual, Symbol(), {}), a.AssertionError); // primitive wrappers and object assert.throws(makeBlock(a.deepStrictEqual, new String('a'), ['a']), a.AssertionError); assert.throws(makeBlock(a.deepStrictEqual, new String('a'), {0: 'a'}), a.AssertionError); assert.throws(makeBlock(a.deepStrictEqual, new Number(1), {}), a.AssertionError); assert.throws(makeBlock(a.deepStrictEqual, new Boolean(true), {}), a.AssertionError); // Testing the throwing function thrower(errorConstructor) { throw new errorConstructor('test'); } // the basic calls work assert.throws(makeBlock(thrower, a.AssertionError), a.AssertionError, 'message'); assert.throws(makeBlock(thrower, a.AssertionError), a.AssertionError); assert.throws(makeBlock(thrower, a.AssertionError)); // if not passing an error, catch all. assert.throws(makeBlock(thrower, TypeError)); // when passing a type, only catch errors of the appropriate type var threw = false; try { a.throws(makeBlock(thrower, TypeError), a.AssertionError); } catch (e) { threw = true; assert.ok(e instanceof TypeError, 'type'); } assert.equal(true, threw, 'a.throws with an explicit error is eating extra errors', a.AssertionError); threw = false; // doesNotThrow should pass through all errors try { a.doesNotThrow(makeBlock(thrower, TypeError), a.AssertionError); } catch (e) { threw = true; assert.ok(e instanceof TypeError); } assert.equal(true, threw, 'a.doesNotThrow with an explicit error is eating extra errors'); // key difference is that throwing our correct error makes an assertion error try { a.doesNotThrow(makeBlock(thrower, TypeError), TypeError); } catch (e) { threw = true; assert.ok(e instanceof a.AssertionError); } assert.equal(true, threw, 'a.doesNotThrow is not catching type matching errors'); assert.throws(function() {assert.ifError(new Error('test error'));}); assert.doesNotThrow(function() {assert.ifError(null);}); assert.doesNotThrow(function() {assert.ifError();}); assert.throws(() => { assert.doesNotThrow(makeBlock(thrower, Error), 'user message'); }, /Got unwanted exception. user message/, 'a.doesNotThrow ignores user message'); // make sure that validating using constructor really works threw = false; try { assert.throws( function() { throw ({}); }, Array ); } catch (e) { threw = true; } assert.ok(threw, 'wrong constructor validation'); // use a RegExp to validate error message a.throws(makeBlock(thrower, TypeError), /test/); // use a fn to validate error object a.throws(makeBlock(thrower, TypeError), function(err) { if ((err instanceof TypeError) && /test/.test(err)) { return true; } }); // https://github.com/nodejs/node/issues/3188 threw = false; try { var ES6Error = class extends Error {}; var AnotherErrorType = class extends Error {}; const functionThatThrows = function() { throw new AnotherErrorType('foo'); }; assert.throws(functionThatThrows, ES6Error); } catch (e) { threw = true; assert(e instanceof AnotherErrorType, `expected AnotherErrorType, received ${e}`); } assert.ok(threw); // https://github.com/nodejs/node/issues/6416 // Make sure circular refs don't throw. { const b = {}; b.b = b; const c = {}; c.b = c; a.doesNotThrow(makeBlock(a.deepEqual, b, c)); a.doesNotThrow(makeBlock(a.deepStrictEqual, b, c)); const d = {}; d.a = 1; d.b = d; const e = {}; e.a = 1; e.b = e.a; a.throws(makeBlock(a.deepEqual, d, e), /AssertionError/); a.throws(makeBlock(a.deepStrictEqual, d, e), /AssertionError/); } // GH-7178. Ensure reflexivity of deepEqual with `arguments` objects. var args = (function() { return arguments; })(); a.throws(makeBlock(a.deepEqual, [], args)); a.throws(makeBlock(a.deepEqual, args, [])); // more checking that arguments objects are handled correctly { const returnArguments = function() { return arguments; }; const someArgs = returnArguments('a'); const sameArgs = returnArguments('a'); const diffArgs = returnArguments('b'); a.throws(makeBlock(a.deepEqual, someArgs, ['a'])); a.throws(makeBlock(a.deepEqual, ['a'], someArgs)); a.throws(makeBlock(a.deepEqual, someArgs, {'0': 'a'})); a.throws(makeBlock(a.deepEqual, someArgs, diffArgs)); a.doesNotThrow(makeBlock(a.deepEqual, someArgs, sameArgs)); } var circular = {y: 1}; circular.x = circular; function testAssertionMessage(actual, expected) { try { assert.equal(actual, ''); } catch (e) { assert.equal(e.toString(), ['AssertionError:', expected, '==', '\'\''].join(' ')); assert.ok(e.generatedMessage, 'Message not marked as generated'); } } testAssertionMessage(undefined, 'undefined'); testAssertionMessage(null, 'null'); testAssertionMessage(true, 'true'); testAssertionMessage(false, 'false'); testAssertionMessage(0, '0'); testAssertionMessage(100, '100'); testAssertionMessage(NaN, 'NaN'); testAssertionMessage(Infinity, 'Infinity'); testAssertionMessage(-Infinity, '-Infinity'); testAssertionMessage('', '""'); testAssertionMessage('foo', '\'foo\''); testAssertionMessage([], '[]'); testAssertionMessage([1, 2, 3], '[ 1, 2, 3 ]'); testAssertionMessage(/a/, '/a/'); testAssertionMessage(/abc/gim, '/abc/gim'); testAssertionMessage(function f() {}, '[Function: f]'); testAssertionMessage(function() {}, '[Function]'); testAssertionMessage({}, '{}'); testAssertionMessage(circular, '{ y: 1, x: [Circular] }'); testAssertionMessage({a: undefined, b: null}, '{ a: undefined, b: null }'); testAssertionMessage({a: NaN, b: Infinity, c: -Infinity}, '{ a: NaN, b: Infinity, c: -Infinity }'); // #2893 try { assert.throws(function() { assert.ifError(null); }); } catch (e) { threw = true; assert.equal(e.message, 'Missing expected exception..'); } assert.ok(threw); // #5292 try { assert.equal(1, 2); } catch (e) { assert.equal(e.toString().split('\n')[0], 'AssertionError: 1 == 2'); assert.ok(e.generatedMessage, 'Message not marked as generated'); } try { assert.equal(1, 2, 'oh no'); } catch (e) { assert.equal(e.toString().split('\n')[0], 'AssertionError: oh no'); assert.equal(e.generatedMessage, false, 'Message incorrectly marked as generated'); } // Verify that throws() and doesNotThrow() throw on non-function block function testBlockTypeError(method, block) { var threw = true; try { method(block); threw = false; } catch (e) { assert.equal(e.toString(), 'TypeError: block must be a function'); } assert.ok(threw); } testBlockTypeError(assert.throws, 'string'); testBlockTypeError(assert.doesNotThrow, 'string'); testBlockTypeError(assert.throws, 1); testBlockTypeError(assert.doesNotThrow, 1); testBlockTypeError(assert.throws, true); testBlockTypeError(assert.doesNotThrow, true); testBlockTypeError(assert.throws, false); testBlockTypeError(assert.doesNotThrow, false); testBlockTypeError(assert.throws, []); testBlockTypeError(assert.doesNotThrow, []); testBlockTypeError(assert.throws, {}); testBlockTypeError(assert.doesNotThrow, {}); testBlockTypeError(assert.throws, /foo/); testBlockTypeError(assert.doesNotThrow, /foo/); testBlockTypeError(assert.throws, null); testBlockTypeError(assert.doesNotThrow, null); testBlockTypeError(assert.throws, undefined); testBlockTypeError(assert.doesNotThrow, undefined); // https://github.com/nodejs/node/issues/3275 assert.throws(() => { throw 'error'; }, (err) => err === 'error'); assert.throws(() => { throw new Error(); }, (err) => err instanceof Error); // Long values should be truncated for display. assert.throws(() => { assert.strictEqual('A'.repeat(1000), ''); }, new RegExp(`^AssertionError: '${'A'.repeat(127)} === ''$`)); console.log('All OK'); node-v4.8.2/test/parallel/test-async-wrap-check-providers.js000644 000766 000024 00000005646 13070706736 024234 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const crypto = require('crypto'); const dgram = require('dgram'); const dns = require('dns'); const fs = require('fs'); const net = require('net'); const tls = require('tls'); const zlib = require('zlib'); const ChildProcess = require('child_process').ChildProcess; const StreamWrap = require('_stream_wrap').StreamWrap; const HTTPParser = process.binding('http_parser').HTTPParser; const async_wrap = process.binding('async_wrap'); const pkeys = Object.keys(async_wrap.Providers); let keyList = pkeys.slice(); // Drop NONE keyList.splice(0, 1); // fs-watch currently needs special configuration on AIX and we // want to improve under https://github.com/nodejs/node/issues/5085. // strip out fs watch related parts for now if (common.isAix) { for (var i = 0; i < keyList.length; i++) { if ((keyList[i] === 'FSEVENTWRAP') || (keyList[i] === 'STATWATCHER')) { keyList.splice(i, 1); } } } function init(id, provider) { keyList = keyList.filter((e) => e !== pkeys[provider]); } function noop() { } async_wrap.setupHooks({ init }); async_wrap.enable(); setTimeout(function() { }, 1); fs.stat(__filename, noop); if (!common.isAix) { // fs-watch currently needs special configuration on AIX and we // want to improve under https://github.com/nodejs/node/issues/5085. // strip out fs watch related parts for now fs.watchFile(__filename, noop); fs.unwatchFile(__filename); fs.watch(__filename).close(); } dns.lookup('localhost', noop); dns.lookupService('::', 0, noop); dns.resolve('localhost', noop); new StreamWrap(new net.Socket()); new (process.binding('tty_wrap').TTY)(); crypto.randomBytes(1, noop); common.refreshTmpDir(); net.createServer(function(c) { c.end(); this.close(); }).listen(common.PIPE, function() { net.connect(common.PIPE, noop); }); net.createServer(function(c) { c.end(); this.close(checkTLS); }).listen(0, function() { net.connect(this.address().port, noop); }); dgram.createSocket('udp4').bind(0, function() { this.send(new Buffer(2), 0, 2, this.address().port, '::', () => { this.close(); }); }); process.on('SIGINT', () => process.exit()); // Run from closed net server above. function checkTLS() { const options = { key: fs.readFileSync(common.fixturesDir + '/keys/ec-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/ec-cert.pem') }; const server = tls.createServer(options, noop) .listen(0, function() { const connectOpts = { rejectUnauthorized: false }; tls.connect(this.address().port, connectOpts, function() { this.destroy(); server.close(); }); }); } zlib.createGzip(); new ChildProcess(); new HTTPParser(HTTPParser.REQUEST); process.on('exit', function() { if (keyList.length !== 0) { process._rawDebug('Not all keys have been used:'); process._rawDebug(keyList); assert.strictEqual(keyList.length, 0); } }); node-v4.8.2/test/parallel/test-async-wrap-disabled-propagate-parent.js000644 000766 000024 00000002462 13070706736 026153 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const net = require('net'); const async_wrap = process.binding('async_wrap'); const providers = Object.keys(async_wrap.Providers); const uidSymbol = Symbol('uid'); let cntr = 0; let client; function init(uid, type, parentUid, parentHandle) { this[uidSymbol] = uid; if (parentHandle) { cntr++; // Cannot assert in init callback or will abort. process.nextTick(() => { assert.strictEqual(providers[type], 'TCPWRAP'); assert.strictEqual(parentUid, server._handle[uidSymbol], 'server uid doesn\'t match parent uid'); assert.strictEqual(parentHandle, server._handle, 'server handle doesn\'t match parent handle'); assert.strictEqual(this, client._handle, 'client doesn\'t match context'); }); } } function noop() { } async_wrap.setupHooks({ init }); async_wrap.enable(); const server = net.createServer(function(c) { client = c; // Allow init callback to run before closing. setImmediate(() => { c.end(); this.close(); }); }).listen(0, function() { net.connect(this.address().port, noop); }); async_wrap.disable(); process.on('exit', function() { // init should have only been called once with a parent. assert.strictEqual(cntr, 1); }); node-v4.8.2/test/parallel/test-async-wrap-post-did-throw.js000644 000766 000024 00000001550 13070706736 024016 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const async_wrap = process.binding('async_wrap'); var asyncThrows = 0; var uncaughtExceptionCount = 0; process.on('uncaughtException', (e) => { assert.equal(e.message, 'oh noes!', 'error messages do not match'); }); process.on('exit', () => { process.removeAllListeners('uncaughtException'); assert.equal(uncaughtExceptionCount, 1); assert.equal(uncaughtExceptionCount, asyncThrows); }); function init() { } function post(id, threw) { if (threw) uncaughtExceptionCount++; } async_wrap.setupHooks({ init, post }); async_wrap.enable(); // Timers still aren't supported, so use crypto API. // It's also important that the callback not happen in a nextTick, like many // error events in core. require('crypto').randomBytes(0, () => { asyncThrows++; throw new Error('oh noes!'); }); node-v4.8.2/test/parallel/test-async-wrap-propagate-parent.js000644 000766 000024 00000002434 13070706736 024405 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const net = require('net'); const async_wrap = process.binding('async_wrap'); const providers = Object.keys(async_wrap.Providers); const uidSymbol = Symbol('uid'); let cntr = 0; let client; function init(uid, type, parentUid, parentHandle) { this[uidSymbol] = uid; if (parentHandle) { cntr++; // Cannot assert in init callback or will abort. process.nextTick(() => { assert.strictEqual(providers[type], 'TCPWRAP'); assert.strictEqual(parentUid, server._handle[uidSymbol], 'server uid doesn\'t match parent uid'); assert.strictEqual(parentHandle, server._handle, 'server handle doesn\'t match parent handle'); assert.strictEqual(this, client._handle, 'client doesn\'t match context'); }); } } function noop() { } async_wrap.setupHooks({ init }); async_wrap.enable(); const server = net.createServer(function(c) { client = c; // Allow init callback to run before closing. setImmediate(() => { c.end(); this.close(); }); }).listen(0, function() { net.connect(this.address().port, noop); }); process.on('exit', function() { // init should have only been called once with a parent. assert.strictEqual(cntr, 1); }); node-v4.8.2/test/parallel/test-async-wrap-throw-from-callback.js000644 000766 000024 00000002771 13070706736 024776 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const async_wrap = process.binding('async_wrap'); const assert = require('assert'); const crypto = require('crypto'); const domain = require('domain'); const spawn = require('child_process').spawn; const callbacks = [ 'init', 'pre', 'post' ]; const toCall = process.argv[2]; var msgCalled = 0; var msgReceived = 0; function init() { if (toCall === 'init') throw new Error('init'); } function pre() { if (toCall === 'pre') throw new Error('pre'); } function post() { if (toCall === 'post') throw new Error('post'); } if (typeof process.argv[2] === 'string') { async_wrap.setupHooks({ init, pre, post }); async_wrap.enable(); process.on('uncaughtException', () => assert.ok(0, 'UNREACHABLE')); const d = domain.create(); d.on('error', () => assert.ok(0, 'UNREACHABLE')); d.run(() => { // Using randomBytes because timers are not yet supported. crypto.randomBytes(0, () => { }); }); } else { process.on('exit', (code) => { assert.strictEqual(msgCalled, callbacks.length); assert.strictEqual(msgCalled, msgReceived); }); callbacks.forEach((item) => { msgCalled++; const child = spawn(process.execPath, [__filename, item]); var errstring = ''; child.stderr.on('data', (data) => { errstring += data.toString(); }); child.on('close', (code) => { if (errstring.includes('Error: ' + item)) msgReceived++; assert.strictEqual(code, 1, `${item} closed with code ${code}`); }); }); } node-v4.8.2/test/parallel/test-async-wrap-throw-no-init.js000644 000766 000024 00000001151 13070706736 023645 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const async_wrap = process.binding('async_wrap'); assert.throws(function() { async_wrap.setupHooks(null); }, /first argument must be an object/); assert.throws(function() { async_wrap.setupHooks({}); }, /init callback must be a function/); assert.throws(function() { async_wrap.enable(); }, /init callback is not assigned to a function/); // Should not throw async_wrap.setupHooks({ init: () => {} }); async_wrap.enable(); assert.throws(function() { async_wrap.setupHooks(() => {}); }, /hooks should not be set while also enabled/); node-v4.8.2/test/parallel/test-async-wrap-uid.js000644 000766 000024 00000001623 13070706736 021714 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const fs = require('fs'); const assert = require('assert'); const async_wrap = process.binding('async_wrap'); const storage = new Map(); async_wrap.setupHooks({ init, pre, post }); async_wrap.enable(); function init(uid) { storage.set(uid, { init: true, pre: false, post: false, }); } function pre(uid) { storage.get(uid).pre = true; } function post(uid) { storage.get(uid).post = true; } fs.access(__filename, function(err) { assert.ifError(err); }); fs.access(__filename, function(err) { assert.ifError(err); }); async_wrap.disable(); process.once('exit', function() { assert.strictEqual(storage.size, 2); for (const item of storage) { const uid = item[0]; const value = item[1]; assert.strictEqual(typeof uid, 'number'); assert.deepStrictEqual(value, { init: true, pre: true, post: true, }); } }); node-v4.8.2/test/parallel/test-bad-unicode.js000644 000766 000024 00000000304 13070706736 021216 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); let exception = null; try { eval('"\\uc/ef"'); } catch (e) { exception = e; } assert(exception instanceof SyntaxError); node-v4.8.2/test/parallel/test-beforeexit-event-exit.js000644 000766 000024 00000000270 13070706736 023270 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); process.on('beforeExit', function() { assert(false, 'exit should not allow this to occur'); }); process.exit(); node-v4.8.2/test/parallel/test-beforeexit-event.js000644 000766 000024 00000001135 13070706736 022322 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const net = require('net'); process.once('beforeExit', common.mustCall(tryImmediate)); function tryImmediate() { setImmediate(common.mustCall(() => { process.once('beforeExit', common.mustCall(tryTimer)); })); } function tryTimer() { setTimeout(common.mustCall(() => { process.once('beforeExit', common.mustCall(tryListen)); }), 1); } function tryListen() { net.createServer() .listen(0) .on('listening', common.mustCall(function() { this.close(); process.on('beforeExit', common.mustCall(() => {})); })); } node-v4.8.2/test/parallel/test-buffer-alloc.js000644 000766 000024 00000131310 13070706736 021407 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var Buffer = require('buffer').Buffer; var SlowBuffer = require('buffer').SlowBuffer; // counter to ensure unique value is always copied var cntr = 0; var b = Buffer.alloc(1024); console.log('b.length == %d', b.length); assert.strictEqual(1024, b.length); b[0] = -1; assert.strictEqual(b[0], 255); for (let i = 0; i < 1024; i++) { b[i] = i % 256; } for (let i = 0; i < 1024; i++) { assert.strictEqual(i % 256, b[i]); } var c = Buffer.alloc(512); console.log('c.length == %d', c.length); assert.strictEqual(512, c.length); var d = Buffer.from([]); assert.strictEqual(0, d.length); var ui32 = new Uint32Array(4).fill(42); var e = Buffer.from(ui32); assert.deepEqual(ui32, e); // First check Buffer#fill() works as expected. assert.throws(function() { Buffer.allocUnsafe(8).fill('a', -1); }); assert.throws(function() { Buffer.allocUnsafe(8).fill('a', 0, 9); }); // Make sure this doesn't hang indefinitely. Buffer.allocUnsafe(8).fill(''); { const buf = Buffer.allocUnsafe(64); buf.fill(10); for (let i = 0; i < buf.length; i++) assert.equal(buf[i], 10); buf.fill(11, 0, buf.length >> 1); for (let i = 0; i < buf.length >> 1; i++) assert.equal(buf[i], 11); for (let i = (buf.length >> 1) + 1; i < buf.length; i++) assert.equal(buf[i], 10); buf.fill('h'); for (let i = 0; i < buf.length; i++) assert.equal('h'.charCodeAt(0), buf[i]); buf.fill(0); for (let i = 0; i < buf.length; i++) assert.equal(0, buf[i]); buf.fill(null); for (let i = 0; i < buf.length; i++) assert.equal(0, buf[i]); buf.fill(1, 16, 32); for (let i = 0; i < 16; i++) assert.equal(0, buf[i]); for (let i = 16; i < 32; i++) assert.equal(1, buf[i]); for (let i = 32; i < buf.length; i++) assert.equal(0, buf[i]); } { const buf = Buffer.allocUnsafe(10); buf.fill('abc'); assert.equal(buf.toString(), 'abcabcabca'); buf.fill('է'); assert.equal(buf.toString(), 'էէէէէ'); } { // copy 512 bytes, from 0 to 512. b.fill(++cntr); c.fill(++cntr); const copied = b.copy(c, 0, 0, 512); console.log('copied %d bytes from b into c', copied); assert.strictEqual(512, copied); for (let i = 0; i < c.length; i++) { assert.strictEqual(b[i], c[i]); } } { // copy c into b, without specifying sourceEnd b.fill(++cntr); c.fill(++cntr); const copied = c.copy(b, 0, 0); console.log('copied %d bytes from c into b w/o sourceEnd', copied); assert.strictEqual(c.length, copied); for (let i = 0; i < c.length; i++) { assert.strictEqual(c[i], b[i]); } } { // copy c into b, without specifying sourceStart b.fill(++cntr); c.fill(++cntr); const copied = c.copy(b, 0); console.log('copied %d bytes from c into b w/o sourceStart', copied); assert.strictEqual(c.length, copied); for (let i = 0; i < c.length; i++) { assert.strictEqual(c[i], b[i]); } } { // copy longer buffer b to shorter c without targetStart b.fill(++cntr); c.fill(++cntr); const copied = b.copy(c); console.log('copied %d bytes from b into c w/o targetStart', copied); assert.strictEqual(c.length, copied); for (let i = 0; i < c.length; i++) { assert.strictEqual(b[i], c[i]); } } { // copy starting near end of b to c b.fill(++cntr); c.fill(++cntr); const copied = b.copy(c, 0, b.length - Math.floor(c.length / 2)); console.log('copied %d bytes from end of b into beginning of c', copied); assert.strictEqual(Math.floor(c.length / 2), copied); for (let i = 0; i < Math.floor(c.length / 2); i++) { assert.strictEqual(b[b.length - Math.floor(c.length / 2) + i], c[i]); } for (let i = Math.floor(c.length / 2) + 1; i < c.length; i++) { assert.strictEqual(c[c.length - 1], c[i]); } } { // try to copy 513 bytes, and check we don't overrun c b.fill(++cntr); c.fill(++cntr); const copied = b.copy(c, 0, 0, 513); console.log('copied %d bytes from b trying to overrun c', copied); assert.strictEqual(c.length, copied); for (let i = 0; i < c.length; i++) { assert.strictEqual(b[i], c[i]); } } { // copy 768 bytes from b into b b.fill(++cntr); b.fill(++cntr, 256); const copied = b.copy(b, 0, 256, 1024); console.log('copied %d bytes from b into b', copied); assert.strictEqual(768, copied); for (let i = 0; i < b.length; i++) { assert.strictEqual(cntr, b[i]); } } // copy string longer than buffer length (failure will segfault) var bb = Buffer.allocUnsafe(10); bb.fill('hello crazy world'); // try to copy from before the beginning of b assert.doesNotThrow(() => { b.copy(c, 0, 100, 10); }); // copy throws at negative sourceStart assert.throws(function() { Buffer.allocUnsafe(5).copy(Buffer.allocUnsafe(5), 0, -1); }, RangeError); { // check sourceEnd resets to targetEnd if former is greater than the latter b.fill(++cntr); c.fill(++cntr); const copied = b.copy(c, 0, 0, 1025); console.log('copied %d bytes from b into c', copied); for (let i = 0; i < c.length; i++) { assert.strictEqual(b[i], c[i]); } } // throw with negative sourceEnd console.log('test copy at negative sourceEnd'); assert.throws(function() { b.copy(c, 0, 0, -1); }, RangeError); // when sourceStart is greater than sourceEnd, zero copied assert.equal(b.copy(c, 0, 100, 10), 0); // when targetStart > targetLength, zero copied assert.equal(b.copy(c, 512, 0, 10), 0); var caught_error; // invalid encoding for Buffer.toString caught_error = null; try { b.toString('invalid'); } catch (err) { caught_error = err; } assert.strictEqual('Unknown encoding: invalid', caught_error.message); // invalid encoding for Buffer.write caught_error = null; try { b.write('test string', 0, 5, 'invalid'); } catch (err) { caught_error = err; } assert.strictEqual('Unknown encoding: invalid', caught_error.message); // try to create 0-length buffers Buffer.from(''); Buffer.from('', 'ascii'); Buffer.from('', 'binary'); Buffer.alloc(0); // try to write a 0-length string beyond the end of b assert.throws(function() { b.write('', 2048); }, RangeError); // throw when writing to negative offset assert.throws(function() { b.write('a', -1); }, RangeError); // throw when writing past bounds from the pool assert.throws(function() { b.write('a', 2048); }, RangeError); // throw when writing to negative offset assert.throws(function() { b.write('a', -1); }, RangeError); // try to copy 0 bytes worth of data into an empty buffer b.copy(Buffer.alloc(0), 0, 0, 0); // try to copy 0 bytes past the end of the target buffer b.copy(Buffer.alloc(0), 1, 1, 1); b.copy(Buffer.allocUnsafe(1), 1, 1, 1); // try to copy 0 bytes from past the end of the source buffer b.copy(Buffer.allocUnsafe(1), 0, 2048, 2048); const rangeBuffer = Buffer.from('abc'); // if start >= buffer's length, empty string will be returned assert.equal(rangeBuffer.toString('ascii', 3), ''); //assert.equal(rangeBuffer.toString('ascii', +Infinity), ''); // fails on 4.x assert.equal(rangeBuffer.toString('ascii', 3.14, 3), ''); //assert.equal(rangeBuffer.toString('ascii', 'Infinity', 3), '');// fails on 4.x // if end <= 0, empty string will be returned assert.equal(rangeBuffer.toString('ascii', 1, 0), ''); //assert.equal(rangeBuffer.toString('ascii', 1, -1.2), ''); // fails on 4.x //assert.equal(rangeBuffer.toString('ascii', 1, -100), ''); // fails on 4.x assert.equal(rangeBuffer.toString('ascii', 1, -Infinity), ''); // if start < 0, start will be taken as zero //assert.equal(rangeBuffer.toString('ascii', -1, 3), 'abc'); // fails on 4.x //assert.equal(rangeBuffer.toString('ascii', -1.99, 3), 'abc'); // fails on 4.x assert.equal(rangeBuffer.toString('ascii', -Infinity, 3), 'abc'); //assert.equal(rangeBuffer.toString('ascii', '-1', 3), 'abc'); // fails on 4.x //assert.equal(rangeBuffer.toString('ascii', '-1.99', 3), 'abc');// fails on 4.x assert.equal(rangeBuffer.toString('ascii', '-Infinity', 3), 'abc'); // if start is an invalid integer, start will be taken as zero assert.equal(rangeBuffer.toString('ascii', 'node.js', 3), 'abc'); assert.equal(rangeBuffer.toString('ascii', {}, 3), 'abc'); assert.equal(rangeBuffer.toString('ascii', [], 3), 'abc'); assert.equal(rangeBuffer.toString('ascii', NaN, 3), 'abc'); assert.equal(rangeBuffer.toString('ascii', null, 3), 'abc'); assert.equal(rangeBuffer.toString('ascii', undefined, 3), 'abc'); assert.equal(rangeBuffer.toString('ascii', false, 3), 'abc'); assert.equal(rangeBuffer.toString('ascii', '', 3), 'abc'); // but, if start is an integer when coerced, then it will be coerced and used. //assert.equal(rangeBuffer.toString('ascii', '-1', 3), 'abc'); // fails on 4.x assert.equal(rangeBuffer.toString('ascii', '1', 3), 'bc'); assert.equal(rangeBuffer.toString('ascii', '-Infinity', 3), 'abc'); assert.equal(rangeBuffer.toString('ascii', '3', 3), ''); assert.equal(rangeBuffer.toString('ascii', Number(3), 3), ''); assert.equal(rangeBuffer.toString('ascii', '3.14', 3), ''); assert.equal(rangeBuffer.toString('ascii', '1.99', 3), 'bc'); //assert.equal(rangeBuffer.toString('ascii', '-1.99', 3), 'abc');// fails on 4.x assert.equal(rangeBuffer.toString('ascii', 1.99, 3), 'bc'); assert.equal(rangeBuffer.toString('ascii', true, 3), 'bc'); // if end > buffer's length, end will be taken as buffer's length assert.equal(rangeBuffer.toString('ascii', 0, 5), 'abc'); assert.equal(rangeBuffer.toString('ascii', 0, 6.99), 'abc'); assert.equal(rangeBuffer.toString('ascii', 0, Infinity), 'abc'); assert.equal(rangeBuffer.toString('ascii', 0, '5'), 'abc'); assert.equal(rangeBuffer.toString('ascii', 0, '6.99'), 'abc'); // fails on v4.x //assert.equal(rangeBuffer.toString('ascii', 0, 'Infinity'), 'abc'); // if end is an invalid integer, end will be taken as buffer's length assert.equal(rangeBuffer.toString('ascii', 0, 'node.js'), ''); assert.equal(rangeBuffer.toString('ascii', 0, {}), ''); assert.equal(rangeBuffer.toString('ascii', 0, NaN), ''); assert.equal(rangeBuffer.toString('ascii', 0, undefined), 'abc'); assert.equal(rangeBuffer.toString('ascii', 0), 'abc'); assert.equal(rangeBuffer.toString('ascii', 0, null), ''); assert.equal(rangeBuffer.toString('ascii', 0, []), ''); assert.equal(rangeBuffer.toString('ascii', 0, false), ''); assert.equal(rangeBuffer.toString('ascii', 0, ''), ''); // but, if end is an integer when coerced, then it will be coerced and used. //assert.equal(rangeBuffer.toString('ascii', 0, '-1'), ''); // fails on 4.x assert.equal(rangeBuffer.toString('ascii', 0, '1'), 'a'); assert.equal(rangeBuffer.toString('ascii', 0, '-Infinity'), ''); assert.equal(rangeBuffer.toString('ascii', 0, '3'), 'abc'); assert.equal(rangeBuffer.toString('ascii', 0, Number(3)), 'abc'); assert.equal(rangeBuffer.toString('ascii', 0, '3.14'), 'abc'); assert.equal(rangeBuffer.toString('ascii', 0, '1.99'), 'a'); //assert.equal(rangeBuffer.toString('ascii', 0, '-1.99'), ''); // fails on 4.x assert.equal(rangeBuffer.toString('ascii', 0, 1.99), 'a'); assert.equal(rangeBuffer.toString('ascii', 0, true), 'a'); // try toString() with a object as a encoding assert.equal(rangeBuffer.toString({toString: function() { return 'ascii'; }}), 'abc'); // testing for smart defaults and ability to pass string values as offset var writeTest = Buffer.from('abcdes'); writeTest.write('n', 'ascii'); writeTest.write('o', 'ascii', '1'); writeTest.write('d', '2', 'ascii'); writeTest.write('e', 3, 'ascii'); writeTest.write('j', 'ascii', 4); assert.equal(writeTest.toString(), 'nodejs'); // ASCII slice test { const asciiString = 'hello world'; for (let i = 0; i < asciiString.length; i++) { b[i] = asciiString.charCodeAt(i); } const asciiSlice = b.toString('ascii', 0, asciiString.length); assert.equal(asciiString, asciiSlice); } { const asciiString = 'hello world'; const offset = 100; const written = b.write(asciiString, offset, 'ascii'); assert.equal(asciiString.length, written); const asciiSlice = b.toString('ascii', offset, offset + asciiString.length); assert.equal(asciiString, asciiSlice); } { const asciiString = 'hello world'; const offset = 100; const sliceA = b.slice(offset, offset + asciiString.length); const sliceB = b.slice(offset, offset + asciiString.length); for (let i = 0; i < asciiString.length; i++) { assert.equal(sliceA[i], sliceB[i]); } } // UTF-8 slice test var utf8String = '¡hέlló wôrld!'; var offset = 100; b.write(utf8String, 0, Buffer.byteLength(utf8String), 'utf8'); var utf8Slice = b.toString('utf8', 0, Buffer.byteLength(utf8String)); assert.equal(utf8String, utf8Slice); var written = b.write(utf8String, offset, 'utf8'); assert.equal(Buffer.byteLength(utf8String), written); utf8Slice = b.toString('utf8', offset, offset + Buffer.byteLength(utf8String)); assert.equal(utf8String, utf8Slice); var sliceA = b.slice(offset, offset + Buffer.byteLength(utf8String)); var sliceB = b.slice(offset, offset + Buffer.byteLength(utf8String)); for (let i = 0; i < Buffer.byteLength(utf8String); i++) { assert.equal(sliceA[i], sliceB[i]); } { const slice = b.slice(100, 150); assert.equal(50, slice.length); for (let i = 0; i < 50; i++) { assert.equal(b[100 + i], slice[i]); } } { // make sure only top level parent propagates from allocPool const b = Buffer.allocUnsafe(5); const c = b.slice(0, 4); const d = c.slice(0, 2); assert.equal(b.parent, c.parent); assert.equal(b.parent, d.parent); } { // also from a non-pooled instance const b = new SlowBuffer(5); const c = b.slice(0, 4); const d = c.slice(0, 2); assert.equal(c.parent, d.parent); } { // Bug regression test const testValue = '\u00F6\u65E5\u672C\u8A9E'; // ö日本語 const buffer = Buffer.allocUnsafe(32); const size = buffer.write(testValue, 0, 'utf8'); console.log('bytes written to buffer: ' + size); const slice = buffer.toString('utf8', 0, size); assert.equal(slice, testValue); } { // Test triple slice const a = Buffer.allocUnsafe(8); for (let i = 0; i < 8; i++) a[i] = i; const b = a.slice(4, 8); assert.equal(4, b[0]); assert.equal(5, b[1]); assert.equal(6, b[2]); assert.equal(7, b[3]); const c = b.slice(2, 4); assert.equal(6, c[0]); assert.equal(7, c[1]); } { const d = Buffer.from([23, 42, 255]); assert.equal(d.length, 3); assert.equal(d[0], 23); assert.equal(d[1], 42); assert.equal(d[2], 255); assert.deepEqual(d, Buffer.from(d)); } { const e = Buffer.from('über'); console.error('uber: \'%s\'', e.toString()); assert.deepEqual(e, Buffer.from([195, 188, 98, 101, 114])); } { const f = Buffer.from('über', 'ascii'); console.error('f.length: %d (should be 4)', f.length); assert.deepEqual(f, Buffer.from([252, 98, 101, 114])); } ['ucs2', 'ucs-2', 'utf16le', 'utf-16le'].forEach(function(encoding) { { const f = Buffer.from('über', encoding); console.error('f.length: %d (should be 8)', f.length); assert.deepEqual(f, Buffer.from([252, 0, 98, 0, 101, 0, 114, 0])); } { const f = Buffer.from('привет', encoding); console.error('f.length: %d (should be 12)', f.length); assert.deepEqual(f, Buffer.from([63, 4, 64, 4, 56, 4, 50, 4, 53, 4, 66, 4])); assert.equal(f.toString(encoding), 'привет'); } { const f = Buffer.from([0, 0, 0, 0, 0]); assert.equal(f.length, 5); const size = f.write('あいうえお', encoding); console.error('bytes written to buffer: %d (should be 4)', size); assert.equal(size, 4); assert.deepEqual(f, Buffer.from([0x42, 0x30, 0x44, 0x30, 0x00])); } }); { const f = Buffer.from('\uD83D\uDC4D', 'utf-16le'); // THUMBS UP SIGN (U+1F44D) assert.equal(f.length, 4); assert.deepEqual(f, Buffer.from('3DD84DDC', 'hex')); } var arrayIsh = {0: 0, 1: 1, 2: 2, 3: 3, length: 4}; var g = Buffer.from(arrayIsh); assert.deepEqual(g, Buffer.from([0, 1, 2, 3])); var strArrayIsh = {0: '0', 1: '1', 2: '2', 3: '3', length: 4}; g = Buffer.from(strArrayIsh); assert.deepEqual(g, Buffer.from([0, 1, 2, 3])); // // Test toString('base64') // assert.equal('TWFu', (Buffer.from('Man')).toString('base64')); { // test that regular and URL-safe base64 both work const expected = [0xff, 0xff, 0xbe, 0xff, 0xef, 0xbf, 0xfb, 0xef, 0xff]; assert.deepEqual(Buffer.from('//++/++/++//', 'base64'), Buffer.from(expected)); assert.deepEqual(Buffer.from('__--_--_--__', 'base64'), Buffer.from(expected)); } { // big example const quote = 'Man is distinguished, not only by his reason, but by this ' + 'singular passion from other animals, which is a lust ' + 'of the mind, that by a perseverance of delight in the ' + 'continued and indefatigable generation of knowledge, ' + 'exceeds the short vehemence of any carnal pleasure.'; const expected = 'TWFuIGlzIGRpc3Rpbmd1aXNoZWQsIG5vdCBvbmx5IGJ5IGhpcyByZWFzb' + '24sIGJ1dCBieSB0aGlzIHNpbmd1bGFyIHBhc3Npb24gZnJvbSBvdGhlci' + 'BhbmltYWxzLCB3aGljaCBpcyBhIGx1c3Qgb2YgdGhlIG1pbmQsIHRoYXQ' + 'gYnkgYSBwZXJzZXZlcmFuY2Ugb2YgZGVsaWdodCBpbiB0aGUgY29udGlu' + 'dWVkIGFuZCBpbmRlZmF0aWdhYmxlIGdlbmVyYXRpb24gb2Yga25vd2xlZ' + 'GdlLCBleGNlZWRzIHRoZSBzaG9ydCB2ZWhlbWVuY2Ugb2YgYW55IGNhcm' + '5hbCBwbGVhc3VyZS4='; assert.equal(expected, (Buffer.from(quote)).toString('base64')); let b = Buffer.allocUnsafe(1024); let bytesWritten = b.write(expected, 0, 'base64'); assert.equal(quote.length, bytesWritten); assert.equal(quote, b.toString('ascii', 0, quote.length)); // check that the base64 decoder ignores whitespace const expectedWhite = expected.slice(0, 60) + ' \n' + expected.slice(60, 120) + ' \n' + expected.slice(120, 180) + ' \n' + expected.slice(180, 240) + ' \n' + expected.slice(240, 300) + '\n' + expected.slice(300, 360) + '\n'; b = Buffer.allocUnsafe(1024); bytesWritten = b.write(expectedWhite, 0, 'base64'); assert.equal(quote.length, bytesWritten); assert.equal(quote, b.toString('ascii', 0, quote.length)); // check that the base64 decoder on the constructor works // even in the presence of whitespace. b = Buffer.from(expectedWhite, 'base64'); assert.equal(quote.length, b.length); assert.equal(quote, b.toString('ascii', 0, quote.length)); // check that the base64 decoder ignores illegal chars const expectedIllegal = expected.slice(0, 60) + ' \x80' + expected.slice(60, 120) + ' \xff' + expected.slice(120, 180) + ' \x00' + expected.slice(180, 240) + ' \x98' + expected.slice(240, 300) + '\x03' + expected.slice(300, 360); b = Buffer.from(expectedIllegal, 'base64'); assert.equal(quote.length, b.length); assert.equal(quote, b.toString('ascii', 0, quote.length)); } assert.equal(Buffer.from('', 'base64').toString(), ''); assert.equal(Buffer.from('K', 'base64').toString(), ''); // multiple-of-4 with padding assert.equal(Buffer.from('Kg==', 'base64').toString(), '*'); assert.equal(Buffer.from('Kio=', 'base64').toString(), '**'); assert.equal(Buffer.from('Kioq', 'base64').toString(), '***'); assert.equal(Buffer.from('KioqKg==', 'base64').toString(), '****'); assert.equal(Buffer.from('KioqKio=', 'base64').toString(), '*****'); assert.equal(Buffer.from('KioqKioq', 'base64').toString(), '******'); assert.equal(Buffer.from('KioqKioqKg==', 'base64').toString(), '*******'); assert.equal(Buffer.from('KioqKioqKio=', 'base64').toString(), '********'); assert.equal(Buffer.from('KioqKioqKioq', 'base64').toString(), '*********'); assert.equal(Buffer.from('KioqKioqKioqKg==', 'base64').toString(), '**********'); assert.equal(Buffer.from('KioqKioqKioqKio=', 'base64').toString(), '***********'); assert.equal(Buffer.from('KioqKioqKioqKioq', 'base64').toString(), '************'); assert.equal(Buffer.from('KioqKioqKioqKioqKg==', 'base64').toString(), '*************'); assert.equal(Buffer.from('KioqKioqKioqKioqKio=', 'base64').toString(), '**************'); assert.equal(Buffer.from('KioqKioqKioqKioqKioq', 'base64').toString(), '***************'); assert.equal(Buffer.from('KioqKioqKioqKioqKioqKg==', 'base64').toString(), '****************'); assert.equal(Buffer.from('KioqKioqKioqKioqKioqKio=', 'base64').toString(), '*****************'); assert.equal(Buffer.from('KioqKioqKioqKioqKioqKioq', 'base64').toString(), '******************'); assert.equal(Buffer.from('KioqKioqKioqKioqKioqKioqKg==', 'base64').toString(), '*******************'); assert.equal(Buffer.from('KioqKioqKioqKioqKioqKioqKio=', 'base64').toString(), '********************'); // no padding, not a multiple of 4 assert.equal(Buffer.from('Kg', 'base64').toString(), '*'); assert.equal(Buffer.from('Kio', 'base64').toString(), '**'); assert.equal(Buffer.from('KioqKg', 'base64').toString(), '****'); assert.equal(Buffer.from('KioqKio', 'base64').toString(), '*****'); assert.equal(Buffer.from('KioqKioqKg', 'base64').toString(), '*******'); assert.equal(Buffer.from('KioqKioqKio', 'base64').toString(), '********'); assert.equal(Buffer.from('KioqKioqKioqKg', 'base64').toString(), '**********'); assert.equal(Buffer.from('KioqKioqKioqKio', 'base64').toString(), '***********'); assert.equal(Buffer.from('KioqKioqKioqKioqKg', 'base64').toString(), '*************'); assert.equal(Buffer.from('KioqKioqKioqKioqKio', 'base64').toString(), '**************'); assert.equal(Buffer.from('KioqKioqKioqKioqKioqKg', 'base64').toString(), '****************'); assert.equal(Buffer.from('KioqKioqKioqKioqKioqKio', 'base64').toString(), '*****************'); assert.equal(Buffer.from('KioqKioqKioqKioqKioqKioqKg', 'base64').toString(), '*******************'); assert.equal(Buffer.from('KioqKioqKioqKioqKioqKioqKio', 'base64').toString(), '********************'); // handle padding graciously, multiple-of-4 or not assert.equal( Buffer.from('72INjkR5fchcxk9+VgdGPFJDxUBFR5/rMFsghgxADiw==', 'base64').length, 32 ); assert.equal( Buffer.from('72INjkR5fchcxk9+VgdGPFJDxUBFR5/rMFsghgxADiw=', 'base64').length, 32 ); assert.equal( Buffer.from('72INjkR5fchcxk9+VgdGPFJDxUBFR5/rMFsghgxADiw', 'base64').length, 32 ); assert.equal( Buffer.from('w69jACy6BgZmaFvv96HG6MYksWytuZu3T1FvGnulPg==', 'base64').length, 31 ); assert.equal( Buffer.from('w69jACy6BgZmaFvv96HG6MYksWytuZu3T1FvGnulPg=', 'base64').length, 31 ); assert.equal( Buffer.from('w69jACy6BgZmaFvv96HG6MYksWytuZu3T1FvGnulPg', 'base64').length, 31 ); // This string encodes single '.' character in UTF-16 var dot = Buffer.from('//4uAA==', 'base64'); assert.equal(dot[0], 0xff); assert.equal(dot[1], 0xfe); assert.equal(dot[2], 0x2e); assert.equal(dot[3], 0x00); assert.equal(dot.toString('base64'), '//4uAA=='); { // Writing base64 at a position > 0 should not mangle the result. // // https://github.com/joyent/node/issues/402 const segments = ['TWFkbmVzcz8h', 'IFRoaXM=', 'IGlz', 'IG5vZGUuanMh']; const b = Buffer.allocUnsafe(64); let pos = 0; for (let i = 0; i < segments.length; ++i) { pos += b.write(segments[i], pos, 'base64'); } assert.equal(b.toString('binary', 0, pos), 'Madness?! This is node.js!'); } // Regression test for https://github.com/nodejs/node/issues/3496. assert.equal(Buffer.from('=bad'.repeat(1e4), 'base64').length, 0); { // Creating buffers larger than pool size. const l = Buffer.poolSize + 5; let s = ''; for (let i = 0; i < l; i++) { s += 'h'; } const b = Buffer.from(s); for (let i = 0; i < l; i++) { assert.equal('h'.charCodeAt(0), b[i]); } const sb = b.toString(); assert.equal(sb.length, s.length); assert.equal(sb, s); } { // Single argument slice const b = Buffer.from('abcde'); assert.equal('bcde', b.slice(1).toString()); } // slice(0,0).length === 0 assert.equal(0, Buffer.from('hello').slice(0, 0).length); // test hex toString console.log('Create hex string from buffer'); var hexb = Buffer.allocUnsafe(256); for (let i = 0; i < 256; i++) { hexb[i] = i; } var hexStr = hexb.toString('hex'); assert.equal(hexStr, '000102030405060708090a0b0c0d0e0f' + '101112131415161718191a1b1c1d1e1f' + '202122232425262728292a2b2c2d2e2f' + '303132333435363738393a3b3c3d3e3f' + '404142434445464748494a4b4c4d4e4f' + '505152535455565758595a5b5c5d5e5f' + '606162636465666768696a6b6c6d6e6f' + '707172737475767778797a7b7c7d7e7f' + '808182838485868788898a8b8c8d8e8f' + '909192939495969798999a9b9c9d9e9f' + 'a0a1a2a3a4a5a6a7a8a9aaabacadaeaf' + 'b0b1b2b3b4b5b6b7b8b9babbbcbdbebf' + 'c0c1c2c3c4c5c6c7c8c9cacbcccdcecf' + 'd0d1d2d3d4d5d6d7d8d9dadbdcdddedf' + 'e0e1e2e3e4e5e6e7e8e9eaebecedeeef' + 'f0f1f2f3f4f5f6f7f8f9fafbfcfdfeff'); console.log('Create buffer from hex string'); var hexb2 = Buffer.from(hexStr, 'hex'); for (let i = 0; i < 256; i++) { assert.equal(hexb2[i], hexb[i]); } { // test an invalid slice end. console.log('Try to slice off the end of the buffer'); const b = Buffer.from([1, 2, 3, 4, 5]); const b2 = b.toString('hex', 1, 10000); const b3 = b.toString('hex', 1, 5); const b4 = b.toString('hex', 1); assert.equal(b2, b3); assert.equal(b2, b4); } function buildBuffer(data) { if (Array.isArray(data)) { var buffer = Buffer.allocUnsafe(data.length); data.forEach(function(v, k) { buffer[k] = v; }); return buffer; } return null; } var x = buildBuffer([0x81, 0xa3, 0x66, 0x6f, 0x6f, 0xa3, 0x62, 0x61, 0x72]); console.log(x.inspect()); assert.equal('', x.inspect()); { const z = x.slice(4); console.log(z.inspect()); console.log(z.length); assert.equal(5, z.length); assert.equal(0x6f, z[0]); assert.equal(0xa3, z[1]); assert.equal(0x62, z[2]); assert.equal(0x61, z[3]); assert.equal(0x72, z[4]); } { const z = x.slice(0); console.log(z.inspect()); console.log(z.length); assert.equal(z.length, x.length); } { const z = x.slice(0, 4); console.log(z.inspect()); console.log(z.length); assert.equal(4, z.length); assert.equal(0x81, z[0]); assert.equal(0xa3, z[1]); } { const z = x.slice(0, 9); console.log(z.inspect()); console.log(z.length); assert.equal(9, z.length); } { const z = x.slice(1, 4); console.log(z.inspect()); console.log(z.length); assert.equal(3, z.length); assert.equal(0xa3, z[0]); } { const z = x.slice(2, 4); console.log(z.inspect()); console.log(z.length); assert.equal(2, z.length); assert.equal(0x66, z[0]); assert.equal(0x6f, z[1]); } assert.equal(0, Buffer.from('hello').slice(0, 0).length); ['ucs2', 'ucs-2', 'utf16le', 'utf-16le'].forEach(function(encoding) { const b = Buffer.allocUnsafe(10); b.write('あいうえお', encoding); assert.equal(b.toString(encoding), 'あいうえお'); }); { // Binary encoding should write only one byte per character. const b = Buffer.from([0xde, 0xad, 0xbe, 0xef]); let s = String.fromCharCode(0xffff); b.write(s, 0, 'binary'); assert.equal(0xff, b[0]); assert.equal(0xad, b[1]); assert.equal(0xbe, b[2]); assert.equal(0xef, b[3]); s = String.fromCharCode(0xaaee); b.write(s, 0, 'binary'); assert.equal(0xee, b[0]); assert.equal(0xad, b[1]); assert.equal(0xbe, b[2]); assert.equal(0xef, b[3]); } { // #1210 Test UTF-8 string includes null character let buf = Buffer.from('\0'); assert.equal(buf.length, 1); buf = Buffer.from('\0\0'); assert.equal(buf.length, 2); } { const buf = Buffer.allocUnsafe(2); let written = buf.write(''); // 0byte assert.equal(written, 0); written = buf.write('\0'); // 1byte (v8 adds null terminator) assert.equal(written, 1); written = buf.write('a\0'); // 1byte * 2 assert.equal(written, 2); written = buf.write('あ'); // 3bytes assert.equal(written, 0); written = buf.write('\0あ'); // 1byte + 3bytes assert.equal(written, 1); written = buf.write('\0\0あ'); // 1byte * 2 + 3bytes assert.equal(written, 2); } { const buf = Buffer.allocUnsafe(10); written = buf.write('あいう'); // 3bytes * 3 (v8 adds null terminator) assert.equal(written, 9); written = buf.write('あいう\0'); // 3bytes * 3 + 1byte assert.equal(written, 10); } { // #243 Test write() with maxLength const buf = Buffer.allocUnsafe(4); buf.fill(0xFF); let written = buf.write('abcd', 1, 2, 'utf8'); console.log(buf); assert.equal(written, 2); assert.equal(buf[0], 0xFF); assert.equal(buf[1], 0x61); assert.equal(buf[2], 0x62); assert.equal(buf[3], 0xFF); buf.fill(0xFF); written = buf.write('abcd', 1, 4); console.log(buf); assert.equal(written, 3); assert.equal(buf[0], 0xFF); assert.equal(buf[1], 0x61); assert.equal(buf[2], 0x62); assert.equal(buf[3], 0x63); buf.fill(0xFF); written = buf.write('abcd', 'utf8', 1, 2); // legacy style console.log(buf); assert.equal(written, 2); assert.equal(buf[0], 0xFF); assert.equal(buf[1], 0x61); assert.equal(buf[2], 0x62); assert.equal(buf[3], 0xFF); buf.fill(0xFF); written = buf.write('abcdef', 1, 2, 'hex'); console.log(buf); assert.equal(written, 2); assert.equal(buf[0], 0xFF); assert.equal(buf[1], 0xAB); assert.equal(buf[2], 0xCD); assert.equal(buf[3], 0xFF); ['ucs2', 'ucs-2', 'utf16le', 'utf-16le'].forEach(function(encoding) { buf.fill(0xFF); written = buf.write('abcd', 0, 2, encoding); console.log(buf); assert.equal(written, 2); assert.equal(buf[0], 0x61); assert.equal(buf[1], 0x00); assert.equal(buf[2], 0xFF); assert.equal(buf[3], 0xFF); }); } { // test offset returns are correct const b = Buffer.allocUnsafe(16); assert.equal(4, b.writeUInt32LE(0, 0)); assert.equal(6, b.writeUInt16LE(0, 4)); assert.equal(7, b.writeUInt8(0, 6)); assert.equal(8, b.writeInt8(0, 7)); assert.equal(16, b.writeDoubleLE(0, 8)); } { // test unmatched surrogates not producing invalid utf8 output // ef bf bd = utf-8 representation of unicode replacement character // see https://codereview.chromium.org/121173009/ const buf = Buffer.from('ab\ud800cd', 'utf8'); assert.equal(buf[0], 0x61); assert.equal(buf[1], 0x62); assert.equal(buf[2], 0xef); assert.equal(buf[3], 0xbf); assert.equal(buf[4], 0xbd); assert.equal(buf[5], 0x63); assert.equal(buf[6], 0x64); } { // test for buffer overrun const buf = Buffer.from([0, 0, 0, 0, 0]); // length: 5 var sub = buf.slice(0, 4); // length: 4 written = sub.write('12345', 'binary'); assert.equal(written, 4); assert.equal(buf[4], 0); } // Check for fractional length args, junk length args, etc. // https://github.com/joyent/node/issues/1758 // Call .fill() first, stops valgrind warning about uninitialized memory reads. Buffer.allocUnsafe(3.3).fill().toString(); // throws bad argument error in commit 43cb4ec assert.equal(Buffer.allocUnsafe(-1).length, 0); assert.equal(Buffer.allocUnsafe(NaN).length, 0); assert.equal(Buffer.allocUnsafe(3.3).length, 3); assert.equal(Buffer.from({length: 3.3}).length, 3); assert.equal(Buffer.from({length: 'BAM'}).length, 0); // Make sure that strings are not coerced to numbers. assert.equal(Buffer.from('99').length, 2); assert.equal(Buffer.from('13.37').length, 5); // Ensure that the length argument is respected. 'ascii utf8 hex base64 binary'.split(' ').forEach(function(enc) { assert.equal(Buffer.allocUnsafe(1).write('aaaaaa', 0, 1, enc), 1); }); { // Regression test, guard against buffer overrun in the base64 decoder. const a = Buffer.allocUnsafe(3); const b = Buffer.from('xxx'); a.write('aaaaaaaa', 'base64'); assert.equal(b.toString(), 'xxx'); } // issue GH-3416 Buffer.from(Buffer.alloc(0), 0, 0); [ 'hex', 'utf8', 'utf-8', 'ascii', 'binary', 'base64', 'ucs2', 'ucs-2', 'utf16le', 'utf-16le' ].forEach(function(enc) { assert.equal(Buffer.isEncoding(enc), true); }); [ 'utf9', 'utf-7', 'Unicode-FTW', 'new gnu gun' ].forEach(function(enc) { assert.equal(Buffer.isEncoding(enc), false); }); // GH-5110 (function() { const buffer = Buffer.from('test'); const string = JSON.stringify(buffer); assert.equal(string, '{"type":"Buffer","data":[116,101,115,116]}'); assert.deepEqual(buffer, JSON.parse(string, function(key, value) { return value && value.type === 'Buffer' ? Buffer.from(value.data) : value; })); })(); // issue GH-7849 (function() { var buf = Buffer.from('test'); var json = JSON.stringify(buf); var obj = JSON.parse(json); var copy = Buffer.from(obj); assert(buf.equals(copy)); })(); // issue GH-4331 assert.throws(function() { Buffer.allocUnsafe(0xFFFFFFFF); }, RangeError); assert.throws(function() { Buffer.allocUnsafe(0xFFFFFFFFF); }, RangeError); assert(Buffer.alloc.toString().length < 600, 'Buffer.alloc is not inlineable'); // https://github.com/nodejs/node/issues/9226 { const buf = Buffer.alloc(4, 'YQ==', 'base64'); const expectedBuf = Buffer.from([97, 97, 97, 97]); assert(buf.equals(expectedBuf)); } { const buf = Buffer.alloc(4, 'ab', 'ascii'); const expectedBuf = Buffer.from([97, 98, 97, 98]); assert(buf.equals(expectedBuf)); } // attempt to overflow buffers, similar to previous bug in array buffers assert.throws(function() { var buf = Buffer(8); buf.readFloatLE(0xffffffff); }, RangeError); assert.throws(function() { var buf = Buffer.allocUnsafe(8); buf.writeFloatLE(0.0, 0xffffffff); }, RangeError); assert.throws(function() { var buf = Buffer.allocUnsafe(8); buf.readFloatLE(0xffffffff); }, RangeError); assert.throws(function() { var buf = Buffer.allocUnsafe(8); buf.writeFloatLE(0.0, 0xffffffff); }, RangeError); // ensure negative values can't get past offset assert.throws(function() { var buf = Buffer.allocUnsafe(8); buf.readFloatLE(-1); }, RangeError); assert.throws(function() { var buf = Buffer.allocUnsafe(8); buf.writeFloatLE(0.0, -1); }, RangeError); assert.throws(function() { var buf = Buffer.allocUnsafe(8); buf.readFloatLE(-1); }, RangeError); assert.throws(function() { var buf = Buffer.allocUnsafe(8); buf.writeFloatLE(0.0, -1); }, RangeError); // offset checks { const buf = Buffer.alloc(0); assert.throws(function() { buf.readUInt8(0); }, RangeError); assert.throws(function() { buf.readInt8(0); }, RangeError); } { const buf = Buffer.from([0xFF]); assert.equal(buf.readUInt8(0), 255); assert.equal(buf.readInt8(0), -1); } [16, 32].forEach(function(bits) { var buf = Buffer.allocUnsafe(bits / 8 - 1); assert.throws(function() { buf['readUInt' + bits + 'BE'](0); }, RangeError, 'readUInt' + bits + 'BE'); assert.throws(function() { buf['readUInt' + bits + 'LE'](0); }, RangeError, 'readUInt' + bits + 'LE'); assert.throws(function() { buf['readInt' + bits + 'BE'](0); }, RangeError, 'readInt' + bits + 'BE()'); assert.throws(function() { buf['readInt' + bits + 'LE'](0); }, RangeError, 'readInt' + bits + 'LE()'); }); [16, 32].forEach(function(bits) { var buf = Buffer.from([0xFF, 0xFF, 0xFF, 0xFF]); assert.equal(buf['readUInt' + bits + 'BE'](0), (0xFFFFFFFF >>> (32 - bits))); assert.equal(buf['readUInt' + bits + 'LE'](0), (0xFFFFFFFF >>> (32 - bits))); assert.equal(buf['readInt' + bits + 'BE'](0), (0xFFFFFFFF >> (32 - bits))); assert.equal(buf['readInt' + bits + 'LE'](0), (0xFFFFFFFF >> (32 - bits))); }); // test for common read(U)IntLE/BE (function() { var buf = Buffer.from([0x01, 0x02, 0x03, 0x04, 0x05, 0x06]); assert.equal(buf.readUIntLE(0, 1), 0x01); assert.equal(buf.readUIntBE(0, 1), 0x01); assert.equal(buf.readUIntLE(0, 3), 0x030201); assert.equal(buf.readUIntBE(0, 3), 0x010203); assert.equal(buf.readUIntLE(0, 5), 0x0504030201); assert.equal(buf.readUIntBE(0, 5), 0x0102030405); assert.equal(buf.readUIntLE(0, 6), 0x060504030201); assert.equal(buf.readUIntBE(0, 6), 0x010203040506); assert.equal(buf.readIntLE(0, 1), 0x01); assert.equal(buf.readIntBE(0, 1), 0x01); assert.equal(buf.readIntLE(0, 3), 0x030201); assert.equal(buf.readIntBE(0, 3), 0x010203); assert.equal(buf.readIntLE(0, 5), 0x0504030201); assert.equal(buf.readIntBE(0, 5), 0x0102030405); assert.equal(buf.readIntLE(0, 6), 0x060504030201); assert.equal(buf.readIntBE(0, 6), 0x010203040506); })(); // test for common write(U)IntLE/BE (function() { var buf = Buffer.allocUnsafe(3); buf.writeUIntLE(0x123456, 0, 3); assert.deepEqual(buf.toJSON().data, [0x56, 0x34, 0x12]); assert.equal(buf.readUIntLE(0, 3), 0x123456); buf = Buffer.allocUnsafe(3); buf.writeUIntBE(0x123456, 0, 3); assert.deepEqual(buf.toJSON().data, [0x12, 0x34, 0x56]); assert.equal(buf.readUIntBE(0, 3), 0x123456); buf = Buffer.allocUnsafe(3); buf.writeIntLE(0x123456, 0, 3); assert.deepEqual(buf.toJSON().data, [0x56, 0x34, 0x12]); assert.equal(buf.readIntLE(0, 3), 0x123456); buf = Buffer.allocUnsafe(3); buf.writeIntBE(0x123456, 0, 3); assert.deepEqual(buf.toJSON().data, [0x12, 0x34, 0x56]); assert.equal(buf.readIntBE(0, 3), 0x123456); buf = Buffer.allocUnsafe(3); buf.writeIntLE(-0x123456, 0, 3); assert.deepEqual(buf.toJSON().data, [0xaa, 0xcb, 0xed]); assert.equal(buf.readIntLE(0, 3), -0x123456); buf = Buffer.allocUnsafe(3); buf.writeIntBE(-0x123456, 0, 3); assert.deepEqual(buf.toJSON().data, [0xed, 0xcb, 0xaa]); assert.equal(buf.readIntBE(0, 3), -0x123456); buf = Buffer.allocUnsafe(3); buf.writeIntLE(-0x123400, 0, 3); assert.deepEqual(buf.toJSON().data, [0x00, 0xcc, 0xed]); assert.equal(buf.readIntLE(0, 3), -0x123400); buf = Buffer.allocUnsafe(3); buf.writeIntBE(-0x123400, 0, 3); assert.deepEqual(buf.toJSON().data, [0xed, 0xcc, 0x00]); assert.equal(buf.readIntBE(0, 3), -0x123400); buf = Buffer.allocUnsafe(3); buf.writeIntLE(-0x120000, 0, 3); assert.deepEqual(buf.toJSON().data, [0x00, 0x00, 0xee]); assert.equal(buf.readIntLE(0, 3), -0x120000); buf = Buffer.allocUnsafe(3); buf.writeIntBE(-0x120000, 0, 3); assert.deepEqual(buf.toJSON().data, [0xee, 0x00, 0x00]); assert.equal(buf.readIntBE(0, 3), -0x120000); buf = Buffer.allocUnsafe(5); buf.writeUIntLE(0x1234567890, 0, 5); assert.deepEqual(buf.toJSON().data, [0x90, 0x78, 0x56, 0x34, 0x12]); assert.equal(buf.readUIntLE(0, 5), 0x1234567890); buf = Buffer.allocUnsafe(5); buf.writeUIntBE(0x1234567890, 0, 5); assert.deepEqual(buf.toJSON().data, [0x12, 0x34, 0x56, 0x78, 0x90]); assert.equal(buf.readUIntBE(0, 5), 0x1234567890); buf = Buffer.allocUnsafe(5); buf.writeIntLE(0x1234567890, 0, 5); assert.deepEqual(buf.toJSON().data, [0x90, 0x78, 0x56, 0x34, 0x12]); assert.equal(buf.readIntLE(0, 5), 0x1234567890); buf = Buffer.allocUnsafe(5); buf.writeIntBE(0x1234567890, 0, 5); assert.deepEqual(buf.toJSON().data, [0x12, 0x34, 0x56, 0x78, 0x90]); assert.equal(buf.readIntBE(0, 5), 0x1234567890); buf = Buffer.allocUnsafe(5); buf.writeIntLE(-0x1234567890, 0, 5); assert.deepEqual(buf.toJSON().data, [0x70, 0x87, 0xa9, 0xcb, 0xed]); assert.equal(buf.readIntLE(0, 5), -0x1234567890); buf = Buffer.allocUnsafe(5); buf.writeIntBE(-0x1234567890, 0, 5); assert.deepEqual(buf.toJSON().data, [0xed, 0xcb, 0xa9, 0x87, 0x70]); assert.equal(buf.readIntBE(0, 5), -0x1234567890); buf = Buffer.allocUnsafe(5); buf.writeIntLE(-0x0012000000, 0, 5); assert.deepEqual(buf.toJSON().data, [0x00, 0x00, 0x00, 0xee, 0xff]); assert.equal(buf.readIntLE(0, 5), -0x0012000000); buf = Buffer.allocUnsafe(5); buf.writeIntBE(-0x0012000000, 0, 5); assert.deepEqual(buf.toJSON().data, [0xff, 0xee, 0x00, 0x00, 0x00]); assert.equal(buf.readIntBE(0, 5), -0x0012000000); })(); // test Buffer slice (function() { var buf = Buffer.from('0123456789'); assert.equal(buf.slice(-10, 10), '0123456789'); assert.equal(buf.slice(-20, 10), '0123456789'); assert.equal(buf.slice(-20, -10), ''); assert.equal(buf.slice(), '0123456789'); assert.equal(buf.slice(0), '0123456789'); assert.equal(buf.slice(0, 0), ''); assert.equal(buf.slice(undefined), '0123456789'); assert.equal(buf.slice('foobar'), '0123456789'); assert.equal(buf.slice(undefined, undefined), '0123456789'); assert.equal(buf.slice(2), '23456789'); assert.equal(buf.slice(5), '56789'); assert.equal(buf.slice(10), ''); assert.equal(buf.slice(5, 8), '567'); assert.equal(buf.slice(8, -1), '8'); assert.equal(buf.slice(-10), '0123456789'); assert.equal(buf.slice(0, -9), '0'); assert.equal(buf.slice(0, -10), ''); assert.equal(buf.slice(0, -1), '012345678'); assert.equal(buf.slice(2, -2), '234567'); assert.equal(buf.slice(0, 65536), '0123456789'); assert.equal(buf.slice(65536, 0), ''); assert.equal(buf.slice(-5, -8), ''); assert.equal(buf.slice(-5, -3), '56'); assert.equal(buf.slice(-10, 10), '0123456789'); for (let i = 0, s = buf.toString(); i < buf.length; ++i) { assert.equal(buf.slice(i), s.slice(i)); assert.equal(buf.slice(0, i), s.slice(0, i)); assert.equal(buf.slice(-i), s.slice(-i)); assert.equal(buf.slice(0, -i), s.slice(0, -i)); } var utf16Buf = Buffer.from('0123456789', 'utf16le'); assert.deepEqual(utf16Buf.slice(0, 6), Buffer.from('012', 'utf16le')); assert.equal(buf.slice('0', '1'), '0'); assert.equal(buf.slice('-5', '10'), '56789'); assert.equal(buf.slice('-10', '10'), '0123456789'); assert.equal(buf.slice('-10', '-5'), '01234'); assert.equal(buf.slice('-10', '-0'), ''); assert.equal(buf.slice('111'), ''); assert.equal(buf.slice('0', '-111'), ''); // try to slice a zero length Buffer // see https://github.com/joyent/node/issues/5881 SlowBuffer(0).slice(0, 1); })(); // Regression test for #5482: should throw but not assert in C++ land. assert.throws(function() { Buffer.from('', 'buffer'); }, TypeError); // Regression test for #6111. Constructing a buffer from another buffer // should a) work, and b) not corrupt the source buffer. (function() { var a = [0]; for (let i = 0; i < 7; ++i) a = a.concat(a); a = a.map(function(_, i) { return i; }); const b = Buffer.from(a); const c = Buffer.from(b); assert.equal(b.length, a.length); assert.equal(c.length, a.length); for (let i = 0, k = a.length; i < k; ++i) { assert.equal(a[i], i); assert.equal(b[i], i); assert.equal(c[i], i); } })(); assert.throws(function() { Buffer.allocUnsafe((-1 >>> 0) + 1); }, RangeError); assert.throws(function() { new SlowBuffer((-1 >>> 0) + 1); }, RangeError); if (common.hasCrypto) { // Test truncation after decode var crypto = require('crypto'); var b1 = Buffer.from('YW55=======', 'base64'); var b2 = Buffer.from('YW55', 'base64'); assert.equal( crypto.createHash('sha1').update(b1).digest('hex'), crypto.createHash('sha1').update(b2).digest('hex') ); } else { console.log('1..0 # Skipped: missing crypto'); } // Test Compare { const b = Buffer.alloc(1, 'a'); const c = Buffer.alloc(1, 'c'); const d = Buffer.alloc(2, 'aa'); assert.equal(b.compare(c), -1); assert.equal(c.compare(d), 1); assert.equal(d.compare(b), 1); assert.equal(b.compare(d), -1); assert.equal(b.compare(b), 0); assert.equal(Buffer.compare(b, c), -1); assert.equal(Buffer.compare(c, d), 1); assert.equal(Buffer.compare(d, b), 1); assert.equal(Buffer.compare(b, d), -1); assert.equal(Buffer.compare(c, c), 0); assert.equal(Buffer.compare(Buffer.alloc(0), Buffer.alloc(0)), 0); assert.equal(Buffer.compare(Buffer.alloc(0), Buffer.alloc(1)), -1); assert.equal(Buffer.compare(Buffer.alloc(1), Buffer.alloc(0)), 1); } assert.throws(function() { var b = Buffer.allocUnsafe(1); Buffer.compare(b, 'abc'); }); assert.throws(function() { var b = Buffer.allocUnsafe(1); Buffer.compare('abc', b); }); assert.throws(function() { var b = Buffer.allocUnsafe(1); b.compare('abc'); }); // Test Equals { const b = Buffer.alloc(5, 'abcdf'); const c = Buffer.alloc(5, 'abcdf'); const d = Buffer.alloc(5, 'abcde'); const e = Buffer.alloc(6, 'abcdef'); assert.ok(b.equals(c)); assert.ok(!c.equals(d)); assert.ok(!d.equals(e)); assert.ok(d.equals(d)); } assert.throws(function() { var b = Buffer.allocUnsafe(1); b.equals('abc'); }); // Regression test for https://github.com/nodejs/node/issues/649. assert.throws(function() { Buffer.allocUnsafe(1422561062959).toString('utf8'); }); var ps = Buffer.poolSize; Buffer.poolSize = 0; assert.equal(Buffer.allocUnsafe(1).parent, undefined); Buffer.poolSize = ps; // Test Buffer.copy() segfault assert.throws(function() { Buffer.allocUnsafe(10).copy(); }); // Test prototype getters don't throw assert.equal(Buffer.prototype.parent, undefined); assert.equal(Buffer.prototype.offset, undefined); assert.equal(SlowBuffer.prototype.parent, undefined); assert.equal(SlowBuffer.prototype.offset, undefined); // ParseArrayIndex() should reject values that don't fit in a 32 bits size_t. assert.throws(() => { const a = Buffer(1).fill(0); const b = Buffer(1).fill(0); a.copy(b, 0, 0x100000000, 0x100000001); }), /out of range index/; // Unpooled buffer (replaces SlowBuffer) const ubuf = Buffer.allocUnsafeSlow(10); assert(ubuf); assert(ubuf.buffer); assert.equal(ubuf.buffer.byteLength, 10); node-v4.8.2/test/parallel/test-buffer-arraybuffer.js000644 000766 000024 00000002532 13070706736 022630 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const Buffer = require('buffer').Buffer; const LENGTH = 16; const ab = new ArrayBuffer(LENGTH); const dv = new DataView(ab); const ui = new Uint8Array(ab); const buf = new Buffer(ab); assert.ok(buf instanceof Buffer); // For backwards compatibility of old .parent property test that if buf is not // a slice then .parent should be undefined. assert.strictEqual(buf.parent, undefined); assert.strictEqual(buf.buffer, ab); assert.strictEqual(buf.length, ab.byteLength); buf.fill(0xC); for (let i = 0; i < LENGTH; i++) { assert.equal(ui[i], 0xC); ui[i] = 0xF; assert.equal(buf[i], 0xF); } buf.writeUInt32LE(0xF00, 0); buf.writeUInt32BE(0xB47, 4); buf.writeDoubleLE(3.1415, 8); assert.equal(dv.getUint32(0, true), 0xF00); assert.equal(dv.getUint32(4), 0xB47); assert.equal(dv.getFloat64(8, true), 3.1415); // Now test protecting users from doing stupid things assert.throws(function() { function AB() { } Object.setPrototypeOf(AB, ArrayBuffer); Object.setPrototypeOf(AB.prototype, ArrayBuffer.prototype); new Buffer(new AB()); }, TypeError); // write{Double,Float}{LE,BE} with noAssert should not crash, cf. #3766 const b = Buffer.allocUnsafe(1); b.writeFloatLE(11.11, 0, true); b.writeFloatBE(11.11, 0, true); b.writeDoubleLE(11.11, 0, true); b.writeDoubleBE(11.11, 0, true); node-v4.8.2/test/parallel/test-buffer-ascii.js000644 000766 000024 00000001516 13070706736 021411 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); // ASCII conversion in node.js simply masks off the high bits, // it doesn't do transliteration. assert.equal(Buffer('hérité').toString('ascii'), 'hC)ritC)'); // 71 characters, 78 bytes. The ’ character is a triple-byte sequence. var input = 'C’est, graphiquement, la réunion d’un accent aigu ' + 'et d’un accent grave.'; var expected = 'Cb\u0000\u0019est, graphiquement, la rC)union ' + 'db\u0000\u0019un accent aigu et db\u0000\u0019un ' + 'accent grave.'; var buf = Buffer(input); for (var i = 0; i < expected.length; ++i) { assert.equal(buf.slice(i).toString('ascii'), expected.slice(i)); // Skip remainder of multi-byte sequence. if (input.charCodeAt(i) > 65535) ++i; if (input.charCodeAt(i) > 127) ++i; } node-v4.8.2/test/parallel/test-buffer-badhex.js000644 000766 000024 00000003200 13070706736 021544 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const Buffer = require('buffer').Buffer; // Test hex strings and bad hex strings { const buf = Buffer.alloc(4); assert.strictEqual(buf.length, 4); assert.deepStrictEqual(buf, new Buffer([0, 0, 0, 0])); assert.strictEqual(buf.write('abcdxx', 0, 'hex'), 2); assert.deepStrictEqual(buf, new Buffer([0xab, 0xcd, 0x00, 0x00])); assert.strictEqual(buf.toString('hex'), 'abcd0000'); assert.strictEqual(buf.write('abcdef01', 0, 'hex'), 4); assert.deepStrictEqual(buf, new Buffer([0xab, 0xcd, 0xef, 0x01])); assert.strictEqual(buf.toString('hex'), 'abcdef01'); const copy = Buffer.from(buf.toString('hex'), 'hex'); assert.strictEqual(buf.toString('hex'), copy.toString('hex')); } { const buf = Buffer.alloc(5); assert.strictEqual(buf.write('abcdxx', 1, 'hex'), 2); assert.strictEqual(buf.toString('hex'), '00abcd0000'); } { const buf = Buffer.alloc(4); assert.deepStrictEqual(buf, new Buffer([0, 0, 0, 0])); assert.strictEqual(buf.write('xxabcd', 0, 'hex'), 0); assert.deepStrictEqual(buf, new Buffer([0, 0, 0, 0])); assert.strictEqual(buf.write('xxab', 1, 'hex'), 0); assert.deepStrictEqual(buf, new Buffer([0, 0, 0, 0])); assert.strictEqual(buf.write('cdxxab', 0, 'hex'), 1); assert.deepStrictEqual(buf, new Buffer([0xcd, 0, 0, 0])); } { const buf = Buffer.alloc(256); for (let i = 0; i < 256; i++) buf[i] = i; const hex = buf.toString('hex'); assert.deepStrictEqual(Buffer.from(hex, 'hex'), buf); const badHex = hex.slice(0, 256) + 'xx' + hex.slice(256, 510); assert.deepStrictEqual(Buffer.from(badHex, 'hex'), buf.slice(0, 128)); } node-v4.8.2/test/parallel/test-buffer-bytelength.js000644 000766 000024 00000004107 13070706736 022465 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var Buffer = require('buffer').Buffer; // coerce values to string assert.equal(Buffer.byteLength(32, 'raw'), 2); assert.equal(Buffer.byteLength(NaN, 'utf8'), 3); assert.equal(Buffer.byteLength({}, 'raws'), 15); assert.equal(Buffer.byteLength(), 9); // buffer var incomplete = new Buffer([0xe4, 0xb8, 0xad, 0xe6, 0x96]); assert.equal(Buffer.byteLength(incomplete), 5); var ascii = new Buffer('abc'); assert.equal(Buffer.byteLength(ascii), 3); // special case: zero length string assert.equal(Buffer.byteLength('', 'ascii'), 0); assert.equal(Buffer.byteLength('', 'HeX'), 0); // utf8 assert.equal(Buffer.byteLength('∑éllö wørl∂!', 'utf-8'), 19); assert.equal(Buffer.byteLength('κλμνξο', 'utf8'), 12); assert.equal(Buffer.byteLength('挵挶挷挸挹', 'utf-8'), 15); assert.equal(Buffer.byteLength('𠝹𠱓𠱸', 'UTF8'), 12); // without an encoding, utf8 should be assumed assert.equal(Buffer.byteLength('hey there'), 9); assert.equal(Buffer.byteLength('𠱸挶νξ#xx :)'), 17); assert.equal(Buffer.byteLength('hello world', ''), 11); // it should also be assumed with unrecognized encoding assert.equal(Buffer.byteLength('hello world', 'abc'), 11); assert.equal(Buffer.byteLength('ßœ∑≈', 'unkn0wn enc0ding'), 10); // base64 assert.equal(Buffer.byteLength('aGVsbG8gd29ybGQ=', 'base64'), 11); assert.equal(Buffer.byteLength('bm9kZS5qcyByb2NrcyE=', 'base64'), 14); assert.equal(Buffer.byteLength('aGkk', 'base64'), 3); assert.equal(Buffer.byteLength('bHNrZGZsa3NqZmtsc2xrZmFqc2RsZmtqcw==', 'base64'), 25); // special padding assert.equal(Buffer.byteLength('aaa=', 'base64'), 2); assert.equal(Buffer.byteLength('aaaa==', 'base64'), 3); assert.equal(Buffer.byteLength('Il était tué'), 14); assert.equal(Buffer.byteLength('Il était tué', 'utf8'), 14); assert.equal(Buffer.byteLength('Il était tué', 'ascii'), 12); assert.equal(Buffer.byteLength('Il était tué', 'binary'), 12); ['ucs2', 'ucs-2', 'utf16le', 'utf-16le'].forEach(function(encoding) { assert.equal(24, Buffer.byteLength('Il était tué', encoding)); }); node-v4.8.2/test/parallel/test-buffer-concat.js000644 000766 000024 00000003311 13070706736 021563 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var zero = []; var one = [ new Buffer('asdf') ]; var long = []; for (var i = 0; i < 10; i++) long.push(new Buffer('asdf')); var flatZero = Buffer.concat(zero); var flatOne = Buffer.concat(one); var flatLong = Buffer.concat(long); var flatLongLen = Buffer.concat(long, 40); assert(flatZero.length === 0); assert(flatOne.toString() === 'asdf'); // A special case where concat used to return the first item, // if the length is one. This check is to make sure that we don't do that. assert(flatOne !== one[0]); assert(flatLong.toString() === (new Array(10 + 1).join('asdf'))); assert(flatLongLen.toString() === (new Array(10 + 1).join('asdf'))); assert.throws(function() { Buffer.concat([42]); }, TypeError); const random10 = common.hasCrypto ? require('crypto').randomBytes(10) : Buffer.alloc(10, 1); const empty = Buffer.alloc(0); assert.notDeepStrictEqual(random10, empty); assert.notDeepStrictEqual(random10, Buffer.alloc(10)); assert.deepStrictEqual(Buffer.concat([], 100), empty); assert.deepStrictEqual(Buffer.concat([random10], 0), empty); assert.deepStrictEqual(Buffer.concat([random10], 10), random10); assert.deepStrictEqual(Buffer.concat([random10, random10], 10), random10); assert.deepStrictEqual(Buffer.concat([empty, random10]), random10); assert.deepStrictEqual(Buffer.concat([random10, empty, empty]), random10); // The tail should be zero-filled assert.deepStrictEqual(Buffer.concat([empty], 100), Buffer.alloc(100)); assert.deepStrictEqual(Buffer.concat([empty], 4096), Buffer.alloc(4096)); assert.deepStrictEqual( Buffer.concat([random10], 40), Buffer.concat([random10, Buffer.alloc(30)])); console.log('ok'); node-v4.8.2/test/parallel/test-buffer-fakes.js000644 000766 000024 00000001735 13070706736 021415 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const Buffer = require('buffer').Buffer; function FakeBuffer() { } Object.setPrototypeOf(FakeBuffer, Buffer); Object.setPrototypeOf(FakeBuffer.prototype, Buffer.prototype); const fb = new FakeBuffer(); assert.throws(function() { new Buffer(fb); }, TypeError); assert.throws(function() { +Buffer.prototype; }, TypeError); assert.throws(function() { Buffer.compare(fb, new Buffer(0)); }, TypeError); assert.throws(function() { fb.write('foo'); }, TypeError); assert.throws(function() { Buffer.concat([fb, fb]); }, TypeError); assert.throws(function() { fb.toString(); }, TypeError); assert.throws(function() { fb.equals(new Buffer(0)); }, TypeError); assert.throws(function() { fb.indexOf(5); }, TypeError); assert.throws(function() { fb.readFloatLE(0); }, TypeError); assert.throws(function() { fb.writeFloatLE(0); }, TypeError); assert.throws(function() { fb.fill(0); }, TypeError); node-v4.8.2/test/parallel/test-buffer-indexof.js000644 000766 000024 00000027216 13070706736 021762 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var Buffer = require('buffer').Buffer; var b = new Buffer('abcdef'); var buf_a = new Buffer('a'); var buf_bc = new Buffer('bc'); var buf_f = new Buffer('f'); var buf_z = new Buffer('z'); var buf_empty = new Buffer(''); assert.strictEqual(b.indexOf('a'), 0); assert.strictEqual(b.indexOf('a', 1), -1); assert.strictEqual(b.indexOf('a', -1), -1); assert.strictEqual(b.indexOf('a', -4), -1); assert.strictEqual(b.indexOf('a', -b.length), 0); assert.strictEqual(b.indexOf('a', NaN), 0); assert.strictEqual(b.indexOf('a', -Infinity), 0); assert.strictEqual(b.indexOf('a', Infinity), -1); assert.strictEqual(b.indexOf('bc'), 1); assert.strictEqual(b.indexOf('bc', 2), -1); assert.strictEqual(b.indexOf('bc', -1), -1); assert.strictEqual(b.indexOf('bc', -3), -1); assert.strictEqual(b.indexOf('bc', -5), 1); assert.strictEqual(b.indexOf('bc', NaN), 1); assert.strictEqual(b.indexOf('bc', -Infinity), 1); assert.strictEqual(b.indexOf('bc', Infinity), -1); assert.strictEqual(b.indexOf('f'), b.length - 1); assert.strictEqual(b.indexOf('z'), -1); assert.strictEqual(b.indexOf(''), -1); assert.strictEqual(b.indexOf('', 1), -1); assert.strictEqual(b.indexOf('', b.length + 1), -1); assert.strictEqual(b.indexOf('', Infinity), -1); assert.strictEqual(b.indexOf(buf_a), 0); assert.strictEqual(b.indexOf(buf_a, 1), -1); assert.strictEqual(b.indexOf(buf_a, -1), -1); assert.strictEqual(b.indexOf(buf_a, -4), -1); assert.strictEqual(b.indexOf(buf_a, -b.length), 0); assert.strictEqual(b.indexOf(buf_a, NaN), 0); assert.strictEqual(b.indexOf(buf_a, -Infinity), 0); assert.strictEqual(b.indexOf(buf_a, Infinity), -1); assert.strictEqual(b.indexOf(buf_bc), 1); assert.strictEqual(b.indexOf(buf_bc, 2), -1); assert.strictEqual(b.indexOf(buf_bc, -1), -1); assert.strictEqual(b.indexOf(buf_bc, -3), -1); assert.strictEqual(b.indexOf(buf_bc, -5), 1); assert.strictEqual(b.indexOf(buf_bc, NaN), 1); assert.strictEqual(b.indexOf(buf_bc, -Infinity), 1); assert.strictEqual(b.indexOf(buf_bc, Infinity), -1); assert.strictEqual(b.indexOf(buf_f), b.length - 1); assert.strictEqual(b.indexOf(buf_z), -1); assert.strictEqual(b.indexOf(buf_empty), -1); assert.strictEqual(b.indexOf(buf_empty, 1), -1); assert.strictEqual(b.indexOf(buf_empty, b.length + 1), -1); assert.strictEqual(b.indexOf(buf_empty, Infinity), -1); assert.strictEqual(b.indexOf(0x61), 0); assert.strictEqual(b.indexOf(0x61, 1), -1); assert.strictEqual(b.indexOf(0x61, -1), -1); assert.strictEqual(b.indexOf(0x61, -4), -1); assert.strictEqual(b.indexOf(0x61, -b.length), 0); assert.strictEqual(b.indexOf(0x61, NaN), 0); assert.strictEqual(b.indexOf(0x61, -Infinity), 0); assert.strictEqual(b.indexOf(0x61, Infinity), -1); assert.strictEqual(b.indexOf(0x0), -1); // test offsets assert.strictEqual(b.indexOf('d', 2), 3); assert.strictEqual(b.indexOf('f', 5), 5); assert.strictEqual(b.indexOf('f', -1), 5); assert.strictEqual(b.indexOf('f', 6), -1); assert.equal(b.indexOf(Buffer('d'), 2), 3); assert.equal(b.indexOf(Buffer('f'), 5), 5); assert.equal(b.indexOf(Buffer('f'), -1), 5); assert.equal(b.indexOf(Buffer('f'), 6), -1); assert.equal(Buffer('ff').indexOf(Buffer('f'), 1, 'ucs2'), -1); // test hex encoding assert.equal( Buffer(b.toString('hex'), 'hex') .indexOf('64', 0, 'hex'), 3); assert.equal( Buffer(b.toString('hex'), 'hex') .indexOf(Buffer('64', 'hex'), 0, 'hex'), 3); // test base64 encoding assert.equal( Buffer(b.toString('base64'), 'base64') .indexOf('ZA==', 0, 'base64'), 3); assert.equal( Buffer(b.toString('base64'), 'base64') .indexOf(Buffer('ZA==', 'base64'), 0, 'base64'), 3); // test ascii encoding assert.equal( Buffer(b.toString('ascii'), 'ascii') .indexOf('d', 0, 'ascii'), 3); assert.equal( Buffer(b.toString('ascii'), 'ascii') .indexOf(Buffer('d', 'ascii'), 0, 'ascii'), 3); // test binary encoding assert.equal( Buffer(b.toString('binary'), 'binary') .indexOf('d', 0, 'binary'), 3); assert.equal( Buffer(b.toString('binary'), 'binary') .indexOf(Buffer('d', 'binary'), 0, 'binary'), 3); assert.equal( Buffer('aa\u00e8aa', 'binary') .indexOf('\u00e8', 'binary'), 2); assert.equal( Buffer('\u00e8', 'binary') .indexOf('\u00e8', 'binary'), 0); assert.equal( Buffer('\u00e8', 'binary') .indexOf(Buffer('\u00e8', 'binary'), 'binary'), 0); { // test usc2 encoding const twoByteString = new Buffer('\u039a\u0391\u03a3\u03a3\u0395', 'ucs2'); assert.equal(8, twoByteString.indexOf('\u0395', 4, 'ucs2')); assert.equal(6, twoByteString.indexOf('\u03a3', -4, 'ucs2')); assert.equal(4, twoByteString.indexOf('\u03a3', -6, 'ucs2')); assert.equal(4, twoByteString.indexOf( new Buffer('\u03a3', 'ucs2'), -6, 'ucs2')); assert.equal(-1, twoByteString.indexOf('\u03a3', -2, 'ucs2')); } // test optional offset with passed encoding assert.equal(new Buffer('aaaa0').indexOf('30', 'hex'), 4); assert.equal(new Buffer('aaaa00a').indexOf('3030', 'hex'), 4); // test usc2 encoding var twoByteString = new Buffer('\u039a\u0391\u03a3\u03a3\u0395', 'ucs2'); assert.equal(8, twoByteString.indexOf('\u0395', 4, 'ucs2')); assert.equal(6, twoByteString.indexOf('\u03a3', -4, 'ucs2')); assert.equal(4, twoByteString.indexOf('\u03a3', -6, 'ucs2')); assert.equal(4, twoByteString.indexOf( new Buffer('\u03a3', 'ucs2'), -6, 'ucs2')); assert.equal(-1, twoByteString.indexOf('\u03a3', -2, 'ucs2')); var mixedByteStringUcs2 = new Buffer('\u039a\u0391abc\u03a3\u03a3\u0395', 'ucs2'); assert.equal(6, mixedByteStringUcs2.indexOf('bc', 0, 'ucs2')); assert.equal(10, mixedByteStringUcs2.indexOf('\u03a3', 0, 'ucs2')); assert.equal(-1, mixedByteStringUcs2.indexOf('\u0396', 0, 'ucs2')); assert.equal( 6, mixedByteStringUcs2.indexOf(new Buffer('bc', 'ucs2'), 0, 'ucs2')); assert.equal( 10, mixedByteStringUcs2.indexOf(new Buffer('\u03a3', 'ucs2'), 0, 'ucs2')); assert.equal( -1, mixedByteStringUcs2.indexOf(new Buffer('\u0396', 'ucs2'), 0, 'ucs2')); { const twoByteString = new Buffer('\u039a\u0391\u03a3\u03a3\u0395', 'ucs2'); // Test single char pattern assert.equal(0, twoByteString.indexOf('\u039a', 0, 'ucs2')); assert.equal(2, twoByteString.indexOf('\u0391', 0, 'ucs2'), 'Alpha'); assert.equal(4, twoByteString.indexOf('\u03a3', 0, 'ucs2'), 'First Sigma'); assert.equal(6, twoByteString.indexOf('\u03a3', 6, 'ucs2'), 'Second Sigma'); assert.equal(8, twoByteString.indexOf('\u0395', 0, 'ucs2'), 'Epsilon'); assert.equal(-1, twoByteString.indexOf('\u0392', 0, 'ucs2'), 'Not beta'); // Test multi-char pattern assert.equal( 0, twoByteString.indexOf('\u039a\u0391', 0, 'ucs2'), 'Lambda Alpha'); assert.equal( 2, twoByteString.indexOf('\u0391\u03a3', 0, 'ucs2'), 'Alpha Sigma'); assert.equal( 4, twoByteString.indexOf('\u03a3\u03a3', 0, 'ucs2'), 'Sigma Sigma'); assert.equal( 6, twoByteString.indexOf('\u03a3\u0395', 0, 'ucs2'), 'Sigma Epsilon'); } var mixedByteStringUtf8 = new Buffer('\u039a\u0391abc\u03a3\u03a3\u0395'); assert.equal(5, mixedByteStringUtf8.indexOf('bc')); assert.equal(5, mixedByteStringUtf8.indexOf('bc', 5)); assert.equal(5, mixedByteStringUtf8.indexOf('bc', -8)); assert.equal(7, mixedByteStringUtf8.indexOf('\u03a3')); assert.equal(-1, mixedByteStringUtf8.indexOf('\u0396')); // Test complex string indexOf algorithms. Only trigger for long strings. // Long string that isn't a simple repeat of a shorter string. var longString = 'A'; for (let i = 66; i < 76; i++) { // from 'B' to 'K' longString = longString + String.fromCharCode(i) + longString; } var longBufferString = new Buffer(longString); // pattern of 15 chars, repeated every 16 chars in long var pattern = 'ABACABADABACABA'; for (let i = 0; i < longBufferString.length - pattern.length; i += 7) { const index = longBufferString.indexOf(pattern, i); assert.equal((i + 15) & ~0xf, index, 'Long ABACABA...-string at index ' + i); } assert.equal(510, longBufferString.indexOf('AJABACA'), 'Long AJABACA, First J'); assert.equal( 1534, longBufferString.indexOf('AJABACA', 511), 'Long AJABACA, Second J'); pattern = 'JABACABADABACABA'; assert.equal( 511, longBufferString.indexOf(pattern), 'Long JABACABA..., First J'); assert.equal( 1535, longBufferString.indexOf(pattern, 512), 'Long JABACABA..., Second J'); // Search for a non-ASCII string in a pure ASCII string. var asciiString = new Buffer( 'arglebargleglopglyfarglebargleglopglyfarglebargleglopglyf'); assert.equal(-1, asciiString.indexOf('\x2061')); assert.equal(3, asciiString.indexOf('leb', 0)); // Search in string containing many non-ASCII chars. var allCodePoints = []; for (let i = 0; i < 65536; i++) allCodePoints[i] = i; var allCharsString = String.fromCharCode.apply(String, allCodePoints); var allCharsBufferUtf8 = new Buffer(allCharsString); var allCharsBufferUcs2 = new Buffer(allCharsString, 'ucs2'); // Search for string long enough to trigger complex search with ASCII pattern // and UC16 subject. assert.equal(-1, allCharsBufferUtf8.indexOf('notfound')); assert.equal(-1, allCharsBufferUcs2.indexOf('notfound')); // Needle is longer than haystack, but only because it's encoded as UTF-16 assert.strictEqual(new Buffer('aaaa').indexOf('a'.repeat(4), 'ucs2'), -1); assert.strictEqual(new Buffer('aaaa').indexOf('a'.repeat(4), 'utf8'), 0); assert.strictEqual(new Buffer('aaaa').indexOf('你好', 'ucs2'), -1); // Haystack has odd length, but the needle is UCS2. assert.strictEqual(new Buffer('aaaaa').indexOf('b', 'ucs2'), -1); { // Find substrings in Utf8. const lengths = [1, 3, 15]; // Single char, simple and complex. const indices = [0x5, 0x60, 0x400, 0x680, 0x7ee, 0xFF02, 0x16610, 0x2f77b]; for (let lengthIndex = 0; lengthIndex < lengths.length; lengthIndex++) { for (let i = 0; i < indices.length; i++) { const index = indices[i]; let length = lengths[lengthIndex]; if (index + length > 0x7F) { length = 2 * length; } if (index + length > 0x7FF) { length = 3 * length; } if (index + length > 0xFFFF) { length = 4 * length; } var patternBufferUtf8 = allCharsBufferUtf8.slice(index, index + length); assert.equal(index, allCharsBufferUtf8.indexOf(patternBufferUtf8)); var patternStringUtf8 = patternBufferUtf8.toString(); assert.equal(index, allCharsBufferUtf8.indexOf(patternStringUtf8)); } } } { // Find substrings in Usc2. const lengths = [2, 4, 16]; // Single char, simple and complex. const indices = [0x5, 0x65, 0x105, 0x205, 0x285, 0x2005, 0x2085, 0xfff0]; for (let lengthIndex = 0; lengthIndex < lengths.length; lengthIndex++) { for (let i = 0; i < indices.length; i++) { const index = indices[i] * 2; const length = lengths[lengthIndex]; var patternBufferUcs2 = allCharsBufferUcs2.slice(index, index + length); assert.equal( index, allCharsBufferUcs2.indexOf(patternBufferUcs2, 0, 'ucs2')); var patternStringUcs2 = patternBufferUcs2.toString('ucs2'); assert.equal( index, allCharsBufferUcs2.indexOf(patternStringUcs2, 0, 'ucs2')); } } } assert.throws(function() { b.indexOf(function() { }); }); assert.throws(function() { b.indexOf({}); }); assert.throws(function() { b.indexOf([]); }); // test truncation of Number arguments to uint8 { const buf = Buffer.from('this is a test'); assert.strictEqual(buf.indexOf(0x6973), 3); assert.strictEqual(buf.indexOf(0x697320), 4); assert.strictEqual(buf.indexOf(0x69732069), 2); assert.strictEqual(buf.indexOf(0x697374657374), 0); assert.strictEqual(buf.indexOf(0x69737374), 0); assert.strictEqual(buf.indexOf(0x69737465), 11); assert.strictEqual(buf.indexOf(0x69737465), 11); assert.strictEqual(buf.indexOf(-140), 0); assert.strictEqual(buf.indexOf(-152), 1); assert.strictEqual(buf.indexOf(0xff), -1); assert.strictEqual(buf.indexOf(0xffff), -1); } node-v4.8.2/test/parallel/test-buffer-inheritance.js000644 000766 000024 00000001452 13070706736 022611 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); function T(n) { const ui8 = new Uint8Array(n); Object.setPrototypeOf(ui8, T.prototype); return ui8; } Object.setPrototypeOf(T.prototype, Buffer.prototype); Object.setPrototypeOf(T, Buffer); T.prototype.sum = function sum() { let cntr = 0; for (let i = 0; i < this.length; i++) cntr += this[i]; return cntr; }; const vals = [new T(4), T(4)]; vals.forEach(function(t) { assert.equal(t.constructor, T); assert.equal(Object.getPrototypeOf(t), T.prototype); assert.equal(Object.getPrototypeOf(Object.getPrototypeOf(t)), Buffer.prototype); t.fill(5); let cntr = 0; for (let i = 0; i < t.length; i++) cntr += t[i]; assert.equal(t.length * 5, cntr); // Check this does not throw t.toString(); }); node-v4.8.2/test/parallel/test-buffer-inspect.js000644 000766 000024 00000001374 13070706736 021770 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var util = require('util'); var buffer = require('buffer'); buffer.INSPECT_MAX_BYTES = 2; var b = new Buffer(4); b.fill('1234'); var s = new buffer.SlowBuffer(4); s.fill('1234'); var expected = ''; assert.strictEqual(util.inspect(b), expected); assert.strictEqual(util.inspect(s), expected); b = new Buffer(2); b.fill('12'); s = new buffer.SlowBuffer(2); s.fill('12'); expected = ''; assert.strictEqual(util.inspect(b), expected); assert.strictEqual(util.inspect(s), expected); buffer.INSPECT_MAX_BYTES = Infinity; assert.doesNotThrow(function() { assert.strictEqual(util.inspect(b), expected); assert.strictEqual(util.inspect(s), expected); }); node-v4.8.2/test/parallel/test-buffer-iterator.js000644 000766 000024 00000001552 13070706736 022152 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var buffer = new Buffer([1, 2, 3, 4, 5]); var arr; var b; // buffers should be iterable arr = []; for (b of buffer) arr.push(b); assert.deepEqual(arr, [1, 2, 3, 4, 5]); // buffer iterators should be iterable arr = []; for (b of buffer[Symbol.iterator]()) arr.push(b); assert.deepEqual(arr, [1, 2, 3, 4, 5]); // buffer#values() should return iterator for values arr = []; for (b of buffer.values()) arr.push(b); assert.deepEqual(arr, [1, 2, 3, 4, 5]); // buffer#keys() should return iterator for keys arr = []; for (b of buffer.keys()) arr.push(b); assert.deepEqual(arr, [0, 1, 2, 3, 4]); // buffer#entries() should return iterator for entries arr = []; for (b of buffer.entries()) arr.push(b); assert.deepEqual(arr, [ [0, 1], [1, 2], [2, 3], [3, 4], [4, 5] ]); node-v4.8.2/test/parallel/test-buffer-safe-unsafe.js000644 000766 000024 00000000374 13070706736 022517 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const safe = Buffer.alloc(10); function isZeroFilled(buf) { for (let n = 0; n < buf.length; n++) if (buf[n] > 0) return false; return true; } assert(isZeroFilled(safe)); node-v4.8.2/test/parallel/test-buffer-slow.js000644 000766 000024 00000003143 13070706736 021303 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const buffer = require('buffer'); const Buffer = buffer.Buffer; const SlowBuffer = buffer.SlowBuffer; const ones = [1, 1, 1, 1]; // should create a Buffer let sb = new SlowBuffer(4); assert(sb instanceof Buffer); assert.strictEqual(sb.length, 4); sb.fill(1); assert.deepEqual(sb, ones); // underlying ArrayBuffer should have the same length assert.strictEqual(sb.buffer.byteLength, 4); // should work without new sb = SlowBuffer(4); assert(sb instanceof Buffer); assert.strictEqual(sb.length, 4); sb.fill(1); assert.deepEqual(sb, ones); // should work with edge cases assert.strictEqual(SlowBuffer(0).length, 0); try { assert.strictEqual(SlowBuffer(buffer.kMaxLength).length, buffer.kMaxLength); } catch (e) { assert.strictEqual(e.message, 'Invalid array buffer length'); } // should work with number-coercible values assert.strictEqual(SlowBuffer('6').length, 6); assert.strictEqual(SlowBuffer(true).length, 1); // should create zero-length buffer if parameter is not a number assert.strictEqual(SlowBuffer().length, 0); assert.strictEqual(SlowBuffer(NaN).length, 0); assert.strictEqual(SlowBuffer({}).length, 0); assert.strictEqual(SlowBuffer('string').length, 0); // should throw with invalid length assert.throws(function() { new SlowBuffer(Infinity); }, /^RangeError: Invalid typed array length$/); assert.throws(function() { new SlowBuffer(-1); }, /^RangeError: Invalid typed array length$/); assert.throws(function() { new SlowBuffer(buffer.kMaxLength + 1); }, /^RangeError: (Invalid typed array length|Array buffer allocation failed)$/); node-v4.8.2/test/parallel/test-buffer-zero-fill-cli.js000644 000766 000024 00000001343 13070706737 022770 0ustar00iojsstaff000000 000000 'use strict'; // Flags: --zero-fill-buffers // when using --zero-fill-buffers, every Buffer and SlowBuffer // instance must be zero filled upon creation require('../common'); const SlowBuffer = require('buffer').SlowBuffer; const assert = require('assert'); function isZeroFilled(buf) { for (let n = 0; n < buf.length; n++) if (buf[n] > 0) return false; return true; } // This can be somewhat unreliable because the // allocated memory might just already happen to // contain all zeroes. The test is run multiple // times to improve the reliability. for (let i = 0; i < 50; i++) { const bufs = [ SlowBuffer(20), Buffer(20), new SlowBuffer(20) ]; for (const buf of bufs) { assert(isZeroFilled(buf)); } } node-v4.8.2/test/parallel/test-buffer-zero-fill-reset.js000644 000766 000024 00000000562 13070706737 023345 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); function testUint8Array(ui) { const length = ui.length; for (let i = 0; i < length; i++) if (ui[i] !== 0) return false; return true; } for (let i = 0; i < 100; i++) { new Buffer(0); const ui = new Uint8Array(65); assert.ok(testUint8Array(ui), 'Uint8Array is not zero-filled'); } node-v4.8.2/test/parallel/test-buffer.js000644 000766 000024 00000117550 13070706737 020332 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var Buffer = require('buffer').Buffer; var SlowBuffer = require('buffer').SlowBuffer; // counter to ensure unique value is always copied var cntr = 0; var b = Buffer(1024); // safe constructor console.log('b.length == %d', b.length); assert.strictEqual(1024, b.length); b[0] = -1; assert.strictEqual(b[0], 255); for (let i = 0; i < 1024; i++) { b[i] = i % 256; } for (let i = 0; i < 1024; i++) { assert.strictEqual(i % 256, b[i]); } var c = new Buffer(512); console.log('c.length == %d', c.length); assert.strictEqual(512, c.length); var d = new Buffer([]); assert.strictEqual(0, d.length); var ui32 = new Uint32Array(4).fill(42); var e = Buffer(ui32); assert.deepEqual(ui32, e); // First check Buffer#fill() works as expected. assert.throws(function() { Buffer(8).fill('a', -1); }); assert.throws(function() { Buffer(8).fill('a', 0, 9); }); // Make sure this doesn't hang indefinitely. Buffer(8).fill(''); { const buf = new Buffer(64); buf.fill(10); for (let i = 0; i < buf.length; i++) assert.equal(buf[i], 10); buf.fill(11, 0, buf.length >> 1); for (let i = 0; i < buf.length >> 1; i++) assert.equal(buf[i], 11); for (let i = (buf.length >> 1) + 1; i < buf.length; i++) assert.equal(buf[i], 10); buf.fill('h'); for (let i = 0; i < buf.length; i++) assert.equal('h'.charCodeAt(0), buf[i]); buf.fill(0); for (let i = 0; i < buf.length; i++) assert.equal(0, buf[i]); buf.fill(null); for (let i = 0; i < buf.length; i++) assert.equal(0, buf[i]); buf.fill(1, 16, 32); for (let i = 0; i < 16; i++) assert.equal(0, buf[i]); for (let i = 16; i < 32; i++) assert.equal(1, buf[i]); for (let i = 32; i < buf.length; i++) assert.equal(0, buf[i]); } { const buf = new Buffer(10); buf.fill('abc'); assert.equal(buf.toString(), 'abcabcabca'); buf.fill('է'); assert.equal(buf.toString(), 'էէէէէ'); } { // copy 512 bytes, from 0 to 512. b.fill(++cntr); c.fill(++cntr); const copied = b.copy(c, 0, 0, 512); console.log('copied %d bytes from b into c', copied); assert.strictEqual(512, copied); for (let i = 0; i < c.length; i++) { assert.strictEqual(b[i], c[i]); } } { // copy c into b, without specifying sourceEnd b.fill(++cntr); c.fill(++cntr); const copied = c.copy(b, 0, 0); console.log('copied %d bytes from c into b w/o sourceEnd', copied); assert.strictEqual(c.length, copied); for (let i = 0; i < c.length; i++) { assert.strictEqual(c[i], b[i]); } } { // copy c into b, without specifying sourceStart b.fill(++cntr); c.fill(++cntr); const copied = c.copy(b, 0); console.log('copied %d bytes from c into b w/o sourceStart', copied); assert.strictEqual(c.length, copied); for (let i = 0; i < c.length; i++) { assert.strictEqual(c[i], b[i]); } } { // copy longer buffer b to shorter c without targetStart b.fill(++cntr); c.fill(++cntr); const copied = b.copy(c); console.log('copied %d bytes from b into c w/o targetStart', copied); assert.strictEqual(c.length, copied); for (let i = 0; i < c.length; i++) { assert.strictEqual(b[i], c[i]); } } { // copy starting near end of b to c b.fill(++cntr); c.fill(++cntr); const copied = b.copy(c, 0, b.length - Math.floor(c.length / 2)); console.log('copied %d bytes from end of b into beginning of c', copied); assert.strictEqual(Math.floor(c.length / 2), copied); for (let i = 0; i < Math.floor(c.length / 2); i++) { assert.strictEqual(b[b.length - Math.floor(c.length / 2) + i], c[i]); } for (let i = Math.floor(c.length / 2) + 1; i < c.length; i++) { assert.strictEqual(c[c.length - 1], c[i]); } } { // try to copy 513 bytes, and check we don't overrun c b.fill(++cntr); c.fill(++cntr); const copied = b.copy(c, 0, 0, 513); console.log('copied %d bytes from b trying to overrun c', copied); assert.strictEqual(c.length, copied); for (let i = 0; i < c.length; i++) { assert.strictEqual(b[i], c[i]); } } { // copy 768 bytes from b into b b.fill(++cntr); b.fill(++cntr, 256); const copied = b.copy(b, 0, 256, 1024); console.log('copied %d bytes from b into b', copied); assert.strictEqual(768, copied); for (let i = 0; i < b.length; i++) { assert.strictEqual(cntr, b[i]); } } // copy string longer than buffer length (failure will segfault) var bb = new Buffer(10); bb.fill('hello crazy world'); // try to copy from before the beginning of b assert.doesNotThrow(() => { b.copy(c, 0, 100, 10); }); // copy throws at negative sourceStart assert.throws(function() { Buffer(5).copy(Buffer(5), 0, -1); }, RangeError); { // check sourceEnd resets to targetEnd if former is greater than the latter b.fill(++cntr); c.fill(++cntr); const copied = b.copy(c, 0, 0, 1025); console.log('copied %d bytes from b into c', copied); for (let i = 0; i < c.length; i++) { assert.strictEqual(b[i], c[i]); } } // throw with negative sourceEnd console.log('test copy at negative sourceEnd'); assert.throws(function() { b.copy(c, 0, 0, -1); }, RangeError); // when sourceStart is greater than sourceEnd, zero copied assert.equal(b.copy(c, 0, 100, 10), 0); // when targetStart > targetLength, zero copied assert.equal(b.copy(c, 512, 0, 10), 0); var caught_error; // invalid encoding for Buffer.toString caught_error = null; try { b.toString('invalid'); } catch (err) { caught_error = err; } assert.strictEqual('Unknown encoding: invalid', caught_error.message); // invalid encoding for Buffer.write caught_error = null; try { b.write('test string', 0, 5, 'invalid'); } catch (err) { caught_error = err; } assert.strictEqual('Unknown encoding: invalid', caught_error.message); // try to create 0-length buffers new Buffer(''); new Buffer('', 'ascii'); new Buffer('', 'binary'); new Buffer(0); // try to write a 0-length string beyond the end of b assert.throws(function() { b.write('', 2048); }, RangeError); // throw when writing to negative offset assert.throws(function() { b.write('a', -1); }, RangeError); // throw when writing past bounds from the pool assert.throws(function() { b.write('a', 2048); }, RangeError); // throw when writing to negative offset assert.throws(function() { b.write('a', -1); }, RangeError); // try to copy 0 bytes worth of data into an empty buffer b.copy(new Buffer(0), 0, 0, 0); // try to copy 0 bytes past the end of the target buffer b.copy(new Buffer(0), 1, 1, 1); b.copy(new Buffer(1), 1, 1, 1); // try to copy 0 bytes from past the end of the source buffer b.copy(new Buffer(1), 0, 2048, 2048); // try to toString() a 0-length slice of a buffer, both within and without the // valid buffer range assert.equal(new Buffer('abc').toString('ascii', 0, 0), ''); assert.equal(new Buffer('abc').toString('ascii', -100, -100), ''); assert.equal(new Buffer('abc').toString('ascii', 100, 100), ''); // try toString() with a object as a encoding assert.equal(new Buffer('abc').toString({toString: function() { return 'ascii'; }}), 'abc'); // testing for smart defaults and ability to pass string values as offset var writeTest = new Buffer('abcdes'); writeTest.write('n', 'ascii'); writeTest.write('o', 'ascii', '1'); writeTest.write('d', '2', 'ascii'); writeTest.write('e', 3, 'ascii'); writeTest.write('j', 'ascii', 4); assert.equal(writeTest.toString(), 'nodejs'); // ASCII slice test { const asciiString = 'hello world'; for (let i = 0; i < asciiString.length; i++) { b[i] = asciiString.charCodeAt(i); } const asciiSlice = b.toString('ascii', 0, asciiString.length); assert.equal(asciiString, asciiSlice); } { const asciiString = 'hello world'; const offset = 100; const written = b.write(asciiString, offset, 'ascii'); assert.equal(asciiString.length, written); const asciiSlice = b.toString('ascii', offset, offset + asciiString.length); assert.equal(asciiString, asciiSlice); } { const asciiString = 'hello world'; const offset = 100; const sliceA = b.slice(offset, offset + asciiString.length); const sliceB = b.slice(offset, offset + asciiString.length); for (let i = 0; i < asciiString.length; i++) { assert.equal(sliceA[i], sliceB[i]); } } // UTF-8 slice test var utf8String = '¡hέlló wôrld!'; var offset = 100; b.write(utf8String, 0, Buffer.byteLength(utf8String), 'utf8'); var utf8Slice = b.toString('utf8', 0, Buffer.byteLength(utf8String)); assert.equal(utf8String, utf8Slice); var written = b.write(utf8String, offset, 'utf8'); assert.equal(Buffer.byteLength(utf8String), written); utf8Slice = b.toString('utf8', offset, offset + Buffer.byteLength(utf8String)); assert.equal(utf8String, utf8Slice); var sliceA = b.slice(offset, offset + Buffer.byteLength(utf8String)); var sliceB = b.slice(offset, offset + Buffer.byteLength(utf8String)); for (let i = 0; i < Buffer.byteLength(utf8String); i++) { assert.equal(sliceA[i], sliceB[i]); } { const slice = b.slice(100, 150); assert.equal(50, slice.length); for (let i = 0; i < 50; i++) { assert.equal(b[100 + i], slice[i]); } } { // make sure only top level parent propagates from allocPool const b = new Buffer(5); const c = b.slice(0, 4); const d = c.slice(0, 2); assert.equal(b.parent, c.parent); assert.equal(b.parent, d.parent); } { // also from a non-pooled instance const b = new SlowBuffer(5); const c = b.slice(0, 4); const d = c.slice(0, 2); assert.equal(c.parent, d.parent); } { // Bug regression test const testValue = '\u00F6\u65E5\u672C\u8A9E'; // ö日本語 const buffer = new Buffer(32); const size = buffer.write(testValue, 0, 'utf8'); console.log('bytes written to buffer: ' + size); const slice = buffer.toString('utf8', 0, size); assert.equal(slice, testValue); } { // Test triple slice const a = new Buffer(8); for (let i = 0; i < 8; i++) a[i] = i; const b = a.slice(4, 8); assert.equal(4, b[0]); assert.equal(5, b[1]); assert.equal(6, b[2]); assert.equal(7, b[3]); const c = b.slice(2, 4); assert.equal(6, c[0]); assert.equal(7, c[1]); } { const d = new Buffer([23, 42, 255]); assert.equal(d.length, 3); assert.equal(d[0], 23); assert.equal(d[1], 42); assert.equal(d[2], 255); assert.deepEqual(d, new Buffer(d)); } { const e = new Buffer('über'); console.error('uber: \'%s\'', e.toString()); assert.deepEqual(e, new Buffer([195, 188, 98, 101, 114])); } { const f = new Buffer('über', 'ascii'); console.error('f.length: %d (should be 4)', f.length); assert.deepEqual(f, new Buffer([252, 98, 101, 114])); } ['ucs2', 'ucs-2', 'utf16le', 'utf-16le'].forEach(function(encoding) { { const f = new Buffer('über', encoding); console.error('f.length: %d (should be 8)', f.length); assert.deepEqual(f, new Buffer([252, 0, 98, 0, 101, 0, 114, 0])); } { const f = new Buffer('привет', encoding); console.error('f.length: %d (should be 12)', f.length); assert.deepEqual(f, new Buffer([63, 4, 64, 4, 56, 4, 50, 4, 53, 4, 66, 4])); assert.equal(f.toString(encoding), 'привет'); } { const f = new Buffer([0, 0, 0, 0, 0]); assert.equal(f.length, 5); const size = f.write('あいうえお', encoding); console.error('bytes written to buffer: %d (should be 4)', size); assert.equal(size, 4); assert.deepEqual(f, new Buffer([0x42, 0x30, 0x44, 0x30, 0x00])); } }); { const f = new Buffer('\uD83D\uDC4D', 'utf-16le'); // THUMBS UP SIGN (U+1F44D) assert.equal(f.length, 4); assert.deepEqual(f, new Buffer('3DD84DDC', 'hex')); } var arrayIsh = {0: 0, 1: 1, 2: 2, 3: 3, length: 4}; var g = new Buffer(arrayIsh); assert.deepEqual(g, new Buffer([0, 1, 2, 3])); var strArrayIsh = {0: '0', 1: '1', 2: '2', 3: '3', length: 4}; g = new Buffer(strArrayIsh); assert.deepEqual(g, new Buffer([0, 1, 2, 3])); // // Test toString('base64') // assert.equal('TWFu', (new Buffer('Man')).toString('base64')); { // test that regular and URL-safe base64 both work const expected = [0xff, 0xff, 0xbe, 0xff, 0xef, 0xbf, 0xfb, 0xef, 0xff]; assert.deepEqual(Buffer('//++/++/++//', 'base64'), Buffer(expected)); assert.deepEqual(Buffer('__--_--_--__', 'base64'), Buffer(expected)); } { // big example const quote = 'Man is distinguished, not only by his reason, but by this ' + 'singular passion from other animals, which is a lust ' + 'of the mind, that by a perseverance of delight in the ' + 'continued and indefatigable generation of knowledge, ' + 'exceeds the short vehemence of any carnal pleasure.'; const expected = 'TWFuIGlzIGRpc3Rpbmd1aXNoZWQsIG5vdCBvbmx5IGJ5IGhpcyByZWFzb' + '24sIGJ1dCBieSB0aGlzIHNpbmd1bGFyIHBhc3Npb24gZnJvbSBvdGhlci' + 'BhbmltYWxzLCB3aGljaCBpcyBhIGx1c3Qgb2YgdGhlIG1pbmQsIHRoYXQ' + 'gYnkgYSBwZXJzZXZlcmFuY2Ugb2YgZGVsaWdodCBpbiB0aGUgY29udGlu' + 'dWVkIGFuZCBpbmRlZmF0aWdhYmxlIGdlbmVyYXRpb24gb2Yga25vd2xlZ' + 'GdlLCBleGNlZWRzIHRoZSBzaG9ydCB2ZWhlbWVuY2Ugb2YgYW55IGNhcm' + '5hbCBwbGVhc3VyZS4='; assert.equal(expected, (new Buffer(quote)).toString('base64')); let b = new Buffer(1024); let bytesWritten = b.write(expected, 0, 'base64'); assert.equal(quote.length, bytesWritten); assert.equal(quote, b.toString('ascii', 0, quote.length)); // check that the base64 decoder ignores whitespace const expectedWhite = expected.slice(0, 60) + ' \n' + expected.slice(60, 120) + ' \n' + expected.slice(120, 180) + ' \n' + expected.slice(180, 240) + ' \n' + expected.slice(240, 300) + '\n' + expected.slice(300, 360) + '\n'; b = new Buffer(1024); bytesWritten = b.write(expectedWhite, 0, 'base64'); assert.equal(quote.length, bytesWritten); assert.equal(quote, b.toString('ascii', 0, quote.length)); // check that the base64 decoder on the constructor works // even in the presence of whitespace. b = new Buffer(expectedWhite, 'base64'); assert.equal(quote.length, b.length); assert.equal(quote, b.toString('ascii', 0, quote.length)); // check that the base64 decoder ignores illegal chars const expectedIllegal = expected.slice(0, 60) + ' \x80' + expected.slice(60, 120) + ' \xff' + expected.slice(120, 180) + ' \x00' + expected.slice(180, 240) + ' \x98' + expected.slice(240, 300) + '\x03' + expected.slice(300, 360); b = new Buffer(expectedIllegal, 'base64'); assert.equal(quote.length, b.length); assert.equal(quote, b.toString('ascii', 0, quote.length)); } assert.equal(new Buffer('', 'base64').toString(), ''); assert.equal(new Buffer('K', 'base64').toString(), ''); // multiple-of-4 with padding assert.equal(new Buffer('Kg==', 'base64').toString(), '*'); assert.equal(new Buffer('Kio=', 'base64').toString(), '**'); assert.equal(new Buffer('Kioq', 'base64').toString(), '***'); assert.equal(new Buffer('KioqKg==', 'base64').toString(), '****'); assert.equal(new Buffer('KioqKio=', 'base64').toString(), '*****'); assert.equal(new Buffer('KioqKioq', 'base64').toString(), '******'); assert.equal(new Buffer('KioqKioqKg==', 'base64').toString(), '*******'); assert.equal(new Buffer('KioqKioqKio=', 'base64').toString(), '********'); assert.equal(new Buffer('KioqKioqKioq', 'base64').toString(), '*********'); assert.equal(new Buffer('KioqKioqKioqKg==', 'base64').toString(), '**********'); assert.equal(new Buffer('KioqKioqKioqKio=', 'base64').toString(), '***********'); assert.equal(new Buffer('KioqKioqKioqKioq', 'base64').toString(), '************'); assert.equal(new Buffer('KioqKioqKioqKioqKg==', 'base64').toString(), '*************'); assert.equal(new Buffer('KioqKioqKioqKioqKio=', 'base64').toString(), '**************'); assert.equal(new Buffer('KioqKioqKioqKioqKioq', 'base64').toString(), '***************'); assert.equal(new Buffer('KioqKioqKioqKioqKioqKg==', 'base64').toString(), '****************'); assert.equal(new Buffer('KioqKioqKioqKioqKioqKio=', 'base64').toString(), '*****************'); assert.equal(new Buffer('KioqKioqKioqKioqKioqKioq', 'base64').toString(), '******************'); assert.equal(new Buffer('KioqKioqKioqKioqKioqKioqKg==', 'base64').toString(), '*******************'); assert.equal(new Buffer('KioqKioqKioqKioqKioqKioqKio=', 'base64').toString(), '********************'); // no padding, not a multiple of 4 assert.equal(new Buffer('Kg', 'base64').toString(), '*'); assert.equal(new Buffer('Kio', 'base64').toString(), '**'); assert.equal(new Buffer('KioqKg', 'base64').toString(), '****'); assert.equal(new Buffer('KioqKio', 'base64').toString(), '*****'); assert.equal(new Buffer('KioqKioqKg', 'base64').toString(), '*******'); assert.equal(new Buffer('KioqKioqKio', 'base64').toString(), '********'); assert.equal(new Buffer('KioqKioqKioqKg', 'base64').toString(), '**********'); assert.equal(new Buffer('KioqKioqKioqKio', 'base64').toString(), '***********'); assert.equal(new Buffer('KioqKioqKioqKioqKg', 'base64').toString(), '*************'); assert.equal(new Buffer('KioqKioqKioqKioqKio', 'base64').toString(), '**************'); assert.equal(new Buffer('KioqKioqKioqKioqKioqKg', 'base64').toString(), '****************'); assert.equal(new Buffer('KioqKioqKioqKioqKioqKio', 'base64').toString(), '*****************'); assert.equal(new Buffer('KioqKioqKioqKioqKioqKioqKg', 'base64').toString(), '*******************'); assert.equal(new Buffer('KioqKioqKioqKioqKioqKioqKio', 'base64').toString(), '********************'); // handle padding graciously, multiple-of-4 or not assert.equal( new Buffer('72INjkR5fchcxk9+VgdGPFJDxUBFR5/rMFsghgxADiw==', 'base64').length, 32 ); assert.equal( new Buffer('72INjkR5fchcxk9+VgdGPFJDxUBFR5/rMFsghgxADiw=', 'base64').length, 32 ); assert.equal( new Buffer('72INjkR5fchcxk9+VgdGPFJDxUBFR5/rMFsghgxADiw', 'base64').length, 32 ); assert.equal( new Buffer('w69jACy6BgZmaFvv96HG6MYksWytuZu3T1FvGnulPg==', 'base64').length, 31 ); assert.equal( new Buffer('w69jACy6BgZmaFvv96HG6MYksWytuZu3T1FvGnulPg=', 'base64').length, 31 ); assert.equal( new Buffer('w69jACy6BgZmaFvv96HG6MYksWytuZu3T1FvGnulPg', 'base64').length, 31 ); // This string encodes single '.' character in UTF-16 var dot = new Buffer('//4uAA==', 'base64'); assert.equal(dot[0], 0xff); assert.equal(dot[1], 0xfe); assert.equal(dot[2], 0x2e); assert.equal(dot[3], 0x00); assert.equal(dot.toString('base64'), '//4uAA=='); { // Writing base64 at a position > 0 should not mangle the result. // // https://github.com/joyent/node/issues/402 const segments = ['TWFkbmVzcz8h', 'IFRoaXM=', 'IGlz', 'IG5vZGUuanMh']; const b = new Buffer(64); let pos = 0; for (let i = 0; i < segments.length; ++i) { pos += b.write(segments[i], pos, 'base64'); } assert.equal(b.toString('binary', 0, pos), 'Madness?! This is node.js!'); } // Regression test for https://github.com/nodejs/node/issues/3496. assert.equal(Buffer('=bad'.repeat(1e4), 'base64').length, 0); { // Creating buffers larger than pool size. const l = Buffer.poolSize + 5; const s = 'h'.repeat(l); const b = new Buffer(s); for (let i = 0; i < l; i++) { assert.equal('h'.charCodeAt(0), b[i]); } const sb = b.toString(); assert.equal(sb.length, s.length); assert.equal(sb, s); } { // Single argument slice const b = new Buffer('abcde'); assert.equal('bcde', b.slice(1).toString()); } // slice(0,0).length === 0 assert.equal(0, Buffer('hello').slice(0, 0).length); // test hex toString console.log('Create hex string from buffer'); var hexb = new Buffer(256); for (let i = 0; i < 256; i++) { hexb[i] = i; } var hexStr = hexb.toString('hex'); assert.equal(hexStr, '000102030405060708090a0b0c0d0e0f' + '101112131415161718191a1b1c1d1e1f' + '202122232425262728292a2b2c2d2e2f' + '303132333435363738393a3b3c3d3e3f' + '404142434445464748494a4b4c4d4e4f' + '505152535455565758595a5b5c5d5e5f' + '606162636465666768696a6b6c6d6e6f' + '707172737475767778797a7b7c7d7e7f' + '808182838485868788898a8b8c8d8e8f' + '909192939495969798999a9b9c9d9e9f' + 'a0a1a2a3a4a5a6a7a8a9aaabacadaeaf' + 'b0b1b2b3b4b5b6b7b8b9babbbcbdbebf' + 'c0c1c2c3c4c5c6c7c8c9cacbcccdcecf' + 'd0d1d2d3d4d5d6d7d8d9dadbdcdddedf' + 'e0e1e2e3e4e5e6e7e8e9eaebecedeeef' + 'f0f1f2f3f4f5f6f7f8f9fafbfcfdfeff'); console.log('Create buffer from hex string'); var hexb2 = new Buffer(hexStr, 'hex'); for (let i = 0; i < 256; i++) { assert.equal(hexb2[i], hexb[i]); } { // test an invalid slice end. console.log('Try to slice off the end of the buffer'); const b = new Buffer([1, 2, 3, 4, 5]); const b2 = b.toString('hex', 1, 10000); const b3 = b.toString('hex', 1, 5); const b4 = b.toString('hex', 1); assert.equal(b2, b3); assert.equal(b2, b4); } function buildBuffer(data) { if (Array.isArray(data)) { var buffer = new Buffer(data.length); data.forEach(function(v, k) { buffer[k] = v; }); return buffer; } return null; } var x = buildBuffer([0x81, 0xa3, 0x66, 0x6f, 0x6f, 0xa3, 0x62, 0x61, 0x72]); console.log(x.inspect()); assert.equal('', x.inspect()); { const z = x.slice(4); console.log(z.inspect()); console.log(z.length); assert.equal(5, z.length); assert.equal(0x6f, z[0]); assert.equal(0xa3, z[1]); assert.equal(0x62, z[2]); assert.equal(0x61, z[3]); assert.equal(0x72, z[4]); } { const z = x.slice(0); console.log(z.inspect()); console.log(z.length); assert.equal(z.length, x.length); } { const z = x.slice(0, 4); console.log(z.inspect()); console.log(z.length); assert.equal(4, z.length); assert.equal(0x81, z[0]); assert.equal(0xa3, z[1]); } { const z = x.slice(0, 9); console.log(z.inspect()); console.log(z.length); assert.equal(9, z.length); } { const z = x.slice(1, 4); console.log(z.inspect()); console.log(z.length); assert.equal(3, z.length); assert.equal(0xa3, z[0]); } { const z = x.slice(2, 4); console.log(z.inspect()); console.log(z.length); assert.equal(2, z.length); assert.equal(0x66, z[0]); assert.equal(0x6f, z[1]); } assert.equal(0, Buffer('hello').slice(0, 0).length); ['ucs2', 'ucs-2', 'utf16le', 'utf-16le'].forEach(function(encoding) { const b = new Buffer(10); b.write('あいうえお', encoding); assert.equal(b.toString(encoding), 'あいうえお'); }); { // Binary encoding should write only one byte per character. const b = Buffer([0xde, 0xad, 0xbe, 0xef]); let s = String.fromCharCode(0xffff); b.write(s, 0, 'binary'); assert.equal(0xff, b[0]); assert.equal(0xad, b[1]); assert.equal(0xbe, b[2]); assert.equal(0xef, b[3]); s = String.fromCharCode(0xaaee); b.write(s, 0, 'binary'); assert.equal(0xee, b[0]); assert.equal(0xad, b[1]); assert.equal(0xbe, b[2]); assert.equal(0xef, b[3]); } { // #1210 Test UTF-8 string includes null character let buf = new Buffer('\0'); assert.equal(buf.length, 1); buf = new Buffer('\0\0'); assert.equal(buf.length, 2); } { const buf = new Buffer(2); let written = buf.write(''); // 0byte assert.equal(written, 0); written = buf.write('\0'); // 1byte (v8 adds null terminator) assert.equal(written, 1); written = buf.write('a\0'); // 1byte * 2 assert.equal(written, 2); written = buf.write('あ'); // 3bytes assert.equal(written, 0); written = buf.write('\0あ'); // 1byte + 3bytes assert.equal(written, 1); written = buf.write('\0\0あ'); // 1byte * 2 + 3bytes assert.equal(written, 2); } { const buf = new Buffer(10); written = buf.write('あいう'); // 3bytes * 3 (v8 adds null terminator) assert.equal(written, 9); written = buf.write('あいう\0'); // 3bytes * 3 + 1byte assert.equal(written, 10); } { // #243 Test write() with maxLength const buf = new Buffer(4); buf.fill(0xFF); let written = buf.write('abcd', 1, 2, 'utf8'); console.log(buf); assert.equal(written, 2); assert.equal(buf[0], 0xFF); assert.equal(buf[1], 0x61); assert.equal(buf[2], 0x62); assert.equal(buf[3], 0xFF); buf.fill(0xFF); written = buf.write('abcd', 1, 4); console.log(buf); assert.equal(written, 3); assert.equal(buf[0], 0xFF); assert.equal(buf[1], 0x61); assert.equal(buf[2], 0x62); assert.equal(buf[3], 0x63); buf.fill(0xFF); written = buf.write('abcd', 'utf8', 1, 2); // legacy style console.log(buf); assert.equal(written, 2); assert.equal(buf[0], 0xFF); assert.equal(buf[1], 0x61); assert.equal(buf[2], 0x62); assert.equal(buf[3], 0xFF); buf.fill(0xFF); written = buf.write('abcdef', 1, 2, 'hex'); console.log(buf); assert.equal(written, 2); assert.equal(buf[0], 0xFF); assert.equal(buf[1], 0xAB); assert.equal(buf[2], 0xCD); assert.equal(buf[3], 0xFF); ['ucs2', 'ucs-2', 'utf16le', 'utf-16le'].forEach(function(encoding) { buf.fill(0xFF); written = buf.write('abcd', 0, 2, encoding); console.log(buf); assert.equal(written, 2); assert.equal(buf[0], 0x61); assert.equal(buf[1], 0x00); assert.equal(buf[2], 0xFF); assert.equal(buf[3], 0xFF); }); } { // test offset returns are correct const b = new Buffer(16); assert.equal(4, b.writeUInt32LE(0, 0)); assert.equal(6, b.writeUInt16LE(0, 4)); assert.equal(7, b.writeUInt8(0, 6)); assert.equal(8, b.writeInt8(0, 7)); assert.equal(16, b.writeDoubleLE(0, 8)); } { // test unmatched surrogates not producing invalid utf8 output // ef bf bd = utf-8 representation of unicode replacement character // see https://codereview.chromium.org/121173009/ const buf = new Buffer('ab\ud800cd', 'utf8'); assert.equal(buf[0], 0x61); assert.equal(buf[1], 0x62); assert.equal(buf[2], 0xef); assert.equal(buf[3], 0xbf); assert.equal(buf[4], 0xbd); assert.equal(buf[5], 0x63); assert.equal(buf[6], 0x64); } { // test for buffer overrun const buf = new Buffer([0, 0, 0, 0, 0]); // length: 5 var sub = buf.slice(0, 4); // length: 4 written = sub.write('12345', 'binary'); assert.equal(written, 4); assert.equal(buf[4], 0); } // Check for fractional length args, junk length args, etc. // https://github.com/joyent/node/issues/1758 // Call .fill() first, stops valgrind warning about uninitialized memory reads. Buffer(3.3).fill().toString(); // throws bad argument error in commit 43cb4ec assert.equal(Buffer(-1).length, 0); assert.equal(Buffer(NaN).length, 0); assert.equal(Buffer(3.3).length, 3); assert.equal(Buffer({length: 3.3}).length, 3); assert.equal(Buffer({length: 'BAM'}).length, 0); // Make sure that strings are not coerced to numbers. assert.equal(Buffer('99').length, 2); assert.equal(Buffer('13.37').length, 5); // Ensure that the length argument is respected. 'ascii utf8 hex base64 binary'.split(' ').forEach(function(enc) { assert.equal(Buffer(1).write('aaaaaa', 0, 1, enc), 1); }); { // Regression test, guard against buffer overrun in the base64 decoder. const a = Buffer(3); const b = Buffer('xxx'); a.write('aaaaaaaa', 'base64'); assert.equal(b.toString(), 'xxx'); } // issue GH-3416 Buffer(Buffer(0), 0, 0); [ 'hex', 'utf8', 'utf-8', 'ascii', 'binary', 'base64', 'ucs2', 'ucs-2', 'utf16le', 'utf-16le' ].forEach(function(enc) { assert.equal(Buffer.isEncoding(enc), true); }); [ 'utf9', 'utf-7', 'Unicode-FTW', 'new gnu gun' ].forEach(function(enc) { assert.equal(Buffer.isEncoding(enc), false); }); // GH-5110 (function() { const buffer = new Buffer('test'); const string = JSON.stringify(buffer); assert.equal(string, '{"type":"Buffer","data":[116,101,115,116]}'); assert.deepEqual(buffer, JSON.parse(string, function(key, value) { return value && value.type === 'Buffer' ? new Buffer(value.data) : value; })); })(); // issue GH-7849 (function() { var buf = new Buffer('test'); var json = JSON.stringify(buf); var obj = JSON.parse(json); var copy = new Buffer(obj); assert(buf.equals(copy)); })(); // issue GH-4331 assert.throws(function() { new Buffer(0xFFFFFFFF); }, RangeError); assert.throws(function() { new Buffer(0xFFFFFFFFF); }, RangeError); // attempt to overflow buffers, similar to previous bug in array buffers assert.throws(function() { var buf = new Buffer(8); buf.readFloatLE(0xffffffff); }, RangeError); assert.throws(function() { var buf = new Buffer(8); buf.writeFloatLE(0.0, 0xffffffff); }, RangeError); assert.throws(function() { var buf = new Buffer(8); buf.readFloatLE(0xffffffff); }, RangeError); assert.throws(function() { var buf = new Buffer(8); buf.writeFloatLE(0.0, 0xffffffff); }, RangeError); // ensure negative values can't get past offset assert.throws(function() { var buf = new Buffer(8); buf.readFloatLE(-1); }, RangeError); assert.throws(function() { var buf = new Buffer(8); buf.writeFloatLE(0.0, -1); }, RangeError); assert.throws(function() { var buf = new Buffer(8); buf.readFloatLE(-1); }, RangeError); assert.throws(function() { var buf = new Buffer(8); buf.writeFloatLE(0.0, -1); }, RangeError); // offset checks { const buf = new Buffer(0); assert.throws(function() { buf.readUInt8(0); }, RangeError); assert.throws(function() { buf.readInt8(0); }, RangeError); } { const buf = new Buffer([0xFF]); assert.equal(buf.readUInt8(0), 255); assert.equal(buf.readInt8(0), -1); } [16, 32].forEach(function(bits) { var buf = new Buffer(bits / 8 - 1); assert.throws(function() { buf['readUInt' + bits + 'BE'](0); }, RangeError, 'readUInt' + bits + 'BE'); assert.throws(function() { buf['readUInt' + bits + 'LE'](0); }, RangeError, 'readUInt' + bits + 'LE'); assert.throws(function() { buf['readInt' + bits + 'BE'](0); }, RangeError, 'readInt' + bits + 'BE()'); assert.throws(function() { buf['readInt' + bits + 'LE'](0); }, RangeError, 'readInt' + bits + 'LE()'); }); [16, 32].forEach(function(bits) { var buf = new Buffer([0xFF, 0xFF, 0xFF, 0xFF]); assert.equal(buf['readUInt' + bits + 'BE'](0), (0xFFFFFFFF >>> (32 - bits))); assert.equal(buf['readUInt' + bits + 'LE'](0), (0xFFFFFFFF >>> (32 - bits))); assert.equal(buf['readInt' + bits + 'BE'](0), (0xFFFFFFFF >> (32 - bits))); assert.equal(buf['readInt' + bits + 'LE'](0), (0xFFFFFFFF >> (32 - bits))); }); // test for common read(U)IntLE/BE (function() { var buf = new Buffer([0x01, 0x02, 0x03, 0x04, 0x05, 0x06]); assert.equal(buf.readUIntLE(0, 1), 0x01); assert.equal(buf.readUIntBE(0, 1), 0x01); assert.equal(buf.readUIntLE(0, 3), 0x030201); assert.equal(buf.readUIntBE(0, 3), 0x010203); assert.equal(buf.readUIntLE(0, 5), 0x0504030201); assert.equal(buf.readUIntBE(0, 5), 0x0102030405); assert.equal(buf.readUIntLE(0, 6), 0x060504030201); assert.equal(buf.readUIntBE(0, 6), 0x010203040506); assert.equal(buf.readIntLE(0, 1), 0x01); assert.equal(buf.readIntBE(0, 1), 0x01); assert.equal(buf.readIntLE(0, 3), 0x030201); assert.equal(buf.readIntBE(0, 3), 0x010203); assert.equal(buf.readIntLE(0, 5), 0x0504030201); assert.equal(buf.readIntBE(0, 5), 0x0102030405); assert.equal(buf.readIntLE(0, 6), 0x060504030201); assert.equal(buf.readIntBE(0, 6), 0x010203040506); })(); // test for common write(U)IntLE/BE (function() { var buf = new Buffer(3); buf.writeUIntLE(0x123456, 0, 3); assert.deepEqual(buf.toJSON().data, [0x56, 0x34, 0x12]); assert.equal(buf.readUIntLE(0, 3), 0x123456); buf = new Buffer(3); buf.writeUIntBE(0x123456, 0, 3); assert.deepEqual(buf.toJSON().data, [0x12, 0x34, 0x56]); assert.equal(buf.readUIntBE(0, 3), 0x123456); buf = new Buffer(3); buf.writeIntLE(0x123456, 0, 3); assert.deepEqual(buf.toJSON().data, [0x56, 0x34, 0x12]); assert.equal(buf.readIntLE(0, 3), 0x123456); buf = new Buffer(3); buf.writeIntBE(0x123456, 0, 3); assert.deepEqual(buf.toJSON().data, [0x12, 0x34, 0x56]); assert.equal(buf.readIntBE(0, 3), 0x123456); buf = new Buffer(3); buf.writeIntLE(-0x123456, 0, 3); assert.deepEqual(buf.toJSON().data, [0xaa, 0xcb, 0xed]); assert.equal(buf.readIntLE(0, 3), -0x123456); buf = new Buffer(3); buf.writeIntBE(-0x123456, 0, 3); assert.deepEqual(buf.toJSON().data, [0xed, 0xcb, 0xaa]); assert.equal(buf.readIntBE(0, 3), -0x123456); buf = new Buffer(3); buf.writeIntLE(-0x123400, 0, 3); assert.deepEqual(buf.toJSON().data, [0x00, 0xcc, 0xed]); assert.equal(buf.readIntLE(0, 3), -0x123400); buf = new Buffer(3); buf.writeIntBE(-0x123400, 0, 3); assert.deepEqual(buf.toJSON().data, [0xed, 0xcc, 0x00]); assert.equal(buf.readIntBE(0, 3), -0x123400); buf = new Buffer(3); buf.writeIntLE(-0x120000, 0, 3); assert.deepEqual(buf.toJSON().data, [0x00, 0x00, 0xee]); assert.equal(buf.readIntLE(0, 3), -0x120000); buf = new Buffer(3); buf.writeIntBE(-0x120000, 0, 3); assert.deepEqual(buf.toJSON().data, [0xee, 0x00, 0x00]); assert.equal(buf.readIntBE(0, 3), -0x120000); buf = new Buffer(5); buf.writeUIntLE(0x1234567890, 0, 5); assert.deepEqual(buf.toJSON().data, [0x90, 0x78, 0x56, 0x34, 0x12]); assert.equal(buf.readUIntLE(0, 5), 0x1234567890); buf = new Buffer(5); buf.writeUIntBE(0x1234567890, 0, 5); assert.deepEqual(buf.toJSON().data, [0x12, 0x34, 0x56, 0x78, 0x90]); assert.equal(buf.readUIntBE(0, 5), 0x1234567890); buf = new Buffer(5); buf.writeIntLE(0x1234567890, 0, 5); assert.deepEqual(buf.toJSON().data, [0x90, 0x78, 0x56, 0x34, 0x12]); assert.equal(buf.readIntLE(0, 5), 0x1234567890); buf = new Buffer(5); buf.writeIntBE(0x1234567890, 0, 5); assert.deepEqual(buf.toJSON().data, [0x12, 0x34, 0x56, 0x78, 0x90]); assert.equal(buf.readIntBE(0, 5), 0x1234567890); buf = new Buffer(5); buf.writeIntLE(-0x1234567890, 0, 5); assert.deepEqual(buf.toJSON().data, [0x70, 0x87, 0xa9, 0xcb, 0xed]); assert.equal(buf.readIntLE(0, 5), -0x1234567890); buf = new Buffer(5); buf.writeIntBE(-0x1234567890, 0, 5); assert.deepEqual(buf.toJSON().data, [0xed, 0xcb, 0xa9, 0x87, 0x70]); assert.equal(buf.readIntBE(0, 5), -0x1234567890); buf = new Buffer(5); buf.writeIntLE(-0x0012000000, 0, 5); assert.deepEqual(buf.toJSON().data, [0x00, 0x00, 0x00, 0xee, 0xff]); assert.equal(buf.readIntLE(0, 5), -0x0012000000); buf = new Buffer(5); buf.writeIntBE(-0x0012000000, 0, 5); assert.deepEqual(buf.toJSON().data, [0xff, 0xee, 0x00, 0x00, 0x00]); assert.equal(buf.readIntBE(0, 5), -0x0012000000); })(); // test Buffer slice (function() { var buf = new Buffer('0123456789'); assert.equal(buf.slice(-10, 10), '0123456789'); assert.equal(buf.slice(-20, 10), '0123456789'); assert.equal(buf.slice(-20, -10), ''); assert.equal(buf.slice(), '0123456789'); assert.equal(buf.slice(0), '0123456789'); assert.equal(buf.slice(0, 0), ''); assert.equal(buf.slice(undefined), '0123456789'); assert.equal(buf.slice('foobar'), '0123456789'); assert.equal(buf.slice(undefined, undefined), '0123456789'); assert.equal(buf.slice(2), '23456789'); assert.equal(buf.slice(5), '56789'); assert.equal(buf.slice(10), ''); assert.equal(buf.slice(5, 8), '567'); assert.equal(buf.slice(8, -1), '8'); assert.equal(buf.slice(-10), '0123456789'); assert.equal(buf.slice(0, -9), '0'); assert.equal(buf.slice(0, -10), ''); assert.equal(buf.slice(0, -1), '012345678'); assert.equal(buf.slice(2, -2), '234567'); assert.equal(buf.slice(0, 65536), '0123456789'); assert.equal(buf.slice(65536, 0), ''); assert.equal(buf.slice(-5, -8), ''); assert.equal(buf.slice(-5, -3), '56'); assert.equal(buf.slice(-10, 10), '0123456789'); for (let i = 0, s = buf.toString(); i < buf.length; ++i) { assert.equal(buf.slice(i), s.slice(i)); assert.equal(buf.slice(0, i), s.slice(0, i)); assert.equal(buf.slice(-i), s.slice(-i)); assert.equal(buf.slice(0, -i), s.slice(0, -i)); } var utf16Buf = new Buffer('0123456789', 'utf16le'); assert.deepEqual(utf16Buf.slice(0, 6), Buffer('012', 'utf16le')); assert.equal(buf.slice('0', '1'), '0'); assert.equal(buf.slice('-5', '10'), '56789'); assert.equal(buf.slice('-10', '10'), '0123456789'); assert.equal(buf.slice('-10', '-5'), '01234'); assert.equal(buf.slice('-10', '-0'), ''); assert.equal(buf.slice('111'), ''); assert.equal(buf.slice('0', '-111'), ''); // try to slice a zero length Buffer // see https://github.com/joyent/node/issues/5881 SlowBuffer(0).slice(0, 1); })(); // Regression test for #5482: should throw but not assert in C++ land. assert.throws(function() { Buffer('', 'buffer'); }, TypeError); // Regression test for #6111. Constructing a buffer from another buffer // should a) work, and b) not corrupt the source buffer. (function() { var a = [0]; for (let i = 0; i < 7; ++i) a = a.concat(a); a = a.map(function(_, i) { return i; }); const b = Buffer(a); const c = Buffer(b); assert.equal(b.length, a.length); assert.equal(c.length, a.length); for (let i = 0, k = a.length; i < k; ++i) { assert.equal(a[i], i); assert.equal(b[i], i); assert.equal(c[i], i); } })(); assert.throws(function() { new Buffer((-1 >>> 0) + 1); }, RangeError); assert.throws(function() { new SlowBuffer((-1 >>> 0) + 1); }, RangeError); if (common.hasCrypto) { // Test truncation after decode var crypto = require('crypto'); var b1 = new Buffer('YW55=======', 'base64'); var b2 = new Buffer('YW55', 'base64'); assert.equal( crypto.createHash('sha1').update(b1).digest('hex'), crypto.createHash('sha1').update(b2).digest('hex') ); } else { common.skip('missing crypto'); } // Test Compare { const b = new Buffer(1).fill('a'); const c = new Buffer(1).fill('c'); const d = new Buffer(2).fill('aa'); assert.equal(b.compare(c), -1); assert.equal(c.compare(d), 1); assert.equal(d.compare(b), 1); assert.equal(b.compare(d), -1); assert.equal(b.compare(b), 0); assert.equal(Buffer.compare(b, c), -1); assert.equal(Buffer.compare(c, d), 1); assert.equal(Buffer.compare(d, b), 1); assert.equal(Buffer.compare(b, d), -1); assert.equal(Buffer.compare(c, c), 0); assert.equal(Buffer.compare(Buffer(0), Buffer(0)), 0); assert.equal(Buffer.compare(Buffer(0), Buffer(1)), -1); assert.equal(Buffer.compare(Buffer(1), Buffer(0)), 1); } assert.throws(function() { var b = new Buffer(1); Buffer.compare(b, 'abc'); }); assert.throws(function() { var b = new Buffer(1); Buffer.compare('abc', b); }); assert.throws(function() { var b = new Buffer(1); b.compare('abc'); }); // Test Equals { const b = new Buffer(5).fill('abcdf'); const c = new Buffer(5).fill('abcdf'); const d = new Buffer(5).fill('abcde'); const e = new Buffer(6).fill('abcdef'); assert.ok(b.equals(c)); assert.ok(!c.equals(d)); assert.ok(!d.equals(e)); assert.ok(d.equals(d)); } assert.throws(function() { var b = new Buffer(1); b.equals('abc'); }); // Regression test for https://github.com/nodejs/node/issues/649. assert.throws(function() { Buffer(1422561062959).toString('utf8'); }); var ps = Buffer.poolSize; Buffer.poolSize = 0; assert.equal(Buffer(1).parent, undefined); Buffer.poolSize = ps; // Test Buffer.copy() segfault assert.throws(function() { Buffer(10).copy(); }); assert.throws(function() { new Buffer(); }, /must start with number, buffer, array or string/); assert.throws(function() { new Buffer(null); }, /must start with number, buffer, array or string/); // Test prototype getters don't throw assert.equal(Buffer.prototype.parent, undefined); assert.equal(Buffer.prototype.offset, undefined); assert.equal(SlowBuffer.prototype.parent, undefined); assert.equal(SlowBuffer.prototype.offset, undefined); { // Test that large negative Buffer length inputs don't affect the pool offset. assert.deepStrictEqual(Buffer(-Buffer.poolSize), Buffer.from('')); assert.deepStrictEqual(Buffer(-100), Buffer.from('')); assert.deepStrictEqual(Buffer.allocUnsafe(-Buffer.poolSize), Buffer.from('')); assert.deepStrictEqual(Buffer.allocUnsafe(-100), Buffer.from('')); // Check pool offset after that by trying to write string into the pool. assert.doesNotThrow(() => Buffer.from('abc')); } node-v4.8.2/test/parallel/test-c-ares.js000644 000766 000024 00000002162 13070706737 020223 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var dns = require('dns'); // Try resolution without callback dns.lookup(null, function(error, result, addressType) { assert.equal(null, result); assert.equal(4, addressType); }); dns.lookup('127.0.0.1', function(error, result, addressType) { assert.equal('127.0.0.1', result); assert.equal(4, addressType); }); dns.lookup('::1', function(error, result, addressType) { assert.equal('::1', result); assert.equal(6, addressType); }); // Try calling resolve with an unsupported type. assert.throws(function() { dns.resolve('www.google.com', 'HI'); }, /Unknown type/); // Try calling resolve with an unsupported type that's an object key assert.throws(function() { dns.resolve('www.google.com', 'toString'); }, /Unknown type/); // Windows doesn't usually have an entry for localhost 127.0.0.1 in // C:\Windows\System32\drivers\etc\hosts // so we disable this test on Windows. if (!common.isWindows) { dns.resolve('127.0.0.1', 'PTR', function(error, domains) { if (error) throw error; assert.ok(Array.isArray(domains)); }); } node-v4.8.2/test/parallel/test-child-process-bad-stdio.js000644 000766 000024 00000003231 13070706737 023452 0ustar00iojsstaff000000 000000 'use strict'; // Flags: --expose_internals const common = require('../common'); const assert = require('assert'); const cp = require('child_process'); if (process.argv[2] === 'child') { setTimeout(() => {}, common.platformTimeout(100)); return; } // Monkey patch spawn() to create a child process normally, but destroy the // stdout and stderr streams. This replicates the conditions where the streams // cannot be properly created. const ChildProcess = require('internal/child_process').ChildProcess; const original = ChildProcess.prototype.spawn; ChildProcess.prototype.spawn = function() { const err = original.apply(this, arguments); this.stdout.destroy(); this.stderr.destroy(); this.stdout = null; this.stderr = null; return err; }; function createChild(options, callback) { const cmd = `${process.execPath} ${__filename} child`; return cp.exec(cmd, options, common.mustCall(callback)); } // Verify that normal execution of a child process is handled. { createChild({}, (err, stdout, stderr) => { assert.strictEqual(err, null); assert.strictEqual(stdout, ''); assert.strictEqual(stderr, ''); }); } // Verify that execution with an error event is handled. { const error = new Error('foo'); const child = createChild({}, (err, stdout, stderr) => { assert.strictEqual(err, error); assert.strictEqual(stdout, ''); assert.strictEqual(stderr, ''); }); child.emit('error', error); } // Verify that execution with a killed process is handled. { createChild({ timeout: 1 }, (err, stdout, stderr) => { assert.strictEqual(err.killed, true); assert.strictEqual(stdout, ''); assert.strictEqual(stderr, ''); }); } node-v4.8.2/test/parallel/test-child-process-buffering.js000644 000766 000024 00000001203 13070706737 023550 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); function pwd(callback) { var output = ''; var child = common.spawnPwd(); child.stdout.setEncoding('utf8'); child.stdout.on('data', function(s) { console.log('stdout: ' + JSON.stringify(s)); output += s; }); child.on('exit', common.mustCall(function(c) { console.log('exit: ' + c); assert.equal(0, c); })); child.on('close', common.mustCall(function() { callback(output); })); } pwd(function(result) { console.dir(result); assert.equal(true, result.length > 1); assert.equal('\n', result[result.length - 1]); }); node-v4.8.2/test/parallel/test-child-process-constructor.js000644 000766 000024 00000001124 13070706737 024170 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var child_process = require('child_process'); var ChildProcess = child_process.ChildProcess; assert.strictEqual(typeof ChildProcess, 'function'); // test that we can call spawn var child = new ChildProcess(); child.spawn({ file: process.execPath, args: ['--interactive'], cwd: process.cwd(), stdio: 'pipe' }); assert.strictEqual(child.hasOwnProperty('pid'), true); // try killing with invalid signal assert.throws(function() { child.kill('foo'); }, /Unknown signal: foo/); assert.strictEqual(child.kill(), true); node-v4.8.2/test/parallel/test-child-process-cwd.js000644 000766 000024 00000003140 13070706737 022360 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var returns = 0; /* Spawns 'pwd' with given options, then test - whether the exit code equals forCode, - optionally whether the stdout result matches forData (after removing traling whitespace) */ function testCwd(options, forCode, forData) { var data = ''; var child = common.spawnPwd(options); child.stdout.setEncoding('utf8'); child.stdout.on('data', function(chunk) { data += chunk; }); child.on('exit', function(code, signal) { assert.strictEqual(forCode, code); }); child.on('close', function() { forData && assert.strictEqual(forData, data.replace(/[\s\r\n]+$/, '')); returns--; }); returns++; return child; } // Assume these exist, and 'pwd' gives us the right directory back testCwd({cwd: common.rootDir}, 0, common.rootDir); if (common.isWindows) { testCwd({cwd: process.env.windir}, 0, process.env.windir); } else { testCwd({cwd: '/dev'}, 0, '/dev'); } // Assume does-not-exist doesn't exist, expect exitCode=-1 and errno=ENOENT (function() { var errors = 0; testCwd({cwd: 'does-not-exist'}, -1).on('error', function(e) { assert.equal(e.code, 'ENOENT'); errors++; }); process.on('exit', function() { assert.equal(errors, 1); }); })(); // Spawn() shouldn't try to chdir() so this should just work testCwd(undefined, 0); testCwd({}, 0); testCwd({cwd: ''}, 0); testCwd({cwd: undefined}, 0); testCwd({cwd: null}, 0); // Check whether all tests actually returned assert.notEqual(0, returns); process.on('exit', function() { assert.equal(0, returns); }); node-v4.8.2/test/parallel/test-child-process-default-options.js000644 000766 000024 00000001121 13070706737 024715 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var spawn = require('child_process').spawn; process.env.HELLO = 'WORLD'; var child; if (common.isWindows) { child = spawn('cmd.exe', ['/c', 'set'], {}); } else { child = spawn('/usr/bin/env', [], {}); } var response = ''; child.stdout.setEncoding('utf8'); child.stdout.on('data', function(chunk) { console.log('stdout: ' + chunk); response += chunk; }); process.on('exit', function() { assert.ok(response.indexOf('HELLO=WORLD') >= 0, 'spawn did not use process.env as default'); }); node-v4.8.2/test/parallel/test-child-process-detached.js000644 000766 000024 00000001216 13070706737 023346 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var path = require('path'); var spawn = require('child_process').spawn; var childPath = path.join(common.fixturesDir, 'parent-process-nonpersistent.js'); var persistentPid = -1; var child = spawn(process.execPath, [ childPath ]); child.stdout.on('data', function(data) { persistentPid = parseInt(data, 10); }); process.on('exit', function() { assert(persistentPid !== -1); assert.throws(function() { process.kill(child.pid); }, /^Error: kill ESRCH$/); assert.doesNotThrow(function() { process.kill(persistentPid); }); }); node-v4.8.2/test/parallel/test-child-process-disconnect.js000644 000766 000024 00000004473 13070706737 023746 0ustar00iojsstaff000000 000000 'use strict'; var assert = require('assert'); var common = require('../common'); var fork = require('child_process').fork; var net = require('net'); // child if (process.argv[2] === 'child') { // Check that the 'disconnect' event is deferred to the next event loop tick. var disconnect = process.disconnect; process.disconnect = function() { disconnect.apply(this, arguments); // If the event is emitted synchronously, we're too late by now. process.once('disconnect', common.mustCall(disconnectIsNotAsync)); // The funky function name makes it show up legible in mustCall errors. function disconnectIsNotAsync() {} }; var server = net.createServer(); server.on('connection', function(socket) { socket.resume(); process.on('disconnect', function() { socket.end((process.connected).toString()); }); // when the socket is closed, we will close the server // allowing the process to self terminate socket.on('end', function() { server.close(); }); socket.write('ready'); }); // when the server is ready tell parent server.on('listening', function() { process.send({ msg: 'ready', port: server.address().port }); }); server.listen(0); } else { // testcase var child = fork(process.argv[1], ['child']); var childFlag = false; var parentFlag = false; // when calling .disconnect the event should emit // and the disconnected flag should be true. child.on('disconnect', common.mustCall(function() { parentFlag = child.connected; })); // the process should also self terminate without using signals child.on('exit', common.mustCall(function() {})); // when child is listening child.on('message', function(obj) { if (obj && obj.msg === 'ready') { // connect to child using TCP to know if disconnect was emitted var socket = net.connect(obj.port); socket.on('data', function(data) { data = data.toString(); // ready to be disconnected if (data === 'ready') { child.disconnect(); assert.throws(child.disconnect.bind(child), Error); return; } // disconnect is emitted childFlag = (data === 'true'); }); } }); process.on('exit', function() { assert.equal(childFlag, false); assert.equal(parentFlag, false); }); } node-v4.8.2/test/parallel/test-child-process-double-pipe.js000644 000766 000024 00000004203 13070706737 024011 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const os = require('os'); const util = require('util'); const spawn = require('child_process').spawn; // We're trying to reproduce: // $ echo "hello\nnode\nand\nworld" | grep o | sed s/o/a/ var grep, sed, echo; if (common.isWindows) { grep = spawn('grep', ['--binary', 'o']), sed = spawn('sed', ['--binary', 's/o/O/']), echo = spawn('cmd.exe', ['/c', 'echo', 'hello&&', 'echo', 'node&&', 'echo', 'and&&', 'echo', 'world']); } else { grep = spawn('grep', ['o']), sed = spawn('sed', ['s/o/O/']), echo = spawn('echo', ['hello\nnode\nand\nworld\n']); } /* * grep and sed hang if the spawn function leaks file descriptors to child * processes. * This happens when calling pipe(2) and then forgetting to set the * FD_CLOEXEC flag on the resulting file descriptors. * * This test checks child processes exit, meaning they don't hang like * explained above. */ // pipe echo | grep echo.stdout.on('data', function(data) { console.error('grep stdin write ' + data.length); if (!grep.stdin.write(data)) { echo.stdout.pause(); } }); grep.stdin.on('drain', function(data) { echo.stdout.resume(); }); // propagate end from echo to grep echo.stdout.on('end', function(code) { grep.stdin.end(); }); echo.on('exit', function() { console.error('echo exit'); }); grep.on('exit', function() { console.error('grep exit'); }); sed.on('exit', function() { console.error('sed exit'); }); // pipe grep | sed grep.stdout.on('data', function(data) { console.error('grep stdout ' + data.length); if (!sed.stdin.write(data)) { grep.stdout.pause(); } }); sed.stdin.on('drain', function(data) { grep.stdout.resume(); }); // propagate end from grep to sed grep.stdout.on('end', function(code) { console.error('grep stdout end'); sed.stdin.end(); }); var result = ''; // print sed's output sed.stdout.on('data', function(data) { result += data.toString('utf8', 0, data.length); util.print(data); }); sed.stdout.on('end', function(code) { assert.strictEqual(result, `hellO${os.EOL}nOde${os.EOL}wOrld${os.EOL}`); }); node-v4.8.2/test/parallel/test-child-process-env.js000644 000766 000024 00000001216 13070706737 022375 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var spawn = require('child_process').spawn; var env = { 'HELLO': 'WORLD' }; Object.setPrototypeOf(env, { 'FOO': 'BAR' }); var child; if (common.isWindows) { child = spawn('cmd.exe', ['/c', 'set'], {env: env}); } else { child = spawn('/usr/bin/env', [], {env: env}); } var response = ''; child.stdout.setEncoding('utf8'); child.stdout.on('data', function(chunk) { console.log('stdout: ' + chunk); response += chunk; }); process.on('exit', function() { assert.ok(response.indexOf('HELLO=WORLD') >= 0); assert.ok(response.indexOf('FOO=BAR') >= 0); }); node-v4.8.2/test/parallel/test-child-process-exec-buffer.js000644 000766 000024 00000001401 13070706737 023774 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var exec = require('child_process').exec; var os = require('os'); var str = 'hello'; // default encoding exec('echo ' + str, common.mustCall(function(err, stdout, stderr) { assert.ok('string', typeof stdout, 'Expected stdout to be a string'); assert.ok('string', typeof stderr, 'Expected stderr to be a string'); assert.equal(str + os.EOL, stdout); })); // no encoding (Buffers expected) exec('echo ' + str, { encoding: null }, common.mustCall(function(err, stdout, stderr) { assert.ok(stdout instanceof Buffer, 'Expected stdout to be a Buffer'); assert.ok(stderr instanceof Buffer, 'Expected stderr to be a Buffer'); assert.equal(str + os.EOL, stdout.toString()); })); node-v4.8.2/test/parallel/test-child-process-exec-cwd.js000644 000766 000024 00000000641 13070706737 023305 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var exec = require('child_process').exec; var pwdcommand, dir; if (common.isWindows) { pwdcommand = 'echo %cd%'; dir = 'c:\\windows'; } else { pwdcommand = 'pwd'; dir = '/dev'; } exec(pwdcommand, {cwd: dir}, common.mustCall(function(err, stdout, stderr) { assert.ifError(err); assert.ok(stdout.indexOf(dir) == 0); })); node-v4.8.2/test/parallel/test-child-process-exec-env.js000644 000766 000024 00000001740 13070706737 023321 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var exec = require('child_process').exec; var success_count = 0; var error_count = 0; var response = ''; var child; function after(err, stdout, stderr) { if (err) { error_count++; console.log('error!: ' + err.code); console.log('stdout: ' + JSON.stringify(stdout)); console.log('stderr: ' + JSON.stringify(stderr)); assert.equal(false, err.killed); } else { success_count++; assert.equal(true, stdout != ''); } } if (!common.isWindows) { child = exec('/usr/bin/env', { env: { 'HELLO': 'WORLD' } }, after); } else { child = exec('set', { env: { 'HELLO': 'WORLD' } }, after); } child.stdout.setEncoding('utf8'); child.stdout.on('data', function(chunk) { response += chunk; }); process.on('exit', function() { console.log('response: ', response); assert.equal(1, success_count); assert.equal(0, error_count); assert.ok(response.indexOf('HELLO=WORLD') >= 0); }); node-v4.8.2/test/parallel/test-child-process-exec-error.js000644 000766 000024 00000000751 13070706737 023663 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var child_process = require('child_process'); function test(fun, code) { fun('does-not-exist', common.mustCall(function(err) { assert.equal(err.code, code); assert(/does\-not\-exist/.test(err.cmd)); })); } if (common.isWindows) { test(child_process.exec, 1); // exit code of cmd.exe } else { test(child_process.exec, 127); // exit code of /bin/sh } test(child_process.execFile, 'ENOENT'); node-v4.8.2/test/parallel/test-child-process-exec-maxBuffer.js000644 000766 000024 00000001337 13070706737 024452 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const cp = require('child_process'); function checkFactory(streamName) { return common.mustCall((err) => { const message = `${streamName} maxBuffer exceeded`; assert.strictEqual(err.message, message); }); } { const cmd = 'echo "hello world"'; cp.exec(cmd, { maxBuffer: 5 }, checkFactory('stdout')); } const unicode = '中文测试'; // length = 4, byte length = 12 { const cmd = `"${process.execPath}" -e "console.log('${unicode}');"`; cp.exec(cmd, {maxBuffer: 10}, checkFactory('stdout')); } { const cmd = `"${process.execPath}" -e "console.('${unicode}');"`; cp.exec(cmd, {maxBuffer: 10}, checkFactory('stderr')); } node-v4.8.2/test/parallel/test-child-process-exec-stdout-stderr-data-string.js000644 000766 000024 00000001042 13070706737 027562 0ustar00iojsstaff000000 000000 'use strict'; // Refs: https://github.com/nodejs/node/issues/7342 const common = require('../common'); const assert = require('assert'); const exec = require('child_process').exec; var stdoutCalls = 0; var stderrCalls = 0; const command = common.isWindows ? 'dir' : 'ls'; exec(command).stdout.on('data', (data) => { stdoutCalls += 1; }); exec('fhqwhgads').stderr.on('data', (data) => { assert.strictEqual(typeof data, 'string'); stderrCalls += 1; }); process.on('exit', () => { assert(stdoutCalls > 0); assert(stderrCalls > 0); }); node-v4.8.2/test/parallel/test-child-process-exit-code.js000644 000766 000024 00000001304 13070706737 023464 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var spawn = require('child_process').spawn; var path = require('path'); var exitScript = path.join(common.fixturesDir, 'exit.js'); var exitChild = spawn(process.argv[0], [exitScript, 23]); exitChild.on('exit', common.mustCall(function(code, signal) { assert.strictEqual(code, 23); assert.strictEqual(signal, null); })); var errorScript = path.join(common.fixturesDir, 'child_process_should_emit_error.js'); var errorChild = spawn(process.argv[0], [errorScript]); errorChild.on('exit', common.mustCall(function(code, signal) { assert.ok(code !== 0); assert.strictEqual(signal, null); })); node-v4.8.2/test/parallel/test-child-process-flush-stdio.js000644 000766 000024 00000001576 13070706737 024057 0ustar00iojsstaff000000 000000 'use strict'; const cp = require('child_process'); const common = require('../common'); const assert = require('assert'); // Windows' `echo` command is a built-in shell command and not an external // executable like on *nix const opts = { shell: common.isWindows }; const p = cp.spawn('echo', [], opts); p.on('close', common.mustCall(function(code, signal) { assert.strictEqual(code, 0); assert.strictEqual(signal, null); spawnWithReadable(); })); p.stdout.read(); function spawnWithReadable() { const buffer = []; const p = cp.spawn('echo', ['123'], opts); p.on('close', common.mustCall(function(code, signal) { assert.strictEqual(code, 0); assert.strictEqual(signal, null); assert.strictEqual(Buffer.concat(buffer).toString().trim(), '123'); })); p.stdout.on('readable', function() { let buf; while (buf = this.read()) buffer.push(buf); }); } node-v4.8.2/test/parallel/test-child-process-fork-and-spawn.js000644 000766 000024 00000001172 13070706737 024435 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var spawn = require('child_process').spawn; var fork = require('child_process').fork; // Fork, then spawn. The spawned process should not hang. switch (process.argv[2] || '') { case '': fork(__filename, ['fork']).on('exit', common.mustCall(checkExit)); break; case 'fork': spawn(process.execPath, [__filename, 'spawn']) .on('exit', common.mustCall(checkExit)); break; case 'spawn': break; default: assert(0); } function checkExit(statusCode) { assert.equal(statusCode, 0); process.nextTick(process.exit); } node-v4.8.2/test/parallel/test-child-process-fork-close.js000644 000766 000024 00000001243 13070706737 023651 0ustar00iojsstaff000000 000000 'use strict'; const assert = require('assert'); const common = require('../common'); const fork = require('child_process').fork; var cp = fork(common.fixturesDir + '/child-process-message-and-exit.js'); let gotMessage = false; let gotExit = false; let gotClose = false; cp.on('message', common.mustCall(function(message) { assert(!gotMessage); assert(!gotClose); assert.strictEqual(message, 'hello'); gotMessage = true; })); cp.on('exit', common.mustCall(function() { assert(!gotExit); assert(!gotClose); gotExit = true; })); cp.on('close', common.mustCall(function() { assert(gotMessage); assert(gotExit); assert(!gotClose); gotClose = true; })); node-v4.8.2/test/parallel/test-child-process-fork-dgram.js000644 000766 000024 00000004254 13070706737 023643 0ustar00iojsstaff000000 000000 'use strict'; /* * The purpose of this test is to make sure that when forking a process, * sending a fd representing a UDP socket to the child and sending messages * to this endpoint, these messages are distributed to the parent and the * child process. */ const common = require('../common'); const dgram = require('dgram'); const fork = require('child_process').fork; const assert = require('assert'); if (common.isWindows) { common.skip('Sending dgram sockets to child processes is not supported'); return; } if (process.argv[2] === 'child') { let childServer; process.once('message', function(msg, clusterServer) { childServer = clusterServer; childServer.once('message', function() { process.send('gotMessage'); childServer.close(); }); process.send('handleReceived'); }); } else { const parentServer = dgram.createSocket('udp4'); const client = dgram.createSocket('udp4'); const child = fork(__filename, ['child']); const msg = Buffer.from('Some bytes'); var childGotMessage = false; var parentGotMessage = false; parentServer.once('message', function(msg, rinfo) { parentGotMessage = true; parentServer.close(); }); parentServer.on('listening', function() { child.send('server', parentServer); child.on('message', function(msg) { if (msg === 'gotMessage') { childGotMessage = true; } else if (msg = 'handlReceived') { sendMessages(); } }); }); const sendMessages = function() { const serverPort = parentServer.address().port; const timer = setInterval(function() { /* * Both the parent and the child got at least one message, * test passed, clean up everyting. */ if (parentGotMessage && childGotMessage) { clearInterval(timer); client.close(); } else { client.send( msg, 0, msg.length, serverPort, '127.0.0.1', function(err) { if (err) throw err; } ); } }, 1); }; parentServer.bind(0, '127.0.0.1'); process.once('exit', function() { assert(parentGotMessage); assert(childGotMessage); }); } node-v4.8.2/test/parallel/test-child-process-fork-exec-argv.js000644 000766 000024 00000001334 13070706737 024426 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var child_process = require('child_process'); var spawn = child_process.spawn; var fork = child_process.fork; if (process.argv[2] === 'fork') { process.stdout.write(JSON.stringify(process.execArgv), function() { process.exit(); }); } else if (process.argv[2] === 'child') { fork(__filename, ['fork']); } else { var execArgv = ['--harmony_proxies', '--stack-size=256']; var args = [__filename, 'child', 'arg0']; var child = spawn(process.execPath, execArgv.concat(args)); var out = ''; child.stdout.on('data', function(chunk) { out += chunk; }); child.on('exit', function() { assert.deepEqual(JSON.parse(out), execArgv); }); } node-v4.8.2/test/parallel/test-child-process-fork-exec-path.js000644 000766 000024 00000001777 13070706737 024436 0ustar00iojsstaff000000 000000 'use strict'; var assert = require('assert'); var fs = require('fs'); var path = require('path'); var common = require('../common'); var msg = {test: 'this'}; var nodePath = process.execPath; var copyPath = path.join(common.tmpDir, 'node-copy.exe'); if (process.env.FORK) { assert(process.send); assert.equal(process.argv[0], copyPath); process.send(msg); process.exit(); } else { common.refreshTmpDir(); try { fs.unlinkSync(copyPath); } catch (e) { if (e.code !== 'ENOENT') throw e; } fs.writeFileSync(copyPath, fs.readFileSync(nodePath)); fs.chmodSync(copyPath, '0755'); // slow but simple var envCopy = JSON.parse(JSON.stringify(process.env)); envCopy.FORK = 'true'; var child = require('child_process').fork(__filename, { execPath: copyPath, env: envCopy }); child.on('message', common.mustCall(function(recv) { assert.deepEqual(msg, recv); })); child.on('exit', common.mustCall(function(code) { fs.unlinkSync(copyPath); assert.equal(code, 0); })); } node-v4.8.2/test/parallel/test-child-process-fork-net.js000644 000766 000024 00000011615 13070706737 023336 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const fork = require('child_process').fork; const net = require('net'); // progress tracker function ProgressTracker(missing, callback) { this.missing = missing; this.callback = callback; } ProgressTracker.prototype.done = function() { this.missing -= 1; this.check(); }; ProgressTracker.prototype.check = function() { if (this.missing === 0) this.callback(); }; if (process.argv[2] === 'child') { var serverScope; process.on('message', function onServer(msg, server) { if (msg.what !== 'server') return; process.removeListener('message', onServer); serverScope = server; server.on('connection', function(socket) { console.log('CHILD: got connection'); process.send({what: 'connection'}); socket.destroy(); }); // start making connection from parent console.log('CHILD: server listening'); process.send({what: 'listening'}); }); process.on('message', function onClose(msg) { if (msg.what !== 'close') return; process.removeListener('message', onClose); serverScope.on('close', function() { process.send({what: 'close'}); }); serverScope.close(); }); process.on('message', function onSocket(msg, socket) { if (msg.what !== 'socket') return; process.removeListener('message', onSocket); socket.end('echo'); console.log('CHILD: got socket'); }); process.send({what: 'ready'}); } else { var child = fork(process.argv[1], ['child']); child.on('exit', function() { console.log('CHILD: died'); }); // send net.Server to child and test by connecting var testServer = function(callback) { // destroy server execute callback when done var progress = new ProgressTracker(2, function() { server.on('close', function() { console.log('PARENT: server closed'); child.send({what: 'close'}); }); server.close(); }); // we expect 4 connections and close events var connections = new ProgressTracker(4, progress.done.bind(progress)); var closed = new ProgressTracker(4, progress.done.bind(progress)); // create server and send it to child var server = net.createServer(); server.on('connection', function(socket) { console.log('PARENT: got connection'); socket.destroy(); connections.done(); }); server.on('listening', function() { console.log('PARENT: server listening'); child.send({what: 'server'}, server); }); server.listen(0); // handle client messages var messageHandlers = function(msg) { if (msg.what === 'listening') { // make connections var socket; for (var i = 0; i < 4; i++) { socket = net.connect(server.address().port, function() { console.log('CLIENT: connected'); }); socket.on('close', function() { closed.done(); console.log('CLIENT: closed'); }); } } else if (msg.what === 'connection') { // child got connection connections.done(); } else if (msg.what === 'close') { child.removeListener('message', messageHandlers); callback(); } }; child.on('message', messageHandlers); }; // send net.Socket to child var testSocket = function(callback) { // create a new server and connect to it, // but the socket will be handled by the child var server = net.createServer(); server.on('connection', function(socket) { socket.on('close', function() { console.log('CLIENT: socket closed'); }); child.send({what: 'socket'}, socket); }); server.on('close', function() { console.log('PARENT: server closed'); callback(); }); // don't listen on the same port, because SmartOS sometimes says // that the server's fd is closed, but it still cannot listen // on the same port again. // // An isolated test for this would be lovely, but for now, this // will have to do. server.listen(0, function() { console.error('testSocket, listening'); var connect = net.connect(server.address().port); var store = ''; connect.on('data', function(chunk) { store += chunk; console.log('CLIENT: got data'); }); connect.on('close', function() { console.log('CLIENT: closed'); assert.equal(store, 'echo'); server.close(); }); }); }; // create server and send it to child var serverSuccess = false; var socketSuccess = false; child.on('message', function onReady(msg) { if (msg.what !== 'ready') return; child.removeListener('message', onReady); testServer(function() { serverSuccess = true; testSocket(function() { socketSuccess = true; child.kill(); }); }); }); process.on('exit', function() { assert.ok(serverSuccess); assert.ok(socketSuccess); }); } node-v4.8.2/test/parallel/test-child-process-fork-net2.js000644 000766 000024 00000006477 13070706737 023432 0ustar00iojsstaff000000 000000 'use strict'; var assert = require('assert'); var common = require('../common'); var fork = require('child_process').fork; var net = require('net'); var count = 12; if (process.argv[2] === 'child') { var needEnd = []; var id = process.argv[3]; process.on('message', function(m, socket) { if (!socket) return; console.error('[%d] got socket', id, m); // will call .end('end') or .write('write'); socket[m](m); socket.resume(); socket.on('data', function() { console.error('[%d] socket.data', id, m); }); socket.on('end', function() { console.error('[%d] socket.end', id, m); }); // store the unfinished socket if (m === 'write') { needEnd.push(socket); } socket.on('close', function(had_error) { console.error('[%d] socket.close', id, had_error, m); }); socket.on('finish', function() { console.error('[%d] socket finished', id, m); }); }); process.on('message', function(m) { if (m !== 'close') return; console.error('[%d] got close message', id); needEnd.forEach(function(endMe, i) { console.error('[%d] ending %d/%d', id, i, needEnd.length); endMe.end('end'); }); }); process.on('disconnect', function() { console.error('[%d] process disconnect, ending', id); needEnd.forEach(function(endMe, i) { console.error('[%d] ending %d/%d', id, i, needEnd.length); endMe.end('end'); }); }); } else { var child1 = fork(process.argv[1], ['child', '1']); var child2 = fork(process.argv[1], ['child', '2']); var child3 = fork(process.argv[1], ['child', '3']); var server = net.createServer(); let connected = 0; let closed = 0; server.on('connection', function(socket) { switch (connected % 6) { case 0: child1.send('end', socket); break; case 1: child1.send('write', socket); break; case 2: child2.send('end', socket); break; case 3: child2.send('write', socket); break; case 4: child3.send('end', socket); break; case 5: child3.send('write', socket); break; } connected += 1; socket.once('close', function() { console.log('[m] socket closed, total %d', ++closed); }); if (connected === count) { closeServer(); } }); var disconnected = 0; server.on('listening', function() { var j = count, client; while (j--) { client = net.connect(this.address().port, '127.0.0.1'); client.on('error', function() { // This can happen if we kill the child too early. // The client should still get a close event afterwards. console.error('[m] CLIENT: error event'); }); client.on('close', function() { console.error('[m] CLIENT: close event'); disconnected += 1; }); } }); var closeEmitted = false; server.on('close', common.mustCall(function() { closeEmitted = true; child1.kill(); child2.kill(); child3.kill(); })); server.listen(0, '127.0.0.1'); var closeServer = function() { server.close(); setTimeout(function() { assert(!closeEmitted); child1.send('close'); child2.send('close'); child3.disconnect(); }, 200); }; process.on('exit', function() { assert.equal(disconnected, count); assert.equal(connected, count); }); } node-v4.8.2/test/parallel/test-child-process-fork-ref.js000644 000766 000024 00000001342 13070706737 023320 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var fork = require('child_process').fork; if (process.argv[2] === 'child') { process.send('1'); // check that child don't instantly die setTimeout(function() { process.send('2'); }, 200); process.on('disconnect', function() { process.stdout.write('3'); }); } else { var child = fork(__filename, ['child'], {silent: true}); var ipc = [], stdout = ''; child.on('message', function(msg) { ipc.push(msg); if (msg === '2') child.disconnect(); }); child.stdout.on('data', function(chunk) { stdout += chunk; }); child.once('exit', function() { assert.deepEqual(ipc, ['1', '2']); assert.equal(stdout, '3'); }); } node-v4.8.2/test/parallel/test-child-process-fork-ref2.js000644 000766 000024 00000001025 13070706737 023400 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var fork = require('child_process').fork; if (process.argv[2] === 'child') { console.log('child -> call disconnect'); process.disconnect(); setTimeout(function() { console.log('child -> will this keep it alive?'); process.on('message', function() { }); }, 400); } else { var child = fork(__filename, ['child']); child.on('disconnect', function() { console.log('parent -> disconnect'); }); child.once('exit', function() { console.log('parent -> exit'); }); } node-v4.8.2/test/parallel/test-child-process-fork-regr-gh-2847.js000644 000766 000024 00000003220 13070706737 024476 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const cluster = require('cluster'); const net = require('net'); if (!cluster.isMaster) { // Exit on first received handle to leave the queue non-empty in master process.on('message', function() { process.exit(1); }); return; } var server = net.createServer(function(s) { if (common.isWindows) { s.on('error', function(err) { // Prevent possible ECONNRESET errors from popping up if (err.code !== 'ECONNRESET') throw err; }); } setTimeout(function() { s.destroy(); }, 100); }).listen(0, function() { var worker = cluster.fork(); function send(callback) { var s = net.connect(server.address().port, function() { worker.send({}, s, callback); }); // Errors can happen if this connection // is still happening while the server has been closed. s.on('error', function(err) { if ((err.code !== 'ECONNRESET') && ((err.code !== 'ECONNREFUSED'))) { throw err; } }); } worker.process.once('close', common.mustCall(function() { // Otherwise the crash on `_channel.fd` access may happen assert(worker.process._channel === null); server.close(); })); worker.on('online', function() { send(function(err) { assert.ifError(err); send(function(err) { // Ignore errors when sending the second handle because the worker // may already have exited. if (err) { if ((err.message !== 'channel closed') && (err.code !== 'ECONNREFUSED')) { throw err; } } }); }); }); }); node-v4.8.2/test/parallel/test-child-process-fork.js000644 000766 000024 00000001315 13070706737 022546 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var fork = require('child_process').fork; var args = ['foo', 'bar']; var n = fork(common.fixturesDir + '/child-process-spawn-node.js', args); assert.deepEqual(args, ['foo', 'bar']); n.on('message', function(m) { console.log('PARENT got message:', m); assert.ok(m.foo); }); // https://github.com/joyent/node/issues/2355 - JSON.stringify(undefined) // returns "undefined" but JSON.parse() cannot parse that... assert.throws(function() { n.send(undefined); }, TypeError); assert.throws(function() { n.send(); }, TypeError); n.send({ hello: 'world' }); n.on('exit', common.mustCall(function(c) { assert.strictEqual(c, 0); })); node-v4.8.2/test/parallel/test-child-process-fork3.js000644 000766 000024 00000000251 13070706737 022627 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var child_process = require('child_process'); child_process.fork(common.fixturesDir + '/empty.js'); // should not hang node-v4.8.2/test/parallel/test-child-process-internal.js000644 000766 000024 00000001325 13070706737 023422 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); //messages var PREFIX = 'NODE_'; var normal = {cmd: 'foo' + PREFIX}; var internal = {cmd: PREFIX + 'bar'}; if (process.argv[2] === 'child') { //send non-internal message containing PREFIX at a non prefix position process.send(normal); //send inernal message process.send(internal); process.exit(0); } else { var fork = require('child_process').fork; var child = fork(process.argv[1], ['child']); child.once('message', common.mustCall(function(data) { assert.deepStrictEqual(data, normal); })); child.once('internalMessage', common.mustCall(function(data) { assert.deepStrictEqual(data, internal); })); } node-v4.8.2/test/parallel/test-child-process-ipc.js000644 000766 000024 00000002041 13070706737 022355 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const spawn = require('child_process').spawn; const path = require('path'); const sub = path.join(common.fixturesDir, 'echo.js'); let gotHelloWorld = false; let gotEcho = false; const child = spawn(process.argv[0], [sub]); child.stderr.on('data', function(data) { console.log('parent stderr: ' + data); }); child.stdout.setEncoding('utf8'); child.stdout.on('data', function(data) { console.log('child said: ' + JSON.stringify(data)); if (!gotHelloWorld) { console.error('testing for hello world'); assert.strictEqual('hello world\r\n', data); gotHelloWorld = true; console.error('writing echo me'); child.stdin.write('echo me\r\n'); } else { console.error('testing for echo me'); assert.equal('echo me\r\n', data); gotEcho = true; child.stdin.end(); } }); child.stdout.on('end', function(data) { console.log('child end'); }); process.on('exit', function() { assert.ok(gotHelloWorld); assert.ok(gotEcho); }); node-v4.8.2/test/parallel/test-child-process-kill.js000644 000766 000024 00000001030 13070706737 022532 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var spawn = require('child_process').spawn; var cat = spawn(common.isWindows ? 'cmd' : 'cat'); cat.stdout.on('end', common.mustCall(function() {})); cat.stderr.on('data', common.fail); cat.stderr.on('end', common.mustCall(function() {})); cat.on('exit', common.mustCall(function(code, signal) { assert.strictEqual(code, null); assert.strictEqual(signal, 'SIGTERM'); })); assert.equal(cat.killed, false); cat.kill(); assert.equal(cat.killed, true); node-v4.8.2/test/parallel/test-child-process-recv-handle.js000644 000766 000024 00000003417 13070706737 024002 0ustar00iojsstaff000000 000000 'use strict'; // Test that a Linux specific quirk in the handle passing protocol is handled // correctly. See https://github.com/joyent/node/issues/5330 for details. var common = require('../common'); var assert = require('assert'); var net = require('net'); var spawn = require('child_process').spawn; if (process.argv[2] === 'worker') worker(); else master(); function master() { // spawn() can only create one IPC channel so we use stdin/stdout as an // ad-hoc command channel. var proc = spawn(process.execPath, [__filename, 'worker'], { stdio: ['pipe', 'pipe', 'pipe', 'ipc'] }); var handle = null; proc.on('exit', function() { handle.close(); }); proc.stdout.on('data', function(data) { assert.equal(data, 'ok\r\n'); net.createServer(common.fail).listen(0, function() { handle = this._handle; proc.send('one'); proc.send('two', handle); proc.send('three'); proc.stdin.write('ok\r\n'); }); }); proc.stderr.pipe(process.stderr); } function worker() { process._channel.readStop(); // Make messages batch up. process.stdout.ref(); process.stdout.write('ok\r\n'); process.stdin.once('data', function(data) { assert.equal(data, 'ok\r\n'); process._channel.readStart(); }); var n = 0; process.on('message', function(msg, handle) { n += 1; if (n === 1) { assert.equal(msg, 'one'); assert.equal(handle, undefined); } else if (n === 2) { assert.equal(msg, 'two'); assert.equal(typeof handle, 'object'); // Also matches null, therefore... assert.ok(handle); // also check that it's truthy. handle.close(); } else if (n === 3) { assert.equal(msg, 'three'); assert.equal(handle, undefined); process.exit(); } }); } node-v4.8.2/test/parallel/test-child-process-send-cb.js000644 000766 000024 00000001103 13070706737 023113 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const fork = require('child_process').fork; if (process.argv[2] === 'child') { process.send('ok', common.mustCall(function(err) { assert.strictEqual(err, null); })); } else { const child = fork(process.argv[1], ['child']); child.on('message', common.mustCall(function(message) { assert.strictEqual(message, 'ok'); })); child.on('exit', common.mustCall(function(exitCode, signalCode) { assert.strictEqual(exitCode, 0); assert.strictEqual(signalCode, null); })); } node-v4.8.2/test/parallel/test-child-process-send-utf8.js000644 000766 000024 00000000604 13070706737 023422 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var fork = require('child_process').fork; var expected = Array(1e5).join('ßßßß'); if (process.argv[2] === 'child') { process.send(expected); } else { var child = fork(process.argv[1], ['child']); child.on('message', common.mustCall(function(actual) { assert.equal(actual, expected); })); } node-v4.8.2/test/parallel/test-child-process-set-blocking.js000644 000766 000024 00000000462 13070706737 024170 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var ch = require('child_process'); var SIZE = 100000; var cp = ch.spawn('python', ['-c', 'print ' + SIZE + ' * "C"'], { stdio: 'inherit' }); cp.on('exit', common.mustCall(function(code) { assert.equal(0, code); })); node-v4.8.2/test/parallel/test-child-process-silent.js000644 000766 000024 00000004427 13070706737 023112 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var childProcess = require('child_process'); // Child pipe test if (process.argv[2] === 'pipe') { process.stdout.write('stdout message'); process.stderr.write('stderr message'); } else if (process.argv[2] === 'ipc') { // Child IPC test process.send('message from child'); process.on('message', function() { process.send('got message from master'); }); } else if (process.argv[2] === 'parent') { // Parent | start child pipe test const child = childProcess.fork(process.argv[1], ['pipe'], {silent: true}); // Allow child process to self terminate child._channel.close(); child._channel = null; child.on('exit', function() { process.exit(0); }); } else { // testcase | start parent && child IPC test // testing: is stderr and stdout piped to parent var args = [process.argv[1], 'parent']; var parent = childProcess.spawn(process.execPath, args); //got any stderr or std data var stdoutData = false; parent.stdout.on('data', function() { stdoutData = true; }); var stderrData = false; parent.stdout.on('data', function() { stderrData = true; }); // testing: do message system work when using silent const child = childProcess.fork(process.argv[1], ['ipc'], {silent: true}); // Manual pipe so we will get errors child.stderr.pipe(process.stderr, {end: false}); child.stdout.pipe(process.stdout, {end: false}); var childSending = false; var childReciveing = false; child.on('message', function(message) { if (childSending === false) { childSending = (message === 'message from child'); } if (childReciveing === false) { childReciveing = (message === 'got message from master'); } if (childReciveing === true) { child.kill(); } }); child.send('message to child'); // Check all values process.on('exit', function() { // clean up child.kill(); parent.kill(); // Check std(out|err) pipes assert.ok(!stdoutData, 'The stdout socket was piped to parent'); assert.ok(!stderrData, 'The stderr socket was piped to parent'); // Check message system assert.ok(childSending, 'The child was able to send a message'); assert.ok(childReciveing, 'The child was able to receive a message'); }); } node-v4.8.2/test/parallel/test-child-process-spawn-error.js000644 000766 000024 00000001045 13070706737 024064 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var spawn = require('child_process').spawn; var assert = require('assert'); var enoentPath = 'foo123'; var spawnargs = ['bar']; assert.equal(common.fileExists(enoentPath), false); var enoentChild = spawn(enoentPath, spawnargs); enoentChild.on('error', common.mustCall(function(err) { assert.equal(err.code, 'ENOENT'); assert.equal(err.errno, 'ENOENT'); assert.equal(err.syscall, 'spawn ' + enoentPath); assert.equal(err.path, enoentPath); assert.deepEqual(err.spawnargs, spawnargs); })); node-v4.8.2/test/parallel/test-child-process-spawn-shell.js000644 000766 000024 00000003375 13070706737 024052 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const cp = require('child_process'); // Verify that a shell is, in fact, executed const doesNotExist = cp.spawn('does-not-exist', {shell: true}); assert.notEqual(doesNotExist.spawnfile, 'does-not-exist'); doesNotExist.on('error', common.fail); doesNotExist.on('exit', common.mustCall((code, signal) => { assert.strictEqual(signal, null); if (common.isWindows) assert.strictEqual(code, 1); // Exit code of cmd.exe else assert.strictEqual(code, 127); // Exit code of /bin/sh })); // Verify that passing arguments works const echo = cp.spawn('echo', ['foo'], { encoding: 'utf8', shell: true }); let echoOutput = ''; assert.strictEqual(echo.spawnargs[echo.spawnargs.length - 1].replace(/"/g, ''), 'echo foo'); echo.stdout.on('data', (data) => { echoOutput += data; }); echo.on('close', common.mustCall((code, signal) => { assert.strictEqual(echoOutput.trim(), 'foo'); })); // Verify that shell features can be used const cmd = common.isWindows ? 'echo bar | more' : 'echo bar | cat'; const command = cp.spawn(cmd, { encoding: 'utf8', shell: true }); let commandOutput = ''; command.stdout.on('data', (data) => { commandOutput += data; }); command.on('close', common.mustCall((code, signal) => { assert.strictEqual(commandOutput.trim(), 'bar'); })); // Verify that the environment is properly inherited const env = cp.spawn(`"${process.execPath}" -pe process.env.BAZ`, { env: Object.assign({}, process.env, {BAZ: 'buzz'}), encoding: 'utf8', shell: true }); let envOutput = ''; env.stdout.on('data', (data) => { envOutput += data; }); env.on('close', common.mustCall((code, signal) => { assert.strictEqual(envOutput.trim(), 'buzz'); })); node-v4.8.2/test/parallel/test-child-process-spawn-typeerror.js000644 000766 000024 00000010251 13070706737 024765 0ustar00iojsstaff000000 000000 'use strict'; const assert = require('assert'); const child_process = require('child_process'); const spawn = child_process.spawn; const fork = child_process.fork; const execFile = child_process.execFile; const common = require('../common'); const cmd = common.isWindows ? 'rundll32' : 'ls'; const invalidcmd = 'hopefully_you_dont_have_this_on_your_machine'; const invalidArgsMsg = /Incorrect value of args option/; const invalidOptionsMsg = /options argument must be an object/; const empty = common.fixturesDir + '/empty.js'; assert.throws(function() { var child = spawn(invalidcmd, 'this is not an array'); child.on('error', common.fail); }, TypeError); // verify that valid argument combinations do not throw assert.doesNotThrow(function() { spawn(cmd); }); assert.doesNotThrow(function() { spawn(cmd, []); }); assert.doesNotThrow(function() { spawn(cmd, {}); }); assert.doesNotThrow(function() { spawn(cmd, [], {}); }); // verify that invalid argument combinations throw assert.throws(function() { spawn(); }, /Bad argument/); assert.throws(function() { spawn(cmd, null); }, invalidArgsMsg); assert.throws(function() { spawn(cmd, true); }, invalidArgsMsg); assert.throws(function() { spawn(cmd, [], null); }, invalidOptionsMsg); assert.throws(function() { spawn(cmd, [], 1); }, invalidOptionsMsg); // Argument types for combinatorics const a = []; const o = {}; const c = function c() {}; const s = 'string'; const u = undefined; const n = null; // function spawn(file=f [,args=a] [, options=o]) has valid combinations: // (f) // (f, a) // (f, a, o) // (f, o) assert.doesNotThrow(function() { spawn(cmd); }); assert.doesNotThrow(function() { spawn(cmd, a); }); assert.doesNotThrow(function() { spawn(cmd, a, o); }); assert.doesNotThrow(function() { spawn(cmd, o); }); // Variants of undefined as explicit 'no argument' at a position assert.doesNotThrow(function() { spawn(cmd, u, o); }); assert.doesNotThrow(function() { spawn(cmd, a, u); }); assert.throws(function() { spawn(cmd, n, o); }, TypeError); assert.throws(function() { spawn(cmd, a, n); }, TypeError); assert.throws(function() { spawn(cmd, s); }, TypeError); assert.throws(function() { spawn(cmd, a, s); }, TypeError); // verify that execFile has same argument parsing behaviour as spawn // // function execFile(file=f [,args=a] [, options=o] [, callback=c]) has valid // combinations: // (f) // (f, a) // (f, a, o) // (f, a, o, c) // (f, a, c) // (f, o) // (f, o, c) // (f, c) assert.doesNotThrow(function() { execFile(cmd); }); assert.doesNotThrow(function() { execFile(cmd, a); }); assert.doesNotThrow(function() { execFile(cmd, a, o); }); assert.doesNotThrow(function() { execFile(cmd, a, o, c); }); assert.doesNotThrow(function() { execFile(cmd, a, c); }); assert.doesNotThrow(function() { execFile(cmd, o); }); assert.doesNotThrow(function() { execFile(cmd, o, c); }); assert.doesNotThrow(function() { execFile(cmd, c); }); // Variants of undefined as explicit 'no argument' at a position assert.doesNotThrow(function() { execFile(cmd, u, o, c); }); assert.doesNotThrow(function() { execFile(cmd, a, u, c); }); assert.doesNotThrow(function() { execFile(cmd, a, o, u); }); assert.doesNotThrow(function() { execFile(cmd, n, o, c); }); assert.doesNotThrow(function() { execFile(cmd, a, n, c); }); assert.doesNotThrow(function() { execFile(cmd, a, o, n); }); // string is invalid in arg position (this may seem strange, but is // consistent across node API, cf. `net.createServer('not options', 'not // callback')` assert.throws(function() { execFile(cmd, s, o, c); }, TypeError); assert.doesNotThrow(function() { execFile(cmd, a, s, c); }); assert.doesNotThrow(function() { execFile(cmd, a, o, s); }); // verify that fork has same argument parsing behaviour as spawn // // function fork(file=f [,args=a] [, options=o]) has valid combinations: // (f) // (f, a) // (f, a, o) // (f, o) assert.doesNotThrow(function() { fork(empty); }); assert.doesNotThrow(function() { fork(empty, a); }); assert.doesNotThrow(function() { fork(empty, a, o); }); assert.doesNotThrow(function() { fork(empty, o); }); assert.throws(function() { fork(empty, s); }, TypeError); assert.doesNotThrow(function() { fork(empty, a, s); }, TypeError); node-v4.8.2/test/parallel/test-child-process-spawnsync-env.js000644 000766 000024 00000000614 13070706737 024421 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var cp = require('child_process'); if (process.argv[2] === 'child') { console.log(process.env.foo); } else { var expected = 'bar'; var child = cp.spawnSync(process.execPath, [__filename, 'child'], { env: Object.assign(process.env, { foo: expected }) }); assert.equal(child.stdout.toString().trim(), expected); } node-v4.8.2/test/parallel/test-child-process-spawnsync-input.js000644 000766 000024 00000004001 13070706737 024762 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const spawnSync = require('child_process').spawnSync; const msgOut = 'this is stdout'; const msgErr = 'this is stderr'; // this is actually not os.EOL? const msgOutBuf = new Buffer(msgOut + '\n'); const msgErrBuf = new Buffer(msgErr + '\n'); const args = [ '-e', `console.log("${msgOut}"); console.error("${msgErr}");` ]; var ret; function checkSpawnSyncRet(ret) { assert.strictEqual(ret.status, 0); assert.strictEqual(ret.error, undefined); } function verifyBufOutput(ret) { checkSpawnSyncRet(ret); assert.deepEqual(ret.stdout, msgOutBuf); assert.deepEqual(ret.stderr, msgErrBuf); } if (process.argv.indexOf('spawnchild') !== -1) { switch (process.argv[3]) { case '1': ret = spawnSync(process.execPath, args, { stdio: 'inherit' }); checkSpawnSyncRet(ret); break; case '2': ret = spawnSync(process.execPath, args, { stdio: ['inherit', 'inherit', 'inherit'] }); checkSpawnSyncRet(ret); break; } process.exit(0); return; } verifyBufOutput(spawnSync(process.execPath, [__filename, 'spawnchild', 1])); verifyBufOutput(spawnSync(process.execPath, [__filename, 'spawnchild', 2])); var options = { input: 1234 }; assert.throws(function() { spawnSync('cat', [], options); }, /TypeError:.*should be Buffer or string not number/); options = { input: 'hello world' }; ret = spawnSync('cat', [], options); checkSpawnSyncRet(ret); assert.strictEqual(ret.stdout.toString('utf8'), options.input); assert.strictEqual(ret.stderr.toString('utf8'), ''); options = { input: new Buffer('hello world') }; ret = spawnSync('cat', [], options); checkSpawnSyncRet(ret); assert.deepEqual(ret.stdout, options.input); assert.deepEqual(ret.stderr, new Buffer('')); verifyBufOutput(spawnSync(process.execPath, args)); ret = spawnSync(process.execPath, args, { encoding: 'utf8' }); checkSpawnSyncRet(ret); assert.strictEqual(ret.stdout, msgOut + '\n'); assert.strictEqual(ret.stderr, msgErr + '\n'); node-v4.8.2/test/parallel/test-child-process-spawnsync-kill-signal.js000644 000766 000024 00000002670 13070706737 026043 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const cp = require('child_process'); if (process.argv[2] === 'child') { setInterval(() => {}, 1000); } else { const exitCode = common.isWindows ? 1 : 0; const SIGKILL = process.binding('constants').SIGKILL; function spawn(killSignal) { const child = cp.spawnSync(process.execPath, [__filename, 'child'], {killSignal, timeout: 100}); assert.strictEqual(child.status, exitCode); assert.strictEqual(child.error.code, 'ETIMEDOUT'); return child; } // Verify that an error is thrown for unknown signals. assert.throws(() => { spawn('SIG_NOT_A_REAL_SIGNAL'); }, /Error: Unknown signal: SIG_NOT_A_REAL_SIGNAL/); // Verify that the default kill signal is SIGTERM. { const child = spawn(); assert.strictEqual(child.signal, 'SIGTERM'); assert.strictEqual(child.options.killSignal, undefined); } // Verify that a string signal name is handled properly. { const child = spawn('SIGKILL'); assert.strictEqual(child.signal, 'SIGKILL'); assert.strictEqual(child.options.killSignal, SIGKILL); } // Verify that a numeric signal is handled properly. { const child = spawn(SIGKILL); assert.strictEqual(typeof SIGKILL, 'number'); assert.strictEqual(child.signal, 'SIGKILL'); assert.strictEqual(child.options.killSignal, SIGKILL); } } node-v4.8.2/test/parallel/test-child-process-spawnsync-maxbuf.js000644 000766 000024 00000001172 13070706737 025113 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const spawnSync = require('child_process').spawnSync; const msgOut = 'this is stdout'; // This is actually not os.EOL? const msgOutBuf = new Buffer(msgOut + '\n'); const args = [ '-e', `console.log("${msgOut}");` ]; const options = { maxBuffer: 1 }; const ret = spawnSync(process.execPath, args, options); assert.ok(ret.error, 'maxBuffer should error'); assert.strictEqual(ret.error.errno, 'ENOBUFS'); // We can have buffers larger than maxBuffer because underneath we alloc 64k // that matches our read sizes assert.deepEqual(ret.stdout, msgOutBuf); node-v4.8.2/test/parallel/test-child-process-spawnsync-shell.js000644 000766 000024 00000002430 13070706737 024736 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const cp = require('child_process'); // Verify that a shell is, in fact, executed const doesNotExist = cp.spawnSync('does-not-exist', {shell: true}); assert.notEqual(doesNotExist.file, 'does-not-exist'); assert.strictEqual(doesNotExist.error, undefined); assert.strictEqual(doesNotExist.signal, null); if (common.isWindows) assert.strictEqual(doesNotExist.status, 1); // Exit code of cmd.exe else assert.strictEqual(doesNotExist.status, 127); // Exit code of /bin/sh // Verify that passing arguments works const echo = cp.spawnSync('echo', ['foo'], {shell: true}); assert.strictEqual(echo.args[echo.args.length - 1].replace(/"/g, ''), 'echo foo'); assert.strictEqual(echo.stdout.toString().trim(), 'foo'); // Verify that shell features can be used const cmd = common.isWindows ? 'echo bar | more' : 'echo bar | cat'; const command = cp.spawnSync(cmd, {shell: true}); assert.strictEqual(command.stdout.toString().trim(), 'bar'); // Verify that the environment is properly inherited const env = cp.spawnSync(`"${process.execPath}" -pe process.env.BAZ`, { env: Object.assign({}, process.env, {BAZ: 'buzz'}), shell: true }); assert.strictEqual(env.stdout.toString().trim(), 'buzz'); node-v4.8.2/test/parallel/test-child-process-spawnsync-timeout.js000644 000766 000024 00000001244 13070706737 025317 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); var spawnSync = require('child_process').spawnSync; const TIMER = 200; const SLEEP = common.platformTimeout(5000); switch (process.argv[2]) { case 'child': setTimeout(function() { console.log('child fired'); process.exit(1); }, SLEEP); break; default: var start = Date.now(); var ret = spawnSync(process.execPath, [__filename, 'child'], {timeout: TIMER}); assert.strictEqual(ret.error.errno, 'ETIMEDOUT'); const end = Date.now() - start; assert(end < SLEEP); assert(ret.status > 128 || ret.signal); break; } node-v4.8.2/test/parallel/test-child-process-spawnsync.js000644 000766 000024 00000002467 13070706737 023643 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const spawnSync = require('child_process').spawnSync; // Echo does different things on Windows and Unix, but in both cases, it does // more-or-less nothing if there are no parameters const ret = spawnSync('sleep', ['0']); assert.strictEqual(ret.status, 0, 'exit status should be zero'); // Error test when command does not exist const ret_err = spawnSync('command_does_not_exist', ['bar']).error; assert.strictEqual(ret_err.code, 'ENOENT'); assert.strictEqual(ret_err.errno, 'ENOENT'); assert.strictEqual(ret_err.syscall, 'spawnSync command_does_not_exist'); assert.strictEqual(ret_err.path, 'command_does_not_exist'); assert.deepEqual(ret_err.spawnargs, ['bar']); { // Test the cwd option const cwd = common.rootDir; const response = common.spawnSyncPwd({cwd}); assert.strictEqual(response.stdout.toString().trim(), cwd); } { // Test the encoding option const noEncoding = common.spawnSyncPwd(); const bufferEncoding = common.spawnSyncPwd({encoding: 'buffer'}); const utf8Encoding = common.spawnSyncPwd({encoding: 'utf8'}); assert.deepStrictEqual(noEncoding.output, bufferEncoding.output); assert.deepStrictEqual([ null, noEncoding.stdout.toString(), noEncoding.stderr.toString() ], utf8Encoding.output); } node-v4.8.2/test/parallel/test-child-process-stdin-ipc.js000644 000766 000024 00000000655 13070706737 023505 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var spawn = require('child_process').spawn; if (process.argv[2] === 'child') { // Just reference stdin, it should start it process.stdin; return; } var proc = spawn(process.execPath, [__filename, 'child'], { stdio: ['ipc', 'inherit', 'inherit'] }); proc.on('exit', common.mustCall(function(code) { assert.strictEqual(code, 0); })); node-v4.8.2/test/parallel/test-child-process-stdin.js000644 000766 000024 00000001664 13070706737 022735 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var spawn = require('child_process').spawn; var cat = spawn(common.isWindows ? 'more' : 'cat'); cat.stdin.write('hello'); cat.stdin.write(' '); cat.stdin.write('world'); assert.strictEqual(true, cat.stdin.writable); assert.strictEqual(false, cat.stdin.readable); cat.stdin.end(); var response = ''; cat.stdout.setEncoding('utf8'); cat.stdout.on('data', function(chunk) { console.log('stdout: ' + chunk); response += chunk; }); cat.stdout.on('end', common.mustCall(function() {})); cat.stderr.on('data', common.fail); cat.stderr.on('end', common.mustCall(function() {})); cat.on('exit', common.mustCall(function(status) { assert.strictEqual(0, status); })); cat.on('close', common.mustCall(function() { if (common.isWindows) { assert.strictEqual('hello world\r\n', response); } else { assert.strictEqual('hello world', response); } })); node-v4.8.2/test/parallel/test-child-process-stdio-big-write-end.js000644 000766 000024 00000002255 13070706737 025366 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var BUFSIZE = 1024; switch (process.argv[2]) { case undefined: return parent(); case 'child': return child(); default: throw new Error('wtf?'); } function parent() { var spawn = require('child_process').spawn; var child = spawn(process.execPath, [__filename, 'child']); var sent = 0; var n = ''; child.stdout.setEncoding('ascii'); child.stdout.on('data', function(c) { n += c; }); child.stdout.on('end', function() { assert.strictEqual(+n, sent); console.log('ok'); }); // Write until the buffer fills up. do { var buf = new Buffer(BUFSIZE); buf.fill('.'); sent += BUFSIZE; } while (child.stdin.write(buf)); // then write a bunch more times. for (var i = 0; i < 100; i++) { const buf = new Buffer(BUFSIZE); buf.fill('.'); sent += BUFSIZE; child.stdin.write(buf); } // now end, before it's all flushed. child.stdin.end(); // now we wait... } function child() { var received = 0; process.stdin.on('data', function(c) { received += c.length; }); process.stdin.on('end', function() { console.log(received); }); } node-v4.8.2/test/parallel/test-child-process-stdio-inherit.js000644 000766 000024 00000001466 13070706737 024376 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var spawn = require('child_process').spawn; if (process.argv[2] === 'parent') parent(); else grandparent(); function grandparent() { var child = spawn(process.execPath, [__filename, 'parent']); child.stderr.pipe(process.stderr); var output = ''; var input = 'asdfasdf'; child.stdout.on('data', function(chunk) { output += chunk; }); child.stdout.setEncoding('utf8'); child.stdin.end(input); child.on('close', function(code, signal) { assert.strictEqual(code, 0); assert.strictEqual(signal, null); // cat on windows adds a \r\n at the end. assert.strictEqual(output.trim(), input.trim()); }); } function parent() { // should not immediately exit. common.spawnCat({ stdio: 'inherit' }); } node-v4.8.2/test/parallel/test-child-process-stdio.js000644 000766 000024 00000001165 13070706737 022732 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var options = {stdio: ['pipe']}; var child = common.spawnPwd(options); assert.notEqual(child.stdout, null); assert.notEqual(child.stderr, null); options = {stdio: 'ignore'}; child = common.spawnPwd(options); assert.equal(child.stdout, null); assert.equal(child.stderr, null); options = {stdio: 'ignore'}; child = common.spawnSyncCat(options); assert.deepStrictEqual(options, {stdio: 'ignore'}); assert.throws(() => { common.spawnPwd({stdio: ['pipe', 'pipe', 'pipe', 'ipc', 'ipc']}); }, /^Error: Child process can have only one IPC pipe$/); node-v4.8.2/test/parallel/test-child-process-stdout-flush-exit.js000644 000766 000024 00000001726 13070706737 025223 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); // if child process output to console and exit if (process.argv[2] === 'child') { console.log('hello'); for (var i = 0; i < 200; i++) { console.log('filler'); } console.log('goodbye'); process.exit(0); } else { // parent process var spawn = require('child_process').spawn; // spawn self as child var child = spawn(process.argv[0], [process.argv[1], 'child']); var stdout = ''; child.stderr.setEncoding('utf8'); child.stderr.on('data', function(data) { console.log('parent stderr: ' + data); assert.ok(false); }); // check if we receive both 'hello' at start and 'goodbye' at end child.stdout.setEncoding('utf8'); child.stdout.on('data', function(data) { stdout += data; }); child.on('close', common.mustCall(function() { assert.equal(stdout.slice(0, 6), 'hello\n'); assert.equal(stdout.slice(stdout.length - 8), 'goodbye\n'); })); } node-v4.8.2/test/parallel/test-child-process-stdout-flush.js000644 000766 000024 00000001210 13070706737 024240 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var path = require('path'); var spawn = require('child_process').spawn; var sub = path.join(common.fixturesDir, 'print-chars.js'); var n = 500000; var child = spawn(process.argv[0], [sub, n]); var count = 0; child.stderr.setEncoding('utf8'); child.stderr.on('data', function(data) { console.log('parent stderr: ' + data); assert.ok(false); }); child.stdout.setEncoding('utf8'); child.stdout.on('data', function(data) { count += data.length; console.log(count); }); child.on('close', function(data) { assert.equal(n, count); console.log('okay'); }); node-v4.8.2/test/parallel/test-child-process-uid-gid.js000644 000766 000024 00000000562 13070706737 023132 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const spawn = require('child_process').spawn; const expectedError = common.isWindows ? /\bENOTSUP\b/ : /\bEPERM\b/; assert.throws(() => { spawn('echo', ['fhqwhgads'], {uid: 0}); }, expectedError); assert.throws(() => { spawn('echo', ['fhqwhgads'], {gid: 0}); }, expectedError); node-v4.8.2/test/parallel/test-child-process-validate-stdio.js000644 000766 000024 00000002426 13070706737 024522 0ustar00iojsstaff000000 000000 'use strict'; // Flags: --expose_internals require('../common'); const assert = require('assert'); const _validateStdio = require('internal/child_process')._validateStdio; // should throw if string and not ignore, pipe, or inherit assert.throws(function() { _validateStdio('foo'); }, /Incorrect value of stdio option/); // should throw if not a string or array assert.throws(function() { _validateStdio(600); }, /Incorrect value of stdio option/); // should populate stdio with undefined if len < 3 { const stdio1 = []; const result = _validateStdio(stdio1, false); assert.strictEqual(stdio1.length, 3); assert.strictEqual(result.hasOwnProperty('stdio'), true); assert.strictEqual(result.hasOwnProperty('ipc'), true); assert.strictEqual(result.hasOwnProperty('ipcFd'), true); } // should throw if stdio has ipc and sync is true const stdio2 = ['ipc', 'ipc', 'ipc']; assert.throws(function() { _validateStdio(stdio2, true); }, /You cannot use IPC with synchronous forks/); { const stdio3 = [process.stdin, process.stdout, process.stderr]; const result = _validateStdio(stdio3, false); assert.deepStrictEqual(result, { stdio: [ { type: 'fd', fd: 0 }, { type: 'fd', fd: 1 }, { type: 'fd', fd: 2 } ], ipc: undefined, ipcFd: undefined }); } node-v4.8.2/test/parallel/test-cli-eval-event.js000644 000766 000024 00000000666 13070706737 021673 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const spawn = require('child_process').spawn; const child = spawn(process.execPath, ['-e', ` const server = require('net').createServer().listen(0); server.once('listening', server.close); `]); child.once('exit', common.mustCall(function(exitCode, signalCode) { assert.strictEqual(exitCode, 0); assert.strictEqual(signalCode, null); })); node-v4.8.2/test/parallel/test-cli-eval.js000644 000766 000024 00000005670 13070706737 020554 0ustar00iojsstaff000000 000000 'use strict'; if (module.parent) { // signal we've been loaded as a module console.log('Loaded as a module, exiting with status code 42.'); process.exit(42); } const common = require('../common'); const assert = require('assert'); const child = require('child_process'); const path = require('path'); const nodejs = '"' + process.execPath + '"'; // replace \ by / because windows uses backslashes in paths, but they're still // interpreted as the escape character when put between quotes. var filename = __filename.replace(/\\/g, '/'); // assert that nothing is written to stdout child.exec(nodejs + ' --eval 42', function(err, stdout, stderr) { assert.strictEqual(stdout, ''); assert.strictEqual(stderr, ''); }); // assert that "42\n" is written to stderr child.exec(nodejs + ' --eval "console.error(42)"', function(err, stdout, stderr) { assert.strictEqual(stdout, ''); assert.strictEqual(stderr, '42\n'); }); // assert that the expected output is written to stdout ['--print', '-p -e', '-pe', '-p'].forEach(function(s) { var cmd = nodejs + ' ' + s + ' '; child.exec(cmd + '42', function(err, stdout, stderr) { assert.strictEqual(stdout, '42\n'); assert.strictEqual(stderr, ''); }); child.exec(cmd + "'[]'", common.mustCall( function(err, stdout, stderr) { assert.strictEqual(stdout, '[]\n'); assert.strictEqual(stderr, ''); })); }); // assert that module loading works child.exec(nodejs + ' --eval "require(\'' + filename + '\')"', function(status, stdout, stderr) { assert.strictEqual(status.code, 42); }); // module path resolve bug, regression test child.exec(nodejs + ' --eval "require(\'./test/parallel/test-cli-eval.js\')"', function(status, stdout, stderr) { assert.strictEqual(status.code, 42); }); // Missing argument should not crash child.exec(nodejs + ' -e', common.mustCall(function(status, stdout, stderr) { assert.notStrictEqual(status, null); assert.strictEqual(status.code, 9); })); // empty program should do nothing child.exec(nodejs + ' -e ""', function(status, stdout, stderr) { assert.strictEqual(stdout, ''); assert.strictEqual(stderr, ''); }); // "\\-42" should be interpreted as an escaped expression, not a switch child.exec(nodejs + ' -p "\\-42"', function(err, stdout, stderr) { assert.strictEqual(stdout, '-42\n'); assert.strictEqual(stderr, ''); }); child.exec(nodejs + ' --use-strict -p process.execArgv', function(status, stdout, stderr) { assert.strictEqual(stdout, "[ '--use-strict', '-p', 'process.execArgv' ]\n"); }); // Regression test for https://github.com/nodejs/node/issues/3574 const emptyFile = path.join(common.fixturesDir, 'empty.js'); child.exec(nodejs + ` -e 'require("child_process").fork("${emptyFile}")'`, function(status, stdout, stderr) { assert.strictEqual(stdout, ''); assert.strictEqual(stderr, ''); }); node-v4.8.2/test/parallel/test-cli-syntax.js000644 000766 000024 00000004510 13070706737 021143 0ustar00iojsstaff000000 000000 'use strict'; const assert = require('assert'); const spawnSync = require('child_process').spawnSync; const path = require('path'); const common = require('../common'); var node = process.execPath; // test both sets of arguments that check syntax var syntaxArgs = [ ['-c'], ['--check'] ]; // test good syntax with and without shebang [ 'syntax/good_syntax.js', 'syntax/good_syntax', 'syntax/good_syntax_shebang.js', 'syntax/good_syntax_shebang', 'syntax/illegal_if_not_wrapped.js' ].forEach(function(file) { file = path.join(common.fixturesDir, file); // loop each possible option, `-c` or `--check` syntaxArgs.forEach(function(args) { var _args = args.concat(file); var c = spawnSync(node, _args, {encoding: 'utf8'}); // no output should be produced assert.strictEqual(c.stdout, '', 'stdout produced'); assert.strictEqual(c.stderr, '', 'stderr produced'); assert.strictEqual(c.status, 0, 'code == ' + c.status); }); }); // test bad syntax with and without shebang [ 'syntax/bad_syntax.js', 'syntax/bad_syntax', 'syntax/bad_syntax_shebang.js', 'syntax/bad_syntax_shebang' ].forEach(function(file) { file = path.join(common.fixturesDir, file); // loop each possible option, `-c` or `--check` syntaxArgs.forEach(function(args) { var _args = args.concat(file); var c = spawnSync(node, _args, {encoding: 'utf8'}); // no stdout should be produced assert.strictEqual(c.stdout, '', 'stdout produced'); // stderr should have a syntax error message var match = c.stderr.match(/^SyntaxError: Unexpected identifier$/m); assert(match, 'stderr incorrect'); assert.strictEqual(c.status, 1, 'code == ' + c.status); }); }); // test file not found [ 'syntax/file_not_found.js', 'syntax/file_not_found' ].forEach(function(file) { file = path.join(common.fixturesDir, file); // loop each possible option, `-c` or `--check` syntaxArgs.forEach(function(args) { var _args = args.concat(file); var c = spawnSync(node, _args, {encoding: 'utf8'}); // no stdout should be produced assert.strictEqual(c.stdout, '', 'stdout produced'); // stderr should have a module not found error message var match = c.stderr.match(/^Error: Cannot find module/m); assert(match, 'stderr incorrect'); assert.strictEqual(c.status, 1, 'code == ' + c.status); }); }); node-v4.8.2/test/parallel/test-cluster-basic.js000644 000766 000024 00000007643 13070706737 021622 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var cluster = require('cluster'); assert.equal('NODE_UNIQUE_ID' in process.env, false, 'NODE_UNIQUE_ID should be removed on startup'); function forEach(obj, fn) { Object.keys(obj).forEach(function(name, index) { fn(obj[name], name, index); }); } if (cluster.isWorker) { var http = require('http'); http.Server(function() { }).listen(common.PORT, '127.0.0.1'); } else if (cluster.isMaster) { var checks = { cluster: { events: { fork: false, online: false, listening: false, exit: false }, equal: { fork: false, online: false, listening: false, exit: false } }, worker: { events: { online: false, listening: false, exit: false }, equal: { online: false, listening: false, exit: false }, states: { none: false, online: false, listening: false, dead: false } } }; var worker; var stateNames = Object.keys(checks.worker.states); //Check events, states, and emit arguments forEach(checks.cluster.events, function(bool, name, index) { //Listen on event cluster.on(name, function(/* worker */) { //Set event checks.cluster.events[name] = true; //Check argument checks.cluster.equal[name] = worker === arguments[0]; //Check state var state = stateNames[index]; checks.worker.states[state] = (state === worker.state); }); }); //Kill worker when listening cluster.on('listening', function() { worker.kill(); }); //Kill process when worker is killed cluster.on('exit', function() { process.exit(0); }); //Create worker worker = cluster.fork(); assert.equal(worker.id, 1); assert.ok(worker instanceof cluster.Worker, 'the worker is not a instance of the Worker constructor'); //Check event forEach(checks.worker.events, function(bool, name, index) { worker.on(name, function() { //Set event checks.worker.events[name] = true; //Check argument checks.worker.equal[name] = (worker === this); switch (name) { case 'exit': assert.equal(arguments[0], worker.process.exitCode); assert.equal(arguments[1], worker.process.signalCode); assert.equal(arguments.length, 2); break; case 'listening': assert.equal(arguments.length, 1); var expect = { address: '127.0.0.1', port: common.PORT, addressType: 4, fd: undefined }; assert.deepEqual(arguments[0], expect); break; default: assert.equal(arguments.length, 0); break; } }); }); //Check all values process.once('exit', function() { //Check cluster events forEach(checks.cluster.events, function(check, name) { assert.ok(check, 'The cluster event "' + name + '" on the cluster ' + 'object did not fire'); }); //Check cluster event arguments forEach(checks.cluster.equal, function(check, name) { assert.ok(check, 'The cluster event "' + name + '" did not emit ' + 'with correct argument'); }); //Check worker states forEach(checks.worker.states, function(check, name) { assert.ok(check, 'The worker state "' + name + '" was not set to true'); }); //Check worker events forEach(checks.worker.events, function(check, name) { assert.ok(check, 'The worker event "' + name + '" on the worker object ' + 'did not fire'); }); //Check worker event arguments forEach(checks.worker.equal, function(check, name) { assert.ok(check, 'The worker event "' + name + '" did not emit with ' + 'corrent argument'); }); }); } node-v4.8.2/test/parallel/test-cluster-bind-privileged-port.js000644 000766 000024 00000001262 13070706737 024556 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var cluster = require('cluster'); var net = require('net'); if (common.isWindows) { common.skip('not reliable on Windows.'); return; } if (process.getuid() === 0) { common.skip('Test is not supposed to be run as root.'); return; } if (cluster.isMaster) { cluster.fork().on('exit', common.mustCall(function(exitCode) { assert.equal(exitCode, 0); })); } else { var s = net.createServer(common.fail); s.listen(42, common.fail.bind(null, 'listen should have failed')); s.on('error', common.mustCall(function(err) { assert.equal(err.code, 'EACCES'); process.disconnect(); })); } node-v4.8.2/test/parallel/test-cluster-bind-twice.js000644 000766 000024 00000005257 13070706737 022565 0ustar00iojsstaff000000 000000 'use strict'; // This test starts two clustered HTTP servers on the same port. It expects the // first cluster to succeed and the second cluster to fail with EADDRINUSE. // // The test may seem complex but most of it is plumbing that routes messages // from the child processes back to the supervisor. As a tree it looks something // like this: // // // / \ // // / \ // // // The first worker starts a server on a fixed port and fires a ready message // that is routed to the second worker. When it tries to bind, it expects to // see an EADDRINUSE error. // // See https://github.com/joyent/node/issues/2721 for more details. var common = require('../common'); var assert = require('assert'); var cluster = require('cluster'); var fork = require('child_process').fork; var http = require('http'); var id = process.argv[2]; if (!id) { var a = fork(__filename, ['one']); var b = fork(__filename, ['two']); a.on('exit', function(c) { if (c) { b.send('QUIT'); throw new Error('A exited with ' + c); } }); b.on('exit', function(c) { if (c) { a.send('QUIT'); throw new Error('B exited with ' + c); } }); a.on('message', function(m) { if (typeof m === 'object') return; assert.equal(m, 'READY'); b.send('START'); }); let ok = false; b.on('message', function(m) { if (typeof m === 'object') return; // ignore system messages assert.equal(m, 'EADDRINUSE'); ok = true; a.send('QUIT'); b.send('QUIT'); }); process.on('exit', function() { assert(ok); }); } else if (id === 'one') { if (cluster.isMaster) return startWorker(); http.createServer(common.fail).listen(common.PORT, function() { process.send('READY'); }); process.on('message', function(m) { if (m === 'QUIT') process.exit(); }); } else if (id === 'two') { if (cluster.isMaster) return startWorker(); let ok = false; process.on('exit', function() { assert(ok); }); var server = http.createServer(common.fail); process.on('message', function(m) { if (typeof m === 'object') return; // ignore system messages if (m === 'QUIT') process.exit(); assert.equal(m, 'START'); server.listen(common.PORT, common.fail); server.on('error', function(e) { assert.equal(e.code, 'EADDRINUSE'); process.send(e.code); ok = true; }); }); } else { assert(0); // bad command line argument } function startWorker() { var worker = cluster.fork(); worker.on('exit', process.exit); worker.on('message', process.send.bind(process)); process.on('message', worker.send.bind(worker)); } node-v4.8.2/test/parallel/test-cluster-debug-port.js000644 000766 000024 00000002313 13070706737 022576 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const cluster = require('cluster'); if (cluster.isMaster) { assert.strictEqual(process.execArgv.length, 0, 'run test with no args'); function checkExitCode(code, signal) { assert.strictEqual(code, 0); assert.strictEqual(signal, null); } console.log('forked worker should not have --debug-port'); cluster.fork().on('exit', checkExitCode); cluster.setupMaster({ execArgv: ['--debug-port=' + process.debugPort] }); console.log('forked worker should have --debug-port, with offset = 1'); cluster.fork({ portSet: process.debugPort + 1 }).on('exit', checkExitCode); cluster.setupMaster({ execArgv: [`--debug-port=${process.debugPort}`, `--debug=${process.debugPort}`] }); console.log('forked worker should have --debug-port, with offset = 2'); cluster.fork({ portSet: process.debugPort + 2 }).on('exit', checkExitCode); } else { const hasDebugArg = process.execArgv.some(function(arg) { return /debug/.test(arg); }); assert.strictEqual(hasDebugArg, process.env.portSet !== undefined); assert.strictEqual(process.debugPort, +process.env.portSet || 5858); process.exit(); } node-v4.8.2/test/parallel/test-cluster-dgram-1.js000644 000766 000024 00000004046 13070706737 021763 0ustar00iojsstaff000000 000000 'use strict'; var NUM_WORKERS = 4; var PACKETS_PER_WORKER = 10; var assert = require('assert'); var cluster = require('cluster'); var common = require('../common'); var dgram = require('dgram'); if (common.isWindows) { common.skip('dgram clustering is currently not supported ' + 'on windows.'); return; } if (cluster.isMaster) master(); else worker(); function master() { var listening = 0; // Fork 4 workers. for (var i = 0; i < NUM_WORKERS; i++) cluster.fork(); // Wait until all workers are listening. cluster.on('listening', function() { if (++listening < NUM_WORKERS) return; // Start sending messages. var buf = new Buffer('hello world'); var socket = dgram.createSocket('udp4'); var sent = 0; doSend(); function doSend() { socket.send(buf, 0, buf.length, common.PORT, '127.0.0.1', afterSend); } function afterSend() { sent++; if (sent < NUM_WORKERS * PACKETS_PER_WORKER) { doSend(); } else { console.log('master sent %d packets', sent); socket.close(); } } }); // Set up event handlers for every worker. Each worker sends a message when // it has received the expected number of packets. After that it disconnects. for (var key in cluster.workers) { if (cluster.workers.hasOwnProperty(key)) setupWorker(cluster.workers[key]); } function setupWorker(worker) { var received = 0; worker.on('message', common.mustCall((msg) => { received = msg.received; worker.disconnect(); })); worker.on('exit', common.mustCall(() => { assert.strictEqual(received, PACKETS_PER_WORKER); })); } } function worker() { var received = 0; // Create udp socket and start listening. var socket = dgram.createSocket('udp4'); socket.on('message', function(data, info) { received++; // Every 10 messages, notify the master. if (received == PACKETS_PER_WORKER) { process.send({received: received}); socket.close(); } }); socket.bind(common.PORT); } node-v4.8.2/test/parallel/test-cluster-dgram-2.js000644 000766 000024 00000003034 13070706737 021760 0ustar00iojsstaff000000 000000 'use strict'; var NUM_WORKERS = 4; var PACKETS_PER_WORKER = 10; var cluster = require('cluster'); var common = require('../common'); var dgram = require('dgram'); if (common.isWindows) { common.skip('dgram clustering is currently not supported ' + 'on windows.'); return; } if (cluster.isMaster) master(); else worker(); function master() { var received = 0; // Start listening on a socket. var socket = dgram.createSocket('udp4'); socket.bind(common.PORT); // Disconnect workers when the expected number of messages have been // received. socket.on('message', function(data, info) { received++; if (received == PACKETS_PER_WORKER * NUM_WORKERS) { console.log('master received %d packets', received); // Close the socket. socket.close(); // Disconnect all workers. cluster.disconnect(); } }); // Fork workers. for (var i = 0; i < NUM_WORKERS; i++) cluster.fork(); } function worker() { // Create udp socket and send packets to master. var socket = dgram.createSocket('udp4'); var buf = new Buffer('hello world'); // This test is intended to exercise the cluster binding of udp sockets, but // since sockets aren't clustered when implicitly bound by at first call of // send(), explicitly bind them to an ephemeral port. socket.bind(0); for (var i = 0; i < PACKETS_PER_WORKER; i++) socket.send(buf, 0, buf.length, common.PORT, '127.0.0.1'); console.log('worker %d sent %d packets', cluster.worker.id, PACKETS_PER_WORKER); } node-v4.8.2/test/parallel/test-cluster-dgram-reuse.js000644 000766 000024 00000001531 13070706737 022742 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const cluster = require('cluster'); const dgram = require('dgram'); if (common.isWindows) { common.skip('dgram clustering is currently not supported ' + 'on windows.'); return; } if (cluster.isMaster) { cluster.fork().on('exit', function(code) { assert.equal(code, 0); }); return; } const sockets = []; function next() { sockets.push(this); if (sockets.length !== 2) return; // Work around health check issue process.nextTick(function() { for (var i = 0; i < sockets.length; i++) sockets[i].close(close); }); } var waiting = 2; function close() { if (--waiting === 0) cluster.worker.disconnect(); } for (var i = 0; i < 2; i++) dgram.createSocket({ type: 'udp4', reuseAddr: true }).bind(common.PORT, next); node-v4.8.2/test/parallel/test-cluster-disconnect-before-exit.js000644 000766 000024 00000001017 13070706737 025066 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var cluster = require('cluster'); if (cluster.isMaster) { var worker = cluster.fork().on('online', disconnect); function disconnect() { worker.disconnect(); // The worker remains in cluster.workers until both disconnect AND exit. // Disconnect is supposed to disconnect all workers, but not workers that // are already disconnected, since calling disconnect() on an already // disconnected worker would error. worker.on('disconnect', cluster.disconnect); } } node-v4.8.2/test/parallel/test-cluster-disconnect-handles.js000644 000766 000024 00000007065 13070706737 024304 0ustar00iojsstaff000000 000000 /* eslint-disable no-debugger */ // Flags: --expose_internals 'use strict'; const common = require('../common'); const assert = require('assert'); const cluster = require('cluster'); const net = require('net'); const Protocol = require('_debugger').Protocol; if (common.isWindows) { common.skip('SCHED_RR not reliable on Windows'); return; } cluster.schedulingPolicy = cluster.SCHED_RR; // Worker sends back a "I'm here" message, then immediately suspends // inside the debugger. The master connects to the debug agent first, // connects to the TCP server second, then disconnects the worker and // unsuspends it again. The ultimate goal of this tortured exercise // is to make sure the connection is still sitting in the master's // pending handle queue. if (cluster.isMaster) { let isKilling = false; const handles = require('internal/cluster').handles; const address = common.hasIPv6 ? '[::1]' : common.localhostIPv4; cluster.setupMaster({ execArgv: [`--debug=${address}:${common.PORT}`] }); const worker = cluster.fork(); worker.once('exit', common.mustCall((code, signal) => { assert.strictEqual(code, 0, 'worker did not exit normally'); assert.strictEqual(signal, null, 'worker did not exit normally'); })); worker.on('message', common.mustCall((message) => { assert.strictEqual(Array.isArray(message), true); assert.strictEqual(message[0], 'listening'); let continueRecv = false; const address = message[1]; const host = address.address; const debugClient = net.connect({ host, port: common.PORT }); const protocol = new Protocol(); debugClient.setEncoding('utf8'); debugClient.on('data', (data) => protocol.execute(data)); debugClient.once('connect', common.mustCall(() => { protocol.onResponse = common.mustCall((res) => { protocol.onResponse = (res) => { // It can happen that the first continue was sent before the break // event was received. If that's the case, send also a continue from // here so the worker exits if (res.body.command === 'continue') { continueRecv = true; } else if (res.body.event === 'break' && continueRecv) { const req = protocol.serialize({ command: 'continue' }); debugClient.write(req); } }; const conn = net.connect({ host, port: address.port }); conn.once('connect', common.mustCall(() => { conn.destroy(); assert.notDeepStrictEqual(handles, {}); worker.disconnect(); assert.deepStrictEqual(handles, {}); // Always send the continue, as the break event might have already // been received. const req = protocol.serialize({ command: 'continue' }); debugClient.write(req); })); }); })); })); process.on('exit', () => assert.deepStrictEqual(handles, {})); process.on('uncaughtException', function(ex) { // Make sure we clean up so as not to leave a stray worker process running // if we encounter a connection or other error if (!worker.isDead()) { if (!isKilling) { isKilling = true; worker.once('exit', function() { throw ex; }); worker.process.kill(); } return; } throw ex; }); } else { const server = net.createServer((socket) => socket.pipe(socket)); const cb = () => { process.send(['listening', server.address()]); debugger; }; if (common.hasIPv6) server.listen(0, '::1', cb); else server.listen(0, common.localhostIPv4, cb); process.on('disconnect', process.exit); } node-v4.8.2/test/parallel/test-cluster-disconnect-idle-worker.js000644 000766 000024 00000000616 13070706737 025105 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var cluster = require('cluster'); var fork = cluster.fork; if (cluster.isMaster) { fork(); // it is intentionally called `fork` instead of fork(); // `cluster.fork` to test that `this` is not used cluster.disconnect(common.mustCall(function() { assert.deepEqual(Object.keys(cluster.workers), []); })); } node-v4.8.2/test/parallel/test-cluster-disconnect-leak.js000644 000766 000024 00000001275 13070706737 023577 0ustar00iojsstaff000000 000000 'use strict'; // Test fails in Node v5.4.0 and passes in v5.4.1 and newer. const common = require('../common'); const net = require('net'); const cluster = require('cluster'); const noop = () => {}; cluster.schedulingPolicy = cluster.SCHED_NONE; if (cluster.isMaster) { const worker = cluster.fork(); // This is the important part of the test: Confirm that `disconnect` fires. worker.on('disconnect', common.mustCall(noop)); // These are just some extra stuff we're checking for good measure... worker.on('exit', common.mustCall(noop)); cluster.on('exit', common.mustCall(noop)); cluster.disconnect(); return; } const server = net.createServer(); server.listen(common.PORT); node-v4.8.2/test/parallel/test-cluster-disconnect-race.js000644 000766 000024 00000001645 13070706737 023576 0ustar00iojsstaff000000 000000 'use strict'; // This code triggers an AssertionError on Linux in Node.js 5.3.0 and earlier. // Ref: https://github.com/nodejs/node/issues/4205 const common = require('../common'); const assert = require('assert'); const net = require('net'); const cluster = require('cluster'); if (common.isWindows) { common.skip('This test does not apply to Windows.'); return; } cluster.schedulingPolicy = cluster.SCHED_NONE; if (cluster.isMaster) { var worker1, worker2; worker1 = cluster.fork(); worker1.on('message', common.mustCall(function() { worker2 = cluster.fork(); worker1.disconnect(); worker2.on('online', common.mustCall(worker2.disconnect)); })); cluster.on('exit', common.mustCall(function(worker, code) { assert.strictEqual(code, 0, 'worker exited with error'); }, 2)); return; } var server = net.createServer(); server.listen(common.PORT, function() { process.send('listening'); }); node-v4.8.2/test/parallel/test-cluster-disconnect-suicide-race.js000644 000766 000024 00000001147 13070706737 025216 0ustar00iojsstaff000000 000000 'use strict'; // Test should fail in Node.js 5.4.1 and pass in later versions. const common = require('../common'); const assert = require('assert'); const cluster = require('cluster'); if (cluster.isMaster) { cluster.on('exit', (worker, code) => { assert.strictEqual(code, 0, 'worker exited with error'); }); return cluster.fork(); } var eventFired = false; cluster.worker.disconnect(); process.nextTick(common.mustCall(() => { assert.strictEqual(eventFired, false, 'disconnect event should wait for ack'); })); cluster.worker.on('disconnect', common.mustCall(() => { eventFired = true; })); node-v4.8.2/test/parallel/test-cluster-disconnect-unshared-tcp.js000644 000766 000024 00000001013 13070706737 025246 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); process.env.NODE_CLUSTER_SCHED_POLICY = 'none'; var cluster = require('cluster'); var net = require('net'); if (cluster.isMaster) { var unbound = cluster.fork().on('online', bind); function bind() { cluster.fork({BOUND: 'y'}).on('listening', disconnect); } function disconnect() { unbound.disconnect(); unbound.on('disconnect', cluster.disconnect); } } else { if (process.env.BOUND === 'y') { var source = net.createServer(); source.listen(0); } } node-v4.8.2/test/parallel/test-cluster-disconnect-unshared-udp.js000644 000766 000024 00000001133 13070706737 025253 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); if (common.isWindows) { common.skip('on windows, because clustered dgram is ENOTSUP'); return; } var cluster = require('cluster'); var dgram = require('dgram'); if (cluster.isMaster) { var unbound = cluster.fork().on('online', bind); function bind() { cluster.fork({BOUND: 'y'}).on('listening', disconnect); } function disconnect() { unbound.disconnect(); unbound.on('disconnect', cluster.disconnect); } } else { if (process.env.BOUND === 'y') { var source = dgram.createSocket('udp4'); source.bind(0); } } node-v4.8.2/test/parallel/test-cluster-disconnect-with-no-workers.js000644 000766 000024 00000000477 13070706737 025745 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var cluster = require('cluster'); var disconnected; process.on('exit', function() { assert(disconnected); }); cluster.disconnect(function() { disconnected = true; }); // Assert that callback is not sometimes synchronous assert(!disconnected); node-v4.8.2/test/parallel/test-cluster-disconnect.js000644 000766 000024 00000004203 13070706737 022657 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var cluster = require('cluster'); var net = require('net'); if (cluster.isWorker) { net.createServer(function(socket) { socket.end('echo'); }).listen(common.PORT, '127.0.0.1'); net.createServer(function(socket) { socket.end('echo'); }).listen(common.PORT + 1, '127.0.0.1'); } else if (cluster.isMaster) { var servers = 2; // test a single TCP server var testConnection = function(port, cb) { var socket = net.connect(port, '127.0.0.1', function() { // buffer result var result = ''; socket.on('data', function(chunk) { result += chunk; }); // check result socket.on('end', function() { cb(result === 'echo'); }); }); }; // test both servers created in the cluster var testCluster = function(cb) { var done = 0; for (var i = 0, l = servers; i < l; i++) { testConnection(common.PORT + i, function(success) { assert.ok(success); done += 1; if (done === servers) { cb(); } }); } }; // start two workers and execute callback when both is listening var startCluster = function(cb) { var workers = 8; var online = 0; for (var i = 0, l = workers; i < l; i++) { var worker = cluster.fork(); worker.on('listening', function() { online += 1; if (online === workers * servers) { cb(); } }); } }; var results = { start: 0, test: 0, disconnect: 0 }; var test = function(again) { //1. start cluster startCluster(function() { results.start += 1; //2. test cluster testCluster(function() { results.test += 1; //3. disconnect cluster cluster.disconnect(function() { results.disconnect += 1; // run test again to confirm cleanup if (again) { test(); } }); }); }); }; test(true); process.once('exit', function() { assert.equal(results.start, 2); assert.equal(results.test, 2); assert.equal(results.disconnect, 2); }); } node-v4.8.2/test/parallel/test-cluster-eaccess.js000644 000766 000024 00000003401 13070706737 022133 0ustar00iojsstaff000000 000000 'use strict'; // Test that errors propagated from cluster workers are properly // received in their master. Creates an EADDRINUSE condition by forking // a process in child cluster and propagates the error to the master. const common = require('../common'); const assert = require('assert'); const cluster = require('cluster'); const fork = require('child_process').fork; const fs = require('fs'); const net = require('net'); if (cluster.isMaster) { const worker = cluster.fork(); // makes sure master is able to fork the worker cluster.on('fork', common.mustCall(function() {})); // makes sure the worker is ready worker.on('online', common.mustCall(function() {})); worker.on('message', common.mustCall(function(err) { // disconnect first, so that we will not leave zombies worker.disconnect(); console.log(err); assert.strictEqual('EADDRINUSE', err.code); })); process.on('exit', function() { console.log('master exited'); try { fs.unlinkSync(common.PIPE); } catch (e) { } }); } else { common.refreshTmpDir(); var cp = fork(common.fixturesDir + '/listen-on-socket-and-exit.js', { stdio: 'inherit' }); // message from the child indicates it's ready and listening cp.on('message', common.mustCall(function() { const server = net.createServer().listen(common.PIPE, function() { // message child process so that it can exit cp.send('end'); // inform master about the unexpected situation process.send('PIPE should have been in use.'); }); server.on('error', function(err) { console.log('parent error, ending'); // message to child process tells it to exit cp.send('end'); // propagate error to parent process.send(err); }); })); } node-v4.8.2/test/parallel/test-cluster-eaddrinuse.js000644 000766 000024 00000002334 13070706737 022654 0ustar00iojsstaff000000 000000 'use strict'; // Check that having a worker bind to a port that's already taken doesn't // leave the master process in a confused state. Releasing the port and // trying again should Just Work[TM]. var common = require('../common'); var assert = require('assert'); var fork = require('child_process').fork; var net = require('net'); var id = '' + process.argv[2]; if (id === 'undefined') { const server = net.createServer(common.fail); server.listen(common.PORT, function() { var worker = fork(__filename, ['worker']); worker.on('message', function(msg) { if (msg !== 'stop-listening') return; server.close(function() { worker.send('stopped-listening'); }); }); }); } else if (id === 'worker') { let server = net.createServer(common.fail); server.listen(common.PORT, common.fail); server.on('error', common.mustCall(function(e) { assert(e.code, 'EADDRINUSE'); process.send('stop-listening'); process.once('message', function(msg) { if (msg !== 'stopped-listening') return; server = net.createServer(common.fail); server.listen(common.PORT, common.mustCall(function() { server.close(); })); }); })); } else { assert(0); // Bad argument. } node-v4.8.2/test/parallel/test-cluster-fork-env.js000644 000766 000024 00000002025 13070706737 022255 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var cluster = require('cluster'); if (cluster.isWorker) { cluster.worker.send({ prop: process.env['cluster_test_prop'], overwrite: process.env['cluster_test_overwrite'] }); } else if (cluster.isMaster) { var checks = { using: false, overwrite: false }; // To check that the cluster extend on the process.env we will overwrite a // property process.env['cluster_test_overwrite'] = 'old'; // Fork worker var worker = cluster.fork({ 'cluster_test_prop': 'custom', 'cluster_test_overwrite': 'new' }); // Checks worker env worker.on('message', function(data) { checks.using = (data.prop === 'custom'); checks.overwrite = (data.overwrite === 'new'); process.exit(0); }); process.once('exit', function() { assert.ok(checks.using, 'The worker did not receive the correct env.'); assert.ok(checks.overwrite, 'The custom environment did not overwrite ' + 'the existing environment.'); }); } node-v4.8.2/test/parallel/test-cluster-http-pipe.js000644 000766 000024 00000001753 13070706737 022447 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const cluster = require('cluster'); const http = require('http'); if (common.isWindows) { common.skip('It is not possible to send pipe handles over ' + 'the IPC pipe on Windows'); return; } if (cluster.isMaster) { common.refreshTmpDir(); var worker = cluster.fork(); worker.on('message', common.mustCall(function(msg) { assert.equal(msg, 'DONE'); })); worker.on('exit', function() { process.exit(); }); return; } http.createServer(function(req, res) { assert.equal(req.connection.remoteAddress, undefined); assert.equal(req.connection.localAddress, undefined); // TODO common.PIPE? res.writeHead(200); res.end('OK'); }).listen(common.PIPE, function() { http.get({ socketPath: common.PIPE, path: '/' }, function(res) { res.resume(); res.on('end', function(err) { if (err) throw err; process.send('DONE'); process.exit(); }); }); }); node-v4.8.2/test/parallel/test-cluster-invalid-message.js000644 000766 000024 00000000716 13070706737 023603 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const cluster = require('cluster'); if (cluster.isMaster) { const worker = cluster.fork(); worker.on('exit', common.mustCall((code, signal) => { assert.strictEqual(code, 0); assert.strictEqual(signal, null); })); worker.on('online', () => { worker.send({ cmd: 'NODE_CLUSTER', ack: -1 }, () => { worker.disconnect(); }); }); } node-v4.8.2/test/parallel/test-cluster-ipc-throw.js000644 000766 000024 00000001062 13070706737 022442 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const http = require('http'); const cluster = require('cluster'); cluster.schedulingPolicy = cluster.SCHED_RR; const server = http.createServer(); if (cluster.isMaster) { server.listen(common.PORT); const worker = cluster.fork(); worker.on('exit', common.mustCall(() => { server.close(); })); } else { process.on('uncaughtException', common.mustCall((e) => {})); server.listen(common.PORT); server.on('error', common.mustCall((e) => { cluster.worker.disconnect(); throw e; })); } node-v4.8.2/test/parallel/test-cluster-listening-port.js000644 000766 000024 00000001004 13070706737 023500 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var cluster = require('cluster'); var net = require('net'); if (cluster.isMaster) { cluster.fork(); cluster.on('listening', common.mustCall(function(worker, address) { const port = address.port; // ensure that the port is not 0 or null assert(port); // ensure that the port is numerical assert.strictEqual(typeof port, 'number'); worker.kill(); })); } else { net.createServer(common.fail).listen(0); } node-v4.8.2/test/parallel/test-cluster-master-error.js000644 000766 000024 00000005227 13070706737 023157 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var cluster = require('cluster'); // Cluster setup if (cluster.isWorker) { var http = require('http'); http.Server(function() { }).listen(common.PORT, '127.0.0.1'); } else if (process.argv[2] === 'cluster') { var totalWorkers = 2; // Send PID to testcase process var forkNum = 0; cluster.on('fork', function forkEvent(worker) { // Send PID process.send({ cmd: 'worker', workerPID: worker.process.pid }); // Stop listening when done if (++forkNum === totalWorkers) { cluster.removeListener('fork', forkEvent); } }); // Throw accidental error when all workers are listening var listeningNum = 0; cluster.on('listening', function listeningEvent() { // When all workers are listening if (++listeningNum === totalWorkers) { // Stop listening cluster.removeListener('listening', listeningEvent); // Throw accidental error process.nextTick(function() { console.error('about to throw'); throw new Error('accidental error'); }); } }); // Startup a basic cluster cluster.fork(); cluster.fork(); } else { // This is the testcase var fork = require('child_process').fork; var isAlive = function(pid) { try { //this will throw an error if the process is dead process.kill(pid, 0); return true; } catch (e) { return false; } }; var masterExited = false; var workersExited = false; // List all workers var workers = []; // Spawn a cluster process var master = fork(process.argv[1], ['cluster'], {silent: true}); // Handle messages from the cluster master.on('message', function(data) { // Add worker pid to list and progress tracker if (data.cmd === 'worker') { workers.push(data.workerPID); } }); // When cluster is dead master.on('exit', function(code) { // Check that the cluster died accidentally (non-zero exit code) masterExited = !!code; var pollWorkers = function() { // When master is dead all workers should be dead too var alive = false; workers.forEach(function(pid) { if (isAlive(pid)) { alive = true; } }); if (alive) { setTimeout(pollWorkers, 50); } else { workersExited = true; } }; // Loop indefinitely until worker exit pollWorkers(); }); process.once('exit', function() { var m = 'The master did not die after an error was thrown'; assert.ok(masterExited, m); m = 'The workers did not die after an error in the master'; assert.ok(workersExited, m); }); } node-v4.8.2/test/parallel/test-cluster-master-kill.js000644 000766 000024 00000003146 13070706737 022757 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var cluster = require('cluster'); if (cluster.isWorker) { // keep the worker alive var http = require('http'); http.Server().listen(common.PORT, '127.0.0.1'); } else if (process.argv[2] === 'cluster') { var worker = cluster.fork(); // send PID info to testcase process process.send({ pid: worker.process.pid }); // terminate the cluster process worker.once('listening', function() { setTimeout(function() { process.exit(0); }, 1000); }); } else { // This is the testcase var fork = require('child_process').fork; // is process alive helper var isAlive = function(pid) { try { //this will throw an error if the process is dead process.kill(pid, 0); return true; } catch (e) { return false; } }; // Spawn a cluster process var master = fork(process.argv[1], ['cluster']); // get pid info var pid = null; master.once('message', function(data) { pid = data.pid; }); // When master is dead var alive = true; master.on('exit', function(code) { // make sure that the master died on purpose assert.equal(code, 0); // check worker process status var pollWorker = function() { alive = isAlive(pid); if (alive) { setTimeout(pollWorker, 50); } }; // Loop indefinitely until worker exit. pollWorker(); }); process.once('exit', function() { assert.equal(typeof pid, 'number', 'did not get worker pid info'); assert.equal(alive, false, 'worker was alive after master died'); }); } node-v4.8.2/test/parallel/test-cluster-message.js000644 000766 000024 00000005625 13070706737 022163 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var cluster = require('cluster'); var net = require('net'); function forEach(obj, fn) { Object.keys(obj).forEach(function(name, index) { fn(obj[name], name); }); } if (cluster.isWorker) { // Create a tcp server. This will be used as cluster-shared-server and as an // alternative IPC channel. var server = net.Server(); var socket, message; function maybeReply() { if (!socket || !message) return; // Tell master using TCP socket that a message is received. socket.write(JSON.stringify({ code: 'received message', echo: message })); } server.on('connection', function(socket_) { socket = socket_; maybeReply(); // Send a message back over the IPC channel. process.send('message from worker'); }); process.on('message', function(message_) { message = message_; maybeReply(); }); server.listen(common.PORT, '127.0.0.1'); } else if (cluster.isMaster) { var checks = { global: { 'receive': false, 'correct': false }, master: { 'receive': false, 'correct': false }, worker: { 'receive': false, 'correct': false } }; var client; var check = function(type, result) { checks[type].receive = true; checks[type].correct = result; console.error('check', checks); var missing = false; forEach(checks, function(type) { if (type.receive === false) missing = true; }); if (missing === false) { console.error('end client'); client.end(); } }; // Spawn worker var worker = cluster.fork(); // When a IPC message is received from the worker worker.on('message', function(message) { check('master', message === 'message from worker'); }); cluster.on('message', function(message) { check('global', message === 'message from worker'); }); // When a TCP server is listening in the worker connect to it worker.on('listening', function() { client = net.connect(common.PORT, function() { // Send message to worker. worker.send('message from master'); }); client.on('data', function(data) { // All data is JSON data = JSON.parse(data.toString()); if (data.code === 'received message') { check('worker', data.echo === 'message from master'); } else { throw new Error('wrong TCP message recived: ' + data); } }); // When the connection ends kill worker and shutdown process client.on('end', function() { worker.kill(); }); worker.on('exit', function() { process.exit(0); }); }); process.once('exit', function() { forEach(checks, function(check, type) { assert.ok(check.receive, 'The ' + type + ' did not receive any message'); assert.ok(check.correct, 'The ' + type + ' did not get the correct message'); }); }); } node-v4.8.2/test/parallel/test-cluster-net-listen.js000644 000766 000024 00000000704 13070706737 022612 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const cluster = require('cluster'); const net = require('net'); if (cluster.isMaster) { // ensure that the worker exits peacefully cluster.fork().on('exit', common.mustCall(function(statusCode) { assert.equal(statusCode, 0); })); } else { // listen() without port should not trigger a libuv assert net.createServer(common.fail).listen(process.exit); } node-v4.8.2/test/parallel/test-cluster-net-send.js000644 000766 000024 00000002445 13070706737 022251 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const fork = require('child_process').fork; const net = require('net'); if (process.argv[2] !== 'child') { console.error('[%d] master', process.pid); const worker = fork(__filename, ['child']); let called = false; worker.once('message', common.mustCall(function(msg, handle) { assert.strictEqual(msg, 'handle'); assert.ok(handle); worker.send('got'); handle.on('data', function(data) { called = true; assert.strictEqual(data.toString(), 'hello'); }); handle.on('end', function() { worker.kill(); }); })); process.once('exit', function() { assert.ok(called); }); } else { console.error('[%d] worker', process.pid); let socket; let cbcalls = 0; function socketConnected() { if (++cbcalls === 2) process.send('handle', socket); } const server = net.createServer(function(c) { process.once('message', common.mustCall(function(msg) { assert.strictEqual(msg, 'got'); c.end('hello'); })); socketConnected(); }); server.listen(common.PORT, function() { socket = net.connect(common.PORT, '127.0.0.1', socketConnected); }); process.on('disconnect', function() { process.exit(); server.close(); }); } node-v4.8.2/test/parallel/test-cluster-process-disconnect.js000644 000766 000024 00000001035 13070706737 024333 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const cluster = require('cluster'); if (cluster.isMaster) { const worker = cluster.fork(); worker.on('exit', common.mustCall((code, signal) => { assert.strictEqual(code, 0, 'worker did not exit normally'); assert.strictEqual(signal, null, 'worker did not exit normally'); })); } else { const net = require('net'); const server = net.createServer(); server.listen(common.PORT, common.mustCall(() => { process.disconnect(); })); } node-v4.8.2/test/parallel/test-cluster-rr-domain-listen.js000644 000766 000024 00000001271 13070706737 023714 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var cluster = require('cluster'); var domain = require('domain'); // RR is the default for v0.11.9+ so the following line is redundant: // cluster.schedulingPolicy = cluster.SCHED_RR; if (cluster.isWorker) { var d = domain.create(); d.run(function() { }); var http = require('http'); http.Server(function() { }).listen(common.PORT, '127.0.0.1'); } else if (cluster.isMaster) { var worker; //Kill worker when listening cluster.on('listening', function() { worker.kill(); }); //Kill process when worker is killed cluster.on('exit', function() { process.exit(0); }); //Create worker worker = cluster.fork(); } node-v4.8.2/test/parallel/test-cluster-rr-ref.js000644 000766 000024 00000000672 13070706737 021731 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const cluster = require('cluster'); const net = require('net'); if (cluster.isMaster) { cluster.fork().on('message', function(msg) { if (msg === 'done') this.kill(); }); } else { const server = net.createServer(common.fail); server.listen(common.PORT, function() { server.unref(); server.ref(); server.close(function() { process.send('done'); }); }); } node-v4.8.2/test/parallel/test-cluster-send-deadlock.js000644 000766 000024 00000002320 13070706737 023221 0ustar00iojsstaff000000 000000 'use strict'; // Testing mutual send of handles: from master to worker, and from worker to // master. var common = require('../common'); var assert = require('assert'); var cluster = require('cluster'); var net = require('net'); if (cluster.isMaster) { var worker = cluster.fork(); worker.on('exit', function(code, signal) { assert.strictEqual(code, 0, 'Worker exited with an error code'); assert(!signal, 'Worker exited by a signal'); server.close(); }); var server = net.createServer(function(socket) { worker.send('handle', socket); }); server.listen(common.PORT, function() { worker.send('listen'); }); } else { process.on('message', function(msg, handle) { if (msg === 'listen') { var client1 = net.connect({ host: 'localhost', port: common.PORT }); var client2 = net.connect({ host: 'localhost', port: common.PORT }); var waiting = 2; client1.on('close', onclose); client2.on('close', onclose); function onclose() { if (--waiting === 0) cluster.worker.disconnect(); } setTimeout(function() { client1.end(); client2.end(); }, 50); } else { process.send('reply', handle); } }); } node-v4.8.2/test/parallel/test-cluster-send-handle-twice.js000644 000766 000024 00000002116 13070706737 024022 0ustar00iojsstaff000000 000000 'use strict'; // Testing to send an handle twice to the parent process. const common = require('../common'); const assert = require('assert'); const cluster = require('cluster'); const net = require('net'); const workers = { toStart: 1 }; if (cluster.isMaster) { for (let i = 0; i < workers.toStart; ++i) { const worker = cluster.fork(); worker.on('exit', common.mustCall(function(code, signal) { assert.strictEqual(code, 0, 'Worker exited with an error code'); assert.strictEqual(signal, null, 'Worker exited by a signal'); })); } } else { const server = net.createServer(function(socket) { process.send('send-handle-1', socket); process.send('send-handle-2', socket); }); server.listen(common.PORT, function() { const client = net.connect({ host: 'localhost', port: common.PORT }); client.on('close', common.mustCall(() => { cluster.worker.disconnect(); })); setTimeout(function() { client.end(); }, 50); }).on('error', function(e) { console.error(e); common.fail('server.listen failed'); cluster.worker.disconnect(); }); } node-v4.8.2/test/parallel/test-cluster-server-restart-none.js000644 000766 000024 00000002126 13070706737 024455 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const cluster = require('cluster'); cluster.schedulingPolicy = cluster.SCHED_NONE; if (cluster.isMaster) { const worker1 = cluster.fork(); worker1.on('listening', common.mustCall(() => { const worker2 = cluster.fork(); worker2.on('exit', (code, signal) => { assert.strictEqual(code, 0, 'worker2 did not exit normally'); assert.strictEqual(signal, null, 'worker2 did not exit normally'); worker1.disconnect(); }); })); worker1.on('exit', common.mustCall((code, signal) => { assert.strictEqual(code, 0, 'worker1 did not exit normally'); assert.strictEqual(signal, null, 'worker1 did not exit normally'); })); } else { const net = require('net'); const server = net.createServer(); server.listen(common.PORT, common.mustCall(() => { if (cluster.worker.id === 2) { server.close(() => { server.listen(common.PORT, common.mustCall(() => { server.close(() => { process.disconnect(); }); })); }); } })); } node-v4.8.2/test/parallel/test-cluster-server-restart-rr.js000644 000766 000024 00000002124 13070706737 024137 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const cluster = require('cluster'); cluster.schedulingPolicy = cluster.SCHED_RR; if (cluster.isMaster) { const worker1 = cluster.fork(); worker1.on('listening', common.mustCall(() => { const worker2 = cluster.fork(); worker2.on('exit', (code, signal) => { assert.strictEqual(code, 0, 'worker2 did not exit normally'); assert.strictEqual(signal, null, 'worker2 did not exit normally'); worker1.disconnect(); }); })); worker1.on('exit', common.mustCall((code, signal) => { assert.strictEqual(code, 0, 'worker1 did not exit normally'); assert.strictEqual(signal, null, 'worker1 did not exit normally'); })); } else { const net = require('net'); const server = net.createServer(); server.listen(common.PORT, common.mustCall(() => { if (cluster.worker.id === 2) { server.close(() => { server.listen(common.PORT, common.mustCall(() => { server.close(() => { process.disconnect(); }); })); }); } })); } node-v4.8.2/test/parallel/test-cluster-setup-master-argv.js000644 000766 000024 00000001104 13070706737 024111 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const cluster = require('cluster'); setTimeout(common.fail.bind(assert, 'setup not emitted'), 1000).unref(); cluster.on('setup', common.mustCall(function() { var clusterArgs = cluster.settings.args; var realArgs = process.argv; assert.strictEqual(clusterArgs[clusterArgs.length - 1], realArgs[realArgs.length - 1]); })); assert(process.argv[process.argv.length - 1] !== 'OMG,OMG'); process.argv.push('OMG,OMG'); process.argv.push('OMG,OMG'); cluster.setupMaster(); node-v4.8.2/test/parallel/test-cluster-setup-master-cumulative.js000644 000766 000024 00000002337 13070706737 025341 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var cluster = require('cluster'); assert(cluster.isMaster); assert.deepEqual(cluster.settings, {}, 'cluster.settings should not be initialized until needed'); cluster.setupMaster(); assert.deepEqual(cluster.settings, { args: process.argv.slice(2), exec: process.argv[1], execArgv: process.execArgv, silent: false, }); console.log('ok sets defaults'); cluster.setupMaster({ exec: 'overridden' }); assert.strictEqual(cluster.settings.exec, 'overridden'); console.log('ok overrids defaults'); cluster.setupMaster({ args: ['foo', 'bar'] }); assert.strictEqual(cluster.settings.exec, 'overridden'); assert.deepEqual(cluster.settings.args, ['foo', 'bar']); cluster.setupMaster({ execArgv: ['baz', 'bang'] }); assert.strictEqual(cluster.settings.exec, 'overridden'); assert.deepEqual(cluster.settings.args, ['foo', 'bar']); assert.deepEqual(cluster.settings.execArgv, ['baz', 'bang']); console.log('ok preserves unchanged settings on repeated calls'); cluster.setupMaster(); assert.deepEqual(cluster.settings, { args: ['foo', 'bar'], exec: 'overridden', execArgv: ['baz', 'bang'], silent: false, }); console.log('ok preserves current settings'); node-v4.8.2/test/parallel/test-cluster-setup-master-emit.js000644 000766 000024 00000001205 13070706737 024112 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var cluster = require('cluster'); assert(cluster.isMaster); function emitAndCatch(next) { cluster.once('setup', common.mustCall(function(settings) { assert.strictEqual(settings.exec, 'new-exec'); setImmediate(next); })); cluster.setupMaster({ exec: 'new-exec' }); } function emitAndCatch2(next) { cluster.once('setup', common.mustCall(function(settings) { assert('exec' in settings); setImmediate(next); })); cluster.setupMaster(); } emitAndCatch(common.mustCall(function() { emitAndCatch2(common.mustCall(function() {})); })); node-v4.8.2/test/parallel/test-cluster-setup-master-multiple.js000644 000766 000024 00000002500 13070706737 025006 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var cluster = require('cluster'); assert(cluster.isMaster); // The cluster.settings object is cloned even though the current implementation // makes that unecessary. This is to make the test less fragile if the // implementation ever changes such that cluster.settings is mutated instead of // replaced. function cheapClone(obj) { return JSON.parse(JSON.stringify(obj)); } var configs = []; // Capture changes cluster.on('setup', function() { console.log('"setup" emitted', cluster.settings); configs.push(cheapClone(cluster.settings)); }); var execs = [ 'node-next', 'node-next-2', 'node-next-3', ]; process.on('exit', function assertTests() { // Tests that "setup" is emitted for every call to setupMaster assert.strictEqual(configs.length, execs.length); assert.strictEqual(configs[0].exec, execs[0]); assert.strictEqual(configs[1].exec, execs[1]); assert.strictEqual(configs[2].exec, execs[2]); }); // Make changes to cluster settings execs.forEach(function(v, i) { setTimeout(function() { cluster.setupMaster({ exec: v }); }, i * 100); }); // cluster emits 'setup' asynchronously, so we must stay alive long // enough for that to happen setTimeout(function() { console.log('cluster setup complete'); }, (execs.length + 1) * 100); node-v4.8.2/test/parallel/test-cluster-setup-master.js000644 000766 000024 00000003002 13070706737 023153 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var cluster = require('cluster'); if (cluster.isWorker) { // Just keep the worker alive process.send(process.argv[2]); } else if (cluster.isMaster) { var checks = { args: false, setupEvent: false, settingsObject: false }; var totalWorkers = 2; // Setup master cluster.setupMaster({ args: ['custom argument'], silent: true }); cluster.once('setup', function() { checks.setupEvent = true; var settings = cluster.settings; if (settings && settings.args && settings.args[0] === 'custom argument' && settings.silent === true && settings.exec === process.argv[1]) { checks.settingsObject = true; } }); var correctIn = 0; cluster.on('online', function lisenter(worker) { worker.once('message', function(data) { correctIn += (data === 'custom argument' ? 1 : 0); if (correctIn === totalWorkers) { checks.args = true; } worker.kill(); }); // All workers are online if (cluster.onlineWorkers === totalWorkers) { checks.workers = true; } }); // Start all workers cluster.fork(); cluster.fork(); // Check all values process.once('exit', function() { assert.ok(checks.args, 'The arguments was noy send to the worker'); assert.ok(checks.setupEvent, 'The setup event was never emitted'); var m = 'The settingsObject do not have correct properties'; assert.ok(checks.settingsObject, m); }); } node-v4.8.2/test/parallel/test-cluster-shared-handle-bind-error.js000644 000766 000024 00000001572 13070706737 025274 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const cluster = require('cluster'); const net = require('net'); if (cluster.isMaster) { // Master opens and binds the socket and shares it with the worker. cluster.schedulingPolicy = cluster.SCHED_NONE; // Hog the TCP port so that when the worker tries to bind, it'll fail. const server = net.createServer(common.fail); server.listen(common.PORT, common.mustCall(() => { const worker = cluster.fork(); worker.on('exit', common.mustCall((exitCode) => { assert.strictEqual(exitCode, 0); server.close(); })); })); } else { const s = net.createServer(common.fail); s.listen(common.PORT, common.fail.bind(null, 'listen should have failed')); s.on('error', common.mustCall((err) => { assert.strictEqual(err.code, 'EADDRINUSE'); process.disconnect(); })); } node-v4.8.2/test/parallel/test-cluster-shared-handle-bind-privileged-port.js000644 000766 000024 00000001477 13070706737 027263 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const cluster = require('cluster'); const net = require('net'); if (common.isWindows) { common.skip('not reliable on Windows'); return; } if (process.getuid() === 0) { common.skip('as this test should not be run as `root`'); return; } if (cluster.isMaster) { // Master opens and binds the socket and shares it with the worker. cluster.schedulingPolicy = cluster.SCHED_NONE; cluster.fork().on('exit', common.mustCall(function(exitCode) { assert.strictEqual(exitCode, 0); })); } else { const s = net.createServer(common.fail); s.listen(42, common.fail.bind(null, 'listen should have failed')); s.on('error', common.mustCall(function(err) { assert.strictEqual(err.code, 'EACCES'); process.disconnect(); })); } node-v4.8.2/test/parallel/test-cluster-shared-leak.js000644 000766 000024 00000002654 13070706737 022716 0ustar00iojsstaff000000 000000 // In Node 4.2.1 on operating systems other than Linux, this test triggers an // assertion in cluster.js. The assertion protects against memory leaks. // https://github.com/nodejs/node/pull/3510 'use strict'; const common = require('../common'); const assert = require('assert'); const net = require('net'); const cluster = require('cluster'); cluster.schedulingPolicy = cluster.SCHED_NONE; if (cluster.isMaster) { var conn, worker1, worker2; worker1 = cluster.fork(); worker1.on('message', common.mustCall(function() { worker2 = cluster.fork(); worker2.on('online', function() { conn = net.connect(common.PORT, common.mustCall(function() { worker1.disconnect(); worker2.disconnect(); })); conn.on('error', function(e) { // ECONNRESET is OK if (e.code !== 'ECONNRESET') throw e; }); }); })); cluster.on('exit', function(worker, exitCode, signalCode) { assert(worker === worker1 || worker === worker2); assert.strictEqual(exitCode, 0); assert.strictEqual(signalCode, null); if (Object.keys(cluster.workers).length === 0) conn.destroy(); }); return; } const server = net.createServer(function(c) { c.on('error', function(e) { // ECONNRESET is OK, so we don't exit with code !== 0 if (e.code !== 'ECONNRESET') throw e; }); c.end('bye'); }); server.listen(common.PORT, function() { process.send('listening'); }); node-v4.8.2/test/parallel/test-cluster-uncaught-exception.js000644 000766 000024 00000001472 13070706737 024345 0ustar00iojsstaff000000 000000 'use strict'; // Installing a custom uncaughtException handler should override the default // one that the cluster module installs. // https://github.com/joyent/node/issues/2556 const common = require('../common'); var assert = require('assert'); var cluster = require('cluster'); var fork = require('child_process').fork; var MAGIC_EXIT_CODE = 42; var isTestRunner = process.argv[2] != 'child'; if (isTestRunner) { var master = fork(__filename, ['child']); master.on('exit', common.mustCall(function(code) { assert.strictEqual(code, MAGIC_EXIT_CODE); })); } else if (cluster.isMaster) { process.on('uncaughtException', function() { process.nextTick(function() { process.exit(MAGIC_EXIT_CODE); }); }); cluster.fork(); throw new Error('kill master'); } else { // worker process.exit(); } node-v4.8.2/test/parallel/test-cluster-worker-constructor.js000644 000766 000024 00000001433 13070706737 024424 0ustar00iojsstaff000000 000000 'use strict'; // test-cluster-worker-constructor.js // validates correct behavior of the cluster.Worker constructor require('../common'); const assert = require('assert'); const cluster = require('cluster'); let worker; worker = new cluster.Worker(); assert.strictEqual(worker.suicide, undefined); assert.strictEqual(worker.state, 'none'); assert.strictEqual(worker.id, 0); assert.strictEqual(worker.process, undefined); worker = new cluster.Worker({ id: 3, state: 'online', process: process }); assert.strictEqual(worker.suicide, undefined); assert.strictEqual(worker.state, 'online'); assert.strictEqual(worker.id, 3); assert.strictEqual(worker.process, process); worker = cluster.Worker.call({}, {id: 5}); assert(worker instanceof cluster.Worker); assert.strictEqual(worker.id, 5); node-v4.8.2/test/parallel/test-cluster-worker-death.js000644 000766 000024 00000000700 13070706737 023120 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var cluster = require('cluster'); if (!cluster.isMaster) { process.exit(42); } else { var worker = cluster.fork(); worker.on('exit', common.mustCall(function(exitCode, signalCode) { assert.equal(exitCode, 42); assert.equal(signalCode, null); })); cluster.on('exit', common.mustCall(function(worker_) { assert.equal(worker_, worker); })); } node-v4.8.2/test/parallel/test-cluster-worker-destroy.js000644 000766 000024 00000001746 13070706737 023537 0ustar00iojsstaff000000 000000 'use strict'; /* * The goal of this test is to cover the Workers' implementation of * Worker.prototype.destroy. Worker.prototype.destroy is called within * the worker's context: once when the worker is still connected to the * master, and another time when it's not connected to it, so that we cover * both code paths. */ const common = require('../common'); var cluster = require('cluster'); var worker1, worker2; if (cluster.isMaster) { worker1 = cluster.fork(); worker2 = cluster.fork(); [worker1, worker2].forEach(function(worker) { worker.on('disconnect', common.mustCall(function() {})); worker.on('exit', common.mustCall(function() {})); }); } else { if (cluster.worker.id === 1) { // Call destroy when worker is disconnected cluster.worker.process.on('disconnect', function() { cluster.worker.destroy(); }); cluster.worker.disconnect(); } else { // Call destroy when worker is not disconnected yet cluster.worker.destroy(); } } node-v4.8.2/test/parallel/test-cluster-worker-disconnect-on-error.js000644 000766 000024 00000000747 13070706737 025740 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const http = require('http'); const cluster = require('cluster'); cluster.schedulingPolicy = cluster.SCHED_NONE; const server = http.createServer(); if (cluster.isMaster) { server.listen(common.PORT); const worker = cluster.fork(); worker.on('exit', common.mustCall(() => { server.close(); })); } else { server.listen(common.PORT); server.on('error', common.mustCall((e) => { cluster.worker.disconnect(); })); } node-v4.8.2/test/parallel/test-cluster-worker-disconnect.js000644 000766 000024 00000004424 13070706737 024173 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var cluster = require('cluster'); if (cluster.isWorker) { var http = require('http'); http.Server(function() { }).listen(common.PORT, '127.0.0.1'); cluster.worker.on('disconnect', function() { process.exit(42); }); } else if (cluster.isMaster) { var checks = { cluster: { emitDisconnect: false, emitExit: false, callback: false }, worker: { emitDisconnect: false, emitDisconnectInsideWorker: false, emitExit: false, state: false, suicideMode: false, died: false } }; // helper function to check if a process is alive var alive = function(pid) { try { process.kill(pid, 0); return true; } catch (e) { return false; } }; // start worker var worker = cluster.fork(); // Disconnect worker when it is ready worker.once('listening', function() { worker.disconnect(); }); // Check cluster events cluster.once('disconnect', function() { checks.cluster.emitDisconnect = true; }); cluster.once('exit', function() { checks.cluster.emitExit = true; }); // Check worker events and properties worker.once('disconnect', function() { checks.worker.emitDisconnect = true; checks.worker.suicideMode = worker.suicide; checks.worker.state = worker.state; }); // Check that the worker died worker.once('exit', function(code) { checks.worker.emitExit = true; checks.worker.died = !alive(worker.process.pid); checks.worker.emitDisconnectInsideWorker = code === 42; }); process.once('exit', function() { var w = checks.worker; var c = checks.cluster; // events assert.ok(w.emitDisconnect, 'Disconnect event did not emit'); assert.ok(w.emitDisconnectInsideWorker, 'Disconnect event did not emit inside worker'); assert.ok(c.emitDisconnect, 'Disconnect event did not emit'); assert.ok(w.emitExit, 'Exit event did not emit'); assert.ok(c.emitExit, 'Exit event did not emit'); // flags assert.equal(w.state, 'disconnected', 'The state property was not set'); assert.equal(w.suicideMode, true, 'Suicide mode was not set'); // is process alive assert.ok(w.died, 'The worker did not die'); }); } node-v4.8.2/test/parallel/test-cluster-worker-events.js000644 000766 000024 00000001706 13070706737 023346 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var cluster = require('cluster'); var OK = 2; if (cluster.isMaster) { var worker = cluster.fork(); worker.on('exit', function(code) { assert.strictEqual(code, OK); process.exit(0); }); worker.send('SOME MESSAGE'); return; } // Messages sent to a worker will be emitted on both the process object and the // process.worker object. assert(cluster.isWorker); var sawProcess; var sawWorker; process.on('message', function(m) { assert(!sawProcess); sawProcess = true; check(m); }); cluster.worker.on('message', function(m) { assert(!sawWorker); sawWorker = true; check(m); }); var messages = []; function check(m) { messages.push(m); if (messages.length < 2) return; assert.deepEqual(messages[0], messages[1]); cluster.worker.once('error', function(e) { assert.strictEqual(e, 'HI'); process.exit(OK); }); process.emit('error', 'HI'); } node-v4.8.2/test/parallel/test-cluster-worker-exit.js000644 000766 000024 00000007172 13070706737 023016 0ustar00iojsstaff000000 000000 'use strict'; // test-cluster-worker-exit.js // verifies that, when a child process exits (by calling `process.exit(code)`) // - the parent receives the proper events in the proper order, no duplicates // - the exitCode and signalCode are correct in the 'exit' event // - the worker.suicide flag, and worker.state are correct // - the worker process actually goes away var common = require('../common'); var assert = require('assert'); var cluster = require('cluster'); var EXIT_CODE = 42; if (cluster.isWorker) { var http = require('http'); var server = http.Server(function() { }); server.once('listening', function() { process.exit(EXIT_CODE); }); server.listen(common.PORT, '127.0.0.1'); } else if (cluster.isMaster) { var expected_results = { cluster_emitDisconnect: [1, "the cluster did not emit 'disconnect'"], cluster_emitExit: [1, "the cluster did not emit 'exit'"], cluster_exitCode: [EXIT_CODE, 'the cluster exited w/ incorrect exitCode'], cluster_signalCode: [null, 'the cluster exited w/ incorrect signalCode'], worker_emitDisconnect: [1, "the worker did not emit 'disconnect'"], worker_emitExit: [1, "the worker did not emit 'exit'"], worker_state: ['disconnected', 'the worker state is incorrect'], worker_suicideMode: [false, 'the worker.suicide flag is incorrect'], worker_died: [true, 'the worker is still running'], worker_exitCode: [EXIT_CODE, 'the worker exited w/ incorrect exitCode'], worker_signalCode: [null, 'the worker exited w/ incorrect signalCode'] }; var results = { cluster_emitDisconnect: 0, cluster_emitExit: 0, worker_emitDisconnect: 0, worker_emitExit: 0 }; // start worker var worker = cluster.fork(); worker.once('listening', function() { // the worker is up and running... }); // Check cluster events cluster.on('disconnect', function() { results.cluster_emitDisconnect += 1; }); cluster.on('exit', function(worker) { results.cluster_exitCode = worker.process.exitCode; results.cluster_signalCode = worker.process.signalCode; results.cluster_emitExit += 1; }); // Check worker events and properties worker.on('disconnect', function() { results.worker_emitDisconnect += 1; results.worker_suicideMode = worker.suicide; results.worker_state = worker.state; if (results.worker_emitExit > 0) { process.nextTick(function() { finish_test(); }); } }); // Check that the worker died worker.once('exit', function(exitCode, signalCode) { results.worker_exitCode = exitCode; results.worker_signalCode = signalCode; results.worker_emitExit += 1; results.worker_died = !alive(worker.process.pid); if (results.worker_emitDisconnect > 0) { process.nextTick(function() { finish_test(); }); } }); var finish_test = function() { try { checkResults(expected_results, results); } catch (exc) { console.error('FAIL: ' + exc.message); if (exc.name != 'AssertionError') { console.trace(exc); } process.exit(1); return; } process.exit(0); }; } // some helper functions ... function checkResults(expected_results, results) { for (var k in expected_results) { const actual = results[k]; const expected = expected_results[k]; var msg = (expected[1] || '') + (' [expected: ' + expected[0] + ' / actual: ' + actual + ']'); if (expected && expected.length) { assert.equal(actual, expected[0], msg); } else { assert.equal(actual, expected, msg); } } } function alive(pid) { try { process.kill(pid, 'SIGCONT'); return true; } catch (e) { return false; } } node-v4.8.2/test/parallel/test-cluster-worker-forced-exit.js000644 000766 000024 00000002076 13070706737 024254 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var cluster = require('cluster'); var SENTINEL = 42; // workers forcibly exit when control channel is disconnected, if // their .suicide flag isn't set // // test this by: // // 1 setup worker to wait a short time after disconnect, and exit // with a sentinel value // 2 disconnect worker with cluster's disconnect, confirm sentinel // 3 disconnect worker with child_process's disconnect, confirm // no sentinel value if (cluster.isWorker) { process.on('disconnect', function(msg) { setTimeout(function() { process.exit(SENTINEL); }, 10); }); return; } checkUnforced(); checkForced(); function checkUnforced() { cluster.fork() .on('online', function() { this.disconnect(); }) .on('exit', common.mustCall(function(status) { assert.equal(status, SENTINEL); })); } function checkForced() { cluster.fork() .on('online', function() { this.process.disconnect(); }) .on('exit', common.mustCall(function(status) { assert.equal(status, 0); })); } node-v4.8.2/test/parallel/test-cluster-worker-init.js000644 000766 000024 00000001243 13070706737 023001 0ustar00iojsstaff000000 000000 'use strict'; // test-cluster-worker-init.js // verifies that, when a child process is forked, the cluster.worker // object can receive messages as expected const common = require('../common'); const assert = require('assert'); const cluster = require('cluster'); const msg = 'foo'; if (cluster.isMaster) { const worker = cluster.fork(); worker.on('message', common.mustCall((message) => { assert.strictEqual(message, true, 'did not receive expected message'); worker.disconnect(); })); worker.on('online', () => { worker.send(msg); }); } else { // GH #7998 cluster.worker.on('message', (message) => { process.send(message === msg); }); } node-v4.8.2/test/parallel/test-cluster-worker-isconnected.js000644 000766 000024 00000002101 13070706737 024326 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var cluster = require('cluster'); var assert = require('assert'); if (cluster.isMaster) { var worker = cluster.fork(); assert.ok(worker.isConnected(), 'isConnected() should return true as soon as the worker has ' + 'been created.'); worker.on('disconnect', function() { assert.ok(!worker.isConnected(), 'After a disconnect event has been emitted, ' + 'isConncted should return false'); }); worker.on('message', function(msg) { if (msg === 'readyToDisconnect') { worker.disconnect(); } }); } else { assert.ok(cluster.worker.isConnected(), 'isConnected() should return true from within a worker at all ' + 'times.'); cluster.worker.process.on('disconnect', function() { assert.ok(!cluster.worker.isConnected(), 'isConnected() should return false from within a worker ' + 'after its underlying process has been disconnected from ' + 'the master'); }); process.send('readyToDisconnect'); } node-v4.8.2/test/parallel/test-cluster-worker-isdead.js000644 000766 000024 00000001347 13070706737 023274 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var cluster = require('cluster'); var assert = require('assert'); if (cluster.isMaster) { var worker = cluster.fork(); assert.ok(!worker.isDead(), 'isDead() should return false right after the worker has been ' + 'created.'); worker.on('exit', function() { assert.ok(worker.isDead(), 'After an event has been emitted, ' + 'isDead should return true'); }); worker.on('message', function(msg) { if (msg === 'readyToDie') { worker.kill(); } }); } else if (cluster.isWorker) { assert.ok(!cluster.worker.isDead(), 'isDead() should return false when called from within a worker'); process.send('readyToDie'); } node-v4.8.2/test/parallel/test-cluster-worker-kill.js000644 000766 000024 00000006465 13070706737 023004 0ustar00iojsstaff000000 000000 'use strict'; // test-cluster-worker-kill.js // verifies that, when a child process is killed (we use SIGKILL) // - the parent receives the proper events in the proper order, no duplicates // - the exitCode and signalCode are correct in the 'exit' event // - the worker.suicide flag, and worker.state are correct // - the worker process actually goes away var common = require('../common'); var assert = require('assert'); var cluster = require('cluster'); if (cluster.isWorker) { var http = require('http'); var server = http.Server(function() { }); server.once('listening', function() { }); server.listen(common.PORT, '127.0.0.1'); } else if (cluster.isMaster) { var KILL_SIGNAL = 'SIGKILL', expected_results = { cluster_emitDisconnect: [1, "the cluster did not emit 'disconnect'"], cluster_emitExit: [1, "the cluster did not emit 'exit'"], cluster_exitCode: [null, 'the cluster exited w/ incorrect exitCode'], cluster_signalCode: [KILL_SIGNAL, 'the cluster exited w/ incorrect signalCode'], worker_emitDisconnect: [1, "the worker did not emit 'disconnect'"], worker_emitExit: [1, "the worker did not emit 'exit'"], worker_state: ['disconnected', 'the worker state is incorrect'], worker_suicideMode: [false, 'the worker.suicide flag is incorrect'], worker_died: [true, 'the worker is still running'], worker_exitCode: [null, 'the worker exited w/ incorrect exitCode'], worker_signalCode: [KILL_SIGNAL, 'the worker exited w/ incorrect signalCode'] }, results = { cluster_emitDisconnect: 0, cluster_emitExit: 0, worker_emitDisconnect: 0, worker_emitExit: 0 }; // start worker var worker = cluster.fork(); // when the worker is up and running, kill it worker.once('listening', function() { worker.process.kill(KILL_SIGNAL); }); // Check cluster events cluster.on('disconnect', function() { results.cluster_emitDisconnect += 1; }); cluster.on('exit', function(worker) { results.cluster_exitCode = worker.process.exitCode; results.cluster_signalCode = worker.process.signalCode; results.cluster_emitExit += 1; }); // Check worker events and properties worker.on('disconnect', function() { results.worker_emitDisconnect += 1; results.worker_suicideMode = worker.suicide; results.worker_state = worker.state; }); // Check that the worker died worker.once('exit', function(exitCode, signalCode) { results.worker_exitCode = exitCode; results.worker_signalCode = signalCode; results.worker_emitExit += 1; results.worker_died = !alive(worker.process.pid); }); process.on('exit', function() { checkResults(expected_results, results); }); } // some helper functions ... function checkResults(expected_results, results) { for (var k in expected_results) { const actual = results[k]; const expected = expected_results[k]; var msg = (expected[1] || '') + (' [expected: ' + expected[0] + ' / actual: ' + actual + ']'); if (expected && expected.length) { assert.equal(actual, expected[0], msg); } else { assert.equal(actual, expected, msg); } } } function alive(pid) { try { process.kill(pid, 'SIGCONT'); return true; } catch (e) { return false; } } node-v4.8.2/test/parallel/test-cluster-worker-no-exit.js000644 000766 000024 00000002556 13070706737 023431 0ustar00iojsstaff000000 000000 'use strict'; var assert = require('assert'); var cluster = require('cluster'); var net = require('net'); var common = require('../common'); var destroyed; var success; var worker; var server; // workers do not exit on disconnect, they exit under normal node rules: when // they have nothing keeping their loop alive, like an active connection // // test this by: // // 1 creating a server, so worker can make a connection to something // 2 disconnecting worker // 3 wait to confirm it did not exit // 4 destroy connection // 5 confirm it does exit if (cluster.isMaster) { server = net.createServer(function(conn) { server.close(); worker.disconnect(); worker.once('disconnect', function() { setTimeout(function() { conn.destroy(); destroyed = true; }, 1000); }).once('exit', function() { // worker should not exit while it has a connection assert(destroyed, 'worker exited before connection destroyed'); success = true; }); }).listen(common.PORT, function() { var port = this.address().port; worker = cluster.fork() .on('online', function() { this.send({port: port}); }); }); process.on('exit', function() { assert(success); }); } else { process.on('message', function(msg) { // we shouldn't exit, not while a network connection exists net.connect(msg.port); }); } node-v4.8.2/test/parallel/test-cluster-worker-wait-server-close.js000644 000766 000024 00000002543 13070706737 025415 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var cluster = require('cluster'); var net = require('net'); var serverClosed = false; if (cluster.isWorker) { var server = net.createServer(function(socket) { // Wait for any data, then close connection socket.write('.'); socket.on('data', function discard() {}); }).listen(common.PORT, common.localhostIPv4); server.once('close', function() { serverClosed = true; }); // Although not typical, the worker process can exit before the disconnect // event fires. Use this to keep the process open until the event has fired. var keepOpen = setInterval(function() {}, 9999); // Check worker events and properties process.once('disconnect', function() { // disconnect should occur after socket close assert(serverClosed); clearInterval(keepOpen); }); } else if (cluster.isMaster) { // start worker var worker = cluster.fork(); // Disconnect worker when it is ready worker.once('listening', function() { const socket = net.createConnection(common.PORT, common.localhostIPv4); socket.on('connect', function() { socket.on('data', function() { console.log('got data from client'); // socket definitely connected to worker if we got data worker.disconnect(); socket.end(); }); }); }); } node-v4.8.2/test/parallel/test-common.js000644 000766 000024 00000000342 13070706737 020337 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); common.globalCheck = false; global.gc = 42; // Not a valid global unless --expose_gc is set. assert.deepEqual(common.leakedGlobals(), ['gc']); node-v4.8.2/test/parallel/test-console-instance.js000644 000766 000024 00000003005 13070706737 022312 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const Stream = require('stream'); const Console = require('console').Console; const out = new Stream(); const err = new Stream(); // ensure the Console instance doesn't write to the // process' "stdout" or "stderr" streams process.stdout.write = process.stderr.write = common.fail; // make sure that the "Console" function exists assert.strictEqual('function', typeof Console); // make sure that the Console constructor throws // when not given a writable stream instance assert.throws(() => { new Console(); }, /^TypeError: Console expects a writable stream instance$/); // Console constructor should throw if stderr exists but is not writable assert.throws(() => { out.write = () => {}; err.write = undefined; new Console(out, err); }, /^TypeError: Console expects writable stream instances$/); out.write = err.write = (d) => {}; var c = new Console(out, err); out.write = err.write = common.mustCall((d) => { assert.strictEqual(d, 'test\n'); }, 2); c.log('test'); c.error('test'); out.write = common.mustCall((d) => { assert.strictEqual('{ foo: 1 }\n', d); }); c.dir({ foo: 1 }); // ensure that the console functions are bound to the console instance let called = 0; out.write = common.mustCall((d) => { called++; assert.strictEqual(d, `${called} ${called - 1} [ 1, 2, 3 ]\n`); }, 3); [1, 2, 3].forEach(c.log); // Console() detects if it is called without `new` keyword assert.doesNotThrow(() => { Console(out, err); }); node-v4.8.2/test/parallel/test-console-not-call-toString.js000644 000766 000024 00000000361 13070706737 024030 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var func = function() {}; var toStringCalled = false; func.toString = function() { toStringCalled = true; }; require('util').inspect(func); assert.ok(!toStringCalled); node-v4.8.2/test/parallel/test-console.js000644 000766 000024 00000005162 13070706737 020516 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); assert.ok(process.stdout.writable); assert.ok(process.stderr.writable); // Support legacy API assert.equal('number', typeof process.stdout.fd); assert.equal('number', typeof process.stderr.fd); assert.throws(function() { console.timeEnd('no such label'); }); assert.doesNotThrow(function() { console.time('label'); console.timeEnd('label'); }); // an Object with a custom .inspect() function var custom_inspect = { foo: 'bar', inspect: function() { return 'inspect'; } }; var stdout_write = global.process.stdout.write; var strings = []; global.process.stdout.write = function(string) { strings.push(string); }; console._stderr = process.stdout; // test console.log() console.log('foo'); console.log('foo', 'bar'); console.log('%s %s', 'foo', 'bar', 'hop'); console.log({slashes: '\\\\'}); console.log(custom_inspect); // test console.dir() console.dir(custom_inspect); console.dir(custom_inspect, { showHidden: false }); console.dir({ foo: { bar: { baz: true } } }, { depth: 0 }); console.dir({ foo: { bar: { baz: true } } }, { depth: 1 }); // test console.trace() console.trace('This is a %j %d', { formatted: 'trace' }, 10, 'foo'); // test console.time() and console.timeEnd() output console.time('label'); console.timeEnd('label'); // verify that Object.prototype properties can be used as labels console.time('__proto__'); console.timeEnd('__proto__'); console.time('constructor'); console.timeEnd('constructor'); console.time('hasOwnProperty'); console.timeEnd('hasOwnProperty'); global.process.stdout.write = stdout_write; assert.equal('foo\n', strings.shift()); assert.equal('foo bar\n', strings.shift()); assert.equal('foo bar hop\n', strings.shift()); assert.equal("{ slashes: '\\\\\\\\' }\n", strings.shift()); assert.equal('inspect\n', strings.shift()); assert.equal("{ foo: 'bar', inspect: [Function] }\n", strings.shift()); assert.equal("{ foo: 'bar', inspect: [Function] }\n", strings.shift()); assert.notEqual(-1, strings.shift().indexOf('foo: [Object]')); assert.equal(-1, strings.shift().indexOf('baz')); assert.equal('Trace: This is a {"formatted":"trace"} 10 foo', strings.shift().split('\n').shift()); assert.ok(/^label: \d+ms$/.test(strings.shift().trim())); assert.ok(/^__proto__: \d+ms$/.test(strings.shift().trim())); assert.ok(/^constructor: \d+ms$/.test(strings.shift().trim())); assert.ok(/^hasOwnProperty: \d+ms$/.test(strings.shift().trim())); assert.equal(strings.length, 0); assert.throws(() => { console.assert(false, 'should throw'); }, /should throw/); assert.doesNotThrow(() => { console.assert(true, 'this should not throw'); }); node-v4.8.2/test/parallel/test-crypto-authenticated.js000644 000766 000024 00000041043 13070706737 023212 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const crypto = require('crypto'); crypto.DEFAULT_ENCODING = 'buffer'; // // Test authenticated encryption modes. // // !NEVER USE STATIC IVs IN REAL LIFE! // const TEST_CASES = [ { algo: 'aes-128-gcm', key: '6970787039613669314d623455536234', iv: '583673497131313748307652', plain: 'Hello World!', ct: '4be13896f64dfa2c2d0f2c76', tag: '272b422f62eb545eaa15b5ff84092447', tampered: false }, { algo: 'aes-128-gcm', key: '6970787039613669314d623455536234', iv: '583673497131313748307652', plain: 'Hello World!', ct: '4be13896f64dfa2c2d0f2c76', aad: '000000FF', tag: 'ba2479f66275665a88cb7b15f43eb005', tampered: false }, { algo: 'aes-128-gcm', key: '6970787039613669314d623455536234', iv: '583673497131313748307652', plain: 'Hello World!', ct: '4be13596f64dfa2c2d0fac76', tag: '272b422f62eb545eaa15b5ff84092447', tampered: true }, { algo: 'aes-256-gcm', key: '337a54767a7233703637564336316a6d56353472495975313534357834546c59', iv: '36306950306836764a6f4561', plain: 'Hello node.js world!', ct: '58e62cfe7b1d274111a82267ebb93866e72b6c2a', tag: '9bb44f663badabacae9720881fb1ec7a', tampered: false }, { algo: 'aes-256-gcm', key: '337a54767a7233703637564336316a6d56353472495975313534357834546c59', iv: '36306950306836764a6f4561', plain: 'Hello node.js world!', ct: '58e62cff7b1d274011a82267ebb93866e72b6c2b', tag: '9bb44f663badabacae9720881fb1ec7a', tampered: true }, { algo: 'aes-192-gcm', key: '1ed2233fa2223ef5d7df08546049406c7305220bca40d4c9', iv: '0e1791e9db3bd21a9122c416', plain: 'Hello node.js world!', password: 'very bad password', aad: '63616c76696e', ct: 'dda53a4059aa17b88756984995f7bba3c636cc44', tag: 'd2a35e5c611e5e3d2258360241c5b045', tampered: false }, // Following test cases are from // http://csrc.nist.gov/groups/ST/toolkit/BCM/documents/ // proposedmodes/gcm/gcm-revised-spec.pdf // Test case 1 { algo: 'aes-128-gcm', key: '00000000000000000000000000000000', iv: '000000000000000000000000', plain: '', plainIsHex: false, ct: '', tag: '58e2fccefa7e3061367f1d57a4e7455a', tampered: false }, // Test case 2 { algo: 'aes-128-gcm', key: '00000000000000000000000000000000', iv: '000000000000000000000000', plain: '00000000000000000000000000000000', plainIsHex: true, ct: '0388dace60b6a392f328c2b971b2fe78', tag: 'ab6e47d42cec13bdf53a67b21257bddf', tampered: false }, // Test case 3 { algo: 'aes-128-gcm', key: 'feffe9928665731c6d6a8f9467308308', iv: 'cafebabefacedbaddecaf888', plain: 'd9313225f88406e5a55909c5aff5269a' + '86a7a9531534f7da2e4c303d8a318a721' + 'c3c0c95956809532fcf0e2449a6b525b1' + '6aedf5aa0de657ba637b391aafd255', plainIsHex: true, ct: '42831ec2217774244b7221b784d0d49c' + 'e3aa212f2c02a4e035c17e2329aca12e2' + '1d514b25466931c7d8f6a5aac84aa051b' + 'a30b396a0aac973d58e091473f5985', tag: '4d5c2af327cd64a62cf35abd2ba6fab4', tampered: false }, // Test case 4 { algo: 'aes-128-gcm', key: 'feffe9928665731c6d6a8f9467308308', iv: 'cafebabefacedbaddecaf888', plain: 'd9313225f88406e5a55909c5aff5269a' + '86a7a9531534f7da2e4c303d8a318a721' + 'c3c0c95956809532fcf0e2449a6b525b16' + 'aedf5aa0de657ba637b39', aad: 'feedfacedeadbeeffeedfacedeadbeefabaddad2', plainIsHex: true, ct: '42831ec2217774244b7221b784d0d49c' + 'e3aa212f2c02a4e035c17e2329aca12e2' + '1d514b25466931c7d8f6a5aac84aa051b' + 'a30b396a0aac973d58e091', tag: '5bc94fbc3221a5db94fae95ae7121a47', tampered: false }, // Test case 5, 8 byte IV { algo: 'aes-128-gcm', key: 'feffe9928665731c6d6a8f9467308308', iv: 'cafebabefacedbad', plain: 'd9313225f88406e5a55909c5aff5269a' + '86a7a9531534f7da2e4c303d8a318a72' + '1c3c0c95956809532fcf0e2449a6b525' + 'b16aedf5aa0de657ba637b39', aad: 'feedfacedeadbeeffeedfacedeadbeef' + 'abaddad2', plainIsHex: true, ct: '61353b4c2806934a777ff51fa22a4755' + '699b2a714fcdc6f83766e5f97b6c7423' + '73806900e49f24b22b097544d4896b42' + '4989b5e1ebac0f07c23f4598', tag: '3612d2e79e3b0785561be14aaca2fccb', tampered: false }, // Test case 6, 60 byte IV { algo: 'aes-128-gcm', key: 'feffe9928665731c6d6a8f9467308308', iv: '9313225DF88406E555909C5AFF5269AA' + '6A7A9538534F7DA1E4C303D2A318A728' + 'C3C0C95156809539FCF0E2429A6B52541' + '6AEDBF5A0DE6A57A637B39B', plain: 'd9313225f88406e5a55909c5aff5269a' + '86a7a9531534f7da2e4c303d8a318a72' + '1c3c0c95956809532fcf0e2449a6b525' + 'b16aedf5aa0de657ba637b39', aad: 'feedfacedeadbeeffeedfacedeadbeefabaddad2', plainIsHex: true, ct: '8ce24998625615b603a033aca13fb894' + 'be9112a5c3a211a8ba262a3cca7e2ca7' + '01e4a9a4fba43c90ccdcb281d48c7c6f' + 'd62875d2aca417034c34aee5', tag: '619cc5aefffe0bfa462af43c1699d050', tampered: false }, // Test case 7 { algo: 'aes-192-gcm', key: '000000000000000000000000000000000000000000000000', iv: '000000000000000000000000', plain: '', plainIsHex: false, ct: '', tag: 'cd33b28ac773f74ba00ed1f312572435', tampered: false }, // Test case 8 { algo: 'aes-192-gcm', key: '000000000000000000000000000000000000000000000000', iv: '000000000000000000000000', plain: '00000000000000000000000000000000', plainIsHex: true, ct: '98e7247c07f0fe411c267e4384b0f600', tag: '2ff58d80033927ab8ef4d4587514f0fb', tampered: false }, // Test case 9 { algo: 'aes-192-gcm', key: 'feffe9928665731c6d6a8f9467308308feffe9928665731c', iv: 'cafebabefacedbaddecaf888', plain: 'd9313225f88406e5a55909c5aff5269a' + '86a7a9531534f7da2e4c303d8a318a72' + '1c3c0c95956809532fcf0e2449a6b525' + 'b16aedf5aa0de657ba637b391aafd255', plainIsHex: true, ct: '3980ca0b3c00e841eb06fac4872a2757' + '859e1ceaa6efd984628593b40ca1e19c' + '7d773d00c144c525ac619d18c84a3f47' + '18e2448b2fe324d9ccda2710acade256', tag: '9924a7c8587336bfb118024db8674a14', tampered: false }, // Test case 10 { algo: 'aes-192-gcm', key: 'feffe9928665731c6d6a8f9467308308feffe9928665731c', iv: 'cafebabefacedbaddecaf888', plain: 'd9313225f88406e5a55909c5aff5269a' + '86a7a9531534f7da2e4c303d8a318a72' + '1c3c0c95956809532fcf0e2449a6b525' + 'b16aedf5aa0de657ba637b39', aad: 'feedfacedeadbeeffeedfacedeadbeefabaddad2', plainIsHex: true, ct: '3980ca0b3c00e841eb06fac4872a2757' + '859e1ceaa6efd984628593b40ca1e19c' + '7d773d00c144c525ac619d18c84a3f47' + '18e2448b2fe324d9ccda2710', tag: '2519498e80f1478f37ba55bd6d27618c', tampered: false }, // Test case 11 { algo: 'aes-192-gcm', key: 'feffe9928665731c6d6a8f9467308308feffe9928665731c', iv: 'cafebabefacedbad', plain: 'd9313225f88406e5a55909c5aff5269a' + '86a7a9531534f7da2e4c303d8a318a72' + '1c3c0c95956809532fcf0e2449a6b525' + 'b16aedf5aa0de657ba637b39', aad: 'feedfacedeadbeeffeedfacedeadbeefabaddad2', plainIsHex: true, ct: '0f10f599ae14a154ed24b36e25324db8' + 'c566632ef2bbb34f8347280fc4507057' + 'fddc29df9a471f75c66541d4d4dad1c9' + 'e93a19a58e8b473fa0f062f7', tag: '65dcc57fcf623a24094fcca40d3533f8', tampered: false }, // Test case 12, 60 byte IV { algo: 'aes-192-gcm', key: 'feffe9928665731c6d6a8f9467308308feffe9928665731c', iv: '9313225df88406e555909c5aff5269aa' + '6a7a9538534f7da1e4c303d2a318a728' + 'c3c0c95156809539fcf0e2429a6b5254' + '16aedbf5a0de6a57a637b39b', plain: 'd9313225f88406e5a55909c5aff5269a' + '86a7a9531534f7da2e4c303d8a318a72' + '1c3c0c95956809532fcf0e2449a6b525' + 'b16aedf5aa0de657ba637b39', aad: 'feedfacedeadbeeffeedfacedeadbeefabaddad2', plainIsHex: true, ct: 'd27e88681ce3243c4830165a8fdcf9ff' + '1de9a1d8e6b447ef6ef7b79828666e45' + '81e79012af34ddd9e2f037589b292db3' + 'e67c036745fa22e7e9b7373b', tag: 'dcf566ff291c25bbb8568fc3d376a6d9', tampered: false }, // Test case 13 { algo: 'aes-256-gcm', key: '0000000000000000000000000000000000000000000000000000000000000000', iv: '000000000000000000000000', plain: '', plainIsHex: false, ct: '', tag: '530f8afbc74536b9a963b4f1c4cb738b', tampered: false }, // Test case 14 { algo: 'aes-256-gcm', key: '0000000000000000000000000000000000000000000000000000000000000000', iv: '000000000000000000000000', plain: '00000000000000000000000000000000', plainIsHex: true, ct: 'cea7403d4d606b6e074ec5d3baf39d18', tag: 'd0d1c8a799996bf0265b98b5d48ab919', tampered: false }, // Test case 15 { algo: 'aes-256-gcm', key: 'feffe9928665731c6d6a8f9467308308feffe9928665731c6d6a8f9467308308', iv: 'cafebabefacedbaddecaf888', plain: 'd9313225f88406e5a55909c5aff5269a' + '86a7a9531534f7da2e4c303d8a318a72' + '1c3c0c95956809532fcf0e2449a6b525' + 'b16aedf5aa0de657ba637b391aafd255', plainIsHex: true, ct: '522dc1f099567d07f47f37a32a84427d' + '643a8cdcbfe5c0c97598a2bd2555d1aa' + '8cb08e48590dbb3da7b08b1056828838' + 'c5f61e6393ba7a0abcc9f662898015ad', tag: 'b094dac5d93471bdec1a502270e3cc6c', tampered: false }, // Test case 16 { algo: 'aes-256-gcm', key: 'feffe9928665731c6d6a8f9467308308feffe9928665731c6d6a8f9467308308', iv: 'cafebabefacedbaddecaf888', plain: 'd9313225f88406e5a55909c5aff5269a' + '86a7a9531534f7da2e4c303d8a318a72' + '1c3c0c95956809532fcf0e2449a6b525' + 'b16aedf5aa0de657ba637b39', aad: 'feedfacedeadbeeffeedfacedeadbeefabaddad2', plainIsHex: true, ct: '522dc1f099567d07f47f37a32a84427d' + '643a8cdcbfe5c0c97598a2bd2555d1aa' + '8cb08e48590dbb3da7b08b1056828838' + 'c5f61e6393ba7a0abcc9f662', tag: '76fc6ece0f4e1768cddf8853bb2d551b', tampered: false }, // Test case 17, 8 byte IV { algo: 'aes-256-gcm', key: 'feffe9928665731c6d6a8f9467308308feffe9928665731c6d6a8f9467308308', iv: 'cafebabefacedbad', plain: 'd9313225f88406e5a55909c5aff5269a' + '86a7a9531534f7da2e4c303d8a318a72' + '1c3c0c95956809532fcf0e2449a6b525' + 'b16aedf5aa0de657ba637b39', aad: 'feedfacedeadbeeffeedfacedeadbeefabaddad2', plainIsHex: true, ct: 'c3762df1ca787d32ae47c13bf19844cb' + 'af1ae14d0b976afac52ff7d79bba9de0' + 'feb582d33934a4f0954cc2363bc73f78' + '62ac430e64abe499f47c9b1f', tag: '3a337dbf46a792c45e454913fe2ea8f2', tampered: false }, // Test case 18, 60 byte IV { algo: 'aes-256-gcm', key: 'feffe9928665731c6d6a8f9467308308feffe9928665731c6d6a8f9467308308', iv: '9313225df88406e555909c5aff5269aa' + '6a7a9538534f7da1e4c303d2a318a728' + 'c3c0c95156809539fcf0e2429a6b5254' + '16aedbf5a0de6a57a637b39b', plain: 'd9313225f88406e5a55909c5aff5269a' + '86a7a9531534f7da2e4c303d8a318a72' + '1c3c0c95956809532fcf0e2449a6b525' + 'b16aedf5aa0de657ba637b39', aad: 'feedfacedeadbeeffeedfacedeadbeefabaddad2', plainIsHex: true, ct: '5a8def2f0c9e53f1f75d7853659e2a20' + 'eeb2b22aafde6419a058ab4f6f746bf4' + '0fc0c3b780f244452da3ebf1c5d82cde' + 'a2418997200ef82e44ae7e3f', tag: 'a44a8266ee1c8eb0c8b5d4cf5ae9f19a', tampered: false }, ]; const ciphers = crypto.getCiphers(); for (const i in TEST_CASES) { const test = TEST_CASES[i]; if (ciphers.indexOf(test.algo) === -1) { common.skip('unsupported ' + test.algo + ' test'); continue; } if (common.hasFipsCrypto && test.iv.length < 24) { console.log('1..0 # Skipped: IV len < 12 bytes unsupported in FIPS mode'); continue; } (function() { var encrypt = crypto.createCipheriv(test.algo, new Buffer(test.key, 'hex'), new Buffer(test.iv, 'hex')); if (test.aad) encrypt.setAAD(new Buffer(test.aad, 'hex')); var inputEncoding = test.plainIsHex ? 'hex' : 'ascii'; var hex = encrypt.update(test.plain, inputEncoding, 'hex'); hex += encrypt.final('hex'); var auth_tag = encrypt.getAuthTag(); // only test basic encryption run if output is marked as tampered. if (!test.tampered) { assert.equal(hex, test.ct); assert.equal(auth_tag.toString('hex'), test.tag); } })(); (function() { var decrypt = crypto.createDecipheriv(test.algo, new Buffer(test.key, 'hex'), new Buffer(test.iv, 'hex')); decrypt.setAuthTag(new Buffer(test.tag, 'hex')); if (test.aad) decrypt.setAAD(new Buffer(test.aad, 'hex')); var outputEncoding = test.plainIsHex ? 'hex' : 'ascii'; var msg = decrypt.update(test.ct, 'hex', outputEncoding); if (!test.tampered) { msg += decrypt.final(outputEncoding); assert.strictEqual(msg, test.plain); } else { // assert that final throws if input data could not be verified! assert.throws(function() { decrypt.final('ascii'); }, / auth/); } })(); (function() { if (!test.password) return; if (common.hasFipsCrypto) { assert.throws(() => { crypto.createCipher(test.algo, test.password); }, /not supported in FIPS mode/); } else { var encrypt = crypto.createCipher(test.algo, test.password); if (test.aad) encrypt.setAAD(new Buffer(test.aad, 'hex')); var hex = encrypt.update(test.plain, 'ascii', 'hex'); hex += encrypt.final('hex'); var auth_tag = encrypt.getAuthTag(); // only test basic encryption run if output is marked as tampered. if (!test.tampered) { assert.equal(hex, test.ct); assert.equal(auth_tag.toString('hex'), test.tag); } } })(); (function() { if (!test.password) return; if (common.hasFipsCrypto) { assert.throws(() => { crypto.createDecipher(test.algo, test.password); }, /not supported in FIPS mode/); } else { var decrypt = crypto.createDecipher(test.algo, test.password); decrypt.setAuthTag(new Buffer(test.tag, 'hex')); if (test.aad) decrypt.setAAD(new Buffer(test.aad, 'hex')); var msg = decrypt.update(test.ct, 'hex', 'ascii'); if (!test.tampered) { msg += decrypt.final('ascii'); assert.equal(msg, test.plain); } else { // assert that final throws if input data could not be verified! assert.throws(function() { decrypt.final('ascii'); }, / auth/); } } })(); // after normal operation, test some incorrect ways of calling the API: // it's most certainly enough to run these tests with one algorithm only. if (i > 0) { continue; } (function() { // non-authenticating mode: var encrypt = crypto.createCipheriv('aes-128-cbc', 'ipxp9a6i1Mb4USb4', '6fKjEjR3Vl30EUYC'); encrypt.update('blah', 'ascii'); encrypt.final(); assert.throws(() => { encrypt.getAuthTag(); }, / state/); assert.throws(() => { encrypt.setAAD(Buffer.from('123', 'ascii')); }, / state/); })(); (function() { // trying to get tag before inputting all data: var encrypt = crypto.createCipheriv(test.algo, new Buffer(test.key, 'hex'), new Buffer(test.iv, 'hex')); encrypt.update('blah', 'ascii'); assert.throws(function() { encrypt.getAuthTag(); }, / state/); })(); (function() { // trying to set tag on encryption object: var encrypt = crypto.createCipheriv(test.algo, Buffer.from(test.key, 'hex'), Buffer.from(test.iv, 'hex')); assert.throws(() => { encrypt.setAuthTag(Buffer.from(test.tag, 'hex')); }, / state/); })(); (function() { // trying to read tag from decryption object: var decrypt = crypto.createDecipheriv(test.algo, new Buffer(test.key, 'hex'), new Buffer(test.iv, 'hex')); assert.throws(function() { decrypt.getAuthTag(); }, / state/); })(); (function() { // trying to create cipher with incorrect IV length assert.throws(function() { crypto.createCipheriv( test.algo, Buffer.from(test.key, 'hex'), Buffer.alloc(0) ); }, /Invalid IV length/); })(); } // Non-authenticating mode: (function() { const encrypt = crypto.createCipheriv('aes-128-cbc', 'ipxp9a6i1Mb4USb4', '6fKjEjR3Vl30EUYC'); encrypt.update('blah', 'ascii'); encrypt.final(); assert.throws(() => encrypt.getAuthTag(), / state/); assert.throws(() => encrypt.setAAD(Buffer.from('123', 'ascii')), / state/); })(); node-v4.8.2/test/parallel/test-crypto-binary-default.js000644 000766 000024 00000060525 13070706737 023304 0ustar00iojsstaff000000 000000 'use strict'; // This is the same as test/simple/test-crypto, but from before the shift // to use buffers by default. const common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const assert = require('assert'); const constants = require('constants'); const crypto = require('crypto'); const fs = require('fs'); const path = require('path'); const tls = require('tls'); crypto.DEFAULT_ENCODING = 'binary'; // Test Certificates const certPem = fs.readFileSync(common.fixturesDir + '/test_cert.pem', 'ascii'); const certPfx = fs.readFileSync(common.fixturesDir + '/test_cert.pfx'); const keyPem = fs.readFileSync(common.fixturesDir + '/test_key.pem', 'ascii'); const rsaPubPem = fs.readFileSync(common.fixturesDir + '/test_rsa_pubkey.pem', 'ascii'); const rsaKeyPem = fs.readFileSync(common.fixturesDir + '/test_rsa_privkey.pem', 'ascii'); // PFX tests assert.doesNotThrow(function() { tls.createSecureContext({pfx: certPfx, passphrase: 'sample'}); }); assert.throws(function() { tls.createSecureContext({pfx: certPfx}); }, /^Error: mac verify failure$/); assert.throws(function() { tls.createSecureContext({pfx: certPfx, passphrase: 'test'}); }, /^Error: mac verify failure$/); assert.throws(function() { tls.createSecureContext({pfx: 'sample', passphrase: 'test'}); }, /^Error: not enough data$/); // Test HMAC const hmacHash = crypto.createHmac('sha1', 'Node') .update('some data') .update('to hmac') .digest('hex'); assert.strictEqual(hmacHash, '19fd6e1ba73d9ed2224dd5094a71babe85d9a892'); // Test HMAC-SHA-* (rfc 4231 Test Cases) var rfc4231 = [ { key: new Buffer('0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b', 'hex'), data: new Buffer('4869205468657265', 'hex'), // 'Hi There' hmac: { sha224: '896fb1128abbdf196832107cd49df33f47b4b1169912ba4f53684b22', sha256: 'b0344c61d8db38535ca8afceaf0bf12b881dc200c9833da726e9376c' + '2e32cff7', sha384: 'afd03944d84895626b0825f4ab46907f15f9dadbe4101ec682aa034c' + '7cebc59cfaea9ea9076ede7f4af152e8b2fa9cb6', sha512: '87aa7cdea5ef619d4ff0b4241a1d6cb02379f4e2ce4ec2787ad0b305' + '45e17cdedaa833b7d6b8a702038b274eaea3f4e4be9d914eeb61f170' + '2e696c203a126854' } }, { key: new Buffer('4a656665', 'hex'), // 'Jefe' data: new Buffer('7768617420646f2079612077616e7420666f72206e6f74686' + '96e673f', 'hex'), // 'what do ya want for nothing?' hmac: { sha224: 'a30e01098bc6dbbf45690f3a7e9e6d0f8bbea2a39e6148008fd05e44', sha256: '5bdcc146bf60754e6a042426089575c75a003f089d2739839dec58b9' + '64ec3843', sha384: 'af45d2e376484031617f78d2b58a6b1b9c7ef464f5a01b47e42ec373' + '6322445e8e2240ca5e69e2c78b3239ecfab21649', sha512: '164b7a7bfcf819e2e395fbe73b56e0a387bd64222e831fd610270cd7' + 'ea2505549758bf75c05a994a6d034f65f8f0e6fdcaeab1a34d4a6b4b' + '636e070a38bce737' } }, { key: new Buffer('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa', 'hex'), data: new Buffer('ddddddddddddddddddddddddddddddddddddddddddddddddd' + 'ddddddddddddddddddddddddddddddddddddddddddddddddddd', 'hex'), hmac: { sha224: '7fb3cb3588c6c1f6ffa9694d7d6ad2649365b0c1f65d69d1ec8333ea', sha256: '773ea91e36800e46854db8ebd09181a72959098b3ef8c122d9635514' + 'ced565fe', sha384: '88062608d3e6ad8a0aa2ace014c8a86f0aa635d947ac9febe83ef4e5' + '5966144b2a5ab39dc13814b94e3ab6e101a34f27', sha512: 'fa73b0089d56a284efb0f0756c890be9b1b5dbdd8ee81a3655f83e33' + 'b2279d39bf3e848279a722c806b485a47e67c807b946a337bee89426' + '74278859e13292fb' } }, { key: new Buffer('0102030405060708090a0b0c0d0e0f10111213141516171819', 'hex'), data: new Buffer('cdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdc' + 'dcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcd', 'hex'), hmac: { sha224: '6c11506874013cac6a2abc1bb382627cec6a90d86efc012de7afec5a', sha256: '82558a389a443c0ea4cc819899f2083a85f0faa3e578f8077a2e3ff4' + '6729665b', sha384: '3e8a69b7783c25851933ab6290af6ca77a9981480850009cc5577c6e' + '1f573b4e6801dd23c4a7d679ccf8a386c674cffb', sha512: 'b0ba465637458c6990e5a8c5f61d4af7e576d97ff94b872de76f8050' + '361ee3dba91ca5c11aa25eb4d679275cc5788063a5f19741120c4f2d' + 'e2adebeb10a298dd' } }, { key: new Buffer('0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c', 'hex'), // 'Test With Truncation' data: new Buffer('546573742057697468205472756e636174696f6e', 'hex'), hmac: { sha224: '0e2aea68a90c8d37c988bcdb9fca6fa8', sha256: 'a3b6167473100ee06e0c796c2955552b', sha384: '3abf34c3503b2a23a46efc619baef897', sha512: '415fad6271580a531d4179bc891d87a6' }, truncate: true }, { key: new Buffer('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaa', 'hex'), // 'Test Using Larger Than Block-Size Key - Hash Key First' data: new Buffer('54657374205573696e67204c6172676572205468616e20426' + 'c6f636b2d53697a65204b6579202d2048617368204b657920' + '4669727374', 'hex'), hmac: { sha224: '95e9a0db962095adaebe9b2d6f0dbce2d499f112f2d2b7273fa6870e', sha256: '60e431591ee0b67f0d8a26aacbf5b77f8e0bc6213728c5140546040f' + '0ee37f54', sha384: '4ece084485813e9088d2c63a041bc5b44f9ef1012a2b588f3cd11f05' + '033ac4c60c2ef6ab4030fe8296248df163f44952', sha512: '80b24263c7c1a3ebb71493c1dd7be8b49b46d1f41b4aeec1121b0137' + '83f8f3526b56d037e05f2598bd0fd2215d6a1e5295e64f73f63f0aec' + '8b915a985d786598' } }, { key: new Buffer('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaa', 'hex'), // 'This is a test using a larger than block-size key and a larger ' + // 'than block-size data. The key needs to be hashed before being ' + // 'used by the HMAC algorithm.' data: new Buffer('5468697320697320612074657374207573696e672061206c6' + '172676572207468616e20626c6f636b2d73697a65206b6579' + '20616e642061206c6172676572207468616e20626c6f636b2' + 'd73697a6520646174612e20546865206b6579206e65656473' + '20746f20626520686173686564206265666f7265206265696' + 'e6720757365642062792074686520484d414320616c676f72' + '6974686d2e', 'hex'), hmac: { sha224: '3a854166ac5d9f023f54d517d0b39dbd946770db9c2b95c9f6f565d1', sha256: '9b09ffa71b942fcb27635fbcd5b0e944bfdc63644f0713938a7f5153' + '5c3a35e2', sha384: '6617178e941f020d351e2f254e8fd32c602420feb0b8fb9adccebb82' + '461e99c5a678cc31e799176d3860e6110c46523e', sha512: 'e37b6a775dc87dbaa4dfa9f96e5e3ffddebd71f8867289865df5a32d' + '20cdc944b6022cac3c4982b10d5eeb55c3e4de15134676fb6de04460' + '65c97440fa8c6a58' } } ]; for (let i = 0, l = rfc4231.length; i < l; i++) { for (var hash in rfc4231[i]['hmac']) { var result = crypto.createHmac(hash, rfc4231[i]['key']) .update(rfc4231[i]['data']) .digest('hex'); if (rfc4231[i]['truncate']) { result = result.substr(0, 32); // first 128 bits == 32 hex chars } assert.strictEqual( rfc4231[i]['hmac'][hash], result, `Test HMAC-${hash}: Test case ${i + 1} rfc 4231` ); } } // Test HMAC-MD5/SHA1 (rfc 2202 Test Cases) var rfc2202_md5 = [ { key: new Buffer('0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b', 'hex'), data: 'Hi There', hmac: '9294727a3638bb1c13f48ef8158bfc9d' }, { key: 'Jefe', data: 'what do ya want for nothing?', hmac: '750c783e6ab0b503eaa86e310a5db738' }, { key: new Buffer('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa', 'hex'), data: new Buffer('ddddddddddddddddddddddddddddddddddddddddddddddddd' + 'ddddddddddddddddddddddddddddddddddddddddddddddddddd', 'hex'), hmac: '56be34521d144c88dbb8c733f0e8b3f6' }, { key: new Buffer('0102030405060708090a0b0c0d0e0f10111213141516171819', 'hex'), data: new Buffer('cdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdc' + 'dcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcd' + 'cdcdcdcdcd', 'hex'), hmac: '697eaf0aca3a3aea3a75164746ffaa79' }, { key: new Buffer('0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c', 'hex'), data: 'Test With Truncation', hmac: '56461ef2342edc00f9bab995690efd4c' }, { key: new Buffer('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaa', 'hex'), data: 'Test Using Larger Than Block-Size Key - Hash Key First', hmac: '6b1ab7fe4bd7bf8f0b62e6ce61b9d0cd' }, { key: new Buffer('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaa', 'hex'), data: 'Test Using Larger Than Block-Size Key and Larger Than One ' + 'Block-Size Data', hmac: '6f630fad67cda0ee1fb1f562db3aa53e' } ]; var rfc2202_sha1 = [ { key: new Buffer('0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b', 'hex'), data: 'Hi There', hmac: 'b617318655057264e28bc0b6fb378c8ef146be00' }, { key: 'Jefe', data: 'what do ya want for nothing?', hmac: 'effcdf6ae5eb2fa2d27416d5f184df9c259a7c79' }, { key: new Buffer('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa', 'hex'), data: new Buffer('ddddddddddddddddddddddddddddddddddddddddddddd' + 'ddddddddddddddddddddddddddddddddddddddddddddd' + 'dddddddddd', 'hex'), hmac: '125d7342b9ac11cd91a39af48aa17b4f63f175d3' }, { key: new Buffer('0102030405060708090a0b0c0d0e0f10111213141516171819', 'hex'), data: new Buffer('cdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdc' + 'dcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcd' + 'cdcdcdcdcd', 'hex'), hmac: '4c9007f4026250c6bc8414f9bf50c86c2d7235da' }, { key: new Buffer('0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c', 'hex'), data: 'Test With Truncation', hmac: '4c1a03424b55e07fe7f27be1d58bb9324a9a5a04' }, { key: new Buffer('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaa', 'hex'), data: 'Test Using Larger Than Block-Size Key - Hash Key First', hmac: 'aa4ae5e15272d00e95705637ce8a3b55ed402112' }, { key: new Buffer('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaa', 'hex'), data: 'Test Using Larger Than Block-Size Key and Larger Than One ' + 'Block-Size Data', hmac: 'e8e99d0f45237d786d6bbaa7965c7808bbff1a91' } ]; for (let i = 0, l = rfc2202_md5.length; i < l; i++) { if (!common.hasFipsCrypto) { assert.equal(rfc2202_md5[i]['hmac'], crypto.createHmac('md5', rfc2202_md5[i]['key']) .update(rfc2202_md5[i]['data']) .digest('hex'), `Test HMAC-MD5 : Test case ${i + 1} rfc 2202`); } } for (let i = 0, l = rfc2202_sha1.length; i < l; i++) { assert.equal(rfc2202_sha1[i]['hmac'], crypto.createHmac('sha1', rfc2202_sha1[i]['key']) .update(rfc2202_sha1[i]['data']) .digest('hex'), `Test HMAC-SHA1 : Test case ${i + 1} rfc 2202`); } // Test hashing var a1 = crypto.createHash('sha1').update('Test123').digest('hex'); var a2 = crypto.createHash('sha256').update('Test123').digest('base64'); var a3 = crypto.createHash('sha512').update('Test123').digest(); // binary var a4 = crypto.createHash('sha1').update('Test123').digest('buffer'); if (!common.hasFipsCrypto) { var a0 = crypto.createHash('md5').update('Test123').digest('binary'); assert.strictEqual( a0, 'h\u00ea\u00cb\u0097\u00d8o\fF!\u00fa+\u000e\u0017\u00ca\u00bd\u008c', 'Test MD5 as binary' ); } assert.strictEqual(a1, '8308651804facb7b9af8ffc53a33a22d6a1c8ac2', 'Test SHA1'); assert.strictEqual(a2, '2bX1jws4GYKTlxhloUB09Z66PoJZW+y+hq5R8dnx9l4=', 'Test SHA256 as base64'); assert.strictEqual( a3, '\u00c1(4\u00f1\u0003\u001fd\u0097!O\'\u00d4C/&Qz\u00d4' + '\u0094\u0015l\u00b8\u008dQ+\u00db\u001d\u00c4\u00b5}\u00b2' + '\u00d6\u0092\u00a3\u00df\u00a2i\u00a1\u009b\n\n*\u000f' + '\u00d7\u00d6\u00a2\u00a8\u0085\u00e3<\u0083\u009c\u0093' + '\u00c2\u0006\u00da0\u00a1\u00879(G\u00ed\'', 'Test SHA512 as assumed binary' ); assert.deepEqual(a4, new Buffer('8308651804facb7b9af8ffc53a33a22d6a1c8ac2', 'hex'), 'Test SHA1'); // Test multiple updates to same hash var h1 = crypto.createHash('sha1').update('Test123').digest('hex'); var h2 = crypto.createHash('sha1').update('Test').update('123').digest('hex'); assert.strictEqual(h1, h2, 'multipled updates'); // Test hashing for binary files var fn = path.join(common.fixturesDir, 'sample.png'); var sha1Hash = crypto.createHash('sha1'); var fileStream = fs.createReadStream(fn); fileStream.on('data', function(data) { sha1Hash.update(data); }); fileStream.on('close', common.mustCall(function() { assert.strictEqual( sha1Hash.digest('hex'), '22723e553129a336ad96e10f6aecdf0f45e4149e', 'Test SHA1 of sample.png' ); })); // Issue #2227: unknown digest method should throw an error. assert.throws(function() { crypto.createHash('xyzzy'); }, /^Error: Digest method not supported$/); // Test signing and verifying var s1 = crypto.createSign('RSA-SHA1') .update('Test123') .sign(keyPem, 'base64'); var s1Verified = crypto.createVerify('RSA-SHA1') .update('Test') .update('123') .verify(certPem, s1, 'base64'); assert.strictEqual(s1Verified, true, 'sign and verify (base 64)'); var s2 = crypto.createSign('RSA-SHA256') .update('Test123') .sign(keyPem); // binary var s2Verified = crypto.createVerify('RSA-SHA256') .update('Test') .update('123') .verify(certPem, s2); // binary assert.strictEqual(s2Verified, true, 'sign and verify (binary)'); var s3 = crypto.createSign('RSA-SHA1') .update('Test123') .sign(keyPem, 'buffer'); var s3Verified = crypto.createVerify('RSA-SHA1') .update('Test') .update('123') .verify(certPem, s3); assert.strictEqual(s3Verified, true, 'sign and verify (buffer)'); function testCipher1(key) { // Test encryption and decryption var plaintext = 'Keep this a secret? No! Tell everyone about node.js!'; var cipher = crypto.createCipher('aes192', key); // encrypt plaintext which is in utf8 format // to a ciphertext which will be in hex var ciph = cipher.update(plaintext, 'utf8', 'hex'); // Only use binary or hex, not base64. ciph += cipher.final('hex'); var decipher = crypto.createDecipher('aes192', key); var txt = decipher.update(ciph, 'hex', 'utf8'); txt += decipher.final('utf8'); assert.strictEqual(txt, plaintext, 'encryption and decryption'); } function testCipher2(key) { // encryption and decryption with Base64 // reported in https://github.com/joyent/node/issues/738 var plaintext = '32|RmVZZkFUVmpRRkp0TmJaUm56ZU9qcnJkaXNNWVNpTTU*|iXmckfRWZBGWWELw' + 'eCBsThSsfUHLeRe0KCsK8ooHgxie0zOINpXxfZi/oNG7uq9JWFVCk70gfzQH8ZUJ' + 'jAfaFg**'; var cipher = crypto.createCipher('aes256', key); // encrypt plaintext which is in utf8 format // to a ciphertext which will be in Base64 var ciph = cipher.update(plaintext, 'utf8', 'base64'); ciph += cipher.final('base64'); var decipher = crypto.createDecipher('aes256', key); var txt = decipher.update(ciph, 'base64', 'utf8'); txt += decipher.final('utf8'); assert.strictEqual(txt, plaintext, 'encryption and decryption with Base64'); } function testCipher3(key, iv) { // Test encyrption and decryption with explicit key and iv var plaintext = '32|RmVZZkFUVmpRRkp0TmJaUm56ZU9qcnJkaXNNWVNpTTU*|iXmckfRWZBGWWELw' + 'eCBsThSsfUHLeRe0KCsK8ooHgxie0zOINpXxfZi/oNG7uq9JWFVCk70gfzQH8ZUJ' + 'jAfaFg**'; var cipher = crypto.createCipheriv('des-ede3-cbc', key, iv); var ciph = cipher.update(plaintext, 'utf8', 'hex'); ciph += cipher.final('hex'); var decipher = crypto.createDecipheriv('des-ede3-cbc', key, iv); var txt = decipher.update(ciph, 'hex', 'utf8'); txt += decipher.final('utf8'); assert.strictEqual(txt, plaintext, 'encryption and decryption with key and iv'); } function testCipher4(key, iv) { // Test encyrption and decryption with explicit key and iv var plaintext = '32|RmVZZkFUVmpRRkp0TmJaUm56ZU9qcnJkaXNNWVNpTTU*|iXmckfRWZBGWWELw' + 'eCBsThSsfUHLeRe0KCsK8ooHgxie0zOINpXxfZi/oNG7uq9JWFVCk70gfzQH8ZUJ' + 'jAfaFg**'; var cipher = crypto.createCipheriv('des-ede3-cbc', key, iv); var ciph = cipher.update(plaintext, 'utf8', 'buffer'); ciph = Buffer.concat([ciph, cipher.final('buffer')]); var decipher = crypto.createDecipheriv('des-ede3-cbc', key, iv); var txt = decipher.update(ciph, 'buffer', 'utf8'); txt += decipher.final('utf8'); assert.strictEqual(txt, plaintext, 'encryption and decryption with key and iv'); } if (!common.hasFipsCrypto) { testCipher1('MySecretKey123'); testCipher1(new Buffer('MySecretKey123')); testCipher2('0123456789abcdef'); testCipher2(new Buffer('0123456789abcdef')); } testCipher3('0123456789abcd0123456789', '12345678'); testCipher3('0123456789abcd0123456789', new Buffer('12345678')); testCipher3(new Buffer('0123456789abcd0123456789'), '12345678'); testCipher3(new Buffer('0123456789abcd0123456789'), new Buffer('12345678')); testCipher4(new Buffer('0123456789abcd0123456789'), new Buffer('12345678')); // update() should only take buffers / strings assert.throws(function() { crypto.createHash('sha1').update({foo: 'bar'}); }, /^TypeError: Not a string or buffer$/); // Test Diffie-Hellman with two parties sharing a secret, // using various encodings as we go along var dh1 = crypto.createDiffieHellman(common.hasFipsCrypto ? 1024 : 256); var p1 = dh1.getPrime('buffer'); var dh2 = crypto.createDiffieHellman(p1, 'base64'); var key1 = dh1.generateKeys(); var key2 = dh2.generateKeys('hex'); var secret1 = dh1.computeSecret(key2, 'hex', 'base64'); var secret2 = dh2.computeSecret(key1, 'binary', 'buffer'); assert.strictEqual(secret1, secret2.toString('base64')); // Create "another dh1" using generated keys from dh1, // and compute secret again var dh3 = crypto.createDiffieHellman(p1, 'buffer'); var privkey1 = dh1.getPrivateKey(); dh3.setPublicKey(key1); dh3.setPrivateKey(privkey1); assert.strictEqual(dh1.getPrime(), dh3.getPrime()); assert.strictEqual(dh1.getGenerator(), dh3.getGenerator()); assert.strictEqual(dh1.getPublicKey(), dh3.getPublicKey()); assert.strictEqual(dh1.getPrivateKey(), dh3.getPrivateKey()); var secret3 = dh3.computeSecret(key2, 'hex', 'base64'); assert.strictEqual(secret1, secret3); // https://github.com/joyent/node/issues/2338 var p = 'FFFFFFFFFFFFFFFFC90FDAA22168C234C4C6628B80DC1CD129024E088A67CC74' + '020BBEA63B139B22514A08798E3404DDEF9519B3CD3A431B302B0A6DF25F1437' + '4FE1356D6D51C245E485B576625E7EC6F44C42E9A637ED6B0BFF5CB6F406B7ED' + 'EE386BFB5A899FA5AE9F24117C4B1FE649286651ECE65381FFFFFFFFFFFFFFFF'; var d = crypto.createDiffieHellman(p, 'hex'); assert.strictEqual(d.verifyError, constants.DH_NOT_SUITABLE_GENERATOR); // Test RSA key signing/verification var rsaSign = crypto.createSign('RSA-SHA1'); var rsaVerify = crypto.createVerify('RSA-SHA1'); assert.ok(rsaSign instanceof crypto.Sign); assert.ok(rsaVerify instanceof crypto.Verify); rsaSign.update(rsaPubPem); var rsaSignature = rsaSign.sign(rsaKeyPem, 'hex'); assert.strictEqual( rsaSignature, '5c50e3145c4e2497aadb0eabc83b342d0b0021ece0d4c4a064b7c' + '8f020d7e2688b122bfb54c724ac9ee169f83f66d2fe90abeb95e8' + 'e1290e7e177152a4de3d944cf7d4883114a20ed0f78e70e25ef0f' + '60f06b858e6af42a2f276ede95bbc6bc9a9bbdda15bd663186a6f' + '40819a7af19e577bb2efa5e579a1f5ce8a0d4ca8b8f6' ); rsaVerify.update(rsaPubPem); assert.strictEqual(rsaVerify.verify(rsaPubPem, rsaSignature, 'hex'), true); // // Test RSA signing and verification // (function() { var privateKey = fs.readFileSync( common.fixturesDir + '/test_rsa_privkey_2.pem'); var publicKey = fs.readFileSync( common.fixturesDir + '/test_rsa_pubkey_2.pem'); var input = 'I AM THE WALRUS'; var signature = '79d59d34f56d0e94aa6a3e306882b52ed4191f07521f25f505a078dc2f89' + '396e0c8ac89e996fde5717f4cb89199d8fec249961fcb07b74cd3d2a4ffa' + '235417b69618e4bcd76b97e29975b7ce862299410e1b522a328e44ac9bb2' + '8195e0268da7eda23d9825ac43c724e86ceeee0d0d4465678652ccaf6501' + '0ddfb299bedeb1ad'; var sign = crypto.createSign('RSA-SHA256'); sign.update(input); var output = sign.sign(privateKey, 'hex'); assert.equal(output, signature); var verify = crypto.createVerify('RSA-SHA256'); verify.update(input); assert.strictEqual(verify.verify(publicKey, signature, 'hex'), true); })(); // // Test DSA signing and verification // (function() { var privateKey = fs.readFileSync( common.fixturesDir + '/test_dsa_privkey.pem'); var publicKey = fs.readFileSync( common.fixturesDir + '/test_dsa_pubkey.pem'); var input = 'I AM THE WALRUS'; // DSA signatures vary across runs so there is no static string to verify // against var sign = crypto.createSign('DSS1'); sign.update(input); var signature = sign.sign(privateKey, 'hex'); var verify = crypto.createVerify('DSS1'); verify.update(input); assert.strictEqual(verify.verify(publicKey, signature, 'hex'), true); })(); // // Test PBKDF2 with RFC 6070 test vectors (except #4) // function testPBKDF2(password, salt, iterations, keylen, expected) { const actual = crypto.pbkdf2Sync(password, salt, iterations, keylen); assert.strictEqual(actual, expected); const cb = common.mustCall((err, actual) => { assert.strictEqual(actual, expected); }); crypto.pbkdf2(password, salt, iterations, keylen, cb); } testPBKDF2('password', 'salt', 1, 20, '\x0c\x60\xc8\x0f\x96\x1f\x0e\x71\xf3\xa9\xb5\x24' + '\xaf\x60\x12\x06\x2f\xe0\x37\xa6'); testPBKDF2('password', 'salt', 2, 20, '\xea\x6c\x01\x4d\xc7\x2d\x6f\x8c\xcd\x1e\xd9\x2a' + '\xce\x1d\x41\xf0\xd8\xde\x89\x57'); testPBKDF2('password', 'salt', 4096, 20, '\x4b\x00\x79\x01\xb7\x65\x48\x9a\xbe\xad\x49\xd9\x26' + '\xf7\x21\xd0\x65\xa4\x29\xc1'); testPBKDF2('passwordPASSWORDpassword', 'saltSALTsaltSALTsaltSALTsaltSALTsalt', 4096, 25, '\x3d\x2e\xec\x4f\xe4\x1c\x84\x9b\x80\xc8\xd8\x36\x62' + '\xc0\xe4\x4a\x8b\x29\x1a\x96\x4c\xf2\xf0\x70\x38'); testPBKDF2('pass\0word', 'sa\0lt', 4096, 16, '\x56\xfa\x6a\xa7\x55\x48\x09\x9d\xcc\x37\xd7\xf0\x34' + '\x25\xe0\xc3'); node-v4.8.2/test/parallel/test-crypto-certificate.js000644 000766 000024 00000002316 13070706737 022652 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var crypto = require('crypto'); crypto.DEFAULT_ENCODING = 'buffer'; var fs = require('fs'); // Test Certificates var spkacValid = fs.readFileSync(common.fixturesDir + '/spkac.valid'); var spkacFail = fs.readFileSync(common.fixturesDir + '/spkac.fail'); var spkacPem = fs.readFileSync(common.fixturesDir + '/spkac.pem'); var certificate = new crypto.Certificate(); assert.strictEqual(certificate.verifySpkac(spkacValid), true); assert.strictEqual(certificate.verifySpkac(spkacFail), false); assert.strictEqual( stripLineEndings(certificate.exportPublicKey(spkacValid).toString('utf8')), stripLineEndings(spkacPem.toString('utf8')) ); assert.strictEqual(certificate.exportPublicKey(spkacFail), ''); assert.strictEqual( certificate.exportChallenge(spkacValid).toString('utf8'), 'fb9ab814-6677-42a4-a60c-f905d1a6924d' ); assert.strictEqual(certificate.exportChallenge(spkacFail), ''); function stripLineEndings(obj) { return obj.replace(/\n/g, ''); } // direct call Certificate() should return instance assert(crypto.Certificate() instanceof crypto.Certificate); node-v4.8.2/test/parallel/test-crypto-cipher-decipher.js000644 000766 000024 00000007331 13070706737 023425 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } if (common.hasFipsCrypto) { common.skip('not supported in FIPS mode'); return; } var crypto = require('crypto'); function testCipher1(key) { // Test encryption and decryption var plaintext = 'Keep this a secret? No! Tell everyone about node.js!'; var cipher = crypto.createCipher('aes192', key); // encrypt plaintext which is in utf8 format // to a ciphertext which will be in hex var ciph = cipher.update(plaintext, 'utf8', 'hex'); // Only use binary or hex, not base64. ciph += cipher.final('hex'); var decipher = crypto.createDecipher('aes192', key); var txt = decipher.update(ciph, 'hex', 'utf8'); txt += decipher.final('utf8'); assert.strictEqual(txt, plaintext, 'encryption and decryption'); // streaming cipher interface // NB: In real life, it's not guaranteed that you can get all of it // in a single read() like this. But in this case, we know it's // quite small, so there's no harm. var cStream = crypto.createCipher('aes192', key); cStream.end(plaintext); ciph = cStream.read(); var dStream = crypto.createDecipher('aes192', key); dStream.end(ciph); txt = dStream.read().toString('utf8'); assert.strictEqual(txt, plaintext, 'encryption and decryption with streams'); } function testCipher2(key) { // encryption and decryption with Base64 // reported in https://github.com/joyent/node/issues/738 var plaintext = '32|RmVZZkFUVmpRRkp0TmJaUm56ZU9qcnJkaXNNWVNpTTU*|iXmckfRWZBGWWELw' + 'eCBsThSsfUHLeRe0KCsK8ooHgxie0zOINpXxfZi/oNG7uq9JWFVCk70gfzQH8ZUJ' + 'jAfaFg**'; var cipher = crypto.createCipher('aes256', key); // encrypt plaintext which is in utf8 format // to a ciphertext which will be in Base64 var ciph = cipher.update(plaintext, 'utf8', 'base64'); ciph += cipher.final('base64'); var decipher = crypto.createDecipher('aes256', key); var txt = decipher.update(ciph, 'base64', 'utf8'); txt += decipher.final('utf8'); assert.strictEqual(txt, plaintext, 'encryption and decryption with Base64'); } testCipher1('MySecretKey123'); testCipher1(new Buffer('MySecretKey123')); testCipher2('0123456789abcdef'); testCipher2(new Buffer('0123456789abcdef')); // Base64 padding regression test, see #4837. (function() { var c = crypto.createCipher('aes-256-cbc', 'secret'); var s = c.update('test', 'utf8', 'base64') + c.final('base64'); assert.equal(s, '375oxUQCIocvxmC5At+rvA=='); })(); // Calling Cipher.final() or Decipher.final() twice should error but // not assert. See #4886. (function() { var c = crypto.createCipher('aes-256-cbc', 'secret'); try { c.final('xxx'); } catch (e) { /* Ignore. */ } try { c.final('xxx'); } catch (e) { /* Ignore. */ } try { c.final('xxx'); } catch (e) { /* Ignore. */ } var d = crypto.createDecipher('aes-256-cbc', 'secret'); try { d.final('xxx'); } catch (e) { /* Ignore. */ } try { d.final('xxx'); } catch (e) { /* Ignore. */ } try { d.final('xxx'); } catch (e) { /* Ignore. */ } })(); // Regression test for #5482: string to Cipher#update() should not assert. (function() { var c = crypto.createCipher('aes192', '0123456789abcdef'); c.update('update'); c.final(); })(); // #5655 regression tests, 'utf-8' and 'utf8' are identical. (function() { var c = crypto.createCipher('aes192', '0123456789abcdef'); c.update('update', ''); // Defaults to "utf8". c.final('utf-8'); // Should not throw. c = crypto.createCipher('aes192', '0123456789abcdef'); c.update('update', 'utf8'); c.final('utf-8'); // Should not throw. c = crypto.createCipher('aes192', '0123456789abcdef'); c.update('update', 'utf-8'); c.final('utf8'); // Should not throw. })(); node-v4.8.2/test/parallel/test-crypto-cipheriv-decipheriv.js000644 000766 000024 00000007047 13070706737 024327 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const crypto = require('crypto'); function testCipher1(key, iv) { // Test encyrption and decryption with explicit key and iv const plaintext = '32|RmVZZkFUVmpRRkp0TmJaUm56ZU9qcnJkaXNNWVNpTTU*|iXmckfRWZBGWWELw' + 'eCBsThSsfUHLeRe0KCsK8ooHgxie0zOINpXxfZi/oNG7uq9JWFVCk70gfzQH8ZUJ' + 'jAfaFg**'; const cipher = crypto.createCipheriv('des-ede3-cbc', key, iv); let ciph = cipher.update(plaintext, 'utf8', 'hex'); ciph += cipher.final('hex'); const decipher = crypto.createDecipheriv('des-ede3-cbc', key, iv); let txt = decipher.update(ciph, 'hex', 'utf8'); txt += decipher.final('utf8'); assert.strictEqual(txt, plaintext, 'encryption/decryption with key and iv'); // streaming cipher interface // NB: In real life, it's not guaranteed that you can get all of it // in a single read() like this. But in this case, we know it's // quite small, so there's no harm. const cStream = crypto.createCipheriv('des-ede3-cbc', key, iv); cStream.end(plaintext); ciph = cStream.read(); const dStream = crypto.createDecipheriv('des-ede3-cbc', key, iv); dStream.end(ciph); txt = dStream.read().toString('utf8'); assert.strictEqual(txt, plaintext, 'streaming cipher iv'); } function testCipher2(key, iv) { // Test encyrption and decryption with explicit key and iv const plaintext = '32|RmVZZkFUVmpRRkp0TmJaUm56ZU9qcnJkaXNNWVNpTTU*|iXmckfRWZBGWWELw' + 'eCBsThSsfUHLeRe0KCsK8ooHgxie0zOINpXxfZi/oNG7uq9JWFVCk70gfzQH8ZUJ' + 'jAfaFg**'; const cipher = crypto.createCipheriv('des-ede3-cbc', key, iv); let ciph = cipher.update(plaintext, 'utf8', 'buffer'); ciph = Buffer.concat([ciph, cipher.final('buffer')]); const decipher = crypto.createDecipheriv('des-ede3-cbc', key, iv); let txt = decipher.update(ciph, 'buffer', 'utf8'); txt += decipher.final('utf8'); assert.strictEqual(txt, plaintext, 'encryption/decryption with key and iv'); } testCipher1('0123456789abcd0123456789', '12345678'); testCipher1('0123456789abcd0123456789', new Buffer('12345678')); testCipher1(new Buffer('0123456789abcd0123456789'), '12345678'); testCipher1(new Buffer('0123456789abcd0123456789'), new Buffer('12345678')); testCipher2(new Buffer('0123456789abcd0123456789'), new Buffer('12345678')); // Zero-sized IV should be accepted in ECB mode. crypto.createCipheriv('aes-128-ecb', Buffer.alloc(16), Buffer.alloc(0)); // But non-empty IVs should be rejected. for (let n = 1; n < 256; n += 1) { assert.throws( () => crypto.createCipheriv('aes-128-ecb', Buffer.alloc(16), Buffer.alloc(n)), /Invalid IV length/); } // Correctly sized IV should be accepted in CBC mode. crypto.createCipheriv('aes-128-cbc', Buffer.alloc(16), Buffer.alloc(16)); // But all other IV lengths should be rejected. for (let n = 0; n < 256; n += 1) { if (n === 16) continue; assert.throws( () => crypto.createCipheriv('aes-128-cbc', Buffer.alloc(16), Buffer.alloc(n)), /Invalid IV length/); } // Zero-sized IV should be rejected in GCM mode. assert.throws( () => crypto.createCipheriv('aes-128-gcm', Buffer.alloc(16), Buffer.alloc(0)), /Invalid IV length/); // But all other IV lengths should be accepted. for (let n = 1; n < 256; n += 1) { if (common.hasFipsCrypto && n < 12) continue; crypto.createCipheriv('aes-128-gcm', Buffer.alloc(16), Buffer.alloc(n)); } node-v4.8.2/test/parallel/test-crypto-dh-odd-key.js000644 000766 000024 00000001023 13070706737 022307 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var crypto = require('crypto'); function test() { var odd = new Buffer(39); odd.fill('A'); var c = crypto.createDiffieHellman(32); c.setPrivateKey(odd); c.generateKeys(); } // FIPS requires a length of at least 1024 if (!common.hasFipsCrypto) { assert.doesNotThrow(function() { test(); }); } else { assert.throws(function() { test(); }, /key size too small/); } node-v4.8.2/test/parallel/test-crypto-dh.js000644 000766 000024 00000016204 13070706737 020764 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var constants = require('constants'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var crypto = require('crypto'); // Test Diffie-Hellman with two parties sharing a secret, // using various encodings as we go along var dh1 = crypto.createDiffieHellman(common.hasFipsCrypto ? 1024 : 256); var p1 = dh1.getPrime('buffer'); var dh2 = crypto.createDiffieHellman(p1, 'buffer'); var key1 = dh1.generateKeys(); var key2 = dh2.generateKeys('hex'); var secret1 = dh1.computeSecret(key2, 'hex', 'base64'); var secret2 = dh2.computeSecret(key1, 'binary', 'buffer'); assert.equal(secret1, secret2.toString('base64')); assert.equal(dh1.verifyError, 0); assert.equal(dh2.verifyError, 0); assert.throws(function() { crypto.createDiffieHellman([0x1, 0x2]); }); assert.throws(function() { crypto.createDiffieHellman(function() { }); }); assert.throws(function() { crypto.createDiffieHellman(/abc/); }); assert.throws(function() { crypto.createDiffieHellman({}); }); // Create "another dh1" using generated keys from dh1, // and compute secret again var dh3 = crypto.createDiffieHellman(p1, 'buffer'); var privkey1 = dh1.getPrivateKey(); dh3.setPublicKey(key1); dh3.setPrivateKey(privkey1); assert.deepEqual(dh1.getPrime(), dh3.getPrime()); assert.deepEqual(dh1.getGenerator(), dh3.getGenerator()); assert.deepEqual(dh1.getPublicKey(), dh3.getPublicKey()); assert.deepEqual(dh1.getPrivateKey(), dh3.getPrivateKey()); assert.equal(dh3.verifyError, 0); var secret3 = dh3.computeSecret(key2, 'hex', 'base64'); assert.equal(secret1, secret3); // Run this one twice to make sure that the dh3 clears its error properly (function() { var c = crypto.createDecipheriv('aes-128-ecb', crypto.randomBytes(16), ''); assert.throws(function() { c.final('utf8'); }, /wrong final block length/); })(); assert.throws(function() { dh3.computeSecret(''); }, /key is too small/i); (function() { var c = crypto.createDecipheriv('aes-128-ecb', crypto.randomBytes(16), ''); assert.throws(function() { c.final('utf8'); }, /wrong final block length/); })(); // Create a shared using a DH group. var alice = crypto.createDiffieHellmanGroup('modp5'); var bob = crypto.createDiffieHellmanGroup('modp5'); alice.generateKeys(); bob.generateKeys(); var aSecret = alice.computeSecret(bob.getPublicKey()).toString('hex'); var bSecret = bob.computeSecret(alice.getPublicKey()).toString('hex'); assert.equal(aSecret, bSecret); assert.equal(alice.verifyError, constants.DH_NOT_SUITABLE_GENERATOR); assert.equal(bob.verifyError, constants.DH_NOT_SUITABLE_GENERATOR); /* Ensure specific generator (buffer) works as expected. * The values below (modp2/modp2buf) are for a 1024 bits long prime from * RFC 2412 E.2, see https://tools.ietf.org/html/rfc2412. */ var modp2 = crypto.createDiffieHellmanGroup('modp2'); var modp2buf = new Buffer([ 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xc9, 0x0f, 0xda, 0xa2, 0x21, 0x68, 0xc2, 0x34, 0xc4, 0xc6, 0x62, 0x8b, 0x80, 0xdc, 0x1c, 0xd1, 0x29, 0x02, 0x4e, 0x08, 0x8a, 0x67, 0xcc, 0x74, 0x02, 0x0b, 0xbe, 0xa6, 0x3b, 0x13, 0x9b, 0x22, 0x51, 0x4a, 0x08, 0x79, 0x8e, 0x34, 0x04, 0xdd, 0xef, 0x95, 0x19, 0xb3, 0xcd, 0x3a, 0x43, 0x1b, 0x30, 0x2b, 0x0a, 0x6d, 0xf2, 0x5f, 0x14, 0x37, 0x4f, 0xe1, 0x35, 0x6d, 0x6d, 0x51, 0xc2, 0x45, 0xe4, 0x85, 0xb5, 0x76, 0x62, 0x5e, 0x7e, 0xc6, 0xf4, 0x4c, 0x42, 0xe9, 0xa6, 0x37, 0xed, 0x6b, 0x0b, 0xff, 0x5c, 0xb6, 0xf4, 0x06, 0xb7, 0xed, 0xee, 0x38, 0x6b, 0xfb, 0x5a, 0x89, 0x9f, 0xa5, 0xae, 0x9f, 0x24, 0x11, 0x7c, 0x4b, 0x1f, 0xe6, 0x49, 0x28, 0x66, 0x51, 0xec, 0xe6, 0x53, 0x81, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff ]); var exmodp2 = crypto.createDiffieHellman(modp2buf, new Buffer([2])); modp2.generateKeys(); exmodp2.generateKeys(); var modp2Secret = modp2.computeSecret(exmodp2.getPublicKey()).toString('hex'); var exmodp2Secret = exmodp2.computeSecret(modp2.getPublicKey()).toString('hex'); assert.equal(modp2Secret, exmodp2Secret); assert.equal(modp2.verifyError, constants.DH_NOT_SUITABLE_GENERATOR); assert.equal(exmodp2.verifyError, constants.DH_NOT_SUITABLE_GENERATOR); // Ensure specific generator (string with encoding) works as expected. var exmodp2_2 = crypto.createDiffieHellman(modp2buf, '02', 'hex'); exmodp2_2.generateKeys(); modp2Secret = modp2.computeSecret(exmodp2_2.getPublicKey()).toString('hex'); var exmodp2_2Secret = exmodp2_2.computeSecret(modp2.getPublicKey()) .toString('hex'); assert.equal(modp2Secret, exmodp2_2Secret); assert.equal(exmodp2_2.verifyError, constants.DH_NOT_SUITABLE_GENERATOR); // Ensure specific generator (string without encoding) works as expected. var exmodp2_3 = crypto.createDiffieHellman(modp2buf, '\x02'); exmodp2_3.generateKeys(); modp2Secret = modp2.computeSecret(exmodp2_3.getPublicKey()).toString('hex'); var exmodp2_3Secret = exmodp2_3.computeSecret(modp2.getPublicKey()) .toString('hex'); assert.equal(modp2Secret, exmodp2_3Secret); assert.equal(exmodp2_3.verifyError, constants.DH_NOT_SUITABLE_GENERATOR); // Ensure specific generator (numeric) works as expected. var exmodp2_4 = crypto.createDiffieHellman(modp2buf, 2); exmodp2_4.generateKeys(); modp2Secret = modp2.computeSecret(exmodp2_4.getPublicKey()).toString('hex'); var exmodp2_4Secret = exmodp2_4.computeSecret(modp2.getPublicKey()) .toString('hex'); assert.equal(modp2Secret, exmodp2_4Secret); assert.equal(exmodp2_4.verifyError, constants.DH_NOT_SUITABLE_GENERATOR); var p = 'FFFFFFFFFFFFFFFFC90FDAA22168C234C4C6628B80DC1CD129024E088A67CC74' + '020BBEA63B139B22514A08798E3404DDEF9519B3CD3A431B302B0A6DF25F1437' + '4FE1356D6D51C245E485B576625E7EC6F44C42E9A637ED6B0BFF5CB6F406B7ED' + 'EE386BFB5A899FA5AE9F24117C4B1FE649286651ECE65381FFFFFFFFFFFFFFFF'; var bad_dh = crypto.createDiffieHellman(p, 'hex'); assert.equal(bad_dh.verifyError, constants.DH_NOT_SUITABLE_GENERATOR); // Test ECDH var ecdh1 = crypto.createECDH('prime256v1'); var ecdh2 = crypto.createECDH('prime256v1'); key1 = ecdh1.generateKeys(); key2 = ecdh2.generateKeys('hex'); secret1 = ecdh1.computeSecret(key2, 'hex', 'base64'); secret2 = ecdh2.computeSecret(key1, 'binary', 'buffer'); assert.equal(secret1, secret2.toString('base64')); // Oakley curves do not clean up ERR stack, it was causing unexpected failure // when accessing other OpenSSL APIs afterwards. crypto.createECDH('Oakley-EC2N-3'); crypto.createHash('sha256'); // Point formats assert.equal(ecdh1.getPublicKey('buffer', 'uncompressed')[0], 4); var firstByte = ecdh1.getPublicKey('buffer', 'compressed')[0]; assert(firstByte === 2 || firstByte === 3); firstByte = ecdh1.getPublicKey('buffer', 'hybrid')[0]; assert(firstByte === 6 || firstByte === 7); // ECDH should check that point is on curve var ecdh3 = crypto.createECDH('secp256k1'); var key3 = ecdh3.generateKeys(); assert.throws(function() { ecdh2.computeSecret(key3, 'binary', 'buffer'); }); // ECDH should allow .setPrivateKey()/.setPublicKey() var ecdh4 = crypto.createECDH('prime256v1'); ecdh4.setPrivateKey(ecdh1.getPrivateKey()); ecdh4.setPublicKey(ecdh1.getPublicKey()); assert.throws(function() { ecdh4.setPublicKey(ecdh3.getPublicKey()); }); node-v4.8.2/test/parallel/test-crypto-domain.js000644 000766 000024 00000001107 13070706737 021634 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var domain = require('domain'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var crypto = require('crypto'); function test(fn) { var ex = new Error('BAM'); var d = domain.create(); d.on('error', common.mustCall(function(err) { assert.strictEqual(err, ex); })); var cb = common.mustCall(function() { throw ex; }); d.run(cb); } test(function(cb) { crypto.pbkdf2('password', 'salt', 1, 8, cb); }); test(function(cb) { crypto.randomBytes(32, cb); }); node-v4.8.2/test/parallel/test-crypto-domains.js000644 000766 000024 00000001443 13070706737 022022 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var domain = require('domain'); var assert = require('assert'); var d = domain.create(); var expect = ['pbkdf2', 'randomBytes', 'pseudoRandomBytes']; if (!common.hasCrypto) { common.skip('missing crypto'); return; } var crypto = require('crypto'); d.on('error', common.mustCall(function(e) { assert.equal(e.message, expect.shift()); }, 3)); d.run(function() { one(); function one() { crypto.pbkdf2('a', 'b', 1, 8, function() { two(); throw new Error('pbkdf2'); }); } function two() { crypto.randomBytes(4, function() { three(); throw new Error('randomBytes'); }); } function three() { crypto.pseudoRandomBytes(4, function() { throw new Error('pseudoRandomBytes'); }); } }); node-v4.8.2/test/parallel/test-crypto-ecb.js000644 000766 000024 00000001624 13070706737 021122 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } if (common.hasFipsCrypto) { common.skip('BF-ECB is not FIPS 140-2 compatible'); return; } const crypto = require('crypto'); crypto.DEFAULT_ENCODING = 'buffer'; // Testing whether EVP_CipherInit_ex is functioning correctly. // Reference: bug#1997 { const encrypt = crypto.createCipheriv('BF-ECB', 'SomeRandomBlahz0c5GZVnR', ''); let hex = encrypt.update('Hello World!', 'ascii', 'hex'); hex += encrypt.final('hex'); assert.strictEqual(hex.toUpperCase(), '6D385F424AAB0CFBF0BB86E07FFB7D71'); } { const decrypt = crypto.createDecipheriv('BF-ECB', 'SomeRandomBlahz0c5GZVnR', ''); let msg = decrypt.update('6D385F424AAB0CFBF0BB86E07FFB7D71', 'hex', 'ascii'); msg += decrypt.final('ascii'); assert.strictEqual(msg, 'Hello World!'); } node-v4.8.2/test/parallel/test-crypto-from-binary.js000644 000766 000024 00000002403 13070706737 022612 0ustar00iojsstaff000000 000000 'use strict'; // This is the same as test/simple/test-crypto, but from before the shift // to use buffers by default. var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var crypto = require('crypto'); var EXTERN_APEX = 0xFBEE9; // manually controlled string for checking binary output var ucs2_control = 'a\u0000'; // grow the strings to proper length while (ucs2_control.length <= EXTERN_APEX) { ucs2_control = ucs2_control.repeat(2); } // check resultant buffer and output string var b = new Buffer(ucs2_control + ucs2_control, 'ucs2'); // // Test updating from birant data // (function() { var datum1 = b.slice(700000); var hash1_converted = crypto.createHash('sha1') .update(datum1.toString('base64'), 'base64') .digest('hex'); var hash1_direct = crypto.createHash('sha1').update(datum1).digest('hex'); assert.equal(hash1_direct, hash1_converted, 'should hash the same.'); var datum2 = b; var hash2_converted = crypto.createHash('sha1') .update(datum2.toString('base64'), 'base64') .digest('hex'); var hash2_direct = crypto.createHash('sha1').update(datum2).digest('hex'); assert.equal(hash2_direct, hash2_converted, 'should hash the same.'); })(); node-v4.8.2/test/parallel/test-crypto-hash-stream-pipe.js000644 000766 000024 00000000716 13070706737 023541 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var crypto = require('crypto'); var stream = require('stream'); var s = new stream.PassThrough(); var h = crypto.createHash('sha1'); var expect = '15987e60950cf22655b9323bc1e281f9c4aff47e'; s.pipe(h).on('data', common.mustCall(function(c) { assert.equal(c, expect); })).setEncoding('hex'); s.end('aoeu'); node-v4.8.2/test/parallel/test-crypto-hash.js000644 000766 000024 00000005535 13070706737 021321 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var fs = require('fs'); var path = require('path'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var crypto = require('crypto'); // Test hashing var a1 = crypto.createHash('sha1').update('Test123').digest('hex'); var a2 = crypto.createHash('sha256').update('Test123').digest('base64'); var a3 = crypto.createHash('sha512').update('Test123').digest(); // binary var a4 = crypto.createHash('sha1').update('Test123').digest('buffer'); // stream interface var a5 = crypto.createHash('sha512'); a5.end('Test123'); a5 = a5.read(); var a6 = crypto.createHash('sha512'); a6.write('Te'); a6.write('st'); a6.write('123'); a6.end(); a6 = a6.read(); var a7 = crypto.createHash('sha512'); a7.end(); a7 = a7.read(); var a8 = crypto.createHash('sha512'); a8.write(''); a8.end(); a8 = a8.read(); if (!common.hasFipsCrypto) { var a0 = crypto.createHash('md5').update('Test123').digest('binary'); assert.equal( a0, 'h\u00ea\u00cb\u0097\u00d8o\fF!\u00fa+\u000e\u0017\u00ca\u00bd\u008c', 'Test MD5 as binary' ); } assert.equal(a1, '8308651804facb7b9af8ffc53a33a22d6a1c8ac2', 'Test SHA1'); assert.equal(a2, '2bX1jws4GYKTlxhloUB09Z66PoJZW+y+hq5R8dnx9l4=', 'Test SHA256 as base64'); assert.deepEqual( a3, new Buffer( '\u00c1(4\u00f1\u0003\u001fd\u0097!O\'\u00d4C/&Qz\u00d4' + '\u0094\u0015l\u00b8\u008dQ+\u00db\u001d\u00c4\u00b5}\u00b2' + '\u00d6\u0092\u00a3\u00df\u00a2i\u00a1\u009b\n\n*\u000f' + '\u00d7\u00d6\u00a2\u00a8\u0085\u00e3<\u0083\u009c\u0093' + '\u00c2\u0006\u00da0\u00a1\u00879(G\u00ed\'', 'binary'), 'Test SHA512 as assumed buffer'); assert.deepEqual(a4, new Buffer('8308651804facb7b9af8ffc53a33a22d6a1c8ac2', 'hex'), 'Test SHA1'); // stream interface should produce the same result. assert.deepEqual(a5, a3, 'stream interface is consistent'); assert.deepEqual(a6, a3, 'stream interface is consistent'); assert.notEqual(a7, undefined, 'no data should return data'); assert.notEqual(a8, undefined, 'empty string should generate data'); // Test multiple updates to same hash var h1 = crypto.createHash('sha1').update('Test123').digest('hex'); var h2 = crypto.createHash('sha1').update('Test').update('123').digest('hex'); assert.equal(h1, h2, 'multipled updates'); // Test hashing for binary files var fn = path.join(common.fixturesDir, 'sample.png'); var sha1Hash = crypto.createHash('sha1'); var fileStream = fs.createReadStream(fn); fileStream.on('data', function(data) { sha1Hash.update(data); }); fileStream.on('close', function() { assert.equal(sha1Hash.digest('hex'), '22723e553129a336ad96e10f6aecdf0f45e4149e', 'Test SHA1 of sample.png'); }); // Issue #2227: unknown digest method should throw an error. assert.throws(function() { crypto.createHash('xyzzy'); }); node-v4.8.2/test/parallel/test-crypto-hmac.js000644 000766 000024 00000033724 13070706737 021307 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var crypto = require('crypto'); // Test for binding layer robustness { const binding = process.binding('crypto'); const h = new binding.Hmac(); // Fail to init the Hmac with an algorithm. assert.throws(() => h.update('hello'), /^TypeError: HmacUpdate fail$/); } // Test HMAC var h1 = crypto.createHmac('sha1', 'Node') .update('some data') .update('to hmac') .digest('hex'); assert.equal(h1, '19fd6e1ba73d9ed2224dd5094a71babe85d9a892', 'test HMAC'); // Test HMAC (Wikipedia Test Cases) var wikipedia = [ { key: 'key', data: 'The quick brown fox jumps over the lazy dog', hmac: { // HMACs lifted from Wikipedia. md5: '80070713463e7749b90c2dc24911e275', sha1: 'de7c9b85b8b78aa6bc8a7a36f70a90701c9db4d9', sha256: 'f7bc83f430538424b13298e6aa6fb143ef4d59a14946175997479dbc' + '2d1a3cd8' } }, { key: 'key', data: '', hmac: { // Intermediate test to help debugging. md5: '63530468a04e386459855da0063b6596', sha1: 'f42bb0eeb018ebbd4597ae7213711ec60760843f', sha256: '5d5d139563c95b5967b9bd9a8c9b233a9dedb45072794cd232dc1b74' + '832607d0' } }, { key: '', data: 'The quick brown fox jumps over the lazy dog', hmac: { // Intermediate test to help debugging. md5: 'ad262969c53bc16032f160081c4a07a0', sha1: '2ba7f707ad5f187c412de3106583c3111d668de8', sha256: 'fb011e6154a19b9a4c767373c305275a5a69e8b68b0b4c9200c383dc' + 'ed19a416' } }, { key: '', data: '', hmac: { // HMACs lifted from Wikipedia. md5: '74e6f7298a9c2d168935f58c001bad88', sha1: 'fbdb1d1b18aa6c08324b7d64b71fb76370690e1d', sha256: 'b613679a0814d9ec772f95d778c35fc5ff1697c493715653c6c71214' + '4292c5ad' } }, ]; for (let i = 0, l = wikipedia.length; i < l; i++) { for (const hash in wikipedia[i]['hmac']) { // FIPS does not support MD5. if (common.hasFipsCrypto && hash === 'md5') continue; const result = crypto.createHmac(hash, wikipedia[i]['key']) .update(wikipedia[i]['data']) .digest('hex'); assert.equal(wikipedia[i]['hmac'][hash], result, 'Test HMAC-' + hash + ': Test case ' + (i + 1) + ' wikipedia'); } } // Test HMAC-SHA-* (rfc 4231 Test Cases) var rfc4231 = [ { key: new Buffer('0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b', 'hex'), data: new Buffer('4869205468657265', 'hex'), // 'Hi There' hmac: { sha224: '896fb1128abbdf196832107cd49df33f47b4b1169912ba4f53684b22', sha256: 'b0344c61d8db38535ca8afceaf0bf12b881dc200c9833da726e9376c' + '2e32cff7', sha384: 'afd03944d84895626b0825f4ab46907f15f9dadbe4101ec682aa034c' + '7cebc59cfaea9ea9076ede7f4af152e8b2fa9cb6', sha512: '87aa7cdea5ef619d4ff0b4241a1d6cb02379f4e2ce4ec2787ad0b305' + '45e17cdedaa833b7d6b8a702038b274eaea3f4e4be9d914eeb61f170' + '2e696c203a126854' } }, { key: new Buffer('4a656665', 'hex'), // 'Jefe' data: new Buffer('7768617420646f2079612077616e7420666f72206e6f74686' + '96e673f', 'hex'), // 'what do ya want for nothing?' hmac: { sha224: 'a30e01098bc6dbbf45690f3a7e9e6d0f8bbea2a39e6148008fd05e44', sha256: '5bdcc146bf60754e6a042426089575c75a003f089d2739839dec58b9' + '64ec3843', sha384: 'af45d2e376484031617f78d2b58a6b1b9c7ef464f5a01b47e42ec373' + '6322445e8e2240ca5e69e2c78b3239ecfab21649', sha512: '164b7a7bfcf819e2e395fbe73b56e0a387bd64222e831fd610270cd7' + 'ea2505549758bf75c05a994a6d034f65f8f0e6fdcaeab1a34d4a6b4b' + '636e070a38bce737' } }, { key: new Buffer('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa', 'hex'), data: new Buffer('ddddddddddddddddddddddddddddddddddddddddddddddddd' + 'ddddddddddddddddddddddddddddddddddddddddddddddddddd', 'hex'), hmac: { sha224: '7fb3cb3588c6c1f6ffa9694d7d6ad2649365b0c1f65d69d1ec8333ea', sha256: '773ea91e36800e46854db8ebd09181a72959098b3ef8c122d9635514' + 'ced565fe', sha384: '88062608d3e6ad8a0aa2ace014c8a86f0aa635d947ac9febe83ef4e5' + '5966144b2a5ab39dc13814b94e3ab6e101a34f27', sha512: 'fa73b0089d56a284efb0f0756c890be9b1b5dbdd8ee81a3655f83e33' + 'b2279d39bf3e848279a722c806b485a47e67c807b946a337bee89426' + '74278859e13292fb' } }, { key: new Buffer('0102030405060708090a0b0c0d0e0f10111213141516171819', 'hex'), data: new Buffer('cdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdc' + 'dcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcd', 'hex'), hmac: { sha224: '6c11506874013cac6a2abc1bb382627cec6a90d86efc012de7afec5a', sha256: '82558a389a443c0ea4cc819899f2083a85f0faa3e578f8077a2e3ff4' + '6729665b', sha384: '3e8a69b7783c25851933ab6290af6ca77a9981480850009cc5577c6e' + '1f573b4e6801dd23c4a7d679ccf8a386c674cffb', sha512: 'b0ba465637458c6990e5a8c5f61d4af7e576d97ff94b872de76f8050' + '361ee3dba91ca5c11aa25eb4d679275cc5788063a5f19741120c4f2d' + 'e2adebeb10a298dd' } }, { key: new Buffer('0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c', 'hex'), // 'Test With Truncation' data: new Buffer('546573742057697468205472756e636174696f6e', 'hex'), hmac: { sha224: '0e2aea68a90c8d37c988bcdb9fca6fa8', sha256: 'a3b6167473100ee06e0c796c2955552b', sha384: '3abf34c3503b2a23a46efc619baef897', sha512: '415fad6271580a531d4179bc891d87a6' }, truncate: true }, { key: new Buffer('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaa', 'hex'), // 'Test Using Larger Than Block-Size Key - Hash Key First' data: new Buffer('54657374205573696e67204c6172676572205468616e20426' + 'c6f636b2d53697a65204b6579202d2048617368204b657920' + '4669727374', 'hex'), hmac: { sha224: '95e9a0db962095adaebe9b2d6f0dbce2d499f112f2d2b7273fa6870e', sha256: '60e431591ee0b67f0d8a26aacbf5b77f8e0bc6213728c5140546040f' + '0ee37f54', sha384: '4ece084485813e9088d2c63a041bc5b44f9ef1012a2b588f3cd11f05' + '033ac4c60c2ef6ab4030fe8296248df163f44952', sha512: '80b24263c7c1a3ebb71493c1dd7be8b49b46d1f41b4aeec1121b0137' + '83f8f3526b56d037e05f2598bd0fd2215d6a1e5295e64f73f63f0aec' + '8b915a985d786598' } }, { key: new Buffer('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaa', 'hex'), // 'This is a test using a larger than block-size key and a larger ' + // 'than block-size data. The key needs to be hashed before being ' + // 'used by the HMAC algorithm.' data: new Buffer('5468697320697320612074657374207573696e672061206c6' + '172676572207468616e20626c6f636b2d73697a65206b6579' + '20616e642061206c6172676572207468616e20626c6f636b2' + 'd73697a6520646174612e20546865206b6579206e65656473' + '20746f20626520686173686564206265666f7265206265696' + 'e6720757365642062792074686520484d414320616c676f72' + '6974686d2e', 'hex'), hmac: { sha224: '3a854166ac5d9f023f54d517d0b39dbd946770db9c2b95c9f6f565d1', sha256: '9b09ffa71b942fcb27635fbcd5b0e944bfdc63644f0713938a7f5153' + '5c3a35e2', sha384: '6617178e941f020d351e2f254e8fd32c602420feb0b8fb9adccebb82' + '461e99c5a678cc31e799176d3860e6110c46523e', sha512: 'e37b6a775dc87dbaa4dfa9f96e5e3ffddebd71f8867289865df5a32d' + '20cdc944b6022cac3c4982b10d5eeb55c3e4de15134676fb6de04460' + '65c97440fa8c6a58' } } ]; for (let i = 0, l = rfc4231.length; i < l; i++) { for (const hash in rfc4231[i]['hmac']) { const str = crypto.createHmac(hash, rfc4231[i].key); str.end(rfc4231[i].data); let strRes = str.read().toString('hex'); let result = crypto.createHmac(hash, rfc4231[i]['key']) .update(rfc4231[i]['data']) .digest('hex'); if (rfc4231[i]['truncate']) { result = result.substr(0, 32); // first 128 bits == 32 hex chars strRes = strRes.substr(0, 32); } assert.equal(rfc4231[i]['hmac'][hash], result, 'Test HMAC-' + hash + ': Test case ' + (i + 1) + ' rfc 4231'); assert.equal(strRes, result, 'Should get same result from stream'); } } // Test HMAC-MD5/SHA1 (rfc 2202 Test Cases) var rfc2202_md5 = [ { key: new Buffer('0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b', 'hex'), data: 'Hi There', hmac: '9294727a3638bb1c13f48ef8158bfc9d' }, { key: 'Jefe', data: 'what do ya want for nothing?', hmac: '750c783e6ab0b503eaa86e310a5db738' }, { key: new Buffer('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa', 'hex'), data: new Buffer('ddddddddddddddddddddddddddddddddddddddddddddddddd' + 'ddddddddddddddddddddddddddddddddddddddddddddddddddd', 'hex'), hmac: '56be34521d144c88dbb8c733f0e8b3f6' }, { key: new Buffer('0102030405060708090a0b0c0d0e0f10111213141516171819', 'hex'), data: new Buffer('cdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdc' + 'dcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcd' + 'cdcdcdcdcd', 'hex'), hmac: '697eaf0aca3a3aea3a75164746ffaa79' }, { key: new Buffer('0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c', 'hex'), data: 'Test With Truncation', hmac: '56461ef2342edc00f9bab995690efd4c' }, { key: new Buffer('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaa', 'hex'), data: 'Test Using Larger Than Block-Size Key - Hash Key First', hmac: '6b1ab7fe4bd7bf8f0b62e6ce61b9d0cd' }, { key: new Buffer('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaa', 'hex'), data: 'Test Using Larger Than Block-Size Key and Larger Than One ' + 'Block-Size Data', hmac: '6f630fad67cda0ee1fb1f562db3aa53e' } ]; var rfc2202_sha1 = [ { key: new Buffer('0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b', 'hex'), data: 'Hi There', hmac: 'b617318655057264e28bc0b6fb378c8ef146be00' }, { key: 'Jefe', data: 'what do ya want for nothing?', hmac: 'effcdf6ae5eb2fa2d27416d5f184df9c259a7c79' }, { key: new Buffer('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa', 'hex'), data: new Buffer('ddddddddddddddddddddddddddddddddddddddddddddd' + 'ddddddddddddddddddddddddddddddddddddddddddddd' + 'dddddddddd', 'hex'), hmac: '125d7342b9ac11cd91a39af48aa17b4f63f175d3' }, { key: new Buffer('0102030405060708090a0b0c0d0e0f10111213141516171819', 'hex'), data: new Buffer('cdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdc' + 'dcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcdcd' + 'cdcdcdcdcd', 'hex'), hmac: '4c9007f4026250c6bc8414f9bf50c86c2d7235da' }, { key: new Buffer('0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c', 'hex'), data: 'Test With Truncation', hmac: '4c1a03424b55e07fe7f27be1d58bb9324a9a5a04' }, { key: new Buffer('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaa', 'hex'), data: 'Test Using Larger Than Block-Size Key - Hash Key First', hmac: 'aa4ae5e15272d00e95705637ce8a3b55ed402112' }, { key: new Buffer('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa' + 'aaaaaaaaaaaaaaaaaaaaaa', 'hex'), data: 'Test Using Larger Than Block-Size Key and Larger Than One ' + 'Block-Size Data', hmac: 'e8e99d0f45237d786d6bbaa7965c7808bbff1a91' } ]; if (!common.hasFipsCrypto) { for (let i = 0, l = rfc2202_md5.length; i < l; i++) { assert.equal(rfc2202_md5[i]['hmac'], crypto.createHmac('md5', rfc2202_md5[i]['key']) .update(rfc2202_md5[i]['data']) .digest('hex'), 'Test HMAC-MD5 : Test case ' + (i + 1) + ' rfc 2202'); } } for (let i = 0, l = rfc2202_sha1.length; i < l; i++) { assert.equal(rfc2202_sha1[i]['hmac'], crypto.createHmac('sha1', rfc2202_sha1[i]['key']) .update(rfc2202_sha1[i]['data']) .digest('hex'), 'Test HMAC-SHA1 : Test case ' + (i + 1) + ' rfc 2202'); } node-v4.8.2/test/parallel/test-crypto-padding-aes256.js000644 000766 000024 00000003022 13070706737 022774 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var crypto = require('crypto'); crypto.DEFAULT_ENCODING = 'buffer'; function aes256(decipherFinal) { var iv = new Buffer('00000000000000000000000000000000', 'hex'); var key = new Buffer('0123456789abcdef0123456789abcdef' + '0123456789abcdef0123456789abcdef', 'hex'); function encrypt(val, pad) { var c = crypto.createCipheriv('aes256', key, iv); c.setAutoPadding(pad); return c.update(val, 'utf8', 'binary') + c.final('binary'); } function decrypt(val, pad) { var c = crypto.createDecipheriv('aes256', key, iv); c.setAutoPadding(pad); return c.update(val, 'binary', 'utf8') + c[decipherFinal]('utf8'); } // echo 0123456789abcdef0123456789abcdef \ // | openssl enc -e -aes256 -nopad -K -iv \ // | openssl enc -d -aes256 -nopad -K -iv var plaintext = '0123456789abcdef0123456789abcdef'; // multiple of block size var encrypted = encrypt(plaintext, false); var decrypted = decrypt(encrypted, false); assert.equal(decrypted, plaintext); // echo 0123456789abcdef0123456789abcde \ // | openssl enc -e -aes256 -K -iv \ // | openssl enc -d -aes256 -K -iv plaintext = '0123456789abcdef0123456789abcde'; // not a multiple encrypted = encrypt(plaintext, true); decrypted = decrypt(encrypted, true); assert.equal(decrypted, plaintext); } aes256('final'); aes256('finaltol'); node-v4.8.2/test/parallel/test-crypto-padding.js000644 000766 000024 00000005747 13070706737 022011 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var crypto = require('crypto'); crypto.DEFAULT_ENCODING = 'buffer'; /* * Input data */ const ODD_LENGTH_PLAIN = 'Hello node world!'; const EVEN_LENGTH_PLAIN = 'Hello node world!AbC09876dDeFgHi'; const KEY_PLAIN = 'S3c.r.e.t.K.e.Y!'; const IV_PLAIN = 'blahFizz2011Buzz'; var CIPHER_NAME = 'aes-128-cbc'; /* * Expected result data */ // echo -n 'Hello node world!' | \ // openssl enc -aes-128-cbc -e -K 5333632e722e652e742e4b2e652e5921 \ // -iv 626c616846697a7a3230313142757a7a | xxd -p -c256 var ODD_LENGTH_ENCRYPTED = '7f57859550d4d2fdb9806da2a750461a9fe77253cd1cbd4b07beee4e070d561f'; // echo -n 'Hello node world!AbC09876dDeFgHi' | \ // openssl enc -aes-128-cbc -e -K 5333632e722e652e742e4b2e652e5921 \ // -iv 626c616846697a7a3230313142757a7a | xxd -p -c256 var EVEN_LENGTH_ENCRYPTED = '7f57859550d4d2fdb9806da2a750461ab46e71b3d78ebe2d9684dfc87f7575b988' + '6119866912cb8c7bcaf76c5ebc2378'; // echo -n 'Hello node world!AbC09876dDeFgHi' | \ // openssl enc -aes-128-cbc -e -K 5333632e722e652e742e4b2e652e5921 \ // -iv 626c616846697a7a3230313142757a7a -nopad | xxd -p -c256 var EVEN_LENGTH_ENCRYPTED_NOPAD = '7f57859550d4d2fdb9806da2a750461ab46e' + '71b3d78ebe2d9684dfc87f7575b9'; /* * Helper wrappers */ function enc(plain, pad) { var encrypt = crypto.createCipheriv(CIPHER_NAME, KEY_PLAIN, IV_PLAIN); encrypt.setAutoPadding(pad); var hex = encrypt.update(plain, 'ascii', 'hex'); hex += encrypt.final('hex'); return hex; } function dec(encd, pad) { var decrypt = crypto.createDecipheriv(CIPHER_NAME, KEY_PLAIN, IV_PLAIN); decrypt.setAutoPadding(pad); var plain = decrypt.update(encd, 'hex'); plain += decrypt.final('binary'); return plain; } /* * Test encryption */ assert.strictEqual(enc(ODD_LENGTH_PLAIN, true), ODD_LENGTH_ENCRYPTED); assert.strictEqual(enc(EVEN_LENGTH_PLAIN, true), EVEN_LENGTH_ENCRYPTED); assert.throws(function() { // input must have block length % enc(ODD_LENGTH_PLAIN, false); }, /data not multiple of block length/); assert.doesNotThrow(function() { assert.strictEqual( enc(EVEN_LENGTH_PLAIN, false), EVEN_LENGTH_ENCRYPTED_NOPAD ); }); /* * Test decryption */ assert.strictEqual(dec(ODD_LENGTH_ENCRYPTED, true), ODD_LENGTH_PLAIN); assert.strictEqual(dec(EVEN_LENGTH_ENCRYPTED, true), EVEN_LENGTH_PLAIN); assert.doesNotThrow(function() { // returns including original padding assert.strictEqual(dec(ODD_LENGTH_ENCRYPTED, false).length, 32); assert.strictEqual(dec(EVEN_LENGTH_ENCRYPTED, false).length, 48); }); assert.throws(function() { // must have at least 1 byte of padding (PKCS): assert.strictEqual( dec(EVEN_LENGTH_ENCRYPTED_NOPAD, true), EVEN_LENGTH_PLAIN ); }, /bad decrypt/); assert.doesNotThrow(function() { // no-pad encrypted string should return the same: assert.strictEqual( dec(EVEN_LENGTH_ENCRYPTED_NOPAD, false), EVEN_LENGTH_PLAIN ); }); node-v4.8.2/test/parallel/test-crypto-pbkdf2.js000644 000766 000024 00000005366 13070706737 021550 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var crypto = require('crypto'); // // Test PBKDF2 with RFC 6070 test vectors (except #4) // function testPBKDF2(password, salt, iterations, keylen, expected) { var actual = crypto.pbkdf2Sync(password, salt, iterations, keylen); assert.equal(actual.toString('binary'), expected); crypto.pbkdf2(password, salt, iterations, keylen, function(err, actual) { assert.equal(actual.toString('binary'), expected); }); } testPBKDF2('password', 'salt', 1, 20, '\x0c\x60\xc8\x0f\x96\x1f\x0e\x71\xf3\xa9\xb5\x24' + '\xaf\x60\x12\x06\x2f\xe0\x37\xa6'); testPBKDF2('password', 'salt', 2, 20, '\xea\x6c\x01\x4d\xc7\x2d\x6f\x8c\xcd\x1e\xd9\x2a' + '\xce\x1d\x41\xf0\xd8\xde\x89\x57'); testPBKDF2('password', 'salt', 4096, 20, '\x4b\x00\x79\x01\xb7\x65\x48\x9a\xbe\xad\x49\xd9\x26' + '\xf7\x21\xd0\x65\xa4\x29\xc1'); testPBKDF2('passwordPASSWORDpassword', 'saltSALTsaltSALTsaltSALTsaltSALTsalt', 4096, 25, '\x3d\x2e\xec\x4f\xe4\x1c\x84\x9b\x80\xc8\xd8\x36\x62' + '\xc0\xe4\x4a\x8b\x29\x1a\x96\x4c\xf2\xf0\x70\x38'); testPBKDF2('pass\0word', 'sa\0lt', 4096, 16, '\x56\xfa\x6a\xa7\x55\x48\x09\x9d\xcc\x37\xd7\xf0\x34' + '\x25\xe0\xc3'); var expected = '64c486c55d30d4c5a079b8823b7d7cb37ff0556f537da8410233bcec330ed956'; var key = crypto.pbkdf2Sync('password', 'salt', 32, 32, 'sha256'); assert.equal(key.toString('hex'), expected); crypto.pbkdf2('password', 'salt', 32, 32, 'sha256', common.mustCall(ondone)); function ondone(err, key) { if (err) throw err; assert.equal(key.toString('hex'), expected); } // Error path should not leak memory (check with valgrind). assert.throws(function() { crypto.pbkdf2('password', 'salt', 1, 20, null); }); // Should not work with Infinity key length assert.throws(function() { crypto.pbkdf2('password', 'salt', 1, Infinity, common.fail); }, /Bad key length/); // Should not work with negative Infinity key length assert.throws(function() { crypto.pbkdf2('password', 'salt', 1, -Infinity, common.fail); }, /Bad key length/); // Should not work with NaN key length assert.throws(function() { crypto.pbkdf2('password', 'salt', 1, NaN, common.fail); }, /Bad key length/); // Should not work with negative key length assert.throws(function() { crypto.pbkdf2('password', 'salt', 1, -1, common.fail); }, /Bad key length/); // Should not get FATAL ERROR with empty password and salt // https://github.com/nodejs/node/issues/8571 assert.doesNotThrow(() => { crypto.pbkdf2('', '', 1, 32, 'sha256', common.mustCall((e) => { assert.ifError(e); })); }); node-v4.8.2/test/parallel/test-crypto-random.js000644 000766 000024 00000001770 13070706737 021653 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const assert = require('assert'); const crypto = require('crypto'); crypto.DEFAULT_ENCODING = 'buffer'; // bump, we register a lot of exit listeners process.setMaxListeners(256); [crypto.randomBytes, crypto.pseudoRandomBytes].forEach(function(f) { [-1, undefined, null, false, true, {}, []].forEach(function(value) { assert.throws(function() { f(value); }, TypeError); assert.throws(function() { f(value, function() {}); }, TypeError); }); [0, 1, 2, 4, 16, 256, 1024].forEach(function(len) { f(len, common.mustCall(function(ex, buf) { assert.strictEqual(ex, null); assert.strictEqual(buf.length, len); assert.ok(Buffer.isBuffer(buf)); })); }); }); // #5126, "FATAL ERROR: v8::Object::SetIndexedPropertiesToExternalArrayData() // length exceeds max acceptable value" assert.throws(function() { crypto.randomBytes((-1 >>> 0) + 1); }, TypeError); node-v4.8.2/test/parallel/test-crypto-rsa-dsa.js000644 000766 000024 00000017273 13070706737 021732 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var fs = require('fs'); var constants = require('constants'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var crypto = require('crypto'); // Test certificates var certPem = fs.readFileSync(common.fixturesDir + '/test_cert.pem', 'ascii'); var keyPem = fs.readFileSync(common.fixturesDir + '/test_key.pem', 'ascii'); var rsaPubPem = fs.readFileSync(common.fixturesDir + '/test_rsa_pubkey.pem', 'ascii'); var rsaKeyPem = fs.readFileSync(common.fixturesDir + '/test_rsa_privkey.pem', 'ascii'); var rsaKeyPemEncrypted = fs.readFileSync( common.fixturesDir + '/test_rsa_privkey_encrypted.pem', 'ascii'); var dsaPubPem = fs.readFileSync(common.fixturesDir + '/test_dsa_pubkey.pem', 'ascii'); var dsaKeyPem = fs.readFileSync(common.fixturesDir + '/test_dsa_privkey.pem', 'ascii'); var dsaKeyPemEncrypted = fs.readFileSync( common.fixturesDir + '/test_dsa_privkey_encrypted.pem', 'ascii'); // Test RSA encryption/decryption (function() { var input = 'I AM THE WALRUS'; var bufferToEncrypt = new Buffer(input); var encryptedBuffer = crypto.publicEncrypt(rsaPubPem, bufferToEncrypt); var decryptedBuffer = crypto.privateDecrypt(rsaKeyPem, encryptedBuffer); assert.equal(input, decryptedBuffer.toString()); var decryptedBufferWithPassword = crypto.privateDecrypt({ key: rsaKeyPemEncrypted, passphrase: 'password' }, encryptedBuffer); assert.equal(input, decryptedBufferWithPassword.toString()); encryptedBuffer = crypto.publicEncrypt({ key: rsaKeyPemEncrypted, passphrase: 'password' }, bufferToEncrypt); decryptedBufferWithPassword = crypto.privateDecrypt({ key: rsaKeyPemEncrypted, passphrase: 'password' }, encryptedBuffer); assert.equal(input, decryptedBufferWithPassword.toString()); encryptedBuffer = crypto.privateEncrypt({ key: rsaKeyPemEncrypted, passphrase: new Buffer('password') }, bufferToEncrypt); decryptedBufferWithPassword = crypto.publicDecrypt({ key: rsaKeyPemEncrypted, passphrase: new Buffer('password') }, encryptedBuffer); assert.equal(input, decryptedBufferWithPassword.toString()); encryptedBuffer = crypto.publicEncrypt(certPem, bufferToEncrypt); decryptedBuffer = crypto.privateDecrypt(keyPem, encryptedBuffer); assert.equal(input, decryptedBuffer.toString()); encryptedBuffer = crypto.publicEncrypt(keyPem, bufferToEncrypt); decryptedBuffer = crypto.privateDecrypt(keyPem, encryptedBuffer); assert.equal(input, decryptedBuffer.toString()); encryptedBuffer = crypto.privateEncrypt(keyPem, bufferToEncrypt); decryptedBuffer = crypto.publicDecrypt(keyPem, encryptedBuffer); assert.equal(input, decryptedBuffer.toString()); assert.throws(function() { crypto.privateDecrypt({ key: rsaKeyPemEncrypted, passphrase: 'wrong' }, bufferToEncrypt); }); assert.throws(function() { crypto.publicEncrypt({ key: rsaKeyPemEncrypted, passphrase: 'wrong' }, encryptedBuffer); }); encryptedBuffer = crypto.privateEncrypt({ key: rsaKeyPemEncrypted, passphrase: new Buffer('password') }, bufferToEncrypt); assert.throws(function() { crypto.publicDecrypt({ key: rsaKeyPemEncrypted, passphrase: [].concat.apply([], new Buffer('password')) }, encryptedBuffer); }); })(); function test_rsa(padding) { var input = new Buffer(padding === 'RSA_NO_PADDING' ? 1024 / 8 : 32); for (var i = 0; i < input.length; i++) input[i] = (i * 7 + 11) & 0xff; var bufferToEncrypt = new Buffer(input); padding = constants[padding]; var encryptedBuffer = crypto.publicEncrypt({ key: rsaPubPem, padding: padding }, bufferToEncrypt); var decryptedBuffer = crypto.privateDecrypt({ key: rsaKeyPem, padding: padding }, encryptedBuffer); assert.equal(input, decryptedBuffer.toString()); } test_rsa('RSA_NO_PADDING'); test_rsa('RSA_PKCS1_PADDING'); test_rsa('RSA_PKCS1_OAEP_PADDING'); // Test RSA key signing/verification var rsaSign = crypto.createSign('RSA-SHA1'); var rsaVerify = crypto.createVerify('RSA-SHA1'); assert.ok(rsaSign); assert.ok(rsaVerify); rsaSign.update(rsaPubPem); var rsaSignature = rsaSign.sign(rsaKeyPem, 'hex'); assert.equal(rsaSignature, '5c50e3145c4e2497aadb0eabc83b342d0b0021ece0d4c4a064b7c' + '8f020d7e2688b122bfb54c724ac9ee169f83f66d2fe90abeb95e8' + 'e1290e7e177152a4de3d944cf7d4883114a20ed0f78e70e25ef0f' + '60f06b858e6af42a2f276ede95bbc6bc9a9bbdda15bd663186a6f' + '40819a7af19e577bb2efa5e579a1f5ce8a0d4ca8b8f6'); rsaVerify.update(rsaPubPem); assert.strictEqual(rsaVerify.verify(rsaPubPem, rsaSignature, 'hex'), true); // Test RSA key signing/verification with encrypted key rsaSign = crypto.createSign('RSA-SHA1'); rsaSign.update(rsaPubPem); assert.doesNotThrow(function() { var signOptions = { key: rsaKeyPemEncrypted, passphrase: 'password' }; rsaSignature = rsaSign.sign(signOptions, 'hex'); }); assert.equal(rsaSignature, '5c50e3145c4e2497aadb0eabc83b342d0b0021ece0d4c4a064b7c' + '8f020d7e2688b122bfb54c724ac9ee169f83f66d2fe90abeb95e8' + 'e1290e7e177152a4de3d944cf7d4883114a20ed0f78e70e25ef0f' + '60f06b858e6af42a2f276ede95bbc6bc9a9bbdda15bd663186a6f' + '40819a7af19e577bb2efa5e579a1f5ce8a0d4ca8b8f6'); rsaVerify = crypto.createVerify('RSA-SHA1'); rsaVerify.update(rsaPubPem); assert.strictEqual(rsaVerify.verify(rsaPubPem, rsaSignature, 'hex'), true); rsaSign = crypto.createSign('RSA-SHA1'); rsaSign.update(rsaPubPem); assert.throws(function() { var signOptions = { key: rsaKeyPemEncrypted, passphrase: 'wrong' }; rsaSign.sign(signOptions, 'hex'); }); // // Test RSA signing and verification // (function() { var privateKey = fs.readFileSync( common.fixturesDir + '/test_rsa_privkey_2.pem'); var publicKey = fs.readFileSync( common.fixturesDir + '/test_rsa_pubkey_2.pem'); var input = 'I AM THE WALRUS'; var signature = '79d59d34f56d0e94aa6a3e306882b52ed4191f07521f25f505a078dc2f89' + '396e0c8ac89e996fde5717f4cb89199d8fec249961fcb07b74cd3d2a4ffa' + '235417b69618e4bcd76b97e29975b7ce862299410e1b522a328e44ac9bb2' + '8195e0268da7eda23d9825ac43c724e86ceeee0d0d4465678652ccaf6501' + '0ddfb299bedeb1ad'; var sign = crypto.createSign('RSA-SHA256'); sign.update(input); var output = sign.sign(privateKey, 'hex'); assert.equal(output, signature); var verify = crypto.createVerify('RSA-SHA256'); verify.update(input); assert.strictEqual(verify.verify(publicKey, signature, 'hex'), true); })(); // // Test DSA signing and verification // (function() { var input = 'I AM THE WALRUS'; // DSA signatures vary across runs so there is no static string to verify // against var sign = crypto.createSign('DSS1'); sign.update(input); var signature = sign.sign(dsaKeyPem, 'hex'); var verify = crypto.createVerify('DSS1'); verify.update(input); assert.strictEqual(verify.verify(dsaPubPem, signature, 'hex'), true); })(); // // Test DSA signing and verification with encrypted key // const input = 'I AM THE WALRUS'; { const sign = crypto.createSign('DSS1'); sign.update(input); assert.throws(function() { sign.sign({ key: dsaKeyPemEncrypted, passphrase: 'wrong' }, 'hex'); }); } { // DSA signatures vary across runs so there is no static string to verify // against const sign = crypto.createSign('DSS1'); sign.update(input); let signature; assert.doesNotThrow(function() { const signOptions = { key: dsaKeyPemEncrypted, passphrase: 'password' }; signature = sign.sign(signOptions, 'hex'); }); const verify = crypto.createVerify('DSS1'); verify.update(input); assert.strictEqual(verify.verify(dsaPubPem, signature, 'hex'), true); } node-v4.8.2/test/parallel/test-crypto-sign-verify.js000644 000766 000024 00000005065 13070706737 022636 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var fs = require('fs'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var crypto = require('crypto'); // Test certificates var certPem = fs.readFileSync(common.fixturesDir + '/test_cert.pem', 'ascii'); var keyPem = fs.readFileSync(common.fixturesDir + '/test_key.pem', 'ascii'); // Test signing and verifying { const s1 = crypto.createSign('RSA-SHA1') .update('Test123') .sign(keyPem, 'base64'); let s1stream = crypto.createSign('RSA-SHA1'); s1stream.end('Test123'); s1stream = s1stream.sign(keyPem, 'base64'); assert.strictEqual(s1, s1stream, 'Stream produces same output'); const verified = crypto.createVerify('RSA-SHA1') .update('Test') .update('123') .verify(certPem, s1, 'base64'); assert.strictEqual(verified, true, 'sign and verify (base 64)'); } { const s2 = crypto.createSign('RSA-SHA256') .update('Test123') .sign(keyPem, 'binary'); let s2stream = crypto.createSign('RSA-SHA256'); s2stream.end('Test123'); s2stream = s2stream.sign(keyPem, 'binary'); assert.strictEqual(s2, s2stream, 'Stream produces same output'); let verified = crypto.createVerify('RSA-SHA256') .update('Test') .update('123') .verify(certPem, s2, 'binary'); assert.strictEqual(verified, true, 'sign and verify (binary)'); const verStream = crypto.createVerify('RSA-SHA256'); verStream.write('Tes'); verStream.write('t12'); verStream.end('3'); verified = verStream.verify(certPem, s2, 'binary'); assert.strictEqual(verified, true, 'sign and verify (stream)'); } { const s3 = crypto.createSign('RSA-SHA1') .update('Test123') .sign(keyPem, 'buffer'); let verified = crypto.createVerify('RSA-SHA1') .update('Test') .update('123') .verify(certPem, s3); assert.strictEqual(verified, true, 'sign and verify (buffer)'); const verStream = crypto.createVerify('RSA-SHA1'); verStream.write('Tes'); verStream.write('t12'); verStream.end('3'); verified = verStream.verify(certPem, s3); assert.strictEqual(verified, true, 'sign and verify (stream)'); } // Test throws exception when key options is null { assert.throws(() => { crypto.createSign('RSA-SHA1').update('Test123').sign(null, 'base64'); }, /^Error: No key provided to sign$/); } node-v4.8.2/test/parallel/test-crypto-stream.js000644 000766 000024 00000003405 13070706737 021663 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var stream = require('stream'); var util = require('util'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var crypto = require('crypto'); // Small stream to buffer converter function Stream2buffer(callback) { stream.Writable.call(this); this._buffers = []; this.once('finish', function() { callback(null, Buffer.concat(this._buffers)); }); } util.inherits(Stream2buffer, stream.Writable); Stream2buffer.prototype._write = function(data, encodeing, done) { this._buffers.push(data); return done(null); }; if (!common.hasFipsCrypto) { // Create an md5 hash of "Hallo world" var hasher1 = crypto.createHash('md5'); hasher1.pipe(new Stream2buffer(common.mustCall(function end(err, hash) { assert.strictEqual(err, null); assert.strictEqual( hash.toString('hex'), '06460dadb35d3d503047ce750ceb2d07' ); }))); hasher1.end('Hallo world'); // Simpler check for unpipe, setEncoding, pause and resume crypto.createHash('md5').unpipe({}); crypto.createHash('md5').setEncoding('utf8'); crypto.createHash('md5').pause(); crypto.createHash('md5').resume(); } // Decipher._flush() should emit an error event, not an exception. const key = new Buffer('48fb56eb10ffeb13fc0ef551bbca3b1b', 'hex'); const badkey = new Buffer('12341234123412341234123412341234', 'hex'); const iv = new Buffer('6d358219d1f488f5f4eb12820a66d146', 'hex'); const cipher = crypto.createCipheriv('aes-128-cbc', key, iv); const decipher = crypto.createDecipheriv('aes-128-cbc', badkey, iv); cipher.pipe(decipher) .on('error', common.mustCall(function end(err) { assert(/bad decrypt/.test(err)); })); cipher.end('Papaya!'); // Should not cause an unhandled exception. node-v4.8.2/test/parallel/test-crypto-verify-failure.js000644 000766 000024 00000002043 13070706737 023316 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var crypto = require('crypto'); var tls = require('tls'); crypto.DEFAULT_ENCODING = 'buffer'; var fs = require('fs'); var certPem = fs.readFileSync(common.fixturesDir + '/test_cert.pem', 'ascii'); var options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }; const server = tls.Server(options, (socket) => { setImmediate(() => { verify(); setImmediate(() => { socket.destroy(); }); }); }); function verify() { crypto.createVerify('RSA-SHA1') .update('Test') .verify(certPem, 'asdfasdfas', 'base64'); } server.listen(0, common.mustCall(() => { tls.connect({ port: server.address().port, rejectUnauthorized: false }, common.mustCall(() => { verify(); })) .on('error', common.fail) .on('close', common.mustCall(() => { server.close(); })).resume(); })); server.unref(); node-v4.8.2/test/parallel/test-crypto.js000644 000766 000024 00000012542 13070706737 020374 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const assert = require('assert'); const crypto = require('crypto'); const fs = require('fs'); const tls = require('tls'); crypto.DEFAULT_ENCODING = 'buffer'; // Test Certificates const caPem = fs.readFileSync(common.fixturesDir + '/test_ca.pem', 'ascii'); const certPem = fs.readFileSync(common.fixturesDir + '/test_cert.pem', 'ascii'); const certPfx = fs.readFileSync(common.fixturesDir + '/test_cert.pfx'); const keyPem = fs.readFileSync(common.fixturesDir + '/test_key.pem', 'ascii'); // 'this' safety // https://github.com/joyent/node/issues/6690 assert.throws(function() { const options = {key: keyPem, cert: certPem, ca: caPem}; const credentials = tls.createSecureContext(options); const context = credentials.context; const notcontext = { setOptions: context.setOptions, setKey: context.setKey }; tls.createSecureContext({ secureOptions: 1 }, notcontext); }, /^TypeError: Illegal invocation$/); // PFX tests assert.doesNotThrow(function() { tls.createSecureContext({pfx: certPfx, passphrase: 'sample'}); }); assert.throws(function() { tls.createSecureContext({pfx: certPfx}); }, /^Error: mac verify failure$/); assert.throws(function() { tls.createSecureContext({pfx: certPfx, passphrase: 'test'}); }, /^Error: mac verify failure$/); assert.throws(function() { tls.createSecureContext({pfx: 'sample', passphrase: 'test'}); }, /^Error: not enough data$/); // update() should only take buffers / strings assert.throws(function() { crypto.createHash('sha1').update({foo: 'bar'}); }, /^TypeError: Not a string or buffer$/); function assertSorted(list) { // Array#sort() modifies the list in place so make a copy. const sorted = list.slice().sort(); assert.deepEqual(list, sorted); } // Assume that we have at least AES-128-CBC. assert.notStrictEqual(0, crypto.getCiphers().length); assert.notStrictEqual(-1, crypto.getCiphers().indexOf('aes-128-cbc')); assert.strictEqual(-1, crypto.getCiphers().indexOf('AES-128-CBC')); assertSorted(crypto.getCiphers()); // Assume that we have at least AES256-SHA. assert.notStrictEqual(0, tls.getCiphers().length); assert.notStrictEqual(-1, tls.getCiphers().indexOf('aes256-sha')); assert.strictEqual(-1, tls.getCiphers().indexOf('AES256-SHA')); assertSorted(tls.getCiphers()); // Assert that we have sha and sha1 but not SHA and SHA1. assert.notStrictEqual(0, crypto.getHashes().length); assert.notStrictEqual(-1, crypto.getHashes().indexOf('sha1')); assert.notStrictEqual(-1, crypto.getHashes().indexOf('sha')); assert.strictEqual(-1, crypto.getHashes().indexOf('SHA1')); assert.strictEqual(-1, crypto.getHashes().indexOf('SHA')); assert.notStrictEqual(-1, crypto.getHashes().indexOf('RSA-SHA1')); assert.strictEqual(-1, crypto.getHashes().indexOf('rsa-sha1')); assertSorted(crypto.getHashes()); // Assume that we have at least secp384r1. assert.notStrictEqual(0, crypto.getCurves().length); assert.notStrictEqual(-1, crypto.getCurves().indexOf('secp384r1')); assert.strictEqual(-1, crypto.getCurves().indexOf('SECP384R1')); assertSorted(crypto.getCurves()); // Regression tests for #5725: hex input that's not a power of two should // throw, not assert in C++ land. assert.throws(function() { crypto.createCipher('aes192', 'test').update('0', 'hex'); }, common.hasFipsCrypto ? /not supported in FIPS mode/ : /Bad input string/); assert.throws(function() { crypto.createDecipher('aes192', 'test').update('0', 'hex'); }, common.hasFipsCrypto ? /not supported in FIPS mode/ : /Bad input string/); assert.throws(function() { crypto.createHash('sha1').update('0', 'hex'); }, /^TypeError: Bad input string$/); assert.throws(function() { crypto.createSign('RSA-SHA1').update('0', 'hex'); }, /^TypeError: Bad input string$/); assert.throws(function() { crypto.createVerify('RSA-SHA1').update('0', 'hex'); }, /^TypeError: Bad input string$/); assert.throws(function() { const priv = [ '-----BEGIN RSA PRIVATE KEY-----', 'MIGrAgEAAiEA+3z+1QNF2/unumadiwEr+C5vfhezsb3hp4jAnCNRpPcCAwEAAQIgQNriSQK4', 'EFwczDhMZp2dvbcz7OUUyt36z3S4usFPHSECEQD/41K7SujrstBfoCPzwC1xAhEA+5kt4BJy', 'eKN7LggbF3Dk5wIQN6SL+fQ5H/+7NgARsVBp0QIRANxYRukavs4QvuyNhMx+vrkCEQCbf6j/', 'Ig6/HueCK/0Jkmp+', '-----END RSA PRIVATE KEY-----', '' ].join('\n'); crypto.createSign('RSA-SHA256').update('test').sign(priv); }, /digest too big for rsa key$/); assert.throws(function() { // The correct header inside `test_bad_rsa_privkey.pem` should have been // -----BEGIN PRIVATE KEY----- and -----END PRIVATE KEY----- // instead of // -----BEGIN RSA PRIVATE KEY----- and -----END RSA PRIVATE KEY----- // It is generated in this way: // $ openssl genrsa -out mykey.pem 512; // $ openssl pkcs8 -topk8 -inform PEM -outform PEM -in mykey.pem \ // -out private_key.pem -nocrypt; // Then open private_key.pem and change its header and footer. const sha1_privateKey = fs.readFileSync(common.fixturesDir + '/test_bad_rsa_privkey.pem', 'ascii'); // this would inject errors onto OpenSSL's error stack crypto.createSign('sha1').sign(sha1_privateKey); }, /asn1 encoding routines:ASN1_CHECK_TLEN:wrong tag/); // Make sure memory isn't released before being returned console.log(crypto.randomBytes(16)); assert.throws(function() { tls.createSecureContext({ crl: 'not a CRL' }); }, /Failed to parse CRL/); node-v4.8.2/test/parallel/test-cwd-enoent-preload.js000644 000766 000024 00000001567 13070706737 022550 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const fs = require('fs'); const spawn = require('child_process').spawn; // Fails with EINVAL on SmartOS, EBUSY on Windows, EBUSY on AIX. if (process.platform === 'sunos' || common.isWindows || common.isAix) { common.skip('cannot rmdir current working directory'); return; } const dirname = common.tmpDir + '/cwd-does-not-exist-' + process.pid; const abspathFile = require('path').join(common.fixturesDir, 'a.js'); common.refreshTmpDir(); fs.mkdirSync(dirname); process.chdir(dirname); fs.rmdirSync(dirname); const proc = spawn(process.execPath, ['-r', abspathFile, '-e', '0']); proc.stdout.pipe(process.stdout); proc.stderr.pipe(process.stderr); proc.once('exit', common.mustCall(function(exitCode, signalCode) { assert.strictEqual(exitCode, 0); assert.strictEqual(signalCode, null); })); node-v4.8.2/test/parallel/test-cwd-enoent-repl.js000644 000766 000024 00000001551 13070706737 022055 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var fs = require('fs'); var spawn = require('child_process').spawn; // Fails with EINVAL on SmartOS, EBUSY on Windows, EBUSY on AIX. if (process.platform === 'sunos' || common.isWindows || common.isAix) { common.skip('cannot rmdir current working directory'); return; } var dirname = common.tmpDir + '/cwd-does-not-exist-' + process.pid; common.refreshTmpDir(); fs.mkdirSync(dirname); process.chdir(dirname); fs.rmdirSync(dirname); var proc = spawn(process.execPath, ['--interactive']); proc.stdout.pipe(process.stdout); proc.stderr.pipe(process.stderr); proc.stdin.write('require("path");\n'); proc.stdin.write('process.exit(42);\n'); proc.once('exit', common.mustCall(function(exitCode, signalCode) { assert.strictEqual(exitCode, 42); assert.strictEqual(signalCode, null); })); node-v4.8.2/test/parallel/test-cwd-enoent.js000644 000766 000024 00000001421 13070706737 021111 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var fs = require('fs'); var spawn = require('child_process').spawn; // Fails with EINVAL on SmartOS, EBUSY on Windows, EBUSY on AIX. if (process.platform === 'sunos' || common.isWindows || common.isAix) { common.skip('cannot rmdir current working directory'); return; } var dirname = common.tmpDir + '/cwd-does-not-exist-' + process.pid; common.refreshTmpDir(); fs.mkdirSync(dirname); process.chdir(dirname); fs.rmdirSync(dirname); var proc = spawn(process.execPath, ['-e', '0']); proc.stdout.pipe(process.stdout); proc.stderr.pipe(process.stderr); proc.once('exit', common.mustCall(function(exitCode, signalCode) { assert.strictEqual(exitCode, 0); assert.strictEqual(signalCode, null); })); node-v4.8.2/test/parallel/test-debug-agent.js000644 000766 000024 00000000457 13070706737 021240 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const debug = require('_debug_agent'); assert.throws( () => { debug.start(); }, function(err) { return (err instanceof assert.AssertionError && err.message === 'Debugger agent running without bindings!'); } ); node-v4.8.2/test/parallel/test-debug-args.js000644 000766 000024 00000000230 13070706737 021063 0ustar00iojsstaff000000 000000 'use strict'; // Flags: --debugger require('../common'); var assert = require('assert'); assert.notEqual(process.execArgv.indexOf('--debugger'), -1); node-v4.8.2/test/parallel/test-debug-brk-no-arg.js000644 000766 000024 00000000572 13070706737 022077 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const spawn = require('child_process').spawn; const child = spawn(process.execPath, ['--debug-brk=' + common.PORT, '-i']); child.stderr.once('data', common.mustCall(function() { child.stdin.end('.exit'); })); child.on('exit', common.mustCall(function(c) { assert.strictEqual(c, 0); })); node-v4.8.2/test/parallel/test-debug-brk.js000644 000766 000024 00000000474 13070706737 020717 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const spawnSync = require('child_process').spawnSync; const args = [`--debug-brk=${common.PORT}`, '-e', '0']; const proc = spawnSync(process.execPath, args, {encoding: 'utf8'}); assert(/Debugger listening on/.test(proc.stderr)); node-v4.8.2/test/parallel/test-debug-no-context.js000644 000766 000024 00000001554 13070706737 022237 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const spawn = require('child_process').spawn; const args = ['--debug', `--debug-port=${common.PORT}`, '--interactive']; const proc = spawn(process.execPath, args); proc.stdin.write(` util.inspect(Promise.resolve(42)); util.inspect(Promise.resolve(1337)); .exit `); proc.on('exit', common.mustCall((exitCode, signalCode) => { // This next line should be included but unfortunately Win10 fails from time // to time in CI. See https://github.com/nodejs/node/issues/5268 // assert.strictEqual(exitCode, 0); assert.strictEqual(signalCode, null); })); let stdout = ''; proc.stdout.setEncoding('utf8'); proc.stdout.on('data', (data) => stdout += data); process.on('exit', () => { assert(stdout.includes('Promise { 42 }')); assert(stdout.includes('Promise { 1337 }')); }); node-v4.8.2/test/parallel/test-debug-port-cluster.js000644 000766 000024 00000001543 13070706737 022602 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const spawn = require('child_process').spawn; const PORT_MIN = common.PORT + 1; // The fixture uses common.PORT. const PORT_MAX = PORT_MIN + 2; const args = [ '--debug=' + PORT_MIN, common.fixturesDir + '/clustered-server/app.js' ]; const child = spawn(process.execPath, args); child.stderr.setEncoding('utf8'); const checkMessages = common.mustCall(() => { for (let port = PORT_MIN; port <= PORT_MAX; port += 1) { const re = RegExp(`Debugger listening on (\\[::\\]|0\\.0\\.0\\.0):${port}`); assert(re.test(stderr)); } }); let stderr = ''; child.stderr.on('data', (data) => { process.stderr.write(`[DATA] ${data}`); stderr += data; if (child.killed !== true && stderr.includes('all workers are running')) { child.kill(); checkMessages(); } }); node-v4.8.2/test/parallel/test-debug-port-from-cmdline.js000644 000766 000024 00000002372 13070706737 023476 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var spawn = require('child_process').spawn; var debugPort = common.PORT; var args = ['--interactive', '--debug-port=' + debugPort]; var childOptions = { stdio: ['pipe', 'pipe', 'pipe', 'ipc'] }; var child = spawn(process.execPath, args, childOptions); child.stdin.write("process.send({ msg: 'childready' });\n"); child.stderr.on('data', function(data) { var lines = data.toString().replace(/\r/g, '').trim().split('\n'); lines.forEach(processStderrLine); }); child.on('message', function onChildMsg(message) { if (message.msg === 'childready') { process._debugProcess(child.pid); } }); process.on('exit', function() { child.kill(); assertOutputLines(); }); var outputLines = []; function processStderrLine(line) { console.log('> ' + line); outputLines.push(line); if (/Debugger listening/.test(line)) { process.exit(); } } function assertOutputLines() { var expectedLines = [ 'Starting debugger agent.', 'Debugger listening on (\\[::\\]|0\\.0\\.0\\.0):' + debugPort, ]; assert.strictEqual(outputLines.length, expectedLines.length); for (var i = 0; i < expectedLines.length; i++) assert(RegExp(expectedLines[i]).test(outputLines[i])); } node-v4.8.2/test/parallel/test-debug-port-numbers.js000644 000766 000024 00000003661 13070706737 022577 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const path = require('path'); const spawn = require('child_process').spawn; // FIXME(bnoordhuis) On UNIX platforms, the debugger doesn't reliably kill // the inferior when killed by a signal. Work around that by spawning // the debugger in its own process group and killing the process group // instead of just the debugger process. const detached = !common.isWindows; const children = []; for (let i = 0; i < 4; i += 1) { const port = common.PORT + i; const args = [`--debug-port=${port}`, '--interactive', 'debug', __filename]; const child = spawn(process.execPath, args, { detached, stdio: 'pipe' }); child.test = { port: port, stdout: '' }; child.stdout.setEncoding('utf8'); child.stdout.on('data', function(s) { child.test.stdout += s; update(); }); child.stdout.pipe(process.stdout); child.stderr.pipe(process.stderr); children.push(child); } function update() { // Debugger prints relative paths except on Windows. const filename = path.basename(__filename); let ready = 0; for (const child of children) ready += RegExp(`break in .*?${filename}:1`).test(child.test.stdout); if (ready === children.length) for (const child of children) kill(child); } function kill(child) { if (!detached) return child.kill(); try { process.kill(-child.pid); // Kill process group. } catch (e) { // Generally ESRCH is returned when the process group is already gone. On // some platforms such as OS X it may be EPERM though. assert.ok((e.code === 'EPERM') || (e.code === 'ESRCH')); } } process.on('exit', function() { for (const child of children) { const port = child.test.port; const one = RegExp(`Debugger listening on (\\[::\\]|0\.0\.0\.0):${port}`); const two = RegExp(`connecting to 127.0.0.1:${port}`); assert(one.test(child.test.stdout)); assert(two.test(child.test.stdout)); } }); node-v4.8.2/test/parallel/test-debug-prompt.js000644 000766 000024 00000000517 13070706737 021460 0ustar00iojsstaff000000 000000 'use strict'; const assert = require('assert'); const common = require('../common'); const spawn = require('child_process').spawn; const proc = spawn(process.execPath, ['debug', 'foo']); proc.stdout.setEncoding('utf8'); proc.stdout.once('data', common.mustCall((data) => { assert.strictEqual(data, 'debug> '); proc.kill(); })); node-v4.8.2/test/parallel/test-debug-protocol-execute.js000644 000766 000024 00000000725 13070706737 023441 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const debug = require('_debugger'); const protocol = new debug.Protocol(); assert.strictEqual(protocol.state, 'headers'); protocol.execute('Content-Length: 10\r\n\r\nfhqwhgads'); assert.strictEqual(protocol.state, 'body'); assert.strictEqual(protocol.res.body, undefined); protocol.state = 'sterrance'; assert.throws( () => { protocol.execute('grumblecakes'); }, /^Error: Unknown state$/ ); node-v4.8.2/test/parallel/test-debug-signal-cluster.js000644 000766 000024 00000004237 13070706737 023076 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const spawn = require('child_process').spawn; const path = require('path'); const port = common.PORT; const serverPath = path.join(common.fixturesDir, 'clustered-server', 'app.js'); const args = [`--debug-port=${port}`, serverPath]; const options = { stdio: ['inherit', 'inherit', 'pipe', 'ipc'] }; const child = spawn(process.execPath, args, options); const outputLines = []; var waitingForDebuggers = false; var pids; child.stderr.on('data', function(data) { const lines = data.toString().replace(/\r/g, '').trim().split('\n'); lines.forEach(function(line) { console.log('> ' + line); if (line === 'all workers are running') { child.on('message', function(msg) { if (msg.type !== 'pids') return; pids = msg.pids; console.error('got pids %j', pids); waitingForDebuggers = true; process._debugProcess(child.pid); }); child.send({ type: 'getpids' }); } else if (waitingForDebuggers) { outputLines.push(line); } }); if (outputLines.length === expectedLines.length) onNoMoreLines(); }); function onNoMoreLines() { assertOutputLines(); process.exit(); } process.on('exit', function onExit() { // Kill processes in reverse order to avoid timing problems on Windows where // the parent process is killed before the children. pids.reverse().forEach(function(pid) { process.kill(pid); }); }); const expectedLines = [ 'Starting debugger agent.', 'Debugger listening on (\\[::\\]|0\\.0\\.0\\.0):' + (port + 0), 'Starting debugger agent.', 'Debugger listening on (\\[::\\]|0\\.0\\.0\\.0):' + (port + 1), 'Starting debugger agent.', 'Debugger listening on (\\[::\\]|0\\.0\\.0\\.0):' + (port + 2), ]; function assertOutputLines() { // Do not assume any particular order of output messages, // since workers can take different amout of time to // start up outputLines.sort(); expectedLines.sort(); assert.equal(outputLines.length, expectedLines.length); for (var i = 0; i < expectedLines.length; i++) assert(RegExp(expectedLines[i]).test(outputLines[i])); } node-v4.8.2/test/parallel/test-debug-uncaught-exception.js000644 000766 000024 00000001122 13070706737 023742 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const path = require('path'); const spawnSync = require('child_process').spawnSync; const emitUncaught = path.join(common.fixturesDir, 'debug-uncaught.js'); const result = spawnSync(process.execPath, [emitUncaught], {encoding: 'utf8'}); const expectedMessage = "There was an internal error in Node's debugger. Please report this bug."; assert.strictEqual(result.status, 1); assert(result.stderr.includes(expectedMessage)); assert(result.stderr.includes('Error: sterrance')); console.log(result.stdout); node-v4.8.2/test/parallel/test-debug-usage.js000644 000766 000024 00000001133 13070706737 021236 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const spawn = require('child_process').spawn; const child = spawn(process.execPath, ['debug']); child.stderr.setEncoding('utf8'); const expectedUsageMessage = `Usage: node debug script.js node debug : node debug -p `; var actualUsageMessage = ''; child.stderr.on('data', function(data) { actualUsageMessage += data.toString(); }); child.on('exit', common.mustCall(function(code) { assert.strictEqual(code, 1); assert.strictEqual(actualUsageMessage, expectedUsageMessage); })); node-v4.8.2/test/parallel/test-debugger-client-addhandle.js000644 000766 000024 00000002077 13070706737 024020 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const Client = require('_debugger').Client; { const client = new Client(); assert.deepStrictEqual(client.handles, {}); } { const client = new Client(); client._addHandle(null); assert.deepStrictEqual(client.handles, {}); } { const client = new Client(); client._addHandle('not an object'); assert.deepStrictEqual(client.handles, {}); } { const client = new Client(); client._addHandle({ handle: 'not a number' }); assert.deepStrictEqual(client.handles, {}); } { const client = new Client(); const validNoScript = { handle: 6, id: 'foo', type: 'not a script' }; client._addHandle(validNoScript); assert.deepStrictEqual(client.handles, { 6: validNoScript }); assert.deepStrictEqual(client.scripts, {}); } { const client = new Client(); const validWithScript = { handle: 5, id: 'bar', type: 'script' }; client._addHandle(validWithScript); assert.deepStrictEqual(client.handles, { 5: validWithScript }); assert.deepStrictEqual(client.scripts, { bar: validWithScript }); } node-v4.8.2/test/parallel/test-debugger-util-regression.js000644 000766 000024 00000002673 13070706737 023775 0ustar00iojsstaff000000 000000 'use strict'; const path = require('path'); const spawn = require('child_process').spawn; const assert = require('assert'); const common = require('../common'); const fixture = path.join( common.fixturesDir, 'debugger-util-regression-fixture.js' ); const args = [ 'debug', fixture ]; const proc = spawn(process.execPath, args, { stdio: 'pipe' }); proc.stdout.setEncoding('utf8'); proc.stderr.setEncoding('utf8'); let stdout = ''; let stderr = ''; let nextCount = 0; let exit = false; proc.stdout.on('data', (data) => { stdout += data; if (stdout.includes('> 1') && nextCount < 1 || stdout.includes('> 2') && nextCount < 2 || stdout.includes('> 3') && nextCount < 3 || stdout.includes('> 4') && nextCount < 4) { nextCount++; proc.stdin.write('n\n'); } else if (!exit && (stdout.includes('< { a: \'b\' }'))) { exit = true; proc.stdin.write('.exit\n'); } else if (stdout.includes('program terminated')) { // Catch edge case present in v4.x // process will terminate after call to util.inspect common.fail('the program should not terminate'); } }); proc.stderr.on('data', (data) => stderr += data); process.on('exit', (code) => { assert.strictEqual(code, 0, 'the program should exit cleanly'); assert.strictEqual(stdout.includes('{ a: \'b\' }'), true, 'the debugger should print the result of util.inspect'); assert.strictEqual(stderr, '', 'stderr should be empty'); }); node-v4.8.2/test/parallel/test-delayed-require.js000644 000766 000024 00000000502 13070706737 022126 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var path = require('path'); var assert = require('assert'); setTimeout(common.mustCall(function() { const a = require(path.join(common.fixturesDir, 'a')); assert.strictEqual(true, 'A' in a); assert.strictEqual('A', a.A()); assert.strictEqual('D', a.D()); }), 50); node-v4.8.2/test/parallel/test-dgram-address.js000644 000766 000024 00000002535 13070706737 021572 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var dgram = require('dgram'); // IPv4 Test var socket_ipv4 = dgram.createSocket('udp4'); var family_ipv4 = 'IPv4'; socket_ipv4.on('listening', function() { var address_ipv4 = socket_ipv4.address(); assert.strictEqual(address_ipv4.address, common.localhostIPv4); assert.strictEqual(typeof address_ipv4.port, 'number'); assert.ok(isFinite(address_ipv4.port)); assert.ok(address_ipv4.port > 0); assert.strictEqual(address_ipv4.family, family_ipv4); socket_ipv4.close(); }); socket_ipv4.on('error', function(e) { console.log('Error on udp4 socket. ' + e.toString()); socket_ipv4.close(); }); socket_ipv4.bind(0, common.localhostIPv4); // IPv6 Test var localhost_ipv6 = '::1'; var socket_ipv6 = dgram.createSocket('udp6'); var family_ipv6 = 'IPv6'; socket_ipv6.on('listening', function() { var address_ipv6 = socket_ipv6.address(); assert.strictEqual(address_ipv6.address, localhost_ipv6); assert.strictEqual(typeof address_ipv6.port, 'number'); assert.ok(isFinite(address_ipv6.port)); assert.ok(address_ipv6.port > 0); assert.strictEqual(address_ipv6.family, family_ipv6); socket_ipv6.close(); }); socket_ipv6.on('error', function(e) { console.log('Error on udp6 socket. ' + e.toString()); socket_ipv6.close(); }); socket_ipv6.bind(0, localhost_ipv6); node-v4.8.2/test/parallel/test-dgram-bind-default-address.js000755 000766 000024 00000001767 13070706737 024137 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const dgram = require('dgram'); // skip test in FreeBSD jails since 0.0.0.0 will resolve to default interface if (common.inFreeBSDJail) { common.skip('In a FreeBSD jail'); return; } dgram.createSocket('udp4').bind(0, common.mustCall(function() { assert.strictEqual(typeof this.address().port, 'number'); assert.ok(isFinite(this.address().port)); assert.ok(this.address().port > 0); assert.strictEqual(this.address().address, '0.0.0.0'); this.close(); })); if (!common.hasIPv6) { common.skip('udp6 part of test, because no IPv6 support'); return; } dgram.createSocket('udp6').bind(0, common.mustCall(function() { assert.strictEqual(typeof this.address().port, 'number'); assert.ok(isFinite(this.address().port)); assert.ok(this.address().port > 0); let address = this.address().address; if (address === '::ffff:0.0.0.0') address = '::'; assert.strictEqual(address, '::'); this.close(); })); node-v4.8.2/test/parallel/test-dgram-bind-shared-ports.js000644 000766 000024 00000002437 13070706737 023473 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var cluster = require('cluster'); var dgram = require('dgram'); function noop() {} if (cluster.isMaster) { var worker1 = cluster.fork(); if (common.isWindows) { var checkErrType = function(er) { assert.equal(er.code, 'ENOTSUP'); worker1.kill(); }; worker1.on('error', common.mustCall(checkErrType, 1)); return; } worker1.on('message', function(msg) { assert.equal(msg, 'success'); var worker2 = cluster.fork(); worker2.on('message', function(msg) { assert.equal(msg, 'socket2:EADDRINUSE'); worker1.kill(); worker2.kill(); }); }); } else { var socket1 = dgram.createSocket('udp4', noop); var socket2 = dgram.createSocket('udp4', noop); socket1.on('error', function(err) { // no errors expected process.send('socket1:' + err.code); }); socket2.on('error', function(err) { // an error is expected on the second worker process.send('socket2:' + err.code); }); socket1.bind({ address: 'localhost', port: common.PORT, exclusive: false }, function() { socket2.bind({port: common.PORT + 1, exclusive: true}, function() { // the first worker should succeed process.send('success'); }); }); } node-v4.8.2/test/parallel/test-dgram-bind.js000644 000766 000024 00000000661 13070706737 021057 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const dgram = require('dgram'); var socket = dgram.createSocket('udp4'); socket.on('listening', common.mustCall(() => { assert.throws(() => { socket.bind(); }, /^Error: Socket is already bound$/); socket.close(); })); var result = socket.bind(); // should not throw assert.strictEqual(result, socket); // should have returned itself node-v4.8.2/test/parallel/test-dgram-bytes-length.js000644 000766 000024 00000000536 13070706737 022551 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var dgram = require('dgram'); var message = new Buffer('Some bytes'); var client = dgram.createSocket('udp4'); client.send( message, 0, message.length, 41234, 'localhost', function(err, bytes) { assert.strictEqual(bytes, message.length); client.close(); } ); node-v4.8.2/test/parallel/test-dgram-close-in-listening.js000644 000766 000024 00000000714 13070706737 023645 0ustar00iojsstaff000000 000000 'use strict'; // Ensure that if a dgram socket is closed before the sendQueue is drained // will not crash const common = require('../common'); const dgram = require('dgram'); const buf = Buffer.alloc(1024, 42); const socket = dgram.createSocket('udp4'); socket.on('listening', function() { socket.close(); }); // adds a listener to 'listening' to send the data when // the socket is available socket.send(buf, 0, buf.length, common.PORT, 'localhost'); node-v4.8.2/test/parallel/test-dgram-close-is-not-callback.js000644 000766 000024 00000000557 13070706737 024215 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var dgram = require('dgram'); var buf = new Buffer(1024); buf.fill(42); var socket = dgram.createSocket('udp4'); socket.send(buf, 0, buf.length, common.PORT, 'localhost'); // if close callback is not function, ignore the argument. socket.close('bad argument'); socket.on('close', common.mustCall(function() {})); node-v4.8.2/test/parallel/test-dgram-close.js000644 000766 000024 00000001273 13070706737 021250 0ustar00iojsstaff000000 000000 'use strict'; // Ensure that if a dgram socket is closed before the DNS lookup completes, it // won't crash. const common = require('../common'); const assert = require('assert'); const dgram = require('dgram'); var buf = new Buffer(1024); buf.fill(42); var socket = dgram.createSocket('udp4'); var handle = socket._handle; socket.send(buf, 0, buf.length, common.PORT, 'localhost'); assert.strictEqual(socket.close(common.mustCall(function() {})), socket); socket.on('close', common.mustCall(function() {})); socket = null; // Verify that accessing handle after closure doesn't throw setImmediate(function() { setImmediate(function() { console.log('Handle fd is: ', handle.fd); }); }); node-v4.8.2/test/parallel/test-dgram-create-socket-handle.js000644 000766 000024 00000001753 13070706737 024130 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const dgram = require('dgram'); const UDP = process.binding('udp_wrap').UDP; const _createSocketHandle = dgram._createSocketHandle; // Throws if an "existing fd" is passed in. assert.throws(() => { _createSocketHandle(common.localhostIPv4, 0, 'udp4', 42); }, /^AssertionError: false == true$/); { // Create a handle that is not bound. const handle = _createSocketHandle(null, null, 'udp4'); assert(handle instanceof UDP); assert.strictEqual(typeof handle.fd, 'number'); assert(handle.fd < 0); } { // Create a bound handle. const handle = _createSocketHandle(common.localhostIPv4, 0, 'udp4'); assert(handle instanceof UDP); assert.strictEqual(typeof handle.fd, 'number'); if (!common.isWindows) assert(handle.fd > 0); } { // Return an error if binding fails. const err = _createSocketHandle('localhost', 0, 'udp4'); assert.strictEqual(typeof err, 'number'); assert(err < 0); } node-v4.8.2/test/parallel/test-dgram-empty-packet.js000644 000766 000024 00000001445 13070706737 022547 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var dgram = require('dgram'); var callbacks = 0; var client; var timer; if (process.platform === 'darwin') { common.skip('because of 17894467 Apple bug'); return; } client = dgram.createSocket('udp4'); client.bind(0, function() { function callback() { callbacks++; if (callbacks == 2) { clearTimeout(timer); client.close(); } else if (callbacks > 2) { throw new Error('the callbacks should be called only two times'); } } client.on('message', function(buffer, bytes) { callback(); }); const port = this.address().port; client.send(new Buffer(1), 0, 0, port, '127.0.0.1', function(err, len) { callback(); }); timer = setTimeout(function() { throw new Error('Timeout'); }, 200); }); node-v4.8.2/test/parallel/test-dgram-error-message-address.js000644 000766 000024 00000002116 13070706737 024336 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const dgram = require('dgram'); // IPv4 Test const socket_ipv4 = dgram.createSocket('udp4'); socket_ipv4.on('listening', common.fail); socket_ipv4.on('error', common.mustCall(function(e) { assert.strictEqual(e.port, undefined); assert.strictEqual(e.message, 'bind EADDRNOTAVAIL 1.1.1.1'); assert.strictEqual(e.address, '1.1.1.1'); assert.strictEqual(e.code, 'EADDRNOTAVAIL'); socket_ipv4.close(); })); socket_ipv4.bind(0, '1.1.1.1'); // IPv6 Test const socket_ipv6 = dgram.createSocket('udp6'); socket_ipv6.on('listening', common.fail); socket_ipv6.on('error', common.mustCall(function(e) { // EAFNOSUPPORT or EPROTONOSUPPORT means IPv6 is disabled on this system. const allowed = ['EADDRNOTAVAIL', 'EAFNOSUPPORT', 'EPROTONOSUPPORT']; assert.notStrictEqual(allowed.indexOf(e.code), -1); assert.strictEqual(e.port, undefined); assert.strictEqual(e.message, 'bind ' + e.code + ' 111::1'); assert.strictEqual(e.address, '111::1'); socket_ipv6.close(); })); socket_ipv6.bind(0, '111::1'); node-v4.8.2/test/parallel/test-dgram-exclusive-implicit-bind.js000644 000766 000024 00000006435 13070706737 024701 0ustar00iojsstaff000000 000000 'use strict'; // Copyright Joyent, Inc. and other Node contributors. // // Permission is hereby granted, free of charge, to any person obtaining a // copy of this software and associated documentation files (the // "Software"), to deal in the Software without restriction, including // without limitation the rights to use, copy, modify, merge, publish, // distribute, sublicense, and/or sell copies of the Software, and to permit // persons to whom the Software is furnished to do so, subject to the // following conditions: // // The above copyright notice and this permission notice shall be included // in all copies or substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN // NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, // DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR // OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE // USE OR OTHER DEALINGS IN THE SOFTWARE. var common = require('../common'); var assert = require('assert'); var cluster = require('cluster'); var dgram = require('dgram'); // Without an explicit bind, send() causes an implicit bind, which always // generate a unique per-socket ephemeral port. An explicit bind to a port // number causes all sockets bound to that number to share a port. // // The 2 workers that call bind() will share a port, the two workers that do // not will not share a port, so master will see 3 unique source ports. // Note that on Windows, clustered dgram is not supported. Since explicit // binding causes the dgram to be clustered, don't fork the workers that bind. // This is a useful test, still, because it demonstrates that by avoiding // clustering, client (ephemeral, implicitly bound) dgram sockets become // supported while using cluster, though servers still cause the master to error // with ENOTSUP. if (cluster.isMaster) { var pass; var messages = 0; var ports = {}; process.on('exit', function() { assert.strictEqual(pass, true); }); var target = dgram.createSocket('udp4'); target.on('message', function(buf, rinfo) { messages++; ports[rinfo.port] = true; if (common.isWindows && messages === 2) { assert.strictEqual(Object.keys(ports).length, 2); done(); } if (!common.isWindows && messages === 4) { assert.strictEqual(Object.keys(ports).length, 3); done(); } function done() { pass = true; cluster.disconnect(); target.close(); } }); target.on('listening', function() { cluster.fork(); cluster.fork(); if (!common.isWindows) { cluster.fork({BOUND: 'y'}); cluster.fork({BOUND: 'y'}); } }); target.bind({port: common.PORT, exclusive: true}); return; } var source = dgram.createSocket('udp4'); if (process.env.BOUND === 'y') { source.bind(0); } else { // cluster doesn't know about exclusive sockets, so it won't close them. This // is expected, its the same situation for timers, outgoing tcp connections, // etc, which also keep workers alive after disconnect was requested. source.unref(); } source.send(Buffer('abc'), 0, 3, common.PORT, '127.0.0.1'); node-v4.8.2/test/parallel/test-dgram-implicit-bind.js000644 000766 000024 00000001224 13070706737 022663 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var dgram = require('dgram'); var source = dgram.createSocket('udp4'); var target = dgram.createSocket('udp4'); var messages = 0; target.on('message', common.mustCall(function(buf) { if (buf.toString() === 'abc') ++messages; if (buf.toString() === 'def') ++messages; if (messages === 2) { source.close(); target.close(); } }, 2)); target.on('listening', function() { // Second .send() call should not throw a bind error. const port = this.address().port; source.send(Buffer('abc'), 0, 3, port, '127.0.0.1'); source.send(Buffer('def'), 0, 3, port, '127.0.0.1'); }); target.bind(0); node-v4.8.2/test/parallel/test-dgram-listen-after-bind.js000644 000766 000024 00000000653 13070706737 023453 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var dgram = require('dgram'); var socket = dgram.createSocket('udp4'); socket.bind(); var fired = false; var timer = setTimeout(function() { socket.close(); }, 100); socket.on('listening', function() { clearTimeout(timer); fired = true; socket.close(); }); socket.on('close', function() { assert(fired, 'listening should fire after bind'); }); node-v4.8.2/test/parallel/test-dgram-membership.js000644 000766 000024 00000004362 13070706737 022300 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const dgram = require('dgram'); const multicastAddress = '224.0.0.114'; const setup = dgram.createSocket.bind(dgram, {type: 'udp4', reuseAddr: true}); // addMembership() on closed socket should throw { const socket = setup(); socket.close(common.mustCall(() => { assert.throws(() => { socket.addMembership(multicastAddress); }, /^Error: Not running$/); })); } // dropMembership() on closed socket should throw { const socket = setup(); socket.close(common.mustCall(() => { assert.throws(() => { socket.dropMembership(multicastAddress); }, /^Error: Not running$/); })); } // addMembership() with no argument should throw { const socket = setup(); assert.throws(() => { socket.addMembership(); }, /^Error: multicast address must be specified$/); socket.close(); } // dropMembership() with no argument should throw { const socket = setup(); assert.throws(() => { socket.dropMembership(); }, /^Error: multicast address must be specified$/); socket.close(); } // addMembership() with invalid multicast address should throw { const socket = setup(); assert.throws(() => { socket.addMembership('256.256.256.256'); }, /^Error: addMembership EINVAL$/); socket.close(); } // dropMembership() with invalid multicast address should throw { const socket = setup(); assert.throws(() => { socket.dropMembership('256.256.256.256'); }, /^Error: dropMembership EINVAL$/); socket.close(); } // addMembership() with valid socket and multicast address should not throw { const socket = setup(); assert.doesNotThrow(() => { socket.addMembership(multicastAddress); }); socket.close(); } // dropMembership() without previous addMembership should throw { const socket = setup(); assert.throws( () => { socket.dropMembership(multicastAddress); }, /^Error: dropMembership EADDRNOTAVAIL$/ ); socket.close(); } // dropMembership() after addMembership() should not throw { const socket = setup(); assert.doesNotThrow( () => { socket.addMembership(multicastAddress); socket.dropMembership(multicastAddress); } ); socket.close(); } node-v4.8.2/test/parallel/test-dgram-msgsize.js000644 000766 000024 00000001217 13070706737 021622 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const dgram = require('dgram'); // Send a too big datagram. The destination doesn't matter because it's // not supposed to get sent out anyway. const buf = Buffer.allocUnsafe(256 * 1024); const sock = dgram.createSocket('udp4'); sock.send(buf, 0, buf.length, 12345, '127.0.0.1', common.mustCall(cb)); function cb(err) { assert(err instanceof Error); assert.strictEqual(err.code, 'EMSGSIZE'); assert.strictEqual(err.address, '127.0.0.1'); assert.strictEqual(err.port, 12345); assert.strictEqual(err.message, 'send EMSGSIZE 127.0.0.1:12345'); sock.close(); } node-v4.8.2/test/parallel/test-dgram-multicast-loopback.js000644 000766 000024 00000001033 13070706737 023732 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const dgram = require('dgram'); { const socket = dgram.createSocket('udp4'); assert.throws(() => { socket.setMulticastLoopback(16); }, /^Error: setMulticastLoopback EBADF$/); } { const socket = dgram.createSocket('udp4'); socket.bind(0); socket.on('listening', common.mustCall(() => { assert.strictEqual(socket.setMulticastLoopback(16), 16); assert.strictEqual(socket.setMulticastLoopback(0), 0); socket.close(); })); } node-v4.8.2/test/parallel/test-dgram-multicast-setTTL.js000644 000766 000024 00000001147 13070706737 023325 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const dgram = require('dgram'); const socket = dgram.createSocket('udp4'); socket.bind(0); socket.on('listening', common.mustCall(() => { const result = socket.setMulticastTTL(16); assert.strictEqual(result, 16); //Try to set an invalid TTL (valid ttl is > 0 and < 256) assert.throws(() => { socket.setMulticastTTL(1000); }, /^Error: setMulticastTTL EINVAL$/); assert.throws(() => { socket.setMulticastTTL('foo'); }, /^TypeError: Argument must be a number$/); //close the socket socket.close(); })); node-v4.8.2/test/parallel/test-dgram-oob-buffer.js000644 000766 000024 00000002565 13070706737 022176 0ustar00iojsstaff000000 000000 'use strict'; // Some operating systems report errors when an UDP message is sent to an // unreachable host. This error can be reported by sendto() and even by // recvfrom(). Node should not propagate this error to the user. var common = require('../common'); var assert = require('assert'); var dgram = require('dgram'); var socket = dgram.createSocket('udp4'); var buf = Buffer([1, 2, 3, 4]); function ok() {} socket.send(buf, 0, 0, common.PORT, '127.0.0.1', ok); // useful? no socket.send(buf, 0, 4, common.PORT, '127.0.0.1', ok); socket.send(buf, 1, 3, common.PORT, '127.0.0.1', ok); socket.send(buf, 3, 1, common.PORT, '127.0.0.1', ok); // Since length of zero means nothing, don't error despite OOB. socket.send(buf, 4, 0, common.PORT, '127.0.0.1', ok); assert.throws(function() { socket.send(buf, 0, 5, common.PORT, '127.0.0.1', common.fail); }); assert.throws(function() { socket.send(buf, 2, 3, common.PORT, '127.0.0.1', common.fail); }); assert.throws(function() { socket.send(buf, 4, 4, common.PORT, '127.0.0.1', common.fail); }); assert.throws(function() { socket.send('abc', 4, 1, common.PORT, '127.0.0.1', common.fail); }); assert.throws(function() { socket.send('abc', 0, 4, common.PORT, '127.0.0.1', common.fail); }); assert.throws(function() { socket.send('abc', -1, 2, common.PORT, '127.0.0.1', common.fail); }); socket.close(); // FIXME should not be necessary node-v4.8.2/test/parallel/test-dgram-ref.js000644 000766 000024 00000000231 13070706737 020710 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var dgram = require('dgram'); // should not hang, see #1282 dgram.createSocket('udp4'); dgram.createSocket('udp6'); node-v4.8.2/test/parallel/test-dgram-regress-4496.js000644 000766 000024 00000000614 13070706737 022217 0ustar00iojsstaff000000 000000 'use strict'; // Remove this test once we support sending strings. require('../common'); var assert = require('assert'); var dgram = require('dgram'); // Should throw but not crash. var socket = dgram.createSocket('udp4'); assert.throws(function() { socket.send(true, 0, 1, 1, 'host'); }, TypeError); assert.throws(function() { socket.sendto(5, 0, 1, 1, 'host'); }, TypeError); socket.close(); node-v4.8.2/test/parallel/test-dgram-send-bad-arguments.js000644 000766 000024 00000001500 13070706737 023614 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var dgram = require('dgram'); var buf = Buffer('test'); var host = '127.0.0.1'; var sock = dgram.createSocket('udp4'); assert.throws(function() { sock.send(); }, TypeError); // First argument should be a buffer. assert.throws(function() { sock.send(buf, -1, 1, 1, host); }, RangeError); assert.throws(function() { sock.send(buf, 1, -1, 1, host); }, RangeError); assert.throws(function() { sock.send(buf, 1, 1, -1, host); }, RangeError); assert.throws(function() { sock.send(buf, 5, 1, 1, host); }, RangeError); assert.throws(function() { sock.send(buf, 1, 5, 1, host); }, RangeError); assert.throws(function() { sock.send(buf, 1, 1, 0, host); }, RangeError); assert.throws(function() { sock.send(buf, 1, 1, 65536, host); }, RangeError); node-v4.8.2/test/parallel/test-dgram-send-callback-buffer-length.js000644 000766 000024 00000001025 13070706737 025347 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var dgram = require('dgram'); var client, timer, buf, len, offset; client = dgram.createSocket('udp4'); buf = new Buffer(256); offset = 20; len = buf.length - offset; client.send(buf, offset, len, common.PORT, '127.0.0.1', function(err, bytes) { assert.notEqual(bytes, buf.length); assert.equal(bytes, buf.length - offset); clearTimeout(timer); client.close(); }); timer = setTimeout(function() { throw new Error('Timeout'); }, 200); node-v4.8.2/test/parallel/test-dgram-send-callback-recursive.js000644 000766 000024 00000001476 13070706737 024640 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const dgram = require('dgram'); const client = dgram.createSocket('udp4'); const chunk = 'abc'; let received = 0; let sent = 0; const limit = 10; let async = false; let port; function onsend() { if (sent++ < limit) { client.send(chunk, 0, chunk.length, port, common.localhostIPv4, onsend); } else { assert.strictEqual(async, true, 'Send should be asynchronous.'); } } client.on('listening', function() { port = this.address().port; setImmediate(function() { async = true; }); onsend(); }); client.on('message', function(buf, info) { received++; if (received === limit) { client.close(); } }); client.on('close', common.mustCall(function() { assert.strictEqual(received, limit); })); client.bind(0); node-v4.8.2/test/parallel/test-dgram-send-empty-buffer.js000644 000766 000024 00000001165 13070706737 023477 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const dgram = require('dgram'); if (process.platform === 'darwin') { common.skip('because of 17894467 Apple bug'); return; } const client = dgram.createSocket('udp4'); client.bind(0, function() { const port = this.address().port; client.on('message', common.mustCall(function onMessage(buffer, bytes) { clearTimeout(timer); client.close(); })); const buf = new Buffer(0); client.send(buf, 0, 0, port, '127.0.0.1', function(err, len) { }); const timer = setTimeout(function() { throw new Error('Timeout'); }, common.platformTimeout(200)); }); node-v4.8.2/test/parallel/test-dgram-setTTL.js000644 000766 000024 00000001037 13070706737 021320 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const dgram = require('dgram'); const socket = dgram.createSocket('udp4'); socket.bind(0); socket.on('listening', common.mustCall(() => { const result = socket.setTTL(16); assert.strictEqual(result, 16); assert.throws(() => { socket.setTTL('foo'); }, /^TypeError: Argument must be a number$/); // TTL must be a number from > 0 to < 256 assert.throws(() => { socket.setTTL(1000); }, /^Error: setTTL EINVAL$/); socket.close(); })); node-v4.8.2/test/parallel/test-dgram-udp4.js000644 000766 000024 00000002125 13070706737 021014 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const dgram = require('dgram'); const message_to_send = 'A message to send'; const server = dgram.createSocket('udp4'); server.on('message', common.mustCall((msg, rinfo) => { assert.strictEqual(rinfo.address, common.localhostIPv4); assert.strictEqual(msg.toString(), message_to_send.toString()); server.send(msg, 0, msg.length, rinfo.port, rinfo.address); })); server.on('listening', common.mustCall(() => { const client = dgram.createSocket('udp4'); const port = server.address().port; client.on('message', common.mustCall((msg, rinfo) => { assert.strictEqual(rinfo.address, common.localhostIPv4); assert.strictEqual(rinfo.port, port); assert.strictEqual(msg.toString(), message_to_send.toString()); client.close(); server.close(); })); client.send(message_to_send, 0, message_to_send.length, port, 'localhost'); client.on('close', common.mustCall(() => {})); })); server.on('close', common.mustCall(() => {})); server.bind(0); node-v4.8.2/test/parallel/test-dgram-unref.js000644 000766 000024 00000000263 13070706737 021260 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var dgram = require('dgram'); var s = dgram.createSocket('udp4'); s.bind(); s.unref(); setTimeout(common.fail, 1000).unref(); node-v4.8.2/test/parallel/test-dh-padding.js000644 000766 000024 00000007544 13070706737 021061 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); try { var crypto = require('crypto'); } catch (e) { common.skip('node compiled without OpenSSL.'); return; } /* This test verifies padding with leading zeroes for shared * secrets that are strictly smaller than the modulus (prime). * See: * RFC 4346: https://www.ietf.org/rfc/rfc4346.txt * https://github.com/nodejs/node-v0.x-archive/issues/7906 * https://github.com/nodejs/node-v0.x-archive/issues/5239 * * In FIPS mode OPENSSL_DH_FIPS_MIN_MODULUS_BITS = 1024, meaning we need * a FIPS-friendly >= 1024 bit prime, we can use MODP 14 from RFC 3526: * https://www.ietf.org/rfc/rfc3526.txt * * We can generate appropriate values with this code: * * crypto = require('crypto'); * * for (;;) { * var a = crypto.getDiffieHellman('modp14'), * var b = crypto.getDiffieHellman('modp14'); * * a.generateKeys(); * b.generateKeys(); * * var aSecret = a.computeSecret(b.getPublicKey()).toString('hex'); * console.log("A public: " + a.getPublicKey().toString('hex')); * console.log("A private: " + a.getPrivateKey().toString('hex')); * console.log("B public: " + b.getPublicKey().toString('hex')); * console.log("B private: " + b.getPrivateKey().toString('hex')); * console.log("A secret: " + aSecret); * console.log('-------------------------------------------------'); * if(aSecret.substring(0,2) === "00") { * console.log("found short key!"); * return; * } * } */ var apub = '5484455905d3eff34c70980e871f27f05448e66f5a6efbb97cbcba4e927196c2bd9ea272cded91\ 10a4977afa8d9b16c9139a444ed2d954a794650e5d7cb525204f385e1af81530518563822ecd0f9\ 524a958d02b3c269e79d6d69850f0968ad567a4404fbb0b19efc8bc73e267b6136b88cafb33299f\ f7c7cace3ffab1a88c2c9ee841f88b4c3679b4efc465f5c93cca11d487be57373e4c5926f634c4e\ efee6721d01db91cd66321615b2522f96368dbc818875d422140d0edf30bdb97d9721feddcb9ff6\ 453741a4f687ee46fc54bf1198801f1210ac789879a5ee123f79e2d2ce1209df2445d32166bc9e4\ 8f89e944ec9c3b2e16c8066cd8eebd4e33eb941'; var bpub = '3fca64510e36bc7da8a3a901c7b74c2eabfa25deaf7cbe1d0c50235866136ad677317279e1fb0\ 06e9c0a07f63e14a3363c8e016fbbde2b2c7e79fed1cc3e08e95f7459f547a8cd0523ee9dc744d\ e5a956d92b937db4448917e1f6829437f05e408ee7aea70c0362b37370c7c75d14449d8b2d2133\ 04ac972302d349975e2265ca7103cfebd019d9e91234d638611abd049014f7abf706c1c5da6c88\ 788a1fdc6cdf17f5fffaf024ce8711a2ebde0b52e9f1cb56224483826d6e5ac6ecfaae07b75d20\ 6e8ac97f5be1a5b68f20382f2a7dac189cf169325c4cf845b26a0cd616c31fec905c5d9035e5f7\ 8e9880c812374ac0f3ca3d365f06e4be526b5affd4b79'; var apriv = '62411e34704637d99c6c958a7db32ac22fcafafbe1c33d2cfdb76e12ded41f38fc16b792b9041\ 2e4c82755a3815ba52f780f0ee296ad46e348fc4d1dcd6b64f4eea1b231b2b7d95c5b1c2e26d34\ 83520558b9860a6eb668f01422a54e6604aa7702b4e67511397ef3ecb912bff1a83899c5a5bfb2\ 0ee29249a91b8a698e62486f7009a0e9eaebda69d77ecfa2ca6ba2db6c8aa81759c8c90c675979\ 08c3b3e6fc60668f7be81cce6784482af228dd7f489005253a165e292802cfd0399924f6c56827\ 7012f68255207722355634290acc7fddeefbba75650a85ece95b6a12de67eac016ba78960108dd\ 5dbadfaa43cc9fed515a1f307b7d90ae0623bc7b8cefb'; var secret = '00c37b1e06a436d6717816a40e6d72907a6f255638b93032267dcb9a5f0b4a9aa0236f3dce63b\ 1c418c60978a00acd1617dfeecf1661d8a3fafb4d0d8824386750f4853313400e7e4afd22847e4\ fa56bc9713872021265111906673b38db83d10cbfa1dea3b6b4c97c8655f4ae82125281af7f234\ 8916a15c6f95649367d169d587697480df4d10b381479e86d5518b520d9d8fb764084eab518224\ dc8fe984ddaf532fc1531ce43155fa0ab32532bf1ece5356b8a3447b5267798a904f16f3f4e635\ 597adc0179d011132dcffc0bbcb0dd2c8700872f8663ec7ddd897c659cc2efebccc73f38f0ec96\ 8612314311231f905f91c63a1aea52e0b60cead8b57df'; /* FIPS-friendly 2048 bit prime */ var p = crypto.createDiffieHellman( crypto.getDiffieHellman('modp14').getPrime()); p.setPublicKey(apub, 'hex'); p.setPrivateKey(apriv, 'hex'); assert.equal( p.computeSecret(bpub, 'hex', 'hex').toString('hex'), secret ); node-v4.8.2/test/parallel/test-dns-lookup-cb-error.js000644 000766 000024 00000001045 13070706737 022654 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var cares = process.binding('cares_wrap'); var dns = require('dns'); // Stub `getaddrinfo` to *always* error. cares.getaddrinfo = function() { return process.binding('uv').UV_ENOENT; }; assert.doesNotThrow(function() { var tickValue = 0; dns.lookup('example.com', function(error, result, addressType) { assert.equal(tickValue, 1); assert.equal(error.code, 'ENOENT'); }); // Make sure that the error callback is called // on next tick. tickValue = 1; }); node-v4.8.2/test/parallel/test-dns-regress-6244.js000644 000766 000024 00000000253 13070706737 021701 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var dns = require('dns'); // Should not segfault, see #6244. dns.resolve4('127.0.0.1', common.mustCall(function() { })); node-v4.8.2/test/parallel/test-dns-regress-7070.js000644 000766 000024 00000000420 13070706737 021673 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var dns = require('dns'); // Should not raise assertion error. Issue #7070 assert.throws(function() { dns.resolveNs([]); }); // bad name assert.throws(function() { dns.resolveNs(''); }); // bad callback node-v4.8.2/test/parallel/test-dns.js000644 000766 000024 00000007350 13070706737 017641 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const dns = require('dns'); var existing = dns.getServers(); assert(existing.length > 0); function noop() {} var goog = [ '8.8.8.8', '8.8.4.4', ]; assert.doesNotThrow(function() { dns.setServers(goog); }); assert.deepEqual(dns.getServers(), goog); assert.throws(function() { dns.setServers(['foobar']); }, /^Error: IP address is not properly formatted: foobar$/); assert.deepEqual(dns.getServers(), goog); var goog6 = [ '2001:4860:4860::8888', '2001:4860:4860::8844', ]; assert.doesNotThrow(function() { dns.setServers(goog6); }); assert.deepEqual(dns.getServers(), goog6); goog6.push('4.4.4.4'); dns.setServers(goog6); assert.deepEqual(dns.getServers(), goog6); var ports = [ '4.4.4.4:53', '[2001:4860:4860::8888]:53', ]; var portsExpected = [ '4.4.4.4', '2001:4860:4860::8888', ]; dns.setServers(ports); assert.deepEqual(dns.getServers(), portsExpected); assert.doesNotThrow(function() { dns.setServers([]); }); assert.deepEqual(dns.getServers(), []); assert.throws(function() { dns.resolve('test.com', [], noop); }, function(err) { return !(err instanceof TypeError); }, 'Unexpected error'); // dns.lookup should accept falsey and string values const errorReg = /^TypeError: invalid arguments: hostname must be a string or falsey$/; assert.throws(function() { dns.lookup({}, noop); }, errorReg); assert.throws(function() { dns.lookup([], noop); }, errorReg); assert.throws(function() { dns.lookup(true, noop); }, errorReg); assert.throws(function() { dns.lookup(1, noop); }, errorReg); assert.throws(function() { dns.lookup(noop, noop); }, errorReg); assert.doesNotThrow(function() { dns.lookup('', noop); }); assert.doesNotThrow(function() { dns.lookup(null, noop); }); assert.doesNotThrow(function() { dns.lookup(undefined, noop); }); assert.doesNotThrow(function() { dns.lookup(0, noop); }); assert.doesNotThrow(function() { dns.lookup(NaN, noop); }); /* * Make sure that dns.lookup throws if hints does not represent a valid flag. * (dns.V4MAPPED | dns.ADDRCONFIG) + 1 is invalid because: * - it's different from dns.V4MAPPED and dns.ADDRCONFIG. * - it's different from them bitwise ored. * - it's different from 0. * - it's an odd number different than 1, and thus is invalid, because * flags are either === 1 or even. */ assert.throws(function() { dns.lookup('www.google.com', { hints: (dns.V4MAPPED | dns.ADDRCONFIG) + 1 }, noop); }, /^TypeError: invalid argument: hints must use valid flags$/); assert.throws(function() { dns.lookup('www.google.com'); }, /^TypeError: invalid arguments: callback must be passed$/); assert.throws(function() { dns.lookup('www.google.com', 4); }, /^TypeError: invalid arguments: callback must be passed$/); assert.doesNotThrow(function() { dns.lookup('www.google.com', 6, noop); }); assert.doesNotThrow(function() { dns.lookup('www.google.com', {}, noop); }); assert.doesNotThrow(function() { dns.lookup('', { family: 4, hints: 0 }, noop); }); assert.doesNotThrow(function() { dns.lookup('', { family: 6, hints: dns.ADDRCONFIG }, noop); }); assert.doesNotThrow(function() { dns.lookup('', { hints: dns.V4MAPPED }, noop); }); assert.doesNotThrow(function() { dns.lookup('', { hints: dns.ADDRCONFIG | dns.V4MAPPED }, noop); }); assert.throws(function() { dns.lookupService('0.0.0.0'); }, /^Error: invalid arguments$/); assert.throws(function() { dns.lookupService('fasdfdsaf', 0, noop); }, /^TypeError: host needs to be a valid IP address$/); assert.throws(function() { dns.lookupService('0.0.0.0', '0', noop); }, /^TypeError: port argument must be a number, got "0"$/); assert.doesNotThrow(function() { dns.lookupService('0.0.0.0', 0, noop); }); node-v4.8.2/test/parallel/test-domain-abort-on-uncaught.js000644 000766 000024 00000012366 13070706737 023662 0ustar00iojsstaff000000 000000 'use strict'; // This test makes sure that when using --abort-on-uncaught-exception and // when throwing an error from within a domain that has an error handler // setup, the process _does not_ abort. const common = require('../common'); const assert = require('assert'); const domain = require('domain'); const child_process = require('child_process'); var errorHandlerCalled = false; const tests = [ function nextTick() { const d = domain.create(); d.once('error', function(err) { errorHandlerCalled = true; }); d.run(function() { process.nextTick(function() { throw new Error('exceptional!'); }); }); }, function timer() { const d = domain.create(); d.on('error', function(err) { errorHandlerCalled = true; }); d.run(function() { setTimeout(function() { throw new Error('exceptional!'); }, 33); }); }, function immediate() { const d = domain.create(); d.on('error', function errorHandler() { errorHandlerCalled = true; }); d.run(function() { setImmediate(function() { throw new Error('boom!'); }); }); }, function timerPlusNextTick() { const d = domain.create(); d.on('error', function(err) { errorHandlerCalled = true; }); d.run(function() { setTimeout(function() { process.nextTick(function() { throw new Error('exceptional!'); }); }, 33); }); }, function firstRun() { const d = domain.create(); d.on('error', function(err) { errorHandlerCalled = true; }); d.run(function() { throw new Error('exceptional!'); }); }, function fsAsync() { const d = domain.create(); d.on('error', function errorHandler() { errorHandlerCalled = true; }); d.run(function() { var fs = require('fs'); fs.exists('/non/existing/file', function onExists(exists) { throw new Error('boom!'); }); }); }, function netServer() { const net = require('net'); const d = domain.create(); d.on('error', function(err) { errorHandlerCalled = true; }); d.run(function() { const server = net.createServer(function(conn) { conn.pipe(conn); }); server.listen(0, common.localhostIPv4, function() { const conn = net.connect(this.address().port, common.localhostIPv4); conn.once('data', function() { throw new Error('ok'); }); conn.end('ok'); server.close(); }); }); }, function firstRunNestedWithErrorHandler() { const d = domain.create(); const d2 = domain.create(); d2.on('error', function errorHandler() { errorHandlerCalled = true; }); d.run(function() { d2.run(function() { throw new Error('boom!'); }); }); }, function timeoutNestedWithErrorHandler() { const d = domain.create(); const d2 = domain.create(); d2.on('error', function errorHandler() { errorHandlerCalled = true; }); d.run(function() { d2.run(function() { setTimeout(function() { console.log('foo'); throw new Error('boom!'); }, 33); }); }); }, function setImmediateNestedWithErrorHandler() { const d = domain.create(); const d2 = domain.create(); d2.on('error', function errorHandler() { errorHandlerCalled = true; }); d.run(function() { d2.run(function() { setImmediate(function() { throw new Error('boom!'); }); }); }); }, function nextTickNestedWithErrorHandler() { const d = domain.create(); const d2 = domain.create(); d2.on('error', function errorHandler() { errorHandlerCalled = true; }); d.run(function() { d2.run(function() { process.nextTick(function() { throw new Error('boom!'); }); }); }); }, function fsAsyncNestedWithErrorHandler() { const d = domain.create(); const d2 = domain.create(); d2.on('error', function errorHandler() { errorHandlerCalled = true; }); d.run(function() { d2.run(function() { var fs = require('fs'); fs.exists('/non/existing/file', function onExists(exists) { throw new Error('boom!'); }); }); }); } ]; if (process.argv[2] === 'child') { const testIndex = +process.argv[3]; tests[testIndex](); process.on('exit', function onExit() { assert.strictEqual(errorHandlerCalled, true); }); } else { tests.forEach(function(test, testIndex) { var testCmd = ''; if (process.platform !== 'win32') { // Do not create core files, as it can take a lot of disk space on // continuous testing and developers' machines testCmd += 'ulimit -c 0 && '; } testCmd += process.argv[0]; testCmd += ' ' + '--abort-on-uncaught-exception'; testCmd += ' ' + process.argv[1]; testCmd += ' ' + 'child'; testCmd += ' ' + testIndex; var child = child_process.exec(testCmd); child.on('exit', function onExit(code, signal) { assert.strictEqual(code, 0, 'Test at index ' + testIndex + ' should have exited with exit code 0 but instead exited with code ' + code + ' and signal ' + signal); }); }); } node-v4.8.2/test/parallel/test-domain-crypto.js000644 000766 000024 00000001135 13070706737 021635 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); try { var crypto = require('crypto'); } catch (e) { common.skip('node compiled without OpenSSL.'); return; } // Pollution of global is intentional as part of test. common.globalCheck = false; // See https://github.com/nodejs/node/commit/d1eff9ab global.domain = require('domain'); // should not throw a 'TypeError: undefined is not a function' exception crypto.randomBytes(8); crypto.randomBytes(8, function() {}); crypto.pseudoRandomBytes(8); crypto.pseudoRandomBytes(8, function() {}); crypto.pbkdf2('password', 'salt', 8, 8, function() {}); node-v4.8.2/test/parallel/test-domain-enter-exit.js000644 000766 000024 00000001670 13070706737 022405 0ustar00iojsstaff000000 000000 'use strict'; // Make sure the domain stack is a stack require('../common'); var assert = require('assert'); var domain = require('domain'); function names(array) { return array.map(function(d) { return d.name; }).join(', '); } var a = domain.create(); a.name = 'a'; var b = domain.create(); b.name = 'b'; var c = domain.create(); c.name = 'c'; a.enter(); // push assert.deepEqual(domain._stack, [a], 'a not pushed: ' + names(domain._stack)); b.enter(); // push assert.deepEqual(domain._stack, [a, b], 'b not pushed: ' + names(domain._stack)); c.enter(); // push assert.deepEqual(domain._stack, [a, b, c], 'c not pushed: ' + names(domain._stack)); b.exit(); // pop assert.deepEqual(domain._stack, [a], 'b and c not popped: ' + names(domain._stack)); b.enter(); // push assert.deepEqual(domain._stack, [a, b], 'b not pushed: ' + names(domain._stack)); node-v4.8.2/test/parallel/test-domain-exit-dispose-again.js000644 000766 000024 00000005335 13070706737 024015 0ustar00iojsstaff000000 000000 'use strict'; // This test makes sure that when a domain is disposed, timers that are // attached to that domain are not fired, but timers that are _not_ attached // to that domain, including those whose callbacks are called from within // the same invocation of listOnTimeout, _are_ called. require('../common'); var assert = require('assert'); var domain = require('domain'); var disposalFailed = false; // Repeatedly schedule a timer with a delay different than the timers attached // to a domain that will eventually be disposed to make sure that they are // called, regardless of what happens with those timers attached to domains // that will eventually be disposed. var a = 0; log(); function log() { console.log(a++, process.domain); if (a < 10) setTimeout(log, 20); } var secondTimerRan = false; // Use the same timeout duration for both "firstTimer" and "secondTimer" // callbacks so that they are called during the same invocation of the // underlying native timer's callback (listOnTimeout in lib/timers.js). const TIMEOUT_DURATION = 50; setTimeout(function firstTimer() { const d = domain.create(); d.on('error', function handleError(err) { // Dispose the domain on purpose, so that we can test that nestedTimer // is not called since it's associated to this domain and a timer whose // domain is diposed should not run. d.dispose(); console.error(err); console.error('in domain error handler', process.domain, process.domain === d); }); d.run(function() { // Create another nested timer that is by definition associated to the // domain "d". Because an error is thrown before the timer's callback // is called, and because the domain's error handler disposes the domain, // this timer's callback should never run. setTimeout(function nestedTimer() { console.error('Nested timer should not run, because it is attached to ' + 'a domain that should be disposed.'); disposalFailed = true; process.exit(1); }, 1); // Make V8 throw an unreferenced error. As a result, the domain's error // handler is called, which disposes the domain "d" and should prevent the // nested timer that is attached to it from running. err3(); // eslint-disable-line no-undef }); }, TIMEOUT_DURATION); // This timer expires in the same invocation of listOnTimeout than firstTimer, // but because it's not attached to any domain, it must run regardless of // domain "d" being disposed. setTimeout(function secondTimer() { console.log('In second timer'); secondTimerRan = true; }, TIMEOUT_DURATION); process.on('exit', function() { assert.strictEqual(a, 10); assert.strictEqual(disposalFailed, false); assert(secondTimerRan); console.log('ok'); }); node-v4.8.2/test/parallel/test-domain-exit-dispose.js000644 000766 000024 00000001764 13070706737 022742 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var common = require('../common'); var assert = require('assert'); var domain = require('domain'); // no matter what happens, we should increment a 10 times. var a = 0; log(); function log() { console.log(a++, process.domain); if (a < 10) setTimeout(log, 20); } // in 50ms we'll throw an error. setTimeout(err, 50); function err() { var d = domain.create(); d.on('error', handle); d.run(err2); function err2() { // this timeout should never be called, since the domain gets // disposed when the error happens. setTimeout(common.mustCall(() => {}, 0), 1); // this function doesn't exist, and throws an error as a result. err3(); // eslint-disable-line no-undef } function handle(e) { // this should clean up everything properly. d.dispose(); console.error(e); console.error('in handler', process.domain, process.domain === d); } } process.on('exit', function() { assert.strictEqual(a, 10); console.log('ok'); }); node-v4.8.2/test/parallel/test-domain-from-timer.js000644 000766 000024 00000000763 13070706737 022404 0ustar00iojsstaff000000 000000 'use strict'; // Simple tests of most basic domain functionality. require('../common'); const assert = require('assert'); // timeouts call the callback directly from cc, so need to make sure the // domain will be used regardless setTimeout(function() { const domain = require('domain'); const d = domain.create(); d.run(function() { process.nextTick(function() { console.trace('in nexttick', process.domain === d); assert.strictEqual(process.domain, d); }); }); }, 1); node-v4.8.2/test/parallel/test-domain-http-server.js000644 000766 000024 00000004371 13070706737 022605 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var domain = require('domain'); var http = require('http'); var assert = require('assert'); var objects = { foo: 'bar', baz: {}, num: 42, arr: [1, 2, 3] }; objects.baz.asdf = objects; var serverCaught = 0; var clientCaught = 0; var server = http.createServer(function(req, res) { var dom = domain.create(); req.resume(); dom.add(req); dom.add(res); dom.on('error', function(er) { serverCaught++; console.log('horray! got a server error', er); // try to send a 500. If that fails, oh well. res.writeHead(500, {'content-type': 'text/plain'}); res.end(er.stack || er.message || 'Unknown error'); }); dom.run(function() { // Now, an action that has the potential to fail! // if you request 'baz', then it'll throw a JSON circular ref error. var data = JSON.stringify(objects[req.url.replace(/[^a-z]/g, '')]); // this line will throw if you pick an unknown key assert(data !== undefined, 'Data should not be undefined'); res.writeHead(200); res.end(data); }); }); server.listen(0, next); function next() { const port = this.address().port; console.log('listening on localhost:%d', port); var requests = 0; var responses = 0; makeReq('/'); makeReq('/foo'); makeReq('/arr'); makeReq('/baz'); makeReq('/num'); function makeReq(p) { requests++; var dom = domain.create(); dom.on('error', function(er) { clientCaught++; console.log('client error', er); req.socket.destroy(); }); var req = http.get({ host: 'localhost', port: port, path: p }); dom.add(req); req.on('response', function(res) { responses++; console.error('requests=%d responses=%d', requests, responses); if (responses === requests) { console.error('done, closing server'); // no more coming. server.close(); } dom.add(res); var d = ''; res.on('data', function(c) { d += c; }); res.on('end', function() { console.error('trying to parse json', d); d = JSON.parse(d); console.log('json!', d); }); }); } } process.on('exit', function() { assert.strictEqual(serverCaught, 2); assert.strictEqual(clientCaught, 2); console.log('ok'); }); node-v4.8.2/test/parallel/test-domain-implicit-fs.js000644 000766 000024 00000002337 13070706737 022542 0ustar00iojsstaff000000 000000 'use strict'; // Simple tests of most basic domain functionality. const common = require('../common'); var assert = require('assert'); var domain = require('domain'); var d = new domain.Domain(); d.on('error', common.mustCall(function(er) { console.error('caught', er); assert.strictEqual(er.domain, d); assert.strictEqual(er.domainThrown, true); assert.ok(!er.domainEmitter); assert.strictEqual(er.code, 'ENOENT'); assert.ok(/\bthis file does not exist\b/i.test(er.path)); assert.strictEqual(typeof er.errno, 'number'); })); // implicit handling of thrown errors while in a domain, via the // single entry points of ReqWrap and MakeCallback. Even if // we try very hard to escape, there should be no way to, even if // we go many levels deep through timeouts and multiple IO calls. // Everything that happens between the domain.enter() and domain.exit() // calls will be bound to the domain, even if multiple levels of // handles are created. d.run(function() { setTimeout(function() { var fs = require('fs'); fs.readdir(__dirname, function() { fs.open('this file does not exist', 'r', function(er) { if (er) throw er; throw new Error('should not get here!'); }); }); }, 100); }); node-v4.8.2/test/parallel/test-domain-multi.js000644 000766 000024 00000002532 13070706737 021451 0ustar00iojsstaff000000 000000 'use strict'; // Tests of multiple domains happening at once. const common = require('../common'); const domain = require('domain'); const http = require('http'); var a = domain.create(); a.enter(); // this will be our "root" domain a.on('error', common.fail); const server = http.createServer((req, res) => { // child domain of a. var b = domain.create(); a.add(b); // treat these EE objects as if they are a part of the b domain // so, an 'error' event on them propagates to the domain, rather // than being thrown. b.add(req); b.add(res); b.on('error', common.mustCall((er) => { if (res) { res.writeHead(500); res.end('An error occurred'); } // res.writeHead(500), res.destroy, etc. server.close(); })); // XXX this bind should not be necessary. // the write cb behavior in http/net should use an // event so that it picks up the domain handling. res.write('HELLO\n', b.bind(() => { throw new Error('this kills domain B, not A'); })); }).listen(0, () => { const c = domain.create(); const req = http.get({ host: 'localhost', port: server.address().port }); // add the request to the C domain c.add(req); req.on('response', (res) => { // add the response object to the C domain c.add(res); res.pipe(process.stdout); }); c.on('error', common.mustCall((er) => { })); }); node-v4.8.2/test/parallel/test-domain-nested-throw.js000644 000766 000024 00000003275 13070706737 022747 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var domain = require('domain'); var dispose; switch (process.argv[2]) { case 'true': dispose = true; break; case 'false': dispose = false; break; default: parent(); return; } function parent() { var node = process.execPath; var spawn = require('child_process').spawn; var opt = { stdio: 'inherit' }; var child = spawn(node, [__filename, 'true'], opt); child.on('exit', function(c) { assert(!c); child = spawn(node, [__filename, 'false'], opt); child.on('exit', function(c) { assert(!c); console.log('ok'); }); }); } var gotDomain1Error = false; var gotDomain2Error = false; var threw1 = false; var threw2 = false; function throw1() { threw1 = true; throw new Error('handled by domain1'); } function throw2() { threw2 = true; throw new Error('handled by domain2'); } function inner(throw1, throw2) { var domain1 = domain.createDomain(); domain1.on('error', function(err) { if (gotDomain1Error) { console.error('got domain 1 twice'); process.exit(1); } if (dispose) domain1.dispose(); gotDomain1Error = true; throw2(); }); domain1.run(function() { throw1(); }); } function outer() { var domain2 = domain.createDomain(); domain2.on('error', function(err) { if (gotDomain2Error) { console.error('got domain 2 twice'); process.exit(1); } gotDomain2Error = true; }); domain2.run(function() { inner(throw1, throw2); }); } process.on('exit', function() { assert(gotDomain1Error); assert(gotDomain2Error); assert(threw1); assert(threw2); console.log('ok', dispose); }); outer(); node-v4.8.2/test/parallel/test-domain-nested.js000644 000766 000024 00000001033 13070706737 021574 0ustar00iojsstaff000000 000000 'use strict'; // Make sure that the nested domains don't cause the domain stack to grow require('../common'); var assert = require('assert'); var domain = require('domain'); process.on('exit', function(c) { assert.equal(domain._stack.length, 0); }); domain.create().run(function() { domain.create().run(function() { domain.create().run(function() { domain.create().on('error', function(e) { // Don't need to do anything here }).run(function() { throw new Error('died'); }); }); }); }); node-v4.8.2/test/parallel/test-domain-no-error-handler-abort-on-uncaught.js000644 000766 000024 00000010216 13070706737 027026 0ustar00iojsstaff000000 000000 'use strict'; /* * This test makes sure that when using --abort-on-uncaught-exception and * when throwing an error from within a domain that does not have an error * handler setup, the process aborts. */ const common = require('../common'); const assert = require('assert'); const domain = require('domain'); const child_process = require('child_process'); const tests = [ function() { const d = domain.create(); d.run(function() { throw new Error('boom!'); }); }, function() { const d = domain.create(); const d2 = domain.create(); d.run(function() { d2.run(function() { throw new Error('boom!'); }); }); }, /* * In this case, only the domain at the top of the stack "d" has an error * handler, but the domain from which the error is thrown doesn't have an * error handler. To be consistent with the way domains bubble up errors, * this test case _should not_ make the process abort. However it was * determined that making such a change in v4.x might be a breaking change, * so instead this test case makes sure the process aborts. */ function() { const d = domain.create(); const d2 = domain.create(); d.on('error', function errorHandler() { }); d.run(function() { d2.run(function() { throw new Error('boom!'); }); }); }, function() { const d = domain.create(); d.run(function() { setTimeout(function() { throw new Error('boom!'); }, 1); }); }, function() { const d = domain.create(); d.run(function() { setImmediate(function() { throw new Error('boom!'); }); }); }, function() { const d = domain.create(); d.run(function() { process.nextTick(function() { throw new Error('boom!'); }); }); }, function() { const d = domain.create(); d.run(function() { var fs = require('fs'); fs.exists('/non/existing/file', function onExists() { throw new Error('boom!'); }); }); }, function() { const d = domain.create(); const d2 = domain.create(); d.on('error', function errorHandler() { }); d.run(function() { d2.run(function() { setTimeout(function() { throw new Error('boom!'); }, 1); }); }); }, function() { const d = domain.create(); const d2 = domain.create(); d.on('error', function errorHandler() { }); d.run(function() { d2.run(function() { setImmediate(function() { throw new Error('boom!'); }); }); }); }, function() { const d = domain.create(); const d2 = domain.create(); d.on('error', function errorHandler() { }); d.run(function() { d2.run(function() { process.nextTick(function() { throw new Error('boom!'); }); }); }); }, function() { const d = domain.create(); const d2 = domain.create(); d.on('error', function errorHandler() { }); d.run(function() { d2.run(function() { var fs = require('fs'); fs.exists('/non/existing/file', function onExists() { throw new Error('boom!'); }); }); }); } ]; if (process.argv[2] === 'child') { const testIndex = +process.argv[3]; tests[testIndex](); } else { tests.forEach(function(test, testIndex) { var testCmd = ''; if (process.platform !== 'win32') { // Do not create core files, as it can take a lot of disk space on // continuous testing and developers' machines testCmd += 'ulimit -c 0 && '; } testCmd += process.argv[0]; testCmd += ' ' + '--abort-on-uncaught-exception'; testCmd += ' ' + process.argv[1]; testCmd += ' ' + 'child'; testCmd += ' ' + testIndex; var child = child_process.exec(testCmd); child.on('exit', function onExit(exitCode, signal) { const errMsg = 'Test at index ' + testIndex + ' should have aborted ' + 'but instead exited with exit code ' + exitCode + ' and signal ' + signal; assert(common.nodeProcessAborted(exitCode, signal), errMsg); }); }); } node-v4.8.2/test/parallel/test-domain-safe-exit.js000644 000766 000024 00000000637 13070706737 022210 0ustar00iojsstaff000000 000000 'use strict'; // Make sure the domain stack doesn't get clobbered by un-matched .exit() require('../common'); var assert = require('assert'); var domain = require('domain'); var a = domain.create(); var b = domain.create(); a.enter(); // push b.enter(); // push assert.deepEqual(domain._stack, [a, b], 'b not pushed'); domain.create().exit(); // no-op assert.deepEqual(domain._stack, [a, b], 'stack mangled!'); node-v4.8.2/test/parallel/test-domain-stack.js000644 000766 000024 00000000772 13070706737 021430 0ustar00iojsstaff000000 000000 'use strict'; // Make sure that the domain stack doesn't get out of hand. require('../common'); var domain = require('domain'); var a = domain.create(); a.name = 'a'; a.on('error', function() { if (domain._stack.length > 5) { console.error('leaking!', domain._stack); process.exit(1); } }); var foo = a.bind(function() { throw new Error('error from foo'); }); for (var i = 0; i < 1000; i++) { process.nextTick(foo); } process.on('exit', function(c) { if (!c) console.log('ok'); }); node-v4.8.2/test/parallel/test-domain-throw-error-then-throw-from-uncaught-exception-handler.js000644 000766 000024 00000010013 13070706737 033063 0ustar00iojsstaff000000 000000 'use strict'; // This test makes sure that when throwing an error from a domain, and then // handling that error in an uncaughtException handler by throwing an error // again, the exit code, signal and error messages are the ones we expect with // and without using --abort-on-uncaught-exception. const common = require('../common'); const assert = require('assert'); const child_process = require('child_process'); const domain = require('domain'); const uncaughtExceptionHandlerErrMsg = 'boom from uncaughtException handler'; const domainErrMsg = 'boom from domain'; const RAN_UNCAUGHT_EXCEPTION_HANDLER_EXIT_CODE = 42; if (process.argv[2] === 'child') { process.on('uncaughtException', common.mustCall(function onUncaught() { if (process.execArgv.indexOf('--abort-on-uncaught-exception') !== -1) { // When passing --abort-on-uncaught-exception to the child process, // we want to make sure that this handler (the process' uncaughtException // event handler) wasn't called. Unfortunately we can't parse the child // process' output to do that, since on Windows the standard error output // is not properly flushed in V8's Isolate::Throw right before the // process aborts due to an uncaught exception, and thus the error // message representing the error that was thrown cannot be read by the // parent process. So instead of parsing the child process' stdandard // error, the parent process will check that in the case // --abort-on-uncaught-exception was passed, the process did not exit // with exit code RAN_UNCAUGHT_EXCEPTION_HANDLER_EXIT_CODE. process.exit(RAN_UNCAUGHT_EXCEPTION_HANDLER_EXIT_CODE); } else { // On the other hand, when not passing --abort-on-uncaught-exception to // the node process, we want to throw in this event handler to make sure // that the proper error message, exit code and signal are the ones we // expect. throw new Error(uncaughtExceptionHandlerErrMsg); } })); const d = domain.create(); d.run(common.mustCall(function() { throw new Error(domainErrMsg); })); } else { runTestWithoutAbortOnUncaughtException(); runTestWithAbortOnUncaughtException(); } function runTestWithoutAbortOnUncaughtException() { child_process.exec(createTestCmdLine(), function onTestDone(err, stdout, stderr) { // When _not_ passing --abort-on-uncaught-exception, the process' // uncaughtException handler _must_ be called, and thus the error // message must include only the message of the error thrown from the // process' uncaughtException handler. assert(stderr.includes(uncaughtExceptionHandlerErrMsg), 'stderr output must include proper uncaughtException handler\'s ' + 'error\'s message'); assert(!stderr.includes(domainErrMsg), 'stderr output must not ' + 'include domain\'s error\'s message'); assert.notEqual(err.code, 0, 'child process should have exited with a non-zero ' + 'exit code, but did not'); }); } function runTestWithAbortOnUncaughtException() { child_process.exec(createTestCmdLine({ withAbortOnUncaughtException: true }), function onTestDone(err, stdout, stderr) { assert.notEqual(err.code, RAN_UNCAUGHT_EXCEPTION_HANDLER_EXIT_CODE, 'child process should not have run its uncaughtException ' + 'event handler'); assert(common.nodeProcessAborted(err.code, err.signal), 'process should have aborted, but did not'); }); } function createTestCmdLine(options) { var testCmd = ''; if (process.platform !== 'win32') { // Do not create core files, as it can take a lot of disk space on // continuous testing and developers' machines testCmd += 'ulimit -c 0 && '; } testCmd += process.argv[0]; if (options && options.withAbortOnUncaughtException) { testCmd += ' ' + '--abort-on-uncaught-exception'; } testCmd += ' ' + process.argv[1]; testCmd += ' ' + 'child'; return testCmd; } node-v4.8.2/test/parallel/test-domain-timers.js000644 000766 000024 00000001420 13070706737 021615 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var domain = require('domain'); var assert = require('assert'); var timeout; var timeoutd = domain.create(); timeoutd.on('error', common.mustCall(function(e) { assert.equal(e.message, 'Timeout UNREFd', 'Domain should catch timer error'); clearTimeout(timeout); })); timeoutd.run(function() { setTimeout(function() { throw new Error('Timeout UNREFd'); }).unref(); }); var immediated = domain.create(); immediated.on('error', common.mustCall(function(e) { assert.equal(e.message, 'Immediate Error', 'Domain should catch immediate error'); })); immediated.run(function() { setImmediate(function() { throw new Error('Immediate Error'); }); }); timeout = setTimeout(function() {}, 10 * 1000); node-v4.8.2/test/parallel/test-domain-top-level-error-handler-clears-stack.js000644 000766 000024 00000002267 13070706737 027347 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const domain = require('domain'); /* * Make sure that the domains stack is cleared after a top-level domain * error handler exited gracefully. */ const d = domain.create(); d.on('error', common.mustCall(function() { process.nextTick(function() { // Scheduling a callback with process.nextTick will enter a _new_ domain, // and the callback will be called after the domain that handled the error // was exited. So there should be only one domain on the domains stack if // the domains stack was cleared properly when the domain error handler // returned. if (domain._stack.length !== 1) { // Do not use assert to perform this test: this callback runs in a // different callstack as the original process._fatalException that // handled the original error, thus throwing here would trigger another // call to process._fatalException, and so on recursively and // indefinitely. console.error('domains stack length should be 1, but instead is:', domain._stack.length); process.exit(1); } }); })); d.run(function() { throw new Error('Error from domain'); }); node-v4.8.2/test/parallel/test-domain-top-level-error-handler-throw.js000644 000766 000024 00000002712 13070706737 026131 0ustar00iojsstaff000000 000000 'use strict'; /* * The goal of this test is to make sure that when a top-level error * handler throws an error following the handling of a previous error, * the process reports the error message from the error thrown in the * top-level error handler, not the one from the previous error. */ require('../common'); const domainErrHandlerExMessage = 'exception from domain error handler'; const internalExMessage = 'You should NOT see me'; if (process.argv[2] === 'child') { var domain = require('domain'); var d = domain.create(); d.on('error', function() { throw new Error(domainErrHandlerExMessage); }); d.run(function doStuff() { process.nextTick(function() { throw new Error(internalExMessage); }); }); } else { var fork = require('child_process').fork; var assert = require('assert'); var child = fork(process.argv[1], ['child'], {silent: true}); var stderrOutput = ''; if (child) { child.stderr.on('data', function onStderrData(data) { stderrOutput += data.toString(); }); child.on('close', function onChildClosed() { assert(stderrOutput.indexOf(domainErrHandlerExMessage) !== -1); assert(stderrOutput.indexOf(internalExMessage) === -1); }); child.on('exit', function onChildExited(exitCode, signal) { var expectedExitCode = 7; var expectedSignal = null; assert.strictEqual(exitCode, expectedExitCode); assert.strictEqual(signal, expectedSignal); }); } } node-v4.8.2/test/parallel/test-domain-uncaught-exception.js000644 000766 000024 00000012631 13070706737 024132 0ustar00iojsstaff000000 000000 'use strict'; /* * The goal of this test is to make sure that errors thrown within domains * are handled correctly. It checks that the process' 'uncaughtException' event * is emitted when appropriate, and not emitted when it shouldn't. It also * checks that the proper domain error handlers are called when they should * be called, and not called when they shouldn't. */ const common = require('../common'); const assert = require('assert'); const domain = require('domain'); const child_process = require('child_process'); const tests = []; function test1() { /* * Throwing from an async callback from within a domain that doesn't have * an error handler must result in emitting the process' uncaughtException * event. */ const d = domain.create(); d.run(function() { setTimeout(function onTimeout() { throw new Error('boom!'); }, 1); }); } tests.push({ fn: test1, expectedMessages: ['uncaughtException'] }); function test2() { /* * Throwing from from within a domain that doesn't have an error handler must * result in emitting the process' uncaughtException event. */ const d2 = domain.create(); d2.run(function() { throw new Error('boom!'); }); } tests.push({ fn: test2, expectedMessages: ['uncaughtException'] }); function test3() { /* * This test creates two nested domains: d3 and d4. d4 doesn't register an * error handler, but d3 does. The error is handled by the d3 domain and thus * an 'uncaughtException' event should _not_ be emitted. */ const d3 = domain.create(); const d4 = domain.create(); d3.on('error', function onErrorInD3Domain() { process.send('errorHandledByDomain'); }); d3.run(function() { d4.run(function() { throw new Error('boom!'); }); }); } tests.push({ fn: test3, expectedMessages: ['errorHandledByDomain'] }); function test4() { /* * This test creates two nested domains: d5 and d6. d6 doesn't register an * error handler. When the timer's callback is called, because async * operations like timer callbacks are bound to the domain that was active * at the time of their creation, and because both d5 and d6 domains have * exited by the time the timer's callback is called, its callback runs with * only d6 on the domains stack. Since d6 doesn't register an error handler, * the process' uncaughtException event should be emitted. */ const d5 = domain.create(); const d6 = domain.create(); d5.on('error', function onErrorInD2Domain() { process.send('errorHandledByDomain'); }); d5.run(function() { d6.run(function() { setTimeout(function onTimeout() { throw new Error('boom!'); }, 1); }); }); } tests.push({ fn: test4, expectedMessages: ['uncaughtException'] }); function test5() { /* * This test creates two nested domains: d7 and d8. d8 _does_ register an * error handler, so throwing within that domain should not emit an uncaught * exception. */ const d7 = domain.create(); const d8 = domain.create(); d8.on('error', function onErrorInD3Domain() { process.send('errorHandledByDomain'); }); d7.run(function() { d8.run(function() { throw new Error('boom!'); }); }); } tests.push({ fn: test5, expectedMessages: ['errorHandledByDomain'] }); function test6() { /* * This test creates two nested domains: d9 and d10. d10 _does_ register an * error handler, so throwing within that domain in an async callback should * _not_ emit an uncaught exception. */ const d9 = domain.create(); const d10 = domain.create(); d10.on('error', function onErrorInD2Domain() { process.send('errorHandledByDomain'); }); d9.run(function() { d10.run(function() { setTimeout(function onTimeout() { throw new Error('boom!'); }, 1); }); }); } tests.push({ fn: test6, expectedMessages: ['errorHandledByDomain'] }); if (process.argv[2] === 'child') { const testIndex = process.argv[3]; process.on('uncaughtException', function onUncaughtException() { process.send('uncaughtException'); }); tests[testIndex].fn(); } else { // Run each test's function in a child process. Listen on // messages sent by each child process and compare expected // messages defined for each test with the actual received messages. tests.forEach(function doTest(test, testIndex) { const testProcess = child_process.fork(__filename, ['child', testIndex]); testProcess.on('message', function onMsg(msg) { if (test.messagesReceived === undefined) test.messagesReceived = []; test.messagesReceived.push(msg); }); testProcess.on('disconnect', common.mustCall(function onExit() { // Make sure that all expected messages were sent from the // child process test.expectedMessages.forEach(function(expectedMessage) { if (test.messagesReceived === undefined || test.messagesReceived.indexOf(expectedMessage) === -1) assert(false, 'test ' + test.fn.name + ' should have sent message: ' + expectedMessage + ' but didn\'t'); }); if (test.messagesReceived) { test.messagesReceived.forEach(function(receivedMessage) { if (test.expectedMessages.indexOf(receivedMessage) === -1) { assert(false, 'test ' + test.fn.name + ' should not have sent message: ' + receivedMessage + ' but did'); } }); } })); }); } node-v4.8.2/test/parallel/test-domain-with-abort-on-uncaught-exception.js000644 000766 000024 00000013062 13070706737 026621 0ustar00iojsstaff000000 000000 'use strict'; const assert = require('assert'); const fs = require('fs'); const common = require('../common'); /* * The goal of this test is to make sure that: * * - Even if --abort_on_uncaught_exception is passed on the command line, * setting up a top-level domain error handler and throwing an error * within this domain does *not* make the process abort. The process exits * gracefully. * * - When passing --abort_on_uncaught_exception on the command line and * setting up a top-level domain error handler, an error thrown * within this domain's error handler *does* make the process abort. * * - When *not* passing --abort_on_uncaught_exception on the command line and * setting up a top-level domain error handler, an error thrown within this * domain's error handler does *not* make the process abort, but makes it exit * with the proper failure exit code. * * - When throwing an error within the top-level domain's error handler * within a try/catch block, the process should exit gracefully, whether or * not --abort_on_uncaught_exception is passed on the command line. */ const domainErrHandlerExMessage = 'exception from domain error handler'; if (process.argv[2] === 'child') { var domain = require('domain'); var d = domain.create(); process.on('uncaughtException', function onUncaughtException() { // The process' uncaughtException event must not be emitted when // an error handler is setup on the top-level domain. // Exiting with exit code of 42 here so that it would assert when // the parent checks the child exit code. process.exit(42); }); d.on('error', function(err) { // Swallowing the error on purpose if 'throwInDomainErrHandler' is not // set if (process.argv.indexOf('throwInDomainErrHandler') !== -1) { // If useTryCatch is set, wrap the throw in a try/catch block. // This is to make sure that a caught exception does not trigger // an abort. if (process.argv.indexOf('useTryCatch') !== -1) { try { throw new Error(domainErrHandlerExMessage); } catch (e) { } } else { throw new Error(domainErrHandlerExMessage); } } }); d.run(function doStuff() { // Throwing from within different types of callbacks as each of them // handles domains differently process.nextTick(function() { throw new Error('Error from nextTick callback'); }); fs.exists('/non/existing/file', function onExists(exists) { throw new Error('Error from fs.exists callback'); }); setImmediate(function onSetImmediate() { throw new Error('Error from setImmediate callback'); }); setTimeout(function onTimeout() { throw new Error('Error from setTimeout callback'); }, 0); throw new Error('Error from domain.run callback'); }); } else { var exec = require('child_process').exec; function testDomainExceptionHandling(cmdLineOption, options) { if (typeof cmdLineOption === 'object') { options = cmdLineOption; cmdLineOption = undefined; } var throwInDomainErrHandlerOpt; if (options.throwInDomainErrHandler) throwInDomainErrHandlerOpt = 'throwInDomainErrHandler'; var cmdToExec = ''; if (process.platform !== 'win32') { // Do not create core files, as it can take a lot of disk space on // continuous testing and developers' machines cmdToExec += 'ulimit -c 0 && '; } var useTryCatchOpt; if (options.useTryCatch) useTryCatchOpt = 'useTryCatch'; cmdToExec += process.argv[0] + ' '; cmdToExec += (cmdLineOption ? cmdLineOption : '') + ' '; cmdToExec += process.argv[1] + ' '; cmdToExec += [ 'child', throwInDomainErrHandlerOpt, useTryCatchOpt ].join(' '); var child = exec(cmdToExec); if (child) { child.on('exit', function onChildExited(exitCode, signal) { // When throwing errors from the top-level domain error handler // outside of a try/catch block, the process should not exit gracefully if (!options.useTryCatch && options.throwInDomainErrHandler) { if (cmdLineOption === '--abort_on_uncaught_exception') { assert(common.nodeProcessAborted(exitCode, signal), 'process should have aborted, but did not'); } else { // By default, uncaught exceptions make node exit with an exit // code of 7. assert.strictEqual(exitCode, 7); assert.strictEqual(signal, null); } } else { // If the top-level domain's error handler does not throw, // the process must exit gracefully, whether or not // --abort_on_uncaught_exception was passed on the command line assert.strictEqual(exitCode, 0); assert.strictEqual(signal, null); } }); } } testDomainExceptionHandling('--abort_on_uncaught_exception', { throwInDomainErrHandler: false, useTryCatch: false }); testDomainExceptionHandling('--abort_on_uncaught_exception', { throwInDomainErrHandler: false, useTryCatch: true }); testDomainExceptionHandling('--abort_on_uncaught_exception', { throwInDomainErrHandler: true, useTryCatch: false }); testDomainExceptionHandling('--abort_on_uncaught_exception', { throwInDomainErrHandler: true, useTryCatch: true }); testDomainExceptionHandling({ throwInDomainErrHandler: false }); testDomainExceptionHandling({ throwInDomainErrHandler: false, useTryCatch: false }); testDomainExceptionHandling({ throwInDomainErrHandler: true, useTryCatch: true }); } node-v4.8.2/test/parallel/test-domain.js000644 000766 000024 00000015477 13070706737 020335 0ustar00iojsstaff000000 000000 'use strict'; // Simple tests of most basic domain functionality. require('../common'); const assert = require('assert'); const domain = require('domain'); const events = require('events'); const fs = require('fs'); var caught = 0; var expectCaught = 0; var d = new domain.Domain(); var e = new events.EventEmitter(); d.on('error', function(er) { console.error('caught', er && (er.message || er)); var er_message = er.message; var er_path = er.path; // On windows, error messages can contain full path names. If this is the // case, remove the directory part. if (typeof er_path === 'string') { var slash = er_path.lastIndexOf('\\'); if (slash !== -1) { var dir = er_path.slice(0, slash + 1); er_path = er_path.replace(dir, ''); er_message = er_message.replace(dir, ''); } } switch (er_message) { case 'emitted': assert.strictEqual(er.domain, d); assert.strictEqual(er.domainEmitter, e); assert.strictEqual(er.domainThrown, false); break; case 'bound': assert.ok(!er.domainEmitter); assert.strictEqual(er.domain, d); assert.strictEqual(er.domainBound, fn); assert.strictEqual(er.domainThrown, false); break; case 'thrown': assert.ok(!er.domainEmitter); assert.strictEqual(er.domain, d); assert.strictEqual(er.domainThrown, true); break; case "ENOENT: no such file or directory, open 'this file does not exist'": assert.strictEqual(er.domain, d); assert.strictEqual(er.domainThrown, false); assert.strictEqual(typeof er.domainBound, 'function'); assert.ok(!er.domainEmitter); assert.strictEqual(er.code, 'ENOENT'); assert.strictEqual(er_path, 'this file does not exist'); assert.strictEqual(typeof er.errno, 'number'); break; case "ENOENT: no such file or directory, open 'stream for nonexistent file'": assert.strictEqual(typeof er.errno, 'number'); assert.strictEqual(er.code, 'ENOENT'); assert.strictEqual(er_path, 'stream for nonexistent file'); assert.strictEqual(er.domain, d); assert.strictEqual(er.domainEmitter, fst); assert.ok(!er.domainBound); assert.strictEqual(er.domainThrown, false); break; case 'implicit': assert.strictEqual(er.domainEmitter, implicit); assert.strictEqual(er.domain, d); assert.strictEqual(er.domainThrown, false); assert.ok(!er.domainBound); break; case 'implicit timer': assert.strictEqual(er.domain, d); assert.strictEqual(er.domainThrown, true); assert.ok(!er.domainEmitter); assert.ok(!er.domainBound); break; case 'Cannot read property \'isDirectory\' of undefined': assert.strictEqual(er.domain, d); assert.ok(!er.domainEmitter); assert.ok(!er.domainBound); break; case 'nextTick execution loop': assert.strictEqual(er.domain, d); assert.ok(!er.domainEmitter); assert.ok(!er.domainBound); break; default: console.error('unexpected error, throwing %j', er.message, er); throw er; } caught++; }); process.on('exit', function() { console.error('exit', caught, expectCaught); assert.strictEqual(caught, expectCaught, 'caught the expected number of errors'); console.log('ok'); }); // revert to using the domain when a callback is passed to nextTick in // the middle of a tickCallback loop d.run(function() { process.nextTick(function() { throw new Error('nextTick execution loop'); }); }); expectCaught++; // catch thrown errors no matter how many times we enter the event loop // this only uses implicit binding, except for the first function // passed to d.run(). The rest are implicitly bound by virtue of being // set up while in the scope of the d domain. d.run(function() { process.nextTick(function() { var i = setInterval(function() { clearInterval(i); setTimeout(function() { fs.stat('this file does not exist', function(er, stat) { // uh oh! stat isn't set! // pretty common error. console.log(stat.isDirectory()); }); }, 1); }, 1); }); }); expectCaught++; // implicit addition of a timer created within a domain-bound context. d.run(function() { setTimeout(function() { throw new Error('implicit timer'); }, 1); }); expectCaught++; // Event emitters added to the domain have their errors routed. d.add(e); e.emit('error', new Error('emitted')); expectCaught++; // get rid of the `if (er) return cb(er)` malarky, by intercepting // the cb functions to the domain, and using the intercepted function // as a callback instead. function fn() { throw new Error('This function should never be called!'); } var bound = d.intercept(fn); bound(new Error('bound')); expectCaught++; // intercepted should never pass first argument to callback function fn2(data) { assert.strictEqual(data, 'data', 'should not be null err argument'); } bound = d.intercept(fn2); bound(null, 'data'); // intercepted should never pass first argument to callback // even if arguments length is more than 2. function fn3(data, data2) { assert.strictEqual(data, 'data', 'should not be null err argument'); assert.strictEqual(data2, 'data2', 'should not be data argument'); } bound = d.intercept(fn3); bound(null, 'data', 'data2'); // throwing in a bound fn is also caught, // even if it's asynchronous, by hitting the // global uncaughtException handler. This doesn't // require interception, since throws are always // caught by the domain. function thrower() { throw new Error('thrown'); } setTimeout(d.bind(thrower), 100); expectCaught++; // Pass an intercepted function to an fs operation that fails. fs.open('this file does not exist', 'r', d.intercept(function(er) { console.error('should not get here!', er); throw new Error('should not get here!'); }, true)); expectCaught++; // implicit addition by being created within a domain-bound context. var implicit; d.run(function() { implicit = new events.EventEmitter(); }); setTimeout(function() { // escape from the domain, but implicit is still bound to it. implicit.emit('error', new Error('implicit')); }, 10); expectCaught++; var result = d.run(function() { return 'return value'; }); assert.strictEqual(result, 'return value'); // check if the executed function take in count the applied parameters result = d.run(function(a, b) { return a + ' ' + b; }, 'return', 'value'); assert.strictEqual(result, 'return value'); var fst = fs.createReadStream('stream for nonexistent file'); d.add(fst); expectCaught++; [42, null, , false, function() {}, 'string'].forEach(function(something) { var d = new domain.Domain(); d.run(function() { process.nextTick(function() { throw something; }); expectCaught++; }); d.on('error', function(er) { assert.strictEqual(something, er); caught++; }); }); node-v4.8.2/test/parallel/test-dsa-fips-invalid-key.js000644 000766 000024 00000001000 13070706737 022757 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasFipsCrypto) { common.skip('node compiled without FIPS OpenSSL.'); return; } var crypto = require('crypto'); var fs = require('fs'); var input = 'hello'; var dsapri = fs.readFileSync(common.fixturesDir + '/keys/dsa_private_1025.pem'); var sign = crypto.createSign('DSS1'); sign.update(input); assert.throws(function() { sign.sign(dsapri); }, /PEM_read_bio_PrivateKey failed/); node-v4.8.2/test/parallel/test-error-reporting.js000644 000766 000024 00000003553 13070706737 022216 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var exec = require('child_process').exec; var path = require('path'); function errExec(script, callback) { var cmd = '"' + process.argv[0] + '" "' + path.join(common.fixturesDir, script) + '"'; return exec(cmd, function(err, stdout, stderr) { // There was some error assert.ok(err); // More than one line of error output. assert.ok(stderr.split('\n').length > 2); // Assert the script is mentioned in error output. assert.ok(stderr.indexOf(script) >= 0); // Proxy the args for more tests. callback(err, stdout, stderr); }); } // Simple throw error errExec('throws_error.js', common.mustCall(function(err, stdout, stderr) { assert.ok(/blah/.test(stderr)); })); // Trying to JSON.parse(undefined) errExec('throws_error2.js', common.mustCall(function(err, stdout, stderr) { assert.ok(/SyntaxError/.test(stderr)); })); // Trying to JSON.parse(undefined) in nextTick errExec('throws_error3.js', common.mustCall(function(err, stdout, stderr) { assert.ok(/SyntaxError/.test(stderr)); })); // throw ILLEGAL error errExec('throws_error4.js', common.mustCall(function(err, stdout, stderr) { assert.ok(/\/\*\*/.test(stderr)); assert.ok(/SyntaxError/.test(stderr)); })); // Specific long exception line doesn't result in stack overflow errExec('throws_error5.js', common.mustCall(function(err, stdout, stderr) { assert.ok(/SyntaxError/.test(stderr)); })); // Long exception line with length > errorBuffer doesn't result in assertion errExec('throws_error6.js', common.mustCall(function(err, stdout, stderr) { assert.ok(/SyntaxError/.test(stderr)); })); // Object that throws in toString() doesn't print garbage errExec('throws_error7.js', common.mustCall(function(err, stdout, stderr) { assert.ok(/foo should not be emitted'); }; e.once('foo', remove); e.removeListener('foo', remove); e.emit('foo'); e.once('e', common.mustCall(function() { e.emit('e'); })); e.once('e', common.mustCall(function() {})); e.emit('e'); node-v4.8.2/test/parallel/test-event-emitter-remove-all-listeners.js000644 000766 000024 00000005341 13070706737 025712 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const events = require('events'); function expect(expected) { const actual = []; process.on('exit', function() { assert.deepStrictEqual(actual.sort(), expected.sort()); }); function listener(name) { actual.push(name); } return common.mustCall(listener, expected.length); } function listener() {} { const ee = new events.EventEmitter(); ee.on('foo', listener); ee.on('bar', listener); ee.on('baz', listener); ee.on('baz', listener); const fooListeners = ee.listeners('foo'); const barListeners = ee.listeners('bar'); const bazListeners = ee.listeners('baz'); ee.on('removeListener', expect(['bar', 'baz', 'baz'])); ee.removeAllListeners('bar'); ee.removeAllListeners('baz'); assert.deepStrictEqual(ee.listeners('foo'), [listener]); assert.deepStrictEqual(ee.listeners('bar'), []); assert.deepStrictEqual(ee.listeners('baz'), []); // After calling removeAllListeners(), // the old listeners array should stay unchanged. assert.deepStrictEqual(fooListeners, [listener]); assert.deepStrictEqual(barListeners, [listener]); assert.deepStrictEqual(bazListeners, [listener, listener]); // After calling removeAllListeners(), // new listeners arrays is different from the old. assert.notEqual(ee.listeners('bar'), barListeners); assert.notEqual(ee.listeners('baz'), bazListeners); } { const ee = new events.EventEmitter(); ee.on('foo', listener); ee.on('bar', listener); // Expect LIFO order ee.on('removeListener', expect(['foo', 'bar', 'removeListener'])); ee.on('removeListener', expect(['foo', 'bar'])); ee.removeAllListeners(); assert.deepStrictEqual([], ee.listeners('foo')); assert.deepStrictEqual([], ee.listeners('bar')); } { const ee = new events.EventEmitter(); ee.on('removeListener', listener); // Check for regression where removeAllListeners() throws when // there exists a 'removeListener' listener, but there exists // no listeners for the provided event type. assert.doesNotThrow(ee.removeAllListeners.bind(ee, 'foo')); } { const ee = new events.EventEmitter(); var expectLength = 2; ee.on('removeListener', function(name, listener) { assert.strictEqual(expectLength--, this.listeners('baz').length); }); ee.on('baz', function() {}); ee.on('baz', function() {}); ee.on('baz', function() {}); assert.strictEqual(ee.listeners('baz').length, expectLength + 1); ee.removeAllListeners('baz'); assert.strictEqual(ee.listeners('baz').length, 0); } { const ee = new events.EventEmitter(); assert.deepStrictEqual(ee, ee.removeAllListeners()); } { const ee = new events.EventEmitter(); ee._events = undefined; assert.strictEqual(ee, ee.removeAllListeners()); } node-v4.8.2/test/parallel/test-event-emitter-remove-listeners.js000644 000766 000024 00000007406 13070706737 025150 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const events = require('events'); function listener1() {} function listener2() {} { const ee = new events.EventEmitter(); ee.on('hello', listener1); ee.on('removeListener', common.mustCall((name, cb) => { assert.strictEqual(name, 'hello'); assert.strictEqual(cb, listener1); })); ee.removeListener('hello', listener1); assert.deepStrictEqual([], ee.listeners('hello')); } { const ee = new events.EventEmitter(); ee.on('hello', listener1); ee.on('removeListener', common.fail); ee.removeListener('hello', listener2); assert.deepStrictEqual([listener1], ee.listeners('hello')); } { const ee = new events.EventEmitter(); ee.on('hello', listener1); ee.on('hello', listener2); ee.once('removeListener', common.mustCall((name, cb) => { assert.strictEqual(name, 'hello'); assert.strictEqual(cb, listener1); assert.deepStrictEqual([listener2], ee.listeners('hello')); })); ee.removeListener('hello', listener1); assert.deepStrictEqual([listener2], ee.listeners('hello')); ee.once('removeListener', common.mustCall((name, cb) => { assert.strictEqual(name, 'hello'); assert.strictEqual(cb, listener2); assert.deepStrictEqual([], ee.listeners('hello')); })); ee.removeListener('hello', listener2); assert.deepStrictEqual([], ee.listeners('hello')); } { const ee = new events.EventEmitter(); function remove1() { common.fail('remove1 should not have been called'); } function remove2() { common.fail('remove2 should not have been called'); } ee.on('removeListener', common.mustCall(function(name, cb) { if (cb !== remove1) return; this.removeListener('quux', remove2); this.emit('quux'); }, 2)); ee.on('quux', remove1); ee.on('quux', remove2); ee.removeListener('quux', remove1); } { const ee = new events.EventEmitter(); ee.on('hello', listener1); ee.on('hello', listener2); ee.once('removeListener', common.mustCall((name, cb) => { assert.strictEqual(name, 'hello'); assert.strictEqual(cb, listener1); assert.deepStrictEqual([listener2], ee.listeners('hello')); ee.once('removeListener', common.mustCall((name, cb) => { assert.strictEqual(name, 'hello'); assert.strictEqual(cb, listener2); assert.deepStrictEqual([], ee.listeners('hello')); })); ee.removeListener('hello', listener2); assert.deepStrictEqual([], ee.listeners('hello')); })); ee.removeListener('hello', listener1); assert.deepStrictEqual([], ee.listeners('hello')); } { const ee = new events.EventEmitter(); const listener3 = common.mustCall(() => { ee.removeListener('hello', listener4); }, 2); const listener4 = common.mustCall(() => {}); ee.on('hello', listener3); ee.on('hello', listener4); // listener4 will still be called although it is removed by listener 3. ee.emit('hello'); // This is so because the interal listener array at time of emit // was [listener3,listener4] // Interal listener array [listener3] ee.emit('hello'); } { const ee = new events.EventEmitter(); ee.once('hello', listener1); ee.on('removeListener', common.mustCall((eventName, listener) => { assert.strictEqual(eventName, 'hello'); assert.strictEqual(listener, listener1); })); ee.emit('hello'); } { const ee = new events.EventEmitter(); assert.deepStrictEqual(ee, ee.removeListener('foo', () => {})); } // Verify that the removed listener must be a function assert.throws(() => { const ee = new events.EventEmitter(); ee.removeListener('foo', null); }, /^TypeError: listener must be a function$/); { const ee = new events.EventEmitter(); const listener = () => {}; ee._events = undefined; const e = ee.removeListener('foo', listener); assert.strictEqual(e, ee); } node-v4.8.2/test/parallel/test-event-emitter-set-max-listeners-side-effects.js000644 000766 000024 00000000341 13070706737 027557 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var events = require('events'); var e = new events.EventEmitter(); assert.deepEqual(e._events, {}); e.setMaxListeners(5); assert.deepEqual(e._events, {}); node-v4.8.2/test/parallel/test-event-emitter-subclass.js000644 000766 000024 00000001501 13070706737 023452 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var EventEmitter = require('events').EventEmitter; var util = require('util'); util.inherits(MyEE, EventEmitter); function MyEE(cb) { this.once(1, cb); this.emit(1); this.removeAllListeners(); EventEmitter.call(this); } var myee = new MyEE(common.mustCall(function() {})); util.inherits(ErrorEE, EventEmitter); function ErrorEE() { this.emit('error', new Error('blerg')); } assert.throws(function() { new ErrorEE(); }, /blerg/); process.on('exit', function() { assert.deepEqual(myee._events, {}); console.log('ok'); }); function MyEE2() { EventEmitter.call(this); } MyEE2.prototype = new EventEmitter(); var ee1 = new MyEE2(); var ee2 = new MyEE2(); ee1.on('x', function() {}); assert.equal(ee2.listenerCount('x'), 0); node-v4.8.2/test/parallel/test-event-emitter-symbols.js000644 000766 000024 00000001030 13070706737 023320 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const EventEmitter = require('events'); const assert = require('assert'); const ee = new EventEmitter(); const foo = Symbol('foo'); const listener = common.mustCall(function() {}); ee.on(foo, listener); assert.deepEqual(ee.listeners(foo), [listener]); ee.emit(foo); ee.removeAllListeners(); assert.deepEqual(ee.listeners(foo), []); ee.on(foo, listener); assert.deepEqual(ee.listeners(foo), [listener]); ee.removeListener(foo, listener); assert.deepEqual(ee.listeners(foo), []); node-v4.8.2/test/parallel/test-exception-handler.js000644 000766 000024 00000000726 13070706737 022466 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var MESSAGE = 'catch me if you can'; process.on('uncaughtException', common.mustCall(function(e) { console.log('uncaught exception! 1'); assert.equal(MESSAGE, e.message); })); process.on('uncaughtException', common.mustCall(function(e) { console.log('uncaught exception! 2'); assert.equal(MESSAGE, e.message); })); setTimeout(function() { throw new Error(MESSAGE); }, 10); node-v4.8.2/test/parallel/test-exception-handler2.js000644 000766 000024 00000000574 13070706737 022551 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); process.on('uncaughtException', function(err) { console.log('Caught exception: ' + err); }); setTimeout(common.mustCall(function() { console.log('This will still run.'); }), 50); // Intentionally cause an exception, but don't catch it. nonexistentFunc(); // eslint-disable-line no-undef common.fail('This will not run.'); node-v4.8.2/test/parallel/test-file-read-noexist.js000644 000766 000024 00000000447 13070706737 022374 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var path = require('path'); var fs = require('fs'); var filename = path.join(common.fixturesDir, 'does_not_exist.txt'); fs.readFile(filename, 'raw', common.mustCall(function(err, content) { assert.ok(err); })); node-v4.8.2/test/parallel/test-file-write-stream.js000644 000766 000024 00000002722 13070706737 022413 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var path = require('path'); var fs = require('fs'); var fn = path.join(common.tmpDir, 'write.txt'); common.refreshTmpDir(); var file = fs.createWriteStream(fn, { highWaterMark: 10 }); var EXPECTED = '012345678910'; var callbacks = { open: -1, drain: -2, close: -1 }; file .on('open', function(fd) { console.error('open!'); callbacks.open++; assert.equal('number', typeof fd); }) .on('error', function(err) { throw err; }) .on('drain', function() { console.error('drain!', callbacks.drain); callbacks.drain++; if (callbacks.drain == -1) { assert.equal(EXPECTED, fs.readFileSync(fn, 'utf8')); file.write(EXPECTED); } else if (callbacks.drain == 0) { assert.equal(EXPECTED + EXPECTED, fs.readFileSync(fn, 'utf8')); file.end(); } }) .on('close', function() { console.error('close!'); assert.strictEqual(file.bytesWritten, EXPECTED.length * 2); callbacks.close++; assert.throws(function() { console.error('write after end should not be allowed'); file.write('should not work anymore'); }, /^Error: write after end$/); fs.unlinkSync(fn); }); for (var i = 0; i < 11; i++) { (function(i) { file.write('' + i); })(i); } process.on('exit', function() { for (var k in callbacks) { assert.equal(0, callbacks[k], k + ' count off by ' + callbacks[k]); } console.log('ok'); }); node-v4.8.2/test/parallel/test-file-write-stream2.js000644 000766 000024 00000004124 13070706737 022473 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var path = require('path'); var fs = require('fs'); var filepath = path.join(common.tmpDir, 'write.txt'); var file; var EXPECTED = '012345678910'; var cb_expected = 'write open drain write drain close error '; var cb_occurred = ''; var countDrains = 0; process.on('exit', function() { removeTestFile(); if (cb_occurred !== cb_expected) { console.log(' Test callback events missing or out of order:'); console.log(' expected: %j', cb_expected); console.log(' occurred: %j', cb_occurred); assert.strictEqual(cb_occurred, cb_expected, 'events missing or out of order: "' + cb_occurred + '" !== "' + cb_expected + '"'); } else { console.log('ok'); } }); function removeTestFile() { try { fs.unlinkSync(filepath); } catch (e) {} } common.refreshTmpDir(); // drain at 0, return false at 10. file = fs.createWriteStream(filepath, { highWaterMark: 11 }); file.on('open', function(fd) { console.error('open'); cb_occurred += 'open '; assert.equal(typeof fd, 'number'); }); file.on('drain', function() { console.error('drain'); cb_occurred += 'drain '; ++countDrains; if (countDrains === 1) { console.error('drain=1, write again'); assert.equal(fs.readFileSync(filepath, 'utf8'), EXPECTED); console.error('ondrain write ret=%j', file.write(EXPECTED)); cb_occurred += 'write '; } else if (countDrains == 2) { console.error('second drain, end'); assert.equal(fs.readFileSync(filepath, 'utf8'), EXPECTED + EXPECTED); file.end(); } }); file.on('close', function() { cb_occurred += 'close '; assert.strictEqual(file.bytesWritten, EXPECTED.length * 2); file.write('should not work anymore'); }); file.on('error', function(err) { cb_occurred += 'error '; assert.ok(err.message.indexOf('write after end') >= 0); }); for (var i = 0; i < 11; i++) { var ret = file.write(i + ''); console.error('%d %j', i, ret); // return false when i hits 10 assert(ret === (i != 10)); } cb_occurred += 'write '; node-v4.8.2/test/parallel/test-file-write-stream3.js000644 000766 000024 00000011004 13070706737 022467 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const path = require('path'); const fs = require('fs'); const filepath = path.join(common.tmpDir, 'write_pos.txt'); const cb_expected = 'write open close write open close write open close '; let cb_occurred = ''; const fileDataInitial = 'abcdefghijklmnopqrstuvwxyz'; const fileDataExpected_1 = 'abcdefghijklmnopqrstuvwxyz'; const fileDataExpected_2 = 'abcdefghij123456qrstuvwxyz'; const fileDataExpected_3 = 'abcdefghij\u2026\u2026qrstuvwxyz'; process.on('exit', function() { if (cb_occurred !== cb_expected) { console.log(' Test callback events missing or out of order:'); console.log(' expected: %j', cb_expected); console.log(' occurred: %j', cb_occurred); assert.strictEqual(cb_occurred, cb_expected, 'events missing or out of order: "' + cb_occurred + '" !== "' + cb_expected + '"'); } }); common.refreshTmpDir(); function run_test_1() { const options = {}; const file = fs.createWriteStream(filepath, options); console.log(' (debug: start ', file.start); console.log(' (debug: pos ', file.pos); file.on('open', function(fd) { cb_occurred += 'open '; }); file.on('close', function() { cb_occurred += 'close '; console.log(' (debug: bytesWritten ', file.bytesWritten); console.log(' (debug: start ', file.start); console.log(' (debug: pos ', file.pos); assert.strictEqual(file.bytesWritten, buffer.length); const fileData = fs.readFileSync(filepath, 'utf8'); console.log(' (debug: file data ', fileData); console.log(' (debug: expected ', fileDataExpected_1); assert.strictEqual(fileData, fileDataExpected_1); run_test_2(); }); file.on('error', function(err) { cb_occurred += 'error '; console.log(' (debug: err event ', err); throw err; }); const buffer = Buffer.from(fileDataInitial); file.write(buffer); cb_occurred += 'write '; file.end(); } function run_test_2() { const buffer = Buffer.from('123456'); const options = { start: 10, flags: 'r+' }; const file = fs.createWriteStream(filepath, options); console.log(' (debug: start ', file.start); console.log(' (debug: pos ', file.pos); file.on('open', function(fd) { cb_occurred += 'open '; }); file.on('close', function() { cb_occurred += 'close '; console.log(' (debug: bytesWritten ', file.bytesWritten); console.log(' (debug: start ', file.start); console.log(' (debug: pos ', file.pos); assert.strictEqual(file.bytesWritten, buffer.length); const fileData = fs.readFileSync(filepath, 'utf8'); console.log(' (debug: file data ', fileData); console.log(' (debug: expected ', fileDataExpected_2); assert.strictEqual(fileData, fileDataExpected_2); run_test_3(); }); file.on('error', function(err) { cb_occurred += 'error '; console.log(' (debug: err event ', err); throw err; }); file.write(buffer); cb_occurred += 'write '; file.end(); } function run_test_3() { const data = '\u2026\u2026'; // 3 bytes * 2 = 6 bytes in UTF-8 const options = { start: 10, flags: 'r+' }; const file = fs.createWriteStream(filepath, options); console.log(' (debug: start ', file.start); console.log(' (debug: pos ', file.pos); file.on('open', function(fd) { cb_occurred += 'open '; }); file.on('close', function() { cb_occurred += 'close '; console.log(' (debug: bytesWritten ', file.bytesWritten); console.log(' (debug: start ', file.start); console.log(' (debug: pos ', file.pos); assert.strictEqual(file.bytesWritten, data.length * 3); const fileData = fs.readFileSync(filepath, 'utf8'); console.log(' (debug: file data ', fileData); console.log(' (debug: expected ', fileDataExpected_3); assert.strictEqual(fileData, fileDataExpected_3); run_test_4(); }); file.on('error', function(err) { cb_occurred += 'error '; console.log(' (debug: err event ', err); throw err; }); file.write(data, 'utf8'); cb_occurred += 'write '; file.end(); } const run_test_4 = common.mustCall(function() { // Error: start must be >= zero assert.throws( function() { fs.createWriteStream(filepath, { start: -5, flags: 'r+' }); }, /start must be/ ); }); run_test_1(); node-v4.8.2/test/parallel/test-force-repl.js000644 000766 000024 00000001047 13070706737 021110 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const spawn = require('child_process').spawn; // spawn a node child process in "interactive" mode (force the repl) const cp = spawn(process.execPath, ['-i']); var timeoutId = setTimeout(function() { common.fail('timeout!'); }, common.platformTimeout(5000)); // give node + the repl 5 seconds to start cp.stdout.setEncoding('utf8'); cp.stdout.once('data', common.mustCall(function(b) { clearTimeout(timeoutId); assert.strictEqual(b, '> '); cp.kill(); })); node-v4.8.2/test/parallel/test-freelist.js000644 000766 000024 00000002101 13070706737 020657 0ustar00iojsstaff000000 000000 'use strict'; // Flags: --expose-internals require('../common'); const assert = require('assert'); const freelist = require('freelist'); const internalFreelist = require('internal/freelist'); assert.equal(typeof freelist, 'object'); assert.equal(typeof freelist.FreeList, 'function'); assert.strictEqual(freelist, internalFreelist); const flist1 = new freelist.FreeList('flist1', 3, String); // Allocating when empty, should not change the list size var result = flist1.alloc('test'); assert.strictEqual(typeof result, 'string'); assert.strictEqual(result, 'test'); assert.strictEqual(flist1.list.length, 0); // Exhaust the free list assert(flist1.free('test1')); assert(flist1.free('test2')); assert(flist1.free('test3')); // Now it should not return 'true', as max length is exceeded assert.strictEqual(flist1.free('test4'), false); assert.strictEqual(flist1.free('test5'), false); // At this point 'alloc' should just return the stored values assert.strictEqual(flist1.alloc(), 'test3'); assert.strictEqual(flist1.alloc(), 'test2'); assert.strictEqual(flist1.alloc(), 'test1'); node-v4.8.2/test/parallel/test-fs-access.js000644 000766 000024 00000007177 13070706737 020733 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var fs = require('fs'); var path = require('path'); var doesNotExist = path.join(common.tmpDir, '__this_should_not_exist'); var readOnlyFile = path.join(common.tmpDir, 'read_only_file'); var readWriteFile = path.join(common.tmpDir, 'read_write_file'); var removeFile = function(file) { try { fs.unlinkSync(file); } catch (err) { // Ignore error } }; var createFileWithPerms = function(file, mode) { removeFile(file); fs.writeFileSync(file, ''); fs.chmodSync(file, mode); }; common.refreshTmpDir(); createFileWithPerms(readOnlyFile, 0o444); createFileWithPerms(readWriteFile, 0o666); /* * On non-Windows supported platforms, fs.access(readOnlyFile, W_OK, ...) * always succeeds if node runs as the super user, which is sometimes the * case for tests running on our continuous testing platform agents. * * In this case, this test tries to change its process user id to a * non-superuser user so that the test that checks for write access to a * read-only file can be more meaningful. * * The change of user id is done after creating the fixtures files for the same * reason: the test may be run as the superuser within a directory in which * only the superuser can create files, and thus it may need superuser * priviledges to create them. * * There's not really any point in resetting the process' user id to 0 after * changing it to 'nobody', since in the case that the test runs without * superuser priviledge, it is not possible to change its process user id to * superuser. * * It can prevent the test from removing files created before the change of user * id, but that's fine. In this case, it is the responsability of the * continuous integration platform to take care of that. */ var hasWriteAccessForReadonlyFile = false; if (!common.isWindows && process.getuid() === 0) { hasWriteAccessForReadonlyFile = true; try { process.setuid('nobody'); hasWriteAccessForReadonlyFile = false; } catch (err) { } } assert(typeof fs.F_OK === 'number'); assert(typeof fs.R_OK === 'number'); assert(typeof fs.W_OK === 'number'); assert(typeof fs.X_OK === 'number'); fs.access(__filename, function(err) { assert.strictEqual(err, null, 'error should not exist'); }); fs.access(__filename, fs.R_OK, function(err) { assert.strictEqual(err, null, 'error should not exist'); }); fs.access(doesNotExist, function(err) { assert.notEqual(err, null, 'error should exist'); assert.strictEqual(err.code, 'ENOENT'); assert.strictEqual(err.path, doesNotExist); }); fs.access(readOnlyFile, fs.F_OK | fs.R_OK, function(err) { assert.strictEqual(err, null, 'error should not exist'); }); fs.access(readOnlyFile, fs.W_OK, function(err) { if (hasWriteAccessForReadonlyFile) { assert.equal(err, null, 'error should not exist'); } else { assert.notEqual(err, null, 'error should exist'); assert.strictEqual(err.path, readOnlyFile); } }); assert.throws(function() { fs.access(100, fs.F_OK, function(err) {}); }, /path must be a string/); assert.throws(function() { fs.access(__filename, fs.F_OK); }, /callback must be a function/); assert.throws(function() { fs.access(__filename, fs.F_OK, {}); }, /callback must be a function/); assert.doesNotThrow(function() { fs.accessSync(__filename); }); assert.doesNotThrow(function() { var mode = fs.F_OK | fs.R_OK | fs.W_OK; fs.accessSync(readWriteFile, mode); }); assert.throws(function() { fs.accessSync(doesNotExist); }, function(err) { return err.code === 'ENOENT' && err.path === doesNotExist; }); process.on('exit', function() { removeFile(readOnlyFile); removeFile(readWriteFile); }); node-v4.8.2/test/parallel/test-fs-append-file-sync.js000644 000766 000024 00000005302 13070706737 022614 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var join = require('path').join; var fs = require('fs'); var currentFileData = 'ABCD'; var num = 220; var data = '南越国是前203年至前111年存在于岭南地区的一个国家，国都位于番禺，疆域包括今天中国的广东、' + '广西两省区的大部份地区，福建省、湖南、贵州、云南的一小部份地区和越南的北部。' + '南越国是秦朝灭亡后，由南海郡尉赵佗于前203年起兵兼并桂林郡和象郡后建立。' + '前196年和前179年，南越国曾先后两次名义上臣属于西汉，成为西汉的“外臣”。前112年，' + '南越国末代君主赵建德与西汉发生战争，被汉武帝于前111年所灭。南越国共存在93年，' + '历经五代君主。南越国是岭南地区的第一个有记载的政权国家，采用封建制和郡县制并存的制度，' + '它的建立保证了秦末乱世岭南地区社会秩序的稳定，有效的改善了岭南地区落后的政治、##济现状。\n'; common.refreshTmpDir(); // test that empty file will be created and have content added var filename = join(common.tmpDir, 'append-sync.txt'); fs.appendFileSync(filename, data); var fileData = fs.readFileSync(filename); assert.equal(Buffer.byteLength(data), fileData.length); // test that appends data to a non empty file var filename2 = join(common.tmpDir, 'append-sync2.txt'); fs.writeFileSync(filename2, currentFileData); fs.appendFileSync(filename2, data); var fileData2 = fs.readFileSync(filename2); assert.equal(Buffer.byteLength(data) + currentFileData.length, fileData2.length); // test that appendFileSync accepts buffers var filename3 = join(common.tmpDir, 'append-sync3.txt'); fs.writeFileSync(filename3, currentFileData); var buf = new Buffer(data, 'utf8'); fs.appendFileSync(filename3, buf); var fileData3 = fs.readFileSync(filename3); assert.equal(buf.length + currentFileData.length, fileData3.length); // test that appendFile accepts numbers. var filename4 = join(common.tmpDir, 'append-sync4.txt'); fs.writeFileSync(filename4, currentFileData, { mode: m }); var m = 0o600; fs.appendFileSync(filename4, num, { mode: m }); // windows permissions aren't unix if (!common.isWindows) { var st = fs.statSync(filename4); assert.equal(st.mode & 0o700, m); } var fileData4 = fs.readFileSync(filename4); assert.equal(Buffer.byteLength('' + num) + currentFileData.length, fileData4.length); //exit logic for cleanup process.on('exit', function() { fs.unlinkSync(filename); fs.unlinkSync(filename2); fs.unlinkSync(filename3); fs.unlinkSync(filename4); }); node-v4.8.2/test/parallel/test-fs-append-file.js000644 000766 000024 00000006016 13070706737 021645 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var fs = require('fs'); var join = require('path').join; var filename = join(common.tmpDir, 'append.txt'); var currentFileData = 'ABCD'; var n = 220; var s = '南越国是前203年至前111年存在于岭南地区的一个国家，国都位于番禺，疆域包括今天中国的广东、' + '广西两省区的大部份地区，福建省、湖南、贵州、云南的一小部份地区和越南的北部。' + '南越国是秦朝灭亡后，由南海郡尉赵佗于前203年起兵兼并桂林郡和象郡后建立。' + '前196年和前179年，南越国曾先后两次名义上臣属于西汉，成为西汉的“外臣”。前112年，' + '南越国末代君主赵建德与西汉发生战争，被汉武帝于前111年所灭。南越国共存在93年，' + '历经五代君主。南越国是岭南地区的第一个有记载的政权国家，采用封建制和郡县制并存的制度，' + '它的建立保证了秦末乱世岭南地区社会秩序的稳定，有效的改善了岭南地区落后的政治、##济现状。\n'; var ncallbacks = 0; common.refreshTmpDir(); // test that empty file will be created and have content added fs.appendFile(filename, s, function(e) { if (e) throw e; ncallbacks++; fs.readFile(filename, function(e, buffer) { if (e) throw e; ncallbacks++; assert.equal(Buffer.byteLength(s), buffer.length); }); }); // test that appends data to a non empty file var filename2 = join(common.tmpDir, 'append2.txt'); fs.writeFileSync(filename2, currentFileData); fs.appendFile(filename2, s, function(e) { if (e) throw e; ncallbacks++; fs.readFile(filename2, function(e, buffer) { if (e) throw e; ncallbacks++; assert.equal(Buffer.byteLength(s) + currentFileData.length, buffer.length); }); }); // test that appendFile accepts buffers var filename3 = join(common.tmpDir, 'append3.txt'); fs.writeFileSync(filename3, currentFileData); var buf = new Buffer(s, 'utf8'); fs.appendFile(filename3, buf, function(e) { if (e) throw e; ncallbacks++; fs.readFile(filename3, function(e, buffer) { if (e) throw e; ncallbacks++; assert.equal(buf.length + currentFileData.length, buffer.length); }); }); // test that appendFile accepts numbers. var filename4 = join(common.tmpDir, 'append4.txt'); fs.writeFileSync(filename4, currentFileData); var m = 0o600; fs.appendFile(filename4, n, { mode: m }, function(e) { if (e) throw e; ncallbacks++; // windows permissions aren't unix if (!common.isWindows) { var st = fs.statSync(filename4); assert.equal(st.mode & 0o700, m); } fs.readFile(filename4, function(e, buffer) { if (e) throw e; ncallbacks++; assert.equal(Buffer.byteLength('' + n) + currentFileData.length, buffer.length); }); }); process.on('exit', function() { assert.equal(8, ncallbacks); fs.unlinkSync(filename); fs.unlinkSync(filename2); fs.unlinkSync(filename3); fs.unlinkSync(filename4); }); node-v4.8.2/test/parallel/test-fs-chmod.js000644 000766 000024 00000005352 13070706737 020555 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const path = require('path'); const fs = require('fs'); let mode_async; let mode_sync; // Need to hijack fs.open/close to make sure that things // get closed once they're opened. fs._open = fs.open; fs._openSync = fs.openSync; fs.open = open; fs.openSync = openSync; fs._close = fs.close; fs._closeSync = fs.closeSync; fs.close = close; fs.closeSync = closeSync; let openCount = 0; function open() { openCount++; return fs._open.apply(fs, arguments); } function openSync() { openCount++; return fs._openSync.apply(fs, arguments); } function close() { openCount--; return fs._close.apply(fs, arguments); } function closeSync() { openCount--; return fs._closeSync.apply(fs, arguments); } // On Windows chmod is only able to manipulate read-only bit if (common.isWindows) { mode_async = 0o400; // read-only mode_sync = 0o600; // read-write } else { mode_async = 0o777; mode_sync = 0o644; } const file1 = path.join(common.fixturesDir, 'a.js'); const file2 = path.join(common.fixturesDir, 'a1.js'); fs.chmod(file1, mode_async.toString(8), common.mustCall((err) => { assert.ifError(err); console.log(fs.statSync(file1).mode); if (common.isWindows) { assert.ok((fs.statSync(file1).mode & 0o777) & mode_async); } else { assert.strictEqual(mode_async, fs.statSync(file1).mode & 0o777); } fs.chmodSync(file1, mode_sync); if (common.isWindows) { assert.ok((fs.statSync(file1).mode & 0o777) & mode_sync); } else { assert.strictEqual(mode_sync, fs.statSync(file1).mode & 0o777); } })); fs.open(file2, 'a', common.mustCall((err, fd) => { assert.ifError(err); fs.fchmod(fd, mode_async.toString(8), common.mustCall((err) => { assert.ifError(err); console.log(fs.fstatSync(fd).mode); if (common.isWindows) { assert.ok((fs.fstatSync(fd).mode & 0o777) & mode_async); } else { assert.strictEqual(mode_async, fs.fstatSync(fd).mode & 0o777); } fs.fchmodSync(fd, mode_sync); if (common.isWindows) { assert.ok((fs.fstatSync(fd).mode & 0o777) & mode_sync); } else { assert.strictEqual(mode_sync, fs.fstatSync(fd).mode & 0o777); } fs.close(fd); })); })); // lchmod if (fs.lchmod) { var link = path.join(common.tmpDir, 'symbolic-link'); common.refreshTmpDir(); fs.symlinkSync(file2, link); fs.lchmod(link, mode_async, common.mustCall((err) => { assert.ifError(err); console.log(fs.lstatSync(link).mode); assert.strictEqual(mode_async, fs.lstatSync(link).mode & 0o777); fs.lchmodSync(link, mode_sync); assert.strictEqual(mode_sync, fs.lstatSync(link).mode & 0o777); })); } process.on('exit', function() { assert.strictEqual(0, openCount); }); node-v4.8.2/test/parallel/test-fs-empty-readStream.js000644 000766 000024 00000001716 13070706737 022706 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const path = require('path'); const fs = require('fs'); const emptyFile = path.join(common.fixturesDir, 'empty.txt'); fs.open(emptyFile, 'r', common.mustCall((error, fd) => { assert.ifError(error); const read = fs.createReadStream(emptyFile, { 'fd': fd }); read.once('data', () => { throw new Error('data event should not emit'); }); read.once('end', common.mustCall(function endEvent1() {})); })); fs.open(emptyFile, 'r', common.mustCall((error, fd) => { assert.ifError(error); const read = fs.createReadStream(emptyFile, { 'fd': fd }); read.pause(); read.once('data', () => { throw new Error('data event should not emit'); }); read.once('end', function endEvent2() { throw new Error('end event should not emit'); }); setTimeout(common.mustCall(() => { assert.strictEqual(read.isPaused(), true); }), common.platformTimeout(50)); })); node-v4.8.2/test/parallel/test-fs-error-messages.js000644 000766 000024 00000010577 13070706737 022426 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const path = require('path'); const fs = require('fs'); const fn = path.join(common.fixturesDir, 'non-existent'); const existingFile = path.join(common.fixturesDir, 'exit.js'); const existingFile2 = path.join(common.fixturesDir, 'create-file.js'); const existingDir = path.join(common.fixturesDir, 'empty'); const existingDir2 = path.join(common.fixturesDir, 'keys'); // ASYNC_CALL fs.stat(fn, function(err) { assert.equal(fn, err.path); assert.ok(0 <= err.message.indexOf(fn)); }); fs.lstat(fn, function(err) { assert.ok(0 <= err.message.indexOf(fn)); }); fs.readlink(fn, function(err) { assert.ok(0 <= err.message.indexOf(fn)); }); fs.link(fn, 'foo', function(err) { assert.ok(0 <= err.message.indexOf(fn)); }); fs.link(existingFile, existingFile2, function(err) { assert.ok(0 <= err.message.indexOf(existingFile)); assert.ok(0 <= err.message.indexOf(existingFile2)); }); fs.symlink(existingFile, existingFile2, function(err) { assert.ok(0 <= err.message.indexOf(existingFile)); assert.ok(0 <= err.message.indexOf(existingFile2)); }); fs.unlink(fn, function(err) { assert.ok(0 <= err.message.indexOf(fn)); }); fs.rename(fn, 'foo', function(err) { assert.ok(0 <= err.message.indexOf(fn)); }); fs.rename(existingDir, existingDir2, function(err) { assert.ok(0 <= err.message.indexOf(existingDir)); assert.ok(0 <= err.message.indexOf(existingDir2)); }); fs.rmdir(fn, function(err) { assert.ok(0 <= err.message.indexOf(fn)); }); fs.mkdir(existingFile, 0o666, function(err) { assert.ok(0 <= err.message.indexOf(existingFile)); }); fs.rmdir(existingFile, function(err) { assert.ok(0 <= err.message.indexOf(existingFile)); }); fs.chmod(fn, 0o666, function(err) { assert.ok(0 <= err.message.indexOf(fn)); }); fs.open(fn, 'r', 0o666, function(err) { assert.ok(0 <= err.message.indexOf(fn)); }); fs.readFile(fn, function(err) { assert.ok(0 <= err.message.indexOf(fn)); }); // Sync const errors = []; let expected = 0; try { ++expected; fs.statSync(fn); } catch (err) { errors.push('stat'); assert.ok(0 <= err.message.indexOf(fn)); } try { ++expected; fs.mkdirSync(existingFile, 0o666); } catch (err) { errors.push('mkdir'); assert.ok(0 <= err.message.indexOf(existingFile)); } try { ++expected; fs.chmodSync(fn, 0o666); } catch (err) { errors.push('chmod'); assert.ok(0 <= err.message.indexOf(fn)); } try { ++expected; fs.lstatSync(fn); } catch (err) { errors.push('lstat'); assert.ok(0 <= err.message.indexOf(fn)); } try { ++expected; fs.readlinkSync(fn); } catch (err) { errors.push('readlink'); assert.ok(0 <= err.message.indexOf(fn)); } try { ++expected; fs.linkSync(fn, 'foo'); } catch (err) { errors.push('link'); assert.ok(0 <= err.message.indexOf(fn)); } try { ++expected; fs.linkSync(existingFile, existingFile2); } catch (err) { errors.push('link'); assert.ok(0 <= err.message.indexOf(existingFile)); assert.ok(0 <= err.message.indexOf(existingFile2)); } try { ++expected; fs.symlinkSync(existingFile, existingFile2); } catch (err) { errors.push('symlink'); assert.ok(0 <= err.message.indexOf(existingFile)); assert.ok(0 <= err.message.indexOf(existingFile2)); } try { ++expected; fs.unlinkSync(fn); } catch (err) { errors.push('unlink'); assert.ok(0 <= err.message.indexOf(fn)); } try { ++expected; fs.rmdirSync(fn); } catch (err) { errors.push('rmdir'); assert.ok(0 <= err.message.indexOf(fn)); } try { ++expected; fs.rmdirSync(existingFile); } catch (err) { errors.push('rmdir'); assert.ok(0 <= err.message.indexOf(existingFile)); } try { ++expected; fs.openSync(fn, 'r'); } catch (err) { errors.push('opens'); assert.ok(0 <= err.message.indexOf(fn)); } try { ++expected; fs.renameSync(fn, 'foo'); } catch (err) { errors.push('rename'); assert.ok(0 <= err.message.indexOf(fn)); } try { ++expected; fs.renameSync(existingDir, existingDir2); } catch (err) { errors.push('rename'); assert.ok(0 <= err.message.indexOf(existingDir)); assert.ok(0 <= err.message.indexOf(existingDir2)); } try { ++expected; fs.readdirSync(fn); } catch (err) { errors.push('readdir'); assert.ok(0 <= err.message.indexOf(fn)); } process.on('exit', function() { assert.equal(expected, errors.length, 'Test fs sync exceptions raised, got ' + errors.length + ' expected ' + expected); }); node-v4.8.2/test/parallel/test-fs-exists.js000644 000766 000024 00000000546 13070706737 021002 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var fs = require('fs'); var f = __filename; fs.exists(f, common.mustCall(function(y) { assert.strictEqual(y, true); })); fs.exists(f + '-NO', common.mustCall(function(y) { assert.strictEqual(y, false); })); assert(fs.existsSync(f)); assert(!fs.existsSync(f + '-NO')); node-v4.8.2/test/parallel/test-fs-fsync.js000644 000766 000024 00000000765 13070706737 020610 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const path = require('path'); const fs = require('fs'); const file = path.join(common.fixturesDir, 'a.js'); fs.open(file, 'a', 0o777, common.mustCall(function(err, fd) { assert.ifError(err); fs.fdatasyncSync(fd); fs.fsyncSync(fd); fs.fdatasync(fd, common.mustCall(function(err) { assert.ifError(err); fs.fsync(fd, common.mustCall(function(err) { assert.ifError(err); })); })); })); node-v4.8.2/test/parallel/test-fs-link.js000644 000766 000024 00000001111 13070706737 020405 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const path = require('path'); const fs = require('fs'); common.refreshTmpDir(); // test creating and reading hard link const srcPath = path.join(common.tmpDir, 'hardlink-target.txt'); const dstPath = path.join(common.tmpDir, 'link1.js'); fs.writeFileSync(srcPath, 'hello world'); const callback = function(err) { if (err) throw err; const dstContent = fs.readFileSync(dstPath, 'utf8'); assert.strictEqual('hello world', dstContent); }; fs.link(srcPath, dstPath, common.mustCall(callback)); node-v4.8.2/test/parallel/test-fs-long-path.js000644 000766 000024 00000001414 13070706737 021347 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var fs = require('fs'); var path = require('path'); if (!common.isWindows) { common.skip('this test is Windows-specific.'); return; } // make a path that will be at least 260 chars long. var fileNameLen = Math.max(260 - common.tmpDir.length - 1, 1); var fileName = path.join(common.tmpDir, new Array(fileNameLen + 1).join('x')); var fullPath = path.resolve(fileName); common.refreshTmpDir(); console.log({ filenameLength: fileName.length, fullPathLength: fullPath.length }); fs.writeFile(fullPath, 'ok', common.mustCall(function(err) { if (err) throw err; fs.stat(fullPath, common.mustCall(function(err, stats) { if (err) throw err; })); })); process.on('exit', function() { fs.unlinkSync(fullPath); }); node-v4.8.2/test/parallel/test-fs-make-callback.js000644 000766 000024 00000001275 13070706737 022132 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var fs = require('fs'); function test(cb) { return function() { // fs.stat() calls makeCallback() on its second argument fs.stat(__filename, cb); }; } // Verify the case where a callback function is provided assert.doesNotThrow(test(function() {})); // Passing undefined calls rethrow() internally, which is fine assert.doesNotThrow(test(undefined)); // Anything else should throw assert.throws(test(null)); assert.throws(test(true)); assert.throws(test(false)); assert.throws(test(1)); assert.throws(test(0)); assert.throws(test('foo')); assert.throws(test(/foo/)); assert.throws(test([])); assert.throws(test({})); node-v4.8.2/test/parallel/test-fs-mkdir-rmdir.js000644 000766 000024 00000001763 13070706737 021706 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const path = require('path'); const fs = require('fs'); const d = path.join(common.tmpDir, 'dir'); common.refreshTmpDir(); // Make sure the directory does not exist assert(!common.fileExists(d)); // Create the directory now fs.mkdirSync(d); // Make sure the directory exists assert(common.fileExists(d)); // Try creating again, it should fail with EEXIST assert.throws(function() { fs.mkdirSync(d); }, /EEXIST: file already exists, mkdir/); // Remove the directory now fs.rmdirSync(d); // Make sure the directory does not exist assert(!common.fileExists(d)); // Similarly test the Async version fs.mkdir(d, 0o666, function(err) { assert.ifError(err); fs.mkdir(d, 0o666, function(err) { assert.ok(err.message.match(/^EEXIST/), 'got EEXIST message'); assert.equal(err.code, 'EEXIST', 'got EEXIST code'); assert.equal(err.path, d, 'got proper path for EEXIST'); fs.rmdir(d, assert.ifError); }); }); node-v4.8.2/test/parallel/test-fs-mkdir.js000644 000766 000024 00000002351 13070706737 020565 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var fs = require('fs'); function unlink(pathname) { try { fs.rmdirSync(pathname); } catch (e) { } } common.refreshTmpDir(); (function() { var ncalls = 0; var pathname = common.tmpDir + '/test1'; unlink(pathname); fs.mkdir(pathname, function(err) { assert.equal(err, null); assert.equal(common.fileExists(pathname), true); ncalls++; }); process.on('exit', function() { unlink(pathname); assert.equal(ncalls, 1); }); })(); (function() { var ncalls = 0; var pathname = common.tmpDir + '/test2'; unlink(pathname); fs.mkdir(pathname, 0o777, function(err) { assert.equal(err, null); assert.equal(common.fileExists(pathname), true); ncalls++; }); process.on('exit', function() { unlink(pathname); assert.equal(ncalls, 1); }); })(); (function() { var pathname = common.tmpDir + '/test3'; unlink(pathname); fs.mkdirSync(pathname); var exists = common.fileExists(pathname); unlink(pathname); assert.equal(exists, true); })(); // Keep the event loop alive so the async mkdir() requests // have a chance to run (since they don't ref the event loop). process.nextTick(function() {}); node-v4.8.2/test/parallel/test-fs-mkdtemp.js000644 000766 000024 00000001373 13070706737 021123 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const fs = require('fs'); const path = require('path'); const Buffer = require('buffer').Buffer; common.refreshTmpDir(); const tmpFolder = fs.mkdtempSync(path.join(common.tmpDir, 'foo.')); assert(path.basename(tmpFolder).length === 'foo.XXXXXX'.length); assert(common.fileExists(tmpFolder)); const utf8 = fs.mkdtempSync(path.join(common.tmpDir, '\u0222abc.')); assert.equal(Buffer.byteLength(path.basename(utf8)), Buffer.byteLength('\u0222abc.XXXXXX')); assert(common.fileExists(utf8)); fs.mkdtemp( path.join(common.tmpDir, 'bar.'), common.mustCall(function(err, folder) { assert.ifError(err); assert(common.fileExists(folder)); }) ); node-v4.8.2/test/parallel/test-fs-non-number-arguments-throw.js000644 000766 000024 00000002257 13070706737 024710 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const fs = require('fs'); const path = require('path'); const tempFile = path.join(common.tmpDir, 'fs-non-number-arguments-throw'); common.refreshTmpDir(); fs.writeFileSync(tempFile, 'abc\ndef'); // a sanity check when using numbers instead of strings const sanity = 'def'; const saneEmitter = fs.createReadStream(tempFile, { start: 4, end: 6 }); assert.throws(function() { fs.createReadStream(tempFile, { start: '4', end: 6 }); }, /^TypeError: start must be a Number$/, "start as string didn't throw an error for createReadStream"); assert.throws(function() { fs.createReadStream(tempFile, { start: 4, end: '6' }); }, /^TypeError: end must be a Number$/, "end as string didn't throw an error for createReadStream"); assert.throws(function() { fs.createWriteStream(tempFile, { start: '4' }); }, /^TypeError: start must be a Number$/, "start as string didn't throw an error for createWriteStream"); saneEmitter.on('data', common.mustCall(function(data) { assert.strictEqual(sanity, data.toString('utf8'), 'read ' + data.toString('utf8') + ' instead of ' + sanity); })); node-v4.8.2/test/parallel/test-fs-null-bytes.js000644 000766 000024 00000004757 13070706737 021571 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var fs = require('fs'); function check(async, sync) { var expected = /Path must be a string without null bytes./; var argsSync = Array.prototype.slice.call(arguments, 2); var argsAsync = argsSync.concat(function(er) { assert(er && er.message.match(expected)); assert.equal(er.code, 'ENOENT'); }); if (sync) assert.throws(function() { console.error(sync.name, argsSync); sync.apply(null, argsSync); }, expected); if (async) async.apply(null, argsAsync); } check(fs.access, fs.accessSync, 'foo\u0000bar'); check(fs.access, fs.accessSync, 'foo\u0000bar', fs.F_OK); check(fs.appendFile, fs.appendFileSync, 'foo\u0000bar'); check(fs.chmod, fs.chmodSync, 'foo\u0000bar', '0644'); check(fs.chown, fs.chownSync, 'foo\u0000bar', 12, 34); check(fs.link, fs.linkSync, 'foo\u0000bar', 'foobar'); check(fs.link, fs.linkSync, 'foobar', 'foo\u0000bar'); check(fs.lstat, fs.lstatSync, 'foo\u0000bar'); check(fs.mkdir, fs.mkdirSync, 'foo\u0000bar', '0755'); check(fs.open, fs.openSync, 'foo\u0000bar', 'r'); check(fs.readFile, fs.readFileSync, 'foo\u0000bar'); check(fs.readdir, fs.readdirSync, 'foo\u0000bar'); check(fs.readlink, fs.readlinkSync, 'foo\u0000bar'); check(fs.realpath, fs.realpathSync, 'foo\u0000bar'); check(fs.rename, fs.renameSync, 'foo\u0000bar', 'foobar'); check(fs.rename, fs.renameSync, 'foobar', 'foo\u0000bar'); check(fs.rmdir, fs.rmdirSync, 'foo\u0000bar'); check(fs.stat, fs.statSync, 'foo\u0000bar'); check(fs.symlink, fs.symlinkSync, 'foo\u0000bar', 'foobar'); check(fs.symlink, fs.symlinkSync, 'foobar', 'foo\u0000bar'); check(fs.truncate, fs.truncateSync, 'foo\u0000bar'); check(fs.unlink, fs.unlinkSync, 'foo\u0000bar'); check(null, fs.unwatchFile, 'foo\u0000bar', common.fail); check(fs.utimes, fs.utimesSync, 'foo\u0000bar', 0, 0); check(null, fs.watch, 'foo\u0000bar', common.fail); check(null, fs.watchFile, 'foo\u0000bar', common.fail); check(fs.writeFile, fs.writeFileSync, 'foo\u0000bar'); // an 'error' for exists means that it doesn't exist. // one of many reasons why this file is the absolute worst. fs.exists('foo\u0000bar', function(exists) { assert(!exists); }); assert(!fs.existsSync('foo\u0000bar')); node-v4.8.2/test/parallel/test-fs-open-flags.js000644 000766 000024 00000003050 13070706737 021507 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var constants = require('constants'); var fs = require('fs'); var O_APPEND = constants.O_APPEND || 0; var O_CREAT = constants.O_CREAT || 0; var O_EXCL = constants.O_EXCL || 0; var O_RDONLY = constants.O_RDONLY || 0; var O_RDWR = constants.O_RDWR || 0; var O_TRUNC = constants.O_TRUNC || 0; var O_WRONLY = constants.O_WRONLY || 0; assert.equal(fs._stringToFlags('r'), O_RDONLY); assert.equal(fs._stringToFlags('r+'), O_RDWR); assert.equal(fs._stringToFlags('w'), O_TRUNC | O_CREAT | O_WRONLY); assert.equal(fs._stringToFlags('w+'), O_TRUNC | O_CREAT | O_RDWR); assert.equal(fs._stringToFlags('a'), O_APPEND | O_CREAT | O_WRONLY); assert.equal(fs._stringToFlags('a+'), O_APPEND | O_CREAT | O_RDWR); assert.equal(fs._stringToFlags('wx'), O_TRUNC | O_CREAT | O_WRONLY | O_EXCL); assert.equal(fs._stringToFlags('xw'), O_TRUNC | O_CREAT | O_WRONLY | O_EXCL); assert.equal(fs._stringToFlags('wx+'), O_TRUNC | O_CREAT | O_RDWR | O_EXCL); assert.equal(fs._stringToFlags('xw+'), O_TRUNC | O_CREAT | O_RDWR | O_EXCL); assert.equal(fs._stringToFlags('ax'), O_APPEND | O_CREAT | O_WRONLY | O_EXCL); assert.equal(fs._stringToFlags('xa'), O_APPEND | O_CREAT | O_WRONLY | O_EXCL); assert.equal(fs._stringToFlags('ax+'), O_APPEND | O_CREAT | O_RDWR | O_EXCL); assert.equal(fs._stringToFlags('xa+'), O_APPEND | O_CREAT | O_RDWR | O_EXCL); ('+ +a +r +w rw wa war raw r++ a++ w++ x +x x+ rx rx+ wxx wax xwx xxx') .split(' ') .forEach(function(flags) { assert.throws(function() { fs._stringToFlags(flags); }); }); node-v4.8.2/test/parallel/test-fs-open-numeric-flags.js000644 000766 000024 00000000645 13070706737 023156 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const constants = require('constants'); const assert = require('assert'); const fs = require('fs'); const path = require('path'); common.refreshTmpDir(); // O_WRONLY without O_CREAT shall fail with ENOENT const pathNE = path.join(common.tmpDir, 'file-should-not-exist'); assert.throws( () => fs.openSync(pathNE, constants.O_WRONLY), (e) => e.code === 'ENOENT' ); node-v4.8.2/test/parallel/test-fs-open.js000644 000766 000024 00000001115 13070706737 020415 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var fs = require('fs'); var caughtException = false; try { // should throw ENOENT, not EBADF // see https://github.com/joyent/node/pull/1228 fs.openSync('/path/to/file/that/does/not/exist', 'r'); } catch (e) { assert.equal(e.code, 'ENOENT'); caughtException = true; } assert.ok(caughtException); fs.open(__filename, 'r', common.mustCall(function(err, fd) { if (err) { throw err; } })); fs.open(__filename, 'rs', common.mustCall(function(err, fd) { if (err) { throw err; } })); node-v4.8.2/test/parallel/test-fs-read-buffer.js000644 000766 000024 00000001477 13070706737 021651 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const path = require('path'); const Buffer = require('buffer').Buffer; const fs = require('fs'); const filepath = path.join(common.fixturesDir, 'x.txt'); const fd = fs.openSync(filepath, 'r'); const expected = 'xyz\n'; const bufferAsync = Buffer.allocUnsafe(expected.length); const bufferSync = Buffer.allocUnsafe(expected.length); fs.read(fd, bufferAsync, 0, expected.length, 0, common.mustCall(function(err, bytesRead) { assert.equal(bytesRead, expected.length); assert.deepStrictEqual(bufferAsync, Buffer.from(expected)); })); var r = fs.readSync(fd, bufferSync, 0, expected.length, 0); assert.deepEqual(bufferSync, new Buffer(expected)); assert.equal(r, expected.length); node-v4.8.2/test/parallel/test-fs-read-file-assert-encoding.js000644 000766 000024 00000000433 13070706737 024371 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const fs = require('fs'); const encoding = 'foo-8'; const filename = 'bar.txt'; assert.throws( fs.readFile.bind(fs, filename, { encoding }, () => {}), new RegExp(`Error: Unknown encoding: ${encoding}$`) ); node-v4.8.2/test/parallel/test-fs-read-file-sync-hostname.js000644 000766 000024 00000000403 13070706737 024071 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var fs = require('fs'); // test reading from hostname if (process.platform === 'linux2') { var hostname = fs.readFileSync('/proc/sys/kernel/hostname'); assert.ok(hostname.length > 0); } node-v4.8.2/test/parallel/test-fs-read-file-sync.js000644 000766 000024 00000000541 13070706737 022260 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const path = require('path'); const fs = require('fs'); const fn = path.join(common.fixturesDir, 'elipses.txt'); const s = fs.readFileSync(fn, 'utf8'); for (let i = 0; i < s.length; i++) { assert.strictEqual('\u2026', s[i]); } assert.strictEqual(10000, s.length); node-v4.8.2/test/parallel/test-fs-read-stream-encoding.js000644 000766 000024 00000001016 13070706737 023444 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const fs = require('fs'); const path = require('path'); const stream = require('stream'); const encoding = 'base64'; const example = path.join(common.fixturesDir, 'x.txt'); const assertStream = new stream.Writable({ write: function(chunk, enc, next) { const expected = new Buffer('xyz'); assert(chunk.equals(expected)); } }); assertStream.setDefaultEncoding(encoding); fs.createReadStream(example, encoding).pipe(assertStream); node-v4.8.2/test/parallel/test-fs-read-stream-err.js000644 000766 000024 00000001725 13070706737 022455 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const fs = require('fs'); const stream = fs.createReadStream(__filename, { bufferSize: 64 }); const err = new Error('BAM'); stream.on('error', common.mustCall((err_) => { process.nextTick(common.mustCall(() => { assert.strictEqual(stream.fd, null); assert.strictEqual(err_, err); })); })); fs.close = common.mustCall((fd_, cb) => { assert.strictEqual(fd_, stream.fd); process.nextTick(cb); }); const read = fs.read; fs.read = function() { // first time is ok. read.apply(fs, arguments); // then it breaks fs.read = common.mustCall(function() { const cb = arguments[arguments.length - 1]; process.nextTick(() => { cb(err); }); // and should not be called again! fs.read = () => { throw new Error('BOOM!'); }; }); }; stream.on('data', (buf) => { stream.on('data', () => common.fail("no more 'data' events should follow")); }); node-v4.8.2/test/parallel/test-fs-read-stream-fd-leak.js000644 000766 000024 00000002310 13070706737 023157 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var fs = require('fs'); var path = require('path'); var openCount = 0; var _fsopen = fs.open; var _fsclose = fs.close; var loopCount = 50; var totalCheck = 50; var emptyTxt = path.join(common.fixturesDir, 'empty.txt'); fs.open = function() { openCount++; return _fsopen.apply(null, arguments); }; fs.close = function() { openCount--; return _fsclose.apply(null, arguments); }; function testLeak(endFn, callback) { console.log('testing for leaks from fs.createReadStream().%s()...', endFn); var i = 0; var check = 0; var checkFunction = function() { if (openCount != 0 && check < totalCheck) { check++; setTimeout(checkFunction, 100); return; } assert.equal(0, openCount, 'no leaked file descriptors using ' + endFn + '() (got ' + openCount + ')'); openCount = 0; callback && setTimeout(callback, 100); }; setInterval(function() { var s = fs.createReadStream(emptyTxt); s[endFn](); if (++i === loopCount) { clearTimeout(this); setTimeout(checkFunction, 100); } }, 2); } testLeak('close', function() { testLeak('destroy'); }); node-v4.8.2/test/parallel/test-fs-read-stream-fd.js000644 000766 000024 00000001060 13070706737 022246 0ustar00iojsstaff000000 000000 'use strict'; var fs = require('fs'); var assert = require('assert'); var path = require('path'); var common = require('../common'); var file = path.join(common.tmpDir, '/read_stream_fd_test.txt'); var input = 'hello world'; var output = ''; var fd, stream; common.refreshTmpDir(); fs.writeFileSync(file, input); fd = fs.openSync(file, 'r'); stream = fs.createReadStream(null, { fd: fd, encoding: 'utf8' }); stream.on('data', function(data) { output += data; }); process.on('exit', function() { fs.unlinkSync(file); assert.equal(output, input); }); node-v4.8.2/test/parallel/test-fs-read-stream-inherit.js000644 000766 000024 00000011064 13070706737 023324 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const path = require('path'); const fs = require('fs'); const fn = path.join(common.fixturesDir, 'elipses.txt'); const rangeFile = path.join(common.fixturesDir, 'x.txt'); const callbacks = { open: 0, end: 0, close: 0 }; let paused = false; const file = fs.ReadStream(fn); file.on('open', function(fd) { file.length = 0; callbacks.open++; assert.strictEqual(typeof fd, 'number'); assert.ok(file.readable); // GH-535 file.pause(); file.resume(); file.pause(); file.resume(); }); file.on('data', function(data) { assert.ok(data instanceof Buffer); assert.ok(!paused); file.length += data.length; paused = true; file.pause(); setTimeout(function() { paused = false; file.resume(); }, 10); }); file.on('end', function(chunk) { callbacks.end++; }); file.on('close', function() { callbacks.close++; }); const file3 = fs.createReadStream(fn, Object.create({encoding: 'utf8'})); file3.length = 0; file3.on('data', function(data) { assert.strictEqual(typeof data, 'string'); file3.length += data.length; for (let i = 0; i < data.length; i++) { // http://www.fileformat.info/info/unicode/char/2026/index.htm assert.strictEqual(data[i], '\u2026'); } }); file3.on('close', function() { callbacks.close++; }); process.on('exit', function() { assert.strictEqual(callbacks.open, 1); assert.strictEqual(callbacks.end, 1); assert.strictEqual(callbacks.close, 2); assert.strictEqual(file.length, 30000); assert.strictEqual(file3.length, 10000); console.error('ok'); }); const file4 = fs.createReadStream(rangeFile, Object.create({bufferSize: 1, start: 1, end: 2})); assert.strictEqual(file4.start, 1); assert.strictEqual(file4.end, 2); let contentRead = ''; file4.on('data', function(data) { contentRead += data.toString('utf-8'); }); file4.on('end', function(data) { assert.strictEqual(contentRead, 'yz'); }); const file5 = fs.createReadStream(rangeFile, Object.create({bufferSize: 1, start: 1})); assert.strictEqual(file5.start, 1); file5.data = ''; file5.on('data', function(data) { file5.data += data.toString('utf-8'); }); file5.on('end', function() { assert.strictEqual(file5.data, 'yz\n'); }); // https://github.com/joyent/node/issues/2320 const file6 = fs.createReadStream(rangeFile, Object.create({bufferSize: 1.23, start: 1})); assert.strictEqual(file6.start, 1); file6.data = ''; file6.on('data', function(data) { file6.data += data.toString('utf-8'); }); file6.on('end', function() { assert.strictEqual(file6.data, 'yz\n'); }); assert.throws(function() { fs.createReadStream(rangeFile, Object.create({start: 10, end: 2})); }, /start must be <= end/); const stream = fs.createReadStream(rangeFile, Object.create({ start: 0, end: 0 })); assert.strictEqual(stream.start, 0); assert.strictEqual(stream.end, 0); stream.data = ''; stream.on('data', function(chunk) { stream.data += chunk; }); stream.on('end', function() { assert.strictEqual(stream.data, 'x'); }); // pause and then resume immediately. const pauseRes = fs.createReadStream(rangeFile); pauseRes.pause(); pauseRes.resume(); let file7 = fs.createReadStream(rangeFile, Object.create({autoClose: false })); assert.strictEqual(file7.autoClose, false); file7.on('data', function() {}); file7.on('end', function() { process.nextTick(function() { assert(!file7.closed); assert(!file7.destroyed); file7Next(); }); }); function file7Next() { // This will tell us if the fd is usable again or not. file7 = fs.createReadStream(null, Object.create({fd: file7.fd, start: 0 })); file7.data = ''; file7.on('data', function(data) { file7.data += data; }); file7.on('end', function(err) { assert.strictEqual(file7.data, 'xyz\n'); }); } // Just to make sure autoClose won't close the stream because of error. const file8 = fs.createReadStream(null, Object.create({fd: 13337, autoClose: false })); file8.on('data', function() {}); file8.on('error', common.mustCall(function() {})); // Make sure stream is destroyed when file does not exist. const file9 = fs.createReadStream('/path/to/file/that/does/not/exist'); file9.on('data', function() {}); file9.on('error', common.mustCall(function() {})); process.on('exit', function() { assert(file7.closed); assert(file7.destroyed); assert(!file8.closed); assert(!file8.destroyed); assert(file8.fd); assert(!file9.closed); assert(file9.destroyed); }); node-v4.8.2/test/parallel/test-fs-read-stream-resume.js000644 000766 000024 00000001127 13070706737 023161 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const fs = require('fs'); const path = require('path'); const file = path.join(common.fixturesDir, 'x.txt'); let data = ''; let first = true; var stream = fs.createReadStream(file); stream.setEncoding('utf8'); stream.on('data', function(chunk) { data += chunk; if (first) { first = false; stream.resume(); } }); process.nextTick(function() { stream.pause(); setTimeout(function() { stream.resume(); }, 100); }); process.on('exit', function() { assert.strictEqual(data, 'xyz\n'); }); node-v4.8.2/test/parallel/test-fs-read-stream-throw-type-error.js000644 000766 000024 00000001741 13070706737 025134 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const fs = require('fs'); const path = require('path'); const example = path.join(common.fixturesDir, 'x.txt'); assert.doesNotThrow(function() { fs.createReadStream(example, undefined); }); assert.doesNotThrow(function() { fs.createReadStream(example, 'utf8'); }); assert.doesNotThrow(function() { fs.createReadStream(example, {encoding: 'utf8'}); }); assert.throws(function() { fs.createReadStream(example, null); }, /options must be a string or an object/); assert.throws(function() { fs.createReadStream(example, 123); }, /options must be a string or an object/); assert.throws(function() { fs.createReadStream(example, 0); }, /options must be a string or an object/); assert.throws(function() { fs.createReadStream(example, true); }, /options must be a string or an object/); assert.throws(function() { fs.createReadStream(example, false); }, /options must be a string or an object/); node-v4.8.2/test/parallel/test-fs-read-stream.js000644 000766 000024 00000007707 13070706737 021675 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var path = require('path'); var fs = require('fs'); var fn = path.join(common.fixturesDir, 'elipses.txt'); var rangeFile = path.join(common.fixturesDir, 'x.txt'); var callbacks = { open: 0, end: 0, close: 0 }; var paused = false; var file = fs.ReadStream(fn); file.on('open', function(fd) { file.length = 0; callbacks.open++; assert.equal('number', typeof fd); assert.ok(file.readable); // GH-535 file.pause(); file.resume(); file.pause(); file.resume(); }); file.on('data', function(data) { assert.ok(data instanceof Buffer); assert.ok(!paused); file.length += data.length; paused = true; file.pause(); setTimeout(function() { paused = false; file.resume(); }, 10); }); file.on('end', function(chunk) { callbacks.end++; }); file.on('close', function() { callbacks.close++; //assert.equal(fs.readFileSync(fn), fileContent); }); var file3 = fs.createReadStream(fn, {encoding: 'utf8'}); file3.length = 0; file3.on('data', function(data) { assert.equal('string', typeof data); file3.length += data.length; for (var i = 0; i < data.length; i++) { // http://www.fileformat.info/info/unicode/char/2026/index.htm assert.equal('\u2026', data[i]); } }); file3.on('close', function() { callbacks.close++; }); process.on('exit', function() { assert.equal(1, callbacks.open); assert.equal(1, callbacks.end); assert.equal(2, callbacks.close); assert.equal(30000, file.length); assert.equal(10000, file3.length); console.error('ok'); }); var file4 = fs.createReadStream(rangeFile, {bufferSize: 1, start: 1, end: 2}); var contentRead = ''; file4.on('data', function(data) { contentRead += data.toString('utf-8'); }); file4.on('end', function(data) { assert.equal(contentRead, 'yz'); }); var file5 = fs.createReadStream(rangeFile, {bufferSize: 1, start: 1}); file5.data = ''; file5.on('data', function(data) { file5.data += data.toString('utf-8'); }); file5.on('end', function() { assert.equal(file5.data, 'yz\n'); }); // https://github.com/joyent/node/issues/2320 var file6 = fs.createReadStream(rangeFile, {bufferSize: 1.23, start: 1}); file6.data = ''; file6.on('data', function(data) { file6.data += data.toString('utf-8'); }); file6.on('end', function() { assert.equal(file6.data, 'yz\n'); }); assert.throws(function() { fs.createReadStream(rangeFile, {start: 10, end: 2}); }, /start must be <= end/); var stream = fs.createReadStream(rangeFile, { start: 0, end: 0 }); stream.data = ''; stream.on('data', function(chunk) { stream.data += chunk; }); stream.on('end', function() { assert.equal('x', stream.data); }); // pause and then resume immediately. var pauseRes = fs.createReadStream(rangeFile); pauseRes.pause(); pauseRes.resume(); var file7 = fs.createReadStream(rangeFile, {autoClose: false }); file7.on('data', function() {}); file7.on('end', function() { process.nextTick(function() { assert(!file7.closed); assert(!file7.destroyed); file7Next(); }); }); function file7Next() { // This will tell us if the fd is usable again or not. file7 = fs.createReadStream(null, {fd: file7.fd, start: 0 }); file7.data = ''; file7.on('data', function(data) { file7.data += data; }); file7.on('end', function(err) { assert.equal(file7.data, 'xyz\n'); }); } // Just to make sure autoClose won't close the stream because of error. var file8 = fs.createReadStream(null, {fd: 13337, autoClose: false }); file8.on('data', function() {}); file8.on('error', common.mustCall(function() {})); // Make sure stream is destroyed when file does not exist. var file9 = fs.createReadStream('/path/to/file/that/does/not/exist'); file9.on('data', function() {}); file9.on('error', common.mustCall(function() {})); process.on('exit', function() { assert(file7.closed); assert(file7.destroyed); assert(!file8.closed); assert(!file8.destroyed); assert(file8.fd); assert(!file9.closed); assert(file9.destroyed); }); node-v4.8.2/test/parallel/test-fs-read.js000644 000766 000024 00000001176 13070706737 020376 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const path = require('path'); const fs = require('fs'); const filepath = path.join(common.fixturesDir, 'x.txt'); const fd = fs.openSync(filepath, 'r'); const expected = 'xyz\n'; fs.read(fd, expected.length, 0, 'utf-8', common.mustCall(function(err, str, bytesRead) { assert.ok(!err); assert.equal(str, expected); assert.equal(bytesRead, expected.length); })); var r = fs.readSync(fd, expected.length, 0, 'utf-8'); assert.equal(r[0], expected); assert.equal(r[1], expected.length); node-v4.8.2/test/parallel/test-fs-readdir.js000644 000766 000024 00000001654 13070706737 021076 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const fs = require('fs'); const readdirDir = common.tmpDir; const files = ['empty', 'files', 'for', 'just', 'testing']; // Make sure tmp directory is clean common.refreshTmpDir(); // Create the necessary files files.forEach(function(currentFile) { fs.closeSync(fs.openSync(readdirDir + '/' + currentFile, 'w')); }); // Check the readdir Sync version assert.deepEqual(files, fs.readdirSync(readdirDir).sort()); // Check the readdir async version fs.readdir(readdirDir, common.mustCall(function(err, f) { assert.ifError(err); assert.deepEqual(files, f.sort()); })); // readdir() on file should throw ENOTDIR // https://github.com/joyent/node/issues/1869 assert.throws(function() { fs.readdirSync(__filename); }, /Error: ENOTDIR: not a directory/); fs.readdir(__filename, common.mustCall(function(e) { assert.equal(e.code, 'ENOTDIR'); })); node-v4.8.2/test/parallel/test-fs-readfile-empty.js000644 000766 000024 00000000653 13070706737 022371 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const path = require('path'); const fs = require('fs'); const fn = path.join(common.fixturesDir, 'empty.txt'); fs.readFile(fn, function(err, data) { assert.ok(data); }); fs.readFile(fn, 'utf8', function(err, data) { assert.strictEqual('', data); }); assert.ok(fs.readFileSync(fn)); assert.strictEqual('', fs.readFileSync(fn, 'utf8')); node-v4.8.2/test/parallel/test-fs-readfile-error.js000644 000766 000024 00000002037 13070706737 022362 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const exec = require('child_process').exec; const path = require('path'); // `fs.readFile('/')` does not fail on FreeBSD, because you can open and read // the directory there. if (process.platform === 'freebsd') { common.skip('platform not supported.'); return; } function test(env, cb) { const filename = path.join(common.fixturesDir, 'test-fs-readfile-error.js'); const execPath = '"' + process.execPath + '" "' + filename + '"'; const options = { env: Object.assign(process.env, env) }; exec(execPath, options, common.mustCall((err, stdout, stderr) => { assert(err); assert.strictEqual(stdout, ''); assert.notStrictEqual(stderr, ''); cb('' + stderr); })); } test({ NODE_DEBUG: '' }, common.mustCall((data) => { assert(/EISDIR/.test(data)); assert(!/test-fs-readfile-error/.test(data)); })); test({ NODE_DEBUG: 'fs' }, common.mustCall((data) => { assert(/EISDIR/.test(data)); assert(/test-fs-readfile-error/.test(data)); })); node-v4.8.2/test/parallel/test-fs-readfile-pipe-large.js000644 000766 000024 00000002233 13070706737 023254 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var path = require('path'); // simulate `cat readfile.js | node readfile.js` if (common.isWindows || common.isAix) { common.skip(`No /dev/stdin on ${process.platform}.`); return; } var fs = require('fs'); if (process.argv[2] === 'child') { fs.readFile('/dev/stdin', function(er, data) { if (er) throw er; process.stdout.write(data); }); return; } var filename = path.join(common.tmpDir, '/readfile_pipe_large_test.txt'); var dataExpected = new Array(1000000).join('a'); common.refreshTmpDir(); fs.writeFileSync(filename, dataExpected); var exec = require('child_process').exec; var f = JSON.stringify(__filename); var node = JSON.stringify(process.execPath); var cmd = 'cat ' + filename + ' | ' + node + ' ' + f + ' child'; exec(cmd, { maxBuffer: 1000000 }, function(err, stdout, stderr) { if (err) console.error(err); assert(!err, 'it exits normally'); assert(stdout === dataExpected, 'it reads the file and outputs it'); assert(stderr === '', 'it does not write to stderr'); console.log('ok'); }); process.on('exit', function() { fs.unlinkSync(filename); }); node-v4.8.2/test/parallel/test-fs-readfile-pipe.js000644 000766 000024 00000001633 13070706737 022167 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); // simulate `cat readfile.js | node readfile.js` if (common.isWindows || common.isAix) { common.skip(`No /dev/stdin on ${process.platform}.`); return; } var fs = require('fs'); var dataExpected = fs.readFileSync(__filename, 'utf8'); if (process.argv[2] === 'child') { fs.readFile('/dev/stdin', function(er, data) { if (er) throw er; process.stdout.write(data); }); return; } var exec = require('child_process').exec; var f = JSON.stringify(__filename); var node = JSON.stringify(process.execPath); var cmd = 'cat ' + f + ' | ' + node + ' ' + f + ' child'; exec(cmd, function(err, stdout, stderr) { if (err) console.error(err); assert(!err, 'it exits normally'); assert(stdout === dataExpected, 'it reads the file and outputs it'); assert(stderr === '', 'it does not write to stderr'); console.log('ok'); }); node-v4.8.2/test/parallel/test-fs-readfile-unlink.js000644 000766 000024 00000001242 13070706737 022526 0ustar00iojsstaff000000 000000 'use strict'; const assert = require('assert'); const common = require('../common'); const fs = require('fs'); const path = require('path'); const dirName = path.resolve(common.fixturesDir, 'test-readfile-unlink'); const fileName = path.resolve(dirName, 'test.bin'); var buf = new Buffer(512 * 1024); buf.fill(42); try { fs.mkdirSync(dirName); } catch (e) { // Ignore if the directory already exists. if (e.code != 'EEXIST') throw e; } fs.writeFileSync(fileName, buf); fs.readFile(fileName, function(err, data) { assert.ifError(err); assert(data.length == buf.length); assert.strictEqual(buf[0], 42); fs.unlinkSync(fileName); fs.rmdirSync(dirName); }); node-v4.8.2/test/parallel/test-fs-readfile-zero-byte-liar.js000644 000766 000024 00000001251 13070706737 024073 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var fs = require('fs'); const dataExpected = fs.readFileSync(__filename, 'utf8'); // sometimes stat returns size=0, but it's a lie. fs._fstat = fs.fstat; fs._fstatSync = fs.fstatSync; fs.fstat = (fd, cb) => { fs._fstat(fd, (er, st) => { if (er) return cb(er); st.size = 0; return cb(er, st); }); }; fs.fstatSync = (fd) => { const st = fs._fstatSync(fd); st.size = 0; return st; }; const d = fs.readFileSync(__filename, 'utf8'); assert.strictEqual(d, dataExpected); fs.readFile(__filename, 'utf8', common.mustCall((er, d) => { assert.strictEqual(d, dataExpected); })); node-v4.8.2/test/parallel/test-fs-readfilesync-pipe-large.js000644 000766 000024 00000002161 13070706737 024151 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var path = require('path'); // simulate `cat readfile.js | node readfile.js` if (common.isWindows || common.isAix) { common.skip(`No /dev/stdin on ${process.platform}.`); return; } var fs = require('fs'); if (process.argv[2] === 'child') { process.stdout.write(fs.readFileSync('/dev/stdin', 'utf8')); return; } var filename = path.join(common.tmpDir, '/readfilesync_pipe_large_test.txt'); var dataExpected = new Array(1000000).join('a'); common.refreshTmpDir(); fs.writeFileSync(filename, dataExpected); var exec = require('child_process').exec; var f = JSON.stringify(__filename); var node = JSON.stringify(process.execPath); var cmd = 'cat ' + filename + ' | ' + node + ' ' + f + ' child'; exec(cmd, { maxBuffer: 1000000 }, function(err, stdout, stderr) { if (err) console.error(err); assert(!err, 'it exits normally'); assert(stdout === dataExpected, 'it reads the file and outputs it'); assert(stderr === '', 'it does not write to stderr'); console.log('ok'); }); process.on('exit', function() { fs.unlinkSync(filename); }); node-v4.8.2/test/parallel/test-fs-realpath.js000644 000766 000024 00000040701 13070706737 021260 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var fs = require('fs'); var path = require('path'); var exec = require('child_process').exec; var async_completed = 0, async_expected = 0, unlink = []; var skipSymlinks = false; common.refreshTmpDir(); var root = '/'; if (common.isWindows) { // something like "C:\\" root = process.cwd().substr(0, 3); // On Windows, creating symlinks requires admin privileges. // We'll only try to run symlink test if we have enough privileges. try { exec('whoami /priv', function(err, o) { if (err || o.indexOf('SeCreateSymbolicLinkPrivilege') == -1) { skipSymlinks = true; } runTest(); }); } catch (er) { // better safe than sorry skipSymlinks = true; process.nextTick(runTest); } } else { process.nextTick(runTest); } function tmp(p) { return path.join(common.tmpDir, p); } var targetsAbsDir = path.join(common.tmpDir, 'targets'); var tmpAbsDir = common.tmpDir; // Set up targetsAbsDir and expected subdirectories fs.mkdirSync(targetsAbsDir); fs.mkdirSync(path.join(targetsAbsDir, 'nested-index')); fs.mkdirSync(path.join(targetsAbsDir, 'nested-index', 'one')); fs.mkdirSync(path.join(targetsAbsDir, 'nested-index', 'two')); function asynctest(testBlock, args, callback, assertBlock) { async_expected++; testBlock.apply(testBlock, args.concat(function(err) { var ignoreError = false; if (assertBlock) { try { ignoreError = assertBlock.apply(assertBlock, arguments); } catch (e) { err = e; } } async_completed++; callback(ignoreError ? null : err); })); } // sub-tests: function test_simple_error_callback(cb) { fs.realpath('/this/path/does/not/exist', common.mustCall(function(err, s) { assert(err); assert(!s); cb(); })); } function test_simple_relative_symlink(callback) { console.log('test_simple_relative_symlink'); if (skipSymlinks) { common.skip('symlink test (no privs)'); return runNextTest(); } const entry = common.tmpDir + '/symlink'; const expected = common.tmpDir + '/cycles/root.js'; [ [entry, '../' + common.tmpDirName + '/cycles/root.js'] ].forEach(function(t) { try {fs.unlinkSync(t[0]);} catch (e) {} console.log('fs.symlinkSync(%j, %j, %j)', t[1], t[0], 'file'); fs.symlinkSync(t[1], t[0], 'file'); unlink.push(t[0]); }); var result = fs.realpathSync(entry); assert.equal(result, path.resolve(expected)); asynctest(fs.realpath, [entry], callback, function(err, result) { assert.equal(result, path.resolve(expected)); }); } function test_simple_absolute_symlink(callback) { console.log('test_simple_absolute_symlink'); // this one should still run, even if skipSymlinks is set, // because it uses a junction. var type = skipSymlinks ? 'junction' : 'dir'; console.log('using type=%s', type); const entry = tmpAbsDir + '/symlink'; const expected = common.fixturesDir + '/nested-index/one'; [ [entry, expected] ].forEach(function(t) { try {fs.unlinkSync(t[0]);} catch (e) {} console.error('fs.symlinkSync(%j, %j, %j)', t[1], t[0], type); fs.symlinkSync(t[1], t[0], type); unlink.push(t[0]); }); var result = fs.realpathSync(entry); assert.equal(result, path.resolve(expected)); asynctest(fs.realpath, [entry], callback, function(err, result) { assert.equal(result, path.resolve(expected)); }); } function test_deep_relative_file_symlink(callback) { console.log('test_deep_relative_file_symlink'); if (skipSymlinks) { common.skip('symlink test (no privs)'); return runNextTest(); } var expected = path.join(common.fixturesDir, 'cycles', 'root.js'); var linkData1 = path.relative(path.join(targetsAbsDir, 'nested-index', 'one'), expected); var linkPath1 = path.join(targetsAbsDir, 'nested-index', 'one', 'symlink1.js'); try {fs.unlinkSync(linkPath1);} catch (e) {} fs.symlinkSync(linkData1, linkPath1, 'file'); var linkData2 = '../one/symlink1.js'; var entry = path.join(targetsAbsDir, 'nested-index', 'two', 'symlink1-b.js'); try {fs.unlinkSync(entry);} catch (e) {} fs.symlinkSync(linkData2, entry, 'file'); unlink.push(linkPath1); unlink.push(entry); assert.equal(fs.realpathSync(entry), path.resolve(expected)); asynctest(fs.realpath, [entry], callback, function(err, result) { assert.equal(result, path.resolve(expected)); }); } function test_deep_relative_dir_symlink(callback) { console.log('test_deep_relative_dir_symlink'); if (skipSymlinks) { common.skip('symlink test (no privs)'); return runNextTest(); } var expected = path.join(common.fixturesDir, 'cycles', 'folder'); var path1b = path.join(targetsAbsDir, 'nested-index', 'one'); var linkPath1b = path.join(path1b, 'symlink1-dir'); var linkData1b = path.relative(path1b, expected); try {fs.unlinkSync(linkPath1b);} catch (e) {} fs.symlinkSync(linkData1b, linkPath1b, 'dir'); var linkData2b = '../one/symlink1-dir'; var entry = path.join(targetsAbsDir, 'nested-index', 'two', 'symlink12-dir'); try {fs.unlinkSync(entry);} catch (e) {} fs.symlinkSync(linkData2b, entry, 'dir'); unlink.push(linkPath1b); unlink.push(entry); assert.equal(fs.realpathSync(entry), path.resolve(expected)); asynctest(fs.realpath, [entry], callback, function(err, result) { assert.equal(result, path.resolve(expected)); }); } function test_cyclic_link_protection(callback) { console.log('test_cyclic_link_protection'); if (skipSymlinks) { common.skip('symlink test (no privs)'); return runNextTest(); } var entry = common.tmpDir + '/cycles/realpath-3a'; [ [entry, '../cycles/realpath-3b'], [common.tmpDir + '/cycles/realpath-3b', '../cycles/realpath-3c'], [common.tmpDir + '/cycles/realpath-3c', '../cycles/realpath-3a'] ].forEach(function(t) { try {fs.unlinkSync(t[0]);} catch (e) {} fs.symlinkSync(t[1], t[0], 'dir'); unlink.push(t[0]); }); assert.throws(function() { fs.realpathSync(entry); }); asynctest(fs.realpath, [entry], callback, function(err, result) { assert.ok(err && true); return true; }); } function test_cyclic_link_overprotection(callback) { console.log('test_cyclic_link_overprotection'); if (skipSymlinks) { common.skip('symlink test (no privs)'); return runNextTest(); } var cycles = common.tmpDir + '/cycles'; var expected = fs.realpathSync(cycles); var folder = cycles + '/folder'; var link = folder + '/cycles'; var testPath = cycles; testPath += '/folder/cycles'.repeat(10); try {fs.unlinkSync(link);} catch (ex) {} fs.symlinkSync(cycles, link, 'dir'); unlink.push(link); assert.equal(fs.realpathSync(testPath), path.resolve(expected)); asynctest(fs.realpath, [testPath], callback, function(er, res) { assert.equal(res, path.resolve(expected)); }); } function test_relative_input_cwd(callback) { console.log('test_relative_input_cwd'); if (skipSymlinks) { common.skip('symlink test (no privs)'); return runNextTest(); } // we need to calculate the relative path to the tmp dir from cwd var entrydir = process.cwd(); var entry = path.relative(entrydir, path.join(common.tmpDir + '/cycles/realpath-3a')); var expected = common.tmpDir + '/cycles/root.js'; [ [entry, '../cycles/realpath-3b'], [common.tmpDir + '/cycles/realpath-3b', '../cycles/realpath-3c'], [common.tmpDir + '/cycles/realpath-3c', 'root.js'] ].forEach(function(t) { var fn = t[0]; console.error('fn=%j', fn); try {fs.unlinkSync(fn);} catch (e) {} var b = path.basename(t[1]); var type = (b === 'root.js' ? 'file' : 'dir'); console.log('fs.symlinkSync(%j, %j, %j)', t[1], fn, type); fs.symlinkSync(t[1], fn, 'file'); unlink.push(fn); }); var origcwd = process.cwd(); process.chdir(entrydir); assert.equal(fs.realpathSync(entry), path.resolve(expected)); asynctest(fs.realpath, [entry], callback, function(err, result) { process.chdir(origcwd); assert.equal(result, path.resolve(expected)); return true; }); } function test_deep_symlink_mix(callback) { console.log('test_deep_symlink_mix'); if (common.isWindows) { // This one is a mix of files and directories, and it's quite tricky // to get the file/dir links sorted out correctly. common.skip('symlink test (no privs)'); return runNextTest(); } /* /tmp/node-test-realpath-f1 -> $tmpDir/node-test-realpath-d1/foo /tmp/node-test-realpath-d1 -> $tmpDir/node-test-realpath-d2 /tmp/node-test-realpath-d2/foo -> $tmpDir/node-test-realpath-f2 /tmp/node-test-realpath-f2 -> $tmpDir/targets/nested-index/one/realpath-c $tmpDir/targets/nested-index/one/realpath-c -> $tmpDir/targets/nested-index/two/realpath-c $tmpDir/targets/nested-index/two/realpath-c -> $tmpDir/cycles/root.js $tmpDir/targets/cycles/root.js (hard) */ var entry = tmp('node-test-realpath-f1'); try { fs.unlinkSync(tmp('node-test-realpath-d2/foo')); } catch (e) {} try { fs.rmdirSync(tmp('node-test-realpath-d2')); } catch (e) {} fs.mkdirSync(tmp('node-test-realpath-d2'), 0o700); try { [ [entry, common.tmpDir + '/node-test-realpath-d1/foo'], [tmp('node-test-realpath-d1'), common.tmpDir + '/node-test-realpath-d2'], [tmp('node-test-realpath-d2/foo'), '../node-test-realpath-f2'], [tmp('node-test-realpath-f2'), targetsAbsDir + '/nested-index/one/realpath-c'], [targetsAbsDir + '/nested-index/one/realpath-c', targetsAbsDir + '/nested-index/two/realpath-c'], [targetsAbsDir + '/nested-index/two/realpath-c', common.tmpDir + '/cycles/root.js'] ].forEach(function(t) { try { fs.unlinkSync(t[0]); } catch (e) {} fs.symlinkSync(t[1], t[0]); unlink.push(t[0]); }); } finally { unlink.push(tmp('node-test-realpath-d2')); } var expected = tmpAbsDir + '/cycles/root.js'; assert.equal(fs.realpathSync(entry), path.resolve(expected)); asynctest(fs.realpath, [entry], callback, function(err, result) { assert.equal(result, path.resolve(expected)); return true; }); } function test_non_symlinks(callback) { console.log('test_non_symlinks'); var entrydir = path.dirname(tmpAbsDir); var entry = tmpAbsDir.substr(entrydir.length + 1) + '/cycles/root.js'; var expected = tmpAbsDir + '/cycles/root.js'; var origcwd = process.cwd(); process.chdir(entrydir); assert.equal(fs.realpathSync(entry), path.resolve(expected)); asynctest(fs.realpath, [entry], callback, function(err, result) { process.chdir(origcwd); assert.equal(result, path.resolve(expected)); return true; }); } var upone = path.join(process.cwd(), '..'); function test_escape_cwd(cb) { console.log('test_escape_cwd'); asynctest(fs.realpath, ['..'], cb, function(er, uponeActual) { assert.equal(upone, uponeActual, 'realpath("..") expected: ' + path.resolve(upone) + ' actual:' + uponeActual); }); } var uponeActual = fs.realpathSync('..'); assert.equal(upone, uponeActual, 'realpathSync("..") expected: ' + path.resolve(upone) + ' actual:' + uponeActual); // going up with .. multiple times // . // `-- a/ // |-- b/ // | `-- e -> .. // `-- d -> .. // realpath(a/b/e/d/a/b/e/d/a) ==> a function test_up_multiple(cb) { console.error('test_up_multiple'); if (skipSymlinks) { common.skip('symlink test (no privs)'); return runNextTest(); } function cleanup() { ['a/b', 'a' ].forEach(function(folder) { try {fs.rmdirSync(tmp(folder));} catch (ex) {} }); } function setup() { cleanup(); } setup(); fs.mkdirSync(tmp('a'), 0o755); fs.mkdirSync(tmp('a/b'), 0o755); fs.symlinkSync('..', tmp('a/d'), 'dir'); unlink.push(tmp('a/d')); fs.symlinkSync('..', tmp('a/b/e'), 'dir'); unlink.push(tmp('a/b/e')); var abedabed = tmp('abedabed'.split('').join('/')); var abedabed_real = tmp(''); var abedabeda = tmp('abedabeda'.split('').join('/')); var abedabeda_real = tmp('a'); assert.equal(fs.realpathSync(abedabeda), abedabeda_real); assert.equal(fs.realpathSync(abedabed), abedabed_real); fs.realpath(abedabeda, function(er, real) { if (er) throw er; assert.equal(abedabeda_real, real); fs.realpath(abedabed, function(er, real) { if (er) throw er; assert.equal(abedabed_real, real); cb(); cleanup(); }); }); } // absolute symlinks with children. // . // `-- a/ // |-- b/ // | `-- c/ // | `-- x.txt // `-- link -> /tmp/node-test-realpath-abs-kids/a/b/ // realpath(root+'/a/link/c/x.txt') ==> root+'/a/b/c/x.txt' function test_abs_with_kids(cb) { console.log('test_abs_with_kids'); // this one should still run, even if skipSymlinks is set, // because it uses a junction. var type = skipSymlinks ? 'junction' : 'dir'; console.log('using type=%s', type); var root = tmpAbsDir + '/node-test-realpath-abs-kids'; function cleanup() { ['/a/b/c/x.txt', '/a/link' ].forEach(function(file) { try {fs.unlinkSync(root + file);} catch (ex) {} }); ['/a/b/c', '/a/b', '/a', '' ].forEach(function(folder) { try {fs.rmdirSync(root + folder);} catch (ex) {} }); } function setup() { cleanup(); ['', '/a', '/a/b', '/a/b/c' ].forEach(function(folder) { console.log('mkdir ' + root + folder); fs.mkdirSync(root + folder, 0o700); }); fs.writeFileSync(root + '/a/b/c/x.txt', 'foo'); fs.symlinkSync(root + '/a/b', root + '/a/link', type); } setup(); var linkPath = root + '/a/link/c/x.txt'; var expectPath = root + '/a/b/c/x.txt'; var actual = fs.realpathSync(linkPath); // console.log({link:linkPath,expect:expectPath,actual:actual},'sync'); assert.equal(actual, path.resolve(expectPath)); asynctest(fs.realpath, [linkPath], cb, function(er, actual) { // console.log({link:linkPath,expect:expectPath,actual:actual},'async'); assert.equal(actual, path.resolve(expectPath)); cleanup(); }); } function test_lying_cache_liar(cb) { var n = 2; // this should not require *any* stat calls, since everything // checked by realpath will be found in the cache. console.log('test_lying_cache_liar'); var cache = { '/foo/bar/baz/bluff': '/foo/bar/bluff', '/1/2/3/4/5/6/7': '/1', '/a': '/a', '/a/b': '/a/b', '/a/b/c': '/a/b', '/a/b/d': '/a/b/d' }; if (common.isWindows) { var wc = {}; Object.keys(cache).forEach(function(k) { wc[ path.resolve(k) ] = path.resolve(cache[k]); }); cache = wc; } var bluff = path.resolve('/foo/bar/baz/bluff'); var rps = fs.realpathSync(bluff, cache); assert.equal(cache[bluff], rps); var nums = path.resolve('/1/2/3/4/5/6/7'); var called = false; // no sync cb calling! fs.realpath(nums, cache, function(er, rp) { called = true; assert.equal(cache[nums], rp); if (--n === 0) cb(); }); assert(called === false); const test = path.resolve('/a/b/c/d'); const expect = path.resolve('/a/b/d'); var actual = fs.realpathSync(test, cache); assert.equal(expect, actual); fs.realpath(test, cache, function(er, actual) { assert.equal(expect, actual); if (--n === 0) cb(); }); } // ---------------------------------------------------------------------------- var tests = [ test_simple_error_callback, test_simple_relative_symlink, test_simple_absolute_symlink, test_deep_relative_file_symlink, test_deep_relative_dir_symlink, test_cyclic_link_protection, test_cyclic_link_overprotection, test_relative_input_cwd, test_deep_symlink_mix, test_non_symlinks, test_escape_cwd, test_abs_with_kids, test_lying_cache_liar, test_up_multiple ]; var numtests = tests.length; var testsRun = 0; function runNextTest(err) { if (err) throw err; var test = tests.shift(); if (!test) { return console.log(numtests + ' subtests completed OK for fs.realpath'); } testsRun++; test(runNextTest); } assert.equal(root, fs.realpathSync('/')); fs.realpath('/', function(err, result) { assert.equal(null, err); assert.equal(root, result); }); function runTest() { var tmpDirs = ['cycles', 'cycles/folder']; tmpDirs.forEach(function(t) { t = tmp(t); fs.mkdirSync(t, 0o700); }); fs.writeFileSync(tmp('cycles/root.js'), "console.error('roooot!');"); console.error('start tests'); runNextTest(); } process.on('exit', function() { assert.equal(numtests, testsRun); unlink.forEach(function(path) { try {fs.unlinkSync(path);} catch (e) {} }); assert.equal(async_completed, async_expected); }); node-v4.8.2/test/parallel/test-fs-sir-writes-alot.js000644 000766 000024 00000002313 13070706737 022522 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var fs = require('fs'); var assert = require('assert'); var join = require('path').join; var filename = join(common.tmpDir, 'out.txt'); common.refreshTmpDir(); var fd = fs.openSync(filename, 'w'); var line = 'aaaaaaaaaaaaaaaaaaaaaaaaaaaa\n'; var N = 10240, complete = 0; for (var i = 0; i < N; i++) { // Create a new buffer for each write. Before the write is actually // executed by the thread pool, the buffer will be collected. var buffer = new Buffer(line); fs.write(fd, buffer, 0, buffer.length, null, function(er, written) { complete++; if (complete === N) { fs.closeSync(fd); var s = fs.createReadStream(filename); s.on('data', testBuffer); } }); } var bytesChecked = 0; function testBuffer(b) { for (var i = 0; i < b.length; i++) { bytesChecked++; if (b[i] !== 'a'.charCodeAt(0) && b[i] !== '\n'.charCodeAt(0)) { throw new Error('invalid char ' + i + ',' + b[i]); } } } process.on('exit', function() { // Probably some of the writes are going to overlap, so we can't assume // that we get (N * line.length). Let's just make sure we've checked a // few... assert.ok(bytesChecked > 1000); }); node-v4.8.2/test/parallel/test-fs-stat.js000644 000766 000024 00000004063 13070706737 020434 0ustar00iojsstaff000000 000000 /* eslint-disable strict */ const common = require('../common'); var assert = require('assert'); var fs = require('fs'); fs.stat('.', common.mustCall(function(err, stats) { assert.ifError(err); assert.ok(stats.mtime instanceof Date); assert(this === global); })); fs.stat('.', common.mustCall(function(err, stats) { assert.ok(stats.hasOwnProperty('blksize')); assert.ok(stats.hasOwnProperty('blocks')); })); fs.lstat('.', common.mustCall(function(err, stats) { assert.ifError(err); assert.ok(stats.mtime instanceof Date); assert(this === global); })); // fstat fs.open('.', 'r', undefined, common.mustCall(function(err, fd) { assert.ok(!err); assert.ok(fd); fs.fstat(fd, common.mustCall(function(err, stats) { assert.ifError(err); assert.ok(stats.mtime instanceof Date); fs.close(fd); assert(this === global); })); assert(this === global); })); // fstatSync fs.open('.', 'r', undefined, common.mustCall(function(err, fd) { var stats; try { stats = fs.fstatSync(fd); } catch (err) { common.fail(err); } if (stats) { console.dir(stats); assert.ok(stats.mtime instanceof Date); } fs.close(fd); })); console.log(`stating: ${__filename}`); fs.stat(__filename, common.mustCall(function(err, s) { assert.ifError(err); console.dir(s); console.log('isDirectory: ' + JSON.stringify(s.isDirectory())); assert.equal(false, s.isDirectory()); console.log('isFile: ' + JSON.stringify(s.isFile())); assert.equal(true, s.isFile()); console.log('isSocket: ' + JSON.stringify(s.isSocket())); assert.equal(false, s.isSocket()); console.log('isBlockDevice: ' + JSON.stringify(s.isBlockDevice())); assert.equal(false, s.isBlockDevice()); console.log('isCharacterDevice: ' + JSON.stringify(s.isCharacterDevice())); assert.equal(false, s.isCharacterDevice()); console.log('isFIFO: ' + JSON.stringify(s.isFIFO())); assert.equal(false, s.isFIFO()); console.log('isSymbolicLink: ' + JSON.stringify(s.isSymbolicLink())); assert.equal(false, s.isSymbolicLink()); assert.ok(s.mtime instanceof Date); })); node-v4.8.2/test/parallel/test-fs-stream-double-close.js000644 000766 000024 00000001312 13070706737 023321 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var fs = require('fs'); common.refreshTmpDir(); test1(fs.createReadStream(__filename)); test2(fs.createReadStream(__filename)); test3(fs.createReadStream(__filename)); test1(fs.createWriteStream(common.tmpDir + '/dummy1')); test2(fs.createWriteStream(common.tmpDir + '/dummy2')); test3(fs.createWriteStream(common.tmpDir + '/dummy3')); function test1(stream) { stream.destroy(); stream.destroy(); } function test2(stream) { stream.destroy(); stream.on('open', common.mustCall(function(fd) { stream.destroy(); })); } function test3(stream) { stream.on('open', common.mustCall(function(fd) { stream.destroy(); stream.destroy(); })); } node-v4.8.2/test/parallel/test-fs-symlink-dir-junction-relative.js000644 000766 000024 00000001740 13070706737 025362 0ustar00iojsstaff000000 000000 'use strict'; // Test creating and resolving relative junction or symbolic link var common = require('../common'); var assert = require('assert'); var path = require('path'); var fs = require('fs'); var linkPath1 = path.join(common.tmpDir, 'junction1'); var linkPath2 = path.join(common.tmpDir, 'junction2'); var linkTarget = path.join(common.fixturesDir); var linkData = path.join(common.fixturesDir); common.refreshTmpDir(); // Test fs.symlink() fs.symlink(linkData, linkPath1, 'junction', common.mustCall(function(err) { if (err) throw err; verifyLink(linkPath1); })); // Test fs.symlinkSync() fs.symlinkSync(linkData, linkPath2, 'junction'); verifyLink(linkPath2); function verifyLink(linkPath) { var stats = fs.lstatSync(linkPath); assert.ok(stats.isSymbolicLink()); var data1 = fs.readFileSync(linkPath + '/x.txt', 'ascii'); var data2 = fs.readFileSync(linkTarget + '/x.txt', 'ascii'); assert.strictEqual(data1, data2); // Clean up. fs.unlinkSync(linkPath); } node-v4.8.2/test/parallel/test-fs-symlink-dir-junction.js000644 000766 000024 00000001705 13070706737 023552 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var path = require('path'); var fs = require('fs'); // test creating and reading symbolic link var linkData = path.join(common.fixturesDir, 'cycles/'); var linkPath = path.join(common.tmpDir, 'cycles_link'); common.refreshTmpDir(); console.log('linkData: ' + linkData); console.log('linkPath: ' + linkPath); fs.symlink(linkData, linkPath, 'junction', common.mustCall(function(err) { if (err) throw err; fs.lstat(linkPath, common.mustCall(function(err, stats) { if (err) throw err; assert.ok(stats.isSymbolicLink()); fs.readlink(linkPath, common.mustCall(function(err, destination) { if (err) throw err; assert.equal(destination, linkData); fs.unlink(linkPath, common.mustCall(function(err) { if (err) throw err; assert(!common.fileExists(linkPath)); assert(common.fileExists(linkData)); })); })); })); })); node-v4.8.2/test/parallel/test-fs-symlink.js000644 000766 000024 00000002432 13070706737 021145 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const path = require('path'); const fs = require('fs'); const exec = require('child_process').exec; var linkTime; var fileTime; if (common.isWindows) { // On Windows, creating symlinks requires admin privileges. // We'll only try to run symlink test if we have enough privileges. exec('whoami /priv', function(err, o) { if (err || o.indexOf('SeCreateSymbolicLinkPrivilege') == -1) { common.skip('insufficient privileges'); return; } }); } common.refreshTmpDir(); // test creating and reading symbolic link const linkData = path.join(common.fixturesDir, '/cycles/root.js'); const linkPath = path.join(common.tmpDir, 'symlink1.js'); fs.symlink(linkData, linkPath, function(err) { if (err) throw err; fs.lstat(linkPath, common.mustCall(function(err, stats) { if (err) throw err; linkTime = stats.mtime.getTime(); })); fs.stat(linkPath, common.mustCall(function(err, stats) { if (err) throw err; fileTime = stats.mtime.getTime(); })); fs.readlink(linkPath, common.mustCall(function(err, destination) { if (err) throw err; assert.equal(destination, linkData); })); }); process.on('exit', function() { assert.notStrictEqual(linkTime, fileTime); }); node-v4.8.2/test/parallel/test-fs-sync-fd-leak.js000644 000766 000024 00000001630 13070706737 021733 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var fs = require('fs'); // ensure that (read|write|append)FileSync() closes the file descriptor fs.openSync = function() { return 42; }; fs.closeSync = function(fd) { assert.equal(fd, 42); close_called++; }; fs.readSync = function() { throw new Error('BAM'); }; fs.writeSync = function() { throw new Error('BAM'); }; fs.fstatSync = function() { throw new Error('BAM'); }; ensureThrows(function() { fs.readFileSync('dummy'); }); ensureThrows(function() { fs.writeFileSync('dummy', 'xxx'); }); ensureThrows(function() { fs.appendFileSync('dummy', 'xxx'); }); var close_called = 0; function ensureThrows(cb) { var got_exception = false; close_called = 0; try { cb(); } catch (e) { assert.equal(e.message, 'BAM'); got_exception = true; } assert.equal(close_called, 1); assert.equal(got_exception, true); } node-v4.8.2/test/parallel/test-fs-truncate-fd.js000644 000766 000024 00000001067 13070706737 021676 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var path = require('path'); var fs = require('fs'); var tmp = common.tmpDir; common.refreshTmpDir(); var filename = path.resolve(tmp, 'truncate-file.txt'); fs.writeFileSync(filename, 'hello world', 'utf8'); var fd = fs.openSync(filename, 'r+'); fs.truncate(fd, 5, common.mustCall(function(err) { assert.ok(!err); assert.equal(fs.readFileSync(filename, 'utf8'), 'hello'); })); process.on('exit', function() { fs.closeSync(fd); fs.unlinkSync(filename); console.log('ok'); }); node-v4.8.2/test/parallel/test-fs-truncate-GH-6233.js000644 000766 000024 00000001347 13070706737 022177 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var fs = require('fs'); var filename = common.tmpDir + '/truncate-file.txt'; common.refreshTmpDir(); // Synchronous test. (function() { fs.writeFileSync(filename, '0123456789'); assert.equal(fs.readFileSync(filename).toString(), '0123456789'); fs.truncateSync(filename, 5); assert.equal(fs.readFileSync(filename).toString(), '01234'); })(); // Asynchronous test. (function() { fs.writeFileSync(filename, '0123456789'); assert.equal(fs.readFileSync(filename).toString(), '0123456789'); fs.truncate(filename, 5, common.mustCall(function(err) { if (err) throw err; assert.equal(fs.readFileSync(filename).toString(), '01234'); })); })(); node-v4.8.2/test/parallel/test-fs-truncate.js000644 000766 000024 00000005152 13070706737 021306 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var path = require('path'); var fs = require('fs'); var tmp = common.tmpDir; var filename = path.resolve(tmp, 'truncate-file.txt'); var data = new Buffer(1024 * 16); data.fill('x'); common.refreshTmpDir(); var stat; // truncateSync fs.writeFileSync(filename, data); stat = fs.statSync(filename); assert.equal(stat.size, 1024 * 16); fs.truncateSync(filename, 1024); stat = fs.statSync(filename); assert.equal(stat.size, 1024); fs.truncateSync(filename); stat = fs.statSync(filename); assert.equal(stat.size, 0); // ftruncateSync fs.writeFileSync(filename, data); var fd = fs.openSync(filename, 'r+'); stat = fs.statSync(filename); assert.equal(stat.size, 1024 * 16); fs.ftruncateSync(fd, 1024); stat = fs.statSync(filename); assert.equal(stat.size, 1024); fs.ftruncateSync(fd); stat = fs.statSync(filename); assert.equal(stat.size, 0); fs.closeSync(fd); // async tests testTruncate(common.mustCall(function(er) { if (er) throw er; testFtruncate(common.mustCall(function(er) { if (er) throw er; })); })); function testTruncate(cb) { fs.writeFile(filename, data, function(er) { if (er) return cb(er); fs.stat(filename, function(er, stat) { if (er) return cb(er); assert.equal(stat.size, 1024 * 16); fs.truncate(filename, 1024, function(er) { if (er) return cb(er); fs.stat(filename, function(er, stat) { if (er) return cb(er); assert.equal(stat.size, 1024); fs.truncate(filename, function(er) { if (er) return cb(er); fs.stat(filename, function(er, stat) { if (er) return cb(er); assert.equal(stat.size, 0); cb(); }); }); }); }); }); }); } function testFtruncate(cb) { fs.writeFile(filename, data, function(er) { if (er) return cb(er); fs.stat(filename, function(er, stat) { if (er) return cb(er); assert.equal(stat.size, 1024 * 16); fs.open(filename, 'w', function(er, fd) { if (er) return cb(er); fs.ftruncate(fd, 1024, function(er) { if (er) return cb(er); fs.stat(filename, function(er, stat) { if (er) return cb(er); assert.equal(stat.size, 1024); fs.ftruncate(fd, function(er) { if (er) return cb(er); fs.stat(filename, function(er, stat) { if (er) return cb(er); assert.equal(stat.size, 0); fs.close(fd, cb); }); }); }); }); }); }); }); } node-v4.8.2/test/parallel/test-fs-utimes.js000644 000766 000024 00000007442 13070706737 020773 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var util = require('util'); var fs = require('fs'); let tests_ok = 0; let tests_run = 0; function stat_resource(resource) { if (typeof resource === 'string') { return fs.statSync(resource); } else { // ensure mtime has been written to disk fs.fsyncSync(resource); return fs.fstatSync(resource); } } function check_mtime(resource, mtime) { mtime = fs._toUnixTimestamp(mtime); const stats = stat_resource(resource); const real_mtime = fs._toUnixTimestamp(stats.mtime); // check up to single-second precision // sub-second precision is OS and fs dependant return mtime - real_mtime < 2; } function expect_errno(syscall, resource, err, errno) { if (err && (err.code === errno || err.code === 'ENOSYS')) { tests_ok++; } else { console.log('FAILED:', 'expect_errno', util.inspect(arguments)); } } function expect_ok(syscall, resource, err, atime, mtime) { if (!err && check_mtime(resource, mtime) || err && err.code === 'ENOSYS') { tests_ok++; } else { console.log('FAILED:', 'expect_ok', util.inspect(arguments)); } } // the tests assume that __filename belongs to the user running the tests // this should be a fairly safe assumption; testing against a temp file // would be even better though (node doesn't have such functionality yet) function testIt(atime, mtime, callback) { let fd; // // test synchronized code paths, these functions throw on failure // function syncTests() { fs.utimesSync(__filename, atime, mtime); expect_ok('utimesSync', __filename, undefined, atime, mtime); tests_run++; // some systems don't have futimes // if there's an error, it should be ENOSYS try { tests_run++; fs.futimesSync(fd, atime, mtime); expect_ok('futimesSync', fd, undefined, atime, mtime); } catch (ex) { expect_errno('futimesSync', fd, ex, 'ENOSYS'); } let err = undefined; try { fs.utimesSync('foobarbaz', atime, mtime); } catch (ex) { err = ex; } expect_errno('utimesSync', 'foobarbaz', err, 'ENOENT'); tests_run++; err = undefined; try { fs.futimesSync(-1, atime, mtime); } catch (ex) { err = ex; } expect_errno('futimesSync', -1, err, 'EBADF'); tests_run++; } // // test async code paths // fs.utimes(__filename, atime, mtime, common.mustCall(function(err) { expect_ok('utimes', __filename, err, atime, mtime); fs.utimes('foobarbaz', atime, mtime, common.mustCall(function(err) { expect_errno('utimes', 'foobarbaz', err, 'ENOENT'); // don't close this fd if (common.isWindows) { fd = fs.openSync(__filename, 'r+'); } else { fd = fs.openSync(__filename, 'r'); } fs.futimes(fd, atime, mtime, common.mustCall(function(err) { expect_ok('futimes', fd, err, atime, mtime); fs.futimes(-1, atime, mtime, common.mustCall(function(err) { expect_errno('futimes', -1, err, 'EBADF'); syncTests(); callback(); })); tests_run++; })); tests_run++; })); tests_run++; })); tests_run++; } const stats = fs.statSync(__filename); // run tests const runTest = common.mustCall(testIt, 6); runTest(new Date('1982-09-10 13:37'), new Date('1982-09-10 13:37'), function() { runTest(new Date(), new Date(), function() { runTest(123456.789, 123456.789, function() { runTest(stats.mtime, stats.mtime, function() { runTest(NaN, Infinity, function() { runTest('123456', -1, common.mustCall(function() { // done })); }); }); }); }); }); process.on('exit', function() { console.log('Tests run / ok:', tests_run, '/', tests_ok); assert.strictEqual(tests_ok, tests_run); }); node-v4.8.2/test/parallel/test-fs-watch-enoent.js000644 000766 000024 00000001105 13070706737 022047 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const fs = require('fs'); assert.throws(function() { fs.watch('non-existent-file'); }, function(err) { assert(err); assert(/non-existent-file/.test(err)); assert.equal(err.filename, 'non-existent-file'); return true; }); const watcher = fs.watch(__filename); watcher.on('error', common.mustCall(function(err) { assert(err); assert(/non-existent-file/.test(err)); assert.equal(err.filename, 'non-existent-file'); })); watcher._handle.onchange(-1, 'ENOENT', 'non-existent-file'); node-v4.8.2/test/parallel/test-fs-watch-recursive.js000644 000766 000024 00000002374 13070706737 022577 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); if (!(process.platform === 'darwin' || common.isWindows)) { common.skip('recursive option is darwin/windows specific'); return; } const assert = require('assert'); const path = require('path'); const fs = require('fs'); const testDir = common.tmpDir; const filenameOne = 'watch.txt'; const testsubdirName = 'testsubdir'; const testsubdir = path.join(testDir, testsubdirName); const relativePathOne = path.join('testsubdir', filenameOne); const filepathOne = path.join(testsubdir, filenameOne); common.refreshTmpDir(); fs.mkdirSync(testsubdir, 0o700); const watcher = fs.watch(testDir, {recursive: true}); var watcherClosed = false; watcher.on('change', function(event, filename) { assert.ok('change' === event || 'rename' === event); // Ignore stale events generated by mkdir and other tests if (filename !== relativePathOne) return; if (common.isOSX) { clearInterval(interval); } watcher.close(); watcherClosed = true; }); if (common.isOSX) { var interval = setInterval(function() { fs.writeFileSync(filepathOne, 'world'); }, 10); } else { fs.writeFileSync(filepathOne, 'world'); } process.on('exit', function() { assert(watcherClosed, 'watcher Object was not closed'); }); node-v4.8.2/test/parallel/test-fs-watchfile.js000644 000766 000024 00000004677 13070706737 021442 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const fs = require('fs'); const path = require('path'); const assert = require('assert'); // Basic usage tests. assert.throws(function() { fs.watchFile('./some-file'); }, /watchFile requires a listener function/); assert.throws(function() { fs.watchFile('./another-file', {}, 'bad listener'); }, /watchFile requires a listener function/); assert.throws(function() { fs.watchFile(new Object(), function() {}); }, /Path must be a string/); const enoentFile = path.join(common.tmpDir, 'non-existent-file'); const expectedStatObject = new fs.Stats( 0, // dev 0, // mode 0, // nlink 0, // uid 0, // gid 0, // rdev common.isWindows ? undefined : 0, // blksize 0, // ino 0, // size common.isWindows ? undefined : 0, // blocks Date.UTC(1970, 0, 1, 0, 0, 0), // atime Date.UTC(1970, 0, 1, 0, 0, 0), // mtime Date.UTC(1970, 0, 1, 0, 0, 0), // ctime Date.UTC(1970, 0, 1, 0, 0, 0) // birthtime ); common.refreshTmpDir(); // If the file initially didn't exist, and gets created at a later point of // time, the callback should be invoked again with proper values in stat object var fileExists = false; fs.watchFile(enoentFile, {interval: 0}, common.mustCall(function(curr, prev) { if (!fileExists) { // If the file does not exist, all the fields should be zero and the date // fields should be UNIX EPOCH time assert.deepStrictEqual(curr, expectedStatObject); assert.deepStrictEqual(prev, expectedStatObject); // Create the file now, so that the callback will be called back once the // event loop notices it. fs.closeSync(fs.openSync(enoentFile, 'w')); fileExists = true; } else { // If the ino (inode) value is greater than zero, it means that the file is // present in the filesystem and it has a valid inode number. assert(curr.ino > 0); // As the file just got created, previous ino value should be lesser than // or equal to zero (non-existent file). assert(prev.ino <= 0); // Stop watching the file fs.unwatchFile(enoentFile); } }, 2)); node-v4.8.2/test/parallel/test-fs-write-buffer.js000644 000766 000024 00000001512 13070706737 022056 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const path = require('path'); const Buffer = require('buffer').Buffer; const fs = require('fs'); const filename = path.join(common.tmpDir, 'write.txt'); const expected = Buffer.from('hello'); common.refreshTmpDir(); fs.open(filename, 'w', 0o644, common.mustCall(function(err, fd) { if (err) throw err; fs.write(fd, expected, 0, expected.length, null, common.mustCall(function(err, written) { if (err) throw err; assert.equal(expected.length, written); fs.closeSync(fd); var found = fs.readFileSync(filename, 'utf8'); assert.deepStrictEqual(expected.toString(), found); fs.unlinkSync(filename); })); })); node-v4.8.2/test/parallel/test-fs-write-file-buffer.js000644 000766 000024 00000002614 13070706737 022777 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var join = require('path').join; var util = require('util'); var fs = require('fs'); var data = [ '/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAUDBAQEAwUEBAQFBQUGBwwIBwcH', 'Bw8LCwkMEQ8SEhEPERETFhwXExQaFRERGCEYGh0dHx8fExciJCIeJBweHx7/', '2wBDAQUFBQcGBw4ICA4eFBEUHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4eHh4e', 'Hh4eHh4eHh4eHh4eHh4eHh4eHh4eHh7/wAARCAAQABADASIAAhEBAxEB/8QA', 'HwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUF', 'BAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkK', 'FhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1', 'dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXG', 'x8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEB', 'AQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAEC', 'AxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRom', 'JygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOE', 'hYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU', '1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwDhfBUFl/wk', 'OmPqKJJZw3aiZFBw4z93jnkkc9u9dj8XLfSI/EBt7DTo7ea2Ox5YXVo5FC7g', 'Tjq24nJPXNVtO0KATRvNHCIg3zoWJWQHqp+o4pun+EtJ0zxBq8mnLJa2d1L5', '0NvnKRjJBUE5PAx3NYxxUY0pRtvYHSc5Ka2X9d7H/9k=']; data = data.join('\n'); common.refreshTmpDir(); var buf = new Buffer(data, 'base64'); fs.writeFileSync(join(common.tmpDir, 'test.jpg'), buf); util.log('Done!'); node-v4.8.2/test/parallel/test-fs-write-file-sync.js000644 000766 000024 00000002625 13070706737 022504 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var path = require('path'); var fs = require('fs'); var openCount = 0; var mode; var content; // Need to hijack fs.open/close to make sure that things // get closed once they're opened. fs._openSync = fs.openSync; fs.openSync = openSync; fs._closeSync = fs.closeSync; fs.closeSync = closeSync; // Reset the umask for testing process.umask(0o000); // On Windows chmod is only able to manipulate read-only bit. Test if creating // the file in read-only mode works. if (common.isWindows) { mode = 0o444; } else { mode = 0o755; } common.refreshTmpDir(); // Test writeFileSync var file1 = path.join(common.tmpDir, 'testWriteFileSync.txt'); fs.writeFileSync(file1, '123', {mode: mode}); content = fs.readFileSync(file1, {encoding: 'utf8'}); assert.equal('123', content); assert.equal(mode, fs.statSync(file1).mode & 0o777); // Test appendFileSync var file2 = path.join(common.tmpDir, 'testAppendFileSync.txt'); fs.appendFileSync(file2, 'abc', {mode: mode}); content = fs.readFileSync(file2, {encoding: 'utf8'}); assert.equal('abc', content); assert.equal(mode, fs.statSync(file2).mode & mode); // Verify that all opened files were closed. assert.equal(0, openCount); function openSync() { openCount++; return fs._openSync.apply(fs, arguments); } function closeSync() { openCount--; return fs._closeSync.apply(fs, arguments); } node-v4.8.2/test/parallel/test-fs-write-file.js000644 000766 000024 00000004444 13070706737 021533 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var fs = require('fs'); var join = require('path').join; common.refreshTmpDir(); var filename = join(common.tmpDir, 'test.txt'); var n = 220; var s = '南越国是前203年至前111年存在于岭南地区的一个国家，国都位于番禺，疆域包括今天中国的广东、' + '广西两省区的大部份地区，福建省、湖南、贵州、云南的一小部份地区和越南的北部。' + '南越国是秦朝灭亡后，由南海郡尉赵佗于前203年起兵兼并桂林郡和象郡后建立。' + '前196年和前179年，南越国曾先后两次名义上臣属于西汉，成为西汉的“外臣”。前112年，' + '南越国末代君主赵建德与西汉发生战争，被汉武帝于前111年所灭。南越国共存在93年，' + '历经五代君主。南越国是岭南地区的第一个有记载的政权国家，采用封建制和郡县制并存的制度，' + '它的建立保证了秦末乱世岭南地区社会秩序的稳定，有效的改善了岭南地区落后的政治、##济现状。\n'; fs.writeFile(filename, s, common.mustCall(function(e) { if (e) throw e; fs.readFile(filename, common.mustCall(function(e, buffer) { if (e) throw e; assert.equal(Buffer.byteLength(s), buffer.length); })); })); // test that writeFile accepts buffers var filename2 = join(common.tmpDir, 'test2.txt'); var buf = new Buffer(s, 'utf8'); fs.writeFile(filename2, buf, common.mustCall(function(e) { if (e) throw e; fs.readFile(filename2, common.mustCall(function(e, buffer) { if (e) throw e; assert.equal(buf.length, buffer.length); })); })); // test that writeFile accepts numbers. var filename3 = join(common.tmpDir, 'test3.txt'); var m = 0o600; fs.writeFile(filename3, n, { mode: m }, common.mustCall(function(e) { if (e) throw e; // windows permissions aren't unix if (!common.isWindows) { var st = fs.statSync(filename3); assert.equal(st.mode & 0o700, m); } fs.readFile(filename3, common.mustCall(function(e, buffer) { if (e) throw e; assert.equal(Buffer.byteLength('' + n), buffer.length); })); })); process.on('exit', function() { fs.unlinkSync(filename); fs.unlinkSync(filename2); fs.unlinkSync(filename3); }); node-v4.8.2/test/parallel/test-fs-write-no-fd.js000644 000766 000024 00000000376 13070706737 021617 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const fs = require('fs'); const assert = require('assert'); assert.throws(function() { fs.write(null, new Buffer(1), 0, 1); }, /TypeError/); assert.throws(function() { fs.write(null, '1', 0, 1); }, /TypeError/); node-v4.8.2/test/parallel/test-fs-write-stream-change-open.js000644 000766 000024 00000001476 13070706737 024273 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const path = require('path'); const fs = require('fs'); var file = path.join(common.tmpDir, 'write.txt'); common.refreshTmpDir(); const stream = fs.WriteStream(file); const _fs_close = fs.close; const _fs_open = fs.open; // change the fs.open with an identical function after the WriteStream // has pushed it onto its internal action queue, but before it's // returned. This simulates AOP-style extension of the fs lib. fs.open = function() { return _fs_open.apply(fs, arguments); }; fs.close = function(fd) { assert.ok(fd, 'fs.close must not be called with an undefined fd.'); fs.close = _fs_close; fs.open = _fs_open; }; stream.write('foo'); stream.end(); process.on('exit', function() { assert.equal(fs.open, _fs_open); }); node-v4.8.2/test/parallel/test-fs-write-stream-encoding.js000644 000766 000024 00000001707 13070706737 023672 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const fs = require('fs'); const path = require('path'); const stream = require('stream'); const firstEncoding = 'base64'; const secondEncoding = 'binary'; const examplePath = path.join(common.fixturesDir, 'x.txt'); const dummyPath = path.join(common.tmpDir, 'x.txt'); common.refreshTmpDir(); const exampleReadStream = fs.createReadStream(examplePath, { encoding: firstEncoding }); const dummyWriteStream = fs.createWriteStream(dummyPath, { encoding: firstEncoding }); exampleReadStream.pipe(dummyWriteStream).on('finish', function() { const assertWriteStream = new stream.Writable({ write: function(chunk, enc, next) { const expected = new Buffer('xyz\n'); assert(chunk.equals(expected)); } }); assertWriteStream.setDefaultEncoding(secondEncoding); fs.createReadStream(dummyPath, { encoding: secondEncoding }).pipe(assertWriteStream); }); node-v4.8.2/test/parallel/test-fs-write-stream-end.js000644 000766 000024 00000001212 13070706737 022641 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var path = require('path'); var fs = require('fs'); common.refreshTmpDir(); (function() { var file = path.join(common.tmpDir, 'write-end-test0.txt'); var stream = fs.createWriteStream(file); stream.end(); stream.on('close', common.mustCall(function() { })); })(); (function() { var file = path.join(common.tmpDir, 'write-end-test1.txt'); var stream = fs.createWriteStream(file); stream.end('a\n', 'utf8'); stream.on('close', common.mustCall(function() { var content = fs.readFileSync(file, 'utf8'); assert.equal(content, 'a\n'); })); })(); node-v4.8.2/test/parallel/test-fs-write-stream-err.js000644 000766 000024 00000002344 13070706737 022672 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var fs = require('fs'); common.refreshTmpDir(); var stream = fs.createWriteStream(common.tmpDir + '/out', { highWaterMark: 10 }); var err = new Error('BAM'); var write = fs.write; var writeCalls = 0; fs.write = function() { switch (writeCalls++) { case 0: console.error('first write'); // first time is ok. return write.apply(fs, arguments); case 1: // then it breaks console.error('second write'); var cb = arguments[arguments.length - 1]; return process.nextTick(function() { cb(err); }); default: // and should not be called again! throw new Error('BOOM!'); } }; fs.close = common.mustCall(function(fd_, cb) { console.error('fs.close', fd_, stream.fd); assert.equal(fd_, stream.fd); process.nextTick(cb); }); stream.on('error', common.mustCall(function(err_) { console.error('error handler'); assert.equal(stream.fd, null); assert.equal(err_, err); })); stream.write(new Buffer(256), function() { console.error('first cb'); stream.write(new Buffer(256), common.mustCall(function(err_) { console.error('second cb'); assert.equal(err_, err); })); }); node-v4.8.2/test/parallel/test-fs-write-stream-throw-type-error.js000644 000766 000024 00000001775 13070706737 025362 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const fs = require('fs'); const path = require('path'); const example = path.join(common.tmpDir, 'dummy'); common.refreshTmpDir(); assert.doesNotThrow(function() { fs.createWriteStream(example, undefined); }); assert.doesNotThrow(function() { fs.createWriteStream(example, 'utf8'); }); assert.doesNotThrow(function() { fs.createWriteStream(example, {encoding: 'utf8'}); }); assert.throws(function() { fs.createWriteStream(example, null); }, /options must be a string or an object/); assert.throws(function() { fs.createWriteStream(example, 123); }, /options must be a string or an object/); assert.throws(function() { fs.createWriteStream(example, 0); }, /options must be a string or an object/); assert.throws(function() { fs.createWriteStream(example, true); }, /options must be a string or an object/); assert.throws(function() { fs.createWriteStream(example, false); }, /options must be a string or an object/); node-v4.8.2/test/parallel/test-fs-write-stream.js000644 000766 000024 00000001332 13070706737 022100 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const path = require('path'); const fs = require('fs'); var file = path.join(common.tmpDir, 'write.txt'); common.refreshTmpDir(); (function() { const stream = fs.WriteStream(file); const _fs_close = fs.close; fs.close = function(fd) { assert.ok(fd, 'fs.close must not be called without an undefined fd.'); fs.close = _fs_close; }; stream.destroy(); })(); (function() { var stream = fs.createWriteStream(file); stream.on('drain', function() { assert.fail(null, null, '\'drain\' event must not be emitted before ' + 'stream.write() has been called at least once.'); }); stream.destroy(); })(); node-v4.8.2/test/parallel/test-fs-write-string-coerce.js000644 000766 000024 00000001473 13070706737 023357 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var path = require('path'); var Buffer = require('buffer').Buffer; var fs = require('fs'); common.refreshTmpDir(); var fn = path.join(common.tmpDir, 'write-string-coerce.txt'); var data = true; var expected = data + ''; fs.open(fn, 'w', 0o644, common.mustCall(function(err, fd) { if (err) throw err; console.log('open done'); fs.write(fd, data, 0, 'utf8', common.mustCall(function(err, written) { console.log('write done'); if (err) throw err; assert.equal(Buffer.byteLength(expected), written); fs.closeSync(fd); const found = fs.readFileSync(fn, 'utf8'); console.log('expected: "%s"', expected); console.log('found: "%s"', found); fs.unlinkSync(fn); assert.strictEqual(expected, found); })); })); node-v4.8.2/test/parallel/test-fs-write-sync.js000644 000766 000024 00000001020 13070706737 021553 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var path = require('path'); var fs = require('fs'); var fn = path.join(common.tmpDir, 'write.txt'); common.refreshTmpDir(); var foo = 'foo'; var fd = fs.openSync(fn, 'w'); var written = fs.writeSync(fd, ''); assert.strictEqual(0, written); fs.writeSync(fd, foo); var bar = 'bár'; written = fs.writeSync(fd, new Buffer(bar), 0, Buffer.byteLength(bar)); assert.ok(written > 3); fs.closeSync(fd); assert.equal(fs.readFileSync(fn), 'foobár'); node-v4.8.2/test/parallel/test-fs-write.js000644 000766 000024 00000003301 13070706737 020605 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var path = require('path'); var Buffer = require('buffer').Buffer; var fs = require('fs'); var fn = path.join(common.tmpDir, 'write.txt'); var fn2 = path.join(common.tmpDir, 'write2.txt'); var expected = 'ümlaut.'; var constants = require('constants'); common.refreshTmpDir(); fs.open(fn, 'w', 0o644, common.mustCall(function(err, fd) { if (err) throw err; console.log('open done'); fs.write(fd, '', 0, 'utf8', function(err, written) { assert.equal(0, written); }); fs.write(fd, expected, 0, 'utf8', common.mustCall(function(err, written) { console.log('write done'); if (err) throw err; assert.equal(Buffer.byteLength(expected), written); fs.closeSync(fd); const found = fs.readFileSync(fn, 'utf8'); console.log('expected: "%s"', expected); console.log('found: "%s"', found); fs.unlinkSync(fn); assert.strictEqual(expected, found); })); })); fs.open(fn2, constants.O_CREAT | constants.O_WRONLY | constants.O_TRUNC, 0o644, common.mustCall(function(err, fd) { if (err) throw err; console.log('open done'); fs.write(fd, '', 0, 'utf8', function(err, written) { assert.equal(0, written); }); fs.write(fd, expected, 0, 'utf8', common.mustCall(function(err, written) { console.log('write done'); if (err) throw err; assert.equal(Buffer.byteLength(expected), written); fs.closeSync(fd); const found = fs.readFileSync(fn2, 'utf8'); console.log('expected: "%s"', expected); console.log('found: "%s"', found); fs.unlinkSync(fn2); assert.strictEqual(expected, found); })); })); node-v4.8.2/test/parallel/test-global.js000644 000766 000024 00000001266 13070706737 020315 0ustar00iojsstaff000000 000000 /* eslint-disable strict */ var common = require('../common'); var path = require('path'); var assert = require('assert'); common.globalCheck = false; baseFoo = 'foo'; // eslint-disable-line no-undef global.baseBar = 'bar'; assert.equal('foo', global.baseFoo, 'x -> global.x in base level not working'); assert.equal('bar', baseBar, // eslint-disable-line no-undef 'global.x -> x in base level not working'); var module = require(path.join(common.fixturesDir, 'global', 'plain')); const fooBar = module.fooBar; assert.equal('foo', fooBar.foo, 'x -> global.x in sub level not working'); assert.equal('bar', fooBar.bar, 'global.x -> x in sub level not working'); node-v4.8.2/test/parallel/test-handle-wrap-close-abort.js000644 000766 000024 00000000561 13070706737 023464 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); process.on('uncaughtException', common.mustCall(function() {}, 2)); setTimeout(function() { process.nextTick(function() { const c = setInterval(function() { clearInterval(c); throw new Error('setInterval'); }, 1); }); setTimeout(function() { throw new Error('setTimeout'); }, 1); }); node-v4.8.2/test/parallel/test-http-1.0-keep-alive.js000644 000766 000024 00000006332 13070706737 022347 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var http = require('http'); var net = require('net'); // Check that our HTTP server correctly handles HTTP/1.0 keep-alive requests. check([{ name: 'keep-alive, no TE header', requests: [{ expectClose: true, data: 'POST / HTTP/1.0\r\n' + 'Connection: keep-alive\r\n' + '\r\n' }, { expectClose: true, data: 'POST / HTTP/1.0\r\n' + 'Connection: keep-alive\r\n' + '\r\n' }], responses: [{ headers: {'Connection': 'keep-alive'}, chunks: ['OK'] }, { chunks: [] }] }, { name: 'keep-alive, with TE: chunked', requests: [{ expectClose: false, data: 'POST / HTTP/1.0\r\n' + 'Connection: keep-alive\r\n' + 'TE: chunked\r\n' + '\r\n' }, { expectClose: true, data: 'POST / HTTP/1.0\r\n' + '\r\n' }], responses: [{ headers: {'Connection': 'keep-alive'}, chunks: ['OK'] }, { chunks: [] }] }, { name: 'keep-alive, with Transfer-Encoding: chunked', requests: [{ expectClose: false, data: 'POST / HTTP/1.0\r\n' + 'Connection: keep-alive\r\n' + '\r\n' }, { expectClose: true, data: 'POST / HTTP/1.0\r\n' + '\r\n' }], responses: [{ headers: {'Connection': 'keep-alive', 'Transfer-Encoding': 'chunked'}, chunks: ['OK'] }, { chunks: [] }] }, { name: 'keep-alive, with Content-Length', requests: [{ expectClose: false, data: 'POST / HTTP/1.0\r\n' + 'Connection: keep-alive\r\n' + '\r\n' }, { expectClose: true, data: 'POST / HTTP/1.0\r\n' + '\r\n' }], responses: [{ headers: {'Connection': 'keep-alive', 'Content-Length': '2'}, chunks: ['OK'] }, { chunks: [] }] }]); function check(tests) { var test = tests[0]; var server; if (test) { server = http.createServer(serverHandler).listen(0, '127.0.0.1', client); } var current = 0; function next() { check(tests.slice(1)); } function serverHandler(req, res) { if (current + 1 === test.responses.length) this.close(); var ctx = test.responses[current]; console.error('< SERVER SENDING RESPONSE', ctx); res.writeHead(200, ctx.headers); ctx.chunks.slice(0, -1).forEach(function(chunk) { res.write(chunk); }); res.end(ctx.chunks[ctx.chunks.length - 1]); } function client() { if (current === test.requests.length) return next(); const port = server.address().port; var conn = net.createConnection(port, '127.0.0.1', connected); function connected() { var ctx = test.requests[current]; console.error(' > CLIENT SENDING REQUEST', ctx); conn.setEncoding('utf8'); conn.write(ctx.data); function onclose() { console.error(' > CLIENT CLOSE'); if (!ctx.expectClose) throw new Error('unexpected close'); client(); } conn.on('close', onclose); function ondata(s) { console.error(' > CLIENT ONDATA %j %j', s.length, s.toString()); current++; if (ctx.expectClose) return; conn.removeListener('close', onclose); conn.removeListener('data', ondata); connected(); } conn.on('data', ondata); } } } node-v4.8.2/test/parallel/test-http-1.0.js000644 000766 000024 00000010122 13070706737 020317 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var net = require('net'); var http = require('http'); var body = 'hello world\n'; function test(handler, request_generator, response_validator) { var server = http.createServer(handler); var client_got_eof = false; var server_response = ''; server.listen(0); server.on('listening', function() { var c = net.createConnection(this.address().port); c.setEncoding('utf8'); c.on('connect', function() { c.write(request_generator()); }); c.on('data', function(chunk) { server_response += chunk; }); c.on('end', common.mustCall(function() { client_got_eof = true; c.end(); server.close(); response_validator(server_response, client_got_eof, false); })); }); } (function() { function handler(req, res) { assert.equal('1.0', req.httpVersion); assert.equal(1, req.httpVersionMajor); assert.equal(0, req.httpVersionMinor); res.writeHead(200, {'Content-Type': 'text/plain'}); res.end(body); } function request_generator() { return 'GET / HTTP/1.0\r\n\r\n'; } function response_validator(server_response, client_got_eof, timed_out) { var m = server_response.split('\r\n\r\n'); assert.equal(m[1], body); assert.equal(true, client_got_eof); assert.equal(false, timed_out); } test(handler, request_generator, response_validator); })(); // // Don't send HTTP/1.1 status lines to HTTP/1.0 clients. // // https://github.com/joyent/node/issues/1234 // (function() { function handler(req, res) { assert.equal('1.0', req.httpVersion); assert.equal(1, req.httpVersionMajor); assert.equal(0, req.httpVersionMinor); res.sendDate = false; res.writeHead(200, {'Content-Type': 'text/plain'}); res.write('Hello, '); res._send(''); res.write('world!'); res._send(''); res.end(); } function request_generator() { return ('GET / HTTP/1.0\r\n' + 'User-Agent: curl/7.19.7 (x86_64-pc-linux-gnu) libcurl/7.19.7 ' + 'OpenSSL/0.9.8k zlib/1.2.3.3 libidn/1.15\r\n' + 'Host: 127.0.0.1:1337\r\n' + 'Accept: */*\r\n' + '\r\n'); } function response_validator(server_response, client_got_eof, timed_out) { var expected_response = 'HTTP/1.1 200 OK\r\n' + 'Content-Type: text/plain\r\n' + 'Connection: close\r\n' + '\r\n' + 'Hello, world!'; assert.equal(expected_response, server_response); assert.equal(true, client_got_eof); assert.equal(false, timed_out); } test(handler, request_generator, response_validator); })(); (function() { function handler(req, res) { assert.equal('1.1', req.httpVersion); assert.equal(1, req.httpVersionMajor); assert.equal(1, req.httpVersionMinor); res.sendDate = false; res.writeHead(200, {'Content-Type': 'text/plain'}); res.write('Hello, '); res._send(''); res.write('world!'); res._send(''); res.end(); } function request_generator() { return ('GET / HTTP/1.1\r\n' + 'User-Agent: curl/7.19.7 (x86_64-pc-linux-gnu) libcurl/7.19.7 ' + 'OpenSSL/0.9.8k zlib/1.2.3.3 libidn/1.15\r\n' + 'Connection: close\r\n' + 'Host: 127.0.0.1:1337\r\n' + 'Accept: */*\r\n' + '\r\n'); } function response_validator(server_response, client_got_eof, timed_out) { var expected_response = 'HTTP/1.1 200 OK\r\n' + 'Content-Type: text/plain\r\n' + 'Connection: close\r\n' + 'Transfer-Encoding: chunked\r\n' + '\r\n' + '7\r\n' + 'Hello, \r\n' + '6\r\n' + 'world!\r\n' + '0\r\n' + '\r\n'; assert.equal(expected_response, server_response); assert.equal(true, client_got_eof); assert.equal(false, timed_out); } test(handler, request_generator, response_validator); })(); node-v4.8.2/test/parallel/test-http-abort-before-end.js000644 000766 000024 00000001050 13070706737 023134 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var http = require('http'); var assert = require('assert'); var server = http.createServer(common.fail); server.listen(0, function() { var req = http.request({ method: 'GET', host: '127.0.0.1', port: this.address().port }); req.on('error', function(ex) { // https://github.com/joyent/node/issues/1399#issuecomment-2597359 // abort() should emit an Error, not the net.Socket object assert(ex instanceof Error); }); req.abort(); req.end(); server.close(); }); node-v4.8.2/test/parallel/test-http-abort-client.js000644 000766 000024 00000002005 13070706737 022405 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var http = require('http'); var server = http.Server(function(req, res) { console.log('Server accepted request.'); res.writeHead(200); res.write('Part of my res.'); res.destroy(); }); server.listen(0, common.mustCall(function() { http.get({ port: this.address().port, headers: { connection: 'keep-alive' } }, common.mustCall(function(res) { server.close(); console.log('Got res: ' + res.statusCode); console.dir(res.headers); res.on('data', function(chunk) { console.log('Read ' + chunk.length + ' bytes'); console.log(' chunk=%j', chunk.toString()); }); res.on('end', function() { console.log('Response ended.'); }); res.on('aborted', function() { console.log('Response aborted.'); }); res.socket.on('close', function() { console.log('socket closed, but not res'); }); // it would be nice if this worked: res.on('close', common.mustCall(function() {})); })); })); node-v4.8.2/test/parallel/test-http-abort-queued-2.js000644 000766 000024 00000001467 13070706737 022571 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const http = require('http'); let socketsCreated = 0; class Agent extends http.Agent { createConnection(options, oncreate) { const socket = super.createConnection(options, oncreate); socketsCreated++; return socket; } } const server = http.createServer((req, res) => res.end()); server.listen(0, common.mustCall(() => { const port = server.address().port; const agent = new Agent({ keepAlive: true, maxSockets: 1 }); http.get({agent, port}, (res) => res.resume()); const req = http.get({agent, port}, common.fail); req.abort(); http.get({agent, port}, common.mustCall((res) => { res.resume(); assert.strictEqual(socketsCreated, 1); agent.destroy(); server.close(); })); })); node-v4.8.2/test/parallel/test-http-abort-queued.js000644 000766 000024 00000004016 13070706737 022423 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const http = require('http'); var complete; var server = http.createServer(function(req, res) { // We should not see the queued /thatotherone request within the server // as it should be aborted before it is sent. assert.equal(req.url, '/'); res.writeHead(200); res.write('foo'); complete = complete || function() { res.end(); }; }); server.listen(0, function() { console.log('listen', server.address().port); var agent = new http.Agent({maxSockets: 1}); assert.equal(Object.keys(agent.sockets).length, 0); var options = { hostname: 'localhost', port: server.address().port, method: 'GET', path: '/', agent: agent }; var req1 = http.request(options); req1.on('response', function(res1) { assert.equal(Object.keys(agent.sockets).length, 1); assert.equal(Object.keys(agent.requests).length, 0); var req2 = http.request({ method: 'GET', host: 'localhost', port: server.address().port, path: '/thatotherone', agent: agent }); assert.equal(Object.keys(agent.sockets).length, 1); assert.equal(Object.keys(agent.requests).length, 1); req2.on('error', function(err) { // This is expected in response to our explicit abort call assert.equal(err.code, 'ECONNRESET'); }); req2.end(); req2.abort(); assert.equal(Object.keys(agent.sockets).length, 1); assert.equal(Object.keys(agent.requests).length, 1); console.log('Got res: ' + res1.statusCode); console.dir(res1.headers); res1.on('data', function(chunk) { console.log('Read ' + chunk.length + ' bytes'); console.log(' chunk=%j', chunk.toString()); complete(); }); res1.on('end', function() { console.log('Response ended.'); setTimeout(function() { assert.equal(Object.keys(agent.sockets).length, 0); assert.equal(Object.keys(agent.requests).length, 0); server.close(); }, 100); }); }); req1.end(); }); node-v4.8.2/test/parallel/test-http-after-connect.js000644 000766 000024 00000002744 13070706737 022564 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const http = require('http'); var clientResponses = 0; const server = http.createServer(common.mustCall(function(req, res) { console.error('Server got GET request'); req.resume(); res.writeHead(200); res.write(''); setTimeout(function() { res.end(req.url); }, 50); }, 2)); server.on('connect', common.mustCall(function(req, socket) { console.error('Server got CONNECT request'); socket.write('HTTP/1.1 200 Connection established\r\n\r\n'); socket.resume(); socket.on('end', function() { socket.end(); }); })); server.listen(0, function() { const req = http.request({ port: this.address().port, method: 'CONNECT', path: 'google.com:80' }); req.on('connect', common.mustCall(function(res, socket) { console.error('Client got CONNECT response'); socket.end(); socket.on('end', function() { doRequest(0); doRequest(1); }); socket.resume(); })); req.end(); }); function doRequest(i) { http.get({ port: server.address().port, path: '/request' + i }, common.mustCall(function(res) { console.error('Client got GET response'); var data = ''; res.setEncoding('utf8'); res.on('data', function(chunk) { data += chunk; }); res.on('end', function() { assert.strictEqual(data, '/request' + i); ++clientResponses; if (clientResponses === 2) { server.close(); } }); })); } node-v4.8.2/test/parallel/test-http-agent-destroyed-socket.js000644 000766 000024 00000005357 13070706737 024423 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var server = http.createServer(function(req, res) { res.writeHead(200, {'Content-Type': 'text/plain'}); res.end('Hello World\n'); }).listen(0, function() { var agent = new http.Agent({maxSockets: 1}); agent.on('free', function(socket, host, port) { console.log('freeing socket. destroyed? ', socket.destroyed); }); var requestOptions = { agent: agent, host: 'localhost', port: this.address().port, path: '/' }; var request1 = http.get(requestOptions, function(response) { // assert request2 is queued in the agent var key = agent.getName(requestOptions); assert(agent.requests[key].length === 1); console.log('got response1'); request1.socket.on('close', function() { console.log('request1 socket closed'); }); response.pipe(process.stdout); response.on('end', function() { console.log('response1 done'); ///////////////////////////////// // // THE IMPORTANT PART // // It is possible for the socket to get destroyed and other work // to run before the 'close' event fires because it happens on // nextTick. This example is contrived because it destroys the // socket manually at just the right time, but at Voxer we have // seen cases where the socket is destroyed by non-user code // then handed out again by an agent *before* the 'close' event // is triggered. request1.socket.destroy(); response.once('close', function() { // assert request2 was removed from the queue assert(!agent.requests[key]); console.log("waiting for request2.onSocket's nextTick"); process.nextTick(function() { // assert that the same socket was not assigned to request2, // since it was destroyed. assert(request1.socket !== request2.socket); assert(!request2.socket.destroyed, 'the socket is destroyed'); }); }); }); }); var request2 = http.get(requestOptions, function(response) { assert(!request2.socket.destroyed); assert(request1.socket.destroyed); // assert not reusing the same socket, since it was destroyed. assert(request1.socket !== request2.socket); console.log('got response2'); var gotClose = false; var gotResponseEnd = false; request2.socket.on('close', function() { console.log('request2 socket closed'); gotClose = true; done(); }); response.pipe(process.stdout); response.on('end', function() { console.log('response2 done'); gotResponseEnd = true; done(); }); function done() { if (gotResponseEnd && gotClose) server.close(); } }); }); node-v4.8.2/test/parallel/test-http-agent-error-on-idle.js000644 000766 000024 00000002347 13070706737 023605 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var Agent = http.Agent; var server = http.createServer(function(req, res) { res.end('hello world'); }); server.listen(0, function() { var agent = new Agent({ keepAlive: true, }); var requestParams = { host: 'localhost', port: this.address().port, agent: agent, path: '/' }; var socketKey = agent.getName(requestParams); get(function(res) { assert.equal(res.statusCode, 200); res.resume(); res.on('end', function() { process.nextTick(function() { var freeSockets = agent.freeSockets[socketKey]; assert.equal(freeSockets.length, 1, 'expect a free socket on ' + socketKey); //generate a random error on the free socket var freeSocket = freeSockets[0]; freeSocket.emit('error', new Error('ECONNRESET: test')); get(done); }); }); }); function get(callback) { return http.get(requestParams, callback); } function done() { assert.equal(Object.keys(agent.freeSockets).length, 0, 'expect the freeSockets pool to be empty'); agent.destroy(); server.close(); process.exit(0); } }); node-v4.8.2/test/parallel/test-http-agent-false.js000644 000766 000024 00000001637 13070706737 022222 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); // sending `agent: false` when `port: null` is also passed in (i.e. the result // of a `url.parse()` call with the default port used, 80 or 443), should not // result in an assertion error... var opts = { host: '127.0.0.1', port: null, path: '/', method: 'GET', agent: false }; var good = false; process.on('exit', function() { assert(good, 'expected either an "error" or "response" event'); }); // we just want an "error" (no local HTTP server on port 80) or "response" // to happen (user happens ot have HTTP server running on port 80). // As long as the process doesn't crash from a C++ assertion then we're good. var req = http.request(opts); req.on('response', function(res) { good = true; }); req.on('error', function(err) { // an "error" event is ok, don't crash the process good = true; }); req.end(); node-v4.8.2/test/parallel/test-http-agent-getname.js000644 000766 000024 00000001340 13070706737 022537 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const http = require('http'); const agent = new http.Agent(); // default to localhost assert.strictEqual( agent.getName({ port: 80, localAddress: '192.168.1.1' }), 'localhost:80:192.168.1.1' ); // empty assert.strictEqual( agent.getName({}), 'localhost::' ); // pass all arguments assert.strictEqual( agent.getName({ host: '0.0.0.0', port: 80, localAddress: '192.168.1.1' }), '0.0.0.0:80:192.168.1.1' ); for (const family of [0, null, undefined, 'bogus']) assert.strictEqual(agent.getName({ family }), 'localhost::'); for (const family of [4, 6]) assert.strictEqual(agent.getName({ family }), 'localhost:::' + family); node-v4.8.2/test/parallel/test-http-agent-keepalive.js000644 000766 000024 00000006742 13070706737 023077 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const http = require('http'); const Agent = require('_http_agent').Agent; let name; const agent = new Agent({ keepAlive: true, keepAliveMsecs: 1000, maxSockets: 5, maxFreeSockets: 5 }); const server = http.createServer(function(req, res) { if (req.url === '/error') { res.destroy(); return; } else if (req.url === '/remote_close') { // cache the socket, close it after a short delay const socket = res.connection; setImmediate(function() { socket.end(); }); } res.end('hello world'); }); function get(path, callback) { return http.get({ host: 'localhost', port: server.address().port, agent: agent, path: path }, callback); } function checkDataAndSockets(body) { assert.equal(body.toString(), 'hello world'); assert.equal(agent.sockets[name].length, 1); assert.equal(agent.freeSockets[name], undefined); } function second() { // request second, use the same socket get('/second', function(res) { assert.equal(res.statusCode, 200); res.on('data', checkDataAndSockets); res.on('end', function() { assert.equal(agent.sockets[name].length, 1); assert.equal(agent.freeSockets[name], undefined); process.nextTick(function() { assert.equal(agent.sockets[name], undefined); assert.equal(agent.freeSockets[name].length, 1); remoteClose(); }); }); }); } function remoteClose() { // mock remote server close the socket get('/remote_close', function(res) { assert.deepEqual(res.statusCode, 200); res.on('data', checkDataAndSockets); res.on('end', function() { assert.equal(agent.sockets[name].length, 1); assert.equal(agent.freeSockets[name], undefined); process.nextTick(function() { assert.equal(agent.sockets[name], undefined); assert.equal(agent.freeSockets[name].length, 1); // waitting remote server close the socket setTimeout(function() { assert.equal(agent.sockets[name], undefined); assert.equal(agent.freeSockets[name], undefined, 'freeSockets is not empty'); remoteError(); }, common.platformTimeout(200)); }); }); }); } function remoteError() { // remove server will destroy ths socket const req = get('/error', function(res) { throw new Error('should not call this function'); }); req.on('error', function(err) { assert.ok(err); assert.equal(err.message, 'socket hang up'); assert.equal(agent.sockets[name].length, 1); assert.equal(agent.freeSockets[name], undefined); // Wait socket 'close' event emit setTimeout(function() { assert.equal(agent.sockets[name], undefined); assert.equal(agent.freeSockets[name], undefined); done(); }, common.platformTimeout(1)); }); } function done() { console.log('http keepalive agent test success.'); process.exit(0); } server.listen(0, function() { name = `localhost:${server.address().port}:`; // request first, and keep alive get('/first', function(res) { assert.equal(res.statusCode, 200); res.on('data', checkDataAndSockets); res.on('end', function() { assert.equal(agent.sockets[name].length, 1); assert.equal(agent.freeSockets[name], undefined); process.nextTick(function() { assert.equal(agent.sockets[name], undefined); assert.equal(agent.freeSockets[name].length, 1); second(); }); }); }); }); node-v4.8.2/test/parallel/test-http-agent-maxsockets-regress-4050.js000644 000766 000024 00000001642 13070706737 025343 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const http = require('http'); const MAX_SOCKETS = 2; const agent = new http.Agent({ keepAlive: true, keepAliveMsecs: 1000, maxSockets: MAX_SOCKETS, maxFreeSockets: 2 }); const server = http.createServer(function(req, res) { res.end('hello world'); }); function get(path, callback) { return http.get({ host: 'localhost', port: server.address().port, agent: agent, path: path }, callback); } server.listen(0, function() { var finished = 0; const num_requests = 6; for (var i = 0; i < num_requests; i++) { const request = get('/1', function() { }); request.on('response', function() { request.abort(); const sockets = agent.sockets[Object.keys(agent.sockets)[0]]; assert(sockets.length <= MAX_SOCKETS); if (++finished === num_requests) { server.close(); } }); } }); node-v4.8.2/test/parallel/test-http-agent-maxsockets.js000644 000766 000024 00000002114 13070706737 023300 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var agent = new http.Agent({ keepAlive: true, keepAliveMsecs: 1000, maxSockets: 2, maxFreeSockets: 2 }); var server = http.createServer(function(req, res) { res.end('hello world'); }); function get(path, callback) { return http.get({ host: 'localhost', port: server.address().port, agent: agent, path: path }, callback); } var count = 0; function done() { if (++count !== 2) { return; } var freepool = agent.freeSockets[Object.keys(agent.freeSockets)[0]]; assert.equal(freepool.length, 2, 'expect keep 2 free sockets, but got ' + freepool.length); agent.destroy(); server.close(); } server.listen(0, function() { get('/1', function(res) { assert.equal(res.statusCode, 200); res.resume(); res.on('end', function() { process.nextTick(done); }); }); get('/2', function(res) { assert.equal(res.statusCode, 200); res.resume(); res.on('end', function() { process.nextTick(done); }); }); }); node-v4.8.2/test/parallel/test-http-agent-no-protocol.js000644 000766 000024 00000001154 13070706737 023375 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var http = require('http'); var url = require('url'); var server = http.createServer(common.mustCall(function(req, res) { res.end(); })).listen(0, '127.0.0.1', common.mustCall(function() { var opts = url.parse(`http://127.0.0.1:${this.address().port}/`); // remove the `protocol` field… the `http` module should fall back // to "http:", as defined by the global, default `http.Agent` instance. opts.agent = new http.Agent(); opts.agent.protocol = null; http.get(opts, common.mustCall(function(res) { res.resume(); server.close(); })); })); node-v4.8.2/test/parallel/test-http-agent-null.js000644 000766 000024 00000000570 13070706737 022075 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var http = require('http'); var server = http.createServer(common.mustCall(function(req, res) { res.end(); })).listen(0, common.mustCall(function() { var options = { agent: null, port: this.address().port }; http.get(options, common.mustCall(function(res) { res.resume(); server.close(); })); })); node-v4.8.2/test/parallel/test-http-agent.js000644 000766 000024 00000001610 13070706737 021121 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var server = http.Server(function(req, res) { res.writeHead(200); res.end('hello world\n'); }); var responses = 0; var N = 4; var M = 4; server.listen(0, function() { const port = this.address().port; for (var i = 0; i < N; i++) { setTimeout(function() { for (var j = 0; j < M; j++) { http.get({ port: port, path: '/' }, function(res) { console.log('%d %d', responses, res.statusCode); if (++responses === N * M) { console.error('Received all responses, closing server'); server.close(); } res.resume(); }).on('error', function(e) { console.log('Error!', e); process.exit(1); }); } }, i); } }); process.on('exit', function() { assert.equal(N * M, responses); }); node-v4.8.2/test/parallel/test-http-allow-req-after-204-res.js000644 000766 000024 00000002041 13070706737 024116 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const http = require('http'); const assert = require('assert'); // first 204 or 304 works, subsequent anything fails const codes = [204, 200]; // Methods don't really matter, but we put in something realistic. const methods = ['DELETE', 'DELETE']; const server = http.createServer(common.mustCall((req, res) => { const code = codes.shift(); assert.strictEqual(typeof code, 'number'); assert.ok(code > 0); res.writeHead(code, {}); res.end(); }, codes.length)); function nextRequest() { const method = methods.shift(); const request = http.request({ port: server.address().port, method: method, path: '/' }, common.mustCall((response) => { response.on('end', common.mustCall(() => { if (methods.length === 0) { server.close(); } else { // throws error: nextRequest(); // works just fine: //process.nextTick(nextRequest); } })); response.resume(); })); request.end(); } server.listen(0, nextRequest); node-v4.8.2/test/parallel/test-http-automatic-headers.js000644 000766 000024 00000001621 13070706737 023424 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var server = http.createServer(function(req, res) { res.setHeader('X-Date', 'foo'); res.setHeader('X-Connection', 'bar'); res.setHeader('X-Content-Length', 'baz'); res.end(); }); server.listen(0); server.on('listening', function() { var agent = new http.Agent({ port: this.address().port, maxSockets: 1 }); http.get({ port: this.address().port, path: '/hello', agent: agent }, function(res) { assert.equal(res.statusCode, 200); assert.equal(res.headers['x-date'], 'foo'); assert.equal(res.headers['x-connection'], 'bar'); assert.equal(res.headers['x-content-length'], 'baz'); assert(res.headers['date']); assert.equal(res.headers['connection'], 'keep-alive'); assert.equal(res.headers['content-length'], '0'); server.close(); agent.destroy(); }); }); node-v4.8.2/test/parallel/test-http-bind-twice.js000644 000766 000024 00000000711 13070706737 022051 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var http = require('http'); var server1 = http.createServer(common.fail); server1.listen(0, '127.0.0.1', common.mustCall(function() { var server2 = http.createServer(common.fail); server2.listen(this.address().port, '127.0.0.1', common.fail); server2.on('error', common.mustCall(function(e) { assert.equal(e.code, 'EADDRINUSE'); server1.close(); })); })); node-v4.8.2/test/parallel/test-http-blank-header.js000644 000766 000024 00000001555 13070706737 022350 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var http = require('http'); var net = require('net'); var server = http.createServer(common.mustCall(function(req, res) { assert.equal('GET', req.method); assert.equal('/blah', req.url); assert.deepEqual({ host: 'mapdevel.trolologames.ru:443', origin: 'http://mapdevel.trolologames.ru', cookie: '' }, req.headers); })); server.listen(0, function() { var c = net.createConnection(this.address().port); c.on('connect', function() { c.write('GET /blah HTTP/1.1\r\n' + 'Host: mapdevel.trolologames.ru:443\r\n' + 'Cookie:\r\n' + 'Origin: http://mapdevel.trolologames.ru\r\n' + '\r\n\r\nhello world' ); }); c.on('end', function() { c.end(); }); c.on('close', function() { server.close(); }); }); node-v4.8.2/test/parallel/test-http-buffer-sanity.js000644 000766 000024 00000002536 13070706737 022611 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var http = require('http'); var bufferSize = 5 * 1024 * 1024; var measuredSize = 0; var buffer = Buffer(bufferSize); for (var i = 0; i < buffer.length; i++) { buffer[i] = i % 256; } var web = http.Server(function(req, res) { web.close(); console.log(req.headers); var i = 0; req.on('data', function(d) { process.stdout.write(','); measuredSize += d.length; for (var j = 0; j < d.length; j++) { assert.equal(buffer[i], d[j]); i++; } }); req.on('end', function() { res.writeHead(200); res.write('thanks'); res.end(); console.log('response with \'thanks\''); }); req.connection.on('error', function(e) { console.log('http server-side error: ' + e.message); process.exit(1); }); }); web.listen(0, common.mustCall(function() { console.log('Making request'); var req = http.request({ port: this.address().port, method: 'GET', path: '/', headers: { 'content-length': buffer.length } }, common.mustCall(function(res) { console.log('Got response'); res.setEncoding('utf8'); res.on('data', common.mustCall(function(string) { assert.equal('thanks', string); })); })); req.end(buffer); })); process.on('exit', function() { assert.equal(bufferSize, measuredSize); }); node-v4.8.2/test/parallel/test-http-byteswritten.js000644 000766 000024 00000001645 13070706737 022576 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var http = require('http'); var body = 'hello world\n'; var httpServer = http.createServer(common.mustCall(function(req, res) { httpServer.close(); res.on('finish', common.mustCall(function() { assert(typeof req.connection.bytesWritten === 'number'); assert(req.connection.bytesWritten > 0); })); res.writeHead(200, { 'Content-Type': 'text/plain' }); // Write 1.5mb to cause some requests to buffer // Also, mix up the encodings a bit. var chunk = new Array(1024 + 1).join('7'); var bchunk = new Buffer(chunk); for (var i = 0; i < 1024; i++) { res.write(chunk); res.write(bchunk); res.write(chunk, 'hex'); } // Get .bytesWritten while buffer is not empty assert(res.connection.bytesWritten > 0); res.end(body); })); httpServer.listen(0, function() { http.get({ port: this.address().port }); }); node-v4.8.2/test/parallel/test-http-catch-uncaughtexception.js000644 000766 000024 00000001131 13070706737 024636 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const http = require('http'); const uncaughtCallback = common.mustCall(function(er) { assert.equal(er.message, 'get did fail'); }); process.on('uncaughtException', uncaughtCallback); const server = http.createServer(function(req, res) { res.writeHead(200, { 'Content-Type': 'text/plain' }); res.end('bye'); }).listen(0, function() { http.get({ port: this.address().port }, function(res) { res.resume(); throw new Error('get did fail'); }).on('close', function() { server.close(); }); }); node-v4.8.2/test/parallel/test-http-chunk-problem.js000644 000766 000024 00000004075 13070706737 022601 0ustar00iojsstaff000000 000000 'use strict'; // http://groups.google.com/group/nodejs/browse_thread/thread/f66cd3c960406919 const common = require('../common'); const assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } if (process.argv[2] === 'request') { const http = require('http'); const options = { port: +process.argv[3], path: '/' }; http.get(options, (res) => { res.pipe(process.stdout); }); return; } if (process.argv[2] === 'shasum') { const crypto = require('crypto'); const shasum = crypto.createHash('sha1'); process.stdin.on('data', (d) => { shasum.update(d); }); process.stdin.on('close', () => { process.stdout.write(shasum.digest('hex')); }); return; } const http = require('http'); const cp = require('child_process'); const filename = require('path').join(common.tmpDir, 'big'); let server; function executeRequest(cb) { cp.exec([process.execPath, __filename, 'request', server.address().port, '|', process.execPath, __filename, 'shasum' ].join(' '), (err, stdout, stderr) => { if (err) throw err; assert.equal('8c206a1a87599f532ce68675536f0b1546900d7a', stdout.slice(0, 40)); cb(); } ); } common.refreshTmpDir(); const ddcmd = common.ddCommand(filename, 10240); cp.exec(ddcmd, function(err, stdout, stderr) { if (err) throw err; server = http.createServer(function(req, res) { res.writeHead(200); // Create the subprocess const cat = cp.spawn('cat', [filename]); // Stream the data through to the response as binary chunks cat.stdout.on('data', (data) => { res.write(data); }); cat.stdout.on('end', () => res.end()); // End the response on exit (and log errors) cat.on('exit', (code) => { if (code !== 0) { console.error('subprocess exited with code ' + code); process.exit(1); } }); }); server.listen(0, () => { executeRequest(() => server.close()); }); }); node-v4.8.2/test/parallel/test-http-chunked-304.js000644 000766 000024 00000002465 13070706737 021761 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var http = require('http'); var net = require('net'); // RFC 2616, section 10.2.5: // // The 204 response MUST NOT contain a message-body, and thus is always // terminated by the first empty line after the header fields. // // Likewise for 304 responses. Verify that no empty chunk is sent when // the user explicitly sets a Transfer-Encoding header. test(204); test(304); function test(statusCode) { const server = http.createServer(common.mustCall((req, res) => { res.writeHead(statusCode, { 'Transfer-Encoding': 'chunked' }); res.end(); server.close(); })); server.listen(0, common.mustCall(() => { const conn = net.createConnection( server.address().port, common.mustCall(() => { conn.write('GET / HTTP/1.1\r\n\r\n'); let resp = ''; conn.setEncoding('utf8'); conn.on('data', common.mustCall((data) => { resp += data; })); conn.on('end', common.mustCall(() => { // Connection: close should be in the response assert.strictEqual(/^Connection: close\r\n$/m.test(resp), true); // Make sure this doesn't end with 0\r\n\r\n assert.strictEqual(/^0\r\n$/m.test(resp), false); })); }) ); })); } node-v4.8.2/test/parallel/test-http-chunked.js000644 000766 000024 00000003503 13070706737 021447 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var UTF8_STRING = '南越国是前203年至前111年存在于岭南地区的一个国家，' + '国都位于番禺，疆域包括今天中国的广东、广西两省区的大部份地区，福建省、湖南、' + '贵州、云南的一小部份地区和越南的北部。南越国是秦朝灭亡后，' + '由南海郡尉赵佗于前203年起兵兼并桂林郡和象郡后建立。前196年和前179年，' + '南越国曾先后两次名义上臣属于西汉，成为西汉的“外臣”。前112年，' + '南越国末代君主赵建德与西汉发生战争，被汉武帝于前111年所灭。' + '南越国共存在93年，历经五代君主。南越国是岭南地区的第一个有记载的政权国家，' + '采用封建制和郡县制并存的制度，它的建立保证了秦末乱世岭南地区社会秩序的稳定，' + '有效的改善了岭南地区落后的政治、经济现状。'; var server = http.createServer(function(req, res) { res.writeHead(200, {'Content-Type': 'text/plain; charset=utf8'}); res.end(UTF8_STRING, 'utf8'); }); server.listen(0, function() { var data = ''; var get = http.get({ path: '/', host: 'localhost', port: this.address().port }, function(x) { x.setEncoding('utf8'); x.on('data', function(c) {data += c;}); x.on('error', function(e) { throw e; }); x.on('end', function() { assert.equal('string', typeof data); console.log('here is the response:'); assert.equal(UTF8_STRING, data); console.log(data); server.close(); }); }); get.on('error', function(e) {throw e;}); get.end(); }); node-v4.8.2/test/parallel/test-http-client-abort-event.js000644 000766 000024 00000000613 13070706737 023527 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var http = require('http'); var server = http.createServer(function(req, res) { res.end(); }); server.listen(0, common.mustCall(function() { var req = http.request({ port: this.address().port }, common.fail); req.on('abort', common.mustCall(function() { server.close(); })); req.end(); req.abort(); req.abort(); })); node-v4.8.2/test/parallel/test-http-client-abort-no-agent.js000644 000766 000024 00000000721 13070706737 024116 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const http = require('http'); const net = require('net'); const server = http.createServer(common.fail); server.listen(0, common.mustCall(() => { const req = http.get({ createConnection(options, oncreate) { const socket = net.createConnection(options, oncreate); socket.once('close', () => server.close()); return socket; }, port: server.address().port }); req.abort(); })); node-v4.8.2/test/parallel/test-http-client-abort-unix-socket.js000644 000766 000024 00000001007 13070706737 024655 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const http = require('http'); const server = http.createServer(common.fail); class Agent extends http.Agent { createConnection(options, oncreate) { const socket = super.createConnection(options, oncreate); socket.once('close', () => server.close()); return socket; } } common.refreshTmpDir(); server.listen(common.PIPE, common.mustCall(() => { const req = http.get({ agent: new Agent(), socketPath: common.PIPE }); req.abort(); })); node-v4.8.2/test/parallel/test-http-client-abort.js000644 000766 000024 00000003036 13070706737 022412 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const http = require('http'); var clientAborts = 0; const server = http.Server(function(req, res) { console.log('Got connection'); res.writeHead(200); res.write('Working on it...'); // I would expect an error event from req or res that the client aborted // before completing the HTTP request / response cycle, or maybe a new // event like "aborted" or something. req.on('aborted', function() { clientAborts++; console.log('Got abort ' + clientAborts); if (clientAborts === N) { console.log('All aborts detected, you win.'); server.close(); } }); // since there is already clientError, maybe that would be appropriate, // since "error" is magical req.on('clientError', function() { console.log('Got clientError'); }); }); var responses = 0; const N = 8; const requests = []; server.listen(0, function() { console.log('Server listening.'); for (var i = 0; i < N; i++) { console.log('Making client ' + i); var options = { port: this.address().port, path: '/?id=' + i }; var req = http.get(options, function(res) { console.log('Client response code ' + res.statusCode); res.resume(); if (++responses === N) { console.log('All clients connected, destroying.'); requests.forEach(function(outReq) { console.log('abort'); outReq.abort(); }); } }); requests.push(req); } }); process.on('exit', function() { assert.equal(N, clientAborts); }); node-v4.8.2/test/parallel/test-http-client-abort2.js000644 000766 000024 00000000516 13070706737 022474 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var http = require('http'); var server = http.createServer(function(req, res) { res.end('Hello'); }); server.listen(0, function() { var req = http.get({port: this.address().port}, function(res) { res.on('data', function(data) { req.abort(); server.close(); }); }); }); node-v4.8.2/test/parallel/test-http-client-aborted-event.js000644 000766 000024 00000000670 13070706737 024043 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const http = require('http'); const server = http.Server(function(req, res) { res.write('Part of my res.'); res.destroy(); }); server.listen(0, common.mustCall(function() { http.get({ port: this.address().port, headers: { connection: 'keep-alive' } }, common.mustCall(function(res) { server.close(); res.on('aborted', common.mustCall(function() {})); })); })); node-v4.8.2/test/parallel/test-http-client-agent.js000644 000766 000024 00000002122 13070706737 022374 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var name; var max = 3; var count = 0; var server = http.Server(function(req, res) { if (req.url === '/0') { setTimeout(function() { res.writeHead(200); res.end('Hello, World!'); }, 100); } else { res.writeHead(200); res.end('Hello, World!'); } }); server.listen(0, function() { name = http.globalAgent.getName({ port: this.address().port }); for (var i = 0; i < max; ++i) { request(i); } }); function request(i) { var req = http.get({ port: server.address().port, path: '/' + i }, function(res) { var socket = req.socket; socket.on('close', function() { ++count; if (count < max) { assert.equal(http.globalAgent.sockets[name].indexOf(socket), -1); } else { assert(!http.globalAgent.sockets.hasOwnProperty(name)); assert(!http.globalAgent.requests.hasOwnProperty(name)); server.close(); } }); res.resume(); }); } process.on('exit', function() { assert.equal(count, max); }); node-v4.8.2/test/parallel/test-http-client-default-headers-exist.js000644 000766 000024 00000002353 13070706737 025473 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var expectedHeaders = { 'DELETE': ['host', 'connection'], 'GET': ['host', 'connection'], 'HEAD': ['host', 'connection'], 'OPTIONS': ['host', 'connection'], 'POST': ['host', 'connection', 'content-length'], 'PUT': ['host', 'connection', 'content-length'] }; var expectedMethods = Object.keys(expectedHeaders); var requestCount = 0; var server = http.createServer(function(req, res) { requestCount++; res.end(); assert(expectedHeaders.hasOwnProperty(req.method), req.method + ' was an unexpected method'); var requestHeaders = Object.keys(req.headers); requestHeaders.forEach(function(header) { assert(expectedHeaders[req.method].indexOf(header.toLowerCase()) !== -1, header + ' shoud not exist for method ' + req.method); }); assert(requestHeaders.length === expectedHeaders[req.method].length, 'some headers were missing for method: ' + req.method); if (expectedMethods.length === requestCount) server.close(); }); server.listen(0, function() { expectedMethods.forEach(function(method) { http.request({ method: method, port: server.address().port }).end(); }); }); node-v4.8.2/test/parallel/test-http-client-encoding.js000644 000766 000024 00000000471 13070706737 023071 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var http = require('http'); http.createServer(function(req, res) { res.end('ok\n'); this.close(); }).listen(0, test); function test() { http.request({ port: this.address().port, encoding: 'utf8' }, function(res) { res.pipe(process.stdout); }).end(); } node-v4.8.2/test/parallel/test-http-client-get-url.js000644 000766 000024 00000000720 13070706737 022657 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var http = require('http'); var server = http.createServer(common.mustCall(function(req, res) { assert.equal('GET', req.method); assert.equal('/foo?bar', req.url); res.writeHead(200, {'Content-Type': 'text/plain'}); res.write('hello\n'); res.end(); server.close(); })); server.listen(0, function() { http.get(`http://127.0.0.1:${this.address().port}/foo?bar`); }); node-v4.8.2/test/parallel/test-http-client-keep-alive-release-before-finish.js000644 000766 000024 00000001546 13070706737 027465 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const http = require('http'); const server = http.createServer((req, res) => { res.end(); }).listen(0, common.mustCall(() => { const agent = new http.Agent({ maxSockets: 1, keepAlive: true }); const port = server.address().port; const post = http.request({ agent, method: 'POST', port, }, common.mustCall((res) => { res.resume(); })); /* What happens here is that the server `end`s the response before we send * `something`, and the client thought that this is a green light for sending * next GET request */ post.write(Buffer.alloc(16 * 1024, 'X')); setTimeout(() => { post.end('something'); }, 100); http.request({ agent, method: 'GET', port, }, common.mustCall((res) => { server.close(); res.connection.end(); })).end(); })); node-v4.8.2/test/parallel/test-http-client-parse-error.js000644 000766 000024 00000001666 13070706737 023553 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var net = require('net'); var connects = 0; var parseErrors = 0; // Create a TCP server net.createServer(function(c) { console.log('connection'); if (++connects === 1) { c.end('HTTP/1.1 302 Object Moved\r\nContent-Length: 0\r\n\r\nhi world'); } else { c.end('bad http - should trigger parse error\r\n'); this.close(); } }).listen(0, '127.0.0.1', function() { for (var i = 0; i < 2; i++) { http.request({ host: '127.0.0.1', port: this.address().port, method: 'GET', path: '/' }).on('error', function(e) { console.log('got error from client'); assert.ok(e.message.indexOf('Parse Error') >= 0); assert.equal(e.code, 'HPE_INVALID_CONSTANT'); parseErrors++; }).end(); } }); process.on('exit', function() { assert.equal(connects, 2); assert.equal(parseErrors, 2); }); node-v4.8.2/test/parallel/test-http-client-pipe-end.js000644 000766 000024 00000001355 13070706737 023006 0ustar00iojsstaff000000 000000 'use strict'; // see https://github.com/joyent/node/issues/3257 var common = require('../common'); var http = require('http'); var server = http.createServer(function(req, res) { req.resume(); req.once('end', function() { res.writeHead(200); res.end(); server.close(); }); }); common.refreshTmpDir(); server.listen(common.PIPE, function() { var req = http.request({ socketPath: common.PIPE, headers: {'Content-Length': '1'}, method: 'POST', path: '/' }); req.write('.'); sched(function() { req.end(); }, 5); }); // schedule a callback after `ticks` event loop ticks function sched(cb, ticks) { function fn() { if (--ticks) setImmediate(fn); else cb(); } setImmediate(fn); } node-v4.8.2/test/parallel/test-http-client-race-2.js000644 000766 000024 00000005165 13070706737 022361 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var url = require('url'); // // Slight variation on test-http-client-race to test for another race // condition involving the parsers FreeList used internally by http.Client. // var body1_s = '1111111111111111'; var body2_s = '22222'; var body3_s = '3333333333333333333'; var server = http.createServer(function(req, res) { var pathname = url.parse(req.url).pathname; var body; switch (pathname) { case '/1': body = body1_s; break; case '/2': body = body2_s; break; default: body = body3_s; } res.writeHead(200, {'Content-Type': 'text/plain', 'Content-Length': body.length}); res.end(body); }); server.listen(0); var body1 = ''; var body2 = ''; var body3 = ''; server.on('listening', function() { var client = http.createClient(this.address().port); // // Client #1 is assigned Parser #1 // var req1 = client.request('/1'); req1.end(); req1.on('response', function(res1) { res1.setEncoding('utf8'); res1.on('data', function(chunk) { body1 += chunk; }); res1.on('end', function() { // // Delay execution a little to allow the 'close' event to be processed // (required to trigger this bug!) // setTimeout(function() { // // The bug would introduce itself here: Client #2 would be allocated the // parser that previously belonged to Client #1. But we're not finished // with Client #1 yet! // var client2 = http.createClient(server.address().port); // // At this point, the bug would manifest itself and crash because the // internal state of the parser was no longer valid for use by Client #1 // var req2 = client.request('/2'); req2.end(); req2.on('response', function(res2) { res2.setEncoding('utf8'); res2.on('data', function(chunk) { body2 += chunk; }); res2.on('end', function() { // // Just to be really sure we've covered all our bases, execute a // request using client2. // var req3 = client2.request('/3'); req3.end(); req3.on('response', function(res3) { res3.setEncoding('utf8'); res3.on('data', function(chunk) { body3 += chunk; }); res3.on('end', function() { server.close(); }); }); }); }); }, 500); }); }); }); process.on('exit', function() { assert.equal(body1_s, body1); assert.equal(body2_s, body2); assert.equal(body3_s, body3); }); node-v4.8.2/test/parallel/test-http-client-race.js000644 000766 000024 00000002243 13070706737 022214 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var url = require('url'); var body1_s = '1111111111111111'; var body2_s = '22222'; var server = http.createServer(function(req, res) { var body = url.parse(req.url).pathname === '/1' ? body1_s : body2_s; res.writeHead(200, {'Content-Type': 'text/plain', 'Content-Length': body.length}); res.end(body); }); server.listen(0); var body1 = ''; var body2 = ''; server.on('listening', function() { var req1 = http.request({ port: this.address().port, path: '/1' }); req1.end(); req1.on('response', function(res1) { res1.setEncoding('utf8'); res1.on('data', function(chunk) { body1 += chunk; }); res1.on('end', function() { var req2 = http.request({ port: server.address().port, path: '/2' }); req2.end(); req2.on('response', function(res2) { res2.setEncoding('utf8'); res2.on('data', function(chunk) { body2 += chunk; }); res2.on('end', function() { server.close(); }); }); }); }); }); process.on('exit', function() { assert.equal(body1_s, body1); assert.equal(body2_s, body2); }); node-v4.8.2/test/parallel/test-http-client-read-in-error.js000644 000766 000024 00000001631 13070706737 023750 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var net = require('net'); var http = require('http'); var util = require('util'); function Agent() { http.Agent.call(this); } util.inherits(Agent, http.Agent); Agent.prototype.createConnection = function() { var self = this; var socket = new net.Socket(); socket.on('error', function() { socket.push('HTTP/1.1 200\r\n\r\n'); }); socket.on('newListener', function onNewListener(name) { if (name !== 'error') return; socket.removeListener('newListener', onNewListener); // Let other listeners to be set up too process.nextTick(function() { self.breakSocket(socket); }); }); return socket; }; Agent.prototype.breakSocket = function breakSocket(socket) { socket.emit('error', new Error('Intentional error')); }; var agent = new Agent(); http.request({ agent: agent }).once('error', function() { console.log('ignore'); }); node-v4.8.2/test/parallel/test-http-client-readable.js000644 000766 000024 00000002162 13070706737 023041 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var http = require('http'); var util = require('util'); var Duplex = require('stream').Duplex; function FakeAgent() { http.Agent.call(this); } util.inherits(FakeAgent, http.Agent); FakeAgent.prototype.createConnection = function createConnection() { var s = new Duplex(); var once = false; s._read = function _read() { if (once) return this.push(null); once = true; this.push('HTTP/1.1 200 Ok\r\nTransfer-Encoding: chunked\r\n\r\n'); this.push('b\r\nhello world\r\n'); this.readable = false; this.push('0\r\n\r\n'); }; // Blackhole s._write = function _write(data, enc, cb) { cb(); }; s.destroy = s.destroySoon = function destroy() { this.writable = false; }; return s; }; var received = ''; var req = http.request({ agent: new FakeAgent() }, common.mustCall(function(res) { res.on('data', function(chunk) { received += chunk; }); res.on('end', common.mustCall(function() {})); })); req.end(); process.on('exit', function() { assert.equal(received, 'hello world'); }); node-v4.8.2/test/parallel/test-http-client-reject-chunked-with-content-length.js000644 000766 000024 00000001547 13070706737 030103 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const http = require('http'); const net = require('net'); const assert = require('assert'); const reqstr = 'HTTP/1.1 200 OK\r\n' + 'Content-Length: 1\r\n' + 'Transfer-Encoding: chunked\r\n\r\n'; const server = net.createServer((socket) => { socket.write(reqstr); }); server.listen(0, () => { // The callback should not be called because the server is sending // both a Content-Length header and a Transfer-Encoding: chunked // header, which is a violation of the HTTP spec. const req = http.get({port: server.address().port}, (res) => { common.fail('callback should not be called'); }); req.on('error', common.mustCall((err) => { assert(/^Parse Error/.test(err.message)); assert.equal(err.code, 'HPE_UNEXPECTED_CONTENT_LENGTH'); server.close(); })); }); node-v4.8.2/test/parallel/test-http-client-reject-cr-no-lf.js000644 000766 000024 00000001414 13070706737 024170 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const http = require('http'); const net = require('net'); const assert = require('assert'); const reqstr = 'HTTP/1.1 200 OK\r\n' + 'Foo: Bar\r' + 'Content-Length: 1\r\n\r\n'; const server = net.createServer((socket) => { socket.write(reqstr); }); server.listen(0, () => { // The callback should not be called because the server is sending a // header field that ends only in \r with no following \n const req = http.get({port: server.address().port}, (res) => { common.fail('callback should not be called'); }); req.on('error', common.mustCall((err) => { assert(/^Parse Error/.test(err.message)); assert.equal(err.code, 'HPE_LF_EXPECTED'); server.close(); })); }); node-v4.8.2/test/parallel/test-http-client-response-domain.js000644 000766 000024 00000001602 13070706737 024403 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const http = require('http'); const domain = require('domain'); var d; common.refreshTmpDir(); // first fire up a simple HTTP server var server = http.createServer(function(req, res) { res.writeHead(200); res.end(); server.close(); }); server.listen(common.PIPE, function() { // create a domain d = domain.create(); d.run(common.mustCall(test)); }); function test() { d.on('error', common.mustCall(function(err) { assert.equal('should be caught by domain', err.message); })); var req = http.get({ socketPath: common.PIPE, headers: {'Content-Length': '1'}, method: 'POST', path: '/' }); req.on('response', function(res) { res.on('end', function() { res.emit('error', new Error('should be caught by domain')); }); res.resume(); }); req.end(); } node-v4.8.2/test/parallel/test-http-client-timeout-agent.js000644 000766 000024 00000003550 13070706737 024066 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var requests_sent = 0; var requests_done = 0; var options = { method: 'GET', port: undefined, host: '127.0.0.1', }; //http.globalAgent.maxSockets = 15; var server = http.createServer(function(req, res) { const m = /\/(.*)/.exec(req.url); const reqid = parseInt(m[1], 10); if (reqid % 2) { // do not reply the request } else { res.writeHead(200, {'Content-Type': 'text/plain'}); res.write(reqid.toString()); res.end(); } }); server.listen(0, options.host, function() { options.port = this.address().port; var req; for (requests_sent = 0; requests_sent < 30; requests_sent += 1) { options.path = '/' + requests_sent; req = http.request(options); req.id = requests_sent; req.on('response', function(res) { res.on('data', function(data) { console.log('res#' + this.req.id + ' data:' + data); }); res.on('end', function(data) { console.log('res#' + this.req.id + ' end'); requests_done += 1; }); }); req.on('close', function() { console.log('req#' + this.id + ' close'); }); req.on('error', function() { console.log('req#' + this.id + ' error'); this.destroy(); }); req.setTimeout(50, function() { console.log('req#' + this.id + ' timeout'); this.abort(); requests_done += 1; }); req.end(); } setTimeout(function maybeDone() { if (requests_done >= requests_sent) { setTimeout(function() { server.close(); }, 100); } else { setTimeout(maybeDone, 100); } }, 100); }); process.on('exit', function() { console.error('done=%j sent=%j', requests_done, requests_sent); assert.strictEqual(requests_done, requests_sent, 'timeout on http request called too much'); }); node-v4.8.2/test/parallel/test-http-client-timeout-event.js000644 000766 000024 00000001636 13070706737 024114 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var http = require('http'); var options = { method: 'GET', port: undefined, host: '127.0.0.1', path: '/' }; var server = http.createServer(function(req, res) { // this space intentionally left blank }); server.listen(0, options.host, function() { options.port = this.address().port; var req = http.request(options, function(res) { // this space intentionally left blank }); req.on('error', function() { // this space is intentionally left blank }); req.on('close', function() { server.close(); }); var timeout_events = 0; req.setTimeout(1); req.on('timeout', function() { timeout_events += 1; }); setTimeout(function() { req.destroy(); assert.equal(timeout_events, 1); }, common.platformTimeout(100)); setTimeout(function() { req.end(); }, common.platformTimeout(50)); }); node-v4.8.2/test/parallel/test-http-client-timeout-with-data.js000644 000766 000024 00000001766 13070706737 024661 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const http = require('http'); var nchunks = 0; const options = { method: 'GET', port: undefined, host: '127.0.0.1', path: '/' }; const server = http.createServer(function(req, res) { res.writeHead(200, {'Content-Length': '2'}); res.write('*'); server.once('timeout', common.mustCall(function() { res.end('*'); })); }); server.listen(0, options.host, function() { options.port = this.address().port; const req = http.request(options, onresponse); req.end(); function onresponse(res) { req.setTimeout(50, common.mustCall(function() { assert.strictEqual(nchunks, 1); // should have received the first chunk server.emit('timeout'); })); res.on('data', common.mustCall(function(data) { assert.strictEqual('' + data, '*'); nchunks++; }, 2)); res.on('end', common.mustCall(function() { assert.strictEqual(nchunks, 2); server.close(); })); } }); node-v4.8.2/test/parallel/test-http-client-timeout.js000644 000766 000024 00000001271 13070706737 022770 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var options = { method: 'GET', port: undefined, host: '127.0.0.1', path: '/' }; var server = http.createServer(function(req, res) { // this space intentionally left blank }); server.listen(0, options.host, function() { options.port = this.address().port; var req = http.request(options, function(res) { // this space intentionally left blank }); req.on('close', function() { server.close(); }); function destroy() { req.destroy(); } var s = req.setTimeout(1, destroy); assert.ok(s instanceof http.ClientRequest); req.on('error', destroy); req.end(); }); node-v4.8.2/test/parallel/test-http-client-unescaped-path.js000644 000766 000024 00000000472 13070706737 024205 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const http = require('http'); for (let i = 0; i <= 32; i += 1) { const path = 'bad' + String.fromCharCode(i) + 'path'; assert.throws(() => http.get({ path }, common.fail), /contains unescaped characters/); } node-v4.8.2/test/parallel/test-http-client-upload-buf.js000644 000766 000024 00000001764 13070706737 023347 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var http = require('http'); var N = 1024; var server = http.createServer(common.mustCall(function(req, res) { assert.equal('POST', req.method); var bytesReceived = 0; req.on('data', function(chunk) { bytesReceived += chunk.length; }); req.on('end', common.mustCall(function() { assert.strictEqual(N, bytesReceived); console.log('request complete from server'); res.writeHead(200, {'Content-Type': 'text/plain'}); res.write('hello\n'); res.end(); })); })); server.listen(0); server.on('listening', common.mustCall(function() { var req = http.request({ port: this.address().port, method: 'POST', path: '/' }, common.mustCall(function(res) { res.setEncoding('utf8'); res.on('data', function(chunk) { console.log(chunk); }); res.on('end', common.mustCall(function() { server.close(); })); })); req.write(new Buffer(N)); req.end(); })); node-v4.8.2/test/parallel/test-http-client-upload.js000644 000766 000024 00000002121 13070706737 022561 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var http = require('http'); var server = http.createServer(common.mustCall(function(req, res) { assert.equal('POST', req.method); req.setEncoding('utf8'); var sent_body = ''; req.on('data', function(chunk) { console.log('server got: ' + JSON.stringify(chunk)); sent_body += chunk; }); req.on('end', common.mustCall(function() { assert.strictEqual('1\n2\n3\n', sent_body); console.log('request complete from server'); res.writeHead(200, {'Content-Type': 'text/plain'}); res.write('hello\n'); res.end(); })); })); server.listen(0); server.on('listening', common.mustCall(function() { var req = http.request({ port: this.address().port, method: 'POST', path: '/' }, common.mustCall(function(res) { res.setEncoding('utf8'); res.on('data', function(chunk) { console.log(chunk); }); res.on('end', common.mustCall(function() { server.close(); })); })); req.write('1\n'); req.write('2\n'); req.write('3\n'); req.end(); })); node-v4.8.2/test/parallel/test-http-common.js000644 000766 000024 00000002442 13070706737 021317 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const httpCommon = require('_http_common'); const checkIsHttpToken = httpCommon._checkIsHttpToken; const checkInvalidHeaderChar = httpCommon._checkInvalidHeaderChar; // checkIsHttpToken assert(checkIsHttpToken('t')); assert(checkIsHttpToken('tt')); assert(checkIsHttpToken('ttt')); assert(checkIsHttpToken('tttt')); assert(checkIsHttpToken('ttttt')); assert.strictEqual(checkIsHttpToken(''), false); assert.strictEqual(checkIsHttpToken(' '), false); assert.strictEqual(checkIsHttpToken('あ'), false); assert.strictEqual(checkIsHttpToken('あa'), false); assert.strictEqual(checkIsHttpToken('aaaaあaaaa'), false); // checkInvalidHeaderChar assert(checkInvalidHeaderChar('あ')); assert(checkInvalidHeaderChar('aaaaあaaaa')); assert.strictEqual(checkInvalidHeaderChar(''), false); assert.strictEqual(checkInvalidHeaderChar(1), false); assert.strictEqual(checkInvalidHeaderChar(' '), false); assert.strictEqual(checkInvalidHeaderChar(false), false); assert.strictEqual(checkInvalidHeaderChar('t'), false); assert.strictEqual(checkInvalidHeaderChar('tt'), false); assert.strictEqual(checkInvalidHeaderChar('ttt'), false); assert.strictEqual(checkInvalidHeaderChar('tttt'), false); assert.strictEqual(checkInvalidHeaderChar('ttttt'), false); node-v4.8.2/test/parallel/test-http-conn-reset.js000644 000766 000024 00000001333 13070706737 022102 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var http = require('http'); var net = require('net'); var options = { host: '127.0.0.1', port: undefined }; // start a tcp server that closes incoming connections immediately var server = net.createServer(function(client) { client.destroy(); server.close(); }); server.listen(0, options.host, common.mustCall(onListen)); // do a GET request, expect it to fail function onListen() { options.port = this.address().port; var req = http.request(options, function(res) { assert.ok(false, 'this should never run'); }); req.on('error', common.mustCall(function(err) { assert.equal(err.code, 'ECONNRESET'); })); req.end(); } node-v4.8.2/test/parallel/test-http-connect-req-res.js000644 000766 000024 00000003670 13070706737 023040 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const http = require('http'); const server = http.createServer(common.fail); server.on('connect', common.mustCall(function(req, socket, firstBodyChunk) { assert.equal(req.method, 'CONNECT'); assert.equal(req.url, 'example.com:443'); console.error('Server got CONNECT request'); // It is legal for the server to send some data intended for the client // along with the CONNECT response socket.write( 'HTTP/1.1 200 Connection established\r\n' + 'Date: Tue, 15 Nov 1994 08:12:31 GMT\r\n' + '\r\n' + 'Head' ); var data = firstBodyChunk.toString(); socket.on('data', function(buf) { data += buf.toString(); }); socket.on('end', function() { socket.end(data); }); })); server.listen(0, common.mustCall(function() { const req = http.request({ port: this.address().port, method: 'CONNECT', path: 'example.com:443' }, common.fail); req.on('close', common.mustCall(function() { })); req.on('connect', common.mustCall(function(res, socket, firstBodyChunk) { console.error('Client got CONNECT request'); // Make sure this request got removed from the pool. const name = 'localhost:' + server.address().port; assert(!http.globalAgent.sockets.hasOwnProperty(name)); assert(!http.globalAgent.requests.hasOwnProperty(name)); // Make sure this socket has detached. assert(!socket.ondata); assert(!socket.onend); assert.equal(socket.listeners('connect').length, 0); assert.equal(socket.listeners('data').length, 0); var data = firstBodyChunk.toString(); // test that the firstBodyChunk was not parsed as HTTP assert.equal(data, 'Head'); socket.on('data', function(buf) { data += buf.toString(); }); socket.on('end', function() { assert.equal(data, 'HeadRequestEnd'); server.close(); }); socket.end('End'); })); req.end('Request'); })); node-v4.8.2/test/parallel/test-http-connect.js000644 000766 000024 00000004731 13070706737 021463 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var http = require('http'); var serverGotConnect = false; var clientGotConnect = false; var server = http.createServer(common.fail); server.on('connect', function(req, socket, firstBodyChunk) { assert.equal(req.method, 'CONNECT'); assert.equal(req.url, 'google.com:443'); console.error('Server got CONNECT request'); serverGotConnect = true; socket.write('HTTP/1.1 200 Connection established\r\n\r\n'); var data = firstBodyChunk.toString(); socket.on('data', function(buf) { data += buf.toString(); }); socket.on('end', function() { socket.end(data); }); }); server.listen(0, function() { var req = http.request({ port: this.address().port, method: 'CONNECT', path: 'google.com:443' }, common.fail); var clientRequestClosed = false; req.on('close', function() { clientRequestClosed = true; }); req.on('connect', function(res, socket, firstBodyChunk) { console.error('Client got CONNECT request'); clientGotConnect = true; // Make sure this request got removed from the pool. var name = 'localhost:' + server.address().port; assert(!http.globalAgent.sockets.hasOwnProperty(name)); assert(!http.globalAgent.requests.hasOwnProperty(name)); // Make sure this socket has detached. assert(!socket.ondata); assert(!socket.onend); assert.equal(socket.listeners('connect').length, 0); assert.equal(socket.listeners('data').length, 0); // the stream.Duplex onend listener // allow 0 here, so that i can run the same test on streams1 impl assert(socket.listeners('end').length <= 1); assert.equal(socket.listeners('free').length, 0); assert.equal(socket.listeners('close').length, 0); assert.equal(socket.listeners('error').length, 0); assert.equal(socket.listeners('agentRemove').length, 0); var data = firstBodyChunk.toString(); socket.on('data', function(buf) { data += buf.toString(); }); socket.on('end', function() { assert.equal(data, 'HeadBody'); assert(clientRequestClosed); server.close(); }); socket.write('Body'); socket.end(); }); // It is legal for the client to send some data intended for the server // before the "200 Connection established" (or any other success or // error code) is received. req.write('Head'); req.end(); }); process.on('exit', function() { assert.ok(serverGotConnect); assert.ok(clientGotConnect); }); node-v4.8.2/test/parallel/test-http-content-length.js000644 000766 000024 00000003757 13070706737 022772 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var expectedHeadersMultipleWrites = { 'connection': 'close', 'transfer-encoding': 'chunked', }; var expectedHeadersEndWithData = { 'connection': 'close', 'content-length': 'hello world'.length, }; var expectedHeadersEndNoData = { 'connection': 'close', 'content-length': '0', }; var receivedRequests = 0; var totalRequests = 3; var server = http.createServer(function(req, res) { res.removeHeader('Date'); switch (req.url.substr(1)) { case 'multiple-writes': assert.deepEqual(req.headers, expectedHeadersMultipleWrites); res.write('hello'); res.end('world'); break; case 'end-with-data': assert.deepEqual(req.headers, expectedHeadersEndWithData); res.end('hello world'); break; case 'empty': assert.deepEqual(req.headers, expectedHeadersEndNoData); res.end(); break; default: throw new Error('Unreachable'); } receivedRequests++; if (totalRequests === receivedRequests) server.close(); }); server.listen(0, function() { var req; req = http.request({ port: this.address().port, method: 'POST', path: '/multiple-writes' }); req.removeHeader('Date'); req.removeHeader('Host'); req.write('hello '); req.end('world'); req.on('response', function(res) { assert.deepEqual(res.headers, expectedHeadersMultipleWrites); }); req = http.request({ port: this.address().port, method: 'POST', path: '/end-with-data' }); req.removeHeader('Date'); req.removeHeader('Host'); req.end('hello world'); req.on('response', function(res) { assert.deepEqual(res.headers, expectedHeadersEndWithData); }); req = http.request({ port: this.address().port, method: 'POST', path: '/empty' }); req.removeHeader('Date'); req.removeHeader('Host'); req.end(); req.on('response', function(res) { assert.deepEqual(res.headers, expectedHeadersEndNoData); }); }); node-v4.8.2/test/parallel/test-http-contentLength0.js000644 000766 000024 00000001114 13070706737 022716 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var http = require('http'); // Simple test of Node's HTTP Client choking on a response // with a 'Content-Length: 0 ' response header. // I.E. a space character after the 'Content-Length' throws an `error` event. var s = http.createServer(function(req, res) { res.writeHead(200, {'Content-Length': '0 '}); res.end(); }); s.listen(0, function() { var request = http.request({ port: this.address().port }, function(response) { console.log('STATUS: ' + response.statusCode); s.close(); response.resume(); }); request.end(); }); node-v4.8.2/test/parallel/test-http-createConnection.js000644 000766 000024 00000001265 13070706737 023314 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var net = require('net'); var create = 0; var response = 0; process.on('exit', function() { assert.equal(1, create, 'createConnection() http option was not called'); assert.equal(1, response, 'http server "request" callback was not called'); }); var server = http.createServer(function(req, res) { res.end(); response++; }).listen(0, '127.0.0.1', function() { http.get({ createConnection: createConnection }, function(res) { res.resume(); server.close(); }); }); function createConnection() { create++; return net.createConnection(server.address().port, '127.0.0.1'); } node-v4.8.2/test/parallel/test-http-date-header.js000644 000766 000024 00000001433 13070706737 022171 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var testResBody = 'other stuff!\n'; var server = http.createServer(function(req, res) { assert.ok(!('date' in req.headers), 'Request headers contained a Date.'); res.writeHead(200, { 'Content-Type': 'text/plain' }); res.end(testResBody); }); server.listen(0); server.addListener('listening', function() { var options = { port: this.address().port, path: '/', method: 'GET' }; var req = http.request(options, function(res) { assert.ok('date' in res.headers, 'Response headers didn\'t contain a Date.'); res.addListener('end', function() { server.close(); process.exit(); }); res.resume(); }); req.end(); }); node-v4.8.2/test/parallel/test-http-default-encoding.js000644 000766 000024 00000001400 13070706737 023230 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var expected = 'This is a unicode text: سلام'; var result = ''; var server = http.Server(function(req, res) { req.setEncoding('utf8'); req.on('data', function(chunk) { result += chunk; }).on('end', function() { server.close(); res.writeHead(200); res.end('hello world\n'); }); }); server.listen(0, function() { http.request({ port: this.address().port, path: '/', method: 'POST' }, function(res) { console.log(res.statusCode); res.resume(); }).on('error', function(e) { console.log(e.message); process.exit(1); }).end(expected); }); process.on('exit', function() { assert.equal(expected, result); }); node-v4.8.2/test/parallel/test-http-default-port.js000644 000766 000024 00000003220 13070706737 022430 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const http = require('http'); const assert = require('assert'); const hostExpect = 'localhost'; const fs = require('fs'); const path = require('path'); const fixtures = path.join(common.fixturesDir, 'keys'); const options = { key: fs.readFileSync(fixtures + '/agent1-key.pem'), cert: fs.readFileSync(fixtures + '/agent1-cert.pem') }; let gotHttpsResp = false; let gotHttpResp = false; if (common.hasCrypto) { var https = require('https'); } else { common.skip('missing crypto'); } process.on('exit', function() { if (common.hasCrypto) { assert(gotHttpsResp); } assert(gotHttpResp); console.log('ok'); }); http.createServer(function(req, res) { assert.equal(req.headers.host, hostExpect); assert.equal(req.headers['x-port'], this.address().port); res.writeHead(200); res.end('ok'); this.close(); }).listen(0, function() { http.globalAgent.defaultPort = this.address().port; http.get({ host: 'localhost', headers: { 'x-port': this.address().port } }, function(res) { gotHttpResp = true; res.resume(); }); }); if (common.hasCrypto) { https.createServer(options, function(req, res) { assert.equal(req.headers.host, hostExpect); assert.equal(req.headers['x-port'], this.address().port); res.writeHead(200); res.end('ok'); this.close(); }).listen(0, function() { https.globalAgent.defaultPort = this.address().port; https.get({ host: 'localhost', rejectUnauthorized: false, headers: { 'x-port': this.address().port } }, function(res) { gotHttpsResp = true; res.resume(); }); }); } node-v4.8.2/test/parallel/test-http-destroyed-socket-write2.js000644 000766 000024 00000003037 13070706737 024532 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); // Verify that ECONNRESET is raised when writing to a http request // where the server has ended the socket. var http = require('http'); var server = http.createServer(function(req, res) { setImmediate(function() { res.destroy(); }); }); server.listen(0, function() { var req = http.request({ port: this.address().port, path: '/', method: 'POST' }); function write() { req.write('hello', function() { setImmediate(write); }); } req.on('error', common.mustCall(function(er) { switch (er.code) { // This is the expected case case 'ECONNRESET': break; // On Windows, this sometimes manifests as ECONNABORTED case 'ECONNABORTED': break; // This test is timing sensitive so an EPIPE is not out of the question. // It should be infrequent, given the 50 ms timeout, but not impossible. case 'EPIPE': break; default: assert.strictEqual(er.code, 'ECONNRESET', 'Write to a torn down client should RESET or ABORT'); break; } assert.equal(req.output.length, 0); assert.equal(req.outputEncodings.length, 0); server.close(); })); req.on('response', function(res) { res.on('data', function(chunk) { common.fail('Should not receive response data'); }); res.on('end', function() { common.fail('Should not receive response end'); }); }); write(); }); node-v4.8.2/test/parallel/test-http-dns-error.js000644 000766 000024 00000001740 13070706737 021742 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const http = require('http'); if (common.hasCrypto) { var https = require('https'); } else { common.skip('missing crypto'); } const host = '*'.repeat(256); function do_not_call() { throw new Error('This function should not have been called.'); } function test(mod) { // Bad host name should not throw an uncatchable exception. // Ensure that there is time to attach an error listener. const req1 = mod.get({host: host, port: 42}, do_not_call); req1.on('error', common.mustCall(function(err) { assert.strictEqual(err.code, 'ENOTFOUND'); })); // http.get() called req1.end() for us const req2 = mod.request({method: 'GET', host: host, port: 42}, do_not_call); req2.on('error', common.mustCall(function(err) { assert.strictEqual(err.code, 'ENOTFOUND'); })); req2.end(); } if (common.hasCrypto) { test(https); } else { common.skip('missing crypto'); } test(http); node-v4.8.2/test/parallel/test-http-double-content-length.js000644 000766 000024 00000001611 13070706737 024225 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const http = require('http'); const assert = require('assert'); // The callback should never be invoked because the server // should respond with a 400 Client Error when a double // Content-Length header is received. const server = http.createServer((req, res) => { assert(false, 'callback should not have been invoked'); res.end(); }); server.on('clientError', common.mustCall((err, socket) => { assert(/^Parse Error/.test(err.message)); assert.equal(err.code, 'HPE_UNEXPECTED_CONTENT_LENGTH'); socket.destroy(); })); server.listen(0, () => { const req = http.get({ port: server.address().port, // Send two content-length header values. headers: {'Content-Length': [1, 2]}}, (res) => { common.fail('an error should have occurred'); } ); req.on('error', common.mustCall(() => { server.close(); })); }); node-v4.8.2/test/parallel/test-http-end-throw-socket-handling.js000644 000766 000024 00000001435 13070706737 025007 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); // Make sure that throwing in 'end' handler doesn't lock // up the socket forever. // // This is NOT a good way to handle errors in general, but all // the same, we should not be so brittle and easily broken. const http = require('http'); let n = 0; const server = http.createServer((req, res) => { if (++n === 10) server.close(); res.end('ok'); }); server.listen(0, common.mustCall(() => { for (let i = 0; i < 10; i++) { const options = { port: server.address().port }; const req = http.request(options, (res) => { res.resume(); res.on('end', common.mustCall(() => { throw new Error('gleep glorp'); })); }); req.end(); } })); process.on('uncaughtException', common.mustCall(() => {}, 10)); node-v4.8.2/test/parallel/test-http-eof-on-connect.js000644 000766 000024 00000001076 13070706737 022643 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var net = require('net'); var http = require('http'); // This is a regression test for https://github.com/joyent/node/issues/44 // It is separate from test-http-malformed-request.js because it is only // reproduceable on the first packet on the first connection to a server. var server = http.createServer(function(req, res) {}); server.listen(0); server.on('listening', function() { net.createConnection(this.address().port).on('connect', function() { this.destroy(); }).on('close', function() { server.close(); }); }); node-v4.8.2/test/parallel/test-http-exceptions.js000644 000766 000024 00000001213 13070706737 022203 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var http = require('http'); var server = http.createServer(function(req, res) { intentionally_not_defined(); // eslint-disable-line no-undef res.writeHead(200, {'Content-Type': 'text/plain'}); res.write('Thank you, come again.'); res.end(); }); server.listen(0, function() { for (var i = 0; i < 4; i += 1) { http.get({ port: this.address().port, path: '/busy/' + i }); } }); var exception_count = 0; process.on('uncaughtException', function(err) { console.log('Caught an exception: ' + err); if (err.name === 'AssertionError') throw err; if (++exception_count === 4) process.exit(0); }); node-v4.8.2/test/parallel/test-http-expect-continue.js000644 000766 000024 00000003550 13070706737 023142 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var outstanding_reqs = 0; var test_req_body = 'some stuff...\n'; var test_res_body = 'other stuff!\n'; var sent_continue = false; var got_continue = false; function handler(req, res) { assert.equal(sent_continue, true, 'Full response sent before 100 Continue'); console.error('Server sending full response...'); res.writeHead(200, { 'Content-Type': 'text/plain', 'ABCD': '1' }); res.end(test_res_body); } var server = http.createServer(handler); server.on('checkContinue', function(req, res) { console.error('Server got Expect: 100-continue...'); res.writeContinue(); sent_continue = true; setTimeout(function() { handler(req, res); }, 100); }); server.listen(0); server.on('listening', function() { var req = http.request({ port: this.address().port, method: 'POST', path: '/world', headers: { 'Expect': '100-continue' } }); console.error('Client sending request...'); outstanding_reqs++; var body = ''; req.on('continue', function() { console.error('Client got 100 Continue...'); got_continue = true; req.end(test_req_body); }); req.on('response', function(res) { assert.equal(got_continue, true, 'Full response received before 100 Continue'); assert.equal(200, res.statusCode, 'Final status code was ' + res.statusCode + ', not 200.'); res.setEncoding('utf8'); res.on('data', function(chunk) { body += chunk; }); res.on('end', function() { console.error('Got full response.'); assert.equal(body, test_res_body, 'Response body doesn\'t match.'); assert.ok('abcd' in res.headers, 'Response headers missing.'); outstanding_reqs--; if (outstanding_reqs === 0) { server.close(); process.exit(); } }); }); }); node-v4.8.2/test/parallel/test-http-extra-response.js000644 000766 000024 00000003157 13070706737 023012 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var http = require('http'); var net = require('net'); // If an HTTP server is broken and sends data after the end of the response, // node should ignore it and drop the connection. // Demos this bug: https://github.com/joyent/node/issues/680 var body = 'hello world\r\n'; var fullResponse = 'HTTP/1.1 500 Internal Server Error\r\n' + 'Content-Length: ' + body.length + '\r\n' + 'Content-Type: text/plain\r\n' + 'Date: Fri + 18 Feb 2011 06:22:45 GMT\r\n' + 'Host: 10.20.149.2\r\n' + 'Access-Control-Allow-Credentials: true\r\n' + 'Server: badly broken/0.1 (OS NAME)\r\n' + '\r\n' + body; var server = net.createServer(function(socket) { var postBody = ''; socket.setEncoding('utf8'); socket.on('data', function(chunk) { postBody += chunk; if (postBody.indexOf('\r\n') > -1) { socket.write(fullResponse); // omg, I wrote the response twice, what a terrible HTTP server I am. socket.end(fullResponse); } }); socket.on('error', function(err) { assert.equal(err.code, 'ECONNRESET'); }); }); server.listen(0, common.mustCall(function() { http.get({ port: this.address().port }, common.mustCall(function(res) { var buffer = ''; console.log('Got res code: ' + res.statusCode); res.setEncoding('utf8'); res.on('data', function(chunk) { buffer += chunk; }); res.on('end', common.mustCall(function() { console.log('Response ended, read ' + buffer.length + ' bytes'); assert.equal(body, buffer); server.close(); })); })); })); node-v4.8.2/test/parallel/test-http-flush-headers.js000644 000766 000024 00000000725 13070706737 022563 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const http = require('http'); const server = http.createServer(); server.on('request', function(req, res) { assert.equal(req.headers['foo'], 'bar'); res.end('ok'); server.close(); }); server.listen(0, '127.0.0.1', function() { const req = http.request({ method: 'GET', host: '127.0.0.1', port: this.address().port, }); req.setHeader('foo', 'bar'); req.flushHeaders(); }); node-v4.8.2/test/parallel/test-http-flush-response-headers.js000644 000766 000024 00000001155 13070706737 024415 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const http = require('http'); const server = http.createServer(); server.on('request', function(req, res) { res.writeHead(200, {'foo': 'bar'}); res.flushHeaders(); res.flushHeaders(); // Should be idempotent. }); server.listen(0, common.localhostIPv4, function() { var req = http.request({ method: 'GET', host: common.localhostIPv4, port: this.address().port, }, onResponse); req.end(); function onResponse(res) { assert.equal(res.headers['foo'], 'bar'); res.destroy(); server.close(); } }); node-v4.8.2/test/parallel/test-http-flush.js000644 000766 000024 00000000566 13070706737 021155 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var http = require('http'); http.createServer(function(req, res) { res.end('ok'); this.close(); }).listen(0, '127.0.0.1', function() { var req = http.request({ method: 'POST', host: '127.0.0.1', port: this.address().port, }); req.flush(); // Flush the request headers. req.flush(); // Should be idempotent. }); node-v4.8.2/test/parallel/test-http-full-response.js000644 000766 000024 00000003106 13070706737 022623 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); // This test requires the program 'ab' var http = require('http'); var exec = require('child_process').exec; var bodyLength = 12345; var body = 'c'.repeat(bodyLength); var server = http.createServer(function(req, res) { res.writeHead(200, { 'Content-Length': bodyLength, 'Content-Type': 'text/plain' }); res.end(body); }); function runAb(opts, callback) { var command = `ab ${opts} http://127.0.0.1:${server.address().port}/`; exec(command, function(err, stdout, stderr) { if (err) { if (/ab|apr/mi.test(stderr)) { common.skip('problem spawning `ab`.\n' + stderr); process.reallyExit(0); } process.exit(); return; } var m = /Document Length:\s*(\d+) bytes/mi.exec(stdout); var documentLength = parseInt(m[1]); m = /Complete requests:\s*(\d+)/mi.exec(stdout); var completeRequests = parseInt(m[1]); m = /HTML transferred:\s*(\d+) bytes/mi.exec(stdout); var htmlTransfered = parseInt(m[1]); assert.equal(bodyLength, documentLength); assert.equal(completeRequests * documentLength, htmlTransfered); if (callback) callback(); }); } server.listen(0, common.mustCall(function() { runAb('-c 1 -n 10', common.mustCall(function() { console.log('-c 1 -n 10 okay'); runAb('-c 1 -n 100', common.mustCall(function() { console.log('-c 1 -n 100 okay'); runAb('-c 1 -n 1000', common.mustCall(function() { console.log('-c 1 -n 1000 okay'); server.close(); })); })); })); })); node-v4.8.2/test/parallel/test-http-get-pipeline-problem.js000644 000766 000024 00000004224 13070706737 024047 0ustar00iojsstaff000000 000000 'use strict'; // In previous versions of Node.js (e.g., 0.6.0), this sort of thing would halt // after http.globalAgent.maxSockets number of files. // See https://groups.google.com/forum/#!topic/nodejs-dev/V5fB69hFa9o var common = require('../common'); var assert = require('assert'); var http = require('http'); var fs = require('fs'); http.globalAgent.maxSockets = 1; common.refreshTmpDir(); var image = fs.readFileSync(common.fixturesDir + '/person.jpg'); console.log('image.length = ' + image.length); var total = 10; var requests = 0, responses = 0; var server = http.Server(function(req, res) { if (++requests === total) { server.close(); } setTimeout(function() { res.writeHead(200, { 'content-type': 'image/jpeg', 'connection': 'close', 'content-length': image.length }); res.end(image); }, 1); }); server.listen(0, function() { for (var i = 0; i < total; i++) { (function() { var x = i; var opts = { port: server.address().port, headers: { connection: 'close' } }; http.get(opts, function(res) { console.error('recv ' + x); var s = fs.createWriteStream(common.tmpDir + '/' + x + '.jpg'); res.pipe(s); s.on('finish', function() { console.error('done ' + x); if (++responses === total) { checkFiles(); } }); }).on('error', function(e) { console.error('error! ', e.message); throw e; }); })(); } }); var checkedFiles = false; function checkFiles() { // Should see 1.jpg, 2.jpg, ..., 100.jpg in tmpDir var files = fs.readdirSync(common.tmpDir); assert(total <= files.length); for (var i = 0; i < total; i++) { var fn = i + '.jpg'; assert.ok(files.indexOf(fn) >= 0, "couldn't find '" + fn + "'"); var stat = fs.statSync(common.tmpDir + '/' + fn); assert.equal(image.length, stat.size, "size doesn't match on '" + fn + "'. Got " + stat.size + ' bytes'); } checkedFiles = true; } process.on('exit', function() { assert.equal(total, requests); assert.equal(total, responses); assert.ok(checkedFiles); }); node-v4.8.2/test/parallel/test-http-head-request.js000644 000766 000024 00000001457 13070706737 022423 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var http = require('http'); var body = 'hello world\n'; function test(headers) { var server = http.createServer(function(req, res) { console.error('req: %s headers: %j', req.method, headers); res.writeHead(200, headers); res.end(); server.close(); }); server.listen(0, common.mustCall(function() { var request = http.request({ port: this.address().port, method: 'HEAD', path: '/' }, common.mustCall(function(response) { console.error('response start'); response.on('end', common.mustCall(function() { console.error('response end'); })); response.resume(); })); request.end(); })); } test({ 'Transfer-Encoding': 'chunked' }); test({ 'Content-Length': body.length }); node-v4.8.2/test/parallel/test-http-head-response-has-no-body-end.js000644 000766 000024 00000001241 13070706737 025442 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var http = require('http'); // This test is to make sure that when the HTTP server // responds to a HEAD request with data to res.end, // it does not send any body. var server = http.createServer(function(req, res) { res.writeHead(200); res.end('FAIL'); // broken: sends FAIL from hot path. }); server.listen(0); server.on('listening', common.mustCall(function() { var req = http.request({ port: this.address().port, method: 'HEAD', path: '/' }, common.mustCall(function(res) { res.on('end', common.mustCall(function() { server.close(); })); res.resume(); })); req.end(); })); node-v4.8.2/test/parallel/test-http-head-response-has-no-body.js000644 000766 000024 00000001253 13070706737 024701 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var http = require('http'); // This test is to make sure that when the HTTP server // responds to a HEAD request, it does not send any body. // In this case it was sending '0\r\n\r\n' var server = http.createServer(function(req, res) { res.writeHead(200); // broken: defaults to TE chunked res.end(); }); server.listen(0); server.on('listening', common.mustCall(function() { var req = http.request({ port: this.address().port, method: 'HEAD', path: '/' }, common.mustCall(function(res) { res.on('end', common.mustCall(function() { server.close(); })); res.resume(); })); req.end(); })); node-v4.8.2/test/parallel/test-http-header-obstext.js000644 000766 000024 00000000636 13070706737 022750 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const http = require('http'); const assert = require('assert'); const server = http.createServer(common.mustCall((req, res) => { res.end('ok'); })); server.listen(0, () => { http.get({ port: server.address().port, headers: {'Test': 'Düsseldorf'} }, common.mustCall((res) => { assert.equal(res.statusCode, 200); server.close(); })); }); node-v4.8.2/test/parallel/test-http-header-read.js000644 000766 000024 00000001632 13070706737 022170 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); // Verify that ServerResponse.getHeader() works correctly even after // the response header has been sent. Issue 752 on github. var s = http.createServer(function(req, res) { var contentType = 'Content-Type'; var plain = 'text/plain'; res.setHeader(contentType, plain); assert.ok(!res.headersSent); res.writeHead(200); assert.ok(res.headersSent); res.end('hello world\n'); // This checks that after the headers have been sent, getHeader works // and does not throw an exception (Issue 752) assert.doesNotThrow( function() { assert.equal(plain, res.getHeader(contentType)); } ); }); s.listen(0, runTest); function runTest() { http.get({ port: this.address().port }, function(response) { response.on('end', function() { s.close(); }); response.resume(); }); } node-v4.8.2/test/parallel/test-http-header-response-splitting.js000644 000766 000024 00000004701 13070706737 025126 0ustar00iojsstaff000000 000000 // Flags: --security-revert=CVE-2016-2216 'use strict'; const common = require('../common'); const assert = require('assert'); const http = require('http'); var testIndex = 0; const testCount = 2 * 4 * 6; const responseBody = 'Hi mars!'; var server = http.createServer(function(req, res) { function reply(header) { switch (testIndex % 4) { case 0: res.writeHead(200, { a: header, b: header }); break; case 1: res.setHeader('a', header); res.setHeader('b', header); res.writeHead(200); break; case 2: res.setHeader('a', header); res.writeHead(200, { b: header }); break; case 3: res.setHeader('a', [header]); res.writeHead(200, { b: header }); break; default: assert.fail(null, null, 'unreachable'); } res.write(responseBody); if (testIndex % 8 < 4) { res.addTrailers({ ta: header, tb: header }); } else { res.addTrailers([['ta', header], ['tb', header]]); } res.end(); } switch ((testIndex / 8) | 0) { case 0: reply('foo \r\ninvalid: bar'); break; case 1: reply('foo \ninvalid: bar'); break; case 2: reply('foo \rinvalid: bar'); break; case 3: reply('foo \n\n\ninvalid: bar'); break; case 4: reply('foo \r\n \r\n \r\ninvalid: bar'); break; case 5: reply('foo \r \n \r \n \r \ninvalid: bar'); break; default: assert(false); } if (++testIndex === testCount) { server.close(); } }); server.listen(0, common.mustCall(function() { const port = this.address().port; for (var i = 0; i < testCount; i++) { http.get({ port: port, path: '/' }, common.mustCall(function(res) { assert.strictEqual(res.headers.a, 'foo invalid: bar'); assert.strictEqual(res.headers.b, 'foo invalid: bar'); assert.strictEqual(res.headers.foo, undefined); assert.strictEqual(res.headers.invalid, undefined); var data = ''; res.setEncoding('utf8'); res.on('data', function(s) { data += s; }); res.on('end', common.mustCall(function() { assert.equal(data, responseBody); assert.strictEqual(res.trailers.ta, 'foo invalid: bar'); assert.strictEqual(res.trailers.tb, 'foo invalid: bar'); assert.strictEqual(res.trailers.foo, undefined); assert.strictEqual(res.trailers.invalid, undefined); })); res.resume(); })); } })); node-v4.8.2/test/parallel/test-http-hex-write.js000644 000766 000024 00000001253 13070706737 021742 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var http = require('http'); var expect = 'hex\nutf8\n'; http.createServer(function(q, s) { s.setHeader('content-length', expect.length); s.write('6865780a', 'hex'); s.write('utf8\n'); s.end(); this.close(); }).listen(0, common.mustCall(function() { http.request({ port: this.address().port }) .on('response', common.mustCall(function(res) { var data = ''; res.setEncoding('ascii'); res.on('data', function(c) { data += c; }); res.on('end', common.mustCall(function() { assert.strictEqual(data, expect); })); })).end(); })); node-v4.8.2/test/parallel/test-http-host-header-ipv6-fail.js000644 000766 000024 00000001733 13070706737 024027 0ustar00iojsstaff000000 000000 'use strict'; /* * When using the object form of http.request and using an IPv6 address * as a hostname, and using a non-standard port, the Host header * is improperly formatted. * Issue: https://github.com/nodejs/node/issues/5308 * As per https://tools.ietf.org/html/rfc7230#section-5.4 and * https://tools.ietf.org/html/rfc3986#section-3.2.2 * the IPv6 address should be enclosed in square brackets */ const common = require('../common'); const assert = require('assert'); const http = require('http'); const hostname = '::1'; function httpreq() { var req = http.request({ host: hostname, port: server.address().port, path: '/', method: 'GET' }); req.end(); } if (!common.hasIPv6) { console.error('Skipping test, no IPv6 support'); return; } const server = http.createServer(common.mustCall(function(req, res) { assert.ok(req.headers.host, `[${hostname}]`); res.end(); server.close(true); })); server.listen(0, hostname, () => httpreq()); node-v4.8.2/test/parallel/test-http-host-headers.js000644 000766 000024 00000003412 13070706737 022413 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const http = require('http'); const assert = require('assert'); const httpServer = http.createServer(reqHandler); function reqHandler(req, res) { if (req.url === '/setHostFalse5') { assert.equal(req.headers.host, undefined); } else { assert.equal(req.headers.host, `localhost:${this.address().port}`, 'Wrong host header for req[' + req.url + ']: ' + req.headers.host); } res.writeHead(200, {}); res.end('ok'); } testHttp(); function testHttp() { var counter = 0; function cb(res) { counter--; if (counter === 0) { httpServer.close(); } res.resume(); } httpServer.listen(0, (er) => { assert.ifError(er); http.get({ method: 'GET', path: '/' + (counter++), host: 'localhost', port: httpServer.address().port, rejectUnauthorized: false }, cb).on('error', common.fail); http.request({ method: 'GET', path: '/' + (counter++), host: 'localhost', port: httpServer.address().port, rejectUnauthorized: false }, cb).on('error', common.fail).end(); http.request({ method: 'POST', path: '/' + (counter++), host: 'localhost', port: httpServer.address().port, rejectUnauthorized: false }, cb).on('error', common.fail).end(); http.request({ method: 'PUT', path: '/' + (counter++), host: 'localhost', port: httpServer.address().port, rejectUnauthorized: false }, cb).on('error', common.fail).end(); http.request({ method: 'DELETE', path: '/' + (counter++), host: 'localhost', port: httpServer.address().port, rejectUnauthorized: false }, cb).on('error', common.fail).end(); }); } node-v4.8.2/test/parallel/test-http-incoming-pipelined-socket-destroy.js000644 000766 000024 00000003036 13070706737 026556 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const http = require('http'); const net = require('net'); const seeds = [ 3, 1, 2, 3, 4, 1, 2, 3, 4, 1, 2, 3, 4 ]; // Set up some timing issues where sockets can be destroyed // via either the req or res. const server = http.createServer(common.mustCall(function(req, res) { switch (req.url) { case '/1': return setImmediate(function() { req.socket.destroy(); server.emit('requestDone'); }); case '/2': return process.nextTick(function() { res.destroy(); server.emit('requestDone'); }); // in one case, actually send a response in 2 chunks case '/3': res.write('hello '); return setImmediate(function() { res.end('world!'); server.emit('requestDone'); }); default: res.destroy(); server.emit('requestDone'); } }, seeds.length)); // Make a bunch of requests pipelined on the same socket function generator(seeds) { return seeds.map(function(r) { return 'GET /' + r + ' HTTP/1.1\r\n' + `Host: localhost:${server.address().port}\r\n` + '\r\n' + '\r\n'; }).join(''); } server.listen(0, common.mustCall(function() { const client = net.connect({ port: this.address().port }); let done = 0; server.on('requestDone', function() { if (++done === seeds.length) { server.close(); } }); // immediately write the pipelined requests. // Some of these will not have a socket to destroy! client.write(generator(seeds)); })); node-v4.8.2/test/parallel/test-http-keep-alive-close-on-header.js000644 000766 000024 00000003244 13070706737 025015 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var body = 'hello world\n'; var headers = {'connection': 'keep-alive'}; var server = http.createServer(function(req, res) { res.writeHead(200, {'Content-Length': body.length, 'Connection': 'close'}); res.write(body); res.end(); }); var connectCount = 0; server.listen(0, function() { var agent = new http.Agent({ maxSockets: 1 }); var name = agent.getName({ port: this.address().port }); var request = http.request({ method: 'GET', path: '/', headers: headers, port: this.address().port, agent: agent }, function(res) { assert.equal(1, agent.sockets[name].length); res.resume(); }); request.on('socket', function(s) { s.on('connect', function() { connectCount++; }); }); request.end(); request = http.request({ method: 'GET', path: '/', headers: headers, port: this.address().port, agent: agent }, function(res) { assert.equal(1, agent.sockets[name].length); res.resume(); }); request.on('socket', function(s) { s.on('connect', function() { connectCount++; }); }); request.end(); request = http.request({ method: 'GET', path: '/', headers: headers, port: this.address().port, agent: agent }, function(response) { response.on('end', function() { assert.equal(1, agent.sockets[name].length); server.close(); }); response.resume(); }); request.on('socket', function(s) { s.on('connect', function() { connectCount++; }); }); request.end(); }); process.on('exit', function() { assert.equal(3, connectCount); }); node-v4.8.2/test/parallel/test-http-keep-alive.js000644 000766 000024 00000002755 13070706737 022060 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const http = require('http'); const server = http.createServer(common.mustCall((req, res) => { const body = 'hello world\n'; res.writeHead(200, {'Content-Length': body.length}); res.write(body); res.end(); }, 3)); const agent = new http.Agent({maxSockets: 1}); const headers = {'connection': 'keep-alive'}; let name; server.listen(0, common.mustCall(function() { name = agent.getName({ port: this.address().port }); http.get({ path: '/', headers: headers, port: this.address().port, agent: agent }, common.mustCall((response) => { assert.strictEqual(agent.sockets[name].length, 1); assert.strictEqual(agent.requests[name].length, 2); response.resume(); })); http.get({ path: '/', headers: headers, port: this.address().port, agent: agent }, common.mustCall((response) => { assert.strictEqual(agent.sockets[name].length, 1); assert.strictEqual(agent.requests[name].length, 1); response.resume(); })); http.get({ path: '/', headers: headers, port: this.address().port, agent: agent }, common.mustCall((response) => { response.on('end', common.mustCall(() => { assert.strictEqual(agent.sockets[name].length, 1); assert(!agent.requests.hasOwnProperty(name)); server.close(); })); response.resume(); })); })); process.on('exit', () => { assert(!agent.sockets.hasOwnProperty(name)); assert(!agent.requests.hasOwnProperty(name)); }); node-v4.8.2/test/parallel/test-http-keepalive-client.js000644 000766 000024 00000002515 13070706737 023251 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var serverSocket = null; var server = http.createServer(function(req, res) { // They should all come in on the same server socket. if (serverSocket) { assert.equal(req.socket, serverSocket); } else { serverSocket = req.socket; } res.end(req.url); }); server.listen(0, function() { makeRequest(expectRequests); }); var agent = http.Agent({ keepAlive: true }); var clientSocket = null; var expectRequests = 10; var actualRequests = 0; function makeRequest(n) { if (n === 0) { server.close(); agent.destroy(); return; } var req = http.request({ port: server.address().port, agent: agent, path: '/' + n }); req.end(); req.on('socket', function(sock) { if (clientSocket) { assert.equal(sock, clientSocket); } else { clientSocket = sock; } }); req.on('response', function(res) { var data = ''; res.setEncoding('utf8'); res.on('data', function(c) { data += c; }); res.on('end', function() { assert.equal(data, '/' + n); setTimeout(function() { actualRequests++; makeRequest(n - 1); }, 1); }); }); } process.on('exit', function() { assert.equal(actualRequests, expectRequests); console.log('ok'); }); node-v4.8.2/test/parallel/test-http-keepalive-maxsockets.js000644 000766 000024 00000003557 13070706737 024163 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var serverSockets = []; var server = http.createServer(function(req, res) { if (serverSockets.indexOf(req.socket) === -1) { serverSockets.push(req.socket); } res.end(req.url); }); server.listen(0, function() { var agent = http.Agent({ keepAlive: true, maxSockets: 5, maxFreeSockets: 2 }); var closed = false; makeReqs(10, function(er) { assert.ifError(er); assert.equal(count(agent.freeSockets), 2); assert.equal(count(agent.sockets), 0); assert.equal(serverSockets.length, 5); // now make 10 more reqs. // should use the 2 free reqs from the pool first. makeReqs(10, function(er) { assert.ifError(er); assert.equal(count(agent.freeSockets), 2); assert.equal(count(agent.sockets), 0); assert.equal(serverSockets.length, 8); agent.destroy(); server.close(function() { closed = true; }); }); }); process.on('exit', function() { assert(closed); console.log('ok'); }); // make 10 requests in parallel, // then 10 more when they all finish. function makeReqs(n, cb) { for (var i = 0; i < n; i++) makeReq(i, then); function then(er) { if (er) return cb(er); else if (--n === 0) setTimeout(cb, 100); } } function makeReq(i, cb) { http.request({ port: server.address().port, path: '/' + i, agent: agent }, function(res) { var data = ''; res.setEncoding('ascii'); res.on('data', function(c) { data += c; }); res.on('end', function() { assert.equal(data, '/' + i); cb(); }); }).end(); } function count(sockets) { return Object.keys(sockets).reduce(function(n, name) { return n + sockets[name].length; }, 0); } }); node-v4.8.2/test/parallel/test-http-keepalive-request.js000644 000766 000024 00000002515 13070706737 023463 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var serverSocket = null; var server = http.createServer(function(req, res) { // They should all come in on the same server socket. if (serverSocket) { assert.equal(req.socket, serverSocket); } else { serverSocket = req.socket; } res.end(req.url); }); server.listen(0, function() { makeRequest(expectRequests); }); var agent = http.Agent({ keepAlive: true }); var clientSocket = null; var expectRequests = 10; var actualRequests = 0; function makeRequest(n) { if (n === 0) { server.close(); agent.destroy(); return; } var req = http.request({ port: server.address().port, path: '/' + n, agent: agent }); req.end(); req.on('socket', function(sock) { if (clientSocket) { assert.equal(sock, clientSocket); } else { clientSocket = sock; } }); req.on('response', function(res) { var data = ''; res.setEncoding('utf8'); res.on('data', function(c) { data += c; }); res.on('end', function() { assert.equal(data, '/' + n); setTimeout(function() { actualRequests++; makeRequest(n - 1); }, 1); }); }); } process.on('exit', function() { assert.equal(actualRequests, expectRequests); console.log('ok'); }); node-v4.8.2/test/parallel/test-http-legacy.js000644 000766 000024 00000003704 13070706737 021275 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var http = require('http'); var url = require('url'); var responses_sent = 0; var body0 = ''; var body1 = ''; var server = http.createServer(function(req, res) { if (responses_sent === 0) { assert.equal('GET', req.method); assert.equal('/hello', url.parse(req.url).pathname); console.dir(req.headers); assert.equal(true, 'accept' in req.headers); assert.equal('*/*', req.headers['accept']); assert.equal(true, 'foo' in req.headers); assert.equal('bar', req.headers['foo']); } if (responses_sent === 1) { assert.equal('POST', req.method); assert.equal('/world', url.parse(req.url).pathname); this.close(); } req.on('end', function() { res.writeHead(200, {'Content-Type': 'text/plain'}); res.write('The path was ' + url.parse(req.url).pathname); res.end(); responses_sent += 1; }); req.resume(); }); server.listen(0, common.mustCall(function() { var client = http.createClient(this.address().port); var req = client.request('/hello', {'Accept': '*/*', 'Foo': 'bar'}); setTimeout(function() { req.end(); }, 100); req.on('response', common.mustCall(function(res) { assert.equal(200, res.statusCode); res.setEncoding('utf8'); res.on('data', function(chunk) { body0 += chunk; }); console.error('Got /hello response'); })); setTimeout(common.mustCall(function() { var req = client.request('POST', '/world'); req.end(); req.on('response', common.mustCall(function(res) { assert.equal(200, res.statusCode); res.setEncoding('utf8'); res.on('data', function(chunk) { body1 += chunk; }); console.error('Got /world response'); })); }), 1); })); process.on('exit', function() { console.error('responses_sent: ' + responses_sent); assert.equal(2, responses_sent); assert.equal('The path was /hello', body0); assert.equal('The path was /world', body1); }); node-v4.8.2/test/parallel/test-http-localaddress-bind-error.js000644 000766 000024 00000001474 13070706737 024534 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var http = require('http'); var invalidLocalAddress = '1.2.3.4'; var server = http.createServer(function(req, res) { console.log('Connect from: ' + req.connection.remoteAddress); req.on('end', function() { res.writeHead(200, { 'Content-Type': 'text/plain' }); res.end('You are from: ' + req.connection.remoteAddress); }); req.resume(); }); server.listen(0, '127.0.0.1', common.mustCall(function() { http.request({ host: 'localhost', port: this.address().port, path: '/', method: 'GET', localAddress: invalidLocalAddress }, function(res) { common.fail('unexpectedly got response from server'); }).on('error', common.mustCall(function(e) { console.log('client got error: ' + e.message); server.close(); })).end(); })); node-v4.8.2/test/parallel/test-http-localaddress.js000644 000766 000024 00000001617 13070706737 022472 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const http = require('http'); const assert = require('assert'); if (!common.hasMultiLocalhost()) { common.skip('platform-specific test.'); return; } var server = http.createServer(function(req, res) { console.log('Connect from: ' + req.connection.remoteAddress); assert.equal('127.0.0.2', req.connection.remoteAddress); req.on('end', function() { res.writeHead(200, { 'Content-Type': 'text/plain' }); res.end('You are from: ' + req.connection.remoteAddress); }); req.resume(); }); server.listen(0, '127.0.0.1', function() { var options = { host: 'localhost', port: this.address().port, path: '/', method: 'GET', localAddress: '127.0.0.2' }; var req = http.request(options, function(res) { res.on('end', function() { server.close(); process.exit(); }); res.resume(); }); req.end(); }); node-v4.8.2/test/parallel/test-http-malformed-request.js000644 000766 000024 00000001562 13070706737 023465 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var net = require('net'); var http = require('http'); var url = require('url'); // Make sure no exceptions are thrown when receiving malformed HTTP // requests. var nrequests_completed = 0; var nrequests_expected = 1; var server = http.createServer(function(req, res) { console.log('req: ' + JSON.stringify(url.parse(req.url))); res.writeHead(200, {'Content-Type': 'text/plain'}); res.write('Hello World'); res.end(); if (++nrequests_completed === nrequests_expected) server.close(); }); server.listen(0); server.on('listening', function() { var c = net.createConnection(this.address().port); c.on('connect', function() { c.write('GET /hello?foo=%99bar HTTP/1.1\r\n\r\n'); c.end(); }); }); process.on('exit', function() { assert.equal(nrequests_expected, nrequests_completed); }); node-v4.8.2/test/parallel/test-http-many-ended-pipelines.js000644 000766 000024 00000001553 13070706737 024040 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); // no warnings should happen! var trace = console.trace; console.trace = function() { trace.apply(console, arguments); throw new Error('no tracing should happen here'); }; var http = require('http'); var net = require('net'); var numRequests = 20; var first = false; var server = http.createServer(function(req, res) { if (!first) { first = true; req.socket.on('close', function() { server.close(); }); } res.end('ok'); // Oh no! The connection died! req.socket.destroy(); }); server.listen(0, function() { var client = net.connect({ port: this.address().port, allowHalfOpen: true }); for (var i = 0; i < numRequests; i++) { client.write('GET / HTTP/1.1\r\n' + 'Host: some.host.name\r\n' + '\r\n\r\n'); } client.end(); client.pipe(process.stdout); }); node-v4.8.2/test/parallel/test-http-max-headers-count.js000644 000766 000024 00000003133 13070706737 023351 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var requests = 0; var responses = 0; var headers = {}; var N = 2000; for (var i = 0; i < N; ++i) { headers['key' + i] = i; } var maxAndExpected = [ // for server [50, 50], [1500, 1500], [0, N + 2] // Host and Connection ]; var max = maxAndExpected[requests][0]; var expected = maxAndExpected[requests][1]; var server = http.createServer(function(req, res) { assert.equal(Object.keys(req.headers).length, expected); if (++requests < maxAndExpected.length) { max = maxAndExpected[requests][0]; expected = maxAndExpected[requests][1]; server.maxHeadersCount = max; } res.writeHead(200, headers); res.end(); }); server.maxHeadersCount = max; server.listen(0, function() { var maxAndExpected = [ // for client [20, 20], [1200, 1200], [0, N + 3] // Connection, Date and Transfer-Encoding ]; doRequest(); function doRequest() { var max = maxAndExpected[responses][0]; var expected = maxAndExpected[responses][1]; var req = http.request({ port: server.address().port, headers: headers }, function(res) { assert.equal(Object.keys(res.headers).length, expected); res.on('end', function() { if (++responses < maxAndExpected.length) { doRequest(); } else { server.close(); } }); res.resume(); }); req.maxHeadersCount = max; req.end(); } }); process.on('exit', function() { assert.equal(requests, maxAndExpected.length); assert.equal(responses, maxAndExpected.length); }); node-v4.8.2/test/parallel/test-http-methods.js000644 000766 000024 00000000620 13070706737 021466 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var util = require('util'); assert(Array.isArray(http.METHODS)); assert(http.METHODS.length > 0); assert(http.METHODS.indexOf('GET') !== -1); assert(http.METHODS.indexOf('HEAD') !== -1); assert(http.METHODS.indexOf('POST') !== -1); assert.deepEqual(util._extend([], http.METHODS), http.METHODS.sort()); node-v4.8.2/test/parallel/test-http-multi-line-headers.js000644 000766 000024 00000001502 13070706737 023513 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var http = require('http'); var net = require('net'); var server = net.createServer(function(conn) { var body = 'Yet another node.js server.'; var response = 'HTTP/1.1 200 OK\r\n' + 'Connection: close\r\n' + 'Content-Length: ' + body.length + '\r\n' + 'Content-Type: text/plain;\r\n' + ' x-unix-mode=0600;\r\n' + ' name=\"hello.txt\"\r\n' + '\r\n' + body; conn.end(response); server.close(); }); server.listen(0, common.mustCall(function() { http.get({ host: '127.0.0.1', port: this.address().port }, common.mustCall(function(res) { assert.equal(res.headers['content-type'], 'text/plain; x-unix-mode=0600; name="hello.txt"'); res.destroy(); })); })); node-v4.8.2/test/parallel/test-http-mutable-headers.js000644 000766 000024 00000007215 13070706737 023074 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); // Simple test of Node's HTTP Client mutable headers // OutgoingMessage.prototype.setHeader(name, value) // OutgoingMessage.prototype.getHeader(name) // OutgoingMessage.prototype.removeHeader(name, value) // ServerResponse.prototype.statusCode // .method // .path var testsComplete = 0; var test = 'headers'; var content = 'hello world\n'; var cookies = [ 'session_token=; path=/; expires=Sun, 15-Sep-2030 13:48:52 GMT', 'prefers_open_id=; path=/; expires=Thu, 01-Jan-1970 00:00:00 GMT' ]; var s = http.createServer(function(req, res) { switch (test) { case 'headers': assert.throws(function() { res.setHeader(); }); assert.throws(function() { res.setHeader('someHeader'); }); assert.throws(function() { res.getHeader(); }); assert.throws(function() { res.removeHeader(); }); res.setHeader('x-test-header', 'testing'); res.setHeader('X-TEST-HEADER2', 'testing'); res.setHeader('set-cookie', cookies); res.setHeader('x-test-array-header', [1, 2, 3]); var val1 = res.getHeader('x-test-header'); var val2 = res.getHeader('x-test-header2'); assert.equal(val1, 'testing'); assert.equal(val2, 'testing'); res.removeHeader('x-test-header2'); break; case 'contentLength': res.setHeader('content-length', content.length); assert.equal(content.length, res.getHeader('Content-Length')); break; case 'transferEncoding': res.setHeader('transfer-encoding', 'chunked'); assert.equal(res.getHeader('Transfer-Encoding'), 'chunked'); break; case 'writeHead': res.statusCode = 404; res.setHeader('x-foo', 'keyboard cat'); res.writeHead(200, { 'x-foo': 'bar', 'x-bar': 'baz' }); break; } res.statusCode = 201; res.end(content); }); s.listen(0, nextTest); function nextTest() { if (test === 'end') { return s.close(); } var bufferedResponse = ''; http.get({ port: s.address().port }, function(response) { console.log('TEST: ' + test); console.log('STATUS: ' + response.statusCode); console.log('HEADERS: '); console.dir(response.headers); switch (test) { case 'headers': assert.equal(response.statusCode, 201); assert.equal(response.headers['x-test-header'], 'testing'); assert.equal(response.headers['x-test-array-header'], [1, 2, 3].join(', ')); assert.deepEqual(cookies, response.headers['set-cookie']); assert.equal(response.headers['x-test-header2'] !== undefined, false); // Make the next request test = 'contentLength'; console.log('foobar'); break; case 'contentLength': assert.equal(response.headers['content-length'], content.length); test = 'transferEncoding'; break; case 'transferEncoding': assert.equal(response.headers['transfer-encoding'], 'chunked'); test = 'writeHead'; break; case 'writeHead': assert.equal(response.headers['x-foo'], 'bar'); assert.equal(response.headers['x-bar'], 'baz'); assert.equal(200, response.statusCode); test = 'end'; break; default: throw new Error('?'); } response.setEncoding('utf8'); response.on('data', function(s) { bufferedResponse += s; }); response.on('end', function() { assert.equal(content, bufferedResponse); testsComplete++; nextTest(); }); }); } process.on('exit', function() { assert.equal(4, testsComplete); }); node-v4.8.2/test/parallel/test-http-no-content-length.js000644 000766 000024 00000001174 13070706737 023373 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var net = require('net'); var http = require('http'); var server = net.createServer(function(socket) { // Neither Content-Length nor Connection socket.end('HTTP/1.1 200 ok\r\n\r\nHello'); }).listen(0, common.mustCall(function() { http.get({port: this.address().port}, common.mustCall(function(res) { var body = ''; res.setEncoding('utf8'); res.on('data', function(chunk) { body += chunk; }); res.on('end', common.mustCall(function() { assert.strictEqual(body, 'Hello'); server.close(); })); })); })); node-v4.8.2/test/parallel/test-http-no-read-no-dump.js000644 000766 000024 00000002067 13070706737 022734 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const http = require('http'); let onPause = null; const server = http.createServer((req, res) => { if (req.method === 'GET') return res.end(); res.writeHead(200); res.flushHeaders(); req.connection.on('pause', () => { res.end(); onPause(); }); }).listen(0, common.mustCall(() => { const agent = new http.Agent({ maxSockets: 1, keepAlive: true }); const port = server.address().port; const post = http.request({ agent, method: 'POST', port, }, common.mustCall((res) => { res.resume(); post.write(Buffer.alloc(16 * 1024).fill('X')); onPause = () => { post.end('something'); }; })); /* What happens here is that the server `end`s the response before we send * `something`, and the client thought that this is a green light for sending * next GET request */ post.write('initial'); http.request({ agent, method: 'GET', port, }, common.mustCall((res) => { server.close(); res.connection.end(); })).end(); })); node-v4.8.2/test/parallel/test-http-outgoing-finish.js000644 000766 000024 00000002713 13070706737 023141 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); http.createServer(function(req, res) { req.resume(); req.on('end', function() { write(res); }); this.close(); }).listen(0, function() { var req = http.request({ port: this.address().port, method: 'PUT' }); write(req); req.on('response', function(res) { res.resume(); }); }); var buf = new Buffer(1024 * 16); buf.fill('x'); function write(out) { var name = out.constructor.name; var finishEvent = false; var endCb = false; // first, write until it gets some backpressure while (out.write(buf)) {} // now end, and make sure that we don't get the 'finish' event // before the tick where the cb gets called. We give it until // nextTick because this is added as a listener before the endcb // is registered. The order is not what we're testing here, just // that 'finish' isn't emitted until the stream is fully flushed. out.on('finish', function() { finishEvent = true; console.error('%s finish event', name); process.nextTick(function() { assert(endCb, name + ' got finish event before endcb!'); console.log('ok - %s finishEvent', name); }); }); out.end(buf, function() { endCb = true; console.error('%s endCb', name); process.nextTick(function() { assert(finishEvent, name + ' got endCb event before finishEvent!'); console.log('ok - %s endCb', name); }); }); } node-v4.8.2/test/parallel/test-http-parser-bad-ref.js000644 000766 000024 00000004015 13070706737 022617 0ustar00iojsstaff000000 000000 'use strict'; // Run this program with valgrind or efence with --expose_gc to expose the // problem. // Flags: --expose_gc require('../common'); var assert = require('assert'); var HTTPParser = process.binding('http_parser').HTTPParser; var kOnHeaders = HTTPParser.kOnHeaders | 0; var kOnHeadersComplete = HTTPParser.kOnHeadersComplete | 0; var kOnBody = HTTPParser.kOnBody | 0; var kOnMessageComplete = HTTPParser.kOnMessageComplete | 0; var headersComplete = 0; var messagesComplete = 0; function flushPool() { new Buffer(Buffer.poolSize - 1); gc(); } function demoBug(part1, part2) { flushPool(); var parser = new HTTPParser('REQUEST'); parser.headers = []; parser.url = ''; parser[kOnHeaders] = function(headers, url) { parser.headers = parser.headers.concat(headers); parser.url += url; }; parser[kOnHeadersComplete] = function(info) { headersComplete++; console.log('url', info.url); }; parser[kOnBody] = function(b, start, len) { }; parser[kOnMessageComplete] = function() { messagesComplete++; }; // We use a function to eliminate references to the Buffer b // We want b to be GCed. The parser will hold a bad reference to it. (function() { var b = Buffer(part1); flushPool(); console.log('parse the first part of the message'); parser.execute(b, 0, b.length); })(); flushPool(); (function() { var b = Buffer(part2); console.log('parse the second part of the message'); parser.execute(b, 0, b.length); parser.finish(); })(); flushPool(); } demoBug('POST /1', '/22 HTTP/1.1\r\n' + 'Content-Type: text/plain\r\n' + 'Content-Length: 4\r\n\r\n' + 'pong'); /* eslint-disable align-function-arguments */ demoBug('POST /1/22 HTTP/1.1\r\n' + 'Content-Type: tex', 't/plain\r\n' + 'Content-Length: 4\r\n\r\n' + 'pong'); /* eslint-enable align-function-arguments */ process.on('exit', function() { assert.equal(2, headersComplete); assert.equal(2, messagesComplete); console.log('done!'); }); node-v4.8.2/test/parallel/test-http-parser-free.js000644 000766 000024 00000001343 13070706737 022241 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var N = 100; var responses = 0; var server = http.createServer(function(req, res) { res.end('Hello'); }); server.listen(0, function() { http.globalAgent.maxSockets = 1; var parser; for (var i = 0; i < N; ++i) { (function makeRequest(i) { var req = http.get({port: server.address().port}, function(res) { if (!parser) { parser = req.parser; } else { assert.strictEqual(req.parser, parser); } if (++responses === N) { server.close(); } res.resume(); }); })(i); } }); process.on('exit', function() { assert.equal(responses, N); }); node-v4.8.2/test/parallel/test-http-parser.js000644 000766 000024 00000040003 13070706737 021316 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var HTTPParser = process.binding('http_parser').HTTPParser; var CRLF = '\r\n'; var REQUEST = HTTPParser.REQUEST; var RESPONSE = HTTPParser.RESPONSE; var methods = HTTPParser.methods; var kOnHeaders = HTTPParser.kOnHeaders | 0; var kOnHeadersComplete = HTTPParser.kOnHeadersComplete | 0; var kOnBody = HTTPParser.kOnBody | 0; var kOnMessageComplete = HTTPParser.kOnMessageComplete | 0; // The purpose of this test is not to check HTTP compliance but to test the // binding. Tests for pathological http messages should be submitted // upstream to https://github.com/joyent/http-parser for inclusion into // deps/http-parser/test.c function newParser(type) { var parser = new HTTPParser(type); parser.headers = []; parser.url = ''; parser[kOnHeaders] = function(headers, url) { parser.headers = parser.headers.concat(headers); parser.url += url; }; parser[kOnHeadersComplete] = function(info) { }; parser[kOnBody] = function(b, start, len) { assert.ok(false, 'Function should not be called.'); }; parser[kOnMessageComplete] = function() { }; return parser; } function mustCall(f, times) { var actual = 0; process.setMaxListeners(256); process.on('exit', function() { assert.equal(actual, times || 1); }); return function() { actual++; return f.apply(this, Array.prototype.slice.call(arguments)); }; } function expectBody(expected) { return mustCall(function(buf, start, len) { var body = '' + buf.slice(start, start + len); assert.equal(body, expected); }); } // // Simple request test. // (function() { var request = Buffer( 'GET /hello HTTP/1.1' + CRLF + CRLF); var onHeadersComplete = function(versionMajor, versionMinor, headers, method, url, statusCode, statusMessage, upgrade, shouldKeepAlive) { assert.equal(versionMajor, 1); assert.equal(versionMinor, 1); assert.equal(method, methods.indexOf('GET')); assert.equal(url || parser.url, '/hello'); }; var parser = newParser(REQUEST); parser[kOnHeadersComplete] = mustCall(onHeadersComplete); parser.execute(request, 0, request.length); // // Check that if we throw an error in the callbacks that error will be // thrown from parser.execute() // parser[kOnHeadersComplete] = function(info) { throw new Error('hello world'); }; parser.reinitialize(HTTPParser.REQUEST); assert.throws(function() { parser.execute(request, 0, request.length); }, Error, 'hello world'); })(); // // Simple response test. // (function() { var request = Buffer( 'HTTP/1.1 200 OK' + CRLF + 'Content-Type: text/plain' + CRLF + 'Content-Length: 4' + CRLF + CRLF + 'pong'); var onHeadersComplete = function(versionMajor, versionMinor, headers, method, url, statusCode, statusMessage, upgrade, shouldKeepAlive) { assert.equal(method, undefined); assert.equal(versionMajor, 1); assert.equal(versionMinor, 1); assert.equal(statusCode, 200); assert.equal(statusMessage, 'OK'); }; var onBody = function(buf, start, len) { var body = '' + buf.slice(start, start + len); assert.equal(body, 'pong'); }; var parser = newParser(RESPONSE); parser[kOnHeadersComplete] = mustCall(onHeadersComplete); parser[kOnBody] = mustCall(onBody); parser.execute(request, 0, request.length); })(); // // Response with no headers. // (function() { var request = Buffer( 'HTTP/1.0 200 Connection established' + CRLF + CRLF); var onHeadersComplete = function(versionMajor, versionMinor, headers, method, url, statusCode, statusMessage, upgrade, shouldKeepAlive) { assert.equal(versionMajor, 1); assert.equal(versionMinor, 0); assert.equal(method, undefined); assert.equal(statusCode, 200); assert.equal(statusMessage, 'Connection established'); assert.deepEqual(headers || parser.headers, []); }; var parser = newParser(RESPONSE); parser[kOnHeadersComplete] = mustCall(onHeadersComplete); parser.execute(request, 0, request.length); })(); // // Trailing headers. // (function() { var request = Buffer( 'POST /it HTTP/1.1' + CRLF + 'Transfer-Encoding: chunked' + CRLF + CRLF + '4' + CRLF + 'ping' + CRLF + '0' + CRLF + 'Vary: *' + CRLF + 'Content-Type: text/plain' + CRLF + CRLF); var seen_body = false; var onHeaders = function(headers, url) { assert.ok(seen_body); // trailers should come after the body assert.deepEqual(headers, ['Vary', '*', 'Content-Type', 'text/plain']); }; var onHeadersComplete = function(versionMajor, versionMinor, headers, method, url, statusCode, statusMessage, upgrade, shouldKeepAlive) { assert.equal(method, methods.indexOf('POST')); assert.equal(url || parser.url, '/it'); assert.equal(versionMajor, 1); assert.equal(versionMinor, 1); // expect to see trailing headers now parser[kOnHeaders] = mustCall(onHeaders); }; var onBody = function(buf, start, len) { var body = '' + buf.slice(start, start + len); assert.equal(body, 'ping'); seen_body = true; }; var parser = newParser(REQUEST); parser[kOnHeadersComplete] = mustCall(onHeadersComplete); parser[kOnBody] = mustCall(onBody); parser.execute(request, 0, request.length); })(); // // Test header ordering. // (function() { var request = Buffer( 'GET / HTTP/1.0' + CRLF + 'X-Filler: 1337' + CRLF + 'X-Filler: 42' + CRLF + 'X-Filler2: 42' + CRLF + CRLF); var onHeadersComplete = function(versionMajor, versionMinor, headers, method, url, statusCode, statusMessage, upgrade, shouldKeepAlive) { assert.equal(method, methods.indexOf('GET')); assert.equal(versionMajor, 1); assert.equal(versionMinor, 0); assert.deepEqual( headers || parser.headers, ['X-Filler', '1337', 'X-Filler', '42', 'X-Filler2', '42']); }; var parser = newParser(REQUEST); parser[kOnHeadersComplete] = mustCall(onHeadersComplete); parser.execute(request, 0, request.length); })(); // // Test large number of headers // (function() { // 256 X-Filler headers var lots_of_headers = 'X-Filler: 42' + CRLF; lots_of_headers = lots_of_headers.repeat(256); var request = Buffer( 'GET /foo/bar/baz?quux=42#1337 HTTP/1.0' + CRLF + lots_of_headers + CRLF); var onHeadersComplete = function(versionMajor, versionMinor, headers, method, url, statusCode, statusMessage, upgrade, shouldKeepAlive) { assert.equal(method, methods.indexOf('GET')); assert.equal(url || parser.url, '/foo/bar/baz?quux=42#1337'); assert.equal(versionMajor, 1); assert.equal(versionMinor, 0); headers = headers || parser.headers; assert.equal(headers.length, 2 * 256); // 256 key/value pairs for (var i = 0; i < headers.length; i += 2) { assert.equal(headers[i], 'X-Filler'); assert.equal(headers[i + 1], '42'); } }; var parser = newParser(REQUEST); parser[kOnHeadersComplete] = mustCall(onHeadersComplete); parser.execute(request, 0, request.length); })(); // // Test request body // (function() { var request = Buffer( 'POST /it HTTP/1.1' + CRLF + 'Content-Type: application/x-www-form-urlencoded' + CRLF + 'Content-Length: 15' + CRLF + CRLF + 'foo=42&bar=1337'); var onHeadersComplete = function(versionMajor, versionMinor, headers, method, url, statusCode, statusMessage, upgrade, shouldKeepAlive) { assert.equal(method, methods.indexOf('POST')); assert.equal(url || parser.url, '/it'); assert.equal(versionMajor, 1); assert.equal(versionMinor, 1); }; var onBody = function(buf, start, len) { var body = '' + buf.slice(start, start + len); assert.equal(body, 'foo=42&bar=1337'); }; var parser = newParser(REQUEST); parser[kOnHeadersComplete] = mustCall(onHeadersComplete); parser[kOnBody] = mustCall(onBody); parser.execute(request, 0, request.length); })(); // // Test chunked request body // (function() { var request = Buffer( 'POST /it HTTP/1.1' + CRLF + 'Content-Type: text/plain' + CRLF + 'Transfer-Encoding: chunked' + CRLF + CRLF + '3' + CRLF + '123' + CRLF + '6' + CRLF + '123456' + CRLF + 'A' + CRLF + '1234567890' + CRLF + '0' + CRLF); var onHeadersComplete = function(versionMajor, versionMinor, headers, method, url, statusCode, statusMessage, upgrade, shouldKeepAlive) { assert.equal(method, methods.indexOf('POST')); assert.equal(url || parser.url, '/it'); assert.equal(versionMajor, 1); assert.equal(versionMinor, 1); }; let body_part = 0; const body_parts = ['123', '123456', '1234567890']; var onBody = function(buf, start, len) { var body = '' + buf.slice(start, start + len); assert.equal(body, body_parts[body_part++]); }; var parser = newParser(REQUEST); parser[kOnHeadersComplete] = mustCall(onHeadersComplete); parser[kOnBody] = mustCall(onBody, body_parts.length); parser.execute(request, 0, request.length); })(); // // Test chunked request body spread over multiple buffers (packets) // (function() { var request = Buffer( 'POST /it HTTP/1.1' + CRLF + 'Content-Type: text/plain' + CRLF + 'Transfer-Encoding: chunked' + CRLF + CRLF + '3' + CRLF + '123' + CRLF + '6' + CRLF + '123456' + CRLF); var onHeadersComplete = function(versionMajor, versionMinor, headers, method, url, statusCode, statusMessage, upgrade, shouldKeepAlive) { assert.equal(method, methods.indexOf('POST')); assert.equal(url || parser.url, '/it'); assert.equal(versionMajor, 1); assert.equal(versionMinor, 1); }; let body_part = 0; const body_parts = ['123', '123456', '123456789', '123456789ABC', '123456789ABCDEF']; var onBody = function(buf, start, len) { var body = '' + buf.slice(start, start + len); assert.equal(body, body_parts[body_part++]); }; var parser = newParser(REQUEST); parser[kOnHeadersComplete] = mustCall(onHeadersComplete); parser[kOnBody] = mustCall(onBody, body_parts.length); parser.execute(request, 0, request.length); request = Buffer( '9' + CRLF + '123456789' + CRLF + 'C' + CRLF + '123456789ABC' + CRLF + 'F' + CRLF + '123456789ABCDEF' + CRLF + '0' + CRLF); parser.execute(request, 0, request.length); })(); // // Stress test. // (function() { var request = Buffer( 'POST /helpme HTTP/1.1' + CRLF + 'Content-Type: text/plain' + CRLF + 'Transfer-Encoding: chunked' + CRLF + CRLF + '3' + CRLF + '123' + CRLF + '6' + CRLF + '123456' + CRLF + '9' + CRLF + '123456789' + CRLF + 'C' + CRLF + '123456789ABC' + CRLF + 'F' + CRLF + '123456789ABCDEF' + CRLF + '0' + CRLF); function test(a, b) { var onHeadersComplete = function(versionMajor, versionMinor, headers, method, url, statusCode, statusMessage, upgrade, shouldKeepAlive) { assert.equal(method, methods.indexOf('POST')); assert.equal(url || parser.url, '/helpme'); assert.equal(versionMajor, 1); assert.equal(versionMinor, 1); }; var expected_body = '123123456123456789123456789ABC123456789ABCDEF'; var onBody = function(buf, start, len) { var chunk = '' + buf.slice(start, start + len); assert.equal(expected_body.indexOf(chunk), 0); expected_body = expected_body.slice(chunk.length); }; var parser = newParser(REQUEST); parser[kOnHeadersComplete] = mustCall(onHeadersComplete); parser[kOnBody] = onBody; parser.execute(a, 0, a.length); parser.execute(b, 0, b.length); assert.equal(expected_body, ''); } for (var i = 1; i < request.length - 1; ++i) { var a = request.slice(0, i); console.error('request.slice(0, ' + i + ') = ', JSON.stringify(a.toString())); var b = request.slice(i); console.error('request.slice(' + i + ') = ', JSON.stringify(b.toString())); test(a, b); } })(); // // Byte by byte test. // (function() { var request = Buffer( 'POST /it HTTP/1.1' + CRLF + 'Content-Type: text/plain' + CRLF + 'Transfer-Encoding: chunked' + CRLF + CRLF + '3' + CRLF + '123' + CRLF + '6' + CRLF + '123456' + CRLF + '9' + CRLF + '123456789' + CRLF + 'C' + CRLF + '123456789ABC' + CRLF + 'F' + CRLF + '123456789ABCDEF' + CRLF + '0' + CRLF); var onHeadersComplete = function(versionMajor, versionMinor, headers, method, url, statusCode, statusMessage, upgrade, shouldKeepAlive) { assert.equal(method, methods.indexOf('POST')); assert.equal(url || parser.url, '/it'); assert.equal(versionMajor, 1); assert.equal(versionMinor, 1); assert.deepEqual( headers || parser.headers, ['Content-Type', 'text/plain', 'Transfer-Encoding', 'chunked']); }; var expected_body = '123123456123456789123456789ABC123456789ABCDEF'; var onBody = function(buf, start, len) { var chunk = '' + buf.slice(start, start + len); assert.equal(expected_body.indexOf(chunk), 0); expected_body = expected_body.slice(chunk.length); }; var parser = newParser(REQUEST); parser[kOnHeadersComplete] = mustCall(onHeadersComplete); parser[kOnBody] = onBody; for (var i = 0; i < request.length; ++i) { parser.execute(request, i, 1); } assert.equal(expected_body, ''); })(); // // Test parser reinit sequence. // (function() { var req1 = Buffer( 'PUT /this HTTP/1.1' + CRLF + 'Content-Type: text/plain' + CRLF + 'Transfer-Encoding: chunked' + CRLF + CRLF + '4' + CRLF + 'ping' + CRLF + '0' + CRLF); var req2 = Buffer( 'POST /that HTTP/1.0' + CRLF + 'Content-Type: text/plain' + CRLF + 'Content-Length: 4' + CRLF + CRLF + 'pong'); var onHeadersComplete1 = function(versionMajor, versionMinor, headers, method, url, statusCode, statusMessage, upgrade, shouldKeepAlive) { assert.equal(method, methods.indexOf('PUT')); assert.equal(url, '/this'); assert.equal(versionMajor, 1); assert.equal(versionMinor, 1); assert.deepEqual( headers, ['Content-Type', 'text/plain', 'Transfer-Encoding', 'chunked']); }; var onHeadersComplete2 = function(versionMajor, versionMinor, headers, method, url, statusCode, statusMessage, upgrade, shouldKeepAlive) { assert.equal(method, methods.indexOf('POST')); assert.equal(url, '/that'); assert.equal(versionMajor, 1); assert.equal(versionMinor, 0); assert.deepEqual(headers, ['Content-Type', 'text/plain', 'Content-Length', '4']); }; var parser = newParser(REQUEST); parser[kOnHeadersComplete] = onHeadersComplete1; parser[kOnBody] = expectBody('ping'); parser.execute(req1, 0, req1.length); parser.reinitialize(REQUEST); parser[kOnBody] = expectBody('pong'); parser[kOnHeadersComplete] = onHeadersComplete2; parser.execute(req2, 0, req2.length); })(); // Test parser 'this' safety // https://github.com/joyent/node/issues/6690 assert.throws(function() { var request = Buffer( 'GET /hello HTTP/1.1' + CRLF + CRLF); var parser = newParser(REQUEST); var notparser = { execute: parser.execute }; notparser.execute(request, 0, request.length); }, TypeError); node-v4.8.2/test/parallel/test-http-pause-resume-one-end.js000644 000766 000024 00000001156 13070706737 023766 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var http = require('http'); var server = http.Server(function(req, res) { res.writeHead(200, {'Content-Type': 'text/plain'}); res.end('Hello World\n'); server.close(); }); server.listen(0, common.mustCall(function() { var opts = { port: this.address().port, headers: { connection: 'close' } }; http.get(opts, common.mustCall(function(res) { res.on('data', common.mustCall(function(chunk) { res.pause(); setTimeout(function() { res.resume(); }); })); res.on('end', common.mustCall(function() {})); })); })); node-v4.8.2/test/parallel/test-http-pause.js000644 000766 000024 00000002507 13070706737 021146 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var expectedServer = 'Request Body from Client'; var resultServer = ''; var expectedClient = 'Response Body from Server'; var resultClient = ''; var server = http.createServer(function(req, res) { console.error('pause server request'); req.pause(); setTimeout(function() { console.error('resume server request'); req.resume(); req.setEncoding('utf8'); req.on('data', function(chunk) { resultServer += chunk; }); req.on('end', function() { console.error(resultServer); res.writeHead(200); res.end(expectedClient); }); }, 100); }); server.listen(0, function() { var req = http.request({ port: this.address().port, path: '/', method: 'POST' }, function(res) { console.error('pause client response'); res.pause(); setTimeout(function() { console.error('resume client response'); res.resume(); res.on('data', function(chunk) { resultClient += chunk; }); res.on('end', function() { console.error(resultClient); server.close(); }); }, 100); }); req.end(expectedServer); }); process.on('exit', function() { assert.equal(expectedServer, resultServer); assert.equal(expectedClient, resultClient); }); node-v4.8.2/test/parallel/test-http-pipe-fs.js000644 000766 000024 00000002031 13070706737 021364 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var http = require('http'); var fs = require('fs'); var path = require('path'); common.refreshTmpDir(); var file = path.join(common.tmpDir, 'http-pipe-fs-test.txt'); var server = http.createServer(common.mustCall(function(req, res) { var stream = fs.createWriteStream(file); req.pipe(stream); stream.on('close', function() { res.writeHead(200); res.end(); }); }, 2)).listen(0, function() { http.globalAgent.maxSockets = 1; for (var i = 0; i < 2; ++i) { (function(i) { var req = http.request({ port: server.address().port, method: 'POST', headers: { 'Content-Length': 5 } }, function(res) { res.on('end', function() { console.error('res' + i + ' end'); if (i === 2) { server.close(); } }); res.resume(); }); req.on('socket', function(s) { console.error('req' + i + ' start'); }); req.end('12345'); }(i + 1)); } }); node-v4.8.2/test/parallel/test-http-pipeline-flood.js000644 000766 000024 00000005026 13070706737 022736 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); // Here we are testing the HTTP server module's flood prevention mechanism. // When writeable.write returns false (ie the underlying send() indicated the // native buffer is full), the HTTP server cork()s the readable part of the // stream. This means that new requests will not be read (however request which // have already been read, but are awaiting processing will still be // processed). // Normally when the writable stream emits a 'drain' event, the server then // uncorks the readable stream, although we arent testing that part here. // The issue being tested exists in Node.js 0.10.20 and is resolved in 0.10.21 // and newer. switch (process.argv[2]) { case undefined: return parent(); case 'child': return child(); default: throw new Error(`Unexpected value: ${process.argv[2]}`); } function parent() { const http = require('http'); const bigResponse = Buffer.alloc(10240, 'x'); var backloggedReqs = 0; const server = http.createServer(function(req, res) { res.setHeader('content-length', bigResponse.length); if (!res.write(bigResponse)) { if (backloggedReqs === 0) { // Once the native buffer fills (ie write() returns false), the flood // prevention should kick in. // This means the stream should emit no more 'data' events. However we // may still be asked to process more requests if they were read before // the flood-prevention mechanism activated. setImmediate(() => { req.socket.on('data', () => common.fail('Unexpected data received')); }); } backloggedReqs++; } res.end(); }); server.on('connection', common.mustCall(function(conn) {})); server.listen(0, function() { const spawn = require('child_process').spawn; const args = [__filename, 'child', this.address().port]; const child = spawn(process.execPath, args, { stdio: 'inherit' }); child.on('close', common.mustCall(function() { server.close(); })); server.setTimeout(200, common.mustCall(function() { child.kill(); })); }); } function child() { const net = require('net'); const port = +process.argv[3]; const conn = net.connect({ port: port }); var req = `GET / HTTP/1.1\r\nHost: localhost:${port}\r\nAccept: */*\r\n\r\n`; req = new Array(10241).join(req); conn.on('connect', write); // `drain` should fire once and only once conn.on('drain', common.mustCall(write)); function write() { while (false !== conn.write(req, 'ascii')); } } node-v4.8.2/test/parallel/test-http-pipeline-regr-2639.js000644 000766 000024 00000001242 13070706737 023167 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const http = require('http'); const net = require('net'); const COUNT = 10; var received = 0; var server = http.createServer(function(req, res) { // Close the server, we have only one TCP connection anyway if (received++ === 0) server.close(); res.writeHead(200); res.write('data'); setTimeout(function() { res.end(); }, (Math.random() * 100) | 0); }).listen(0, function() { const s = net.connect(this.address().port); var big = 'GET / HTTP/1.0\r\n\r\n'.repeat(COUNT); s.write(big); s.resume(); }); process.on('exit', function() { assert.equal(received, COUNT); }); node-v4.8.2/test/parallel/test-http-pipeline-regr-3332.js000644 000766 000024 00000001735 13070706737 023165 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const http = require('http'); const net = require('net'); const big = new Buffer(16 * 1024); big.fill('A'); const COUNT = 1e4; var received = 0; var client; const server = http.createServer(function(req, res) { res.end(big, function() { if (++received === COUNT) { server.close(); client.end(); } }); }).listen(0, function() { var req = new Array(COUNT + 1).join('GET / HTTP/1.1\r\n\r\n'); client = net.connect(this.address().port, function() { client.write(req); }); // Just let the test terminate instead of hanging client.on('close', function() { if (received !== COUNT) server.close(); }); client.resume(); }); process.on('exit', function() { // The server should pause connection on pipeline flood, but it shoul still // resume it and finish processing the requests, when its output queue will // be empty again. assert.equal(received, COUNT); }); node-v4.8.2/test/parallel/test-http-pipeline-regr-3508.js000644 000766 000024 00000002040 13070706737 023160 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const http = require('http'); const net = require('net'); var once = false; var first = null; var second = null; const chunk = new Buffer(1024); chunk.fill('X'); var size = 0; var more; var done; var server = http.createServer(function(req, res) { if (!once) server.close(); once = true; if (first === null) { first = res; return; } if (second === null) { second = res; res.write(chunk); } else { res.end(chunk); } size += res.outputSize; if (size <= req.socket._writableState.highWaterMark) { more(); return; } done(); }).on('upgrade', function(req, socket) { second.end(chunk, function() { socket.end(); }); first.end('hello'); }).listen(0, function() { var s = net.connect(this.address().port); more = function() { s.write('GET / HTTP/1.1\r\n\r\n'); }; done = function() { s.write('GET / HTTP/1.1\r\n\r\n' + 'GET / HTTP/1.1\r\nConnection: upgrade\r\nUpgrade: ws\r\n\r\naaa'); }; more(); more(); s.resume(); }); node-v4.8.2/test/parallel/test-http-proxy.js000644 000766 000024 00000004204 13070706737 021206 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var url = require('url'); var cookies = [ 'session_token=; path=/; expires=Sun, 15-Sep-2030 13:48:52 GMT', 'prefers_open_id=; path=/; expires=Thu, 01-Jan-1970 00:00:00 GMT' ]; var headers = {'content-type': 'text/plain', 'set-cookie': cookies, 'hello': 'world' }; var backend = http.createServer(function(req, res) { console.error('backend request'); res.writeHead(200, headers); res.write('hello world\n'); res.end(); }); var proxy = http.createServer(function(req, res) { console.error('proxy req headers: ' + JSON.stringify(req.headers)); http.get({ port: backend.address().port, path: url.parse(req.url).pathname }, function(proxy_res) { console.error('proxy res headers: ' + JSON.stringify(proxy_res.headers)); assert.equal('world', proxy_res.headers['hello']); assert.equal('text/plain', proxy_res.headers['content-type']); assert.deepEqual(cookies, proxy_res.headers['set-cookie']); res.writeHead(proxy_res.statusCode, proxy_res.headers); proxy_res.on('data', function(chunk) { res.write(chunk); }); proxy_res.on('end', function() { res.end(); console.error('proxy res'); }); }); }); var body = ''; var nlistening = 0; function startReq() { nlistening++; if (nlistening < 2) return; http.get({ port: proxy.address().port, path: '/test' }, function(res) { console.error('got res'); assert.equal(200, res.statusCode); assert.equal('world', res.headers['hello']); assert.equal('text/plain', res.headers['content-type']); assert.deepEqual(cookies, res.headers['set-cookie']); res.setEncoding('utf8'); res.on('data', function(chunk) { body += chunk; }); res.on('end', function() { proxy.close(); backend.close(); console.error('closed both'); }); }); console.error('client req'); } console.error('listen proxy'); proxy.listen(0, startReq); console.error('listen backend'); backend.listen(0, startReq); process.on('exit', function() { assert.equal(body, 'hello world\n'); }); node-v4.8.2/test/parallel/test-http-raw-headers.js000644 000766 000024 00000004655 13070706737 022241 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); http.createServer(function(req, res) { var expectRawHeaders = [ 'Host', `localhost:${this.address().port}`, 'transfer-ENCODING', 'CHUNKED', 'x-BaR', 'yoyoyo', 'Connection', 'close' ]; var expectHeaders = { host: `localhost:${this.address().port}`, 'transfer-encoding': 'CHUNKED', 'x-bar': 'yoyoyo', connection: 'close' }; var expectRawTrailers = [ 'x-bAr', 'yOyOyOy', 'x-baR', 'OyOyOyO', 'X-bAr', 'yOyOyOy', 'X-baR', 'OyOyOyO' ]; var expectTrailers = { 'x-bar': 'yOyOyOy, OyOyOyO, yOyOyOy, OyOyOyO' }; this.close(); assert.deepEqual(req.rawHeaders, expectRawHeaders); assert.deepEqual(req.headers, expectHeaders); req.on('end', function() { assert.deepEqual(req.rawTrailers, expectRawTrailers); assert.deepEqual(req.trailers, expectTrailers); }); req.resume(); res.setHeader('Trailer', 'x-foo'); res.addTrailers([ ['x-fOo', 'xOxOxOx'], ['x-foO', 'OxOxOxO'], ['X-fOo', 'xOxOxOx'], ['X-foO', 'OxOxOxO'] ]); res.end('x f o o'); }).listen(0, function() { var req = http.request({ port: this.address().port, path: '/' }); req.addTrailers([ ['x-bAr', 'yOyOyOy'], ['x-baR', 'OyOyOyO'], ['X-bAr', 'yOyOyOy'], ['X-baR', 'OyOyOyO'] ]); req.setHeader('transfer-ENCODING', 'CHUNKED'); req.setHeader('x-BaR', 'yoyoyo'); req.end('y b a r'); req.on('response', function(res) { var expectRawHeaders = [ 'Trailer', 'x-foo', 'Date', null, 'Connection', 'close', 'Transfer-Encoding', 'chunked' ]; var expectHeaders = { trailer: 'x-foo', date: null, connection: 'close', 'transfer-encoding': 'chunked' }; res.rawHeaders[3] = null; res.headers.date = null; assert.deepEqual(res.rawHeaders, expectRawHeaders); assert.deepEqual(res.headers, expectHeaders); res.on('end', function() { var expectRawTrailers = [ 'x-fOo', 'xOxOxOx', 'x-foO', 'OxOxOxO', 'X-fOo', 'xOxOxOx', 'X-foO', 'OxOxOxO' ]; var expectTrailers = { 'x-foo': 'xOxOxOx, OxOxOxO, xOxOxOx, OxOxOxO' }; assert.deepEqual(res.rawTrailers, expectRawTrailers); assert.deepEqual(res.trailers, expectTrailers); console.log('ok'); }); res.resume(); }); }); node-v4.8.2/test/parallel/test-http-regr-gh-2821.js000644 000766 000024 00000000613 13070706737 021752 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const http = require('http'); const server = http.createServer(function(req, res) { res.writeHead(200); res.end(); server.close(); }); server.listen(0, function() { const req = http.request({ method: 'POST', port: this.address().port }); const payload = new Buffer(16390); payload.fill('Й'); req.write(payload); req.end(); }); node-v4.8.2/test/parallel/test-http-remove-header-stays-removed.js000644 000766 000024 00000001757 13070706737 025362 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var server = http.createServer(function(request, response) { // removed headers should stay removed, even if node automatically adds them // to the output: response.removeHeader('connection'); response.removeHeader('transfer-encoding'); response.removeHeader('content-length'); // make sure that removing and then setting still works: response.removeHeader('date'); response.setHeader('date', 'coffee o clock'); response.end('beep boop\n'); this.close(); }); var response = ''; process.on('exit', function() { assert.equal('beep boop\n', response); console.log('ok'); }); server.listen(0, function() { http.get({ port: this.address().port }, function(res) { assert.equal(200, res.statusCode); assert.deepStrictEqual(res.headers, { date: 'coffee o clock' }); res.setEncoding('ascii'); res.on('data', function(chunk) { response += chunk; }); }); }); node-v4.8.2/test/parallel/test-http-request-dont-override-options.js000644 000766 000024 00000002176 13070706737 025773 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const http = require('http'); var requests = 0; http.createServer(function(req, res) { res.writeHead(200); res.end('ok'); requests++; }).listen(0, function() { var agent = new http.Agent(); agent.defaultPort = this.address().port; // options marked as explicitly undefined for readability // in this test, they should STAY undefined as options should not // be mutable / modified var options = { host: undefined, hostname: common.localhostIPv4, port: undefined, defaultPort: undefined, path: undefined, method: undefined, agent: agent }; http.request(options, function(res) { res.resume(); }).end(); process.on('exit', function() { assert.equal(requests, 1); assert.strictEqual(options.host, undefined); assert.strictEqual(options.hostname, common.localhostIPv4); assert.strictEqual(options.port, undefined); assert.strictEqual(options.defaultPort, undefined); assert.strictEqual(options.path, undefined); assert.strictEqual(options.method, undefined); }); }).unref(); node-v4.8.2/test/parallel/test-http-request-end-twice.js000644 000766 000024 00000000674 13070706737 023401 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var server = http.Server(function(req, res) { res.writeHead(200, {'Content-Type': 'text/plain'}); res.end('hello world\n'); }); server.listen(0, function() { var req = http.get({port: this.address().port}, function(res) { res.on('end', function() { assert.ok(!req.end()); server.close(); }); res.resume(); }); }); node-v4.8.2/test/parallel/test-http-request-end.js000644 000766 000024 00000001340 13070706737 022257 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var expected = 'Post Body For Test'; var server = http.Server(function(req, res) { var result = ''; req.setEncoding('utf8'); req.on('data', function(chunk) { result += chunk; }); req.on('end', function() { assert.strictEqual(expected, result); server.close(); res.writeHead(200); res.end('hello world\n'); }); }); server.listen(0, function() { http.request({ port: this.address().port, path: '/', method: 'POST' }, function(res) { console.log(res.statusCode); res.resume(); }).on('error', function(e) { console.log(e.message); process.exit(1); }).end(expected); }); node-v4.8.2/test/parallel/test-http-request-methods.js000644 000766 000024 00000002167 13070706737 023164 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var net = require('net'); var http = require('http'); // Test that the DELETE, PATCH and PURGE verbs get passed through correctly ['DELETE', 'PATCH', 'PURGE'].forEach(function(method, index) { var server = http.createServer(common.mustCall(function(req, res) { assert.strictEqual(req.method, method); res.writeHead(200, {'Content-Type': 'text/plain'}); res.write('hello '); res.write('world\n'); res.end(); })); server.listen(0); server.on('listening', common.mustCall(function() { var c = net.createConnection(this.address().port); var server_response = ''; c.setEncoding('utf8'); c.on('connect', function() { c.write(method + ' / HTTP/1.0\r\n\r\n'); }); c.on('data', function(chunk) { console.log(chunk); server_response += chunk; }); c.on('end', common.mustCall(function() { const m = server_response.split('\r\n\r\n'); assert.strictEqual(m[1], 'hello world\n'); c.end(); })); c.on('close', function() { server.close(); }); })); }); node-v4.8.2/test/parallel/test-http-res-write-after-end.js000644 000766 000024 00000001111 13070706737 023603 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var http = require('http'); var server = http.Server(common.mustCall(function(req, res) { res.on('error', common.mustCall(function onResError(err) { assert.strictEqual(err.message, 'write after end'); })); res.write('This should write.'); res.end(); var r = res.write('This should raise an error.'); assert.equal(r, true, 'write after end should return true'); })); server.listen(0, function() { http.get({port: this.address().port}, function(res) { server.close(); }); }); node-v4.8.2/test/parallel/test-http-res-write-end-dont-take-array.js000644 000766 000024 00000002343 13070706737 025514 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var test = 1; var server = http.createServer(function(req, res) { res.writeHead(200, {'Content-Type': 'text/plain'}); if (test === 1) { // write should accept string res.write('string'); // write should accept buffer res.write(new Buffer('asdf')); // write should not accept an Array assert.throws(function() { res.write(['array']); }, TypeError, 'first argument must be a string or Buffer'); // end should not accept an Array assert.throws(function() { res.end(['moo']); }, TypeError, 'first argument must be a string or Buffer'); // end should accept string res.end('string'); } else if (test === 2) { // end should accept Buffer res.end(new Buffer('asdf')); } }); server.listen(0, function() { // just make a request, other tests handle responses http.get({port: this.address().port}, function(res) { res.resume(); // lazy serial test, because we can only call end once per request test += 1; // do it again to test .end(Buffer); http.get({port: server.address().port}, function(res) { res.resume(); server.close(); }); }); }); node-v4.8.2/test/parallel/test-http-response-add-header-after-sent.js000644 000766 000024 00000000724 13070706737 025710 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const http = require('http'); const server = http.createServer((req, res) => { assert.doesNotThrow(() => { res.setHeader('header1', 1); }); res.write('abc'); assert.throws(() => { res.setHeader('header2', 2); }, /Can't set headers after they are sent\./); res.end(); }); server.listen(0, () => { http.get({port: server.address().port}, () => { server.close(); }); }); node-v4.8.2/test/parallel/test-http-response-close.js000644 000766 000024 00000001262 13070706737 022767 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var http = require('http'); var server = http.createServer(common.mustCall(function(req, res) { res.writeHead(200); res.write('a'); req.on('close', common.mustCall(function() { console.error('request aborted'); })); res.on('close', common.mustCall(function() { console.error('response aborted'); })); })); server.listen(0); server.on('listening', function() { console.error('make req'); http.get({ port: this.address().port }, function(res) { console.error('got res'); res.on('data', function(data) { console.error('destroy res'); res.destroy(); server.close(); }); }); }); node-v4.8.2/test/parallel/test-http-response-multi-content-length.js000644 000766 000024 00000002712 13070706737 025744 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const http = require('http'); const assert = require('assert'); const MAX_COUNT = 2; const server = http.createServer((req, res) => { const num = req.headers['x-num']; // TODO(@jasnell) At some point this should be refactored as the API // should not be allowing users to set multiple content-length values // in the first place. switch (num) { case '1': res.setHeader('content-length', [2, 1]); break; case '2': res.writeHead(200, {'content-length': [1, 2]}); break; default: common.fail('should never get here'); } res.end('ok'); }); var count = 0; server.listen(0, common.mustCall(() => { for (let n = 1; n <= MAX_COUNT ; n++) { // This runs twice, the first time, the server will use // setHeader, the second time it uses writeHead. In either // case, the error handler must be called because the client // is not allowed to accept multiple content-length headers. http.get( {port: server.address().port, headers: {'x-num': n}}, (res) => { assert(false, 'client allowed multiple content-length headers.'); } ).on('error', common.mustCall((err) => { assert(/^Parse Error/.test(err.message)); assert.equal(err.code, 'HPE_UNEXPECTED_CONTENT_LENGTH'); count++; if (count === MAX_COUNT) server.close(); })); } })); process.on('exit', () => { assert.equal(count, MAX_COUNT); }); node-v4.8.2/test/parallel/test-http-response-no-headers.js000644 000766 000024 00000002103 13070706737 023702 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var http = require('http'); var net = require('net'); var expected = { '0.9': 'I AM THE WALRUS', '1.0': 'I AM THE WALRUS', '1.1': '' }; function test(httpVersion, callback) { var server = net.createServer(function(conn) { var reply = 'HTTP/' + httpVersion + ' 200 OK\r\n\r\n' + expected[httpVersion]; conn.end(reply); }); server.listen(0, '127.0.0.1', common.mustCall(function() { var options = { host: '127.0.0.1', port: this.address().port }; var req = http.get(options, common.mustCall(function(res) { var body = ''; res.on('data', function(data) { body += data; }); res.on('end', common.mustCall(function() { assert.equal(body, expected[httpVersion]); server.close(); if (callback) process.nextTick(callback); })); })); req.on('error', function(err) { throw err; }); })); } test('0.9', function() { test('1.0', function() { test('1.1'); }); }); node-v4.8.2/test/parallel/test-http-response-readable.js000644 000766 000024 00000001033 13070706737 023415 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var testServer = new http.Server(function(req, res) { res.writeHead(200); res.end('Hello world'); }); testServer.listen(0, function() { http.get({ port: this.address().port }, function(res) { assert.equal(res.readable, true, 'res.readable initially true'); res.on('end', function() { assert.equal(res.readable, false, 'res.readable set to false after end'); testServer.close(); }); res.resume(); }); }); node-v4.8.2/test/parallel/test-http-response-remove-header-after-sent.js000644 000766 000024 00000000733 13070706737 026455 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const http = require('http'); const server = http.createServer((req, res) => { assert.doesNotThrow(() => { res.removeHeader('header1', 1); }); res.write('abc'); assert.throws(() => { res.removeHeader('header2', 2); }, /Can't remove headers after they are sent/); res.end(); }); server.listen(0, () => { http.get({port: server.address().port}, () => { server.close(); }); }); node-v4.8.2/test/parallel/test-http-response-splitting.js000644 000766 000024 00000003252 13070706737 023700 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const http = require('http'); const net = require('net'); const url = require('url'); const assert = require('assert'); // Response splitting example, credit: Amit Klein, Safebreach const str = '/welcome?lang=bar%c4%8d%c4%8aContent­Length:%200%c4%8d%c4%8a%c' + '4%8d%c4%8aHTTP/1.1%20200%20OK%c4%8d%c4%8aContent­Length:%202' + '0%c4%8d%c4%8aLast­Modified:%20Mon,%2027%20Oct%202003%2014:50:18' + '%20GMT%c4%8d%c4%8aContent­Type:%20text/html%c4%8d%c4%8a%c4%8' + 'd%c4%8a%3chtml%3eGotcha!%3c/html%3e'; // Response splitting example, credit: Сковорода Никита Андреевич (@ChALkeR) const x = 'fooഊSet-Cookie: foo=barഊഊ'; const y = 'foo⠊Set-Cookie: foo=bar'; var count = 0; function test(res, code, header) { assert.throws(() => { res.writeHead(code, header); }, /^TypeError: The header content contains invalid characters$/); } const server = http.createServer((req, res) => { switch (count++) { case 0: const loc = url.parse(req.url, true).query.lang; test(res, 302, {Location: `/foo?lang=${loc}`}); break; case 1: test(res, 200, {'foo': x}); break; case 2: test(res, 200, {'foo': y}); break; default: common.fail('should not get to here.'); } if (count === 3) server.close(); res.end('ok'); }); server.listen(0, () => { const end = 'HTTP/1.1\r\n\r\n'; const client = net.connect({port: server.address().port}, () => { client.write(`GET ${str} ${end}`); client.write(`GET / ${end}`); client.write(`GET / ${end}`); client.end(); }); }); node-v4.8.2/test/parallel/test-http-response-status-message.js000644 000766 000024 00000003635 13070706737 024635 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var net = require('net'); var testsComplete = 0; var testCases = [ { path: '/200', statusMessage: 'OK', response: 'HTTP/1.1 200 OK\r\n\r\n' }, { path: '/500', statusMessage: 'Internal Server Error', response: 'HTTP/1.1 500 Internal Server Error\r\n\r\n' }, { path: '/302', statusMessage: 'Moved Temporarily', response: 'HTTP/1.1 302 Moved Temporarily\r\n\r\n' }, { path: '/missing', statusMessage: '', response: 'HTTP/1.1 200 \r\n\r\n' }, { path: '/missing-no-space', statusMessage: '', response: 'HTTP/1.1 200\r\n\r\n' } ]; testCases.findByPath = function(path) { var matching = this.filter(function(testCase) { return testCase.path === path; }); if (matching.length === 0) { throw 'failed to find test case with path ' + path; } return matching[0]; }; var server = net.createServer(function(connection) { connection.on('data', function(data) { var path = data.toString().match(/GET (.*) HTTP.1.1/)[1]; var testCase = testCases.findByPath(path); connection.write(testCase.response); connection.end(); }); }); var runTest = function(testCaseIndex) { var testCase = testCases[testCaseIndex]; http.get({ port: server.address().port, path: testCase.path }, function(response) { console.log('client: expected status message: ' + testCase.statusMessage); console.log('client: actual status message: ' + response.statusMessage); assert.equal(testCase.statusMessage, response.statusMessage); response.on('end', function() { testsComplete++; if (testCaseIndex + 1 < testCases.length) { runTest(testCaseIndex + 1); } else { server.close(); } }); response.resume(); }); }; server.listen(0, function() { runTest(0); }); process.on('exit', function() { assert.equal(testCases.length, testsComplete); }); node-v4.8.2/test/parallel/test-http-response-statuscode.js000644 000766 000024 00000004413 13070706737 024041 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const http = require('http'); const MAX_REQUESTS = 12; var reqNum = 0; const server = http.Server(common.mustCall(function(req, res) { switch (reqNum) { case 0: assert.throws(common.mustCall(() => { res.writeHead(-1); }, /invalid status code/i)); break; case 1: assert.throws(common.mustCall(() => { res.writeHead(Infinity); }, /invalid status code/i)); break; case 2: assert.throws(common.mustCall(() => { res.writeHead(NaN); }, /invalid status code/i)); break; case 3: assert.throws(common.mustCall(() => { res.writeHead({}); }, /invalid status code/i)); break; case 4: assert.throws(common.mustCall(() => { res.writeHead(99); }, /invalid status code/i)); break; case 5: assert.throws(common.mustCall(() => { res.writeHead(1000); }, /invalid status code/i)); break; case 6: assert.throws(common.mustCall(() => { res.writeHead('1000'); }, /invalid status code/i)); break; case 7: assert.throws(common.mustCall(() => { res.writeHead(null); }, /invalid status code/i)); break; case 8: assert.throws(common.mustCall(() => { res.writeHead(true); }, /invalid status code/i)); break; case 9: assert.throws(common.mustCall(() => { res.writeHead([]); }, /invalid status code/i)); break; case 10: assert.throws(common.mustCall(() => { res.writeHead('this is not valid'); }, /invalid status code/i)); break; case 11: assert.throws(common.mustCall(() => { res.writeHead('404 this is not valid either'); }, /invalid status code/i)); this.close(); break; default: throw new Error('Unexpected request'); } res.statusCode = 200; res.end(); }, MAX_REQUESTS)); server.listen(); server.on('listening', function makeRequest() { http.get({ port: this.address().port }, (res) => { assert.strictEqual(res.statusCode, 200); res.on('end', () => { if (++reqNum < MAX_REQUESTS) makeRequest.call(this); }); res.resume(); }); }); node-v4.8.2/test/parallel/test-http-server-consumed-timeout.js000644 000766 000024 00000001377 13070706737 024642 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const http = require('http'); const server = http.createServer((req, res) => { server.close(); res.writeHead(200); res.flushHeaders(); req.setTimeout(common.platformTimeout(200), () => { common.fail('Request timeout should not fire'); }); req.resume(); req.once('end', common.mustCall(() => { res.end(); })); }); server.listen(0, common.mustCall(() => { const req = http.request({ port: server.address().port, method: 'POST' }, (res) => { const interval = setInterval(() => { req.write('a'); }, common.platformTimeout(25)); setTimeout(() => { clearInterval(interval); req.end(); }, common.platformTimeout(200)); }); req.write('.'); })); node-v4.8.2/test/parallel/test-http-server-multiheaders.js000644 000766 000024 00000003556 13070706737 024030 0ustar00iojsstaff000000 000000 'use strict'; // Verify that the HTTP server implementation handles multiple instances // of the same header as per RFC2616: joining the handful of fields by ', ' // that support it, and dropping duplicates for other fields. require('../common'); var assert = require('assert'); var http = require('http'); var srv = http.createServer(function(req, res) { assert.equal(req.headers.accept, 'abc, def, ghijklmnopqrst'); assert.equal(req.headers.host, 'foo'); assert.equal(req.headers['www-authenticate'], 'foo, bar, baz'); assert.equal(req.headers['proxy-authenticate'], 'foo, bar, baz'); assert.equal(req.headers['x-foo'], 'bingo'); assert.equal(req.headers['x-bar'], 'banjo, bango'); assert.equal(req.headers['sec-websocket-protocol'], 'chat, share'); assert.equal(req.headers['sec-websocket-extensions'], 'foo; 1, bar; 2, baz'); assert.equal(req.headers['constructor'], 'foo, bar, baz'); res.writeHead(200, {'Content-Type': 'text/plain'}); res.end('EOF'); srv.close(); }); srv.listen(0, function() { http.get({ host: 'localhost', port: this.address().port, path: '/', headers: [ ['accept', 'abc'], ['accept', 'def'], ['Accept', 'ghijklmnopqrst'], ['host', 'foo'], ['Host', 'bar'], ['hOst', 'baz'], ['www-authenticate', 'foo'], ['WWW-Authenticate', 'bar'], ['WWW-AUTHENTICATE', 'baz'], ['proxy-authenticate', 'foo'], ['Proxy-Authenticate', 'bar'], ['PROXY-AUTHENTICATE', 'baz'], ['x-foo', 'bingo'], ['x-bar', 'banjo'], ['x-bar', 'bango'], ['sec-websocket-protocol', 'chat'], ['sec-websocket-protocol', 'share'], ['sec-websocket-extensions', 'foo; 1'], ['sec-websocket-extensions', 'bar; 2'], ['sec-websocket-extensions', 'baz'], ['constructor', 'foo'], ['constructor', 'bar'], ['constructor', 'baz'], ] }); }); node-v4.8.2/test/parallel/test-http-server-multiheaders2.js000644 000766 000024 00000004057 13070706737 024107 0ustar00iojsstaff000000 000000 'use strict'; // Verify that the HTTP server implementation handles multiple instances // of the same header as per RFC2616: joining the handful of fields by ', ' // that support it, and dropping duplicates for other fields. require('../common'); var assert = require('assert'); var http = require('http'); var multipleAllowed = [ 'Accept', 'Accept-Charset', 'Accept-Encoding', 'Accept-Language', 'Connection', 'Cookie', 'DAV', // GH-2750 'Pragma', // GH-715 'Link', // GH-1187 'WWW-Authenticate', // GH-1083 'Proxy-Authenticate', // GH-4052 'Sec-Websocket-Extensions', // GH-2764 'Sec-Websocket-Protocol', // GH-2764 'Via', // GH-6660 // not a special case, just making sure it's parsed correctly 'X-Forwarded-For', // make sure that unspecified headers is treated as multiple 'Some-Random-Header', 'X-Some-Random-Header', ]; var multipleForbidden = [ 'Content-Type', 'User-Agent', 'Referer', 'Host', 'Authorization', 'Proxy-Authorization', 'If-Modified-Since', 'If-Unmodified-Since', 'From', 'Location', 'Max-Forwards', // special case, tested differently //'Content-Length', ]; var srv = http.createServer(function(req, res) { multipleForbidden.forEach(function(header) { assert.equal(req.headers[header.toLowerCase()], 'foo', 'header parsed incorrectly: ' + header); }); multipleAllowed.forEach(function(header) { assert.equal(req.headers[header.toLowerCase()], 'foo, bar', 'header parsed incorrectly: ' + header); }); res.writeHead(200, {'Content-Type': 'text/plain'}); res.end('EOF'); srv.close(); }); function makeHeader(value) { return function(header) { return [header, value]; }; } var headers = [] .concat(multipleAllowed.map(makeHeader('foo'))) .concat(multipleForbidden.map(makeHeader('foo'))) .concat(multipleAllowed.map(makeHeader('bar'))) .concat(multipleForbidden.map(makeHeader('bar'))); srv.listen(0, function() { http.get({ host: 'localhost', port: this.address().port, path: '/', headers: headers, }); }); node-v4.8.2/test/parallel/test-http-server-reject-chunked-with-content-length.js000644 000766 000024 00000001721 13070706737 030125 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const http = require('http'); const net = require('net'); const assert = require('assert'); const reqstr = 'POST / HTTP/1.1\r\n' + 'Content-Length: 1\r\n' + 'Transfer-Encoding: chunked\r\n\r\n'; const server = http.createServer((req, res) => { common.fail('callback should not be invoked'); }); server.on('clientError', common.mustCall((err) => { assert(/^Parse Error/.test(err.message)); assert.equal(err.code, 'HPE_UNEXPECTED_CONTENT_LENGTH'); server.close(); })); server.listen(0, () => { const client = net.connect({port: server.address().port}, () => { client.write(reqstr); client.end(); }); client.on('data', (data) => { // Should not get to this point because the server should simply // close the connection without returning any data. common.fail('no data should be returned by the server'); }); client.on('end', common.mustCall(() => {})); }); node-v4.8.2/test/parallel/test-http-server-reject-cr-no-lf.js000644 000766 000024 00000001514 13070706737 024221 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const net = require('net'); const http = require('http'); const assert = require('assert'); const str = 'GET / HTTP/1.1\r\n' + 'Dummy: Header\r' + 'Content-Length: 1\r\n' + '\r\n'; const server = http.createServer((req, res) => { common.fail('this should not be called'); }); server.on('clientError', common.mustCall((err) => { assert(/^Parse Error/.test(err.message)); assert.equal(err.code, 'HPE_LF_EXPECTED'); server.close(); })); server.listen(0, () => { const client = net.connect({port: server.address().port}, () => { client.on('data', (chunk) => { common.fail('this should not be called'); }); client.on('end', common.mustCall(() => { server.close(); })); client.write(str); client.end(); }); }); node-v4.8.2/test/parallel/test-http-server-stale-close.js000644 000766 000024 00000001356 13070706737 023551 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var http = require('http'); var util = require('util'); var fork = require('child_process').fork; if (process.env.NODE_TEST_FORK_PORT) { var req = http.request({ headers: {'Content-Length': '42'}, method: 'POST', host: '127.0.0.1', port: +process.env.NODE_TEST_FORK_PORT, }, process.exit); req.write('BAM'); req.end(); } else { var server = http.createServer(function(req, res) { res.writeHead(200, {'Content-Length': '42'}); req.pipe(res); req.on('close', function() { server.close(); res.end(); }); }); server.listen(0, function() { fork(__filename, { env: util._extend(process.env, {NODE_TEST_FORK_PORT: this.address().port}) }); }); } node-v4.8.2/test/parallel/test-http-server-unconsume-consume.js000644 000766 000024 00000001247 13070706737 025020 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const http = require('http'); const testServer = http.createServer((req, res) => { common.fail('Should not be called'); res.end(); }); testServer.on('connect', common.mustCall((req, socket, head) => { socket.write('HTTP/1.1 200 Connection Established' + '\r\n' + 'Proxy-agent: Node-Proxy' + '\r\n' + '\r\n'); // This shouldn't raise an assertion in StreamBase::Consume. testServer.emit('connection', socket); testServer.close(); })); testServer.listen(0, common.mustCall(() => { http.request({ port: testServer.address().port, method: 'CONNECT' }, (res) => {}).end(); })); node-v4.8.2/test/parallel/test-http-server-unconsume.js000644 000766 000024 00000001151 13070706737 023343 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var net = require('net'); var received = ''; var server = http.createServer(function(req, res) { res.writeHead(200); res.end(); req.socket.on('data', function(data) { received += data; }); server.close(); }).listen(0, function() { var socket = net.connect(this.address().port, function() { socket.write('PUT / HTTP/1.1\r\n\r\n'); socket.once('data', function() { socket.end('hello world'); }); }); }); process.on('exit', function() { assert.equal(received, 'hello world'); }); node-v4.8.2/test/parallel/test-http-server.js000644 000766 000024 00000005173 13070706737 021341 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var net = require('net'); var http = require('http'); var url = require('url'); var qs = require('querystring'); var request_number = 0; var requests_sent = 0; var server_response = ''; var client_got_eof = false; var server = http.createServer(function(req, res) { res.id = request_number; req.id = request_number++; if (req.id === 0) { assert.strictEqual('GET', req.method); assert.strictEqual('/hello', url.parse(req.url).pathname); assert.strictEqual('world', qs.parse(url.parse(req.url).query).hello); assert.strictEqual('b==ar', qs.parse(url.parse(req.url).query).foo); } if (req.id === 1) { assert.strictEqual('POST', req.method); assert.strictEqual('/quit', url.parse(req.url).pathname); } if (req.id === 2) { assert.strictEqual('foo', req.headers['x-x']); } if (req.id === 3) { assert.strictEqual('bar', req.headers['x-x']); this.close(); } setTimeout(function() { res.writeHead(200, {'Content-Type': 'text/plain'}); res.write(url.parse(req.url).pathname); res.end(); }, 1); }); server.listen(0); server.httpAllowHalfOpen = true; server.on('listening', function() { var c = net.createConnection(this.address().port); c.setEncoding('utf8'); c.on('connect', function() { c.write('GET /hello?hello=world&foo=b==ar HTTP/1.1\r\n\r\n'); requests_sent += 1; }); c.on('data', function(chunk) { server_response += chunk; if (requests_sent === 1) { c.write('POST /quit HTTP/1.1\r\n\r\n'); requests_sent += 1; } if (requests_sent === 2) { c.write('GET / HTTP/1.1\r\nX-X: foo\r\n\r\n' + 'GET / HTTP/1.1\r\nX-X: bar\r\n\r\n'); // Note: we are making the connection half-closed here // before we've gotten the response from the server. This // is a pretty bad thing to do and not really supported // by many http servers. Node supports it optionally if // you set server.httpAllowHalfOpen=true, which we've done // above. c.end(); assert.strictEqual(c.readyState, 'readOnly'); requests_sent += 2; } }); c.on('end', function() { client_got_eof = true; }); c.on('close', function() { assert.strictEqual(c.readyState, 'closed'); }); }); process.on('exit', function() { assert.strictEqual(4, request_number); assert.strictEqual(4, requests_sent); var hello = new RegExp('/hello'); assert.notStrictEqual(null, hello.exec(server_response)); var quit = new RegExp('/quit'); assert.notStrictEqual(null, quit.exec(server_response)); assert.strictEqual(true, client_got_eof); }); node-v4.8.2/test/parallel/test-http-set-cookies.js000644 000766 000024 00000003037 13070706737 022255 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var nresponses = 0; var server = http.createServer(function(req, res) { if (req.url === '/one') { res.writeHead(200, [['set-cookie', 'A'], ['content-type', 'text/plain']]); res.end('one\n'); } else { res.writeHead(200, [['set-cookie', 'A'], ['set-cookie', 'B'], ['content-type', 'text/plain']]); res.end('two\n'); } }); server.listen(0); server.on('listening', function() { // // one set-cookie header // http.get({ port: this.address().port, path: '/one' }, function(res) { // set-cookie headers are always return in an array. // even if there is only one. assert.deepEqual(['A'], res.headers['set-cookie']); assert.equal('text/plain', res.headers['content-type']); res.on('data', function(chunk) { console.log(chunk.toString()); }); res.on('end', function() { if (++nresponses === 2) { server.close(); } }); }); // two set-cookie headers http.get({ port: this.address().port, path: '/two' }, function(res) { assert.deepEqual(['A', 'B'], res.headers['set-cookie']); assert.equal('text/plain', res.headers['content-type']); res.on('data', function(chunk) { console.log(chunk.toString()); }); res.on('end', function() { if (++nresponses === 2) { server.close(); } }); }); }); process.on('exit', function() { assert.equal(2, nresponses); }); node-v4.8.2/test/parallel/test-http-set-timeout-server.js000644 000766 000024 00000011434 13070706737 023613 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var http = require('http'); var net = require('net'); var tests = []; function test(fn) { if (!tests.length) process.nextTick(run); tests.push(fn); } function run() { var fn = tests.shift(); if (fn) { console.log('# %s', fn.name); fn(run); } else { console.log('ok'); } } test(function serverTimeout(cb) { var caughtTimeout = false; process.on('exit', function() { assert(caughtTimeout); }); var server = http.createServer(function(req, res) { // just do nothing, we should get a timeout event. }); server.listen(common.mustCall(function() { http.get({ port: server.address().port }).on('error', function() {}); })); var s = server.setTimeout(50, function(socket) { caughtTimeout = true; socket.destroy(); server.close(); cb(); }); assert.ok(s instanceof http.Server); }); test(function serverRequestTimeout(cb) { var caughtTimeout = false; process.on('exit', function() { assert(caughtTimeout); }); var server = http.createServer(function(req, res) { // just do nothing, we should get a timeout event. var s = req.setTimeout(50, function() { caughtTimeout = true; req.socket.destroy(); server.close(); cb(); }); assert.ok(s instanceof http.IncomingMessage); }); server.listen(common.mustCall(function() { var port = server.address().port; var req = http.request({ port: port, method: 'POST' }); req.on('error', function() {}); req.write('Hello'); // req is in progress })); }); test(function serverResponseTimeout(cb) { var caughtTimeout = false; process.on('exit', function() { assert(caughtTimeout); }); var server = http.createServer(function(req, res) { // just do nothing, we should get a timeout event. var s = res.setTimeout(50, function() { caughtTimeout = true; res.socket.destroy(); server.close(); cb(); }); assert.ok(s instanceof http.OutgoingMessage); }); server.listen(common.mustCall(function() { var port = server.address().port; http.get({ port: port }).on('error', function() {}); })); }); test(function serverRequestNotTimeoutAfterEnd(cb) { var caughtTimeoutOnRequest = false; var caughtTimeoutOnResponse = false; process.on('exit', function() { assert(!caughtTimeoutOnRequest); assert(caughtTimeoutOnResponse); }); var server = http.createServer(function(req, res) { // just do nothing, we should get a timeout event. var s = req.setTimeout(50, function(socket) { caughtTimeoutOnRequest = true; }); assert.ok(s instanceof http.IncomingMessage); res.on('timeout', function(socket) { caughtTimeoutOnResponse = true; }); }); server.on('timeout', function(socket) { socket.destroy(); server.close(); cb(); }); server.listen(common.mustCall(function() { var port = server.address().port; http.get({ port: port }).on('error', function() {}); })); }); test(function serverResponseTimeoutWithPipeline(cb) { var caughtTimeout = ''; process.on('exit', function() { assert.equal(caughtTimeout, '/2'); }); var server = http.createServer(function(req, res) { var s = res.setTimeout(50, function() { caughtTimeout += req.url; }); assert.ok(s instanceof http.OutgoingMessage); if (req.url === '/1') res.end(); }); server.on('timeout', function(socket) { socket.destroy(); server.close(); cb(); }); server.listen(common.mustCall(function() { var port = server.address().port; var c = net.connect({ port: port, allowHalfOpen: true }, function() { c.write('GET /1 HTTP/1.1\r\nHost: localhost\r\n\r\n'); c.write('GET /2 HTTP/1.1\r\nHost: localhost\r\n\r\n'); c.write('GET /3 HTTP/1.1\r\nHost: localhost\r\n\r\n'); }); })); }); test(function idleTimeout(cb) { var caughtTimeoutOnRequest = false; var caughtTimeoutOnResponse = false; var caughtTimeoutOnServer = false; process.on('exit', function() { assert(!caughtTimeoutOnRequest); assert(!caughtTimeoutOnResponse); assert(caughtTimeoutOnServer); }); var server = http.createServer(function(req, res) { req.on('timeout', function(socket) { caughtTimeoutOnRequest = true; }); res.on('timeout', function(socket) { caughtTimeoutOnResponse = true; }); res.end(); }); var s = server.setTimeout(50, function(socket) { caughtTimeoutOnServer = true; socket.destroy(); server.close(); cb(); }); assert.ok(s instanceof http.Server); server.listen(common.mustCall(function() { var port = server.address().port; var c = net.connect({ port: port, allowHalfOpen: true }, function() { c.write('GET /1 HTTP/1.1\r\nHost: localhost\r\n\r\n'); // Keep-Alive }); })); }); node-v4.8.2/test/parallel/test-http-set-timeout.js000644 000766 000024 00000001441 13070706737 022304 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const http = require('http'); const net = require('net'); var server = http.createServer(function(req, res) { console.log('got request. setting 500ms timeout'); var socket = req.connection.setTimeout(500); assert.ok(socket instanceof net.Socket); req.connection.on('timeout', common.mustCall(function() { req.connection.destroy(); console.error('TIMEOUT'); server.close(); })); }); server.listen(0, function() { console.log(`Server running at http://127.0.0.1:${this.address().port}/`); var request = http.get({port: this.address().port, path: '/'}); request.on('error', common.mustCall(function() { console.log('HTTP REQUEST COMPLETE (this is good)'); })); request.end(); }); node-v4.8.2/test/parallel/test-http-set-trailers.js000644 000766 000024 00000004303 13070706737 022443 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var http = require('http'); var net = require('net'); var outstanding_reqs = 0; var server = http.createServer(function(req, res) { res.writeHead(200, [['content-type', 'text/plain']]); res.addTrailers({'x-foo': 'bar'}); res.end('stuff' + '\n'); }); server.listen(0); // first, we test an HTTP/1.0 request. server.on('listening', function() { var c = net.createConnection(this.address().port); var res_buffer = ''; c.setEncoding('utf8'); c.on('connect', function() { outstanding_reqs++; c.write('GET / HTTP/1.0\r\n\r\n'); }); c.on('data', function(chunk) { //console.log(chunk); res_buffer += chunk; }); c.on('end', function() { c.end(); assert.ok(!/x-foo/.test(res_buffer), 'Trailer in HTTP/1.0 response.'); outstanding_reqs--; if (outstanding_reqs === 0) { server.close(); process.exit(); } }); }); // now, we test an HTTP/1.1 request. server.on('listening', function() { var c = net.createConnection(this.address().port); var res_buffer = ''; var tid; c.setEncoding('utf8'); c.on('connect', function() { outstanding_reqs++; c.write('GET / HTTP/1.1\r\n\r\n'); tid = setTimeout(common.fail, 2000, 'Couldn\'t find last chunk.'); }); c.on('data', function(chunk) { //console.log(chunk); res_buffer += chunk; if (/0\r\n/.test(res_buffer)) { // got the end. outstanding_reqs--; clearTimeout(tid); assert.ok( /0\r\nx-foo: bar\r\n\r\n$/.test(res_buffer), 'No trailer in HTTP/1.1 response.' ); if (outstanding_reqs === 0) { server.close(); process.exit(); } } }); }); // now, see if the client sees the trailers. server.on('listening', function() { http.get({ port: this.address().port, path: '/hello', headers: {} }, function(res) { res.on('end', function() { //console.log(res.trailers); assert.ok('x-foo' in res.trailers, 'Client doesn\'t see trailers.'); outstanding_reqs--; if (outstanding_reqs === 0) { server.close(); process.exit(); } }); res.resume(); }); outstanding_reqs++; }); node-v4.8.2/test/parallel/test-http-should-keep-alive.js000644 000766 000024 00000003206 13070706737 023344 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var net = require('net'); var SERVER_RESPONSES = [ 'HTTP/1.0 200 ok\r\nContent-Length: 0\r\n\r\n', 'HTTP/1.0 200 ok\r\nContent-Length: 0\r\nConnection: keep-alive\r\n\r\n', 'HTTP/1.0 200 ok\r\nContent-Length: 0\r\nConnection: close\r\n\r\n', 'HTTP/1.1 200 ok\r\nContent-Length: 0\r\n\r\n', 'HTTP/1.1 200 ok\r\nContent-Length: 0\r\nConnection: keep-alive\r\n\r\n', 'HTTP/1.1 200 ok\r\nContent-Length: 0\r\nConnection: close\r\n\r\n' ]; var SHOULD_KEEP_ALIVE = [ false, // HTTP/1.0, default true, // HTTP/1.0, Connection: keep-alive false, // HTTP/1.0, Connection: close true, // HTTP/1.1, default true, // HTTP/1.1, Connection: keep-alive false // HTTP/1.1, Connection: close ]; var requests = 0; var responses = 0; http.globalAgent.maxSockets = 5; var server = net.createServer(function(socket) { socket.write(SERVER_RESPONSES[requests]); ++requests; }).listen(0, function() { function makeRequest() { var req = http.get({port: server.address().port}, function(res) { assert.equal(req.shouldKeepAlive, SHOULD_KEEP_ALIVE[responses], SERVER_RESPONSES[responses] + ' should ' + (SHOULD_KEEP_ALIVE[responses] ? '' : 'not ') + 'Keep-Alive'); ++responses; if (responses < SHOULD_KEEP_ALIVE.length) { makeRequest(); } else { server.close(); } res.resume(); }); } makeRequest(); }); process.on('exit', function() { assert.equal(requests, SERVER_RESPONSES.length); assert.equal(responses, SHOULD_KEEP_ALIVE.length); }); node-v4.8.2/test/parallel/test-http-status-code.js000644 000766 000024 00000002136 13070706737 022262 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); // Simple test of Node's HTTP ServerResponse.statusCode // ServerResponse.prototype.statusCode var testsComplete = 0; var tests = [200, 202, 300, 404, 451, 500]; var testIdx = 0; var s = http.createServer(function(req, res) { var t = tests[testIdx]; res.writeHead(t, {'Content-Type': 'text/plain'}); console.log('--\nserver: statusCode after writeHead: ' + res.statusCode); assert.equal(res.statusCode, t); res.end('hello world\n'); }); s.listen(0, nextTest); function nextTest() { if (testIdx + 1 === tests.length) { return s.close(); } var test = tests[testIdx]; http.get({ port: s.address().port }, function(response) { console.log('client: expected status: ' + test); console.log('client: statusCode: ' + response.statusCode); assert.equal(response.statusCode, test); response.on('end', function() { testsComplete++; testIdx += 1; nextTest(); }); response.resume(); }); } process.on('exit', function() { assert.equal(5, testsComplete); }); node-v4.8.2/test/parallel/test-http-status-message.js000644 000766 000024 00000001311 13070706737 022766 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var net = require('net'); var s = http.createServer(function(req, res) { res.statusCode = 200; res.statusMessage = 'Custom Message'; res.end(''); }); s.listen(0, test); function test() { var bufs = []; var client = net.connect(this.address().port, function() { client.write('GET / HTTP/1.1\r\nConnection: close\r\n\r\n'); }); client.on('data', function(chunk) { bufs.push(chunk); }); client.on('end', function() { var head = Buffer.concat(bufs).toString('binary').split('\r\n')[0]; assert.equal('HTTP/1.1 200 Custom Message', head); console.log('ok'); s.close(); }); } node-v4.8.2/test/parallel/test-http-status-reason-invalid-chars.js000644 000766 000024 00000002426 13070706737 025363 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const http = require('http'); function explicit(req, res) { assert.throws(() => { res.writeHead(200, 'OK\r\nContent-Type: text/html\r\n'); }, /Invalid character in statusMessage/); assert.throws(() => { res.writeHead(200, 'OK\u010D\u010AContent-Type: gotcha\r\n'); }, /Invalid character in statusMessage/); res.statusMessage = 'OK'; res.end(); } function implicit(req, res) { assert.throws(() => { res.statusMessage = 'OK\r\nContent-Type: text/html\r\n'; res.writeHead(200); }, /Invalid character in statusMessage/); res.statusMessage = 'OK'; res.end(); } const server = http.createServer((req, res) => { if (req.url === '/explicit') { explicit(req, res); } else { implicit(req, res); } }).listen(0, common.mustCall(() => { const hostname = 'localhost'; const url = `http://${hostname}:${server.address().port}`; let left = 2; const check = common.mustCall((res) => { left--; assert.notStrictEqual(res.headers['content-type'], 'text/html'); assert.notStrictEqual(res.headers['content-type'], 'gotcha'); if (left === 0) server.close(); }, 2); http.get(`${url}/explicit`, check).end(); http.get(`${url}/implicit`, check).end(); })); node-v4.8.2/test/parallel/test-http-timeout-overflow.js000644 000766 000024 00000001437 13070706737 023361 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var serverRequests = 0; var clientRequests = 0; var server = http.createServer(function(req, res) { serverRequests++; res.writeHead(200, {'Content-Type': 'text/plain'}); res.end('OK'); }); server.listen(0, function() { function callback() {} var req = http.request({ port: this.address().port, path: '/', agent: false }, function(res) { req.clearTimeout(callback); res.on('end', function() { clientRequests++; server.close(); }); res.resume(); }); // Overflow signed int32 req.setTimeout(0xffffffff, callback); req.end(); }); process.once('exit', function() { assert.equal(clientRequests, 1); assert.equal(serverRequests, 1); }); node-v4.8.2/test/parallel/test-http-timeout.js000644 000766 000024 00000001434 13070706737 021515 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var http = require('http'); var server = http.createServer(function(req, res) { res.writeHead(200, {'Content-Type': 'text/plain'}); res.end('OK'); }); var agent = new http.Agent({maxSockets: 1}); server.listen(0, function() { for (var i = 0; i < 11; ++i) { createRequest().end(); } function callback() {} var count = 0; function createRequest() { const req = http.request( {port: server.address().port, path: '/', agent: agent}, function(res) { req.clearTimeout(callback); res.on('end', function() { count++; if (count === 11) { server.close(); } }); res.resume(); } ); req.setTimeout(1000, callback); return req; } }); node-v4.8.2/test/parallel/test-http-unix-socket.js000644 000766 000024 00000002215 13070706737 022276 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var http = require('http'); var server = http.createServer(function(req, res) { res.writeHead(200, { 'Content-Type': 'text/plain', 'Connection': 'close' }); res.write('hello '); res.write('world\n'); res.end(); }); common.refreshTmpDir(); server.listen(common.PIPE, common.mustCall(function() { var options = { socketPath: common.PIPE, path: '/' }; var req = http.get(options, common.mustCall(function(res) { assert.equal(res.statusCode, 200); assert.equal(res.headers['content-type'], 'text/plain'); res.body = ''; res.setEncoding('utf8'); res.on('data', function(chunk) { res.body += chunk; }); res.on('end', common.mustCall(function() { assert.equal(res.body, 'hello world\n'); server.close(function(error) { assert.equal(error, undefined); server.close(function(error) { assert.equal(error && error.message, 'Not running'); }); }); })); })); req.on('error', function(e) { console.log(e.stack); process.exit(1); }); req.end(); })); node-v4.8.2/test/parallel/test-http-upgrade-advertise.js000644 000766 000024 00000002375 13070706737 023447 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const http = require('http'); const tests = [ { headers: {}, expected: 'regular' }, { headers: { upgrade: 'h2c' }, expected: 'regular' }, { headers: { connection: 'upgrade' }, expected: 'regular' }, { headers: { connection: 'upgrade', upgrade: 'h2c' }, expected: 'upgrade' } ]; function fire() { if (tests.length === 0) return server.close(); const test = tests.shift(); const done = common.mustCall(function done(result) { assert.equal(result, test.expected); fire(); }); const req = http.request({ port: server.address().port, path: '/', headers: test.headers }, function onResponse(res) { res.resume(); done('regular'); }); req.on('upgrade', function onUpgrade(res, socket) { socket.destroy(); done('upgrade'); }); req.end(); } const server = http.createServer(function(req, res) { res.writeHead(200, { Connection: 'upgrade, keep-alive', Upgrade: 'h2c' }); res.end('hello world'); }).on('upgrade', function(req, socket) { socket.end('HTTP/1.1 101 Switching protocols\r\n' + 'Connection: upgrade\r\n' + 'Upgrade: h2c\r\n\r\n' + 'ohai'); }).listen(0, fire); node-v4.8.2/test/parallel/test-http-upgrade-agent.js000644 000766 000024 00000003240 13070706737 022547 0ustar00iojsstaff000000 000000 'use strict'; // Verify that the 'upgrade' header causes an 'upgrade' event to be emitted to // the HTTP client. This test uses a raw TCP server to better control server // behavior. var common = require('../common'); var assert = require('assert'); var http = require('http'); var net = require('net'); // Create a TCP server var srv = net.createServer(function(c) { c.on('data', function(d) { c.write('HTTP/1.1 101\r\n'); c.write('hello: world\r\n'); c.write('connection: upgrade\r\n'); c.write('upgrade: websocket\r\n'); c.write('\r\n'); c.write('nurtzo'); }); c.on('end', function() { c.end(); }); }); srv.listen(0, '127.0.0.1', common.mustCall(function() { var options = { port: this.address().port, host: '127.0.0.1', headers: { 'connection': 'upgrade', 'upgrade': 'websocket' } }; var name = options.host + ':' + options.port; var req = http.request(options); req.end(); req.on('upgrade', common.mustCall(function(res, socket, upgradeHead) { var recvData = upgradeHead; socket.on('data', function(d) { recvData += d; }); socket.on('close', common.mustCall(function() { assert.equal(recvData, 'nurtzo'); })); console.log(res.headers); var expectedHeaders = { 'hello': 'world', 'connection': 'upgrade', 'upgrade': 'websocket' }; assert.deepEqual(expectedHeaders, res.headers); // Make sure this request got removed from the pool. assert(!http.globalAgent.sockets.hasOwnProperty(name)); req.on('close', common.mustCall(function() { socket.end(); srv.close(); })); })); })); node-v4.8.2/test/parallel/test-http-upgrade-client.js000644 000766 000024 00000003506 13070706737 022734 0ustar00iojsstaff000000 000000 'use strict'; // Verify that the 'upgrade' header causes an 'upgrade' event to be emitted to // the HTTP client. This test uses a raw TCP server to better control server // behavior. var common = require('../common'); var assert = require('assert'); var http = require('http'); var net = require('net'); // Create a TCP server var srv = net.createServer(function(c) { c.on('data', function(d) { c.write('HTTP/1.1 101\r\n'); c.write('hello: world\r\n'); c.write('connection: upgrade\r\n'); c.write('upgrade: websocket\r\n'); c.write('\r\n'); c.write('nurtzo'); }); c.on('end', function() { c.end(); }); }); srv.listen(0, '127.0.0.1', common.mustCall(function() { var port = this.address().port; var headers = [ { connection: 'upgrade', upgrade: 'websocket' }, [ ['Host', 'echo.websocket.org'], ['Connection', 'Upgrade'], ['Upgrade', 'websocket'], ['Origin', 'http://www.websocket.org'] ] ]; var left = headers.length; headers.forEach(function(h) { var req = http.get({ port: port, headers: h }); var sawUpgrade = false; req.on('upgrade', common.mustCall(function(res, socket, upgradeHead) { sawUpgrade = true; var recvData = upgradeHead; socket.on('data', function(d) { recvData += d; }); socket.on('close', common.mustCall(function() { assert.equal(recvData, 'nurtzo'); })); console.log(res.headers); var expectedHeaders = { hello: 'world', connection: 'upgrade', upgrade: 'websocket' }; assert.deepStrictEqual(expectedHeaders, res.headers); socket.end(); if (--left == 0) srv.close(); })); req.on('close', common.mustCall(function() { assert.strictEqual(sawUpgrade, true); })); }); })); node-v4.8.2/test/parallel/test-http-upgrade-client2.js000644 000766 000024 00000002601 13070706737 023011 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var http = require('http'); var CRLF = '\r\n'; var server = http.createServer(); server.on('upgrade', function(req, socket, head) { socket.write('HTTP/1.1 101 Ok' + CRLF + 'Connection: Upgrade' + CRLF + 'Upgrade: Test' + CRLF + CRLF + 'head'); socket.on('end', function() { socket.end(); }); }); server.listen(0, common.mustCall(function() { function upgradeRequest(fn) { console.log('req'); var header = { 'Connection': 'Upgrade', 'Upgrade': 'Test' }; var request = http.request({ port: server.address().port, headers: header }); var wasUpgrade = false; function onUpgrade(res, socket, head) { console.log('client upgraded'); wasUpgrade = true; request.removeListener('upgrade', onUpgrade); socket.end(); } request.on('upgrade', onUpgrade); function onEnd() { console.log('client end'); request.removeListener('end', onEnd); if (!wasUpgrade) { throw new Error('hasn\'t received upgrade event'); } else { fn && process.nextTick(fn); } } request.on('close', onEnd); request.write('head'); } upgradeRequest(common.mustCall(function() { upgradeRequest(common.mustCall(function() { // Test pass console.log('Pass!'); server.close(); })); })); })); node-v4.8.2/test/parallel/test-http-upgrade-server.js000644 000766 000024 00000007376 13070706737 022775 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var util = require('util'); var net = require('net'); var http = require('http'); var requests_recv = 0; var requests_sent = 0; var request_upgradeHead = null; function createTestServer() { return new testServer(); } function testServer() { http.Server.call(this, function() {}); this.on('connection', function() { requests_recv++; }); this.on('request', function(req, res) { res.writeHead(200, {'Content-Type': 'text/plain'}); res.write('okay'); res.end(); }); this.on('upgrade', function(req, socket, upgradeHead) { socket.write('HTTP/1.1 101 Web Socket Protocol Handshake\r\n' + 'Upgrade: WebSocket\r\n' + 'Connection: Upgrade\r\n' + '\r\n\r\n'); request_upgradeHead = upgradeHead; socket.on('data', function(d) { var data = d.toString('utf8'); if (data === 'kill') { socket.end(); } else { socket.write(data, 'utf8'); } }); }); } util.inherits(testServer, http.Server); function writeReq(socket, data, encoding) { requests_sent++; socket.write(data); } /*----------------------------------------------- connection: Upgrade with listener -----------------------------------------------*/ function test_upgrade_with_listener() { var conn = net.createConnection(server.address().port); conn.setEncoding('utf8'); var state = 0; conn.on('connect', function() { writeReq(conn, 'GET / HTTP/1.1\r\n' + 'Upgrade: WebSocket\r\n' + 'Connection: Upgrade\r\n' + '\r\n' + 'WjN}|M(6'); }); conn.on('data', function(data) { state++; assert.equal('string', typeof data); if (state === 1) { assert.equal('HTTP/1.1 101', data.substr(0, 12)); assert.equal('WjN}|M(6', request_upgradeHead.toString('utf8')); conn.write('test', 'utf8'); } else if (state === 2) { assert.equal('test', data); conn.write('kill', 'utf8'); } }); conn.on('end', function() { assert.equal(2, state); conn.end(); server.removeAllListeners('upgrade'); test_upgrade_no_listener(); }); } /*----------------------------------------------- connection: Upgrade, no listener -----------------------------------------------*/ var test_upgrade_no_listener_ended = false; function test_upgrade_no_listener() { var conn = net.createConnection(server.address().port); conn.setEncoding('utf8'); conn.on('connect', function() { writeReq(conn, 'GET / HTTP/1.1\r\n' + 'Upgrade: WebSocket\r\n' + 'Connection: Upgrade\r\n' + '\r\n'); }); conn.on('end', function() { test_upgrade_no_listener_ended = true; conn.end(); }); conn.on('close', function() { test_standard_http(); }); } /*----------------------------------------------- connection: normal -----------------------------------------------*/ function test_standard_http() { var conn = net.createConnection(server.address().port); conn.setEncoding('utf8'); conn.on('connect', function() { writeReq(conn, 'GET / HTTP/1.1\r\n\r\n'); }); conn.once('data', function(data) { assert.equal('string', typeof data); assert.equal('HTTP/1.1 200', data.substr(0, 12)); conn.end(); }); conn.on('close', function() { server.close(); }); } var server = createTestServer(); server.listen(0, function() { // All tests get chained after this: test_upgrade_with_listener(); }); /*----------------------------------------------- Fin. -----------------------------------------------*/ process.on('exit', function() { assert.equal(3, requests_recv); assert.equal(3, requests_sent); assert.ok(test_upgrade_no_listener_ended); }); node-v4.8.2/test/parallel/test-http-upgrade-server2.js000644 000766 000024 00000001632 13070706737 023044 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var http = require('http'); var net = require('net'); var server = http.createServer(function(req, res) { throw new Error('This shouldn\'t happen.'); }); server.on('upgrade', function(req, socket, upgradeHead) { // test that throwing an error from upgrade gets // is uncaught throw new Error('upgrade error'); }); process.on('uncaughtException', common.mustCall(function(e) { assert.equal('upgrade error', e.message); process.exit(0); })); server.listen(0, function() { var c = net.createConnection(this.address().port); c.on('connect', function() { c.write('GET /blah HTTP/1.1\r\n' + 'Upgrade: WebSocket\r\n' + 'Connection: Upgrade\r\n' + '\r\n\r\nhello world'); }); c.on('end', function() { c.end(); }); c.on('close', function() { server.close(); }); }); node-v4.8.2/test/parallel/test-http-url.parse-auth-with-header-in-request.js000644 000766 000024 00000001502 13070706737 027166 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var url = require('url'); function check(request) { // the correct authorization header is be passed assert.strictEqual(request.headers.authorization, 'NoAuthForYOU'); } var server = http.createServer(function(request, response) { // run the check function check.call(this, request, response); response.writeHead(200, {}); response.end('ok'); server.close(); }); server.listen(0, function() { var testURL = url.parse(`http://asdf:qwer@localhost:${this.address().port}`); // the test here is if you set a specific authorization header in the // request we should not override that with basic auth testURL.headers = { Authorization: 'NoAuthForYOU' }; // make the request http.request(testURL).end(); }); node-v4.8.2/test/parallel/test-http-url.parse-auth.js000644 000766 000024 00000001321 13070706737 022674 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var url = require('url'); function check(request) { // the correct authorization header is be passed assert.strictEqual(request.headers.authorization, 'Basic dXNlcjpwYXNzOg=='); } var server = http.createServer(function(request, response) { // run the check function check.call(this, request, response); response.writeHead(200, {}); response.end('ok'); server.close(); }); server.listen(0, function() { const port = this.address().port; // username = "user", password = "pass:" var testURL = url.parse(`http://user:pass%3A@localhost:${port}`); // make the request http.request(testURL).end(); }); node-v4.8.2/test/parallel/test-http-url.parse-basic.js000644 000766 000024 00000002104 13070706737 023014 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var url = require('url'); var testURL; // make sure the basics work function check(request) { // default method should still be get assert.strictEqual(request.method, 'GET'); // there are no URL params, so you should not see any assert.strictEqual(request.url, '/'); // the host header should use the url.parse.hostname assert.strictEqual(request.headers.host, testURL.hostname + ':' + testURL.port); } var server = http.createServer(function(request, response) { // run the check function check.call(this, request, response); response.writeHead(200, {}); response.end('ok'); server.close(); }); server.listen(0, function() { testURL = url.parse(`http://localhost:${this.address().port}`); // make the request var clientRequest = http.request(testURL); // since there is a little magic with the agent // make sure that an http request uses the http.Agent assert.ok(clientRequest.agent instanceof http.Agent); clientRequest.end(); }); node-v4.8.2/test/parallel/test-http-url.parse-https.request.js000644 000766 000024 00000002155 13070706737 024572 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var https = require('https'); var url = require('url'); var fs = require('fs'); // https options var httpsOptions = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }; function check(request) { // assert that I'm https assert.ok(request.socket._secureEstablished); } var server = https.createServer(httpsOptions, function(request, response) { // run the check function check.call(this, request, response); response.writeHead(200, {}); response.end('ok'); server.close(); }); server.listen(0, function() { var testURL = url.parse(`https://localhost:${this.address().port}`); testURL.rejectUnauthorized = false; // make the request var clientRequest = https.request(testURL); // since there is a little magic with the agent // make sure that the request uses the https.Agent assert.ok(clientRequest.agent instanceof https.Agent); clientRequest.end(); }); node-v4.8.2/test/parallel/test-http-url.parse-only-support-http-https-protocol.js000644 000766 000024 00000003346 13070706737 030413 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var url = require('url'); assert.throws(function() { http.request(url.parse('file:///whatever')); }, function(err) { if (err instanceof Error) { assert.strictEqual(err.message, 'Protocol "file:" not supported.' + ' Expected "http:".'); return true; } }); assert.throws(function() { http.request(url.parse('mailto:asdf@asdf.com')); }, function(err) { if (err instanceof Error) { assert.strictEqual(err.message, 'Protocol "mailto:" not supported.' + ' Expected "http:".'); return true; } }); assert.throws(function() { http.request(url.parse('ftp://www.example.com')); }, function(err) { if (err instanceof Error) { assert.strictEqual(err.message, 'Protocol "ftp:" not supported.' + ' Expected "http:".'); return true; } }); assert.throws(function() { http.request(url.parse('javascript:alert(\'hello\');')); }, function(err) { if (err instanceof Error) { assert.strictEqual(err.message, 'Protocol "javascript:" not supported.' + ' Expected "http:".'); return true; } }); assert.throws(function() { http.request(url.parse('xmpp:isaacschlueter@jabber.org')); }, function(err) { if (err instanceof Error) { assert.strictEqual(err.message, 'Protocol "xmpp:" not supported.' + ' Expected "http:".'); return true; } }); assert.throws(function() { http.request(url.parse('f://some.host/path')); }, function(err) { if (err instanceof Error) { assert.strictEqual(err.message, 'Protocol "f:" not supported.' + ' Expected "http:".'); return true; } }); node-v4.8.2/test/parallel/test-http-url.parse-path.js000644 000766 000024 00000001120 13070706737 022664 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var url = require('url'); function check(request) { // a path should come over assert.strictEqual(request.url, '/asdf'); } var server = http.createServer(function(request, response) { // run the check function check.call(this, request, response); response.writeHead(200, {}); response.end('ok'); server.close(); }); server.listen(0, function() { var testURL = url.parse(`http://localhost:${this.address().port}/asdf`); // make the request http.request(testURL).end(); }); node-v4.8.2/test/parallel/test-http-url.parse-post.js000644 000766 000024 00000001612 13070706737 022723 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var url = require('url'); var testURL; function check(request) { //url.parse should not mess with the method assert.strictEqual(request.method, 'POST'); //everything else should be right assert.strictEqual(request.url, '/asdf?qwer=zxcv'); //the host header should use the url.parse.hostname assert.strictEqual(request.headers.host, testURL.hostname + ':' + testURL.port); } var server = http.createServer(function(request, response) { // run the check function check.call(this, request, response); response.writeHead(200, {}); response.end('ok'); server.close(); }); server.listen(0, function() { testURL = url.parse(`http://localhost:${this.address().port}/asdf?qwer=zxcv`); testURL.method = 'POST'; // make the request http.request(testURL).end(); }); node-v4.8.2/test/parallel/test-http-url.parse-search.js000644 000766 000024 00000001205 13070706737 023201 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var url = require('url'); function check(request) { // a path should come over with params assert.strictEqual(request.url, '/asdf?qwer=zxcv'); } var server = http.createServer(function(request, response) { // run the check function check.call(this, request, response); response.writeHead(200, {}); response.end('ok'); server.close(); }); server.listen(0, function() { const port = this.address().port; var testURL = url.parse(`http://localhost:${port}/asdf?qwer=zxcv`); // make the request http.request(testURL).end(); }); node-v4.8.2/test/parallel/test-http-wget.js000644 000766 000024 00000003236 13070706737 020777 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var net = require('net'); var http = require('http'); // wget sends an HTTP/1.0 request with Connection: Keep-Alive // // Sending back a chunked response to an HTTP/1.0 client would be wrong, // so what has to happen in this case is that the connection is closed // by the server after the entity body if the Content-Length was not // sent. // // If the Content-Length was sent, we can probably safely honor the // keep-alive request, even though HTTP 1.0 doesn't say that the // connection can be kept open. Presumably any client sending this // header knows that it is extending HTTP/1.0 and can handle the // response. We don't test that here however, just that if the // content-length is not provided, that the connection is in fact // closed. var server = http.createServer(function(req, res) { res.writeHead(200, {'Content-Type': 'text/plain'}); res.write('hello '); res.write('world\n'); res.end(); }); server.listen(0); server.on('listening', common.mustCall(function() { var c = net.createConnection(this.address().port); var server_response = ''; c.setEncoding('utf8'); c.on('connect', function() { c.write('GET / HTTP/1.0\r\n' + 'Connection: Keep-Alive\r\n\r\n'); }); c.on('data', function(chunk) { console.log(chunk); server_response += chunk; }); c.on('end', common.mustCall(function() { const m = server_response.split('\r\n\r\n'); assert.strictEqual(m[1], 'hello world\n'); console.log('got end'); c.end(); })); c.on('close', common.mustCall(function() { console.log('got close'); server.close(); })); })); node-v4.8.2/test/parallel/test-http-write-callbacks.js000644 000766 000024 00000003755 13070706737 023106 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var serverEndCb = false; var serverIncoming = ''; var serverIncomingExpect = 'bazquuxblerg'; var clientEndCb = false; var clientIncoming = ''; var clientIncomingExpect = 'asdffoobar'; process.on('exit', function() { assert(serverEndCb); assert.equal(serverIncoming, serverIncomingExpect); assert(clientEndCb); assert.equal(clientIncoming, clientIncomingExpect); console.log('ok'); }); // Verify that we get a callback when we do res.write(..., cb) var server = http.createServer(function(req, res) { res.statusCode = 400; res.end('Bad Request.\nMust send Expect:100-continue\n'); }); server.on('checkContinue', function(req, res) { server.close(); assert.equal(req.method, 'PUT'); res.writeContinue(function() { // continue has been written req.on('end', function() { res.write('asdf', function(er) { assert.ifError(er); res.write('foo', 'ascii', function(er) { assert.ifError(er); res.end(new Buffer('bar'), 'buffer', function(er) { serverEndCb = true; }); }); }); }); }); req.setEncoding('ascii'); req.on('data', function(c) { serverIncoming += c; }); }); server.listen(0, function() { var req = http.request({ port: this.address().port, method: 'PUT', headers: { 'expect': '100-continue' } }); req.on('continue', function() { // ok, good to go. req.write('YmF6', 'base64', function(er) { assert.ifError(er); req.write(new Buffer('quux'), function(er) { assert.ifError(er); req.end('626c657267', 'hex', function(er) { assert.ifError(er); clientEndCb = true; }); }); }); }); req.on('response', function(res) { // this should not come until after the end is flushed out assert(clientEndCb); res.setEncoding('ascii'); res.on('data', function(c) { clientIncoming += c; }); }); }); node-v4.8.2/test/parallel/test-http-write-empty-string.js000644 000766 000024 00000001464 13070706737 023624 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var http = require('http'); var server = http.createServer(function(request, response) { console.log('responding to ' + request.url); response.writeHead(200, {'Content-Type': 'text/plain'}); response.write('1\n'); response.write(''); response.write('2\n'); response.write(''); response.end('3\n'); this.close(); }); server.listen(0, common.mustCall(function() { http.get({ port: this.address().port }, common.mustCall(function(res) { var response = ''; assert.equal(200, res.statusCode); res.setEncoding('ascii'); res.on('data', function(chunk) { response += chunk; }); res.on('end', common.mustCall(function() { assert.strictEqual('1\n2\n3\n', response); })); })); })); node-v4.8.2/test/parallel/test-http-write-head.js000644 000766 000024 00000002265 13070706737 022063 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); // Verify that ServerResponse.writeHead() works as setHeader. // Issue 5036 on github. var s = http.createServer(function(req, res) { res.setHeader('test', '1'); // toLowerCase() is used on the name argument, so it must be a string. var threw = false; try { res.setHeader(0xf00, 'bar'); } catch (e) { assert.ok(e instanceof TypeError); threw = true; } assert.ok(threw, 'Non-string names should throw'); // undefined value should throw, via 979d0ca8 threw = false; try { res.setHeader('foo', undefined); } catch (e) { assert.ok(e instanceof Error); assert.equal(e.message, '`value` required in setHeader("foo", value).'); threw = true; } assert.ok(threw, 'Undefined value should throw'); res.writeHead(200, { Test: '2' }); res.end(); }); s.listen(0, runTest); function runTest() { http.get({ port: this.address().port }, function(response) { response.on('end', function() { assert.equal(response.headers['test'], '2'); assert(response.rawHeaders.indexOf('Test') !== -1); s.close(); }); response.resume(); }); } node-v4.8.2/test/parallel/test-http-zero-length-write.js000644 000766 000024 00000002722 13070706737 023416 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var http = require('http'); var Stream = require('stream'); function getSrc() { // An old-style readable stream. // The Readable class prevents this behavior. var src = new Stream(); // start out paused, just so we don't miss anything yet. var paused = false; src.pause = function() { paused = true; }; src.resume = function() { paused = false; }; var chunks = [ '', 'asdf', '', 'foo', '', 'bar', '' ]; var interval = setInterval(function() { if (paused) return; var chunk = chunks.shift(); if (chunk !== undefined) { src.emit('data', chunk); } else { src.emit('end'); clearInterval(interval); } }, 1); return src; } var expect = 'asdffoobar'; var server = http.createServer(function(req, res) { var actual = ''; req.setEncoding('utf8'); req.on('data', function(c) { actual += c; }); req.on('end', function() { assert.equal(actual, expect); getSrc().pipe(res); }); server.close(); }); server.listen(0, function() { var req = http.request({ port: this.address().port, method: 'POST' }); var actual = ''; req.on('response', function(res) { res.setEncoding('utf8'); res.on('data', function(c) { actual += c; }); res.on('end', function() { assert.equal(actual, expect); }); }); getSrc().pipe(req); }); process.on('exit', function(c) { if (!c) console.log('ok'); }); node-v4.8.2/test/parallel/test-http.js000644 000766 000024 00000004425 13070706737 020034 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const http = require('http'); const url = require('url'); var responses_sent = 0; var responses_recvd = 0; var body0 = ''; var body1 = ''; const server = http.Server(function(req, res) { if (responses_sent === 0) { assert.strictEqual('GET', req.method); assert.strictEqual('/hello', url.parse(req.url).pathname); console.dir(req.headers); assert.strictEqual(true, 'accept' in req.headers); assert.strictEqual('*/*', req.headers['accept']); assert.strictEqual(true, 'foo' in req.headers); assert.strictEqual('bar', req.headers['foo']); } if (responses_sent === 1) { assert.strictEqual('POST', req.method); assert.strictEqual('/world', url.parse(req.url).pathname); this.close(); } req.on('end', function() { res.writeHead(200, {'Content-Type': 'text/plain'}); res.write('The path was ' + url.parse(req.url).pathname); res.end(); responses_sent += 1; }); req.resume(); //assert.equal('127.0.0.1', res.connection.remoteAddress); }); server.listen(0); server.on('listening', function() { const agent = new http.Agent({ port: this.address().port, maxSockets: 1 }); http.get({ port: this.address().port, path: '/hello', headers: {'Accept': '*/*', 'Foo': 'bar'}, agent: agent }, function(res) { assert.strictEqual(200, res.statusCode); responses_recvd += 1; res.setEncoding('utf8'); res.on('data', function(chunk) { body0 += chunk; }); console.error('Got /hello response'); }); setTimeout(function() { const req = http.request({ port: server.address().port, method: 'POST', path: '/world', agent: agent }, function(res) { assert.strictEqual(200, res.statusCode); responses_recvd += 1; res.setEncoding('utf8'); res.on('data', function(chunk) { body1 += chunk; }); console.error('Got /world response'); }); req.end(); }, 1); }); process.on('exit', function() { console.error('responses_recvd: ' + responses_recvd); assert.strictEqual(2, responses_recvd); console.error('responses_sent: ' + responses_sent); assert.strictEqual(2, responses_sent); assert.strictEqual('The path was /hello', body0); assert.strictEqual('The path was /world', body1); }); node-v4.8.2/test/parallel/test-https-agent-servername.js000644 000766 000024 00000001536 13070706737 023460 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var https = require('https'); var fs = require('fs'); var options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem'), ca: fs.readFileSync(common.fixturesDir + '/keys/ca1-cert.pem') }; var server = https.Server(options, function(req, res) { res.writeHead(200); res.end('hello world\n'); }); server.listen(0, function() { https.get({ path: '/', port: this.address().port, rejectUnauthorized: true, servername: 'agent1', ca: options.ca }, function(res) { res.resume(); console.log(res.statusCode); server.close(); }).on('error', function(e) { console.log(e.message); process.exit(1); }); }); node-v4.8.2/test/parallel/test-https-agent-session-eviction.js000644 000766 000024 00000003545 13070706737 024614 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const assert = require('assert'); const https = require('https'); const fs = require('fs'); const constants = require('constants'); const options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem'), secureOptions: constants.SSL_OP_NO_TICKET }; // Create TLS1.2 server https.createServer(options, function(req, res) { res.end('ohai'); }).listen(0, function() { first(this); }); // Do request and let agent cache the session function first(server) { const port = server.address().port; const req = https.request({ port: port, rejectUnauthorized: false }, function(res) { res.resume(); server.close(function() { faultyServer(port); }); }); req.end(); } // Create TLS1 server function faultyServer(port) { options.secureProtocol = 'TLSv1_method'; https.createServer(options, function(req, res) { res.end('hello faulty'); }).listen(port, function() { second(this); }); } // Attempt to request using cached session function second(server, session) { const req = https.request({ port: server.address().port, rejectUnauthorized: false }, function(res) { res.resume(); }); // Let it fail req.on('error', common.mustCall(function(err) { assert(/wrong version number/.test(err.message)); req.on('close', function() { third(server); }); })); req.end(); } // Try one more time - session should be evicted! function third(server) { const req = https.request({ port: server.address().port, rejectUnauthorized: false }, function(res) { res.resume(); assert(!req.socket.isSessionReused()); server.close(); }); req.on('error', common.fail); req.end(); } node-v4.8.2/test/parallel/test-https-agent-session-reuse.js000644 000766 000024 00000006201 13070706737 024107 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const https = require('https'); const crypto = require('crypto'); const fs = require('fs'); const options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }; const ca = fs.readFileSync(common.fixturesDir + '/keys/ca1-cert.pem'); const clientSessions = {}; let serverRequests = 0; const agent = new https.Agent({ maxCachedSessions: 1 }); const server = https.createServer(options, function(req, res) { if (req.url === '/drop-key') server.setTicketKeys(crypto.randomBytes(48)); serverRequests++; res.end('ok'); }).listen(0, function() { const queue = [ { name: 'first', method: 'GET', path: '/', servername: 'agent1', ca: ca, port: this.address().port }, { name: 'first-reuse', method: 'GET', path: '/', servername: 'agent1', ca: ca, port: this.address().port }, { name: 'cipher-change', method: 'GET', path: '/', servername: 'agent1', // Choose different cipher to use different cache entry ciphers: 'AES256-SHA', ca: ca, port: this.address().port }, // Change the ticket key to ensure session is updated in cache { name: 'before-drop', method: 'GET', path: '/drop-key', servername: 'agent1', ca: ca, port: this.address().port }, // Ticket will be updated starting from this { name: 'after-drop', method: 'GET', path: '/', servername: 'agent1', ca: ca, port: this.address().port }, { name: 'after-drop-reuse', method: 'GET', path: '/', servername: 'agent1', ca: ca, port: this.address().port } ]; function request() { const options = queue.shift(); options.agent = agent; https.request(options, function(res) { clientSessions[options.name] = res.socket.getSession(); res.resume(); res.on('end', function() { if (queue.length !== 0) return request(); server.close(); }); }).end(); } request(); }); process.on('exit', function() { assert.strictEqual(serverRequests, 6); assert.strictEqual(clientSessions['first'].toString('hex'), clientSessions['first-reuse'].toString('hex')); assert.notEqual(clientSessions['first'].toString('hex'), clientSessions['cipher-change'].toString('hex')); assert.notEqual(clientSessions['first'].toString('hex'), clientSessions['before-drop'].toString('hex')); assert.notEqual(clientSessions['cipher-change'].toString('hex'), clientSessions['before-drop'].toString('hex')); assert.notEqual(clientSessions['before-drop'].toString('hex'), clientSessions['after-drop'].toString('hex')); assert.strictEqual(clientSessions['after-drop'].toString('hex'), clientSessions['after-drop-reuse'].toString('hex')); }); node-v4.8.2/test/parallel/test-https-agent-sni.js000644 000766 000024 00000002117 13070706737 022076 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const https = require('https'); const fs = require('fs'); const options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }; const TOTAL = 4; var waiting = TOTAL; const server = https.Server(options, function(req, res) { if (--waiting === 0) server.close(); res.writeHead(200, { 'x-sni': req.socket.servername }); res.end('hello world'); }); server.listen(0, function() { function expectResponse(id) { return common.mustCall(function(res) { res.resume(); assert.equal(res.headers['x-sni'], 'sni.' + id); }); } var agent = new https.Agent({ maxSockets: 1 }); for (var j = 0; j < TOTAL; j++) { https.get({ agent: agent, path: '/', port: this.address().port, host: '127.0.0.1', servername: 'sni.' + j, rejectUnauthorized: false }, expectResponse(j)); } }); node-v4.8.2/test/parallel/test-https-agent-sockets-leak.js000644 000766 000024 00000002635 13070706737 023677 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const fs = require('fs'); const https = require('https'); const assert = require('assert'); const options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem'), ca: fs.readFileSync(common.fixturesDir + '/keys/ca1-cert.pem') }; const server = https.Server(options, common.mustCall((req, res) => { res.writeHead(200); res.end('https\n'); })); const agent = new https.Agent({ keepAlive: false }); server.listen(0, common.mustCall(() => { https.get({ host: server.address().host, port: server.address().port, headers: {host: 'agent1'}, rejectUnauthorized: true, ca: options.ca, agent: agent }, common.mustCall((res) => { res.resume(); server.close(); // Only one entry should exist in agent.sockets pool // If there are more entries in agent.sockets, // removeSocket will not delete them resulting in a resource leak assert.strictEqual(Object.keys(agent.sockets).length, 1); res.req.on('close', common.mustCall(() => { // To verify that no leaks occur, check that no entries // exist in agent.sockets pool after both request and socket // has been closed. assert.strictEqual(Object.keys(agent.sockets).length, 0); })); })); })); node-v4.8.2/test/parallel/test-https-agent.js000644 000766 000024 00000002125 13070706737 021306 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const https = require('https'); const fs = require('fs'); const options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }; const server = https.Server(options, function(req, res) { res.writeHead(200); res.end('hello world\n'); }); var responses = 0; const N = 4; const M = 4; server.listen(0, function() { for (var i = 0; i < N; i++) { setTimeout(function() { for (var j = 0; j < M; j++) { https.get({ path: '/', port: server.address().port, rejectUnauthorized: false }, function(res) { res.resume(); assert.strictEqual(res.statusCode, 200); if (++responses === N * M) server.close(); }).on('error', function(e) { throw e; }); } }, i); } }); process.on('exit', function() { assert.strictEqual(N * M, responses); }); node-v4.8.2/test/parallel/test-https-byteswritten.js000644 000766 000024 00000001524 13070706737 022755 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var fs = require('fs'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var https = require('https'); var options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }; var body = 'hello world\n'; var httpsServer = https.createServer(options, function(req, res) { res.on('finish', function() { assert(typeof req.connection.bytesWritten === 'number'); assert(req.connection.bytesWritten > 0); httpsServer.close(); console.log('ok'); }); res.writeHead(200, { 'Content-Type': 'text/plain' }); res.end(body); }); httpsServer.listen(0, function() { https.get({ port: this.address().port, rejectUnauthorized: false }); }); node-v4.8.2/test/parallel/test-https-client-checkServerIdentity.js000644 000766 000024 00000002521 13070706737 025442 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var https = require('https'); var fs = require('fs'); var path = require('path'); var options = { key: fs.readFileSync(path.join(common.fixturesDir, 'keys/agent3-key.pem')), cert: fs.readFileSync(path.join(common.fixturesDir, 'keys/agent3-cert.pem')) }; var server = https.createServer(options, common.mustCall(function(req, res) { res.writeHead(200); res.end(); req.resume(); })).listen(0, function() { authorized(); }); function authorized() { var req = https.request({ port: server.address().port, rejectUnauthorized: true, ca: [fs.readFileSync(path.join(common.fixturesDir, 'keys/ca2-cert.pem'))] }, common.fail); req.on('error', function(err) { override(); }); req.end(); } function override() { var options = { port: server.address().port, rejectUnauthorized: true, ca: [fs.readFileSync(path.join(common.fixturesDir, 'keys/ca2-cert.pem'))], checkServerIdentity: function(host, cert) { return false; } }; options.agent = new https.Agent(options); var req = https.request(options, function(res) { assert(req.socket.authorized); server.close(); }); req.on('error', function(err) { throw err; }); req.end(); } node-v4.8.2/test/parallel/test-https-client-get-url.js000644 000766 000024 00000001512 13070706737 023042 0ustar00iojsstaff000000 000000 'use strict'; // disable strict server certificate validation by the client process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var https = require('https'); var fs = require('fs'); var options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }; var server = https.createServer(options, common.mustCall(function(req, res) { assert.equal('GET', req.method); assert.equal('/foo?bar', req.url); res.writeHead(200, {'Content-Type': 'text/plain'}); res.write('hello\n'); res.end(); server.close(); })); server.listen(0, function() { https.get(`https://127.0.0.1:${this.address().port}/foo?bar`); }); node-v4.8.2/test/parallel/test-https-client-reject.js000644 000766 000024 00000002741 13070706737 022744 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var https = require('https'); var fs = require('fs'); var path = require('path'); var options = { key: fs.readFileSync(path.join(common.fixturesDir, 'test_key.pem')), cert: fs.readFileSync(path.join(common.fixturesDir, 'test_cert.pem')) }; var server = https.createServer(options, common.mustCall(function(req, res) { res.writeHead(200); res.end(); req.resume(); }, 2)).listen(0, function() { unauthorized(); }); function unauthorized() { var req = https.request({ port: server.address().port, rejectUnauthorized: false }, function(res) { assert(!req.socket.authorized); res.resume(); rejectUnauthorized(); }); req.on('error', function(err) { throw err; }); req.end(); } function rejectUnauthorized() { var options = { port: server.address().port }; options.agent = new https.Agent(options); var req = https.request(options, common.fail); req.on('error', function(err) { authorized(); }); req.end(); } function authorized() { var options = { port: server.address().port, ca: [fs.readFileSync(path.join(common.fixturesDir, 'test_cert.pem'))] }; options.agent = new https.Agent(options); var req = https.request(options, function(res) { res.resume(); assert(req.socket.authorized); server.close(); }); req.on('error', common.fail); req.end(); } node-v4.8.2/test/parallel/test-https-client-resume.js000644 000766 000024 00000003242 13070706737 022765 0ustar00iojsstaff000000 000000 'use strict'; // Create an ssl server. First connection, validate that not resume. // Cache session and close connection. Use session on second connection. // ASSERT resumption. var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var https = require('https'); var tls = require('tls'); var fs = require('fs'); var options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent2-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent2-cert.pem') }; // create server var server = https.createServer(options, common.mustCall(function(req, res) { res.end('Goodbye'); }, 2)); // start listening server.listen(0, function() { var session1 = null; var client1 = tls.connect({ port: this.address().port, rejectUnauthorized: false }, function() { console.log('connect1'); assert.ok(!client1.isSessionReused(), 'Session *should not* be reused.'); session1 = client1.getSession(); client1.write('GET / HTTP/1.0\r\n' + 'Server: 127.0.0.1\r\n' + '\r\n'); }); client1.on('close', function() { console.log('close1'); var opts = { port: server.address().port, rejectUnauthorized: false, session: session1 }; var client2 = tls.connect(opts, function() { console.log('connect2'); assert.ok(client2.isSessionReused(), 'Session *should* be reused.'); client2.write('GET / HTTP/1.0\r\n' + 'Server: 127.0.0.1\r\n' + '\r\n'); }); client2.on('close', function() { console.log('close2'); server.close(); }); }); }); node-v4.8.2/test/parallel/test-https-close.js000644 000766 000024 00000002347 13070706737 021323 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const fs = require('fs'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const https = require('https'); const options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }; var connections = {}; var server = https.createServer(options, function(req, res) { var interval = setInterval(function() { res.write('data'); }, 1000); interval.unref(); }); server.on('connection', function(connection) { var key = connection.remoteAddress + ':' + connection.remotePort; connection.on('close', function() { delete connections[key]; }); connections[key] = connection; }); function shutdown() { server.close(common.mustCall(function() {})); for (var key in connections) { connections[key].destroy(); delete connections[key]; } } server.listen(0, function() { var requestOptions = { hostname: '127.0.0.1', port: this.address().port, path: '/', method: 'GET', rejectUnauthorized: false }; var req = https.request(requestOptions, function(res) { res.on('data', function(d) {}); setImmediate(shutdown); }); req.end(); }); node-v4.8.2/test/parallel/test-https-connect-address-family.js000644 000766 000024 00000002220 13070706737 024537 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); if (!common.hasIPv6) { common.skip('no IPv6 support'); return; } const assert = require('assert'); const https = require('https'); const dns = require('dns'); function runTest() { const ciphers = 'AECDH-NULL-SHA'; https.createServer({ ciphers }, common.mustCall(function(req, res) { this.close(); res.end(); })).listen(common.PORT, '::1', common.mustCall(function() { const options = { host: 'localhost', port: common.PORT, family: 6, ciphers: ciphers, rejectUnauthorized: false, }; // Will fail with ECONNREFUSED if the address family is not honored. https.get(options, common.mustCall(function() { assert.strictEqual('::1', this.socket.remoteAddress); this.destroy(); })); })); } dns.lookup('localhost', {family: 6, all: true}, (err, addresses) => { if (err) { if (err.code === 'ENOTFOUND') { common.skip('localhost does not resolve to ::1'); return; } throw err; } if (addresses.some((val) => val.address === '::1')) runTest(); else common.skip('localhost does not resolve to ::1'); }); node-v4.8.2/test/parallel/test-https-connecting-to-http.js000644 000766 000024 00000001123 13070706737 023731 0ustar00iojsstaff000000 000000 'use strict'; // This tests the situation where you try to connect a https client // to an http server. You should get an error and exit. var common = require('../common'); var http = require('http'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var https = require('https'); var server = http.createServer(common.fail); server.listen(0, common.mustCall(function() { var req = https.get({ port: this.address().port }, common.fail); req.on('error', common.mustCall(function(e) { console.log('Got expected error: ', e.message); server.close(); })); })); node-v4.8.2/test/parallel/test-https-drain.js000644 000766 000024 00000003165 13070706737 021312 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var https = require('https'); var fs = require('fs'); var path = require('path'); var options = { key: fs.readFileSync(path.join(common.fixturesDir, 'test_key.pem')), cert: fs.readFileSync(path.join(common.fixturesDir, 'test_cert.pem')) }; var bufSize = 1024 * 1024; var sent = 0; var received = 0; var server = https.createServer(options, function(req, res) { res.writeHead(200); req.pipe(res); }); server.listen(0, function() { var resumed = false; var req = https.request({ method: 'POST', port: this.address().port, rejectUnauthorized: false }, function(res) { var timer; res.pause(); console.error('paused'); send(); function send() { if (req.write(new Buffer(bufSize))) { sent += bufSize; assert.ok(sent < 100 * 1024 * 1024); // max 100MB return process.nextTick(send); } sent += bufSize; console.error('sent: ' + sent); resumed = true; res.resume(); console.error('resumed'); timer = setTimeout(function() { process.exit(1); }, 1000); } res.on('data', function(data) { assert.ok(resumed); if (timer) { clearTimeout(timer); timer = null; } received += data.length; if (received >= sent) { console.error('received: ' + received); req.end(); server.close(); } }); }); req.write('a'); ++sent; }); process.on('exit', function() { assert.equal(sent, received); }); node-v4.8.2/test/parallel/test-https-eof-for-eom.js000644 000766 000024 00000003722 13070706737 022327 0ustar00iojsstaff000000 000000 'use strict'; // I hate HTTP. One way of terminating an HTTP response is to not send // a content-length header, not send a transfer-encoding: chunked header, // and simply terminate the TCP connection. That is identity // transfer-encoding. // // This test is to be sure that the https client is handling this case // correctly. var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var https = require('https'); var tls = require('tls'); var fs = require('fs'); var options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }; var server = tls.Server(options, function(socket) { console.log('2) Server got request'); socket.write('HTTP/1.1 200 OK\r\n' + 'Date: Tue, 15 Feb 2011 22:14:54 GMT\r\n' + 'Expires: -1\r\n' + 'Cache-Control: private, max-age=0\r\n' + 'Set-Cookie: xyz\r\n' + 'Set-Cookie: abc\r\n' + 'Server: gws\r\n' + 'X-XSS-Protection: 1; mode=block\r\n' + 'Connection: close\r\n' + '\r\n'); socket.write('hello world\n'); setTimeout(function() { socket.end('hello world\n'); console.log('4) Server finished response'); }, 100); }); server.listen(0, common.mustCall(function() { console.log('1) Making Request'); https.get({ port: this.address().port, rejectUnauthorized: false }, common.mustCall(function(res) { var bodyBuffer = ''; server.close(); console.log('3) Client got response headers.'); assert.equal('gws', res.headers.server); res.setEncoding('utf8'); res.on('data', function(s) { bodyBuffer += s; }); res.on('end', common.mustCall(function() { console.log('5) Client got "end" event.'); assert.strictEqual('hello world\nhello world\n', bodyBuffer); })); })); })); node-v4.8.2/test/parallel/test-https-foafssl.js000644 000766 000024 00000004606 13070706737 021653 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); if (!common.opensslCli) { common.skip('node compiled without OpenSSL CLI.'); return; } var assert = require('assert'); var join = require('path').join; var fs = require('fs'); var spawn = require('child_process').spawn; if (!common.hasCrypto) { common.skip('missing crypto'); return; } var https = require('https'); var options = { key: fs.readFileSync(common.fixturesDir + '/agent.key'), cert: fs.readFileSync(common.fixturesDir + '/agent.crt'), requestCert: true }; const modulus = 'A6F44A9C25791431214F5C87AF9E040177A8BB89AC803F7E09BBC3A5519F' + '349CD9B9C40BE436D0AA823A94147E26C89248ADA2BE3DD4D34E8C289646' + '94B2047D217B4F1299371EA93A83C89AB9440724131E65F2B0161DE9560C' + 'DE9C13455552B2F49CF0FB00D8D77532324913F6F80FF29D0A131D29DB06' + 'AFF8BE191B7920DC2DAE1C26EA82A47847A10391EF3BF6AABB3CC40FF821' + '00B03A4F0FF1809278E4DDFDA7DE954ED56DC7AD9A47EEBC37D771A366FC' + '60A5BCB72373BEC180649B3EFA0E9092707210B41B90032BB18BC91F2046' + 'EBDAF1191F4A4E26D71879C4C7867B62FCD508E8CE66E82D128A71E91580' + '9FCF44E8DE774067F1DE5D70B9C03687'; var CRLF = '\r\n'; var body = 'hello world\n'; var cert; var server = https.createServer(options, common.mustCall(function(req, res) { console.log('got request'); cert = req.connection.getPeerCertificate(); assert.strictEqual(cert.subjectaltname, 'URI:http://example.com/#me'); assert.strictEqual(cert.exponent, '0x10001'); assert.strictEqual(cert.modulus, modulus); res.writeHead(200, { 'content-type': 'text/plain' }); res.end(body); })); server.listen(0, function() { var args = ['s_client', '-quiet', '-connect', `127.0.0.1:${this.address().port}`, '-cert', join(common.fixturesDir, 'foafssl.crt'), '-key', join(common.fixturesDir, 'foafssl.key')]; // for the performance and stability issue in s_client on Windows if (common.isWindows) args.push('-no_rand_screen'); var client = spawn(common.opensslCli, args); client.stdout.on('data', function(data) { var message = data.toString(); var contents = message.split(CRLF + CRLF).pop(); assert.equal(body, contents); server.close(); }); client.stdin.write('GET /\n\n'); client.on('error', function(error) { throw error; }); }); node-v4.8.2/test/parallel/test-https-host-headers.js000644 000766 000024 00000005215 13070706737 022601 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var https = require('https'); const fs = require('fs'); const options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }; const httpsServer = https.createServer(options, reqHandler); function reqHandler(req, res) { console.log('Got request: ' + req.headers.host + ' ' + req.url); if (req.url === '/setHostFalse5') { assert.equal(req.headers.host, undefined); } else { assert.equal(req.headers.host, `localhost:${this.address().port}`, 'Wrong host header for req[' + req.url + ']: ' + req.headers.host); } res.writeHead(200, {}); //process.nextTick(function() { res.end('ok'); }); res.end('ok'); } function thrower(er) { throw er; } testHttps(); function testHttps() { var counter = 0; function cb(res) { counter--; console.log('back from https request. counter = ' + counter); if (counter === 0) { httpsServer.close(); console.log('ok'); } res.resume(); } httpsServer.listen(0, function(er) { console.log(`test https server listening on port ${this.address().port}`); if (er) throw er; https.get({ method: 'GET', path: '/' + (counter++), host: 'localhost', //agent: false, port: this.address().port, rejectUnauthorized: false }, cb).on('error', thrower); https.request({ method: 'GET', path: '/' + (counter++), host: 'localhost', //agent: false, port: this.address().port, rejectUnauthorized: false }, cb).on('error', thrower).end(); https.request({ method: 'POST', path: '/' + (counter++), host: 'localhost', //agent: false, port: this.address().port, rejectUnauthorized: false }, cb).on('error', thrower).end(); https.request({ method: 'PUT', path: '/' + (counter++), host: 'localhost', //agent: false, port: this.address().port, rejectUnauthorized: false }, cb).on('error', thrower).end(); https.request({ method: 'DELETE', path: '/' + (counter++), host: 'localhost', //agent: false, port: this.address().port, rejectUnauthorized: false }, cb).on('error', thrower).end(); https.get({ method: 'GET', path: '/setHostFalse' + (counter++), host: 'localhost', setHost: false, port: this.address().port, rejectUnauthorized: false }, cb).on('error', thrower).end(); }); } node-v4.8.2/test/parallel/test-https-localaddress-bind-error.js000644 000766 000024 00000002105 13070706737 024707 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var fs = require('fs'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var https = require('https'); var options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }; var invalidLocalAddress = '1.2.3.4'; var server = https.createServer(options, function(req, res) { console.log('Connect from: ' + req.connection.remoteAddress); req.on('end', function() { res.writeHead(200, { 'Content-Type': 'text/plain' }); res.end('You are from: ' + req.connection.remoteAddress); }); req.resume(); }); server.listen(0, '127.0.0.1', common.mustCall(function() { https.request({ host: 'localhost', port: this.address().port, path: '/', method: 'GET', localAddress: invalidLocalAddress }, function(res) { common.fail('unexpectedly got response from server'); }).on('error', common.mustCall(function(e) { console.log('client got error: ' + e.message); server.close(); })).end(); })); node-v4.8.2/test/parallel/test-https-localaddress.js000644 000766 000024 00000002277 13070706737 022660 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const fs = require('fs'); const assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var https = require('https'); if (!common.hasMultiLocalhost()) { common.skip('platform-specific test.'); return; } var options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }; var server = https.createServer(options, function(req, res) { console.log('Connect from: ' + req.connection.remoteAddress); assert.equal('127.0.0.2', req.connection.remoteAddress); req.on('end', function() { res.writeHead(200, { 'Content-Type': 'text/plain' }); res.end('You are from: ' + req.connection.remoteAddress); }); req.resume(); }); server.listen(0, '127.0.0.1', function() { var options = { host: 'localhost', port: this.address().port, path: '/', method: 'GET', localAddress: '127.0.0.2', rejectUnauthorized: false }; var req = https.request(options, function(res) { res.on('end', function() { server.close(); process.exit(); }); res.resume(); }); req.end(); }); node-v4.8.2/test/parallel/test-https-pfx.js000644 000766 000024 00000002017 13070706737 021005 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var fs = require('fs'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var https = require('https'); var pfx = fs.readFileSync(common.fixturesDir + '/test_cert.pfx'); var options = { host: '127.0.0.1', port: undefined, path: '/', pfx: pfx, passphrase: 'sample', requestCert: true, rejectUnauthorized: false }; var server = https.createServer(options, function(req, res) { assert.equal(req.socket.authorized, false); // not a client cert assert.equal(req.socket.authorizationError, 'DEPTH_ZERO_SELF_SIGNED_CERT'); res.writeHead(200); res.end('OK'); }); server.listen(0, options.host, common.mustCall(function() { options.port = this.address().port; https.get(options, common.mustCall(function(res) { var data = ''; res.on('data', function(data_) { data += data_; }); res.on('end', common.mustCall(function() { assert.strictEqual(data, 'OK'); server.close(); })); })); })); node-v4.8.2/test/parallel/test-https-req-split.js000644 000766 000024 00000002066 13070706737 022134 0ustar00iojsstaff000000 000000 'use strict'; // disable strict server certificate validation by the client process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0'; var common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var https = require('https'); var tls = require('tls'); var fs = require('fs'); var options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }; // Force splitting incoming data tls.SLAB_BUFFER_SIZE = 1; var server = https.createServer(options); server.on('upgrade', common.mustCall(function(req, socket, upgrade) { socket.on('data', function(data) { throw new Error('Unexpected data: ' + data); }); socket.end('HTTP/1.1 200 Ok\r\n\r\n'); })); server.listen(0, function() { var req = https.request({ host: '127.0.0.1', port: this.address().port, agent: false, headers: { Connection: 'Upgrade', Upgrade: 'Websocket' } }, function() { req.socket.destroy(); server.close(); }); req.end(); }); node-v4.8.2/test/parallel/test-https-resume-after-renew.js000644 000766 000024 00000002354 13070706737 023731 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var fs = require('fs'); var https = require('https'); var crypto = require('crypto'); var options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem'), ca: fs.readFileSync(common.fixturesDir + '/keys/ca1-cert.pem') }; var server = https.createServer(options, function(req, res) { res.end('hello'); }); var aes = new Buffer(16); aes.fill('S'); var hmac = new Buffer(16); hmac.fill('H'); server._sharedCreds.context.enableTicketKeyCallback(); server._sharedCreds.context.onticketkeycallback = function(name, iv, enc) { if (enc) { var newName = new Buffer(16); var newIV = crypto.randomBytes(16); newName.fill('A'); } else { // Renew return [ 2, hmac, aes ]; } return [ 1, hmac, aes, newName, newIV ]; }; server.listen(0, function() { var addr = this.address(); function doReq(callback) { https.request({ method: 'GET', port: addr.port, servername: 'agent1', ca: options.ca }, function(res) { res.resume(); res.once('end', callback); }).end(); } doReq(function() { doReq(function() { server.close(); }); }); }); node-v4.8.2/test/parallel/test-https-set-timeout-server.js000644 000766 000024 00000010540 13070706737 023773 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var https = require('https'); var tls = require('tls'); var fs = require('fs'); var tests = []; var serverOptions = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }; function test(fn) { if (!tests.length) process.nextTick(run); tests.push(fn); } function run() { var fn = tests.shift(); if (fn) { console.log('# %s', fn.name); fn(run); } else { console.log('ok'); } } test(function serverTimeout(cb) { var server = https.createServer(serverOptions, function(req, res) { // just do nothing, we should get a timeout event. }); server.listen(0, common.mustCall(function() { var s = server.setTimeout(50, common.mustCall(function(socket) { socket.destroy(); server.close(); cb(); })); assert.ok(s instanceof https.Server); https.get({ port: this.address().port, rejectUnauthorized: false }).on('error', function() {}); })); }); test(function serverRequestTimeout(cb) { function handler(req, res) { // just do nothing, we should get a timeout event. req.setTimeout(50, common.mustCall(function() { req.socket.destroy(); server.close(); cb(); })); } var server = https.createServer(serverOptions, common.mustCall(handler)); server.listen(0, function() { var req = https.request({ port: this.address().port, method: 'POST', rejectUnauthorized: false }); req.on('error', function() {}); req.write('Hello'); // req is in progress }); }); test(function serverResponseTimeout(cb) { function handler(req, res) { // just do nothing, we should get a timeout event. res.setTimeout(50, common.mustCall(function() { res.socket.destroy(); server.close(); cb(); })); } var server = https.createServer(serverOptions, common.mustCall(handler)); server.listen(0, function() { https.get({ port: this.address().port, rejectUnauthorized: false }).on('error', function() {}); }); }); test(function serverRequestNotTimeoutAfterEnd(cb) { function handler(req, res) { // just do nothing, we should get a timeout event. req.setTimeout(50, common.fail); res.on('timeout', common.mustCall(function(socket) {})); } var server = https.createServer(serverOptions, common.mustCall(handler)); server.on('timeout', function(socket) { socket.destroy(); server.close(); cb(); }); server.listen(0, function() { https.get({ port: this.address().port, rejectUnauthorized: false }).on('error', function() {}); }); }); test(function serverResponseTimeoutWithPipeline(cb) { var caughtTimeout = ''; process.on('exit', function() { assert.equal(caughtTimeout, '/2'); }); var server = https.createServer(serverOptions, function(req, res) { res.setTimeout(50, function() { caughtTimeout += req.url; }); if (req.url === '/1') res.end(); }); server.on('timeout', function(socket) { socket.destroy(); server.close(); cb(); }); server.listen(0, function() { var options = { port: this.address().port, allowHalfOpen: true, rejectUnauthorized: false }; var c = tls.connect(options, function() { c.write('GET /1 HTTP/1.1\r\nHost: localhost\r\n\r\n'); c.write('GET /2 HTTP/1.1\r\nHost: localhost\r\n\r\n'); c.write('GET /3 HTTP/1.1\r\nHost: localhost\r\n\r\n'); }); }); }); test(function idleTimeout(cb) { var server = https.createServer(serverOptions, common.mustCall(function(req, res) { req.on('timeout', common.fail); res.on('timeout', common.fail); res.end(); })); server.setTimeout(50, common.mustCall(function(socket) { socket.destroy(); server.close(); cb(); })); server.listen(0, function() { var options = { port: this.address().port, allowHalfOpen: true, rejectUnauthorized: false }; tls.connect(options, function() { this.write('GET /1 HTTP/1.1\r\nHost: localhost\r\n\r\n'); // Keep-Alive }); }); }); node-v4.8.2/test/parallel/test-https-simple.js000644 000766 000024 00000004113 13070706737 021500 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const assert = require('assert'); const https = require('https'); const fs = require('fs'); const options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }; const tests = 2; let successful = 0; const testSucceeded = function() { successful = successful + 1; if (successful === tests) { server.close(); } }; const body = 'hello world\n'; const serverCallback = common.mustCall(function(req, res) { res.writeHead(200, { 'content-type': 'text/plain' }); res.end(body); }); const server = https.createServer(options, serverCallback); server.listen(0, function() { // Do a request ignoring the unauthorized server certs const noCertCheckOptions = { hostname: '127.0.0.1', port: this.address().port, path: '/', method: 'GET', rejectUnauthorized: false }; noCertCheckOptions.Agent = new https.Agent(noCertCheckOptions); const req = https.request(noCertCheckOptions, function(res) { let responseBody = ''; res.on('data', function(d) { responseBody = responseBody + d; }); res.on('end', function() { assert.equal(responseBody, body); testSucceeded(); }); }); req.end(); req.on('error', function(e) { throw e; }); // Do a request that throws error due to the invalid server certs const checkCertOptions = { hostname: '127.0.0.1', port: this.address().port, path: '/', method: 'GET' }; const checkCertReq = https.request(checkCertOptions, function(res) { res.on('data', function() { throw new Error('data should not be received'); }); res.on('end', function() { throw new Error('connection should not be established'); }); }); checkCertReq.end(); checkCertReq.on('error', function(e) { assert.equal(e.code, 'UNABLE_TO_VERIFY_LEAF_SIGNATURE'); testSucceeded(); }); }); process.on('exit', function() { assert.equal(successful, tests); }); node-v4.8.2/test/parallel/test-https-socket-options.js000644 000766 000024 00000003170 13070706737 023172 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var https = require('https'); var fs = require('fs'); var http = require('http'); var options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }; var body = 'hello world\n'; // Try first with http server var server_http = http.createServer(function(req, res) { console.log('got HTTP request'); res.writeHead(200, { 'content-type': 'text/plain' }); res.end(body); }); server_http.listen(0, function() { var req = http.request({ port: this.address().port, rejectUnauthorized: false }, function(res) { server_http.close(); res.resume(); }); // These methods should exist on the request and get passed down to the socket req.setNoDelay(true); req.setTimeout(1000, function() { }); req.setSocketKeepAlive(true, 1000); req.end(); }); // Then try https server (requires functions to be // mirroed in tls.js's CryptoStream) var server_https = https.createServer(options, function(req, res) { console.log('got HTTPS request'); res.writeHead(200, { 'content-type': 'text/plain' }); res.end(body); }); server_https.listen(0, function() { var req = https.request({ port: this.address().port, rejectUnauthorized: false }, function(res) { server_https.close(); res.resume(); }); // These methods should exist on the request and get passed down to the socket req.setNoDelay(true); req.setTimeout(1000, function() { }); req.setSocketKeepAlive(true, 1000); req.end(); }); node-v4.8.2/test/parallel/test-https-strict.js000644 000766 000024 00000012424 13070706737 021523 0ustar00iojsstaff000000 000000 'use strict'; // disable strict server certificate validation by the client process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var https = require('https'); var fs = require('fs'); var path = require('path'); function file(fname) { return path.resolve(common.fixturesDir, 'keys', fname); } function read(fname) { return fs.readFileSync(file(fname)); } // key1 is signed by ca1. var key1 = read('agent1-key.pem'); var cert1 = read('agent1-cert.pem'); // key2 has a self signed cert var key2 = read('agent2-key.pem'); var cert2 = read('agent2-cert.pem'); // key3 is signed by ca2. var key3 = read('agent3-key.pem'); var cert3 = read('agent3-cert.pem'); var ca1 = read('ca1-cert.pem'); var ca2 = read('ca2-cert.pem'); // different agents to use different CA lists. // this api is beyond bad. var agent0 = new https.Agent(); var agent1 = new https.Agent({ ca: [ca1] }); var agent2 = new https.Agent({ ca: [ca2] }); var agent3 = new https.Agent({ ca: [ca1, ca2] }); var options1 = { key: key1, cert: cert1 }; var options2 = { key: key2, cert: cert2 }; var options3 = { key: key3, cert: cert3 }; var server1 = server(options1); var server2 = server(options2); var server3 = server(options3); var listenWait = 0; server1.listen(0, listening()); server2.listen(0, listening()); server3.listen(0, listening()); var responseErrors = {}; var expectResponseCount = 0; var responseCount = 0; var pending = 0; function server(options, port) { var s = https.createServer(options, handler); s.requests = []; s.expectCount = 0; return s; } function handler(req, res) { this.requests.push(req.url); res.statusCode = 200; res.setHeader('foo', 'bar'); res.end('hello, world\n'); } function listening() { listenWait++; return function() { listenWait--; if (listenWait === 0) { allListening(); } }; } function makeReq(path, port, error, host, ca) { pending++; var options = { port: port, path: path, ca: ca }; if (!ca) { options.agent = agent0; } else { if (!Array.isArray(ca)) ca = [ca]; if (-1 !== ca.indexOf(ca1) && -1 !== ca.indexOf(ca2)) { options.agent = agent3; } else if (-1 !== ca.indexOf(ca1)) { options.agent = agent1; } else if (-1 !== ca.indexOf(ca2)) { options.agent = agent2; } else { options.agent = agent0; } } if (host) { options.headers = { host: host }; } var req = https.get(options); expectResponseCount++; var server = port === server1.address().port ? server1 : port === server2.address().port ? server2 : port === server3.address().port ? server3 : null; if (!server) throw new Error('invalid port: ' + port); server.expectCount++; req.on('response', function(res) { responseCount++; assert.equal(res.connection.authorizationError, error); responseErrors[path] = res.connection.authorizationError; pending--; if (pending === 0) { server1.close(); server2.close(); server3.close(); } res.resume(); }); } function allListening() { // ok, ready to start the tests! const port1 = server1.address().port; const port2 = server2.address().port; const port3 = server3.address().port; // server1: host 'agent1', signed by ca1 makeReq('/inv1', port1, 'UNABLE_TO_VERIFY_LEAF_SIGNATURE'); makeReq('/inv1-ca1', port1, 'Hostname/IP doesn\'t match certificate\'s altnames: ' + '"Host: localhost. is not cert\'s CN: agent1"', null, ca1); makeReq('/inv1-ca1ca2', port1, 'Hostname/IP doesn\'t match certificate\'s altnames: ' + '"Host: localhost. is not cert\'s CN: agent1"', null, [ca1, ca2]); makeReq('/val1-ca1', port1, null, 'agent1', ca1); makeReq('/val1-ca1ca2', port1, null, 'agent1', [ca1, ca2]); makeReq('/inv1-ca2', port1, 'UNABLE_TO_VERIFY_LEAF_SIGNATURE', 'agent1', ca2); // server2: self-signed, host = 'agent2' // doesn't matter that thename matches, all of these will error. makeReq('/inv2', port2, 'DEPTH_ZERO_SELF_SIGNED_CERT'); makeReq('/inv2-ca1', port2, 'DEPTH_ZERO_SELF_SIGNED_CERT', 'agent2', ca1); makeReq('/inv2-ca1ca2', port2, 'DEPTH_ZERO_SELF_SIGNED_CERT', 'agent2', [ca1, ca2]); // server3: host 'agent3', signed by ca2 makeReq('/inv3', port3, 'UNABLE_TO_VERIFY_LEAF_SIGNATURE'); makeReq('/inv3-ca2', port3, 'Hostname/IP doesn\'t match certificate\'s altnames: ' + '"Host: localhost. is not cert\'s CN: agent3"', null, ca2); makeReq('/inv3-ca1ca2', port3, 'Hostname/IP doesn\'t match certificate\'s altnames: ' + '"Host: localhost. is not cert\'s CN: agent3"', null, [ca1, ca2]); makeReq('/val3-ca2', port3, null, 'agent3', ca2); makeReq('/val3-ca1ca2', port3, null, 'agent3', [ca1, ca2]); makeReq('/inv3-ca1', port3, 'UNABLE_TO_VERIFY_LEAF_SIGNATURE', 'agent1', ca1); } process.on('exit', function() { console.error(responseErrors); assert.equal(server1.requests.length, server1.expectCount); assert.equal(server2.requests.length, server2.expectCount); assert.equal(server3.requests.length, server3.expectCount); assert.equal(responseCount, expectResponseCount); }); node-v4.8.2/test/parallel/test-https-timeout-server-2.js000644 000766 000024 00000001423 13070706737 023341 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var https = require('https'); var tls = require('tls'); var fs = require('fs'); var options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }; var server = https.createServer(options, common.fail); server.on('secureConnection', function(cleartext) { var s = cleartext.setTimeout(50, function() { cleartext.destroy(); server.close(); }); assert.ok(s instanceof tls.TLSSocket); }); server.listen(0, function() { tls.connect({ host: '127.0.0.1', port: this.address().port, rejectUnauthorized: false }); }); node-v4.8.2/test/parallel/test-https-timeout-server.js000644 000766 000024 00000001576 13070706737 023213 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var https = require('https'); var net = require('net'); var fs = require('fs'); var options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem'), handshakeTimeout: 50 }; var server = https.createServer(options, common.fail); server.on('clientError', common.mustCall(function(err, conn) { // Don't hesitate to update the asserts if the internal structure of // the cleartext object ever changes. We're checking that the https.Server // has closed the client connection. assert.equal(conn._secureEstablished, false); server.close(); })); server.listen(0, function() { net.connect({ host: '127.0.0.1', port: this.address().port }); }); node-v4.8.2/test/parallel/test-https-timeout.js000644 000766 000024 00000001665 13070706737 021706 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const https = require('https'); const fs = require('fs'); const options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }; // a server that never replies const server = https.createServer(options, function() { console.log('Got request. Doing nothing.'); }).listen(0, common.mustCall(function() { const req = https.request({ host: 'localhost', port: this.address().port, path: '/', method: 'GET', rejectUnauthorized: false }); req.setTimeout(10); req.end(); req.on('response', function() { console.log('got response'); }); req.on('timeout', common.mustCall(function() { console.log('timeout occurred outside'); req.destroy(); server.close(); process.exit(0); })); })); node-v4.8.2/test/parallel/test-https-truncate.js000644 000766 000024 00000002526 13070706737 022042 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const assert = require('assert'); const https = require('https'); const fs = require('fs'); const key = fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'); const cert = fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem'); // number of bytes discovered empirically to trigger the bug const data = Buffer.alloc(1024 * 32 + 1); httpsTest(); function httpsTest() { const sopt = { key: key, cert: cert }; const server = https.createServer(sopt, function(req, res) { res.setHeader('content-length', data.length); res.end(data); server.close(); }); server.listen(0, function() { const opts = { port: this.address().port, rejectUnauthorized: false }; https.get(opts).on('response', function(res) { test(res); }); }); } const test = common.mustCall(function(res) { res.on('end', common.mustCall(function() { assert.strictEqual(res._readableState.length, 0); assert.strictEqual(bytes, data.length); })); // Pause and then resume on each chunk, to ensure that there will be // a lone byte hanging out at the very end. let bytes = 0; res.on('data', function(chunk) { bytes += chunk.length; this.pause(); setTimeout(this.resume.bind(this), 1); }); }); node-v4.8.2/test/parallel/test-instanceof.js000644 000766 000024 00000000364 13070706737 021204 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); // Regression test for instanceof, see // https://github.com/nodejs/node/issues/7592 const F = () => {}; F.prototype = {}; assert(Object.create(F.prototype) instanceof F); node-v4.8.2/test/parallel/test-internal-modules-expose.js000644 000766 000024 00000000253 13070706737 023633 0ustar00iojsstaff000000 000000 'use strict'; // Flags: --expose_internals require('../common'); var assert = require('assert'); assert.equal(typeof require('internal/freelist').FreeList, 'function'); node-v4.8.2/test/parallel/test-internal-modules.js000644 000766 000024 00000000371 13070706737 022333 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var path = require('path'); var assert = require('assert'); assert.throws(function() { require('internal/freelist'); }); assert(require(path.join(common.fixturesDir, 'internal-modules')) === 42); node-v4.8.2/test/parallel/test-intl-v8BreakIterator.js000644 000766 000024 00000000634 13070706737 023033 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); if (global.Intl === undefined || Intl.v8BreakIterator === undefined) { return console.log('1..0 # Skipped: no Intl'); } try { new Intl.v8BreakIterator(); // May succeed if data is available - OK } catch (e) { // May throw this error if ICU data is not available - OK assert.throws(() => new Intl.v8BreakIterator(), /ICU data/); } node-v4.8.2/test/parallel/test-intl.js000644 000766 000024 00000005250 13070706737 020020 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); // does node think that i18n was enabled? var enablei18n = process.config.variables.v8_enable_i18n_support; if (enablei18n === undefined) { enablei18n = false; } // is the Intl object present? var haveIntl = (global.Intl != undefined); // Returns true if no specific locale ids were configured (i.e. "all") // Else, returns true if loc is in the configured list // Else, returns false function haveLocale(loc) { var locs = process.config.variables.icu_locales.split(','); return locs.indexOf(loc) !== -1; } if (!haveIntl) { const erMsg = '"Intl" object is NOT present but v8_enable_i18n_support is ' + enablei18n; assert.equal(enablei18n, false, erMsg); common.skip('Intl tests because Intl object not present.'); } else { const erMsg = '"Intl" object is present but v8_enable_i18n_support is ' + enablei18n + '. Is this test out of date?'; assert.equal(enablei18n, true, erMsg); // Construct a new date at the beginning of Unix time var date0 = new Date(0); // Use the GMT time zone var GMT = 'Etc/GMT'; // Construct an English formatter. Should format to "Jan 70" var dtf = new Intl.DateTimeFormat(['en'], {timeZone: GMT, month: 'short', year: '2-digit'}); // If list is specified and doesn't contain 'en' then return. if (process.config.variables.icu_locales && !haveLocale('en')) { common.skip('detailed Intl tests because English is not ' + 'listed as supported.'); // Smoke test. Does it format anything, or fail? console.log('Date(0) formatted to: ' + dtf.format(date0)); return; } // Check with toLocaleString var localeString = dtf.format(date0); assert.equal(localeString, 'Jan 70'); // Options to request GMT var optsGMT = {timeZone: GMT}; // Test format localeString = date0.toLocaleString(['en'], optsGMT); assert.equal(localeString, '1/1/1970, 12:00:00 AM'); // number format assert.equal(new Intl.NumberFormat(['en']).format(12345.67890), '12,345.679'); var collOpts = { sensitivity: 'base', ignorePunctuation: true }; var coll = new Intl.Collator(['en'], collOpts); assert.equal(coll.compare('blackbird', 'black-bird'), 0, 'ignore punctuation failed'); assert.equal(coll.compare('blackbird', 'red-bird'), -1, 'compare less failed'); assert.equal(coll.compare('bluebird', 'blackbird'), 1, 'compare greater failed'); assert.equal(coll.compare('Bluebird', 'bluebird'), 0, 'ignore case failed'); assert.equal(coll.compare('\ufb03', 'ffi'), 0, 'ffi ligature (contraction) failed'); } node-v4.8.2/test/parallel/test-js-stream-call-properties.js000644 000766 000024 00000000320 13070706737 024053 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const util = require('util'); const JSStream = process.binding('js_stream').JSStream; // Testing if will abort when properties are printed. util.inspect(new JSStream()); node-v4.8.2/test/parallel/test-listen-fd-cluster.js000644 000766 000024 00000007220 13070706737 022415 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var http = require('http'); var net = require('net'); var cluster = require('cluster'); console.error('Cluster listen fd test', process.argv[2] || 'runner'); if (common.isWindows) { common.skip('This test is disabled on windows.'); return; } // Process relationship is: // // parent: the test main script // -> master: the cluster master // -> worker: the cluster worker switch (process.argv[2]) { case 'master': return master(); case 'worker': return worker(); } var ok; process.on('exit', function() { assert.ok(ok); }); // spawn the parent, and listen for it to tell us the pid of the cluster. // WARNING: This is an example of listening on some arbitrary FD number // that has already been bound elsewhere in advance. However, binding // server handles to stdio fd's is NOT a good or reliable way to do // concurrency in HTTP servers! Use the cluster module, or if you want // a more low-level approach, use child process IPC manually. test(function(parent, port) { // now make sure that we can request to the worker, then kill it. http.get({ server: 'localhost', port: port, path: '/', }).on('response', function(res) { var s = ''; res.on('data', function(c) { s += c.toString(); }); res.on('end', function() { // kill the worker before we start doing asserts. // it's really annoying when tests leave orphans! parent.kill(); parent.on('exit', function() { assert.equal(s, 'hello from worker\n'); assert.equal(res.statusCode, 200); console.log('ok'); ok = true; }); }); }); }); function test(cb) { console.error('about to listen in parent'); var server = net.createServer(function(conn) { console.error('connection on parent'); conn.end('hello from parent\n'); }).listen(0, function() { const port = this.address().port; console.error('server listening on %d', port); var spawn = require('child_process').spawn; var master = spawn(process.execPath, [__filename, 'master'], { stdio: [ 0, 'pipe', 2, server._handle, 'ipc' ], detached: true }); // Now close the parent, so that the master is the only thing // referencing that handle. Note that connections will still // be accepted, because the master has the fd open. server.close(); master.on('exit', function(code) { console.error('master exited', code); }); master.on('close', function() { console.error('master closed'); }); console.error('master spawned'); master.on('message', function(msg) { if (msg === 'started worker') { cb(master, port); } }); }); } function master() { console.error('in master, spawning worker'); cluster.setupMaster({ args: [ 'worker' ] }); var worker = cluster.fork(); worker.on('message', function(msg) { if (msg === 'worker ready') { process.send('started worker'); } }); // Prevent outliving our parent process in case it is abnormally killed - // under normal conditions our parent kills this process before exiting. process.on('disconnect', function() { console.error('master exit on disconnect'); process.exit(0); }); } function worker() { console.error('worker, about to create server and listen on fd=3'); // start a server on fd=3 http.createServer(function(req, res) { console.error('request on worker'); console.error('%s %s', req.method, req.url, req.headers); res.end('hello from worker\n'); }).listen({ fd: 3 }, function() { console.error('worker listening on fd=3'); process.send('worker ready'); }); } node-v4.8.2/test/parallel/test-listen-fd-detached-inherit.js000644 000766 000024 00000005776 13070706737 024153 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var http = require('http'); var net = require('net'); var spawn = require('child_process').spawn; if (common.isWindows) { common.skip('This test is disabled on windows.'); return; } switch (process.argv[2]) { case 'child': return child(); case 'parent': return parent(); default: return test(); } // spawn the parent, and listen for it to tell us the pid of the child. // WARNING: This is an example of listening on some arbitrary FD number // that has already been bound elsewhere in advance. However, binding // server handles to stdio fd's is NOT a good or reliable way to do // concurrency in HTTP servers! Use the cluster module, or if you want // a more low-level approach, use child process IPC manually. function test() { var parent = spawn(process.execPath, [__filename, 'parent'], { stdio: [ 0, 'pipe', 2 ] }); var json = ''; parent.stdout.on('data', function(c) { json += c.toString(); if (json.indexOf('\n') !== -1) next(); }); function next() { console.error('output from parent = %s', json); var child = JSON.parse(json); // now make sure that we can request to the child, then kill it. http.get({ server: 'localhost', port: child.port, path: '/', }).on('response', function(res) { var s = ''; res.on('data', function(c) { s += c.toString(); }); res.on('end', function() { // kill the child before we start doing asserts. // it's really annoying when tests leave orphans! process.kill(child.pid, 'SIGKILL'); try { parent.kill(); } catch (e) {} assert.equal(s, 'hello from child\n'); assert.equal(res.statusCode, 200); }); }); } } // Listen on port, and then pass the handle to the detached child. // Then output the child's pid, and immediately exit. function parent() { var server = net.createServer(function(conn) { conn.end('HTTP/1.1 403 Forbidden\r\n\r\nI got problems.\r\n'); throw new Error('Should not see connections on parent'); }).listen(0, function() { console.error('server listening on %d', this.address().port); var child = spawn(process.execPath, [__filename, 'child'], { stdio: [ 0, 1, 2, server._handle ], detached: true }); console.log('%j\n', { pid: child.pid, port: this.address().port }); // Now close the parent, so that the child is the only thing // referencing that handle. Note that connections will still // be accepted, because the child has the fd open, but the parent // will exit gracefully. server.close(); child.unref(); }); } // Run as a child of the parent() mode. function child() { // start a server on fd=3 http.createServer(function(req, res) { console.error('request on child'); console.error('%s %s', req.method, req.url, req.headers); res.end('hello from child\n'); }).listen({ fd: 3 }, function() { console.error('child listening on fd=3'); }); } node-v4.8.2/test/parallel/test-listen-fd-detached.js000644 000766 000024 00000005562 13070706737 022504 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var http = require('http'); var net = require('net'); var spawn = require('child_process').spawn; if (common.isWindows) { common.skip('This test is disabled on windows.'); return; } switch (process.argv[2]) { case 'child': return child(); case 'parent': return parent(); default: return test(); } // spawn the parent, and listen for it to tell us the pid of the child. // WARNING: This is an example of listening on some arbitrary FD number // that has already been bound elsewhere in advance. However, binding // server handles to stdio fd's is NOT a good or reliable way to do // concurrency in HTTP servers! Use the cluster module, or if you want // a more low-level approach, use child process IPC manually. function test() { var parent = spawn(process.execPath, [__filename, 'parent'], { stdio: [ 0, 'pipe', 2 ] }); var json = ''; parent.stdout.on('data', function(c) { json += c.toString(); if (json.indexOf('\n') !== -1) next(); }); function next() { console.error('output from parent = %s', json); var child = JSON.parse(json); // now make sure that we can request to the child, then kill it. http.get({ server: 'localhost', port: child.port, path: '/', }).on('response', function(res) { var s = ''; res.on('data', function(c) { s += c.toString(); }); res.on('end', function() { // kill the child before we start doing asserts. // it's really annoying when tests leave orphans! process.kill(child.pid, 'SIGKILL'); try { parent.kill(); } catch (e) {} assert.equal(s, 'hello from child\n'); assert.equal(res.statusCode, 200); }); }); } } function parent() { var server = net.createServer(function(conn) { console.error('connection on parent'); conn.end('hello from parent\n'); }).listen(0, function() { console.error('server listening on %d', this.address().port); var spawn = require('child_process').spawn; var child = spawn(process.execPath, [__filename, 'child'], { stdio: [ 'ignore', 'ignore', 'ignore', server._handle ], detached: true }); console.log('%j\n', { pid: child.pid, port: this.address().port }); // Now close the parent, so that the child is the only thing // referencing that handle. Note that connections will still // be accepted, because the child has the fd open, but the parent // will exit gracefully. server.close(); child.unref(); }); } function child() { // start a server on fd=3 http.createServer(function(req, res) { console.error('request on child'); console.error('%s %s', req.method, req.url, req.headers); res.end('hello from child\n'); }).listen({ fd: 3 }, function() { console.error('child listening on fd=3'); }); } node-v4.8.2/test/parallel/test-listen-fd-ebadf.js000644 000766 000024 00000000532 13070706737 021774 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var net = require('net'); net.createServer(common.fail).listen({fd: 2}) .on('error', common.mustCall(onError)); net.createServer(common.fail).listen({fd: 42}) .on('error', common.mustCall(onError)); function onError(ex) { assert.equal(ex.code, 'EINVAL'); } node-v4.8.2/test/parallel/test-listen-fd-server.js000644 000766 000024 00000005054 13070706737 022245 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var http = require('http'); var net = require('net'); if (common.isWindows) { common.skip('This test is disabled on windows.'); return; } switch (process.argv[2]) { case 'child': return child(); } var ok; process.on('exit', function() { assert.ok(ok); }); // WARNING: This is an example of listening on some arbitrary FD number // that has already been bound elsewhere in advance. However, binding // server handles to stdio fd's is NOT a good or reliable way to do // concurrency in HTTP servers! Use the cluster module, or if you want // a more low-level approach, use child process IPC manually. test(function(child, port) { // now make sure that we can request to the child, then kill it. http.get({ server: 'localhost', port: port, path: '/', }).on('response', function(res) { var s = ''; res.on('data', function(c) { s += c.toString(); }); res.on('end', function() { child.kill(); child.on('exit', function() { assert.equal(s, 'hello from child\n'); assert.equal(res.statusCode, 200); console.log('ok'); ok = true; }); }); }); }); function child() { // Prevent outliving the parent process in case it is terminated before // killing this child process. process.on('disconnect', function() { console.error('exit on disconnect'); process.exit(0); }); // start a server on fd=3 http.createServer(function(req, res) { console.error('request on child'); console.error('%s %s', req.method, req.url, req.headers); res.end('hello from child\n'); }).listen({ fd: 3 }, function() { console.error('child listening on fd=3'); process.send('listening'); }); } function test(cb) { var server = net.createServer(function(conn) { console.error('connection on parent'); conn.end('hello from parent\n'); }).listen(0, function() { const port = this.address().port; console.error('server listening on %d', port); var spawn = require('child_process').spawn; var child = spawn(process.execPath, [__filename, 'child'], { stdio: [ 0, 1, 2, server._handle, 'ipc' ] }); console.log('%j\n', { pid: child.pid }); // Now close the parent, so that the child is the only thing // referencing that handle. Note that connections will still // be accepted, because the child has the fd open. server.close(); child.on('message', function(msg) { if (msg === 'listening') { cb(child, port); } }); }); } node-v4.8.2/test/parallel/test-memory-usage-emfile.js000644 000766 000024 00000000370 13070706737 022721 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var fs = require('fs'); var files = []; while (files.length < 256) files.push(fs.openSync(__filename, 'r')); var r = process.memoryUsage(); assert.equal(true, r['rss'] > 0); node-v4.8.2/test/parallel/test-memory-usage.js000644 000766 000024 00000000314 13070706737 021460 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var r = process.memoryUsage(); assert.ok(r.rss > 0); assert.ok(r.heapTotal > 0); assert.ok(r.heapUsed > 0); assert.ok(r.external > 0); node-v4.8.2/test/parallel/test-microtask-queue-integration-domain.js000644 000766 000024 00000002061 13070706737 025753 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); // Requiring the domain module here changes the function that is used by node to // call process.nextTick's callbacks to a variant that specifically handles // domains. We want to test this specific variant in this test, and so even if // the domain module is not used, this require call is needed and must not be // removed. require('domain'); var implementations = [ function(fn) { Promise.resolve().then(fn); } ]; var expected = 0; var done = 0; process.on('exit', function() { assert.equal(done, expected); }); function test(scheduleMicrotask) { var nextTickCalled = false; expected++; scheduleMicrotask(function() { process.nextTick(function() { nextTickCalled = true; }); setTimeout(function() { assert(nextTickCalled); done++; }, 0); }); } // first tick case implementations.forEach(test); // tick callback case setTimeout(function() { implementations.forEach(function(impl) { process.nextTick(test.bind(null, impl)); }); }, 0); node-v4.8.2/test/parallel/test-microtask-queue-integration.js000644 000766 000024 00000001327 13070706737 024512 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var implementations = [ function(fn) { Promise.resolve().then(fn); } ]; var expected = 0; var done = 0; process.on('exit', function() { assert.equal(done, expected); }); function test(scheduleMicrotask) { var nextTickCalled = false; expected++; scheduleMicrotask(function() { process.nextTick(function() { nextTickCalled = true; }); setTimeout(function() { assert(nextTickCalled); done++; }, 0); }); } // first tick case implementations.forEach(test); // tick callback case setTimeout(function() { implementations.forEach(function(impl) { process.nextTick(test.bind(null, impl)); }); }, 0); node-v4.8.2/test/parallel/test-microtask-queue-run-domain.js000644 000766 000024 00000001640 13070706737 024236 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); // Requiring the domain module here changes the function that is used by node to // call process.nextTick's callbacks to a variant that specifically handles // domains. We want to test this specific variant in this test, and so even if // the domain module is not used, this require call is needed and must not be // removed. require('domain'); function enqueueMicrotask(fn) { Promise.resolve().then(fn); } var done = 0; process.on('exit', function() { assert.equal(done, 2); }); // no nextTick, microtask setTimeout(function() { enqueueMicrotask(function() { done++; }); }, 0); // no nextTick, microtask with nextTick setTimeout(function() { var called = false; enqueueMicrotask(function() { process.nextTick(function() { called = true; }); }); setTimeout(function() { if (called) done++; }, 0); }, 0); node-v4.8.2/test/parallel/test-microtask-queue-run-immediate-domain.js000644 000766 000024 00000001635 13070706737 026176 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); // Requiring the domain module here changes the function that is used by node to // call process.nextTick's callbacks to a variant that specifically handles // domains. We want to test this specific variant in this test, and so even if // the domain module is not used, this require call is needed and must not be // removed. require('domain'); function enqueueMicrotask(fn) { Promise.resolve().then(fn); } var done = 0; process.on('exit', function() { assert.equal(done, 2); }); // no nextTick, microtask setImmediate(function() { enqueueMicrotask(function() { done++; }); }); // no nextTick, microtask with nextTick setImmediate(function() { var called = false; enqueueMicrotask(function() { process.nextTick(function() { called = true; }); }); setImmediate(function() { if (called) done++; }); }); node-v4.8.2/test/parallel/test-microtask-queue-run-immediate.js000644 000766 000024 00000001103 13070706737 024717 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); function enqueueMicrotask(fn) { Promise.resolve().then(fn); } var done = 0; process.on('exit', function() { assert.equal(done, 2); }); // no nextTick, microtask setImmediate(function() { enqueueMicrotask(function() { done++; }); }); // no nextTick, microtask with nextTick setImmediate(function() { var called = false; enqueueMicrotask(function() { process.nextTick(function() { called = true; }); }); setImmediate(function() { if (called) done++; }); }); node-v4.8.2/test/parallel/test-microtask-queue-run.js000644 000766 000024 00000001106 13070706737 022766 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); function enqueueMicrotask(fn) { Promise.resolve().then(fn); } var done = 0; process.on('exit', function() { assert.equal(done, 2); }); // no nextTick, microtask setTimeout(function() { enqueueMicrotask(function() { done++; }); }, 0); // no nextTick, microtask with nextTick setTimeout(function() { var called = false; enqueueMicrotask(function() { process.nextTick(function() { called = true; }); }); setTimeout(function() { if (called) done++; }, 0); }, 0); node-v4.8.2/test/parallel/test-module-globalpaths-nodepath.js000644 000766 000024 00000001326 13070706737 024435 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var module = require('module'); var partA, partB; var partC = ''; if (common.isWindows) { partA = 'C:\\Users\\Rocko Artischocko\\AppData\\Roaming\\npm'; partB = 'C:\\Program Files (x86)\\nodejs\\'; process.env['NODE_PATH'] = partA + ';' + partB + ';' + partC; } else { partA = '/usr/test/lib/node_modules'; partB = '/usr/test/lib/node'; process.env['NODE_PATH'] = partA + ':' + partB + ':' + partC; } module._initPaths(); assert.ok(module.globalPaths.indexOf(partA) !== -1); assert.ok(module.globalPaths.indexOf(partB) !== -1); assert.ok(module.globalPaths.indexOf(partC) === -1); assert.ok(Array.isArray(module.globalPaths)); node-v4.8.2/test/parallel/test-module-loading-error.js000644 000766 000024 00000001537 13070706737 023105 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); console.error('load test-module-loading-error.js'); var error_desc = { win32: ['%1 is not a valid Win32 application'], linux: ['file too short', 'Exec format error'], sunos: ['unknown file type', 'not an ELF file'], darwin: ['file too short'] }; var dlerror_msg = error_desc[process.platform]; if (!dlerror_msg) { common.skip('platform not supported.'); return; } try { require('../fixtures/module-loading-error.node'); } catch (e) { assert.strictEqual(dlerror_msg.some((errMsgCase) => { return e.toString().indexOf(errMsgCase) !== -1; }), true); } try { require(); } catch (e) { assert.notEqual(e.toString().indexOf('missing path'), -1); } try { require({}); } catch (e) { assert.notEqual(e.toString().indexOf('path must be a string'), -1); } node-v4.8.2/test/parallel/test-module-nodemodulepaths.js000644 000766 000024 00000000721 13070706737 023526 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var module = require('module'); var file, delimiter, paths; if (common.isWindows) { file = 'C:\\Users\\Rocko Artischocko\\node_stuff\\foo'; delimiter = '\\'; } else { file = '/usr/test/lib/node_modules/npm/foo'; delimiter = '/'; } paths = module._nodeModulePaths(file); assert.ok(paths.indexOf(file + delimiter + 'node_modules') !== -1); assert.ok(Array.isArray(paths)); node-v4.8.2/test/parallel/test-module-version.js000644 000766 000024 00000000557 13070706737 022027 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); // Check for existence assert(process.config.variables.hasOwnProperty('node_module_version')); // Ensure that `node_module_version` is an Integer assert(!Number.isNaN(parseInt(process.config.variables.node_module_version))); assert.strictEqual(process.config.variables.node_module_version, 46); node-v4.8.2/test/parallel/test-net-access-byteswritten.js000644 000766 000024 00000001235 13070706737 023637 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const net = require('net'); const tls = require('tls'); const tty = require('tty'); // Check that the bytesWritten getter doesn't crash if object isn't // constructed. assert.strictEqual(net.Socket.prototype.bytesWritten, undefined); assert.strictEqual(tls.TLSSocket.super_.prototype.bytesWritten, undefined); assert.strictEqual(tls.TLSSocket.prototype.bytesWritten, undefined); assert.strictEqual(tty.ReadStream.super_.prototype.bytesWritten, undefined); assert.strictEqual(tty.ReadStream.prototype.bytesWritten, undefined); assert.strictEqual(tty.WriteStream.prototype.bytesWritten, undefined); node-v4.8.2/test/parallel/test-net-after-close.js000644 000766 000024 00000001246 13070706737 022043 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var net = require('net'); var server = net.createServer(function(s) { console.error('SERVER: got connection'); s.end(); }); server.listen(0, common.mustCall(function() { var c = net.createConnection(this.address().port); c.on('close', common.mustCall(function() { console.error('connection closed'); assert.strictEqual(c._handle, null); assert.doesNotThrow(function() { c.setNoDelay(); c.setKeepAlive(); c.bufferSize; c.pause(); c.resume(); c.address(); c.remoteAddress; c.remotePort; }); server.close(); })); })); node-v4.8.2/test/parallel/test-net-better-error-messages-listen-path.js000644 000766 000024 00000000464 13070706737 026307 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const net = require('net'); const fp = '/blah/fadfa'; const server = net.createServer(common.fail); server.listen(fp, common.fail); server.on('error', common.mustCall(function(e) { assert.strictEqual(e.address, fp); })); node-v4.8.2/test/parallel/test-net-better-error-messages-listen.js000644 000766 000024 00000000570 13070706737 025353 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const net = require('net'); const server = net.createServer(common.fail); server.listen(1, '1.1.1.1', common.fail); server.on('error', common.mustCall(function(e) { assert.strictEqual(e.address, '1.1.1.1'); assert.strictEqual(e.port, 1); assert.strictEqual(e.syscall, 'listen'); })); node-v4.8.2/test/parallel/test-net-better-error-messages-path.js000644 000766 000024 00000000512 13070706737 025005 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var net = require('net'); var assert = require('assert'); var fp = '/tmp/fadagagsdfgsdf'; var c = net.connect(fp); c.on('connect', common.fail); c.on('error', common.mustCall(function(e) { assert.equal(e.code, 'ENOENT'); assert.equal(e.message, 'connect ENOENT ' + fp); })); node-v4.8.2/test/parallel/test-net-better-error-messages-port-hostname.js000644 000766 000024 00000000566 13070706737 026662 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const net = require('net'); const assert = require('assert'); const c = net.createConnection(common.PORT, '***'); c.on('connect', common.fail); c.on('error', common.mustCall(function(e) { assert.strictEqual(e.code, 'ENOTFOUND'); assert.strictEqual(e.port, common.PORT); assert.strictEqual(e.hostname, '***'); })); node-v4.8.2/test/parallel/test-net-better-error-messages-port.js000644 000766 000024 00000000567 13070706737 025047 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const net = require('net'); const assert = require('assert'); const c = net.createConnection(common.PORT); c.on('connect', common.fail); c.on('error', common.mustCall(function(e) { assert.strictEqual(e.code, 'ECONNREFUSED'); assert.strictEqual(e.port, common.PORT); assert.strictEqual(e.address, '127.0.0.1'); })); node-v4.8.2/test/parallel/test-net-binary.js000644 000766 000024 00000002540 13070706737 021121 0ustar00iojsstaff000000 000000 /* eslint-disable strict */ require('../common'); var assert = require('assert'); var net = require('net'); var binaryString = ''; for (var i = 255; i >= 0; i--) { var s = '\'\\' + i.toString(8) + '\''; var S = eval(s); assert.ok(S.charCodeAt(0) == i); assert.ok(S == String.fromCharCode(i)); binaryString += S; } // safe constructor var echoServer = net.Server(function(connection) { connection.setEncoding('binary'); connection.on('data', function(chunk) { connection.write(chunk, 'binary'); }); connection.on('end', function() { connection.end(); }); }); echoServer.listen(0); var recv = ''; echoServer.on('listening', function() { var j = 0; var c = net.createConnection({ port: this.address().port }); c.setEncoding('binary'); c.on('data', function(chunk) { var n = j + chunk.length; while (j < n && j < 256) { c.write(String.fromCharCode(j), 'binary'); j++; } if (j === 256) { c.end(); } recv += chunk; }); c.on('connect', function() { c.write(binaryString, 'binary'); }); c.on('close', function() { echoServer.close(); }); }); process.on('exit', function() { assert.equal(2 * 256, recv.length); var a = recv.split(''); var first = a.slice(0, 256).reverse().join(''); var second = a.slice(256, 2 * 256).join(''); assert.equal(first, second); }); node-v4.8.2/test/parallel/test-net-bind-twice.js000644 000766 000024 00000000705 13070706737 021663 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var net = require('net'); var server1 = net.createServer(common.fail); server1.listen(0, '127.0.0.1', common.mustCall(function() { var server2 = net.createServer(common.fail); server2.listen(this.address().port, '127.0.0.1', common.fail); server2.on('error', common.mustCall(function(e) { assert.equal(e.code, 'EADDRINUSE'); server1.close(); })); })); node-v4.8.2/test/parallel/test-net-buffersize.js000644 000766 000024 00000001107 13070706737 021777 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var net = require('net'); var iter = 10; var server = net.createServer(function(socket) { socket.on('readable', function() { socket.read(); }); socket.on('end', function() { server.close(); }); }); server.listen(0, function() { var client = net.connect(this.address().port); client.on('finish', function() { assert.strictEqual(client.bufferSize, 0); }); for (var i = 1; i < iter; i++) { client.write('a'); assert.strictEqual(client.bufferSize, i); } client.end(); }); node-v4.8.2/test/parallel/test-net-bytes-read.js000644 000766 000024 00000001466 13070706737 021702 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const net = require('net'); const big = Buffer(1024 * 1024); const server = net.createServer((socket) => { socket.end(big); server.close(); }).listen(0, () => { let prev = 0; function checkRaise(value) { assert(value > prev); prev = value; } const socket = net.connect(server.address().port, () => { socket.on('data', (chunk) => { checkRaise(socket.bytesRead); }); socket.on('end', common.mustCall(() => { assert.equal(socket.bytesRead, prev); assert.equal(big.length, prev); })); socket.on('close', common.mustCall(() => { assert(!socket._handle); assert.equal(socket.bytesRead, prev); assert.equal(big.length, prev); })); }); socket.end(); }); node-v4.8.2/test/parallel/test-net-bytes-stats.js000644 000766 000024 00000002412 13070706737 022115 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var net = require('net'); var bytesRead = 0; var bytesWritten = 0; var count = 0; var tcp = net.Server(function(s) { console.log('tcp server connection'); // trigger old mode. s.resume(); s.on('end', function() { bytesRead += s.bytesRead; console.log('tcp socket disconnect #' + count); }); }); tcp.listen(0, function doTest() { console.error('listening'); var socket = net.createConnection(this.address().port); socket.on('connect', function() { count++; console.error('CLIENT connect #%d', count); socket.write('foo', function() { console.error('CLIENT: write cb'); socket.end('bar'); }); }); socket.on('finish', function() { bytesWritten += socket.bytesWritten; console.error('CLIENT end event #%d', count); }); socket.on('close', function() { console.error('CLIENT close event #%d', count); console.log('Bytes read: ' + bytesRead); console.log('Bytes written: ' + bytesWritten); if (count < 2) { console.error('RECONNECTING'); socket.connect(tcp.address().port); } else { tcp.close(); } }); }); process.on('exit', function() { assert.equal(bytesRead, 12); assert.equal(bytesWritten, 12); }); node-v4.8.2/test/parallel/test-net-can-reset-timeout.js000644 000766 000024 00000001225 13070706737 023201 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var net = require('net'); var server = net.createServer(common.mustCall(function(stream) { stream.setTimeout(100); stream.resume(); stream.on('timeout', common.mustCall(function() { console.log('timeout'); // try to reset the timeout. stream.write('WHAT.'); })); stream.on('end', function() { console.log('server side end'); stream.end(); }); })); server.listen(0, function() { var c = net.createConnection(this.address().port); c.on('data', function() { c.end(); }); c.on('end', function() { console.log('client side end'); server.close(); }); }); node-v4.8.2/test/parallel/test-net-connect-buffer.js000644 000766 000024 00000004403 13070706737 022535 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var net = require('net'); var dataWritten = false; var connectHappened = false; var tcp = net.Server(function(s) { tcp.close(); console.log('tcp server connection'); var buf = ''; s.on('data', function(d) { buf += d; }); s.on('end', function() { console.error('SERVER: end', buf.toString()); assert.equal(buf, "L'État, c'est moi"); console.log('tcp socket disconnect'); s.end(); }); s.on('error', function(e) { console.log('tcp server-side error: ' + e.message); process.exit(1); }); }); tcp.listen(0, function() { var socket = net.Stream({ highWaterMark: 0 }); console.log('Connecting to socket '); socket.connect(this.address().port, function() { console.log('socket connected'); connectHappened = true; }); console.log('_connecting = ' + socket._connecting); assert.equal('opening', socket.readyState); // Make sure that anything besides a buffer or a string throws. [null, true, false, undefined, 1, 1.0, 1 / 0, +Infinity, -Infinity, [], {} ].forEach(function(v) { function f() { console.error('write', v); socket.write(v); } assert.throws(f, TypeError); }); // Write a string that contains a multi-byte character sequence to test that // `bytesWritten` is incremented with the # of bytes, not # of characters. var a = "L'État, c'est "; var b = 'moi'; // We're still connecting at this point so the datagram is first pushed onto // the connect queue. Make sure that it's not added to `bytesWritten` again // when the actual write happens. var r = socket.write(a, function(er) { console.error('write cb'); dataWritten = true; assert.ok(connectHappened); console.error('socket.bytesWritten', socket.bytesWritten); //assert.equal(socket.bytesWritten, Buffer(a + b).length); console.error('data written'); }); console.error('socket.bytesWritten', socket.bytesWritten); console.error('write returned', r); assert.equal(socket.bytesWritten, Buffer(a).length); assert.equal(false, r); socket.end(b); assert.equal('opening', socket.readyState); }); process.on('exit', function() { assert.ok(connectHappened); assert.ok(dataWritten); }); node-v4.8.2/test/parallel/test-net-connect-handle-econnrefused.js000644 000766 000024 00000000636 13070706737 025201 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var net = require('net'); var assert = require('assert'); // Hopefully nothing is running on common.PORT var c = net.createConnection(common.PORT); c.on('connect', function() { console.error('connected?!'); assert.ok(false); }); c.on('error', common.mustCall(function(e) { console.error('couldn\'t connect.'); assert.equal('ECONNREFUSED', e.code); })); node-v4.8.2/test/parallel/test-net-connect-immediate-destroy.js000644 000766 000024 00000000317 13070706737 024711 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const net = require('net'); const socket = net.connect(common.PORT, common.localhostIPv4, common.fail); socket.on('error', common.fail); socket.destroy(); node-v4.8.2/test/parallel/test-net-connect-immediate-finish.js000644 000766 000024 00000000750 13070706737 024501 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const net = require('net'); const client = net.connect({host: '***', port: common.PORT}); client.once('error', common.mustCall(function(err) { assert(err); assert.strictEqual(err.code, err.errno); assert.strictEqual(err.code, 'ENOTFOUND'); assert.strictEqual(err.host, err.hostname); assert.strictEqual(err.host, '***'); assert.strictEqual(err.syscall, 'getaddrinfo'); })); client.end(); node-v4.8.2/test/parallel/test-net-connect-local-error.js000644 000766 000024 00000001050 13070706737 023500 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const net = require('net'); var client = net.connect({ port: common.PORT + 1, localPort: common.PORT, localAddress: common.localhostIPv4 }); client.on('error', common.mustCall(function onError(err) { assert.strictEqual( err.localPort, common.PORT, `${err.localPort} !== ${common.PORT} in ${err}` ); assert.strictEqual( err.localAddress, common.localhostIPv4, `${err.localAddress} !== ${common.localhostIPv4} in ${err}` ); })); node-v4.8.2/test/parallel/test-net-connect-options-ipv6.js000644 000766 000024 00000004224 13070706737 023642 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const net = require('net'); if (!common.hasIPv6) { common.skip('no IPv6 support'); return; } const hosts = common.localIPv6Hosts; var hostIdx = 0; var host = hosts[hostIdx]; var localhostTries = 10; const server = net.createServer({allowHalfOpen: true}, function(socket) { socket.resume(); socket.on('end', common.mustCall(function() {})); socket.end(); }); server.listen(0, '::1', tryConnect); function tryConnect() { const client = net.connect({ host: host, port: server.address().port, family: 6, allowHalfOpen: true }, function() { console.error('client connect cb'); client.resume(); client.on('end', common.mustCall(function() { setTimeout(function() { assert(client.writable); client.end(); }, 10); })); client.on('close', function() { server.close(); }); }).on('error', function(err) { // ENOTFOUND means we don't have the requested address. In this // case we try the next one in the list and if we run out of // candidates we assume IPv6 is not supported on the // machine and skip the test. // EAI_AGAIN means we tried to remotely resolve the address and // timed out or hit some intermittent connectivity issue with the // dns server. Although we are looking for local loopback addresses // we may go remote since the list we search includes addresses that // cover more than is available on any one distribution. The // net is that if we get an EAI_AGAIN we were looking for an // address which does not exist in this distribution so the error // is not significant and we should just move on and try the // next address in the list. if ((err.syscall === 'getaddrinfo') && ((err.code === 'ENOTFOUND') || (err.code === 'EAI_AGAIN'))) { if (host !== 'localhost' || --localhostTries === 0) host = hosts[++hostIdx]; if (host) tryConnect(); else { common.skip('no IPv6 localhost support'); server.close(); } return; } throw err; }); } node-v4.8.2/test/parallel/test-net-connect-options.js000644 000766 000024 00000001372 13070706737 022761 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var net = require('net'); var server = net.createServer({ allowHalfOpen: true }, common.mustCall(function(socket) { socket.resume(); socket.on('end', common.mustCall(function() {})); socket.end(); })); server.listen(0, function() { var client = net.connect({ host: '127.0.0.1', port: this.address().port, allowHalfOpen: true }, common.mustCall(function() { console.error('client connect cb'); client.resume(); client.on('end', common.mustCall(function() { setTimeout(function() { assert(client.writable); client.end(); }, 10); })); client.on('close', function() { server.close(); }); })); }); node-v4.8.2/test/parallel/test-net-connect-paused-connection.js000644 000766 000024 00000000464 13070706737 024705 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var net = require('net'); net.createServer(function(conn) { conn.unref(); }).listen(0, function() { net.connect(this.address().port, 'localhost').pause(); setTimeout(function() { common.fail('expected to exit'); }, 1000).unref(); }).unref(); node-v4.8.2/test/parallel/test-net-create-connection.js000644 000766 000024 00000004732 13070706737 023242 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const net = require('net'); const expectedConnections = 7; var clientConnected = 0; var serverConnected = 0; const server = net.createServer(function(socket) { socket.end(); if (++serverConnected === expectedConnections) { server.close(); } }); server.listen(0, 'localhost', function() { function cb() { ++clientConnected; } function fail(opts, errtype, msg) { assert.throws(function() { net.createConnection(opts, cb); }, function(err) { return err instanceof errtype && msg === err.message; }); } net.createConnection(this.address().port).on('connect', cb); net.createConnection(this.address().port, 'localhost').on('connect', cb); net.createConnection(this.address().port, cb); net.createConnection(this.address().port, 'localhost', cb); net.createConnection(this.address().port + '', 'localhost', cb); net.createConnection({port: this.address().port + ''}).on('connect', cb); net.createConnection({port: '0x' + this.address().port.toString(16)}, cb); fail({ port: true }, TypeError, 'port should be a number or string: true'); fail({ port: false }, TypeError, 'port should be a number or string: false'); fail({ port: [] }, TypeError, 'port should be a number or string: '); fail({ port: {} }, TypeError, 'port should be a number or string: [object Object]'); fail({ port: null }, TypeError, 'port should be a number or string: null'); fail({ port: '' }, RangeError, 'port should be >= 0 and < 65536: '); fail({ port: ' ' }, RangeError, 'port should be >= 0 and < 65536: '); fail({ port: '0x' }, RangeError, 'port should be >= 0 and < 65536: 0x'); fail({ port: '-0x1' }, RangeError, 'port should be >= 0 and < 65536: -0x1'); fail({ port: NaN }, RangeError, 'port should be >= 0 and < 65536: NaN'); fail({ port: Infinity }, RangeError, 'port should be >= 0 and < 65536: Infinity'); fail({ port: -1 }, RangeError, 'port should be >= 0 and < 65536: -1'); fail({ port: 65536 }, RangeError, 'port should be >= 0 and < 65536: 65536'); }); // Try connecting to random ports, but do so once the server is closed server.on('close', function() { function nop() {} net.createConnection({port: 0}).on('error', nop); net.createConnection({port: undefined}).on('error', nop); }); process.on('exit', function() { assert.equal(clientConnected, expectedConnections); }); node-v4.8.2/test/parallel/test-net-dns-custom-lookup.js000644 000766 000024 00000002030 13070706737 023232 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var net = require('net'); function check(addressType, cb) { var server = net.createServer(function(client) { client.end(); server.close(); cb && cb(); }); var address = addressType === 4 ? common.localhostIPv4 : '::1'; server.listen(0, address, common.mustCall(function() { net.connect({ port: this.address().port, host: 'localhost', family: addressType, lookup: lookup }).on('lookup', common.mustCall(function(err, ip, type) { assert.strictEqual(err, null); assert.strictEqual(address, ip); assert.strictEqual(type, addressType); })); })); function lookup(host, dnsopts, cb) { dnsopts.family = addressType; if (addressType === 4) { process.nextTick(function() { cb(null, common.localhostIPv4, 4); }); } else { process.nextTick(function() { cb(null, '::1', 6); }); } } } check(4, function() { common.hasIPv6 && check(6); }); node-v4.8.2/test/parallel/test-net-dns-error.js000644 000766 000024 00000001062 13070706737 021546 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var net = require('net'); var host = '*'.repeat(256); function do_not_call() { throw new Error('This function should not have been called.'); } var socket = net.connect(42, host, do_not_call); socket.on('error', common.mustCall(function(err) { assert.equal(err.code, 'ENOTFOUND'); })); socket.on('lookup', function(err, ip, type) { assert(err instanceof Error); assert.equal(err.code, 'ENOTFOUND'); assert.equal(ip, undefined); assert.equal(type, undefined); }); node-v4.8.2/test/parallel/test-net-dns-lookup-skip.js000644 000766 000024 00000000644 13070706737 022677 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var net = require('net'); function check(addressType) { var server = net.createServer(function(client) { client.end(); server.close(); }); var address = addressType === 4 ? '127.0.0.1' : '::1'; server.listen(0, address, function() { net.connect(this.address().port, address).on('lookup', common.fail); }); } check(4); common.hasIPv6 && check(6); node-v4.8.2/test/parallel/test-net-dns-lookup.js000644 000766 000024 00000000736 13070706737 021735 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var net = require('net'); var server = net.createServer(function(client) { client.end(); server.close(); }); server.listen(0, '127.0.0.1', common.mustCall(function() { net.connect(this.address().port, 'localhost') .on('lookup', common.mustCall(function(err, ip, type) { assert.equal(err, null); assert.equal(ip, '127.0.0.1'); assert.equal(type, '4'); })); })); node-v4.8.2/test/parallel/test-net-during-close.js000644 000766 000024 00000001111 13070706737 022221 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var net = require('net'); var server = net.createServer(function(socket) { socket.end(); }); server.listen(0, common.mustCall(function() { var client = net.createConnection(this.address().port); server.close(); // server connection event has not yet fired // client is still attempting to connect assert.doesNotThrow(function() { client.remoteAddress; client.remoteFamily; client.remotePort; }); // exit now, do not wait for the client error event process.exit(0); })); node-v4.8.2/test/parallel/test-net-eaddrinuse.js000644 000766 000024 00000000632 13070706737 021760 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var net = require('net'); var server1 = net.createServer(function(socket) { }); var server2 = net.createServer(function(socket) { }); server1.listen(0, function() { server2.on('error', function(error) { assert.equal(true, error.message.indexOf('EADDRINUSE') >= 0); server1.close(); }); server2.listen(this.address().port); }); node-v4.8.2/test/parallel/test-net-end-close.js000644 000766 000024 00000001030 13070706737 021477 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const net = require('net'); const uv = process.binding('uv'); const s = new net.Socket({ handle: { readStart: function() { process.nextTick(() => this.onread(uv.UV_EOF, null)); }, close: (cb) => process.nextTick(cb) }, writable: false }); s.resume(); const events = []; s.on('end', () => events.push('end')); s.on('close', () => events.push('close')); process.on('exit', () => { assert.deepStrictEqual(events, [ 'end', 'close' ]); }); node-v4.8.2/test/parallel/test-net-end-without-connect.js000644 000766 000024 00000000176 13070706737 023536 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var net = require('net'); var sock = new net.Socket(); sock.end(); // Should not throw. node-v4.8.2/test/parallel/test-net-error-twice.js000644 000766 000024 00000001632 13070706737 022100 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const net = require('net'); const buf = new Buffer(10 * 1024 * 1024); buf.fill(0x62); const errs = []; var clientSocket; var serverSocket; function ready() { if (clientSocket && serverSocket) { clientSocket.destroy(); serverSocket.write(buf); } } var srv = net.createServer(function onConnection(conn) { conn.on('error', function(err) { errs.push(err); if (errs.length > 1 && errs[0] === errs[1]) assert(false, 'We should not be emitting the same error twice'); }); conn.on('close', function() { srv.unref(); }); serverSocket = conn; ready(); }).listen(0, function() { var client = net.connect({ port: this.address().port }); client.on('connect', function() { clientSocket = client; ready(); }); }); process.on('exit', function() { console.log(errs); assert.equal(errs.length, 1); }); node-v4.8.2/test/parallel/test-net-internal.js000644 000766 000024 00000000750 13070706737 021452 0ustar00iojsstaff000000 000000 'use strict'; // Flags: --expose-internals require('../common'); const assert = require('assert'); const net = require('internal/net'); assert.strictEqual(net.isLegalPort(''), false); assert.strictEqual(net.isLegalPort('0'), true); assert.strictEqual(net.isLegalPort(0), true); assert.strictEqual(net.isLegalPort(65536), false); assert.strictEqual(net.isLegalPort('65535'), true); assert.strictEqual(net.isLegalPort(undefined), false); assert.strictEqual(net.isLegalPort(null), true); node-v4.8.2/test/parallel/test-net-isip.js000644 000766 000024 00000005632 13070706737 020606 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var net = require('net'); assert.equal(net.isIP('127.0.0.1'), 4); assert.equal(net.isIP('x127.0.0.1'), 0); assert.equal(net.isIP('example.com'), 0); assert.equal(net.isIP('0000:0000:0000:0000:0000:0000:0000:0000'), 6); assert.equal(net.isIP('0000:0000:0000:0000:0000:0000:0000:0000::0000'), 0); assert.equal(net.isIP('1050:0:0:0:5:600:300c:326b'), 6); assert.equal(net.isIP('2001:252:0:1::2008:6'), 6); assert.equal(net.isIP('2001:dead:beef:1::2008:6'), 6); assert.equal(net.isIP('2001::'), 6); assert.equal(net.isIP('2001:dead::'), 6); assert.equal(net.isIP('2001:dead:beef::'), 6); assert.equal(net.isIP('2001:dead:beef:1::'), 6); assert.equal(net.isIP('ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff'), 6); assert.equal(net.isIP(':2001:252:0:1::2008:6:'), 0); assert.equal(net.isIP(':2001:252:0:1::2008:6'), 0); assert.equal(net.isIP('2001:252:0:1::2008:6:'), 0); assert.equal(net.isIP('2001:252::1::2008:6'), 0); assert.equal(net.isIP('::2001:252:1:2008:6'), 6); assert.equal(net.isIP('::2001:252:1:1.1.1.1'), 6); assert.equal(net.isIP('::2001:252:1:255.255.255.255'), 6); assert.equal(net.isIP('::2001:252:1:255.255.255.255.76'), 0); assert.equal(net.isIP('::anything'), 0); assert.equal(net.isIP('::1'), 6); assert.equal(net.isIP('::'), 6); assert.equal(net.isIP('0000:0000:0000:0000:0000:0000:12345:0000'), 0); assert.equal(net.isIP('0'), 0); assert.equal(net.isIP(), 0); assert.equal(net.isIP(''), 0); assert.equal(net.isIP(null), 0); assert.equal(net.isIP(123), 0); assert.equal(net.isIP(true), 0); assert.equal(net.isIP({}), 0); assert.equal(net.isIP({ toString: () => '::2001:252:1:255.255.255.255' }), 6); assert.equal(net.isIP({ toString: () => '127.0.0.1' }), 4); assert.equal(net.isIP({ toString: () => 'bla' }), 0); assert.equal(net.isIPv4('127.0.0.1'), true); assert.equal(net.isIPv4('example.com'), false); assert.equal(net.isIPv4('2001:252:0:1::2008:6'), false); assert.equal(net.isIPv4(), false); assert.equal(net.isIPv4(''), false); assert.equal(net.isIPv4(null), false); assert.equal(net.isIPv4(123), false); assert.equal(net.isIPv4(true), false); assert.equal(net.isIPv4({}), false); assert.equal(net.isIPv4({ toString: () => '::2001:252:1:255.255.255.255' }), false); assert.equal(net.isIPv4({ toString: () => '127.0.0.1' }), true); assert.equal(net.isIPv4({ toString: () => 'bla' }), false); assert.equal(net.isIPv6('127.0.0.1'), false); assert.equal(net.isIPv6('example.com'), false); assert.equal(net.isIPv6('2001:252:0:1::2008:6'), true); assert.equal(net.isIPv6(), false); assert.equal(net.isIPv6(''), false); assert.equal(net.isIPv6(null), false); assert.equal(net.isIPv6(123), false); assert.equal(net.isIPv6(true), false); assert.equal(net.isIPv6({}), false); assert.equal(net.isIPv6({ toString: () => '::2001:252:1:255.255.255.255' }), true); assert.equal(net.isIPv6({ toString: () => '127.0.0.1' }), false); assert.equal(net.isIPv6({ toString: () => 'bla' }), false); node-v4.8.2/test/parallel/test-net-keepalive.js000644 000766 000024 00000001746 13070706737 021611 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const net = require('net'); var serverConnection; var clientConnection; var echoServer = net.createServer(function(connection) { serverConnection = connection; setTimeout(common.mustCall(function() { // make sure both connections are still open assert.strictEqual(serverConnection.readyState, 'open'); assert.strictEqual(clientConnection.readyState, 'open'); serverConnection.end(); clientConnection.end(); echoServer.close(); }, 1), common.platformTimeout(100)); connection.setTimeout(0); assert.notEqual(connection.setKeepAlive, undefined); // send a keepalive packet after 50 ms connection.setKeepAlive(true, common.platformTimeout(50)); connection.on('end', function() { connection.end(); }); }); echoServer.listen(0); echoServer.on('listening', function() { clientConnection = net.createConnection(this.address().port); clientConnection.setTimeout(0); }); node-v4.8.2/test/parallel/test-net-large-string.js000644 000766 000024 00000001322 13070706737 022230 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var net = require('net'); var kPoolSize = 40 * 1024; var data = 'あ'.repeat(kPoolSize); var encoding = 'UTF-8'; var server = net.createServer(common.mustCall(function(socket) { var receivedSize = 0; socket.setEncoding(encoding); socket.on('data', function(data) { receivedSize += data.length; }); socket.on('end', common.mustCall(function() { assert.strictEqual(receivedSize, kPoolSize); socket.end(); })); })); server.listen(0, function() { var client = net.createConnection(this.address().port); client.on('end', function() { server.close(); }); client.write(data, encoding); client.end(); }); node-v4.8.2/test/parallel/test-net-listen-close-server-callback-is-not-function.js000644 000766 000024 00000000356 13070706737 030331 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var net = require('net'); var server = net.createServer(common.fail); server.on('close', common.mustCall(function() {})); server.listen(0, common.fail); server.close('bad argument'); node-v4.8.2/test/parallel/test-net-listen-close-server.js000644 000766 000024 00000000323 13070706737 023537 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var net = require('net'); var server = net.createServer(function(socket) { }); server.listen(0, common.fail); server.on('error', common.fail); server.close(); node-v4.8.2/test/parallel/test-net-listen-error.js000644 000766 000024 00000000402 13070706737 022255 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var net = require('net'); var server = net.createServer(function(socket) { }); server.listen(1, '1.1.1.1', common.fail); // EACCESS or EADDRNOTAVAIL server.on('error', common.mustCall(function(error) {})); node-v4.8.2/test/parallel/test-net-listen-exclusive-random-ports.js000644 000766 000024 00000001477 13070706737 025573 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var cluster = require('cluster'); var net = require('net'); function noop() {} if (cluster.isMaster) { var worker1 = cluster.fork(); worker1.on('message', function(port1) { assert.equal(port1, port1 | 0, 'first worker could not listen'); var worker2 = cluster.fork(); worker2.on('message', function(port2) { assert.equal(port2, port2 | 0, 'second worker could not listen'); assert.notEqual(port1, port2, 'ports should not be equal'); worker1.kill(); worker2.kill(); }); }); } else { var server = net.createServer(noop); server.on('error', function(err) { process.send(err.code); }); server.listen({ port: 0, exclusive: true }, function() { process.send(server.address().port); }); } node-v4.8.2/test/parallel/test-net-listen-fd0.js000644 000766 000024 00000000701 13070706737 021577 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var net = require('net'); var gotError = false; process.on('exit', function() { assert(gotError instanceof Error); }); // this should fail with an async EINVAL error, not throw an exception net.createServer(common.fail).listen({fd: 0}).on('error', function(e) { switch (e.code) { case 'EINVAL': case 'ENOTSOCK': gotError = e; break; } }); node-v4.8.2/test/parallel/test-net-listen-port-option.js000644 000766 000024 00000001204 13070706737 023417 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var net = require('net'); function close() { this.close(); } net.Server().listen({ port: undefined }, close); net.Server().listen({ port: '0' }, close); [ 'nan', -1, 123.456, 0x10000, 1 / 0, -1 / 0, '+Infinity', '-Infinity' ].forEach(function(port) { assert.throws(function() { net.Server().listen({ port: port }, common.fail); }, /port should be >= 0 and < 65536/i); }); [null, true, false].forEach(function(port) { assert.throws(function() { net.Server().listen({ port: port }, common.fail); }, /invalid listen argument/i); }); node-v4.8.2/test/parallel/test-net-listen-shared-ports.js000644 000766 000024 00000002066 13070706737 023547 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var cluster = require('cluster'); var net = require('net'); function noop() {} if (cluster.isMaster) { var worker1 = cluster.fork(); worker1.on('message', function(msg) { assert.equal(msg, 'success'); var worker2 = cluster.fork(); worker2.on('message', function(msg) { assert.equal(msg, 'server2:EADDRINUSE'); worker1.kill(); worker2.kill(); }); }); } else { var server1 = net.createServer(noop); var server2 = net.createServer(noop); server1.on('error', function(err) { // no errors expected process.send('server1:' + err.code); }); server2.on('error', function(err) { // an error is expected on the second worker process.send('server2:' + err.code); }); server1.listen({ host: 'localhost', port: common.PORT, exclusive: false }, function() { server2.listen({port: common.PORT + 1, exclusive: true}, function() { // the first worker should succeed process.send('success'); }); }); } node-v4.8.2/test/parallel/test-net-local-address-port.js000644 000766 000024 00000001066 13070706737 023336 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var net = require('net'); var server = net.createServer(common.mustCall(function(socket) { assert.equal(socket.localAddress, common.localhostIPv4); assert.equal(socket.localPort, this.address().port); socket.on('end', function() { server.close(); }); socket.resume(); })); server.listen(0, common.localhostIPv4, function() { var client = net.createConnection(this.address().port, common.localhostIPv4); client.on('connect', function() { client.end(); }); }); node-v4.8.2/test/parallel/test-net-localerror.js000644 000766 000024 00000000741 13070706737 022002 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const net = require('net'); connect({ host: 'localhost', port: common.PORT, localPort: 'foobar', }, /^TypeError: localPort should be a number: foobar$/); connect({ host: 'localhost', port: common.PORT, localAddress: 'foobar', }, /^TypeError: localAddress must be a valid IP: foobar$/); function connect(opts, msg) { assert.throws(function() { net.connect(opts); }, msg); } node-v4.8.2/test/parallel/test-net-localport.js000644 000766 000024 00000001073 13070706737 021634 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var net = require('net'); var server = net.createServer(function(socket) { console.log(socket.remotePort); assert.strictEqual(socket.remotePort, common.PORT); socket.end(); socket.on('close', function() { server.close(); }); }).listen(0).on('listening', function() { var client = net.connect({ host: '127.0.0.1', port: this.address().port, localPort: common.PORT, }).on('connect', function() { assert.strictEqual(client.localPort, common.PORT); }); }); node-v4.8.2/test/parallel/test-net-pause-resume-connecting.js000644 000766 000024 00000002771 13070706737 024403 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const net = require('net'); let connections = 0; let dataEvents = 0; let conn; // Server var server = net.createServer(function(conn) { connections++; conn.end('This was the year he fell to pieces.'); if (connections === 5) server.close(); }); server.listen(0, function() { // Client 1 conn = require('net').createConnection(this.address().port, 'localhost'); conn.resume(); conn.on('data', onDataOk); // Client 2 conn = require('net').createConnection(this.address().port, 'localhost'); conn.pause(); conn.resume(); conn.on('data', onDataOk); // Client 3 conn = require('net').createConnection(this.address().port, 'localhost'); conn.pause(); conn.on('data', common.fail); scheduleTearDown(conn); // Client 4 conn = require('net').createConnection(this.address().port, 'localhost'); conn.resume(); conn.pause(); conn.resume(); conn.on('data', onDataOk); // Client 5 conn = require('net').createConnection(this.address().port, 'localhost'); conn.resume(); conn.resume(); conn.pause(); conn.on('data', common.fail); scheduleTearDown(conn); function onDataOk() { dataEvents++; } function scheduleTearDown(conn) { setTimeout(function() { conn.removeAllListeners('data'); conn.resume(); }, 100); } }); // Exit sanity checks process.on('exit', function() { assert.strictEqual(connections, 5); assert.strictEqual(dataEvents, 3); }); node-v4.8.2/test/parallel/test-net-persistent-keepalive.js000644 000766 000024 00000001766 13070706737 024011 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var net = require('net'); var serverConnection; var clientConnection; var echoServer = net.createServer(function(connection) { serverConnection = connection; setTimeout(function() { // make sure both connections are still open assert.equal(serverConnection.readyState, 'open'); assert.equal(clientConnection.readyState, 'open'); serverConnection.end(); clientConnection.end(); echoServer.close(); }, 600); connection.setTimeout(0); assert.equal(typeof connection.setKeepAlive, 'function'); connection.on('end', function() { connection.end(); }); }); echoServer.listen(0); echoServer.on('listening', function() { clientConnection = new net.Socket(); // send a keepalive packet after 1000 ms // and make sure it persists var s = clientConnection.setKeepAlive(true, 400); assert.ok(s instanceof net.Socket); clientConnection.connect(this.address().port); clientConnection.setTimeout(0); }); node-v4.8.2/test/parallel/test-net-persistent-nodelay.js000644 000766 000024 00000001447 13070706737 023473 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var net = require('net'); var TCPWrap = process.binding('tcp_wrap').TCP; var echoServer = net.createServer(function(connection) { connection.end(); }); echoServer.listen(0); var callCount = 0; var Socket = net.Socket; var setNoDelay = TCPWrap.prototype.setNoDelay; TCPWrap.prototype.setNoDelay = function(enable) { setNoDelay.call(this, enable); callCount++; }; echoServer.on('listening', function() { var sock1 = new Socket(); // setNoDelay before the handle is created // there is probably a better way to test this var s = sock1.setNoDelay(); assert.ok(s instanceof net.Socket); sock1.connect(this.address().port); sock1.on('end', function() { assert.equal(callCount, 1); echoServer.close(); }); }); node-v4.8.2/test/parallel/test-net-persistent-ref-unref.js000644 000766 000024 00000001377 13070706737 023733 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var net = require('net'); var TCPWrap = process.binding('tcp_wrap').TCP; var echoServer = net.createServer(function(conn) { conn.end(); }); var ref = TCPWrap.prototype.ref; var unref = TCPWrap.prototype.unref; var refCount = 0; TCPWrap.prototype.ref = function() { ref.call(this); refCount++; assert.equal(refCount, 0); }; TCPWrap.prototype.unref = function() { unref.call(this); refCount--; assert.equal(refCount, -1); }; echoServer.listen(0); echoServer.on('listening', function() { var sock = new net.Socket(); sock.unref(); sock.ref(); sock.connect(this.address().port); sock.on('end', function() { assert.equal(refCount, 0); echoServer.close(); }); }); node-v4.8.2/test/parallel/test-net-pingpong.js000644 000766 000024 00000006043 13070706737 021460 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const net = require('net'); function pingPongTest(port, host) { const N = 1000; var count = 0; var sentPongs = 0; var sent_final_ping = false; const server = net.createServer( { allowHalfOpen: true }, common.mustCall(onSocket) ); function onSocket(socket) { assert.strictEqual(socket.server, server); server.getConnections(common.mustCall(function(err, connections) { assert.ifError(err); assert.strictEqual(connections, 1); })); socket.setNoDelay(); socket.timeout = 0; socket.setEncoding('utf8'); socket.on('data', common.mustCall(function(data) { // Since we never queue data (we're always waiting for the PING // before sending a pong) the writeQueueSize should always be less // than one message. assert.ok(0 <= socket.bufferSize && socket.bufferSize <= 4); assert.strictEqual(socket.writable, true); assert.strictEqual(socket.readable, true); assert.ok(count <= N); assert.strictEqual(data, 'PING'); socket.write('PONG', common.mustCall(function() { sentPongs++; })); }, N + 1)); socket.on('end', common.mustCall(function() { assert.strictEqual(socket.allowHalfOpen, true); assert.strictEqual(socket.writable, true); // because allowHalfOpen assert.strictEqual(socket.readable, false); socket.end(); })); socket.on('error', common.fail); socket.on('close', common.mustCall(function() { assert.strictEqual(socket.writable, false); assert.strictEqual(socket.readable, false); socket.server.close(); })); } server.listen(port, host, common.mustCall(function() { if (this.address().port) port = this.address().port; const client = net.createConnection(port, host); client.setEncoding('ascii'); client.on('connect', common.mustCall(function() { assert.strictEqual(client.readable, true); assert.strictEqual(client.writable, true); client.write('PING'); })); client.on('data', common.mustCall(function(data) { assert.strictEqual(data, 'PONG'); count += 1; if (sent_final_ping) { assert.strictEqual(client.writable, false); assert.strictEqual(client.readable, true); return; } else { assert.strictEqual(client.writable, true); assert.strictEqual(client.readable, true); } if (count < N) { client.write('PING'); } else { sent_final_ping = true; client.write('PING'); client.end(); } }, N + 1)); client.on('close', common.mustCall(function() { assert.strictEqual(count, N + 1); assert.strictEqual(sentPongs, N + 1); assert.strictEqual(sent_final_ping, true); })); client.on('error', common.fail); })); } /* All are run at once, so run on different ports */ common.refreshTmpDir(); pingPongTest(common.PIPE); pingPongTest(0); pingPongTest(0, 'localhost'); if (common.hasIPv6) pingPongTest(0, '::1'); node-v4.8.2/test/parallel/test-net-pipe-connect-errors.js000644 000766 000024 00000004517 13070706737 023541 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var fs = require('fs'); var net = require('net'); var path = require('path'); var assert = require('assert'); var accessErrorFired = false; // Test if ENOTSOCK is fired when trying to connect to a file which is not // a socket. var emptyTxt; if (common.isWindows) { // on Win, common.PIPE will be a named pipe, so we use an existing empty // file instead emptyTxt = path.join(common.fixturesDir, 'empty.txt'); } else { common.refreshTmpDir(); // Keep the file name very short so tht we don't exceed the 108 char limit // on CI for a POSIX socket. Even though this isn't actually a socket file, // the error will be different from the one we are expecting if we exceed the // limit. emptyTxt = common.tmpDir + '0.txt'; function cleanup() { try { fs.unlinkSync(emptyTxt); } catch (e) { if (e.code != 'ENOENT') throw e; } } process.on('exit', cleanup); cleanup(); fs.writeFileSync(emptyTxt, ''); } var notSocketClient = net.createConnection(emptyTxt, function() { assert.ok(false); }); notSocketClient.on('error', common.mustCall(function(err) { assert(err.code === 'ENOTSOCK' || err.code === 'ECONNREFUSED', `received ${err.code} instead of ENOTSOCK or ECONNREFUSED`); })); // Trying to connect to not-existing socket should result in ENOENT error var noEntSocketClient = net.createConnection('no-ent-file', function() { assert.ok(false); }); noEntSocketClient.on('error', common.mustCall(function(err) { assert.equal(err.code, 'ENOENT'); })); // On Windows or when running as root, a chmod has no effect on named pipes if (!common.isWindows && process.getuid() !== 0) { // Trying to connect to a socket one has no access to should result in EACCES var accessServer = net.createServer(function() { assert.ok(false); }); accessServer.listen(common.PIPE, function() { fs.chmodSync(common.PIPE, 0); var accessClient = net.createConnection(common.PIPE, function() { assert.ok(false); }); accessClient.on('error', function(err) { assert.equal(err.code, 'EACCES'); accessErrorFired = true; accessServer.close(); }); }); } // Assert that all error events were fired process.on('exit', function() { if (!common.isWindows && process.getuid() !== 0) { assert.ok(accessErrorFired); } }); node-v4.8.2/test/parallel/test-net-reconnect-error.js000644 000766 000024 00000001420 13070706737 022740 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const net = require('net'); const assert = require('assert'); const N = 20; let client_error_count = 0; let disconnect_count = 0; // Hopefully nothing is running on common.PORT const c = net.createConnection(common.PORT); c.on('connect', function() { console.error('CLIENT connected'); assert.ok(false); }); c.on('error', function(e) { console.error('CLIENT error: ' + e.code); client_error_count++; assert.strictEqual('ECONNREFUSED', e.code); }); c.on('close', function() { console.log('CLIENT disconnect'); if (disconnect_count++ < N) c.connect(common.PORT); // reconnect }); process.on('exit', function() { assert.strictEqual(N + 1, disconnect_count); assert.strictEqual(N + 1, client_error_count); }); node-v4.8.2/test/parallel/test-net-reconnect.js000644 000766 000024 00000003205 13070706737 021614 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var net = require('net'); var N = 50; var client_recv_count = 0; var client_end_count = 0; var disconnect_count = 0; var server = net.createServer(function(socket) { console.error('SERVER: got socket connection'); socket.resume(); console.error('SERVER connect, writing'); socket.write('hello\r\n'); socket.on('end', function() { console.error('SERVER socket end, calling end()'); socket.end(); }); socket.on('close', function(had_error) { console.log('SERVER had_error: ' + JSON.stringify(had_error)); assert.equal(false, had_error); }); }); server.listen(0, function() { console.log('SERVER listening'); var client = net.createConnection(this.address().port); client.setEncoding('UTF8'); client.on('connect', function() { console.error('CLIENT connected', client._writableState); }); client.on('data', function(chunk) { client_recv_count += 1; console.log('client_recv_count ' + client_recv_count); assert.equal('hello\r\n', chunk); console.error('CLIENT: calling end', client._writableState); client.end(); }); client.on('end', function() { console.error('CLIENT end'); client_end_count++; }); client.on('close', function(had_error) { console.log('CLIENT disconnect'); assert.equal(false, had_error); if (disconnect_count++ < N) client.connect(server.address().port); // reconnect else server.close(); }); }); process.on('exit', function() { assert.equal(N + 1, disconnect_count); assert.equal(N + 1, client_recv_count); assert.equal(N + 1, client_end_count); }); node-v4.8.2/test/parallel/test-net-remote-address-port.js000644 000766 000024 00000004073 13070706737 023540 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const net = require('net'); var conns_closed = 0; var remoteAddrCandidates = [ common.localhostIPv4 ]; if (common.hasIPv6) remoteAddrCandidates.push('::ffff:127.0.0.1'); var remoteFamilyCandidates = ['IPv4']; if (common.hasIPv6) remoteFamilyCandidates.push('IPv6'); var server = net.createServer(common.mustCall(function(socket) { assert.notEqual(-1, remoteAddrCandidates.indexOf(socket.remoteAddress)); assert.notEqual(-1, remoteFamilyCandidates.indexOf(socket.remoteFamily)); assert.ok(socket.remotePort); assert.notEqual(socket.remotePort, this.address().port); socket.on('end', function() { if (++conns_closed === 2) server.close(); }); socket.on('close', function() { assert.notEqual(-1, remoteAddrCandidates.indexOf(socket.remoteAddress)); assert.notEqual(-1, remoteFamilyCandidates.indexOf(socket.remoteFamily)); }); socket.resume(); }, 2)); server.listen(0, 'localhost', function() { var client = net.createConnection(this.address().port, 'localhost'); var client2 = net.createConnection(this.address().port); client.on('connect', function() { assert.notEqual(-1, remoteAddrCandidates.indexOf(client.remoteAddress)); assert.notEqual(-1, remoteFamilyCandidates.indexOf(client.remoteFamily)); assert.strictEqual(client.remotePort, server.address().port); client.end(); }); client.on('close', function() { assert.notEqual(-1, remoteAddrCandidates.indexOf(client.remoteAddress)); assert.notEqual(-1, remoteFamilyCandidates.indexOf(client.remoteFamily)); }); client2.on('connect', function() { assert.notEqual(-1, remoteAddrCandidates.indexOf(client2.remoteAddress)); assert.notEqual(-1, remoteFamilyCandidates.indexOf(client2.remoteFamily)); assert.strictEqual(client2.remotePort, server.address().port); client2.end(); }); client2.on('close', function() { assert.notEqual(-1, remoteAddrCandidates.indexOf(client2.remoteAddress)); assert.notEqual(-1, remoteFamilyCandidates.indexOf(client2.remoteFamily)); }); }); node-v4.8.2/test/parallel/test-net-server-bind.js000644 000766 000024 00000003653 13070706737 022063 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var net = require('net'); // With only a callback, server should get a port assigned by the OS var address0; var server0 = net.createServer(function(socket) { }); server0.listen(function() { address0 = server0.address(); console.log('address0 %j', address0); server0.close(); }); // No callback to listen(), assume we can bind in 100 ms var address1; var connectionKey1; var server1 = net.createServer(function(socket) { }); server1.listen(common.PORT); setTimeout(function() { address1 = server1.address(); connectionKey1 = server1._connectionKey; console.log('address1 %j', address1); server1.close(); }, 100); // Callback to listen() var address2; var server2 = net.createServer(function(socket) { }); server2.listen(common.PORT + 1, function() { address2 = server2.address(); console.log('address2 %j', address2); server2.close(); }); // Backlog argument var address3; var server3 = net.createServer(function(socket) { }); server3.listen(common.PORT + 2, '0.0.0.0', 127, function() { address3 = server3.address(); console.log('address3 %j', address3); server3.close(); }); // Backlog argument without host argument var address4; var server4 = net.createServer(function(socket) { }); server4.listen(common.PORT + 3, 127, function() { address4 = server4.address(); console.log('address4 %j', address4); server4.close(); }); process.on('exit', function() { assert.ok(address0.port > 100); assert.equal(common.PORT, address1.port); var expectedConnectionKey1; if (address1.family === 'IPv6') expectedConnectionKey1 = '6::::' + address1.port; else expectedConnectionKey1 = '4:0.0.0.0:' + address1.port; assert.equal(connectionKey1, expectedConnectionKey1); assert.equal(common.PORT + 1, address2.port); assert.equal(common.PORT + 2, address3.port); assert.equal(common.PORT + 3, address4.port); }); node-v4.8.2/test/parallel/test-net-server-close.js000644 000766 000024 00000001650 13070706737 022247 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var net = require('net'); var events = []; var sockets = []; process.on('exit', function() { assert.equal(server.connections, 0); assert.equal(events.length, 3); // Expect to see one server event and two client events. The order of the // events is undefined because they arrive on the same event loop tick. assert.equal(events.join(' ').match(/server/g).length, 1); assert.equal(events.join(' ').match(/client/g).length, 2); }); var server = net.createServer(function(c) { c.on('close', function() { events.push('client'); }); sockets.push(c); if (sockets.length === 2) { server.close(); sockets.forEach(function(c) { c.destroy(); }); } }); server.on('close', function() { events.push('server'); }); server.listen(0, function() { net.createConnection(this.address().port); net.createConnection(this.address().port); }); node-v4.8.2/test/parallel/test-net-server-connections.js000644 000766 000024 00000000455 13070706737 023466 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var net = require('net'); // test that server.connections property is no longer enumerable now that it // has been marked as deprecated var server = new net.Server(); assert.equal(Object.keys(server).indexOf('connections'), -1); node-v4.8.2/test/parallel/test-net-server-listen-remove-callback.js000644 000766 000024 00000000770 13070706737 025467 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var net = require('net'); // Server should only fire listen callback once var server = net.createServer(); server.on('close', function() { var listeners = server.listeners('listening'); console.log('Closed, listeners:', listeners.length); assert.equal(0, listeners.length); }); server.listen(0, function() { server.close(); }); server.once('close', function() { server.listen(0, function() { server.close(); }); }); node-v4.8.2/test/parallel/test-net-server-max-connections-close-makes-more-available.js000644 000766 000024 00000004515 13070706737 031331 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var net = require('net'); // Sets the server's maxConnections property to 1. // Open 2 connections (connection 0 and connection 1). // Connection 0 should be accepted. // Connection 1 should be rejected. // Closes connection 0. // Open 2 more connections (connection 2 and 3). // Connection 2 should be accepted. // Connection 3 should be rejected. var connections = []; var received = []; var sent = []; var createConnection = function(index) { console.error('creating connection ' + index); return new Promise(function(resolve, reject) { var connection = net.createConnection(server.address().port, function() { var msg = '' + index; console.error('sending message: ' + msg); this.write(msg); sent.push(msg); }); connection.on('error', function(err) { assert.equal(err.code, 'ECONNRESET'); resolve(); }); connection.on('data', function(e) { console.error('connection ' + index + ' received response'); resolve(); }); connection.on('end', function() { console.error('ending ' + index); resolve(); }); connections[index] = connection; }); }; var closeConnection = function(index) { console.error('closing connection ' + index); return new Promise(function(resolve, reject) { connections[index].on('end', function() { resolve(); }); connections[index].end(); }); }; var server = net.createServer(function(socket) { socket.on('data', function(data) { console.error('received message: ' + data); received.push('' + data); socket.write('acknowledged'); }); }); server.maxConnections = 1; server.listen(0, function() { createConnection(0) .then(createConnection.bind(null, 1)) .then(closeConnection.bind(null, 0)) .then(createConnection.bind(null, 2)) .then(createConnection.bind(null, 3)) .then(server.close.bind(server)) .then(closeConnection.bind(null, 2)); }); process.on('exit', function() { // Confirm that all connections tried to send data... assert.deepEqual(sent, [0, 1, 2, 3]); // ...but that only connections 0 and 2 were successful. assert.deepEqual(received, [0, 2]); }); process.on('unhandledRejection', function() { console.error('promise rejected'); common.fail('A promise in the chain rejected'); }); node-v4.8.2/test/parallel/test-net-server-max-connections.js000644 000766 000024 00000004026 13070706737 024247 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const net = require('net'); // This test creates 20 connections to a server and sets the server's // maxConnections property to 10. The first 10 connections make it through // and the last 10 connections are rejected. const N = 20; var closes = 0; const waits = []; const server = net.createServer(common.mustCall(function(connection) { connection.write('hello'); waits.push(function() { connection.end(); }); }, N / 2)); server.listen(0, function() { makeConnection(0); }); server.maxConnections = N / 2; function makeConnection(index) { const c = net.createConnection(server.address().port); var gotData = false; c.on('connect', function() { if (index + 1 < N) { makeConnection(index + 1); } c.on('close', function() { console.error('closed %d', index); closes++; if (closes < N / 2) { assert.ok( server.maxConnections <= index, `${index} should not have been one of the first closed connections` ); } if (closes === N / 2) { var cb; console.error('calling wait callback.'); while (cb = waits.shift()) { cb(); } server.close(); } if (index < server.maxConnections) { assert.strictEqual(true, gotData, `${index} didn't get data, but should have`); } else { assert.strictEqual(false, gotData, `${index} got data, but shouldn't have`); } }); }); c.on('end', function() { c.end(); }); c.on('data', function(b) { gotData = true; assert.ok(0 < b.length); }); c.on('error', function(e) { // Retry if SmartOS and ECONNREFUSED. See // https://github.com/nodejs/node/issues/2663. if (common.isSunOS && (e.code === 'ECONNREFUSED')) { c.connect(server.address().port); } console.error('error %d: %s', index, e); }); } process.on('exit', function() { assert.strictEqual(N, closes); }); node-v4.8.2/test/parallel/test-net-server-pause-on-connect.js000644 000766 000024 00000002450 13070706737 024317 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const net = require('net'); const msg = 'test'; var stopped = true; var server1Sock; const server1ConnHandler = function(socket) { socket.on('data', function(data) { if (stopped) { common.fail('data event should not have happened yet'); } assert.equal(data.toString(), msg, 'invalid data received'); socket.end(); server1.close(); }); server1Sock = socket; }; const server1 = net.createServer({pauseOnConnect: true}, server1ConnHandler); const server2ConnHandler = function(socket) { socket.on('data', function(data) { assert.equal(data.toString(), msg, 'invalid data received'); socket.end(); server2.close(); assert.equal(server1Sock.bytesRead, 0, 'no data should have been read yet'); server1Sock.resume(); stopped = false; }); }; const server2 = net.createServer({pauseOnConnect: false}, server2ConnHandler); server1.listen(0, function() { const clientHandler = common.mustCall(function() { server2.listen(0, function() { net.createConnection({port: this.address().port}).write(msg); }); }); net.createConnection({port: this.address().port}).write(msg, clientHandler); }); process.on('exit', function() { assert.equal(stopped, false); }); node-v4.8.2/test/parallel/test-net-server-try-ports.js000644 000766 000024 00000001223 13070706737 023121 0ustar00iojsstaff000000 000000 'use strict'; // This test binds to one port, then attempts to start a server on that // port. It should be EADDRINUSE but be able to then bind to another port. const common = require('../common'); const assert = require('assert'); const net = require('net'); const server1 = net.Server(); const server2 = net.Server(); server2.on('error', common.mustCall(function(e) { assert.strictEqual(e.code, 'EADDRINUSE'); server2.listen(0, common.mustCall(function() { server1.close(); server2.close(); })); })); server1.listen(0, common.mustCall(function() { // This should make server2 emit EADDRINUSE server2.listen(this.address().port); })); node-v4.8.2/test/parallel/test-net-server-unref-persistent.js000644 000766 000024 00000000545 13070706737 024461 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var net = require('net'); var server = net.createServer(); // unref before listening server.unref(); server.listen(); // If the timeout fires, that means the server held the event loop open // and the unref() was not persistent. Close the server and fail the test. setTimeout(common.fail, 1000).unref(); node-v4.8.2/test/parallel/test-net-server-unref.js000644 000766 000024 00000000252 13070706737 022256 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var net = require('net'); var s = net.createServer(); s.listen(0); s.unref(); setTimeout(common.fail, 1000).unref(); node-v4.8.2/test/parallel/test-net-settimeout.js000644 000766 000024 00000001372 13070706737 022041 0ustar00iojsstaff000000 000000 'use strict'; // This example sets a timeout then immediately attempts to disable the timeout // https://github.com/joyent/node/pull/2245 const common = require('../common'); const net = require('net'); const assert = require('assert'); const T = 100; const server = net.createServer(common.mustCall((c) => { c.write('hello'); })); server.listen(0, function() { const socket = net.createConnection(this.address().port, 'localhost'); const s = socket.setTimeout(T, () => { common.fail('Socket timeout event is not expected to fire'); }); assert.ok(s instanceof net.Socket); socket.on('data', common.mustCall(() => { setTimeout(function() { socket.destroy(); server.close(); }, T * 2); })); socket.setTimeout(0); }); node-v4.8.2/test/parallel/test-net-socket-destroy-twice.js000644 000766 000024 00000000363 13070706737 023726 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var net = require('net'); var conn = net.createConnection(common.PORT); conn.on('error', common.mustCall(function() { conn.destroy(); })); conn.on('close', common.mustCall(function() {})); node-v4.8.2/test/parallel/test-net-socket-local-address.js000644 000766 000024 00000001655 13070706737 023646 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const net = require('net'); // skip test in FreeBSD jails if (common.inFreeBSDJail) { common.skip('In a FreeBSD jail'); return; } var conns = 0; var clientLocalPorts = []; var serverRemotePorts = []; const client = new net.Socket(); const server = net.createServer((socket) => { serverRemotePorts.push(socket.remotePort); socket.end(); }); server.on('close', common.mustCall(() => { assert.deepEqual(clientLocalPorts, serverRemotePorts, 'client and server should agree on the ports used'); assert.strictEqual(2, conns); })); server.listen(0, common.localhostIPv4, connect); function connect() { if (conns === 2) { server.close(); return; } conns++; client.once('close', connect); client.connect(server.address().port, common.localhostIPv4, () => { clientLocalPorts.push(client.localPort); }); } node-v4.8.2/test/parallel/test-net-socket-timeout-unref.js000644 000766 000024 00000001507 13070706737 023730 0ustar00iojsstaff000000 000000 'use strict'; // Test that unref'ed sockets with timeouts do not prevent exit. const common = require('../common'); const net = require('net'); const server = net.createServer(function(c) { c.write('hello'); c.unref(); }); server.listen(0); server.unref(); var connections = 0; const sockets = []; const delays = [8, 5, 3, 6, 2, 4]; delays.forEach(function(T) { const socket = net.createConnection(server.address().port, 'localhost'); socket.on('connect', common.mustCall(function() { if (++connections === delays.length) { sockets.forEach(function(s) { s.socket.setTimeout(s.timeout, function() { s.socket.destroy(); throw new Error('socket timed out unexpectedly'); }); s.socket.unref(); }); } })); sockets.push({socket: socket, timeout: T * 1000}); }); node-v4.8.2/test/parallel/test-net-socket-timeout.js000644 000766 000024 00000002202 13070706737 022604 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var net = require('net'); var assert = require('assert'); // Verify that invalid delays throw var noop = function() {}; var s = new net.Socket(); var nonNumericDelays = ['100', true, false, undefined, null, '', {}, noop, []]; var badRangeDelays = [-0.001, -1, -Infinity, Infinity, NaN]; var validDelays = [0, 0.001, 1, 1e6]; for (let i = 0; i < nonNumericDelays.length; i++) { assert.throws(function() { s.setTimeout(nonNumericDelays[i], noop); }, TypeError); } for (let i = 0; i < badRangeDelays.length; i++) { assert.throws(function() { s.setTimeout(badRangeDelays[i], noop); }, RangeError); } for (let i = 0; i < validDelays.length; i++) { assert.doesNotThrow(function() { s.setTimeout(validDelays[i], noop); }); } var server = net.Server(); server.listen(0, common.mustCall(function() { var socket = net.createConnection(this.address().port); socket.setTimeout(100, common.mustCall(function() { socket.destroy(); server.close(); clearTimeout(timer); })); var timer = setTimeout(function() { process.exit(1); }, common.platformTimeout(200)); })); node-v4.8.2/test/parallel/test-net-stream.js000644 000766 000024 00000002104 13070706737 021124 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var net = require('net'); var s = new net.Stream(); // test that destroy called on a stream with a server only ever decrements the // server connection count once s.server = new net.Server(); s.server.connections = 10; s._server = s.server; assert.equal(10, s.server.connections); s.destroy(); assert.equal(9, s.server.connections); s.destroy(); assert.equal(9, s.server.connections); var SIZE = 2E6; var N = 10; var buf = new Buffer(SIZE); buf.fill(0x61); // 'a' var server = net.createServer(function(socket) { socket.setNoDelay(); socket.on('error', function(err) { socket.destroy(); }).on('close', function() { server.close(); }); for (var i = 0; i < N; ++i) { socket.write(buf, function() { }); } socket.end(); }).listen(0, function() { var conn = net.connect(this.address().port); conn.on('data', function(buf) { conn.pause(); setTimeout(function() { conn.destroy(); }, 20); }); }); process.on('exit', function() { assert.equal(server.connections, 0); }); node-v4.8.2/test/parallel/test-net-sync-cork.js000644 000766 000024 00000001354 13070706737 021547 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const net = require('net'); const server = net.createServer(handle); const N = 100; const buf = Buffer('aa'); server.listen(0, function() { const conn = net.connect(this.address().port); conn.on('connect', () => { let res = true; let i = 0; for (; i < N && res; i++) { conn.cork(); conn.write(buf); res = conn.write(buf); conn.uncork(); } assert.equal(i, N); conn.end(); }); }); process.on('exit', function() { assert.equal(server.connections, 0); }); function handle(socket) { socket.resume(); socket.on('error', function(err) { socket.destroy(); }).on('close', function() { server.close(); }); } node-v4.8.2/test/parallel/test-net-write-after-close.js000644 000766 000024 00000001107 13070706737 023167 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var net = require('net'); var server = net.createServer(common.mustCall(function(socket) { socket.resume(); socket.on('error', common.mustCall(function(error) { console.error('got error, closing server', error); server.close(); })); setTimeout(common.mustCall(function() { console.error('about to try to write'); socket.write('test', common.mustCall(function(e) {})); }), 250); })); server.listen(0, function() { var client = net.connect(this.address().port, function() { client.end(); }); }); node-v4.8.2/test/parallel/test-net-write-connect-write.js000644 000766 000024 00000001153 13070706737 023545 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var net = require('net'); var server = net.createServer(function(socket) { socket.pipe(socket); }).listen(0, common.mustCall(function() { var conn = net.connect(this.address().port); var received = ''; conn.setEncoding('utf8'); conn.write('before'); conn.on('connect', function() { conn.write('after'); }); conn.on('data', function(buf) { received += buf; conn.end(); }); conn.on('end', common.mustCall(function() { server.close(); assert.strictEqual(received, 'before' + 'after'); })); })); node-v4.8.2/test/parallel/test-net-write-fully-async-buffer.js000644 000766 000024 00000001552 13070706737 024504 0ustar00iojsstaff000000 000000 'use strict'; // Flags: --expose-gc // Note: This is a variant of test-net-write-fully-async-hex-string.js. // This always worked, but it seemed appropriate to add a test that checks the // behaviour for Buffers, too. const common = require('../common'); const net = require('net'); const data = Buffer.alloc(1000000); const server = net.createServer(common.mustCall(function(conn) { conn.resume(); })).listen(0, common.mustCall(function() { const conn = net.createConnection(this.address().port, common.mustCall(() => { let count = 0; function writeLoop() { if (count++ === 200) { conn.destroy(); server.close(); return; } while (conn.write(Buffer.from(data))); global.gc(true); // The buffer allocated above should still be alive. } conn.on('drain', writeLoop); writeLoop(); })); })); node-v4.8.2/test/parallel/test-net-write-fully-async-hex-string.js000644 000766 000024 00000001423 13070706737 025320 0ustar00iojsstaff000000 000000 'use strict'; // Flags: --expose-gc // Regression test for https://github.com/nodejs/node/issues/8251. const common = require('../common'); const net = require('net'); const data = Buffer.alloc(1000000).toString('hex'); const server = net.createServer(common.mustCall(function(conn) { conn.resume(); })).listen(0, common.mustCall(function() { const conn = net.createConnection(this.address().port, common.mustCall(() => { let count = 0; function writeLoop() { if (count++ === 20) { conn.destroy(); server.close(); return; } while (conn.write(data, 'hex')); global.gc(true); // The buffer allocated inside the .write() call should still be alive. } conn.on('drain', writeLoop); writeLoop(); })); })); node-v4.8.2/test/parallel/test-net-write-slow.js000644 000766 000024 00000001722 13070706737 021752 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var net = require('net'); var SIZE = 2E5; var N = 10; var flushed = 0; var received = 0; var buf = new Buffer(SIZE); buf.fill(0x61); // 'a' var server = net.createServer(function(socket) { socket.setNoDelay(); socket.setTimeout(9999); socket.on('timeout', function() { common.fail(`flushed: ${flushed}, received: ${received}/${SIZE * N}`); }); for (var i = 0; i < N; ++i) { socket.write(buf, function() { ++flushed; if (flushed === N) { socket.setTimeout(0); } }); } socket.end(); }).listen(0, common.mustCall(function() { var conn = net.connect(this.address().port); conn.on('data', function(buf) { received += buf.length; conn.pause(); setTimeout(function() { conn.resume(); }, 20); }); conn.on('end', common.mustCall(function() { server.close(); assert.strictEqual(received, SIZE * N); })); })); node-v4.8.2/test/parallel/test-next-tick-doesnt-hang.js000644 000766 000024 00000000361 13070706737 023163 0ustar00iojsstaff000000 000000 'use strict'; /* * This test verifies that having a single nextTick statement and nothing else * does not hang the event loop. If this test times out it has failed. */ require('../common'); process.nextTick(function() { // Nothing }); node-v4.8.2/test/parallel/test-next-tick-domain.js000644 000766 000024 00000000365 13070706737 022227 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var origNextTick = process.nextTick; require('domain'); assert.strictEqual(origNextTick, process.nextTick, 'Requiring domain should not change nextTick'); node-v4.8.2/test/parallel/test-next-tick-errors.js000644 000766 000024 00000001651 13070706737 022273 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); const order = []; let exceptionHandled = false; // This nextTick function will throw an error. It should only be called once. // When it throws an error, it should still get removed from the queue. process.nextTick(function() { order.push('A'); // cause an error what(); // eslint-disable-line no-undef }); // This nextTick function should remain in the queue when the first one // is removed. It should be called if the error in the first one is // caught (which we do in this test). process.nextTick(function() { order.push('C'); }); process.on('uncaughtException', function() { if (!exceptionHandled) { exceptionHandled = true; order.push('B'); } else { // If we get here then the first process.nextTick got called twice order.push('OOPS!'); } }); process.on('exit', function() { assert.deepEqual(['A', 'B', 'C'], order); }); node-v4.8.2/test/parallel/test-next-tick-intentional-starvation.js000644 000766 000024 00000001632 13070706737 025472 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); // this is the inverse of test-next-tick-starvation. // it verifies that process.nextTick will *always* come before other // events, up to the limit of the process.maxTickDepth value. // WARNING: unsafe! process.maxTickDepth = Infinity; var ran = false; var starved = false; var start = +new Date(); var timerRan = false; function spin() { ran = true; var now = +new Date(); if (now - start > 100) { console.log('The timer is starving, just as we planned.'); starved = true; // now let it out. return; } process.nextTick(spin); } function onTimeout() { if (!starved) throw new Error('The timer escaped!'); console.log('The timer ran once the ban was lifted'); timerRan = true; } spin(); setTimeout(onTimeout, 50); process.on('exit', function() { assert.ok(ran); assert.ok(starved); assert.ok(timerRan); }); node-v4.8.2/test/parallel/test-next-tick-ordering.js000644 000766 000024 00000001222 13070706737 022562 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var i; var N = 30; var done = []; function get_printer(timeout) { return function() { console.log('Running from setTimeout ' + timeout); done.push(timeout); }; } process.nextTick(function() { console.log('Running from nextTick'); done.push('nextTick'); }); for (i = 0; i < N; i += 1) { setTimeout(get_printer(i), i); } console.log('Running from main.'); process.on('exit', function() { assert.equal('nextTick', done[0]); /* Disabling this test. I don't think we can ensure the order for (i = 0; i < N; i += 1) { assert.equal(i, done[i + 1]); } */ }); node-v4.8.2/test/parallel/test-next-tick-ordering2.js000644 000766 000024 00000000527 13070706737 022653 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var order = []; process.nextTick(function() { setTimeout(function() { order.push('setTimeout'); }, 0); process.nextTick(function() { order.push('nextTick'); }); }); process.on('exit', function() { assert.deepEqual(order, ['nextTick', 'setTimeout']); }); node-v4.8.2/test/parallel/test-next-tick-when-exiting.js000644 000766 000024 00000000466 13070706737 023370 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); process.on('exit', () => { assert.strictEqual(process._exiting, true, 'process._exiting was not set!'); process.nextTick(() => { common.fail('process is exiting, should not be called.'); }); }); process.exit(); node-v4.8.2/test/parallel/test-next-tick.js000644 000766 000024 00000001101 13070706737 020747 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); process.nextTick(common.mustCall(function() { process.nextTick(common.mustCall(function() { process.nextTick(common.mustCall(function() {})); })); })); setTimeout(common.mustCall(function() { process.nextTick(common.mustCall(function() {})); }), 50); process.nextTick(common.mustCall(function() {})); var obj = {}; process.nextTick(function(a, b) { assert.equal(a, 42); assert.equal(b, obj); }, 42, obj); process.on('exit', function() { process.nextTick(common.fail); }); node-v4.8.2/test/parallel/test-npm-install.js000644 000766 000024 00000002610 13070706737 021305 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const path = require('path'); const spawn = require('child_process').spawn; const assert = require('assert'); const fs = require('fs'); common.refreshTmpDir(); const npmSandbox = path.join(common.tmpDir, 'npm-sandbox'); fs.mkdirSync(npmSandbox); const installDir = path.join(common.tmpDir, 'install-dir'); fs.mkdirSync(installDir); const npmPath = path.join( common.testDir, '..', 'deps', 'npm', 'bin', 'npm-cli.js' ); const args = [ npmPath, 'install' ]; const pkgContent = JSON.stringify({ dependencies: { 'package-name': common.fixturesDir + '/packages/main' } }); const pkgPath = path.join(installDir, 'package.json'); fs.writeFileSync(pkgPath, pkgContent); const env = Object.create(process.env); env['PATH'] = path.dirname(process.execPath); env['NPM_CONFIG_PREFIX'] = path.join(npmSandbox, 'npm-prefix'); env['NPM_CONFIG_TMP'] = path.join(npmSandbox, 'npm-tmp'); env['HOME'] = path.join(npmSandbox, 'home'); const proc = spawn(process.execPath, args, { cwd: installDir, env: env }); function handleExit(code, signalCode) { assert.strictEqual(code, 0, `npm install got error code ${code}`); assert.strictEqual(signalCode, null, `unexpected signal: ${signalCode}`); assert.doesNotThrow(function() { fs.accessSync(installDir + '/node_modules/package-name'); }); } proc.on('exit', common.mustCall(handleExit)); node-v4.8.2/test/parallel/test-os-homedir-no-envvar.js000644 000766 000024 00000001307 13070706737 023030 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const cp = require('child_process'); const os = require('os'); const path = require('path'); if (process.argv[2] === 'child') { if (common.isWindows) assert.strictEqual(process.env.USERPROFILE, undefined); else assert.strictEqual(process.env.HOME, undefined); const home = os.homedir(); assert.strictEqual(typeof home, 'string'); assert(home.includes(path.sep)); } else { if (common.isWindows) delete process.env.USERPROFILE; else delete process.env.HOME; const child = cp.spawnSync(process.execPath, [__filename, 'child'], { env: process.env }); assert.equal(child.status, 0); } node-v4.8.2/test/parallel/test-os.js000644 000766 000024 00000007212 13070706737 017473 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var os = require('os'); var path = require('path'); process.env.TMPDIR = '/tmpdir'; process.env.TMP = '/tmp'; process.env.TEMP = '/temp'; if (common.isWindows) { assert.equal(os.tmpdir(), '/temp'); process.env.TEMP = ''; assert.equal(os.tmpdir(), '/tmp'); process.env.TMP = ''; const expected = (process.env.SystemRoot || process.env.windir) + '\\temp'; assert.equal(os.tmpdir(), expected); process.env.TEMP = '\\temp\\'; assert.equal(os.tmpdir(), '\\temp'); process.env.TEMP = '\\tmpdir/'; assert.equal(os.tmpdir(), '\\tmpdir/'); process.env.TEMP = '\\'; assert.equal(os.tmpdir(), '\\'); process.env.TEMP = 'C:\\'; assert.equal(os.tmpdir(), 'C:\\'); } else { assert.equal(os.tmpdir(), '/tmpdir'); process.env.TMPDIR = ''; assert.equal(os.tmpdir(), '/tmp'); process.env.TMP = ''; assert.equal(os.tmpdir(), '/temp'); process.env.TEMP = ''; assert.equal(os.tmpdir(), '/tmp'); process.env.TMPDIR = '/tmpdir/'; assert.equal(os.tmpdir(), '/tmpdir'); process.env.TMPDIR = '/tmpdir\\'; assert.equal(os.tmpdir(), '/tmpdir\\'); process.env.TMPDIR = '/'; assert.equal(os.tmpdir(), '/'); } var endianness = os.endianness(); console.log('endianness = %s', endianness); assert.ok(/[BL]E/.test(endianness)); var hostname = os.hostname(); console.log('hostname = %s', hostname); assert.ok(hostname.length > 0); var uptime = os.uptime(); console.log('uptime = %d', uptime); assert.ok(uptime > 0); var cpus = os.cpus(); console.log('cpus = ', cpus); assert.ok(cpus.length > 0); var type = os.type(); console.log('type = ', type); assert.ok(type.length > 0); var release = os.release(); console.log('release = ', release); assert.ok(release.length > 0); //TODO: Check format on more than just AIX if (common.isAix) assert.ok(/^\d+\.\d+$/.test(release)); var platform = os.platform(); console.log('platform = ', platform); assert.ok(platform.length > 0); var arch = os.arch(); console.log('arch = ', arch); assert.ok(arch.length > 0); if (process.platform != 'sunos') { // not implemeneted yet assert.ok(os.loadavg().length > 0); assert.ok(os.freemem() > 0); assert.ok(os.totalmem() > 0); } var interfaces = os.networkInterfaces(); console.error(interfaces); switch (platform) { case 'linux': { const filter = function(e) { return e.address == '127.0.0.1'; }; const actual = interfaces.lo.filter(filter); const expected = [{ address: '127.0.0.1', netmask: '255.0.0.0', mac: '00:00:00:00:00:00', family: 'IPv4', internal: true }]; assert.deepEqual(actual, expected); break; } case 'win32': { const filter = function(e) { return e.address == '127.0.0.1'; }; const actual = interfaces['Loopback Pseudo-Interface 1'].filter(filter); const expected = [{ address: '127.0.0.1', netmask: '255.0.0.0', mac: '00:00:00:00:00:00', family: 'IPv4', internal: true }]; assert.deepEqual(actual, expected); break; } } var EOL = os.EOL; assert.ok(EOL.length > 0); var home = os.homedir(); console.log('homedir = ' + home); assert.ok(typeof home === 'string'); assert.ok(home.indexOf(path.sep) !== -1); if (common.isWindows && process.env.USERPROFILE) { assert.equal(home, process.env.USERPROFILE); delete process.env.USERPROFILE; assert.ok(os.homedir().indexOf(path.sep) !== -1); process.env.USERPROFILE = home; } else if (!common.isWindows && process.env.HOME) { assert.equal(home, process.env.HOME); delete process.env.HOME; assert.ok(os.homedir().indexOf(path.sep) !== -1); process.env.HOME = home; } node-v4.8.2/test/parallel/test-path-makelong.js000644 000766 000024 00000001670 13070706737 021603 0ustar00iojsstaff000000 000000 'use strict'; var assert = require('assert'); var path = require('path'); var common = require('../common'); if (common.isWindows) { var file = path.join(common.fixturesDir, 'a.js'); var resolvedFile = path.resolve(file); assert.equal('\\\\?\\' + resolvedFile, path._makeLong(file)); assert.equal('\\\\?\\' + resolvedFile, path._makeLong('\\\\?\\' + file)); assert.equal('\\\\?\\UNC\\someserver\\someshare\\somefile', path._makeLong('\\\\someserver\\someshare\\somefile')); assert.equal('\\\\?\\UNC\\someserver\\someshare\\somefile', path._makeLong('\\\\?\\UNC\\someserver\\someshare\\somefile')); assert.equal('\\\\.\\pipe\\somepipe', path._makeLong('\\\\.\\pipe\\somepipe')); } assert.equal(path._makeLong(null), null); assert.equal(path._makeLong(100), 100); assert.equal(path._makeLong(path), path); assert.equal(path._makeLong(false), false); assert.equal(path._makeLong(true), true); node-v4.8.2/test/parallel/test-path-parse-format.js000644 000766 000024 00000006675 13070706737 022420 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var path = require('path'); var winPaths = [ 'C:\\path\\dir\\index.html', 'C:\\another_path\\DIR\\1\\2\\33\\index', 'another_path\\DIR with spaces\\1\\2\\33\\index', '\\foo\\C:', 'file', '.\\file', '', // unc '\\\\server\\share\\file_path', '\\\\server two\\shared folder\\file path.zip', '\\\\teela\\admin$\\system32', '\\\\?\\UNC\\server\\share' ]; var winSpecialCaseFormatTests = [ [{dir: 'some\\dir'}, 'some\\dir\\'], [{base: 'index.html'}, 'index.html'], [{}, ''] ]; var unixPaths = [ '/home/user/dir/file.txt', '/home/user/a dir/another File.zip', '/home/user/a dir//another&File.', '/home/user/a$$$dir//another File.zip', 'user/dir/another File.zip', 'file', '.\\file', './file', 'C:\\foo', '' ]; var unixSpecialCaseFormatTests = [ [{dir: 'some/dir'}, 'some/dir/'], [{base: 'index.html'}, 'index.html'], [{}, ''] ]; var errors = [ {method: 'parse', input: [null], message: /Path must be a string. Received null/}, {method: 'parse', input: [{}], message: /Path must be a string. Received {}/}, {method: 'parse', input: [true], message: /Path must be a string. Received true/}, {method: 'parse', input: [1], message: /Path must be a string. Received 1/}, {method: 'parse', input: [], message: /Path must be a string. Received undefined/}, {method: 'format', input: [null], message: /Parameter 'pathObject' must be an object, not/}, {method: 'format', input: [''], message: /Parameter 'pathObject' must be an object, not string/}, {method: 'format', input: [true], message: /Parameter 'pathObject' must be an object, not boolean/}, {method: 'format', input: [1], message: /Parameter 'pathObject' must be an object, not number/}, {method: 'format', input: [{root: true}], message: /'pathObject.root' must be a string or undefined, not boolean/}, {method: 'format', input: [{root: 12}], message: /'pathObject.root' must be a string or undefined, not number/}, ]; checkParseFormat(path.win32, winPaths); checkParseFormat(path.posix, unixPaths); checkErrors(path.win32); checkErrors(path.posix); checkFormat(path.win32, winSpecialCaseFormatTests); checkFormat(path.posix, unixSpecialCaseFormatTests); function checkErrors(path) { errors.forEach(function(errorCase) { try { path[errorCase.method].apply(path, errorCase.input); } catch (err) { assert.ok(err instanceof TypeError); assert.ok( errorCase.message.test(err.message), 'expected ' + errorCase.message + ' to match ' + err.message ); return; } common.fail(null, null, 'should have thrown'); }); } function checkParseFormat(path, paths) { paths.forEach(function(element) { var output = path.parse(element); assert.strictEqual(typeof output.root, 'string'); assert.strictEqual(typeof output.dir, 'string'); assert.strictEqual(typeof output.base, 'string'); assert.strictEqual(typeof output.ext, 'string'); assert.strictEqual(typeof output.name, 'string'); assert.strictEqual(path.format(output), element); assert.strictEqual(output.dir, output.dir ? path.dirname(element) : ''); assert.strictEqual(output.base, path.basename(element)); assert.strictEqual(output.ext, path.extname(element)); }); } function checkFormat(path, testCases) { testCases.forEach(function(testCase) { assert.strictEqual(path.format(testCase[0]), testCase[1]); }); } node-v4.8.2/test/parallel/test-path-zero-length-strings.js000644 000766 000024 00000002503 13070706737 023727 0ustar00iojsstaff000000 000000 'use strict'; // These testcases are specific to one uncommon behaviour in path module. Few // of the functions in path module, treat '' strings as current working // directory. This test makes sure that the behaviour is intact between commits. // See: https://github.com/nodejs/node/pull/2106 require('../common'); const assert = require('assert'); const path = require('path'); const pwd = process.cwd(); // join will internally ignore all the zero-length strings and it will return // '.' if the joined string is a zero-length string. assert.equal(path.join(''), '.'); assert.equal(path.join('', ''), '.'); assert.equal(path.join(pwd), pwd); assert.equal(path.join(pwd, ''), pwd); // normalize will return '.' if the input is a zero-length string assert.equal(path.normalize(''), '.'); assert.equal(path.normalize(pwd), pwd); // Since '' is not a valid path in any of the common environments, return false assert.equal(path.isAbsolute(''), false); // resolve, internally ignores all the zero-length strings and returns the // current working directory assert.equal(path.resolve(''), pwd); assert.equal(path.resolve('', ''), pwd); // relative, internally calls resolve. So, '' is actually the current directory assert.equal(path.relative('', pwd), ''); assert.equal(path.relative(pwd, ''), ''); assert.equal(path.relative(pwd, pwd), ''); node-v4.8.2/test/parallel/test-path.js000644 000766 000024 00000040611 13070706737 020006 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var path = require('path'); var f = __filename; assert.equal(path.basename(f), 'test-path.js'); assert.equal(path.basename(f, '.js'), 'test-path'); assert.equal(path.basename(''), ''); assert.equal(path.basename('/dir/basename.ext'), 'basename.ext'); assert.equal(path.basename('/basename.ext'), 'basename.ext'); assert.equal(path.basename('basename.ext'), 'basename.ext'); assert.equal(path.basename('basename.ext/'), 'basename.ext'); assert.equal(path.basename('basename.ext//'), 'basename.ext'); // On Windows a backslash acts as a path separator. assert.equal(path.win32.basename('\\dir\\basename.ext'), 'basename.ext'); assert.equal(path.win32.basename('\\basename.ext'), 'basename.ext'); assert.equal(path.win32.basename('basename.ext'), 'basename.ext'); assert.equal(path.win32.basename('basename.ext\\'), 'basename.ext'); assert.equal(path.win32.basename('basename.ext\\\\'), 'basename.ext'); // On unix a backslash is just treated as any other character. assert.equal(path.posix.basename('\\dir\\basename.ext'), '\\dir\\basename.ext'); assert.equal(path.posix.basename('\\basename.ext'), '\\basename.ext'); assert.equal(path.posix.basename('basename.ext'), 'basename.ext'); assert.equal(path.posix.basename('basename.ext\\'), 'basename.ext\\'); assert.equal(path.posix.basename('basename.ext\\\\'), 'basename.ext\\\\'); // POSIX filenames may include control characters // c.f. http://www.dwheeler.com/essays/fixing-unix-linux-filenames.html if (!common.isWindows) { var controlCharFilename = 'Icon' + String.fromCharCode(13); assert.equal(path.basename('/a/b/' + controlCharFilename), controlCharFilename); } assert.equal(path.extname(f), '.js'); assert.equal(path.dirname(f).substr(-13), common.isWindows ? 'test\\parallel' : 'test/parallel'); assert.equal(path.dirname('/a/b/'), '/a'); assert.equal(path.dirname('/a/b'), '/a'); assert.equal(path.dirname('/a'), '/'); assert.equal(path.dirname(''), '.'); assert.equal(path.dirname('/'), '/'); assert.equal(path.dirname('////'), '/'); assert.equal(path.win32.dirname('c:\\'), 'c:\\'); assert.equal(path.win32.dirname('c:\\foo'), 'c:\\'); assert.equal(path.win32.dirname('c:\\foo\\'), 'c:\\'); assert.equal(path.win32.dirname('c:\\foo\\bar'), 'c:\\foo'); assert.equal(path.win32.dirname('c:\\foo\\bar\\'), 'c:\\foo'); assert.equal(path.win32.dirname('c:\\foo\\bar\\baz'), 'c:\\foo\\bar'); assert.equal(path.win32.dirname('\\'), '\\'); assert.equal(path.win32.dirname('\\foo'), '\\'); assert.equal(path.win32.dirname('\\foo\\'), '\\'); assert.equal(path.win32.dirname('\\foo\\bar'), '\\foo'); assert.equal(path.win32.dirname('\\foo\\bar\\'), '\\foo'); assert.equal(path.win32.dirname('\\foo\\bar\\baz'), '\\foo\\bar'); assert.equal(path.win32.dirname('c:'), 'c:'); assert.equal(path.win32.dirname('c:foo'), 'c:'); assert.equal(path.win32.dirname('c:foo\\'), 'c:'); assert.equal(path.win32.dirname('c:foo\\bar'), 'c:foo'); assert.equal(path.win32.dirname('c:foo\\bar\\'), 'c:foo'); assert.equal(path.win32.dirname('c:foo\\bar\\baz'), 'c:foo\\bar'); assert.equal(path.win32.dirname('\\\\unc\\share'), '\\\\unc\\share'); assert.equal(path.win32.dirname('\\\\unc\\share\\foo'), '\\\\unc\\share\\'); assert.equal(path.win32.dirname('\\\\unc\\share\\foo\\'), '\\\\unc\\share\\'); assert.equal(path.win32.dirname('\\\\unc\\share\\foo\\bar'), '\\\\unc\\share\\foo'); assert.equal(path.win32.dirname('\\\\unc\\share\\foo\\bar\\'), '\\\\unc\\share\\foo'); assert.equal(path.win32.dirname('\\\\unc\\share\\foo\\bar\\baz'), '\\\\unc\\share\\foo\\bar'); assert.equal(path.extname(''), ''); assert.equal(path.extname('/path/to/file'), ''); assert.equal(path.extname('/path/to/file.ext'), '.ext'); assert.equal(path.extname('/path.to/file.ext'), '.ext'); assert.equal(path.extname('/path.to/file'), ''); assert.equal(path.extname('/path.to/.file'), ''); assert.equal(path.extname('/path.to/.file.ext'), '.ext'); assert.equal(path.extname('/path/to/f.ext'), '.ext'); assert.equal(path.extname('/path/to/..ext'), '.ext'); assert.equal(path.extname('file'), ''); assert.equal(path.extname('file.ext'), '.ext'); assert.equal(path.extname('.file'), ''); assert.equal(path.extname('.file.ext'), '.ext'); assert.equal(path.extname('/file'), ''); assert.equal(path.extname('/file.ext'), '.ext'); assert.equal(path.extname('/.file'), ''); assert.equal(path.extname('/.file.ext'), '.ext'); assert.equal(path.extname('.path/file.ext'), '.ext'); assert.equal(path.extname('file.ext.ext'), '.ext'); assert.equal(path.extname('file.'), '.'); assert.equal(path.extname('.'), ''); assert.equal(path.extname('./'), ''); assert.equal(path.extname('.file.ext'), '.ext'); assert.equal(path.extname('.file'), ''); assert.equal(path.extname('.file.'), '.'); assert.equal(path.extname('.file..'), '.'); assert.equal(path.extname('..'), ''); assert.equal(path.extname('../'), ''); assert.equal(path.extname('..file.ext'), '.ext'); assert.equal(path.extname('..file'), '.file'); assert.equal(path.extname('..file.'), '.'); assert.equal(path.extname('..file..'), '.'); assert.equal(path.extname('...'), '.'); assert.equal(path.extname('...ext'), '.ext'); assert.equal(path.extname('....'), '.'); assert.equal(path.extname('file.ext/'), '.ext'); assert.equal(path.extname('file.ext//'), '.ext'); assert.equal(path.extname('file/'), ''); assert.equal(path.extname('file//'), ''); assert.equal(path.extname('file./'), '.'); assert.equal(path.extname('file.//'), '.'); // On windows, backspace is a path separator. assert.equal(path.win32.extname('.\\'), ''); assert.equal(path.win32.extname('..\\'), ''); assert.equal(path.win32.extname('file.ext\\'), '.ext'); assert.equal(path.win32.extname('file.ext\\\\'), '.ext'); assert.equal(path.win32.extname('file\\'), ''); assert.equal(path.win32.extname('file\\\\'), ''); assert.equal(path.win32.extname('file.\\'), '.'); assert.equal(path.win32.extname('file.\\\\'), '.'); // On unix, backspace is a valid name component like any other character. assert.equal(path.posix.extname('.\\'), ''); assert.equal(path.posix.extname('..\\'), '.\\'); assert.equal(path.posix.extname('file.ext\\'), '.ext\\'); assert.equal(path.posix.extname('file.ext\\\\'), '.ext\\\\'); assert.equal(path.posix.extname('file\\'), ''); assert.equal(path.posix.extname('file\\\\'), ''); assert.equal(path.posix.extname('file.\\'), '.\\'); assert.equal(path.posix.extname('file.\\\\'), '.\\\\'); // path.join tests var failures = []; var joinTests = // arguments result [[['.', 'x/b', '..', '/b/c.js'], 'x/b/c.js'], [['/.', 'x/b', '..', '/b/c.js'], '/x/b/c.js'], [['/foo', '../../../bar'], '/bar'], [['foo', '../../../bar'], '../../bar'], [['foo/', '../../../bar'], '../../bar'], [['foo/x', '../../../bar'], '../bar'], [['foo/x', './bar'], 'foo/x/bar'], [['foo/x/', './bar'], 'foo/x/bar'], [['foo/x/', '.', 'bar'], 'foo/x/bar'], [['./'], './'], [['.', './'], './'], [['.', '.', '.'], '.'], [['.', './', '.'], '.'], [['.', '/./', '.'], '.'], [['.', '/////./', '.'], '.'], [['.'], '.'], [['', '.'], '.'], [['', 'foo'], 'foo'], [['foo', '/bar'], 'foo/bar'], [['', '/foo'], '/foo'], [['', '', '/foo'], '/foo'], [['', '', 'foo'], 'foo'], [['foo', ''], 'foo'], [['foo/', ''], 'foo/'], [['foo', '', '/bar'], 'foo/bar'], [['./', '..', '/foo'], '../foo'], [['./', '..', '..', '/foo'], '../../foo'], [['.', '..', '..', '/foo'], '../../foo'], [['', '..', '..', '/foo'], '../../foo'], [['/'], '/'], [['/', '.'], '/'], [['/', '..'], '/'], [['/', '..', '..'], '/'], [[''], '.'], [['', ''], '.'], [[' /foo'], ' /foo'], [[' ', 'foo'], ' /foo'], [[' ', '.'], ' '], [[' ', '/'], ' /'], [[' ', ''], ' '], [['/', 'foo'], '/foo'], [['/', '/foo'], '/foo'], [['/', '//foo'], '/foo'], [['/', '', '/foo'], '/foo'], [['', '/', 'foo'], '/foo'], [['', '/', '/foo'], '/foo'] ]; // Windows-specific join tests if (common.isWindows) { joinTests = joinTests.concat( [// UNC path expected [['//foo/bar'], '//foo/bar/'], [['\\/foo/bar'], '//foo/bar/'], [['\\\\foo/bar'], '//foo/bar/'], // UNC path expected - server and share separate [['//foo', 'bar'], '//foo/bar/'], [['//foo/', 'bar'], '//foo/bar/'], [['//foo', '/bar'], '//foo/bar/'], // UNC path expected - questionable [['//foo', '', 'bar'], '//foo/bar/'], [['//foo/', '', 'bar'], '//foo/bar/'], [['//foo/', '', '/bar'], '//foo/bar/'], // UNC path expected - even more questionable [['', '//foo', 'bar'], '//foo/bar/'], [['', '//foo/', 'bar'], '//foo/bar/'], [['', '//foo/', '/bar'], '//foo/bar/'], // No UNC path expected (no double slash in first component) [['\\', 'foo/bar'], '/foo/bar'], [['\\', '/foo/bar'], '/foo/bar'], [['', '/', '/foo/bar'], '/foo/bar'], // No UNC path expected (no non-slashes in first component - questionable) [['//', 'foo/bar'], '/foo/bar'], [['//', '/foo/bar'], '/foo/bar'], [['\\\\', '/', '/foo/bar'], '/foo/bar'], [['//'], '/'], // No UNC path expected (share name missing - questionable). [['//foo'], '/foo'], [['//foo/'], '/foo/'], [['//foo', '/'], '/foo/'], [['//foo', '', '/'], '/foo/'], // No UNC path expected (too many leading slashes - questionable) [['///foo/bar'], '/foo/bar'], [['////foo', 'bar'], '/foo/bar'], [['\\\\\\/foo/bar'], '/foo/bar'], // Drive-relative vs drive-absolute paths. This merely describes the // status quo, rather than being obviously right [['c:'], 'c:.'], [['c:.'], 'c:.'], [['c:', ''], 'c:.'], [['', 'c:'], 'c:.'], [['c:.', '/'], 'c:./'], [['c:.', 'file'], 'c:file'], [['c:', '/'], 'c:/'], [['c:', 'file'], 'c:/file'] ]); } // Run the join tests. joinTests.forEach(function(test) { var actual = path.join.apply(path, test[0]); var expected = common.isWindows ? test[1].replace(/\//g, '\\') : test[1]; var message = 'path.join(' + test[0].map(JSON.stringify).join(',') + ')' + '\n expect=' + JSON.stringify(expected) + '\n actual=' + JSON.stringify(actual); if (actual !== expected) failures.push('\n' + message); // assert.equal(actual, expected, message); }); assert.equal(failures.length, 0, failures.join('')); // Test thrown TypeErrors var typeErrorTests = [true, false, 7, null, {}, undefined, [], NaN]; function fail(fn) { var args = Array.prototype.slice.call(arguments, 1); assert.throws(function() { fn.apply(null, args); }, TypeError); } typeErrorTests.forEach(function(test) { fail(path.join, test); fail(path.resolve, test); fail(path.normalize, test); fail(path.isAbsolute, test); fail(path.relative, test, 'foo'); fail(path.relative, 'foo', test); fail(path.parse, test); // These methods should throw a TypeError, but do not for backwards // compatibility. Uncommenting these lines in the future should be a goal. // fail(path.dirname, test); // fail(path.basename, test); // fail(path.extname, test); // undefined is a valid value as the second argument to basename if (test !== undefined) { fail(path.basename, 'foo', test); } }); // path normalize tests assert.equal(path.win32.normalize('./fixtures///b/../b/c.js'), 'fixtures\\b\\c.js'); assert.equal(path.win32.normalize('/foo/../../../bar'), '\\bar'); assert.equal(path.win32.normalize('a//b//../b'), 'a\\b'); assert.equal(path.win32.normalize('a//b//./c'), 'a\\b\\c'); assert.equal(path.win32.normalize('a//b//.'), 'a\\b'); assert.equal(path.win32.normalize('//server/share/dir/file.ext'), '\\\\server\\share\\dir\\file.ext'); assert.equal(path.posix.normalize('./fixtures///b/../b/c.js'), 'fixtures/b/c.js'); assert.equal(path.posix.normalize('/foo/../../../bar'), '/bar'); assert.equal(path.posix.normalize('a//b//../b'), 'a/b'); assert.equal(path.posix.normalize('a//b//./c'), 'a/b/c'); assert.equal(path.posix.normalize('a//b//.'), 'a/b'); // path.resolve tests var resolveTests; if (common.isWindows) { // windows resolveTests = // arguments result [[['c:/blah\\blah', 'd:/games', 'c:../a'], 'c:\\blah\\a'], [['c:/ignore', 'd:\\a/b\\c/d', '\\e.exe'], 'd:\\e.exe'], [['c:/ignore', 'c:/some/file'], 'c:\\some\\file'], [['d:/ignore', 'd:some/dir//'], 'd:\\ignore\\some\\dir'], [['.'], process.cwd()], [['//server/share', '..', 'relative\\'], '\\\\server\\share\\relative'], [['c:/', '//'], 'c:\\'], [['c:/', '//dir'], 'c:\\dir'], [['c:/', '//server/share'], '\\\\server\\share\\'], [['c:/', '//server//share'], '\\\\server\\share\\'], [['c:/', '///some//dir'], 'c:\\some\\dir'] ]; } else { // Posix resolveTests = // arguments result [[['/var/lib', '../', 'file/'], '/var/file'], [['/var/lib', '/../', 'file/'], '/file'], [['a/b/c/', '../../..'], process.cwd()], [['.'], process.cwd()], [['/some/dir', '.', '/absolute/'], '/absolute']]; } failures = []; resolveTests.forEach(function(test) { var actual = path.resolve.apply(path, test[0]); var expected = test[1]; var message = 'path.resolve(' + test[0].map(JSON.stringify).join(',') + ')' + '\n expect=' + JSON.stringify(expected) + '\n actual=' + JSON.stringify(actual); if (actual !== expected) failures.push('\n' + message); // assert.equal(actual, expected, message); }); assert.equal(failures.length, 0, failures.join('')); // path.isAbsolute tests assert.equal(path.win32.isAbsolute('/'), true); assert.equal(path.win32.isAbsolute('//'), true); assert.equal(path.win32.isAbsolute('//server'), true); assert.equal(path.win32.isAbsolute('//server/file'), true); assert.equal(path.win32.isAbsolute('\\\\server\\file'), true); assert.equal(path.win32.isAbsolute('\\\\server'), true); assert.equal(path.win32.isAbsolute('\\\\'), true); assert.equal(path.win32.isAbsolute('c'), false); assert.equal(path.win32.isAbsolute('c:'), false); assert.equal(path.win32.isAbsolute('c:\\'), true); assert.equal(path.win32.isAbsolute('c:/'), true); assert.equal(path.win32.isAbsolute('c://'), true); assert.equal(path.win32.isAbsolute('C:/Users/'), true); assert.equal(path.win32.isAbsolute('C:\\Users\\'), true); assert.equal(path.win32.isAbsolute('C:cwd/another'), false); assert.equal(path.win32.isAbsolute('C:cwd\\another'), false); assert.equal(path.win32.isAbsolute('directory/directory'), false); assert.equal(path.win32.isAbsolute('directory\\directory'), false); assert.equal(path.posix.isAbsolute('/home/foo'), true); assert.equal(path.posix.isAbsolute('/home/foo/..'), true); assert.equal(path.posix.isAbsolute('bar/'), false); assert.equal(path.posix.isAbsolute('./baz'), false); // path.relative tests var relativeTests; if (common.isWindows) { // windows relativeTests = // arguments result [['c:/blah\\blah', 'd:/games', 'd:\\games'], ['c:/aaaa/bbbb', 'c:/aaaa', '..'], ['c:/aaaa/bbbb', 'c:/cccc', '..\\..\\cccc'], ['c:/aaaa/bbbb', 'c:/aaaa/bbbb', ''], ['c:/aaaa/bbbb', 'c:/aaaa/cccc', '..\\cccc'], ['c:/aaaa/', 'c:/aaaa/cccc', 'cccc'], ['c:/', 'c:\\aaaa\\bbbb', 'aaaa\\bbbb'], ['c:/aaaa/bbbb', 'd:\\', 'd:\\']]; } else { // posix relativeTests = // arguments result [['/var/lib', '/var', '..'], ['/var/lib', '/bin', '../../bin'], ['/var/lib', '/var/lib', ''], ['/var/lib', '/var/apache', '../apache'], ['/var/', '/var/lib', 'lib'], ['/', '/var/lib', 'var/lib']]; } failures = []; relativeTests.forEach(function(test) { var actual = path.relative(test[0], test[1]); var expected = test[2]; var message = 'path.relative(' + test.slice(0, 2).map(JSON.stringify).join(',') + ')' + '\n expect=' + JSON.stringify(expected) + '\n actual=' + JSON.stringify(actual); if (actual !== expected) failures.push('\n' + message); }); assert.equal(failures.length, 0, failures.join('')); // windows assert.equal(path.win32.sep, '\\'); // posix assert.equal(path.posix.sep, '/'); // path.delimiter tests // windows assert.equal(path.win32.delimiter, ';'); // posix assert.equal(path.posix.delimiter, ':'); if (common.isWindows) assert.deepEqual(path, path.win32, 'should be win32 path module'); else assert.deepEqual(path, path.posix, 'should be posix path module'); node-v4.8.2/test/parallel/test-pipe-address.js000644 000766 000024 00000000465 13070706737 021435 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var net = require('net'); var server = net.createServer(common.fail); common.refreshTmpDir(); server.listen(common.PIPE, common.mustCall(function() { assert.strictEqual(server.address(), common.PIPE); server.close(); })); node-v4.8.2/test/parallel/test-pipe-file-to-http.js000644 000766 000024 00000002547 13070706737 022327 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const fs = require('fs'); const http = require('http'); const path = require('path'); const cp = require('child_process'); common.refreshTmpDir(); const filename = path.join(common.tmpDir || '/tmp', 'big'); let count = 0; const server = http.createServer(function(req, res) { let timeoutId; assert.strictEqual('POST', req.method); req.pause(); setTimeout(function() { req.resume(); }, 1000); req.on('data', function(chunk) { count += chunk.length; }); req.on('end', function() { if (timeoutId) { clearTimeout(timeoutId); } res.writeHead(200, {'Content-Type': 'text/plain'}); res.end(); }); }); server.listen(0); server.on('listening', function() { const cmd = common.ddCommand(filename, 10240); cp.exec(cmd, function(err) { if (err) throw err; makeRequest(); }); }); function makeRequest() { const req = http.request({ port: server.address().port, path: '/', method: 'POST' }); const s = fs.ReadStream(filename); s.pipe(req); s.on('close', common.mustCall((err) => { assert.ifError(err); })); req.on('response', function(res) { res.resume(); res.on('end', function() { server.close(); }); }); } process.on('exit', function() { assert.strictEqual(1024 * 10240, count); }); node-v4.8.2/test/parallel/test-pipe-head.js000644 000766 000024 00000000734 13070706737 020710 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const exec = require('child_process').exec; const join = require('path').join; const nodePath = process.argv[0]; const script = join(common.fixturesDir, 'print-10-lines.js'); const cmd = `"${nodePath}" "${script}" | head -2`; exec(cmd, common.mustCall(function(err, stdout, stderr) { assert.ifError(err); const lines = stdout.split('\n'); assert.strictEqual(3, lines.length); })); node-v4.8.2/test/parallel/test-pipe-return-val.js000644 000766 000024 00000000511 13070706737 022077 0ustar00iojsstaff000000 000000 'use strict'; // This test ensures SourceStream.pipe(DestStream) returns DestStream require('../common'); var Stream = require('stream').Stream; var assert = require('assert'); var sourceStream = new Stream(); var destStream = new Stream(); var result = sourceStream.pipe(destStream); assert.strictEqual(result, destStream); node-v4.8.2/test/parallel/test-pipe-stream.js000644 000766 000024 00000002353 13070706737 021301 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var net = require('net'); common.refreshTmpDir(); function test(clazz, cb) { var have_ping = false; var have_pong = false; function check() { assert.ok(have_ping); assert.ok(have_pong); } function ping() { var conn = new clazz(); conn.on('error', function(err) { throw err; }); conn.connect(common.PIPE, function() { conn.write('PING', 'utf-8'); }); conn.on('data', function(data) { assert.equal(data.toString(), 'PONG'); have_pong = true; conn.destroy(); }); } function pong(conn) { conn.on('error', function(err) { throw err; }); conn.on('data', function(data) { assert.equal(data.toString(), 'PING'); have_ping = true; conn.write('PONG', 'utf-8'); }); conn.on('close', function() { server.close(); }); } var timeout = setTimeout(function() { server.close(); }, 2000); var server = net.Server(); server.listen(common.PIPE, ping); server.on('connection', pong); server.on('close', function() { clearTimeout(timeout); check(); cb && cb(); }); } test(net.Stream, function() { test(net.Socket); }); node-v4.8.2/test/parallel/test-pipe-unref.js000644 000766 000024 00000000305 13070706737 021120 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var net = require('net'); common.refreshTmpDir(); var s = net.Server(); s.listen(common.PIPE); s.unref(); setTimeout(common.fail, 1000).unref(); node-v4.8.2/test/parallel/test-pipe-writev.js000644 000766 000024 00000001542 13070706737 021325 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const net = require('net'); if (common.isWindows) { common.skip('Unix-specific test'); return; } common.refreshTmpDir(); const server = net.createServer((connection) => { connection.on('error', (err) => { throw err; }); const writev = connection._writev.bind(connection); connection._writev = common.mustCall(writev); connection.cork(); connection.write('pi'); connection.write('ng'); connection.end(); }); server.on('error', (err) => { throw err; }); server.listen(common.PIPE, () => { const client = net.connect(common.PIPE); client.on('error', (err) => { throw err; }); client.on('data', common.mustCall((data) => { assert.strictEqual(data.toString(), 'ping'); })); client.on('end', () => { server.close(); }); }); node-v4.8.2/test/parallel/test-preload.js000644 000766 000024 00000005154 13070706737 020503 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const path = require('path'); const child_process = require('child_process'); var nodeBinary = process.argv[0]; var preloadOption = function(preloads) { var option = ''; preloads.forEach(function(preload, index) { option += '-r ' + preload + ' '; }); return option; }; var fixture = function(name) { return path.join(common.fixturesDir, name); }; var fixtureA = fixture('printA.js'); var fixtureB = fixture('printB.js'); var fixtureC = fixture('printC.js'); var fixtureThrows = fixture('throws_error4.js'); // test preloading a single module works child_process.exec(nodeBinary + ' ' + preloadOption([fixtureA]) + ' ' + fixtureB, function(err, stdout, stderr) { if (err) throw err; assert.strictEqual(stdout, 'A\nB\n'); }); // test preloading multiple modules works child_process.exec(nodeBinary + ' ' + preloadOption([fixtureA, fixtureB]) + ' ' + fixtureC, function(err, stdout, stderr) { if (err) throw err; assert.strictEqual(stdout, 'A\nB\nC\n'); }); // test that preloading a throwing module aborts child_process.exec(nodeBinary + ' ' + preloadOption([fixtureA, fixtureThrows]) + ' ' + fixtureB, function(err, stdout, stderr) { if (err) { assert.strictEqual(stdout, 'A\n'); } else { throw new Error('Preload should have failed'); } }); // test that preload can be used with --eval child_process.exec(nodeBinary + ' ' + preloadOption([fixtureA]) + '-e "console.log(\'hello\');"', function(err, stdout, stderr) { if (err) throw err; assert.strictEqual(stdout, 'A\nhello\n'); }); // test that preload placement at other points in the cmdline // also test that duplicated preload only gets loaded once child_process.exec(nodeBinary + ' ' + preloadOption([fixtureA]) + '-e "console.log(\'hello\');" ' + preloadOption([fixtureA, fixtureB]), function(err, stdout, stderr) { if (err) throw err; assert.strictEqual(stdout, 'A\nB\nhello\n'); }); child_process.exec(nodeBinary + ' ' + '--require ' + fixture('cluster-preload.js') + ' ' + fixture('cluster-preload-test.js'), function(err, stdout, stderr) { if (err) throw err; assert.ok(/worker terminated with code 43/.test(stdout)); }); // https://github.com/nodejs/node/issues/1691 process.chdir(common.fixturesDir); child_process.exec(nodeBinary + ' ' + '--expose_debug_as=v8debug ' + '--require ' + fixture('cluster-preload.js') + ' ' + 'cluster-preload-test.js', function(err, stdout, stderr) { if (err) throw err; assert.ok(/worker terminated with code 43/.test(stdout)); }); node-v4.8.2/test/parallel/test-process-argv-0.js000644 000766 000024 00000001014 13070706737 021614 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var path = require('path'); var assert = require('assert'); var spawn = require('child_process').spawn; if (process.argv[2] !== 'child') { var child = spawn(process.execPath, [__filename, 'child'], { cwd: path.dirname(process.execPath) }); var childArgv0 = ''; child.stdout.on('data', function(chunk) { childArgv0 += chunk; }); process.on('exit', function() { assert.equal(childArgv0, process.execPath); }); } else { process.stdout.write(process.argv[0]); } node-v4.8.2/test/parallel/test-process-assert.js000644 000766 000024 00000000461 13070706737 022026 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); assert.strictEqual(process.assert(1, 'error'), undefined); assert.throws(() => { process.assert(undefined, 'errorMessage'); }, /^Error: errorMessage$/); assert.throws(() => { process.assert(false); }, /^Error: assertion error$/); node-v4.8.2/test/parallel/test-process-before-exit.js000644 000766 000024 00000000417 13070706737 022737 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var N = 5; var n = 0; function f() { if (++n < N) setTimeout(f, 5); } process.on('beforeExit', f); process.on('exit', function() { assert.equal(n, N + 1); // The sixth time we let it through. }); node-v4.8.2/test/parallel/test-process-binding.js000644 000766 000024 00000000476 13070706737 022145 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); assert.throws( function() { process.binding('test'); }, /No such module: test/ ); assert.doesNotThrow(function() { process.binding('buffer'); }, function(err) { if (err instanceof Error) { return true; } }, 'unexpected error'); node-v4.8.2/test/parallel/test-process-chdir.js000644 000766 000024 00000002244 13070706737 021617 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const fs = require('fs'); const path = require('path'); assert.notStrictEqual(process.cwd(), __dirname); process.chdir(__dirname); assert.strictEqual(process.cwd(), __dirname); let dirName; if (process.versions.icu) { // ICU is available, use characters that could possibly be decomposed dirName = 'weird \uc3a4\uc3ab\uc3af characters \u00e1\u00e2\u00e3'; } else { // ICU is unavailable, use characters that can't be decomposed dirName = 'weird \ud83d\udc04 characters \ud83d\udc05'; } const dir = path.resolve(common.tmpDir, dirName); // Make sure that the tmp directory is clean common.refreshTmpDir(); fs.mkdirSync(dir); process.chdir(dir); assert.strictEqual(process.cwd().normalize(), dir.normalize()); process.chdir('..'); assert.strictEqual(process.cwd().normalize(), path.resolve(common.tmpDir).normalize()); assert.throws(function() { process.chdir({}); }, TypeError, 'Bad argument.'); assert.throws(function() { process.chdir(); }, TypeError, 'Bad argument.'); assert.throws(function() { process.chdir('x', 'y'); }, TypeError, 'Bad argument.'); node-v4.8.2/test/parallel/test-process-config.js000644 000766 000024 00000001274 13070706737 021775 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var fs = require('fs'); var path = require('path'); // check for existence assert(process.hasOwnProperty('config')); // ensure that `process.config` is an Object assert(Object(process.config) === process.config); var configPath = path.resolve(__dirname, '..', '..', 'config.gypi'); var config = fs.readFileSync(configPath, 'utf8'); // clean up comment at the first line config = config.split('\n').slice(1).join('\n').replace(/'/g, '"'); config = JSON.parse(config, function(key, value) { if (value === 'true') return true; if (value === 'false') return false; return value; }); assert.deepEqual(config, process.config); node-v4.8.2/test/parallel/test-process-cpuUsage.js000644 000766 000024 00000004543 13070706737 022306 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const result = process.cpuUsage(); // Validate the result of calling with no previous value argument. validateResult(result); // Validate the result of calling with a previous value argument. validateResult(process.cpuUsage(result)); // Ensure the results are >= the previous. let thisUsage; let lastUsage = process.cpuUsage(); for (let i = 0; i < 10; i++) { thisUsage = process.cpuUsage(); validateResult(thisUsage); assert(thisUsage.user >= lastUsage.user); assert(thisUsage.system >= lastUsage.system); lastUsage = thisUsage; } // Ensure that the diffs are >= 0. let startUsage; let diffUsage; for (let i = 0; i < 10; i++) { startUsage = process.cpuUsage(); diffUsage = process.cpuUsage(startUsage); validateResult(startUsage); validateResult(diffUsage); assert(diffUsage.user >= 0); assert(diffUsage.system >= 0); } const invalidUserArgument = /^TypeError: value of user property of argument is invalid$/; const invalidSystemArgument = /^TypeError: value of system property of argument is invalid$/; // Ensure that an invalid shape for the previous value argument throws an error. assert.throws(() => { process.cpuUsage(1); }, invalidUserArgument); assert.throws(() => { process.cpuUsage({}); }, invalidUserArgument); assert.throws(() => { process.cpuUsage({ user: 'a' }); }, invalidUserArgument); assert.throws(() => { process.cpuUsage({ system: 'b' }); }, invalidUserArgument); assert.throws(() => { process.cpuUsage({ user: null, system: 'c' }); }, invalidUserArgument); assert.throws(() => { process.cpuUsage({ user: 'd', system: null }); }, invalidUserArgument); assert.throws(() => { process.cpuUsage({ user: -1, system: 2 }); }, invalidUserArgument); assert.throws(() => { process.cpuUsage({ user: 3, system: -2 }); }, invalidSystemArgument); assert.throws(() => { process.cpuUsage({ user: Number.POSITIVE_INFINITY, system: 4 }); }, invalidUserArgument); assert.throws(() => { process.cpuUsage({ user: 5, system: Number.NEGATIVE_INFINITY }); }, invalidSystemArgument); // Ensure that the return value is the expected shape. function validateResult(result) { assert.notEqual(result, null); assert(Number.isFinite(result.user)); assert(Number.isFinite(result.system)); assert(result.user >= 0); assert(result.system >= 0); } node-v4.8.2/test/parallel/test-process-emit.js000644 000766 000024 00000001062 13070706737 021461 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const sym = Symbol(); process.on('normal', common.mustCall((data) => { assert.strictEqual(data, 'normalData'); })); process.on(sym, common.mustCall((data) => { assert.strictEqual(data, 'symbolData'); })); process.on('SIGPIPE', common.mustCall((data) => { assert.strictEqual(data, 'signalData'); })); process.emit('normal', 'normalData'); process.emit(sym, 'symbolData'); process.emit('SIGPIPE', 'signalData'); assert.strictEqual(isNaN(process._eventsCount), false); node-v4.8.2/test/parallel/test-process-env.js000644 000766 000024 00000004533 13070706737 021321 0ustar00iojsstaff000000 000000 'use strict'; /* eslint-disable max-len */ // first things first, set the timezone; see tzset(3) process.env.TZ = 'Europe/Amsterdam'; require('../common'); var assert = require('assert'); var spawn = require('child_process').spawn; /* For the moment we are not going to support setting the timezone via the * environment variables. The problem is that various V8 platform backends * deal with timezone in different ways. The windows platform backend caches * the timezone value while the Linux one hits libc for every query. https://github.com/joyent/node/blob/08782931205bc4f6d28102ebc29fd806e8ccdf1f/deps/v8/src/platform-linux.cc#L339-345 https://github.com/joyent/node/blob/08782931205bc4f6d28102ebc29fd806e8ccdf1f/deps/v8/src/platform-win32.cc#L590-596 // time difference between Greenwich and Amsterdam is +2 hours in the summer date = new Date('Fri, 10 Sep 1982 03:15:00 GMT'); assert.equal(3, date.getUTCHours()); assert.equal(5, date.getHours()); */ // changes in environment should be visible to child processes if (process.argv[2] == 'you-are-the-child') { // failed assertion results in process exiting with status code 1 assert.equal(false, 'NODE_PROCESS_ENV_DELETED' in process.env); assert.equal(42, process.env.NODE_PROCESS_ENV); assert.equal('asdf', process.env.hasOwnProperty); var hasOwnProperty = Object.prototype.hasOwnProperty; const has = hasOwnProperty.call(process.env, 'hasOwnProperty'); assert.equal(true, has); process.exit(0); } else { assert.equal(Object.prototype.hasOwnProperty, process.env.hasOwnProperty); const has = process.env.hasOwnProperty('hasOwnProperty'); assert.equal(false, has); process.env.hasOwnProperty = 'asdf'; process.env.NODE_PROCESS_ENV = 42; assert.equal(42, process.env.NODE_PROCESS_ENV); process.env.NODE_PROCESS_ENV_DELETED = 42; assert.equal(true, 'NODE_PROCESS_ENV_DELETED' in process.env); delete process.env.NODE_PROCESS_ENV_DELETED; assert.equal(false, 'NODE_PROCESS_ENV_DELETED' in process.env); var child = spawn(process.argv[0], [process.argv[1], 'you-are-the-child']); child.stdout.on('data', function(data) { console.log(data.toString()); }); child.stderr.on('data', function(data) { console.log(data.toString()); }); child.on('exit', function(statusCode) { if (statusCode != 0) { process.exit(statusCode); // failed assertion in child process } }); } node-v4.8.2/test/parallel/test-process-exec-argv.js000644 000766 000024 00000001063 13070706737 022405 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var spawn = require('child_process').spawn; if (process.argv[2] === 'child') { process.stdout.write(JSON.stringify(process.execArgv)); } else { var execArgv = ['--harmony_proxies', '--stack-size=256']; var args = [__filename, 'child', 'arg0']; var child = spawn(process.execPath, execArgv.concat(args)); var out = ''; child.stdout.on('data', function(chunk) { out += chunk; }); child.on('close', function() { assert.deepStrictEqual(JSON.parse(out), execArgv); }); } node-v4.8.2/test/parallel/test-process-execpath.js000644 000766 000024 00000001544 13070706737 022331 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const child_process = require('child_process'); const path = require('path'); const fs = require('fs'); assert.strictEqual(process.execPath, fs.realpathSync(process.execPath)); if (common.isWindows) { common.skip('symlinks are weird on windows'); return; } if (process.argv[2] === 'child') { // The console.log() output is part of the test here. console.log(process.execPath); } else { common.refreshTmpDir(); const symlinkedNode = path.join(common.tmpDir, 'symlinked-node'); fs.symlinkSync(process.execPath, symlinkedNode); const proc = child_process.spawnSync(symlinkedNode, [__filename, 'child']); assert.strictEqual(proc.stderr.toString(), ''); assert.strictEqual(proc.stdout.toString(), `${process.execPath}\n`); assert.strictEqual(proc.status, 0); } node-v4.8.2/test/parallel/test-process-exit-code.js000644 000766 000024 00000003252 13070706737 022407 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); switch (process.argv[2]) { case 'child1': return child1(); case 'child2': return child2(); case 'child3': return child3(); case 'child4': return child4(); case 'child5': return child5(); case undefined: return parent(); default: throw new Error('wtf'); } function child1() { process.exitCode = 42; process.on('exit', function(code) { assert.equal(code, 42); }); } function child2() { process.exitCode = 99; process.on('exit', function(code) { assert.equal(code, 42); }); process.exit(42); } function child3() { process.exitCode = 99; process.on('exit', function(code) { assert.equal(code, 0); }); process.exit(0); } function child4() { process.exitCode = 99; process.on('exit', function(code) { if (code !== 1) { console.log('wrong code! expected 1 for uncaughtException'); process.exit(99); } }); throw new Error('ok'); } function child5() { process.exitCode = 95; process.on('exit', function(code) { assert.equal(code, 95); process.exitCode = 99; }); } function parent() { test('child1', 42); test('child2', 42); test('child3', 0); test('child4', 1); test('child5', 99); } function test(arg, exit) { var spawn = require('child_process').spawn; var node = process.execPath; var f = __filename; var option = { stdio: [ 0, 1, 'ignore' ] }; spawn(node, [f, arg], option).on('exit', function(code) { assert.equal(code, exit, 'wrong exit for ' + arg + '\nexpected:' + exit + ' but got:' + code); console.log('ok - %s exited with %d', arg, exit); }); } node-v4.8.2/test/parallel/test-process-exit-from-before-exit.js000644 000766 000024 00000000354 13070706737 024647 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); process.on('beforeExit', common.mustCall(function() { setTimeout(common.fail, 5); process.exit(0); // Should execute immediately even if we schedule new work. common.fail(); })); node-v4.8.2/test/parallel/test-process-exit-recursive.js000644 000766 000024 00000000540 13070706737 023501 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); // recursively calling .exit() should not overflow the call stack var nexits = 0; process.on('exit', function(code) { assert.equal(nexits++, 0); assert.equal(code, 1); // now override the exit code of 1 with 0 so that the test passes process.exit(0); }); process.exit(1); node-v4.8.2/test/parallel/test-process-exit.js000644 000766 000024 00000000467 13070706737 021504 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); // calling .exit() from within "exit" should not overflow the call stack var nexits = 0; process.on('exit', function(code) { assert.equal(nexits++, 0); assert.equal(code, 0); process.exit(); }); // "exit" should be emitted unprovoked node-v4.8.2/test/parallel/test-process-getactivehandles.js000644 000766 000024 00000001645 13070706737 024044 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const net = require('net'); const NUM = 8; const connections = []; const clients = []; var clients_counter = 0; const server = net.createServer(function listener(c) { connections.push(c); }).listen(0, makeConnection); function makeConnection() { if (clients_counter >= NUM) return; net.connect(server.address().port, function connected() { clientConnected(this); makeConnection(); }); } function clientConnected(client) { clients.push(client); if (++clients_counter >= NUM) checkAll(); } function checkAll() { const handles = process._getActiveHandles(); clients.forEach(function(item) { assert.ok(handles.indexOf(item) > -1); item.destroy(); }); connections.forEach(function(item) { assert.ok(handles.indexOf(item) > -1); item.end(); }); assert.ok(handles.indexOf(server) > -1); server.close(); } node-v4.8.2/test/parallel/test-process-getgroups.js000644 000766 000024 00000001322 13070706737 022541 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var exec = require('child_process').exec; if (process.platform === 'darwin') { common.skip('Output of `id -G` is unreliable on Darwin.'); return; } if (typeof process.getgroups === 'function') { var groups = process.getgroups(); assert(Array.isArray(groups)); assert(groups.length > 0); exec('id -G', function(err, stdout) { if (err) throw err; var real_groups = stdout.match(/\d+/g).map(Number); assert.equal(groups.length, real_groups.length); check(groups, real_groups); check(real_groups, groups); }); } function check(a, b) { for (var i = 0; i < a.length; ++i) assert(b.indexOf(a[i]) !== -1); } node-v4.8.2/test/parallel/test-process-hrtime.js000644 000766 000024 00000001176 13070706737 022021 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); // the default behavior, return an Array "tuple" of numbers var tuple = process.hrtime(); // validate the default behavior validateTuple(tuple); // validate that passing an existing tuple returns another valid tuple validateTuple(process.hrtime(tuple)); // test that only an Array may be passed to process.hrtime() assert.throws(function() { process.hrtime(1); }); function validateTuple(tuple) { assert(Array.isArray(tuple)); assert.equal(2, tuple.length); tuple.forEach(function(v) { assert.equal('number', typeof v); assert(isFinite(v)); }); } node-v4.8.2/test/parallel/test-process-kill-null.js000644 000766 000024 00000000762 13070706737 022434 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var spawn = require('child_process').spawn; var cat = spawn('cat'); var called; assert.ok(process.kill(cat.pid, 0)); cat.on('exit', function() { assert.throws(function() { process.kill(cat.pid, 0); }, Error); }); cat.stdout.on('data', function() { called = true; process.kill(cat.pid, 'SIGKILL'); }); // EPIPE when null sig fails cat.stdin.write('test'); process.on('exit', function() { assert.ok(called); }); node-v4.8.2/test/parallel/test-process-kill-pid.js000644 000766 000024 00000004037 13070706737 022235 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); // test variants of pid // // null: TypeError // undefined: TypeError // // 'SIGTERM': TypeError // // String(process.pid): TypeError // // Nan, Infinity, -Infinity: TypeError // // 0, String(0): our group process // // process.pid, String(process.pid): ourself assert.throws(function() { process.kill('SIGTERM'); }, TypeError); assert.throws(function() { process.kill(null); }, TypeError); assert.throws(function() { process.kill(undefined); }, TypeError); assert.throws(function() { process.kill(+'not a number'); }, TypeError); assert.throws(function() { process.kill(1 / 0); }, TypeError); assert.throws(function() { process.kill(-1 / 0); }, TypeError); // Test that kill throws an error for invalid signal assert.throws(function() { process.kill(1, 'test'); }, Error); // Test kill argument processing in valid cases. // // Monkey patch _kill so that we don't actually send any signals, particularly // that we don't kill our process group, or try to actually send ANY signals on // windows, which doesn't support them. function kill(tryPid, trySig, expectPid, expectSig) { var getPid; var getSig; var origKill = process._kill; process._kill = function(pid, sig) { getPid = pid; getSig = sig; // un-monkey patch process._kill process._kill = origKill; }; process.kill(tryPid, trySig); assert.equal(getPid, expectPid); assert.equal(getSig, expectSig); } // Note that SIGHUP and SIGTERM map to 1 and 15 respectively, even on Windows // (for Windows, libuv maps 1 and 15 to the correct behaviour). kill(0, 'SIGHUP', 0, 1); kill(0, undefined, 0, 15); kill('0', 'SIGHUP', 0, 1); kill('0', undefined, 0, 15); // negative numbers are meaningful on unix kill(-1, 'SIGHUP', -1, 1); kill(-1, undefined, -1, 15); kill('-1', 'SIGHUP', -1, 1); kill('-1', undefined, -1, 15); kill(process.pid, 'SIGHUP', process.pid, 1); kill(process.pid, undefined, process.pid, 15); kill(String(process.pid), 'SIGHUP', process.pid, 1); kill(String(process.pid), undefined, process.pid, 15); node-v4.8.2/test/parallel/test-process-next-tick.js000644 000766 000024 00000000515 13070706737 022433 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var N = 2; function cb() { throw new Error(); } for (var i = 0; i < N; ++i) { process.nextTick(common.mustCall(cb)); } process.on('uncaughtException', common.mustCall(function() {}, N)); process.on('exit', function() { process.removeAllListeners('uncaughtException'); }); node-v4.8.2/test/parallel/test-process-raw-debug.js000644 000766 000024 00000002035 13070706737 022401 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var os = require('os'); switch (process.argv[2]) { case 'child': return child(); case undefined: return parent(); default: throw new Error('wtf? ' + process.argv[2]); } function parent() { var spawn = require('child_process').spawn; var child = spawn(process.execPath, [__filename, 'child']); var output = ''; child.stderr.on('data', function(c) { output += c; }); child.stderr.setEncoding('utf8'); child.stderr.on('end', function() { assert.equal(output, 'I can still debug!' + os.EOL); console.log('ok - got expected message'); }); child.on('exit', function(c) { assert(!c); console.log('ok - child exited nicely'); }); } function child() { // even when all hope is lost... process.nextTick = function() { throw new Error('No ticking!'); }; var stderr = process.stderr; stderr.write = function() { throw new Error('No writing to stderr!'); }; process._rawDebug('I can still %s!', 'debug'); } node-v4.8.2/test/parallel/test-process-release.js000644 000766 000024 00000000651 13070706737 022146 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const versionParts = process.versions.node.split('.'); assert.equal(process.release.name, 'node'); // it's expected that future LTS release lines will have additional // branches in here if (versionParts[0] === '4' && versionParts[1] >= 2) { assert.equal(process.release.lts, 'Argon'); } else { assert.strictEqual(process.release.lts, undefined); } node-v4.8.2/test/parallel/test-process-remove-all-signal-listeners.js000644 000766 000024 00000002032 13070706737 026045 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const spawn = require('child_process').spawn; if (common.isWindows) { common.skip('Win32 doesn\'t have signals, just a kind of ' + 'emulation, insufficient for this test to apply.'); return; } if (process.argv[2] !== '--do-test') { // We are the master, fork a child so we can verify it exits with correct // status. process.env.DOTEST = 'y'; var child = spawn(process.execPath, [__filename, '--do-test']); child.once('exit', common.mustCall(function(code, signal) { assert.equal(signal, 'SIGINT'); })); return; } process.on('SIGINT', function() { // Remove all handlers and kill ourselves. We should terminate by SIGINT // now that we have no handlers. process.removeAllListeners('SIGINT'); process.kill(process.pid, 'SIGINT'); }); // Signal handlers aren't sufficient to keep node alive, so resume stdin process.stdin.resume(); // Demonstrate that signals are being handled process.kill(process.pid, 'SIGINT'); node-v4.8.2/test/parallel/test-process-versions.js000644 000766 000024 00000000611 13070706737 022372 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var expected_keys = ['ares', 'http_parser', 'modules', 'node', 'uv', 'v8', 'zlib']; if (common.hasCrypto) { expected_keys.push('openssl'); } if (typeof Intl !== 'undefined') { expected_keys.push('icu'); } assert.deepEqual(Object.keys(process.versions).sort(), expected_keys.sort()); node-v4.8.2/test/parallel/test-process-wrap.js000644 000766 000024 00000002416 13070706737 021500 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var Process = process.binding('process_wrap').Process; var Pipe = process.binding('pipe_wrap').Pipe; var pipe = new Pipe(); var p = new Process(); var processExited = false; var gotPipeEOF = false; var gotPipeData = false; p.onexit = function(exitCode, signal) { console.log('exit'); p.close(); pipe.readStart(); assert.equal(0, exitCode); assert.equal(0, signal); processExited = true; }; pipe.onread = function(err, b, off, len) { assert.ok(processExited); if (b) { gotPipeData = true; console.log('read %d', len); } else { gotPipeEOF = true; pipe.close(); } }; p.spawn({ file: process.execPath, args: [process.execPath, '-v'], stdio: [ { type: 'ignore' }, { type: 'pipe', handle: pipe }, { type: 'ignore' } ] }); // 'this' safety // https://github.com/joyent/node/issues/6690 assert.throws(function() { var notp = { spawn: p.spawn }; notp.spawn({ file: process.execPath, args: [process.execPath, '-v'], stdio: [ { type: 'ignore' }, { type: 'pipe', handle: pipe }, { type: 'ignore' } ] }); }, TypeError); process.on('exit', function() { assert.ok(processExited); assert.ok(gotPipeEOF); assert.ok(gotPipeData); }); node-v4.8.2/test/parallel/test-promises-unhandled-rejections.js000644 000766 000024 00000046755 13070706737 025035 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var domain = require('domain'); var asyncTest = (function() { var asyncTestsEnabled = false; var asyncTestLastCheck; var asyncTestQueue = []; var asyncTestHandle; var currentTest = null; function fail(error) { var stack = currentTest ? error.stack + '\nFrom previous event:\n' + currentTest.stack : error.stack; if (currentTest) process.stderr.write('\'' + currentTest.description + '\' failed\n\n'); process.stderr.write(stack); process.exit(2); } function nextAsyncTest() { var called = false; function done(err) { if (called) return fail(new Error('done called twice')); called = true; asyncTestLastCheck = Date.now(); if (arguments.length > 0) return fail(err); setTimeout(nextAsyncTest, 10); } if (asyncTestQueue.length) { var test = asyncTestQueue.shift(); currentTest = test; test.action(done); } else { clearInterval(asyncTestHandle); } } return function asyncTest(description, fn) { var stack = new Error().stack.split('\n').slice(1).join('\n'); asyncTestQueue.push({ action: fn, stack: stack, description: description }); if (!asyncTestsEnabled) { asyncTestsEnabled = true; asyncTestLastCheck = Date.now(); process.on('uncaughtException', fail); asyncTestHandle = setInterval(function() { var now = Date.now(); if (now - asyncTestLastCheck > 10000) { return fail(new Error('Async test timeout exceeded')); } }, 10); setTimeout(nextAsyncTest, 10); } }; })(); function setupException(fn) { var listeners = process.listeners('uncaughtException'); process.removeAllListeners('uncaughtException'); process.on('uncaughtException', fn); return function clean() { process.removeListener('uncaughtException', fn); listeners.forEach(function(listener) { process.on('uncaughtException', listener); }); }; } function clean() { process.removeAllListeners('unhandledRejection'); process.removeAllListeners('rejectionHandled'); } function onUnhandledSucceed(done, predicate) { clean(); process.on('unhandledRejection', function(reason, promise) { try { predicate(reason, promise); } catch (e) { return done(e); } done(); }); } function onUnhandledFail(done) { clean(); process.on('unhandledRejection', function(reason, promise) { done(new Error('unhandledRejection not supposed to be triggered')); }); process.on('rejectionHandled', function() { done(new Error('rejectionHandled not supposed to be triggered')); }); setTimeout(function() { done(); }, 10); } asyncTest('synchronously rejected promise should trigger' + ' unhandledRejection', function(done) { var e = new Error(); onUnhandledSucceed(done, function(reason, promise) { assert.strictEqual(e, reason); }); Promise.reject(e); }); asyncTest('synchronously rejected promise should trigger' + ' unhandledRejection', function(done) { var e = new Error(); onUnhandledSucceed(done, function(reason, promise) { assert.strictEqual(e, reason); }); new Promise(function(_, reject) { reject(e); }); }); asyncTest('Promise rejected after setImmediate should trigger' + ' unhandledRejection', function(done) { var e = new Error(); onUnhandledSucceed(done, function(reason, promise) { assert.strictEqual(e, reason); }); new Promise(function(_, reject) { setImmediate(function() { reject(e); }); }); }); asyncTest('Promise rejected after setTimeout(,1) should trigger' + ' unhandled rejection', function(done) { var e = new Error(); onUnhandledSucceed(done, function(reason, promise) { assert.strictEqual(e, reason); }); new Promise(function(_, reject) { setTimeout(function() { reject(e); }, 1); }); }); asyncTest('Catching a promise rejection after setImmediate is not' + ' soon enough to stop unhandledRejection', function(done) { var e = new Error(); onUnhandledSucceed(done, function(reason, promise) { assert.strictEqual(e, reason); }); var _reject; var promise = new Promise(function(_, reject) { _reject = reject; }); _reject(e); setImmediate(function() { promise.then(common.fail, function() {}); }); }); asyncTest('When re-throwing new errors in a promise catch, only the' + ' re-thrown error should hit unhandledRejection', function(done) { var e = new Error(); var e2 = new Error(); onUnhandledSucceed(done, function(reason, promise) { assert.strictEqual(e2, reason); assert.strictEqual(promise2, promise); }); var promise2 = Promise.reject(e).then(common.fail, function(reason) { assert.strictEqual(e, reason); throw e2; }); }); asyncTest('Test params of unhandledRejection for a synchronously-rejected' + 'promise', function(done) { var e = new Error(); onUnhandledSucceed(done, function(reason, promise) { assert.strictEqual(e, reason); assert.strictEqual(promise, promise); }); Promise.reject(e); }); asyncTest('When re-throwing new errors in a promise catch, only the ' + 're-thrown error should hit unhandledRejection: original promise' + ' rejected async with setTimeout(,1)', function(done) { var e = new Error(); var e2 = new Error(); onUnhandledSucceed(done, function(reason, promise) { assert.strictEqual(e2, reason); assert.strictEqual(promise2, promise); }); var promise2 = new Promise(function(_, reject) { setTimeout(function() { reject(e); }, 1); }).then(common.fail, function(reason) { assert.strictEqual(e, reason); throw e2; }); }); asyncTest('When re-throwing new errors in a promise catch, only the re-thrown' + ' error should hit unhandledRejection: promise catch attached a' + ' process.nextTick after rejection', function(done) { var e = new Error(); var e2 = new Error(); onUnhandledSucceed(done, function(reason, promise) { assert.strictEqual(e2, reason); assert.strictEqual(promise2, promise); }); var promise = new Promise(function(_, reject) { setTimeout(function() { reject(e); process.nextTick(function() { promise2 = promise.then(common.fail, function(reason) { assert.strictEqual(e, reason); throw e2; }); }); }, 1); }); var promise2; }); asyncTest( 'unhandledRejection should not be triggered if a promise catch is' + ' attached synchronously upon the promise\'s creation', function(done) { var e = new Error(); onUnhandledFail(done); Promise.reject(e).then(common.fail, function() {}); } ); asyncTest( 'unhandledRejection should not be triggered if a promise catch is' + ' attached synchronously upon the promise\'s creation', function(done) { var e = new Error(); onUnhandledFail(done); new Promise(function(_, reject) { reject(e); }).then(common.fail, function() {}); } ); asyncTest('Attaching a promise catch in a process.nextTick is soon enough to' + ' prevent unhandledRejection', function(done) { var e = new Error(); onUnhandledFail(done); var promise = Promise.reject(e); process.nextTick(function() { promise.then(common.fail, function() {}); }); }); asyncTest('Attaching a promise catch in a process.nextTick is soon enough to' + ' prevent unhandledRejection', function(done) { var e = new Error(); onUnhandledFail(done); var promise = new Promise(function(_, reject) { reject(e); }); process.nextTick(function() { promise.then(common.fail, function() {}); }); }); asyncTest('While inside setImmediate, catching a rejected promise derived ' + 'from returning a rejected promise in a fulfillment handler ' + 'prevents unhandledRejection', function(done) { onUnhandledFail(done); setImmediate(function() { // reproduces on first tick and inside of setImmediate Promise .resolve('resolve') .then(function() { return Promise.reject('reject'); }).catch(function(e) {}); }); }); // State adapation tests asyncTest('catching a promise which is asynchronously rejected (via' + 'resolution to an asynchronously-rejected promise) prevents' + ' unhandledRejection', function(done) { var e = new Error(); onUnhandledFail(done); Promise.resolve().then(function() { return new Promise(function(_, reject) { setTimeout(function() { reject(e); }, 1); }); }).then(common.fail, function(reason) { assert.strictEqual(e, reason); }); }); asyncTest('Catching a rejected promise derived from throwing in a' + ' fulfillment handler prevents unhandledRejection', function(done) { var e = new Error(); onUnhandledFail(done); Promise.resolve().then(function() { throw e; }).then(common.fail, function(reason) { assert.strictEqual(e, reason); }); }); asyncTest('Catching a rejected promise derived from returning a' + ' synchronously-rejected promise in a fulfillment handler' + ' prevents unhandledRejection', function(done) { var e = new Error(); onUnhandledFail(done); Promise.resolve().then(function() { return Promise.reject(e); }).then(common.fail, function(reason) { assert.strictEqual(e, reason); }); }); asyncTest('A rejected promise derived from returning an' + ' asynchronously-rejected promise in a fulfillment handler' + ' does trigger unhandledRejection', function(done) { var e = new Error(); var _promise; onUnhandledSucceed(done, function(reason, promise) { assert.strictEqual(e, reason); assert.strictEqual(_promise, promise); }); _promise = Promise.resolve().then(function() { return new Promise(function(_, reject) { setTimeout(function() { reject(e); }, 1); }); }); }); asyncTest('A rejected promise derived from throwing in a fulfillment handler' + ' does trigger unhandledRejection', function(done) { var e = new Error(); var _promise; onUnhandledSucceed(done, function(reason, promise) { assert.strictEqual(e, reason); assert.strictEqual(_promise, promise); }); _promise = Promise.resolve().then(function() { throw e; }); }); asyncTest( 'A rejected promise derived from returning a synchronously-rejected' + ' promise in a fulfillment handler does trigger unhandledRejection', function(done) { var e = new Error(); var _promise; onUnhandledSucceed(done, function(reason, promise) { assert.strictEqual(e, reason); assert.strictEqual(_promise, promise); }); _promise = Promise.resolve().then(function() { return Promise.reject(e); }); } ); // Combinations with Promise.all asyncTest('Catching the Promise.all() of a collection that includes a' + 'rejected promise prevents unhandledRejection', function(done) { var e = new Error(); onUnhandledFail(done); Promise.all([Promise.reject(e)]).then(common.fail, function() {}); }); asyncTest( 'Catching the Promise.all() of a collection that includes a ' + 'nextTick-async rejected promise prevents unhandledRejection', function(done) { var e = new Error(); onUnhandledFail(done); var p = new Promise(function(_, reject) { process.nextTick(function() { reject(e); }); }); p = Promise.all([p]); process.nextTick(function() { p.then(common.fail, function() {}); }); } ); asyncTest('Failing to catch the Promise.all() of a collection that includes' + ' a rejected promise triggers unhandledRejection for the returned' + ' promise, not the passed promise', function(done) { var e = new Error(); onUnhandledSucceed(done, function(reason, promise) { assert.strictEqual(e, reason); assert.strictEqual(p, promise); }); var p = Promise.all([Promise.reject(e)]); }); asyncTest('Waiting setTimeout(, 10) to catch a promise causes an' + ' unhandledRejection + rejectionHandled pair', function(done) { clean(); var unhandledPromises = []; var e = new Error(); process.on('unhandledRejection', function(reason, promise) { assert.strictEqual(e, reason); unhandledPromises.push(promise); }); process.on('rejectionHandled', function(promise) { assert.strictEqual(1, unhandledPromises.length); assert.strictEqual(unhandledPromises[0], promise); assert.strictEqual(thePromise, promise); done(); }); var thePromise = new Promise(function() { throw e; }); setTimeout(function() { thePromise.then(common.fail, function(reason) { assert.strictEqual(e, reason); }); }, 10); }); asyncTest('Waiting for some combination of process.nextTick + promise' + ' microtasks to attach a catch handler is still soon enough to' + ' prevent unhandledRejection', function(done) { var e = new Error(); onUnhandledFail(done); var a = Promise.reject(e); process.nextTick(function() { Promise.resolve().then(function() { process.nextTick(function() { Promise.resolve().then(function() { a.catch(function() {}); }); }); }); }); }); asyncTest('Waiting for some combination of process.nextTick + promise' + ' microtasks to attach a catch handler is still soon enough to ' + 'prevent unhandledRejection: inside setImmediate', function(done) { var e = new Error(); onUnhandledFail(done); setImmediate(function() { var a = Promise.reject(e); process.nextTick(function() { Promise.resolve().then(function() { process.nextTick(function() { Promise.resolve().then(function() { a.catch(function() {}); }); }); }); }); }); }); asyncTest('Waiting for some combination of process.nextTick + promise ' + 'microtasks to attach a catch handler is still soon enough to ' + 'prevent unhandledRejection: inside setTimeout', function(done) { var e = new Error(); onUnhandledFail(done); setTimeout(function() { var a = Promise.reject(e); process.nextTick(function() { Promise.resolve().then(function() { process.nextTick(function() { Promise.resolve().then(function() { a.catch(function() {}); }); }); }); }); }, 0); }); asyncTest('Waiting for some combination of promise microtasks + ' + 'process.nextTick to attach a catch handler is still soon enough' + ' to prevent unhandledRejection', function(done) { var e = new Error(); onUnhandledFail(done); var a = Promise.reject(e); Promise.resolve().then(function() { process.nextTick(function() { Promise.resolve().then(function() { process.nextTick(function() { a.catch(function() {}); }); }); }); }); }); asyncTest( 'Waiting for some combination of promise microtasks +' + ' process.nextTick to attach a catch handler is still soon enough' + ' to prevent unhandledRejection: inside setImmediate', function(done) { var e = new Error(); onUnhandledFail(done); setImmediate(function() { var a = Promise.reject(e); Promise.resolve().then(function() { process.nextTick(function() { Promise.resolve().then(function() { process.nextTick(function() { a.catch(function() {}); }); }); }); }); }); } ); asyncTest('Waiting for some combination of promise microtasks +' + ' process.nextTick to attach a catch handler is still soon enough' + ' to prevent unhandledRejection: inside setTimeout', function(done) { var e = new Error(); onUnhandledFail(done); setTimeout(function() { var a = Promise.reject(e); Promise.resolve().then(function() { process.nextTick(function() { Promise.resolve().then(function() { process.nextTick(function() { a.catch(function() {}); }); }); }); }); }, 0); }); asyncTest('setImmediate + promise microtasks is too late to attach a catch' + ' handler; unhandledRejection will be triggered in that case.' + ' (setImmediate before promise creation/rejection)', function(done) { var e = new Error(); onUnhandledSucceed(done, function(reason, promise) { assert.strictEqual(e, reason); assert.strictEqual(p, promise); }); var p = Promise.reject(e); setImmediate(function() { Promise.resolve().then(function() { p.catch(function() {}); }); }); }); asyncTest('setImmediate + promise microtasks is too late to attach a catch' + ' handler; unhandledRejection will be triggered in that case' + ' (setImmediate before promise creation/rejection)', function(done) { onUnhandledSucceed(done, function(reason, promise) { assert.strictEqual(undefined, reason); assert.strictEqual(p, promise); }); setImmediate(function() { Promise.resolve().then(function() { Promise.resolve().then(function() { Promise.resolve().then(function() { Promise.resolve().then(function() { p.catch(function() {}); }); }); }); }); }); var p = Promise.reject(); }); asyncTest('setImmediate + promise microtasks is too late to attach a catch' + ' handler; unhandledRejection will be triggered in that case' + ' (setImmediate after promise creation/rejection)', function(done) { onUnhandledSucceed(done, function(reason, promise) { assert.strictEqual(undefined, reason); assert.strictEqual(p, promise); }); var p = Promise.reject(); setImmediate(function() { Promise.resolve().then(function() { Promise.resolve().then(function() { Promise.resolve().then(function() { Promise.resolve().then(function() { p.catch(function() {}); }); }); }); }); }); }); asyncTest( 'Promise unhandledRejection handler does not interfere with domain' + ' error handlers being given exceptions thrown from nextTick.', function(done) { var d = domain.create(); var domainReceivedError; d.on('error', function(e) { domainReceivedError = e; }); d.run(function() { var e = new Error('error'); var domainError = new Error('domain error'); onUnhandledSucceed(done, function(reason, promise) { assert.strictEqual(reason, e); assert.strictEqual(domainReceivedError, domainError); d.dispose(); }); Promise.reject(e); process.nextTick(function() { throw domainError; }); }); } ); asyncTest('nextTick is immediately scheduled when called inside an event' + ' handler', function(done) { clean(); var e = new Error('error'); process.on('unhandledRejection', function(reason, promise) { var order = []; process.nextTick(function() { order.push(1); }); setTimeout(function() { order.push(2); assert.deepEqual([1, 2], order); done(); }, 1); }); Promise.reject(e); }); asyncTest('Throwing an error inside a rejectionHandled handler goes to' + ' unhandledException, and does not cause .catch() to throw an' + 'exception', function(done) { clean(); var e = new Error(); var e2 = new Error(); var tearDownException = setupException(function(err) { assert.equal(e2, err); tearDownException(); done(); }); process.on('rejectionHandled', function() { throw e2; }); var p = Promise.reject(e); setTimeout(function() { try { p.catch(function() {}); } catch (e) { done(new Error('fail')); } }, 1); }); node-v4.8.2/test/parallel/test-punycode.js000644 000766 000024 00000017260 13070706737 020704 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const punycode = require('punycode'); const assert = require('assert'); assert.strictEqual(punycode.encode('ü'), 'tda'); assert.strictEqual(punycode.encode('Goethe'), 'Goethe-'); assert.strictEqual(punycode.encode('Bücher'), 'Bcher-kva'); assert.strictEqual(punycode.encode( 'Willst du die Blüthe des frühen, die Früchte des späteren Jahres'), 'Willst du die Blthe des frhen, die Frchte des spteren Jahres-x9e96lkal'); assert.strictEqual(punycode.encode('日本語'), 'wgv71a119e'); assert.strictEqual(punycode.decode('tda'), 'ü'); assert.strictEqual(punycode.decode('Goethe-'), 'Goethe'); assert.strictEqual(punycode.decode('Bcher-kva'), 'Bücher'); assert.strictEqual(punycode.decode( 'Willst du die Blthe des frhen, die Frchte des spteren Jahres-x9e96lkal'), 'Willst du die Blüthe des frühen, die Früchte des späteren Jahres'); assert.strictEqual(punycode.decode('wgv71a119e'), '日本語'); assert.throws(() => { punycode.decode(' '); }, /^RangeError: Invalid input$/); assert.throws(() => { punycode.decode('α-'); }, /^RangeError: Illegal input >= 0x80 \(not a basic code point\)$/); assert.throws(() => { punycode.decode('あ'); }, /^RangeError: Overflow: input needs wider integers to process$/); // http://tools.ietf.org/html/rfc3492#section-7.1 const tests = [ // (A) Arabic (Egyptian) { encoded: 'egbpdaj6bu4bxfgehfvwxn', decoded: '\u0644\u064A\u0647\u0645\u0627\u0628\u062A\u0643\u0644\u0645' + '\u0648\u0634\u0639\u0631\u0628\u064A\u061F' }, // (B) Chinese (simplified) { encoded: 'ihqwcrb4cv8a8dqg056pqjye', decoded: '\u4ED6\u4EEC\u4E3A\u4EC0\u4E48\u4E0D\u8BF4\u4E2D\u6587' }, // (C) Chinese (traditional) { encoded: 'ihqwctvzc91f659drss3x8bo0yb', decoded: '\u4ED6\u5011\u7232\u4EC0\u9EBD\u4E0D\u8AAA\u4E2D\u6587' }, // (D) Czech: Proprostnemluvesky { encoded: 'Proprostnemluvesky-uyb24dma41a', decoded: '\u0050\u0072\u006F\u010D\u0070\u0072\u006F\u0073\u0074\u011B' + '\u006E\u0065\u006D\u006C\u0075\u0076\u00ED\u010D\u0065\u0073\u006B\u0079' }, // (E) Hebrew { encoded: '4dbcagdahymbxekheh6e0a7fei0b', decoded: '\u05DC\u05DE\u05D4\u05D4\u05DD\u05E4\u05E9\u05D5\u05D8\u05DC' + '\u05D0\u05DE\u05D3\u05D1\u05E8\u05D9\u05DD\u05E2\u05D1\u05E8\u05D9\u05EA' }, // (F) Hindi (Devanagari) { encoded: 'i1baa7eci9glrd9b2ae1bj0hfcgg6iyaf8o0a1dig0cd', decoded: '\u092F\u0939\u0932\u094B\u0917\u0939\u093F\u0928\u094D\u0926' + '\u0940\u0915\u094D\u092F\u094B\u0902\u0928\u0939\u0940\u0902\u092C' + '\u094B\u0932\u0938\u0915\u0924\u0947\u0939\u0948\u0902' }, // (G) Japanese (kanji and hiragana) { encoded: 'n8jok5ay5dzabd5bym9f0cm5685rrjetr6pdxa', decoded: '\u306A\u305C\u307F\u3093\u306A\u65E5\u672C\u8A9E\u3092\u8A71' + '\u3057\u3066\u304F\u308C\u306A\u3044\u306E\u304B' }, // (H) Korean (Hangul syllables) { encoded: '989aomsvi5e83db1d2a355cv1e0vak1dwrv93d5xbh15a0dt30a5jpsd879' + 'ccm6fea98c', decoded: '\uC138\uACC4\uC758\uBAA8\uB4E0\uC0AC\uB78C\uB4E4\uC774\uD55C' + '\uAD6D\uC5B4\uB97C\uC774\uD574\uD55C\uB2E4\uBA74\uC5BC\uB9C8\uB098' + '\uC88B\uC744\uAE4C' }, // (I) Russian (Cyrillic) { encoded: 'b1abfaaepdrnnbgefbadotcwatmq2g4l', decoded: '\u043F\u043E\u0447\u0435\u043C\u0443\u0436\u0435\u043E\u043D' + '\u0438\u043D\u0435\u0433\u043E\u0432\u043E\u0440\u044F\u0442\u043F' + '\u043E\u0440\u0443\u0441\u0441\u043A\u0438' }, // (J) Spanish: PorqunopuedensimplementehablarenEspaol { encoded: 'PorqunopuedensimplementehablarenEspaol-fmd56a', decoded: '\u0050\u006F\u0072\u0071\u0075\u00E9\u006E\u006F\u0070\u0075' + '\u0065\u0064\u0065\u006E\u0073\u0069\u006D\u0070\u006C\u0065\u006D' + '\u0065\u006E\u0074\u0065\u0068\u0061\u0062\u006C\u0061\u0072\u0065' + '\u006E\u0045\u0073\u0070\u0061\u00F1\u006F\u006C' }, // (K) Vietnamese: Tisaohkhngth // chnitingVit { encoded: 'TisaohkhngthchnitingVit-kjcr8268qyxafd2f1b9g', decoded: '\u0054\u1EA1\u0069\u0073\u0061\u006F\u0068\u1ECD\u006B\u0068' + '\u00F4\u006E\u0067\u0074\u0068\u1EC3\u0063\u0068\u1EC9\u006E\u00F3' + '\u0069\u0074\u0069\u1EBF\u006E\u0067\u0056\u0069\u1EC7\u0074' }, // (L) 3B { encoded: '3B-ww4c5e180e575a65lsy2b', decoded: '\u0033\u5E74\u0042\u7D44\u91D1\u516B\u5148\u751F' }, // (M) -with-SUPER-MONKEYS { encoded: '-with-SUPER-MONKEYS-pc58ag80a8qai00g7n9n', decoded: '\u5B89\u5BA4\u5948\u7F8E\u6075\u002D\u0077\u0069\u0074\u0068' + '\u002D\u0053\u0055\u0050\u0045\u0052\u002D\u004D\u004F\u004E\u004B' + '\u0045\u0059\u0053' }, // (N) Hello-Another-Way- { encoded: 'Hello-Another-Way--fc4qua05auwb3674vfr0b', decoded: '\u0048\u0065\u006C\u006C\u006F\u002D\u0041\u006E\u006F\u0074' + '\u0068\u0065\u0072\u002D\u0057\u0061\u0079\u002D\u305D\u308C\u305E' + '\u308C\u306E\u5834\u6240' }, // (O) 2 { encoded: '2-u9tlzr9756bt3uc0v', decoded: '\u3072\u3068\u3064\u5C4B\u6839\u306E\u4E0B\u0032' }, // (P) MajiKoi5 { encoded: 'MajiKoi5-783gue6qz075azm5e', decoded: '\u004D\u0061\u006A\u0069\u3067\u004B\u006F\u0069\u3059\u308B' + '\u0035\u79D2\u524D' }, // (Q) de { encoded: 'de-jg4avhby1noc0d', decoded: '\u30D1\u30D5\u30A3\u30FC\u0064\u0065\u30EB\u30F3\u30D0' }, // (R) { encoded: 'd9juau41awczczp', decoded: '\u305D\u306E\u30B9\u30D4\u30FC\u30C9\u3067' }, // (S) -> $1.00 <- { encoded: '-> $1.00 <--', decoded: '\u002D\u003E\u0020\u0024\u0031\u002E\u0030\u0030\u0020\u003C' + '\u002D' } ]; let errors = 0; const handleError = (error, name) => { console.error( 'FAIL: %s expected %j, got %j', name, error.expected, error.actual ); errors++; }; const regexNonASCII = /[^\x20-\x7E]/; const testBattery = { encode: (test) => assert.strictEqual( punycode.encode(test.decoded), test.encoded ), decode: (test) => assert.strictEqual( punycode.decode(test.encoded), test.decoded ), toASCII: (test) => assert.strictEqual( punycode.toASCII(test.decoded), regexNonASCII.test(test.decoded) ? `xn--${test.encoded}` : test.decoded ), toUnicode: (test) => assert.strictEqual( punycode.toUnicode( regexNonASCII.test(test.decoded) ? `xn--${test.encoded}` : test.decoded ), regexNonASCII.test(test.decoded) ? test.decoded.toLowerCase() : test.decoded ) }; tests.forEach((testCase) => { Object.keys(testBattery).forEach((key) => { try { testBattery[key](testCase); } catch (error) { handleError(error, key); } }); }); // BMP code point assert.strictEqual(punycode.ucs2.encode([0x61]), 'a'); // supplementary code point (surrogate pair) assert.strictEqual(punycode.ucs2.encode([0x1D306]), '\uD834\uDF06'); // high surrogate assert.strictEqual(punycode.ucs2.encode([0xD800]), '\uD800'); // high surrogate followed by non-surrogates assert.strictEqual(punycode.ucs2.encode([0xD800, 0x61, 0x62]), '\uD800ab'); // low surrogate assert.strictEqual(punycode.ucs2.encode([0xDC00]), '\uDC00'); // low surrogate followed by non-surrogates assert.strictEqual(punycode.ucs2.encode([0xDC00, 0x61, 0x62]), '\uDC00ab'); assert.strictEqual(errors, 0); // test map domain assert.strictEqual(punycode.toASCII('Bücher@日本語.com'), 'Bücher@xn--wgv71a119e.com'); assert.strictEqual(punycode.toUnicode('Bücher@xn--wgv71a119e.com'), 'Bücher@日本語.com'); node-v4.8.2/test/parallel/test-querystring-multichar-separator.js000644 000766 000024 00000000767 13070706737 025442 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const qs = require('querystring'); assert.deepEqual( qs.parse('foo=>bar&&bar=>baz', '&&', '=>'), {foo: 'bar', bar: 'baz'} ); assert.strictEqual( qs.stringify({foo: 'bar', bar: 'baz'}, '&&', '=>'), 'foo=>bar&&bar=>baz' ); assert.deepEqual( qs.parse('foo==>bar, bar==>baz', ', ', '==>'), {foo: 'bar', bar: 'baz'} ); assert.strictEqual( qs.stringify({foo: 'bar', bar: 'baz'}, ', ', '==>'), 'foo==>bar, bar==>baz' ); node-v4.8.2/test/parallel/test-querystring.js000644 000766 000024 00000016324 13070706737 021452 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); // test using assert var qs = require('querystring'); // folding block, commented to pass gjslint // {{{ // [ wonkyQS, canonicalQS, obj ] var qsTestCases = [ ['foo=918854443121279438895193', 'foo=918854443121279438895193', {'foo': '918854443121279438895193'}], ['foo=bar', 'foo=bar', {'foo': 'bar'}], ['foo=bar&foo=quux', 'foo=bar&foo=quux', {'foo': ['bar', 'quux']}], ['foo=1&bar=2', 'foo=1&bar=2', {'foo': '1', 'bar': '2'}], ['my+weird+field=q1%212%22%27w%245%267%2Fz8%29%3F', 'my%20weird%20field=q1!2%22\'w%245%267%2Fz8)%3F', {'my weird field': 'q1!2"\'w$5&7/z8)?' }], ['foo%3Dbaz=bar', 'foo%3Dbaz=bar', {'foo=baz': 'bar'}], ['foo=baz=bar', 'foo=baz%3Dbar', {'foo': 'baz=bar'}], ['str=foo&arr=1&arr=2&arr=3&somenull=&undef=', 'str=foo&arr=1&arr=2&arr=3&somenull=&undef=', { 'str': 'foo', 'arr': ['1', '2', '3'], 'somenull': '', 'undef': ''}], [' foo = bar ', '%20foo%20=%20bar%20', {' foo ': ' bar '}], ['foo=%zx', 'foo=%25zx', {'foo': '%zx'}], ['foo=%EF%BF%BD', 'foo=%EF%BF%BD', {'foo': '\ufffd' }], // See: https://github.com/joyent/node/issues/1707 ['hasOwnProperty=x&toString=foo&valueOf=bar&__defineGetter__=baz', 'hasOwnProperty=x&toString=foo&valueOf=bar&__defineGetter__=baz', { hasOwnProperty: 'x', toString: 'foo', valueOf: 'bar', __defineGetter__: 'baz' }], // See: https://github.com/joyent/node/issues/3058 ['foo&bar=baz', 'foo=&bar=baz', { foo: '', bar: 'baz' }], [null, '', {}], [undefined, '', {}] ]; // [ wonkyQS, canonicalQS, obj ] var qsColonTestCases = [ ['foo:bar', 'foo:bar', {'foo': 'bar'}], ['foo:bar;foo:quux', 'foo:bar;foo:quux', {'foo': ['bar', 'quux']}], ['foo:1&bar:2;baz:quux', 'foo:1%26bar%3A2;baz:quux', {'foo': '1&bar:2', 'baz': 'quux'}], ['foo%3Abaz:bar', 'foo%3Abaz:bar', {'foo:baz': 'bar'}], ['foo:baz:bar', 'foo:baz%3Abar', {'foo': 'baz:bar'}] ]; // [wonkyObj, qs, canonicalObj] var extendedFunction = function() {}; extendedFunction.prototype = {a: 'b'}; var qsWeirdObjects = [ [{regexp: /./g}, 'regexp=', {'regexp': ''}], [{regexp: new RegExp('.', 'g')}, 'regexp=', {'regexp': ''}], [{fn: function() {}}, 'fn=', {'fn': ''}], [{fn: new Function('')}, 'fn=', {'fn': ''}], [{math: Math}, 'math=', {'math': ''}], [{e: extendedFunction}, 'e=', {'e': ''}], [{d: new Date()}, 'd=', {'d': ''}], [{d: Date}, 'd=', {'d': ''}], [{f: new Boolean(false), t: new Boolean(true)}, 'f=&t=', {'f': '', 't': ''}], [{f: false, t: true}, 'f=false&t=true', {'f': 'false', 't': 'true'}], [{n: null}, 'n=', {'n': ''}], [{nan: NaN}, 'nan=', {'nan': ''}], [{inf: Infinity}, 'inf=', {'inf': ''}], [{a: [], b: []}, '', {}] ]; // }}} var vm = require('vm'); var foreignObject = vm.runInNewContext('({"foo": ["bar", "baz"]})'); var qsNoMungeTestCases = [ ['', {}], ['foo=bar&foo=baz', {'foo': ['bar', 'baz']}], ['foo=bar&foo=baz', foreignObject], ['blah=burp', {'blah': 'burp'}], ['gragh=1&gragh=3&goo=2', {'gragh': ['1', '3'], 'goo': '2'}], ['frappucino=muffin&goat%5B%5D=scone&pond=moose', {'frappucino': 'muffin', 'goat[]': 'scone', 'pond': 'moose'}], ['trololol=yes&lololo=no', {'trololol': 'yes', 'lololo': 'no'}] ]; assert.strictEqual('918854443121279438895193', qs.parse('id=918854443121279438895193').id); // test that the canonical qs is parsed properly. qsTestCases.forEach(function(testCase) { assert.deepEqual(testCase[2], qs.parse(testCase[0])); }); // test that the colon test cases can do the same qsColonTestCases.forEach(function(testCase) { assert.deepEqual(testCase[2], qs.parse(testCase[0], ';', ':')); }); // test the weird objects, that they get parsed properly qsWeirdObjects.forEach(function(testCase) { assert.deepEqual(testCase[2], qs.parse(testCase[1])); }); qsNoMungeTestCases.forEach(function(testCase) { assert.deepEqual(testCase[0], qs.stringify(testCase[1], '&', '=')); }); // test the nested qs-in-qs case (function() { var f = qs.parse('a=b&q=x%3Dy%26y%3Dz'); f.q = qs.parse(f.q); assert.deepEqual(f, { a: 'b', q: { x: 'y', y: 'z' } }); })(); // nested in colon (function() { var f = qs.parse('a:b;q:x%3Ay%3By%3Az', ';', ':'); f.q = qs.parse(f.q, ';', ':'); assert.deepEqual(f, { a: 'b', q: { x: 'y', y: 'z' } }); })(); // now test stringifying // basic qsTestCases.forEach(function(testCase) { assert.equal(testCase[1], qs.stringify(testCase[2])); }); qsColonTestCases.forEach(function(testCase) { assert.equal(testCase[1], qs.stringify(testCase[2], ';', ':')); }); qsWeirdObjects.forEach(function(testCase) { assert.equal(testCase[1], qs.stringify(testCase[0])); }); // invalid surrogate pair throws URIError assert.throws(function() { qs.stringify({ foo: '\udc00' }); }, URIError); // coerce numbers to string assert.strictEqual('foo=0', qs.stringify({ foo: 0 })); assert.strictEqual('foo=0', qs.stringify({ foo: -0 })); assert.strictEqual('foo=3', qs.stringify({ foo: 3 })); assert.strictEqual('foo=-72.42', qs.stringify({ foo: -72.42 })); assert.strictEqual('foo=', qs.stringify({ foo: NaN })); assert.strictEqual('foo=', qs.stringify({ foo: Infinity })); // nested { const f = qs.stringify({ a: 'b', q: qs.stringify({ x: 'y', y: 'z' }) }); assert.equal(f, 'a=b&q=x%3Dy%26y%3Dz'); } assert.doesNotThrow(function() { qs.parse(undefined); }); // nested in colon { const f = qs.stringify({ a: 'b', q: qs.stringify({ x: 'y', y: 'z' }, ';', ':') }, ';', ':'); assert.equal(f, 'a:b;q:x%3Ay%3By%3Az'); } assert.deepEqual({}, qs.parse()); // Test limiting assert.equal( Object.keys(qs.parse('a=1&b=1&c=1', null, null, { maxKeys: 1 })).length, 1); // Test removing limit function testUnlimitedKeys() { const query = {}; for (var i = 0; i < 2000; i++) query[i] = i; const url = qs.stringify(query); assert.equal( Object.keys(qs.parse(url, null, null, { maxKeys: 0 })).length, 2000); } testUnlimitedKeys(); var b = qs.unescapeBuffer('%d3%f2Ug%1f6v%24%5e%98%cb' + '%0d%ac%a2%2f%9d%eb%d8%a2%e6'); // assert.equal(0xd3, b[0]); assert.equal(0xf2, b[1]); assert.equal(0x55, b[2]); assert.equal(0x67, b[3]); assert.equal(0x1f, b[4]); assert.equal(0x36, b[5]); assert.equal(0x76, b[6]); assert.equal(0x24, b[7]); assert.equal(0x5e, b[8]); assert.equal(0x98, b[9]); assert.equal(0xcb, b[10]); assert.equal(0x0d, b[11]); assert.equal(0xac, b[12]); assert.equal(0xa2, b[13]); assert.equal(0x2f, b[14]); assert.equal(0x9d, b[15]); assert.equal(0xeb, b[16]); assert.equal(0xd8, b[17]); assert.equal(0xa2, b[18]); assert.equal(0xe6, b[19]); // Test custom decode function demoDecode(str) { return str + str; } assert.deepEqual( qs.parse('a=a&b=b&c=c', null, null, { decodeURIComponent: demoDecode }), { aa: 'aa', bb: 'bb', cc: 'cc' }); // Test custom encode function demoEncode(str) { return str[0]; } var obj = { aa: 'aa', bb: 'bb', cc: 'cc' }; assert.equal( qs.stringify(obj, null, null, { encodeURIComponent: demoEncode }), 'a=a&b=b&c=c'); // test overriding .unescape var prevUnescape = qs.unescape; qs.unescape = function(str) { return str.replace(/o/g, '_'); }; assert.deepEqual(qs.parse('foo=bor'), {f__: 'b_r'}); qs.unescape = prevUnescape; node-v4.8.2/test/parallel/test-readdouble.js000644 000766 000024 00000005323 13070706737 021161 0ustar00iojsstaff000000 000000 'use strict'; /* * Tests to verify we're reading in doubles correctly */ require('../common'); const assert = require('assert'); /* * Test (64 bit) double */ function test(clazz) { var buffer = new clazz(8); buffer[0] = 0x55; buffer[1] = 0x55; buffer[2] = 0x55; buffer[3] = 0x55; buffer[4] = 0x55; buffer[5] = 0x55; buffer[6] = 0xd5; buffer[7] = 0x3f; assert.equal(1.1945305291680097e+103, buffer.readDoubleBE(0)); assert.equal(0.3333333333333333, buffer.readDoubleLE(0)); buffer[0] = 1; buffer[1] = 0; buffer[2] = 0; buffer[3] = 0; buffer[4] = 0; buffer[5] = 0; buffer[6] = 0xf0; buffer[7] = 0x3f; assert.equal(7.291122019655968e-304, buffer.readDoubleBE(0)); assert.equal(1.0000000000000002, buffer.readDoubleLE(0)); buffer[0] = 2; assert.equal(4.778309726801735e-299, buffer.readDoubleBE(0)); assert.equal(1.0000000000000004, buffer.readDoubleLE(0)); buffer[0] = 1; buffer[6] = 0; buffer[7] = 0; assert.equal(7.291122019556398e-304, buffer.readDoubleBE(0)); assert.equal(5e-324, buffer.readDoubleLE(0)); buffer[0] = 0xff; buffer[1] = 0xff; buffer[2] = 0xff; buffer[3] = 0xff; buffer[4] = 0xff; buffer[5] = 0xff; buffer[6] = 0x0f; buffer[7] = 0x00; assert.ok(isNaN(buffer.readDoubleBE(0))); assert.equal(2.225073858507201e-308, buffer.readDoubleLE(0)); buffer[6] = 0xef; buffer[7] = 0x7f; assert.ok(isNaN(buffer.readDoubleBE(0))); assert.equal(1.7976931348623157e+308, buffer.readDoubleLE(0)); buffer[0] = 0; buffer[1] = 0; buffer[2] = 0; buffer[3] = 0; buffer[4] = 0; buffer[5] = 0; buffer[6] = 0xf0; buffer[7] = 0x3f; assert.equal(3.03865e-319, buffer.readDoubleBE(0)); assert.equal(1, buffer.readDoubleLE(0)); buffer[6] = 0; buffer[7] = 0x40; assert.equal(3.16e-322, buffer.readDoubleBE(0)); assert.equal(2, buffer.readDoubleLE(0)); buffer[7] = 0xc0; assert.equal(9.5e-322, buffer.readDoubleBE(0)); assert.equal(-2, buffer.readDoubleLE(0)); buffer[6] = 0x10; buffer[7] = 0; assert.equal(2.0237e-320, buffer.readDoubleBE(0)); assert.equal(2.2250738585072014e-308, buffer.readDoubleLE(0)); buffer[6] = 0; assert.equal(0, buffer.readDoubleBE(0)); assert.equal(0, buffer.readDoubleLE(0)); assert.equal(false, 1 / buffer.readDoubleLE(0) < 0); buffer[7] = 0x80; assert.equal(6.3e-322, buffer.readDoubleBE(0)); assert.equal(0, buffer.readDoubleLE(0)); assert.equal(true, 1 / buffer.readDoubleLE(0) < 0); buffer[6] = 0xf0; buffer[7] = 0x7f; assert.equal(3.0418e-319, buffer.readDoubleBE(0)); assert.equal(Infinity, buffer.readDoubleLE(0)); buffer[6] = 0xf0; buffer[7] = 0xff; assert.equal(3.04814e-319, buffer.readDoubleBE(0)); assert.equal(-Infinity, buffer.readDoubleLE(0)); } test(Buffer); node-v4.8.2/test/parallel/test-readfloat.js000644 000766 000024 00000003311 13070706737 021007 0ustar00iojsstaff000000 000000 'use strict'; /* * Tests to verify we're reading in floats correctly */ require('../common'); const assert = require('assert'); /* * Test (32 bit) float */ function test(clazz) { var buffer = new clazz(4); buffer[0] = 0; buffer[1] = 0; buffer[2] = 0x80; buffer[3] = 0x3f; assert.equal(4.600602988224807e-41, buffer.readFloatBE(0)); assert.equal(1, buffer.readFloatLE(0)); buffer[0] = 0; buffer[1] = 0; buffer[2] = 0; buffer[3] = 0xc0; assert.equal(2.6904930515036488e-43, buffer.readFloatBE(0)); assert.equal(-2, buffer.readFloatLE(0)); buffer[0] = 0xff; buffer[1] = 0xff; buffer[2] = 0x7f; buffer[3] = 0x7f; assert.ok(isNaN(buffer.readFloatBE(0))); assert.equal(3.4028234663852886e+38, buffer.readFloatLE(0)); buffer[0] = 0xab; buffer[1] = 0xaa; buffer[2] = 0xaa; buffer[3] = 0x3e; assert.equal(-1.2126478207002966e-12, buffer.readFloatBE(0)); assert.equal(0.3333333432674408, buffer.readFloatLE(0)); buffer[0] = 0; buffer[1] = 0; buffer[2] = 0; buffer[3] = 0; assert.equal(0, buffer.readFloatBE(0)); assert.equal(0, buffer.readFloatLE(0)); assert.equal(false, 1 / buffer.readFloatLE(0) < 0); buffer[3] = 0x80; assert.equal(1.793662034335766e-43, buffer.readFloatBE(0)); assert.equal(0, buffer.readFloatLE(0)); assert.equal(true, 1 / buffer.readFloatLE(0) < 0); buffer[0] = 0; buffer[1] = 0; buffer[2] = 0x80; buffer[3] = 0x7f; assert.equal(4.609571298396486e-41, buffer.readFloatBE(0)); assert.equal(Infinity, buffer.readFloatLE(0)); buffer[0] = 0; buffer[1] = 0; buffer[2] = 0x80; buffer[3] = 0xff; assert.equal(4.627507918739843e-41, buffer.readFloatBE(0)); assert.equal(-Infinity, buffer.readFloatLE(0)); } test(Buffer); node-v4.8.2/test/parallel/test-readint.js000644 000766 000024 00000004565 13070706737 020510 0ustar00iojsstaff000000 000000 'use strict'; /* * Tests to verify we're reading in signed integers correctly */ require('../common'); const assert = require('assert'); /* * Test 8 bit signed integers */ function test8(clazz) { var data = new clazz(4); data[0] = 0x23; assert.equal(0x23, data.readInt8(0)); data[0] = 0xff; assert.equal(-1, data.readInt8(0)); data[0] = 0x87; data[1] = 0xab; data[2] = 0x7c; data[3] = 0xef; assert.equal(-121, data.readInt8(0)); assert.equal(-85, data.readInt8(1)); assert.equal(124, data.readInt8(2)); assert.equal(-17, data.readInt8(3)); } function test16(clazz) { var buffer = new clazz(6); buffer[0] = 0x16; buffer[1] = 0x79; assert.equal(0x1679, buffer.readInt16BE(0)); assert.equal(0x7916, buffer.readInt16LE(0)); buffer[0] = 0xff; buffer[1] = 0x80; assert.equal(-128, buffer.readInt16BE(0)); assert.equal(-32513, buffer.readInt16LE(0)); /* test offset with weenix */ buffer[0] = 0x77; buffer[1] = 0x65; buffer[2] = 0x65; buffer[3] = 0x6e; buffer[4] = 0x69; buffer[5] = 0x78; assert.equal(0x7765, buffer.readInt16BE(0)); assert.equal(0x6565, buffer.readInt16BE(1)); assert.equal(0x656e, buffer.readInt16BE(2)); assert.equal(0x6e69, buffer.readInt16BE(3)); assert.equal(0x6978, buffer.readInt16BE(4)); assert.equal(0x6577, buffer.readInt16LE(0)); assert.equal(0x6565, buffer.readInt16LE(1)); assert.equal(0x6e65, buffer.readInt16LE(2)); assert.equal(0x696e, buffer.readInt16LE(3)); assert.equal(0x7869, buffer.readInt16LE(4)); } function test32(clazz) { var buffer = new clazz(6); buffer[0] = 0x43; buffer[1] = 0x53; buffer[2] = 0x16; buffer[3] = 0x79; assert.equal(0x43531679, buffer.readInt32BE(0)); assert.equal(0x79165343, buffer.readInt32LE(0)); buffer[0] = 0xff; buffer[1] = 0xfe; buffer[2] = 0xef; buffer[3] = 0xfa; assert.equal(-69638, buffer.readInt32BE(0)); assert.equal(-84934913, buffer.readInt32LE(0)); buffer[0] = 0x42; buffer[1] = 0xc3; buffer[2] = 0x95; buffer[3] = 0xa9; buffer[4] = 0x36; buffer[5] = 0x17; assert.equal(0x42c395a9, buffer.readInt32BE(0)); assert.equal(-1013601994, buffer.readInt32BE(1)); assert.equal(-1784072681, buffer.readInt32BE(2)); assert.equal(-1449802942, buffer.readInt32LE(0)); assert.equal(917083587, buffer.readInt32LE(1)); assert.equal(389458325, buffer.readInt32LE(2)); } test8(Buffer); test16(Buffer); test32(Buffer); node-v4.8.2/test/parallel/test-readline-interface.js000644 000766 000024 00000027170 13070706737 022600 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var readline = require('readline'); var EventEmitter = require('events').EventEmitter; var inherits = require('util').inherits; function FakeInput() { EventEmitter.call(this); } inherits(FakeInput, EventEmitter); FakeInput.prototype.resume = function() {}; FakeInput.prototype.pause = function() {}; FakeInput.prototype.write = function() {}; FakeInput.prototype.end = function() {}; function isWarned(emitter) { for (var name in emitter) { var listeners = emitter[name]; if (listeners.warned) return true; } return false; } [ true, false ].forEach(function(terminal) { var fi; var rli; var called; // sending a full line fi = new FakeInput(); rli = new readline.Interface({ input: fi, output: fi, terminal: terminal }); called = false; rli.on('line', function(line) { called = true; assert.equal(line, 'asdf'); }); fi.emit('data', 'asdf\n'); assert.ok(called); // sending a blank line fi = new FakeInput(); rli = new readline.Interface({ input: fi, output: fi, terminal: terminal }); called = false; rli.on('line', function(line) { called = true; assert.equal(line, ''); }); fi.emit('data', '\n'); assert.ok(called); // sending a single character with no newline fi = new FakeInput(); rli = new readline.Interface(fi, {}); called = false; rli.on('line', function(line) { called = true; }); fi.emit('data', 'a'); assert.ok(!called); rli.close(); // sending a single character with no newline and then a newline fi = new FakeInput(); rli = new readline.Interface({ input: fi, output: fi, terminal: terminal }); called = false; rli.on('line', function(line) { called = true; assert.equal(line, 'a'); }); fi.emit('data', 'a'); assert.ok(!called); fi.emit('data', '\n'); assert.ok(called); rli.close(); // sending multiple newlines at once fi = new FakeInput(); rli = new readline.Interface({ input: fi, output: fi, terminal: terminal }); var expectedLines = ['foo', 'bar', 'baz']; var callCount = 0; rli.on('line', function(line) { assert.equal(line, expectedLines[callCount]); callCount++; }); fi.emit('data', expectedLines.join('\n') + '\n'); assert.equal(callCount, expectedLines.length); rli.close(); // sending multiple newlines at once that does not end with a new line fi = new FakeInput(); rli = new readline.Interface({ input: fi, output: fi, terminal: terminal }); expectedLines = ['foo', 'bar', 'baz', 'bat']; callCount = 0; rli.on('line', function(line) { assert.equal(line, expectedLines[callCount]); callCount++; }); fi.emit('data', expectedLines.join('\n')); assert.equal(callCount, expectedLines.length - 1); rli.close(); // sending multiple newlines at once that does not end with a new(empty) // line and a `end` event fi = new FakeInput(); rli = new readline.Interface({ input: fi, output: fi, terminal: terminal }); expectedLines = ['foo', 'bar', 'baz', '']; callCount = 0; rli.on('line', function(line) { assert.equal(line, expectedLines[callCount]); callCount++; }); rli.on('close', function() { callCount++; }); fi.emit('data', expectedLines.join('\n')); fi.emit('end'); assert.equal(callCount, expectedLines.length); rli.close(); // sending multiple newlines at once that does not end with a new line // and a `end` event(last line is) // \r\n should emit one line event, not two fi = new FakeInput(); rli = new readline.Interface({ input: fi, output: fi, terminal: terminal }); expectedLines = ['foo', 'bar', 'baz', 'bat']; callCount = 0; rli.on('line', function(line) { assert.equal(line, expectedLines[callCount]); callCount++; }); fi.emit('data', expectedLines.join('\r\n')); assert.equal(callCount, expectedLines.length - 1); rli.close(); // \r\n should emit one line event when split across multiple writes. fi = new FakeInput(); rli = new readline.Interface({ input: fi, output: fi, terminal: terminal }); expectedLines = ['foo', 'bar', 'baz', 'bat']; callCount = 0; rli.on('line', function(line) { assert.equal(line, expectedLines[callCount]); callCount++; }); expectedLines.forEach(function(line) { fi.emit('data', line + '\r'); fi.emit('data', '\n'); }); assert.equal(callCount, expectedLines.length); rli.close(); // \r should behave like \n when alone fi = new FakeInput(); rli = new readline.Interface({ input: fi, output: fi, terminal: true }); expectedLines = ['foo', 'bar', 'baz', 'bat']; callCount = 0; rli.on('line', function(line) { assert.equal(line, expectedLines[callCount]); callCount++; }); fi.emit('data', expectedLines.join('\r')); assert.equal(callCount, expectedLines.length - 1); rli.close(); // \r at start of input should output blank line fi = new FakeInput(); rli = new readline.Interface({ input: fi, output: fi, terminal: true }); expectedLines = ['', 'foo' ]; callCount = 0; rli.on('line', function(line) { assert.equal(line, expectedLines[callCount]); callCount++; }); fi.emit('data', '\rfoo\r'); assert.equal(callCount, expectedLines.length); rli.close(); // \t when there is no completer function should behave like an ordinary // character fi = new FakeInput(); rli = new readline.Interface({ input: fi, output: fi, terminal: true }); called = false; rli.on('line', function(line) { assert.equal(line, '\t'); assert.strictEqual(called, false); called = true; }); fi.emit('data', '\t'); fi.emit('data', '\n'); assert.ok(called); rli.close(); // \t does not become part of the input when there is a completer function fi = new FakeInput(); var completer = function(line) { return [[], line]; }; rli = new readline.Interface({ input: fi, output: fi, terminal: true, completer: completer }); called = false; rli.on('line', function(line) { assert.equal(line, 'foo'); assert.strictEqual(called, false); called = true; }); for (var character of '\tfo\to\t') { fi.emit('data', character); } fi.emit('data', '\n'); assert.ok(called); rli.close(); // constructor throws if completer is not a function or undefined fi = new FakeInput(); assert.throws(function() { readline.createInterface({ input: fi, completer: 'string is not valid' }); }, function(err) { if (err instanceof TypeError) { if (/Argument \'completer\' must be a function/.test(err)) { return true; } } return false; }); // sending a multi-byte utf8 char over multiple writes var buf = Buffer('☮', 'utf8'); fi = new FakeInput(); rli = new readline.Interface({ input: fi, output: fi, terminal: terminal }); callCount = 0; rli.on('line', function(line) { callCount++; assert.equal(line, buf.toString('utf8')); }); [].forEach.call(buf, function(i) { fi.emit('data', Buffer([i])); }); assert.equal(callCount, 0); fi.emit('data', '\n'); assert.equal(callCount, 1); rli.close(); // Regression test for repl freeze, #1968: // check that nothing fails if 'keypress' event throws. fi = new FakeInput(); rli = new readline.Interface({ input: fi, output: fi, terminal: true }); var keys = []; fi.on('keypress', function(key) { keys.push(key); if (key === 'X') { throw new Error('bad thing happened'); } }); try { fi.emit('data', 'fooX'); } catch (e) { } fi.emit('data', 'bar'); assert.equal(keys.join(''), 'fooXbar'); rli.close(); // calling readline without `new` fi = new FakeInput(); rli = readline.Interface({ input: fi, output: fi, terminal: terminal }); called = false; rli.on('line', function(line) { called = true; assert.equal(line, 'asdf'); }); fi.emit('data', 'asdf\n'); assert.ok(called); rli.close(); if (terminal) { // question fi = new FakeInput(); rli = new readline.Interface({ input: fi, output: fi, terminal: terminal }); expectedLines = ['foo']; rli.question(expectedLines[0], function() { rli.close(); }); var cursorPos = rli._getCursorPos(); assert.equal(cursorPos.rows, 0); assert.equal(cursorPos.cols, expectedLines[0].length); rli.close(); // sending a multi-line question fi = new FakeInput(); rli = new readline.Interface({ input: fi, output: fi, terminal: terminal }); expectedLines = ['foo', 'bar']; rli.question(expectedLines.join('\n'), function() { rli.close(); }); cursorPos = rli._getCursorPos(); assert.equal(cursorPos.rows, expectedLines.length - 1); assert.equal(cursorPos.cols, expectedLines.slice(-1)[0].length); rli.close(); } // isFullWidthCodePoint() should return false for non-numeric values [true, false, null, undefined, {}, [], 'あ'].forEach((v) => { assert.strictEqual(readline.isFullWidthCodePoint('あ'), false); }); // wide characters should be treated as two columns. assert.equal(readline.isFullWidthCodePoint('a'.charCodeAt(0)), false); assert.equal(readline.isFullWidthCodePoint('あ'.charCodeAt(0)), true); assert.equal(readline.isFullWidthCodePoint('谢'.charCodeAt(0)), true); assert.equal(readline.isFullWidthCodePoint('고'.charCodeAt(0)), true); assert.equal(readline.isFullWidthCodePoint(0x1f251), true); // surrogate assert.equal(readline.codePointAt('ABC', 0), 0x41); assert.equal(readline.codePointAt('あいう', 1), 0x3044); assert.equal(readline.codePointAt('\ud800\udc00', 0), // surrogate 0x10000); assert.equal(readline.codePointAt('\ud800\udc00A', 2), // surrogate 0x41); assert.equal(readline.getStringWidth('abcde'), 5); assert.equal(readline.getStringWidth('古池や'), 6); assert.equal(readline.getStringWidth('ノード.js'), 9); assert.equal(readline.getStringWidth('你好'), 4); assert.equal(readline.getStringWidth('안녕하세요'), 10); assert.equal(readline.getStringWidth('A\ud83c\ude00BC'), 5); // surrogate // check if vt control chars are stripped assert.equal(readline .stripVTControlCharacters('\u001b[31m> \u001b[39m'), '> '); assert.equal(readline .stripVTControlCharacters('\u001b[31m> \u001b[39m> '), '> > '); assert.equal(readline .stripVTControlCharacters('\u001b[31m\u001b[39m'), ''); assert.equal(readline .stripVTControlCharacters('> '), '> '); assert.equal(readline.getStringWidth('\u001b[31m> \u001b[39m'), 2); assert.equal(readline.getStringWidth('\u001b[31m> \u001b[39m> '), 4); assert.equal(readline.getStringWidth('\u001b[31m\u001b[39m'), 0); assert.equal(readline.getStringWidth('> '), 2); assert.deepEqual(fi.listeners(terminal ? 'keypress' : 'data'), []); // check EventEmitter memory leak for (var i = 0; i < 12; i++) { var rl = readline.createInterface({ input: process.stdin, output: process.stdout }); rl.close(); assert.equal(isWarned(process.stdin._events), false); assert.equal(isWarned(process.stdout._events), false); } //can create a new readline Interface with a null output arugument fi = new FakeInput(); rli = new readline.Interface({input: fi, output: null, terminal: terminal }); called = false; rli.on('line', function(line) { called = true; assert.equal(line, 'asdf'); }); fi.emit('data', 'asdf\n'); assert.ok(called); assert.doesNotThrow(function() { rli.setPrompt('ddd> '); }); assert.doesNotThrow(function() { rli.prompt(); }); assert.doesNotThrow(function() { rli.write('really shouldnt be seeing this'); }); assert.doesNotThrow(function() { rli.question('What do you think of node.js? ', function(answer) { console.log('Thank you for your valuable feedback:', answer); rli.close(); }); }); }); node-v4.8.2/test/parallel/test-readline-keys.js000644 000766 000024 00000014300 13070706737 021602 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var PassThrough = require('stream').PassThrough; var assert = require('assert'); var inherits = require('util').inherits; var extend = require('util')._extend; var Interface = require('readline').Interface; function FakeInput() { PassThrough.call(this); } inherits(FakeInput, PassThrough); var fi = new FakeInput(); var fo = new FakeInput(); new Interface({ input: fi, output: fo, terminal: true }); var keys = []; fi.on('keypress', function(s, k) { keys.push(k); }); function addTest(sequences, expectedKeys) { if (!Array.isArray(sequences)) { sequences = [ sequences ]; } if (!Array.isArray(expectedKeys)) { expectedKeys = [ expectedKeys ]; } expectedKeys = expectedKeys.map(function(k) { return k ? extend({ ctrl: false, meta: false, shift: false }, k) : k; }); keys = []; sequences.forEach(function(sequence) { fi.write(sequence); }); assert.deepStrictEqual(keys, expectedKeys); } // Simulate key interval test cases // Returns a function that takes `next` test case and returns a thunk // that can be called to run tests in sequence // e.g. // addKeyIntervalTest(..) // (addKeyIntervalTest(..) // (addKeyIntervalTest(..)(noop)))() // where noop is a terminal function(() => {}). const addKeyIntervalTest = (sequences, expectedKeys, interval, assertDelay) => { if (!interval) interval = 550; if (!assertDelay) assertDelay = 550; return (next) => () => { if (!Array.isArray(sequences)) { sequences = [ sequences ]; } if (!Array.isArray(expectedKeys)) { expectedKeys = [ expectedKeys ]; } expectedKeys = expectedKeys.map(function(k) { return k ? extend({ ctrl: false, meta: false, shift: false }, k) : k; }); const keys = []; fi.on('keypress', (s, k) => keys.push(k)); const emitKeys = (arr) => { var head = arr.shift(); var tail = arr; if (head) { fi.write(head); setTimeout(() => emitKeys(tail), interval); } else { setTimeout(() => { next(); assert.deepStrictEqual(keys, expectedKeys); }, assertDelay); } }; emitKeys(sequences); }; }; // regular alphanumerics addTest('io.JS', [ { name: 'i', sequence: 'i' }, { name: 'o', sequence: 'o' }, undefined, // emitted as `emit('keypress', '.', undefined)` { name: 'j', sequence: 'J', shift: true }, { name: 's', sequence: 'S', shift: true }, ]); // named characters addTest('\n\r\t', [ { name: 'enter', sequence: '\n' }, { name: 'return', sequence: '\r' }, { name: 'tab', sequence: '\t' }, ]); // space and backspace addTest('\b\x7f\x1b\b\x1b\x7f \x1b ', [ { name: 'backspace', sequence: '\b' }, { name: 'backspace', sequence: '\x7f' }, { name: 'backspace', sequence: '\x1b\b', meta: true }, { name: 'backspace', sequence: '\x1b\x7f', meta: true }, { name: 'space', sequence: ' ' }, { name: 'space', sequence: '\x1b ', meta: true }, ]); // control keys addTest('\x01\x0b\x10', [ { name: 'a', sequence: '\x01', ctrl: true }, { name: 'k', sequence: '\x0b', ctrl: true }, { name: 'p', sequence: '\x10', ctrl: true }, ]); // alt keys addTest('a\x1baA\x1bA', [ { name: 'a', sequence: 'a' }, { name: 'a', sequence: '\x1ba', meta: true }, { name: 'a', sequence: 'A', shift: true }, { name: 'a', sequence: '\x1bA', meta: true, shift: true }, ]); // xterm/gnome addTest('\x1bOA\x1bOB', [ { name: 'up', sequence: '\x1bOA', code: 'OA' }, { name: 'down', sequence: '\x1bOB', code: 'OB' }, ]); // old xterm shift-arrows addTest('\x1bO2A\x1bO2B', [ { name: 'up', sequence: '\x1bO2A', code: 'OA', shift: true }, { name: 'down', sequence: '\x1bO2B', code: 'OB', shift: true }, ]); // gnome terminal addTest('\x1b[A\x1b[B\x1b[2A\x1b[2B', [ { name: 'up', sequence: '\x1b[A', code: '[A' }, { name: 'down', sequence: '\x1b[B', code: '[B' }, { name: 'up', sequence: '\x1b[2A', code: '[A', shift: true }, { name: 'down', sequence: '\x1b[2B', code: '[B', shift: true }, ]); // rxvt addTest('\x1b[20~\x1b[2$\x1b[2^', [ { name: 'f9', sequence: '\x1b[20~', code: '[20~' }, { name: 'insert', sequence: '\x1b[2$', code: '[2$', shift: true }, { name: 'insert', sequence: '\x1b[2^', code: '[2^', ctrl: true }, ]); // xterm + modifiers addTest('\x1b[20;5~\x1b[6;5^', [ { name: 'f9', sequence: '\x1b[20;5~', code: '[20~', ctrl: true }, { name: 'pagedown', sequence: '\x1b[6;5^', code: '[6^', ctrl: true }, ]); addTest('\x1b[H\x1b[5H\x1b[1;5H', [ { name: 'home', sequence: '\x1b[H', code: '[H' }, { name: 'home', sequence: '\x1b[5H', code: '[H', ctrl: true }, { name: 'home', sequence: '\x1b[1;5H', code: '[H', ctrl: true }, ]); // escape sequences broken into multiple data chunks addTest('\x1b[D\x1b[C\x1b[D\x1b[C'.split(''), [ { name: 'left', sequence: '\x1b[D', code: '[D' }, { name: 'right', sequence: '\x1b[C', code: '[C' }, { name: 'left', sequence: '\x1b[D', code: '[D' }, { name: 'right', sequence: '\x1b[C', code: '[C' }, ]); // escape sequences mixed with regular ones addTest('\x1b[DD\x1b[2DD\x1b[2^D', [ { name: 'left', sequence: '\x1b[D', code: '[D' }, { name: 'd', sequence: 'D', shift: true }, { name: 'left', sequence: '\x1b[2D', code: '[D', shift: true }, { name: 'd', sequence: 'D', shift: true }, { name: 'insert', sequence: '\x1b[2^', code: '[2^', ctrl: true }, { name: 'd', sequence: 'D', shift: true }, ]); // color sequences addTest('\x1b[31ma\x1b[39ma', [ { name: 'undefined', sequence: '\x1b[31m', code: '[31m' }, { name: 'a', sequence: 'a' }, { name: 'undefined', sequence: '\x1b[39m', code: '[39m' }, { name: 'a', sequence: 'a' }, ]); // Reduce array of addKeyIntervalTest(..) right to left // with () => {} as initial function const runKeyIntervalTests = [ // escape character addKeyIntervalTest('\x1b', [ { name: 'escape', sequence: '\x1b', meta: true } ]), // chain of escape characters addKeyIntervalTest('\x1b\x1b\x1b\x1b'.split(''), [ { name: 'escape', sequence: '\x1b', meta: true }, { name: 'escape', sequence: '\x1b', meta: true }, { name: 'escape', sequence: '\x1b', meta: true }, { name: 'escape', sequence: '\x1b', meta: true } ]) ].reverse().reduce((acc, fn) => fn(acc), () => {}); // run key interval tests one after another runKeyIntervalTests(); node-v4.8.2/test/parallel/test-readline-set-raw-mode.js000644 000766 000024 00000002745 13070706737 023145 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var readline = require('readline'); var Stream = require('stream'); var stream = new Stream(); var expectedRawMode = true; var rawModeCalled = false; var resumeCalled = false; var pauseCalled = false; stream.setRawMode = function(mode) { rawModeCalled = true; assert.equal(mode, expectedRawMode); }; stream.resume = function() { resumeCalled = true; }; stream.pause = function() { pauseCalled = true; }; // when the "readline" starts in "terminal" mode, // then setRawMode(true) should be called var rli = readline.createInterface({ input: stream, output: stream, terminal: true }); assert(rli.terminal); assert(rawModeCalled); assert(resumeCalled); assert(!pauseCalled); // pause() should call *not* call setRawMode() rawModeCalled = false; resumeCalled = false; pauseCalled = false; rli.pause(); assert(!rawModeCalled); assert(!resumeCalled); assert(pauseCalled); // resume() should *not* call setRawMode() rawModeCalled = false; resumeCalled = false; pauseCalled = false; rli.resume(); assert(!rawModeCalled); assert(resumeCalled); assert(!pauseCalled); // close() should call setRawMode(false) expectedRawMode = false; rawModeCalled = false; resumeCalled = false; pauseCalled = false; rli.close(); assert(rawModeCalled); assert(!resumeCalled); assert(pauseCalled); assert.deepEqual(stream.listeners('keypress'), []); // one data listener for the keypress events. assert.equal(stream.listeners('data').length, 1); node-v4.8.2/test/parallel/test-readline-undefined-columns.js000644 000766 000024 00000001502 13070706737 024246 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const PassThrough = require('stream').PassThrough; const readline = require('readline'); // Checks that tab completion still works // when output column size is undefined const iStream = new PassThrough(); const oStream = new PassThrough(); readline.createInterface({ terminal: true, input: iStream, output: oStream, completer: function(line, cb) { cb(null, [['process.stdout', 'process.stdin', 'process.stderr'], line]); } }); var output = ''; oStream.on('data', function(data) { output += data; }); oStream.on('end', function() { const expect = 'process.stdout\r\n' + 'process.stdin\r\n' + 'process.stderr'; assert(new RegExp(expect).test(output)); }); iStream.write('process.std\t'); oStream.end(); node-v4.8.2/test/parallel/test-readuint.js000644 000766 000024 00000004671 13070706737 020673 0ustar00iojsstaff000000 000000 'use strict'; /* * A battery of tests to help us read a series of uints */ require('../common'); const assert = require('assert'); /* * We need to check the following things: * - We are correctly resolving big endian (doesn't mean anything for 8 bit) * - Correctly resolving little endian (doesn't mean anything for 8 bit) * - Correctly using the offsets * - Correctly interpreting values that are beyond the signed range as unsigned */ function test8(clazz) { var data = new clazz(4); data[0] = 23; data[1] = 23; data[2] = 23; data[3] = 23; assert.equal(23, data.readUInt8(0)); assert.equal(23, data.readUInt8(1)); assert.equal(23, data.readUInt8(2)); assert.equal(23, data.readUInt8(3)); data[0] = 255; /* If it became a signed int, would be -1 */ assert.equal(255, data.readUInt8(0)); } /* * Test 16 bit unsigned integers. We need to verify the same set as 8 bit, only * now some of the issues actually matter: * - We are correctly resolving big endian * - Correctly resolving little endian * - Correctly using the offsets * - Correctly interpreting values that are beyond the signed range as unsigned */ function test16(clazz) { var data = new clazz(4); data[0] = 0; data[1] = 0x23; data[2] = 0x42; data[3] = 0x3f; assert.equal(0x23, data.readUInt16BE(0)); assert.equal(0x2342, data.readUInt16BE(1)); assert.equal(0x423f, data.readUInt16BE(2)); assert.equal(0x2300, data.readUInt16LE(0)); assert.equal(0x4223, data.readUInt16LE(1)); assert.equal(0x3f42, data.readUInt16LE(2)); data[0] = 0xfe; data[1] = 0xfe; assert.equal(0xfefe, data.readUInt16BE(0)); assert.equal(0xfefe, data.readUInt16LE(0)); } /* * Test 32 bit unsigned integers. We need to verify the same set as 8 bit, only * now some of the issues actually matter: * - We are correctly resolving big endian * - Correctly using the offsets * - Correctly interpreting values that are beyond the signed range as unsigned */ function test32(clazz) { var data = new clazz(8); data[0] = 0x32; data[1] = 0x65; data[2] = 0x42; data[3] = 0x56; data[4] = 0x23; data[5] = 0xff; assert.equal(0x32654256, data.readUInt32BE(0)); assert.equal(0x65425623, data.readUInt32BE(1)); assert.equal(0x425623ff, data.readUInt32BE(2)); assert.equal(0x56426532, data.readUInt32LE(0)); assert.equal(0x23564265, data.readUInt32LE(1)); assert.equal(0xff235642, data.readUInt32LE(2)); } test8(Buffer); test16(Buffer); test32(Buffer); node-v4.8.2/test/parallel/test-ref-unref-return.js000644 000766 000024 00000000771 13070706737 022263 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var net = require('net'); var dgram = require('dgram'); assert.ok((new net.Server()).ref() instanceof net.Server); assert.ok((new net.Server()).unref() instanceof net.Server); assert.ok((new net.Socket()).ref() instanceof net.Socket); assert.ok((new net.Socket()).unref() instanceof net.Socket); assert.ok((new dgram.Socket('udp4')).ref() instanceof dgram.Socket); assert.ok((new dgram.Socket('udp6')).unref() instanceof dgram.Socket); node-v4.8.2/test/parallel/test-regress-GH-1531.js000644 000766 000024 00000001523 13070706737 021406 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var https = require('https'); var fs = require('fs'); var options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }; var server = https.createServer(options, function(req, res) { res.writeHead(200); res.end('hello world\n'); }); server.listen(0, common.mustCall(function() { console.error('listening'); https.get({ agent: false, path: '/', port: this.address().port, rejectUnauthorized: false }, common.mustCall(function(res) { console.error(res.statusCode, res.headers); res.resume(); server.close(); })).on('error', function(e) { console.error(e.stack); process.exit(1); }); })); node-v4.8.2/test/parallel/test-regress-GH-1899.js000644 000766 000024 00000000674 13070706737 021435 0ustar00iojsstaff000000 000000 'use strict'; var path = require('path'); var assert = require('assert'); var spawn = require('child_process').spawn; var common = require('../common'); var child = spawn(process.argv[0], [ path.join(common.fixturesDir, 'GH-1899-output.js') ]); var output = ''; child.stdout.on('data', function(data) { output += data; }); child.on('exit', function(code, signal) { assert.equal(code, 0); assert.equal(output, 'hello, world!\n'); }); node-v4.8.2/test/parallel/test-regress-GH-2245.js000644 000766 000024 00000001137 13070706737 021412 0ustar00iojsstaff000000 000000 /* eslint-disable strict */ require('../common'); var assert = require('assert'); /* In Node.js 0.10, a bug existed that caused strict functions to not capture their environment when evaluated. When run in 0.10 `test()` fails with a `ReferenceError`. See https://github.com/nodejs/node/issues/2245 for details. */ function test() { var code = [ 'var foo = {m: 1};', '', 'function bar() {', '\'use strict\';', 'return foo; // foo isn\'t captured in 0.10', '};' ].join('\n'); eval(code); return bar(); // eslint-disable-line no-undef } assert.deepEqual(test(), {m: 1}); node-v4.8.2/test/parallel/test-regress-GH-3238.js000644 000766 000024 00000001036 13070706737 021413 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const cluster = require('cluster'); if (cluster.isMaster) { function forkWorker(action) { const worker = cluster.fork({ action }); worker.on('disconnect', common.mustCall(() => { assert.strictEqual(worker.suicide, true); })); worker.on('exit', common.mustCall(() => { assert.strictEqual(worker.suicide, true); })); } forkWorker('disconnect'); forkWorker('kill'); } else { cluster.worker[process.env.action](); } node-v4.8.2/test/parallel/test-regress-GH-3542.js000644 000766 000024 00000001247 13070706737 021415 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const fs = require('fs'); const path = require('path'); // This test is only relevant on Windows. if (!common.isWindows) { common.skip('Windows specific test.'); return; } function test(p) { var result = fs.realpathSync(p); assert.strictEqual(result, path.resolve(p)); fs.realpath(p, common.mustCall(function(err, result) { assert.ok(!err); assert.strictEqual(result, path.resolve(p)); })); } test('//localhost/c$/windows/system32'); test('//localhost/c$/windows'); test('//localhost/c$/'); test('\\\\localhost\\c$'); test('c:\\'); test('c:'); test(process.env.windir); node-v4.8.2/test/parallel/test-regress-GH-3739.js000644 000766 000024 00000001235 13070706737 021422 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const fs = require('fs'); const path = require('path'); var dir = path.resolve(common.tmpDir); // Make sure that the tmp directory is clean common.refreshTmpDir(); // Make a long path. for (var i = 0; i < 50; i++) { dir = dir + '/1234567890'; try { fs.mkdirSync(dir, '0777'); } catch (e) { if (e.code !== 'EEXIST') { throw e; } } } // Test if file exists synchronously assert(common.fileExists(dir), 'Directory is not accessible'); // Test if file exists asynchronously fs.access(dir, function(err) { assert(!err, 'Directory is not accessible'); }); node-v4.8.2/test/parallel/test-regress-GH-4256.js000644 000766 000024 00000000242 13070706737 021412 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); process.domain = null; setTimeout(function() { console.log('this console.log statement should not make node crash'); }, 1); node-v4.8.2/test/parallel/test-regress-GH-4948.js000644 000766 000024 00000002043 13070706737 021423 0ustar00iojsstaff000000 000000 'use strict'; // https://github.com/joyent/node/issues/4948 require('../common'); var http = require('http'); var reqCount = 0; var server = http.createServer(function(serverReq, serverRes) { if (reqCount) { serverRes.end(); server.close(); return; } reqCount = 1; // normally the use case would be to call an external site // does not require connecting locally or to itself to fail var r = http.request({hostname: 'localhost', port: this.address().port}, function(res) { // required, just needs to be in the client response somewhere serverRes.end(); // required for test to fail res.on('data', function(data) { }); }); r.on('error', function(e) {}); r.end(); serverRes.write('some data'); }).listen(0, function() { // simulate a client request that closes early var net = require('net'); var sock = new net.Socket(); sock.connect(this.address().port, 'localhost'); sock.on('connect', function() { sock.write('GET / HTTP/1.1\r\n\r\n'); sock.end(); }); }); node-v4.8.2/test/parallel/test-regress-GH-5927.js000644 000766 000024 00000000727 13070706737 021430 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var readline = require('readline'); var rl = readline.createInterface(process.stdin, process.stdout); rl.resume(); var hasPaused = false; var origPause = rl.pause; rl.pause = function() { hasPaused = true; origPause.apply(this, arguments); }; var origSetRawMode = rl._setRawMode; rl._setRawMode = function(mode) { assert.ok(hasPaused); origSetRawMode.apply(this, arguments); }; rl.close(); node-v4.8.2/test/parallel/test-regress-GH-6235.js000644 000766 000024 00000000255 13070706737 021415 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); assert.doesNotThrow(function() { require('vm').runInNewContext('"use strict"; var v = 1; v = 2'); }); node-v4.8.2/test/parallel/test-regress-GH-746.js000644 000766 000024 00000000720 13070706737 021333 0ustar00iojsstaff000000 000000 'use strict'; // Just test that destroying stdin doesn't mess up listening on a server. // This is a regression test for GH-746. const common = require('../common'); var net = require('net'); process.stdin.destroy(); var server = net.createServer(common.mustCall(function(socket) { console.log('accepted'); socket.end(); server.close(); })); server.listen(0, function() { console.log('listening...'); net.createConnection(this.address().port); }); node-v4.8.2/test/parallel/test-regress-GH-7511.js000644 000766 000024 00000000445 13070706737 021414 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const vm = require('vm'); assert.doesNotThrow(function() { var context = vm.createContext({ process: process }); var result = vm.runInContext('process.env["PATH"]', context); assert.notEqual(undefined, result); }); node-v4.8.2/test/parallel/test-regress-GH-819.js000644 000766 000024 00000000260 13070706737 021333 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var net = require('net'); // Connect to something that we need to DNS resolve var c = net.createConnection(80, 'google.com'); c.destroy(); node-v4.8.2/test/parallel/test-regress-GH-io-1068.js000644 000766 000024 00000000077 13070706737 022023 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); process.stdin.emit('end'); node-v4.8.2/test/parallel/test-regress-GH-io-1811.js000644 000766 000024 00000001103 13070706737 022006 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); // Change kMaxLength for zlib to trigger the error without having to allocate // large Buffers. const buffer = require('buffer'); const oldkMaxLength = buffer.kMaxLength; buffer.kMaxLength = 128; const zlib = require('zlib'); buffer.kMaxLength = oldkMaxLength; const encoded = new Buffer('H4sIAAAAAAAAA0tMHFgAAIw2K/GAAAAA', 'base64'); // Async zlib.gunzip(encoded, function(err) { assert.ok(err instanceof RangeError); }); // Sync assert.throws(function() { zlib.gunzipSync(encoded); }, RangeError); node-v4.8.2/test/parallel/test-regress-GH-node-9326.js000644 000766 000024 00000000471 13070706737 022344 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var child_process = require('child_process'); // NOTE: Was crashing on FreeBSD var cp = child_process.spawn(process.execPath, [ '-e', 'process.kill(process.pid, "SIGINT")' ]); cp.on('exit', function(code) { assert.notEqual(code, 0); }); node-v4.8.2/test/parallel/test-regression-object-prototype.js000644 000766 000024 00000000204 13070706737 024533 0ustar00iojsstaff000000 000000 /* eslint-disable required-modules */ 'use strict'; Object.prototype.xadsadsdasasdxx = function() { }; console.log('puts after'); node-v4.8.2/test/parallel/test-repl-.save.load.js000644 000766 000024 00000004265 13070706737 021751 0ustar00iojsstaff000000 000000 'use strict'; var assert = require('assert'); var join = require('path').join; var fs = require('fs'); var common = require('../common'); common.refreshTmpDir(); var repl = require('repl'); var works = [['inner.one'], 'inner.o']; const putIn = new common.ArrayStream(); var testMe = repl.start('', putIn); var testFile = [ 'var top = function() {', 'var inner = {one:1};' ]; var saveFileName = join(common.tmpDir, 'test.save.js'); // input some data putIn.run(testFile); // save it to a file putIn.run(['.save ' + saveFileName]); // the file should have what I wrote assert.equal(fs.readFileSync(saveFileName, 'utf8'), testFile.join('\n') + '\n'); // make sure that the REPL data is "correct" // so when I load it back I know I'm good testMe.complete('inner.o', function(error, data) { assert.deepEqual(data, works); }); // clear the REPL putIn.run(['.clear']); // Load the file back in putIn.run(['.load ' + saveFileName]); // make sure that the REPL data is "correct" testMe.complete('inner.o', function(error, data) { assert.deepEqual(data, works); }); // clear the REPL putIn.run(['.clear']); var loadFile = join(common.tmpDir, 'file.does.not.exist'); // should not break putIn.write = function(data) { // make sure I get a failed to load message and not some crazy error assert.equal(data, 'Failed to load:' + loadFile + '\n'); // eat me to avoid work putIn.write = function() {}; }; putIn.run(['.load ' + loadFile]); // throw error on loading directory loadFile = common.tmpDir; putIn.write = function(data) { assert.equal(data, 'Failed to load:' + loadFile + ' is not a valid file\n'); putIn.write = function() {}; }; putIn.run(['.load ' + loadFile]); // clear the REPL putIn.run(['.clear']); // NUL (\0) is disallowed in filenames in UNIX-like operating systems and // Windows so we can use that to test failed saves const invalidFileName = join(common.tmpDir, '\0\0\0\0\0'); // should not break putIn.write = function(data) { // make sure I get a failed to save message and not some other error assert.equal(data, 'Failed to save:' + invalidFileName + '\n'); // reset to no-op putIn.write = function() {}; }; // save it to a file putIn.run(['.save ' + invalidFileName]); node-v4.8.2/test/parallel/test-repl-autolibs.js000644 000766 000024 00000002116 13070706737 021632 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var util = require('util'); var repl = require('repl'); // This test adds global variables common.globalCheck = false; const putIn = new common.ArrayStream(); repl.start('', putIn, null, true); test1(); function test1() { var gotWrite = false; putIn.write = function(data) { gotWrite = true; if (data.length) { // inspect output matches repl output assert.equal(data, util.inspect(require('fs'), null, 2, false) + '\n'); // globally added lib matches required lib assert.equal(global.fs, require('fs')); test2(); } }; assert(!gotWrite); putIn.run(['fs']); assert(gotWrite); } function test2() { var gotWrite = false; putIn.write = function(data) { gotWrite = true; if (data.length) { // repl response error message assert.equal(data, '{}\n'); // original value wasn't overwritten assert.equal(val, global.url); } }; var val = {}; global.url = val; assert(!gotWrite); putIn.run(['url']); assert(gotWrite); } node-v4.8.2/test/parallel/test-repl-console.js000644 000766 000024 00000001144 13070706737 021452 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const repl = require('repl'); // Create a dummy stream that does nothing const stream = new common.ArrayStream(); var r = repl.start({ input: stream, output: stream, useGlobal: false }); // ensure that the repl context gets its own "console" instance assert(r.context.console); // ensure that the repl console instance is not the global one assert.notStrictEqual(r.context.console, console); // ensure that the repl console instance does not have a setter assert.throws(() => r.context.console = 'foo', TypeError); node-v4.8.2/test/parallel/test-repl-context.js000644 000766 000024 00000001335 13070706737 021476 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const repl = require('repl'); // Create a dummy stream that does nothing const stream = new common.ArrayStream(); // Test when useGlobal is false testContext(repl.start({ input: stream, output: stream, useGlobal: false })); function testContext(repl) { const context = repl.createContext(); // ensure that the repl context gets its own "console" instance assert(context.console instanceof require('console').Console); // ensure that the repl's global property is the context assert(context.global === context); // ensure that the repl console instance does not have a setter assert.throws(() => context.console = 'foo'); } node-v4.8.2/test/parallel/test-repl-definecommand.js000644 000766 000024 00000002075 13070706737 022605 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const stream = require('stream'); const assert = require('assert'); const repl = require('repl'); var output = ''; const inputStream = new stream.PassThrough(); const outputStream = new stream.PassThrough(); outputStream.on('data', function(d) { output += d; }); const r = repl.start({ input: inputStream, output: outputStream, terminal: true }); r.defineCommand('say1', { help: 'help for say1', action: function(thing) { output = ''; this.write('hello ' + thing); this.displayPrompt(); } }); r.defineCommand('say2', function() { output = ''; this.write('hello from say2'); this.displayPrompt(); }); inputStream.write('.help\n'); assert(/\nsay1\thelp for say1\n/.test(output), 'help for say1 not present'); assert(/\nsay2\t\n/.test(output), 'help for say2 not present'); inputStream.write('.say1 node developer\n'); assert(/> hello node developer/.test(output), 'say1 outputted incorrectly'); inputStream.write('.say2 node developer\n'); assert(/> hello from say2/.test(output), 'say2 outputted incorrectly'); node-v4.8.2/test/parallel/test-repl-domain.js000644 000766 000024 00000001067 13070706737 021263 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var repl = require('repl'); const putIn = new common.ArrayStream(); repl.start('', putIn); putIn.write = function(data) { // Don't use assert for this because the domain might catch it, and // give a false negative. Don't throw, just print and exit. if (data === 'OK\n') { console.log('ok'); } else { console.error(data); process.exit(1); } }; putIn.run([ 'require("domain").create().on("error", function() { console.log("OK") })' + '.run(function() { throw new Error("threw") })' ]); node-v4.8.2/test/parallel/test-repl-end-emits-exit.js000644 000766 000024 00000002010 13070706737 022635 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const repl = require('repl'); let terminalExit = 0; let regularExit = 0; // Create a dummy stream that does nothing const stream = new common.ArrayStream(); function testTerminalMode() { var r1 = repl.start({ input: stream, output: stream, terminal: true }); process.nextTick(function() { // manually fire a ^D keypress stream.emit('data', '\u0004'); }); r1.on('exit', function() { // should be fired from the simulated ^D keypress terminalExit++; testRegularMode(); }); } function testRegularMode() { var r2 = repl.start({ input: stream, output: stream, terminal: false }); process.nextTick(function() { stream.emit('end'); }); r2.on('exit', function() { // should be fired from the simulated 'end' event regularExit++; }); } process.on('exit', function() { assert.equal(terminalExit, 1); assert.equal(regularExit, 1); }); // start testTerminalMode(); node-v4.8.2/test/parallel/test-repl-envvars.js000644 000766 000024 00000003023 13070706737 021472 0ustar00iojsstaff000000 000000 'use strict'; // Flags: --expose-internals const common = require('../common'); const stream = require('stream'); const REPL = require('internal/repl'); const assert = require('assert'); const inspect = require('util').inspect; const tests = [ { env: {}, expected: { terminal: true, useColors: true } }, { env: { NODE_DISABLE_COLORS: '1' }, expected: { terminal: true, useColors: false } }, { env: { NODE_NO_READLINE: '1' }, expected: { terminal: false, useColors: false } }, { env: { TERM: 'dumb' }, expected: { terminal: true, useColors: false } }, { env: { NODE_NO_READLINE: '1', NODE_DISABLE_COLORS: '1' }, expected: { terminal: false, useColors: false } }, { env: { NODE_NO_READLINE: '0' }, expected: { terminal: true, useColors: true } } ]; function run(test) { const env = test.env; const expected = test.expected; const opts = { terminal: true, input: new stream.Readable({ read() {} }), output: new stream.Writable({ write() {} }) }; REPL.createInternalRepl(env, opts, function(err, repl) { if (err) throw err; // The REPL registers 'module' and 'require' globals common.allowGlobals(repl.context.module, repl.context.require); assert.equal(expected.terminal, repl.terminal, 'Expected ' + inspect(expected) + ' with ' + inspect(env)); assert.equal(expected.useColors, repl.useColors, 'Expected ' + inspect(expected) + ' with ' + inspect(env)); repl.close(); }); } tests.forEach(run); node-v4.8.2/test/parallel/test-repl-eval-scope.js000644 000766 000024 00000001024 13070706737 022043 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const repl = require('repl'); { const stream = new common.ArrayStream(); const options = { eval: common.mustCall((cmd, context) => { assert.strictEqual(cmd, '.scope\n'); assert.deepStrictEqual(context, {animal: 'Sterrance'}); }), input: stream, output: stream, terminal: true }; const r = repl.start(options); r.context = {animal: 'Sterrance'}; stream.emit('data', '\t'); stream.emit('.exit\n'); } node-v4.8.2/test/parallel/test-repl-eval.js000644 000766 000024 00000001254 13070706737 020741 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const repl = require('repl'); { let evalCalledWithExpectedArgs = false; const options = { eval: common.mustCall((cmd, context) => { // Assertions here will not cause the test to exit with an error code // so set a boolean that is checked in process.on('exit',...) instead. evalCalledWithExpectedArgs = (cmd === 'foo\n' && context.foo === 'bar'); }) }; const r = repl.start(options); r.context = {foo: 'bar'}; try { r.write('foo\n'); } finally { r.write('.exit\n'); } process.on('exit', () => { assert(evalCalledWithExpectedArgs); }); } node-v4.8.2/test/parallel/test-repl-harmony.js000644 000766 000024 00000001207 13070706737 021465 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var spawn = require('child_process').spawn; var args = ['-i']; var child = spawn(process.execPath, args); var input = '(function(){"use strict"; const y=1;y=2})()\n'; var expectOut = /^> TypeError: Assignment to constant variable.\n/; child.stderr.setEncoding('utf8'); child.stderr.on('data', function(c) { throw new Error('child.stderr be silent'); }); child.stdout.setEncoding('utf8'); var out = ''; child.stdout.on('data', function(c) { out += c; }); child.stdout.on('end', function() { assert(expectOut.test(out)); console.log('ok'); }); child.stdin.end(input); node-v4.8.2/test/parallel/test-repl-history-perm.js000644 000766 000024 00000002561 13070706737 022456 0ustar00iojsstaff000000 000000 'use strict'; // Flags: --expose_internals const common = require('../common'); if (common.isWindows) { common.skip('Win32 uses ACLs for file permissions, ' + 'modes are always 0666 and says nothing about group/other ' + 'read access.'); return; } const assert = require('assert'); const path = require('path'); const fs = require('fs'); const repl = require('internal/repl'); const Duplex = require('stream').Duplex; // Invoking the REPL should create a repl history file at the specified path // and mode 600. var stream = new Duplex(); stream.pause = stream.resume = function() {}; // ends immediately stream._read = function() { this.push(null); }; stream._write = function(c, e, cb) { cb(); }; stream.readable = stream.writable = true; common.refreshTmpDir(); const replHistoryPath = path.join(common.tmpDir, '.node_repl_history'); const checkResults = common.mustCall(function(err, r) { if (err) throw err; // The REPL registers 'module' and 'require' globals common.allowGlobals(r.context.module, r.context.require); r.input.end(); const stat = fs.statSync(replHistoryPath); assert.strictEqual( stat.mode & 0o777, 0o600, 'REPL history file should be mode 0600'); }); repl.createInternalRepl( {NODE_REPL_HISTORY: replHistoryPath}, { terminal: true, input: stream, output: stream }, checkResults ); node-v4.8.2/test/parallel/test-repl-mode.js000644 000766 000024 00000003573 13070706737 020744 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const Stream = require('stream'); const repl = require('repl'); common.globalCheck = false; const tests = [ testSloppyMode, testStrictMode, testAutoMode ]; tests.forEach(function(test) { test(); }); function testSloppyMode() { const cli = initRepl(repl.REPL_MODE_SLOPPY); cli.input.emit('data', ` x = 3 `.trim() + '\n'); assert.strictEqual(cli.output.accumulator.join(''), '> 3\n> '); cli.output.accumulator.length = 0; cli.input.emit('data', ` let y = 3 `.trim() + '\n'); assert.ok(/SyntaxError: Block-scoped/.test( cli.output.accumulator.join(''))); } function testStrictMode() { const cli = initRepl(repl.REPL_MODE_STRICT); cli.input.emit('data', ` x = 3 `.trim() + '\n'); assert.ok(/ReferenceError: x is not defined/.test( cli.output.accumulator.join(''))); cli.output.accumulator.length = 0; cli.input.emit('data', ` let y = 3 `.trim() + '\n'); assert.strictEqual(cli.output.accumulator.join(''), 'undefined\n> '); } function testAutoMode() { const cli = initRepl(repl.REPL_MODE_MAGIC); cli.input.emit('data', ` x = 3 `.trim() + '\n'); assert.strictEqual(cli.output.accumulator.join(''), '> 3\n> '); cli.output.accumulator.length = 0; cli.input.emit('data', ` let y = 3 `.trim() + '\n'); assert.strictEqual(cli.output.accumulator.join(''), 'undefined\n> '); } function initRepl(mode) { const input = new Stream(); input.write = input.pause = input.resume = function() {}; input.readable = true; const output = new Stream(); output.write = output.pause = output.resume = function(buf) { output.accumulator.push(buf); }; output.accumulator = []; output.writable = true; return repl.start({ input: input, output: output, useColors: false, terminal: false, replMode: mode }); } node-v4.8.2/test/parallel/test-repl-options.js000644 000766 000024 00000004071 13070706737 021505 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const repl = require('repl'); common.globalCheck = false; // Create a dummy stream that does nothing const stream = new common.ArrayStream(); // 1, mostly defaults var r1 = repl.start({ input: stream, output: stream, terminal: true }); assert.equal(r1.input, stream); assert.equal(r1.output, stream); assert.equal(r1.input, r1.inputStream); assert.equal(r1.output, r1.outputStream); assert.equal(r1.terminal, true); assert.equal(r1.useColors, r1.terminal); assert.equal(r1.useGlobal, false); assert.equal(r1.ignoreUndefined, false); assert.equal(r1.replMode, repl.REPL_MODE_SLOPPY); assert.equal(r1.historySize, 30); // test r1 for backwards compact assert.equal(r1.rli.input, stream); assert.equal(r1.rli.output, stream); assert.equal(r1.rli.input, r1.inputStream); assert.equal(r1.rli.output, r1.outputStream); assert.equal(r1.rli.terminal, true); assert.equal(r1.useColors, r1.rli.terminal); // 2 function writer() {} function evaler() {} var r2 = repl.start({ input: stream, output: stream, terminal: false, useColors: true, useGlobal: true, ignoreUndefined: true, eval: evaler, writer: writer, replMode: repl.REPL_MODE_STRICT }); assert.equal(r2.input, stream); assert.equal(r2.output, stream); assert.equal(r2.input, r2.inputStream); assert.equal(r2.output, r2.outputStream); assert.equal(r2.terminal, false); assert.equal(r2.useColors, true); assert.equal(r2.useGlobal, true); assert.equal(r2.ignoreUndefined, true); assert.equal(r2.writer, writer); assert.equal(r2.replMode, repl.REPL_MODE_STRICT); // test r2 for backwards compact assert.equal(r2.rli.input, stream); assert.equal(r2.rli.output, stream); assert.equal(r2.rli.input, r2.inputStream); assert.equal(r2.rli.output, r2.outputStream); assert.equal(r2.rli.terminal, false); // testing out "magic" replMode var r3 = repl.start({ input: stream, output: stream, writer: writer, replMode: repl.REPL_MODE_MAGIC, historySize: 50 }); assert.equal(r3.replMode, repl.REPL_MODE_MAGIC); assert.equal(r3.historySize, 50); node-v4.8.2/test/parallel/test-repl-persistent-history.js000644 000766 000024 00000021207 13070706737 023711 0ustar00iojsstaff000000 000000 'use strict'; // Flags: --expose-internals const common = require('../common'); const stream = require('stream'); const REPL = require('internal/repl'); const assert = require('assert'); const fs = require('fs'); const path = require('path'); const os = require('os'); common.refreshTmpDir(); // Mock os.homedir() os.homedir = function() { return common.tmpDir; }; // Create an input stream specialized for testing an array of actions class ActionStream extends stream.Stream { run(data) { const _iter = data[Symbol.iterator](); const doAction = () => { const next = _iter.next(); if (next.done) { // Close the repl. Note that it must have a clean prompt to do so. setImmediate(() => { this.emit('keypress', '', { ctrl: true, name: 'd' }); }); return; } const action = next.value; if (typeof action === 'object') { this.emit('keypress', '', action); } else { this.emit('data', action + '\n'); } setImmediate(doAction); }; setImmediate(doAction); } resume() {} pause() {} } ActionStream.prototype.readable = true; // Mock keys const UP = { name: 'up' }; const ENTER = { name: 'enter' }; const CLEAR = { ctrl: true, name: 'u' }; // Common message bits const prompt = '> '; const replDisabled = '\nPersistent history support disabled. Set the ' + 'NODE_REPL_HISTORY environment\nvariable to a valid, ' + 'user-writable path to enable.\n'; const convertMsg = '\nConverting old JSON repl history to line-separated ' + 'history.\nThe new repl history file can be found at ' + path.join(common.tmpDir, '.node_repl_history') + '.\n'; const homedirErr = '\nError: Could not get the home directory.\n' + 'REPL session history will not be persisted.\n'; const replFailedRead = '\nError: Could not open history file.\n' + 'REPL session history will not be persisted.\n'; const sameHistoryFilePaths = '\nThe old repl history file has the same name ' + 'and location as the new one i.e., ' + path.join(common.tmpDir, '.node_repl_history') + ' and is empty.\nUsing it as is.\n'; // File paths const fixtures = common.fixturesDir; const historyFixturePath = path.join(fixtures, '.node_repl_history'); const historyPath = path.join(common.tmpDir, '.fixture_copy_repl_history'); const historyPathFail = path.join(common.tmpDir, '.node_repl\u0000_history'); const oldHistoryPath = path.join(fixtures, 'old-repl-history-file.json'); const enoentHistoryPath = path.join(fixtures, 'enoent-repl-history-file.json'); const emptyHistoryPath = path.join(fixtures, '.empty-repl-history-file'); const defaultHistoryPath = path.join(common.tmpDir, '.node_repl_history'); const tests = [ { env: { NODE_REPL_HISTORY: '' }, test: [UP], expected: [prompt, replDisabled, prompt] }, { env: { NODE_REPL_HISTORY: ' ' }, test: [UP], expected: [prompt, replDisabled, prompt] }, { env: { NODE_REPL_HISTORY: '', NODE_REPL_HISTORY_FILE: enoentHistoryPath }, test: [UP], expected: [prompt, replDisabled, prompt] }, { env: { NODE_REPL_HISTORY: '', NODE_REPL_HISTORY_FILE: oldHistoryPath }, test: [UP], expected: [prompt, replDisabled, prompt] }, { env: { NODE_REPL_HISTORY_FILE: emptyHistoryPath }, test: [UP], expected: [prompt, convertMsg, prompt] }, { env: { NODE_REPL_HISTORY_FILE: defaultHistoryPath }, test: [UP], expected: [prompt, sameHistoryFilePaths, prompt] }, { env: { NODE_REPL_HISTORY: historyPath }, test: [UP, CLEAR], expected: [prompt, prompt + '\'you look fabulous today\'', prompt] }, { env: { NODE_REPL_HISTORY: historyPath, NODE_REPL_HISTORY_FILE: oldHistoryPath }, test: [UP, CLEAR], expected: [prompt, prompt + '\'you look fabulous today\'', prompt] }, { env: { NODE_REPL_HISTORY: historyPath, NODE_REPL_HISTORY_FILE: '' }, test: [UP, CLEAR], expected: [prompt, prompt + '\'you look fabulous today\'', prompt] }, { env: {}, test: [UP], expected: [prompt] }, { env: { NODE_REPL_HISTORY_FILE: oldHistoryPath }, test: [UP, CLEAR, '\'42\'', ENTER], expected: [prompt, convertMsg, prompt, prompt + '\'=^.^=\'', prompt, '\'', '4', '2', '\'', '\'42\'\n', prompt, prompt], after: function ensureHistoryFixture() { // XXX(Fishrock123) Make sure nothing weird happened to our fixture // or it's temporary copy. // Sometimes this test used to erase the fixture and I'm not sure why. const history = fs.readFileSync(historyFixturePath, 'utf8'); assert.strictEqual(history, '\'you look fabulous today\'\n\'Stay Fresh~\'\n'); const historyCopy = fs.readFileSync(historyPath, 'utf8'); assert.strictEqual(historyCopy, '\'you look fabulous today\'' + os.EOL + '\'Stay Fresh~\'' + os.EOL); } }, { // Requires the above testcase env: {}, test: [UP, UP, ENTER], expected: [prompt, prompt + '\'42\'', prompt + '\'=^.^=\'', '\'=^.^=\'\n', prompt] }, { env: { NODE_REPL_HISTORY: historyPath, NODE_REPL_HISTORY_SIZE: 1 }, test: [UP, UP, CLEAR], expected: [prompt, prompt + '\'you look fabulous today\'', prompt] }, { env: { NODE_REPL_HISTORY_FILE: oldHistoryPath, NODE_REPL_HISTORY_SIZE: 1 }, test: [UP, UP, UP, CLEAR], expected: [prompt, convertMsg, prompt, prompt + '\'=^.^=\'', prompt] }, { env: { NODE_REPL_HISTORY: historyPathFail, NODE_REPL_HISTORY_SIZE: 1 }, test: [UP], expected: [prompt, replFailedRead, prompt, replDisabled, prompt] }, { // Make sure this is always the last test, since we change os.homedir() before: function before() { // Mock os.homedir() failure os.homedir = function() { throw new Error('os.homedir() failure'); }; }, env: {}, test: [UP], expected: [prompt, homedirErr, prompt, replDisabled, prompt] } ]; const numtests = tests.length; var testsNotRan = tests.length; process.on('beforeExit', () => assert.strictEqual(testsNotRan, 0) ); function cleanupTmpFile() { try { // Write over the file, clearing any history fs.writeFileSync(defaultHistoryPath, ''); } catch (err) { if (err.code === 'ENOENT') return true; throw err; } return true; } // Copy our fixture to the tmp directory fs.createReadStream(historyFixturePath) .pipe(fs.createWriteStream(historyPath)).on('unpipe', () => runTest()); function runTest(assertCleaned) { const opts = tests.shift(); if (!opts) return; // All done if (assertCleaned) { try { assert.strictEqual(fs.readFileSync(defaultHistoryPath, 'utf8'), ''); } catch (e) { if (e.code !== 'ENOENT') { console.error(`Failed test # ${numtests - tests.length}`); throw e; } } } const env = opts.env; const test = opts.test; const expected = opts.expected; const after = opts.after; const before = opts.before; if (before) before(); REPL.createInternalRepl(env, { input: new ActionStream(), output: new stream.Writable({ write(chunk, _, next) { const output = chunk.toString(); // Ignore escapes and blank lines if (output.charCodeAt(0) === 27 || /^[\r\n]+$/.test(output)) return next(); try { assert.strictEqual(output, expected.shift()); } catch (err) { console.error(`Failed test # ${numtests - tests.length}`); throw err; } next(); } }), prompt: prompt, useColors: false, terminal: true }, function(err, repl) { if (err) { console.error(`Failed test # ${numtests - tests.length}`); throw err; } // The REPL registers 'module' and 'require' globals. // This test also registers '_'. common.allowGlobals(repl.context.module, repl.context.require, repl.context._); repl.once('close', () => { if (repl._flushing) { repl.once('flushHistory', onClose); return; } onClose(); }); function onClose() { const cleaned = after ? after() : cleanupTmpFile(); try { // Ensure everything that we expected was output assert.strictEqual(expected.length, 0); testsNotRan--; setImmediate(runTest, cleaned); } catch (err) { console.error(`Failed test # ${numtests - tests.length}`); throw err; } } repl.inputStream.run(test); }); } node-v4.8.2/test/parallel/test-repl-require-cache.js000644 000766 000024 00000000461 13070706737 022526 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const repl = require('repl'); // https://github.com/joyent/node/issues/3226 require.cache.something = 1; assert.equal(require.cache.something, 1); repl.start({ useGlobal: false }).close(); assert.equal(require.cache.something, 1); node-v4.8.2/test/parallel/test-repl-require.js000644 000766 000024 00000001530 13070706737 021463 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const net = require('net'); process.chdir(common.fixturesDir); const repl = require('repl'); const server = net.createServer((conn) => { repl.start('', conn).on('exit', () => { conn.destroy(); server.close(); }); }); const host = common.localhostIPv4; const port = 0; const options = { host, port }; var answer = ''; server.listen(options, function() { options.port = this.address().port; const conn = net.connect(options); conn.setEncoding('utf8'); conn.on('data', (data) => answer += data); conn.write('require("baz")\n.exit\n'); }); process.on('exit', function() { assert.strictEqual(false, /Cannot find module/.test(answer)); assert.strictEqual(false, /Error/.test(answer)); assert.strictEqual(true, /eye catcher/.test(answer)); }); node-v4.8.2/test/parallel/test-repl-reset-event.js000644 000766 000024 00000002217 13070706737 022253 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); common.globalCheck = false; const assert = require('assert'); const repl = require('repl'); // Create a dummy stream that does nothing const dummy = new common.ArrayStream(); function testReset(cb) { const r = repl.start({ input: dummy, output: dummy, useGlobal: false }); r.context.foo = 42; r.on('reset', common.mustCall(function(context) { assert(!!context, 'REPL did not emit a context with reset event'); assert.strictEqual(context, r.context, 'REPL emitted incorrect context'); assert.strictEqual( context.foo, undefined, 'REPL emitted the previous context, and is not using global as context' ); context.foo = 42; cb(); })); r.resetContext(); } function testResetGlobal() { const r = repl.start({ input: dummy, output: dummy, useGlobal: true }); r.context.foo = 42; r.on('reset', common.mustCall(function(context) { assert.strictEqual( context.foo, 42, '"foo" property is missing from REPL using global as context' ); })); r.resetContext(); } testReset(common.mustCall(testResetGlobal)); node-v4.8.2/test/parallel/test-repl-setprompt.js000644 000766 000024 00000001166 13070706737 022051 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const spawn = require('child_process').spawn; const os = require('os'); var args = [ '-e', 'var e = new (require("repl")).REPLServer("foo.. "); e.context.e = e;', ]; var p = 'bar.. '; var child = spawn(process.execPath, args); child.stdout.setEncoding('utf8'); var data = ''; child.stdout.on('data', function(d) { data += d; }); child.stdin.end(`e.setPrompt("${p}");${os.EOL}`); child.on('close', function(code, signal) { assert.strictEqual(code, 0); assert.ok(!signal); var lines = data.split(/\n/); assert.strictEqual(lines.pop(), p); }); node-v4.8.2/test/parallel/test-repl-syntax-error-handling.js000644 000766 000024 00000002100 13070706737 024240 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); switch (process.argv[2]) { case 'child': return child(); case undefined: return parent(); default: throw new Error('wtf'); } function parent() { var spawn = require('child_process').spawn; var child = spawn(process.execPath, [__filename, 'child']); child.stderr.setEncoding('utf8'); child.stderr.on('data', function(c) { console.error('%j', c); throw new Error('should not get stderr data'); }); child.stdout.setEncoding('utf8'); var out = ''; child.stdout.on('data', function(c) { out += c; }); child.stdout.on('end', function() { assert.equal(out, '10\n'); console.log('ok - got expected output'); }); child.on('exit', function(c) { assert(!c); console.log('ok - exit success'); }); } function child() { var vm = require('vm'); try { vm.runInThisContext('haf!@##&$!@$*!@', { displayErrors: false }); } catch (er) { var caught = true; } assert(caught); vm.runInThisContext('console.log(10)', { displayErrors: false }); } node-v4.8.2/test/parallel/test-repl-syntax-error-stack.js000644 000766 000024 00000001124 13070706737 023566 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const path = require('path'); const repl = require('repl'); let found = false; process.on('exit', () => { assert.strictEqual(found, true); }); common.ArrayStream.prototype.write = function(output) { if (/var foo bar;/.test(output)) found = true; }; const putIn = new common.ArrayStream(); repl.start('', putIn); let file = path.join(common.fixturesDir, 'syntax', 'bad_syntax'); if (common.isWindows) file = file.replace(/\\/g, '\\\\'); putIn.run(['.clear']); putIn.run([`require('${file}');`]); node-v4.8.2/test/parallel/test-repl-tab-complete-crash.js000644 000766 000024 00000001234 13070706737 023462 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const repl = require('repl'); var referenceErrorCount = 0; common.ArrayStream.prototype.write = function(msg) { if (msg.startsWith('ReferenceError: ')) { referenceErrorCount++; } }; const putIn = new common.ArrayStream(); const testMe = repl.start('', putIn); // https://github.com/nodejs/node/issues/3346 // Tab-completion for an undefined variable inside a function should report a // ReferenceError. putIn.run(['.clear']); putIn.run(['function () {']); testMe.complete('arguments.'); process.on('exit', function() { assert.strictEqual(referenceErrorCount, 1); }); node-v4.8.2/test/parallel/test-repl-tab-complete.js000644 000766 000024 00000017220 13070706737 022366 0ustar00iojsstaff000000 000000 'use strict'; // Flags: --harmony-proxies var common = require('../common'); var assert = require('assert'); var repl = require('repl'); var referenceErrors = 0; var expectedReferenceErrors = 0; function getDoNotCallFunction() { expectedReferenceErrors += 1; return function() { assert(false); }; } process.on('exit', function() { assert.strictEqual(referenceErrors, expectedReferenceErrors); }); var works = [['inner.one'], 'inner.o']; const putIn = new common.ArrayStream(); var testMe = repl.start('', putIn); // Some errors are passed to the domain, but do not callback testMe._domain.on('error', function(err) { // Errors come from another context, so instanceof doesn't work var str = err.toString(); if (/^ReferenceError:/.test(str)) referenceErrors++; else assert(false); }); // Tab Complete will not break in an object literal putIn.run(['.clear']); putIn.run([ 'var inner = {', 'one:1' ]); testMe.complete('inner.o', getDoNotCallFunction()); testMe.complete('console.lo', common.mustCall(function(error, data) { assert.deepEqual(data, [['console.log'], 'console.lo']); })); // Tab Complete will return globaly scoped variables putIn.run(['};']); testMe.complete('inner.o', common.mustCall(function(error, data) { assert.deepEqual(data, works); })); putIn.run(['.clear']); // Tab Complete will not break in an ternary operator with () putIn.run([ 'var inner = ( true ', '?', '{one: 1} : ' ]); testMe.complete('inner.o', getDoNotCallFunction()); putIn.run(['.clear']); // Tab Complete will return a simple local variable putIn.run([ 'var top = function() {', 'var inner = {one:1};' ]); testMe.complete('inner.o', common.mustCall(function(error, data) { assert.deepEqual(data, works); })); // When you close the function scope tab complete will not return the // locally scoped variable putIn.run(['};']); testMe.complete('inner.o', getDoNotCallFunction()); putIn.run(['.clear']); // Tab Complete will return a complex local variable putIn.run([ 'var top = function() {', 'var inner = {', ' one:1', '};' ]); testMe.complete('inner.o', common.mustCall(function(error, data) { assert.deepEqual(data, works); })); putIn.run(['.clear']); // Tab Complete will return a complex local variable even if the function // has parameters putIn.run([ 'var top = function(one, two) {', 'var inner = {', ' one:1', '};' ]); testMe.complete('inner.o', common.mustCall(function(error, data) { assert.deepEqual(data, works); })); putIn.run(['.clear']); // Tab Complete will return a complex local variable even if the // scope is nested inside an immediately executed function putIn.run([ 'var top = function() {', '(function test () {', 'var inner = {', ' one:1', '};' ]); testMe.complete('inner.o', common.mustCall(function(error, data) { assert.deepEqual(data, works); })); putIn.run(['.clear']); // def has the params and { on a separate line putIn.run([ 'var top = function() {', 'r = function test (', ' one, two) {', 'var inner = {', ' one:1', '};' ]); testMe.complete('inner.o', getDoNotCallFunction()); putIn.run(['.clear']); // currently does not work, but should not break, not the { putIn.run([ 'var top = function() {', 'r = function test ()', '{', 'var inner = {', ' one:1', '};' ]); testMe.complete('inner.o', getDoNotCallFunction()); putIn.run(['.clear']); // currently does not work, but should not break putIn.run([ 'var top = function() {', 'r = function test (', ')', '{', 'var inner = {', ' one:1', '};' ]); testMe.complete('inner.o', getDoNotCallFunction()); putIn.run(['.clear']); // make sure tab completion works on non-Objects putIn.run([ 'var str = "test";' ]); testMe.complete('str.len', common.mustCall(function(error, data) { assert.deepEqual(data, [['str.length'], 'str.len']); })); putIn.run(['.clear']); // tab completion should not break on spaces var spaceTimeout = setTimeout(function() { throw new Error('timeout'); }, 1000); testMe.complete(' ', common.mustCall(function(error, data) { assert.deepEqual(data, [[], undefined]); clearTimeout(spaceTimeout); })); // tab completion should pick up the global "toString" object, and // any other properties up the "global" object's prototype chain testMe.complete('toSt', common.mustCall(function(error, data) { assert.deepEqual(data, [['toString'], 'toSt']); })); // Tab complete provides built in libs for require() putIn.run(['.clear']); testMe.complete('require(\'', common.mustCall(function(error, data) { assert.strictEqual(error, null); repl._builtinLibs.forEach(function(lib) { assert.notStrictEqual(data[0].indexOf(lib), -1, lib + ' not found'); }); })); testMe.complete('require(\'n', common.mustCall(function(error, data) { assert.strictEqual(error, null); assert.strictEqual(data.length, 2); assert.strictEqual(data[1], 'n'); assert.notStrictEqual(data[0].indexOf('net'), -1); // It's possible to pick up non-core modules too data[0].forEach(function(completion) { if (completion) assert(/^n/.test(completion)); }); })); // Make sure tab completion works on context properties putIn.run(['.clear']); putIn.run([ 'var custom = "test";' ]); testMe.complete('cus', common.mustCall(function(error, data) { assert.deepEqual(data, [['custom'], 'cus']); })); // Make sure tab completion doesn't crash REPL with half-baked proxy objects. // See: https://github.com/nodejs/node/issues/2119 putIn.run(['.clear']); putIn.run([ 'var proxy = Proxy.create({});' ]); testMe.complete('proxy.', common.mustCall(function(error, data) { assert.strictEqual(error, null); assert.deepEqual(data, [[], 'proxy.']); })); // Make sure tab completion does not include integer members of an Array var array_elements = [ [ 'ary.__defineGetter__', 'ary.__defineSetter__', 'ary.__lookupGetter__', 'ary.__lookupSetter__', 'ary.__proto__', 'ary.constructor', 'ary.hasOwnProperty', 'ary.isPrototypeOf', 'ary.propertyIsEnumerable', 'ary.toLocaleString', 'ary.toString', 'ary.valueOf', '', 'ary.concat', 'ary.copyWithin', 'ary.entries', 'ary.every', 'ary.fill', 'ary.filter', 'ary.find', 'ary.findIndex', 'ary.forEach', 'ary.indexOf', 'ary.join', 'ary.keys', 'ary.lastIndexOf', 'ary.length', 'ary.map', 'ary.pop', 'ary.push', 'ary.reduce', 'ary.reduceRight', 'ary.reverse', 'ary.shift', 'ary.slice', 'ary.some', 'ary.sort', 'ary.splice', 'ary.unshift' ], 'ary.']; putIn.run(['.clear']); putIn.run(['var ary = [1,2,3];']); testMe.complete('ary.', common.mustCall(function(error, data) { assert.deepEqual(data, array_elements); })); // Make sure tab completion does not include integer keys in an object var obj_elements = [ [ 'obj.__defineGetter__', 'obj.__defineSetter__', 'obj.__lookupGetter__', 'obj.__lookupSetter__', 'obj.__proto__', 'obj.constructor', 'obj.hasOwnProperty', 'obj.isPrototypeOf', 'obj.propertyIsEnumerable', 'obj.toLocaleString', 'obj.toString', 'obj.valueOf', '', 'obj.a' ], 'obj.' ]; putIn.run(['.clear']); putIn.run(['var obj = {1:"a","1a":"b",a:"b"};']); testMe.complete('obj.', common.mustCall(function(error, data) { assert.deepEqual(data, obj_elements); })); // tab completion for defined commands putIn.run(['.clear']); testMe.complete('.b', common.mustCall((error, data) => { assert.deepStrictEqual(data, [['break'], 'b']); })); const testNonGlobal = repl.start({ input: putIn, output: putIn, useGlobal: false }); const builtins = [['Infinity', '', 'Int16Array', 'Int32Array', 'Int8Array'], 'I']; if (typeof Intl === 'object') { builtins[0].push('Intl'); } testNonGlobal.complete('I', common.mustCall((error, data) => { assert.deepStrictEqual(data, builtins); })); node-v4.8.2/test/parallel/test-repl-tab.js000644 000766 000024 00000000676 13070706737 020567 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var repl = require('repl'); var zlib = require('zlib'); // just use builtin stream inherited from Duplex var putIn = zlib.createGzip(); var testMe = repl.start('', putIn, function(cmd, context, filename, callback) { callback(null, cmd); }); testMe._domain.on('error', common.fail); testMe.complete('', function(err, results) { assert.equal(err, null); }); node-v4.8.2/test/parallel/test-repl-unexpected-token-recoverable.js000644 000766 000024 00000001464 13070706737 025566 0ustar00iojsstaff000000 000000 'use strict'; /* * This is a regression test for https://github.com/joyent/node/issues/8874. */ require('../common'); var assert = require('assert'); var spawn = require('child_process').spawn; // use -i to force node into interactive mode, despite stdout not being a TTY var args = [ '-i' ]; var child = spawn(process.execPath, args); var input = 'var foo = "bar\\\nbaz"'; // Match '...' as well since it marks a multi-line statement var expectOut = /^> ... undefined\n/; child.stderr.setEncoding('utf8'); child.stderr.on('data', function(c) { throw new Error('child.stderr be silent'); }); child.stdout.setEncoding('utf8'); var out = ''; child.stdout.on('data', function(c) { out += c; }); child.stdout.on('end', function() { assert(expectOut.test(out)); console.log('ok'); }); child.stdin.end(input); node-v4.8.2/test/parallel/test-repl.js000644 000766 000024 00000043642 13070706737 020023 0ustar00iojsstaff000000 000000 /* eslint-disable max-len, strict */ const common = require('../common'); const assert = require('assert'); common.globalCheck = false; common.refreshTmpDir(); const net = require('net'); const repl = require('repl'); const message = 'Read, Eval, Print Loop'; const prompt_unix = 'node via Unix socket> '; const prompt_tcp = 'node via TCP socket> '; const prompt_multiline = '... '; const prompt_npm = 'npm should be run outside of the ' + 'node repl, in your normal shell.\n' + '(Press Control-D to exit.)\n'; const expect_npm = prompt_npm + prompt_unix; var server_tcp, server_unix, client_tcp, client_unix, replServer; // absolute path to test/fixtures/a.js const moduleFilename = require('path').join(common.fixturesDir, 'a'); console.error('repl test'); // function for REPL to run global.invoke_me = function(arg) { return 'invoked ' + arg; }; function send_expect(list) { if (list.length > 0) { const cur = list.shift(); console.error('sending ' + JSON.stringify(cur.send)); cur.client.expect = cur.expect; cur.client.list = list; if (cur.send.length > 0) { cur.client.write(cur.send + '\n'); } } } function clean_up() { client_tcp.end(); client_unix.end(); } function strict_mode_error_test() { send_expect([ { client: client_unix, send: 'ref = 1', expect: /^ReferenceError:\sref\sis\snot\sdefined\n\s+at\srepl:1:5/ }, ]); } function error_test() { // The other stuff is done so reuse unix socket var read_buffer = ''; var run_strict_test = true; client_unix.removeAllListeners('data'); client_unix.on('data', function(data) { read_buffer += data.toString('ascii', 0, data.length); console.error('Unix data: ' + JSON.stringify(read_buffer) + ', expecting ' + (client_unix.expect.exec ? client_unix.expect : JSON.stringify(client_unix.expect))); if (read_buffer.indexOf(prompt_unix) !== -1) { // if it's an exact match, then don't do the regexp if (read_buffer !== client_unix.expect) { var expect = client_unix.expect; if (expect === prompt_multiline) expect = /[.]{3} /; assert.ok(read_buffer.match(expect)); console.error('match'); } read_buffer = ''; if (client_unix.list && client_unix.list.length > 0) { send_expect(client_unix.list); } else if (run_strict_test) { replServer.replMode = repl.REPL_MODE_STRICT; run_strict_test = false; strict_mode_error_test(); } else { console.error('End of Error test, running TCP test.'); tcp_test(); } } else if (read_buffer.indexOf(prompt_multiline) !== -1) { // Check that you meant to send a multiline test assert.strictEqual(prompt_multiline, client_unix.expect); read_buffer = ''; if (client_unix.list && client_unix.list.length > 0) { send_expect(client_unix.list); } else if (run_strict_test) { replServer.replMode = repl.REPL_MODE_STRICT; run_strict_test = false; strict_mode_error_test(); } else { console.error('End of Error test, running TCP test.\n'); tcp_test(); } } else { console.error('didn\'t see prompt yet, buffering.'); } }); send_expect([ // Uncaught error throws and prints out { client: client_unix, send: 'throw new Error(\'test error\');', expect: /^Error: test error/ }, // Common syntax error is treated as multiline command { client: client_unix, send: 'function test_func() {', expect: prompt_multiline }, // You can recover with the .break command { client: client_unix, send: '.break', expect: prompt_unix }, // But passing the same string to eval() should throw { client: client_unix, send: 'eval("function test_func() {")', expect: /^SyntaxError: Unexpected end of input/ }, // Can handle multiline template literals { client: client_unix, send: '`io.js', expect: prompt_multiline }, // Special REPL commands still available { client: client_unix, send: '.break', expect: prompt_unix }, // Template expressions can cross lines { client: client_unix, send: '`io.js ${"1.0"', expect: prompt_multiline }, { client: client_unix, send: '+ ".2"}`', expect: `'io.js 1.0.2'\n${prompt_unix}` }, // Floating point numbers are not interpreted as REPL commands. { client: client_unix, send: '.1234', expect: '0.1234' }, // Floating point expressions are not interpreted as REPL commands { client: client_unix, send: '.1+.1', expect: '0.2' }, // Can parse valid JSON { client: client_unix, send: 'JSON.parse(\'{"valid": "json"}\');', expect: '{ valid: \'json\' }'}, // invalid input to JSON.parse error is special case of syntax error, // should throw { client: client_unix, send: 'JSON.parse(\'{invalid: \\\'json\\\'}\');', expect: /^SyntaxError: Unexpected token i/ }, // end of input to JSON.parse error is special case of syntax error, // should throw { client: client_unix, send: 'JSON.parse(\'066\');', expect: /^SyntaxError: Unexpected number/ }, // should throw { client: client_unix, send: 'JSON.parse(\'{\');', expect: /^SyntaxError: Unexpected end of input/ }, // invalid RegExps are a special case of syntax error, // should throw { client: client_unix, send: '/(/;', expect: /^SyntaxError: Invalid regular expression\:/ }, // invalid RegExp modifiers are a special case of syntax error, // should throw (GH-4012) { client: client_unix, send: 'new RegExp("foo", "wrong modifier");', expect: /^SyntaxError: Invalid flags supplied to RegExp constructor/ }, // strict mode syntax errors should be caught (GH-5178) { client: client_unix, send: '(function() { "use strict"; return 0755; })()', expect: /^SyntaxError: Octal literals are not allowed in strict mode/ }, { client: client_unix, send: '(function(a, a, b) { "use strict"; return a + b + c; })()', expect: /^SyntaxError: Strict mode function may not have duplicate parameter names/ }, { client: client_unix, send: '(function() { "use strict"; with (this) {} })()', expect: /^SyntaxError: Strict mode code may not include a with statement/ }, { client: client_unix, send: '(function() { "use strict"; var x; delete x; })()', expect: /^SyntaxError: Delete of an unqualified identifier in strict mode/ }, { client: client_unix, send: '(function() { "use strict"; eval = 17; })()', expect: /^SyntaxError: Unexpected eval or arguments in strict mode/ }, { client: client_unix, send: '(function() { "use strict"; if (true) function f() { } })()', expect: /^SyntaxError: In strict mode code, functions can only be declared at top level or immediately within another function/ }, // Named functions can be used: { client: client_unix, send: 'function blah() { return 1; }', expect: prompt_unix }, { client: client_unix, send: 'blah()', expect: '1\n' + prompt_unix }, // Functions should not evaluate twice (#2773) { client: client_unix, send: 'var I = [1,2,3,function() {}]; I.pop()', expect: '[Function]' }, // Multiline object { client: client_unix, send: '{ a: ', expect: prompt_multiline }, { client: client_unix, send: '1 }', expect: '{ a: 1 }' }, // Multiline anonymous function with comment { client: client_unix, send: '(function() {', expect: prompt_multiline }, { client: client_unix, send: '// blah', expect: prompt_multiline }, { client: client_unix, send: 'return 1;', expect: prompt_multiline }, { client: client_unix, send: '})()', expect: '1' }, // npm prompt error message { client: client_unix, send: 'npm install foobar', expect: expect_npm }, { client: client_unix, send: '(function() {\n\nreturn 1;\n})()', expect: '1' }, { client: client_unix, send: '{\n\na: 1\n}', expect: '{ a: 1 }' }, { client: client_unix, send: 'url.format("http://google.com")', expect: 'http://google.com/' }, { client: client_unix, send: 'var path = 42; path', expect: '42' }, // this makes sure that we don't print `undefined` when we actually print // the error message { client: client_unix, send: '.invalid_repl_command', expect: 'Invalid REPL keyword\n' + prompt_unix }, // this makes sure that we don't crash when we use an inherited property as // a REPL command { client: client_unix, send: '.toString', expect: 'Invalid REPL keyword\n' + prompt_unix }, // fail when we are not inside a String and a line continuation is used { client: client_unix, send: '[] \\', expect: /^SyntaxError: Unexpected token ILLEGAL/ }, // do not fail when a String is created with line continuation { client: client_unix, send: '\'the\\\nfourth\\\neye\'', expect: prompt_multiline + prompt_multiline + '\'thefourtheye\'\n' + prompt_unix }, // Don't fail when a partial String is created and line continuation is used // with whitespace characters at the end of the string. We are to ignore it. // This test is to make sure that we properly remove the whitespace // characters at the end of line, unlike the buggy `trimWhitespace` function { client: client_unix, send: ' \t .break \t ', expect: prompt_unix }, // multiline strings preserve whitespace characters in them { client: client_unix, send: '\'the \\\n fourth\t\t\\\n eye \'', expect: prompt_multiline + prompt_multiline + '\'the fourth\\t\\t eye \'\n' + prompt_unix }, // more than one multiline strings also should preserve whitespace chars { client: client_unix, send: '\'the \\\n fourth\' + \'\t\t\\\n eye \'', expect: prompt_multiline + prompt_multiline + '\'the fourth\\t\\t eye \'\n' + prompt_unix }, // using REPL commands within a string literal should still work { client: client_unix, send: '\'\\\n.break', expect: prompt_unix }, // using REPL command "help" within a string literal should still work { client: client_unix, send: '\'thefourth\\\n.help\neye\'', expect: /'thefourtheye'/ }, // empty lines in the REPL should be allowed { client: client_unix, send: '\n\r\n\r\n', expect: prompt_unix + prompt_unix + prompt_unix }, // empty lines in the string literals should not affect the string { client: client_unix, send: '\'the\\\n\\\nfourtheye\'\n', expect: prompt_multiline + prompt_multiline + '\'thefourtheye\'\n' + prompt_unix }, // Regression test for https://github.com/nodejs/node/issues/597 { client: client_unix, send: '/(.)(.)(.)(.)(.)(.)(.)(.)(.)/.test(\'123456789\')\n', expect: `true\n${prompt_unix}` }, // the following test's result depends on the RegEx's match from the above { client: client_unix, send: 'RegExp.$1\nRegExp.$2\nRegExp.$3\nRegExp.$4\nRegExp.$5\n' + 'RegExp.$6\nRegExp.$7\nRegExp.$8\nRegExp.$9\n', expect: ['\'1\'\n', '\'2\'\n', '\'3\'\n', '\'4\'\n', '\'5\'\n', '\'6\'\n', '\'7\'\n', '\'8\'\n', '\'9\'\n'].join(`${prompt_unix}`) }, // regression tests for https://github.com/nodejs/node/issues/2749 { client: client_unix, send: 'function x() {\nreturn \'\\n\';\n }', expect: prompt_multiline + prompt_multiline + 'undefined\n' + prompt_unix }, { client: client_unix, send: 'function x() {\nreturn \'\\\\\';\n }', expect: prompt_multiline + prompt_multiline + 'undefined\n' + prompt_unix }, // regression tests for https://github.com/nodejs/node/issues/3421 { client: client_unix, send: 'function x() {\n//\'\n }', expect: prompt_multiline + prompt_multiline + 'undefined\n' + prompt_unix }, { client: client_unix, send: 'function x() {\n//"\n }', expect: prompt_multiline + prompt_multiline + 'undefined\n' + prompt_unix }, { client: client_unix, send: 'function x() {//\'\n }', expect: prompt_multiline + 'undefined\n' + prompt_unix }, { client: client_unix, send: 'function x() {//"\n }', expect: prompt_multiline + 'undefined\n' + prompt_unix }, { client: client_unix, send: 'function x() {\nvar i = "\'";\n }', expect: prompt_multiline + prompt_multiline + 'undefined\n' + prompt_unix }, { client: client_unix, send: 'function x(/*optional*/) {}', expect: 'undefined\n' + prompt_unix }, { client: client_unix, send: 'function x(/* // 5 */) {}', expect: 'undefined\n' + prompt_unix }, { client: client_unix, send: '// /* 5 */', expect: 'undefined\n' + prompt_unix }, { client: client_unix, send: '"//"', expect: '\'//\'\n' + prompt_unix }, { client: client_unix, send: '"data /*with*/ comment"', expect: '\'data /*with*/ comment\'\n' + prompt_unix }, { client: client_unix, send: 'function x(/*fn\'s optional params*/) {}', expect: 'undefined\n' + prompt_unix }, { client: client_unix, send: '/* \'\n"\n\'"\'\n*/', expect: 'undefined\n' + prompt_unix }, // REPL should get a normal require() function, not one that allows // access to internal modules without the --expose_internals flag. { client: client_unix, send: 'require("internal/repl")', expect: /^Error: Cannot find module 'internal\/repl'/ }, // REPL should handle quotes within regexp literal in multiline mode { client: client_unix, send: "function x(s) {\nreturn s.replace(/'/,'');\n}", expect: prompt_multiline + prompt_multiline + 'undefined\n' + prompt_unix }, { client: client_unix, send: "function x(s) {\nreturn s.replace(/\'/,'');\n}", expect: prompt_multiline + prompt_multiline + 'undefined\n' + prompt_unix }, { client: client_unix, send: 'function x(s) {\nreturn s.replace(/"/,"");\n}', expect: prompt_multiline + prompt_multiline + 'undefined\n' + prompt_unix }, { client: client_unix, send: 'function x(s) {\nreturn s.replace(/.*/,"");\n}', expect: prompt_multiline + prompt_multiline + 'undefined\n' + prompt_unix }, ]); } function tcp_test() { server_tcp = net.createServer(function(socket) { assert.strictEqual(server_tcp, socket.server); socket.on('end', function() { socket.end(); }); repl.start(prompt_tcp, socket); }); server_tcp.listen(0, function() { var read_buffer = ''; client_tcp = net.createConnection(this.address().port); client_tcp.on('connect', function() { assert.strictEqual(true, client_tcp.readable); assert.strictEqual(true, client_tcp.writable); send_expect([ { client: client_tcp, send: '', expect: prompt_tcp }, { client: client_tcp, send: 'invoke_me(333)', expect: ('\'' + 'invoked 333' + '\'\n' + prompt_tcp) }, { client: client_tcp, send: 'a += 1', expect: ('12346' + '\n' + prompt_tcp) }, { client: client_tcp, send: 'require(' + JSON.stringify(moduleFilename) + ').number', expect: ('42' + '\n' + prompt_tcp) } ]); }); client_tcp.on('data', function(data) { read_buffer += data.toString('ascii', 0, data.length); console.error('TCP data: ' + JSON.stringify(read_buffer) + ', expecting ' + JSON.stringify(client_tcp.expect)); if (read_buffer.indexOf(prompt_tcp) !== -1) { assert.strictEqual(client_tcp.expect, read_buffer); console.error('match'); read_buffer = ''; if (client_tcp.list && client_tcp.list.length > 0) { send_expect(client_tcp.list); } else { console.error('End of TCP test.\n'); clean_up(); } } else { console.error('didn\'t see prompt yet, buffering'); } }); client_tcp.on('error', function(e) { throw e; }); client_tcp.on('close', function() { server_tcp.close(); }); }); } function unix_test() { server_unix = net.createServer(function(socket) { assert.strictEqual(server_unix, socket.server); socket.on('end', function() { socket.end(); }); replServer = repl.start({ prompt: prompt_unix, input: socket, output: socket, useGlobal: true }); replServer.context.message = message; }); server_unix.on('listening', function() { var read_buffer = ''; client_unix = net.createConnection(common.PIPE); client_unix.on('connect', function() { assert.strictEqual(true, client_unix.readable); assert.strictEqual(true, client_unix.writable); send_expect([ { client: client_unix, send: '', expect: prompt_unix }, { client: client_unix, send: 'message', expect: ('\'' + message + '\'\n' + prompt_unix) }, { client: client_unix, send: 'invoke_me(987)', expect: ('\'' + 'invoked 987' + '\'\n' + prompt_unix) }, { client: client_unix, send: 'a = 12345', expect: ('12345' + '\n' + prompt_unix) }, { client: client_unix, send: '{a:1}', expect: ('{ a: 1 }' + '\n' + prompt_unix) } ]); }); client_unix.on('data', function(data) { read_buffer += data.toString('ascii', 0, data.length); console.error('Unix data: ' + JSON.stringify(read_buffer) + ', expecting ' + JSON.stringify(client_unix.expect)); if (read_buffer.indexOf(prompt_unix) !== -1) { assert.strictEqual(client_unix.expect, read_buffer); console.error('match'); read_buffer = ''; if (client_unix.list && client_unix.list.length > 0) { send_expect(client_unix.list); } else { console.error('End of Unix test, running Error test.\n'); process.nextTick(error_test); } } else { console.error('didn\'t see prompt yet, buffering.'); } }); client_unix.on('error', function(e) { throw e; }); client_unix.on('close', function() { server_unix.close(); }); }); server_unix.listen(common.PIPE); } unix_test(); node-v4.8.2/test/parallel/test-require-cache.js000644 000766 000024 00000001056 13070706737 021567 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); (function testInjectFakeModule() { var relativePath = '../fixtures/semicolon'; var absolutePath = require.resolve(relativePath); var fakeModule = {}; require.cache[absolutePath] = {exports: fakeModule}; assert.strictEqual(require(relativePath), fakeModule); })(); (function testInjectFakeNativeModule() { var relativePath = 'fs'; var fakeModule = {}; require.cache[relativePath] = {exports: fakeModule}; assert.strictEqual(require(relativePath), fakeModule); })(); node-v4.8.2/test/parallel/test-require-dot.js000644 000766 000024 00000001071 13070706737 021307 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const m = require('module'); const a = require(common.fixturesDir + '/module-require/relative/dot.js'); const b = require(common.fixturesDir + '/module-require/relative/dot-slash.js'); assert.strictEqual(a.value, 42); assert.strictEqual(a, b, 'require(".") should resolve like require("./")'); process.env.NODE_PATH = common.fixturesDir + '/module-require/relative'; m._initPaths(); const c = require('.'); assert.strictEqual(c.value, 42, 'require(".") should honor NODE_PATH'); node-v4.8.2/test/parallel/test-require-exceptions.js000644 000766 000024 00000001210 13070706737 022675 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); // A module with an error in it should throw assert.throws(function() { require(common.fixturesDir + '/throws_error'); }, /^Error: blah$/); // Requiring the same module again should throw as well assert.throws(function() { require(common.fixturesDir + '/throws_error'); }, /^Error: blah$/); // Requiring a module that does not exist should throw an // error with its `code` set to MODULE_NOT_FOUND assert.throws(function() { require(common.fixturesDir + '/DOES_NOT_EXIST'); }, function(e) { assert.equal('MODULE_NOT_FOUND', e.code); return true; }); node-v4.8.2/test/parallel/test-require-extensions-main.js000644 000766 000024 00000000444 13070706737 023645 0ustar00iojsstaff000000 000000 'use strict'; const assert = require('assert'); const common = require('../common'); const fixturesRequire = require(`${common.fixturesDir}/require-bin/bin/req.js`); assert.strictEqual( fixturesRequire, '', 'test-require-extensions-main failed to import fixture requirements' ); node-v4.8.2/test/parallel/test-require-extensions-same-filename-as-dir-trailing-slash.js000644 000766 000024 00000000517 13070706737 031521 0ustar00iojsstaff000000 000000 /* eslint-disable max-len */ 'use strict'; var common = require('../common'); var assert = require('assert'); var content = require(common.fixturesDir + '/json-with-directory-name-module/module-stub/one-trailing-slash/two/three.js'); assert.notEqual(content.rocko, 'artischocko'); assert.equal(content, 'hello from module-stub!'); node-v4.8.2/test/parallel/test-require-extensions-same-filename-as-dir.js000644 000766 000024 00000000465 13070706737 026604 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const content = require(common.fixturesDir + '/json-with-directory-name-module/module-stub/one/two/three.js'); assert.notStrictEqual(content.rocko, 'artischocko'); assert.strictEqual(content, 'hello from module-stub!'); node-v4.8.2/test/parallel/test-require-invalid-package.js000644 000766 000024 00000000333 13070706737 023540 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); // Should be an invalid package path. assert.throws(() => require('package.json'), (err) => { return err && err.code === 'MODULE_NOT_FOUND'; }); node-v4.8.2/test/parallel/test-require-json.js000644 000766 000024 00000000551 13070706737 021474 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var path = require('path'); var assert = require('assert'); try { require(path.join(common.fixturesDir, 'invalid.json')); } catch (err) { var re = /test[\/\\]fixtures[\/\\]invalid.json: Unexpected string/; var i = err.message.match(re); assert(null !== i, 'require() json error should include path'); } node-v4.8.2/test/parallel/test-require-long-path.js000644 000766 000024 00000001326 13070706737 022415 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const fs = require('fs'); const path = require('path'); if (!common.isWindows) { common.skip('this test is Windows-specific.'); return; } // make a path that is more than 260 chars long. const dirNameLen = Math.max(260 - common.tmpDir.length, 1); const dirName = path.join(common.tmpDir, 'x'.repeat(dirNameLen)); const fullDirPath = path.resolve(dirName); const indexFile = path.join(fullDirPath, 'index.js'); const otherFile = path.join(fullDirPath, 'other.js'); common.refreshTmpDir(); fs.mkdirSync(fullDirPath); fs.writeFileSync(indexFile, 'require("./other");'); fs.writeFileSync(otherFile, ''); require(indexFile); require(otherFile); common.refreshTmpDir(); node-v4.8.2/test/parallel/test-require-process.js000644 000766 000024 00000000351 13070706737 022177 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var nativeProcess = require('process'); assert.strictEqual(nativeProcess, process, 'require("process") should return global process reference'); node-v4.8.2/test/parallel/test-require-resolve.js000644 000766 000024 00000001226 13070706737 022202 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const fixturesDir = common.fixturesDir; const assert = require('assert'); const path = require('path'); assert.strictEqual( path.join(__dirname, '../fixtures/a.js').toLowerCase(), require.resolve('../fixtures/a').toLowerCase()); assert.strictEqual( path.join(fixturesDir, 'a.js').toLowerCase(), require.resolve(path.join(fixturesDir, 'a')).toLowerCase()); assert.strictEqual( path.join(fixturesDir, 'nested-index', 'one', 'index.js').toLowerCase(), require.resolve('../fixtures/nested-index/one').toLowerCase()); assert.strictEqual('path', require.resolve('path')); console.log('ok'); node-v4.8.2/test/parallel/test-require-unicode.js000644 000766 000024 00000001046 13070706737 022151 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const fs = require('fs'); const path = require('path'); common.refreshTmpDir(); const dirname = path.join(common.tmpDir, '\u4e2d\u6587\u76ee\u5f55'); fs.mkdirSync(dirname); fs.writeFileSync(path.join(dirname, 'file.js'), 'module.exports = 42;'); fs.writeFileSync(path.join(dirname, 'package.json'), JSON.stringify({ name: 'test', main: 'file.js' })); assert.equal(require(dirname), 42); assert.equal(require(path.join(dirname, 'file.js')), 42); node-v4.8.2/test/parallel/test-setproctitle.js000644 000766 000024 00000002127 13070706737 021573 0ustar00iojsstaff000000 000000 'use strict'; // Original test written by Jakub Lekstan const common = require('../common'); // FIXME add sunos support if ('linux freebsd darwin'.indexOf(process.platform) === -1) { common.skip(`Unsupported platform [${process.platform}]`); return; } const assert = require('assert'); const exec = require('child_process').exec; const path = require('path'); // The title shouldn't be too long; libuv's uv_set_process_title() out of // security considerations no longer overwrites envp, only argv, so the // maximum title length is possibly quite short. let title = 'testme'; assert.notStrictEqual(process.title, title); process.title = title; assert.strictEqual(process.title, title); exec(`ps -p ${process.pid} -o args=`, function callback(error, stdout, stderr) { assert.ifError(error); assert.strictEqual(stderr, ''); // freebsd always add ' (procname)' to the process title if (process.platform === 'freebsd') title += ` (${path.basename(process.execPath)})`; // omitting trailing whitespace and \n assert.strictEqual(stdout.replace(/\s+$/, ''), title); }); node-v4.8.2/test/parallel/test-sigint-infinite-loop.js000644 000766 000024 00000001660 13070706737 023122 0ustar00iojsstaff000000 000000 'use strict'; // This test is to assert that we can SIGINT a script which loops forever. // Ref(http): // groups.google.com/group/nodejs-dev/browse_thread/thread/e20f2f8df0296d3f const common = require('../common'); var assert = require('assert'); var spawn = require('child_process').spawn; console.log('start'); var c = spawn(process.execPath, ['-e', 'while(true) { console.log("hi"); }']); var sentKill = false; c.stdout.on('data', function(s) { // Prevent race condition: // Wait for the first bit of output from the child process // so that we're sure that it's in the V8 event loop and not // just in the startup phase of execution. if (!sentKill) { c.kill('SIGINT'); console.log('SIGINT infinite-loop.js'); sentKill = true; } }); c.on('exit', common.mustCall(function(code) { assert.ok(code !== 0); console.log('killed infinite-loop.js'); })); process.on('exit', function() { assert.ok(sentKill); }); node-v4.8.2/test/parallel/test-signal-handler.js000644 000766 000024 00000001545 13070706737 021745 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); if (common.isWindows) { common.skip('SIGUSR1 and SIGHUP signals are not supported'); return; } console.log('process.pid: ' + process.pid); process.on('SIGUSR1', common.mustCall(function() {})); process.on('SIGUSR1', common.mustCall(function() { setTimeout(function() { console.log('End.'); process.exit(0); }, 5); })); var i = 0; setInterval(function() { console.log('running process...' + ++i); if (i === 5) { process.kill(process.pid, 'SIGUSR1'); } }, 1); // Test on condition where a watcher for SIGNAL // has been previously registered, and `process.listeners(SIGNAL).length === 1` process.on('SIGHUP', function() { common.fail('should not run'); }); process.removeAllListeners('SIGHUP'); process.on('SIGHUP', common.mustCall(function() {})); process.kill(process.pid, 'SIGHUP'); node-v4.8.2/test/parallel/test-signal-safety.js000644 000766 000024 00000000470 13070706737 021617 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var Signal = process.binding('signal_wrap').Signal; // Test Signal `this` safety // https://github.com/joyent/node/issues/6690 assert.throws(function() { var s = new Signal(); var nots = { start: s.start }; nots.start(9); }, TypeError); node-v4.8.2/test/parallel/test-signal-unregister.js000644 000766 000024 00000000660 13070706737 022514 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const spawn = require('child_process').spawn; const child = spawn(process.argv[0], [common.fixturesDir + '/should_exit.js']); child.stdout.once('data', function() { child.kill('SIGINT'); }); child.on('exit', common.mustCall(function(exitCode, signalCode) { assert.strictEqual(exitCode, null); assert.strictEqual(signalCode, 'SIGINT'); })); node-v4.8.2/test/parallel/test-socket-write-after-fin-error.js000644 000766 000024 00000003043 13070706737 024470 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); // This is similar to simple/test-socket-write-after-fin, except that // we don't set allowHalfOpen. Then we write after the client has sent // a FIN, and this is an error. However, the standard "write after end" // message is too vague, and doesn't actually tell you what happens. var net = require('net'); var serverData = ''; var gotServerEnd = false; var clientData = ''; var gotClientEnd = false; var gotServerError = false; var server = net.createServer(function(sock) { sock.setEncoding('utf8'); sock.on('error', function(er) { console.error(er.code + ': ' + er.message); gotServerError = er; }); sock.on('data', function(c) { serverData += c; }); sock.on('end', function() { gotServerEnd = true; sock.write(serverData); sock.end(); }); server.close(); }); server.listen(0, function() { var sock = net.connect(this.address().port); sock.setEncoding('utf8'); sock.on('data', function(c) { clientData += c; }); sock.on('end', function() { gotClientEnd = true; }); process.on('exit', function() { assert.equal(clientData, ''); assert.equal(serverData, 'hello1hello2hello3\nTHUNDERMUSCLE!'); assert(gotClientEnd); assert(gotServerEnd); assert(gotServerError); assert.equal(gotServerError.code, 'EPIPE'); assert.notEqual(gotServerError.message, 'write after end'); console.log('ok'); }); sock.write('hello1'); sock.write('hello2'); sock.write('hello3\n'); sock.end('THUNDERMUSCLE!'); }); node-v4.8.2/test/parallel/test-socket-write-after-fin.js000644 000766 000024 00000001642 13070706737 023344 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var net = require('net'); const expected = 'hello1hello2hello3\nTHUNDERMUSCLE!'; var server = net.createServer({ allowHalfOpen: true }, common.mustCall(function(sock) { var serverData = ''; sock.setEncoding('utf8'); sock.on('data', function(c) { serverData += c; }); sock.on('end', common.mustCall(function() { assert.strictEqual(serverData, expected); sock.end(serverData); server.close(); })); })); server.listen(0, common.mustCall(function() { var sock = net.connect(this.address().port); var clientData = ''; sock.setEncoding('utf8'); sock.on('data', function(c) { clientData += c; }); sock.on('end', common.mustCall(function() { assert.strictEqual(clientData, expected); })); sock.write('hello1'); sock.write('hello2'); sock.write('hello3\n'); sock.end('THUNDERMUSCLE!'); })); node-v4.8.2/test/parallel/test-spawn-cmd-named-pipe.js000644 000766 000024 00000003026 13070706737 022757 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); // This test is intended for Windows only if (!common.isWindows) { common.skip('this test is Windows-specific.'); return; } if (!process.argv[2]) { // parent const net = require('net'); const spawn = require('child_process').spawn; const path = require('path'); const pipeNamePrefix = path.basename(__filename) + '.' + process.pid; const stdinPipeName = '\\\\.\\pipe\\' + pipeNamePrefix + '.stdin'; const stdoutPipeName = '\\\\.\\pipe\\' + pipeNamePrefix + '.stdout'; const stdinPipeServer = net.createServer(function(c) { c.on('end', common.mustCall(function() { })); c.end('hello'); }); stdinPipeServer.listen(stdinPipeName); const output = []; const stdoutPipeServer = net.createServer(function(c) { c.on('data', function(x) { output.push(x); }); c.on('end', common.mustCall(function() { assert.strictEqual(output.join(''), 'hello'); })); }); stdoutPipeServer.listen(stdoutPipeName); const comspec = process.env['comspec']; if (!comspec || comspec.length === 0) { common.fail('Failed to get COMSPEC'); } const args = ['/c', process.execPath, __filename, 'child', '<', stdinPipeName, '>', stdoutPipeName]; const child = spawn(comspec, args); child.on('exit', common.mustCall(function(exitCode) { stdinPipeServer.close(); stdoutPipeServer.close(); assert.strictEqual(exitCode, 0); })); } else { // child process.stdin.pipe(process.stdout); } node-v4.8.2/test/parallel/test-stdin-child-proc.js000644 000766 000024 00000001002 13070706737 022204 0ustar00iojsstaff000000 000000 'use strict'; // This tests that pausing and resuming stdin does not hang and timeout // when done in a child process. See test/parallel/test-stdin-pause-resume.js const common = require('../common'); const assert = require('assert'); const child_process = require('child_process'); const path = require('path'); const cp = child_process.spawn(process.execPath, [path.resolve(__dirname, 'test-stdin-pause-resume.js')]); cp.on('exit', common.mustCall((code) => { assert.equal(code, 0); })); node-v4.8.2/test/parallel/test-stdin-from-file.js000644 000766 000024 00000003423 13070706737 022051 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const join = require('path').join; const childProcess = require('child_process'); const fs = require('fs'); const stdoutScript = join(common.fixturesDir, 'echo-close-check.js'); const tmpFile = join(common.tmpDir, 'stdin.txt'); const cmd = '"' + process.argv[0] + '" "' + stdoutScript + '" < "' + tmpFile + '"'; const string = 'abc\nümlaut.\nsomething else\n' + '南越国是前203年至前111年存在于岭南地区的一个国家，国都位于番禺，' + '疆域包括今天中国的广东、广西两省区的大部份地区，福建省、湖南、贵州、' + '云南的一小部份地区和越南的北部。南越国是秦朝灭亡后，' + '由南海郡尉赵佗于前203年起兵兼并桂林郡和象郡后建立。前196年和前179年，' + '南越国曾先后两次名义上臣属于西汉，成为西汉的“外臣”。前112年，' + '南越国末代君主赵建德与西汉发生战争，被汉武帝于前111年所灭。南越国共存在93年，' + '历经五代君主。南越国是岭南地区的第一个有记载的政权国家，' + '采用封建制和郡县制并存的制度，' + '它的建立保证了秦末乱世岭南地区社会秩序的稳定，' + '有效的改善了岭南地区落后的政治、##济现状。\n'; common.refreshTmpDir(); console.log(cmd + '\n\n'); fs.writeFileSync(tmpFile, string); childProcess.exec(cmd, common.mustCall(function(err, stdout, stderr) { fs.unlinkSync(tmpFile); assert.ifError(err); assert.strictEqual(stdout, 'hello world\r\n' + string); assert.strictEqual('', stderr); })); node-v4.8.2/test/parallel/test-stdin-hang.js000644 000766 000024 00000000423 13070706737 021103 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); // This test *only* verifies that invoking the stdin getter does not // cause node to hang indefinitely. // If it does, then the test-runner will nuke it. // invoke the getter. process.stdin; console.error('Should exit normally now.'); node-v4.8.2/test/parallel/test-stdin-pause-resume-sync.js000644 000766 000024 00000000512 13070706737 023552 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); console.error('before opening stdin'); process.stdin.resume(); console.error('stdin opened'); console.error('pausing stdin'); process.stdin.pause(); console.error('opening again'); process.stdin.resume(); console.error('pausing again'); process.stdin.pause(); console.error('should exit now'); node-v4.8.2/test/parallel/test-stdin-pause-resume.js000644 000766 000024 00000000721 13070706737 022602 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); console.error('before opening stdin'); process.stdin.resume(); console.error('stdin opened'); setTimeout(function() { console.error('pausing stdin'); process.stdin.pause(); setTimeout(function() { console.error('opening again'); process.stdin.resume(); setTimeout(function() { console.error('pausing again'); process.stdin.pause(); console.error('should exit now'); }, 1); }, 1); }, 1); node-v4.8.2/test/parallel/test-stdin-pipe-large.js000644 000766 000024 00000001142 13070706737 022212 0ustar00iojsstaff000000 000000 'use strict'; // See https://github.com/nodejs/node/issues/5927 const common = require('../common'); const assert = require('assert'); const spawn = require('child_process').spawn; if (process.argv[2] === 'child') { process.stdin.pipe(process.stdout); return; } const child = spawn(process.execPath, [__filename, 'child'], { stdio: 'pipe' }); const expectedBytes = 1024 * 1024; let readBytes = 0; child.stdin.end(Buffer(expectedBytes)); child.stdout.on('data', (chunk) => readBytes += chunk.length); child.stdout.on('end', common.mustCall(() => { assert.strictEqual(readBytes, expectedBytes); })); node-v4.8.2/test/parallel/test-stdin-pipe-resume.js000644 000766 000024 00000001351 13070706737 022422 0ustar00iojsstaff000000 000000 'use strict'; // This tests that piping stdin will cause it to resume() as well. require('../common'); var assert = require('assert'); if (process.argv[2] === 'child') { process.stdin.pipe(process.stdout); } else { var spawn = require('child_process').spawn; var buffers = []; var child = spawn(process.execPath, [__filename, 'child']); child.stdout.on('data', function(c) { buffers.push(c); }); child.stdout.on('close', function() { var b = Buffer.concat(buffers).toString(); assert.equal(b, 'Hello, world\n'); console.log('ok'); }); child.stdin.write('Hel'); child.stdin.write('lo,'); child.stdin.write(' wo'); setTimeout(function() { child.stdin.write('rld\n'); child.stdin.end(); }, 10); } node-v4.8.2/test/parallel/test-stdin-resume-pause.js000644 000766 000024 00000000123 13070706737 022576 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); process.stdin.resume(); process.stdin.pause(); node-v4.8.2/test/parallel/test-stdin-script-child.js000644 000766 000024 00000001354 13070706737 022557 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const spawn = require('child_process').spawn; const child = spawn(process.execPath, [], { env: Object.assign(process.env, { NODE_DEBUG: process.argv[2] }) }); const wanted = child.pid + '\n'; var found = ''; child.stdout.setEncoding('utf8'); child.stdout.on('data', function(c) { found += c; }); child.stderr.setEncoding('utf8'); child.stderr.on('data', function(c) { console.error('> ' + c.trim().split(/\n/).join('\n> ')); }); child.on('close', common.mustCall(function(c) { assert.strictEqual(c, 0); assert.strictEqual(found, wanted); console.log('ok'); })); setTimeout(function() { child.stdin.end('console.log(process.pid)'); }, 1); node-v4.8.2/test/parallel/test-stdio-closed.js000644 000766 000024 00000001204 13070706737 021436 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const spawn = require('child_process').spawn; const fs = require('fs'); if (common.isWindows) { common.skip('platform not supported.'); return; } if (process.argv[2] === 'child') { [0, 1, 2].forEach((i) => assert.doesNotThrow(() => fs.fstatSync(i))); return; } // Run the script in a shell but close stdout and stderr. const cmd = `"${process.execPath}" "${__filename}" child 1>&- 2>&-`; const proc = spawn('/bin/sh', ['-c', cmd], { stdio: 'inherit' }); proc.on('exit', common.mustCall(function(exitCode) { assert.strictEqual(exitCode, 0); })); node-v4.8.2/test/parallel/test-stdio-readable-writable.js000644 000766 000024 00000000416 13070706737 023537 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); assert(process.stdout.writable); assert(!process.stdout.readable); assert(process.stderr.writable); assert(!process.stderr.readable); assert(!process.stdin.writable); assert(process.stdin.readable); node-v4.8.2/test/parallel/test-stdout-cannot-be-closed-child-process-pipe.js000644 000766 000024 00000001256 13070706737 027201 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); if (process.argv[2] === 'child') process.stdout.end('foo'); else parent(); function parent() { var spawn = require('child_process').spawn; var child = spawn(process.execPath, [__filename, 'child']); var out = ''; var err = ''; child.stdout.setEncoding('utf8'); child.stderr.setEncoding('utf8'); child.stdout.on('data', function(c) { out += c; }); child.stderr.on('data', function(c) { err += c; }); child.on('close', function(code, signal) { assert(code); assert.equal(out, 'foo'); assert(/process\.stdout cannot be closed/.test(err)); console.log('ok'); }); } node-v4.8.2/test/parallel/test-stdout-close-catch.js000644 000766 000024 00000001576 13070706737 022566 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const path = require('path'); const child_process = require('child_process'); const testScript = path.join(common.fixturesDir, 'catch-stdout-error.js'); const cmd = JSON.stringify(process.execPath) + ' ' + JSON.stringify(testScript) + ' | ' + JSON.stringify(process.execPath) + ' ' + '-pe "process.stdin.on(\'data\' , () => process.exit(1))"'; const child = child_process.exec(cmd); let output = ''; const outputExpect = { code: 'EPIPE', errno: 'EPIPE', syscall: 'write' }; child.stderr.on('data', function(c) { output += c; }); child.on('close', common.mustCall(function(code) { try { output = JSON.parse(output); } catch (er) { console.error(output); process.exit(1); } assert.deepEqual(output, outputExpect); console.log('ok'); })); node-v4.8.2/test/parallel/test-stdout-close-unref.js000644 000766 000024 00000001244 13070706737 022613 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const spawn = require('child_process').spawn; if (process.argv[2] === 'child') { process.stdin.resume(); process.stdin._handle.close(); process.stdin._handle.unref(); // Should not segfault. process.stdin.on('error', common.mustCall(function(err) {})); return; } // Use spawn so that we can be sure that stdin has a _handle property. // Refs: https://github.com/nodejs/node/pull/5916 const proc = spawn(process.execPath, [__filename, 'child'], { stdio: 'pipe' }); proc.stderr.pipe(process.stderr); proc.on('exit', common.mustCall(function(exitCode) { if (exitCode !== 0) process.exitCode = exitCode; })); node-v4.8.2/test/parallel/test-stdout-stderr-reading.js000644 000766 000024 00000003255 13070706737 023307 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); // verify that stdout is never read from. var net = require('net'); var read = net.Socket.prototype.read; net.Socket.prototype.read = function() { if (this.fd === 1) throw new Error('reading from stdout!'); if (this.fd === 2) throw new Error('reading from stderr!'); return read.apply(this, arguments); }; if (process.argv[2] === 'child') child(); else parent(); function parent() { var spawn = require('child_process').spawn; var node = process.execPath; var c1 = spawn(node, [__filename, 'child']); var c1out = ''; c1.stdout.setEncoding('utf8'); c1.stdout.on('data', function(chunk) { c1out += chunk; }); c1.stderr.setEncoding('utf8'); c1.stderr.on('data', function(chunk) { console.error('c1err: ' + chunk.split('\n').join('\nc1err: ')); }); c1.on('close', common.mustCall(function(code, signal) { assert(!code); assert(!signal); assert.equal(c1out, 'ok\n'); console.log('ok'); })); var c2 = spawn(node, ['-e', 'console.log("ok")']); var c2out = ''; c2.stdout.setEncoding('utf8'); c2.stdout.on('data', function(chunk) { c2out += chunk; }); c1.stderr.setEncoding('utf8'); c1.stderr.on('data', function(chunk) { console.error('c1err: ' + chunk.split('\n').join('\nc1err: ')); }); c2.on('close', common.mustCall(function(code, signal) { assert(!code); assert(!signal); assert.equal(c2out, 'ok\n'); console.log('ok'); })); } function child() { // should not be reading *ever* in here. net.Socket.prototype.read = function() { throw new Error('no reading allowed in child'); }; console.log('ok'); } node-v4.8.2/test/parallel/test-stdout-to-file.js000644 000766 000024 00000002445 13070706737 021734 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const path = require('path'); const childProcess = require('child_process'); const fs = require('fs'); const scriptString = path.join(common.fixturesDir, 'print-chars.js'); const scriptBuffer = path.join(common.fixturesDir, 'print-chars-from-buffer.js'); const tmpFile = path.join(common.tmpDir, 'stdout.txt'); common.refreshTmpDir(); function test(size, useBuffer, cb) { var cmd = '"' + process.argv[0] + '"' + ' ' + '"' + (useBuffer ? scriptBuffer : scriptString) + '"' + ' ' + size + ' > ' + '"' + tmpFile + '"'; try { fs.unlinkSync(tmpFile); } catch (e) {} console.log(`${size} chars to ${tmpFile}...`); childProcess.exec(cmd, common.mustCall(function(err) { if (err) throw err; console.log('done!'); var stat = fs.statSync(tmpFile); console.log(`${tmpFile} has ${stat.size} bytes`); assert.strictEqual(size, stat.size); fs.unlinkSync(tmpFile); cb(); })); } test(1024 * 1024, false, common.mustCall(function() { console.log('Done printing with string'); test(1024 * 1024, true, common.mustCall(function() { console.log('Done printing with buffer'); })); })); node-v4.8.2/test/parallel/test-stream-base-no-abort.js000644 000766 000024 00000003073 13070706737 022775 0ustar00iojsstaff000000 000000 'use strict'; const async_wrap = process.binding('async_wrap'); const uv = process.binding('uv'); const assert = require('assert'); const common = require('../common'); const dgram = require('dgram'); const fs = require('fs'); const net = require('net'); const tls = require('tls'); const providers = Object.keys(async_wrap.Providers); var flags = 0; // Make sure all asserts have run at least once. process.on('exit', () => assert.equal(flags, 0b111)); function init(id, provider) { this._external; // Test will abort if nullptr isn't properly checked. switch (providers[provider]) { case 'TCPWRAP': assert.equal(this.fd, uv.UV_EINVAL); flags |= 0b1; break; case 'TLSWRAP': assert.equal(this.fd, uv.UV_EINVAL); flags |= 0b10; break; case 'UDPWRAP': assert.equal(this.fd, uv.UV_EBADF); flags |= 0b100; break; } } async_wrap.setupHooks({ init }); async_wrap.enable(); const checkTLS = common.mustCall(function checkTLS() { const options = { key: fs.readFileSync(common.fixturesDir + '/keys/ec-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/ec-cert.pem') }; const server = tls.createServer(options, () => {}) .listen(common.PORT, function() { tls.connect(common.PORT, { rejectUnauthorized: false }, function() { this.destroy(); server.close(); }); }); }); const checkTCP = common.mustCall(function checkTCP() { net.createServer(() => {}).listen(common.PORT, function() { this.close(checkTLS); }); }); dgram.createSocket('udp4').close(checkTCP); node-v4.8.2/test/parallel/test-stream-big-packet.js000644 000766 000024 00000002761 13070706737 022355 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const util = require('util'); const stream = require('stream'); let passed = false; function PassThrough() { stream.Transform.call(this); } util.inherits(PassThrough, stream.Transform); PassThrough.prototype._transform = function(chunk, encoding, done) { this.push(chunk); done(); }; function TestStream() { stream.Transform.call(this); } util.inherits(TestStream, stream.Transform); TestStream.prototype._transform = function(chunk, encoding, done) { if (!passed) { // Char 'a' only exists in the last write passed = chunk.toString().indexOf('a') >= 0; } done(); }; const s1 = new PassThrough(); const s2 = new PassThrough(); const s3 = new TestStream(); s1.pipe(s3); // Don't let s2 auto close which may close s3 s2.pipe(s3, {end: false}); // We must write a buffer larger than highWaterMark const big = new Buffer(s1._writableState.highWaterMark + 1); big.fill('x'); // Since big is larger than highWaterMark, it will be buffered internally. assert(!s1.write(big)); // 'tiny' is small enough to pass through internal buffer. assert(s2.write('tiny')); // Write some small data in next IO loop, which will never be written to s3 // Because 'drain' event is not emitted from s1 and s1 is still paused setImmediate(s1.write.bind(s1), 'later'); // Assert after two IO loops when all operations have been done. process.on('exit', function() { assert(passed, 'Large buffer is not handled properly by Writable Stream'); }); node-v4.8.2/test/parallel/test-stream-big-push.js000644 000766 000024 00000002540 13070706737 022060 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const stream = require('stream'); const str = 'asdfasdfasdfasdfasdf'; const r = new stream.Readable({ highWaterMark: 5, encoding: 'utf8' }); let reads = 0; let eofed = false; let ended = false; r._read = function(n) { if (reads === 0) { setTimeout(function() { r.push(str); }); reads++; } else if (reads === 1) { var ret = r.push(str); assert.strictEqual(ret, false); reads++; } else { assert(!eofed); eofed = true; r.push(null); } }; r.on('end', function() { ended = true; }); // push some data in to start. // we've never gotten any read event at this point. var ret = r.push(str); // should be false. > hwm assert(!ret); var chunk = r.read(); assert.strictEqual(chunk, str); chunk = r.read(); assert.strictEqual(chunk, null); r.once('readable', function() { // this time, we'll get *all* the remaining data, because // it's been added synchronously, as the read WOULD take // us below the hwm, and so it triggered a _read() again, // which synchronously added more, which we then return. chunk = r.read(); assert.strictEqual(chunk, str + str); chunk = r.read(); assert.strictEqual(chunk, null); }); process.on('exit', function() { assert(eofed); assert(ended); assert.strictEqual(reads, 2); console.log('ok'); }); node-v4.8.2/test/parallel/test-stream-decoder-objectmode.js000644 000766 000024 00000001017 13070706737 024056 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const stream = require('stream'); const assert = require('assert'); const readable = new stream.Readable({ read: () => {}, encoding: 'utf16le', objectMode: true }); readable.push(Buffer.from('abc', 'utf16le')); readable.push(Buffer.from('def', 'utf16le')); readable.push(null); // Without object mode, these would be concatenated into a single chunk. assert.strictEqual(readable.read(), 'abc'); assert.strictEqual(readable.read(), 'def'); assert.strictEqual(readable.read(), null); node-v4.8.2/test/parallel/test-stream-duplex.js000644 000766 000024 00000001131 13070706737 021636 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const Duplex = require('stream').Transform; const stream = new Duplex({ objectMode: true }); assert(Duplex() instanceof Duplex); assert(stream._readableState.objectMode); assert(stream._writableState.objectMode); let written; let read; stream._write = (obj, _, cb) => { written = obj; cb(); }; stream._read = () => {}; stream.on('data', (obj) => { read = obj; }); stream.push({ val: 1 }); stream.end({ val: 2 }); process.on('exit', () => { assert.strictEqual(read.val, 1); assert.strictEqual(written.val, 2); }); node-v4.8.2/test/parallel/test-stream-end-paused.js000644 000766 000024 00000001206 13070706737 022365 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); // Make sure we don't miss the end event for paused 0-length streams const Readable = require('stream').Readable; const stream = new Readable(); let calledRead = false; stream._read = function() { assert(!calledRead); calledRead = true; this.push(null); }; stream.on('data', function() { throw new Error('should not ever get data'); }); stream.pause(); setTimeout(common.mustCall(function() { stream.on('end', common.mustCall(function() {})); stream.resume(); })); process.on('exit', function() { assert(calledRead); console.log('ok'); }); node-v4.8.2/test/parallel/test-stream-ispaused.js000644 000766 000024 00000000774 13070706737 022166 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const stream = require('stream'); const readable = new stream.Readable(); // _read is a noop, here. readable._read = Function(); // default state of a stream is not "paused" assert.ok(!readable.isPaused()); // make the stream start flowing... readable.on('data', Function()); // still not paused. assert.ok(!readable.isPaused()); readable.pause(); assert.ok(readable.isPaused()); readable.resume(); assert.ok(!readable.isPaused()); node-v4.8.2/test/parallel/test-stream-pipe-after-end.js000644 000766 000024 00000003053 13070706737 023142 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const Readable = require('_stream_readable'); const Writable = require('_stream_writable'); const util = require('util'); util.inherits(TestReadable, Readable); function TestReadable(opt) { if (!(this instanceof TestReadable)) return new TestReadable(opt); Readable.call(this, opt); this._ended = false; } TestReadable.prototype._read = function(n) { if (this._ended) this.emit('error', new Error('_read called twice')); this._ended = true; this.push(null); }; util.inherits(TestWritable, Writable); function TestWritable(opt) { if (!(this instanceof TestWritable)) return new TestWritable(opt); Writable.call(this, opt); this._written = []; } TestWritable.prototype._write = function(chunk, encoding, cb) { this._written.push(chunk); cb(); }; // this one should not emit 'end' until we read() from it later. const ender = new TestReadable(); let enderEnded = false; // what happens when you pipe() a Readable that's already ended? const piper = new TestReadable(); // pushes EOF null, and length=0, so this will trigger 'end' piper.read(); setTimeout(function() { ender.on('end', function() { enderEnded = true; }); assert(!enderEnded); const c = ender.read(); assert.equal(c, null); const w = new TestWritable(); let writableFinished = false; w.on('finish', function() { writableFinished = true; }); piper.pipe(w); process.on('exit', function() { assert(enderEnded); assert(writableFinished); console.log('ok'); }); }); node-v4.8.2/test/parallel/test-stream-pipe-await-drain-manual-resume.js000644 000766 000024 00000003733 13070706737 026253 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const stream = require('stream'); const assert = require('assert'); // A consumer stream with a very low highWaterMark, which starts in a state // where it buffers the chunk it receives rather than indicating that they // have been consumed. const writable = new stream.Writable({ highWaterMark: 5 }); let isCurrentlyBufferingWrites = true; const queue = []; writable._write = (chunk, encoding, cb) => { if (isCurrentlyBufferingWrites) queue.push({chunk, cb}); else cb(); }; const readable = new stream.Readable({ read() {} }); readable.pipe(writable); readable.once('pause', common.mustCall(() => { assert.strictEqual( readable._readableState.awaitDrain, 1, 'awaitDrain doesn\'t increase' ); // First pause, resume manually. The next write() to writable will still // return false, because chunks are still being buffered, so it will increase // the awaitDrain counter again. process.nextTick(common.mustCall(() => { readable.resume(); })); readable.once('pause', common.mustCall(() => { assert.strictEqual( readable._readableState.awaitDrain, 1, '.resume() does not reset counter' ); // Second pause, handle all chunks from now on. Once all callbacks that // are currently queued up are handled, the awaitDrain drain counter should // fall back to 0 and all chunks that are pending on the readable side // should be flushed. isCurrentlyBufferingWrites = false; for (const queued of queue) queued.cb(); })); })); readable.push(Buffer(100)); // Fill the writable HWM, first 'pause'. readable.push(Buffer(100)); // Second 'pause'. readable.push(Buffer(100)); // Should get through to the writable. readable.push(null); writable.on('finish', common.mustCall(() => { assert.strictEqual( readable._readableState.awaitDrain, 0, 'awaitDrain not 0 after all chunks are written' ); // Everything okay, all chunks were written. })); node-v4.8.2/test/parallel/test-stream-pipe-await-drain-push-while-write.js000644 000766 000024 00000003064 13070706737 026712 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const stream = require('stream'); const assert = require('assert'); const awaitDrainStates = [ 1, // after first chunk before callback 1, // after second chunk before callback 0 // resolving chunk pushed after first chunk, awaitDrain is decreased ]; // A writable stream which pushes data onto the stream which pipes into it, // but only the first time it's written to. Since it's not paused at this time, // a second write will occur. If the pipe increases awaitDrain twice, we'll // never get subsequent chunks because 'drain' is only emitted once. const writable = new stream.Writable({ write: common.mustCall(function(chunk, encoding, cb) { if (chunk.length === 32 * 1024) { // first chunk const beforePush = readable._readableState.awaitDrain; readable.push(new Buffer(34 * 1024)); // above hwm // We should check if awaitDrain counter is increased. const afterPush = readable._readableState.awaitDrain; assert.strictEqual(afterPush - beforePush, 1, 'Counter is not increased for awaitDrain'); } assert.strictEqual( awaitDrainStates.shift(), readable._readableState.awaitDrain, 'State variable awaitDrain is not correct.' ); cb(); }, 3) }); // A readable stream which produces two buffers. const bufs = [new Buffer(32 * 1024), new Buffer(33 * 1024)]; // above hwm const readable = new stream.Readable({ read: function() { while (bufs.length > 0) { this.push(bufs.shift()); } } }); readable.pipe(writable); node-v4.8.2/test/parallel/test-stream-pipe-await-drain.js000644 000766 000024 00000003361 13070706737 023477 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const stream = require('stream'); const assert = require('assert'); // This is very similar to test-stream-pipe-cleanup-pause.js. const reader = new stream.Readable(); const writer1 = new stream.Writable(); const writer2 = new stream.Writable(); const writer3 = new stream.Writable(); // 560000 is chosen here because it is larger than the (default) highWaterMark // and will cause `.write()` to return false // See: https://github.com/nodejs/node/issues/5820 const buffer = Buffer(560000); reader._read = function(n) {}; writer1._write = common.mustCall(function(chunk, encoding, cb) { this.emit('chunk-received'); cb(); }, 1); writer1.once('chunk-received', function() { assert.strictEqual(reader._readableState.awaitDrain, 0, 'initial value is not 0'); setImmediate(function() { // This one should *not* get through to writer1 because writer2 is not // "done" processing. reader.push(buffer); }); }); // A "slow" consumer: writer2._write = common.mustCall(function(chunk, encoding, cb) { assert.strictEqual( reader._readableState.awaitDrain, 1, 'awaitDrain isn\'t 1 after first push' ); // Not calling cb here to "simulate" slow stream. // This should be called exactly once, since the first .write() call // will return false. }, 1); writer3._write = common.mustCall(function(chunk, encoding, cb) { assert.strictEqual( reader._readableState.awaitDrain, 2, 'awaitDrain isn\'t 2 after second push' ); // Not calling cb here to "simulate" slow stream. // This should be called exactly once, since the first .write() call // will return false. }, 1); reader.pipe(writer1); reader.pipe(writer2); reader.pipe(writer3); reader.push(buffer); node-v4.8.2/test/parallel/test-stream-pipe-cleanup-pause.js000644 000766 000024 00000001637 13070706737 024045 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const stream = require('stream'); const reader = new stream.Readable(); const writer1 = new stream.Writable(); const writer2 = new stream.Writable(); // 560000 is chosen here because it is larger than the (default) highWaterMark // and will cause `.write()` to return false // See: https://github.com/nodejs/node/issues/2323 const buffer = new Buffer(560000); reader._read = function(n) {}; writer1._write = common.mustCall(function(chunk, encoding, cb) { this.emit('chunk-received'); cb(); }, 1); writer1.once('chunk-received', function() { reader.unpipe(writer1); reader.pipe(writer2); reader.push(buffer); setImmediate(function() { reader.push(buffer); setImmediate(function() { reader.push(buffer); }); }); }); writer2._write = common.mustCall(function(chunk, encoding, cb) { cb(); }, 3); reader.pipe(writer1); reader.push(buffer); node-v4.8.2/test/parallel/test-stream-pipe-cleanup.js000644 000766 000024 00000005240 13070706737 022724 0ustar00iojsstaff000000 000000 'use strict'; // This test asserts that Stream.prototype.pipe does not leave listeners // hanging on the source or dest. require('../common'); const stream = require('stream'); const assert = require('assert'); const util = require('util'); function Writable() { this.writable = true; this.endCalls = 0; stream.Stream.call(this); } util.inherits(Writable, stream.Stream); Writable.prototype.end = function() { this.endCalls++; }; Writable.prototype.destroy = function() { this.endCalls++; }; function Readable() { this.readable = true; stream.Stream.call(this); } util.inherits(Readable, stream.Stream); function Duplex() { this.readable = true; Writable.call(this); } util.inherits(Duplex, Writable); let i = 0; const limit = 100; let w = new Writable(); let r; for (i = 0; i < limit; i++) { r = new Readable(); r.pipe(w); r.emit('end'); } assert.strictEqual(0, r.listeners('end').length); assert.strictEqual(limit, w.endCalls); w.endCalls = 0; for (i = 0; i < limit; i++) { r = new Readable(); r.pipe(w); r.emit('close'); } assert.strictEqual(0, r.listeners('close').length); assert.strictEqual(limit, w.endCalls); w.endCalls = 0; r = new Readable(); for (i = 0; i < limit; i++) { w = new Writable(); r.pipe(w); w.emit('close'); } assert.strictEqual(0, w.listeners('close').length); r = new Readable(); w = new Writable(); const d = new Duplex(); r.pipe(d); // pipeline A d.pipe(w); // pipeline B assert.strictEqual(r.listeners('end').length, 2); // A.onend, A.cleanup assert.strictEqual(r.listeners('close').length, 2); // A.onclose, A.cleanup assert.strictEqual(d.listeners('end').length, 2); // B.onend, B.cleanup // A.cleanup, B.onclose, B.cleanup assert.strictEqual(d.listeners('close').length, 3); assert.strictEqual(w.listeners('end').length, 0); assert.strictEqual(w.listeners('close').length, 1); // B.cleanup r.emit('end'); assert.strictEqual(d.endCalls, 1); assert.strictEqual(w.endCalls, 0); assert.strictEqual(r.listeners('end').length, 0); assert.strictEqual(r.listeners('close').length, 0); assert.strictEqual(d.listeners('end').length, 2); // B.onend, B.cleanup assert.strictEqual(d.listeners('close').length, 2); // B.onclose, B.cleanup assert.strictEqual(w.listeners('end').length, 0); assert.strictEqual(w.listeners('close').length, 1); // B.cleanup d.emit('end'); assert.strictEqual(d.endCalls, 1); assert.strictEqual(w.endCalls, 1); assert.strictEqual(r.listeners('end').length, 0); assert.strictEqual(r.listeners('close').length, 0); assert.strictEqual(d.listeners('end').length, 0); assert.strictEqual(d.listeners('close').length, 0); assert.strictEqual(w.listeners('end').length, 0); assert.strictEqual(w.listeners('close').length, 0); node-v4.8.2/test/parallel/test-stream-pipe-error-handling.js000644 000766 000024 00000004215 13070706737 024211 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var Stream = require('stream').Stream; (function testErrorListenerCatches() { var source = new Stream(); var dest = new Stream(); source.pipe(dest); var gotErr = null; source.on('error', function(err) { gotErr = err; }); var err = new Error('This stream turned into bacon.'); source.emit('error', err); assert.strictEqual(gotErr, err); })(); (function testErrorWithoutListenerThrows() { var source = new Stream(); var dest = new Stream(); source.pipe(dest); var err = new Error('This stream turned into bacon.'); var gotErr = null; try { source.emit('error', err); } catch (e) { gotErr = e; } assert.strictEqual(gotErr, err); })(); (function testErrorWithRemovedListenerThrows() { var R = Stream.Readable; var W = Stream.Writable; var r = new R(); var w = new W(); var removed = false; var didTest = false; process.on('exit', function() { assert(didTest); console.log('ok'); }); r._read = common.mustCall(function() { setTimeout(function() { assert(removed); assert.throws(function() { w.emit('error', new Error('fail')); }); didTest = true; }); }); w.on('error', myOnError); r.pipe(w); w.removeListener('error', myOnError); removed = true; function myOnError(er) { throw new Error('this should not happen'); } })(); (function testErrorWithRemovedListenerThrows() { var R = Stream.Readable; var W = Stream.Writable; var r = new R(); var w = new W(); var removed = false; var didTest = false; var caught = false; process.on('exit', function() { assert(didTest); console.log('ok'); }); r._read = common.mustCall(function() { setTimeout(function() { assert(removed); w.emit('error', new Error('fail')); didTest = true; }); }); w.on('error', myOnError); w._write = function() {}; r.pipe(w); // Removing some OTHER random listener should not do anything w.removeListener('error', function() {}); removed = true; function myOnError(er) { assert(!caught); caught = true; } })(); node-v4.8.2/test/parallel/test-stream-pipe-event.js000644 000766 000024 00000001002 13070706737 022406 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var stream = require('stream'); var assert = require('assert'); var util = require('util'); function Writable() { this.writable = true; stream.Stream.call(this); } util.inherits(Writable, stream.Stream); function Readable() { this.readable = true; stream.Stream.call(this); } util.inherits(Readable, stream.Stream); var passed = false; var w = new Writable(); w.on('pipe', function(src) { passed = true; }); var r = new Readable(); r.pipe(w); assert.ok(passed); node-v4.8.2/test/parallel/test-stream-pipe-multiple-pipes.js000644 000766 000024 00000002352 13070706737 024247 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const stream = require('stream'); const assert = require('assert'); const readable = new stream.Readable({ read: () => {} }); const writables = []; for (let i = 0; i < 5; i++) { const target = new stream.Writable({ write: common.mustCall((chunk, encoding, callback) => { target.output.push(chunk); callback(); }, 1) }); target.output = []; target.on('pipe', common.mustCall(() => {})); readable.pipe(target); writables.push(target); } const input = Buffer.from([1, 2, 3, 4, 5]); readable.push(input); // The pipe() calls will postpone emission of the 'resume' event using nextTick, // so no data will be available to the writable streams until then. process.nextTick(common.mustCall(() => { for (const target of writables) { assert.deepStrictEqual(target.output, [input]); target.on('unpipe', common.mustCall(() => {})); readable.unpipe(target); } readable.push('something else'); // This does not get through. readable.push(null); readable.resume(); // Make sure the 'end' event gets emitted. })); readable.on('end', common.mustCall(() => { for (const target of writables) { assert.deepStrictEqual(target.output, [input]); } })); node-v4.8.2/test/parallel/test-stream-pipe-unpipe-streams.js000644 000766 000024 00000001727 13070706737 024257 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const Stream = require('stream'); const Readable = Stream.Readable; const Writable = Stream.Writable; const source = Readable({read: () => {}}); const dest1 = Writable({write: () => {}}); const dest2 = Writable({write: () => {}}); source.pipe(dest1); source.pipe(dest2); dest1.on('unpipe', common.mustCall(() => {})); dest2.on('unpipe', common.mustCall(() => {})); assert.strictEqual(source._readableState.pipes[0], dest1); assert.strictEqual(source._readableState.pipes[1], dest2); assert.strictEqual(source._readableState.pipes.length, 2); // Should be able to unpipe them in the reverse order that they were piped. source.unpipe(dest2); assert.strictEqual(source._readableState.pipes, dest1); assert.notStrictEqual(source._readableState.pipes, dest2); dest2.on('unpipe', common.fail); source.unpipe(dest2); source.unpipe(dest1); assert.strictEqual(source._readableState.pipes, null); node-v4.8.2/test/parallel/test-stream-pipe-without-listenerCount.js000644 000766 000024 00000000671 13070706737 025637 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const stream = require('stream'); const r = new stream.Stream(); r.listenerCount = undefined; const w = new stream.Stream(); w.listenerCount = undefined; w.on('pipe', function() { r.emit('error', new Error('Readable Error')); w.emit('error', new Error('Writable Error')); }); r.on('error', common.mustCall(noop)); w.on('error', common.mustCall(noop)); r.pipe(w); function noop() {} node-v4.8.2/test/parallel/test-stream-preprocess.js000644 000766 000024 00000003745 13070706737 022537 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const fs = require('fs'); const path = require('path'); const rl = require('readline'); const BOM = '\uFEFF'; // Get the data using a non-stream way to compare with the streamed data. const modelData = fs.readFileSync( path.join(common.fixturesDir, 'file-to-read-without-bom.txt'), 'utf8' ); const modelDataFirstCharacter = modelData[0]; // Detect the number of forthcoming 'line' events for mustCall() 'expected' arg. const lineCount = modelData.match(/\n/g).length; // Ensure both without-bom and with-bom test files are textwise equal. assert.strictEqual( fs.readFileSync( path.join(common.fixturesDir, 'file-to-read-with-bom.txt'), 'utf8' ), `${BOM}${modelData}` ); // An unjustified BOM stripping with a non-BOM character unshifted to a stream. const inputWithoutBOM = fs.createReadStream( path.join(common.fixturesDir, 'file-to-read-without-bom.txt'), 'utf8' ); inputWithoutBOM.once('readable', common.mustCall(() => { const maybeBOM = inputWithoutBOM.read(1); assert.strictEqual(maybeBOM, modelDataFirstCharacter); assert.notStrictEqual(maybeBOM, BOM); inputWithoutBOM.unshift(maybeBOM); let streamedData = ''; rl.createInterface({ input: inputWithoutBOM, }).on('line', common.mustCall((line) => { streamedData += `${line}\n`; }, lineCount)).on('close', common.mustCall(() => { assert.strictEqual(streamedData, modelData); })); })); // A justified BOM stripping. const inputWithBOM = fs.createReadStream( path.join(common.fixturesDir, 'file-to-read-with-bom.txt'), 'utf8' ); inputWithBOM.once('readable', common.mustCall(() => { const maybeBOM = inputWithBOM.read(1); assert.strictEqual(maybeBOM, BOM); let streamedData = ''; rl.createInterface({ input: inputWithBOM, }).on('line', common.mustCall((line) => { streamedData += `${line}\n`; }, lineCount)).on('close', common.mustCall(() => { assert.strictEqual(streamedData, modelData); })); })); node-v4.8.2/test/parallel/test-stream-push-order.js000644 000766 000024 00000001111 13070706737 022423 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var Readable = require('stream').Readable; var assert = require('assert'); var s = new Readable({ highWaterMark: 20, encoding: 'ascii' }); var list = ['1', '2', '3', '4', '5', '6']; s._read = function(n) { var one = list.shift(); if (!one) { s.push(null); } else { var two = list.shift(); s.push(one); s.push(two); } }; s.read(0); // ACTUALLY [1, 3, 5, 6, 4, 2] process.on('exit', function() { assert.deepEqual(s._readableState.buffer, ['1', '2', '3', '4', '5', '6']); console.log('ok'); }); node-v4.8.2/test/parallel/test-stream-push-strings.js000644 000766 000024 00000002033 13070706737 023005 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var Readable = require('stream').Readable; var util = require('util'); util.inherits(MyStream, Readable); function MyStream(options) { Readable.call(this, options); this._chunks = 3; } MyStream.prototype._read = function(n) { switch (this._chunks--) { case 0: return this.push(null); case 1: return setTimeout(function() { this.push('last chunk'); }.bind(this), 100); case 2: return this.push('second to last chunk'); case 3: return process.nextTick(function() { this.push('first chunk'); }.bind(this)); default: throw new Error('?'); } }; var ms = new MyStream(); var results = []; ms.on('readable', function() { var chunk; while (null !== (chunk = ms.read())) results.push(chunk + ''); }); var expect = [ 'first chunksecond to last chunk', 'last chunk' ]; process.on('exit', function() { assert.equal(ms._chunks, -1); assert.deepEqual(results, expect); console.log('ok'); }); node-v4.8.2/test/parallel/test-stream-readable-constructor-set-methods.js000644 000766 000024 00000000531 13070706737 026714 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var Readable = require('stream').Readable; var _readCalled = false; function _read(n) { _readCalled = true; this.push(null); } var r = new Readable({ read: _read }); r.resume(); process.on('exit', function() { assert.equal(r._read, _read); assert(_readCalled); }); node-v4.8.2/test/parallel/test-stream-readable-emittedReadable.js000644 000766 000024 00000003674 13070706737 025163 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const Readable = require('stream').Readable; const readable = new Readable({ read: () => {} }); // Initialized to false. assert.strictEqual(readable._readableState.emittedReadable, false); readable.on('readable', common.mustCall(() => { // emittedReadable should be true when the readable event is emitted assert.strictEqual(readable._readableState.emittedReadable, true); readable.read(); // emittedReadable is reset to false during read() assert.strictEqual(readable._readableState.emittedReadable, false); }, 4)); // When the first readable listener is just attached, // emittedReadable should be false assert.strictEqual(readable._readableState.emittedReadable, false); // Each one of these should trigger a readable event. process.nextTick(common.mustCall(() => { readable.push('foo'); })); process.nextTick(common.mustCall(() => { readable.push('bar'); })); process.nextTick(common.mustCall(() => { readable.push('quo'); })); process.nextTick(common.mustCall(() => { readable.push(null); })); const noRead = new Readable({ read: () => {} }); noRead.on('readable', common.mustCall(() => { // emittedReadable should be true when the readable event is emitted assert.strictEqual(noRead._readableState.emittedReadable, true); noRead.read(0); // emittedReadable is not reset during read(0) assert.strictEqual(noRead._readableState.emittedReadable, true); })); noRead.push('foo'); noRead.push(null); const flowing = new Readable({ read: () => {} }); flowing.on('data', common.mustCall(() => { // When in flowing mode, emittedReadable is always false. assert.strictEqual(flowing._readableState.emittedReadable, false); flowing.read(); assert.strictEqual(flowing._readableState.emittedReadable, false); }, 3)); flowing.push('foooo'); flowing.push('bar'); flowing.push('quo'); process.nextTick(common.mustCall(() => { flowing.push(null); })); node-v4.8.2/test/parallel/test-stream-readable-event.js000644 000766 000024 00000004467 13070706737 023232 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var Readable = require('stream').Readable; (function first() { // First test, not reading when the readable is added. // make sure that on('readable', ...) triggers a readable event. var r = new Readable({ highWaterMark: 3 }); var _readCalled = false; r._read = function(n) { _readCalled = true; }; // This triggers a 'readable' event, which is lost. r.push(new Buffer('blerg')); var caughtReadable = false; setTimeout(function() { // we're testing what we think we are assert(!r._readableState.reading); r.on('readable', function() { caughtReadable = true; }); }); process.on('exit', function() { // we're testing what we think we are assert(!_readCalled); assert(caughtReadable); console.log('ok 1'); }); })(); (function second() { // second test, make sure that readable is re-emitted if there's // already a length, while it IS reading. var r = new Readable({ highWaterMark: 3 }); var _readCalled = false; r._read = function(n) { _readCalled = true; }; // This triggers a 'readable' event, which is lost. r.push(new Buffer('bl')); var caughtReadable = false; setTimeout(function() { // assert we're testing what we think we are assert(r._readableState.reading); r.on('readable', function() { caughtReadable = true; }); }); process.on('exit', function() { // we're testing what we think we are assert(_readCalled); assert(caughtReadable); console.log('ok 2'); }); })(); (function third() { // Third test, not reading when the stream has not passed // the highWaterMark but *has* reached EOF. var r = new Readable({ highWaterMark: 30 }); var _readCalled = false; r._read = function(n) { _readCalled = true; }; // This triggers a 'readable' event, which is lost. r.push(new Buffer('blerg')); r.push(null); var caughtReadable = false; setTimeout(function() { // assert we're testing what we think we are assert(!r._readableState.reading); r.on('readable', function() { caughtReadable = true; }); }); process.on('exit', function() { // we're testing what we think we are assert(!_readCalled); assert(caughtReadable); console.log('ok 3'); }); })(); node-v4.8.2/test/parallel/test-stream-readable-flow-recursion.js000644 000766 000024 00000002527 13070706737 025062 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); // this test verifies that passing a huge number to read(size) // will push up the highWaterMark, and cause the stream to read // more data continuously, but without triggering a nextTick // warning or RangeError. var Readable = require('stream').Readable; // throw an error if we trigger a nextTick warning. process.throwDeprecation = true; var stream = new Readable({ highWaterMark: 2 }); var reads = 0; var total = 5000; stream._read = function(size) { reads++; size = Math.min(size, total); total -= size; if (size === 0) stream.push(null); else stream.push(new Buffer(size)); }; var depth = 0; function flow(stream, size, callback) { depth += 1; var chunk = stream.read(size); if (!chunk) stream.once('readable', flow.bind(null, stream, size, callback)); else callback(chunk); depth -= 1; console.log('flow(' + depth + '): exit'); } flow(stream, 5000, function() { console.log('complete (' + depth + ')'); }); process.on('exit', function(code) { assert.equal(reads, 2); // we pushed up the high water mark assert.equal(stream._readableState.highWaterMark, 8192); // length is 0 right now, because we pulled it all out. assert.equal(stream._readableState.length, 0); assert(!code); assert.equal(depth, 0); console.log('ok'); }); node-v4.8.2/test/parallel/test-stream-readable-invalid-chunk.js000644 000766 000024 00000000611 13070706737 024630 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const stream = require('stream'); const assert = require('assert'); const readable = new stream.Readable({ read: () => {} }); assert.throws(() => readable.push([]), /Invalid non-string\/buffer chunk/); assert.throws(() => readable.push({}), /Invalid non-string\/buffer chunk/); assert.throws(() => readable.push(0), /Invalid non-string\/buffer chunk/); node-v4.8.2/test/parallel/test-stream-readable-needReadable.js000644 000766 000024 00000005154 13070706737 024436 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const Readable = require('stream').Readable; const readable = new Readable({ read: () => {} }); // Initialized to false. assert.strictEqual(readable._readableState.needReadable, false); readable.on('readable', common.mustCall(() => { // When the readable event fires, needReadable is reset. assert.strictEqual(readable._readableState.needReadable, false); readable.read(); })); // If a readable listener is attached, then a readable event is needed. assert.strictEqual(readable._readableState.needReadable, true); readable.push('foo'); readable.push(null); readable.on('end', common.mustCall(() => { // No need to emit readable anymore when the stream ends. assert.strictEqual(readable._readableState.needReadable, false); })); const asyncReadable = new Readable({ read: () => {} }); asyncReadable.on('readable', common.mustCall(() => { if (asyncReadable.read() !== null) { // After each read(), the buffer is empty. // If the stream doesn't end now, // then we need to notify the reader on future changes. assert.strictEqual(asyncReadable._readableState.needReadable, true); } }, 3)); process.nextTick(common.mustCall(() => { asyncReadable.push('foooo'); })); process.nextTick(common.mustCall(() => { asyncReadable.push('bar'); })); process.nextTick(common.mustCall(() => { asyncReadable.push(null); })); const flowing = new Readable({ read: () => {} }); // Notice this must be above the on('data') call. flowing.push('foooo'); flowing.push('bar'); flowing.push('quo'); process.nextTick(common.mustCall(() => { flowing.push(null); })); // When the buffer already has enough data, and the stream is // in flowing mode, there is no need for the readable event. flowing.on('data', common.mustCall(function(data) { assert.strictEqual(flowing._readableState.needReadable, false); }, 3)); const slowProducer = new Readable({ read: () => {} }); slowProducer.on('readable', common.mustCall(() => { if (slowProducer.read(8) === null) { // The buffer doesn't have enough data, and the stream is not ened, // we need to notify the reader when data arrives. assert.strictEqual(slowProducer._readableState.needReadable, true); } else { assert.strictEqual(slowProducer._readableState.needReadable, false); } }, 4)); process.nextTick(common.mustCall(() => { slowProducer.push('foo'); })); process.nextTick(common.mustCall(() => { slowProducer.push('foo'); })); process.nextTick(common.mustCall(() => { slowProducer.push('foo'); })); process.nextTick(common.mustCall(() => { slowProducer.push(null); })); node-v4.8.2/test/parallel/test-stream-readable-reading-readingMore.js000644 000766 000024 00000003247 13070706737 025747 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const Readable = require('stream').Readable; const readable = new Readable({ read(size) {} }); const state = readable._readableState; // Starting off with false initially. assert.strictEqual(state.reading, false); assert.strictEqual(state.readingMore, false); readable.on('data', common.mustCall((data) => { // while in a flowing state, should try to read more. if (state.flowing) assert.strictEqual(state.readingMore, true); // reading as long as we've not ended assert.strictEqual(state.reading, !state.ended); }, 2)); function onStreamEnd() { // End of stream; state.reading is false // And so should be readingMore. assert.strictEqual(state.readingMore, false); assert.strictEqual(state.reading, false); } readable.on('readable', common.mustCall(() => { // 'readable' always gets called before 'end' // since 'end' hasn't been emitted, more data could be incoming assert.strictEqual(state.readingMore, true); // if the stream has ended, we shouldn't be reading assert.strictEqual(state.ended, !state.reading); if (readable.read() === null) // reached end of stream process.nextTick(common.mustCall(onStreamEnd, 1)); }, 2)); readable.on('end', common.mustCall(onStreamEnd)); readable.push('pushed'); // stop emitting 'data' events readable.pause(); // read() should only be called while operating in paused mode readable.read(6); // reading assert.strictEqual(state.reading, true); assert.strictEqual(state.readingMore, true); // resume emitting 'data' events readable.resume(); // add chunk to front readable.unshift('unshifted'); // end readable.push(null); node-v4.8.2/test/parallel/test-stream-readable-resumeScheduled.js000644 000766 000024 00000003470 13070706737 025223 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); // Testing Readable Stream resumeScheduled state const assert = require('assert'); const stream = require('stream'); const Readable = stream.Readable; const Writable = stream.Writable; { // pipe() test case const r = new Readable({ read() {} }); const w = new Writable(); // resumeScheduled should start = `false`. assert.strictEqual(r._readableState.resumeScheduled, false); // calling pipe() should change the state value = true. r.pipe(w); assert.strictEqual(r._readableState.resumeScheduled, true); process.nextTick(common.mustCall(() => { assert.strictEqual(r._readableState.resumeScheduled, false); })); } { // 'data' listener test case const r = new Readable({ read() {} }); // resumeScheduled should start = `false`. assert.strictEqual(r._readableState.resumeScheduled, false); r.push(Buffer.from([1, 2, 3])); // adding 'data' listener should change the state value r.on('data', common.mustCall(() => { assert.strictEqual(r._readableState.resumeScheduled, false); })); assert.strictEqual(r._readableState.resumeScheduled, true); process.nextTick(common.mustCall(() => { assert.strictEqual(r._readableState.resumeScheduled, false); })); } { // resume() test case const r = new Readable({ read() {} }); // resumeScheduled should start = `false`. assert.strictEqual(r._readableState.resumeScheduled, false); // Calling resume() should change the state value. r.resume(); assert.strictEqual(r._readableState.resumeScheduled, true); r.on('resume', common.mustCall(() => { // The state value should be `false` again assert.strictEqual(r._readableState.resumeScheduled, false); })); process.nextTick(common.mustCall(() => { assert.strictEqual(r._readableState.resumeScheduled, false); })); } node-v4.8.2/test/parallel/test-stream-readable-with-unimplemented-_read.js000644 000766 000024 00000000313 13070706737 026762 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const stream = require('stream'); const assert = require('assert'); const readable = new stream.Readable(); assert.throws(() => readable.read(), /not implemented/); node-v4.8.2/test/parallel/test-stream-readableListening-state.js000644 000766 000024 00000001665 13070706737 025103 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const stream = require('stream'); const r = new stream.Readable({ read: () => {} }); // readableListening state should start in `false`. assert.strictEqual(r._readableState.readableListening, false); r.on('readable', common.mustCall(() => { // Inside the readable event this state should be true. assert.strictEqual(r._readableState.readableListening, true); })); r.push(Buffer.from('Testing readableListening state')); const r2 = new stream.Readable({ read: () => {} }); // readableListening state should start in `false`. assert.strictEqual(r2._readableState.readableListening, false); r2.on('data', common.mustCall((chunk) => { // readableListening should be false because we don't have // a `readable` listener assert.strictEqual(r2._readableState.readableListening, false); })); r2.push(Buffer.from('Testing readableListening state')); node-v4.8.2/test/parallel/test-stream-transform-constructor-set-methods.js000644 000766 000024 00000001070 13070706737 027167 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var Transform = require('stream').Transform; var _transformCalled = false; function _transform(d, e, n) { _transformCalled = true; n(); } var _flushCalled = false; function _flush(n) { _flushCalled = true; n(); } var t = new Transform({ transform: _transform, flush: _flush }); t.end(new Buffer('blerg')); t.resume(); process.on('exit', function() { assert.equal(t._transform, _transform); assert.equal(t._flush, _flush); assert(_transformCalled); assert(_flushCalled); }); node-v4.8.2/test/parallel/test-stream-transform-objectmode-falsey-value.js000644 000766 000024 00000001245 13070706737 027062 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var stream = require('stream'); var PassThrough = stream.PassThrough; var src = new PassThrough({ objectMode: true }); var tx = new PassThrough({ objectMode: true }); var dest = new PassThrough({ objectMode: true }); var expect = [ -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ]; var results = []; process.on('exit', function() { assert.deepEqual(results, expect); console.log('ok'); }); dest.on('data', function(x) { results.push(x); }); src.pipe(tx).pipe(dest); var i = -1; var int = setInterval(function() { if (i > 10) { src.end(); clearInterval(int); } else { src.write(i++); } }); node-v4.8.2/test/parallel/test-stream-transform-split-objectmode.js000644 000766 000024 00000002251 13070706737 025616 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var Transform = require('stream').Transform; var parser = new Transform({ readableObjectMode: true }); assert(parser._readableState.objectMode); assert(!parser._writableState.objectMode); assert(parser._readableState.highWaterMark === 16); assert(parser._writableState.highWaterMark === (16 * 1024)); parser._transform = function(chunk, enc, callback) { callback(null, { val: chunk[0] }); }; var parsed; parser.on('data', function(obj) { parsed = obj; }); parser.end(new Buffer([42])); process.on('exit', function() { assert(parsed.val === 42); }); var serializer = new Transform({ writableObjectMode: true }); assert(!serializer._readableState.objectMode); assert(serializer._writableState.objectMode); assert(serializer._readableState.highWaterMark === (16 * 1024)); assert(serializer._writableState.highWaterMark === 16); serializer._transform = function(obj, _, callback) { callback(null, new Buffer([obj.val])); }; var serialized; serializer.on('data', function(chunk) { serialized = chunk; }); serializer.write({ val: 42 }); process.on('exit', function() { assert(serialized[0] === 42); }); node-v4.8.2/test/parallel/test-stream-unshift-empty-chunk.js000644 000766 000024 00000002466 13070706737 024273 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); // This test verifies that stream.unshift(Buffer(0)) or // stream.unshift('') does not set state.reading=false. var Readable = require('stream').Readable; var r = new Readable(); var nChunks = 10; var chunk = new Buffer(10); chunk.fill('x'); r._read = function(n) { setImmediate(function() { r.push(--nChunks === 0 ? null : chunk); }); }; var readAll = false; var seen = []; r.on('readable', function() { var chunk; while (chunk = r.read()) { seen.push(chunk.toString()); // simulate only reading a certain amount of the data, // and then putting the rest of the chunk back into the // stream, like a parser might do. We just fill it with // 'y' so that it's easy to see which bits were touched, // and which were not. var putBack = new Buffer(readAll ? 0 : 5); putBack.fill('y'); readAll = !readAll; r.unshift(putBack); } }); var expect = [ 'xxxxxxxxxx', 'yyyyy', 'xxxxxxxxxx', 'yyyyy', 'xxxxxxxxxx', 'yyyyy', 'xxxxxxxxxx', 'yyyyy', 'xxxxxxxxxx', 'yyyyy', 'xxxxxxxxxx', 'yyyyy', 'xxxxxxxxxx', 'yyyyy', 'xxxxxxxxxx', 'yyyyy', 'xxxxxxxxxx', 'yyyyy' ]; r.on('end', function() { assert.deepEqual(seen, expect); console.log('ok'); }); node-v4.8.2/test/parallel/test-stream-unshift-read-race.js000644 000766 000024 00000005337 13070706737 023652 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); // This test verifies that: // 1. unshift() does not cause colliding _read() calls. // 2. unshift() after the 'end' event is an error, but after the EOF // signalling null, it is ok, and just creates a new readable chunk. // 3. push() after the EOF signaling null is an error. // 4. _read() is not called after pushing the EOF null chunk. var stream = require('stream'); var hwm = 10; var r = stream.Readable({ highWaterMark: hwm }); var chunks = 10; var data = new Buffer(chunks * hwm + Math.ceil(hwm / 2)); for (var i = 0; i < data.length; i++) { var c = 'asdf'.charCodeAt(i % 4); data[i] = c; } var pos = 0; var pushedNull = false; r._read = function(n) { assert(!pushedNull, '_read after null push'); // every third chunk is fast push(!(chunks % 3)); function push(fast) { assert(!pushedNull, 'push() after null push'); var c = pos >= data.length ? null : data.slice(pos, pos + n); pushedNull = c === null; if (fast) { pos += n; r.push(c); if (c === null) pushError(); } else { setTimeout(function() { pos += n; r.push(c); if (c === null) pushError(); }); } } }; function pushError() { assert.throws(function() { r.push(new Buffer(1)); }); } var w = stream.Writable(); var written = []; w._write = function(chunk, encoding, cb) { written.push(chunk.toString()); cb(); }; var ended = false; r.on('end', function() { assert(!ended, 'end emitted more than once'); assert.throws(function() { r.unshift(new Buffer(1)); }); ended = true; w.end(); }); r.on('readable', function() { var chunk; while (null !== (chunk = r.read(10))) { w.write(chunk); if (chunk.length > 4) r.unshift(new Buffer('1234')); } }); var finished = false; w.on('finish', function() { finished = true; // each chunk should start with 1234, and then be asfdasdfasdf... // The first got pulled out before the first unshift('1234'), so it's // lacking that piece. assert.equal(written[0], 'asdfasdfas'); var asdf = 'd'; console.error('0: %s', written[0]); for (var i = 1; i < written.length; i++) { console.error('%s: %s', i.toString(32), written[i]); assert.equal(written[i].slice(0, 4), '1234'); for (var j = 4; j < written[i].length; j++) { var c = written[i].charAt(j); assert.equal(c, asdf); switch (asdf) { case 'a': asdf = 's'; break; case 's': asdf = 'd'; break; case 'd': asdf = 'f'; break; case 'f': asdf = 'a'; break; } } } }); process.on('exit', function() { assert.equal(written.length, 18); assert(ended, 'stream ended'); assert(finished, 'stream finished'); console.log('ok'); }); node-v4.8.2/test/parallel/test-stream-wrap-encoding.js000644 000766 000024 00000000676 13070706737 023107 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const StreamWrap = require('_stream_wrap'); const Duplex = require('stream').Duplex; const stream = new Duplex({ read: function() { }, write: function() { } }); stream.setEncoding('ascii'); const wrap = new StreamWrap(stream); wrap.on('error', common.mustCall(function(err) { assert(/StringDecoder/.test(err.message)); })); stream.push('ohai'); node-v4.8.2/test/parallel/test-stream-wrap.js000644 000766 000024 00000001243 13070706737 021312 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const StreamWrap = require('_stream_wrap'); const Duplex = require('stream').Duplex; const ShutdownWrap = process.binding('stream_wrap').ShutdownWrap; function testShutdown(callback) { var stream = new Duplex({ read: function() { }, write: function() { } }); var wrap = new StreamWrap(stream); var req = new ShutdownWrap(); req.oncomplete = function(code) { assert(code < 0); callback(); }; req.handle = wrap._handle; // Close the handle to simulate wrap.destroy(); req.handle.shutdown(req); } testShutdown(common.mustCall(function() {})); node-v4.8.2/test/parallel/test-stream-writable-change-default-encoding.js000644 000766 000024 00000002413 13070706737 026603 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var stream = require('stream'); var util = require('util'); function MyWritable(fn, options) { stream.Writable.call(this, options); this.fn = fn; } util.inherits(MyWritable, stream.Writable); MyWritable.prototype._write = function(chunk, encoding, callback) { this.fn(Buffer.isBuffer(chunk), typeof chunk, encoding); callback(); }; (function defaultCondingIsUtf8() { var m = new MyWritable(function(isBuffer, type, enc) { assert.equal(enc, 'utf8'); }, { decodeStrings: false }); m.write('foo'); m.end(); }()); (function changeDefaultEncodingToAscii() { var m = new MyWritable(function(isBuffer, type, enc) { assert.equal(enc, 'ascii'); }, { decodeStrings: false }); m.setDefaultEncoding('ascii'); m.write('bar'); m.end(); }()); assert.throws(function changeDefaultEncodingToInvalidValue() { var m = new MyWritable(function(isBuffer, type, enc) { }, { decodeStrings: false }); m.setDefaultEncoding({}); m.write('bar'); m.end(); }, TypeError); (function checkVairableCaseEncoding() { var m = new MyWritable(function(isBuffer, type, enc) { assert.equal(enc, 'ascii'); }, { decodeStrings: false }); m.setDefaultEncoding('AsCii'); m.write('bar'); m.end(); }()); node-v4.8.2/test/parallel/test-stream-writable-constructor-set-methods.js000644 000766 000024 00000001265 13070706737 026773 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var Writable = require('stream').Writable; var _writeCalled = false; function _write(d, e, n) { _writeCalled = true; } var w = new Writable({ write: _write }); w.end(new Buffer('blerg')); var _writevCalled = false; var dLength = 0; function _writev(d, n) { dLength = d.length; _writevCalled = true; } var w2 = new Writable({ writev: _writev }); w2.cork(); w2.write(new Buffer('blerg')); w2.write(new Buffer('blerg')); w2.end(); process.on('exit', function() { assert.equal(w._write, _write); assert(_writeCalled); assert.equal(w2._writev, _writev); assert.equal(dLength, 2); assert(_writevCalled); }); node-v4.8.2/test/parallel/test-stream-writable-decoded-encoding.js000644 000766 000024 00000002020 13070706737 025315 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var stream = require('stream'); var util = require('util'); function MyWritable(fn, options) { stream.Writable.call(this, options); this.fn = fn; } util.inherits(MyWritable, stream.Writable); MyWritable.prototype._write = function(chunk, encoding, callback) { this.fn(Buffer.isBuffer(chunk), typeof chunk, encoding); callback(); }; (function decodeStringsTrue() { var m = new MyWritable(function(isBuffer, type, enc) { assert(isBuffer); assert.equal(type, 'object'); assert.equal(enc, 'buffer'); console.log('ok - decoded string is decoded'); }, { decodeStrings: true }); m.write('some-text', 'utf8'); m.end(); })(); (function decodeStringsFalse() { var m = new MyWritable(function(isBuffer, type, enc) { assert(!isBuffer); assert.equal(type, 'string'); assert.equal(enc, 'utf8'); console.log('ok - un-decoded string is not decoded'); }, { decodeStrings: false }); m.write('some-text', 'utf8'); m.end(); })(); node-v4.8.2/test/parallel/test-stream-writable-ended-state.js000644 000766 000024 00000001011 13070706737 024336 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const stream = require('stream'); const writable = new stream.Writable(); writable._write = (chunk, encoding, cb) => { assert.strictEqual(writable._writableState.ended, false); cb(); }; assert.strictEqual(writable._writableState.ended, false); writable.end('testing ended state', common.mustCall(() => { assert.strictEqual(writable._writableState.ended, true); })); assert.strictEqual(writable._writableState.ended, true); node-v4.8.2/test/parallel/test-stream-writable-finished-state.js000644 000766 000024 00000001076 13070706737 025063 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const stream = require('stream'); const writable = new stream.Writable(); writable._write = (chunk, encoding, cb) => { // The state finished should start in false. assert.strictEqual(writable._writableState.finished, false); cb(); }; writable.on('finish', common.mustCall(() => { assert.strictEqual(writable._writableState.finished, true); })); writable.end('testing finished state', common.mustCall(() => { assert.strictEqual(writable._writableState.finished, true); })); node-v4.8.2/test/parallel/test-stream-writable-needdrain-state.js000644 000766 000024 00000001100 13070706737 025207 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const stream = require('stream'); const assert = require('assert'); const transform = new stream.Transform({ transform: _transform, highWaterMark: 1 }); function _transform(chunk, encoding, cb) { assert.strictEqual(transform._writableState.needDrain, true); cb(); } assert.strictEqual(transform._writableState.needDrain, false); transform.write('asdasd', common.mustCall(() => { assert.strictEqual(transform._writableState.needDrain, false); })); assert.strictEqual(transform._writableState.needDrain, true); node-v4.8.2/test/parallel/test-stream-writableState-ending.js000644 000766 000024 00000001471 13070706737 024420 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const stream = require('stream'); const writable = new stream.Writable(); function testStates(ending, finished, ended) { assert.strictEqual(writable._writableState.ending, ending); assert.strictEqual(writable._writableState.finished, finished); assert.strictEqual(writable._writableState.ended, ended); } writable._write = (chunk, encoding, cb) => { // ending, finished, ended start in false. testStates(false, false, false); cb(); }; writable.on('finish', () => { // ending, finished, ended = true. testStates(true, true, true); }); writable.end('testing function end()', () => { // ending, finished, ended = true. testStates(true, true, true); }); // ending, ended = true. // finished = false. testStates(true, false, true); node-v4.8.2/test/parallel/test-stream-writableState-uncorked-bufferedRequestCount.js000644 000766 000024 00000003165 13070706737 031132 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const stream = require('stream'); const writable = new stream.Writable(); writable._writev = common.mustCall((chunks, cb) => { assert.equal(chunks.length, 2, 'two chunks to write'); cb(); }, 1); writable._write = common.mustCall((chunk, encoding, cb) => { cb(); }, 1); // first cork writable.cork(); assert.strictEqual(writable._writableState.corked, 1); assert.strictEqual(writable._writableState.bufferedRequestCount, 0); // cork again writable.cork(); assert.strictEqual(writable._writableState.corked, 2); // the first chunk is buffered writable.write('first chunk'); assert.strictEqual(writable._writableState.bufferedRequestCount, 1); // first uncork does nothing writable.uncork(); assert.strictEqual(writable._writableState.corked, 1); assert.strictEqual(writable._writableState.bufferedRequestCount, 1); process.nextTick(uncork); // the second chunk is buffered, because we uncork at the end of tick writable.write('second chunk'); assert.strictEqual(writable._writableState.corked, 1); assert.strictEqual(writable._writableState.bufferedRequestCount, 2); function uncork() { // second uncork flushes the buffer writable.uncork(); assert.strictEqual(writable._writableState.corked, 0); assert.strictEqual(writable._writableState.bufferedRequestCount, 0); // verify that end() uncorks correctly writable.cork(); writable.write('third chunk'); writable.end(); // end causes an uncork() as well assert.strictEqual(writable._writableState.corked, 0); assert.strictEqual(writable._writableState.bufferedRequestCount, 0); } node-v4.8.2/test/parallel/test-stream-writev.js000644 000766 000024 00000004637 13070706737 021673 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var stream = require('stream'); var queue = []; for (var decode = 0; decode < 2; decode++) { for (var uncork = 0; uncork < 2; uncork++) { for (var multi = 0; multi < 2; multi++) { queue.push([!!decode, !!uncork, !!multi]); } } } run(); function run() { var t = queue.pop(); if (t) test(t[0], t[1], t[2], run); else console.log('ok'); } function test(decode, uncork, multi, next) { console.log('# decode=%j uncork=%j multi=%j', decode, uncork, multi); var counter = 0; var expectCount = 0; function cnt(msg) { expectCount++; var expect = expectCount; return function(er) { if (er) throw er; counter++; assert.equal(counter, expect); }; } var w = new stream.Writable({ decodeStrings: decode }); w._write = function(chunk, e, cb) { assert(false, 'Should not call _write'); }; var expectChunks = decode ? [ { encoding: 'buffer', chunk: [104, 101, 108, 108, 111, 44, 32] }, { encoding: 'buffer', chunk: [119, 111, 114, 108, 100] }, { encoding: 'buffer', chunk: [33] }, { encoding: 'buffer', chunk: [10, 97, 110, 100, 32, 116, 104, 101, 110, 46, 46, 46] }, { encoding: 'buffer', chunk: [250, 206, 190, 167, 222, 173, 190, 239, 222, 202, 251, 173]} ] : [ { encoding: 'ascii', chunk: 'hello, ' }, { encoding: 'utf8', chunk: 'world' }, { encoding: 'buffer', chunk: [33] }, { encoding: 'binary', chunk: '\nand then...' }, { encoding: 'hex', chunk: 'facebea7deadbeefdecafbad' } ]; var actualChunks; w._writev = function(chunks, cb) { actualChunks = chunks.map(function(chunk) { return { encoding: chunk.encoding, chunk: Buffer.isBuffer(chunk.chunk) ? Array.prototype.slice.call(chunk.chunk) : chunk.chunk }; }); cb(); }; w.cork(); w.write('hello, ', 'ascii', cnt('hello')); w.write('world', 'utf8', cnt('world')); if (multi) w.cork(); w.write(new Buffer('!'), 'buffer', cnt('!')); w.write('\nand then...', 'binary', cnt('and then')); if (multi) w.uncork(); w.write('facebea7deadbeefdecafbad', 'hex', cnt('hex')); if (uncork) w.uncork(); w.end(cnt('end')); w.on('finish', function() { // make sure finish comes after all the write cb cnt('finish')(); assert.deepEqual(expectChunks, actualChunks); next(); }); } node-v4.8.2/test/parallel/test-stream2-base64-single-char-read-end.js000644 000766 000024 00000001323 13070706737 025355 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var R = require('_stream_readable'); var W = require('_stream_writable'); var assert = require('assert'); var src = new R({encoding: 'base64'}); var dst = new W(); var hasRead = false; var accum = []; var timeout; src._read = function(n) { if (!hasRead) { hasRead = true; process.nextTick(function() { src.push(new Buffer('1')); src.push(null); }); } }; dst._write = function(chunk, enc, cb) { accum.push(chunk); cb(); }; src.on('end', function() { assert.equal(Buffer.concat(accum) + '', 'MQ=='); clearTimeout(timeout); }); src.pipe(dst); timeout = setTimeout(function() { common.fail('timed out waiting for _write'); }, 100); node-v4.8.2/test/parallel/test-stream2-compatibility.js000644 000766 000024 00000001057 13070706737 023277 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var R = require('_stream_readable'); var assert = require('assert'); var util = require('util'); var ondataCalled = 0; function TestReader() { R.apply(this); this._buffer = new Buffer(100); this._buffer.fill('x'); this.on('data', function() { ondataCalled++; }); } util.inherits(TestReader, R); TestReader.prototype._read = function(n) { this.push(this._buffer); this._buffer = new Buffer(0); }; new TestReader(); setImmediate(function() { assert.equal(ondataCalled, 1); console.log('ok'); }); node-v4.8.2/test/parallel/test-stream2-decode-partial.js000644 000766 000024 00000001065 13070706737 023302 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const Readable = require('_stream_readable'); const assert = require('assert'); var buf = ''; const euro = new Buffer([0xE2, 0x82, 0xAC]); const cent = new Buffer([0xC2, 0xA2]); const source = Buffer.concat([euro, cent]); const readable = Readable({ encoding: 'utf8' }); readable.push(source.slice(0, 2)); readable.push(source.slice(2, 4)); readable.push(source.slice(4, 6)); readable.push(null); readable.on('data', function(data) { buf += data; }); process.on('exit', function() { assert.strictEqual(buf, '€¢'); }); node-v4.8.2/test/parallel/test-stream2-finish-pipe.js000644 000766 000024 00000000755 13070706737 022645 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var stream = require('stream'); var Buffer = require('buffer').Buffer; var r = new stream.Readable(); r._read = function(size) { r.push(new Buffer(size)); }; var w = new stream.Writable(); w._write = function(data, encoding, cb) { cb(null); }; r.pipe(w); // This might sound unrealistic, but it happens in net.js. When // `socket.allowHalfOpen === false`, EOF will cause `.destroySoon()` call which // ends the writable side of net.Socket. w.end(); node-v4.8.2/test/parallel/test-stream2-httpclient-response-end.js000644 000766 000024 00000001172 13070706737 025202 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var http = require('http'); var msg = 'Hello'; var server = http.createServer(function(req, res) { res.writeHead(200, {'Content-Type': 'text/plain'}); res.end(msg); }).listen(0, function() { http.get({port: this.address().port}, function(res) { var data = ''; res.on('readable', common.mustCall(function() { console.log('readable event'); data += res.read(); })); res.on('end', common.mustCall(function() { console.log('end event'); assert.strictEqual(msg, data); server.close(); })); }); }); node-v4.8.2/test/parallel/test-stream2-large-read-stall.js000644 000766 000024 00000002235 13070706737 023545 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); // If everything aligns so that you do a read(n) of exactly the // remaining buffer, then make sure that 'end' still emits. var READSIZE = 100; var PUSHSIZE = 20; var PUSHCOUNT = 1000; var HWM = 50; var Readable = require('stream').Readable; var r = new Readable({ highWaterMark: HWM }); var rs = r._readableState; r._read = push; r.on('readable', function() { console.error('>> readable'); do { console.error(' > read(%d)', READSIZE); var ret = r.read(READSIZE); console.error(' < %j (%d remain)', ret && ret.length, rs.length); } while (ret && ret.length === READSIZE); console.error('<< after read()', ret && ret.length, rs.needReadable, rs.length); }); r.on('end', common.mustCall(function() { assert.strictEqual(pushes, PUSHCOUNT + 1); })); var pushes = 0; function push() { if (pushes > PUSHCOUNT) return; if (pushes++ === PUSHCOUNT) { console.error(' push(EOF)'); return r.push(null); } console.error(' push #%d', pushes); if (r.push(new Buffer(PUSHSIZE))) setTimeout(push); } node-v4.8.2/test/parallel/test-stream2-objects.js000644 000766 000024 00000013224 13070706737 022056 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var Readable = require('_stream_readable'); var Writable = require('_stream_writable'); var assert = require('assert'); // tiny node-tap lookalike. var tests = []; var count = 0; function test(name, fn) { count++; tests.push([name, fn]); } function run() { var next = tests.shift(); if (!next) return console.error('ok'); var name = next[0]; var fn = next[1]; console.log('# %s', name); fn({ same: assert.deepEqual, equal: assert.equal, end: function() { count--; run(); } }); } // ensure all tests have run process.on('exit', function() { assert.strictEqual(count, 0); }); process.nextTick(run); function toArray(callback) { var stream = new Writable({ objectMode: true }); var list = []; stream.write = function(chunk) { list.push(chunk); }; stream.end = function() { callback(list); }; return stream; } function fromArray(list) { var r = new Readable({ objectMode: true }); r._read = noop; list.forEach(function(chunk) { r.push(chunk); }); r.push(null); return r; } function noop() {} test('can read objects from stream', function(t) { var r = fromArray([{ one: '1'}, { two: '2' }]); var v1 = r.read(); var v2 = r.read(); var v3 = r.read(); assert.deepEqual(v1, { one: '1' }); assert.deepEqual(v2, { two: '2' }); assert.deepEqual(v3, null); t.end(); }); test('can pipe objects into stream', function(t) { var r = fromArray([{ one: '1'}, { two: '2' }]); r.pipe(toArray(function(list) { assert.deepEqual(list, [ { one: '1' }, { two: '2' } ]); t.end(); })); }); test('read(n) is ignored', function(t) { var r = fromArray([{ one: '1'}, { two: '2' }]); var value = r.read(2); assert.deepEqual(value, { one: '1' }); t.end(); }); test('can read objects from _read (sync)', function(t) { var r = new Readable({ objectMode: true }); var list = [{ one: '1'}, { two: '2' }]; r._read = function(n) { var item = list.shift(); r.push(item || null); }; r.pipe(toArray(function(list) { assert.deepEqual(list, [ { one: '1' }, { two: '2' } ]); t.end(); })); }); test('can read objects from _read (async)', function(t) { var r = new Readable({ objectMode: true }); var list = [{ one: '1'}, { two: '2' }]; r._read = function(n) { var item = list.shift(); process.nextTick(function() { r.push(item || null); }); }; r.pipe(toArray(function(list) { assert.deepEqual(list, [ { one: '1' }, { two: '2' } ]); t.end(); })); }); test('can read strings as objects', function(t) { var r = new Readable({ objectMode: true }); r._read = noop; var list = ['one', 'two', 'three']; list.forEach(function(str) { r.push(str); }); r.push(null); r.pipe(toArray(function(array) { assert.deepEqual(array, list); t.end(); })); }); test('read(0) for object streams', function(t) { var r = new Readable({ objectMode: true }); r._read = noop; r.push('foobar'); r.push(null); r.pipe(toArray(function(array) { assert.deepEqual(array, ['foobar']); t.end(); })); }); test('falsey values', function(t) { var r = new Readable({ objectMode: true }); r._read = noop; r.push(false); r.push(0); r.push(''); r.push(null); r.pipe(toArray(function(array) { assert.deepEqual(array, [false, 0, '']); t.end(); })); }); test('high watermark _read', function(t) { var r = new Readable({ highWaterMark: 6, objectMode: true }); var calls = 0; var list = ['1', '2', '3', '4', '5', '6', '7', '8']; r._read = function(n) { calls++; }; list.forEach(function(c) { r.push(c); }); var v = r.read(); assert.strictEqual(calls, 0); assert.strictEqual(v, '1'); var v2 = r.read(); assert.strictEqual(v2, '2'); var v3 = r.read(); assert.strictEqual(v3, '3'); assert.strictEqual(calls, 1); t.end(); }); test('high watermark push', function(t) { var r = new Readable({ highWaterMark: 6, objectMode: true }); r._read = function(n) {}; for (var i = 0; i < 6; i++) { var bool = r.push(i); assert.strictEqual(bool, i !== 5); } t.end(); }); test('can write objects to stream', function(t) { var w = new Writable({ objectMode: true }); w._write = function(chunk, encoding, cb) { assert.deepEqual(chunk, { foo: 'bar' }); cb(); }; w.on('finish', function() { t.end(); }); w.write({ foo: 'bar' }); w.end(); }); test('can write multiple objects to stream', function(t) { var w = new Writable({ objectMode: true }); var list = []; w._write = function(chunk, encoding, cb) { list.push(chunk); cb(); }; w.on('finish', function() { assert.deepEqual(list, [0, 1, 2, 3, 4]); t.end(); }); w.write(0); w.write(1); w.write(2); w.write(3); w.write(4); w.end(); }); test('can write strings as objects', function(t) { var w = new Writable({ objectMode: true }); var list = []; w._write = function(chunk, encoding, cb) { list.push(chunk); process.nextTick(cb); }; w.on('finish', function() { assert.deepEqual(list, ['0', '1', '2', '3', '4']); t.end(); }); w.write('0'); w.write('1'); w.write('2'); w.write('3'); w.write('4'); w.end(); }); test('buffers finish until cb is called', function(t) { var w = new Writable({ objectMode: true }); var called = false; w._write = function(chunk, encoding, cb) { assert.strictEqual(chunk, 'foo'); process.nextTick(function() { called = true; cb(); }); }; w.on('finish', function() { assert.strictEqual(called, true); t.end(); }); w.write('foo'); w.end(); }); node-v4.8.2/test/parallel/test-stream2-pipe-error-handling.js000644 000766 000024 00000003411 13070706737 024270 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var stream = require('stream'); (function testErrorListenerCatches() { var count = 1000; var source = new stream.Readable(); source._read = function(n) { n = Math.min(count, n); count -= n; source.push(new Buffer(n)); }; var unpipedDest; source.unpipe = function(dest) { unpipedDest = dest; stream.Readable.prototype.unpipe.call(this, dest); }; var dest = new stream.Writable(); dest._write = function(chunk, encoding, cb) { cb(); }; source.pipe(dest); var gotErr = null; dest.on('error', function(err) { gotErr = err; }); var unpipedSource; dest.on('unpipe', function(src) { unpipedSource = src; }); var err = new Error('This stream turned into bacon.'); dest.emit('error', err); assert.strictEqual(gotErr, err); assert.strictEqual(unpipedSource, source); assert.strictEqual(unpipedDest, dest); })(); (function testErrorWithoutListenerThrows() { var count = 1000; var source = new stream.Readable(); source._read = function(n) { n = Math.min(count, n); count -= n; source.push(new Buffer(n)); }; var unpipedDest; source.unpipe = function(dest) { unpipedDest = dest; stream.Readable.prototype.unpipe.call(this, dest); }; var dest = new stream.Writable(); dest._write = function(chunk, encoding, cb) { cb(); }; source.pipe(dest); var unpipedSource; dest.on('unpipe', function(src) { unpipedSource = src; }); var err = new Error('This stream turned into bacon.'); var gotErr = null; try { dest.emit('error', err); } catch (e) { gotErr = e; } assert.strictEqual(gotErr, err); assert.strictEqual(unpipedSource, source); assert.strictEqual(unpipedDest, dest); })(); node-v4.8.2/test/parallel/test-stream2-pipe-error-once-listener.js000644 000766 000024 00000001373 13070706737 025260 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var util = require('util'); var stream = require('stream'); var Read = function() { stream.Readable.call(this); }; util.inherits(Read, stream.Readable); Read.prototype._read = function(size) { this.push('x'); this.push(null); }; var Write = function() { stream.Writable.call(this); }; util.inherits(Write, stream.Writable); Write.prototype._write = function(buffer, encoding, cb) { this.emit('error', new Error('boom')); this.emit('alldone'); }; var read = new Read(); var write = new Write(); write.once('error', function(err) {}); write.once('alldone', function(err) { console.log('ok'); }); process.on('exit', function(c) { console.error('error thrown even with listener'); }); read.pipe(write); node-v4.8.2/test/parallel/test-stream2-push.js000644 000766 000024 00000004041 13070706737 021401 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var stream = require('stream'); var Readable = stream.Readable; var Writable = stream.Writable; var assert = require('assert'); var EE = require('events').EventEmitter; // a mock thing a bit like the net.Socket/tcp_wrap.handle interaction stream = new Readable({ highWaterMark: 16, encoding: 'utf8' }); var source = new EE(); stream._read = function() { console.error('stream._read'); readStart(); }; var ended = false; stream.on('end', function() { ended = true; }); source.on('data', function(chunk) { var ret = stream.push(chunk); console.error('data', stream._readableState.length); if (!ret) readStop(); }); source.on('end', function() { stream.push(null); }); var reading = false; function readStart() { console.error('readStart'); reading = true; } function readStop() { console.error('readStop'); reading = false; process.nextTick(function() { var r = stream.read(); if (r !== null) writer.write(r); }); } var writer = new Writable({ decodeStrings: false }); var written = []; var expectWritten = [ 'asdfgasdfgasdfgasdfg', 'asdfgasdfgasdfgasdfg', 'asdfgasdfgasdfgasdfg', 'asdfgasdfgasdfgasdfg', 'asdfgasdfgasdfgasdfg', 'asdfgasdfgasdfgasdfg' ]; writer._write = function(chunk, encoding, cb) { console.error('WRITE %s', chunk); written.push(chunk); process.nextTick(cb); }; writer.on('finish', finish); // now emit some chunks. var chunk = 'asdfg'; var set = 0; readStart(); data(); function data() { assert(reading); source.emit('data', chunk); assert(reading); source.emit('data', chunk); assert(reading); source.emit('data', chunk); assert(reading); source.emit('data', chunk); assert(!reading); if (set++ < 5) setTimeout(data, 10); else end(); } function finish() { console.error('finish'); assert.deepEqual(written, expectWritten); console.log('ok'); } function end() { source.emit('end'); assert(!reading); writer.end(stream.read()); setImmediate(function() { assert(ended); }); } node-v4.8.2/test/parallel/test-stream2-read-sync-stack.js000644 000766 000024 00000001136 13070706737 023414 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var Readable = require('stream').Readable; var r = new Readable(); var N = 256 * 1024; // Go ahead and allow the pathological case for this test. // Yes, it's an infinite loop, that's the point. process.maxTickDepth = N + 2; var reads = 0; r._read = function(n) { var chunk = reads++ === N ? null : new Buffer(1); r.push(chunk); }; r.on('readable', function onReadable() { if (!(r._readableState.length % 256)) console.error('readable', r._readableState.length); r.read(N * 2); }); r.on('end', common.mustCall(function() {})); r.read(0); node-v4.8.2/test/parallel/test-stream2-readable-empty-buffer-no-eof.js000644 000766 000024 00000004575 13070706737 025761 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const Readable = require('stream').Readable; test1(); test2(); function test1() { const r = new Readable(); // should not end when we get a Buffer(0) or '' as the _read result // that just means that there is *temporarily* no data, but to go // ahead and try again later. // // note that this is very unusual. it only works for crypto streams // because the other side of the stream will call read(0) to cycle // data through openssl. that's why we set the timeouts to call // r.read(0) again later, otherwise there is no more work being done // and the process just exits. const buf = Buffer(5).fill('x'); let reads = 5; const timeout = common.platformTimeout(50); r._read = function(n) { switch (reads--) { case 0: return r.push(null); // EOF case 1: return r.push(buf); case 2: setTimeout(r.read.bind(r, 0), timeout); return r.push(new Buffer(0)); // Not-EOF! case 3: setTimeout(r.read.bind(r, 0), timeout); return process.nextTick(function() { return r.push(new Buffer(0)); }); case 4: setTimeout(r.read.bind(r, 0), timeout); return setTimeout(function() { return r.push(new Buffer(0)); }); case 5: return setTimeout(function() { return r.push(buf); }); default: throw new Error('unreachable'); } }; const results = []; function flow() { let chunk; while (null !== (chunk = r.read())) results.push(chunk + ''); } r.on('readable', flow); r.on('end', function() { results.push('EOF'); }); flow(); process.on('exit', function() { assert.deepEqual(results, [ 'xxxxx', 'xxxxx', 'EOF' ]); console.log('ok'); }); } function test2() { var r = new Readable({ encoding: 'base64' }); var reads = 5; r._read = function(n) { if (!reads--) return r.push(null); // EOF else return r.push(new Buffer('x')); }; var results = []; function flow() { var chunk; while (null !== (chunk = r.read())) results.push(chunk + ''); } r.on('readable', flow); r.on('end', function() { results.push('EOF'); }); flow(); process.on('exit', function() { assert.deepEqual(results, [ 'eHh4', 'eHg=', 'EOF' ]); console.log('ok'); }); } node-v4.8.2/test/parallel/test-stream2-readable-from-list.js000644 000766 000024 00000004026 13070706737 024076 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var fromList = require('_stream_readable')._fromList; // tiny node-tap lookalike. var tests = []; var count = 0; function test(name, fn) { count++; tests.push([name, fn]); } function run() { var next = tests.shift(); if (!next) return console.error('ok'); var name = next[0]; var fn = next[1]; console.log('# %s', name); fn({ same: assert.deepEqual, equal: assert.equal, end: function() { count--; run(); } }); } // ensure all tests have run process.on('exit', function() { assert.equal(count, 0); }); process.nextTick(run); test('buffers', function(t) { var list = [ new Buffer('foog'), new Buffer('bark'), new Buffer('bazy'), new Buffer('kuel') ]; // read more than the first element. var ret = fromList(6, { buffer: list, length: 16 }); t.equal(ret.toString(), 'foogba'); // read exactly the first element. ret = fromList(2, { buffer: list, length: 10 }); t.equal(ret.toString(), 'rk'); // read less than the first element. ret = fromList(2, { buffer: list, length: 8 }); t.equal(ret.toString(), 'ba'); // read more than we have. ret = fromList(100, { buffer: list, length: 6 }); t.equal(ret.toString(), 'zykuel'); // all consumed. t.same(list, []); t.end(); }); test('strings', function(t) { var list = [ 'foog', 'bark', 'bazy', 'kuel' ]; // read more than the first element. var ret = fromList(6, { buffer: list, length: 16, decoder: true }); t.equal(ret, 'foogba'); // read exactly the first element. ret = fromList(2, { buffer: list, length: 10, decoder: true }); t.equal(ret, 'rk'); // read less than the first element. ret = fromList(2, { buffer: list, length: 8, decoder: true }); t.equal(ret, 'ba'); // read more than we have. ret = fromList(100, { buffer: list, length: 6, decoder: true }); t.equal(ret, 'zykuel'); // all consumed. t.same(list, []); t.end(); }); node-v4.8.2/test/parallel/test-stream2-readable-legacy-drain.js000644 000766 000024 00000001505 13070706737 024520 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var Stream = require('stream'); var Readable = Stream.Readable; var r = new Readable(); var N = 256; var reads = 0; r._read = function(n) { return r.push(++reads === N ? null : new Buffer(1)); }; r.on('end', common.mustCall(function() {})); var w = new Stream(); w.writable = true; var buffered = 0; w.write = function(c) { buffered += c.length; process.nextTick(drain); return false; }; function drain() { assert(buffered <= 3); buffered = 0; w.emit('drain'); } w.end = common.mustCall(function() {}); // Just for kicks, let's mess with the drain count. // This verifies that even if it gets negative in the // pipe() cleanup function, we'll still function properly. r.on('readable', function() { w.emit('drain'); }); r.pipe(w); node-v4.8.2/test/parallel/test-stream2-readable-non-empty-end.js000644 000766 000024 00000002057 13070706737 024656 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var Readable = require('_stream_readable'); var len = 0; var chunks = new Array(10); for (var i = 1; i <= 10; i++) { chunks[i - 1] = new Buffer(i); len += i; } var test = new Readable(); var n = 0; test._read = function(size) { var chunk = chunks[n++]; setTimeout(function() { test.push(chunk === undefined ? null : chunk); }); }; test.on('end', thrower); function thrower() { throw new Error('this should not happen!'); } var bytesread = 0; test.on('readable', function() { var b = len - bytesread - 1; var res = test.read(b); if (res) { bytesread += res.length; console.error('br=%d len=%d', bytesread, len); setTimeout(next); } test.read(0); }); test.read(0); function next() { // now let's make 'end' happen test.removeListener('end', thrower); test.on('end', common.mustCall(function() {})); // one to get the last byte var r = test.read(); assert(r); assert.equal(r.length, 1); r = test.read(); assert.equal(r, null); } node-v4.8.2/test/parallel/test-stream2-readable-wrap-empty.js000644 000766 000024 00000000612 13070706737 024264 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var Readable = require('_stream_readable'); var EE = require('events').EventEmitter; var oldStream = new EE(); oldStream.pause = function() {}; oldStream.resume = function() {}; var newStream = new Readable().wrap(oldStream); newStream .on('readable', function() {}) .on('end', common.mustCall(function() {})); oldStream.emit('end'); node-v4.8.2/test/parallel/test-stream2-readable-wrap.js000644 000766 000024 00000004133 13070706737 023132 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var Readable = require('_stream_readable'); var Writable = require('_stream_writable'); var EE = require('events').EventEmitter; var testRuns = 0, completedRuns = 0; function runTest(highWaterMark, objectMode, produce) { testRuns++; var old = new EE(); var r = new Readable({ highWaterMark: highWaterMark, objectMode: objectMode }); assert.equal(r, r.wrap(old)); var ended = false; r.on('end', function() { ended = true; }); old.pause = function() { console.error('old.pause()'); old.emit('pause'); flowing = false; }; old.resume = function() { console.error('old.resume()'); old.emit('resume'); flow(); }; var flowing; var chunks = 10; var oldEnded = false; var expected = []; function flow() { flowing = true; while (flowing && chunks-- > 0) { var item = produce(); expected.push(item); console.log('old.emit', chunks, flowing); old.emit('data', item); console.log('after emit', chunks, flowing); } if (chunks <= 0) { oldEnded = true; console.log('old end', chunks, flowing); old.emit('end'); } } var w = new Writable({ highWaterMark: highWaterMark * 2, objectMode: objectMode }); var written = []; w._write = function(chunk, encoding, cb) { console.log('_write', chunk); written.push(chunk); setTimeout(cb); }; w.on('finish', function() { completedRuns++; performAsserts(); }); r.pipe(w); flow(); function performAsserts() { assert(ended); assert(oldEnded); assert.deepEqual(written, expected); } } runTest(100, false, function() { return new Buffer(100); }); runTest(10, false, function() { return new Buffer('xxxxxxxxxx'); }); runTest(1, true, function() { return { foo: 'bar' }; }); var objectChunks = [ 5, 'a', false, 0, '', 'xyz', { x: 4 }, 7, [], 555 ]; runTest(1, true, function() { return objectChunks.shift(); }); process.on('exit', function() { assert.equal(testRuns, completedRuns); console.log('ok'); }); node-v4.8.2/test/parallel/test-stream2-set-encoding.js000644 000766 000024 00000015005 13070706737 023003 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var R = require('_stream_readable'); var util = require('util'); // tiny node-tap lookalike. var tests = []; var count = 0; function test(name, fn) { count++; tests.push([name, fn]); } function run() { var next = tests.shift(); if (!next) return console.error('ok'); var name = next[0]; var fn = next[1]; console.log('# %s', name); fn({ same: assert.deepEqual, equal: assert.equal, end: function() { count--; run(); } }); } // ensure all tests have run process.on('exit', function() { assert.equal(count, 0); }); process.nextTick(run); ///// util.inherits(TestReader, R); function TestReader(n, opts) { R.call(this, opts); this.pos = 0; this.len = n || 100; } TestReader.prototype._read = function(n) { setTimeout(function() { if (this.pos >= this.len) { // double push(null) to test eos handling this.push(null); return this.push(null); } n = Math.min(n, this.len - this.pos); if (n <= 0) { // double push(null) to test eos handling this.push(null); return this.push(null); } this.pos += n; var ret = new Buffer(n); ret.fill('a'); console.log('this.push(ret)', ret); return this.push(ret); }.bind(this), 1); }; test('setEncoding utf8', function(t) { var tr = new TestReader(100); tr.setEncoding('utf8'); var out = []; var expect = [ 'aaaaaaaaaa', 'aaaaaaaaaa', 'aaaaaaaaaa', 'aaaaaaaaaa', 'aaaaaaaaaa', 'aaaaaaaaaa', 'aaaaaaaaaa', 'aaaaaaaaaa', 'aaaaaaaaaa', 'aaaaaaaaaa' ]; tr.on('readable', function flow() { var chunk; while (null !== (chunk = tr.read(10))) out.push(chunk); }); tr.on('end', function() { t.same(out, expect); t.end(); }); }); test('setEncoding hex', function(t) { var tr = new TestReader(100); tr.setEncoding('hex'); var out = []; var expect = [ '6161616161', '6161616161', '6161616161', '6161616161', '6161616161', '6161616161', '6161616161', '6161616161', '6161616161', '6161616161', '6161616161', '6161616161', '6161616161', '6161616161', '6161616161', '6161616161', '6161616161', '6161616161', '6161616161', '6161616161' ]; tr.on('readable', function flow() { var chunk; while (null !== (chunk = tr.read(10))) out.push(chunk); }); tr.on('end', function() { t.same(out, expect); t.end(); }); }); test('setEncoding hex with read(13)', function(t) { var tr = new TestReader(100); tr.setEncoding('hex'); var out = []; var expect = [ '6161616161616', '1616161616161', '6161616161616', '1616161616161', '6161616161616', '1616161616161', '6161616161616', '1616161616161', '6161616161616', '1616161616161', '6161616161616', '1616161616161', '6161616161616', '1616161616161', '6161616161616', '16161' ]; tr.on('readable', function flow() { console.log('readable once'); var chunk; while (null !== (chunk = tr.read(13))) out.push(chunk); }); tr.on('end', function() { console.log('END'); t.same(out, expect); t.end(); }); }); test('setEncoding base64', function(t) { var tr = new TestReader(100); tr.setEncoding('base64'); var out = []; var expect = [ 'YWFhYWFhYW', 'FhYWFhYWFh', 'YWFhYWFhYW', 'FhYWFhYWFh', 'YWFhYWFhYW', 'FhYWFhYWFh', 'YWFhYWFhYW', 'FhYWFhYWFh', 'YWFhYWFhYW', 'FhYWFhYWFh', 'YWFhYWFhYW', 'FhYWFhYWFh', 'YWFhYWFhYW', 'FhYQ==' ]; tr.on('readable', function flow() { var chunk; while (null !== (chunk = tr.read(10))) out.push(chunk); }); tr.on('end', function() { t.same(out, expect); t.end(); }); }); test('encoding: utf8', function(t) { var tr = new TestReader(100, { encoding: 'utf8' }); var out = []; var expect = [ 'aaaaaaaaaa', 'aaaaaaaaaa', 'aaaaaaaaaa', 'aaaaaaaaaa', 'aaaaaaaaaa', 'aaaaaaaaaa', 'aaaaaaaaaa', 'aaaaaaaaaa', 'aaaaaaaaaa', 'aaaaaaaaaa' ]; tr.on('readable', function flow() { var chunk; while (null !== (chunk = tr.read(10))) out.push(chunk); }); tr.on('end', function() { t.same(out, expect); t.end(); }); }); test('encoding: hex', function(t) { var tr = new TestReader(100, { encoding: 'hex' }); var out = []; var expect = [ '6161616161', '6161616161', '6161616161', '6161616161', '6161616161', '6161616161', '6161616161', '6161616161', '6161616161', '6161616161', '6161616161', '6161616161', '6161616161', '6161616161', '6161616161', '6161616161', '6161616161', '6161616161', '6161616161', '6161616161' ]; tr.on('readable', function flow() { var chunk; while (null !== (chunk = tr.read(10))) out.push(chunk); }); tr.on('end', function() { t.same(out, expect); t.end(); }); }); test('encoding: hex with read(13)', function(t) { var tr = new TestReader(100, { encoding: 'hex' }); var out = []; var expect = [ '6161616161616', '1616161616161', '6161616161616', '1616161616161', '6161616161616', '1616161616161', '6161616161616', '1616161616161', '6161616161616', '1616161616161', '6161616161616', '1616161616161', '6161616161616', '1616161616161', '6161616161616', '16161' ]; tr.on('readable', function flow() { var chunk; while (null !== (chunk = tr.read(13))) out.push(chunk); }); tr.on('end', function() { t.same(out, expect); t.end(); }); }); test('encoding: base64', function(t) { var tr = new TestReader(100, { encoding: 'base64' }); var out = []; var expect = [ 'YWFhYWFhYW', 'FhYWFhYWFh', 'YWFhYWFhYW', 'FhYWFhYWFh', 'YWFhYWFhYW', 'FhYWFhYWFh', 'YWFhYWFhYW', 'FhYWFhYWFh', 'YWFhYWFhYW', 'FhYWFhYWFh', 'YWFhYWFhYW', 'FhYWFhYWFh', 'YWFhYWFhYW', 'FhYQ==' ]; tr.on('readable', function flow() { var chunk; while (null !== (chunk = tr.read(10))) out.push(chunk); }); tr.on('end', function() { t.same(out, expect); t.end(); }); }); test('chainable', function(t) { var tr = new TestReader(100); t.equal(tr.setEncoding('utf8'), tr); t.end(); }); node-v4.8.2/test/parallel/test-stream2-transform.js000644 000766 000024 00000025756 13070706737 022455 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var PassThrough = require('_stream_passthrough'); var Transform = require('_stream_transform'); // tiny node-tap lookalike. var tests = []; var count = 0; function test(name, fn) { count++; tests.push([name, fn]); } function run() { var next = tests.shift(); if (!next) return console.error('ok'); var name = next[0]; var fn = next[1]; console.log('# %s', name); fn({ same: assert.deepEqual, equal: assert.equal, ok: assert, end: function() { count--; run(); } }); } // ensure all tests have run process.on('exit', function() { assert.equal(count, 0); }); process.nextTick(run); ///// test('writable side consumption', function(t) { var tx = new Transform({ highWaterMark: 10 }); var transformed = 0; tx._transform = function(chunk, encoding, cb) { transformed += chunk.length; tx.push(chunk); cb(); }; for (var i = 1; i <= 10; i++) { tx.write(new Buffer(i)); } tx.end(); t.equal(tx._readableState.length, 10); t.equal(transformed, 10); t.equal(tx._transformState.writechunk.length, 5); t.same(tx._writableState.getBuffer().map(function(c) { return c.chunk.length; }), [6, 7, 8, 9, 10]); t.end(); }); test('passthrough', function(t) { var pt = new PassThrough(); pt.write(new Buffer('foog')); pt.write(new Buffer('bark')); pt.write(new Buffer('bazy')); pt.write(new Buffer('kuel')); pt.end(); t.equal(pt.read(5).toString(), 'foogb'); t.equal(pt.read(5).toString(), 'arkba'); t.equal(pt.read(5).toString(), 'zykue'); t.equal(pt.read(5).toString(), 'l'); t.end(); }); test('object passthrough', function(t) { var pt = new PassThrough({ objectMode: true }); pt.write(1); pt.write(true); pt.write(false); pt.write(0); pt.write('foo'); pt.write(''); pt.write({ a: 'b'}); pt.end(); t.equal(pt.read(), 1); t.equal(pt.read(), true); t.equal(pt.read(), false); t.equal(pt.read(), 0); t.equal(pt.read(), 'foo'); t.equal(pt.read(), ''); t.same(pt.read(), { a: 'b'}); t.end(); }); test('passthrough constructor', function(t) { const pt = PassThrough(); assert(pt instanceof PassThrough); t.end(); }); test('simple transform', function(t) { var pt = new Transform(); pt._transform = function(c, e, cb) { var ret = new Buffer(c.length); ret.fill('x'); pt.push(ret); cb(); }; pt.write(new Buffer('foog')); pt.write(new Buffer('bark')); pt.write(new Buffer('bazy')); pt.write(new Buffer('kuel')); pt.end(); t.equal(pt.read(5).toString(), 'xxxxx'); t.equal(pt.read(5).toString(), 'xxxxx'); t.equal(pt.read(5).toString(), 'xxxxx'); t.equal(pt.read(5).toString(), 'x'); t.end(); }); test('simple object transform', function(t) { var pt = new Transform({ objectMode: true }); pt._transform = function(c, e, cb) { pt.push(JSON.stringify(c)); cb(); }; pt.write(1); pt.write(true); pt.write(false); pt.write(0); pt.write('foo'); pt.write(''); pt.write({ a: 'b'}); pt.end(); t.equal(pt.read(), '1'); t.equal(pt.read(), 'true'); t.equal(pt.read(), 'false'); t.equal(pt.read(), '0'); t.equal(pt.read(), '"foo"'); t.equal(pt.read(), '""'); t.equal(pt.read(), '{"a":"b"}'); t.end(); }); test('async passthrough', function(t) { var pt = new Transform(); pt._transform = function(chunk, encoding, cb) { setTimeout(function() { pt.push(chunk); cb(); }, 10); }; pt.write(new Buffer('foog')); pt.write(new Buffer('bark')); pt.write(new Buffer('bazy')); pt.write(new Buffer('kuel')); pt.end(); pt.on('finish', function() { t.equal(pt.read(5).toString(), 'foogb'); t.equal(pt.read(5).toString(), 'arkba'); t.equal(pt.read(5).toString(), 'zykue'); t.equal(pt.read(5).toString(), 'l'); t.end(); }); }); test('assymetric transform (expand)', function(t) { var pt = new Transform(); // emit each chunk 2 times. pt._transform = function(chunk, encoding, cb) { setTimeout(function() { pt.push(chunk); setTimeout(function() { pt.push(chunk); cb(); }, 10); }, 10); }; pt.write(new Buffer('foog')); pt.write(new Buffer('bark')); pt.write(new Buffer('bazy')); pt.write(new Buffer('kuel')); pt.end(); pt.on('finish', function() { t.equal(pt.read(5).toString(), 'foogf'); t.equal(pt.read(5).toString(), 'oogba'); t.equal(pt.read(5).toString(), 'rkbar'); t.equal(pt.read(5).toString(), 'kbazy'); t.equal(pt.read(5).toString(), 'bazyk'); t.equal(pt.read(5).toString(), 'uelku'); t.equal(pt.read(5).toString(), 'el'); t.end(); }); }); test('assymetric transform (compress)', function(t) { var pt = new Transform(); // each output is the first char of 3 consecutive chunks, // or whatever's left. pt.state = ''; pt._transform = function(chunk, encoding, cb) { if (!chunk) chunk = ''; var s = chunk.toString(); setTimeout(function() { this.state += s.charAt(0); if (this.state.length === 3) { pt.push(new Buffer(this.state)); this.state = ''; } cb(); }.bind(this), 10); }; pt._flush = function(cb) { // just output whatever we have. pt.push(new Buffer(this.state)); this.state = ''; cb(); }; pt.write(new Buffer('aaaa')); pt.write(new Buffer('bbbb')); pt.write(new Buffer('cccc')); pt.write(new Buffer('dddd')); pt.write(new Buffer('eeee')); pt.write(new Buffer('aaaa')); pt.write(new Buffer('bbbb')); pt.write(new Buffer('cccc')); pt.write(new Buffer('dddd')); pt.write(new Buffer('eeee')); pt.write(new Buffer('aaaa')); pt.write(new Buffer('bbbb')); pt.write(new Buffer('cccc')); pt.write(new Buffer('dddd')); pt.end(); // 'abcdeabcdeabcd' pt.on('finish', function() { t.equal(pt.read(5).toString(), 'abcde'); t.equal(pt.read(5).toString(), 'abcde'); t.equal(pt.read(5).toString(), 'abcd'); t.end(); }); }); // this tests for a stall when data is written to a full stream // that has empty transforms. test('complex transform', function(t) { var count = 0; var saved = null; var pt = new Transform({highWaterMark: 3}); pt._transform = function(c, e, cb) { if (count++ === 1) saved = c; else { if (saved) { pt.push(saved); saved = null; } pt.push(c); } cb(); }; pt.once('readable', function() { process.nextTick(function() { pt.write(new Buffer('d')); pt.write(new Buffer('ef'), function() { pt.end(); t.end(); }); t.equal(pt.read().toString(), 'abcdef'); t.equal(pt.read(), null); }); }); pt.write(new Buffer('abc')); }); test('passthrough event emission', function(t) { var pt = new PassThrough(); var emits = 0; pt.on('readable', function() { console.error('>>> emit readable %d', emits); emits++; }); pt.write(new Buffer('foog')); console.error('need emit 0'); pt.write(new Buffer('bark')); console.error('should have emitted readable now 1 === %d', emits); t.equal(emits, 1); t.equal(pt.read(5).toString(), 'foogb'); t.equal(pt.read(5) + '', 'null'); console.error('need emit 1'); pt.write(new Buffer('bazy')); console.error('should have emitted, but not again'); pt.write(new Buffer('kuel')); console.error('should have emitted readable now 2 === %d', emits); t.equal(emits, 2); t.equal(pt.read(5).toString(), 'arkba'); t.equal(pt.read(5).toString(), 'zykue'); t.equal(pt.read(5), null); console.error('need emit 2'); pt.end(); t.equal(emits, 3); t.equal(pt.read(5).toString(), 'l'); t.equal(pt.read(5), null); console.error('should not have emitted again'); t.equal(emits, 3); t.end(); }); test('passthrough event emission reordered', function(t) { var pt = new PassThrough(); var emits = 0; pt.on('readable', function() { console.error('emit readable', emits); emits++; }); pt.write(new Buffer('foog')); console.error('need emit 0'); pt.write(new Buffer('bark')); console.error('should have emitted readable now 1 === %d', emits); t.equal(emits, 1); t.equal(pt.read(5).toString(), 'foogb'); t.equal(pt.read(5), null); console.error('need emit 1'); pt.once('readable', function() { t.equal(pt.read(5).toString(), 'arkba'); t.equal(pt.read(5), null); console.error('need emit 2'); pt.once('readable', function() { t.equal(pt.read(5).toString(), 'zykue'); t.equal(pt.read(5), null); pt.once('readable', function() { t.equal(pt.read(5).toString(), 'l'); t.equal(pt.read(5), null); t.equal(emits, 4); t.end(); }); pt.end(); }); pt.write(new Buffer('kuel')); }); pt.write(new Buffer('bazy')); }); test('passthrough facaded', function(t) { console.error('passthrough facaded'); var pt = new PassThrough(); var datas = []; pt.on('data', function(chunk) { datas.push(chunk.toString()); }); pt.on('end', function() { t.same(datas, ['foog', 'bark', 'bazy', 'kuel']); t.end(); }); pt.write(new Buffer('foog')); setTimeout(function() { pt.write(new Buffer('bark')); setTimeout(function() { pt.write(new Buffer('bazy')); setTimeout(function() { pt.write(new Buffer('kuel')); setTimeout(function() { pt.end(); }, 10); }, 10); }, 10); }, 10); }); test('object transform (json parse)', function(t) { console.error('json parse stream'); var jp = new Transform({ objectMode: true }); jp._transform = function(data, encoding, cb) { try { jp.push(JSON.parse(data)); cb(); } catch (er) { cb(er); } }; // anything except null/undefined is fine. // those are "magic" in the stream API, because they signal EOF. var objects = [ { foo: 'bar' }, 100, 'string', { nested: { things: [ { foo: 'bar' }, 100, 'string' ] } } ]; var ended = false; jp.on('end', function() { ended = true; }); objects.forEach(function(obj) { jp.write(JSON.stringify(obj)); var res = jp.read(); t.same(res, obj); }); jp.end(); // read one more time to get the 'end' event jp.read(); process.nextTick(function() { t.ok(ended); t.end(); }); }); test('object transform (json stringify)', function(t) { console.error('json parse stream'); var js = new Transform({ objectMode: true }); js._transform = function(data, encoding, cb) { try { js.push(JSON.stringify(data)); cb(); } catch (er) { cb(er); } }; // anything except null/undefined is fine. // those are "magic" in the stream API, because they signal EOF. var objects = [ { foo: 'bar' }, 100, 'string', { nested: { things: [ { foo: 'bar' }, 100, 'string' ] } } ]; var ended = false; js.on('end', function() { ended = true; }); objects.forEach(function(obj) { js.write(obj); var res = js.read(); t.equal(res, JSON.stringify(obj)); }); js.end(); // read one more time to get the 'end' event js.read(); process.nextTick(function() { t.ok(ended); t.end(); }); }); node-v4.8.2/test/parallel/test-stream2-unpipe-drain.js000644 000766 000024 00000002047 13070706737 023021 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const stream = require('stream'); const util = require('util'); function TestWriter() { stream.Writable.call(this); } util.inherits(TestWriter, stream.Writable); TestWriter.prototype._write = function(buffer, encoding, callback) { console.log('write called'); // super slow write stream (callback never called) }; const dest = new TestWriter(); function TestReader(id) { stream.Readable.call(this); this.reads = 0; } util.inherits(TestReader, stream.Readable); TestReader.prototype._read = function(size) { this.reads += 1; this.push(Buffer.alloc(size)); }; const src1 = new TestReader(); const src2 = new TestReader(); src1.pipe(dest); src1.once('readable', function() { process.nextTick(function() { src2.pipe(dest); src2.once('readable', function() { process.nextTick(function() { src1.unpipe(dest); }); }); }); }); process.on('exit', function() { assert.strictEqual(src1.reads, 2); assert.strictEqual(src2.reads, 2); }); node-v4.8.2/test/parallel/test-stream2-unpipe-leak.js000644 000766 000024 00000002546 13070706737 022644 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var stream = require('stream'); var chunk = new Buffer('hallo'); var util = require('util'); function TestWriter() { stream.Writable.call(this); } util.inherits(TestWriter, stream.Writable); TestWriter.prototype._write = function(buffer, encoding, callback) { callback(null); }; var dest = new TestWriter(); // Set this high so that we'd trigger a nextTick warning // and/or RangeError if we do maybeReadMore wrong. function TestReader() { stream.Readable.call(this, { highWaterMark: 0x10000 }); } util.inherits(TestReader, stream.Readable); TestReader.prototype._read = function(size) { this.push(chunk); }; var src = new TestReader(); for (var i = 0; i < 10; i++) { src.pipe(dest); src.unpipe(dest); } assert.equal(src.listeners('end').length, 0); assert.equal(src.listeners('readable').length, 0); assert.equal(dest.listeners('unpipe').length, 0); assert.equal(dest.listeners('drain').length, 0); assert.equal(dest.listeners('error').length, 0); assert.equal(dest.listeners('close').length, 0); assert.equal(dest.listeners('finish').length, 0); console.error(src._readableState); process.on('exit', function() { src._readableState.buffer.length = 0; console.error(src._readableState); assert(src._readableState.length >= src._readableState.highWaterMark); console.log('ok'); }); node-v4.8.2/test/parallel/test-stream2-writable.js000644 000766 000024 00000017224 13070706737 022242 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var W = require('_stream_writable'); var D = require('_stream_duplex'); var assert = require('assert'); var util = require('util'); util.inherits(TestWriter, W); function TestWriter() { W.apply(this, arguments); this.buffer = []; this.written = 0; } TestWriter.prototype._write = function(chunk, encoding, cb) { // simulate a small unpredictable latency setTimeout(function() { this.buffer.push(chunk.toString()); this.written += chunk.length; cb(); }.bind(this), Math.floor(Math.random() * 10)); }; var chunks = new Array(50); for (var i = 0; i < chunks.length; i++) { chunks[i] = new Array(i + 1).join('x'); } // tiny node-tap lookalike. var tests = []; var count = 0; function test(name, fn) { count++; tests.push([name, fn]); } function run() { var next = tests.shift(); if (!next) return console.error('ok'); var name = next[0]; var fn = next[1]; console.log('# %s', name); fn({ same: assert.deepStrictEqual, equal: assert.strictEqual, end: function() { count--; run(); } }); } // ensure all tests have run process.on('exit', function() { assert.strictEqual(count, 0); }); process.nextTick(run); test('write fast', function(t) { var tw = new TestWriter({ highWaterMark: 100 }); tw.on('finish', function() { t.same(tw.buffer, chunks, 'got chunks in the right order'); t.end(); }); chunks.forEach(function(chunk) { // screw backpressure. Just buffer it all up. tw.write(chunk); }); tw.end(); }); test('write slow', function(t) { var tw = new TestWriter({ highWaterMark: 100 }); tw.on('finish', function() { t.same(tw.buffer, chunks, 'got chunks in the right order'); t.end(); }); var i = 0; (function W() { tw.write(chunks[i++]); if (i < chunks.length) setTimeout(W, 10); else tw.end(); })(); }); test('write backpressure', function(t) { var tw = new TestWriter({ highWaterMark: 50 }); var drains = 0; tw.on('finish', function() { t.same(tw.buffer, chunks, 'got chunks in the right order'); t.equal(drains, 17); t.end(); }); tw.on('drain', function() { drains++; }); var i = 0; (function W() { do { var ret = tw.write(chunks[i++]); } while (ret !== false && i < chunks.length); if (i < chunks.length) { assert(tw._writableState.length >= 50); tw.once('drain', W); } else { tw.end(); } })(); }); test('write bufferize', function(t) { var tw = new TestWriter({ highWaterMark: 100 }); var encodings = [ 'hex', 'utf8', 'utf-8', 'ascii', 'binary', 'base64', 'ucs2', 'ucs-2', 'utf16le', 'utf-16le', undefined ]; tw.on('finish', function() { t.same(tw.buffer, chunks, 'got the expected chunks'); }); chunks.forEach(function(chunk, i) { var enc = encodings[ i % encodings.length ]; chunk = new Buffer(chunk); tw.write(chunk.toString(enc), enc); }); t.end(); }); test('write no bufferize', function(t) { var tw = new TestWriter({ highWaterMark: 100, decodeStrings: false }); tw._write = function(chunk, encoding, cb) { assert(typeof chunk === 'string'); chunk = new Buffer(chunk, encoding); return TestWriter.prototype._write.call(this, chunk, encoding, cb); }; var encodings = [ 'hex', 'utf8', 'utf-8', 'ascii', 'binary', 'base64', 'ucs2', 'ucs-2', 'utf16le', 'utf-16le', undefined ]; tw.on('finish', function() { t.same(tw.buffer, chunks, 'got the expected chunks'); }); chunks.forEach(function(chunk, i) { var enc = encodings[ i % encodings.length ]; chunk = new Buffer(chunk); tw.write(chunk.toString(enc), enc); }); t.end(); }); test('write callbacks', function(t) { var callbacks = chunks.map(function(chunk, i) { return [i, function() { callbacks._called[i] = chunk; }]; }).reduce(function(set, x) { set['callback-' + x[0]] = x[1]; return set; }, {}); callbacks._called = []; var tw = new TestWriter({ highWaterMark: 100 }); tw.on('finish', function() { process.nextTick(function() { t.same(tw.buffer, chunks, 'got chunks in the right order'); t.same(callbacks._called, chunks, 'called all callbacks'); t.end(); }); }); chunks.forEach(function(chunk, i) { tw.write(chunk, callbacks['callback-' + i]); }); tw.end(); }); test('end callback', function(t) { var tw = new TestWriter(); tw.end(function() { t.end(); }); }); test('end callback with chunk', function(t) { var tw = new TestWriter(); tw.end(new Buffer('hello world'), function() { t.end(); }); }); test('end callback with chunk and encoding', function(t) { var tw = new TestWriter(); tw.end('hello world', 'ascii', function() { t.end(); }); }); test('end callback after .write() call', function(t) { var tw = new TestWriter(); tw.write(new Buffer('hello world')); tw.end(function() { t.end(); }); }); test('end callback called after write callback', function(t) { var tw = new TestWriter(); var writeCalledback = false; tw.write(new Buffer('hello world'), function() { writeCalledback = true; }); tw.end(function() { t.equal(writeCalledback, true); t.end(); }); }); test('encoding should be ignored for buffers', function(t) { var tw = new W(); var hex = '018b5e9a8f6236ffe30e31baf80d2cf6eb'; tw._write = function(chunk) { t.equal(chunk.toString('hex'), hex); t.end(); }; var buf = new Buffer(hex, 'hex'); tw.write(buf, 'binary'); }); test('writables are not pipable', function(t) { var w = new W(); w._write = function() {}; var gotError = false; w.on('error', function() { gotError = true; }); w.pipe(process.stdout); assert(gotError); t.end(); }); test('duplexes are pipable', function(t) { var d = new D(); d._read = function() {}; d._write = function() {}; var gotError = false; d.on('error', function() { gotError = true; }); d.pipe(process.stdout); assert(!gotError); t.end(); }); test('end(chunk) two times is an error', function(t) { var w = new W(); w._write = function() {}; var gotError = false; w.on('error', function(er) { gotError = true; t.equal(er.message, 'write after end'); }); w.end('this is the end'); w.end('and so is this'); process.nextTick(function() { assert(gotError); t.end(); }); }); test('dont end while writing', function(t) { var w = new W(); var wrote = false; w._write = function(chunk, e, cb) { assert(!this.writing); wrote = true; this.writing = true; setTimeout(function() { this.writing = false; cb(); }, 1); }; w.on('finish', function() { assert(wrote); t.end(); }); w.write(Buffer(0)); w.end(); }); test('finish does not come before write cb', function(t) { var w = new W(); var writeCb = false; w._write = function(chunk, e, cb) { setTimeout(function() { writeCb = true; cb(); }, 10); }; w.on('finish', function() { assert(writeCb); t.end(); }); w.write(Buffer(0)); w.end(); }); test('finish does not come before sync _write cb', function(t) { var w = new W(); var writeCb = false; w._write = function(chunk, e, cb) { cb(); }; w.on('finish', function() { assert(writeCb); t.end(); }); w.write(Buffer.alloc(0), function() { writeCb = true; }); w.end(); }); test('finish is emitted if last chunk is empty', function(t) { var w = new W(); w._write = function(chunk, e, cb) { process.nextTick(cb); }; w.on('finish', function() { t.end(); }); w.write(Buffer(1)); w.end(Buffer(0)); }); node-v4.8.2/test/parallel/test-stream3-cork-end.js000644 000766 000024 00000004162 13070706737 022131 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const stream = require('stream'); const Writable = stream.Writable; // Test the buffering behaviour of Writable streams. // // The call to cork() triggers storing chunks which are flushed // on calling end() and the stream subsequently ended. // // node version target: 0.12 const expectedChunks = ['please', 'buffer', 'me', 'kindly']; var inputChunks = expectedChunks.slice(0); var seenChunks = []; var seenEnd = false; var w = new Writable(); // lets arrange to store the chunks w._write = function(chunk, encoding, cb) { // stream end event is not seen before the last write assert.ok(!seenEnd); // default encoding given none was specified assert.equal(encoding, 'buffer'); seenChunks.push(chunk); cb(); }; // lets record the stream end event w.on('finish', () => { seenEnd = true; }); function writeChunks(remainingChunks, callback) { var writeChunk = remainingChunks.shift(); var writeState; if (writeChunk) { setImmediate(() => { writeState = w.write(writeChunk); // we were not told to stop writing assert.ok(writeState); writeChunks(remainingChunks, callback); }); } else { callback(); } } // do an initial write w.write('stuff'); // the write was immediate assert.equal(seenChunks.length, 1); // reset the seen chunks seenChunks = []; // trigger stream buffering w.cork(); // write the bufferedChunks writeChunks(inputChunks, () => { // should not have seen anything yet assert.equal(seenChunks.length, 0); // trigger flush and ending the stream w.end(); // stream should not ended in current tick assert.ok(!seenEnd); // buffered bytes should be seen in current tick assert.equal(seenChunks.length, 4); // did the chunks match for (var i = 0, l = expectedChunks.length; i < l; i++) { var seen = seenChunks[i]; // there was a chunk assert.ok(seen); var expected = new Buffer(expectedChunks[i]); // it was what we expected assert.ok(seen.equals(expected)); } setImmediate(() => { // stream should have ended in next tick assert.ok(seenEnd); }); }); node-v4.8.2/test/parallel/test-stream3-cork-uncork.js000644 000766 000024 00000003725 13070706737 022670 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const stream = require('stream'); const Writable = stream.Writable; // Test the buffering behaviour of Writable streams. // // The call to cork() triggers storing chunks which are flushed // on calling uncork() in the same tick. // // node version target: 0.12 const expectedChunks = ['please', 'buffer', 'me', 'kindly']; var inputChunks = expectedChunks.slice(0); var seenChunks = []; var seenEnd = false; var w = new Writable(); // lets arrange to store the chunks w._write = function(chunk, encoding, cb) { // default encoding given none was specified assert.equal(encoding, 'buffer'); seenChunks.push(chunk); cb(); }; // lets record the stream end event w.on('finish', () => { seenEnd = true; }); function writeChunks(remainingChunks, callback) { var writeChunk = remainingChunks.shift(); var writeState; if (writeChunk) { setImmediate(() => { writeState = w.write(writeChunk); // we were not told to stop writing assert.ok(writeState); writeChunks(remainingChunks, callback); }); } else { callback(); } } // do an initial write w.write('stuff'); // the write was immediate assert.equal(seenChunks.length, 1); // reset the chunks seen so far seenChunks = []; // trigger stream buffering w.cork(); // write the bufferedChunks writeChunks(inputChunks, () => { // should not have seen anything yet assert.equal(seenChunks.length, 0); // trigger writing out the buffer w.uncork(); // buffered bytes shoud be seen in current tick assert.equal(seenChunks.length, 4); // did the chunks match for (var i = 0, l = expectedChunks.length; i < l; i++) { var seen = seenChunks[i]; // there was a chunk assert.ok(seen); var expected = new Buffer(expectedChunks[i]); // it was what we expected assert.ok(seen.equals(expected)); } setImmediate(() => { // the stream should not have been ended assert.ok(!seenEnd); }); }); node-v4.8.2/test/parallel/test-stream3-pause-then-read.js000644 000766 000024 00000006012 13070706737 023405 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var stream = require('stream'); var Readable = stream.Readable; var Writable = stream.Writable; var totalChunks = 100; var chunkSize = 99; var expectTotalData = totalChunks * chunkSize; var expectEndingData = expectTotalData; var r = new Readable({ highWaterMark: 1000 }); var chunks = totalChunks; r._read = function(n) { if (!(chunks % 2)) setImmediate(push); else if (!(chunks % 3)) process.nextTick(push); else push(); }; var totalPushed = 0; function push() { var chunk = chunks-- > 0 ? new Buffer(chunkSize) : null; if (chunk) { totalPushed += chunk.length; chunk.fill('x'); } r.push(chunk); } read100(); // first we read 100 bytes function read100() { readn(100, onData); } function readn(n, then) { console.error('read %d', n); expectEndingData -= n; (function read() { var c = r.read(n); if (!c) r.once('readable', read); else { assert.equal(c.length, n); assert(!r._readableState.flowing); then(); } })(); } // then we listen to some data events function onData() { expectEndingData -= 100; console.error('onData'); var seen = 0; r.on('data', function od(c) { seen += c.length; if (seen >= 100) { // seen enough r.removeListener('data', od); r.pause(); if (seen > 100) { // oh no, seen too much! // put the extra back. var diff = seen - 100; r.unshift(c.slice(c.length - diff)); console.error('seen too much', seen, diff); } // Nothing should be lost in between setImmediate(pipeLittle); } }); } // Just pipe 200 bytes, then unshift the extra and unpipe function pipeLittle() { expectEndingData -= 200; console.error('pipe a little'); var w = new Writable(); var written = 0; w.on('finish', function() { assert.equal(written, 200); setImmediate(read1234); }); w._write = function(chunk, encoding, cb) { written += chunk.length; if (written >= 200) { r.unpipe(w); w.end(); cb(); if (written > 200) { var diff = written - 200; written -= diff; r.unshift(chunk.slice(chunk.length - diff)); } } else { setImmediate(cb); } }; r.pipe(w); } // now read 1234 more bytes function read1234() { readn(1234, resumePause); } function resumePause() { console.error('resumePause'); // don't read anything, just resume and re-pause a whole bunch r.resume(); r.pause(); r.resume(); r.pause(); r.resume(); r.pause(); r.resume(); r.pause(); r.resume(); r.pause(); setImmediate(pipe); } function pipe() { console.error('pipe the rest'); var w = new Writable(); var written = 0; w._write = function(chunk, encoding, cb) { written += chunk.length; cb(); }; w.on('finish', function() { console.error('written', written, totalPushed); assert.equal(written, expectEndingData); assert.equal(totalPushed, expectTotalData); console.log('ok'); }); r.pipe(w); } node-v4.8.2/test/parallel/test-string-decoder-end.js000644 000766 000024 00000002617 13070706737 022533 0ustar00iojsstaff000000 000000 'use strict'; // verify that the string decoder works getting 1 byte at a time, // the whole buffer at once, and that both match the .toString(enc) // result of the entire buffer. require('../common'); var assert = require('assert'); var SD = require('string_decoder').StringDecoder; var encodings = ['base64', 'hex', 'utf8', 'utf16le', 'ucs2']; var bufs = [ '☃💩', 'asdf' ].map(function(b) { return new Buffer(b); }); // also test just arbitrary bytes from 0-15. for (var i = 1; i <= 16; i++) { var bytes = new Array(i).join('.').split('.').map(function(_, j) { return j + 0x78; }); bufs.push(new Buffer(bytes)); } encodings.forEach(testEncoding); console.log('ok'); function testEncoding(encoding) { bufs.forEach(function(buf) { testBuf(encoding, buf); }); } function testBuf(encoding, buf) { console.error('# %s', encoding, buf); // write one byte at a time. var s = new SD(encoding); var res1 = ''; for (var i = 0; i < buf.length; i++) { res1 += s.write(buf.slice(i, i + 1)); } res1 += s.end(); // write the whole buffer at once. var res2 = ''; s = new SD(encoding); res2 += s.write(buf); res2 += s.end(); // .toString() on the buffer var res3 = buf.toString(encoding); console.log('expect=%j', res3); assert.equal(res1, res3, 'one byte at a time should match toString'); assert.equal(res2, res3, 'all bytes at once should match toString'); } node-v4.8.2/test/parallel/test-string-decoder.js000644 000766 000024 00000006014 13070706737 021762 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var StringDecoder = require('string_decoder').StringDecoder; process.stdout.write('scanning '); // UTF-8 test('utf-8', new Buffer('$', 'utf-8'), '$'); test('utf-8', new Buffer('¢', 'utf-8'), '¢'); test('utf-8', new Buffer('€', 'utf-8'), '€'); test('utf-8', new Buffer('𤭢', 'utf-8'), '𤭢'); // A mixed ascii and non-ascii string // Test stolen from deps/v8/test/cctest/test-strings.cc // U+02E4 -> CB A4 // U+0064 -> 64 // U+12E4 -> E1 8B A4 // U+0030 -> 30 // U+3045 -> E3 81 85 test( 'utf-8', new Buffer([0xCB, 0xA4, 0x64, 0xE1, 0x8B, 0xA4, 0x30, 0xE3, 0x81, 0x85]), '\u02e4\u0064\u12e4\u0030\u3045' ); // UCS-2 test('ucs2', new Buffer('ababc', 'ucs2'), 'ababc'); // UTF-16LE test('ucs2', new Buffer('3DD84DDC', 'hex'), '\ud83d\udc4d'); // thumbs up console.log(' crayon!'); // test verifies that StringDecoder will correctly decode the given input // buffer with the given encoding to the expected output. It will attempt all // possible ways to write() the input buffer, see writeSequences(). The // singleSequence allows for easy debugging of a specific sequence which is // useful in case of test failures. function test(encoding, input, expected, singleSequence) { var sequences; if (!singleSequence) { sequences = writeSequences(input.length); } else { sequences = [singleSequence]; } sequences.forEach(function(sequence) { var decoder = new StringDecoder(encoding); var output = ''; sequence.forEach(function(write) { output += decoder.write(input.slice(write[0], write[1])); }); process.stdout.write('.'); if (output !== expected) { var message = 'Expected "' + unicodeEscape(expected) + '", ' + 'but got "' + unicodeEscape(output) + '"\n' + 'Write sequence: ' + JSON.stringify(sequence) + '\n' + 'Decoder charBuffer: 0x' + decoder.charBuffer.toString('hex') + '\n' + 'Full Decoder State: ' + JSON.stringify(decoder, null, 2); assert.fail(output, expected, message); } }); } // unicodeEscape prints the str contents as unicode escape codes. function unicodeEscape(str) { var r = ''; for (var i = 0; i < str.length; i++) { r += '\\u' + str.charCodeAt(i).toString(16); } return r; } // writeSequences returns an array of arrays that describes all possible ways a // buffer of the given length could be split up and passed to sequential write // calls. // // e.G. writeSequences(3) will return: [ // [ [ 0, 3 ] ], // [ [ 0, 2 ], [ 2, 3 ] ], // [ [ 0, 1 ], [ 1, 3 ] ], // [ [ 0, 1 ], [ 1, 2 ], [ 2, 3 ] ] // ] function writeSequences(length, start, sequence) { if (start === undefined) { start = 0; sequence = []; } else if (start === length) { return [sequence]; } var sequences = []; for (var end = length; end > start; end--) { var subSequence = sequence.concat([[start, end]]); var subSequences = writeSequences(length, end, subSequence, sequences); sequences = sequences.concat(subSequences); } return sequences; } node-v4.8.2/test/parallel/test-stringbytes-external.js000644 000766 000024 00000006344 13070706737 023254 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); // minimum string size to overflow into external string space var EXTERN_APEX = 0xFBEE9; // manually controlled string for checking binary output var ucs2_control = 'a\u0000'; var write_str = 'a'; // first do basic checks var b = new Buffer(write_str, 'ucs2'); var c = b.toString('binary'); assert.equal(b[0], 0x61); assert.equal(b[1], 0); assert.equal(ucs2_control, c); // now create big strings var size = 1 + (1 << 20); write_str = Array(size).join(write_str); ucs2_control = Array(size).join(ucs2_control); // check resultant buffer and output string b = new Buffer(write_str, 'ucs2'); // check fist Buffer created from write string for (let i = 0; i < b.length; i += 2) { assert.equal(b[i], 0x61); assert.equal(b[i + 1], 0); } // create another string to create an external string var b_bin = b.toString('binary'); var b_ucs = b.toString('ucs2'); // check control against external binary string assert.equal(ucs2_control, b_bin); // create buffer copy from external var c_bin = new Buffer(b_bin, 'binary'); var c_ucs = new Buffer(b_ucs, 'ucs2'); // make sure they're the same length assert.equal(c_bin.length, c_ucs.length); // make sure Buffers from externals are the same for (let i = 0; i < c_bin.length; i++) { assert.equal(c_bin[i], c_ucs[i]); } // check resultant strings assert.equal(c_bin.toString('ucs2'), c_ucs.toString('ucs2')); assert.equal(c_bin.toString('binary'), ucs2_control); assert.equal(c_ucs.toString('binary'), ucs2_control); // now let's test BASE64 and HEX ecoding/decoding var RADIOS = 2; var PRE_HALF_APEX = Math.ceil(EXTERN_APEX / 2) - RADIOS; var PRE_3OF4_APEX = Math.ceil((EXTERN_APEX / 4) * 3) - RADIOS; (function() { for (var j = 0; j < RADIOS * 2; j += 1) { var datum = b; var slice = datum.slice(0, PRE_HALF_APEX + j); var slice2 = datum.slice(0, PRE_HALF_APEX + j + 2); var pumped_string = slice.toString('hex'); var pumped_string2 = slice2.toString('hex'); var decoded = new Buffer(pumped_string, 'hex'); // the string are the same? for (var k = 0; k < pumped_string.length; ++k) { assert.equal(pumped_string[k], pumped_string2[k]); } // the recoded buffer is the same? for (var i = 0; i < decoded.length; ++i) { assert.equal(datum[i], decoded[i]); } } })(); (function() { for (var j = 0; j < RADIOS * 2; j += 1) { var datum = b; var slice = datum.slice(0, PRE_3OF4_APEX + j); var slice2 = datum.slice(0, PRE_3OF4_APEX + j + 2); var pumped_string = slice.toString('base64'); var pumped_string2 = slice2.toString('base64'); var decoded = new Buffer(pumped_string, 'base64'); // the string are the same? for (var k = 0; k < pumped_string.length - 3; ++k) { assert.equal(pumped_string[k], pumped_string2[k]); } // the recoded buffer is the same? for (var i = 0; i < decoded.length; ++i) { assert.equal(datum[i], decoded[i]); } } })(); // https://github.com/nodejs/node/issues/1024 (function() { var a = Array(1 << 20).join('x'); var b = Buffer(a, 'ucs2').toString('ucs2'); var c = Buffer(b, 'utf8').toString('utf8'); assert.equal(a.length, b.length); assert.equal(b.length, c.length); assert.equal(a, b); assert.equal(b, c); })(); node-v4.8.2/test/parallel/test-sync-fileread.js000644 000766 000024 00000000411 13070706737 021571 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const path = require('path'); const fs = require('fs'); const fixture = path.join(common.fixturesDir, 'x.txt'); assert.strictEqual(fs.readFileSync(fixture).toString(), 'xyz\n'); node-v4.8.2/test/parallel/test-sync-io-option.js000644 000766 000024 00000001720 13070706737 021737 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const execFile = require('child_process').execFile; if (process.argv[2] === 'child') { setImmediate(function() { require('fs').readFileSync(__filename); process.exit(); }); } else { (function runTest(flags) { var execArgv = [flags.pop()]; var args = [__filename, 'child']; var cntr = 0; args = execArgv.concat(args); if (!args[0]) args.shift(); execFile(process.execPath, args, function(err, stdout, stderr) { assert.equal(err, null); assert.equal(stdout, ''); if (/^WARNING[\s\S]*fs\.readFileSync/.test(stderr)) cntr++; if (args[0] === '--trace-sync-io') { assert.equal(cntr, 1); } else if (args[0] === __filename) { assert.equal(cntr, 0); } else { throw new Error('UNREACHABLE'); } if (flags.length > 0) setImmediate(runTest, flags); }); }(['--trace-sync-io', ''])); } node-v4.8.2/test/parallel/test-sys.js000644 000766 000024 00000000307 13070706737 017666 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var sys = require('sys'); // eslint-disable-line no-restricted-modules var util = require('util'); assert.strictEqual(sys, util); node-v4.8.2/test/parallel/test-tcp-wrap-connect.js000644 000766 000024 00000002655 13070706737 022244 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var TCP = process.binding('tcp_wrap').TCP; var TCPConnectWrap = process.binding('tcp_wrap').TCPConnectWrap; var ShutdownWrap = process.binding('stream_wrap').ShutdownWrap; function makeConnection() { var client = new TCP(); var req = new TCPConnectWrap(); var err = client.connect(req, '127.0.0.1', this.address().port); assert.equal(err, 0); req.oncomplete = function(status, client_, req_) { assert.equal(0, status); assert.equal(client, client_); assert.equal(req, req_); console.log('connected'); var shutdownReq = new ShutdownWrap(); var err = client.shutdown(shutdownReq); assert.equal(err, 0); shutdownReq.oncomplete = function(status, client_, req_) { console.log('shutdown complete'); assert.equal(0, status); assert.equal(client, client_); assert.equal(shutdownReq, req_); shutdownCount++; client.close(); }; }; } ///// var connectCount = 0; var endCount = 0; var shutdownCount = 0; var server = require('net').Server(function(s) { console.log('got connection'); connectCount++; s.resume(); s.on('end', function() { console.log('got eof'); endCount++; s.destroy(); server.close(); }); }); server.listen(0, makeConnection); process.on('exit', function() { assert.equal(1, shutdownCount); assert.equal(1, connectCount); assert.equal(1, endCount); }); node-v4.8.2/test/parallel/test-tcp-wrap-listen.js000644 000766 000024 00000004570 13070706737 022107 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var TCP = process.binding('tcp_wrap').TCP; var WriteWrap = process.binding('stream_wrap').WriteWrap; var server = new TCP(); var r = server.bind('0.0.0.0', 0); assert.equal(0, r); var port = {}; server.getsockname(port); port = port.port; server.listen(128); var sliceCount = 0, eofCount = 0; var writeCount = 0; var recvCount = 0; server.onconnection = function(err, client) { assert.equal(0, client.writeQueueSize); console.log('got connection'); function maybeCloseClient() { if (client.pendingWrites.length == 0 && client.gotEOF) { console.log('close client'); client.close(); } } client.readStart(); client.pendingWrites = []; client.onread = function(err, buffer) { if (buffer) { assert.ok(buffer.length > 0); assert.equal(0, client.writeQueueSize); var req = new WriteWrap(); req.async = false; const returnCode = client.writeBuffer(req, buffer); assert.equal(returnCode, 0); client.pendingWrites.push(req); console.log('client.writeQueueSize: ' + client.writeQueueSize); // 11 bytes should flush assert.equal(0, client.writeQueueSize); if (req.async) req.oncomplete = done; else process.nextTick(done.bind(null, 0, client, req)); function done(status, client_, req_) { assert.equal(req, client.pendingWrites.shift()); // Check parameters. assert.equal(0, status); assert.equal(client, client_); assert.equal(req, req_); console.log('client.writeQueueSize: ' + client.writeQueueSize); assert.equal(0, client.writeQueueSize); writeCount++; console.log('write ' + writeCount); maybeCloseClient(); } sliceCount++; } else { console.log('eof'); client.gotEOF = true; server.close(); eofCount++; maybeCloseClient(); } }; }; var net = require('net'); var c = net.createConnection(port); c.on('connect', function() { c.end('hello world'); }); c.setEncoding('utf8'); c.on('data', function(d) { assert.equal('hello world', d); recvCount++; }); c.on('close', function() { console.error('client closed'); }); process.on('exit', function() { assert.equal(1, sliceCount); assert.equal(1, eofCount); assert.equal(1, writeCount); assert.equal(1, recvCount); }); node-v4.8.2/test/parallel/test-tcp-wrap.js000644 000766 000024 00000000702 13070706737 020604 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var TCP = process.binding('tcp_wrap').TCP; var uv = process.binding('uv'); var handle = new TCP(); // Should be able to bind to the port var err = handle.bind('0.0.0.0', 0); assert.equal(err, 0); // Should not be able to bind to the same port again var out = {}; handle.getsockname(out); err = handle.bind('0.0.0.0', out.port); assert.equal(err, uv.UV_EINVAL); handle.close(); node-v4.8.2/test/parallel/test-tick-processor.js000644 000766 000024 00000004051 13070706737 022017 0ustar00iojsstaff000000 000000 'use strict'; const fs = require('fs'); const assert = require('assert'); const cp = require('child_process'); const common = require('../common'); // TODO(mhdawson) Currently the test-tick-processor functionality in V8 // depends on addresses being smaller than a full 64 bits. Aix supports // the full 64 bits and the result is that it does not process the // addresses correctly and runs out of memory // Disabling until we get a fix upstreamed into V8 if (common.isAix) { common.skip('Aix address range too big for scripts.'); return; } common.refreshTmpDir(); process.chdir(common.tmpDir); // Unknown checked for to prevent flakiness, if pattern is not found, // then a large number of unknown ticks should be present runTest(/LazyCompile.*\[eval\]:1|.*% UNKNOWN/, `function f() { for (var i = 0; i < 1000000; i++) { i++; } setImmediate(function() { f(); }); }; setTimeout(function() { process.exit(0); }, 2000); f();`); if (common.isWindows || common.isSunOS || common.isAix || common.isLinuxPPCBE || common.isFreeBSD) { common.skip('C++ symbols are not mapped for this os.'); return; } runTest(/RunInDebugContext/, `function f() { require(\'vm\').runInDebugContext(\'Debug\'); setImmediate(function() { f(); }); }; setTimeout(function() { process.exit(0); }, 2000); f();`); runTest(/Runtime_DateCurrentTime/, `function f() { this.ts = Date.now(); setImmediate(function() { new f(); }); }; setTimeout(function() { process.exit(0); }, 2000); f();`); function runTest(pattern, code) { cp.execFileSync(process.execPath, ['-prof', '-pe', code]); var matches = fs.readdirSync(common.tmpDir); assert.strictEqual(matches.length, 1, 'There should be a single log file.'); var log = matches[0]; var out = cp.execSync(process.execPath + ' --prof-process --call-graph-size=10 ' + log, {encoding: 'utf8'}); assert(pattern.test(out), `${pattern} not matching ${out}`); fs.unlinkSync(log); } node-v4.8.2/test/parallel/test-timer-close.js000644 000766 000024 00000000420 13070706737 021267 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var t = new (process.binding('timer_wrap').Timer); var called = 0; function onclose() { called++; } t.close(onclose); t.close(onclose); process.on('exit', function() { assert.equal(1, called); }); node-v4.8.2/test/parallel/test-timers-active.js000644 000766 000024 00000001527 13070706737 021631 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const active = require('timers').active; // active() should create timers for these var legitTimers = [ { _idleTimeout: 0 }, { _idleTimeout: 1 } ]; legitTimers.forEach(function(legit) { const savedTimeout = legit._idleTimeout; active(legit); // active() should mutate these objects assert(legit._idleTimeout === savedTimeout); assert(Number.isInteger(legit._idleStart)); assert(legit._idleNext); assert(legit._idlePrev); }); // active() should not create a timer for these var bogusTimers = [ { _idleTimeout: -1 }, { _idleTimeout: undefined }, ]; bogusTimers.forEach(function(bogus) { const savedTimeout = bogus._idleTimeout; active(bogus); // active() should not mutate these objects assert.deepStrictEqual(bogus, {_idleTimeout: savedTimeout}); }); node-v4.8.2/test/parallel/test-timers-args.js000644 000766 000024 00000001271 13070706737 021306 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); function range(n) { return 'x'.repeat(n + 1).split('').map(function(_, i) { return i; }); } function timeout(nargs) { var args = range(nargs); setTimeout.apply(null, [callback, 1].concat(args)); function callback() { assert.deepEqual([].slice.call(arguments), args); if (nargs < 128) timeout(nargs + 1); } } function interval(nargs) { var args = range(nargs); var timer = setTimeout.apply(null, [callback, 1].concat(args)); function callback() { clearInterval(timer); assert.deepEqual([].slice.call(arguments), args); if (nargs < 128) interval(nargs + 1); } } timeout(0); interval(0); node-v4.8.2/test/parallel/test-timers-clear-null-does-not-throw-error.js000644 000766 000024 00000000671 13070706737 026431 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); // This test makes sure clearing timers with // 'null' or no input does not throw error assert.doesNotThrow(() => clearInterval(null)); assert.doesNotThrow(() => clearInterval()); assert.doesNotThrow(() => clearTimeout(null)); assert.doesNotThrow(() => clearTimeout()); assert.doesNotThrow(() => clearImmediate(null)); assert.doesNotThrow(() => clearImmediate()); node-v4.8.2/test/parallel/test-timers-immediate-queue.js000644 000766 000024 00000001550 13070706737 023432 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); // setImmediate should run clear its queued cbs once per event loop turn // but immediates queued while processing the current queue should happen // on the next turn of the event loop. // in v0.10 hit should be 1, because we only process one cb per turn // in v0.11 and beyond it should be the exact same size of QUEUE // if we're letting things recursively add to the immediate QUEUE hit will be // > QUEUE var ticked = false; var hit = 0; var QUEUE = 1000; function run() { if (hit === 0) process.nextTick(function() { ticked = true; }); if (ticked) return; hit += 1; setImmediate(run); } for (var i = 0; i < QUEUE; i++) setImmediate(run); process.on('exit', function() { console.log('hit', hit); assert.strictEqual(hit, QUEUE, 'We ticked between the immediate queue'); }); node-v4.8.2/test/parallel/test-timers-immediate.js000644 000766 000024 00000001361 13070706737 022310 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); let immediateA = false; let immediateB = false; let immediateC = []; setImmediate(function() { try { immediateA = process.hrtime(before); } catch (e) { console.log('failed to get hrtime with offset'); } clearImmediate(immediateB); }); const before = process.hrtime(); immediateB = setImmediate(function() { immediateB = true; }); setImmediate(function(x, y, z) { immediateC = [x, y, z]; }, 1, 2, 3); process.on('exit', function() { assert.ok(immediateA, 'Immediate should happen after normal execution'); assert.notStrictEqual(immediateB, true, 'immediateB should not fire'); assert.deepEqual(immediateC, [1, 2, 3], 'immediateC args should match'); }); node-v4.8.2/test/parallel/test-timers-linked-list.js000644 000766 000024 00000003523 13070706737 022573 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const L = require('_linklist'); // eslint-disable-line no-restricted-modules var list = { name: 'list' }; var A = { name: 'A' }; var B = { name: 'B' }; var C = { name: 'C' }; var D = { name: 'D' }; L.init(list); L.init(A); L.init(B); L.init(C); L.init(D); assert.ok(L.isEmpty(list)); assert.equal(null, L.peek(list)); L.append(list, A); // list -> A assert.equal(A, L.peek(list)); L.append(list, B); // list -> A -> B assert.equal(A, L.peek(list)); L.append(list, C); // list -> A -> B -> C assert.equal(A, L.peek(list)); L.append(list, D); // list -> A -> B -> C -> D assert.equal(A, L.peek(list)); var x = L.shift(list); assert.equal(A, x); // list -> B -> C -> D assert.equal(B, L.peek(list)); x = L.shift(list); assert.equal(B, x); // list -> C -> D assert.equal(C, L.peek(list)); // B is already removed, so removing it again shouldn't hurt. L.remove(B); // list -> C -> D assert.equal(C, L.peek(list)); // Put B back on the list L.append(list, B); // list -> C -> D -> B assert.equal(C, L.peek(list)); L.remove(C); // list -> D -> B assert.equal(D, L.peek(list)); L.remove(B); // list -> D assert.equal(D, L.peek(list)); L.remove(D); // list assert.equal(null, L.peek(list)); assert.ok(L.isEmpty(list)); L.append(list, D); // list -> D assert.equal(D, L.peek(list)); L.append(list, C); L.append(list, B); L.append(list, A); // list -> D -> C -> B -> A // Append should REMOVE C from the list and append it to the end. L.append(list, C); // list -> D -> B -> A -> C assert.equal(D, L.shift(list)); // list -> B -> A -> C assert.equal(B, L.peek(list)); assert.equal(B, L.shift(list)); // list -> A -> C assert.equal(A, L.peek(list)); assert.equal(A, L.shift(list)); // list -> C assert.equal(C, L.peek(list)); assert.equal(C, L.shift(list)); // list assert.ok(L.isEmpty(list)); node-v4.8.2/test/parallel/test-timers-non-integer-delay.js000644 000766 000024 00000001665 13070706737 023702 0ustar00iojsstaff000000 000000 'use strict'; /* * This test makes sure that non-integer timer delays do not make the process * hang. See https://github.com/joyent/node/issues/8065 and * https://github.com/joyent/node/issues/8068 which have been fixed by * https://github.com/joyent/node/pull/8073. * * If the process hangs, this test will make the tests suite timeout, * otherwise it will exit very quickly (after 50 timers with a short delay * fire). * * We have to set at least several timers with a non-integer delay to * reproduce the issue. Sometimes, a timer with a non-integer delay will * expire correctly. 50 timers has always been more than enough to reproduce * it 100%. */ require('../common'); var TIMEOUT_DELAY = 1.1; var NB_TIMEOUTS_FIRED = 50; var nbTimeoutFired = 0; var interval = setInterval(function() { ++nbTimeoutFired; if (nbTimeoutFired === NB_TIMEOUTS_FIRED) { clearInterval(interval); process.exit(0); } }, TIMEOUT_DELAY); node-v4.8.2/test/parallel/test-timers-now.js000644 000766 000024 00000000354 13070706737 021156 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); // Return value of Timer.now() should easily fit in a SMI right after start-up. const Timer = process.binding('timer_wrap').Timer; assert(Timer.now() < 0x3ffffff); node-v4.8.2/test/parallel/test-timers-ordering.js000644 000766 000024 00000001230 13070706737 022156 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var Timer = process.binding('timer_wrap').Timer; var N = 30; var last_i = 0; var last_ts = 0; var f = function(i) { if (i <= N) { // check order assert.equal(i, last_i + 1, 'order is broken: ' + i + ' != ' + last_i + ' + 1'); last_i = i; // check that this iteration is fired at least 1ms later than the previous var now = Timer.now(); console.log(i, now); assert(now >= last_ts + 1, 'current ts ' + now + ' < prev ts ' + last_ts + ' + 1'); last_ts = now; // schedule next iteration setTimeout(f, 1, i + 1); } }; f(1); node-v4.8.2/test/parallel/test-timers-reset-process-domain-on-throw.js000644 000766 000024 00000003011 13070706737 026162 0ustar00iojsstaff000000 000000 'use strict'; // This test makes sure that when throwing from within a timer's callback, // its active domain at the time of the throw is not the process' active domain // for the next timers that need to be processed on the same turn of the event // loop. const common = require('../common'); const assert = require('assert'); const domain = require('domain'); // Use the same timeout value so that both timers' callbacks are called during // the same invocation of the underlying native timer's callback (listOnTimeout // in lib/timers.js). setTimeout(err, 50); setTimeout(common.mustCall(secondTimer), 50); function err() { const d = domain.create(); d.on('error', handleDomainError); d.run(err2); function err2() { // this function doesn't exist, and throws an error as a result. err3(); // eslint-disable-line no-undef } function handleDomainError(e) { // In the domain's error handler, the current active domain should be the // domain within which the error was thrown. assert.equal(process.domain, d); } } function secondTimer() { // secondTimer was scheduled before any domain had been created, so its // callback should not have any active domain set when it runs. if (process.domain !== null) { console.log('process.domain should be null in this timer callback, but is:', process.domain); // Do not use assert here, as it throws errors and if a domain with an error // handler is active, then asserting wouldn't make the test fail. process.exit(1); } } node-v4.8.2/test/parallel/test-timers-socket-timeout-removes-other-socket-unref-timer.js000644 000766 000024 00000002405 13070706737 031644 0ustar00iojsstaff000000 000000 'use strict'; /* * This test is a regression test for joyent/node#8897. */ const common = require('../common'); const net = require('net'); const clients = []; const server = net.createServer(function onClient(client) { clients.push(client); if (clients.length === 2) { /* * Enroll two timers, and make the one supposed to fire first * unenroll the other one supposed to fire later. This mutates * the list of unref timers when traversing it, and exposes the * original issue in joyent/node#8897. */ clients[0].setTimeout(1, function onTimeout() { clients[1].setTimeout(0); clients[0].end(); clients[1].end(); }); // Use a delay that is higher than the lowest timer resolution accross all // supported platforms, so that the two timers don't fire at the same time. clients[1].setTimeout(50); } }); server.listen(0, common.localhostIPv4, function() { var nbClientsEnded = 0; function addEndedClient(client) { ++nbClientsEnded; if (nbClientsEnded === 2) { server.close(); } } const client1 = net.connect({ port: this.address().port }); client1.on('end', addEndedClient); const client2 = net.connect({ port: this.address().port }); client2.on('end', addEndedClient); }); node-v4.8.2/test/parallel/test-timers-this.js000644 000766 000024 00000001635 13070706737 021325 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const immediateHandler = setImmediate(common.mustCall(function() { assert.strictEqual(this, immediateHandler); })); const immediateArgsHandler = setImmediate(common.mustCall(function() { assert.strictEqual(this, immediateArgsHandler); }), 'args ...'); const intervalHandler = setInterval(common.mustCall(function() { clearInterval(intervalHandler); assert.strictEqual(this, intervalHandler); }), 1); const intervalArgsHandler = setInterval(common.mustCall(function() { clearInterval(intervalArgsHandler); assert.strictEqual(this, intervalArgsHandler); }), 1, 'args ...'); const timeoutHandler = setTimeout(common.mustCall(function() { assert.strictEqual(this, timeoutHandler); }), 1); const timeoutArgsHandler = setTimeout(common.mustCall(function() { assert.strictEqual(this, timeoutArgsHandler); }), 1, 'args ...'); node-v4.8.2/test/parallel/test-timers-uncaught-exception.js000644 000766 000024 00000001577 13070706737 024175 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var exceptions = 0; var timer1 = 0; var timer2 = 0; // the first timer throws... console.error('set first timer'); setTimeout(function() { console.error('first timer'); timer1++; throw new Error('BAM!'); }, 100); // ...but the second one should still run console.error('set second timer'); setTimeout(function() { console.error('second timer'); assert.equal(timer1, 1); timer2++; }, 100); function uncaughtException(err) { console.error('uncaught handler'); assert.equal(err.message, 'BAM!'); exceptions++; } process.on('uncaughtException', uncaughtException); var exited = false; process.on('exit', function() { assert(!exited); exited = true; process.removeListener('uncaughtException', uncaughtException); assert.equal(exceptions, 1); assert.equal(timer1, 1); assert.equal(timer2, 1); }); node-v4.8.2/test/parallel/test-timers-unenroll-unref-interval.js000644 000766 000024 00000002770 13070706737 025154 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const timers = require('timers'); { const interval = setInterval(common.mustCall(() => { clearTimeout(interval); }), 1).unref(); } { const interval = setInterval(common.mustCall(() => { interval.close(); }), 1).unref(); } { const interval = setInterval(common.mustCall(() => { timers.unenroll(interval); }), 1).unref(); } { const interval = setInterval(common.mustCall(() => { interval._idleTimeout = -1; }), 1).unref(); } { const interval = setInterval(common.mustCall(() => { interval._onTimeout = null; }), 1).unref(); } { const interval = setInterval(common.mustCall(() => { // This case is only necessary / valid prior to // c8c2544cd9c339cdde881fc9a7f0851971b94d72 // which is not on the v4.x branch. assert.strictEqual(typeof interval._repeat, 'function'); process.nextTick(common.mustCall(() => { interval._repeat = null; })); }), 1).unref(); } // Use timers' intrinsic behavior to keep this open // exactly long enough for the problem to manifest. // // See https://github.com/nodejs/node/issues/9561 // // Since this is added after it will always fire later // than the previous timeouts, unrefed or not. // // Keep the event loop alive for one timeout and then // another. Any problems will occur when the second // should be called but before it is able to be. setTimeout(common.mustCall(() => { setTimeout(common.mustCall(() => {}), 1); }), 1); node-v4.8.2/test/parallel/test-timers-unref-active-unenrolled-disposed.js000644 000766 000024 00000002315 13070706737 026717 0ustar00iojsstaff000000 000000 'use strict'; // https://github.com/nodejs/node/pull/2540/files#r38231197 const common = require('../common'); const timers = require('timers'); const assert = require('assert'); const domain = require('domain'); // Crazy stuff to keep the process open, // then close it when we are actually done. const TEST_DURATION = common.platformTimeout(1000); const keepOpen = setTimeout(function() { throw new Error('Test timed out. keepOpen was not canceled.'); }, TEST_DURATION); const endTest = makeTimer(2); const someTimer = makeTimer(1); someTimer.domain = domain.create(); someTimer.domain.dispose(); someTimer._onTimeout = function() { throw new Error('someTimer was not supposed to fire!'); }; endTest._onTimeout = common.mustCall(function() { assert.strictEqual(someTimer._idlePrev, null); assert.strictEqual(someTimer._idleNext, null); clearTimeout(keepOpen); }); const cancelsTimer = makeTimer(1); cancelsTimer._onTimeout = common.mustCall(function() { someTimer._idleTimeout = 0; }); timers._unrefActive(cancelsTimer); timers._unrefActive(someTimer); timers._unrefActive(endTest); function makeTimer(msecs) { const timer = {}; timers.unenroll(timer); timers.enroll(timer, msecs); return timer; } node-v4.8.2/test/parallel/test-timers-unref-active.js000644 000766 000024 00000002675 13070706737 022753 0ustar00iojsstaff000000 000000 'use strict'; /* * This test is aimed at making sure that unref timers queued with * timers._unrefActive work correctly. * * Basically, it queues one timer in the unref queue, and then queues * it again each time its timeout callback is fired until the callback * has been called ten times. * * At that point, it unenrolls the unref timer so that its timeout callback * is not fired ever again. * * Finally, a ref timeout is used with a delay large enough to make sure that * all 10 timeouts had the time to expire. */ require('../common'); const timers = require('timers'); const assert = require('assert'); var someObject = {}; var nbTimeouts = 0; /* * libuv 0.10.x uses GetTickCount on Windows to implement timers, which uses * system's timers whose resolution is between 10 and 16ms. See * http://msdn.microsoft.com/en-us/library/windows/desktop/ms724408.aspx * for more information. That's the lowest resolution for timers across all * supported platforms. We're using it as the lowest common denominator, * and thus expect 5 timers to be able to fire in under 100 ms. */ const N = 5; const TEST_DURATION = 1000; timers.unenroll(someObject); timers.enroll(someObject, 1); someObject._onTimeout = function _onTimeout() { ++nbTimeouts; if (nbTimeouts === N) timers.unenroll(someObject); timers._unrefActive(someObject); }; timers._unrefActive(someObject); setTimeout(function() { assert.equal(nbTimeouts, N); }, TEST_DURATION); node-v4.8.2/test/parallel/test-timers-unref-call.js000644 000766 000024 00000000463 13070706737 022404 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var Timer = process.binding('timer_wrap').Timer; Timer.now = function() { return ++Timer.now.ticks; }; Timer.now.ticks = 0; var t = setInterval(function() {}, 1); var o = { _idleStart: 0, _idleTimeout: 1 }; t.unref.call(o); setTimeout(clearInterval.bind(null, t), 2); node-v4.8.2/test/parallel/test-timers-unref-leak.js000644 000766 000024 00000001047 13070706737 022404 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var called = 0; var closed = 0; var timeout = setTimeout(function() { called++; }, 10); timeout.unref(); // Wrap `close` method to check if the handle was closed var close = timeout._handle.close; timeout._handle.close = function() { closed++; return close.apply(this, arguments); }; // Just to keep process alive and let previous timer's handle die setTimeout(function() { }, 50); process.on('exit', function() { assert.equal(called, 1); assert.equal(closed, 1); }); node-v4.8.2/test/parallel/test-timers-unref-remove-other-unref-timers-only-one-fires.js000644 000766 000024 00000001655 13070706737 031373 0ustar00iojsstaff000000 000000 'use strict'; /* * The goal of this test is to make sure that, after the regression introduced * by 934bfe23a16556d05bfb1844ef4d53e8c9887c3d, the fix preserves the following * behavior of unref timers: if two timers are scheduled to fire at the same * time, if one unenrolls the other one in its _onTimeout callback, the other * one will *not* fire. * * This behavior is a private implementation detail and should not be * considered public interface. */ require('../common'); const timers = require('timers'); const assert = require('assert'); var nbTimersFired = 0; const foo = { _onTimeout: function() { ++nbTimersFired; timers.unenroll(bar); } }; const bar = { _onTimeout: function() { ++nbTimersFired; timers.unenroll(foo); } }; timers.enroll(bar, 1); timers._unrefActive(bar); timers.enroll(foo, 1); timers._unrefActive(foo); setTimeout(function() { assert.notEqual(nbTimersFired, 2); }, 20); node-v4.8.2/test/parallel/test-timers-unref-remove-other-unref-timers.js000644 000766 000024 00000001413 13070706737 026517 0ustar00iojsstaff000000 000000 'use strict'; /* * This test is a regression test for joyent/node#8897. * * It tests some private implementation details that should not be * considered public interface. */ const common = require('../common'); const timers = require('timers'); const foo = { _onTimeout: common.fail }; const bar = { _onTimeout: common.mustCall(function() { timers.unenroll(foo); }) }; // We use timers with expiration times that are sufficiently apart to make // sure that they're not fired at the same time on platforms where the timer // resolution is a bit coarse (e.g Windows with a default resolution of ~15ms). timers.enroll(bar, 1); timers._unrefActive(bar); timers.enroll(foo, 50); timers._unrefActive(foo); // Keep the process open. setTimeout(function() {}, 100); node-v4.8.2/test/parallel/test-timers-unref.js000644 000766 000024 00000003603 13070706737 021472 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); let interval_fired = false; let timeout_fired = false; let unref_interval = false; let unref_timer = false; let unref_callbacks = 0; let checks = 0; var LONG_TIME = 10 * 1000; var SHORT_TIME = 100; assert.doesNotThrow(function() { setTimeout(function() {}, 10).unref().ref().unref(); }, 'ref and unref are chainable'); assert.doesNotThrow(function() { setInterval(function() {}, 10).unref().ref().unref(); }, 'ref and unref are chainable'); setInterval(function() { interval_fired = true; }, LONG_TIME).unref(); setTimeout(function() { timeout_fired = true; }, LONG_TIME).unref(); const interval = setInterval(function() { unref_interval = true; clearInterval(interval); }, SHORT_TIME); interval.unref(); setTimeout(function() { unref_timer = true; }, SHORT_TIME).unref(); const check_unref = setInterval(function() { if (checks > 5 || (unref_interval && unref_timer)) clearInterval(check_unref); checks += 1; }, 100); setTimeout(function() { unref_callbacks++; this.unref(); }, SHORT_TIME); // Should not timeout the test setInterval(function() { this.unref(); }, SHORT_TIME); // Should not assert on args.Holder()->InternalFieldCount() > 0. See #4261. (function() { var t = setInterval(function() {}, 1); process.nextTick(t.unref.bind({})); process.nextTick(t.unref.bind(t)); })(); process.on('exit', function() { assert.strictEqual(interval_fired, false, 'Interval should not fire'); assert.strictEqual(timeout_fired, false, 'Timeout should not fire'); assert.strictEqual(unref_timer, true, 'An unrefd timeout should still fire'); assert.strictEqual(unref_interval, true, 'An unrefd interval should still fire'); assert.strictEqual(unref_callbacks, 1, 'Callback should only run once'); }); node-v4.8.2/test/parallel/test-timers-unrefd-interval-still-fires.js000644 000766 000024 00000001244 13070706737 025712 0ustar00iojsstaff000000 000000 'use strict'; /* * This test is a regression test for joyent/node#8900. */ const common = require('../common'); const TEST_DURATION = common.platformTimeout(1000); const N = 3; var nbIntervalFired = 0; const keepOpen = setTimeout(() => { console.error('[FAIL] Interval fired %d/%d times.', nbIntervalFired, N); throw new Error('Test timed out. keepOpen was not canceled.'); }, TEST_DURATION); const timer = setInterval(() => { ++nbIntervalFired; if (nbIntervalFired === N) { clearInterval(timer); timer._onTimeout = () => { throw new Error('Unrefd interval fired after being cleared.'); }; clearTimeout(keepOpen); } }, 1); timer.unref(); node-v4.8.2/test/parallel/test-timers-unrefed-in-beforeexit.js000644 000766 000024 00000000543 13070706737 024541 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); var once = 0; process.on('beforeExit', () => { if (once > 1) throw new RangeError('beforeExit should only have been called once!'); setTimeout(() => {}, 1).unref(); once++; }); process.on('exit', (code) => { if (code !== 0) return; assert.strictEqual(once, 1); }); node-v4.8.2/test/parallel/test-timers-zero-timeout.js000644 000766 000024 00000001411 13070706737 023011 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); // https://github.com/joyent/node/issues/2079 - zero timeout drops extra args (function() { var ncalled = 0; setTimeout(f, 0, 'foo', 'bar', 'baz'); setTimeout(function() {}, 0); function f(a, b, c) { assert.equal(a, 'foo'); assert.equal(b, 'bar'); assert.equal(c, 'baz'); ncalled++; } process.on('exit', function() { assert.equal(ncalled, 1); }); })(); (function() { var ncalled = 0; var iv = setInterval(f, 0, 'foo', 'bar', 'baz'); function f(a, b, c) { assert.equal(a, 'foo'); assert.equal(b, 'bar'); assert.equal(c, 'baz'); if (++ncalled == 3) clearTimeout(iv); } process.on('exit', function() { assert.equal(ncalled, 3); }); })(); node-v4.8.2/test/parallel/test-timers.js000644 000766 000024 00000002261 13070706737 020354 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); var inputs = [ undefined, null, true, false, '', [], {}, NaN, +Infinity, -Infinity, (1.0 / 0.0), // sanity check parseFloat('x'), // NaN -10, -1, -0.5, -0.1, -0.0, 0, 0.0, 0.1, 0.5, 1, 1.0, 2147483648, // browser behaviour: timeouts > 2^31-1 run on next tick 12345678901234 // ditto ]; var timeouts = []; var intervals = []; inputs.forEach(function(value, index) { setTimeout(function() { timeouts[index] = true; }, value); var handle = setInterval(function() { clearInterval(handle); // disarm timer or we'll never finish intervals[index] = true; }, value); }); // All values in inputs array coerce to 1 ms. Therefore, they should all run // before a timer set here for 2 ms. setTimeout(common.mustCall(function() { // assert that all other timers have run inputs.forEach(function(value, index) { assert(timeouts[index]); assert(intervals[index]); }); }), 2); // Test 10 ms timeout separately. setTimeout(common.mustCall(function() {}), 10); setInterval(common.mustCall(function() { clearInterval(this); }), 10); node-v4.8.2/test/parallel/test-tls-0-dns-altname.js000644 000766 000024 00000001747 13070706737 022221 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const tls = require('tls'); const fs = require('fs'); const server = tls.createServer({ key: fs.readFileSync(common.fixturesDir + '/keys/0-dns-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/0-dns-cert.pem') }, function(c) { c.once('data', function() { c.destroy(); server.close(); }); }).listen(0, common.mustCall(function() { const c = tls.connect(this.address().port, { rejectUnauthorized: false }, common.mustCall(function() { const cert = c.getPeerCertificate(); assert.strictEqual(cert.subjectaltname, 'DNS:google.com\0.evil.com, ' + 'DNS:just-another.com, ' + 'IP Address:8.8.8.8, ' + 'IP Address:8.8.4.4, ' + 'DNS:last.com'); c.write('ok'); })); })); node-v4.8.2/test/parallel/test-tls-addca.js000644 000766 000024 00000003264 13070706737 020711 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const fs = require('fs'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const tls = require('tls'); function filenamePEM(n) { return require('path').join(common.fixturesDir, 'keys', n + '.pem'); } function loadPEM(n) { return fs.readFileSync(filenamePEM(n)); } const caCert = loadPEM('ca1-cert'); const contextWithoutCert = tls.createSecureContext({}); const contextWithCert = tls.createSecureContext({}); // Adding a CA certificate to contextWithCert should not also add it to // contextWithoutCert. This is tested by trying to connect to a server that // depends on that CA using contextWithoutCert. contextWithCert.context.addCACert(caCert); const serverOptions = { key: loadPEM('agent1-key'), cert: loadPEM('agent1-cert'), }; const server = tls.createServer(serverOptions, function() {}); const clientOptions = { port: undefined, ca: [caCert], servername: 'agent1', rejectUnauthorized: true, }; function startTest() { // This client should fail to connect because it doesn't trust the CA // certificate. clientOptions.secureContext = contextWithoutCert; clientOptions.port = server.address().port; const client = tls.connect(clientOptions, common.fail); client.on('error', common.mustCall(() => { client.destroy(); // This time it should connect because contextWithCert includes the needed // CA certificate. clientOptions.secureContext = contextWithCert; const client2 = tls.connect(clientOptions, common.mustCall(() => { client2.destroy(); server.close(); })); client2.on('error', (e) => { console.log(e); }); })); } server.listen(0, startTest); node-v4.8.2/test/parallel/test-tls-alert-handling.js000644 000766 000024 00000003272 13070706737 022545 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.opensslCli) { common.skip('node compiled without OpenSSL CLI.'); return; } if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var net = require('net'); var fs = require('fs'); var success = false; function filenamePEM(n) { return require('path').join(common.fixturesDir, 'keys', n + '.pem'); } function loadPEM(n) { return fs.readFileSync(filenamePEM(n)); } var opts = { key: loadPEM('agent2-key'), cert: loadPEM('agent2-cert') }; var max_iter = 20; var iter = 0; var server = tls.createServer(opts, function(s) { s.pipe(s); s.on('error', function(e) { // ignore error }); }); server.listen(0, function() { sendClient(); }); function sendClient() { var client = tls.connect(server.address().port, { rejectUnauthorized: false }); client.on('data', function(chunk) { if (iter++ === 2) sendBADTLSRecord(); if (iter < max_iter) { client.write('a'); return; } client.end(); server.close(); success = true; }); client.write('a'); client.on('error', function(e) { // ignore error }); client.on('close', function() { server.close(); }); } function sendBADTLSRecord() { var BAD_RECORD = new Buffer([0xff, 0xff, 0xff, 0xff, 0xff, 0xff]); var socket = net.connect(server.address().port); var client = tls.connect({ socket: socket, rejectUnauthorized: false }, function() { socket.write(BAD_RECORD); socket.end(); }); client.on('error', function(e) { // ignore error }); } process.on('exit', function() { assert(iter === max_iter); assert(success); }); node-v4.8.2/test/parallel/test-tls-alert.js000644 000766 000024 00000002332 13070706737 020757 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.opensslCli) { common.skip('node compiled without OpenSSL CLI.'); return; } if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var fs = require('fs'); var spawn = require('child_process').spawn; var success = false; function filenamePEM(n) { return require('path').join(common.fixturesDir, 'keys', n + '.pem'); } function loadPEM(n) { return fs.readFileSync(filenamePEM(n)); } var server = tls.Server({ secureProtocol: 'TLSv1_2_server_method', key: loadPEM('agent2-key'), cert: loadPEM('agent2-cert') }, null).listen(0, function() { var args = ['s_client', '-quiet', '-tls1_1', '-connect', `127.0.0.1:${this.address().port}`]; // for the performance and stability issue in s_client on Windows if (common.isWindows) args.push('-no_rand_screen'); var client = spawn(common.opensslCli, args); var out = ''; client.stderr.setEncoding('utf8'); client.stderr.on('data', function(d) { out += d; if (/SSL alert number 70/.test(out)) { success = true; server.close(); } }); }); process.on('exit', function() { assert(success); }); node-v4.8.2/test/parallel/test-tls-alpn-server-client.js000644 000766 000024 00000040035 13070706737 023364 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); if (!common.hasCrypto) { console.log('1..0 # Skipped: missing crypto'); return; } if (!process.features.tls_alpn) { console.error('Skipping because node compiled without OpenSSL or ' + 'with old OpenSSL version.'); process.exit(0); } const assert = require('assert'); const fs = require('fs'); const tls = require('tls'); function filenamePEM(n) { return require('path').join(common.fixturesDir, 'keys', n + '.pem'); } function loadPEM(n) { return fs.readFileSync(filenamePEM(n)); } var serverPort = common.PORT; var serverIP = common.localhostIPv4; function checkResults(result, expected) { assert.strictEqual(result.server.ALPN, expected.server.ALPN); assert.strictEqual(result.server.NPN, expected.server.NPN); assert.strictEqual(result.client.ALPN, expected.client.ALPN); assert.strictEqual(result.client.NPN, expected.client.NPN); } function runTest(clientsOptions, serverOptions, cb) { serverOptions.key = loadPEM('agent2-key'); serverOptions.cert = loadPEM('agent2-cert'); var results = []; var index = 0; var server = tls.createServer(serverOptions, function(c) { results[index].server = {ALPN: c.alpnProtocol, NPN: c.npnProtocol}; }); server.listen(serverPort, serverIP, function() { connectClient(clientsOptions); }); function connectClient(options) { var opt = options.shift(); opt.port = serverPort; opt.host = serverIP; opt.rejectUnauthorized = false; results[index] = {}; var client = tls.connect(opt, function() { results[index].client = {ALPN: client.alpnProtocol, NPN: client.npnProtocol}; client.destroy(); if (options.length) { index++; connectClient(options); } else { server.close(); cb(results); } }); } } // Server: ALPN/NPN, Client: ALPN/NPN function Test1() { var serverOptions = { ALPNProtocols: ['a', 'b', 'c'], NPNProtocols: ['a', 'b', 'c'] }; var clientsOptions = [{ ALPNProtocols: ['a', 'b', 'c'], NPNProtocols: ['a', 'b', 'c'] }, { ALPNProtocols: ['c', 'b', 'e'], NPNProtocols: ['c', 'b', 'e'] }, { ALPNProtocols: ['first-priority-unsupported', 'x', 'y'], NPNProtocols: ['first-priority-unsupported', 'x', 'y'] }]; runTest(clientsOptions, serverOptions, function(results) { // 'a' is selected by ALPN checkResults(results[0], {server: {ALPN: 'a', NPN: false}, client: {ALPN: 'a', NPN: undefined}}); // 'b' is selected by ALPN checkResults(results[1], {server: {ALPN: 'b', NPN: false}, client: {ALPN: 'b', NPN: undefined}}); // nothing is selected by ALPN checkResults(results[2], {server: {ALPN: false, NPN: 'first-priority-unsupported'}, client: {ALPN: false, NPN: false}}); // execute next test Test2(); }); } // Server: ALPN/NPN, Client: ALPN function Test2() { var serverOptions = { ALPNProtocols: ['a', 'b', 'c'], NPNProtocols: ['a', 'b', 'c'] }; var clientsOptions = [{ ALPNProtocols: ['a', 'b', 'c'] }, { ALPNProtocols: ['c', 'b', 'e'] }, { ALPNProtocols: ['first-priority-unsupported', 'x', 'y'] }]; runTest(clientsOptions, serverOptions, function(results) { // 'a' is selected by ALPN checkResults(results[0], {server: {ALPN: 'a', NPN: false}, client: {ALPN: 'a', NPN: undefined}}); // 'b' is selected by ALPN checkResults(results[1], {server: {ALPN: 'b', NPN: false}, client: {ALPN: 'b', NPN: undefined}}); // nothing is selected by ALPN checkResults(results[2], {server: {ALPN: false, NPN: 'http/1.1'}, client: {ALPN: false, NPN: false}}); // execute next test Test3(); }); } // Server: ALPN/NPN, Client: NPN function Test3() { var serverOptions = { ALPNProtocols: ['a', 'b', 'c'], NPNProtocols: ['a', 'b', 'c'] }; var clientsOptions = [{ NPNProtocols: ['a', 'b', 'c'] }, { NPPNProtocols: ['c', 'b', 'e'] }, { NPPNProtocols: ['first-priority-unsupported', 'x', 'y'] }]; runTest(clientsOptions, serverOptions, function(results) { // 'a' is selected by NPN checkResults(results[0], {server: {ALPN: false, NPN: 'a'}, client: {ALPN: false, NPN: 'a'}}); // nothing is selected by ALPN checkResults(results[1], {server: {ALPN: false, NPN: 'http/1.1'}, client: {ALPN: false, NPN: false}}); // nothing is selected by ALPN checkResults(results[2], {server: {ALPN: false, NPN: 'http/1.1'}, client: {ALPN: false, NPN: false}}); // execute next test Test4(); }); } // Server: ALPN/NPN, Client: Nothing function Test4() { var serverOptions = { ALPNProtocols: ['a', 'b', 'c'], NPNProtocols: ['a', 'b', 'c'] }; var clientsOptions = [{}, {}, {}]; runTest(clientsOptions, serverOptions, function(results) { // nothing is selected by ALPN checkResults(results[0], {server: {ALPN: false, NPN: 'http/1.1'}, client: {ALPN: false, NPN: false}}); // nothing is selected by ALPN checkResults(results[1], {server: {ALPN: false, NPN: 'http/1.1'}, client: {ALPN: false, NPN: false}}); // nothing is selected by ALPN checkResults(results[2], {server: {ALPN: false, NPN: 'http/1.1'}, client: {ALPN: false, NPN: false}}); // execute next test Test5(); }); } // Server: ALPN, Client: ALPN/NPN function Test5() { var serverOptions = { ALPNProtocols: ['a', 'b', 'c'] }; var clientsOptions = [{ ALPNProtocols: ['a', 'b', 'c'], NPNProtocols: ['a', 'b', 'c'] }, { ALPNProtocols: ['c', 'b', 'e'], NPNProtocols: ['c', 'b', 'e'] }, { ALPNProtocols: ['first-priority-unsupported', 'x', 'y'], NPNProtocols: ['first-priority-unsupported', 'x', 'y'] }]; runTest(clientsOptions, serverOptions, function(results) { // 'a' is selected by ALPN checkResults(results[0], {server: {ALPN: 'a', NPN: false}, client: {ALPN: 'a', NPN: undefined}}); // 'b' is selected by ALPN checkResults(results[1], {server: {ALPN: 'b', NPN: false}, client: {ALPN: 'b', NPN: undefined}}); // nothing is selected by ALPN checkResults(results[2], {server: {ALPN: false, NPN: 'first-priority-unsupported'}, client: {ALPN: false, NPN: false}}); // execute next test Test6(); }); } // Server: ALPN, Client: ALPN function Test6() { var serverOptions = { ALPNProtocols: ['a', 'b', 'c'] }; var clientsOptions = [{ ALPNProtocols: ['a', 'b', 'c'] }, { ALPNProtocols: ['c', 'b', 'e'] }, { ALPNProtocols: ['first-priority-unsupported', 'x', 'y'] }]; runTest(clientsOptions, serverOptions, function(results) { // 'a' is selected by ALPN checkResults(results[0], {server: {ALPN: 'a', NPN: false}, client: {ALPN: 'a', NPN: undefined}}); // 'b' is selected by ALPN checkResults(results[1], {server: {ALPN: 'b', NPN: false}, client: {ALPN: 'b', NPN: undefined}}); // nothing is selected by ALPN checkResults(results[2], {server: {ALPN: false, NPN: 'http/1.1'}, client: {ALPN: false, NPN: false}}); // execute next test Test7(); }); } // Server: ALPN, Client: NPN function Test7() { var serverOptions = { ALPNProtocols: ['a', 'b', 'c'] }; var clientsOptions = [{ NPNProtocols: ['a', 'b', 'c'] }, { NPNProtocols: ['c', 'b', 'e'] }, { NPNProtocols: ['first-priority-unsupported', 'x', 'y'] }]; runTest(clientsOptions, serverOptions, function(results) { // nothing is selected by ALPN checkResults(results[0], {server: {ALPN: false, NPN: 'a'}, client: {ALPN: false, NPN: false}}); // nothing is selected by ALPN checkResults(results[1], {server: {ALPN: false, NPN: 'c'}, client: {ALPN: false, NPN: false}}); // nothing is selected by ALPN checkResults(results[2], {server: {ALPN: false, NPN: 'first-priority-unsupported'}, client: {ALPN: false, NPN: false}}); // execute next test Test8(); }); } // Server: ALPN, Client: Nothing function Test8() { var serverOptions = { ALPNProtocols: ['a', 'b', 'c'] }; var clientsOptions = [{}, {}, {}]; runTest(clientsOptions, serverOptions, function(results) { // nothing is selected by ALPN checkResults(results[0], {server: {ALPN: false, NPN: 'http/1.1'}, client: {ALPN: false, NPN: false}}); // nothing is selected by ALPN checkResults(results[1], {server: {ALPN: false, NPN: 'http/1.1'}, client: {ALPN: false, NPN: false}}); // nothing is selected by ALPN checkResults(results[2], {server: {ALPN: false, NPN: 'http/1.1'}, client: {ALPN: false, NPN: false}}); // execute next test Test9(); }); } // Server: NPN, Client: ALPN/NPN function Test9() { var serverOptions = { NPNProtocols: ['a', 'b', 'c'] }; var clientsOptions = [{ ALPNrotocols: ['a', 'b', 'c'], NPNProtocols: ['a', 'b', 'c'] }, { ALPNProtocols: ['c', 'b', 'e'], NPNProtocols: ['c', 'b', 'e'] }, { ALPNProtocols: ['first-priority-unsupported', 'x', 'y'], NPNProtocols: ['first-priority-unsupported', 'x', 'y'] }]; runTest(clientsOptions, serverOptions, function(results) { // 'a' is selected by NPN checkResults(results[0], {server: {ALPN: false, NPN: 'a'}, client: {ALPN: false, NPN: 'a'}}); // 'b' is selected by NPN checkResults(results[1], {server: {ALPN: false, NPN: 'b'}, client: {ALPN: false, NPN: 'b'}}); // nothing is selected checkResults(results[2], {server: {ALPN: false, NPN: 'first-priority-unsupported'}, client: {ALPN: false, NPN: false}}); // execute next test Test10(); }); } // Server: NPN, Client: ALPN function Test10() { var serverOptions = { NPNProtocols: ['a', 'b', 'c'] }; var clientsOptions = [{ ALPNProtocols: ['a', 'b', 'c'] }, { ALPNProtocols: ['c', 'b', 'e'] }, { ALPNProtocols: ['first-priority-unsupported', 'x', 'y'] }]; runTest(clientsOptions, serverOptions, function(results) { // nothing is selected checkResults(results[0], {server: {ALPN: false, NPN: 'http/1.1'}, client: {ALPN: false, NPN: false}}); // nothing is selected checkResults(results[1], {server: {ALPN: false, NPN: 'http/1.1'}, client: {ALPN: false, NPN: false}}); // nothing is selected checkResults(results[2], {server: {ALPN: false, NPN: 'http/1.1'}, client: {ALPN: false, NPN: false}}); // execute next test Test11(); }); } // Server: NPN, Client: NPN function Test11() { var serverOptions = { NPNProtocols: ['a', 'b', 'c'] }; var clientsOptions = [{ NPNProtocols: ['a', 'b', 'c'] }, { NPNProtocols: ['c', 'b', 'e'] }, { NPNProtocols: ['first-priority-unsupported', 'x', 'y'] }]; runTest(clientsOptions, serverOptions, function(results) { // 'a' is selected by NPN checkResults(results[0], {server: {ALPN: false, NPN: 'a'}, client: {ALPN: false, NPN: 'a'}}); // 'b' is selected by NPN checkResults(results[1], {server: {ALPN: false, NPN: 'b'}, client: {ALPN: false, NPN: 'b'}}); // nothing is selected checkResults(results[2], {server: {ALPN: false, NPN: 'first-priority-unsupported'}, client: {ALPN: false, NPN: false}}); // execute next test Test12(); }); } // Server: NPN, Client: Nothing function Test12() { var serverOptions = { NPNProtocols: ['a', 'b', 'c'] }; var clientsOptions = [{}, {}, {}]; runTest(clientsOptions, serverOptions, function(results) { // nothing is selected checkResults(results[0], {server: {ALPN: false, NPN: 'http/1.1'}, client: {ALPN: false, NPN: false}}); // nothing is selected checkResults(results[1], {server: {ALPN: false, NPN: 'http/1.1'}, client: {ALPN: false, NPN: false}}); // nothing is selected checkResults(results[2], {server: {ALPN: false, NPN: 'http/1.1'}, client: {ALPN: false, NPN: false}}); // execute next test Test13(); }); } // Server: Nothing, Client: ALPN/NPN function Test13() { var serverOptions = {}; var clientsOptions = [{ ALPNrotocols: ['a', 'b', 'c'], NPNProtocols: ['a', 'b', 'c'] }, { ALPNProtocols: ['c', 'b', 'e'], NPNProtocols: ['c', 'b', 'e'] }, { ALPNProtocols: ['first-priority-unsupported', 'x', 'y'], NPNProtocols: ['first-priority-unsupported', 'x', 'y'] }]; runTest(clientsOptions, serverOptions, function(results) { // nothing is selected checkResults(results[0], {server: {ALPN: false, NPN: 'a'}, client: {ALPN: false, NPN: false}}); // nothing is selected checkResults(results[1], {server: {ALPN: false, NPN: 'c'}, client: {ALPN: false, NPN: false}}); // nothing is selected checkResults(results[2], {server: {ALPN: false, NPN: 'first-priority-unsupported'}, client: {ALPN: false, NPN: false}}); // execute next test Test14(); }); } // Server: Nothing, Client: ALPN function Test14() { var serverOptions = {}; var clientsOptions = [{ ALPNrotocols: ['a', 'b', 'c'] }, { ALPNProtocols: ['c', 'b', 'e'] }, { ALPNProtocols: ['first-priority-unsupported', 'x', 'y'] }]; runTest(clientsOptions, serverOptions, function(results) { // nothing is selected checkResults(results[0], {server: {ALPN: false, NPN: 'http/1.1'}, client: {ALPN: false, NPN: false}}); // nothing is selected checkResults(results[1], {server: {ALPN: false, NPN: 'http/1.1'}, client: {ALPN: false, NPN: false}}); // nothing is selected checkResults(results[2], {server: {ALPN: false, NPN: 'http/1.1'}, client: {ALPN: false, NPN: false}}); // execute next test Test15(); }); } // Server: Nothing, Client: NPN function Test15() { var serverOptions = {}; var clientsOptions = [{ NPNProtocols: ['a', 'b', 'c'] }, { NPNProtocols: ['c', 'b', 'e'] }, { NPNProtocols: ['first-priority-unsupported', 'x', 'y'] }]; runTest(clientsOptions, serverOptions, function(results) { // nothing is selected checkResults(results[0], {server: {ALPN: false, NPN: 'a'}, client: {ALPN: false, NPN: false}}); // nothing is selected checkResults(results[1], {server: {ALPN: false, NPN: 'c'}, client: {ALPN: false, NPN: false}}); // nothing is selected checkResults(results[2], {server: {ALPN: false, NPN: 'first-priority-unsupported'}, client: {ALPN: false, NPN: false}}); // execute next test Test16(); }); } // Server: Nothing, Client: Nothing function Test16() { var serverOptions = {}; var clientsOptions = [{}, {}, {}]; runTest(clientsOptions, serverOptions, function(results) { // nothing is selected checkResults(results[0], {server: {ALPN: false, NPN: 'http/1.1'}, client: {ALPN: false, NPN: false}}); // nothing is selected checkResults(results[1], {server: {ALPN: false, NPN: 'http/1.1'}, client: {ALPN: false, NPN: false}}); // nothing is selected checkResults(results[2], {server: {ALPN: false, NPN: 'http/1.1'}, client: {ALPN: false, NPN: false}}); }); } Test1(); node-v4.8.2/test/parallel/test-tls-async-cb-after-socket-end.js000644 000766 000024 00000002520 13070706737 024477 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var path = require('path'); var fs = require('fs'); var constants = require('constants'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var options = { secureOptions: constants.SSL_OP_NO_TICKET, key: fs.readFileSync(path.join(common.fixturesDir, 'test_key.pem')), cert: fs.readFileSync(path.join(common.fixturesDir, 'test_cert.pem')) }; var server = tls.createServer(options, function(c) { }); var sessionCb = null; var client = null; server.on('newSession', function(key, session, done) { done(); }); server.on('resumeSession', function(id, cb) { sessionCb = cb; next(); }); server.listen(0, function() { var clientOpts = { port: this.address().port, rejectUnauthorized: false, session: false }; var s1 = tls.connect(clientOpts, function() { clientOpts.session = s1.getSession(); console.log('1st secure'); s1.destroy(); var s2 = tls.connect(clientOpts, function(s) { console.log('2nd secure'); s2.destroy(); }).on('connect', function() { console.log('2nd connected'); client = s2; next(); }); }); }); function next() { if (!client || !sessionCb) return; client.destroy(); setTimeout(function() { sessionCb(); server.close(); }, 100); } node-v4.8.2/test/parallel/test-tls-basic-validations.js000644 000766 000024 00000001226 13070706737 023245 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const assert = require('assert'); const tls = require('tls'); { const buffer = Buffer.from('abcd'); const out = {}; tls.convertNPNProtocols(buffer, out); out.NPNProtocols.write('efgh'); assert(buffer.equals(Buffer.from('abcd'))); assert(out.NPNProtocols.equals(Buffer.from('efgh'))); } { const buffer = Buffer.from('abcd'); const out = {}; tls.convertALPNProtocols(buffer, out); out.ALPNProtocols.write('efgh'); assert(buffer.equals(Buffer.from('abcd'))); assert(out.ALPNProtocols.equals(Buffer.from('efgh'))); } node-v4.8.2/test/parallel/test-tls-cert-regression.js000644 000766 000024 00000002775 13070706737 022776 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var cert = `-----BEGIN CERTIFICATE----- MIIBfjCCASgCCQDmmNjAojbDQjANBgkqhkiG9w0BAQUFADBFMQswCQYDVQQGEwJB VTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50ZXJuZXQgV2lkZ2l0 cyBQdHkgTHRkMCAXDTE0MDExNjE3NTMxM1oYDzIyODcxMDMxMTc1MzEzWjBFMQsw CQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50ZXJu ZXQgV2lkZ2l0cyBQdHkgTHRkMFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAPKwlfMX 6HGZIt1xm7fna72eWcOYfUfSxSugghvqYgJt2Oi3lH+wsU1O9FzRIVmpeIjDXhbp Mjsa1HtzSiccPXsCAwEAATANBgkqhkiG9w0BAQUFAANBAHOoKy0NkyfiYH7Ne5ka uvCyndyeB4d24FlfqEUlkfaWCZlNKRaV9YhLDiEg3BcIreFo4brtKQfZzTRs0GVm KHg= -----END CERTIFICATE-----`; var key = `-----BEGIN RSA PRIVATE KEY----- MIIBPQIBAAJBAPKwlfMX6HGZIt1xm7fna72eWcOYfUfSxSugghvqYgJt2Oi3lH+w sU1O9FzRIVmpeIjDXhbpMjsa1HtzSiccPXsCAwEAAQJBAM4uU9aJE0OfdE1p/X+K LrCT3XMdFCJ24GgmHyOURtwDy18upQJecDVdcZp16fjtOPmaW95GoYRyifB3R4I5 RxECIQD7jRM9slCSVV8xp9kOJQNpHjhRQYVGBn+pyllS2sb+RQIhAPb7Y+BIccri NWnuhwCW8hA7Fkj/kaBdAwyW7L3Tvui/AiEAiqLCovMecre4Yi6GcsQ1b/6mvSmm IOS+AT6zIfXPTB0CIQCJKGR3ymN/Qw5crL1GQ41cHCQtF9ickOq/lBUW+j976wIh AOaJnkQrmurlRdePX6LvN/LgGAQoxwovfjcOYNnZsIVY -----END RSA PRIVATE KEY-----`; function test(cert, key, cb) { var server = tls.createServer({ cert: cert, key: key }).listen(0, function() { server.close(cb); }); } test(cert, key, common.mustCall(function() { test(Buffer.from(cert), Buffer.from(key), common.mustCall(function() {})); })); node-v4.8.2/test/parallel/test-tls-check-server-identity.js000644 000766 000024 00000013736 13070706737 024072 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const assert = require('assert'); const util = require('util'); const tls = require('tls'); const tests = [ // False-y values. { host: false, cert: { subject: { CN: 'a.com' } }, error: 'Host: false. is not cert\'s CN: a.com' }, { host: null, cert: { subject: { CN: 'a.com' } }, error: 'Host: null. is not cert\'s CN: a.com' }, { host: undefined, cert: { subject: { CN: 'a.com' } }, error: 'Host: undefined. is not cert\'s CN: a.com' }, // Basic CN handling { host: 'a.com', cert: { subject: { CN: 'a.com' } } }, { host: 'a.com', cert: { subject: { CN: 'A.COM' } } }, { host: 'a.com', cert: { subject: { CN: 'b.com' } }, error: 'Host: a.com. is not cert\'s CN: b.com' }, { host: 'a.com', cert: { subject: { CN: 'a.com.' } } }, { host: 'a.com', cert: { subject: { CN: '.a.com' } }, error: 'Host: a.com. is not cert\'s CN: .a.com' }, // Wildcards in CN { host: 'b.a.com', cert: { subject: { CN: '*.a.com' } } }, { host: 'ba.com', cert: { subject: { CN: '*.a.com' } }, error: 'Host: ba.com. is not cert\'s CN: *.a.com' }, { host: '\n.b.com', cert: { subject: { CN: '*n.b.com' } }, error: 'Host: \n.b.com. is not cert\'s CN: *n.b.com' }, { host: 'b.a.com', cert: { subjectaltname: 'DNS:omg.com', subject: { CN: '*.a.com' } }, error: 'Host: b.a.com. is not in the cert\'s altnames: ' + 'DNS:omg.com' }, { host: 'b.a.com', cert: { subject: { CN: 'b*b.a.com' } }, error: 'Host: b.a.com. is not cert\'s CN: b*b.a.com' }, // Empty Cert { host: 'a.com', cert: { }, error: 'Cert is empty' }, // Multiple CN fields { host: 'foo.com', cert: { subject: { CN: ['foo.com', 'bar.com'] } // CN=foo.com; CN=bar.com; } }, // DNS names and CN { host: 'a.com', cert: { subjectaltname: 'DNS:*', subject: { CN: 'b.com' } }, error: 'Host: a.com. is not in the cert\'s altnames: ' + 'DNS:*' }, { host: 'a.com', cert: { subjectaltname: 'DNS:*.com', subject: { CN: 'b.com' } }, error: 'Host: a.com. is not in the cert\'s altnames: ' + 'DNS:*.com' }, { host: 'a.co.uk', cert: { subjectaltname: 'DNS:*.co.uk', subject: { CN: 'b.com' } } }, { host: 'a.com', cert: { subjectaltname: 'DNS:*.a.com', subject: { CN: 'a.com' } }, error: 'Host: a.com. is not in the cert\'s altnames: ' + 'DNS:*.a.com' }, { host: 'a.com', cert: { subjectaltname: 'DNS:*.a.com', subject: { CN: 'b.com' } }, error: 'Host: a.com. is not in the cert\'s altnames: ' + 'DNS:*.a.com' }, { host: 'a.com', cert: { subjectaltname: 'DNS:a.com', subject: { CN: 'b.com' } } }, { host: 'a.com', cert: { subjectaltname: 'DNS:A.COM', subject: { CN: 'b.com' } } }, // DNS names { host: 'a.com', cert: { subjectaltname: 'DNS:*.a.com', subject: {} }, error: 'Host: a.com. is not in the cert\'s altnames: ' + 'DNS:*.a.com' }, { host: 'b.a.com', cert: { subjectaltname: 'DNS:*.a.com', subject: {} } }, { host: 'c.b.a.com', cert: { subjectaltname: 'DNS:*.a.com', subject: {} }, error: 'Host: c.b.a.com. is not in the cert\'s altnames: ' + 'DNS:*.a.com' }, { host: 'b.a.com', cert: { subjectaltname: 'DNS:*b.a.com', subject: {} } }, { host: 'a-cb.a.com', cert: { subjectaltname: 'DNS:*b.a.com', subject: {} } }, { host: 'a.b.a.com', cert: { subjectaltname: 'DNS:*b.a.com', subject: {} }, error: 'Host: a.b.a.com. is not in the cert\'s altnames: ' + 'DNS:*b.a.com' }, // Mutliple DNS names { host: 'a.b.a.com', cert: { subjectaltname: 'DNS:*b.a.com, DNS:a.b.a.com', subject: {} } }, // URI names { host: 'a.b.a.com', cert: { subjectaltname: 'URI:http://a.b.a.com/', subject: {} } }, { host: 'a.b.a.com', cert: { subjectaltname: 'URI:http://*.b.a.com/', subject: {} }, error: 'Host: a.b.a.com. is not in the cert\'s altnames: ' + 'URI:http://*.b.a.com/' }, // IP addresses { host: 'a.b.a.com', cert: { subjectaltname: 'IP Address:127.0.0.1', subject: {} }, error: 'Host: a.b.a.com. is not in the cert\'s altnames: ' + 'IP Address:127.0.0.1' }, { host: '127.0.0.1', cert: { subjectaltname: 'IP Address:127.0.0.1', subject: {} } }, { host: '127.0.0.2', cert: { subjectaltname: 'IP Address:127.0.0.1', subject: {} }, error: 'IP: 127.0.0.2 is not in the cert\'s list: ' + '127.0.0.1' }, { host: '127.0.0.1', cert: { subjectaltname: 'DNS:a.com', subject: {} }, error: 'IP: 127.0.0.1 is not in the cert\'s list: ' }, { host: 'localhost', cert: { subjectaltname: 'DNS:a.com', subject: { CN: 'localhost' } }, error: 'Host: localhost. is not in the cert\'s altnames: ' + 'DNS:a.com' }, // IDNA { host: 'xn--bcher-kva.example.com', cert: { subject: { CN: '*.example.com' } }, }, // RFC 6125, section 6.4.3: "[...] the client SHOULD NOT attempt to match // a presented identifier where the wildcard character is embedded within // an A-label [...]" { host: 'xn--bcher-kva.example.com', cert: { subject: { CN: 'xn--*.example.com' } }, error: 'Host: xn--bcher-kva.example.com. is not cert\'s CN: ' + 'xn--*.example.com', }, ]; tests.forEach(function(test, i) { const err = tls.checkServerIdentity(test.host, test.cert); assert.strictEqual(err && err.reason, test.error, `Test# ${i} failed: ${util.inspect(test)} \n` + `${test.error} != ${(err && err.reason)}`); }); node-v4.8.2/test/parallel/test-tls-cipher-list.js000644 000766 000024 00000001424 13070706737 022074 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const assert = require('assert'); const spawn = require('child_process').spawn; const defaultCoreList = require('constants').defaultCoreCipherList; function doCheck(arg, check) { var out = ''; arg = arg.concat([ '-pe', 'require("constants").defaultCipherList' ]); spawn(process.execPath, arg, {}). on('error', common.fail). stdout.on('data', function(chunk) { out += chunk; }).on('end', function() { assert.equal(out.trim(), check); }).on('error', common.fail); } // test the default unmodified version doCheck([], defaultCoreList); // test the command line switch by itself doCheck(['--tls-cipher-list=ABC'], 'ABC'); node-v4.8.2/test/parallel/test-tls-client-abort.js000644 000766 000024 00000001144 13070706737 022233 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var fs = require('fs'); var path = require('path'); var cert = fs.readFileSync(path.join(common.fixturesDir, 'test_cert.pem')); var key = fs.readFileSync(path.join(common.fixturesDir, 'test_key.pem')); var conn = tls.connect({cert: cert, key: key, port: common.PORT}, function() { assert.ok(false); // callback should never be executed }); conn.on('error', function() { }); assert.doesNotThrow(function() { conn.destroy(); }); node-v4.8.2/test/parallel/test-tls-client-abort2.js000644 000766 000024 00000000525 13070706737 022317 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var conn = tls.connect(common.PORT, common.fail); conn.on('error', common.mustCall(function() { assert.doesNotThrow(function() { conn.destroy(); }); })); node-v4.8.2/test/parallel/test-tls-client-default-ciphers.js000644 000766 000024 00000000754 13070706737 024211 0ustar00iojsstaff000000 000000 'use strict'; var assert = require('assert'); var common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); function Done() {} function test1() { var ciphers = ''; tls.createSecureContext = function(options) { ciphers = options.ciphers; throw new Done(); }; try { tls.connect(common.PORT); } catch (e) { assert(e instanceof Done); } assert.equal(ciphers, tls.DEFAULT_CIPHERS); } test1(); node-v4.8.2/test/parallel/test-tls-client-destroy-soon.js000644 000766 000024 00000002262 13070706737 023573 0ustar00iojsstaff000000 000000 'use strict'; // Create an ssl server. First connection, validate that not resume. // Cache session and close connection. Use session on second connection. // ASSERT resumption. var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var fs = require('fs'); var options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent2-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent2-cert.pem') }; var big = new Buffer(2 * 1024 * 1024); big.fill('Y'); // create server var server = tls.createServer(options, common.mustCall(function(socket) { socket.end(big); socket.destroySoon(); })); // start listening server.listen(0, common.mustCall(function() { var client = tls.connect({ port: this.address().port, rejectUnauthorized: false }, common.mustCall(function() { var bytesRead = 0; client.on('readable', function() { var d = client.read(); if (d) bytesRead += d.length; }); client.on('end', common.mustCall(function() { server.close(); assert.strictEqual(big.length, bytesRead); })); })); })); node-v4.8.2/test/parallel/test-tls-client-reject.js000644 000766 000024 00000002746 13070706737 022411 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var fs = require('fs'); var path = require('path'); var options = { key: fs.readFileSync(path.join(common.fixturesDir, 'test_key.pem')), cert: fs.readFileSync(path.join(common.fixturesDir, 'test_cert.pem')) }; var server = tls.createServer(options, common.mustCall(function(socket) { socket.on('data', function(data) { console.error(data.toString()); assert.equal(data, 'ok'); }); }, 3)).listen(0, function() { unauthorized(); }); function unauthorized() { var socket = tls.connect({ port: server.address().port, servername: 'localhost', rejectUnauthorized: false }, function() { assert(!socket.authorized); socket.end(); rejectUnauthorized(); }); socket.on('error', common.fail); socket.write('ok'); } function rejectUnauthorized() { var socket = tls.connect(server.address().port, { servername: 'localhost' }, common.fail); socket.on('error', function(err) { console.error(err); authorized(); }); socket.write('ng'); } function authorized() { var socket = tls.connect(server.address().port, { ca: [fs.readFileSync(path.join(common.fixturesDir, 'test_cert.pem'))], servername: 'localhost' }, function() { assert(socket.authorized); socket.end(); server.close(); }); socket.on('error', common.fail); socket.write('ok'); } node-v4.8.2/test/parallel/test-tls-client-resume.js000644 000766 000024 00000002630 13070706737 022425 0ustar00iojsstaff000000 000000 'use strict'; // Create an ssl server. First connection, validate that not resume. // Cache session and close connection. Use session on second connection. // ASSERT resumption. var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var fs = require('fs'); var options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent2-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent2-cert.pem') }; // create server var server = tls.Server(options, common.mustCall(function(socket) { socket.end('Goodbye'); }, 2)); // start listening server.listen(0, function() { var session1 = null; var client1 = tls.connect({ port: this.address().port, rejectUnauthorized: false }, function() { console.log('connect1'); assert.ok(!client1.isSessionReused(), 'Session *should not* be reused.'); session1 = client1.getSession(); }); client1.on('close', function() { console.log('close1'); var opts = { port: server.address().port, rejectUnauthorized: false, session: session1 }; var client2 = tls.connect(opts, function() { console.log('connect2'); assert.ok(client2.isSessionReused(), 'Session *should* be reused.'); }); client2.on('close', function() { console.log('close2'); server.close(); }); }); }); node-v4.8.2/test/parallel/test-tls-client-verify.js000644 000766 000024 00000006232 13070706737 022433 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const tls = require('tls'); const fs = require('fs'); const hosterr = /Hostname\/IP doesn't match certificate's altnames/g; const testCases = [{ ca: ['ca1-cert'], key: 'agent2-key', cert: 'agent2-cert', servers: [ { ok: true, key: 'agent1-key', cert: 'agent1-cert' }, { ok: false, key: 'agent2-key', cert: 'agent2-cert' }, { ok: false, key: 'agent3-key', cert: 'agent3-cert' } ] }, { ca: [], key: 'agent2-key', cert: 'agent2-cert', servers: [ { ok: false, key: 'agent1-key', cert: 'agent1-cert' }, { ok: false, key: 'agent2-key', cert: 'agent2-cert' }, { ok: false, key: 'agent3-key', cert: 'agent3-cert' } ] }, { ca: ['ca1-cert', 'ca2-cert'], key: 'agent2-key', cert: 'agent2-cert', servers: [ { ok: true, key: 'agent1-key', cert: 'agent1-cert' }, { ok: false, key: 'agent2-key', cert: 'agent2-cert' }, { ok: true, key: 'agent3-key', cert: 'agent3-cert' } ] } ]; function filenamePEM(n) { return require('path').join(common.fixturesDir, 'keys', n + '.pem'); } function loadPEM(n) { return fs.readFileSync(filenamePEM(n)); } let successfulTests = 0; function testServers(index, servers, clientOptions, cb) { const serverOptions = servers[index]; if (!serverOptions) { cb(); return; } const ok = serverOptions.ok; if (serverOptions.key) { serverOptions.key = loadPEM(serverOptions.key); } if (serverOptions.cert) { serverOptions.cert = loadPEM(serverOptions.cert); } const server = tls.createServer(serverOptions, common.mustCall(function(s) { s.end('hello world\n'); })); server.listen(0, common.mustCall(function() { let b = ''; console.error('connecting...'); clientOptions.port = this.address().port; const client = tls.connect(clientOptions, common.mustCall(function() { const authorized = client.authorized || hosterr.test(client.authorizationError); console.error('expected: ' + ok + ' authed: ' + authorized); assert.strictEqual(ok, authorized); server.close(); })); client.on('data', function(d) { b += d.toString(); }); client.on('end', common.mustCall(function() { assert.strictEqual('hello world\n', b); })); client.on('close', common.mustCall(function() { testServers(index + 1, servers, clientOptions, cb); })); })); } function runTest(testIndex) { var tcase = testCases[testIndex]; if (!tcase) return; const clientOptions = { port: undefined, ca: tcase.ca.map(loadPEM), key: loadPEM(tcase.key), cert: loadPEM(tcase.cert), rejectUnauthorized: false }; testServers(0, tcase.servers, clientOptions, common.mustCall(function() { successfulTests++; runTest(testIndex + 1); })); } runTest(0); process.on('exit', function() { console.log('successful tests: %d', successfulTests); assert.equal(successfulTests, testCases.length); }); node-v4.8.2/test/parallel/test-tls-close-error.js000644 000766 000024 00000001266 13070706737 022111 0ustar00iojsstaff000000 000000 'use strict'; var assert = require('assert'); var common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var fs = require('fs'); var server = tls.createServer({ key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }, function(c) { }).listen(0, common.mustCall(function() { var c = tls.connect(this.address().port, function() { assert(false, 'should not be called'); }); c.on('error', common.mustCall(function(err) {})); c.on('close', common.mustCall(function(err) { assert.ok(err); server.close(); })); })); node-v4.8.2/test/parallel/test-tls-close-notify.js000644 000766 000024 00000001425 13070706737 022265 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var fs = require('fs'); var server = tls.createServer({ key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }, function(c) { // Send close-notify without shutting down TCP socket if (c._handle.shutdownSSL() !== 1) c._handle.shutdownSSL(); }).listen(0, common.mustCall(function() { var c = tls.connect(this.address().port, { rejectUnauthorized: false }, common.mustCall(function() { // Ensure that we receive 'end' event anyway c.on('end', common.mustCall(function() { c.destroy(); server.close(); })); })); })); node-v4.8.2/test/parallel/test-tls-cnnic-whitelist.js000644 000766 000024 00000003752 13070706737 022763 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const assert = require('assert'); const tls = require('tls'); const fs = require('fs'); const path = require('path'); function filenamePEM(n) { return path.join(common.fixturesDir, 'keys', n + '.pem'); } function loadPEM(n) { return fs.readFileSync(filenamePEM(n)); } const testCases = [ { // Test 0: for the check of a cert not existed in the whitelist. // agent7-cert.pem is issued by the fake CNNIC root CA so that its // hash is not listed in the whitelist. // fake-cnnic-root-cert has the same subject name as the original // rootCA. serverOpts: { key: loadPEM('agent7-key'), cert: loadPEM('agent7-cert') }, clientOpts: { port: undefined, rejectUnauthorized: true, ca: [loadPEM('fake-cnnic-root-cert')] }, errorCode: 'CERT_REVOKED' }, // Test 1: for the fix of node#2061 // agent6-cert.pem is signed by intermidate cert of ca3. // The server has a cert chain of agent6->ca3->ca1(root) but // tls.connect should be failed with an error of // UNABLE_TO_GET_ISSUER_CERT_LOCALLY since the root CA of ca1 is not // installed locally. { serverOpts: { ca: loadPEM('ca3-key'), key: loadPEM('agent6-key'), cert: loadPEM('agent6-cert') }, clientOpts: { port: undefined, rejectUnauthorized: true }, errorCode: 'UNABLE_TO_GET_ISSUER_CERT_LOCALLY' } ]; function runTest(tindex) { const tcase = testCases[tindex]; if (!tcase) return; const server = tls.createServer(tcase.serverOpts, (s) => { s.resume(); }).listen(0, common.mustCall(function() { tcase.clientOpts = this.address().port; const client = tls.connect(tcase.clientOpts); client.on('error', common.mustCall((e) => { assert.strictEqual(e.code, tcase.errorCode); server.close(common.mustCall(() => { runTest(tindex + 1); })); })); })); } runTest(0); node-v4.8.2/test/parallel/test-tls-connect-address-family.js000644 000766 000024 00000002202 13070706737 024177 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); if (!common.hasIPv6) { common.skip('no IPv6 support'); return; } const assert = require('assert'); const tls = require('tls'); const dns = require('dns'); function runTest() { const ciphers = 'AECDH-NULL-SHA'; tls.createServer({ ciphers }, common.mustCall(function() { this.close(); })).listen(0, '::1', common.mustCall(function() { const options = { host: 'localhost', port: this.address().port, family: 6, ciphers: ciphers, rejectUnauthorized: false, }; // Will fail with ECONNREFUSED if the address family is not honored. tls.connect(options).once('secureConnect', common.mustCall(function() { assert.strictEqual('::1', this.remoteAddress); this.destroy(); })); })); } dns.lookup('localhost', {family: 6, all: true}, (err, addresses) => { if (err) { if (err.code === 'ENOTFOUND') { common.skip('localhost does not resolve to ::1'); return; } throw err; } if (addresses.some((val) => val.address === '::1')) runTest(); else common.skip('localhost does not resolve to ::1'); }); node-v4.8.2/test/parallel/test-tls-connect-given-socket.js000644 000766 000024 00000003446 13070706737 023704 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var net = require('net'); var fs = require('fs'); var path = require('path'); var serverConnected = 0; var clientConnected = 0; var options = { key: fs.readFileSync(path.join(common.fixturesDir, 'test_key.pem')), cert: fs.readFileSync(path.join(common.fixturesDir, 'test_cert.pem')) }; var server = tls.createServer(options, function(socket) { serverConnected++; socket.end('Hello'); }).listen(0, function() { var waiting = 2; function establish(socket) { var client = tls.connect({ rejectUnauthorized: false, socket: socket }, function() { clientConnected++; var data = ''; client.on('data', function(chunk) { data += chunk.toString(); }); client.on('end', function() { assert.equal(data, 'Hello'); if (--waiting === 0) server.close(); }); }); assert(client.readable); assert(client.writable); return client; } // Immediate death socket var immediateDeath = net.connect(this.address().port); establish(immediateDeath).destroy(); // Outliving var outlivingTCP = net.connect(this.address().port); outlivingTCP.on('connect', function() { outlivingTLS.destroy(); next(); }); var outlivingTLS = establish(outlivingTCP); function next() { // Already connected socket var connected = net.connect(server.address().port, function() { establish(connected); }); // Connecting socket var connecting = net.connect(server.address().port); establish(connecting); } }); process.on('exit', function() { assert.equal(serverConnected, 2); assert.equal(clientConnected, 2); }); node-v4.8.2/test/parallel/test-tls-connect-no-host.js000644 000766 000024 00000001725 13070706737 022673 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var assert = require('assert'); var fs = require('fs'); var path = require('path'); var cert = fs.readFileSync(path.join(common.fixturesDir, 'test_cert.pem')); var key = fs.readFileSync(path.join(common.fixturesDir, 'test_key.pem')); // https://github.com/nodejs/node/issues/1489 // tls.connect(options) with no options.host should accept a cert with // CN:'localhost' tls.createServer({ key: key, cert: cert }).listen(0, function() { var socket = tls.connect({ port: this.address().port, ca: cert, // No host set here. 'localhost' is the default, // but tls.checkServerIdentity() breaks before the fix with: // Error: Hostname/IP doesn't match certificate's altnames: // "Host: undefined. is not cert's CN: localhost" }, function() { assert(socket.authorized); process.exit(); }); }); node-v4.8.2/test/parallel/test-tls-connect-pipe.js000644 000766 000024 00000001222 13070706737 022231 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var fs = require('fs'); var options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }; common.refreshTmpDir(); var server = tls.Server(options, common.mustCall(function(socket) { server.close(); })); server.listen(common.PIPE, common.mustCall(function() { var options = { rejectUnauthorized: false }; var client = tls.connect(common.PIPE, options, common.mustCall(function() { client.end(); })); })); node-v4.8.2/test/parallel/test-tls-connect-secure-context.js000644 000766 000024 00000001544 13070706737 024253 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); if (!common.hasCrypto) { console.log('1..0 # Skipped: missing crypto'); return; } const tls = require('tls'); const fs = require('fs'); const path = require('path'); const keysDir = path.join(common.fixturesDir, 'keys'); const ca = fs.readFileSync(path.join(keysDir, 'ca1-cert.pem')); const cert = fs.readFileSync(path.join(keysDir, 'agent1-cert.pem')); const key = fs.readFileSync(path.join(keysDir, 'agent1-key.pem')); const server = tls.createServer({ cert: cert, key: key }, function(c) { c.end(); }).listen(common.PORT, function() { const secureContext = tls.createSecureContext({ ca: ca }); const socket = tls.connect({ secureContext: secureContext, servername: 'agent1', port: common.PORT }, common.mustCall(function() { server.close(); socket.end(); })); }); node-v4.8.2/test/parallel/test-tls-connect-simple.js000644 000766 000024 00000002021 13070706737 022563 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const tls = require('tls'); const fs = require('fs'); let serverConnected = 0; const options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }; const server = tls.Server(options, common.mustCall(function(socket) { if (++serverConnected === 2) { server.close(common.mustCall(function() {})); server.on('close', common.mustCall(function() {})); } }, 2)); server.listen(0, function() { const client1options = { port: this.address().port, rejectUnauthorized: false }; const client1 = tls.connect(client1options, common.mustCall(function() { client1.end(); })); const client2options = { port: this.address().port, rejectUnauthorized: false }; const client2 = tls.connect(client2options); client2.on('secureConnect', common.mustCall(function() { client2.end(); })); }); node-v4.8.2/test/parallel/test-tls-connect-stream-writes.js000644 000766 000024 00000002771 13070706737 024114 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const fs = require('fs'); const tls = require('tls'); const stream = require('stream'); const net = require('net'); var server; var cert_dir = common.fixturesDir; var options = { key: fs.readFileSync(cert_dir + '/test_key.pem'), cert: fs.readFileSync(cert_dir + '/test_cert.pem'), ca: [ fs.readFileSync(cert_dir + '/test_ca.pem') ], ciphers: 'AES256-GCM-SHA384' }; var content = 'hello world'; var recv_bufs = []; var send_data = ''; server = tls.createServer(options, function(s) { s.on('data', function(c) { recv_bufs.push(c); }); }); server.listen(0, function() { var raw = net.connect(this.address().port); var pending = false; raw.on('readable', function() { if (pending) p._read(); }); var p = new stream.Duplex({ read: function read() { pending = false; var chunk = raw.read(); if (chunk) { this.push(chunk); } else { pending = true; } }, write: function write(data, enc, cb) { raw.write(data, enc, cb); } }); var socket = tls.connect({ socket: p, rejectUnauthorized: false }, function() { for (var i = 0; i < 50; ++i) { socket.write(content); send_data += content; } socket.end(); server.close(); }); }); process.on('exit', function() { var recv_data = (Buffer.concat(recv_bufs)).toString(); assert.strictEqual(send_data, recv_data); }); node-v4.8.2/test/parallel/test-tls-connect.js000644 000766 000024 00000002144 13070706737 021302 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var fs = require('fs'); var path = require('path'); // https://github.com/joyent/node/issues/1218 // uncatchable exception on TLS connection error (function() { var cert = fs.readFileSync(path.join(common.fixturesDir, 'test_cert.pem')); var key = fs.readFileSync(path.join(common.fixturesDir, 'test_key.pem')); var options = {cert: cert, key: key, port: common.PORT}; var conn = tls.connect(options, common.fail); conn.on('error', common.mustCall(function() {})); })(); // SSL_accept/SSL_connect error handling (function() { var cert = fs.readFileSync(path.join(common.fixturesDir, 'test_cert.pem')); var key = fs.readFileSync(path.join(common.fixturesDir, 'test_key.pem')); var conn = tls.connect({ cert: cert, key: key, port: common.PORT, ciphers: 'rick-128-roll' }, function() { assert.ok(false); // callback should never be executed }); conn.on('error', common.mustCall(function() {})); })(); node-v4.8.2/test/parallel/test-tls-delayed-attach-error.js000644 000766 000024 00000001604 13070706737 023651 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var fs = require('fs'); var net = require('net'); var bonkers = new Buffer(1024); bonkers.fill(42); var options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }; var server = net.createServer(common.mustCall(function(c) { setTimeout(common.mustCall(function() { var s = new tls.TLSSocket(c, { isServer: true, secureContext: tls.createSecureContext(options) }); s.on('_tlsError', common.mustCall(function() {})); s.on('close', function() { server.close(); s.destroy(); }); }), 200); })).listen(0, function() { var c = net.connect({port: this.address().port}, function() { c.write(bonkers); }); }); node-v4.8.2/test/parallel/test-tls-delayed-attach.js000644 000766 000024 00000001746 13070706737 022531 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var fs = require('fs'); var net = require('net'); var sent = 'hello world'; var received = ''; var options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }; var server = net.createServer(function(c) { setTimeout(function() { var s = new tls.TLSSocket(c, { isServer: true, secureContext: tls.createSecureContext(options) }); s.on('data', function(chunk) { received += chunk; }); s.on('end', function() { server.close(); s.destroy(); }); }, 200); }).listen(0, function() { var c = tls.connect(this.address().port, { rejectUnauthorized: false }, function() { c.end(sent); }); }); process.on('exit', function() { assert.equal(received, sent); }); node-v4.8.2/test/parallel/test-tls-destroy-whilst-write.js000644 000766 000024 00000000770 13070706737 024005 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const tls = require('tls'); const stream = require('stream'); const delay = new stream.Duplex({ read: function read() { }, write: function write(data, enc, cb) { console.log('pending'); setImmediate(function() { console.log('done'); cb(); }); } }); const secure = tls.connect({ socket: delay }); setImmediate(function() { secure.destroy(); }); node-v4.8.2/test/parallel/test-tls-dhe.js000644 000766 000024 00000004350 13070706737 020412 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var spawn = require('child_process').spawn; var fs = require('fs'); var key = fs.readFileSync(common.fixturesDir + '/keys/agent2-key.pem'); var cert = fs.readFileSync(common.fixturesDir + '/keys/agent2-cert.pem'); var nsuccess = 0; var ntests = 0; var ciphers = 'DHE-RSA-AES128-SHA256:ECDHE-RSA-AES128-SHA256'; function loadDHParam(n) { var path = common.fixturesDir; if (n !== 'error') path += '/keys'; return fs.readFileSync(path + '/dh' + n + '.pem'); } function test(keylen, expectedCipher, cb) { var options = { key: key, cert: cert, ciphers: ciphers, dhparam: loadDHParam(keylen) }; var server = tls.createServer(options, function(conn) { conn.end(); }); server.on('close', function(err) { assert(!err); if (cb) cb(); }); server.listen(0, '127.0.0.1', function() { var args = ['s_client', '-connect', `127.0.0.1:${this.address().port}`, '-cipher', ciphers]; // for the performance and stability issue in s_client on Windows if (common.isWindows) args.push('-no_rand_screen'); var client = spawn(common.opensslCli, args); var out = ''; client.stdout.setEncoding('utf8'); client.stdout.on('data', function(d) { out += d; }); client.stdout.on('end', function() { // DHE key length can be checked -brief option in s_client but it // is only supported in openssl 1.0.2 so we cannot check it. var reg = new RegExp('Cipher : ' + expectedCipher); if (reg.test(out)) { nsuccess++; server.close(); } }); }); } function test512() { assert.throws(function() { test(512, 'DHE-RSA-AES128-SHA256', null); }, /DH parameter is less than 1024 bits/); } function test1024() { test(1024, 'DHE-RSA-AES128-SHA256', test2048); ntests++; } function test2048() { test(2048, 'DHE-RSA-AES128-SHA256', testError); ntests++; } function testError() { test('error', 'ECDHE-RSA-AES128-SHA256', test512); ntests++; } test1024(); process.on('exit', function() { assert.equal(ntests, nsuccess); assert.equal(ntests, 3); }); node-v4.8.2/test/parallel/test-tls-ecdh-disable.js000644 000766 000024 00000002067 13070706737 022161 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var exec = require('child_process').exec; var fs = require('fs'); var options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent2-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent2-cert.pem'), ciphers: 'ECDHE-RSA-RC4-SHA', ecdhCurve: false }; var server = tls.createServer(options, common.fail); server.listen(0, '127.0.0.1', common.mustCall(function() { var cmd = '"' + common.opensslCli + '" s_client -cipher ' + options.ciphers + ` -connect 127.0.0.1:${this.address().port}`; // for the performance and stability issue in s_client on Windows if (common.isWindows) cmd += ' -no_rand_screen'; exec(cmd, common.mustCall(function(err, stdout, stderr) { // Old versions of openssl will still exit with 0 so we // can't just check if err is not null. assert(stderr.includes('handshake failure')); server.close(); })); })); node-v4.8.2/test/parallel/test-tls-ecdh.js000644 000766 000024 00000002134 13070706737 020553 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var exec = require('child_process').exec; var fs = require('fs'); var options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent2-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent2-cert.pem'), ciphers: '-ALL:ECDHE-RSA-AES128-SHA256', ecdhCurve: 'prime256v1' }; var reply = 'I AM THE WALRUS'; // something recognizable var server = tls.createServer(options, common.mustCall(function(conn) { conn.end(reply); })); server.listen(0, '127.0.0.1', common.mustCall(function() { var cmd = '"' + common.opensslCli + '" s_client -cipher ' + options.ciphers + ` -connect 127.0.0.1:${this.address().port}`; // for the performance and stability issue in s_client on Windows if (common.isWindows) cmd += ' -no_rand_screen'; exec(cmd, common.mustCall(function(err, stdout, stderr) { if (err) throw err; assert.notEqual(stdout.indexOf(reply), -1); server.close(); })); })); node-v4.8.2/test/parallel/test-tls-econnreset.js000644 000766 000024 00000005105 13070706737 022016 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var cacert = `-----BEGIN CERTIFICATE----- MIIBxTCCAX8CAnXnMA0GCSqGSIb3DQEBBQUAMH0xCzAJBgNVBAYTAlVTMQswCQYD VQQIEwJDQTEWMBQGA1UEBxMNU2FuIEZyYW5jaXNjbzEZMBcGA1UEChMQU3Ryb25n TG9vcCwgSW5jLjESMBAGA1UECxMJU3Ryb25nT3BzMRowGAYDVQQDExFjYS5zdHJv bmdsb29wLmNvbTAeFw0xNDAxMTcyMjE1MDdaFw00MTA2MDMyMjE1MDdaMH0xCzAJ BgNVBAYTAlVTMQswCQYDVQQIEwJDQTEWMBQGA1UEBxMNU2FuIEZyYW5jaXNjbzEZ MBcGA1UEChMQU3Ryb25nTG9vcCwgSW5jLjESMBAGA1UECxMJU3Ryb25nT3BzMRow GAYDVQQDExFjYS5zdHJvbmdsb29wLmNvbTBMMA0GCSqGSIb3DQEBAQUAAzsAMDgC MQDKbQ6rIR5t1q1v4Ha36jrq0IkyUohy9EYNvLnXUly1PGqxby0ILlAVJ8JawpY9 AVkCAwEAATANBgkqhkiG9w0BAQUFAAMxALA1uS4CqQXRSAyYTfio5oyLGz71a+NM +0AFLBwh5AQjhGd0FcenU4OfHxyDEOJT/Q== -----END CERTIFICATE-----`; var cert = `-----BEGIN CERTIFICATE----- MIIBfDCCATYCAgQaMA0GCSqGSIb3DQEBBQUAMH0xCzAJBgNVBAYTAlVTMQswCQYD VQQIEwJDQTEWMBQGA1UEBxMNU2FuIEZyYW5jaXNjbzEZMBcGA1UEChMQU3Ryb25n TG9vcCwgSW5jLjESMBAGA1UECxMJU3Ryb25nT3BzMRowGAYDVQQDExFjYS5zdHJv bmdsb29wLmNvbTAeFw0xNDAxMTcyMjE1MDdaFw00MTA2MDMyMjE1MDdaMBkxFzAV BgNVBAMTDnN0cm9uZ2xvb3AuY29tMEwwDQYJKoZIhvcNAQEBBQADOwAwOAIxAMfk I0LWU15pPUwIQNMnRVhhOibi0TQmAau8FBtgwEfGK01WpfGUaJr1a41K8Uq7xwID AQABoxkwFzAVBgNVHREEDjAMhwQAAAAAhwR/AAABMA0GCSqGSIb3DQEBBQUAAzEA cGpYrhkrb7mIh9DNhV0qp7pGjqBzlHqB7KQXw2luLDp//6dyHBMexDCQznkhZKRU -----END CERTIFICATE-----`; var key = `-----BEGIN RSA PRIVATE KEY----- MIH0AgEAAjEAx+QjQtZTXmk9TAhA0ydFWGE6JuLRNCYBq7wUG2DAR8YrTVal8ZRo mvVrjUrxSrvHAgMBAAECMBCGccvSwC2r8Z9Zh1JtirQVxaL1WWpAQfmVwLe0bAgg /JWMU/6hS36TsYyZMxwswQIZAPTAfht/zDLb7Hwgu2twsS1Ra9w/yyvtlwIZANET 26votwJAHK1yUrZGA5nnp5qcmQ/JUQIZAII5YV/UUZvF9D/fUplJ7puENPWNY9bN pQIZAMMwxuS3XiO7two2sQF6W+JTYyX1DPCwAQIZAOYg1TvEGT38k8e8jygv8E8w YqrWTeQFNQ== -----END RSA PRIVATE KEY-----`; var ca = [ cert, cacert ]; var clientError = null; var connectError = null; var server = tls.createServer({ ca: ca, cert: cert, key: key }, function(conn) { throw 'unreachable'; }).on('clientError', function(err, conn) { assert(!clientError && conn); clientError = err; }).listen(0, function() { var options = { ciphers: 'AES128-GCM-SHA256', port: this.address().port, ca: ca }; tls.connect(options).on('error', function(err) { assert(!connectError); connectError = err; this.destroy(); server.close(); }).write('123'); }); process.on('exit', function() { assert(clientError); assert(connectError); assert(/socket hang up/.test(clientError.message)); assert(/ECONNRESET/.test(clientError.code)); }); node-v4.8.2/test/parallel/test-tls-empty-sni-context.js000644 000766 000024 00000002000 13070706737 023247 0ustar00iojsstaff000000 000000 'use strict'; if (!process.features.tls_sni) { console.log('1..0 # Skipped: node compiled without OpenSSL or ' + 'with old OpenSSL version.'); return; } const common = require('../common'); const assert = require('assert'); if (!common.hasCrypto) { console.log('1..0 # Skipped: missing crypto'); return; } const tls = require('tls'); const options = { SNICallback: (name, callback) => { callback(null, tls.createSecureContext()); } }; const server = tls.createServer(options, (c) => { common.fail('Should not be called'); }).on('clientError', common.mustCall((err, c) => { assert(/SSL_use_certificate:passed a null parameter/i.test(err.message)); server.close(); })).listen(0, common.mustCall(() => { const c = tls.connect({ port: server.address().port, rejectUnauthorized: false, servername: 'any.name' }, () => { common.fail('Should not be called'); }); c.on('error', common.mustCall((err) => { assert(/socket hang up/.test(err.message)); })); })); node-v4.8.2/test/parallel/test-tls-env-bad-extra-ca.js000644 000766 000024 00000002034 13070706737 022665 0ustar00iojsstaff000000 000000 // Setting NODE_EXTRA_CA_CERTS to non-existent file emits a warning 'use strict'; const common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const assert = require('assert'); const tls = require('tls'); const fork = require('child_process').fork; if (process.env.CHILD) { // This will try to load the extra CA certs, and emit a warning when it fails. return tls.createServer({}); } const env = { CHILD: 'yes', NODE_EXTRA_CA_CERTS: common.fixturesDir + '/no-such-file-exists', }; var opts = { env: env, silent: true, }; var stderr = ''; fork(__filename, opts) .on('exit', common.mustCall(function(status) { assert.equal(status, 0, 'client did not succeed in connecting'); })) .on('close', common.mustCall(function() { assert(stderr.match(new RegExp( 'Warning: Ignoring extra certs from.*no-such-file-exists' + '.* load failed:.*No such file or directory' )), stderr); })) .stderr.setEncoding('utf8').on('data', function(str) { stderr += str; }); node-v4.8.2/test/parallel/test-tls-env-extra-ca.js000644 000766 000024 00000002136 13070706737 022144 0ustar00iojsstaff000000 000000 // Certs in NODE_EXTRA_CA_CERTS are used for TLS peer validation 'use strict'; const common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const assert = require('assert'); const tls = require('tls'); const fork = require('child_process').fork; const fs = require('fs'); if (process.env.CHILD) { const copts = { port: process.env.PORT, checkServerIdentity: function() {}, }; const client = tls.connect(copts, function() { client.end('hi'); }); return; } const options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem'), }; const server = tls.createServer(options, function(s) { s.end('bye'); server.close(); }).listen(0, common.mustCall(function() { const env = { CHILD: 'yes', PORT: this.address().port, NODE_EXTRA_CA_CERTS: common.fixturesDir + '/keys/ca1-cert.pem', }; fork(__filename, {env: env}).on('exit', common.mustCall(function(status) { assert.equal(status, 0, 'client did not succeed in connecting'); })); })); node-v4.8.2/test/parallel/test-tls-external-accessor.js000644 000766 000024 00000001150 13070706737 023267 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } // Ensure accessing ._external doesn't hit an assert in the accessor method. const tls = require('tls'); { const pctx = tls.createSecureContext().context; const cctx = Object.create(pctx); assert.throws(() => cctx._external, /incompatible receiver/); pctx._external; } { const pctx = tls.createSecurePair().credentials.context; const cctx = Object.create(pctx); assert.throws(() => cctx._external, /incompatible receiver/); pctx._external; } node-v4.8.2/test/parallel/test-tls-fast-writing.js000644 000766 000024 00000002662 13070706737 022274 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var fs = require('fs'); var dir = common.fixturesDir; var options = { key: fs.readFileSync(dir + '/test_key.pem'), cert: fs.readFileSync(dir + '/test_cert.pem'), ca: [ fs.readFileSync(dir + '/test_ca.pem') ] }; var server = tls.createServer(options, onconnection); var gotChunk = false; var gotDrain = false; setTimeout(function() { console.log('not ok - timed out'); process.exit(1); }, common.platformTimeout(1000)); function onconnection(conn) { conn.on('data', function(c) { if (!gotChunk) { gotChunk = true; console.log('ok - got chunk'); } // just some basic sanity checks. assert(c.length); assert(Buffer.isBuffer(c)); if (gotDrain) process.exit(0); }); } server.listen(0, function() { var chunk = new Buffer(1024); chunk.fill('x'); var opt = { port: this.address().port, rejectUnauthorized: false }; var conn = tls.connect(opt, function() { conn.on('drain', ondrain); write(); }); function ondrain() { if (!gotDrain) { gotDrain = true; console.log('ok - got drain'); } if (gotChunk) process.exit(0); write(); } function write() { // this needs to return false eventually while (false !== conn.write(chunk)); } }); node-v4.8.2/test/parallel/test-tls-friendly-error-message.js000644 000766 000024 00000001500 13070706737 024231 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const tls = require('tls'); const fs = require('fs'); const key = fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'); const cert = fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem'); tls.createServer({ key: key, cert: cert }, common.mustCall(function(conn) { conn.end(); this.close(); })).listen(0, common.mustCall(function() { var options = { port: this.address().port, rejectUnauthorized: true }; tls.connect(options).on('error', common.mustCall(function(err) { assert.strictEqual(err.code, 'UNABLE_TO_VERIFY_LEAF_SIGNATURE'); assert.strictEqual(err.message, 'unable to verify the first certificate'); this.destroy(); })); })); node-v4.8.2/test/parallel/test-tls-getcipher.js000644 000766 000024 00000002011 13070706737 021614 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var fs = require('fs'); var cipher_list = ['AES128-SHA256', 'AES256-SHA256']; var cipher_version_pattern = /TLS|SSL/; var options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent2-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent2-cert.pem'), ciphers: cipher_list.join(':'), honorCipherOrder: true }; var server = tls.createServer(options, common.mustCall(function(cleartextStream) {})); server.listen(0, '127.0.0.1', function() { var client = tls.connect({ host: '127.0.0.1', port: this.address().port, ciphers: cipher_list.join(':'), rejectUnauthorized: false }, function() { var cipher = client.getCipher(); assert.equal(cipher.name, cipher_list[0]); assert(cipher_version_pattern.test(cipher.version)); client.end(); server.close(); }); }); node-v4.8.2/test/parallel/test-tls-handshake-error.js000644 000766 000024 00000001446 13070706737 022732 0ustar00iojsstaff000000 000000 'use strict'; var assert = require('assert'); var common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var fs = require('fs'); var server = tls.createServer({ key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem'), rejectUnauthorized: true }, function(c) { }).listen(0, common.mustCall(function() { var c = tls.connect({ port: this.address().port, ciphers: 'RC4' }, function() { assert(false, 'should not be called'); }); c.on('error', common.mustCall(function(err) { assert.notEqual(err.code, 'ECONNRESET'); })); c.on('close', common.mustCall(function(err) { assert.ok(err); server.close(); })); })); node-v4.8.2/test/parallel/test-tls-handshake-nohang.js000644 000766 000024 00000000413 13070706737 023044 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); // neither should hang tls.createSecurePair(null, false, false, false); tls.createSecurePair(null, true, false, false); node-v4.8.2/test/parallel/test-tls-hello-parser-failure.js000644 000766 000024 00000001732 13070706737 023675 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var net = require('net'); var fs = require('fs'); var options = { key: fs.readFileSync(common.fixturesDir + '/test_key.pem'), cert: fs.readFileSync(common.fixturesDir + '/test_cert.pem') }; var bonkers = new Buffer(1024 * 1024); bonkers.fill(42); var server = tls.createServer(options, function(c) { }).listen(0, function() { var client = net.connect(this.address().port, function() { client.write(bonkers); }); var once = false; var writeAgain = setTimeout(function() { client.write(bonkers); }); client.on('error', function(err) { if (!once) { clearTimeout(writeAgain); once = true; client.destroy(); server.close(); } }); client.on('close', function(hadError) { assert.strictEqual(hadError, true, 'Client never errored'); }); }); node-v4.8.2/test/parallel/test-tls-honorcipherorder.js000644 000766 000024 00000005565 13070706737 023237 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var fs = require('fs'); var nconns = 0; // We explicitly set TLS version to 1.2 so as to be safe when the // default method is updated in the future var SSL_Method = 'TLSv1_2_method'; var localhost = '127.0.0.1'; process.on('exit', function() { assert.equal(nconns, 6); }); function test(honorCipherOrder, clientCipher, expectedCipher, cb) { var soptions = { secureProtocol: SSL_Method, key: fs.readFileSync(common.fixturesDir + '/keys/agent2-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent2-cert.pem'), ciphers: 'AES256-SHA256:AES128-GCM-SHA256:AES128-SHA256:' + 'ECDHE-RSA-AES128-GCM-SHA256', honorCipherOrder: !!honorCipherOrder }; var server = tls.createServer(soptions, function(cleartextStream) { nconns++; // End socket to send CLOSE_NOTIFY and TCP FIN packet, otherwise // it may hang for ~30 seconds in FIN_WAIT_1 state (at least on OSX). cleartextStream.end(); }); server.listen(0, localhost, function() { var coptions = { rejectUnauthorized: false, secureProtocol: SSL_Method }; if (clientCipher) { coptions.ciphers = clientCipher; } const port = this.address().port; var client = tls.connect(port, localhost, coptions, function() { var cipher = client.getCipher(); client.end(); server.close(); assert.equal(cipher.name, expectedCipher); if (cb) cb(); }); }); } test1(); function test1() { // Client has the preference of cipher suites by default test(false, 'AES128-GCM-SHA256:AES256-SHA256:AES128-SHA256', 'AES128-GCM-SHA256', test2); } function test2() { // Server has the preference of cipher suites, and AES256-SHA256 is // the server's top choice. test(true, 'AES128-GCM-SHA256:AES256-SHA256:AES128-SHA256', 'AES256-SHA256', test3); } function test3() { // Server has the preference of cipher suites. AES128-GCM-SHA256 is given // higher priority over AES128-SHA256 among client cipher suites. test(true, 'AES128-SHA256:AES128-GCM-SHA256', 'AES128-GCM-SHA256', test4); } function test4() { // As client has only one cipher, server has no choice, irrespective // of honorCipherOrder. test(true, 'AES128-SHA256', 'AES128-SHA256', test5); } function test5() { // Client did not explicitly set ciphers and client offers // tls.DEFAULT_CIPHERS. All ciphers of the server are included in the // default list so the negotiated cipher is selected according to the // server's top preference of AES256-SHA256. test(true, null, 'AES256-SHA256', test6); } function test6() { // Ensure that `tls.DEFAULT_CIPHERS` is used tls.DEFAULT_CIPHERS = 'ECDHE-RSA-AES128-GCM-SHA256'; test(true, null, 'ECDHE-RSA-AES128-GCM-SHA256'); } node-v4.8.2/test/parallel/test-tls-inception.js000644 000766 000024 00000002652 13070706737 021645 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var fs = require('fs'); var path = require('path'); var net = require('net'); var options, a, b; var body = new Buffer(400000).fill('A'); options = { key: fs.readFileSync(path.join(common.fixturesDir, 'test_key.pem')), cert: fs.readFileSync(path.join(common.fixturesDir, 'test_cert.pem')) }; // the "proxy" server a = tls.createServer(options, function(socket) { var options = { host: '127.0.0.1', port: b.address().port, rejectUnauthorized: false }; var dest = net.connect(options); dest.pipe(socket); socket.pipe(dest); dest.on('end', function() { socket.destroy(); }); }); // the "target" server b = tls.createServer(options, function(socket) { socket.end(body); }); a.listen(0, function() { b.listen(0, function() { options = { host: '127.0.0.1', port: a.address().port, rejectUnauthorized: false }; var socket = tls.connect(options); var ssl; ssl = tls.connect({ socket: socket, rejectUnauthorized: false }); ssl.setEncoding('utf8'); var buf = ''; ssl.on('data', function(data) { buf += data; }); ssl.on('end', common.mustCall(function() { assert.equal(buf, body); ssl.end(); a.close(); b.close(); })); }); }); node-v4.8.2/test/parallel/test-tls-interleave.js000644 000766 000024 00000002546 13070706737 022015 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const assert = require('assert'); const tls = require('tls'); const fs = require('fs'); const dir = common.fixturesDir; const options = { key: fs.readFileSync(dir + '/test_key.pem'), cert: fs.readFileSync(dir + '/test_cert.pem'), ca: [ fs.readFileSync(dir + '/test_ca.pem') ] }; const writes = [ 'some server data', 'and a separate packet', 'and one more', ]; let receivedWrites = 0; const server = tls.createServer(options, function(c) { writes.forEach(function(str) { c.write(str); }); }).listen(0, common.mustCall(function() { const connectOpts = { rejectUnauthorized: false }; const c = tls.connect(this.address().port, connectOpts, function() { c.write('some client data'); c.on('readable', function() { let data = c.read(); if (data === null) return; data = data.toString(); while (data.length !== 0) { assert.strictEqual(data.indexOf(writes[receivedWrites]), 0); data = data.slice(writes[receivedWrites].length); if (++receivedWrites === writes.length) { c.end(); server.close(); } } }); }); })); process.on('exit', function() { assert.strictEqual(receivedWrites, writes.length); }); node-v4.8.2/test/parallel/test-tls-invoke-queued.js000644 000766 000024 00000001645 13070706737 022437 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var fs = require('fs'); var received = ''; var server = tls.createServer({ key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }, function(c) { c._write('hello ', null, function() { c._write('world!', null, function() { c.destroy(); }); c._write(' gosh', null, function() {}); }); server.close(); }).listen(0, common.mustCall(function() { var c = tls.connect(this.address().port, { rejectUnauthorized: false }, common.mustCall(function() { c.on('data', function(chunk) { received += chunk; }); c.on('end', common.mustCall(function() { assert.strictEqual(received, 'hello world! gosh'); })); })); })); node-v4.8.2/test/parallel/test-tls-js-stream.js000644 000766 000024 00000003015 13070706737 021554 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var stream = require('stream'); var fs = require('fs'); var net = require('net'); var connected = { client: 0, server: 0 }; var server = tls.createServer({ key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }, function(c) { console.log('new client'); connected.server++; c.end('ohai'); }).listen(0, function() { var raw = net.connect(this.address().port); var pending = false; raw.on('readable', function() { if (pending) p._read(); }); var p = new stream.Duplex({ read: function read() { pending = false; var chunk = raw.read(); if (chunk) { console.log('read', chunk); this.push(chunk); } else { pending = true; } }, write: function write(data, enc, cb) { console.log('write', data, enc); raw.write(data, enc, cb); } }); var socket = tls.connect({ socket: p, rejectUnauthorized: false }, function() { console.log('client secure'); connected.client++; socket.end('hello'); socket.resume(); socket.destroy(); }); socket.once('close', function() { console.log('client close'); server.close(); }); }); process.once('exit', function() { assert.equal(connected.client, 1); assert.equal(connected.server, 1); }); node-v4.8.2/test/parallel/test-tls-junk-closes-server.js000644 000766 000024 00000001262 13070706737 023412 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const tls = require('tls'); const fs = require('fs'); const net = require('net'); const options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent2-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent2-cert.pem') }; const server = tls.createServer(options, common.fail); server.listen(0, common.mustCall(function() { const c = net.createConnection(this.address().port); c.on('connect', common.mustCall(function() { c.write('blah\nblah\nblah\n'); })); c.on('end', common.mustCall(function() { server.close(); })); })); node-v4.8.2/test/parallel/test-tls-junk-server.js000644 000766 000024 00000001161 13070706737 022122 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const assert = require('assert'); const https = require('https'); const net = require('net'); const server = net.createServer(function(s) { s.once('data', function() { s.end('I was waiting for you, hello!', function() { s.destroy(); }); }); }); server.listen(0, function() { const req = https.request({ port: this.address().port }); req.end(); req.once('error', common.mustCall(function(err) { assert(/unknown protocol/.test(err.message)); server.close(); })); }); node-v4.8.2/test/parallel/test-tls-key-mismatch.js000644 000766 000024 00000000667 13070706737 022254 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const assert = require('assert'); const tls = require('tls'); const fs = require('fs'); const options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent2-cert.pem') }; assert.throws(function() { tls.createSecureContext(options); }); node-v4.8.2/test/parallel/test-tls-legacy-onselect.js000644 000766 000024 00000001243 13070706737 022726 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var net = require('net'); var server = net.Server(common.mustCall(function(raw) { var pair = tls.createSecurePair(null, true, false, false); pair.on('error', function() {}); pair.ssl.setSNICallback(common.mustCall(function() { raw.destroy(); server.close(); })); require('_tls_legacy').pipe(pair, raw); })).listen(0, function() { tls.connect({ port: this.address().port, rejectUnauthorized: false, servername: 'server' }, function() { }).on('error', function() { // Just ignore }); }); node-v4.8.2/test/parallel/test-tls-max-send-fragment.js000644 000766 000024 00000002142 13070706737 023164 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var fs = require('fs'); var buf = new Buffer(10000); var received = 0; var maxChunk = 768; var server = tls.createServer({ key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }, function(c) { // Lower and upper limits assert(!c.setMaxSendFragment(511)); assert(!c.setMaxSendFragment(16385)); // Correct fragment size assert(c.setMaxSendFragment(maxChunk)); c.end(buf); }).listen(0, common.mustCall(function() { var c = tls.connect(this.address().port, { rejectUnauthorized: false }, common.mustCall(function() { c.on('data', function(chunk) { assert(chunk.length <= maxChunk); received += chunk.length; }); // Ensure that we receive 'end' event anyway c.on('end', common.mustCall(function() { c.destroy(); server.close(); assert.strictEqual(received, buf.length); })); })); })); node-v4.8.2/test/parallel/test-tls-multi-key.js000644 000766 000024 00000002410 13070706737 021565 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var fs = require('fs'); var options = { key: [ fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), fs.readFileSync(common.fixturesDir + '/keys/ec-key.pem') ], cert: [ fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem'), fs.readFileSync(common.fixturesDir + '/keys/ec-cert.pem') ] }; var ciphers = []; var server = tls.createServer(options, function(conn) { conn.end('ok'); }).listen(0, function() { var ecdsa = tls.connect(this.address().port, { ciphers: 'ECDHE-ECDSA-AES256-GCM-SHA384', rejectUnauthorized: false }, function() { ciphers.push(ecdsa.getCipher()); var rsa = tls.connect(server.address().port, { ciphers: 'ECDHE-RSA-AES256-GCM-SHA384', rejectUnauthorized: false }, function() { ciphers.push(rsa.getCipher()); ecdsa.end(); rsa.end(); server.close(); }); }); }); process.on('exit', function() { assert.deepEqual(ciphers, [{ name: 'ECDHE-ECDSA-AES256-GCM-SHA384', version: 'TLSv1/SSLv3' }, { name: 'ECDHE-RSA-AES256-GCM-SHA384', version: 'TLSv1/SSLv3' }]); }); node-v4.8.2/test/parallel/test-tls-no-cert-required.js000644 000766 000024 00000000640 13070706737 023035 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); // Omitting the cert or pfx option to tls.createServer() should not throw. // AECDH-NULL-SHA is a no-authentication/no-encryption cipher and hence // doesn't need a certificate. tls.createServer({ ciphers: 'AECDH-NULL-SHA' }).listen(0, function() { this.close(); }); node-v4.8.2/test/parallel/test-tls-no-rsa-key.js000644 000766 000024 00000001516 13070706737 021640 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var fs = require('fs'); var options = { key: fs.readFileSync(common.fixturesDir + '/keys/ec-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/ec-cert.pem') }; var server = tls.createServer(options, function(conn) { conn.end('ok'); }).listen(0, common.mustCall(function() { var c = tls.connect(this.address().port, { rejectUnauthorized: false }, common.mustCall(function() { c.on('end', common.mustCall(function() { c.end(); server.close(); })); c.on('data', function(data) { assert.equal(data, 'ok'); }); const cert = c.getPeerCertificate(); assert.strictEqual(cert.subject.C, 'US'); })); })); node-v4.8.2/test/parallel/test-tls-no-sslv23.js000644 000766 000024 00000004035 13070706737 021420 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); assert.throws(function() { tls.createSecureContext({ secureProtocol: 'blargh' }); }, /Unknown method/); assert.throws(function() { tls.createSecureContext({ secureProtocol: 'SSLv2_method' }); }, /SSLv2 methods disabled/); assert.throws(function() { tls.createSecureContext({ secureProtocol: 'SSLv2_client_method' }); }, /SSLv2 methods disabled/); assert.throws(function() { tls.createSecureContext({ secureProtocol: 'SSLv2_server_method' }); }, /SSLv2 methods disabled/); assert.throws(function() { tls.createSecureContext({ secureProtocol: 'SSLv3_method' }); }, /SSLv3 methods disabled/); assert.throws(function() { tls.createSecureContext({ secureProtocol: 'SSLv3_client_method' }); }, /SSLv3 methods disabled/); assert.throws(function() { tls.createSecureContext({ secureProtocol: 'SSLv3_server_method' }); }, /SSLv3 methods disabled/); // Note that SSLv2 and SSLv3 are disallowed but SSLv2_method and friends are // still accepted. They are OpenSSL's way of saying that all known protocols // are supported unless explicitly disabled (which we do for SSLv2 and SSLv3.) tls.createSecureContext({ secureProtocol: 'SSLv23_method' }); tls.createSecureContext({ secureProtocol: 'SSLv23_client_method' }); tls.createSecureContext({ secureProtocol: 'SSLv23_server_method' }); tls.createSecureContext({ secureProtocol: 'TLSv1_method' }); tls.createSecureContext({ secureProtocol: 'TLSv1_client_method' }); tls.createSecureContext({ secureProtocol: 'TLSv1_server_method' }); tls.createSecureContext({ secureProtocol: 'TLSv1_1_method' }); tls.createSecureContext({ secureProtocol: 'TLSv1_1_client_method' }); tls.createSecureContext({ secureProtocol: 'TLSv1_1_server_method' }); tls.createSecureContext({ secureProtocol: 'TLSv1_2_method' }); tls.createSecureContext({ secureProtocol: 'TLSv1_2_client_method' }); tls.createSecureContext({ secureProtocol: 'TLSv1_2_server_method' }); node-v4.8.2/test/parallel/test-tls-no-sslv3.js000644 000766 000024 00000003111 13070706737 021330 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const tls = require('tls'); const fs = require('fs'); const spawn = require('child_process').spawn; if (common.opensslCli === false) { common.skip('node compiled without OpenSSL CLI.'); return; } const cert = fs.readFileSync(common.fixturesDir + '/test_cert.pem'); const key = fs.readFileSync(common.fixturesDir + '/test_key.pem'); const server = tls.createServer({ cert: cert, key: key }, common.fail); const errors = []; let stderr = ''; server.listen(0, '127.0.0.1', function() { const address = this.address().address + ':' + this.address().port; const args = ['s_client', '-ssl3', '-connect', address]; // for the performance and stability issue in s_client on Windows if (common.isWindows) args.push('-no_rand_screen'); const client = spawn(common.opensslCli, args, { stdio: 'pipe' }); client.stdout.pipe(process.stdout); client.stderr.pipe(process.stderr); client.stderr.setEncoding('utf8'); client.stderr.on('data', (data) => stderr += data); client.once('exit', common.mustCall(function(exitCode) { assert.strictEqual(exitCode, 1); server.close(); })); }); server.on('clientError', (err) => errors.push(err)); process.on('exit', function() { if (/unknown option -ssl3/.test(stderr)) { common.skip('`openssl s_client -ssl3` not supported.'); } else { assert.strictEqual(errors.length, 1); assert(/:wrong version number/.test(errors[0].message)); } }); node-v4.8.2/test/parallel/test-tls-npn-server-client.js000644 000766 000024 00000005040 13070706737 023222 0ustar00iojsstaff000000 000000 'use strict'; if (!process.features.tls_npn) { common.skip('node compiled without OpenSSL or ' + 'with old OpenSSL version.'); return; } const common = require('../common'); const assert = require('assert'); const fs = require('fs'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); function filenamePEM(n) { return require('path').join(common.fixturesDir, 'keys', n + '.pem'); } function loadPEM(n) { return fs.readFileSync(filenamePEM(n)); } var serverOptions = { key: loadPEM('agent2-key'), cert: loadPEM('agent2-cert'), crl: loadPEM('ca2-crl'), SNICallback: function(servername, cb) { cb(null, tls.createSecureContext({ key: loadPEM('agent2-key'), cert: loadPEM('agent2-cert'), crl: loadPEM('ca2-crl'), })); }, NPNProtocols: ['a', 'b', 'c'] }; var clientsOptions = [{ port: undefined, key: serverOptions.key, cert: serverOptions.cert, crl: serverOptions.crl, NPNProtocols: ['a', 'b', 'c'], rejectUnauthorized: false }, { port: undefined, key: serverOptions.key, cert: serverOptions.cert, crl: serverOptions.crl, NPNProtocols: ['c', 'b', 'e'], rejectUnauthorized: false }, { port: undefined, key: serverOptions.key, cert: serverOptions.cert, crl: serverOptions.crl, rejectUnauthorized: false }, { port: undefined, key: serverOptions.key, cert: serverOptions.cert, crl: serverOptions.crl, NPNProtocols: ['first-priority-unsupported', 'x', 'y'], rejectUnauthorized: false }]; const serverResults = []; const clientsResults = []; var server = tls.createServer(serverOptions, function(c) { serverResults.push(c.npnProtocol); }); server.listen(0, startTest); function startTest() { function connectClient(options, callback) { options.port = server.address().port; var client = tls.connect(options, function() { clientsResults.push(client.npnProtocol); client.destroy(); callback(); }); } connectClient(clientsOptions[0], function() { connectClient(clientsOptions[1], function() { connectClient(clientsOptions[2], function() { connectClient(clientsOptions[3], function() { server.close(); }); }); }); }); } process.on('exit', function() { assert.equal(serverResults[0], clientsResults[0]); assert.equal(serverResults[1], clientsResults[1]); assert.equal(serverResults[2], 'http/1.1'); assert.equal(clientsResults[2], false); assert.equal(serverResults[3], 'first-priority-unsupported'); assert.equal(clientsResults[3], false); }); node-v4.8.2/test/parallel/test-tls-ocsp-callback.js000644 000766 000024 00000006413 13070706737 022352 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); if (!process.features.tls_ocsp) { common.skip('node compiled without OpenSSL or ' + 'with old OpenSSL version.'); return; } if (!common.opensslCli) { common.skip('node compiled without OpenSSL CLI.'); return; } if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var assert = require('assert'); var constants = require('constants'); var fs = require('fs'); var join = require('path').join; var pfx = fs.readFileSync(join(common.fixturesDir, 'keys', 'agent1-pfx.pem')); function test(testOptions, cb) { var keyFile = join(common.fixturesDir, 'keys', 'agent1-key.pem'); var certFile = join(common.fixturesDir, 'keys', 'agent1-cert.pem'); var caFile = join(common.fixturesDir, 'keys', 'ca1-cert.pem'); var key = fs.readFileSync(keyFile); var cert = fs.readFileSync(certFile); var ca = fs.readFileSync(caFile); var options = { key: key, cert: cert, ca: [ca] }; var requestCount = 0; var clientSecure = 0; var ocspCount = 0; var ocspResponse; if (testOptions.pfx) { delete options.key; delete options.cert; options.pfx = testOptions.pfx; options.passphrase = testOptions.passphrase; } var server = tls.createServer(options, function(cleartext) { cleartext.on('error', function(er) { // We're ok with getting ECONNRESET in this test, but it's // timing-dependent, and thus unreliable. Any other errors // are just failures, though. if (er.code !== 'ECONNRESET') throw er; }); ++requestCount; cleartext.end(); }); server.on('OCSPRequest', function(cert, issuer, callback) { ++ocspCount; assert.ok(Buffer.isBuffer(cert)); assert.ok(Buffer.isBuffer(issuer)); // Just to check that async really works there setTimeout(function() { callback(null, testOptions.response ? new Buffer(testOptions.response) : null); }, 100); }); server.listen(0, function() { var client = tls.connect({ port: this.address().port, requestOCSP: testOptions.ocsp !== false, secureOptions: testOptions.ocsp === false ? constants.SSL_OP_NO_TICKET : 0, rejectUnauthorized: false }, function() { clientSecure++; }); client.on('OCSPResponse', function(resp) { ocspResponse = resp; if (resp) client.destroy(); }); client.on('close', function() { server.close(cb); }); }); process.on('exit', function() { if (testOptions.ocsp === false) { assert.equal(requestCount, clientSecure); assert.equal(requestCount, 1); return; } if (testOptions.response) { assert.equal(ocspResponse.toString(), testOptions.response); } else { assert.ok(ocspResponse === null); } assert.equal(requestCount, testOptions.response ? 0 : 1); assert.equal(clientSecure, requestCount); assert.equal(ocspCount, 1); }); } var tests = [ { response: false }, { response: 'hello world' }, { ocsp: false } ]; if (!common.hasFipsCrypto) { tests.push({ pfx: pfx, passphrase: 'sample', response: 'hello pfx' }); } function runTests(i) { if (i === tests.length) return; test(tests[i], common.mustCall(function() { runTests(i + 1); })); } runTests(0); node-v4.8.2/test/parallel/test-tls-on-empty-socket.js000644 000766 000024 00000001535 13070706737 022712 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var fs = require('fs'); var net = require('net'); var out = ''; var server = tls.createServer({ key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }, function(c) { c.end('hello'); }).listen(0, function() { var socket = new net.Socket(); var s = tls.connect({ socket: socket, rejectUnauthorized: false }, function() { s.on('data', function(chunk) { out += chunk; }); s.on('end', function() { s.destroy(); server.close(); }); }); socket.connect(this.address().port); }); process.on('exit', function() { assert.equal(out, 'hello'); }); node-v4.8.2/test/parallel/test-tls-over-http-tunnel.js000644 000766 000024 00000010074 13070706737 023105 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var https = require('https'); var fs = require('fs'); var net = require('net'); var http = require('http'); var gotRequest = false; var key = fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'); var cert = fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem'); var options = { key: key, cert: cert }; var server = https.createServer(options, function(req, res) { console.log('SERVER: got request'); res.writeHead(200, { 'content-type': 'text/plain' }); console.log('SERVER: sending response'); res.end('hello world\n'); }); var proxy = net.createServer(function(clientSocket) { console.log('PROXY: got a client connection'); var serverSocket = null; clientSocket.on('data', function(chunk) { if (!serverSocket) { // Verify the CONNECT request assert.equal(`CONNECT localhost:${server.address().port} HTTP/1.1\r\n` + 'Proxy-Connections: keep-alive\r\n' + `Host: localhost:${proxy.address().port}\r\n` + 'Connection: close\r\n\r\n', chunk); console.log('PROXY: got CONNECT request'); console.log('PROXY: creating a tunnel'); // create the tunnel serverSocket = net.connect(server.address().port, function() { console.log('PROXY: replying to client CONNECT request'); // Send the response clientSocket.write('HTTP/1.1 200 OK\r\nProxy-Connections: keep' + '-alive\r\nConnections: keep-alive\r\nVia: ' + `localhost:${proxy.address().port}\r\n\r\n`); }); serverSocket.on('data', function(chunk) { clientSocket.write(chunk); }); serverSocket.on('end', function() { clientSocket.destroy(); }); } else { serverSocket.write(chunk); } }); clientSocket.on('end', function() { serverSocket.destroy(); }); }); server.listen(0); proxy.listen(0, function() { console.log('CLIENT: Making CONNECT request'); var req = http.request({ port: this.address().port, method: 'CONNECT', path: `localhost:${server.address().port}`, headers: { 'Proxy-Connections': 'keep-alive' } }); req.useChunkedEncodingByDefault = false; // for v0.6 req.on('response', onResponse); // for v0.6 req.on('upgrade', onUpgrade); // for v0.6 req.on('connect', onConnect); // for v0.7 or later req.end(); function onResponse(res) { // Very hacky. This is necessary to avoid http-parser leaks. res.upgrade = true; } function onUpgrade(res, socket, head) { // Hacky. process.nextTick(function() { onConnect(res, socket, head); }); } function onConnect(res, socket, header) { assert.equal(200, res.statusCode); console.log('CLIENT: got CONNECT response'); // detach the socket socket.removeAllListeners('data'); socket.removeAllListeners('close'); socket.removeAllListeners('error'); socket.removeAllListeners('drain'); socket.removeAllListeners('end'); socket.ondata = null; socket.onend = null; socket.ondrain = null; console.log('CLIENT: Making HTTPS request'); https.get({ path: '/foo', key: key, cert: cert, socket: socket, // reuse the socket agent: false, rejectUnauthorized: false }, function(res) { assert.equal(200, res.statusCode); res.on('data', function(chunk) { assert.equal('hello world\n', chunk); console.log('CLIENT: got HTTPS response'); gotRequest = true; }); res.on('end', function() { proxy.close(); server.close(); }); }).on('error', function(er) { // We're ok with getting ECONNRESET in this test, but it's // timing-dependent, and thus unreliable. Any other errors // are just failures, though. if (er.code !== 'ECONNRESET') throw er; }).end(); } }); process.on('exit', function() { assert.ok(gotRequest); }); node-v4.8.2/test/parallel/test-tls-parse-cert-string.js000644 000766 000024 00000001311 13070706737 023215 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const tls = require('tls'); const singles = 'C=US\nST=CA\nL=SF\nO=Node.js Foundation\nOU=Node.js\n' + 'CN=ca1\nemailAddress=ry@clouds.org'; const singlesOut = tls.parseCertString(singles); assert.deepEqual(singlesOut, { C: 'US', ST: 'CA', L: 'SF', O: 'Node.js Foundation', OU: 'Node.js', CN: 'ca1', emailAddress: 'ry@clouds.org' }); const doubles = 'OU=Domain Control Validated\nOU=PositiveSSL Wildcard\n' + 'CN=*.nodejs.org'; const doublesOut = tls.parseCertString(doubles); assert.deepEqual(doublesOut, { OU: [ 'Domain Control Validated', 'PositiveSSL Wildcard' ], CN: '*.nodejs.org' }); node-v4.8.2/test/parallel/test-tls-passphrase.js000644 000766 000024 00000001773 13070706737 022031 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var fs = require('fs'); var path = require('path'); var key = fs.readFileSync(path.join(common.fixturesDir, 'pass-key.pem')); var cert = fs.readFileSync(path.join(common.fixturesDir, 'pass-cert.pem')); var server = tls.Server({ key: key, passphrase: 'passphrase', cert: cert, ca: [cert], requestCert: true, rejectUnauthorized: true }, function(s) { s.end(); }); server.listen(0, common.mustCall(function() { var c = tls.connect({ port: this.address().port, key: key, passphrase: 'passphrase', cert: cert, rejectUnauthorized: false }, common.mustCall(function() {})); c.on('end', function() { server.close(); }); })); assert.throws(function() { tls.connect({ port: server.address().port, key: key, passphrase: 'invalid', cert: cert, rejectUnauthorized: false }); }); node-v4.8.2/test/parallel/test-tls-pause.js000644 000766 000024 00000003335 13070706737 020771 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var fs = require('fs'); var path = require('path'); var options = { key: fs.readFileSync(path.join(common.fixturesDir, 'test_key.pem')), cert: fs.readFileSync(path.join(common.fixturesDir, 'test_cert.pem')) }; var bufSize = 1024 * 1024; var sent = 0; var received = 0; var server = tls.Server(options, function(socket) { socket.pipe(socket); socket.on('data', function(c) { console.error('data', c.length); }); }); server.listen(0, function() { var resumed = false; var client = tls.connect({ port: this.address().port, rejectUnauthorized: false }, function() { console.error('connected'); client.pause(); console.error('paused'); send(); function send() { console.error('sending'); var ret = client.write(new Buffer(bufSize)); console.error('write => %j', ret); if (false !== ret) { console.error('write again'); sent += bufSize; assert.ok(sent < 100 * 1024 * 1024); // max 100MB return process.nextTick(send); } sent += bufSize; console.error('sent: ' + sent); resumed = true; client.resume(); console.error('resumed', client); } }); client.on('data', function(data) { console.error('data'); assert.ok(resumed); received += data.length; console.error('received', received); console.error('sent', sent); if (received >= sent) { console.error('received: ' + received); client.end(); server.close(); } }); }); process.on('exit', function() { assert.equal(sent, received); }); node-v4.8.2/test/parallel/test-tls-peer-certificate-encoding.js000644 000766 000024 00000001723 13070706737 024652 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var fs = require('fs'); var util = require('util'); var join = require('path').join; var options = { key: fs.readFileSync(join(common.fixturesDir, 'keys', 'agent5-key.pem')), cert: fs.readFileSync(join(common.fixturesDir, 'keys', 'agent5-cert.pem')), ca: [ fs.readFileSync(join(common.fixturesDir, 'keys', 'ca2-cert.pem')) ] }; var server = tls.createServer(options, function(cleartext) { cleartext.end('World'); }); server.listen(0, common.mustCall(function() { var socket = tls.connect({ port: this.address().port, rejectUnauthorized: false }, common.mustCall(function() { var peerCert = socket.getPeerCertificate(); console.error(util.inspect(peerCert)); assert.equal(peerCert.subject.CN, 'Ádám Lippai'); server.close(); })); socket.end('Hello'); })); node-v4.8.2/test/parallel/test-tls-peer-certificate-multi-keys.js000644 000766 000024 00000001660 13070706737 025167 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var fs = require('fs'); var util = require('util'); var join = require('path').join; var options = { key: fs.readFileSync(join(common.fixturesDir, 'agent.key')), cert: fs.readFileSync(join(common.fixturesDir, 'multi-alice.crt')) }; var server = tls.createServer(options, function(cleartext) { cleartext.end('World'); }); server.listen(0, common.mustCall(function() { var socket = tls.connect({ port: this.address().port, rejectUnauthorized: false }, common.mustCall(function() { var peerCert = socket.getPeerCertificate(); console.error(util.inspect(peerCert)); assert.deepEqual(peerCert.subject.OU, ['Information Technology', 'Engineering', 'Marketing']); server.close(); })); socket.end('Hello'); })); node-v4.8.2/test/parallel/test-tls-peer-certificate.js000644 000766 000024 00000003217 13070706737 023066 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var fs = require('fs'); var util = require('util'); var join = require('path').join; var options = { key: fs.readFileSync(join(common.fixturesDir, 'keys', 'agent1-key.pem')), cert: fs.readFileSync(join(common.fixturesDir, 'keys', 'agent1-cert.pem')), ca: [ fs.readFileSync(join(common.fixturesDir, 'keys', 'ca1-cert.pem')) ] }; var server = tls.createServer(options, function(cleartext) { cleartext.end('World'); }); server.listen(0, common.mustCall(function() { var socket = tls.connect({ port: this.address().port, rejectUnauthorized: false }, common.mustCall(function() { var peerCert = socket.getPeerCertificate(); assert.ok(!peerCert.issuerCertificate); // Verify that detailed return value has all certs peerCert = socket.getPeerCertificate(true); assert.ok(peerCert.issuerCertificate); console.error(util.inspect(peerCert)); assert.equal(peerCert.subject.emailAddress, 'ry@tinyclouds.org'); assert.equal(peerCert.serialNumber, '9A84ABCFB8A72AC0'); assert.equal(peerCert.exponent, '0x10001'); assert.equal(peerCert.fingerprint, '8D:06:3A:B3:E5:8B:85:29:72:4F:7D:1B:54:CD:95:19:3C:EF:6F:AA'); assert.deepEqual(peerCert.infoAccess['OCSP - URI'], [ 'http://ocsp.nodejs.org/' ]); var issuer = peerCert.issuerCertificate; assert.ok(issuer.issuerCertificate === issuer); assert.equal(issuer.serialNumber, '8DF21C01468AF393'); server.close(); })); socket.end('Hello'); })); node-v4.8.2/test/parallel/test-tls-pfx-gh-5100-regr.js000644 000766 000024 00000001454 13070706737 022365 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); if (!common.hasCrypto) { common.skip('node compiled without crypto.'); return; } const assert = require('assert'); const tls = require('tls'); const fs = require('fs'); const path = require('path'); const pfx = fs.readFileSync( path.join(common.fixturesDir, 'keys', 'agent1-pfx.pem')); const server = tls.createServer({ pfx: pfx, passphrase: 'sample', requestCert: true, rejectUnauthorized: false }, common.mustCall(function(c) { assert(c.authorizationError === null, 'authorizationError must be null'); c.end(); })).listen(0, function() { var client = tls.connect({ port: this.address().port, pfx: pfx, passphrase: 'sample', rejectUnauthorized: false }, function() { client.end(); server.close(); }); }); node-v4.8.2/test/parallel/test-tls-regr-gh-5108.js000644 000766 000024 00000001525 13070706737 021601 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const assert = require('assert'); const tls = require('tls'); const fs = require('fs'); const options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }; const server = tls.createServer(options, function(s) { s.end('hello'); }).listen(0, function() { const opts = { port: this.address().port, rejectUnauthorized: false }; const client = tls.connect(opts, function() { putImmediate(client); }); }); function putImmediate(client) { setImmediate(function() { if (client.ssl) { const fd = client.ssl.fd; assert(!!fd); putImmediate(client); } else { server.close(); } }); } node-v4.8.2/test/parallel/test-tls-request-timeout.js000644 000766 000024 00000001332 13070706737 023023 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var fs = require('fs'); var options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }; var server = tls.Server(options, common.mustCall(function(socket) { var s = socket.setTimeout(100); assert.ok(s instanceof tls.TLSSocket); socket.on('timeout', common.mustCall(function(err) { socket.end(); server.close(); })); })); server.listen(0, function() { tls.connect({ port: this.address().port, rejectUnauthorized: false }); }); node-v4.8.2/test/parallel/test-tls-securepair-fiftharg.js000644 000766 000024 00000001425 13070706737 023604 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const fs = require('fs'); const tls = require('tls'); const sslcontext = tls.createSecureContext({ cert: fs.readFileSync(common.fixturesDir + '/test_cert.pem'), key: fs.readFileSync(common.fixturesDir + '/test_key.pem') }); var catchedServername; const pair = tls.createSecurePair(sslcontext, true, false, false, { SNICallback: common.mustCall(function(servername, cb) { catchedServername = servername; }) }); // captured traffic from browser's request to https://www.google.com const sslHello = fs.readFileSync(common.fixturesDir + '/google_ssl_hello.bin'); pair.encrypted.write(sslHello); process.on('exit', function() { assert.strictEqual('www.google.com', catchedServername); }); node-v4.8.2/test/parallel/test-tls-securepair-server.js000644 000766 000024 00000005700 13070706737 023320 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var join = require('path').join; var net = require('net'); var fs = require('fs'); var spawn = require('child_process').spawn; var key = fs.readFileSync(join(common.fixturesDir, 'agent.key')).toString(); var cert = fs.readFileSync(join(common.fixturesDir, 'agent.crt')).toString(); function log(a) { console.error('***server*** ' + a); } var server = net.createServer(common.mustCall(function(socket) { log('connection fd=' + socket.fd); var sslcontext = tls.createSecureContext({key: key, cert: cert}); sslcontext.context.setCiphers('RC4-SHA:AES128-SHA:AES256-SHA'); var pair = tls.createSecurePair(sslcontext, true); assert.ok(pair.encrypted.writable); assert.ok(pair.cleartext.writable); pair.encrypted.pipe(socket); socket.pipe(pair.encrypted); log('i set it secure'); pair.on('secure', function() { log('connected+secure!'); pair.cleartext.write('hello\r\n'); log(pair.cleartext.getPeerCertificate()); log(pair.cleartext.getCipher()); }); pair.cleartext.on('data', function(data) { log('read bytes ' + data.length); pair.cleartext.write(data); }); socket.on('end', function() { log('socket end'); }); pair.cleartext.on('error', function(err) { log('got error: '); log(err); log(err.stack); socket.destroy(); }); pair.encrypted.on('error', function(err) { log('encrypted error: '); log(err); log(err.stack); socket.destroy(); }); socket.on('error', function(err) { log('socket error: '); log(err); log(err.stack); socket.destroy(); }); socket.on('close', function(err) { log('socket closed'); }); pair.on('error', function(err) { log('secure error: '); log(err); log(err.stack); socket.destroy(); }); })); var gotHello = false; var sentWorld = false; var gotWorld = false; server.listen(0, common.mustCall(function() { // To test use: openssl s_client -connect localhost:8000 var args = ['s_client', '-connect', `127.0.0.1:${this.address().port}`]; // for the performance and stability issue in s_client on Windows if (common.isWindows) args.push('-no_rand_screen'); var client = spawn(common.opensslCli, args); var out = ''; client.stdout.setEncoding('utf8'); client.stdout.on('data', function(d) { out += d; if (!gotHello && /hello/.test(out)) { gotHello = true; client.stdin.write('world\r\n'); sentWorld = true; } if (!gotWorld && /world/.test(out)) { gotWorld = true; client.stdin.end(); } }); client.stdout.pipe(process.stdout, { end: false }); client.on('exit', common.mustCall(function(code) { assert.strictEqual(0, code); server.close(); })); })); process.on('exit', function() { assert.ok(gotHello); assert.ok(sentWorld); assert.ok(gotWorld); }); node-v4.8.2/test/parallel/test-tls-server-connection-server.js000644 000766 000024 00000001367 13070706737 024626 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const assert = require('assert'); const tls = require('tls'); const fs = require('fs'); const options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }; const server = tls.createServer(options, function(s) { s.end('hello'); }).listen(0, function() { const opts = { port: this.address().port, rejectUnauthorized: false }; server.on('connection', common.mustCall(function(socket) { assert(socket.server === server); server.close(); })); const client = tls.connect(opts, function() { client.end(); }); }); node-v4.8.2/test/parallel/test-tls-server-verify.js000644 000766 000024 00000023116 13070706737 022463 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); if (!common.opensslCli) { common.skip('node compiled without OpenSSL CLI.'); return; } // This is a rather complex test which sets up various TLS servers with node // and connects to them using the 'openssl s_client' command line utility // with various keys. Depending on the certificate authority and other // parameters given to the server, the various clients are // - rejected, // - accepted and "unauthorized", or // - accepted and "authorized". const testCases = [{ title: 'Do not request certs. Everyone is unauthorized.', requestCert: false, rejectUnauthorized: false, renegotiate: false, CAs: ['ca1-cert'], clients: [{ name: 'agent1', shouldReject: false, shouldAuth: false }, { name: 'agent2', shouldReject: false, shouldAuth: false }, { name: 'agent3', shouldReject: false, shouldAuth: false }, { name: 'nocert', shouldReject: false, shouldAuth: false } ] }, { title: 'Allow both authed and unauthed connections with CA1', requestCert: true, rejectUnauthorized: false, renegotiate: false, CAs: ['ca1-cert'], clients: [{ name: 'agent1', shouldReject: false, shouldAuth: true }, { name: 'agent2', shouldReject: false, shouldAuth: false }, { name: 'agent3', shouldReject: false, shouldAuth: false }, { name: 'nocert', shouldReject: false, shouldAuth: false } ] }, { title: 'Do not request certs at connection. Do that later', requestCert: false, rejectUnauthorized: false, renegotiate: true, CAs: ['ca1-cert'], clients: [{ name: 'agent1', shouldReject: false, shouldAuth: true }, { name: 'agent2', shouldReject: false, shouldAuth: false }, { name: 'agent3', shouldReject: false, shouldAuth: false }, { name: 'nocert', shouldReject: false, shouldAuth: false } ] }, { title: 'Allow only authed connections with CA1', requestCert: true, rejectUnauthorized: true, renegotiate: false, CAs: ['ca1-cert'], clients: [{ name: 'agent1', shouldReject: false, shouldAuth: true }, { name: 'agent2', shouldReject: true }, { name: 'agent3', shouldReject: true }, { name: 'nocert', shouldReject: true } ] }, { title: 'Allow only authed connections with CA1 and CA2', requestCert: true, rejectUnauthorized: true, renegotiate: false, CAs: ['ca1-cert', 'ca2-cert'], clients: [{ name: 'agent1', shouldReject: false, shouldAuth: true }, { name: 'agent2', shouldReject: true }, { name: 'agent3', shouldReject: false, shouldAuth: true }, { name: 'nocert', shouldReject: true } ] }, { title: 'Allow only certs signed by CA2 but not in the CRL', requestCert: true, rejectUnauthorized: true, renegotiate: false, CAs: ['ca2-cert'], crl: 'ca2-crl', clients: [ { name: 'agent1', shouldReject: true, shouldAuth: false }, { name: 'agent2', shouldReject: true, shouldAuth: false }, { name: 'agent3', shouldReject: false, shouldAuth: true }, // Agent4 has a cert in the CRL. { name: 'agent4', shouldReject: true, shouldAuth: false }, { name: 'nocert', shouldReject: true } ] } ]; if (!common.hasCrypto) { common.skip('missing crypto'); return; } const tls = require('tls'); const constants = require('constants'); const assert = require('assert'); const fs = require('fs'); const spawn = require('child_process').spawn; function filenamePEM(n) { return require('path').join(common.fixturesDir, 'keys', n + '.pem'); } function loadPEM(n) { return fs.readFileSync(filenamePEM(n)); } const serverKey = loadPEM('agent2-key'); const serverCert = loadPEM('agent2-cert'); function runClient(prefix, port, options, cb) { // Client can connect in three ways: // - Self-signed cert // - Certificate, but not signed by CA. // - Certificate signed by CA. const args = ['s_client', '-connect', '127.0.0.1:' + port]; // for the performance issue in s_client on Windows if (common.isWindows) args.push('-no_rand_screen'); console.log(prefix + ' connecting with', options.name); switch (options.name) { case 'agent1': // Signed by CA1 args.push('-key'); args.push(filenamePEM('agent1-key')); args.push('-cert'); args.push(filenamePEM('agent1-cert')); break; case 'agent2': // Self-signed // This is also the key-cert pair that the server will use. args.push('-key'); args.push(filenamePEM('agent2-key')); args.push('-cert'); args.push(filenamePEM('agent2-cert')); break; case 'agent3': // Signed by CA2 args.push('-key'); args.push(filenamePEM('agent3-key')); args.push('-cert'); args.push(filenamePEM('agent3-cert')); break; case 'agent4': // Signed by CA2 (rejected by ca2-crl) args.push('-key'); args.push(filenamePEM('agent4-key')); args.push('-cert'); args.push(filenamePEM('agent4-cert')); break; case 'nocert': // Do not send certificate break; default: throw new Error(prefix + 'Unknown agent name'); } // To test use: openssl s_client -connect localhost:8000 const client = spawn(common.opensslCli, args); let out = ''; let rejected = true; let authed = false; let goodbye = false; client.stdout.setEncoding('utf8'); client.stdout.on('data', function(d) { out += d; if (!goodbye && /_unauthed/g.test(out)) { console.error(prefix + ' * unauthed'); goodbye = true; client.kill(); authed = false; rejected = false; } if (!goodbye && /_authed/g.test(out)) { console.error(prefix + ' * authed'); goodbye = true; client.kill(); authed = true; rejected = false; } }); //client.stdout.pipe(process.stdout); client.on('exit', function(code) { //assert.equal(0, code, prefix + options.name + // ": s_client exited with error code " + code); if (options.shouldReject) { assert.strictEqual(true, rejected, prefix + options.name + ' NOT rejected, but should have been'); } else { assert.strictEqual(false, rejected, prefix + options.name + ' rejected, but should NOT have been'); assert.strictEqual(options.shouldAuth, authed, prefix + options.name + ' authed is ' + authed + ' but should have been ' + options.shouldAuth); } cb(); }); } // Run the tests let successfulTests = 0; function runTest(port, testIndex) { const prefix = testIndex + ' '; const tcase = testCases[testIndex]; if (!tcase) return; console.error(prefix + "Running '%s'", tcase.title); const cas = tcase.CAs.map(loadPEM); const crl = tcase.crl ? loadPEM(tcase.crl) : null; const serverOptions = { key: serverKey, cert: serverCert, ca: cas, crl: crl, requestCert: tcase.requestCert, rejectUnauthorized: tcase.rejectUnauthorized }; /* * If renegotiating - session might be resumed and openssl won't request * client's certificate (probably because of bug in the openssl) */ if (tcase.renegotiate) { serverOptions.secureOptions = constants.SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION; } let renegotiated = false; const server = tls.Server(serverOptions, function handleConnection(c) { c.on('error', function(e) { // child.kill() leads ECONNRESET errro in the TLS connection of // openssl s_client via spawn(). A Test result is already // checked by the data of client.stdout before child.kill() so // these tls errors can be ignored. }); if (tcase.renegotiate && !renegotiated) { renegotiated = true; setTimeout(function() { console.error(prefix + '- connected, renegotiating'); c.write('\n_renegotiating\n'); return c.renegotiate({ requestCert: true, rejectUnauthorized: false }, function(err) { assert(!err); c.write('\n_renegotiated\n'); handleConnection(c); }); }, 200); return; } if (c.authorized) { console.error(prefix + '- authed connection: ' + c.getPeerCertificate().subject.CN); c.write('\n_authed\n'); } else { console.error(prefix + '- unauthed connection: %s', c.authorizationError); c.write('\n_unauthed\n'); } }); function runNextClient(clientIndex) { const options = tcase.clients[clientIndex]; if (options) { runClient(prefix + clientIndex + ' ', port, options, function() { runNextClient(clientIndex + 1); }); } else { server.close(); successfulTests++; runTest(port, nextTest++); } } server.listen(port, function() { port = server.address().port; if (tcase.debug) { console.error(prefix + 'TLS server running on port ' + port); } else { if (tcase.renegotiate) { runNextClient(0); } else { let clientsCompleted = 0; for (let i = 0; i < tcase.clients.length; i++) { runClient(prefix + i + ' ', port, tcase.clients[i], function() { clientsCompleted++; if (clientsCompleted === tcase.clients.length) { server.close(); successfulTests++; runTest(port, nextTest++); } }); } } } }); } let nextTest = 0; runTest(0, nextTest++); runTest(0, nextTest++); process.on('exit', function() { assert.strictEqual(successfulTests, testCases.length); }); node-v4.8.2/test/parallel/test-tls-session-cache.js000644 000766 000024 00000005547 13070706737 022407 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); if (!common.opensslCli) { common.skip('node compiled without OpenSSL CLI.'); return; } if (!common.hasCrypto) { common.skip('missing crypto'); return; } doTest({ tickets: false }, function() { doTest({ tickets: true }, function() { console.error('all done'); }); }); function doTest(testOptions, callback) { var assert = require('assert'); var tls = require('tls'); var fs = require('fs'); var join = require('path').join; var spawn = require('child_process').spawn; var keyFile = join(common.fixturesDir, 'agent.key'); var certFile = join(common.fixturesDir, 'agent.crt'); var key = fs.readFileSync(keyFile); var cert = fs.readFileSync(certFile); var options = { key: key, cert: cert, ca: [cert], requestCert: true }; var requestCount = 0; var resumeCount = 0; var session; var server = tls.createServer(options, function(cleartext) { cleartext.on('error', function(er) { // We're ok with getting ECONNRESET in this test, but it's // timing-dependent, and thus unreliable. Any other errors // are just failures, though. if (er.code !== 'ECONNRESET') throw er; }); ++requestCount; cleartext.end(); }); server.on('newSession', function(id, data, cb) { // Emulate asynchronous store setTimeout(function() { assert.ok(!session); session = { id: id, data: data }; cb(); }, 1000); }); server.on('resumeSession', function(id, callback) { ++resumeCount; assert.ok(session); assert.equal(session.id.toString('hex'), id.toString('hex')); // Just to check that async really works there setTimeout(function() { callback(null, session.data); }, 100); }); server.listen(0, function() { var args = [ 's_client', '-tls1', '-connect', `localhost:${this.address().port}`, '-servername', 'ohgod', '-key', join(common.fixturesDir, 'agent.key'), '-cert', join(common.fixturesDir, 'agent.crt'), '-reconnect' ].concat(testOptions.tickets ? [] : '-no_ticket'); // for the performance and stability issue in s_client on Windows if (common.isWindows) args.push('-no_rand_screen'); var client = spawn(common.opensslCli, args, { stdio: [ 0, 1, 'pipe' ] }); client.stderr.setEncoding('utf8'); client.on('exit', function(code) { console.error('done'); assert.equal(code, 0); server.close(function() { setTimeout(callback, 100); }); }); }); process.on('exit', function() { if (testOptions.tickets) { assert.equal(requestCount, 6); assert.equal(resumeCount, 0); } else { // initial request + reconnect requests (5 times) assert.ok(session); assert.equal(requestCount, 6); assert.equal(resumeCount, 5); } }); } node-v4.8.2/test/parallel/test-tls-set-ciphers.js000644 000766 000024 00000002272 13070706737 022101 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); if (!common.opensslCli) { common.skip('node compiled without OpenSSL CLI.'); return; } if (!common.hasCrypto) { common.skip('missing crypto'); return; } var assert = require('assert'); var exec = require('child_process').exec; var tls = require('tls'); var fs = require('fs'); var options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent2-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent2-cert.pem'), ciphers: 'DES-CBC3-SHA' }; var reply = 'I AM THE WALRUS'; // something recognizable var response = ''; process.on('exit', function() { assert.notEqual(response.indexOf(reply), -1); }); var server = tls.createServer(options, common.mustCall(function(conn) { conn.end(reply); })); server.listen(0, '127.0.0.1', function() { var cmd = '"' + common.opensslCli + '" s_client -cipher ' + options.ciphers + ` -connect 127.0.0.1:${this.address().port}`; // for the performance and stability issue in s_client on Windows if (common.isWindows) cmd += ' -no_rand_screen'; exec(cmd, function(err, stdout, stderr) { if (err) throw err; response = stdout; server.close(); }); }); node-v4.8.2/test/parallel/test-tls-set-encoding.js000644 000766 000024 00000002065 13070706737 022232 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var fs = require('fs'); var options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent2-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent2-cert.pem') }; var message = 'hello world\n'; var server = tls.Server(options, common.mustCall(function(socket) { socket.end(message); })); server.listen(0, function() { var client = tls.connect({ port: this.address().port, rejectUnauthorized: false }); var buffer = ''; client.setEncoding('utf8'); client.on('data', function(d) { assert.ok(typeof d === 'string'); buffer += d; }); client.on('close', function() { // readyState is deprecated but we want to make // sure this isn't triggering an assert in lib/net.js // See issue #1069. assert.equal('closed', client.readyState); assert.equal(buffer, message); console.log(message); server.close(); }); }); node-v4.8.2/test/parallel/test-tls-sni-option.js000644 000766 000024 00000007564 13070706737 021763 0ustar00iojsstaff000000 000000 'use strict'; if (!process.features.tls_sni) { common.skip('node compiled without OpenSSL or ' + 'with old OpenSSL version.'); return; } const common = require('../common'); const assert = require('assert'); const fs = require('fs'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); function filenamePEM(n) { return require('path').join(common.fixturesDir, 'keys', n + '.pem'); } function loadPEM(n) { return fs.readFileSync(filenamePEM(n)); } var serverOptions = { key: loadPEM('agent2-key'), cert: loadPEM('agent2-cert'), requestCert: true, rejectUnauthorized: false, SNICallback: function(servername, callback) { var context = SNIContexts[servername]; // Just to test asynchronous callback setTimeout(function() { if (context) { if (context.emptyRegression) callback(null, {}); else callback(null, tls.createSecureContext(context)); } else { callback(null, null); } }, 100); } }; var SNIContexts = { 'a.example.com': { key: loadPEM('agent1-key'), cert: loadPEM('agent1-cert'), ca: [ loadPEM('ca2-cert') ] }, 'b.example.com': { key: loadPEM('agent3-key'), cert: loadPEM('agent3-cert') }, 'c.another.com': { emptyRegression: true } }; var clientsOptions = [{ port: undefined, key: loadPEM('agent1-key'), cert: loadPEM('agent1-cert'), ca: [loadPEM('ca1-cert')], servername: 'a.example.com', rejectUnauthorized: false }, { port: undefined, key: loadPEM('agent4-key'), cert: loadPEM('agent4-cert'), ca: [loadPEM('ca1-cert')], servername: 'a.example.com', rejectUnauthorized: false }, { port: undefined, key: loadPEM('agent2-key'), cert: loadPEM('agent2-cert'), ca: [loadPEM('ca2-cert')], servername: 'b.example.com', rejectUnauthorized: false }, { port: undefined, key: loadPEM('agent3-key'), cert: loadPEM('agent3-cert'), ca: [loadPEM('ca1-cert')], servername: 'c.wrong.com', rejectUnauthorized: false }, { port: undefined, key: loadPEM('agent3-key'), cert: loadPEM('agent3-cert'), ca: [loadPEM('ca1-cert')], servername: 'c.another.com', rejectUnauthorized: false }]; const serverResults = []; const clientResults = []; const serverErrors = []; const clientErrors = []; let serverError; let clientError; var server = tls.createServer(serverOptions, function(c) { serverResults.push({ sni: c.servername, authorized: c.authorized }); }); server.on('clientError', function(err) { serverResults.push(null); serverError = err.message; }); server.listen(0, startTest); function startTest() { function connectClient(i, callback) { var options = clientsOptions[i]; clientError = null; serverError = null; options.port = server.address().port; var client = tls.connect(options, function() { clientResults.push( /Hostname\/IP doesn't/.test(client.authorizationError || '')); client.destroy(); next(); }); client.on('error', function(err) { clientResults.push(false); clientError = err.message; next(); }); function next() { clientErrors.push(clientError); serverErrors.push(serverError); if (i === clientsOptions.length - 1) callback(); else connectClient(i + 1, callback); } } connectClient(0, function() { server.close(); }); } process.on('exit', function() { assert.deepEqual(serverResults, [ { sni: 'a.example.com', authorized: false }, { sni: 'a.example.com', authorized: true }, { sni: 'b.example.com', authorized: false }, { sni: 'c.wrong.com', authorized: false }, null ]); assert.deepEqual(clientResults, [true, true, true, false, false]); assert.deepEqual(clientErrors, [null, null, null, null, 'socket hang up']); assert.deepEqual(serverErrors, [ null, null, null, null, 'Invalid SNI context' ]); }); node-v4.8.2/test/parallel/test-tls-sni-server-client.js000644 000766 000024 00000005130 13070706737 023220 0ustar00iojsstaff000000 000000 'use strict'; if (!process.features.tls_sni) { common.skip('node compiled without OpenSSL or ' + 'with old OpenSSL version.'); return; } const common = require('../common'); const assert = require('assert'); const fs = require('fs'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); function filenamePEM(n) { return require('path').join(common.fixturesDir, 'keys', n + '.pem'); } function loadPEM(n) { return fs.readFileSync(filenamePEM(n)); } var serverOptions = { key: loadPEM('agent2-key'), cert: loadPEM('agent2-cert') }; var SNIContexts = { 'a.example.com': { key: loadPEM('agent1-key'), cert: loadPEM('agent1-cert') }, 'asterisk.test.com': { key: loadPEM('agent3-key'), cert: loadPEM('agent3-cert') }, 'chain.example.com': { key: loadPEM('agent6-key'), // NOTE: Contains ca3 chain cert cert: loadPEM('agent6-cert') } }; var clientsOptions = [{ port: undefined, ca: [loadPEM('ca1-cert')], servername: 'a.example.com', rejectUnauthorized: false }, { port: undefined, ca: [loadPEM('ca2-cert')], servername: 'b.test.com', rejectUnauthorized: false }, { port: undefined, ca: [loadPEM('ca2-cert')], servername: 'a.b.test.com', rejectUnauthorized: false }, { port: undefined, ca: [loadPEM('ca1-cert')], servername: 'c.wrong.com', rejectUnauthorized: false }, { port: undefined, ca: [loadPEM('ca1-cert')], servername: 'chain.example.com', rejectUnauthorized: false }]; const serverResults = []; const clientResults = []; var server = tls.createServer(serverOptions, function(c) { serverResults.push(c.servername); }); server.addContext('a.example.com', SNIContexts['a.example.com']); server.addContext('*.test.com', SNIContexts['asterisk.test.com']); server.addContext('chain.example.com', SNIContexts['chain.example.com']); server.listen(0, startTest); function startTest() { var i = 0; function start() { // No options left if (i === clientsOptions.length) return server.close(); var options = clientsOptions[i++]; options.port = server.address().port; var client = tls.connect(options, function() { clientResults.push( client.authorizationError && /Hostname\/IP doesn't/.test(client.authorizationError)); client.destroy(); // Continue start(); }); } start(); } process.on('exit', function() { assert.deepEqual(serverResults, [ 'a.example.com', 'b.test.com', 'a.b.test.com', 'c.wrong.com', 'chain.example.com' ]); assert.deepEqual(clientResults, [true, true, false, false, true]); }); node-v4.8.2/test/parallel/test-tls-socket-default-options.js000644 000766 000024 00000002142 13070706737 024252 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const tls = require('tls'); const fs = require('fs'); const sent = 'hello world'; const serverOptions = { isServer: true, key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }; function testSocketOptions(socket, socketOptions) { let received = ''; const server = tls.createServer(serverOptions, function(s) { s.on('data', function(chunk) { received += chunk; }); s.on('end', function() { server.close(); s.destroy(); assert.equal(received, sent); setImmediate(runTests); }); }).listen(0, function() { const c = new tls.TLSSocket(socket, socketOptions); c.connect(this.address().port, function() { c.end(sent); }); }); } const testArgs = [ [], [undefined, {}] ]; let n = 0; function runTests() { if (n++ < testArgs.length) { testSocketOptions.apply(null, testArgs[n]); } } runTests(); node-v4.8.2/test/parallel/test-tls-startcom-wosign-whitelist.js000644 000766 000024 00000004103 13070706737 025020 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const tls = require('tls'); const fs = require('fs'); const path = require('path'); let finished = 0; function filenamePEM(n) { return path.join(common.fixturesDir, 'keys', n + '.pem'); } function loadPEM(n) { return fs.readFileSync(filenamePEM(n)); } const testCases = [ { // agent8 is signed by fake-startcom-root with notBefore of // Oct 20 23:59:59 2016 GMT. It passes StartCom/WoSign check. serverOpts: { key: loadPEM('agent8-key'), cert: loadPEM('agent8-cert') }, clientOpts: { ca: loadPEM('fake-startcom-root-cert'), port: undefined, rejectUnauthorized: true }, errorCode: 'CERT_OK' }, { // agent9 is signed by fake-startcom-root with notBefore of // Oct 21 00:00:01 2016 GMT. It fails StartCom/WoSign check. serverOpts: { key: loadPEM('agent9-key'), cert: loadPEM('agent9-cert') }, clientOpts: { ca: loadPEM('fake-startcom-root-cert'), port: undefined, rejectUnauthorized: true }, errorCode: 'CERT_REVOKED' } ]; function runNextTest(server, tindex) { server.close(function() { finished++; runTest(tindex + 1); }); } function runTest(tindex) { const tcase = testCases[tindex]; if (!tcase) return; const server = tls.createServer(tcase.serverOpts, function(s) { s.resume(); }).listen(0, function() { tcase.clientOpts.port = this.address().port; const client = tls.connect(tcase.clientOpts); client.on('error', function(e) { assert.strictEqual(e.code, tcase.errorCode); runNextTest(server, tindex); }); client.on('secureConnect', function() { // agent8 can pass StartCom/WoSign check so that the secureConnect // is established. assert.strictEqual(tcase.errorCode, 'CERT_OK'); client.end(); runNextTest(server, tindex); }); }); } runTest(0); process.on('exit', function() { assert.strictEqual(finished, testCases.length); }); node-v4.8.2/test/parallel/test-tls-starttls-server.js000644 000766 000024 00000002260 13070706737 023034 0ustar00iojsstaff000000 000000 'use strict'; // Test asynchronous SNI+OCSP on TLSSocket created with `server` set to // `net.Server` instead of `tls.Server` const common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const assert = require('assert'); const fs = require('fs'); const net = require('net'); const tls = require('tls'); const key = fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'); const cert = fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem'); const server = net.createServer(common.mustCall((s) => { const tlsSocket = new tls.TLSSocket(s, { isServer: true, server: server, secureContext: tls.createSecureContext({ key: key, cert: cert }), SNICallback: common.mustCall((hostname, callback) => { assert.strictEqual(hostname, 'test.test'); callback(null, null); }) }); tlsSocket.on('secure', common.mustCall(() => { tlsSocket.end(); server.close(); })); })).listen(0, () => { const opts = { servername: 'test.test', port: server.address().port, rejectUnauthorized: false, requestOCSP: true }; tls.connect(opts, function() { this.end(); }); }); node-v4.8.2/test/parallel/test-tls-ticket-cluster.js000644 000766 000024 00000004375 13070706737 022623 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const tls = require('tls'); const cluster = require('cluster'); const fs = require('fs'); const join = require('path').join; const workerCount = 4; const expectedReqCount = 16; if (cluster.isMaster) { let reusedCount = 0; let reqCount = 0; let lastSession = null; let shootOnce = false; function shoot() { console.error('[master] connecting'); const c = tls.connect(common.PORT, { session: lastSession, rejectUnauthorized: false }, function() { lastSession = c.getSession(); c.end(); if (++reqCount === expectedReqCount) { Object.keys(cluster.workers).forEach(function(id) { cluster.workers[id].send('die'); }); } else { shoot(); } }); } function fork() { const worker = cluster.fork(); worker.on('message', function(msg) { console.error('[master] got %j', msg); if (msg === 'reused') { ++reusedCount; } else if (msg === 'listening' && !shootOnce) { shootOnce = true; shoot(); } }); worker.on('exit', function() { console.error('[master] worker died'); }); } for (let i = 0; i < workerCount; i++) { fork(); } process.on('exit', function() { assert.strictEqual(reqCount, expectedReqCount); assert.strictEqual(reusedCount + 1, reqCount); }); return; } const keyFile = join(common.fixturesDir, 'agent.key'); const certFile = join(common.fixturesDir, 'agent.crt'); const key = fs.readFileSync(keyFile); const cert = fs.readFileSync(certFile); const options = { key: key, cert: cert }; const server = tls.createServer(options, function(c) { if (c.isSessionReused()) { process.send('reused'); } else { process.send('not-reused'); } c.end(); }); server.listen(common.PORT, function() { process.send('listening'); }); process.on('message', function listener(msg) { console.error('[worker] got %j', msg); if (msg === 'die') { server.close(function() { console.error('[worker] server close'); process.exit(); }); } }); process.on('exit', function() { console.error('[worker] exit'); }); node-v4.8.2/test/parallel/test-tls-ticket.js000644 000766 000024 00000004732 13070706737 021141 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const tls = require('tls'); const fs = require('fs'); const net = require('net'); const crypto = require('crypto'); const keys = crypto.randomBytes(48); const serverLog = []; const ticketLog = []; let serverCount = 0; function createServer() { const id = serverCount++; let counter = 0; let previousKey = null; const server = tls.createServer({ key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem'), ticketKeys: keys }, function(c) { serverLog.push(id); c.end(); counter++; // Rotate ticket keys if (counter === 1) { previousKey = server.getTicketKeys(); server.setTicketKeys(crypto.randomBytes(48)); } else if (counter === 2) { server.setTicketKeys(previousKey); } else if (counter === 3) { // Use keys from counter=2 } else { throw new Error('UNREACHABLE'); } }); return server; } const naturalServers = [ createServer(), createServer(), createServer() ]; // 3x servers const servers = naturalServers.concat(naturalServers).concat(naturalServers); // Create one TCP server and balance sockets to multiple TLS server instances const shared = net.createServer(function(c) { servers.shift().emit('connection', c); }).listen(0, function() { start(function() { shared.close(); }); }); function start(callback) { let sess = null; let left = servers.length; function connect() { const s = tls.connect(shared.address().port, { session: sess, rejectUnauthorized: false }, function() { sess = sess || s.getSession(); ticketLog.push(s.getTLSTicket().toString('hex')); }); s.on('close', function() { if (--left === 0) callback(); else connect(); }); } connect(); } process.on('exit', function() { assert.strictEqual(ticketLog.length, serverLog.length); for (let i = 0; i < naturalServers.length - 1; i++) { assert.notStrictEqual(serverLog[i], serverLog[i + 1]); assert.strictEqual(ticketLog[i], ticketLog[i + 1]); // 2nd connection should have different ticket assert.notStrictEqual(ticketLog[i], ticketLog[i + naturalServers.length]); // 3rd connection should have the same ticket assert.strictEqual(ticketLog[i], ticketLog[i + naturalServers.length * 2]); } }); node-v4.8.2/test/parallel/test-tls-timeout-server-2.js000644 000766 000024 00000001365 13070706737 023006 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const tls = require('tls'); const fs = require('fs'); const options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }; const server = tls.createServer(options, common.mustCall(function(cleartext) { const s = cleartext.setTimeout(50, function() { cleartext.destroy(); server.close(); }); assert.ok(s instanceof tls.TLSSocket); })); server.listen(0, common.mustCall(function() { tls.connect({ host: '127.0.0.1', port: this.address().port, rejectUnauthorized: false }); })); node-v4.8.2/test/parallel/test-tls-timeout-server.js000644 000766 000024 00000001177 13070706737 022650 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var net = require('net'); var fs = require('fs'); var options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem'), handshakeTimeout: 50 }; var server = tls.createServer(options, common.fail); server.on('clientError', common.mustCall(function(err, conn) { conn.destroy(); server.close(); })); server.listen(0, function() { net.connect({ host: '127.0.0.1', port: this.address().port }); }); node-v4.8.2/test/parallel/test-tls-wrap-no-abort.js000644 000766 000024 00000000324 13070706737 022337 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const util = require('util'); const TLSWrap = process.binding('tls_wrap').TLSWrap; // This will abort if internal pointer is not set to nullptr. util.inspect(new TLSWrap()); node-v4.8.2/test/parallel/test-tls-wrap-timeout.js000644 000766 000024 00000001700 13070706737 022303 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var net = require('net'); var fs = require('fs'); var options = { key: fs.readFileSync(common.fixturesDir + '/keys/agent1-key.pem'), cert: fs.readFileSync(common.fixturesDir + '/keys/agent1-cert.pem') }; var server = tls.createServer(options, function(c) { setTimeout(function() { c.write('hello'); setTimeout(function() { c.destroy(); server.close(); }, 150); }, 150); }); server.listen(0, function() { var socket = net.connect(this.address().port, function() { var s = socket.setTimeout(common.platformTimeout(240), function() { throw new Error('timeout'); }); assert.ok(s instanceof net.Socket); var tsocket = tls.connect({ socket: socket, rejectUnauthorized: false }); tsocket.resume(); }); }); node-v4.8.2/test/parallel/test-tls-writewrap-leak.js000644 000766 000024 00000001152 13070706737 022605 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const assert = require('assert'); const net = require('net'); const tls = require('tls'); const server = net.createServer(common.mustCall((c) => { c.destroy(); })).listen(0, common.mustCall(() => { const c = tls.connect({ port: server.address().port }); c.on('error', () => { // Otherwise `.write()` callback won't be invoked. c.destroyed = false; }); c.write('hello', common.mustCall((err) => { assert.strictEqual(err.code, 'ECANCELED'); server.close(); })); })); node-v4.8.2/test/parallel/test-tls-zero-clear-in.js000644 000766 000024 00000001605 13070706737 022321 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var fs = require('fs'); var path = require('path'); var cert = fs.readFileSync(path.join(common.fixturesDir, 'test_cert.pem')); var key = fs.readFileSync(path.join(common.fixturesDir, 'test_key.pem')); var server = tls.createServer({ cert: cert, key: key }, function(c) { // Nop setTimeout(function() { c.end(); server.close(); }, 20); }).listen(0, common.mustCall(function() { var conn = tls.connect({ cert: cert, key: key, rejectUnauthorized: false, port: this.address().port }, function() { setTimeout(function() { conn.destroy(); }, 20); }); // SSL_write() call's return value, when called 0 bytes, should not be // treated as error. conn.end(''); conn.on('error', common.fail); })); node-v4.8.2/test/parallel/test-umask.js000644 000766 000024 00000001054 13070706737 020170 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); // Note in Windows one can only set the "user" bits. var mask; if (common.isWindows) { mask = '0600'; } else { mask = '0664'; } var old = process.umask(mask); assert.equal(parseInt(mask, 8), process.umask(old)); // confirm reading the umask does not modify it. // 1. If the test fails, this call will succeed, but the mask will be set to 0 assert.equal(old, process.umask()); // 2. If the test fails, process.umask() will return 0 assert.equal(old, process.umask()); node-v4.8.2/test/parallel/test-url.js000644 000766 000024 00000130004 13070706737 017650 0ustar00iojsstaff000000 000000 /* eslint-disable max-len */ 'use strict'; require('../common'); var assert = require('assert'); var url = require('url'); // URLs to parse, and expected data // { url : parsed } var parseTests = { '//some_path': { href: '//some_path', pathname: '//some_path', path: '//some_path' }, 'http:\\\\evil-phisher\\foo.html#h\\a\\s\\h': { protocol: 'http:', slashes: true, host: 'evil-phisher', hostname: 'evil-phisher', pathname: '/foo.html', path: '/foo.html', hash: '#h%5Ca%5Cs%5Ch', href: 'http://evil-phisher/foo.html#h%5Ca%5Cs%5Ch' }, 'http:\\\\evil-phisher\\foo.html?json="\\"foo\\""#h\\a\\s\\h': { protocol: 'http:', slashes: true, host: 'evil-phisher', hostname: 'evil-phisher', pathname: '/foo.html', search: '?json=%22%5C%22foo%5C%22%22', query: 'json=%22%5C%22foo%5C%22%22', path: '/foo.html?json=%22%5C%22foo%5C%22%22', hash: '#h%5Ca%5Cs%5Ch', href: 'http://evil-phisher/foo.html?json=%22%5C%22foo%5C%22%22#h%5Ca%5Cs%5Ch' }, 'http:\\\\evil-phisher\\foo.html#h\\a\\s\\h?blarg': { protocol: 'http:', slashes: true, host: 'evil-phisher', hostname: 'evil-phisher', pathname: '/foo.html', path: '/foo.html', hash: '#h%5Ca%5Cs%5Ch?blarg', href: 'http://evil-phisher/foo.html#h%5Ca%5Cs%5Ch?blarg' }, 'http:\\\\evil-phisher\\foo.html': { protocol: 'http:', slashes: true, host: 'evil-phisher', hostname: 'evil-phisher', pathname: '/foo.html', path: '/foo.html', href: 'http://evil-phisher/foo.html' }, 'HTTP://www.example.com/': { href: 'http://www.example.com/', protocol: 'http:', slashes: true, host: 'www.example.com', hostname: 'www.example.com', pathname: '/', path: '/' }, 'HTTP://www.example.com': { href: 'http://www.example.com/', protocol: 'http:', slashes: true, host: 'www.example.com', hostname: 'www.example.com', pathname: '/', path: '/' }, 'http://www.ExAmPlE.com/': { href: 'http://www.example.com/', protocol: 'http:', slashes: true, host: 'www.example.com', hostname: 'www.example.com', pathname: '/', path: '/' }, 'http://user:pw@www.ExAmPlE.com/': { href: 'http://user:pw@www.example.com/', protocol: 'http:', slashes: true, auth: 'user:pw', host: 'www.example.com', hostname: 'www.example.com', pathname: '/', path: '/' }, 'http://USER:PW@www.ExAmPlE.com/': { href: 'http://USER:PW@www.example.com/', protocol: 'http:', slashes: true, auth: 'USER:PW', host: 'www.example.com', hostname: 'www.example.com', pathname: '/', path: '/' }, 'http://user@www.example.com/': { href: 'http://user@www.example.com/', protocol: 'http:', slashes: true, auth: 'user', host: 'www.example.com', hostname: 'www.example.com', pathname: '/', path: '/' }, 'http://user%3Apw@www.example.com/': { href: 'http://user:pw@www.example.com/', protocol: 'http:', slashes: true, auth: 'user:pw', host: 'www.example.com', hostname: 'www.example.com', pathname: '/', path: '/' }, 'http://x.com/path?that\'s#all, folks': { href: 'http://x.com/path?that%27s#all,%20folks', protocol: 'http:', slashes: true, host: 'x.com', hostname: 'x.com', search: '?that%27s', query: 'that%27s', pathname: '/path', hash: '#all,%20folks', path: '/path?that%27s' }, 'HTTP://X.COM/Y': { href: 'http://x.com/Y', protocol: 'http:', slashes: true, host: 'x.com', hostname: 'x.com', pathname: '/Y', path: '/Y' }, // whitespace in the front ' http://www.example.com/': { href: 'http://www.example.com/', protocol: 'http:', slashes: true, host: 'www.example.com', hostname: 'www.example.com', pathname: '/', path: '/' }, // + not an invalid host character // per https://url.spec.whatwg.org/#host-parsing 'http://x.y.com+a/b/c': { href: 'http://x.y.com+a/b/c', protocol: 'http:', slashes: true, host: 'x.y.com+a', hostname: 'x.y.com+a', pathname: '/b/c', path: '/b/c' }, // an unexpected invalid char in the hostname. 'HtTp://x.y.cOm;a/b/c?d=e#f gi': { href: 'http://x.y.com/;a/b/c?d=e#f%20g%3Ch%3Ei', protocol: 'http:', slashes: true, host: 'x.y.com', hostname: 'x.y.com', pathname: ';a/b/c', search: '?d=e', query: 'd=e', hash: '#f%20g%3Ch%3Ei', path: ';a/b/c?d=e' }, // make sure that we don't accidentally lcast the path parts. 'HtTp://x.y.cOm;A/b/c?d=e#f gi': { href: 'http://x.y.com/;A/b/c?d=e#f%20g%3Ch%3Ei', protocol: 'http:', slashes: true, host: 'x.y.com', hostname: 'x.y.com', pathname: ';A/b/c', search: '?d=e', query: 'd=e', hash: '#f%20g%3Ch%3Ei', path: ';A/b/c?d=e' }, 'http://x...y...#p': { href: 'http://x...y.../#p', protocol: 'http:', slashes: true, host: 'x...y...', hostname: 'x...y...', hash: '#p', pathname: '/', path: '/' }, 'http://x/p/"quoted"': { href: 'http://x/p/%22quoted%22', protocol: 'http:', slashes: true, host: 'x', hostname: 'x', pathname: '/p/%22quoted%22', path: '/p/%22quoted%22' }, ' Is a URL!': { href: '%3Chttp://goo.corn/bread%3E%20Is%20a%20URL!', pathname: '%3Chttp://goo.corn/bread%3E%20Is%20a%20URL!', path: '%3Chttp://goo.corn/bread%3E%20Is%20a%20URL!' }, 'http://www.narwhaljs.org/blog/categories?id=news': { href: 'http://www.narwhaljs.org/blog/categories?id=news', protocol: 'http:', slashes: true, host: 'www.narwhaljs.org', hostname: 'www.narwhaljs.org', search: '?id=news', query: 'id=news', pathname: '/blog/categories', path: '/blog/categories?id=news' }, 'http://mt0.google.com/vt/lyrs=m@114&hl=en&src=api&x=2&y=2&z=3&s=': { href: 'http://mt0.google.com/vt/lyrs=m@114&hl=en&src=api&x=2&y=2&z=3&s=', protocol: 'http:', slashes: true, host: 'mt0.google.com', hostname: 'mt0.google.com', pathname: '/vt/lyrs=m@114&hl=en&src=api&x=2&y=2&z=3&s=', path: '/vt/lyrs=m@114&hl=en&src=api&x=2&y=2&z=3&s=' }, 'http://mt0.google.com/vt/lyrs=m@114???&hl=en&src=api&x=2&y=2&z=3&s=': { href: 'http://mt0.google.com/vt/lyrs=m@114???&hl=en&src=api' + '&x=2&y=2&z=3&s=', protocol: 'http:', slashes: true, host: 'mt0.google.com', hostname: 'mt0.google.com', search: '???&hl=en&src=api&x=2&y=2&z=3&s=', query: '??&hl=en&src=api&x=2&y=2&z=3&s=', pathname: '/vt/lyrs=m@114', path: '/vt/lyrs=m@114???&hl=en&src=api&x=2&y=2&z=3&s=' }, 'http://user:pass@mt0.google.com/vt/lyrs=m@114???&hl=en&src=api&x=2&y=2&z=3&s=': { href: 'http://user:pass@mt0.google.com/vt/lyrs=m@114???' + '&hl=en&src=api&x=2&y=2&z=3&s=', protocol: 'http:', slashes: true, host: 'mt0.google.com', auth: 'user:pass', hostname: 'mt0.google.com', search: '???&hl=en&src=api&x=2&y=2&z=3&s=', query: '??&hl=en&src=api&x=2&y=2&z=3&s=', pathname: '/vt/lyrs=m@114', path: '/vt/lyrs=m@114???&hl=en&src=api&x=2&y=2&z=3&s=' }, 'file:///etc/passwd': { href: 'file:///etc/passwd', slashes: true, protocol: 'file:', pathname: '/etc/passwd', hostname: '', host: '', path: '/etc/passwd' }, 'file://localhost/etc/passwd': { href: 'file://localhost/etc/passwd', protocol: 'file:', slashes: true, pathname: '/etc/passwd', hostname: 'localhost', host: 'localhost', path: '/etc/passwd' }, 'file://foo/etc/passwd': { href: 'file://foo/etc/passwd', protocol: 'file:', slashes: true, pathname: '/etc/passwd', hostname: 'foo', host: 'foo', path: '/etc/passwd' }, 'file:///etc/node/': { href: 'file:///etc/node/', slashes: true, protocol: 'file:', pathname: '/etc/node/', hostname: '', host: '', path: '/etc/node/' }, 'file://localhost/etc/node/': { href: 'file://localhost/etc/node/', protocol: 'file:', slashes: true, pathname: '/etc/node/', hostname: 'localhost', host: 'localhost', path: '/etc/node/' }, 'file://foo/etc/node/': { href: 'file://foo/etc/node/', protocol: 'file:', slashes: true, pathname: '/etc/node/', hostname: 'foo', host: 'foo', path: '/etc/node/' }, 'http:/baz/../foo/bar': { href: 'http:/baz/../foo/bar', protocol: 'http:', pathname: '/baz/../foo/bar', path: '/baz/../foo/bar' }, 'http://user:pass@example.com:8000/foo/bar?baz=quux#frag': { href: 'http://user:pass@example.com:8000/foo/bar?baz=quux#frag', protocol: 'http:', slashes: true, host: 'example.com:8000', auth: 'user:pass', port: '8000', hostname: 'example.com', hash: '#frag', search: '?baz=quux', query: 'baz=quux', pathname: '/foo/bar', path: '/foo/bar?baz=quux' }, '//user:pass@example.com:8000/foo/bar?baz=quux#frag': { href: '//user:pass@example.com:8000/foo/bar?baz=quux#frag', slashes: true, host: 'example.com:8000', auth: 'user:pass', port: '8000', hostname: 'example.com', hash: '#frag', search: '?baz=quux', query: 'baz=quux', pathname: '/foo/bar', path: '/foo/bar?baz=quux' }, '/foo/bar?baz=quux#frag': { href: '/foo/bar?baz=quux#frag', hash: '#frag', search: '?baz=quux', query: 'baz=quux', pathname: '/foo/bar', path: '/foo/bar?baz=quux' }, 'http:/foo/bar?baz=quux#frag': { href: 'http:/foo/bar?baz=quux#frag', protocol: 'http:', hash: '#frag', search: '?baz=quux', query: 'baz=quux', pathname: '/foo/bar', path: '/foo/bar?baz=quux' }, 'mailto:foo@bar.com?subject=hello': { href: 'mailto:foo@bar.com?subject=hello', protocol: 'mailto:', host: 'bar.com', auth: 'foo', hostname: 'bar.com', search: '?subject=hello', query: 'subject=hello', path: '?subject=hello' }, 'javascript:alert(\'hello\');': { href: 'javascript:alert(\'hello\');', protocol: 'javascript:', pathname: 'alert(\'hello\');', path: 'alert(\'hello\');' }, 'xmpp:isaacschlueter@jabber.org': { href: 'xmpp:isaacschlueter@jabber.org', protocol: 'xmpp:', host: 'jabber.org', auth: 'isaacschlueter', hostname: 'jabber.org' }, 'http://atpass:foo%40bar@127.0.0.1:8080/path?search=foo#bar': { href: 'http://atpass:foo%40bar@127.0.0.1:8080/path?search=foo#bar', protocol: 'http:', slashes: true, host: '127.0.0.1:8080', auth: 'atpass:foo@bar', hostname: '127.0.0.1', port: '8080', pathname: '/path', search: '?search=foo', query: 'search=foo', hash: '#bar', path: '/path?search=foo' }, 'svn+ssh://foo/bar': { href: 'svn+ssh://foo/bar', host: 'foo', hostname: 'foo', protocol: 'svn+ssh:', pathname: '/bar', path: '/bar', slashes: true }, 'dash-test://foo/bar': { href: 'dash-test://foo/bar', host: 'foo', hostname: 'foo', protocol: 'dash-test:', pathname: '/bar', path: '/bar', slashes: true }, 'dash-test:foo/bar': { href: 'dash-test:foo/bar', host: 'foo', hostname: 'foo', protocol: 'dash-test:', pathname: '/bar', path: '/bar' }, 'dot.test://foo/bar': { href: 'dot.test://foo/bar', host: 'foo', hostname: 'foo', protocol: 'dot.test:', pathname: '/bar', path: '/bar', slashes: true }, 'dot.test:foo/bar': { href: 'dot.test:foo/bar', host: 'foo', hostname: 'foo', protocol: 'dot.test:', pathname: '/bar', path: '/bar' }, // IDNA tests 'http://www.日本語.com/': { href: 'http://www.xn--wgv71a119e.com/', protocol: 'http:', slashes: true, host: 'www.xn--wgv71a119e.com', hostname: 'www.xn--wgv71a119e.com', pathname: '/', path: '/' }, 'http://example.Bücher.com/': { href: 'http://example.xn--bcher-kva.com/', protocol: 'http:', slashes: true, host: 'example.xn--bcher-kva.com', hostname: 'example.xn--bcher-kva.com', pathname: '/', path: '/' }, 'http://www.Äffchen.com/': { href: 'http://www.xn--ffchen-9ta.com/', protocol: 'http:', slashes: true, host: 'www.xn--ffchen-9ta.com', hostname: 'www.xn--ffchen-9ta.com', pathname: '/', path: '/' }, 'http://www.Äffchen.cOm;A/b/c?d=e#f gi': { href: 'http://www.xn--ffchen-9ta.com/;A/b/c?d=e#f%20g%3Ch%3Ei', protocol: 'http:', slashes: true, host: 'www.xn--ffchen-9ta.com', hostname: 'www.xn--ffchen-9ta.com', pathname: ';A/b/c', search: '?d=e', query: 'd=e', hash: '#f%20g%3Ch%3Ei', path: ';A/b/c?d=e' }, 'http://SÉLIER.COM/': { href: 'http://xn--slier-bsa.com/', protocol: 'http:', slashes: true, host: 'xn--slier-bsa.com', hostname: 'xn--slier-bsa.com', pathname: '/', path: '/' }, 'http://ليهمابتكلموشعربي؟.ي؟/': { href: 'http://xn--egbpdaj6bu4bxfgehfvwxn.xn--egb9f/', protocol: 'http:', slashes: true, host: 'xn--egbpdaj6bu4bxfgehfvwxn.xn--egb9f', hostname: 'xn--egbpdaj6bu4bxfgehfvwxn.xn--egb9f', pathname: '/', path: '/' }, 'http://➡.ws/➡': { href: 'http://xn--hgi.ws/➡', protocol: 'http:', slashes: true, host: 'xn--hgi.ws', hostname: 'xn--hgi.ws', pathname: '/➡', path: '/➡' }, 'http://bucket_name.s3.amazonaws.com/image.jpg': { protocol: 'http:', slashes: true, host: 'bucket_name.s3.amazonaws.com', hostname: 'bucket_name.s3.amazonaws.com', pathname: '/image.jpg', href: 'http://bucket_name.s3.amazonaws.com/image.jpg', path: '/image.jpg' }, 'git+http://github.com/joyent/node.git': { protocol: 'git+http:', slashes: true, host: 'github.com', hostname: 'github.com', pathname: '/joyent/node.git', path: '/joyent/node.git', href: 'git+http://github.com/joyent/node.git' }, //if local1@domain1 is uses as a relative URL it may //be parse into auth@hostname, but here there is no //way to make it work in url.parse, I add the test to be explicit 'local1@domain1': { pathname: 'local1@domain1', path: 'local1@domain1', href: 'local1@domain1' }, //While this may seem counter-intuitive, a browser will parse // as a path. 'www.example.com': { href: 'www.example.com', pathname: 'www.example.com', path: 'www.example.com' }, // ipv6 support '[fe80::1]': { href: '[fe80::1]', pathname: '[fe80::1]', path: '[fe80::1]' }, 'coap://[FEDC:BA98:7654:3210:FEDC:BA98:7654:3210]': { protocol: 'coap:', slashes: true, host: '[fedc:ba98:7654:3210:fedc:ba98:7654:3210]', hostname: 'fedc:ba98:7654:3210:fedc:ba98:7654:3210', href: 'coap://[fedc:ba98:7654:3210:fedc:ba98:7654:3210]/', pathname: '/', path: '/' }, 'coap://[1080:0:0:0:8:800:200C:417A]:61616/': { protocol: 'coap:', slashes: true, host: '[1080:0:0:0:8:800:200c:417a]:61616', port: '61616', hostname: '1080:0:0:0:8:800:200c:417a', href: 'coap://[1080:0:0:0:8:800:200c:417a]:61616/', pathname: '/', path: '/' }, 'http://user:password@[3ffe:2a00:100:7031::1]:8080': { protocol: 'http:', slashes: true, auth: 'user:password', host: '[3ffe:2a00:100:7031::1]:8080', port: '8080', hostname: '3ffe:2a00:100:7031::1', href: 'http://user:password@[3ffe:2a00:100:7031::1]:8080/', pathname: '/', path: '/' }, 'coap://u:p@[::192.9.5.5]:61616/.well-known/r?n=Temperature': { protocol: 'coap:', slashes: true, auth: 'u:p', host: '[::192.9.5.5]:61616', port: '61616', hostname: '::192.9.5.5', href: 'coap://u:p@[::192.9.5.5]:61616/.well-known/r?n=Temperature', search: '?n=Temperature', query: 'n=Temperature', pathname: '/.well-known/r', path: '/.well-known/r?n=Temperature' }, // empty port 'http://example.com:': { protocol: 'http:', slashes: true, host: 'example.com', hostname: 'example.com', href: 'http://example.com/', pathname: '/', path: '/' }, 'http://example.com:/a/b.html': { protocol: 'http:', slashes: true, host: 'example.com', hostname: 'example.com', href: 'http://example.com/a/b.html', pathname: '/a/b.html', path: '/a/b.html' }, 'http://example.com:?a=b': { protocol: 'http:', slashes: true, host: 'example.com', hostname: 'example.com', href: 'http://example.com/?a=b', search: '?a=b', query: 'a=b', pathname: '/', path: '/?a=b' }, 'http://example.com:#abc': { protocol: 'http:', slashes: true, host: 'example.com', hostname: 'example.com', href: 'http://example.com/#abc', hash: '#abc', pathname: '/', path: '/' }, 'http://[fe80::1]:/a/b?a=b#abc': { protocol: 'http:', slashes: true, host: '[fe80::1]', hostname: 'fe80::1', href: 'http://[fe80::1]/a/b?a=b#abc', search: '?a=b', query: 'a=b', hash: '#abc', pathname: '/a/b', path: '/a/b?a=b' }, 'http://-lovemonsterz.tumblr.com/rss': { protocol: 'http:', slashes: true, host: '-lovemonsterz.tumblr.com', hostname: '-lovemonsterz.tumblr.com', href: 'http://-lovemonsterz.tumblr.com/rss', pathname: '/rss', path: '/rss', }, 'http://-lovemonsterz.tumblr.com:80/rss': { protocol: 'http:', slashes: true, port: '80', host: '-lovemonsterz.tumblr.com:80', hostname: '-lovemonsterz.tumblr.com', href: 'http://-lovemonsterz.tumblr.com:80/rss', pathname: '/rss', path: '/rss', }, 'http://user:pass@-lovemonsterz.tumblr.com/rss': { protocol: 'http:', slashes: true, auth: 'user:pass', host: '-lovemonsterz.tumblr.com', hostname: '-lovemonsterz.tumblr.com', href: 'http://user:pass@-lovemonsterz.tumblr.com/rss', pathname: '/rss', path: '/rss', }, 'http://user:pass@-lovemonsterz.tumblr.com:80/rss': { protocol: 'http:', slashes: true, auth: 'user:pass', port: '80', host: '-lovemonsterz.tumblr.com:80', hostname: '-lovemonsterz.tumblr.com', href: 'http://user:pass@-lovemonsterz.tumblr.com:80/rss', pathname: '/rss', path: '/rss', }, 'http://_jabber._tcp.google.com/test': { protocol: 'http:', slashes: true, host: '_jabber._tcp.google.com', hostname: '_jabber._tcp.google.com', href: 'http://_jabber._tcp.google.com/test', pathname: '/test', path: '/test', }, 'http://user:pass@_jabber._tcp.google.com/test': { protocol: 'http:', slashes: true, auth: 'user:pass', host: '_jabber._tcp.google.com', hostname: '_jabber._tcp.google.com', href: 'http://user:pass@_jabber._tcp.google.com/test', pathname: '/test', path: '/test', }, 'http://_jabber._tcp.google.com:80/test': { protocol: 'http:', slashes: true, port: '80', host: '_jabber._tcp.google.com:80', hostname: '_jabber._tcp.google.com', href: 'http://_jabber._tcp.google.com:80/test', pathname: '/test', path: '/test', }, 'http://user:pass@_jabber._tcp.google.com:80/test': { protocol: 'http:', slashes: true, auth: 'user:pass', port: '80', host: '_jabber._tcp.google.com:80', hostname: '_jabber._tcp.google.com', href: 'http://user:pass@_jabber._tcp.google.com:80/test', pathname: '/test', path: '/test', }, 'http://x:1/\' <>"`/{}|\\^~`/': { protocol: 'http:', slashes: true, host: 'x:1', port: '1', hostname: 'x', pathname: '/%27%20%3C%3E%22%60/%7B%7D%7C/%5E~%60/', path: '/%27%20%3C%3E%22%60/%7B%7D%7C/%5E~%60/', href: 'http://x:1/%27%20%3C%3E%22%60/%7B%7D%7C/%5E~%60/' }, 'http://a@b@c/': { protocol: 'http:', slashes: true, auth: 'a@b', host: 'c', hostname: 'c', href: 'http://a%40b@c/', path: '/', pathname: '/' }, 'http://a@b?@c': { protocol: 'http:', slashes: true, auth: 'a', host: 'b', hostname: 'b', href: 'http://a@b/?@c', path: '/?@c', pathname: '/', search: '?@c', query: '@c' }, 'http://a\r" \t\n<\'b:b@c\r\nd/e?f': { protocol: 'http:', slashes: true, auth: 'a\r" \t\n<\'b:b', host: 'c', port: null, hostname: 'c', hash: null, search: '?f', query: 'f', pathname: '%0D%0Ad/e', path: '%0D%0Ad/e?f', href: 'http://a%0D%22%20%09%0A%3C\'b:b@c/%0D%0Ad/e?f' }, // git urls used by npm 'git+ssh://git@github.com:npm/npm': { protocol: 'git+ssh:', slashes: true, auth: 'git', host: 'github.com', port: null, hostname: 'github.com', hash: null, search: null, query: null, pathname: '/:npm/npm', path: '/:npm/npm', href: 'git+ssh://git@github.com/:npm/npm' } }; for (const u in parseTests) { let actual = url.parse(u); const spaced = url.parse(` \t ${u}\n\t`); let expected = parseTests[u]; Object.keys(actual).forEach(function(i) { if (expected[i] === undefined && actual[i] === null) { expected[i] = null; } }); assert.deepEqual(actual, expected); assert.deepEqual(spaced, expected); expected = parseTests[u].href; actual = url.format(parseTests[u]); assert.equal(actual, expected, 'format(' + u + ') == ' + u + '\nactual:' + actual); } var parseTestsWithQueryString = { '/foo/bar?baz=quux#frag': { href: '/foo/bar?baz=quux#frag', hash: '#frag', search: '?baz=quux', query: { baz: 'quux' }, pathname: '/foo/bar', path: '/foo/bar?baz=quux' }, 'http://example.com': { href: 'http://example.com/', protocol: 'http:', slashes: true, host: 'example.com', hostname: 'example.com', query: {}, search: '', pathname: '/', path: '/' }, '/example': { protocol: null, slashes: null, auth: null, host: null, port: null, hostname: null, hash: null, search: '', query: {}, pathname: '/example', path: '/example', href: '/example' }, '/example?query=value': { protocol: null, slashes: null, auth: null, host: null, port: null, hostname: null, hash: null, search: '?query=value', query: { query: 'value' }, pathname: '/example', path: '/example?query=value', href: '/example?query=value' } }; for (const u in parseTestsWithQueryString) { const actual = url.parse(u, true); const expected = parseTestsWithQueryString[u]; for (const i in actual) { if (actual[i] === null && expected[i] === undefined) { expected[i] = null; } } assert.deepEqual(actual, expected); } // some extra formatting tests, just to verify // that it'll format slightly wonky content to a valid url. var formatTests = { 'http://example.com?': { href: 'http://example.com/?', protocol: 'http:', slashes: true, host: 'example.com', hostname: 'example.com', search: '?', query: {}, pathname: '/' }, 'http://example.com?foo=bar#frag': { href: 'http://example.com/?foo=bar#frag', protocol: 'http:', host: 'example.com', hostname: 'example.com', hash: '#frag', search: '?foo=bar', query: 'foo=bar', pathname: '/' }, 'http://example.com?foo=@bar#frag': { href: 'http://example.com/?foo=@bar#frag', protocol: 'http:', host: 'example.com', hostname: 'example.com', hash: '#frag', search: '?foo=@bar', query: 'foo=@bar', pathname: '/' }, 'http://example.com?foo=/bar/#frag': { href: 'http://example.com/?foo=/bar/#frag', protocol: 'http:', host: 'example.com', hostname: 'example.com', hash: '#frag', search: '?foo=/bar/', query: 'foo=/bar/', pathname: '/' }, 'http://example.com?foo=?bar/#frag': { href: 'http://example.com/?foo=?bar/#frag', protocol: 'http:', host: 'example.com', hostname: 'example.com', hash: '#frag', search: '?foo=?bar/', query: 'foo=?bar/', pathname: '/' }, 'http://example.com#frag=?bar/#frag': { href: 'http://example.com/#frag=?bar/#frag', protocol: 'http:', host: 'example.com', hostname: 'example.com', hash: '#frag=?bar/#frag', pathname: '/' }, 'http://google.com" onload="alert(42)/': { href: 'http://google.com/%22%20onload=%22alert(42)/', protocol: 'http:', host: 'google.com', pathname: '/%22%20onload=%22alert(42)/' }, 'http://a.com/a/b/c?s#h': { href: 'http://a.com/a/b/c?s#h', protocol: 'http', host: 'a.com', pathname: 'a/b/c', hash: 'h', search: 's' }, 'xmpp:isaacschlueter@jabber.org': { href: 'xmpp:isaacschlueter@jabber.org', protocol: 'xmpp:', host: 'jabber.org', auth: 'isaacschlueter', hostname: 'jabber.org' }, 'http://atpass:foo%40bar@127.0.0.1/': { href: 'http://atpass:foo%40bar@127.0.0.1/', auth: 'atpass:foo@bar', hostname: '127.0.0.1', protocol: 'http:', pathname: '/' }, 'http://atslash%2F%40:%2F%40@foo/': { href: 'http://atslash%2F%40:%2F%40@foo/', auth: 'atslash/@:/@', hostname: 'foo', protocol: 'http:', pathname: '/' }, 'svn+ssh://foo/bar': { href: 'svn+ssh://foo/bar', hostname: 'foo', protocol: 'svn+ssh:', pathname: '/bar', slashes: true }, 'dash-test://foo/bar': { href: 'dash-test://foo/bar', hostname: 'foo', protocol: 'dash-test:', pathname: '/bar', slashes: true }, 'dash-test:foo/bar': { href: 'dash-test:foo/bar', hostname: 'foo', protocol: 'dash-test:', pathname: '/bar' }, 'dot.test://foo/bar': { href: 'dot.test://foo/bar', hostname: 'foo', protocol: 'dot.test:', pathname: '/bar', slashes: true }, 'dot.test:foo/bar': { href: 'dot.test:foo/bar', hostname: 'foo', protocol: 'dot.test:', pathname: '/bar' }, // ipv6 support 'coap:u:p@[::1]:61616/.well-known/r?n=Temperature': { href: 'coap:u:p@[::1]:61616/.well-known/r?n=Temperature', protocol: 'coap:', auth: 'u:p', hostname: '::1', port: '61616', pathname: '/.well-known/r', search: 'n=Temperature' }, 'coap:[fedc:ba98:7654:3210:fedc:ba98:7654:3210]:61616/s/stopButton': { href: 'coap:[fedc:ba98:7654:3210:fedc:ba98:7654:3210]:61616/s/stopButton', protocol: 'coap', host: '[fedc:ba98:7654:3210:fedc:ba98:7654:3210]:61616', pathname: '/s/stopButton' }, // encode context-specific delimiters in path and query, but do not touch // other non-delimiter chars like `%`. // // `#`,`?` in path '/path/to/%%23%3F+=&.txt?foo=theA1#bar': { href: '/path/to/%%23%3F+=&.txt?foo=theA1#bar', pathname: '/path/to/%#?+=&.txt', query: { foo: 'theA1' }, hash: '#bar' }, // `#`,`?` in path + `#` in query '/path/to/%%23%3F+=&.txt?foo=the%231#bar': { href: '/path/to/%%23%3F+=&.txt?foo=the%231#bar', pathname: '/path/to/%#?+=&.txt', query: { foo: 'the#1' }, hash: '#bar' }, // `?` and `#` in path and search 'http://ex.com/foo%3F100%m%23r?abc=the%231?&foo=bar#frag': { href: 'http://ex.com/foo%3F100%m%23r?abc=the%231?&foo=bar#frag', protocol: 'http:', hostname: 'ex.com', hash: '#frag', search: '?abc=the#1?&foo=bar', pathname: '/foo?100%m#r', }, // `?` and `#` in search only 'http://ex.com/fooA100%mBr?abc=the%231?&foo=bar#frag': { href: 'http://ex.com/fooA100%mBr?abc=the%231?&foo=bar#frag', protocol: 'http:', hostname: 'ex.com', hash: '#frag', search: '?abc=the#1?&foo=bar', pathname: '/fooA100%mBr', }, // multiple `#` in search 'http://example.com/?foo=bar%231%232%233&abc=%234%23%235#frag': { href: 'http://example.com/?foo=bar%231%232%233&abc=%234%23%235#frag', protocol: 'http:', slashes: true, host: 'example.com', hostname: 'example.com', hash: '#frag', search: '?foo=bar#1#2#3&abc=#4##5', query: {}, pathname: '/' } }; for (const u in formatTests) { const expect = formatTests[u].href; delete formatTests[u].href; const actual = url.format(u); const actualObj = url.format(formatTests[u]); assert.equal(actual, expect, 'wonky format(' + u + ') == ' + expect + '\nactual:' + actual); assert.equal(actualObj, expect, 'wonky format(' + JSON.stringify(formatTests[u]) + ') == ' + expect + '\nactual: ' + actualObj); } /* [from, path, expected] */ var relativeTests = [ ['/foo/bar/baz', 'quux', '/foo/bar/quux'], ['/foo/bar/baz', 'quux/asdf', '/foo/bar/quux/asdf'], ['/foo/bar/baz', 'quux/baz', '/foo/bar/quux/baz'], ['/foo/bar/baz', '../quux/baz', '/foo/quux/baz'], ['/foo/bar/baz', '/bar', '/bar'], ['/foo/bar/baz/', 'quux', '/foo/bar/baz/quux'], ['/foo/bar/baz/', 'quux/baz', '/foo/bar/baz/quux/baz'], ['/foo/bar/baz', '../../../../../../../../quux/baz', '/quux/baz'], ['/foo/bar/baz', '../../../../../../../quux/baz', '/quux/baz'], ['/foo', '.', '/'], ['/foo', '..', '/'], ['/foo/', '.', '/foo/'], ['/foo/', '..', '/'], ['/foo/bar', '.', '/foo/'], ['/foo/bar', '..', '/'], ['/foo/bar/', '.', '/foo/bar/'], ['/foo/bar/', '..', '/foo/'], ['foo/bar', '../../../baz', '../../baz'], ['foo/bar/', '../../../baz', '../baz'], ['http://example.com/b//c//d;p?q#blarg', 'https:#hash2', 'https:///#hash2'], ['http://example.com/b//c//d;p?q#blarg', 'https:/p/a/t/h?s#hash2', 'https://p/a/t/h?s#hash2'], ['http://example.com/b//c//d;p?q#blarg', 'https://u:p@h.com/p/a/t/h?s#hash2', 'https://u:p@h.com/p/a/t/h?s#hash2'], ['http://example.com/b//c//d;p?q#blarg', 'https:/a/b/c/d', 'https://a/b/c/d'], ['http://example.com/b//c//d;p?q#blarg', 'http:#hash2', 'http://example.com/b//c//d;p?q#hash2'], ['http://example.com/b//c//d;p?q#blarg', 'http:/p/a/t/h?s#hash2', 'http://example.com/p/a/t/h?s#hash2'], ['http://example.com/b//c//d;p?q#blarg', 'http://u:p@h.com/p/a/t/h?s#hash2', 'http://u:p@h.com/p/a/t/h?s#hash2'], ['http://example.com/b//c//d;p?q#blarg', 'http:/a/b/c/d', 'http://example.com/a/b/c/d'], ['/foo/bar/baz', '/../etc/passwd', '/etc/passwd'], ['http://localhost', 'file:///Users/foo', 'file:///Users/foo'], ['http://localhost', 'file://foo/Users', 'file://foo/Users'] ]; relativeTests.forEach(function(relativeTest) { const a = url.resolve(relativeTest[0], relativeTest[1]); const e = relativeTest[2]; assert.equal(a, e, 'resolve(' + [relativeTest[0], relativeTest[1]] + ') == ' + e + '\n actual=' + a); }); // https://github.com/joyent/node/issues/568 [ undefined, null, true, false, 0.0, 0, [], {} ].forEach(function(val) { assert.throws(function() { url.parse(val); }, TypeError); }); // // Tests below taken from Chiron // http://code.google.com/p/chironjs/source/browse/trunk/src/test/http/url.js // // Copyright (c) 2002-2008 Kris Kowal // used with permission under MIT License // // Changes marked with @isaacs var bases = [ 'http://a/b/c/d;p?q', 'http://a/b/c/d;p?q=1/2', 'http://a/b/c/d;p=1/2?q', 'fred:///s//a/b/c', 'http:///s//a/b/c' ]; //[to, from, result] var relativeTests2 = [ // http://lists.w3.org/Archives/Public/uri/2004Feb/0114.html ['../c', 'foo:a/b', 'foo:c'], ['foo:.', 'foo:a', 'foo:'], ['/foo/../../../bar', 'zz:abc', 'zz:/bar'], ['/foo/../bar', 'zz:abc', 'zz:/bar'], // @isaacs Disagree. Not how web browsers resolve this. ['foo/../../../bar', 'zz:abc', 'zz:bar'], // ['foo/../../../bar', 'zz:abc', 'zz:../../bar'], // @isaacs Added ['foo/../bar', 'zz:abc', 'zz:bar'], ['zz:.', 'zz:abc', 'zz:'], ['/.', bases[0], 'http://a/'], ['/.foo', bases[0], 'http://a/.foo'], ['.foo', bases[0], 'http://a/b/c/.foo'], // http://gbiv.com/protocols/uri/test/rel_examples1.html // examples from RFC 2396 ['g:h', bases[0], 'g:h'], ['g', bases[0], 'http://a/b/c/g'], ['./g', bases[0], 'http://a/b/c/g'], ['g/', bases[0], 'http://a/b/c/g/'], ['/g', bases[0], 'http://a/g'], ['//g', bases[0], 'http://g/'], // changed with RFC 2396bis //('?y', bases[0], 'http://a/b/c/d;p?y'], ['?y', bases[0], 'http://a/b/c/d;p?y'], ['g?y', bases[0], 'http://a/b/c/g?y'], // changed with RFC 2396bis //('#s', bases[0], CURRENT_DOC_URI + '#s'], ['#s', bases[0], 'http://a/b/c/d;p?q#s'], ['g#s', bases[0], 'http://a/b/c/g#s'], ['g?y#s', bases[0], 'http://a/b/c/g?y#s'], [';x', bases[0], 'http://a/b/c/;x'], ['g;x', bases[0], 'http://a/b/c/g;x'], ['g;x?y#s', bases[0], 'http://a/b/c/g;x?y#s'], // changed with RFC 2396bis //('', bases[0], CURRENT_DOC_URI], ['', bases[0], 'http://a/b/c/d;p?q'], ['.', bases[0], 'http://a/b/c/'], ['./', bases[0], 'http://a/b/c/'], ['..', bases[0], 'http://a/b/'], ['../', bases[0], 'http://a/b/'], ['../g', bases[0], 'http://a/b/g'], ['../..', bases[0], 'http://a/'], ['../../', bases[0], 'http://a/'], ['../../g', bases[0], 'http://a/g'], ['../../../g', bases[0], ('http://a/../g', 'http://a/g')], ['../../../../g', bases[0], ('http://a/../../g', 'http://a/g')], // changed with RFC 2396bis //('/./g', bases[0], 'http://a/./g'], ['/./g', bases[0], 'http://a/g'], // changed with RFC 2396bis //('/../g', bases[0], 'http://a/../g'], ['/../g', bases[0], 'http://a/g'], ['g.', bases[0], 'http://a/b/c/g.'], ['.g', bases[0], 'http://a/b/c/.g'], ['g..', bases[0], 'http://a/b/c/g..'], ['..g', bases[0], 'http://a/b/c/..g'], ['./../g', bases[0], 'http://a/b/g'], ['./g/.', bases[0], 'http://a/b/c/g/'], ['g/./h', bases[0], 'http://a/b/c/g/h'], ['g/../h', bases[0], 'http://a/b/c/h'], ['g;x=1/./y', bases[0], 'http://a/b/c/g;x=1/y'], ['g;x=1/../y', bases[0], 'http://a/b/c/y'], ['g?y/./x', bases[0], 'http://a/b/c/g?y/./x'], ['g?y/../x', bases[0], 'http://a/b/c/g?y/../x'], ['g#s/./x', bases[0], 'http://a/b/c/g#s/./x'], ['g#s/../x', bases[0], 'http://a/b/c/g#s/../x'], ['http:g', bases[0], ('http:g', 'http://a/b/c/g')], ['http:', bases[0], ('http:', bases[0])], // not sure where this one originated ['/a/b/c/./../../g', bases[0], 'http://a/a/g'], // http://gbiv.com/protocols/uri/test/rel_examples2.html // slashes in base URI's query args ['g', bases[1], 'http://a/b/c/g'], ['./g', bases[1], 'http://a/b/c/g'], ['g/', bases[1], 'http://a/b/c/g/'], ['/g', bases[1], 'http://a/g'], ['//g', bases[1], 'http://g/'], // changed in RFC 2396bis //('?y', bases[1], 'http://a/b/c/?y'], ['?y', bases[1], 'http://a/b/c/d;p?y'], ['g?y', bases[1], 'http://a/b/c/g?y'], ['g?y/./x', bases[1], 'http://a/b/c/g?y/./x'], ['g?y/../x', bases[1], 'http://a/b/c/g?y/../x'], ['g#s', bases[1], 'http://a/b/c/g#s'], ['g#s/./x', bases[1], 'http://a/b/c/g#s/./x'], ['g#s/../x', bases[1], 'http://a/b/c/g#s/../x'], ['./', bases[1], 'http://a/b/c/'], ['../', bases[1], 'http://a/b/'], ['../g', bases[1], 'http://a/b/g'], ['../../', bases[1], 'http://a/'], ['../../g', bases[1], 'http://a/g'], // http://gbiv.com/protocols/uri/test/rel_examples3.html // slashes in path params // all of these changed in RFC 2396bis ['g', bases[2], 'http://a/b/c/d;p=1/g'], ['./g', bases[2], 'http://a/b/c/d;p=1/g'], ['g/', bases[2], 'http://a/b/c/d;p=1/g/'], ['g?y', bases[2], 'http://a/b/c/d;p=1/g?y'], [';x', bases[2], 'http://a/b/c/d;p=1/;x'], ['g;x', bases[2], 'http://a/b/c/d;p=1/g;x'], ['g;x=1/./y', bases[2], 'http://a/b/c/d;p=1/g;x=1/y'], ['g;x=1/../y', bases[2], 'http://a/b/c/d;p=1/y'], ['./', bases[2], 'http://a/b/c/d;p=1/'], ['../', bases[2], 'http://a/b/c/'], ['../g', bases[2], 'http://a/b/c/g'], ['../../', bases[2], 'http://a/b/'], ['../../g', bases[2], 'http://a/b/g'], // http://gbiv.com/protocols/uri/test/rel_examples4.html // double and triple slash, unknown scheme ['g:h', bases[3], 'g:h'], ['g', bases[3], 'fred:///s//a/b/g'], ['./g', bases[3], 'fred:///s//a/b/g'], ['g/', bases[3], 'fred:///s//a/b/g/'], ['/g', bases[3], 'fred:///g'], // may change to fred:///s//a/g ['//g', bases[3], 'fred://g'], // may change to fred:///s//g ['//g/x', bases[3], 'fred://g/x'], // may change to fred:///s//g/x ['///g', bases[3], 'fred:///g'], ['./', bases[3], 'fred:///s//a/b/'], ['../', bases[3], 'fred:///s//a/'], ['../g', bases[3], 'fred:///s//a/g'], ['../../', bases[3], 'fred:///s//'], ['../../g', bases[3], 'fred:///s//g'], ['../../../g', bases[3], 'fred:///s/g'], // may change to fred:///s//a/../../../g ['../../../../g', bases[3], 'fred:///g'], // http://gbiv.com/protocols/uri/test/rel_examples5.html // double and triple slash, well-known scheme ['g:h', bases[4], 'g:h'], ['g', bases[4], 'http:///s//a/b/g'], ['./g', bases[4], 'http:///s//a/b/g'], ['g/', bases[4], 'http:///s//a/b/g/'], ['/g', bases[4], 'http:///g'], // may change to http:///s//a/g ['//g', bases[4], 'http://g/'], // may change to http:///s//g ['//g/x', bases[4], 'http://g/x'], // may change to http:///s//g/x ['///g', bases[4], 'http:///g'], ['./', bases[4], 'http:///s//a/b/'], ['../', bases[4], 'http:///s//a/'], ['../g', bases[4], 'http:///s//a/g'], ['../../', bases[4], 'http:///s//'], ['../../g', bases[4], 'http:///s//g'], // may change to http:///s//a/../../g ['../../../g', bases[4], 'http:///s/g'], // may change to http:///s//a/../../../g ['../../../../g', bases[4], 'http:///g'], // from Dan Connelly's tests in http://www.w3.org/2000/10/swap/uripath.py ['bar:abc', 'foo:xyz', 'bar:abc'], ['../abc', 'http://example/x/y/z', 'http://example/x/abc'], ['http://example/x/abc', 'http://example2/x/y/z', 'http://example/x/abc'], ['../r', 'http://ex/x/y/z', 'http://ex/x/r'], ['q/r', 'http://ex/x/y', 'http://ex/x/q/r'], ['q/r#s', 'http://ex/x/y', 'http://ex/x/q/r#s'], ['q/r#s/t', 'http://ex/x/y', 'http://ex/x/q/r#s/t'], ['ftp://ex/x/q/r', 'http://ex/x/y', 'ftp://ex/x/q/r'], ['', 'http://ex/x/y', 'http://ex/x/y'], ['', 'http://ex/x/y/', 'http://ex/x/y/'], ['', 'http://ex/x/y/pdq', 'http://ex/x/y/pdq'], ['z/', 'http://ex/x/y/', 'http://ex/x/y/z/'], ['#Animal', 'file:/swap/test/animal.rdf', 'file:/swap/test/animal.rdf#Animal'], ['../abc', 'file:/e/x/y/z', 'file:/e/x/abc'], ['/example/x/abc', 'file:/example2/x/y/z', 'file:/example/x/abc'], ['../r', 'file:/ex/x/y/z', 'file:/ex/x/r'], ['/r', 'file:/ex/x/y/z', 'file:/r'], ['q/r', 'file:/ex/x/y', 'file:/ex/x/q/r'], ['q/r#s', 'file:/ex/x/y', 'file:/ex/x/q/r#s'], ['q/r#', 'file:/ex/x/y', 'file:/ex/x/q/r#'], ['q/r#s/t', 'file:/ex/x/y', 'file:/ex/x/q/r#s/t'], ['ftp://ex/x/q/r', 'file:/ex/x/y', 'ftp://ex/x/q/r'], ['', 'file:/ex/x/y', 'file:/ex/x/y'], ['', 'file:/ex/x/y/', 'file:/ex/x/y/'], ['', 'file:/ex/x/y/pdq', 'file:/ex/x/y/pdq'], ['z/', 'file:/ex/x/y/', 'file:/ex/x/y/z/'], ['file://meetings.example.com/cal#m1', 'file:/devel/WWW/2000/10/swap/test/reluri-1.n3', 'file://meetings.example.com/cal#m1'], ['file://meetings.example.com/cal#m1', 'file:/home/connolly/w3ccvs/WWW/2000/10/swap/test/reluri-1.n3', 'file://meetings.example.com/cal#m1'], ['./#blort', 'file:/some/dir/foo', 'file:/some/dir/#blort'], ['./#', 'file:/some/dir/foo', 'file:/some/dir/#'], // Ryan Lee ['./', 'http://example/x/abc.efg', 'http://example/x/'], // Graham Klyne's tests // http://www.ninebynine.org/Software/HaskellUtils/Network/UriTest.xls // 01-31 are from Connelly's cases // 32-49 ['./q:r', 'http://ex/x/y', 'http://ex/x/q:r'], ['./p=q:r', 'http://ex/x/y', 'http://ex/x/p=q:r'], ['?pp/rr', 'http://ex/x/y?pp/qq', 'http://ex/x/y?pp/rr'], ['y/z', 'http://ex/x/y?pp/qq', 'http://ex/x/y/z'], ['local/qual@domain.org#frag', 'mailto:local', 'mailto:local/qual@domain.org#frag'], ['more/qual2@domain2.org#frag', 'mailto:local/qual1@domain1.org', 'mailto:local/more/qual2@domain2.org#frag'], ['y?q', 'http://ex/x/y?q', 'http://ex/x/y?q'], ['/x/y?q', 'http://ex?p', 'http://ex/x/y?q'], ['c/d', 'foo:a/b', 'foo:a/c/d'], ['/c/d', 'foo:a/b', 'foo:/c/d'], ['', 'foo:a/b?c#d', 'foo:a/b?c'], ['b/c', 'foo:a', 'foo:b/c'], ['../b/c', 'foo:/a/y/z', 'foo:/a/b/c'], ['./b/c', 'foo:a', 'foo:b/c'], ['/./b/c', 'foo:a', 'foo:/b/c'], ['../../d', 'foo://a//b/c', 'foo://a/d'], ['.', 'foo:a', 'foo:'], ['..', 'foo:a', 'foo:'], // 50-57[cf. TimBL comments -- // http://lists.w3.org/Archives/Public/uri/2003Feb/0028.html, // http://lists.w3.org/Archives/Public/uri/2003Jan/0008.html) ['abc', 'http://example/x/y%2Fz', 'http://example/x/abc'], ['../../x%2Fabc', 'http://example/a/x/y/z', 'http://example/a/x%2Fabc'], ['../x%2Fabc', 'http://example/a/x/y%2Fz', 'http://example/a/x%2Fabc'], ['abc', 'http://example/x%2Fy/z', 'http://example/x%2Fy/abc'], ['q%3Ar', 'http://ex/x/y', 'http://ex/x/q%3Ar'], ['/x%2Fabc', 'http://example/x/y%2Fz', 'http://example/x%2Fabc'], ['/x%2Fabc', 'http://example/x/y/z', 'http://example/x%2Fabc'], ['/x%2Fabc', 'http://example/x/y%2Fz', 'http://example/x%2Fabc'], // 70-77 ['local2@domain2', 'mailto:local1@domain1?query1', 'mailto:local2@domain2'], ['local2@domain2?query2', 'mailto:local1@domain1', 'mailto:local2@domain2?query2'], ['local2@domain2?query2', 'mailto:local1@domain1?query1', 'mailto:local2@domain2?query2'], ['?query2', 'mailto:local@domain?query1', 'mailto:local@domain?query2'], ['local@domain?query2', 'mailto:?query1', 'mailto:local@domain?query2'], ['?query2', 'mailto:local@domain?query1', 'mailto:local@domain?query2'], ['http://example/a/b?c/../d', 'foo:bar', 'http://example/a/b?c/../d'], ['http://example/a/b#c/../d', 'foo:bar', 'http://example/a/b#c/../d'], // 82-88 // @isaacs Disagree. Not how browsers do it. // ['http:this', 'http://example.org/base/uri', 'http:this'], // @isaacs Added ['http:this', 'http://example.org/base/uri', 'http://example.org/base/this'], ['http:this', 'http:base', 'http:this'], ['.//g', 'f:/a', 'f://g'], ['b/c//d/e', 'f://example.org/base/a', 'f://example.org/base/b/c//d/e'], ['m2@example.ord/c2@example.org', 'mid:m@example.ord/c@example.org', 'mid:m@example.ord/m2@example.ord/c2@example.org'], ['mini1.xml', 'file:///C:/DEV/Haskell/lib/HXmlToolbox-3.01/examples/', 'file:///C:/DEV/Haskell/lib/HXmlToolbox-3.01/examples/mini1.xml'], ['../b/c', 'foo:a/y/z', 'foo:a/b/c'], //changeing auth ['http://diff:auth@www.example.com', 'http://asdf:qwer@www.example.com', 'http://diff:auth@www.example.com/'], // changing port ['https://example.com:81/', 'https://example.com:82/', 'https://example.com:81/'] ]; relativeTests2.forEach(function(relativeTest) { const a = url.resolve(relativeTest[1], relativeTest[0]); const e = relativeTest[2]; assert.equal(a, e, 'resolve(' + [relativeTest[1], relativeTest[0]] + ') == ' + e + '\n actual=' + a); }); //if format and parse are inverse operations then //resolveObject(parse(x), y) == parse(resolve(x, y)) //format: [from, path, expected] relativeTests.forEach(function(relativeTest) { var actual = url.resolveObject(url.parse(relativeTest[0]), relativeTest[1]); var expected = url.parse(relativeTest[2]); assert.deepEqual(actual, expected); expected = relativeTest[2]; actual = url.format(actual); assert.equal(actual, expected, 'format(' + actual + ') == ' + expected + '\nactual:' + actual); }); //format: [to, from, result] // the test: ['.//g', 'f:/a', 'f://g'] is a fundamental problem // url.parse('f:/a') does not have a host // url.resolve('f:/a', './/g') does not have a host because you have moved // down to the g directory. i.e. f: //g, however when this url is parsed // f:// will indicate that the host is g which is not the case. // it is unclear to me how to keep this information from being lost // it may be that a pathname of ////g should collapse to /g but this seems // to be a lot of work for an edge case. Right now I remove the test if (relativeTests2[181][0] === './/g' && relativeTests2[181][1] === 'f:/a' && relativeTests2[181][2] === 'f://g') { relativeTests2.splice(181, 1); } relativeTests2.forEach(function(relativeTest) { var actual = url.resolveObject(url.parse(relativeTest[1]), relativeTest[0]); var expected = url.parse(relativeTest[2]); assert.deepEqual(actual, expected); expected = relativeTest[2]; actual = url.format(actual); assert.equal(actual, expected, 'format(' + relativeTest[1] + ') == ' + expected + '\nactual:' + actual); }); // https://github.com/nodejs/node/pull/1036 var throws = [ undefined, null, true, false, 0, function() {} ]; for (let i = 0; i < throws.length; i++) { assert.throws(function() { url.format(throws[i]); }, TypeError); } assert(url.format('') === ''); assert(url.format({}) === ''); node-v4.8.2/test/parallel/test-utf8-scripts.js000644 000766 000024 00000000316 13070706737 021423 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); // üäö console.log('Σὲ γνωρίζω ἀπὸ τὴν κόψη'); assert.equal(true, /Hellö Wörld/.test('Hellö Wörld')); node-v4.8.2/test/parallel/test-util-decorate-error-stack.js000644 000766 000024 00000001714 13070706737 024046 0ustar00iojsstaff000000 000000 // Flags: --expose_internals 'use strict'; require('../common'); const assert = require('assert'); const internalUtil = require('internal/util'); assert.doesNotThrow(function() { internalUtil.decorateErrorStack(); internalUtil.decorateErrorStack(null); internalUtil.decorateErrorStack(1); internalUtil.decorateErrorStack(true); }); // Verify that a stack property is not added to non-Errors const obj = {}; internalUtil.decorateErrorStack(obj); assert.strictEqual(obj.stack, undefined); // Verify that the stack is decorated when possible let err; try { require('../fixtures/syntax/bad_syntax'); } catch (e) { err = e; assert(!/var foo bar;/.test(err.stack)); internalUtil.decorateErrorStack(err); } assert(/var foo bar;/.test(err.stack)); // Verify that the stack is unchanged when there is no arrow message err = new Error('foo'); const originalStack = err.stack; internalUtil.decorateErrorStack(err); assert.strictEqual(originalStack, err.stack); node-v4.8.2/test/parallel/test-util-format.js000644 000766 000024 00000006066 13070706737 021323 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var util = require('util'); var symbol = Symbol('foo'); assert.strictEqual(util.format(), ''); assert.strictEqual(util.format(''), ''); assert.strictEqual(util.format([]), '[]'); assert.strictEqual(util.format([0]), '[ 0 ]'); assert.strictEqual(util.format({}), '{}'); assert.strictEqual(util.format({foo: 42}), '{ foo: 42 }'); assert.strictEqual(util.format(null), 'null'); assert.strictEqual(util.format(true), 'true'); assert.strictEqual(util.format(false), 'false'); assert.strictEqual(util.format('test'), 'test'); // CHECKME this is for console.log() compatibility - but is it *right*? assert.strictEqual(util.format('foo', 'bar', 'baz'), 'foo bar baz'); // ES6 Symbol handling assert.strictEqual(util.format(symbol), 'Symbol(foo)'); assert.strictEqual(util.format('foo', symbol), 'foo Symbol(foo)'); assert.strictEqual(util.format('%s', symbol), 'Symbol(foo)'); assert.strictEqual(util.format('%j', symbol), 'undefined'); assert.throws(function() { util.format('%d', symbol); }, TypeError); assert.strictEqual(util.format('%d', 42.0), '42'); assert.strictEqual(util.format('%d', 42), '42'); assert.strictEqual(util.format('%s', 42), '42'); assert.strictEqual(util.format('%j', 42), '42'); assert.strictEqual(util.format('%d', '42.0'), '42'); assert.strictEqual(util.format('%d', '42'), '42'); assert.strictEqual(util.format('%s', '42'), '42'); assert.strictEqual(util.format('%j', '42'), '"42"'); assert.strictEqual(util.format('%%s%s', 'foo'), '%sfoo'); assert.strictEqual(util.format('%s'), '%s'); assert.strictEqual(util.format('%s', undefined), 'undefined'); assert.strictEqual(util.format('%s', 'foo'), 'foo'); assert.strictEqual(util.format('%s:%s'), '%s:%s'); assert.strictEqual(util.format('%s:%s', undefined), 'undefined:%s'); assert.strictEqual(util.format('%s:%s', 'foo'), 'foo:%s'); assert.strictEqual(util.format('%s:%s', 'foo', 'bar'), 'foo:bar'); assert.strictEqual(util.format('%s:%s', 'foo', 'bar', 'baz'), 'foo:bar baz'); assert.strictEqual(util.format('%%%s%%', 'hi'), '%hi%'); assert.strictEqual(util.format('%%%s%%%%', 'hi'), '%hi%%'); assert.strictEqual(util.format('%sbc%%def', 'a'), 'abc%def'); assert.strictEqual(util.format('%d:%d', 12, 30), '12:30'); assert.strictEqual(util.format('%d:%d', 12), '12:%d'); assert.strictEqual(util.format('%d:%d'), '%d:%d'); assert.strictEqual(util.format('o: %j, a: %j', {}, []), 'o: {}, a: []'); assert.strictEqual(util.format('o: %j, a: %j', {}), 'o: {}, a: %j'); assert.strictEqual(util.format('o: %j, a: %j'), 'o: %j, a: %j'); (function() { var o = {}; o.o = o; assert.strictEqual(util.format('%j', o), '[Circular]'); })(); // Errors assert.equal(util.format(new Error('foo')), '[Error: foo]'); function CustomError(msg) { Error.call(this); Object.defineProperty(this, 'message', { value: msg, enumerable: false }); Object.defineProperty(this, 'name', { value: 'CustomError', enumerable: false }); } util.inherits(CustomError, Error); assert.strictEqual(util.format(new CustomError('bar')), '[CustomError: bar]'); node-v4.8.2/test/parallel/test-util-inherits.js000644 000766 000024 00000002125 13070706737 021650 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const inherits = require('util').inherits; // super constructor function A() { this._a = 'a'; } A.prototype.a = function() { return this._a; }; // one level of inheritance function B(value) { A.call(this); this._b = value; } inherits(B, A); B.prototype.b = function() { return this._b; }; assert.strictEqual(B.super_, A); const b = new B('b'); assert.strictEqual(b.a(), 'a'); assert.strictEqual(b.b(), 'b'); assert.strictEqual(b.constructor, B); // two levels of inheritance function C() { B.call(this, 'b'); this._c = 'c'; } inherits(C, B); C.prototype.c = function() { return this._c; }; C.prototype.getValue = function() { return this.a() + this.b() + this.c(); }; assert.strictEqual(C.super_, B); const c = new C(); assert.strictEqual(c.getValue(), 'abc'); assert.strictEqual(c.constructor, C); // should throw with invalid arguments assert.throws(function() { inherits(A, {}); }, TypeError); assert.throws(function() { inherits(A, null); }, TypeError); assert.throws(function() { inherits(null, A); }, TypeError); node-v4.8.2/test/parallel/test-util-inspect.js000644 000766 000024 00000041523 13070706737 021475 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var util = require('util'); assert.equal(util.inspect(1), '1'); assert.equal(util.inspect(false), 'false'); assert.equal(util.inspect(''), "''"); assert.equal(util.inspect('hello'), "'hello'"); assert.equal(util.inspect(function() {}), '[Function]'); assert.equal(util.inspect(undefined), 'undefined'); assert.equal(util.inspect(null), 'null'); assert.equal(util.inspect(/foo(bar\n)?/gi), '/foo(bar\\n)?/gi'); assert.equal(util.inspect(new Date('Sun, 14 Feb 2010 11:48:40 GMT')), new Date('2010-02-14T12:48:40+01:00').toString()); assert.equal(util.inspect('\n\u0001'), "'\\n\\u0001'"); assert.equal(util.inspect([]), '[]'); assert.equal(util.inspect(Object.create([])), 'Array {}'); assert.equal(util.inspect([1, 2]), '[ 1, 2 ]'); assert.equal(util.inspect([1, [2, 3]]), '[ 1, [ 2, 3 ] ]'); assert.equal(util.inspect({}), '{}'); assert.equal(util.inspect({a: 1}), '{ a: 1 }'); assert.equal(util.inspect({a: function() {}}), '{ a: [Function] }'); assert.equal(util.inspect({a: 1, b: 2}), '{ a: 1, b: 2 }'); assert.equal(util.inspect({'a': {}}), '{ a: {} }'); assert.equal(util.inspect({'a': {'b': 2}}), '{ a: { b: 2 } }'); assert.equal(util.inspect({'a': {'b': { 'c': { 'd': 2 }}}}), '{ a: { b: { c: [Object] } } }'); assert.equal(util.inspect({'a': {'b': { 'c': { 'd': 2 }}}}, false, null), '{ a: { b: { c: { d: 2 } } } }'); assert.equal(util.inspect([1, 2, 3], true), '[ 1, 2, 3, [length]: 3 ]'); assert.equal(util.inspect({'a': {'b': { 'c': 2}}}, false, 0), '{ a: [Object] }'); assert.equal(util.inspect({'a': {'b': { 'c': 2}}}, false, 1), '{ a: { b: [Object] } }'); assert.equal(util.inspect(Object.create({}, {visible: {value: 1, enumerable: true}, hidden: {value: 2}})), '{ visible: 1 }' ); { const regexp = /regexp/; regexp.aprop = 42; assert.strictEqual(util.inspect({a: regexp}, false, 0), '{ a: /regexp/ }'); } // Due to the hash seed randomization it's not deterministic the order that // the following ways this hash is displayed. // See http://codereview.chromium.org/9124004/ { const out = util.inspect(Object.create({}, {visible: {value: 1, enumerable: true}, hidden: {value: 2}}), true); if (out !== '{ [hidden]: 2, visible: 1 }' && out !== '{ visible: 1, [hidden]: 2 }') { assert.ok(false); } } // Objects without prototype { const out = util.inspect(Object.create(null, { name: {value: 'Tim', enumerable: true}, hidden: {value: 'secret'}}), true); if (out !== "{ [hidden]: 'secret', name: 'Tim' }" && out !== "{ name: 'Tim', [hidden]: 'secret' }") { assert(false); } } assert.equal( util.inspect(Object.create(null, {name: {value: 'Tim', enumerable: true}, hidden: {value: 'secret'}})), '{ name: \'Tim\' }' ); // Dynamic properties assert.equal(util.inspect({get readonly() {}}), '{ readonly: [Getter] }'); assert.equal(util.inspect({get readwrite() {}, set readwrite(val) {}}), '{ readwrite: [Getter/Setter] }'); assert.equal(util.inspect({set writeonly(val) {}}), '{ writeonly: [Setter] }'); var value = {}; value['a'] = value; assert.equal(util.inspect(value), '{ a: [Circular] }'); // Array with dynamic properties value = [1, 2, 3]; value.__defineGetter__('growingLength', function() { this.push(true); return this.length; }); assert.equal(util.inspect(value), '[ 1, 2, 3, growingLength: [Getter] ]'); // Function with properties value = function() {}; value.aprop = 42; assert.equal(util.inspect(value), '{ [Function] aprop: 42 }'); // Anonymous function with properties value = (() => function() {})(); value.aprop = 42; assert.strictEqual(util.inspect(value), '{ [Function] aprop: 42 }'); // Regular expressions with properties value = /123/ig; value.aprop = 42; assert.equal(util.inspect(value), '{ /123/gi aprop: 42 }'); // Dates with properties value = new Date('Sun, 14 Feb 2010 11:48:40 GMT'); value.aprop = 42; assert.equal(util.inspect(value), '{ Sun, 14 Feb 2010 11:48:40 GMT aprop: 42 }' ); // test the internal isDate implementation var Date2 = require('vm').runInNewContext('Date'); var d = new Date2(); var orig = util.inspect(d); Date2.prototype.foo = 'bar'; var after = util.inspect(d); assert.equal(orig, after); // test positive/negative zero assert.equal(util.inspect(0), '0'); assert.equal(util.inspect(-0), '-0'); // test for sparse array var a = ['foo', 'bar', 'baz']; assert.equal(util.inspect(a), '[ \'foo\', \'bar\', \'baz\' ]'); delete a[1]; assert.equal(util.inspect(a), '[ \'foo\', , \'baz\' ]'); assert.equal(util.inspect(a, true), '[ \'foo\', , \'baz\', [length]: 3 ]'); assert.equal(util.inspect(new Array(5)), '[ , , , , ]'); // test for Array constructor in different context { const Debug = require('vm').runInDebugContext('Debug'); const map = new Map(); map.set(1, 2); const mirror = Debug.MakeMirror(map.entries(), true); const vals = mirror.preview(); const valsOutput = []; for (const o of vals) { valsOutput.push(o); } assert.strictEqual(util.inspect(valsOutput), '[ [ 1, 2 ] ]'); } // test for other constructors in different context var obj = require('vm').runInNewContext('(function(){return {}})()', {}); assert.strictEqual(util.inspect(obj), '{}'); obj = require('vm').runInNewContext('var m=new Map();m.set(1,2);m', {}); assert.strictEqual(util.inspect(obj), 'Map { 1 => 2 }'); obj = require('vm').runInNewContext('var s=new Set();s.add(1);s.add(2);s', {}); assert.strictEqual(util.inspect(obj), 'Set { 1, 2 }'); obj = require('vm').runInNewContext('fn=function(){};new Promise(fn,fn)', {}); assert.strictEqual(util.inspect(obj), 'Promise { }'); // test for property descriptors var getter = Object.create(null, { a: { get: function() { return 'aaa'; } } }); var setter = Object.create(null, { b: { set: function() {} } }); var getterAndSetter = Object.create(null, { c: { get: function() { return 'ccc'; }, set: function() {} } }); assert.equal(util.inspect(getter, true), '{ [a]: [Getter] }'); assert.equal(util.inspect(setter, true), '{ [b]: [Setter] }'); assert.equal(util.inspect(getterAndSetter, true), '{ [c]: [Getter/Setter] }'); // exceptions should print the error message, not '{}' assert.equal(util.inspect(new Error()), '[Error]'); assert.equal(util.inspect(new Error('FAIL')), '[Error: FAIL]'); assert.equal(util.inspect(new TypeError('FAIL')), '[TypeError: FAIL]'); assert.equal(util.inspect(new SyntaxError('FAIL')), '[SyntaxError: FAIL]'); try { undef(); // eslint-disable-line no-undef } catch (e) { assert.equal(util.inspect(e), '[ReferenceError: undef is not defined]'); } var ex = util.inspect(new Error('FAIL'), true); assert.ok(ex.indexOf('[Error: FAIL]') != -1); assert.ok(ex.indexOf('[stack]') != -1); assert.ok(ex.indexOf('[message]') != -1); // GH-1941 // should not throw: assert.equal(util.inspect(Object.create(Date.prototype)), 'Date {}'); // GH-1944 assert.doesNotThrow(function() { var d = new Date(); d.toUTCString = null; util.inspect(d); }); assert.doesNotThrow(function() { var r = /regexp/; r.toString = null; util.inspect(r); }); // bug with user-supplied inspect function returns non-string assert.doesNotThrow(function() { util.inspect([{ inspect: function() { return 123; } }]); }); // GH-2225 { const x = { inspect: util.inspect }; assert.ok(util.inspect(x).indexOf('inspect') != -1); } // util.inspect should not display the escaped value of a key. var w = { '\\': 1, '\\\\': 2, '\\\\\\': 3, '\\\\\\\\': 4, }; var y = ['a', 'b', 'c']; y['\\\\\\'] = 'd'; assert.ok(util.inspect(w), '{ \'\\\': 1, \'\\\\\': 2, \'\\\\\\\': 3, \'\\\\\\\\\': 4 }'); assert.ok(util.inspect(y), '[ \'a\', \'b\', \'c\', \'\\\\\\\': \'d\' ]'); // util.inspect.styles and util.inspect.colors function test_color_style(style, input, implicit) { var color_name = util.inspect.styles[style]; var color = ['', '']; if (util.inspect.colors[color_name]) color = util.inspect.colors[color_name]; var without_color = util.inspect(input, false, 0, false); var with_color = util.inspect(input, false, 0, true); var expect = '\u001b[' + color[0] + 'm' + without_color + '\u001b[' + color[1] + 'm'; assert.equal(with_color, expect, 'util.inspect color for style ' + style); } test_color_style('special', function() {}); test_color_style('number', 123.456); test_color_style('boolean', true); test_color_style('undefined', undefined); test_color_style('null', null); test_color_style('string', 'test string'); test_color_style('date', new Date()); test_color_style('regexp', /regexp/); // an object with "hasOwnProperty" overwritten should not throw assert.doesNotThrow(function() { util.inspect({ hasOwnProperty: null }); }); // new API, accepts an "options" object { let subject = { foo: 'bar', hello: 31, a: { b: { c: { d: 0 } } } }; Object.defineProperty(subject, 'hidden', { enumerable: false, value: null }); assert(util.inspect(subject, { showHidden: false }).indexOf('hidden') === -1); assert(util.inspect(subject, { showHidden: true }).indexOf('hidden') !== -1); assert(util.inspect(subject, { colors: false }).indexOf('\u001b[32m') === -1); assert(util.inspect(subject, { colors: true }).indexOf('\u001b[32m') !== -1); assert(util.inspect(subject, { depth: 2 }).indexOf('c: [Object]') !== -1); assert(util.inspect(subject, { depth: 0 }).indexOf('a: [Object]') !== -1); assert(util.inspect(subject, { depth: null }).indexOf('{ d: 0 }') !== -1); // "customInspect" option can enable/disable calling inspect() on objects subject = { inspect: function() { return 123; } }; assert(util.inspect(subject, { customInspect: true }).indexOf('123') !== -1); assert(util.inspect(subject, { customInspect: true }).indexOf('inspect') === -1); assert(util.inspect(subject, { customInspect: false }).indexOf('123') === -1); assert(util.inspect(subject, { customInspect: false }).indexOf('inspect') !== -1); // custom inspect() functions should be able to return other Objects subject.inspect = function() { return { foo: 'bar' }; }; assert.equal(util.inspect(subject), '{ foo: \'bar\' }'); subject.inspect = function(depth, opts) { assert.strictEqual(opts.customInspectOptions, true); }; util.inspect(subject, { customInspectOptions: true }); } // util.inspect with "colors" option should produce as many lines as without it function test_lines(input) { var count_lines = function(str) { return (str.match(/\n/g) || []).length; }; var without_color = util.inspect(input); var with_color = util.inspect(input, {colors: true}); assert.equal(count_lines(without_color), count_lines(with_color)); } test_lines([1, 2, 3, 4, 5, 6, 7]); test_lines(function() { var big_array = []; for (var i = 0; i < 100; i++) { big_array.push(i); } return big_array; }()); test_lines({foo: 'bar', baz: 35, b: {a: 35}}); test_lines({ foo: 'bar', baz: 35, b: {a: 35}, very_long_key: 'very_long_value', even_longer_key: ['with even longer value in array'] }); // test boxed primitives output the correct values assert.equal(util.inspect(new String('test')), '[String: \'test\']'); assert.equal(util.inspect(Object(Symbol('test'))), '[Symbol: Symbol(test)]'); assert.equal(util.inspect(new Boolean(false)), '[Boolean: false]'); assert.equal(util.inspect(new Boolean(true)), '[Boolean: true]'); assert.equal(util.inspect(new Number(0)), '[Number: 0]'); assert.equal(util.inspect(new Number(-0)), '[Number: -0]'); assert.equal(util.inspect(new Number(-1.1)), '[Number: -1.1]'); assert.equal(util.inspect(new Number(13.37)), '[Number: 13.37]'); // test boxed primitives with own properties var str = new String('baz'); str.foo = 'bar'; assert.equal(util.inspect(str), '{ [String: \'baz\'] foo: \'bar\' }'); var bool = new Boolean(true); bool.foo = 'bar'; assert.equal(util.inspect(bool), '{ [Boolean: true] foo: \'bar\' }'); var num = new Number(13.37); num.foo = 'bar'; assert.equal(util.inspect(num), '{ [Number: 13.37] foo: \'bar\' }'); // test es6 Symbol if (typeof Symbol !== 'undefined') { assert.equal(util.inspect(Symbol()), 'Symbol()'); assert.equal(util.inspect(Symbol(123)), 'Symbol(123)'); assert.equal(util.inspect(Symbol('hi')), 'Symbol(hi)'); assert.equal(util.inspect([Symbol()]), '[ Symbol() ]'); assert.equal(util.inspect({ foo: Symbol() }), '{ foo: Symbol() }'); const options = { showHidden: true }; let subject = {}; subject[Symbol('symbol')] = 42; assert.equal(util.inspect(subject), '{}'); assert.equal(util.inspect(subject, options), '{ [Symbol(symbol)]: 42 }'); subject = [1, 2, 3]; subject[Symbol('symbol')] = 42; assert.equal(util.inspect(subject), '[ 1, 2, 3 ]'); assert.equal(util.inspect(subject, options), '[ 1, 2, 3, [length]: 3, [Symbol(symbol)]: 42 ]'); } // test Set assert.equal(util.inspect(new Set()), 'Set {}'); assert.equal(util.inspect(new Set([1, 2, 3])), 'Set { 1, 2, 3 }'); var set = new Set(['foo']); set.bar = 42; assert.equal(util.inspect(set, true), 'Set { \'foo\', [size]: 1, bar: 42 }'); // test Map { assert.equal(util.inspect(new Map()), 'Map {}'); assert.equal(util.inspect(new Map([[1, 'a'], [2, 'b'], [3, 'c']])), 'Map { 1 => \'a\', 2 => \'b\', 3 => \'c\' }'); const map = new Map([['foo', null]]); map.bar = 42; assert.equal(util.inspect(map, true), 'Map { \'foo\' => null, [size]: 1, bar: 42 }'); } // test Promise assert.equal(util.inspect(Promise.resolve(3)), 'Promise { 3 }'); assert.equal(util.inspect(Promise.reject(3)), 'Promise { 3 }'); assert.equal(util.inspect(new Promise(function() {})), 'Promise { }'); var promise = Promise.resolve('foo'); promise.bar = 42; assert.equal(util.inspect(promise), 'Promise { \'foo\', bar: 42 }'); // Make sure it doesn't choke on polyfills. Unlike Set/Map, there is no standard // interface to synchronously inspect a Promise, so our techniques only work on // a bonafide native Promise. var oldPromise = Promise; global.Promise = function() { this.bar = 42; }; assert.equal(util.inspect(new Promise()), '{ bar: 42 }'); global.Promise = oldPromise; // Map/Set Iterators var m = new Map([['foo', 'bar']]); assert.strictEqual(util.inspect(m.keys()), 'MapIterator { \'foo\' }'); assert.strictEqual(util.inspect(m.values()), 'MapIterator { \'bar\' }'); assert.strictEqual(util.inspect(m.entries()), 'MapIterator { [ \'foo\', \'bar\' ] }'); // make sure the iterator doesn't get consumed var keys = m.keys(); assert.strictEqual(util.inspect(keys), 'MapIterator { \'foo\' }'); assert.strictEqual(util.inspect(keys), 'MapIterator { \'foo\' }'); var s = new Set([1, 3]); assert.strictEqual(util.inspect(s.keys()), 'SetIterator { 1, 3 }'); assert.strictEqual(util.inspect(s.values()), 'SetIterator { 1, 3 }'); assert.strictEqual(util.inspect(s.entries()), 'SetIterator { [ 1, 1 ], [ 3, 3 ] }'); // make sure the iterator doesn't get consumed keys = s.keys(); assert.strictEqual(util.inspect(keys), 'SetIterator { 1, 3 }'); assert.strictEqual(util.inspect(keys), 'SetIterator { 1, 3 }'); // Test alignment of items in container // Assumes that the first numeric character is the start of an item. function checkAlignment(container) { var lines = util.inspect(container).split('\n'); var pos; lines.forEach(function(line) { var npos = line.search(/\d/); if (npos !== -1) { if (pos !== undefined) assert.equal(pos, npos, 'container items not aligned'); pos = npos; } }); } var big_array = []; for (var i = 0; i < 100; i++) { big_array.push(i); } checkAlignment(big_array); checkAlignment(function() { var obj = {}; big_array.forEach(function(v) { obj[v] = null; }); return obj; }()); checkAlignment(new Set(big_array)); checkAlignment(new Map(big_array.map(function(y) { return [y, null]; }))); // Test display of constructors { class ObjectSubclass {} class ArraySubclass extends Array {} class SetSubclass extends Set {} class MapSubclass extends Map {} class PromiseSubclass extends Promise {} const x = new ObjectSubclass(); x.foo = 42; assert.equal(util.inspect(x), 'ObjectSubclass { foo: 42 }'); assert.equal(util.inspect(new ArraySubclass(1, 2, 3)), 'ArraySubclass [ 1, 2, 3 ]'); assert.equal(util.inspect(new SetSubclass([1, 2, 3])), 'SetSubclass { 1, 2, 3 }'); assert.equal(util.inspect(new MapSubclass([['foo', 42]])), 'MapSubclass { \'foo\' => 42 }'); assert.equal(util.inspect(new PromiseSubclass(function() {})), 'PromiseSubclass { }'); } // Corner cases. { const x = { constructor: 42 }; assert.equal(util.inspect(x), '{ constructor: 42 }'); } { const x = {}; Object.defineProperty(x, 'constructor', { get: function() { throw new Error('should not access constructor'); }, enumerable: true }); assert.equal(util.inspect(x), '{ constructor: [Getter] }'); } { const x = new function() {}; assert.equal(util.inspect(x), '{}'); } { const x = Object.create(null); assert.strictEqual(util.inspect(x), '{}'); } node-v4.8.2/test/parallel/test-util-internal.js000644 000766 000024 00000002146 13070706737 021642 0ustar00iojsstaff000000 000000 'use strict'; // Flags: --expose_internals const common = require('../common'); const path = require('path'); const assert = require('assert'); const internalUtil = require('internal/util'); function getHiddenValue(obj, name) { return function() { internalUtil.getHiddenValue(obj, name); }; } assert.throws(getHiddenValue(), /obj must be an object/); assert.throws(getHiddenValue(null, 'foo'), /obj must be an object/); assert.throws(getHiddenValue(undefined, 'foo'), /obj must be an object/); assert.throws(getHiddenValue('bar', 'foo'), /obj must be an object/); assert.throws(getHiddenValue(85, 'foo'), /obj must be an object/); assert.throws(getHiddenValue({}), /name must be a string/); assert.throws(getHiddenValue({}, null), /name must be a string/); assert.throws(getHiddenValue({}, []), /name must be a string/); assert.deepEqual(internalUtil.getHiddenValue({}, 'foo'), undefined); let arrowMessage; try { require(path.join(common.fixturesDir, 'syntax', 'bad_syntax')); } catch (err) { arrowMessage = internalUtil.getHiddenValue(err, 'arrowMessage'); } assert(/bad_syntax\.js:1/.test(arrowMessage)); node-v4.8.2/test/parallel/test-util-log.js000644 000766 000024 00000002057 13070706737 020610 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var util = require('util'); assert.ok(process.stdout.writable); assert.ok(process.stderr.writable); var stdout_write = global.process.stdout.write; var strings = []; global.process.stdout.write = function(string) { strings.push(string); }; console._stderr = process.stdout; var tests = [ {input: 'foo', output: 'foo'}, {input: undefined, output: 'undefined'}, {input: null, output: 'null'}, {input: false, output: 'false'}, {input: 42, output: '42'}, {input: function() {}, output: '[Function]'}, {input: parseInt('not a number', 10), output: 'NaN'}, {input: {answer: 42}, output: '{ answer: 42 }'}, {input: [1, 2, 3], output: '[ 1, 2, 3 ]'} ]; // test util.log() tests.forEach(function(test) { util.log(test.input); const result = strings.shift().trim(); const re = (/[0-9]{1,2} [A-Z][a-z]{2} [0-9]{2}:[0-9]{2}:[0-9]{2} - (.+)$/); const match = re.exec(result); assert.ok(match); assert.equal(match[1], test.output); }); global.process.stdout.write = stdout_write; node-v4.8.2/test/parallel/test-util.js000644 000766 000024 00000011416 13070706737 020030 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const util = require('util'); const context = require('vm').runInNewContext; // isArray assert.equal(true, util.isArray([])); assert.equal(true, util.isArray(Array())); assert.equal(true, util.isArray(new Array())); assert.equal(true, util.isArray(new Array(5))); assert.equal(true, util.isArray(new Array('with', 'some', 'entries'))); assert.equal(true, util.isArray(context('Array')())); assert.equal(false, util.isArray({})); assert.equal(false, util.isArray({ push: function() {} })); assert.equal(false, util.isArray(/regexp/)); assert.equal(false, util.isArray(new Error())); assert.equal(false, util.isArray(Object.create(Array.prototype))); // isRegExp assert.equal(true, util.isRegExp(/regexp/)); assert.equal(true, util.isRegExp(RegExp())); assert.equal(true, util.isRegExp(new RegExp())); assert.equal(true, util.isRegExp(context('RegExp')())); assert.equal(false, util.isRegExp({})); assert.equal(false, util.isRegExp([])); assert.equal(false, util.isRegExp(new Date())); assert.equal(false, util.isRegExp(Object.create(RegExp.prototype))); // isDate assert.equal(true, util.isDate(new Date())); assert.equal(true, util.isDate(new Date(0))); assert.equal(true, util.isDate(new (context('Date')))); assert.equal(false, util.isDate(Date())); assert.equal(false, util.isDate({})); assert.equal(false, util.isDate([])); assert.equal(false, util.isDate(new Error())); assert.equal(false, util.isDate(Object.create(Date.prototype))); // isError assert.equal(true, util.isError(new Error())); assert.equal(true, util.isError(new TypeError())); assert.equal(true, util.isError(new SyntaxError())); assert.equal(true, util.isError(new (context('Error')))); assert.equal(true, util.isError(new (context('TypeError')))); assert.equal(true, util.isError(new (context('SyntaxError')))); assert.equal(false, util.isError({})); assert.equal(false, util.isError({ name: 'Error', message: '' })); assert.equal(false, util.isError([])); assert.equal(true, util.isError(Object.create(Error.prototype))); // isObject assert.ok(util.isObject({}) === true); // isPrimitive assert.equal(false, util.isPrimitive({})); assert.equal(false, util.isPrimitive(new Error())); assert.equal(false, util.isPrimitive(new Date())); assert.equal(false, util.isPrimitive([])); assert.equal(false, util.isPrimitive(/regexp/)); assert.equal(false, util.isPrimitive(function() {})); assert.equal(false, util.isPrimitive(new Number(1))); assert.equal(false, util.isPrimitive(new String('bla'))); assert.equal(false, util.isPrimitive(new Boolean(true))); assert.equal(true, util.isPrimitive(1)); assert.equal(true, util.isPrimitive('bla')); assert.equal(true, util.isPrimitive(true)); assert.equal(true, util.isPrimitive(undefined)); assert.equal(true, util.isPrimitive(null)); assert.equal(true, util.isPrimitive(Infinity)); assert.equal(true, util.isPrimitive(NaN)); assert.equal(true, util.isPrimitive(Symbol('symbol'))); // isBuffer assert.equal(false, util.isBuffer('foo')); assert.equal(true, util.isBuffer(new Buffer('foo'))); // _extend assert.deepStrictEqual(util._extend({a: 1}), {a: 1}); assert.deepStrictEqual(util._extend({a: 1}, []), {a: 1}); assert.deepStrictEqual(util._extend({a: 1}, null), {a: 1}); assert.deepStrictEqual(util._extend({a: 1}, true), {a: 1}); assert.deepStrictEqual(util._extend({a: 1}, false), {a: 1}); assert.deepStrictEqual(util._extend({a: 1}, {b: 2}), {a: 1, b: 2}); assert.deepStrictEqual(util._extend({a: 1, b: 2}, {b: 3}), {a: 1, b: 3}); // deprecated assert.strictEqual(util.isBoolean(true), true); assert.strictEqual(util.isBoolean(false), true); assert.strictEqual(util.isBoolean('string'), false); assert.strictEqual(util.isNull(null), true); assert.strictEqual(util.isNull(), false); assert.strictEqual(util.isNull('string'), false); assert.strictEqual(util.isUndefined(), true); assert.strictEqual(util.isUndefined(null), false); assert.strictEqual(util.isUndefined('string'), false); assert.strictEqual(util.isNullOrUndefined(null), true); assert.strictEqual(util.isNullOrUndefined(), true); assert.strictEqual(util.isNullOrUndefined('string'), false); assert.strictEqual(util.isNumber(42), true); assert.strictEqual(util.isNumber(), false); assert.strictEqual(util.isNumber('string'), false); assert.strictEqual(util.isString('string'), true); assert.strictEqual(util.isString(), false); assert.strictEqual(util.isString(42), false); assert.strictEqual(util.isSymbol(Symbol()), true); assert.strictEqual(util.isSymbol(), false); assert.strictEqual(util.isSymbol('string'), false); assert.strictEqual(util.isFunction(() => {}), true); assert.strictEqual(util.isFunction(function() {}), true); assert.strictEqual(util.isFunction(), false); assert.strictEqual(util.isFunction('string'), false); util.print('test'); util.puts('test'); util.debug('test'); util.error('test'); node-v4.8.2/test/parallel/test-v8-flag-type-check.js000644 000766 000024 00000000340 13070706737 022343 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var v8 = require('v8'); assert.throws(function() {v8.setFlagsFromString(1);}, TypeError); assert.throws(function() {v8.setFlagsFromString();}, TypeError); node-v4.8.2/test/parallel/test-v8-flags.js000644 000766 000024 00000000664 13070706737 020505 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var v8 = require('v8'); var vm = require('vm'); v8.setFlagsFromString('--allow_natives_syntax'); assert(eval('%_IsSmi(42)')); assert(vm.runInThisContext('%_IsSmi(42)')); v8.setFlagsFromString('--noallow_natives_syntax'); assert.throws(function() { eval('%_IsSmi(42)'); }, SyntaxError); assert.throws(function() { vm.runInThisContext('%_IsSmi(42)'); }, SyntaxError); node-v4.8.2/test/parallel/test-v8-stats.js000644 000766 000024 00000002123 13070706737 020537 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var v8 = require('v8'); var s = v8.getHeapStatistics(); var keys = [ 'heap_size_limit', 'total_available_size', 'total_heap_size', 'total_heap_size_executable', 'total_physical_size', 'used_heap_size']; assert.deepEqual(Object.keys(s).sort(), keys); keys.forEach(function(key) { assert.equal(typeof s[key], 'number'); }); const expectedHeapSpaces = [ 'new_space', 'old_space', 'code_space', 'map_space', 'large_object_space' ]; const heapSpaceStatistics = v8.getHeapSpaceStatistics(); const actualHeapSpaceNames = heapSpaceStatistics.map((s) => s.space_name); assert.deepEqual(actualHeapSpaceNames.sort(), expectedHeapSpaces.sort()); heapSpaceStatistics.forEach((heapSpace) => { assert.strictEqual(typeof heapSpace.space_name, 'string'); assert.strictEqual(typeof heapSpace.space_size, 'number'); assert.strictEqual(typeof heapSpace.space_used_size, 'number'); assert.strictEqual(typeof heapSpace.space_available_size, 'number'); assert.strictEqual(typeof heapSpace.physical_space_size, 'number'); }); node-v4.8.2/test/parallel/test-vm-basic.js000644 000766 000024 00000002374 13070706737 020557 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var vm = require('vm'); // Test 1: vm.runInNewContext var sandbox = {}; var result = vm.runInNewContext( 'foo = "bar"; this.typeofProcess = typeof process; typeof Object;', sandbox ); assert.deepEqual(sandbox, { foo: 'bar', typeofProcess: 'undefined', }); assert.strictEqual(result, 'function'); // Test 2: vm.runInContext var sandbox2 = { foo: 'bar' }; var context = vm.createContext(sandbox2); result = vm.runInContext( 'baz = foo; this.typeofProcess = typeof process; typeof Object;', context ); assert.deepEqual(sandbox2, { foo: 'bar', baz: 'bar', typeofProcess: 'undefined' }); assert.strictEqual(result, 'function'); // Test 3: vm.runInThisContext result = vm.runInThisContext( 'vmResult = "foo"; Object.prototype.toString.call(process);' ); assert.strictEqual(global.vmResult, 'foo'); assert.strictEqual(result, '[object process]'); delete global.vmResult; // Test 4: vm.runInNewContext result = vm.runInNewContext( 'vmResult = "foo"; typeof process;' ); assert.strictEqual(global.vmResult, undefined); assert.strictEqual(result, 'undefined'); // Test 5: vm.createContext var sandbox3 = {}; var context2 = vm.createContext(sandbox3); assert.strictEqual(sandbox3, context2); node-v4.8.2/test/parallel/test-vm-context-async-script.js000644 000766 000024 00000000520 13070706737 023566 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var vm = require('vm'); var sandbox = { setTimeout: setTimeout }; var ctx = vm.createContext(sandbox); vm.runInContext('setTimeout(function() { x = 3; }, 0);', ctx); setTimeout(function() { assert.strictEqual(sandbox.x, 3); assert.strictEqual(ctx.x, 3); }, 1); node-v4.8.2/test/parallel/test-vm-context-property-forwarding.js000644 000766 000024 00000000457 13070706737 025204 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var vm = require('vm'); var sandbox = { x: 3 }; var ctx = vm.createContext(sandbox); assert.strictEqual(vm.runInContext('x;', ctx), 3); vm.runInContext('y = 4;', ctx); assert.strictEqual(sandbox.y, 4); assert.strictEqual(ctx.y, 4); node-v4.8.2/test/parallel/test-vm-context.js000644 000766 000024 00000004460 13070706737 021160 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var vm = require('vm'); var Script = vm.Script; var script = new Script('"passed";'); console.error('run in a new empty context'); var context = vm.createContext(); var result = script.runInContext(context); assert.equal('passed', result); console.error('create a new pre-populated context'); context = vm.createContext({'foo': 'bar', 'thing': 'lala'}); assert.equal('bar', context.foo); assert.equal('lala', context.thing); console.error('test updating context'); script = new Script('foo = 3;'); result = script.runInContext(context); assert.equal(3, context.foo); assert.equal('lala', context.thing); // Issue GH-227: assert.throws(function() { vm.runInNewContext('', null, 'some.js'); }, TypeError); // Issue GH-1140: console.error('test runInContext signature'); var gh1140Exception; try { vm.runInContext('throw new Error()', context, 'expected-filename.js'); } catch (e) { gh1140Exception = e; assert.ok(/expected-filename/.test(e.stack), 'expected appearance of filename in Error stack'); } assert.ok(gh1140Exception, 'expected exception from runInContext signature test'); // GH-558, non-context argument segfaults / raises assertion [undefined, null, 0, 0.0, '', {}, []].forEach(function(e) { assert.throws(function() { script.runInContext(e); }, TypeError); assert.throws(function() { vm.runInContext('', e); }, TypeError); }); // Issue GH-693: console.error('test RegExp as argument to assert.throws'); script = vm.createScript('var assert = require(\'assert\'); assert.throws(' + 'function() { throw "hello world"; }, /hello/);', 'some.js'); script.runInNewContext({ require: require }); // Issue GH-7529 script = vm.createScript('delete b'); var ctx = {}; Object.defineProperty(ctx, 'b', { configurable: false }); ctx = vm.createContext(ctx); assert.equal(script.runInContext(ctx), false); // Error on the first line of a module should // have the correct line and column number assert.throws(function() { vm.runInContext('throw new Error()', context, { filename: 'expected-filename.js', lineOffset: 32, columnOffset: 123 }); }, function(err) { return /expected-filename.js:33:130/.test(err.stack); }, 'Expected appearance of proper offset in Error stack'); node-v4.8.2/test/parallel/test-vm-create-and-run-in-context.js000644 000766 000024 00000001534 13070706737 024366 0ustar00iojsstaff000000 000000 'use strict'; // Flags: --expose-gc require('../common'); var assert = require('assert'); var vm = require('vm'); console.error('run in a new empty context'); var context = vm.createContext(); var result = vm.runInContext('"passed";', context); assert.equal('passed', result); console.error('create a new pre-populated context'); context = vm.createContext({'foo': 'bar', 'thing': 'lala'}); assert.equal('bar', context.foo); assert.equal('lala', context.thing); console.error('test updating context'); result = vm.runInContext('var foo = 3;', context); assert.equal(3, context.foo); assert.equal('lala', context.thing); // https://github.com/nodejs/node/issues/5768 console.error('run in contextified sandbox without referencing the context'); var sandbox = {x: 1}; vm.createContext(sandbox); gc(); vm.runInContext('x = 2', sandbox); // Should not crash. node-v4.8.2/test/parallel/test-vm-create-context-accessors.js000644 000766 000024 00000000744 13070706737 024405 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var vm = require('vm'); var ctx = {}; Object.defineProperty(ctx, 'getter', { get: function() { return 'ok'; } }); var val; Object.defineProperty(ctx, 'setter', { set: function(_val) { val = _val; }, get: function() { return 'ok=' + val; } }); ctx = vm.createContext(ctx); var result = vm.runInContext('setter = "test";[getter,setter]', ctx); assert.deepEqual(result, ['ok', 'ok=test']); node-v4.8.2/test/parallel/test-vm-create-context-arg.js000644 000766 000024 00000000620 13070706737 023162 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var vm = require('vm'); assert.throws(function() { vm.createContext('string is not supported'); }, TypeError); assert.doesNotThrow(function() { vm.createContext({ a: 1 }); vm.createContext([0, 1, 2, 3]); }); assert.doesNotThrow(function() { var sandbox = {}; vm.createContext(sandbox); vm.createContext(sandbox); }); node-v4.8.2/test/parallel/test-vm-create-context-circular-reference.js000644 000766 000024 00000000356 13070706737 026157 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var vm = require('vm'); var sbx = {}; sbx.window = sbx; sbx = vm.createContext(sbx); sbx.test = 123; assert.equal(sbx.window.window.window.window.window.test, 123); node-v4.8.2/test/parallel/test-vm-cross-context.js000644 000766 000024 00000000351 13070706737 022302 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var vm = require('vm'); var ctx = vm.createContext(global); assert.doesNotThrow(function() { vm.runInContext('!function() { var x = console.log; }()', ctx); }); node-v4.8.2/test/parallel/test-vm-debug-context.js000644 000766 000024 00000005662 13070706737 022251 0ustar00iojsstaff000000 000000 /* eslint-disable no-debugger */ 'use strict'; var common = require('../common'); var assert = require('assert'); var vm = require('vm'); var spawn = require('child_process').spawn; assert.throws(function() { vm.runInDebugContext('*'); }, /SyntaxError/); assert.throws(function() { vm.runInDebugContext({ toString: common.fail }); }, /AssertionError/); assert.throws(function() { vm.runInDebugContext('throw URIError("BAM")'); }, /URIError/); assert.throws(function() { vm.runInDebugContext('(function(f) { f(f) })(function(f) { f(f) })'); }, /RangeError/); assert.equal(typeof vm.runInDebugContext('this'), 'object'); assert.equal(typeof vm.runInDebugContext('Debug'), 'object'); assert.strictEqual(vm.runInDebugContext(), undefined); assert.strictEqual(vm.runInDebugContext(0), 0); assert.strictEqual(vm.runInDebugContext(null), null); assert.strictEqual(vm.runInDebugContext(undefined), undefined); // See https://github.com/nodejs/node/issues/1190, accessing named interceptors // and accessors inside a debug event listener should not crash. (function() { var Debug = vm.runInDebugContext('Debug'); var breaks = 0; function ondebugevent(evt, exc) { if (evt !== Debug.DebugEvent.Break) return; exc.frame(0).evaluate('process.env').properties(); // Named interceptor. exc.frame(0).evaluate('process.title').getTruncatedValue(); // Accessor. breaks += 1; } function breakpoint() { debugger; } assert.equal(breaks, 0); Debug.setListener(ondebugevent); assert.equal(breaks, 0); breakpoint(); assert.equal(breaks, 1); })(); // Can set listeners and breakpoints on a single line file (function() { const Debug = vm.runInDebugContext('Debug'); const fn = require(common.fixturesDir + '/exports-function-with-param'); let called = false; Debug.setListener(function(event, state, data) { if (data.constructor.name === 'BreakEvent') { called = true; } }); Debug.setBreakPoint(fn); fn('foo'); assert.strictEqual(Debug.showBreakPoints(fn), '(arg) { [B0]return arg; }'); assert.strictEqual(called, true); })(); // See https://github.com/nodejs/node/issues/1190, fatal errors should not // crash the process. var script = common.fixturesDir + '/vm-run-in-debug-context.js'; var proc = spawn(process.execPath, [script]); var data = []; proc.stdout.on('data', common.fail); proc.stderr.on('data', data.push.bind(data)); proc.stderr.once('end', common.mustCall(function() { var haystack = Buffer.concat(data).toString('utf8'); assert(/SyntaxError: Unexpected token \*/.test(haystack)); })); proc.once('exit', common.mustCall(function(exitCode, signalCode) { assert.equal(exitCode, 1); assert.equal(signalCode, null); })); proc = spawn(process.execPath, [script, 'handle-fatal-exception']); proc.stdout.on('data', common.fail); proc.stderr.on('data', common.fail); proc.once('exit', common.mustCall(function(exitCode, signalCode) { assert.equal(exitCode, 42); assert.equal(signalCode, null); })); node-v4.8.2/test/parallel/test-vm-function-declaration.js000644 000766 000024 00000001612 13070706737 023600 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var vm = require('vm'); var o = vm.createContext({ console: console }); // This triggers the setter callback in node_contextify.cc var code = 'var a = function() {};\n'; // but this does not, since function decls are defineProperties, // not simple sets. code += 'function b(){}\n'; // Grab the global b function as the completion value, to ensure that // we are getting the global function, and not some other thing code += '(function(){return this})().b;\n'; var res = vm.runInContext(code, o, 'test'); assert.equal(typeof res, 'function', 'result should be function'); assert.equal(res.name, 'b', 'res should be named b'); assert.equal(typeof o.a, 'function', 'a should be function'); assert.equal(typeof o.b, 'function', 'b should be function'); assert.equal(res, o.b, 'result should be global b function'); console.log('ok'); node-v4.8.2/test/parallel/test-vm-global-define-property.js000644 000766 000024 00000001140 13070706737 024036 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var vm = require('vm'); var code = 'Object.defineProperty(this, "f", {\n' + ' get: function() { return x; },\n' + ' set: function(k) { x = k; },\n' + ' configurable: true,\n' + ' enumerable: true\n' + '});\n' + 'g = f;\n' + 'f;\n'; var x = {}; var o = vm.createContext({ console: console, x: x }); var res = vm.runInContext(code, o, 'test'); assert(res); assert.equal(typeof res, 'object'); assert.equal(res, x); assert.equal(o.f, res); assert.deepEqual(Object.keys(o), ['console', 'x', 'g', 'f']); node-v4.8.2/test/parallel/test-vm-global-identity.js000644 000766 000024 00000000424 13070706737 022557 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var vm = require('vm'); var ctx = vm.createContext(); ctx.window = ctx; var thisVal = vm.runInContext('this;', ctx); var windowVal = vm.runInContext('window;', ctx); assert.strictEqual(thisVal, windowVal); node-v4.8.2/test/parallel/test-vm-harmony-proxies.js000644 000766 000024 00000001163 13070706737 022635 0ustar00iojsstaff000000 000000 'use strict'; // Flags: --harmony_proxies require('../common'); var assert = require('assert'); var vm = require('vm'); // src/node_contextify.cc filters out the Proxy object from the parent // context. Make sure that the new context has a Proxy object of its own. var sandbox = {}; vm.runInNewContext('this.Proxy = Proxy', sandbox); assert(typeof sandbox.Proxy === 'object'); assert(sandbox.Proxy !== Proxy); // Unless we copy the Proxy object explicitly, of course. sandbox = { Proxy: Proxy }; vm.runInNewContext('this.Proxy = Proxy', sandbox); assert(typeof sandbox.Proxy === 'object'); assert(sandbox.Proxy === Proxy); node-v4.8.2/test/parallel/test-vm-harmony-symbols.js000644 000766 000024 00000001021 13070706737 022625 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var vm = require('vm'); // The sandbox should have its own Symbol constructor. var sandbox = {}; vm.runInNewContext('this.Symbol = Symbol', sandbox); assert(typeof sandbox.Symbol === 'function'); assert(sandbox.Symbol !== Symbol); // Unless we copy the Symbol constructor explicitly, of course. sandbox = { Symbol: Symbol }; vm.runInNewContext('this.Symbol = Symbol', sandbox); assert(typeof sandbox.Symbol === 'function'); assert(sandbox.Symbol === Symbol); node-v4.8.2/test/parallel/test-vm-is-context.js000644 000766 000024 00000000763 13070706737 021573 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var vm = require('vm'); assert.throws(function() { vm.isContext('string is not supported'); }, TypeError); assert.strictEqual(vm.isContext({}), false); assert.strictEqual(vm.isContext([]), false); assert.strictEqual(vm.isContext(vm.createContext()), true); assert.strictEqual(vm.isContext(vm.createContext([])), true); var sandbox = { foo: 'bar' }; vm.createContext(sandbox); assert.strictEqual(vm.isContext(sandbox), true); node-v4.8.2/test/parallel/test-vm-low-stack-space.js000644 000766 000024 00000001005 13070706737 022461 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const vm = require('vm'); function a() { try { return a(); } catch (e) { // Throw an exception as near to the recursion-based RangeError as possible. return vm.runInThisContext('() => 42')(); } } assert.strictEqual(a(), 42); function b() { try { return b(); } catch (e) { // This writes a lot of noise to stderr, but it still works. return vm.runInNewContext('() => 42')(); } } assert.strictEqual(b(), 42); node-v4.8.2/test/parallel/test-vm-new-script-new-context.js000644 000766 000024 00000003434 13070706737 024040 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const Script = require('vm').Script; common.globalCheck = false; console.error('run a string'); var script = new Script('\'passed\';'); console.error('script created'); const result1 = script.runInNewContext(); const result2 = script.runInNewContext(); assert.equal('passed', result1); assert.equal('passed', result2); console.error('thrown error'); script = new Script('throw new Error(\'test\');'); assert.throws(function() { script.runInNewContext(); }, /test/); console.error('undefined reference'); script = new Script('foo.bar = 5;'); assert.throws(function() { script.runInNewContext(); }, /not defined/); global.hello = 5; script = new Script('hello = 2'); script.runInNewContext(); assert.equal(5, global.hello); console.error('pass values in and out'); global.code = 'foo = 1;' + 'bar = 2;' + 'if (baz !== 3) throw new Error(\'test fail\');'; global.foo = 2; global.obj = { foo: 0, baz: 3 }; script = new Script(global.code); /* eslint-disable no-unused-vars */ var baz = script.runInNewContext(global.obj); /* eslint-enable no-unused-vars */ assert.equal(1, global.obj.foo); assert.equal(2, global.obj.bar); assert.equal(2, global.foo); console.error('call a function by reference'); script = new Script('f()'); function changeFoo() { global.foo = 100; } script.runInNewContext({ f: changeFoo }); assert.equal(global.foo, 100); console.error('modify an object by reference'); script = new Script('f.a = 2'); var f = { a: 1 }; script.runInNewContext({ f: f }); assert.equal(f.a, 2); assert.throws(function() { script.runInNewContext(); }, /f is not defined/); console.error('invalid this'); assert.throws(function() { script.runInNewContext.call('\'hello\';'); }, TypeError); node-v4.8.2/test/parallel/test-vm-new-script-this-context.js000644 000766 000024 00000002131 13070706737 024207 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const Script = require('vm').Script; common.globalCheck = false; console.error('run a string'); var script = new Script('\'passed\';'); const result = script.runInThisContext(script); assert.equal('passed', result); console.error('thrown error'); script = new Script('throw new Error(\'test\');'); assert.throws(function() { script.runInThisContext(script); }); global.hello = 5; script = new Script('hello = 2'); script.runInThisContext(script); assert.equal(2, global.hello); console.error('pass values'); global.code = 'foo = 1;' + 'bar = 2;' + 'if (typeof baz !== "undefined") throw new Error("test fail");'; global.foo = 2; global.obj = { foo: 0, baz: 3 }; script = new Script(global.code); script.runInThisContext(script); assert.equal(0, global.obj.foo); assert.equal(2, global.bar); assert.equal(1, global.foo); console.error('call a function'); global.f = function() { global.foo = 100; }; script = new Script('f()'); script.runInThisContext(script); assert.equal(100, global.foo); node-v4.8.2/test/parallel/test-vm-preserves-property.js000644 000766 000024 00000001245 13070706737 023372 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const vm = require('vm'); const x = {}; Object.defineProperty(x, 'prop', { configurable: false, enumerable: false, writable: false, value: 'val' }); const o = vm.createContext(x); const code = 'Object.getOwnPropertyDescriptor(this, "prop")'; const res = vm.runInContext(code, o, 'test'); assert(res); assert.strictEqual(typeof res, 'object'); assert.strictEqual(res.value, 'val'); assert.strictEqual(res.configurable, false, 'should not be configurable'); assert.strictEqual(res.enumerable, false, 'should not be enumerable'); assert.strictEqual(res.writable, false, 'should not be writable'); node-v4.8.2/test/parallel/test-vm-property-not-on-sandbox.js000644 000766 000024 00000002651 13070706737 024224 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const vm = require('vm'); // This, admittedly contrived, example tests an edge cases of the vm module. // // The GetterCallback explicitly checks the global_proxy() if a property is // not found on the sandbox. In the following test, the explicit check // inside the callback yields different results than deferring the // check until after the callback. The check is deferred if the // callback does not intercept, i.e., if args.GetReturnValue().Set() is // not called. // Check that the GetterCallback explicitly calls GetRealNamedProperty() // on the global proxy if the property is not found on the sandbox. // // foo is not defined on the sandbox until we call CopyProperties(). // In the GetterCallback, we do not find the property on the sandbox and // get the property from the global proxy. Since the return value is // the sandbox, we replace it by // the global_proxy to keep the correct identities. // // This test case is partially inspired by // https://github.com/nodejs/node/issues/855 const sandbox = {console}; sandbox.document = {defaultView: sandbox}; vm.createContext(sandbox); const code = `Object.defineProperty( this, 'foo', { get: function() {return document.defaultView} } ); var result = foo === this;`; vm.runInContext(code, sandbox); assert.strictEqual(sandbox.result, true); node-v4.8.2/test/parallel/test-vm-run-in-new-context.js000644 000766 000024 00000002654 13070706737 023160 0ustar00iojsstaff000000 000000 'use strict'; // Flags: --expose-gc const common = require('../common'); const assert = require('assert'); const vm = require('vm'); assert.equal(typeof gc, 'function', 'Run this test with --expose-gc'); common.globalCheck = false; console.error('run a string'); const result = vm.runInNewContext('\'passed\';'); assert.equal('passed', result); console.error('thrown error'); assert.throws(function() { vm.runInNewContext('throw new Error(\'test\');'); }); global.hello = 5; vm.runInNewContext('hello = 2'); assert.equal(5, global.hello); console.error('pass values in and out'); global.code = 'foo = 1;' + 'bar = 2;' + 'if (baz !== 3) throw new Error(\'test fail\');'; global.foo = 2; global.obj = { foo: 0, baz: 3 }; /* eslint-disable no-unused-vars */ var baz = vm.runInNewContext(global.code, global.obj); /* eslint-enable no-unused-vars */ assert.equal(1, global.obj.foo); assert.equal(2, global.obj.bar); assert.equal(2, global.foo); console.error('call a function by reference'); function changeFoo() { global.foo = 100; } vm.runInNewContext('f()', { f: changeFoo }); assert.equal(global.foo, 100); console.error('modify an object by reference'); var f = { a: 1 }; vm.runInNewContext('f.a = 2', { f: f }); assert.equal(f.a, 2); console.error('use function in context without referencing context'); var fn = vm.runInNewContext('(function() { obj.p = {}; })', { obj: {} }); gc(); fn(); // Should not crash node-v4.8.2/test/parallel/test-vm-static-this.js000644 000766 000024 00000001740 13070706737 021726 0ustar00iojsstaff000000 000000 /* eslint-disable strict */ var common = require('../common'); var assert = require('assert'); var vm = require('vm'); common.globalCheck = false; // Run a string var result = vm.runInThisContext('\'passed\';'); assert.strictEqual('passed', result); // thrown error assert.throws(function() { vm.runInThisContext('throw new Error(\'test\');'); }, /test/); global.hello = 5; vm.runInThisContext('hello = 2'); assert.strictEqual(2, global.hello); // pass values var code = 'foo = 1;' + 'bar = 2;' + 'if (typeof baz !== \'undefined\') throw new Error(\'test fail\');'; global.foo = 2; global.obj = { foo: 0, baz: 3 }; /* eslint-disable no-unused-vars */ var baz = vm.runInThisContext(code); /* eslint-enable no-unused-vars */ assert.strictEqual(0, global.obj.foo); assert.strictEqual(2, global.bar); assert.strictEqual(1, global.foo); // call a function global.f = function() { global.foo = 100; }; vm.runInThisContext('f()'); assert.strictEqual(100, global.foo); node-v4.8.2/test/parallel/test-vm-symbols.js000644 000766 000024 00000001053 13070706737 021157 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const vm = require('vm'); const symbol = Symbol(); function Document() { this[symbol] = 'foo'; } Document.prototype.getSymbolValue = function() { return this[symbol]; }; const context = new Document(); vm.createContext(context); assert.strictEqual(context.getSymbolValue(), 'foo', 'should return symbol-keyed value from the outside'); assert.strictEqual(vm.runInContext('this.getSymbolValue()', context), 'foo', 'should return symbol-keyed value from the inside'); node-v4.8.2/test/parallel/test-vm-syntax-error-message.js000644 000766 000024 00000001162 13070706737 023567 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var child_process = require('child_process'); var p = child_process.spawn(process.execPath, [ '-e', 'vm = require("vm");' + 'context = vm.createContext({});' + 'try { vm.runInContext("throw new Error(\'boo\')", context); } ' + 'catch (e) { console.log(e.message); }' ]); p.stderr.on('data', function(data) { assert(false, 'Unexpected stderr data: ' + data); }); var output = ''; p.stdout.on('data', function(data) { output += data; }); process.on('exit', function() { assert.equal(output.replace(/[\r\n]+/g, ''), 'boo'); }); node-v4.8.2/test/parallel/test-vm-syntax-error-stderr.js000644 000766 000024 00000001267 13070706737 023454 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const path = require('path'); const child_process = require('child_process'); const wrong_script = path.join(common.fixturesDir, 'cert.pem'); const p = child_process.spawn(process.execPath, [ '-e', 'require(process.argv[1]);', wrong_script ]); p.stdout.on('data', function(data) { common.fail('Unexpected stdout data: ' + data); }); let output = ''; p.stderr.on('data', function(data) { output += data; }); process.on('exit', function() { assert(/BEGIN CERT/.test(output)); assert(/^\s+\^/m.test(output)); assert(/Invalid left-hand side expression in prefix operation/.test(output)); }); node-v4.8.2/test/parallel/test-vm-timeout.js000644 000766 000024 00000001666 13070706737 021167 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var vm = require('vm'); // Test 1: Timeout of 100ms executing endless loop assert.throws(function() { vm.runInThisContext('while(true) {}', { timeout: 100 }); }); // Test 2: Timeout must be >= 0ms assert.throws(function() { vm.runInThisContext('', { timeout: -1 }); }, RangeError); // Test 3: Timeout of 0ms assert.throws(function() { vm.runInThisContext('', { timeout: 0 }); }, RangeError); // Test 4: Timeout of 1000ms, script finishes first vm.runInThisContext('', { timeout: 1000 }); // Test 5: Nested vm timeouts, inner timeout propagates out assert.throws(function() { var context = { log: console.log, runInVM: function(timeout) { vm.runInNewContext('while(true) {}', context, { timeout: timeout }); } }; vm.runInNewContext('runInVM(10)', context, { timeout: 10000 }); throw new Error('Test 5 failed'); }, /Script execution timed out./); node-v4.8.2/test/parallel/test-writedouble.js000644 000766 000024 00000013474 13070706737 021406 0ustar00iojsstaff000000 000000 'use strict'; /* * Tests to verify we're writing doubles correctly */ require('../common'); const assert = require('assert'); function test(clazz) { var buffer = new clazz(16); buffer.writeDoubleBE(2.225073858507201e-308, 0); buffer.writeDoubleLE(2.225073858507201e-308, 8); assert.equal(0x00, buffer[0]); assert.equal(0x0f, buffer[1]); assert.equal(0xff, buffer[2]); assert.equal(0xff, buffer[3]); assert.equal(0xff, buffer[4]); assert.equal(0xff, buffer[5]); assert.equal(0xff, buffer[6]); assert.equal(0xff, buffer[7]); assert.equal(0xff, buffer[8]); assert.equal(0xff, buffer[9]); assert.equal(0xff, buffer[10]); assert.equal(0xff, buffer[11]); assert.equal(0xff, buffer[12]); assert.equal(0xff, buffer[13]); assert.equal(0x0f, buffer[14]); assert.equal(0x00, buffer[15]); buffer.writeDoubleBE(1.0000000000000004, 0); buffer.writeDoubleLE(1.0000000000000004, 8); assert.equal(0x3f, buffer[0]); assert.equal(0xf0, buffer[1]); assert.equal(0x00, buffer[2]); assert.equal(0x00, buffer[3]); assert.equal(0x00, buffer[4]); assert.equal(0x00, buffer[5]); assert.equal(0x00, buffer[6]); assert.equal(0x02, buffer[7]); assert.equal(0x02, buffer[8]); assert.equal(0x00, buffer[9]); assert.equal(0x00, buffer[10]); assert.equal(0x00, buffer[11]); assert.equal(0x00, buffer[12]); assert.equal(0x00, buffer[13]); assert.equal(0xf0, buffer[14]); assert.equal(0x3f, buffer[15]); buffer.writeDoubleBE(-2, 0); buffer.writeDoubleLE(-2, 8); assert.equal(0xc0, buffer[0]); assert.equal(0x00, buffer[1]); assert.equal(0x00, buffer[2]); assert.equal(0x00, buffer[3]); assert.equal(0x00, buffer[4]); assert.equal(0x00, buffer[5]); assert.equal(0x00, buffer[6]); assert.equal(0x00, buffer[7]); assert.equal(0x00, buffer[8]); assert.equal(0x00, buffer[9]); assert.equal(0x00, buffer[10]); assert.equal(0x00, buffer[11]); assert.equal(0x00, buffer[12]); assert.equal(0x00, buffer[13]); assert.equal(0x00, buffer[14]); assert.equal(0xc0, buffer[15]); buffer.writeDoubleBE(1.7976931348623157e+308, 0); buffer.writeDoubleLE(1.7976931348623157e+308, 8); assert.equal(0x7f, buffer[0]); assert.equal(0xef, buffer[1]); assert.equal(0xff, buffer[2]); assert.equal(0xff, buffer[3]); assert.equal(0xff, buffer[4]); assert.equal(0xff, buffer[5]); assert.equal(0xff, buffer[6]); assert.equal(0xff, buffer[7]); assert.equal(0xff, buffer[8]); assert.equal(0xff, buffer[9]); assert.equal(0xff, buffer[10]); assert.equal(0xff, buffer[11]); assert.equal(0xff, buffer[12]); assert.equal(0xff, buffer[13]); assert.equal(0xef, buffer[14]); assert.equal(0x7f, buffer[15]); buffer.writeDoubleBE(0 * -1, 0); buffer.writeDoubleLE(0 * -1, 8); assert.equal(0x80, buffer[0]); assert.equal(0x00, buffer[1]); assert.equal(0x00, buffer[2]); assert.equal(0x00, buffer[3]); assert.equal(0x00, buffer[4]); assert.equal(0x00, buffer[5]); assert.equal(0x00, buffer[6]); assert.equal(0x00, buffer[7]); assert.equal(0x00, buffer[8]); assert.equal(0x00, buffer[9]); assert.equal(0x00, buffer[10]); assert.equal(0x00, buffer[11]); assert.equal(0x00, buffer[12]); assert.equal(0x00, buffer[13]); assert.equal(0x00, buffer[14]); assert.equal(0x80, buffer[15]); buffer.writeDoubleBE(Infinity, 0); buffer.writeDoubleLE(Infinity, 8); assert.equal(0x7F, buffer[0]); assert.equal(0xF0, buffer[1]); assert.equal(0x00, buffer[2]); assert.equal(0x00, buffer[3]); assert.equal(0x00, buffer[4]); assert.equal(0x00, buffer[5]); assert.equal(0x00, buffer[6]); assert.equal(0x00, buffer[7]); assert.equal(0x00, buffer[8]); assert.equal(0x00, buffer[9]); assert.equal(0x00, buffer[10]); assert.equal(0x00, buffer[11]); assert.equal(0x00, buffer[12]); assert.equal(0x00, buffer[13]); assert.equal(0xF0, buffer[14]); assert.equal(0x7F, buffer[15]); assert.equal(Infinity, buffer.readDoubleBE(0)); assert.equal(Infinity, buffer.readDoubleLE(8)); buffer.writeDoubleBE(-Infinity, 0); buffer.writeDoubleLE(-Infinity, 8); assert.equal(0xFF, buffer[0]); assert.equal(0xF0, buffer[1]); assert.equal(0x00, buffer[2]); assert.equal(0x00, buffer[3]); assert.equal(0x00, buffer[4]); assert.equal(0x00, buffer[5]); assert.equal(0x00, buffer[6]); assert.equal(0x00, buffer[7]); assert.equal(0x00, buffer[8]); assert.equal(0x00, buffer[9]); assert.equal(0x00, buffer[10]); assert.equal(0x00, buffer[11]); assert.equal(0x00, buffer[12]); assert.equal(0x00, buffer[13]); assert.equal(0xF0, buffer[14]); assert.equal(0xFF, buffer[15]); assert.equal(-Infinity, buffer.readDoubleBE(0)); assert.equal(-Infinity, buffer.readDoubleLE(8)); buffer.writeDoubleBE(NaN, 0); buffer.writeDoubleLE(NaN, 8); // Darwin ia32 does the other kind of NaN. // Compiler bug. No one really cares. assert(0x7F === buffer[0] || 0xFF === buffer[0]); // mips processors use a slightly different NaN assert(0xF8 === buffer[1] || 0xF7 === buffer[1]); assert(0x00 === buffer[2] || 0xFF === buffer[2]); assert(0x00 === buffer[3] || 0xFF === buffer[3]); assert(0x00 === buffer[4] || 0xFF === buffer[4]); assert(0x00 === buffer[5] || 0xFF === buffer[5]); assert(0x00 === buffer[6] || 0xFF === buffer[6]); assert(0x00 === buffer[7] || 0xFF === buffer[7]); assert(0x00 === buffer[8] || 0xFF === buffer[8]); assert(0x00 === buffer[9] || 0xFF === buffer[9]); assert(0x00 === buffer[10] || 0xFF === buffer[10]); assert(0x00 === buffer[11] || 0xFF === buffer[11]); assert(0x00 === buffer[12] || 0xFF === buffer[12]); assert(0x00 === buffer[13] || 0xFF === buffer[13]); assert(0xF8 === buffer[14] || 0xF7 === buffer[14]); // Darwin ia32 does the other kind of NaN. // Compiler bug. No one really cares. assert(0x7F === buffer[15] || 0xFF === buffer[15]); assert.ok(isNaN(buffer.readDoubleBE(0))); assert.ok(isNaN(buffer.readDoubleLE(8))); } test(Buffer); node-v4.8.2/test/parallel/test-writefloat.js000644 000766 000024 00000007141 13070706737 021233 0ustar00iojsstaff000000 000000 'use strict'; /* * Tests to verify we're writing floats correctly */ require('../common'); const assert = require('assert'); function test(clazz) { var buffer = new clazz(8); buffer.writeFloatBE(1, 0); buffer.writeFloatLE(1, 4); assert.equal(0x3f, buffer[0]); assert.equal(0x80, buffer[1]); assert.equal(0x00, buffer[2]); assert.equal(0x00, buffer[3]); assert.equal(0x00, buffer[4]); assert.equal(0x00, buffer[5]); assert.equal(0x80, buffer[6]); assert.equal(0x3f, buffer[7]); buffer.writeFloatBE(1 / 3, 0); buffer.writeFloatLE(1 / 3, 4); assert.equal(0x3e, buffer[0]); assert.equal(0xaa, buffer[1]); assert.equal(0xaa, buffer[2]); assert.equal(0xab, buffer[3]); assert.equal(0xab, buffer[4]); assert.equal(0xaa, buffer[5]); assert.equal(0xaa, buffer[6]); assert.equal(0x3e, buffer[7]); buffer.writeFloatBE(3.4028234663852886e+38, 0); buffer.writeFloatLE(3.4028234663852886e+38, 4); assert.equal(0x7f, buffer[0]); assert.equal(0x7f, buffer[1]); assert.equal(0xff, buffer[2]); assert.equal(0xff, buffer[3]); assert.equal(0xff, buffer[4]); assert.equal(0xff, buffer[5]); assert.equal(0x7f, buffer[6]); assert.equal(0x7f, buffer[7]); buffer.writeFloatLE(1.1754943508222875e-38, 0); buffer.writeFloatBE(1.1754943508222875e-38, 4); assert.equal(0x00, buffer[0]); assert.equal(0x00, buffer[1]); assert.equal(0x80, buffer[2]); assert.equal(0x00, buffer[3]); assert.equal(0x00, buffer[4]); assert.equal(0x80, buffer[5]); assert.equal(0x00, buffer[6]); assert.equal(0x00, buffer[7]); buffer.writeFloatBE(0 * -1, 0); buffer.writeFloatLE(0 * -1, 4); assert.equal(0x80, buffer[0]); assert.equal(0x00, buffer[1]); assert.equal(0x00, buffer[2]); assert.equal(0x00, buffer[3]); assert.equal(0x00, buffer[4]); assert.equal(0x00, buffer[5]); assert.equal(0x00, buffer[6]); assert.equal(0x80, buffer[7]); buffer.writeFloatBE(Infinity, 0); buffer.writeFloatLE(Infinity, 4); assert.equal(0x7F, buffer[0]); assert.equal(0x80, buffer[1]); assert.equal(0x00, buffer[2]); assert.equal(0x00, buffer[3]); assert.equal(0x00, buffer[4]); assert.equal(0x00, buffer[5]); assert.equal(0x80, buffer[6]); assert.equal(0x7F, buffer[7]); assert.equal(Infinity, buffer.readFloatBE(0)); assert.equal(Infinity, buffer.readFloatLE(4)); buffer.writeFloatBE(-Infinity, 0); buffer.writeFloatLE(-Infinity, 4); // Darwin ia32 does the other kind of NaN. // Compiler bug. No one really cares. assert(0xFF === buffer[0] || 0x7F === buffer[0]); assert.equal(0x80, buffer[1]); assert.equal(0x00, buffer[2]); assert.equal(0x00, buffer[3]); assert.equal(0x00, buffer[4]); assert.equal(0x00, buffer[5]); assert.equal(0x80, buffer[6]); assert.equal(0xFF, buffer[7]); assert.equal(-Infinity, buffer.readFloatBE(0)); assert.equal(-Infinity, buffer.readFloatLE(4)); buffer.writeFloatBE(NaN, 0); buffer.writeFloatLE(NaN, 4); // Darwin ia32 does the other kind of NaN. // Compiler bug. No one really cares. assert(0x7F === buffer[0] || 0xFF === buffer[0]); // mips processors use a slightly different NaN assert(0xC0 === buffer[1] || 0xBF === buffer[1]); assert(0x00 === buffer[2] || 0xFF === buffer[2]); assert(0x00 === buffer[3] || 0xFF === buffer[3]); assert(0x00 === buffer[4] || 0xFF === buffer[4]); assert(0x00 === buffer[5] || 0xFF === buffer[5]); assert(0xC0 === buffer[6] || 0xBF === buffer[6]); // Darwin ia32 does the other kind of NaN. // Compiler bug. No one really cares. assert(0x7F === buffer[7] || 0xFF === buffer[7]); assert.ok(isNaN(buffer.readFloatBE(0))); assert.ok(isNaN(buffer.readFloatLE(4))); } test(Buffer); node-v4.8.2/test/parallel/test-writeint.js000644 000766 000024 00000010417 13070706737 020720 0ustar00iojsstaff000000 000000 'use strict'; /* * Tests to verify we're writing signed integers correctly */ require('../common'); const assert = require('assert'); function test8(clazz) { var buffer = new clazz(2); buffer.writeInt8(0x23, 0); buffer.writeInt8(-5, 1); assert.equal(0x23, buffer[0]); assert.equal(0xfb, buffer[1]); /* Make sure we handle truncation correctly */ assert.throws(function() { buffer.writeInt8(0xabc, 0); }); assert.throws(function() { buffer.writeInt8(0xabc, 0); }); /* Make sure we handle min/max correctly */ buffer.writeInt8(0x7f, 0); buffer.writeInt8(-0x80, 1); assert.equal(0x7f, buffer[0]); assert.equal(0x80, buffer[1]); assert.throws(function() { buffer.writeInt8(0x7f + 1, 0); }); assert.throws(function() { buffer.writeInt8(-0x80 - 1, 0); }); } function test16(clazz) { var buffer = new clazz(6); buffer.writeInt16BE(0x0023, 0); buffer.writeInt16LE(0x0023, 2); assert.equal(0x00, buffer[0]); assert.equal(0x23, buffer[1]); assert.equal(0x23, buffer[2]); assert.equal(0x00, buffer[3]); buffer.writeInt16BE(-5, 0); buffer.writeInt16LE(-5, 2); assert.equal(0xff, buffer[0]); assert.equal(0xfb, buffer[1]); assert.equal(0xfb, buffer[2]); assert.equal(0xff, buffer[3]); buffer.writeInt16BE(-1679, 1); buffer.writeInt16LE(-1679, 3); assert.equal(0xf9, buffer[1]); assert.equal(0x71, buffer[2]); assert.equal(0x71, buffer[3]); assert.equal(0xf9, buffer[4]); /* Make sure we handle min/max correctly */ buffer.writeInt16BE(0x7fff, 0); buffer.writeInt16BE(-0x8000, 2); assert.equal(0x7f, buffer[0]); assert.equal(0xff, buffer[1]); assert.equal(0x80, buffer[2]); assert.equal(0x00, buffer[3]); assert.throws(function() { buffer.writeInt16BE(0x7fff + 1, 0); }); assert.throws(function() { buffer.writeInt16BE(-0x8000 - 1, 0); }); buffer.writeInt16LE(0x7fff, 0); buffer.writeInt16LE(-0x8000, 2); assert.equal(0xff, buffer[0]); assert.equal(0x7f, buffer[1]); assert.equal(0x00, buffer[2]); assert.equal(0x80, buffer[3]); assert.throws(function() { buffer.writeInt16LE(0x7fff + 1, 0); }); assert.throws(function() { buffer.writeInt16LE(-0x8000 - 1, 0); }); } function test32(clazz) { var buffer = new clazz(8); buffer.writeInt32BE(0x23, 0); buffer.writeInt32LE(0x23, 4); assert.equal(0x00, buffer[0]); assert.equal(0x00, buffer[1]); assert.equal(0x00, buffer[2]); assert.equal(0x23, buffer[3]); assert.equal(0x23, buffer[4]); assert.equal(0x00, buffer[5]); assert.equal(0x00, buffer[6]); assert.equal(0x00, buffer[7]); buffer.writeInt32BE(-5, 0); buffer.writeInt32LE(-5, 4); assert.equal(0xff, buffer[0]); assert.equal(0xff, buffer[1]); assert.equal(0xff, buffer[2]); assert.equal(0xfb, buffer[3]); assert.equal(0xfb, buffer[4]); assert.equal(0xff, buffer[5]); assert.equal(0xff, buffer[6]); assert.equal(0xff, buffer[7]); buffer.writeInt32BE(-805306713, 0); buffer.writeInt32LE(-805306713, 4); assert.equal(0xcf, buffer[0]); assert.equal(0xff, buffer[1]); assert.equal(0xfe, buffer[2]); assert.equal(0xa7, buffer[3]); assert.equal(0xa7, buffer[4]); assert.equal(0xfe, buffer[5]); assert.equal(0xff, buffer[6]); assert.equal(0xcf, buffer[7]); /* Make sure we handle min/max correctly */ buffer.writeInt32BE(0x7fffffff, 0); buffer.writeInt32BE(-0x80000000, 4); assert.equal(0x7f, buffer[0]); assert.equal(0xff, buffer[1]); assert.equal(0xff, buffer[2]); assert.equal(0xff, buffer[3]); assert.equal(0x80, buffer[4]); assert.equal(0x00, buffer[5]); assert.equal(0x00, buffer[6]); assert.equal(0x00, buffer[7]); assert.throws(function() { buffer.writeInt32BE(0x7fffffff + 1, 0); }); assert.throws(function() { buffer.writeInt32BE(-0x80000000 - 1, 0); }); buffer.writeInt32LE(0x7fffffff, 0); buffer.writeInt32LE(-0x80000000, 4); assert.equal(0xff, buffer[0]); assert.equal(0xff, buffer[1]); assert.equal(0xff, buffer[2]); assert.equal(0x7f, buffer[3]); assert.equal(0x00, buffer[4]); assert.equal(0x00, buffer[5]); assert.equal(0x00, buffer[6]); assert.equal(0x80, buffer[7]); assert.throws(function() { buffer.writeInt32LE(0x7fffffff + 1, 0); }); assert.throws(function() { buffer.writeInt32LE(-0x80000000 - 1, 0); }); } test8(Buffer); test16(Buffer); test32(Buffer); node-v4.8.2/test/parallel/test-writeuint.js000644 000766 000024 00000006532 13070706737 021110 0ustar00iojsstaff000000 000000 'use strict'; /* * A battery of tests to help us read a series of uints */ require('../common'); const assert = require('assert'); /* * We need to check the following things: * - We are correctly resolving big endian (doesn't mean anything for 8 bit) * - Correctly resolving little endian (doesn't mean anything for 8 bit) * - Correctly using the offsets * - Correctly interpreting values that are beyond the signed range as unsigned */ function test8(clazz) { var data = new clazz(4); data.writeUInt8(23, 0); data.writeUInt8(23, 1); data.writeUInt8(23, 2); data.writeUInt8(23, 3); assert.equal(23, data[0]); assert.equal(23, data[1]); assert.equal(23, data[2]); assert.equal(23, data[3]); data.writeUInt8(23, 0); data.writeUInt8(23, 1); data.writeUInt8(23, 2); data.writeUInt8(23, 3); assert.equal(23, data[0]); assert.equal(23, data[1]); assert.equal(23, data[2]); assert.equal(23, data[3]); data.writeUInt8(255, 0); assert.equal(255, data[0]); data.writeUInt8(255, 0); assert.equal(255, data[0]); } function test16(clazz) { var value = 0x2343; var data = new clazz(4); data.writeUInt16BE(value, 0); assert.equal(0x23, data[0]); assert.equal(0x43, data[1]); data.writeUInt16BE(value, 1); assert.equal(0x23, data[1]); assert.equal(0x43, data[2]); data.writeUInt16BE(value, 2); assert.equal(0x23, data[2]); assert.equal(0x43, data[3]); data.writeUInt16LE(value, 0); assert.equal(0x23, data[1]); assert.equal(0x43, data[0]); data.writeUInt16LE(value, 1); assert.equal(0x23, data[2]); assert.equal(0x43, data[1]); data.writeUInt16LE(value, 2); assert.equal(0x23, data[3]); assert.equal(0x43, data[2]); value = 0xff80; data.writeUInt16LE(value, 0); assert.equal(0xff, data[1]); assert.equal(0x80, data[0]); data.writeUInt16BE(value, 0); assert.equal(0xff, data[0]); assert.equal(0x80, data[1]); } function test32(clazz) { var data = new clazz(6); var value = 0xe7f90a6d; data.writeUInt32BE(value, 0); assert.equal(0xe7, data[0]); assert.equal(0xf9, data[1]); assert.equal(0x0a, data[2]); assert.equal(0x6d, data[3]); data.writeUInt32BE(value, 1); assert.equal(0xe7, data[1]); assert.equal(0xf9, data[2]); assert.equal(0x0a, data[3]); assert.equal(0x6d, data[4]); data.writeUInt32BE(value, 2); assert.equal(0xe7, data[2]); assert.equal(0xf9, data[3]); assert.equal(0x0a, data[4]); assert.equal(0x6d, data[5]); data.writeUInt32LE(value, 0); assert.equal(0xe7, data[3]); assert.equal(0xf9, data[2]); assert.equal(0x0a, data[1]); assert.equal(0x6d, data[0]); data.writeUInt32LE(value, 1); assert.equal(0xe7, data[4]); assert.equal(0xf9, data[3]); assert.equal(0x0a, data[2]); assert.equal(0x6d, data[1]); data.writeUInt32LE(value, 2); assert.equal(0xe7, data[5]); assert.equal(0xf9, data[4]); assert.equal(0x0a, data[3]); assert.equal(0x6d, data[2]); } function testUint(clazz) { const data = new clazz(8); var val = 1; // Test 0 to 5 bytes. for (var i = 0; i <= 5; i++) { const errmsg = `byteLength: ${i}`; assert.throws(function() { data.writeUIntBE(val, 0, i); }, /value is out of bounds/, errmsg); assert.throws(function() { data.writeUIntLE(val, 0, i); }, /value is out of bounds/, errmsg); val *= 0x100; } } test8(Buffer); test16(Buffer); test32(Buffer); testUint(Buffer); node-v4.8.2/test/parallel/test-zerolengthbufferbug.js000644 000766 000024 00000001132 13070706737 023116 0ustar00iojsstaff000000 000000 'use strict'; // Serving up a zero-length buffer should work. const common = require('../common'); var http = require('http'); var server = http.createServer(function(req, res) { var buffer = new Buffer(0); // FIXME: WTF gjslint want this? res.writeHead(200, {'Content-Type': 'text/html', 'Content-Length': buffer.length}); res.end(buffer); }); server.listen(0, common.mustCall(function() { http.get({ port: this.address().port }, common.mustCall(function(res) { res.on('data', common.fail); res.on('end', function(d) { server.close(); }); })); })); node-v4.8.2/test/parallel/test-zlib-close-after-error.js000644 000766 000024 00000000536 13070706737 023345 0ustar00iojsstaff000000 000000 'use strict'; // https://github.com/nodejs/node/issues/6034 const common = require('../common'); const assert = require('assert'); const zlib = require('zlib'); const decompress = zlib.createGunzip(15); decompress.on('error', common.mustCall((err) => { assert.doesNotThrow(() => decompress.close()); })); decompress.write('something invalid'); node-v4.8.2/test/parallel/test-zlib-close-after-write.js000644 000766 000024 00000000363 13070706737 023344 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var zlib = require('zlib'); zlib.gzip('hello', common.mustCall(function(err, out) { var unzip = zlib.createGunzip(); unzip.write(out); unzip.close(common.mustCall(function() {})); })); node-v4.8.2/test/parallel/test-zlib-const.js000644 000766 000024 00000001015 13070706737 021131 0ustar00iojsstaff000000 000000 /* eslint-disable strict */ require('../common'); var assert = require('assert'); var zlib = require('zlib'); assert.equal(zlib.Z_OK, 0, 'Z_OK should be 0'); zlib.Z_OK = 1; assert.equal(zlib.Z_OK, 0, 'Z_OK should be 0'); assert.equal(zlib.codes.Z_OK, 0, 'Z_OK should be 0'); zlib.codes.Z_OK = 1; assert.equal(zlib.codes.Z_OK, 0, 'zlib.codes.Z_OK should be 0'); zlib.codes = {Z_OK: 1}; assert.equal(zlib.codes.Z_OK, 0, 'zlib.codes.Z_OK should be 0'); assert.ok(Object.isFrozen(zlib.codes), 'zlib.codes should be frozen'); node-v4.8.2/test/parallel/test-zlib-convenience-methods.js000644 000766 000024 00000003120 13070706737 023737 0ustar00iojsstaff000000 000000 'use strict'; // test convenience methods with and without options supplied require('../common'); var assert = require('assert'); var zlib = require('zlib'); var hadRun = 0; var expect = 'blahblahblahblahblahblah'; var opts = { level: 9, chunkSize: 1024, }; [ ['gzip', 'gunzip'], ['gzip', 'unzip'], ['deflate', 'inflate'], ['deflateRaw', 'inflateRaw'], ].forEach(function(method) { zlib[method[0]](expect, opts, function(err, result) { zlib[method[1]](result, opts, function(err, result) { assert.equal(result, expect, 'Should get original string after ' + method[0] + '/' + method[1] + ' with options.'); hadRun++; }); }); zlib[method[0]](expect, function(err, result) { zlib[method[1]](result, function(err, result) { assert.equal(result, expect, 'Should get original string after ' + method[0] + '/' + method[1] + ' without options.'); hadRun++; }); }); var result = zlib[method[0] + 'Sync'](expect, opts); result = zlib[method[1] + 'Sync'](result, opts); assert.equal(result, expect, 'Should get original string after ' + method[0] + '/' + method[1] + ' with options.'); hadRun++; result = zlib[method[0] + 'Sync'](expect); result = zlib[method[1] + 'Sync'](result); assert.equal(result, expect, 'Should get original string after ' + method[0] + '/' + method[1] + ' without options.'); hadRun++; }); process.on('exit', function() { assert.equal(hadRun, 16, 'expect 16 compressions'); }); node-v4.8.2/test/parallel/test-zlib-create-raw.js000644 000766 000024 00000000455 13070706737 022044 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const zlib = require('zlib'); { const inflateRaw = zlib.createInflateRaw(); assert(inflateRaw instanceof zlib.InflateRaw); } { const deflateRaw = zlib.createDeflateRaw(); assert(deflateRaw instanceof zlib.DeflateRaw); } node-v4.8.2/test/parallel/test-zlib-dictionary-fail.js000644 000766 000024 00000002455 13070706737 023072 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var zlib = require('zlib'); // Should raise an error, not trigger an assertion in src/node_zlib.cc (function() { var stream = zlib.createInflate(); stream.on('error', common.mustCall(function(err) { assert(/Missing dictionary/.test(err.message)); })); // String "test" encoded with dictionary "dict". stream.write(Buffer([0x78, 0xBB, 0x04, 0x09, 0x01, 0xA5])); })(); // Should raise an error, not trigger an assertion in src/node_zlib.cc (function() { var stream = zlib.createInflate({ dictionary: Buffer('fail') }); stream.on('error', common.mustCall(function(err) { assert(/Bad dictionary/.test(err.message)); })); // String "test" encoded with dictionary "dict". stream.write(Buffer([0x78, 0xBB, 0x04, 0x09, 0x01, 0xA5])); })(); // Should raise an error, not trigger an assertion in src/node_zlib.cc (function() { var stream = zlib.createInflateRaw({ dictionary: Buffer('fail') }); stream.on('error', common.mustCall(function(err) { // It's not possible to separate invalid dict and invalid data when using // the raw format assert(/invalid/.test(err.message)); })); // String "test" encoded with dictionary "dict". stream.write(Buffer([0x78, 0xBB, 0x04, 0x09, 0x01, 0xA5])); })(); node-v4.8.2/test/parallel/test-zlib-dictionary.js000644 000766 000024 00000006503 13070706737 022157 0ustar00iojsstaff000000 000000 'use strict'; // test compression/decompression with dictionary const common = require('../common'); const assert = require('assert'); const zlib = require('zlib'); var spdyDict = new Buffer([ 'optionsgetheadpostputdeletetraceacceptaccept-charsetaccept-encodingaccept-', 'languageauthorizationexpectfromhostif-modified-sinceif-matchif-none-matchi', 'f-rangeif-unmodifiedsincemax-forwardsproxy-authorizationrangerefererteuser', '-agent10010120020120220320420520630030130230330430530630740040140240340440', '5406407408409410411412413414415416417500501502503504505accept-rangesageeta', 'glocationproxy-authenticatepublicretry-afterservervarywarningwww-authentic', 'ateallowcontent-basecontent-encodingcache-controlconnectiondatetrailertran', 'sfer-encodingupgradeviawarningcontent-languagecontent-lengthcontent-locati', 'oncontent-md5content-rangecontent-typeetagexpireslast-modifiedset-cookieMo', 'ndayTuesdayWednesdayThursdayFridaySaturdaySundayJanFebMarAprMayJunJulAugSe', 'pOctNovDecchunkedtext/htmlimage/pngimage/jpgimage/gifapplication/xmlapplic', 'ation/xhtmltext/plainpublicmax-agecharset=iso-8859-1utf-8gzipdeflateHTTP/1', '.1statusversionurl\0' ].join('')); var deflate = zlib.createDeflate({ dictionary: spdyDict }); var input = [ 'HTTP/1.1 200 Ok', 'Server: node.js', 'Content-Length: 0', '' ].join('\r\n'); var called = 0; // // We'll use clean-new inflate stream each time // and .reset() old dirty deflate one // function run(num) { var inflate = zlib.createInflate({ dictionary: spdyDict }); if (num === 2) { deflate.reset(); deflate.removeAllListeners('data'); } // Put data into deflate stream deflate.on('data', function(chunk) { inflate.write(chunk); }); // Get data from inflate stream var output = []; inflate.on('data', function(chunk) { output.push(chunk); }); inflate.on('end', function() { called++; assert.equal(output.join(''), input); if (num < 2) run(num + 1); }); deflate.write(input); deflate.flush(function() { inflate.end(); }); } run(1); function rawDictionaryTest() { let output = ''; const deflate = zlib.createDeflateRaw({ dictionary: spdyDict }); const inflate = zlib.createInflateRaw({ dictionary: spdyDict }); deflate.on('data', function(chunk) { inflate.write(chunk); }); inflate.on('data', function(chunk) { output += chunk; }); deflate.on('end', function() { inflate.end(); }); inflate.on('end', common.mustCall(function() { assert.equal(input, output); })); deflate.write(input); deflate.end(); } function deflateRawResetDictionaryTest() { let doneReset = false; let output = ''; const deflate = zlib.createDeflateRaw({ dictionary: spdyDict }); const inflate = zlib.createInflateRaw({ dictionary: spdyDict }); deflate.on('data', function(chunk) { if (doneReset) inflate.write(chunk); }); inflate.on('data', function(chunk) { output += chunk; }); deflate.on('end', function() { inflate.end(); }); inflate.on('end', common.mustCall(function() { assert.equal(input, output); })); deflate.write(input); deflate.flush(function() { deflate.reset(); doneReset = true; deflate.write(input); deflate.end(); }); } rawDictionaryTest(); deflateRawResetDictionaryTest(); process.on('exit', function() { assert.equal(called, 2); }); node-v4.8.2/test/parallel/test-zlib-flush-drain.js000644 000766 000024 00000002211 13070706737 022216 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const zlib = require('zlib'); const bigData = new Buffer(10240).fill('x'); const opts = { level: 0, highWaterMark: 16 }; const deflater = zlib.createDeflate(opts); // shim deflater.flush so we can count times executed var flushCount = 0; var drainCount = 0; const flush = deflater.flush; deflater.flush = function(kind, callback) { flushCount++; flush.call(this, kind, callback); }; deflater.write(bigData); const ws = deflater._writableState; const beforeFlush = ws.needDrain; var afterFlush = ws.needDrain; deflater.flush(function(err) { afterFlush = ws.needDrain; }); deflater.on('drain', function() { drainCount++; }); process.once('exit', function() { assert.equal(beforeFlush, true, 'before calling flush, writable stream should need to drain'); assert.equal(afterFlush, false, 'after calling flush, writable stream should not need to drain'); assert.equal(drainCount, 1, 'the deflater should have emitted a single drain event'); assert.equal(flushCount, 2, 'flush should be called twice'); }); node-v4.8.2/test/parallel/test-zlib-flush.js000644 000766 000024 00000002041 13070706737 021124 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var zlib = require('zlib'); var path = require('path'); var fs = require('fs'); const file = fs.readFileSync(path.resolve(common.fixturesDir, 'person.jpg')); const chunkSize = 16; const opts = { level: 0 }; const deflater = zlib.createDeflate(opts); const chunk = file.slice(0, chunkSize); const expectedNone = new Buffer([0x78, 0x01]); const blkhdr = new Buffer([0x00, 0x10, 0x00, 0xef, 0xff]); const adler32 = new Buffer([0x00, 0x00, 0x00, 0xff, 0xff]); const expectedFull = Buffer.concat([blkhdr, chunk, adler32]); let actualNone; let actualFull; deflater.write(chunk, function() { deflater.flush(zlib.Z_NO_FLUSH, function() { actualNone = deflater.read(); deflater.flush(function() { var bufs = [], buf; while (buf = deflater.read()) bufs.push(buf); actualFull = Buffer.concat(bufs); }); }); }); process.once('exit', function() { assert.deepEqual(actualNone, expectedNone); assert.deepEqual(actualFull, expectedFull); }); node-v4.8.2/test/parallel/test-zlib-from-gzip.js000644 000766 000024 00000001654 13070706737 021726 0ustar00iojsstaff000000 000000 'use strict'; // test unzipping a file that was created with a non-node gzip lib, // piped in as fast as possible. var common = require('../common'); var assert = require('assert'); var zlib = require('zlib'); var path = require('path'); common.refreshTmpDir(); var gunzip = zlib.createGunzip(); var fs = require('fs'); var fixture = path.resolve(common.fixturesDir, 'person.jpg.gz'); var unzippedFixture = path.resolve(common.fixturesDir, 'person.jpg'); var outputFile = path.resolve(common.tmpDir, 'person.jpg'); var expect = fs.readFileSync(unzippedFixture); var inp = fs.createReadStream(fixture); var out = fs.createWriteStream(outputFile); inp.pipe(gunzip).pipe(out); out.on('close', function() { var actual = fs.readFileSync(outputFile); assert.equal(actual.length, expect.length, 'length should match'); for (var i = 0, l = actual.length; i < l; i++) { assert.equal(actual[i], expect[i], 'byte[' + i + ']'); } }); node-v4.8.2/test/parallel/test-zlib-from-string.js000644 000766 000024 00000006460 13070706737 022263 0ustar00iojsstaff000000 000000 'use strict'; // test compressing and uncompressing a string with zlib require('../common'); var assert = require('assert'); var zlib = require('zlib'); var inputString = 'ΩΩLorem ipsum dolor sit amet, consectetur adipiscing elit.' + ' Morbi faucibus, purus at gravida dictum, libero arcu conv' + 'allis lacus, in commodo libero metus eu nisi. Nullam commo' + 'do, neque nec porta placerat, nisi est fermentum augue, vi' + 'tae gravida tellus sapien sit amet tellus. Aenean non diam' + ' orci. Proin quis elit turpis. Suspendisse non diam ipsum.' + ' Suspendisse nec ullamcorper odio. Vestibulum arcu mi, sod' + 'ales non suscipit id, ultrices ut massa. Sed ac sem sit am' + 'et arcu malesuada fermentum. Nunc sed. '; var expectedBase64Deflate = 'eJxdUUtOQzEMvMoc4OndgT0gJCT2buJWlpI4jePeqZfpmXAK' + 'LRKbLOzx/HK73q6vOrhCunlF1qIDJhNUeW5I2ozT5OkDlKWL' + 'JWkncJG5403HQXAkT3Jw29B9uIEmToMukglZ0vS6ociBh4JG' + '8sV4oVLEUCitK2kxq1WzPnChHDzsaGKy491LofoAbWh8do43' + 'oeuYhB5EPCjcLjzYJo48KrfQBvnJecNFJvHT1+RSQsGoC7dn' + '2t/xjhduTA1NWyQIZR0pbHwMDatnD+crPqKSqGPHp1vnlsWM' + '/07ubf7bheF7kqSj84Bm0R1fYTfaK8vqqqfKBtNMhe3OZh6N' + '95CTvMX5HJJi4xOVzCgUOIMSLH7wmeOHaFE4RdpnGavKtrB5' + 'xzfO/Ll9'; var expectedBase64Gzip = 'H4sIAAAAAAAAA11RS05DMQy8yhzg6d2BPSAkJPZu4laWkjiN496' + 'pl+mZcAotEpss7PH8crverq86uEK6eUXWogMmE1R5bkjajNPk6Q' + 'OUpYslaSdwkbnjTcdBcCRPcnDb0H24gSZOgy6SCVnS9LqhyIGHg' + 'kbyxXihUsRQKK0raTGrVbM+cKEcPOxoYrLj3Uuh+gBtaHx2jjeh' + '65iEHkQ8KNwuPNgmjjwqt9AG+cl5w0Um8dPX5FJCwagLt2fa3/G' + 'OF25MDU1bJAhlHSlsfAwNq2cP5ys+opKoY8enW+eWxYz/Tu5t/t' + 'uF4XuSpKPzgGbRHV9hN9ory+qqp8oG00yF7c5mHo33kJO8xfkck' + 'mLjE5XMKBQ4gxIsfvCZ44doUThF2mcZq8q2sHnHNzRtagj5AQAA'; zlib.deflate(inputString, function(err, buffer) { assert.equal(buffer.toString('base64'), expectedBase64Deflate, 'deflate encoded string should match'); }); zlib.gzip(inputString, function(err, buffer) { // Can't actually guarantee that we'll get exactly the same // deflated bytes when we compress a string, since the header // depends on stuff other than the input string itself. // However, decrypting it should definitely yield the same // result that we're expecting, and this should match what we get // from inflating the known valid deflate data. zlib.gunzip(buffer, function(err, gunzipped) { assert.equal(gunzipped.toString(), inputString, 'Should get original string after gzip/gunzip'); }); }); var buffer = new Buffer(expectedBase64Deflate, 'base64'); zlib.unzip(buffer, function(err, buffer) { assert.equal(buffer.toString(), inputString, 'decoded inflated string should match'); }); buffer = new Buffer(expectedBase64Gzip, 'base64'); zlib.unzip(buffer, function(err, buffer) { assert.equal(buffer.toString(), inputString, 'decoded gunzipped string should match'); }); node-v4.8.2/test/parallel/test-zlib-invalid-input.js000644 000766 000024 00000002374 13070706737 022577 0ustar00iojsstaff000000 000000 'use strict'; // test uncompressing invalid input require('../common'); const assert = require('assert'); const zlib = require('zlib'); var nonStringInputs = [1, true, {a: 1}, ['a']]; console.error('Doing the non-strings'); nonStringInputs.forEach(function(input) { // zlib.gunzip should not throw an error when called with bad input. assert.doesNotThrow(function() { zlib.gunzip(input, function(err, buffer) { // zlib.gunzip should pass the error to the callback. assert.ok(err); }); }); }); console.error('Doing the unzips'); // zlib.Unzip classes need to get valid data, or else they'll throw. var unzips = [ zlib.Unzip(), zlib.Gunzip(), zlib.Inflate(), zlib.InflateRaw() ]; var hadError = []; unzips.forEach(function(uz, i) { console.error('Error for ' + uz.constructor.name); uz.on('error', function(er) { console.error('Error event', er); hadError[i] = true; }); uz.on('end', function(er) { throw new Error('end event should not be emitted ' + uz.constructor.name); }); // this will trigger error event uz.write('this is not valid compressed data.'); }); process.on('exit', function() { assert.deepEqual(hadError, [true, true, true, true], 'expect 4 errors'); }); node-v4.8.2/test/parallel/test-zlib-not-string-or-buffer.js000644 000766 000024 00000001352 13070706737 024000 0ustar00iojsstaff000000 000000 'use strict'; // Check the error condition testing for passing something other than a string // or buffer. require('../common'); const assert = require('assert'); const zlib = require('zlib'); const expected = /^TypeError: Not a string or buffer$/; assert.throws(() => { zlib.deflateSync(undefined); }, expected); assert.throws(() => { zlib.deflateSync(null); }, expected); assert.throws(() => { zlib.deflateSync(true); }, expected); assert.throws(() => { zlib.deflateSync(false); }, expected); assert.throws(() => { zlib.deflateSync(0); }, expected); assert.throws(() => { zlib.deflateSync(1); }, expected); assert.throws(() => { zlib.deflateSync([1, 2, 3]); }, expected); assert.throws(() => { zlib.deflateSync({foo: 'bar'}); }, expected); node-v4.8.2/test/parallel/test-zlib-params.js000644 000766 000024 00000001726 13070706737 021277 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var zlib = require('zlib'); var path = require('path'); var fs = require('fs'); const file = fs.readFileSync(path.resolve(common.fixturesDir, 'person.jpg')); const chunkSize = 12 * 1024; const opts = { level: 9, strategy: zlib.Z_DEFAULT_STRATEGY }; const deflater = zlib.createDeflate(opts); const chunk1 = file.slice(0, chunkSize); const chunk2 = file.slice(chunkSize); const blkhdr = new Buffer([0x00, 0x5a, 0x82, 0xa5, 0x7d]); const expected = Buffer.concat([blkhdr, chunk2]); let actual; deflater.write(chunk1, function() { deflater.params(0, zlib.Z_DEFAULT_STRATEGY, function() { while (deflater.read()); deflater.end(chunk2, function() { var bufs = [], buf; while (buf = deflater.read()) bufs.push(buf); actual = Buffer.concat(bufs); }); }); while (deflater.read()); }); process.once('exit', function() { assert.deepEqual(actual, expected); }); node-v4.8.2/test/parallel/test-zlib-random-byte-pipes.js000644 000766 000024 00000006661 13070706737 023356 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var crypto = require('crypto'); var stream = require('stream'); var Stream = stream.Stream; var util = require('util'); var zlib = require('zlib'); // emit random bytes, and keep a shasum function RandomReadStream(opt) { Stream.call(this); this.readable = true; this._paused = false; this._processing = false; this._hasher = crypto.createHash('sha1'); opt = opt || {}; // base block size. opt.block = opt.block || 256 * 1024; // total number of bytes to emit opt.total = opt.total || 256 * 1024 * 1024; this._remaining = opt.total; // how variable to make the block sizes opt.jitter = opt.jitter || 1024; this._opt = opt; this._process = this._process.bind(this); process.nextTick(this._process); } util.inherits(RandomReadStream, Stream); RandomReadStream.prototype.pause = function() { this._paused = true; this.emit('pause'); }; RandomReadStream.prototype.resume = function() { // console.error("rrs resume"); this._paused = false; this.emit('resume'); this._process(); }; RandomReadStream.prototype._process = function() { if (this._processing) return; if (this._paused) return; this._processing = true; if (!this._remaining) { this._hash = this._hasher.digest('hex').toLowerCase().trim(); this._processing = false; this.emit('end'); return; } // figure out how many bytes to output // if finished, then just emit end. var block = this._opt.block; var jitter = this._opt.jitter; if (jitter) { block += Math.ceil(Math.random() * jitter - (jitter / 2)); } block = Math.min(block, this._remaining); var buf = new Buffer(block); for (var i = 0; i < block; i++) { buf[i] = Math.random() * 256; } this._hasher.update(buf); this._remaining -= block; console.error('block=%d\nremain=%d\n', block, this._remaining); this._processing = false; this.emit('data', buf); process.nextTick(this._process); }; // a filter that just verifies a shasum function HashStream() { Stream.call(this); this.readable = this.writable = true; this._hasher = crypto.createHash('sha1'); } util.inherits(HashStream, Stream); HashStream.prototype.write = function(c) { // Simulate the way that an fs.ReadStream returns false // on *every* write like a jerk, only to resume a // moment later. this._hasher.update(c); process.nextTick(this.resume.bind(this)); return false; }; HashStream.prototype.resume = function() { this.emit('resume'); process.nextTick(this.emit.bind(this, 'drain')); }; HashStream.prototype.end = function(c) { if (c) { this.write(c); } this._hash = this._hasher.digest('hex').toLowerCase().trim(); this.emit('data', this._hash); this.emit('end'); }; var inp = new RandomReadStream({ total: 1024, block: 256, jitter: 16 }); var out = new HashStream(); var gzip = zlib.createGzip(); var gunz = zlib.createGunzip(); inp.pipe(gzip).pipe(gunz).pipe(out); inp.on('data', function(c) { console.error('inp data', c.length); }); gzip.on('data', function(c) { console.error('gzip data', c.length); }); gunz.on('data', function(c) { console.error('gunz data', c.length); }); out.on('data', function(c) { console.error('out data', c.length); }); out.on('data', common.mustCall(function(c) { console.error('hash=%s', c); assert.equal(c, inp._hash, 'hashes should match'); })); node-v4.8.2/test/parallel/test-zlib-write-after-close.js000644 000766 000024 00000000510 13070706737 023336 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var zlib = require('zlib'); zlib.gzip('hello', common.mustCall(function(err, out) { var unzip = zlib.createGunzip(); unzip.close(common.mustCall(function() {})); assert.throws(() => unzip.write(out), /^Error: zlib binding closed$/); })); node-v4.8.2/test/parallel/test-zlib-write-after-flush.js000644 000766 000024 00000001224 13070706737 023355 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var zlib = require('zlib'); var gzip = zlib.createGzip(); var gunz = zlib.createUnzip(); gzip.pipe(gunz); var output = ''; var input = 'A line of data\n'; gunz.setEncoding('utf8'); gunz.on('data', function(c) { output += c; }); process.on('exit', function() { assert.equal(output, input); // Make sure that the flush flag was set back to normal assert.equal(gzip._flushFlag, zlib.Z_NO_FLUSH); console.log('ok'); }); // make sure that flush/write doesn't trigger an assert failure gzip.flush(); write(); function write() { gzip.write(input); gzip.end(); gunz.read(0); } node-v4.8.2/test/parallel/test-zlib-zero-byte.js000644 000766 000024 00000000627 13070706737 021733 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var assert = require('assert'); var zlib = require('zlib'); var gz = zlib.Gzip(); var emptyBuffer = new Buffer(0); var received = 0; gz.on('data', function(c) { received += c.length; }); gz.on('end', common.mustCall(function() { assert.strictEqual(received, 20); })); gz.on('finish', common.mustCall(function() {})); gz.write(emptyBuffer); gz.end(); node-v4.8.2/test/parallel/test-zlib.js000644 000766 000024 00000013312 13070706737 020010 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var zlib = require('zlib'); var path = require('path'); var zlibPairs = [[zlib.Deflate, zlib.Inflate], [zlib.Gzip, zlib.Gunzip], [zlib.Deflate, zlib.Unzip], [zlib.Gzip, zlib.Unzip], [zlib.DeflateRaw, zlib.InflateRaw]]; // how fast to trickle through the slowstream var trickle = [128, 1024, 1024 * 1024]; // tunable options for zlib classes. // several different chunk sizes var chunkSize = [128, 1024, 1024 * 16, 1024 * 1024]; // this is every possible value. var level = [-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9]; var windowBits = [8, 9, 10, 11, 12, 13, 14, 15]; var memLevel = [1, 2, 3, 4, 5, 6, 7, 8, 9]; var strategy = [0, 1, 2, 3, 4]; // it's nice in theory to test every combination, but it // takes WAY too long. Maybe a pummel test could do this? if (!process.env.PUMMEL) { trickle = [1024]; chunkSize = [1024 * 16]; level = [6]; memLevel = [8]; windowBits = [15]; strategy = [0]; } var fs = require('fs'); var testFiles = ['person.jpg', 'elipses.txt', 'empty.txt']; if (process.env.FAST) { zlibPairs = [[zlib.Gzip, zlib.Unzip]]; testFiles = ['person.jpg']; } var tests = {}; testFiles.forEach(function(file) { tests[file] = fs.readFileSync(path.resolve(common.fixturesDir, file)); }); var util = require('util'); var stream = require('stream'); // stream that saves everything function BufferStream() { this.chunks = []; this.length = 0; this.writable = true; this.readable = true; } util.inherits(BufferStream, stream.Stream); BufferStream.prototype.write = function(c) { this.chunks.push(c); this.length += c.length; return true; }; BufferStream.prototype.end = function(c) { if (c) this.write(c); // flatten var buf = new Buffer(this.length); var i = 0; this.chunks.forEach(function(c) { c.copy(buf, i); i += c.length; }); this.emit('data', buf); this.emit('end'); return true; }; function SlowStream(trickle) { this.trickle = trickle; this.offset = 0; this.readable = this.writable = true; } util.inherits(SlowStream, stream.Stream); SlowStream.prototype.write = function() { throw new Error('not implemented, just call ss.end(chunk)'); }; SlowStream.prototype.pause = function() { this.paused = true; this.emit('pause'); }; SlowStream.prototype.resume = function() { const emit = () => { if (this.paused) return; if (this.offset >= this.length) { this.ended = true; return this.emit('end'); } var end = Math.min(this.offset + this.trickle, this.length); var c = this.chunk.slice(this.offset, end); this.offset += c.length; this.emit('data', c); process.nextTick(emit); }; if (this.ended) return; this.emit('resume'); if (!this.chunk) return; this.paused = false; emit(); }; SlowStream.prototype.end = function(chunk) { // walk over the chunk in blocks. this.chunk = chunk; this.length = chunk.length; this.resume(); return this.ended; }; // for each of the files, make sure that compressing and // decompressing results in the same data, for every combination // of the options set above. var failures = 0; var total = 0; var done = 0; Object.keys(tests).forEach(function(file) { var test = tests[file]; chunkSize.forEach(function(chunkSize) { trickle.forEach(function(trickle) { windowBits.forEach(function(windowBits) { level.forEach(function(level) { memLevel.forEach(function(memLevel) { strategy.forEach(function(strategy) { zlibPairs.forEach(function(pair) { var Def = pair[0]; var Inf = pair[1]; var opts = { level: level, windowBits: windowBits, memLevel: memLevel, strategy: strategy }; total++; var def = new Def(opts); var inf = new Inf(opts); var ss = new SlowStream(trickle); var buf = new BufferStream(); // verify that the same exact buffer comes out the other end. buf.on('data', function(c) { var msg = file + ' ' + chunkSize + ' ' + JSON.stringify(opts) + ' ' + Def.name + ' -> ' + Inf.name; var ok = true; var testNum = ++done; for (var i = 0; i < Math.max(c.length, test.length); i++) { if (c[i] !== test[i]) { ok = false; failures++; break; } } if (ok) { console.log('ok ' + (testNum) + ' ' + msg); } else { console.log('not ok ' + (testNum) + ' ' + msg); console.log(' ...'); console.log(' testfile: ' + file); console.log(' type: ' + Def.name + ' -> ' + Inf.name); console.log(' position: ' + i); console.log(' options: ' + JSON.stringify(opts)); console.log(' expect: ' + test[i]); console.log(' actual: ' + c[i]); console.log(' chunkSize: ' + chunkSize); console.log(' ---'); } }); // the magic happens here. ss.pipe(def).pipe(inf).pipe(buf); ss.end(test); }); }); }); }); }); }); }); // sad stallman is sad. }); process.on('exit', function(code) { console.log('1..' + done); assert.equal(done, total, (total - done) + ' tests left unfinished'); assert.ok(!failures, 'some test failures'); }); node-v4.8.2/test/parallel/testcfg.py000644 000766 000024 00000000307 13070706737 017546 0ustar00iojsstaff000000 000000 import sys, os sys.path.append(os.path.join(os.path.dirname(__file__), '..')) import testpy def GetConfiguration(context, root): return testpy.ParallelTestConfiguration(context, root, 'parallel') node-v4.8.2/test/message/2100bytes.js000644 000766 000024 00000004510 13070706736 017353 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); console.log([ '_______________________________________________50', '______________________________________________100', '______________________________________________150', '______________________________________________200', '______________________________________________250', '______________________________________________300', '______________________________________________350', '______________________________________________400', '______________________________________________450', '______________________________________________500', '______________________________________________550', '______________________________________________600', '______________________________________________650', '______________________________________________700', '______________________________________________750', '______________________________________________800', '______________________________________________850', '______________________________________________900', '______________________________________________950', '_____________________________________________1000', '_____________________________________________1050', '_____________________________________________1100', '_____________________________________________1150', '_____________________________________________1200', '_____________________________________________1250', '_____________________________________________1300', '_____________________________________________1350', '_____________________________________________1400', '_____________________________________________1450', '_____________________________________________1500', '_____________________________________________1550', '_____________________________________________1600', '_____________________________________________1650', '_____________________________________________1700', '_____________________________________________1750', '_____________________________________________1800', '_____________________________________________1850', '_____________________________________________1900', '_____________________________________________1950', '_____________________________________________2000', '_____________________________________________2050', '_____________________________________________2100' ].join('\n')); node-v4.8.2/test/message/2100bytes.out000644 000766 000024 00000004064 13070706736 017552 0ustar00iojsstaff000000 000000 _______________________________________________50 ______________________________________________100 ______________________________________________150 ______________________________________________200 ______________________________________________250 ______________________________________________300 ______________________________________________350 ______________________________________________400 ______________________________________________450 ______________________________________________500 ______________________________________________550 ______________________________________________600 ______________________________________________650 ______________________________________________700 ______________________________________________750 ______________________________________________800 ______________________________________________850 ______________________________________________900 ______________________________________________950 _____________________________________________1000 _____________________________________________1050 _____________________________________________1100 _____________________________________________1150 _____________________________________________1200 _____________________________________________1250 _____________________________________________1300 _____________________________________________1350 _____________________________________________1400 _____________________________________________1450 _____________________________________________1500 _____________________________________________1550 _____________________________________________1600 _____________________________________________1650 _____________________________________________1700 _____________________________________________1750 _____________________________________________1800 _____________________________________________1850 _____________________________________________1900 _____________________________________________1950 _____________________________________________2000 _____________________________________________2050 _____________________________________________2100 node-v4.8.2/test/message/console_low_stack_space.js000644 000766 000024 00000000655 13070706736 022613 0ustar00iojsstaff000000 000000 'use strict'; // copy console accessor because requiring ../common touches it const consoleDescriptor = Object.getOwnPropertyDescriptor(global, 'console'); delete global.console; global.console = {}; require('../common'); function a() { try { return a(); } catch (e) { const console = consoleDescriptor.get(); if (console.log) { console.log('Hello, World!'); } else { throw e; } } } a(); node-v4.8.2/test/message/console_low_stack_space.out000644 000766 000024 00000000016 13070706736 022775 0ustar00iojsstaff000000 000000 Hello, World! node-v4.8.2/test/message/core_line_numbers.js000644 000766 000024 00000001015 13070706736 021411 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const punycode = require('punycode'); // This test verifies that line numbers in core modules are reported correctly. // The punycode module was chosen for testing because it changes infrequently. // If this test begins failing, it is likely due to a punycode update, and the // test's assertions simply need to be updated to reflect the changes. If a // punycode update was not made, and this test begins failing, then line numbers // are probably actually broken. punycode.decode('x'); node-v4.8.2/test/message/core_line_numbers.out000644 000766 000024 00000000751 13070706736 021612 0ustar00iojsstaff000000 000000 punycode.js:67 throw new RangeError(errors[type]); ^ RangeError: Invalid input at error (punycode.js:67:*) at Object.decode (punycode.js:*:*) at Object. (*test*message*core_line_numbers.js:*:*) at Module._compile (module.js:*:*) at Object.Module._extensions..js (module.js:*:*) at Module.load (module.js:*:*) at Function.Module._load (module.js:*:*) at Function.Module.runMain (module.js:*:*) at startup (node.js:*:*) at node.js:*:* node-v4.8.2/test/message/error_exit.js000644 000766 000024 00000000261 13070706736 020103 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); process.on('exit', function(code) { console.error('Exiting with code=%d', code); }); assert.equal(1, 2); node-v4.8.2/test/message/error_exit.out000644 000766 000024 00000000647 13070706736 020306 0ustar00iojsstaff000000 000000 Exiting with code=1 assert.js:* throw new assert.AssertionError({ ^ AssertionError: 1 == 2 at Object. (*test*message*error_exit.js:*:*) at Module._compile (module.js:*:*) at Object.Module._extensions..js (module.js:*:*) at Module.load (module.js:*:*) at Function.Module._load (module.js:*:*) at Function.Module.runMain (module.js:*:*) at startup (node.js:*:*) at node.js:*:* node-v4.8.2/test/message/eval_messages.js000644 000766 000024 00000001240 13070706736 020535 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var spawn = require('child_process').spawn; function run(cmd, strict, cb) { var args = []; if (strict) args.push('--use_strict'); args.push('-pe', cmd); var child = spawn(process.execPath, args); child.stdout.pipe(process.stdout); child.stderr.pipe(process.stdout); child.on('close', cb); } var queue = [ 'with(this){__filename}', '42', 'throw new Error("hello")', 'var x = 100; y = x;', 'var ______________________________________________; throw 10' ]; function go() { var c = queue.shift(); if (!c) return console.log('done'); run(c, false, function() { run(c, true, go); }); } go(); node-v4.8.2/test/message/eval_messages.out000644 000766 000024 00000003060 13070706736 020732 0ustar00iojsstaff000000 000000 [eval] [eval]:1 with(this){__filename} ^^^^ SyntaxError: Strict mode code may not include a with statement at Object.exports.runInThisContext (vm.js:*) at Object. ([eval]-wrapper:*:*) at Module._compile (module.js:*:*) at node.js:*:* at nextTickCallbackWith0Args (node.js:*:*) at process._tickCallback (node.js:*:*) 42 42 [eval]:1 throw new Error("hello") ^ Error: hello at [eval]:1:7 at Object.exports.runInThisContext (vm.js:*) at Object. ([eval]-wrapper:*:*) at Module._compile (module.js:*:*) at node.js:*:* at nextTickCallbackWith0Args (node.js:*:*) at process._tickCallback (node.js:*:*) [eval]:1 throw new Error("hello") ^ Error: hello at [eval]:1:7 at Object.exports.runInThisContext (vm.js:*) at Object. ([eval]-wrapper:*:*) at Module._compile (module.js:*:*) at node.js:*:* at nextTickCallbackWith0Args (node.js:*:*) at process._tickCallback (node.js:*:*) 100 [eval]:1 var x = 100; y = x; ^ ReferenceError: y is not defined at [eval]:1:16 at Object.exports.runInThisContext (vm.js:*) at Object. ([eval]-wrapper:*:*) at Module._compile (module.js:*:*) at node.js:*:* at nextTickCallbackWith0Args (node.js:*:*) at process._tickCallback (node.js:*:*) [eval]:1 var ______________________________________________; throw 10 ^ 10 [eval]:1 var ______________________________________________; throw 10 ^ 10 done node-v4.8.2/test/message/hello_world.js000644 000766 000024 00000000101 13070706736 020224 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); console.log('hello world'); node-v4.8.2/test/message/hello_world.out000644 000766 000024 00000000014 13070706736 020422 0ustar00iojsstaff000000 000000 hello world node-v4.8.2/test/message/max_tick_depth.js000644 000766 000024 00000000267 13070706736 020712 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); process.maxTickDepth = 10; var i = 20; process.nextTick(function f() { console.error('tick %d', i); if (i-- > 0) process.nextTick(f); }); node-v4.8.2/test/message/max_tick_depth.out000644 000766 000024 00000000236 13070706736 021101 0ustar00iojsstaff000000 000000 tick 20 tick 19 tick 18 tick 17 tick 16 tick 15 tick 14 tick 13 tick 12 tick 11 tick 10 tick 9 tick 8 tick 7 tick 6 tick 5 tick 4 tick 3 tick 2 tick 1 tick 0 node-v4.8.2/test/message/message.status000644 000766 000024 00000000560 13070706736 020256 0ustar00iojsstaff000000 000000 prefix message # To mark a test as flaky, list the test name in the appropriate section # below, without ".js", followed by ": PASS,FLAKY". Example: # sample-test : PASS,FLAKY [true] # This section applies to all platforms [$system==win32] [$system==linux] [$system==macos] [$system==solaris] # Also applies to SmartOS [$system==freebsd] node-v4.8.2/test/message/nexttick_throw.js000644 000766 000024 00000000422 13070706736 020774 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); process.nextTick(function() { process.nextTick(function() { process.nextTick(function() { process.nextTick(function() { // eslint-disable-next-line undefined_reference_error_maker; }); }); }); }); node-v4.8.2/test/message/nexttick_throw.out000644 000766 000024 00000000571 13070706736 021174 0ustar00iojsstaff000000 000000 *test*message*nexttick_throw.js:* undefined_reference_error_maker; ^ ReferenceError: undefined_reference_error_maker is not defined at *test*message*nexttick_throw.js:*:* at nextTickCallbackWith0Args (node.js:*:*) at process._tickCallback (node.js:*:*) at Function.Module.runMain (module.js:*:*) at startup (node.js:*:*) at node.js:*:* node-v4.8.2/test/message/stack_overflow.js000644 000766 000024 00000000307 13070706736 020752 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); Error.stackTraceLimit = 0; console.error('before'); // stack overflow function stackOverflow() { stackOverflow(); } stackOverflow(); console.error('after'); node-v4.8.2/test/message/stack_overflow.out000644 000766 000024 00000000212 13070706736 021140 0ustar00iojsstaff000000 000000 before *test*message*stack_overflow.js:* function stackOverflow() { ^ RangeError: Maximum call stack size exceeded node-v4.8.2/test/message/stdin_messages.js000644 000766 000024 00000001262 13070706736 020733 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var spawn = require('child_process').spawn; function run(cmd, strict, cb) { var args = []; if (strict) args.push('--use_strict'); args.push('-p'); var child = spawn(process.execPath, args); child.stdout.pipe(process.stdout); child.stderr.pipe(process.stdout); child.stdin.end(cmd); child.on('close', cb); } var queue = [ 'with(this){__filename}', '42', 'throw new Error("hello")', 'var x = 100; y = x;', 'var ______________________________________________; throw 10' ]; function go() { var c = queue.shift(); if (!c) return console.log('done'); run(c, false, function() { run(c, true, go); }); } go(); node-v4.8.2/test/message/stdin_messages.out000644 000766 000024 00000003104 13070706736 021123 0ustar00iojsstaff000000 000000 [stdin] [stdin]:1 with(this){__filename} ^^^^ SyntaxError: Strict mode code may not include a with statement at Object.exports.runInThisContext (vm.js:*) at Object. ([stdin]-wrapper:*:*) at Module._compile (module.js:*:*) at node.js:*:* at nextTickCallbackWith0Args (node.js:*:*) at process._tickCallback (node.js:*:*) 42 42 [stdin]:1 throw new Error("hello") ^ Error: hello at [stdin]:1:* at Object.exports.runInThisContext (vm.js:*) at Object. ([stdin]-wrapper:*:*) at Module._compile (module.js:*:*) at node.js:*:* at nextTickCallbackWith0Args (node.js:*:*) at process._tickCallback (node.js:*:*) [stdin]:1 throw new Error("hello") ^ Error: hello at [stdin]:1:* at Object.exports.runInThisContext (vm.js:*) at Object. ([stdin]-wrapper:*:*) at Module._compile (module.js:*:*) at node.js:*:* at nextTickCallbackWith0Args (node.js:*:*) at process._tickCallback (node.js:*:*) 100 [stdin]:1 var x = 100; y = x; ^ ReferenceError: y is not defined at [stdin]:1:16 at Object.exports.runInThisContext (vm.js:*) at Object. ([stdin]-wrapper:*:*) at Module._compile (module.js:*:*) at node.js:*:* at nextTickCallbackWith0Args (node.js:*:*) at process._tickCallback (node.js:*:*) [stdin]:1 var ______________________________________________; throw 10 ^ 10 [stdin]:1 var ______________________________________________; throw 10 ^ 10 done node-v4.8.2/test/message/testcfg.py000644 000766 000024 00000012341 13070706736 017376 0ustar00iojsstaff000000 000000 # Copyright 2008 the V8 project authors. All rights reserved. # Redistribution and use in source and binary forms, with or without # modification, are permitted provided that the following conditions are # met: # # * Redistributions of source code must retain the above copyright # notice, this list of conditions and the following disclaimer. # * Redistributions in binary form must reproduce the above # copyright notice, this list of conditions and the following # disclaimer in the documentation and/or other materials provided # with the distribution. # * Neither the name of Google Inc. nor the names of its # contributors may be used to endorse or promote products derived # from this software without specific prior written permission. # # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. import test import os from os.path import join, dirname, exists, basename, isdir import re FLAGS_PATTERN = re.compile(r"//\s+Flags:(.*)") class MessageTestCase(test.TestCase): def __init__(self, path, file, expected, arch, mode, context, config): super(MessageTestCase, self).__init__(context, path, arch, mode) self.file = file self.expected = expected self.config = config self.arch = arch self.mode = mode def IgnoreLine(self, str): """Ignore empty lines and valgrind output.""" if not str.strip(): return True else: return str.startswith('==') or str.startswith('**') def IsFailureOutput(self, output): f = file(self.expected) # Skip initial '#' comment and spaces #for line in f: # if (not line.startswith('#')) and (not line.strip()): # break # Convert output lines to regexps that we can match env = { 'basename': basename(self.file) } patterns = [ ] for line in f: if not line.strip(): continue pattern = re.escape(line.rstrip() % env) pattern = pattern.replace('\\*', '.*') pattern = '^%s$' % pattern patterns.append(pattern) # Compare actual output with the expected raw_lines = (output.stdout + output.stderr).split('\n') outlines = [ s for s in raw_lines if not self.IgnoreLine(s) ] if len(outlines) != len(patterns): print "length differs." print "expect=%d" % len(patterns) print "actual=%d" % len(outlines) print "patterns:" for i in xrange(len(patterns)): print "pattern = %s" % patterns[i] print "outlines:" for i in xrange(len(outlines)): print "outline = %s" % outlines[i] return True for i in xrange(len(patterns)): if not re.match(patterns[i], outlines[i]): print "match failed" print "line=%d" % i print "expect=%s" % patterns[i] print "actual=%s" % outlines[i] return True return False def GetLabel(self): return "%s %s" % (self.mode, self.GetName()) def GetName(self): return self.path[-1] def GetCommand(self): result = [self.config.context.GetVm(self.arch, self.mode)] source = open(self.file).read() flags_match = FLAGS_PATTERN.search(source) if flags_match: result += flags_match.group(1).strip().split() result.append(self.file) return result def GetSource(self): return (open(self.file).read() + "\n--- expected output ---\n" + open(self.expected).read()) class MessageTestConfiguration(test.TestConfiguration): def __init__(self, context, root): super(MessageTestConfiguration, self).__init__(context, root) def Ls(self, path): if isdir(path): return [f[:-3] for f in os.listdir(path) if f.endswith('.js')] else: return [] def ListTests(self, current_path, path, arch, mode): all_tests = [current_path + [t] for t in self.Ls(self.root)] result = [] for test in all_tests: if self.Contains(path, test): file_prefix = join(self.root, reduce(join, test[1:], "")) file_path = file_prefix + ".js" output_path = file_prefix + ".out" if not exists(output_path): raise Exception("Could not find %s" % output_path) result.append(MessageTestCase(test, file_path, output_path, arch, mode, self.context, self)) return result def GetBuildRequirements(self): return ['sample', 'sample=shell'] def GetTestStatus(self, sections, defs): status_file = join(self.root, 'message.status') if exists(status_file): test.ReadConfigurationInto(status_file, sections, defs) def GetConfiguration(context, root): return MessageTestConfiguration(context, root) node-v4.8.2/test/message/throw_custom_error.js000644 000766 000024 00000000206 13070706736 021666 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); // custom error throwing throw ({ name: 'MyCustomError', message: 'This is a custom message' }); node-v4.8.2/test/message/throw_custom_error.out000644 000766 000024 00000000230 13070706736 022056 0ustar00iojsstaff000000 000000 *test*message*throw_custom_error.js:5 throw ({ name: 'MyCustomError', message: 'This is a custom message' }); ^ MyCustomError: This is a custom message node-v4.8.2/test/message/throw_in_line_with_tabs.js000644 000766 000024 00000000305 13070706736 022624 0ustar00iojsstaff000000 000000 /* eslint-disable indent */ 'use strict'; require('../common'); console.error('before'); (function() { // these lines should contain tab! throw ({ foo: 'bar' }); })(); console.error('after'); node-v4.8.2/test/message/throw_in_line_with_tabs.out000644 000766 000024 00000000136 13070706736 023021 0ustar00iojsstaff000000 000000 before *test*message*throw_in_line_with_tabs.js:9 throw ({ foo: 'bar' }); ^ [object Object] node-v4.8.2/test/message/throw_non_error.js000644 000766 000024 00000000126 13070706736 021147 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); // custom error throwing throw ({ foo: 'bar' }); node-v4.8.2/test/message/throw_non_error.out000644 000766 000024 00000000115 13070706736 021340 0ustar00iojsstaff000000 000000 *test*message*throw_non_error.js:5 throw ({ foo: 'bar' }); ^ [object Object] node-v4.8.2/test/message/throw_null.js000644 000766 000024 00000000061 13070706736 020114 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); throw null; node-v4.8.2/test/message/throw_null.out000644 000766 000024 00000000062 13070706736 020310 0ustar00iojsstaff000000 000000 *test*message*throw_null.js:4 throw null; ^ null node-v4.8.2/test/message/throw_undefined.js000644 000766 000024 00000000066 13070706736 021110 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); throw undefined; node-v4.8.2/test/message/throw_undefined.out000644 000766 000024 00000000101 13070706736 021271 0ustar00iojsstaff000000 000000 *test*message*throw_undefined.js:4 throw undefined; ^ undefined node-v4.8.2/test/message/timeout_throw.js000644 000766 000024 00000000213 13070706736 020627 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); setTimeout(function() { // eslint-disable-next-line no-undef undefined_reference_error_maker; }); node-v4.8.2/test/message/timeout_throw.out000644 000766 000024 00000000356 13070706736 021032 0ustar00iojsstaff000000 000000 *test*message*timeout_throw.js:* undefined_reference_error_maker; ^ ReferenceError: undefined_reference_error_maker is not defined at null._onTimeout (*test*message*timeout_throw.js:*:*) at Timer.listOnTimeout (timers.js:*:*) node-v4.8.2/test/message/undefined_reference_in_new_context.js000644 000766 000024 00000000253 13070706736 025004 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var vm = require('vm'); console.error('before'); // undefined reference vm.runInNewContext('foo.bar = 5;'); console.error('after'); node-v4.8.2/test/message/undefined_reference_in_new_context.out000644 000766 000024 00000001014 13070706736 025173 0ustar00iojsstaff000000 000000 before evalmachine.:1 foo.bar = 5; ^ ReferenceError: foo is not defined at evalmachine.:1:1 at ContextifyScript.Script.runInNewContext (vm.js:*) at Object.exports.runInNewContext (vm.js:*) at Object. (*test*message*undefined_reference_in_new_context.js:*) at Module._compile (module.js:*) at *..js (module.js:*) at Module.load (module.js:*) at Function.Module._load (module.js:*:*) at Function.Module.runMain (module.js:*:*) at startup (node.js:*:*) node-v4.8.2/test/message/vm_caught_custom_runtime_error.js000644 000766 000024 00000000707 13070706736 024251 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const vm = require('vm'); console.error('beginning'); // Regression test for https://github.com/nodejs/node/issues/7397: // vm.runInThisContext() should not print out anything to stderr by itself. try { vm.runInThisContext(`throw ({ name: 'MyCustomError', message: 'This is a custom message' })`, { filename: 'test.vm' }); } catch (e) { console.error('received error', e.name); } console.error('end'); node-v4.8.2/test/message/vm_caught_custom_runtime_error.out000644 000766 000024 00000000053 13070706736 024436 0ustar00iojsstaff000000 000000 beginning received error MyCustomError end node-v4.8.2/test/message/vm_display_runtime_error.js000644 000766 000024 00000000272 13070706736 023046 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var vm = require('vm'); console.error('beginning'); vm.runInThisContext('throw new Error("boo!")', { filename: 'test.vm' }); console.error('end'); node-v4.8.2/test/message/vm_display_runtime_error.out000644 000766 000024 00000000704 13070706736 023241 0ustar00iojsstaff000000 000000 beginning test.vm:1 throw new Error("boo!") ^ Error: boo! at test.vm:1:7 at Object.exports.runInThisContext (vm.js:*) at Object. (*test*message*vm_display_runtime_error.js:*) at Module._compile (module.js:*) at Object.Module._extensions..js (module.js:*) at Module.load (module.js:*) at Function.Module._load (module.js:*) at Function.Module.runMain (module.js:*) at startup (node.js:*) at node.js:* node-v4.8.2/test/message/vm_display_syntax_error.js000644 000766 000024 00000000251 13070706736 022706 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var vm = require('vm'); console.error('beginning'); vm.runInThisContext('var 5;', { filename: 'test.vm' }); console.error('end'); node-v4.8.2/test/message/vm_display_syntax_error.out000644 000766 000024 00000000664 13070706736 023111 0ustar00iojsstaff000000 000000 beginning test.vm:1 var 5; ^^^ SyntaxError: Unexpected number at Object.exports.runInThisContext (vm.js:*) at Object. (*test*message*vm_display_syntax_error.js:*) at Module._compile (module.js:*) at Object.Module._extensions..js (module.js:*) at Module.load (module.js:*) at Function.Module._load (module.js:*) at Function.Module.runMain (module.js:*) at startup (node.js:*) at node.js:* node-v4.8.2/test/message/vm_dont_display_runtime_error.js000644 000766 000024 00000000557 13070706736 024100 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var vm = require('vm'); console.error('beginning'); try { vm.runInThisContext('throw new Error("boo!")', { filename: 'test.vm', displayErrors: false }); } catch (e) {} console.error('middle'); vm.runInThisContext('throw new Error("boo!")', { filename: 'test.vm', displayErrors: false }); console.error('end'); node-v4.8.2/test/message/vm_dont_display_runtime_error.out000644 000766 000024 00000000717 13070706736 024271 0ustar00iojsstaff000000 000000 beginning middle test.vm:1 throw new Error("boo!") ^ Error: boo! at test.vm:1:7 at Object.exports.runInThisContext (vm.js:*) at Object. (*test*message*vm_dont_display_runtime_error.js:*) at Module._compile (module.js:*) at Object.Module._extensions..js (module.js:*) at Module.load (module.js:*) at Function.Module._load (module.js:*) at Function.Module.runMain (module.js:*) at startup (node.js:*) at node.js:* node-v4.8.2/test/message/vm_dont_display_syntax_error.js000644 000766 000024 00000000515 13070706736 023735 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var vm = require('vm'); console.error('beginning'); try { vm.runInThisContext('var 5;', { filename: 'test.vm', displayErrors: false }); } catch (e) {} console.error('middle'); vm.runInThisContext('var 5;', { filename: 'test.vm', displayErrors: false }); console.error('end'); node-v4.8.2/test/message/vm_dont_display_syntax_error.out000644 000766 000024 00000000677 13070706736 024141 0ustar00iojsstaff000000 000000 beginning middle test.vm:1 var 5; ^^^ SyntaxError: Unexpected number at Object.exports.runInThisContext (vm.js:*) at Object. (*test*message*vm_dont_display_syntax_error.js:*) at Module._compile (module.js:*) at Object.Module._extensions..js (module.js:*) at Module.load (module.js:*) at Function.Module._load (module.js:*) at Function.Module.runMain (module.js:*) at startup (node.js:*) at node.js:* node-v4.8.2/test/known_issues/known_issues.status000644 000766 000024 00000000634 13070706736 022466 0ustar00iojsstaff000000 000000 prefix known_issues # If a known issue does not apply to a platform, list the test name in the # appropriate section below, without ".js", followed by ": SKIP". Example: # sample-test : SKIP [true] # This section applies to all platforms [$system==win32] test-stdout-buffer-flush-on-exit: SKIP [$system==linux] [$system==macos] [$system==solaris] [$system==freebsd] [$system==aix] node-v4.8.2/test/known_issues/test-events-known-properties.js000644 000766 000024 00000000477 13070706736 024642 0ustar00iojsstaff000000 000000 'use strict'; // Refs: https://github.com/nodejs/node/issues/728 const common = require('../common'); const assert = require('assert'); const EventEmitter = require('events'); const ee = new EventEmitter(); ee.on('__proto__', common.mustCall((data) => { assert.strictEqual(data, 42); })); ee.emit('__proto__', 42); node-v4.8.2/test/known_issues/test-module-deleted-extensions.js000644 000766 000024 00000001142 13070706736 025066 0ustar00iojsstaff000000 000000 'use strict'; // Refs: https://github.com/nodejs/node/issues/4778 const common = require('../common'); const assert = require('assert'); const fs = require('fs'); const path = require('path'); const file = path.join(common.tmpDir, 'test-extensions.foo.bar'); common.refreshTmpDir(); fs.writeFileSync(file, '', 'utf8'); require.extensions['.foo.bar'] = (module, path) => {}; delete require.extensions['.foo.bar']; require.extensions['.bar'] = common.mustCall((module, path) => { assert.strictEqual(module.id, file); assert.strictEqual(path, file); }); require(path.join(common.tmpDir, 'test-extensions')); node-v4.8.2/test/known_issues/test-process-external-stdio-close.js000644 000766 000024 00000001206 13070706736 025522 0ustar00iojsstaff000000 000000 'use strict'; // Refs: https://github.com/nodejs/node/issues/947 const common = require('../common'); const assert = require('assert'); const cp = require('child_process'); if (process.argv[2] === 'child') { process.on('message', common.mustCall((msg) => { assert.strictEqual(msg, 'go'); console.log('logging should not cause a crash'); process.disconnect(); })); } else { const child = cp.fork(__filename, ['child'], {silent: true}); child.on('close', common.mustCall((exitCode, signal) => { assert.strictEqual(exitCode, 0); assert.strictEqual(signal, null); })); child.stdout.destroy(); child.send('go'); } node-v4.8.2/test/known_issues/test-stdin-is-always-net.socket.js000644 000766 000024 00000001120 13070706736 025077 0ustar00iojsstaff000000 000000 'use strict'; // Refs: https://github.com/nodejs/node/pull/5916 const common = require('../common'); const assert = require('assert'); const spawn = require('child_process').spawn; const net = require('net'); if (process.argv[2] === 'child') { assert(process.stdin instanceof net.Socket); return; } const proc = spawn(process.execPath, [__filename, 'child'], {stdio: 'ignore'}); // To double-check this test, set stdio to 'pipe' and uncomment the line below. // proc.stderr.pipe(process.stderr); proc.on('exit', common.mustCall(function(exitCode) { process.exitCode = exitCode; })); node-v4.8.2/test/known_issues/test-stdout-buffer-flush-on-exit.js000644 000766 000024 00000001431 13070706736 025272 0ustar00iojsstaff000000 000000 'use strict'; // Refs: https://github.com/nodejs/node/issues/2148 require('../common'); const assert = require('assert'); const execSync = require('child_process').execSync; const lineSeed = 'foo bar baz quux quuz aaa bbb ccc'; if (process.argv[2] === 'child') { const longLine = lineSeed.repeat(parseInt(process.argv[4], 10)); process.on('exit', () => { console.log(longLine); }); process.exit(); } [22, 21, 20, 19, 18, 17, 16, 16, 17, 18, 19, 20, 21, 22].forEach((exponent) => { const bigNum = Math.pow(2, exponent); const longLine = lineSeed.repeat(bigNum); const cmd = `${process.execPath} ${__filename} child ${exponent} ${bigNum}`; const stdout = execSync(cmd).toString().trim(); assert.strictEqual(stdout, longLine, `failed with exponent ${exponent}`); }); node-v4.8.2/test/known_issues/test-vm-attributes-property-not-on-sandbox.js000644 000766 000024 00000001646 13070706736 027345 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const vm = require('vm'); // The QueryCallback explicitly calls GetRealNamedPropertyAttributes // on the global proxy if the property is not found on the sandbox. // // foo is not defined on the sandbox until we call CopyProperties(). // In the QueryCallback, we do not find the property on the sandbox // and look up its PropertyAttributes on the global_proxy(). // PropertyAttributes are always flattened to a value // descriptor. const sandbox = {}; vm.createContext(sandbox); const code = `Object.defineProperty( this, 'foo', { get: function() {return 17} } ); var desc = Object.getOwnPropertyDescriptor(this, 'foo');`; vm.runInContext(code, sandbox); // The descriptor is flattened. We wrongly have typeof desc.value = 'number'. assert.strictEqual(typeof sandbox.desc.get, 'function'); node-v4.8.2/test/known_issues/test-vm-data-property-writable.js000644 000766 000024 00000000615 13070706736 025026 0ustar00iojsstaff000000 000000 'use strict'; // Refs: https://github.com/nodejs/node/issues/10223 require('../common'); const vm = require('vm'); const assert = require('assert'); const context = vm.createContext({}); const code = ` Object.defineProperty(this, 'foo', {value: 5}); Object.getOwnPropertyDescriptor(this, 'foo'); `; const desc = vm.runInContext(code, context); assert.strictEqual(desc.writable, false); node-v4.8.2/test/known_issues/test-vm-function-redefinition.js000644 000766 000024 00000000600 13070706736 024720 0ustar00iojsstaff000000 000000 'use strict'; // Refs: https://github.com/nodejs/node/issues/548 require('../common'); const assert = require('assert'); const vm = require('vm'); const context = vm.createContext(); vm.runInContext('function test() { return 0; }', context); vm.runInContext('function test() { return 1; }', context); const result = vm.runInContext('test()', context); assert.strictEqual(result, 1); node-v4.8.2/test/known_issues/test-vm-getters.js000644 000766 000024 00000000776 13070706736 022111 0ustar00iojsstaff000000 000000 'use strict'; // Refs: https://github.com/nodejs/node/issues/2734 require('../common'); const assert = require('assert'); const vm = require('vm'); const sandbox = {}; Object.defineProperty(sandbox, 'prop', { get() { return 'foo'; } }); const descriptor = Object.getOwnPropertyDescriptor(sandbox, 'prop'); const context = vm.createContext(sandbox); const code = 'Object.getOwnPropertyDescriptor(this, "prop");'; const result = vm.runInContext(code, context); assert.strictEqual(result, descriptor); node-v4.8.2/test/known_issues/testcfg.py000644 000766 000024 00000000311 13070706736 020473 0ustar00iojsstaff000000 000000 import sys, os sys.path.append(os.path.join(os.path.dirname(__file__), '..')) import testpy def GetConfiguration(context, root): return testpy.SimpleTestConfiguration(context, root, 'known_issues') node-v4.8.2/test/internet/test-dgram-broadcast-multi-process.js000644 000766 000024 00000014356 13070706736 024752 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const dgram = require('dgram'); const util = require('util'); const networkInterfaces = require('os').networkInterfaces(); const Buffer = require('buffer').Buffer; const fork = require('child_process').fork; const LOCAL_BROADCAST_HOST = '255.255.255.255'; const TIMEOUT = common.platformTimeout(5000); const messages = [ new Buffer('First message to send'), new Buffer('Second message to send'), new Buffer('Third message to send'), new Buffer('Fourth message to send') ]; if (common.inFreeBSDJail) { common.skip('in a FreeBSD jail'); return; } // take the first non-internal interface as the address for binding get_bindAddress: for (var name in networkInterfaces) { var interfaces = networkInterfaces[name]; for (var i = 0; i < interfaces.length; i++) { var localInterface = interfaces[i]; if (!localInterface.internal && localInterface.family === 'IPv4') { var bindAddress = localInterface.address; break get_bindAddress; } } } assert.ok(bindAddress); if (process.argv[2] !== 'child') { const workers = {}; const listeners = 3; let listening = 0; let dead = 0; let i = 0; let done = 0; let timer = null; //exit the test if it doesn't succeed within TIMEOUT timer = setTimeout(function() { console.error('[PARENT] Responses were not received within %d ms.', TIMEOUT); console.error('[PARENT] Fail'); killChildren(workers); process.exit(1); }, TIMEOUT); //launch child processes for (var x = 0; x < listeners; x++) { (function() { var worker = fork(process.argv[1], ['child']); workers[worker.pid] = worker; worker.messagesReceived = []; //handle the death of workers worker.on('exit', function(code, signal) { // don't consider this the true death if the worker // has finished successfully // or if the exit code is 0 if (worker.isDone || code == 0) { return; } dead += 1; console.error('[PARENT] Worker %d died. %d dead of %d', worker.pid, dead, listeners); if (dead === listeners) { console.error('[PARENT] All workers have died.'); console.error('[PARENT] Fail'); killChildren(workers); process.exit(1); } }); worker.on('message', function(msg) { if (msg.listening) { listening += 1; if (listening === listeners) { //all child process are listening, so start sending sendSocket.sendNext(); } } else if (msg.message) { worker.messagesReceived.push(msg.message); if (worker.messagesReceived.length === messages.length) { done += 1; worker.isDone = true; console.error('[PARENT] %d received %d messages total.', worker.pid, worker.messagesReceived.length); } if (done === listeners) { console.error('[PARENT] All workers have received the ' + 'required number of ' + 'messages. Will now compare.'); Object.keys(workers).forEach(function(pid) { var worker = workers[pid]; var count = 0; worker.messagesReceived.forEach(function(buf) { for (var i = 0; i < messages.length; ++i) { if (buf.toString() === messages[i].toString()) { count++; break; } } }); console.error('[PARENT] %d received %d matching messges.', worker.pid, count); assert.equal(count, messages.length, 'A worker received an invalid multicast message'); }); clearTimeout(timer); console.error('[PARENT] Success'); killChildren(workers); } } }); })(x); } var sendSocket = dgram.createSocket({ type: 'udp4', reuseAddr: true }); // bind the address explicitly for sending // INADDR_BROADCAST to only one interface sendSocket.bind(common.PORT, bindAddress); sendSocket.on('listening', function() { sendSocket.setBroadcast(true); }); sendSocket.on('close', function() { console.error('[PARENT] sendSocket closed'); }); sendSocket.sendNext = function() { var buf = messages[i++]; if (!buf) { try { sendSocket.close(); } catch (e) {} return; } sendSocket.send( buf, 0, buf.length, common.PORT, LOCAL_BROADCAST_HOST, function(err) { if (err) throw err; console.error('[PARENT] sent %s to %s:%s', util.inspect(buf.toString()), LOCAL_BROADCAST_HOST, common.PORT); process.nextTick(sendSocket.sendNext); } ); }; function killChildren(children) { Object.keys(children).forEach(function(key) { var child = children[key]; child.kill(); }); } } if (process.argv[2] === 'child') { var receivedMessages = []; var listenSocket = dgram.createSocket({ type: 'udp4', reuseAddr: true }); listenSocket.on('message', function(buf, rinfo) { // receive udp messages only sent from parent if (rinfo.address !== bindAddress) return; console.error('[CHILD] %s received %s from %j', process.pid, util.inspect(buf.toString()), rinfo); receivedMessages.push(buf); process.send({ message: buf.toString() }); if (receivedMessages.length == messages.length) { process.nextTick(function() { listenSocket.close(); }); } }); listenSocket.on('close', function() { //HACK: Wait to exit the process to ensure that the parent //process has had time to receive all messages via process.send() //This may be indicitave of some other issue. setTimeout(function() { process.exit(); }, 1000); }); listenSocket.on('listening', function() { process.send({ listening: true }); }); listenSocket.bind(common.PORT); } node-v4.8.2/test/internet/test-dgram-multicast-multi-process.js000644 000766 000024 00000012735 13070706736 025014 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const dgram = require('dgram'); const fork = require('child_process').fork; const LOCAL_BROADCAST_HOST = '224.0.0.114'; const TIMEOUT = common.platformTimeout(5000); const messages = [ new Buffer('First message to send'), new Buffer('Second message to send'), new Buffer('Third message to send'), new Buffer('Fourth message to send') ]; const workers = {}; const listeners = 3; // Skip test in FreeBSD jails. if (common.inFreeBSDJail) { common.skip('In a FreeBSD jail'); return; } function launchChildProcess() { const worker = fork(__filename, ['child']); workers[worker.pid] = worker; worker.messagesReceived = []; // Handle the death of workers. worker.on('exit', function(code) { // Don't consider this the true death if the worker has finished // successfully or if the exit code is 0. if (worker.isDone || code === 0) { return; } dead += 1; console.error('[PARENT] Worker %d died. %d dead of %d', worker.pid, dead, listeners); if (dead === listeners) { console.error('[PARENT] All workers have died.'); console.error('[PARENT] Fail'); process.exit(1); } }); worker.on('message', function(msg) { if (msg.listening) { listening += 1; if (listening === listeners) { // All child process are listening, so start sending. sendSocket.sendNext(); } return; } if (msg.message) { worker.messagesReceived.push(msg.message); if (worker.messagesReceived.length === messages.length) { done += 1; worker.isDone = true; console.error('[PARENT] %d received %d messages total.', worker.pid, worker.messagesReceived.length); } if (done === listeners) { console.error('[PARENT] All workers have received the ' + 'required number of messages. Will now compare.'); Object.keys(workers).forEach(function(pid) { const worker = workers[pid]; var count = 0; worker.messagesReceived.forEach(function(buf) { for (var i = 0; i < messages.length; ++i) { if (buf.toString() === messages[i].toString()) { count++; break; } } }); console.error('[PARENT] %d received %d matching messages.', worker.pid, count); assert.strictEqual(count, messages.length, 'A worker received an invalid multicast message'); }); clearTimeout(timer); console.error('[PARENT] Success'); killChildren(workers); } } }); } function killChildren(children) { Object.keys(children).forEach(function(key) { const child = children[key]; child.kill(); }); } if (process.argv[2] !== 'child') { var listening = 0; var dead = 0; var i = 0; var done = 0; // Exit the test if it doesn't succeed within TIMEOUT. var timer = setTimeout(function() { console.error('[PARENT] Responses were not received within %d ms.', TIMEOUT); console.error('[PARENT] Fail'); killChildren(workers); process.exit(1); }, TIMEOUT); // Launch child processes. for (var x = 0; x < listeners; x++) { launchChildProcess(x); } var sendSocket = dgram.createSocket('udp4'); // The socket is actually created async now. sendSocket.on('listening', function() { sendSocket.setTTL(1); sendSocket.setBroadcast(true); sendSocket.setMulticastTTL(1); sendSocket.setMulticastLoopback(true); }); sendSocket.on('close', function() { console.error('[PARENT] sendSocket closed'); }); sendSocket.sendNext = function() { const buf = messages[i++]; if (!buf) { try { sendSocket.close(); } catch (e) {} return; } sendSocket.send( buf, 0, buf.length, common.PORT, LOCAL_BROADCAST_HOST, function(err) { if (err) throw err; console.error('[PARENT] sent "%s" to %s:%s', buf.toString(), LOCAL_BROADCAST_HOST, common.PORT); process.nextTick(sendSocket.sendNext); } ); }; } if (process.argv[2] === 'child') { const receivedMessages = []; const listenSocket = dgram.createSocket({ type: 'udp4', reuseAddr: true }); listenSocket.on('listening', function() { listenSocket.addMembership(LOCAL_BROADCAST_HOST); listenSocket.on('message', function(buf, rinfo) { console.error('[CHILD] %s received "%s" from %j', process.pid, buf.toString(), rinfo); receivedMessages.push(buf); process.send({ message: buf.toString() }); if (receivedMessages.length === messages.length) { // .dropMembership() not strictly needed but here as a sanity check. listenSocket.dropMembership(LOCAL_BROADCAST_HOST); process.nextTick(function() { listenSocket.close(); }); } }); listenSocket.on('close', function() { // HACK: Wait to exit the process to ensure that the parent // process has had time to receive all messages via process.send() // This may be indicative of some other issue. setTimeout(function() { process.exit(); }, common.platformTimeout(1000)); }); process.send({ listening: true }); }); listenSocket.bind(common.PORT); } node-v4.8.2/test/internet/test-dgram-send-cb-quelches-error.js000644 000766 000024 00000001735 13070706736 024452 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var mustCall = common.mustCall; var assert = require('assert'); var dgram = require('dgram'); var dns = require('dns'); var socket = dgram.createSocket('udp4'); var buffer = new Buffer('gary busey'); dns.setServers([]); socket.once('error', onEvent); // assert that: // * callbacks act as "error" listeners if given. // * error is never emitter for missing dns entries // if a callback that handles error is present // * error is emitted if a callback with no argument is passed socket.send(buffer, 0, buffer.length, 100, 'dne.example.com', mustCall(callbackOnly)); function callbackOnly(err) { assert.ok(err); socket.removeListener('error', onEvent); socket.on('error', mustCall(onError)); socket.send(buffer, 0, buffer.length, 100, 'dne.example.com'); } function onEvent(err) { common.fail('Error should not be emitted if there is callback'); } function onError(err) { assert.ok(err); socket.close(); } node-v4.8.2/test/internet/test-dns-cares-domains.js000644 000766 000024 00000000771 13070706736 022417 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var dns = require('dns'); var domain = require('domain'); var methods = [ 'resolve4', 'resolve6', 'resolveCname', 'resolveMx', 'resolveNs', 'resolveTxt', 'resolveSrv', 'resolveNaptr', 'resolveSoa' ]; methods.forEach(function(method) { var d = domain.create(); d.run(function() { dns[method]('google.com', function() { assert.strictEqual(process.domain, d, method + ' retains domain'); }); }); }); node-v4.8.2/test/internet/test-dns-ipv4.js000644 000766 000024 00000010213 13070706736 020544 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const dns = require('dns'); const net = require('net'); const isIPv4 = net.isIPv4; let expected = 0; let completed = 0; let running = false; const queue = []; function TEST(f) { function next() { var f = queue.shift(); if (f) { running = true; console.log(f.name); f(done); } } function done() { running = false; completed++; process.nextTick(next); } expected++; queue.push(f); if (!running) { next(); } } function checkWrap(req) { assert.ok(typeof req === 'object'); } TEST(function test_resolve4(done) { var req = dns.resolve4('www.google.com', function(err, ips) { if (err) throw err; assert.ok(ips.length > 0); for (var i = 0; i < ips.length; i++) { assert.ok(isIPv4(ips[i])); } done(); }); checkWrap(req); }); TEST(function test_reverse_ipv4(done) { var req = dns.reverse('8.8.8.8', function(err, domains) { if (err) throw err; assert.ok(domains.length > 0); for (var i = 0; i < domains.length; i++) { assert.ok(domains[i]); assert.ok(typeof domains[i] === 'string'); } done(); }); checkWrap(req); }); TEST(function test_lookup_ipv4_explicit(done) { var req = dns.lookup('www.google.com', 4, function(err, ip, family) { if (err) throw err; assert.ok(net.isIPv4(ip)); assert.strictEqual(family, 4); done(); }); checkWrap(req); }); TEST(function test_lookup_ipv4_implicit(done) { var req = dns.lookup('www.google.com', function(err, ip, family) { if (err) throw err; assert.ok(net.isIPv4(ip)); assert.strictEqual(family, 4); done(); }); checkWrap(req); }); TEST(function test_lookup_ipv4_explicit_object(done) { var req = dns.lookup('www.google.com', { family: 4 }, function(err, ip, family) { if (err) throw err; assert.ok(net.isIPv4(ip)); assert.strictEqual(family, 4); done(); }); checkWrap(req); }); TEST(function test_lookup_ipv4_hint_addrconfig(done) { var req = dns.lookup('www.google.com', { hints: dns.ADDRCONFIG }, function(err, ip, family) { if (err) throw err; assert.ok(net.isIPv4(ip)); assert.strictEqual(family, 4); done(); }); checkWrap(req); }); TEST(function test_lookup_ip_ipv4(done) { var req = dns.lookup('127.0.0.1', function(err, ip, family) { if (err) throw err; assert.strictEqual(ip, '127.0.0.1'); assert.strictEqual(family, 4); done(); }); checkWrap(req); }); TEST(function test_lookup_localhost_ipv4(done) { var req = dns.lookup('localhost', 4, function(err, ip, family) { if (err) throw err; assert.strictEqual(ip, '127.0.0.1'); assert.strictEqual(family, 4); done(); }); checkWrap(req); }); TEST(function test_lookup_all_ipv4(done) { var req = dns.lookup( 'www.google.com', {all: true, family: 4}, function(err, ips) { if (err) throw err; assert.ok(Array.isArray(ips)); assert.ok(ips.length > 0); ips.forEach(function(ip) { assert.ok(isIPv4(ip.address)); assert.strictEqual(ip.family, 4); }); done(); } ); checkWrap(req); }); TEST(function test_lookupservice_ip_ipv4(done) { var req = dns.lookupService('127.0.0.1', 80, function(err, host, service) { if (err) throw err; assert.equal(typeof host, 'string'); assert(host); /* * Retrieve the actual HTTP service name as setup on the host currently * running the test by reading it from /etc/services. This is not ideal, * as the service name lookup could use another mechanism (e.g nscd), but * it's already better than hardcoding it. */ var httpServiceName = common.getServiceName(80, 'tcp'); if (!httpServiceName) { /* * Couldn't find service name, reverting to the most sensible default * for port 80. */ httpServiceName = 'http'; } assert.strictEqual(service, httpServiceName); done(); }); checkWrap(req); }); process.on('exit', function() { console.log(completed + ' tests completed'); assert.equal(running, false); assert.strictEqual(expected, completed); }); node-v4.8.2/test/internet/test-dns-ipv6.js000644 000766 000024 00000011710 13070706736 020551 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const dns = require('dns'); const net = require('net'); const isIPv6 = net.isIPv6; let expected = 0; let completed = 0; let running = false; const queue = []; if (!common.hasIPv6) { common.skip('this test, no IPv6 support'); return; } function TEST(f) { function next() { var f = queue.shift(); if (f) { running = true; console.log(f.name); f(done); } } function done() { running = false; completed++; process.nextTick(next); } expected++; queue.push(f); if (!running) { next(); } } function checkWrap(req) { assert.ok(typeof req === 'object'); } TEST(function test_resolve6(done) { var req = dns.resolve6('ipv6.google.com', function(err, ips) { if (err) throw err; assert.ok(ips.length > 0); for (var i = 0; i < ips.length; i++) { assert.ok(isIPv6(ips[i])); } done(); }); checkWrap(req); }); TEST(function test_reverse_ipv6(done) { var req = dns.reverse('2001:4860:4860::8888', function(err, domains) { if (err) throw err; assert.ok(domains.length > 0); for (var i = 0; i < domains.length; i++) { assert.ok(domains[i]); assert.ok(typeof domains[i] === 'string'); } done(); }); checkWrap(req); }); TEST(function test_lookup_ipv6_explicit(done) { var req = dns.lookup('ipv6.google.com', 6, function(err, ip, family) { if (err) throw err; assert.ok(net.isIPv6(ip)); assert.strictEqual(family, 6); done(); }); checkWrap(req); }); /* This ends up just being too problematic to test TEST(function test_lookup_ipv6_implicit(done) { var req = dns.lookup('ipv6.google.com', function(err, ip, family) { if (err) throw err; assert.ok(net.isIPv6(ip)); assert.strictEqual(family, 6); done(); }); checkWrap(req); }); */ TEST(function test_lookup_ipv6_explicit_object(done) { var req = dns.lookup('ipv6.google.com', { family: 6 }, function(err, ip, family) { if (err) throw err; assert.ok(net.isIPv6(ip)); assert.strictEqual(family, 6); done(); }); checkWrap(req); }); TEST(function test_lookup_ipv6_hint(done) { var req = dns.lookup('www.google.com', { family: 6, hints: dns.V4MAPPED }, function(err, ip, family) { if (err) { // FreeBSD does not support V4MAPPED if (process.platform === 'freebsd') { assert(err instanceof Error); assert.strictEqual(err.code, 'EAI_BADFLAGS'); assert.strictEqual(err.hostname, 'www.google.com'); assert.ok(/getaddrinfo EAI_BADFLAGS/.test(err.message)); done(); return; } else { throw err; } } assert.ok(net.isIPv6(ip)); assert.strictEqual(family, 6); done(); }); checkWrap(req); }); TEST(function test_lookup_ip_ipv6(done) { var req = dns.lookup('::1', function(err, ip, family) { if (err) throw err; assert.ok(net.isIPv6(ip)); assert.strictEqual(family, 6); done(); }); checkWrap(req); }); TEST(function test_lookup_all_ipv6(done) { var req = dns.lookup( 'www.google.com', {all: true, family: 6}, function(err, ips) { if (err) throw err; assert.ok(Array.isArray(ips)); assert.ok(ips.length > 0); ips.forEach(function(ip) { assert.ok(isIPv6(ip.address), 'Invalid IPv6: ' + ip.address.toString()); assert.strictEqual(ip.family, 6); }); done(); } ); checkWrap(req); }); TEST(function test_lookupservice_ip_ipv6(done) { var req = dns.lookupService('::1', 80, function(err, host, service) { if (err) { // Not skipping the test, rather checking an alternative result, // i.e. that ::1 may not be configured (e.g. in /etc/hosts) assert.strictEqual(err.code, 'ENOTFOUND'); return done(); } assert.equal(typeof host, 'string'); assert(host); /* * Retrieve the actual HTTP service name as setup on the host currently * running the test by reading it from /etc/services. This is not ideal, * as the service name lookup could use another mechanism (e.g nscd), but * it's already better than hardcoding it. */ var httpServiceName = common.getServiceName(80, 'tcp'); if (!httpServiceName) { /* * Couldn't find service name, reverting to the most sensible default * for port 80. */ httpServiceName = 'http'; } assert.strictEqual(service, httpServiceName); done(); }); checkWrap(req); }); /* Disabled because it appears to be not working on linux. */ /* TEST(function test_lookup_localhost_ipv6(done) { var req = dns.lookup('localhost', 6, function(err, ip, family) { if (err) throw err; assert.ok(net.isIPv6(ip)); assert.strictEqual(family, 6); done(); }); checkWrap(req); }); */ process.on('exit', function() { console.log(completed + ' tests completed'); assert.equal(running, false); assert.strictEqual(expected, completed); }); node-v4.8.2/test/internet/test-dns-txt-sigsegv.js000644 000766 000024 00000000336 13070706736 022153 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var dns = require('dns'); dns.resolveTxt('www.microsoft.com', function(err, records) { assert.equal(err, null); assert.equal(records.length, 0); }); node-v4.8.2/test/internet/test-dns.js000644 000766 000024 00000020610 13070706736 017666 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const dns = require('dns'); const net = require('net'); const isIPv4 = net.isIPv4; const isIPv6 = net.isIPv6; const util = require('util'); let expected = 0; let completed = 0; let running = false; const queue = []; function TEST(f) { function next() { var f = queue.shift(); if (f) { running = true; console.log(f.name); f(done); } } function done() { running = false; completed++; process.nextTick(next); } expected++; queue.push(f); if (!running) { next(); } } function checkWrap(req) { assert.ok(typeof req === 'object'); } TEST(function test_reverse_bogus(done) { var error; try { dns.reverse('bogus ip', function() { assert.ok(false); }); } catch (e) { error = e; } assert.ok(error instanceof Error); assert.strictEqual(error.errno, 'EINVAL'); done(); }); TEST(function test_resolveMx(done) { var req = dns.resolveMx('gmail.com', function(err, result) { if (err) throw err; assert.ok(result.length > 0); for (var i = 0; i < result.length; i++) { var item = result[i]; assert.ok(item); assert.ok(typeof item === 'object'); assert.ok(item.exchange); assert.ok(typeof item.exchange === 'string'); assert.ok(typeof item.priority === 'number'); } done(); }); checkWrap(req); }); TEST(function test_resolveNs(done) { var req = dns.resolveNs('rackspace.com', function(err, names) { if (err) throw err; assert.ok(names.length > 0); for (var i = 0; i < names.length; i++) { var name = names[i]; assert.ok(name); assert.ok(typeof name === 'string'); } done(); }); checkWrap(req); }); TEST(function test_resolveSrv(done) { var req = dns.resolveSrv('_jabber._tcp.google.com', function(err, result) { if (err) throw err; assert.ok(result.length > 0); for (var i = 0; i < result.length; i++) { var item = result[i]; assert.ok(item); assert.ok(typeof item === 'object'); assert.ok(item.name); assert.ok(typeof item.name === 'string'); assert.ok(typeof item.port === 'number'); assert.ok(typeof item.priority === 'number'); assert.ok(typeof item.weight === 'number'); } done(); }); checkWrap(req); }); TEST(function test_resolveNaptr(done) { var req = dns.resolveNaptr('sip2sip.info', function(err, result) { if (err) throw err; assert.ok(result.length > 0); for (var i = 0; i < result.length; i++) { var item = result[i]; assert.ok(item); assert.ok(typeof item === 'object'); assert.ok(typeof item.flags === 'string'); assert.ok(typeof item.service === 'string'); assert.ok(typeof item.regexp === 'string'); assert.ok(typeof item.replacement === 'string'); assert.ok(typeof item.order === 'number'); assert.ok(typeof item.preference === 'number'); } done(); }); checkWrap(req); }); TEST(function test_resolveSoa(done) { var req = dns.resolveSoa('nodejs.org', function(err, result) { if (err) throw err; assert.ok(result); assert.ok(typeof result === 'object'); assert.ok(typeof result.nsname === 'string'); assert.ok(result.nsname.length > 0); assert.ok(typeof result.hostmaster === 'string'); assert.ok(result.hostmaster.length > 0); assert.ok(typeof result.serial === 'number'); assert.ok((result.serial > 0) && (result.serial < 4294967295)); assert.ok(typeof result.refresh === 'number'); assert.ok((result.refresh > 0) && (result.refresh < 2147483647)); assert.ok(typeof result.retry === 'number'); assert.ok((result.retry > 0) && (result.retry < 2147483647)); assert.ok(typeof result.expire === 'number'); assert.ok((result.expire > 0) && (result.expire < 2147483647)); assert.ok(typeof result.minttl === 'number'); assert.ok((result.minttl >= 0) && (result.minttl < 2147483647)); done(); }); checkWrap(req); }); TEST(function test_resolveCname(done) { var req = dns.resolveCname('www.microsoft.com', function(err, names) { if (err) throw err; assert.ok(names.length > 0); for (var i = 0; i < names.length; i++) { var name = names[i]; assert.ok(name); assert.ok(typeof name === 'string'); } done(); }); checkWrap(req); }); TEST(function test_resolveTxt(done) { var req = dns.resolveTxt('google.com', function(err, records) { if (err) throw err; assert.equal(records.length, 1); assert.ok(util.isArray(records[0])); assert.equal(records[0][0].indexOf('v=spf1'), 0); done(); }); checkWrap(req); }); TEST(function test_lookup_failure(done) { var req = dns.lookup('does.not.exist', 4, function(err, ip, family) { assert.ok(err instanceof Error); assert.strictEqual(err.errno, dns.NOTFOUND); assert.strictEqual(err.errno, 'ENOTFOUND'); assert.ok(!/ENOENT/.test(err.message)); assert.ok(/does\.not\.exist/.test(err.message)); done(); }); checkWrap(req); }); TEST(function test_lookup_null(done) { var req = dns.lookup(null, function(err, ip, family) { if (err) throw err; assert.strictEqual(ip, null); assert.strictEqual(family, 4); done(); }); checkWrap(req); }); TEST(function test_lookup_ip_all(done) { var req = dns.lookup('127.0.0.1', {all: true}, function(err, ips, family) { if (err) throw err; assert.ok(Array.isArray(ips)); assert.ok(ips.length > 0); assert.strictEqual(ips[0].address, '127.0.0.1'); assert.strictEqual(ips[0].family, 4); done(); }); checkWrap(req); }); TEST(function test_lookup_null_all(done) { var req = dns.lookup(null, {all: true}, function(err, ips, family) { if (err) throw err; assert.ok(Array.isArray(ips)); assert.strictEqual(ips.length, 0); done(); }); checkWrap(req); }); TEST(function test_lookup_all_mixed(done) { var req = dns.lookup('www.google.com', {all: true}, function(err, ips) { if (err) throw err; assert.ok(Array.isArray(ips)); assert.ok(ips.length > 0); ips.forEach(function(ip) { if (isIPv4(ip.address)) assert.equal(ip.family, 4); else if (isIPv6(ip.address)) assert.equal(ip.family, 6); else assert(false); }); done(); }); checkWrap(req); }); TEST(function test_lookupservice_invalid(done) { var req = dns.lookupService('1.2.3.4', 80, function(err, host, service) { assert(err instanceof Error); assert.strictEqual(err.code, 'ENOTFOUND'); assert.ok(/1\.2\.3\.4/.test(err.message)); done(); }); checkWrap(req); }); TEST(function test_reverse_failure(done) { var req = dns.reverse('0.0.0.0', function(err) { assert(err instanceof Error); assert.strictEqual(err.code, 'ENOTFOUND'); // Silly error code... assert.strictEqual(err.hostname, '0.0.0.0'); assert.ok(/0\.0\.0\.0/.test(err.message)); done(); }); checkWrap(req); }); TEST(function test_lookup_failure(done) { var req = dns.lookup('nosuchhostimsure', function(err) { assert(err instanceof Error); assert.strictEqual(err.code, 'ENOTFOUND'); // Silly error code... assert.strictEqual(err.hostname, 'nosuchhostimsure'); assert.ok(/nosuchhostimsure/.test(err.message)); done(); }); checkWrap(req); }); TEST(function test_resolve_failure(done) { var req = dns.resolve4('nosuchhostimsure', function(err) { assert(err instanceof Error); switch (err.code) { case 'ENOTFOUND': case 'ESERVFAIL': break; default: assert.strictEqual(err.code, 'ENOTFOUND'); // Silly error code... break; } assert.strictEqual(err.hostname, 'nosuchhostimsure'); assert.ok(/nosuchhostimsure/.test(err.message)); done(); }); checkWrap(req); }); var getaddrinfoCallbackCalled = false; console.log('looking up nodejs.org...'); var cares = process.binding('cares_wrap'); var req = new cares.GetAddrInfoReqWrap(); cares.getaddrinfo(req, 'nodejs.org', 4); req.oncomplete = function(err, domains) { assert.strictEqual(err, 0); console.log('nodejs.org = ', domains); assert.ok(Array.isArray(domains)); assert.ok(domains.length >= 1); assert.ok(typeof domains[0] == 'string'); getaddrinfoCallbackCalled = true; }; process.on('exit', function() { console.log(completed + ' tests completed'); assert.equal(running, false); assert.strictEqual(expected, completed); assert.ok(getaddrinfoCallbackCalled); }); node-v4.8.2/test/internet/test-http-dns-fail.js000644 000766 000024 00000001312 13070706736 021552 0ustar00iojsstaff000000 000000 'use strict'; /* * Repeated requests for a domain that fails to resolve * should trigger the error event after each attempt. */ const common = require('../common'); var assert = require('assert'); var http = require('http'); var hadError = 0; function httpreq(count) { if (1 < count) return; var req = http.request({ host: 'not-a-real-domain-name.nobody-would-register-this-as-a-tld', port: 80, path: '/', method: 'GET' }, common.fail); req.on('error', function(e) { console.log(e.message); assert.strictEqual(e.code, 'ENOTFOUND'); hadError++; httpreq(count + 1); }); req.end(); } httpreq(0); process.on('exit', function() { assert.equal(2, hadError); }); node-v4.8.2/test/internet/test-http-https-default-ports.js000644 000766 000024 00000000547 13070706736 024017 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var https = require('https'); var http = require('http'); https.get('https://www.google.com/', common.mustCall(function(res) { res.resume(); })); http.get('http://www.google.com/', common.mustCall(function(res) { res.resume(); })); node-v4.8.2/test/internet/test-net-connect-timeout.js000644 000766 000024 00000001506 13070706736 023006 0ustar00iojsstaff000000 000000 'use strict'; // This example attempts to time out before the connection is established // https://groups.google.com/forum/#!topic/nodejs/UE0ZbfLt6t8 // https://groups.google.com/forum/#!topic/nodejs-dev/jR7-5UDqXkw const common = require('../common'); var net = require('net'); var assert = require('assert'); var start = new Date(); var T = 100; // 192.0.2.1 is part of subnet assigned as "TEST-NET" in RFC 5737. // For use solely in documentation and example source code. // In short, it should be unreachable. // In practice, it's a network black hole. var socket = net.createConnection(9999, '192.0.2.1'); socket.setTimeout(T); socket.on('timeout', common.mustCall(function() { console.error('timeout'); var now = new Date(); assert.ok(now - start < T + 500); socket.destroy(); })); socket.on('connect', common.fail); node-v4.8.2/test/internet/test-net-connect-unref.js000644 000766 000024 00000000421 13070706736 022432 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); var net = require('net'); var client; var TIMEOUT = 10 * 1000; client = net.createConnection(53, '8.8.8.8', function() { client.unref(); }); client.on('close', common.fail); setTimeout(common.fail, TIMEOUT).unref(); node-v4.8.2/test/internet/test-tls-connnect-melissadata.js000644 000766 000024 00000000607 13070706736 024002 0ustar00iojsstaff000000 000000 'use strict'; // Test for authorized access to the server which has a cross root // certification between Starfield Class 2 and ValiCert Class 2 var common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } var tls = require('tls'); var socket = tls.connect(443, 'address.melissadata.net', function() { socket.resume(); socket.destroy(); }); node-v4.8.2/test/internet/test-tls-reuse-host-from-socket.js000644 000766 000024 00000000613 13070706736 024230 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); if (!common.hasCrypto) { common.skip('missing crypto'); return; } const tls = require('tls'); const net = require('net'); const socket = net.connect(443, 'www.example.org', common.mustCall(() => { const secureSocket = tls.connect({socket: socket}, common.mustCall(() => { secureSocket.destroy(); console.log('ok'); })); })); node-v4.8.2/test/internet/testcfg.py000644 000766 000024 00000000305 13070706736 017577 0ustar00iojsstaff000000 000000 import sys, os sys.path.append(os.path.join(os.path.dirname(__file__), '..')) import testpy def GetConfiguration(context, root): return testpy.SimpleTestConfiguration(context, root, 'internet') node-v4.8.2/test/gc/test-http-client-connaborted.js000644 000766 000024 00000002363 13070706736 022377 0ustar00iojsstaff000000 000000 'use strict'; // just like test/gc/http-client.js, // but aborting every connection that comes in. function serverHandler(req, res) { res.connection.destroy(); } const http = require('http'); const weak = require('weak'); require('../common'); const assert = require('assert'); const todo = 500; let done = 0; let count = 0; let countGC = 0; console.log('We should do ' + todo + ' requests'); var server = http.createServer(serverHandler); server.listen(0, getall); function getall() { if (count >= todo) return; (function() { function cb(res) { done += 1; statusLater(); } var req = http.get({ hostname: 'localhost', pathname: '/', port: server.address().port }, cb).on('error', cb); count++; weak(req, afterGC); })(); setImmediate(getall); } for (var i = 0; i < 10; i++) getall(); function afterGC() { countGC++; } var timer; function statusLater() { gc(); if (timer) clearTimeout(timer); timer = setTimeout(status, 1); } function status() { gc(); console.log('Done: %d/%d', done, todo); console.log('Collected: %d/%d', countGC, count); if (done === todo) { console.log('All should be collected now.'); assert(count === countGC); process.exit(0); } } node-v4.8.2/test/gc/test-http-client-onerror.js000644 000766 000024 00000002656 13070706736 021574 0ustar00iojsstaff000000 000000 'use strict'; // just like test/gc/http-client.js, // but with an on('error') handler that does nothing. function serverHandler(req, res) { req.resume(); res.writeHead(200, {'Content-Type': 'text/plain'}); res.end('Hello World\n'); } const http = require('http'); const weak = require('weak'); require('../common'); const assert = require('assert'); const todo = 500; let done = 0; let count = 0; let countGC = 0; console.log('We should do ' + todo + ' requests'); var server = http.createServer(serverHandler); server.listen(0, runTest); function getall() { if (count >= todo) return; (function() { function cb(res) { res.resume(); done += 1; statusLater(); } function onerror(er) { throw er; } var req = http.get({ hostname: 'localhost', pathname: '/', port: server.address().port }, cb).on('error', onerror); count++; weak(req, afterGC); })(); setImmediate(getall); } function runTest() { for (var i = 0; i < 10; i++) getall(); } function afterGC() { countGC++; } var timer; function statusLater() { gc(); if (timer) clearTimeout(timer); timer = setTimeout(status, 1); } function status() { gc(); console.log('Done: %d/%d', done, todo); console.log('Collected: %d/%d', countGC, count); if (done === todo) { console.log('All should be collected now.'); assert.strictEqual(count, countGC); process.exit(0); } } node-v4.8.2/test/gc/test-http-client-timeout.js000644 000766 000024 00000002632 13070706736 021566 0ustar00iojsstaff000000 000000 'use strict'; // just like test/gc/http-client.js, // but with a timeout set function serverHandler(req, res) { setTimeout(function() { req.resume(); res.writeHead(200); res.end('hello\n'); }, 100); } const http = require('http'); const weak = require('weak'); require('../common'); const assert = require('assert'); const todo = 550; let done = 0; let count = 0; let countGC = 0; console.log('We should do ' + todo + ' requests'); var server = http.createServer(serverHandler); server.listen(0, getall); function getall() { if (count >= todo) return; (function() { function cb(res) { res.resume(); done += 1; statusLater(); } var req = http.get({ hostname: 'localhost', pathname: '/', port: server.address().port }, cb); req.on('error', cb); req.setTimeout(10, function() { console.log('timeout (expected)'); }); count++; weak(req, afterGC); })(); setImmediate(getall); } for (var i = 0; i < 10; i++) getall(); function afterGC() { countGC++; } var timer; function statusLater() { gc(); if (timer) clearTimeout(timer); timer = setTimeout(status, 1); } function status() { gc(); console.log('Done: %d/%d', done, todo); console.log('Collected: %d/%d', countGC, count); if (done === todo) { console.log('All should be collected now.'); assert(count === countGC); process.exit(0); } } node-v4.8.2/test/gc/test-http-client.js000644 000766 000024 00000002326 13070706736 020102 0ustar00iojsstaff000000 000000 'use strict'; // just a simple http server and client. function serverHandler(req, res) { res.writeHead(200, {'Content-Type': 'text/plain'}); res.end('Hello World\n'); } const http = require('http'); const weak = require('weak'); require('../common'); const assert = require('assert'); const todo = 500; let done = 0; let count = 0; let countGC = 0; console.log('We should do ' + todo + ' requests'); var server = http.createServer(serverHandler); server.listen(0, getall); function getall() { if (count >= todo) return; (function() { function cb(res) { res.resume(); console.error('in cb'); done += 1; res.on('end', gc); } var req = http.get({ hostname: 'localhost', pathname: '/', port: server.address().port }, cb); count++; weak(req, afterGC); })(); setImmediate(getall); } for (var i = 0; i < 10; i++) getall(); function afterGC() { countGC++; } setInterval(status, 1000).unref(); function status() { gc(); console.log('Done: %d/%d', done, todo); console.log('Collected: %d/%d', countGC, count); if (done === todo) { console.log('All should be collected now.'); assert(count === countGC); process.exit(0); } } node-v4.8.2/test/gc/test-net-timeout.js000644 000766 000024 00000003077 13070706736 020125 0ustar00iojsstaff000000 000000 'use strict'; // just like test/gc/http-client-timeout.js, // but using a net server/client instead function serverHandler(sock) { sock.setTimeout(120000); sock.resume(); var timer; sock.on('close', function() { clearTimeout(timer); }); sock.on('error', function(err) { assert.strictEqual(err.code, 'ECONNRESET'); }); timer = setTimeout(function() { sock.end('hello\n'); }, 100); } const net = require('net'); const weak = require('weak'); require('../common'); const assert = require('assert'); const todo = 500; let done = 0; let count = 0; let countGC = 0; console.log('We should do ' + todo + ' requests'); var server = net.createServer(serverHandler); server.listen(0, getall); function getall() { if (count >= todo) return; (function() { var req = net.connect(server.address().port); req.resume(); req.setTimeout(10, function() { //console.log('timeout (expected)') req.destroy(); done++; gc(); }); count++; weak(req, afterGC); })(); setImmediate(getall); } for (var i = 0; i < 10; i++) getall(); function afterGC() { countGC++; } setInterval(status, 100).unref(); function status() { gc(); console.log('Done: %d/%d', done, todo); console.log('Collected: %d/%d', countGC, count); if (done === todo) { /* Give libuv some time to make close callbacks. */ setTimeout(function() { gc(); console.log('All should be collected now.'); console.log('Collected: %d/%d', countGC, count); assert(count === countGC); process.exit(0); }, 200); } } node-v4.8.2/test/gc/testcfg.py000644 000766 000024 00000000320 13070706736 016335 0ustar00iojsstaff000000 000000 import sys, os sys.path.append(os.path.join(os.path.dirname(__file__), '..')) import testpy def GetConfiguration(context, root): return testpy.SimpleTestConfiguration(context, root, 'gc', ['--expose-gc']) node-v4.8.2/test/fixtures/.empty-repl-history-file000644 000766 000024 00000000000 13070706736 022312 0ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/.node_repl_history000644 000766 000024 00000000050 13070706736 021335 0ustar00iojsstaff000000 000000 'you look fabulous today' 'Stay Fresh~' node-v4.8.2/test/fixtures/a.js000644 000766 000024 00000000515 13070706736 016370 0ustar00iojsstaff000000 000000 var c = require('./b/c'); console.error('load fixtures/a.js'); var string = 'A'; exports.SomeClass = c.SomeClass; exports.A = function() { return string; }; exports.C = function() { return c.C(); }; exports.D = function() { return c.D(); }; exports.number = 42; process.on('exit', function() { string = 'A done'; }); node-v4.8.2/test/fixtures/a1.js000644 000766 000024 00000000515 13070706736 016451 0ustar00iojsstaff000000 000000 var c = require('./b/c'); console.error('load fixtures/a.js'); var string = 'A'; exports.SomeClass = c.SomeClass; exports.A = function() { return string; }; exports.C = function() { return c.C(); }; exports.D = function() { return c.D(); }; exports.number = 42; process.on('exit', function() { string = 'A done'; }); node-v4.8.2/test/fixtures/agent.crt000644 000766 000024 00000002315 13070706736 017422 0ustar00iojsstaff000000 000000 -----BEGIN CERTIFICATE----- MIIDXTCCAkWgAwIBAgIJAMUSOvlaeyQHMA0GCSqGSIb3DQEBBQUAMEUxCzAJBgNV BAYTAkFVMRMwEQYDVQQIDApTb21lLVN0YXRlMSEwHwYDVQQKDBhJbnRlcm5ldCBX aWRnaXRzIFB0eSBMdGQwHhcNMTAxMTE2MDkzMjQ5WhcNMTMxMTE1MDkzMjQ5WjBF MQswCQYDVQQGEwJBVTETMBEGA1UECAwKU29tZS1TdGF0ZTEhMB8GA1UECgwYSW50 ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB CgKCAQEAz+LXZOjcQCJq3+ZKUFabj71oo/ex/XsBcFqtBThjjTw9CVEVwfPQQp4X wtPiB204vnYXwQ1/R2NdTQqCZu47l79LssL/u2a5Y9+0NEU3nQA5qdt+1FAE0c5o exPimXOrR3GWfKz7PmZ2O0117IeCUUXPG5U8umhDe/4mDF4ZNJiKc404WthquTqg S7rLQZHhZ6D0EnGnOkzlmxJMYPNHSOY1/6ivdNUUcC87awNEA3lgfhy25IyBK3QJ c+aYKNTbt70Lery3bu2wWLFGtmNiGlQTS4JsxImRsECTI727ObS7/FWAQsqW+COL 0Sa5BuMFrFIpjPrEe0ih7vRRbdmXRwIDAQABo1AwTjAdBgNVHQ4EFgQUDnV4d6mD tOnluLoCjkUHTX/n4agwHwYDVR0jBBgwFoAUDnV4d6mDtOnluLoCjkUHTX/n4agw DAYDVR0TBAUwAwEB/zANBgkqhkiG9w0BAQUFAAOCAQEAFwV4MQfTo+qMv9JMiyno IEiqfOz4RgtmBqRnXUffcjS2dhc7/z+FPZnM79Kej8eLHoVfxCyWRHFlzm93vEdv wxOCrD13EDOi08OOZfxWyIlCa6Bg8cMAKqQzd2OvQOWqlRWBTThBJIhWflU33izX Qn5GdmYqhfpc+9ZHHGhvXNydtRQkdxVK2dZNzLBvBlLlRmtoClU7xm3A+/5dddeP AQHEPtyFlUw49VYtZ3ru6KqPms7MKvcRhYLsy9rwSfuuniMlx4d0bDR7TOkw0QQS A0N8MGQRQpzl4mw4jLzyM5d5QtuGBh2P6hPGa0YQxtI3RPT/p6ENzzBiAKXiSfzo xw== -----END CERTIFICATE----- node-v4.8.2/test/fixtures/agent.key000644 000766 000024 00000003213 13070706736 017420 0ustar00iojsstaff000000 000000 -----BEGIN RSA PRIVATE KEY----- MIIEowIBAAKCAQEAz+LXZOjcQCJq3+ZKUFabj71oo/ex/XsBcFqtBThjjTw9CVEV wfPQQp4XwtPiB204vnYXwQ1/R2NdTQqCZu47l79LssL/u2a5Y9+0NEU3nQA5qdt+ 1FAE0c5oexPimXOrR3GWfKz7PmZ2O0117IeCUUXPG5U8umhDe/4mDF4ZNJiKc404 WthquTqgS7rLQZHhZ6D0EnGnOkzlmxJMYPNHSOY1/6ivdNUUcC87awNEA3lgfhy2 5IyBK3QJc+aYKNTbt70Lery3bu2wWLFGtmNiGlQTS4JsxImRsECTI727ObS7/FWA QsqW+COL0Sa5BuMFrFIpjPrEe0ih7vRRbdmXRwIDAQABAoIBAGe4+9VqZfJN+dsq 8Osyuz01uQ8OmC0sAWTIqUlQgENIyf9rCJsUBlYmwR5BT6Z69XP6QhHdpSK+TiAR XUz0EqG9HYzcxHIBaACP7j6iRoQ8R4kbbiWKo0z3WqQGIOqFjvD/mKEuQdE5mEYw eOUCG6BnX1WY2Yr8WKd2AA/tp0/Y4d8z04u9eodMpSTbHTzYMJb5SbBN1vo6FY7q 8zSuO0BMzXlAxUsCwHsk1GQHFr8Oh3zIR7bQGtMBouI+6Lhh7sjFYsfxJboqMTBV IKaA216M6ggHG7MU1/jeKcMGDmEfqQLQoyWp29rMK6TklUgipME2L3UD7vTyAVzz xbVOpZkCgYEA8CXW4sZBBrSSrLR5SB+Ubu9qNTggLowOsC/kVKB2WJ4+xooc5HQo mFhq1v/WxPQoWIxdYsfg2odlL+JclK5Qcy6vXmRSdAQ5lK9gBDKxZSYc3NwAw2HA zyHCTK+I0n8PBYQ+yGcrxu0WqTGnlLW+Otk4CejO34WlgHwbH9bbY5UCgYEA3ZvT C4+OoMHXlmICSt29zUrYiL33IWsR3/MaONxTEDuvgkOSXXQOl/8Ebd6Nu+3WbsSN bjiPC/JyL1YCVmijdvFpl4gjtgvfJifs4G+QHvO6YfsYoVANk4u6g6rUuBIOwNK4 RwYxwDc0oysp+g7tPxoSgDHReEVKJNzGBe9NGGsCgYEA4O4QP4gCEA3B9BF2J5+s n9uPVxmiyvZUK6Iv8zP4pThTBBMIzNIf09G9AHPQ7djikU2nioY8jXKTzC3xGTHM GJZ5m6fLsu7iH+nDvSreDSeNkTBfZqGAvoGYQ8uGE+L+ZuRfCcXYsxIOT5s6o4c3 Dle2rVFpsuKzCY00urW796ECgYBn3go75+xEwrYGQSer6WR1nTgCV29GVYXKPooy zmmMOT1Yw80NSkEw0pFD4cTyqVYREsTrPU0mn1sPfrOXxnGfZSVFpcR/Je9QVfQ7 eW7GYxwfom335aqHVj10SxRqteP+UoWWnHujCPz94VRKZMakBddYCIGSan+G6YdS 7sdmwwKBgBc2qj0wvGXDF2kCLwSGfWoMf8CS1+5fIiUIdT1e/+7MfDdbmLMIFVjF QKS3zVViXCbrG5SY6wS9hxoc57f6E2A8vcaX6zy2xkZlGHQCpWRtEM5R01OWJQaH HsHMmQZGUQVoDm1oRkDhrTFK4K3ukc3rAxzeTZ96utOQN8/KJsTv -----END RSA PRIVATE KEY----- node-v4.8.2/test/fixtures/alice.crt000644 000766 000024 00000002624 13070706736 017404 0ustar00iojsstaff000000 000000 -----BEGIN CERTIFICATE----- MIID8DCCAtigAwIBAgIJALmw0zKhqlY1MA0GCSqGSIb3DQEBBQUAMFgxDjAMBgNV BAMTBWFsaWNlMUYwRAYDVR0RFD11bmlmb3JtUmVzb3VyY2VJZGVudGlmaWVyOmh0 dHA6Ly9sb2NhbGhvc3Q6ODAwMC9hbGljZS5mb2FmI21lMB4XDTExMDgyNDA1NTUx NFoXDTExMDkyMzA1NTUxNFowWDEOMAwGA1UEAxMFYWxpY2UxRjBEBgNVHREUPXVu aWZvcm1SZXNvdXJjZUlkZW50aWZpZXI6aHR0cDovL2xvY2FsaG9zdDo4MDAwL2Fs aWNlLmZvYWYjbWUwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDP4tdk 6NxAImrf5kpQVpuPvWij97H9ewFwWq0FOGONPD0JURXB89BCnhfC0+IHbTi+dhfB DX9HY11NCoJm7juXv0uywv+7Zrlj37Q0RTedADmp237UUATRzmh7E+KZc6tHcZZ8 rPs+ZnY7TXXsh4JRRc8blTy6aEN7/iYMXhk0mIpzjTha2Gq5OqBLustBkeFnoPQS cac6TOWbEkxg80dI5jX/qK901RRwLztrA0QDeWB+HLbkjIErdAlz5pgo1Nu3vQt6 vLdu7bBYsUa2Y2IaVBNLgmzEiZGwQJMjvbs5tLv8VYBCypb4I4vRJrkG4wWsUimM +sR7SKHu9FFt2ZdHAgMBAAGjgbwwgbkwHQYDVR0OBBYEFA51eHepg7Tp5bi6Ao5F B01/5+GoMIGJBgNVHSMEgYEwf4AUDnV4d6mDtOnluLoCjkUHTX/n4aihXKRaMFgx DjAMBgNVBAMTBWFsaWNlMUYwRAYDVR0RFD11bmlmb3JtUmVzb3VyY2VJZGVudGlm aWVyOmh0dHA6Ly9sb2NhbGhvc3Q6ODAwMC9hbGljZS5mb2FmI21lggkAubDTMqGq VjUwDAYDVR0TBAUwAwEB/zANBgkqhkiG9w0BAQUFAAOCAQEAreudH4Y7R9Vl2GJo 2xRUEwZiMj/ogomZ7B+IZtcuMIR8X2mzQ30xmPKaCy/fjbueqBroIDdxFeQ4eWZf MD3AK/q5lJXwSInDjnn7jE9gNgLdQeCnajV0/QH+eDxIe/Alvx+RuvrDiNOudEs4 vhqv5zEaL6VEXoWVb4/cghDbynQucSpyOMmGGPYYw2zmg0nNXdQauYWDUZIaDwQ6 tM/pi2ewYubHPZdwJv5jvxTN3Z7RuuGHM+aLAZSAqSgAi0ml8PYYd2eRzXMaEI0c eajcEvVa405aYT6dxuF1qqRDYx14As/R7O5RKCpz7wsxD6ICD/Ynv3GCUGxANQim bcCjpg== -----END CERTIFICATE----- node-v4.8.2/test/fixtures/b/000755 000766 000024 00000000000 13070706736 016032 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/break-in-module/000755 000766 000024 00000000000 13070706736 020564 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/breakpoints.js000644 000766 000024 00000000360 13070706736 020467 0ustar00iojsstaff000000 000000 debugger; function a(x) { var i = 10; while (--i != 0); debugger; return i; } function b() { return ['hello', 'world'].join(' '); } a(); debugger; a(1); b(); b(); setInterval(function() { }, 5000); now = new Date(); debugger; node-v4.8.2/test/fixtures/breakpoints_utf8.js000644 000766 000024 00000000354 13070706736 021440 0ustar00iojsstaff000000 000000 debugger; function a(x) { var i = 10; while (--i != 0); debugger; return i; } function b() { return ['こんにち', 'わ'].join(' '); } a(); a(1); b(); b(); setInterval(function() { }, 5000); now = new Date(); debugger; node-v4.8.2/test/fixtures/catch-stdout-error.js000644 000766 000024 00000000460 13070706736 021700 0ustar00iojsstaff000000 000000 function write() { try { process.stdout.write('Hello, world\n'); } catch (ex) { throw new Error('this should never happen'); } setImmediate(function() { write(); }); } process.stdout.on('error', function(er) { console.error(JSON.stringify(er)); process.exit(42); }); write(); node-v4.8.2/test/fixtures/cert.pem000644 000766 000024 00000004017 13070706736 017253 0ustar00iojsstaff000000 000000 -----BEGIN CERTIFICATE----- MIIDNDCCAp2gAwIBAgIJAJvXLQpGPpm7MA0GCSqGSIb3DQEBBQUAMHAxCzAJBgNV BAYTAkdCMRAwDgYDVQQIEwdHd3luZWRkMREwDwYDVQQHEwhXYXVuZmF3cjEUMBIG A1UEChMLQWNrbmFjayBMdGQxEjAQBgNVBAsTCVRlc3QgQ2VydDESMBAGA1UEAxMJ bG9jYWxob3N0MB4XDTA5MTEwMjE5MzMwNVoXDTEwMTEwMjE5MzMwNVowcDELMAkG A1UEBhMCR0IxEDAOBgNVBAgTB0d3eW5lZGQxETAPBgNVBAcTCFdhdW5mYXdyMRQw EgYDVQQKEwtBY2tuYWNrIEx0ZDESMBAGA1UECxMJVGVzdCBDZXJ0MRIwEAYDVQQD Ewlsb2NhbGhvc3QwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBANdym7nGe2yw 6LlJfJrQtC5TmKOGrSXiyolYCbGOy4xZI4KD31d3097jhlQFJyF+10gwkE62DuJe fLvBZDUsvLe1R8bzlVhZnBVn+3QJyUIWQAL+DsRj8P3KoD7k363QN5dIaA1GOAg2 vZcPy1HCUsvOgvDXGRUCZqNLAyt+h/cpAgMBAAGjgdUwgdIwHQYDVR0OBBYEFK4s VBV4shKUj3UX/fvSJnFaaPBjMIGiBgNVHSMEgZowgZeAFK4sVBV4shKUj3UX/fvS JnFaaPBjoXSkcjBwMQswCQYDVQQGEwJHQjEQMA4GA1UECBMHR3d5bmVkZDERMA8G A1UEBxMIV2F1bmZhd3IxFDASBgNVBAoTC0Fja25hY2sgTHRkMRIwEAYDVQQLEwlU ZXN0IENlcnQxEjAQBgNVBAMTCWxvY2FsaG9zdIIJAJvXLQpGPpm7MAwGA1UdEwQF MAMBAf8wDQYJKoZIhvcNAQEFBQADgYEAFxR7BA1mUlsYqPiogtxSIfLzHWh+s0bJ SBuhNrHes4U8QxS8+x/KWjd/81gzsf9J1C2VzTlFaydAgigz3SkQYgs+TMnFkT2o 9jqoJrcdf4WpZ2DQXUALaZgwNzPumMUSx8Ac5gO+BY/RHyP6fCodYvdNwyKslnI3 US7eCSHZsVo= -----END CERTIFICATE----- -----BEGIN RSA PRIVATE KEY----- MIICXgIBAAKBgQDXcpu5xntssOi5SXya0LQuU5ijhq0l4sqJWAmxjsuMWSOCg99X d9Pe44ZUBSchftdIMJBOtg7iXny7wWQ1LLy3tUfG85VYWZwVZ/t0CclCFkAC/g7E Y/D9yqA+5N+t0DeXSGgNRjgINr2XD8tRwlLLzoLw1xkVAmajSwMrfof3KQIDAQAB AoGBAIBHR/tT93ce2mJAJAXV0AJpWc+7x2pwX2FpXtQujnlxNZhnRlrBCRCD7h4m t0bVS/86kyGaesBDvAbavfx/N5keYzzmmSp5Ht8IPqKPydGWdigk4x90yWvktai7 dWuRKF94FXr0GUuBONb/dfHdp4KBtzN7oIF9WydYGGXA9ZmBAkEA8/k01bfwQZIu AgcdNEM94Zcug1gSspXtUu8exNQX4+PNVbadghZb1+OnUO4d3gvWfqvAnaXD3KV6 N4OtUhQQ0QJBAOIRbKMfaymQ9yE3CQQxYfKmEhHXWARXVwuYqIFqjmhSjSXx0l/P 7mSHz1I9uDvxkJev8sQgu1TKIyTOdqPH1tkCQQDPa6H1yYoj1Un0Q2Qa2Mg1kTjk Re6vkjPQ/KcmJEOjZjtekgFbZfLzmwLXFXqjG2FjFFaQMSxR3QYJSJQEYjbhAkEA sy7OZcjcXnjZeEkv61Pc57/7qIp/6Aj2JGnefZ1gvI1Z9Q5kCa88rA/9Iplq8pA4 ZBKAoDW1ZbJGAsFmxc/6mQJAdPilhci0qFN86IGmf+ZBnwsDflIwHKDaVofti4wQ sPWhSOb9VQjMXekI4Y2l8fqAVTS2Fn6+8jkVKxXBywSVCw== -----END RSA PRIVATE KEY----- node-v4.8.2/test/fixtures/child-process-message-and-exit.js000644 000766 000024 00000000051 13070706736 024033 0ustar00iojsstaff000000 000000 process.send('hello'); process.exit(0); node-v4.8.2/test/fixtures/child-process-persistent.js000644 000766 000024 00000000041 13070706736 023077 0ustar00iojsstaff000000 000000 setInterval(function() {}, 500); node-v4.8.2/test/fixtures/child-process-spawn-node.js000644 000766 000024 00000000352 13070706736 022757 0ustar00iojsstaff000000 000000 var assert = require('assert'); function onmessage(m) { console.log('CHILD got message:', m); assert.ok(m.hello); process.removeListener('message', onmessage); } process.on('message', onmessage); process.send({ foo: 'bar' }); node-v4.8.2/test/fixtures/child_process_should_emit_error.js000644 000766 000024 00000000267 13070706736 024602 0ustar00iojsstaff000000 000000 var exec = require('child_process').exec; [0, 1].forEach(function(i) { exec('ls', function(err, stdout, stderr) { console.log(i); throw new Error('hello world'); }); }); node-v4.8.2/test/fixtures/cluster-preload-test.js000644 000766 000024 00000000317 13070706736 022232 0ustar00iojsstaff000000 000000 var cluster = require('cluster'); if (cluster.isMaster) { cluster.fork(); // one child cluster.on('exit', function(worker, code, signal) { console.log('worker terminated with code ' + code); }); } node-v4.8.2/test/fixtures/cluster-preload.js000644 000766 000024 00000001035 13070706736 021253 0ustar00iojsstaff000000 000000 var assert = require('assert'); // https://github.com/nodejs/node/issues/1803 // this module is used as a preload module. It should have a parent with the // module search paths initialized from the current working directory assert.ok(module.parent); const expectedPaths = require('module')._nodeModulePaths(process.cwd()); assert.deepStrictEqual(module.parent.paths, expectedPaths); var cluster = require('cluster'); cluster.isMaster || process.exit(42 + cluster.worker.id); // +42 to distinguish // from exit(1) for other random reasons node-v4.8.2/test/fixtures/clustered-server/000755 000766 000024 00000000000 13070706736 021107 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/create-file.js000644 000766 000024 00000000277 13070706736 020335 0ustar00iojsstaff000000 000000 var fs = require('fs'); var file_name = process.argv[2]; var file_size = parseInt(process.argv[3]); var fd = fs.openSync(file_name, 'w'); fs.ftruncateSync(fd, file_size); fs.closeSync(fd); node-v4.8.2/test/fixtures/cycles/000755 000766 000024 00000000000 13070706736 017073 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/debug-target.js000644 000766 000024 00000000043 13070706736 020516 0ustar00iojsstaff000000 000000 var a = 0; a += 1; a += 2; a += 3; node-v4.8.2/test/fixtures/debug-uncaught.js000644 000766 000024 00000000426 13070706736 021053 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); const assert = require('assert'); const debug = require('_debugger'); function emit() { const error = new Error('sterrance'); process.emit('uncaughtException', error); } assert.doesNotThrow(emit); debug.start(['fhqwhgads']); emit(); node-v4.8.2/test/fixtures/debugger-util-regression-fixture.js000644 000766 000024 00000000152 13070706736 024546 0ustar00iojsstaff000000 000000 'use strict'; const util = require('util'); const payload = util.inspect({a: 'b'}); console.log(payload); node-v4.8.2/test/fixtures/deprecated-userland-function.js000644 000766 000024 00000000215 13070706736 023703 0ustar00iojsstaff000000 000000 const util = require('util'); function deprecatedFunction() { } util.deprecate(deprecatedFunction, 'deprecatedFunction is deprecated.')(); node-v4.8.2/test/fixtures/deprecated.js000644 000766 000024 00000000051 13070706736 020243 0ustar00iojsstaff000000 000000 require('util').p('This is deprecated'); node-v4.8.2/test/fixtures/destroy-stdin.js000644 000766 000024 00000000031 13070706736 020751 0ustar00iojsstaff000000 000000 process.stdin.destroy(); node-v4.8.2/test/fixtures/dherror.pem000644 000766 000024 00000000161 13070706736 017757 0ustar00iojsstaff000000 000000 -----BEGIN DH PARAMETERS----- AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA -----END DH PARAMETERS----- node-v4.8.2/test/fixtures/doc_inc_1.md000644 000766 000024 00000000070 13070706736 017746 0ustar00iojsstaff000000 000000 Look [here][]! [here]: doc_inc_2.html#doc_inc_2_foobar node-v4.8.2/test/fixtures/doc_inc_2.md000644 000766 000024 00000000052 13070706736 017747 0ustar00iojsstaff000000 000000 # foobar I exist and am being linked to. node-v4.8.2/test/fixtures/doc_with_includes.md000644 000766 000024 00000000051 13070706736 021615 0ustar00iojsstaff000000 000000 @include doc_inc_1 @include doc_inc_2.md node-v4.8.2/test/fixtures/doc_with_yaml.md000644 000766 000024 00000000655 13070706736 020763 0ustar00iojsstaff000000 000000 # Sample Markdown with YAML info ## Foobar Describe `Foobar` in more detail here. ## Foobar II Describe `Foobar II` in more detail here. ## Deprecated thingy Describe `Deprecated thingy` in more detail here. ## Something Describe `Something` in more detail here. node-v4.8.2/test/fixtures/echo-close-check.js000644 000766 000024 00000000713 13070706736 021244 0ustar00iojsstaff000000 000000 var common = require('../common'); var assert = require('assert'); var net = require('net'); var fs = require('fs'); process.stdout.write('hello world\r\n'); var stdin = process.openStdin(); stdin.on('data', function(data) { process.stdout.write(data.toString()); }); stdin.on('end', function() { // If stdin's fd was closed, the next open() call would return 0. var fd = fs.openSync(process.argv[1], 'r'); assert(fd > 2); fs.closeSync(fd); }); node-v4.8.2/test/fixtures/echo.js000644 000766 000024 00000000337 13070706736 017070 0ustar00iojsstaff000000 000000 var common = require('../common'); var assert = require('assert'); process.stdout.write('hello world\r\n'); var stdin = process.openStdin(); stdin.on('data', function(data) { process.stdout.write(data.toString()); }); node-v4.8.2/test/fixtures/elipses.txt000644 000766 000024 00000072460 13070706736 020027 0ustar00iojsstaff000000 000000 …………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………………node-v4.8.2/test/fixtures/empty/000755 000766 000024 00000000000 13070706736 016747 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/empty.js000644 000766 000024 00000000000 13070706736 017273 0ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/empty.txt000644 000766 000024 00000000000 13070706736 017476 0ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/exit.js000644 000766 000024 00000000044 13070706736 017116 0ustar00iojsstaff000000 000000 process.exit(process.argv[2] || 1); node-v4.8.2/test/fixtures/exports-function-with-param.js000644 000766 000024 00000000063 13070706736 023544 0ustar00iojsstaff000000 000000 module.exports = function foo(arg) { return arg; } node-v4.8.2/test/fixtures/file-to-read-with-bom.txt000644 000766 000024 00000000017 13070706736 022344 0ustar00iojsstaff000000 000000 abc def ghi node-v4.8.2/test/fixtures/file-to-read-without-bom.txt000644 000766 000024 00000000014 13070706736 023071 0ustar00iojsstaff000000 000000 abc def ghi node-v4.8.2/test/fixtures/fixture.ini000644 000766 000024 00000000450 13070706736 017777 0ustar00iojsstaff000000 000000 ; a comment root=something url = http://example.com/?foo=bar [ the section with whitespace ] this has whitespace = yep ; and a comment; and then another just a flag, no value. [section] one=two Foo=Bar this=Your Mother! blank= [Section Two] something else=blah remove = whitespacenode-v4.8.2/test/fixtures/foafssl.crt000644 000766 000024 00000002777 13070706736 017775 0ustar00iojsstaff000000 000000 Bag Attributes friendlyName: Me's Not a Certification Authority ID localKeyID: 98 CC 02 91 83 8D 14 4A 60 40 B7 11 E8 EF A9 01 4B D7 16 8A subject=/O=FOAF+SSL/OU=The Community Of Self Signers/UID=http://example.com/#me/CN=Me issuer=/O=FOAF+SSL/OU=The Community of Self Signers/CN=Not a Certification Authority -----BEGIN CERTIFICATE----- MIIDVDCCAr2gAwIBAgIQRLIhwZ2N3ciEdpWb6kPmPzANBgkqhkiG9w0BAQUFADBj MREwDwYDVQQKDAhGT0FGK1NTTDEmMCQGA1UECwwdVGhlIENvbW11bml0eSBvZiBT ZWxmIFNpZ25lcnMxJjAkBgNVBAMMHU5vdCBhIENlcnRpZmljYXRpb24gQXV0aG9y aXR5MB4XDTExMDgzMDE3MzIwNFoXDTEyMDgyMDE5MzIwNFowcDERMA8GA1UECgwI Rk9BRitTU0wxJjAkBgNVBAsMHVRoZSBDb21tdW5pdHkgT2YgU2VsZiBTaWduZXJz MSYwJAYKCZImiZPyLGQBAQwWaHR0cDovL2V4YW1wbGUuY29tLyNtZTELMAkGA1UE AwwCTWUwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCm9EqcJXkUMSFP XIevngQBd6i7iayAP34Ju8OlUZ80nNm5xAvkNtCqgjqUFH4myJJIraK+PdTTTowo lkaUsgR9IXtPEpk3Hqk6g8iauUQHJBMeZfKwFh3pVgzenBNFVVKy9Jzw+wDY13Uy MkkT9vgP8p0KEx0p2wav+L4ZG3kg3C2uHCbqgqR4R6EDke879qq7PMQP+CEAsDpP D/GAknjk3f2n3pVO1W3HrZpH7rw313GjZvxgpby3I3O+wYBkmz76DpCScHIQtBuQ Ayuxi8kfIEbr2vEZH0pOJtcYecTHhnti/NUI6M5m6C0SinHpFYCfz0To3ndAZ/He XXC5wDaHAgMBAAGjeDB2MAwGA1UdEwEB/wQCMAAwDgYDVR0PAQH/BAQDAgLsMBEG CWCGSAGG+EIBAQQEAwIFoDAdBgNVHQ4EFgQU3gJIUFpe8rKklsjEdsxlaT6rZhow JAYDVR0RAQH/BBowGIYWaHR0cDovL2V4YW1wbGUuY29tLyNtZTANBgkqhkiG9w0B AQUFAAOBgQBLhwWbYMdeSkVZ4biVUle+XHP4Gv8V9WSfldvgn1PntS1lpVR46Exl AkLO1SrnN5WHeAjv6VNb3KmTF+QhLt/4a1l9CEEeZSg5ml5aeXE+veobgypDoam+ NKYAeIW9Wx+HcgBL4leIX3WiCKu/eal+a5ro18LQ8hkZqryHeVESIw== -----END CERTIFICATE----- node-v4.8.2/test/fixtures/foafssl.key000644 000766 000024 00000003540 13070706736 017762 0ustar00iojsstaff000000 000000 Bag Attributes friendlyName: Me's Not a Certification Authority ID localKeyID: 98 CC 02 91 83 8D 14 4A 60 40 B7 11 E8 EF A9 01 4B D7 16 8A Key Attributes: -----BEGIN PRIVATE KEY----- MIIEvwIBADANBgkqhkiG9w0BAQEFAASCBKkwggSlAgEAAoIBAQCm9EqcJXkUMSFP XIevngQBd6i7iayAP34Ju8OlUZ80nNm5xAvkNtCqgjqUFH4myJJIraK+PdTTTowo lkaUsgR9IXtPEpk3Hqk6g8iauUQHJBMeZfKwFh3pVgzenBNFVVKy9Jzw+wDY13Uy MkkT9vgP8p0KEx0p2wav+L4ZG3kg3C2uHCbqgqR4R6EDke879qq7PMQP+CEAsDpP D/GAknjk3f2n3pVO1W3HrZpH7rw313GjZvxgpby3I3O+wYBkmz76DpCScHIQtBuQ Ayuxi8kfIEbr2vEZH0pOJtcYecTHhnti/NUI6M5m6C0SinHpFYCfz0To3ndAZ/He XXC5wDaHAgMBAAECggEAEhwrv7Zc5PDTYS1zVnx4iMQ3HGi5uouom1uvxE4PTAC7 qWf3tkCv798Cha+XY5OcMqALKEHCxU0e7QQoEdchn4UzQAePcSg1STCkYQw5seCa 5lA+vBUaF4aLDNa3TG0N9HWOVKGVnO/6OYC05qKClBBIMqCSKEkm942u6UBOql6q 71Sj1Nd/4eP9AcvgO5cgyUszM2I25LzXIZW7JLgdqXiJRj8CuY3X5FVURvadENgk ctw5EjdT7LNdc67Ot9Bs6qcVr2ld/U+4ZSC2+cqtPyn7mnA4hrYXlpA1Ilv3oRwZ aUJfG5HVV4jjNVHxDqddBh3UhOxJYZ1DNEMndTBx8QKBgQDcsrLfkE6utaj8w/of Hk/aq1JRNLgSvhoP2wVmK7USvYFj7DIvL4CqyghY5TLgNk272v8mT0Q7R6AtsOUk Gf50uZFAtIoPvTsvBu6cbRsPTeGJ0i1+LLme/AJu3MexXLF6mlzoGmlx8V7CoFqI 9hvqBA5rZ6ecoSjmU2q2xWKXKQKBgQDBqNqicSp2jnHiTXYbG/tsnxhFwALdEjvb EgZprmoBzo1eQFOY/DNBdDiEZBstu9mJBX3XWTU1F4c6tYRocNCMDwLBZAB6NnVM JjoddJApa5Qg3uoXmk53saZhcVkOzh+P/Dxg9c9O3q4DDUegnkM95ZSbCPtIBq6K bPA3OS+GLwKBgQCY0022LjGuHbFlRzg+sDjPzW71OLJ2mBln/VyhwYZj8cJVtUuT DSvmGHzrQduXE0OE4ENq/dzbx9+NhD9IXo+ruIxy6BHqkDkZeY1l2M+yK1YQn/BM vR/UjeIJbu0BTpS/t4C6YP+/nUrnLy9CRFpUFHb/vQl+FsNBq2XsJob88QKBgQCD 6B5bbNduf2HEsdxTZMDhYJAo2jtZFxVcBzAFBb7A0k7qNsh6OLY0zBO+4Wy9vujR 8sKfTuz157u9WmwAs27pJ0RKM3I7zCIjJxqIe5/CBruTlCJAx2LRFljsoEb31aAb 88Owi12ULAq8m2wBVCsa2uhYnUqC6cIzGTaZdsMPEwKBgQDJXI+J2d36IWzFrByH yskssFldbLxm/7EexzAYuoSpHuQIxGJYHTHn6CZhqrX8UbxVnS909ES+17kdLZVP egvaxn1mtfZInnH64PiQDQrsNnbP4Zg8yvLvIcEVIPqnSQ5QrhdR29tjYuDwUIKM 4BMR2yfkFp6URRX7ZD1UQsduww== -----END PRIVATE KEY----- node-v4.8.2/test/fixtures/foo000644 000766 000024 00000000024 13070706736 016313 0ustar00iojsstaff000000 000000 exports.foo = "ok" node-v4.8.2/test/fixtures/GH-1899-output.js000644 000766 000024 00000000037 13070706736 020413 0ustar00iojsstaff000000 000000 console.log('hello, world!'); node-v4.8.2/test/fixtures/GH-892-request.js000644 000766 000024 00000001105 13070706736 020450 0ustar00iojsstaff000000 000000 // Called by test/pummel/test-regress-GH-892.js var https = require('https'); var fs = require('fs'); var assert = require('assert'); var PORT = parseInt(process.argv[2]); var bytesExpected = parseInt(process.argv[3]); var gotResponse = false; var options = { method: 'POST', port: PORT, rejectUnauthorized: false }; var req = https.request(options, function(res) { assert.equal(200, res.statusCode); gotResponse = true; console.error('DONE'); res.resume(); }); req.end(new Buffer(bytesExpected)); process.on('exit', function() { assert.ok(gotResponse); }); node-v4.8.2/test/fixtures/global/000755 000766 000024 00000000000 13070706736 017051 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/google_ssl_hello.bin000644 000766 000024 00000001005 13070706736 021617 0ustar00iojsstaff000000 000000 {$ }м{e%ųLPSݝQ {hҟ)(KV#Pʏ@$+/ 329/5 www.google.com  #aIoal/f<{6l'b 7^sCg=a/*cj&T7Rg@*  zs*MS gN`6xzѳ$b"HZQ?gyN@F3tspdy/3.1h2-14http/1.1uP <node-v4.8.2/test/fixtures/internal-modules/000755 000766 000024 00000000000 13070706736 021073 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/invalid.json000644 000766 000024 00000000106 13070706736 020127 0ustar00iojsstaff000000 000000 { "name": "foo", "version": "0.0.1" "description": "im broken" }node-v4.8.2/test/fixtures/json-with-directory-name-module/000755 000766 000024 00000000000 13070706736 023736 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/keys/000755 000766 000024 00000000000 13070706736 016564 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/listen-on-socket-and-exit.js000644 000766 000024 00000000642 13070706736 023056 0ustar00iojsstaff000000 000000 // child process that listens on a socket, allows testing of an EADDRINUSE condition var common = require('../common'); var net = require('net'); common.refreshTmpDir(); var server = net.createServer().listen(common.PIPE, function() { console.log('child listening'); process.send('listening'); }); function onmessage() { console.log('child exiting'); server.close(); } process.once('message', onmessage); node-v4.8.2/test/fixtures/module-load-order/000755 000766 000024 00000000000 13070706736 021124 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/module-loading-error.node000644 000766 000024 00000000007 13070706736 022504 0ustar00iojsstaff000000 000000 foobar node-v4.8.2/test/fixtures/module-require/000755 000766 000024 00000000000 13070706736 020550 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/msca.pem000644 000766 000024 00000001572 13070706736 017244 0ustar00iojsstaff000000 000000 -----BEGIN CERTIFICATE----- MIICWjCCAcMCAgGlMA0GCSqGSIb3DQEBBAUAMHUxCzAJBgNVBAYTAlVTMRgwFgYD VQQKEw9HVEUgQ29ycG9yYXRpb24xJzAlBgNVBAsTHkdURSBDeWJlclRydXN0IFNv bHV0aW9ucywgSW5jLjEjMCEGA1UEAxMaR1RFIEN5YmVyVHJ1c3QgR2xvYmFsIFJv b3QwHhcNOTgwODEzMDAyOTAwWhcNMTgwODEzMjM1OTAwWjB1MQswCQYDVQQGEwJV UzEYMBYGA1UEChMPR1RFIENvcnBvcmF0aW9uMScwJQYDVQQLEx5HVEUgQ3liZXJU cnVzdCBTb2x1dGlvbnMsIEluYy4xIzAhBgNVBAMTGkdURSBDeWJlclRydXN0IEds b2JhbCBSb290MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCVD6C28FCc6HrH iM3dFw4usJTQGz0O9pTAipTHBsiQl8i4ZBp6fmw8U+E3KHNgf7KXUwefU/ltWJTS r41tiGeA5u2ylc9yMcqlHHK6XALnZELn+aks1joNrI1CqiQBOeacPwGFVw1Yh0X4 04Wqk2kmhXBIgD8SFcd5tB8FLztimQIDAQABMA0GCSqGSIb3DQEBBAUAA4GBAG3r GwnpXtlR22ciYaQqPEh346B8pt5zohQDhT37qw4wxYMWM4ETCJ57NE7fQMh017l9 3PR2VX2bY1QY6fDq81yx2YtCHrnAlU66+tXifPVoYb+O7AWXX1uw16OFNMQkpw0P lZPvy5TYnh+dXIVtx6quTx8itc2VrbqnzPmrC3p/ -----END CERTIFICATE----- node-v4.8.2/test/fixtures/multi-alice.crt000644 000766 000024 00000002442 13070706736 020532 0ustar00iojsstaff000000 000000 -----BEGIN CERTIFICATE----- MIIDnjCCAoYCCQCXooHS0l6bHDANBgkqhkiG9w0BAQUFADCBkDELMAkGA1UEBhMC QVUxEzARBgNVBAgMClNvbWUtU3RhdGUxITAfBgNVBAoMGEludGVybmV0IFdpZGdp dHMgUHR5IEx0ZDEfMB0GA1UECwwWSW5mb3JtYXRpb24gVGVjaG5vbG9neTEUMBIG A1UECwwLRW5naW5lZXJpbmcxEjAQBgNVBAsMCU1hcmtldGluZzAeFw0xMjAzMDQx NDA4MDVaFw0xMjA0MDMxNDA4MDVaMIGQMQswCQYDVQQGEwJBVTETMBEGA1UECAwK U29tZS1TdGF0ZTEhMB8GA1UECgwYSW50ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMR8w HQYDVQQLDBZJbmZvcm1hdGlvbiBUZWNobm9sb2d5MRQwEgYDVQQLDAtFbmdpbmVl cmluZzESMBAGA1UECwwJTWFya2V0aW5nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8A MIIBCgKCAQEAz+LXZOjcQCJq3+ZKUFabj71oo/ex/XsBcFqtBThjjTw9CVEVwfPQ Qp4XwtPiB204vnYXwQ1/R2NdTQqCZu47l79LssL/u2a5Y9+0NEU3nQA5qdt+1FAE 0c5oexPimXOrR3GWfKz7PmZ2O0117IeCUUXPG5U8umhDe/4mDF4ZNJiKc404Wthq uTqgS7rLQZHhZ6D0EnGnOkzlmxJMYPNHSOY1/6ivdNUUcC87awNEA3lgfhy25IyB K3QJc+aYKNTbt70Lery3bu2wWLFGtmNiGlQTS4JsxImRsECTI727ObS7/FWAQsqW +COL0Sa5BuMFrFIpjPrEe0ih7vRRbdmXRwIDAQABMA0GCSqGSIb3DQEBBQUAA4IB AQC7kyzjGXy7SnT1tvefdvtdAtErDuD375/sB2l1V72+BNXlIlddmEC8IkAVSKg2 5Y7MuQ4yMsHlhrdUxj/XOOVMHY/49xsZiN5hF2jb2mdq7KdvlVMYqyf126bW2mOx cLVSiuucdp88zoJopWBUnNyVOYhh18St9bNosGgPzppGBCpL+MJvoSn3wrnFn8ER wwN1m3ga590wHa4fny+qlD/hJNww16wbwgdF9NqsuR/e+sj9ZsoIYRCF8iKBajzt 3o7cZIRlvGtJfJRM87YCAn4BR3JgQPXfbhx31KwtMXtAJNzOHk26bblW3jTC8c7+ Cu1gNEM083vUq6/UxJUM8lOM -----END CERTIFICATE----- node-v4.8.2/test/fixtures/nested-index/000755 000766 000024 00000000000 13070706736 020200 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/net-fd-passing-receiver.js000644 000766 000024 00000001370 13070706736 022571 0ustar00iojsstaff000000 000000 process.mixin(require('../common')); net = require('net'); path = process.ARGV[2]; greeting = process.ARGV[3]; receiver = net.createServer(function(socket) { socket.on('fd', function(fd) { var peerInfo = process.getpeername(fd); peerInfo.fd = fd; var passedSocket = new net.Socket(peerInfo); passedSocket.on('eof', function() { passedSocket.close(); }); passedSocket.on('data', function(data) { passedSocket.send('[echo] ' + data); }); passedSocket.on('close', function() { receiver.close(); }); passedSocket.send('[greeting] ' + greeting); }); }); /* To signal the test runne we're up and listening */ receiver.on('listening', function() { console.log('ready'); }); receiver.listen(path); node-v4.8.2/test/fixtures/node_modules/000755 000766 000024 00000000000 13070706736 020266 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/not-main-module.js000644 000766 000024 00000000325 13070706736 021154 0ustar00iojsstaff000000 000000 var assert = require('assert'); assert.notEqual(module, require.main, 'require.main should not == module'); assert.notEqual(module, process.mainModule, 'process.mainModule should not === module'); node-v4.8.2/test/fixtures/old-repl-history-file.json000644 000766 000024 00000000043 13070706736 022633 0ustar00iojsstaff000000 000000 [ "'=^.^='", "'hello world'" ] node-v4.8.2/test/fixtures/order_of_end_tags_5873.md000644 000766 000024 00000000117 13070706736 022263 0ustar00iojsstaff000000 000000 # Title ## Subsection ### Class Method: Buffer.from(array) * `array` {Array} node-v4.8.2/test/fixtures/packages/000755 000766 000024 00000000000 13070706736 017367 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/parent-process-nonpersistent.js000644 000766 000024 00000000425 13070706736 024026 0ustar00iojsstaff000000 000000 var spawn = require('child_process').spawn, path = require('path'), childPath = path.join(__dirname, 'child-process-persistent.js'); var child = spawn(process.execPath, [ childPath ], { detached: true, stdio: 'ignore' }); console.log(child.pid); child.unref(); node-v4.8.2/test/fixtures/pass-cert.pem000644 000766 000024 00000001274 13070706736 020221 0ustar00iojsstaff000000 000000 -----BEGIN CERTIFICATE----- MIIB2TCCAUICCQDQv9q5AAtoEzANBgkqhkiG9w0BAQUFADAxMQswCQYDVQQGEwJK UDEOMAwGA1UECBMFVG9reW8xEjAQBgNVBAoUCW5vZGVqc19qcDAeFw0xMTExMjYx NzA0MDhaFw0yMTExMjMxNzA0MDhaMDExCzAJBgNVBAYTAkpQMQ4wDAYDVQQIEwVU b2t5bzESMBAGA1UEChQJbm9kZWpzX2pwMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCB iQKBgQChmQeFwsaomtQbw9Nm55Dn6KSR9bkY8PDroQUeTNa90BlIbhGsKYm4l7bE RaasFgOrkcQpk45fdDVYPjKxraZiGXXKjSIDYeDAIC/+CkwQKrejgCPmJs4gV4g+ npvwi1gVr2NAg7fkJOyEW2TDp4dsAD8qtG8Aml0C1hJXwFYmBwIDAQABMA0GCSqG SIb3DQEBBQUAA4GBAGJYkr3VgHUZSyGrdUWeGKiKS4EY3D4ki8Luv9Jf/IpxJLbZ NGaKUbXSVYSW3US0yR1+lsNvWchmc0wLsbNEHbIiS4BQPkqX7F8FCthM1gwRLQPa Sofz3dRNFKDmivG9mdbQDPD/duft7Kn6E3JS5myYUJ0dRKeYfOXLXCY2pZpG -----END CERTIFICATE----- node-v4.8.2/test/fixtures/pass-csr.pem000644 000766 000024 00000001076 13070706736 020053 0ustar00iojsstaff000000 000000 -----BEGIN CERTIFICATE REQUEST----- MIIBcDCB2gIBADAxMQswCQYDVQQGEwJKUDEOMAwGA1UECBMFVG9reW8xEjAQBgNV BAoUCW5vZGVqc19qcDCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEAoZkHhcLG qJrUG8PTZueQ5+ikkfW5GPDw66EFHkzWvdAZSG4RrCmJuJe2xEWmrBYDq5HEKZOO X3Q1WD4ysa2mYhl1yo0iA2HgwCAv/gpMECq3o4Aj5ibOIFeIPp6b8ItYFa9jQIO3 5CTshFtkw6eHbAA/KrRvAJpdAtYSV8BWJgcCAwEAAaAAMA0GCSqGSIb3DQEBBQUA A4GBAC9g7s3rG6G7JSTUOizY1u9Ij6QM9Y6PqQthr4OJHa+Hln5FJQahpgJmA4kC WYoWvBMBgFPFBCYAj0yMPohrlAwlbd9MADe4gg3lxuO9UxXDzp/lOVRBAEa4n5i+ Lw7VEiJtPha4NXgeNzxi5OyBJwxAOPFwsyCdR0SynlifTFHI -----END CERTIFICATE REQUEST----- node-v4.8.2/test/fixtures/pass-key.pem000644 000766 000024 00000001741 13070706736 020053 0ustar00iojsstaff000000 000000 -----BEGIN ENCRYPTED PRIVATE KEY----- MIICojAcBgoqhkiG9w0BDAEDMA4ECMeM7uTE/aoCAgIIAASCAoDIIO3VAz+gb7td FSOwV/zshzjr7n54r6Jg6fFyeIRrE3tgobr0loPfZUadtd1uxGMFlf4WKqXdk9u/ Le2BCw34rTVCIlwritFHmcQ56xDKB5WTx+yuzxr97tmnFq00kTeHUcsPOb+eYU5B 2M0xWpYeEUP4iwQafUz6A6EOjSADYYpdgHHAzIY9VwECPkCqOJJti644OMNPUw8q nvoESqwjAO1t2lymNUFk6zHg6FewiyCfjY6ucUCadbN74vUqKAJI45u7HQL8rxSf 95ncmjpHc+t7GUrQyzD68JaIGFN1Q8d09/ve3EOfoUoDGW+rE3hJ7oISeJfY3k7I bBw6i0MO/ZfMs9wbmbMNDKzXQMolXfenK+KdD5Scp6eCeE14KqbQXuDoy+yA9CcZ F87v4AyiY2o+A+cS56oY2R9Gc7uX51N8ZQGCuE/IEXeZbemV81br/EytJiZsXbPj Kks1QkcsWnfsCUEeyF6IvIRXB70A4fuJ3+V9YoPoIawY18OoRPbMBBWkfMwEJIdB 2bW3joco0unImwRT6aXFghCnHOdXyQOMNtf1aCSDd/7o+Vac50Lwtuwpp7NsnUID V9reIaEugHuM3PHbv3ygm8o3wb2VVRHgWV/wOReEtqLPhERyM1xfVs0y6xCGiE84 N4uEzAwSGDFgEYACoj7LrqrVVEeVbrD0Gul2/fq9HnKOk6E/tygrwusasyL5vtSX ZH/DeKK2XKq70bSu+1eGA/A+SqySckBe4QgEO7Qyb9xWqZhbqDyLg/xCUfDscMyP WWW6nN56LcWI7UOEfWJVLTFCBil5T4e2qA4BiJTNc8zwwOM0BIyqvnhlENGbwQBI KuSCzKIh -----END ENCRYPTED PRIVATE KEY----- node-v4.8.2/test/fixtures/path.js000644 000766 000024 00000000556 13070706736 017111 0ustar00iojsstaff000000 000000 // This is actually more a fixture than a test. It is used to make var common = require('../common'); // sure that require('./path') and require('path') do different things. // It has to be in the same directory as the test 'test-module-loading.js' // and it has to have the same name as an internal module. exports.path_func = function() { return 'path_func'; }; node-v4.8.2/test/fixtures/person.jpg000644 000766 000024 00000131132 13070706736 017622 0ustar00iojsstaff000000 000000 JFIFHHJPhotoshop 3.08BIMHH8BIM\action conference copenhagencphdenmarkrebootreboot118BIM I@@IAdobed           s!1AQa"q2B#R3b$r%C4Scs5D'6Tdt& EFVU(eufv7GWgw8HXhx)9IYiy*:JZjzm!1AQa"q2#BRbr3$4CS%cs5DT &6E'dtU7()󄔤euFVfvGWgw8HXhx9IYiy*:JZjz ?~X,a7UXWMpAH_56I:h4}b]G҂ʓBrs^,5h9rHCpˈ$xI*R.ՖKWbX癧~|?}2\d~OyNllPt~=Օ%TV(׋) śD%<']^o/LSޡ&HEۯ')HR:HP[I!*e#!oY?RE=4}$O5<~Y8l?(-5E$H9D=GrJr,7Y93wޢNL9A/GgY+.<јڭ^_Z.JebTJӝY,oC;f(9/RI7V u VT/.ekՙCr?"j >.e l T 4$#SP+ïd&dOI/?ycN^KRCEi#9 %WYo"owPޓ|KQ^$ l1zc6]ZSnq`{ qkS%CFs"3c @AZRmV,q[G+L#t=0(n$tߙEdHMKޤckH S_eZs,X3? iKz}z Mdz6.x[퀁i-o\R\J'IQHj8ـT#c--|$f89g~QWn9L0XɢkW24[=|UQ1,BPqU1Rlp @U4OK0ᏤZ@_Vgbhb}/ qrO$ԭRoSd(DQnMO[C^>IW_>\KZsYu7RQx.(J7=˫l9 c.t2Hz]<*i_# kҔAjQi~kmq2&]yEVl8ɐZ=-}EL( Gs.RRU;e eG^!腙ܗ(3!6Y5Vcp}Vi#U(P8帀<(ϾL KQ ~뗎I,D+,b/_-i:MjrDзU?@ !~n׬g{T 095݉fAHE~^mKΔMH(欫&Eh^~Ω\B V̜w+O3H!`*Ȩ"hH8fJ`Wb]私|9f{NNՃlJI &Y5orIBÊ!PBb?S)5}= 6kIm>kJ$`5pC8ɫ]F/hCxʫ<)|U_˚4y9 }k}RX[]Io_?VVG8̃t̄,㶺ēړ#5կLHEknY9"?Rm=2#2NmgKU? c(q'bƿ<Mwډa2q2NyYΞgм{uF-~ JbX=I4SFbGrHA6+t(YVrDDC|(gq_v-mIDb<PbH(=u.FP%AW8evȖ Uت;RbzPx* c#C4 8M94? W0@&_7wV ު伆b3Cӧ4ÿ6|k}UZ+%QVj>ڡ<[K1;FO{<ϡy.d6ڟG*7f cIGă: LXbNU{표E7F #}SWMjA$-_$~'~_HO>-O.qYWd}T#kj` $O$/7i,׏IqlՆwS{/\TR"n &.əD;ْivҖWCF80XS Rv< @5h-4 k_B _:d|!2k}ŲxO\ҷ= RVnbʴZ g#5,cZY _yScrq@7C w$9l1U1%-4ŞQRFޝ~ُ7aSu,i\^sPҊ&`@ve qg]}mRFp^=v*UkaCӹEԢY(p(^9 j|9-= bR@4)@v,(\l SAǞ UfVF ܿt@YW \ 2,reeDj=VYfy1YLTԴ1<њt[KH9#SʽlƕX~ޅ%G7Rnזw/۰;5b*QYUxN\Sy"&At5kgcl-ܑna^4J=0%*yp̿g'@ y ٧4>KB-r=.@ S@qe>~,#oEm:]H%@yF*ՙke Aoyѣi"x kVlX'LIZثz0\BK)o6MrA&=D0zUi~ B; &;~h򧔭/A;gMReeЏ?gY8,4#xu1ۿڷ S#GS PUثPRJ'a+[X[m1 bO&ZȂ60@Dw5?g98ryw夫l$i$'Mۊ?pjG)r<ɃkGoC]Jo,b(%: jD7jPBJB< bnը?#'Z~:"X~Qژg^Bwu :u ; կ}a_P֔AnX;\C#FԲ H9|G`f"#>FwIG7fƈ@h˕EY"x=Krzۉ\8y|M醮cS/q,uk(~||䫩UE@U e;d+z%Z\r0P‹[^"N]Z֥C'O_MV 9Zih)\i:q o2*(䢵.'c̶eT$/܌ Ioh]K5ᗚ9iAcwa 3D,v:c1%/$0mMlyw,+:vzc r, ȳ{}LQfбzaXaIG[6Isnx9N)݆2K B eʮAwO[Lڏ$7c_Wzqk`?D;W9Elyjߚ6~RY$E+ȫ͔ %\Da5ҵ'v.մ)$"7d^TUUkaCI懐el/NQ*殄2IE≈T)/kheԍmG,LGd4R>ҷl2dknYe|qM>WǕٵ%X>!#bjn(H_tK-mPQ"Q (Mk_Z,$'d)5[#sl[ SqZ+5PhWbc/h/RViI%d5@5OִIt)lRz&;e6C˼mך!8eqrLK2IZX]-ȷRYh<rK-厥p'&f(ԃ}Aחq? ꥀ^fE'qf|ȞiBmy g>*> 2rLҠiڄ7vs"9G:+s"O~HclPc.;b"M>귶zd% my b7_>$?g1BdiE[M}|~UEP0*e%[(o\žDAkE;q Yq-՜?WoL eF`+Z6eės@ȴq? >1k) ]4d.\[F!P+L>ն<:$p?.mb:I-̆IX3*n)ZŨF1YcP+ѾUz'")rr^6n4o@@#Ăr>^-H#qB~S^2VcCLmõ$*Yf+~GԄC 'Pef< ^ k&OZEf]_$?$*> mޙ~Ͷc嗎l$9& vVU@b ݾ VTE+OJ2D7e \8{np^7#~1~g 'LQA@zm4f_$ߘ]?چsg:ު1̆(~k˖aGF{EEvVYc:\LqHb!a}IWyq8 +A^yg:ƣrj`ĄIh_2ju*1p~9!vS6yMTyZS^DuHX8&)d+ܷ0oԮN5{D9}һͯ䊶јd(ݨƤSlE≭= R:[b7 k1dE/י.l!cY$|4')XZ}5&mtAS:)z嵦5:ipx3uF~Dps##yy^@巈L>j(Oˣ+.4H\=5[3=v֣w/֭!a;dx[8=[$ThI Ei琕G41#N !F+]{l2oW6CZZZA9y?-y~d@NaHH\t%0ݖ ˽9P~ pl\#b8ZWb&;mʿN)Kw$}4.uJ}$dK zsI;&hZƝMkn=j@iUNAkK>$'&[c jiAYiȞȶ*M#*L O_dwԅeЩ1O(0aV f&C\WkI)x`SYqx9~$Lʆ^#դN Kh8Ud+ /qP*ZɒHڳ[7zLVyUJ^r+rW -A}KZ0oM9@z ̈ fH&xeROPA+A+dH.uwPG=UI^3L(gzKN R/dHmi% RHbo4$x/?͐'2cO}RIo Dɽ+@Os'f>J u[DhcKj#u4R~_S +هZ UE7 = PN {v-Y^I}?֭b) /NURzwRyuY9g@HӿE-:^B vCMTPl~|x7~njܲ%ߖ+`K$N,QpMՂZ~ce\ǫ~?ʞ1ˤ:l\z\&+y#wػ'1!z-3+E9Eo59XHȺwTC&*fK,J;lQŅټKo beG_k9-054PPݖdO+1.-R~Eyl6DіFI4UB)>7&1FuI&# e#5vSsY>BisH[%.K: 08r]~ňypN9AOb-!դd)bQTEBkzrf\x8fW"Q4O)GȺvՒZgKk |Xp,>^"mMCt[ߣC|ۢc^/Ͷ!~"-R:kƠq .(* ɱQ^m P@eEZ #0yޮ?QĤ#lŔ"̈TĊ(WpA\l`'ɵiN@+Cܡ 6esLO cb5%;{;Hu)g5G6*Yx߷~cfG(bV7 *)vsX̂?g15z_Xq0۪k˩]OWFÍ#v+deQl5 8h03U~zҎο𿵌J[#tux8sFGqnFs,aXxmNGS@A}SLk~>ۺ銀 >GE^3E]I#%a<^;T/HpoOķl'1[}b$dWNUE߷Ԭ֒I؅K˳ $Wq[gvf мf?g9D3qْU5ϥϤd ]QV6n_.2;.Ey4f+sw¥I٤Os&#Qdۗ1:q<q749"L_ %R')t6nG-]qHq+7_>fds>Y<$}V;F{\#Q(m/% SE* rڃ $̭lOUF9,;|'jq2I4eeUUN$azev$#Y@Pn+L^|kZlcV41 !$Qѿ [^p/&6+ ŀ,֊@o.^(l_:yR֢ңKDJb`U%Qg*AFQE ny ҹ␫J#G+3/NMl‘@$tp5ֈ+Aq?K Dx< )Ɔq ݄J-.PC rժ.} &Y4KBfJWiF#dɖ*7,H|0%cP]ojP)tOJn6:}ɶ#UQɏ2it*YcG{K1<I8myKI]joHZd+ܚ(?r-)ﾱrvPv_a/׀j=i(b |AQ Zka-ID[4qo1FBL;nͳ/(&}?_L߈e 15o&ԋs0HJ v0y6F4[tit>KQ)xg+1ɶo&ƴYkTZIHÒG7_-_Z~aoy61HU R߂er}\Ώ$ߚ_OelO"aQ݃ Qkx=YV0BOUOcg)Qj708,tb;6`!N6oUnREGÈfJ|-G%O|j2$G-C~h37aʳDzFbޢZx c">jͩ[SԪ||[f?YՇN?0f4F`HP?yHZq`jnsCUe sp{?4<]=, `WySf, G{fMO6N)fN ,B~URk<#TriSj+K)DQٕKS]P%is٠=)( 8&%^N#ETׯcC"n:V(i=+{԰ #<2reUbpӥJկb',Gs i@v r8Q8;w-: #Msx']9#?zJO$&P7ѨnD̨PycTwZc_{4SGnT*| ~ʧrn5}r $SZ&l5JQӞ0,㘼v\Oj2=TBvWgl9cYf1* u܃R ?! y{:?(G^.GN^*je~uf40<|lc/"ҿ,|}`ywx]/JQj7j(rXdIهw_Z*W97,ai F/J#@j0KC4B ^εn%Csi}U0 cD2coz M&2/evE(8!ɸ ٛ٠뉡e埘Λc7,j๱88|fE 9LEیБ =K?j73ԲHGj>O}4FLi(TBH(0kSF 0Y)60;LԡEg-AVSrɮQ_-͵4a>̈Jd4ziW3j5VqQ`\rݜ2ʛ R*pnJ*0|\f1e6i%S#Rĉ}䜈6NV,WicS*M?7%J:U̐i-ܩ8ѩeN_QciI=o$(u)!dYWu}f"NJmڽ+(b{d6):aOѓ?oÂOf~uMFtzwSMu5;#W_S-l9Sl󮝡YJa)xz: -."";qVBG&5e_H%ұ4&->;daH 18'.i;Db*H9, fqq6hfakIu*A#sU*Kpfٜ 4j^kQO<ͪS\䆐t;a֊Q-w1·7MK߄Y]R-[4ab&gg%`yWx5KDd/: fɫж$S _ַHOG'@y_PLoĖ\ IR*4"e-Vwj UN]:bBFM؆i2ES+4c$_ʚ{hqq$.ȪOel]`X䖝~y5-ޢNB脅%KL Kxоdkܾi6uYXbu|Y)x̭CʼoyaPT^t㔯ٌ1z;͞~뚼MЁ/Zb6_K#t__QVŜWo N R fոU-5󞯭 J JiD?RWfAG IsDyXF45Oo724<2r*wf݆j'in9H(__҉EeL8_5ifX^$Ct>;MsFw%ݸ viգ+4E]% gDD05$Tצ=8$@zuU呝`FM6e>Ɖv d|ѨXKf[*y1c.jY Umi_jJwma;$-:n薒>«5 U8!@ְ45~Y `ZFpt6W짗&~ȷ& yn-!,5՟ԥW1C8K7#9FBtow;-3ȗ#[iEdk#om=dߝ>s:ot[sѼלv%Q*>6L@'/x_Gԯ7GT0x䏡~`"܎Qܓ-ń9yF(7։iYx&#4 "G 2<Õ-̟D)VsfxbKh՗byM/Ooo,DRʹuߑ\6%B `z1R`2ӑl Բ{OYdk۵7{d*A0,kZ6Lo_YRX' ZML~h. Қ"H0O*i${ĨF*ȊTec>Q&REE6I6FMZSքS!m Eb݇UU#aۆT%z^ ȱzxOJP  9іUZ>PӭŧO gRĵ*vC~tn-例QzpijEI$,e Mw,`Do_Խ9yp) 31fS9?Iw3pՖGsA3Q')`2tXՈ/}i(_t$kf%n%A+Սw 'E[D-Z*~wluY4{CStHWooU5;eA1}WS]}k!Nӓ" U#om#Tt+l*Wd[T|Wb@z_$w'l? Ad~Um⽈Y45 FL AjZ#04go3@k 1WU<֭z`]co$CP)hL~tV5gcC̗, ĂX+M1[\%̲s ‹gEƬŒ(k~!JSVk2'2lQlQl,rURxOn4[5\@K5G\xS|\f <(C5?gٍ,D6!L~Wv2N24f&@PdCK,}SDe}VYe Pw=&c/V;w";YazV"4ʹ:sCM7gTM(.82}3m1djqRj&&$(rYίiZ՜Gc +}i#xf$HۄYھh9gYݞS7P7lOk$8o8PI, fhP( 5T05oLX,=TՓz7}& # 2vad-^G@8 zUc}T2>{WUaokSAFe)T8rv8~m$\:fϫڄj~"J@sysB0L-΃uhTIa2h&#;f;r$aҢ֭#`2C ̭.2j4BYcYYI}<4c2QSYe{numK dQŠ:( `X{Fif eπĤAg(iz %/?,uпKN 9"Er FRlUQ%hd>d|qTMW2mHUV8Pcڎ|K+ȤOq/Hᒐe@; i\|~=E:HaG[a&OqJZ='7 p+7&kG'm->[XUw#n y ՠLYZj7IU_-K{I6wa2Ft+y)NA[B7Ե4kW:yhijPgf)ȯ 9LzokwyF4C˧|izpM,U22?a(%8*=BioL78dP>C<l1D~+fc+_ nhܢV('C2pq3sd:Vfkؠ4-"7HضJ?Eʼ%/-RzYד䳱zC-rA3pU0?# 8tl j{qbZ* P=7,?Bo-F"(>u1a7[߾'@<% B`Mﰠ {{b_ -{Zx[q.B1*SJlGWĞLRּw/嶉SDѕH)trN[| *P*N"+|Zj^f]B6L}D-(aK5~)n%^DHwa+B*x }OfPjR -9jK$8RP8X_*_OoYjLU3 ETu*r' 65LK2=j=Fe[=L֬/FEYn.E5vOcQQaڀ1TTOlj _"0\yX!(iYz3XX "OS jǿт3 {ԝ#2;2}CN Ddb222FQ&goUxVrGH 7ˀk%럗?q.$"#yI6*hJٗP6e$RM[ӖLԜ^*Fy 2(89y[v֒#G,kv j9&@P49dm8B |30}. Ȝ]J.YðOP1 TgDZp]EE,7"Ey@* Ɵ^26TײVYI\((X_g+Yumߚt;KZ ة}tXոD BFfiv|,n$UUJemW,@MtIU4ԕt37j>󟚊C*#ۃ0ٗIIrW1dEJt#!4ESIySr07ׂv5coqp,c%ʻGo†Ah D%2E?wӊ@Jߗ!„-Ő ݱT{9#bzPR'Ÿ,. =A"W--5 y.eq) |1rJzYel]̕!3pKzXPSr0ٛILZoD b7־?X!UvqBN*P]G4eBQ[.x$&^NH8z/LI;v0W[uQN* ޫ}Jr>B丕[sKfr֞'W'4&P\VsE+T ƕ4sIKWҀC<+K$ʪ~U>z Gu3'O%=f -،}..Q8BIM%jCW6K<*GC     C     J !1"AQa2q #BR$3Cbr%Ss񃄔5!1AQaq"2#3BR$C ?{Zi> u*$Gb0]PI ʷTpôXrHq q#g8O&5%l=-;ŚbE,Ӵ2HNIf$u'fsJ.n@$A:qQ:eJ1q Ar1't,qzu % %IsVsBʏWu'z[UM,6ɥA8 ˎ4D`>9*v MWjsNK醨mG_WܤI1RGX0IHsهG]"syqh"1+jz0+ !]Ӱʝðqi՗-.+=GqU-ETy"Yf9P`s 1*W`<#Jo:SjjWvۛ1&=A0>Oep|Gx= k 5 r&_QfSe8FqӋuN䙱|a굤 -%gYh R:NP~|CKWv{Ll ^l ;!eQwEP]Xz?tB)Ąn;H-=r`? gvs=ؐ,5E!y6F4op]lIXi*1>fY#dnbBFqOi; @#)7"grvt$:oHbHf:uƑC P*8GAOғCK'$₢mE,$ VW]G@1܂T oUc.֧?u$sqà&1[znTjZ-EjEUeD˲U!PFg%8:%uYU4|`S5!}COdt|m@䴨|(=@غR6q!H'ފs~rإu9o]W]SY5ӥmt],#4UKI dϨM*oָuQr`Ya[.T:i(TM`8"\UH=OXR2fm鮞PsIiZIRΐ5v33 `9@썎 ;X t9J.V|:KnoKm4tԔ(b(EC g;o5J(o1nk[" wB|Ǝ=mXAxATR`tGYՋO\^Qb oL6Z5MYlV*y)Xf*@ђ )W եQ{$D:c0`e6+mxۓZjqD~( `6yQbzd\e!Oc:}#Mf\F*ni 5ɹTTl$NI8pυm>H[(ef5# J(ĉBv )AUc1T>'`\mV2G@3[Q#oFon*dC y?i9[ ThU7j'zJ42n :ۉ$ę͹LR44B kj!& [-Xp0r8u^x΂u1Nrz^^Nurg\cU*α10bn{^bR ^Bm} ^䖒YjMڦ!"1Py@16.4A}{c]U#rj+JaH!i`ގ{蝸V*GzX0Uƕ*KUHSy7pDQO}E,BzoIHeh͗S<3}zatGMYm jj\%AqPAYEd,'4i$dU#wqΊtEqQ"ֈuN ̭vH-|ç]ֆO5GBX$qN˖~CzqSQ7&Kf.Ujt\VJ`*LI !ٟF;R'؂4"lp vvEdPZy)ᢚZy0U3Hx,E akms~g~=lR^o]+afƋSm⏺v&V.W[*:u]I]0觩B 1x-C+z&4 SFk -Ŗ)>GIFH6U\]nTWHU3(+Q$#`G_nYMxjr?ZRT2M.dv 8 [;_Z?CcJ6I"6s|ln%̛Ư+v㫤xHT7hSnÈ'^p^ZcFf2Oˆ&8ܡc,GˌcipSx`ya 2iN -* ߄{]\]jTsAD%Ȩgkqrjhl̟N/4&/6P`>4` $%CbG~tN-G"Ou:c@c_SMv޽{VF"9Z39Ft/!egK%C@% >c˧j+U0.Lcù|q0z(HD/_+ѭ 1 'Vdw珯̬^[S.M O%k=jih1"/>z3"/1lxD"@u@CߢQzZ-W FMSizx$OE3b' Gux٨fۉ"LͶuaԭGlPU$fHsBaYfo^'xb@2I݅=NF``d m#ƩKޮl4W[i -O4-3'd>a>% ^\Ri7}ZخauBS#n{ʦ %rGӍSMkђF=GFwtAt_te!-]oZ@OU%"*x^tFUUN ='LuaE͡'x}\8?E[YSpqn\m o@% n|p gLv#8 OE;$SO+o"!튇>K?cZE_@5`E3KУp[}}}DQ#Tk$fZa"mتzSJNAT9%Y]E4RrzV,=3,0|`)o),ԊU"N q 0G̶=Ikk4oc#zaGG2"<!$cK$BZÓOݬ zmH*&dz0Sՙ< #`BivP/.\M!Kh]DZ$q:̲!1|ħ#muEWCXtl3~_IDI/P+=5sKԌ'G7S4;fSHx peljh?GP!2}ď6ؖw aIDzL,myFjI>-Ƴ(HAP.8H ):J*Z;m5G)eeFZV.Sbȫ͂tRGl~)}PGvLi ,r~ǿN@P b[qoƒl_I=1$sSyHT( g<1ðcF"$nMnTk{QU+K#")g,@Ubp@?T IA5j꪿WCQRkej#`GݹՀ$s \ܪ]lj+m=wPKwk ].U>t#H#mUDbT41ߍ<#adiޭDDV"jKVt⪆3AuR# 2ջnv2jXjQ1[ن|tI:3P٬5uEVt)c)e_ %1r˙QM7PH$Jø8 oʥ0K-&8$tpxטhs꥜p2h®pz'^GѪkS"$tWh(%w?I<\rR,Z /qiRlбO5RFz$fcd<}OOawuAj~v4փc٧y _'gͣ8GKAZTQ qijQ֥4*`A$xDb+0:4{-|'}= V]t!yhWo3?49\[gM!U]W=R҇İSҭ0ӫs!cS媝W:R$Yh>ǒ6]oj.+X4TԷ)'3%!RJ&Y@Sve*'>=Mp7[QXs{B->9[A ,'mU_ qJg;yFbZ8tu۩-W;Toq?^C#H YH;j=٤HgKu1P݇M d7iUiLc}:eH9Q4.b#|JKͷPYi)]ZZl!CC:`@nk(ڕ&2݂[ImoD_f+8% AwEJk'$䑎(~ؒFutK45E< KP`mzaߎcuJߩ/7GI0XBܮexC5/,mKQ4QO1^wG[4#F@pA=6洚/ }yWOqWADpvt'zqB u** & C~'uhH 13uD,Yujq&ex/uedg7>],]7$X*ב'hlf@OUUei"ƻP. ٵ͂E,0GR03߆ e =u_+Rꥦ TZPF@ `0~\<((Iz<:0VFxI%֚ŷ\io&@@{ DNep*A)h%:w< XZdY*+L3tt<Z@̣=^p&m:dخxI羝aɹ[ uR-szb[#Niہ/XV|T(N1#x9febˡ$zRuRp*|#9q'ujnq#M9k6H? a˛/q"}(3p`T]PTr z'+ߌNjZu ։58WIP2~Xܡ YOL*ٮqʝ@'~g_f+9j Z?07`:;Rj7"Ueq:^W^ xPN.$g5 J闡L}`xlڲ@9:|qjeMKmCw7qU2yd`*p@b3=Cc^jKD;3wE7G k*&ifPG9q2Nj-D)MAEoX+"}dvt꾜96S2V* eCliuw9ӈEsif*WQɍpRZmWg sU,S#j;vc9N: pLorX-y龉^\x6ܣ4u[#!s'T&8ivb^^pNLrh+M5DZELn8rOQߧ5b7E:CwN˛nx2`8+eq'7p$ 1ZJ\cA8ϹV=~H-Ko-XHY$ 2@?^4'0v*K59IB1 ppVoJX)t;L~S[ 5il1n' Sa᭹OW%%m?TK6Țܓ Ufʜ7Z+ !I%W]_M]W="#U[ťs`IౠX2L*MKwۅMRfTD˻{0}i]X5.\ǯzI>"Gs+ɒ|9$ @ /R?/ꯖEMb sc!e~l)S9\,7t6tV mV誺T,)MeKUzA`[.8lC N~,x-ZA]5(jZۺ+HĆ,&^9Sk8R[$2}O_V-~S b\tUį/m|V%W[rLi^u@֕AcBg)#TG!FTJ(իMv]dtO8Pf 6 n-h[uc]!g˖8$=a%D];U$q' 'Lux?DU[Վ4DщM䝲 @\I$vw?.hUB;EtIAz ڨ( rHE!,A c5h+ꎼ=3E+BS3#! YP{sss3,g6`û$߻-tZfPAEctXK8Ui#8v`G|. GvYԌB$aC[bVjݫ$bݴRg*='&Gm?I53dH KGbQ7A%ܣ|@^wfjA-!$I/9\x[ i%e,t,imgZ:5eILUprr f ~Z?MHh\Yrsn(b3>XNv#x[*ĕU1;TV` ?8ZjP=h)v"FAHERzvE`ZXYOc3Zuv8x餥㖒H7iυqzU@?g$~$9aqi-A"cxDG@=ݬi])GdDo+,u(2˩e+#1cqu?SsM&pI Avu4! hdi;Ha>=1ۈLj.—=2&Js3O+FclϿ9|utPjZKWP0;@8vFZI4/SS5%"yvβ5# ˿rGqx_hx8$ZLb"X߸ Aqs40R%M=PV$[DS>dRg'a{6#88."MH xt;ʵurng?6M\ې'k DmiVHdo$'b]v,Q4`qj,>aQ\:?V֛ݪKU4qeAJzcS*\88]F S>w,P<mQ-M^棳u{EE RFWƎGpt I&ҦHsaCb9B X ߙc1;O $)nzM ̭)MYIlj=Fs"V"פ$&(`Jgxą{]&[~hK,:߼w\6 cNJtDTi=hL%y`D?vD̝G`#U;*_k%LTASM(*"~aLa;YE| eF\X]GܵUtIk*aBdR :F!pA:Daf2D^yUKu-KYgELCu{ꚖhUe k g!iURkSTfmG Ɨ埮z~ mפZͪLWcdMñd; H=3 FrIXok[`6ξ^h-Y%%eU}u-ZV9Ӳ ǨQZNi$#xB@jJ szI sWP5<#3S!P6r384Æ6 { Jydv'E $ewgTۀxk4H>UvX,/5kSd\tX]uث+։i6p]ޫ"<Pk]jžᦄʴt6AaD^D:#A ?uI`DAf%{e}`$&.V#qߋnts4)UoEicg"$\(#ۊ;CEՂźO,-?3nYWOT]jOj&G$(%W(v} -f []U&^!ڶW*iI4!z jF2GbPg&~Ϸe̘A!p}תj^[MI\'Tp%eu< y #@AoSmtUcd^[7Y7mUhjtj%ގϕoHPGxB/O1:P#O~YA_ \ISRR^[T5.H.j6`w8YeOH$E YrĎMl-Q&B=8o5|Sb#iӱ?^Nކa.cuo.uZ9#3)\vޤe@e\K>VgMUKVC$BGMqJzHD2B Yݸxi? F xO6@<5t貮QRQY:RTR$QW$3T"n|;W\@yK봽颩Z=p\Smͼ{t<{,'ϒԨ=Ow_͊ [o+o+jYQ>84ޠ@Vs՚xZPI:[K'rkg!Fk+MnxQj8*Bk6 q Ǯ~\n,, j  uj=ޕ%0'H g$?xrC#U5óO*G]*$H$PxVuHep0>dܹFU#;KX,z"^OO!4S" AP6^]6yqG-d%4UvcbIwS:u e:~\lz#1gVú_݃êeGYWSIZ=\[PT(9JmHEoT52i C 0Eţ]_@ȊO@^BʭWM9[ R$$Ol l e]iWt/ۧ p)O^?NV^s<5),q2$/bhT -b7NaM«@;=[tW̽KFfiG,&!P(rw1t?/uDC@cY^5F }U}!g M榤İb r^01IfTjԫw8mZgSw!5r eOoD-g%|O@Y!cE+?äҤANӌoзثQ0"#>žh d l˷DY8 Q=~F ꣢cŮikA)UO7ozBr db+c0I${=0])tQ^d5Et[^ʾb˃ $%V PmWAp,ռɶ硍㩊,T#4Ԥ*pDmy,pc0­rCIDo?[m$FꦖkUjW[jo (6e澎V[%MN1lӱÑ#6v2*8MTGQ~h6[sԮW-/䢺[Wˍ*wU cD*8R $."0k71GՐ1/ 㯿|qeڤea_>sɔmrp6Q%AEe.۪i:FnYoqSb[tʻ1Nszӯ\L5kHVOxUкM!zU9tmU@Htkȩ p}%31ۍB Gi  mm*^(~)( 鑲:B`xԧ #L0O~ۡGTT5#BʶEֶQ fSm47![O^nT,RU3(W*H= M:,Իd7aNOp%Ee/d9׼L;y:.֠TSИɚxR"G_p/}lc;hU*g ZF$=3_dx"/.945$v[gU馾=kҜ#ţ Q805Qmf0zoVqʻ9* 7x*i˓ː{}3]X|lS*pQTnkv䦎))ؓxa ?䦺OV7Niķ\h59VTLc{ GRhujI &M% 6Yܣ╈Tz='reF+LuS9(nX\^5-7jN=Sׄ qJt ~iMn5-0VF'92mB)%߁Fǧ WK 6 2`ԭ0jT,}%\|O!Rpy!9=ON U/OLuI)'.c}UNG~\(fـ}U[#( "wlpuR!|,tM-z%էUa"QyN* sd֫X|#}VZZ`|_OT.Ri;V_d@30DUHB8ȭQ,O%7 wln˩9nUj˔bVUH0Fwqs]K s?V--^BG˾Si+cڨJ'p)Ice;,@x`6ӫUXQ::"bm(PyŪsۭ5-AUXyӂ@FL3{&8;? ^ckmrɮ95QWR,:'VA !iѴk\ix:Q}U<̼&;̐?o*]SK[U54 ;#$x,%X6 .qd|$FvK-dH%Jet=B?0߯!<)0Hi!'}GS9e'܂V|<'b QąRP4ᙶInrn[QfG" UD${!Eλcm'N $C*HapRQAA"Likd2H<ɇh;H$ q?e_l9h?ߺbp5asTmw80D,QṶܱTowp K3x\:S$kV :MQ^C-;Wςpeho^diGu2;EGe7422asS/$c6l5~|m|KdBR;eό2W mV &ntoތpfjSI|u@[K(sZ[y*Lp{}%_mszdZ ew`njך) ޭL:cL]l}=ƶ-=,~`.2z@鸎ṕc:%rˡM, \F L@?SMjyJU$3$aqvC\vh[U#0p"' ֹ7U)؈y׭{ܿ9=g̰܈_i~jvQB$%!B>p1IqC6(Gy!It6a$4),#c8ǿ7VH+ ]=tZTZH>q߉"[MZ5Ѭ?WDCE]3TthJȨ*ɻSCRJb$?D4՗JdyDb|ՕN:uQӁի?n$RM< Jk8l7a"&8=&Ͽ 42Np r"0M !CmH+ipুb)'xEn]OJ@0#GBKd^1'NLVKsJ(Mvel,)&Ҷ^^S]@Rl?R@K,0$SZFqk4LJ03EuqqIJͧa D~FT d1@~VXaԞ ɦ"GK쨭SSVI&\:|>sK].i24%3FRW_Uq;)+lsh*#t V[~H&zHTQfx,aX_|b'PX_)\<;?O_`Wg䪵W329+Iʑ8 o(C۵pv'{LTɔ'_-iBHupGIXԤuqeiRm9~ ]GN$Z9;X}H׉Ҋc\%Z[[u'`6Dz{s~({#p6[uUbQUa) k.>xzuK4C}Q+mjf0+.0W#?\p̭$쭩@ TYJ( pV]ͬ|NUIB|H |}D.K "hu.g Â$(?t8v'.] SgJz@WN#s{P,sJ0Y`H ?.NAcs cH5[NM$weWlSOߺ^gVQTyd!,JBGl>rOF,]j}#׀Q %buEUA)%s.N=c:~Rs*K]⅏,]w~x=}8 ?w~CcOOk̍E\-ZQ$$T9M '{:@t\4*H[u$%=Dҁq;~r ] !W:$Aч^cH%j)&}q-+ u]M!^%E@Cbl֗ gGbm]z{=TOCoE,0VI]ZNյAwV`[EMpsRtU<^ MVUUbb;X~^9q)-bPURO7%zNӏ2D1O.\{ pҴ2)F;aIp}4:-ЫMQR{ !u.jb:1Ny {g2`\.[L[Z)jC@H tG`QRS*GF '߅Zz$Opgۣ!:a\֫Jɰn-~GWN Bv!〞B'GumMB=l9Lp1rvlqnC?)h]Uj\p/6_&?-; SS-4UmEmpF\ S. |RlZiI zvE +'Xݹpcb\ڰ uG I= B~&yQλݭiꛓ=2>$F-Żu41\CAe~9-JRPȿ׎{_UC% c#S35uLh Mnwٌ{Bʱ|ǐ~PP[)KupIT7P鸂pOO~-%=(O %]¢]@ TQ=MPF9%TaWAR*] N1e1K }Pk-rUUaGoBthtTP@‰S;$Ad.?>&+i(v Nν6OϦ=J[IWqXFJ}X%6RtAi]K;}}@Zj-1A9IbbR=,~`t,_U il:S5:ZZYDN»8 :}8vi&=ey j%sJ`XV*:u@U&]aSvv*)C-ΑILY\Ն㓓QO4 ~/v%#~4Q;<_%je')Hc-J'z}z /6uQhҮU*2ԈhN-wZul {uBjثºx'150icPy=zOovIE*n$^ !`Ͼ1F!rL./c [m_I9ZAg&XOԩ_I-?YBGCa) ԫӴ35De$UsশB.]рS K6B:~\ 斜LD90Xᔖd$ j* }WI-G p[YkƢ}7e b{ gRvg¦($*x'dw  %{x1UV#}XEa%߯?p 4D_UGo.br'…o:WzUHZd|cot%UA3Y#E<(k}YfKnk,\yN]NӁ<`.SzN5,h2$| w$UR[T H'xLpN:ڊG{`$SO(iRԼ9 T*Y,ɇn$۫@VLsI8(yF :ߌ˷ LDÅkROMp~j$DV^frF^QEU=ڢWltTy vބ@Z iF*cR}X8=G=ǣiu-V ggRQ2[ F: 0̀pw|p˔xl'C\faS۷\QdjZoTt4E`I2I'roJS|9>Y#88dƂ M/冖٪7;^%gbg)U;doP44PkkI]u W4IHemlA|;DY/;OZ:Hjk!-O[n&4N; IL)ĩĂ{c24ShqյWMW[)M/#=qY I+ke+eL@&#orG("jzX[{ U@Ql\t'>v +i5Bx7y<*5z fB66;$=[fuJ7)Wy{SY x'(b:6Z F[Zk 1#I#UY!O\n:yA6yuꅎ9Ï˷۩.PSBrˤi$ȍ 'pOBq?T8 h2QuB9s"5,M䎋cq}{?znU5󬰫Hw|tW-yܪj3M+;sqɀKt=ޅ $2hLR  %yWVRNIjT~?^ T[(2$Fc߄wK^1#g˪YvHNCJCUS Lt˶b{.:I.vɃ[VnFEE-`v*O:8 Z0n6)[zRR'gI6m S8d)t=wjUN%zn]IdvXM)={c<@H.OE\)䙈Y%\'d|DfkBd%nd WʂIztn u%n"!*K5w:jie6ŒȦU"-8FXmUv]Q'P`>$ZHYh ɩGiW&?,^S 4y3c_ $d#yY+G6ͽ{$|IZt_*S蠦 VIbqDbOxvѯA ]U{*(o-ωP3(euBTmPS U#bq\p%LBGCdFp~CJ >rvc#8iq\en<.ji[ܰcbBe%D!\`L~uQ*-M,YeB~|1)Bdɉ1dg9+!jڎ=/\( ScR)eF3T^15m/g5tq@^tx: ȺrBGGe#q,M`R.-]kySz٘,ORz~.a,v9lUI-EՖ7Ѻ%Jr1cH`7Q!襵׺c[P",Ȯ@;?%T㙲#J|9 _?>QBr8 p_d)*R=8I'¢^+N6J_<$u/I8Sު)qN;?Ca< Q?#>ᒕqt[N=+UnK!I끜 kDS*SMmdfH38Ϩ~_sBt Gi[VTvdQWI=?džTRz_G 0(  =ROM(    ?.C@      AeVD3&uΚQ/BGen-K(*Ե]*Km`~2'$I\IcAap=4yh#,exSR36k3sK$~aSZ-\-.4u3,`ҲPSm&o^(7E?&h̐klԱt'Ǭ@4w9ޚ#^z|}4xR銚Oo_:aac~=#@ e'Fm"\ԫ}ktS뭟?0թR/-!EC|}B݄A8^ZvE/˴D6QRܗM<|2  #܋NaAsYֺmy$b&Ug5BCtm u> Ѻ0nc!i1l]'\sQL78Ozݝh%C?RSg11iXT#4!Rɣ*yLJ+FfInA |:>h|ǰM C@(ks= ?R3!㇐hsɕq{^;$g=R PgF5 t'A%w(T|UK,#'`t87[_Lyn )epW W@]1}H[jӽ1}}/֫r ueMrdC7QEy-2coT3W85Έ5jL`#UwK._肤DrxFsMX4E6r:U%؁+3J3ŒxWs&AoI /qqk2nKw21>vI'rv⶯9lԡnOzܐs]ϏƏu8Z[UqQWwLGGuT/5p;Jbfɑ5 {nq;cf@)yٷ"S[){Ù7ֿ:S[Z?Iwkֲ>XO~>0!f>i^WƬWqQ!0U2~˔.PuH+Kuۤsݭv1\3%Z<sus[+i:s1tibjBGCL+fЋ4(9O{-*9잝ffP0PيdtJg 5-gL>M*Vu0 l8w%("vo.V :ըfQ+;\Joߊƾ3Ka:4d߼Iq m}R-([^C5qgt5L~3wVԾkA,tRs";qUe 厸ty2\zFdVba3D[{2IB+!(oŋLxD?+]7"g^ϕ;ERrLv Dx`Ւhݝ&K3guaq7`Z,"Ml{.ݦqa(#=s܏OBN∞2/-2UvA8C$rn"L3^97<$pzjdmWn; 3 ,P6wc7AA.}B^0d$0ϧ{"˂{/Xo&ьc=wp?ZdvQZ{0x^bV*!K<(S>OUSF"9a/VRU+ҴvQ"c^kYY"mQ$qGC(ybO2yD53S_/8iɏ/lOՀLoz8j*H`p)w!k@WmQ\ZG *8|-OX aBV lp"-giTu0`V08_NtOqR -q>;x2AlDfo1=UV_* USEJ)|~0^Rmkil``p&LE];kI%Vʆ%@ +rſ(!T~b"0?BJO0O(n󦏓/uO--@`;>a_]#Mt<ɞ+&EB"ҸHC{{z| R}%A\a.~DdWh9++])f"} 7W'@Ex)yK xǞ:-O*{(q[msW\(Ulc'Dd^LewCL{^韛WzR]7>ӅA 4A+fP逍qo1 by֮ Zpmpx{Ubeۑ[GP)ވ t+ylyu N-S-Y((MoBMћf]fD O$"ӊ$R"a&acLg :QzevK:RP]`lRn/SRQZ.[PLCn_0ioi[: V4zؘbkᛴtST}cbb#<Ц,!iLBpy٣3:d9>'.epǴ _p~ 6gf\y' c>bY.G{+~xC]RyW<67Vq̒,H lxѵ'}vzkS\!nw'}XOuYkQ'?7U]جY]T7<PL(b{s'?+ME\nr*ax%89uBJx})}tp @M_Xf R8<<.ijIA9&$CZ|?2pBHwRdeUkc_)I/w&iϦ}x(0׮u׃Tƣyk[] hh% UW#|iPa5g D7޸NK)#Oxk͝IMZP$da&6K;xRH-nu암I#CCl SSu0.Bi ouG\rt'T;uؕBqq5ML@^kqT51ץ E= ‰y4#G)H{yw;zN9A+e}tidiV}r%zU=sP*IA ͎UCfB߀+i7k㻶%2^vĉ_+$m)\I#c/]p堡fd?YOuF[UίJG.S@@]d.ގb06(-q~qWRnϋ ,ƈZOJ>-|sRKGsE2ca,[vh̬#g\I?3r aP󋑔j4x HJCbWpl p@  ^_U6Gx?Wa GmBI9*Mcy2H_q~lޥ=ACr-D9):)H.RfmEW͹XqH;_[z:Y13!zy[M -G >_:B'݊t2^oiw 5Et΂CN&~,O/S7 !-g@%css[ m>4ZXX7ؘiS@n>/z=#cϕ[54Y2Tih)#7俟H7[[|pC)FawL8 ZĊŚYw*!1ӚSQ{?sńmy&pS KY#MG9B~J#$: ,?`IIBM7, -4'lfz$J{јtr K-|@q%AF{Y]i0ie}HW C4:Cew,ڦ1Jt}s=>Ta4]./1P\*R. s9q'wDž@\$4Ti/1m\1+CT^3+2|J.Xw/i#*<|}so#t5J_q}֭vR~+WYI86&RT 4 B/0H>}2E0U X0C4M1DoEWmmi:Q`j tZ?(|o1:@}CArZ@tDûkXr'nJ )@cFv V~%qF}Ա8]9ƑbWڄ7 Uz3|@gӁt.'Y|?Kw% ՛2r脰},⅃]X+?<&JF}j q!'PXmC>QH6$t0Ϯl< =ƈ0I֫{UL32'1XPQW{^zYXM{vG؏c7F],Ih1:w'"F6'X8, i?m2D'BKt t)#nR +;[ɪ w0pUqqUp#qwZꉓm*+BfŹ#-+Œ'{ Cy#t=>ڻ\ڥ ,4f jF*ӁZC6qр%N6aQ7tb&awm]K&>p[w\*MYz$>E2> y它LDF`'ަ#٠&GCN9TmpC/w aa 7'O(jRXJMot΍:+%}y+奴a[' ЮBo,߄^GoϤ~WFݓ܏m1ytPƏL8'(U*ol!4+y["CB!ku˫ȋdLa۴_7@;y@#\̓WYhNAh|'L! >gbhMyQl9K"5XآR4VO6.V˨UM{9 rkEn<̀lHa@+M݌nYDn x(ި{kAY>U]&cn_AOV',|>7d(E px@QI8Nx.,GS ײ$A9jK,YHf* 3)W(ky+)4Gp=lƺ#"8x *VSłf?yfun}:!ED*)ZwH1,+SYT{MyP .j-ω%Ή<tP066ӣm '\]mJˤ06m)$5{'v13`p.1+/?a ďl^=Iƛ+3jJ>-!PWw_ ׉65_\xay(:[ѣ&|Yb!:2aqo{VS}ÌTCK6bhMNڝ0%mѿcQ"K+Po<7ڹօ&2jb~(ixo~p8Vw_\T2eVRHrɈ 5?-ޜmKJ Jt ,pP|/KTIS&5O c\EEwj" <E'XJnP0^=1rM̺ Ed{;}*p W(⍟0,uИ(XyEs$U hX`Sّ<(DZXF<@j9%!^ +VIDbuw E}1 #7 M 6ZHsJpI *<;y { A#cQ^ښuV^Ӳɘѽ"kj.H'#b5k" . ~=Pg5[`(d] m#I͓7]aLL>(xG~~xi,٣w%8h{vZ+MS,$7f&vMpCފ4ޗ8hho>ͽ= D9O.;!cO2Ac Setu?U9[FG-2YT >b}i_dƸ|" xPv2_?[?2Y uL#5B!vZƗ /9˲oo ;#κ]I/Sb ?Gpրǹ33EAcfĿ+48 'SXC ysQ*{߰Ya{I)"=R)&mΏ|XgO~8v9s^As.P=DP,r 8H֜,0$:K8'4U,`az&PG^ƻ%SorEPeDQ_s*N[ > A2YhxY*1M Ke3<~8*ib@ސXoVcJF6)T@rX-jm[seg2xC+ޗ]8e1RrӅ .G 9Fv0P-xܗ.Ȧ>= ʘS+'Z K(וC?"8x¦̷?Wʐ,K`BWoOH"wpGibZH>v\ +FyNrDh a`Z?WZsYf$S^W\}&izŕ@ݿtj4ZHdM5Lbc"qCHA@6- 2S*FM:V(h&Je<~Kc-d'Ccqk nڦ1?Ȳresfm0oBu63/]Binz]=< AVWmC筏&0x)EG:рѷkcci̔s1];gdž. $9DUtdԞZjct?"C$J}Xg&x(̏j)@|ɥcfdžǗ!E4&"!.#^NCf. ?#//3ΑiВAMsC+(ݭEպP\/),Wv$|9 [BBU 6ֲE {~`Ǹ563>%?KPL@_Py|'/e#_%fA[ @,wқ0X5W(5ב1Hu8, 01 ɟ"F~($>3 5%3HEi'Os`iGEuh46adb_S,A#}Qx=^wH"^E%%?775?\pnE춲M.V9>37: $S7D_Ai!׾"r I>I>Vj3> n$FO55T;RPɢPqE?{g%0x&m-&(ow&'Zd*l$xoQ!"d2]q<I2I1:frϴr,1 t3 ORA"lq[dud )(|A7SȒ.edƑciQ)h[9V;#uR*52lN f1L<6v_߼`iW'.W)= y0w LK+"M1b+)'+o5' (z#!~jfh0'(bŪF)b~u[F m*. mp2 sLxgA^8fHPQ9P?;N"TQ%",d}ґ%1>p)"F }*lX {Ɂ豒- SV?28qs^gR|F%fM 0 CuMIA ~L뾶c=6,V,[ bj,C)De27g[el#ILzGS۸_=9yG2"G^嫰_vXԖL-7ZufN9s&ZLy-YFUA >byy{-)x3k@!,0Z\m?DtdGښg:82>Vsuoe h-Sf)ۄwWZ ~ykG7-%9γixf,J5k joX,"`eě"9 '`4xA,rLiTгxEgے깤CȨ[/ܐ?Rxiv?8C UcJpl f0;K.|Bb ~5_2unTۂ圖ؽ|3XF$2$ ucɶ9m 4iʋ9 ;ֺE93oYt~|3*iD <|/oQwg'2n >٤Z.fgaSf27~<>:XAIL(u{Y=]M$1/=`Z}n뎽t}tClm{[WgKS|cȥ"UUjH_$h6f[?@եgMT[2T*<Cq/zb[BBB~cz KslSejG5PšiO-7/vkDt|r>:@5Uͭ,Q-}O/ OڄБCGҾLoɺ<=78eAOb0aH}ѦV=['EnUa`h ذOбOE-C-|9҅<"yh~avd|{H ¦_;'bdL7XmYZ6T^EW< f҄lt " ]h0Xnvu;+SO'd́j1ÉdE/}mxL'Od-NER9o3_D妽%&Ngrd4џr rZ&q˥nD&$Oekm84/6D]IHNǖ(!mM("B}l.=Es ̼>+#d 32:Vl0ܽG`2BqŬ-~w揁iav gwKʳKWڟ,V?㙘5p*gSN2_$` sBe U2;ì<t cMkuSvڱɹ'AND*벮qZ򳆷^DsDCeS2iTG/(}$3m$B?QRInsjΟfPc4U<Ɗs-mAG)s߀,%wy+OUywq^2͂߆a v-Dcg9v5ڣ2hw4]^>Oי1g fc``Y,7\JfNhBuPiߊ"`3mAKċ[vUMIsۤT4y9'cT!w7pۉ_?B0=/")n)ER2 ~QJ kOeRDQC0n ymm}E Eh0R+(U.cuQaG i7<ޙ3 M2 z\@TumC*zE8H S/| dj}U_nٶ(Vt,KI+_Ƞ>cr+jntqvuɚfjDК &C BA>u=miTvf[}O6v 6:M-Co(Ed ft6UBm3Xg5F}M&cKSD in 4 -&0LX3AZtuyu X,z Ya[wWEGSvkW`fbCp A_X?j2]Չʿ{u*^+űu_%l%AzB㲄{z^CcՅz,BnQ㋲ ZЋrMgV] JQ%?Ǣz?U\~?cmyA:u:?%Д 0Z[IʫmqpN/<=O5Mo𴹊s.Z++1bo ,2P/(Cuj@hj-zt~EDHΔi?J<,kT@QjƊO}OmbmMi?>_d$ gvO(2''1Q3(jNV) 8 #"ˣ_ָ > LU%5 p;Iq_o\>Acr$Twnjԕ)bp}c4Y^_/\J[#Mc|dQ ҍEo):35Kgq̅xa*}GPy+f70$u)+Neu;8A>@?RK9)mKT1 ŸO~L-auO2g cg%Л ~)VN[3KDʰ[t'gq][뛄9ݘ7Mɚngb &OKnuo%Km}Z7\mugxwÄەDf5䌓$:&kkf@q#!EW!%u\u3gYgzĘhr ˴)ś6]ÁQnfPzJtk=ϩmj^7cS HR ^#2(X!>޵/Gν,@Bg C0 ^IfpeN4LkhISSk7}&Xҥhbzp㭖jA_-skj-d<åHdX@\&lY{T;g57ܙ'iG ɻI?-&߳(^z͈j%JK|z.=-]8%,Y\waЍ  sOr}H7 4Yma~?^E\/E:[u…s%ȃ()o&4s3Vrѱ;?Lߪ"Zz6U\-ٳt!@+SJRw[ a'#|٪WMfY<2@5Ԗws@/ rBZyp{hJN{"5 DON0͍Kȃ/StkҎ$M [2L!qQvDQ5`ĺIG@?g29}#?tlxO05C@I1@6t >Ouq C]KhǭkwPsB/N AJLZe 4Z8M%?дr]_UH-{VVZe/ixY$^Ģ",/}^6.9OzrlEBgsRLD_P7=Plptr#y缤 NZQb=T nNHiG&ȃjSjSѽYL8a.dPD5s&'Iym?.vnTg$BP*[.CrK8/vW8Lo}ڛX1>o.<$:_bʸԶ͆WQW: ŗm9߂#io`Kf'ﵲcKNyϬOG[`ȥ4o Ѡ B+j<=;x*Jq|geNs+vIϡһZ֕)5e,df& ga"Ίּ0Bd4! . nK<#;R&RWQ~P8<=,fB~\[L⾤f~ 㳺)r E7`wι="z 2I7AͦCA|٦R\\l]DI%Ec56.Ŵ62M-z?hX5/UtNͷ-^谩̗_hCcߙ% @Ov<3bܞ@J $EE.8 4:c8ZU?HO֑G省,MY"{T5@AIp?0:} ,=UioOU]F2-%yYL!Y:f~aG`>y*acz㲾Rn3 A$Y#)`ՈOBd;v#GFp ObsӨ##YTsqf$ƎqkYP Ԕ3'ëy;?;ImEˬ,??Hu}K;Yؾ4ഢ#Qjg@!W5N<ڦ*-N[TOV׸,J]ئD菔y7z(  w$nf,}M}tUmR7z26u0iJyZ\GT嶕ˢwNe3FxYQjK"2?WRs)pM`g*)CWlcS7njc_X НH(|sko.WE>xQD:i|/W=BteTJMS6EG^6: f%4ŝB?v" Ҹ\mG_fz%UQa|ݝ3GZZ9$a|&#'b~՛ .2,, a5u Վj9 S l:J}Re؎68%nDCf]F| /nNN`_".lmH(+`tZ n'fHYwSww:s .{ zɨYs,&%Gq7?Q MU? o DN^+p3 jS;6%E$h,J!qKB,9l~Ʌ߀Ɗ=-ƢϏΟyoHC{dg;.6t=2ƓRO$֥FD۱?O4Fi;fv$g|bzԇiQ+dQ_Izo_ru5&:5ދA*+~5З$:&HHϘU6LhANN"mH"&p cP4>1b!zHz\B\ FRa[!`9r꒛a]ݪY_˚^dK *]aqaUO>C?6AVr!zm;@؊A뜗Lv6 ,[Xr{iy.)<ĶŽ;Aj524SH|@Eup|3JQI"؜k $ ag77w$<|]ˡ띺z9o6x~`H>nM[66EzYsJfT lf<˜ĝI#a'=Z^*| JzNnُ%RRDȝ&Rc6Dc}U9)A߆^e,*mJ z4 JӰdhq`Hr%y7TpWH3c@`7=? =ui 2tB֙J]4NwN᯵P94(m>szjӧ3+(( poy[ xߏ=F1̨ F;o`>--c`ݿ>KF)giWH)gJ$8`Iq;iJת/S&'į7l5t@hWx= tܔ]ΩTʣw1yGcr5o91ŋH VqKrnv9DPLfVC< xTUyK~sZ:T= DP: n: aIo)%\kQ3G3}_' NH GpkVϽ6`Y1P0h7wB~ӿ8Rs-+6ii Kp=k^ ;Q bbdP5*`[2:ǀ'_HED5ّ\:rk]W)40H6w)tdu6bxlwL mF- `"1dz no'@0-(SoAd&bHۑX5 =h}qfcmIw1W0yY;B5aNyW pT0Yb W(Hcac}nuIT$pTx-S8XWP]6Pt>#6cI]AA"SX:+cHP ?[oD=&j_vn/VKڵ*7[HM׊T7k[8|`PyYjԛ0;ޟS1=|n)/lC-,tA'Jo+H<E }PɂNˏd"޷kV4u/@,AS}.CC!Bo  TS dΩXp#B;/!.Jv<\Q?.J]Ci- 5^9k3ˆb7\^c`9Wr*[;z-YkOsߴ7.h@Ct'8ν&IM3MHܵ[8\ů[a ~:V*PSn:4g_4Y+/-LQ7˓!Geִ|^Lޥ4 nMZtƗ5ںQ@*pW2ޠo&PNzn\,}UPEyB-Rh&mM<;Ou_[ O8m0͜d #`ЯrJTT':3pJGT(\#SʹLSy}ķq%Y}%NtPg (TCA;TNl$E(gkDcx[h)UT@l ͐_0qr!G:%-N纫~~m~qb3d#jh䏹:qƤ-u> @L5q m}3švfJmc̾]F44 w&ԃIZ[ڶag%Wc4M|K-9֛V KJ%m #CA Me"uM:OQ0a}~KeЖ&SԛU27O/%t%mlEAcա"Zo{<(ev1D1vGZ鋝d<;wL6'bVwkjcA=7dRʦ+xgp# C%y?̉]k[#Ƣe+f3`'a`,pc>#WY!%R4&Elt\bL 1FN6У1b~8/t'o 7}^lVQ/3KX8 u,OLT3yI3I3er =,"נ*c̗TE f?'?Bл`KY9z\H{JI#GV}RW=ʫH`K$A[E=G<Bo4js!M疀jʦz㱣$5/;n؅Q$E&LO>gI?HHb0܍?Fa- b*/Ju~NI)d3/uN7NDsSNL_(`ME&zJ]|7@tX!lKt6)nSkKg8u梎'?&?}\qI>R3SPa~0w.Cm6?xF FlgĂ+oLY{s E" 9-/՜jCZEӎF%yѡb&EZC8x,m9l.&5By%zk"Xp%,86/ |Duڵr$LXt4Եwѿc S<=A'#UߘJVF:ڤMjFlHYJRF.NCR; W-( (+5y)J6O=Inn?Pث+W>l(v*-ϣK>X*RNY{7ARh3ׯ@zܛTV|.MVrc65YǫAbq}l¥%,!w,w_`0jB2|rx MY;~oA"Õ7emXt܍ ov P<Ӓ9B%+J`y]_ڦ4fA O`J3\9:SGUЖ kk" >"[{8>c|yh!9LѦDJ[\]h6v 2ZS7Iٯm_! ;lQ}(׈W&lӟPCYi!-eܣ67;?n]p)&<4"ס.Q&55S|&FԪuȚ\%ջ]q~3VE-JQX؜xo⟠S0kr$Ќ[ch1&TxOnƀB]d"( z*x+Q$*@TIY}x8 pCUp 1%sUτ vA'zTʒbyPna盔lHٳk1B)9E`/sAbi^V}<@*V1yPʧ;%6Gmҟx1 ÍU{RxJE+$q7 ndGVמ=hF<&,lBLG#_d)|*(MebJΟ/\Iң)`Bκ8pBR_3ۃ%Ta[;k`2a(͏‚A'6L] k2P]bZ!OJ^ Fd;3KyA7,.)% $SfxI MP-\Z8%漢&KOTYcYr})F :t~ ҫY1 DNږ<)azW5,v3 I%,٫ ̂vX/lW'%?/5}5oE6e na?뇅 Bcw:S:xTuh(lm%EH^(IE q:"3ǎ60dRfs\8z%V/3]ϋN|*!t˽MSr5S1Ͼ*UENEd"3G#sSiw7q^ lMH0n(%xHZ-eHQ!IRavc#jYKk\:%Z^ogœ߫i$8L(I%,(.,u)O>-na)nyqelL^F48  xOޢmZ{5_$#wJsEg- he쬋:K>_вdR# JnRa$a9.usR|_ [^&6\t ٿ/2:umV2 t̰jm!Ǧ?q]N.GMi1%vRG.i to)ƥ,ʻgקtVZA'fuT'C/Q%4ILxRp&_*(o_5^i+x%ٱ &`t^?(<}YwN~>1؋*#+EQ ?`30Eqo.d(:҂GYj=]Q e@`+WD& Ai3/%qYY6S(EC>|xI}s!L 4SZ iwtkFCOyvm!gW^$՜WLPǾIgP;V-"DܵP)v.طT!Y?QYk"YX%lXrg"ќ]RRh%ַtzLf# P%!ho7 vrLW*uG>6YUү QVw5%`:\NJ_Se =uUSvCV,B *=fE׼늀}p)ٖKLee$1#R:F=y2+EdBV5#N>T݈XsHnuVҿr.\Uu`^֙>Ys*q-vm`*>AfQ|{~Y}gY96lQ!;hk1@C*tȩv.0I,,YaaeXǚy,kĺnb6ZXCL01>:PfX6 T~aOűG4޳ݞH潉4!pm'QU]oSfN,T ]CHLU*4N*x~ok#YMs|;60iM-P P[ C -ԧ\RaNK%$?Ĺ{| Ƨ,pr3g]o9Ù@~د6ڄ"S z*quC%\sLe:&wXɲNaF9&#s~/itQh3a|Tmh^"mKK%Vx(BYIM!'fTzuIFFNJ_ x4yrA 2ij)2,٩V%mJ0']H(P4bOzՓ=5њ#gaȬJ^iT هU,htw H?Z9¶Un8fj.R,_q4PVT%uUuo@cM;KEq)5T=.OtqdrbޤiH<7jv-Ǔ\TԢ(.,BH\*$d /aiDW^wXueH%c Zܫ;nFO+^_cNX U6p5<0 9;dC וk(axoW3Kϳ{VTR2bbs>+NWܟ¾n`c1;l|0JF] oQ1>!c;(A2;LȒ̐X`Z"!5^PM"bxwmZRt8J8zgn;j, w1zmw:g#s(/ΝW\w9s3KWN_U79Z%9+ TV+vBeoq `kÝJ u/njikCSAC-g}#*?vFaar0â Tb΋KJ1t”$> ;}xA:5>$)3Z+)ޅ~~"V̝hi.(x:G ˜ˁ=^\z%"ů74/ Eq~|mў̿'dkD=9c NX3Chߜ0L~|شʎ /|@Wsd =΀+@#XW",XEL?gVp;:~PeH@1-.vYȃw@T!p Qѱ״luUV%+)4~E4*t-;ʁ ;Nhe/1xםDypof#钕 BF??SQVqY?y8)ʹXɳ`;:u UT)Ec5TEraM7 3/sJt"ù!`IY3i׀9bu,aЊ܆&g@4` J`nاeFaAw|wj8hTu״G[ہwep9ǧQ5߫nD-T,W[HL 9VzGyK!J^" X7'Hu?Ӳ\cSwnXhds<7BgT,1/Ԇŀ C`C?7AZ ۬K1k]3%ԖeH Jҍ}?sfTjkS޳:r1L`3#*{Ljے]Q@MI~1˵C>OiS֣w;H?@fi4wWjVt OEbC^3sUbcۡ!!@)?g<%7x1 /S_ltӡH aFSpbp뒿5*j4BU+`M!Z&{ߺeL|]d_|[F;`#e|D^g}E ajgBɵ¦ k˻O("4dj$j2KfnM\JC%'Yp)' KV) /i$u)\@Uc }^urgXbc9g(96;}ӥXQ9 (A!H#`T!=dir #zlzuZ" z˻8ɟgzab@SC&خR]:Tld$J?à]b]qB]N[oq- tbE&dpӱhU#,nڌ妅4 QT^!žh0MO`$n:L z]$Bj,[QfҭlR^غܲU[LnՄDĥm;P; d_ *zDB,b1aV]VU(++nr) IQY+dP yf Kc50@wpgy醾tt[0Ove7FVwr r)Ek w )DdKZi O9P'*xyuV&i]-p;hv>-5roJSN)rm&р!y⸩mwMmEAޤC+$9dx(I|N=EuNs뢜\y~sJ;f=   5- 2Np}zӸ!a37ċ<إ z9J_dJO*.}Y OmF:Zڊe?zu[q#=ηZΊ[6RR3hW>B}`q䃳ܓΈ}Ct XlP84;KWoP:V>#.{,5+D97_'3 Ph5LQb#&yFvWk/-^7@rkHyi_YW\=C>'&1ɊVO^˿|Uw}>nʆ֧ʝ9B cQ+`'hb9gBPPjfJ }e/&'հ4IKS䱽Q^2\Dcvk:,0%U!G@ɤezY\\}x9sYpx`/SJs|S[ %GDžE)Xyc*ñhhNO n'S%RP`&c#"#Ą9_Z0; ,30䟅g4>SE4)v6W+Eg䑔ԄF9G82=^ ?(use雡yw<8RAAMGA^Įլέ_(ˍJ=&%cpRpK77!yiϯsg _m)FԄUS0i˕_5=>OjgNbLÙH}h%7ZmkchDrTBax%Hp:zxČs,XbɹM :dW&, DgX'o[D5&YRWi?UQ,HV_)0Ϯz~ mפZͪLWcdMñd; H=3 FrIXok[`6ξ^h-Y%%eU}u-ZV9Ӳ ǨQZNi$#xB@jJ szI sWP5<#3S!P6r384Æ6 { Jydv'E $ewgTۀxk4H>UvX,/5kSd\tX]uث+։i6p]ޫ"<Pk]jžᦄʴt6AaD^D:#A ?uI`DAf%{e}`$&.V#qߋnts4)UoEicg"$\(#ۊ;CEՂźO,-?3nYWOT]jOj&G$(%W(v} -f []U&^!ڶW*iI4!z jF2GbPg&~Ϸe̘A!p}תj^[MI\'Tp%eu< y #@AoSmtUcd^[7Y7mUhjtj%ގϕoHPGxB/O1:P#O~YA_ \ISRR^[T5.H.j6`w8YeOH$E YrĎMl-Q&B=8o5|Sb#iӱ?^Nކa.cuo.uZ9#3)\vޤe@e\K>VgMUKVC$BGMqJzHD2B Yݸxi? F xO6@<5t貮QRQY:RTR$QW$3T"n|;W\@yK봽颩Z=p\Smͼ{t<{,'ϒԨ=Ow_͊ [o+o+jYQ>84ޠ@Vs՚xZPI:[K'rkg!Fk+MnxQj8*Bk6 q Ǯ~\n,, j  uj=ޕ%0'H g$?xrC#U5óO*G]*$H$PxVuHep0>dܹFU#;KX,z"^OO!4S" AP6^]6yqG-d%4UvcbIwS:u e:~\lz#1gVú_݃êeGYWSIZ=\[PT(9JmHEoT52i C 0Eţ]_@ȊO@^BʭWM9[ R$$Ol l e]iWt/ۧ p)O^?NV^s<5),q2$/bhT -b7NaM«@;=[tW̽KFfiG,&!P(rw1t?/uDC@cY^5F }U}!g M榤İb r^01IfTjԫw8mZgSw!5r eOoD-g%|O@Y!cE+?äҤANӌoзثQ0"#>žh d l˷DY8 Q=~F ꣢cŮikA)UO7ozBr db+c0I${=0])tQ^d5Et[^ʾb˃ $%V PmWAp,ռɶ硍㩊,T#4Ԥ*pDmy,pc0­rCIDo?[m$FꦖkUjW[jo (6e澎V[%MN1lӱÑ#6v2*8MTGQ~h6[sԮW-/䢺[Wˍ*wU cD*8R $."0k71GՐ1/ 㯿|qeڤea_>sɔmrp6Q%AEe.۪i:FnYoqSb[tʻ1Nszӯ\L5kHVOxUкM!zU9tmU@Htkȩ p}%31ۍB Gi  mm*^(~)( 鑲:B`xԧ #L0O~ۡGTT5#BʶEֶQ fSm47![O^nT,RU3(W*H= M:,Իd7aNOp%Ee/d9׼L;y:.֠TSИɚxR"G_p/}lc;hU*g ZF$=3_dx"/.945$v[gU馾=kҜ#ţ Q805Qmf0zoVqʻ9* 7x*i˓ː{}3]X|lS*pQTnkv䦎))ؓxa ?䦺OV7Niķ\h59VTLc{ GRhujI &M% 6Yܣ╈Tz='reF+LuS9(nX\^5-7jN=Sׄ qJt ~iMn5-0VF'92mB)%߁Fǧ WK 6 2`ԭ0jT,}%\|O!Rpy!9=ON U/OLuI)'.c}UNG~\(fـ}U[#( "wlpuR!|,tM-z%էUa"QyN* sd֫X|#}VZZ`|_OT.Ri;V_d@30DUHB8ȭQ,O%7 wln˩9nUj˔bVUH0Fwqs]K s?V--^BG˾Si+cڨJ'p)Ice;,@x`6ӫUXQ::"bm(PyŪsۭ5-AUXyӂ@FL3{&8;? ^ckmrɮ95QWR,:'VA !iѴk\ix:Q}U<̼&;̐?o*]SK[U54 ;#$x,%X6 .qd|$FvK-dH%Jet=B?0߯!<)0Hi!'}GS9e'܂V|<'b QąRP4ᙶInrn[QfG" UD${!Eλcm'N $C*HapRQAA"Likd2H<ɇh;H$ q?e_l9h?ߺbp5asTmw80D,QṶܱTowp K3x\:S$kV :MQ^C-;Wςpeho^diGu2;EGe7422asS/$c6l5~|m|KdBR;eό2W mV &ntoތpfjSI|u@[K(sZ[y*Lp{}%_mszdZ ew`njך) ޭL:cL]l}=ƶ-=,~`.2z@鸎ṕc:%rˡM, \F L@?SMjyJU$3$aqvC\vh[U#0p"' ֹ7U)؈y׭{ܿ9=g̰܈_i~jvQB$%!B>p1IqC6(Gy!It6a$4),#c8ǿ7VH+ ]=tZTZH>q߉"[MZ5Ѭ?WDCE]3TthJȨ*ɻSCRJb$?D4՗JdyDb|ՕN:uQӁի?n$RM< Jk8l7a"&8=&Ͽ 42Np r"0M !CmH+ipুb)'xEn]OJ@0#GBKd^1'NLVKsJ(Mvel,)&Ҷ^^S]@Rl?R@K,0$SZFqk4LJ03EuqqIJͧa D~FT d1@~VXaԞ ɦ"GK쨭SSVI&\:|>sK].i24%3FRW_Uq;)+lsh*#t V[~H&zHTQfx,aX_|b'PX_)\<;?O_`Wg䪵W329+Iʑ8 o(C۵pv'{LTɔ'_-iBHupGIXԤuqeiRm9~ ]GN$Z9;X}H׉Ҋc\%Z[[u'`6Dz{s~({#p6[uUbQUa) k.>xzuK4C}Q+mjf0+.0W#?\p̭$쭩@ TYJ( pV]ͬ|NUIB|H |}D.K "hu.g Â$(?t8v'.] SgJz@WN#s{P,sJ0Y`H ?.NAcs cH5[NM$weWlSOߺ^gVQTyd!,JBGl>rOF,]j}#׀Q %buEUA)%s.N=c:~Rs*K]⅏,]w~x=}8 ?w~CcOOk̍E\-ZQ$$T9M '{:@t\4*H[u$%=Dҁq;~r ] !W:$Aч^cH%j)&}q-+ u]M!^%E@Cbl֗ gGbm]z{=TOCoE,0VI]ZNյAwV`[EMpsRtU<^ MVUUbb;X~^9q)-bPURO7%zNӏ2D1O.\{ pҴ2)F;aIp}4:-ЫMQR{ !u.jb:1Ny {g2`\.[L[Z)jC@H tG`QRS*GF '߅Zz$Opgۣ!:a\֫Jɰn-~GWN Bv!〞B'GumMB=l9Lp1rvlqnC?)h]Uj\p/6_&?-; SS-4UmEmpF\ S. |RlZiI zvE +'Xݹpcb\ڰ uG I= B~&yQλݭiꛓ=2>$F-Żu41\CAe~9-JRPȿ׎{_UC% c#S35uLh Mnwٌ{Bʱ|ǐ~PP[)KupIT7P鸂pOO~-%=(O %]¢]@ TQ=MPF9%TaWAR*] N1e1K }Pk-rUUaGoBthtTP@‰S;$Ad.?>&+i(v Nν6OϦ=J[IWqXFJ}X%6RtAi]K;}}@Zj-1A9IbbR=,~`t,_U il:S5:ZZYDN»8 :}8vi&=ey j%sJ`XV*:u@U&]aSvv*)C-ΑILY\Ն㓓QO4 ~/v%#~4Q;<_%je')Hc-J'z}z /6uQhҮU*2ԈhN-wZul {uBjثºx'150icPy=zOovIE*n$^ !`Ͼ1F!rL./c [m_I9ZAg&XOԩ_I-?YBGCa) ԫӴ35De$UsশB.]рS K6B:~\ 斜LD90Xᔖd$ j* }WI-G p[YkƢ}7e b{ gRvg¦($*x'dw  %{x1UV#}XEa%߯?p 4D_UGo.br'…o:WzUHZd|cot%UA3Y#E<(k}YfKnk,\yN]NӁ<`.SzN5,h2$| w$UR[T H'xLpN:ڊG{`$SO(iRԼ9 T*Y,ɇn$۫@VLsI8(yF :ߌ˷ LDÅkROMp~j$DV^frF^QEU=ڢWltTy vބ@Z iF*cR}X8=G=ǣiu-V ggRQ2[ F: 0̀pw|p˔xl'C\faS۷\QdjZoTt4E`I2I'roJS|9>Y#88dƂ M/冖٪7;^%gbg)U;doP44PkkI]u W4IHemlA|;DY/;OZ:Hjk!-O[n&4N; IL)ĩĂ{c24ShqյWMW[)M/#=qY I+ke+eL@&#orG("jzX[{ U@Ql\t'>v +i5Bx7y<*5z fB66;$=[fuJ7)Wy{SY x'(b:6Z F[Zk 1#I#UY!O\n:yA6yuꅎ9Ï˷۩.PSBrˤi$ȍ 'pOBq?T8 h2QuB9s"5,M䎋cq}{?znU5󬰫Hw|tW-yܪj3M+;sqɀKt=ޅ $2hLR  %yWVRNIjT~?^ T[(2$Fc߄wK^1#g˪YvHNCJCUS Lt˶b{.:I.vɃ[VnFEE-`v*O:8 Z0n6)[zRR'gI6m S8d)t=wjUN%zn]IdvXM)={c<@H.OE\)䙈Y%\'d|DfkBd%nd WʂIztn u%n"!*K5w:jie6ŒȦU"-8FXmUv]Q'P`>$ZHYh ɩGiW&?,^S 4y3c_ $d#yY+G6ͽ{$|IZt_*S蠦 VIbqDbOxvѯA ]U{*(o-ωP3(euBTmPS U#bq\p%LBGCdFp~CJ >rvc#8iq\en<.ji[ܰcbBe%D!\`L~uQ*-M,YeB~|1)Bdɉ1dg9+!jڎ=/\( ScR)eF3T^15m/g5tq@^tx: ȺrBGGe#q,M`R.-]kySz٘,ORz~.a,v9lUI-EՖ7Ѻ%Jr1cH`7Q!襵׺c[P",Ȯ@;?%T㙲#J|9 _?>QBr8 p_d)*R=8I'¢^+N6J_<$u/I8Sު)qN;?Ca< Q?#>ᒕqt[N=+UnK!I끜 kDS*SMmdfH38Ϩ~_sBt Gi[VTvdQWI=?džTRz_G m}O%?`mƃtɦ&?#sXI7:Ƨv<Bq6{Tjϖ QþiK9RO;Y$e|a4ؒ&tVS5O~(فRWK ïWqdzuRQ=^eOp[xfU\f~_&NJ]ZAKn H5,$t5C[?`b}Lz$ l;w 󟔎٬/lmvQN`c~FsOR(x-$Ҽݶ~[9_ܹ<r0oZ'ZleӮfLq@KwO?{]?PMƑY s(X.񝼨#Z2&ЯT|By + 7~ҟnREKOsf0s(Yݑ9Êρo,3񮢞8ra\d{׃FE׈|GG#ĭ*e 6~D<|$^}+Tbf<1= ŧdȳ[xjXc=ZQ2ȁ#"#ωbܰ̾W6pU|ĎU9V\)m8N:2IsFj&|w~?WՂO2h،<@j2GNGqL'H4Z—* ڽM|s?DzKOZԯdʵC7}+ix~={E-eW`99C܂M_CZ\^쫥UFS{ʬFieT$:'4y?xS庐- (/B#K&A$Znq(PP xcX^|Bx;Gx' m{tIo \qZYJSұKN4j}WǞ0A؏&F2}\{YxY5aCQ嵒8EE<Ws/^\DIU r8z Y\iėcyದ2=*3ht>7[]XN`֡] rm;85zi5 ۬5$ia vI䚥wAmY- ${ n * 0 ֯|Y-,} QL:y;c NՒi+u .}&v'`nORc&MPCW-_Ga m;ʩ2c'GZEZP6?j{&_~leu/434%ZN Ot>6 =EE+(pNII=?ʾ6OH;vZ{b`#4c!-kD%nnkOI. ޱk[ɐ[zޱy˹o E!.{|;awTaEo3Z1[+b\Hyf5NkiVp, 8ע,AFּ9jwNɍ܃=h^󰎿~;|mڵv) L4蠞MspĚ셴? V]U S|oOW5i$ּC7޽lP01׶y<עj(+lψ::Ki3Kߕ^+"e d}+ź?oA e}Q'Ԭk|(†z&G5^Yʰ#9uUpH'`8p>24_.Dt/Zt1;nz}Y}Mm r{ kω猯|g ۿ hlb/#?w'>_j+7jxV,0g+v5_wL6.n;ZJv'Ooƴ9kv6Y3%,7vaOzk&{:m"&hB.@AJ+/^-u yc! 2wm+c𾘾fkI@ q8\rY?i]ad1Xx3Xn## 6y  u|yh(g{o i$Ci):1rxd|vMzUͺ,1e2[  ⾢iRj:V6QVg  r+I5?OWCXY[pOSz۾g&ugB2  -ۻ=.Iu'E9{v|:K| З\&+7I!?+$cy$`~:4gP]ys!3,P*k;v7QYM*E@9>J  _<~w:էϡwIqil_jR'q^|(ښ_ɥ4[qIϾi(ZDеOKMme  {׾2Q-Q**}Ny^~=4q|9"x,sש2op~"q,O0w#'ңnoA_YIXaI8np"BՖuý+R^KDs']>|p] 1 I?lYob9`I3vǿoG{I=% NcߍH Ϡױx[I9<0>xp#҄u+zŗ?hυ̯qmqnphH+ꠠ9_!PxN-Ķac@ u)TC:r*fFLUOáM޷sU;Js^$h~t[[x?5~ _~#RI.=2Zǵz㠬ڳn⽈4bH۪7 tQQU aSE5q)֑|l|9nMOnRuDdi@b_FOZX[&(n@W;O+׽tB?xJxi?P\j7KinR."fQӚj6N^^Ho$ERX |(S7^IojZ(VAu0`In nAmrm#4WCz2̧^v]< OFqÍqcau]VV8WO3,08yeBouo[NgZjkLy FcOsMw:k ]יþ{k5,$ArW?J|SxtZ6].]I NY{^>ZЮ:-)yZK ZE$`\szɦj3Ԡ@M]#wd@^iwcⷄ<3Ekb[&Fc>|33i&pjmG,T0ӯnςt-o.FumB- ,2vsQ _&ɌZH`XWHAv&PլK$WnNph$"u?5OZ-Z5.)"֞ |Gm̽|ef?ag|rN#h'+돽֢@z_N+YtMwU[%1I`O5oZEsm*MC2*c.[krȬ0 fx'z_>K  &rFI!@ Yt./S@'f@88"LZu okmM,p/@"ZL:lGz1ӭr>࿆mq8l ɖWefRE6yrֽ+߱/7VwmL'(aٗʭ2鴟sᯇc5-# c'o^~ oGB&䃂I'n:jIxo_أC4d|`>Q4Ma_~rzc=d~wt fI]5֛Ĥxuu͕֯{wlcs&64udW介"K N3F6zܔͥͨjL$sSWݗ[SCxVkK-5|1Lk?/E5It~ZeK5sypz]x_kF%5?͏K11v 8cgW:Fd̺|@\_ݎ'89MICc346B+]7ytn'z|Gm]qQ0<2pxZ^񕮛^k3l56"o,xWQ<5)K1M5W#(GsUnw1}`-z1xkɔxVyRDn;uck/"MrJƨn( C.9\u_Q?hS=k'`fUTp0)=;э;o 5t?LZlq*(Vs~L]:=ORtɚ1qN0Up=>eb.whQ,2GpX#çx/yii;G9K`n{ >zX`,.==S]1ZvW';\zK}/v43_2vpX7f|EcY1>ИQ8l:ݦ⮓?܆nvn ~(OwR-5b+yr@|LwZ^ QSOF|ڬ'֓w EVa՗is@I>W q[CжO8^\=-+N$׳>?(2NHqɧG&MG;E`7VpnXS~%Bl HO .1q;z[VRľ"]JX4Uj煇[*Oxk?[Qsi~X∳s*+F򋟖,w.s;J5|;Џ-g5oNN:FmVT񆁪 "c^𭭦}ܹ=2wcƢ|QmPG Fc=AJ oֺܢ1fRz6=ѽw'[E5 猓_'Lt/xᗊ]RSM(ʮ 9>GGTL3^ >0.v67`o=Hb핶crA8aY5ˣi?>kSr8HGƼIѡ|"$ZKߑ\qO&s{Js8 V~ }HK"x\8 q]w8[PcC{7 9Xʮr9"9kuNJMᖉƲ멢)&GC9>s1x[4]Vk5=3c6.dt=,#|{o܁%nuA"_μq4}UM0]Au$F/068 dDfx,iF `K9~ӘW,y^i&=PDp2 4#M{G_IIYdL%>|MLỶ?,l=:u4-UZ:|g,o.V0<^\O+6dܗ2 POE]ֻO}ok[ú~={f=RҾŐHnn{9`x]r>&[b[HEup:K1!nv׊!^PDv=̟y:|%cc(^H䙘f=r9X#QIe#oe* #}=tK~9ɂEfr oe::W]/u&q0%qHo[_ |o F[ ; K~{b9_HfW!@cb~gA3ō|?Uu?V+oO1s7y`2kVp3Ms %;~GUD<:;pSʉc44|gҜxPFE|g|"|sKOxh_bU{;DTcɻK`;Ւ(t*@ |)> )ִ^i F=757#/^i qw xӮ7gR ey]vQ#P߁c4wJ~#-8A<\ZlkZʒLX60W݉25S=7xI2CR;[I'L y(9YU jeU:/s"r.=l;?S?Fi6qJdYn$>2Tl:\ӛ ދ'0^0Arý!x+UAv=@15\+ ;^SD~񽁣FBrf^O0!Ӷ*8GΌteX /ޠA5\?HzPQ1 pHpfV}NJMO9GB|n>AaTe /nwfzl֒>ړQ]V7®v6O9*ډ+uKfH͌Q2odP2DHdӭ=[cvF:1T8WXC#C['iVJ\=ZvUP5 6y;L"H`$\PH\9C1f0Wj!DVjr2Nl-sje+bUŤj[%8CQo ח3gGvtx澇ڮ@)1oiߞ?џ #ly'mڔ0Dڮ v&bP34XWQ`cyri5; b0 *H 00 *H  00 *H  0?, 4ZHFdmra>NOU Ope^-Da"т1Y`MI_^&[#ldT wƙ3M\5ul DӭƧŋ4X#H۬X l<$TPŠ͘{tvq*KF|6]'AZw ҂U9\$dаRRCPAN`UȖzxDy/mfXk$"<_x;ͩE.$VRN; 4s1X?,˷HBiY`bDR{%3YDYۨКYBB E ױ2 +NQO `: TVj5xWI+|c==28)Um]C9VZt萡Sޢ~gg`-|*jiWt7lʔ{iϏ,v}cJ-$$6oRLd\\1v*EفVzBő 5^0B&xZJkg֑|!_"~@G+Wz7;VV}*WvϢz`|VظVxW[?O1%0# *H  1*zSr5zZq8R010!0 +#h(IJ2Z* U7LrOnode-v4.8.2/test/fixtures/test_dsa_params.pem000644 000766 000024 00000001444 13070706736 021470 0ustar00iojsstaff000000 000000 -----BEGIN DSA PARAMETERS----- MIICIAKCAQEAiJCR40HCtA6pk864XhKceke8N4chlrpwcphAXpHwSQGHlv1JJFyj aPqugWtzwZH55g7qpIiT3fmg6V6PfzNfx4sQGlSjckZaN02WRUAacn0va6UbwyYV 7LZzuHlHzayHLl/btGeTF+zL+9eMLKfll+r+5bJXDMWh3xUD1Nldf+fsIsbVZI9Q Nzf3L1/07XVTLedQYaE77OqVuu+cfoBtb+K5MsQdHMMN20BGjKIvGkJICuC448Gk Dx1wpxz2vSJEi6FqXruM6c9yrPvhJKSfbVFYK2n82MMXMNNu9Dwqwsv6Ig6dIVyw dKDrSw1Nz9j9TWA5BolNta3yMPHrEjCuIQIVAKq0ZZ0/36sZE1cqt6j0hZTisWUV AoIBAFbI9MKn9DBJ7lo7+LRblgNKg9lk4D/6NBBRgOeCN4WnOxHQrqpSTUBG+VcA BDKEfoHfEPI9KZKpEgpzGTpr7mGxDPLHfGL+vvf1EYbmcTDrUWlf9B/3+L3uwIdd v3NYLepyEZ8L8g6eRGSQ4Svg1oSR/GAUTeGJczPg6qW0b/LTpf4eeDNWYGF6aogJ UphnPcZ0Xqw+yvq/i1uzAVirUxp9Crb7km0dfA0G/HBiSdcEt6l8LdQd6qmcL0nx cm9x6L+tSol5hXNynV0wcxdCQz4Xj5na+NoRGb9jPYxgLkoq07hwAkqkQDyF61tx fWgGc7zmh/x6JMGe/Xhg1TvgxLs= -----END DSA PARAMETERS----- node-v4.8.2/test/fixtures/test_dsa_privkey.pem000644 000766 000024 00000002310 13070706736 021667 0ustar00iojsstaff000000 000000 -----BEGIN DSA PRIVATE KEY----- MIIDVQIBAAKCAQEAuQmFtb2R28f2LZvv5vqLHh263pDneNFTksm6qOlLNjcrBavu OqzZZ0dvC5KJYOJ7/lyumE5Qd12xMG4m2GtbsArgBIqP2bNq3zqRjcKd9RYN6W/G YRa545oa0IWX0U+m118N4b8l4rY4EJMCLES+TlGJUAhCG3/i7KIIpEHs9vsWmGJK lKkmHW+PCJFbQ0zMHlrJaQylJiHx9XMtKLKjAvexkfBF174Su7IoNoYR7Y/jRRgO 5mo3xBZk3dJmn2QZRBaHar5MFdau00zKw1oJDtpXHNgxDI2faJ/cVbM0YTQhiMLh SS4VgSnzWefV+y1MRH5HpaXHtCq+XhZscDeJ9wIhAKSu6bu06h6oiKBg5gMlJu9Y Md1eU95jWoofGP/Ye3TLAoIBACTbXwui6qVPOFDM/p7MUnIf8pQ8dZcod6zhmfVp /trSIWoSPoag8Jj3h78pswx4dkI7l4M3mZqNe+dwgQrWHVNBp7pkhBFFAokwW0rF +mctFSOMP0Mt1leSKF15BfWLG5AvCYT6vYxy2uULeefUxft+OzhbKOWnvl5JGfAt ddlMip2M754qpW49Am+BOxWnQs0oIAvXNna2BNdjMUBBG3XQFTbcucKY4d0HdsvJ Cjw0p+Dgq0iFwC/Fg1yZOdO0S+ZqKip8IrP94j1F4lO7PEJiT+AfDJ+LwzNTtKzk Qps/Sl89H+TNJcN/Y3QPwBtHzTc/OighUz3V8/yM9U4aYU0CggEAS8U79P4cax28 Emh8kQqiLEyoo89LIsD+DiBuEpeSGb7ty29dP2eRIBce4AVHQ7D/Pwkm8bxnh5+Y iDqD13344lZY32a5zMXmMnN1e/lPs21p/z7XO/5ggDzw+h7EQHPIAF87KvPFiO14 Vi1m9IzG/Nmu4Flks+4IBXlsXxgLDbYjtuQuOhmU+VtIxiQbrbe+wVMhzzaDNMt/ wXr5twAwWbPqJynPlodndElETz6dNLL0gW61uHN/CFsaMTLManftSifh5DJpglaL yQ/2+uGje419/kOWOexZ8ysREKIBrhWhePolw8SAiygwbCUhgSbruWpJPpQOOtI5 YTh2lIK0vAIgIY7133yqdVd5zIlFFLGM0tjLJ9eGwRYgcEnTYIrUcBA= -----END DSA PRIVATE KEY----- node-v4.8.2/test/fixtures/test_dsa_privkey_encrypted.pem000644 000766 000024 00000001714 13070706736 023753 0ustar00iojsstaff000000 000000 -----BEGIN ENCRYPTED PRIVATE KEY----- MIICkjAcBgoqhkiG9w0BDAEDMA4ECLCAnNHA9e3tAgIIAASCAnC9H9ncbLh/TpT9 jVecNZZ+udUB0qmaqIQ+qW03NJfrJdGhAd8tbhGb2hqIi4tLfOpUAQS93BfMXguM hyVQWJLGreIm7ehIqXwwFJFts9WJWsS9UleHOTtKNQvft3Lkp29lR/DZtXsJfJbT 0gjjHFpGhaNnIEK8eRAoyXZTPLv6ZPvFp4szj7GjslP5dvkcBeXbgTlBAT4EVB9e 43tfF1J2wOnuIkQXvnZ5eVseYIbKpCjAU/ZkoZU6ySVvFkc3+NIB9qHqKsE4LKdp wqhCuuh0b95TpiUoI+IIsLUbcGW7EZGwkVV2NxYZGpNehx5/kwGnH32KyDOqNVkm y5sC96oRSXz9eAo69zC0LgFL4ZyHWa9gebgPXRSbegiLNt+wxE4arSPlwUaKWzlH qEL2zzeVBIvuDwQ6SDMNiNv1GK68kaZ9AuR0jPn3COO2TgdWaigqrGPpNv8c/F2m Hv1ex6FAJr88aglxU7K6gS7ayFtWZqdg4K7KIGrP8Ii/UCkzQxSnFRTFbjUJCK8A 5mM7/jpmUd/U6Ygl/QrtMjPBHN02CjTc3LZK92uUf0g1u838zX91FxvItzyockpg rkZ5UWggZ2q0Hg7duYffjOR28d6u44JPIPJ9WIN2upsZoP1ABdUdazBRhpq9Da68 7+lpZC5BGwhpiP93bB66T+QwjqLCDFygIaCii+vQq/814pk/i/7VBEVGm2iDjOx/ Ng99ltKl+JDJ/lQwE27pp+JP+9Oe8uU94kelPA7w8xrj/YuukQbVY03+WYFag/Dn uMJyKYOqm7LmHOQy8rggM9RjY6XQY0KV8BKX3wG+4zjARTLKRbo= -----END ENCRYPTED PRIVATE KEY----- node-v4.8.2/test/fixtures/test_dsa_pubkey.pem000644 000766 000024 00000002252 13070706736 021502 0ustar00iojsstaff000000 000000 -----BEGIN PUBLIC KEY----- MIIDRjCCAjkGByqGSM44BAEwggIsAoIBAQC5CYW1vZHbx/Ytm+/m+oseHbrekOd4 0VOSybqo6Us2NysFq+46rNlnR28Lkolg4nv+XK6YTlB3XbEwbibYa1uwCuAEio/Z s2rfOpGNwp31Fg3pb8ZhFrnjmhrQhZfRT6bXXw3hvyXitjgQkwIsRL5OUYlQCEIb f+LsogikQez2+xaYYkqUqSYdb48IkVtDTMweWslpDKUmIfH1cy0osqMC97GR8EXX vhK7sig2hhHtj+NFGA7majfEFmTd0mafZBlEFodqvkwV1q7TTMrDWgkO2lcc2DEM jZ9on9xVszRhNCGIwuFJLhWBKfNZ59X7LUxEfkelpce0Kr5eFmxwN4n3AiEApK7p u7TqHqiIoGDmAyUm71gx3V5T3mNaih8Y/9h7dMsCggEAJNtfC6LqpU84UMz+nsxS ch/ylDx1lyh3rOGZ9Wn+2tIhahI+hqDwmPeHvymzDHh2QjuXgzeZmo1753CBCtYd U0GnumSEEUUCiTBbSsX6Zy0VI4w/Qy3WV5IoXXkF9YsbkC8JhPq9jHLa5Qt559TF +347OFso5ae+XkkZ8C112UyKnYzvniqlbj0Cb4E7FadCzSggC9c2drYE12MxQEEb ddAVNty5wpjh3Qd2y8kKPDSn4OCrSIXAL8WDXJk507RL5moqKnwis/3iPUXiU7s8 QmJP4B8Mn4vDM1O0rORCmz9KXz0f5M0lw39jdA/AG0fNNz86KCFTPdXz/Iz1Thph TQOCAQUAAoIBAEvFO/T+HGsdvBJofJEKoixMqKPPSyLA/g4gbhKXkhm+7ctvXT9n kSAXHuAFR0Ow/z8JJvG8Z4efmIg6g9d9+OJWWN9muczF5jJzdXv5T7Ntaf8+1zv+ YIA88PoexEBzyABfOyrzxYjteFYtZvSMxvzZruBZZLPuCAV5bF8YCw22I7bkLjoZ lPlbSMYkG623vsFTIc82gzTLf8F6+bcAMFmz6icpz5aHZ3RJRE8+nTSy9IFutbhz fwhbGjEyzGp37Uon4eQyaYJWi8kP9vrho3uNff5DljnsWfMrERCiAa4VoXj6JcPE gIsoMGwlIYEm67lqST6UDjrSOWE4dpSCtLw= -----END PUBLIC KEY----- node-v4.8.2/test/fixtures/test_key.pem000644 000766 000024 00000001567 13070706736 020154 0ustar00iojsstaff000000 000000 -----BEGIN RSA PRIVATE KEY----- MIICXQIBAAKBgQDx3wdzpq2rvwm3Ucun1qAD/ClB+wW+RhR1nVix286QvaNqePAd CAwwLL82NqXcVQRbQ4s95splQnwvjgkFdKVXFTjPKKJI5aV3wSRN61EBVPdYpCre 535yfG/uDysZFCnVQdnCZ1tnXAR8BirxCNjHqbVyIyBGjsNoNCEPb2R35QIDAQAB AoGBAJNem9C4ftrFNGtQ2DB0Udz7uDuucepkErUy4MbFsc947GfENjDKJXr42Kx0 kYx09ImS1vUpeKpH3xiuhwqe7tm4FsCBg4TYqQle14oxxm7TNeBwwGC3OB7hiokb aAjbPZ1hAuNs6ms3Ybvvj6Lmxzx42m8O5DXCG2/f+KMvaNUhAkEA/ekrOsWkNoW9 2n3m+msdVuxeek4B87EoTOtzCXb1dybIZUVv4J48VAiM43hhZHWZck2boD/hhwjC M5NWd4oY6QJBAPPcgBVNdNZSZ8hR4ogI4nzwWrQhl9MRbqqtfOn2TK/tjMv10ALg lPmn3SaPSNRPKD2hoLbFuHFERlcS79pbCZ0CQQChX3PuIna/gDitiJ8oQLOg7xEM wk9TRiDK4kl2lnhjhe6PDpaQN4E4F0cTuwqLAoLHtrNWIcOAQvzKMrYdu1MhAkBm Et3qDMnjDAs05lGT72QeN90/mPAcASf5eTTYGahv21cb6IBxM+AnwAPpqAAsHhYR 9h13Y7uYbaOjvuF23LRhAkBoI9eaSMn+l81WXOVUHnzh3ZwB4GuTyxMXXNOhuiFd 0z4LKAMh99Z4xQmqSoEkXsfM4KPpfhYjF/bwIcP5gOei -----END RSA PRIVATE KEY----- node-v4.8.2/test/fixtures/test_rsa_privkey.pem000644 000766 000024 00000001573 13070706736 021717 0ustar00iojsstaff000000 000000 -----BEGIN RSA PRIVATE KEY----- MIICXgIBAAKBgQDCFENGw33yGihy92pDjZQhl0C36rPJj+CvfSC8+q28hxA161QF NUd13wuCTUcq0Qd2qsBe/2hFyc2DCJJg0h1L78+6Z4UMR7EOcpfdUE9Hf3m/hs+F UR45uBJeDK1HSFHD8bHKD6kv8FPGfJTotc+2xjJwoYi+1hqp1fIekaxsyQIDAQAB AoGBAJR8ZkCUvx5kzv+utdl7T5MnordT1TvoXXJGXK7ZZ+UuvMNUCdN2QPc4sBiA QWvLw1cSKt5DsKZ8UETpYPy8pPYnnDEz2dDYiaew9+xEpubyeW2oH4Zx71wqBtOK kqwrXa/pzdpiucRRjk6vE6YY7EBBs/g7uanVpGibOVAEsqH1AkEA7DkjVH28WDUg f1nqvfn2Kj6CT7nIcE3jGJsZZ7zlZmBmHFDONMLUrXR/Zm3pR5m0tCmBqa5RK95u 412jt1dPIwJBANJT3v8pnkth48bQo/fKel6uEYyboRtA5/uHuHkZ6FQF7OUkGogc mSJluOdc5t6hI1VsLn0QZEjQZMEOWr+wKSMCQQCC4kXJEsHAve77oP6HtG/IiEn7 kpyUXRNvFsDE0czpJJBvL/aRFUJxuRK91jhjC68sA7NsKMGg5OXb5I5Jj36xAkEA gIT7aFOYBFwGgQAQkWNKLvySgKbAZRTeLBacpHMuQdl1DfdntvAyqpAZ0lY0RKmW G6aFKaqQfOXKCyWoUiVknQJAXrlgySFci/2ueKlIE1QqIiLSZ8V8OlpFLRnb1pzI 7U1yQXnTAEFYM560yJlzUpOb1V4cScGd365tiSMvxLOvTA== -----END RSA PRIVATE KEY----- node-v4.8.2/test/fixtures/test_rsa_privkey_2.pem000644 000766 000024 00000001563 13070706736 022137 0ustar00iojsstaff000000 000000 -----BEGIN RSA PRIVATE KEY----- MIICWQIBAAKBgQCsMgRdxxEeeXscPvqFzp/6/IIdoeKSlBn7361FWZwMQUG0qCbr XYtdXPyqp2B4GThviIqiaJZITCTY87CiV7bFvH2lmUMJLsCc3BaQ4XFQbEU5D5jN FfP7g78MEKbCb9rEfYMI2EGwbfKRUZUrYeBadzIMHEMEHDyiBXrCohTXMQIBIwKB gHEoLsFITRQGr/yeah1qhmMa9ms+fvKb1o+S/NXNLAgNoDTjh0o2KGHspgm+cpgQ kszzU8nPszbS86SC4cnEnKy/g3uw3Lf55a2P8vgh1P386/PzI+Im8s6E/EpDwn/P R2E5gqTfePl8m7r9oeIARZXysmHHgBtEm5pTUav6QvOLAkEA2arx2R/3Yb6yZ5oO 3ldZEzCBNmB6mCoczrH6jjBosb4Gj7TK+asNlbinw1gj8sgdkzAw6jGnJ2IUfftm QMykwQJBAMqFDclCf2b9cwi82+Xg+mjlT8BEf+l5xdRrweOyjB6DmUhgeqDISJUK JgxGr4TxIQ6DGeEWxChGzzU6utlRnnECQDf4wdi/E7oMdwSylhvqkz9y32XBCZTX oQHzQG20rTUE+l93oeht0EsSOcSEYQPqUL9yyr/g4dbtVbn+0SabBcsCQEs4u/pL 5i2RVpzYbu77yrk/OuEDf/eiQipT6O4sX+4Tn1VlqePynp3B8N/8/11DnpBclJVu 2yTnGcNQVAeTWBsCQFMekiY/KbwAgTopqpCUg5CLNph91FVW5PIntLmd5gSj8ZJS uNuro8CURrOe8iiI3pG9m4KkbDdOBSOMADXJojE= -----END RSA PRIVATE KEY----- node-v4.8.2/test/fixtures/test_rsa_privkey_encrypted.pem000644 000766 000024 00000001741 13070706736 023771 0ustar00iojsstaff000000 000000 -----BEGIN ENCRYPTED PRIVATE KEY----- MIICojAcBgoqhkiG9w0BDAEDMA4ECEMCOq/cAz8QAgIIAASCAoDT/S5XcBm7u/2i Ar4vLx5L+heu9f4iRRStWO/yaOvxZRmrqNJXI15F74mtfrXga+LKyd8YAYD8XR4e na6SbOZmBFHBZOWBDmDiupMoq+mOgTe84iOgo8LHYf040PzZnL/ouvepQy5LU1A5 bv9T1d1BVpQ2IfQ9QNu8rUZFxlD1VzFCB9mvwUgcAfaTSfxyamr7KPlKaIhwPK11 c1w0xoC+N1mp3KrfK/jwWk3JYFVq35W/7PUsC25qyLWUgJLs9h/eGSzo/5kZ4fLK bzBox9DzhaoBiKnfPNVKlwP+jL19vVb+0USLh9vTQQ1o4oral1fA+04bJjeOkFTf VkxVpa7GUZzgjOPIWEeqHDFZ7QZDYKb2e4kWpx9CPWnUlRLcNE88GPx00LnsCkQH yHBAtA3VCRqE2Yn2ROJmfgjjKQorglxIS6dxc+J9gZb0/M4Ad4Hn7N/23UB3CjYD qeILsbOOTudQgIOoXOVMgRbhRD3HsU27OSuhvSd+CjpRG9BFuUcBmjZ06TOAZt8q IZlVwIEaJBeBAYtyfEsaEN76B0DhzvF5fGWSXtlhR3uvftsWQ0J192VvDDJ+DIvX SON62RfCzKD7FidmUbMVTgCwK2WJ0XiEHSgl7pLeSbAiEd3GAKrdH99FOOqcmqjr 0dLnbCCs3GuXTfoCZGDoNfvoqJ0HdF6zmIOU0mmUn4ia6R/LbbOYDM6DS+rkQRTA Dqh/ilbp2WU9+OChQIQUOQPLcA7prt/Tnkm3X5TFVVbx7WQRfJhu5l7qElrF8W81 iiBQrvtiJrBEDst1GmoKBMkOknj+QXK/NzhDFhcHWG5Kg0HQd3I6c1wdg64xBO3U lyI/PHdl -----END ENCRYPTED PRIVATE KEY----- node-v4.8.2/test/fixtures/test_rsa_pubkey.pem000644 000766 000024 00000000420 13070706736 021513 0ustar00iojsstaff000000 000000 -----BEGIN PUBLIC KEY----- MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDCFENGw33yGihy92pDjZQhl0C3 6rPJj+CvfSC8+q28hxA161QFNUd13wuCTUcq0Qd2qsBe/2hFyc2DCJJg0h1L78+6 Z4UMR7EOcpfdUE9Hf3m/hs+FUR45uBJeDK1HSFHD8bHKD6kv8FPGfJTotc+2xjJw oYi+1hqp1fIekaxsyQIDAQAB -----END PUBLIC KEY----- node-v4.8.2/test/fixtures/test_rsa_pubkey_2.pem000644 000766 000024 00000000367 13070706736 021746 0ustar00iojsstaff000000 000000 -----BEGIN RSA PUBLIC KEY----- MIGHAoGBAKwyBF3HER55exw++oXOn/r8gh2h4pKUGfvfrUVZnAxBQbSoJutdi11c /KqnYHgZOG+IiqJolkhMJNjzsKJXtsW8faWZQwkuwJzcFpDhcVBsRTkPmM0V8/uD vwwQpsJv2sR9gwjYQbBt8pFRlSth4Fp3MgwcQwQcPKIFesKiFNcxAgEj -----END RSA PUBLIC KEY----- node-v4.8.2/test/fixtures/throws_error.js000644 000766 000024 00000000031 13070706736 020700 0ustar00iojsstaff000000 000000 throw new Error('blah'); node-v4.8.2/test/fixtures/throws_error1.js000644 000766 000024 00000000031 13070706736 020761 0ustar00iojsstaff000000 000000 throw new Error('blah'); node-v4.8.2/test/fixtures/throws_error2.js000644 000766 000024 00000000030 13070706736 020761 0ustar00iojsstaff000000 000000 JSON.parse(undefined); node-v4.8.2/test/fixtures/throws_error3.js000644 000766 000024 00000000073 13070706736 020771 0ustar00iojsstaff000000 000000 process.nextTick(function() { JSON.parse(undefined); }); node-v4.8.2/test/fixtures/throws_error4.js000644 000766 000024 00000001747 13070706736 021003 0ustar00iojsstaff000000 000000 01234567890123456789012345/** 01234567890123456789012345678901234567890123456789 01234567890123456789012345678901234567890123456789 01234567890123456789012345678901234567890123456789 01234567890123456789012345678901234567890123456789 01234567890123456789012345678901234567890123456789 01234567890123456789012345678901234567890123456789 01234567890123456789012345678901234567890123456789 01234567890123456789012345678901234567890123456789 01234567890123456789012345678901234567890123456789 01234567890123456789012345678901234567890123456789 01234567890123456789012345678901234567890123456789 01234567890123456789012345678901234567890123456789 01234567890123456789012345678901234567890123456789 01234567890123456789012345678901234567890123456789 01234567890123456789012345678901234567890123456789 01234567890123456789012345678901234567890123456789 01234567890123456789012345678901234567890123456789 01234567890123456789012345678901234567890123456789 01234567890123456789012345678901234567890123456789 node-v4.8.2/test/fixtures/throws_error5.js000644 000766 000024 00000001005 13070706736 020767 0ustar00iojsstaff000000 000000 0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000k0000000000000000000 node-v4.8.2/test/fixtures/throws_error6.js000644 000766 000024 00000002006 13070706736 020772 0ustar00iojsstaff000000 000000 00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000k000000000 node-v4.8.2/test/fixtures/throws_error7.js000644 000766 000024 00000000070 13070706736 020772 0ustar00iojsstaff000000 000000 throw { toString: function() { throw this; } }; node-v4.8.2/test/fixtures/tls-session-ticket.txt000644 000766 000024 00000002615 13070706736 022122 0ustar00iojsstaff000000 000000 -----BEGIN SSL SESSION PARAMETERS----- MIID2wIBAQICAwEEAgA1BCAMjLe+70uBSPGvybkTnPVUMwdbdtVbkMIXf8L5M8Kl VAQwog+Afs00cnYUcgD1BQewJyxX1e561oRuDTpy7BHABC1hC7hxTaul+pwv+cBx 8D72oQYCBFFQF3OiBAICASyjggNhMIIDXTCCAkWgAwIBAgIJAMUSOvlaeyQHMA0G CSqGSIb3DQEBBQUAMEUxCzAJBgNVBAYTAkFVMRMwEQYDVQQIDApTb21lLVN0YXRl MSEwHwYDVQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQwHhcNMTAxMTE2MDkz MjQ5WhcNMTMxMTE1MDkzMjQ5WjBFMQswCQYDVQQGEwJBVTETMBEGA1UECAwKU29t ZS1TdGF0ZTEhMB8GA1UECgwYSW50ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjAN BgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAz+LXZOjcQCJq3+ZKUFabj71oo/ex /XsBcFqtBThjjTw9CVEVwfPQQp4XwtPiB204vnYXwQ1/R2NdTQqCZu47l79LssL/ u2a5Y9+0NEU3nQA5qdt+1FAE0c5oexPimXOrR3GWfKz7PmZ2O0117IeCUUXPG5U8 umhDe/4mDF4ZNJiKc404WthquTqgS7rLQZHhZ6D0EnGnOkzlmxJMYPNHSOY1/6iv dNUUcC87awNEA3lgfhy25IyBK3QJc+aYKNTbt70Lery3bu2wWLFGtmNiGlQTS4Js xImRsECTI727ObS7/FWAQsqW+COL0Sa5BuMFrFIpjPrEe0ih7vRRbdmXRwIDAQAB o1AwTjAdBgNVHQ4EFgQUDnV4d6mDtOnluLoCjkUHTX/n4agwHwYDVR0jBBgwFoAU DnV4d6mDtOnluLoCjkUHTX/n4agwDAYDVR0TBAUwAwEB/zANBgkqhkiG9w0BAQUF AAOCAQEAFwV4MQfTo+qMv9JMiynoIEiqfOz4RgtmBqRnXUffcjS2dhc7/z+FPZnM 79Kej8eLHoVfxCyWRHFlzm93vEdvwxOCrD13EDOi08OOZfxWyIlCa6Bg8cMAKqQz d2OvQOWqlRWBTThBJIhWflU33izXQn5GdmYqhfpc+9ZHHGhvXNydtRQkdxVK2dZN zLBvBlLlRmtoClU7xm3A+/5dddePAQHEPtyFlUw49VYtZ3ru6KqPms7MKvcRhYLs y9rwSfuuniMlx4d0bDR7TOkw0QQSA0N8MGQRQpzl4mw4jLzyM5d5QtuGBh2P6hPG a0YQxtI3RPT/p6ENzzBiAKXiSfzox6QCBAClAwIBEg== -----END SSL SESSION PARAMETERS----- node-v4.8.2/test/fixtures/uncaught-exceptions/000755 000766 000024 00000000000 13070706736 021606 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/utf8-bom.js000644 000766 000024 00000000030 13070706736 017601 0ustar00iojsstaff000000 000000 module.exports = 42; node-v4.8.2/test/fixtures/utf8-bom.json000644 000766 000024 00000000006 13070706736 020141 0ustar00iojsstaff000000 000000 42 node-v4.8.2/test/fixtures/vm-run-in-debug-context.js000644 000766 000024 00000000222 13070706736 022541 0ustar00iojsstaff000000 000000 if (process.argv[2] === 'handle-fatal-exception') process._fatalException = process.exit.bind(null, 42); require('vm').runInDebugContext('*'); node-v4.8.2/test/fixtures/x.txt000644 000766 000024 00000000004 13070706736 016613 0ustar00iojsstaff000000 000000 xyz node-v4.8.2/test/fixtures/x1024.txt000644 000766 000024 00000002000 13070706736 017120 0ustar00iojsstaff000000 000000 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxnode-v4.8.2/test/fixtures/uncaught-exceptions/domain.js000644 000766 000024 00000000337 13070706736 023416 0ustar00iojsstaff000000 000000 var domain = require('domain'); var d = domain.create(); d.on('error', function(err) { console.log('[ignored]', err.stack); }); d.run(function() { setImmediate(function() { throw new Error('in domain'); }); }); node-v4.8.2/test/fixtures/uncaught-exceptions/global.js000644 000766 000024 00000000103 13070706736 023376 0ustar00iojsstaff000000 000000 console.log('going to throw an error'); throw new Error('global'); node-v4.8.2/test/fixtures/uncaught-exceptions/parse-error-mod.js000644 000766 000024 00000000064 13070706736 025162 0ustar00iojsstaff000000 000000 console.log('parse error on next line'); var a = '; node-v4.8.2/test/fixtures/uncaught-exceptions/parse-error.js000644 000766 000024 00000000114 13070706736 024401 0ustar00iojsstaff000000 000000 console.log('require fails on next line'); require('./parse-error-mod.js'); node-v4.8.2/test/fixtures/uncaught-exceptions/timeout.js000644 000766 000024 00000000076 13070706736 023635 0ustar00iojsstaff000000 000000 setTimeout(function() { throw new Error('timeout'); }, 10); node-v4.8.2/test/fixtures/test-init-native/fs.js000644 000766 000024 00000000175 13070706736 021766 0ustar00iojsstaff000000 000000 (function() { var fs = require('fs'); if (fs.readFile) { require('util').print('fs loaded successfully'); } })(); node-v4.8.2/test/fixtures/test-init-index/index.js000644 000766 000024 00000000106 13070706736 022300 0ustar00iojsstaff000000 000000 (function() { require('util').print('Loaded successfully!'); })(); node-v4.8.2/test/fixtures/syntax/bad_syntax.js000644 000766 000024 00000000015 13070706736 021625 0ustar00iojsstaff000000 000000 var foo bar; node-v4.8.2/test/fixtures/syntax/bad_syntax_shebang.js000644 000766 000024 00000000041 13070706736 023313 0ustar00iojsstaff000000 000000 #!/usr/bin/env node var foo bar; node-v4.8.2/test/fixtures/syntax/good_syntax.js000644 000766 000024 00000000021 13070706736 022024 0ustar00iojsstaff000000 000000 var foo = 'bar'; node-v4.8.2/test/fixtures/syntax/good_syntax_shebang.js000644 000766 000024 00000000045 13070706736 023521 0ustar00iojsstaff000000 000000 #!/usr/bin/env node var foo = 'bar'; node-v4.8.2/test/fixtures/syntax/illegal_if_not_wrapped.js000644 000766 000024 00000000030 13070706736 024157 0ustar00iojsstaff000000 000000 if (true) { return; } node-v4.8.2/test/fixtures/require-bin/bin/000755 000766 000024 00000000000 13070706736 020603 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/require-bin/lib/000755 000766 000024 00000000000 13070706736 020601 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/require-bin/package.json000644 000766 000024 00000000056 13070706736 022322 0ustar00iojsstaff000000 000000 { "name": "req", "main": "./lib/req.js" } node-v4.8.2/test/fixtures/require-bin/lib/req.js000644 000766 000024 00000000025 13070706736 021723 0ustar00iojsstaff000000 000000 module.exports = ''; node-v4.8.2/test/fixtures/require-bin/bin/req.js000644 000766 000024 00000000041 13070706736 021723 0ustar00iojsstaff000000 000000 module.exports = require('../'); node-v4.8.2/test/fixtures/packages/invalid/000755 000766 000024 00000000000 13070706736 021015 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/packages/main/000755 000766 000024 00000000000 13070706736 020313 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/packages/main-index/000755 000766 000024 00000000000 13070706736 021420 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/packages/main-index/package-main-module/000755 000766 000024 00000000000 13070706736 025220 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/packages/main-index/package.json000644 000766 000024 00000000111 13070706736 023677 0ustar00iojsstaff000000 000000 {"name":"package-name" ,"version":"1.2.3" ,"main":"package-main-module"} node-v4.8.2/test/fixtures/packages/main-index/package-main-module/index.js000644 000766 000024 00000000023 13070706736 026660 0ustar00iojsstaff000000 000000 exports.ok = 'ok'; node-v4.8.2/test/fixtures/packages/main/package-main-module.js000644 000766 000024 00000000023 13070706736 024444 0ustar00iojsstaff000000 000000 exports.ok = 'ok'; node-v4.8.2/test/fixtures/packages/main/package.json000644 000766 000024 00000000111 13070706736 022572 0ustar00iojsstaff000000 000000 {"name":"package-name" ,"version":"1.2.3" ,"main":"package-main-module"} node-v4.8.2/test/fixtures/packages/invalid/index.js000644 000766 000024 00000000023 13070706736 022455 0ustar00iojsstaff000000 000000 exports.ok = 'ok'; node-v4.8.2/test/fixtures/packages/invalid/package.json000644 000766 000024 00000000004 13070706736 023275 0ustar00iojsstaff000000 000000 {,} node-v4.8.2/test/fixtures/node_modules/asdf.js000644 000766 000024 00000000170 13070706736 021537 0ustar00iojsstaff000000 000000 console.error(__filename); console.error(module.paths.join('\n') + '\n'); throw new Error('Should not ever get here.'); node-v4.8.2/test/fixtures/node_modules/bar.js000644 000766 000024 00000000112 13070706736 021362 0ustar00iojsstaff000000 000000 console.error(__filename); console.error(module.paths.join('\n') + '\n'); node-v4.8.2/test/fixtures/node_modules/baz/000755 000766 000024 00000000000 13070706736 021042 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/node_modules/foo.js000644 000766 000024 00000000243 13070706736 021406 0ustar00iojsstaff000000 000000 console.error(__filename); console.error(module.paths.join('\n') + '\n'); var assert = require('assert'); assert.equal(require('baz'), require('./baz/index.js')); node-v4.8.2/test/fixtures/node_modules/node_modules/000755 000766 000024 00000000000 13070706736 022743 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/node_modules/node_modules/bar.js000644 000766 000024 00000000170 13070706736 024043 0ustar00iojsstaff000000 000000 console.error(__filename); console.error(module.paths.join('\n') + '\n'); throw new Error('Should not ever get here.'); node-v4.8.2/test/fixtures/node_modules/baz/index.js000644 000766 000024 00000000571 13070706736 022512 0ustar00iojsstaff000000 000000 console.error(__filename); console.error(module.paths.join('\n') + '\n'); // this should work, and get the one that doesn't throw var assert = require('assert'); assert.equal(require('bar'), require('../bar.js')); // this should work, and get the one in ./node_modules/asdf.js assert.equal(require('asdf'), require('./node_modules/asdf.js')); module.exports = 'eye catcher'; node-v4.8.2/test/fixtures/node_modules/baz/node_modules/000755 000766 000024 00000000000 13070706736 023517 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/node_modules/baz/node_modules/asdf.js000644 000766 000024 00000000112 13070706736 024764 0ustar00iojsstaff000000 000000 console.error(__filename); console.error(module.paths.join('\n') + '\n'); node-v4.8.2/test/fixtures/nested-index/one/000755 000766 000024 00000000000 13070706736 020761 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/nested-index/three/000755 000766 000024 00000000000 13070706736 021307 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/nested-index/three.js000644 000766 000024 00000000000 13070706736 021633 0ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/nested-index/two/000755 000766 000024 00000000000 13070706736 021011 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/nested-index/two/hello.js000644 000766 000024 00000000044 13070706736 022450 0ustar00iojsstaff000000 000000 exports.hello = 'hello from two!'; node-v4.8.2/test/fixtures/nested-index/two/index.js000644 000766 000024 00000000052 13070706736 022453 0ustar00iojsstaff000000 000000 exports.hello = require('./hello').hello; node-v4.8.2/test/fixtures/nested-index/three/index.js000644 000766 000024 00000000000 13070706736 022742 0ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/nested-index/one/hello.js000644 000766 000024 00000000044 13070706736 022420 0ustar00iojsstaff000000 000000 exports.hello = 'hello from one!'; node-v4.8.2/test/fixtures/nested-index/one/index.js000644 000766 000024 00000000052 13070706736 022423 0ustar00iojsstaff000000 000000 exports.hello = require('./hello').hello; node-v4.8.2/test/fixtures/module-require/child/000755 000766 000024 00000000000 13070706736 021633 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/module-require/parent/000755 000766 000024 00000000000 13070706736 022041 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/module-require/relative/000755 000766 000024 00000000000 13070706736 022363 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/module-require/relative/dot-slash.js000644 000766 000024 00000000040 13070706736 024611 0ustar00iojsstaff000000 000000 module.exports = require('./'); node-v4.8.2/test/fixtures/module-require/relative/dot.js000644 000766 000024 00000000037 13070706736 023507 0ustar00iojsstaff000000 000000 module.exports = require('.'); node-v4.8.2/test/fixtures/module-require/relative/index.js000644 000766 000024 00000000024 13070706736 024024 0ustar00iojsstaff000000 000000 exports.value = 42; node-v4.8.2/test/fixtures/module-require/parent/index.js000644 000766 000024 00000000315 13070706736 023505 0ustar00iojsstaff000000 000000 var child = require('../child'); //console.log(child.module.require, child.module); console.log(child.module.require('target')); console.log(child.loaded); exports.loaded = child.module.require('target'); node-v4.8.2/test/fixtures/module-require/parent/node_modules/000755 000766 000024 00000000000 13070706736 024516 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/module-require/parent/node_modules/target.js000644 000766 000024 00000000040 13070706736 026334 0ustar00iojsstaff000000 000000 exports.loaded = 'from parent'; node-v4.8.2/test/fixtures/module-require/child/index.js000644 000766 000024 00000000075 13070706736 023302 0ustar00iojsstaff000000 000000 exports.loaded = require('target'); exports.module = module; node-v4.8.2/test/fixtures/module-require/child/node_modules/000755 000766 000024 00000000000 13070706736 024310 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/module-require/child/node_modules/target.js000644 000766 000024 00000000037 13070706736 026134 0ustar00iojsstaff000000 000000 exports.loaded = 'from child'; node-v4.8.2/test/fixtures/module-load-order/file1000644 000766 000024 00000000031 13070706736 022041 0ustar00iojsstaff000000 000000 exports.file1 = 'file1'; node-v4.8.2/test/fixtures/module-load-order/file1.js000644 000766 000024 00000000034 13070706736 022457 0ustar00iojsstaff000000 000000 exports.file1 = 'file1.js'; node-v4.8.2/test/fixtures/module-load-order/file1.node000644 000766 000024 00000000036 13070706736 022772 0ustar00iojsstaff000000 000000 exports.file1 = 'file1.node'; node-v4.8.2/test/fixtures/module-load-order/file1.reg000644 000766 000024 00000000035 13070706736 022621 0ustar00iojsstaff000000 000000 exports.file1 = 'file1.reg'; node-v4.8.2/test/fixtures/module-load-order/file1.reg2000644 000766 000024 00000000036 13070706736 022704 0ustar00iojsstaff000000 000000 exports.file1 = 'file1.reg2'; node-v4.8.2/test/fixtures/module-load-order/file2/000755 000766 000024 00000000000 13070706736 022125 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/module-load-order/file2.js000644 000766 000024 00000000034 13070706736 022460 0ustar00iojsstaff000000 000000 exports.file2 = 'file2.js'; node-v4.8.2/test/fixtures/module-load-order/file2.node000644 000766 000024 00000000036 13070706736 022773 0ustar00iojsstaff000000 000000 exports.file2 = 'file2.node'; node-v4.8.2/test/fixtures/module-load-order/file2.reg000644 000766 000024 00000000035 13070706736 022622 0ustar00iojsstaff000000 000000 exports.file2 = 'file2.reg'; node-v4.8.2/test/fixtures/module-load-order/file2.reg2000644 000766 000024 00000000036 13070706736 022705 0ustar00iojsstaff000000 000000 exports.file2 = 'file2.reg2'; node-v4.8.2/test/fixtures/module-load-order/file3/000755 000766 000024 00000000000 13070706736 022126 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/module-load-order/file3.node000644 000766 000024 00000000036 13070706736 022774 0ustar00iojsstaff000000 000000 exports.file3 = 'file3.node'; node-v4.8.2/test/fixtures/module-load-order/file3.reg000644 000766 000024 00000000035 13070706736 022623 0ustar00iojsstaff000000 000000 exports.file3 = 'file3.reg'; node-v4.8.2/test/fixtures/module-load-order/file3.reg2000644 000766 000024 00000000036 13070706736 022706 0ustar00iojsstaff000000 000000 exports.file3 = 'file3.reg2'; node-v4.8.2/test/fixtures/module-load-order/file4/000755 000766 000024 00000000000 13070706736 022127 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/module-load-order/file4.reg000644 000766 000024 00000000035 13070706736 022624 0ustar00iojsstaff000000 000000 exports.file4 = 'file4.reg'; node-v4.8.2/test/fixtures/module-load-order/file4.reg2000644 000766 000024 00000000036 13070706736 022707 0ustar00iojsstaff000000 000000 exports.file4 = 'file4.reg2'; node-v4.8.2/test/fixtures/module-load-order/file5/000755 000766 000024 00000000000 13070706736 022130 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/module-load-order/file5.reg2000644 000766 000024 00000000036 13070706736 022710 0ustar00iojsstaff000000 000000 exports.file5 = 'file5.reg2'; node-v4.8.2/test/fixtures/module-load-order/file6/000755 000766 000024 00000000000 13070706736 022131 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/module-load-order/file7/000755 000766 000024 00000000000 13070706736 022132 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/module-load-order/file8/000755 000766 000024 00000000000 13070706736 022133 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/module-load-order/file9/000755 000766 000024 00000000000 13070706736 022134 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/module-load-order/file9/index.reg2000644 000766 000024 00000000044 13070706736 024022 0ustar00iojsstaff000000 000000 exports.file9 = 'file9/index.reg2'; node-v4.8.2/test/fixtures/module-load-order/file8/index.reg000644 000766 000024 00000000043 13070706736 023736 0ustar00iojsstaff000000 000000 exports.file8 = 'file8/index.reg'; node-v4.8.2/test/fixtures/module-load-order/file8/index.reg2000644 000766 000024 00000000044 13070706736 024021 0ustar00iojsstaff000000 000000 exports.file8 = 'file8/index.reg2'; node-v4.8.2/test/fixtures/module-load-order/file7/index.node000644 000766 000024 00000000044 13070706736 024106 0ustar00iojsstaff000000 000000 exports.file7 = 'file7/index.node'; node-v4.8.2/test/fixtures/module-load-order/file7/index.reg000644 000766 000024 00000000043 13070706736 023735 0ustar00iojsstaff000000 000000 exports.file7 = 'file7/index.reg'; node-v4.8.2/test/fixtures/module-load-order/file7/index.reg2000644 000766 000024 00000000044 13070706736 024020 0ustar00iojsstaff000000 000000 exports.file7 = 'file7/index.reg2'; node-v4.8.2/test/fixtures/module-load-order/file6/index.js000644 000766 000024 00000000042 13070706736 023572 0ustar00iojsstaff000000 000000 exports.file6 = 'file6/index.js'; node-v4.8.2/test/fixtures/module-load-order/file6/index.node000644 000766 000024 00000000044 13070706736 024105 0ustar00iojsstaff000000 000000 exports.file6 = 'file6/index.node'; node-v4.8.2/test/fixtures/module-load-order/file6/index.reg000644 000766 000024 00000000043 13070706736 023734 0ustar00iojsstaff000000 000000 exports.file6 = 'file6/index.reg'; node-v4.8.2/test/fixtures/module-load-order/file6/index.reg2000644 000766 000024 00000000044 13070706736 024017 0ustar00iojsstaff000000 000000 exports.file6 = 'file6/index.reg2'; node-v4.8.2/test/fixtures/module-load-order/file5/index.js000644 000766 000024 00000000042 13070706736 023571 0ustar00iojsstaff000000 000000 exports.file5 = 'file5/index.js'; node-v4.8.2/test/fixtures/module-load-order/file5/index.node000644 000766 000024 00000000044 13070706736 024104 0ustar00iojsstaff000000 000000 exports.file5 = 'file5/index.node'; node-v4.8.2/test/fixtures/module-load-order/file5/index.reg000644 000766 000024 00000000043 13070706736 023733 0ustar00iojsstaff000000 000000 exports.file5 = 'file5/index.reg'; node-v4.8.2/test/fixtures/module-load-order/file5/index.reg2000644 000766 000024 00000000044 13070706736 024016 0ustar00iojsstaff000000 000000 exports.file5 = 'file5/index.reg2'; node-v4.8.2/test/fixtures/module-load-order/file4/index.js000644 000766 000024 00000000042 13070706736 023570 0ustar00iojsstaff000000 000000 exports.file4 = 'file4/index.js'; node-v4.8.2/test/fixtures/module-load-order/file4/index.node000644 000766 000024 00000000044 13070706736 024103 0ustar00iojsstaff000000 000000 exports.file4 = 'file4/index.node'; node-v4.8.2/test/fixtures/module-load-order/file4/index.reg000644 000766 000024 00000000043 13070706736 023732 0ustar00iojsstaff000000 000000 exports.file4 = 'file4/index.reg'; node-v4.8.2/test/fixtures/module-load-order/file4/index.reg2000644 000766 000024 00000000044 13070706736 024015 0ustar00iojsstaff000000 000000 exports.file4 = 'file4/index.reg2'; node-v4.8.2/test/fixtures/module-load-order/file3/index.js000644 000766 000024 00000000042 13070706736 023567 0ustar00iojsstaff000000 000000 exports.file3 = 'file3/index.js'; node-v4.8.2/test/fixtures/module-load-order/file3/index.node000644 000766 000024 00000000044 13070706736 024102 0ustar00iojsstaff000000 000000 exports.file3 = 'file3/index.node'; node-v4.8.2/test/fixtures/module-load-order/file3/index.reg000644 000766 000024 00000000043 13070706736 023731 0ustar00iojsstaff000000 000000 exports.file3 = 'file3/index.reg'; node-v4.8.2/test/fixtures/module-load-order/file3/index.reg2000644 000766 000024 00000000044 13070706736 024014 0ustar00iojsstaff000000 000000 exports.file3 = 'file3/index.reg2'; node-v4.8.2/test/fixtures/module-load-order/file2/index.js000644 000766 000024 00000000042 13070706736 023566 0ustar00iojsstaff000000 000000 exports.file2 = 'file2/index.js'; node-v4.8.2/test/fixtures/module-load-order/file2/index.node000644 000766 000024 00000000044 13070706736 024101 0ustar00iojsstaff000000 000000 exports.file2 = 'file2/index.node'; node-v4.8.2/test/fixtures/module-load-order/file2/index.reg000644 000766 000024 00000000043 13070706736 023730 0ustar00iojsstaff000000 000000 exports.file2 = 'file2/index.reg'; node-v4.8.2/test/fixtures/module-load-order/file2/index.reg2000644 000766 000024 00000000044 13070706736 024013 0ustar00iojsstaff000000 000000 exports.file2 = 'file2/index.reg2'; node-v4.8.2/test/fixtures/keys/0-dns-cert.pem000644 000766 000024 00000002113 13070706736 021140 0ustar00iojsstaff000000 000000 -----BEGIN CERTIFICATE----- MIIC/zCCAemgAwIBAgICJxEwCwYJKoZIhvcNAQEFMBUxEzARBgNVBAMWCm9oLm15 Lmdvc2gwHhcNMTQxMjA4MTM0MTUzWhcNMzQxMjAzMTM0MTUzWjATMREwDwYDVQQD FghldmlsLmNvbTCCASAwCwYJKoZIhvcNAQEBA4IBDwAwggEKAoIBAQCsFwwf1dsr PdxyTHBreymbFGACLQtaOihGsSkYtIzUEF1aT90YDMzNdoLr4wkwWig5FPRMnjmX 7pXY9RVbWmwG/M2eku9S62LekUFkeY1W/QftV9LYgAg7wVDA+v3+zk/EMEqADYm6 W735tzDIKtvx+/3Dd9puQ0TLFNHBxAmTz7YNaJdIUqzs3DWT4zeZQj0RCOyWCjQL NfqQ80I7NYFYb4IJqiUY8iOTL5kPi7b5szem5EakQbhufDWun4xGTZk/URZHgYgp REbOLTYs2hqbK76biW/Yvwd1l7RsptIvJvkuQ1R/dO1WPv6PLKLTuS1EOHM3YqNH o7wDSplOJe5rAgMBAAGhCQMHADEyMzQ1NqIJAwcANzg5YWJjo0swSTBHBgNVHREE QDA+ghRnb29nbGUuY29tAC5ldmlsLmNvbYIQanVzdC1hbm90aGVyLmNvbYcECAgI CIcECAgEBIIIbGFzdC5jb20wCwYJKoZIhvcNAQEBA4IBAQBAC2n4CIXLnyONTjPc qU0wu41wI+IQlb9mi0C7WEd9HumCbskahAp8vTs35DehnSxrl15FG0rABVtTROCv eflBKuzwPjtnfZm37UIbQKQUtcxwMQ/zvA83w4GLrLvrFtaQRpXn/RtL/q4CIpQH MGaPW1Gs24RVBHxI7OXf9UlUruB1yQLUbbtdBtxZ6pk/B32e3yWowbvG7OxuUL0F 1w4DD2m+GfbTyZSCfYKP/zMp3xhTxihVfZ2g07ufc51bNCftWKBLHM/QHJmn4pVo rrz1vS9nMf/i16zrJ8Xmj61Eo4Aes37lAH5kUiT1VsNxSDcQCiqr1mcj6ByXKNCQ wDzO -----END CERTIFICATE----- node-v4.8.2/test/fixtures/keys/0-dns-key.pem000644 000766 000024 00000003213 13070706736 020775 0ustar00iojsstaff000000 000000 -----BEGIN RSA PRIVATE KEY----- MIIEowIBAAKCAQEArBcMH9XbKz3cckxwa3spmxRgAi0LWjooRrEpGLSM1BBdWk/d GAzMzXaC6+MJMFooORT0TJ45l+6V2PUVW1psBvzNnpLvUuti3pFBZHmNVv0H7VfS 2IAIO8FQwPr9/s5PxDBKgA2Julu9+bcwyCrb8fv9w3fabkNEyxTRwcQJk8+2DWiX SFKs7Nw1k+M3mUI9EQjslgo0CzX6kPNCOzWBWG+CCaolGPIjky+ZD4u2+bM3puRG pEG4bnw1rp+MRk2ZP1EWR4GIKURGzi02LNoamyu+m4lv2L8HdZe0bKbSLyb5LkNU f3TtVj7+jyyi07ktRDhzN2KjR6O8A0qZTiXuawIDAQABAoIBABUlW9sJlz3QAyeU VvgOEUW6EjYSPOPgY5SULl2XyfpA7IetapiK8huJJXtA0Z88ZNbmyUIk6yTNL2KS cwZfrQiKxeVnXrsMq4B3ztY+zWxT+UZj1Ue/K8PT9E1SSiWmSkzsNitX/oWEwmpN 5VOjWJV6hmsfbhrAb1KZA1FQ+nBMEQrkEFpmFD1nJE8dH5rWNo4YbM/boR/kC93G CHOwd2TKNrBa8ZeMOjcyUK9fg15CMkj7uTzfIGkjCM/mXOxvsvTuZ0np7PL7aF+o GfSHP/l+B5rxT1GTYjZtpSEgAoqYEFJnnZELklo7KRWB7p2rgyHPElSjQN3xIn5Z apNPrBECgYEA26gZGBP+j1Hqrh3nAhOq/t6PMj+V8yz/i2TrraJ1z7GKRGoBUOX9 ruJGJExfACzgrKl1hL4XRfLdHuooScUqrIxLX7eKHE2nBSd0M40zEKbgIMRhaMsf lAFOkxJRHMT7edaVu3MkSfDgFXRbhr+jcdxspzhunHMJVUnC5LgAKHMCgYEAyJAw 6GF80Uud5oDHo2tGY9uYgMIUN9rmrrFjqstkVB6QMFlyyeI3MHUhiU7qH53yaRCi FxuHU6usQFmduwZAKInoPMRhYTYbexe4CYB+C96trwoV7ltDE+a7ZTsEj5kSYvCO KLcVTn4mcU0TSpE0MU1XQKP0Ev/mdZ5aYEopvCkCgYEAlkVa3YkYNq5g8btNRbN0 4SYbKtIrYJChRpjFTyV8mZkpMYKf4dtmANWWDNEekP0iu5y25BgzzcvHkJW6+DTl 6+OS0Sm8V36cS79hFL99dt/jJyeSSGHl+ZgnTCBU02zDaefuya2M3vTmKGdREk9a ntOglYnayjc85Fcw+M4UdZcCgYAFw/9j7smDysSzR6h1jjPr0vhDW1Dxeh1/kCHp Wwd7U5WZjji6jQJBJlzccaRRXF0HoC7Is0Xkpd7BytG5+qgFglFmzc5u2PtZQolL 3KHC/ZfInGWdAIqhG9TvSA8Ngb0BkyDDEuBN7Vp1j12qmxoBANQtS4lMsoaRgwfe FMO2YQKBgGv6Ndv+eHWSkqGFOSXU6dXAjOuAji3K1yRlxUg/RS/DCMK+8XQbuh47 +p998LwvI70JIr4v2PAkO3/HaRILOTRLLvq8O/yqHwrVf+P7AQ8kPm7uUf7kTXat DYcKIAp5ddZweyFCgwVm+JMd1E+cpL97RbHCbu7Ct6OD9uLGXCUh -----END RSA PRIVATE KEY----- node-v4.8.2/test/fixtures/keys/agent1-cert.pem000644 000766 000024 00000002026 13070706736 021401 0ustar00iojsstaff000000 000000 -----BEGIN CERTIFICATE----- MIIC1jCCAj+gAwIBAgIJAJqEq8+4pyrAMA0GCSqGSIb3DQEBCwUAMHoxCzAJBgNV BAYTAlVTMQswCQYDVQQIDAJDQTELMAkGA1UEBwwCU0YxDzANBgNVBAoMBkpveWVu dDEQMA4GA1UECwwHTm9kZS5qczEMMAoGA1UEAwwDY2ExMSAwHgYJKoZIhvcNAQkB FhFyeUB0aW55Y2xvdWRzLm9yZzAeFw0xNTA0MTgxMzI5MDhaFw00MjA5MDIxMzI5 MDhaMH0xCzAJBgNVBAYTAlVTMQswCQYDVQQIEwJDQTELMAkGA1UEBxMCU0YxDzAN BgNVBAoTBkpveWVudDEQMA4GA1UECxMHTm9kZS5qczEPMA0GA1UEAxMGYWdlbnQx MSAwHgYJKoZIhvcNAQkBFhFyeUB0aW55Y2xvdWRzLm9yZzCBnzANBgkqhkiG9w0B AQEFAAOBjQAwgYkCgYEAuOs3hW8rF+7xx5iB9wjmIgd+HTqRFUeKxG+mWV35Hl6A 3uzYGXwWznqsOomr4a/UkZrxbPGp5Awqa9g72NF97g3Sysq2DW4a3ycXWAeYYcHS lRxqJGXTjx+vG/0nDCXLBhoDKO00zEccdjGS8xEjjieQQr+KeASmIm0kQmuN5YcC AwEAAaNhMF8wXQYIKwYBBQUHAQEEUTBPMCMGCCsGAQUFBzABhhdodHRwOi8vb2Nz cC5ub2RlanMub3JnLzAoBggrBgEFBQcwAoYcaHR0cDovL2NhLm5vZGVqcy5vcmcv Y2EuY2VydDANBgkqhkiG9w0BAQsFAAOBgQA45MmH28Gns+1yu9w9MR/oR8hKDMnG E4yDZ+9SofWdqRsGe5MNeMbp9c+FxIxODcNmdhV5Ao6+ZCRX4N9GjLqUL1jQoFAs pT/U80ZU+4bz2EwGMBQt7CJZb/u+j8/vXheyGFZkCWEQj6AgZQFTniRRQJLwbiy5 uDktGqnhvamyrg== -----END CERTIFICATE----- node-v4.8.2/test/fixtures/keys/agent1-csr.pem000644 000766 000024 00000001331 13070706736 021231 0ustar00iojsstaff000000 000000 -----BEGIN CERTIFICATE REQUEST----- MIIB4jCCAUsCAQAwfTELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMQswCQYDVQQH EwJTRjEPMA0GA1UEChMGSm95ZW50MRAwDgYDVQQLEwdOb2RlLmpzMQ8wDQYDVQQD EwZhZ2VudDExIDAeBgkqhkiG9w0BCQEWEXJ5QHRpbnljbG91ZHMub3JnMIGfMA0G CSqGSIb3DQEBAQUAA4GNADCBiQKBgQC46zeFbysX7vHHmIH3COYiB34dOpEVR4rE b6ZZXfkeXoDe7NgZfBbOeqw6iavhr9SRmvFs8ankDCpr2DvY0X3uDdLKyrYNbhrf JxdYB5hhwdKVHGokZdOPH68b/ScMJcsGGgMo7TTMRxx2MZLzESOOJ5BCv4p4BKYi bSRCa43lhwIDAQABoCUwIwYJKoZIhvcNAQkHMRYTFEEgY2hhbGxlbmdlIHBhc3N3 b3JkMA0GCSqGSIb3DQEBBQUAA4GBAC1pwZvvfYfK8IXYyXLD3N47MEbn/Y8C85Qi rYVl7y/7ThurCLtWVlS3e7es3Kr8nxjHTjVZW20RZHOmOGfSOkXoL3uuwew1jvCq ibM2jwPCq1N/I4D94Fzh9LG86Cu8U6PtBlZzgprdK84Fo8U/pFRikPrggApUiPhm MZeWhDyn -----END CERTIFICATE REQUEST----- node-v4.8.2/test/fixtures/keys/agent1-key.pem000644 000766 000024 00000001573 13070706736 021242 0ustar00iojsstaff000000 000000 -----BEGIN RSA PRIVATE KEY----- MIICXgIBAAKBgQC46zeFbysX7vHHmIH3COYiB34dOpEVR4rEb6ZZXfkeXoDe7NgZ fBbOeqw6iavhr9SRmvFs8ankDCpr2DvY0X3uDdLKyrYNbhrfJxdYB5hhwdKVHGok ZdOPH68b/ScMJcsGGgMo7TTMRxx2MZLzESOOJ5BCv4p4BKYibSRCa43lhwIDAQAB AoGBAIXZzPCLDXhffydo3vo/uMT9A26IzCfJB0s1PgYGHaK76TBz4+Bej+uZpD0j FgVgzs8uhn7DVqQ5oiM5++fvi+Sd+KlyVNgLKe7UTBGYE5Nc9DuDDD0GmJtFvso6 amsVhECF8sWZVOAwUdrwHhWevp5gJ1cfs3YMTlT9YqdRaWOhAkEA8TJAPfnbEfWf saDhWCjanW+w2QEYPa6wYFt+I5L2XPTeKR/wEQ3EzM++vCWxSF5LNSaXIdic847p BcIGi/0r6QJBAMREt5r1c6Wf5mS6i/Jg6AdCEUjy0feRCeKemJDMKxyl5m/cU+rk p5YBUgwoI8kzc82GEhyg4/NgHQfNcrZdT+8CQFVzChNq21PHgyX46xzCjIDOOwcG PkJMCyx3/X446JMSJUrIh9Ji4F/3EYmyiNYsodRYsZ5KEYCwFpn1nUAnF1ECQQC/ uzl54YomJDyX7jzEfLJuVLY6AyvmowN7JN95pFoBVHf2ktBPySuFuKiEQ7oh1Wet QOn0mZ/VovD5LFSBnkp1AkEAgOMkBCJuOfBDvQwrmAAowWQi//7D2x0fhyKcrF6D EZYVV125Wodw3zFxmE9p4vb6Hg3X5jSyGMzdE5ZqMgBD7w== -----END RSA PRIVATE KEY----- node-v4.8.2/test/fixtures/keys/agent1-pfx.pem000644 000766 000024 00000004605 13070706736 021246 0ustar00iojsstaff000000 000000 0 0 G *H  8 40 00/ *H  00 *H 0 *H  0'#/*1&_}+, 3/ .")W8V0J.nIJ/aCmҮz붧0}n75*avT߉2U=.X.nKiKh?utPE 1,԰~ _vy|ohКGOt$bQb`exx m`lK0;w1 KَԷd7_'0/}=ˆOzl\2ď3䭚.O9#p,&J+^s:Yy3ݢkuϙ,#r+uDzwH,v|붎ډ`1[y_CzRކ-Vt1aݪ 1ĴV'w0IFHo;C17hBb2"r0@ ř [\%٪rrs>}e0@,'S?Qe/.1>(@ݰ/dmM~p|+LxսJ qK AJNwrJ$PF&K']%Uqq ~=XבD"b(kI@{ `ltEZ0Ge΅~D@+ClN lq$-gcK6j?oU ͱdM̙{o ˑI[l{ =iƉF3t v,Ta{}PJ8Ǻa"TxWO!<_܄ -N>=yƿǫ`Rk#PַNVNCjv " 7^"aPFNnK%qu/S@aE [^%w8,jA#_O:RJ^%;sCNdvGNiG%vl[A6;[nr  k< ]M>ن#'\Y]~t) 7GG 6k_*GȓXĢsς=$=m4 %ed 0;1/bb<{ib·p])\ R~NgfaU%ҨϤQ}_ ʐb׳^jlkd! p/TQ0l@R${JP@o#x^uO O0tc6BKe]VA\ɷ^]LgYnj7xhEmQ%qǿ+q9&QNuO6~|_1\k]Sx$>kF:A PHsX MƟoU`AӼ x&:խ7Hv̛-*QD =W9жdZ4rBHblR&eE$/V_J _v !i܁s1?l3uQ}{@cW (\>6&eThR:n&D5*g4/.cIHxj{&2FBs7|K+~@EP30 *H 00 *H  00 *H  0"1 DֱQUDu\S>4FS r(b2Օ".f8ۻ ζ/ arɎ75MBqWDrBQRڦTEh"Ŧ@986j*&4"w0Y M|>,Cj}(+Ze MysU) &n%l;9kx6j!eF,83\E)wb;NcJR;i0{w6NmP8ŒgTCe'G8ë-,t&~I,ʷ1Ṯ ~TC7$Z)/~?KN0d(`zc0m,?HnZERB62CI?ӘdF^=AXAwP M¥-yc Ko;ǮYH>OΆr]@Îywnv[AmV7eKøz_=L ܘ :/1{GDc)ܢz=d*.2rfomg}i:Ma}6٘%F. y1%0# *H  1:勅)rO}T͕ ca2-serial touch ca2-database.txt # # Create Subordinate Certificate Authority: ca3 # ('password' is used for the CA password.) # ca3-key.pem: openssl genrsa -out ca3-key.pem 1024 ca3-csr.pem: ca3.cnf ca3-key.pem openssl req -new \ -extensions v3_ca \ -config ca3.cnf \ -key ca3-key.pem \ -out ca3-csr.pem ca3-cert.pem: ca3-csr.pem ca3-key.pem ca3.cnf ca1-cert.pem ca1-key.pem openssl x509 -req \ -extfile ca3.cnf \ -extensions v3_ca \ -days 9999 \ -passin "pass:password" \ -in ca3-csr.pem \ -CA ca1-cert.pem \ -CAkey ca1-key.pem \ -CAcreateserial \ -out ca3-cert.pem # # Create Fake CNNIC Root Certificate Authority: fake-cnnic-root # fake-cnnic-root-key.pem: openssl genrsa -out fake-cnnic-root-key.pem 2048 fake-cnnic-root-cert.pem: fake-cnnic-root.cnf fake-cnnic-root-key.pem openssl req -x509 -new \ -key fake-cnnic-root-key.pem \ -days 1024 \ -out fake-cnnic-root-cert.pem \ -config fake-cnnic-root.cnf # # Create Fake StartCom Root Certificate Authority: fake-startcom-root # fake-startcom-root-key.pem: openssl genrsa -out fake-startcom-root-key.pem 2048 fake-startcom-root-cert.pem: fake-startcom-root.cnf \ fake-startcom-root-key.pem openssl req -new -x509 -days 9999 -config \ fake-startcom-root.cnf -key fake-startcom-root-key.pem -out \ fake-startcom-root-cert.pem echo '01' > fake-startcom-root-serial touch fake-startcom-root-database.txt # # agent1 is signed by ca1. # agent1-key.pem: openssl genrsa -out agent1-key.pem 1024 agent1-csr.pem: agent1.cnf agent1-key.pem openssl req -new -config agent1.cnf -key agent1-key.pem -out agent1-csr.pem agent1-cert.pem: agent1-csr.pem ca1-cert.pem ca1-key.pem openssl x509 -req \ -extfile agent1.cnf \ -extensions v3_ca \ -days 9999 \ -passin "pass:password" \ -in agent1-csr.pem \ -CA ca1-cert.pem \ -CAkey ca1-key.pem \ -CAcreateserial \ -out agent1-cert.pem agent1-pfx.pem: agent1-cert.pem agent1-key.pem ca1-cert.pem openssl pkcs12 -export \ -descert \ -in agent1-cert.pem \ -inkey agent1-key.pem \ -certfile ca1-cert.pem \ -out agent1-pfx.pem \ -password pass:sample agent1-verify: agent1-cert.pem ca1-cert.pem openssl verify -CAfile ca1-cert.pem agent1-cert.pem # # agent2 has a self signed cert # # Generate new private key agent2-key.pem: openssl genrsa -out agent2-key.pem 1024 # Create a Certificate Signing Request for the key agent2-csr.pem: agent2-key.pem agent2.cnf openssl req -new -config agent2.cnf -key agent2-key.pem -out agent2-csr.pem # Create a Certificate for the agent. agent2-cert.pem: agent2-csr.pem agent2-key.pem openssl x509 -req \ -days 9999 \ -in agent2-csr.pem \ -signkey agent2-key.pem \ -out agent2-cert.pem agent2-verify: agent2-cert.pem openssl verify -CAfile agent2-cert.pem agent2-cert.pem # # agent3 is signed by ca2. # agent3-key.pem: openssl genrsa -out agent3-key.pem 1024 agent3-csr.pem: agent3.cnf agent3-key.pem openssl req -new -config agent3.cnf -key agent3-key.pem -out agent3-csr.pem agent3-cert.pem: agent3-csr.pem ca2-cert.pem ca2-key.pem openssl x509 -req \ -days 9999 \ -passin "pass:password" \ -in agent3-csr.pem \ -CA ca2-cert.pem \ -CAkey ca2-key.pem \ -CAcreateserial \ -out agent3-cert.pem agent3-verify: agent3-cert.pem ca2-cert.pem openssl verify -CAfile ca2-cert.pem agent3-cert.pem # # agent4 is signed by ca2 (client cert) # agent4-key.pem: openssl genrsa -out agent4-key.pem 1024 agent4-csr.pem: agent4.cnf agent4-key.pem openssl req -new -config agent4.cnf -key agent4-key.pem -out agent4-csr.pem agent4-cert.pem: agent4-csr.pem ca2-cert.pem ca2-key.pem openssl x509 -req \ -days 9999 \ -passin "pass:password" \ -in agent4-csr.pem \ -CA ca2-cert.pem \ -CAkey ca2-key.pem \ -CAcreateserial \ -extfile agent4.cnf \ -extensions ext_key_usage \ -out agent4-cert.pem agent4-verify: agent4-cert.pem ca2-cert.pem openssl verify -CAfile ca2-cert.pem agent4-cert.pem # # Make CRL with agent4 being rejected # ca2-crl.pem: ca2-key.pem ca2-cert.pem ca2.cnf openssl ca -revoke agent4-cert.pem \ -keyfile ca2-key.pem \ -cert ca2-cert.pem \ -config ca2.cnf \ -passin 'pass:password' openssl ca \ -keyfile ca2-key.pem \ -cert ca2-cert.pem \ -config ca2.cnf \ -gencrl \ -out ca2-crl.pem \ -passin 'pass:password' # # agent5 is signed by ca2 (client cert) # agent5-key.pem: openssl genrsa -out agent5-key.pem 1024 agent5-csr.pem: agent5.cnf agent5-key.pem openssl req -new -config agent5.cnf -key agent5-key.pem -out agent5-csr.pem agent5-cert.pem: agent5-csr.pem ca2-cert.pem ca2-key.pem openssl x509 -req \ -days 9999 \ -passin "pass:password" \ -in agent5-csr.pem \ -CA ca2-cert.pem \ -CAkey ca2-key.pem \ -CAcreateserial \ -extfile agent5.cnf \ -extensions ext_key_usage \ -out agent5-cert.pem agent5-verify: agent5-cert.pem ca2-cert.pem openssl verify -CAfile ca2-cert.pem agent5-cert.pem # # agent6 is signed by ca3 # agent6-key.pem: openssl genrsa -out agent6-key.pem 1024 agent6-csr.pem: agent6.cnf agent6-key.pem openssl req -new -config agent6.cnf -key agent6-key.pem -out agent6-csr.pem agent6-cert.pem: agent6-csr.pem ca3-cert.pem ca3-key.pem openssl x509 -req \ -days 9999 \ -passin "pass:password" \ -in agent6-csr.pem \ -CA ca3-cert.pem \ -CAkey ca3-key.pem \ -CAcreateserial \ -extfile agent6.cnf \ -out agent6-cert.pem cat ca3-cert.pem >> agent6-cert.pem agent6-verify: agent6-cert.pem ca3-cert.pem openssl verify -CAfile ca3-cert.pem agent6-cert.pem # # agent7 is signed by fake-cnnic-root. # agent7-key.pem: openssl genrsa -out agent7-key.pem 2048 agent7-csr.pem: agent1.cnf agent7-key.pem openssl req -new -config agent7.cnf -key agent7-key.pem -out agent7-csr.pem agent7-cert.pem: agent7-csr.pem fake-cnnic-root-cert.pem fake-cnnic-root-key.pem openssl x509 -req \ -extfile agent7.cnf \ -days 9999 \ -passin "pass:password" \ -in agent7-csr.pem \ -CA fake-cnnic-root-cert.pem \ -CAkey fake-cnnic-root-key.pem \ -CAcreateserial \ -out agent7-cert.pem agent7-verify: agent7-cert.pem fake-cnnic-root-cert.pem openssl verify -CAfile fake-cnnic-root-cert.pem agent7-cert.pem # # agent8 is signed by fake-startcom-root with notBefore # of Oct 20 23:59:59 2016 GMT # agent8-key.pem: openssl genrsa -out agent8-key.pem 2048 agent8-csr.pem: agent8.cnf agent8-key.pem openssl req -new -config agent8.cnf -key agent8-key.pem \ -out agent8-csr.pem agent8-cert.pem: agent8-csr.pem openssl ca \ -config fake-startcom-root.cnf \ -keyfile fake-startcom-root-key.pem \ -cert fake-startcom-root-cert.pem \ -batch \ -days 9999 \ -passin "pass:password" \ -in agent8-csr.pem \ -startdate 20161020235959Z \ -notext -out agent8-cert.pem agent8-verify: agent8-cert.pem fake-startcom-root-cert.pem openssl verify -CAfile fake-startcom-root-cert.pem \ agent8-cert.pem # # agent9 is signed by fake-startcom-root with notBefore # of Oct 21 00:00:01 2016 GMT # agent9-key.pem: openssl genrsa -out agent9-key.pem 2048 agent9-csr.pem: agent9.cnf agent9-key.pem openssl req -new -config agent9.cnf -key agent9-key.pem \ -out agent9-csr.pem agent9-cert.pem: agent9-csr.pem openssl ca \ -config fake-startcom-root.cnf \ -keyfile fake-startcom-root-key.pem \ -cert fake-startcom-root-cert.pem \ -batch \ -days 9999 \ -passin "pass:password" \ -in agent9-csr.pem \ -startdate 20161021000001Z \ -notext -out agent9-cert.pem ec-key.pem: openssl ecparam -genkey -out ec-key.pem -name prime256v1 ec-csr.pem: ec-key.pem openssl req -new -config ec.cnf -key ec-key.pem -out ec-csr.pem ec-cert.pem: ec-csr.pem ec-key.pem openssl x509 -req \ -days 9999 \ -in ec-csr.pem \ -signkey ec-key.pem \ -out ec-cert.pem dh512.pem: openssl dhparam -out dh512.pem 512 dh1024.pem: openssl dhparam -out dh1024.pem 1024 dh2048.pem: openssl dhparam -out dh2048.pem 2048 dsa1025.pem: openssl dsaparam -out dsa1025.pem 1025 dsa_private_1025.pem: openssl gendsa -out dsa_private_1025.pem dsa1025.pem dsa_public_1025.pem: openssl dsa -in dsa_private_1025.pem -pubout -out dsa_public_1025.pem rsa_private_1024.pem: openssl genrsa -out rsa_private_1024.pem 1024 rsa_private_2048.pem: openssl genrsa -out rsa_private_2048.pem 2048 rsa_private_4096.pem: openssl genrsa -out rsa_private_4096.pem 4096 rsa_public_1024.pem: rsa_private_1024.pem openssl rsa -in rsa_private_1024.pem -out rsa_public_1024.pem rsa_public_2048.pem: rsa_private_2048.pem openssl rsa -in rsa_private_2048.pem -out rsa_public_2048.pem rsa_public_4096.pem: rsa_private_4096.pem openssl rsa -in rsa_private_4096.pem -out rsa_public_4096.pem clean: rm -f *.pem *.srl ca2-database.txt ca2-serial test: agent1-verify agent2-verify agent3-verify agent4-verify agent5-verify .PHONY: all clean test agent1-verify agent2-verify agent3-verify agent4-verify agent5-verify node-v4.8.2/test/fixtures/keys/rsa_private_1024.pem000644 000766 000024 00000001567 13070706736 022265 0ustar00iojsstaff000000 000000 -----BEGIN RSA PRIVATE KEY----- MIICXQIBAAKBgQDOF+YjZgVg8yGFS+++0WVcTKms1Wl2Lbnzj7jWOPyZnXxww7cE afiL3QI2RZCiVwBcueUejCbzT5iLrsWceryOCHZE4nQ5IOEYCpPzWw6oTfSM7HV0 axQEpSzJFp20NJV9pVvBmSrrrdlGaDwHY1nlGVB3s2CKTAVxcKWoD6FhVQIDAQAB AoGBAIoz5JRgWcMFx7jHj2H6sWoPzsij5DDnwQbfniep11p8DXLhC93d4lqIPm9+ ftseVJPZ5RdzDLuk6Lri3IlulPnEeJZrfYQVlfge6N9swQ54j3wRGEBjcP+7pu7Q nQ5FpOyJqQWWMUinf+o1bEkClIBPTY4x8pIoCM09wSvD9weRAkEA/hWym3rDwrcu pKvb1VgWZtrrCv5m+2Dk5V7qA+9sUyI9Lq9dlklNMcbuJXCy8Evd2Q3EMySYQGVc cXEKkeKefwJBAM+ll95tMX/YDEYAtOf3stz59rC4EyuD2kOZJt0dPj3vApYYq9+0 Wnd0c8VOzJGjpVI21SY+fA+doMiZVVjSPisCQCD0R3oK7iDvCUmqUJTXG/CzLBD8 9fZcltN4//kKsI4Hvs+zRvwa/bwbBQAuIccwz9E7C9tmP6j6fIbqFmjdb5kCQCJI MJ6kYHu+66fTDgsONhWNn1Dl0yRoDG0EqAnxfgkzoLWvNREl8ZmvPD3jGJsi7XR5 YQ+DWXAqkhUMW67iZykCQQCgZdOUkAWu7NsCfGSTTvrMapa5PAt/GPDzzY9JGGif p+09SVdrnphr+MX6MCnOsixPXrMtg/LLhpQkwjVetm15 -----END RSA PRIVATE KEY----- node-v4.8.2/test/fixtures/keys/rsa_private_2048.pem000644 000766 000024 00000003213 13070706736 022262 0ustar00iojsstaff000000 000000 -----BEGIN RSA PRIVATE KEY----- MIIEowIBAAKCAQEA20oG4U+MsV45A4zG0ySoavFmWmdkVtmKh1Tk9sC3V6Fu5w1v 44lZDa57n+ghEA9Y4txUVQzm3TppwBFqUB2bBZrAhAjmjiPxjECGTV7ABaAQyihJ R0F2LL1KmdlduFXACvNCfIseBoOY6K49vrW3/rVC1gBQ6/S3K6jECjGAvOyUcIAv ch0YpW68v12AOUMI+CpzRQdMv6akbOVt5Qtg1vIvv0lIuirYcq9MWS++oFvHrxzX qAiAfgc0truwbW5Lz2w7Wcy0pBYeVW6HvBFPwUEV/2rn+RHrbgE9yQ+p4gDkdfHV yuMx21Mf449UwQUuI3HZ4BPqmyWkwSEYsfVYMQIDAQABAoIBAA9GT8Zf+SfdrVD+ /FZ2xjh0yjFf5FBcZNbaZfx+Hgc/mm8Ds5iA17ApSDkyPSNWPlXHDSTDek1MpVMY o3QjK8ovJlvMFustu8SONgyrneqGZMUAG2KYP7gME2c2Cd4uMutQWIA+XIANqJgE kw52r/NRAu/PI9PbvuqOneEr45DFNNfu7RUsyewfrd07+xeDzqyMZFizjgZS8pyF eu9jVo/4T64tT24+oTVn1O3sSn4DL0oh3IvTyv7jVDHP5QqjvY7scSSva5VPqXQI 9kkdzm0ECUqEAxwwn8EmyogrMJJYIKBmuFYxl3rYAY19hNVsMafmnlHxjSgv3n8h LjnnPLECgYEA/bZy7NtfPrHWBQvSpUPyge7ykfOwOoNYHY0OJcw/MGjNbk6d6ZOv 3/gpGNO90iJkBI5cMXOgtOe0Nj1dkkSy9C81jd3JzR9mrK9Id8sJcUw2XpN1IKcE w89tcf1tmvP/st6dY3RDHARIPjNvQfcWkzT0uDJmf8cihS3MeWcPi2UCgYEA3UQh gPFfTAVW/mvwOkO37SK6/5hXbE4V1bHoP3fWAXmXO3C53K4FAuhErq8nw6ZOf9DG jjhskmeXoUNb06gLBO2okfFL9ccDS4hKm5LQJvolrFfd6PTc/HOIxCvEj7aA4w0T d0c1KUZjS7SNL0e3I4jNbJF6GXjwTHBMo5se2t0CgYEA2F7Hpi30DVC2l/kcPOs0 nxD79/LeIRiwhgssvJlybkOCpwcO7wuPmy9VRSIXKWVA7Q3HnDjjHkTYUMWGzl4e S9cTEhjKqE+WTcDyyY7zT5dSatfQtPcbPi7hRKx/0/0w3QezLAUT0onoXnuY76Xc r9AiwA/jkCdwzilfz01QWW0CgYAUHmjJd6kJmYaydZAPTC8CIeFM8kYos+TqXFXY x4Wu9qZYokRUG4KbJBFyrLx53rpOhuY28kx093RjFmPYF/SAizeDpaQZgfH7wTW/ dZb1pFMem5Ky5ujdD4hFBhHGW3rWqk61zsS3rw3CSXV48hVl5r9++q9Wd5ep66Ac VDN3BQKBgGMkPiQ5YuhVG3zEYM/4zgW7zCEuDyocqXkv5nJGW3JxPDBuJhLbwQ8F RqawaRhuIQZtKnbN7JIGLFYYx+LkUlj7bbkzz6iaHHBtiDqz4/bHEL3q02DpAyJR koWbtKIbZfS0Zno3OoGdYyvwXYaaE3Q3DJOc+NUmMKhlAhcAkjQv -----END RSA PRIVATE KEY----- node-v4.8.2/test/fixtures/keys/rsa_private_4096.pem000644 000766 000024 00000006253 13070706736 022276 0ustar00iojsstaff000000 000000 -----BEGIN RSA PRIVATE KEY----- MIIJKQIBAAKCAgEArAvNBLD//h69aKy5t49I5CFdtwVuAym9qXa3IMZ7vCauW5/8 V7xkTZeX/Yywykyxm59R3e1xQT9Wcsur0OhQby449szXEJq/ZRVIos7p/CpgzlGO eWOhbwm6J973uJvMudvq1UPJA90vX1LGcgZfL/SOFkqRs+bVyrkjScDrDP7wCMQA CkJTh8ScwVqURnRb61mx+sck8kuuauNAaKgXIzQZWYHGIihKVc+iWCYhAXE0Lq8B yX125IbHIVVPKUdr5EfnNxLD9c1fO7rWNZfNlkZnEr2PZxa+T8YjD8FCJTYxLFLQ 7bH94Gh0UtydgqO2yYwr5TV7FSFa+HwqkvdBNo9c7g9608lNWXa+CZOU/HsTTcyj WIzqnXwZf5eUc8G7oHmNMTx8xOQ9gbnS1TjgDtztvh+RGeEsMQT5UEU7Do1eeCyl 8lQ56BdZJ4eoUefAW7YqGkuYi0Qn5deX9ei1ozlefewPC/6q/sPNZHbPcdJ5yeya N+TV4qzKlDGH3lw8g1mT3BOJhCcdxLuYuc3vKplBGx6fAW0klT39eeK4FtCEWH1r xUzQEltngS9INYos6238KS8u3GFZFf3ggJemtxg/1oTv4L2ZGS7/j4rGef1IP2ij Ith28ZnsYCJyajxQRB2ViUSirdFEQ0s7vAnxtMzAtDKcMsQDfbWWeEKGbZMCAwEA AQKCAgEAgCB9u7uxuefcuWLBIKH17+elalMB3hss41LFCQSoS7Qm75eTDyf/LwXx rGMlmlNJhhM9neBiEux/jhh+SaNpm5M52xssI3KLjVUvdghQm3pYA+8bAu4e4JnG 6ECWDgcBjXzpQ5Aq2NTVndEAdxSluQoQ8yrvnaIQn9wHGrswkcoeqviE6x8AJEFZ WGoDuQCZIAn5kUDUFBomt/WsFwTvzkjThCQwkWmeCpAKYEltFSzgZs/wrcThUUnK bNmijaRiBm1CFXLFO36KKOp48wqtkfe2dW90p5p5euGdZPNRNnNIZbD7ZbnDz2cb Eka4iv0veKQKYLXWhyMDI8Ec17yJ9EYDe12jogMyb7839VxklDyVV0aPY8C0YDst l92qU7v+0S1dpFA22rmEKThTTYmAWoCfY8tsQSgQGb6y2WVFo46iZOsoC6lZQOqJ yhxwDfLjsRyAJHCkHFuigcj7jukt5/zzhC7+JkKg+iWrv63a3TvFiu8jWYgddy38 e2rM7mXS18oe0PAKWiYU+JcEHdousGFkfcHyVzsiCku1MiWKZNVsQDKU2sYQdgo+ B6XR0yiVCucFBLT2jEht+MsrbNpdXQ2/cNYbabQFLGKSST1qfJNepvGiCqUsCakA nickA91dTBF4yH3M6hREQolkpw+6SD0bd9Kf2P0QmWOSrefPKMkCggEBAN1Bnzrk 6eJUHiJNlQ5QHXty7HYlFueO7dPHjRLiwd4EnRabjwx2rxtWjYwLP4MOsV3J9a5f dX7GVarQxbQys64pFKP3fqktjhxEBsPw/+kJH1E5SRfmZKtKOqsJan/AHSGpeBWg Hp4kjpHW2qxsoXZr2IJuICmf5aVui2kUB6C9CgE1IFIf4dAphIOPg+OJJck2z6Do lJhlG2L6JOdcuNTOy4Ecf1C8EYAGbOe+4gXSIVYx/yG+Tat+CKqZbQqr9B8jDPy7 4BLhI97uHYP5K0tl/DNVcMD73WeWEEvbw7V7bJ94sH78SUK6w2FMijne3UbEcB60 tSI59wwHIJ1mW9UCggEBAMcP9JecWe8ss+QzKvSdBeP15dtpiqx0Q+ijFZYHQGy8 fP6MJD8/4w/uvS+mP1LaWaLm2mcMrog1dKMxps+fcUBkFAZpwc7uRj/n2ovoJo4R TOT/6xUn33a4fnuZcyW2RDQrfolNOHkXmVRYdUYMS3G1JkGMDJfpOrWW41THhixn XTSFgrBlVl3cgKZ+v/YM5phM+cZLYZU8/tOdYfxoiSWDOGMwEBiwbyNE1FTUlXDv oORXJ8Kt4ei3b7KElgu+QFpBWR15OU09fLUHTArydB6oE5H9mHUic9Yi71AiKTPM wxBhM6V+vXdjc89QcUhHtpJBXwLX8N+lOiqLBJHdX8cCggEBAKSJ5YEltSzkA1jd OyjeuV4Rs/mUUXk4WHLy5l2SFjwmUC/81R+er0/0SOVJhBzRc2NdCoB3augxVIno Ie6E+gxdboUVS7NCNnmcuS9D7Pv/FbQQluPYKSsc045YPUPtuXxMDAqA/eP7Ka8Z CZvKWTS4tNUiUnbB+0TQdYpaI+YMTwFg4b1RClwEVBCGTL2MQ3ZkdXmjHMZMAlbT 0VfhI27Wro5AhAmlIpqDrL+Wu306rCHuol4UqKwM2SMNYALcp3n0VfcpPFSt60Ag 8gAv71tt52TBeE17wEYFWe8f6mXu+HOLjC2TLmQagau9ANpSe1niQcMD/eQLGUZv knibI1UCggEAaVWJERzb/hLCkjN9PHlGn60D14nOppjTQmvhxUTLE37eCXgwygNN bKXhGDC5e2ctXWUZFsSAKnVW5fAlG+J79B3A9u/JbW1qYPCYFcZfeHexH9BIHia+ Ob1AuLinVMJQ7uZBC/h/tJwHN7mjPNDOrzmzJ6YrF8uDlIlme/skhaSgjmVDlYHa JMrEjNWvUEzdTKQW25YR6f2fvmyeaAkM4XvBP8M0EUxzUs9eKBFhjqROl+WClaKb UyCWC3nbSBWBSgEgXddCuhuaPNTCqVxIk9xOlscBgKIdd6d+yQF6mf11DtrQkHcz XNSUeJRRjXTdKCFNXFzWChINaGutnF3vCwKCAQBvmjBndvF1cQW6GdYMNBpZE+gr jsWMRQqs3TQnUI2bzhOGj/2JzWcghCuYB3pIlEGYrhaGLYa0bBwMcoE95lg/Gleg YxQakN4Qv7Xy6zN8pT/8GNAaqBuO+4AOAITrM4xGAYYkfvQbG83PZpoUl1h82+tS 4imnGk+gzqzz52PkAYV/LkcWlBFSoqSeI2lQvaLLrijhacHKokJui3YAmqIMR6X2 AeVV3juiLWJsCk9Jd5eLTPy4XlcNzB5MTenmUWXUFjqhSeNPMNHDE82xuZ362OKD FvtYiLTGh2vWw/0zRHbV4S5dO5RkNLVxiu7akOoV6uBgYdNCJxYHNBVWusyA -----END RSA PRIVATE KEY----- node-v4.8.2/test/fixtures/keys/rsa_public_1024.pem000644 000766 000024 00000000420 13070706736 022054 0ustar00iojsstaff000000 000000 -----BEGIN PUBLIC KEY----- MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDOF+YjZgVg8yGFS+++0WVcTKms 1Wl2Lbnzj7jWOPyZnXxww7cEafiL3QI2RZCiVwBcueUejCbzT5iLrsWceryOCHZE 4nQ5IOEYCpPzWw6oTfSM7HV0axQEpSzJFp20NJV9pVvBmSrrrdlGaDwHY1nlGVB3 s2CKTAVxcKWoD6FhVQIDAQAB -----END PUBLIC KEY----- node-v4.8.2/test/fixtures/keys/rsa_public_2048.pem000644 000766 000024 00000000703 13070706736 022067 0ustar00iojsstaff000000 000000 -----BEGIN PUBLIC KEY----- MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA20oG4U+MsV45A4zG0ySo avFmWmdkVtmKh1Tk9sC3V6Fu5w1v44lZDa57n+ghEA9Y4txUVQzm3TppwBFqUB2b BZrAhAjmjiPxjECGTV7ABaAQyihJR0F2LL1KmdlduFXACvNCfIseBoOY6K49vrW3 /rVC1gBQ6/S3K6jECjGAvOyUcIAvch0YpW68v12AOUMI+CpzRQdMv6akbOVt5Qtg 1vIvv0lIuirYcq9MWS++oFvHrxzXqAiAfgc0truwbW5Lz2w7Wcy0pBYeVW6HvBFP wUEV/2rn+RHrbgE9yQ+p4gDkdfHVyuMx21Mf449UwQUuI3HZ4BPqmyWkwSEYsfVY MQIDAQAB -----END PUBLIC KEY----- node-v4.8.2/test/fixtures/keys/rsa_public_4096.pem000644 000766 000024 00000006253 13070706736 022102 0ustar00iojsstaff000000 000000 -----BEGIN RSA PRIVATE KEY----- MIIJKQIBAAKCAgEArAvNBLD//h69aKy5t49I5CFdtwVuAym9qXa3IMZ7vCauW5/8 V7xkTZeX/Yywykyxm59R3e1xQT9Wcsur0OhQby449szXEJq/ZRVIos7p/CpgzlGO eWOhbwm6J973uJvMudvq1UPJA90vX1LGcgZfL/SOFkqRs+bVyrkjScDrDP7wCMQA CkJTh8ScwVqURnRb61mx+sck8kuuauNAaKgXIzQZWYHGIihKVc+iWCYhAXE0Lq8B yX125IbHIVVPKUdr5EfnNxLD9c1fO7rWNZfNlkZnEr2PZxa+T8YjD8FCJTYxLFLQ 7bH94Gh0UtydgqO2yYwr5TV7FSFa+HwqkvdBNo9c7g9608lNWXa+CZOU/HsTTcyj WIzqnXwZf5eUc8G7oHmNMTx8xOQ9gbnS1TjgDtztvh+RGeEsMQT5UEU7Do1eeCyl 8lQ56BdZJ4eoUefAW7YqGkuYi0Qn5deX9ei1ozlefewPC/6q/sPNZHbPcdJ5yeya N+TV4qzKlDGH3lw8g1mT3BOJhCcdxLuYuc3vKplBGx6fAW0klT39eeK4FtCEWH1r xUzQEltngS9INYos6238KS8u3GFZFf3ggJemtxg/1oTv4L2ZGS7/j4rGef1IP2ij Ith28ZnsYCJyajxQRB2ViUSirdFEQ0s7vAnxtMzAtDKcMsQDfbWWeEKGbZMCAwEA AQKCAgEAgCB9u7uxuefcuWLBIKH17+elalMB3hss41LFCQSoS7Qm75eTDyf/LwXx rGMlmlNJhhM9neBiEux/jhh+SaNpm5M52xssI3KLjVUvdghQm3pYA+8bAu4e4JnG 6ECWDgcBjXzpQ5Aq2NTVndEAdxSluQoQ8yrvnaIQn9wHGrswkcoeqviE6x8AJEFZ WGoDuQCZIAn5kUDUFBomt/WsFwTvzkjThCQwkWmeCpAKYEltFSzgZs/wrcThUUnK bNmijaRiBm1CFXLFO36KKOp48wqtkfe2dW90p5p5euGdZPNRNnNIZbD7ZbnDz2cb Eka4iv0veKQKYLXWhyMDI8Ec17yJ9EYDe12jogMyb7839VxklDyVV0aPY8C0YDst l92qU7v+0S1dpFA22rmEKThTTYmAWoCfY8tsQSgQGb6y2WVFo46iZOsoC6lZQOqJ yhxwDfLjsRyAJHCkHFuigcj7jukt5/zzhC7+JkKg+iWrv63a3TvFiu8jWYgddy38 e2rM7mXS18oe0PAKWiYU+JcEHdousGFkfcHyVzsiCku1MiWKZNVsQDKU2sYQdgo+ B6XR0yiVCucFBLT2jEht+MsrbNpdXQ2/cNYbabQFLGKSST1qfJNepvGiCqUsCakA nickA91dTBF4yH3M6hREQolkpw+6SD0bd9Kf2P0QmWOSrefPKMkCggEBAN1Bnzrk 6eJUHiJNlQ5QHXty7HYlFueO7dPHjRLiwd4EnRabjwx2rxtWjYwLP4MOsV3J9a5f dX7GVarQxbQys64pFKP3fqktjhxEBsPw/+kJH1E5SRfmZKtKOqsJan/AHSGpeBWg Hp4kjpHW2qxsoXZr2IJuICmf5aVui2kUB6C9CgE1IFIf4dAphIOPg+OJJck2z6Do lJhlG2L6JOdcuNTOy4Ecf1C8EYAGbOe+4gXSIVYx/yG+Tat+CKqZbQqr9B8jDPy7 4BLhI97uHYP5K0tl/DNVcMD73WeWEEvbw7V7bJ94sH78SUK6w2FMijne3UbEcB60 tSI59wwHIJ1mW9UCggEBAMcP9JecWe8ss+QzKvSdBeP15dtpiqx0Q+ijFZYHQGy8 fP6MJD8/4w/uvS+mP1LaWaLm2mcMrog1dKMxps+fcUBkFAZpwc7uRj/n2ovoJo4R TOT/6xUn33a4fnuZcyW2RDQrfolNOHkXmVRYdUYMS3G1JkGMDJfpOrWW41THhixn XTSFgrBlVl3cgKZ+v/YM5phM+cZLYZU8/tOdYfxoiSWDOGMwEBiwbyNE1FTUlXDv oORXJ8Kt4ei3b7KElgu+QFpBWR15OU09fLUHTArydB6oE5H9mHUic9Yi71AiKTPM wxBhM6V+vXdjc89QcUhHtpJBXwLX8N+lOiqLBJHdX8cCggEBAKSJ5YEltSzkA1jd OyjeuV4Rs/mUUXk4WHLy5l2SFjwmUC/81R+er0/0SOVJhBzRc2NdCoB3augxVIno Ie6E+gxdboUVS7NCNnmcuS9D7Pv/FbQQluPYKSsc045YPUPtuXxMDAqA/eP7Ka8Z CZvKWTS4tNUiUnbB+0TQdYpaI+YMTwFg4b1RClwEVBCGTL2MQ3ZkdXmjHMZMAlbT 0VfhI27Wro5AhAmlIpqDrL+Wu306rCHuol4UqKwM2SMNYALcp3n0VfcpPFSt60Ag 8gAv71tt52TBeE17wEYFWe8f6mXu+HOLjC2TLmQagau9ANpSe1niQcMD/eQLGUZv knibI1UCggEAaVWJERzb/hLCkjN9PHlGn60D14nOppjTQmvhxUTLE37eCXgwygNN bKXhGDC5e2ctXWUZFsSAKnVW5fAlG+J79B3A9u/JbW1qYPCYFcZfeHexH9BIHia+ Ob1AuLinVMJQ7uZBC/h/tJwHN7mjPNDOrzmzJ6YrF8uDlIlme/skhaSgjmVDlYHa JMrEjNWvUEzdTKQW25YR6f2fvmyeaAkM4XvBP8M0EUxzUs9eKBFhjqROl+WClaKb UyCWC3nbSBWBSgEgXddCuhuaPNTCqVxIk9xOlscBgKIdd6d+yQF6mf11DtrQkHcz XNSUeJRRjXTdKCFNXFzWChINaGutnF3vCwKCAQBvmjBndvF1cQW6GdYMNBpZE+gr jsWMRQqs3TQnUI2bzhOGj/2JzWcghCuYB3pIlEGYrhaGLYa0bBwMcoE95lg/Gleg YxQakN4Qv7Xy6zN8pT/8GNAaqBuO+4AOAITrM4xGAYYkfvQbG83PZpoUl1h82+tS 4imnGk+gzqzz52PkAYV/LkcWlBFSoqSeI2lQvaLLrijhacHKokJui3YAmqIMR6X2 AeVV3juiLWJsCk9Jd5eLTPy4XlcNzB5MTenmUWXUFjqhSeNPMNHDE82xuZ362OKD FvtYiLTGh2vWw/0zRHbV4S5dO5RkNLVxiu7akOoV6uBgYdNCJxYHNBVWusyA -----END RSA PRIVATE KEY----- node-v4.8.2/test/fixtures/keys/fake-startcom-root-issued-certs/01.pem000644 000766 000024 00000002270 13070706736 025641 0ustar00iojsstaff000000 000000 -----BEGIN CERTIFICATE----- MIIDUDCCAjgCAQEwDQYJKoZIhvcNAQELBQAwfTELMAkGA1UEBhMCSUwxFjAUBgNV BAoTDVN0YXJ0Q29tIEx0ZC4xKzApBgNVBAsTIlNlY3VyZSBEaWdpdGFsIENlcnRp ZmljYXRlIFNpZ25pbmcxKTAnBgNVBAMTIFN0YXJ0Q29tIENlcnRpZmljYXRpb24g QXV0aG9yaXR5MCAYDzIwMTYxMDIwMjM1OTU5WhcNNDQwMzIxMTAwNjM5WjBdMQsw CQYDVQQGEwJVUzELMAkGA1UECBMCQ0ExCzAJBgNVBAcTAlNGMQ8wDQYDVQQKEwZO T0RFSlMxDzANBgNVBAsTBmFnZW50ODESMBAGA1UEAxMJbG9jYWxob3N0MIIBIjAN BgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAzkVSP6XxWpBlSjqqavwOhpp36aFJ qLK7fRpxR+f0PdQ9WJajDEicxwKWGFqQBE+d5BjqrAD59L2QGZQ2VOF9VLZyFz3F 9TIlkd4yt9Od0qE98yIouDBNWu7UZqvNynAe5caD5i1MgyIUQqIUOnZwM21hwqYN N/OESf38A8Tfuvh3ALUn7zBEVyUPWIWTYPhFHSCWIsS2URZ/qDLk8GavphkqXdFB ii3V8Th5niPtpIsRF6Qhwh8SK+s0zh53o0qkmCNpXLd/PJQQAwC70WRq7ncL4D+U C1gnDL0j9SzojXQu31kXs8UZTa7RFnx5r+gDiA/gGrLs4IiwDJhVHMx0nQIDAQAB MA0GCSqGSIb3DQEBCwUAA4IBAQA7iMlm+rgZnlps+LFsoXG4dGNPaOhKI9t/XBrO 6O64LLyx/FPIQSaYi130QNB7Zy0uw8xqrH6cGRTJ9RCfBFFP4rzgIX3wEAHnmwMr i4dGEixBUIIjhw6fAVxAhrkzmgUpUt0qIP9otGgESEYXIg7bFkXIHit0Im1VOdvf +LnUKZw9o7UEesKIDVkuAsjoKKkrsO0kdf0dgAj6Ix5xmAtBsDvkH0aOSdPfTZG6 LQrnZf/quBotog3NmDzrvQaH8GNpTJcYNjKlxD2z0PvQUyp0FD8oCC+oD+EGv2zZ 65scEXU/n8kTmdJkCjx4nb39HttYzOlNlTgMxAfxgL7A/PcT -----END CERTIFICATE----- node-v4.8.2/test/fixtures/keys/fake-startcom-root-issued-certs/02.pem000644 000766 000024 00000002270 13070706736 025642 0ustar00iojsstaff000000 000000 -----BEGIN CERTIFICATE----- MIIDUDCCAjgCAQIwDQYJKoZIhvcNAQELBQAwfTELMAkGA1UEBhMCSUwxFjAUBgNV BAoTDVN0YXJ0Q29tIEx0ZC4xKzApBgNVBAsTIlNlY3VyZSBEaWdpdGFsIENlcnRp ZmljYXRlIFNpZ25pbmcxKTAnBgNVBAMTIFN0YXJ0Q29tIENlcnRpZmljYXRpb24g QXV0aG9yaXR5MCAYDzIwMTYxMDIxMDAwMDAxWhcNNDQwMzIxMTAwNzAyWjBdMQsw CQYDVQQGEwJVUzELMAkGA1UECBMCQ0ExCzAJBgNVBAcTAlNGMQ8wDQYDVQQKEwZO T0RFSlMxDzANBgNVBAsTBmFnZW50OTESMBAGA1UEAxMJbG9jYWxob3N0MIIBIjAN BgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEApT6nASSx9e2i/t0aHSd9BxMRD92o 33/iaiXWzBOKMJp7jxCWAg6SnpjrFsyjTxaAqg+e1zlm10YBT6DholstffzQqK2x TKGVOQK4jxX23wJlrn5mDk0fagBtY49L1KFy8DxJqKgt7uxz61GGUWwKWXG7Vnga bkqDd9o3ZF7bOq7mMQvfDzPrwYI8uTjTxR8R19uxNNOGtHMTnwvDeczTmtTox8U+ 4N2hN2scDZvRBx5aQAtnXRyZhAokAJMYojinx9iqlVFQi3ct52LIhsca6ympfDc2 0yA4aSVfoW7NlqsnvrTOV4nt3UbrxGGpiE7Em8Hdcw2EMF+jqCTLGtsqYQIDAQAB MA0GCSqGSIb3DQEBCwUAA4IBAQCMjKFycVQh7Puz/FpQh3NhJ99Ic3rzr+3nAKFD 4Kcl3L8szH3zjLCw46/y2jqPiAbg2zg9miYkI/2W/G+m2VQEQvp2SwjVr/Rj2Soe iTonruUpDFF7LG01q3kpZ7nYWRGvVgn5D9BGk4/SWuzxiWRdwlzJf2e8cXLExVS0 0CgRsb5nRoZ+RZmVIrGMfIi8CI7uTlcHtQzD7B7gpHtOSMlQoSSeqOy6F498duvl QhhQhJBxmjSegw/lawWQSDFArJimK/rwyb6ZFbRfBgg6o/k5W9G5l0oG5abQMp+/ u8Fd+QUNwR6OovE0AqL6wNHCnqzNnihTL6/hRVer6i5Hfxmb -----END CERTIFICATE----- node-v4.8.2/test/fixtures/json-with-directory-name-module/module-stub/000755 000766 000024 00000000000 13070706736 026176 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/json-with-directory-name-module/module-stub.json000644 000766 000024 00000000031 13070706736 027063 0ustar00iojsstaff000000 000000 {"rocko": "artischocko"} node-v4.8.2/test/fixtures/json-with-directory-name-module/module-stub/index.js000644 000766 000024 00000000053 13070706736 027641 0ustar00iojsstaff000000 000000 module.exports = "hello from module-stub!" node-v4.8.2/test/fixtures/json-with-directory-name-module/module-stub/one/000755 000766 000024 00000000000 13070706736 026757 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/json-with-directory-name-module/module-stub/one-trailing-slash/000755 000766 000024 00000000000 13070706736 031676 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/json-with-directory-name-module/module-stub/package.json000644 000766 000024 00000000246 13070706736 030466 0ustar00iojsstaff000000 000000 { "version": "1.1.12", "name": "module-stub", "main": "./index.js", "description": "A stub for node tests", "author": "Robert Kowalski " } node-v4.8.2/test/fixtures/json-with-directory-name-module/module-stub/one-trailing-slash/two/000755 000766 000024 00000000000 13070706736 032507 5ustar00iojsstaff000000 000000 test/fixtures/json-with-directory-name-module/module-stub/one-trailing-slash/two/three.js000644 000766 000024 00000000044 13070706736 034073 0ustar00iojsstaff000000 000000 node-v4.8.2module.exports = require('../../'); node-v4.8.2/test/fixtures/json-with-directory-name-module/module-stub/one/two/000755 000766 000024 00000000000 13070706736 027570 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/json-with-directory-name-module/module-stub/one/two/three.js000644 000766 000024 00000000043 13070706736 031232 0ustar00iojsstaff000000 000000 module.exports = require('../..'); node-v4.8.2/test/fixtures/internal-modules/index.js000644 000766 000024 00000000057 13070706736 022542 0ustar00iojsstaff000000 000000 module.exports = require('internal/freelist'); node-v4.8.2/test/fixtures/internal-modules/node_modules/000755 000766 000024 00000000000 13070706736 023550 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/internal-modules/node_modules/internal/000755 000766 000024 00000000000 13070706736 025364 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/internal-modules/node_modules/internal/freelist.js000644 000766 000024 00000000025 13070706736 027534 0ustar00iojsstaff000000 000000 module.exports = 42; node-v4.8.2/test/fixtures/global/plain.js000644 000766 000024 00000000120 13070706736 020503 0ustar00iojsstaff000000 000000 foo = 'foo'; global.bar = 'bar'; exports.fooBar = {foo: global.foo, bar: bar}; node-v4.8.2/test/fixtures/empty/.gitkeep000644 000766 000024 00000000000 13070706736 020366 0ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/cycles/folder/000755 000766 000024 00000000000 13070706736 020346 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/cycles/root.js000644 000766 000024 00000000304 13070706736 020411 0ustar00iojsstaff000000 000000 var foo = exports.foo = require('./folder/foo'); exports.hello = 'hello'; exports.sayHello = function() { return foo.hello(); }; exports.calledFromFoo = function() { return exports.hello; }; node-v4.8.2/test/fixtures/cycles/folder/foo.js000644 000766 000024 00000000141 13070706736 021463 0ustar00iojsstaff000000 000000 var root = require('./../root'); exports.hello = function() { return root.calledFromFoo(); }; node-v4.8.2/test/fixtures/clustered-server/app.js000644 000766 000024 00000001465 13070706736 022233 0ustar00iojsstaff000000 000000 'use strict'; const http = require('http'); const cluster = require('cluster'); function handleRequest(request, response) { response.end('hello world\n'); } const NUMBER_OF_WORKERS = 2; var workersOnline = 0; if (cluster.isMaster) { cluster.on('online', function() { if (++workersOnline === NUMBER_OF_WORKERS) { console.error('all workers are running'); } }); process.on('message', function(msg) { if (msg.type === 'getpids') { const pids = []; pids.push(process.pid); for (var key in cluster.workers) pids.push(cluster.workers[key].process.pid); process.send({ type: 'pids', pids: pids }); } }); for (var i = 0; i < NUMBER_OF_WORKERS; i++) { cluster.fork(); } } else { const server = http.createServer(handleRequest); server.listen(0); } node-v4.8.2/test/fixtures/break-in-module/main.js000644 000766 000024 00000000103 13070706736 022040 0ustar00iojsstaff000000 000000 var mod = require('./mod.js'); mod.hello(); mod.hello(); debugger; node-v4.8.2/test/fixtures/break-in-module/mod.js000644 000766 000024 00000000076 13070706736 021704 0ustar00iojsstaff000000 000000 exports.hello = function() { return 'hello from module'; }; node-v4.8.2/test/fixtures/b/c.js000644 000766 000024 00000000631 13070706736 016612 0ustar00iojsstaff000000 000000 var d = require('./d'); var assert = require('assert'); var package = require('./package'); assert.equal('world', package.hello); console.error('load fixtures/b/c.js'); var string = 'C'; exports.SomeClass = function() { }; exports.C = function() { return string; }; exports.D = function() { return d.D(); }; process.on('exit', function() { string = 'C done'; console.log('b/c.js exit'); }); node-v4.8.2/test/fixtures/b/d.js000644 000766 000024 00000000243 13070706736 016612 0ustar00iojsstaff000000 000000 console.error('load fixtures/b/d.js'); var string = 'D'; exports.D = function() { return string; }; process.on('exit', function() { string = 'D done'; }); node-v4.8.2/test/fixtures/b/package/000755 000766 000024 00000000000 13070706736 017425 5ustar00iojsstaff000000 000000 node-v4.8.2/test/fixtures/b/package/index.js000644 000766 000024 00000000101 13070706736 021062 0ustar00iojsstaff000000 000000 exports.hello = 'world'; console.error('load package/index.js'); node-v4.8.2/test/doctool/test-doctool-html.js000644 000766 000024 00000011541 13070706736 021325 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const fs = require('fs'); const path = require('path'); // The doctool currently uses js-yaml from the tool/eslint/ tree. try { require('../../tools/eslint/node_modules/js-yaml'); } catch (e) { return common.skip('missing js-yaml (eslint not present)'); } const processIncludes = require('../../tools/doc/preprocess.js'); const html = require('../../tools/doc/html.js'); // Test data is a list of objects with two properties. // The file property is the file path. // The html property is some html which will be generated by the doctool. // This html will be stripped of all whitespace because we don't currently // have an html parser. const testData = [ { file: path.join(common.fixturesDir, 'sample_document.md'), html: '
  1. fish

  2. fish

  3. Redfish

    4. ' + '
  4. Bluefish
' }, { file: path.join(common.fixturesDir, 'order_of_end_tags_5873.md'), html: '

ClassMethod: Buffer.from(array) ' + '#

' }, { file: path.join(common.fixturesDir, 'doc_with_yaml.md'), html: '

Sample Markdown with YAML info' + '#

' + '

Foobar#

' + '
Added in: v1.0.0
' + '

Describe Foobar in more detail here.

' + '

Foobar II#

' + '
Added in: v5.3.0, v4.2.0
' + '

Describe Foobar II in more detail here.

' + '

Deprecated thingy#' + '

' + '
Added in: v1.0.0' + 'Deprecated since: v2.0.0

Describe ' + 'Deprecated thingy in more detail here.

' + '

Something#

' + ' ' + '

Describe Something in more detail here. ' + '

' }, { file: path.join(common.fixturesDir, 'doc_with_includes.md'), html: '' + '

Look here!

' + '' + '' + '

foobar#

' + '

I exist and am being linked to.

' + '' }, { file: path.join(common.fixturesDir, 'sample_document.md'), html: '
  1. fish

  2. fish

  3. Redfish

    4. ' + '
  4. Bluefish
', analyticsId: 'UA-67020396-1' }, ]; testData.forEach((item) => { // Normalize expected data by stripping whitespace const expected = item.html.replace(/\s/g, ''); const includeAnalytics = typeof item.analyticsId !== 'undefined'; fs.readFile(item.file, 'utf8', common.mustCall((err, input) => { assert.ifError(err); processIncludes(item.file, input, common.mustCall((err, preprocessed) => { assert.ifError(err); html( { input: preprocessed, filename: 'foo', template: 'doc/template.html', nodeVersion: process.version, analytics: item.analyticsId, }, common.mustCall((err, output) => { assert.ifError(err); const actual = output.replace(/\s/g, ''); // Assert that the input stripped of all whitespace contains the // expected list assert.notStrictEqual(actual.indexOf(expected), -1); // Testing the insertion of Google Analytics script when // an analytics id is provided. Should not be present by default if (includeAnalytics) { assert.notStrictEqual(actual.indexOf('google-analytics.com'), -1, 'Google Analytics script was not present'); } else { assert.strictEqual(actual.indexOf('google-analytics.com'), -1, 'Google Analytics script was present'); } })); })); })); }); node-v4.8.2/test/doctool/test-doctool-json.js000644 000766 000024 00000010172 13070706736 021331 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const fs = require('fs'); const path = require('path'); // The doctool currently uses js-yaml from the tool/eslint/ tree. try { require('../../tools/eslint/node_modules/js-yaml'); } catch (e) { return common.skip('missing js-yaml (eslint not present)'); } const json = require('../../tools/doc/json.js'); // Outputs valid json with the expected fields when given simple markdown // Test data is a list of objects with two properties. // The file property is the file path. // The json property is some json which will be generated by the doctool. const testData = [ { file: path.join(common.fixturesDir, 'sample_document.md'), json: { source: 'foo', modules: [{ textRaw: 'Sample Markdown', name: 'sample_markdown', modules: [{ textRaw: 'Seussian Rhymes', name: 'seussian_rhymes', desc: '
    \n
  1. fish
    2. \n

  2. fish

    \n
    3. \n
  3. ' + '

    Red fish

    \n
    4. \n
  4. Blue fish
    5. \n
\n', type: 'module', displayName: 'Seussian Rhymes' }], type: 'module', displayName: 'Sample Markdown' }] } }, { file: path.join(common.fixturesDir, 'order_of_end_tags_5873.md'), json: { source: 'foo', modules: [{ textRaw: 'Title', name: 'title', modules: [{ textRaw: 'Subsection', name: 'subsection', classMethods: [{ textRaw: 'Class Method: Buffer.from(array)', type: 'classMethod', name: 'from', signatures: [ { params: [{ textRaw: '`array` {Array} ', name: 'array', type: 'Array' }] }, { params: [{ name: 'array' }] } ] }], type: 'module', displayName: 'Subsection' }], type: 'module', displayName: 'Title' }] } }, { file: path.join(common.fixturesDir, 'doc_with_yaml.md'), json: { source: 'foo', modules: [ { textRaw: 'Sample Markdown with YAML info', name: 'sample_markdown_with_yaml_info', modules: [ { textRaw: 'Foobar', name: 'foobar', meta: { added: ['v1.0.0'] }, desc: '

Describe Foobar in more detail ' + 'here.

\n', type: 'module', displayName: 'Foobar' }, { textRaw: 'Foobar II', name: 'foobar_ii', meta: { added: ['v5.3.0', 'v4.2.0'] }, desc: '

Describe Foobar II in more detail ' + 'here.

\n', type: 'module', displayName: 'Foobar II' }, { textRaw: 'Deprecated thingy', name: 'deprecated_thingy', meta: { added: ['v1.0.0'], deprecated: ['v2.0.0'] }, desc: '

Describe Deprecated thingy in more ' + 'detail here.

\n', type: 'module', displayName: 'Deprecated thingy' }, { textRaw: 'Something', name: 'something', desc: '\n

' + 'Describe Something in more detail here.

\n', type: 'module', displayName: 'Something' } ], type: 'module', displayName: 'Sample Markdown with YAML info' } ] } } ]; testData.forEach((item) => { fs.readFile(item.file, 'utf8', common.mustCall((err, input) => { assert.ifError(err); json(input, 'foo', common.mustCall((err, output) => { assert.ifError(err); assert.deepStrictEqual(output, item.json); })); })); }); node-v4.8.2/test/doctool/testcfg.py000644 000766 000024 00000000314 13070706736 017412 0ustar00iojsstaff000000 000000 import os import sys sys.path.append(os.path.join(os.path.dirname(__file__), '..')) import testpy def GetConfiguration(context, root): return testpy.SimpleTestConfiguration(context, root, 'doctool') node-v4.8.2/test/disabled/test-debug-brk-file.js000644 000766 000024 00000004623 13070706736 021606 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var spawn = require('child_process').spawn; var path = require('path'); var net = require('net'); var isDone = false; var targetPath = path.resolve(common.fixturesDir, 'debug-target.js'); var child = spawn(process.execPath, ['--debug-brk=' + common.PORT, targetPath]); child.stderr.on('data', function() { child.emit('debug_start'); }); child.on('exit', function() { assert(isDone); console.log('ok'); }); child.once('debug_start', function() { // delayed for some time until debug agent is ready setTimeout(function() { debug_client_connect(); }, 200); }); function debug_client_connect() { var msg = null; var tmpBuf = ''; var conn = net.connect({port: common.PORT}); conn.setEncoding('utf8'); conn.on('data', function(data) { tmpBuf += data; parse(); }); function parse() { if (!msg) { msg = { headers: null, contentLength: 0 }; } if (!msg.headers) { var offset = tmpBuf.indexOf('\r\n\r\n'); if (offset < 0) return; msg.headers = tmpBuf.substring(0, offset); tmpBuf = tmpBuf.slice(offset + 4); var matches = /Content-Length: (\d+)/.exec(msg.headers); if (matches[1]) { msg.contentLength = +(matches[1]); } } if (msg.headers && Buffer.byteLength(tmpBuf) >= msg.contentLength) { try { var b = Buffer(tmpBuf); var body = b.toString('utf8', 0, msg.contentLength); tmpBuf = b.toString('utf8', msg.contentLength, b.length); // get breakpoint list and check if it exists on line 0 if (!body.length) { var req = JSON.stringify({'seq': 1, 'type': 'request', 'command': 'listbreakpoints'}); conn.write('Content-Length: ' + req.length + '\r\n\r\n' + req); return; } var obj = JSON.parse(body); if (obj.type === 'response' && obj.command === 'listbreakpoints' && !obj.running) { obj.body.breakpoints.forEach(function(bpoint) { if (bpoint.line === 0) isDone = true; }); } var req = JSON.stringify({'seq': 100, 'type': 'request', 'command': 'disconnect'}); conn.write('Content-Length: ' + req.length + '\r\n\r\n' + req); } finally { msg = null; parse(); } } } } node-v4.8.2/test/disabled/test-dgram-send-error.js000644 000766 000024 00000003065 13070706736 022176 0ustar00iojsstaff000000 000000 'use strict'; // Some operating systems report errors when an UDP message is sent to an // unreachable host. This error can be reported by sendto() and even by // recvfrom(). Node should not propagate this error to the user. // We test this by sending a bunch of packets to random IPs. In the meantime // we also send packets to ourselves to verify that after receiving an error // we can still receive packets successfully. var ITERATIONS = 1000; var assert = require('assert'), common = require('../common'), dgram = require('dgram'); var buf = new Buffer(1024); buf.fill(42); var packetsReceived = 0, packetsSent = 0; var socket = dgram.createSocket('udp4'); socket.on('message', onMessage); socket.on('listening', doSend); socket.bind(common.PORT); function onMessage(message, info) { packetsReceived++; if (packetsReceived < ITERATIONS) { doSend(); } else { socket.close(); } } function afterSend(err) { if (err) throw err; packetsSent++; } function doSend() { // Generate a random IP. var parts = []; for (var i = 0; i < 4; i++) { // Generate a random number in the range 1..254. parts.push(Math.floor(Math.random() * 254) + 1); } var ip = parts.join('.'); socket.send(buf, 0, buf.length, 1, ip, afterSend); socket.send(buf, 0, buf.length, common.PORT, '127.0.0.1', afterSend); } process.on('exit', function() { console.log(packetsSent + ' UDP packets sent, ' + packetsReceived + ' received'); assert.strictEqual(packetsSent, ITERATIONS * 2); assert.strictEqual(packetsReceived, ITERATIONS); }); node-v4.8.2/test/disabled/test-fs-largefile.js000644 000766 000024 00000001733 13070706736 021366 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var path = require('path'), fs = require('fs'), filepath = path.join(common.tmpDir, 'large.txt'), fd = fs.openSync(filepath, 'w+'), offset = 5 * 1024 * 1024 * 1024, // 5GB message = 'Large File'; fs.truncateSync(fd, offset); assert.equal(fs.statSync(filepath).size, offset); var writeBuf = new Buffer(message); fs.writeSync(fd, writeBuf, 0, writeBuf.length, offset); var readBuf = new Buffer(writeBuf.length); fs.readSync(fd, readBuf, 0, readBuf.length, offset); assert.equal(readBuf.toString(), message); fs.readSync(fd, readBuf, 0, 1, 0); assert.equal(readBuf[0], 0); var exceptionRaised = false; try { fs.writeSync(fd, writeBuf, 0, writeBuf.length, 42.000001); } catch (err) { console.log(err); exceptionRaised = true; assert.equal(err.message, 'Not an integer'); } assert.ok(exceptionRaised); fs.close(fd); process.on('exit', function() { fs.unlinkSync(filepath); }); node-v4.8.2/test/disabled/test-http-abort-stream-end.js000644 000766 000024 00000001502 13070706736 023141 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var http = require('http'); var maxSize = 1024; var size = 0; var s = http.createServer(function(req, res) { this.close(); res.writeHead(200, {'Content-Type': 'text/plain'}); for (var i = 0; i < maxSize; i++) { res.write('x' + i); } res.end(); }); var aborted = false; s.listen(common.PORT, function() { var req = http.get('http://localhost:' + common.PORT, function(res) { res.on('data', function(chunk) { size += chunk.length; assert(!aborted, 'got data after abort'); if (size > maxSize) { aborted = true; req.abort(); size = maxSize; } }); }); req.end(); }); process.on('exit', function() { assert(aborted); assert.equal(size, maxSize); console.log('ok'); }); node-v4.8.2/test/disabled/test-https-loop-to-google.js000644 000766 000024 00000001077 13070706736 023032 0ustar00iojsstaff000000 000000 'use strict'; // Failing test for https // Will fail with "socket hang up" for 4 out of 10 requests // Tested on node 0.5.0-pre commit 9851574 var common = require('../common'); var https = require('https'); for (var i = 0; i < 10; ++i) { https.get({ host: 'www.google.com', path: '/accounts/o8/id', port: 443 }, function(res) { var data = ''; res.on('data', function(chunk) { data += chunk; }); res.on('end', function() { console.log(res.statusCode); }); }).on('error', function(error) { console.log(error); }); } node-v4.8.2/test/disabled/test-readline.js000644 000766 000024 00000005315 13070706736 020611 0ustar00iojsstaff000000 000000 'use strict'; // Can't test this when 'make test' doesn't assign a tty to the stdout. // Yet another use-case for require('tty').spawn ? var common = require('../common'); var assert = require('assert'); var readline = require('readline'); var key = { xterm: { home: ['\x1b[H', {ctrl: true, name: 'a'}], end: ['\x1b[F', {ctrl: true, name: 'e'}], metab: ['\x1bb', {meta: true, name: 'b'}], metaf: ['\x1bf', {meta: true, name: 'f'}], metad: ['\x1bd', {meta: true, name: 'd'}] }, gnome: { home: ['\x1bOH', {ctrl: true, name: 'a'}], end: ['\x1bOF', {ctrl: true, name: 'e'}] }, rxvt: { home: ['\x1b[7', {ctrl: true, name: 'a'}], end: ['\x1b[8', {ctrl: true, name: 'e'}] }, putty: { home: ['\x1b[1~', {ctrl: true, name: 'a'}], end: ['\x1b[>~', {ctrl: true, name: 'e'}] } }; var readlineFakeStream = function() { var written_bytes = []; var rl = readline.createInterface( { input: process.stdin, output: process.stdout, completer: function(text) { return [[], '']; } }); var _stdoutWrite = process.stdout.write; process.stdout.write = function(data) { data.split('').forEach(rl.written_bytes.push.bind(rl.written_bytes)); _stdoutWrite.apply(this, arguments); }; rl.written_bytes = written_bytes; return rl; }; var rl = readlineFakeStream(); var written_bytes_length, refreshed; rl.write('foo'); assert.equal(3, rl.cursor); [key.xterm, key.rxvt, key.gnome, key.putty].forEach(function(key) { rl.write.apply(rl, key.home); assert.equal(0, rl.cursor); rl.write.apply(rl, key.end); assert.equal(3, rl.cursor); }); rl = readlineFakeStream(); rl.write('foo bar.hop/zoo'); rl.write.apply(rl, key.xterm.home); [ {cursor: 4, key: key.xterm.metaf}, {cursor: 7, key: key.xterm.metaf}, {cursor: 8, key: key.xterm.metaf}, {cursor: 11, key: key.xterm.metaf}, {cursor: 12, key: key.xterm.metaf}, {cursor: 15, key: key.xterm.metaf}, {cursor: 12, key: key.xterm.metab}, {cursor: 11, key: key.xterm.metab}, {cursor: 8, key: key.xterm.metab}, {cursor: 7, key: key.xterm.metab}, {cursor: 4, key: key.xterm.metab}, {cursor: 0, key: key.xterm.metab}, ].forEach(function(action) { written_bytes_length = rl.written_bytes.length; rl.write.apply(rl, action.key); assert.equal(action.cursor, rl.cursor); refreshed = written_bytes_length !== rl.written_bytes.length; assert.equal(true, refreshed); }); rl = readlineFakeStream(); rl.write('foo bar.hop/zoo'); rl.write.apply(rl, key.xterm.home); [ 'bar.hop/zoo', '.hop/zoo', 'hop/zoo', '/zoo', 'zoo', '' ].forEach(function(expectedLine) { rl.write.apply(rl, key.xterm.metad); assert.equal(0, rl.cursor); assert.equal(expectedLine, rl.line); }); rl.close(); node-v4.8.2/test/disabled/test-sendfd.js000644 000766 000024 00000010006 13070706736 020262 0ustar00iojsstaff000000 000000 'use strict'; // Test sending and receiving a file descriptor. // // This test is pretty complex. It ends up spawning test/fixtures/recvfd.js // as a child to test desired behavior. What happens is // // 1. Create an in-memory pipe via pipe(2). These two file descriptors // are not visible to any other process, and so make a good test-case // for sharing. // 2. Create a a UNIX socket at SOCK_PATH. When a client connects to this // path, they are sent the write end of the pipe from above. // 3. The client is sent n JSON representations of the DATA variable, each // with a different ordinal. We send these delimited by '\n' strings // so that the receiving end can avoid any coalescing that happens // due to the stream nature of the socket (e.g. '{}{}' is not a valid // JSON string). // 4. The child process receives file descriptors and JSON blobs and, // whenever it has at least one of each, writes a modified JSON blob // to the FD. The blob is modified to include the child's process ID. // 5. Once the child process has sent n responses, it closes the write end // of the pipe, which signals to the parent that there is no more data // coming. // 6. The parent listens to the read end of the pipe, accumulating JSON // blobs (again, delimited by '\n') and verifying that a) the 'pid' // attribute belongs to the child and b) the 'ord' field has not been // seen in a response yet. This is intended to ensure that all blobs // sent out have been relayed back to us. var common = require('../common'); var assert = require('assert'); var buffer = require('buffer'); var child_process = require('child_process'); var fs = require('fs'); var net = require('net'); var netBinding = process.binding('net'); var path = require('path'); var DATA = { 'ppid' : process.pid, 'ord' : 0 }; var SOCK_PATH = path.join(__dirname, '..', path.basename(__filename, '.js') + '.sock'); var logChild = function(d) { if (typeof d == 'object') { d = d.toString(); } d.split('\n').forEach(function(l) { if (l.length > 0) { console.error('CHILD: ' + l); } }); }; // Create a pipe // // We establish a listener on the read end of the pipe so that we can // validate any data sent back by the child. We send the write end of the // pipe to the child and close it off in our process. var pipeFDs = netBinding.pipe(); assert.equal(pipeFDs.length, 2); var seenOrdinals = []; var pipeReadStream = new net.Stream(); pipeReadStream.on('data', function(data) { data.toString('utf8').trim().split('\n').forEach(function(d) { var rd = JSON.parse(d); assert.equal(rd.pid, cpp); assert.equal(seenOrdinals.indexOf(rd.ord), -1); seenOrdinals.unshift(rd.ord); }); }); pipeReadStream.open(pipeFDs[0]); pipeReadStream.resume(); // Create a UNIX socket at SOCK_PATH and send DATA and the write end // of the pipe to whoever connects. // // We send two messages here, both with the same pipe FD: one string, and // one buffer. We want to make sure that both datatypes are handled // correctly. var srv = net.createServer(function(s) { var str = JSON.stringify(DATA) + '\n'; DATA.ord = DATA.ord + 1; var buf = new buffer.Buffer(str.length); buf.write(JSON.stringify(DATA) + '\n', 'utf8'); s.write(str, 'utf8', pipeFDs[1]); if (s.write(buf, pipeFDs[1])) { netBinding.close(pipeFDs[1]); } else { s.on('drain', function() { netBinding.close(pipeFDs[1]); }); } }); srv.listen(SOCK_PATH); // Spawn a child running test/fixtures/recvfd.js var cp = child_process.spawn(process.argv[0], [path.join(common.fixturesDir, 'recvfd.js'), SOCK_PATH]); cp.stdout.on('data', logChild); cp.stderr.on('data', logChild); // When the child exits, clean up and validate its exit status var cpp = cp.pid; cp.on('exit', function(code, signal) { srv.close(); // fs.unlinkSync(SOCK_PATH); assert.equal(code, 0); assert.equal(seenOrdinals.length, 2); }); // vim:ts=2 sw=2 et node-v4.8.2/test/disabled/test-setuidgid.js000644 000766 000024 00000001120 13070706736 020775 0ustar00iojsstaff000000 000000 'use strict'; // Requires special privileges var common = require('../common'); var assert = require('assert'); var oldgid = process.getgid(); process.setgid('nobody'); var newgid = process.getgid(); assert.notEqual(newgid, oldgid, 'gids expected to be different'); var olduid = process.getuid(); process.setuid('nobody'); var newuid = process.getuid(); assert.notEqual(newuid, olduid, 'uids expected to be different'); try { process.setuid('nobody1234'); } catch (e) { assert.equal(e.message, 'failed to resolve group', 'unexpected error message' ); } node-v4.8.2/test/disabled/tls_server.js000644 000766 000024 00000002221 13070706736 020232 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var util = require('util'); var net = require('net'); var fs = require('fs'); var crypto = require('crypto'); var keyPem = fs.readFileSync(common.fixturesDir + '/cert.pem'); var certPem = fs.readFileSync(common.fixturesDir + '/cert.pem'); try { var credentials = crypto.createCredentials({key: keyPem, cert: certPem}); } catch (e) { common.skip('node compiled without OpenSSL.'); return; } var i = 0; var server = net.createServer(function(connection) { connection.setSecure(credentials); connection.setEncoding('binary'); connection.on('secure', function() { //console.log('Secure'); }); connection.on('data', function(chunk) { console.log('recved: ' + JSON.stringify(chunk)); connection.write('HTTP/1.0 200 OK\r\n' + 'Content-type: text/plain\r\n' + 'Content-length: 9\r\n' + '\r\n' + 'OK : ' + i + '\r\n\r\n'); i = i + 1; connection.end(); }); connection.on('end', function() { connection.end(); }); }); server.listen(4443); node-v4.8.2/test/debugger/helper-debugger-repl.js000644 000766 000024 00000006102 13070706736 022062 0ustar00iojsstaff000000 000000 'use strict'; process.env.NODE_DEBUGGER_TIMEOUT = 2000; var common = require('../common'); var assert = require('assert'); var spawn = require('child_process').spawn; var port = common.PORT; var child; var buffer = ''; var expected = []; var quit; function startDebugger(scriptToDebug) { scriptToDebug = process.env.NODE_DEBUGGER_TEST_SCRIPT || common.fixturesDir + '/' + scriptToDebug; child = spawn(process.execPath, ['debug', '--port=' + port, scriptToDebug]); console.error('./node', 'debug', '--port=' + port, scriptToDebug); child.stdout.setEncoding('utf-8'); child.stdout.on('data', function(data) { data = (buffer + data).split('\n'); buffer = data.pop(); data.forEach(function(line) { child.emit('line', line); }); }); child.stderr.pipe(process.stderr); child.on('line', function(line) { line = line.replace(/^(debug> *)+/, ''); console.log(line); assert.ok(expected.length > 0, 'Got unexpected line: ' + line); var expectedLine = expected[0].lines.shift(); assert.ok(line.match(expectedLine) !== null, line + ' != ' + expectedLine); if (expected[0].lines.length === 0) { var callback = expected[0].callback; expected.shift(); callback && callback(); } }); var childClosed = false; child.on('close', function(code) { assert(!code); childClosed = true; }); var quitCalled = false; quit = function() { if (quitCalled || childClosed) return; quitCalled = true; child.stdin.write('quit'); child.kill('SIGTERM'); }; setTimeout(function() { console.error('dying badly buffer=%j', buffer); var err = 'Timeout'; if (expected.length > 0 && expected[0].lines) { err = err + '. Expected: ' + expected[0].lines.shift(); } child.on('close', function() { console.error('child is closed'); throw new Error(err); }); quit(); }, 10000).unref(); process.once('uncaughtException', function(e) { console.error('UncaughtException', e, e.stack); quit(); console.error(e.toString()); process.exit(1); }); process.on('exit', function(code) { console.error('process exit', code); quit(); if (code === 0) assert(childClosed); }); } function addTest(input, output) { function next() { if (expected.length > 0) { console.log('debug> ' + expected[0].input); child.stdin.write(expected[0].input + '\n'); if (!expected[0].lines) { var callback = expected[0].callback; expected.shift(); callback && callback(); } } else { quit(); } } expected.push({input: input, lines: output, callback: next}); } var handshakeLines = [ /listening on /, /connecting.* ok/ ]; var initialBreakLines = [ /break in .*:1/, /1/, /2/, /3/ ]; var initialLines = handshakeLines.concat(initialBreakLines); // Process initial lines addTest(null, initialLines); exports.startDebugger = startDebugger; exports.addTest = addTest; exports.initialLines = initialLines; exports.handshakeLines = handshakeLines; exports.initialBreakLines = initialBreakLines; node-v4.8.2/test/debugger/test-debug-break-on-uncaught.js000644 000766 000024 00000005126 13070706736 023441 0ustar00iojsstaff000000 000000 'use strict'; const path = require('path'); const assert = require('assert'); const spawn = require('child_process').spawn; const common = require('../common'); const debug = require('_debugger'); const scenarios = []; addScenario('global.js', 2); addScenario('timeout.js', 2); run(); /***************** IMPLEMENTATION *****************/ function addScenario(scriptName, throwsOnLine) { scenarios.push( runScenario.bind(null, scriptName, throwsOnLine, run) ); } function run() { const next = scenarios.shift(); if (next) next(); } function runScenario(scriptName, throwsOnLine, next) { let asserted = false; const port = common.PORT; const testScript = path.join( common.fixturesDir, 'uncaught-exceptions', scriptName ); const child = spawn(process.execPath, [ '--debug-brk=' + port, testScript ]); child.on('close', function() { assert(asserted, 'debugger did not pause on exception'); if (next) next(); }); const exceptions = []; let stderr = ''; function stderrListener(data) { stderr += data; if (stderr.includes('Debugger listening on ')) { setTimeout(setupClient.bind(null, runTest), 200); child.stderr.removeListener('data', stderrListener); } } child.stderr.setEncoding('utf8'); child.stderr.on('data', stderrListener); function setupClient(callback) { const client = new debug.Client(); client.once('ready', callback.bind(null, client)); client.on('unhandledResponse', function(body) { console.error('unhandled response: %j', body); }); client.on('error', function(err) { if (asserted) return; assert.ifError(err); }); client.connect(port); } function runTest(client) { client.req( { command: 'setexceptionbreak', arguments: { type: 'uncaught', enabled: true } }, function(error) { assert.ifError(error); client.on('exception', function(event) { exceptions.push(event.body); }); client.reqContinue(function(error) { assert.ifError(error); setTimeout(assertHasPaused.bind(null, client), 100); }); } ); } function assertHasPaused(client) { assert(exceptions.length, 'no exceptions thrown, race condition in test?'); assert.equal(exceptions.length, 1, 'debugger did not pause on exception'); assert.equal(exceptions[0].uncaught, true); assert.equal(exceptions[0].script.name, testScript); assert.equal(exceptions[0].sourceLine + 1, throwsOnLine); asserted = true; client.reqContinue(assert.ifError); } } node-v4.8.2/test/debugger/test-debugger-client.js000644 000766 000024 00000013625 13070706736 022106 0ustar00iojsstaff000000 000000 'use strict'; process.env.NODE_DEBUGGER_TIMEOUT = 2000; var common = require('../common'); var assert = require('assert'); var debug = require('_debugger'); var debugPort = common.PORT; debug.port = debugPort; var spawn = require('child_process').spawn; setTimeout(function() { if (nodeProcess) nodeProcess.kill('SIGTERM'); throw new Error('timeout'); }, 10000).unref(); var resCount = 0; var p = new debug.Protocol(); p.onResponse = function(res) { resCount++; }; p.execute('Type: connect\r\n' + 'V8-Version: 3.0.4.1\r\n' + 'Protocol-Version: 1\r\n' + 'Embedding-Host: node v0.3.3-pre\r\n' + 'Content-Length: 0\r\n\r\n'); assert.equal(1, resCount); // Make sure split messages go in. var parts = []; parts.push('Content-Length: 336\r\n'); assert.equal(21, parts[0].length); parts.push('\r\n'); assert.equal(2, parts[1].length); var bodyLength = 0; parts.push('{"seq":12,"type":"event","event":"break","body":' + '{"invocationText":"#'); assert.equal(78, parts[2].length); bodyLength += parts[2].length; parts.push('.[anonymous](req=#, ' + 'res=#)","sourceLine"'); assert.equal(78, parts[3].length); bodyLength += parts[3].length; parts.push(':45,"sourceColumn":4,"sourceLineText":" debugger;",' + '"script":{"id":24,"name":"/home/ryan/projects/node/' + 'benchmark/http_simple.js","lineOffset":0,"columnOffset":0,' + '"lineCount":98}}}'); assert.equal(180, parts[4].length); bodyLength += parts[4].length; assert.equal(336, bodyLength); for (var i = 0; i < parts.length; i++) { p.execute(parts[i]); } assert.equal(2, resCount); // Make sure that if we get backed up, we still manage to get all the // messages var d = 'Content-Length: 466\r\n\r\n' + '{"seq":10,"type":"event","event":"afterCompile","success":true,' + '"body":{"script":{"handle":1,"type":"script","name":"dns.js",' + '"id":34,"lineOffset":0,"columnOffset":0,"lineCount":241,' + '"sourceStart":"(function(module, exports, require) {' + 'var dns = process.binding(\'cares\')' + ';\\nvar ne","sourceLength":6137,"scriptType":2,"compilationType":0,' + '"context":{"ref":0},"text":"dns.js (lines: 241)"}},"refs":' + '[{"handle":0' + ',"type":"context","text":"#"}],"running":true}' + '\r\n\r\nContent-Length: 119\r\n\r\n' + '{"seq":11,"type":"event","event":"scriptCollected","success":true,' + '"body":{"script":{"id":26}},"refs":[],"running":true}'; p.execute(d); assert.equal(4, resCount); var expectedConnections = 0; var tests = []; function addTest(cb) { expectedConnections++; tests.push(cb); } addTest(function(client, done) { console.error('requesting version'); client.reqVersion(function(err, v) { assert.ok(!err); console.log('version: %s', v); assert.equal(process.versions.v8, v); done(); }); }); addTest(function(client, done) { console.error('requesting scripts'); client.reqScripts(function(err) { assert.ok(!err); console.error('got %d scripts', Object.keys(client.scripts).length); var foundMainScript = false; for (var k in client.scripts) { var script = client.scripts[k]; if (script && script.name === 'node.js') { foundMainScript = true; break; } } assert.ok(foundMainScript); done(); }); }); addTest(function(client, done) { console.error('eval 2+2'); client.reqEval('2+2', function(err, res) { console.error(res); assert.ok(!err); assert.equal('4', res.text); assert.equal(4, res.value); done(); }); }); var connectCount = 0; var script = 'setTimeout(function() { console.log("blah"); });' + 'setInterval(function() {}, 1000000);'; var nodeProcess; function doTest(cb, done) { var args = ['--debug=' + debugPort, '-e', script]; nodeProcess = spawn(process.execPath, args); nodeProcess.stdout.once('data', function(c) { console.log('>>> new node process: %d', nodeProcess.pid); var failed = true; try { process._debugProcess(nodeProcess.pid); failed = false; } finally { // At least TRY not to leave zombie procs if this fails. if (failed) nodeProcess.kill('SIGTERM'); } console.log('>>> starting debugger session'); }); var didTryConnect = false; nodeProcess.stderr.setEncoding('utf8'); var b = ''; nodeProcess.stderr.on('data', function(data) { console.error('got stderr data %j', data); nodeProcess.stderr.resume(); b += data; if (didTryConnect === false && b.match(/Debugger listening on port/)) { didTryConnect = true; // The timeout is here to expose a race in the bootstrap process. // Without the early SIGUSR1 debug handler, it effectively results // in an infinite ECONNREFUSED loop. setTimeout(tryConnect, 100); function tryConnect() { // Wait for some data before trying to connect var c = new debug.Client(); console.error('>>> connecting...'); c.connect(debug.port); c.on('break', function(brk) { c.reqContinue(function() {}); }); c.on('ready', function() { connectCount++; console.log('ready!'); cb(c, function() { c.end(); c.on('end', function() { console.error( '>>> killing node process %d\n\n', nodeProcess.pid); nodeProcess.kill(); done(); }); }); }); c.on('error', function(err) { if (err.code !== 'ECONNREFUSED') throw err; setTimeout(tryConnect, 10); }); } } }); } function run() { var t = tests[0]; if (!t) return; doTest(t, function() { tests.shift(); run(); }); } run(); process.on('exit', function(code) { if (!code) assert.equal(expectedConnections, connectCount); }); node-v4.8.2/test/debugger/test-debugger-debug-brk.js000644 000766 000024 00000001150 13070706736 022460 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var spawn = require('child_process').spawn; var script = common.fixturesDir + '/empty.js'; function fail() { assert(0); // `node --debug-brk script.js` should not quit } function test(arg) { var child = spawn(process.execPath, [arg, script]); child.on('exit', fail); // give node time to start up the debugger setTimeout(function() { child.removeListener('exit', fail); child.kill(); }, 2000); process.on('exit', function() { assert(child.killed); }); } test('--debug-brk'); test('--debug-brk=5959'); node-v4.8.2/test/debugger/test-debugger-pid.js000644 000766 000024 00000001635 13070706736 021402 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var assert = require('assert'); var spawn = require('child_process').spawn; var buffer = ''; // connect to debug agent var interfacer = spawn(process.execPath, ['debug', '-p', '655555']); console.error(process.execPath, 'debug', '-p', '655555'); interfacer.stdout.setEncoding('utf-8'); interfacer.stderr.setEncoding('utf-8'); var onData = function(data) { data = (buffer + data).split('\n'); buffer = data.pop(); data.forEach(function(line) { interfacer.emit('line', line); }); }; interfacer.stdout.on('data', onData); interfacer.stderr.on('data', onData); interfacer.on('line', function(line) { line = line.replace(/^(debug> *)+/, ''); var expected = 'Target process: 655555 doesn\'t exist.'; assert.ok(expected == line, 'Got unexpected line: ' + line); }); interfacer.on('exit', function(code, signal) { assert.ok(code == 1, 'Got unexpected code: ' + code); }); node-v4.8.2/test/debugger/test-debugger-remote.js000644 000766 000024 00000002545 13070706736 022122 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var assert = require('assert'); var spawn = require('child_process').spawn; var buffer = ''; var scriptToDebug = common.fixturesDir + '/empty.js'; function fail() { assert(0); // `--debug-brk script.js` should not quit } // running with debug agent var child = spawn(process.execPath, ['--debug-brk=5959', scriptToDebug]); console.error(process.execPath, '--debug-brk=5959', scriptToDebug); // connect to debug agent var interfacer = spawn(process.execPath, ['debug', 'localhost:5959']); console.error(process.execPath, 'debug', 'localhost:5959'); interfacer.stdout.setEncoding('utf-8'); interfacer.stdout.on('data', function(data) { data = (buffer + data).split('\n'); buffer = data.pop(); data.forEach(function(line) { interfacer.emit('line', line); }); }); interfacer.on('line', function(line) { line = line.replace(/^(debug> *)+/, ''); console.log(line); var expected = '\bconnecting to localhost:5959 ... ok'; assert.ok(expected == line, 'Got unexpected line: ' + line); }); // allow time to start up the debugger setTimeout(function() { child.removeListener('exit', fail); child.kill(); interfacer.removeListener('exit', fail); interfacer.kill(); }, 2000); process.on('exit', function() { assert(child.killed); assert(interfacer.killed); }); interfacer.stderr.pipe(process.stderr); node-v4.8.2/test/debugger/test-debugger-repl-break-in-module.js000644 000766 000024 00000002626 13070706736 024542 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var repl = require('./helper-debugger-repl.js'); repl.startDebugger('break-in-module/main.js'); // -- SET BREAKPOINT -- // Set breakpoint by file name + line number where the file is not loaded yet repl.addTest('sb("mod.js", 2)', [ /Warning: script 'mod\.js' was not loaded yet\./, /1/, /2/, /3/, /4/, /5/, /6/ ]); // Check escaping of regex characters repl.addTest('sb(")^$*+?}{|][(.js\\\\", 1)', [ /Warning: script '[^']+' was not loaded yet\./, /1/, /2/, /3/, /4/, /5/, /6/ ]); // continue - the breakpoint should be triggered repl.addTest('c', [ /break in .*[\\\/]mod\.js:2/, /1/, /2/, /3/, /4/ ]); // -- RESTORE BREAKPOINT ON RESTART -- // Restart the application - breakpoint should be restored repl.addTest('restart', [].concat( [ /terminated/ ], repl.handshakeLines, [ /Restoring breakpoint mod.js:2/, /Warning: script 'mod\.js' was not loaded yet\./, /Restoring breakpoint \).*:\d+/, /Warning: script '\)[^']*' was not loaded yet\./ ], repl.initialBreakLines)); // continue - the breakpoint should be triggered repl.addTest('c', [ /break in .*[\\\/]mod\.js:2/, /1/, /2/, /3/, /4/ ]); // -- CLEAR BREAKPOINT SET IN MODULE TO BE LOADED -- repl.addTest('cb("mod.js", 2)', [ /1/, /2/, /3/, /4/, /5/ ]); repl.addTest('c', [ /break in .*[\\\/]main\.js:4/, /2/, /3/, /4/, /5/, /6/ ]); // -- (END) -- repl.addTest('quit', []); node-v4.8.2/test/debugger/test-debugger-repl-restart.js000644 000766 000024 00000001076 13070706736 023251 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var repl = require('./helper-debugger-repl.js'); repl.startDebugger('breakpoints.js'); var linesWithBreakpoint = [ /1/, /2/, /3/, /4/, /5/, /\* 6/ ]; // We slice here, because addTest will change the given array. repl.addTest('sb(6)', linesWithBreakpoint.slice()); var initialLines = repl.initialLines.slice(); initialLines.splice(2, 0, /Restoring/, /Warning/); // Restart the debugged script repl.addTest('restart', [ /terminated/, ].concat(initialLines)); repl.addTest('list(5)', linesWithBreakpoint); repl.addTest('quit', []); node-v4.8.2/test/debugger/test-debugger-repl-term.js000644 000766 000024 00000001265 13070706736 022534 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); process.env.NODE_FORCE_READLINE = 1; var repl = require('./helper-debugger-repl.js'); repl.startDebugger('breakpoints.js'); var addTest = repl.addTest; // next addTest('n', [ /debug>.*n/, /break in .*:11/, /9/, /10/, /11/, /12/, /13/ ]); // should repeat next addTest('', [ /debug>/, /break in .*:5/, /3/, /4/, /5/, /6/, /7/, ]); // continue addTest('c', [ /debug>.*c/, /break in .*:12/, /10/, /11/, /12/, /13/, /14/ ]); // should repeat continue addTest('', [ /debug>/, /break in .*:5/, /3/, /4/, /5/, /6/, /7/, ]); // should repeat continue addTest('', [ /debug>/, /break in .*:23/, /21/, /22/, /23/, /24/, /25/, ]); node-v4.8.2/test/debugger/test-debugger-repl-utf8.js000644 000766 000024 00000000301 13070706736 022441 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../common'); var script = common.fixturesDir + '/breakpoints_utf8.js'; process.env.NODE_DEBUGGER_TEST_SCRIPT = script; require('./test-debugger-repl.js'); node-v4.8.2/test/debugger/test-debugger-repl.js000644 000766 000024 00000002377 13070706736 021574 0ustar00iojsstaff000000 000000 'use strict'; require('../common'); var repl = require('./helper-debugger-repl.js'); repl.startDebugger('breakpoints.js'); var addTest = repl.addTest; // Next addTest('n', [ /break in .*:11/, /9/, /10/, /11/, /12/, /13/ ]); // Watch addTest('watch("\'x\'")'); // Continue addTest('c', [ /break in .*:5/, /Watchers/, /0:\s+'x' = "x"/, /()/, /3/, /4/, /5/, /6/, /7/ ]); // Show watchers addTest('watchers', [ /0:\s+'x' = "x"/ ]); // Unwatch addTest('unwatch("\'x\'")'); // Step out addTest('o', [ /break in .*:12/, /10/, /11/, /12/, /13/, /14/ ]); // Continue addTest('c', [ /break in .*:5/, /3/, /4/, /5/, /6/, /7/ ]); // Set breakpoint by function name addTest('sb("setInterval()", "!(setInterval.flag++)")', [ /1/, /2/, /3/, /4/, /5/, /6/, /7/, /8/, /9/, /10/ ]); // Continue addTest('c', [ /break in timers.js:\d+/, /\d/, /\d/, /\d/, /\d/, /\d/ ]); // Execute addTest('exec process.title', [ /node/ ]); // Execute addTest('exec exec process.title', [ /SyntaxError: Unexpected identifier/ ]); // REPL and process.env regression addTest('repl', [ /Ctrl/ ]); addTest('for (var i in process.env) delete process.env[i]', []); addTest('process.env', [ /\{\}/ ]); addTest('arr = [{foo: "bar"}]', [ /\[ \{ foo: 'bar' \} \]/ ]); node-v4.8.2/test/debugger/testcfg.py000644 000766 000024 00000000305 13070706736 017533 0ustar00iojsstaff000000 000000 import sys, os sys.path.append(os.path.join(os.path.dirname(__file__), '..')) import testpy def GetConfiguration(context, root): return testpy.SimpleTestConfiguration(context, root, 'debugger') node-v4.8.2/test/cctest/util.cc000644 000766 000024 00000004222 13070706736 016511 0ustar00iojsstaff000000 000000 #include "util.h" #include "util-inl.h" #include "gtest/gtest.h" TEST(UtilTest, ListHead) { struct Item { node::ListNode node_; }; typedef node::ListHead List; List list; EXPECT_TRUE(list.IsEmpty()); Item one; EXPECT_TRUE(one.node_.IsEmpty()); list.PushBack(&one); EXPECT_FALSE(list.IsEmpty()); EXPECT_FALSE(one.node_.IsEmpty()); { List::Iterator it = list.begin(); EXPECT_NE(list.end(), it); EXPECT_EQ(&one, *it); ++it; EXPECT_FALSE(it != list.end()); // Iterator only implements != operator. } Item two; list.PushBack(&two); { List::Iterator it = list.begin(); EXPECT_NE(list.end(), it); EXPECT_EQ(&one, *it); ++it; EXPECT_NE(list.end(), it); EXPECT_EQ(&two, *it); ++it; EXPECT_FALSE(it != list.end()); // Iterator only implements != operator. } EXPECT_EQ(&one, list.PopFront()); EXPECT_TRUE(one.node_.IsEmpty()); EXPECT_FALSE(list.IsEmpty()); { List::Iterator it = list.begin(); EXPECT_NE(list.end(), it); EXPECT_EQ(&two, *it); ++it; EXPECT_FALSE(it != list.end()); // Iterator only implements != operator. } EXPECT_EQ(&two, list.PopFront()); EXPECT_TRUE(two.node_.IsEmpty()); EXPECT_TRUE(list.IsEmpty()); EXPECT_FALSE(list.begin() != list.end()); } TEST(UtilTest, StringEqualNoCase) { using node::StringEqualNoCase; EXPECT_FALSE(StringEqualNoCase("a", "b")); EXPECT_TRUE(StringEqualNoCase("", "")); EXPECT_TRUE(StringEqualNoCase("equal", "equal")); EXPECT_TRUE(StringEqualNoCase("equal", "EQUAL")); EXPECT_TRUE(StringEqualNoCase("EQUAL", "EQUAL")); EXPECT_FALSE(StringEqualNoCase("equal", "equals")); EXPECT_FALSE(StringEqualNoCase("equals", "equal")); } TEST(UtilTest, ToLower) { using node::ToLower; EXPECT_EQ('0', ToLower('0')); EXPECT_EQ('a', ToLower('a')); EXPECT_EQ('a', ToLower('A')); } TEST(UtilTest, Malloc) { using node::Malloc; EXPECT_NE(nullptr, Malloc(0)); EXPECT_NE(nullptr, Malloc(1)); } TEST(UtilTest, Calloc) { using node::Calloc; EXPECT_NE(nullptr, Calloc(0, 0)); EXPECT_NE(nullptr, Calloc(1, 0)); EXPECT_NE(nullptr, Calloc(0, 1)); EXPECT_NE(nullptr, Calloc(1, 1)); } node-v4.8.2/test/addons/.gitignore000644 000766 000024 00000000112 13070706736 017172 0ustar00iojsstaff000000 000000 .buildstamp .docbuildstamp Makefile *.Makefile *.mk gyp-mac-tool /*/build node-v4.8.2/test/addons/async-hello-world/000755 000766 000024 00000000000 13070706736 020553 5ustar00iojsstaff000000 000000 node-v4.8.2/test/addons/at-exit/000755 000766 000024 00000000000 13070706736 016563 5ustar00iojsstaff000000 000000 node-v4.8.2/test/addons/buffer-free-callback/000755 000766 000024 00000000000 13070706736 021132 5ustar00iojsstaff000000 000000 node-v4.8.2/test/addons/heap-profiler/000755 000766 000024 00000000000 13070706736 017745 5ustar00iojsstaff000000 000000 node-v4.8.2/test/addons/hello-world/000755 000766 000024 00000000000 13070706736 017440 5ustar00iojsstaff000000 000000 node-v4.8.2/test/addons/hello-world-function-export/000755 000766 000024 00000000000 13070706736 022602 5ustar00iojsstaff000000 000000 node-v4.8.2/test/addons/load-long-path/000755 000766 000024 00000000000 13070706736 020016 5ustar00iojsstaff000000 000000 node-v4.8.2/test/addons/make-callback/000755 000766 000024 00000000000 13070706736 017657 5ustar00iojsstaff000000 000000 node-v4.8.2/test/addons/make-callback-recurse/000755 000766 000024 00000000000 13070706736 021325 5ustar00iojsstaff000000 000000 node-v4.8.2/test/addons/new-target/000755 000766 000024 00000000000 13070706736 017265 5ustar00iojsstaff000000 000000 node-v4.8.2/test/addons/openssl-binding/000755 000766 000024 00000000000 13070706736 020303 5ustar00iojsstaff000000 000000 node-v4.8.2/test/addons/repl-domain-abort/000755 000766 000024 00000000000 13070706736 020524 5ustar00iojsstaff000000 000000 node-v4.8.2/test/addons/stringbytes-external-exceed-max/000755 000766 000024 00000000000 13070706736 023423 5ustar00iojsstaff000000 000000 node-v4.8.2/test/addons/testcfg.py000644 000766 000024 00000000301 13070706736 017213 0ustar00iojsstaff000000 000000 import sys, os sys.path.append(os.path.join(os.path.dirname(__file__), '..')) import testpy def GetConfiguration(context, root): return testpy.AddonTestConfiguration(context, root, 'addon') node-v4.8.2/test/addons/stringbytes-external-exceed-max/binding.cc000644 000766 000024 00000001135 13070706736 025344 0ustar00iojsstaff000000 000000 #include #include #include void EnsureAllocation(const v8::FunctionCallbackInfo &args) { v8::Isolate* isolate = args.GetIsolate(); uintptr_t size = args[0]->IntegerValue(); v8::Local success; void* buffer = malloc(size); if (buffer) { success = v8::Boolean::New(isolate, true); free(buffer); } else { success = v8::Boolean::New(isolate, false); } args.GetReturnValue().Set(success); } void init(v8::Local target) { NODE_SET_METHOD(target, "ensureAllocation", EnsureAllocation); } NODE_MODULE(binding, init); node-v4.8.2/test/addons/stringbytes-external-exceed-max/binding.gyp000644 000766 000024 00000000227 13070706736 025557 0ustar00iojsstaff000000 000000 { 'targets': [ { 'target_name': 'binding', 'defines': [ 'V8_DEPRECATION_WARNINGS=1' ], 'sources': [ 'binding.cc' ] } ] } node-v4.8.2/test/addons/stringbytes-external-exceed-max/test-stringbytes-external-at-max.js000644 000766 000024 00000001720 13070706736 032320 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../../common'); const binding = require(`./build/${common.buildType}/binding`); const assert = require('assert'); // v8 fails silently if string length > v8::String::kMaxLength // v8::String::kMaxLength defined in v8.h const kStringMaxLength = process.binding('buffer').kStringMaxLength; const skipMessage = 'intensive toString tests due to memory confinements'; if (!common.enoughTestMem) { common.skip(skipMessage); return; } try { var buf = new Buffer(kStringMaxLength); } catch (e) { // If the exception is not due to memory confinement then rethrow it. if (e.message !== 'Invalid array buffer length') throw (e); common.skip(skipMessage); return; } // Ensure we have enough memory available for future allocations to succeed. if (!binding.ensureAllocation(2 * kStringMaxLength)) { common.skip(skipMessage); return; } const maxString = buf.toString('binary'); assert.equal(maxString.length, kStringMaxLength); test/addons/stringbytes-external-exceed-max/test-stringbytes-external-exceed-max-by-1-ascii.js000644 000766 000024 00000001703 13070706736 034727 0ustar00iojsstaff000000 000000 node-v4.8.2'use strict'; const common = require('../../common'); const binding = require(`./build/${common.buildType}/binding`); const assert = require('assert'); const skipMessage = 'intensive toString tests due to memory confinements'; if (!common.enoughTestMem) { common.skip(skipMessage); return; } // v8 fails silently if string length > v8::String::kMaxLength // v8::String::kMaxLength defined in v8.h const kStringMaxLength = process.binding('buffer').kStringMaxLength; try { var buf = new Buffer(kStringMaxLength + 1); } catch (e) { // If the exception is not due to memory confinement then rethrow it. if (e.message !== 'Invalid array buffer length') throw (e); common.skip(skipMessage); return; } // Ensure we have enough memory available for future allocations to succeed. if (!binding.ensureAllocation(2 * kStringMaxLength)) { common.skip(skipMessage); return; } assert.throws(function() { buf.toString('ascii'); }, /toString failed/); test/addons/stringbytes-external-exceed-max/test-stringbytes-external-exceed-max-by-1-base64.js000644 000766 000024 00000001704 13070706736 034724 0ustar00iojsstaff000000 000000 node-v4.8.2'use strict'; const common = require('../../common'); const binding = require(`./build/${common.buildType}/binding`); const assert = require('assert'); const skipMessage = 'intensive toString tests due to memory confinements'; if (!common.enoughTestMem) { common.skip(skipMessage); return; } // v8 fails silently if string length > v8::String::kMaxLength // v8::String::kMaxLength defined in v8.h const kStringMaxLength = process.binding('buffer').kStringMaxLength; try { var buf = new Buffer(kStringMaxLength + 1); } catch (e) { // If the exception is not due to memory confinement then rethrow it. if (e.message !== 'Invalid array buffer length') throw (e); common.skip(skipMessage); return; } // Ensure we have enough memory available for future allocations to succeed. if (!binding.ensureAllocation(2 * kStringMaxLength)) { common.skip(skipMessage); return; } assert.throws(function() { buf.toString('base64'); }, /toString failed/); test/addons/stringbytes-external-exceed-max/test-stringbytes-external-exceed-max-by-1-binary.js000644 000766 000024 00000002353 13070706736 035125 0ustar00iojsstaff000000 000000 node-v4.8.2'use strict'; const common = require('../../common'); const binding = require(`./build/${common.buildType}/binding`); const assert = require('assert'); const skipMessage = 'intensive toString tests due to memory confinements'; if (!common.enoughTestMem) { common.skip(skipMessage); return; } // v8 fails silently if string length > v8::String::kMaxLength // v8::String::kMaxLength defined in v8.h const kStringMaxLength = process.binding('buffer').kStringMaxLength; try { var buf = new Buffer(kStringMaxLength + 1); } catch (e) { // If the exception is not due to memory confinement then rethrow it. if (e.message !== 'Invalid array buffer length') throw (e); common.skip(skipMessage); return; } // Ensure we have enough memory available for future allocations to succeed. if (!binding.ensureAllocation(2 * kStringMaxLength)) { common.skip(skipMessage); return; } assert.throws(function() { buf.toString('binary'); }, /toString failed/); var maxString = buf.toString('binary', 1); assert.equal(maxString.length, kStringMaxLength); // Free the memory early instead of at the end of the next assignment maxString = undefined; maxString = buf.toString('binary', 0, kStringMaxLength); assert.equal(maxString.length, kStringMaxLength); test/addons/stringbytes-external-exceed-max/test-stringbytes-external-exceed-max-by-1-hex.js000644 000766 000024 00000001701 13070706736 034421 0ustar00iojsstaff000000 000000 node-v4.8.2'use strict'; const common = require('../../common'); const binding = require(`./build/${common.buildType}/binding`); const assert = require('assert'); const skipMessage = 'intensive toString tests due to memory confinements'; if (!common.enoughTestMem) { common.skip(skipMessage); return; } // v8 fails silently if string length > v8::String::kMaxLength // v8::String::kMaxLength defined in v8.h const kStringMaxLength = process.binding('buffer').kStringMaxLength; try { var buf = new Buffer(kStringMaxLength + 1); } catch (e) { // If the exception is not due to memory confinement then rethrow it. if (e.message !== 'Invalid array buffer length') throw (e); common.skip(skipMessage); return; } // Ensure we have enough memory available for future allocations to succeed. if (!binding.ensureAllocation(2 * kStringMaxLength)) { common.skip(skipMessage); return; } assert.throws(function() { buf.toString('hex'); }, /toString failed/); test/addons/stringbytes-external-exceed-max/test-stringbytes-external-exceed-max-by-1-utf8.js000644 000766 000024 00000002043 13070706736 034523 0ustar00iojsstaff000000 000000 node-v4.8.2'use strict'; const common = require('../../common'); const binding = require(`./build/${common.buildType}/binding`); const assert = require('assert'); const skipMessage = 'intensive toString tests due to memory confinements'; if (!common.enoughTestMem) { common.skip(skipMessage); return; } // v8 fails silently if string length > v8::String::kMaxLength // v8::String::kMaxLength defined in v8.h const kStringMaxLength = process.binding('buffer').kStringMaxLength; try { var buf = new Buffer(kStringMaxLength + 1); } catch (e) { // If the exception is not due to memory confinement then rethrow it. if (e.message !== 'Invalid array buffer length') throw (e); common.skip(skipMessage); return; } // Ensure we have enough memory available for future allocations to succeed. if (!binding.ensureAllocation(2 * kStringMaxLength)) { common.skip(skipMessage); return; } assert.throws(function() { buf.toString(); }, /toString failed|Invalid array buffer length/); assert.throws(function() { buf.toString('utf8'); }, /toString failed/); node-v4.8.2/test/addons/stringbytes-external-exceed-max/test-stringbytes-external-exceed-max-by-2.js000644 000766 000024 00000001737 13070706736 033730 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../../common'); const binding = require(`./build/${common.buildType}/binding`); const assert = require('assert'); const skipMessage = 'intensive toString tests due to memory confinements'; if (!common.enoughTestMem) { common.skip(skipMessage); return; } // v8 fails silently if string length > v8::String::kMaxLength // v8::String::kMaxLength defined in v8.h const kStringMaxLength = process.binding('buffer').kStringMaxLength; try { var buf = new Buffer(kStringMaxLength + 2); } catch (e) { // If the exception is not due to memory confinement then rethrow it. if (e.message !== 'Invalid array buffer length') throw (e); common.skip(skipMessage); return; } // Ensure we have enough memory available for future allocations to succeed. if (!binding.ensureAllocation(2 * kStringMaxLength)) { common.skip(skipMessage); return; } const maxString = buf.toString('utf16le'); assert.equal(maxString.length, (kStringMaxLength + 2) / 2); node-v4.8.2/test/addons/stringbytes-external-exceed-max/test-stringbytes-external-exceed-max.js000644 000766 000024 00000001711 13070706736 033151 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../../common'); const binding = require(`./build/${common.buildType}/binding`); const assert = require('assert'); const skipMessage = 'intensive toString tests due to memory confinements'; if (!common.enoughTestMem) { common.skip(skipMessage); return; } // v8 fails silently if string length > v8::String::kMaxLength // v8::String::kMaxLength defined in v8.h const kStringMaxLength = process.binding('buffer').kStringMaxLength; try { var buf = new Buffer(kStringMaxLength * 2 + 2); } catch (e) { // If the exception is not due to memory confinement then rethrow it. if (e.message !== 'Invalid array buffer length') throw (e); common.skip(skipMessage); return; } // Ensure we have enough memory available for future allocations to succeed. if (!binding.ensureAllocation(2 * kStringMaxLength)) { common.skip(skipMessage); return; } assert.throws(function() { buf.toString('utf16le'); }, /toString failed/); node-v4.8.2/test/addons/repl-domain-abort/binding.cc000644 000766 000024 00000001140 13070706736 022441 0ustar00iojsstaff000000 000000 #include #include using v8::Function; using v8::FunctionCallbackInfo; using v8::Local; using v8::HandleScope; using v8::Isolate; using v8::Object; using v8::Value; void Method(const FunctionCallbackInfo& args) { Isolate* isolate = args.GetIsolate(); HandleScope scope(isolate); node::MakeCallback(isolate, isolate->GetCurrentContext()->Global(), args[0].As(), 0, NULL); } void init(Local target) { NODE_SET_METHOD(target, "method", Method); } NODE_MODULE(binding, init); node-v4.8.2/test/addons/repl-domain-abort/binding.gyp000644 000766 000024 00000000227 13070706736 022660 0ustar00iojsstaff000000 000000 { 'targets': [ { 'target_name': 'binding', 'defines': [ 'V8_DEPRECATION_WARNINGS=1' ], 'sources': [ 'binding.cc' ] } ] } node-v4.8.2/test/addons/repl-domain-abort/test.js000644 000766 000024 00000002355 13070706736 022046 0ustar00iojsstaff000000 000000 'use strict'; var common = require('../../common'); var assert = require('assert'); var repl = require('repl'); var stream = require('stream'); var path = require('path'); var buildType = process.config.target_defaults.default_configuration; var buildPath = path.join(__dirname, 'build', buildType, 'binding'); // On Windows, escape backslashes in the path before passing it to REPL. if (common.isWindows) buildPath = buildPath.replace(/\\/g, '/'); var cb_ran = false; process.on('exit', function() { assert(cb_ran); console.log('ok'); }); var lines = [ // This line shouldn't cause an assertion error. 'require(\'' + buildPath + '\')' + // Log output to double check callback ran. '.method(function() { console.log(\'cb_ran\'); });', ]; var dInput = new stream.Readable(); var dOutput = new stream.Writable(); dInput._read = function _read(size) { while (lines.length > 0 && this.push(lines.shift())); if (lines.length === 0) this.push(null); }; dOutput._write = function _write(chunk, encoding, cb) { if (chunk.toString().indexOf('cb_ran') === 0) cb_ran = true; cb(); }; var options = { input: dInput, output: dOutput, terminal: false, ignoreUndefined: true }; // Run commands from fake REPL. repl.start(options); node-v4.8.2/test/addons/openssl-binding/binding.cc000644 000766 000024 00000002222 13070706736 022222 0ustar00iojsstaff000000 000000 #include "node.h" #include "../../../src/util.h" #include "../../../src/util-inl.h" #include #include namespace { inline void RandomBytes(const v8::FunctionCallbackInfo& info) { assert(info[0]->IsArrayBufferView()); auto view = info[0].As(); auto byte_offset = view->ByteOffset(); auto byte_length = view->ByteLength(); assert(view->HasBuffer()); auto buffer = view->Buffer(); auto contents = buffer->GetContents(); auto data = static_cast(contents.Data()) + byte_offset; assert(RAND_poll()); auto rval = RAND_bytes(data, static_cast(byte_length)); info.GetReturnValue().Set(rval > 0); } inline void Initialize(v8::Local exports, v8::Local module, v8::Local context) { auto isolate = context->GetIsolate(); auto key = v8::String::NewFromUtf8(isolate, "randomBytes"); auto value = v8::FunctionTemplate::New(isolate, RandomBytes)->GetFunction(); assert(exports->Set(context, key, value).IsJust()); } } // anonymous namespace NODE_MODULE_CONTEXT_AWARE(binding, Initialize) node-v4.8.2/test/addons/openssl-binding/binding.gyp000644 000766 000024 00000000246 13070706736 022440 0ustar00iojsstaff000000 000000 { 'targets': [ { 'target_name': 'binding', 'sources': ['binding.cc'], 'include_dirs': ['../../../deps/openssl/openssl/include'], }, ] } node-v4.8.2/test/addons/openssl-binding/test.js000644 000766 000024 00000000414 13070706736 021617 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../../common'); const assert = require('assert'); const binding = require(`./build/${common.buildType}/binding`); const bytes = new Uint8Array(1024); assert(binding.randomBytes(bytes)); assert(bytes.reduce((v, a) => v + a) > 0); node-v4.8.2/test/addons/new-target/binding.cc000644 000766 000024 00000000633 13070706736 021210 0ustar00iojsstaff000000 000000 #include #include namespace { inline void NewClass(const v8::FunctionCallbackInfo&) {} inline void Initialize(v8::Local binding) { auto isolate = binding->GetIsolate(); binding->Set(v8::String::NewFromUtf8(isolate, "Class"), v8::FunctionTemplate::New(isolate, NewClass)->GetFunction()); } NODE_MODULE(binding, Initialize) } // anonymous namespace node-v4.8.2/test/addons/new-target/binding.gyp000644 000766 000024 00000000227 13070706736 021421 0ustar00iojsstaff000000 000000 { 'targets': [ { 'target_name': 'binding', 'defines': [ 'V8_DEPRECATION_WARNINGS=1' ], 'sources': [ 'binding.cc' ] } ] } node-v4.8.2/test/addons/new-target/test.js000644 000766 000024 00000000550 13070706736 020602 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../../common'); const assert = require('assert'); const binding = require(`./build/${common.buildType}/binding`); class Class extends binding.Class { constructor() { super(); this.method(); } method() { this.ok = true; } } assert.ok(new Class() instanceof binding.Class); assert.ok(new Class().ok); node-v4.8.2/test/addons/make-callback-recurse/binding.cc000644 000766 000024 00000001242 13070706736 023245 0ustar00iojsstaff000000 000000 #include "node.h" #include "v8.h" #include "../../../src/util.h" using v8::Function; using v8::FunctionCallbackInfo; using v8::Isolate; using v8::Local; using v8::Object; using v8::Value; namespace { void MakeCallback(const FunctionCallbackInfo& args) { CHECK(args[0]->IsObject()); CHECK(args[1]->IsFunction()); Isolate* isolate = args.GetIsolate(); Local recv = args[0].As(); Local method = args[1].As(); node::MakeCallback(isolate, recv, method, 0, nullptr); } void Initialize(Local target) { NODE_SET_METHOD(target, "makeCallback", MakeCallback); } } // namespace NODE_MODULE(binding, Initialize) node-v4.8.2/test/addons/make-callback-recurse/binding.gyp000644 000766 000024 00000000227 13070706736 023461 0ustar00iojsstaff000000 000000 { 'targets': [ { 'target_name': 'binding', 'defines': [ 'V8_DEPRECATION_WARNINGS=1' ], 'sources': [ 'binding.cc' ] } ] } node-v4.8.2/test/addons/make-callback-recurse/test.js000644 000766 000024 00000012742 13070706736 022650 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../../common'); const assert = require('assert'); const domain = require('domain'); const binding = require(`./build/${common.buildType}/binding`); const makeCallback = binding.makeCallback; // Make sure this is run in the future. const mustCallCheckDomains = common.mustCall(checkDomains); // Make sure that using MakeCallback allows the error to propagate. assert.throws(function() { makeCallback({}, function() { throw new Error('hi from domain error'); }); }); // Check the execution order of the nextTickQueue and MicrotaskQueue in // relation to running multiple MakeCallback's from bootstrap, // node::MakeCallback() and node::AsyncWrap::MakeCallback(). // TODO(trevnorris): Is there a way to verify this is being run during // bootstrap? (function verifyExecutionOrder(arg) { const results_arr = []; // Processing of the MicrotaskQueue is manually handled by node. They are not // processed until after the nextTickQueue has been processed. Promise.resolve(1).then(common.mustCall(function() { results_arr.push(7); })); // The nextTick should run after all immediately invoked calls. process.nextTick(common.mustCall(function() { results_arr.push(3); // Run same test again but while processing the nextTickQueue to make sure // the following MakeCallback call breaks in the middle of processing the // queue and allows the script to run normally. process.nextTick(common.mustCall(function() { results_arr.push(6); })); makeCallback({}, common.mustCall(function() { results_arr.push(4); })); results_arr.push(5); })); results_arr.push(0); // MakeCallback is calling the function immediately, but should then detect // that a script is already in the middle of execution and return before // either the nextTickQueue or MicrotaskQueue are processed. makeCallback({}, common.mustCall(function() { results_arr.push(1); })); // This should run before either the nextTickQueue or MicrotaskQueue are // processed. Previously MakeCallback would not detect this circumstance // and process them immediately. results_arr.push(2); setImmediate(common.mustCall(function() { for (var i = 0; i < results_arr.length; i++) { assert.equal(results_arr[i], i, `verifyExecutionOrder(${arg}) results: ${results_arr}`); } if (arg === 1) { // The tests are first run on bootstrap during LoadEnvironment() in // src/node.cc. Now run the tests through node::MakeCallback(). setImmediate(function() { makeCallback({}, common.mustCall(function() { verifyExecutionOrder(2); })); }); } else if (arg === 2) { // setTimeout runs via the TimerWrap, which runs through // AsyncWrap::MakeCallback(). Make sure there are no conflicts using // node::MakeCallback() within it. setTimeout(common.mustCall(function() { verifyExecutionOrder(3); }), 10); } else if (arg === 3) { mustCallCheckDomains(); } else { throw new Error('UNREACHABLE'); } })); }(1)); function checkDomains() { // Check that domains are properly entered/exited when called in multiple // levels from both node::MakeCallback() and AsyncWrap::MakeCallback setImmediate(common.mustCall(function() { const d1 = domain.create(); const d2 = domain.create(); const d3 = domain.create(); makeCallback({ domain: d1 }, common.mustCall(function() { assert.equal(d1, process.domain); makeCallback({ domain: d2 }, common.mustCall(function() { assert.equal(d2, process.domain); makeCallback({ domain: d3 }, common.mustCall(function() { assert.equal(d3, process.domain); })); assert.equal(d2, process.domain); })); assert.equal(d1, process.domain); })); })); setTimeout(common.mustCall(function() { const d1 = domain.create(); const d2 = domain.create(); const d3 = domain.create(); makeCallback({ domain: d1 }, common.mustCall(function() { assert.equal(d1, process.domain); makeCallback({ domain: d2 }, common.mustCall(function() { assert.equal(d2, process.domain); makeCallback({ domain: d3 }, common.mustCall(function() { assert.equal(d3, process.domain); })); assert.equal(d2, process.domain); })); assert.equal(d1, process.domain); })); }), 1); // Make sure nextTick, setImmediate and setTimeout can all recover properly // after a thrown makeCallback call. process.nextTick(common.mustCall(function() { const d = domain.create(); d.on('error', common.mustCall(function(e) { assert.equal(e.message, 'throw from domain 3'); })); makeCallback({ domain: d }, function() { throw new Error('throw from domain 3'); }); throw new Error('UNREACHABLE'); })); setImmediate(common.mustCall(function() { const d = domain.create(); d.on('error', common.mustCall(function(e) { assert.equal(e.message, 'throw from domain 2'); })); makeCallback({ domain: d }, function() { throw new Error('throw from domain 2'); }); throw new Error('UNREACHABLE'); })); setTimeout(common.mustCall(function() { const d = domain.create(); d.on('error', common.mustCall(function(e) { assert.equal(e.message, 'throw from domain 1'); })); makeCallback({ domain: d }, function() { throw new Error('throw from domain 1'); }); throw new Error('UNREACHABLE'); })); } node-v4.8.2/test/addons/make-callback/binding.cc000644 000766 000024 00000002063 13070706736 021601 0ustar00iojsstaff000000 000000 #include "node.h" #include "v8.h" #include "../../../src/util.h" #include namespace { void MakeCallback(const v8::FunctionCallbackInfo& args) { CHECK(args[0]->IsObject()); CHECK(args[1]->IsFunction() || args[1]->IsString()); auto isolate = args.GetIsolate(); auto recv = args[0].As(); std::vector> argv; for (size_t n = 2; n < static_cast(args.Length()); n += 1) { argv.push_back(args[n]); } v8::Local result; if (args[1]->IsFunction()) { auto method = args[1].As(); result = node::MakeCallback(isolate, recv, method, argv.size(), argv.data()); } else if (args[1]->IsString()) { auto method = args[1].As(); result = node::MakeCallback(isolate, recv, method, argv.size(), argv.data()); } else { UNREACHABLE(); } args.GetReturnValue().Set(result); } void Initialize(v8::Local target) { NODE_SET_METHOD(target, "makeCallback", MakeCallback); } } // namespace NODE_MODULE(binding, Initialize) node-v4.8.2/test/addons/make-callback/binding.gyp000644 000766 000024 00000000227 13070706736 022013 0ustar00iojsstaff000000 000000 { 'targets': [ { 'target_name': 'binding', 'defines': [ 'V8_DEPRECATION_WARNINGS=1' ], 'sources': [ 'binding.cc' ] } ] } node-v4.8.2/test/addons/make-callback/test.js000644 000766 000024 00000003214 13070706736 021174 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../../common'); const assert = require('assert'); const vm = require('vm'); const binding = require(`./build/${common.buildType}/binding`); const makeCallback = binding.makeCallback; assert.strictEqual(42, makeCallback(process, common.mustCall(function() { assert.strictEqual(0, arguments.length); assert.strictEqual(this, process); return 42; }))); assert.strictEqual(42, makeCallback(process, common.mustCall(function(x) { assert.strictEqual(1, arguments.length); assert.strictEqual(this, process); assert.strictEqual(x, 1337); return 42; }), 1337)); const recv = { one: common.mustCall(function() { assert.strictEqual(0, arguments.length); assert.strictEqual(this, recv); return 42; }), two: common.mustCall(function(x) { assert.strictEqual(1, arguments.length); assert.strictEqual(this, recv); assert.strictEqual(x, 1337); return 42; }), }; assert.strictEqual(42, makeCallback(recv, 'one')); assert.strictEqual(42, makeCallback(recv, 'two', 1337)); // Check that the callback is made in the context of the receiver. const target = vm.runInNewContext(` (function($Object) { if (Object === $Object) throw new Error('bad'); return Object; }) `); assert.notStrictEqual(Object, makeCallback(process, target, Object)); // Runs in inner context. const forward = vm.runInNewContext(` (function(forward) { return forward(Object); }) `); // Runs in outer context. const endpoint = function($Object) { if (Object === $Object) throw new Error('bad'); return Object; }; assert.strictEqual(Object, makeCallback(process, forward, endpoint)); node-v4.8.2/test/addons/load-long-path/binding.cc000644 000766 000024 00000000516 13070706736 021741 0ustar00iojsstaff000000 000000 #include #include void Method(const v8::FunctionCallbackInfo& args) { v8::Isolate* isolate = args.GetIsolate(); args.GetReturnValue().Set(v8::String::NewFromUtf8(isolate, "world")); } void init(v8::Local target) { NODE_SET_METHOD(target, "hello", Method); } NODE_MODULE(binding, init); node-v4.8.2/test/addons/load-long-path/binding.gyp000644 000766 000024 00000000227 13070706736 022152 0ustar00iojsstaff000000 000000 { 'targets': [ { 'target_name': 'binding', 'defines': [ 'V8_DEPRECATION_WARNINGS=1' ], 'sources': [ 'binding.cc' ] } ] } node-v4.8.2/test/addons/load-long-path/test.js000644 000766 000024 00000002176 13070706736 021341 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../../common'); const fs = require('fs'); const path = require('path'); const assert = require('assert'); if (common.isWOW64) { common.skip('doesn\'t work on WOW64'); return; } common.refreshTmpDir(); // make a path that is more than 260 chars long. // Any given folder cannot have a name longer than 260 characters, // so create 10 nested folders each with 30 character long names. var addonDestinationDir = path.resolve(common.tmpDir); for (var i = 0; i < 10; i++) { addonDestinationDir = path.join(addonDestinationDir, 'x'.repeat(30)); fs.mkdirSync(addonDestinationDir); } const addonPath = path.join(__dirname, 'build', common.buildType, 'binding.node'); const addonDestinationPath = path.join(addonDestinationDir, 'binding.node'); // Copy binary to long path destination var contents = fs.readFileSync(addonPath); fs.writeFileSync(addonDestinationPath, contents); // Attempt to load at long path destination var addon = require(addonDestinationPath); assert(addon != null); assert(addon.hello() == 'world'); node-v4.8.2/test/addons/hello-world-function-export/binding.cc000644 000766 000024 00000000621 13070706736 024522 0ustar00iojsstaff000000 000000 #include #include void Method(const v8::FunctionCallbackInfo& args) { v8::Isolate* isolate = args.GetIsolate(); v8::HandleScope scope(isolate); args.GetReturnValue().Set(v8::String::NewFromUtf8(isolate, "world")); } void init(v8::Local exports, v8::Local module) { NODE_SET_METHOD(module, "exports", Method); } NODE_MODULE(binding, init); node-v4.8.2/test/addons/hello-world-function-export/binding.gyp000644 000766 000024 00000000227 13070706736 024736 0ustar00iojsstaff000000 000000 { 'targets': [ { 'target_name': 'binding', 'defines': [ 'V8_DEPRECATION_WARNINGS=1' ], 'sources': [ 'binding.cc' ] } ] } node-v4.8.2/test/addons/hello-world-function-export/test.js000644 000766 000024 00000000345 13070706736 024121 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../../common'); var assert = require('assert'); const binding = require(`./build/${common.buildType}/binding`); assert.equal('world', binding()); console.log('binding.hello() =', binding()); node-v4.8.2/test/addons/hello-world/binding.cc000644 000766 000024 00000000560 13070706736 021362 0ustar00iojsstaff000000 000000 #include #include void Method(const v8::FunctionCallbackInfo& args) { v8::Isolate* isolate = args.GetIsolate(); v8::HandleScope scope(isolate); args.GetReturnValue().Set(v8::String::NewFromUtf8(isolate, "world")); } void init(v8::Local target) { NODE_SET_METHOD(target, "hello", Method); } NODE_MODULE(binding, init); node-v4.8.2/test/addons/hello-world/binding.gyp000644 000766 000024 00000000227 13070706736 021574 0ustar00iojsstaff000000 000000 { 'targets': [ { 'target_name': 'binding', 'defines': [ 'V8_DEPRECATION_WARNINGS=1' ], 'sources': [ 'binding.cc' ] } ] } node-v4.8.2/test/addons/hello-world/test.js000644 000766 000024 00000000361 13070706736 020755 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../../common'); var assert = require('assert'); const binding = require(`./build/${common.buildType}/binding`); assert.equal('world', binding.hello()); console.log('binding.hello() =', binding.hello()); node-v4.8.2/test/addons/heap-profiler/binding.cc000644 000766 000024 00000001571 13070706736 021672 0ustar00iojsstaff000000 000000 #include "node.h" #include "v8.h" #include "v8-profiler.h" namespace { inline void Test(const v8::FunctionCallbackInfo& args) { v8::Isolate* const isolate = args.GetIsolate(); const v8::HeapSnapshot* const heap_snapshot = isolate->GetHeapProfiler()->TakeHeapSnapshot(); struct : public v8::OutputStream { WriteResult WriteAsciiChunk(char*, int) override { return kContinue; } void EndOfStream() override {} } output_stream; heap_snapshot->Serialize(&output_stream, v8::HeapSnapshot::kJSON); const_cast(heap_snapshot)->Delete(); } inline void Initialize(v8::Local binding) { v8::Isolate* const isolate = binding->GetIsolate(); binding->Set(v8::String::NewFromUtf8(isolate, "test"), v8::FunctionTemplate::New(isolate, Test)->GetFunction()); } NODE_MODULE(test, Initialize) } // anonymous namespace node-v4.8.2/test/addons/heap-profiler/binding.gyp000644 000766 000024 00000000275 13070706736 022104 0ustar00iojsstaff000000 000000 { 'targets': [ { 'target_name': 'binding', 'defines': [ 'V8_DEPRECATION_WARNINGS=1' ], 'sources': [ 'binding.cc' ], 'win_delay_load_hook': 'false' } ] } node-v4.8.2/test/addons/heap-profiler/test.js000644 000766 000024 00000000434 13070706736 021263 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../../common'); const binding = require(`./build/${common.buildType}/binding`); // Create an AsyncWrap object. const timer = setTimeout(function() {}, 1); timer.unref(); // Stress-test the heap profiler. binding.test(); clearTimeout(timer); node-v4.8.2/test/addons/buffer-free-callback/binding.cc000644 000766 000024 00000001526 13070706736 023057 0ustar00iojsstaff000000 000000 #include #include #include #include static int alive; static char buf[1024]; static void FreeCallback(char* data, void* hint) { alive--; } void Alloc(const v8::FunctionCallbackInfo& args) { v8::Isolate* isolate = args.GetIsolate(); alive++; args.GetReturnValue().Set(node::Buffer::New( isolate, buf, args[0]->IntegerValue(), FreeCallback, nullptr).ToLocalChecked()); } void Check(const v8::FunctionCallbackInfo& args) { v8::Isolate* isolate = args.GetIsolate(); isolate->RequestGarbageCollectionForTesting( v8::Isolate::kFullGarbageCollection); CHECK_GT(alive, 0); } void init(v8::Local target) { NODE_SET_METHOD(target, "alloc", Alloc); NODE_SET_METHOD(target, "check", Check); } NODE_MODULE(binding, init); node-v4.8.2/test/addons/buffer-free-callback/binding.gyp000644 000766 000024 00000000227 13070706736 023266 0ustar00iojsstaff000000 000000 { 'targets': [ { 'target_name': 'binding', 'defines': [ 'V8_DEPRECATION_WARNINGS=1' ], 'sources': [ 'binding.cc' ] } ] } node-v4.8.2/test/addons/buffer-free-callback/test.js000644 000766 000024 00000000617 13070706736 022453 0ustar00iojsstaff000000 000000 'use strict'; // Flags: --expose-gc const common = require('../../common'); const binding = require(`./build/${common.buildType}/binding`); function check(size) { var buf = binding.alloc(size); var slice = buf.slice(size >>> 1); buf = null; binding.check(slice); slice = null; gc(); gc(); gc(); } check(64); // Empty ArrayBuffer does not allocate data, worth checking check(0); node-v4.8.2/test/addons/at-exit/binding.cc000644 000766 000024 00000001747 13070706736 020515 0ustar00iojsstaff000000 000000 #undef NDEBUG #include #include #include #include using node::AtExit; using v8::HandleScope; using v8::Isolate; using v8::Local; using v8::Object; static char cookie[] = "yum yum"; static int at_exit_cb1_called = 0; static int at_exit_cb2_called = 0; static void at_exit_cb1(void* arg) { Isolate* isolate = static_cast(arg); HandleScope handle_scope(isolate); Local obj = Object::New(isolate); assert(!obj.IsEmpty()); // Assert VM is still alive. assert(obj->IsObject()); at_exit_cb1_called++; } static void at_exit_cb2(void* arg) { assert(arg == static_cast(cookie)); at_exit_cb2_called++; } static void sanity_check(void) { assert(at_exit_cb1_called == 1); assert(at_exit_cb2_called == 2); } void init(Local target) { AtExit(at_exit_cb1, target->CreationContext()->GetIsolate()); AtExit(at_exit_cb2, cookie); AtExit(at_exit_cb2, cookie); atexit(sanity_check); } NODE_MODULE(binding, init); node-v4.8.2/test/addons/at-exit/binding.gyp000644 000766 000024 00000000227 13070706736 020717 0ustar00iojsstaff000000 000000 { 'targets': [ { 'target_name': 'binding', 'defines': [ 'V8_DEPRECATION_WARNINGS=1' ], 'sources': [ 'binding.cc' ] } ] } node-v4.8.2/test/addons/at-exit/test.js000644 000766 000024 00000000146 13070706736 020101 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../../common'); require(`./build/${common.buildType}/binding`); node-v4.8.2/test/addons/async-hello-world/binding.cc000644 000766 000024 00000003364 13070706736 022502 0ustar00iojsstaff000000 000000 #include #include #include #if defined _WIN32 #include #else #include #endif struct async_req { uv_work_t req; int input; int output; v8::Isolate* isolate; v8::Persistent callback; }; void DoAsync(uv_work_t* r) { async_req* req = reinterpret_cast(r->data); // Simulate CPU intensive process... #if defined _WIN32 Sleep(1000); #else sleep(1); #endif req->output = req->input * 2; } void AfterAsync(uv_work_t* r) { async_req* req = reinterpret_cast(r->data); v8::Isolate* isolate = req->isolate; v8::HandleScope scope(isolate); v8::Local argv[2] = { v8::Null(isolate), v8::Integer::New(isolate, req->output) }; v8::TryCatch try_catch(isolate); v8::Local callback = v8::Local::New(isolate, req->callback); callback->Call(isolate->GetCurrentContext()->Global(), 2, argv); // cleanup req->callback.Reset(); delete req; if (try_catch.HasCaught()) { node::FatalException(isolate, try_catch); } } void Method(const v8::FunctionCallbackInfo& args) { v8::Isolate* isolate = args.GetIsolate(); v8::HandleScope scope(isolate); async_req* req = new async_req; req->req.data = req; req->input = args[0]->IntegerValue(); req->output = 0; req->isolate = isolate; v8::Local callback = v8::Local::Cast(args[1]); req->callback.Reset(isolate, callback); uv_queue_work(uv_default_loop(), &req->req, DoAsync, (uv_after_work_cb)AfterAsync); } void init(v8::Local exports, v8::Local module) { NODE_SET_METHOD(module, "exports", Method); } NODE_MODULE(binding, init); node-v4.8.2/test/addons/async-hello-world/binding.gyp000644 000766 000024 00000000227 13070706736 022707 0ustar00iojsstaff000000 000000 { 'targets': [ { 'target_name': 'binding', 'defines': [ 'V8_DEPRECATION_WARNINGS=1' ], 'sources': [ 'binding.cc' ] } ] } node-v4.8.2/test/addons/async-hello-world/test.js000644 000766 000024 00000000464 13070706736 022074 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../../common'); var assert = require('assert'); const binding = require(`./build/${common.buildType}/binding`); binding(5, common.mustCall(function(err, val) { assert.equal(null, err); assert.equal(10, val); process.nextTick(common.mustCall(function() {})); })); node-v4.8.2/test/abort/test-abort-uncaught-exception.js000644 000766 000024 00000001307 13070706736 023302 0ustar00iojsstaff000000 000000 'use strict'; const common = require('../common'); const assert = require('assert'); const spawn = require('child_process').spawn; const node = process.execPath; if (process.argv[2] === 'child') { throw new Error('child error'); } else { run('', null); run('--abort-on-uncaught-exception', 'SIGABRT'); } function run(flags, signal) { const args = [__filename, 'child']; if (flags) args.unshift(flags); const child = spawn(node, args); child.on('exit', common.mustCall(function(code, sig) { if (!common.isWindows) { assert.strictEqual(sig, signal); } else { if (signal) assert.strictEqual(code, 3); else assert.strictEqual(code, 1); } })); } node-v4.8.2/src/.eslintrc000644 000766 000024 00000000116 13070706736 015372 0ustar00iojsstaff000000 000000 # ECMAScript-6 # http://eslint.org/docs/rules/#ecmascript-6 prefer-template: 2node-v4.8.2/src/async-wrap-inl.h000644 000766 000024 00000002212 13070706736 016562 0ustar00iojsstaff000000 000000 #ifndef SRC_ASYNC_WRAP_INL_H_ #define SRC_ASYNC_WRAP_INL_H_ #include "async-wrap.h" #include "base-object.h" #include "base-object-inl.h" #include "env.h" #include "env-inl.h" #include "node_internals.h" #include "util.h" #include "util-inl.h" #include "v8.h" namespace node { inline bool AsyncWrap::ran_init_callback() const { return static_cast(bits_ & 1); } inline AsyncWrap::ProviderType AsyncWrap::provider_type() const { return static_cast(bits_ >> 1); } inline int64_t AsyncWrap::get_uid() const { return uid_; } inline v8::Local AsyncWrap::MakeCallback( const v8::Local symbol, int argc, v8::Local* argv) { v8::Local cb_v = object()->Get(symbol); CHECK(cb_v->IsFunction()); return MakeCallback(cb_v.As(), argc, argv); } inline v8::Local AsyncWrap::MakeCallback( uint32_t index, int argc, v8::Local* argv) { v8::Local cb_v = object()->Get(index); CHECK(cb_v->IsFunction()); return MakeCallback(cb_v.As(), argc, argv); } } // namespace node #endif // SRC_ASYNC_WRAP_INL_H_ node-v4.8.2/src/async-wrap.cc000644 000766 000024 00000026313 13070706736 016150 0ustar00iojsstaff000000 000000 #include "async-wrap.h" #include "async-wrap-inl.h" #include "env.h" #include "env-inl.h" #include "util.h" #include "util-inl.h" #include "uv.h" #include "v8.h" #include "v8-profiler.h" using v8::Array; using v8::Boolean; using v8::Context; using v8::Function; using v8::FunctionCallbackInfo; using v8::HandleScope; using v8::HeapProfiler; using v8::Int32; using v8::Integer; using v8::Isolate; using v8::Local; using v8::MaybeLocal; using v8::Number; using v8::Object; using v8::RetainedObjectInfo; using v8::TryCatch; using v8::Value; namespace node { static const char* const provider_names[] = { #define V(PROVIDER) \ #PROVIDER, NODE_ASYNC_PROVIDER_TYPES(V) #undef V }; class RetainedAsyncInfo: public RetainedObjectInfo { public: explicit RetainedAsyncInfo(uint16_t class_id, AsyncWrap* wrap); void Dispose() override; bool IsEquivalent(RetainedObjectInfo* other) override; intptr_t GetHash() override; const char* GetLabel() override; intptr_t GetSizeInBytes() override; private: const char* label_; const AsyncWrap* wrap_; const int length_; }; RetainedAsyncInfo::RetainedAsyncInfo(uint16_t class_id, AsyncWrap* wrap) : label_(provider_names[class_id - NODE_ASYNC_ID_OFFSET]), wrap_(wrap), length_(wrap->self_size()) { } void RetainedAsyncInfo::Dispose() { delete this; } bool RetainedAsyncInfo::IsEquivalent(RetainedObjectInfo* other) { return label_ == other->GetLabel() && wrap_ == static_cast(other)->wrap_; } intptr_t RetainedAsyncInfo::GetHash() { return reinterpret_cast(wrap_); } const char* RetainedAsyncInfo::GetLabel() { return label_; } intptr_t RetainedAsyncInfo::GetSizeInBytes() { return length_; } RetainedObjectInfo* WrapperInfo(uint16_t class_id, Local wrapper) { // No class_id should be the provider type of NONE. CHECK_NE(NODE_ASYNC_ID_OFFSET, class_id); CHECK(wrapper->IsObject()); CHECK(!wrapper.IsEmpty()); Local object = wrapper.As(); CHECK_GT(object->InternalFieldCount(), 0); AsyncWrap* wrap = Unwrap(object); CHECK_NE(nullptr, wrap); return new RetainedAsyncInfo(class_id, wrap); } // end RetainedAsyncInfo static void EnableHooksJS(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); Local init_fn = env->async_hooks_init_function(); if (init_fn.IsEmpty() || !init_fn->IsFunction()) return env->ThrowTypeError("init callback is not assigned to a function"); env->async_hooks()->set_enable_callbacks(1); } static void DisableHooksJS(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); env->async_hooks()->set_enable_callbacks(0); } static void SetupHooks(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); if (env->async_hooks()->callbacks_enabled()) return env->ThrowError("hooks should not be set while also enabled"); if (!args[0]->IsObject()) return env->ThrowTypeError("first argument must be an object"); Local fn_obj = args[0].As(); Local init_v = fn_obj->Get( env->context(), FIXED_ONE_BYTE_STRING(env->isolate(), "init")).ToLocalChecked(); Local pre_v = fn_obj->Get( env->context(), FIXED_ONE_BYTE_STRING(env->isolate(), "pre")).ToLocalChecked(); Local post_v = fn_obj->Get( env->context(), FIXED_ONE_BYTE_STRING(env->isolate(), "post")).ToLocalChecked(); Local destroy_v = fn_obj->Get( env->context(), FIXED_ONE_BYTE_STRING(env->isolate(), "destroy")).ToLocalChecked(); if (!init_v->IsFunction()) return env->ThrowTypeError("init callback must be a function"); env->set_async_hooks_init_function(init_v.As()); if (pre_v->IsFunction()) env->set_async_hooks_pre_function(pre_v.As()); if (post_v->IsFunction()) env->set_async_hooks_post_function(post_v.As()); if (destroy_v->IsFunction()) env->set_async_hooks_destroy_function(destroy_v.As()); } void AsyncWrap::Initialize(Local target, Local unused, Local context) { Environment* env = Environment::GetCurrent(context); Isolate* isolate = env->isolate(); HandleScope scope(isolate); env->SetMethod(target, "setupHooks", SetupHooks); env->SetMethod(target, "disable", DisableHooksJS); env->SetMethod(target, "enable", EnableHooksJS); Local async_providers = Object::New(isolate); #define V(PROVIDER) \ async_providers->Set(FIXED_ONE_BYTE_STRING(isolate, #PROVIDER), \ Integer::New(isolate, AsyncWrap::PROVIDER_ ## PROVIDER)); NODE_ASYNC_PROVIDER_TYPES(V) #undef V target->Set(FIXED_ONE_BYTE_STRING(isolate, "Providers"), async_providers); env->set_async_hooks_init_function(Local()); env->set_async_hooks_pre_function(Local()); env->set_async_hooks_post_function(Local()); env->set_async_hooks_destroy_function(Local()); } void AsyncWrap::DestroyIdsCb(uv_idle_t* handle) { uv_idle_stop(handle); Environment* env = Environment::from_destroy_ids_idle_handle(handle); // None of the V8 calls done outside the HandleScope leak a handle. If this // changes in the future then the SealHandleScope wrapping the uv_run() // will catch this can cause the process to abort. HandleScope handle_scope(env->isolate()); Context::Scope context_scope(env->context()); Local fn = env->async_hooks_destroy_function(); if (fn.IsEmpty()) return env->destroy_ids_list()->clear(); TryCatch try_catch(env->isolate()); for (auto current_id : *env->destroy_ids_list()) { // Want each callback to be cleaned up after itself, instead of cleaning // them all up after the while() loop completes. HandleScope scope(env->isolate()); Local argv = Number::New(env->isolate(), current_id); MaybeLocal ret = fn->Call( env->context(), Undefined(env->isolate()), 1, &argv); if (ret.IsEmpty()) { ClearFatalExceptionHandlers(env); FatalException(env->isolate(), try_catch); } } } void LoadAsyncWrapperInfo(Environment* env) { HeapProfiler* heap_profiler = env->isolate()->GetHeapProfiler(); #define V(PROVIDER) \ heap_profiler->SetWrapperClassInfoProvider( \ (NODE_ASYNC_ID_OFFSET + AsyncWrap::PROVIDER_ ## PROVIDER), WrapperInfo); NODE_ASYNC_PROVIDER_TYPES(V) #undef V } AsyncWrap::AsyncWrap(Environment* env, Local object, ProviderType provider, AsyncWrap* parent) : BaseObject(env, object), bits_(static_cast(provider) << 1), uid_(env->get_async_wrap_uid()) { CHECK_NE(provider, PROVIDER_NONE); CHECK_GE(object->InternalFieldCount(), 1); // Shift provider value over to prevent id collision. persistent().SetWrapperClassId(NODE_ASYNC_ID_OFFSET + provider); Local init_fn = env->async_hooks_init_function(); // No init callback exists, no reason to go on. if (init_fn.IsEmpty()) return; // If async wrap callbacks are disabled and no parent was passed that has // run the init callback then return. if (!env->async_wrap_callbacks_enabled() && (parent == nullptr || !parent->ran_init_callback())) return; HandleScope scope(env->isolate()); Local argv[] = { Number::New(env->isolate(), get_uid()), Int32::New(env->isolate(), provider), Null(env->isolate()), Null(env->isolate()) }; if (parent != nullptr) { argv[2] = Number::New(env->isolate(), parent->get_uid()); argv[3] = parent->object(); } TryCatch try_catch(env->isolate()); MaybeLocal ret = init_fn->Call(env->context(), object, arraysize(argv), argv); if (ret.IsEmpty()) { ClearFatalExceptionHandlers(env); FatalException(env->isolate(), try_catch); } bits_ |= 1; // ran_init_callback() is true now. } AsyncWrap::~AsyncWrap() { if (!ran_init_callback()) return; if (env()->destroy_ids_list()->empty()) uv_idle_start(env()->destroy_ids_idle_handle(), DestroyIdsCb); env()->destroy_ids_list()->push_back(get_uid()); } Local AsyncWrap::MakeCallback(const Local cb, int argc, Local* argv) { CHECK(env()->context() == env()->isolate()->GetCurrentContext()); Local pre_fn = env()->async_hooks_pre_function(); Local post_fn = env()->async_hooks_post_function(); Local uid = Number::New(env()->isolate(), get_uid()); Local context = object(); Local domain; bool has_domain = false; Environment::AsyncCallbackScope callback_scope(env()); if (env()->using_domains()) { Local domain_v = context->Get(env()->domain_string()); has_domain = domain_v->IsObject(); if (has_domain) { domain = domain_v.As(); if (domain->Get(env()->disposed_string())->IsTrue()) return Local(); } } if (has_domain) { Local enter_v = domain->Get(env()->enter_string()); if (enter_v->IsFunction()) { if (enter_v.As()->Call(domain, 0, nullptr).IsEmpty()) { FatalError("node::AsyncWrap::MakeCallback", "domain enter callback threw, please report this"); } } } if (ran_init_callback() && !pre_fn.IsEmpty()) { TryCatch try_catch(env()->isolate()); MaybeLocal ar = pre_fn->Call(env()->context(), context, 1, &uid); if (ar.IsEmpty()) { ClearFatalExceptionHandlers(env()); FatalException(env()->isolate(), try_catch); return Local(); } } Local ret = cb->Call(context, argc, argv); if (ran_init_callback() && !post_fn.IsEmpty()) { Local did_throw = Boolean::New(env()->isolate(), ret.IsEmpty()); Local vals[] = { uid, did_throw }; TryCatch try_catch(env()->isolate()); MaybeLocal ar = post_fn->Call(env()->context(), context, arraysize(vals), vals); if (ar.IsEmpty()) { ClearFatalExceptionHandlers(env()); FatalException(env()->isolate(), try_catch); return Local(); } } if (ret.IsEmpty()) { return ret; } if (has_domain) { Local exit_v = domain->Get(env()->exit_string()); if (exit_v->IsFunction()) { if (exit_v.As()->Call(domain, 0, nullptr).IsEmpty()) { FatalError("node::AsyncWrap::MakeCallback", "domain exit callback threw, please report this"); } } } if (callback_scope.in_makecallback()) { return ret; } Environment::TickInfo* tick_info = env()->tick_info(); if (tick_info->length() == 0) { env()->isolate()->RunMicrotasks(); } Local process = env()->process_object(); if (tick_info->length() == 0) { tick_info->set_index(0); return ret; } if (env()->tick_callback_function()->Call(process, 0, nullptr).IsEmpty()) { return Local(); } return ret; } } // namespace node NODE_MODULE_CONTEXT_AWARE_BUILTIN(async_wrap, node::AsyncWrap::Initialize) node-v4.8.2/src/async-wrap.h000644 000766 000024 00000007530 13070706736 016012 0ustar00iojsstaff000000 000000 #ifndef SRC_ASYNC_WRAP_H_ #define SRC_ASYNC_WRAP_H_ #include "base-object.h" #include "uv.h" #include "v8.h" #include namespace node { #define NODE_ASYNC_ID_OFFSET 0xA1C #define NODE_ASYNC_PROVIDER_TYPES(V) \ V(NONE) \ V(CRYPTO) \ V(FSEVENTWRAP) \ V(FSREQWRAP) \ V(GETADDRINFOREQWRAP) \ V(GETNAMEINFOREQWRAP) \ V(HTTPPARSER) \ V(JSSTREAM) \ V(PIPEWRAP) \ V(PIPECONNECTWRAP) \ V(PROCESSWRAP) \ V(QUERYWRAP) \ V(SHUTDOWNWRAP) \ V(SIGNALWRAP) \ V(STATWATCHER) \ V(TCPWRAP) \ V(TCPCONNECTWRAP) \ V(TIMERWRAP) \ V(TLSWRAP) \ V(TTYWRAP) \ V(UDPWRAP) \ V(UDPSENDWRAP) \ V(WRITEWRAP) \ V(ZLIB) class Environment; class AsyncWrap : public BaseObject { public: enum ProviderType { #define V(PROVIDER) \ PROVIDER_ ## PROVIDER, NODE_ASYNC_PROVIDER_TYPES(V) #undef V }; AsyncWrap(Environment* env, v8::Local object, ProviderType provider, AsyncWrap* parent = nullptr); virtual ~AsyncWrap(); static void Initialize(v8::Local target, v8::Local unused, v8::Local context); static void DestroyIdsCb(uv_idle_t* handle); inline ProviderType provider_type() const; inline int64_t get_uid() const; // Only call these within a valid HandleScope. v8::Local MakeCallback(const v8::Local cb, int argc, v8::Local* argv); inline v8::Local MakeCallback(const v8::Local symbol, int argc, v8::Local* argv); inline v8::Local MakeCallback(uint32_t index, int argc, v8::Local* argv); virtual size_t self_size() const = 0; private: inline AsyncWrap(); inline bool ran_init_callback() const; // When the async hooks init JS function is called from the constructor it is // expected the context object will receive a _asyncQueue object property // that will be used to call pre/post in MakeCallback. uint32_t bits_; const int64_t uid_; }; void LoadAsyncWrapperInfo(Environment* env); } // namespace node #endif // SRC_ASYNC_WRAP_H_ node-v4.8.2/src/base-object-inl.h000644 000766 000024 00000003061 13070706736 016657 0ustar00iojsstaff000000 000000 #ifndef SRC_BASE_OBJECT_INL_H_ #define SRC_BASE_OBJECT_INL_H_ #include "base-object.h" #include "env.h" #include "env-inl.h" #include "util.h" #include "util-inl.h" #include "v8.h" namespace node { inline BaseObject::BaseObject(Environment* env, v8::Local handle) : handle_(env->isolate(), handle), env_(env) { CHECK_EQ(false, handle.IsEmpty()); // The zero field holds a pointer to the handle. Immediately set it to // nullptr in case it's accessed by the user before construction is complete. if (handle->InternalFieldCount() > 0) handle->SetAlignedPointerInInternalField(0, nullptr); } inline BaseObject::~BaseObject() { CHECK(handle_.IsEmpty()); } inline v8::Persistent& BaseObject::persistent() { return handle_; } inline v8::Local BaseObject::object() { return PersistentToLocal(env_->isolate(), handle_); } inline Environment* BaseObject::env() const { return env_; } template inline void BaseObject::WeakCallback( const v8::WeakCallbackData& data) { Type* self = data.GetParameter(); self->persistent().Reset(); delete self; } template inline void BaseObject::MakeWeak(Type* ptr) { v8::HandleScope scope(env_->isolate()); v8::Local handle = object(); CHECK_GT(handle->InternalFieldCount(), 0); Wrap(handle, ptr); handle_.MarkIndependent(); handle_.SetWeak(ptr, WeakCallback); } inline void BaseObject::ClearWeak() { handle_.ClearWeak(); } } // namespace node #endif // SRC_BASE_OBJECT_INL_H_ node-v4.8.2/src/base-object.h000644 000766 000024 00000002611 13070706736 016077 0ustar00iojsstaff000000 000000 #ifndef SRC_BASE_OBJECT_H_ #define SRC_BASE_OBJECT_H_ #include "v8.h" namespace node { class Environment; class BaseObject { public: inline BaseObject(Environment* env, v8::Local handle); inline virtual ~BaseObject(); // Returns the wrapped object. Returns an empty handle when // persistent.IsEmpty() is true. inline v8::Local object(); // The parent class is responsible for calling .Reset() on destruction // when the persistent handle is strong because there is no way for // BaseObject to know when the handle goes out of scope. // Weak handles have been reset by the time the destructor runs but // calling .Reset() again is harmless. inline v8::Persistent& persistent(); inline Environment* env() const; // The handle_ must have an internal field count > 0, and the first // index is reserved for a pointer to this class. This is an // implicit requirement, but Node does not have a case where it's // required that MakeWeak() be called and the internal field not // be set. template inline void MakeWeak(Type* ptr); inline void ClearWeak(); private: BaseObject(); template static inline void WeakCallback( const v8::WeakCallbackData& data); v8::Persistent handle_; Environment* env_; }; } // namespace node #endif // SRC_BASE_OBJECT_H_ node-v4.8.2/src/cares_wrap.cc000644 000766 000024 00000113135 13070706736 016211 0ustar00iojsstaff000000 000000 #define CARES_STATICLIB #include "ares.h" #include "async-wrap.h" #include "async-wrap-inl.h" #include "env.h" #include "env-inl.h" #include "node.h" #include "req-wrap.h" #include "req-wrap-inl.h" #include "tree.h" #include "util.h" #include "util-inl.h" #include "uv.h" #include #include #include #if defined(__ANDROID__) || \ defined(__MINGW32__) || \ defined(__OpenBSD__) || \ defined(_MSC_VER) # include #else # include #endif #if defined(__OpenBSD__) # define AI_V4MAPPED 0 #endif namespace node { namespace cares_wrap { using v8::Array; using v8::Context; using v8::EscapableHandleScope; using v8::Function; using v8::FunctionCallbackInfo; using v8::FunctionTemplate; using v8::HandleScope; using v8::Integer; using v8::Local; using v8::Null; using v8::Object; using v8::String; using v8::Value; inline const char* ToErrorCodeString(int status) { switch (status) { #define V(code) case ARES_##code: return #code; V(EADDRGETNETWORKPARAMS) V(EBADFAMILY) V(EBADFLAGS) V(EBADHINTS) V(EBADNAME) V(EBADQUERY) V(EBADRESP) V(EBADSTR) V(ECANCELLED) V(ECONNREFUSED) V(EDESTRUCTION) V(EFILE) V(EFORMERR) V(ELOADIPHLPAPI) V(ENODATA) V(ENOMEM) V(ENONAME) V(ENOTFOUND) V(ENOTIMP) V(ENOTINITIALIZED) V(EOF) V(EREFUSED) V(ESERVFAIL) V(ETIMEOUT) #undef V } return "UNKNOWN_ARES_ERROR"; } class GetAddrInfoReqWrap : public ReqWrap { public: GetAddrInfoReqWrap(Environment* env, Local req_wrap_obj); size_t self_size() const override { return sizeof(*this); } }; GetAddrInfoReqWrap::GetAddrInfoReqWrap(Environment* env, Local req_wrap_obj) : ReqWrap(env, req_wrap_obj, AsyncWrap::PROVIDER_GETADDRINFOREQWRAP) { Wrap(req_wrap_obj, this); } static void NewGetAddrInfoReqWrap(const FunctionCallbackInfo& args) { CHECK(args.IsConstructCall()); } class GetNameInfoReqWrap : public ReqWrap { public: GetNameInfoReqWrap(Environment* env, Local req_wrap_obj); size_t self_size() const override { return sizeof(*this); } }; GetNameInfoReqWrap::GetNameInfoReqWrap(Environment* env, Local req_wrap_obj) : ReqWrap(env, req_wrap_obj, AsyncWrap::PROVIDER_GETNAMEINFOREQWRAP) { Wrap(req_wrap_obj, this); } static void NewGetNameInfoReqWrap(const FunctionCallbackInfo& args) { CHECK(args.IsConstructCall()); } static void NewQueryReqWrap(const FunctionCallbackInfo& args) { CHECK(args.IsConstructCall()); } static int cmp_ares_tasks(const node_ares_task* a, const node_ares_task* b) { if (a->sock < b->sock) return -1; if (a->sock > b->sock) return 1; return 0; } RB_GENERATE_STATIC(node_ares_task_list, node_ares_task, node, cmp_ares_tasks) /* This is called once per second by loop->timer. It is used to constantly */ /* call back into c-ares for possibly processing timeouts. */ static void ares_timeout(uv_timer_t* handle) { Environment* env = Environment::from_cares_timer_handle(handle); CHECK_EQ(false, RB_EMPTY(env->cares_task_list())); ares_process_fd(env->cares_channel(), ARES_SOCKET_BAD, ARES_SOCKET_BAD); } static void ares_poll_cb(uv_poll_t* watcher, int status, int events) { node_ares_task* task = ContainerOf(&node_ares_task::poll_watcher, watcher); Environment* env = task->env; /* Reset the idle timer */ uv_timer_again(env->cares_timer_handle()); if (status < 0) { /* An error happened. Just pretend that the socket is both readable and */ /* writable. */ ares_process_fd(env->cares_channel(), task->sock, task->sock); return; } /* Process DNS responses */ ares_process_fd(env->cares_channel(), events & UV_READABLE ? task->sock : ARES_SOCKET_BAD, events & UV_WRITABLE ? task->sock : ARES_SOCKET_BAD); } static void ares_poll_close_cb(uv_handle_t* watcher) { node_ares_task* task = ContainerOf(&node_ares_task::poll_watcher, reinterpret_cast(watcher)); free(task); } /* Allocates and returns a new node_ares_task */ static node_ares_task* ares_task_create(Environment* env, ares_socket_t sock) { node_ares_task* task = static_cast(node::Malloc(sizeof(*task))); if (task == nullptr) { /* Out of memory. */ return nullptr; } task->env = env; task->sock = sock; if (uv_poll_init_socket(env->event_loop(), &task->poll_watcher, sock) < 0) { /* This should never happen. */ free(task); return nullptr; } return task; } /* Callback from ares when socket operation is started */ static void ares_sockstate_cb(void* data, ares_socket_t sock, int read, int write) { Environment* env = static_cast(data); node_ares_task* task; node_ares_task lookup_task; lookup_task.sock = sock; task = RB_FIND(node_ares_task_list, env->cares_task_list(), &lookup_task); if (read || write) { if (!task) { /* New socket */ /* If this is the first socket then start the timer. */ uv_timer_t* timer_handle = env->cares_timer_handle(); if (!uv_is_active(reinterpret_cast(timer_handle))) { CHECK(RB_EMPTY(env->cares_task_list())); uv_timer_start(timer_handle, ares_timeout, 1000, 1000); } task = ares_task_create(env, sock); if (task == nullptr) { /* This should never happen unless we're out of memory or something */ /* is seriously wrong. The socket won't be polled, but the the query */ /* will eventually time out. */ return; } RB_INSERT(node_ares_task_list, env->cares_task_list(), task); } /* This should never fail. If it fails anyway, the query will eventually */ /* time out. */ uv_poll_start(&task->poll_watcher, (read ? UV_READABLE : 0) | (write ? UV_WRITABLE : 0), ares_poll_cb); } else { /* read == 0 and write == 0 this is c-ares's way of notifying us that */ /* the socket is now closed. We must free the data associated with */ /* socket. */ CHECK(task && "When an ares socket is closed we should have a handle for it"); RB_REMOVE(node_ares_task_list, env->cares_task_list(), task); uv_close(reinterpret_cast(&task->poll_watcher), ares_poll_close_cb); if (RB_EMPTY(env->cares_task_list())) { uv_timer_stop(env->cares_timer_handle()); } } } static Local HostentToAddresses(Environment* env, struct hostent* host) { EscapableHandleScope scope(env->isolate()); Local addresses = Array::New(env->isolate()); char ip[INET6_ADDRSTRLEN]; for (uint32_t i = 0; host->h_addr_list[i] != nullptr; ++i) { uv_inet_ntop(host->h_addrtype, host->h_addr_list[i], ip, sizeof(ip)); Local address = OneByteString(env->isolate(), ip); addresses->Set(i, address); } return scope.Escape(addresses); } static Local HostentToNames(Environment* env, struct hostent* host) { EscapableHandleScope scope(env->isolate()); Local names = Array::New(env->isolate()); for (uint32_t i = 0; host->h_aliases[i] != nullptr; ++i) { Local address = OneByteString(env->isolate(), host->h_aliases[i]); names->Set(i, address); } return scope.Escape(names); } class QueryWrap : public AsyncWrap { public: QueryWrap(Environment* env, Local req_wrap_obj) : AsyncWrap(env, req_wrap_obj, AsyncWrap::PROVIDER_QUERYWRAP) { if (env->in_domain()) req_wrap_obj->Set(env->domain_string(), env->domain_array()->Get(0)); } ~QueryWrap() override { CHECK_EQ(false, persistent().IsEmpty()); ClearWrap(object()); persistent().Reset(); } // Subclasses should implement the appropriate Send method. virtual int Send(const char* name) { UNREACHABLE(); return 0; } virtual int Send(const char* name, int family) { UNREACHABLE(); return 0; } protected: void* GetQueryArg() { return static_cast(this); } static void Callback(void *arg, int status, int timeouts, unsigned char* answer_buf, int answer_len) { QueryWrap* wrap = static_cast(arg); if (status != ARES_SUCCESS) { wrap->ParseError(status); } else { wrap->Parse(answer_buf, answer_len); } delete wrap; } static void Callback(void *arg, int status, int timeouts, struct hostent* host) { QueryWrap* wrap = static_cast(arg); if (status != ARES_SUCCESS) { wrap->ParseError(status); } else { wrap->Parse(host); } delete wrap; } void CallOnComplete(Local answer) { HandleScope handle_scope(env()->isolate()); Context::Scope context_scope(env()->context()); Local argv[] = { Integer::New(env()->isolate(), 0), answer }; MakeCallback(env()->oncomplete_string(), arraysize(argv), argv); } void CallOnComplete(Local answer, Local family) { HandleScope handle_scope(env()->isolate()); Context::Scope context_scope(env()->context()); Local argv[] = { Integer::New(env()->isolate(), 0), answer, family }; MakeCallback(env()->oncomplete_string(), arraysize(argv), argv); } void ParseError(int status) { CHECK_NE(status, ARES_SUCCESS); HandleScope handle_scope(env()->isolate()); Context::Scope context_scope(env()->context()); const char* code = ToErrorCodeString(status); Local arg = OneByteString(env()->isolate(), code); MakeCallback(env()->oncomplete_string(), 1, &arg); } // Subclasses should implement the appropriate Parse method. virtual void Parse(unsigned char* buf, int len) { UNREACHABLE(); } virtual void Parse(struct hostent* host) { UNREACHABLE(); } }; class QueryAWrap: public QueryWrap { public: QueryAWrap(Environment* env, Local req_wrap_obj) : QueryWrap(env, req_wrap_obj) { } int Send(const char* name) override { ares_query(env()->cares_channel(), name, ns_c_in, ns_t_a, Callback, GetQueryArg()); return 0; } size_t self_size() const override { return sizeof(*this); } protected: void Parse(unsigned char* buf, int len) override { HandleScope handle_scope(env()->isolate()); Context::Scope context_scope(env()->context()); struct hostent* host; int status = ares_parse_a_reply(buf, len, &host, nullptr, nullptr); if (status != ARES_SUCCESS) { ParseError(status); return; } Local addresses = HostentToAddresses(env(), host); ares_free_hostent(host); this->CallOnComplete(addresses); } }; class QueryAaaaWrap: public QueryWrap { public: QueryAaaaWrap(Environment* env, Local req_wrap_obj) : QueryWrap(env, req_wrap_obj) { } int Send(const char* name) override { ares_query(env()->cares_channel(), name, ns_c_in, ns_t_aaaa, Callback, GetQueryArg()); return 0; } size_t self_size() const override { return sizeof(*this); } protected: void Parse(unsigned char* buf, int len) override { HandleScope handle_scope(env()->isolate()); Context::Scope context_scope(env()->context()); struct hostent* host; int status = ares_parse_aaaa_reply(buf, len, &host, nullptr, nullptr); if (status != ARES_SUCCESS) { ParseError(status); return; } Local addresses = HostentToAddresses(env(), host); ares_free_hostent(host); this->CallOnComplete(addresses); } }; class QueryCnameWrap: public QueryWrap { public: QueryCnameWrap(Environment* env, Local req_wrap_obj) : QueryWrap(env, req_wrap_obj) { } int Send(const char* name) override { ares_query(env()->cares_channel(), name, ns_c_in, ns_t_cname, Callback, GetQueryArg()); return 0; } size_t self_size() const override { return sizeof(*this); } protected: void Parse(unsigned char* buf, int len) override { HandleScope handle_scope(env()->isolate()); Context::Scope context_scope(env()->context()); struct hostent* host; int status = ares_parse_a_reply(buf, len, &host, nullptr, nullptr); if (status != ARES_SUCCESS) { ParseError(status); return; } // A cname lookup always returns a single record but we follow the // common API here. Local result = Array::New(env()->isolate(), 1); result->Set(0, OneByteString(env()->isolate(), host->h_name)); ares_free_hostent(host); this->CallOnComplete(result); } }; class QueryMxWrap: public QueryWrap { public: QueryMxWrap(Environment* env, Local req_wrap_obj) : QueryWrap(env, req_wrap_obj) { } int Send(const char* name) override { ares_query(env()->cares_channel(), name, ns_c_in, ns_t_mx, Callback, GetQueryArg()); return 0; } size_t self_size() const override { return sizeof(*this); } protected: void Parse(unsigned char* buf, int len) override { HandleScope handle_scope(env()->isolate()); Context::Scope context_scope(env()->context()); struct ares_mx_reply* mx_start; int status = ares_parse_mx_reply(buf, len, &mx_start); if (status != ARES_SUCCESS) { ParseError(status); return; } Local mx_records = Array::New(env()->isolate()); Local exchange_symbol = env()->exchange_string(); Local priority_symbol = env()->priority_string(); ares_mx_reply* current = mx_start; for (uint32_t i = 0; current != nullptr; ++i, current = current->next) { Local mx_record = Object::New(env()->isolate()); mx_record->Set(exchange_symbol, OneByteString(env()->isolate(), current->host)); mx_record->Set(priority_symbol, Integer::New(env()->isolate(), current->priority)); mx_records->Set(i, mx_record); } ares_free_data(mx_start); this->CallOnComplete(mx_records); } }; class QueryNsWrap: public QueryWrap { public: QueryNsWrap(Environment* env, Local req_wrap_obj) : QueryWrap(env, req_wrap_obj) { } int Send(const char* name) override { ares_query(env()->cares_channel(), name, ns_c_in, ns_t_ns, Callback, GetQueryArg()); return 0; } size_t self_size() const override { return sizeof(*this); } protected: void Parse(unsigned char* buf, int len) override { HandleScope handle_scope(env()->isolate()); Context::Scope context_scope(env()->context()); struct hostent* host; int status = ares_parse_ns_reply(buf, len, &host); if (status != ARES_SUCCESS) { ParseError(status); return; } Local names = HostentToNames(env(), host); ares_free_hostent(host); this->CallOnComplete(names); } }; class QueryTxtWrap: public QueryWrap { public: QueryTxtWrap(Environment* env, Local req_wrap_obj) : QueryWrap(env, req_wrap_obj) { } int Send(const char* name) override { ares_query(env()->cares_channel(), name, ns_c_in, ns_t_txt, Callback, GetQueryArg()); return 0; } size_t self_size() const override { return sizeof(*this); } protected: void Parse(unsigned char* buf, int len) override { HandleScope handle_scope(env()->isolate()); Context::Scope context_scope(env()->context()); struct ares_txt_reply* txt_out; int status = ares_parse_txt_reply(buf, len, &txt_out); if (status != ARES_SUCCESS) { ParseError(status); return; } Local txt_records = Array::New(env()->isolate()); Local txt_chunk; ares_txt_reply* current = txt_out; uint32_t i = 0; for (uint32_t j = 0; current != nullptr; current = current->next) { Local txt = OneByteString(env()->isolate(), current->txt); // New record found - write out the current chunk if (current->record_start) { if (!txt_chunk.IsEmpty()) txt_records->Set(i++, txt_chunk); txt_chunk = Array::New(env()->isolate()); j = 0; } txt_chunk->Set(j++, txt); } // Push last chunk if it isn't empty if (!txt_chunk.IsEmpty()) txt_records->Set(i, txt_chunk); ares_free_data(txt_out); this->CallOnComplete(txt_records); } }; class QuerySrvWrap: public QueryWrap { public: explicit QuerySrvWrap(Environment* env, Local req_wrap_obj) : QueryWrap(env, req_wrap_obj) { } int Send(const char* name) override { ares_query(env()->cares_channel(), name, ns_c_in, ns_t_srv, Callback, GetQueryArg()); return 0; } size_t self_size() const override { return sizeof(*this); } protected: void Parse(unsigned char* buf, int len) override { HandleScope handle_scope(env()->isolate()); Context::Scope context_scope(env()->context()); struct ares_srv_reply* srv_start; int status = ares_parse_srv_reply(buf, len, &srv_start); if (status != ARES_SUCCESS) { ParseError(status); return; } Local srv_records = Array::New(env()->isolate()); Local name_symbol = env()->name_string(); Local port_symbol = env()->port_string(); Local priority_symbol = env()->priority_string(); Local weight_symbol = env()->weight_string(); ares_srv_reply* current = srv_start; for (uint32_t i = 0; current != nullptr; ++i, current = current->next) { Local srv_record = Object::New(env()->isolate()); srv_record->Set(name_symbol, OneByteString(env()->isolate(), current->host)); srv_record->Set(port_symbol, Integer::New(env()->isolate(), current->port)); srv_record->Set(priority_symbol, Integer::New(env()->isolate(), current->priority)); srv_record->Set(weight_symbol, Integer::New(env()->isolate(), current->weight)); srv_records->Set(i, srv_record); } ares_free_data(srv_start); this->CallOnComplete(srv_records); } }; class QueryNaptrWrap: public QueryWrap { public: explicit QueryNaptrWrap(Environment* env, Local req_wrap_obj) : QueryWrap(env, req_wrap_obj) { } int Send(const char* name) override { ares_query(env()->cares_channel(), name, ns_c_in, ns_t_naptr, Callback, GetQueryArg()); return 0; } size_t self_size() const override { return sizeof(*this); } protected: void Parse(unsigned char* buf, int len) override { HandleScope handle_scope(env()->isolate()); Context::Scope context_scope(env()->context()); ares_naptr_reply* naptr_start; int status = ares_parse_naptr_reply(buf, len, &naptr_start); if (status != ARES_SUCCESS) { ParseError(status); return; } Local naptr_records = Array::New(env()->isolate()); Local flags_symbol = env()->flags_string(); Local service_symbol = env()->service_string(); Local regexp_symbol = env()->regexp_string(); Local replacement_symbol = env()->replacement_string(); Local order_symbol = env()->order_string(); Local preference_symbol = env()->preference_string(); ares_naptr_reply* current = naptr_start; for (uint32_t i = 0; current != nullptr; ++i, current = current->next) { Local naptr_record = Object::New(env()->isolate()); naptr_record->Set(flags_symbol, OneByteString(env()->isolate(), current->flags)); naptr_record->Set(service_symbol, OneByteString(env()->isolate(), current->service)); naptr_record->Set(regexp_symbol, OneByteString(env()->isolate(), current->regexp)); naptr_record->Set(replacement_symbol, OneByteString(env()->isolate(), current->replacement)); naptr_record->Set(order_symbol, Integer::New(env()->isolate(), current->order)); naptr_record->Set(preference_symbol, Integer::New(env()->isolate(), current->preference)); naptr_records->Set(i, naptr_record); } ares_free_data(naptr_start); this->CallOnComplete(naptr_records); } }; class QuerySoaWrap: public QueryWrap { public: QuerySoaWrap(Environment* env, Local req_wrap_obj) : QueryWrap(env, req_wrap_obj) { } int Send(const char* name) override { ares_query(env()->cares_channel(), name, ns_c_in, ns_t_soa, Callback, GetQueryArg()); return 0; } size_t self_size() const override { return sizeof(*this); } protected: void Parse(unsigned char* buf, int len) override { HandleScope handle_scope(env()->isolate()); Context::Scope context_scope(env()->context()); ares_soa_reply* soa_out; int status = ares_parse_soa_reply(buf, len, &soa_out); if (status != ARES_SUCCESS) { ParseError(status); return; } Local soa_record = Object::New(env()->isolate()); soa_record->Set(env()->nsname_string(), OneByteString(env()->isolate(), soa_out->nsname)); soa_record->Set(env()->hostmaster_string(), OneByteString(env()->isolate(), soa_out->hostmaster)); soa_record->Set(env()->serial_string(), Integer::New(env()->isolate(), soa_out->serial)); soa_record->Set(env()->refresh_string(), Integer::New(env()->isolate(), soa_out->refresh)); soa_record->Set(env()->retry_string(), Integer::New(env()->isolate(), soa_out->retry)); soa_record->Set(env()->expire_string(), Integer::New(env()->isolate(), soa_out->expire)); soa_record->Set(env()->minttl_string(), Integer::New(env()->isolate(), soa_out->minttl)); ares_free_data(soa_out); this->CallOnComplete(soa_record); } }; class GetHostByAddrWrap: public QueryWrap { public: explicit GetHostByAddrWrap(Environment* env, Local req_wrap_obj) : QueryWrap(env, req_wrap_obj) { } int Send(const char* name) override { int length, family; char address_buffer[sizeof(struct in6_addr)]; if (uv_inet_pton(AF_INET, name, &address_buffer) == 0) { length = sizeof(struct in_addr); family = AF_INET; } else if (uv_inet_pton(AF_INET6, name, &address_buffer) == 0) { length = sizeof(struct in6_addr); family = AF_INET6; } else { return UV_EINVAL; // So errnoException() reports a proper error. } ares_gethostbyaddr(env()->cares_channel(), address_buffer, length, family, Callback, GetQueryArg()); return 0; } size_t self_size() const override { return sizeof(*this); } protected: void Parse(struct hostent* host) override { HandleScope handle_scope(env()->isolate()); Context::Scope context_scope(env()->context()); this->CallOnComplete(HostentToNames(env(), host)); } }; class GetHostByNameWrap: public QueryWrap { public: explicit GetHostByNameWrap(Environment* env, Local req_wrap_obj) : QueryWrap(env, req_wrap_obj) { } int Send(const char* name, int family) override { ares_gethostbyname(env()->cares_channel(), name, family, Callback, GetQueryArg()); return 0; } protected: void Parse(struct hostent* host) override { HandleScope scope(env()->isolate()); Local addresses = HostentToAddresses(env(), host); Local family = Integer::New(env()->isolate(), host->h_addrtype); this->CallOnComplete(addresses, family); } }; template static void Query(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); CHECK_EQ(false, args.IsConstructCall()); CHECK(args[0]->IsObject()); CHECK(args[1]->IsString()); Local req_wrap_obj = args[0].As(); Local string = args[1].As(); Wrap* wrap = new Wrap(env, req_wrap_obj); node::Utf8Value name(env->isolate(), string); int err = wrap->Send(*name); if (err) delete wrap; args.GetReturnValue().Set(err); } void AfterGetAddrInfo(uv_getaddrinfo_t* req, int status, struct addrinfo* res) { GetAddrInfoReqWrap* req_wrap = static_cast(req->data); Environment* env = req_wrap->env(); HandleScope handle_scope(env->isolate()); Context::Scope context_scope(env->context()); Local argv[] = { Integer::New(env->isolate(), status), Null(env->isolate()) }; if (status == 0) { // Success struct addrinfo *address; int n = 0; // Create the response array. Local results = Array::New(env->isolate()); char ip[INET6_ADDRSTRLEN]; const char *addr; // Iterate over the IPv4 responses again this time creating javascript // strings for each IP and filling the results array. address = res; while (address) { CHECK_EQ(address->ai_socktype, SOCK_STREAM); // Ignore random ai_family types. if (address->ai_family == AF_INET) { // Juggle pointers addr = reinterpret_cast(&(reinterpret_cast( address->ai_addr)->sin_addr)); int err = uv_inet_ntop(address->ai_family, addr, ip, INET6_ADDRSTRLEN); if (err) continue; // Create JavaScript string Local s = OneByteString(env->isolate(), ip); results->Set(n, s); n++; } // Increment address = address->ai_next; } // Iterate over the IPv6 responses putting them in the array. address = res; while (address) { CHECK_EQ(address->ai_socktype, SOCK_STREAM); // Ignore random ai_family types. if (address->ai_family == AF_INET6) { // Juggle pointers addr = reinterpret_cast(&(reinterpret_cast( address->ai_addr)->sin6_addr)); int err = uv_inet_ntop(address->ai_family, addr, ip, INET6_ADDRSTRLEN); if (err) continue; // Create JavaScript string Local s = OneByteString(env->isolate(), ip); results->Set(n, s); n++; } // Increment address = address->ai_next; } // No responses were found to return if (n == 0) { argv[0] = Integer::New(env->isolate(), UV_EAI_NODATA); } argv[1] = results; } uv_freeaddrinfo(res); // Make the callback into JavaScript req_wrap->MakeCallback(env->oncomplete_string(), arraysize(argv), argv); delete req_wrap; } void AfterGetNameInfo(uv_getnameinfo_t* req, int status, const char* hostname, const char* service) { GetNameInfoReqWrap* req_wrap = static_cast(req->data); Environment* env = req_wrap->env(); HandleScope handle_scope(env->isolate()); Context::Scope context_scope(env->context()); Local argv[] = { Integer::New(env->isolate(), status), Null(env->isolate()), Null(env->isolate()) }; if (status == 0) { // Success Local js_hostname = OneByteString(env->isolate(), hostname); Local js_service = OneByteString(env->isolate(), service); argv[1] = js_hostname; argv[2] = js_service; } // Make the callback into JavaScript req_wrap->MakeCallback(env->oncomplete_string(), arraysize(argv), argv); delete req_wrap; } static void IsIP(const FunctionCallbackInfo& args) { node::Utf8Value ip(args.GetIsolate(), args[0]); char address_buffer[sizeof(struct in6_addr)]; int rc = 0; if (uv_inet_pton(AF_INET, *ip, &address_buffer) == 0) rc = 4; else if (uv_inet_pton(AF_INET6, *ip, &address_buffer) == 0) rc = 6; args.GetReturnValue().Set(rc); } static void IsIPv4(const FunctionCallbackInfo& args) { node::Utf8Value ip(args.GetIsolate(), args[0]); char address_buffer[sizeof(struct in_addr)]; if (uv_inet_pton(AF_INET, *ip, &address_buffer) == 0) { args.GetReturnValue().Set(true); } else { args.GetReturnValue().Set(false); } } static void IsIPv6(const FunctionCallbackInfo& args) { node::Utf8Value ip(args.GetIsolate(), args[0]); char address_buffer[sizeof(struct in6_addr)]; if (uv_inet_pton(AF_INET6, *ip, &address_buffer) == 0) { args.GetReturnValue().Set(true); } else { args.GetReturnValue().Set(false); } } static void GetAddrInfo(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); CHECK(args[0]->IsObject()); CHECK(args[1]->IsString()); CHECK(args[2]->IsInt32()); Local req_wrap_obj = args[0].As(); node::Utf8Value hostname(env->isolate(), args[1]); int32_t flags = (args[3]->IsInt32()) ? args[3]->Int32Value() : 0; int family; switch (args[2]->Int32Value()) { case 0: family = AF_UNSPEC; break; case 4: family = AF_INET; break; case 6: family = AF_INET6; break; default: CHECK(0 && "bad address family"); ABORT(); } GetAddrInfoReqWrap* req_wrap = new GetAddrInfoReqWrap(env, req_wrap_obj); struct addrinfo hints; memset(&hints, 0, sizeof(struct addrinfo)); hints.ai_family = family; hints.ai_socktype = SOCK_STREAM; hints.ai_flags = flags; int err = uv_getaddrinfo(env->event_loop(), &req_wrap->req_, AfterGetAddrInfo, *hostname, nullptr, &hints); req_wrap->Dispatched(); if (err) delete req_wrap; args.GetReturnValue().Set(err); } static void GetNameInfo(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); CHECK(args[0]->IsObject()); CHECK(args[1]->IsString()); CHECK(args[2]->IsUint32()); Local req_wrap_obj = args[0].As(); node::Utf8Value ip(env->isolate(), args[1]); const unsigned port = args[2]->Uint32Value(); struct sockaddr_storage addr; CHECK(uv_ip4_addr(*ip, port, reinterpret_cast(&addr)) == 0 || uv_ip6_addr(*ip, port, reinterpret_cast(&addr)) == 0); GetNameInfoReqWrap* req_wrap = new GetNameInfoReqWrap(env, req_wrap_obj); int err = uv_getnameinfo(env->event_loop(), &req_wrap->req_, AfterGetNameInfo, (struct sockaddr*)&addr, NI_NAMEREQD); req_wrap->Dispatched(); if (err) delete req_wrap; args.GetReturnValue().Set(err); } static void GetServers(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); Local server_array = Array::New(env->isolate()); ares_addr_node* servers; int r = ares_get_servers(env->cares_channel(), &servers); CHECK_EQ(r, ARES_SUCCESS); ares_addr_node* cur = servers; for (uint32_t i = 0; cur != nullptr; ++i, cur = cur->next) { char ip[INET6_ADDRSTRLEN]; const void* caddr = static_cast(&cur->addr); int err = uv_inet_ntop(cur->family, caddr, ip, sizeof(ip)); CHECK_EQ(err, 0); Local addr = OneByteString(env->isolate(), ip); server_array->Set(i, addr); } ares_free_data(servers); args.GetReturnValue().Set(server_array); } static void SetServers(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); CHECK(args[0]->IsArray()); Local arr = Local::Cast(args[0]); uint32_t len = arr->Length(); if (len == 0) { int rv = ares_set_servers(env->cares_channel(), nullptr); return args.GetReturnValue().Set(rv); } ares_addr_node* servers = new ares_addr_node[len]; ares_addr_node* last = nullptr; int err; for (uint32_t i = 0; i < len; i++) { CHECK(arr->Get(i)->IsArray()); Local elm = Local::Cast(arr->Get(i)); CHECK(elm->Get(0)->Int32Value()); CHECK(elm->Get(1)->IsString()); int fam = elm->Get(0)->Int32Value(); node::Utf8Value ip(env->isolate(), elm->Get(1)); ares_addr_node* cur = &servers[i]; switch (fam) { case 4: cur->family = AF_INET; err = uv_inet_pton(AF_INET, *ip, &cur->addr); break; case 6: cur->family = AF_INET6; err = uv_inet_pton(AF_INET6, *ip, &cur->addr); break; default: CHECK(0 && "Bad address family."); ABORT(); } if (err) break; cur->next = nullptr; if (last != nullptr) last->next = cur; last = cur; } if (err == 0) err = ares_set_servers(env->cares_channel(), &servers[0]); else err = ARES_EBADSTR; delete[] servers; args.GetReturnValue().Set(err); } static void StrError(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); const char* errmsg = ares_strerror(args[0]->Int32Value()); args.GetReturnValue().Set(OneByteString(env->isolate(), errmsg)); } static void CaresTimerCloseCb(uv_handle_t* handle) { Environment* env = Environment::from_cares_timer_handle( reinterpret_cast(handle)); env->FinishHandleCleanup(handle); } static void CaresTimerClose(Environment* env, uv_handle_t* handle, void* arg) { uv_close(handle, CaresTimerCloseCb); } static void Initialize(Local target, Local unused, Local context) { Environment* env = Environment::GetCurrent(context); int r = ares_library_init(ARES_LIB_INIT_ALL); if (r != ARES_SUCCESS) return env->ThrowError(ToErrorCodeString(r)); struct ares_options options; memset(&options, 0, sizeof(options)); options.flags = ARES_FLAG_NOCHECKRESP; options.sock_state_cb = ares_sockstate_cb; options.sock_state_cb_data = env; /* We do the call to ares_init_option for caller. */ r = ares_init_options(env->cares_channel_ptr(), &options, ARES_OPT_FLAGS | ARES_OPT_SOCK_STATE_CB); if (r != ARES_SUCCESS) { ares_library_cleanup(); return env->ThrowError(ToErrorCodeString(r)); } /* Initialize the timeout timer. The timer won't be started until the */ /* first socket is opened. */ uv_timer_init(env->event_loop(), env->cares_timer_handle()); env->RegisterHandleCleanup( reinterpret_cast(env->cares_timer_handle()), CaresTimerClose, nullptr); env->SetMethod(target, "queryA", Query); env->SetMethod(target, "queryAaaa", Query); env->SetMethod(target, "queryCname", Query); env->SetMethod(target, "queryMx", Query); env->SetMethod(target, "queryNs", Query); env->SetMethod(target, "queryTxt", Query); env->SetMethod(target, "querySrv", Query); env->SetMethod(target, "queryNaptr", Query); env->SetMethod(target, "querySoa", Query); env->SetMethod(target, "getHostByAddr", Query); env->SetMethod(target, "getaddrinfo", GetAddrInfo); env->SetMethod(target, "getnameinfo", GetNameInfo); env->SetMethod(target, "isIP", IsIP); env->SetMethod(target, "isIPv4", IsIPv4); env->SetMethod(target, "isIPv6", IsIPv6); env->SetMethod(target, "strerror", StrError); env->SetMethod(target, "getServers", GetServers); env->SetMethod(target, "setServers", SetServers); target->Set(FIXED_ONE_BYTE_STRING(env->isolate(), "AF_INET"), Integer::New(env->isolate(), AF_INET)); target->Set(FIXED_ONE_BYTE_STRING(env->isolate(), "AF_INET6"), Integer::New(env->isolate(), AF_INET6)); target->Set(FIXED_ONE_BYTE_STRING(env->isolate(), "AF_UNSPEC"), Integer::New(env->isolate(), AF_UNSPEC)); target->Set(FIXED_ONE_BYTE_STRING(env->isolate(), "AI_ADDRCONFIG"), Integer::New(env->isolate(), AI_ADDRCONFIG)); target->Set(FIXED_ONE_BYTE_STRING(env->isolate(), "AI_V4MAPPED"), Integer::New(env->isolate(), AI_V4MAPPED)); Local aiw = FunctionTemplate::New(env->isolate(), NewGetAddrInfoReqWrap); aiw->InstanceTemplate()->SetInternalFieldCount(1); aiw->SetClassName( FIXED_ONE_BYTE_STRING(env->isolate(), "GetAddrInfoReqWrap")); target->Set(FIXED_ONE_BYTE_STRING(env->isolate(), "GetAddrInfoReqWrap"), aiw->GetFunction()); Local niw = FunctionTemplate::New(env->isolate(), NewGetNameInfoReqWrap); niw->InstanceTemplate()->SetInternalFieldCount(1); niw->SetClassName( FIXED_ONE_BYTE_STRING(env->isolate(), "GetNameInfoReqWrap")); target->Set(FIXED_ONE_BYTE_STRING(env->isolate(), "GetNameInfoReqWrap"), niw->GetFunction()); Local qrw = FunctionTemplate::New(env->isolate(), NewQueryReqWrap); qrw->InstanceTemplate()->SetInternalFieldCount(1); qrw->SetClassName( FIXED_ONE_BYTE_STRING(env->isolate(), "QueryReqWrap")); target->Set(FIXED_ONE_BYTE_STRING(env->isolate(), "QueryReqWrap"), qrw->GetFunction()); } } // namespace cares_wrap } // namespace node NODE_MODULE_CONTEXT_AWARE_BUILTIN(cares_wrap, node::cares_wrap::Initialize) node-v4.8.2/src/CNNICHashWhitelist.inc000644 000766 000024 00000254261 13070706736 017610 0ustar00iojsstaff000000 000000 // This Source Code Form is subject to the terms of the Mozilla Public // License, v. 2.0. If a copy of the MPL was not distributed with this // file, You can obtain one at http://mozilla.org/MPL/2.0/. // //*************************************************************************** // This file was automatically generated by makeCNNICHashes.js. It shouldn't // need to be manually edited. //*************************************************************************** // This file may be removed after Sun Feb 02 2020 21:45:13 GMT-0800 (PST) #define CNNIC_WHITELIST_HASH_LEN 32 struct WhitelistedCNNICHash { const uint8_t hash[CNNIC_WHITELIST_HASH_LEN]; }; static const struct WhitelistedCNNICHash WhitelistedCNNICHashes[] = { { { 0x00, 0xC5, 0x9F, 0x5E, 0xF3, 0xB4, 0x6D, 0xBC, 0xA0, 0xA8, 0xBB, 0xA5, 0x0A, 0x72, 0xD4, 0xE1, 0x83, 0x9A, 0x94, 0xFB, 0x1A, 0x58, 0x5A, 0xD7, 0x2A, 0x7A, 0xAC, 0x3C, 0x72, 0x56, 0x1F, 0xC0 }, }, { { 0x02, 0x01, 0x4E, 0x80, 0xF5, 0xC4, 0xF3, 0x8B, 0xA9, 0xD9, 0x04, 0x79, 0x1A, 0x63, 0xF6, 0x4D, 0x05, 0xF9, 0xE2, 0x03, 0xA1, 0xF1, 0x2B, 0x06, 0xD6, 0x55, 0x94, 0x01, 0x41, 0x0E, 0x73, 0x36 }, }, { { 0x02, 0x35, 0x38, 0xE2, 0x48, 0x15, 0x28, 0x75, 0x29, 0x2F, 0x2C, 0x83, 0x9A, 0xB3, 0x2B, 0xC7, 0x35, 0x1E, 0x2B, 0x29, 0x99, 0x1D, 0x66, 0xAE, 0xA6, 0x16, 0xCB, 0x0B, 0x26, 0xA5, 0xE3, 0x75 }, }, { { 0x02, 0xEC, 0x35, 0xF5, 0x83, 0x4C, 0xD2, 0xC3, 0x43, 0x33, 0x39, 0x9A, 0xEA, 0x6B, 0xDA, 0x84, 0x68, 0xAB, 0x8D, 0x74, 0xEF, 0x6C, 0xA5, 0x2D, 0x33, 0x7A, 0x30, 0x69, 0x4C, 0x3F, 0x95, 0xA4 }, }, { { 0x03, 0xE0, 0x6E, 0x0B, 0x7A, 0x2C, 0xBA, 0xE4, 0xB6, 0x8B, 0xCE, 0x5F, 0x83, 0xE7, 0xA9, 0x31, 0x6E, 0xD7, 0x82, 0x3E, 0x8D, 0x94, 0x85, 0x38, 0xF1, 0x94, 0x3F, 0xA4, 0x27, 0xD7, 0x91, 0x0E }, }, { { 0x04, 0x0F, 0x53, 0x7A, 0x51, 0x95, 0x95, 0xCC, 0xFF, 0xDE, 0x35, 0xE0, 0xD1, 0x28, 0xB7, 0x99, 0x92, 0x2B, 0xA9, 0x37, 0xA2, 0xE8, 0x65, 0x84, 0x36, 0x62, 0xF1, 0xF4, 0x50, 0x02, 0xB8, 0x2D }, }, { { 0x04, 0x18, 0xD5, 0x3E, 0xBC, 0x8E, 0x71, 0x41, 0x25, 0x1B, 0x4D, 0xC8, 0xFA, 0x7B, 0x2B, 0xD8, 0xFD, 0x3A, 0x1C, 0x65, 0x2A, 0xA1, 0x16, 0xE7, 0xFC, 0x70, 0x0B, 0x2A, 0xB5, 0x1A, 0x2A, 0x1A }, }, { { 0x06, 0xD4, 0x08, 0xFF, 0xA9, 0x93, 0xAF, 0x04, 0x45, 0x9C, 0x45, 0x67, 0x1A, 0xAB, 0xD8, 0x7E, 0xF9, 0x2B, 0x85, 0x6B, 0x1B, 0x42, 0xC6, 0x7E, 0x00, 0x5E, 0xB4, 0xD2, 0x71, 0x58, 0xA8, 0x42 }, }, { { 0x07, 0x19, 0x4F, 0x47, 0xF4, 0xCE, 0xD0, 0x96, 0xD1, 0x06, 0x8D, 0x34, 0x49, 0x3B, 0x67, 0x37, 0x14, 0x45, 0x16, 0x93, 0xA6, 0xA2, 0x71, 0x2F, 0x70, 0x8F, 0x59, 0x36, 0x12, 0x11, 0xC6, 0x21 }, }, { { 0x07, 0x8F, 0xEE, 0x58, 0x8A, 0x2C, 0x55, 0xC8, 0xE2, 0xC1, 0x78, 0x71, 0xAA, 0xB6, 0xE4, 0x00, 0xB3, 0xFD, 0xBC, 0xDC, 0xF3, 0x91, 0x46, 0xA0, 0x89, 0x37, 0xF9, 0xAC, 0x06, 0xA1, 0xB8, 0xBD }, }, { { 0x07, 0xE9, 0x60, 0x9E, 0x05, 0xDC, 0x0A, 0x1E, 0x52, 0x15, 0x06, 0x49, 0xEB, 0xF4, 0x1F, 0x6D, 0xE3, 0x86, 0x7C, 0x9C, 0x25, 0xFE, 0x17, 0x7B, 0xAB, 0xCF, 0xD9, 0xB3, 0x70, 0x46, 0x13, 0x8B }, }, { { 0x08, 0x21, 0x0A, 0xC3, 0xA2, 0x95, 0x56, 0xF6, 0x8D, 0x33, 0xB4, 0x40, 0x87, 0x9C, 0x54, 0x63, 0x64, 0x04, 0xE9, 0x7C, 0x4D, 0x9F, 0x97, 0x82, 0x23, 0xD2, 0x42, 0xAB, 0xE5, 0x38, 0x5E, 0x4E }, }, { { 0x08, 0xC2, 0xD3, 0x17, 0xA8, 0x4A, 0x3C, 0xBE, 0x38, 0xDE, 0x64, 0xA2, 0x4D, 0xD4, 0x27, 0x91, 0x09, 0xE2, 0xBC, 0x02, 0x2B, 0x93, 0xB1, 0x05, 0xA8, 0x94, 0xA5, 0x1A, 0xDC, 0x3E, 0xE5, 0xCC }, }, { { 0x09, 0x9F, 0x3E, 0x71, 0xB5, 0x00, 0xD1, 0x5B, 0x03, 0x7B, 0x93, 0xAA, 0x5F, 0xB4, 0x16, 0x19, 0x0A, 0xD1, 0xDF, 0x86, 0x73, 0xAB, 0x31, 0xA8, 0xF6, 0xD9, 0x7F, 0x59, 0x5E, 0x8E, 0x16, 0xE9 }, }, { { 0x09, 0xEB, 0xDD, 0x1B, 0x7F, 0xFA, 0x4E, 0xD7, 0x4B, 0xEB, 0xAE, 0x96, 0xBA, 0x10, 0x65, 0xDC, 0x7D, 0xA1, 0xC5, 0xD3, 0x18, 0x3C, 0xC5, 0x94, 0x19, 0xE9, 0x78, 0x36, 0xAF, 0x7F, 0x6D, 0x70 }, }, { { 0x0A, 0x01, 0x88, 0x81, 0x2C, 0x9D, 0xE8, 0x8A, 0x2F, 0x0A, 0x5C, 0x4C, 0x57, 0xE6, 0xF9, 0xA8, 0x15, 0x69, 0xE9, 0xC7, 0x09, 0xC0, 0x95, 0x40, 0x80, 0xE5, 0xE4, 0xE6, 0x62, 0x85, 0x6D, 0xF8 }, }, { { 0x0A, 0x42, 0x19, 0x7E, 0x48, 0x70, 0xB2, 0x34, 0x20, 0xF5, 0x51, 0x9F, 0xB8, 0x39, 0xB6, 0xCC, 0x83, 0x03, 0x52, 0x9A, 0xA9, 0x06, 0x9A, 0xD1, 0xA0, 0x90, 0x86, 0xCF, 0x6C, 0xBA, 0x07, 0xC2 }, }, { { 0x0B, 0x03, 0xE1, 0x27, 0xC2, 0xE3, 0x3E, 0xAD, 0xBC, 0xB0, 0x99, 0x80, 0x46, 0xCC, 0x9B, 0xA7, 0x33, 0x46, 0x3E, 0x0C, 0xA6, 0x43, 0x52, 0x27, 0x81, 0xB0, 0x3D, 0x81, 0x53, 0x97, 0xEB, 0x4F }, }, { { 0x0B, 0x1E, 0x1E, 0x73, 0x43, 0xA0, 0xE9, 0x1C, 0x2A, 0x27, 0xDD, 0x2A, 0x4D, 0x7E, 0x6B, 0xF1, 0xE8, 0x04, 0x4B, 0x58, 0xCE, 0x1A, 0xE8, 0x1E, 0x27, 0xD8, 0x14, 0xFD, 0x2D, 0xC0, 0x18, 0x93 }, }, { { 0x0B, 0x48, 0xD5, 0x5C, 0xAC, 0x84, 0xFD, 0xEE, 0x15, 0xD8, 0x1A, 0xFF, 0x99, 0x07, 0xBB, 0x9A, 0x57, 0x11, 0xA9, 0x5C, 0xE2, 0x3A, 0x8D, 0x4D, 0x5E, 0x88, 0x62, 0xBF, 0x15, 0xA7, 0x6A, 0x75 }, }, { { 0x0B, 0xFE, 0xA1, 0x38, 0x31, 0x67, 0x3E, 0xC9, 0x69, 0xD0, 0x5F, 0xD8, 0x67, 0xB6, 0x69, 0xF2, 0x71, 0x24, 0xAF, 0xEB, 0x7C, 0x60, 0x8C, 0xFE, 0x54, 0xCF, 0x46, 0x33, 0x06, 0xCC, 0x99, 0x2E }, }, { { 0x0C, 0xB9, 0x31, 0x93, 0xF1, 0x65, 0x26, 0xE1, 0xD1, 0x65, 0x52, 0x11, 0x7B, 0xA2, 0x1A, 0xAC, 0xB9, 0xF1, 0xD7, 0xA8, 0x93, 0x56, 0xA3, 0x5D, 0xE4, 0xF6, 0x65, 0xE9, 0x39, 0x90, 0x79, 0x38 }, }, { { 0x0D, 0x16, 0x1B, 0xB9, 0xCA, 0x0D, 0x20, 0xE4, 0x67, 0x35, 0x89, 0x67, 0x22, 0x78, 0xB0, 0xA3, 0xC5, 0xE2, 0x69, 0x30, 0xA4, 0xDC, 0x3A, 0x82, 0x16, 0x85, 0x43, 0x24, 0x27, 0xC7, 0x31, 0x5A }, }, { { 0x0D, 0x66, 0x45, 0x6B, 0x0B, 0xF4, 0xAA, 0x54, 0x16, 0xE4, 0x4D, 0x9F, 0xDB, 0x40, 0x38, 0x3D, 0x34, 0x3D, 0x7B, 0x3F, 0x6A, 0xFE, 0x69, 0xAA, 0x08, 0x95, 0xBB, 0x1A, 0xB5, 0xE0, 0x61, 0xA0 }, }, { { 0x0D, 0x71, 0xC8, 0xCA, 0x16, 0x56, 0x59, 0xEF, 0xAF, 0x69, 0x65, 0x29, 0x28, 0x9A, 0xAE, 0x25, 0xD9, 0xC4, 0x2A, 0x1B, 0xBB, 0x03, 0x5A, 0x2B, 0x8C, 0x61, 0x14, 0x7E, 0x1B, 0x8B, 0x90, 0x52 }, }, { { 0x0E, 0xFD, 0x68, 0x73, 0xD6, 0x0E, 0x77, 0x96, 0x2D, 0xF6, 0x00, 0x16, 0xDC, 0x3B, 0xAF, 0x9C, 0xA7, 0x1E, 0x7D, 0x86, 0x19, 0xE7, 0xEB, 0xAA, 0x3A, 0xF2, 0xDC, 0xB5, 0xBA, 0x24, 0xDE, 0xC2 }, }, { { 0x0E, 0xFF, 0x3C, 0xFF, 0xDA, 0x4A, 0x3E, 0x87, 0x23, 0x4A, 0x86, 0xC7, 0x0D, 0x49, 0x8C, 0x62, 0x60, 0x7F, 0x37, 0x44, 0xEA, 0x71, 0xF1, 0x83, 0x1D, 0xCF, 0xCA, 0xF3, 0xAF, 0x15, 0x56, 0x9C }, }, { { 0x10, 0x83, 0x6D, 0xA0, 0xCD, 0x6A, 0xC0, 0x95, 0xDD, 0x7A, 0xC3, 0x4D, 0x99, 0x01, 0x90, 0x9A, 0x8E, 0xF8, 0x4D, 0x6E, 0xE0, 0x5B, 0x83, 0x43, 0x03, 0xD4, 0x7F, 0xC0, 0xA5, 0xF9, 0x14, 0xFA }, }, { { 0x11, 0xA4, 0x02, 0x7B, 0x45, 0xFC, 0x9A, 0x6F, 0x40, 0x21, 0x25, 0xC3, 0xCA, 0x22, 0x68, 0xE0, 0x15, 0xA3, 0x1B, 0xA4, 0xFD, 0xB0, 0x05, 0x9D, 0x66, 0x6B, 0x73, 0xC8, 0x51, 0xD5, 0x35, 0x92 }, }, { { 0x12, 0x6B, 0x1B, 0xA6, 0x38, 0xC7, 0xE6, 0x99, 0xBC, 0xBC, 0x54, 0xF5, 0x79, 0xAC, 0xD3, 0x9F, 0xE6, 0x1D, 0x08, 0x22, 0x5F, 0xE5, 0xB1, 0xF9, 0x01, 0x88, 0xB2, 0x3F, 0xD8, 0x43, 0x3E, 0x8E }, }, { { 0x13, 0x5D, 0x3E, 0xDA, 0x6E, 0x55, 0x9B, 0xF5, 0xEE, 0x23, 0x0A, 0xA5, 0xBA, 0x59, 0xBB, 0x6A, 0x2A, 0x0F, 0x07, 0x82, 0x2F, 0xED, 0x38, 0x44, 0x7E, 0x6A, 0xBC, 0x5C, 0x23, 0xAA, 0xD0, 0x27 }, }, { { 0x13, 0x6A, 0x40, 0x09, 0x81, 0xB1, 0xA3, 0xE0, 0x5F, 0xDC, 0xAC, 0x20, 0xA2, 0x36, 0xF8, 0x6E, 0x94, 0xE5, 0xEE, 0x58, 0x59, 0xD8, 0xFD, 0x45, 0xE9, 0xE9, 0xC5, 0xA6, 0xC5, 0xC0, 0xA4, 0x13 }, }, { { 0x14, 0x21, 0x28, 0xA6, 0x65, 0x1C, 0xDC, 0x18, 0x70, 0xC2, 0x67, 0x5E, 0xC0, 0xB0, 0xEF, 0x32, 0xB5, 0xD4, 0xC1, 0x55, 0x35, 0x8E, 0x7E, 0xD9, 0x5A, 0x98, 0xE8, 0x3B, 0x1A, 0xD8, 0xBE, 0x4D }, }, { { 0x14, 0x47, 0x25, 0xA6, 0x79, 0x1C, 0x60, 0x0C, 0x4C, 0x2C, 0xF3, 0x94, 0x3F, 0x3E, 0xCF, 0x40, 0xD6, 0x31, 0xD7, 0x60, 0xE4, 0x51, 0xEF, 0x28, 0x29, 0xAF, 0xFB, 0xEE, 0x74, 0x80, 0xAD, 0x17 }, }, { { 0x15, 0x27, 0x2A, 0xBC, 0x1F, 0x0C, 0x4D, 0x1D, 0x1A, 0x92, 0x08, 0x73, 0x55, 0xA1, 0xE0, 0x42, 0x6C, 0x2B, 0xB5, 0xB4, 0x37, 0x30, 0x00, 0xB8, 0x2C, 0x2C, 0xCA, 0xB7, 0xFA, 0xD6, 0xFA, 0x20 }, }, { { 0x15, 0x48, 0x1F, 0xDE, 0x4E, 0x3F, 0x72, 0x49, 0x66, 0x87, 0xDF, 0x57, 0x5F, 0xB5, 0xB1, 0x27, 0xBD, 0x6D, 0xEB, 0x66, 0x1D, 0xD9, 0x07, 0x71, 0x8B, 0xA0, 0x65, 0xC7, 0xDA, 0x66, 0x76, 0xD1 }, }, { { 0x15, 0x5A, 0x88, 0x39, 0x60, 0x8B, 0x77, 0x25, 0x34, 0x6A, 0x72, 0x40, 0xE4, 0xE2, 0x50, 0x3A, 0xCC, 0x7B, 0x8B, 0xEF, 0x0B, 0x1B, 0xE6, 0x15, 0xB9, 0x02, 0x4A, 0x88, 0xE6, 0x52, 0x11, 0xF9 }, }, { { 0x15, 0x5D, 0x88, 0x6E, 0x99, 0x1D, 0x40, 0x0A, 0xBF, 0x2F, 0x83, 0xC2, 0x80, 0xD1, 0x24, 0x6D, 0xCE, 0x02, 0xA6, 0x28, 0x31, 0x26, 0xC6, 0x17, 0xE4, 0x17, 0xD2, 0xB7, 0xEA, 0xC1, 0x19, 0x24 }, }, { { 0x18, 0x1E, 0xBB, 0x29, 0x8D, 0x20, 0x68, 0x5C, 0x48, 0xF7, 0x53, 0x89, 0x80, 0xC5, 0x63, 0xC8, 0xF7, 0x48, 0x95, 0x4C, 0xF2, 0x64, 0x41, 0x9A, 0x72, 0xFC, 0xC6, 0x34, 0x0A, 0x10, 0x23, 0x80 }, }, { { 0x19, 0x77, 0x3E, 0xE9, 0xE9, 0x35, 0x6B, 0x88, 0x11, 0xD6, 0x56, 0x79, 0x9C, 0x53, 0x16, 0x0B, 0x61, 0x73, 0xFA, 0x8A, 0x81, 0x47, 0x97, 0xDB, 0xCD, 0x55, 0xB2, 0x27, 0x38, 0x70, 0x60, 0x3E }, }, { { 0x1A, 0x9E, 0xC6, 0x8C, 0xED, 0xB6, 0xBD, 0x94, 0x0C, 0x95, 0x34, 0xE6, 0x84, 0xBB, 0x04, 0x9F, 0xF1, 0xE2, 0x3B, 0x66, 0xA1, 0x33, 0x01, 0x2F, 0xC3, 0x99, 0xEB, 0x4F, 0xB5, 0xD3, 0xAA, 0x35 }, }, { { 0x1B, 0x7B, 0xF8, 0xD9, 0xE8, 0x29, 0x3C, 0x53, 0xDD, 0x59, 0xEC, 0x97, 0xFE, 0x16, 0xF0, 0xEA, 0xB4, 0x68, 0x5B, 0x95, 0xCE, 0x14, 0xD2, 0x62, 0x3E, 0x70, 0x94, 0x2C, 0xFF, 0x25, 0xE7, 0x30 }, }, { { 0x1B, 0xD7, 0xB3, 0x62, 0xBC, 0x14, 0x66, 0xFA, 0xC0, 0x5E, 0xC5, 0x9E, 0x12, 0xE8, 0x1B, 0xE7, 0x35, 0x38, 0xC4, 0x97, 0x28, 0xF5, 0xAD, 0xBA, 0x2D, 0x81, 0xFC, 0xDB, 0xC4, 0x65, 0x7C, 0x1B }, }, { { 0x1B, 0xEC, 0xFE, 0x78, 0xCE, 0x5E, 0x77, 0xA9, 0x77, 0xBB, 0x5F, 0xE3, 0x49, 0x91, 0x06, 0xC6, 0x4C, 0xF2, 0xB0, 0x76, 0x16, 0x59, 0x49, 0x04, 0x11, 0x17, 0xCD, 0x8A, 0xBC, 0xD9, 0x05, 0xD4 }, }, { { 0x1B, 0xF4, 0x8A, 0x83, 0x3C, 0xE4, 0x05, 0x64, 0x8C, 0xC0, 0xBD, 0xD3, 0xB5, 0xB8, 0xC1, 0x8E, 0xB5, 0x13, 0x15, 0x34, 0x29, 0x3A, 0xB2, 0x63, 0x44, 0xB5, 0x00, 0x76, 0x48, 0x11, 0x41, 0xED }, }, { { 0x1C, 0x04, 0x82, 0x0F, 0x7B, 0x4A, 0x2F, 0x1E, 0x38, 0x5D, 0xE1, 0xDE, 0x16, 0xB2, 0x22, 0x6E, 0x88, 0x3D, 0x9C, 0x34, 0x66, 0x3E, 0x1B, 0x64, 0xE8, 0x5B, 0x98, 0x0E, 0xAF, 0xF0, 0xB9, 0xD3 }, }, { { 0x1D, 0x9E, 0xC0, 0x06, 0xA5, 0x26, 0xFA, 0xB5, 0xCE, 0x2E, 0x71, 0xFD, 0xFC, 0x07, 0xC0, 0x11, 0xF7, 0x65, 0x7B, 0xF8, 0x5F, 0x5D, 0x03, 0x52, 0xB8, 0xCB, 0x21, 0x8D, 0x4F, 0xCB, 0xC4, 0x43 }, }, { { 0x1E, 0x78, 0xF8, 0x08, 0x84, 0xE3, 0x2A, 0x2E, 0xA5, 0xAD, 0x1E, 0xE8, 0x35, 0x88, 0xAC, 0xDB, 0x18, 0x4A, 0x4A, 0x6E, 0x87, 0x56, 0x5B, 0xF5, 0x03, 0xB5, 0x69, 0x7A, 0xBF, 0xAE, 0x64, 0xA4 }, }, { { 0x1F, 0x11, 0x85, 0xA5, 0x21, 0xE2, 0x8E, 0x95, 0x17, 0x1C, 0xF3, 0x86, 0x07, 0x8A, 0x76, 0x4A, 0x9A, 0x3E, 0x71, 0xC2, 0x59, 0xBC, 0xDC, 0x5F, 0x8E, 0x66, 0xE1, 0xB5, 0x20, 0x55, 0xA2, 0x6D }, }, { { 0x1F, 0x23, 0xD7, 0xA6, 0x38, 0x17, 0x1F, 0x6D, 0x09, 0x99, 0x64, 0xE0, 0xFA, 0x01, 0x72, 0x1C, 0x06, 0xCC, 0xEB, 0x8E, 0xA2, 0x98, 0xBF, 0xD0, 0x04, 0x8E, 0x13, 0x8D, 0x98, 0xFC, 0x36, 0x24 }, }, { { 0x1F, 0xC7, 0xF8, 0x10, 0x4E, 0x27, 0xFF, 0x2A, 0x45, 0x56, 0xF9, 0x1E, 0x05, 0x42, 0x17, 0xC5, 0x8F, 0x69, 0x3F, 0x70, 0x36, 0x25, 0x9E, 0x39, 0x80, 0xB5, 0x59, 0x5B, 0x04, 0x3D, 0x11, 0x92 }, }, { { 0x20, 0x0B, 0x49, 0xBD, 0xD6, 0x35, 0x02, 0x57, 0xCC, 0xD4, 0xE6, 0xAD, 0xE1, 0xCB, 0x75, 0x13, 0x8D, 0xD6, 0xD9, 0x06, 0xFE, 0xF3, 0x49, 0xC0, 0xC9, 0x86, 0xA5, 0x1B, 0x29, 0xB9, 0xE5, 0x2D }, }, { { 0x21, 0x09, 0xF3, 0x10, 0x7D, 0x97, 0xF8, 0x70, 0x48, 0x70, 0x8E, 0xC8, 0x7C, 0xA2, 0xDC, 0x31, 0x8B, 0x2F, 0x2B, 0x57, 0x47, 0xC3, 0x38, 0xBD, 0x9C, 0x6D, 0xBC, 0xD6, 0x0F, 0xD6, 0xBE, 0xA2 }, }, { { 0x21, 0x78, 0xE8, 0x28, 0x3A, 0x73, 0x39, 0x6E, 0x08, 0xC0, 0xA1, 0x1A, 0x88, 0x72, 0xFA, 0x4A, 0x9F, 0xCC, 0x05, 0x67, 0x0C, 0xEE, 0xFF, 0xB8, 0x95, 0x83, 0x8E, 0xB6, 0x59, 0xDE, 0x38, 0xDB }, }, { { 0x22, 0x01, 0x71, 0xF7, 0x0E, 0x1F, 0xC3, 0xC4, 0xF7, 0x8D, 0xA6, 0xC8, 0xB1, 0xD7, 0x2C, 0x3B, 0xA8, 0x31, 0x9A, 0x46, 0xF8, 0x19, 0x2D, 0x1E, 0x19, 0xB9, 0xE2, 0x9A, 0xBA, 0x18, 0xEE, 0x87 }, }, { { 0x23, 0x19, 0xCB, 0x3D, 0x58, 0xC6, 0xD5, 0x53, 0x62, 0x5D, 0xE5, 0xF4, 0x25, 0x2B, 0xF0, 0x29, 0xAB, 0x83, 0x05, 0xEB, 0xF2, 0x2F, 0xA2, 0x3E, 0x99, 0x73, 0x04, 0x66, 0xDE, 0x24, 0xD6, 0xC3 }, }, { { 0x23, 0x8A, 0x80, 0xCC, 0x9B, 0x58, 0x9A, 0xDC, 0x89, 0xB7, 0xA8, 0xF3, 0x4D, 0xDF, 0x12, 0x48, 0x73, 0x4B, 0x9F, 0x7F, 0x78, 0x20, 0xB6, 0x04, 0x07, 0x66, 0xC5, 0x41, 0x3A, 0xD2, 0xBD, 0xEF }, }, { { 0x23, 0x9C, 0x79, 0x5F, 0x0C, 0x55, 0xA5, 0x53, 0x16, 0x2A, 0x9C, 0xA0, 0x6E, 0x88, 0x01, 0xE1, 0x19, 0xBD, 0xFF, 0x54, 0x35, 0x4A, 0x3F, 0x68, 0x43, 0xCF, 0x2A, 0x2F, 0xA6, 0x01, 0x75, 0x8E }, }, { { 0x24, 0x62, 0x52, 0x48, 0x32, 0xC1, 0x54, 0xD8, 0x4D, 0xF5, 0x8E, 0xD7, 0x75, 0x22, 0x3B, 0xBE, 0x25, 0x7D, 0xEA, 0xF7, 0x0E, 0xF9, 0xD2, 0x08, 0x61, 0x4E, 0xC0, 0xF5, 0x97, 0x7F, 0x6D, 0x58 }, }, { { 0x24, 0x6D, 0x0C, 0x31, 0x48, 0x72, 0x75, 0x59, 0xF9, 0x9A, 0xD0, 0xC1, 0x50, 0x37, 0x70, 0x06, 0xB7, 0xA1, 0x7A, 0x60, 0x3A, 0x47, 0x3B, 0x6A, 0xAC, 0xD2, 0x4E, 0x16, 0xC6, 0xC5, 0x1B, 0x42 }, }, { { 0x25, 0x1B, 0xB7, 0xC5, 0x42, 0x33, 0xDA, 0x44, 0xBF, 0x53, 0xB5, 0x8A, 0xF2, 0x9A, 0xE1, 0x74, 0xB9, 0x78, 0xBA, 0xDB, 0x89, 0xA9, 0x50, 0xAB, 0x3E, 0x5F, 0x9B, 0x4D, 0x0D, 0xCD, 0xBC, 0x62 }, }, { { 0x26, 0x03, 0xCB, 0xDF, 0x69, 0x75, 0xE3, 0x68, 0x83, 0x7F, 0x95, 0x1A, 0x00, 0x49, 0xFD, 0xC3, 0xC4, 0xB2, 0x39, 0xF0, 0x82, 0xF6, 0xBF, 0x89, 0x5D, 0xB8, 0xF3, 0x27, 0x05, 0xE6, 0x9C, 0xF3 }, }, { { 0x27, 0x50, 0x11, 0x93, 0xE4, 0x61, 0xCA, 0xCE, 0x55, 0x32, 0xFA, 0xD5, 0xD5, 0xB2, 0x7E, 0x01, 0x16, 0x57, 0x92, 0xE0, 0x4F, 0x24, 0x21, 0x93, 0x2F, 0x39, 0x28, 0xAF, 0x9F, 0xCD, 0xA4, 0xF3 }, }, { { 0x27, 0xA8, 0x41, 0xAE, 0xCF, 0xE0, 0xA1, 0x39, 0x37, 0x51, 0xC2, 0x55, 0xF9, 0x06, 0xDB, 0x9E, 0x88, 0x6B, 0xBA, 0x4D, 0x7C, 0x44, 0xEC, 0x63, 0xCE, 0x7D, 0xC6, 0xDE, 0xC1, 0x8B, 0xB9, 0x20 }, }, { { 0x28, 0x07, 0x10, 0x60, 0x44, 0x03, 0x45, 0xD0, 0x0E, 0x80, 0xB9, 0xD7, 0xCB, 0xE1, 0x87, 0xC1, 0xD8, 0xB0, 0xF2, 0xEF, 0x5D, 0x0A, 0xAC, 0x9C, 0xCE, 0xEF, 0x9A, 0x8C, 0x5A, 0x06, 0xF3, 0x02 }, }, { { 0x28, 0xD9, 0x51, 0x84, 0xB5, 0xEA, 0x14, 0x0F, 0x47, 0x4F, 0x3A, 0xF6, 0xCE, 0x70, 0x52, 0xE8, 0x59, 0x3C, 0xF3, 0xA5, 0x01, 0x0F, 0x52, 0x24, 0x1A, 0x1E, 0x36, 0x64, 0x60, 0xE5, 0x91, 0x9E }, }, { { 0x29, 0x01, 0x93, 0xE3, 0x7A, 0x38, 0x87, 0xFD, 0x36, 0x15, 0xDF, 0x12, 0x2E, 0x95, 0x21, 0x17, 0x42, 0x15, 0xEE, 0x68, 0xF7, 0x44, 0xB2, 0xFA, 0x35, 0xD2, 0x9C, 0x5D, 0xF1, 0x08, 0xF5, 0x5B }, }, { { 0x2A, 0x0F, 0x70, 0x67, 0x6E, 0x18, 0x4D, 0x49, 0x39, 0xA4, 0x04, 0xDE, 0x35, 0xAC, 0x84, 0xAB, 0x81, 0xAF, 0xEC, 0x36, 0x17, 0xE7, 0xE1, 0xBF, 0x34, 0x67, 0xD4, 0x19, 0x25, 0x5D, 0xD8, 0x17 }, }, { { 0x2A, 0xA6, 0x47, 0x8C, 0xC7, 0x5D, 0x67, 0xA8, 0xCA, 0x55, 0xB2, 0xE1, 0x63, 0xFD, 0xBB, 0xBC, 0x9D, 0x74, 0xB4, 0xE5, 0xF3, 0x7B, 0x7D, 0xBD, 0x13, 0xC9, 0x4E, 0x85, 0x8D, 0x40, 0xDA, 0xD0 }, }, { { 0x2B, 0xF1, 0xE3, 0xF0, 0x37, 0x5A, 0x9A, 0x21, 0xC0, 0x7A, 0x92, 0x18, 0x04, 0x2F, 0x18, 0x77, 0x3F, 0x43, 0xEA, 0xB0, 0xF5, 0xC0, 0x00, 0x26, 0x45, 0x40, 0x48, 0x2F, 0x04, 0xAE, 0x18, 0xEF }, }, { { 0x2C, 0x82, 0x47, 0x4F, 0x0E, 0xF6, 0xCB, 0x65, 0x0A, 0x13, 0xEF, 0x20, 0x99, 0x6E, 0x65, 0x7B, 0x67, 0x24, 0xF0, 0xA0, 0xD5, 0xEE, 0x24, 0x6D, 0x26, 0xBB, 0xFA, 0x0A, 0xBB, 0x2C, 0x22, 0xE1 }, }, { { 0x2C, 0x9B, 0xE1, 0x2D, 0xA4, 0x99, 0xEA, 0xBB, 0x2F, 0xFD, 0xF9, 0x91, 0x6F, 0x2B, 0x27, 0x18, 0x81, 0x19, 0x5B, 0x74, 0x19, 0xBD, 0x1E, 0xEF, 0x8D, 0x50, 0x77, 0x2A, 0xB9, 0x46, 0x4A, 0xA8 }, }, { { 0x2C, 0xBD, 0xD5, 0x6C, 0xE4, 0xB4, 0x06, 0x09, 0xE9, 0xAA, 0x52, 0x1E, 0xAA, 0x76, 0xAC, 0x7E, 0x55, 0x73, 0x7B, 0xF4, 0x3E, 0x2B, 0x0C, 0x30, 0xDD, 0xCF, 0x59, 0x87, 0x2E, 0xAB, 0xE7, 0x7B }, }, { { 0x2D, 0xDE, 0xE4, 0x5F, 0x72, 0x78, 0x38, 0xDE, 0xAD, 0xE6, 0x7E, 0x9C, 0xA7, 0x05, 0xEB, 0xB4, 0xC2, 0xE9, 0x40, 0xAE, 0x1B, 0x9D, 0x62, 0x35, 0x72, 0x18, 0x04, 0x58, 0x31, 0xE9, 0x8F, 0xDE }, }, { { 0x2E, 0x5D, 0xD2, 0x55, 0x09, 0x6D, 0x64, 0x83, 0x10, 0x5C, 0xB6, 0x03, 0x6C, 0x59, 0x17, 0x57, 0xFD, 0x98, 0x49, 0x70, 0x66, 0x05, 0x3F, 0x83, 0x39, 0xE4, 0xD8, 0xD0, 0xC3, 0x75, 0x49, 0x03 }, }, { { 0x2E, 0xD2, 0x05, 0x8F, 0x39, 0xEA, 0xBA, 0x5C, 0xB3, 0xD7, 0xDF, 0x24, 0xCA, 0x74, 0xA7, 0x7D, 0xDC, 0x12, 0x06, 0x01, 0x52, 0x7B, 0x0F, 0x51, 0x06, 0x91, 0x05, 0xCA, 0x88, 0x37, 0x6E, 0x20 }, }, { { 0x30, 0x7B, 0x09, 0x34, 0xEF, 0x97, 0x85, 0xE7, 0x08, 0xED, 0x48, 0x1A, 0x99, 0x7A, 0x8A, 0x88, 0xB7, 0xBF, 0x22, 0xDD, 0x26, 0xAA, 0x17, 0x17, 0x31, 0xB8, 0xF7, 0xE0, 0xD5, 0x97, 0xB7, 0x08 }, }, { { 0x30, 0xCB, 0x41, 0x11, 0xFB, 0x10, 0x08, 0x6F, 0xC6, 0xA4, 0x1F, 0x04, 0xB7, 0xE9, 0xD4, 0xCF, 0x66, 0x10, 0xBB, 0x06, 0x59, 0xD8, 0xE2, 0xAC, 0x80, 0x4F, 0xC8, 0x96, 0xB0, 0x25, 0x42, 0xBB }, }, { { 0x30, 0xE0, 0x69, 0x80, 0x9C, 0x79, 0x90, 0xF0, 0xB5, 0xF2, 0x66, 0xE8, 0x94, 0x59, 0x96, 0x42, 0xE8, 0x53, 0x50, 0xAB, 0x82, 0x81, 0x05, 0x34, 0xC7, 0xF3, 0xFD, 0x67, 0x0C, 0x1B, 0xEB, 0x18 }, }, { { 0x31, 0x53, 0x47, 0x52, 0xB6, 0xF5, 0x48, 0x20, 0x91, 0x5C, 0x39, 0x5B, 0xEE, 0x97, 0x5B, 0xC5, 0x4E, 0x3F, 0x07, 0xC0, 0x8C, 0xD3, 0x4C, 0x5A, 0x51, 0x15, 0xDE, 0xF0, 0x17, 0xDB, 0x2B, 0x54 }, }, { { 0x31, 0xB8, 0x3E, 0x01, 0x90, 0x98, 0x95, 0xBC, 0x74, 0x2D, 0x6B, 0xE8, 0x40, 0x0A, 0xDE, 0x51, 0xB2, 0x09, 0x83, 0xF6, 0x83, 0xA2, 0xAA, 0xEE, 0xB2, 0x5F, 0x58, 0xDF, 0x98, 0x1B, 0xDE, 0x0D }, }, { { 0x32, 0xEF, 0x13, 0x33, 0x86, 0xBF, 0x0C, 0x63, 0xCF, 0x29, 0xD6, 0x2B, 0x0D, 0x76, 0x88, 0x9E, 0x9D, 0x9D, 0x53, 0x2E, 0xE4, 0x90, 0x38, 0x94, 0x4D, 0xBC, 0x21, 0x49, 0xD8, 0xCA, 0xA5, 0xD1 }, }, { { 0x34, 0x06, 0x4F, 0xF9, 0x3B, 0x27, 0x4C, 0xF5, 0xA7, 0x24, 0xEC, 0x19, 0x64, 0x50, 0x4A, 0x71, 0x0A, 0xB9, 0x7B, 0xA1, 0x10, 0x3C, 0xD9, 0xB9, 0x8C, 0x81, 0xD0, 0xAB, 0xCF, 0x3B, 0x19, 0xBD }, }, { { 0x34, 0x65, 0xC2, 0xF9, 0xA0, 0xCF, 0x36, 0xE5, 0xEE, 0xF0, 0x27, 0x1C, 0x52, 0x91, 0x2D, 0x58, 0x6F, 0xB2, 0x0B, 0x94, 0x43, 0xE7, 0xD5, 0x82, 0xA3, 0xE2, 0x23, 0x93, 0xFA, 0xC8, 0x1B, 0xB4 }, }, { { 0x35, 0x98, 0x10, 0xFF, 0xFE, 0xD1, 0x3A, 0x2C, 0x25, 0xCD, 0x91, 0xFC, 0xF0, 0x85, 0x59, 0x33, 0xC9, 0x94, 0xA9, 0xDF, 0xC9, 0x39, 0x2D, 0x97, 0x07, 0xC3, 0xC0, 0xE7, 0x30, 0x0F, 0x90, 0x8D }, }, { { 0x35, 0xDF, 0x79, 0x2B, 0x10, 0x0A, 0x79, 0xA6, 0x5C, 0x44, 0x87, 0x04, 0x30, 0x9D, 0xD6, 0x4B, 0x54, 0x39, 0x4E, 0xBA, 0xE8, 0xC4, 0x8C, 0x3B, 0xD5, 0xDE, 0xE9, 0xCC, 0x68, 0x7D, 0x60, 0x34 }, }, { { 0x36, 0x45, 0xEF, 0x7F, 0x5D, 0x15, 0xA5, 0x46, 0x7E, 0x85, 0x30, 0x7D, 0xDA, 0x15, 0xCB, 0xBB, 0x55, 0xB7, 0x30, 0xAE, 0xF8, 0xEF, 0x9C, 0x71, 0x5D, 0x7D, 0x9F, 0xB4, 0x7F, 0xDF, 0x33, 0xAD }, }, { { 0x36, 0xB4, 0xFE, 0x74, 0x3B, 0x6D, 0xF4, 0x4A, 0x71, 0x3E, 0x91, 0x4C, 0xAB, 0xFB, 0xF2, 0xBE, 0x60, 0x24, 0x9B, 0x46, 0x43, 0x4D, 0x04, 0x43, 0x59, 0x12, 0x5A, 0x10, 0x6A, 0x37, 0xEB, 0x1C }, }, { { 0x36, 0xF5, 0xA9, 0x7D, 0x79, 0x3F, 0x84, 0x97, 0x44, 0xD6, 0xAB, 0x39, 0xB7, 0xA8, 0x18, 0xF8, 0x17, 0x6E, 0x65, 0x20, 0xDC, 0x86, 0x3D, 0xCE, 0x43, 0xB3, 0x98, 0xC3, 0x0B, 0x5E, 0xDB, 0x09 }, }, { { 0x38, 0x23, 0x4E, 0x55, 0x9D, 0x30, 0x27, 0xD1, 0x61, 0xDA, 0x8C, 0x98, 0x88, 0x04, 0x9A, 0x4D, 0x20, 0xAC, 0xF2, 0x00, 0x90, 0xAD, 0x1A, 0x22, 0x2B, 0x73, 0x9A, 0xC8, 0x6E, 0xB7, 0x6F, 0x06 }, }, { { 0x39, 0x02, 0x27, 0xCE, 0x88, 0x1C, 0x71, 0x8B, 0x59, 0xA6, 0xBC, 0x31, 0x90, 0xD5, 0x17, 0xE7, 0x1E, 0x1E, 0x58, 0x66, 0x93, 0xC8, 0xBF, 0x8A, 0x30, 0x27, 0x26, 0x20, 0x13, 0xFE, 0x16, 0x63 }, }, { { 0x39, 0x21, 0x5C, 0xAA, 0x37, 0x1A, 0xBE, 0x57, 0x6A, 0xB9, 0x3B, 0x18, 0xC2, 0xF3, 0x75, 0x5E, 0xE2, 0x6F, 0x8C, 0x3A, 0xDB, 0x75, 0x9B, 0x6F, 0x34, 0x78, 0x9F, 0xB8, 0xEC, 0xF0, 0x54, 0x28 }, }, { { 0x39, 0x7B, 0xA8, 0x8A, 0x05, 0xDA, 0xFD, 0x7D, 0x58, 0xFA, 0xCF, 0x45, 0x60, 0xA6, 0x88, 0xAB, 0xEE, 0xD2, 0x13, 0xE0, 0xF8, 0x8C, 0x76, 0xB6, 0x2A, 0xB2, 0xFD, 0xE3, 0x67, 0xC3, 0x2D, 0x32 }, }, { { 0x39, 0x7D, 0x00, 0x6E, 0xF8, 0xAF, 0xB2, 0x0F, 0x43, 0x61, 0xA6, 0xC9, 0x72, 0xF0, 0xC5, 0x7C, 0xC0, 0x87, 0x74, 0x01, 0x06, 0x12, 0x78, 0x3F, 0xBA, 0xBC, 0xB8, 0xD6, 0xF6, 0x03, 0x9E, 0x2C }, }, { { 0x3A, 0xCF, 0x85, 0x3C, 0x4E, 0x45, 0x02, 0xBD, 0x82, 0xD5, 0x85, 0xD5, 0xE0, 0x82, 0xC4, 0xB3, 0xAD, 0x03, 0xCD, 0xB6, 0xB5, 0x05, 0xCA, 0x80, 0x47, 0x19, 0x88, 0xEC, 0x4C, 0x58, 0x99, 0x9E }, }, { { 0x3A, 0xEA, 0x2C, 0xEF, 0xAE, 0x63, 0x44, 0xFF, 0xAE, 0x67, 0x49, 0x4C, 0x68, 0x4E, 0x1E, 0xBF, 0x87, 0x95, 0x40, 0xB5, 0x3D, 0x40, 0xF5, 0x16, 0x9F, 0x78, 0x89, 0x7F, 0x1B, 0x38, 0xAB, 0x66 }, }, { { 0x3B, 0x47, 0x85, 0x0B, 0xF8, 0x4C, 0x4C, 0xF2, 0xCA, 0x6C, 0x31, 0xB3, 0x78, 0x39, 0xC9, 0x50, 0x76, 0x63, 0x70, 0xD7, 0xF4, 0xB6, 0x4A, 0xD0, 0x18, 0x55, 0xCA, 0xCF, 0xE3, 0x51, 0x2F, 0xC3 }, }, { { 0x3B, 0x6E, 0x3B, 0xB7, 0x00, 0x04, 0xBD, 0x78, 0xC9, 0x69, 0xA7, 0xFB, 0xD5, 0x11, 0x33, 0xA2, 0xB3, 0xC4, 0xDF, 0xB6, 0xBA, 0x38, 0x5D, 0xCE, 0x3F, 0xB8, 0x4D, 0x73, 0x6B, 0xEA, 0xB1, 0xD9 }, }, { { 0x3B, 0xAA, 0x31, 0x31, 0x70, 0x68, 0xAC, 0xE0, 0x89, 0xAE, 0xB4, 0xA8, 0x8D, 0x7E, 0xDE, 0xBE, 0x94, 0xAB, 0x4A, 0xCE, 0x46, 0xBB, 0xD2, 0x68, 0x3E, 0x3F, 0xDF, 0xF5, 0x59, 0x30, 0x0F, 0x93 }, }, { { 0x3C, 0x38, 0x36, 0x2E, 0x16, 0x8B, 0xB4, 0xA7, 0x59, 0xC4, 0x80, 0x55, 0x1C, 0xB1, 0x65, 0x6F, 0x6A, 0x96, 0x8B, 0x9B, 0x43, 0xCB, 0xE0, 0xD7, 0x39, 0x75, 0x4A, 0xB7, 0x8A, 0x28, 0x87, 0x0E }, }, { { 0x3D, 0x14, 0x47, 0x2D, 0xCE, 0x4A, 0xFD, 0xC2, 0x27, 0x6C, 0x81, 0x47, 0x97, 0xC7, 0xBC, 0x7A, 0x6C, 0x14, 0xF7, 0x95, 0x3E, 0x7E, 0x9F, 0xEA, 0x69, 0x51, 0x04, 0x0F, 0x2D, 0xAF, 0xBE, 0x9A }, }, { { 0x3E, 0x8E, 0x9B, 0xAD, 0x8E, 0xD9, 0xB5, 0x72, 0x38, 0x2E, 0x59, 0x8D, 0x2D, 0x73, 0x67, 0xE1, 0xFD, 0x6A, 0xF6, 0x95, 0x25, 0x00, 0x9D, 0x67, 0xB4, 0xE8, 0xAF, 0x80, 0xD9, 0x15, 0x85, 0x49 }, }, { { 0x3F, 0x27, 0xBD, 0xCA, 0x9B, 0x0E, 0x42, 0xF3, 0xF6, 0xD0, 0x91, 0x2C, 0x92, 0xE2, 0xDA, 0x65, 0xCB, 0x35, 0x8F, 0x0B, 0x8F, 0x80, 0x5B, 0xEC, 0x5D, 0xE9, 0x32, 0x51, 0xD9, 0xC4, 0xB1, 0x99 }, }, { { 0x3F, 0x2E, 0xA6, 0x4E, 0xFB, 0xD6, 0xBF, 0xC4, 0x0A, 0xF0, 0xAD, 0x46, 0xA4, 0xA2, 0x57, 0x84, 0x19, 0xD8, 0x68, 0x6E, 0x38, 0x98, 0x8B, 0x91, 0x47, 0x01, 0x8C, 0x36, 0x29, 0x31, 0xE4, 0xF9 }, }, { { 0x3F, 0x4F, 0x28, 0x8B, 0xAF, 0x5B, 0xDE, 0x86, 0x72, 0xD6, 0xAD, 0xD1, 0x50, 0xE3, 0x23, 0x79, 0x49, 0x9A, 0x16, 0xC5, 0x81, 0xFB, 0x77, 0x37, 0xEC, 0x49, 0x80, 0xE4, 0xF9, 0xC3, 0x3D, 0x4D }, }, { { 0x3F, 0x92, 0x54, 0x89, 0x64, 0xCC, 0xDE, 0xFB, 0x29, 0x96, 0x5A, 0x27, 0xC1, 0x6C, 0x2F, 0xED, 0x28, 0xD9, 0xB9, 0x14, 0x0E, 0x4F, 0xB5, 0x5B, 0x37, 0x22, 0x4C, 0x67, 0xB2, 0xA0, 0x55, 0x1F }, }, { { 0x40, 0x58, 0xEC, 0x4A, 0x7A, 0x7B, 0xA0, 0xB8, 0x65, 0xA7, 0x39, 0xA0, 0x0C, 0x85, 0xF3, 0x44, 0x58, 0x79, 0xD6, 0x5E, 0x1D, 0x42, 0x2E, 0xED, 0x07, 0x65, 0x5A, 0x8E, 0x3E, 0xC3, 0x18, 0xCF }, }, { { 0x41, 0x29, 0x6B, 0x9F, 0xAA, 0xD6, 0x41, 0x33, 0xFC, 0xCB, 0xA6, 0xBA, 0x74, 0x54, 0x11, 0xEC, 0xC9, 0x11, 0xFD, 0x8E, 0xD5, 0x41, 0x90, 0x0F, 0x9E, 0x20, 0x36, 0x08, 0xEE, 0xA3, 0x59, 0x2D }, }, { { 0x41, 0x88, 0x71, 0x80, 0x7E, 0xDC, 0xED, 0xA8, 0x57, 0xD7, 0xE8, 0x48, 0x31, 0x71, 0x81, 0xE1, 0xE8, 0x33, 0xF5, 0x4C, 0x89, 0xA6, 0x11, 0xA2, 0x30, 0xAD, 0x99, 0x06, 0x5D, 0x45, 0x86, 0x95 }, }, { { 0x41, 0xA6, 0x8D, 0xFD, 0x90, 0xDA, 0x6D, 0x12, 0x09, 0x84, 0x85, 0xBF, 0x6F, 0x87, 0x24, 0x5F, 0x4E, 0xC0, 0x54, 0x71, 0xDA, 0x59, 0xD0, 0x81, 0x06, 0x01, 0x53, 0xA2, 0x22, 0x25, 0x23, 0x7F }, }, { { 0x42, 0x08, 0x71, 0xD8, 0xAC, 0x49, 0x3C, 0xF9, 0x46, 0x8B, 0xB3, 0x76, 0x97, 0x6D, 0x65, 0x5E, 0xF0, 0xAF, 0xAA, 0xC2, 0x3D, 0x77, 0x00, 0x92, 0x20, 0xC3, 0xAF, 0x8B, 0xDD, 0x37, 0x5A, 0x24 }, }, { { 0x42, 0x5D, 0x4E, 0xBF, 0x1B, 0xDE, 0x0B, 0xF8, 0xD1, 0xDB, 0xD3, 0x3D, 0x8D, 0x16, 0x34, 0xC4, 0xFA, 0xFE, 0xB6, 0xF8, 0x05, 0xF1, 0xCC, 0xB5, 0x34, 0xAC, 0xB7, 0x2A, 0xED, 0xA2, 0xCD, 0x0A }, }, { { 0x44, 0x12, 0x63, 0x80, 0xA0, 0x73, 0xFE, 0xA1, 0xA2, 0x00, 0x4F, 0x71, 0x1D, 0xF2, 0xCA, 0x47, 0xC2, 0xC4, 0xB4, 0xFF, 0x64, 0x4E, 0x76, 0xAF, 0xBE, 0x27, 0x97, 0xC9, 0x63, 0x7C, 0x6A, 0xF9 }, }, { { 0x44, 0x25, 0xDD, 0xFB, 0xBA, 0xFB, 0xE1, 0xAA, 0xCE, 0x25, 0x85, 0x70, 0x48, 0x96, 0x9D, 0xC8, 0x9D, 0xF5, 0x97, 0x7B, 0xB2, 0xE3, 0x34, 0x7C, 0x9C, 0xEB, 0x0E, 0x5A, 0x7B, 0x68, 0xC5, 0x31 }, }, { { 0x45, 0x63, 0xCF, 0x13, 0xC2, 0x49, 0x2C, 0xAA, 0x92, 0xF5, 0x5B, 0x17, 0x26, 0x3A, 0xDD, 0x72, 0x04, 0xA8, 0x0F, 0xE6, 0x24, 0x0C, 0x4D, 0x63, 0xE8, 0x39, 0x59, 0x58, 0xF6, 0x94, 0xCD, 0x33 }, }, { { 0x45, 0xCB, 0x86, 0xCA, 0x97, 0x52, 0x29, 0xB7, 0xD5, 0xDA, 0xFC, 0x05, 0xEB, 0x0C, 0x53, 0x65, 0x82, 0x3A, 0x91, 0xA9, 0x8B, 0x7D, 0xBE, 0x81, 0xAB, 0x5F, 0x17, 0x8B, 0x2D, 0xA4, 0xAD, 0x9E }, }, { { 0x46, 0x9B, 0xD8, 0x04, 0xE9, 0x98, 0xAE, 0x27, 0x9A, 0xC3, 0xFE, 0x1B, 0x52, 0x88, 0x46, 0xE7, 0xAE, 0xC7, 0x6C, 0x56, 0xB8, 0x0B, 0x40, 0xF3, 0x24, 0x20, 0x8F, 0x5A, 0x9F, 0x64, 0x5C, 0xB5 }, }, { { 0x46, 0xCD, 0x08, 0x08, 0x8D, 0x36, 0x06, 0x2C, 0x56, 0x71, 0x09, 0x2C, 0x02, 0x76, 0x7A, 0x25, 0x0D, 0xE7, 0x0B, 0xF3, 0xE1, 0x53, 0x63, 0x69, 0x66, 0xE6, 0x6E, 0xC5, 0x7E, 0x8E, 0xE9, 0xF5 }, }, { { 0x47, 0x84, 0xF6, 0xCD, 0x59, 0x3D, 0x7B, 0x31, 0x2E, 0xB1, 0xF6, 0x19, 0xE1, 0x11, 0xDF, 0x3B, 0x48, 0x6D, 0x1B, 0xF8, 0x37, 0x15, 0xAD, 0x8D, 0xAB, 0xA5, 0x72, 0xAF, 0xB2, 0x61, 0xD5, 0xBE }, }, { { 0x48, 0xC5, 0xD4, 0xFF, 0x5D, 0x08, 0x4A, 0xC1, 0x95, 0xB1, 0xA6, 0xA2, 0x19, 0xF8, 0x1B, 0xBD, 0xF9, 0xD2, 0xE5, 0xC0, 0x70, 0xEC, 0x97, 0xDF, 0x3C, 0xB0, 0xB7, 0x3E, 0xF4, 0x70, 0xDC, 0xE9 }, }, { { 0x49, 0xDC, 0xF8, 0xFA, 0x68, 0xE9, 0x2B, 0x5C, 0x21, 0xFE, 0xF9, 0x3D, 0x26, 0x0C, 0x24, 0x8C, 0xE3, 0xBE, 0x98, 0x62, 0x68, 0x68, 0xE7, 0x5A, 0x3F, 0x63, 0x34, 0xBB, 0x7D, 0xC1, 0x81, 0xEC }, }, { { 0x4B, 0x1F, 0xC8, 0x2D, 0x24, 0x72, 0x92, 0x7A, 0xC1, 0x7C, 0x58, 0x43, 0x07, 0xCB, 0x96, 0xD6, 0xFD, 0xDB, 0x8D, 0x50, 0xA5, 0x29, 0x53, 0x07, 0xD3, 0x0C, 0x75, 0x88, 0x59, 0x6A, 0xD4, 0x0B }, }, { { 0x4B, 0x35, 0x02, 0xFF, 0xAD, 0x64, 0x16, 0x39, 0x4F, 0x2F, 0x78, 0x47, 0x76, 0x13, 0x39, 0x69, 0xA5, 0x5C, 0xA8, 0xF3, 0x9F, 0x78, 0x3C, 0x26, 0x0F, 0xFE, 0xDB, 0xA8, 0xFC, 0xE4, 0x19, 0x70 }, }, { { 0x4B, 0x51, 0xFC, 0x11, 0x4B, 0xAC, 0x8E, 0x2D, 0x2A, 0xF2, 0xAE, 0x56, 0x84, 0x42, 0x9C, 0xCA, 0xAB, 0x21, 0x39, 0xC9, 0xB3, 0x51, 0xBF, 0x7E, 0x1B, 0x03, 0x0A, 0xE8, 0x62, 0x4A, 0xC1, 0x72 }, }, { { 0x4C, 0xD0, 0xD6, 0x7E, 0xCC, 0x3B, 0x01, 0xC8, 0xC2, 0x63, 0x4E, 0x7A, 0x73, 0x76, 0x12, 0xF6, 0x3A, 0x17, 0xFF, 0x51, 0x0A, 0x77, 0xA8, 0x04, 0xBB, 0x33, 0x1B, 0x2B, 0xE5, 0x8D, 0xFE, 0x0C }, }, { { 0x4D, 0xCF, 0xEB, 0xDC, 0x15, 0x4B, 0x0C, 0x85, 0x46, 0x7F, 0x6F, 0x52, 0xAD, 0x80, 0x4E, 0x19, 0x1D, 0x5B, 0xC8, 0x13, 0x51, 0x72, 0x0E, 0xC0, 0xD1, 0x9B, 0xD2, 0x5B, 0xF8, 0xF0, 0xA5, 0x53 }, }, { { 0x4F, 0x19, 0xDD, 0x12, 0x92, 0x4C, 0xE0, 0xC1, 0x4F, 0x82, 0xC0, 0x56, 0xC7, 0xD4, 0x2B, 0xAC, 0x43, 0xD0, 0x13, 0x3A, 0xAF, 0x89, 0xC1, 0xEF, 0xDC, 0xFA, 0x3C, 0x3E, 0x47, 0x09, 0x7D, 0x59 }, }, { { 0x4F, 0xFB, 0x59, 0x19, 0xBC, 0x38, 0x5C, 0x8C, 0x58, 0xE4, 0x62, 0xBF, 0x13, 0x22, 0x10, 0xD8, 0xB7, 0x86, 0x12, 0xD0, 0xC2, 0x2A, 0x6B, 0x6A, 0x68, 0x2E, 0x0B, 0x9E, 0x9C, 0x9F, 0x9A, 0x44 }, }, { { 0x50, 0xF4, 0x78, 0x1E, 0xB1, 0xC1, 0x46, 0x70, 0xD9, 0xA5, 0x52, 0xC3, 0x49, 0x5F, 0xB9, 0xF6, 0xAE, 0x86, 0x8A, 0xB1, 0xC9, 0xD9, 0x83, 0xE0, 0x82, 0x68, 0x65, 0xA1, 0x02, 0xEC, 0xA6, 0xD3 }, }, { { 0x51, 0x6A, 0x2F, 0x33, 0x60, 0xC7, 0x6F, 0xC4, 0x6A, 0xB2, 0x88, 0x7F, 0x88, 0xE8, 0xD0, 0x8E, 0xFB, 0xD8, 0x44, 0x5A, 0xA7, 0xBB, 0xD2, 0x29, 0xDF, 0xC7, 0x1A, 0x90, 0x4F, 0x55, 0xAE, 0xB4 }, }, { { 0x52, 0x1F, 0x6C, 0x6A, 0x84, 0x36, 0x65, 0x79, 0xCA, 0x2D, 0xEA, 0xEB, 0x23, 0x15, 0xBF, 0x8E, 0x53, 0x1C, 0x9F, 0xA4, 0x7B, 0x89, 0x9D, 0xA2, 0x72, 0x16, 0xA9, 0x98, 0x82, 0x86, 0xAF, 0xE5 }, }, { { 0x52, 0xFF, 0x8B, 0x6E, 0x98, 0xB0, 0x96, 0x19, 0x90, 0x03, 0xDE, 0x97, 0xBC, 0xCF, 0xD2, 0xA7, 0xF1, 0xAC, 0x57, 0xA8, 0x31, 0x35, 0xB9, 0x55, 0xFF, 0x68, 0x63, 0x36, 0xA6, 0x91, 0xD5, 0xCA }, }, { { 0x53, 0x79, 0x64, 0x58, 0xDA, 0x97, 0xCE, 0x36, 0x78, 0xF2, 0xD1, 0xD9, 0xB2, 0xA5, 0xB2, 0xFB, 0x30, 0x75, 0xEA, 0xFA, 0xF6, 0xFF, 0x04, 0x78, 0xB5, 0x72, 0xDD, 0xFD, 0x70, 0x99, 0xAE, 0xE2 }, }, { { 0x53, 0x9C, 0xA9, 0xE1, 0xF0, 0x6A, 0xF2, 0x10, 0x7F, 0x96, 0xBF, 0x4B, 0x7D, 0xD4, 0xCE, 0xCD, 0x9E, 0xD1, 0x1A, 0x38, 0xD6, 0x70, 0x91, 0x69, 0x9C, 0x56, 0x26, 0xE2, 0x7A, 0x1F, 0x54, 0xA5 }, }, { { 0x55, 0x21, 0xF9, 0x63, 0x57, 0x81, 0x58, 0xB8, 0xD0, 0xE7, 0xC4, 0x91, 0xCD, 0xB8, 0x5C, 0x3D, 0xE9, 0xD5, 0x2E, 0xA5, 0x1F, 0xFC, 0xB0, 0x93, 0xD3, 0x12, 0x28, 0x11, 0x13, 0x14, 0x97, 0xEB }, }, { { 0x55, 0xD0, 0xEB, 0xE3, 0x2C, 0xBA, 0x09, 0xF6, 0x58, 0x4D, 0x9E, 0x7B, 0x57, 0x92, 0xA4, 0x03, 0xC2, 0x1D, 0x39, 0xD6, 0xE1, 0xF5, 0xE8, 0xED, 0x37, 0xB9, 0x3F, 0xA6, 0x1D, 0x88, 0x35, 0x16 }, }, { { 0x58, 0x1A, 0xDE, 0x64, 0x84, 0x95, 0xB4, 0xB1, 0x62, 0x9C, 0x3C, 0x7C, 0x78, 0xEF, 0xBE, 0xF2, 0x75, 0x06, 0x56, 0x65, 0xB2, 0x41, 0x1C, 0x0E, 0x5F, 0xCF, 0xBC, 0x7E, 0xB4, 0xBE, 0x34, 0x0B }, }, { { 0x59, 0xC9, 0xE8, 0xDF, 0x03, 0x0B, 0x1C, 0xD5, 0x89, 0xA8, 0xB3, 0x4F, 0xE7, 0x42, 0x51, 0xEA, 0xD5, 0xA5, 0xFB, 0xE9, 0xE6, 0x13, 0x67, 0xCA, 0x76, 0xAF, 0xD9, 0xDD, 0xD9, 0xC6, 0xF1, 0x6F }, }, { { 0x59, 0xE9, 0xFA, 0x2F, 0xF0, 0x76, 0x89, 0x33, 0x28, 0x33, 0xC6, 0x40, 0xF5, 0x05, 0xFA, 0x24, 0x09, 0xEB, 0x88, 0x93, 0x32, 0x57, 0xC1, 0x93, 0xB0, 0x07, 0xD3, 0xA2, 0x89, 0x6A, 0x98, 0x50 }, }, { { 0x59, 0xEE, 0x9B, 0x36, 0x80, 0xAE, 0x20, 0x56, 0x83, 0x9C, 0x0B, 0xF6, 0x9E, 0xE6, 0x63, 0x26, 0x57, 0x16, 0xA8, 0xE2, 0x4C, 0xC6, 0x49, 0x95, 0xFB, 0xA6, 0xCB, 0x6F, 0x0C, 0x12, 0x39, 0xDC }, }, { { 0x5A, 0x84, 0xAF, 0xE6, 0x74, 0x05, 0xAB, 0xE8, 0x4A, 0x0C, 0xD4, 0x2C, 0x2B, 0xA2, 0xE4, 0xC8, 0x8F, 0x35, 0xE0, 0xA5, 0x95, 0xE5, 0x69, 0xA3, 0xE1, 0x86, 0x69, 0x44, 0x40, 0x5B, 0xE7, 0x36 }, }, { { 0x5A, 0x8E, 0x86, 0x21, 0x2C, 0x06, 0x33, 0x94, 0x94, 0xF8, 0x5B, 0x5F, 0x85, 0x11, 0xDF, 0x00, 0x00, 0x23, 0x94, 0x07, 0x8F, 0xFC, 0x77, 0x4D, 0x43, 0x6F, 0x0D, 0x63, 0x86, 0xD7, 0xA6, 0xF7 }, }, { { 0x5A, 0xC0, 0x98, 0x2D, 0xA0, 0xC8, 0x3D, 0x0B, 0xA9, 0x38, 0x1A, 0x5C, 0xD8, 0x7B, 0x80, 0xD1, 0x10, 0xF2, 0x6E, 0xE8, 0x39, 0x27, 0x1B, 0xC2, 0x70, 0x60, 0x8F, 0xD1, 0x43, 0x7F, 0x55, 0xB0 }, }, { { 0x5B, 0x29, 0x3D, 0x30, 0x9F, 0x64, 0x24, 0xBC, 0x26, 0x4F, 0x4B, 0xB0, 0x18, 0xAE, 0xF5, 0x0E, 0x63, 0xE3, 0x37, 0xD1, 0x4D, 0xF0, 0x64, 0xC5, 0x7A, 0x23, 0x52, 0x83, 0x42, 0x16, 0x1C, 0x68 }, }, { { 0x5C, 0x7F, 0xF0, 0x55, 0xC2, 0xFD, 0x03, 0x3F, 0x34, 0xC4, 0xC4, 0xF7, 0xC4, 0xFB, 0x7D, 0xDA, 0xAA, 0xFB, 0x43, 0x56, 0xC5, 0x60, 0xC9, 0x9E, 0xDF, 0xF0, 0x74, 0xDA, 0x04, 0xAF, 0x65, 0x7C }, }, { { 0x5C, 0xD2, 0x44, 0x6A, 0x8E, 0x4A, 0x0F, 0xA7, 0xE3, 0xCD, 0xF8, 0x00, 0x5D, 0xED, 0xCE, 0xBA, 0xE9, 0xE6, 0x81, 0x9A, 0x8A, 0x69, 0x87, 0x31, 0x55, 0x5B, 0x7D, 0xC9, 0xD0, 0xA2, 0x3F, 0xC0 }, }, { { 0x5C, 0xEB, 0xEB, 0xD8, 0x34, 0x01, 0xB7, 0x0B, 0xAC, 0xB5, 0x4F, 0x66, 0xA9, 0xB7, 0x78, 0x55, 0x69, 0x6E, 0xCE, 0x16, 0x7F, 0xE6, 0xC6, 0x0A, 0x05, 0x16, 0x8B, 0xE4, 0x39, 0x19, 0xC8, 0x0F }, }, { { 0x5E, 0x23, 0xDB, 0xD4, 0xD0, 0xC9, 0xBF, 0xB1, 0x5F, 0x61, 0x6A, 0x95, 0x17, 0xA1, 0x30, 0xD8, 0x66, 0xA8, 0xCB, 0x0B, 0x18, 0x96, 0x3D, 0x54, 0xE7, 0xED, 0xAE, 0xE2, 0x61, 0xCB, 0x1C, 0x19 }, }, { { 0x5F, 0x8B, 0x88, 0x8E, 0xE9, 0x6C, 0x0C, 0x0F, 0x5A, 0x91, 0x72, 0x90, 0xAC, 0xA6, 0x5A, 0xFD, 0x6E, 0xBD, 0xAE, 0x05, 0xA0, 0x2A, 0xAF, 0x04, 0x29, 0xE9, 0x72, 0xEC, 0x01, 0x90, 0xEC, 0xFC }, }, { { 0x62, 0x2E, 0xC3, 0xBE, 0x7C, 0xF5, 0xE4, 0xE6, 0x3F, 0x74, 0x18, 0x69, 0x28, 0x74, 0x40, 0x05, 0xCB, 0xB7, 0x8D, 0xF3, 0x06, 0xB8, 0x67, 0xC3, 0xFC, 0xAD, 0x5E, 0x2B, 0xA7, 0x53, 0x96, 0x83 }, }, { { 0x62, 0x6F, 0x7E, 0xB4, 0xFD, 0x9B, 0x71, 0xFF, 0xAA, 0x0C, 0x8E, 0xC9, 0x65, 0x54, 0x64, 0xE6, 0x5E, 0x7F, 0x96, 0xCF, 0xA3, 0x82, 0x73, 0x97, 0x41, 0x35, 0x66, 0xAA, 0x2C, 0xC1, 0xE5, 0x72 }, }, { { 0x63, 0x64, 0x15, 0x61, 0x77, 0xDC, 0xDF, 0x60, 0x4D, 0xF9, 0x1E, 0x31, 0x32, 0x2E, 0x57, 0x74, 0x69, 0x1E, 0x0C, 0x41, 0xFA, 0x0D, 0x2F, 0x25, 0x7A, 0xD7, 0xF9, 0xF0, 0x25, 0x98, 0x14, 0x45 }, }, { { 0x65, 0x66, 0x00, 0xA4, 0x5E, 0x45, 0x6A, 0xBA, 0x5B, 0x00, 0x8D, 0x87, 0x91, 0x54, 0xB7, 0x69, 0x0D, 0x7F, 0x27, 0x31, 0x02, 0x09, 0x7D, 0x8F, 0xD8, 0xC3, 0xDE, 0xAB, 0x30, 0xD8, 0x4A, 0xB2 }, }, { { 0x65, 0xED, 0x61, 0xA8, 0x8C, 0x55, 0xEF, 0xB0, 0x38, 0x07, 0x1A, 0xEE, 0xDE, 0xF8, 0xE1, 0x83, 0xE2, 0x37, 0x38, 0x46, 0x97, 0x26, 0xEB, 0x99, 0x68, 0x0C, 0xD2, 0x44, 0x72, 0x73, 0x6B, 0xEC }, }, { { 0x66, 0x50, 0xB2, 0xEA, 0x64, 0x4C, 0x3F, 0x4E, 0x8C, 0x9E, 0x3C, 0x46, 0xAC, 0xEA, 0xC4, 0x52, 0x33, 0xD8, 0x66, 0xE3, 0x98, 0xFF, 0x90, 0xEB, 0x59, 0xB2, 0xC6, 0x25, 0x20, 0x82, 0xAC, 0x04 }, }, { { 0x66, 0xBE, 0x7E, 0xA1, 0x13, 0x8B, 0xCB, 0xA4, 0xDE, 0x0B, 0x41, 0x28, 0x5D, 0x9A, 0x13, 0x3F, 0xA7, 0xF5, 0x70, 0xA3, 0xC8, 0x13, 0x55, 0x79, 0xB8, 0x60, 0x19, 0x9D, 0x0A, 0x51, 0x45, 0x7C }, }, { { 0x69, 0x01, 0x4B, 0xBC, 0x84, 0x29, 0xD8, 0x5F, 0x41, 0xC2, 0x22, 0xD9, 0x7F, 0x7E, 0xD5, 0x35, 0xCF, 0x81, 0x23, 0x9A, 0xF2, 0x7A, 0xCC, 0x88, 0x70, 0xDC, 0xD4, 0x08, 0x34, 0x8B, 0x48, 0xBA }, }, { { 0x69, 0x21, 0x1F, 0x36, 0x3A, 0x2D, 0xBE, 0x01, 0x5B, 0x31, 0xCB, 0xD9, 0xFC, 0x5E, 0x94, 0xC2, 0xF6, 0xF4, 0x3C, 0x58, 0xDB, 0xDE, 0xE9, 0xE3, 0xE4, 0x6B, 0x19, 0xD7, 0x59, 0xBB, 0xB8, 0x81 }, }, { { 0x69, 0x75, 0x67, 0xBB, 0xAC, 0x94, 0xEE, 0xC3, 0xE6, 0xFA, 0x4A, 0x4E, 0x46, 0xFA, 0x51, 0x74, 0x05, 0xF3, 0x77, 0xC0, 0xDE, 0xE3, 0xD4, 0x29, 0x91, 0x4E, 0x6B, 0x7E, 0xA0, 0x8C, 0xB1, 0xA6 }, }, { { 0x6A, 0xAC, 0xC5, 0x09, 0x2F, 0x12, 0xBC, 0x94, 0xA0, 0xAD, 0x0E, 0x9E, 0xF6, 0x36, 0x43, 0x7D, 0x36, 0x0D, 0xC7, 0xC9, 0xF1, 0x40, 0x44, 0x17, 0xA3, 0x36, 0x91, 0x94, 0x4E, 0x76, 0x31, 0x36 }, }, { { 0x6B, 0x4A, 0x8C, 0xB6, 0x07, 0xF5, 0x1C, 0x83, 0x0D, 0xE7, 0x20, 0xF4, 0xBB, 0xDE, 0xDF, 0x49, 0x10, 0x15, 0x13, 0xDF, 0xD1, 0xDB, 0x0B, 0x0A, 0x97, 0xCC, 0x3F, 0xDD, 0x9A, 0x39, 0xC6, 0xE7 }, }, { { 0x6C, 0x8F, 0xD1, 0xE6, 0xE1, 0x1B, 0xAF, 0xA6, 0x17, 0x78, 0x13, 0xA0, 0x44, 0x40, 0xB1, 0xB9, 0x6A, 0x1C, 0xDB, 0x7C, 0x2D, 0x70, 0x3F, 0x55, 0xDE, 0x85, 0x7C, 0x80, 0xA8, 0x9E, 0x73, 0x25 }, }, { { 0x6C, 0xC6, 0xDC, 0xDA, 0x58, 0xC6, 0x1F, 0xB2, 0x86, 0x70, 0xD1, 0xC2, 0x01, 0x76, 0x57, 0xB0, 0xC5, 0xD6, 0x1A, 0x26, 0xC9, 0xCB, 0xD1, 0xEA, 0x75, 0x5C, 0x68, 0x20, 0xB5, 0xF6, 0xD6, 0x7D }, }, { { 0x6D, 0x32, 0xF4, 0x93, 0x40, 0x56, 0xEE, 0x17, 0x14, 0xCA, 0x72, 0x70, 0x3F, 0x64, 0x46, 0x9B, 0x98, 0x58, 0xFC, 0x39, 0x96, 0x4B, 0x4C, 0x03, 0x93, 0xB3, 0x7D, 0xDE, 0xAB, 0x8B, 0x19, 0x75 }, }, { { 0x6D, 0xC9, 0x87, 0x5C, 0xD3, 0x46, 0xA2, 0x2B, 0x47, 0xB2, 0x80, 0xB1, 0xB1, 0x45, 0x0D, 0x87, 0x8E, 0x09, 0x8B, 0xB2, 0xE2, 0xA9, 0xE3, 0xC2, 0x5C, 0xC7, 0x6A, 0xFF, 0x93, 0xC0, 0xBE, 0xAB }, }, { { 0x6E, 0x1A, 0x88, 0x63, 0xF2, 0x93, 0x4B, 0x39, 0x01, 0x23, 0x7E, 0x84, 0xD0, 0x76, 0x27, 0x04, 0x23, 0x06, 0x78, 0x7F, 0x2D, 0xE0, 0x66, 0x30, 0xBD, 0x37, 0xD8, 0x03, 0x94, 0x35, 0xBF, 0xCA }, }, { { 0x6F, 0x3B, 0xB3, 0x4B, 0x5D, 0x32, 0x91, 0xDF, 0xB3, 0xE4, 0x12, 0x71, 0xA1, 0xD7, 0x30, 0xCD, 0xBC, 0xFF, 0xC1, 0x0B, 0x68, 0x05, 0x9D, 0xCC, 0xD3, 0x1C, 0x47, 0x4B, 0xB7, 0x44, 0x16, 0xE5 }, }, { { 0x6F, 0xBD, 0xCD, 0xF1, 0xB4, 0x37, 0x9F, 0xC4, 0x73, 0xAB, 0x5E, 0xEA, 0x4E, 0xC2, 0xF4, 0x84, 0xCE, 0x91, 0xD1, 0x0E, 0x31, 0x34, 0x5F, 0x15, 0xA7, 0x6A, 0x84, 0x85, 0xB8, 0xFF, 0xFB, 0x7E }, }, { { 0x6F, 0xDC, 0x18, 0xD6, 0x55, 0x14, 0xDD, 0xCE, 0xF0, 0x2F, 0xEA, 0x81, 0x7A, 0x1B, 0x70, 0x84, 0x71, 0x95, 0xFF, 0x5C, 0x07, 0xB1, 0x3D, 0x6A, 0x97, 0x1E, 0x0E, 0x77, 0x4B, 0x44, 0x10, 0xA0 }, }, { { 0x70, 0xB8, 0xEC, 0xD5, 0x62, 0xEC, 0x3D, 0x9F, 0x48, 0x64, 0x75, 0x2A, 0x3A, 0x8C, 0x54, 0x39, 0x93, 0xB4, 0x38, 0x72, 0x8F, 0xE2, 0x71, 0x81, 0xF4, 0xC0, 0x8D, 0xE6, 0xA0, 0xD8, 0xB7, 0x9A }, }, { { 0x71, 0x1E, 0xF0, 0x96, 0x33, 0x43, 0x8A, 0xC5, 0xBE, 0x9D, 0xA8, 0x12, 0x2E, 0x7A, 0xCF, 0x0E, 0xA2, 0x68, 0xB8, 0x72, 0xAD, 0xDC, 0x3E, 0xE8, 0x37, 0x2B, 0x91, 0x6D, 0x60, 0x65, 0xCF, 0xA8 }, }, { { 0x72, 0x1B, 0x1F, 0x92, 0x9D, 0xA7, 0xEA, 0xF8, 0x96, 0x24, 0x64, 0x7B, 0xA3, 0xCC, 0x4E, 0x1E, 0xD1, 0x57, 0x54, 0xAB, 0x83, 0x6E, 0x33, 0x58, 0xB0, 0x35, 0xA1, 0xF2, 0x27, 0x4A, 0x43, 0xBE }, }, { { 0x72, 0xE7, 0x49, 0x87, 0x21, 0x0C, 0x7E, 0xF6, 0x67, 0x46, 0xE4, 0x9A, 0x96, 0xDF, 0x55, 0xCC, 0x6F, 0xAD, 0xF7, 0xA6, 0x31, 0xC7, 0xAE, 0x3F, 0x3E, 0x9E, 0x18, 0x72, 0x3D, 0xE5, 0x2A, 0x6E }, }, { { 0x73, 0x3B, 0x42, 0x24, 0x25, 0x8D, 0xEE, 0x07, 0x0E, 0xDF, 0xA3, 0x41, 0x1F, 0xBC, 0x9B, 0xAD, 0x31, 0x65, 0xBE, 0x66, 0x0F, 0x34, 0x0A, 0xA2, 0x30, 0x8A, 0x5A, 0x33, 0x23, 0xFA, 0xBF, 0xA7 }, }, { { 0x76, 0x98, 0x67, 0x60, 0xAC, 0xFE, 0x55, 0x59, 0xA2, 0xA2, 0xAB, 0x2A, 0x4E, 0x85, 0x49, 0x83, 0xC5, 0xFD, 0xE6, 0x73, 0xCE, 0x8E, 0xB1, 0x71, 0x23, 0x49, 0x48, 0x64, 0x86, 0x7A, 0x98, 0xB1 }, }, { { 0x77, 0xDD, 0xC8, 0x1B, 0xD2, 0x8B, 0x9D, 0x46, 0x1E, 0x7D, 0x3C, 0xD4, 0xA8, 0x12, 0x2A, 0xA9, 0x8A, 0x24, 0x60, 0xFB, 0xA0, 0x8F, 0x1B, 0x7B, 0xAC, 0xB6, 0x6C, 0x92, 0xD7, 0x99, 0x1C, 0xCC }, }, { { 0x78, 0x0C, 0x33, 0xFE, 0x95, 0x4C, 0xC4, 0xDB, 0x39, 0x04, 0xD7, 0x6A, 0x68, 0x58, 0xBC, 0xD1, 0x01, 0x7F, 0x52, 0xDA, 0x59, 0x9D, 0x36, 0xDA, 0xE6, 0x66, 0xC0, 0x4E, 0x41, 0xAF, 0x8D, 0xCD }, }, { { 0x78, 0xC9, 0x30, 0x40, 0x5A, 0x72, 0x0D, 0x9F, 0x00, 0x66, 0xDD, 0x88, 0xA2, 0xA8, 0xDA, 0xFB, 0xBE, 0x6C, 0xD6, 0x5D, 0x54, 0xB7, 0x76, 0x06, 0x42, 0x1B, 0x45, 0x43, 0x8C, 0x65, 0x8A, 0xD4 }, }, { { 0x79, 0x8F, 0x83, 0xB1, 0xC4, 0xC6, 0x5C, 0x4D, 0x5D, 0xEA, 0x13, 0x03, 0x53, 0x53, 0xD8, 0xED, 0xE5, 0xD7, 0x1D, 0x99, 0x47, 0xF4, 0x34, 0xFD, 0xEA, 0x0D, 0xBC, 0x1E, 0xC8, 0x2F, 0x45, 0x35 }, }, { { 0x79, 0xA8, 0xFC, 0x72, 0x70, 0xB2, 0xE5, 0xF3, 0x35, 0x6B, 0x09, 0xC6, 0xB8, 0x64, 0xFC, 0x92, 0xE5, 0xFB, 0xC9, 0xE6, 0x9B, 0xEC, 0x93, 0xA4, 0xE3, 0x3B, 0x8D, 0xF5, 0x75, 0x60, 0x17, 0xBE }, }, { { 0x7B, 0xFE, 0x47, 0xAE, 0xBA, 0x8B, 0x0A, 0x3A, 0x94, 0x5A, 0x88, 0xD8, 0xEF, 0x18, 0x91, 0xC9, 0x89, 0x97, 0x8A, 0xBF, 0x12, 0x2E, 0xC5, 0xE0, 0x51, 0x4B, 0xE3, 0x6C, 0x3A, 0x7F, 0x22, 0x9B }, }, { { 0x7D, 0x20, 0xC7, 0xA9, 0x27, 0x26, 0x2B, 0xE7, 0x38, 0xD2, 0x58, 0xD0, 0xFD, 0x97, 0x6E, 0x9A, 0xF3, 0x6E, 0xF7, 0x99, 0x5F, 0x05, 0xE2, 0x87, 0x6A, 0x29, 0xAE, 0xBC, 0x3A, 0x24, 0xAA, 0xCE }, }, { { 0x7E, 0x2E, 0xDB, 0x9D, 0x38, 0xF9, 0x29, 0x3C, 0xDD, 0xD6, 0x03, 0xB1, 0x75, 0xC9, 0xB2, 0x05, 0xAC, 0x0B, 0x55, 0x3A, 0x4B, 0xF5, 0xFB, 0x08, 0xC2, 0x46, 0xEC, 0xF9, 0xC8, 0x49, 0xDB, 0x28 }, }, { { 0x7F, 0x95, 0x9B, 0x06, 0x34, 0xDA, 0x94, 0xFA, 0xCA, 0xDA, 0xB0, 0x21, 0xCF, 0x94, 0x20, 0x78, 0x16, 0x00, 0x36, 0x13, 0xEF, 0x09, 0xEB, 0x54, 0xF6, 0x48, 0x60, 0x50, 0x08, 0x19, 0x02, 0x75 }, }, { { 0x7F, 0x9A, 0x69, 0xCF, 0xA2, 0xF5, 0x0C, 0x13, 0xE1, 0xB7, 0x11, 0xDD, 0x6B, 0x14, 0x69, 0x2B, 0xDB, 0x77, 0xD9, 0xFF, 0xD8, 0xC1, 0x10, 0xAE, 0x5D, 0x05, 0xA4, 0xCB, 0x73, 0x12, 0x37, 0x48 }, }, { { 0x80, 0x20, 0x56, 0xE1, 0xDB, 0x9D, 0x9B, 0x73, 0x21, 0xD1, 0xFF, 0xBB, 0xE1, 0x2F, 0x5C, 0xBE, 0xDE, 0xC3, 0x6D, 0x0B, 0x5E, 0xC2, 0xA4, 0xE1, 0x8D, 0x99, 0x54, 0x36, 0x4C, 0xEC, 0x81, 0x29 }, }, { { 0x80, 0x97, 0x63, 0x4C, 0xE3, 0x3D, 0x41, 0x53, 0x3D, 0x41, 0x5D, 0xAF, 0xDB, 0x8B, 0xA1, 0x91, 0xC0, 0x30, 0x52, 0xAC, 0x8B, 0xAA, 0x25, 0x54, 0x34, 0x77, 0x3A, 0x16, 0x4B, 0x91, 0x1D, 0x6E }, }, { { 0x80, 0xD0, 0x17, 0x09, 0x34, 0xD2, 0x2A, 0xEA, 0x73, 0x3F, 0x11, 0x5E, 0x52, 0x42, 0xC6, 0xB8, 0x6D, 0x7F, 0xCF, 0xB4, 0x90, 0x4E, 0x65, 0xB7, 0xB7, 0xB9, 0x07, 0xF2, 0xCA, 0x94, 0xED, 0x71 }, }, { { 0x81, 0x1D, 0xF2, 0xF4, 0x73, 0x6F, 0x85, 0x62, 0xE2, 0x02, 0xFD, 0x00, 0x75, 0x32, 0xF1, 0xDE, 0x40, 0x17, 0x86, 0x1E, 0xFA, 0xBE, 0x67, 0x34, 0x20, 0xC2, 0x7F, 0x2E, 0x2A, 0x33, 0xFA, 0xC1 }, }, { { 0x81, 0x1E, 0x37, 0x86, 0x37, 0xB1, 0xD2, 0xCB, 0xB1, 0x89, 0xAF, 0xD6, 0x74, 0x95, 0xFE, 0x8A, 0xB9, 0xD8, 0x3A, 0x74, 0x2E, 0x35, 0x8C, 0xBB, 0xDB, 0xD1, 0x54, 0x98, 0xBF, 0x9C, 0x7B, 0x56 }, }, { { 0x81, 0xA0, 0xF1, 0xD0, 0x29, 0x46, 0x8E, 0xE8, 0x66, 0x36, 0x4A, 0x19, 0x8A, 0x26, 0x08, 0x58, 0x30, 0xC2, 0xA4, 0x16, 0xE4, 0x9E, 0x22, 0x4C, 0xE8, 0x09, 0x66, 0xFC, 0xC4, 0x99, 0xD6, 0x36 }, }, { { 0x82, 0x56, 0x8B, 0x3B, 0xB3, 0xC6, 0x55, 0xD7, 0xF2, 0x2D, 0x8C, 0x97, 0xA5, 0x66, 0x9C, 0xC8, 0x34, 0xA2, 0xDD, 0x7C, 0xDA, 0xE7, 0x5A, 0x26, 0x45, 0x59, 0x55, 0x16, 0x46, 0x55, 0x8E, 0x14 }, }, { { 0x82, 0x7C, 0x8C, 0x80, 0x11, 0x1F, 0xF2, 0x21, 0xC3, 0xEB, 0x1E, 0xF5, 0xC0, 0xD5, 0xD4, 0x34, 0x48, 0x31, 0x86, 0xE2, 0x09, 0x00, 0x75, 0x63, 0x15, 0x8E, 0x9E, 0x76, 0xD2, 0x79, 0x0F, 0x1C }, }, { { 0x82, 0x92, 0x67, 0xC5, 0xAD, 0x70, 0xE5, 0x45, 0x18, 0x02, 0x3A, 0xB7, 0x85, 0xFA, 0x3C, 0xDE, 0xD6, 0x6F, 0x42, 0x5D, 0xE1, 0xF3, 0x2F, 0xCD, 0x72, 0x1B, 0x49, 0x46, 0x3A, 0x5A, 0x5F, 0x5B }, }, { { 0x83, 0x34, 0xEA, 0xB8, 0x1C, 0x60, 0x4E, 0x99, 0xD5, 0x40, 0x51, 0x3E, 0xF2, 0xE3, 0x7A, 0xBA, 0x71, 0x4F, 0x07, 0xB2, 0xBA, 0x01, 0x0A, 0xD7, 0x1D, 0xC4, 0xE1, 0x1A, 0x92, 0x18, 0xC1, 0x8C }, }, { { 0x83, 0x54, 0x7A, 0xCA, 0x3C, 0xED, 0x73, 0xDF, 0x99, 0x14, 0xF3, 0x15, 0x60, 0x74, 0x63, 0x79, 0x29, 0x4C, 0x76, 0x0E, 0xF9, 0xA8, 0xB7, 0x6E, 0x00, 0x06, 0x46, 0xC7, 0x39, 0x07, 0x21, 0x65 }, }, { { 0x83, 0x89, 0xC8, 0x79, 0xB6, 0x3B, 0x82, 0x9D, 0x2D, 0x39, 0xA8, 0xCF, 0xB7, 0x87, 0xE7, 0x72, 0x77, 0xD5, 0xCF, 0xA3, 0xE3, 0x6F, 0xDA, 0xCB, 0xAB, 0x4D, 0x18, 0xB2, 0xB0, 0x4E, 0x32, 0x94 }, }, { { 0x84, 0x23, 0xB3, 0xF1, 0xCC, 0x85, 0x2B, 0x49, 0xCF, 0x81, 0xB7, 0xD5, 0xFF, 0x51, 0xA7, 0xA5, 0x6A, 0x84, 0x78, 0x3A, 0x2D, 0xF7, 0x43, 0x61, 0xFF, 0x2E, 0xEE, 0x0F, 0x92, 0x12, 0xC1, 0x59 }, }, { { 0x84, 0x7B, 0x5F, 0x1E, 0xEB, 0x2A, 0x44, 0x13, 0xC8, 0xFA, 0x37, 0x98, 0x21, 0x97, 0x37, 0xE1, 0x92, 0xBA, 0x72, 0x72, 0xA1, 0x08, 0xB7, 0x17, 0x28, 0xA8, 0xD1, 0x65, 0x17, 0xF6, 0x1E, 0x9D }, }, { { 0x85, 0x31, 0xB2, 0xBF, 0xC5, 0x45, 0x79, 0xE8, 0xF1, 0x8F, 0x27, 0xB2, 0xE6, 0xEC, 0xC0, 0xF8, 0x90, 0x64, 0xEE, 0x86, 0x87, 0x0E, 0xCC, 0x8B, 0xBE, 0x0C, 0xE6, 0x86, 0xEC, 0xDA, 0x2C, 0x17 }, }, { { 0x85, 0x76, 0x0F, 0x59, 0x51, 0x90, 0xE9, 0xB4, 0x67, 0x8B, 0xBF, 0x44, 0xEF, 0xB5, 0xCF, 0x8F, 0x6B, 0x19, 0x37, 0xA9, 0xB8, 0x6B, 0x31, 0xB7, 0x51, 0xBE, 0xCF, 0x72, 0x18, 0x03, 0xB0, 0x1C }, }, { { 0x85, 0xF0, 0x79, 0x36, 0xB4, 0x29, 0x1F, 0x36, 0xD9, 0xB7, 0x5F, 0x42, 0xE8, 0xB7, 0xEE, 0x8A, 0x64, 0xE6, 0x32, 0xA1, 0x18, 0x11, 0x65, 0xFE, 0x72, 0xB4, 0x88, 0x23, 0xC3, 0xD9, 0x9D, 0x9D }, }, { { 0x86, 0x12, 0x9F, 0xE7, 0x61, 0x99, 0x4D, 0x7B, 0x64, 0xE4, 0x02, 0x85, 0x8F, 0x88, 0xC5, 0x2B, 0x3E, 0xB9, 0xC0, 0x71, 0xFF, 0xBE, 0x80, 0x02, 0x80, 0xAC, 0x8C, 0x0C, 0x6F, 0x79, 0xE7, 0xA6 }, }, { { 0x86, 0x19, 0x6B, 0x0F, 0xD3, 0x0F, 0x8F, 0x57, 0x56, 0x98, 0xB5, 0xEE, 0xF2, 0x69, 0xD0, 0x69, 0x2F, 0x88, 0xAD, 0xEA, 0xC4, 0x83, 0x6A, 0x62, 0x67, 0xAB, 0xC8, 0x36, 0x23, 0x34, 0x00, 0x86 }, }, { { 0x86, 0xD1, 0x8B, 0xCD, 0xDE, 0x16, 0x45, 0x42, 0x48, 0x6E, 0x56, 0x44, 0x2C, 0xE1, 0xB8, 0x8B, 0x1A, 0x10, 0x73, 0x7C, 0xBD, 0x5E, 0xA4, 0xAA, 0xB8, 0xD5, 0xB8, 0xAF, 0x51, 0xF5, 0x29, 0x09 }, }, { { 0x88, 0x8D, 0x6D, 0x77, 0xD8, 0x1C, 0x62, 0x91, 0xCB, 0x84, 0xD9, 0xD6, 0x56, 0x27, 0x82, 0xFD, 0x2E, 0xB3, 0x42, 0x5D, 0x49, 0x1E, 0x68, 0x74, 0x20, 0x28, 0x4B, 0x76, 0xA1, 0xDE, 0xBF, 0xAB }, }, { { 0x89, 0xAF, 0x0E, 0x54, 0xC7, 0x62, 0x77, 0x86, 0x93, 0x52, 0x9D, 0x0A, 0x95, 0x0B, 0x78, 0x33, 0xF5, 0xEA, 0xBA, 0xF3, 0x42, 0x79, 0x72, 0x60, 0x7F, 0xB2, 0xC7, 0x0C, 0x96, 0xA3, 0x21, 0x61 }, }, { { 0x89, 0xDA, 0xC7, 0x89, 0x6B, 0x46, 0xF2, 0xFC, 0x8B, 0xEA, 0x62, 0x11, 0xFF, 0x98, 0xB6, 0x1F, 0xAA, 0x15, 0x7B, 0xA8, 0xC4, 0xAD, 0x6F, 0xD1, 0x75, 0x92, 0x75, 0xCE, 0x39, 0x41, 0xC3, 0x28 }, }, { { 0x8A, 0x09, 0x85, 0xBF, 0x86, 0xE8, 0xC9, 0xB9, 0x17, 0xEC, 0x84, 0xDA, 0x2A, 0x56, 0x73, 0x1E, 0x75, 0x2A, 0xA0, 0xDC, 0x52, 0x87, 0xC2, 0xBF, 0x39, 0x51, 0x0B, 0xB3, 0xF0, 0xF2, 0x0A, 0xD1 }, }, { { 0x8A, 0xAF, 0x36, 0x3C, 0xC9, 0xD8, 0x44, 0x15, 0xA7, 0xEB, 0x0D, 0x72, 0xDA, 0x08, 0xB3, 0x58, 0x80, 0x68, 0x55, 0x9C, 0xB0, 0xA9, 0xAE, 0x92, 0xB8, 0xF4, 0x60, 0x2E, 0xDA, 0x23, 0x82, 0xAA }, }, { { 0x8A, 0xB2, 0x77, 0x62, 0xF4, 0xA2, 0xE3, 0x11, 0x22, 0x04, 0x96, 0x98, 0x39, 0x99, 0xC8, 0xC4, 0x60, 0x96, 0x3D, 0xFC, 0x1B, 0x88, 0x51, 0x11, 0x1D, 0xA4, 0x1D, 0x3F, 0x3B, 0x0A, 0x6E, 0x94 }, }, { { 0x8A, 0xD1, 0xD5, 0x48, 0x95, 0x27, 0xB5, 0x28, 0xE5, 0xB5, 0xD6, 0xA5, 0x95, 0x78, 0x87, 0x08, 0x88, 0x8A, 0x3F, 0xB1, 0x9F, 0x2C, 0x7C, 0x8B, 0x38, 0x07, 0x0E, 0x1F, 0x38, 0x98, 0x96, 0x8B }, }, { { 0x8A, 0xDB, 0x49, 0xD4, 0x15, 0x53, 0x56, 0x70, 0x5B, 0x64, 0x42, 0x6A, 0x99, 0x0F, 0x58, 0xB3, 0xA0, 0x71, 0xEF, 0x78, 0x2E, 0x6C, 0x09, 0x53, 0x07, 0xD7, 0x74, 0x74, 0xD5, 0xB5, 0x7A, 0x62 }, }, { { 0x8B, 0x3A, 0x10, 0x35, 0xC3, 0xFD, 0xF3, 0x45, 0xFB, 0x70, 0x80, 0x44, 0x83, 0xA5, 0x04, 0x49, 0xA3, 0xD7, 0x60, 0xC6, 0xBA, 0x48, 0xF5, 0xB8, 0x2D, 0x6B, 0xB2, 0x62, 0xED, 0x9D, 0xE3, 0x73 }, }, { { 0x8B, 0x3A, 0x75, 0xCB, 0xC3, 0x62, 0xD2, 0x35, 0x57, 0x0E, 0x5D, 0xE7, 0x04, 0x29, 0x38, 0x70, 0x8A, 0x1B, 0x0F, 0xCE, 0xB4, 0x59, 0x86, 0x2A, 0x38, 0x67, 0xB7, 0x34, 0xCD, 0xCB, 0x97, 0x94 }, }, { { 0x8C, 0x3E, 0x7C, 0x1D, 0xCC, 0x7D, 0xD8, 0xE7, 0xD8, 0xBF, 0x7B, 0x5B, 0x3A, 0xE5, 0xE0, 0x27, 0x2E, 0x81, 0x1A, 0xB9, 0xF3, 0xC3, 0xC5, 0x38, 0xE5, 0x74, 0x71, 0x77, 0xE6, 0x2D, 0x62, 0x92 }, }, { { 0x8C, 0x7C, 0x65, 0x7B, 0xDA, 0x13, 0xCA, 0x62, 0xF2, 0x9A, 0x65, 0xC6, 0xD5, 0x19, 0x3A, 0x93, 0xCF, 0x6C, 0x58, 0x77, 0x18, 0xAD, 0xCA, 0x67, 0x15, 0x8E, 0x97, 0xD3, 0x6A, 0x62, 0x3E, 0xCA }, }, { { 0x8C, 0xA6, 0x79, 0x62, 0xC4, 0xA8, 0x09, 0x13, 0x33, 0xF2, 0x4E, 0xFD, 0x60, 0xEE, 0x70, 0xCF, 0xED, 0xDB, 0xD6, 0x41, 0x59, 0x04, 0x70, 0x9E, 0x78, 0x5C, 0x33, 0x1B, 0x1E, 0xF5, 0x8F, 0x8E }, }, { { 0x8E, 0x18, 0xFD, 0xBD, 0xB0, 0x08, 0x16, 0x00, 0x35, 0xFA, 0xF5, 0x01, 0x5B, 0xE7, 0xDA, 0xF4, 0x63, 0xB5, 0xC4, 0x14, 0xEA, 0xBC, 0x8B, 0x89, 0xF3, 0xDB, 0xA2, 0x05, 0xAB, 0x09, 0xA6, 0x43 }, }, { { 0x8F, 0x10, 0x10, 0x47, 0x93, 0xE8, 0x55, 0x42, 0xBC, 0x06, 0x04, 0xD6, 0xCF, 0x21, 0x5F, 0x78, 0x80, 0xBD, 0x6A, 0x4D, 0xD0, 0xFD, 0xF1, 0xE7, 0xA5, 0xB9, 0xCA, 0x12, 0x46, 0xF5, 0xC4, 0x09 }, }, { { 0x8F, 0x71, 0x27, 0x76, 0x2E, 0xE7, 0x51, 0x69, 0xBD, 0xC3, 0x5B, 0x04, 0xA7, 0x28, 0xE9, 0xD3, 0x1B, 0x7E, 0x4D, 0x37, 0x89, 0xAA, 0x2C, 0x46, 0xD8, 0xA3, 0x1B, 0x3D, 0xFA, 0x81, 0xA9, 0x7E }, }, { { 0x8F, 0x94, 0x15, 0x92, 0x6F, 0x40, 0x49, 0xEA, 0x41, 0x8A, 0x30, 0x7C, 0x76, 0x36, 0xE4, 0x9B, 0x14, 0x4F, 0xA5, 0x3E, 0x52, 0xE1, 0x04, 0x15, 0x5F, 0x58, 0x03, 0x5E, 0x45, 0x41, 0xCD, 0x6E }, }, { { 0x90, 0xB3, 0xA1, 0x85, 0x36, 0x86, 0xAF, 0xEB, 0x15, 0x4A, 0xEF, 0x7E, 0x84, 0x0D, 0x38, 0x04, 0x4E, 0x7D, 0x7F, 0x6D, 0xC4, 0xCE, 0x82, 0x8C, 0xE3, 0x97, 0x55, 0xAC, 0x88, 0xE4, 0x2E, 0x07 }, }, { { 0x90, 0xE2, 0x51, 0x86, 0x7F, 0x6B, 0x0C, 0x14, 0xBD, 0x9B, 0x51, 0x0C, 0xFD, 0xA8, 0x48, 0x49, 0x72, 0xFD, 0xF0, 0xE0, 0x6D, 0xC1, 0x1F, 0x5D, 0x1D, 0x59, 0x0B, 0xE3, 0xFC, 0x38, 0xDF, 0xF0 }, }, { { 0x91, 0x90, 0xF8, 0x25, 0x51, 0x0C, 0x65, 0x98, 0xE1, 0x9D, 0x17, 0xDB, 0xBE, 0x6E, 0x7C, 0x82, 0x31, 0x86, 0x9C, 0xA7, 0xF6, 0xE3, 0x07, 0xA2, 0xC2, 0xCC, 0x54, 0x77, 0x8D, 0x4A, 0x89, 0xB3 }, }, { { 0x91, 0xC7, 0x6E, 0xF8, 0xC7, 0x05, 0x3B, 0x2A, 0x27, 0x0B, 0x97, 0x19, 0x78, 0x3C, 0x85, 0x10, 0xA2, 0x89, 0x0A, 0x48, 0x40, 0x18, 0x63, 0x72, 0x6E, 0x23, 0x3A, 0x82, 0xBF, 0x9A, 0x0B, 0xCF }, }, { { 0x92, 0x3F, 0x0F, 0x8C, 0x40, 0x5A, 0x02, 0xE6, 0x82, 0xC4, 0xB4, 0x66, 0x5A, 0x7E, 0xE7, 0x16, 0xAA, 0x57, 0xE0, 0xA5, 0x86, 0xC2, 0x4A, 0x16, 0x5A, 0xAD, 0x7E, 0x5B, 0xDA, 0x22, 0x78, 0x24 }, }, { { 0x92, 0x71, 0x44, 0x12, 0x1C, 0x23, 0x63, 0x57, 0x07, 0xE9, 0x40, 0x7F, 0x7F, 0xFF, 0x6A, 0x64, 0x63, 0x5D, 0x7C, 0xE9, 0x06, 0x66, 0xD4, 0x29, 0x94, 0x09, 0x7A, 0xF4, 0x0C, 0x31, 0x36, 0xFB }, }, { { 0x94, 0xDC, 0x80, 0x07, 0x49, 0x1D, 0xA8, 0xBF, 0xB7, 0x39, 0x14, 0xAD, 0xCE, 0xF7, 0x1A, 0x12, 0x41, 0x58, 0xBA, 0xD1, 0x7B, 0xA8, 0x8F, 0xA9, 0x46, 0x57, 0x9B, 0xBC, 0x2D, 0x64, 0x97, 0x8D }, }, { { 0x95, 0x68, 0x33, 0xAE, 0xE6, 0x61, 0x19, 0x26, 0xE9, 0x52, 0x72, 0xA1, 0xF5, 0x88, 0xF9, 0x2A, 0xF5, 0x2C, 0xAE, 0x70, 0x7A, 0xCD, 0xCC, 0x82, 0x63, 0x99, 0x7B, 0xFA, 0x8C, 0x71, 0x9C, 0xA8 }, }, { { 0x95, 0x89, 0xDA, 0xC9, 0xEC, 0xE7, 0x6D, 0xF5, 0x72, 0x01, 0x96, 0xDC, 0x58, 0x6D, 0x17, 0x9D, 0x73, 0x5D, 0xF7, 0x17, 0x92, 0x6C, 0x06, 0x1E, 0xA7, 0x0C, 0x40, 0x85, 0x64, 0x8F, 0xF3, 0x12 }, }, { { 0x96, 0xA4, 0x59, 0x90, 0xFC, 0xD0, 0x1C, 0x9C, 0x2A, 0xF0, 0x64, 0x5F, 0x87, 0xB9, 0x69, 0x8B, 0x05, 0xAF, 0xE6, 0x94, 0x32, 0xEB, 0x57, 0x01, 0x08, 0x20, 0x13, 0xBA, 0xC5, 0xB0, 0x55, 0x60 }, }, { { 0x96, 0xEB, 0x44, 0xAA, 0x6A, 0x20, 0x49, 0xE6, 0xBA, 0xFF, 0xE6, 0xB5, 0x21, 0xC4, 0xAD, 0x8C, 0x58, 0x77, 0x26, 0xCA, 0xA0, 0x12, 0xE8, 0xFB, 0x8E, 0x8E, 0x21, 0x89, 0x77, 0xBF, 0x1D, 0xF6 }, }, { { 0x97, 0x4F, 0x51, 0xA6, 0x04, 0x68, 0x48, 0xFA, 0xA7, 0xB3, 0x3F, 0xD2, 0x39, 0x13, 0x86, 0x42, 0x8B, 0xD5, 0x24, 0xEA, 0xEB, 0xA8, 0x01, 0x4E, 0x6D, 0x1F, 0xE2, 0x54, 0x38, 0x3F, 0x41, 0x79 }, }, { { 0x97, 0x8D, 0x6F, 0x1E, 0x9A, 0xA3, 0xA3, 0xCE, 0xB1, 0xAD, 0xA6, 0x09, 0xE2, 0x00, 0x95, 0xFB, 0xC3, 0x3A, 0x6B, 0xBC, 0x6A, 0x21, 0xD8, 0x0A, 0x4E, 0xCB, 0x27, 0x3C, 0x60, 0xAC, 0x2A, 0xC7 }, }, { { 0x98, 0xB5, 0x92, 0x4E, 0x06, 0xCD, 0xEA, 0x1B, 0xA1, 0x7F, 0xDB, 0x1B, 0x13, 0x97, 0x90, 0x24, 0xB1, 0xC2, 0x5B, 0x0A, 0x69, 0x0C, 0xFE, 0x87, 0x8D, 0x4C, 0xB4, 0x07, 0x76, 0xB9, 0x6F, 0xB0 }, }, { { 0x99, 0xA5, 0x5F, 0x76, 0xCB, 0xEA, 0x0F, 0x3E, 0x60, 0x71, 0xD3, 0x82, 0x18, 0x1A, 0xF6, 0xCB, 0x25, 0xBD, 0xC5, 0x87, 0x5E, 0x29, 0xF0, 0xF4, 0xD7, 0x19, 0xA9, 0xD3, 0x5B, 0x5B, 0xD6, 0xBF }, }, { { 0x9A, 0x4B, 0x49, 0x93, 0xB4, 0xED, 0x8C, 0x27, 0xE7, 0x7F, 0x3C, 0x8A, 0xAF, 0xDB, 0xDC, 0x11, 0x1A, 0x36, 0xB7, 0x3C, 0xCA, 0xDB, 0x87, 0x04, 0x98, 0x25, 0x00, 0xD1, 0xB0, 0xF1, 0x09, 0xF2 }, }, { { 0x9A, 0x5F, 0xAB, 0xE5, 0x8A, 0x1E, 0xAE, 0x4B, 0x20, 0xBA, 0xB3, 0xA7, 0xEB, 0x5E, 0x42, 0xA2, 0xDA, 0x83, 0x11, 0x59, 0x25, 0x7D, 0xD4, 0xE3, 0x55, 0x2E, 0xC6, 0xF7, 0xD2, 0x67, 0xFA, 0xBA }, }, { { 0x9A, 0xAE, 0x9D, 0x45, 0xAA, 0x04, 0x03, 0x06, 0x4B, 0xC5, 0xA7, 0x4D, 0xD0, 0x32, 0x5D, 0xA4, 0x1E, 0x12, 0xCF, 0x58, 0x6C, 0x46, 0x2E, 0xE0, 0x6C, 0x2B, 0xB4, 0x56, 0xF8, 0x44, 0x1C, 0x4F }, }, { { 0x9B, 0x8F, 0x9F, 0xC4, 0xAF, 0xA7, 0x04, 0x0D, 0x4E, 0x59, 0x4D, 0x66, 0x7C, 0x44, 0x44, 0xB5, 0x25, 0x88, 0x20, 0xC0, 0x8F, 0x89, 0x91, 0x0E, 0xD3, 0x42, 0x1C, 0xB4, 0xA9, 0x7B, 0xB7, 0x9E }, }, { { 0x9C, 0x70, 0x8D, 0x5B, 0xAB, 0x37, 0xF5, 0xB6, 0xBC, 0x8A, 0x77, 0x53, 0x12, 0x57, 0x2A, 0xB2, 0x79, 0x21, 0x6D, 0x55, 0x6D, 0xA7, 0x4A, 0xC2, 0xA7, 0xC0, 0x41, 0xE8, 0xCE, 0xB0, 0xBE, 0x0A }, }, { { 0x9C, 0xCA, 0x23, 0x7C, 0xDF, 0xCA, 0x2C, 0x72, 0xC6, 0x09, 0x25, 0x4A, 0x72, 0x57, 0xFE, 0xD5, 0x3A, 0xF1, 0x44, 0xAB, 0xC2, 0x5E, 0xCD, 0x8E, 0xF7, 0x01, 0x30, 0x8C, 0xB1, 0x3C, 0xF7, 0x69 }, }, { { 0x9D, 0x6B, 0xDF, 0xCF, 0x0C, 0xBF, 0xFE, 0xEA, 0x3B, 0x1A, 0xC7, 0xE9, 0x63, 0xCB, 0xB5, 0xF2, 0x7F, 0xBD, 0xA8, 0x9D, 0x27, 0x77, 0xF6, 0x0E, 0x56, 0x5B, 0x27, 0x78, 0x54, 0xEF, 0xB0, 0x19 }, }, { { 0x9D, 0xAC, 0x33, 0x14, 0xB2, 0x5B, 0xB7, 0x9A, 0x39, 0xCD, 0x01, 0xEC, 0x4B, 0x33, 0xA1, 0x2F, 0x47, 0x51, 0x2F, 0x54, 0x09, 0xFF, 0x09, 0x5D, 0x40, 0xAA, 0xD6, 0x20, 0x84, 0xEF, 0x15, 0xBE }, }, { { 0x9F, 0x24, 0x5C, 0x0A, 0x0E, 0xC6, 0x3A, 0xAA, 0xCB, 0xF9, 0x69, 0xC6, 0xFC, 0x24, 0xA1, 0x07, 0x15, 0x83, 0xB7, 0x79, 0xA5, 0x8A, 0xB6, 0x23, 0xDD, 0x15, 0x31, 0xA2, 0xCA, 0x9F, 0x87, 0x51 }, }, { { 0x9F, 0xAF, 0x1C, 0x11, 0xA3, 0xC7, 0xE2, 0x41, 0xF8, 0x63, 0x71, 0x97, 0xE8, 0x99, 0x68, 0xDB, 0x86, 0x6A, 0xD0, 0x1A, 0x5D, 0x4E, 0xD5, 0x34, 0x59, 0x48, 0x65, 0xB9, 0x70, 0x75, 0xF2, 0x60 }, }, { { 0x9F, 0xFA, 0x4E, 0xF4, 0xFC, 0xF2, 0xCF, 0xD1, 0xB2, 0x7C, 0x6A, 0x62, 0xE3, 0xC4, 0x23, 0x5B, 0xD8, 0x3C, 0xC5, 0xE0, 0x06, 0xE9, 0x2A, 0x55, 0xE4, 0xA9, 0x86, 0xE6, 0x30, 0x53, 0x57, 0xE3 }, }, { { 0xA0, 0xC2, 0xD2, 0x07, 0xA4, 0x7E, 0x18, 0xD0, 0x37, 0x14, 0xD5, 0xB3, 0x44, 0x5D, 0x88, 0xBE, 0x81, 0xFF, 0x5E, 0x1D, 0x16, 0x07, 0x3D, 0xC1, 0x16, 0x6B, 0xB5, 0x44, 0x8F, 0xF6, 0x52, 0xDF }, }, { { 0xA1, 0x97, 0x7D, 0x0C, 0x92, 0x7C, 0x21, 0xEB, 0x47, 0x6F, 0x67, 0xBE, 0xFE, 0xD6, 0xCF, 0x2C, 0x61, 0xB7, 0x45, 0xF0, 0xCE, 0x8D, 0x26, 0x58, 0x3D, 0x03, 0xB2, 0x70, 0x02, 0xD5, 0xCD, 0xAF }, }, { { 0xA2, 0x6C, 0x37, 0x5E, 0xB3, 0x19, 0x6E, 0x28, 0x3B, 0xEC, 0x60, 0x3D, 0xB6, 0xBB, 0xDA, 0xE2, 0x49, 0x55, 0xE4, 0xBA, 0x91, 0x0C, 0xD4, 0x2D, 0x9E, 0xAC, 0x55, 0xCA, 0xC6, 0x10, 0x3A, 0xB9 }, }, { { 0xA3, 0xA4, 0xFC, 0x03, 0xE1, 0x75, 0xF2, 0x68, 0x02, 0x57, 0x46, 0x34, 0xDE, 0x70, 0x7D, 0x2F, 0x92, 0xF4, 0xD0, 0xCB, 0x90, 0xCD, 0xB6, 0x1D, 0xD1, 0x95, 0x8B, 0xCF, 0x0C, 0x55, 0x20, 0x86 }, }, { { 0xA6, 0x62, 0xFC, 0x81, 0xC9, 0x09, 0x34, 0xB9, 0xB4, 0xD6, 0x30, 0xB5, 0xD8, 0x2E, 0x86, 0xF2, 0x36, 0x3E, 0xC1, 0x5C, 0xCF, 0xCD, 0xAF, 0xA7, 0xA2, 0x0C, 0x9B, 0x4E, 0x3A, 0x90, 0x0D, 0xD1 }, }, { { 0xA6, 0xA4, 0xA3, 0xF6, 0x1F, 0xA5, 0x8C, 0xE9, 0x70, 0xB4, 0x58, 0xB7, 0xC3, 0x7C, 0x05, 0x2E, 0xAD, 0x1E, 0xB2, 0x0B, 0x85, 0x67, 0xE3, 0x51, 0xAD, 0x8E, 0x6F, 0xBA, 0x49, 0xC2, 0x69, 0x2C }, }, { { 0xA6, 0xDE, 0x6C, 0x3B, 0x8C, 0x14, 0x05, 0xCB, 0xE1, 0x2D, 0xB4, 0x09, 0x97, 0x61, 0x71, 0xAC, 0xB5, 0x1F, 0xB3, 0xDC, 0xFB, 0xB7, 0x6E, 0xE3, 0x84, 0x95, 0x39, 0xCD, 0x8A, 0xB0, 0x66, 0xDF }, }, { { 0xA8, 0x53, 0xAD, 0xC1, 0xC2, 0x18, 0x59, 0xAF, 0x7C, 0x46, 0x2B, 0x4A, 0xA0, 0xA5, 0x74, 0xCA, 0x9F, 0xEE, 0xFB, 0x18, 0x5A, 0x1F, 0xDB, 0xB6, 0xC1, 0x0E, 0x17, 0xD6, 0x01, 0xB7, 0x09, 0x8F }, }, { { 0xA8, 0xDF, 0xF0, 0x6A, 0x17, 0x35, 0xB4, 0x6D, 0x17, 0xDA, 0xEB, 0xC3, 0x43, 0x43, 0x18, 0x31, 0x3B, 0x2D, 0x9E, 0x7C, 0x3E, 0xF4, 0x8F, 0x28, 0x53, 0x75, 0x35, 0x13, 0xE1, 0xB2, 0x53, 0xA8 }, }, { { 0xA8, 0xE3, 0x8C, 0x6E, 0xC0, 0x93, 0xF5, 0xAF, 0x53, 0x88, 0xF1, 0xE7, 0x66, 0xD7, 0x5F, 0xFB, 0x57, 0xDD, 0xBE, 0x3E, 0x9D, 0xC2, 0xE0, 0xBE, 0x57, 0xBB, 0x88, 0x36, 0x46, 0xC5, 0xC0, 0x32 }, }, { { 0xA9, 0x0B, 0x8D, 0xE1, 0x7F, 0x6B, 0x68, 0x37, 0x56, 0x21, 0x2D, 0xB3, 0xAB, 0x34, 0x89, 0x6E, 0x91, 0x70, 0x93, 0x11, 0x3E, 0x47, 0xCA, 0x35, 0x96, 0x2E, 0xAC, 0xCA, 0x9C, 0xB3, 0x86, 0xF0 }, }, { { 0xA9, 0x71, 0x2F, 0x85, 0xED, 0x2E, 0x25, 0xAD, 0xA5, 0x7D, 0xC1, 0xF0, 0xF8, 0x6D, 0xE1, 0x07, 0xB5, 0xE2, 0xF0, 0x36, 0x09, 0x53, 0xF1, 0xED, 0x12, 0x5E, 0x37, 0x07, 0x59, 0x47, 0x1D, 0x09 }, }, { { 0xAA, 0xEB, 0xFE, 0x2D, 0x21, 0xB7, 0xE5, 0x35, 0x1B, 0xB9, 0x99, 0x69, 0x44, 0x44, 0x19, 0xEF, 0x21, 0xC9, 0x68, 0x8C, 0xE0, 0x53, 0x24, 0x88, 0x84, 0xCA, 0xB0, 0xB8, 0x95, 0x10, 0x30, 0xFF }, }, { { 0xAB, 0x41, 0x28, 0x10, 0x9C, 0xAB, 0x8A, 0x58, 0x7C, 0x8F, 0xF4, 0xC7, 0xF6, 0x87, 0x34, 0x49, 0x98, 0x18, 0xD1, 0x3F, 0x52, 0x26, 0x76, 0xD0, 0x66, 0xB3, 0x52, 0x17, 0x6F, 0xD2, 0x35, 0x96 }, }, { { 0xAB, 0x80, 0xD9, 0xBA, 0x0A, 0xEF, 0xAD, 0x7B, 0xEC, 0xCE, 0x7F, 0x5E, 0x61, 0x59, 0x9A, 0xF5, 0x26, 0x69, 0xBF, 0x59, 0x50, 0x7F, 0x8E, 0xF1, 0x99, 0x13, 0xC4, 0x2E, 0xE1, 0x29, 0xDA, 0xF0 }, }, { { 0xAB, 0xEB, 0x6A, 0xA0, 0xD1, 0xB0, 0xE0, 0x49, 0xD6, 0x9D, 0xF8, 0x3A, 0xDD, 0x19, 0xF7, 0x26, 0x8A, 0x38, 0xDE, 0x6C, 0x00, 0x72, 0x60, 0x68, 0xC2, 0xEE, 0xE4, 0x55, 0x44, 0xF6, 0xD6, 0x7A }, }, { { 0xAC, 0x1B, 0x4C, 0x64, 0x6C, 0xAE, 0xFB, 0x10, 0x8A, 0x54, 0xCA, 0xB5, 0x4A, 0x96, 0xE9, 0x66, 0x6E, 0x72, 0xA8, 0x20, 0x22, 0x44, 0xEF, 0x3D, 0x7C, 0xA9, 0x34, 0xDF, 0xCC, 0x24, 0xFC, 0xA7 }, }, { { 0xAC, 0x7C, 0x14, 0xB9, 0x56, 0x8F, 0x92, 0x07, 0x5A, 0xD4, 0xA3, 0xBA, 0x3D, 0x4B, 0x01, 0x84, 0x91, 0xF3, 0x66, 0x1A, 0x37, 0x9B, 0x3D, 0xFE, 0xDD, 0x6F, 0xD3, 0xC3, 0x2E, 0xFA, 0x84, 0x7D }, }, { { 0xAD, 0x69, 0x54, 0x5F, 0x9F, 0x85, 0x25, 0x5F, 0xE4, 0x16, 0x51, 0x3D, 0x94, 0xDB, 0x31, 0x50, 0x5F, 0x38, 0x4B, 0x52, 0x3C, 0x2C, 0xA2, 0x6E, 0xDC, 0x0A, 0x54, 0x9A, 0x8F, 0x16, 0x26, 0xF9 }, }, { { 0xAE, 0x03, 0x19, 0xFE, 0xA6, 0xA6, 0x5E, 0x84, 0xE8, 0x54, 0xB5, 0x15, 0x50, 0xEA, 0x44, 0x4F, 0xA3, 0xB8, 0xBB, 0x50, 0xAE, 0x93, 0x74, 0x01, 0x3C, 0xFE, 0xF3, 0x88, 0x73, 0x5D, 0x0B, 0xD3 }, }, { { 0xAE, 0x4D, 0xF3, 0x97, 0x9B, 0x74, 0x27, 0x34, 0xA3, 0x39, 0xC4, 0x70, 0x1D, 0x5E, 0x13, 0x21, 0x26, 0x3F, 0xF4, 0x4E, 0x67, 0x56, 0x49, 0x05, 0xF4, 0x9E, 0x25, 0x34, 0x62, 0xB8, 0x02, 0x25 }, }, { { 0xAF, 0x1F, 0x37, 0x1F, 0x34, 0x84, 0x57, 0x51, 0x65, 0x2D, 0xC7, 0x48, 0x23, 0xF3, 0x01, 0x5C, 0x5A, 0x11, 0xCA, 0x65, 0x3F, 0x28, 0x70, 0x1E, 0xDD, 0x4A, 0x7E, 0x0D, 0x23, 0x17, 0x1B, 0xBB }, }, { { 0xAF, 0x6B, 0x80, 0x51, 0x47, 0x14, 0x0A, 0x0E, 0x41, 0x81, 0xD8, 0x6A, 0x7E, 0x8F, 0x07, 0x69, 0xB6, 0x1D, 0x46, 0xD7, 0xB6, 0xFA, 0xC6, 0xE6, 0xF9, 0x59, 0x6D, 0xE9, 0x4A, 0xA8, 0xE2, 0xE8 }, }, { { 0xB0, 0x5C, 0x14, 0x33, 0x61, 0x75, 0x9B, 0xE1, 0x52, 0xFD, 0x76, 0xA5, 0xFF, 0xA4, 0x87, 0x2D, 0xD4, 0x2E, 0xA0, 0x60, 0xAE, 0x40, 0xA3, 0x83, 0x13, 0xB7, 0xB5, 0x4A, 0xEC, 0x06, 0x73, 0xC2 }, }, { { 0xB0, 0xE0, 0xE1, 0x6C, 0x5F, 0x69, 0x1F, 0x66, 0xA9, 0x57, 0x3B, 0xD3, 0xCF, 0x43, 0xF9, 0xDF, 0xD2, 0xAD, 0x3E, 0x56, 0x15, 0x54, 0x63, 0x7F, 0x1E, 0x7B, 0x71, 0x91, 0x4D, 0x62, 0x73, 0x38 }, }, { { 0xB2, 0xDC, 0x86, 0x25, 0x6C, 0xCF, 0xF4, 0xBB, 0x14, 0xFD, 0x70, 0x27, 0x9F, 0xCC, 0x3C, 0xE9, 0x25, 0xC5, 0x1F, 0xB7, 0x17, 0xE5, 0x87, 0x6F, 0x29, 0x1B, 0xA1, 0x70, 0x73, 0x43, 0x85, 0x68 }, }, { { 0xB3, 0x0D, 0x88, 0x44, 0x30, 0x43, 0xF5, 0xF3, 0x72, 0x32, 0xBB, 0x9B, 0xAC, 0xB9, 0x94, 0xC5, 0xBA, 0xE9, 0x3A, 0x46, 0xFC, 0x87, 0xF1, 0x51, 0x29, 0xC9, 0x74, 0x69, 0xA5, 0x81, 0x4E, 0xCA }, }, { { 0xB3, 0x1A, 0xF0, 0xC2, 0xE5, 0x1E, 0xA2, 0x1C, 0x91, 0x04, 0xF9, 0x4F, 0xAA, 0x66, 0xE0, 0xCC, 0xC0, 0x41, 0x34, 0xD5, 0x80, 0x9A, 0x2A, 0x26, 0x70, 0xA3, 0xB7, 0xBC, 0x7D, 0xD9, 0x64, 0xF8 }, }, { { 0xB3, 0xE6, 0x42, 0x06, 0x6E, 0x41, 0x78, 0x67, 0xD9, 0x0F, 0xB9, 0xB2, 0xBA, 0x15, 0x41, 0x98, 0xA5, 0xC5, 0xF6, 0xCC, 0x82, 0x9B, 0x51, 0x39, 0xDF, 0xD6, 0x91, 0xE5, 0x1A, 0xD3, 0x74, 0xAD }, }, { { 0xB3, 0xF4, 0xB1, 0x6F, 0x8E, 0xCE, 0xBB, 0x41, 0x47, 0x4F, 0x92, 0x4F, 0xEE, 0xF9, 0xB0, 0xBD, 0x97, 0x9B, 0x36, 0x36, 0xC3, 0x4F, 0xF2, 0x72, 0x3F, 0x67, 0x3C, 0x8E, 0xEE, 0x2A, 0xF1, 0x52 }, }, { { 0xB4, 0xD4, 0x67, 0xFC, 0x5E, 0x97, 0xDB, 0x25, 0xA1, 0xFD, 0xB0, 0x06, 0xD2, 0x77, 0x66, 0xB9, 0x99, 0x5B, 0xB9, 0xC7, 0x7B, 0x66, 0x43, 0x97, 0x08, 0xA4, 0x59, 0xB0, 0x43, 0xD0, 0x33, 0x24 }, }, { { 0xB4, 0xED, 0xCD, 0x6F, 0x8A, 0x01, 0x82, 0xB7, 0x17, 0xF0, 0x6F, 0xE1, 0xD7, 0xAC, 0x9C, 0x62, 0x33, 0xD4, 0x38, 0x22, 0xE9, 0xFD, 0x14, 0xDB, 0x98, 0xF7, 0xF8, 0x4E, 0x32, 0x79, 0x6D, 0x08 }, }, { { 0xB5, 0xE5, 0xDC, 0xDE, 0xCB, 0x8D, 0xEB, 0x27, 0x13, 0x4F, 0x02, 0xA5, 0x18, 0x79, 0x43, 0x16, 0xF0, 0x8F, 0xAF, 0x9C, 0x2B, 0x1F, 0xDA, 0xD6, 0xD4, 0x86, 0x61, 0xF5, 0x7E, 0xA6, 0x45, 0xD9 }, }, { { 0xB5, 0xEF, 0x42, 0xC4, 0xBC, 0xED, 0xF1, 0x7B, 0xEC, 0xC7, 0x5B, 0xF4, 0x63, 0x66, 0x49, 0xCE, 0xBF, 0xF8, 0x71, 0x1B, 0xCE, 0xFF, 0xFA, 0x69, 0x5C, 0xC2, 0x52, 0xFA, 0x57, 0x4D, 0x42, 0x18 }, }, { { 0xB6, 0x82, 0x3C, 0x9D, 0xBC, 0x8E, 0x8C, 0x05, 0x4B, 0xCF, 0x60, 0xF2, 0x38, 0x21, 0xAC, 0x6C, 0x58, 0x19, 0x73, 0x51, 0xEA, 0xCF, 0xA5, 0x57, 0x4C, 0xF0, 0x41, 0xB4, 0xCE, 0x6B, 0x84, 0x04 }, }, { { 0xB7, 0x06, 0xDE, 0x1B, 0xD1, 0xEE, 0x2F, 0x4C, 0xEC, 0x6C, 0xE0, 0x92, 0x02, 0x2B, 0x49, 0x32, 0x81, 0xE2, 0x9A, 0x21, 0x73, 0x50, 0x8C, 0x9B, 0xD0, 0xFB, 0xC2, 0xC3, 0xD9, 0x68, 0xE3, 0xE7 }, }, { { 0xB8, 0x74, 0x36, 0x95, 0x1C, 0xEC, 0x37, 0x7E, 0xEF, 0x73, 0xDE, 0x4B, 0x74, 0xF2, 0x83, 0xC4, 0x2B, 0x2C, 0xCB, 0x1C, 0xA3, 0x7C, 0x5B, 0x30, 0xAA, 0xD6, 0x55, 0xA7, 0x40, 0x1A, 0x3D, 0x2F }, }, { { 0xB9, 0x8D, 0x83, 0x38, 0x55, 0xC3, 0x67, 0x88, 0x62, 0xB6, 0x2F, 0x36, 0x50, 0xDB, 0x00, 0xA3, 0x45, 0xF4, 0x6A, 0x0E, 0x8E, 0x01, 0x1A, 0x20, 0x01, 0x3F, 0xD8, 0xED, 0xCE, 0x25, 0x27, 0x0D }, }, { { 0xBA, 0x51, 0xAF, 0xF5, 0xD5, 0xD3, 0x10, 0x5F, 0x34, 0xA2, 0xB3, 0x3A, 0x83, 0xE3, 0xAD, 0xFD, 0x12, 0xD7, 0x9C, 0xA6, 0x05, 0x90, 0x9D, 0x96, 0x03, 0x3E, 0x32, 0xA5, 0xCF, 0x2F, 0x71, 0xF6 }, }, { { 0xBB, 0x5C, 0xB3, 0x78, 0xB7, 0xB9, 0x48, 0x7F, 0xA6, 0x1B, 0xC0, 0x91, 0x3D, 0xA1, 0xDF, 0x26, 0xA1, 0xCF, 0xEF, 0xF7, 0x45, 0x2D, 0x9B, 0xA3, 0x6C, 0xAC, 0x47, 0xA8, 0x5C, 0x7F, 0xF3, 0x48 }, }, { { 0xBC, 0x14, 0x2E, 0xBA, 0xC2, 0x78, 0xA8, 0xFE, 0x8C, 0xA8, 0xBC, 0x2C, 0x62, 0xFB, 0xCC, 0x40, 0x17, 0xFF, 0x24, 0x96, 0x98, 0xBE, 0xED, 0xFB, 0x1E, 0xF3, 0x6F, 0x37, 0x5F, 0xB3, 0x9F, 0x72 }, }, { { 0xBD, 0x2E, 0x2F, 0x37, 0xC9, 0x66, 0xC3, 0x86, 0xD9, 0x70, 0x44, 0xFD, 0xE3, 0xE3, 0xF9, 0x00, 0xFB, 0x1A, 0x0B, 0x04, 0x03, 0xB5, 0x81, 0x72, 0x5F, 0x34, 0xE3, 0xC1, 0x90, 0x05, 0x60, 0x56 }, }, { { 0xBE, 0xB9, 0x09, 0x0C, 0x92, 0xD1, 0x6B, 0xD0, 0x5A, 0xF3, 0x91, 0x5A, 0x39, 0xCC, 0x2A, 0xFA, 0x9F, 0x6A, 0x8A, 0x6F, 0xBE, 0xD4, 0xFE, 0x54, 0xD9, 0xDE, 0x32, 0x49, 0x23, 0xB3, 0x93, 0x5A }, }, { { 0xBF, 0x38, 0xE6, 0xAE, 0x32, 0x0F, 0x69, 0x16, 0x16, 0x0D, 0xA6, 0x06, 0x86, 0x83, 0xBF, 0x49, 0xF2, 0xB2, 0x2B, 0x25, 0x24, 0x84, 0x63, 0x68, 0xF5, 0x04, 0x51, 0x81, 0x52, 0x40, 0x25, 0x9A }, }, { { 0xBF, 0x60, 0xAE, 0xB3, 0x91, 0xC0, 0xFB, 0xD0, 0x49, 0x53, 0x52, 0x6D, 0xA9, 0xFD, 0x59, 0x96, 0x9A, 0x82, 0xF1, 0xEE, 0x81, 0xA7, 0x97, 0x98, 0xA4, 0x17, 0x1E, 0x14, 0x59, 0x39, 0x19, 0x67 }, }, { { 0xBF, 0xF4, 0x3A, 0x97, 0x20, 0x48, 0x2D, 0x13, 0x4C, 0xD5, 0xEE, 0x8A, 0x88, 0x99, 0xE1, 0xA7, 0x36, 0xBF, 0x54, 0xA2, 0xB7, 0x86, 0x26, 0x9C, 0x0D, 0xCB, 0x8B, 0xA1, 0x92, 0xA8, 0x1F, 0xA4 }, }, { { 0xC0, 0x09, 0xA1, 0xBE, 0x5B, 0xE8, 0xAF, 0xB5, 0x25, 0x8E, 0x12, 0x85, 0x5C, 0x64, 0xD0, 0x4D, 0x13, 0xE8, 0xCC, 0xC4, 0x7B, 0x02, 0xBF, 0x3B, 0x51, 0xC6, 0xE1, 0x18, 0x05, 0xAE, 0xEC, 0xEB }, }, { { 0xC0, 0x9F, 0xFA, 0x0E, 0xDD, 0x16, 0xBA, 0x55, 0xF2, 0x3C, 0xEA, 0xF7, 0x2B, 0x11, 0x34, 0xE9, 0x28, 0xDB, 0xA1, 0xC2, 0x34, 0x5A, 0x5A, 0xB5, 0x63, 0x1E, 0x25, 0x41, 0x24, 0x05, 0x4A, 0xDB }, }, { { 0xC0, 0xAB, 0xD1, 0xC3, 0x56, 0x2F, 0xBC, 0x7F, 0xF7, 0xBD, 0x38, 0x95, 0x54, 0x60, 0xC3, 0xFC, 0x43, 0x55, 0x0D, 0x97, 0x7F, 0x25, 0xE3, 0x43, 0xD4, 0x9C, 0xD4, 0xAF, 0xAD, 0xF2, 0x09, 0x3C }, }, { { 0xC0, 0xFE, 0xB7, 0x2A, 0x5F, 0x33, 0x16, 0x5C, 0x0D, 0xC7, 0xC4, 0x24, 0x7E, 0x23, 0xF3, 0x8C, 0xC6, 0x1F, 0x25, 0x24, 0x42, 0xB2, 0xF6, 0x13, 0x40, 0x92, 0xDE, 0x3B, 0xAD, 0x7E, 0x45, 0x0D }, }, { { 0xC1, 0x77, 0x12, 0x97, 0xA4, 0xE8, 0xDC, 0x53, 0x75, 0x19, 0x5E, 0x1B, 0x63, 0x04, 0x2B, 0x59, 0x19, 0x09, 0xF1, 0xD7, 0xEB, 0x5D, 0x25, 0xF2, 0x97, 0xAE, 0x7A, 0x61, 0xC1, 0x53, 0x8F, 0x9E }, }, { { 0xC1, 0x86, 0xBE, 0x26, 0xE4, 0x47, 0x89, 0x7C, 0x48, 0x3C, 0x43, 0xFD, 0xC0, 0x86, 0xE2, 0x60, 0x74, 0x17, 0xEB, 0x3E, 0xA7, 0x88, 0xEC, 0x03, 0x10, 0xA7, 0x9D, 0xA9, 0x24, 0x1D, 0x16, 0xDE }, }, { { 0xC1, 0xDE, 0x5F, 0xA3, 0x92, 0x13, 0x68, 0x58, 0x11, 0xA5, 0xBA, 0x93, 0x12, 0x1D, 0xE7, 0xA3, 0x95, 0x98, 0x4E, 0x84, 0x44, 0x4E, 0x58, 0xF1, 0x63, 0xB7, 0xA6, 0x20, 0xAE, 0x3B, 0xBF, 0xA8 }, }, { { 0xC2, 0xAD, 0xDF, 0x99, 0xCF, 0xC4, 0x2C, 0xE0, 0xE5, 0xA0, 0x93, 0xBC, 0xBF, 0x87, 0x40, 0x7C, 0x61, 0x1F, 0x9D, 0x0A, 0xBF, 0x2A, 0x35, 0xD6, 0xE8, 0x03, 0xA3, 0x8E, 0xCB, 0x92, 0xC7, 0xB3 }, }, { { 0xC2, 0xE7, 0x92, 0x11, 0x6A, 0x05, 0x00, 0x00, 0xBD, 0x47, 0x59, 0x1D, 0x93, 0x04, 0x71, 0xE6, 0x17, 0x4C, 0x93, 0x85, 0xF5, 0xDC, 0x32, 0xB7, 0x62, 0x31, 0x65, 0x5F, 0xC8, 0x5E, 0x22, 0xE2 }, }, { { 0xC3, 0x79, 0x03, 0xC5, 0x3A, 0xE6, 0x02, 0xEC, 0x96, 0x9E, 0xC3, 0x3F, 0x63, 0xFE, 0x9A, 0xB2, 0x0C, 0x39, 0x5F, 0x83, 0x0D, 0x30, 0xE4, 0xEE, 0x9D, 0x8D, 0xD9, 0x05, 0x92, 0x1E, 0xC1, 0xA0 }, }, { { 0xC3, 0xCF, 0x54, 0x16, 0xA5, 0x31, 0xAF, 0x4B, 0xFA, 0xE8, 0x9C, 0x45, 0x14, 0x3F, 0x20, 0xCC, 0x1B, 0x3E, 0x18, 0x1D, 0x29, 0xC2, 0xD0, 0xE8, 0xFF, 0x7D, 0x3F, 0x2A, 0x66, 0xB1, 0x82, 0xFE }, }, { { 0xC4, 0x98, 0xA1, 0xB6, 0x9F, 0x54, 0x40, 0x86, 0x17, 0x47, 0x47, 0x71, 0x5A, 0x27, 0x4D, 0x3F, 0xB5, 0x90, 0x19, 0xBE, 0x09, 0x21, 0x31, 0xBC, 0xFA, 0xA8, 0x3A, 0x39, 0x5F, 0x7E, 0x57, 0x3C }, }, { { 0xC4, 0xE2, 0x8D, 0xD8, 0x3F, 0xE3, 0x0C, 0x96, 0x33, 0x8C, 0xEF, 0x77, 0x73, 0xC6, 0xDF, 0xCA, 0x6C, 0xE4, 0xFA, 0x96, 0x41, 0xBE, 0xAB, 0x38, 0x05, 0xA8, 0xEF, 0xB6, 0xCD, 0xC3, 0xCF, 0x0A }, }, { { 0xC5, 0x00, 0xB8, 0x3F, 0x3E, 0x06, 0x6C, 0xD1, 0xDD, 0x0E, 0xBC, 0xD7, 0x3D, 0xD4, 0x01, 0x61, 0xB9, 0x25, 0x9A, 0xA7, 0x7A, 0xB8, 0xA6, 0x47, 0xE8, 0x57, 0x1F, 0xF3, 0x37, 0xCF, 0x94, 0x6D }, }, { { 0xC5, 0x29, 0x5B, 0xA6, 0xE2, 0x7E, 0x72, 0x10, 0x22, 0xFE, 0xB2, 0x1E, 0x78, 0xEB, 0x7B, 0x03, 0x57, 0xC9, 0xCD, 0x56, 0x5B, 0xD0, 0xE5, 0x96, 0x72, 0xF6, 0x66, 0x34, 0x2B, 0x79, 0x94, 0x9D }, }, { { 0xC6, 0x12, 0x75, 0x6B, 0xA5, 0x42, 0x34, 0x4A, 0xDC, 0x1B, 0x80, 0xE9, 0x38, 0x84, 0x5A, 0x1E, 0xD6, 0xE9, 0x38, 0xFE, 0xF4, 0x0D, 0x04, 0xEC, 0x86, 0x55, 0x8F, 0x4B, 0x21, 0x05, 0x2F, 0xD2 }, }, { { 0xC6, 0x17, 0xE0, 0x85, 0x5B, 0xF1, 0x4F, 0xBF, 0x21, 0xAF, 0x00, 0x82, 0x25, 0xCA, 0xBE, 0x40, 0x4F, 0x73, 0x8C, 0x27, 0x8A, 0x4A, 0x42, 0x87, 0xF1, 0xEE, 0x38, 0x01, 0x27, 0xC5, 0x61, 0xFA }, }, { { 0xC6, 0xA4, 0x24, 0xBF, 0x7C, 0xFE, 0x31, 0x72, 0x74, 0x7A, 0x47, 0x14, 0xA0, 0xEF, 0xB9, 0x17, 0x93, 0x8C, 0x5E, 0xBD, 0x59, 0x12, 0x9D, 0xED, 0x7A, 0x81, 0x18, 0xC7, 0xF6, 0x59, 0xD1, 0x33 }, }, { { 0xC6, 0xAD, 0x1D, 0x7A, 0x14, 0x1A, 0x91, 0x75, 0x2D, 0x31, 0xFB, 0xC1, 0x06, 0x16, 0xBF, 0x1C, 0xA2, 0xFB, 0x5B, 0x02, 0xE8, 0x46, 0xB5, 0x9E, 0x63, 0x34, 0x6B, 0x31, 0x92, 0xA7, 0x52, 0x92 }, }, { { 0xC7, 0x01, 0x83, 0x64, 0x38, 0xF3, 0x7B, 0xEA, 0x8A, 0x88, 0x16, 0x10, 0x63, 0x70, 0x86, 0xF8, 0x8D, 0x9A, 0x11, 0x5E, 0x00, 0x92, 0x46, 0xD2, 0x7F, 0x48, 0x9F, 0xA7, 0x18, 0x51, 0x88, 0xA8 }, }, { { 0xC7, 0xFF, 0x8E, 0xFD, 0xEC, 0xDF, 0x00, 0xD1, 0xFC, 0x8D, 0x55, 0x2D, 0x2A, 0x70, 0x70, 0xE5, 0xE3, 0x3D, 0x42, 0xE5, 0x90, 0xF5, 0x86, 0xC6, 0xAE, 0xDE, 0x03, 0x2B, 0x2D, 0x86, 0x7B, 0xD5 }, }, { { 0xC7, 0xFF, 0xB4, 0x9F, 0xBC, 0x94, 0x72, 0x24, 0x5C, 0x8E, 0x95, 0xDE, 0x62, 0x9A, 0xF5, 0xC1, 0xBF, 0xEA, 0xC5, 0x50, 0x04, 0xC1, 0x54, 0x82, 0x3A, 0x58, 0xBA, 0xE8, 0x05, 0x6E, 0x3C, 0x64 }, }, { { 0xC8, 0x37, 0xD6, 0xF2, 0xAB, 0x14, 0x79, 0x91, 0x42, 0xED, 0x3C, 0x79, 0xBE, 0xD9, 0x44, 0x1E, 0x92, 0x50, 0xBD, 0x05, 0x20, 0x25, 0xAD, 0x8A, 0xF4, 0x40, 0x41, 0xAC, 0x19, 0xEF, 0xBB, 0x4C }, }, { { 0xC9, 0x43, 0x10, 0x03, 0xBB, 0xEA, 0xB5, 0x8E, 0x35, 0x2F, 0xDE, 0xB4, 0x5B, 0x7F, 0xCF, 0x15, 0xC7, 0x3F, 0x07, 0x34, 0xA0, 0x7D, 0x6C, 0xBD, 0xF6, 0x32, 0x92, 0x92, 0xEB, 0x81, 0x2C, 0x93 }, }, { { 0xC9, 0x72, 0xF4, 0xF9, 0x6E, 0x71, 0x33, 0xE1, 0x6E, 0x55, 0x57, 0xA0, 0x57, 0xB1, 0xD4, 0x2B, 0xA9, 0x2D, 0x98, 0x5C, 0xAE, 0xE7, 0x3C, 0xAF, 0xDA, 0xEB, 0x55, 0xEC, 0xA2, 0xE4, 0xAB, 0xB0 }, }, { { 0xC9, 0x78, 0x37, 0x2C, 0x9E, 0x11, 0x60, 0x71, 0xB6, 0x1B, 0x90, 0x92, 0xA9, 0xAA, 0x96, 0x81, 0x62, 0x36, 0x55, 0xA6, 0x6F, 0x4F, 0xCB, 0xC4, 0xD3, 0xA6, 0x7E, 0xFD, 0x56, 0x72, 0x48, 0x30 }, }, { { 0xCA, 0x55, 0x6F, 0x82, 0xC9, 0x68, 0x4C, 0x9A, 0xF3, 0x55, 0x7D, 0x3E, 0x2D, 0x88, 0xAF, 0x92, 0xED, 0x25, 0x9C, 0x20, 0xFF, 0xD1, 0xDD, 0xE9, 0xF7, 0x9D, 0x6B, 0x92, 0xC6, 0x1E, 0xE1, 0xB9 }, }, { { 0xCA, 0xBE, 0x25, 0x56, 0xF1, 0xBB, 0x56, 0x57, 0x0C, 0xEF, 0x3A, 0x87, 0x03, 0x32, 0x71, 0xA1, 0xF2, 0x1D, 0x09, 0xB7, 0xFD, 0x04, 0x12, 0x83, 0x18, 0xE5, 0xE7, 0xBC, 0xE3, 0xA2, 0x01, 0xE2 }, }, { { 0xCA, 0xDC, 0xD5, 0xAE, 0x1B, 0x75, 0x6A, 0xB7, 0x41, 0xB3, 0x56, 0x9C, 0x42, 0xA5, 0x41, 0x1F, 0x09, 0x3E, 0x4E, 0x1F, 0x01, 0x2E, 0xC5, 0x79, 0x91, 0xCB, 0xD6, 0xDB, 0xE0, 0x8F, 0xAA, 0xC1 }, }, { { 0xCB, 0x7A, 0x43, 0x8D, 0x16, 0xE4, 0xA5, 0xF3, 0xC5, 0x6F, 0xDF, 0x19, 0x1E, 0x1D, 0xAF, 0x9F, 0x32, 0x5C, 0x65, 0x0B, 0xD6, 0x2F, 0x07, 0xC4, 0x67, 0x71, 0x72, 0x07, 0x35, 0x1A, 0xE3, 0x29 }, }, { { 0xCC, 0x2A, 0x70, 0x6F, 0xE6, 0x8F, 0x5D, 0x17, 0xF4, 0xAB, 0xAF, 0x60, 0x86, 0xE5, 0xBD, 0x97, 0xAE, 0x35, 0xEB, 0x35, 0x9F, 0x75, 0xC0, 0x92, 0xBB, 0xA4, 0x93, 0xFE, 0x11, 0xF2, 0x69, 0xFD }, }, { { 0xCC, 0x30, 0xD8, 0x19, 0xDE, 0x54, 0x05, 0xF6, 0x49, 0xC8, 0xB7, 0xA8, 0x14, 0x8F, 0x26, 0xD7, 0x71, 0x08, 0x3E, 0xC5, 0x18, 0xF9, 0xB6, 0x6F, 0xF5, 0x47, 0xF2, 0x82, 0x2D, 0x11, 0x93, 0x6D }, }, { { 0xCC, 0x65, 0xCD, 0xC5, 0x33, 0x62, 0xD4, 0x21, 0x62, 0x7E, 0xAE, 0xF5, 0xD0, 0xC8, 0xE4, 0xC4, 0xE2, 0x40, 0xAD, 0xE0, 0xC9, 0xD4, 0x20, 0xBE, 0x67, 0x1E, 0x70, 0xF0, 0xFB, 0xAC, 0x8D, 0x0A }, }, { { 0xCD, 0xB1, 0x62, 0x53, 0xD2, 0x2E, 0xD5, 0xD4, 0x26, 0xCF, 0xA1, 0xB0, 0x5C, 0xEC, 0xD8, 0x6E, 0xF1, 0xB7, 0xDE, 0xAA, 0x07, 0xC5, 0x70, 0x5E, 0xBB, 0xAF, 0x7D, 0x9A, 0x80, 0x7D, 0x56, 0x16 }, }, { { 0xCD, 0xC0, 0x39, 0xF3, 0xA2, 0xD1, 0xBB, 0xA5, 0xE8, 0x09, 0x4E, 0x55, 0x23, 0xCF, 0x60, 0x47, 0x09, 0x7D, 0x4B, 0x3C, 0xD4, 0xEC, 0x4E, 0xD6, 0xAA, 0x8E, 0xB7, 0xB4, 0xD8, 0xB5, 0x77, 0x7D }, }, { { 0xCD, 0xC4, 0xEA, 0x92, 0x02, 0xE3, 0x3E, 0xDD, 0x0F, 0x2D, 0x3A, 0xE8, 0x6A, 0xCA, 0xC7, 0xFB, 0x25, 0x35, 0x4B, 0x02, 0x23, 0x5B, 0x09, 0x33, 0xAA, 0x81, 0xA3, 0x13, 0xB5, 0xFD, 0xFE, 0xEC }, }, { { 0xCE, 0x4C, 0x2F, 0x8F, 0x16, 0x46, 0x8A, 0x58, 0x88, 0xE9, 0x0F, 0x73, 0x4E, 0x4D, 0x22, 0x02, 0xDF, 0xAD, 0xBF, 0xA6, 0x6F, 0x5B, 0x35, 0x75, 0x2B, 0xAA, 0x76, 0x21, 0xA7, 0x60, 0xB0, 0x88 }, }, { { 0xCE, 0x81, 0x44, 0x58, 0x54, 0x03, 0x1F, 0x3D, 0x0F, 0x5C, 0x88, 0x75, 0x46, 0x4D, 0xCD, 0x5B, 0xA6, 0xC8, 0x90, 0xF4, 0x49, 0xB3, 0x20, 0x7B, 0xCA, 0x2B, 0xC9, 0x61, 0x82, 0x2D, 0x27, 0xC4 }, }, { { 0xCF, 0xA0, 0xC0, 0x0C, 0xB2, 0xFB, 0x4B, 0x85, 0x7A, 0xAD, 0x22, 0xB1, 0x3A, 0x90, 0xE3, 0x46, 0xA0, 0x3E, 0x6B, 0x79, 0xAB, 0xD5, 0xD2, 0x75, 0xB5, 0x43, 0x24, 0x68, 0x17, 0x92, 0xD6, 0xD1 }, }, { { 0xD0, 0xF5, 0x93, 0xC1, 0xA8, 0x1B, 0x1E, 0xF8, 0x51, 0x69, 0x81, 0xEE, 0x56, 0xF1, 0xD5, 0x98, 0xA2, 0xA6, 0x03, 0x48, 0x8C, 0x67, 0x8C, 0x1B, 0x7B, 0xBE, 0xA6, 0x44, 0x6B, 0x00, 0x83, 0xAD }, }, { { 0xD2, 0x90, 0x3C, 0xA2, 0x55, 0x17, 0x27, 0xED, 0x01, 0x71, 0xCC, 0x4A, 0x43, 0xB3, 0xCA, 0xE0, 0x09, 0xB7, 0x47, 0xB9, 0xF4, 0xF8, 0x48, 0x72, 0x92, 0x27, 0xBF, 0x59, 0x02, 0xF2, 0x3E, 0x47 }, }, { { 0xD2, 0xE8, 0xA1, 0x23, 0x7A, 0x93, 0xF5, 0x78, 0xD1, 0xBA, 0x8F, 0x09, 0xE4, 0xFF, 0x10, 0x7B, 0x62, 0x35, 0x78, 0x85, 0x42, 0xAA, 0x61, 0x83, 0xD1, 0x76, 0xDB, 0xF1, 0xC8, 0x8D, 0xCF, 0xB6 }, }, { { 0xD5, 0x04, 0x88, 0x96, 0x86, 0x07, 0x29, 0xA8, 0xFA, 0x5D, 0x23, 0x57, 0x81, 0x2B, 0xA5, 0x6C, 0xBE, 0x84, 0xC9, 0xAB, 0x7D, 0x14, 0xDF, 0x47, 0x64, 0xE0, 0xB6, 0x62, 0x0F, 0xA3, 0x20, 0x10 }, }, { { 0xD5, 0x41, 0xA7, 0x7E, 0x13, 0x6E, 0x9E, 0x70, 0x3B, 0xB9, 0x9F, 0x80, 0x68, 0xCF, 0xEE, 0x86, 0xA4, 0xB9, 0xF0, 0x89, 0xE0, 0x2D, 0x0C, 0x6C, 0xB6, 0xD4, 0xA3, 0x94, 0x6C, 0x6B, 0x16, 0x7A }, }, { { 0xD5, 0x83, 0x94, 0x96, 0xCD, 0xC8, 0x5B, 0xE3, 0xD1, 0xF1, 0xAC, 0x65, 0x2E, 0xFA, 0x92, 0xBE, 0xA3, 0xB0, 0x61, 0xC1, 0x3D, 0xAD, 0x5A, 0x82, 0x11, 0x22, 0xCF, 0xE9, 0xC7, 0x1A, 0x5A, 0x32 }, }, { { 0xD5, 0xA4, 0xEE, 0x46, 0x95, 0xB5, 0x65, 0xA6, 0x7E, 0x50, 0x48, 0x66, 0xFE, 0x5B, 0xA3, 0xC0, 0xED, 0xCA, 0xEE, 0xD5, 0x2A, 0xD0, 0xAF, 0x07, 0xE6, 0x79, 0x17, 0x73, 0x85, 0x12, 0xC8, 0xF5 }, }, { { 0xD6, 0x25, 0xC0, 0x59, 0x2B, 0x25, 0xDC, 0x03, 0xAA, 0x7E, 0x87, 0x8E, 0x6A, 0x85, 0x09, 0x1B, 0xAA, 0x07, 0x8D, 0x26, 0x8B, 0xBD, 0xB4, 0x9F, 0x09, 0x67, 0x94, 0x08, 0x61, 0x2D, 0x1E, 0xFE }, }, { { 0xD6, 0xD1, 0xB3, 0x5C, 0xBC, 0x12, 0xFB, 0x1C, 0x70, 0xA0, 0xB4, 0x3B, 0xA5, 0x9A, 0xB3, 0xD3, 0x22, 0x5F, 0x37, 0x32, 0x64, 0xDD, 0x87, 0xFB, 0xCA, 0x00, 0x61, 0xEC, 0x1C, 0x4D, 0xA1, 0x1A }, }, { { 0xD7, 0x32, 0x49, 0x74, 0xB5, 0x60, 0x09, 0x62, 0x17, 0x61, 0xF7, 0xC0, 0xFF, 0x68, 0x9D, 0xDE, 0x47, 0x74, 0x99, 0x85, 0xE1, 0xEE, 0x8B, 0x5C, 0x89, 0x61, 0xDD, 0x8F, 0x6A, 0x78, 0xBB, 0xF5 }, }, { { 0xD9, 0x2E, 0x3E, 0xE3, 0x82, 0xC8, 0xDC, 0xAF, 0xA0, 0x39, 0x3D, 0x9F, 0x9A, 0x00, 0xBF, 0x4C, 0xD9, 0xD5, 0x64, 0x26, 0x2B, 0x18, 0x0F, 0x68, 0x16, 0x0B, 0x20, 0x34, 0xC5, 0x44, 0xD1, 0x0A }, }, { { 0xD9, 0x65, 0xF7, 0x41, 0x62, 0x04, 0xDA, 0x83, 0x1A, 0xF6, 0x6B, 0xFA, 0x8F, 0x90, 0xD1, 0x41, 0xE9, 0x93, 0xF0, 0x00, 0x21, 0x33, 0xF2, 0x8D, 0xE9, 0x7F, 0x56, 0x4A, 0x1D, 0x60, 0x4E, 0xCC }, }, { { 0xD9, 0x7F, 0x55, 0xB9, 0x57, 0x9B, 0x05, 0xAE, 0x4A, 0x3E, 0xD7, 0xFC, 0x55, 0x8C, 0x58, 0x45, 0x64, 0x51, 0x60, 0xDA, 0xB3, 0x53, 0x85, 0xC1, 0x38, 0xBC, 0x89, 0x9C, 0x4D, 0xAD, 0x8B, 0x36 }, }, { { 0xDA, 0xDF, 0x97, 0x13, 0x34, 0x14, 0xAD, 0x51, 0x3F, 0xC7, 0x50, 0x14, 0xE9, 0x56, 0x65, 0xDA, 0xD7, 0x76, 0xB1, 0x50, 0x4B, 0x15, 0x67, 0x43, 0x4F, 0xD8, 0x2A, 0x79, 0xA2, 0x20, 0xE9, 0xA1 }, }, { { 0xDE, 0xCD, 0xB9, 0xFC, 0x1D, 0xDE, 0xC9, 0x7E, 0x09, 0xC3, 0x02, 0x6A, 0xCE, 0xB7, 0x6B, 0xDA, 0xE9, 0xDE, 0xB6, 0x62, 0x75, 0x1D, 0xDA, 0x34, 0x9D, 0x2F, 0xA6, 0xBD, 0x75, 0xCA, 0x59, 0x14 }, }, { { 0xDE, 0xD1, 0x9A, 0xD5, 0xDE, 0x99, 0x65, 0xD9, 0x22, 0x5C, 0x1B, 0xBA, 0x5F, 0xB4, 0xD8, 0x90, 0xC8, 0xE5, 0xC0, 0x35, 0xE4, 0x85, 0x27, 0x52, 0xB6, 0x69, 0xB0, 0x40, 0x0F, 0x24, 0xF1, 0x74 }, }, { { 0xDF, 0x30, 0xBF, 0x8D, 0x1B, 0xF9, 0x37, 0x8E, 0x43, 0x3E, 0xF9, 0xE1, 0xB3, 0xA2, 0x28, 0xA0, 0x7E, 0x36, 0x58, 0xA5, 0xBC, 0x43, 0x88, 0x23, 0x45, 0x4D, 0xB0, 0x6A, 0x67, 0x94, 0x4C, 0x6E }, }, { { 0xDF, 0x69, 0xF9, 0x6A, 0x85, 0x67, 0x8F, 0x6C, 0xAF, 0x3F, 0xDE, 0x25, 0xEC, 0xFB, 0x5D, 0xF4, 0x74, 0x70, 0x87, 0xC2, 0xAF, 0x3B, 0x00, 0x65, 0xFB, 0x15, 0x10, 0x55, 0xCB, 0xCB, 0xA8, 0xC1 }, }, { { 0xE0, 0x0B, 0xD7, 0x86, 0xD1, 0xF2, 0xF4, 0x46, 0xC4, 0xBA, 0x83, 0x99, 0xD4, 0xD8, 0xD5, 0xA0, 0xD1, 0x98, 0x57, 0x8F, 0x42, 0x99, 0xFD, 0xFD, 0xAF, 0xF7, 0x8C, 0x3F, 0x67, 0x71, 0xF3, 0x94 }, }, { { 0xE0, 0x8B, 0x2C, 0xC2, 0x7A, 0xE8, 0xE2, 0xEF, 0x1A, 0x33, 0x01, 0x7A, 0x9A, 0xC2, 0x5D, 0xDA, 0xFB, 0x5E, 0xA1, 0x12, 0xC9, 0x56, 0xB0, 0x02, 0xFE, 0x6C, 0x79, 0x80, 0x14, 0xAA, 0x90, 0x65 }, }, { { 0xE1, 0xB2, 0xE8, 0x6B, 0x0D, 0xA8, 0x69, 0xE9, 0x25, 0x26, 0x6C, 0x1B, 0x56, 0x88, 0x34, 0x5A, 0x17, 0xB0, 0xF6, 0xE2, 0xA2, 0x14, 0x94, 0x54, 0x7E, 0xAC, 0x09, 0x7C, 0x8B, 0xF5, 0x3C, 0x5A }, }, { { 0xE1, 0xD6, 0x44, 0xA0, 0x96, 0xBD, 0x8A, 0x6C, 0xAC, 0xBB, 0xDA, 0x3E, 0x7F, 0xC3, 0x38, 0xEA, 0xDD, 0xC1, 0x2F, 0x23, 0x6C, 0x72, 0x61, 0xE4, 0x5F, 0x8A, 0xD2, 0xD8, 0x42, 0x42, 0x4F, 0x72 }, }, { { 0xE2, 0x24, 0x10, 0xB5, 0xA6, 0x7F, 0xED, 0xC2, 0x64, 0x69, 0x4C, 0x44, 0x9D, 0x84, 0xFA, 0x1A, 0x02, 0xBC, 0x8B, 0x21, 0x28, 0xC1, 0x25, 0x60, 0x71, 0x58, 0xC9, 0x1B, 0x05, 0x38, 0x6C, 0x6A }, }, { { 0xE2, 0xA8, 0x47, 0xC3, 0xF0, 0x9B, 0xEB, 0x6F, 0x05, 0x68, 0x6F, 0x17, 0x79, 0x1B, 0x05, 0xF1, 0xFE, 0x25, 0xF7, 0x71, 0x86, 0x9C, 0x42, 0x63, 0xA5, 0x5B, 0x94, 0x18, 0x77, 0xE4, 0x79, 0x04 }, }, { { 0xE2, 0xF3, 0x9A, 0x9D, 0x48, 0xA3, 0x22, 0x10, 0x55, 0xB3, 0xC8, 0xA3, 0xEB, 0x14, 0x39, 0xD6, 0xB8, 0x73, 0x01, 0x3E, 0xE4, 0xD0, 0x97, 0x12, 0x20, 0x64, 0xF2, 0x7E, 0xC0, 0x3D, 0xD4, 0xDA }, }, { { 0xE2, 0xF5, 0xDE, 0x57, 0xCD, 0x67, 0x24, 0x9A, 0x7E, 0x1F, 0x45, 0x5B, 0x85, 0xC0, 0x6F, 0x0D, 0x80, 0x9E, 0x75, 0xA5, 0x5C, 0x6B, 0x05, 0x48, 0x16, 0xE0, 0x19, 0x89, 0x9A, 0x3A, 0x02, 0xFF }, }, { { 0xE6, 0x44, 0xD1, 0x1C, 0x37, 0x07, 0x0F, 0x89, 0x69, 0x33, 0x08, 0x17, 0x8D, 0x6B, 0xE4, 0x95, 0x94, 0x96, 0x92, 0xC1, 0xFB, 0xEB, 0x30, 0xED, 0x32, 0x9B, 0x74, 0x02, 0x7F, 0xCF, 0xFD, 0x48 }, }, { { 0xE6, 0xB0, 0xF2, 0xE2, 0x5B, 0xD5, 0x16, 0xE4, 0xBB, 0xA3, 0x7A, 0x2B, 0xF2, 0xE2, 0xC7, 0x2A, 0x1E, 0x53, 0x9C, 0x60, 0x30, 0xF3, 0xCF, 0x9B, 0xBE, 0x5E, 0x79, 0x72, 0x8D, 0x68, 0x64, 0x78 }, }, { { 0xE6, 0xE5, 0x4D, 0xE7, 0xB4, 0x97, 0x54, 0xD3, 0x57, 0xB0, 0xA8, 0xD9, 0x4A, 0x4D, 0x4F, 0x80, 0xAC, 0xD1, 0x99, 0x4C, 0xCC, 0x1C, 0x99, 0x08, 0xE9, 0xF0, 0xD9, 0x21, 0xE4, 0x28, 0xB8, 0x38 }, }, { { 0xE7, 0x0C, 0xBB, 0x7A, 0xF7, 0xAA, 0x20, 0xB9, 0x89, 0x0B, 0xC1, 0xF9, 0xFA, 0x00, 0xD8, 0x09, 0x0B, 0x5A, 0xC9, 0x82, 0x5E, 0xA9, 0xD2, 0xFD, 0xF7, 0x7C, 0xA4, 0xDA, 0xE9, 0x44, 0x51, 0xB2 }, }, { { 0xE8, 0x16, 0xF9, 0x92, 0x94, 0xA1, 0x3A, 0xC2, 0xFA, 0x2B, 0xFB, 0x76, 0xC2, 0x2D, 0xFA, 0x71, 0xBC, 0x3D, 0xA4, 0x8F, 0x67, 0x1E, 0xF7, 0x7C, 0x00, 0xAA, 0x8E, 0x45, 0x9B, 0x7C, 0xC8, 0x2A }, }, { { 0xE8, 0x21, 0x3C, 0x45, 0x51, 0x81, 0x61, 0xBC, 0x36, 0x37, 0x3D, 0xCD, 0x2D, 0x4B, 0x21, 0xB7, 0x6A, 0x7C, 0x06, 0x6D, 0xF5, 0x52, 0x6E, 0x88, 0x8B, 0x6E, 0xED, 0x09, 0xA9, 0xEE, 0xD0, 0x62 }, }, { { 0xE9, 0xF5, 0x71, 0xC7, 0x71, 0x64, 0xAB, 0xEA, 0xE1, 0x85, 0x28, 0x37, 0x5C, 0xFD, 0xC7, 0x21, 0x9A, 0x6B, 0xDE, 0x46, 0x1B, 0x19, 0x73, 0xBE, 0x2B, 0xB8, 0xBD, 0xF0, 0xDA, 0x78, 0xB2, 0xB4 }, }, { { 0xEB, 0x11, 0x63, 0xAA, 0xEF, 0xE8, 0xFD, 0x88, 0xE1, 0x32, 0x7B, 0x48, 0xA9, 0xC0, 0x06, 0x2E, 0x06, 0xF0, 0xA6, 0xEA, 0xA0, 0xA0, 0x18, 0x24, 0x7F, 0x9F, 0xA4, 0xE3, 0x4E, 0x3A, 0x47, 0x4C }, }, { { 0xEC, 0x4B, 0xBD, 0xEB, 0x15, 0x12, 0x1D, 0x96, 0x76, 0x4D, 0x6C, 0x01, 0xB2, 0x7E, 0xD5, 0xAE, 0x86, 0x46, 0x5C, 0x46, 0xD5, 0xA4, 0x0E, 0x34, 0xAE, 0xFC, 0x09, 0x2D, 0x3E, 0x8B, 0xB1, 0x76 }, }, { { 0xEC, 0x5F, 0xA4, 0x73, 0x12, 0x1E, 0x3F, 0x49, 0xF0, 0x95, 0x3A, 0x2A, 0x91, 0x83, 0x39, 0xE3, 0x6F, 0x3C, 0xB6, 0xB8, 0xD8, 0xB8, 0x9E, 0x91, 0x74, 0x23, 0xDA, 0xCE, 0xAC, 0xE6, 0xD5, 0x8A }, }, { { 0xEC, 0xCE, 0x4E, 0x52, 0x82, 0xFD, 0x2E, 0xE0, 0x03, 0xA4, 0x03, 0x2C, 0x80, 0xD3, 0x32, 0x1A, 0x69, 0x47, 0x25, 0x98, 0x94, 0x59, 0x09, 0xCB, 0x25, 0x55, 0x7A, 0xA8, 0x47, 0x74, 0x2D, 0xDF }, }, { { 0xED, 0x5B, 0xB8, 0x6A, 0x95, 0xA5, 0xFE, 0x2B, 0x17, 0x08, 0xF2, 0x56, 0x75, 0x4A, 0x89, 0xC4, 0x29, 0x67, 0x9B, 0x30, 0x75, 0x8E, 0xE0, 0x12, 0x2B, 0x9E, 0x50, 0x85, 0x8D, 0xE2, 0x10, 0x4B }, }, { { 0xED, 0xC1, 0xBF, 0x3E, 0xFB, 0xF7, 0xE1, 0xD9, 0x5E, 0x19, 0xC5, 0x5E, 0xCA, 0xE7, 0x7E, 0x83, 0x69, 0x46, 0xAB, 0x0A, 0x26, 0xA7, 0x8E, 0x32, 0xA4, 0x72, 0xC9, 0xD3, 0x6C, 0x69, 0xCE, 0xCD }, }, { { 0xED, 0xF4, 0xDF, 0x97, 0x2C, 0xAD, 0x6C, 0x47, 0x0B, 0xAB, 0x5D, 0x66, 0x42, 0xF6, 0x60, 0xB8, 0x42, 0xD6, 0xC9, 0x73, 0x07, 0x44, 0x93, 0xE4, 0xEF, 0x1B, 0xBF, 0x31, 0x1A, 0x92, 0x79, 0x95 }, }, { { 0xEE, 0x0C, 0xF6, 0x2B, 0x9D, 0x8E, 0x42, 0xA2, 0x23, 0xB9, 0xA9, 0x60, 0xB5, 0xE9, 0x67, 0x0C, 0xCC, 0x34, 0x6D, 0x89, 0x93, 0x8F, 0xFA, 0x5D, 0xF7, 0x98, 0x65, 0xE4, 0x13, 0xD6, 0x31, 0x54 }, }, { { 0xEE, 0x34, 0xE1, 0xA1, 0x9B, 0xC8, 0x89, 0xF8, 0x5F, 0x7F, 0x0F, 0x5B, 0xF8, 0x72, 0xB1, 0xAC, 0x56, 0x5E, 0xC6, 0xF1, 0x9D, 0xB5, 0x17, 0xBA, 0x4E, 0xD7, 0x55, 0xC4, 0x18, 0x5F, 0x69, 0xE8 }, }, { { 0xEF, 0x36, 0xA2, 0x29, 0x89, 0x65, 0xE4, 0x98, 0x84, 0x59, 0xB9, 0x21, 0x6A, 0xB3, 0x3C, 0x3C, 0xA8, 0x42, 0xD2, 0x16, 0x83, 0xB6, 0x2A, 0x2B, 0xF1, 0x53, 0x0D, 0x30, 0xB0, 0xAE, 0x78, 0x25 }, }, { { 0xEF, 0xAF, 0xCA, 0x84, 0x90, 0x30, 0x7B, 0x0F, 0x62, 0x2B, 0xF4, 0x3A, 0x0E, 0xB3, 0xC5, 0x1A, 0xCB, 0xDD, 0xDE, 0xDC, 0x23, 0x92, 0xF1, 0x61, 0xAC, 0xED, 0x16, 0x71, 0xA6, 0x53, 0x60, 0x7E }, }, { { 0xEF, 0xD1, 0xE0, 0xE7, 0x3F, 0xA8, 0x71, 0x00, 0xB7, 0x6A, 0x93, 0x23, 0x49, 0xC4, 0x5D, 0x09, 0xB2, 0x8B, 0x2D, 0x8A, 0x00, 0x17, 0x19, 0xA5, 0x8D, 0xFA, 0xCC, 0x74, 0x84, 0xC7, 0xCF, 0x42 }, }, { { 0xF0, 0x11, 0xAD, 0x9E, 0xDD, 0x4F, 0xE7, 0x18, 0x8D, 0x77, 0x2E, 0xBA, 0xFA, 0x5B, 0xF5, 0x32, 0x92, 0x47, 0x77, 0x88, 0xDC, 0x12, 0x80, 0x32, 0x76, 0xB0, 0x00, 0xC4, 0x41, 0x91, 0x03, 0xF0 }, }, { { 0xF0, 0x2F, 0x9D, 0xA4, 0x5D, 0x9E, 0xB9, 0x86, 0x19, 0x4E, 0x06, 0xF5, 0xE6, 0x18, 0x95, 0x45, 0x12, 0xC9, 0x02, 0x6E, 0x7C, 0xA7, 0xB5, 0x1E, 0x66, 0x5D, 0xB6, 0xAD, 0xBA, 0xC1, 0xF6, 0x00 }, }, { { 0xF0, 0x6B, 0x35, 0x95, 0x36, 0xD1, 0x34, 0x32, 0x8B, 0x36, 0x00, 0x4D, 0xA9, 0xA9, 0x19, 0x0C, 0x3A, 0x76, 0x69, 0xE8, 0x27, 0x8D, 0xB9, 0xF7, 0x58, 0x57, 0xC4, 0x8D, 0x64, 0x4B, 0xE2, 0x03 }, }, { { 0xF0, 0xCF, 0xC7, 0x79, 0x13, 0x39, 0x7D, 0xE2, 0x38, 0xED, 0xB5, 0x9F, 0x0F, 0x99, 0x23, 0xC6, 0xD4, 0x11, 0x0A, 0x4B, 0x3A, 0xC8, 0xAC, 0x76, 0x55, 0x6A, 0x0C, 0x92, 0x44, 0xF0, 0x3F, 0xC1 }, }, { { 0xF2, 0xB1, 0x95, 0x84, 0x6E, 0xE2, 0xB9, 0xAB, 0x5F, 0x18, 0xE6, 0x80, 0x21, 0xF8, 0xDF, 0x7C, 0x0B, 0x60, 0x58, 0xDE, 0xDE, 0x86, 0xC5, 0xD5, 0x90, 0xF2, 0xE8, 0x64, 0x3A, 0xFE, 0x04, 0x52 }, }, { { 0xF2, 0xE5, 0x30, 0x0C, 0x39, 0xF2, 0x86, 0xC6, 0x78, 0x99, 0x90, 0x9C, 0x7C, 0xE7, 0x35, 0x9B, 0x09, 0x45, 0xD2, 0xAF, 0xD3, 0x4A, 0x6D, 0xD6, 0x9E, 0x08, 0xCD, 0xA5, 0x44, 0xC8, 0x7B, 0x3A }, }, { { 0xF3, 0x0C, 0x0A, 0xED, 0x70, 0x6D, 0x22, 0x55, 0x5F, 0x07, 0x09, 0x6A, 0xF4, 0xB8, 0xBE, 0xDC, 0x16, 0x3C, 0x0F, 0x6E, 0xD5, 0x34, 0x6E, 0xFC, 0x28, 0xE8, 0xCF, 0xAF, 0x84, 0x2F, 0xA5, 0xD9 }, }, { { 0xF6, 0x13, 0xD5, 0x90, 0x46, 0xD1, 0x66, 0x71, 0xD3, 0xC5, 0x60, 0x17, 0x6F, 0x3D, 0x77, 0xFD, 0xC5, 0x1E, 0x5F, 0x57, 0xB5, 0xE4, 0x8A, 0xE7, 0xA4, 0xB9, 0x70, 0x0A, 0x11, 0xD4, 0x69, 0x3A }, }, { { 0xF6, 0x54, 0x6B, 0x2F, 0xFE, 0x2B, 0xAE, 0xF7, 0x35, 0xE8, 0x25, 0x67, 0xA6, 0xE2, 0x36, 0x75, 0x03, 0x94, 0xC1, 0x19, 0x14, 0x09, 0x87, 0x0C, 0x6F, 0xBE, 0x95, 0x2D, 0x08, 0xA3, 0x3A, 0xBA }, }, { { 0xF6, 0xAA, 0xEF, 0x12, 0xFC, 0x25, 0x2D, 0xD9, 0xE7, 0xF7, 0x75, 0x2C, 0x2F, 0x74, 0x5D, 0x59, 0xD6, 0x37, 0x57, 0xC6, 0xCC, 0x14, 0xD2, 0x25, 0x3A, 0x64, 0x7C, 0xD1, 0x81, 0x49, 0x39, 0x93 }, }, { { 0xF8, 0x64, 0x44, 0x3E, 0x2F, 0x63, 0x9E, 0x7C, 0xFF, 0xD2, 0x42, 0x21, 0xF6, 0x1B, 0xBF, 0xF0, 0x7C, 0xCE, 0x5C, 0x61, 0xDD, 0xB1, 0x68, 0xB3, 0xB4, 0x04, 0xD7, 0xC8, 0xCD, 0xCA, 0x18, 0xB2 }, }, { { 0xF8, 0x94, 0xF9, 0x67, 0x36, 0x9C, 0xE7, 0xCF, 0xA3, 0x1A, 0xC1, 0x9A, 0x66, 0x65, 0xB0, 0xC4, 0x24, 0xBA, 0x40, 0x8A, 0xD5, 0xD3, 0x65, 0xF1, 0x68, 0xD8, 0xBE, 0xEB, 0x79, 0xF4, 0x89, 0xF3 }, }, { { 0xF8, 0xCF, 0x1E, 0x08, 0x6A, 0x6A, 0x06, 0x3F, 0xAD, 0x25, 0x74, 0x25, 0xAA, 0xE7, 0x20, 0x01, 0x40, 0x05, 0xB4, 0x15, 0x91, 0x2D, 0xBB, 0x8C, 0x0B, 0xC9, 0x99, 0xAF, 0x48, 0x48, 0xCF, 0xE5 }, }, { { 0xFB, 0x9A, 0xF7, 0x9D, 0xEA, 0x18, 0xAF, 0x62, 0x99, 0x85, 0x0E, 0x25, 0x15, 0x9B, 0x4F, 0xB2, 0x24, 0xCB, 0xB0, 0xF1, 0x4E, 0xAD, 0x7E, 0x85, 0xF6, 0x0C, 0x2A, 0xB2, 0x09, 0xEA, 0x45, 0x0D }, }, { { 0xFB, 0xC4, 0xC9, 0xBA, 0xCF, 0xE3, 0xDA, 0x64, 0x13, 0x18, 0x26, 0x6B, 0x72, 0x58, 0x56, 0x00, 0x35, 0xBC, 0x64, 0x60, 0x8E, 0x34, 0xB9, 0x90, 0xCA, 0x92, 0xA5, 0x52, 0xF3, 0x14, 0x21, 0x61 }, }, { { 0xFB, 0xED, 0xD3, 0x88, 0x89, 0xF0, 0xB4, 0x1F, 0x73, 0x4D, 0xE2, 0xF4, 0xC9, 0xD6, 0xF2, 0x7C, 0x8D, 0x4A, 0xA9, 0xAB, 0x73, 0x64, 0x91, 0xE1, 0x64, 0xE1, 0x21, 0xB7, 0xBC, 0xAF, 0x44, 0xE8 }, }, { { 0xFC, 0x01, 0xA5, 0x5A, 0x36, 0xCC, 0x8B, 0x7B, 0x7C, 0xA2, 0xEA, 0xB0, 0x84, 0x60, 0xC2, 0x8D, 0x1D, 0x6C, 0xD8, 0x9C, 0x57, 0x59, 0x94, 0x05, 0xD5, 0x37, 0x4B, 0x91, 0xAA, 0xEB, 0xC8, 0x79 }, }, { { 0xFC, 0x4D, 0x9A, 0x37, 0xE5, 0xF7, 0x32, 0x72, 0xD0, 0xA9, 0xDF, 0xCC, 0xE9, 0x03, 0x12, 0xC7, 0x52, 0xE1, 0xB5, 0x2E, 0xB6, 0x54, 0xC4, 0x2C, 0x36, 0x94, 0x4B, 0x90, 0x2A, 0x30, 0x41, 0x07 }, }, { { 0xFC, 0x56, 0xDB, 0xA1, 0xE7, 0xAF, 0xBD, 0xAA, 0x07, 0x33, 0xC6, 0x91, 0x1C, 0x5F, 0x1F, 0x18, 0x28, 0xCB, 0x12, 0x98, 0x31, 0x40, 0x1A, 0x3C, 0xFD, 0xEA, 0xA7, 0x24, 0x62, 0x95, 0x35, 0x94 }, }, { { 0xFC, 0x83, 0xC2, 0x89, 0x89, 0x5A, 0x92, 0x08, 0xC9, 0xB1, 0x7A, 0x16, 0xBC, 0xE5, 0xCE, 0x80, 0xE8, 0xF4, 0xA0, 0x77, 0x21, 0x25, 0x29, 0xCE, 0x0B, 0xC7, 0xF5, 0x42, 0xC6, 0xCB, 0xDE, 0x1A }, }, { { 0xFC, 0xA6, 0x23, 0x5D, 0x2A, 0xA4, 0xB1, 0xB2, 0x51, 0x50, 0x78, 0x57, 0xB4, 0xF0, 0x08, 0xDF, 0xD5, 0x27, 0x04, 0x2C, 0xE0, 0x45, 0x01, 0xAA, 0xE2, 0x9D, 0xD2, 0x05, 0xBB, 0xEF, 0xCE, 0x0D }, }, { { 0xFC, 0xE7, 0x34, 0xE1, 0x2B, 0x8E, 0xFB, 0x43, 0x12, 0x71, 0xBF, 0xF6, 0x7A, 0x7A, 0x0A, 0x93, 0xB2, 0x19, 0xDD, 0x5E, 0x5D, 0xCC, 0x12, 0x58, 0x59, 0x4D, 0x96, 0xFC, 0xE1, 0x93, 0xB8, 0x60 }, }, { { 0xFD, 0x9C, 0xFE, 0x14, 0xDA, 0xD8, 0x97, 0x8C, 0x5B, 0xC8, 0x88, 0x93, 0x8F, 0x16, 0xF3, 0xB3, 0x98, 0xF7, 0x63, 0xA3, 0xAD, 0xAF, 0xAA, 0x4A, 0xD9, 0x41, 0xB7, 0xE3, 0x87, 0xEB, 0x4F, 0x4A }, }, { { 0xFD, 0xED, 0x92, 0xCB, 0x40, 0x91, 0x66, 0x82, 0x3A, 0x35, 0xE2, 0x17, 0xF3, 0x0B, 0x38, 0xC4, 0x86, 0xF8, 0x3E, 0xF2, 0xD4, 0xF2, 0x7B, 0x05, 0xF1, 0x8C, 0x74, 0x49, 0x81, 0x33, 0x9A, 0x1C }, }, { { 0xFE, 0x26, 0xB2, 0xA6, 0x45, 0xA3, 0x1A, 0x91, 0x11, 0x00, 0x09, 0x9A, 0xA9, 0xA2, 0x93, 0x9F, 0x49, 0xE9, 0xFB, 0xEA, 0x64, 0x48, 0x7B, 0xDF, 0x68, 0xA5, 0x23, 0x70, 0x32, 0x92, 0xD6, 0xA0 }, }, { { 0xFE, 0x42, 0x1B, 0x24, 0x4E, 0x0E, 0x81, 0x6D, 0x9F, 0x26, 0xB3, 0x52, 0xC8, 0x31, 0xD9, 0x30, 0xE1, 0xC1, 0xC5, 0xD2, 0xFA, 0x4E, 0x0A, 0x1C, 0x77, 0x96, 0xA1, 0xF2, 0x02, 0x0E, 0xF1, 0x67 }, }, { { 0xFE, 0x4F, 0x35, 0x6C, 0x7F, 0x9B, 0xFC, 0x17, 0xFF, 0xCB, 0x68, 0xD0, 0x76, 0x4E, 0xCB, 0x2A, 0x87, 0xCA, 0xA0, 0xAE, 0x4C, 0xB5, 0x66, 0x62, 0x21, 0x04, 0xD3, 0x6F, 0xFB, 0x52, 0xCB, 0x29 }, }, { { 0xFF, 0x82, 0x6E, 0x2D, 0x0C, 0xB7, 0x71, 0x68, 0x68, 0x67, 0x5A, 0xE4, 0xB4, 0x31, 0xB6, 0x37, 0x1E, 0x9F, 0x0C, 0xDF, 0xCC, 0xB4, 0x9D, 0x43, 0xBA, 0x30, 0x49, 0xBF, 0xDD, 0x2C, 0x41, 0xB1 }, }, { { 0xFF, 0xDC, 0x6B, 0x85, 0xFE, 0x7B, 0x10, 0x83, 0xB5, 0x41, 0x6F, 0x80, 0x6F, 0xC2, 0x44, 0xB9, 0xE4, 0xDF, 0x42, 0x99, 0xFB, 0xE3, 0xF6, 0x81, 0xAF, 0x3F, 0x5C, 0xF4, 0x22, 0x5A, 0x8E, 0xAF }, }, }; node-v4.8.2/src/debug-agent.cc000644 000766 000024 00000021106 13070706736 016241 0ustar00iojsstaff000000 000000 // Copyright Fedor Indutny and other Node contributors. // // Permission is hereby granted, free of charge, to any person obtaining a // copy of this software and associated documentation files (the // "Software"), to deal in the Software without restriction, including // without limitation the rights to use, copy, modify, merge, publish, // distribute, sublicense, and/or sell copies of the Software, and to permit // persons to whom the Software is furnished to do so, subject to the // following conditions: // // The above copyright notice and this permission notice shall be included // in all copies or substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN // NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, // DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR // OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE // USE OR OTHER DEALINGS IN THE SOFTWARE. #include "debug-agent.h" #include "node.h" #include "node_internals.h" // arraysize #include "env.h" #include "env-inl.h" #include "v8.h" #include "v8-debug.h" #include "util.h" #include "util-inl.h" #include namespace node { namespace debugger { using v8::Context; using v8::Function; using v8::FunctionCallbackInfo; using v8::FunctionTemplate; using v8::HandleScope; using v8::Integer; using v8::Isolate; using v8::Local; using v8::Locker; using v8::NewStringType; using v8::Object; using v8::String; using v8::Value; Agent::Agent(Environment* env) : state_(kNone), port_(5858), wait_(false), parent_env_(env), child_env_(nullptr), dispatch_handler_(nullptr) { CHECK_EQ(0, uv_sem_init(&start_sem_, 0)); } Agent::~Agent() { Stop(); uv_sem_destroy(&start_sem_); while (AgentMessage* msg = messages_.PopFront()) delete msg; } bool Agent::Start(const std::string& host, int port, bool wait) { int err; if (state_ == kRunning) return false; err = uv_loop_init(&child_loop_); if (err != 0) goto loop_init_failed; // Interruption signal handler err = uv_async_init(&child_loop_, &child_signal_, ChildSignalCb); if (err != 0) goto async_init_failed; uv_unref(reinterpret_cast(&child_signal_)); host_ = host; port_ = port; wait_ = wait; err = uv_thread_create(&thread_, reinterpret_cast(ThreadCb), this); if (err != 0) goto thread_create_failed; uv_sem_wait(&start_sem_); state_ = kRunning; return true; thread_create_failed: uv_close(reinterpret_cast(&child_signal_), nullptr); async_init_failed: err = uv_loop_close(&child_loop_); CHECK_EQ(err, 0); loop_init_failed: return false; } void Agent::Enable() { v8::Debug::SetMessageHandler(MessageHandler); // Assign environment to the debugger's context // NOTE: The debugger context is created after `SetMessageHandler()` call parent_env()->AssignToContext(v8::Debug::GetDebugContext()); } void Agent::Stop() { int err; if (state_ != kRunning) { return; } v8::Debug::SetMessageHandler(nullptr); // Send empty message to terminate things EnqueueMessage(new AgentMessage(nullptr, 0)); // Signal worker thread to make it stop err = uv_async_send(&child_signal_); CHECK_EQ(err, 0); err = uv_thread_join(&thread_); CHECK_EQ(err, 0); uv_close(reinterpret_cast(&child_signal_), nullptr); uv_run(&child_loop_, UV_RUN_NOWAIT); err = uv_loop_close(&child_loop_); CHECK_EQ(err, 0); state_ = kNone; } void Agent::WorkerRun() { static const char* argv[] = { "node", "--debug-agent" }; Isolate::CreateParams params; ArrayBufferAllocator array_buffer_allocator; params.array_buffer_allocator = &array_buffer_allocator; Isolate* isolate = Isolate::New(params); { Locker locker(isolate); Isolate::Scope isolate_scope(isolate); HandleScope handle_scope(isolate); Local context = Context::New(isolate); Context::Scope context_scope(context); Environment* env = CreateEnvironment( isolate, &child_loop_, context, arraysize(argv), argv, arraysize(argv), argv); child_env_ = env; // Expose API InitAdaptor(env); LoadEnvironment(env); CHECK_EQ(&child_loop_, env->event_loop()); uv_run(&child_loop_, UV_RUN_DEFAULT); // Clean-up peristent api_.Reset(); // Clean-up all running handles env->CleanupHandles(); env->Dispose(); env = nullptr; } isolate->Dispose(); } void Agent::InitAdaptor(Environment* env) { Isolate* isolate = env->isolate(); HandleScope scope(isolate); // Create API adaptor Local t = FunctionTemplate::New(isolate); t->InstanceTemplate()->SetInternalFieldCount(1); t->SetClassName(String::NewFromUtf8(isolate, "DebugAPI")); NODE_SET_PROTOTYPE_METHOD(t, "notifyListen", NotifyListen); NODE_SET_PROTOTYPE_METHOD(t, "notifyWait", NotifyWait); NODE_SET_PROTOTYPE_METHOD(t, "sendCommand", SendCommand); Local api = t->GetFunction()->NewInstance(); api->SetAlignedPointerInInternalField(0, this); api->Set(String::NewFromUtf8(isolate, "host", NewStringType::kNormal).ToLocalChecked(), String::NewFromUtf8(isolate, host_.data(), NewStringType::kNormal, host_.size()).ToLocalChecked()); api->Set(String::NewFromUtf8(isolate, "port"), Integer::New(isolate, port_)); env->process_object()->Set(String::NewFromUtf8(isolate, "_debugAPI"), api); api_.Reset(env->isolate(), api); } Agent* Agent::Unwrap(const v8::FunctionCallbackInfo& args) { void* ptr = args.Holder()->GetAlignedPointerFromInternalField(0); return reinterpret_cast(ptr); } void Agent::NotifyListen(const FunctionCallbackInfo& args) { Agent* a = Unwrap(args); // Notify other thread that we are ready to process events uv_sem_post(&a->start_sem_); } void Agent::NotifyWait(const FunctionCallbackInfo& args) { Agent* a = Unwrap(args); a->wait_ = false; int err = uv_async_send(&a->child_signal_); CHECK_EQ(err, 0); } void Agent::SendCommand(const FunctionCallbackInfo& args) { Agent* a = Unwrap(args); Environment* env = a->child_env(); HandleScope scope(env->isolate()); String::Value v(args[0]); v8::Debug::SendCommand(a->parent_env()->isolate(), *v, v.length()); if (a->dispatch_handler_ != nullptr) a->dispatch_handler_(a->parent_env()); } void Agent::ThreadCb(Agent* agent) { agent->WorkerRun(); } void Agent::ChildSignalCb(uv_async_t* signal) { Agent* a = ContainerOf(&Agent::child_signal_, signal); Isolate* isolate = a->child_env()->isolate(); HandleScope scope(isolate); Local api = PersistentToLocal(isolate, a->api_); Mutex::ScopedLock scoped_lock(a->message_mutex_); while (AgentMessage* msg = a->messages_.PopFront()) { // Time to close everything if (msg->data() == nullptr) { delete msg; MakeCallback(isolate, api, "onclose", 0, nullptr); break; } // Waiting for client, do not send anything just yet if (a->wait_) { a->messages_.PushFront(msg); // Push message back into the ready queue. break; } Local argv[] = { String::NewFromTwoByte(isolate, msg->data(), String::kNormalString, msg->length()) }; // Emit message MakeCallback(isolate, api, "onmessage", arraysize(argv), argv); delete msg; } } void Agent::EnqueueMessage(AgentMessage* message) { Mutex::ScopedLock scoped_lock(message_mutex_); messages_.PushBack(message); uv_async_send(&child_signal_); } void Agent::MessageHandler(const v8::Debug::Message& message) { Isolate* isolate = message.GetIsolate(); Environment* env = Environment::GetCurrent(isolate); if (env == nullptr) return; // Called from a non-node context. Agent* a = env->debugger_agent(); CHECK_NE(a, nullptr); CHECK_EQ(isolate, a->parent_env()->isolate()); HandleScope scope(isolate); Local json = message.GetJSON(); String::Value v(json); AgentMessage* msg = new AgentMessage(*v, v.length()); a->EnqueueMessage(msg); } } // namespace debugger } // namespace node node-v4.8.2/src/debug-agent.h000644 000766 000024 00000007263 13070706736 016113 0ustar00iojsstaff000000 000000 // Copyright Fedor Indutny and other Node contributors. // // Permission is hereby granted, free of charge, to any person obtaining a // copy of this software and associated documentation files (the // "Software"), to deal in the Software without restriction, including // without limitation the rights to use, copy, modify, merge, publish, // distribute, sublicense, and/or sell copies of the Software, and to permit // persons to whom the Software is furnished to do so, subject to the // following conditions: // // The above copyright notice and this permission notice shall be included // in all copies or substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN // NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, // DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR // OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE // USE OR OTHER DEALINGS IN THE SOFTWARE. #ifndef SRC_DEBUG_AGENT_H_ #define SRC_DEBUG_AGENT_H_ #include "node_mutex.h" #include "util.h" #include "util-inl.h" #include "uv.h" #include "v8.h" #include "v8-debug.h" #include #include // Forward declaration to break recursive dependency chain with src/env.h. namespace node { class Environment; } // namespace node namespace node { namespace debugger { class AgentMessage { public: AgentMessage(uint16_t* val, int length) : length_(length) { if (val == nullptr) { data_ = val; } else { data_ = new uint16_t[length]; memcpy(data_, val, length * sizeof(*data_)); } } ~AgentMessage() { delete[] data_; data_ = nullptr; } inline const uint16_t* data() const { return data_; } inline int length() const { return length_; } ListNode member; private: uint16_t* data_; int length_; }; class Agent { public: explicit Agent(node::Environment* env); ~Agent(); typedef void (*DispatchHandler)(node::Environment* env); // Start the debugger agent thread bool Start(const std::string& host, int port, bool wait); // Listen for debug events void Enable(); // Stop the debugger agent void Stop(); inline void set_dispatch_handler(DispatchHandler handler) { dispatch_handler_ = handler; } inline node::Environment* parent_env() const { return parent_env_; } inline node::Environment* child_env() const { return child_env_; } protected: void InitAdaptor(Environment* env); // Worker body void WorkerRun(); static void ThreadCb(Agent* agent); static void ParentSignalCb(uv_async_t* signal); static void ChildSignalCb(uv_async_t* signal); static void MessageHandler(const v8::Debug::Message& message); // V8 API static Agent* Unwrap(const v8::FunctionCallbackInfo& args); static void NotifyListen(const v8::FunctionCallbackInfo& args); static void NotifyWait(const v8::FunctionCallbackInfo& args); static void SendCommand(const v8::FunctionCallbackInfo& args); void EnqueueMessage(AgentMessage* message); enum State { kNone, kRunning }; State state_; std::string host_; int port_; bool wait_; uv_sem_t start_sem_; node::Mutex message_mutex_; uv_async_t child_signal_; uv_thread_t thread_; node::Environment* parent_env_; node::Environment* child_env_; uv_loop_t child_loop_; v8::Persistent api_; ListHead messages_; DispatchHandler dispatch_handler_; }; } // namespace debugger } // namespace node #endif // SRC_DEBUG_AGENT_H_ node-v4.8.2/src/env-inl.h000644 000766 000024 00000044351 13070706736 015300 0ustar00iojsstaff000000 000000 #ifndef SRC_ENV_INL_H_ #define SRC_ENV_INL_H_ #include "env.h" #include "node.h" #include "util.h" #include "util-inl.h" #include "uv.h" #include "v8.h" #include #include namespace node { inline Environment::IsolateData* Environment::IsolateData::Get( v8::Isolate* isolate) { return static_cast(isolate->GetData(kIsolateSlot)); } inline Environment::IsolateData* Environment::IsolateData::GetOrCreate( v8::Isolate* isolate, uv_loop_t* loop) { IsolateData* isolate_data = Get(isolate); if (isolate_data == nullptr) { isolate_data = new IsolateData(isolate, loop); isolate->SetData(kIsolateSlot, isolate_data); } isolate_data->ref_count_ += 1; return isolate_data; } inline void Environment::IsolateData::Put() { if (--ref_count_ == 0) { isolate()->SetData(kIsolateSlot, nullptr); delete this; } } // Create string properties as internalized one byte strings. // // Internalized because it makes property lookups a little faster and because // the string is created in the old space straight away. It's going to end up // in the old space sooner or later anyway but now it doesn't go through // v8::Eternal's new space handling first. // // One byte because our strings are ASCII and we can safely skip V8's UTF-8 // decoding step. It's a one-time cost, but why pay it when you don't have to? inline Environment::IsolateData::IsolateData(v8::Isolate* isolate, uv_loop_t* loop) : event_loop_(loop), isolate_(isolate), #define V(PropertyName, StringValue) \ PropertyName ## _(isolate, \ v8::String::NewFromOneByte( \ isolate, \ reinterpret_cast(StringValue), \ v8::NewStringType::kInternalized, \ sizeof(StringValue) - 1).ToLocalChecked()), PER_ISOLATE_STRING_PROPERTIES(V) #undef V ref_count_(0) {} inline uv_loop_t* Environment::IsolateData::event_loop() const { return event_loop_; } inline v8::Isolate* Environment::IsolateData::isolate() const { return isolate_; } inline Environment::AsyncHooks::AsyncHooks() { for (int i = 0; i < kFieldsCount; i++) fields_[i] = 0; } inline uint32_t* Environment::AsyncHooks::fields() { return fields_; } inline int Environment::AsyncHooks::fields_count() const { return kFieldsCount; } inline bool Environment::AsyncHooks::callbacks_enabled() { return fields_[kEnableCallbacks] != 0; } inline void Environment::AsyncHooks::set_enable_callbacks(uint32_t flag) { fields_[kEnableCallbacks] = flag; } inline Environment::AsyncCallbackScope::AsyncCallbackScope(Environment* env) : env_(env) { env_->makecallback_cntr_++; } inline Environment::AsyncCallbackScope::~AsyncCallbackScope() { env_->makecallback_cntr_--; } inline bool Environment::AsyncCallbackScope::in_makecallback() { return env_->makecallback_cntr_ > 1; } inline Environment::DomainFlag::DomainFlag() { for (int i = 0; i < kFieldsCount; ++i) fields_[i] = 0; } inline uint32_t* Environment::DomainFlag::fields() { return fields_; } inline int Environment::DomainFlag::fields_count() const { return kFieldsCount; } inline uint32_t Environment::DomainFlag::count() const { return fields_[kCount]; } inline Environment::TickInfo::TickInfo() { for (int i = 0; i < kFieldsCount; ++i) fields_[i] = 0; } inline uint32_t* Environment::TickInfo::fields() { return fields_; } inline int Environment::TickInfo::fields_count() const { return kFieldsCount; } inline uint32_t Environment::TickInfo::index() const { return fields_[kIndex]; } inline uint32_t Environment::TickInfo::length() const { return fields_[kLength]; } inline void Environment::TickInfo::set_index(uint32_t value) { fields_[kIndex] = value; } inline Environment::ArrayBufferAllocatorInfo::ArrayBufferAllocatorInfo() { for (int i = 0; i < kFieldsCount; ++i) fields_[i] = 0; } inline uint32_t* Environment::ArrayBufferAllocatorInfo::fields() { return fields_; } inline int Environment::ArrayBufferAllocatorInfo::fields_count() const { return kFieldsCount; } inline bool Environment::ArrayBufferAllocatorInfo::no_zero_fill() const { return fields_[kNoZeroFill] != 0; } inline void Environment::ArrayBufferAllocatorInfo::reset_fill_flag() { fields_[kNoZeroFill] = 0; } inline Environment* Environment::New(v8::Local context, uv_loop_t* loop) { Environment* env = new Environment(context, loop); env->AssignToContext(context); return env; } inline void Environment::AssignToContext(v8::Local context) { context->SetAlignedPointerInEmbedderData(kContextEmbedderDataIndex, this); } inline Environment* Environment::GetCurrent(v8::Isolate* isolate) { return GetCurrent(isolate->GetCurrentContext()); } inline Environment* Environment::GetCurrent(v8::Local context) { return static_cast( context->GetAlignedPointerFromEmbedderData(kContextEmbedderDataIndex)); } inline Environment* Environment::GetCurrent( const v8::FunctionCallbackInfo& info) { ASSERT(info.Data()->IsExternal()); return static_cast(info.Data().As()->Value()); } template inline Environment* Environment::GetCurrent( const v8::PropertyCallbackInfo& info) { ASSERT(info.Data()->IsExternal()); // XXX(bnoordhuis) Work around a g++ 4.9.2 template type inferrer bug // when the expression is written as info.Data().As(). v8::Local data = info.Data(); return static_cast(data.As()->Value()); } inline Environment::Environment(v8::Local context, uv_loop_t* loop) : isolate_(context->GetIsolate()), isolate_data_(IsolateData::GetOrCreate(context->GetIsolate(), loop)), timer_base_(uv_now(loop)), using_domains_(false), printed_error_(false), trace_sync_io_(false), makecallback_cntr_(0), async_wrap_uid_(0), debugger_agent_(this), http_parser_buffer_(nullptr), context_(context->GetIsolate(), context) { // We'll be creating new objects so make sure we've entered the context. v8::HandleScope handle_scope(isolate()); v8::Context::Scope context_scope(context); set_as_external(v8::External::New(isolate(), this)); set_binding_cache_object(v8::Object::New(isolate())); set_module_load_list_array(v8::Array::New(isolate())); v8::Local fn = v8::FunctionTemplate::New(isolate()); fn->SetClassName(FIXED_ONE_BYTE_STRING(isolate(), "InternalFieldObject")); v8::Local obj = fn->InstanceTemplate(); obj->SetInternalFieldCount(1); set_generic_internal_field_template(obj); RB_INIT(&cares_task_list_); handle_cleanup_waiting_ = 0; destroy_ids_list_.reserve(512); } inline Environment::~Environment() { v8::HandleScope handle_scope(isolate()); context()->SetAlignedPointerInEmbedderData(kContextEmbedderDataIndex, nullptr); #define V(PropertyName, TypeName) PropertyName ## _.Reset(); ENVIRONMENT_STRONG_PERSISTENT_PROPERTIES(V) #undef V isolate_data()->Put(); delete[] heap_statistics_buffer_; delete[] heap_space_statistics_buffer_; delete[] http_parser_buffer_; } inline void Environment::CleanupHandles() { while (HandleCleanup* hc = handle_cleanup_queue_.PopFront()) { handle_cleanup_waiting_++; hc->cb_(this, hc->handle_, hc->arg_); delete hc; } while (handle_cleanup_waiting_ != 0) uv_run(event_loop(), UV_RUN_ONCE); } inline void Environment::Dispose() { delete this; } inline v8::Isolate* Environment::isolate() const { return isolate_; } inline bool Environment::async_wrap_callbacks_enabled() const { // The const_cast is okay, it doesn't violate conceptual const-ness. return const_cast(this)->async_hooks()->callbacks_enabled(); } inline bool Environment::in_domain() const { // The const_cast is okay, it doesn't violate conceptual const-ness. return using_domains() && const_cast(this)->domain_flag()->count() > 0; } inline Environment* Environment::from_immediate_check_handle( uv_check_t* handle) { return ContainerOf(&Environment::immediate_check_handle_, handle); } inline uv_check_t* Environment::immediate_check_handle() { return &immediate_check_handle_; } inline uv_idle_t* Environment::immediate_idle_handle() { return &immediate_idle_handle_; } inline Environment* Environment::from_destroy_ids_idle_handle( uv_idle_t* handle) { return ContainerOf(&Environment::destroy_ids_idle_handle_, handle); } inline uv_idle_t* Environment::destroy_ids_idle_handle() { return &destroy_ids_idle_handle_; } inline Environment* Environment::from_idle_prepare_handle( uv_prepare_t* handle) { return ContainerOf(&Environment::idle_prepare_handle_, handle); } inline uv_prepare_t* Environment::idle_prepare_handle() { return &idle_prepare_handle_; } inline Environment* Environment::from_idle_check_handle(uv_check_t* handle) { return ContainerOf(&Environment::idle_check_handle_, handle); } inline uv_check_t* Environment::idle_check_handle() { return &idle_check_handle_; } inline void Environment::RegisterHandleCleanup(uv_handle_t* handle, HandleCleanupCb cb, void *arg) { handle_cleanup_queue_.PushBack(new HandleCleanup(handle, cb, arg)); } inline void Environment::FinishHandleCleanup(uv_handle_t* handle) { handle_cleanup_waiting_--; } inline uv_loop_t* Environment::event_loop() const { return isolate_data()->event_loop(); } inline Environment::AsyncHooks* Environment::async_hooks() { return &async_hooks_; } inline Environment::DomainFlag* Environment::domain_flag() { return &domain_flag_; } inline Environment::TickInfo* Environment::tick_info() { return &tick_info_; } inline Environment::ArrayBufferAllocatorInfo* Environment::array_buffer_allocator_info() { return &array_buffer_allocator_info_; } inline uint64_t Environment::timer_base() const { return timer_base_; } inline bool Environment::using_domains() const { return using_domains_; } inline void Environment::set_using_domains(bool value) { using_domains_ = value; } inline bool Environment::printed_error() const { return printed_error_; } inline void Environment::set_printed_error(bool value) { printed_error_ = value; } inline void Environment::set_trace_sync_io(bool value) { trace_sync_io_ = value; } inline int64_t Environment::get_async_wrap_uid() { return ++async_wrap_uid_; } inline std::vector* Environment::destroy_ids_list() { return &destroy_ids_list_; } inline double* Environment::heap_statistics_buffer() const { CHECK_NE(heap_statistics_buffer_, nullptr); return heap_statistics_buffer_; } inline void Environment::set_heap_statistics_buffer(double* pointer) { CHECK_EQ(heap_statistics_buffer_, nullptr); // Should be set only once. heap_statistics_buffer_ = pointer; } inline double* Environment::heap_space_statistics_buffer() const { CHECK_NE(heap_space_statistics_buffer_, nullptr); return heap_space_statistics_buffer_; } inline void Environment::set_heap_space_statistics_buffer(double* pointer) { CHECK_EQ(heap_space_statistics_buffer_, nullptr); // Should be set only once. heap_space_statistics_buffer_ = pointer; } inline char* Environment::http_parser_buffer() const { return http_parser_buffer_; } inline void Environment::set_http_parser_buffer(char* buffer) { CHECK_EQ(http_parser_buffer_, nullptr); // Should be set only once. http_parser_buffer_ = buffer; } inline Environment* Environment::from_cares_timer_handle(uv_timer_t* handle) { return ContainerOf(&Environment::cares_timer_handle_, handle); } inline uv_timer_t* Environment::cares_timer_handle() { return &cares_timer_handle_; } inline ares_channel Environment::cares_channel() { return cares_channel_; } // Only used in the call to ares_init_options(). inline ares_channel* Environment::cares_channel_ptr() { return &cares_channel_; } inline node_ares_task_list* Environment::cares_task_list() { return &cares_task_list_; } inline Environment::IsolateData* Environment::isolate_data() const { return isolate_data_; } // this would have been a template function were it not for the fact that g++ // sometimes fails to resolve it... #define THROW_ERROR(fun) \ do { \ v8::HandleScope scope(isolate); \ isolate->ThrowException(fun(OneByteString(isolate, errmsg))); \ } \ while (0) inline void Environment::ThrowError(v8::Isolate* isolate, const char* errmsg) { THROW_ERROR(v8::Exception::Error); } inline void Environment::ThrowTypeError(v8::Isolate* isolate, const char* errmsg) { THROW_ERROR(v8::Exception::TypeError); } inline void Environment::ThrowRangeError(v8::Isolate* isolate, const char* errmsg) { THROW_ERROR(v8::Exception::RangeError); } inline void Environment::ThrowError(const char* errmsg) { ThrowError(isolate(), errmsg); } inline void Environment::ThrowTypeError(const char* errmsg) { ThrowTypeError(isolate(), errmsg); } inline void Environment::ThrowRangeError(const char* errmsg) { ThrowRangeError(isolate(), errmsg); } inline void Environment::ThrowErrnoException(int errorno, const char* syscall, const char* message, const char* path) { isolate()->ThrowException( ErrnoException(isolate(), errorno, syscall, message, path)); } inline void Environment::ThrowUVException(int errorno, const char* syscall, const char* message, const char* path, const char* dest) { isolate()->ThrowException( UVException(isolate(), errorno, syscall, message, path, dest)); } inline v8::Local Environment::NewFunctionTemplate(v8::FunctionCallback callback, v8::Local signature) { v8::Local external = as_external(); return v8::FunctionTemplate::New(isolate(), callback, external, signature); } inline void Environment::SetMethod(v8::Local that, const char* name, v8::FunctionCallback callback) { v8::Local function = NewFunctionTemplate(callback)->GetFunction(); // kInternalized strings are created in the old space. const v8::NewStringType type = v8::NewStringType::kInternalized; v8::Local name_string = v8::String::NewFromUtf8(isolate(), name, type).ToLocalChecked(); that->Set(name_string, function); function->SetName(name_string); // NODE_SET_METHOD() compatibility. } inline void Environment::SetProtoMethod(v8::Local that, const char* name, v8::FunctionCallback callback) { v8::Local signature = v8::Signature::New(isolate(), that); v8::Local function = NewFunctionTemplate(callback, signature)->GetFunction(); // kInternalized strings are created in the old space. const v8::NewStringType type = v8::NewStringType::kInternalized; v8::Local name_string = v8::String::NewFromUtf8(isolate(), name, type).ToLocalChecked(); that->PrototypeTemplate()->Set(name_string, function); function->SetName(name_string); // NODE_SET_PROTOTYPE_METHOD() compatibility. } inline void Environment::SetTemplateMethod(v8::Local that, const char* name, v8::FunctionCallback callback) { v8::Local function = NewFunctionTemplate(callback)->GetFunction(); // kInternalized strings are created in the old space. const v8::NewStringType type = v8::NewStringType::kInternalized; v8::Local name_string = v8::String::NewFromUtf8(isolate(), name, type).ToLocalChecked(); that->Set(name_string, function); function->SetName(name_string); // NODE_SET_METHOD() compatibility. } inline v8::Local Environment::NewInternalFieldObject() { v8::MaybeLocal m_obj = generic_internal_field_template()->NewInstance(context()); return m_obj.ToLocalChecked(); } #define V(PropertyName, StringValue) \ inline \ v8::Local Environment::IsolateData::PropertyName() const { \ /* Strings are immutable so casting away const-ness here is okay. */ \ return const_cast(this)->PropertyName ## _.Get(isolate()); \ } PER_ISOLATE_STRING_PROPERTIES(V) #undef V #define V(PropertyName, StringValue) \ inline v8::Local Environment::PropertyName() const { \ return isolate_data()->PropertyName(); \ } PER_ISOLATE_STRING_PROPERTIES(V) #undef V #define V(PropertyName, TypeName) \ inline v8::Local Environment::PropertyName() const { \ return StrongPersistentToLocal(PropertyName ## _); \ } \ inline void Environment::set_ ## PropertyName(v8::Local value) { \ PropertyName ## _.Reset(isolate(), value); \ } ENVIRONMENT_STRONG_PERSISTENT_PROPERTIES(V) #undef V #undef ENVIRONMENT_STRONG_PERSISTENT_PROPERTIES #undef PER_ISOLATE_STRING_PROPERTIES } // namespace node #endif // SRC_ENV_INL_H_ node-v4.8.2/src/env.cc000644 000766 000024 00000003101 13070706736 014642 0ustar00iojsstaff000000 000000 #include "env.h" #include "env-inl.h" #include "v8.h" #include namespace node { using v8::HandleScope; using v8::Local; using v8::Message; using v8::StackFrame; using v8::StackTrace; using v8::TryCatch; using v8::Value; void Environment::PrintSyncTrace() const { if (!trace_sync_io_) return; HandleScope handle_scope(isolate()); Local stack = StackTrace::CurrentStackTrace(isolate(), 10, StackTrace::kDetailed); fprintf(stderr, "WARNING: Detected use of sync API\n"); for (int i = 0; i < stack->GetFrameCount() - 1; i++) { Local stack_frame = stack->GetFrame(i); node::Utf8Value fn_name_s(isolate(), stack_frame->GetFunctionName()); node::Utf8Value script_name(isolate(), stack_frame->GetScriptName()); const int line_number = stack_frame->GetLineNumber(); const int column = stack_frame->GetColumn(); if (stack_frame->IsEval()) { if (stack_frame->GetScriptId() == Message::kNoScriptIdInfo) { fprintf(stderr, " at [eval]:%i:%i\n", line_number, column); } else { fprintf(stderr, " at [eval] (%s:%i:%i)\n", *script_name, line_number, column); } break; } if (fn_name_s.length() == 0) { fprintf(stderr, " at %s:%i:%i\n", *script_name, line_number, column); } else { fprintf(stderr, " at %s (%s:%i:%i)\n", *fn_name_s, *script_name, line_number, column); } } fflush(stderr); } } // namespace node node-v4.8.2/src/env.h000644 000766 000024 00000072715 13070706736 014525 0ustar00iojsstaff000000 000000 #ifndef SRC_ENV_H_ #define SRC_ENV_H_ #include "ares.h" #include "debug-agent.h" #include "handle_wrap.h" #include "req-wrap.h" #include "tree.h" #include "util.h" #include "uv.h" #include "v8.h" #include #include // Caveat emptor: we're going slightly crazy with macros here but the end // hopefully justifies the means. We have a lot of per-context properties // and adding and maintaining their getters and setters by hand would be // a nightmare so let's make the preprocessor generate them for us. // // Make sure that any macros defined here are undefined again at the bottom // of context-inl.h. The exceptions are NODE_CONTEXT_EMBEDDER_DATA_INDEX // and NODE_ISOLATE_SLOT, they may have been defined externally. namespace node { // Pick an index that's hopefully out of the way when we're embedded inside // another application. Performance-wise or memory-wise it doesn't matter: // Context::SetAlignedPointerInEmbedderData() is backed by a FixedArray, // worst case we pay a one-time penalty for resizing the array. #ifndef NODE_CONTEXT_EMBEDDER_DATA_INDEX #define NODE_CONTEXT_EMBEDDER_DATA_INDEX 32 #endif // The slot 0 and 1 had already been taken by "gin" and "blink" in Chrome, // and the size of isolate's slots is 4 by default, so using 3 should // hopefully make node work independently when embedded into other // application. #ifndef NODE_ISOLATE_SLOT #define NODE_ISOLATE_SLOT 3 #endif // Strings are per-isolate primitives but Environment proxies them // for the sake of convenience. Strings should be ASCII-only. #define PER_ISOLATE_STRING_PROPERTIES(V) \ V(address_string, "address") \ V(alpn_buffer_string, "alpnBuffer") \ V(args_string, "args") \ V(argv_string, "argv") \ V(arrow_message_string, "arrowMessage") \ V(async, "async") \ V(async_queue_string, "_asyncQueue") \ V(atime_string, "atime") \ V(birthtime_string, "birthtime") \ V(blksize_string, "blksize") \ V(blocks_string, "blocks") \ V(buffer_string, "buffer") \ V(bytes_string, "bytes") \ V(bytes_parsed_string, "bytesParsed") \ V(bytes_read_string, "bytesRead") \ V(callback_string, "callback") \ V(change_string, "change") \ V(oncertcb_string, "oncertcb") \ V(onclose_string, "_onclose") \ V(code_string, "code") \ V(compare_string, "compare") \ V(ctime_string, "ctime") \ V(cwd_string, "cwd") \ V(debug_port_string, "debugPort") \ V(debug_string, "debug") \ V(dest_string, "dest") \ V(detached_string, "detached") \ V(dev_string, "dev") \ V(disposed_string, "_disposed") \ V(domain_string, "domain") \ V(emitting_top_level_domain_error_string, "_emittingTopLevelDomainError") \ V(exchange_string, "exchange") \ V(idle_string, "idle") \ V(irq_string, "irq") \ V(enter_string, "enter") \ V(env_pairs_string, "envPairs") \ V(env_string, "env") \ V(errno_string, "errno") \ V(error_string, "error") \ V(events_string, "_events") \ V(exec_argv_string, "execArgv") \ V(exec_path_string, "execPath") \ V(exiting_string, "_exiting") \ V(exit_code_string, "exitCode") \ V(exit_string, "exit") \ V(expire_string, "expire") \ V(exponent_string, "exponent") \ V(exports_string, "exports") \ V(ext_key_usage_string, "ext_key_usage") \ V(external_string, "external") \ V(external_stream_string, "_externalStream") \ V(family_string, "family") \ V(fatal_exception_string, "_fatalException") \ V(fd_string, "fd") \ V(file_string, "file") \ V(fingerprint_string, "fingerprint") \ V(flags_string, "flags") \ V(fsevent_string, "FSEvent") \ V(gid_string, "gid") \ V(handle_string, "handle") \ V(heap_total_string, "heapTotal") \ V(heap_used_string, "heapUsed") \ V(hostmaster_string, "hostmaster") \ V(ignore_string, "ignore") \ V(immediate_callback_string, "_immediateCallback") \ V(infoaccess_string, "infoAccess") \ V(inherit_string, "inherit") \ V(ino_string, "ino") \ V(input_string, "input") \ V(internal_string, "internal") \ V(ipv4_string, "IPv4") \ V(ipv6_lc_string, "ipv6") \ V(ipv6_string, "IPv6") \ V(isalive_string, "isAlive") \ V(isclosing_string, "isClosing") \ V(issuer_string, "issuer") \ V(issuercert_string, "issuerCertificate") \ V(kill_signal_string, "killSignal") \ V(mac_string, "mac") \ V(mark_sweep_compact_string, "mark-sweep-compact") \ V(max_buffer_string, "maxBuffer") \ V(message_string, "message") \ V(minttl_string, "minttl") \ V(mode_string, "mode") \ V(model_string, "model") \ V(modulus_string, "modulus") \ V(mtime_string, "mtime") \ V(name_string, "name") \ V(need_imm_cb_string, "_needImmediateCallback") \ V(netmask_string, "netmask") \ V(nice_string, "nice") \ V(nlink_string, "nlink") \ V(npn_buffer_string, "npnBuffer") \ V(nsname_string, "nsname") \ V(ocsp_request_string, "OCSPRequest") \ V(offset_string, "offset") \ V(onchange_string, "onchange") \ V(onclienthello_string, "onclienthello") \ V(oncomplete_string, "oncomplete") \ V(onconnection_string, "onconnection") \ V(ondone_string, "ondone") \ V(onerror_string, "onerror") \ V(onexit_string, "onexit") \ V(onhandshakedone_string, "onhandshakedone") \ V(onhandshakestart_string, "onhandshakestart") \ V(onmessage_string, "onmessage") \ V(onnewsession_string, "onnewsession") \ V(onnewsessiondone_string, "onnewsessiondone") \ V(onocspresponse_string, "onocspresponse") \ V(onread_string, "onread") \ V(onreadstart_string, "onreadstart") \ V(onreadstop_string, "onreadstop") \ V(onselect_string, "onselect") \ V(onshutdown_string, "onshutdown") \ V(onsignal_string, "onsignal") \ V(onstop_string, "onstop") \ V(onwrite_string, "onwrite") \ V(output_string, "output") \ V(order_string, "order") \ V(owner_string, "owner") \ V(parse_error_string, "Parse Error") \ V(path_string, "path") \ V(pbkdf2_error_string, "PBKDF2 Error") \ V(pid_string, "pid") \ V(pipe_string, "pipe") \ V(port_string, "port") \ V(preference_string, "preference") \ V(priority_string, "priority") \ V(processed_string, "processed") \ V(prototype_string, "prototype") \ V(raw_string, "raw") \ V(rdev_string, "rdev") \ V(readable_string, "readable") \ V(received_shutdown_string, "receivedShutdown") \ V(refresh_string, "refresh") \ V(regexp_string, "regexp") \ V(rename_string, "rename") \ V(replacement_string, "replacement") \ V(retry_string, "retry") \ V(rss_string, "rss") \ V(serial_string, "serial") \ V(scavenge_string, "scavenge") \ V(scopeid_string, "scopeid") \ V(selected_npn_buffer_string, "selectedNpnBuffer") \ V(sent_shutdown_string, "sentShutdown") \ V(serial_number_string, "serialNumber") \ V(service_string, "service") \ V(servername_string, "servername") \ V(session_id_string, "sessionId") \ V(signal_string, "signal") \ V(size_string, "size") \ V(sni_context_err_string, "Invalid SNI context") \ V(sni_context_string, "sni_context") \ V(speed_string, "speed") \ V(stack_string, "stack") \ V(status_string, "status") \ V(stdio_string, "stdio") \ V(subject_string, "subject") \ V(subjectaltname_string, "subjectaltname") \ V(sys_string, "sys") \ V(syscall_string, "syscall") \ V(tick_callback_string, "_tickCallback") \ V(tick_domain_cb_string, "_tickDomainCallback") \ V(ticketkeycallback_string, "onticketkeycallback") \ V(timeout_string, "timeout") \ V(times_string, "times") \ V(timestamp_string, "timestamp") \ V(title_string, "title") \ V(tls_npn_string, "tls_npn") \ V(tls_alpn_string, "tls_alpn") \ V(tls_ocsp_string, "tls_ocsp") \ V(tls_sni_string, "tls_sni") \ V(tls_string, "tls") \ V(tls_ticket_string, "tlsTicket") \ V(type_string, "type") \ V(uid_string, "uid") \ V(unknown_string, "") \ V(user_string, "user") \ V(uv_string, "uv") \ V(valid_from_string, "valid_from") \ V(valid_to_string, "valid_to") \ V(verify_error_string, "verifyError") \ V(version_string, "version") \ V(weight_string, "weight") \ V(windows_verbatim_arguments_string, "windowsVerbatimArguments") \ V(wrap_string, "wrap") \ V(writable_string, "writable") \ V(write_queue_size_string, "writeQueueSize") \ V(x_forwarded_string, "x-forwarded-for") \ V(zero_return_string, "ZERO_RETURN") \ #define ENVIRONMENT_STRONG_PERSISTENT_PROPERTIES(V) \ V(as_external, v8::External) \ V(async_hooks_init_function, v8::Function) \ V(async_hooks_pre_function, v8::Function) \ V(async_hooks_post_function, v8::Function) \ V(async_hooks_destroy_function, v8::Function) \ V(binding_cache_object, v8::Object) \ V(buffer_constructor_function, v8::Function) \ V(buffer_prototype_object, v8::Object) \ V(context, v8::Context) \ V(domain_array, v8::Array) \ V(domains_stack_array, v8::Array) \ V(fs_stats_constructor_function, v8::Function) \ V(generic_internal_field_template, v8::ObjectTemplate) \ V(jsstream_constructor_template, v8::FunctionTemplate) \ V(module_load_list_array, v8::Array) \ V(pipe_constructor_template, v8::FunctionTemplate) \ V(process_object, v8::Object) \ V(promise_reject_function, v8::Function) \ V(script_context_constructor_template, v8::FunctionTemplate) \ V(script_data_constructor_function, v8::Function) \ V(secure_context_constructor_template, v8::FunctionTemplate) \ V(tcp_constructor_template, v8::FunctionTemplate) \ V(tick_callback_function, v8::Function) \ V(tls_wrap_constructor_function, v8::Function) \ V(tls_wrap_constructor_template, v8::FunctionTemplate) \ V(tty_constructor_template, v8::FunctionTemplate) \ V(udp_constructor_function, v8::Function) \ V(write_wrap_constructor_function, v8::Function) \ class Environment; struct node_ares_task { Environment* env; ares_socket_t sock; uv_poll_t poll_watcher; RB_ENTRY(node_ares_task) node; }; RB_HEAD(node_ares_task_list, node_ares_task); class Environment { public: class AsyncHooks { public: inline uint32_t* fields(); inline int fields_count() const; inline bool callbacks_enabled(); inline void set_enable_callbacks(uint32_t flag); private: friend class Environment; // So we can call the constructor. inline AsyncHooks(); enum Fields { // Set this to not zero if the init hook should be called. kEnableCallbacks, kFieldsCount }; uint32_t fields_[kFieldsCount]; DISALLOW_COPY_AND_ASSIGN(AsyncHooks); }; class AsyncCallbackScope { public: explicit AsyncCallbackScope(Environment* env); ~AsyncCallbackScope(); inline bool in_makecallback(); private: Environment* env_; DISALLOW_COPY_AND_ASSIGN(AsyncCallbackScope); }; class DomainFlag { public: inline uint32_t* fields(); inline int fields_count() const; inline uint32_t count() const; private: friend class Environment; // So we can call the constructor. inline DomainFlag(); enum Fields { kCount, kFieldsCount }; uint32_t fields_[kFieldsCount]; DISALLOW_COPY_AND_ASSIGN(DomainFlag); }; class TickInfo { public: inline uint32_t* fields(); inline int fields_count() const; inline uint32_t index() const; inline uint32_t length() const; inline void set_index(uint32_t value); private: friend class Environment; // So we can call the constructor. inline TickInfo(); enum Fields { kIndex, kLength, kFieldsCount }; uint32_t fields_[kFieldsCount]; DISALLOW_COPY_AND_ASSIGN(TickInfo); }; class ArrayBufferAllocatorInfo { public: inline uint32_t* fields(); inline int fields_count() const; inline bool no_zero_fill() const; inline void reset_fill_flag(); private: friend class Environment; // So we can call the constructor. inline ArrayBufferAllocatorInfo(); enum Fields { kNoZeroFill, kFieldsCount }; uint32_t fields_[kFieldsCount]; DISALLOW_COPY_AND_ASSIGN(ArrayBufferAllocatorInfo); }; typedef void (*HandleCleanupCb)(Environment* env, uv_handle_t* handle, void* arg); class HandleCleanup { private: friend class Environment; HandleCleanup(uv_handle_t* handle, HandleCleanupCb cb, void* arg) : handle_(handle), cb_(cb), arg_(arg) { } uv_handle_t* handle_; HandleCleanupCb cb_; void* arg_; ListNode handle_cleanup_queue_; }; static inline Environment* GetCurrent(v8::Isolate* isolate); static inline Environment* GetCurrent(v8::Local context); static inline Environment* GetCurrent( const v8::FunctionCallbackInfo& info); template static inline Environment* GetCurrent( const v8::PropertyCallbackInfo& info); // See CreateEnvironment() in src/node.cc. static inline Environment* New(v8::Local context, uv_loop_t* loop); inline void CleanupHandles(); inline void Dispose(); void AssignToContext(v8::Local context); inline v8::Isolate* isolate() const; inline uv_loop_t* event_loop() const; inline bool async_wrap_callbacks_enabled() const; inline bool in_domain() const; inline uint32_t watched_providers() const; static inline Environment* from_immediate_check_handle(uv_check_t* handle); static inline Environment* from_destroy_ids_idle_handle(uv_idle_t* handle); inline uv_check_t* immediate_check_handle(); inline uv_idle_t* immediate_idle_handle(); inline uv_idle_t* destroy_ids_idle_handle(); static inline Environment* from_idle_prepare_handle(uv_prepare_t* handle); inline uv_prepare_t* idle_prepare_handle(); static inline Environment* from_idle_check_handle(uv_check_t* handle); inline uv_check_t* idle_check_handle(); // Register clean-up cb to be called on env->Dispose() inline void RegisterHandleCleanup(uv_handle_t* handle, HandleCleanupCb cb, void *arg); inline void FinishHandleCleanup(uv_handle_t* handle); inline AsyncHooks* async_hooks(); inline DomainFlag* domain_flag(); inline TickInfo* tick_info(); inline ArrayBufferAllocatorInfo* array_buffer_allocator_info(); inline uint64_t timer_base() const; static inline Environment* from_cares_timer_handle(uv_timer_t* handle); inline uv_timer_t* cares_timer_handle(); inline ares_channel cares_channel(); inline ares_channel* cares_channel_ptr(); inline node_ares_task_list* cares_task_list(); inline bool using_domains() const; inline void set_using_domains(bool value); inline bool printed_error() const; inline void set_printed_error(bool value); void PrintSyncTrace() const; inline void set_trace_sync_io(bool value); inline int64_t get_async_wrap_uid(); // List of id's that have been destroyed and need the destroy() cb called. inline std::vector* destroy_ids_list(); inline double* heap_statistics_buffer() const; inline void set_heap_statistics_buffer(double* pointer); inline double* heap_space_statistics_buffer() const; inline void set_heap_space_statistics_buffer(double* pointer); inline char* http_parser_buffer() const; inline void set_http_parser_buffer(char* buffer); inline void ThrowError(const char* errmsg); inline void ThrowTypeError(const char* errmsg); inline void ThrowRangeError(const char* errmsg); inline void ThrowErrnoException(int errorno, const char* syscall = nullptr, const char* message = nullptr, const char* path = nullptr); inline void ThrowUVException(int errorno, const char* syscall = nullptr, const char* message = nullptr, const char* path = nullptr, const char* dest = nullptr); // Convenience methods for contextify inline static void ThrowError(v8::Isolate* isolate, const char* errmsg); inline static void ThrowTypeError(v8::Isolate* isolate, const char* errmsg); inline static void ThrowRangeError(v8::Isolate* isolate, const char* errmsg); inline v8::Local NewFunctionTemplate(v8::FunctionCallback callback, v8::Local signature = v8::Local()); // Convenience methods for NewFunctionTemplate(). inline void SetMethod(v8::Local that, const char* name, v8::FunctionCallback callback); inline void SetProtoMethod(v8::Local that, const char* name, v8::FunctionCallback callback); inline void SetTemplateMethod(v8::Local that, const char* name, v8::FunctionCallback callback); inline v8::Local NewInternalFieldObject(); // Strings are shared across shared contexts. The getters simply proxy to // the per-isolate primitive. #define V(PropertyName, StringValue) \ inline v8::Local PropertyName() const; PER_ISOLATE_STRING_PROPERTIES(V) #undef V #define V(PropertyName, TypeName) \ inline v8::Local PropertyName() const; \ inline void set_ ## PropertyName(v8::Local value); ENVIRONMENT_STRONG_PERSISTENT_PROPERTIES(V) #undef V inline debugger::Agent* debugger_agent() { return &debugger_agent_; } typedef ListHead HandleWrapQueue; typedef ListHead, &ReqWrap::req_wrap_queue_> ReqWrapQueue; inline HandleWrapQueue* handle_wrap_queue() { return &handle_wrap_queue_; } inline ReqWrapQueue* req_wrap_queue() { return &req_wrap_queue_; } static const int kContextEmbedderDataIndex = NODE_CONTEXT_EMBEDDER_DATA_INDEX; private: static const int kIsolateSlot = NODE_ISOLATE_SLOT; class IsolateData; inline Environment(v8::Local context, uv_loop_t* loop); inline ~Environment(); inline IsolateData* isolate_data() const; v8::Isolate* const isolate_; IsolateData* const isolate_data_; uv_check_t immediate_check_handle_; uv_idle_t immediate_idle_handle_; uv_idle_t destroy_ids_idle_handle_; uv_prepare_t idle_prepare_handle_; uv_check_t idle_check_handle_; AsyncHooks async_hooks_; DomainFlag domain_flag_; TickInfo tick_info_; ArrayBufferAllocatorInfo array_buffer_allocator_info_; const uint64_t timer_base_; uv_timer_t cares_timer_handle_; ares_channel cares_channel_; node_ares_task_list cares_task_list_; bool using_domains_; bool printed_error_; bool trace_sync_io_; size_t makecallback_cntr_; int64_t async_wrap_uid_; std::vector destroy_ids_list_; debugger::Agent debugger_agent_; HandleWrapQueue handle_wrap_queue_; ReqWrapQueue req_wrap_queue_; ListHead handle_cleanup_queue_; int handle_cleanup_waiting_; double* heap_statistics_buffer_ = nullptr; double* heap_space_statistics_buffer_ = nullptr; char* http_parser_buffer_; #define V(PropertyName, TypeName) \ v8::Persistent PropertyName ## _; ENVIRONMENT_STRONG_PERSISTENT_PROPERTIES(V) #undef V // Per-thread, reference-counted singleton. class IsolateData { public: static inline IsolateData* GetOrCreate(v8::Isolate* isolate, uv_loop_t* loop); inline void Put(); inline uv_loop_t* event_loop() const; #define V(PropertyName, StringValue) \ inline v8::Local PropertyName() const; PER_ISOLATE_STRING_PROPERTIES(V) #undef V private: inline static IsolateData* Get(v8::Isolate* isolate); inline explicit IsolateData(v8::Isolate* isolate, uv_loop_t* loop); inline v8::Isolate* isolate() const; uv_loop_t* const event_loop_; v8::Isolate* const isolate_; #define V(PropertyName, StringValue) \ v8::Eternal PropertyName ## _; PER_ISOLATE_STRING_PROPERTIES(V) #undef V unsigned int ref_count_; DISALLOW_COPY_AND_ASSIGN(IsolateData); }; DISALLOW_COPY_AND_ASSIGN(Environment); }; } // namespace node #endif // SRC_ENV_H_ node-v4.8.2/src/fs_event_wrap.cc000644 000766 000024 00000011527 13070706736 016727 0ustar00iojsstaff000000 000000 #include "async-wrap.h" #include "async-wrap-inl.h" #include "env.h" #include "env-inl.h" #include "util.h" #include "util-inl.h" #include "node.h" #include "handle_wrap.h" #include namespace node { using v8::Context; using v8::FunctionCallbackInfo; using v8::FunctionTemplate; using v8::HandleScope; using v8::Integer; using v8::Local; using v8::Object; using v8::String; using v8::Value; class FSEventWrap: public HandleWrap { public: static void Initialize(Local target, Local unused, Local context); static void New(const FunctionCallbackInfo& args); static void Start(const FunctionCallbackInfo& args); static void Close(const FunctionCallbackInfo& args); size_t self_size() const override { return sizeof(*this); } private: FSEventWrap(Environment* env, Local object); ~FSEventWrap() override; static void OnEvent(uv_fs_event_t* handle, const char* filename, int events, int status); uv_fs_event_t handle_; bool initialized_; }; FSEventWrap::FSEventWrap(Environment* env, Local object) : HandleWrap(env, object, reinterpret_cast(&handle_), AsyncWrap::PROVIDER_FSEVENTWRAP) { initialized_ = false; } FSEventWrap::~FSEventWrap() { CHECK_EQ(initialized_, false); } void FSEventWrap::Initialize(Local target, Local unused, Local context) { Environment* env = Environment::GetCurrent(context); Local t = env->NewFunctionTemplate(New); t->InstanceTemplate()->SetInternalFieldCount(1); t->SetClassName(env->fsevent_string()); env->SetProtoMethod(t, "start", Start); env->SetProtoMethod(t, "close", Close); target->Set(env->fsevent_string(), t->GetFunction()); } void FSEventWrap::New(const FunctionCallbackInfo& args) { CHECK(args.IsConstructCall()); Environment* env = Environment::GetCurrent(args); new FSEventWrap(env, args.This()); } void FSEventWrap::Start(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); FSEventWrap* wrap; ASSIGN_OR_RETURN_UNWRAP(&wrap, args.Holder()); if (args.Length() < 1 || !args[0]->IsString()) { return env->ThrowTypeError("filename must be a valid string"); } node::Utf8Value path(env->isolate(), args[0]); unsigned int flags = 0; if (args[2]->IsTrue()) flags |= UV_FS_EVENT_RECURSIVE; int err = uv_fs_event_init(wrap->env()->event_loop(), &wrap->handle_); if (err == 0) { wrap->initialized_ = true; err = uv_fs_event_start(&wrap->handle_, OnEvent, *path, flags); if (err == 0) { // Check for persistent argument if (!args[1]->IsTrue()) { uv_unref(reinterpret_cast(&wrap->handle_)); } } else { FSEventWrap::Close(args); } } args.GetReturnValue().Set(err); } void FSEventWrap::OnEvent(uv_fs_event_t* handle, const char* filename, int events, int status) { FSEventWrap* wrap = static_cast(handle->data); Environment* env = wrap->env(); HandleScope handle_scope(env->isolate()); Context::Scope context_scope(env->context()); CHECK_EQ(wrap->persistent().IsEmpty(), false); // We're in a bind here. libuv can set both UV_RENAME and UV_CHANGE but // the Node API only lets us pass a single event to JS land. // // The obvious solution is to run the callback twice, once for each event. // However, since the second event is not allowed to fire if the handle is // closed after the first event, and since there is no good way to detect // closed handles, that option is out. // // For now, ignore the UV_CHANGE event if UV_RENAME is also set. Make the // assumption that a rename implicitly means an attribute change. Not too // unreasonable, right? Still, we should revisit this before v1.0. Local event_string; if (status) { event_string = String::Empty(env->isolate()); } else if (events & UV_RENAME) { event_string = env->rename_string(); } else if (events & UV_CHANGE) { event_string = env->change_string(); } else { CHECK(0 && "bad fs events flag"); ABORT(); } Local argv[] = { Integer::New(env->isolate(), status), event_string, Null(env->isolate()) }; if (filename != nullptr) { argv[2] = OneByteString(env->isolate(), filename); } wrap->MakeCallback(env->onchange_string(), arraysize(argv), argv); } void FSEventWrap::Close(const FunctionCallbackInfo& args) { FSEventWrap* wrap; ASSIGN_OR_RETURN_UNWRAP(&wrap, args.Holder()); if (wrap == nullptr || wrap->initialized_ == false) return; wrap->initialized_ = false; HandleWrap::Close(args); } } // namespace node NODE_MODULE_CONTEXT_AWARE_BUILTIN(fs_event_wrap, node::FSEventWrap::Initialize) node-v4.8.2/src/handle_wrap.cc000644 000766 000024 00000004636 13070706736 016354 0ustar00iojsstaff000000 000000 #include "handle_wrap.h" #include "async-wrap.h" #include "async-wrap-inl.h" #include "env.h" #include "env-inl.h" #include "util.h" #include "util-inl.h" #include "node.h" namespace node { using v8::Context; using v8::FunctionCallbackInfo; using v8::HandleScope; using v8::Local; using v8::Object; using v8::Value; void HandleWrap::Ref(const FunctionCallbackInfo& args) { HandleWrap* wrap; ASSIGN_OR_RETURN_UNWRAP(&wrap, args.Holder()); if (IsAlive(wrap)) { uv_ref(wrap->handle__); wrap->flags_ &= ~kUnref; } } void HandleWrap::Unref(const FunctionCallbackInfo& args) { HandleWrap* wrap; ASSIGN_OR_RETURN_UNWRAP(&wrap, args.Holder()); if (IsAlive(wrap)) { uv_unref(wrap->handle__); wrap->flags_ |= kUnref; } } void HandleWrap::Close(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); HandleWrap* wrap; ASSIGN_OR_RETURN_UNWRAP(&wrap, args.Holder()); // guard against uninitialized handle or double close if (!IsAlive(wrap)) return; CHECK_EQ(false, wrap->persistent().IsEmpty()); uv_close(wrap->handle__, OnClose); wrap->handle__ = nullptr; if (args[0]->IsFunction()) { wrap->object()->Set(env->onclose_string(), args[0]); wrap->flags_ |= kCloseCallback; } } HandleWrap::HandleWrap(Environment* env, Local object, uv_handle_t* handle, AsyncWrap::ProviderType provider, AsyncWrap* parent) : AsyncWrap(env, object, provider, parent), flags_(0), handle__(handle) { handle__->data = this; HandleScope scope(env->isolate()); Wrap(object, this); env->handle_wrap_queue()->PushBack(this); } HandleWrap::~HandleWrap() { CHECK(persistent().IsEmpty()); } void HandleWrap::OnClose(uv_handle_t* handle) { HandleWrap* wrap = static_cast(handle->data); Environment* env = wrap->env(); HandleScope scope(env->isolate()); // The wrap object should still be there. CHECK_EQ(wrap->persistent().IsEmpty(), false); // But the handle pointer should be gone. CHECK_EQ(wrap->handle__, nullptr); HandleScope handle_scope(env->isolate()); Context::Scope context_scope(env->context()); if (wrap->flags_ & kCloseCallback) { wrap->MakeCallback(env->onclose_string(), 0, nullptr); } ClearWrap(wrap->object()); wrap->persistent().Reset(); delete wrap; } } // namespace node node-v4.8.2/src/handle_wrap.h000644 000766 000024 00000004002 13070706736 016201 0ustar00iojsstaff000000 000000 #ifndef SRC_HANDLE_WRAP_H_ #define SRC_HANDLE_WRAP_H_ #include "async-wrap.h" #include "util.h" #include "uv.h" #include "v8.h" namespace node { class Environment; // Rules: // // - Do not throw from handle methods. Set errno. // // - MakeCallback may only be made directly off the event loop. // That is there can be no JavaScript stack frames underneath it. // (Is there any way to assert that?) // // - No use of v8::WeakReferenceCallback. The close callback signifies that // we're done with a handle - external resources can be freed. // // - Reusable? // // - The uv_close_cb is used to free the c++ object. The close callback // is not made into javascript land. // // - uv_ref, uv_unref counts are managed at this layer to avoid needless // js/c++ boundary crossing. At the javascript layer that should all be // taken care of. class HandleWrap : public AsyncWrap { public: static void Close(const v8::FunctionCallbackInfo& args); static void Ref(const v8::FunctionCallbackInfo& args); static void Unref(const v8::FunctionCallbackInfo& args); static inline bool IsAlive(const HandleWrap* wrap) { return wrap != nullptr && wrap->GetHandle() != nullptr; } inline uv_handle_t* GetHandle() const { return handle__; } protected: HandleWrap(Environment* env, v8::Local object, uv_handle_t* handle, AsyncWrap::ProviderType provider, AsyncWrap* parent = nullptr); ~HandleWrap() override; private: friend class Environment; friend void GetActiveHandles(const v8::FunctionCallbackInfo&); static void OnClose(uv_handle_t* handle); ListNode handle_wrap_queue_; unsigned int flags_; // Using double underscore due to handle_ member in tcp_wrap. Probably // tcp_wrap should rename it's member to 'handle'. uv_handle_t* handle__; static const unsigned int kUnref = 1; static const unsigned int kCloseCallback = 2; }; } // namespace node #endif // SRC_HANDLE_WRAP_H_ node-v4.8.2/src/js_stream.cc000644 000766 000024 00000013435 13070706736 016054 0ustar00iojsstaff000000 000000 #include "js_stream.h" #include "async-wrap.h" #include "env.h" #include "env-inl.h" #include "node_buffer.h" #include "stream_base.h" #include "stream_base-inl.h" #include "v8.h" namespace node { using v8::Array; using v8::Context; using v8::External; using v8::FunctionCallbackInfo; using v8::FunctionTemplate; using v8::HandleScope; using v8::Local; using v8::Object; using v8::Value; JSStream::JSStream(Environment* env, Local obj, AsyncWrap* parent) : AsyncWrap(env, obj, AsyncWrap::PROVIDER_JSSTREAM, parent), StreamBase(env) { node::Wrap(obj, this); MakeWeak(this); } JSStream::~JSStream() { } void* JSStream::Cast() { return static_cast(this); } AsyncWrap* JSStream::GetAsyncWrap() { return static_cast(this); } bool JSStream::IsAlive() { v8::Local fn = object()->Get(env()->isalive_string()); if (!fn->IsFunction()) return false; return MakeCallback(fn.As(), 0, nullptr)->IsTrue(); } bool JSStream::IsClosing() { return MakeCallback(env()->isclosing_string(), 0, nullptr)->IsTrue(); } int JSStream::ReadStart() { return MakeCallback(env()->onreadstart_string(), 0, nullptr)->Int32Value(); } int JSStream::ReadStop() { return MakeCallback(env()->onreadstop_string(), 0, nullptr)->Int32Value(); } int JSStream::DoShutdown(ShutdownWrap* req_wrap) { HandleScope scope(env()->isolate()); Local argv[] = { req_wrap->object() }; req_wrap->Dispatched(); Local res = MakeCallback(env()->onshutdown_string(), arraysize(argv), argv); return res->Int32Value(); } int JSStream::DoWrite(WriteWrap* w, uv_buf_t* bufs, size_t count, uv_stream_t* send_handle) { CHECK_EQ(send_handle, nullptr); HandleScope scope(env()->isolate()); Local bufs_arr = Array::New(env()->isolate(), count); Local buf; for (size_t i = 0; i < count; i++) { buf = Buffer::Copy(env(), bufs[i].base, bufs[i].len).ToLocalChecked(); bufs_arr->Set(i, buf); } Local argv[] = { w->object(), bufs_arr }; w->Dispatched(); Local res = MakeCallback(env()->onwrite_string(), arraysize(argv), argv); return res->Int32Value(); } void JSStream::New(const FunctionCallbackInfo& args) { // This constructor should not be exposed to public javascript. // Therefore we assert that we are not trying to call this as a // normal function. CHECK(args.IsConstructCall()); Environment* env = Environment::GetCurrent(args); JSStream* wrap; if (args.Length() == 0) { wrap = new JSStream(env, args.This(), nullptr); } else if (args[0]->IsExternal()) { void* ptr = args[0].As()->Value(); wrap = new JSStream(env, args.This(), static_cast(ptr)); } else { UNREACHABLE(); } CHECK(wrap); } static void FreeCallback(char* data, void* hint) { // Intentional no-op } void JSStream::DoAlloc(const FunctionCallbackInfo& args) { JSStream* wrap; ASSIGN_OR_RETURN_UNWRAP(&wrap, args.Holder()); uv_buf_t buf; wrap->OnAlloc(args[0]->Int32Value(), &buf); Local vbuf = Buffer::New( wrap->env(), buf.base, buf.len, FreeCallback, nullptr).ToLocalChecked(); return args.GetReturnValue().Set(vbuf); } void JSStream::DoRead(const FunctionCallbackInfo& args) { JSStream* wrap; ASSIGN_OR_RETURN_UNWRAP(&wrap, args.Holder()); CHECK(Buffer::HasInstance(args[1])); uv_buf_t buf = uv_buf_init(Buffer::Data(args[1]), Buffer::Length(args[1])); wrap->OnRead(args[0]->Int32Value(), &buf); } void JSStream::DoAfterWrite(const FunctionCallbackInfo& args) { JSStream* wrap; CHECK(args[0]->IsObject()); WriteWrap* w; ASSIGN_OR_RETURN_UNWRAP(&wrap, args.Holder()); ASSIGN_OR_RETURN_UNWRAP(&w, args[0].As()); wrap->OnAfterWrite(w); } template void JSStream::Finish(const FunctionCallbackInfo& args) { Wrap* w; CHECK(args[0]->IsObject()); ASSIGN_OR_RETURN_UNWRAP(&w, args[0].As()); w->Done(args[1]->Int32Value()); } void JSStream::ReadBuffer(const FunctionCallbackInfo& args) { JSStream* wrap; ASSIGN_OR_RETURN_UNWRAP(&wrap, args.Holder()); CHECK(Buffer::HasInstance(args[0])); char* data = Buffer::Data(args[0]); int len = Buffer::Length(args[0]); do { uv_buf_t buf; ssize_t avail = len; wrap->OnAlloc(len, &buf); if (static_cast(buf.len) < avail) avail = buf.len; memcpy(buf.base, data, avail); data += avail; len -= avail; wrap->OnRead(avail, &buf); } while (len != 0); } void JSStream::EmitEOF(const FunctionCallbackInfo& args) { JSStream* wrap; ASSIGN_OR_RETURN_UNWRAP(&wrap, args.Holder()); wrap->OnRead(UV_EOF, nullptr); } void JSStream::Initialize(Local target, Local unused, Local context) { Environment* env = Environment::GetCurrent(context); Local t = env->NewFunctionTemplate(New); t->SetClassName(FIXED_ONE_BYTE_STRING(env->isolate(), "JSStream")); t->InstanceTemplate()->SetInternalFieldCount(1); env->SetProtoMethod(t, "doAlloc", DoAlloc); env->SetProtoMethod(t, "doRead", DoRead); env->SetProtoMethod(t, "doAfterWrite", DoAfterWrite); env->SetProtoMethod(t, "finishWrite", Finish); env->SetProtoMethod(t, "finishShutdown", Finish); env->SetProtoMethod(t, "readBuffer", ReadBuffer); env->SetProtoMethod(t, "emitEOF", EmitEOF); StreamBase::AddMethods(env, t, StreamBase::kFlagHasWritev); target->Set(FIXED_ONE_BYTE_STRING(env->isolate(), "JSStream"), t->GetFunction()); env->set_jsstream_constructor_template(t); } } // namespace node NODE_MODULE_CONTEXT_AWARE_BUILTIN(js_stream, node::JSStream::Initialize) node-v4.8.2/src/js_stream.h000644 000766 000024 00000002735 13070706736 015717 0ustar00iojsstaff000000 000000 #ifndef SRC_JS_STREAM_H_ #define SRC_JS_STREAM_H_ #include "async-wrap.h" #include "env.h" #include "stream_base.h" #include "v8.h" namespace node { class JSStream : public AsyncWrap, public StreamBase { public: static void Initialize(v8::Local target, v8::Local unused, v8::Local context); ~JSStream(); void* Cast() override; bool IsAlive() override; bool IsClosing() override; int ReadStart() override; int ReadStop() override; int DoShutdown(ShutdownWrap* req_wrap) override; int DoWrite(WriteWrap* w, uv_buf_t* bufs, size_t count, uv_stream_t* send_handle) override; size_t self_size() const override { return sizeof(*this); } protected: JSStream(Environment* env, v8::Local obj, AsyncWrap* parent); AsyncWrap* GetAsyncWrap() override; static void New(const v8::FunctionCallbackInfo& args); static void DoAlloc(const v8::FunctionCallbackInfo& args); static void DoRead(const v8::FunctionCallbackInfo& args); static void DoAfterWrite(const v8::FunctionCallbackInfo& args); static void ReadBuffer(const v8::FunctionCallbackInfo& args); static void EmitEOF(const v8::FunctionCallbackInfo& args); template static void Finish(const v8::FunctionCallbackInfo& args); }; } // namespace node #endif // SRC_JS_STREAM_H_ node-v4.8.2/src/node.cc000644 000766 000024 00000372070 13070706736 015015 0ustar00iojsstaff000000 000000 #include "node.h" #include "node_buffer.h" #include "node_constants.h" #include "node_file.h" #include "node_http_parser.h" #include "node_javascript.h" #include "node_version.h" #include "node_internals.h" #include "node_revert.h" #if defined HAVE_PERFCTR #include "node_counters.h" #endif #if HAVE_OPENSSL #include "node_crypto.h" #endif #if defined(NODE_HAVE_I18N_SUPPORT) #include "node_i18n.h" #endif #if defined HAVE_DTRACE || defined HAVE_ETW #include "node_dtrace.h" #endif #if defined HAVE_LTTNG #include "node_lttng.h" #endif #include "ares.h" #include "async-wrap.h" #include "async-wrap-inl.h" #include "env.h" #include "env-inl.h" #include "handle_wrap.h" #include "req-wrap.h" #include "req-wrap-inl.h" #include "string_bytes.h" #include "util.h" #include "uv.h" #if NODE_USE_V8_PLATFORM #include "libplatform/libplatform.h" #endif // NODE_USE_V8_PLATFORM #include "v8-debug.h" #include "v8-profiler.h" #include "zlib.h" #ifdef NODE_ENABLE_VTUNE_PROFILING #include "../deps/v8/src/third_party/vtune/v8-vtune.h" #endif #include #include // PATH_MAX #include #include #include #include #include #include #include #include #if defined(NODE_HAVE_I18N_SUPPORT) #include #endif #if defined(LEAK_SANITIZER) #include #endif #if defined(_MSC_VER) #include #include #define getpid GetCurrentProcessId #define umask _umask typedef int mode_t; #else #include #include // getrlimit, setrlimit #include // setuid, getuid #endif #if defined(__POSIX__) && !defined(__ANDROID__) #include // getpwnam() #include // getgrnam() #endif #ifdef __APPLE__ #include #define environ (*_NSGetEnviron()) #elif !defined(_MSC_VER) extern char **environ; #endif namespace node { using v8::Array; using v8::ArrayBuffer; using v8::Boolean; using v8::Context; using v8::EscapableHandleScope; using v8::Exception; using v8::Float64Array; using v8::Function; using v8::FunctionCallbackInfo; using v8::FunctionTemplate; using v8::HandleScope; using v8::HeapStatistics; using v8::Integer; using v8::Isolate; using v8::Local; using v8::Locker; using v8::MaybeLocal; using v8::Message; using v8::Number; using v8::Object; using v8::ObjectTemplate; using v8::Promise; using v8::PromiseRejectMessage; using v8::PropertyCallbackInfo; using v8::SealHandleScope; using v8::StackFrame; using v8::StackTrace; using v8::String; using v8::TryCatch; using v8::Uint32; using v8::Uint32Array; using v8::V8; using v8::Value; static bool print_eval = false; static bool force_repl = false; static bool syntax_check_only = false; static bool trace_deprecation = false; static bool throw_deprecation = false; static bool trace_sync_io = false; static bool track_heap_objects = false; static const char* eval_string = nullptr; static unsigned int preload_module_count = 0; static const char** preload_modules = nullptr; static bool use_debug_agent = false; static bool debug_wait_connect = false; static std::string debug_host; // NOLINT(runtime/string) static int debug_port = 5858; static bool prof_process = false; static bool v8_is_profiling = false; static bool node_is_initialized = false; static node_module* modpending; static node_module* modlist_builtin; static node_module* modlist_linked; static node_module* modlist_addon; #if defined(NODE_HAVE_I18N_SUPPORT) // Path to ICU data (for i18n / Intl) static const char* icu_data_dir = nullptr; #endif // used by C++ modules as well bool no_deprecation = false; // process-relative uptime base, initialized at start-up static double prog_start_time; static bool debugger_running; static uv_async_t dispatch_debug_messages_async; static Mutex node_isolate_mutex; static v8::Isolate* node_isolate; static v8::Platform* default_platform; #ifdef __POSIX__ static uv_sem_t debug_semaphore; #endif static struct { #if NODE_USE_V8_PLATFORM void Initialize(int thread_pool_size) { platform_ = v8::platform::CreateDefaultPlatform(thread_pool_size); V8::InitializePlatform(platform_); } void PumpMessageLoop(Isolate* isolate) { v8::platform::PumpMessageLoop(platform_, isolate); } void Dispose() { delete platform_; platform_ = nullptr; } v8::Platform* platform_; #else // !NODE_USE_V8_PLATFORM void Initialize(int thread_pool_size) {} void PumpMessageLoop(Isolate* isolate) {} void Dispose() {} #endif // !NODE_USE_V8_PLATFORM } v8_platform; static void PrintErrorString(const char* format, ...) { va_list ap; va_start(ap, format); #ifdef _WIN32 HANDLE stderr_handle = GetStdHandle(STD_ERROR_HANDLE); // Check if stderr is something other than a tty/console if (stderr_handle == INVALID_HANDLE_VALUE || stderr_handle == nullptr || uv_guess_handle(_fileno(stderr)) != UV_TTY) { vfprintf(stderr, format, ap); va_end(ap); return; } // Fill in any placeholders int n = _vscprintf(format, ap); std::vector out(n + 1); vsprintf(out.data(), format, ap); // Get required wide buffer size n = MultiByteToWideChar(CP_UTF8, 0, out.data(), -1, nullptr, 0); std::vector wbuf(n); MultiByteToWideChar(CP_UTF8, 0, out.data(), -1, wbuf.data(), n); // Don't include the null character in the output CHECK_GT(n, 0); WriteConsoleW(stderr_handle, wbuf.data(), n - 1, nullptr, nullptr); #else vfprintf(stderr, format, ap); #endif va_end(ap); } static void CheckImmediate(uv_check_t* handle) { Environment* env = Environment::from_immediate_check_handle(handle); HandleScope scope(env->isolate()); Context::Scope context_scope(env->context()); MakeCallback(env, env->process_object(), env->immediate_callback_string()); } static void IdleImmediateDummy(uv_idle_t* handle) { // Do nothing. Only for maintaining event loop. // TODO(bnoordhuis) Maybe make libuv accept nullptr idle callbacks. } static inline const char *errno_string(int errorno) { #define ERRNO_CASE(e) case e: return #e; switch (errorno) { #ifdef EACCES ERRNO_CASE(EACCES); #endif #ifdef EADDRINUSE ERRNO_CASE(EADDRINUSE); #endif #ifdef EADDRNOTAVAIL ERRNO_CASE(EADDRNOTAVAIL); #endif #ifdef EAFNOSUPPORT ERRNO_CASE(EAFNOSUPPORT); #endif #ifdef EAGAIN ERRNO_CASE(EAGAIN); #endif #ifdef EWOULDBLOCK # if EAGAIN != EWOULDBLOCK ERRNO_CASE(EWOULDBLOCK); # endif #endif #ifdef EALREADY ERRNO_CASE(EALREADY); #endif #ifdef EBADF ERRNO_CASE(EBADF); #endif #ifdef EBADMSG ERRNO_CASE(EBADMSG); #endif #ifdef EBUSY ERRNO_CASE(EBUSY); #endif #ifdef ECANCELED ERRNO_CASE(ECANCELED); #endif #ifdef ECHILD ERRNO_CASE(ECHILD); #endif #ifdef ECONNABORTED ERRNO_CASE(ECONNABORTED); #endif #ifdef ECONNREFUSED ERRNO_CASE(ECONNREFUSED); #endif #ifdef ECONNRESET ERRNO_CASE(ECONNRESET); #endif #ifdef EDEADLK ERRNO_CASE(EDEADLK); #endif #ifdef EDESTADDRREQ ERRNO_CASE(EDESTADDRREQ); #endif #ifdef EDOM ERRNO_CASE(EDOM); #endif #ifdef EDQUOT ERRNO_CASE(EDQUOT); #endif #ifdef EEXIST ERRNO_CASE(EEXIST); #endif #ifdef EFAULT ERRNO_CASE(EFAULT); #endif #ifdef EFBIG ERRNO_CASE(EFBIG); #endif #ifdef EHOSTUNREACH ERRNO_CASE(EHOSTUNREACH); #endif #ifdef EIDRM ERRNO_CASE(EIDRM); #endif #ifdef EILSEQ ERRNO_CASE(EILSEQ); #endif #ifdef EINPROGRESS ERRNO_CASE(EINPROGRESS); #endif #ifdef EINTR ERRNO_CASE(EINTR); #endif #ifdef EINVAL ERRNO_CASE(EINVAL); #endif #ifdef EIO ERRNO_CASE(EIO); #endif #ifdef EISCONN ERRNO_CASE(EISCONN); #endif #ifdef EISDIR ERRNO_CASE(EISDIR); #endif #ifdef ELOOP ERRNO_CASE(ELOOP); #endif #ifdef EMFILE ERRNO_CASE(EMFILE); #endif #ifdef EMLINK ERRNO_CASE(EMLINK); #endif #ifdef EMSGSIZE ERRNO_CASE(EMSGSIZE); #endif #ifdef EMULTIHOP ERRNO_CASE(EMULTIHOP); #endif #ifdef ENAMETOOLONG ERRNO_CASE(ENAMETOOLONG); #endif #ifdef ENETDOWN ERRNO_CASE(ENETDOWN); #endif #ifdef ENETRESET ERRNO_CASE(ENETRESET); #endif #ifdef ENETUNREACH ERRNO_CASE(ENETUNREACH); #endif #ifdef ENFILE ERRNO_CASE(ENFILE); #endif #ifdef ENOBUFS ERRNO_CASE(ENOBUFS); #endif #ifdef ENODATA ERRNO_CASE(ENODATA); #endif #ifdef ENODEV ERRNO_CASE(ENODEV); #endif #ifdef ENOENT ERRNO_CASE(ENOENT); #endif #ifdef ENOEXEC ERRNO_CASE(ENOEXEC); #endif #ifdef ENOLINK ERRNO_CASE(ENOLINK); #endif #ifdef ENOLCK # if ENOLINK != ENOLCK ERRNO_CASE(ENOLCK); # endif #endif #ifdef ENOMEM ERRNO_CASE(ENOMEM); #endif #ifdef ENOMSG ERRNO_CASE(ENOMSG); #endif #ifdef ENOPROTOOPT ERRNO_CASE(ENOPROTOOPT); #endif #ifdef ENOSPC ERRNO_CASE(ENOSPC); #endif #ifdef ENOSR ERRNO_CASE(ENOSR); #endif #ifdef ENOSTR ERRNO_CASE(ENOSTR); #endif #ifdef ENOSYS ERRNO_CASE(ENOSYS); #endif #ifdef ENOTCONN ERRNO_CASE(ENOTCONN); #endif #ifdef ENOTDIR ERRNO_CASE(ENOTDIR); #endif #ifdef ENOTEMPTY # if ENOTEMPTY != EEXIST ERRNO_CASE(ENOTEMPTY); # endif #endif #ifdef ENOTSOCK ERRNO_CASE(ENOTSOCK); #endif #ifdef ENOTSUP ERRNO_CASE(ENOTSUP); #else # ifdef EOPNOTSUPP ERRNO_CASE(EOPNOTSUPP); # endif #endif #ifdef ENOTTY ERRNO_CASE(ENOTTY); #endif #ifdef ENXIO ERRNO_CASE(ENXIO); #endif #ifdef EOVERFLOW ERRNO_CASE(EOVERFLOW); #endif #ifdef EPERM ERRNO_CASE(EPERM); #endif #ifdef EPIPE ERRNO_CASE(EPIPE); #endif #ifdef EPROTO ERRNO_CASE(EPROTO); #endif #ifdef EPROTONOSUPPORT ERRNO_CASE(EPROTONOSUPPORT); #endif #ifdef EPROTOTYPE ERRNO_CASE(EPROTOTYPE); #endif #ifdef ERANGE ERRNO_CASE(ERANGE); #endif #ifdef EROFS ERRNO_CASE(EROFS); #endif #ifdef ESPIPE ERRNO_CASE(ESPIPE); #endif #ifdef ESRCH ERRNO_CASE(ESRCH); #endif #ifdef ESTALE ERRNO_CASE(ESTALE); #endif #ifdef ETIME ERRNO_CASE(ETIME); #endif #ifdef ETIMEDOUT ERRNO_CASE(ETIMEDOUT); #endif #ifdef ETXTBSY ERRNO_CASE(ETXTBSY); #endif #ifdef EXDEV ERRNO_CASE(EXDEV); #endif default: return ""; } } const char *signo_string(int signo) { #define SIGNO_CASE(e) case e: return #e; switch (signo) { #ifdef SIGHUP SIGNO_CASE(SIGHUP); #endif #ifdef SIGINT SIGNO_CASE(SIGINT); #endif #ifdef SIGQUIT SIGNO_CASE(SIGQUIT); #endif #ifdef SIGILL SIGNO_CASE(SIGILL); #endif #ifdef SIGTRAP SIGNO_CASE(SIGTRAP); #endif #ifdef SIGABRT SIGNO_CASE(SIGABRT); #endif #ifdef SIGIOT # if SIGABRT != SIGIOT SIGNO_CASE(SIGIOT); # endif #endif #ifdef SIGBUS SIGNO_CASE(SIGBUS); #endif #ifdef SIGFPE SIGNO_CASE(SIGFPE); #endif #ifdef SIGKILL SIGNO_CASE(SIGKILL); #endif #ifdef SIGUSR1 SIGNO_CASE(SIGUSR1); #endif #ifdef SIGSEGV SIGNO_CASE(SIGSEGV); #endif #ifdef SIGUSR2 SIGNO_CASE(SIGUSR2); #endif #ifdef SIGPIPE SIGNO_CASE(SIGPIPE); #endif #ifdef SIGALRM SIGNO_CASE(SIGALRM); #endif SIGNO_CASE(SIGTERM); #ifdef SIGCHLD SIGNO_CASE(SIGCHLD); #endif #ifdef SIGSTKFLT SIGNO_CASE(SIGSTKFLT); #endif #ifdef SIGCONT SIGNO_CASE(SIGCONT); #endif #ifdef SIGSTOP SIGNO_CASE(SIGSTOP); #endif #ifdef SIGTSTP SIGNO_CASE(SIGTSTP); #endif #ifdef SIGBREAK SIGNO_CASE(SIGBREAK); #endif #ifdef SIGTTIN SIGNO_CASE(SIGTTIN); #endif #ifdef SIGTTOU SIGNO_CASE(SIGTTOU); #endif #ifdef SIGURG SIGNO_CASE(SIGURG); #endif #ifdef SIGXCPU SIGNO_CASE(SIGXCPU); #endif #ifdef SIGXFSZ SIGNO_CASE(SIGXFSZ); #endif #ifdef SIGVTALRM SIGNO_CASE(SIGVTALRM); #endif #ifdef SIGPROF SIGNO_CASE(SIGPROF); #endif #ifdef SIGWINCH SIGNO_CASE(SIGWINCH); #endif #ifdef SIGIO SIGNO_CASE(SIGIO); #endif #ifdef SIGPOLL # if SIGPOLL != SIGIO SIGNO_CASE(SIGPOLL); # endif #endif #ifdef SIGLOST # if SIGLOST != SIGABRT SIGNO_CASE(SIGLOST); # endif #endif #ifdef SIGPWR # if SIGPWR != SIGLOST SIGNO_CASE(SIGPWR); # endif #endif #ifdef SIGSYS SIGNO_CASE(SIGSYS); #endif default: return ""; } } // Convenience methods void ThrowError(v8::Isolate* isolate, const char* errmsg) { Environment::GetCurrent(isolate)->ThrowError(errmsg); } void ThrowTypeError(v8::Isolate* isolate, const char* errmsg) { Environment::GetCurrent(isolate)->ThrowTypeError(errmsg); } void ThrowRangeError(v8::Isolate* isolate, const char* errmsg) { Environment::GetCurrent(isolate)->ThrowRangeError(errmsg); } void ThrowErrnoException(v8::Isolate* isolate, int errorno, const char* syscall, const char* message, const char* path) { Environment::GetCurrent(isolate)->ThrowErrnoException(errorno, syscall, message, path); } void ThrowUVException(v8::Isolate* isolate, int errorno, const char* syscall, const char* message, const char* path, const char* dest) { Environment::GetCurrent(isolate) ->ThrowUVException(errorno, syscall, message, path, dest); } Local ErrnoException(Isolate* isolate, int errorno, const char *syscall, const char *msg, const char *path) { Environment* env = Environment::GetCurrent(isolate); Local e; Local estring = OneByteString(env->isolate(), errno_string(errorno)); if (msg == nullptr || msg[0] == '\0') { msg = strerror(errorno); } Local message = OneByteString(env->isolate(), msg); Local cons = String::Concat(estring, FIXED_ONE_BYTE_STRING(env->isolate(), ", ")); cons = String::Concat(cons, message); Local path_string; if (path != nullptr) { // FIXME(bnoordhuis) It's questionable to interpret the file path as UTF-8. path_string = String::NewFromUtf8(env->isolate(), path); } if (path_string.IsEmpty() == false) { cons = String::Concat(cons, FIXED_ONE_BYTE_STRING(env->isolate(), " '")); cons = String::Concat(cons, path_string); cons = String::Concat(cons, FIXED_ONE_BYTE_STRING(env->isolate(), "'")); } e = Exception::Error(cons); Local obj = e->ToObject(env->isolate()); obj->Set(env->errno_string(), Integer::New(env->isolate(), errorno)); obj->Set(env->code_string(), estring); if (path_string.IsEmpty() == false) { obj->Set(env->path_string(), path_string); } if (syscall != nullptr) { obj->Set(env->syscall_string(), OneByteString(env->isolate(), syscall)); } return e; } static Local StringFromPath(Isolate* isolate, const char* path) { #ifdef _WIN32 if (strncmp(path, "\\\\?\\UNC\\", 8) == 0) { return String::Concat(FIXED_ONE_BYTE_STRING(isolate, "\\\\"), String::NewFromUtf8(isolate, path + 8)); } else if (strncmp(path, "\\\\?\\", 4) == 0) { return String::NewFromUtf8(isolate, path + 4); } #endif return String::NewFromUtf8(isolate, path); } Local UVException(Isolate* isolate, int errorno, const char* syscall, const char* msg, const char* path) { return UVException(isolate, errorno, syscall, msg, path, nullptr); } Local UVException(Isolate* isolate, int errorno, const char* syscall, const char* msg, const char* path, const char* dest) { Environment* env = Environment::GetCurrent(isolate); if (!msg || !msg[0]) msg = uv_strerror(errorno); Local js_code = OneByteString(isolate, uv_err_name(errorno)); Local js_syscall = OneByteString(isolate, syscall); Local js_path; Local js_dest; Local js_msg = js_code; js_msg = String::Concat(js_msg, FIXED_ONE_BYTE_STRING(isolate, ": ")); js_msg = String::Concat(js_msg, OneByteString(isolate, msg)); js_msg = String::Concat(js_msg, FIXED_ONE_BYTE_STRING(isolate, ", ")); js_msg = String::Concat(js_msg, js_syscall); if (path != nullptr) { js_path = StringFromPath(isolate, path); js_msg = String::Concat(js_msg, FIXED_ONE_BYTE_STRING(isolate, " '")); js_msg = String::Concat(js_msg, js_path); js_msg = String::Concat(js_msg, FIXED_ONE_BYTE_STRING(isolate, "'")); } if (dest != nullptr) { js_dest = StringFromPath(isolate, dest); js_msg = String::Concat(js_msg, FIXED_ONE_BYTE_STRING(isolate, " -> '")); js_msg = String::Concat(js_msg, js_dest); js_msg = String::Concat(js_msg, FIXED_ONE_BYTE_STRING(isolate, "'")); } Local e = Exception::Error(js_msg)->ToObject(isolate); // TODO(piscisaureus) errno should probably go; the user has no way of // knowing which uv errno value maps to which error. e->Set(env->errno_string(), Integer::New(isolate, errorno)); e->Set(env->code_string(), js_code); e->Set(env->syscall_string(), js_syscall); if (!js_path.IsEmpty()) e->Set(env->path_string(), js_path); if (!js_dest.IsEmpty()) e->Set(env->dest_string(), js_dest); return e; } // Look up environment variable unless running as setuid root. inline const char* secure_getenv(const char* key) { #ifndef _WIN32 if (getuid() != geteuid() || getgid() != getegid()) return nullptr; #endif return getenv(key); } #ifdef _WIN32 // Does about the same as strerror(), // but supports all windows error messages static const char *winapi_strerror(const int errorno, bool* must_free) { char *errmsg = nullptr; FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS, nullptr, errorno, MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), (LPTSTR)&errmsg, 0, nullptr); if (errmsg) { *must_free = true; // Remove trailing newlines for (int i = strlen(errmsg) - 1; i >= 0 && (errmsg[i] == '\n' || errmsg[i] == '\r'); i--) { errmsg[i] = '\0'; } return errmsg; } else { // FormatMessage failed *must_free = false; return "Unknown error"; } } Local WinapiErrnoException(Isolate* isolate, int errorno, const char* syscall, const char* msg, const char* path) { Environment* env = Environment::GetCurrent(isolate); Local e; bool must_free = false; if (!msg || !msg[0]) { msg = winapi_strerror(errorno, &must_free); } Local message = OneByteString(env->isolate(), msg); if (path) { Local cons1 = String::Concat(message, FIXED_ONE_BYTE_STRING(isolate, " '")); Local cons2 = String::Concat(cons1, String::NewFromUtf8(isolate, path)); Local cons3 = String::Concat(cons2, FIXED_ONE_BYTE_STRING(isolate, "'")); e = Exception::Error(cons3); } else { e = Exception::Error(message); } Local obj = e->ToObject(env->isolate()); obj->Set(env->errno_string(), Integer::New(isolate, errorno)); if (path != nullptr) { obj->Set(env->path_string(), String::NewFromUtf8(isolate, path)); } if (syscall != nullptr) { obj->Set(env->syscall_string(), OneByteString(isolate, syscall)); } if (must_free) LocalFree((HLOCAL)msg); return e; } #endif void* ArrayBufferAllocator::Allocate(size_t size) { if (env_ == nullptr || !env_->array_buffer_allocator_info()->no_zero_fill() || zero_fill_all_buffers) return node::Calloc(size, 1); env_->array_buffer_allocator_info()->reset_fill_flag(); return node::Malloc(size); } static bool DomainHasErrorHandler(const Environment* env, const Local& domain) { HandleScope scope(env->isolate()); Local domain_event_listeners_v = domain->Get(env->events_string()); if (!domain_event_listeners_v->IsObject()) return false; Local domain_event_listeners_o = domain_event_listeners_v.As(); Local domain_error_listeners_v = domain_event_listeners_o->Get(env->error_string()); if (domain_error_listeners_v->IsFunction() || (domain_error_listeners_v->IsArray() && domain_error_listeners_v.As()->Length() > 0)) return true; return false; } static bool TopDomainHasErrorHandler(const Environment* env) { HandleScope scope(env->isolate()); if (!env->using_domains()) return false; Local domains_stack_array = env->domains_stack_array().As(); if (domains_stack_array->Length() == 0) return false; uint32_t domains_stack_length = domains_stack_array->Length(); if (domains_stack_length == 0) return false; Local top_domain_v = domains_stack_array->Get(domains_stack_length - 1); if (!top_domain_v->IsObject()) return false; Local top_domain = top_domain_v.As(); if (DomainHasErrorHandler(env, top_domain)) return true; return false; } static bool ShouldAbortOnUncaughtException(Isolate* isolate) { HandleScope scope(isolate); Environment* env = Environment::GetCurrent(isolate); Local process_object = env->process_object(); Local emitting_top_level_domain_error_key = env->emitting_top_level_domain_error_string(); bool isEmittingTopLevelDomainError = process_object->Get(emitting_top_level_domain_error_key)->BooleanValue(); return isEmittingTopLevelDomainError || !TopDomainHasErrorHandler(env); } void SetupDomainUse(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); if (env->using_domains()) return; env->set_using_domains(true); HandleScope scope(env->isolate()); Local process_object = env->process_object(); Local tick_callback_function_key = env->tick_domain_cb_string(); Local tick_callback_function = process_object->Get(tick_callback_function_key).As(); if (!tick_callback_function->IsFunction()) { fprintf(stderr, "process._tickDomainCallback assigned to non-function\n"); ABORT(); } process_object->Set(env->tick_callback_string(), tick_callback_function); env->set_tick_callback_function(tick_callback_function); CHECK(args[0]->IsArray()); env->set_domain_array(args[0].As()); CHECK(args[1]->IsArray()); env->set_domains_stack_array(args[1].As()); // Do a little housekeeping. env->process_object()->Delete( FIXED_ONE_BYTE_STRING(args.GetIsolate(), "_setupDomainUse")); uint32_t* const fields = env->domain_flag()->fields(); uint32_t const fields_count = env->domain_flag()->fields_count(); Local array_buffer = ArrayBuffer::New(env->isolate(), fields, sizeof(*fields) * fields_count); args.GetReturnValue().Set(Uint32Array::New(array_buffer, 0, fields_count)); } void RunMicrotasks(const FunctionCallbackInfo& args) { args.GetIsolate()->RunMicrotasks(); } void SetupNextTick(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); CHECK(args[0]->IsFunction()); CHECK(args[1]->IsObject()); env->set_tick_callback_function(args[0].As()); env->SetMethod(args[1].As(), "runMicrotasks", RunMicrotasks); // Do a little housekeeping. env->process_object()->Delete( FIXED_ONE_BYTE_STRING(args.GetIsolate(), "_setupNextTick")); // Values use to cross communicate with processNextTick. uint32_t* const fields = env->tick_info()->fields(); uint32_t const fields_count = env->tick_info()->fields_count(); Local array_buffer = ArrayBuffer::New(env->isolate(), fields, sizeof(*fields) * fields_count); args.GetReturnValue().Set(Uint32Array::New(array_buffer, 0, fields_count)); } void PromiseRejectCallback(PromiseRejectMessage message) { Local promise = message.GetPromise(); Isolate* isolate = promise->GetIsolate(); Local value = message.GetValue(); Local event = Integer::New(isolate, message.GetEvent()); Environment* env = Environment::GetCurrent(isolate); Local callback = env->promise_reject_function(); if (value.IsEmpty()) value = Undefined(isolate); Local args[] = { event, promise, value }; Local process = env->process_object(); callback->Call(process, arraysize(args), args); } void SetupPromises(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); Isolate* isolate = env->isolate(); CHECK(args[0]->IsFunction()); isolate->SetPromiseRejectCallback(PromiseRejectCallback); env->set_promise_reject_function(args[0].As()); env->process_object()->Delete( FIXED_ONE_BYTE_STRING(args.GetIsolate(), "_setupPromises")); } Local MakeCallback(Environment* env, Local recv, const Local callback, int argc, Local argv[]) { // If you hit this assertion, you forgot to enter the v8::Context first. CHECK_EQ(env->context(), env->isolate()->GetCurrentContext()); Local pre_fn = env->async_hooks_pre_function(); Local post_fn = env->async_hooks_post_function(); Local object, domain; bool ran_init_callback = false; bool has_domain = false; Environment::AsyncCallbackScope callback_scope(env); // TODO(trevnorris): Adding "_asyncQueue" to the "this" in the init callback // is a horrible way to detect usage. Rethink how detection should happen. if (recv->IsObject()) { object = recv.As(); Local async_queue_v = object->Get(env->async_queue_string()); if (async_queue_v->IsObject()) ran_init_callback = true; } if (env->using_domains()) { CHECK(recv->IsObject()); Local domain_v = object->Get(env->domain_string()); has_domain = domain_v->IsObject(); if (has_domain) { domain = domain_v.As(); if (domain->Get(env->disposed_string())->IsTrue()) return Undefined(env->isolate()); } } if (has_domain) { Local enter_v = domain->Get(env->enter_string()); if (enter_v->IsFunction()) { if (enter_v.As()->Call(domain, 0, nullptr).IsEmpty()) { FatalError("node::MakeCallback", "domain enter callback threw, please report this"); } } } if (ran_init_callback && !pre_fn.IsEmpty()) { TryCatch try_catch(env->isolate()); MaybeLocal ar = pre_fn->Call(env->context(), object, 0, nullptr); if (ar.IsEmpty()) { ClearFatalExceptionHandlers(env); FatalException(env->isolate(), try_catch); return Local(); } } Local ret = callback->Call(recv, argc, argv); if (ran_init_callback && !post_fn.IsEmpty()) { Local did_throw = Boolean::New(env->isolate(), ret.IsEmpty()); // Currently there's no way to retrieve an uid from node::MakeCallback(). // This needs to be fixed. Local vals[] = { Undefined(env->isolate()).As(), did_throw }; TryCatch try_catch(env->isolate()); MaybeLocal ar = post_fn->Call(env->context(), object, arraysize(vals), vals); if (ar.IsEmpty()) { ClearFatalExceptionHandlers(env); FatalException(env->isolate(), try_catch); return Local(); } } if (ret.IsEmpty()) { // NOTE: For backwards compatibility with public API we return Undefined() // if the top level call threw. return callback_scope.in_makecallback() ? ret : Undefined(env->isolate()).As(); } if (has_domain) { Local exit_v = domain->Get(env->exit_string()); if (exit_v->IsFunction()) { if (exit_v.As()->Call(domain, 0, nullptr).IsEmpty()) { FatalError("node::MakeCallback", "domain exit callback threw, please report this"); } } } if (callback_scope.in_makecallback()) { return ret; } Environment::TickInfo* tick_info = env->tick_info(); if (tick_info->length() == 0) { env->isolate()->RunMicrotasks(); } Local process = env->process_object(); if (tick_info->length() == 0) { tick_info->set_index(0); } if (env->tick_callback_function()->Call(process, 0, nullptr).IsEmpty()) { return Undefined(env->isolate()); } return ret; } // Internal only. Local MakeCallback(Environment* env, Local recv, uint32_t index, int argc, Local argv[]) { Local cb_v = recv->Get(index); CHECK(cb_v->IsFunction()); return MakeCallback(env, recv.As(), cb_v.As(), argc, argv); } Local MakeCallback(Environment* env, Local recv, Local symbol, int argc, Local argv[]) { Local cb_v = recv->Get(symbol); CHECK(cb_v->IsFunction()); return MakeCallback(env, recv.As(), cb_v.As(), argc, argv); } Local MakeCallback(Environment* env, Local recv, const char* method, int argc, Local argv[]) { Local method_string = OneByteString(env->isolate(), method); return MakeCallback(env, recv, method_string, argc, argv); } Local MakeCallback(Isolate* isolate, Local recv, const char* method, int argc, Local argv[]) { EscapableHandleScope handle_scope(isolate); Local context = recv->CreationContext(); Environment* env = Environment::GetCurrent(context); Context::Scope context_scope(context); return handle_scope.Escape( Local::New(isolate, MakeCallback(env, recv, method, argc, argv))); } Local MakeCallback(Isolate* isolate, Local recv, Local symbol, int argc, Local argv[]) { EscapableHandleScope handle_scope(isolate); Local context = recv->CreationContext(); Environment* env = Environment::GetCurrent(context); Context::Scope context_scope(context); return handle_scope.Escape( Local::New(isolate, MakeCallback(env, recv, symbol, argc, argv))); } Local MakeCallback(Isolate* isolate, Local recv, Local callback, int argc, Local argv[]) { EscapableHandleScope handle_scope(isolate); Local context = recv->CreationContext(); Environment* env = Environment::GetCurrent(context); Context::Scope context_scope(context); return handle_scope.Escape(Local::New( isolate, MakeCallback(env, recv.As(), callback, argc, argv))); } enum encoding ParseEncoding(const char* encoding, enum encoding default_encoding) { switch (encoding[0]) { case 'u': // utf8, utf16le if (encoding[1] == 't' && encoding[2] == 'f') { // Skip `-` encoding += encoding[3] == '-' ? 4 : 3; if (encoding[0] == '8' && encoding[1] == '\0') return UTF8; if (strncmp(encoding, "16le", 4) == 0) return UCS2; // ucs2 } else if (encoding[1] == 'c' && encoding[2] == 's') { encoding += encoding[3] == '-' ? 4 : 3; if (encoding[0] == '2' && encoding[1] == '\0') return UCS2; } break; case 'b': // binary if (encoding[1] == 'i') { if (strncmp(encoding + 2, "nary", 4) == 0) return BINARY; // buffer } else if (encoding[1] == 'u') { if (strncmp(encoding + 2, "ffer", 4) == 0) return BUFFER; } break; case '\0': return default_encoding; default: break; } if (StringEqualNoCase(encoding, "utf8")) { return UTF8; } else if (StringEqualNoCase(encoding, "utf-8")) { return UTF8; } else if (StringEqualNoCase(encoding, "ascii")) { return ASCII; } else if (StringEqualNoCase(encoding, "base64")) { return BASE64; } else if (StringEqualNoCase(encoding, "ucs2")) { return UCS2; } else if (StringEqualNoCase(encoding, "ucs-2")) { return UCS2; } else if (StringEqualNoCase(encoding, "utf16le")) { return UCS2; } else if (StringEqualNoCase(encoding, "utf-16le")) { return UCS2; } else if (StringEqualNoCase(encoding, "binary")) { return BINARY; } else if (StringEqualNoCase(encoding, "buffer")) { return BUFFER; } else if (StringEqualNoCase(encoding, "hex")) { return HEX; } else if (StringEqualNoCase(encoding, "raw") == 0) { if (!no_deprecation) { fprintf(stderr, "'raw' (array of integers) has been removed. " "Use 'binary'.\n"); } return BINARY; } else if (StringEqualNoCase(encoding, "raws") == 0) { if (!no_deprecation) { fprintf(stderr, "'raws' encoding has been renamed to 'binary'. " "Please update your code.\n"); } return BINARY; } else { return default_encoding; } } enum encoding ParseEncoding(Isolate* isolate, Local encoding_v, enum encoding default_encoding) { if (!encoding_v->IsString()) return default_encoding; node::Utf8Value encoding(isolate, encoding_v); return ParseEncoding(*encoding, default_encoding); } Local Encode(Isolate* isolate, const char* buf, size_t len, enum encoding encoding) { CHECK_NE(encoding, UCS2); return StringBytes::Encode(isolate, buf, len, encoding); } Local Encode(Isolate* isolate, const uint16_t* buf, size_t len) { return StringBytes::Encode(isolate, buf, len); } // Returns -1 if the handle was not valid for decoding ssize_t DecodeBytes(Isolate* isolate, Local val, enum encoding encoding) { HandleScope scope(isolate); if (val->IsArray()) { fprintf(stderr, "'raw' encoding (array of integers) has been removed. " "Use 'binary'.\n"); UNREACHABLE(); return -1; } return StringBytes::Size(isolate, val, encoding); } // Returns number of bytes written. ssize_t DecodeWrite(Isolate* isolate, char* buf, size_t buflen, Local val, enum encoding encoding) { return StringBytes::Write(isolate, buf, buflen, val, encoding, nullptr); } void AppendExceptionLine(Environment* env, Local er, Local message, enum ErrorHandlingMode mode) { if (message.IsEmpty()) return; HandleScope scope(env->isolate()); Local err_obj; if (!er.IsEmpty() && er->IsObject()) { err_obj = er.As(); // Do it only once per message if (!err_obj->GetHiddenValue(env->processed_string()).IsEmpty()) return; err_obj->SetHiddenValue(env->processed_string(), True(env->isolate())); } // Print (filename):(line number): (message). node::Utf8Value filename(env->isolate(), message->GetScriptResourceName()); const char* filename_string = *filename; int linenum = message->GetLineNumber(); // Print line of source code. node::Utf8Value sourceline(env->isolate(), message->GetSourceLine()); const char* sourceline_string = *sourceline; // Because of how node modules work, all scripts are wrapped with a // "function (module, exports, __filename, ...) {" // to provide script local variables. // // When reporting errors on the first line of a script, this wrapper // function is leaked to the user. There used to be a hack here to // truncate off the first 62 characters, but it caused numerous other // problems when vm.runIn*Context() methods were used for non-module // code. // // If we ever decide to re-instate such a hack, the following steps // must be taken: // // 1. Pass a flag around to say "this code was wrapped" // 2. Update the stack frame output so that it is also correct. // // It would probably be simpler to add a line rather than add some // number of characters to the first line, since V8 truncates the // sourceline to 78 characters, and we end up not providing very much // useful debugging info to the user if we remove 62 characters. int start = message->GetStartColumn(); int end = message->GetEndColumn(); char arrow[1024]; int max_off = sizeof(arrow) - 2; int off = snprintf(arrow, sizeof(arrow), "%s:%i\n%s\n", filename_string, linenum, sourceline_string); CHECK_GE(off, 0); if (off > max_off) { off = max_off; } // Print wavy underline (GetUnderline is deprecated). for (int i = 0; i < start; i++) { if (sourceline_string[i] == '\0' || off >= max_off) { break; } CHECK_LT(off, max_off); arrow[off++] = (sourceline_string[i] == '\t') ? '\t' : ' '; } for (int i = start; i < end; i++) { if (sourceline_string[i] == '\0' || off >= max_off) { break; } CHECK_LT(off, max_off); arrow[off++] = '^'; } CHECK_LE(off, max_off); arrow[off] = '\n'; arrow[off + 1] = '\0'; Local arrow_str = String::NewFromUtf8(env->isolate(), arrow); const bool can_set_arrow = !arrow_str.IsEmpty() && !err_obj.IsEmpty(); // If allocating arrow_str failed, print it out. There's not much else to do. // If it's not an error, but something needs to be printed out because // it's a fatal exception, also print it out from here. // Otherwise, the arrow property will be attached to the object and handled // by the caller. if (!can_set_arrow || (mode == FATAL_ERROR && !err_obj->IsNativeError())) { if (env->printed_error()) return; env->set_printed_error(true); uv_tty_reset_mode(); PrintErrorString("\n%s", arrow); return; } err_obj->SetHiddenValue(env->arrow_message_string(), arrow_str); } static void ReportException(Environment* env, Local er, Local message) { HandleScope scope(env->isolate()); AppendExceptionLine(env, er, message, FATAL_ERROR); Local trace_value; Local arrow; if (er->IsUndefined() || er->IsNull()) { trace_value = Undefined(env->isolate()); } else { Local err_obj = er->ToObject(env->isolate()); trace_value = err_obj->Get(env->stack_string()); arrow = err_obj->GetHiddenValue(env->arrow_message_string()); } node::Utf8Value trace(env->isolate(), trace_value); // range errors have a trace member set to undefined if (trace.length() > 0 && !trace_value->IsUndefined()) { if (arrow.IsEmpty() || !arrow->IsString()) { PrintErrorString("%s\n", *trace); } else { node::Utf8Value arrow_string(env->isolate(), arrow); PrintErrorString("%s\n%s\n", *arrow_string, *trace); } } else { // this really only happens for RangeErrors, since they're the only // kind that won't have all this info in the trace, or when non-Error // objects are thrown manually. Local message; Local name; if (er->IsObject()) { Local err_obj = er.As(); message = err_obj->Get(env->message_string()); name = err_obj->Get(FIXED_ONE_BYTE_STRING(env->isolate(), "name")); } if (message.IsEmpty() || message->IsUndefined() || name.IsEmpty() || name->IsUndefined()) { // Not an error object. Just print as-is. String::Utf8Value message(er); PrintErrorString("%s\n", *message ? *message : ""); } else { node::Utf8Value name_string(env->isolate(), name); node::Utf8Value message_string(env->isolate(), message); if (arrow.IsEmpty() || !arrow->IsString()) { PrintErrorString("%s: %s\n", *name_string, *message_string); } else { node::Utf8Value arrow_string(env->isolate(), arrow); PrintErrorString("%s\n%s: %s\n", *arrow_string, *name_string, *message_string); } } } fflush(stderr); } static void ReportException(Environment* env, const TryCatch& try_catch) { ReportException(env, try_catch.Exception(), try_catch.Message()); } // Executes a str within the current v8 context. static Local ExecuteString(Environment* env, Local source, Local filename) { EscapableHandleScope scope(env->isolate()); TryCatch try_catch; // try_catch must be nonverbose to disable FatalException() handler, // we will handle exceptions ourself. try_catch.SetVerbose(false); Local script = v8::Script::Compile(source, filename); if (script.IsEmpty()) { ReportException(env, try_catch); exit(3); } Local result = script->Run(); if (result.IsEmpty()) { ReportException(env, try_catch); exit(4); } return scope.Escape(result); } static void GetActiveRequests(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); Local ary = Array::New(args.GetIsolate()); int i = 0; for (auto w : *env->req_wrap_queue()) if (w->persistent().IsEmpty() == false) ary->Set(i++, w->object()); args.GetReturnValue().Set(ary); } // Non-static, friend of HandleWrap. Could have been a HandleWrap method but // implemented here for consistency with GetActiveRequests(). void GetActiveHandles(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); Local ary = Array::New(env->isolate()); int i = 0; Local owner_sym = env->owner_string(); for (auto w : *env->handle_wrap_queue()) { if (w->persistent().IsEmpty() || (w->flags_ & HandleWrap::kUnref)) continue; Local object = w->object(); Local owner = object->Get(owner_sym); if (owner->IsUndefined()) owner = object; ary->Set(i++, owner); } args.GetReturnValue().Set(ary); } static void Abort(const FunctionCallbackInfo& args) { ABORT(); } static void Chdir(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); if (args.Length() != 1 || !args[0]->IsString()) { return env->ThrowTypeError("Bad argument."); } node::Utf8Value path(args.GetIsolate(), args[0]); int err = uv_chdir(*path); if (err) { return env->ThrowUVException(err, "uv_chdir"); } } static void Cwd(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); #ifdef _WIN32 /* MAX_PATH is in characters, not bytes. Make sure we have enough headroom. */ char buf[MAX_PATH * 4]; #else char buf[PATH_MAX]; #endif size_t cwd_len = sizeof(buf); int err = uv_cwd(buf, &cwd_len); if (err) { return env->ThrowUVException(err, "uv_cwd"); } Local cwd = String::NewFromUtf8(env->isolate(), buf, String::kNormalString, cwd_len); args.GetReturnValue().Set(cwd); } static void Umask(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); uint32_t old; if (args.Length() < 1 || args[0]->IsUndefined()) { old = umask(0); umask(static_cast(old)); } else if (!args[0]->IsInt32() && !args[0]->IsString()) { return env->ThrowTypeError("argument must be an integer or octal string."); } else { int oct; if (args[0]->IsInt32()) { oct = args[0]->Uint32Value(); } else { oct = 0; node::Utf8Value str(env->isolate(), args[0]); // Parse the octal string. for (size_t i = 0; i < str.length(); i++) { char c = (*str)[i]; if (c > '7' || c < '0') { return env->ThrowTypeError("invalid octal string"); } oct *= 8; oct += c - '0'; } } old = umask(static_cast(oct)); } args.GetReturnValue().Set(old); } #if defined(__POSIX__) && !defined(__ANDROID__) static const uid_t uid_not_found = static_cast(-1); static const gid_t gid_not_found = static_cast(-1); static uid_t uid_by_name(const char* name) { struct passwd pwd; struct passwd* pp; char buf[8192]; errno = 0; pp = nullptr; if (getpwnam_r(name, &pwd, buf, sizeof(buf), &pp) == 0 && pp != nullptr) { return pp->pw_uid; } return uid_not_found; } static char* name_by_uid(uid_t uid) { struct passwd pwd; struct passwd* pp; char buf[8192]; int rc; errno = 0; pp = nullptr; if ((rc = getpwuid_r(uid, &pwd, buf, sizeof(buf), &pp)) == 0 && pp != nullptr) { return strdup(pp->pw_name); } if (rc == 0) { errno = ENOENT; } return nullptr; } static gid_t gid_by_name(const char* name) { struct group pwd; struct group* pp; char buf[8192]; errno = 0; pp = nullptr; if (getgrnam_r(name, &pwd, buf, sizeof(buf), &pp) == 0 && pp != nullptr) { return pp->gr_gid; } return gid_not_found; } #if 0 // For future use. static const char* name_by_gid(gid_t gid) { struct group pwd; struct group* pp; char buf[8192]; int rc; errno = 0; pp = nullptr; if ((rc = getgrgid_r(gid, &pwd, buf, sizeof(buf), &pp)) == 0 && pp != nullptr) { return strdup(pp->gr_name); } if (rc == 0) { errno = ENOENT; } return nullptr; } #endif static uid_t uid_by_name(Isolate* isolate, Local value) { if (value->IsUint32()) { return static_cast(value->Uint32Value()); } else { node::Utf8Value name(isolate, value); return uid_by_name(*name); } } static gid_t gid_by_name(Isolate* isolate, Local value) { if (value->IsUint32()) { return static_cast(value->Uint32Value()); } else { node::Utf8Value name(isolate, value); return gid_by_name(*name); } } static void GetUid(const FunctionCallbackInfo& args) { // uid_t is an uint32_t on all supported platforms. args.GetReturnValue().Set(static_cast(getuid())); } static void GetGid(const FunctionCallbackInfo& args) { // gid_t is an uint32_t on all supported platforms. args.GetReturnValue().Set(static_cast(getgid())); } static void GetEUid(const FunctionCallbackInfo& args) { // uid_t is an uint32_t on all supported platforms. args.GetReturnValue().Set(static_cast(geteuid())); } static void GetEGid(const FunctionCallbackInfo& args) { // gid_t is an uint32_t on all supported platforms. args.GetReturnValue().Set(static_cast(getegid())); } static void SetGid(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); if (!args[0]->IsUint32() && !args[0]->IsString()) { return env->ThrowTypeError("setgid argument must be a number or a string"); } gid_t gid = gid_by_name(env->isolate(), args[0]); if (gid == gid_not_found) { return env->ThrowError("setgid group id does not exist"); } if (setgid(gid)) { return env->ThrowErrnoException(errno, "setgid"); } } static void SetEGid(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); if (!args[0]->IsUint32() && !args[0]->IsString()) { return env->ThrowTypeError("setegid argument must be a number or string"); } gid_t gid = gid_by_name(env->isolate(), args[0]); if (gid == gid_not_found) { return env->ThrowError("setegid group id does not exist"); } if (setegid(gid)) { return env->ThrowErrnoException(errno, "setegid"); } } static void SetUid(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); if (!args[0]->IsUint32() && !args[0]->IsString()) { return env->ThrowTypeError("setuid argument must be a number or a string"); } uid_t uid = uid_by_name(env->isolate(), args[0]); if (uid == uid_not_found) { return env->ThrowError("setuid user id does not exist"); } if (setuid(uid)) { return env->ThrowErrnoException(errno, "setuid"); } } static void SetEUid(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); if (!args[0]->IsUint32() && !args[0]->IsString()) { return env->ThrowTypeError("seteuid argument must be a number or string"); } uid_t uid = uid_by_name(env->isolate(), args[0]); if (uid == uid_not_found) { return env->ThrowError("seteuid user id does not exist"); } if (seteuid(uid)) { return env->ThrowErrnoException(errno, "seteuid"); } } static void GetGroups(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); int ngroups = getgroups(0, nullptr); if (ngroups == -1) { return env->ThrowErrnoException(errno, "getgroups"); } gid_t* groups = new gid_t[ngroups]; ngroups = getgroups(ngroups, groups); if (ngroups == -1) { delete[] groups; return env->ThrowErrnoException(errno, "getgroups"); } Local groups_list = Array::New(env->isolate(), ngroups); bool seen_egid = false; gid_t egid = getegid(); for (int i = 0; i < ngroups; i++) { groups_list->Set(i, Integer::New(env->isolate(), groups[i])); if (groups[i] == egid) seen_egid = true; } delete[] groups; if (seen_egid == false) { groups_list->Set(ngroups, Integer::New(env->isolate(), egid)); } args.GetReturnValue().Set(groups_list); } static void SetGroups(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); if (!args[0]->IsArray()) { return env->ThrowTypeError("argument 1 must be an array"); } Local groups_list = args[0].As(); size_t size = groups_list->Length(); gid_t* groups = new gid_t[size]; for (size_t i = 0; i < size; i++) { gid_t gid = gid_by_name(env->isolate(), groups_list->Get(i)); if (gid == gid_not_found) { delete[] groups; return env->ThrowError("group name not found"); } groups[i] = gid; } int rc = setgroups(size, groups); delete[] groups; if (rc == -1) { return env->ThrowErrnoException(errno, "setgroups"); } } static void InitGroups(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); if (!args[0]->IsUint32() && !args[0]->IsString()) { return env->ThrowTypeError("argument 1 must be a number or a string"); } if (!args[1]->IsUint32() && !args[1]->IsString()) { return env->ThrowTypeError("argument 2 must be a number or a string"); } node::Utf8Value arg0(env->isolate(), args[0]); gid_t extra_group; bool must_free; char* user; if (args[0]->IsUint32()) { user = name_by_uid(args[0]->Uint32Value()); must_free = true; } else { user = *arg0; must_free = false; } if (user == nullptr) { return env->ThrowError("initgroups user not found"); } extra_group = gid_by_name(env->isolate(), args[1]); if (extra_group == gid_not_found) { if (must_free) free(user); return env->ThrowError("initgroups extra group not found"); } int rc = initgroups(user, extra_group); if (must_free) { free(user); } if (rc) { return env->ThrowErrnoException(errno, "initgroups"); } } #endif // __POSIX__ && !defined(__ANDROID__) void Exit(const FunctionCallbackInfo& args) { exit(args[0]->Int32Value()); } static void Uptime(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); double uptime; uv_update_time(env->event_loop()); uptime = uv_now(env->event_loop()) - prog_start_time; args.GetReturnValue().Set(Number::New(env->isolate(), uptime / 1000)); } void MemoryUsage(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); size_t rss; int err = uv_resident_set_memory(&rss); if (err) { return env->ThrowUVException(err, "uv_resident_set_memory"); } // V8 memory usage HeapStatistics v8_heap_stats; env->isolate()->GetHeapStatistics(&v8_heap_stats); Local heap_total = Number::New(env->isolate(), v8_heap_stats.total_heap_size()); Local heap_used = Number::New(env->isolate(), v8_heap_stats.used_heap_size()); Local external_mem = Number::New(env->isolate(), env->isolate()->AdjustAmountOfExternalAllocatedMemory(0)); Local info = Object::New(env->isolate()); info->Set(env->rss_string(), Number::New(env->isolate(), rss)); info->Set(env->heap_total_string(), heap_total); info->Set(env->heap_used_string(), heap_used); info->Set(env->external_string(), external_mem); args.GetReturnValue().Set(info); } void Kill(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); if (args.Length() != 2) { return env->ThrowError("Bad argument."); } int pid = args[0]->Int32Value(); int sig = args[1]->Int32Value(); int err = uv_kill(pid, sig); args.GetReturnValue().Set(err); } // used in Hrtime() below #define NANOS_PER_SEC 1000000000 // Hrtime exposes libuv's uv_hrtime() high-resolution timer. // The value returned by uv_hrtime() is a 64-bit int representing nanoseconds, // so this function instead returns an Array with 2 entries representing seconds // and nanoseconds, to avoid any integer overflow possibility. // Pass in an Array from a previous hrtime() call to instead get a time diff. void Hrtime(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); uint64_t t = uv_hrtime(); if (args.Length() > 0) { // return a time diff tuple if (!args[0]->IsArray()) { return env->ThrowTypeError( "process.hrtime() only accepts an Array tuple."); } Local inArray = Local::Cast(args[0]); uint64_t seconds = inArray->Get(0)->Uint32Value(); uint64_t nanos = inArray->Get(1)->Uint32Value(); t -= (seconds * NANOS_PER_SEC) + nanos; } Local tuple = Array::New(env->isolate(), 2); tuple->Set(0, Integer::NewFromUnsigned(env->isolate(), t / NANOS_PER_SEC)); tuple->Set(1, Integer::NewFromUnsigned(env->isolate(), t % NANOS_PER_SEC)); args.GetReturnValue().Set(tuple); } // Microseconds in a second, as a float, used in CPUUsage() below #define MICROS_PER_SEC 1e6 // CPUUsage use libuv's uv_getrusage() this-process resource usage accessor, // to access ru_utime (user CPU time used) and ru_stime (system CPU time used), // which are uv_timeval_t structs (long tv_sec, long tv_usec). // Returns those values as Float64 microseconds in the elements of the array // passed to the function. void CPUUsage(const FunctionCallbackInfo& args) { uv_rusage_t rusage; // Call libuv to get the values we'll return. int err = uv_getrusage(&rusage); if (err) { // On error, return the strerror version of the error code. Local errmsg = OneByteString(args.GetIsolate(), uv_strerror(err)); args.GetReturnValue().Set(errmsg); return; } // Get the double array pointer from the Float64Array argument. CHECK(args[0]->IsFloat64Array()); Local array = args[0].As(); CHECK_EQ(array->Length(), 2); Local ab = array->Buffer(); double* fields = static_cast(ab->GetContents().Data()); // Set the Float64Array elements to be user / system values in microseconds. fields[0] = MICROS_PER_SEC * rusage.ru_utime.tv_sec + rusage.ru_utime.tv_usec; fields[1] = MICROS_PER_SEC * rusage.ru_stime.tv_sec + rusage.ru_stime.tv_usec; } extern "C" void node_module_register(void* m) { struct node_module* mp = reinterpret_cast(m); if (mp->nm_flags & NM_F_BUILTIN) { mp->nm_link = modlist_builtin; modlist_builtin = mp; } else if (!node_is_initialized) { // "Linked" modules are included as part of the node project. // Like builtins they are registered *before* node::Init runs. mp->nm_flags = NM_F_LINKED; mp->nm_link = modlist_linked; modlist_linked = mp; } else { modpending = mp; } } struct node_module* get_builtin_module(const char* name) { struct node_module* mp; for (mp = modlist_builtin; mp != nullptr; mp = mp->nm_link) { if (strcmp(mp->nm_modname, name) == 0) break; } CHECK(mp == nullptr || (mp->nm_flags & NM_F_BUILTIN) != 0); return (mp); } struct node_module* get_linked_module(const char* name) { struct node_module* mp; for (mp = modlist_linked; mp != nullptr; mp = mp->nm_link) { if (strcmp(mp->nm_modname, name) == 0) break; } CHECK(mp == nullptr || (mp->nm_flags & NM_F_LINKED) != 0); return mp; } // DLOpen is process.dlopen(module, filename). // Used to load 'module.node' dynamically shared objects. // // FIXME(bnoordhuis) Not multi-context ready. TBD how to resolve the conflict // when two contexts try to load the same shared object. Maybe have a shadow // cache that's a plain C list or hash table that's shared across contexts? void DLOpen(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); uv_lib_t lib; CHECK_EQ(modpending, nullptr); if (args.Length() != 2) { env->ThrowError("process.dlopen takes exactly 2 arguments."); return; } Local module = args[0]->ToObject(env->isolate()); // Cast node::Utf8Value filename(env->isolate(), args[1]); // Cast const bool is_dlopen_error = uv_dlopen(*filename, &lib); // Objects containing v14 or later modules will have registered themselves // on the pending list. Activate all of them now. At present, only one // module per object is supported. node_module* const mp = modpending; modpending = nullptr; if (is_dlopen_error) { Local errmsg = OneByteString(env->isolate(), uv_dlerror(&lib)); uv_dlclose(&lib); #ifdef _WIN32 // Windows needs to add the filename into the error message errmsg = String::Concat(errmsg, args[1]->ToString(env->isolate())); #endif // _WIN32 env->isolate()->ThrowException(Exception::Error(errmsg)); return; } if (mp == nullptr) { uv_dlclose(&lib); env->ThrowError("Module did not self-register."); return; } if (mp->nm_version != NODE_MODULE_VERSION) { char errmsg[1024]; snprintf(errmsg, sizeof(errmsg), "Module version mismatch. Expected %d, got %d.", NODE_MODULE_VERSION, mp->nm_version); // NOTE: `mp` is allocated inside of the shared library's memory, calling // `uv_dlclose` will deallocate it uv_dlclose(&lib); env->ThrowError(errmsg); return; } if (mp->nm_flags & NM_F_BUILTIN) { uv_dlclose(&lib); env->ThrowError("Built-in module self-registered."); return; } mp->nm_dso_handle = lib.handle; mp->nm_link = modlist_addon; modlist_addon = mp; Local exports_string = env->exports_string(); Local exports = module->Get(exports_string)->ToObject(env->isolate()); if (mp->nm_context_register_func != nullptr) { mp->nm_context_register_func(exports, module, env->context(), mp->nm_priv); } else if (mp->nm_register_func != nullptr) { mp->nm_register_func(exports, module, mp->nm_priv); } else { uv_dlclose(&lib); env->ThrowError("Module has no declared entry point."); return; } // Tell coverity that 'handle' should not be freed when we return. // coverity[leaked_storage] } static void OnFatalError(const char* location, const char* message) { if (location) { PrintErrorString("FATAL ERROR: %s %s\n", location, message); } else { PrintErrorString("FATAL ERROR: %s\n", message); } fflush(stderr); ABORT(); } NO_RETURN void FatalError(const char* location, const char* message) { OnFatalError(location, message); // to suppress compiler warning ABORT(); } void FatalException(Isolate* isolate, Local error, Local message) { HandleScope scope(isolate); Environment* env = Environment::GetCurrent(isolate); Local process_object = env->process_object(); Local fatal_exception_string = env->fatal_exception_string(); Local fatal_exception_function = process_object->Get(fatal_exception_string).As(); if (!fatal_exception_function->IsFunction()) { // failed before the process._fatalException function was added! // this is probably pretty bad. Nothing to do but report and exit. ReportException(env, error, message); exit(6); } TryCatch fatal_try_catch; // Do not call FatalException when _fatalException handler throws fatal_try_catch.SetVerbose(false); // this will return true if the JS layer handled it, false otherwise Local caught = fatal_exception_function->Call(process_object, 1, &error); if (fatal_try_catch.HasCaught()) { // the fatal exception function threw, so we must exit ReportException(env, fatal_try_catch); exit(7); } if (false == caught->BooleanValue()) { ReportException(env, error, message); exit(1); } } void FatalException(Isolate* isolate, const TryCatch& try_catch) { HandleScope scope(isolate); // TODO(bajtos) do not call FatalException if try_catch is verbose // (requires V8 API to expose getter for try_catch.is_verbose_) FatalException(isolate, try_catch.Exception(), try_catch.Message()); } void OnMessage(Local message, Local error) { // The current version of V8 sends messages for errors only // (thus `error` is always set). FatalException(Isolate::GetCurrent(), error, message); } void ClearFatalExceptionHandlers(Environment* env) { Local process = env->process_object(); Local events = process->Get(env->context(), env->events_string()).ToLocalChecked(); if (events->IsObject()) { events.As()->Set( env->context(), OneByteString(env->isolate(), "uncaughtException"), Undefined(env->isolate())).FromJust(); } process->Set( env->context(), env->domain_string(), Undefined(env->isolate())).FromJust(); } static void Binding(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); Local module = args[0]->ToString(env->isolate()); node::Utf8Value module_v(env->isolate(), module); Local cache = env->binding_cache_object(); Local exports; if (cache->Has(module)) { exports = cache->Get(module)->ToObject(env->isolate()); args.GetReturnValue().Set(exports); return; } // Append a string to process.moduleLoadList char buf[1024]; snprintf(buf, sizeof(buf), "Binding %s", *module_v); Local modules = env->module_load_list_array(); uint32_t l = modules->Length(); modules->Set(l, OneByteString(env->isolate(), buf)); node_module* mod = get_builtin_module(*module_v); if (mod != nullptr) { exports = Object::New(env->isolate()); // Internal bindings don't have a "module" object, only exports. CHECK_EQ(mod->nm_register_func, nullptr); CHECK_NE(mod->nm_context_register_func, nullptr); Local unused = Undefined(env->isolate()); mod->nm_context_register_func(exports, unused, env->context(), mod->nm_priv); cache->Set(module, exports); } else if (!strcmp(*module_v, "constants")) { exports = Object::New(env->isolate()); DefineConstants(exports); cache->Set(module, exports); } else if (!strcmp(*module_v, "natives")) { exports = Object::New(env->isolate()); DefineJavaScript(env, exports); cache->Set(module, exports); } else { char errmsg[1024]; snprintf(errmsg, sizeof(errmsg), "No such module: %s", *module_v); return env->ThrowError(errmsg); } args.GetReturnValue().Set(exports); } static void LinkedBinding(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args.GetIsolate()); Local module = args[0]->ToString(env->isolate()); Local cache = env->binding_cache_object(); Local exports_v = cache->Get(module); if (exports_v->IsObject()) return args.GetReturnValue().Set(exports_v.As()); node::Utf8Value module_v(env->isolate(), module); node_module* mod = get_linked_module(*module_v); if (mod == nullptr) { char errmsg[1024]; snprintf(errmsg, sizeof(errmsg), "No such module was linked: %s", *module_v); return env->ThrowError(errmsg); } Local exports = Object::New(env->isolate()); if (mod->nm_context_register_func != nullptr) { mod->nm_context_register_func(exports, module, env->context(), mod->nm_priv); } else if (mod->nm_register_func != nullptr) { mod->nm_register_func(exports, module, mod->nm_priv); } else { return env->ThrowError("Linked module has no declared entry point."); } cache->Set(module, exports); args.GetReturnValue().Set(exports); } static void ProcessTitleGetter(Local property, const PropertyCallbackInfo& info) { char buffer[512]; uv_get_process_title(buffer, sizeof(buffer)); info.GetReturnValue().Set(String::NewFromUtf8(info.GetIsolate(), buffer)); } static void ProcessTitleSetter(Local property, Local value, const PropertyCallbackInfo& info) { node::Utf8Value title(info.GetIsolate(), value); // TODO(piscisaureus): protect with a lock uv_set_process_title(*title); } static void EnvGetter(Local property, const PropertyCallbackInfo& info) { Isolate* isolate = info.GetIsolate(); #ifdef __POSIX__ node::Utf8Value key(isolate, property); const char* val = getenv(*key); if (val) { return info.GetReturnValue().Set(String::NewFromUtf8(isolate, val)); } #else // _WIN32 String::Value key(property); WCHAR buffer[32767]; // The maximum size allowed for environment variables. DWORD result = GetEnvironmentVariableW(reinterpret_cast(*key), buffer, arraysize(buffer)); // If result >= sizeof buffer the buffer was too small. That should never // happen. If result == 0 and result != ERROR_SUCCESS the variable was not // not found. if ((result > 0 || GetLastError() == ERROR_SUCCESS) && result < arraysize(buffer)) { const uint16_t* two_byte_buffer = reinterpret_cast(buffer); Local rc = String::NewFromTwoByte(isolate, two_byte_buffer); return info.GetReturnValue().Set(rc); } #endif } static void EnvSetter(Local property, Local value, const PropertyCallbackInfo& info) { #ifdef __POSIX__ node::Utf8Value key(info.GetIsolate(), property); node::Utf8Value val(info.GetIsolate(), value); setenv(*key, *val, 1); #else // _WIN32 String::Value key(property); String::Value val(value); WCHAR* key_ptr = reinterpret_cast(*key); // Environment variables that start with '=' are read-only. if (key_ptr[0] != L'=') { SetEnvironmentVariableW(key_ptr, reinterpret_cast(*val)); } #endif // Whether it worked or not, always return value. info.GetReturnValue().Set(value); } static void EnvQuery(Local property, const PropertyCallbackInfo& info) { int32_t rc = -1; // Not found unless proven otherwise. #ifdef __POSIX__ node::Utf8Value key(info.GetIsolate(), property); if (getenv(*key)) rc = 0; #else // _WIN32 String::Value key(property); WCHAR* key_ptr = reinterpret_cast(*key); if (GetEnvironmentVariableW(key_ptr, nullptr, 0) > 0 || GetLastError() == ERROR_SUCCESS) { rc = 0; if (key_ptr[0] == L'=') { // Environment variables that start with '=' are hidden and read-only. rc = static_cast(v8::ReadOnly) | static_cast(v8::DontDelete) | static_cast(v8::DontEnum); } } #endif if (rc != -1) info.GetReturnValue().Set(rc); } static void EnvDeleter(Local property, const PropertyCallbackInfo& info) { bool rc = true; #ifdef __POSIX__ node::Utf8Value key(info.GetIsolate(), property); rc = getenv(*key) != nullptr; if (rc) unsetenv(*key); #else String::Value key(property); WCHAR* key_ptr = reinterpret_cast(*key); if (key_ptr[0] == L'=' || !SetEnvironmentVariableW(key_ptr, nullptr)) { // Deletion failed. Return true if the key wasn't there in the first place, // false if it is still there. rc = GetEnvironmentVariableW(key_ptr, nullptr, 0) == 0 && GetLastError() != ERROR_SUCCESS; } #endif info.GetReturnValue().Set(rc); } static void EnvEnumerator(const PropertyCallbackInfo& info) { Isolate* isolate = info.GetIsolate(); #ifdef __POSIX__ int size = 0; while (environ[size]) size++; Local envarr = Array::New(isolate, size); for (int i = 0; i < size; ++i) { const char* var = environ[i]; const char* s = strchr(var, '='); const int length = s ? s - var : strlen(var); Local name = String::NewFromUtf8(isolate, var, String::kNormalString, length); envarr->Set(i, name); } #else // _WIN32 WCHAR* environment = GetEnvironmentStringsW(); if (environment == nullptr) return; // This should not happen. Local envarr = Array::New(isolate); WCHAR* p = environment; int i = 0; while (*p) { WCHAR *s; if (*p == L'=') { // If the key starts with '=' it is a hidden environment variable. p += wcslen(p) + 1; continue; } else { s = wcschr(p, L'='); } if (!s) { s = p + wcslen(p); } const uint16_t* two_byte_buffer = reinterpret_cast(p); const size_t two_byte_buffer_len = s - p; Local value = String::NewFromTwoByte(isolate, two_byte_buffer, String::kNormalString, two_byte_buffer_len); envarr->Set(i++, value); p = s + wcslen(s) + 1; } FreeEnvironmentStringsW(environment); #endif info.GetReturnValue().Set(envarr); } static Local GetFeatures(Environment* env) { EscapableHandleScope scope(env->isolate()); Local obj = Object::New(env->isolate()); #if defined(DEBUG) && DEBUG Local debug = True(env->isolate()); #else Local debug = False(env->isolate()); #endif // defined(DEBUG) && DEBUG obj->Set(env->debug_string(), debug); obj->Set(env->uv_string(), True(env->isolate())); // TODO(bnoordhuis) ping libuv obj->Set(env->ipv6_lc_string(), True(env->isolate())); #ifdef OPENSSL_NPN_NEGOTIATED Local tls_npn = True(env->isolate()); #else Local tls_npn = False(env->isolate()); #endif obj->Set(env->tls_npn_string(), tls_npn); #ifdef TLSEXT_TYPE_application_layer_protocol_negotiation Local tls_alpn = True(env->isolate()); #else Local tls_alpn = False(env->isolate()); #endif obj->Set(env->tls_alpn_string(), tls_alpn); #ifdef SSL_CTRL_SET_TLSEXT_SERVERNAME_CB Local tls_sni = True(env->isolate()); #else Local tls_sni = False(env->isolate()); #endif obj->Set(env->tls_sni_string(), tls_sni); #if !defined(OPENSSL_NO_TLSEXT) && defined(SSL_CTX_set_tlsext_status_cb) Local tls_ocsp = True(env->isolate()); #else Local tls_ocsp = False(env->isolate()); #endif // !defined(OPENSSL_NO_TLSEXT) && defined(SSL_CTX_set_tlsext_status_cb) obj->Set(env->tls_ocsp_string(), tls_ocsp); obj->Set(env->tls_string(), Boolean::New(env->isolate(), get_builtin_module("crypto") != nullptr)); return scope.Escape(obj); } static void DebugPortGetter(Local property, const PropertyCallbackInfo& info) { info.GetReturnValue().Set(debug_port); } static void DebugPortSetter(Local property, Local value, const PropertyCallbackInfo& info) { debug_port = value->Int32Value(); } static void DebugProcess(const FunctionCallbackInfo& args); static void DebugPause(const FunctionCallbackInfo& args); static void DebugEnd(const FunctionCallbackInfo& args); void NeedImmediateCallbackGetter(Local property, const PropertyCallbackInfo& info) { Environment* env = Environment::GetCurrent(info); const uv_check_t* immediate_check_handle = env->immediate_check_handle(); bool active = uv_is_active( reinterpret_cast(immediate_check_handle)); info.GetReturnValue().Set(active); } static void NeedImmediateCallbackSetter( Local property, Local value, const PropertyCallbackInfo& info) { Environment* env = Environment::GetCurrent(info); uv_check_t* immediate_check_handle = env->immediate_check_handle(); bool active = uv_is_active( reinterpret_cast(immediate_check_handle)); if (active == value->BooleanValue()) return; uv_idle_t* immediate_idle_handle = env->immediate_idle_handle(); if (active) { uv_check_stop(immediate_check_handle); uv_idle_stop(immediate_idle_handle); } else { uv_check_start(immediate_check_handle, CheckImmediate); // Idle handle is needed only to stop the event loop from blocking in poll. uv_idle_start(immediate_idle_handle, IdleImmediateDummy); } } void SetIdle(uv_prepare_t* handle) { Environment* env = Environment::from_idle_prepare_handle(handle); env->isolate()->GetCpuProfiler()->SetIdle(true); } void ClearIdle(uv_check_t* handle) { Environment* env = Environment::from_idle_check_handle(handle); env->isolate()->GetCpuProfiler()->SetIdle(false); } void StartProfilerIdleNotifier(Environment* env) { uv_prepare_start(env->idle_prepare_handle(), SetIdle); uv_check_start(env->idle_check_handle(), ClearIdle); } void StopProfilerIdleNotifier(Environment* env) { uv_prepare_stop(env->idle_prepare_handle()); uv_check_stop(env->idle_check_handle()); } void StartProfilerIdleNotifier(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); StartProfilerIdleNotifier(env); } void StopProfilerIdleNotifier(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); StopProfilerIdleNotifier(env); } #define READONLY_PROPERTY(obj, str, var) \ do { \ obj->ForceSet(OneByteString(env->isolate(), str), var, v8::ReadOnly); \ } while (0) #define READONLY_DONT_ENUM_PROPERTY(obj, str, var) \ do { \ obj->ForceSet(OneByteString(env->isolate(), str), \ var, \ static_cast(v8::ReadOnly | \ v8::DontEnum)); \ } while (0) void SetupProcessObject(Environment* env, int argc, const char* const* argv, int exec_argc, const char* const* exec_argv) { HandleScope scope(env->isolate()); Local process = env->process_object(); process->SetAccessor(env->title_string(), ProcessTitleGetter, ProcessTitleSetter, env->as_external()); // process.version READONLY_PROPERTY(process, "version", FIXED_ONE_BYTE_STRING(env->isolate(), NODE_VERSION)); // process.moduleLoadList READONLY_PROPERTY(process, "moduleLoadList", env->module_load_list_array()); // process.versions Local versions = Object::New(env->isolate()); READONLY_PROPERTY(process, "versions", versions); const char http_parser_version[] = NODE_STRINGIFY(HTTP_PARSER_VERSION_MAJOR) "." NODE_STRINGIFY(HTTP_PARSER_VERSION_MINOR) "." NODE_STRINGIFY(HTTP_PARSER_VERSION_PATCH); READONLY_PROPERTY(versions, "http_parser", FIXED_ONE_BYTE_STRING(env->isolate(), http_parser_version)); // +1 to get rid of the leading 'v' READONLY_PROPERTY(versions, "node", OneByteString(env->isolate(), NODE_VERSION + 1)); READONLY_PROPERTY(versions, "v8", OneByteString(env->isolate(), V8::GetVersion())); READONLY_PROPERTY(versions, "uv", OneByteString(env->isolate(), uv_version_string())); READONLY_PROPERTY(versions, "zlib", FIXED_ONE_BYTE_STRING(env->isolate(), ZLIB_VERSION)); READONLY_PROPERTY(versions, "ares", FIXED_ONE_BYTE_STRING(env->isolate(), ARES_VERSION_STR)); #if defined(NODE_HAVE_I18N_SUPPORT) && defined(U_ICU_VERSION) READONLY_PROPERTY(versions, "icu", OneByteString(env->isolate(), U_ICU_VERSION)); if (icu_data_dir != nullptr) { // Did the user attempt (via env var or parameter) to set an ICU path? READONLY_PROPERTY(process, "icu_data_dir", OneByteString(env->isolate(), icu_data_dir)); } #endif const char node_modules_version[] = NODE_STRINGIFY(NODE_MODULE_VERSION); READONLY_PROPERTY( versions, "modules", FIXED_ONE_BYTE_STRING(env->isolate(), node_modules_version)); // process._promiseRejectEvent Local promiseRejectEvent = Object::New(env->isolate()); READONLY_DONT_ENUM_PROPERTY(process, "_promiseRejectEvent", promiseRejectEvent); READONLY_PROPERTY(promiseRejectEvent, "unhandled", Integer::New(env->isolate(), v8::kPromiseRejectWithNoHandler)); READONLY_PROPERTY(promiseRejectEvent, "handled", Integer::New(env->isolate(), v8::kPromiseHandlerAddedAfterReject)); #if HAVE_OPENSSL // Stupid code to slice out the version string. { // NOLINT(whitespace/braces) size_t i, j, k; int c; for (i = j = 0, k = sizeof(OPENSSL_VERSION_TEXT) - 1; i < k; ++i) { c = OPENSSL_VERSION_TEXT[i]; if ('0' <= c && c <= '9') { for (j = i + 1; j < k; ++j) { c = OPENSSL_VERSION_TEXT[j]; if (c == ' ') break; } break; } } READONLY_PROPERTY( versions, "openssl", OneByteString(env->isolate(), &OPENSSL_VERSION_TEXT[i], j - i)); } #endif // process.arch READONLY_PROPERTY(process, "arch", OneByteString(env->isolate(), NODE_ARCH)); // process.platform READONLY_PROPERTY(process, "platform", OneByteString(env->isolate(), NODE_PLATFORM)); // process.release Local release = Object::New(env->isolate()); READONLY_PROPERTY(process, "release", release); READONLY_PROPERTY(release, "name", OneByteString(env->isolate(), "node")); #if NODE_VERSION_IS_LTS READONLY_PROPERTY(release, "lts", OneByteString(env->isolate(), NODE_VERSION_LTS_CODENAME)); #endif // if this is a release build and no explicit base has been set // substitute the standard release download URL #ifndef NODE_RELEASE_URLBASE # if NODE_VERSION_IS_RELEASE # define NODE_RELEASE_URLBASE "https://nodejs.org/download/release/" # endif #endif #if defined(NODE_RELEASE_URLBASE) # define NODE_RELEASE_URLPFX NODE_RELEASE_URLBASE "v" NODE_VERSION_STRING "/" # define NODE_RELEASE_URLFPFX NODE_RELEASE_URLPFX "node-v" NODE_VERSION_STRING READONLY_PROPERTY(release, "sourceUrl", OneByteString(env->isolate(), NODE_RELEASE_URLFPFX ".tar.gz")); READONLY_PROPERTY(release, "headersUrl", OneByteString(env->isolate(), NODE_RELEASE_URLFPFX "-headers.tar.gz")); # ifdef _WIN32 READONLY_PROPERTY(release, "libUrl", OneByteString(env->isolate(), strcmp(NODE_ARCH, "ia32") ? NODE_RELEASE_URLPFX "win-" NODE_ARCH "/node.lib" : NODE_RELEASE_URLPFX "win-x86/node.lib")); # endif #endif // process.argv Local arguments = Array::New(env->isolate(), argc); for (int i = 0; i < argc; ++i) { arguments->Set(i, String::NewFromUtf8(env->isolate(), argv[i])); } process->Set(env->argv_string(), arguments); // process.execArgv Local exec_arguments = Array::New(env->isolate(), exec_argc); for (int i = 0; i < exec_argc; ++i) { exec_arguments->Set(i, String::NewFromUtf8(env->isolate(), exec_argv[i])); } process->Set(env->exec_argv_string(), exec_arguments); // create process.env Local process_env_template = ObjectTemplate::New(env->isolate()); process_env_template->SetNamedPropertyHandler(EnvGetter, EnvSetter, EnvQuery, EnvDeleter, EnvEnumerator, env->as_external()); Local process_env = process_env_template->NewInstance(); process->Set(env->env_string(), process_env); READONLY_PROPERTY(process, "pid", Integer::New(env->isolate(), getpid())); READONLY_PROPERTY(process, "features", GetFeatures(env)); process->SetAccessor(env->need_imm_cb_string(), NeedImmediateCallbackGetter, NeedImmediateCallbackSetter, env->as_external()); // -e, --eval if (eval_string) { READONLY_PROPERTY(process, "_eval", String::NewFromUtf8(env->isolate(), eval_string)); } // -p, --print if (print_eval) { READONLY_PROPERTY(process, "_print_eval", True(env->isolate())); } // -c, --check if (syntax_check_only) { READONLY_PROPERTY(process, "_syntax_check_only", True(env->isolate())); } // -i, --interactive if (force_repl) { READONLY_PROPERTY(process, "_forceRepl", True(env->isolate())); } if (preload_module_count) { CHECK(preload_modules); Local array = Array::New(env->isolate()); for (unsigned int i = 0; i < preload_module_count; ++i) { Local module = String::NewFromUtf8(env->isolate(), preload_modules[i]); array->Set(i, module); } READONLY_PROPERTY(process, "_preload_modules", array); delete[] preload_modules; preload_modules = nullptr; preload_module_count = 0; } // --no-deprecation if (no_deprecation) { READONLY_PROPERTY(process, "noDeprecation", True(env->isolate())); } // --throw-deprecation if (throw_deprecation) { READONLY_PROPERTY(process, "throwDeprecation", True(env->isolate())); } // --prof-process if (prof_process) { READONLY_PROPERTY(process, "profProcess", True(env->isolate())); } // --trace-deprecation if (trace_deprecation) { READONLY_PROPERTY(process, "traceDeprecation", True(env->isolate())); } // --security-revert flags #define V(code, _, __) \ do { \ if (IsReverted(REVERT_ ## code)) { \ READONLY_PROPERTY(process, "REVERT_" #code, True(env->isolate())); \ } \ } while (0); REVERSIONS(V) #undef V size_t exec_path_len = 2 * PATH_MAX; char* exec_path = new char[exec_path_len]; Local exec_path_value; if (uv_exepath(exec_path, &exec_path_len) == 0) { exec_path_value = String::NewFromUtf8(env->isolate(), exec_path, String::kNormalString, exec_path_len); } else { exec_path_value = String::NewFromUtf8(env->isolate(), argv[0]); } process->Set(env->exec_path_string(), exec_path_value); delete[] exec_path; process->SetAccessor(env->debug_port_string(), DebugPortGetter, DebugPortSetter, env->as_external()); // define various internal methods env->SetMethod(process, "_startProfilerIdleNotifier", StartProfilerIdleNotifier); env->SetMethod(process, "_stopProfilerIdleNotifier", StopProfilerIdleNotifier); env->SetMethod(process, "_getActiveRequests", GetActiveRequests); env->SetMethod(process, "_getActiveHandles", GetActiveHandles); env->SetMethod(process, "reallyExit", Exit); env->SetMethod(process, "abort", Abort); env->SetMethod(process, "chdir", Chdir); env->SetMethod(process, "cwd", Cwd); env->SetMethod(process, "umask", Umask); #if defined(__POSIX__) && !defined(__ANDROID__) env->SetMethod(process, "getuid", GetUid); env->SetMethod(process, "geteuid", GetEUid); env->SetMethod(process, "setuid", SetUid); env->SetMethod(process, "seteuid", SetEUid); env->SetMethod(process, "setgid", SetGid); env->SetMethod(process, "setegid", SetEGid); env->SetMethod(process, "getgid", GetGid); env->SetMethod(process, "getegid", GetEGid); env->SetMethod(process, "getgroups", GetGroups); env->SetMethod(process, "setgroups", SetGroups); env->SetMethod(process, "initgroups", InitGroups); #endif // __POSIX__ && !defined(__ANDROID__) env->SetMethod(process, "_kill", Kill); env->SetMethod(process, "_debugProcess", DebugProcess); env->SetMethod(process, "_debugPause", DebugPause); env->SetMethod(process, "_debugEnd", DebugEnd); env->SetMethod(process, "hrtime", Hrtime); env->SetMethod(process, "cpuUsage", CPUUsage); env->SetMethod(process, "dlopen", DLOpen); env->SetMethod(process, "uptime", Uptime); env->SetMethod(process, "memoryUsage", MemoryUsage); env->SetMethod(process, "binding", Binding); env->SetMethod(process, "_linkedBinding", LinkedBinding); env->SetMethod(process, "_setupNextTick", SetupNextTick); env->SetMethod(process, "_setupPromises", SetupPromises); env->SetMethod(process, "_setupDomainUse", SetupDomainUse); // pre-set _events object for faster emit checks process->Set(env->events_string(), Object::New(env->isolate())); } #undef READONLY_PROPERTY static void AtExit() { uv_tty_reset_mode(); } static void SignalExit(int signo) { uv_tty_reset_mode(); #ifdef __FreeBSD__ // FreeBSD has a nasty bug, see RegisterSignalHandler for details struct sigaction sa; memset(&sa, 0, sizeof(sa)); sa.sa_handler = SIG_DFL; CHECK_EQ(sigaction(signo, &sa, nullptr), 0); #endif raise(signo); } // Most of the time, it's best to use `console.error` to write // to the process.stderr stream. However, in some cases, such as // when debugging the stream.Writable class or the process.nextTick // function, it is useful to bypass JavaScript entirely. static void RawDebug(const FunctionCallbackInfo& args) { CHECK(args.Length() == 1 && args[0]->IsString() && "must be called with a single string"); node::Utf8Value message(args.GetIsolate(), args[0]); PrintErrorString("%s\n", *message); fflush(stderr); } void LoadEnvironment(Environment* env) { HandleScope handle_scope(env->isolate()); env->isolate()->SetFatalErrorHandler(node::OnFatalError); env->isolate()->AddMessageListener(OnMessage); // Compile, execute the src/node.js file. (Which was included as static C // string in node_natives.h. 'native_node' is the string containing that // source code.) // The node.js file returns a function 'f' atexit(AtExit); TryCatch try_catch; // Disable verbose mode to stop FatalException() handler from trying // to handle the exception. Errors this early in the start-up phase // are not safe to ignore. try_catch.SetVerbose(false); Local script_name = FIXED_ONE_BYTE_STRING(env->isolate(), "node.js"); Local f_value = ExecuteString(env, MainSource(env), script_name); if (try_catch.HasCaught()) { ReportException(env, try_catch); exit(10); } CHECK(f_value->IsFunction()); Local f = Local::Cast(f_value); // Now we call 'f' with the 'process' variable that we've built up with // all our bindings. Inside node.js we'll take care of assigning things to // their places. // We start the process this way in order to be more modular. Developers // who do not like how 'src/node.js' setups the module system but do like // Node's I/O bindings may want to replace 'f' with their own function. // Add a reference to the global object Local global = env->context()->Global(); #if defined HAVE_DTRACE || defined HAVE_ETW InitDTrace(env, global); #endif #if defined HAVE_LTTNG InitLTTNG(env, global); #endif #if defined HAVE_PERFCTR InitPerfCounters(env, global); #endif // Enable handling of uncaught exceptions // (FatalException(), break on uncaught exception in debugger) // // This is not strictly necessary since it's almost impossible // to attach the debugger fast enought to break on exception // thrown during process startup. try_catch.SetVerbose(true); env->SetMethod(env->process_object(), "_rawDebug", RawDebug); Local arg = env->process_object(); f->Call(global, 1, &arg); } void FreeEnvironment(Environment* env) { CHECK_NE(env, nullptr); env->Dispose(); } static void PrintHelp(); static bool ParseDebugOpt(const char* arg) { const char* port = nullptr; if (!strcmp(arg, "--debug")) { use_debug_agent = true; } else if (!strncmp(arg, "--debug=", sizeof("--debug=") - 1)) { use_debug_agent = true; port = arg + sizeof("--debug=") - 1; } else if (!strcmp(arg, "--debug-brk")) { use_debug_agent = true; debug_wait_connect = true; } else if (!strncmp(arg, "--debug-brk=", sizeof("--debug-brk=") - 1)) { use_debug_agent = true; debug_wait_connect = true; port = arg + sizeof("--debug-brk=") - 1; } else if (!strncmp(arg, "--debug-port=", sizeof("--debug-port=") - 1)) { // XXX(bnoordhuis) Misnomer, configures port and listen address. port = arg + sizeof("--debug-port=") - 1; } else { return false; } if (port == nullptr) { return true; } std::string* const the_host = &debug_host; int* const the_port = &debug_port; // FIXME(bnoordhuis) Move IPv6 address parsing logic to lib/net.js. // It seems reasonable to support [address]:port notation // in net.Server#listen() and net.Socket#connect(). const size_t port_len = strlen(port); if (port[0] == '[' && port[port_len - 1] == ']') { the_host->assign(port + 1, port_len - 2); return true; } const char* const colon = strrchr(port, ':'); if (colon == nullptr) { // Either a port number or a host name. Assume that // if it's not all decimal digits, it's a host name. for (size_t n = 0; port[n] != '\0'; n += 1) { if (port[n] < '0' || port[n] > '9') { *the_host = port; return true; } } } else { const bool skip = (colon > port && port[0] == '[' && colon[-1] == ']'); the_host->assign(port + skip, colon - skip); } char* endptr; errno = 0; const char* const digits = colon != nullptr ? colon + 1 : port; const long result = strtol(digits, &endptr, 10); // NOLINT(runtime/int) if (errno != 0 || *endptr != '\0' || result < 1024 || result > 65535) { fprintf(stderr, "Debug port must be in range 1024 to 65535.\n"); PrintHelp(); exit(12); } *the_port = static_cast(result); return true; } static void PrintHelp() { // XXX: If you add an option here, please also add it to doc/node.1 and // doc/api/cli.md printf("Usage: node [options] [ -e script | script.js ] [arguments] \n" " node debug script.js [arguments] \n" "\n" "Options:\n" " -v, --version print Node.js version\n" " -e, --eval script evaluate script\n" " -p, --print evaluate script and print result\n" " -c, --check syntax check script without executing\n" " -i, --interactive always enter the REPL even if stdin\n" " does not appear to be a terminal\n" " -r, --require module to preload (option can be repeated)\n" " --no-deprecation silence deprecation warnings\n" " --trace-deprecation show stack traces on deprecations\n" " --throw-deprecation throw an exception anytime a deprecated " "function is used\n" " --trace-sync-io show stack trace when use of sync IO\n" " is detected after the first tick\n" " --track-heap-objects track heap object allocations for heap " "snapshots\n" " --prof-process process v8 profiler output generated\n" " using --prof\n" " --zero-fill-buffers automatically zero-fill all newly allocated\n" " Buffer and SlowBuffer instances\n" " --v8-options print v8 command line options\n" #if HAVE_OPENSSL " --tls-cipher-list=val use an alternative default TLS cipher list\n" #endif #if defined(NODE_HAVE_I18N_SUPPORT) " --icu-data-dir=dir set ICU data load path to dir\n" " (overrides NODE_ICU_DATA)\n" #if !defined(NODE_HAVE_SMALL_ICU) " note: linked-in ICU data is\n" " present.\n" #endif #endif "\n" "Environment variables:\n" #ifdef _WIN32 "NODE_PATH ';'-separated list of directories\n" #else "NODE_PATH ':'-separated list of directories\n" #endif " prefixed to the module search path.\n" "NODE_DISABLE_COLORS set to 1 to disable colors in the REPL\n" #if defined(NODE_HAVE_I18N_SUPPORT) "NODE_ICU_DATA data path for ICU (Intl object) data\n" #if !defined(NODE_HAVE_SMALL_ICU) " (will extend linked-in data)\n" #endif #endif "NODE_REPL_HISTORY path to the persistent REPL history file\n" "\n" "Documentation can be found at https://nodejs.org/\n"); } // Parse command line arguments. // // argv is modified in place. exec_argv and v8_argv are out arguments that // ParseArgs() allocates memory for and stores a pointer to the output // vector in. The caller should free them with delete[]. // // On exit: // // * argv contains the arguments with node and V8 options filtered out. // * exec_argv contains both node and V8 options and nothing else. // * v8_argv contains argv[0] plus any V8 options static void ParseArgs(int* argc, const char** argv, int* exec_argc, const char*** exec_argv, int* v8_argc, const char*** v8_argv) { const unsigned int nargs = static_cast(*argc); const char** new_exec_argv = new const char*[nargs]; const char** new_v8_argv = new const char*[nargs]; const char** new_argv = new const char*[nargs]; const char** local_preload_modules = new const char*[nargs]; for (unsigned int i = 0; i < nargs; ++i) { new_exec_argv[i] = nullptr; new_v8_argv[i] = nullptr; new_argv[i] = nullptr; local_preload_modules[i] = nullptr; } // exec_argv starts with the first option, the other two start with argv[0]. unsigned int new_exec_argc = 0; unsigned int new_v8_argc = 1; unsigned int new_argc = 1; new_v8_argv[0] = argv[0]; new_argv[0] = argv[0]; unsigned int index = 1; bool short_circuit = false; while (index < nargs && argv[index][0] == '-' && !short_circuit) { const char* const arg = argv[index]; unsigned int args_consumed = 1; if (ParseDebugOpt(arg)) { // Done, consumed by ParseDebugOpt(). } else if (strcmp(arg, "--version") == 0 || strcmp(arg, "-v") == 0) { printf("%s\n", NODE_VERSION); exit(0); } else if (strcmp(arg, "--help") == 0 || strcmp(arg, "-h") == 0) { PrintHelp(); exit(0); } else if (strcmp(arg, "--eval") == 0 || strcmp(arg, "-e") == 0 || strcmp(arg, "--print") == 0 || strcmp(arg, "-pe") == 0 || strcmp(arg, "-p") == 0) { bool is_eval = strchr(arg, 'e') != nullptr; bool is_print = strchr(arg, 'p') != nullptr; print_eval = print_eval || is_print; // --eval, -e and -pe always require an argument. if (is_eval == true) { args_consumed += 1; eval_string = argv[index + 1]; if (eval_string == nullptr) { fprintf(stderr, "%s: %s requires an argument\n", argv[0], arg); exit(9); } } else if ((index + 1 < nargs) && argv[index + 1] != nullptr && argv[index + 1][0] != '-') { args_consumed += 1; eval_string = argv[index + 1]; if (strncmp(eval_string, "\\-", 2) == 0) { // Starts with "\\-": escaped expression, drop the backslash. eval_string += 1; } } } else if (strcmp(arg, "--require") == 0 || strcmp(arg, "-r") == 0) { const char* module = argv[index + 1]; if (module == nullptr) { fprintf(stderr, "%s: %s requires an argument\n", argv[0], arg); exit(9); } args_consumed += 1; local_preload_modules[preload_module_count++] = module; } else if (strcmp(arg, "--check") == 0 || strcmp(arg, "-c") == 0) { syntax_check_only = true; } else if (strcmp(arg, "--interactive") == 0 || strcmp(arg, "-i") == 0) { force_repl = true; } else if (strcmp(arg, "--no-deprecation") == 0) { no_deprecation = true; } else if (strcmp(arg, "--trace-deprecation") == 0) { trace_deprecation = true; } else if (strcmp(arg, "--trace-sync-io") == 0) { trace_sync_io = true; } else if (strcmp(arg, "--track-heap-objects") == 0) { track_heap_objects = true; } else if (strcmp(arg, "--throw-deprecation") == 0) { throw_deprecation = true; } else if (strncmp(arg, "--security-revert=", 18) == 0) { const char* cve = arg + 18; Revert(cve); } else if (strcmp(arg, "--prof-process") == 0) { prof_process = true; short_circuit = true; } else if (strcmp(arg, "--zero-fill-buffers") == 0) { zero_fill_all_buffers = true; } else if (strcmp(arg, "--v8-options") == 0) { new_v8_argv[new_v8_argc] = "--help"; new_v8_argc += 1; #if HAVE_OPENSSL } else if (strncmp(arg, "--tls-cipher-list=", 18) == 0) { default_cipher_list = arg + 18; #endif #if defined(NODE_HAVE_I18N_SUPPORT) } else if (strncmp(arg, "--icu-data-dir=", 15) == 0) { icu_data_dir = arg + 15; #endif } else if (strcmp(arg, "--expose-internals") == 0 || strcmp(arg, "--expose_internals") == 0) { // consumed in js } else { // V8 option. Pass through as-is. new_v8_argv[new_v8_argc] = arg; new_v8_argc += 1; } memcpy(new_exec_argv + new_exec_argc, argv + index, args_consumed * sizeof(*argv)); new_exec_argc += args_consumed; index += args_consumed; } // Copy remaining arguments. const unsigned int args_left = nargs - index; memcpy(new_argv + new_argc, argv + index, args_left * sizeof(*argv)); new_argc += args_left; *exec_argc = new_exec_argc; *exec_argv = new_exec_argv; *v8_argc = new_v8_argc; *v8_argv = new_v8_argv; // Copy new_argv over argv and update argc. memcpy(argv, new_argv, new_argc * sizeof(*argv)); delete[] new_argv; *argc = static_cast(new_argc); // Copy the preload_modules from the local array to an appropriately sized // global array. if (preload_module_count > 0) { CHECK(!preload_modules); preload_modules = new const char*[preload_module_count]; memcpy(preload_modules, local_preload_modules, preload_module_count * sizeof(*preload_modules)); } delete[] local_preload_modules; } // Called from V8 Debug Agent TCP thread. static void DispatchMessagesDebugAgentCallback(Environment* env) { // TODO(indutny): move async handle to environment uv_async_send(&dispatch_debug_messages_async); } static void StartDebug(Environment* env, bool wait) { CHECK(!debugger_running); env->debugger_agent()->set_dispatch_handler( DispatchMessagesDebugAgentCallback); debugger_running = env->debugger_agent()->Start(debug_host, debug_port, wait); if (debugger_running == false) { fprintf(stderr, "Starting debugger on %s:%d failed\n", debug_host.c_str(), debug_port); fflush(stderr); return; } } // Called from the main thread. static void EnableDebug(Environment* env) { CHECK(debugger_running); // Send message to enable debug in workers HandleScope handle_scope(env->isolate()); Local message = Object::New(env->isolate()); message->Set(FIXED_ONE_BYTE_STRING(env->isolate(), "cmd"), FIXED_ONE_BYTE_STRING(env->isolate(), "NODE_DEBUG_ENABLED")); Local argv[] = { FIXED_ONE_BYTE_STRING(env->isolate(), "internalMessage"), message }; MakeCallback(env, env->process_object(), "emit", arraysize(argv), argv); // Enabled debugger, possibly making it wait on a semaphore env->debugger_agent()->Enable(); } // Called from an arbitrary thread. static void TryStartDebugger() { Mutex::ScopedLock scoped_lock(node_isolate_mutex); if (auto isolate = node_isolate) { v8::Debug::DebugBreak(isolate); uv_async_send(&dispatch_debug_messages_async); } } // Called from the main thread. static void DispatchDebugMessagesAsyncCallback(uv_async_t* handle) { Mutex::ScopedLock scoped_lock(node_isolate_mutex); if (auto isolate = node_isolate) { if (debugger_running == false) { fprintf(stderr, "Starting debugger agent.\n"); HandleScope scope(isolate); Environment* env = Environment::GetCurrent(isolate); Context::Scope context_scope(env->context()); StartDebug(env, false); EnableDebug(env); } Isolate::Scope isolate_scope(isolate); v8::Debug::ProcessDebugMessages(); } } #ifdef __POSIX__ static void EnableDebugSignalHandler(int signo) { uv_sem_post(&debug_semaphore); } static void RegisterSignalHandler(int signal, void (*handler)(int signal), bool reset_handler = false) { struct sigaction sa; memset(&sa, 0, sizeof(sa)); sa.sa_handler = handler; #ifndef __FreeBSD__ // FreeBSD has a nasty bug with SA_RESETHAND reseting the SA_SIGINFO, that is // in turn set for a libthr wrapper. This leads to a crash. // Work around the issue by manually setting SIG_DFL in the signal handler sa.sa_flags = reset_handler ? SA_RESETHAND : 0; #endif sigfillset(&sa.sa_mask); CHECK_EQ(sigaction(signal, &sa, nullptr), 0); } void DebugProcess(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); if (args.Length() != 1) { return env->ThrowError("Invalid number of arguments."); } pid_t pid; int r; pid = args[0]->IntegerValue(); r = kill(pid, SIGUSR1); if (r != 0) { return env->ThrowErrnoException(errno, "kill"); } } inline void* DebugSignalThreadMain(void* unused) { for (;;) { uv_sem_wait(&debug_semaphore); TryStartDebugger(); } return nullptr; } static int RegisterDebugSignalHandler() { // Start a watchdog thread for calling v8::Debug::DebugBreak() because // it's not safe to call directly from the signal handler, it can // deadlock with the thread it interrupts. CHECK_EQ(0, uv_sem_init(&debug_semaphore, 0)); pthread_attr_t attr; CHECK_EQ(0, pthread_attr_init(&attr)); // Don't shrink the thread's stack on FreeBSD. Said platform decided to // follow the pthreads specification to the letter rather than in spirit: // https://lists.freebsd.org/pipermail/freebsd-current/2014-March/048885.html #ifndef __FreeBSD__ CHECK_EQ(0, pthread_attr_setstacksize(&attr, PTHREAD_STACK_MIN)); #endif // __FreeBSD__ CHECK_EQ(0, pthread_attr_setdetachstate(&attr, PTHREAD_CREATE_DETACHED)); sigset_t sigmask; sigfillset(&sigmask); CHECK_EQ(0, pthread_sigmask(SIG_SETMASK, &sigmask, &sigmask)); pthread_t thread; const int err = pthread_create(&thread, &attr, DebugSignalThreadMain, nullptr); CHECK_EQ(0, pthread_sigmask(SIG_SETMASK, &sigmask, nullptr)); CHECK_EQ(0, pthread_attr_destroy(&attr)); if (err != 0) { fprintf(stderr, "node[%d]: pthread_create: %s\n", getpid(), strerror(err)); fflush(stderr); // Leave SIGUSR1 blocked. We don't install a signal handler, // receiving the signal would terminate the process. return -err; } RegisterSignalHandler(SIGUSR1, EnableDebugSignalHandler); // Unblock SIGUSR1. A pending SIGUSR1 signal will now be delivered. sigemptyset(&sigmask); sigaddset(&sigmask, SIGUSR1); CHECK_EQ(0, pthread_sigmask(SIG_UNBLOCK, &sigmask, nullptr)); return 0; } #endif // __POSIX__ #ifdef _WIN32 DWORD WINAPI EnableDebugThreadProc(void* arg) { TryStartDebugger(); return 0; } static int GetDebugSignalHandlerMappingName(DWORD pid, wchar_t* buf, size_t buf_len) { return _snwprintf(buf, buf_len, L"node-debug-handler-%u", pid); } static int RegisterDebugSignalHandler() { wchar_t mapping_name[32]; HANDLE mapping_handle; DWORD pid; LPTHREAD_START_ROUTINE* handler; pid = GetCurrentProcessId(); if (GetDebugSignalHandlerMappingName(pid, mapping_name, arraysize(mapping_name)) < 0) { return -1; } mapping_handle = CreateFileMappingW(INVALID_HANDLE_VALUE, nullptr, PAGE_READWRITE, 0, sizeof *handler, mapping_name); if (mapping_handle == nullptr) { return -1; } handler = reinterpret_cast( MapViewOfFile(mapping_handle, FILE_MAP_ALL_ACCESS, 0, 0, sizeof *handler)); if (handler == nullptr) { CloseHandle(mapping_handle); return -1; } *handler = EnableDebugThreadProc; UnmapViewOfFile(static_cast(handler)); return 0; } static void DebugProcess(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); Isolate* isolate = args.GetIsolate(); DWORD pid; HANDLE process = nullptr; HANDLE thread = nullptr; HANDLE mapping = nullptr; wchar_t mapping_name[32]; LPTHREAD_START_ROUTINE* handler = nullptr; if (args.Length() != 1) { env->ThrowError("Invalid number of arguments."); goto out; } pid = (DWORD) args[0]->IntegerValue(); process = OpenProcess(PROCESS_CREATE_THREAD | PROCESS_QUERY_INFORMATION | PROCESS_VM_OPERATION | PROCESS_VM_WRITE | PROCESS_VM_READ, FALSE, pid); if (process == nullptr) { isolate->ThrowException( WinapiErrnoException(isolate, GetLastError(), "OpenProcess")); goto out; } if (GetDebugSignalHandlerMappingName(pid, mapping_name, arraysize(mapping_name)) < 0) { env->ThrowErrnoException(errno, "sprintf"); goto out; } mapping = OpenFileMappingW(FILE_MAP_READ, FALSE, mapping_name); if (mapping == nullptr) { isolate->ThrowException(WinapiErrnoException(isolate, GetLastError(), "OpenFileMappingW")); goto out; } handler = reinterpret_cast( MapViewOfFile(mapping, FILE_MAP_READ, 0, 0, sizeof *handler)); if (handler == nullptr || *handler == nullptr) { isolate->ThrowException( WinapiErrnoException(isolate, GetLastError(), "MapViewOfFile")); goto out; } thread = CreateRemoteThread(process, nullptr, 0, *handler, nullptr, 0, nullptr); if (thread == nullptr) { isolate->ThrowException(WinapiErrnoException(isolate, GetLastError(), "CreateRemoteThread")); goto out; } // Wait for the thread to terminate if (WaitForSingleObject(thread, INFINITE) != WAIT_OBJECT_0) { isolate->ThrowException(WinapiErrnoException(isolate, GetLastError(), "WaitForSingleObject")); goto out; } out: if (process != nullptr) CloseHandle(process); if (thread != nullptr) CloseHandle(thread); if (handler != nullptr) UnmapViewOfFile(handler); if (mapping != nullptr) CloseHandle(mapping); } #endif // _WIN32 static void DebugPause(const FunctionCallbackInfo& args) { v8::Debug::DebugBreak(args.GetIsolate()); } static void DebugEnd(const FunctionCallbackInfo& args) { if (debugger_running) { Environment* env = Environment::GetCurrent(args); env->debugger_agent()->Stop(); debugger_running = false; } } inline void PlatformInit() { #ifdef __POSIX__ sigset_t sigmask; sigemptyset(&sigmask); sigaddset(&sigmask, SIGUSR1); const int err = pthread_sigmask(SIG_SETMASK, &sigmask, nullptr); // Make sure file descriptors 0-2 are valid before we start logging anything. for (int fd = STDIN_FILENO; fd <= STDERR_FILENO; fd += 1) { struct stat ignored; if (fstat(fd, &ignored) == 0) continue; // Anything but EBADF means something is seriously wrong. We don't // have to special-case EINTR, fstat() is not interruptible. if (errno != EBADF) ABORT(); if (fd != open("/dev/null", O_RDWR)) ABORT(); } CHECK_EQ(err, 0); #ifndef NODE_SHARED_MODE // Restore signal dispositions, the parent process may have changed them. struct sigaction act; memset(&act, 0, sizeof(act)); // The hard-coded upper limit is because NSIG is not very reliable; on Linux, // it evaluates to 32, 34 or 64, depending on whether RT signals are enabled. // Counting up to SIGRTMIN doesn't work for the same reason. for (unsigned nr = 1; nr < 32; nr += 1) { if (nr == SIGKILL || nr == SIGSTOP) continue; act.sa_handler = (nr == SIGPIPE) ? SIG_IGN : SIG_DFL; CHECK_EQ(0, sigaction(nr, &act, nullptr)); } #endif // !NODE_SHARED_MODE RegisterSignalHandler(SIGINT, SignalExit, true); RegisterSignalHandler(SIGTERM, SignalExit, true); // Raise the open file descriptor limit. struct rlimit lim; if (getrlimit(RLIMIT_NOFILE, &lim) == 0 && lim.rlim_cur != lim.rlim_max) { // Do a binary search for the limit. rlim_t min = lim.rlim_cur; rlim_t max = 1 << 20; // But if there's a defined upper bound, don't search, just set it. if (lim.rlim_max != RLIM_INFINITY) { min = lim.rlim_max; max = lim.rlim_max; } do { lim.rlim_cur = min + (max - min) / 2; if (setrlimit(RLIMIT_NOFILE, &lim)) { max = lim.rlim_cur; } else { min = lim.rlim_cur; } } while (min + 1 < max); } #endif // __POSIX__ } void Init(int* argc, const char** argv, int* exec_argc, const char*** exec_argv) { // Initialize prog_start_time to get relative uptime. prog_start_time = static_cast(uv_now(uv_default_loop())); // Make inherited handles noninheritable. uv_disable_stdio_inheritance(); // init async debug messages dispatching // Main thread uses uv_default_loop CHECK_EQ(0, uv_async_init(uv_default_loop(), &dispatch_debug_messages_async, DispatchDebugMessagesAsyncCallback)); uv_unref(reinterpret_cast(&dispatch_debug_messages_async)); #if defined(NODE_V8_OPTIONS) // Should come before the call to V8::SetFlagsFromCommandLine() // so the user can disable a flag --foo at run-time by passing // --no_foo from the command line. V8::SetFlagsFromString(NODE_V8_OPTIONS, sizeof(NODE_V8_OPTIONS) - 1); #endif // Parse a few arguments which are specific to Node. int v8_argc; const char** v8_argv; ParseArgs(argc, argv, exec_argc, exec_argv, &v8_argc, &v8_argv); // TODO(bnoordhuis) Intercept --prof arguments and start the CPU profiler // manually? That would give us a little more control over its runtime // behavior but it could also interfere with the user's intentions in ways // we fail to anticipate. Dillema. for (int i = 1; i < v8_argc; ++i) { if (strncmp(v8_argv[i], "--prof", sizeof("--prof") - 1) == 0) { v8_is_profiling = true; break; } } #ifdef __POSIX__ // Block SIGPROF signals when sleeping in epoll_wait/kevent/etc. Avoids the // performance penalty of frequent EINTR wakeups when the profiler is running. // Only do this for v8.log profiling, as it breaks v8::CpuProfiler users. if (v8_is_profiling) { uv_loop_configure(uv_default_loop(), UV_LOOP_BLOCK_SIGNAL, SIGPROF); } #endif #if defined(NODE_HAVE_I18N_SUPPORT) if (icu_data_dir == nullptr) { // if the parameter isn't given, use the env variable. icu_data_dir = secure_getenv("NODE_ICU_DATA"); } // Initialize ICU. // If icu_data_dir is nullptr here, it will load the 'minimal' data. if (!i18n::InitializeICUDirectory(icu_data_dir)) { FatalError(nullptr, "Could not initialize ICU " "(check NODE_ICU_DATA or --icu-data-dir parameters)"); } #endif // The const_cast doesn't violate conceptual const-ness. V8 doesn't modify // the argv array or the elements it points to. if (v8_argc > 1) V8::SetFlagsFromCommandLine(&v8_argc, const_cast(v8_argv), true); // Anything that's still in v8_argv is not a V8 or a node option. for (int i = 1; i < v8_argc; i++) { fprintf(stderr, "%s: bad option: %s\n", argv[0], v8_argv[i]); } delete[] v8_argv; v8_argv = nullptr; if (v8_argc > 1) { exit(9); } if (debug_wait_connect) { const char expose_debug_as[] = "--expose_debug_as=v8debug"; V8::SetFlagsFromString(expose_debug_as, sizeof(expose_debug_as) - 1); } // Unconditionally force typed arrays to allocate outside the v8 heap. This // is to prevent memory pointers from being moved around that are returned by // Buffer::Data(). const char no_typed_array_heap[] = "--typed_array_max_size_in_heap=0"; V8::SetFlagsFromString(no_typed_array_heap, sizeof(no_typed_array_heap) - 1); if (!use_debug_agent) { RegisterDebugSignalHandler(); } // We should set node_is_initialized here instead of in node::Start, // otherwise embedders using node::Init to initialize everything will not be // able to set it and native modules will not load for them. node_is_initialized = true; } struct AtExitCallback { AtExitCallback* next_; void (*cb_)(void* arg); void* arg_; }; static AtExitCallback* at_exit_functions_; // TODO(bnoordhuis) Turn into per-context event. void RunAtExit(Environment* env) { AtExitCallback* p = at_exit_functions_; at_exit_functions_ = nullptr; while (p) { AtExitCallback* q = p->next_; p->cb_(p->arg_); delete p; p = q; } } void AtExit(void (*cb)(void* arg), void* arg) { AtExitCallback* p = new AtExitCallback; p->cb_ = cb; p->arg_ = arg; p->next_ = at_exit_functions_; at_exit_functions_ = p; } void EmitBeforeExit(Environment* env) { HandleScope handle_scope(env->isolate()); Context::Scope context_scope(env->context()); Local process_object = env->process_object(); Local exit_code = FIXED_ONE_BYTE_STRING(env->isolate(), "exitCode"); Local args[] = { FIXED_ONE_BYTE_STRING(env->isolate(), "beforeExit"), process_object->Get(exit_code)->ToInteger(env->isolate()) }; MakeCallback(env, process_object, "emit", arraysize(args), args); } int EmitExit(Environment* env) { // process.emit('exit') HandleScope handle_scope(env->isolate()); Context::Scope context_scope(env->context()); Local process_object = env->process_object(); process_object->Set(env->exiting_string(), True(env->isolate())); Local exitCode = env->exit_code_string(); int code = process_object->Get(exitCode)->Int32Value(); Local args[] = { env->exit_string(), Integer::New(env->isolate(), code) }; MakeCallback(env, process_object, "emit", arraysize(args), args); // Reload exit code, it may be changed by `emit('exit')` return process_object->Get(exitCode)->Int32Value(); } // Just a convenience method Environment* CreateEnvironment(Isolate* isolate, Local context, int argc, const char* const* argv, int exec_argc, const char* const* exec_argv) { Environment* env; Context::Scope context_scope(context); env = CreateEnvironment(isolate, uv_default_loop(), context, argc, argv, exec_argc, exec_argv); LoadEnvironment(env); return env; } static Environment* CreateEnvironment(Isolate* isolate, Local context, NodeInstanceData* instance_data) { return CreateEnvironment(isolate, instance_data->event_loop(), context, instance_data->argc(), instance_data->argv(), instance_data->exec_argc(), instance_data->exec_argv()); } static void HandleCloseCb(uv_handle_t* handle) { Environment* env = reinterpret_cast(handle->data); env->FinishHandleCleanup(handle); } static void HandleCleanup(Environment* env, uv_handle_t* handle, void* arg) { handle->data = env; uv_close(handle, HandleCloseCb); } Environment* CreateEnvironment(Isolate* isolate, uv_loop_t* loop, Local context, int argc, const char* const* argv, int exec_argc, const char* const* exec_argv) { HandleScope handle_scope(isolate); Context::Scope context_scope(context); Environment* env = Environment::New(context, loop); isolate->SetAutorunMicrotasks(false); uv_check_init(env->event_loop(), env->immediate_check_handle()); uv_unref( reinterpret_cast(env->immediate_check_handle())); uv_idle_init(env->event_loop(), env->immediate_idle_handle()); // Inform V8's CPU profiler when we're idle. The profiler is sampling-based // but not all samples are created equal; mark the wall clock time spent in // epoll_wait() and friends so profiling tools can filter it out. The samples // still end up in v8.log but with state=IDLE rather than state=EXTERNAL. // TODO(bnoordhuis) Depends on a libuv implementation detail that we should // probably fortify in the API contract, namely that the last started prepare // or check watcher runs first. It's not 100% foolproof; if an add-on starts // a prepare or check watcher after us, any samples attributed to its callback // will be recorded with state=IDLE. uv_prepare_init(env->event_loop(), env->idle_prepare_handle()); uv_check_init(env->event_loop(), env->idle_check_handle()); uv_unref(reinterpret_cast(env->idle_prepare_handle())); uv_unref(reinterpret_cast(env->idle_check_handle())); uv_idle_init(env->event_loop(), env->destroy_ids_idle_handle()); uv_unref(reinterpret_cast(env->destroy_ids_idle_handle())); // Register handle cleanups env->RegisterHandleCleanup( reinterpret_cast(env->immediate_check_handle()), HandleCleanup, nullptr); env->RegisterHandleCleanup( reinterpret_cast(env->immediate_idle_handle()), HandleCleanup, nullptr); env->RegisterHandleCleanup( reinterpret_cast(env->idle_prepare_handle()), HandleCleanup, nullptr); env->RegisterHandleCleanup( reinterpret_cast(env->idle_check_handle()), HandleCleanup, nullptr); if (v8_is_profiling) { StartProfilerIdleNotifier(env); } Local process_template = FunctionTemplate::New(isolate); process_template->SetClassName(FIXED_ONE_BYTE_STRING(isolate, "process")); Local process_object = process_template->GetFunction()->NewInstance(); env->set_process_object(process_object); SetupProcessObject(env, argc, argv, exec_argc, exec_argv); LoadAsyncWrapperInfo(env); return env; } // Entry point for new node instances, also called directly for the main // node instance. static void StartNodeInstance(void* arg) { NodeInstanceData* instance_data = static_cast(arg); Isolate::CreateParams params; ArrayBufferAllocator* array_buffer_allocator = new ArrayBufferAllocator(); params.array_buffer_allocator = array_buffer_allocator; #ifdef NODE_ENABLE_VTUNE_PROFILING params.code_event_handler = vTune::GetVtuneCodeEventHandler(); #endif Isolate* isolate = Isolate::New(params); { Mutex::ScopedLock scoped_lock(node_isolate_mutex); if (instance_data->is_main()) { CHECK_EQ(node_isolate, nullptr); node_isolate = isolate; } } if (track_heap_objects) { isolate->GetHeapProfiler()->StartTrackingHeapObjects(true); } { Locker locker(isolate); Isolate::Scope isolate_scope(isolate); HandleScope handle_scope(isolate); Local context = Context::New(isolate); Environment* env = CreateEnvironment(isolate, context, instance_data); array_buffer_allocator->set_env(env); Context::Scope context_scope(context); isolate->SetAbortOnUncaughtExceptionCallback( ShouldAbortOnUncaughtException); // Start debug agent when argv has --debug if (instance_data->use_debug_agent()) StartDebug(env, debug_wait_connect); { Environment::AsyncCallbackScope callback_scope(env); LoadEnvironment(env); } env->set_trace_sync_io(trace_sync_io); // Enable debugger if (instance_data->use_debug_agent()) EnableDebug(env); { SealHandleScope seal(isolate); bool more; do { v8_platform.PumpMessageLoop(isolate); more = uv_run(env->event_loop(), UV_RUN_ONCE); if (more == false) { v8_platform.PumpMessageLoop(isolate); EmitBeforeExit(env); // Emit `beforeExit` if the loop became alive either after emitting // event, or after running some callbacks. more = uv_loop_alive(env->event_loop()); if (uv_run(env->event_loop(), UV_RUN_NOWAIT) != 0) more = true; } } while (more == true); } env->set_trace_sync_io(false); int exit_code = EmitExit(env); if (instance_data->is_main()) instance_data->set_exit_code(exit_code); RunAtExit(env); #if defined(LEAK_SANITIZER) __lsan_do_leak_check(); #endif array_buffer_allocator->set_env(nullptr); env->Dispose(); env = nullptr; } { Mutex::ScopedLock scoped_lock(node_isolate_mutex); if (node_isolate == isolate) node_isolate = nullptr; } CHECK_NE(isolate, nullptr); isolate->Dispose(); isolate = nullptr; delete array_buffer_allocator; } int Start(int argc, char** argv) { PlatformInit(); CHECK_GT(argc, 0); // Hack around with the argv pointer. Used for process.title = "blah". argv = uv_setup_args(argc, argv); // This needs to run *before* V8::Initialize(). The const_cast is not // optional, in case you're wondering. int exec_argc; const char** exec_argv; Init(&argc, const_cast(argv), &exec_argc, &exec_argv); #if HAVE_OPENSSL if (const char* extra = secure_getenv("NODE_EXTRA_CA_CERTS")) crypto::UseExtraCaCerts(extra); // V8 on Windows doesn't have a good source of entropy. Seed it from // OpenSSL's pool. V8::SetEntropySource(crypto::EntropySource); #endif const int thread_pool_size = 4; v8_platform.Initialize(thread_pool_size); V8::Initialize(); int exit_code = 1; { NodeInstanceData instance_data(NodeInstanceType::MAIN, uv_default_loop(), argc, const_cast(argv), exec_argc, exec_argv, use_debug_agent); StartNodeInstance(&instance_data); exit_code = instance_data.exit_code(); } V8::Dispose(); v8_platform.Dispose(); delete[] exec_argv; exec_argv = nullptr; return exit_code; } } // namespace node node-v4.8.2/src/node.d000644 000766 000024 00000030044 13070706736 014643 0ustar00iojsstaff000000 000000 /* Copyright Joyent, Inc. and other Node contributors. * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the * "Software"), to deal in the Software without restriction, including * without limitation the rights to use, copy, modify, merge, publish, * distribute, sublicense, and/or sell copies of the Software, and to permit * persons to whom the Software is furnished to do so, subject to the * following conditions: * * The above copyright notice and this permission notice shall be included * in all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN * NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE * USE OR OTHER DEALINGS IN THE SOFTWARE. */ /* * This is the DTrace library file for the node provider, which includes * the necessary translators to get from the args[] to something useful. * Be warned: the mechanics here are seriously ugly -- and one must always * keep in mind that clean abstractions often require filthy systems. */ #pragma D depends_on library procfs.d typedef struct { int32_t fd; int32_t port; uint32_t remote; uint32_t buffered; } node_dtrace_connection_t; typedef struct { int32_t fd; int32_t port; uint64_t remote; uint32_t buffered; } node_dtrace_connection64_t; typedef struct { int fd; string remoteAddress; int remotePort; int bufferSize; } node_connection_t; translator node_connection_t { fd = *(int32_t *)copyin((uintptr_t)&nc->fd, sizeof (int32_t)); remotePort = *(int32_t *)copyin((uintptr_t)&nc->port, sizeof (int32_t)); remoteAddress = curpsinfo->pr_dmodel == PR_MODEL_ILP32 ? copyinstr((uintptr_t)*(uint32_t *)copyin((uintptr_t)&nc->remote, sizeof (int32_t))) : copyinstr((uintptr_t)*(uint64_t *)copyin((uintptr_t) &((node_dtrace_connection64_t *)nc)->remote, sizeof (int64_t))); bufferSize = curpsinfo->pr_dmodel == PR_MODEL_ILP32 ? *(uint32_t *)copyin((uintptr_t)&nc->buffered, sizeof (int32_t)) : *(uint32_t *)copyin((uintptr_t) &((node_dtrace_connection64_t *)nc)->buffered, sizeof (int32_t)); }; /* * 32-bit and 64-bit structures received from node for HTTP client request * probe. */ typedef struct { uint32_t url; uint32_t method; } node_dtrace_http_client_request_t; typedef struct { uint64_t url; uint64_t method; } node_dtrace_http_client_request64_t; /* * The following structures are never used directly, but must exist to bind the * types specified in the provider to the translators defined here. * Ultimately, they always get cast to a more specific type inside the * translator. To add to the confusion, the DTrace compiler does not allow * declaring two translators with the same destination type if the source types * are structures with the same size (because libctf says they're compatible, * so dtrace considers them equivalent). Since we must define translators from * node_dtrace_http_client_request_t (above), node_dtrace_http_request_t, and * node_dtrace_http_server_request_t (both below), each of these three structs * must be declared with a different size. */ typedef struct { uint32_t version; uint64_t dummy1; } node_dtrace_http_request_t; typedef struct { uint32_t version; uint64_t dummy2; uint64_t dummy3; } node_dtrace_http_server_request_t; /* * Actual 32-bit and 64-bit, v0 and v1 structures received from node for the * HTTP server request probe. */ typedef struct { uint32_t url; uint32_t method; } node_dtrace_http_server_request_v0_t; typedef struct { uint32_t version; uint32_t url; uint32_t method; uint32_t forwardedFor; } node_dtrace_http_server_request_v1_t; typedef struct { uint64_t url; uint64_t method; } node_dtrace_http_server_request64_v0_t; typedef struct { uint32_t version; uint32_t pad; uint64_t url; uint64_t method; uint64_t forwardedFor; } node_dtrace_http_server_request64_v1_t; /* * In the end, both client and server request probes from both old and new * binaries translate their arguments to node_http_request_t, which is what the * user's D script ultimately sees. */ typedef struct { string url; string method; string forwardedFor; } node_http_request_t; /* * The following translators are particularly filthy for reasons of backwards * compatibility. Stable versions of node prior to 0.6 used a single * http_request struct with fields for "url" and "method" for both client and * server probes. 0.6 added a "forwardedFor" field intended for the server * probe only, and the http_request struct passed by the application was split * first into client_http_request and server_http_request and the latter was * again split for v0 (the old struct) and v1. * * To distinguish the binary representations of the two versions of these * structs, the new version prepends a "version" member (where the old one has * a "url" pointer). Each field that we're translating below first switches on * the value of this "version" field: if it's larger than 4096, we know we must * be looking at the "url" pointer of the older structure version. Otherwise, * we must be looking at the new version. Besides this, we have the usual * switch based on the userland process data model. This would all be simpler * with macros, but those aren't available in D library files since we cannot * rely on cpp being present at runtime. * * In retrospect, the versioning bit might have been unnecessary since the type * of the object passed in should allow DTrace to select which translator to * use. However, DTrace does sometimes use translators whose source types * don't quite match, and since we know this versioning logic works, we just * leave it alone. Each of the translators below is functionally identical * (except that the client -> client translator doesn't bother translating * forwardedFor) and should actually work with any version of any of the client * or server structs transmitted by the application up to this point. */ /* * Translate from node_dtrace_http_server_request_t (received from node 0.6 and * later versions) to node_http_request_t. */ translator node_http_request_t { url = (*(uint32_t *)copyin((uintptr_t)(uint32_t *)nd, sizeof (uint32_t))) >= 4096 ? (curpsinfo->pr_dmodel == PR_MODEL_ILP32 ? copyinstr(*(uint32_t *)copyin((uintptr_t) &((node_dtrace_http_server_request_v0_t *)nd)->url, sizeof (uint32_t))) : copyinstr(*(uint64_t *)copyin((uintptr_t) &((node_dtrace_http_server_request64_v0_t *)nd)->url, sizeof (uint64_t)))) : (curpsinfo->pr_dmodel == PR_MODEL_ILP32 ? copyinstr(*(uint32_t *)copyin((uintptr_t) &((node_dtrace_http_server_request_v1_t *)nd)->url, sizeof (uint32_t))) : copyinstr(*(uint64_t *)copyin((uintptr_t) &((node_dtrace_http_server_request64_v1_t *)nd)->url, sizeof (uint64_t)))); method = (*(uint32_t *)copyin((uintptr_t)(uint32_t *)nd, sizeof (uint32_t))) >= 4096 ? (curpsinfo->pr_dmodel == PR_MODEL_ILP32 ? copyinstr(*(uint32_t *)copyin((uintptr_t) &((node_dtrace_http_server_request_v0_t *)nd)->method, sizeof (uint32_t))) : copyinstr(*(uint64_t *)copyin((uintptr_t) &((node_dtrace_http_server_request64_v0_t *)nd)->method, sizeof (uint64_t)))) : (curpsinfo->pr_dmodel == PR_MODEL_ILP32 ? copyinstr(*(uint32_t *)copyin((uintptr_t) &((node_dtrace_http_server_request_v1_t *)nd)->method, sizeof (uint32_t))) : copyinstr(*(uint64_t *)copyin((uintptr_t) &((node_dtrace_http_server_request64_v1_t *)nd)->method, sizeof (uint64_t)))); forwardedFor = (*(uint32_t *)copyin((uintptr_t)(uint32_t *)nd, sizeof (uint32_t))) >= 4096 ? "" : (curpsinfo->pr_dmodel == PR_MODEL_ILP32 ? copyinstr(*(uint32_t *)copyin((uintptr_t) &((node_dtrace_http_server_request_v1_t *)nd)->forwardedFor, sizeof (uint32_t))) : copyinstr(*(uint64_t *)copyin((uintptr_t) &((node_dtrace_http_server_request64_v1_t *)nd)-> forwardedFor, sizeof (uint64_t)))); }; /* * Translate from node_dtrace_http_client_request_t (received from node 0.6 and * later versions) to node_http_request_t. */ translator node_http_request_t { url = (*(uint32_t *)copyin((uintptr_t)(uint32_t *)nd, sizeof (uint32_t))) >= 4096 ? (curpsinfo->pr_dmodel == PR_MODEL_ILP32 ? copyinstr(*(uint32_t *)copyin((uintptr_t) &((node_dtrace_http_server_request_v0_t *)nd)->url, sizeof (uint32_t))) : copyinstr(*(uint64_t *)copyin((uintptr_t) &((node_dtrace_http_server_request64_v0_t *)nd)->url, sizeof (uint64_t)))) : (curpsinfo->pr_dmodel == PR_MODEL_ILP32 ? copyinstr(*(uint32_t *)copyin((uintptr_t) &((node_dtrace_http_server_request_v1_t *)nd)->url, sizeof (uint32_t))) : copyinstr(*(uint64_t *)copyin((uintptr_t) &((node_dtrace_http_server_request64_v1_t *)nd)->url, sizeof (uint64_t)))); method = (*(uint32_t *)copyin((uintptr_t)(uint32_t *)nd, sizeof (uint32_t))) >= 4096 ? (curpsinfo->pr_dmodel == PR_MODEL_ILP32 ? copyinstr(*(uint32_t *)copyin((uintptr_t) &((node_dtrace_http_server_request_v0_t *)nd)->method, sizeof (uint32_t))) : copyinstr(*(uint64_t *)copyin((uintptr_t) &((node_dtrace_http_server_request64_v0_t *)nd)->method, sizeof (uint64_t)))) : (curpsinfo->pr_dmodel == PR_MODEL_ILP32 ? copyinstr(*(uint32_t *)copyin((uintptr_t) &((node_dtrace_http_server_request_v1_t *)nd)->method, sizeof (uint32_t))) : copyinstr(*(uint64_t *)copyin((uintptr_t) &((node_dtrace_http_server_request64_v1_t *)nd)->method, sizeof (uint64_t)))); forwardedFor = ""; }; /* * Translate from node_dtrace_http_request_t (received from versions of node * prior to 0.6) to node_http_request_t. This is used for both the server and * client probes since these versions of node didn't distinguish between the * types used in these probes. */ translator node_http_request_t { url = (*(uint32_t *)copyin((uintptr_t)(uint32_t *)nd, sizeof (uint32_t))) >= 4096 ? (curpsinfo->pr_dmodel == PR_MODEL_ILP32 ? copyinstr(*(uint32_t *)copyin((uintptr_t) &((node_dtrace_http_server_request_v0_t *)nd)->url, sizeof (uint32_t))) : copyinstr(*(uint64_t *)copyin((uintptr_t) &((node_dtrace_http_server_request64_v0_t *)nd)->url, sizeof (uint64_t)))) : (curpsinfo->pr_dmodel == PR_MODEL_ILP32 ? copyinstr(*(uint32_t *)copyin((uintptr_t) &((node_dtrace_http_server_request_v1_t *)nd)->url, sizeof (uint32_t))) : copyinstr(*(uint64_t *)copyin((uintptr_t) &((node_dtrace_http_server_request64_v1_t *)nd)->url, sizeof (uint64_t)))); method = (*(uint32_t *)copyin((uintptr_t)(uint32_t *)nd, sizeof (uint32_t))) >= 4096 ? (curpsinfo->pr_dmodel == PR_MODEL_ILP32 ? copyinstr(*(uint32_t *)copyin((uintptr_t) &((node_dtrace_http_server_request_v0_t *)nd)->method, sizeof (uint32_t))) : copyinstr(*(uint64_t *)copyin((uintptr_t) &((node_dtrace_http_server_request64_v0_t *)nd)->method, sizeof (uint64_t)))) : (curpsinfo->pr_dmodel == PR_MODEL_ILP32 ? copyinstr(*(uint32_t *)copyin((uintptr_t) &((node_dtrace_http_server_request_v1_t *)nd)->method, sizeof (uint32_t))) : copyinstr(*(uint64_t *)copyin((uintptr_t) &((node_dtrace_http_server_request64_v1_t *)nd)->method, sizeof (uint64_t)))); forwardedFor = (*(uint32_t *) copyin((uintptr_t)(uint32_t *)nd, sizeof (uint32_t))) >= 4096 ? "" : (curpsinfo->pr_dmodel == PR_MODEL_ILP32 ? copyinstr(*(uint32_t *)copyin((uintptr_t) &((node_dtrace_http_server_request_v1_t *)nd)->forwardedFor, sizeof (uint32_t))) : copyinstr(*(uint64_t *)copyin((uintptr_t) &((node_dtrace_http_server_request64_v1_t *)nd)-> forwardedFor, sizeof (uint64_t)))); }; node-v4.8.2/src/node.h000644 000766 000024 00000044335 13070706736 014657 0ustar00iojsstaff000000 000000 #ifndef SRC_NODE_H_ #define SRC_NODE_H_ #ifdef _WIN32 # ifndef BUILDING_NODE_EXTENSION # define NODE_EXTERN __declspec(dllexport) # else # define NODE_EXTERN __declspec(dllimport) # endif #else # define NODE_EXTERN /* nothing */ #endif #ifdef BUILDING_NODE_EXTENSION # undef BUILDING_V8_SHARED # undef BUILDING_UV_SHARED # define USING_V8_SHARED 1 # define USING_UV_SHARED 1 #endif // This should be defined in make system. // See issue https://github.com/joyent/node/issues/1236 #if defined(__MINGW32__) || defined(_MSC_VER) #ifndef _WIN32_WINNT # define _WIN32_WINNT 0x0501 #endif #ifndef NOMINMAX # define NOMINMAX #endif #endif #if defined(_MSC_VER) #define PATH_MAX MAX_PATH #endif #ifdef _WIN32 # define SIGKILL 9 #endif #include "v8.h" // NOLINT(build/include_order) #include "node_version.h" // NODE_MODULE_VERSION #define NODE_MAKE_VERSION(major, minor, patch) \ ((major) * 0x1000 + (minor) * 0x100 + (patch)) #ifdef __clang__ # define NODE_CLANG_AT_LEAST(major, minor, patch) \ (NODE_MAKE_VERSION(major, minor, patch) <= \ NODE_MAKE_VERSION(__clang_major__, __clang_minor__, __clang_patchlevel__)) #else # define NODE_CLANG_AT_LEAST(major, minor, patch) (0) #endif #ifdef __GNUC__ # define NODE_GNUC_AT_LEAST(major, minor, patch) \ (NODE_MAKE_VERSION(major, minor, patch) <= \ NODE_MAKE_VERSION(__GNUC__, __GNUC_MINOR__, __GNUC_PATCHLEVEL__)) #else # define NODE_GNUC_AT_LEAST(major, minor, patch) (0) #endif #if NODE_CLANG_AT_LEAST(2, 9, 0) || NODE_GNUC_AT_LEAST(4, 5, 0) # define NODE_DEPRECATED(message, declarator) \ __attribute__((deprecated(message))) declarator #elif defined(_MSC_VER) # define NODE_DEPRECATED(message, declarator) \ __declspec(deprecated) declarator #else # define NODE_DEPRECATED(message, declarator) \ declarator #endif // Forward-declare libuv loop struct uv_loop_s; // Forward-declare these functions now to stop MSVS from becoming // terminally confused when it's done in node_internals.h namespace node { NODE_EXTERN v8::Local ErrnoException(v8::Isolate* isolate, int errorno, const char* syscall = NULL, const char* message = NULL, const char* path = NULL); NODE_EXTERN v8::Local UVException(v8::Isolate* isolate, int errorno, const char* syscall = NULL, const char* message = NULL, const char* path = NULL); NODE_EXTERN v8::Local UVException(v8::Isolate* isolate, int errorno, const char* syscall, const char* message, const char* path, const char* dest); NODE_DEPRECATED("Use ErrnoException(isolate, ...)", inline v8::Local ErrnoException( int errorno, const char* syscall = NULL, const char* message = NULL, const char* path = NULL) { return ErrnoException(v8::Isolate::GetCurrent(), errorno, syscall, message, path); }) inline v8::Local UVException(int errorno, const char* syscall = NULL, const char* message = NULL, const char* path = NULL) { return UVException(v8::Isolate::GetCurrent(), errorno, syscall, message, path); } /* * MakeCallback doesn't have a HandleScope. That means the callers scope * will retain ownership of created handles from MakeCallback and related. * There is by default a wrapping HandleScope before uv_run, if the caller * doesn't have a HandleScope on the stack the global will take ownership * which won't be reaped until the uv loop exits. * * If a uv callback is fired, and there is no enclosing HandleScope in the * cb, you will appear to leak 4-bytes for every invocation. Take heed. */ NODE_EXTERN v8::Local MakeCallback( v8::Isolate* isolate, v8::Local recv, const char* method, int argc, v8::Local* argv); NODE_EXTERN v8::Local MakeCallback( v8::Isolate* isolate, v8::Local recv, v8::Local symbol, int argc, v8::Local* argv); NODE_EXTERN v8::Local MakeCallback( v8::Isolate* isolate, v8::Local recv, v8::Local callback, int argc, v8::Local* argv); } // namespace node #if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS #include "node_internals.h" #endif #include #include #ifndef NODE_STRINGIFY #define NODE_STRINGIFY(n) NODE_STRINGIFY_HELPER(n) #define NODE_STRINGIFY_HELPER(n) #n #endif #ifdef _WIN32 // TODO(tjfontaine) consider changing the usage of ssize_t to ptrdiff_t #if !defined(_SSIZE_T_) && !defined(_SSIZE_T_DEFINED) typedef intptr_t ssize_t; # define _SSIZE_T_ # define _SSIZE_T_DEFINED #endif #else // !_WIN32 # include // size_t, ssize_t #endif // _WIN32 namespace node { NODE_EXTERN extern bool no_deprecation; NODE_EXTERN int Start(int argc, char *argv[]); NODE_EXTERN void Init(int* argc, const char** argv, int* exec_argc, const char*** exec_argv); class Environment; NODE_EXTERN Environment* CreateEnvironment(v8::Isolate* isolate, struct uv_loop_s* loop, v8::Local context, int argc, const char* const* argv, int exec_argc, const char* const* exec_argv); NODE_EXTERN void LoadEnvironment(Environment* env); NODE_EXTERN void FreeEnvironment(Environment* env); // NOTE: Calling this is the same as calling // CreateEnvironment() + LoadEnvironment() from above. // `uv_default_loop()` will be passed as `loop`. NODE_EXTERN Environment* CreateEnvironment(v8::Isolate* isolate, v8::Local context, int argc, const char* const* argv, int exec_argc, const char* const* exec_argv); NODE_EXTERN void EmitBeforeExit(Environment* env); NODE_EXTERN int EmitExit(Environment* env); NODE_EXTERN void RunAtExit(Environment* env); /* Converts a unixtime to V8 Date */ #define NODE_UNIXTIME_V8(t) v8::Date::New(v8::Isolate::GetCurrent(), \ 1000 * static_cast(t)) #define NODE_V8_UNIXTIME(v) (static_cast((v)->NumberValue())/1000.0); // Used to be a macro, hence the uppercase name. #define NODE_DEFINE_CONSTANT(target, constant) \ do { \ v8::Isolate* isolate = target->GetIsolate(); \ v8::Local constant_name = \ v8::String::NewFromUtf8(isolate, #constant); \ v8::Local constant_value = \ v8::Number::New(isolate, static_cast(constant)); \ v8::PropertyAttribute constant_attributes = \ static_cast(v8::ReadOnly | v8::DontDelete); \ (target)->ForceSet(constant_name, constant_value, constant_attributes); \ } \ while (0) // Used to be a macro, hence the uppercase name. template inline void NODE_SET_METHOD(const TypeName& recv, const char* name, v8::FunctionCallback callback) { v8::Isolate* isolate = v8::Isolate::GetCurrent(); v8::HandleScope handle_scope(isolate); v8::Local t = v8::FunctionTemplate::New(isolate, callback); v8::Local fn = t->GetFunction(); v8::Local fn_name = v8::String::NewFromUtf8(isolate, name); fn->SetName(fn_name); recv->Set(fn_name, fn); } #define NODE_SET_METHOD node::NODE_SET_METHOD // Used to be a macro, hence the uppercase name. // Not a template because it only makes sense for FunctionTemplates. inline void NODE_SET_PROTOTYPE_METHOD(v8::Local recv, const char* name, v8::FunctionCallback callback) { v8::Isolate* isolate = v8::Isolate::GetCurrent(); v8::HandleScope handle_scope(isolate); v8::Local s = v8::Signature::New(isolate, recv); v8::Local t = v8::FunctionTemplate::New(isolate, callback, v8::Local(), s); v8::Local fn = t->GetFunction(); recv->PrototypeTemplate()->Set(v8::String::NewFromUtf8(isolate, name), fn); v8::Local fn_name = v8::String::NewFromUtf8(isolate, name); fn->SetName(fn_name); } #define NODE_SET_PROTOTYPE_METHOD node::NODE_SET_PROTOTYPE_METHOD enum encoding {ASCII, UTF8, BASE64, UCS2, BINARY, HEX, BUFFER}; NODE_EXTERN enum encoding ParseEncoding( v8::Isolate* isolate, v8::Local encoding_v, enum encoding default_encoding = BINARY); NODE_DEPRECATED("Use ParseEncoding(isolate, ...)", inline enum encoding ParseEncoding( v8::Local encoding_v, enum encoding default_encoding = BINARY) { return ParseEncoding(v8::Isolate::GetCurrent(), encoding_v, default_encoding); }) NODE_EXTERN void FatalException(v8::Isolate* isolate, const v8::TryCatch& try_catch); NODE_DEPRECATED("Use FatalException(isolate, ...)", inline void FatalException(const v8::TryCatch& try_catch) { return FatalException(v8::Isolate::GetCurrent(), try_catch); }) // Don't call with encoding=UCS2. NODE_EXTERN v8::Local Encode(v8::Isolate* isolate, const char* buf, size_t len, enum encoding encoding = BINARY); // The input buffer should be in host endianness. NODE_EXTERN v8::Local Encode(v8::Isolate* isolate, const uint16_t* buf, size_t len); NODE_DEPRECATED("Use Encode(isolate, ...)", inline v8::Local Encode( const void* buf, size_t len, enum encoding encoding = BINARY) { v8::Isolate* isolate = v8::Isolate::GetCurrent(); if (encoding == UCS2) { assert(reinterpret_cast(buf) % sizeof(uint16_t) == 0 && "UCS2 buffer must be aligned on two-byte boundary."); const uint16_t* that = static_cast(buf); return Encode(isolate, that, len / sizeof(*that)); } return Encode(isolate, static_cast(buf), len, encoding); }) // Returns -1 if the handle was not valid for decoding NODE_EXTERN ssize_t DecodeBytes(v8::Isolate* isolate, v8::Local, enum encoding encoding = BINARY); NODE_DEPRECATED("Use DecodeBytes(isolate, ...)", inline ssize_t DecodeBytes( v8::Local val, enum encoding encoding = BINARY) { return DecodeBytes(v8::Isolate::GetCurrent(), val, encoding); }) // returns bytes written. NODE_EXTERN ssize_t DecodeWrite(v8::Isolate* isolate, char* buf, size_t buflen, v8::Local, enum encoding encoding = BINARY); NODE_DEPRECATED("Use DecodeWrite(isolate, ...)", inline ssize_t DecodeWrite(char* buf, size_t buflen, v8::Local val, enum encoding encoding = BINARY) { return DecodeWrite(v8::Isolate::GetCurrent(), buf, buflen, val, encoding); }) #ifdef _WIN32 NODE_EXTERN v8::Local WinapiErrnoException( v8::Isolate* isolate, int errorno, const char *syscall = NULL, const char *msg = "", const char *path = NULL); NODE_DEPRECATED("Use WinapiErrnoException(isolate, ...)", inline v8::Local WinapiErrnoException(int errorno, const char *syscall = NULL, const char *msg = "", const char *path = NULL) { return WinapiErrnoException(v8::Isolate::GetCurrent(), errorno, syscall, msg, path); }) #endif const char *signo_string(int errorno); typedef void (*addon_register_func)( v8::Local exports, v8::Local module, void* priv); typedef void (*addon_context_register_func)( v8::Local exports, v8::Local module, v8::Local context, void* priv); #define NM_F_BUILTIN 0x01 #define NM_F_LINKED 0x02 struct node_module { int nm_version; unsigned int nm_flags; void* nm_dso_handle; const char* nm_filename; node::addon_register_func nm_register_func; node::addon_context_register_func nm_context_register_func; const char* nm_modname; void* nm_priv; struct node_module* nm_link; }; node_module* get_builtin_module(const char *name); node_module* get_linked_module(const char *name); extern "C" NODE_EXTERN void node_module_register(void* mod); #ifdef _WIN32 # define NODE_MODULE_EXPORT __declspec(dllexport) #else # define NODE_MODULE_EXPORT __attribute__((visibility("default"))) #endif #ifdef NODE_SHARED_MODE # define NODE_CTOR_PREFIX #else # define NODE_CTOR_PREFIX static #endif #if defined(_MSC_VER) #pragma section(".CRT$XCU", read) #define NODE_C_CTOR(fn) \ NODE_CTOR_PREFIX void __cdecl fn(void); \ __declspec(dllexport, allocate(".CRT$XCU")) \ void (__cdecl*fn ## _)(void) = fn; \ NODE_CTOR_PREFIX void __cdecl fn(void) #else #define NODE_C_CTOR(fn) \ NODE_CTOR_PREFIX void fn(void) __attribute__((constructor)); \ NODE_CTOR_PREFIX void fn(void) #endif #define NODE_MODULE_X(modname, regfunc, priv, flags) \ extern "C" { \ static node::node_module _module = \ { \ NODE_MODULE_VERSION, \ flags, \ NULL, \ __FILE__, \ (node::addon_register_func) (regfunc), \ NULL, \ NODE_STRINGIFY(modname), \ priv, \ NULL \ }; \ NODE_C_CTOR(_register_ ## modname) { \ node_module_register(&_module); \ } \ } #define NODE_MODULE_CONTEXT_AWARE_X(modname, regfunc, priv, flags) \ extern "C" { \ static node::node_module _module = \ { \ NODE_MODULE_VERSION, \ flags, \ NULL, \ __FILE__, \ NULL, \ (node::addon_context_register_func) (regfunc), \ NODE_STRINGIFY(modname), \ priv, \ NULL \ }; \ NODE_C_CTOR(_register_ ## modname) { \ node_module_register(&_module); \ } \ } #define NODE_MODULE(modname, regfunc) \ NODE_MODULE_X(modname, regfunc, NULL, 0) #define NODE_MODULE_CONTEXT_AWARE(modname, regfunc) \ NODE_MODULE_CONTEXT_AWARE_X(modname, regfunc, NULL, 0) #define NODE_MODULE_CONTEXT_AWARE_BUILTIN(modname, regfunc) \ NODE_MODULE_CONTEXT_AWARE_X(modname, regfunc, NULL, NM_F_BUILTIN) \ /* * For backward compatibility in add-on modules. */ #define NODE_MODULE_DECL /* nothing */ /* Called after the event loop exits but before the VM is disposed. * Callbacks are run in reverse order of registration, i.e. newest first. */ NODE_EXTERN void AtExit(void (*cb)(void* arg), void* arg = 0); } // namespace node #endif // SRC_NODE_H_ node-v4.8.2/src/node.js000644 000766 000024 00000075130 13070706736 015041 0ustar00iojsstaff000000 000000 // Hello, and welcome to hacking node.js! // // This file is invoked by node::LoadEnvironment in src/node.cc, and is // responsible for bootstrapping the node.js core. As special caution is given // to the performance of the startup process, many dependencies are invoked // lazily. 'use strict'; (function(process) { this.global = this; function startup() { var EventEmitter = NativeModule.require('events'); process._eventsCount = 0; Object.setPrototypeOf(process, Object.create(EventEmitter.prototype, { constructor: { value: process.constructor } })); EventEmitter.call(process); process.EventEmitter = EventEmitter; // process.EventEmitter is deprecated // do this good and early, since it handles errors. startup.processFatal(); startup.globalVariables(); startup.globalTimeouts(); startup.globalConsole(); startup.processAssert(); startup.processConfig(); startup.processNextTick(); startup.processPromises(); startup.processStdio(); startup.processKillAndExit(); startup.processSignalHandlers(); startup.processCpuUsage(); // Do not initialize channel in debugger agent, it deletes env variable // and the main thread won't see it. if (process.argv[1] !== '--debug-agent') startup.processChannel(); startup.processRawDebug(); process.argv[0] = process.execPath; // There are various modes that Node can run in. The most common two // are running from a script and running the REPL - but there are a few // others like the debugger or running --eval arguments. Here we decide // which mode we run in. if (NativeModule.exists('_third_party_main')) { // To allow people to extend Node in different ways, this hook allows // one to drop a file lib/_third_party_main.js into the build // directory which will be executed instead of Node's normal loading. process.nextTick(function() { NativeModule.require('_third_party_main'); }); } else if (process.argv[1] == 'debug') { // Start the debugger agent NativeModule.require('_debugger').start(); } else if (process.argv[1] == '--debug-agent') { // Start the debugger agent NativeModule.require('_debug_agent').start(); } else if (process.profProcess) { NativeModule.require('internal/v8_prof_processor'); } else { // There is user code to be run // If this is a worker in cluster mode, start up the communication // channel. This needs to be done before any user code gets executed // (including preload modules). if (process.argv[1] && process.env.NODE_UNIQUE_ID) { var cluster = NativeModule.require('cluster'); cluster._setupWorker(); // Make sure it's not accidentally inherited by child processes. delete process.env.NODE_UNIQUE_ID; } if (process._eval != null) { // User passed '-e' or '--eval' arguments to Node. startup.preloadModules(); evalScript('[eval]'); } else if (process.argv[1]) { // make process.argv[1] into a full path var path = NativeModule.require('path'); process.argv[1] = path.resolve(process.argv[1]); var Module = NativeModule.require('module'); // check if user passed `-c` or `--check` arguments to Node. if (process._syntax_check_only != null) { var vm = NativeModule.require('vm'); var fs = NativeModule.require('fs'); var internalModule = NativeModule.require('internal/module'); // read the source var filename = Module._resolveFilename(process.argv[1]); var source = fs.readFileSync(filename, 'utf-8'); // remove shebang and BOM source = internalModule.stripBOM(source.replace(/^\#\!.*/, '')); // wrap it source = Module.wrap(source); // compile the script, this will throw if it fails new vm.Script(source, {filename: filename, displayErrors: true}); process.exit(0); } startup.preloadModules(); if (global.v8debug && process.execArgv.some(function(arg) { return arg.match(/^--debug-brk(=[0-9]*)?$/); })) { // XXX Fix this terrible hack! // // Give the client program a few ticks to connect. // Otherwise, there's a race condition where `node debug foo.js` // will not be able to connect in time to catch the first // breakpoint message on line 1. // // A better fix would be to somehow get a message from the // global.v8debug object about a connection, and runMain when // that occurs. --isaacs var debugTimeout = +process.env.NODE_DEBUG_TIMEOUT || 50; setTimeout(Module.runMain, debugTimeout); } else { // Main entry point into most programs: Module.runMain(); } } else { // If -i or --interactive were passed, or stdin is a TTY. if (process._forceRepl || NativeModule.require('tty').isatty(0)) { // REPL var cliRepl = NativeModule.require('internal/repl'); cliRepl.createInternalRepl(process.env, function(err, repl) { if (err) { throw err; } repl.on('exit', function() { if (repl._flushing) { repl.pause(); return repl.once('flushHistory', function() { process.exit(); }); } process.exit(); }); }); } else { // Read all of stdin - execute it. process.stdin.setEncoding('utf8'); var code = ''; process.stdin.on('data', function(d) { code += d; }); process.stdin.on('end', function() { process._eval = code; evalScript('[stdin]'); }); } } } } startup.globalVariables = function() { global.process = process; global.global = global; global.GLOBAL = global; global.root = global; global.Buffer = NativeModule.require('buffer').Buffer; process.domain = null; process._exiting = false; }; startup.globalTimeouts = function() { const timers = NativeModule.require('timers'); global.clearImmediate = timers.clearImmediate; global.clearInterval = timers.clearInterval; global.clearTimeout = timers.clearTimeout; global.setImmediate = timers.setImmediate; global.setInterval = timers.setInterval; global.setTimeout = timers.setTimeout; }; startup.globalConsole = function() { global.__defineGetter__('console', function() { return NativeModule.require('console'); }); }; startup._lazyConstants = null; startup.lazyConstants = function() { if (!startup._lazyConstants) { startup._lazyConstants = process.binding('constants'); } return startup._lazyConstants; }; startup.processFatal = function() { process._fatalException = function(er) { var caught; if (process.domain && process.domain._errorHandler) caught = process.domain._errorHandler(er) || caught; if (!caught) caught = process.emit('uncaughtException', er); // If someone handled it, then great. otherwise, die in C++ land // since that means that we'll exit the process, emit the 'exit' event if (!caught) { try { if (!process._exiting) { process._exiting = true; process.emit('exit', 1); } } catch (er) { // nothing to be done about it at this point. } // if we handled an error, then make sure any ticks get processed } else { NativeModule.require('timers').setImmediate(process._tickCallback); } return caught; }; }; var assert; startup.processAssert = function() { assert = process.assert = function(x, msg) { if (!x) throw new Error(msg || 'assertion error'); }; }; startup.processConfig = function() { // used for `process.config`, but not a real module var config = NativeModule._source.config; delete NativeModule._source.config; // strip the gyp comment line at the beginning config = config.split('\n') .slice(1) .join('\n') .replace(/"/g, '\\"') .replace(/'/g, '"'); process.config = JSON.parse(config, function(key, value) { if (value === 'true') return true; if (value === 'false') return false; // Intl.v8BreakIterator() would crash w/ fatal error, so throw instead. if (value.icu_small && global.hasOwnProperty('Intl') && Intl.hasOwnProperty('v8BreakIterator') && !process.icu_data_dir) { const des = Object.getOwnPropertyDescriptor(Intl, 'v8BreakIterator'); des.value = function v8BreakIterator() { throw new Error('v8BreakIterator: full ICU data not installed. ' + 'See https://github.com/nodejs/node/wiki/Intl'); }; Object.defineProperty(Intl, 'v8BreakIterator', des); } // Don’t let icu_data_dir leak through. delete process.icu_data_dir; return value; }); }; startup.processCpuUsage = function() { // Get the native function, which will be replaced with a JS version. const _cpuUsage = process.cpuUsage; // Create the argument array that will be passed to the native function. const cpuValues = new Float64Array(2); // Replace the native function with the JS version that calls the native // function. process.cpuUsage = function cpuUsage(prevValue) { // If a previous value was passed in, ensure it has the correct shape. if (prevValue) { if (!previousValueIsValid(prevValue.user)) { throw new TypeError('value of user property of argument is invalid'); } if (!previousValueIsValid(prevValue.system)) { throw new TypeError( 'value of system property of argument is invalid'); } } // Call the native function to get the current values. const errmsg = _cpuUsage(cpuValues); if (errmsg) { throw new Error('unable to obtain CPU usage: ' + errmsg); } // If a previous value was passed in, // return diff of current from previous. if (prevValue) return { user: cpuValues[0] - prevValue.user, system: cpuValues[1] - prevValue.system }; // If no previous value passed in, return current value. return { user: cpuValues[0], system: cpuValues[1] }; // Ensure that a previously passed in value is valid. Currently, the // native implementation always returns // numbers <= Number.MAX_SAFE_INTEGER. function previousValueIsValid(num) { return Number.isFinite(num) && num <= Number.MAX_SAFE_INTEGER && num >= 0; } }; }; var addPendingUnhandledRejection; var hasBeenNotifiedProperty = new WeakMap(); startup.processNextTick = function() { var nextTickQueue = []; var pendingUnhandledRejections = []; var microtasksScheduled = false; // Used to run V8's micro task queue. var _runMicrotasks = {}; // *Must* match Environment::TickInfo::Fields in src/env.h. var kIndex = 0; var kLength = 1; process.nextTick = nextTick; // Needs to be accessible from beyond this scope. process._tickCallback = _tickCallback; process._tickDomainCallback = _tickDomainCallback; // This tickInfo thing is used so that the C++ code in src/node.cc // can have easy access to our nextTick state, and avoid unnecessary // calls into JS land. const tickInfo = process._setupNextTick(_tickCallback, _runMicrotasks); _runMicrotasks = _runMicrotasks.runMicrotasks; function tickDone() { if (tickInfo[kLength] !== 0) { if (tickInfo[kLength] <= tickInfo[kIndex]) { nextTickQueue = []; tickInfo[kLength] = 0; } else { nextTickQueue.splice(0, tickInfo[kIndex]); tickInfo[kLength] = nextTickQueue.length; } } tickInfo[kIndex] = 0; } function scheduleMicrotasks() { if (microtasksScheduled) return; nextTickQueue.push({ callback: runMicrotasksCallback, domain: null }); tickInfo[kLength]++; microtasksScheduled = true; } function runMicrotasksCallback() { microtasksScheduled = false; _runMicrotasks(); if (tickInfo[kIndex] < tickInfo[kLength] || emitPendingUnhandledRejections()) scheduleMicrotasks(); } // Run callbacks that have no domain. // Using domains will cause this to be overridden. function _tickCallback() { var callback, args, tock; do { while (tickInfo[kIndex] < tickInfo[kLength]) { tock = nextTickQueue[tickInfo[kIndex]++]; callback = tock.callback; args = tock.args; // Using separate callback execution functions helps to limit the // scope of DEOPTs caused by using try blocks and allows direct // callback invocation with small numbers of arguments to avoid the // performance hit associated with using `fn.apply()` if (args === undefined) { nextTickCallbackWith0Args(callback); } else { switch (args.length) { case 1: nextTickCallbackWith1Arg(callback, args[0]); break; case 2: nextTickCallbackWith2Args(callback, args[0], args[1]); break; case 3: nextTickCallbackWith3Args(callback, args[0], args[1], args[2]); break; default: nextTickCallbackWithManyArgs(callback, args); } } if (1e4 < tickInfo[kIndex]) tickDone(); } tickDone(); _runMicrotasks(); emitPendingUnhandledRejections(); } while (tickInfo[kLength] !== 0); } function _tickDomainCallback() { var callback, domain, args, tock; do { while (tickInfo[kIndex] < tickInfo[kLength]) { tock = nextTickQueue[tickInfo[kIndex]++]; callback = tock.callback; domain = tock.domain; args = tock.args; if (domain) domain.enter(); // Using separate callback execution functions helps to limit the // scope of DEOPTs caused by using try blocks and allows direct // callback invocation with small numbers of arguments to avoid the // performance hit associated with using `fn.apply()` if (args === undefined) { nextTickCallbackWith0Args(callback); } else { switch (args.length) { case 1: nextTickCallbackWith1Arg(callback, args[0]); break; case 2: nextTickCallbackWith2Args(callback, args[0], args[1]); break; case 3: nextTickCallbackWith3Args(callback, args[0], args[1], args[2]); break; default: nextTickCallbackWithManyArgs(callback, args); } } if (1e4 < tickInfo[kIndex]) tickDone(); if (domain) domain.exit(); } tickDone(); _runMicrotasks(); emitPendingUnhandledRejections(); } while (tickInfo[kLength] !== 0); } function nextTickCallbackWith0Args(callback) { var threw = true; try { callback(); threw = false; } finally { if (threw) tickDone(); } } function nextTickCallbackWith1Arg(callback, arg1) { var threw = true; try { callback(arg1); threw = false; } finally { if (threw) tickDone(); } } function nextTickCallbackWith2Args(callback, arg1, arg2) { var threw = true; try { callback(arg1, arg2); threw = false; } finally { if (threw) tickDone(); } } function nextTickCallbackWith3Args(callback, arg1, arg2, arg3) { var threw = true; try { callback(arg1, arg2, arg3); threw = false; } finally { if (threw) tickDone(); } } function nextTickCallbackWithManyArgs(callback, args) { var threw = true; try { callback.apply(null, args); threw = false; } finally { if (threw) tickDone(); } } function TickObject(c, args) { this.callback = c; this.domain = process.domain || null; this.args = args; } function nextTick(callback) { // on the way out, don't bother. it won't get fired anyway. if (process._exiting) return; var args; if (arguments.length > 1) { args = []; for (var i = 1; i < arguments.length; i++) args.push(arguments[i]); } nextTickQueue.push(new TickObject(callback, args)); tickInfo[kLength]++; } function emitPendingUnhandledRejections() { var hadListeners = false; while (pendingUnhandledRejections.length > 0) { var promise = pendingUnhandledRejections.shift(); var reason = pendingUnhandledRejections.shift(); if (hasBeenNotifiedProperty.get(promise) === false) { hasBeenNotifiedProperty.set(promise, true); if (!process.emit('unhandledRejection', reason, promise)) { // Nobody is listening. // TODO(petkaantonov) Take some default action, see #830 } else { hadListeners = true; } } } return hadListeners; } addPendingUnhandledRejection = function(promise, reason) { pendingUnhandledRejections.push(promise, reason); scheduleMicrotasks(); }; }; startup.processPromises = function() { var promiseRejectEvent = process._promiseRejectEvent; function unhandledRejection(promise, reason) { hasBeenNotifiedProperty.set(promise, false); addPendingUnhandledRejection(promise, reason); } function rejectionHandled(promise) { var hasBeenNotified = hasBeenNotifiedProperty.get(promise); if (hasBeenNotified !== undefined) { hasBeenNotifiedProperty.delete(promise); if (hasBeenNotified === true) { process.nextTick(function() { process.emit('rejectionHandled', promise); }); } } } process._setupPromises(function(event, promise, reason) { if (event === promiseRejectEvent.unhandled) unhandledRejection(promise, reason); else if (event === promiseRejectEvent.handled) rejectionHandled(promise); else NativeModule.require('assert').fail('unexpected PromiseRejectEvent'); }); }; function evalScript(name) { var Module = NativeModule.require('module'); var path = NativeModule.require('path'); try { var cwd = process.cwd(); } catch (e) { // getcwd(3) can fail if the current working directory has been deleted. // Fall back to the directory name of the (absolute) executable path. // It's not really correct but what are the alternatives? cwd = path.dirname(process.execPath); } var module = new Module(name); module.filename = path.join(cwd, name); module.paths = Module._nodeModulePaths(cwd); var script = process._eval; var body = script; script = `global.__filename = ${JSON.stringify(name)};\n` + 'global.exports = exports;\n' + 'global.module = module;\n' + 'global.__dirname = __dirname;\n' + 'global.require = require;\n' + 'return require("vm").runInThisContext(' + `${JSON.stringify(body)}, { filename: ` + `${JSON.stringify(name)} });\n`; // Defer evaluation for a tick. This is a workaround for deferred // events not firing when evaluating scripts from the command line, // see https://github.com/nodejs/node/issues/1600. process.nextTick(function() { var result = module._compile(script, `${name}-wrapper`); if (process._print_eval) console.log(result); }); } function createWritableStdioStream(fd) { var stream; var tty_wrap = process.binding('tty_wrap'); // Note stream._type is used for test-module-load-list.js switch (tty_wrap.guessHandleType(fd)) { case 'TTY': var tty = NativeModule.require('tty'); stream = new tty.WriteStream(fd); stream._type = 'tty'; break; case 'FILE': var fs = NativeModule.require('fs'); stream = new fs.SyncWriteStream(fd, { autoClose: false }); stream._type = 'fs'; break; case 'PIPE': case 'TCP': var net = NativeModule.require('net'); stream = new net.Socket({ fd: fd, readable: false, writable: true }); stream._type = 'pipe'; break; default: // Probably an error on in uv_guess_handle() throw new Error('Implement me. Unknown stream file type!'); } // For supporting legacy API we put the FD here. stream.fd = fd; stream._isStdio = true; return stream; } startup.processStdio = function() { var stdin, stdout, stderr; process.__defineGetter__('stdout', function() { if (stdout) return stdout; stdout = createWritableStdioStream(1); stdout.destroy = stdout.destroySoon = function(er) { er = er || new Error('process.stdout cannot be closed.'); stdout.emit('error', er); }; if (stdout.isTTY) { process.on('SIGWINCH', function() { stdout._refreshSize(); }); } return stdout; }); process.__defineGetter__('stderr', function() { if (stderr) return stderr; stderr = createWritableStdioStream(2); stderr.destroy = stderr.destroySoon = function(er) { er = er || new Error('process.stderr cannot be closed.'); stderr.emit('error', er); }; if (stderr.isTTY) { process.on('SIGWINCH', function() { stderr._refreshSize(); }); } return stderr; }); process.__defineGetter__('stdin', function() { if (stdin) return stdin; var tty_wrap = process.binding('tty_wrap'); var fd = 0; switch (tty_wrap.guessHandleType(fd)) { case 'TTY': var tty = NativeModule.require('tty'); stdin = new tty.ReadStream(fd, { highWaterMark: 0, readable: true, writable: false }); break; case 'FILE': var fs = NativeModule.require('fs'); stdin = new fs.ReadStream(null, { fd: fd, autoClose: false }); break; case 'PIPE': case 'TCP': var net = NativeModule.require('net'); // It could be that process has been started with an IPC channel // sitting on fd=0, in such case the pipe for this fd is already // present and creating a new one will lead to the assertion failure // in libuv. if (process._channel && process._channel.fd === fd) { stdin = new net.Socket({ handle: process._channel, readable: true, writable: false }); } else { stdin = new net.Socket({ fd: fd, readable: true, writable: false }); } // Make sure the stdin can't be `.end()`-ed stdin._writableState.ended = true; break; default: // Probably an error on in uv_guess_handle() throw new Error('Implement me. Unknown stdin file type!'); } // For supporting legacy API we put the FD here. stdin.fd = fd; // stdin starts out life in a paused state, but node doesn't // know yet. Explicitly to readStop() it to put it in the // not-reading state. if (stdin._handle && stdin._handle.readStop) { stdin._handle.reading = false; stdin._readableState.reading = false; stdin._handle.readStop(); } // if the user calls stdin.pause(), then we need to stop reading // immediately, so that the process can close down. stdin.on('pause', function() { if (!stdin._handle) return; stdin._readableState.reading = false; stdin._handle.reading = false; stdin._handle.readStop(); }); return stdin; }); process.openStdin = function() { process.stdin.resume(); return process.stdin; }; }; startup.processKillAndExit = function() { process.exit = function(code) { if (code || code === 0) process.exitCode = code; if (!process._exiting) { process._exiting = true; process.emit('exit', process.exitCode || 0); } process.reallyExit(process.exitCode || 0); }; process.kill = function(pid, sig) { var err; if (pid != (pid | 0)) { throw new TypeError('invalid pid'); } // preserve null signal if (0 === sig) { err = process._kill(pid, 0); } else { sig = sig || 'SIGTERM'; if (startup.lazyConstants()[sig] && sig.slice(0, 3) === 'SIG') { err = process._kill(pid, startup.lazyConstants()[sig]); } else { throw new Error(`Unknown signal: ${sig}`); } } if (err) { var errnoException = NativeModule.require('util')._errnoException; throw errnoException(err, 'kill'); } return true; }; }; startup.processSignalHandlers = function() { // Load events module in order to access prototype elements on process like // process.addListener. var signalWraps = {}; function isSignal(event) { return typeof event === 'string' && event.slice(0, 3) === 'SIG' && startup.lazyConstants().hasOwnProperty(event); } // Detect presence of a listener for the special signal types process.on('newListener', function(type, listener) { if (isSignal(type) && !signalWraps.hasOwnProperty(type)) { var Signal = process.binding('signal_wrap').Signal; var wrap = new Signal(); wrap.unref(); wrap.onsignal = function() { process.emit(type); }; var signum = startup.lazyConstants()[type]; var err = wrap.start(signum); if (err) { wrap.close(); var errnoException = NativeModule.require('util')._errnoException; throw errnoException(err, 'uv_signal_start'); } signalWraps[type] = wrap; } }); process.on('removeListener', function(type, listener) { if (signalWraps.hasOwnProperty(type) && this.listenerCount(type) === 0) { signalWraps[type].close(); delete signalWraps[type]; } }); }; startup.processChannel = function() { // If we were spawned with env NODE_CHANNEL_FD then load that up and // start parsing data from that stream. if (process.env.NODE_CHANNEL_FD) { var fd = parseInt(process.env.NODE_CHANNEL_FD, 10); assert(fd >= 0); // Make sure it's not accidentally inherited by child processes. delete process.env.NODE_CHANNEL_FD; var cp = NativeModule.require('child_process'); // Load tcp_wrap to avoid situation where we might immediately receive // a message. // FIXME is this really necessary? process.binding('tcp_wrap'); cp._forkChild(fd); assert(process.send); } }; startup.processRawDebug = function() { var format = NativeModule.require('util').format; var rawDebug = process._rawDebug; process._rawDebug = function() { rawDebug(format.apply(null, arguments)); }; }; // Load preload modules startup.preloadModules = function() { if (process._preload_modules) { NativeModule.require('module')._preloadModules(process._preload_modules); } }; // Below you find a minimal module system, which is used to load the node // core modules found in lib/*.js. All core modules are compiled into the // node binary, so they can be loaded faster. var ContextifyScript = process.binding('contextify').ContextifyScript; function runInThisContext(code, options) { var script = new ContextifyScript(code, options); return script.runInThisContext(); } function NativeModule(id) { this.filename = `${id}.js`; this.id = id; this.exports = {}; this.loaded = false; this.loading = true; } NativeModule._source = process.binding('natives'); NativeModule._cache = {}; NativeModule.require = function(id) { if (id == 'native_module') { return NativeModule; } var cached = NativeModule.getCached(id); if (cached && (cached.loaded || cached.loading)) { return cached.exports; } if (!NativeModule.exists(id)) { throw new Error(`No such native module ${id}`); } process.moduleLoadList.push(`NativeModule ${id}`); var nativeModule = new NativeModule(id); nativeModule.cache(); nativeModule.compile(); return nativeModule.exports; }; NativeModule.getCached = function(id) { return NativeModule._cache[id]; }; NativeModule.exists = function(id) { return NativeModule._source.hasOwnProperty(id); }; const EXPOSE_INTERNALS = process.execArgv.some(function(arg) { return arg.match(/^--expose[-_]internals$/); }); if (EXPOSE_INTERNALS) { NativeModule.nonInternalExists = NativeModule.exists; NativeModule.isInternal = function(id) { return false; }; } else { NativeModule.nonInternalExists = function(id) { return NativeModule.exists(id) && !NativeModule.isInternal(id); }; NativeModule.isInternal = function(id) { return id.startsWith('internal/'); }; } NativeModule.getSource = function(id) { return NativeModule._source[id]; }; NativeModule.wrap = function(script) { return NativeModule.wrapper[0] + script + NativeModule.wrapper[1]; }; NativeModule.wrapper = [ '(function (exports, require, module, __filename, __dirname) { ', '\n});' ]; NativeModule.prototype.compile = function() { var source = NativeModule.getSource(this.id); source = NativeModule.wrap(source); this.loading = true; try { var fn = runInThisContext(source, { filename: this.filename, lineOffset: 0 }); fn(this.exports, NativeModule.require, this, this.filename); this.loaded = true; } finally { this.loading = false; } }; NativeModule.prototype.cache = function() { NativeModule._cache[this.id] = this; }; startup(); }); node-v4.8.2/src/node.stp000644 000766 000024 00000004471 13070706736 015233 0ustar00iojsstaff000000 000000 probe node_net_server_connection = process("node").mark("net__server__connection") { remote = user_string($arg2); port = $arg3; fd = $arg4; probestr = sprintf("%s(remote=%s, port=%d, fd=%d)", $$name, remote, port, fd); } probe node_net_stream_end = process("node").mark("net__stream__end") { remote = user_string($arg2); port = $arg3; fd = $arg4; probestr = sprintf("%s(remote=%s, port=%d, fd=%d)", $$name, remote, port, fd); } probe node_http_server_request = process("node").mark("http__server__request") { remote = user_string($arg3); port = $arg4; method = user_string($arg5); url = user_string($arg6); fd = $arg7; probestr = sprintf("%s(remote=%s, port=%d, method=%s, url=%s, fd=%d)", $$name, remote, port, method, url, fd); } probe node_http_server_response = process("node").mark("http__server__response") { remote = user_string($arg2); port = $arg3; fd = $arg4; probestr = sprintf("%s(remote=%s, port=%d, fd=%d)", $$name, remote, port, fd); } probe node_http_client_request = process("node").mark("http__client__request") { remote = user_string($arg3); port = $arg4; method = user_string($arg5); url = user_string($arg6); fd = $arg7; probestr = sprintf("%s(remote=%s, port=%d, method=%s, url=%s, fd=%d)", $$name, remote, port, method, url, fd); } probe node_http_client_response = process("node").mark("http__client__response") { remote = user_string($arg2); port = $arg3; fd = $arg4; probestr = sprintf("%s(remote=%s, port=%d, fd=%d)", $$name, remote, port, fd); } probe node_gc_start = process("node").mark("gc__start") { scavenge = 1 << 0; compact = 1 << 1; if ($arg1 == scavenge) type = "kGCTypeScavenge"; else if ($arg1 == compact) type = "kGCTypeMarkSweepCompact"; else type = "kGCTypeAll"; flags = $arg2; probestr = sprintf("%s(type=%s,flags=%d)", $$name, type, flags); } probe node_gc_stop = process("node").mark("gc__stop") { scavenge = 1 << 0; compact = 1 << 1; if ($arg1 == scavenge) type = "kGCTypeScavenge"; else if ($arg1 == compact) type = "kGCTypeMarkSweepCompact"; else type = "kGCTypeAll"; flags = $arg2; probestr = sprintf("%s(type=%s,flags=%d)", $$name, type, flags); } node-v4.8.2/src/node_buffer.cc000644 000766 000024 00000101023 13070706736 016332 0ustar00iojsstaff000000 000000 #include "node.h" #include "node_buffer.h" #include "env.h" #include "env-inl.h" #include "string_bytes.h" #include "string_search.h" #include "util.h" #include "util-inl.h" #include "v8-profiler.h" #include "v8.h" #include #include #define BUFFER_ID 0xB0E4 #define MIN(a, b) ((a) < (b) ? (a) : (b)) #define CHECK_NOT_OOB(r) \ do { \ if (!(r)) return env->ThrowRangeError("out of range index"); \ } while (0) #define THROW_AND_RETURN_UNLESS_BUFFER(env, obj) \ do { \ if (!HasInstance(obj)) \ return env->ThrowTypeError("argument should be a Buffer"); \ } while (0) #define SPREAD_ARG(val, name) \ CHECK((val)->IsUint8Array()); \ Local name = (val).As(); \ ArrayBuffer::Contents name##_c = name->Buffer()->GetContents(); \ const size_t name##_offset = name->ByteOffset(); \ const size_t name##_length = name->ByteLength(); \ char* const name##_data = \ static_cast(name##_c.Data()) + name##_offset; \ if (name##_length > 0) \ CHECK_NE(name##_data, nullptr); #define SLICE_START_END(start_arg, end_arg, end_max) \ size_t start; \ size_t end; \ CHECK_NOT_OOB(ParseArrayIndex(start_arg, 0, &start)); \ CHECK_NOT_OOB(ParseArrayIndex(end_arg, end_max, &end)); \ if (end < start) end = start; \ CHECK_NOT_OOB(end <= end_max); \ size_t length = end - start; #define BUFFER_MALLOC(length) \ zero_fill_all_buffers ? node::Calloc(length, 1) : node::Malloc(length) namespace node { // if true, all Buffer and SlowBuffer instances will automatically zero-fill bool zero_fill_all_buffers = false; namespace Buffer { using v8::ArrayBuffer; using v8::ArrayBufferCreationMode; using v8::Context; using v8::EscapableHandleScope; using v8::Function; using v8::FunctionCallbackInfo; using v8::FunctionTemplate; using v8::HandleScope; using v8::Integer; using v8::Isolate; using v8::Local; using v8::Maybe; using v8::MaybeLocal; using v8::Number; using v8::Object; using v8::Persistent; using v8::String; using v8::Uint32; using v8::Uint32Array; using v8::Uint8Array; using v8::Value; using v8::WeakCallbackData; class CallbackInfo { public: static inline void Free(char* data, void* hint); static inline CallbackInfo* New(Isolate* isolate, Local object, FreeCallback callback, void* hint = 0); inline void Dispose(Isolate* isolate); inline Persistent* persistent(); private: static void WeakCallback(const WeakCallbackData&); inline void WeakCallback(Isolate* isolate, Local object); inline CallbackInfo(Isolate* isolate, Local object, FreeCallback callback, void* hint); ~CallbackInfo(); Persistent persistent_; FreeCallback const callback_; void* const hint_; DISALLOW_COPY_AND_ASSIGN(CallbackInfo); }; void CallbackInfo::Free(char* data, void*) { ::free(data); } CallbackInfo* CallbackInfo::New(Isolate* isolate, Local object, FreeCallback callback, void* hint) { return new CallbackInfo(isolate, object, callback, hint); } void CallbackInfo::Dispose(Isolate* isolate) { WeakCallback(isolate, PersistentToLocal(isolate, persistent_)); } Persistent* CallbackInfo::persistent() { return &persistent_; } CallbackInfo::CallbackInfo(Isolate* isolate, Local object, FreeCallback callback, void* hint) : persistent_(isolate, object), callback_(callback), hint_(hint) { persistent_.SetWeak(this, WeakCallback); persistent_.SetWrapperClassId(BUFFER_ID); persistent_.MarkIndependent(); isolate->AdjustAmountOfExternalAllocatedMemory(sizeof(*this)); } CallbackInfo::~CallbackInfo() { persistent_.Reset(); } void CallbackInfo::WeakCallback( const WeakCallbackData& data) { data.GetParameter()->WeakCallback(data.GetIsolate(), data.GetValue()); } void CallbackInfo::WeakCallback(Isolate* isolate, Local object) { CHECK(object->IsArrayBuffer()); Local buf = object.As(); ArrayBuffer::Contents obj_c = buf->GetContents(); char* const obj_data = static_cast(obj_c.Data()); if (buf->ByteLength() != 0) CHECK_NE(obj_data, nullptr); buf->Neuter(); callback_(obj_data, hint_); int64_t change_in_bytes = -static_cast(sizeof(*this)); isolate->AdjustAmountOfExternalAllocatedMemory(change_in_bytes); delete this; } // Parse index for external array data. inline MUST_USE_RESULT bool ParseArrayIndex(Local arg, size_t def, size_t* ret) { if (arg->IsUndefined()) { *ret = def; return true; } int64_t tmp_i = arg->IntegerValue(); if (tmp_i < 0) return false; // Check that the result fits in a size_t. const uint64_t kSizeMax = static_cast(static_cast(-1)); // coverity[pointless_expression] if (static_cast(tmp_i) > kSizeMax) return false; *ret = static_cast(tmp_i); return true; } // Buffer methods bool HasInstance(Local val) { return val->IsUint8Array(); } bool HasInstance(Local obj) { return obj->IsUint8Array(); } char* Data(Local val) { CHECK(val->IsUint8Array()); Local ui = val.As(); ArrayBuffer::Contents ab_c = ui->Buffer()->GetContents(); return static_cast(ab_c.Data()) + ui->ByteOffset(); } char* Data(Local obj) { CHECK(obj->IsUint8Array()); Local ui = obj.As(); ArrayBuffer::Contents ab_c = ui->Buffer()->GetContents(); return static_cast(ab_c.Data()) + ui->ByteOffset(); } size_t Length(Local val) { CHECK(val->IsUint8Array()); Local ui = val.As(); return ui->ByteLength(); } size_t Length(Local obj) { CHECK(obj->IsUint8Array()); Local ui = obj.As(); return ui->ByteLength(); } MaybeLocal New(Isolate* isolate, Local string, enum encoding enc) { EscapableHandleScope scope(isolate); const size_t length = StringBytes::Size(isolate, string, enc); size_t actual = 0; char* data = nullptr; if (length > 0) { data = static_cast(BUFFER_MALLOC(length)); if (data == nullptr) return Local(); actual = StringBytes::Write(isolate, data, length, string, enc); CHECK(actual <= length); if (actual == 0) { free(data); data = nullptr; } else if (actual < length) { data = static_cast(node::Realloc(data, actual)); CHECK_NE(data, nullptr); } } Local buf; if (New(isolate, data, actual).ToLocal(&buf)) return scope.Escape(buf); // Object failed to be created. Clean up resources. free(data); return Local(); } MaybeLocal New(Isolate* isolate, size_t length) { EscapableHandleScope handle_scope(isolate); Local obj; if (Buffer::New(Environment::GetCurrent(isolate), length).ToLocal(&obj)) return handle_scope.Escape(obj); return Local(); } MaybeLocal New(Environment* env, size_t length) { EscapableHandleScope scope(env->isolate()); // V8 currently only allows a maximum Typed Array index of max Smi. if (length > kMaxLength) { return Local(); } void* data; if (length > 0) { data = BUFFER_MALLOC(length); if (data == nullptr) return Local(); } else { data = nullptr; } Local ab = ArrayBuffer::New(env->isolate(), data, length, ArrayBufferCreationMode::kInternalized); Local ui = Uint8Array::New(ab, 0, length); Maybe mb = ui->SetPrototype(env->context(), env->buffer_prototype_object()); if (mb.FromMaybe(false)) return scope.Escape(ui); // Object failed to be created. Clean up resources. free(data); return Local(); } MaybeLocal Copy(Isolate* isolate, const char* data, size_t length) { EscapableHandleScope handle_scope(isolate); Environment* env = Environment::GetCurrent(isolate); Local obj; if (Buffer::Copy(env, data, length).ToLocal(&obj)) return handle_scope.Escape(obj); return Local(); } MaybeLocal Copy(Environment* env, const char* data, size_t length) { EscapableHandleScope scope(env->isolate()); // V8 currently only allows a maximum Typed Array index of max Smi. if (length > kMaxLength) { return Local(); } void* new_data; if (length > 0) { CHECK_NE(data, nullptr); new_data = node::Malloc(length); if (new_data == nullptr) return Local(); memcpy(new_data, data, length); } else { new_data = nullptr; } Local ab = ArrayBuffer::New(env->isolate(), new_data, length, ArrayBufferCreationMode::kInternalized); Local ui = Uint8Array::New(ab, 0, length); Maybe mb = ui->SetPrototype(env->context(), env->buffer_prototype_object()); if (mb.FromMaybe(false)) return scope.Escape(ui); // Object failed to be created. Clean up resources. free(new_data); return Local(); } MaybeLocal New(Isolate* isolate, char* data, size_t length, FreeCallback callback, void* hint) { EscapableHandleScope handle_scope(isolate); Environment* env = Environment::GetCurrent(isolate); Local obj; if (Buffer::New(env, data, length, callback, hint).ToLocal(&obj)) return handle_scope.Escape(obj); return Local(); } MaybeLocal New(Environment* env, char* data, size_t length, FreeCallback callback, void* hint) { EscapableHandleScope scope(env->isolate()); if (length > kMaxLength) { return Local(); } Local ab = ArrayBuffer::New(env->isolate(), data, length); Local ui = Uint8Array::New(ab, 0, length); Maybe mb = ui->SetPrototype(env->context(), env->buffer_prototype_object()); if (!mb.FromMaybe(false)) return Local(); CallbackInfo::New(env->isolate(), ab, callback, hint); return scope.Escape(ui); } MaybeLocal New(Isolate* isolate, char* data, size_t length) { EscapableHandleScope handle_scope(isolate); Environment* env = Environment::GetCurrent(isolate); Local obj; if (Buffer::New(env, data, length).ToLocal(&obj)) return handle_scope.Escape(obj); return Local(); } MaybeLocal New(Environment* env, char* data, size_t length) { EscapableHandleScope scope(env->isolate()); if (length > 0) { CHECK_NE(data, nullptr); CHECK(length <= kMaxLength); } Local ab = ArrayBuffer::New(env->isolate(), data, length, ArrayBufferCreationMode::kInternalized); Local ui = Uint8Array::New(ab, 0, length); Maybe mb = ui->SetPrototype(env->context(), env->buffer_prototype_object()); if (mb.FromMaybe(false)) return scope.Escape(ui); return Local(); } void CreateFromString(const FunctionCallbackInfo& args) { CHECK(args[0]->IsString()); CHECK(args[1]->IsString()); enum encoding enc = ParseEncoding(args.GetIsolate(), args[1].As(), UTF8); Local buf; if (New(args.GetIsolate(), args[0].As(), enc).ToLocal(&buf)) args.GetReturnValue().Set(buf); } void CreateFromArrayBuffer(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); if (!args[0]->IsArrayBuffer()) return env->ThrowTypeError("argument is not an ArrayBuffer"); Local ab = args[0].As(); Local ui = Uint8Array::New(ab, 0, ab->ByteLength()); Maybe mb = ui->SetPrototype(env->context(), env->buffer_prototype_object()); if (!mb.FromMaybe(false)) return env->ThrowError("Unable to set Object prototype"); args.GetReturnValue().Set(ui); } template void StringSlice(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); Isolate* isolate = env->isolate(); THROW_AND_RETURN_UNLESS_BUFFER(env, args.This()); SPREAD_ARG(args.This(), ts_obj); if (ts_obj_length == 0) return args.GetReturnValue().SetEmptyString(); SLICE_START_END(args[0], args[1], ts_obj_length) args.GetReturnValue().Set( StringBytes::Encode(isolate, ts_obj_data + start, length, encoding)); } template <> void StringSlice(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); THROW_AND_RETURN_UNLESS_BUFFER(env, args.This()); SPREAD_ARG(args.This(), ts_obj); if (ts_obj_length == 0) return args.GetReturnValue().SetEmptyString(); SLICE_START_END(args[0], args[1], ts_obj_length) length /= 2; const char* data = ts_obj_data + start; const uint16_t* buf; bool release = false; // Node's "ucs2" encoding expects LE character data inside a Buffer, so we // need to reorder on BE platforms. See http://nodejs.org/api/buffer.html // regarding Node's "ucs2" encoding specification. const bool aligned = (reinterpret_cast(data) % sizeof(*buf) == 0); if (IsLittleEndian() && !aligned) { // Make a copy to avoid unaligned accesses in v8::String::NewFromTwoByte(). // This applies ONLY to little endian platforms, as misalignment will be // handled by a byte-swapping operation in StringBytes::Encode on // big endian platforms. uint16_t* copy = new uint16_t[length]; for (size_t i = 0, k = 0; i < length; i += 1, k += 2) { // Assumes that the input is little endian. const uint8_t lo = static_cast(data[k + 0]); const uint8_t hi = static_cast(data[k + 1]); copy[i] = lo | hi << 8; } buf = copy; release = true; } else { buf = reinterpret_cast(data); } args.GetReturnValue().Set(StringBytes::Encode(env->isolate(), buf, length)); if (release) delete[] buf; } void BinarySlice(const FunctionCallbackInfo& args) { StringSlice(args); } void AsciiSlice(const FunctionCallbackInfo& args) { StringSlice(args); } void Utf8Slice(const FunctionCallbackInfo& args) { StringSlice(args); } void Ucs2Slice(const FunctionCallbackInfo& args) { StringSlice(args); } void HexSlice(const FunctionCallbackInfo& args) { StringSlice(args); } void Base64Slice(const FunctionCallbackInfo& args) { StringSlice(args); } // bytesCopied = buffer.copy(target[, targetStart][, sourceStart][, sourceEnd]); void Copy(const FunctionCallbackInfo &args) { Environment* env = Environment::GetCurrent(args); THROW_AND_RETURN_UNLESS_BUFFER(env, args.This()); THROW_AND_RETURN_UNLESS_BUFFER(env, args[0]); Local target_obj = args[0].As(); SPREAD_ARG(args.This(), ts_obj); SPREAD_ARG(target_obj, target); size_t target_start; size_t source_start; size_t source_end; CHECK_NOT_OOB(ParseArrayIndex(args[1], 0, &target_start)); CHECK_NOT_OOB(ParseArrayIndex(args[2], 0, &source_start)); CHECK_NOT_OOB(ParseArrayIndex(args[3], ts_obj_length, &source_end)); // Copy 0 bytes; we're done if (target_start >= target_length || source_start >= source_end) return args.GetReturnValue().Set(0); if (source_start > ts_obj_length) return env->ThrowRangeError("out of range index"); if (source_end - source_start > target_length - target_start) source_end = source_start + target_length - target_start; uint32_t to_copy = MIN(MIN(source_end - source_start, target_length - target_start), ts_obj_length - source_start); memmove(target_data + target_start, ts_obj_data + source_start, to_copy); args.GetReturnValue().Set(to_copy); } void Fill(const FunctionCallbackInfo& args) { THROW_AND_RETURN_UNLESS_BUFFER(Environment::GetCurrent(args), args[0]); SPREAD_ARG(args[0], ts_obj); size_t start = args[2]->Uint32Value(); size_t end = args[3]->Uint32Value(); size_t length = end - start; CHECK(length + start <= ts_obj_length); if (args[1]->IsNumber()) { int value = args[1]->Uint32Value() & 255; memset(ts_obj_data + start, value, length); return; } node::Utf8Value str(args.GetIsolate(), args[1]); size_t str_length = str.length(); size_t in_there = str_length; char* ptr = ts_obj_data + start + str_length; if (str_length == 0) return; memcpy(ts_obj_data + start, *str, MIN(str_length, length)); if (str_length >= length) return; while (in_there < length - in_there) { memcpy(ptr, ts_obj_data + start, in_there); ptr += in_there; in_there *= 2; } if (in_there < length) { memcpy(ptr, ts_obj_data + start, length - in_there); in_there = length; } } template void StringWrite(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); THROW_AND_RETURN_UNLESS_BUFFER(env, args.This()); SPREAD_ARG(args.This(), ts_obj); if (!args[0]->IsString()) return env->ThrowTypeError("Argument must be a string"); Local str = args[0]->ToString(env->isolate()); if (encoding == HEX && str->Length() % 2 != 0) return env->ThrowTypeError("Invalid hex string"); size_t offset; size_t max_length; CHECK_NOT_OOB(ParseArrayIndex(args[1], 0, &offset)); CHECK_NOT_OOB(ParseArrayIndex(args[2], ts_obj_length - offset, &max_length)); max_length = MIN(ts_obj_length - offset, max_length); if (max_length == 0) return args.GetReturnValue().Set(0); if (offset >= ts_obj_length) return env->ThrowRangeError("Offset is out of bounds"); uint32_t written = StringBytes::Write(env->isolate(), ts_obj_data + offset, max_length, str, encoding, nullptr); args.GetReturnValue().Set(written); } void Base64Write(const FunctionCallbackInfo& args) { StringWrite(args); } void BinaryWrite(const FunctionCallbackInfo& args) { StringWrite(args); } void Utf8Write(const FunctionCallbackInfo& args) { StringWrite(args); } void Ucs2Write(const FunctionCallbackInfo& args) { StringWrite(args); } void HexWrite(const FunctionCallbackInfo& args) { StringWrite(args); } void AsciiWrite(const FunctionCallbackInfo& args) { StringWrite(args); } static inline void Swizzle(char* start, unsigned int len) { char* end = start + len - 1; while (start < end) { char tmp = *start; *start++ = *end; *end-- = tmp; } } template void ReadFloatGeneric(const FunctionCallbackInfo& args) { THROW_AND_RETURN_UNLESS_BUFFER(Environment::GetCurrent(args), args[0]); SPREAD_ARG(args[0], ts_obj); uint32_t offset = args[1]->Uint32Value(); CHECK_LE(offset + sizeof(T), ts_obj_length); union NoAlias { T val; char bytes[sizeof(T)]; }; union NoAlias na; const char* ptr = static_cast(ts_obj_data) + offset; memcpy(na.bytes, ptr, sizeof(na.bytes)); if (endianness != GetEndianness()) Swizzle(na.bytes, sizeof(na.bytes)); args.GetReturnValue().Set(na.val); } void ReadFloatLE(const FunctionCallbackInfo& args) { ReadFloatGeneric(args); } void ReadFloatBE(const FunctionCallbackInfo& args) { ReadFloatGeneric(args); } void ReadDoubleLE(const FunctionCallbackInfo& args) { ReadFloatGeneric(args); } void ReadDoubleBE(const FunctionCallbackInfo& args) { ReadFloatGeneric(args); } template uint32_t WriteFloatGeneric(const FunctionCallbackInfo& args) { SPREAD_ARG(args[0], ts_obj); T val = args[1]->NumberValue(); uint32_t offset = args[2]->Uint32Value(); size_t memcpy_num = sizeof(T); if (offset + sizeof(T) > ts_obj_length) memcpy_num = ts_obj_length - offset; union NoAlias { T val; char bytes[sizeof(T)]; }; union NoAlias na = { val }; char* ptr = static_cast(ts_obj_data) + offset; if (endianness != GetEndianness()) Swizzle(na.bytes, sizeof(na.bytes)); memcpy(ptr, na.bytes, memcpy_num); return offset + memcpy_num; } void WriteFloatLE(const FunctionCallbackInfo& args) { THROW_AND_RETURN_UNLESS_BUFFER(Environment::GetCurrent(args), args[0]); args.GetReturnValue().Set(WriteFloatGeneric(args)); } void WriteFloatBE(const FunctionCallbackInfo& args) { THROW_AND_RETURN_UNLESS_BUFFER(Environment::GetCurrent(args), args[0]); args.GetReturnValue().Set(WriteFloatGeneric(args)); } void WriteDoubleLE(const FunctionCallbackInfo& args) { THROW_AND_RETURN_UNLESS_BUFFER(Environment::GetCurrent(args), args[0]); args.GetReturnValue().Set(WriteFloatGeneric(args)); } void WriteDoubleBE(const FunctionCallbackInfo& args) { THROW_AND_RETURN_UNLESS_BUFFER(Environment::GetCurrent(args), args[0]); args.GetReturnValue().Set(WriteFloatGeneric(args)); } void ByteLengthUtf8(const FunctionCallbackInfo &args) { CHECK(args[0]->IsString()); // Fast case: avoid StringBytes on UTF8 string. Jump to v8. args.GetReturnValue().Set(args[0].As()->Utf8Length()); } void Compare(const FunctionCallbackInfo &args) { Environment* env = Environment::GetCurrent(args); THROW_AND_RETURN_UNLESS_BUFFER(env, args[0]); THROW_AND_RETURN_UNLESS_BUFFER(env, args[1]); SPREAD_ARG(args[0], obj_a); SPREAD_ARG(args[1], obj_b); size_t cmp_length = MIN(obj_a_length, obj_b_length); int val = cmp_length > 0 ? memcmp(obj_a_data, obj_b_data, cmp_length) : 0; // Normalize val to be an integer in the range of [1, -1] since // implementations of memcmp() can vary by platform. if (val == 0) { if (obj_a_length > obj_b_length) val = 1; else if (obj_a_length < obj_b_length) val = -1; } else { if (val > 0) val = 1; else val = -1; } args.GetReturnValue().Set(val); } void IndexOfString(const FunctionCallbackInfo& args) { ASSERT(args[1]->IsString()); ASSERT(args[2]->IsNumber()); enum encoding enc = ParseEncoding(args.GetIsolate(), args[3], UTF8); THROW_AND_RETURN_UNLESS_BUFFER(Environment::GetCurrent(args), args[0]); SPREAD_ARG(args[0], ts_obj); Local needle = args[1].As(); const char* haystack = ts_obj_data; // Round down to the nearest multiple of 2 in case of UCS2. const size_t haystack_length = (enc == UCS2) ? ts_obj_length &~ 1 : ts_obj_length; // NOLINT(whitespace/operators) const size_t needle_length = StringBytes::Size(args.GetIsolate(), needle, enc); if (needle_length == 0 || haystack_length == 0) { return args.GetReturnValue().Set(-1); } int64_t offset_i64 = args[2]->IntegerValue(); size_t offset = 0; if (offset_i64 < 0) { if (offset_i64 + static_cast(haystack_length) < 0) { offset = 0; } else { offset = static_cast(haystack_length + offset_i64); } } else { offset = static_cast(offset_i64); } if (haystack_length < offset || needle_length + offset > haystack_length) { return args.GetReturnValue().Set(-1); } size_t result = haystack_length; if (enc == UCS2) { String::Value needle_value(needle); if (*needle_value == nullptr) return args.GetReturnValue().Set(-1); if (haystack_length < 2 || needle_value.length() < 1) { return args.GetReturnValue().Set(-1); } if (IsBigEndian()) { StringBytes::InlineDecoder decoder; decoder.Decode(Environment::GetCurrent(args), needle, args[3], UCS2); const uint16_t* decoded_string = reinterpret_cast(decoder.out()); if (decoded_string == nullptr) return args.GetReturnValue().Set(-1); result = SearchString(reinterpret_cast(haystack), haystack_length / 2, decoded_string, decoder.size() / 2, offset / 2); } else { result = SearchString(reinterpret_cast(haystack), haystack_length / 2, reinterpret_cast(*needle_value), needle_value.length(), offset / 2); } result *= 2; } else if (enc == UTF8) { String::Utf8Value needle_value(needle); if (*needle_value == nullptr) return args.GetReturnValue().Set(-1); result = SearchString(reinterpret_cast(haystack), haystack_length, reinterpret_cast(*needle_value), needle_length, offset); } else if (enc == BINARY) { uint8_t* needle_data = static_cast(node::Malloc(needle_length)); if (needle_data == nullptr) { return args.GetReturnValue().Set(-1); } needle->WriteOneByte( needle_data, 0, needle_length, String::NO_NULL_TERMINATION); result = SearchString(reinterpret_cast(haystack), haystack_length, needle_data, needle_length, offset); free(needle_data); } args.GetReturnValue().Set( result == haystack_length ? -1 : static_cast(result)); } void IndexOfBuffer(const FunctionCallbackInfo& args) { ASSERT(args[1]->IsObject()); ASSERT(args[2]->IsNumber()); enum encoding enc = ParseEncoding(args.GetIsolate(), args[3], UTF8); THROW_AND_RETURN_UNLESS_BUFFER(Environment::GetCurrent(args), args[0]); SPREAD_ARG(args[0], ts_obj); SPREAD_ARG(args[1], buf); if (buf_length > 0) CHECK_NE(buf_data, nullptr); const char* haystack = ts_obj_data; const size_t haystack_length = ts_obj_length; const char* needle = buf_data; const size_t needle_length = buf_length; if (needle_length == 0 || haystack_length == 0) { return args.GetReturnValue().Set(-1); } int64_t offset_i64 = args[2]->IntegerValue(); size_t offset = 0; if (offset_i64 < 0) { if (offset_i64 + static_cast(haystack_length) < 0) offset = 0; else offset = static_cast(haystack_length + offset_i64); } else { offset = static_cast(offset_i64); } if (haystack_length < offset || needle_length + offset > haystack_length) { return args.GetReturnValue().Set(-1); } size_t result = haystack_length; if (enc == UCS2) { if (haystack_length < 2 || needle_length < 2) { return args.GetReturnValue().Set(-1); } result = SearchString( reinterpret_cast(haystack), haystack_length / 2, reinterpret_cast(needle), needle_length / 2, offset / 2); result *= 2; } else { result = SearchString( reinterpret_cast(haystack), haystack_length, reinterpret_cast(needle), needle_length, offset); } args.GetReturnValue().Set( result == haystack_length ? -1 : static_cast(result)); } void IndexOfNumber(const FunctionCallbackInfo& args) { ASSERT(args[1]->IsNumber()); ASSERT(args[2]->IsNumber()); THROW_AND_RETURN_UNLESS_BUFFER(Environment::GetCurrent(args), args[0]); SPREAD_ARG(args[0], ts_obj); uint32_t needle = args[1]->Uint32Value(); int64_t offset_i64 = args[2]->IntegerValue(); size_t offset; if (offset_i64 < 0) { if (offset_i64 + static_cast(ts_obj_length) < 0) offset = 0; else offset = static_cast(ts_obj_length + offset_i64); } else { offset = static_cast(offset_i64); } if (ts_obj_length == 0 || offset + 1 > ts_obj_length) return args.GetReturnValue().Set(-1); void* ptr = memchr(ts_obj_data + offset, needle, ts_obj_length - offset); char* ptr_char = static_cast(ptr); args.GetReturnValue().Set(ptr ? static_cast(ptr_char - ts_obj_data) : -1); } // pass Buffer object to load prototype methods void SetupBufferJS(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); CHECK(args[0]->IsObject()); Local proto = args[0].As(); env->set_buffer_prototype_object(proto); env->SetMethod(proto, "asciiSlice", AsciiSlice); env->SetMethod(proto, "base64Slice", Base64Slice); env->SetMethod(proto, "binarySlice", BinarySlice); env->SetMethod(proto, "hexSlice", HexSlice); env->SetMethod(proto, "ucs2Slice", Ucs2Slice); env->SetMethod(proto, "utf8Slice", Utf8Slice); env->SetMethod(proto, "asciiWrite", AsciiWrite); env->SetMethod(proto, "base64Write", Base64Write); env->SetMethod(proto, "binaryWrite", BinaryWrite); env->SetMethod(proto, "hexWrite", HexWrite); env->SetMethod(proto, "ucs2Write", Ucs2Write); env->SetMethod(proto, "utf8Write", Utf8Write); env->SetMethod(proto, "copy", Copy); CHECK(args[1]->IsObject()); Local bObj = args[1].As(); uint32_t* const fields = env->array_buffer_allocator_info()->fields(); uint32_t const fields_count = env->array_buffer_allocator_info()->fields_count(); Local array_buffer = ArrayBuffer::New(env->isolate(), fields, sizeof(*fields) * fields_count); bObj->Set(String::NewFromUtf8(env->isolate(), "flags"), Uint32Array::New(array_buffer, 0, fields_count)); } void Initialize(Local target, Local unused, Local context) { Environment* env = Environment::GetCurrent(context); env->SetMethod(target, "setupBufferJS", SetupBufferJS); env->SetMethod(target, "createFromString", CreateFromString); env->SetMethod(target, "createFromArrayBuffer", CreateFromArrayBuffer); env->SetMethod(target, "byteLengthUtf8", ByteLengthUtf8); env->SetMethod(target, "compare", Compare); env->SetMethod(target, "fill", Fill); env->SetMethod(target, "indexOfBuffer", IndexOfBuffer); env->SetMethod(target, "indexOfNumber", IndexOfNumber); env->SetMethod(target, "indexOfString", IndexOfString); env->SetMethod(target, "readDoubleBE", ReadDoubleBE); env->SetMethod(target, "readDoubleLE", ReadDoubleLE); env->SetMethod(target, "readFloatBE", ReadFloatBE); env->SetMethod(target, "readFloatLE", ReadFloatLE); env->SetMethod(target, "writeDoubleBE", WriteDoubleBE); env->SetMethod(target, "writeDoubleLE", WriteDoubleLE); env->SetMethod(target, "writeFloatBE", WriteFloatBE); env->SetMethod(target, "writeFloatLE", WriteFloatLE); target->Set(env->context(), FIXED_ONE_BYTE_STRING(env->isolate(), "kMaxLength"), Integer::NewFromUnsigned(env->isolate(), kMaxLength)).FromJust(); target->Set(env->context(), FIXED_ONE_BYTE_STRING(env->isolate(), "kStringMaxLength"), Integer::New(env->isolate(), String::kMaxLength)).FromJust(); } } // namespace Buffer } // namespace node NODE_MODULE_CONTEXT_AWARE_BUILTIN(buffer, node::Buffer::Initialize) node-v4.8.2/src/node_buffer.h000644 000766 000024 00000004402 13070706736 016177 0ustar00iojsstaff000000 000000 #ifndef SRC_NODE_BUFFER_H_ #define SRC_NODE_BUFFER_H_ #include "node.h" #include "v8.h" namespace node { extern bool zero_fill_all_buffers; namespace Buffer { static const unsigned int kMaxLength = sizeof(int32_t) == sizeof(intptr_t) ? 0x3fffffff : 0x7fffffff; NODE_EXTERN typedef void (*FreeCallback)(char* data, void* hint); NODE_EXTERN bool HasInstance(v8::Local val); NODE_EXTERN bool HasInstance(v8::Local val); NODE_EXTERN char* Data(v8::Local val); NODE_EXTERN char* Data(v8::Local val); NODE_EXTERN size_t Length(v8::Local val); NODE_EXTERN size_t Length(v8::Local val); // public constructor - data is copied NODE_EXTERN v8::MaybeLocal Copy(v8::Isolate* isolate, const char* data, size_t len); // public constructor NODE_EXTERN v8::MaybeLocal New(v8::Isolate* isolate, size_t length); // public constructor from string NODE_EXTERN v8::MaybeLocal New(v8::Isolate* isolate, v8::Local string, enum encoding enc = UTF8); // public constructor - data is used, callback is passed data on object gc NODE_EXTERN v8::MaybeLocal New(v8::Isolate* isolate, char* data, size_t length, FreeCallback callback, void* hint); // public constructor - data is used. NODE_EXTERN v8::MaybeLocal New(v8::Isolate* isolate, char* data, size_t len); // This is verbose to be explicit with inline commenting static inline bool IsWithinBounds(size_t off, size_t len, size_t max) { // Asking to seek too far into the buffer // check to avoid wrapping in subsequent subtraction if (off > max) return false; // Asking for more than is left over in the buffer if (max - off < len) return false; // Otherwise we're in bounds return true; } } // namespace Buffer } // namespace node #endif // SRC_NODE_BUFFER_H_ node-v4.8.2/src/node_config.cc000644 000766 000024 00000002317 13070706736 016334 0ustar00iojsstaff000000 000000 #include "node.h" #include "env.h" #include "env-inl.h" #include "util.h" #include "util-inl.h" namespace node { using v8::Context; using v8::Local; using v8::Object; using v8::Value; using v8::ReadOnly; // The config binding is used to provide an internal view of compile or runtime // config options that are required internally by lib/*.js code. This is an // alternative to dropping additional properties onto the process object as // has been the practice previously in node.cc. #define READONLY_BOOLEAN_PROPERTY(str) \ do { \ target->DefineOwnProperty(env->context(), \ OneByteString(env->isolate(), str), \ True(env->isolate()), ReadOnly).FromJust(); \ } while (0) void InitConfig(Local target, Local unused, Local context) { #ifdef NODE_FIPS_MODE Environment* env = Environment::GetCurrent(context); READONLY_BOOLEAN_PROPERTY("fipsMode"); #endif } } // namespace node NODE_MODULE_CONTEXT_AWARE_BUILTIN(config, node::InitConfig) node-v4.8.2/src/node_constants.cc000644 000766 000024 00000052424 13070706736 017107 0ustar00iojsstaff000000 000000 #include "node_constants.h" #include "uv.h" #include #if !defined(_MSC_VER) #include #endif #include #include #include #include #if HAVE_OPENSSL # include # include # ifndef OPENSSL_NO_ENGINE # include # endif // !OPENSSL_NO_ENGINE #endif namespace node { using v8::Local; using v8::Object; #if HAVE_OPENSSL const char* default_cipher_list = DEFAULT_CIPHER_LIST_CORE; #endif void DefineErrnoConstants(Local target) { #ifdef E2BIG NODE_DEFINE_CONSTANT(target, E2BIG); #endif #ifdef EACCES NODE_DEFINE_CONSTANT(target, EACCES); #endif #ifdef EADDRINUSE NODE_DEFINE_CONSTANT(target, EADDRINUSE); #endif #ifdef EADDRNOTAVAIL NODE_DEFINE_CONSTANT(target, EADDRNOTAVAIL); #endif #ifdef EAFNOSUPPORT NODE_DEFINE_CONSTANT(target, EAFNOSUPPORT); #endif #ifdef EAGAIN NODE_DEFINE_CONSTANT(target, EAGAIN); #endif #ifdef EALREADY NODE_DEFINE_CONSTANT(target, EALREADY); #endif #ifdef EBADF NODE_DEFINE_CONSTANT(target, EBADF); #endif #ifdef EBADMSG NODE_DEFINE_CONSTANT(target, EBADMSG); #endif #ifdef EBUSY NODE_DEFINE_CONSTANT(target, EBUSY); #endif #ifdef ECANCELED NODE_DEFINE_CONSTANT(target, ECANCELED); #endif #ifdef ECHILD NODE_DEFINE_CONSTANT(target, ECHILD); #endif #ifdef ECONNABORTED NODE_DEFINE_CONSTANT(target, ECONNABORTED); #endif #ifdef ECONNREFUSED NODE_DEFINE_CONSTANT(target, ECONNREFUSED); #endif #ifdef ECONNRESET NODE_DEFINE_CONSTANT(target, ECONNRESET); #endif #ifdef EDEADLK NODE_DEFINE_CONSTANT(target, EDEADLK); #endif #ifdef EDESTADDRREQ NODE_DEFINE_CONSTANT(target, EDESTADDRREQ); #endif #ifdef EDOM NODE_DEFINE_CONSTANT(target, EDOM); #endif #ifdef EDQUOT NODE_DEFINE_CONSTANT(target, EDQUOT); #endif #ifdef EEXIST NODE_DEFINE_CONSTANT(target, EEXIST); #endif #ifdef EFAULT NODE_DEFINE_CONSTANT(target, EFAULT); #endif #ifdef EFBIG NODE_DEFINE_CONSTANT(target, EFBIG); #endif #ifdef EHOSTUNREACH NODE_DEFINE_CONSTANT(target, EHOSTUNREACH); #endif #ifdef EIDRM NODE_DEFINE_CONSTANT(target, EIDRM); #endif #ifdef EILSEQ NODE_DEFINE_CONSTANT(target, EILSEQ); #endif #ifdef EINPROGRESS NODE_DEFINE_CONSTANT(target, EINPROGRESS); #endif #ifdef EINTR NODE_DEFINE_CONSTANT(target, EINTR); #endif #ifdef EINVAL NODE_DEFINE_CONSTANT(target, EINVAL); #endif #ifdef EIO NODE_DEFINE_CONSTANT(target, EIO); #endif #ifdef EISCONN NODE_DEFINE_CONSTANT(target, EISCONN); #endif #ifdef EISDIR NODE_DEFINE_CONSTANT(target, EISDIR); #endif #ifdef ELOOP NODE_DEFINE_CONSTANT(target, ELOOP); #endif #ifdef EMFILE NODE_DEFINE_CONSTANT(target, EMFILE); #endif #ifdef EMLINK NODE_DEFINE_CONSTANT(target, EMLINK); #endif #ifdef EMSGSIZE NODE_DEFINE_CONSTANT(target, EMSGSIZE); #endif #ifdef EMULTIHOP NODE_DEFINE_CONSTANT(target, EMULTIHOP); #endif #ifdef ENAMETOOLONG NODE_DEFINE_CONSTANT(target, ENAMETOOLONG); #endif #ifdef ENETDOWN NODE_DEFINE_CONSTANT(target, ENETDOWN); #endif #ifdef ENETRESET NODE_DEFINE_CONSTANT(target, ENETRESET); #endif #ifdef ENETUNREACH NODE_DEFINE_CONSTANT(target, ENETUNREACH); #endif #ifdef ENFILE NODE_DEFINE_CONSTANT(target, ENFILE); #endif #ifdef ENOBUFS NODE_DEFINE_CONSTANT(target, ENOBUFS); #endif #ifdef ENODATA NODE_DEFINE_CONSTANT(target, ENODATA); #endif #ifdef ENODEV NODE_DEFINE_CONSTANT(target, ENODEV); #endif #ifdef ENOENT NODE_DEFINE_CONSTANT(target, ENOENT); #endif #ifdef ENOEXEC NODE_DEFINE_CONSTANT(target, ENOEXEC); #endif #ifdef ENOLCK NODE_DEFINE_CONSTANT(target, ENOLCK); #endif #ifdef ENOLINK NODE_DEFINE_CONSTANT(target, ENOLINK); #endif #ifdef ENOMEM NODE_DEFINE_CONSTANT(target, ENOMEM); #endif #ifdef ENOMSG NODE_DEFINE_CONSTANT(target, ENOMSG); #endif #ifdef ENOPROTOOPT NODE_DEFINE_CONSTANT(target, ENOPROTOOPT); #endif #ifdef ENOSPC NODE_DEFINE_CONSTANT(target, ENOSPC); #endif #ifdef ENOSR NODE_DEFINE_CONSTANT(target, ENOSR); #endif #ifdef ENOSTR NODE_DEFINE_CONSTANT(target, ENOSTR); #endif #ifdef ENOSYS NODE_DEFINE_CONSTANT(target, ENOSYS); #endif #ifdef ENOTCONN NODE_DEFINE_CONSTANT(target, ENOTCONN); #endif #ifdef ENOTDIR NODE_DEFINE_CONSTANT(target, ENOTDIR); #endif #ifdef ENOTEMPTY NODE_DEFINE_CONSTANT(target, ENOTEMPTY); #endif #ifdef ENOTSOCK NODE_DEFINE_CONSTANT(target, ENOTSOCK); #endif #ifdef ENOTSUP NODE_DEFINE_CONSTANT(target, ENOTSUP); #endif #ifdef ENOTTY NODE_DEFINE_CONSTANT(target, ENOTTY); #endif #ifdef ENXIO NODE_DEFINE_CONSTANT(target, ENXIO); #endif #ifdef EOPNOTSUPP NODE_DEFINE_CONSTANT(target, EOPNOTSUPP); #endif #ifdef EOVERFLOW NODE_DEFINE_CONSTANT(target, EOVERFLOW); #endif #ifdef EPERM NODE_DEFINE_CONSTANT(target, EPERM); #endif #ifdef EPIPE NODE_DEFINE_CONSTANT(target, EPIPE); #endif #ifdef EPROTO NODE_DEFINE_CONSTANT(target, EPROTO); #endif #ifdef EPROTONOSUPPORT NODE_DEFINE_CONSTANT(target, EPROTONOSUPPORT); #endif #ifdef EPROTOTYPE NODE_DEFINE_CONSTANT(target, EPROTOTYPE); #endif #ifdef ERANGE NODE_DEFINE_CONSTANT(target, ERANGE); #endif #ifdef EROFS NODE_DEFINE_CONSTANT(target, EROFS); #endif #ifdef ESPIPE NODE_DEFINE_CONSTANT(target, ESPIPE); #endif #ifdef ESRCH NODE_DEFINE_CONSTANT(target, ESRCH); #endif #ifdef ESTALE NODE_DEFINE_CONSTANT(target, ESTALE); #endif #ifdef ETIME NODE_DEFINE_CONSTANT(target, ETIME); #endif #ifdef ETIMEDOUT NODE_DEFINE_CONSTANT(target, ETIMEDOUT); #endif #ifdef ETXTBSY NODE_DEFINE_CONSTANT(target, ETXTBSY); #endif #ifdef EWOULDBLOCK NODE_DEFINE_CONSTANT(target, EWOULDBLOCK); #endif #ifdef EXDEV NODE_DEFINE_CONSTANT(target, EXDEV); #endif } void DefineWindowsErrorConstants(Local target) { #ifdef WSAEINTR NODE_DEFINE_CONSTANT(target, WSAEINTR); #endif #ifdef WSAEBADF NODE_DEFINE_CONSTANT(target, WSAEBADF); #endif #ifdef WSAEACCES NODE_DEFINE_CONSTANT(target, WSAEACCES); #endif #ifdef WSAEFAULT NODE_DEFINE_CONSTANT(target, WSAEFAULT); #endif #ifdef WSAEINVAL NODE_DEFINE_CONSTANT(target, WSAEINVAL); #endif #ifdef WSAEMFILE NODE_DEFINE_CONSTANT(target, WSAEMFILE); #endif #ifdef WSAEWOULDBLOCK NODE_DEFINE_CONSTANT(target, WSAEWOULDBLOCK); #endif #ifdef WSAEINPROGRESS NODE_DEFINE_CONSTANT(target, WSAEINPROGRESS); #endif #ifdef WSAEALREADY NODE_DEFINE_CONSTANT(target, WSAEALREADY); #endif #ifdef WSAENOTSOCK NODE_DEFINE_CONSTANT(target, WSAENOTSOCK); #endif #ifdef WSAEDESTADDRREQ NODE_DEFINE_CONSTANT(target, WSAEDESTADDRREQ); #endif #ifdef WSAEMSGSIZE NODE_DEFINE_CONSTANT(target, WSAEMSGSIZE); #endif #ifdef WSAEPROTOTYPE NODE_DEFINE_CONSTANT(target, WSAEPROTOTYPE); #endif #ifdef WSAENOPROTOOPT NODE_DEFINE_CONSTANT(target, WSAENOPROTOOPT); #endif #ifdef WSAEPROTONOSUPPORT NODE_DEFINE_CONSTANT(target, WSAEPROTONOSUPPORT); #endif #ifdef WSAESOCKTNOSUPPORT NODE_DEFINE_CONSTANT(target, WSAESOCKTNOSUPPORT); #endif #ifdef WSAEOPNOTSUPP NODE_DEFINE_CONSTANT(target, WSAEOPNOTSUPP); #endif #ifdef WSAEPFNOSUPPORT NODE_DEFINE_CONSTANT(target, WSAEPFNOSUPPORT); #endif #ifdef WSAEAFNOSUPPORT NODE_DEFINE_CONSTANT(target, WSAEAFNOSUPPORT); #endif #ifdef WSAEADDRINUSE NODE_DEFINE_CONSTANT(target, WSAEADDRINUSE); #endif #ifdef WSAEADDRNOTAVAIL NODE_DEFINE_CONSTANT(target, WSAEADDRNOTAVAIL); #endif #ifdef WSAENETDOWN NODE_DEFINE_CONSTANT(target, WSAENETDOWN); #endif #ifdef WSAENETUNREACH NODE_DEFINE_CONSTANT(target, WSAENETUNREACH); #endif #ifdef WSAENETRESET NODE_DEFINE_CONSTANT(target, WSAENETRESET); #endif #ifdef WSAECONNABORTED NODE_DEFINE_CONSTANT(target, WSAECONNABORTED); #endif #ifdef WSAECONNRESET NODE_DEFINE_CONSTANT(target, WSAECONNRESET); #endif #ifdef WSAENOBUFS NODE_DEFINE_CONSTANT(target, WSAENOBUFS); #endif #ifdef WSAEISCONN NODE_DEFINE_CONSTANT(target, WSAEISCONN); #endif #ifdef WSAENOTCONN NODE_DEFINE_CONSTANT(target, WSAENOTCONN); #endif #ifdef WSAESHUTDOWN NODE_DEFINE_CONSTANT(target, WSAESHUTDOWN); #endif #ifdef WSAETOOMANYREFS NODE_DEFINE_CONSTANT(target, WSAETOOMANYREFS); #endif #ifdef WSAETIMEDOUT NODE_DEFINE_CONSTANT(target, WSAETIMEDOUT); #endif #ifdef WSAECONNREFUSED NODE_DEFINE_CONSTANT(target, WSAECONNREFUSED); #endif #ifdef WSAELOOP NODE_DEFINE_CONSTANT(target, WSAELOOP); #endif #ifdef WSAENAMETOOLONG NODE_DEFINE_CONSTANT(target, WSAENAMETOOLONG); #endif #ifdef WSAEHOSTDOWN NODE_DEFINE_CONSTANT(target, WSAEHOSTDOWN); #endif #ifdef WSAEHOSTUNREACH NODE_DEFINE_CONSTANT(target, WSAEHOSTUNREACH); #endif #ifdef WSAENOTEMPTY NODE_DEFINE_CONSTANT(target, WSAENOTEMPTY); #endif #ifdef WSAEPROCLIM NODE_DEFINE_CONSTANT(target, WSAEPROCLIM); #endif #ifdef WSAEUSERS NODE_DEFINE_CONSTANT(target, WSAEUSERS); #endif #ifdef WSAEDQUOT NODE_DEFINE_CONSTANT(target, WSAEDQUOT); #endif #ifdef WSAESTALE NODE_DEFINE_CONSTANT(target, WSAESTALE); #endif #ifdef WSAEREMOTE NODE_DEFINE_CONSTANT(target, WSAEREMOTE); #endif #ifdef WSASYSNOTREADY NODE_DEFINE_CONSTANT(target, WSASYSNOTREADY); #endif #ifdef WSAVERNOTSUPPORTED NODE_DEFINE_CONSTANT(target, WSAVERNOTSUPPORTED); #endif #ifdef WSANOTINITIALISED NODE_DEFINE_CONSTANT(target, WSANOTINITIALISED); #endif #ifdef WSAEDISCON NODE_DEFINE_CONSTANT(target, WSAEDISCON); #endif #ifdef WSAENOMORE NODE_DEFINE_CONSTANT(target, WSAENOMORE); #endif #ifdef WSAECANCELLED NODE_DEFINE_CONSTANT(target, WSAECANCELLED); #endif #ifdef WSAEINVALIDPROCTABLE NODE_DEFINE_CONSTANT(target, WSAEINVALIDPROCTABLE); #endif #ifdef WSAEINVALIDPROVIDER NODE_DEFINE_CONSTANT(target, WSAEINVALIDPROVIDER); #endif #ifdef WSAEPROVIDERFAILEDINIT NODE_DEFINE_CONSTANT(target, WSAEPROVIDERFAILEDINIT); #endif #ifdef WSASYSCALLFAILURE NODE_DEFINE_CONSTANT(target, WSASYSCALLFAILURE); #endif #ifdef WSASERVICE_NOT_FOUND NODE_DEFINE_CONSTANT(target, WSASERVICE_NOT_FOUND); #endif #ifdef WSATYPE_NOT_FOUND NODE_DEFINE_CONSTANT(target, WSATYPE_NOT_FOUND); #endif #ifdef WSA_E_NO_MORE NODE_DEFINE_CONSTANT(target, WSA_E_NO_MORE); #endif #ifdef WSA_E_CANCELLED NODE_DEFINE_CONSTANT(target, WSA_E_CANCELLED); #endif #ifdef WSAEREFUSED NODE_DEFINE_CONSTANT(target, WSAEREFUSED); #endif } void DefineSignalConstants(Local target) { #ifdef SIGHUP NODE_DEFINE_CONSTANT(target, SIGHUP); #endif #ifdef SIGINT NODE_DEFINE_CONSTANT(target, SIGINT); #endif #ifdef SIGQUIT NODE_DEFINE_CONSTANT(target, SIGQUIT); #endif #ifdef SIGILL NODE_DEFINE_CONSTANT(target, SIGILL); #endif #ifdef SIGTRAP NODE_DEFINE_CONSTANT(target, SIGTRAP); #endif #ifdef SIGABRT NODE_DEFINE_CONSTANT(target, SIGABRT); #endif #ifdef SIGIOT NODE_DEFINE_CONSTANT(target, SIGIOT); #endif #ifdef SIGBUS NODE_DEFINE_CONSTANT(target, SIGBUS); #endif #ifdef SIGFPE NODE_DEFINE_CONSTANT(target, SIGFPE); #endif #ifdef SIGKILL NODE_DEFINE_CONSTANT(target, SIGKILL); #endif #ifdef SIGUSR1 NODE_DEFINE_CONSTANT(target, SIGUSR1); #endif #ifdef SIGSEGV NODE_DEFINE_CONSTANT(target, SIGSEGV); #endif #ifdef SIGUSR2 NODE_DEFINE_CONSTANT(target, SIGUSR2); #endif #ifdef SIGPIPE NODE_DEFINE_CONSTANT(target, SIGPIPE); #endif #ifdef SIGALRM NODE_DEFINE_CONSTANT(target, SIGALRM); #endif NODE_DEFINE_CONSTANT(target, SIGTERM); #ifdef SIGCHLD NODE_DEFINE_CONSTANT(target, SIGCHLD); #endif #ifdef SIGSTKFLT NODE_DEFINE_CONSTANT(target, SIGSTKFLT); #endif #ifdef SIGCONT NODE_DEFINE_CONSTANT(target, SIGCONT); #endif #ifdef SIGSTOP NODE_DEFINE_CONSTANT(target, SIGSTOP); #endif #ifdef SIGTSTP NODE_DEFINE_CONSTANT(target, SIGTSTP); #endif #ifdef SIGBREAK NODE_DEFINE_CONSTANT(target, SIGBREAK); #endif #ifdef SIGTTIN NODE_DEFINE_CONSTANT(target, SIGTTIN); #endif #ifdef SIGTTOU NODE_DEFINE_CONSTANT(target, SIGTTOU); #endif #ifdef SIGURG NODE_DEFINE_CONSTANT(target, SIGURG); #endif #ifdef SIGXCPU NODE_DEFINE_CONSTANT(target, SIGXCPU); #endif #ifdef SIGXFSZ NODE_DEFINE_CONSTANT(target, SIGXFSZ); #endif #ifdef SIGVTALRM NODE_DEFINE_CONSTANT(target, SIGVTALRM); #endif #ifdef SIGPROF NODE_DEFINE_CONSTANT(target, SIGPROF); #endif #ifdef SIGWINCH NODE_DEFINE_CONSTANT(target, SIGWINCH); #endif #ifdef SIGIO NODE_DEFINE_CONSTANT(target, SIGIO); #endif #ifdef SIGPOLL NODE_DEFINE_CONSTANT(target, SIGPOLL); #endif #ifdef SIGLOST NODE_DEFINE_CONSTANT(target, SIGLOST); #endif #ifdef SIGPWR NODE_DEFINE_CONSTANT(target, SIGPWR); #endif #ifdef SIGSYS NODE_DEFINE_CONSTANT(target, SIGSYS); #endif #ifdef SIGUNUSED NODE_DEFINE_CONSTANT(target, SIGUNUSED); #endif } void DefineOpenSSLConstants(Local target) { #ifdef SSL_OP_ALL NODE_DEFINE_CONSTANT(target, SSL_OP_ALL); #endif #ifdef SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION NODE_DEFINE_CONSTANT(target, SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION); #endif #ifdef SSL_OP_CIPHER_SERVER_PREFERENCE NODE_DEFINE_CONSTANT(target, SSL_OP_CIPHER_SERVER_PREFERENCE); #endif #ifdef SSL_OP_CISCO_ANYCONNECT NODE_DEFINE_CONSTANT(target, SSL_OP_CISCO_ANYCONNECT); #endif #ifdef SSL_OP_COOKIE_EXCHANGE NODE_DEFINE_CONSTANT(target, SSL_OP_COOKIE_EXCHANGE); #endif #ifdef SSL_OP_CRYPTOPRO_TLSEXT_BUG NODE_DEFINE_CONSTANT(target, SSL_OP_CRYPTOPRO_TLSEXT_BUG); #endif #ifdef SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS NODE_DEFINE_CONSTANT(target, SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS); #endif #ifdef SSL_OP_EPHEMERAL_RSA NODE_DEFINE_CONSTANT(target, SSL_OP_EPHEMERAL_RSA); #endif #ifdef SSL_OP_LEGACY_SERVER_CONNECT NODE_DEFINE_CONSTANT(target, SSL_OP_LEGACY_SERVER_CONNECT); #endif #ifdef SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER NODE_DEFINE_CONSTANT(target, SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER); #endif #ifdef SSL_OP_MICROSOFT_SESS_ID_BUG NODE_DEFINE_CONSTANT(target, SSL_OP_MICROSOFT_SESS_ID_BUG); #endif #ifdef SSL_OP_MSIE_SSLV2_RSA_PADDING NODE_DEFINE_CONSTANT(target, SSL_OP_MSIE_SSLV2_RSA_PADDING); #endif #ifdef SSL_OP_NETSCAPE_CA_DN_BUG NODE_DEFINE_CONSTANT(target, SSL_OP_NETSCAPE_CA_DN_BUG); #endif #ifdef SSL_OP_NETSCAPE_CHALLENGE_BUG NODE_DEFINE_CONSTANT(target, SSL_OP_NETSCAPE_CHALLENGE_BUG); #endif #ifdef SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG NODE_DEFINE_CONSTANT(target, SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG); #endif #ifdef SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG NODE_DEFINE_CONSTANT(target, SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG); #endif #ifdef SSL_OP_NO_COMPRESSION NODE_DEFINE_CONSTANT(target, SSL_OP_NO_COMPRESSION); #endif #ifdef SSL_OP_NO_QUERY_MTU NODE_DEFINE_CONSTANT(target, SSL_OP_NO_QUERY_MTU); #endif #ifdef SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION NODE_DEFINE_CONSTANT(target, SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION); #endif #ifdef SSL_OP_NO_SSLv2 NODE_DEFINE_CONSTANT(target, SSL_OP_NO_SSLv2); #endif #ifdef SSL_OP_NO_SSLv3 NODE_DEFINE_CONSTANT(target, SSL_OP_NO_SSLv3); #endif #ifdef SSL_OP_NO_TICKET NODE_DEFINE_CONSTANT(target, SSL_OP_NO_TICKET); #endif #ifdef SSL_OP_NO_TLSv1 NODE_DEFINE_CONSTANT(target, SSL_OP_NO_TLSv1); #endif #ifdef SSL_OP_NO_TLSv1_1 NODE_DEFINE_CONSTANT(target, SSL_OP_NO_TLSv1_1); #endif #ifdef SSL_OP_NO_TLSv1_2 NODE_DEFINE_CONSTANT(target, SSL_OP_NO_TLSv1_2); #endif #ifdef SSL_OP_PKCS1_CHECK_1 NODE_DEFINE_CONSTANT(target, SSL_OP_PKCS1_CHECK_1); #endif #ifdef SSL_OP_PKCS1_CHECK_2 NODE_DEFINE_CONSTANT(target, SSL_OP_PKCS1_CHECK_2); #endif #ifdef SSL_OP_SINGLE_DH_USE NODE_DEFINE_CONSTANT(target, SSL_OP_SINGLE_DH_USE); #endif #ifdef SSL_OP_SINGLE_ECDH_USE NODE_DEFINE_CONSTANT(target, SSL_OP_SINGLE_ECDH_USE); #endif #ifdef SSL_OP_SSLEAY_080_CLIENT_DH_BUG NODE_DEFINE_CONSTANT(target, SSL_OP_SSLEAY_080_CLIENT_DH_BUG); #endif #ifdef SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG NODE_DEFINE_CONSTANT(target, SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG); #endif #ifdef SSL_OP_TLS_BLOCK_PADDING_BUG NODE_DEFINE_CONSTANT(target, SSL_OP_TLS_BLOCK_PADDING_BUG); #endif #ifdef SSL_OP_TLS_D5_BUG NODE_DEFINE_CONSTANT(target, SSL_OP_TLS_D5_BUG); #endif #ifdef SSL_OP_TLS_ROLLBACK_BUG NODE_DEFINE_CONSTANT(target, SSL_OP_TLS_ROLLBACK_BUG); #endif # ifndef OPENSSL_NO_ENGINE # ifdef ENGINE_METHOD_DSA NODE_DEFINE_CONSTANT(target, ENGINE_METHOD_DSA); # endif # ifdef ENGINE_METHOD_DH NODE_DEFINE_CONSTANT(target, ENGINE_METHOD_DH); # endif # ifdef ENGINE_METHOD_RAND NODE_DEFINE_CONSTANT(target, ENGINE_METHOD_RAND); # endif # ifdef ENGINE_METHOD_ECDH NODE_DEFINE_CONSTANT(target, ENGINE_METHOD_ECDH); # endif # ifdef ENGINE_METHOD_ECDSA NODE_DEFINE_CONSTANT(target, ENGINE_METHOD_ECDSA); # endif # ifdef ENGINE_METHOD_CIPHERS NODE_DEFINE_CONSTANT(target, ENGINE_METHOD_CIPHERS); # endif # ifdef ENGINE_METHOD_DIGESTS NODE_DEFINE_CONSTANT(target, ENGINE_METHOD_DIGESTS); # endif # ifdef ENGINE_METHOD_STORE NODE_DEFINE_CONSTANT(target, ENGINE_METHOD_STORE); # endif # ifdef ENGINE_METHOD_PKEY_METHS NODE_DEFINE_CONSTANT(target, ENGINE_METHOD_PKEY_METHS); # endif # ifdef ENGINE_METHOD_PKEY_ASN1_METHS NODE_DEFINE_CONSTANT(target, ENGINE_METHOD_PKEY_ASN1_METHS); # endif # ifdef ENGINE_METHOD_ALL NODE_DEFINE_CONSTANT(target, ENGINE_METHOD_ALL); # endif # ifdef ENGINE_METHOD_NONE NODE_DEFINE_CONSTANT(target, ENGINE_METHOD_NONE); # endif # endif // !OPENSSL_NO_ENGINE #ifdef DH_CHECK_P_NOT_SAFE_PRIME NODE_DEFINE_CONSTANT(target, DH_CHECK_P_NOT_SAFE_PRIME); #endif #ifdef DH_CHECK_P_NOT_PRIME NODE_DEFINE_CONSTANT(target, DH_CHECK_P_NOT_PRIME); #endif #ifdef DH_UNABLE_TO_CHECK_GENERATOR NODE_DEFINE_CONSTANT(target, DH_UNABLE_TO_CHECK_GENERATOR); #endif #ifdef DH_NOT_SUITABLE_GENERATOR NODE_DEFINE_CONSTANT(target, DH_NOT_SUITABLE_GENERATOR); #endif #ifdef OPENSSL_NPN_NEGOTIATED #define NPN_ENABLED 1 NODE_DEFINE_CONSTANT(target, NPN_ENABLED); #endif #ifdef TLSEXT_TYPE_application_layer_protocol_negotiation #define ALPN_ENABLED 1 NODE_DEFINE_CONSTANT(target, ALPN_ENABLED); #endif #ifdef RSA_PKCS1_PADDING NODE_DEFINE_CONSTANT(target, RSA_PKCS1_PADDING); #endif #ifdef RSA_SSLV23_PADDING NODE_DEFINE_CONSTANT(target, RSA_SSLV23_PADDING); #endif #ifdef RSA_NO_PADDING NODE_DEFINE_CONSTANT(target, RSA_NO_PADDING); #endif #ifdef RSA_PKCS1_OAEP_PADDING NODE_DEFINE_CONSTANT(target, RSA_PKCS1_OAEP_PADDING); #endif #ifdef RSA_X931_PADDING NODE_DEFINE_CONSTANT(target, RSA_X931_PADDING); #endif #ifdef RSA_PKCS1_PSS_PADDING NODE_DEFINE_CONSTANT(target, RSA_PKCS1_PSS_PADDING); #endif #if HAVE_OPENSSL // NOTE: These are not defines NODE_DEFINE_CONSTANT(target, POINT_CONVERSION_COMPRESSED); NODE_DEFINE_CONSTANT(target, POINT_CONVERSION_UNCOMPRESSED); NODE_DEFINE_CONSTANT(target, POINT_CONVERSION_HYBRID); #endif } void DefineSystemConstants(Local target) { // file access modes NODE_DEFINE_CONSTANT(target, O_RDONLY); NODE_DEFINE_CONSTANT(target, O_WRONLY); NODE_DEFINE_CONSTANT(target, O_RDWR); NODE_DEFINE_CONSTANT(target, S_IFMT); NODE_DEFINE_CONSTANT(target, S_IFREG); NODE_DEFINE_CONSTANT(target, S_IFDIR); NODE_DEFINE_CONSTANT(target, S_IFCHR); #ifdef S_IFBLK NODE_DEFINE_CONSTANT(target, S_IFBLK); #endif #ifdef S_IFIFO NODE_DEFINE_CONSTANT(target, S_IFIFO); #endif #ifdef S_IFLNK NODE_DEFINE_CONSTANT(target, S_IFLNK); #endif #ifdef S_IFSOCK NODE_DEFINE_CONSTANT(target, S_IFSOCK); #endif #ifdef O_CREAT NODE_DEFINE_CONSTANT(target, O_CREAT); #endif #ifdef O_EXCL NODE_DEFINE_CONSTANT(target, O_EXCL); #endif #ifdef O_NOCTTY NODE_DEFINE_CONSTANT(target, O_NOCTTY); #endif #ifdef O_TRUNC NODE_DEFINE_CONSTANT(target, O_TRUNC); #endif #ifdef O_APPEND NODE_DEFINE_CONSTANT(target, O_APPEND); #endif #ifdef O_DIRECTORY NODE_DEFINE_CONSTANT(target, O_DIRECTORY); #endif #ifdef O_EXCL NODE_DEFINE_CONSTANT(target, O_EXCL); #endif #ifdef O_NOFOLLOW NODE_DEFINE_CONSTANT(target, O_NOFOLLOW); #endif #ifdef O_SYNC NODE_DEFINE_CONSTANT(target, O_SYNC); #endif #ifdef O_SYMLINK NODE_DEFINE_CONSTANT(target, O_SYMLINK); #endif #ifdef O_DIRECT NODE_DEFINE_CONSTANT(target, O_DIRECT); #endif #ifdef O_NONBLOCK NODE_DEFINE_CONSTANT(target, O_NONBLOCK); #endif #ifdef S_IRWXU NODE_DEFINE_CONSTANT(target, S_IRWXU); #endif #ifdef S_IRUSR NODE_DEFINE_CONSTANT(target, S_IRUSR); #endif #ifdef S_IWUSR NODE_DEFINE_CONSTANT(target, S_IWUSR); #endif #ifdef S_IXUSR NODE_DEFINE_CONSTANT(target, S_IXUSR); #endif #ifdef S_IRWXG NODE_DEFINE_CONSTANT(target, S_IRWXG); #endif #ifdef S_IRGRP NODE_DEFINE_CONSTANT(target, S_IRGRP); #endif #ifdef S_IWGRP NODE_DEFINE_CONSTANT(target, S_IWGRP); #endif #ifdef S_IXGRP NODE_DEFINE_CONSTANT(target, S_IXGRP); #endif #ifdef S_IRWXO NODE_DEFINE_CONSTANT(target, S_IRWXO); #endif #ifdef S_IROTH NODE_DEFINE_CONSTANT(target, S_IROTH); #endif #ifdef S_IWOTH NODE_DEFINE_CONSTANT(target, S_IWOTH); #endif #ifdef S_IXOTH NODE_DEFINE_CONSTANT(target, S_IXOTH); #endif #ifdef F_OK NODE_DEFINE_CONSTANT(target, F_OK); #endif #ifdef R_OK NODE_DEFINE_CONSTANT(target, R_OK); #endif #ifdef W_OK NODE_DEFINE_CONSTANT(target, W_OK); #endif #ifdef X_OK NODE_DEFINE_CONSTANT(target, X_OK); #endif } void DefineUVConstants(Local target) { NODE_DEFINE_CONSTANT(target, UV_UDP_REUSEADDR); } void DefineCryptoConstants(Local target) { #if HAVE_OPENSSL NODE_DEFINE_STRING_CONSTANT(target, "defaultCoreCipherList", DEFAULT_CIPHER_LIST_CORE); NODE_DEFINE_STRING_CONSTANT(target, "defaultCipherList", default_cipher_list); #endif } void DefineConstants(Local target) { DefineErrnoConstants(target); DefineWindowsErrorConstants(target); DefineSignalConstants(target); DefineOpenSSLConstants(target); DefineSystemConstants(target); DefineUVConstants(target); DefineCryptoConstants(target); } } // namespace node node-v4.8.2/src/node_constants.h000644 000766 000024 00000003334 13070706736 016745 0ustar00iojsstaff000000 000000 #ifndef SRC_NODE_CONSTANTS_H_ #define SRC_NODE_CONSTANTS_H_ #include "node.h" #include "v8.h" #if HAVE_OPENSSL #define DEFAULT_CIPHER_LIST_CORE "ECDHE-RSA-AES128-GCM-SHA256:" \ "ECDHE-ECDSA-AES128-GCM-SHA256:" \ "ECDHE-RSA-AES256-GCM-SHA384:" \ "ECDHE-ECDSA-AES256-GCM-SHA384:" \ "DHE-RSA-AES128-GCM-SHA256:" \ "ECDHE-RSA-AES128-SHA256:" \ "DHE-RSA-AES128-SHA256:" \ "ECDHE-RSA-AES256-SHA384:" \ "DHE-RSA-AES256-SHA384:" \ "ECDHE-RSA-AES256-SHA256:" \ "DHE-RSA-AES256-SHA256:" \ "HIGH:" \ "!aNULL:" \ "!eNULL:" \ "!EXPORT:" \ "!DES:" \ "!RC4:" \ "!MD5:" \ "!PSK:" \ "!SRP:" \ "!CAMELLIA" #endif namespace node { #if HAVE_OPENSSL extern const char* default_cipher_list; #endif void DefineConstants(v8::Local target); } // namespace node #endif // SRC_NODE_CONSTANTS_H_ node-v4.8.2/src/node_contextify.cc000644 000766 000024 00000057402 13070706736 017270 0ustar00iojsstaff000000 000000 #include "node.h" #include "node_internals.h" #include "node_watchdog.h" #include "base-object.h" #include "base-object-inl.h" #include "env.h" #include "env-inl.h" #include "util.h" #include "util-inl.h" #include "v8-debug.h" namespace node { using v8::AccessType; using v8::Array; using v8::Boolean; using v8::Context; using v8::Debug; using v8::EscapableHandleScope; using v8::External; using v8::Function; using v8::FunctionCallbackInfo; using v8::FunctionTemplate; using v8::HandleScope; using v8::Integer; using v8::Isolate; using v8::Local; using v8::Maybe; using v8::MaybeLocal; using v8::Name; using v8::NamedPropertyHandlerConfiguration; using v8::None; using v8::Object; using v8::ObjectTemplate; using v8::Persistent; using v8::PropertyAttribute; using v8::PropertyCallbackInfo; using v8::Script; using v8::ScriptCompiler; using v8::ScriptOrigin; using v8::String; using v8::TryCatch; using v8::UnboundScript; using v8::V8; using v8::Value; using v8::WeakCallbackInfo; class ContextifyContext { protected: // V8 reserves the first field in context objects for the debugger. We use the // second field to hold a reference to the sandbox object. enum { kSandboxObjectIndex = 1 }; Environment* const env_; Persistent context_; public: ContextifyContext(Environment* env, Local sandbox_obj) : env_(env) { Local v8_context = CreateV8Context(env, sandbox_obj); context_.Reset(env->isolate(), v8_context); // Allocation failure or maximum call stack size reached if (context_.IsEmpty()) return; context_.SetWeak(this, WeakCallback, v8::WeakCallbackType::kParameter); context_.MarkIndependent(); } ~ContextifyContext() { context_.Reset(); } inline Environment* env() const { return env_; } inline Local context() const { return PersistentToLocal(env()->isolate(), context_); } inline Local global_proxy() const { return context()->Global(); } inline Local sandbox() const { return Local::Cast(context()->GetEmbedderData(kSandboxObjectIndex)); } // XXX(isaacs): This function only exists because of a shortcoming of // the V8 SetNamedPropertyHandler function. // // It does not provide a way to intercept Object.defineProperty(..) // calls. As a result, these properties are not copied onto the // contextified sandbox when a new global property is added via either // a function declaration or a Object.defineProperty(global, ...) call. // // Note that any function declarations or Object.defineProperty() // globals that are created asynchronously (in a setTimeout, callback, // etc.) will happen AFTER the call to copy properties, and thus not be // caught. // // The way to properly fix this is to add some sort of a // Object::SetNamedDefinePropertyHandler() function that takes a callback, // which receives the property name and property descriptor as arguments. // // Luckily, such situations are rare, and asynchronously-added globals // weren't supported by Node's VM module until 0.12 anyway. But, this // should be fixed properly in V8, and this copy function should be // removed once there is a better way. void CopyProperties() { HandleScope scope(env()->isolate()); Local context = PersistentToLocal(env()->isolate(), context_); Local global = context->Global()->GetPrototype()->ToObject(env()->isolate()); Local sandbox_obj = sandbox(); Local clone_property_method; Local names = global->GetOwnPropertyNames(); int length = names->Length(); for (int i = 0; i < length; i++) { Local key = names->Get(i)->ToString(env()->isolate()); bool has = sandbox_obj->HasOwnProperty(context, key).FromJust(); if (!has) { // Could also do this like so: // // PropertyAttribute att = global->GetPropertyAttributes(key_v); // Local val = global->Get(key_v); // sandbox->ForceSet(key_v, val, att); // // However, this doesn't handle ES6-style properties configured with // Object.defineProperty, and that's exactly what we're up against at // this point. ForceSet(key,val,att) only supports value properties // with the ES3-style attribute flags (DontDelete/DontEnum/ReadOnly), // which doesn't faithfully capture the full range of configurations // that can be done using Object.defineProperty. if (clone_property_method.IsEmpty()) { Local code = FIXED_ONE_BYTE_STRING(env()->isolate(), "(function cloneProperty(source, key, target) {\n" " if (key === 'Proxy') return;\n" " try {\n" " var desc = Object.getOwnPropertyDescriptor(source, key);\n" " if (desc.value === source) desc.value = target;\n" " Object.defineProperty(target, key, desc);\n" " } catch (e) {\n" " // Catch sealed properties errors\n" " }\n" "})"); Local fname = FIXED_ONE_BYTE_STRING(env()->isolate(), "binding:script"); Local node-v4.8.2/doc/topics/000755 000766 000024 00000000000 13070706736 015027 5ustar00iojsstaff000000 000000 node-v4.8.2/doc/topics/blocking-vs-non-blocking.md000644 000766 000024 00000011445 13070706736 022152 0ustar00iojsstaff000000 000000 # Overview of Blocking vs Non-Blocking This overview covers the difference between **blocking** and **non-blocking** calls in Node.js. This overview will refer to the event loop and libuv but no prior knowledge of those topics is required. Readers are assumed to have a basic understanding of the JavaScript language and Node.js callback pattern. > "I/O" refers primarily to interaction with the system's disk and network supported by [libuv](http://libuv.org/). ## Blocking **Blocking** is when the execution of additional JavaScript in the Node.js process must wait until a non-JavaScript operation completes. This happens because the event loop is unable to continue running JavaScript while a **blocking** operation is occurring. In Node.js, JavaScript that exhibits poor performance due to being CPU intensive rather than waiting on a non-JavaScript operation, such as I/O, isn't typically referred to as **blocking**. Synchronous methods in the Node.js standard library that use libuv are the most commonly used **blocking** operations. Native modules may also have **blocking** methods. All of the I/O methods in the Node.js standard library provide asynchronous versions, which are **non-blocking**, and accept callback functions. Some methods also have **blocking** counterparts, which have names that end with `Sync`. ## Comparing Code **Blocking** methods execute **synchronously** and **non-blocking** methods execute **asynchronously**. Using the File System module as an example, this is a **synchronous** file read: ```js const fs = require('fs'); const data = fs.readFileSync('/file.md'); // blocks here until file is read ``` And here is an equivalent **asynchronous** example: ```js const fs = require('fs'); fs.readFile('/file.md', (err, data) => { if (err) throw err; }); ``` The first example appears simpler than the second but has the disadvantage of the second line **blocking** the execution of any additional JavaScript until the entire file is read. Note that in the synchronous version if an error is thrown it will need to be caught or the process will crash. In the asynchronous version, it is up to the author to decide whether an error should throw as shown. Let's expand our example a little bit: ```js const fs = require('fs'); const data = fs.readFileSync('/file.md'); // blocks here until file is read console.log(data); // moreWork(); will run after console.log ``` And here is a similar, but not equivalent asynchronous example: ```js const fs = require('fs'); fs.readFile('/file.md', (err, data) => { if (err) throw err; console.log(data); }); // moreWork(); will run before console.log ``` In the first example above, `console.log` will be called before `moreWork()`. In the second example `fs.readFile()` is **non-blocking** so JavaScript execution can continue and `moreWork()` will be called first. The ability to run `moreWork()` without waiting for the file read to complete is a key design choice that allows for higher throughput. ## Concurrency and Throughput JavaScript execution in Node.js is single threaded, so concurrency refers to the event loop's capacity to execute JavaScript callback functions after completing other work. Any code that is expected to run in a concurrent manner must allow the event loop to continue running as non-JavaScript operations, like I/O, are occurring. As an example, let's consider a case where each request to a web server takes 50ms to complete and 45ms of that 50ms is database I/O that can be done asychronously. Choosing **non-blocking** asynchronous operations frees up that 45ms per request to handle other requests. This is a significant difference in capacity just by choosing to use **non-blocking** methods instead of **blocking** methods. The event loop is different than models in many other languages where additional threads may be created to handle concurrent work. ## Dangers of Mixing Blocking and Non-Blocking Code There are some patterns that should be avoided when dealing with I/O. Let's look at an example: ```js const fs = require('fs'); fs.readFile('/file.md', (err, data) => { if (err) throw err; console.log(data); }); fs.unlinkSync('/file.md'); ``` In the above example, `fs.unlinkSync()` is likely to be run before `fs.readFile()`, which would delete `file.md` before it is actually read. A better way to write this that is completely **non-blocking** and guaranteed to execute in the correct order is: ```js const fs = require('fs'); fs.readFile('/file.md', (err, data) => { if (err) throw err; console.log(data); fs.unlink('/file.md', (err) => { if (err) throw err; }); }); ``` The above places a **non-blocking** call to `fs.unlink()` within the callback of `fs.readFile()` which guarantees the correct order of operations. ## Additional Resources - [libuv](http://libuv.org/) - [About Node.js](https://nodejs.org/en/about/) node-v4.8.2/doc/topics/the-event-loop-timers-and-nexttick.md000644 000766 000024 00000043051 13070706736 024112 0ustar00iojsstaff000000 000000 # The Node.js Event Loop, Timers, and `process.nextTick()` ## What is the Event Loop? The event loop is what allows Node.js to perform non-blocking I/O operations — despite the fact that JavaScript is single-threaded — by offloading operations to the system kernel whenever possible. Since most modern kernels are multi-threaded, they can handle multiple operations executing in the background. When one of these operations completes, the kernel tells Node.js so that the appropriate callback may be added to the **poll** queue to eventually be executed. We'll explain this in further detail later in this topic. ## Event Loop Explained When Node.js starts, it initializes the event loop, processes the provided input script (or drops into the [REPL][], which is not covered in this document) which may make async API calls, schedule timers, or call `process.nextTick()`, then begins processing the event loop. The following diagram shows a simplified overview of the event loop's order of operations. ┌───────────────────────┐ ┌─>│ timers │ │ └──────────┬────────────┘ │ ┌──────────┴────────────┐ │ │ I/O callbacks │ │ └──────────┬────────────┘ │ ┌──────────┴────────────┐ │ │ idle, prepare │ │ └──────────┬────────────┘ ┌───────────────┐ │ ┌──────────┴────────────┐ │ incoming: │ │ │ poll │<─────┤ connections, │ │ └──────────┬────────────┘ │ data, etc. │ │ ┌──────────┴────────────┐ └───────────────┘ │ │ check │ │ └──────────┬────────────┘ │ ┌──────────┴────────────┐ └──┤ close callbacks │ └───────────────────────┘ *note: each box will be referred to as a "phase" of the event loop.* Each phase has a FIFO queue of callbacks to execute. While each phase is special in its own way, generally, when the event loop enters a given phase, it will perform any operations specific to that phase, then execute callbacks in that phase's queue until the queue has been exhausted or the maximum number of callbacks has executed. When the queue has been exhausted or the callback limit is reached, the event loop will move to the next phase, and so on. Since any of these operations may schedule _more_ operations and new events processed in the **poll** phase are queued by the kernel, poll events can be queued while polling events are being processed. As a result, long running callbacks can allow the poll phase to run much longer than a timer's threshold. See the [**timers**](#timers) and [**poll**](#poll) sections for more details. _**NOTE:** There is a slight discrepancy between the Windows and the Unix/Linux implementation, but that's not important for this demonstration. The most important parts are here. There are actually seven or eight steps, but the ones we care about — ones that Node.js actually uses - are those above._ ## Phases Overview * **timers**: this phase executes callbacks scheduled by `setTimeout()` and `setInterval()`. * **I/O callbacks**: most types of callback except timers, `setImmedate()`, close * **idle, prepare**: only used internally * **poll**: retrieve new I/O events; node will block here when appropriate * **check**: `setImmediate()` callbacks are invoked here * **close callbacks**: e.g socket.on('close', ...) Between each run of the event loop, Node.js checks if it is waiting for any asynchronous I/O or timers and shuts down cleanly if there are not any. ## Phases in Detail ### timers A timer specifies the **threshold** _after which_ a provided callback _may be executed_ rather than the **exact** time a person _wants it to be executed_. Timers callbacks will run as early as they can be scheduled after the specified amount of time has passed; however, Operating System scheduling or the running of other callbacks may delay them. _**Note**: Technically, the [**poll** phase](#poll) controls when timers are executed._ For example, say you schedule a timeout to execute after a 100 ms threshold, then your script starts asynchronously reading a file which takes 95 ms: ```js var fs = require('fs'); function someAsyncOperation (callback) { // Assume this takes 95ms to complete fs.readFile('/path/to/file', callback); } var timeoutScheduled = Date.now(); setTimeout(function () { var delay = Date.now() - timeoutScheduled; console.log(delay + "ms have passed since I was scheduled"); }, 100); // do someAsyncOperation which takes 95 ms to complete someAsyncOperation(function () { var startCallback = Date.now(); // do something that will take 10ms... while (Date.now() - startCallback < 10) { ; // do nothing } }); ``` When the event loop enters the **poll** phase, it has an empty queue (`fs.readFile()` has not completed), so it will wait for the number of ms remaining until the soonest timer's threshold is reached. While it is waiting 95 ms pass, `fs.readFile()` finishes reading the file and its callback which takes 10 ms to complete is added to the **poll** queue and executed. When the callback finishes, there are no more callbacks in the queue, so the event loop will see that the threshold of the soonest timer has been reached then wrap back to the **timers** phase to execute the timer's callback. In this example, you will see that the total delay between the timer being scheduled and its callback being executed will be 105ms. Note: To prevent the **poll** phase from starving the event loop, [libuv] (http://libuv.org/) (the C library that implements the Node.js event loop and all of the asynchronous behaviors of the platform) also has a hard maximum (system dependent) before it stops polling for more events. ### I/O callbacks This phase executes callbacks for some system operations such as types of TCP errors. For example if a TCP socket receives `ECONNREFUSED` when attempting to connect, some \*nix systems want to wait to report the error. This will be queued to execute in the **I/O callbacks** phase. ### poll The **poll** phase has two main functions: 1. Executing scripts for timers whose threshold has elapsed, then 2. Processing events in the **poll** queue. When the event loop enters the **poll** phase _and there are no timers scheduled_, one of two things will happen: * _If the **poll** queue **is not empty**_, the event loop will iterate through its queue of callbacks executing them synchronously until either the queue has been exhausted, or the system-dependent hard limit is reached. * _If the **poll** queue **is empty**_, one of two more things will happen: * If scripts have been scheduled by `setImmediate()`, the event loop will end the **poll** phase and continue to the **check** phase to execute those scheduled scripts. * If scripts **have not** been scheduled by `setImmediate()`, the event loop will wait for callbacks to be added to the queue, then execute them immediately. Once the **poll** queue is empty the event loop will check for timers _whose time thresholds have been reached_. If one or more timers are ready, the event loop will wrap back to the **timers** phase to execute those timers' callbacks. ### check This phase allows a person to execute callbacks immediately after the **poll** phase has completed. If the **poll** phase becomes idle and scripts have been queued with `setImmediate()`, the event loop may continue to the **check** phase rather than waiting. `setImmediate()` is actually a special timer that runs in a separate phase of the event loop. It uses a libuv API that schedules callbacks to execute after the **poll** phase has completed. Generally, as the code is executed, the event loop will eventually hit the **poll** phase where it will wait for an incoming connection, request, etc. However, if a callback has been scheduled with `setImmediate()` and the **poll** phase becomes idle, it will end and continue to the **check** phase rather than waiting for **poll** events. ### close callbacks If a socket or handle is closed abruptly (e.g. `socket.destroy()`), the `'close'` event will be emitted in this phase. Otherwise it will be emitted via `process.nextTick()`. ## `setImmediate()` vs `setTimeout()` `setImmediate` and `setTimeout()` are similar, but behave in different ways depending on when they are called. * `setImmediate()` is designed to execute a script once the current **poll** phase completes. * `setTimeout()` schedules a script to be run after a minimum threshold in ms has elapsed. The order in which the timers are executed will vary depending on the context in which they are called. If both are called from within the main module, then timing will be bound by the performance of the process (which can be impacted by other applications running on the machine). For example, if we run the following script which is not within an I/O cycle (i.e. the main module), the order in which the two timers are executed is non-deterministic, as it is bound by the performance of the process: ```js // timeout_vs_immediate.js setTimeout(function timeout () { console.log('timeout'); },0); setImmediate(function immediate () { console.log('immediate'); }); ``` $ node timeout_vs_immediate.js timeout immediate $ node timeout_vs_immediate.js immediate timeout However, if you move the two calls within an I/O cycle, the immediate callback is always executed first: ```js // timeout_vs_immediate.js var fs = require('fs') fs.readFile(__filename, () => { setTimeout(() => { console.log('timeout') }, 0) setImmediate(() => { console.log('immediate') }) }) ``` $ node timeout_vs_immediate.js immediate timeout $ node timeout_vs_immediate.js immediate timeout The main advantage to using `setImmediate()` over `setTimeout()` is `setImmediate()` will always be executed before any timers if scheduled within an I/O cycle, independently of how many timers are present. ## `process.nextTick()` ### Understanding `process.nextTick()` You may have noticed that `process.nextTick()` was not displayed in the diagram, even though it's a part of the asynchronous API. This is because `process.nextTick()` is not technically part of the event loop. Instead, the `nextTickQueue` will be processed after the current operation completes, regardless of the current phase of the event loop. Looking back at our diagram, any time you call `process.nextTick()` in a given phase, all callbacks passed to `process.nextTick()` will be resolved before the event loop continues. This can create some bad situations because **it allows you to "starve" your I/O by making recursive `process.nextTick()` calls**, which prevents the event loop from reaching the **poll** phase. ### Why would that be allowed? Why would something like this be included in Node.js? Part of it is a design philosophy where an API should always be asynchronous even where it doesn't have to be. Take this code snippet for example: ```js function apiCall (arg, callback) { if (typeof arg !== 'string') return process.nextTick(callback, new TypeError('argument should be string')); } ``` The snippet does an argument check and if it's not correct, it will pass the error to the callback. The API updated fairly recently to allow passing arguments to `process.nextTick()` allowing it to take any arguments passed after the callback to be propagated as the arguments to the callback so you don't have to nest functions. What we're doing is passing an error back to the user but only *after* we have allowed the rest of the user's code to execute. By using `process.nextTick()` we guarantee that `apiCall()` always runs its callback *after* the rest of the user's code and *before* the event loop is allowed to proceed. To achieve this, the JS call stack is allowed to unwind then immediately execute the provided callback which allows a person to make recursive calls to `process.nextTick()` without reaching a `RangeError: Maximum call stack size exceeded from v8`. This philosophy can lead to some potentially problematic situations. Take this snippet for example: ```js // this has an asynchronous signature, but calls callback synchronously function someAsyncApiCall (callback) { callback(); }; // the callback is called before `someAsyncApiCall` completes. someAsyncApiCall(() => { // since someAsyncApiCall has completed, bar hasn't been assigned any value console.log('bar', bar); // undefined }); var bar = 1; ``` The user defines `someAsyncApiCall()` to have an asynchronous signature, but it actually operates synchronously. When it is called, the callback provided to `someAsyncApiCall()` is called in the same phase of the event loop because `someAsyncApiCall()` doesn't actually do anything asynchronously. As a result, the callback tries to reference `bar` even though it may not have that variable in scope yet, because the script has not been able to run to completion. By placing the callback in a `process.nextTick()`, the script still has the ability to run to completion, allowing all the variables, functions, etc., to be initialized prior to the callback being called. It also has the advantage of not allowing the event loop to continue. It may be useful for the user to be alerted to an error before the event loop is allowed to continue. Here is the previous example using `process.nextTick()`: ```js function someAsyncApiCall (callback) { process.nextTick(callback); }; someAsyncApiCall(() => { console.log('bar', bar); // 1 }); var bar = 1; ``` Here's another real world example: ```js const server = net.createServer(() => {}).listen(8080); server.on('listening', () => {}); ``` When only a port is passed the port is bound immediately. So the `'listening'` callback could be called immediately. Problem is that the `.on('listening')` will not have been set by that time. To get around this the `'listening'` event is queued in a `nextTick()` to allow the script to run to completion. Which allows the user to set any event handlers they want. ## `process.nextTick()` vs `setImmediate()` We have two calls that are similar as far as users are concerned, but their names are confusing. * `process.nextTick()` fires immediately on the same phase * `setImmediate()` fires on the following iteration or 'tick' of the event loop In essence, the names should be swapped. `process.nextTick()` fires more immediately than `setImmediate()` but this is an artifact of the past which is unlikely to change. Making this switch would break a large percentage of the packages on npm. Every day more new modules are being added, which mean every day we wait, more potential breakages occur. While they are confusing, the names themselves won't change. *We recommend developers use `setImmediate()` in all cases because it's easier to reason about (and it leads to code that's compatible with a wider variety of environments, like browser JS.)* ## Why use `process.nextTick()`? There are two main reasons: 1. Allow users to handle errors, cleanup any then unneeded resources, or perhaps try the request again before the event loop continues. 2. At times it's necessary to allow a callback to run after the call stack has unwound but before the event loop continues. One example is to match the user's expectations. Simple example: ```js var server = net.createServer(); server.on('connection', function(conn) { }); server.listen(8080); server.on('listening', function() { }); ``` Say that `listen()` is run at the beginning of the event loop, but the listening callback is placed in a `setImmediate()`. Now, unless a hostname is passed binding to the port will happen immediately. Now for the event loop to proceed it must hit the **poll** phase, which means there is a non-zero chance that a connection could have been received allowing the connection event to be fired before the listening event. Another example is running a function constructor that was to, say, inherit from `EventEmitter` and it wanted to call an event within the constructor: ```js const EventEmitter = require('events'); const util = require('util'); function MyEmitter() { EventEmitter.call(this); this.emit('event'); } util.inherits(MyEmitter, EventEmitter); const myEmitter = new MyEmitter(); myEmitter.on('event', function() { console.log('an event occurred!'); }); ``` You can't emit an event from the constructor immediately because the script will not have processed to the point where the user assigns a callback to that event. So, within the constructor itself, you can use `process.nextTick()` to set a callback to emit the event after the constructor has finished, which provides the expected results: ```js const EventEmitter = require('events'); const util = require('util'); function MyEmitter() { EventEmitter.call(this); // use nextTick to emit the event once a handler is assigned process.nextTick(function () { this.emit('event'); }.bind(this)); } util.inherits(MyEmitter, EventEmitter); const myEmitter = new MyEmitter(); myEmitter.on('event', function() { console.log('an event occurred!'); }); ``` [REPL]: https://nodejs.org/api/repl.html#repl_repl node-v4.8.2/doc/guides/building-node-with-ninja.md000644 000766 000024 00000003302 13070706735 022113 0ustar00iojsstaff000000 000000 # Building Node with Ninja The purpose of this guide is to show how to build Node.js using [Ninja][], as doing so can be significantly quicker than using `make`. Please see [Ninja's site][Ninja] for installation instructions (unix only). To build Node with ninja, there are 3 steps that must be taken: 1. Configure the project's OS-based build rules via `./configure --ninja`. 2. Run `ninja -C out/Release` to produce a compiled release binary. 3. Lastly, make symlink to `./node` using `ln -fs out/Release/node node`. When running `ninja -C out/Release` you will see output similar to the following if the build has succeeded: ``` ninja: Entering directory `out/Release` [4/4] LINK node, POSTBUILDS ``` The bottom line will change while building, showing the progress as `[finished/total]` build steps. This is useful output that `make` does not produce and is one of the benefits of using Ninja. Also, Ninja will likely compile much faster than even `make -j8` (or `-j`). ## Considerations Ninja builds vary slightly from `make` builds. If you wish to run `make test` after, `make` will likely still need to rebuild some amount of Node. As such, if you wish to run the tests, it can be helpful to invoke the test runner directly, like so: `tools/test.py --mode=release message parallel sequential -J` ## Alias `alias nnode='./configure --ninja && ninja -C out/Release && ln -fs out/Release/node node'` ## Producing a debug build The above alias can be modified slightly to produce a debug build, rather than a release build as shown below: `alias nnodedebug='./configure --ninja && ninja -C out/Debug && ln -fs out/Debug/node node_g'` [Ninja]: https://ninja-build.org/ node-v4.8.2/doc/guides/maintaining-V8.md000644 000766 000024 00000041651 13070706736 020130 0ustar00iojsstaff000000 000000 # Maintaining V8 in Node.js # Background V8 follows the Chromium release schedule. The support horizon for Chromium is very different from the support horizon that Node.js needs to provide to its users. As a result Node.js needs to support a version of V8 for quite a bit longer than what upstream needs to support. Since V8 doesn't have an LTS supported branch, there is no official process around how the V8 branches in Node.js are maintained. This document attempts to document the current processes and proposes a workflow for maintaining the V8 branches in Node.js LTS and Current releases and how the Node.js and V8 teams at Google can help. # V8 Release Schedule V8 and Chromium follow a [roughly 6-week release cadence](https://www.chromium.org/developers/calendar). At any given time there are three V8 branches that are **active**. For example, at the time of this writing: * **Stable**: V8 5.4 is currently shipping as part of Chromium stable. This branch was created approx. 6 weeks before from when V8 5.3 shipped as stable. * **Beta**: V8 5.5 is currently in beta. It will be promoted to stable next; approximately 6 weeks after V8 5.4 shipped as stable. * **Master**: V8 tip-of-tree corresponds to V8 5.6. This branch gets regularly released as part of the Chromium **canary** builds. This branch will be promoted to beta next when V8 5.5 ships as stable. All older branches are considered **abandoned**, and are not maintained by the V8 team. ## V8 merge process overview The process for backporting bug fixes to active branches is officially documented [on the V8 wiki](https://github.com/v8/v8/wiki/Merging%20&%20Patching). The summary of the process is: * V8 only supports active branches. There is no testing done on any branches older than the current stable/beta/master. * A fix needing backport is tagged w/ *merge-request-x.x* tag. This can be done by anyone interested in getting the fix backported. Issues with this tag are reviewed by the V8 team regularly as candidates for backporting. * Fixes need some 'baking time' before they can be approved for backporting. This means waiting a few days to ensure that no issues are detected on the canary/beta builds. * Once ready, the issue is tagged w/ *merge-approved-x.x* and one can do the actual merge by using the scripts on the [wiki page](https://github.com/v8/v8/wiki/Merging%20&%20Patching). * Merge requests to an abandoned branch will be rejected. * Only bug fixes are accepted for backporting. # Node.js Support Requirements At any given time Node.js needs to be maintaining a few different V8 branches for the various Current, LTS, and nightly releases. At present this list includes the following branches1:
Release Support Start Support End V8 version V8 branch released V8 branch abandoned
Node.js v4.x 2015-10-01 2018-04-01 4.5 2015-09-01 2015-10-13
Node.js v6.x 2016-04-01 2019-04-01 5.1 2016-05-31 2016-06-26
Node.js v7.x 2016-10-01 2017-04-01 5.4 2016-10-18 ~2016-12-01
master N/A N/A 5.4 2016-10-18 ~2016-12-01
The versions of V8 used in Node.js v4.x and v6.x have already been abandoned by upstream V8. However, Node.js needs to continue supporting these branches for many months (Current branches) or several years (LTS branches). # Maintenance Process Once a bug in Node.js has been identified to be caused by V8, the first step is to identify the versions of Node.js and V8 affected. The bug may be present in multiple different locations, each of which follows a slightly different process. * Unfixed bugs. The bug exists in the V8 master branch. * Fixed, but needs backport. The bug may need porting to one or more branches. * Backporting to active branches. * Backporting to abandoned branches. * Backports identified by the V8 team. Bugs identified by upstream V8 that we haven't encountered in Node.js yet. ## Unfixed Upstream Bugs If the bug can be reproduced on the [`vee-eight-lkgr` branch](https://github.com/v8/node/tree/vee-eight-lkgr), Chromium canary, or V8 tip-of-tree, and the test case is valid, then the bug needs to be fixed upstream first. * Start by opening a bug upstream [using this template](https://bugs.chromium.org/p/v8/issues/entry?template=Node.js%20upstream%20bug). * Make sure to include a link to the corresponding Node.js issue (if one exists). * If the fix is simple enough, you may fix it yourself; [contributions](https://github.com/v8/v8/wiki/Contributing) are welcome. * V8's build waterfall tests your change. * Once the bug is fixed it may still need backporting, if it exists in other V8 branches that are still active or are branches that Node.js cares about. Follow the process for backporting below. ## Backporting to Active Branches If the bug exists in any of the active V8 branches, we may need to get the fix backported. At any given time there are [two active branches](https://build.chromium.org/p/client.v8.branches/console) (beta and stable) in addition to master. The following steps are needed to backport the fix: * Identify which version of V8 the bug was fixed in. * Identify if any active V8 branches still contain the bug: * A tracking bug is needed to request a backport. * If there isn't already a V8 bug tracking the fix, open a new merge request bug using this [Node.js specific template](https://bugs.chromium.org/p/v8/issues/entry?template=Node.js%20merge%20request). * If a bug already exists * Add a reference to the GitHub issue. * Attach *merge-request-x.x* labels to the bug for any active branches that still contain the bug. (e.g. merge-request-5.3, merge-request-5.4) * Add ofrobots-at-google.com to the cc list. * Once the merge has been approved, it should be merged using the [merge script documented in the V8 wiki](https://github.com/v8/v8/wiki/Merging%20&%20Patching). Merging requires commit access to the V8 repository. If you don't have commit access you can indicate someone on the V8 team can do the merge for you. * It is possible that the merge request may not get approved, for example if it is considered to be a feature or otherwise too risky for V8 stable. In such cases we float the patch on the Node.js side. See the process on 'Backporting to Abandoned branches'. * Once the fix has been merged upstream, it can be picked up during an update of the V8 branch, (see below). ## Backporting to Abandoned Branches Abandoned V8 branches are supported in the Node.js V8 repository. The fix needs to be cherry-picked in the Node.js repository and V8-CI must test the change. * For each abandoned V8 branch corresponding to an LTS branch that is affected by the bug: * Open a cherry-pick PR on nodejs/node targeting the appropriate *vY.x-staging* branch (e.g. *v6.x-staging* to fix an issue in V8-5.1). * Increase the patch level version in v8-version.h. This will not cause any problems with versioning because V8 will not publish other patches for this branch, so Node.js can effectively bump the patch version. * In some cases the patch may require extra effort to merge in case V8 has changed substantially. For important issues we may be able to lean on the V8 team to get help with reimplementing the patch. * Run the Node.js [V8-CI](https://ci.nodejs.org/job/node-test-commit-v8-linux/) in addition to the [Node.js CI](https://ci.nodejs.org/job/node-test-pull-request/). An example for workflow how to cherry-pick consider the following bug: https://crbug.com/v8/5199. From the bug we can see that it was merged by V8 into 5.2 and 5.3, and not into V8 5.1 (since it was already abandoned). Since Node.js `v6.x` uses V8 5.1, the fix needed to cherry-picked. To cherry-pick, here's an example workflow: * Download and apply the commit linked-to in the issue (in this case a51f429). `curl -L https://github.com/v8/v8/commit/a51f429.patch | git am -3 --directory=deps/v8`. If the branches have diverged significantly, this may not apply cleanly. It may help to try to cherry-pick the merge to the oldest branch that was done upstream in V8. In this example, this would be the patch from the merge to 5.2. The hope is that this would be closer to the V8 5.1, and has a better chance of applying cleanly. If you're stuck, feel free to ping @ofrobots for help. * Modify the commit message to match the format we use for V8 backports and replace yourself as the author. `git commit --amend --reset-author`. You may want to add extra description if necessary to indicate the impact of the fix on Node.js. In this case the original issue was descriptive enough. Example: ``` deps: cherry-pick a51f429 from V8 upstream Original commit message: [regexp] Fix case-insensitive matching for one-byte subjects. The bug occurs because we do not canonicalize character class ranges before adding case equivalents. While adding case equivalents, we abort early for one-byte subject strings, assuming that the ranges are sorted. Which they are not. R=marja@chromium.org BUG=v8:5199 Review-Url: https://codereview.chromium.org/2159683002 Cr-Commit-Position: refs/heads/master@{#37833} PR-URL: ``` * Open a PR against the `v6.x-staging` branch in the Node.js repo. Launch the normal and [V8-CI](https://ci.nodejs.org/job/node-test-commit-v8-linux/) using the Node.js CI system. We only needed to backport to `v6.x` as the other LTS branches weren't affected by this bug. ## Backports Identified by the V8 team For bugs found through the browser or other channels, the V8 team marks bugs that might be applicable to the abandoned branches in use by Node.js. This is done through manual tagging by the V8 team and through an automated process that tags any fix that gets backported to the stable branch (as it is likely candidate for backporting further). Such fixes are tagged with the following labels in the V8 issue tracker: * `NodeJS-Backport-Review` ([V8](https://bugs.chromium.org/p/v8/issues/list?can=1&q=label%3ANodeJS-Backport-Review), [Chromium](https://bugs.chromium.org/p/chromium/issues/list?can=1&q=label%3ANodeJS-Backport-Review)): to be reviewed if this is applicable to abandoned branches in use by Node.js. This list if regularly reviewed by the Node.js team at Google to determine applicability to Node.js. * `NodeJS-Backport-Approved` ([V8](https://bugs.chromium.org/p/v8/issues/list?can=1&q=label%3ANodeJS-Backport-Approved), [Chromium](https://bugs.chromium.org/p/chromium/issues/list?can=1&q=label%3ANodeJS-Backport-Approved)): marks bugs that are deemed relevant to Node.js and should be backported. * `NodeJS-Backport-Done` ([V8](https://bugs.chromium.org/p/v8/issues/list?can=1&q=label%3ANodeJS-Backport-Done), [Chromium](https://bugs.chromium.org/p/chromium/issues/list?can=1&q=label%3ANodeJS-Backport-Done)): Backport for Node.js has been performed already. * `NodeJS-Backport-Rejected` ([V8](https://bugs.chromium.org/p/v8/issues/list?can=1&q=label%3ANodeJS-Backport-Rejected), [Chromium](https://bugs.chromium.org/p/chromium/issues/list?can=1&q=label%3ANodeJS-Backport-Rejected)): Backport for Node.js is not desired. The backlog of issues with such is regularly reviewed by the node-team at Google to shepherd through the backport process. External contributors are welcome to collaborate on the backport process as well. Note that some of the bugs may be security issues and will not be visible to external collaborators. # Updating V8 Node.js keeps a vendored copy of V8 inside of deps/ directory. In addition Node.js may need to float patches that do not exist upstream. This means that some care may need to be taken to update the vendored copy of V8. ## Minor updates (patch level) Because there may be floating patches on the version of V8 in Node.js, it is safest to apply the patch level updates as a patch. For example, imagine that upstream V8 is at 5.0.71.47 and Node.js is at 5.0.71.32. It would be best to compute the diff between these tags on the V8 repository, and then apply that patch on the copy of V8 in Node.js. This should preserve the patches/backports that Node.js may be floating (or else cause a merge conflict). The rough outline of the process is: ```shell # Assuming your fork of Node.js is checked out in $NODE_DIR # and you want to update the Node.js master branch. # Find the current (OLD) version in # $NODE_DIR/deps/v8/include/v8-version.h cd $NODE_DIR git checkout master git merge --ff-only origin/master git checkout -b V8_NEW_VERSION curl -L https://github.com/v8/v8/compare/${V8_OLD_VERSION}...${V8_NEW_VERSION}.patch | git apply --directory=deps/v8 # You may want to amend the commit message to describe the nature of the update ``` V8 also keeps tags of the form *5.4-lkgr* which point to the *Last Known Good Revision* from the 5.4 branch that can be useful in the update process above. ## Major Updates We upgrade the version of V8 in Node.js master whenever a V8 release goes stable upstream, that is, whenever a new release of Chrome comes out. Upgrading major versions would be much harder to do with the patch mechanism above. A better strategy is to 1. Audit the current master branch and look at the patches that have been floated since the last major V8 update. 1. Replace the copy of V8 in Node.js with a fresh checkout of the latest stable V8 branch. Special care must be taken to recursively update the DEPS that V8 has a compile time dependency on (at the moment of this writing, these are only trace_event and gtest_prod.h) 1. Refloat (cherry-pick) all the patches from list computed in 1) as necessary. Some of the patches may no longer be necessary. To audit for floating patches: ```shell git log --oneline deps/v8 ``` To replace the copy of V8 in Node.js, use the '[update-v8](https://gist.github.com/targos/8da405e96e98fdff01a395bed365b816)' script2. For example, if you want to replace the copy of V8 in Node.js with the branch-head for V8 5.1 branch: ```shell cd $NODE_DIR rm -rf deps/v8 path/to/update-v8 branch-heads/5.1 ``` You may want to look at the commits created by the above scripts, and squash them once you have reviewed them. This should be followed up with manual refloating of all relevant patches. # Proposal: Using a fork repo to track upstream V8 The fact that Node.js keeps a vendored, potentially edited copy of V8 in deps/ makes the above processes a bit complicated. An alternative proposal would be to create a fork of V8 at nodejs/v8 that would be used to maintain the V8 branches. This has several benefits: * The process to update the version of V8 in Node.js could be automated to track the tips of various V8 branches in nodejs/v8. * It would simplify cherry-picking and porting of fixes between branches as the version bumps in v8-version.h would happen as part of this update instead of on every change. * It would simplify the V8-CI and make it more automatable. * The history of the V8 branch in nodejs/v8 becomes purer and it would make it easier to pull in the V8 team for help with reviewing. * It would make it simpler to setup an automated build that tracks Node.js master + V8 lkgr integration build. This would require some tooling to: * A script that would update the V8 in a specific Node.js branch with V8 from upstream (dependent on branch abandoned vs. active). * We need a script to bump V8 version numbers when a new version of V8 is promoted from nodejs/v8 to nodejs/node. * Enabled the V8-CI build in Jenkins to build from the nodejs/v8 fork. # Proposal: Dealing with the need to float patches to a stable/beta Sometimes upstream V8 may not want to merge a fix to their stable branches, but we might. An example of this would be a fix for a performance regression that only affects Node.js and not the browser. At the moment we don't have a mechanism to deal with this situation. If we float a patch and bump the V8 version, we might run into a problem if upstream releases a fix with the same version number. One idea we have been kicking around is that we could move to a 5-place version number in V8, e.g.: 5.4.500.30.${embedder}. The ${embedder} represents the number of patches an embedder is floating on top of an official V8 version. This would also help with auditing the floating patches in the Node.js commit history. We are trying this out in https://github.com/nodejs/node/pull/9754. If this ends up working, we will investigate making this change upstream. ## Notes 1Node.js 0.12 and older are intentionally omitted from this document as their support is ending soon. 2It seems that @targos is working on port of this script here https://github.com/targos/update-v8. node-v4.8.2/doc/guides/writing-tests.md000644 000766 000024 00000017063 13070706736 020162 0ustar00iojsstaff000000 000000 # How to write a test for the Node.js project ## What is a test? Most tests in Node.js core are JavaScript programs that exercise a functionality provided by Node.js and check that it behaves as expected. Tests should exit with code `0` on success. A test will fail if: - It exits by setting `process.exitCode` to a non-zero number. - This is usually done by having an assertion throw an uncaught Error. - Occasionally, using `process.exit(code)` may be appropriate. - It never exits. In this case, the test runner will terminate the test because it sets a maximum time limit. Tests can be added for multiple reasons: - When adding new functionality. - When fixing regressions and bugs. - When expanding test coverage. ## Test structure Let's analyze this very basic test from the Node.js test suite: ```javascript 1 'use strict'; 2 const common = require('../common'); 3 const http = require('http'); 4 const assert = require('assert'); 5 6 const server = http.createServer(common.mustCall((req, res) => { 7 res.end('ok'); 8 })); 9 server.listen(common.PORT, () => { 10 http.get({ 11 port: common.PORT, 12 headers: {'Test': 'Düsseldorf'} 13 }, common.mustCall((res) => { 14 assert.equal(res.statusCode, 200); 15 server.close(); 16 })); 17 }); ``` **Lines 1-2** ```javascript 'use strict'; const common = require('../common'); ``` These two lines are mandatory and should be included on every test. The `common` module is a helper module that provides useful tools for the tests. If for some reason, no functionality from `common` is used, it should still be included like this: ```javascript require('../common'); ``` Why? It checks for leaks of globals. **Lines 3-4** ```javascript const http = require('http'); const assert = require('assert'); ``` These modules are required for the test to run. Except for special cases, these modules should only include core modules. The `assert` module is used by most of the tests to check that the assumptions for the test are met. Note that require statements are sorted, in [ASCII](http://man7.org/linux/man-pages/man7/ascii.7.html) order (digits, upper case, `_`, lower case). **Lines 6-17** This is the body of the test. This test is quite simple, it just tests that an HTTP server accepts `non-ASCII` characters in the headers of an incoming request. Interesting things to notice: - The use of `common.PORT` as the listening port. Always use `common.PORT` instead of using an arbitrary value, as it allows to run tests in parallel safely, as they are not trying to reuse the same port another test is already using. - The use of `common.mustCall` to check that some callbacks/listeners are called. - The HTTP server is closed once all the checks have run. This way, the test can exit gracefully. Remember that for a test to succeed, it must exit with a status code of 0. ## General recommendations ### Timers The use of timers is discouraged, unless timers are being tested. There are multiple reasons for this. Mainly, they are a source of flakiness. For a thorough explanation go [here](https://github.com/nodejs/testing/issues/27). In the event a timer is needed, it's recommended using the `common.platformTimeout()` method, that allows setting specific timeouts depending on the platform. For example: ```javascript const timer = setTimeout(fail, common.platformTimeout(4000)); ``` will create a 4-seconds timeout, except for some platforms where the delay will be multiplied for some factor. ### The *common* API Make use of the helpers from the `common` module as much as possible. One interesting case is `common.mustCall`. The use of `common.mustCall` may avoid the use of extra variables and the corresponding assertions. Let's explain this with a real test from the test suite. ```javascript 'use strict'; var common = require('../common'); var assert = require('assert'); var http = require('http'); var request = 0; var response = 0; process.on('exit', function() { assert.equal(request, 1, 'http server "request" callback was not called'); assert.equal(response, 1, 'http request "response" callback was not called'); }); var server = http.createServer(function(req, res) { request++; res.end(); }).listen(common.PORT, function() { var options = { agent: null, port: this.address().port }; http.get(options, function(res) { response++; res.resume(); server.close(); }); }); ``` This test could be greatly simplified by using `common.mustCall` like this: ```javascript 'use strict'; var common = require('../common'); var assert = require('assert'); var http = require('http'); var server = http.createServer(common.mustCall(function(req, res) { res.end(); })).listen(common.PORT, function() { var options = { agent: null, port: this.address().port }; http.get(options, common.mustCall(function(res) { res.resume(); server.close(); })); }); ``` ### Flags Some tests will require running Node.js with specific command line flags set. To accomplish this, a `// Flags: ` comment should be added in the preamble of the test followed by the flags. For example, to allow a test to require some of the `internal/*` modules, the `--expose-internals` flag should be added. A test that would require `internal/freelist` could start like this: ```javascript 'use strict'; // Flags: --expose-internals require('../common'); const assert = require('assert'); const freelist = require('internal/freelist'); ``` ### Assertions When writing assertions, prefer the strict versions: * `assert.strictEqual()` over `assert.equal()` * `assert.deepStrictEqual()` over `assert.deepEqual()` When using `assert.throws()`, if possible, provide the full error message: ```js assert.throws( () => { throw new Error('Wrong value'); }, /^Error: Wrong value$/ // Instead of something like /Wrong value/ ); ``` ### ES.Next features For performance considerations, we only use a selected subset of ES.Next features in JavaScript code in the `lib` directory. However, when writing tests, it is encouraged to use ES.Next features that have already landed in the ECMAScript specification. For example: * `let` and `const` over `var` * Template literals over string concatenation * Arrow functions when appropriate ## Naming Test Files Test files are named using kebab casing. The first component of the name is `test`. The second is the module or subsystem being tested. The third is usually the method or event name being tested. Subsequent components of the name add more information about what is being tested. For example, a test for the `beforeExit` event on the `process` object might be named `test-process-before-exit.js`. If the test specifically checked that arrow functions worked correctly with the `beforeExit` event, then it might be named `test-process-before-exit-arrow-functions.js`. ## Imported Tests ### Web Platform Tests Some of the tests for the WHATWG URL implementation (named `test-whatwg-url-*.js`) are imported from the [Web Platform Tests Project](https://github.com/w3c/web-platform-tests/tree/master/url). These imported tests will be wrapped like this: ```js /* eslint-disable */ /* WPT Refs: https://github.com/w3c/web-platform-tests/blob/8791bed/url/urlsearchparams-stringifier.html License: http://www.w3.org/Consortium/Legal/2008/04-testsuite-copyright.html */ // Test code /* eslint-enable */ ``` If you want to improve tests that have been imported this way, please send a PR to the upstream project first. When your proposed change is merged in the upstream project, send another PR here to update Node.js accordingly. Be sure to update the hash in the URL following `WPT Refs:`. node-v4.8.2/doc/api_assets/dnt_helper.js000644 000766 000024 00000004670 13070706735 020351 0ustar00iojsstaff000000 000000 /** * http://schalkneethling.github.io/blog/2015/11/06/respect-user-choice-do-not-track/ * https://github.com/schalkneethling/dnt-helper/blob/master/js/dnt-helper.js * * Returns true or false based on whether doNotTack is enabled. It also takes into account the * anomalies, such as !bugzilla 887703, which effect versions of Fx 31 and lower. It also handles * IE versions on Windows 7, 8 and 8.1, where the DNT implementation does not honor the spec. * @see https://bugzilla.mozilla.org/show_bug.cgi?id=1217896 for more details * @params {string} [dnt] - An optional mock doNotTrack string to ease unit testing. * @params {string} [userAgent] - An optional mock userAgent string to ease unit testing. * @returns {boolean} true if enabled else false */ function _dntEnabled(dnt, userAgent) { 'use strict'; // for old version of IE we need to use the msDoNotTrack property of navigator // on newer versions, and newer platforms, this is doNotTrack but, on the window object // Safari also exposes the property on the window object. var dntStatus = dnt || navigator.doNotTrack || window.doNotTrack || navigator.msDoNotTrack; var ua = userAgent || navigator.userAgent; // List of Windows versions known to not implement DNT according to the standard. var anomalousWinVersions = ['Windows NT 6.1', 'Windows NT 6.2', 'Windows NT 6.3']; var fxMatch = ua.match(/Firefox\/(\d+)/); var ieRegEx = /MSIE|Trident/i; var isIE = ieRegEx.test(ua); // Matches from Windows up to the first occurance of ; un-greedily // http://www.regexr.com/3c2el var platform = ua.match(/Windows.+?(?=;)/g); // With old versions of IE, DNT did not exist so we simply return false; if (isIE && typeof Array.prototype.indexOf !== 'function') { return false; } else if (fxMatch && parseInt(fxMatch[1], 10) < 32) { // Can't say for sure if it is 1 or 0, due to Fx bug 887703 dntStatus = 'Unspecified'; } else if (isIE && platform && anomalousWinVersions.indexOf(platform.toString()) !== -1) { // default is on, which does not honor the specification dntStatus = 'Unspecified'; } else { // sets dntStatus to Disabled or Enabled based on the value returned by the browser. // If dntStatus is undefined, it will be set to Unspecified dntStatus = { '0': 'Disabled', '1': 'Enabled' }[dntStatus] || 'Unspecified'; } return dntStatus === 'Enabled' ? true : false; } node-v4.8.2/doc/api_assets/sh.css000644 000766 000024 00000000610 13070706735 017001 0ustar00iojsstaff000000 000000 .sh_sourceCode { font-weight: normal; font-style: normal; } .sh_sourceCode .sh_symbol, .sh_sourceCode .sh_cbracket { color: #333; } .sh_sourceCode .sh_keyword { color: #338; } .sh_sourceCode .sh_string, .sh_sourceCode .sh_regexp, .sh_sourceCode .sh_number, .sh_sourceCode .sh_specialchar { color: #E54305; } .sh_sourceCode .sh_comment { color: #666; font-weight: lighter; } node-v4.8.2/doc/api_assets/sh_main.js000644 000766 000024 00000035702 13070706735 017643 0ustar00iojsstaff000000 000000 /* SHJS - Syntax Highlighting in JavaScript Copyright (C) 2007, 2008 gnombat@users.sourceforge.net License: http://shjs.sourceforge.net/doc/gplv3.html */ if (! this.sh_languages) { this.sh_languages = {}; } var sh_requests = {}; function sh_isEmailAddress(url) { if (/^mailto:/.test(url)) { return false; } return url.indexOf('@') !== -1; } function sh_setHref(tags, numTags, inputString) { var url = inputString.substring(tags[numTags - 2].pos, tags[numTags - 1].pos); if (url.length >= 2 && url.charAt(0) === '<' && url.charAt(url.length - 1) === '>') { url = url.substr(1, url.length - 2); } if (sh_isEmailAddress(url)) { url = 'mailto:' + url; } tags[numTags - 2].node.href = url; } /* Konqueror has a bug where the regular expression /$/g will not match at the end of a line more than once: var regex = /$/g; var match; var line = '1234567890'; regex.lastIndex = 10; match = regex.exec(line); var line2 = 'abcde'; regex.lastIndex = 5; match = regex.exec(line2); // fails */ function sh_konquerorExec(s) { var result = ['']; result.index = s.length; result.input = s; return result; } /** Highlights all elements containing source code in a text string. The return value is an array of objects, each representing an HTML start or end tag. Each object has a property named pos, which is an integer representing the text offset of the tag. Every start tag also has a property named node, which is the DOM element started by the tag. End tags do not have this property. @param inputString a text string @param language a language definition object @return an array of tag objects */ function sh_highlightString(inputString, language) { if (/Konqueror/.test(navigator.userAgent)) { if (! language.konquered) { for (var s = 0; s < language.length; s++) { for (var p = 0; p < language[s].length; p++) { var r = language[s][p][0]; if (r.source === '$') { r.exec = sh_konquerorExec; } } } language.konquered = true; } } var a = document.createElement('a'); var span = document.createElement('span'); // the result var tags = []; var numTags = 0; // each element is a pattern object from language var patternStack = []; // the current position within inputString var pos = 0; // the name of the current style, or null if there is no current style var currentStyle = null; var output = function(s, style) { var length = s.length; // this is more than just an optimization - we don't want to output empty elements if (length === 0) { return; } if (! style) { var stackLength = patternStack.length; if (stackLength !== 0) { var pattern = patternStack[stackLength - 1]; // check whether this is a state or an environment if (! pattern[3]) { // it's not a state - it's an environment; use the style for this environment style = pattern[1]; } } } if (currentStyle !== style) { if (currentStyle) { tags[numTags++] = {pos: pos}; if (currentStyle === 'sh_url') { sh_setHref(tags, numTags, inputString); } } if (style) { var clone; if (style === 'sh_url') { clone = a.cloneNode(false); } else { clone = span.cloneNode(false); } clone.className = style; tags[numTags++] = {node: clone, pos: pos}; } } pos += length; currentStyle = style; }; var endOfLinePattern = /\r\n|\r|\n/g; endOfLinePattern.lastIndex = 0; var inputStringLength = inputString.length; while (pos < inputStringLength) { var start = pos; var end; var startOfNextLine; var endOfLineMatch = endOfLinePattern.exec(inputString); if (endOfLineMatch === null) { end = inputStringLength; startOfNextLine = inputStringLength; } else { end = endOfLineMatch.index; startOfNextLine = endOfLinePattern.lastIndex; } var line = inputString.substring(start, end); var matchCache = []; for (;;) { var posWithinLine = pos - start; var stateIndex; var stackLength = patternStack.length; if (stackLength === 0) { stateIndex = 0; } else { // get the next state stateIndex = patternStack[stackLength - 1][2]; } var state = language[stateIndex]; var numPatterns = state.length; var mc = matchCache[stateIndex]; if (! mc) { mc = matchCache[stateIndex] = []; } var bestMatch = null; var bestPatternIndex = -1; for (var i = 0; i < numPatterns; i++) { var match; if (i < mc.length && (mc[i] === null || posWithinLine <= mc[i].index)) { match = mc[i]; } else { var regex = state[i][0]; regex.lastIndex = posWithinLine; match = regex.exec(line); mc[i] = match; } if (match !== null && (bestMatch === null || match.index < bestMatch.index)) { bestMatch = match; bestPatternIndex = i; if (match.index === posWithinLine) { break; } } } if (bestMatch === null) { output(line.substring(posWithinLine), null); break; } else { // got a match if (bestMatch.index > posWithinLine) { output(line.substring(posWithinLine, bestMatch.index), null); } var pattern = state[bestPatternIndex]; var newStyle = pattern[1]; var matchedString; if (newStyle instanceof Array) { for (var subexpression = 0; subexpression < newStyle.length; subexpression++) { matchedString = bestMatch[subexpression + 1]; output(matchedString, newStyle[subexpression]); } } else { matchedString = bestMatch[0]; output(matchedString, newStyle); } switch (pattern[2]) { case -1: // do nothing break; case -2: // exit patternStack.pop(); break; case -3: // exitall patternStack.length = 0; break; default: // this was the start of a delimited pattern or a state/environment patternStack.push(pattern); break; } } } // end of the line if (currentStyle) { tags[numTags++] = {pos: pos}; if (currentStyle === 'sh_url') { sh_setHref(tags, numTags, inputString); } currentStyle = null; } pos = startOfNextLine; } return tags; } //////////////////////////////////////////////////////////////////////////////// // DOM-dependent functions function sh_getClasses(element) { var result = []; var htmlClass = element.className; if (htmlClass && htmlClass.length > 0) { var htmlClasses = htmlClass.split(' '); for (var i = 0; i < htmlClasses.length; i++) { if (htmlClasses[i].length > 0) { result.push(htmlClasses[i]); } } } return result; } function sh_addClass(element, name) { var htmlClasses = sh_getClasses(element); for (var i = 0; i < htmlClasses.length; i++) { if (name.toLowerCase() === htmlClasses[i].toLowerCase()) { return; } } htmlClasses.push(name); element.className = htmlClasses.join(' '); } /** Extracts the tags from an HTML DOM NodeList. @param nodeList a DOM NodeList @param result an object with text, tags and pos properties */ function sh_extractTagsFromNodeList(nodeList, result) { var length = nodeList.length; for (var i = 0; i < length; i++) { var node = nodeList.item(i); switch (node.nodeType) { case 1: if (node.nodeName.toLowerCase() === 'br') { var terminator; if (/MSIE/.test(navigator.userAgent)) { terminator = '\r'; } else { terminator = '\n'; } result.text.push(terminator); result.pos++; } else { result.tags.push({node: node.cloneNode(false), pos: result.pos}); sh_extractTagsFromNodeList(node.childNodes, result); result.tags.push({pos: result.pos}); } break; case 3: case 4: result.text.push(node.data); result.pos += node.length; break; } } } /** Extracts the tags from the text of an HTML element. The extracted tags will be returned as an array of tag objects. See sh_highlightString for the format of the tag objects. @param element a DOM element @param tags an empty array; the extracted tag objects will be returned in it @return the text of the element @see sh_highlightString */ function sh_extractTags(element, tags) { var result = {}; result.text = []; result.tags = tags; result.pos = 0; sh_extractTagsFromNodeList(element.childNodes, result); return result.text.join(''); } /** Merges the original tags from an element with the tags produced by highlighting. @param originalTags an array containing the original tags @param highlightTags an array containing the highlighting tags - these must not overlap @result an array containing the merged tags */ function sh_mergeTags(originalTags, highlightTags) { var numOriginalTags = originalTags.length; if (numOriginalTags === 0) { return highlightTags; } var numHighlightTags = highlightTags.length; if (numHighlightTags === 0) { return originalTags; } var result = []; var originalIndex = 0; var highlightIndex = 0; while (originalIndex < numOriginalTags && highlightIndex < numHighlightTags) { var originalTag = originalTags[originalIndex]; var highlightTag = highlightTags[highlightIndex]; if (originalTag.pos <= highlightTag.pos) { result.push(originalTag); originalIndex++; } else { result.push(highlightTag); if (highlightTags[highlightIndex + 1].pos <= originalTag.pos) { highlightIndex++; result.push(highlightTags[highlightIndex]); highlightIndex++; } else { // new end tag result.push({pos: originalTag.pos}); // new start tag highlightTags[highlightIndex] = {node: highlightTag.node.cloneNode(false), pos: originalTag.pos}; } } } while (originalIndex < numOriginalTags) { result.push(originalTags[originalIndex]); originalIndex++; } while (highlightIndex < numHighlightTags) { result.push(highlightTags[highlightIndex]); highlightIndex++; } return result; } /** Inserts tags into text. @param tags an array of tag objects @param text a string representing the text @return a DOM DocumentFragment representing the resulting HTML */ function sh_insertTags(tags, text) { var doc = document; var result = document.createDocumentFragment(); var tagIndex = 0; var numTags = tags.length; var textPos = 0; var textLength = text.length; var currentNode = result; // output one tag or text node every iteration while (textPos < textLength || tagIndex < numTags) { var tag; var tagPos; if (tagIndex < numTags) { tag = tags[tagIndex]; tagPos = tag.pos; } else { tagPos = textLength; } if (tagPos <= textPos) { // output the tag if (tag.node) { // start tag var newNode = tag.node; currentNode.appendChild(newNode); currentNode = newNode; } else { // end tag currentNode = currentNode.parentNode; } tagIndex++; } else { // output text currentNode.appendChild(doc.createTextNode(text.substring(textPos, tagPos))); textPos = tagPos; } } return result; } /** Highlights an element containing source code. Upon completion of this function, the element will have been placed in the "sh_sourceCode" class. @param element a DOM 
 element containing the source code to be highlighted
@param  language  a language definition object
*/
function sh_highlightElement(element, language) {
  sh_addClass(element, 'sh_sourceCode');
  var originalTags = [];
  var inputString = sh_extractTags(element, originalTags);
  var highlightTags = sh_highlightString(inputString, language);
  var tags = sh_mergeTags(originalTags, highlightTags);
  var documentFragment = sh_insertTags(tags, inputString);
  while (element.hasChildNodes()) {
    element.removeChild(element.firstChild);
  }
  element.appendChild(documentFragment);
}

function sh_getXMLHttpRequest() {
  if (window.ActiveXObject) {
    return new ActiveXObject('Msxml2.XMLHTTP');
  }
  else if (window.XMLHttpRequest) {
    return new XMLHttpRequest();
  }
  throw 'No XMLHttpRequest implementation available';
}

function sh_load(language, element, prefix, suffix) {
  if (language in sh_requests) {
    sh_requests[language].push(element);
    return;
  }
  sh_requests[language] = [element];
  var request = sh_getXMLHttpRequest();
  var url = prefix + 'sh_' + language + suffix;
  request.open('GET', url, true);
  request.onreadystatechange = function () {
    if (request.readyState === 4) {
      try {
        if (! request.status || request.status === 200) {
          eval(request.responseText);
          var elements = sh_requests[language];
          for (var i = 0; i < elements.length; i++) {
            sh_highlightElement(elements[i], sh_languages[language]);
          }
        }
        else {
          throw 'HTTP error: status ' + request.status;
        }
      }
      finally {
        request = null;
      }
    }
  };
  request.send(null);
}

/**
Highlights all elements containing source code on the current page. Elements
containing source code must be "pre" elements with a "class" attribute of
"sh_LANGUAGE", where LANGUAGE is a valid language identifier; e.g., "sh_java"
identifies the element as containing "java" language source code.
*/
function highlight(prefix, suffix, tag) {
  var nodeList = document.getElementsByTagName(tag);
  for (var i = 0; i < nodeList.length; i++) {
    var element = nodeList.item(i);
    var htmlClasses = sh_getClasses(element);
    var highlighted = false;
    var donthighlight = false;
    for (var j = 0; j < htmlClasses.length; j++) {
      var htmlClass = htmlClasses[j].toLowerCase();
      if (htmlClass === 'sh_none') {
        donthighlight = true
        continue;
      }
      if (htmlClass.substr(0, 3) === 'sh_') {
        var language = htmlClass.substring(3);
        if (language in sh_languages) {
          sh_highlightElement(element, sh_languages[language]);
          highlighted = true;
        }
        else if (typeof(prefix) === 'string' && typeof(suffix) === 'string') {
          sh_load(language, element, prefix, suffix);
        }
        else {
          throw 'Found <' + tag + '> element with class="' + htmlClass + '", but no such language exists';
        }
        break;
      }
    }
    if (highlighted === false && donthighlight == false) {
      sh_highlightElement(element, sh_languages["javascript"]);
    }
  }
}



function sh_highlightDocument(prefix, suffix) {
  highlight(prefix, suffix, 'tt');
  highlight(prefix, suffix, 'code');
  highlight(prefix, suffix, 'pre');
}
node-v4.8.2/doc/api_assets/style.css000644 000766 000024 00000016103 13070706735 017533 0ustar00iojsstaff000000 000000 /*--------------------- Layout and Typography ----------------------------*/
html {
  -webkit-font-smoothing: antialiased;
  -moz-osx-font-smoothing: grayscale;
  -webkit-font-variant-ligatures: none;
          font-variant-ligatures: none;
}

body {
  font-family: "Lato", "Lucida Grande", "Lucida Sans Unicode", "Lucida Sans", Verdana, Tahoma, sans-serif;
  font-size: 62.5%;
  margin: 0;
  padding: 0;
  color: #333;
  background: #fff;
}

h1, h2, h3, h4 {
  margin: .8em 0 .5em;
  line-height: 1.2;
}

h5, h6 {
  margin: 1em 0 .8em;
  line-height: 1.2;
}

h1 {
  margin-top: 0;
  font-size: 2.441em;
}

h2 {font-size: 1.953em;}

h3 {font-size: 1.563em;}

h4 {font-size: 1.25em;}

h5 {font-size: 1em;}

h6 {font-size: .8em;}

pre, tt, code, .pre, span.type, a.type {
  font-family: Monaco, Consolas, "Lucida Console", monospace;
}

#content {
  font-size: 1.8em;
  position: relative;
}

a, a:link, a:active {
  color: #43853d;
  text-decoration: none;
  border-radius: 2px;
  padding: .1em .2em;
  margin: -.1em;
}

a:hover, a:focus {
  color: #fff;
  background-color: #43853d;
  outline: none;
}

strong {
  font-weight: 700;
}

code a:hover {
  background: none;
}

em code {
  font-style: normal;
}

#changelog #gtoc {
  display: none;
}

#gtoc {
  font-size: .8em;
}

.line {
  width: calc(100% - 1em);
  display: block;
  padding-bottom: 1px;
}

.api_stability {
  color: white !important;
  margin: 0 0 1em 0;
  font-family: "Lato", "Lucida Grande", "Lucida Sans Unicode", "Lucida Sans", Verdana, Tahoma, sans-serif;
  font-weight: 700;
}

.api_stability * {
  color: white !important;
}

.api_stability a {
  text-decoration: underline;
}

.api_stability a:hover, .api_stability a:active, .api_stability a:focus {
  background: rgba(255, 255, 255, .4);
}

.api_stability a code {
  background: none;
}

.api_stability_0 {
  background-color: #D60027;
}

.api_stability_1 {
  background-color: #EC5315;
}

.api_stability_2 {
  background-color: #4EBA0F;
}

.api_stability_3 {
  background-color: #0084B6;
}

.api_metadata {
  font-size: .75em;
  margin-bottom: 1em;
}

.api_metadata span {
  margin-right: 1em;
}

.api_metadata span:last-child {
  margin-right: 0px;
}

ul.plain {
  list-style: none;
}

abbr {
  border-bottom: 1px dotted #454545;
}

p {
  position: relative;
  text-rendering: optimizeLegibility;
  margin: 0 0 1.125em 0;
  line-height: 1.5em;
}

#apicontent > *:last-child {
  margin-bottom: 0;
  padding-bottom: 2em;
}

table {
  border-collapse: collapse;
  margin: 0 0 1.5em 0;
}

th, td {
  border: 1px solid #aaa;
}

th {
  text-align:left;
}

ol, ul, dl {
  margin: 0 0 .6em 0;
  padding: 0;
}

ol ul, ol ol, ol dl, ul ul, ul ol, ul dl, dl ul, dl ol, dl dl {
  margin-bottom: 0;
}

ul, ol {
  margin-left: 2em;
}

dl dt {
  position: relative;
  margin: 1.5em 0 0;
}

dl dd {
  position: relative;
  margin: 0 1em 0;
}

dd + dt.pre {
  margin-top: 1.6em;
}

h1, h2, h3, h4, h5, h6 {
  text-rendering: optimizeLegibility;
  font-weight: 700;
  position: relative;
}

header h1 {
  font-size: 2em;
  line-height: 2em;
  margin: 0;
}

#apicontent {
  padding-top: 1em;
}

#apicontent .line {
  width: calc(50% - 1em);
  margin: 1em 1em .95em;
  background-color: #ccc;
}

h2 + h2 {
  margin: 0 0 .5em;
}

h3 + h3 {
  margin: 0 0 .5em;
}

h2, h3, h4, h5 {
  position: relative;
  padding-right: 40px;
}

h1 span, h2 span, h3 span, h4 span {
  position: absolute;
  display: block;
  top: 0;
  right: 0;
}

h1 span:hover, h2 span:hover, h3 span:hover, h4 span:hover {
  opacity: 1;
}

h1 span a, h2 span a, h3 span a, h4 span a {
  font-size: .8em;
  color: #000;
  text-decoration: none;
  font-weight: bold;
}

pre, tt, code {
  line-height: 1.5em;
  margin: 0; padding: 0;
}

.pre {
  line-height: 1.5em;
  font-size: 1.2em;
}

pre {
  padding: 1em;
  vertical-align: top;
  background: #f2f2f2;
  margin: 1em;
  overflow-x: auto;
}

pre > code {
  font-size: .8em;
  padding: 0;
}

pre + h3 {
  margin-top: 2.225em;
}

code.pre {
  white-space: pre;
}

#intro {
  margin-top: 1.25em;
  margin-left: 1em;
}

#intro a {
  color: #ddd;
  font-size: 1.25em;
  font-weight: bold;
}

hr {
  background: none;
  border: medium none;
  border-bottom: 1px solid #7a7a7a;
  margin: 0 0 1em 0;
}

#toc h2 {
  margin-top: 0;
  font-size: 1em;
  line-height: 0;
  margin: 1.5em 0;
}

#toc ul {
  font-size: .8125em;
}

#toc ul ul {
  font-size: 1em;
}

#toc ul a {
  text-decoration:none;
}

#toc ul li {
  margin-bottom: .666em;
  list-style: square outside;
}

#toc li > ul {
  margin-top: .666em;
}

#toc .stability_0::after {
  background-color: #d50027;
  color: #fff;
}

#toc .stability_0::after {
  content: "deprecated";
  font-size: .8em;
  position: relative;
  top: -.18em;
  left: .5em;
  padding: 0 .3em .2em;
  border-radius: 3px;
}

#apicontent li {
  margin-bottom: .5em;
}

#apicontent li:last-child {
  margin-bottom: 0;
}

tt, code {
  font-size: .9em;
  color: #040404;
  background-color: #f2f2f2;
  border-radius: 2px;
  padding: .1em .3em;
}

a code {
  color: inherit;
  background: inherit;
  padding: 0;
}

.type {
  font-size: .9em;
  line-height: 1.5em;
}

#column1.interior {
  margin-left: 234px;
  padding: 0 2em;
  -webkit-padding-start: 1.5em;
}

#column2.interior {
  width: 234px;
  background: #333;
  position: fixed;
  left: 0;
  top: 0;
  bottom: 0;
  overflow-x: hidden;
  overflow-y: scroll;
}

#column2 ul {
  list-style: none;
  margin: .9em 0 .5em;
  background: #333;
}

#column2 > :first-child {
  margin: 1.25em 1em;
}

#column2 > ul:nth-child(2) {
  margin: 1.25em 0 .5em;
}

#column2 > ul:last-child {
  margin: .9em 0 1.25em;
}

#column2 ul li {
  padding-left: 1.4em;
  margin-bottom: .5em;
  padding-bottom: .5em;
  font-size: .8em;
}

#column2 .line {
  margin: 0 .5em;
  background-color: #707070;
}

#column2 ul li:last-child {
  margin-bottom: 0;
}

#column2 ul li a {
  color: #ccc;
  border-radius: 0;
}

#column2 ul li a.active, #column2 ul li a.active:hover,
#column2 ul li a.active:focus {
  color: #43853d;
  border-radius: 0;
  border-bottom: 1px solid #43853d;
  background: none;
}

#intro a:hover, #intro a:focus,
#column2 ul li a:hover, #column2 ul li a:focus {
  color: #fff;
  background: none;
}

span > .mark, span > .mark:visited {
  font-size: 1em;
  color: #707070;
  position: absolute;
  top: 0px;
  right: 0px;
}

span > .mark:hover, span > .mark:focus, span > .mark:active {
  color: #43853d;
  background: none;
}

th, td {
  padding: .75em 1em .75em 1em;
  vertical-align: top;
}

th > *:last-child, td > *:last-child {
  margin-bottom: 0;
}

/* simpler clearfix */
.clearfix:after {
  content: ".";
  display: block;
  height: 0;
  clear: both;
  visibility: hidden;
}

@media only screen and (max-width: 1024px) {
  #content {
    font-size: 2.5em;
    overflow: visible;
  }
  #column1.interior {
    margin-left: 0;
    padding-left: .5em;
    padding-right: .5em;
    width: auto;
    overflow-y: visible;
  }
  #column2 {
    display: none;
  }
}

@media only screen and (max-width: 1024px) and (orientation: portrait) {
  #content {
    font-size: 3.5em;
  }
}

@media print {
  html {
    height: auto;
  }
  #column2.interior {
    display: none;
  }
  #column1.interior {
    margin-left: auto;
    overflow-y: auto;
  }
}
node-v4.8.2/doc/api/_toc.html000644 000766 000024 00000013754 13070706740 016116 0ustar00iojsstaff000000 000000 


  
  Index | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    
  

  
  
  
  



node-v4.8.2/doc/api/_toc.json000644 000766 000024 00000016347 13070706740 016124 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/_toc.md",
  "desc": [
    {
      "type": "space"
    },
    {
      "type": "list_start",
      "ordered": false
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[About these Docs](documentation.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Usage & Example](synopsis.html)"
    },
    {
      "type": "space"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_end"
    },
    {
      "type": "html",
      "pre": false,
      "text": "
\n\n"
    },
    {
      "type": "list_start",
      "ordered": false
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Assertion Testing](assert.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Buffer](buffer.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[C/C++ Addons](addons.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Child Processes](child_process.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Cluster](cluster.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Command Line Options](cli.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Console](console.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Crypto](crypto.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Debugger](debugger.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[DNS](dns.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Domain](domain.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Errors](errors.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Events](events.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[File System](fs.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Globals](globals.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[HTTP](http.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[HTTPS](https.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Modules](modules.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Net](net.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[OS](os.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Path](path.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Process](process.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Punycode](punycode.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Query Strings](querystring.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Readline](readline.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[REPL](repl.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Stream](stream.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[String Decoder](string_decoder.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Timers](timers.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[TLS/SSL](tls.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[TTY](tty.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[UDP/Datagram](dgram.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[URL](url.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Utilities](util.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[V8](v8.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[VM](vm.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[ZLIB](zlib.html)"
    },
    {
      "type": "space"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_end"
    },
    {
      "type": "html",
      "pre": false,
      "text": "
\n\n"
    },
    {
      "type": "list_start",
      "ordered": false
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[GitHub Repo & Issue Tracker](https://github.com/nodejs/node)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Mailing List](http://groups.google.com/group/nodejs)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_end"
    }
  ]
}
node-v4.8.2/doc/api/_toc.md000644 000766 000024 00000002410 13070706735 015541 0ustar00iojsstaff000000 000000 @// NB(chrisdickinson): if you move this file, be sure to update tools/doc/html.js to
@// point at the new location.
* [About these Docs](documentation.html)
* [Usage & Example](synopsis.html)




* [Assertion Testing](assert.html)
* [Buffer](buffer.html)
* [C/C++ Addons](addons.html)
* [Child Processes](child_process.html)
* [Cluster](cluster.html)
* [Command Line Options](cli.html)
* [Console](console.html)
* [Crypto](crypto.html)
* [Debugger](debugger.html)
* [DNS](dns.html)
* [Domain](domain.html)
* [Errors](errors.html)
* [Events](events.html)
* [File System](fs.html)
* [Globals](globals.html)
* [HTTP](http.html)
* [HTTPS](https.html)
* [Modules](modules.html)
* [Net](net.html)
* [OS](os.html)
* [Path](path.html)
* [Process](process.html)
* [Punycode](punycode.html)
* [Query Strings](querystring.html)
* [Readline](readline.html)
* [REPL](repl.html)
* [Stream](stream.html)
* [String Decoder](string_decoder.html)
* [Timers](timers.html)
* [TLS/SSL](tls.html)
* [TTY](tty.html)
* [UDP/Datagram](dgram.html)
* [URL](url.html)
* [Utilities](util.html)
* [V8](v8.html)
* [VM](vm.html)
* [ZLIB](zlib.html)




* [GitHub Repo & Issue Tracker](https://github.com/nodejs/node)
* [Mailing List](http://groups.google.com/group/nodejs)
node-v4.8.2/doc/api/addons.html000644 000766 000024 00000121406 13070706740 016434 0ustar00iojsstaff000000 000000 


  
  C/C++ Addons | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

      

        
C/C++ Addons#


Node.js Addons are dynamically-linked shared objects, written in C or C++, that
can be loaded into Node.js using the require() function, and used
just as if they were an ordinary Node.js module. They are used primarily to
provide an interface between JavaScript running in Node.js and C/C++ libraries.


At the moment, the method for implementing Addons is rather complicated,
involving knowledge of several components and APIs :


    

  • V8: the C++ library Node.js currently uses to provide the
JavaScript implementation. V8 provides the mechanisms for creating objects,
calling functions, etc. V8's API is documented mostly in the
v8.h header file (deps/v8/include/v8.h in the Node.js source
tree), which is also available online.
    

    • 

  • libuv: The C library that implements the Node.js event loop, its worker
threads and all of the asynchronous behaviors of the platform. It also
serves as a cross-platform abstraction library, giving easy, POSIX-like
access across all major operating systems to many common system tasks, such
as interacting with the filesystem, sockets, timers and system events. libuv
also provides a pthreads-like threading abstraction that may be used to
power more sophisticated asynchronous Addons that need to move beyond the
standard event loop. Addon authors are encouraged to think about how to
avoid blocking the event loop with I/O or other time-intensive tasks by
off-loading work via libuv to non-blocking system operations, worker threads
or a custom use of libuv's threads.
    

    • 

  • Internal Node.js libraries. Node.js itself exports a number of C/C++ APIs
that Addons can use — the most important of which is the
node::ObjectWrap class.
    

    • 

  • Node.js includes a number of other statically linked libraries including
OpenSSL. These other libraries are located in the deps/ directory in the
Node.js source tree. Only the V8 and OpenSSL symbols are purposefully
re-exported by Node.js and may be used to various extents by Addons.
See Linking to Node.js' own dependencies for additional information.
    

    • 



All of the following examples are available for download and may
be used as a starting-point for your own Addon.


Hello world#


This "Hello world" example is a simple Addon, written in C++, that is the
equivalent of the following JavaScript code:


module.exports.hello = () => 'world';



First, create the file hello.cc:


// hello.cc
#include <node.h>

namespace demo {

using v8::FunctionCallbackInfo;
using v8::Isolate;
using v8::Local;
using v8::Object;
using v8::String;
using v8::Value;

void Method(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();
  args.GetReturnValue().Set(String::NewFromUtf8(isolate, "world"));
}

void init(Local<Object> exports) {
  NODE_SET_METHOD(exports, "hello", Method);
}

NODE_MODULE(addon, init)

}  // namespace demo



Note that all Node.js Addons must export an initialization function following
the pattern:


void Initialize(Local<Object> exports);
NODE_MODULE(module_name, Initialize)



There is no semi-colon after NODE_MODULE as it's not a function (see
node.h).


The module_name must match the filename of the final binary (excluding
the .node suffix).


In the hello.cc example, then, the initialization function is init and the
Addon module name is addon.


Building#


Once the source code has been written, it must be compiled into the binary
addon.node file. To do so, create a file called binding.gyp in the
top-level of the project describing the build configuration of your module
using a JSON-like format. This file is used by node-gyp -- a tool written
specifically to compile Node.js Addons.


{
  "targets": [
    {
      "target_name": "addon",
      "sources": [ "hello.cc" ]
    }
  ]
}

Note: A version of the node-gyp utility is bundled and distributed with
Node.js as part of npm. This version is not made directly available for
developers to use and is intended only to support the ability to use the
npm install command to compile and install Addons. Developers who wish to
use node-gyp directly can install it using the command
npm install -g node-gyp. See the node-gyp installation instructions for
more information, including platform-specific requirements.


Once the binding.gyp file has been created, use node-gyp configure to
generate the appropriate project build files for the current platform. This
will generate either a Makefile (on Unix platforms) or a vcxproj file
(on Windows) in the build/ directory.


Next, invoke the node-gyp build command to generate the compiled addon.node
file. This will be put into the build/Release/ directory.


When using npm install to install a Node.js Addon, npm uses its own bundled
version of node-gyp to perform this same set of actions, generating a
compiled version of the Addon for the user's platform on demand.


Once built, the binary Addon can be used from within Node.js by pointing
require() to the built addon.node module:


// hello.js
const addon = require('./build/Release/addon');

console.log(addon.hello()); // 'world'



Please see the examples below for further information or
https://github.com/arturadib/node-qt for an example in production.


Because the exact path to the compiled Addon binary can vary depending on how
it is compiled (i.e. sometimes it may be in ./build/Debug/), Addons can use
the bindings package to load the compiled module.


Note that while the bindings package implementation is more sophisticated
in how it locates Addon modules, it is essentially using a try-catch pattern
similar to:


try {
  return require('./build/Release/addon.node');
} catch (err) {
  return require('./build/Debug/addon.node');
}



Linking to Node.js' own dependencies#


Node.js uses a number of statically linked libraries such as V8, libuv and
OpenSSL. All Addons are required to link to V8 and may link to any of the
other dependencies as well. Typically, this is as simple as including
the appropriate #include <...> statements (e.g. #include <v8.h>) and
node-gyp will locate the appropriate headers automatically. However, there
are a few caveats to be aware of:


    

  • When node-gyp runs, it will detect the specific release version of Node.js
and download either the full source tarball or just the headers. If the full
source is downloaded, Addons will have complete access to the full set of
Node.js dependencies. However, if only the Node.js headers are downloaded, then
only the symbols exported by Node.js will be available.
    

    • 

  • node-gyp can be run using the --nodedir flag pointing at a local Node.js
source image. Using this option, the Addon will have access to the full set of
dependencies.
    

    • 



Loading Addons using require()#


The filename extension of the compiled Addon binary is .node (as opposed
to .dll or .so). The require() function is written to look for
files with the .node file extension and initialize those as dynamically-linked
libraries.


When calling require(), the .node extension can usually be
omitted and Node.js will still find and initialize the Addon. One caveat,
however, is that Node.js will first attempt to locate and load modules or
JavaScript files that happen to share the same base name. For instance, if
there is a file addon.js in the same directory as the binary addon.node,
then require('addon') will give precedence to the addon.js file
and load it instead.


Native Abstractions for Node.js#


Each of the examples illustrated in this document make direct use of the
Node.js and V8 APIs for implementing Addons. It is important to understand
that the V8 API can, and has, changed dramatically from one V8 release to the
next (and one major Node.js release to the next). With each change, Addons may
need to be updated and recompiled in order to continue functioning. The Node.js
release schedule is designed to minimize the frequency and impact of such
changes but there is little that Node.js can do currently to ensure stability
of the V8 APIs.


The Native Abstractions for Node.js (or nan) provide a set of tools that
Addon developers are recommended to use to keep compatibility between past and
future releases of V8 and Node.js. See the nan examples for an
illustration of how it can be used.


Addon examples#


Following are some example Addons intended to help developers get started. The
examples make use of the V8 APIs. Refer to the online V8 reference
for help with the various V8 calls, and V8's Embedder's Guide for an
explanation of several concepts used such as handles, scopes, function
templates, etc.


Each of these examples using the following binding.gyp file:


{
  "targets": [
    {
      "target_name": "addon",
      "sources": [ "addon.cc" ]
    }
  ]
}

In cases where there is more than one .cc file, simply add the additional
filename to the sources array. For example:


"sources": ["addon.cc", "myexample.cc"]

Once the binding.gyp file is ready, the example Addons can be configured and
built using node-gyp:


$ node-gyp configure build

Function arguments#


Addons will typically expose objects and functions that can be accessed from
JavaScript running within Node.js. When functions are invoked from JavaScript,
the input arguments and return value must be mapped to and from the C/C++
code.


The following example illustrates how to read function arguments passed from
JavaScript and how to return a result:


// addon.cc
#include <node.h>

namespace demo {

using v8::Exception;
using v8::FunctionCallbackInfo;
using v8::Isolate;
using v8::Local;
using v8::Number;
using v8::Object;
using v8::String;
using v8::Value;

// This is the implementation of the "add" method
// Input arguments are passed using the
// const FunctionCallbackInfo<Value>& args struct
void Add(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();

  // Check the number of arguments passed.
  if (args.Length() < 2) {
    // Throw an Error that is passed back to JavaScript
    isolate->ThrowException(Exception::TypeError(
        String::NewFromUtf8(isolate, "Wrong number of arguments")));
    return;
  }

  // Check the argument types
  if (!args[0]->IsNumber() || !args[1]->IsNumber()) {
    isolate->ThrowException(Exception::TypeError(
        String::NewFromUtf8(isolate, "Wrong arguments")));
    return;
  }

  // Perform the operation
  double value = args[0]->NumberValue() + args[1]->NumberValue();
  Local<Number> num = Number::New(isolate, value);

  // Set the return value (using the passed in
  // FunctionCallbackInfo<Value>&)
  args.GetReturnValue().Set(num);
}

void Init(Local<Object> exports) {
  NODE_SET_METHOD(exports, "add", Add);
}

NODE_MODULE(addon, Init)

}  // namespace demo



Once compiled, the example Addon can be required and used from within Node.js:


// test.js
const addon = require('./build/Release/addon');

console.log('This should be eight:', addon.add(3, 5));



Callbacks#


It is common practice within Addons to pass JavaScript functions to a C++
function and execute them from there. The following example illustrates how
to invoke such callbacks:


// addon.cc
#include <node.h>

namespace demo {

using v8::Function;
using v8::FunctionCallbackInfo;
using v8::Isolate;
using v8::Local;
using v8::Null;
using v8::Object;
using v8::String;
using v8::Value;

void RunCallback(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();
  Local<Function> cb = Local<Function>::Cast(args[0]);
  const unsigned argc = 1;
  Local<Value> argv[argc] = { String::NewFromUtf8(isolate, "hello world") };
  cb->Call(Null(isolate), argc, argv);
}

void Init(Local<Object> exports, Local<Object> module) {
  NODE_SET_METHOD(module, "exports", RunCallback);
}

NODE_MODULE(addon, Init)

}  // namespace demo



Note that this example uses a two-argument form of Init() that receives
the full module object as the second argument. This allows the Addon
to completely overwrite exports with a single function instead of
adding the function as a property of exports.


To test it, run the following JavaScript:


// test.js
const addon = require('./build/Release/addon');

addon((msg) => {
  console.log(msg); // 'hello world'
});



Note that, in this example, the callback function is invoked synchronously.


Object factory#


Addons can create and return new objects from within a C++ function as
illustrated in the following example. An object is created and returned with a
property msg that echoes the string passed to createObject():


// addon.cc
#include <node.h>

namespace demo {

using v8::FunctionCallbackInfo;
using v8::Isolate;
using v8::Local;
using v8::Object;
using v8::String;
using v8::Value;

void CreateObject(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();

  Local<Object> obj = Object::New(isolate);
  obj->Set(String::NewFromUtf8(isolate, "msg"), args[0]->ToString());

  args.GetReturnValue().Set(obj);
}

void Init(Local<Object> exports, Local<Object> module) {
  NODE_SET_METHOD(module, "exports", CreateObject);
}

NODE_MODULE(addon, Init)

}  // namespace demo



To test it in JavaScript:


// test.js
const addon = require('./build/Release/addon');

var obj1 = addon('hello');
var obj2 = addon('world');
console.log(obj1.msg, obj2.msg); // 'hello world'



Function factory#


Another common scenario is creating JavaScript functions that wrap C++
functions and returning those back to JavaScript:


// addon.cc
#include <node.h>

namespace demo {

using v8::Function;
using v8::FunctionCallbackInfo;
using v8::FunctionTemplate;
using v8::Isolate;
using v8::Local;
using v8::Object;
using v8::String;
using v8::Value;

void MyFunction(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();
  args.GetReturnValue().Set(String::NewFromUtf8(isolate, "hello world"));
}

void CreateFunction(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();

  Local<FunctionTemplate> tpl = FunctionTemplate::New(isolate, MyFunction);
  Local<Function> fn = tpl->GetFunction();

  // omit this to make it anonymous
  fn->SetName(String::NewFromUtf8(isolate, "theFunction"));

  args.GetReturnValue().Set(fn);
}

void Init(Local<Object> exports, Local<Object> module) {
  NODE_SET_METHOD(module, "exports", CreateFunction);
}

NODE_MODULE(addon, Init)

}  // namespace demo



To test:


// test.js
const addon = require('./build/Release/addon');

var fn = addon();
console.log(fn()); // 'hello world'



Wrapping C++ objects#


It is also possible to wrap C++ objects/classes in a way that allows new
instances to be created using the JavaScript new operator:


// addon.cc
#include <node.h>
#include "myobject.h"

namespace demo {

using v8::Local;
using v8::Object;

void InitAll(Local<Object> exports) {
  MyObject::Init(exports);
}

NODE_MODULE(addon, InitAll)

}  // namespace demo



Then, in myobject.h, the wrapper class inherits from node::ObjectWrap:


// myobject.h
#ifndef MYOBJECT_H
#define MYOBJECT_H

#include <node.h>
#include <node_object_wrap.h>

namespace demo {

class MyObject : public node::ObjectWrap {
 public:
  static void Init(v8::Local<v8::Object> exports);

 private:
  explicit MyObject(double value = 0);
  ~MyObject();

  static void New(const v8::FunctionCallbackInfo<v8::Value>& args);
  static void PlusOne(const v8::FunctionCallbackInfo<v8::Value>& args);
  static v8::Persistent<v8::Function> constructor;
  double value_;
};

}  // namespace demo

#endif



In myobject.cc, implement the various methods that are to be exposed.
Below, the method plusOne() is exposed by adding it to the constructor's
prototype:


// myobject.cc
#include "myobject.h"

namespace demo {

using v8::Context;
using v8::Function;
using v8::FunctionCallbackInfo;
using v8::FunctionTemplate;
using v8::Isolate;
using v8::Local;
using v8::Number;
using v8::Object;
using v8::Persistent;
using v8::String;
using v8::Value;

Persistent<Function> MyObject::constructor;

MyObject::MyObject(double value) : value_(value) {
}

MyObject::~MyObject() {
}

void MyObject::Init(Local<Object> exports) {
  Isolate* isolate = exports->GetIsolate();

  // Prepare constructor template
  Local<FunctionTemplate> tpl = FunctionTemplate::New(isolate, New);
  tpl->SetClassName(String::NewFromUtf8(isolate, "MyObject"));
  tpl->InstanceTemplate()->SetInternalFieldCount(1);

  // Prototype
  NODE_SET_PROTOTYPE_METHOD(tpl, "plusOne", PlusOne);

  constructor.Reset(isolate, tpl->GetFunction());
  exports->Set(String::NewFromUtf8(isolate, "MyObject"),
               tpl->GetFunction());
}

void MyObject::New(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();

  if (args.IsConstructCall()) {
    // Invoked as constructor: `new MyObject(...)`
    double value = args[0]->IsUndefined() ? 0 : args[0]->NumberValue();
    MyObject* obj = new MyObject(value);
    obj->Wrap(args.This());
    args.GetReturnValue().Set(args.This());
  } else {
    // Invoked as plain function `MyObject(...)`, turn into construct call.
    const int argc = 1;
    Local<Value> argv[argc] = { args[0] };
    Local<Context> context = isolate->GetCurrentContext();
    Local<Function> cons = Local<Function>::New(isolate, constructor);
    Local<Object> result =
        cons->NewInstance(context, argc, argv).ToLocalChecked();
    args.GetReturnValue().Set(result);
  }
}

void MyObject::PlusOne(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();

  MyObject* obj = ObjectWrap::Unwrap<MyObject>(args.Holder());
  obj->value_ += 1;

  args.GetReturnValue().Set(Number::New(isolate, obj->value_));
}

}  // namespace demo



To build this example, the myobject.cc file must be added to the
binding.gyp:


{
  "targets": [
    {
      "target_name": "addon",
      "sources": [
        "addon.cc",
        "myobject.cc"
      ]
    }
  ]
}

Test it with:


// test.js
const addon = require('./build/Release/addon');

var obj = new addon.MyObject(10);
console.log(obj.plusOne()); // 11
console.log(obj.plusOne()); // 12
console.log(obj.plusOne()); // 13



Factory of wrapped objects#


Alternatively, it is possible to use a factory pattern to avoid explicitly
creating object instances using the JavaScript new operator:


var obj = addon.createObject();
// instead of:
// var obj = new addon.Object();



First, the createObject() method is implemented in addon.cc:


// addon.cc
#include <node.h>
#include "myobject.h"

namespace demo {

using v8::FunctionCallbackInfo;
using v8::Isolate;
using v8::Local;
using v8::Object;
using v8::String;
using v8::Value;

void CreateObject(const FunctionCallbackInfo<Value>& args) {
  MyObject::NewInstance(args);
}

void InitAll(Local<Object> exports, Local<Object> module) {
  MyObject::Init(exports->GetIsolate());

  NODE_SET_METHOD(module, "exports", CreateObject);
}

NODE_MODULE(addon, InitAll)

}  // namespace demo



In myobject.h, the static method NewInstance() is added to handle
instantiating the object. This method takes the place of using new in
JavaScript:


// myobject.h
#ifndef MYOBJECT_H
#define MYOBJECT_H

#include <node.h>
#include <node_object_wrap.h>

namespace demo {

class MyObject : public node::ObjectWrap {
 public:
  static void Init(v8::Isolate* isolate);
  static void NewInstance(const v8::FunctionCallbackInfo<v8::Value>& args);

 private:
  explicit MyObject(double value = 0);
  ~MyObject();

  static void New(const v8::FunctionCallbackInfo<v8::Value>& args);
  static void PlusOne(const v8::FunctionCallbackInfo<v8::Value>& args);
  static v8::Persistent<v8::Function> constructor;
  double value_;
};

}  // namespace demo

#endif



The implementation in myobject.cc is similar to the previous example:


// myobject.cc
#include <node.h>
#include "myobject.h"

namespace demo {

using v8::Context;
using v8::Function;
using v8::FunctionCallbackInfo;
using v8::FunctionTemplate;
using v8::Isolate;
using v8::Local;
using v8::Number;
using v8::Object;
using v8::Persistent;
using v8::String;
using v8::Value;

Persistent<Function> MyObject::constructor;

MyObject::MyObject(double value) : value_(value) {
}

MyObject::~MyObject() {
}

void MyObject::Init(Isolate* isolate) {
  // Prepare constructor template
  Local<FunctionTemplate> tpl = FunctionTemplate::New(isolate, New);
  tpl->SetClassName(String::NewFromUtf8(isolate, "MyObject"));
  tpl->InstanceTemplate()->SetInternalFieldCount(1);

  // Prototype
  NODE_SET_PROTOTYPE_METHOD(tpl, "plusOne", PlusOne);

  constructor.Reset(isolate, tpl->GetFunction());
}

void MyObject::New(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();

  if (args.IsConstructCall()) {
    // Invoked as constructor: `new MyObject(...)`
    double value = args[0]->IsUndefined() ? 0 : args[0]->NumberValue();
    MyObject* obj = new MyObject(value);
    obj->Wrap(args.This());
    args.GetReturnValue().Set(args.This());
  } else {
    // Invoked as plain function `MyObject(...)`, turn into construct call.
    const int argc = 1;
    Local<Value> argv[argc] = { args[0] };
    Local<Function> cons = Local<Function>::New(isolate, constructor);
    Local<Context> context = isolate->GetCurrentContext();
    Local<Object> instance =
        cons->NewInstance(context, argc, argv).ToLocalChecked();
    args.GetReturnValue().Set(instance);
  }
}

void MyObject::NewInstance(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();

  const unsigned argc = 1;
  Local<Value> argv[argc] = { args[0] };
  Local<Function> cons = Local<Function>::New(isolate, constructor);
  Local<Context> context = isolate->GetCurrentContext();
  Local<Object> instance =
      cons->NewInstance(context, argc, argv).ToLocalChecked();

  args.GetReturnValue().Set(instance);
}

void MyObject::PlusOne(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();

  MyObject* obj = ObjectWrap::Unwrap<MyObject>(args.Holder());
  obj->value_ += 1;

  args.GetReturnValue().Set(Number::New(isolate, obj->value_));
}

}  // namespace demo



Once again, to build this example, the myobject.cc file must be added to the
binding.gyp:


{
  "targets": [
    {
      "target_name": "addon",
      "sources": [
        "addon.cc",
        "myobject.cc"
      ]
    }
  ]
}

Test it with:


// test.js
const createObject = require('./build/Release/addon');

var obj = createObject(10);
console.log(obj.plusOne()); // 11
console.log(obj.plusOne()); // 12
console.log(obj.plusOne()); // 13

var obj2 = createObject(20);
console.log(obj2.plusOne()); // 21
console.log(obj2.plusOne()); // 22
console.log(obj2.plusOne()); // 23



Passing wrapped objects around#


In addition to wrapping and returning C++ objects, it is possible to pass
wrapped objects around by unwrapping them with the Node.js helper function
node::ObjectWrap::Unwrap. The following examples shows a function add()
that can take two MyObject objects as input arguments:


// addon.cc
#include <node.h>
#include <node_object_wrap.h>
#include "myobject.h"

namespace demo {

using v8::FunctionCallbackInfo;
using v8::Isolate;
using v8::Local;
using v8::Number;
using v8::Object;
using v8::String;
using v8::Value;

void CreateObject(const FunctionCallbackInfo<Value>& args) {
  MyObject::NewInstance(args);
}

void Add(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();

  MyObject* obj1 = node::ObjectWrap::Unwrap<MyObject>(
      args[0]->ToObject());
  MyObject* obj2 = node::ObjectWrap::Unwrap<MyObject>(
      args[1]->ToObject());

  double sum = obj1->value() + obj2->value();
  args.GetReturnValue().Set(Number::New(isolate, sum));
}

void InitAll(Local<Object> exports) {
  MyObject::Init(exports->GetIsolate());

  NODE_SET_METHOD(exports, "createObject", CreateObject);
  NODE_SET_METHOD(exports, "add", Add);
}

NODE_MODULE(addon, InitAll)

}  // namespace demo



In myobject.h, a new public method is added to allow access to private values
after unwrapping the object.


// myobject.h
#ifndef MYOBJECT_H
#define MYOBJECT_H

#include <node.h>
#include <node_object_wrap.h>

namespace demo {

class MyObject : public node::ObjectWrap {
 public:
  static void Init(v8::Isolate* isolate);
  static void NewInstance(const v8::FunctionCallbackInfo<v8::Value>& args);
  inline double value() const { return value_; }

 private:
  explicit MyObject(double value = 0);
  ~MyObject();

  static void New(const v8::FunctionCallbackInfo<v8::Value>& args);
  static v8::Persistent<v8::Function> constructor;
  double value_;
};

}  // namespace demo

#endif



The implementation of myobject.cc is similar to before:


// myobject.cc
#include <node.h>
#include "myobject.h"

namespace demo {

using v8::Context;
using v8::Function;
using v8::FunctionCallbackInfo;
using v8::FunctionTemplate;
using v8::Isolate;
using v8::Local;
using v8::Object;
using v8::Persistent;
using v8::String;
using v8::Value;

Persistent<Function> MyObject::constructor;

MyObject::MyObject(double value) : value_(value) {
}

MyObject::~MyObject() {
}

void MyObject::Init(Isolate* isolate) {
  // Prepare constructor template
  Local<FunctionTemplate> tpl = FunctionTemplate::New(isolate, New);
  tpl->SetClassName(String::NewFromUtf8(isolate, "MyObject"));
  tpl->InstanceTemplate()->SetInternalFieldCount(1);

  constructor.Reset(isolate, tpl->GetFunction());
}

void MyObject::New(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();

  if (args.IsConstructCall()) {
    // Invoked as constructor: `new MyObject(...)`
    double value = args[0]->IsUndefined() ? 0 : args[0]->NumberValue();
    MyObject* obj = new MyObject(value);
    obj->Wrap(args.This());
    args.GetReturnValue().Set(args.This());
  } else {
    // Invoked as plain function `MyObject(...)`, turn into construct call.
    const int argc = 1;
    Local<Value> argv[argc] = { args[0] };
    Local<Context> context = isolate->GetCurrentContext();
    Local<Function> cons = Local<Function>::New(isolate, constructor);
    Local<Object> instance =
        cons->NewInstance(context, argc, argv).ToLocalChecked();
    args.GetReturnValue().Set(instance);
  }
}

void MyObject::NewInstance(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();

  const unsigned argc = 1;
  Local<Value> argv[argc] = { args[0] };
  Local<Function> cons = Local<Function>::New(isolate, constructor);
  Local<Context> context = isolate->GetCurrentContext();
  Local<Object> instance =
      cons->NewInstance(context, argc, argv).ToLocalChecked();

  args.GetReturnValue().Set(instance);
}

}  // namespace demo



Test it with:


// test.js
const addon = require('./build/Release/addon');

var obj1 = addon.createObject(10);
var obj2 = addon.createObject(20);
var result = addon.add(obj1, obj2);

console.log(result); // 30



AtExit hooks#


An "AtExit" hook is a function that is invoked after the Node.js event loop
has ended but before the JavaScript VM is terminated and Node.js shuts down.
"AtExit" hooks are registered using the node::AtExit API.


void AtExit(callback, args)#


    

  • callback: void (*)(void*) - A pointer to the function to call at exit.
    • 

  • args: void* - A pointer to pass to the callback at exit.
    • 



Registers exit hooks that run after the event loop has ended but before the VM
is killed.


AtExit takes two parameters: a pointer to a callback function to run at exit,
and a pointer to untyped context data to be passed to that callback.


Callbacks are run in last-in first-out order.


The following addon.cc implements AtExit:


// addon.cc
#undef NDEBUG
#include <assert.h>
#include <stdlib.h>
#include <node.h>

namespace demo {

using node::AtExit;
using v8::HandleScope;
using v8::Isolate;
using v8::Local;
using v8::Object;

static char cookie[] = "yum yum";
static int at_exit_cb1_called = 0;
static int at_exit_cb2_called = 0;

static void at_exit_cb1(void* arg) {
  Isolate* isolate = static_cast<Isolate*>(arg);
  HandleScope scope(isolate);
  Local<Object> obj = Object::New(isolate);
  assert(!obj.IsEmpty()); // assert VM is still alive
  assert(obj->IsObject());
  at_exit_cb1_called++;
}

static void at_exit_cb2(void* arg) {
  assert(arg == static_cast<void*>(cookie));
  at_exit_cb2_called++;
}

static void sanity_check(void*) {
  assert(at_exit_cb1_called == 1);
  assert(at_exit_cb2_called == 2);
}

void init(Local<Object> exports) {
  AtExit(sanity_check);
  AtExit(at_exit_cb2, cookie);
  AtExit(at_exit_cb2, cookie);
  AtExit(at_exit_cb1, exports->GetIsolate());
}

NODE_MODULE(addon, init);

}  // namespace demo



Test in JavaScript by running:


// test.js
const addon = require('./build/Release/addon');



      

    

  

  
  
  
  



node-v4.8.2/doc/api/addons.json000644 000766 000024 00000112624 13070706740 016443 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/addons.md",
  "modules": [
    {
      "textRaw": "C/C++ Addons",
      "name": "c/c++_addons",
      "desc": "
Node.js Addons are dynamically-linked shared objects, written in C or C++, that\ncan be loaded into Node.js using the require() function, and used\njust as if they were an ordinary Node.js module. They are used primarily to\nprovide an interface between JavaScript running in Node.js and C/C++ libraries.
\n
At the moment, the method for implementing Addons is rather complicated,\ninvolving knowledge of several components and APIs :
\n
    \n
  • V8: the C++ library Node.js currently uses to provide the\nJavaScript implementation. V8 provides the mechanisms for creating objects,\ncalling functions, etc. V8's API is documented mostly in the\nv8.h header file (deps/v8/include/v8.h in the Node.js source\ntree), which is also available online.
    \n
    • \n
  • libuv: The C library that implements the Node.js event loop, its worker\nthreads and all of the asynchronous behaviors of the platform. It also\nserves as a cross-platform abstraction library, giving easy, POSIX-like\naccess across all major operating systems to many common system tasks, such\nas interacting with the filesystem, sockets, timers and system events. libuv\nalso provides a pthreads-like threading abstraction that may be used to\npower more sophisticated asynchronous Addons that need to move beyond the\nstandard event loop. Addon authors are encouraged to think about how to\navoid blocking the event loop with I/O or other time-intensive tasks by\noff-loading work via libuv to non-blocking system operations, worker threads\nor a custom use of libuv's threads.
    \n
    • \n
  • Internal Node.js libraries. Node.js itself exports a number of C/C++ APIs\nthat Addons can use — the most important of which is the\nnode::ObjectWrap class.
    \n
    • \n
  • Node.js includes a number of other statically linked libraries including\nOpenSSL. These other libraries are located in the deps/ directory in the\nNode.js source tree. Only the V8 and OpenSSL symbols are purposefully\nre-exported by Node.js and may be used to various extents by Addons.\nSee Linking to Node.js' own dependencies for additional information.
    \n
    • \n
\n
All of the following examples are available for download and may\nbe used as a starting-point for your own Addon.
\n",
      "modules": [
        {
          "textRaw": "Hello world",
          "name": "hello_world",
          "desc": "
This "Hello world" example is a simple Addon, written in C++, that is the\nequivalent of the following JavaScript code:
\n
module.exports.hello = () => 'world';\n
\n
First, create the file hello.cc:
\n
// hello.cc\n#include <node.h>\n\nnamespace demo {\n\nusing v8::FunctionCallbackInfo;\nusing v8::Isolate;\nusing v8::Local;\nusing v8::Object;\nusing v8::String;\nusing v8::Value;\n\nvoid Method(const FunctionCallbackInfo<Value>& args) {\n  Isolate* isolate = args.GetIsolate();\n  args.GetReturnValue().Set(String::NewFromUtf8(isolate, "world"));\n}\n\nvoid init(Local<Object> exports) {\n  NODE_SET_METHOD(exports, "hello", Method);\n}\n\nNODE_MODULE(addon, init)\n\n}  // namespace demo\n
\n
Note that all Node.js Addons must export an initialization function following\nthe pattern:
\n
void Initialize(Local<Object> exports);\nNODE_MODULE(module_name, Initialize)\n
\n
There is no semi-colon after NODE_MODULE as it's not a function (see\nnode.h).
\n
The module_name must match the filename of the final binary (excluding\nthe .node suffix).
\n
In the hello.cc example, then, the initialization function is init and the\nAddon module name is addon.
\n",
          "modules": [
            {
              "textRaw": "Building",
              "name": "building",
              "desc": "
Once the source code has been written, it must be compiled into the binary\naddon.node file. To do so, create a file called binding.gyp in the\ntop-level of the project describing the build configuration of your module\nusing a JSON-like format. This file is used by node-gyp -- a tool written\nspecifically to compile Node.js Addons.
\n
{\n  "targets": [\n    {\n      "target_name": "addon",\n      "sources": [ "hello.cc" ]\n    }\n  ]\n}\n
Note: A version of the node-gyp utility is bundled and distributed with\nNode.js as part of npm. This version is not made directly available for\ndevelopers to use and is intended only to support the ability to use the\nnpm install command to compile and install Addons. Developers who wish to\nuse node-gyp directly can install it using the command\nnpm install -g node-gyp. See the node-gyp installation instructions for\nmore information, including platform-specific requirements.
\n
Once the binding.gyp file has been created, use node-gyp configure to\ngenerate the appropriate project build files for the current platform. This\nwill generate either a Makefile (on Unix platforms) or a vcxproj file\n(on Windows) in the build/ directory.
\n
Next, invoke the node-gyp build command to generate the compiled addon.node\nfile. This will be put into the build/Release/ directory.
\n
When using npm install to install a Node.js Addon, npm uses its own bundled\nversion of node-gyp to perform this same set of actions, generating a\ncompiled version of the Addon for the user's platform on demand.
\n
Once built, the binary Addon can be used from within Node.js by pointing\nrequire() to the built addon.node module:
\n
// hello.js\nconst addon = require('./build/Release/addon');\n\nconsole.log(addon.hello()); // 'world'\n
\n
Please see the examples below for further information or\nhttps://github.com/arturadib/node-qt for an example in production.
\n
Because the exact path to the compiled Addon binary can vary depending on how\nit is compiled (i.e. sometimes it may be in ./build/Debug/), Addons can use\nthe bindings package to load the compiled module.
\n
Note that while the bindings package implementation is more sophisticated\nin how it locates Addon modules, it is essentially using a try-catch pattern\nsimilar to:
\n
try {\n  return require('./build/Release/addon.node');\n} catch (err) {\n  return require('./build/Debug/addon.node');\n}\n
\n",
              "type": "module",
              "displayName": "Building"
            },
            {
              "textRaw": "Linking to Node.js' own dependencies",
              "name": "linking_to_node.js'_own_dependencies",
              "desc": "
Node.js uses a number of statically linked libraries such as V8, libuv and\nOpenSSL. All Addons are required to link to V8 and may link to any of the\nother dependencies as well. Typically, this is as simple as including\nthe appropriate #include <...> statements (e.g. #include <v8.h>) and\nnode-gyp will locate the appropriate headers automatically. However, there\nare a few caveats to be aware of:
\n
    \n
  • When node-gyp runs, it will detect the specific release version of Node.js\nand download either the full source tarball or just the headers. If the full\nsource is downloaded, Addons will have complete access to the full set of\nNode.js dependencies. However, if only the Node.js headers are downloaded, then\nonly the symbols exported by Node.js will be available.
    \n
    • \n
  • node-gyp can be run using the --nodedir flag pointing at a local Node.js\nsource image. Using this option, the Addon will have access to the full set of\ndependencies.
    \n
    • \n
\n",
              "type": "module",
              "displayName": "Linking to Node.js' own dependencies"
            },
            {
              "textRaw": "Loading Addons using require()",
              "name": "loading_addons_using_require()",
              "desc": "
The filename extension of the compiled Addon binary is .node (as opposed\nto .dll or .so). The require() function is written to look for\nfiles with the .node file extension and initialize those as dynamically-linked\nlibraries.
\n
When calling require(), the .node extension can usually be\nomitted and Node.js will still find and initialize the Addon. One caveat,\nhowever, is that Node.js will first attempt to locate and load modules or\nJavaScript files that happen to share the same base name. For instance, if\nthere is a file addon.js in the same directory as the binary addon.node,\nthen require('addon') will give precedence to the addon.js file\nand load it instead.
\n",
              "type": "module",
              "displayName": "Loading Addons using require()"
            }
          ],
          "type": "module",
          "displayName": "Hello world"
        },
        {
          "textRaw": "Addon examples",
          "name": "addon_examples",
          "desc": "
Following are some example Addons intended to help developers get started. The\nexamples make use of the V8 APIs. Refer to the online V8 reference\nfor help with the various V8 calls, and V8's Embedder's Guide for an\nexplanation of several concepts used such as handles, scopes, function\ntemplates, etc.
\n
Each of these examples using the following binding.gyp file:
\n
{\n  "targets": [\n    {\n      "target_name": "addon",\n      "sources": [ "addon.cc" ]\n    }\n  ]\n}\n
In cases where there is more than one .cc file, simply add the additional\nfilename to the sources array. For example:
\n
"sources": ["addon.cc", "myexample.cc"]\n
Once the binding.gyp file is ready, the example Addons can be configured and\nbuilt using node-gyp:
\n
$ node-gyp configure build\n
",
          "modules": [
            {
              "textRaw": "Function arguments",
              "name": "function_arguments",
              "desc": "
Addons will typically expose objects and functions that can be accessed from\nJavaScript running within Node.js. When functions are invoked from JavaScript,\nthe input arguments and return value must be mapped to and from the C/C++\ncode.
\n
The following example illustrates how to read function arguments passed from\nJavaScript and how to return a result:
\n
// addon.cc\n#include <node.h>\n\nnamespace demo {\n\nusing v8::Exception;\nusing v8::FunctionCallbackInfo;\nusing v8::Isolate;\nusing v8::Local;\nusing v8::Number;\nusing v8::Object;\nusing v8::String;\nusing v8::Value;\n\n// This is the implementation of the "add" method\n// Input arguments are passed using the\n// const FunctionCallbackInfo<Value>& args struct\nvoid Add(const FunctionCallbackInfo<Value>& args) {\n  Isolate* isolate = args.GetIsolate();\n\n  // Check the number of arguments passed.\n  if (args.Length() < 2) {\n    // Throw an Error that is passed back to JavaScript\n    isolate->ThrowException(Exception::TypeError(\n        String::NewFromUtf8(isolate, "Wrong number of arguments")));\n    return;\n  }\n\n  // Check the argument types\n  if (!args[0]->IsNumber() || !args[1]->IsNumber()) {\n    isolate->ThrowException(Exception::TypeError(\n        String::NewFromUtf8(isolate, "Wrong arguments")));\n    return;\n  }\n\n  // Perform the operation\n  double value = args[0]->NumberValue() + args[1]->NumberValue();\n  Local<Number> num = Number::New(isolate, value);\n\n  // Set the return value (using the passed in\n  // FunctionCallbackInfo<Value>&)\n  args.GetReturnValue().Set(num);\n}\n\nvoid Init(Local<Object> exports) {\n  NODE_SET_METHOD(exports, "add", Add);\n}\n\nNODE_MODULE(addon, Init)\n\n}  // namespace demo\n
\n
Once compiled, the example Addon can be required and used from within Node.js:
\n
// test.js\nconst addon = require('./build/Release/addon');\n\nconsole.log('This should be eight:', addon.add(3, 5));\n
\n",
              "type": "module",
              "displayName": "Function arguments"
            },
            {
              "textRaw": "Callbacks",
              "name": "callbacks",
              "desc": "
It is common practice within Addons to pass JavaScript functions to a C++\nfunction and execute them from there. The following example illustrates how\nto invoke such callbacks:
\n
// addon.cc\n#include <node.h>\n\nnamespace demo {\n\nusing v8::Function;\nusing v8::FunctionCallbackInfo;\nusing v8::Isolate;\nusing v8::Local;\nusing v8::Null;\nusing v8::Object;\nusing v8::String;\nusing v8::Value;\n\nvoid RunCallback(const FunctionCallbackInfo<Value>& args) {\n  Isolate* isolate = args.GetIsolate();\n  Local<Function> cb = Local<Function>::Cast(args[0]);\n  const unsigned argc = 1;\n  Local<Value> argv[argc] = { String::NewFromUtf8(isolate, "hello world") };\n  cb->Call(Null(isolate), argc, argv);\n}\n\nvoid Init(Local<Object> exports, Local<Object> module) {\n  NODE_SET_METHOD(module, "exports", RunCallback);\n}\n\nNODE_MODULE(addon, Init)\n\n}  // namespace demo\n
\n
Note that this example uses a two-argument form of Init() that receives\nthe full module object as the second argument. This allows the Addon\nto completely overwrite exports with a single function instead of\nadding the function as a property of exports.
\n
To test it, run the following JavaScript:
\n
// test.js\nconst addon = require('./build/Release/addon');\n\naddon((msg) => {\n  console.log(msg); // 'hello world'\n});\n
\n
Note that, in this example, the callback function is invoked synchronously.
\n",
              "type": "module",
              "displayName": "Callbacks"
            },
            {
              "textRaw": "Object factory",
              "name": "object_factory",
              "desc": "
Addons can create and return new objects from within a C++ function as\nillustrated in the following example. An object is created and returned with a\nproperty msg that echoes the string passed to createObject():
\n
// addon.cc\n#include <node.h>\n\nnamespace demo {\n\nusing v8::FunctionCallbackInfo;\nusing v8::Isolate;\nusing v8::Local;\nusing v8::Object;\nusing v8::String;\nusing v8::Value;\n\nvoid CreateObject(const FunctionCallbackInfo<Value>& args) {\n  Isolate* isolate = args.GetIsolate();\n\n  Local<Object> obj = Object::New(isolate);\n  obj->Set(String::NewFromUtf8(isolate, "msg"), args[0]->ToString());\n\n  args.GetReturnValue().Set(obj);\n}\n\nvoid Init(Local<Object> exports, Local<Object> module) {\n  NODE_SET_METHOD(module, "exports", CreateObject);\n}\n\nNODE_MODULE(addon, Init)\n\n}  // namespace demo\n
\n
To test it in JavaScript:
\n
// test.js\nconst addon = require('./build/Release/addon');\n\nvar obj1 = addon('hello');\nvar obj2 = addon('world');\nconsole.log(obj1.msg, obj2.msg); // 'hello world'\n
\n",
              "type": "module",
              "displayName": "Object factory"
            },
            {
              "textRaw": "Function factory",
              "name": "function_factory",
              "desc": "
Another common scenario is creating JavaScript functions that wrap C++\nfunctions and returning those back to JavaScript:
\n
// addon.cc\n#include <node.h>\n\nnamespace demo {\n\nusing v8::Function;\nusing v8::FunctionCallbackInfo;\nusing v8::FunctionTemplate;\nusing v8::Isolate;\nusing v8::Local;\nusing v8::Object;\nusing v8::String;\nusing v8::Value;\n\nvoid MyFunction(const FunctionCallbackInfo<Value>& args) {\n  Isolate* isolate = args.GetIsolate();\n  args.GetReturnValue().Set(String::NewFromUtf8(isolate, "hello world"));\n}\n\nvoid CreateFunction(const FunctionCallbackInfo<Value>& args) {\n  Isolate* isolate = args.GetIsolate();\n\n  Local<FunctionTemplate> tpl = FunctionTemplate::New(isolate, MyFunction);\n  Local<Function> fn = tpl->GetFunction();\n\n  // omit this to make it anonymous\n  fn->SetName(String::NewFromUtf8(isolate, "theFunction"));\n\n  args.GetReturnValue().Set(fn);\n}\n\nvoid Init(Local<Object> exports, Local<Object> module) {\n  NODE_SET_METHOD(module, "exports", CreateFunction);\n}\n\nNODE_MODULE(addon, Init)\n\n}  // namespace demo\n
\n
To test:
\n
// test.js\nconst addon = require('./build/Release/addon');\n\nvar fn = addon();\nconsole.log(fn()); // 'hello world'\n
\n",
              "type": "module",
              "displayName": "Function factory"
            },
            {
              "textRaw": "Wrapping C++ objects",
              "name": "wrapping_c++_objects",
              "desc": "
It is also possible to wrap C++ objects/classes in a way that allows new\ninstances to be created using the JavaScript new operator:
\n
// addon.cc\n#include <node.h>\n#include "myobject.h"\n\nnamespace demo {\n\nusing v8::Local;\nusing v8::Object;\n\nvoid InitAll(Local<Object> exports) {\n  MyObject::Init(exports);\n}\n\nNODE_MODULE(addon, InitAll)\n\n}  // namespace demo\n
\n
Then, in myobject.h, the wrapper class inherits from node::ObjectWrap:
\n
// myobject.h\n#ifndef MYOBJECT_H\n#define MYOBJECT_H\n\n#include <node.h>\n#include <node_object_wrap.h>\n\nnamespace demo {\n\nclass MyObject : public node::ObjectWrap {\n public:\n  static void Init(v8::Local<v8::Object> exports);\n\n private:\n  explicit MyObject(double value = 0);\n  ~MyObject();\n\n  static void New(const v8::FunctionCallbackInfo<v8::Value>& args);\n  static void PlusOne(const v8::FunctionCallbackInfo<v8::Value>& args);\n  static v8::Persistent<v8::Function> constructor;\n  double value_;\n};\n\n}  // namespace demo\n\n#endif\n
\n
In myobject.cc, implement the various methods that are to be exposed.\nBelow, the method plusOne() is exposed by adding it to the constructor's\nprototype:
\n
// myobject.cc\n#include "myobject.h"\n\nnamespace demo {\n\nusing v8::Context;\nusing v8::Function;\nusing v8::FunctionCallbackInfo;\nusing v8::FunctionTemplate;\nusing v8::Isolate;\nusing v8::Local;\nusing v8::Number;\nusing v8::Object;\nusing v8::Persistent;\nusing v8::String;\nusing v8::Value;\n\nPersistent<Function> MyObject::constructor;\n\nMyObject::MyObject(double value) : value_(value) {\n}\n\nMyObject::~MyObject() {\n}\n\nvoid MyObject::Init(Local<Object> exports) {\n  Isolate* isolate = exports->GetIsolate();\n\n  // Prepare constructor template\n  Local<FunctionTemplate> tpl = FunctionTemplate::New(isolate, New);\n  tpl->SetClassName(String::NewFromUtf8(isolate, "MyObject"));\n  tpl->InstanceTemplate()->SetInternalFieldCount(1);\n\n  // Prototype\n  NODE_SET_PROTOTYPE_METHOD(tpl, "plusOne", PlusOne);\n\n  constructor.Reset(isolate, tpl->GetFunction());\n  exports->Set(String::NewFromUtf8(isolate, "MyObject"),\n               tpl->GetFunction());\n}\n\nvoid MyObject::New(const FunctionCallbackInfo<Value>& args) {\n  Isolate* isolate = args.GetIsolate();\n\n  if (args.IsConstructCall()) {\n    // Invoked as constructor: `new MyObject(...)`\n    double value = args[0]->IsUndefined() ? 0 : args[0]->NumberValue();\n    MyObject* obj = new MyObject(value);\n    obj->Wrap(args.This());\n    args.GetReturnValue().Set(args.This());\n  } else {\n    // Invoked as plain function `MyObject(...)`, turn into construct call.\n    const int argc = 1;\n    Local<Value> argv[argc] = { args[0] };\n    Local<Context> context = isolate->GetCurrentContext();\n    Local<Function> cons = Local<Function>::New(isolate, constructor);\n    Local<Object> result =\n        cons->NewInstance(context, argc, argv).ToLocalChecked();\n    args.GetReturnValue().Set(result);\n  }\n}\n\nvoid MyObject::PlusOne(const FunctionCallbackInfo<Value>& args) {\n  Isolate* isolate = args.GetIsolate();\n\n  MyObject* obj = ObjectWrap::Unwrap<MyObject>(args.Holder());\n  obj->value_ += 1;\n\n  args.GetReturnValue().Set(Number::New(isolate, obj->value_));\n}\n\n}  // namespace demo\n
\n
To build this example, the myobject.cc file must be added to the\nbinding.gyp:
\n
{\n  "targets": [\n    {\n      "target_name": "addon",\n      "sources": [\n        "addon.cc",\n        "myobject.cc"\n      ]\n    }\n  ]\n}\n
Test it with:
\n
// test.js\nconst addon = require('./build/Release/addon');\n\nvar obj = new addon.MyObject(10);\nconsole.log(obj.plusOne()); // 11\nconsole.log(obj.plusOne()); // 12\nconsole.log(obj.plusOne()); // 13\n
\n",
              "type": "module",
              "displayName": "Wrapping C++ objects"
            },
            {
              "textRaw": "Factory of wrapped objects",
              "name": "factory_of_wrapped_objects",
              "desc": "
Alternatively, it is possible to use a factory pattern to avoid explicitly\ncreating object instances using the JavaScript new operator:
\n
var obj = addon.createObject();\n// instead of:\n// var obj = new addon.Object();\n
\n
First, the createObject() method is implemented in addon.cc:
\n
// addon.cc\n#include <node.h>\n#include "myobject.h"\n\nnamespace demo {\n\nusing v8::FunctionCallbackInfo;\nusing v8::Isolate;\nusing v8::Local;\nusing v8::Object;\nusing v8::String;\nusing v8::Value;\n\nvoid CreateObject(const FunctionCallbackInfo<Value>& args) {\n  MyObject::NewInstance(args);\n}\n\nvoid InitAll(Local<Object> exports, Local<Object> module) {\n  MyObject::Init(exports->GetIsolate());\n\n  NODE_SET_METHOD(module, "exports", CreateObject);\n}\n\nNODE_MODULE(addon, InitAll)\n\n}  // namespace demo\n
\n
In myobject.h, the static method NewInstance() is added to handle\ninstantiating the object. This method takes the place of using new in\nJavaScript:
\n
// myobject.h\n#ifndef MYOBJECT_H\n#define MYOBJECT_H\n\n#include <node.h>\n#include <node_object_wrap.h>\n\nnamespace demo {\n\nclass MyObject : public node::ObjectWrap {\n public:\n  static void Init(v8::Isolate* isolate);\n  static void NewInstance(const v8::FunctionCallbackInfo<v8::Value>& args);\n\n private:\n  explicit MyObject(double value = 0);\n  ~MyObject();\n\n  static void New(const v8::FunctionCallbackInfo<v8::Value>& args);\n  static void PlusOne(const v8::FunctionCallbackInfo<v8::Value>& args);\n  static v8::Persistent<v8::Function> constructor;\n  double value_;\n};\n\n}  // namespace demo\n\n#endif\n
\n
The implementation in myobject.cc is similar to the previous example:
\n
// myobject.cc\n#include <node.h>\n#include "myobject.h"\n\nnamespace demo {\n\nusing v8::Context;\nusing v8::Function;\nusing v8::FunctionCallbackInfo;\nusing v8::FunctionTemplate;\nusing v8::Isolate;\nusing v8::Local;\nusing v8::Number;\nusing v8::Object;\nusing v8::Persistent;\nusing v8::String;\nusing v8::Value;\n\nPersistent<Function> MyObject::constructor;\n\nMyObject::MyObject(double value) : value_(value) {\n}\n\nMyObject::~MyObject() {\n}\n\nvoid MyObject::Init(Isolate* isolate) {\n  // Prepare constructor template\n  Local<FunctionTemplate> tpl = FunctionTemplate::New(isolate, New);\n  tpl->SetClassName(String::NewFromUtf8(isolate, "MyObject"));\n  tpl->InstanceTemplate()->SetInternalFieldCount(1);\n\n  // Prototype\n  NODE_SET_PROTOTYPE_METHOD(tpl, "plusOne", PlusOne);\n\n  constructor.Reset(isolate, tpl->GetFunction());\n}\n\nvoid MyObject::New(const FunctionCallbackInfo<Value>& args) {\n  Isolate* isolate = args.GetIsolate();\n\n  if (args.IsConstructCall()) {\n    // Invoked as constructor: `new MyObject(...)`\n    double value = args[0]->IsUndefined() ? 0 : args[0]->NumberValue();\n    MyObject* obj = new MyObject(value);\n    obj->Wrap(args.This());\n    args.GetReturnValue().Set(args.This());\n  } else {\n    // Invoked as plain function `MyObject(...)`, turn into construct call.\n    const int argc = 1;\n    Local<Value> argv[argc] = { args[0] };\n    Local<Function> cons = Local<Function>::New(isolate, constructor);\n    Local<Context> context = isolate->GetCurrentContext();\n    Local<Object> instance =\n        cons->NewInstance(context, argc, argv).ToLocalChecked();\n    args.GetReturnValue().Set(instance);\n  }\n}\n\nvoid MyObject::NewInstance(const FunctionCallbackInfo<Value>& args) {\n  Isolate* isolate = args.GetIsolate();\n\n  const unsigned argc = 1;\n  Local<Value> argv[argc] = { args[0] };\n  Local<Function> cons = Local<Function>::New(isolate, constructor);\n  Local<Context> context = isolate->GetCurrentContext();\n  Local<Object> instance =\n      cons->NewInstance(context, argc, argv).ToLocalChecked();\n\n  args.GetReturnValue().Set(instance);\n}\n\nvoid MyObject::PlusOne(const FunctionCallbackInfo<Value>& args) {\n  Isolate* isolate = args.GetIsolate();\n\n  MyObject* obj = ObjectWrap::Unwrap<MyObject>(args.Holder());\n  obj->value_ += 1;\n\n  args.GetReturnValue().Set(Number::New(isolate, obj->value_));\n}\n\n}  // namespace demo\n
\n
Once again, to build this example, the myobject.cc file must be added to the\nbinding.gyp:
\n
{\n  "targets": [\n    {\n      "target_name": "addon",\n      "sources": [\n        "addon.cc",\n        "myobject.cc"\n      ]\n    }\n  ]\n}\n
Test it with:
\n
// test.js\nconst createObject = require('./build/Release/addon');\n\nvar obj = createObject(10);\nconsole.log(obj.plusOne()); // 11\nconsole.log(obj.plusOne()); // 12\nconsole.log(obj.plusOne()); // 13\n\nvar obj2 = createObject(20);\nconsole.log(obj2.plusOne()); // 21\nconsole.log(obj2.plusOne()); // 22\nconsole.log(obj2.plusOne()); // 23\n
\n",
              "type": "module",
              "displayName": "Factory of wrapped objects"
            },
            {
              "textRaw": "Passing wrapped objects around",
              "name": "passing_wrapped_objects_around",
              "desc": "
In addition to wrapping and returning C++ objects, it is possible to pass\nwrapped objects around by unwrapping them with the Node.js helper function\nnode::ObjectWrap::Unwrap. The following examples shows a function add()\nthat can take two MyObject objects as input arguments:
\n
// addon.cc\n#include <node.h>\n#include <node_object_wrap.h>\n#include "myobject.h"\n\nnamespace demo {\n\nusing v8::FunctionCallbackInfo;\nusing v8::Isolate;\nusing v8::Local;\nusing v8::Number;\nusing v8::Object;\nusing v8::String;\nusing v8::Value;\n\nvoid CreateObject(const FunctionCallbackInfo<Value>& args) {\n  MyObject::NewInstance(args);\n}\n\nvoid Add(const FunctionCallbackInfo<Value>& args) {\n  Isolate* isolate = args.GetIsolate();\n\n  MyObject* obj1 = node::ObjectWrap::Unwrap<MyObject>(\n      args[0]->ToObject());\n  MyObject* obj2 = node::ObjectWrap::Unwrap<MyObject>(\n      args[1]->ToObject());\n\n  double sum = obj1->value() + obj2->value();\n  args.GetReturnValue().Set(Number::New(isolate, sum));\n}\n\nvoid InitAll(Local<Object> exports) {\n  MyObject::Init(exports->GetIsolate());\n\n  NODE_SET_METHOD(exports, "createObject", CreateObject);\n  NODE_SET_METHOD(exports, "add", Add);\n}\n\nNODE_MODULE(addon, InitAll)\n\n}  // namespace demo\n
\n
In myobject.h, a new public method is added to allow access to private values\nafter unwrapping the object.
\n
// myobject.h\n#ifndef MYOBJECT_H\n#define MYOBJECT_H\n\n#include <node.h>\n#include <node_object_wrap.h>\n\nnamespace demo {\n\nclass MyObject : public node::ObjectWrap {\n public:\n  static void Init(v8::Isolate* isolate);\n  static void NewInstance(const v8::FunctionCallbackInfo<v8::Value>& args);\n  inline double value() const { return value_; }\n\n private:\n  explicit MyObject(double value = 0);\n  ~MyObject();\n\n  static void New(const v8::FunctionCallbackInfo<v8::Value>& args);\n  static v8::Persistent<v8::Function> constructor;\n  double value_;\n};\n\n}  // namespace demo\n\n#endif\n
\n
The implementation of myobject.cc is similar to before:
\n
// myobject.cc\n#include <node.h>\n#include "myobject.h"\n\nnamespace demo {\n\nusing v8::Context;\nusing v8::Function;\nusing v8::FunctionCallbackInfo;\nusing v8::FunctionTemplate;\nusing v8::Isolate;\nusing v8::Local;\nusing v8::Object;\nusing v8::Persistent;\nusing v8::String;\nusing v8::Value;\n\nPersistent<Function> MyObject::constructor;\n\nMyObject::MyObject(double value) : value_(value) {\n}\n\nMyObject::~MyObject() {\n}\n\nvoid MyObject::Init(Isolate* isolate) {\n  // Prepare constructor template\n  Local<FunctionTemplate> tpl = FunctionTemplate::New(isolate, New);\n  tpl->SetClassName(String::NewFromUtf8(isolate, "MyObject"));\n  tpl->InstanceTemplate()->SetInternalFieldCount(1);\n\n  constructor.Reset(isolate, tpl->GetFunction());\n}\n\nvoid MyObject::New(const FunctionCallbackInfo<Value>& args) {\n  Isolate* isolate = args.GetIsolate();\n\n  if (args.IsConstructCall()) {\n    // Invoked as constructor: `new MyObject(...)`\n    double value = args[0]->IsUndefined() ? 0 : args[0]->NumberValue();\n    MyObject* obj = new MyObject(value);\n    obj->Wrap(args.This());\n    args.GetReturnValue().Set(args.This());\n  } else {\n    // Invoked as plain function `MyObject(...)`, turn into construct call.\n    const int argc = 1;\n    Local<Value> argv[argc] = { args[0] };\n    Local<Context> context = isolate->GetCurrentContext();\n    Local<Function> cons = Local<Function>::New(isolate, constructor);\n    Local<Object> instance =\n        cons->NewInstance(context, argc, argv).ToLocalChecked();\n    args.GetReturnValue().Set(instance);\n  }\n}\n\nvoid MyObject::NewInstance(const FunctionCallbackInfo<Value>& args) {\n  Isolate* isolate = args.GetIsolate();\n\n  const unsigned argc = 1;\n  Local<Value> argv[argc] = { args[0] };\n  Local<Function> cons = Local<Function>::New(isolate, constructor);\n  Local<Context> context = isolate->GetCurrentContext();\n  Local<Object> instance =\n      cons->NewInstance(context, argc, argv).ToLocalChecked();\n\n  args.GetReturnValue().Set(instance);\n}\n\n}  // namespace demo\n
\n
Test it with:
\n
// test.js\nconst addon = require('./build/Release/addon');\n\nvar obj1 = addon.createObject(10);\nvar obj2 = addon.createObject(20);\nvar result = addon.add(obj1, obj2);\n\nconsole.log(result); // 30\n
\n",
              "type": "module",
              "displayName": "Passing wrapped objects around"
            },
            {
              "textRaw": "AtExit hooks",
              "name": "atexit_hooks",
              "desc": "
An "AtExit" hook is a function that is invoked after the Node.js event loop\nhas ended but before the JavaScript VM is terminated and Node.js shuts down.\n"AtExit" hooks are registered using the node::AtExit API.
\n",
              "modules": [
                {
                  "textRaw": "void AtExit(callback, args)",
                  "name": "void_atexit(callback,_args)",
                  "desc": "
    \n
  • callback: void (*)(void*) - A pointer to the function to call at exit.
    • \n
  • args: void* - A pointer to pass to the callback at exit.
    • \n
\n
Registers exit hooks that run after the event loop has ended but before the VM\nis killed.
\n
AtExit takes two parameters: a pointer to a callback function to run at exit,\nand a pointer to untyped context data to be passed to that callback.
\n
Callbacks are run in last-in first-out order.
\n
The following addon.cc implements AtExit:
\n
// addon.cc\n#undef NDEBUG\n#include <assert.h>\n#include <stdlib.h>\n#include <node.h>\n\nnamespace demo {\n\nusing node::AtExit;\nusing v8::HandleScope;\nusing v8::Isolate;\nusing v8::Local;\nusing v8::Object;\n\nstatic char cookie[] = "yum yum";\nstatic int at_exit_cb1_called = 0;\nstatic int at_exit_cb2_called = 0;\n\nstatic void at_exit_cb1(void* arg) {\n  Isolate* isolate = static_cast<Isolate*>(arg);\n  HandleScope scope(isolate);\n  Local<Object> obj = Object::New(isolate);\n  assert(!obj.IsEmpty()); // assert VM is still alive\n  assert(obj->IsObject());\n  at_exit_cb1_called++;\n}\n\nstatic void at_exit_cb2(void* arg) {\n  assert(arg == static_cast<void*>(cookie));\n  at_exit_cb2_called++;\n}\n\nstatic void sanity_check(void*) {\n  assert(at_exit_cb1_called == 1);\n  assert(at_exit_cb2_called == 2);\n}\n\nvoid init(Local<Object> exports) {\n  AtExit(sanity_check);\n  AtExit(at_exit_cb2, cookie);\n  AtExit(at_exit_cb2, cookie);\n  AtExit(at_exit_cb1, exports->GetIsolate());\n}\n\nNODE_MODULE(addon, init);\n\n}  // namespace demo\n
\n
Test in JavaScript by running:
\n
// test.js\nconst addon = require('./build/Release/addon');\n
\n",
                  "type": "module",
                  "displayName": "void AtExit(callback, args)"
                }
              ],
              "type": "module",
              "displayName": "AtExit hooks"
            }
          ],
          "type": "module",
          "displayName": "Addon examples"
        }
      ],
      "properties": [
        {
          "textRaw": "Native Abstractions for Node.js",
          "name": "js",
          "desc": "
Each of the examples illustrated in this document make direct use of the\nNode.js and V8 APIs for implementing Addons. It is important to understand\nthat the V8 API can, and has, changed dramatically from one V8 release to the\nnext (and one major Node.js release to the next). With each change, Addons may\nneed to be updated and recompiled in order to continue functioning. The Node.js\nrelease schedule is designed to minimize the frequency and impact of such\nchanges but there is little that Node.js can do currently to ensure stability\nof the V8 APIs.
\n
The Native Abstractions for Node.js (or nan) provide a set of tools that\nAddon developers are recommended to use to keep compatibility between past and\nfuture releases of V8 and Node.js. See the nan examples for an\nillustration of how it can be used.
\n"
        }
      ],
      "type": "module",
      "displayName": "C/C++ Addons"
    }
  ]
}
node-v4.8.2/doc/api/addons.md000644 000766 000024 00000072136 13070706735 016101 0ustar00iojsstaff000000 000000 # C/C++ Addons

Node.js Addons are dynamically-linked shared objects, written in C or C++, that
can be loaded into Node.js using the [`require()`][require] function, and used
just as if they were an ordinary Node.js module. They are used primarily to
provide an interface between JavaScript running in Node.js and C/C++ libraries.

At the moment, the method for implementing Addons is rather complicated,
involving knowledge of several components and APIs :

 - V8: the C++ library Node.js currently uses to provide the
   JavaScript implementation. V8 provides the mechanisms for creating objects,
   calling functions, etc. V8's API is documented mostly in the
   `v8.h` header file (`deps/v8/include/v8.h` in the Node.js source
   tree), which is also available [online][v8-docs].

 - [libuv][]: The C library that implements the Node.js event loop, its worker
   threads and all of the asynchronous behaviors of the platform. It also
   serves as a cross-platform abstraction library, giving easy, POSIX-like
   access across all major operating systems to many common system tasks, such
   as interacting with the filesystem, sockets, timers and system events. libuv
   also provides a pthreads-like threading abstraction that may be used to
   power more sophisticated asynchronous Addons that need to move beyond the
   standard event loop. Addon authors are encouraged to think about how to
   avoid blocking the event loop with I/O or other time-intensive tasks by
   off-loading work via libuv to non-blocking system operations, worker threads
   or a custom use of libuv's threads.

 - Internal Node.js libraries. Node.js itself exports a number of C/C++ APIs
   that Addons can use — the most important of which is the
   `node::ObjectWrap` class.

 - Node.js includes a number of other statically linked libraries including
   OpenSSL. These other libraries are located in the `deps/` directory in the
   Node.js source tree. Only the V8 and OpenSSL symbols are purposefully
   re-exported by Node.js and may be used to various extents by Addons.
   See [Linking to Node.js' own dependencies][] for additional information.

All of the following examples are available for [download][] and may
be used as a starting-point for your own Addon.

## Hello world

This "Hello world" example is a simple Addon, written in C++, that is the
equivalent of the following JavaScript code:

```js
module.exports.hello = () => 'world';
```

First, create the file `hello.cc`:

```cpp
// hello.cc
#include 

namespace demo {

using v8::FunctionCallbackInfo;
using v8::Isolate;
using v8::Local;
using v8::Object;
using v8::String;
using v8::Value;

void Method(const FunctionCallbackInfo& args) {
  Isolate* isolate = args.GetIsolate();
  args.GetReturnValue().Set(String::NewFromUtf8(isolate, "world"));
}

void init(Local exports) {
  NODE_SET_METHOD(exports, "hello", Method);
}

NODE_MODULE(addon, init)

}  // namespace demo
```

Note that all Node.js Addons must export an initialization function following
the pattern:

```cpp
void Initialize(Local exports);
NODE_MODULE(module_name, Initialize)
```

There is no semi-colon after `NODE_MODULE` as it's not a function (see
`node.h`).

The `module_name` must match the filename of the final binary (excluding
the .node suffix).

In the `hello.cc` example, then, the initialization function is `init` and the
Addon module name is `addon`.

### Building

Once the source code has been written, it must be compiled into the binary
`addon.node` file. To do so, create a file called `binding.gyp` in the
top-level of the project describing the build configuration of your module
using a JSON-like format. This file is used by [node-gyp][] -- a tool written
specifically to compile Node.js Addons.

```
{
  "targets": [
    {
      "target_name": "addon",
      "sources": [ "hello.cc" ]
    }
  ]
}
```

*Note: A version of the `node-gyp` utility is bundled and distributed with
Node.js as part of `npm`. This version is not made directly available for
developers to use and is intended only to support the ability to use the
`npm install` command to compile and install Addons. Developers who wish to
use `node-gyp` directly can install it using the command
`npm install -g node-gyp`. See the `node-gyp` [installation instructions][] for
more information, including platform-specific requirements.*

Once the `binding.gyp` file has been created, use `node-gyp configure` to
generate the appropriate project build files for the current platform. This
will generate either a `Makefile` (on Unix platforms) or a `vcxproj` file
(on Windows) in the `build/` directory.

Next, invoke the `node-gyp build` command to generate the compiled `addon.node`
file. This will be put into the `build/Release/` directory.

When using `npm install` to install a Node.js Addon, npm uses its own bundled
version of `node-gyp` to perform this same set of actions, generating a
compiled version of the Addon for the user's platform on demand.

Once built, the binary Addon can be used from within Node.js by pointing
[`require()`][require] to the built `addon.node` module:

```js
// hello.js
const addon = require('./build/Release/addon');

console.log(addon.hello()); // 'world'
```

Please see the examples below for further information or
 for an example in production.

Because the exact path to the compiled Addon binary can vary depending on how
it is compiled (i.e. sometimes it may be in `./build/Debug/`), Addons can use
the [bindings][] package to load the compiled module.

Note that while the `bindings` package implementation is more sophisticated
in how it locates Addon modules, it is essentially using a try-catch pattern
similar to:

```js
try {
  return require('./build/Release/addon.node');
} catch (err) {
  return require('./build/Debug/addon.node');
}
```

### Linking to Node.js' own dependencies

Node.js uses a number of statically linked libraries such as V8, libuv and
OpenSSL. All Addons are required to link to V8 and may link to any of the
other dependencies as well. Typically, this is as simple as including
the appropriate `#include <...>` statements (e.g. `#include `) and
`node-gyp` will locate the appropriate headers automatically. However, there
are a few caveats to be aware of:

* When `node-gyp` runs, it will detect the specific release version of Node.js
and download either the full source tarball or just the headers. If the full
source is downloaded, Addons will have complete access to the full set of
Node.js dependencies. However, if only the Node.js headers are downloaded, then
only the symbols exported by Node.js will be available.

* `node-gyp` can be run using the `--nodedir` flag pointing at a local Node.js
source image. Using this option, the Addon will have access to the full set of
dependencies.

### Loading Addons using require()

The filename extension of the compiled Addon binary is `.node` (as opposed
to `.dll` or `.so`). The [`require()`][require] function is written to look for
files with the `.node` file extension and initialize those as dynamically-linked
libraries.

When calling [`require()`][require], the `.node` extension can usually be
omitted and Node.js will still find and initialize the Addon. One caveat,
however, is that Node.js will first attempt to locate and load modules or
JavaScript files that happen to share the same base name. For instance, if
there is a file `addon.js` in the same directory as the binary `addon.node`,
then [`require('addon')`][require] will give precedence to the `addon.js` file
and load it instead.

## Native Abstractions for Node.js

Each of the examples illustrated in this document make direct use of the
Node.js and V8 APIs for implementing Addons. It is important to understand
that the V8 API can, and has, changed dramatically from one V8 release to the
next (and one major Node.js release to the next). With each change, Addons may
need to be updated and recompiled in order to continue functioning. The Node.js
release schedule is designed to minimize the frequency and impact of such
changes but there is little that Node.js can do currently to ensure stability
of the V8 APIs.

The [Native Abstractions for Node.js][] (or `nan`) provide a set of tools that
Addon developers are recommended to use to keep compatibility between past and
future releases of V8 and Node.js. See the `nan` [examples][] for an
illustration of how it can be used.

## Addon examples

Following are some example Addons intended to help developers get started. The
examples make use of the V8 APIs. Refer to the online [V8 reference][v8-docs]
for help with the various V8 calls, and V8's [Embedder's Guide][] for an
explanation of several concepts used such as handles, scopes, function
templates, etc.

Each of these examples using the following `binding.gyp` file:

```
{
  "targets": [
    {
      "target_name": "addon",
      "sources": [ "addon.cc" ]
    }
  ]
}
```

In cases where there is more than one `.cc` file, simply add the additional
filename to the `sources` array. For example:

```
"sources": ["addon.cc", "myexample.cc"]
```

Once the `binding.gyp` file is ready, the example Addons can be configured and
built using `node-gyp`:

```
$ node-gyp configure build
```


### Function arguments

Addons will typically expose objects and functions that can be accessed from
JavaScript running within Node.js. When functions are invoked from JavaScript,
the input arguments and return value must be mapped to and from the C/C++
code.

The following example illustrates how to read function arguments passed from
JavaScript and how to return a result:

```cpp
// addon.cc
#include 

namespace demo {

using v8::Exception;
using v8::FunctionCallbackInfo;
using v8::Isolate;
using v8::Local;
using v8::Number;
using v8::Object;
using v8::String;
using v8::Value;

// This is the implementation of the "add" method
// Input arguments are passed using the
// const FunctionCallbackInfo& args struct
void Add(const FunctionCallbackInfo& args) {
  Isolate* isolate = args.GetIsolate();

  // Check the number of arguments passed.
  if (args.Length() < 2) {
    // Throw an Error that is passed back to JavaScript
    isolate->ThrowException(Exception::TypeError(
        String::NewFromUtf8(isolate, "Wrong number of arguments")));
    return;
  }

  // Check the argument types
  if (!args[0]->IsNumber() || !args[1]->IsNumber()) {
    isolate->ThrowException(Exception::TypeError(
        String::NewFromUtf8(isolate, "Wrong arguments")));
    return;
  }

  // Perform the operation
  double value = args[0]->NumberValue() + args[1]->NumberValue();
  Local num = Number::New(isolate, value);

  // Set the return value (using the passed in
  // FunctionCallbackInfo&)
  args.GetReturnValue().Set(num);
}

void Init(Local exports) {
  NODE_SET_METHOD(exports, "add", Add);
}

NODE_MODULE(addon, Init)

}  // namespace demo
```

Once compiled, the example Addon can be required and used from within Node.js:

```js
// test.js
const addon = require('./build/Release/addon');

console.log('This should be eight:', addon.add(3, 5));
```


### Callbacks

It is common practice within Addons to pass JavaScript functions to a C++
function and execute them from there. The following example illustrates how
to invoke such callbacks:

```cpp
// addon.cc
#include 

namespace demo {

using v8::Function;
using v8::FunctionCallbackInfo;
using v8::Isolate;
using v8::Local;
using v8::Null;
using v8::Object;
using v8::String;
using v8::Value;

void RunCallback(const FunctionCallbackInfo& args) {
  Isolate* isolate = args.GetIsolate();
  Local cb = Local::Cast(args[0]);
  const unsigned argc = 1;
  Local argv[argc] = { String::NewFromUtf8(isolate, "hello world") };
  cb->Call(Null(isolate), argc, argv);
}

void Init(Local exports, Local module) {
  NODE_SET_METHOD(module, "exports", RunCallback);
}

NODE_MODULE(addon, Init)

}  // namespace demo
```

Note that this example uses a two-argument form of `Init()` that receives
the full `module` object as the second argument. This allows the Addon
to completely overwrite `exports` with a single function instead of
adding the function as a property of `exports`.

To test it, run the following JavaScript:

```js
// test.js
const addon = require('./build/Release/addon');

addon((msg) => {
  console.log(msg); // 'hello world'
});
```

Note that, in this example, the callback function is invoked synchronously.

### Object factory

Addons can create and return new objects from within a C++ function as
illustrated in the following example. An object is created and returned with a
property `msg` that echoes the string passed to `createObject()`:

```cpp
// addon.cc
#include 

namespace demo {

using v8::FunctionCallbackInfo;
using v8::Isolate;
using v8::Local;
using v8::Object;
using v8::String;
using v8::Value;

void CreateObject(const FunctionCallbackInfo& args) {
  Isolate* isolate = args.GetIsolate();

  Local obj = Object::New(isolate);
  obj->Set(String::NewFromUtf8(isolate, "msg"), args[0]->ToString());

  args.GetReturnValue().Set(obj);
}

void Init(Local exports, Local module) {
  NODE_SET_METHOD(module, "exports", CreateObject);
}

NODE_MODULE(addon, Init)

}  // namespace demo
```

To test it in JavaScript:

```js
// test.js
const addon = require('./build/Release/addon');

var obj1 = addon('hello');
var obj2 = addon('world');
console.log(obj1.msg, obj2.msg); // 'hello world'
```


### Function factory

Another common scenario is creating JavaScript functions that wrap C++
functions and returning those back to JavaScript:

```cpp
// addon.cc
#include 

namespace demo {

using v8::Function;
using v8::FunctionCallbackInfo;
using v8::FunctionTemplate;
using v8::Isolate;
using v8::Local;
using v8::Object;
using v8::String;
using v8::Value;

void MyFunction(const FunctionCallbackInfo& args) {
  Isolate* isolate = args.GetIsolate();
  args.GetReturnValue().Set(String::NewFromUtf8(isolate, "hello world"));
}

void CreateFunction(const FunctionCallbackInfo& args) {
  Isolate* isolate = args.GetIsolate();

  Local tpl = FunctionTemplate::New(isolate, MyFunction);
  Local fn = tpl->GetFunction();

  // omit this to make it anonymous
  fn->SetName(String::NewFromUtf8(isolate, "theFunction"));

  args.GetReturnValue().Set(fn);
}

void Init(Local exports, Local module) {
  NODE_SET_METHOD(module, "exports", CreateFunction);
}

NODE_MODULE(addon, Init)

}  // namespace demo
```

To test:

```js
// test.js
const addon = require('./build/Release/addon');

var fn = addon();
console.log(fn()); // 'hello world'
```


### Wrapping C++ objects

It is also possible to wrap C++ objects/classes in a way that allows new
instances to be created using the JavaScript `new` operator:

```cpp
// addon.cc
#include 
#include "myobject.h"

namespace demo {

using v8::Local;
using v8::Object;

void InitAll(Local exports) {
  MyObject::Init(exports);
}

NODE_MODULE(addon, InitAll)

}  // namespace demo
```

Then, in `myobject.h`, the wrapper class inherits from `node::ObjectWrap`:

```cpp
// myobject.h
#ifndef MYOBJECT_H
#define MYOBJECT_H

#include 
#include 

namespace demo {

class MyObject : public node::ObjectWrap {
 public:
  static void Init(v8::Local exports);

 private:
  explicit MyObject(double value = 0);
  ~MyObject();

  static void New(const v8::FunctionCallbackInfo& args);
  static void PlusOne(const v8::FunctionCallbackInfo& args);
  static v8::Persistent constructor;
  double value_;
};

}  // namespace demo

#endif
```

In `myobject.cc`, implement the various methods that are to be exposed.
Below, the method `plusOne()` is exposed by adding it to the constructor's
prototype:

```cpp
// myobject.cc
#include "myobject.h"

namespace demo {

using v8::Context;
using v8::Function;
using v8::FunctionCallbackInfo;
using v8::FunctionTemplate;
using v8::Isolate;
using v8::Local;
using v8::Number;
using v8::Object;
using v8::Persistent;
using v8::String;
using v8::Value;

Persistent MyObject::constructor;

MyObject::MyObject(double value) : value_(value) {
}

MyObject::~MyObject() {
}

void MyObject::Init(Local exports) {
  Isolate* isolate = exports->GetIsolate();

  // Prepare constructor template
  Local tpl = FunctionTemplate::New(isolate, New);
  tpl->SetClassName(String::NewFromUtf8(isolate, "MyObject"));
  tpl->InstanceTemplate()->SetInternalFieldCount(1);

  // Prototype
  NODE_SET_PROTOTYPE_METHOD(tpl, "plusOne", PlusOne);

  constructor.Reset(isolate, tpl->GetFunction());
  exports->Set(String::NewFromUtf8(isolate, "MyObject"),
               tpl->GetFunction());
}

void MyObject::New(const FunctionCallbackInfo& args) {
  Isolate* isolate = args.GetIsolate();

  if (args.IsConstructCall()) {
    // Invoked as constructor: `new MyObject(...)`
    double value = args[0]->IsUndefined() ? 0 : args[0]->NumberValue();
    MyObject* obj = new MyObject(value);
    obj->Wrap(args.This());
    args.GetReturnValue().Set(args.This());
  } else {
    // Invoked as plain function `MyObject(...)`, turn into construct call.
    const int argc = 1;
    Local argv[argc] = { args[0] };
    Local context = isolate->GetCurrentContext();
    Local cons = Local::New(isolate, constructor);
    Local result =
        cons->NewInstance(context, argc, argv).ToLocalChecked();
    args.GetReturnValue().Set(result);
  }
}

void MyObject::PlusOne(const FunctionCallbackInfo& args) {
  Isolate* isolate = args.GetIsolate();

  MyObject* obj = ObjectWrap::Unwrap(args.Holder());
  obj->value_ += 1;

  args.GetReturnValue().Set(Number::New(isolate, obj->value_));
}

}  // namespace demo
```

To build this example, the `myobject.cc` file must be added to the
`binding.gyp`:

```
{
  "targets": [
    {
      "target_name": "addon",
      "sources": [
        "addon.cc",
        "myobject.cc"
      ]
    }
  ]
}
```

Test it with:

```js
// test.js
const addon = require('./build/Release/addon');

var obj = new addon.MyObject(10);
console.log(obj.plusOne()); // 11
console.log(obj.plusOne()); // 12
console.log(obj.plusOne()); // 13
```

### Factory of wrapped objects

Alternatively, it is possible to use a factory pattern to avoid explicitly
creating object instances using the JavaScript `new` operator:

```js
var obj = addon.createObject();
// instead of:
// var obj = new addon.Object();
```

First, the `createObject()` method is implemented in `addon.cc`:

```cpp
// addon.cc
#include 
#include "myobject.h"

namespace demo {

using v8::FunctionCallbackInfo;
using v8::Isolate;
using v8::Local;
using v8::Object;
using v8::String;
using v8::Value;

void CreateObject(const FunctionCallbackInfo& args) {
  MyObject::NewInstance(args);
}

void InitAll(Local exports, Local module) {
  MyObject::Init(exports->GetIsolate());

  NODE_SET_METHOD(module, "exports", CreateObject);
}

NODE_MODULE(addon, InitAll)

}  // namespace demo
```

In `myobject.h`, the static method `NewInstance()` is added to handle
instantiating the object. This method takes the place of using `new` in
JavaScript:

```cpp
// myobject.h
#ifndef MYOBJECT_H
#define MYOBJECT_H

#include 
#include 

namespace demo {

class MyObject : public node::ObjectWrap {
 public:
  static void Init(v8::Isolate* isolate);
  static void NewInstance(const v8::FunctionCallbackInfo& args);

 private:
  explicit MyObject(double value = 0);
  ~MyObject();

  static void New(const v8::FunctionCallbackInfo& args);
  static void PlusOne(const v8::FunctionCallbackInfo& args);
  static v8::Persistent constructor;
  double value_;
};

}  // namespace demo

#endif
```

The implementation in `myobject.cc` is similar to the previous example:

```cpp
// myobject.cc
#include 
#include "myobject.h"

namespace demo {

using v8::Context;
using v8::Function;
using v8::FunctionCallbackInfo;
using v8::FunctionTemplate;
using v8::Isolate;
using v8::Local;
using v8::Number;
using v8::Object;
using v8::Persistent;
using v8::String;
using v8::Value;

Persistent MyObject::constructor;

MyObject::MyObject(double value) : value_(value) {
}

MyObject::~MyObject() {
}

void MyObject::Init(Isolate* isolate) {
  // Prepare constructor template
  Local tpl = FunctionTemplate::New(isolate, New);
  tpl->SetClassName(String::NewFromUtf8(isolate, "MyObject"));
  tpl->InstanceTemplate()->SetInternalFieldCount(1);

  // Prototype
  NODE_SET_PROTOTYPE_METHOD(tpl, "plusOne", PlusOne);

  constructor.Reset(isolate, tpl->GetFunction());
}

void MyObject::New(const FunctionCallbackInfo& args) {
  Isolate* isolate = args.GetIsolate();

  if (args.IsConstructCall()) {
    // Invoked as constructor: `new MyObject(...)`
    double value = args[0]->IsUndefined() ? 0 : args[0]->NumberValue();
    MyObject* obj = new MyObject(value);
    obj->Wrap(args.This());
    args.GetReturnValue().Set(args.This());
  } else {
    // Invoked as plain function `MyObject(...)`, turn into construct call.
    const int argc = 1;
    Local argv[argc] = { args[0] };
    Local cons = Local::New(isolate, constructor);
    Local context = isolate->GetCurrentContext();
    Local instance =
        cons->NewInstance(context, argc, argv).ToLocalChecked();
    args.GetReturnValue().Set(instance);
  }
}

void MyObject::NewInstance(const FunctionCallbackInfo& args) {
  Isolate* isolate = args.GetIsolate();

  const unsigned argc = 1;
  Local argv[argc] = { args[0] };
  Local cons = Local::New(isolate, constructor);
  Local context = isolate->GetCurrentContext();
  Local instance =
      cons->NewInstance(context, argc, argv).ToLocalChecked();

  args.GetReturnValue().Set(instance);
}

void MyObject::PlusOne(const FunctionCallbackInfo& args) {
  Isolate* isolate = args.GetIsolate();

  MyObject* obj = ObjectWrap::Unwrap(args.Holder());
  obj->value_ += 1;

  args.GetReturnValue().Set(Number::New(isolate, obj->value_));
}

}  // namespace demo
```

Once again, to build this example, the `myobject.cc` file must be added to the
`binding.gyp`:

```
{
  "targets": [
    {
      "target_name": "addon",
      "sources": [
        "addon.cc",
        "myobject.cc"
      ]
    }
  ]
}
```

Test it with:

```js
// test.js
const createObject = require('./build/Release/addon');

var obj = createObject(10);
console.log(obj.plusOne()); // 11
console.log(obj.plusOne()); // 12
console.log(obj.plusOne()); // 13

var obj2 = createObject(20);
console.log(obj2.plusOne()); // 21
console.log(obj2.plusOne()); // 22
console.log(obj2.plusOne()); // 23
```


### Passing wrapped objects around

In addition to wrapping and returning C++ objects, it is possible to pass
wrapped objects around by unwrapping them with the Node.js helper function
`node::ObjectWrap::Unwrap`. The following examples shows a function `add()`
that can take two `MyObject` objects as input arguments:

```cpp
// addon.cc
#include 
#include 
#include "myobject.h"

namespace demo {

using v8::FunctionCallbackInfo;
using v8::Isolate;
using v8::Local;
using v8::Number;
using v8::Object;
using v8::String;
using v8::Value;

void CreateObject(const FunctionCallbackInfo& args) {
  MyObject::NewInstance(args);
}

void Add(const FunctionCallbackInfo& args) {
  Isolate* isolate = args.GetIsolate();

  MyObject* obj1 = node::ObjectWrap::Unwrap(
      args[0]->ToObject());
  MyObject* obj2 = node::ObjectWrap::Unwrap(
      args[1]->ToObject());

  double sum = obj1->value() + obj2->value();
  args.GetReturnValue().Set(Number::New(isolate, sum));
}

void InitAll(Local exports) {
  MyObject::Init(exports->GetIsolate());

  NODE_SET_METHOD(exports, "createObject", CreateObject);
  NODE_SET_METHOD(exports, "add", Add);
}

NODE_MODULE(addon, InitAll)

}  // namespace demo
```

In `myobject.h`, a new public method is added to allow access to private values
after unwrapping the object.

```cpp
// myobject.h
#ifndef MYOBJECT_H
#define MYOBJECT_H

#include 
#include 

namespace demo {

class MyObject : public node::ObjectWrap {
 public:
  static void Init(v8::Isolate* isolate);
  static void NewInstance(const v8::FunctionCallbackInfo& args);
  inline double value() const { return value_; }

 private:
  explicit MyObject(double value = 0);
  ~MyObject();

  static void New(const v8::FunctionCallbackInfo& args);
  static v8::Persistent constructor;
  double value_;
};

}  // namespace demo

#endif
```

The implementation of `myobject.cc` is similar to before:

```cpp
// myobject.cc
#include 
#include "myobject.h"

namespace demo {

using v8::Context;
using v8::Function;
using v8::FunctionCallbackInfo;
using v8::FunctionTemplate;
using v8::Isolate;
using v8::Local;
using v8::Object;
using v8::Persistent;
using v8::String;
using v8::Value;

Persistent MyObject::constructor;

MyObject::MyObject(double value) : value_(value) {
}

MyObject::~MyObject() {
}

void MyObject::Init(Isolate* isolate) {
  // Prepare constructor template
  Local tpl = FunctionTemplate::New(isolate, New);
  tpl->SetClassName(String::NewFromUtf8(isolate, "MyObject"));
  tpl->InstanceTemplate()->SetInternalFieldCount(1);

  constructor.Reset(isolate, tpl->GetFunction());
}

void MyObject::New(const FunctionCallbackInfo& args) {
  Isolate* isolate = args.GetIsolate();

  if (args.IsConstructCall()) {
    // Invoked as constructor: `new MyObject(...)`
    double value = args[0]->IsUndefined() ? 0 : args[0]->NumberValue();
    MyObject* obj = new MyObject(value);
    obj->Wrap(args.This());
    args.GetReturnValue().Set(args.This());
  } else {
    // Invoked as plain function `MyObject(...)`, turn into construct call.
    const int argc = 1;
    Local argv[argc] = { args[0] };
    Local context = isolate->GetCurrentContext();
    Local cons = Local::New(isolate, constructor);
    Local instance =
        cons->NewInstance(context, argc, argv).ToLocalChecked();
    args.GetReturnValue().Set(instance);
  }
}

void MyObject::NewInstance(const FunctionCallbackInfo& args) {
  Isolate* isolate = args.GetIsolate();

  const unsigned argc = 1;
  Local argv[argc] = { args[0] };
  Local cons = Local::New(isolate, constructor);
  Local context = isolate->GetCurrentContext();
  Local instance =
      cons->NewInstance(context, argc, argv).ToLocalChecked();

  args.GetReturnValue().Set(instance);
}

}  // namespace demo
```

Test it with:

```js
// test.js
const addon = require('./build/Release/addon');

var obj1 = addon.createObject(10);
var obj2 = addon.createObject(20);
var result = addon.add(obj1, obj2);

console.log(result); // 30
```

### AtExit hooks

An "AtExit" hook is a function that is invoked after the Node.js event loop
has ended but before the JavaScript VM is terminated and Node.js shuts down.
"AtExit" hooks are registered using the `node::AtExit` API.

#### void AtExit(callback, args)

* `callback`: `void (*)(void*)` - A pointer to the function to call at exit.
* `args`: `void*` - A pointer to pass to the callback at exit.

Registers exit hooks that run after the event loop has ended but before the VM
is killed.

AtExit takes two parameters: a pointer to a callback function to run at exit,
and a pointer to untyped context data to be passed to that callback.

Callbacks are run in last-in first-out order.

The following `addon.cc` implements AtExit:

```cpp
// addon.cc
#undef NDEBUG
#include 
#include 
#include 

namespace demo {

using node::AtExit;
using v8::HandleScope;
using v8::Isolate;
using v8::Local;
using v8::Object;

static char cookie[] = "yum yum";
static int at_exit_cb1_called = 0;
static int at_exit_cb2_called = 0;

static void at_exit_cb1(void* arg) {
  Isolate* isolate = static_cast(arg);
  HandleScope scope(isolate);
  Local obj = Object::New(isolate);
  assert(!obj.IsEmpty()); // assert VM is still alive
  assert(obj->IsObject());
  at_exit_cb1_called++;
}

static void at_exit_cb2(void* arg) {
  assert(arg == static_cast(cookie));
  at_exit_cb2_called++;
}

static void sanity_check(void*) {
  assert(at_exit_cb1_called == 1);
  assert(at_exit_cb2_called == 2);
}

void init(Local exports) {
  AtExit(sanity_check);
  AtExit(at_exit_cb2, cookie);
  AtExit(at_exit_cb2, cookie);
  AtExit(at_exit_cb1, exports->GetIsolate());
}

NODE_MODULE(addon, init);

}  // namespace demo
```

Test in JavaScript by running:

```js
// test.js
const addon = require('./build/Release/addon');
```

[bindings]: https://github.com/TooTallNate/node-bindings
[download]: https://github.com/nodejs/node-addon-examples
[Embedder's Guide]: https://developers.google.com/v8/embed
[examples]: https://github.com/nodejs/nan/tree/master/examples/
[installation instructions]: https://github.com/nodejs/node-gyp#installation
[libuv]: https://github.com/libuv/libuv
[Linking to Node.js' own dependencies]: #linking-to-nodejs-own-dependencies
[Native Abstractions for Node.js]: https://github.com/nodejs/nan
[node-gyp]: https://github.com/nodejs/node-gyp
[require]: globals.html#globals_require
[v8-docs]: https://v8docs.nodesource.com/
node-v4.8.2/doc/api/all.html000644 000766 000024 00004434022 13070706740 015741 0ustar00iojsstaff000000 000000 


  
  About this Documentation | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

        
Table of Contents

        

      


      

        

About this Documentation#



The goal of this documentation is to comprehensively explain the Node.js
API, both from a reference as well as a conceptual point of view.  Each
section describes a built-in module or high-level concept.


Where appropriate, property types, method arguments, and the arguments
provided to event handlers are detailed in a list underneath the topic
heading.


Every .html document has a corresponding .json document presenting
the same information in a structured manner.  This feature is
experimental, and added for the benefit of IDEs and other utilities that
wish to do programmatic things with the documentation.


Every .html and .json file is generated based on the corresponding
.md file in the doc/api/ folder in Node.js's source tree.  The
documentation is generated using the tools/doc/generate.js program.
The HTML template is located at doc/template.html.


If you find an error in this documentation, please submit an issue
or see the contributing guide for directions on how to submit a patch.


Stability Index#



Throughout the documentation, you will see indications of a section's
stability.  The Node.js API is still somewhat changing, and as it
matures, certain parts are more reliable than others.  Some are so
proven, and so relied upon, that they are unlikely to ever change at
all.  Others are brand new and experimental, or known to be hazardous
and in the process of being redesigned.


The stability indices are as follows:


Stability: 0 - Deprecated This feature is known to be problematic, and changes are planned.  Do not rely on it.  Use of the feature may cause warnings.  Backwards compatibility should not be expected.
Stability: 1 - Experimental This feature is subject to change, and is gated by a command line flag. It may change or be removed in future versions.
Stability: 2 - Stable The API has proven satisfactory. Compatibility with the npm ecosystem is a high priority, and will not be broken unless absolutely necessary.
Stability: 3 - Locked Only bug fixes, security fixes, and performance improvements will be accepted. Please do not suggest API changes in this area; they will be refused.
JSON Output#


Stability: 1 - Experimental
Every HTML file in the markdown has a corresponding JSON file with the
same data.


This feature was added in Node.js v0.6.12.  It is experimental.


Syscalls and man pages#


System calls like open(2) and read(2) define the interface between user programs
and the underlying operating system. Node functions which simply wrap a syscall,
like fs.open(), will document that. The docs link to the corresponding man
pages (short for manual pages) which describe how the syscalls work.


Caveat: some syscalls, like lchown(2), are BSD-specific. That means, for
example, that fs.lchown() only works on Mac OS X and other BSD-derived systems,
and is not available on Linux.


Most Unix syscalls have Windows equivalents, but behavior may differ on Windows
relative to Linux and OS X. For an example of the subtle ways in which it's
sometimes impossible to replace Unix syscall semantics on Windows, see Node
issue 4760.




Usage#



node [options] [v8 options] [script.js | -e "script"] [arguments]


Please see the Command Line Options document for information about
different options and ways to run scripts with Node.


Example#


An example of a web server written with Node.js which responds with
'Hello World':


const http = require('http');

const hostname = '127.0.0.1';
const port = 3000;

const server = http.createServer((req, res) => {
  res.statusCode = 200;
  res.setHeader('Content-Type', 'text/plain');
  res.end('Hello World\n');
});

server.listen(port, hostname, () => {
  console.log(`Server running at http://${hostname}:${port}/`);
});



To run the server, put the code into a file called example.js and execute
it with Node.js:


$ node example.js
Server running at http://127.0.0.1:3000/

All of the examples in the documentation can be run similarly.




C/C++ Addons#


Node.js Addons are dynamically-linked shared objects, written in C or C++, that
can be loaded into Node.js using the require() function, and used
just as if they were an ordinary Node.js module. They are used primarily to
provide an interface between JavaScript running in Node.js and C/C++ libraries.


At the moment, the method for implementing Addons is rather complicated,
involving knowledge of several components and APIs :


    

  • V8: the C++ library Node.js currently uses to provide the
JavaScript implementation. V8 provides the mechanisms for creating objects,
calling functions, etc. V8's API is documented mostly in the
v8.h header file (deps/v8/include/v8.h in the Node.js source
tree), which is also available online.
    

    • 

  • libuv: The C library that implements the Node.js event loop, its worker
threads and all of the asynchronous behaviors of the platform. It also
serves as a cross-platform abstraction library, giving easy, POSIX-like
access across all major operating systems to many common system tasks, such
as interacting with the filesystem, sockets, timers and system events. libuv
also provides a pthreads-like threading abstraction that may be used to
power more sophisticated asynchronous Addons that need to move beyond the
standard event loop. Addon authors are encouraged to think about how to
avoid blocking the event loop with I/O or other time-intensive tasks by
off-loading work via libuv to non-blocking system operations, worker threads
or a custom use of libuv's threads.
    

    • 

  • Internal Node.js libraries. Node.js itself exports a number of C/C++ APIs
that Addons can use — the most important of which is the
node::ObjectWrap class.
    

    • 

  • Node.js includes a number of other statically linked libraries including
OpenSSL. These other libraries are located in the deps/ directory in the
Node.js source tree. Only the V8 and OpenSSL symbols are purposefully
re-exported by Node.js and may be used to various extents by Addons.
See Linking to Node.js' own dependencies for additional information.
    

    • 



All of the following examples are available for download and may
be used as a starting-point for your own Addon.


Hello world#


This "Hello world" example is a simple Addon, written in C++, that is the
equivalent of the following JavaScript code:


module.exports.hello = () => 'world';



First, create the file hello.cc:


// hello.cc
#include <node.h>

namespace demo {

using v8::FunctionCallbackInfo;
using v8::Isolate;
using v8::Local;
using v8::Object;
using v8::String;
using v8::Value;

void Method(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();
  args.GetReturnValue().Set(String::NewFromUtf8(isolate, "world"));
}

void init(Local<Object> exports) {
  NODE_SET_METHOD(exports, "hello", Method);
}

NODE_MODULE(addon, init)

}  // namespace demo



Note that all Node.js Addons must export an initialization function following
the pattern:


void Initialize(Local<Object> exports);
NODE_MODULE(module_name, Initialize)



There is no semi-colon after NODE_MODULE as it's not a function (see
node.h).


The module_name must match the filename of the final binary (excluding
the .node suffix).


In the hello.cc example, then, the initialization function is init and the
Addon module name is addon.


Building#


Once the source code has been written, it must be compiled into the binary
addon.node file. To do so, create a file called binding.gyp in the
top-level of the project describing the build configuration of your module
using a JSON-like format. This file is used by node-gyp -- a tool written
specifically to compile Node.js Addons.


{
  "targets": [
    {
      "target_name": "addon",
      "sources": [ "hello.cc" ]
    }
  ]
}

Note: A version of the node-gyp utility is bundled and distributed with
Node.js as part of npm. This version is not made directly available for
developers to use and is intended only to support the ability to use the
npm install command to compile and install Addons. Developers who wish to
use node-gyp directly can install it using the command
npm install -g node-gyp. See the node-gyp installation instructions for
more information, including platform-specific requirements.


Once the binding.gyp file has been created, use node-gyp configure to
generate the appropriate project build files for the current platform. This
will generate either a Makefile (on Unix platforms) or a vcxproj file
(on Windows) in the build/ directory.


Next, invoke the node-gyp build command to generate the compiled addon.node
file. This will be put into the build/Release/ directory.


When using npm install to install a Node.js Addon, npm uses its own bundled
version of node-gyp to perform this same set of actions, generating a
compiled version of the Addon for the user's platform on demand.


Once built, the binary Addon can be used from within Node.js by pointing
require() to the built addon.node module:


// hello.js
const addon = require('./build/Release/addon');

console.log(addon.hello()); // 'world'



Please see the examples below for further information or
https://github.com/arturadib/node-qt for an example in production.


Because the exact path to the compiled Addon binary can vary depending on how
it is compiled (i.e. sometimes it may be in ./build/Debug/), Addons can use
the bindings package to load the compiled module.


Note that while the bindings package implementation is more sophisticated
in how it locates Addon modules, it is essentially using a try-catch pattern
similar to:


try {
  return require('./build/Release/addon.node');
} catch (err) {
  return require('./build/Debug/addon.node');
}



Linking to Node.js' own dependencies#


Node.js uses a number of statically linked libraries such as V8, libuv and
OpenSSL. All Addons are required to link to V8 and may link to any of the
other dependencies as well. Typically, this is as simple as including
the appropriate #include <...> statements (e.g. #include <v8.h>) and
node-gyp will locate the appropriate headers automatically. However, there
are a few caveats to be aware of:


    

  • When node-gyp runs, it will detect the specific release version of Node.js
and download either the full source tarball or just the headers. If the full
source is downloaded, Addons will have complete access to the full set of
Node.js dependencies. However, if only the Node.js headers are downloaded, then
only the symbols exported by Node.js will be available.
    

    • 

  • node-gyp can be run using the --nodedir flag pointing at a local Node.js
source image. Using this option, the Addon will have access to the full set of
dependencies.
    

    • 



Loading Addons using require()#


The filename extension of the compiled Addon binary is .node (as opposed
to .dll or .so). The require() function is written to look for
files with the .node file extension and initialize those as dynamically-linked
libraries.


When calling require(), the .node extension can usually be
omitted and Node.js will still find and initialize the Addon. One caveat,
however, is that Node.js will first attempt to locate and load modules or
JavaScript files that happen to share the same base name. For instance, if
there is a file addon.js in the same directory as the binary addon.node,
then require('addon') will give precedence to the addon.js file
and load it instead.


Native Abstractions for Node.js#


Each of the examples illustrated in this document make direct use of the
Node.js and V8 APIs for implementing Addons. It is important to understand
that the V8 API can, and has, changed dramatically from one V8 release to the
next (and one major Node.js release to the next). With each change, Addons may
need to be updated and recompiled in order to continue functioning. The Node.js
release schedule is designed to minimize the frequency and impact of such
changes but there is little that Node.js can do currently to ensure stability
of the V8 APIs.


The Native Abstractions for Node.js (or nan) provide a set of tools that
Addon developers are recommended to use to keep compatibility between past and
future releases of V8 and Node.js. See the nan examples for an
illustration of how it can be used.


Addon examples#


Following are some example Addons intended to help developers get started. The
examples make use of the V8 APIs. Refer to the online V8 reference
for help with the various V8 calls, and V8's Embedder's Guide for an
explanation of several concepts used such as handles, scopes, function
templates, etc.


Each of these examples using the following binding.gyp file:


{
  "targets": [
    {
      "target_name": "addon",
      "sources": [ "addon.cc" ]
    }
  ]
}

In cases where there is more than one .cc file, simply add the additional
filename to the sources array. For example:


"sources": ["addon.cc", "myexample.cc"]

Once the binding.gyp file is ready, the example Addons can be configured and
built using node-gyp:


$ node-gyp configure build

Function arguments#


Addons will typically expose objects and functions that can be accessed from
JavaScript running within Node.js. When functions are invoked from JavaScript,
the input arguments and return value must be mapped to and from the C/C++
code.


The following example illustrates how to read function arguments passed from
JavaScript and how to return a result:


// addon.cc
#include <node.h>

namespace demo {

using v8::Exception;
using v8::FunctionCallbackInfo;
using v8::Isolate;
using v8::Local;
using v8::Number;
using v8::Object;
using v8::String;
using v8::Value;

// This is the implementation of the "add" method
// Input arguments are passed using the
// const FunctionCallbackInfo<Value>& args struct
void Add(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();

  // Check the number of arguments passed.
  if (args.Length() < 2) {
    // Throw an Error that is passed back to JavaScript
    isolate->ThrowException(Exception::TypeError(
        String::NewFromUtf8(isolate, "Wrong number of arguments")));
    return;
  }

  // Check the argument types
  if (!args[0]->IsNumber() || !args[1]->IsNumber()) {
    isolate->ThrowException(Exception::TypeError(
        String::NewFromUtf8(isolate, "Wrong arguments")));
    return;
  }

  // Perform the operation
  double value = args[0]->NumberValue() + args[1]->NumberValue();
  Local<Number> num = Number::New(isolate, value);

  // Set the return value (using the passed in
  // FunctionCallbackInfo<Value>&)
  args.GetReturnValue().Set(num);
}

void Init(Local<Object> exports) {
  NODE_SET_METHOD(exports, "add", Add);
}

NODE_MODULE(addon, Init)

}  // namespace demo



Once compiled, the example Addon can be required and used from within Node.js:


// test.js
const addon = require('./build/Release/addon');

console.log('This should be eight:', addon.add(3, 5));



Callbacks#


It is common practice within Addons to pass JavaScript functions to a C++
function and execute them from there. The following example illustrates how
to invoke such callbacks:


// addon.cc
#include <node.h>

namespace demo {

using v8::Function;
using v8::FunctionCallbackInfo;
using v8::Isolate;
using v8::Local;
using v8::Null;
using v8::Object;
using v8::String;
using v8::Value;

void RunCallback(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();
  Local<Function> cb = Local<Function>::Cast(args[0]);
  const unsigned argc = 1;
  Local<Value> argv[argc] = { String::NewFromUtf8(isolate, "hello world") };
  cb->Call(Null(isolate), argc, argv);
}

void Init(Local<Object> exports, Local<Object> module) {
  NODE_SET_METHOD(module, "exports", RunCallback);
}

NODE_MODULE(addon, Init)

}  // namespace demo



Note that this example uses a two-argument form of Init() that receives
the full module object as the second argument. This allows the Addon
to completely overwrite exports with a single function instead of
adding the function as a property of exports.


To test it, run the following JavaScript:


// test.js
const addon = require('./build/Release/addon');

addon((msg) => {
  console.log(msg); // 'hello world'
});



Note that, in this example, the callback function is invoked synchronously.


Object factory#


Addons can create and return new objects from within a C++ function as
illustrated in the following example. An object is created and returned with a
property msg that echoes the string passed to createObject():


// addon.cc
#include <node.h>

namespace demo {

using v8::FunctionCallbackInfo;
using v8::Isolate;
using v8::Local;
using v8::Object;
using v8::String;
using v8::Value;

void CreateObject(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();

  Local<Object> obj = Object::New(isolate);
  obj->Set(String::NewFromUtf8(isolate, "msg"), args[0]->ToString());

  args.GetReturnValue().Set(obj);
}

void Init(Local<Object> exports, Local<Object> module) {
  NODE_SET_METHOD(module, "exports", CreateObject);
}

NODE_MODULE(addon, Init)

}  // namespace demo



To test it in JavaScript:


// test.js
const addon = require('./build/Release/addon');

var obj1 = addon('hello');
var obj2 = addon('world');
console.log(obj1.msg, obj2.msg); // 'hello world'



Function factory#


Another common scenario is creating JavaScript functions that wrap C++
functions and returning those back to JavaScript:


// addon.cc
#include <node.h>

namespace demo {

using v8::Function;
using v8::FunctionCallbackInfo;
using v8::FunctionTemplate;
using v8::Isolate;
using v8::Local;
using v8::Object;
using v8::String;
using v8::Value;

void MyFunction(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();
  args.GetReturnValue().Set(String::NewFromUtf8(isolate, "hello world"));
}

void CreateFunction(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();

  Local<FunctionTemplate> tpl = FunctionTemplate::New(isolate, MyFunction);
  Local<Function> fn = tpl->GetFunction();

  // omit this to make it anonymous
  fn->SetName(String::NewFromUtf8(isolate, "theFunction"));

  args.GetReturnValue().Set(fn);
}

void Init(Local<Object> exports, Local<Object> module) {
  NODE_SET_METHOD(module, "exports", CreateFunction);
}

NODE_MODULE(addon, Init)

}  // namespace demo



To test:


// test.js
const addon = require('./build/Release/addon');

var fn = addon();
console.log(fn()); // 'hello world'



Wrapping C++ objects#


It is also possible to wrap C++ objects/classes in a way that allows new
instances to be created using the JavaScript new operator:


// addon.cc
#include <node.h>
#include "myobject.h"

namespace demo {

using v8::Local;
using v8::Object;

void InitAll(Local<Object> exports) {
  MyObject::Init(exports);
}

NODE_MODULE(addon, InitAll)

}  // namespace demo



Then, in myobject.h, the wrapper class inherits from node::ObjectWrap:


// myobject.h
#ifndef MYOBJECT_H
#define MYOBJECT_H

#include <node.h>
#include <node_object_wrap.h>

namespace demo {

class MyObject : public node::ObjectWrap {
 public:
  static void Init(v8::Local<v8::Object> exports);

 private:
  explicit MyObject(double value = 0);
  ~MyObject();

  static void New(const v8::FunctionCallbackInfo<v8::Value>& args);
  static void PlusOne(const v8::FunctionCallbackInfo<v8::Value>& args);
  static v8::Persistent<v8::Function> constructor;
  double value_;
};

}  // namespace demo

#endif



In myobject.cc, implement the various methods that are to be exposed.
Below, the method plusOne() is exposed by adding it to the constructor's
prototype:


// myobject.cc
#include "myobject.h"

namespace demo {

using v8::Context;
using v8::Function;
using v8::FunctionCallbackInfo;
using v8::FunctionTemplate;
using v8::Isolate;
using v8::Local;
using v8::Number;
using v8::Object;
using v8::Persistent;
using v8::String;
using v8::Value;

Persistent<Function> MyObject::constructor;

MyObject::MyObject(double value) : value_(value) {
}

MyObject::~MyObject() {
}

void MyObject::Init(Local<Object> exports) {
  Isolate* isolate = exports->GetIsolate();

  // Prepare constructor template
  Local<FunctionTemplate> tpl = FunctionTemplate::New(isolate, New);
  tpl->SetClassName(String::NewFromUtf8(isolate, "MyObject"));
  tpl->InstanceTemplate()->SetInternalFieldCount(1);

  // Prototype
  NODE_SET_PROTOTYPE_METHOD(tpl, "plusOne", PlusOne);

  constructor.Reset(isolate, tpl->GetFunction());
  exports->Set(String::NewFromUtf8(isolate, "MyObject"),
               tpl->GetFunction());
}

void MyObject::New(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();

  if (args.IsConstructCall()) {
    // Invoked as constructor: `new MyObject(...)`
    double value = args[0]->IsUndefined() ? 0 : args[0]->NumberValue();
    MyObject* obj = new MyObject(value);
    obj->Wrap(args.This());
    args.GetReturnValue().Set(args.This());
  } else {
    // Invoked as plain function `MyObject(...)`, turn into construct call.
    const int argc = 1;
    Local<Value> argv[argc] = { args[0] };
    Local<Context> context = isolate->GetCurrentContext();
    Local<Function> cons = Local<Function>::New(isolate, constructor);
    Local<Object> result =
        cons->NewInstance(context, argc, argv).ToLocalChecked();
    args.GetReturnValue().Set(result);
  }
}

void MyObject::PlusOne(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();

  MyObject* obj = ObjectWrap::Unwrap<MyObject>(args.Holder());
  obj->value_ += 1;

  args.GetReturnValue().Set(Number::New(isolate, obj->value_));
}

}  // namespace demo



To build this example, the myobject.cc file must be added to the
binding.gyp:


{
  "targets": [
    {
      "target_name": "addon",
      "sources": [
        "addon.cc",
        "myobject.cc"
      ]
    }
  ]
}

Test it with:


// test.js
const addon = require('./build/Release/addon');

var obj = new addon.MyObject(10);
console.log(obj.plusOne()); // 11
console.log(obj.plusOne()); // 12
console.log(obj.plusOne()); // 13



Factory of wrapped objects#


Alternatively, it is possible to use a factory pattern to avoid explicitly
creating object instances using the JavaScript new operator:


var obj = addon.createObject();
// instead of:
// var obj = new addon.Object();



First, the createObject() method is implemented in addon.cc:


// addon.cc
#include <node.h>
#include "myobject.h"

namespace demo {

using v8::FunctionCallbackInfo;
using v8::Isolate;
using v8::Local;
using v8::Object;
using v8::String;
using v8::Value;

void CreateObject(const FunctionCallbackInfo<Value>& args) {
  MyObject::NewInstance(args);
}

void InitAll(Local<Object> exports, Local<Object> module) {
  MyObject::Init(exports->GetIsolate());

  NODE_SET_METHOD(module, "exports", CreateObject);
}

NODE_MODULE(addon, InitAll)

}  // namespace demo



In myobject.h, the static method NewInstance() is added to handle
instantiating the object. This method takes the place of using new in
JavaScript:


// myobject.h
#ifndef MYOBJECT_H
#define MYOBJECT_H

#include <node.h>
#include <node_object_wrap.h>

namespace demo {

class MyObject : public node::ObjectWrap {
 public:
  static void Init(v8::Isolate* isolate);
  static void NewInstance(const v8::FunctionCallbackInfo<v8::Value>& args);

 private:
  explicit MyObject(double value = 0);
  ~MyObject();

  static void New(const v8::FunctionCallbackInfo<v8::Value>& args);
  static void PlusOne(const v8::FunctionCallbackInfo<v8::Value>& args);
  static v8::Persistent<v8::Function> constructor;
  double value_;
};

}  // namespace demo

#endif



The implementation in myobject.cc is similar to the previous example:


// myobject.cc
#include <node.h>
#include "myobject.h"

namespace demo {

using v8::Context;
using v8::Function;
using v8::FunctionCallbackInfo;
using v8::FunctionTemplate;
using v8::Isolate;
using v8::Local;
using v8::Number;
using v8::Object;
using v8::Persistent;
using v8::String;
using v8::Value;

Persistent<Function> MyObject::constructor;

MyObject::MyObject(double value) : value_(value) {
}

MyObject::~MyObject() {
}

void MyObject::Init(Isolate* isolate) {
  // Prepare constructor template
  Local<FunctionTemplate> tpl = FunctionTemplate::New(isolate, New);
  tpl->SetClassName(String::NewFromUtf8(isolate, "MyObject"));
  tpl->InstanceTemplate()->SetInternalFieldCount(1);

  // Prototype
  NODE_SET_PROTOTYPE_METHOD(tpl, "plusOne", PlusOne);

  constructor.Reset(isolate, tpl->GetFunction());
}

void MyObject::New(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();

  if (args.IsConstructCall()) {
    // Invoked as constructor: `new MyObject(...)`
    double value = args[0]->IsUndefined() ? 0 : args[0]->NumberValue();
    MyObject* obj = new MyObject(value);
    obj->Wrap(args.This());
    args.GetReturnValue().Set(args.This());
  } else {
    // Invoked as plain function `MyObject(...)`, turn into construct call.
    const int argc = 1;
    Local<Value> argv[argc] = { args[0] };
    Local<Function> cons = Local<Function>::New(isolate, constructor);
    Local<Context> context = isolate->GetCurrentContext();
    Local<Object> instance =
        cons->NewInstance(context, argc, argv).ToLocalChecked();
    args.GetReturnValue().Set(instance);
  }
}

void MyObject::NewInstance(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();

  const unsigned argc = 1;
  Local<Value> argv[argc] = { args[0] };
  Local<Function> cons = Local<Function>::New(isolate, constructor);
  Local<Context> context = isolate->GetCurrentContext();
  Local<Object> instance =
      cons->NewInstance(context, argc, argv).ToLocalChecked();

  args.GetReturnValue().Set(instance);
}

void MyObject::PlusOne(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();

  MyObject* obj = ObjectWrap::Unwrap<MyObject>(args.Holder());
  obj->value_ += 1;

  args.GetReturnValue().Set(Number::New(isolate, obj->value_));
}

}  // namespace demo



Once again, to build this example, the myobject.cc file must be added to the
binding.gyp:


{
  "targets": [
    {
      "target_name": "addon",
      "sources": [
        "addon.cc",
        "myobject.cc"
      ]
    }
  ]
}

Test it with:


// test.js
const createObject = require('./build/Release/addon');

var obj = createObject(10);
console.log(obj.plusOne()); // 11
console.log(obj.plusOne()); // 12
console.log(obj.plusOne()); // 13

var obj2 = createObject(20);
console.log(obj2.plusOne()); // 21
console.log(obj2.plusOne()); // 22
console.log(obj2.plusOne()); // 23



Passing wrapped objects around#


In addition to wrapping and returning C++ objects, it is possible to pass
wrapped objects around by unwrapping them with the Node.js helper function
node::ObjectWrap::Unwrap. The following examples shows a function add()
that can take two MyObject objects as input arguments:


// addon.cc
#include <node.h>
#include <node_object_wrap.h>
#include "myobject.h"

namespace demo {

using v8::FunctionCallbackInfo;
using v8::Isolate;
using v8::Local;
using v8::Number;
using v8::Object;
using v8::String;
using v8::Value;

void CreateObject(const FunctionCallbackInfo<Value>& args) {
  MyObject::NewInstance(args);
}

void Add(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();

  MyObject* obj1 = node::ObjectWrap::Unwrap<MyObject>(
      args[0]->ToObject());
  MyObject* obj2 = node::ObjectWrap::Unwrap<MyObject>(
      args[1]->ToObject());

  double sum = obj1->value() + obj2->value();
  args.GetReturnValue().Set(Number::New(isolate, sum));
}

void InitAll(Local<Object> exports) {
  MyObject::Init(exports->GetIsolate());

  NODE_SET_METHOD(exports, "createObject", CreateObject);
  NODE_SET_METHOD(exports, "add", Add);
}

NODE_MODULE(addon, InitAll)

}  // namespace demo



In myobject.h, a new public method is added to allow access to private values
after unwrapping the object.


// myobject.h
#ifndef MYOBJECT_H
#define MYOBJECT_H

#include <node.h>
#include <node_object_wrap.h>

namespace demo {

class MyObject : public node::ObjectWrap {
 public:
  static void Init(v8::Isolate* isolate);
  static void NewInstance(const v8::FunctionCallbackInfo<v8::Value>& args);
  inline double value() const { return value_; }

 private:
  explicit MyObject(double value = 0);
  ~MyObject();

  static void New(const v8::FunctionCallbackInfo<v8::Value>& args);
  static v8::Persistent<v8::Function> constructor;
  double value_;
};

}  // namespace demo

#endif



The implementation of myobject.cc is similar to before:


// myobject.cc
#include <node.h>
#include "myobject.h"

namespace demo {

using v8::Context;
using v8::Function;
using v8::FunctionCallbackInfo;
using v8::FunctionTemplate;
using v8::Isolate;
using v8::Local;
using v8::Object;
using v8::Persistent;
using v8::String;
using v8::Value;

Persistent<Function> MyObject::constructor;

MyObject::MyObject(double value) : value_(value) {
}

MyObject::~MyObject() {
}

void MyObject::Init(Isolate* isolate) {
  // Prepare constructor template
  Local<FunctionTemplate> tpl = FunctionTemplate::New(isolate, New);
  tpl->SetClassName(String::NewFromUtf8(isolate, "MyObject"));
  tpl->InstanceTemplate()->SetInternalFieldCount(1);

  constructor.Reset(isolate, tpl->GetFunction());
}

void MyObject::New(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();

  if (args.IsConstructCall()) {
    // Invoked as constructor: `new MyObject(...)`
    double value = args[0]->IsUndefined() ? 0 : args[0]->NumberValue();
    MyObject* obj = new MyObject(value);
    obj->Wrap(args.This());
    args.GetReturnValue().Set(args.This());
  } else {
    // Invoked as plain function `MyObject(...)`, turn into construct call.
    const int argc = 1;
    Local<Value> argv[argc] = { args[0] };
    Local<Context> context = isolate->GetCurrentContext();
    Local<Function> cons = Local<Function>::New(isolate, constructor);
    Local<Object> instance =
        cons->NewInstance(context, argc, argv).ToLocalChecked();
    args.GetReturnValue().Set(instance);
  }
}

void MyObject::NewInstance(const FunctionCallbackInfo<Value>& args) {
  Isolate* isolate = args.GetIsolate();

  const unsigned argc = 1;
  Local<Value> argv[argc] = { args[0] };
  Local<Function> cons = Local<Function>::New(isolate, constructor);
  Local<Context> context = isolate->GetCurrentContext();
  Local<Object> instance =
      cons->NewInstance(context, argc, argv).ToLocalChecked();

  args.GetReturnValue().Set(instance);
}

}  // namespace demo



Test it with:


// test.js
const addon = require('./build/Release/addon');

var obj1 = addon.createObject(10);
var obj2 = addon.createObject(20);
var result = addon.add(obj1, obj2);

console.log(result); // 30



AtExit hooks#


An "AtExit" hook is a function that is invoked after the Node.js event loop
has ended but before the JavaScript VM is terminated and Node.js shuts down.
"AtExit" hooks are registered using the node::AtExit API.


void AtExit(callback, args)#


    

  • callback: void (*)(void*) - A pointer to the function to call at exit.
    • 

  • args: void* - A pointer to pass to the callback at exit.
    • 



Registers exit hooks that run after the event loop has ended but before the VM
is killed.


AtExit takes two parameters: a pointer to a callback function to run at exit,
and a pointer to untyped context data to be passed to that callback.


Callbacks are run in last-in first-out order.


The following addon.cc implements AtExit:


// addon.cc
#undef NDEBUG
#include <assert.h>
#include <stdlib.h>
#include <node.h>

namespace demo {

using node::AtExit;
using v8::HandleScope;
using v8::Isolate;
using v8::Local;
using v8::Object;

static char cookie[] = "yum yum";
static int at_exit_cb1_called = 0;
static int at_exit_cb2_called = 0;

static void at_exit_cb1(void* arg) {
  Isolate* isolate = static_cast<Isolate*>(arg);
  HandleScope scope(isolate);
  Local<Object> obj = Object::New(isolate);
  assert(!obj.IsEmpty()); // assert VM is still alive
  assert(obj->IsObject());
  at_exit_cb1_called++;
}

static void at_exit_cb2(void* arg) {
  assert(arg == static_cast<void*>(cookie));
  at_exit_cb2_called++;
}

static void sanity_check(void*) {
  assert(at_exit_cb1_called == 1);
  assert(at_exit_cb2_called == 2);
}

void init(Local<Object> exports) {
  AtExit(sanity_check);
  AtExit(at_exit_cb2, cookie);
  AtExit(at_exit_cb2, cookie);
  AtExit(at_exit_cb1, exports->GetIsolate());
}

NODE_MODULE(addon, init);

}  // namespace demo



Test in JavaScript by running:


// test.js
const addon = require('./build/Release/addon');





Assert#


Stability: 2 - Stable
The assert module provides a simple set of assertion tests that can be used to
test invariants.


assert(value[, message])#



Added in: v0.5.9

    

  • value <any>
    • 

  • message <any>
    • 



An alias of assert.ok() .


const assert = require('assert');

assert(true);  // OK
assert(1);     // OK
assert(false);
  // throws "AssertionError: false == true"
assert(0);
  // throws "AssertionError: 0 == true"
assert(false, 'it\'s false');
  // throws "AssertionError: it's false"



assert.deepEqual(actual, expected[, message])#



Added in: v0.1.21

    

  • actual <any>
    • 

  • expected <any>
    • 

  • message <any>
    • 



Tests for deep equality between the actual and expected parameters.
Primitive values are compared with the equal comparison operator ( == ).


Only enumerable "own" properties are considered. The deepEqual()
implementation does not test object prototypes, attached symbols, or
non-enumerable properties. This can lead to some potentially surprising
results. For example, the following example does not throw an AssertionError
because the properties on the Error object are non-enumerable:


// WARNING: This does not throw an AssertionError!
assert.deepEqual(Error('a'), Error('b'));



"Deep" equality means that the enumerable "own" properties of child objects
are evaluated also:


const assert = require('assert');

const obj1 = {
  a : {
    b : 1
  }
};
const obj2 = {
  a : {
    b : 2
  }
};
const obj3 = {
  a : {
    b : 1
  }
}
const obj4 = Object.create(obj1);

assert.deepEqual(obj1, obj1);
  // OK, object is equal to itself

assert.deepEqual(obj1, obj2);
  // AssertionError: { a: { b: 1 } } deepEqual { a: { b: 2 } }
  // values of b are different

assert.deepEqual(obj1, obj3);
  // OK, objects are equal

assert.deepEqual(obj1, obj4);
  // AssertionError: { a: { b: 1 } } deepEqual {}
  // Prototypes are ignored



If the values are not equal, an AssertionError is thrown with a message
property set equal to the value of the message parameter. If the message
parameter is undefined, a default error message is assigned.


assert.deepStrictEqual(actual, expected[, message])#



Added in: v1.2.0

    

  • actual <any>
    • 

  • expected <any>
    • 

  • message <any>
    • 



Generally identical to assert.deepEqual() with two exceptions. First,
primitive values are compared using the strict equality operator ( === ).
Second, object comparisons include a strict equality check of their prototypes.


const assert = require('assert');

assert.deepEqual({a:1}, {a:'1'});
  // OK, because 1 == '1'

assert.deepStrictEqual({a:1}, {a:'1'});
  // AssertionError: { a: 1 } deepStrictEqual { a: '1' }
  // because 1 !== '1' using strict equality



If the values are not equal, an AssertionError is thrown with a message
property set equal to the value of the message parameter. If the message
parameter is undefined, a default error message is assigned.


assert.doesNotThrow(block[, error][, message])#



Added in: v0.1.21



Asserts that the function block does not throw an error. See
assert.throws() for more details.


When assert.doesNotThrow() is called, it will immediately call the block
function.


If an error is thrown and it is the same type as that specified by the error
parameter, then an AssertionError is thrown. If the error is of a different
type, or if the error parameter is undefined, the error is propagated back
to the caller.


The following, for instance, will throw the TypeError because there is no
matching error type in the assertion:


assert.doesNotThrow(
  () => {
    throw new TypeError('Wrong value');
  },
  SyntaxError
);



However, the following will result in an AssertionError with the message
'Got unwanted exception (TypeError)..':


assert.doesNotThrow(
  () => {
    throw new TypeError('Wrong value');
  },
  TypeError
);



If an AssertionError is thrown and a value is provided for the message
parameter, the value of message will be appended to the AssertionError
message:


assert.doesNotThrow(
  () => {
    throw new TypeError('Wrong value');
  },
  TypeError,
  'Whoops'
);
// Throws: AssertionError: Got unwanted exception (TypeError). Whoops



assert.equal(actual, expected[, message])#



Added in: v0.1.21

    

  • actual <any>
    • 

  • expected <any>
    • 

  • message <any>
    • 



Tests shallow, coercive equality between the actual and expected parameters
using the equal comparison operator ( == ).


const assert = require('assert');

assert.equal(1, 1);
  // OK, 1 == 1
assert.equal(1, '1');
  // OK, 1 == '1'

assert.equal(1, 2);
  // AssertionError: 1 == 2
assert.equal({a: {b: 1}}, {a: {b: 1}});
  //AssertionError: { a: { b: 1 } } == { a: { b: 1 } }



If the values are not equal, an AssertionError is thrown with a message
property set equal to the value of the message parameter. If the message
parameter is undefined, a default error message is assigned.


assert.fail(actual, expected, message, operator)#



Added in: v0.1.21

    

  • actual <any>
    • 

  • expected <any>
    • 

  • message <any>
    • 

  • operator <String>
    • 



Throws an AssertionError. If message is falsy, the error message is set as
the values of actual and expected separated by the provided operator.
Otherwise, the error message is the value of message.


const assert = require('assert');

assert.fail(1, 2, undefined, '>');
  // AssertionError: 1 > 2

assert.fail(1, 2, 'whoops', '>');
  // AssertionError: whoops



assert.ifError(value)#



Added in: v0.1.97

    

  • value <any>
    • 



Throws value if value is truthy. This is useful when testing the error
argument in callbacks.


const assert = require('assert');

assert.ifError(0); // OK
assert.ifError(1); // Throws 1
assert.ifError('error') // Throws 'error'
assert.ifError(new Error()); // Throws Error



assert.notDeepEqual(actual, expected[, message])#



Added in: v0.1.21

    

  • actual <any>
    • 

  • expected <any>
    • 

  • message <any>
    • 



Tests for any deep inequality. Opposite of assert.deepEqual().


const assert = require('assert');

const obj1 = {
  a : {
    b : 1
  }
};
const obj2 = {
  a : {
    b : 2
  }
};
const obj3 = {
  a : {
    b : 1
  }
};
const obj4 = Object.create(obj1);

assert.notDeepEqual(obj1, obj1);
  // AssertionError: { a: { b: 1 } } notDeepEqual { a: { b: 1 } }

assert.notDeepEqual(obj1, obj2);
  // OK, obj1 and obj2 are not deeply equal

assert.notDeepEqual(obj1, obj3);
  // AssertionError: { a: { b: 1 } } notDeepEqual { a: { b: 1 } }

assert.notDeepEqual(obj1, obj4);
  // OK, obj1 and obj4 are not deeply equal



If the values are deeply equal, an AssertionError is thrown with a message
property set equal to the value of the message parameter. If the message
parameter is undefined, a default error message is assigned.


assert.notDeepStrictEqual(actual, expected[, message])#



Added in: v1.2.0

    

  • actual <any>
    • 

  • expected <any>
    • 

  • message <any>
    • 



Tests for deep strict inequality. Opposite of assert.deepStrictEqual().


const assert = require('assert');

assert.notDeepEqual({a:1}, {a:'1'});
  // AssertionError: { a: 1 } notDeepEqual { a: '1' }

assert.notDeepStrictEqual({a:1}, {a:'1'});
  // OK



If the values are deeply and strictly equal, an AssertionError is thrown
with a message property set equal to the value of the message parameter. If
the message parameter is undefined, a default error message is assigned.


assert.notEqual(actual, expected[, message])#



Added in: v0.1.21

    

  • actual <any>
    • 

  • expected <any>
    • 

  • message <any>
    • 



Tests shallow, coercive inequality with the not equal comparison operator
( != ).


const assert = require('assert');

assert.notEqual(1, 2);
  // OK

assert.notEqual(1, 1);
  // AssertionError: 1 != 1

assert.notEqual(1, '1');
  // AssertionError: 1 != '1'



If the values are equal, an AssertionError is thrown with a message
property set equal to the value of the message parameter. If the message
parameter is undefined, a default error message is assigned.


assert.notStrictEqual(actual, expected[, message])#



Added in: v0.1.21

    

  • actual <any>
    • 

  • expected <any>
    • 

  • message <any>
    • 



Tests strict inequality as determined by the strict not equal operator
( !== ).


const assert = require('assert');

assert.notStrictEqual(1, 2);
  // OK

assert.notStrictEqual(1, 1);
  // AssertionError: 1 !== 1

assert.notStrictEqual(1, '1');
  // OK



If the values are strictly equal, an AssertionError is thrown with a
message property set equal to the value of the message parameter. If the
message parameter is undefined, a default error message is assigned.


assert.ok(value[, message])#



Added in: v0.1.21

    

  • value <any>
    • 

  • message <any>
    • 



Tests if value is truthy. It is equivalent to
assert.equal(!!value, true, message).


If value is not truthy, an AssertionError is thrown with a message
property set equal to the value of the message parameter. If the message
parameter is undefined, a default error message is assigned.


const assert = require('assert');

assert.ok(true);  // OK
assert.ok(1);     // OK
assert.ok(false);
  // throws "AssertionError: false == true"
assert.ok(0);
  // throws "AssertionError: 0 == true"
assert.ok(false, 'it\'s false');
  // throws "AssertionError: it's false"



assert.strictEqual(actual, expected[, message])#



Added in: v0.1.21

    

  • actual <any>
    • 

  • expected <any>
    • 

  • message <any>
    • 



Tests strict equality as determined by the strict equality operator ( === ).


const assert = require('assert');

assert.strictEqual(1, 2);
  // AssertionError: 1 === 2

assert.strictEqual(1, 1);
  // OK

assert.strictEqual(1, '1');
  // AssertionError: 1 === '1'



If the values are not strictly equal, an AssertionError is thrown with a
message property set equal to the value of the message parameter. If the
message parameter is undefined, a default error message is assigned.


assert.throws(block[, error][, message])#



Added in: v0.1.21



Expects the function block to throw an error.


If specified, error can be a constructor, RegExp, or validation
function.


If specified, message will be the message provided by the AssertionError if
the block fails to throw.


Validate instanceof using constructor:


assert.throws(
  () => {
    throw new Error('Wrong value');
  },
  Error
);



Validate error message using RegExp:


assert.throws(
  () => {
    throw new Error('Wrong value');
  },
  /value/
);



Custom error validation:


assert.throws(
  () => {
    throw new Error('Wrong value');
  },
  function(err) {
    if ( (err instanceof Error) && /value/.test(err) ) {
      return true;
    }
  },
  'unexpected error'
);



Note that error can not be a string. If a string is provided as the second
argument, then error is assumed to be omitted and the string will be used for
message instead. This can lead to easy-to-miss mistakes:


// THIS IS A MISTAKE! DO NOT DO THIS!
assert.throws(myFunction, 'missing foo', 'did not throw with expected message');

// Do this instead.
assert.throws(myFunction, /missing foo/, 'did not throw with expected message');





Buffer#


Stability: 2 - Stable
Prior to the introduction of TypedArray in ECMAScript 2015 (ES6), the
JavaScript language had no mechanism for reading or manipulating streams
of binary data. The Buffer class was introduced as part of the Node.js
API to make it possible to interact with octet streams in the context of things
like TCP streams and file system operations.


Now that TypedArray has been added in ES6, the Buffer class implements the
Uint8Array API in a manner that is more optimized and suitable for Node.js'
use cases.


Instances of the Buffer class are similar to arrays of integers but
correspond to fixed-sized, raw memory allocations outside the V8 heap.
The size of the Buffer is established when it is created and cannot be
resized.


The Buffer class is a global within Node.js, making it unlikely that one
would need to ever use require('buffer').Buffer.


const buf1 = new Buffer(10);
  // creates a buffer of length 10
  // This is the same as Buffer.allocUnsafe(10), and the returned
  // Buffer instance might contain old data that needs to be
  // overwritten using either fill() or write().

const buf2 = new Buffer([1,2,3]);
  // creates a buffer containing [01, 02, 03]
  // This is the same as Buffer.from([1,2,3]).

const buf3 = new Buffer('test');
  // creates a buffer containing ASCII bytes [74, 65, 73, 74]
  // This is the same as Buffer.from('test').

const buf4 = new Buffer('tést', 'utf8');
  // creates a buffer containing UTF8 bytes [74, c3, a9, 73, 74]
  // This is the same as Buffer.from('tést', 'utf8').

const buf5 = Buffer.alloc(10);
  // Creates a zero-filled Buffer of length 10.

const buf6 = Buffer.alloc(10, 1);
  // Creates a Buffer of length 10, filled with 0x01.

const buf7 = Buffer.allocUnsafe(10);
  // Creates an uninitialized buffer of length 10.
  // This is faster than calling Buffer.alloc() but the returned
  // Buffer instance might contain old data that needs to be
  // overwritten using either fill() or write().

const buf8 = Buffer.from([1,2,3]);
  // Creates a Buffer containing [01, 02, 03].

const buf9 = Buffer.from('test');
  // Creates a Buffer containing ASCII bytes [74, 65, 73, 74].

const buf8 = Buffer.from('tést', 'utf8');
  // Creates a Buffer containing UTF8 bytes [74, c3, a9, 73, 74].



Buffer.from(), Buffer.alloc(), and Buffer.allocUnsafe()#


Historically, Buffer instances have been created using the Buffer
constructor function, which allocates the returned Buffer
differently based on what arguments are provided:


    

  • Passing a number as the first argument to Buffer() (e.g. new Buffer(10)),
allocates a new Buffer object of the specified size. The memory allocated
for such Buffer instances is not initialized and can contain sensitive
data. Such Buffer objects must be initialized manually by using either
buf.fill(0) or by writing to the Buffer completely. While this
behavior is intentional to improve performance, development experience has
demonstrated that a more explicit distinction is required between creating a
fast-but-uninitialized Buffer versus creating a slower-but-safer Buffer.
    • 

  • Passing a string, array, or Buffer as the first argument copies the
passed object's data into the Buffer.
    • 

  • Passing an ArrayBuffer returns a Buffer that shares allocated memory with
the given ArrayBuffer.
    • 



Because the behavior of new Buffer() changes significantly based on the type
of value passed as the first argument, applications that do not properly
validate the input arguments passed to new Buffer(), or that fail to
appropriately initialize newly allocated Buffer content, can inadvertently
introduce security and reliability issues into their code.


To make the creation of Buffer objects more reliable and less error prone,
new Buffer.from(), Buffer.alloc(), and Buffer.allocUnsafe() methods have
been introduced as an alternative means of creating Buffer instances.


Developers should migrate all existing uses of the new Buffer() constructors
to one of these new APIs.



Buffer instances returned by Buffer.allocUnsafe(size) may be allocated
off a shared internal memory pool if size is less than or equal to half
Buffer.poolSize. Instances returned by Buffer.allocUnsafeSlow(size) never
use the shared internal memory pool.


What makes Buffer.allocUnsafe(size) and Buffer.allocUnsafeSlow(size) "unsafe"?#


When calling Buffer.allocUnsafe() (and Buffer.allocUnsafeSlow()), the
segment of allocated memory is uninitialized (it is not zeroed-out). While
this design makes the allocation of memory quite fast, the allocated segment of
memory might contain old data that is potentially sensitive. Using a Buffer
created by Buffer.allocUnsafe() without completely overwriting the memory
can allow this old data to be leaked when the Buffer memory is read.


While there are clear performance advantages to using Buffer.allocUnsafe(),
extra care must be taken in order to avoid introducing security
vulnerabilities into an application.


Buffers and Character Encodings#


Buffers are commonly used to represent sequences of encoded characters
such as UTF8, UCS2, Base64 or even Hex-encoded data. It is possible to
convert back and forth between Buffers and ordinary JavaScript string objects
by using an explicit encoding method.


const buf = new Buffer('hello world', 'ascii');
console.log(buf.toString('hex'));
  // prints: 68656c6c6f20776f726c64
console.log(buf.toString('base64'));
  // prints: aGVsbG8gd29ybGQ=



The character encodings currently supported by Node.js include:


    

  • 'ascii' - for 7-bit ASCII data only.  This encoding method is very fast and
will strip the high bit if set.
    

    • 

  • 'utf8' - Multibyte encoded Unicode characters. Many web pages and other
document formats use UTF-8.
    

    • 

  • 'utf16le' - 2 or 4 bytes, little-endian encoded Unicode characters.
Surrogate pairs (U+10000 to U+10FFFF) are supported.
    

    • 

  • 'ucs2' - Alias of 'utf16le'.
    

    • 

  • 'base64' - Base64 string encoding. When creating a buffer from a string,
this encoding will also correctly accept "URL and Filename Safe Alphabet" as
specified in RFC 4648, Section 5.
    

    • 

  • 'binary' - A way of encoding the buffer into a one-byte (latin-1)
encoded string. The string 'latin-1' is not supported. Instead, pass
'binary' to use 'latin-1' encoding.
    

    • 

  • 'hex' - Encode each byte as two hexadecimal characters.
    

    • 



Buffers and TypedArray#


Buffers are also Uint8Array TypedArray instances. However, there are subtle
incompatibilities with the TypedArray specification in ECMAScript 2015. For
instance, while ArrayBuffer#slice() creates a copy of the slice,
the implementation of Buffer#slice() creates a view over the
existing Buffer without copying, making Buffer#slice() far more efficient.


It is also possible to create new TypedArray instances from a Buffer with the
following caveats:


    

  1. The Buffer instances's memory is copied to the TypedArray, not shared.
    

    2. 

  2. The Buffer's memory is interpreted as an array of distinct elements, and not
as a byte array of the target type. That is,
new Uint32Array(new Buffer([1,2,3,4])) creates a 4-element Uint32Array
with elements [1,2,3,4], not a Uint32Array with a single element
[0x1020304] or [0x4030201].
    

    3. 



It is possible to create a new Buffer that shares the same allocated memory as
a TypedArray instance by using the TypeArray objects .buffer property:


const arr = new Uint16Array(2);
arr[0] = 5000;
arr[1] = 4000;

const buf1 = new Buffer(arr); // copies the buffer
const buf2 = new Buffer(arr.buffer); // shares the memory with arr;

console.log(buf1);
  // Prints: <Buffer 88 a0>, copied buffer has only two elements
console.log(buf2);
  // Prints: <Buffer 88 13 a0 0f>

arr[1] = 6000;
console.log(buf1);
  // Prints: <Buffer 88 a0>
console.log(buf2);
  // Prints: <Buffer 88 13 70 17>



Note that when creating a Buffer using the TypeArray's .buffer, it is not
currently possible to use only a portion of the underlying ArrayBuffer. To
create a Buffer that uses only a part of the ArrayBuffer, use the
buf.slice() function after the Buffer is created:


const arr = new Uint16Array(20);
const buf = new Buffer(arr.buffer).slice(0, 16);
console.log(buf.length);
  // Prints: 16



The Buffer.from() and TypedArray.from() (e.g.Uint8Array.from()) have
different signatures and implementations. Specifically, the TypedArray variants
accept a second argument that is a mapping function that is invoked on every
element of the typed array:


    

  • TypedArray.from(source[, mapFn[, thisArg]])
    • 



The Buffer.from() method, however, does not support the use of a mapping
function:



Buffers and ES6 iteration#


Buffers can be iterated over using the ECMAScript 2015 (ES6) for..of syntax:


const buf = new Buffer([1, 2, 3]);

for (var b of buf)
  console.log(b)

// Prints:
//   1
//   2
//   3



Additionally, the buf.values(), buf.keys(), and
buf.entries() methods can be used to create iterators.


The --zero-fill-buffers command line option#


Node.js can be started using the --zero-fill-buffers command line option to
force all newly allocated Buffer and SlowBuffer instances created using
either new Buffer(size) and new SlowBuffer(size) to be automatically
zero-filled upon creation. Use of this flag changes the default behavior of
these methods and can have a significant impact on performance. Use of the
--zero-fill-buffers option is recommended only when absolutely necessary to
enforce that newly allocated Buffer instances cannot contain potentially
sensitive data.


$ node --zero-fill-buffers
> Buffer(5);
<Buffer 00 00 00 00 00>

Class: Buffer#


The Buffer class is a global type for dealing with binary data directly.
It can be constructed in a variety of ways.


new Buffer(array)#




Allocates a new Buffer using an array of octets.


const buf = new Buffer([0x62,0x75,0x66,0x66,0x65,0x72]);
  // creates a new Buffer containing ASCII bytes
  // ['b','u','f','f','e','r']



new Buffer(buffer)#




Copies the passed buffer data onto a new Buffer instance.


const buf1 = new Buffer('buffer');
const buf2 = new Buffer(buf1);

buf1[0] = 0x61;
console.log(buf1.toString());
  // 'auffer'
console.log(buf2.toString());
  // 'buffer' (copy is not changed)



new Buffer(arrayBuffer)#


    

  • arrayBuffer - The .buffer property of a TypedArray or a new
ArrayBuffer()
    • 



When passed a reference to the .buffer property of a TypedArray instance,
the newly created Buffer will share the same allocated memory as the
TypedArray.


const arr = new Uint16Array(2);
arr[0] = 5000;
arr[1] = 4000;

const buf = new Buffer(arr.buffer); // shares the memory with arr;

console.log(buf);
  // Prints: <Buffer 88 13 a0 0f>

// changing the TypdArray changes the Buffer also
arr[1] = 6000;

console.log(buf);
  // Prints: <Buffer 88 13 70 17>



new Buffer(size)#




Allocates a new Buffer of size bytes.  The size must be less than
or equal to the value of require('buffer').kMaxLength (on 64-bit
architectures, kMaxLength is (2^31)-1). Otherwise, a RangeError is
thrown. If a size less than 0 is specified, a zero-length Buffer will be
created.


Unlike ArrayBuffers, the underlying memory for Buffer instances created in
this way is not initialized. The contents of a newly created Buffer are
unknown and could contain sensitive data. Use buf.fill(0) to initialize a
Buffer to zeroes.


const buf = new Buffer(5);
console.log(buf);
  // <Buffer 78 e0 82 02 01>
  // (octets will be different, every time)
buf.fill(0);
console.log(buf);
  // <Buffer 00 00 00 00 00>



new Buffer(str[, encoding])#




Creates a new Buffer containing the given JavaScript string str. If
provided, the encoding parameter identifies the strings character encoding.


const buf1 = new Buffer('this is a tést');
console.log(buf1.toString());
  // prints: this is a tést
console.log(buf1.toString('ascii'));
  // prints: this is a tC)st

const buf2 = new Buffer('7468697320697320612074c3a97374', 'hex');
console.log(buf2.toString());
  // prints: this is a tést



Class Method: Buffer.alloc(size[, fill[, encoding]])#



Added in: v4.5.0



Allocates a new Buffer of size bytes. If fill is undefined, the
Buffer will be zero-filled.


const buf = Buffer.alloc(5);
console.log(buf);
  // <Buffer 00 00 00 00 00>



The size must be less than or equal to the value of
require('buffer').kMaxLength (on 64-bit architectures, kMaxLength is
(2^31)-1). Otherwise, a RangeError is thrown. If a size less than 0
is specified, a zero-length Buffer will be created.


If fill is specified, the allocated Buffer will be initialized by calling
buf.fill(fill). See [buf.fill()][] for more information.


const buf = Buffer.alloc(5, 'a');
console.log(buf);
  // <Buffer 61 61 61 61 61>



If both fill and encoding are specified, the allocated Buffer will be
initialized by calling buf.fill(fill, encoding). For example:


const buf = Buffer.alloc(11, 'aGVsbG8gd29ybGQ=', 'base64');
console.log(buf);
  // <Buffer 68 65 6c 6c 6f 20 77 6f 72 6c 64>



Calling Buffer.alloc(size) can be significantly slower than the alternative
Buffer.allocUnsafe(size) but ensures that the newly created Buffer instance
contents will never contain sensitive data.


A TypeError will be thrown if size is not a number.


Class Method: Buffer.allocUnsafe(size)#



Added in: v4.5.0



Allocates a new non-zero-filled Buffer of size bytes.  The size must
be less than or equal to the value of require('buffer').kMaxLength (on 64-bit
architectures, kMaxLength is (2^31)-1). Otherwise, a RangeError is
thrown. If a size less than 0 is specified, a zero-length Buffer will be
created.


The underlying memory for Buffer instances created in this way is not
initialized. The contents of the newly created Buffer are unknown and
may contain sensitive data. Use buf.fill(0) to initialize such
Buffer instances to zeroes.


const buf = Buffer.allocUnsafe(5);
console.log(buf);
  // <Buffer 78 e0 82 02 01>
  // (octets will be different, every time)
buf.fill(0);
console.log(buf);
  // <Buffer 00 00 00 00 00>



A TypeError will be thrown if size is not a number.


Note that the Buffer module pre-allocates an internal Buffer instance of
size Buffer.poolSize that is used as a pool for the fast allocation of new
Buffer instances created using Buffer.allocUnsafe(size) (and the
new Buffer(size) constructor) only when size is less than or equal to
Buffer.poolSize >> 1 (floor of Buffer.poolSize divided by two). The default
value of Buffer.poolSize is 8192 but can be modified.


Use of this pre-allocated internal memory pool is a key difference between
calling Buffer.alloc(size, fill) vs. Buffer.allocUnsafe(size).fill(fill).
Specifically, Buffer.alloc(size, fill) will never use the internal Buffer
pool, while Buffer.allocUnsafe(size).fill(fill) will use the internal
Buffer pool if size is less than or equal to half Buffer.poolSize. The
difference is subtle but can be important when an application requires the
additional performance that Buffer.allocUnsafe(size) provides.


Class Method: Buffer.allocUnsafeSlow(size)#



Added in: v4.5.0



Allocates a new non-zero-filled and non-pooled Buffer of size bytes.  The
size must be less than or equal to the value of
require('buffer').kMaxLength (on 64-bit architectures, kMaxLength is
(2^31)-1). Otherwise, a RangeError is thrown. If a size less than 0
is specified, a zero-length Buffer will be created.


The underlying memory for Buffer instances created in this way is not
initialized. The contents of the newly created Buffer are unknown and
may contain sensitive data. Use buf.fill(0) to initialize such
Buffer instances to zeroes.


When using Buffer.allocUnsafe() to allocate new Buffer instances,
allocations under 4KB are, by default, sliced from a single pre-allocated
Buffer. This allows applications to avoid the garbage collection overhead of
creating many individually allocated Buffers. This approach improves both
performance and memory usage by eliminating the need to track and cleanup as
many Persistent objects.


However, in the case where a developer may need to retain a small chunk of
memory from a pool for an indeterminate amount of time, it may be appropriate
to create an un-pooled Buffer instance using Buffer.allocUnsafeSlow() then
copy out the relevant bits.


// need to keep around a few small chunks of memory
const store = [];

socket.on('readable', () => {
  const data = socket.read();
  // allocate for retained data
  const sb = Buffer.allocUnsafeSlow(10);
  // copy the data into the new allocation
  data.copy(sb, 0, 0, 10);
  store.push(sb);
});



Use of Buffer.allocUnsafeSlow() should be used only as a last resort after
a developer has observed undue memory retention in their applications.


A TypeError will be thrown if size is not a number.


Class Method: Buffer.byteLength(string[, encoding])#




Returns the actual byte length of a string. This is not the same as
String.prototype.length since that returns the number of characters in
a string.


Note that for 'base64' and 'hex', this function assumes valid input. For
strings that contain non-Base64/Hex-encoded data (e.g. whitespace), the return
value might be greater than the length of a Buffer created from the string.


Example:


const str = '\u00bd + \u00bc = \u00be';

console.log(`${str}: ${str.length} characters, ` +
            `${Buffer.byteLength(str, 'utf8')} bytes`);

// ½ + ¼ = ¾: 9 characters, 12 bytes



Class Method: Buffer.compare(buf1, buf2)#



Added in: v0.11.13



Compares buf1 to buf2 typically for the purpose of sorting arrays of
Buffers. This is equivalent is calling buf1.compare(buf2).


const arr = [Buffer('1234'), Buffer('0123')];
arr.sort(Buffer.compare);



Class Method: Buffer.concat(list[, totalLength])#



Added in: v0.7.11

    

  • list <Array> List of Buffer objects to concat
    • 

  • totalLength <Number> Total length of the Buffers in the list when concatenated
    • 

  • Returns: <Buffer>
    • 



Returns a new Buffer which is the result of concatenating all the Buffers in
the list together.


If the list has no items, or if the totalLength is 0, then a new zero-length
Buffer is returned.


If totalLength is not provided, it is calculated from the Buffers in the
list. This, however, adds an additional loop to the function, so it is faster
to provide the length explicitly.


Example: build a single Buffer from a list of three Buffers:


const buf1 = new Buffer(10).fill(0);
const buf2 = new Buffer(14).fill(0);
const buf3 = new Buffer(18).fill(0);
const totalLength = buf1.length + buf2.length + buf3.length;

console.log(totalLength);
const bufA = Buffer.concat([buf1, buf2, buf3], totalLength);
console.log(bufA);
console.log(bufA.length);

// 42
// <Buffer 00 00 00 00 ...>
// 42



Class Method: Buffer.from(array)#



Added in: v4.5.0



Allocates a new Buffer using an array of octets.


const buf = Buffer.from([0x62,0x75,0x66,0x66,0x65,0x72]);
  // creates a new Buffer containing ASCII bytes
  // ['b','u','f','f','e','r']



A TypeError will be thrown if array is not an Array.


Class Method: Buffer.from(arrayBuffer)#



Added in: v4.5.0

    

  • arrayBuffer <ArrayBuffer> The .buffer property of a TypedArray or
a new ArrayBuffer()
    • 



When passed a reference to the .buffer property of a TypedArray instance,
the newly created Buffer will share the same allocated memory as the
TypedArray.


const arr = new Uint16Array(2);
arr[0] = 5000;
arr[1] = 4000;

const buf = Buffer.from(arr.buffer); // shares the memory with arr;

console.log(buf);
  // Prints: <Buffer 88 13 a0 0f>

// changing the TypedArray changes the Buffer also
arr[1] = 6000;

console.log(buf);
  // Prints: <Buffer 88 13 70 17>



A TypeError will be thrown if arrayBuffer is not an ArrayBuffer.


Class Method: Buffer.from(buffer)#



Added in: v4.5.0



Copies the passed buffer data onto a new Buffer instance.


const buf1 = Buffer.from('buffer');
const buf2 = Buffer.from(buf1);

buf1[0] = 0x61;
console.log(buf1.toString());
  // 'auffer'
console.log(buf2.toString());
  // 'buffer' (copy is not changed)



A TypeError will be thrown if buffer is not a Buffer.


Class Method: Buffer.from(str[, encoding])#



Added in: v4.5.0

    

  • str <String> String to encode.
    • 

  • encoding <String> Encoding to use, Default: 'utf8'
    • 



Creates a new Buffer containing the given JavaScript string str. If
provided, the encoding parameter identifies the character encoding.
If not provided, encoding defaults to 'utf8'.


const buf1 = Buffer.from('this is a tést');
console.log(buf1.toString());
  // prints: this is a tést
console.log(buf1.toString('ascii'));
  // prints: this is a tC)st

const buf2 = Buffer.from('7468697320697320612074c3a97374', 'hex');
console.log(buf2.toString());
  // prints: this is a tést



A TypeError will be thrown if str is not a string.


Class Method: Buffer.isBuffer(obj)#




Returns 'true' if obj is a Buffer.


Class Method: Buffer.isEncoding(encoding)#



Added in: v0.9.1



Returns true if the encoding is a valid encoding argument, or false
otherwise.


buf[index]#




The index operator [index] can be used to get and set the octet at position
index in the Buffer. The values refer to individual bytes, so the legal value
range is between 0x00 and 0xFF (hex) or 0 and 255 (decimal).


Example: copy an ASCII string into a Buffer, one byte at a time:


const str = "Node.js";
const buf = new Buffer(str.length);

for (var i = 0; i < str.length ; i++) {
  buf[i] = str.charCodeAt(i);
}

console.log(buf.toString('ascii'));
  // Prints: Node.js



buf.compare(otherBuffer)#



Added in: v0.11.13



Compares two Buffer instances and returns a number indicating whether buf
comes before, after, or is the same as the otherBuffer in sort order.
Comparison is based on the actual sequence of bytes in each Buffer.


    

  • 0 is returned if otherBuffer is the same as buf
    • 

  • 1 is returned if otherBuffer should come before buf when sorted.
    • 

  • -1 is returned if otherBuffer should come after buf when sorted.
    • 



const buf1 = new Buffer('ABC');
const buf2 = new Buffer('BCD');
const buf3 = new Buffer('ABCD');

console.log(buf1.compare(buf1));
  // Prints: 0
console.log(buf1.compare(buf2));
  // Prints: -1
console.log(buf1.compare(buf3));
  // Prints: -1
console.log(buf2.compare(buf1));
  // Prints: 1
console.log(buf2.compare(buf3));
  // Prints: 1

[buf1, buf2, buf3].sort(Buffer.compare);
  // produces sort order [buf1, buf3, buf2]



buf.copy(targetBuffer[, targetStart[, sourceStart[, sourceEnd]]])#




Copies data from a region of this Buffer to a region in the target Buffer even
if the target memory region overlaps with the source.


Example: build two Buffers, then copy buf1 from byte 16 through byte 19
into buf2, starting at the 8th byte in buf2.


const buf1 = new Buffer(26);
const buf2 = new Buffer(26).fill('!');

for (var i = 0 ; i < 26 ; i++) {
  buf1[i] = i + 97; // 97 is ASCII a
}

buf1.copy(buf2, 8, 16, 20);
console.log(buf2.toString('ascii', 0, 25));
  // Prints: !!!!!!!!qrst!!!!!!!!!!!!!



Example: Build a single Buffer, then copy data from one region to an overlapping
region in the same Buffer


const buf = new Buffer(26);

for (var i = 0 ; i < 26 ; i++) {
  buf[i] = i + 97; // 97 is ASCII a
}

buf.copy(buf, 0, 4, 10);
console.log(buf.toString());

// efghijghijklmnopqrstuvwxyz



buf.entries()#



Added in: v1.1.0

    

  • Returns: <Iterator>
    • 



Creates and returns an iterator of [index, byte] pairs from the Buffer
contents.


const buf = new Buffer('buffer');
for (var pair of buf.entries()) {
  console.log(pair);
}
// prints:
//   [0, 98]
//   [1, 117]
//   [2, 102]
//   [3, 102]
//   [4, 101]
//   [5, 114]



buf.equals(otherBuffer)#



Added in: v1.0.0



Returns a boolean indicating whether this and otherBuffer have exactly the
same bytes.


const buf1 = new Buffer('ABC');
const buf2 = new Buffer('414243', 'hex');
const buf3 = new Buffer('ABCD');

console.log(buf1.equals(buf2));
  // Prints: true
console.log(buf1.equals(buf3));
  // Prints: false



buf.fill(value[, offset[, end]])#



Added in: v0.5.0



Fills the Buffer with the specified value. If the offset and end are not
given it will fill the entire Buffer. The method returns a reference to the
Buffer so calls can be chained.


const b = new Buffer(50).fill('h');
console.log(b.toString());
  // Prints: hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh



buf.indexOf(value[, byteOffset][, encoding])#



Added in: v1.5.0



Operates similar to Array#indexOf() in that it returns either the
starting index position of value in Buffer or -1 if the Buffer does not
contain value. The value can be a String, Buffer or Number. Strings are by
default interpreted as UTF8. Buffers will use the entire Buffer (to compare a
partial Buffer use buf.slice()). Numbers will be interpreted as unsigned 8-bit
integer values between 0 and 255.


const buf = new Buffer('this is a buffer');

buf.indexOf('this');
  // returns 0
buf.indexOf('is');
  // returns 2
buf.indexOf(new Buffer('a buffer'));
  // returns 8
buf.indexOf(97); // ascii for 'a'
  // returns 8
buf.indexOf(new Buffer('a buffer example'));
  // returns -1
buf.indexOf(new Buffer('a buffer example').slice(0,8));
  // returns 8

const utf16Buffer = new Buffer('\u039a\u0391\u03a3\u03a3\u0395', 'ucs2');

utf16Buffer.indexOf('\u03a3',  0, 'ucs2');
  // returns 4
utf16Buffer.indexOf('\u03a3', -4, 'ucs2');
  // returns 6



buf.keys()#



Added in: v1.1.0

    

  • Returns: <Iterator>
    • 



Creates and returns an iterator of Buffer keys (indices).


const buf = new Buffer('buffer');
for (var key of buf.keys()) {
  console.log(key);
}
// prints:
//   0
//   1
//   2
//   3
//   4
//   5



buf.length#




Returns the amount of memory allocated for the Buffer in number of bytes. Note
that this does not necessarily reflect the amount of usable data within the
Buffer. For instance, in the example below, a Buffer with 1234 bytes is
allocated, but only 11 ASCII bytes are written.


const buf = new Buffer(1234);

console.log(buf.length);
  // Prints: 1234

buf.write('some string', 0, 'ascii');
console.log(buf.length);
  // Prints: 1234



While the length property is not immutable, changing the value of length
can result in undefined and inconsistent behavior. Applications that wish to
modify the length of a Buffer should therefore treat length as read-only and
use buf.slice() to create a new Buffer.


var buf = new Buffer(10);
buf.write('abcdefghj', 0, 'ascii');
console.log(buf.length);
  // Prints: 10
buf = buf.slice(0,5);
console.log(buf.length);
  // Prints: 5



buf.readDoubleBE(offset[, noAssert])#


buf.readDoubleLE(offset[, noAssert])#




Reads a 64-bit double from the Buffer at the specified offset with specified
endian format (readDoubleBE() returns big endian, readDoubleLE() returns
little endian).


Setting noAssert to true skips validation of the offset. This allows the
offset to be beyond the end of the Buffer.


const buf = new Buffer([1,2,3,4,5,6,7,8]);

buf.readDoubleBE();
  // Returns: 8.20788039913184e-304
buf.readDoubleLE();
  // Returns: 5.447603722011605e-270
buf.readDoubleLE(1);
  // throws RangeError: Index out of range

buf.readDoubleLE(1, true); // Warning: reads passed end of buffer!
  // Segmentation fault! don't do this!



buf.readFloatBE(offset[, noAssert])#


buf.readFloatLE(offset[, noAssert])#




Reads a 32-bit float from the Buffer at the specified offset with specified
endian format (readFloatBE() returns big endian, readFloatLE() returns
little endian).


Setting noAssert to true skips validation of the offset. This allows the
offset to be beyond the end of the Buffer.


const buf = new Buffer([1,2,3,4]);

buf.readFloatBE();
  // Returns: 2.387939260590663e-38
buf.readFloatLE();
  // Returns: 1.539989614439558e-36
buf.readFloatLE(1);
  // throws RangeError: Index out of range

buf.readFloatLE(1, true); // Warning: reads passed end of buffer!
  // Segmentation fault! don't do this!



buf.readInt8(offset[, noAssert])#




Reads a signed 8-bit integer from the Buffer at the specified offset.


Setting noAssert to true skips validation of the offset. This allows the
offset to be beyond the end of the Buffer.


Integers read from the Buffer are interpreted as two's complement signed values.


const buf = new Buffer([1,-2,3,4]);

buf.readInt8(0);
  // returns 1
buf.readInt8(1);
  // returns -2



buf.readInt16BE(offset[, noAssert])#


buf.readInt16LE(offset[, noAssert])#




Reads a signed 16-bit integer from the Buffer at the specified offset with
the specified endian format (readInt16BE() returns big endian,
readInt16LE() returns little endian).


Setting noAssert to true skips validation of the offset. This allows the
offset to be beyond the end of the Buffer.


Integers read from the Buffer are interpreted as two's complement signed values.


const buf = new Buffer([1,-2,3,4]);

buf.readInt16BE();
  // returns 510
buf.readInt16LE(1);
  // returns 1022



buf.readInt32BE(offset[, noAssert])#


buf.readInt32LE(offset[, noAssert])#




Reads a signed 32-bit integer from the Buffer at the specified offset with
the specified endian format (readInt32BE() returns big endian,
readInt32LE() returns little endian).


Setting noAssert to true skips validation of the offset. This allows the
offset to be beyond the end of the Buffer.


Integers read from the Buffer are interpreted as two's complement signed values.


const buf = new Buffer([1,-2,3,4]);

buf.readInt32BE();
  // returns 33424132
buf.readInt32LE();
  // returns 67370497
buf.readInt32LE(1);
  // throws RangeError: Index out of range



buf.readIntBE(offset, byteLength[, noAssert])#


buf.readIntLE(offset, byteLength[, noAssert])#



Added in: v1.0.0



Reads byteLength number of bytes from the Buffer at the specified offset
and interprets the result as a two's complement signed value. Supports up to 48
bits of accuracy. For example:


const buf = new Buffer(6);
buf.writeUInt16LE(0x90ab, 0);
buf.writeUInt32LE(0x12345678, 2);
buf.readIntLE(0, 6).toString(16);  // Specify 6 bytes (48 bits)
// Returns: '1234567890ab'

buf.readIntBE(0, 6).toString(16);
// Returns: -546f87a9cbee



Setting noAssert to true skips validation of the offset. This allows the
offset to be beyond the end of the Buffer.


buf.readUInt8(offset[, noAssert])#




Reads an unsigned 8-bit integer from the Buffer at the specified offset.


Setting noAssert to true skips validation of the offset. This allows the
offset to be beyond the end of the Buffer.


const buf = new Buffer([1,-2,3,4]);

buf.readUInt8(0);
  // returns 1
buf.readUInt8(1);
  // returns 254



buf.readUInt16BE(offset[, noAssert])#


buf.readUInt16LE(offset[, noAssert])#




Reads an unsigned 16-bit integer from the Buffer at the specified offset with
specified endian format (readUInt16BE() returns big endian,
readUInt16LE() returns little endian).


Setting noAssert to true skips validation of the offset. This allows the
offset to be beyond the end of the Buffer.


Example:


const buf = new Buffer([0x3, 0x4, 0x23, 0x42]);

buf.readUInt16BE(0);
  // Returns: 0x0304
buf.readUInt16LE(0);
  // Returns: 0x0403
buf.readUInt16BE(1);
  // Returns: 0x0423
buf.readUInt16LE(1);
  // Returns: 0x2304
buf.readUInt16BE(2);
  // Returns: 0x2342
buf.readUInt16LE(2);
  // Returns: 0x4223



buf.readUInt32BE(offset[, noAssert])#


buf.readUInt32LE(offset[, noAssert])#




Reads an unsigned 32-bit integer from the Buffer at the specified offset with
specified endian format (readUInt32BE() returns big endian,
readUInt32LE() returns little endian).


Setting noAssert to true skips validation of the offset. This allows the
offset to be beyond the end of the Buffer.


Example:


const buf = new Buffer([0x3, 0x4, 0x23, 0x42]);

buf.readUInt32BE(0);
  // Returns: 0x03042342
console.log(buf.readUInt32LE(0));
  // Returns: 0x42230403



buf.readUIntBE(offset, byteLength[, noAssert])#


buf.readUIntLE(offset, byteLength[, noAssert])#



Added in: v1.0.0



Reads byteLength number of bytes from the Buffer at the specified offset
and interprets the result as an unsigned integer. Supports up to 48
bits of accuracy. For example:


const buf = new Buffer(6);
buf.writeUInt16LE(0x90ab, 0);
buf.writeUInt32LE(0x12345678, 2);
buf.readUIntLE(0, 6).toString(16);  // Specify 6 bytes (48 bits)
// Returns: '1234567890ab'

buf.readUIntBE(0, 6).toString(16);
// Returns: ab9078563412



Setting noAssert to true skips validation of the offset. This allows the
offset to be beyond the end of the Buffer.


buf.slice([start[, end]])#




Returns a new Buffer that references the same memory as the original, but
offset and cropped by the start and end indices.


Note that modifying the new Buffer slice will modify the memory in the
original Buffer because the allocated memory of the two objects overlap.


Example: build a Buffer with the ASCII alphabet, take a slice, then modify one
byte from the original Buffer.


const buf1 = new Buffer(26);

for (var i = 0 ; i < 26 ; i++) {
  buf1[i] = i + 97; // 97 is ASCII a
}

const buf2 = buf1.slice(0, 3);
buf2.toString('ascii', 0, buf2.length);
  // Returns: 'abc'
buf1[0] = 33;
buf2.toString('ascii', 0, buf2.length);
  // Returns : '!bc'



Specifying negative indexes causes the slice to be generated relative to the
end of the Buffer rather than the beginning.


const buf = new Buffer('buffer');

buf.slice(-6, -1).toString();
  // Returns 'buffe', equivalent to buf.slice(0, 5)
buf.slice(-6, -2).toString();
  // Returns 'buff', equivalent to buf.slice(0, 4)
buf.slice(-5, -2).toString();
  // Returns 'uff', equivalent to buf.slice(1, 4)



buf.toString([encoding[, start[, end]]])#




Decodes and returns a string from the Buffer data using the specified
character set encoding.


const buf = new Buffer(26);
for (var i = 0 ; i < 26 ; i++) {
  buf[i] = i + 97; // 97 is ASCII a
}
buf.toString('ascii');
  // Returns: 'abcdefghijklmnopqrstuvwxyz'
buf.toString('ascii',0,5);
  // Returns: 'abcde'
buf.toString('utf8',0,5);
  // Returns: 'abcde'
buf.toString(undefined,0,5);
  // Returns: 'abcde', encoding defaults to 'utf8'



buf.toJSON()#



Added in: v0.9.2



Returns a JSON representation of the Buffer instance.  JSON.stringify()
implicitly calls this function when stringifying a Buffer instance.


Example:


const buf = new Buffer('test');
const json = JSON.stringify(buf);

console.log(json);
// Prints: '{"type":"Buffer","data":[116,101,115,116]}'

const copy = JSON.parse(json, (key, value) => {
    return value && value.type === 'Buffer'
      ? new Buffer(value.data)
      : value;
  });

console.log(copy.toString());
// Prints: 'test'



buf.values()#



Added in: v1.1.0

    

  • Returns: <Iterator>
    • 



Creates and returns an iterator for Buffer values (bytes). This function is
called automatically when the Buffer is used in a for..of statement.


const buf = new Buffer('buffer');
for (var value of buf.values()) {
  console.log(value);
}
// prints:
//   98
//   117
//   102
//   102
//   101
//   114

for (var value of buf) {
  console.log(value);
}
// prints:
//   98
//   117
//   102
//   102
//   101
//   114



buf.write(string[, offset[, length]][, encoding])#




Writes string to the Buffer at offset using the given encoding.
The length parameter is the number of bytes to write. If the Buffer did not
contain enough space to fit the entire string, only a partial amount of the
string will be written however, it will not write only partially encoded
characters.


const buf = new Buffer(256);
const len = buf.write('\u00bd + \u00bc = \u00be', 0);
console.log(`${len} bytes: ${buf.toString('utf8', 0, len)}`);
  // Prints: 12 bytes: ½ + ¼ = ¾



buf.writeDoubleBE(value, offset[, noAssert])#


buf.writeDoubleLE(value, offset[, noAssert])#


    

  • value <Number> Bytes to be written to Buffer
    • 

  • offset <Number> 0 <= offset <= buf.length - 8
    • 

  • noAssert <Boolean> Default: false
    • 

  • Returns: <Number> The offset plus the number of written bytes
    • 



Writes value to the Buffer at the specified offset with specified endian
format (writeDoubleBE() writes big endian, writeDoubleLE() writes little
endian). The value argument should be a valid 64-bit double. Behavior is
not defined when value is anything other than a 64-bit double.


Set noAssert to true to skip validation of value and offset. This means
that value may be too large for the specific function and offset may be
beyond the end of the Buffer leading to the values being silently dropped. This
should not be used unless you are certain of correctness.


Example:


const buf = new Buffer(8);
buf.writeDoubleBE(0xdeadbeefcafebabe, 0);

console.log(buf);
  // Prints: <Buffer 43 eb d5 b7 dd f9 5f d7>

buf.writeDoubleLE(0xdeadbeefcafebabe, 0);

console.log(buf);
  // Prints: <Buffer d7 5f f9 dd b7 d5 eb 43>



buf.writeFloatBE(value, offset[, noAssert])#


buf.writeFloatLE(value, offset[, noAssert])#


    

  • value <Number> Bytes to be written to Buffer
    • 

  • offset <Number> 0 <= offset <= buf.length - 4
    • 

  • noAssert <Boolean> Default: false
    • 

  • Returns: <Number> The offset plus the number of written bytes
    • 



Writes value to the Buffer at the specified offset with specified endian
format (writeFloatBE() writes big endian, writeFloatLE() writes little
endian). Behavior is not defined when value is anything other than a 32-bit
float.


Set noAssert to true to skip validation of value and offset. This means
that value may be too large for the specific function and offset may be
beyond the end of the Buffer leading to the values being silently dropped. This
should not be used unless you are certain of correctness.


Example:


const buf = new Buffer(4);
buf.writeFloatBE(0xcafebabe, 0);

console.log(buf);
  // Prints: <Buffer 4f 4a fe bb>

buf.writeFloatLE(0xcafebabe, 0);

console.log(buf);
  // Prints: <Buffer bb fe 4a 4f>



buf.writeInt8(value, offset[, noAssert])#


    

  • value <Number> Bytes to be written to Buffer
    • 

  • offset <Number> 0 <= offset <= buf.length - 1
    • 

  • noAssert <Boolean> Default: false
    • 

  • Returns: <Number> The offset plus the number of written bytes
    • 



Writes value to the Buffer at the specified offset. The value should be a
valid signed 8-bit integer.  Behavior is not defined when value is anything
other than a signed 8-bit integer.


Set noAssert to true to skip validation of value and offset. This means
that value may be too large for the specific function and offset may be
beyond the end of the Buffer leading to the values being silently dropped. This
should not be used unless you are certain of correctness.


The value is interpreted and written as a two's complement signed integer.


const buf = new Buffer(2);
buf.writeInt8(2, 0);
buf.writeInt8(-2, 1);
console.log(buf);
  // Prints: <Buffer 02 fe>



buf.writeInt16BE(value, offset[, noAssert])#


buf.writeInt16LE(value, offset[, noAssert])#


    

  • value <Number> Bytes to be written to Buffer
    • 

  • offset <Number> 0 <= offset <= buf.length - 2
    • 

  • noAssert <Boolean> Default: false
    • 

  • Returns: <Number> The offset plus the number of written bytes
    • 



Writes value to the Buffer at the specified offset with specified endian
format (writeInt16BE() writes big endian, writeInt16LE() writes little
endian). The value should be a valid signed 16-bit integer. Behavior is
not defined when value is anything other than a signed 16-bit integer.


Set noAssert to true to skip validation of value and offset. This means
that value may be too large for the specific function and offset may be
beyond the end of the Buffer leading to the values being silently dropped. This
should not be used unless you are certain of correctness.


The value is interpreted and written as a two's complement signed integer.


const buf = new Buffer(4);
buf.writeInt16BE(0x0102,0);
buf.writeInt16LE(0x0304,2);
console.log(buf);
  // Prints: <Buffer 01 02 04 03>



buf.writeInt32BE(value, offset[, noAssert])#


buf.writeInt32LE(value, offset[, noAssert])#


    

  • value <Number> Bytes to be written to Buffer
    • 

  • offset <Number> 0 <= offset <= buf.length - 4
    • 

  • noAssert <Boolean> Default: false
    • 

  • Returns: <Number> The offset plus the number of written bytes
    • 



Writes value to the Buffer at the specified offset with specified endian
format (writeInt32BE() writes big endian, writeInt32LE() writes little
endian). The value should be a valid signed 32-bit integer. Behavior is
not defined when value is anything other than a signed 32-bit integer.


Set noAssert to true to skip validation of value and offset. This means
that value may be too large for the specific function and offset may be
beyond the end of the Buffer leading to the values being silently dropped. This
should not be used unless you are certain of correctness.


The value is interpreted and written as a two's complement signed integer.


const buf = new Buffer(8);
buf.writeInt32BE(0x01020304,0);
buf.writeInt32LE(0x05060708,4);
console.log(buf);
  // Prints: <Buffer 01 02 03 04 08 07 06 05>



buf.writeIntBE(value, offset, byteLength[, noAssert])#


buf.writeIntLE(value, offset, byteLength[, noAssert])#



Added in: v1.0.0

    

  • value <Number> Bytes to be written to Buffer
    • 

  • offset <Number> 0 <= offset <= buf.length - byteLength
    • 

  • byteLength <Number> 0 < byteLength <= 6
    • 

  • noAssert <Boolean> Default: false
    • 

  • Returns: <Number> The offset plus the number of written bytes
    • 



Writes value to the Buffer at the specified offset and byteLength.
Supports up to 48 bits of accuracy. For example:


const buf1 = new Buffer(6);
buf1.writeUIntBE(0x1234567890ab, 0, 6);
console.log(buf1);
  // Prints: <Buffer 12 34 56 78 90 ab>

const buf2 = new Buffer(6);
buf2.writeUIntLE(0x1234567890ab, 0, 6);
console.log(buf2);
  // Prints: <Buffer ab 90 78 56 34 12>



Set noAssert to true to skip validation of value and offset. This means
that value may be too large for the specific function and offset may be
beyond the end of the Buffer leading to the values being silently dropped. This
should not be used unless you are certain of correctness.


Behavior is not defined when value is anything other than an integer.


buf.writeUInt8(value, offset[, noAssert])#


    

  • value <Number> Bytes to be written to Buffer
    • 

  • offset <Number> 0 <= offset <= buf.length - 1
    • 

  • noAssert <Boolean> Default: false
    • 

  • Returns: <Number> The offset plus the number of written bytes
    • 



Writes value to the Buffer at the specified offset. The value should be a
valid unsigned 8-bit integer.  Behavior is not defined when value is anything
other than an unsigned 8-bit integer.


Set noAssert to true to skip validation of value and offset. This means
that value may be too large for the specific function and offset may be
beyond the end of the Buffer leading to the values being silently dropped. This
should not be used unless you are certain of correctness.


Example:


const buf = new Buffer(4);
buf.writeUInt8(0x3, 0);
buf.writeUInt8(0x4, 1);
buf.writeUInt8(0x23, 2);
buf.writeUInt8(0x42, 3);

console.log(buf);
  // Prints: <Buffer 03 04 23 42>



buf.writeUInt16BE(value, offset[, noAssert])#


buf.writeUInt16LE(value, offset[, noAssert])#


    

  • value <Number> Bytes to be written to Buffer
    • 

  • offset <Number> 0 <= offset <= buf.length - 2
    • 

  • noAssert <Boolean> Default: false
    • 

  • Returns: <Number> The offset plus the number of written bytes
    • 



Writes value to the Buffer at the specified offset with specified endian
format (writeUInt16BE() writes big endian, writeUInt16LE() writes little
endian). The value should be a valid unsigned 16-bit integer. Behavior is
not defined when value is anything other than an unsigned 16-bit integer.


Set noAssert to true to skip validation of value and offset. This means
that value may be too large for the specific function and offset may be
beyond the end of the Buffer leading to the values being silently dropped. This
should not be used unless you are certain of correctness.


Example:


const buf = new Buffer(4);
buf.writeUInt16BE(0xdead, 0);
buf.writeUInt16BE(0xbeef, 2);

console.log(buf);
  // Prints: <Buffer de ad be ef>

buf.writeUInt16LE(0xdead, 0);
buf.writeUInt16LE(0xbeef, 2);

console.log(buf);
  // Prints: <Buffer ad de ef be>



buf.writeUInt32BE(value, offset[, noAssert])#


buf.writeUInt32LE(value, offset[, noAssert])#


    

  • value <Number> Bytes to be written to Buffer
    • 

  • offset <Number> 0 <= offset <= buf.length - 4
    • 

  • noAssert <Boolean> Default: false
    • 

  • Returns: <Number> The offset plus the number of written bytes
    • 



Writes value to the Buffer at the specified offset with specified endian
format (writeUInt32BE() writes big endian, writeUInt32LE() writes little
endian). The value should be a valid unsigned 32-bit integer. Behavior is
not defined when value is anything other than an unsigned 32-bit integer.


Set noAssert to true to skip validation of value and offset. This means
that value may be too large for the specific function and offset may be
beyond the end of the Buffer leading to the values being silently dropped. This
should not be used unless you are certain of correctness.


Example:


const buf = new Buffer(4);
buf.writeUInt32BE(0xfeedface, 0);

console.log(buf);
  // Prints: <Buffer fe ed fa ce>

buf.writeUInt32LE(0xfeedface, 0);

console.log(buf);
  // Prints: <Buffer ce fa ed fe>



buf.writeUIntBE(value, offset, byteLength[, noAssert])#


buf.writeUIntLE(value, offset, byteLength[, noAssert])#


    

  • value <Number> Bytes to be written to Buffer
    • 

  • offset <Number> 0 <= offset <= buf.length - byteLength
    • 

  • byteLength <Number> 0 < byteLength <= 6
    • 

  • noAssert <Boolean> Default: false
    • 

  • Returns: <Number> The offset plus the number of written bytes
    • 



Writes value to the Buffer at the specified offset and byteLength.
Supports up to 48 bits of accuracy. For example:


const buf = new Buffer(6);
buf.writeUIntBE(0x1234567890ab, 0, 6);
console.log(buf);
  // Prints: <Buffer 12 34 56 78 90 ab>



Set noAssert to true to skip validation of value and offset. This means
that value may be too large for the specific function and offset may be
beyond the end of the Buffer leading to the values being silently dropped. This
should not be used unless you are certain of correctness.


Behavior is not defined when value is anything other than an unsigned integer.


buffer.INSPECT_MAX_BYTES#




Returns the maximum number of bytes that will be returned when
buffer.inspect() is called. This can be overridden by user modules. See
util.inspect() for more details on buffer.inspect() behavior.


Note that this is a property on the buffer module as returned by
require('buffer'), not on the Buffer global or a Buffer instance.


Class: SlowBuffer#


Returns an un-pooled Buffer.


In order to avoid the garbage collection overhead of creating many individually
allocated Buffers, by default allocations under 4KB are sliced from a single
larger allocated object. This approach improves both performance and memory
usage since v8 does not need to track and cleanup as many Persistent objects.


In the case where a developer may need to retain a small chunk of memory from a
pool for an indeterminate amount of time, it may be appropriate to create an
un-pooled Buffer instance using SlowBuffer then copy out the relevant bits.


// need to keep around a few small chunks of memory
const store = [];

socket.on('readable', () => {
  var data = socket.read();
  // allocate for retained data
  var sb = new SlowBuffer(10);
  // copy the data into the new allocation
  data.copy(sb, 0, 0, 10);
  store.push(sb);
});



Use of SlowBuffer should be used only as a last resort after a developer
has observed undue memory retention in their applications.


new SlowBuffer(size)#


    

  • size Number
    • 



Allocates a new SlowBuffer of size bytes.  The size must be less than
or equal to the value of require('buffer').kMaxLength (on 64-bit
architectures, kMaxLength is (2^31)-1). Otherwise, a RangeError is
thrown. If a size less than 0 is specified, a zero-length SlowBuffer will be
created.


The underlying memory for SlowBuffer instances is not initialized. The
contents of a newly created SlowBuffer are unknown and could contain
sensitive data. Use buf.fill(0) to initialize a SlowBuffer to zeroes.


const SlowBuffer = require('buffer').SlowBuffer;
const buf = new SlowBuffer(5);
console.log(buf);
  // <Buffer 78 e0 82 02 01>
  // (octets will be different, every time)
buf.fill(0);
console.log(buf);
  // <Buffer 00 00 00 00 00>





Child Process#


Stability: 2 - Stable
The child_process module provides the ability to spawn child processes in
a manner that is similar, but not identical, to popen(3). This capability
is primarily provided by the child_process.spawn() function:


const spawn = require('child_process').spawn;
const ls = spawn('ls', ['-lh', '/usr']);

ls.stdout.on('data', (data) => {
  console.log(`stdout: ${data}`);
});

ls.stderr.on('data', (data) => {
  console.log(`stderr: ${data}`);
});

ls.on('close', (code) => {
  console.log(`child process exited with code ${code}`);
});



By default, pipes for stdin, stdout and stderr are established between
the parent Node.js process and the spawned child. It is possible to stream data
through these pipes in a non-blocking way. Note, however, that some programs
use line-buffered I/O internally. While that does not affect Node.js, it can
mean that data sent to the child process may not be immediately consumed.


The child_process.spawn() method spawns the child process asynchronously,
without blocking the Node.js event loop. The child_process.spawnSync()
function provides equivalent functionality in a synchronous manner that blocks
the event loop until the spawned process either exits or is terminated.


For convenience, the child_process module provides a handful of synchronous
and asynchronous alternatives to child_process.spawn() and
child_process.spawnSync().  Note that each of these alternatives are
implemented on top of child_process.spawn() or child_process.spawnSync().


    

  • child_process.exec(): spawns a shell and runs a command within that shell,
passing the stdout and stderr to a callback function when complete.
    • 

  • child_process.execFile(): similar to child_process.exec() except that
it spawns the command directly without first spawning a shell.
    • 

  • child_process.fork(): spawns a new Node.js process and invokes a
specified module with an IPC communication channel established that allows
sending messages between parent and child.
    • 

  • child_process.execSync(): a synchronous version of
child_process.exec() that will block the Node.js event loop.
    • 

  • child_process.execFileSync(): a synchronous version of
child_process.execFile() that will block the Node.js event loop.
    • 



For certain use cases, such as automating shell scripts, the
synchronous counterparts may be more convenient. In many cases, however,
the synchronous methods can have significant impact on performance due to
stalling the event loop while spawned processes complete.


Asynchronous Process Creation#


The child_process.spawn(), child_process.fork(), child_process.exec(),
and child_process.execFile() methods all follow the idiomatic asynchronous
programming pattern typical of other Node.js APIs.


Each of the methods returns a ChildProcess instance. These objects
implement the Node.js EventEmitter API, allowing the parent process to
register listener functions that are called when certain events occur during
the life cycle of the child process.


The child_process.exec() and child_process.execFile() methods additionally
allow for an optional callback function to be specified that is invoked
when the child process terminates.


Spawning .bat and .cmd files on Windows#


The importance of the distinction between child_process.exec() and
child_process.execFile() can vary based on platform. On Unix-type operating
systems (Unix, Linux, OSX) child_process.execFile() can be more efficient
because it does not spawn a shell. On Windows, however, .bat and .cmd
files are not executable on their own without a terminal, and therefore cannot
be launched using child_process.execFile(). When running on Windows, .bat
and .cmd files can be invoked using child_process.spawn() with the shell
option set, with child_process.exec(), or by spawning cmd.exe and passing
the .bat or .cmd file as an argument (which is what the shell option and
child_process.exec() do).


// On Windows Only ...
const spawn = require('child_process').spawn;
const bat = spawn('cmd.exe', ['/c', 'my.bat']);

bat.stdout.on('data', (data) => {
  console.log(data);
});

bat.stderr.on('data', (data) => {
  console.log(data);
});

bat.on('exit', (code) => {
  console.log(`Child exited with code ${code}`);
});

// OR...
const exec = require('child_process').exec;
exec('my.bat', (err, stdout, stderr) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log(stdout);
});



child_process.exec(command[, options][, callback])#



Added in: v0.1.90

    

  • command <String> The command to run, with space-separated arguments
    • 

  • options <Object>
      

    • cwd <String> Current working directory of the child process
      • 

    • env <Object> Environment key-value pairs
      • 

    • encoding <String> (Default: 'utf8')
      • 

    • shell <String> Shell to execute the command with
(Default: '/bin/sh' on UNIX, 'cmd.exe' on Windows,  The shell should
 understand the -c switch on UNIX or /s /c on Windows. On Windows,
 command line parsing should be compatible with cmd.exe.)
      • 

    • timeout <Number> (Default: 0)
      • 

    • maxBuffer <Number> largest amount of data (in bytes) allowed on stdout or
stderr - if exceeded child process is killed (Default: 200*1024)
      • 

    • killSignal <String> | <Integer> (Default: 'SIGTERM')
      • 

    • uid <Number> Sets the user identity of the process. (See setuid(2).)
      • 

    • gid <Number> Sets the group identity of the process. (See setgid(2).)
      • 

    

    • 

  • callback <Function> called with the output when process terminates

    • 

  • Returns: <ChildProcess>
    • 



Spawns a shell then executes the command within that shell, buffering any
generated output.


Note: Never pass unsanitised user input to this function. Any input
containing shell metacharacters may be used to trigger arbitrary command
execution.


const exec = require('child_process').exec;
exec('cat *.js bad_file | wc -l', (error, stdout, stderr) => {
  if (error) {
    console.error(`exec error: ${error}`);
    return;
  }
  console.log(`stdout: ${stdout}`);
  console.log(`stderr: ${stderr}`);
});



If a callback function is provided, it is called with the arguments
(error, stdout, stderr). On success, error will be null.  On error,
error will be an instance of Error. The error.code property will be
the exit code of the child process while error.signal will be set to the
signal that terminated the process. Any exit code other than 0 is considered
to be an error.


The stdout and stderr arguments passed to the callback will contain the
stdout and stderr output of the child process. By default, Node.js will decode
the output as UTF-8 and pass strings to the callback. The encoding option
can be used to specify the character encoding used to decode the stdout and
stderr output. If encoding is 'buffer', or an unrecognized character
encoding, Buffer objects will be passed to the callback instead.


The options argument may be passed as the second argument to customize how
the process is spawned. The default options are:


{
  encoding: 'utf8',
  timeout: 0,
  maxBuffer: 200*1024,
  killSignal: 'SIGTERM',
  cwd: null,
  env: null
}



If timeout is greater than 0, the parent will send the the signal
identified by the killSignal property (the default is 'SIGTERM') if the
child runs longer than timeout milliseconds.


The maxBuffer option specifies the largest amount of data (in bytes) allowed
on stdout or stderr - if this value is exceeded then the child process is
terminated.


Note: Unlike the exec() POSIX system call, child_process.exec() does not
replace the existing process and uses a shell to execute the command.


child_process.execFile(file[, args][, options][, callback])#



Added in: v0.1.91



The child_process.execFile() function is similar to child_process.exec()
except that it does not spawn a shell. Rather, the specified executable file
is spawned directly as a new process making it slightly more efficient than
child_process.exec().


The same options as child_process.exec() are supported. Since a shell is not
spawned, behaviors such as I/O redirection and file globbing are not supported.


const execFile = require('child_process').execFile;
const child = execFile('node', ['--version'], (error, stdout, stderr) => {
  if (error) {
    throw error;
  }
  console.log(stdout);
});



The stdout and stderr arguments passed to the callback will contain the
stdout and stderr output of the child process. By default, Node.js will decode
the output as UTF-8 and pass strings to the callback. The encoding option
can be used to specify the character encoding used to decode the stdout and
stderr output. If encoding is 'buffer', or an unrecognized character
encoding, Buffer objects will be passed to the callback instead.


child_process.fork(modulePath[, args][, options])#



Added in: v0.5.0

    

  • modulePath <String> The module to run in the child
    • 

  • args <Array> List of string arguments
    • 

  • options <Object>
      

    • cwd <String> Current working directory of the child process
      • 

    • env <Object> Environment key-value pairs
      • 

    • execPath <String> Executable used to create the child process
      • 

    • execArgv <Array> List of string arguments passed to the executable
(Default: process.execArgv)
      • 

    • silent <Boolean> If true, stdin, stdout, and stderr of the child will be
piped to the parent, otherwise they will be inherited from the parent, see
the 'pipe' and 'inherit' options for child_process.spawn()'s
stdio for more details (default is false)
      • 

    • uid <Number> Sets the user identity of the process. (See setuid(2).)
      • 

    • gid <Number> Sets the group identity of the process. (See setgid(2).)
      • 

    

    • 

  • Returns: <ChildProcess>
    • 



The child_process.fork() method is a special case of
child_process.spawn() used specifically to spawn new Node.js processes.
Like child_process.spawn(), a ChildProcess object is returned. The returned
ChildProcess will have an additional communication channel built-in that
allows messages to be passed back and forth between the parent and child. See
ChildProcess#send() for details.


It is important to keep in mind that spawned Node.js child processes are
independent of the parent with exception of the IPC communication channel
that is established between the two. Each process has its own memory, with
their own V8 instances. Because of the additional resource allocations
required, spawning a large number of child Node.js processes is not
recommended.


By default, child_process.fork() will spawn new Node.js instances using the
process.execPath of the parent process. The execPath property in the
options object allows for an alternative execution path to be used.


Node.js processes launched with a custom execPath will communicate with the
parent process using the file descriptor (fd) identified using the
environment variable NODE_CHANNEL_FD on the child process. The input and
output on this fd is expected to be line delimited JSON objects.


Note: Unlike the fork() POSIX system call, child_process.fork() does
not clone the current process.


child_process.spawn(command[, args][, options])#



Added in: v0.1.90

    

  • command <String> The command to run
    • 

  • args <Array> List of string arguments
    • 

  • options <Object>
      

    • cwd <String> Current working directory of the child process
      • 

    • env <Object> Environment key-value pairs
      • 

    • stdio <Array> | <String> Child's stdio configuration. (See
options.stdio)
      • 

    • detached <Boolean> Prepare child to run independently of its parent
process. Specific behavior depends on the platform, see
options.detached)
      • 

    • uid <Number> Sets the user identity of the process. (See setuid(2).)
      • 

    • gid <Number> Sets the group identity of the process. (See setgid(2).)
      • 

    • shell <Boolean> | <String> If true, runs command inside of a shell. Uses
'/bin/sh' on UNIX, and 'cmd.exe' on Windows. A different shell can be
specified as a string. The shell should understand the -c switch on UNIX,
or /s /c on Windows. Defaults to false (no shell).
      • 

    

    • 

  • Returns: <ChildProcess>
    • 



The child_process.spawn() method spawns a new process using the given
command, with command line arguments in args. If omitted, args defaults
to an empty array.


Note: If the shell option is enabled, do not pass unsanitised user input to
this function. Any input containing shell metacharacters may be used to
trigger arbitrary command execution.


A third argument may be used to specify additional options, with these defaults:


{
  cwd: undefined,
  env: process.env
}



Use cwd to specify the working directory from which the process is spawned.
If not given, the default is to inherit the current working directory.


Use env to specify environment variables that will be visible to the new
process, the default is process.env.


Example of running ls -lh /usr, capturing stdout, stderr, and the
exit code:


const spawn = require('child_process').spawn;
const ls = spawn('ls', ['-lh', '/usr']);

ls.stdout.on('data', (data) => {
  console.log(`stdout: ${data}`);
});

ls.stderr.on('data', (data) => {
  console.log(`stderr: ${data}`);
});

ls.on('close', (code) => {
  console.log(`child process exited with code ${code}`);
});



Example: A very elaborate way to run 'ps ax | grep ssh'


const spawn = require('child_process').spawn;
const ps = spawn('ps', ['ax']);
const grep = spawn('grep', ['ssh']);

ps.stdout.on('data', (data) => {
  grep.stdin.write(data);
});

ps.stderr.on('data', (data) => {
  console.log(`ps stderr: ${data}`);
});

ps.on('close', (code) => {
  if (code !== 0) {
    console.log(`ps process exited with code ${code}`);
  }
  grep.stdin.end();
});

grep.stdout.on('data', (data) => {
  console.log(`${data}`);
});

grep.stderr.on('data', (data) => {
  console.log(`grep stderr: ${data}`);
});

grep.on('close', (code) => {
  if (code !== 0) {
    console.log(`grep process exited with code ${code}`);
  }
});



Example of checking for failed exec:


const spawn = require('child_process').spawn;
const child = spawn('bad_command');

child.on('error', (err) => {
  console.log('Failed to start child process.');
});



options.detached#



Added in: v0.7.10

On Windows, setting options.detached to true makes it possible for the
child process to continue running after the parent exits. The child will have
its own console window. Once enabled for a child process, it cannot be
disabled.


On non-Windows platforms, if options.detached is set to true, the child
process will be made the leader of a new process group and session. Note that
child processes may continue running after the parent exits regardless of
whether they are detached or not.  See setsid(2) for more information.


By default, the parent will wait for the detached child to exit. To prevent
the parent from waiting for a given child, use the child.unref() method.
Doing so will cause the parent's event loop to not include the child in its
reference count, allowing the parent to exit independently of the child, unless
there is an established IPC channel between the child and parent.


When using the detached option to start a long-running process, the process
will not stay running in the background after the parent exits unless it is
provided with a stdio configuration that is not connected to the parent.
If the parent's stdio is inherited, the child will remain attached to the
controlling terminal.


Example of a long-running process, by detaching and also ignoring its parent
stdio file descriptors, in order to ignore the parent's termination:


const spawn = require('child_process').spawn;

const child = spawn(process.argv[0], ['child_program.js'], {
  detached: true,
  stdio: 'ignore'
});

child.unref();



Alternatively one can redirect the child process' output into files:


const fs = require('fs');
const spawn = require('child_process').spawn;
const out = fs.openSync('./out.log', 'a');
const err = fs.openSync('./out.log', 'a');

const child = spawn('prg', [], {
 detached: true,
 stdio: [ 'ignore', out, err ]
});

child.unref();



options.stdio#



Added in: v0.7.10

The options.stdio option is used to configure the pipes that are established
between the parent and child process. By default, the child's stdin, stdout,
and stderr are redirected to corresponding child.stdin, child.stdout, and
child.stderr streams on the ChildProcess object. This is equivalent to
setting the options.stdio equal to ['pipe', 'pipe', 'pipe'].


For convenience, options.stdio may be one of the following strings:


    

  • 'pipe' - equivalent to ['pipe', 'pipe', 'pipe'] (the default)
    • 

  • 'ignore' - equivalent to ['ignore', 'ignore', 'ignore']
    • 

  • 'inherit' - equivalent to [process.stdin, process.stdout, process.stderr]
 or [0,1,2]
    • 



Otherwise, the value of option.stdio is an array where each index corresponds
to an fd in the child. The fds 0, 1, and 2 correspond to stdin, stdout,
and stderr, respectively. Additional fds can be specified to create additional
pipes between the parent and child. The value is one of the following:


    

  1. 'pipe' - Create a pipe between the child process and the parent process.
The parent end of the pipe is exposed to the parent as a property on the
child_process object as ChildProcess.stdio[fd]. Pipes created for
fds 0 - 2 are also available as ChildProcess.stdin, ChildProcess.stdout
and ChildProcess.stderr, respectively.
    2. 

  2. 'ipc' - Create an IPC channel for passing messages/file descriptors
between parent and child. A ChildProcess may have at most one IPC stdio
file descriptor. Setting this option enables the ChildProcess.send() method.
If the child writes JSON messages to this file descriptor, the
ChildProcess.on('message') event handler will be triggered in the parent.
If the child is a Node.js process, the presence of an IPC channel will enable
process.send(), process.disconnect(), process.on('disconnect'), and
process.on('message') within the child.
    3. 

  3. 'ignore' - Instructs Node.js to ignore the fd in the child. While Node.js
will always open fds 0 - 2 for the processes it spawns, setting the fd to
'ignore' will cause Node.js to open /dev/null and attach it to the
child's fd.
    4. 

  4. Stream object - Share a readable or writable stream that refers to a tty,
file, socket, or a pipe with the child process. The stream's underlying
file descriptor is duplicated in the child process to the fd that
corresponds to the index in the stdio array. Note that the stream must
have an underlying descriptor (file streams do not until the 'open'
event has occurred).
    5. 

  5. Positive integer - The integer value is interpreted as a file descriptor
that is is currently open in the parent process. It is shared with the child
process, similar to how Stream objects can be shared.
    6. 

  6. null, undefined - Use default value. For stdio fds 0, 1 and 2 (in other
words, stdin, stdout, and stderr) a pipe is created. For fd 3 and up, the
default is 'ignore'.
    7. 



Example:


const spawn = require('child_process').spawn;

// Child will use parent's stdios
spawn('prg', [], { stdio: 'inherit' });

// Spawn child sharing only stderr
spawn('prg', [], { stdio: ['pipe', 'pipe', process.stderr] });

// Open an extra fd=4, to interact with programs presenting a
// startd-style interface.
spawn('prg', [], { stdio: ['pipe', null, null, null, 'pipe'] });



It is worth noting that when an IPC channel is established between the
parent and child processes, and the child is a Node.js process, the child
is launched with the IPC channel unreferenced (using unref()) until the
child registers an event handler for the process.on('disconnect') event
or the process.on('message') event.This allows the child to exit normally
without the process being held open by the open IPC channel.


See also: child_process.exec() and child_process.fork()


Synchronous Process Creation#


The child_process.spawnSync(), child_process.execSync(), and
child_process.execFileSync() methods are synchronous and WILL block
the Node.js event loop, pausing execution of any additional code until the
spawned process exits.


Blocking calls like these are mostly useful for simplifying general purpose
scripting tasks and for simplifying the loading/processing of application
configuration at startup.


child_process.execFileSync(file[, args][, options])#



Added in: v0.11.12

    

  • file <String> The name or path of the executable file to run
    • 

  • args <Array> List of string arguments
    • 

  • options <Object>
      

    • cwd <String> Current working directory of the child process
      • 

    • input <String> | <Buffer> The value which will be passed as stdin to the spawned process
        

      • supplying this value will override stdio[0]
        • 

      

      • 

    • stdio <String> | <Array> Child's stdio configuration. (Default: 'pipe')
        

      • stderr by default will be output to the parent process' stderr unless
stdio is specified
        • 

      

      • 

    • env <Object> Environment key-value pairs
      • 

    • uid <Number> Sets the user identity of the process. (See setuid(2).)
      • 

    • gid <Number> Sets the group identity of the process. (See setgid(2).)
      • 

    • timeout <Number> In milliseconds the maximum amount of time the process is allowed to run. (Default: undefined)
      • 

    • killSignal <String> | <Integer> The signal value to be used when the spawned process will be killed. (Default: 'SIGTERM')
      • 

    • maxBuffer <Number> largest amount of data (in bytes) allowed on stdout or
stderr - if exceeded child process is killed
      • 

    • encoding <String> The encoding used for all stdio inputs and outputs. (Default: 'buffer')
      • 

    

    • 

  • Returns: <Buffer> | <String> The stdout from the command
    • 



The child_process.execFileSync() method is generally identical to
child_process.execFile() with the exception that the method will not return
until the child process has fully closed. When a timeout has been encountered
and killSignal is sent, the method won't return until the process has
completely exited. Note that if the child process intercepts and handles
the SIGTERM signal and does not exit, the parent process will still wait
until the child process has exited.


If the process times out, or has a non-zero exit code, this method will
throw.  The Error object will contain the entire result from
child_process.spawnSync()


child_process.execSync(command[, options])#



Added in: v0.11.12

    

  • command <String> The command to run
    • 

  • options <Object>
      

    • cwd <String> Current working directory of the child process
      • 

    • input <String> | <Buffer> The value which will be passed as stdin to the spawned process
        

      • supplying this value will override stdio[0]
        • 

      

      • 

    • stdio <String> | <Array> Child's stdio configuration. (Default: 'pipe')
        

      • stderr by default will be output to the parent process' stderr unless
stdio is specified
        • 

      

      • 

    • env <Object> Environment key-value pairs
      • 

    • shell <String> Shell to execute the command with
(Default: '/bin/sh' on UNIX, 'cmd.exe' on Windows,  The shell should
 understand the -c switch on UNIX or /s /c on Windows. On Windows,
 command line parsing should be compatible with cmd.exe.)
      • 

    • uid <Number> Sets the user identity of the process. (See setuid(2).)
      • 

    • gid <Number> Sets the group identity of the process. (See setgid(2).)
      • 

    • timeout <Number> In milliseconds the maximum amount of time the process is allowed to run. (Default: undefined)
      • 

    • killSignal <String> | <Integer> The signal value to be used when the spawned process will be killed. (Default: 'SIGTERM')
      • 

    • maxBuffer <Number> largest amount of data (in bytes) allowed on stdout or
stderr - if exceeded child process is killed
      • 

    • encoding <String> The encoding used for all stdio inputs and outputs. (Default: 'buffer')
      • 

    

    • 

  • Returns: <Buffer> | <String> The stdout from the command
    • 



The child_process.execSync() method is generally identical to
child_process.exec() with the exception that the method will not return until
the child process has fully closed. When a timeout has been encountered and
killSignal is sent, the method won't return until the process has completely
exited. Note that if  the child process intercepts and handles the SIGTERM
signal and doesn't exit, the parent process will wait until the child
process has exited.


If the process times out, or has a non-zero exit code, this method will
throw.  The Error object will contain the entire result from
child_process.spawnSync()


Note: Never pass unsanitised user input to this function. Any input
containing shell metacharacters may be used to trigger arbitrary command
execution.


child_process.spawnSync(command[, args][, options])#



Added in: v0.11.12

    

  • command <String> The command to run
    • 

  • args <Array> List of string arguments
    • 

  • options <Object>
      

    • cwd <String> Current working directory of the child process
      • 

    • input <String> | <Buffer> The value which will be passed as stdin to the spawned process
        

      • supplying this value will override stdio[0]
        • 

      

      • 

    • stdio <String> | <Array> Child's stdio configuration. (Default: 'pipe')
      • 

    • env <Object> Environment key-value pairs
      • 

    • uid <Number> Sets the user identity of the process. (See setuid(2).)
      • 

    • gid <Number> Sets the group identity of the process. (See setgid(2).)
      • 

    • timeout <Number> In milliseconds the maximum amount of time the process is allowed to run. (Default: undefined)
      • 

    • killSignal <String> | <Integer> The signal value to be used when the spawned process will be killed. (Default: 'SIGTERM')
      • 

    • maxBuffer <Number> largest amount of data (in bytes) allowed on stdout or
stderr - if exceeded child process is killed
      • 

    • encoding <String> The encoding used for all stdio inputs and outputs. (Default: 'buffer')
      • 

    • shell <Boolean> | <String> If true, runs command inside of a shell. Uses
'/bin/sh' on UNIX, and 'cmd.exe' on Windows. A different shell can be
specified as a string. The shell should understand the -c switch on UNIX,
or /s /c on Windows. Defaults to false (no shell).
      • 

    

    • 

  • Returns: <Object>
      

    • pid <Number> Pid of the child process
      • 

    • output <Array> Array of results from stdio output
      • 

    • stdout <Buffer> | <String> The contents of output[1]
      • 

    • stderr <Buffer> | <String> The contents of output[2]
      • 

    • status <Number> The exit code of the child process
      • 

    • signal <String> The signal used to kill the child process
      • 

    • error <Error> The error object if the child process failed or timed out
      • 

    

    • 



The child_process.spawnSync() method is generally identical to
child_process.spawn() with the exception that the function will not return
until the child process has fully closed. When a timeout has been encountered
and killSignal is sent, the method won't return until the process has
completely exited. Note that if the process intercepts and handles the
SIGTERM signal and doesn't exit, the parent process will wait until the child
process has exited.


Note: If the shell option is enabled, do not pass unsanitised user input to
this function. Any input containing shell metacharacters may be used to
trigger arbitrary command execution.


Class: ChildProcess#



Added in: v2.2.0

Instances of the ChildProcess class are EventEmitters that represent
spawned child processes.


Instances of ChildProcess are not intended to be created directly. Rather,
use the child_process.spawn(), child_process.exec(),
child_process.execFile(), or child_process.fork() methods to create
instances of ChildProcess.


Event: 'close'#



Added in: v0.7.7

    

  • code <Number> the exit code if the child exited on its own.
    • 

  • signal <String> the signal by which the child process was terminated.
    • 



The 'close' event is emitted when the stdio streams of a child process have
been closed. This is distinct from the 'exit' event, since multiple
processes might share the same stdio streams.


Event: 'disconnect'#



Added in: v0.7.2

The 'disconnect' event is emitted after calling the
ChildProcess.disconnect() method in the parent or child process. After
disconnecting it is no longer possible to send or receive messages, and the
ChildProcess.connected property is false.


Event: 'error'#




The 'error' event is emitted whenever:


    

  1. The process could not be spawned, or
    2. 

  2. The process could not be killed, or
    3. 

  3. Sending a message to the child process failed.
    4. 



Note that the 'exit' event may or may not fire after an error has occurred.
If you are listening to both the 'exit' and 'error' events, it is important
to guard against accidentally invoking handler functions multiple times.


See also ChildProcess#kill() and ChildProcess#send().


Event: 'exit'#



Added in: v0.1.90

    

  • code <Number> the exit code if the child exited on its own.
    • 

  • signal <String> the signal by which the child process was terminated.
    • 



The 'exit' event is emitted after the child process ends. If the process
exited, code is the final exit code of the process, otherwise null. If the
process terminated due to receipt of a signal, signal is the string name of
the signal, otherwise null. One of the two will always be non-null.


Note that when the 'exit' event is triggered, child process stdio streams
might still be open.


Also, note that Node.js establishes signal handlers for SIGINT and
SIGTERM and Node.js processes will not terminate immediately due to receipt
of those signals. Rather, Node.js will perform a sequence of cleanup actions
and then will re-raise the handled signal.


See waitpid(2).


Event: 'message'#



Added in: v0.5.9



The 'message' event is triggered when a child process uses process.send()
to send messages.


child.connected#



Added in: v0.7.2

    

  • <Boolean> Set to false after .disconnect is called
    • 



The child.connected property indicates whether it is still possible to send
and receive messages from a child process. When child.connected is false, it
is no longer possible to send or receive messages.


child.disconnect()#



Added in: v0.7.2

Closes the IPC channel between parent and child, allowing the child to exit
gracefully once there are no other connections keeping it alive. After calling
this method the child.connected and process.connected properties in both
the parent and child (respectively) will be set to false, and it will be no
longer possible to pass messages between the processes.


The 'disconnect' event will be emitted when there are no messages in the
process of being received. This will most often be triggered immediately after
calling child.disconnect().


Note that when the child process is a Node.js instance (e.g. spawned using
child_process.fork()), the process.disconnect() method can be invoked
within the child process to close the IPC channel as well.


child.kill([signal])#



Added in: v0.1.90



The child.kill() methods sends a signal to the child process. If no argument
is given, the process will be sent the 'SIGTERM' signal. See signal(7) for
a list of available signals.


const spawn = require('child_process').spawn;
const grep = spawn('grep', ['ssh']);

grep.on('close', (code, signal) => {
  console.log(
    `child process terminated due to receipt of signal ${signal}`);
});

// Send SIGHUP to process
grep.kill('SIGHUP');



The ChildProcess object may emit an 'error' event if the signal cannot be
delivered. Sending a signal to a child process that has already exited is not
an error but may have unforeseen consequences. Specifically, if the process
identifier (PID) has been reassigned to another process, the signal will be
delivered to that process instead which can have unexpected results.


Note that while the function is called kill, the signal delivered to the
child process may not actually terminate the process.


See kill(2) for reference.


Also note: on Linux, child processes of child processes will not be terminated
when attempting to kill their parent. This is likely to happen when running a
new process in a shell or with use of the shell option of ChildProcess, such
as in this example:


'use strict';
const spawn = require('child_process').spawn;

let child = spawn('sh', ['-c',
  `node -e "setInterval(() => {
      console.log(process.pid, 'is alive')
    }, 500);"`
  ], {
    stdio: ['inherit', 'inherit', 'inherit']
  });

setTimeout(() => {
  child.kill(); // does not terminate the node process in the shell
}, 2000);



child.pid#



Added in: v0.1.90



Returns the process identifier (PID) of the child process.


Example:


const spawn = require('child_process').spawn;
const grep = spawn('grep', ['ssh']);

console.log(`Spawned child pid: ${grep.pid}`);
grep.stdin.end();



child.send(message[, sendHandle][, callback])#



Added in: v0.5.9



When an IPC channel has been established between the parent and child (
i.e. when using child_process.fork()), the child.send() method can be
used to send messages to the child process. When the child process is a Node.js
instance, these messages can be received via the process.on('message') event.


For example, in the parent script:


const cp = require('child_process');
const n = cp.fork(`${__dirname}/sub.js`);

n.on('message', (m) => {
  console.log('PARENT got message:', m);
});

n.send({ hello: 'world' });



And then the child script, 'sub.js' might look like this:


process.on('message', (m) => {
  console.log('CHILD got message:', m);
});

process.send({ foo: 'bar' });



Child Node.js processes will have a process.send() method of their own that
allows the child to send messages back to the parent.


There is a special case when sending a {cmd: 'NODE_foo'} message. All messages
containing a NODE_ prefix in its cmd property are considered to be reserved
for use within Node.js core and will not be emitted in the child's
process.on('message') event. Rather, such messages are emitted using the
process.on('internalMessage') event and are consumed internally by Node.js.
Applications should avoid using such messages or listening for
'internalMessage' events as it is subject to change without notice.


The optional sendHandle argument that may be passed to child.send() is for
passing a TCP server or socket object to the child process. The child will
receive the object as the second argument passed to the callback function
registered on the process.on('message') event. Any data that is received and
buffered in the socket will not be sent to the child.


The optional callback is a function that is invoked after the message is
sent but before the child may have received it.  The function is called with a
single argument: null on success, or an Error object on failure.


If no callback function is provided and the message cannot be sent, an
'error' event will be emitted by the ChildProcess object. This can happen,
for instance, when the child process has already exited.


child.send() will return false if the channel has closed or when the
backlog of unsent messages exceeds a threshold that makes it unwise to send
more. Otherwise, the method returns true. The callback function can be
used to implement flow control.


Example: sending a server object#


The sendHandle argument can be used, for instance, to pass the handle of
a TCP server object to the child process as illustrated in the example below:


const child = require('child_process').fork('child.js');

// Open up the server object and send the handle.
const server = require('net').createServer();
server.on('connection', (socket) => {
  socket.end('handled by parent');
});
server.listen(1337, () => {
  child.send('server', server);
});



The child would then receive the server object as:


process.on('message', (m, server) => {
  if (m === 'server') {
    server.on('connection', (socket) => {
      socket.end('handled by child');
    });
  }
});



Once the server is now shared between the parent and child, some connections
can be handled by the parent and some by the child.


While the example above uses a server created using the net module, dgram
module servers use exactly the same workflow with the exceptions of listening on
a 'message' event instead of 'connection' and using server.bind instead of
server.listen. This is, however, currently only supported on UNIX platforms.


Example: sending a socket object#


Similarly, the sendHandler argument can be used to pass the handle of a
socket to the child process. The example below spawns two children that each
handle connections with "normal" or "special" priority:


const normal = require('child_process').fork('child.js', ['normal']);
const special = require('child_process').fork('child.js', ['special']);

// Open up the server and send sockets to child
const server = require('net').createServer();
server.on('connection', (socket) => {

  // If this is special priority
  if (socket.remoteAddress === '74.125.127.100') {
    special.send('socket', socket);
    return;
  }
  // This is normal priority
  normal.send('socket', socket);
});
server.listen(1337);



The child.js would receive the socket handle as the second argument passed
to the event callback function:


process.on('message', (m, socket) => {
  if (m === 'socket') {
    socket.end(`Request handled with ${process.argv[2]} priority`);
  }
});



Once a socket has been passed to a child, the parent is no longer capable of
tracking when the socket is destroyed. To indicate this, the .connections
property becomes null. It is recommended not to use .maxConnections when
this occurs.


Note: this function uses JSON.stringify() internally to serialize the message.


child.stderr#



Added in: v0.1.90



A Readable Stream that represents the child process's stderr.


If the child was spawned with stdio[2] set to anything other than 'pipe',
then this will be undefined.


child.stderr is an alias for child.stdio[2]. Both properties will refer to
the same value.


child.stdin#



Added in: v0.1.90



A Writable Stream that represents the child process's stdin.


Note that if a child process waits to read all of its input, the child will not
continue until this stream has been closed via end().


If the child was spawned with stdio[0] set to anything other than 'pipe',
then this will be undefined.


child.stdin is an alias for child.stdio[0]. Both properties will refer to
the same value.


child.stdio#



Added in: v0.7.10



A sparse array of pipes to the child process, corresponding with positions in
the stdio option passed to child_process.spawn() that have been set
to the value 'pipe'. Note that child.stdio[0], child.stdio[1], and
child.stdio[2] are also available as child.stdin, child.stdout, and
child.stderr, respectively.


In the following example, only the child's fd 1 (stdout) is configured as a
pipe, so only the parent's child.stdio[1] is a stream, all other values in
the array are null.


const assert = require('assert');
const fs = require('fs');
const child_process = require('child_process');

const child = child_process.spawn('ls', {
    stdio: [
      0, // Use parents stdin for child
      'pipe', // Pipe child's stdout to parent
      fs.openSync('err.out', 'w') // Direct child's stderr to a file
    ]
});

assert.equal(child.stdio[0], null);
assert.equal(child.stdio[0], child.stdin);

assert(child.stdout);
assert.equal(child.stdio[1], child.stdout);

assert.equal(child.stdio[2], null);
assert.equal(child.stdio[2], child.stderr);



child.stdout#



Added in: v0.1.90



A Readable Stream that represents the child process's stdout.


If the child was spawned with stdio[1] set to anything other than 'pipe',
then this will be undefined.


child.stdout is an alias for child.stdio[1]. Both properties will refer
to the same value.




Cluster#


Stability: 2 - Stable
A single instance of Node.js runs in a single thread. To take advantage of
multi-core systems the user will sometimes want to launch a cluster of Node.js
processes to handle the load.


The cluster module allows you to easily create child processes that
all share server ports.


const cluster = require('cluster');
const http = require('http');
const numCPUs = require('os').cpus().length;

if (cluster.isMaster) {
  // Fork workers.
  for (var i = 0; i < numCPUs; i++) {
    cluster.fork();
  }

  cluster.on('exit', (worker, code, signal) => {
    console.log(`worker ${worker.process.pid} died`);
  });
} else {
  // Workers can share any TCP connection
  // In this case it is an HTTP server
  http.createServer((req, res) => {
    res.writeHead(200);
    res.end('hello world\n');
  }).listen(8000);
}



Running Node.js will now share port 8000 between the workers:


$ NODE_DEBUG=cluster node server.js
23521,Master Worker 23524 online
23521,Master Worker 23526 online
23521,Master Worker 23523 online
23521,Master Worker 23528 online

Please note that, on Windows, it is not yet possible to set up a named pipe
server in a worker.


How It Works#



The worker processes are spawned using the child_process.fork() method,
so that they can communicate with the parent via IPC and pass server
handles back and forth.


The cluster module supports two methods of distributing incoming
connections.


The first one (and the default one on all platforms except Windows),
is the round-robin approach, where the master process listens on a
port, accepts new connections and distributes them across the workers
in a round-robin fashion, with some built-in smarts to avoid
overloading a worker process.


The second approach is where the master process creates the listen
socket and sends it to interested workers. The workers then accept
incoming connections directly.


The second approach should, in theory, give the best performance.
In practice however, distribution tends to be very unbalanced due
to operating system scheduler vagaries. Loads have been observed
where over 70% of all connections ended up in just two processes,
out of a total of eight.


Because server.listen() hands off most of the work to the master
process, there are three cases where the behavior between a normal
Node.js process and a cluster worker differs:


    

  1. server.listen({fd: 7}) Because the message is passed to the master,
file descriptor 7 in the parent will be listened on, and the
handle passed to the worker, rather than listening to the worker's
idea of what the number 7 file descriptor references.
    2. 

  2. server.listen(handle) Listening on handles explicitly will cause
the worker to use the supplied handle, rather than talk to the master
process.  If the worker already has the handle, then it's presumed
that you know what you are doing.
    3. 

  3. server.listen(0) Normally, this will cause servers to listen on a
random port.  However, in a cluster, each worker will receive the
same "random" port each time they do listen(0).  In essence, the
port is random the first time, but predictable thereafter.  If you
want to listen on a unique port, generate a port number based on the
cluster worker ID.
    4. 



There is no routing logic in Node.js, or in your program, and no shared
state between the workers.  Therefore, it is important to design your
program such that it does not rely too heavily on in-memory data objects
for things like sessions and login.


Because workers are all separate processes, they can be killed or
re-spawned depending on your program's needs, without affecting other
workers.  As long as there are some workers still alive, the server will
continue to accept connections.  If no workers are alive, existing connections
will be dropped and new connections will be refused.  Node.js does not
automatically manage the number of workers for you, however.  It is your
responsibility to manage the worker pool for your application's needs.


Class: Worker#



Added in: v0.7.0

A Worker object contains all public information and method about a worker.
In the master it can be obtained using cluster.workers. In a worker
it can be obtained using cluster.worker.


Event: 'disconnect'#



Added in: v0.7.7

Similar to the cluster.on('disconnect') event, but specific to this worker.


cluster.fork().on('disconnect', () => {
  // Worker has disconnected
});



Event: 'error'#



Added in: v0.7.3

This event is the same as the one provided by child_process.fork().


In a worker you can also use process.on('error').


Event: 'exit'#



Added in: v0.11.2

    

  • code <Number> the exit code, if it exited normally.
    • 

  • signal <String> the name of the signal (e.g. 'SIGHUP') that caused
the process to be killed.
    • 



Similar to the cluster.on('exit') event, but specific to this worker.


const worker = cluster.fork();
worker.on('exit', (code, signal) => {
  if (signal) {
    console.log(`worker was killed by signal: ${signal}`);
  } else if (code !== 0) {
    console.log(`worker exited with error code: ${code}`);
  } else {
    console.log('worker success!');
  }
});



Event: 'listening'#



Added in: v0.7.0



Similar to the cluster.on('listening') event, but specific to this worker.


cluster.fork().on('listening', (address) => {
  // Worker is listening
});



It is not emitted in the worker.


Event: 'message'#



Added in: v0.7.0



Similar to the cluster.on('message') event, but specific to this worker. In a
worker you can also use process.on('message').


See process event: 'message'.


As an example, here is a cluster that keeps count of the number of requests
in the master process using the message system:


const cluster = require('cluster');
const http = require('http');

if (cluster.isMaster) {

  // Keep track of http requests
  var numReqs = 0;
  setInterval(() => {
    console.log('numReqs =', numReqs);
  }, 1000);

  // Count requests
  function messageHandler(msg) {
    if (msg.cmd && msg.cmd == 'notifyRequest') {
      numReqs += 1;
    }
  }

  // Start workers and listen for messages containing notifyRequest
  const numCPUs = require('os').cpus().length;
  for (var i = 0; i < numCPUs; i++) {
    cluster.fork();
  }

  Object.keys(cluster.workers).forEach((id) => {
    cluster.workers[id].on('message', messageHandler);
  });

} else {

  // Worker processes have a http server.
  http.Server((req, res) => {
    res.writeHead(200);
    res.end('hello world\n');

    // notify master about the request
    process.send({ cmd: 'notifyRequest' });
  }).listen(8000);
}



Event: 'online'#



Added in: v0.7.0

Similar to the cluster.on('online') event, but specific to this worker.


cluster.fork().on('online', () => {
  // Worker is online
});



It is not emitted in the worker.


worker.disconnect()#



Added in: v0.7.7

In a worker, this function will close all servers, wait for the 'close' event on
those servers, and then disconnect the IPC channel.


In the master, an internal message is sent to the worker causing it to call
.disconnect() on itself.


Causes .suicide to be set.


Note that after a server is closed, it will no longer accept new connections,
but connections may be accepted by any other listening worker. Existing
connections will be allowed to close as usual. When no more connections exist,
see server.close(), the IPC channel to the worker will close allowing it to
die gracefully.


The above applies only to server connections, client connections are not
automatically closed by workers, and disconnect does not wait for them to close
before exiting.


Note that in a worker, process.disconnect exists, but it is not this function,
it is disconnect.


Because long living server connections may block workers from disconnecting, it
may be useful to send a message, so application specific actions may be taken to
close them. It also may be useful to implement a timeout, killing a worker if
the 'disconnect' event has not been emitted after some time.


if (cluster.isMaster) {
  var worker = cluster.fork();
  var timeout;

  worker.on('listening', (address) => {
    worker.send('shutdown');
    worker.disconnect();
    timeout = setTimeout(() => {
      worker.kill();
    }, 2000);
  });

  worker.on('disconnect', () => {
    clearTimeout(timeout);
  });

} else if (cluster.isWorker) {
  const net = require('net');
  var server = net.createServer((socket) => {
    // connections never end
  });

  server.listen(8000);

  process.on('message', (msg) => {
    if (msg === 'shutdown') {
      // initiate graceful close of any connections to server
    }
  });
}



worker.id#



Added in: v0.8.0



Each new worker is given its own unique id, this id is stored in the
id.


While a worker is alive, this is the key that indexes it in
cluster.workers


worker.isConnected()#



Added in: v0.11.14

This function returns true if the worker is connected to its master via its IPC
channel, false otherwise. A worker is connected to its master after it's been
created. It is disconnected after the 'disconnect' event is emitted.


worker.isDead()#



Added in: v0.11.14

This function returns true if the worker's process has terminated (either
because of exiting or being signaled). Otherwise, it returns false.


worker.kill([signal='SIGTERM'])#



Added in: v0.9.12

    

  • signal <String> Name of the kill signal to send to the worker
process.
    • 



This function will kill the worker. In the master, it does this by disconnecting
the worker.process, and once disconnected, killing with signal. In the
worker, it does it by disconnecting the channel, and then exiting with code 0.


Causes .suicide to be set.


This method is aliased as worker.destroy() for backwards compatibility.


Note that in a worker, process.kill() exists, but it is not this function,
it is kill.


worker.process#



Added in: v0.7.0



All workers are created using child_process.fork(), the returned object
from this function is stored as .process. In a worker, the global process
is stored.


See: Child Process module


Note that workers will call process.exit(0) if the 'disconnect' event occurs
on process and .suicide is not true. This protects against accidental
disconnection.


worker.send(message[, sendHandle][, callback])#



Added in: v0.7.0



Send a message to a worker or master, optionally with a handle.


In the master this sends a message to a specific worker. It is identical to
ChildProcess.send().


In a worker this sends a message to the master. It is identical to
process.send().


This example will echo back all messages from the master:


if (cluster.isMaster) {
  var worker = cluster.fork();
  worker.send('hi there');

} else if (cluster.isWorker) {
  process.on('message', (msg) => {
    process.send(msg);
  });
}



worker.suicide#



Added in: v0.7.0
Deprecated since: v6.0.0 



Set by calling .kill() or .disconnect(), until then it is undefined.


The boolean worker.suicide lets you distinguish between voluntary and accidental
exit, the master may choose not to respawn a worker based on this value.


cluster.on('exit', (worker, code, signal) => {
  if (worker.suicide === true) {
    console.log('Oh, it was just suicide\' – no need to worry').
  }
});

// kill worker
worker.kill();



Event: 'disconnect'#



Added in: v0.7.9



Emitted after the worker IPC channel has disconnected. This can occur when a
worker exits gracefully, is killed, or is disconnected manually (such as with
worker.disconnect()).


There may be a delay between the 'disconnect' and 'exit' events.  These events
can be used to detect if the process is stuck in a cleanup or if there are
long-living connections.


cluster.on('disconnect', (worker) => {
  console.log(`The worker #${worker.id} has disconnected`);
});



Event: 'exit'#



Added in: v0.7.9

    

  • worker <cluster.Worker>
    • 

  • code <Number> the exit code, if it exited normally.
    • 

  • signal <String> the name of the signal (e.g. 'SIGHUP') that caused
the process to be killed.
    • 



When any of the workers die the cluster module will emit the 'exit' event.


This can be used to restart the worker by calling .fork() again.


cluster.on('exit', (worker, code, signal) => {
  console.log('worker %d died (%s). restarting...',
    worker.process.pid, signal || code);
  cluster.fork();
});



See child_process event: 'exit'.


Event: 'fork'#



Added in: v0.7.0



When a new worker is forked the cluster module will emit a 'fork' event.
This can be used to log worker activity, and create your own timeout.


var timeouts = [];
function errorMsg() {
  console.error('Something must be wrong with the connection ...');
}

cluster.on('fork', (worker) => {
  timeouts[worker.id] = setTimeout(errorMsg, 2000);
});
cluster.on('listening', (worker, address) => {
  clearTimeout(timeouts[worker.id]);
});
cluster.on('exit', (worker, code, signal) => {
  clearTimeout(timeouts[worker.id]);
  errorMsg();
});



Event: 'listening'#



Added in: v0.7.0



After calling listen() from a worker, when the 'listening' event is emitted on
the server, a 'listening' event will also be emitted on cluster in the master.


The event handler is executed with two arguments, the worker contains the worker
object and the address object contains the following connection properties:
address, port and addressType. This is very useful if the worker is listening
on more than one address.


cluster.on('listening', (worker, address) => {
  console.log(
    `A worker is now connected to ${address.address}:${address.port}`);
});



The addressType is one of:


    

  • 4 (TCPv4)
    • 

  • 6 (TCPv6)
    • 

  • -1 (unix domain socket)
    • 

  • "udp4" or "udp6" (UDP v4 or v6)
    • 



Event: 'message'#




Emitted when the cluster master receives a message from any worker.


See child_process event: 'message'.


Event: 'online'#



Added in: v0.7.0



After forking a new worker, the worker should respond with an online message.
When the master receives an online message it will emit this event.
The difference between 'fork' and 'online' is that fork is emitted when the
master forks a worker, and 'online' is emitted when the worker is running.


cluster.on('online', (worker) => {
  console.log('Yay, the worker responded after it was forked');
});



Event: 'setup'#



Added in: v0.7.1



Emitted every time .setupMaster() is called.


The settings object is the cluster.settings object at the time
.setupMaster() was called and is advisory only, since multiple calls to
.setupMaster() can be made in a single tick.


If accuracy is important, use cluster.settings.


cluster.disconnect([callback])#



Added in: v0.7.7

    

  • callback <Function> called when all workers are disconnected and handles are
closed
    • 



Calls .disconnect() on each worker in cluster.workers.


When they are disconnected all internal handles will be closed, allowing the
master process to die gracefully if no other event is waiting.


The method takes an optional callback argument which will be called when finished.


This can only be called from the master process.


cluster.fork([env])#



Added in: v0.6.0



Spawn a new worker process.


This can only be called from the master process.


cluster.isMaster#



Added in: v0.8.1



True if the process is a master. This is determined
by the process.env.NODE_UNIQUE_ID. If process.env.NODE_UNIQUE_ID is
undefined, then isMaster is true.


cluster.isWorker#



Added in: v0.6.0



True if the process is not a master (it is the negation of cluster.isMaster).


cluster.schedulingPolicy#



Added in: v0.11.2

The scheduling policy, either cluster.SCHED_RR for round-robin or
cluster.SCHED_NONE to leave it to the operating system. This is a
global setting and effectively frozen once you spawn the first worker
or call cluster.setupMaster(), whatever comes first.


SCHED_RR is the default on all operating systems except Windows.
Windows will change to SCHED_RR once libuv is able to effectively
distribute IOCP handles without incurring a large performance hit.


cluster.schedulingPolicy can also be set through the
NODE_CLUSTER_SCHED_POLICY environment variable. Valid
values are "rr" and "none".


cluster.settings#



Added in: v0.7.1

    

  • <Object>
      

    • execArgv <Array> list of string arguments passed to the Node.js
executable. (Default=process.execArgv)
      • 

    • exec <String> file path to worker file.  (Default=process.argv[1])
      • 

    • args <Array> string arguments passed to worker.
(Default=process.argv.slice(2))
      • 

    • silent <Boolean> whether or not to send output to parent's stdio.
(Default=false)
      • 

    • uid <Number> Sets the user identity of the process. (See setuid(2).)
      • 

    • gid <Number> Sets the group identity of the process. (See setgid(2).)
      • 

    

    • 



After calling .setupMaster() (or .fork()) this settings object will contain
the settings, including the default values.


This object is not supposed to be changed or set manually, by you.


cluster.setupMaster([settings])#



Added in: v0.7.1

    

  • settings <Object>
      

    • exec <String> file path to worker file.  (Default=process.argv[1])
      • 

    • args <Array> string arguments passed to worker.
(Default=process.argv.slice(2))
      • 

    • silent <Boolean> whether or not to send output to parent's stdio.
(Default=false)
      • 

    

    • 



setupMaster is used to change the default 'fork' behavior. Once called,
the settings will be present in cluster.settings.


Note that:


    

  • any settings changes only affect future calls to .fork() and have no
effect on workers that are already running
    • 

  • The only attribute of a worker that cannot be set via .setupMaster() is
the env passed to .fork()
    • 

  • the defaults above apply to the first call only, the defaults for later
calls is the current value at the time of cluster.setupMaster() is called
    • 



Example:


const cluster = require('cluster');
cluster.setupMaster({
  exec: 'worker.js',
  args: ['--use', 'https'],
  silent: true
});
cluster.fork(); // https worker
cluster.setupMaster({
  exec: 'worker.js',
  args: ['--use', 'http']
});
cluster.fork(); // http worker



This can only be called from the master process.


cluster.worker#



Added in: v0.7.0



A reference to the current worker object. Not available in the master process.


const cluster = require('cluster');

if (cluster.isMaster) {
  console.log('I am master');
  cluster.fork();
  cluster.fork();
} else if (cluster.isWorker) {
  console.log(`I am worker #${cluster.worker.id}`);
}



cluster.workers#



Added in: v0.7.0



A hash that stores the active worker objects, keyed by id field. Makes it
easy to loop through all the workers. It is only available in the master
process.


A worker is removed from cluster.workers after the worker has disconnected and
exited. The order between these two events cannot be determined in advance.
However, it is guaranteed that the removal from the cluster.workers list happens
before last 'disconnect' or 'exit' event is emitted.


// Go through all workers
function eachWorker(callback) {
  for (var id in cluster.workers) {
    callback(cluster.workers[id]);
  }
}
eachWorker((worker) => {
  worker.send('big announcement to all workers');
});



Should you wish to reference a worker over a communication channel, using
the worker's unique id is the easiest way to find the worker.


socket.on('data', (id) => {
  var worker = cluster.workers[id];
});





Command Line Options#



Node.js comes with a variety of CLI options. These options expose built-in
debugging, multiple ways to execute scripts, and other helpful runtime options.


To view this documentation as a manual page in your terminal, run man node.


Synopsis#


node [options] [v8 options] [script.js | -e "script"] [arguments]


node debug [script.js | -e "script" | <host>:<port>] …


node --v8-options


Execute without arguments to start the REPL.


For more info about node debug, please see the debugger documentation.


Options#


-v, --version#



Added in: v0.1.3

Print node's version.


-h, --help#



Added in: v0.1.3

Print node command line options.
The output of this option is less detailed than this document.


-e, --eval "script"#



Added in: v0.5.2

Evaluate the following argument as JavaScript.


-p, --print "script"#



Added in: v0.6.4

Identical to -e but prints the result.


-c, --check#



Added in: v4.2.0

Syntax check the script without executing.


-i, --interactive#



Added in: v0.7.7

Opens the REPL even if stdin does not appear to be a terminal.


-r, --require module#



Added in: v1.6.0

Preload the specified module at startup.


Follows require()'s module resolution
rules. module may be either a path to a file, or a node module name.


--no-deprecation#



Added in: v0.8.0

Silence deprecation warnings.


--trace-deprecation#



Added in: v0.8.0

Print stack traces for deprecations.


--throw-deprecation#



Added in: v0.11.14

Throw errors for deprecations.


--trace-sync-io#



Added in: v2.1.0

Prints a stack trace whenever synchronous I/O is detected after the first turn
of the event loop.


--zero-fill-buffers#



Added in: v4.5.0

Automatically zero-fills all newly allocated Buffer and SlowBuffer
instances.


--track-heap-objects#



Added in: v2.4.0

Track heap object allocations for heap snapshots.


--prof-process#



Added in: v4.4.0

Process v8 profiler output generated using the v8 option --prof.


--v8-options#



Added in: v0.1.3

Print v8 command line options.


--tls-cipher-list=list#



Added in: v4.0.0

Specify an alternative default TLS cipher list. (Requires Node.js to be built
with crypto support. (Default))


--enable-fips#


Enable FIPS-compliant crypto at startup. (Requires Node.js to be built with
./configure --openssl-fips)


--force-fips#


Force FIPS-compliant crypto on startup. (Cannot be disabled from script code.)
(Same requirements as --enable-fips)


--icu-data-dir=file#



Added in: v0.11.15

Specify ICU data load path. (overrides NODE_ICU_DATA)


Environment Variables#


NODE_DEBUG=module[,…]#



Added in: v0.1.32

','-separated list of core modules that should print debug information.


NODE_PATH=path[:…]#



Added in: v0.1.32

':'-separated list of directories prefixed to the module search path.


Note: on Windows, this is a ';'-separated list instead.


NODE_DISABLE_COLORS=1#



Added in: v0.3.0

When set to 1 colors will not be used in the REPL.


NODE_ICU_DATA=file#



Added in: v0.11.15

Data path for ICU (Intl object) data. Will extend linked-in data when compiled
with small-icu support.


NODE_REPL_HISTORY=file#



Added in: v3.0.0

Path to the file used to store the persistent REPL history. The default path is
~/.node_repl_history, which is overridden by this variable. Setting the value
to an empty string ("" or " ") disables persistent REPL history.


NODE_EXTRA_CA_CERTS=file#



Added in: XXX

When set, the well known "root" CAs (like VeriSign) will be extended with the
extra certificates in file. The file should consist of one or more trusted
certificates in PEM format. A message will be printed to stderr (once)
if the file is missing or
misformatted, but any errors are otherwise ignored.


Note that neither the well known nor extra certificates are used when the ca
options property is explicitly specified for a TLS or HTTPS client or server.




Console#


Stability: 2 - Stable
The console module provides a simple debugging console that is similar to the
JavaScript console mechanism provided by web browsers.


The module exports two specific components:


    

  • A Console class with methods such as console.log(), console.error() and
console.warn() that can be used to write to any Node.js stream.
    • 

  • A global console instance configured to write to stdout and stderr.
Because this object is global, it can be used without calling
require('console').
    • 



Example using the global console:


console.log('hello world');
  // Prints: hello world, to stdout
console.log('hello %s', 'world');
  // Prints: hello world, to stdout
console.error(new Error('Whoops, something bad happened'));
  // Prints: [Error: Whoops, something bad happened], to stderr

const name = 'Will Robinson';
console.warn(`Danger ${name}! Danger!`);
  // Prints: Danger Will Robinson! Danger!, to stderr



Example using the Console class:


const out = getStreamSomehow();
const err = getStreamSomehow();
const myConsole = new console.Console(out, err);

myConsole.log('hello world');
  // Prints: hello world, to out
myConsole.log('hello %s', 'world');
  // Prints: hello world, to out
myConsole.error(new Error('Whoops, something bad happened'));
  // Prints: [Error: Whoops, something bad happened], to err

const name = 'Will Robinson';
myConsole.warn(`Danger ${name}! Danger!`);
  // Prints: Danger Will Robinson! Danger!, to err



While the API for the Console class is designed fundamentally around the
browser console object, the Console in Node.js is not intended to
duplicate the browser's functionality exactly.


Asynchronous vs Synchronous Consoles#


The console functions are usually asynchronous unless the destination is a file.
Disks are fast and operating systems normally employ write-back caching;
it should be a very rare occurrence indeed that a write blocks, but it
is possible.


Additionally, console functions are blocking when outputting to TTYs
(terminals) on OS X as a workaround for the OS's very small, 1kb buffer size.
This is to prevent interleaving between stdout and stderr.


Class: Console#



The Console class can be used to create a simple logger with configurable
output streams and can be accessed using either require('console').Console
or console.Console:


const Console = require('console').Console;
const Console = console.Console;



new Console(stdout[, stderr])#


Creates a new Console by passing one or two writable stream instances.
stdout is a writable stream to print log or info output. stderr
is used for warning or error output. If stderr isn't passed, warning and error
output will be sent to stdout.


const output = fs.createWriteStream('./stdout.log');
const errorOutput = fs.createWriteStream('./stderr.log');
// custom simple logger
const logger = new Console(output, errorOutput);
// use it like console
const count = 5;
logger.log('count: %d', count);
// in stdout.log: count 5



The global console is a special Console whose output is sent to
process.stdout and process.stderr. It is equivalent to calling:


new Console(process.stdout, process.stderr);



console.assert(value[, message][, ...])#



Added in: v0.1.101

A simple assertion test that verifies whether value is truthy. If it is not,
an AssertionError is thrown. If provided, the error message is formatted
using util.format() and used as the error message.


console.assert(true, 'does nothing');
  // OK
console.assert(false, 'Whoops %s', 'didn\'t work');
  // AssertionError: Whoops didn't work



Note: the console.assert() method is implemented differently in Node.js
than the console.assert() method available in browsers.


Specifically, in browsers, calling console.assert() with a falsy
assertion will cause the message to be printed to the console without
interrupting execution of subsequent code. In Node.js, however, a falsy
assertion will cause an AssertionError to be thrown.


Functionality approximating that implemented by browsers can be implemented
by extending Node.js' console and overriding the console.assert() method.


In the following example, a simple module is created that extends and overrides
the default behavior of console in Node.js.


'use strict';

// Creates a simple extension of console with a
// new impl for assert without monkey-patching.
const myConsole = Object.create(console, {
  assert: {
    value: function assert(assertion, message, ...args) {
      try {
        console.assert(assertion, message, ...args);
      } catch (err) {
        console.error(err.stack);
      }
    },
    configurable: true,
    enumerable: true,
    writable: true,
  },
});

module.exports = myConsole;



This can then be used as a direct replacement for the built in console:


const console = require('./myConsole');
console.assert(false, 'this message will print, but no error thrown');
console.log('this will also print');



console.dir(obj[, options])#



Added in: v0.1.101

Uses util.inspect() on obj and prints the resulting string to stdout.
This function bypasses any custom inspect() function defined on obj. An
optional options object may be passed to alter certain aspects of the
formatted string:


    

  • showHidden - if true then the object's non-enumerable and symbol
properties will be shown too. Defaults to false.
    

    • 

  • depth - tells util.inspect() how many times to recurse while
formatting the object. This is useful for inspecting large complicated objects.
Defaults to 2. To make it recurse indefinitely, pass null.
    

    • 

  • colors - if true, then the output will be styled with ANSI color codes.
Defaults to false. Colors are customizable; see
customizing util.inspect() colors.
    

    • 



console.error([data][, ...])#



Added in: v0.1.100

Prints to stderr with newline. Multiple arguments can be passed, with the
first used as the primary message and all additional used as substitution
values similar to printf(3) (the arguments are all passed to
util.format()).


const code = 5;
console.error('error #%d', code);
  // Prints: error #5, to stderr
console.error('error', code);
  // Prints: error 5, to stderr



If formatting elements (e.g. %d) are not found in the first string then
util.inspect() is called on each argument and the resulting string
values are concatenated. See util.format() for more information.


console.info([data][, ...])#



Added in: v0.1.100

The console.info() function is an alias for console.log().


console.log([data][, ...])#



Added in: v0.1.100

Prints to stdout with newline. Multiple arguments can be passed, with the
first used as the primary message and all additional used as substitution
values similar to printf(3) (the arguments are all passed to
util.format()).


const count = 5;
console.log('count: %d', count);
  // Prints: count: 5, to stdout
console.log('count:', count);
  // Prints: count: 5, to stdout



If formatting elements (e.g. %d) are not found in the first string then
util.inspect() is called on each argument and the resulting string
values are concatenated. See util.format() for more information.


console.time(label)#



Added in: v0.1.104

Used to calculate the duration of a specific operation. To start a timer, call
the console.time() method, giving it a unique label as the only parameter. To stop the
timer, and to get the elapsed time in milliseconds, just call the
console.timeEnd() method, again passing the
timer's unique label as the parameter.


console.timeEnd(label)#



Added in: v0.1.104

Stops a timer that was previously started by calling console.time() and
prints the result to stdout:


console.time('100-elements');
for (let i = 0; i < 100; i++) {
  ;
}
console.timeEnd('100-elements');
// prints 100-elements: 262ms



console.trace(message[, ...])#



Added in: v0.1.104

Prints to stderr the string 'Trace :', followed by the util.format()
formatted message and stack trace to the current position in the code.


console.trace('Show me');
  // Prints: (stack trace will vary based on where trace is called)
  //  Trace: Show me
  //    at repl:2:9
  //    at REPLServer.defaultEval (repl.js:248:27)
  //    at bound (domain.js:287:14)
  //    at REPLServer.runBound [as eval] (domain.js:300:12)
  //    at REPLServer.<anonymous> (repl.js:412:12)
  //    at emitOne (events.js:82:20)
  //    at REPLServer.emit (events.js:169:7)
  //    at REPLServer.Interface._onLine (readline.js:210:10)
  //    at REPLServer.Interface._line (readline.js:549:8)
  //    at REPLServer.Interface._ttyWrite (readline.js:826:14)



console.warn([data][, ...])#



Added in: v0.1.100

The console.warn() function is an alias for console.error().




Crypto#


Stability: 2 - Stable
The crypto module provides cryptographic functionality that includes a set of
wrappers for OpenSSL's hash, HMAC, cipher, decipher, sign and verify functions.


Use require('crypto') to access this module.


const crypto = require('crypto');

const secret = 'abcdefg';
const hash = crypto.createHmac('sha256', secret)
                   .update('I love cupcakes')
                   .digest('hex');
console.log(hash);
  // Prints:
  //   c0fa1bc00531bd78ef38c628449c5102aeabd49b5dc3a2a516ea6ea959d6658e



Class: Certificate#



Added in: v0.11.8

SPKAC is a Certificate Signing Request mechanism originally implemented by
Netscape and now specified formally as part of HTML5's keygen element.


The crypto module provides the Certificate class for working with SPKAC
data. The most common usage is handling output generated by the HTML5
<keygen> element. Node.js uses OpenSSL's SPKAC implementation internally.


new crypto.Certificate()#


Instances of the Certificate class can be created using the new keyword
or by calling crypto.Certificate() as a function:


const crypto = require('crypto');

const cert1 = new crypto.Certificate();
const cert2 = crypto.Certificate();



certificate.exportChallenge(spkac)#



Added in: v0.11.8

The spkac data structure includes a public key and a challenge. The
certificate.exportChallenge() returns the challenge component in the
form of a Node.js Buffer. The spkac argument can be either a string
or a Buffer.


const cert = require('crypto').Certificate();
const spkac = getSpkacSomehow();
const challenge = cert.exportChallenge(spkac);
console.log(challenge.toString('utf8'));
  // Prints the challenge as a UTF8 string



certificate.exportPublicKey(spkac)#



Added in: v0.11.8

The spkac data structure includes a public key and a challenge. The
certificate.exportPublicKey() returns the public key component in the
form of a Node.js Buffer. The spkac argument can be either a string
or a Buffer.


const cert = require('crypto').Certificate();
const spkac = getSpkacSomehow();
const publicKey = cert.exportPublicKey(spkac);
console.log(publicKey);
  // Prints the public key as <Buffer ...>



certificate.verifySpkac(spkac)#



Added in: v0.11.8

Returns true if the given spkac data structure is valid, false otherwise.
The spkac argument must be a Node.js Buffer.


const cert = require('crypto').Certificate();
const spkac = getSpkacSomehow();
console.log(cert.verifySpkac(new Buffer(spkac)));
  // Prints true or false



Class: Cipher#



Added in: v0.1.94

Instances of the Cipher class are used to encrypt data. The class can be
used in one of two ways:


    

  • As a stream that is both readable and writable, where plain unencrypted
data is written to produce encrypted data on the readable side, or
    • 

  • Using the cipher.update() and cipher.final() methods to produce
the encrypted data.
    • 



The crypto.createCipher() or crypto.createCipheriv() methods are
used to create Cipher instances. Cipher objects are not to be created
directly using the new keyword.


Example: Using Cipher objects as streams:


const crypto = require('crypto');
const cipher = crypto.createCipher('aes192', 'a password');

var encrypted = '';
cipher.on('readable', () => {
  var data = cipher.read();
  if (data)
    encrypted += data.toString('hex');
});
cipher.on('end', () => {
  console.log(encrypted);
  // Prints: ca981be48e90867604588e75d04feabb63cc007a8f8ad89b10616ed84d815504
});

cipher.write('some clear text data');
cipher.end();



Example: Using Cipher and piped streams:


const crypto = require('crypto');
const fs = require('fs');
const cipher = crypto.createCipher('aes192', 'a password');

const input = fs.createReadStream('test.js');
const output = fs.createWriteStream('test.enc');

input.pipe(cipher).pipe(output);



Example: Using the cipher.update() and cipher.final() methods:


const crypto = require('crypto');
const cipher = crypto.createCipher('aes192', 'a password');

var encrypted = cipher.update('some clear text data', 'utf8', 'hex');
encrypted += cipher.final('hex');
console.log(encrypted);
  // Prints: ca981be48e90867604588e75d04feabb63cc007a8f8ad89b10616ed84d815504



cipher.final([output_encoding])#



Added in: v0.1.94

Returns any remaining enciphered contents. If output_encoding
parameter is one of 'binary', 'base64' or 'hex', a string is returned.
If an output_encoding is not provided, a Buffer is returned.


Once the cipher.final() method has been called, the Cipher object can no
longer be used to encrypt data. Attempts to call cipher.final() more than
once will result in an error being thrown.


cipher.setAAD(buffer)#



Added in: v1.0.0

When using an authenticated encryption mode (only GCM is currently
supported), the cipher.setAAD() method sets the value used for the
additional authenticated data (AAD) input parameter.


cipher.getAuthTag()#



Added in: v1.0.0

When using an authenticated encryption mode (only GCM is currently
supported), the cipher.getAuthTag() method returns a Buffer containing
the authentication tag that has been computed from the given data.


The cipher.getAuthTag() method should only be called after encryption has
been completed using the cipher.final() method.


cipher.setAutoPadding(auto_padding=true)#



Added in: v0.7.1

When using block encryption algorithms, the Cipher class will automatically
add padding to the input data to the appropriate block size. To disable the
default padding call cipher.setAutoPadding(false).


When auto_padding is false, the length of the entire input data must be a
multiple of the cipher's block size or cipher.final() will throw an Error.
Disabling automatic padding is useful for non-standard padding, for instance
using 0x0 instead of PKCS padding.


The cipher.setAutoPadding() method must be called before cipher.final().


cipher.update(data[, input_encoding][, output_encoding])#



Added in: v0.1.94

Updates the cipher with data. If the input_encoding argument is given,
it's value must be one of 'utf8', 'ascii', or 'binary' and the data
argument is a string using the specified encoding. If the input_encoding
argument is not given, data must be a Buffer. If data is a
Buffer then input_encoding is ignored.


The output_encoding specifies the output format of the enciphered
data, and can be 'binary', 'base64' or 'hex'. If the output_encoding
is specified, a string using the specified encoding is returned. If no
output_encoding is provided, a Buffer is returned.


The cipher.update() method can be called multiple times with new data until
cipher.final() is called. Calling cipher.update() after
cipher.final() will result in an error being thrown.


Class: Decipher#



Added in: v0.1.94

Instances of the Decipher class are used to decrypt data. The class can be
used in one of two ways:


    

  • As a stream that is both readable and writable, where plain encrypted
data is written to produce unencrypted data on the readable side, or
    • 

  • Using the decipher.update() and decipher.final() methods to
produce the unencrypted data.
    • 



The crypto.createDecipher() or crypto.createDecipheriv() methods are
used to create Decipher instances. Decipher objects are not to be created
directly using the new keyword.


Example: Using Decipher objects as streams:


const crypto = require('crypto');
const decipher = crypto.createDecipher('aes192', 'a password');

var decrypted = '';
decipher.on('readable', () => {
  var data = decipher.read();
  if (data)
  decrypted += data.toString('utf8');
});
decipher.on('end', () => {
  console.log(decrypted);
  // Prints: some clear text data
});

var encrypted = 'ca981be48e90867604588e75d04feabb63cc007a8f8ad89b10616ed84d815504';
decipher.write(encrypted, 'hex');
decipher.end();



Example: Using Decipher and piped streams:


const crypto = require('crypto');
const fs = require('fs');
const decipher = crypto.createDecipher('aes192', 'a password');

const input = fs.createReadStream('test.enc');
const output = fs.createWriteStream('test.js');

input.pipe(decipher).pipe(output);



Example: Using the decipher.update() and decipher.final() methods:


const crypto = require('crypto');
const decipher = crypto.createDecipher('aes192', 'a password');

var encrypted = 'ca981be48e90867604588e75d04feabb63cc007a8f8ad89b10616ed84d815504';
var decrypted = decipher.update(encrypted, 'hex', 'utf8');
decrypted += decipher.final('utf8');
console.log(decrypted);
  // Prints: some clear text data



decipher.final([output_encoding])#



Added in: v0.1.94

Returns any remaining deciphered contents. If output_encoding
parameter is one of 'binary', 'base64' or 'hex', a string is returned.
If an output_encoding is not provided, a Buffer is returned.


Once the decipher.final() method has been called, the Decipher object can
no longer be used to decrypt data. Attempts to call decipher.final() more
than once will result in an error being thrown.


decipher.setAAD(buffer)#



Added in: v1.0.0

When using an authenticated encryption mode (only GCM is currently
supported), the decipher.setAAD() method sets the value used for the
additional authenticated data (AAD) input parameter.


decipher.setAuthTag(buffer)#



Added in: v1.0.0

When using an authenticated encryption mode (only GCM is currently
supported), the decipher.setAuthTag() method is used to pass in the
received authentication tag. If no tag is provided, or if the cipher text
has been tampered with, decipher.final() with throw, indicating that the
cipher text should be discarded due to failed authentication.


decipher.setAutoPadding(auto_padding=true)#



Added in: v0.7.1

When data has been encrypted without standard block padding, calling
decipher.setAutoPadding(false) will disable automatic padding to prevent
decipher.final() from checking for and removing padding.


Turning auto padding off will only work if the input data's length is a
multiple of the ciphers block size.


The decipher.setAutoPadding() method must be called before
decipher.update().


decipher.update(data[, input_encoding][, output_encoding])#



Added in: v0.1.94

Updates the decipher with data. If the input_encoding argument is given,
it's value must be one of 'binary', 'base64', or 'hex' and the data
argument is a string using the specified encoding. If the input_encoding
argument is not given, data must be a Buffer. If data is a
Buffer then input_encoding is ignored.


The output_encoding specifies the output format of the enciphered
data, and can be 'binary', 'ascii' or 'utf8'. If the output_encoding
is specified, a string using the specified encoding is returned. If no
output_encoding is provided, a Buffer is returned.


The decipher.update() method can be called multiple times with new data until
decipher.final() is called. Calling decipher.update() after
decipher.final() will result in an error being thrown.


Class: DiffieHellman#



Added in: v0.5.0

The DiffieHellman class is a utility for creating Diffie-Hellman key
exchanges.


Instances of the DiffieHellman class can be created using the
crypto.createDiffieHellman() function.


const crypto = require('crypto');
const assert = require('assert');

// Generate Alice's keys...
const alice = crypto.createDiffieHellman(2048);
const alice_key = alice.generateKeys();

// Generate Bob's keys...
const bob = crypto.createDiffieHellman(alice.getPrime(), alice.getGenerator());
const bob_key = bob.generateKeys();

// Exchange and generate the secret...
const alice_secret = alice.computeSecret(bob_key);
const bob_secret = bob.computeSecret(alice_key);

// OK
assert.equal(alice_secret.toString('hex'), bob_secret.toString('hex'));



diffieHellman.computeSecret(other_public_key[, input_encoding][, output_encoding])#



Added in: v0.5.0

Computes the shared secret using other_public_key as the other
party's public key and returns the computed shared secret. The supplied
key is interpreted using the specified input_encoding, and secret is
encoded using specified output_encoding. Encodings can be
'binary', 'hex', or 'base64'. If the input_encoding is not
provided, other_public_key is expected to be a Buffer.


If output_encoding is given a string is returned; otherwise, a
Buffer is returned.


diffieHellman.generateKeys([encoding])#



Added in: v0.5.0

Generates private and public Diffie-Hellman key values, and returns
the public key in the specified encoding. This key should be
transferred to the other party. Encoding can be 'binary', 'hex',
or 'base64'. If encoding is provided a string is returned; otherwise a
Buffer is returned.


diffieHellman.getGenerator([encoding])#



Added in: v0.5.0

Returns the Diffie-Hellman generator in the specified encoding, which can
be 'binary', 'hex', or 'base64'. If  encoding is provided a string is
returned; otherwise a Buffer is returned.


diffieHellman.getPrime([encoding])#



Added in: v0.5.0

Returns the Diffie-Hellman prime in the specified encoding, which can
be 'binary', 'hex', or 'base64'. If encoding is provided a string is
returned; otherwise a Buffer is returned.


diffieHellman.getPrivateKey([encoding])#



Added in: v0.5.0

Returns the Diffie-Hellman private key in the specified encoding,
which can be 'binary', 'hex', or 'base64'. If encoding is provided a
string is returned; otherwise a Buffer is returned.


diffieHellman.getPublicKey([encoding])#



Added in: v0.5.0

Returns the Diffie-Hellman public key in the specified encoding, which
can be 'binary', 'hex', or 'base64'. If encoding is provided a
string is returned; otherwise a Buffer is returned.


diffieHellman.setPrivateKey(private_key[, encoding])#



Added in: v0.5.0

Sets the Diffie-Hellman private key. If the encoding argument is provided
and is either 'binary', 'hex', or 'base64', private_key is expected
to be a string. If no encoding is provided, private_key is expected
to be a Buffer.


diffieHellman.setPublicKey(public_key[, encoding])#



Added in: v0.5.0

Sets the Diffie-Hellman public key. If the encoding argument is provided
and is either 'binary', 'hex' or 'base64', public_key is expected
to be a string. If no encoding is provided, public_key is expected
to be a Buffer.


diffieHellman.verifyError#



Added in: v0.11.12

A bit field containing any warnings and/or errors resulting from a check
performed during initialization of the DiffieHellman object.


The following values are valid for this property (as defined in constants
module):


    

  • DH_CHECK_P_NOT_SAFE_PRIME
    • 

  • DH_CHECK_P_NOT_PRIME
    • 

  • DH_UNABLE_TO_CHECK_GENERATOR
    • 

  • DH_NOT_SUITABLE_GENERATOR
    • 



Class: ECDH#



Added in: v0.11.14

The ECDH class is a utility for creating Elliptic Curve Diffie-Hellman (ECDH)
key exchanges.


Instances of the ECDH class can be created using the
crypto.createECDH() function.


const crypto = require('crypto');
const assert = require('assert');

// Generate Alice's keys...
const alice = crypto.createECDH('secp521r1');
const alice_key = alice.generateKeys();

// Generate Bob's keys...
const bob = crypto.createECDH('secp521r1');
const bob_key = bob.generateKeys();

// Exchange and generate the secret...
const alice_secret = alice.computeSecret(bob_key);
const bob_secret = bob.computeSecret(alice_key);

assert(alice_secret, bob_secret);
  // OK



ecdh.computeSecret(other_public_key[, input_encoding][, output_encoding])#



Added in: v0.11.14

Computes the shared secret using other_public_key as the other
party's public key and returns the computed shared secret. The supplied
key is interpreted using specified input_encoding, and the returned secret
is encoded using the specified output_encoding. Encodings can be
'binary', 'hex', or 'base64'. If the input_encoding is not
provided, other_public_key is expected to be a Buffer.


If output_encoding is given a string will be returned; otherwise a
Buffer is returned.


ecdh.generateKeys([encoding[, format]])#



Added in: v0.11.14

Generates private and public EC Diffie-Hellman key values, and returns
the public key in the specified format and encoding. This key should be
transferred to the other party.


The format arguments specifies point encoding and can be 'compressed',
'uncompressed', or 'hybrid'. If format is not specified, the point will
be returned in 'uncompressed' format.


The encoding argument can be 'binary', 'hex', or 'base64'. If
encoding is provided a string is returned; otherwise a Buffer
is returned.


ecdh.getPrivateKey([encoding])#



Added in: v0.11.14

Returns the EC Diffie-Hellman private key in the specified encoding,
which can be 'binary', 'hex', or 'base64'. If encoding is provided
a string is returned; otherwise a Buffer is returned.


ecdh.getPublicKey([encoding[, format]])#



Added in: v0.11.14

Returns the EC Diffie-Hellman public key in the specified encoding and
format.


The format argument specifies point encoding and can be 'compressed',
'uncompressed', or 'hybrid'. If format is not specified the point will be
returned in 'uncompressed' format.


The encoding argument can be 'binary', 'hex', or 'base64'. If
encoding is specified, a string is returned; otherwise a Buffer is
returned.


ecdh.setPrivateKey(private_key[, encoding])#



Added in: v0.11.14

Sets the EC Diffie-Hellman private key. The encoding can be 'binary',
'hex' or 'base64'. If encoding is provided, private_key is expected
to be a string; otherwise private_key is expected to be a Buffer. If
private_key is not valid for the curve specified when the ECDH object was
created, an error is thrown. Upon setting the private key, the associated
public point (key) is also generated and set in the ECDH object.


ecdh.setPublicKey(public_key[, encoding])#



Added in: v0.11.14
Deprecated since: v5.2.0 

Stability: 0 - Deprecated
Sets the EC Diffie-Hellman public key. Key encoding can be 'binary',
'hex' or 'base64'. If encoding is provided public_key is expected to
be a string; otherwise a Buffer is expected.


Note that there is not normally a reason to call this method because ECDH
only requires a private key and the other party's public key to compute the
shared secret. Typically either ecdh.generateKeys() or
ecdh.setPrivateKey() will be called. The ecdh.setPrivateKey() method
attempts to generate the public point/key associated with the private key being
set.


Example (obtaining a shared secret):


const crypto = require('crypto');
const alice = crypto.createECDH('secp256k1');
const bob = crypto.createECDH('secp256k1');

// Note: This is a shortcut way to specify one of Alice's previous private
// keys. It would be unwise to use such a predictable private key in a real
// application.
alice.setPrivateKey(
  crypto.createHash('sha256').update('alice', 'utf8').digest()
);

// Bob uses a newly generated cryptographically strong
// pseudorandom key pair bob.generateKeys();

const alice_secret = alice.computeSecret(bob.getPublicKey(), null, 'hex');
const bob_secret = bob.computeSecret(alice.getPublicKey(), null, 'hex');

// alice_secret and bob_secret should be the same shared secret value
console.log(alice_secret === bob_secret);



Class: Hash#



Added in: v0.1.92

The Hash class is a utility for creating hash digests of data. It can be
used in one of two ways:


    

  • As a stream that is both readable and writable, where data is written
to produce a computed hash digest on the readable side, or
    • 

  • Using the hash.update() and hash.digest() methods to produce the
computed hash.
    • 



The crypto.createHash() method is used to create Hash instances. Hash
objects are not to be created directly using the new keyword.


Example: Using Hash objects as streams:


const crypto = require('crypto');
const hash = crypto.createHash('sha256');

hash.on('readable', () => {
  var data = hash.read();
  if (data)
    console.log(data.toString('hex'));
    // Prints:
    //   6a2da20943931e9834fc12cfe5bb47bbd9ae43489a30726962b576f4e3993e50
});

hash.write('some data to hash');
hash.end();



Example: Using Hash and piped streams:


const crypto = require('crypto');
const fs = require('fs');
const hash = crypto.createHash('sha256');

const input = fs.createReadStream('test.js');
input.pipe(hash).pipe(process.stdout);



Example: Using the hash.update() and hash.digest() methods:


const crypto = require('crypto');
const hash = crypto.createHash('sha256');

hash.update('some data to hash');
console.log(hash.digest('hex'));
  // Prints:
  //   6a2da20943931e9834fc12cfe5bb47bbd9ae43489a30726962b576f4e3993e50



hash.digest([encoding])#



Added in: v0.1.92

Calculates the digest of all of the data passed to be hashed (using the
hash.update() method). The encoding can be 'hex', 'binary' or
'base64'. If encoding is provided a string will be returned; otherwise
a Buffer is returned.


The Hash object can not be used again after hash.digest() method has been
called. Multiple calls will cause an error to be thrown.


hash.update(data[, input_encoding])#



Added in: v0.1.92

Updates the hash content with the given data, the encoding of which
is given in input_encoding and can be 'utf8', 'ascii' or
'binary'. If encoding is not provided, and the data is a string, an
encoding of 'binary' is enforced. If data is a Buffer then
input_encoding is ignored.


This can be called many times with new data as it is streamed.


Class: Hmac#



Added in: v0.1.94

The Hmac Class is a utility for creating cryptographic HMAC digests. It can
be used in one of two ways:


    

  • As a stream that is both readable and writable, where data is written
to produce a computed HMAC digest on the readable side, or
    • 

  • Using the hmac.update() and hmac.digest() methods to produce the
computed HMAC digest.
    • 



The crypto.createHmac() method is used to create Hmac instances. Hmac
objects are not to be created directly using the new keyword.


Example: Using Hmac objects as streams:


const crypto = require('crypto');
const hmac = crypto.createHmac('sha256', 'a secret');

hmac.on('readable', () => {
  var data = hmac.read();
  if (data)
    console.log(data.toString('hex'));
    // Prints:
    //   7fd04df92f636fd450bc841c9418e5825c17f33ad9c87c518115a45971f7f77e
});

hmac.write('some data to hash');
hmac.end();



Example: Using Hmac and piped streams:


const crypto = require('crypto');
const fs = require('fs');
const hmac = crypto.createHmac('sha256', 'a secret');

const input = fs.createReadStream('test.js');
input.pipe(hmac).pipe(process.stdout);



Example: Using the hmac.update() and hmac.digest() methods:


const crypto = require('crypto');
const hmac = crypto.createHmac('sha256', 'a secret');

hmac.update('some data to hash');
console.log(hmac.digest('hex'));
  // Prints:
  //   7fd04df92f636fd450bc841c9418e5825c17f33ad9c87c518115a45971f7f77e



hmac.digest([encoding])#



Added in: v0.1.94

Calculates the HMAC digest of all of the data passed using hmac.update().
The encoding can be 'hex', 'binary' or 'base64'. If encoding is
provided a string is returned; otherwise a Buffer is returned;


The Hmac object can not be used again after hmac.digest() has been
called. Multiple calls to hmac.digest() will result in an error being thrown.


hmac.update(data[, input_encoding])#



Added in: v0.1.94

Updates the Hmac content with the given data, the encoding of which
is given in input_encoding and can be 'utf8', 'ascii' or
'binary'. If encoding is not provided, and the data is a string, an
encoding of 'utf8' is enforced. If data is a Buffer then
input_encoding is ignored.


This can be called many times with new data as it is streamed.


Class: Sign#



Added in: v0.1.92

The Sign Class is a utility for generating signatures. It can be used in one
of two ways:


    

  • As a writable stream, where data to be signed is written and the
sign.sign() method is used to generate and return the signature, or
    • 

  • Using the sign.update() and sign.sign() methods to produce the
signature.
    • 



The crypto.createSign() method is used to create Sign instances. Sign
objects are not to be created directly using the new keyword.


Example: Using Sign objects as streams:


const crypto = require('crypto');
const sign = crypto.createSign('RSA-SHA256');

sign.write('some data to sign');
sign.end();

const private_key = getPrivateKeySomehow();
console.log(sign.sign(private_key, 'hex'));
  // Prints the calculated signature



Example: Using the sign.update() and sign.sign() methods:


const crypto = require('crypto');
const sign = crypto.createSign('RSA-SHA256');

sign.update('some data to sign');

const private_key = getPrivateKeySomehow();
console.log(sign.sign(private_key, 'hex'));
  // Prints the calculated signature



A Sign instance can also be created by just passing in the digest
algorithm name, in which case OpenSSL will infer the full signature algorithm
from the type of the PEM-formatted private key, including algorithms that
do not have directly exposed name constants, e.g. 'ecdsa-with-SHA256'.


Example: signing using ECDSA with SHA256


const crypto = require('crypto');
const sign = crypto.createSign('sha256');

sign.update('some data to sign');

const private_key = '-----BEGIN EC PRIVATE KEY-----\n' +
        'MHcCAQEEIF+jnWY1D5kbVYDNvxxo/Y+ku2uJPDwS0r/VuPZQrjjVoAoGCCqGSM49\n' +
        'AwEHoUQDQgAEurOxfSxmqIRYzJVagdZfMMSjRNNhB8i3mXyIMq704m2m52FdfKZ2\n' +
        'pQhByd5eyj3lgZ7m7jbchtdgyOF8Io/1ng==\n' +
        '-----END EC PRIVATE KEY-----\n';

console.log(sign.sign(private_key).toString('hex'));



sign.sign(private_key[, output_format])#



Added in: v0.1.92

Calculates the signature on all the data passed through using either
sign.update() or sign.write().


The private_key argument can be an object or a string. If private_key is a
string, it is treated as a raw key with no passphrase. If private_key is an
object, it is interpreted as a hash containing two properties:


    

  • key : <String> - PEM encoded private key
    • 

  • passphrase : <String> - passphrase for the private key
    • 



The output_format can specify one of 'binary', 'hex' or 'base64'. If
output_format is provided a string is returned; otherwise a Buffer is
returned.


The Sign object can not be again used after sign.sign() method has been
called. Multiple calls to sign.sign() will result in an error being thrown.


sign.update(data[, input_encoding])#



Added in: v0.1.92

Updates the Sign content with the given data, the encoding of which
is given in input_encoding and can be 'utf8', 'ascii' or
'binary'. If encoding is not provided, and the data is a string, an
encoding of 'utf8' is enforced. If data is a Buffer then
input_encoding is ignored.


This can be called many times with new data as it is streamed.


Class: Verify#



Added in: v0.1.92

The Verify class is a utility for verifying signatures. It can be used in one
of two ways:



The [crypto.createVerify()][] method is used to create Verify instances.
Verify objects are not to be created directly using the new keyword.


Example: Using Verify objects as streams:


const crypto = require('crypto');
const verify = crypto.createVerify('RSA-SHA256');

verify.write('some data to sign');
verify.end();

const public_key = getPublicKeySomehow();
const signature = getSignatureToVerify();
console.log(verify.verify(public_key, signature));
  // Prints true or false



Example: Using the verify.update() and verify.verify() methods:


const crypto = require('crypto');
const verify = crypto.createVerify('RSA-SHA256');

verify.update('some data to sign');

const public_key = getPublicKeySomehow();
const signature = getSignatureToVerify();
console.log(verify.verify(public_key, signature));
  // Prints true or false



verifier.update(data[, input_encoding])#



Added in: v0.1.92

Updates the Verify content with the given data, the encoding of which
is given in input_encoding and can be 'utf8', 'ascii' or
'binary'. If encoding is not provided, and the data is a string, an
encoding of 'utf8' is enforced. If data is a Buffer then
input_encoding is ignored.


This can be called many times with new data as it is streamed.


verifier.verify(object, signature[, signature_format])#



Added in: v0.1.92

Verifies the provided data using the given object and signature.
The object argument is a string containing a PEM encoded object, which can be
one an RSA public key, a DSA public key, or an X.509 certificate.
The signature argument is the previously calculated signature for the data, in
the signature_format which can be 'binary', 'hex' or 'base64'.
If a signature_format is specified, the signature is expected to be a
string; otherwise signature is expected to be a Buffer.


Returns true or false depending on the validity of the signature for
the data and public key.


The verifier object can not be used again after verify.verify() has been
called. Multiple calls to verify.verify() will result in an error being
thrown.


crypto module methods and properties#


crypto.DEFAULT_ENCODING#



Added in: v0.9.3

The default encoding to use for functions that can take either strings
or buffers. The default value is 'buffer', which makes methods
default to Buffer objects.


The crypto.DEFAULT_ENCODING mechanism is provided for backwards compatibility
with legacy programs that expect 'binary' to be the default encoding.


New applications should expect the default to be 'buffer'. This property may
become deprecated in a future Node.js release.


crypto.createCipher(algorithm, password)#



Added in: v0.1.94

Creates and returns a Cipher object that uses the given algorithm and
password.


The algorithm is dependent on OpenSSL, examples are 'aes192', etc. On
recent OpenSSL releases, openssl list-cipher-algorithms will display the
available cipher algorithms.


The password is used to derive the cipher key and initialization vector (IV).
The value must be either a 'binary' encoded string or a Buffer.


The implementation of crypto.createCipher() derives keys using the OpenSSL
function EVP_BytesToKey with the digest algorithm set to MD5, one
iteration, and no salt. The lack of salt allows dictionary attacks as the same
password always creates the same key. The low iteration count and
non-cryptographically secure hash algorithm allow passwords to be tested very
rapidly.


In line with OpenSSL's recommendation to use pbkdf2 instead of
EVP_BytesToKey it is recommended that developers derive a key and IV on
their own using crypto.pbkdf2() and to use crypto.createCipheriv()
to create the Cipher object.


crypto.createCipheriv(algorithm, key, iv)#


Creates and returns a Cipher object, with the given algorithm, key and
initialization vector (iv).


The algorithm is dependent on OpenSSL, examples are 'aes192', etc. On
recent OpenSSL releases, openssl list-cipher-algorithms will display the
available cipher algorithms.


The key is the raw key used by the algorithm and iv is an
initialization vector. Both arguments must be 'binary' encoded strings or
buffers.


crypto.createCredentials(details)#



Added in: v0.1.92
Deprecated since: v0.11.13 

Stability: 0 - Deprecated: Use tls.createSecureContext() instead.
The crypto.createCredentials() method is a deprecated alias for creating
and returning a tls.SecureContext object. The crypto.createCredentials()
method should not be used.


The optional details argument is a hash object with keys:


    

  • pfx : <String> | <Buffer> - PFX or PKCS12 encoded private
key, certificate and CA certificates
    • 

  • key : <String> - PEM encoded private key
    • 

  • passphrase : <String> - passphrase for the private key or PFX
    • 

  • cert : <String> - PEM encoded certificate
    • 

  • ca : <String> | <Array> - Either a string or array of strings of PEM encoded CA
certificates to trust.
    • 

  • crl : <String> | <Array> - Either a string or array of strings of PEM encoded CRLs
(Certificate Revocation List)
    • 

  • ciphers: <String> using the OpenSSL cipher list format describing the
cipher algorithms to use or exclude.
    • 



If no 'ca' details are given, Node.js will use Mozilla's default
publicly trusted list of CAs.


crypto.createDecipher(algorithm, password)#



Added in: v0.1.94

Creates and returns a Decipher object that uses the given algorithm and
password (key).


The implementation of crypto.createDecipher() derives keys using the OpenSSL
function EVP_BytesToKey with the digest algorithm set to MD5, one
iteration, and no salt. The lack of salt allows dictionary attacks as the same
password always creates the same key. The low iteration count and
non-cryptographically secure hash algorithm allow passwords to be tested very
rapidly.


In line with OpenSSL's recommendation to use pbkdf2 instead of
EVP_BytesToKey it is recommended that developers derive a key and IV on
their own using crypto.pbkdf2() and to use crypto.createDecipheriv()
to create the Decipher object.


crypto.createDecipheriv(algorithm, key, iv)#



Added in: v0.1.94

Creates and returns a Decipher object that uses the given algorithm, key
and initialization vector (iv).


The algorithm is dependent on OpenSSL, examples are 'aes192', etc. On
recent OpenSSL releases, openssl list-cipher-algorithms will display the
available cipher algorithms.


The key is the raw key used by the algorithm and iv is an
initialization vector. Both arguments must be 'binary' encoded strings or
buffers.


crypto.createDiffieHellman(prime[, prime_encoding][, generator][, generator_encoding])#



Added in: v0.11.12

Creates a DiffieHellman key exchange object using the supplied prime and an
optional specific generator.


The generator argument can be a number, string, or Buffer. If
generator is not specified, the value 2 is used.


The prime_encoding and generator_encoding arguments can be 'binary',
'hex', or 'base64'.


If prime_encoding is specified, prime is expected to be a string; otherwise
a Buffer is expected.


If generator_encoding is specified, generator is expected to be a string;
otherwise either a number or Buffer is expected.


crypto.createDiffieHellman(prime_length[, generator])#



Added in: v0.5.0

Creates a DiffieHellman key exchange object and generates a prime of
prime_length bits using an optional specific numeric generator.
If generator is not specified, the value 2 is used.


crypto.createECDH(curve_name)#



Added in: v0.11.14

Creates an Elliptic Curve Diffie-Hellman (ECDH) key exchange object using a
predefined curve specified by the curve_name string. Use
crypto.getCurves() to obtain a list of available curve names. On recent
OpenSSL releases, openssl ecparam -list_curves will also display the name
and description of each available elliptic curve.


crypto.createHash(algorithm)#



Added in: v0.1.92

Creates and returns a Hash object that can be used to generate hash digests
using the given algorithm.


The algorithm is dependent on the available algorithms supported by the
version of OpenSSL on the platform. Examples are 'sha256', 'sha512', etc.
On recent releases of OpenSSL, openssl list-message-digest-algorithms will
display the available digest algorithms.


Example: generating the sha256 sum of a file


const filename = process.argv[2];
const crypto = require('crypto');
const fs = require('fs');

const hash = crypto.createHash('sha256');

const input = fs.createReadStream(filename);
input.on('readable', () => {
  var data = input.read();
  if (data)
    hash.update(data);
  else {
    console.log(`${hash.digest('hex')} ${filename}`);
  }
});



crypto.createHmac(algorithm, key)#



Added in: v0.1.94

Creates and returns an Hmac object that uses the given algorithm and key.


The algorithm is dependent on the available algorithms supported by the
version of OpenSSL on the platform. Examples are 'sha256', 'sha512', etc.
On recent releases of OpenSSL, openssl list-message-digest-algorithms will
display the available digest algorithms.


The key is the HMAC key used to generate the cryptographic HMAC hash.


Example: generating the sha256 HMAC of a file


const filename = process.argv[2];
const crypto = require('crypto');
const fs = require('fs');

const hmac = crypto.createHmac('sha256', 'a secret');

const input = fs.createReadStream(filename);
input.on('readable', () => {
  var data = input.read();
  if (data)
    hmac.update(data);
  else {
    console.log(`${hmac.digest('hex')} ${filename}`);
  }
});



crypto.createSign(algorithm)#



Added in: v0.1.92

Creates and returns a Sign object that uses the given algorithm.
Use crypto.getHashes() to obtain an array of names of the available
signing algorithms.


crypto.createVerify(algorithm)#



Added in: v0.1.92

Creates and returns a Verify object that uses the given algorithm.
Use crypto.getHashes() to obtain an array of names of the available
signing algorithms.


crypto.getCiphers()#



Added in: v0.9.3

Returns an array with the names of the supported cipher algorithms.


Example:


const ciphers = crypto.getCiphers();
console.log(ciphers); // ['aes-128-cbc', 'aes-128-ccm', ...]



crypto.getCurves()#



Added in: v2.3.0

Returns an array with the names of the supported elliptic curves.


Example:


const curves = crypto.getCurves();
console.log(curves); // ['secp256k1', 'secp384r1', ...]



crypto.getDiffieHellman(group_name)#



Added in: v0.7.5

Creates a predefined DiffieHellman key exchange object. The
supported groups are: 'modp1', 'modp2', 'modp5' (defined in
RFC 2412, but see Caveats) and 'modp14', 'modp15',
'modp16', 'modp17', 'modp18' (defined in RFC 3526). The
returned object mimics the interface of objects created by
crypto.createDiffieHellman(), but will not allow changing
the keys (with diffieHellman.setPublicKey() for example). The
advantage of using this method is that the parties do not have to
generate nor exchange a group modulus beforehand, saving both processor
and communication time.


Example (obtaining a shared secret):


const crypto = require('crypto');
const alice = crypto.getDiffieHellman('modp14');
const bob = crypto.getDiffieHellman('modp14');

alice.generateKeys();
bob.generateKeys();

const alice_secret = alice.computeSecret(bob.getPublicKey(), null, 'hex');
const bob_secret = bob.computeSecret(alice.getPublicKey(), null, 'hex');

/* alice_secret and bob_secret should be the same */
console.log(alice_secret == bob_secret);



crypto.getHashes()#



Added in: v0.9.3

Returns an array of the names of the supported hash algorithms,
such as RSA-SHA256.


Example:


const hashes = crypto.getHashes();
console.log(hashes); // ['sha', 'sha1', 'sha1WithRSAEncryption', ...]



crypto.pbkdf2(password, salt, iterations, keylen[, digest], callback)#



Added in: v0.5.5

Provides an asynchronous Password-Based Key Derivation Function 2 (PBKDF2)
implementation. A selected HMAC digest algorithm specified by digest is
applied to derive a key of the requested byte length (keylen) from the
password, salt and iterations. If the digest algorithm is not specified,
a default of 'sha1' is used.


The supplied callback function is called with two arguments: err and
derivedKey. If an error occurs, err will be set; otherwise err will be
null. The successfully generated derivedKey will be passed as a Buffer.


The iterations argument must be a number set as high as possible. The
higher the number of iterations, the more secure the derived key will be,
but will take a longer amount of time to complete.


The salt should also be as unique as possible. It is recommended that the
salts are random and their lengths are greater than 16 bytes. See
NIST SP 800-132 for details.


Example:


const crypto = require('crypto');
crypto.pbkdf2('secret', 'salt', 100000, 512, 'sha512', (err, key) => {
  if (err) throw err;
  console.log(key.toString('hex'));  // 'c5e478d...1469e50'
});



An array of supported digest functions can be retrieved using
crypto.getHashes().


crypto.pbkdf2Sync(password, salt, iterations, keylen[, digest])#



Added in: v0.9.3

Provides a synchronous Password-Based Key Derivation Function 2 (PBKDF2)
implementation. A selected HMAC digest algorithm specified by digest is
applied to derive a key of the requested byte length (keylen) from the
password, salt and iterations. If the digest algorithm is not specified,
a default of 'sha1' is used.


If an error occurs an Error will be thrown, otherwise the derived key will be
returned as a Buffer.


The iterations argument must be a number set as high as possible. The
higher the number of iterations, the more secure the derived key will be,
but will take a longer amount of time to complete.


The salt should also be as unique as possible. It is recommended that the
salts are random and their lengths are greater than 16 bytes. See
NIST SP 800-132 for details.


Example:


const crypto = require('crypto');
const key = crypto.pbkdf2Sync('secret', 'salt', 100000, 512, 'sha512');
console.log(key.toString('hex'));  // 'c5e478d...1469e50'



An array of supported digest functions can be retrieved using
crypto.getHashes().


crypto.privateDecrypt(private_key, buffer)#



Added in: v0.11.14

Decrypts buffer with private_key.


private_key can be an object or a string. If private_key is a string, it is
treated as the key with no passphrase and will use RSA_PKCS1_OAEP_PADDING.
If private_key is an object, it is interpreted as a hash object with the
keys:


    

  • key : <String> - PEM encoded private key
    • 

  • passphrase : <String> - Optional passphrase for the private key
    • 

  • padding : An optional padding value, one of the following:
      

    • constants.RSA_NO_PADDING
      • 

    • constants.RSA_PKCS1_PADDING
      • 

    • constants.RSA_PKCS1_OAEP_PADDING
      • 

    

    • 



All paddings are defined in the constants module.


crypto.privateEncrypt(private_key, buffer)#



Added in: v1.1.0

Encrypts buffer with private_key.


private_key can be an object or a string. If private_key is a string, it is
treated as the key with no passphrase and will use RSA_PKCS1_PADDING.
If private_key is an object, it is interpreted as a hash object with the
keys:


    

  • key : <String> - PEM encoded private key
    • 

  • passphrase : <String> - Optional passphrase for the private key
    • 

  • padding : An optional padding value, one of the following:
      

    • constants.RSA_NO_PADDING
      • 

    • constants.RSA_PKCS1_PADDING
      • 

    

    • 



All paddings are defined in the constants module.


crypto.publicDecrypt(public_key, buffer)#



Added in: v1.1.0

Decrypts buffer with public_key.


public_key can be an object or a string. If public_key is a string, it is
treated as the key with no passphrase and will use RSA_PKCS1_PADDING.
If public_key is an object, it is interpreted as a hash object with the
keys:


    

  • key : <String> - PEM encoded public key
    • 

  • passphrase : <String> - Optional passphrase for the private key
    • 

  • padding : An optional padding value, one of the following:
      

    • constants.RSA_NO_PADDING
      • 

    • constants.RSA_PKCS1_PADDING
      • 

    • constants.RSA_PKCS1_OAEP_PADDING
      • 

    

    • 



Because RSA public keys can be derived from private keys, a private key may
be passed instead of a public key.


All paddings are defined in the constants module.


crypto.publicEncrypt(public_key, buffer)#



Added in: v0.11.14

Encrypts buffer with public_key.


public_key can be an object or a string. If public_key is a string, it is
treated as the key with no passphrase and will use RSA_PKCS1_OAEP_PADDING.
If public_key is an object, it is interpreted as a hash object with the
keys:


    

  • key : <String> - PEM encoded public key
    • 

  • passphrase : <String> - Optional passphrase for the private key
    • 

  • padding : An optional padding value, one of the following:
      

    • constants.RSA_NO_PADDING
      • 

    • constants.RSA_PKCS1_PADDING
      • 

    • constants.RSA_PKCS1_OAEP_PADDING
      • 

    

    • 



Because RSA public keys can be derived from private keys, a private key may
be passed instead of a public key.


All paddings are defined in the constants module.


crypto.randomBytes(size[, callback])#



Added in: v0.5.8

Generates cryptographically strong pseudo-random data. The size argument
is a number indicating the number of bytes to generate.


If a callback function is provided, the bytes are generated asynchronously
and the callback function is invoked with two arguments: err and buf.
If an error occurs, err will be an Error object; otherwise it is null. The
buf argument is a Buffer containing the generated bytes.


// Asynchronous
const crypto = require('crypto');
crypto.randomBytes(256, (err, buf) => {
  if (err) throw err;
  console.log(`${buf.length} bytes of random data: ${buf.toString('hex')}`);
});



If the callback function is not provided, the random bytes are generated
synchronously and returned as a Buffer. An error will be thrown if
there is a problem generating the bytes.


// Synchronous
const buf = crypto.randomBytes(256);
console.log(
  `${buf.length} bytes of random data: ${buf.toString('hex')}`);



The crypto.randomBytes() method will block until there is sufficient entropy.
This should normally never take longer than a few milliseconds. The only time
when generating the random bytes may conceivably block for a longer period of
time is right after boot, when the whole system is still low on entropy.


crypto.setEngine(engine[, flags])#



Added in: v0.11.11

Load and set the engine for some or all OpenSSL functions (selected by flags).


engine could be either an id or a path to the engine's shared library.


The optional flags argument uses ENGINE_METHOD_ALL by default. The flags
is a bit field taking one of or a mix of the following flags (defined in the
constants module):


    

  • ENGINE_METHOD_RSA
    • 

  • ENGINE_METHOD_DSA
    • 

  • ENGINE_METHOD_DH
    • 

  • ENGINE_METHOD_RAND
    • 

  • ENGINE_METHOD_ECDH
    • 

  • ENGINE_METHOD_ECDSA
    • 

  • ENGINE_METHOD_CIPHERS
    • 

  • ENGINE_METHOD_DIGESTS
    • 

  • ENGINE_METHOD_STORE
    • 

  • ENGINE_METHOD_PKEY_METH
    • 

  • ENGINE_METHOD_PKEY_ASN1_METH
    • 

  • ENGINE_METHOD_ALL
    • 

  • ENGINE_METHOD_NONE
    • 



Notes#


Legacy Streams API (pre Node.js v0.10)#


The Crypto module was added to Node.js before there was the concept of a
unified Stream API, and before there were Buffer objects for handling
binary data. As such, the many of the crypto defined classes have methods not
typically found on other Node.js classes that implement the streams
API (e.g. update(), final(), or digest()). Also, many methods accepted
and returned 'binary' encoded strings by default rather than Buffers. This
default was changed after Node.js v0.8 to use Buffer objects by default
instead.


Recent ECDH Changes#


Usage of ECDH with non-dynamically generated key pairs has been simplified.
Now, ecdh.setPrivateKey() can be called with a preselected private key
and the associated public point (key) will be computed and stored in the object.
This allows code to only store and provide the private part of the EC key pair.
ecdh.setPrivateKey() now also validates that the private key is valid for
the selected curve.


The ecdh.setPublicKey() method is now deprecated as its inclusion in the
API is not useful. Either a previously stored private key should be set, which
automatically generates the associated public key, or ecdh.generateKeys()
should be called. The main drawback of using ecdh.setPublicKey() is that
it can be used to put the ECDH key pair into an inconsistent state.


Support for weak or compromised algorithms#


The crypto module still supports some algorithms which are already
compromised and are not currently recommended for use. The API also allows
the use of ciphers and hashes with a small key size that are considered to be
too weak for safe use.


Users should take full responsibility for selecting the crypto
algorithm and key size according to their security requirements.


Based on the recommendations of NIST SP 800-131A:


    

  • MD5 and SHA-1 are no longer acceptable where collision resistance is
required such as digital signatures.
    • 

  • The key used with RSA, DSA and DH algorithms is recommended to have
at least 2048 bits and that of the curve of ECDSA and ECDH at least
224 bits, to be safe to use for several years.
    • 

  • The DH groups of modp1, modp2 and modp5 have a key size
smaller than 2048 bits and are not recommended.
    • 



See the reference for other recommendations and details.




Debugger#


Stability: 2 - Stable


Node.js includes an out-of-process debugging utility accessible via a
TCP-based protocol and built-in debugging client. To use it, start Node.js
with the debug argument followed by the path to the script to debug; a prompt
will be displayed indicating successful launch of the debugger:


$ node debug myscript.js
< debugger listening on port 5858
connecting... ok
break in /home/indutny/Code/git/indutny/myscript.js:1
  1 x = 5;
  2 setTimeout(() => {
  3   debugger;
debug>

Node.js's debugger client is not a full-featured debugger, but simple step and
inspection are possible.


Inserting the statement debugger; into the source code of a script will
enable a breakpoint at that position in the code:


// myscript.js
x = 5;
setTimeout(() => {
  debugger;
  console.log('world');
}, 1000);
console.log('hello');



Once the debugger is run, a breakpoint will occur at line 4:


$ node debug myscript.js
< debugger listening on port 5858
connecting... ok
break in /home/indutny/Code/git/indutny/myscript.js:1
  1 x = 5;
  2 setTimeout(() => {
  3   debugger;
debug> cont
< hello
break in /home/indutny/Code/git/indutny/myscript.js:3
  1 x = 5;
  2 setTimeout(() => {
  3   debugger;
  4   console.log('world');
  5 }, 1000);
debug> next
break in /home/indutny/Code/git/indutny/myscript.js:4
  2 setTimeout(() => {
  3   debugger;
  4   console.log('world');
  5 }, 1000);
  6 console.log('hello');
debug> repl
Press Ctrl + C to leave debug repl
> x
5
> 2+2
4
debug> next
< world
break in /home/indutny/Code/git/indutny/myscript.js:5
  3   debugger;
  4   console.log('world');
  5 }, 1000);
  6 console.log('hello');
  7
debug> quit

The repl command allows code to be evaluated remotely. The next command
steps to the next line. Type help to see what other commands are available.


Watchers#


It is possible to watch expression and variable values while debugging. On
every breakpoint, each expression from the watchers list will be evaluated
in the current context and displayed immediately before the breakpoint's
source code listing.


To begin watching an expression, type watch('my_expression'). The command
watchers will print the active watchers. To remove a watcher, type
unwatch('my_expression').


Command reference#


Stepping#


    

  • cont, c - Continue execution
    • 

  • next, n - Step next
    • 

  • step, s - Step in
    • 

  • out, o - Step out
    • 

  • pause - Pause running code (like pause button in Developer Tools)
    • 



Breakpoints#


    

  • setBreakpoint(), sb() - Set breakpoint on current line
    • 

  • setBreakpoint(line), sb(line) - Set breakpoint on specific line
    • 

  • setBreakpoint('fn()'), sb(...) - Set breakpoint on a first statement in
functions body
    • 

  • setBreakpoint('script.js', 1), sb(...) - Set breakpoint on first line of
script.js
    • 

  • clearBreakpoint('script.js', 1), cb(...) - Clear breakpoint in script.js
on line 1
    • 



It is also possible to set a breakpoint in a file (module) that
isn't loaded yet:


$ node debug test/fixtures/break-in-module/main.js
< debugger listening on port 5858
connecting to port 5858... ok
break in test/fixtures/break-in-module/main.js:1
  1 var mod = require('./mod.js');
  2 mod.hello();
  3 mod.hello();
debug> setBreakpoint('mod.js', 23)
Warning: script 'mod.js' was not loaded yet.
  1 var mod = require('./mod.js');
  2 mod.hello();
  3 mod.hello();
debug> c
break in test/fixtures/break-in-module/mod.js:23
 21
 22 exports.hello = () => {
 23   return 'hello from module';
 24 };
 25
debug>

Information#


    

  • backtrace, bt - Print backtrace of current execution frame
    • 

  • list(5) - List scripts source code with 5 line context (5 lines before and
after)
    • 

  • watch(expr) - Add expression to watch list
    • 

  • unwatch(expr) - Remove expression from watch list
    • 

  • watchers - List all watchers and their values (automatically listed on each
breakpoint)
    • 

  • repl - Open debugger's repl for evaluation in debugging script's context
    • 

  • exec expr - Execute an expression in debugging script's context
    • 



Execution control#


    

  • run - Run script (automatically runs on debugger's start)
    • 

  • restart - Restart script
    • 

  • kill - Kill script
    • 



Various#


    

  • scripts - List all loaded scripts
    • 

  • version - Display V8's version
    • 



Advanced Usage#


An alternative way of enabling and accessing the debugger is to start
Node.js with the --debug command-line flag or by signaling an existing
Node.js process with SIGUSR1.


Once a process has been set in debug mode this way, it can be inspected
using the Node.js debugger by either connecting to the pid of the running
process or via URI reference to the listening debugger:


    

  • node debug -p <pid> - Connects to the process via the pid
    • 

  • node debug <URI> - Connects to the process via the URI such as
localhost:5858
    • 





UDP / Datagram Sockets#


Stability: 2 - Stable


The dgram module provides an implementation of UDP Datagram sockets.


const dgram = require('dgram');
const server = dgram.createSocket('udp4');

server.on('error', (err) => {
  console.log(`server error:\n${err.stack}`);
  server.close();
});

server.on('message', (msg, rinfo) => {
  console.log(`server got: ${msg} from ${rinfo.address}:${rinfo.port}`);
});

server.on('listening', () => {
  var address = server.address();
  console.log(`server listening ${address.address}:${address.port}`);
});

server.bind(41234);
// server listening 0.0.0.0:41234



Class: dgram.Socket#



Added in: v0.1.99

The dgram.Socket object is an EventEmitter that encapsulates the
datagram functionality.


New instances of dgram.Socket are created using dgram.createSocket().
The new keyword is not to be used to create dgram.Socket instances.


Event: 'close'#



Added in: v0.1.99

The 'close' event is emitted after a socket is closed with close().
Once triggered, no new 'message' events will be emitted on this socket.


Event: 'error'#



Added in: v0.1.99



The 'error' event is emitted whenever any error occurs. The event handler
function is passed a single Error object.


Event: 'listening'#



Added in: v0.1.99

The 'listening' event is emitted whenever a socket begins listening for
datagram messages. This occurs as soon as UDP sockets are created.


Event: 'message'#



Added in: v0.1.99

The 'message' event is emitted when a new datagram is available on a socket.
The event handler function is passed two arguments: msg and rinfo.



socket.addMembership(multicastAddress[, multicastInterface])#



Added in: v0.6.9



Tells the kernel to join a multicast group at the given multicastAddress and
multicastInterface using the IP_ADD_MEMBERSHIP socket option. If the
multicastInterface argument is not specified, the operating system will choose
one interface and will add membership to it. To add membership to every
available interface, call addMembership multiple times, once per interface.


socket.address()#



Added in: v0.1.99

Returns an object containing the address information for a socket.
For UDP sockets, this object will contain address, family and port
properties.


socket.bind([port][, address][, callback])#



Added in: v0.1.99

    

  • port <Number> - Integer, Optional
    • 

  • address <String>, Optional
    • 

  • callback <Function> with no parameters, Optional. Called when
binding is complete.
    • 



For UDP sockets, causes the dgram.Socket to listen for datagram
messages on a named port and optional address. If port is not
specified or is 0, the operating system will attempt to bind to a
random port. If address is not specified, the operating system will
attempt to listen on all addresses.  Once binding is complete, a
'listening' event is emitted and the optional callback function is
called.


Note that specifying both a 'listening' event listener and passing a
callback to the socket.bind() method is not harmful but not very
useful.


A bound datagram socket keeps the Node.js process running to receive
datagram messages.


If binding fails, an 'error' event is generated. In rare case (e.g.
attempting to bind with a closed socket), an Error may be thrown.


Example of a UDP server listening on port 41234:


const dgram = require('dgram');
const server = dgram.createSocket('udp4');

server.on('error', (err) => {
  console.log(`server error:\n${err.stack}`);
  server.close();
});

server.on('message', (msg, rinfo) => {
  console.log(`server got: ${msg} from ${rinfo.address}:${rinfo.port}`);
});

server.on('listening', () => {
  var address = server.address();
  console.log(`server listening ${address.address}:${address.port}`);
});

server.bind(41234);
// server listening 0.0.0.0:41234



socket.bind(options[, callback])#



Added in: v0.11.14



For UDP sockets, causes the dgram.Socket to listen for datagram
messages on a named port and optional address that are passed as
properties of an options object passed as the first argument. If
port is not specified or is 0, the operating system will attempt
to bind to a random port. If address is not specified, the operating
system will attempt to listen on all addresses.  Once binding is
complete, a 'listening' event is emitted and the optional callback
function is called.


Note that specifying both a 'listening' event listener and passing a
callback to the socket.bind() method is not harmful but not very
useful.


The options object may contain an additional exclusive property that is
use when using dgram.Socket objects with the cluster module. When
exclusive is set to false (the default), cluster workers will use the same
underlying socket handle allowing connection handling duties to be shared.
When exclusive is true, however, the handle is not shared and attempted
port sharing results in an error.


A bound datagram socket keeps the Node.js process running to receive
datagram messages.


If binding fails, an 'error' event is generated. In rare case (e.g.
attempting to bind with a closed socket), an Error may be thrown.


An example socket listening on an exclusive port is shown below.


socket.bind({
  address: 'localhost',
  port: 8000,
  exclusive: true
});



socket.close([callback])#



Added in: v0.1.99

Close the underlying socket and stop listening for data on it. If a callback is
provided, it is added as a listener for the 'close' event.


socket.dropMembership(multicastAddress[, multicastInterface])#



Added in: v0.6.9



Instructs the kernel to leave a multicast group at multicastAddress using the
IP_DROP_MEMBERSHIP socket option. This method is automatically called by the
kernel when the socket is closed or the process terminates, so most apps will
never have reason to call this.


If multicastInterface is not specified, the operating system will attempt to
drop membership on all valid interfaces.


socket.send(buf, offset, length, port, address[, callback])#



Added in: v0.1.99

    

  • buf <Buffer> | <String> Message to be sent
    • 

  • offset <Number> Integer. Offset in the buffer where the message starts.
    • 

  • length <Number> Integer. Number of bytes in the message.
    • 

  • port <Number> Integer. Destination port.
    • 

  • address <String> Destination hostname or IP address.
    • 

  • callback <Function> Called when the message has been sent. Optional.
    • 



Broadcasts a datagram on the socket. The destination port and address must
be specified.


The buf argument is a Buffer object containing the message. The offset
and length specify the offset within the Buffer where the message begins
and the number of bytes in the message, respectively. With messages that
contain  multi-byte characters, offset and length will be calculated with
respect to byte length and not the character position.


The address argument is a string. If the value of address is a host name,
DNS will be used to resolve the address of the host. If the address is not
specified or is an empty string, '0.0.0.0' or '::0' will be used instead.
It is possible, depending on the network configuration, that these defaults
may not work; accordingly, it is best to be explicit about the destination
address.


If the socket has not been previously bound with a call to bind, the socket
is assigned a random port number and is bound to the "all interfaces" address
('0.0.0.0' for udp4 sockets, '::0' for udp6 sockets.)


An optional callback function  may be specified to as a way of reporting
DNS errors or for determining when it is safe to reuse the buf object.
Note that DNS lookups delay the time to send for at least one tick of the
Node.js event loop.


The only way to know for sure that the datagram has been sent is by using a
callback. If an error occurs and a callback is given, the error will be
passed as the first argument to the callback. If a callback is not given,
the error is emitted as an 'error' event on the socket object.


Example of sending a UDP packet to a random port on localhost;


const dgram = require('dgram');
const message = new Buffer('Some bytes');
const client = dgram.createSocket('udp4');
client.send(message, 0, message.length, 41234, 'localhost', (err) => {
  client.close();
});



A Note about UDP datagram size


The maximum size of an IPv4/v6 datagram depends on the MTU
(Maximum Transmission Unit) and on the Payload Length field size.


    

  • The Payload Length field is 16 bits wide, which means that a normal
payload exceed 64K octets including the internet header and data
(65,507 bytes = 65,535 − 8 bytes UDP header − 20 bytes IP header);
this is generally true for loopback interfaces, but such long datagram
messages are impractical for most hosts and networks.
    

    • 

  • The MTU is the largest size a given link layer technology can support for
datagram messages. For any link, IPv4 mandates a minimum MTU of 68
octets, while the recommended MTU for IPv4 is 576 (typically recommended
as the MTU for dial-up type applications), whether they arrive whole or in
fragments.
    

    For IPv6, the minimum MTU is 1280 octets, however, the mandatory minimum
fragment reassembly buffer size is 1500 octets. The value of 68 octets is
very small, since most current link layer technologies, like Ethernet, have a
minimum MTU of 1500.
    

    • 



It is impossible to know in advance the MTU of each link through which
a packet might travel. Sending a datagram greater than the receiver MTU will
not work because the packet will get silently dropped without informing the
source that the data did not reach its intended recipient.


socket.setBroadcast(flag)#




Sets or clears the SO_BROADCAST socket option.  When set to true, UDP
packets may be sent to a local interface's broadcast address.


socket.setMulticastLoopback(flag)#



Added in: v0.3.8



Sets or clears the IP_MULTICAST_LOOP socket option.  When set to true,
multicast packets will also be received on the local interface.


socket.setMulticastTTL(ttl)#



Added in: v0.3.8



Sets the IP_MULTICAST_TTL socket option.  While TTL generally stands for
"Time to Live", in this context it specifies the number of IP hops that a
packet is allowed to travel through, specifically for multicast traffic.  Each
router or gateway that forwards a packet decrements the TTL. If the TTL is
decremented to 0 by a router, it will not be forwarded.


The argument passed to to socket.setMulticastTTL() is a number of hops
between 0 and 255. The default on most systems is 1 but can vary.


socket.setTTL(ttl)#



Added in: v0.1.101



Sets the IP_TTL socket option. While TTL generally stands for "Time to Live",
in this context it specifies the number of IP hops that a packet is allowed to
travel through.  Each router or gateway that forwards a packet decrements the
TTL.  If the TTL is decremented to 0 by a router, it will not be forwarded.
Changing TTL values is typically done for network probes or when multicasting.


The argument to socket.setTTL() is a number of hops between 1 and 255.
The default on most systems is 64 but can vary.


socket.ref()#



Added in: v0.9.1

By default, binding a socket will cause it to block the Node.js process from
exiting as long as the socket is open. The socket.unref() method can be used
to exclude the socket from the reference counting that keeps the Node.js
process active. The socket.ref() method adds the socket back to the reference
counting and restores the default behavior.


Calling socket.ref() multiples times will have no additional effect.


The socket.ref() method returns a reference to the socket so calls can be
chained.


socket.unref()#



Added in: v0.9.1

By default, binding a socket will cause it to block the Node.js process from
exiting as long as the socket is open. The socket.unref() method can be used
to exclude the socket from the reference counting that keeps the Node.js
process active, allowing the process to exit even if the socket is still
listening.


Calling socket.unref() multiple times will have no addition effect.


The socket.unref() method returns a reference to the socket so calls can be
chained.


Change to asynchronous socket.bind() behavior#


As of Node.js v0.10, dgram.Socket#bind() changed to an asynchronous
execution model. Legacy code that assumes synchronous behavior, as in the
following example:


const s = dgram.createSocket('udp4');
s.bind(1234);
s.addMembership('224.0.0.114');



Must be changed to pass a callback function to the dgram.Socket#bind()
function:


const s = dgram.createSocket('udp4');
s.bind(1234, () => {
  s.addMembership('224.0.0.114');
});



dgram module functions#


dgram.createSocket(options[, callback])#



Added in: v0.11.13



Creates a dgram.Socket object. The options argument is an object that
should contain a type field of either udp4 or udp6 and an optional
boolean reuseAddr field.


When reuseAddr is true socket.bind() will reuse the address, even if
another process has already bound a socket on it. reuseAddr defaults to
false. The optional callback function is added as a listener for 'message'
events.


Once the socket is created, calling socket.bind() will instruct the
socket to begin listening for datagram messages. When address and port are
not passed to  socket.bind() the method will bind the socket to the "all
interfaces" address on a random port (it does the right thing for both udp4
and udp6 sockets). The bound address and port can be retrieved using
socket.address().address and socket.address().port.


dgram.createSocket(type[, callback])#



Added in: v0.1.99



Creates a dgram.Socket object of the specified type. The type argument
can be either udp4 or udp6. An optional callback function can be passed
which is added as a listener for 'message' events.


Once the socket is created, calling socket.bind() will instruct the
socket to begin listening for datagram messages. When address and port are
not passed to  socket.bind() the method will bind the socket to the "all
interfaces" address on a random port (it does the right thing for both udp4
and udp6 sockets). The bound address and port can be retrieved using
socket.address().address and socket.address().port.




DNS#


Stability: 2 - Stable
The dns module contains functions belonging to two different categories:


1) Functions that use the underlying operating system facilities to perform
name resolution, and that do not necessarily perform any network communication.
This category contains only one function: dns.lookup(). Developers
looking to perform name resolution in the same way that other applications on
the same operating system behave should use dns.lookup().


For example, looking up iana.org.


const dns = require('dns');

dns.lookup('nodejs.org', (err, addresses, family) => {
  console.log('addresses:', addresses);
});
// address: "192.0.43.8" family: IPv4



2) Functions that connect to an actual DNS server to perform name resolution,
and that always use the network to perform DNS queries. This category
contains all functions in the dns module except dns.lookup(). These
functions do not use the same set of configuration files used by
dns.lookup() (e.g. /etc/hosts). These functions should be used by
developers who do not want to use the underlying operating system's facilities
for name resolution, and instead want to always perform DNS queries.


Below is an example that resolves 'archive.org' then reverse resolves the IP
addresses that are returned.


const dns = require('dns');

dns.resolve4('archive.org', (err, addresses) => {
  if (err) throw err;

  console.log(`addresses: ${JSON.stringify(addresses)}`);

  addresses.forEach((a) => {
    dns.reverse(a, (err, hostnames) => {
      if (err) {
        throw err;
      }
      console.log(`reverse for ${a}: ${JSON.stringify(hostnames)}`);
    });
  });
});



There are subtle consequences in choosing one over the other, please consult
the Implementation considerations section for more information.


dns.getServers()#



Added in: v0.11.3

Returns an array of IP address strings that are being used for name
resolution.


dns.lookup(hostname[, options], callback)#



Added in: v0.1.90

Resolves a hostname (e.g. 'nodejs.org') into the first found A (IPv4) or
AAAA (IPv6) record. options can be an object or integer. If options is
not provided, then IPv4 and IPv6 addresses are both valid. If options is
an integer, then it must be 4 or 6.


Alternatively, options can be an object containing these properties:


    

  • family <Number> - The record family. If present, must be the integer
4 or 6. If not provided, both IP v4 and v6 addresses are accepted.
    • 

  • hints: <Number> - If present, it should be one or more of the supported
getaddrinfo flags. If hints is not provided, then no flags are passed to
getaddrinfo. Multiple flags can be passed through hints by bitwise
ORing their values.
See supported getaddrinfo flags for more information on supported
flags.
    • 

  • all: <Boolean> - When true, the callback returns all resolved addresses
in an array, otherwise returns a single address. Defaults to false.
    • 



All properties are optional. An example usage of options is shown below.


{
  family: 4,
  hints: dns.ADDRCONFIG | dns.V4MAPPED,
  all: false
}

The callback function has arguments (err, address, family). address is a
string representation of an IPv4 or IPv6 address. family is either the
integer 4 or 6 and denotes the family of address (not necessarily the
value initially passed to lookup).


With the all option set to true, the arguments change to
(err, addresses), with addresses being an array of objects with the
properties address and family.


On error, err is an Error object, where err.code is the error code.
Keep in mind that err.code will be set to 'ENOENT' not only when
the hostname does not exist but also when the lookup fails in other ways
such as no available file descriptors.


dns.lookup() does not necessarily have anything to do with the DNS protocol.
The implementation uses an operating system facility that can associate names
with addresses, and vice versa. This implementation can have subtle but
important consequences on the behavior of any Node.js program. Please take some
time to consult the Implementation considerations section before using
dns.lookup().


Example usage:


const dns = require('dns');
const options = {
  family: 6,
  hints: dns.ADDRCONFIG | dns.V4MAPPED,
};
dns.lookup('example.com', options, (err, address, family) =>
  console.log('address: %j family: IPv%s', address, family));
// address: "2606:2800:220:1:248:1893:25c8:1946" family: IPv6

// When options.all is true, the result will be an Array.
options.all = true;
dns.lookup('example.com', options, (err, addresses) =>
  console.log('addresses: %j', addresses));
// addresses: [{"address":"2606:2800:220:1:248:1893:25c8:1946","family":6}]



Supported getaddrinfo flags#


The following flags can be passed as hints to dns.lookup().


    

  • dns.ADDRCONFIG: Returned address types are determined by the types
of addresses supported by the current system. For example, IPv4 addresses
are only returned if the current system has at least one IPv4 address
configured. Loopback addresses are not considered.
    • 

  • dns.V4MAPPED: If the IPv6 family was specified, but no IPv6 addresses were
found, then return IPv4 mapped IPv6 addresses. Note that it is not supported
on some operating systems (e.g FreeBSD 10.1).
    • 



dns.lookupService(address, port, callback)#



Added in: v0.11.14

Resolves the given address and port into a hostname and service using
the operating system's underlying getnameinfo implementation.


The callback has arguments (err, hostname, service). The hostname and
service arguments are strings (e.g. 'localhost' and 'http' respectively).


On error, err is an Error object, where err.code is the error code.


const dns = require('dns');
dns.lookupService('127.0.0.1', 22, (err, hostname, service) => {
  console.log(hostname, service);
    // Prints: localhost ssh
});



dns.resolve(hostname[, rrtype], callback)#



Added in: v0.1.27

Uses the DNS protocol to resolve a hostname (e.g. 'nodejs.org') into an
array of the record types specified by rrtype.


Valid values for rrtype are:


    

  • 'A' - IPV4 addresses, default
    • 

  • 'AAAA' - IPV6 addresses
    • 

  • 'MX' - mail exchange records
    • 

  • 'TXT' - text records
    • 

  • 'SRV' - SRV records
    • 

  • 'PTR' - used for reverse IP lookups
    • 

  • 'NS' - name server records
    • 

  • 'CNAME' - canonical name records
    • 

  • 'SOA' - start of authority record
    • 

  • 'NAPTR' - name authority pointer record
    • 



The callback function has arguments (err, addresses). When successful,
addresses will be an array, except when resolving an SOA record which returns
an object structured in the same manner as one returned by the
dns.resolveSoa() method. The type of each item in addresses is
determined by the record type, and described in the documentation for the
corresponding lookup methods.


On error, err is an Error object, where err.code is
one of the error codes listed here.


dns.resolve4(hostname, callback)#



Added in: v0.1.16

Uses the DNS protocol to resolve a IPv4 addresses (A records) for the
hostname. The addresses argument passed to the callback function
will contain an array of IPv4 addresses (e.g.
['74.125.79.104', '74.125.79.105', '74.125.79.106']).


dns.resolve6(hostname, callback)#



Added in: v0.1.16

Uses the DNS protocol to resolve a IPv6 addresses (AAAA records) for the
hostname. The addresses argument passed to the callback function
will contain an array of IPv6 addresses.


dns.resolveCname(hostname, callback)#



Added in: v0.3.2

Uses the DNS protocol to resolve CNAME records for the hostname. The
addresses argument passed to the callback function
will contain an array of canonical name records available for the hostname
(e.g. ['bar.example.com']).


dns.resolveMx(hostname, callback)#



Added in: v0.1.27

Uses the DNS protocol to resolve mail exchange records (MX records) for the
hostname. The addresses argument passed to the callback function will
contain an array of objects containing both a priority and exchange
property (e.g. [{priority: 10, exchange: 'mx.example.com'}, ...]).


dns.resolveNaptr(hostname, callback)#



Added in: v0.9.12

Uses the DNS protocol to resolve regular expression based records (NAPTR
records) for the hostname. The callback function has arguments
(err, addresses).  The addresses argument passed to the callback function
will contain an array of objects with the following properties:


    

  • flags
    • 

  • service
    • 

  • regexp
    • 

  • replacement
    • 

  • order
    • 

  • preference
    • 



For example:


{
  flags: 's',
  service: 'SIP+D2U',
  regexp: '',
  replacement: '_sip._udp.example.com',
  order: 30,
  preference: 100
}



dns.resolveNs(hostname, callback)#



Added in: v0.1.90

Uses the DNS protocol to resolve name server records (NS records) for the
hostname. The addresses argument passed to the callback function will
contain an array of name server records available for hostname
(e.g. ['ns1.example.com', 'ns2.example.com']).


dns.resolveSoa(hostname, callback)#



Added in: v0.11.10

Uses the DNS protocol to resolve a start of authority record (SOA record) for
the hostname. The addresses argument passed to the callback function will
be an object with the following properties:


    

  • nsname
    • 

  • hostmaster
    • 

  • serial
    • 

  • refresh
    • 

  • retry
    • 

  • expire
    • 

  • minttl
    • 



{
  nsname: 'ns.example.com',
  hostmaster: 'root.example.com',
  serial: 2013101809,
  refresh: 10000,
  retry: 2400,
  expire: 604800,
  minttl: 3600
}

dns.resolveSrv(hostname, callback)#



Added in: v0.1.27

Uses the DNS protocol to resolve service records (SRV records) for the
hostname. The addresses argument passed to the callback function will
be an array of objects with the following properties:


    

  • priority
    • 

  • weight
    • 

  • port
    • 

  • name
    • 



{
  priority: 10,
  weight: 5,
  port: 21223,
  name: 'service.example.com'
}

dns.resolveTxt(hostname, callback)#



Added in: v0.1.27

Uses the DNS protocol to resolve text queries (TXT records) for the
hostname. The addresses argument passed to the callback function is
is a two-dimentional array of the text records available for hostname (e.g.,
[ ['v=spf1 ip4:0.0.0.0 ', '~all' ] ]). Each sub-array contains TXT chunks of
one record. Depending on the use case, these could be either joined together or
treated separately.


dns.reverse(ip, callback)#



Added in: v0.1.16

Performs a reverse DNS query that resolves an IPv4 or IPv6 address to an
array of hostnames.


The callback function has arguments (err, hostnames), where hostnames
is an array of resolved hostnames for the given ip.


On error, err is an Error object, where err.code is
one of the DNS error codes.


dns.setServers(servers)#



Added in: v0.11.3

Sets the IP addresses of the servers to be used when resolving. The servers
argument is an array of IPv4 or IPv6 addresses.


If a port specified on the address it will be removed.


An error will be thrown if an invalid address is provided.


The dns.setServers() method must not be called while a DNS query is in
progress.


Error codes#


Each DNS query can return one of the following error codes:


    

  • dns.NODATA: DNS server returned answer with no data.
    • 

  • dns.FORMERR: DNS server claims query was misformatted.
    • 

  • dns.SERVFAIL: DNS server returned general failure.
    • 

  • dns.NOTFOUND: Domain name not found.
    • 

  • dns.NOTIMP: DNS server does not implement requested operation.
    • 

  • dns.REFUSED: DNS server refused query.
    • 

  • dns.BADQUERY: Misformatted DNS query.
    • 

  • dns.BADNAME: Misformatted hostname.
    • 

  • dns.BADFAMILY: Unsupported address family.
    • 

  • dns.BADRESP: Misformatted DNS reply.
    • 

  • dns.CONNREFUSED: Could not contact DNS servers.
    • 

  • dns.TIMEOUT: Timeout while contacting DNS servers.
    • 

  • dns.EOF: End of file.
    • 

  • dns.FILE: Error reading file.
    • 

  • dns.NOMEM: Out of memory.
    • 

  • dns.DESTRUCTION: Channel is being destroyed.
    • 

  • dns.BADSTR: Misformatted string.
    • 

  • dns.BADFLAGS: Illegal flags specified.
    • 

  • dns.NONAME: Given hostname is not numeric.
    • 

  • dns.BADHINTS: Illegal hints flags specified.
    • 

  • dns.NOTINITIALIZED: c-ares library initialization not yet performed.
    • 

  • dns.LOADIPHLPAPI: Error loading iphlpapi.dll.
    • 

  • dns.ADDRGETNETWORKPARAMS: Could not find GetNetworkParams function.
    • 

  • dns.CANCELLED: DNS query cancelled.
    • 



Implementation considerations#


Although dns.lookup() and the various dns.resolve*()/dns.reverse()
functions have the same goal of associating a network name with a network
address (or vice versa), their behavior is quite different. These differences
can have subtle but significant consequences on the behavior of Node.js
programs.


dns.lookup()#


Under the hood, dns.lookup() uses the same operating system facilities
as most other programs. For instance, dns.lookup() will almost always
resolve a given name the same way as the ping command. On most POSIX-like
operating systems, the behavior of the dns.lookup() function can be
modified by changing settings in nsswitch.conf(5) and/or resolv.conf(5),
but note that changing these files will change the behavior of all other
programs running on the same operating system.


Though the call to dns.lookup() will be asynchronous from JavaScript's
perspective, it is implemented as a synchronous call to getaddrinfo(3) that
runs on libuv's threadpool. Because libuv's threadpool has a fixed size, it
means that if for whatever reason the call to getaddrinfo(3) takes a long
time, other operations that could run on libuv's threadpool (such as filesystem
operations) will experience degraded performance. In order to mitigate this
issue, one potential solution is to increase the size of libuv's threadpool by
setting the 'UV_THREADPOOL_SIZE' environment variable to a value greater than
4 (its current default value). For more information on libuv's threadpool, see
the official libuv documentation.


dns.resolve(), dns.resolve*() and dns.reverse()#


These functions are implemented quite differently than dns.lookup(). They
do not use getaddrinfo(3) and they always perform a DNS query on the
network. This network communication is always done asynchronously, and does not
use libuv's threadpool.


As a result, these functions cannot have the same negative impact on other
processing that happens on libuv's threadpool that dns.lookup() can have.


They do not use the same set of configuration files than what dns.lookup()
uses. For instance, they do not use the configuration from /etc/hosts.




Domain#


Stability: 0 - Deprecated
This module is pending deprecation. Once a replacement API has been
finalized, this module will be fully deprecated. Most end users should
not have cause to use this module. Users who absolutely must have
the functionality that domains provide may rely on it for the time being
but should expect to have to migrate to a different solution
in the future.


Domains provide a way to handle multiple different IO operations as a
single group.  If any of the event emitters or callbacks registered to a
domain emit an 'error' event, or throw an error, then the domain object
will be notified, rather than losing the context of the error in the
process.on('uncaughtException') handler, or causing the program to
exit immediately with an error code.


Warning: Don't Ignore Errors!#



Domain error handlers are not a substitute for closing down your
process when an error occurs.


By the very nature of how throw works in JavaScript, there is almost
never any way to safely "pick up where you left off", without leaking
references, or creating some other sort of undefined brittle state.


The safest way to respond to a thrown error is to shut down the
process.  Of course, in a normal web server, you might have many
connections open, and it is not reasonable to abruptly shut those down
because an error was triggered by someone else.


The better approach is to send an error response to the request that
triggered the error, while letting the others finish in their normal
time, and stop listening for new requests in that worker.


In this way, domain usage goes hand-in-hand with the cluster module,
since the master process can fork a new worker when a worker
encounters an error.  For Node.js programs that scale to multiple
machines, the terminating proxy or service registry can take note of
the failure, and react accordingly.


For example, this is not a good idea:


// XXX WARNING!  BAD IDEA!

const d = require('domain').create();
d.on('error', (er) => {
  // The error won't crash the process, but what it does is worse!
  // Though we've prevented abrupt process restarting, we are leaking
  // resources like crazy if this ever happens.
  // This is no better than process.on('uncaughtException')!
  console.log(`error, but oh well ${er.message}`);
});
d.run(() => {
  require('http').createServer((req, res) => {
    handleRequest(req, res);
  }).listen(PORT);
});



By using the context of a domain, and the resilience of separating our
program into multiple worker processes, we can react more
appropriately, and handle errors with much greater safety.


// Much better!

const cluster = require('cluster');
const PORT = +process.env.PORT || 1337;

if (cluster.isMaster) {
  // In real life, you'd probably use more than just 2 workers,
  // and perhaps not put the master and worker in the same file.
  //
  // You can also of course get a bit fancier about logging, and
  // implement whatever custom logic you need to prevent DoS
  // attacks and other bad behavior.
  //
  // See the options in the cluster documentation.
  //
  // The important thing is that the master does very little,
  // increasing our resilience to unexpected errors.

  cluster.fork();
  cluster.fork();

  cluster.on('disconnect', (worker) => {
    console.error('disconnect!');
    cluster.fork();
  });

} else {
  // the worker
  //
  // This is where we put our bugs!

  const domain = require('domain');

  // See the cluster documentation for more details about using
  // worker processes to serve requests.  How it works, caveats, etc.

  const server = require('http').createServer((req, res) => {
    const d = domain.create();
    d.on('error', (er) => {
      console.error(`error ${er.stack}`);

      // Note: we're in dangerous territory!
      // By definition, something unexpected occurred,
      // which we probably didn't want.
      // Anything can happen now!  Be very careful!

      try {
        // make sure we close down within 30 seconds
        const killtimer = setTimeout(() => {
          process.exit(1);
        }, 30000);
        // But don't keep the process open just for that!
        killtimer.unref();

        // stop taking new requests.
        server.close();

        // Let the master know we're dead.  This will trigger a
        // 'disconnect' in the cluster master, and then it will fork
        // a new worker.
        cluster.worker.disconnect();

        // try to send an error to the request that triggered the problem
        res.statusCode = 500;
        res.setHeader('content-type', 'text/plain');
        res.end('Oops, there was a problem!\n');
      } catch (er2) {
        // oh well, not much we can do at this point.
        console.error(`Error sending 500! ${er2.stack}`);
      }
    });

    // Because req and res were created before this domain existed,
    // we need to explicitly add them.
    // See the explanation of implicit vs explicit binding below.
    d.add(req);
    d.add(res);

    // Now run the handler function in the domain.
    d.run(() => {
      handleRequest(req, res);
    });
  });
  server.listen(PORT);
}

// This part isn't important.  Just an example routing thing.
// You'd put your fancy application logic here.
function handleRequest(req, res) {
  switch (req.url) {
    case '/error':
      // We do some async stuff, and then...
      setTimeout(() => {
        // Whoops!
        flerb.bark();
      });
      break;
    default:
      res.end('ok');
  }
}



Additions to Error objects#



Any time an Error object is routed through a domain, a few extra fields
are added to it.


    

  • error.domain The domain that first handled the error.
    • 

  • error.domainEmitter The event emitter that emitted an 'error' event
with the error object.
    • 

  • error.domainBound The callback function which was bound to the
domain, and passed an error as its first argument.
    • 

  • error.domainThrown A boolean indicating whether the error was
thrown, emitted, or passed to a bound callback function.
    • 



Implicit Binding#



If domains are in use, then all new EventEmitter objects (including
Stream objects, requests, responses, etc.) will be implicitly bound to
the active domain at the time of their creation.


Additionally, callbacks passed to lowlevel event loop requests (such as
to fs.open, or other callback-taking methods) will automatically be
bound to the active domain.  If they throw, then the domain will catch
the error.


In order to prevent excessive memory usage, Domain objects themselves
are not implicitly added as children of the active domain.  If they
were, then it would be too easy to prevent request and response objects
from being properly garbage collected.


If you want to nest Domain objects as children of a parent Domain,
then you must explicitly add them.


Implicit binding routes thrown errors and 'error' events to the
Domain's 'error' event, but does not register the EventEmitter on the
Domain, so domain.dispose() will not shut down the EventEmitter.
Implicit binding only takes care of thrown errors and 'error' events.


Explicit Binding#



Sometimes, the domain in use is not the one that ought to be used for a
specific event emitter.  Or, the event emitter could have been created
in the context of one domain, but ought to instead be bound to some
other domain.


For example, there could be one domain in use for an HTTP server, but
perhaps we would like to have a separate domain to use for each request.


That is possible via explicit binding.


For example:


// create a top-level domain for the server
const domain = require('domain');
const http = require('http');
const serverDomain = domain.create();

serverDomain.run(() => {
  // server is created in the scope of serverDomain
  http.createServer((req, res) => {
    // req and res are also created in the scope of serverDomain
    // however, we'd prefer to have a separate domain for each request.
    // create it first thing, and add req and res to it.
    const reqd = domain.create();
    reqd.add(req);
    reqd.add(res);
    reqd.on('error', (er) => {
      console.error('Error', er, req.url);
      try {
        res.writeHead(500);
        res.end('Error occurred, sorry.');
      } catch (er2) {
        console.error('Error sending 500', er2, req.url);
      }
    });
  }).listen(1337);
});



domain.create()#


    

  • Returns: <Domain>
    • 



Returns a new Domain object.


Class: Domain#


The Domain class encapsulates the functionality of routing errors and
uncaught exceptions to the active Domain object.


Domain is a child class of EventEmitter.  To handle the errors that it
catches, listen to its 'error' event.


domain.run(fn[, arg][, ...])#




Run the supplied function in the context of the domain, implicitly
binding all event emitters, timers, and lowlevel requests that are
created in that context. Optionally, arguments can be passed to
the function.


This is the most basic way to use a domain.


Example:


const domain = require('domain');
const fs = require('fs');
const d = domain.create();
d.on('error', (er) => {
  console.error('Caught error!', er);
});
d.run(() => {
  process.nextTick(() => {
    setTimeout(() => { // simulating some various async stuff
      fs.open('non-existent file', 'r', (er, fd) => {
        if (er) throw er;
        // proceed...
      });
    }, 100);
  });
});



In this example, the d.on('error') handler will be triggered, rather
than crashing the program.


domain.members#




An array of timers and event emitters that have been explicitly added
to the domain.


domain.add(emitter)#




Explicitly adds an emitter to the domain.  If any event handlers called by
the emitter throw an error, or if the emitter emits an 'error' event, it
will be routed to the domain's 'error' event, just like with implicit
binding.


This also works with timers that are returned from setInterval() and
setTimeout().  If their callback function throws, it will be caught by
the domain 'error' handler.


If the Timer or EventEmitter was already bound to a domain, it is removed
from that one, and bound to this one instead.


domain.remove(emitter)#




The opposite of domain.add(emitter).  Removes domain handling from the
specified emitter.


domain.bind(callback)#




The returned function will be a wrapper around the supplied callback
function.  When the returned function is called, any errors that are
thrown will be routed to the domain's 'error' event.


Example#


const d = domain.create();

function readSomeFile(filename, cb) {
  fs.readFile(filename, 'utf8', d.bind((er, data) => {
    // if this throws, it will also be passed to the domain
    return cb(er, data ? JSON.parse(data) : null);
  }));
}

d.on('error', (er) => {
  // an error occurred somewhere.
  // if we throw it now, it will crash the program
  // with the normal line number and stack message.
});



domain.intercept(callback)#




This method is almost identical to domain.bind(callback).  However, in
addition to catching thrown errors, it will also intercept Error
objects sent as the first argument to the function.


In this way, the common if (err) return callback(err); pattern can be replaced
with a single error handler in a single place.


Example#


const d = domain.create();

function readSomeFile(filename, cb) {
  fs.readFile(filename, 'utf8', d.intercept((data) => {
    // note, the first argument is never passed to the
    // callback since it is assumed to be the 'Error' argument
    // and thus intercepted by the domain.

    // if this throws, it will also be passed to the domain
    // so the error-handling logic can be moved to the 'error'
    // event on the domain instead of being repeated throughout
    // the program.
    return cb(null, JSON.parse(data));
  }));
}

d.on('error', (er) => {
  // an error occurred somewhere.
  // if we throw it now, it will crash the program
  // with the normal line number and stack message.
});



domain.enter()#


The enter method is plumbing used by the run, bind, and intercept
methods to set the active domain. It sets domain.active and process.domain
to the domain, and implicitly pushes the domain onto the domain stack managed
by the domain module (see domain.exit() for details on the domain stack). The
call to enter delimits the beginning of a chain of asynchronous calls and I/O
operations bound to a domain.


Calling enter changes only the active domain, and does not alter the domain
itself. enter and exit can be called an arbitrary number of times on a
single domain.


If the domain on which enter is called has been disposed, enter will return
without setting the domain.


domain.exit()#


The exit method exits the current domain, popping it off the domain stack.
Any time execution is going to switch to the context of a different chain of
asynchronous calls, it's important to ensure that the current domain is exited.
The call to exit delimits either the end of or an interruption to the chain
of asynchronous calls and I/O operations bound to a domain.


If there are multiple, nested domains bound to the current execution context,
exit will exit any domains nested within this domain.


Calling exit changes only the active domain, and does not alter the domain
itself. enter and exit can be called an arbitrary number of times on a
single domain.


If the domain on which exit is called has been disposed, exit will return
without exiting the domain.


domain.dispose()#


Stability: 0 - Deprecated.  Please recover from failed IO actions explicitly via error event handlers set on the domain.
Once dispose has been called, the domain will no longer be used by callbacks
bound into the domain via run, bind, or intercept, and a 'dispose' event
is emitted.




Errors#



Applications running in Node.js will generally experience four categories of
errors:


    

  • Standard JavaScript errors such as:
      

    • <EvalError> : thrown when a call to eval() fails.
      • 

    • <SyntaxError> : thrown in response to improper JavaScript language
syntax.
      • 

    • <RangeError> : thrown when a value is not within an expected range
      • 

    • <ReferenceError> : thrown when using undefined variables
      • 

    • <TypeError> : thrown when passing arguments of the wrong type
      • 

    • <URIError> : thrown when a global URI handling function is misused.
      • 

    

    • 

  • System errors triggered by underlying operating system constraints such
as attempting to open a file that does not exist, attempting to send data
over a closed socket, etc;
    • 

  • And User-specified errors triggered by application code.
    • 

  • Assertion Errors are a special class of error that can be triggered whenever
Node.js detects an exceptional logic violation that should never occur. These
are raised typically by the assert module.
    • 



All JavaScript and System errors raised by Node.js inherit from, or are
instances of, the standard JavaScript <Error> class and are guaranteed
to provide at least the properties available on that class.


Error Propagation and Interception#



Node.js supports several mechanisms for propagating and handling errors that
occur while an application is running. How these errors are reported and
handled depends entirely on the type of Error and the style of the API that is
called.


All JavaScript errors are handled as exceptions that immediately generate
and throw an error using the standard JavaScript throw mechanism. These
are handled using the try / catch construct provided by the JavaScript
language.


// Throws with a ReferenceError because z is undefined
try {
  const m = 1;
  const n = m + z;
} catch (err) {
  // Handle the error here.
}



Any use of the JavaScript throw mechanism will raise an exception that
must be handled using try / catch or the Node.js process will exit
immediately.


With few exceptions, Synchronous APIs (any blocking method that does not
accept a callback function, such as fs.readFileSync), will use throw
to report errors.


Errors that occur within Asynchronous APIs may be reported in multiple ways:


    

  • Most asynchronous methods that accept a callback function will accept an
Error object passed as the first argument to that function. If that first
argument is not null and is an instance of Error, then an error occurred
that should be handled.
    

    const fs = require('fs');
fs.readFile('a file that does not exist', (err, data) => {
  if (err) {
    console.error('There was an error reading the file!', err);
    return;
  }
  // Otherwise handle the data
});

    

    • 

  • When an asynchronous method is called on an object that is an EventEmitter,
errors can be routed to that object's 'error' event.
    

    const net = require('net');
const connection = net.connect('localhost');

// Adding an 'error' event handler to a stream:
connection.on('error', (err) => {
  // If the connection is reset by the server, or if it can't
  // connect at all, or on any sort of error encountered by
  // the connection, the error will be sent here.
  console.error(err);
});

connection.pipe(process.stdout);

    

    • 

  • A handful of typically asynchronous methods in the Node.js API may still
use the throw mechanism to raise exceptions that must be handled using
try / catch. There is no comprehensive list of such methods; please
refer to the documentation of each method to determine the appropriate
error handling mechanism required.
    

    • 



The use of the 'error' event mechanism is most common for stream-based
and event emitter-based APIs, which themselves represent a series of
asynchronous operations over time (as opposed to a single operation that may
pass or fail).


For all EventEmitter objects, if an 'error' event handler is not
provided, the error will be thrown, causing the Node.js process to report an
unhandled exception and  crash unless either: The domain module is used
appropriately or a handler has been registered for the
process.on('uncaughtException') event.


const EventEmitter = require('events');
const ee = new EventEmitter();

setImmediate(() => {
  // This will crash the process because no 'error' event
  // handler has been added.
  ee.emit('error', new Error('This will crash'));
});



Errors generated in this way cannot be intercepted using try / catch as
they are thrown after the calling code has already exited.


Developers must refer to the documentation for each method to determine
exactly how errors raised by those methods are propagated.


Node.js style callbacks#



Most asynchronous methods exposed by the Node.js core API follow an idiomatic
pattern  referred to as a "Node.js style callback". With this pattern, a
callback function is passed to the method as an argument. When the operation
either completes or an error is raised, the callback function is called with
the Error object (if any) passed as the first argument. If no error was raised,
the first argument will be passed as null.


const fs = require('fs');

function nodeStyleCallback(err, data) {
 if (err) {
   console.error('There was an error', err);
   return;
 }
 console.log(data);
}

fs.readFile('/some/file/that/does-not-exist', nodeStyleCallback);
fs.readFile('/some/file/that/does-exist', nodeStyleCallback)



The JavaScript try / catch mechanism cannot be used to intercept errors
generated by asynchronous APIs.  A common mistake for beginners is to try to
use throw inside a Node.js style callback:


// THIS WILL NOT WORK:
const fs = require('fs');

try {
  fs.readFile('/some/file/that/does-not-exist', (err, data) => {
    // mistaken assumption: throwing here...
    if (err) {
      throw err;
    }
  });
} catch(err) {
  // This will not catch the throw!
  console.log(err);
}



This will not work because the callback function passed to fs.readFile() is
called asynchronously. By the time the callback has been called, the
surrounding code (including the try { } catch(err) { } block will have
already exited. Throwing an error inside the callback can crash the Node.js
process in most cases. If domains are enabled, or a handler has been
registered with process.on('uncaughtException'), such errors can be
intercepted.


Class: Error#



A generic JavaScript Error object that does not denote any specific
circumstance of why the error occurred. Error objects capture a "stack trace"
detailing the point in the code at which the Error was instantiated, and may
provide a text description of the error.


All errors generated by Node.js, including all System and JavaScript errors,
will either be instances of, or inherit from, the Error class.


new Error(message)#




Creates a new Error object and sets the error.message property to the
provided text message. If an object is passed as message, the text message
is generated by calling message.toString(). The error.stack property will
represent the point in the code at which new Error() was called. Stack traces
are dependent on V8's stack trace API. Stack traces extend only to either
(a) the beginning of  synchronous code execution, or (b) the number of frames
given by the property Error.stackTraceLimit, whichever is smaller.


Error.captureStackTrace(targetObject[, constructorOpt])#




Creates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.


const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack  // similar to `new Error().stack`



The first line of the trace, instead of being prefixed with ErrorType:
message, will be the result of calling targetObject.toString().


The optional constructorOpt argument accepts a function. If given, all frames
above constructorOpt, including constructorOpt, will be omitted from the
generated stack trace.


The constructorOpt argument is useful for hiding implementation
details of error generation from an end user. For instance:


function MyError() {
  Error.captureStackTrace(this, MyError);
}

// Without passing MyError to captureStackTrace, the MyError
// frame would show up in the .stack property. By passing
// the constructor, we omit that frame and all frames above it.
new MyError().stack



Error.stackTraceLimit#




The Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).


The default value is 10 but may be set to any valid JavaScript number. Changes
will affect any stack trace captured after the value has been changed.


If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.


error.message#




The error.message property is the string description of the error as set by calling new Error(message).
The message passed to the constructor will also appear in the first line of
the stack trace of the Error, however changing this property after the
Error object is created may not change the first line of the stack trace
(for example, when error.stack is read before this property is changed).


const err = new Error('The message');
console.log(err.message);
  // Prints: The message



error.stack#




The error.stack property is a string describing the point in the code at which
the Error was instantiated.


For example:


Error: Things keep happening!
   at /home/gbusey/file.js:525:2
   at Frobnicator.refrobulate (/home/gbusey/business-logic.js:424:21)
   at Actor.<anonymous> (/home/gbusey/actors.js:400:8)
   at increaseSynergy (/home/gbusey/actors.js:701:6)

The first line is formatted as <error class name>: <error message>, and
is followed by a series of stack frames (each line beginning with "at ").
Each frame describes a call site within the code that lead to the error being
generated. V8 attempts to display a name for each function (by variable name,
function name, or object method name), but occasionally it will not be able to
find a suitable name. If V8 cannot determine a name for the function, only
location information will be displayed for that frame. Otherwise, the
determined function name will be displayed with location information appended
in parentheses.


It is important to note that frames are only generated for JavaScript
functions. If, for example, execution synchronously passes through a C++ addon
function called cheetahify, which itself calls a JavaScript function, the
frame representing the cheetahify call will not be present in the stack
traces:


const cheetahify = require('./native-binding.node');

function makeFaster() {
  // cheetahify *synchronously* calls speedy.
  cheetahify(function speedy() {
    throw new Error('oh no!');
  });
}

makeFaster(); // will throw:
  // /home/gbusey/file.js:6
  //     throw new Error('oh no!');
  //           ^
  // Error: oh no!
  //     at speedy (/home/gbusey/file.js:6:11)
  //     at makeFaster (/home/gbusey/file.js:5:3)
  //     at Object.<anonymous> (/home/gbusey/file.js:10:1)
  //     at Module._compile (module.js:456:26)
  //     at Object.Module._extensions..js (module.js:474:10)
  //     at Module.load (module.js:356:32)
  //     at Function.Module._load (module.js:312:12)
  //     at Function.Module.runMain (module.js:497:10)
  //     at startup (node.js:119:16)
  //     at node.js:906:3



The location information will be one of:


    

  • native, if the frame represents a call internal to V8 (as in [].forEach).
    • 

  • plain-filename.js:line:column, if the frame represents a call internal
 to Node.js.
    • 

  • /absolute/path/to/file.js:line:column, if the frame represents a call in
a user program, or its dependencies.
    • 



The string representing the stack trace is lazily generated when the
error.stack property is accessed.


The number of frames captured by the stack trace is bounded by the smaller of
Error.stackTraceLimit or the number of available frames on the current event
loop tick.


System-level errors are generated as augmented Error instances, which are
detailed here.


Class: RangeError#


A subclass of Error that indicates that a provided argument was not within the
set or range of acceptable values for a function; whether that is a numeric
range, or outside the set of options for a given function parameter.


For example:


require('net').connect(-1);
  // throws RangeError, port should be > 0 && < 65536



Node.js will generate and throw RangeError instances immediately as a form
of argument validation.


Class: ReferenceError#


A subclass of Error that indicates that an attempt is being made to access a
variable that is not defined. Such errors commonly indicate typos in code, or
an otherwise broken program.


While client code may generate and propagate these errors, in practice, only V8
will do so.


doesNotExist;
  // throws ReferenceError, doesNotExist is not a variable in this program.



ReferenceError instances will have an error.arguments property whose value
is an array containing a single element: a string representing the variable
that was not defined.


const assert = require('assert');
try {
  doesNotExist;
} catch(err) {
  assert(err.arguments[0], 'doesNotExist');
}



Unless an application is dynamically generating and running code,
ReferenceError instances should always be considered a bug in the code
or its dependencies.


Class: SyntaxError#


A subclass of Error that indicates that a program is not valid JavaScript.
These errors may only be generated and propagated as a result of code
evaluation. Code evaluation may happen as a result of eval, Function,
require, or vm. These errors are almost always indicative of a broken
program.


try {
  require('vm').runInThisContext('binary ! isNotOk');
} catch(err) {
  // err will be a SyntaxError
}



SyntaxError instances are unrecoverable in the context that created them –
they may only be caught by other contexts.


Class: TypeError#


A subclass of Error that indicates that a provided argument is not an
allowable type. For example, passing a function to a parameter which expects a
string would be considered a TypeError.


require('url').parse(() => { });
  // throws TypeError, since it expected a string



Node.js will generate and throw TypeError instances immediately as a form
of argument validation.


Exceptions vs. Errors#



A JavaScript exception is a value that is thrown as a result of an invalid
operation or as the target of a throw statement. While it is not required
that these values are instances of Error or classes which inherit from
Error, all exceptions thrown by Node.js or the JavaScript runtime will be
instances of Error.


Some exceptions are unrecoverable at the JavaScript layer. Such exceptions
will always cause the Node.js process to crash. Examples include assert()
checks or abort() calls in the C++ layer.


System Errors#


System errors are generated when exceptions occur within the program's
runtime environment. Typically, these are operational errors that occur
when an application violates an operating system constraint such as attempting
to read a file that does not exist or when the user does not have sufficient
permissions.


System errors are typically generated at the syscall level: an exhaustive list
of error codes and their meanings is available by running man 2 intro or
man 3 errno on most Unices; or online.


In Node.js, system errors are represented as augmented Error objects with
added properties.


Class: System Error#


error.code#




The error.code property is a string representing the error code, which is always
E followed by a sequence of capital letters.


error.errno#




The error.errno property is a number or a string.
The number is a negative value which corresponds to the error code defined in
libuv Error handling. See uv-errno.h header file (deps/uv/include/uv-errno.h in
the Node.js source tree) for details.
In case of a string, it is the same as error.code.


error.syscall#




The error.syscall property is a string describing the syscall that failed.


error.path#




When present (e.g. in fs or child_process), the error.path property is a string
containing a relevant invalid pathname.


error.address#




When present (e.g. in net or dgram), the error.address property is a string
describing the address to which the connection failed.


error.port#




When present (e.g. in net or dgram), the error.port property is a number representing
the connection's port that is not available.


Common System Errors#


This list is not exhaustive, but enumerates many of the common system
errors encountered when writing a Node.js program. An exhaustive list may be
found here.


    

  • EACCES (Permission denied): An attempt was made to access a file in a way
forbidden by its file access permissions.
    

    • 

  • EADDRINUSE (Address already in use):  An attempt to bind a server
(net, http, or https) to a local address failed due to
another server on the local system already occupying that address.
    

    • 

  • ECONNREFUSED (Connection refused): No connection could be made because the
target machine actively refused it. This usually results from trying to
connect to a service that is inactive on the foreign host.
    

    • 

  • ECONNRESET (Connection reset by peer): A connection was forcibly closed by
a peer. This normally results from a loss of the connection on the remote
socket due to a timeout or reboot. Commonly encountered via the http
and net modules.
    

    • 

  • EEXIST (File exists): An existing file was the target of an operation that
required that the target not exist.
    

    • 

  • EISDIR (Is a directory): An operation expected a file, but the given
pathname was a directory.
    

    • 

  • EMFILE (Too many open files in system): Maximum number of
file descriptors allowable on the system has been reached, and
requests for another descriptor cannot be fulfilled until at least one
has been closed. This is encountered when opening many files at once in
parallel, especially on systems (in particular, OS X) where there is a low
file descriptor limit for processes. To remedy a low limit, run
ulimit -n 2048 in the same shell that will run the Node.js process.
    

    • 

  • ENOENT (No such file or directory): Commonly raised by fs operations
to indicate that a component of the specified pathname does not exist -- no
entity (file or directory) could be found by the given path.
    

    • 

  • ENOTDIR (Not a directory): A component of the given pathname existed, but
was not a directory as expected. Commonly raised by fs.readdir.
    

    • 

  • ENOTEMPTY (Directory not empty): A directory with entries was the target
of an operation that requires an empty directory -- usually fs.unlink.
    

    • 

  • EPERM (Operation not permitted): An attempt was made to perform an
operation that requires elevated privileges.
    

    • 

  • EPIPE (Broken pipe): A write on a pipe, socket, or FIFO for which there is
no process to read the data. Commonly encountered at the net and
http layers, indicative that the remote side of the stream being
written to has been closed.
    

    • 

  • ETIMEDOUT (Operation timed out): A connect or send request failed because
the connected party did not properly respond after a period of time. Usually
encountered by http or net -- often a sign that a socket.end()
was not properly called.
    

    • 





Events#


Stability: 2 - Stable


Much of the Node.js core API is built around an idiomatic asynchronous
event-driven architecture in which certain kinds of objects (called "emitters")
periodically emit named events that cause Function objects ("listeners") to be
called.


For instance: a net.Server object emits an event each time a peer
connects to it; a fs.ReadStream emits an event when the file is opened;
a stream emits an event whenever data is available to be read.


All objects that emit events are instances of the EventEmitter class. These
objects expose an eventEmitter.on() function that allows one or more
Functions to be attached to named events emitted by the object. Typically,
event names are camel-cased strings but any valid JavaScript property key
can be used.


When the EventEmitter object emits an event, all of the Functions attached
to that specific event are called synchronously. Any values returned by the
called listeners are ignored and will be discarded.


The following example shows a simple EventEmitter instance with a single
listener. The eventEmitter.on() method is used to register listeners, while
the eventEmitter.emit() method is used to trigger the event.


const EventEmitter = require('events');
const util = require('util');

function MyEmitter() {
  EventEmitter.call(this);
}
util.inherits(MyEmitter, EventEmitter);

const myEmitter = new MyEmitter();
myEmitter.on('event', () => {
  console.log('an event occurred!');
});
myEmitter.emit('event');



Any object can become an EventEmitter through inheritance. The example above
uses the traditional Node.js style prototypical inheritance using
the util.inherits() method. It is, however, possible to use ES6 classes as
well:


const EventEmitter = require('events');

class MyEmitter extends EventEmitter {}

const myEmitter = new MyEmitter();
myEmitter.on('event', () => {
  console.log('an event occurred!');
});
myEmitter.emit('event');



Passing arguments and this to listeners#


The eventEmitter.emit() method allows an arbitrary set of arguments to be
passed to the listener functions. It is important to keep in mind that when an
ordinary listener function is called by the EventEmitter, the standard this
keyword is intentionally set to reference the EventEmitter to which the
listener is attached.


const myEmitter = new MyEmitter();
myEmitter.on('event', function(a, b) {
  console.log(a, b, this);
    // Prints:
    //   a b MyEmitter {
    //     domain: null,
    //     _events: { event: [Function] },
    //     _eventsCount: 1,
    //     _maxListeners: undefined }
});
myEmitter.emit('event', 'a', 'b');



It is possible to use ES6 Arrow Functions as listeners, however, when doing so,
the this keyword will no longer reference the EventEmitter instance:


const myEmitter = new MyEmitter();
myEmitter.on('event', (a, b) => {
  console.log(a, b, this);
    // Prints: a b {}
});
myEmitter.emit('event', 'a', 'b');



Asynchronous vs. Synchronous#


The EventListener calls all listeners synchronously in the order in which
they were registered. This is important to ensure the proper sequencing of
events and to avoid race conditions or logic errors. When appropriate,
listener functions can switch to an asynchronous mode of operation using
the setImmediate() or process.nextTick() methods:


const myEmitter = new MyEmitter();
myEmitter.on('event', (a, b) => {
  setImmediate(() => {
    console.log('this happens asynchronously');
  });
});
myEmitter.emit('event', 'a', 'b');



Handling events only once#


When a listener is registered using the eventEmitter.on() method, that
listener will be invoked every time the named event is emitted.


const myEmitter = new MyEmitter();
var m = 0;
myEmitter.on('event', () => {
  console.log(++m);
});
myEmitter.emit('event');
  // Prints: 1
myEmitter.emit('event');
  // Prints: 2



Using the eventEmitter.once() method, it is possible to register a listener
that is unregistered before it is called.


const myEmitter = new MyEmitter();
var m = 0;
myEmitter.once('event', () => {
  console.log(++m);
});
myEmitter.emit('event');
  // Prints: 1
myEmitter.emit('event');
  // Ignored



Error events#


When an error occurs within an EventEmitter instance, the typical action is
for an 'error' event to be emitted. These are treated as a special case
within Node.js.


If an EventEmitter does not have at least one listener registered for the
'error' event, and an 'error' event is emitted, the error is thrown, a
stack trace is printed, and the Node.js process exits.


const myEmitter = new MyEmitter();
myEmitter.emit('error', new Error('whoops!'));
  // Throws and crashes Node.js



To guard against crashing the Node.js process, developers can either register
a listener for the process.on('uncaughtException') event or use the
domain module (Note, however, that the domain module has been
deprecated).


const myEmitter = new MyEmitter();

process.on('uncaughtException', (err) => {
  console.log('whoops! there was an error');
});

myEmitter.emit('error', new Error('whoops!'));
  // Prints: whoops! there was an error



As a best practice, developers should always register listeners for the
'error' event:


const myEmitter = new MyEmitter();
myEmitter.on('error', (err) => {
  console.log('whoops! there was an error');
});
myEmitter.emit('error', new Error('whoops!'));
  // Prints: whoops! there was an error



Class: EventEmitter#



Added in: v0.1.26

The EventEmitter class is defined and exposed by the events module:


const EventEmitter = require('events');



All EventEmitters emit the event 'newListener' when new listeners are
added and 'removeListener' when a listener is removed.


Event: 'newListener'#



Added in: v0.1.26



The EventEmitter instance will emit it's own 'newListener' event before
a listener is added to it's internal array of listeners.


Listeners registered for the 'newListener' event will be passed the event
name and a reference to the listener being added.


The fact that the event is triggered before adding the listener has a subtle
but important side effect: any additional listeners registered to the same
name within the 'newListener' callback will be inserted before the
listener that is in the process of being added.


const myEmitter = new MyEmitter();
// Only do this once so we don't loop forever
myEmitter.once('newListener', (event, listener) => {
  if (event === 'event') {
    // Insert a new listener in front
    myEmitter.on('event', () => {
      console.log('B');
    });
  }
});
myEmitter.on('event', () => {
  console.log('A');
});
myEmitter.emit('event');
  // Prints:
  //   B
  //   A



Event: 'removeListener'#



Added in: v0.9.3



The 'removeListener' event is emitted after a listener is removed.


EventEmitter.listenerCount(emitter, eventName)#



Added in: v0.9.12
Deprecated since: v4.0.0 

Stability: 0 - Deprecated: Use emitter.listenerCount() instead.
A class method that returns the number of listeners for the given eventName
registered on the given emitter.


const myEmitter = new MyEmitter();
myEmitter.on('event', () => {});
myEmitter.on('event', () => {});
console.log(EventEmitter.listenerCount(myEmitter, 'event'));
  // Prints: 2



EventEmitter.defaultMaxListeners#



Added in: v0.11.2

By default, a maximum of 10 listeners can be registered for any single
event. This limit can be changed for individual EventEmitter instances
using the emitter.setMaxListeners(n) method. To change the default
for all EventEmitter instances, the EventEmitter.defaultMaxListeners
property can be used.


Take caution when setting the EventEmitter.defaultMaxListeners because the
change effects all EventEmitter instances, including those created before
the change is made. However, calling emitter.setMaxListeners(n) still has
precedence over EventEmitter.defaultMaxListeners.


Note that this is not a hard limit. The EventEmitter instance will allow
more listeners to be added but will output a trace warning to stderr indicating
that a possible EventEmitter memory leak has been detected. For any single
EventEmitter, the emitter.getMaxListeners() and emitter.setMaxListeners()
methods can be used to temporarily avoid this warning:


emitter.setMaxListeners(emitter.getMaxListeners() + 1);
emitter.once('event', () => {
  // do stuff
  emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0));
});



emitter.addListener(eventName, listener)#



Added in: v0.1.26

Alias for emitter.on(eventName, listener).


emitter.emit(eventName[, arg1][, arg2][, ...])#



Added in: v0.1.26

Synchronously calls each of the listeners registered for the event named
eventName, in the order they were registered, passing the supplied arguments
to each.


Returns true if the event had listeners, false otherwise.


emitter.getMaxListeners()#



Added in: v1.0.0

Returns the current max listener value for the EventEmitter which is either
set by emitter.setMaxListeners(n) or defaults to
EventEmitter.defaultMaxListeners.


emitter.listenerCount(eventName)#



Added in: v3.2.0

    

  • eventName <Value> The name of the event being listened for
    • 



Returns the number of listeners listening to the event named eventName.


emitter.listeners(eventName)#



Added in: v0.1.26

Returns a copy of the array of listeners for the event named eventName.


server.on('connection', (stream) => {
  console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
  // Prints: [ [Function] ]



emitter.on(eventName, listener)#



Added in: v0.1.101

Adds the listener function to the end of the listeners array for the
event named eventName. No checks are made to see if the listener has
already been added. Multiple calls passing the same combination of eventName
and listener will result in the listener being added, and called, multiple
times.


server.on('connection', (stream) => {
  console.log('someone connected!');
});



Returns a reference to the EventEmitter so calls can be chained.


emitter.once(eventName, listener)#



Added in: v0.3.0

Adds a one time listener function for the event named eventName. The
next time eventName is triggered, this listener is removed and then invoked.


server.once('connection', (stream) => {
  console.log('Ah, we have our first user!');
});



Returns a reference to the EventEmitter so calls can be chained.


emitter.removeAllListeners([eventName])#



Added in: v0.1.26

Removes all listeners, or those of the specified eventName.


Note that it is bad practice to remove listeners added elsewhere in the code,
particularly when the EventEmitter instance was created by some other
component or module (e.g. sockets or file streams).


Returns a reference to the EventEmitter so calls can be chained.


emitter.removeListener(eventName, listener)#



Added in: v0.1.26

Removes the specified listener from the listener array for the event named
eventName.


var callback = (stream) => {
  console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);



removeListener will remove, at most, one instance of a listener from the
listener array. If any single listener has been added multiple times to the
listener array for the specified eventName, then removeListener must be
called multiple times to remove each instance.


Note that once an event has been emitted, all listeners attached to it at the
time of emitting will be called in order. This implies that any removeListener()
or removeAllListeners() calls after emitting and before the last listener
finishes execution will not remove them from emit() in progress. Subsequent
events will behave as expected.


const myEmitter = new MyEmitter();

var callbackA = () => {
  console.log('A');
  myEmitter.removeListener('event', callbackB);
};

var callbackB = () => {
  console.log('B');
};

myEmitter.on('event', callbackA);

myEmitter.on('event', callbackB);

// callbackA removes listener callbackB but it will still be called.
// Internal listener array at time of emit [callbackA, callbackB]
myEmitter.emit('event');
  // Prints:
  //   A
  //   B

// callbackB is now removed.
// Internal listener array [callbackA]
myEmitter.emit('event');
  // Prints:
  //   A



Because listeners are managed using an internal array, calling this will
change the position indices of any listener registered after the listener
being removed. This will not impact the order in which listeners are called,
but it will means that any copies of the listener array as returned by
the emitter.listeners() method will need to be recreated.


Returns a reference to the EventEmitter so calls can be chained.


emitter.setMaxListeners(n)#



Added in: v0.3.5

By default EventEmitters will print a warning if more than 10 listeners are
added for a particular event. This is a useful default that helps finding
memory leaks. Obviously, not all events should be limited to just 10 listeners.
The emitter.setMaxListeners() method allows the limit to be modified for this
specific EventEmitter instance. The value can be set to Infinity (or 0)
to indicate an unlimited number of listeners.


Returns a reference to the EventEmitter so calls can be chained.




File System#


Stability: 2 - Stable


File I/O is provided by simple wrappers around standard POSIX functions.  To
use this module do require('fs'). All the methods have asynchronous and
synchronous forms.


The asynchronous form always takes a completion callback as its last argument.
The arguments passed to the completion callback depend on the method, but the
first argument is always reserved for an exception. If the operation was
completed successfully, then the first argument will be null or undefined.


When using the synchronous form any exceptions are immediately thrown.
You can use try/catch to handle exceptions or allow them to bubble up.


Here is an example of the asynchronous version:


const fs = require('fs');

fs.unlink('/tmp/hello', (err) => {
  if (err) throw err;
  console.log('successfully deleted /tmp/hello');
});



Here is the synchronous version:


const fs = require('fs');

fs.unlinkSync('/tmp/hello');
console.log('successfully deleted /tmp/hello');



With the asynchronous methods there is no guaranteed ordering. So the
following is prone to error:


fs.rename('/tmp/hello', '/tmp/world', (err) => {
  if (err) throw err;
  console.log('renamed complete');
});
fs.stat('/tmp/world', (err, stats) => {
  if (err) throw err;
  console.log(`stats: ${JSON.stringify(stats)}`);
});



It could be that fs.stat is executed before fs.rename.
The correct way to do this is to chain the callbacks.


fs.rename('/tmp/hello', '/tmp/world', (err) => {
  if (err) throw err;
  fs.stat('/tmp/world', (err, stats) => {
    if (err) throw err;
    console.log(`stats: ${JSON.stringify(stats)}`);
  });
});



In busy processes, the programmer is strongly encouraged to use the
asynchronous versions of these calls. The synchronous versions will block
the entire process until they complete--halting all connections.


The relative path to a filename can be used. Remember, however, that this path
will be relative to process.cwd().


Most fs functions let you omit the callback argument. If you do, a default
callback is used that rethrows errors. To get a trace to the original call
site, set the NODE_DEBUG environment variable:


$ cat script.js
function bad() {
  require('fs').readFile('/');
}
bad();

$ env NODE_DEBUG=fs node script.js
fs.js:66
        throw err;
              ^
Error: EISDIR, read
    at rethrow (fs.js:61:21)
    at maybeCallback (fs.js:79:42)
    at Object.fs.readFile (fs.js:153:18)
    at bad (/path/to/script.js:2:17)
    at Object.<anonymous> (/path/to/script.js:5:1)
    <etc.>

Class: fs.FSWatcher#



Added in: v0.5.8

Objects returned from fs.watch() are of this type.


Event: 'change'#



Added in: v0.5.8

    

  • event <String> The type of fs change
    • 

  • filename <String> The filename that changed (if relevant/available)
    • 



Emitted when something changes in a watched directory or file.
See more details in fs.watch().


Event: 'error'#



Added in: v0.5.8



Emitted when an error occurs.


watcher.close()#



Added in: v0.5.8

Stop watching for changes on the given fs.FSWatcher.


Class: fs.ReadStream#



Added in: v0.1.93

ReadStream is a Readable Stream.


Event: 'open'#



Added in: v0.1.93

    

  • fd <Number> Integer file descriptor used by the ReadStream.
    • 



Emitted when the ReadStream's file is opened.


Event: 'close'#



Added in: v0.1.93

Emitted when the ReadStream's underlying file descriptor has been closed
using the fs.close() method.


readStream.path#



Added in: v0.1.93

The path to the file the stream is reading from.


Class: fs.Stats#



Added in: v0.1.21

Objects returned from fs.stat(), fs.lstat() and fs.fstat() and their
synchronous counterparts are of this type.


    

  • stats.isFile()
    • 

  • stats.isDirectory()
    • 

  • stats.isBlockDevice()
    • 

  • stats.isCharacterDevice()
    • 

  • stats.isSymbolicLink() (only valid with fs.lstat())
    • 

  • stats.isFIFO()
    • 

  • stats.isSocket()
    • 



For a regular file util.inspect(stats) would return a string very
similar to this:


{
  dev: 2114,
  ino: 48064969,
  mode: 33188,
  nlink: 1,
  uid: 85,
  gid: 100,
  rdev: 0,
  size: 527,
  blksize: 4096,
  blocks: 8,
  atime: Mon, 10 Oct 2011 23:24:11 GMT,
  mtime: Mon, 10 Oct 2011 23:24:11 GMT,
  ctime: Mon, 10 Oct 2011 23:24:11 GMT,
  birthtime: Mon, 10 Oct 2011 23:24:11 GMT
}



Please note that atime, mtime, birthtime, and ctime are
instances of Date object and to compare the values of
these objects you should use appropriate methods. For most general
uses getTime() will return the number of
milliseconds elapsed since 1 January 1970 00:00:00 UTC and this
integer should be sufficient for any comparison, however there are
additional methods which can be used for displaying fuzzy information.
More details can be found in the MDN JavaScript Reference
page.


Stat Time Values#


The times in the stat object have the following semantics:


    

  • atime "Access Time" - Time when file data last accessed.  Changed
by the mknod(2), utimes(2), and read(2) system calls.
    • 

  • mtime "Modified Time" - Time when file data last modified.
Changed by the mknod(2), utimes(2), and write(2) system calls.
    • 

  • ctime "Change Time" - Time when file status was last changed
(inode data modification).  Changed by the chmod(2), chown(2),
link(2), mknod(2), rename(2), unlink(2), utimes(2),
read(2), and write(2) system calls.
    • 

  • birthtime "Birth Time" -  Time of file creation. Set once when the
file is created.  On filesystems where birthtime is not available,
this field may instead hold either the ctime or
1970-01-01T00:00Z (ie, unix epoch timestamp 0). Note that this
value may be greater than atime or mtime in this case. On Darwin
and other FreeBSD variants, also set if the atime is explicitly
set to an earlier value than the current birthtime using the
utimes(2) system call.
    • 



Prior to Node v0.12, the ctime held the birthtime on Windows
systems.  Note that as of v0.12, ctime is not "creation time", and
on Unix systems, it never was.


Class: fs.WriteStream#



Added in: v0.1.93

WriteStream is a Writable Stream.


Event: 'open'#



Added in: v0.1.93

    

  • fd <Number> Integer file descriptor used by the WriteStream.
    • 



Emitted when the WriteStream's file is opened.


Event: 'close'#



Added in: v0.1.93

Emitted when the WriteStream's underlying file descriptor has been closed
using the fs.close() method.


writeStream.bytesWritten#



Added in: v0.4.7

The number of bytes written so far. Does not include data that is still queued
for writing.


writeStream.path#



Added in: v0.1.93

The path to the file the stream is writing to.


fs.access(path[, mode], callback)#



Added in: v0.11.15

Tests a user's permissions for the file specified by path. mode is an
optional integer that specifies the accessibility checks to be performed. The
following constants define the possible values of mode. It is possible to
create a mask consisting of the bitwise OR of two or more values.


    

  • fs.F_OK - File is visible to the calling process. This is useful for
determining if a file exists, but says nothing about rwx permissions.
Default if no mode is specified.
    • 

  • fs.R_OK - File can be read by the calling process.
    • 

  • fs.W_OK - File can be written by the calling process.
    • 

  • fs.X_OK - File can be executed by the calling process. This has no effect
on Windows (will behave like fs.F_OK).
    • 



The final argument, callback, is a callback function that is invoked with
a possible error argument. If any of the accessibility checks fail, the error
argument will be populated. The following example checks if the file
/etc/passwd can be read and written by the current process.


fs.access('/etc/passwd', fs.R_OK | fs.W_OK, (err) => {
  console.log(err ? 'no access!' : 'can read/write');
});



Using fs.access() to check for the accessibility of a file before calling
fs.open(), fs.readFile() or fs.writeFile() is not recommended. Doing
so introduces a race condition, since other processes may change the file's
state between the two calls. Instead, user code should open/read/write the
file directly and handle the error raised if the file is not accessible.


For example:


write (NOT RECOMMENDED)


fs.access('myfile', (err) => {
  if (!err) {
    console.error('myfile already exists');
    return;
  }

  fs.open('myfile', 'wx', (err, fd) => {
    if (err) throw err;
    writeMyData(fd);
  });
});



write (RECOMMENDED)


fs.open('myfile', 'wx', (err, fd) => {
  if (err) {
    if (err.code === "EEXIST") {
      console.error('myfile already exists');
      return;
    } else {
      throw err;
    }
  }

  writeMyData(fd);
});



read (NOT RECOMMENDED)


fs.access('myfile', (err) => {
  if (err) {
    if (err.code === "ENOENT") {
      console.error('myfile does not exist');
      return;
    } else {
      throw err;
    }
  }

  fs.open('myfile', 'r', (err, fd) => {
    if (err) throw err;
    readMyData(fd);
  });
});



read (RECOMMENDED)


fs.open('myfile', 'r', (err, fd) => {
  if (err) {
    if (err.code === "ENOENT") {
      console.error('myfile does not exist');
      return;
    } else {
      throw err;
    }
  }

  readMyData(fd);
});



The "not recommended" examples above check for accessibility and then use the
file; the "recommended" examples are better because they use the file directly
and handle the error, if any.


In general, check for the accessibility of a file only if the file won’t be
used directly, for example when its accessibility is a signal from another
process.


fs.accessSync(path[, mode])#



Added in: v0.11.15

Synchronous version of fs.access(). This throws if any accessibility checks
fail, and does nothing otherwise.


fs.appendFile(file, data[, options], callback)#



Added in: v0.6.7



Asynchronously append data to a file, creating the file if it does not yet exist.
data can be a string or a buffer.


Example:


fs.appendFile('message.txt', 'data to append', (err) => {
  if (err) throw err;
  console.log('The "data to append" was appended to file!');
});



If options is a string, then it specifies the encoding. Example:


fs.appendFile('message.txt', 'data to append', 'utf8', callback);



fs.appendFileSync(file, data[, options])#



Added in: v0.6.7

The synchronous version of fs.appendFile(). Returns undefined.


fs.chmod(path, mode, callback)#



Added in: v0.1.30

Asynchronous chmod(2). No arguments other than a possible exception are given
to the completion callback.


fs.chmodSync(path, mode)#



Added in: v0.6.7

Synchronous chmod(2). Returns undefined.


fs.chown(path, uid, gid, callback)#



Added in: v0.1.97

Asynchronous chown(2). No arguments other than a possible exception are given
to the completion callback.


fs.chownSync(path, uid, gid)#



Added in: v0.1.97

Synchronous chown(2). Returns undefined.


fs.close(fd, callback)#



Added in: v0.0.2

Asynchronous close(2).  No arguments other than a possible exception are given
to the completion callback.


fs.closeSync(fd)#



Added in: v0.1.21

Synchronous close(2). Returns undefined.


fs.createReadStream(path[, options])#



Added in: v0.1.31

Returns a new ReadStream object. (See Readable Stream).


Be aware that, unlike the default value set for highWaterMark on a
readable stream (16 kb), the stream returned by this method has a
default value of 64 kb for the same parameter.


options is an object or string with the following defaults:


{
  flags: 'r',
  encoding: null,
  fd: null,
  mode: 0o666,
  autoClose: true
}



options can include start and end values to read a range of bytes from
the file instead of the entire file.  Both start and end are inclusive and
start counting at 0. If fd is specified and start is omitted or undefined,
fs.createReadStream() reads sequentially from the current file position.
The encoding can be any one of those accepted by Buffer.


If fd is specified, ReadStream will ignore the path argument and will use
the specified file descriptor. This means that no 'open' event will be emitted.
Note that fd should be blocking; non-blocking fds should be passed to
net.Socket.


If autoClose is false, then the file descriptor won't be closed, even if
there's an error.  It is your responsibility to close it and make sure
there's no file descriptor leak.  If autoClose is set to true (default
behavior), on error or end the file descriptor will be closed
automatically.


mode sets the file mode (permission and sticky bits), but only if the
file was created.


An example to read the last 10 bytes of a file which is 100 bytes long:


fs.createReadStream('sample.txt', {start: 90, end: 99});



If options is a string, then it specifies the encoding.


fs.createWriteStream(path[, options])#



Added in: v0.1.31

Returns a new WriteStream object. (See Writable Stream).


options is an object or string with the following defaults:


{
  flags: 'w',
  defaultEncoding: 'utf8',
  fd: null,
  mode: 0o666
}



options may also include a start option to allow writing data at
some position past the beginning of the file.  Modifying a file rather
than replacing it may require a flags mode of r+ rather than the
default mode w. The defaultEncoding can be any one of those accepted by Buffer.


Like ReadStream, if fd is specified, WriteStream will ignore the
path argument and will use the specified file descriptor. This means that no
'open' event will be emitted. Note that fd should be blocking; non-blocking
fds should be passed to net.Socket.


If options is a string, then it specifies the encoding.


fs.exists(path, callback)#



Added in: v0.0.2
Deprecated since: v1.0.0 

Stability: 0 - Deprecated: Use fs.stat() or fs.access() instead.
Test whether or not the given path exists by checking with the file system.
Then call the callback argument with either true or false.  Example:


fs.exists('/etc/passwd', (exists) => {
  console.log(exists ? 'it\'s there' : 'no passwd!');
});



Using fs.exists() to check for the existence of a file before calling
fs.open(), fs.readFile() or fs.writeFile() is not recommended. Doing
so introduces a race condition, since other processes may change the file's
state between the two calls. Instead, user code should open/read/write the
file directly and handle the error raised if the file does not exist.


For example:


write (NOT RECOMMENDED)


fs.exists('myfile', (exists) => {
  if (exists) {
    console.error('myfile already exists');
  } else {
    fs.open('myfile', 'wx', (err, fd) => {
      if (err) throw err;
      writeMyData(fd);
    });
  }
});



write (RECOMMENDED)


fs.open('myfile', 'wx', (err, fd) => {
  if (err) {
    if (err.code === "EEXIST") {
      console.error('myfile already exists');
      return;
    } else {
      throw err;
    }
  }
  writeMyData(fd);
});



read (NOT RECOMMENDED)


fs.exists('myfile', (exists) => {
  if (exists) {
    fs.open('myfile', 'r', (err, fd) => {
      readMyData(fd);
    });
  } else {
    console.error('myfile does not exist');
  }
});



read (RECOMMENDED)


fs.open('myfile', 'r', (err, fd) => {
  if (err) {
    if (err.code === "ENOENT") {
      console.error('myfile does not exist');
      return;
    } else {
      throw err;
    }
  } else {
    readMyData(fd);
  }
});



The "not recommended" examples above check for existence and then use the
file; the "recommended" examples are better because they use the file directly
and handle the error, if any.


In general, check for the existence of a file only if the file won’t be
used directly, for example when its existence is a signal from another
process.


fs.existsSync(path)#



Added in: v0.1.21
Deprecated since: v1.0.0 

Stability: 0 - Deprecated: Use fs.statSync() or fs.accessSync() instead.
Synchronous version of fs.exists().
Returns true if the file exists, false otherwise.


fs.fchmod(fd, mode, callback)#



Added in: v0.4.7

Asynchronous fchmod(2). No arguments other than a possible exception
are given to the completion callback.


fs.fchmodSync(fd, mode)#



Added in: v0.4.7

Synchronous fchmod(2). Returns undefined.


fs.fchown(fd, uid, gid, callback)#



Added in: v0.4.7

Asynchronous fchown(2). No arguments other than a possible exception are given
to the completion callback.


fs.fchownSync(fd, uid, gid)#



Added in: v0.4.7

Synchronous fchown(2). Returns undefined.


fs.fdatasync(fd, callback)#



Added in: v0.1.96

Asynchronous fdatasync(2). No arguments other than a possible exception are
given to the completion callback.


fs.fdatasyncSync(fd)#



Added in: v0.1.96

Synchronous fdatasync(2). Returns undefined.


fs.fstat(fd, callback)#



Added in: v0.1.95

Asynchronous fstat(2). The callback gets two arguments (err, stats) where
stats is a fs.Stats object. fstat() is identical to stat(),
except that the file to be stat-ed is specified by the file descriptor fd.


fs.fstatSync(fd)#



Added in: v0.1.95

Synchronous fstat(2). Returns an instance of fs.Stats.


fs.fsync(fd, callback)#



Added in: v0.1.96

Asynchronous fsync(2). No arguments other than a possible exception are given
to the completion callback.


fs.fsyncSync(fd)#



Added in: v0.1.96

Synchronous fsync(2). Returns undefined.


fs.ftruncate(fd, len, callback)#



Added in: v0.8.6

Asynchronous ftruncate(2). No arguments other than a possible exception are
given to the completion callback.


fs.ftruncateSync(fd, len)#



Added in: v0.8.6

Synchronous ftruncate(2). Returns undefined.


fs.futimes(fd, atime, mtime, callback)#



Added in: v0.4.2

Change the file timestamps of a file referenced by the supplied file
descriptor.


fs.futimesSync(fd, atime, mtime)#



Added in: v0.4.2

Synchronous version of fs.futimes(). Returns undefined.


fs.lchmod(path, mode, callback)#



Deprecated since: v0.4.7 

Asynchronous lchmod(2). No arguments other than a possible exception
are given to the completion callback.


Only available on Mac OS X.


fs.lchmodSync(path, mode)#



Deprecated since: v0.4.7 

Synchronous lchmod(2). Returns undefined.


fs.lchown(path, uid, gid, callback)#



Deprecated since: v0.4.7 

Asynchronous lchown(2). No arguments other than a possible exception are given
to the completion callback.


fs.lchownSync(path, uid, gid)#



Deprecated since: v0.4.7 

Synchronous lchown(2). Returns undefined.


fs.link(srcpath, dstpath, callback)#



Added in: v0.1.31

Asynchronous link(2). No arguments other than a possible exception are given to
the completion callback.


fs.linkSync(srcpath, dstpath)#



Added in: v0.1.31

Synchronous link(2). Returns undefined.


fs.lstat(path, callback)#



Added in: v0.1.30

Asynchronous lstat(2). The callback gets two arguments (err, stats) where
stats is a fs.Stats object. lstat() is identical to stat(),
except that if path is a symbolic link, then the link itself is stat-ed,
not the file that it refers to.


fs.lstatSync(path)#



Added in: v0.1.30

Synchronous lstat(2). Returns an instance of fs.Stats.


fs.mkdir(path[, mode], callback)#



Added in: v0.1.8

Asynchronous mkdir(2). No arguments other than a possible exception are given
to the completion callback. mode defaults to 0o777.


fs.mkdirSync(path[, mode])#



Added in: v0.1.21

Synchronous mkdir(2). Returns undefined.


fs.mkdtemp(prefix, callback)#


Creates a unique temporary directory.


Generates six random characters to be appended behind a required
prefix to create a unique temporary directory.


The created folder path is passed as a string to the callback's second
parameter.


Example:


fs.mkdtemp('/tmp/foo-', (err, folder) => {
  console.log(folder);
    // Prints: /tmp/foo-itXde2
});



fs.mkdtempSync(template)#


The synchronous version of [fs.mkdtemp()][]. Returns the created
folder path.


fs.open(path, flags[, mode], callback)#



Added in: v0.0.2

Asynchronous file open. See open(2). flags can be:


    

  • 'r' - Open file for reading.
An exception occurs if the file does not exist.
    

    • 

  • 'r+' - Open file for reading and writing.
An exception occurs if the file does not exist.
    

    • 

  • 'rs' - Open file for reading in synchronous mode. Instructs the operating
system to bypass the local file system cache.
    

    This is primarily useful for opening files on NFS mounts as it allows you to
skip the potentially stale local cache. It has a very real impact on I/O
performance so don't use this flag unless you need it.
    

    Note that this doesn't turn fs.open() into a synchronous blocking call.
If that's what you want then you should be using fs.openSync()
    

    • 

  • 'rs+' - Open file for reading and writing, telling the OS to open it
synchronously. See notes for 'rs' about using this with caution.
    

    • 

  • 'w' - Open file for writing.
The file is created (if it does not exist) or truncated (if it exists).
    

    • 

  • 'wx' - Like 'w' but fails if path exists.
    

    • 

  • 'w+' - Open file for reading and writing.
The file is created (if it does not exist) or truncated (if it exists).
    

    • 

  • 'wx+' - Like 'w+' but fails if path exists.
    

    • 

  • 'a' - Open file for appending.
The file is created if it does not exist.
    

    • 

  • 'ax' - Like 'a' but fails if path exists.
    

    • 

  • 'a+' - Open file for reading and appending.
The file is created if it does not exist.
    

    • 

  • 'ax+' - Like 'a+' but fails if path exists.
    

    • 



mode sets the file mode (permission and sticky bits), but only if the file was
created. It defaults to 0666, readable and writable.


The callback gets two arguments (err, fd).


The exclusive flag 'x' (O_EXCL flag in open(2)) ensures that path is newly
created. On POSIX systems, path is considered to exist even if it is a symlink
to a non-existent file. The exclusive flag may or may not work with network file
systems.


flags can also be a number as documented by open(2); commonly used constants
are available from require('constants').  On Windows, flags are translated to
their equivalent ones where applicable, e.g. O_WRONLY to FILE_GENERIC_WRITE,
or O_EXCL|O_CREAT to CREATE_NEW, as accepted by CreateFileW.


On Linux, positional writes don't work when the file is opened in append mode.
The kernel ignores the position argument and always appends the data to
the end of the file.


fs.openSync(path, flags[, mode])#



Added in: v0.1.21

Synchronous version of fs.open(). Returns an integer representing the file
descriptor.


fs.read(fd, buffer, offset, length, position, callback)#



Added in: v0.0.2

Read data from the file specified by fd.


buffer is the buffer that the data will be written to.


offset is the offset in the buffer to start writing at.


length is an integer specifying the number of bytes to read.


position is an integer specifying where to begin reading from in the file.
If position is null, data will be read from the current file position.


The callback is given the three arguments, (err, bytesRead, buffer).


fs.readdir(path, callback)#



Added in: v0.1.8

Asynchronous readdir(3).  Reads the contents of a directory.
The callback gets two arguments (err, files) where files is an array of
the names of the files in the directory excluding '.' and '..'.


fs.readdirSync(path)#



Added in: v0.1.21

Synchronous readdir(3). Returns an array of filenames excluding '.' and
'..'.


fs.readFile(file[, options], callback)#



Added in: v0.1.29



Asynchronously reads the entire contents of a file. Example:


fs.readFile('/etc/passwd', (err, data) => {
  if (err) throw err;
  console.log(data);
});



The callback is passed two arguments (err, data), where data is the
contents of the file.


If no encoding is specified, then the raw buffer is returned.


If options is a string, then it specifies the encoding. Example:


fs.readFile('/etc/passwd', 'utf8', callback);



fs.readFileSync(file[, options])#



Added in: v0.1.8

Synchronous version of fs.readFile. Returns the contents of the file.


If the encoding option is specified then this function returns a
string. Otherwise it returns a buffer.


fs.readlink(path, callback)#



Added in: v0.1.31

Asynchronous readlink(2). The callback gets two arguments (err,
linkString).


fs.readlinkSync(path)#



Added in: v0.1.31

Synchronous readlink(2). Returns the symbolic link's string value.


fs.realpath(path[, cache], callback)#



Added in: v0.1.31

Asynchronous realpath(2). The callback gets two arguments (err,
resolvedPath). May use process.cwd to resolve relative paths. cache is an
object literal of mapped paths that can be used to force a specific path
resolution or avoid additional fs.stat calls for known real paths.


Example:


var cache = {'/etc':'/private/etc'};
fs.realpath('/etc/passwd', cache, (err, resolvedPath) => {
  if (err) throw err;
  console.log(resolvedPath);
});



fs.readSync(fd, buffer, offset, length, position)#



Added in: v0.1.21

Synchronous version of fs.read(). Returns the number of bytesRead.


fs.realpathSync(path[, cache])#



Added in: v0.1.31

Synchronous realpath(2). Returns the resolved path. cache is an
object literal of mapped paths that can be used to force a specific path
resolution or avoid additional fs.stat calls for known real paths.


fs.rename(oldPath, newPath, callback)#



Added in: v0.0.2

Asynchronous rename(2). No arguments other than a possible exception are given
to the completion callback.


fs.renameSync(oldPath, newPath)#



Added in: v0.1.21

Synchronous rename(2). Returns undefined.


fs.rmdir(path, callback)#



Added in: v0.0.2

Asynchronous rmdir(2). No arguments other than a possible exception are given
to the completion callback.


fs.rmdirSync(path)#



Added in: v0.1.21

Synchronous rmdir(2). Returns undefined.


fs.stat(path, callback)#



Added in: v0.0.2

Asynchronous stat(2). The callback gets two arguments (err, stats) where
stats is a fs.Stats object.  See the fs.Stats section for more
information.


fs.statSync(path)#



Added in: v0.1.21

Synchronous stat(2). Returns an instance of fs.Stats.


fs.symlink(target, path[, type], callback)#



Added in: v0.1.31

Asynchronous symlink(2). No arguments other than a possible exception are given
to the completion callback.
The type argument can be set to 'dir', 'file', or 'junction' (default
is 'file') and is only available on Windows (ignored on other platforms).
Note that Windows junction points require the destination path to be absolute.  When using
'junction', the target argument will automatically be normalized to absolute path.


Here is an example below:


fs.symlink('./foo', './new-port');



It creates a symbolic link named "new-port" that points to "foo".


fs.symlinkSync(target, path[, type])#



Added in: v0.1.31

Synchronous symlink(2). Returns undefined.


fs.truncate(path, len, callback)#



Added in: v0.8.6

Asynchronous truncate(2). No arguments other than a possible exception are
given to the completion callback. A file descriptor can also be passed as the
first argument. In this case, fs.ftruncate() is called.


fs.truncateSync(path, len)#



Added in: v0.8.6

Synchronous truncate(2). Returns undefined.


fs.unlink(path, callback)#



Added in: v0.0.2

Asynchronous unlink(2). No arguments other than a possible exception are given
to the completion callback.


fs.unlinkSync(path)#



Added in: v0.1.21

Synchronous unlink(2). Returns undefined.


fs.unwatchFile(filename[, listener])#



Added in: v0.1.31

Stop watching for changes on filename. If listener is specified, only that
particular listener is removed. Otherwise, all listeners are removed and you
have effectively stopped watching filename.


Calling fs.unwatchFile() with a filename that is not being watched is a
no-op, not an error.


Note: fs.watch() is more efficient than fs.watchFile() and fs.unwatchFile().
fs.watch() should be used instead of fs.watchFile() and fs.unwatchFile()
when possible.


fs.utimes(path, atime, mtime, callback)#



Added in: v0.4.2

Change file timestamps of the file referenced by the supplied path.


Note: the arguments atime and mtime of the following related functions does
follow the below rules:


    

  • If the value is a numberable string like '123456789', the value would get
converted to corresponding number.
    • 

  • If the value is NaN or Infinity, the value would get converted to
Date.now().
    • 



fs.utimesSync(path, atime, mtime)#



Added in: v0.4.2

Synchronous version of fs.utimes(). Returns undefined.


fs.watch(filename[, options][, listener])#



Added in: v0.5.10

Watch for changes on filename, where filename is either a file or a
directory.  The returned object is a fs.FSWatcher.


The second argument is optional. The options if provided should be an object.
The supported boolean members are persistent and recursive. persistent
indicates whether the process should continue to run as long as files are being
watched. recursive indicates whether all subdirectories should be watched, or
only the current directory. This applies when a directory is specified, and only
on supported platforms (See Caveats).


The default is { persistent: true, recursive: false }.


The listener callback gets two arguments (event, filename).  event is either
'rename' or 'change', and filename is the name of the file which triggered
the event.


Caveats#



The fs.watch API is not 100% consistent across platforms, and is
unavailable in some situations.


The recursive option is only supported on OS X and Windows.


Availability#



This feature depends on the underlying operating system providing a way
to be notified of filesystem changes.


    

  • On Linux systems, this uses inotify.
    • 

  • On BSD systems, this uses kqueue.
    • 

  • On OS X, this uses kqueue for files and 'FSEvents' for directories.
    • 

  • On SunOS systems (including Solaris and SmartOS), this uses event ports.
    • 

  • On Windows systems, this feature depends on ReadDirectoryChangesW.
    • 

  • On Aix systems, this feature depends on AHAFS, which must be enabled.
    • 



If the underlying functionality is not available for some reason, then
fs.watch will not be able to function. For example, watching files or
directories can be unreliable, and in some cases impossible, on network file
systems (NFS, SMB, etc), or host file systems when using virtualization software
such as Vagrant, Docker, etc.


You can still use fs.watchFile, which uses stat polling, but it is slower and
less reliable.


Inodes#



On Linux and OS X systems, fs.watch() resolves the path to an inode and
watches the inode. If the watched path is deleted and recreated, it is assigned
a new inode. The watch will emit an event for the delete but will continue
watching the original inode. Events for the new inode will not be emitted.
This is expected behavior.


Filename Argument#



Providing filename argument in the callback is only supported on Linux and
Windows.  Even on supported platforms, filename is not always guaranteed to
be provided. Therefore, don't assume that filename argument is always
provided in the callback, and have some fallback logic if it is null.


fs.watch('somedir', (event, filename) => {
  console.log(`event is: ${event}`);
  if (filename) {
    console.log(`filename provided: ${filename}`);
  } else {
    console.log('filename not provided');
  }
});



fs.watchFile(filename[, options], listener)#



Added in: v0.1.31

Watch for changes on filename. The callback listener will be called each
time the file is accessed.


The options argument may be omitted. If provided, it should be an object. The
options object may contain a boolean named persistent that indicates
whether the process should continue to run as long as files are being watched.
The options object may specify an interval property indicating how often the
target should be polled in milliseconds. The default is
{ persistent: true, interval: 5007 }.


The listener gets two arguments the current stat object and the previous
stat object:


fs.watchFile('message.text', (curr, prev) => {
  console.log(`the current mtime is: ${curr.mtime}`);
  console.log(`the previous mtime was: ${prev.mtime}`);
});



These stat objects are instances of fs.Stat.


If you want to be notified when the file was modified, not just accessed,
you need to compare curr.mtime and prev.mtime.


Note: when an fs.watchFile operation results in an ENOENT error, it will
 invoke the listener once, with all the fields zeroed (or, for dates, the Unix
 Epoch). In Windows, blksize and blocks fields will be undefined, instead
 of zero. If the file is created later on, the listener will be called again,
 with the latest stat objects. This is a change in functionality since v0.10.


Note: fs.watch() is more efficient than fs.watchFile and fs.unwatchFile.
fs.watch should be used instead of fs.watchFile and fs.unwatchFile
when possible.


fs.write(fd, buffer, offset, length[, position], callback)#



Added in: v0.0.2

Write buffer to the file specified by fd.


offset determines the part of the buffer to be written, and length is
an integer specifying the number of bytes to write.


position refers to the offset from the beginning of the file where this data
should be written. If typeof position !== 'number', the data will be written
at the current position. See pwrite(2).


The callback will be given three arguments (err, written, buffer) where
written specifies how many bytes were written from buffer.


Note that it is unsafe to use fs.write multiple times on the same file
without waiting for the callback. For this scenario,
fs.createWriteStream is strongly recommended.


On Linux, positional writes don't work when the file is opened in append mode.
The kernel ignores the position argument and always appends the data to
the end of the file.


fs.write(fd, data[, position[, encoding]], callback)#



Added in: v0.11.5

Write data to the file specified by fd.  If data is not a Buffer instance
then the value will be coerced to a string.


position refers to the offset from the beginning of the file where this data
should be written. If typeof position !== 'number' the data will be written at
the current position. See pwrite(2).


encoding is the expected string encoding.


The callback will receive the arguments (err, written, string) where written
specifies how many bytes the passed string required to be written. Note that
bytes written is not the same as string characters. See Buffer.byteLength.


Unlike when writing buffer, the entire string must be written. No substring
may be specified. This is because the byte offset of the resulting data may not
be the same as the string offset.


Note that it is unsafe to use fs.write multiple times on the same file
without waiting for the callback. For this scenario,
fs.createWriteStream is strongly recommended.


On Linux, positional writes don't work when the file is opened in append mode.
The kernel ignores the position argument and always appends the data to
the end of the file.


fs.writeFile(file, data[, options], callback)#



Added in: v0.1.29



Asynchronously writes data to a file, replacing the file if it already exists.
data can be a string or a buffer.


The encoding option is ignored if data is a buffer. It defaults
to 'utf8'.


Example:


fs.writeFile('message.txt', 'Hello Node.js', (err) => {
  if (err) throw err;
  console.log('It\'s saved!');
});



If options is a string, then it specifies the encoding. Example:


fs.writeFile('message.txt', 'Hello Node.js', 'utf8', callback);



Note that it is unsafe to use fs.writeFile multiple times on the same file
without waiting for the callback. For this scenario,
fs.createWriteStream is strongly recommended.


fs.writeFileSync(file, data[, options])#



Added in: v0.1.29

The synchronous version of fs.writeFile(). Returns undefined.


fs.writeSync(fd, buffer, offset, length[, position])#



Added in: v0.1.21

fs.writeSync(fd, data[, position[, encoding]])#



Added in: v0.11.5

Synchronous versions of fs.write(). Returns the number of bytes written.




Global Objects#



These objects are available in all modules. Some of these objects aren't
actually in the global scope but in the module scope - this will be noted.


The objects listed here are specific to Node.js. There are a number of
built-in objects that are part of the JavaScript language itself, which are
also globally accessible.


Class: Buffer#



Added in: v0.1.103




Used to handle binary data. See the buffer section.


__dirname#



Added in: v0.1.27




The directory name of the current module. This the same as the
path.dirname() of the __filename.


__dirname isn't actually a global but rather local to each module.


Example: running node example.js from /Users/mjr


console.log(__dirname);
// Prints: /Users/mjr
console.log(path.dirname(__filename));
// Prints: /Users/mjr



__filename#



Added in: v0.0.1




The file name of the current module. This is the resolved absolute path of the
current module file.


For a main program this is not necessarily the same as the file name used in the
command line.


See __dirname for the directory name of the current module.


__filename isn't actually a global but rather local to each module.


Examples:


Running node example.js from /Users/mjr


console.log(__filename);
// Prints: /Users/mjr/example.js
console.log(__dirname);
// Prints: /Users/mjr



Given two modules: a and b, where b is a dependency of
a and there is a directory structure of:


    

  • /Users/mjr/app/a.js
    • 

  • /Users/mjr/app/node_modules/b/b.js
    • 



References to __filename within b.js will return
/Users/mjr/app/node_modules/b/b.js while references to __filename within
a.js will return /Users/mjr/app/a.js.


clearImmediate(immediateObject)#



Added in: v0.9.1



clearImmediate is described in the timers section.


clearInterval(intervalObject)#



Added in: v0.0.1



clearInterval is described in the timers section.


clearTimeout(timeoutObject)#



Added in: v0.0.1



clearTimeout is described in the timers section.


console#



Added in: v0.1.100




Used to print to stdout and stderr. See the console section.


exports#



Added in: v0.1.12



A reference to the module.exports that is shorter to type.
See module system documentation for details on when to use exports and
when to use module.exports.


exports isn't actually a global but rather local to each module.


See the module system documentation for more information.


global#



Added in: v0.1.27




In browsers, the top-level scope is the global scope. That means that in
browsers if you're in the global scope var something will define a global
variable. In Node.js this is different. The top-level scope is not the global
scope; var something inside an Node.js module will be local to that module.


module#



Added in: v0.1.16




A reference to the current module. In particular
module.exports is used for defining what a module exports and makes
available through require().


module isn't actually a global but rather local to each module.


See the module system documentation for more information.


process#



Added in: v0.1.7




The process object. See the process object section.


require()#



Added in: v0.1.13




To require modules. See the Modules section.  require isn't actually a
global but rather local to each module.


require.cache#



Added in: v0.3.0



Modules are cached in this object when they are required. By deleting a key
value from this object, the next require will reload the module. Note that
this does not apply to native addons, for which reloading will result in an
Error.


require.extensions#



Added in: v0.3.0
Deprecated since: v0.10.6 

Stability: 0 - Deprecated


Instruct require on how to handle certain file extensions.


Process files with the extension .sjs as .js:


require.extensions['.sjs'] = require.extensions['.js'];



Deprecated  In the past, this list has been used to load
non-JavaScript modules into Node.js by compiling them on-demand.
However, in practice, there are much better ways to do this, such as
loading modules via some other Node.js program, or compiling them to
JavaScript ahead of time.


Since the Module system is locked, this feature will probably never go
away.  However, it may have subtle bugs and complexities that are best
left untouched.


require.resolve()#



Added in: v0.3.0

Use the internal require() machinery to look up the location of a module,
but rather than loading the module, just return the resolved filename.


setImmediate(callback[, arg][, ...])#



Added in: v0.9.1



setImmediate is described in the timers section.


setInterval(callback, delay[, arg][, ...])#



Added in: v0.0.1



setInterval is described in the timers section.


setTimeout(callback, delay[, arg][, ...])#



Added in: v0.0.1



setTimeout is described in the timers section.




HTTP#


Stability: 2 - Stable
To use the HTTP server and client one must require('http').


The HTTP interfaces in Node.js are designed to support many features
of the protocol which have been traditionally difficult to use.
In particular, large, possibly chunk-encoded, messages. The interface is
careful to never buffer entire requests or responses--the
user is able to stream data.


HTTP message headers are represented by an object like this:


{ 'content-length': '123',
  'content-type': 'text/plain',
  'connection': 'keep-alive',
  'host': 'mysite.com',
  'accept': '*/*' }

Keys are lowercased. Values are not modified.


In order to support the full spectrum of possible HTTP applications, Node.js's
HTTP API is very low-level. It deals with stream handling and message
parsing only. It parses a message into headers and body but it does not
parse the actual headers or the body.


See message.headers for details on how duplicate headers are handled.


The raw headers as they were received are retained in the rawHeaders
property, which is an array of [key, value, key2, value2, ...].  For
example, the previous message header object might have a rawHeaders
list like the following:


[ 'ConTent-Length', '123456',
  'content-LENGTH', '123',
  'content-type', 'text/plain',
  'CONNECTION', 'keep-alive',
  'Host', 'mysite.com',
  'accepT', '*/*' ]

Class: http.Agent#



Added in: v0.3.4

The HTTP Agent is used for pooling sockets used in HTTP client
requests.


The HTTP Agent also defaults client requests to using
Connection:keep-alive. If no pending HTTP requests are waiting on a
socket to become free the socket is closed. This means that Node.js's
pool has the benefit of keep-alive when under load but still does not
require developers to manually close the HTTP clients using
KeepAlive.


If you opt into using HTTP KeepAlive, you can create an Agent object
with that flag set to true.  (See the constructor options.)
Then, the Agent will keep unused sockets in a pool for later use.  They
will be explicitly marked so as to not keep the Node.js process running.
However, it is still a good idea to explicitly destroy() KeepAlive
agents when they are no longer in use, so that the Sockets will be shut
down.


Sockets are removed from the agent's pool when the socket emits either
a 'close' event or a special 'agentRemove' event. This means that if
you intend to keep one HTTP request open for a long time and don't
want it to stay in the pool you can do something along the lines of:


http.get(options, (res) => {
  // Do stuff
}).on('socket', (socket) => {
  socket.emit('agentRemove');
});



Alternatively, you could just opt out of pooling entirely using
agent:false:


http.get({
  hostname: 'localhost',
  port: 80,
  path: '/',
  agent: false  // create a new agent just for this one request
}, (res) => {
  // Do stuff with response
})



new Agent(options)#



Added in: v0.3.4

    

  • options <Object> Set of configurable options to set on the agent.
Can have the following fields:
      

    • keepAlive <Boolean> Keep sockets around even when there are no
outstanding requests, so they can be used for future requests without
having to reestablish a TCP connection. Default = false
      • 

    • keepAliveMsecs <Integer> When using the keepAlive option, specifies
the initial delay
for TCP Keep-Alive packets. Ignored when the
keepAlive option is false or undefined. Default = 1000.
      • 

    • maxSockets <Number> Maximum number of sockets to allow per
host.  Default = Infinity.
      • 

    • maxFreeSockets <Number> Maximum number of sockets to leave open
in a free state.  Only relevant if keepAlive is set to true.
Default = 256.
      • 

    

    • 



The default http.globalAgent that is used by http.request() has all
of these values set to their respective defaults.


To configure any of them, you must create your own http.Agent object.


const http = require('http');
var keepAliveAgent = new http.Agent({ keepAlive: true });
options.agent = keepAliveAgent;
http.request(options, onResponseCallback);



agent.destroy()#



Added in: v0.11.4

Destroy any sockets that are currently in use by the agent.


It is usually not necessary to do this.  However, if you are using an
agent with KeepAlive enabled, then it is best to explicitly shut down
the agent when you know that it will no longer be used.  Otherwise,
sockets may hang open for quite a long time before the server
terminates them.


agent.freeSockets#



Added in: v0.11.4

An object which contains arrays of sockets currently awaiting use by
the Agent when HTTP KeepAlive is used.  Do not modify.


agent.getName(options)#



Added in: v0.11.4

Get a unique name for a set of request options, to determine whether a
connection can be reused.  In the http agent, this returns
host:port:localAddress.  In the https agent, the name includes the
CA, cert, ciphers, and other HTTPS/TLS-specific options that determine
socket reusability.


Options:


    

  • host: A domain name or IP address of the server to issue the request to.
    • 

  • port: Port of remote server.
    • 

  • localAddress: Local interface to bind for network connections when issuing
the request.
    • 



agent.maxFreeSockets#



Added in: v0.11.7

By default set to 256.  For Agents supporting HTTP KeepAlive, this
sets the maximum number of sockets that will be left open in the free
state.


agent.maxSockets#



Added in: v0.3.6

By default set to Infinity. Determines how many concurrent sockets the agent
can have open per origin. Origin is either a 'host:port' or
'host:port:localAddress' combination.


agent.requests#



Added in: v0.5.9

An object which contains queues of requests that have not yet been assigned to
sockets. Do not modify.


agent.sockets#



Added in: v0.3.6

An object which contains arrays of sockets currently in use by the
Agent.  Do not modify.


Class: http.ClientRequest#



Added in: v0.1.17

This object is created internally and returned from http.request().  It
represents an in-progress request whose header has already been queued.  The
header is still mutable using the setHeader(name, value), getHeader(name),
removeHeader(name) API.  The actual header will be sent along with the first
data chunk or when closing the connection.


To get the response, add a listener for 'response' to the request object.
'response' will be emitted from the request object when the response
headers have been received.  The 'response' event is executed with one
argument which is an instance of http.IncomingMessage.


During the 'response' event, one can add listeners to the
response object; particularly to listen for the 'data' event.


If no 'response' handler is added, then the response will be
entirely discarded.  However, if you add a 'response' event handler,
then you must consume the data from the response object, either by
calling response.read() whenever there is a 'readable' event, or
by adding a 'data' handler, or by calling the .resume() method.
Until the data is consumed, the 'end' event will not fire.  Also, until
the data is read it will consume memory that can eventually lead to a
'process out of memory' error.


Note: Node.js does not check whether Content-Length and the length of the body
which has been transmitted are equal or not.


The request implements the Writable Stream interface. This is an
EventEmitter with the following events:


Event: 'abort'#



Added in: v1.4.1

function () { }


Emitted when the request has been aborted by the client. This event is only
emitted on the first call to abort().


Event: 'aborted'#



Added in: v0.3.8

function () { }


Emitted when the request has been aborted by the server and the network
socket has closed.


Event: 'connect'#



Added in: v0.7.0

function (response, socket, head) { }


Emitted each time a server responds to a request with a CONNECT method. If this
event isn't being listened for, clients receiving a CONNECT method will have
their connections closed.


A client and server pair that shows you how to listen for the 'connect' event:


const http = require('http');
const net = require('net');
const url = require('url');

// Create an HTTP tunneling proxy
var proxy = http.createServer( (req, res) => {
  res.writeHead(200, {'Content-Type': 'text/plain'});
  res.end('okay');
});
proxy.on('connect', (req, cltSocket, head) => {
  // connect to an origin server
  var srvUrl = url.parse(`http://${req.url}`);
  var srvSocket = net.connect(srvUrl.port, srvUrl.hostname, () => {
    cltSocket.write('HTTP/1.1 200 Connection Established\r\n' +
                    'Proxy-agent: Node.js-Proxy\r\n' +
                    '\r\n');
    srvSocket.write(head);
    srvSocket.pipe(cltSocket);
    cltSocket.pipe(srvSocket);
  });
});

// now that proxy is running
proxy.listen(1337, '127.0.0.1', () => {

  // make a request to a tunneling proxy
  var options = {
    port: 1337,
    hostname: '127.0.0.1',
    method: 'CONNECT',
    path: 'www.google.com:80'
  };

  var req = http.request(options);
  req.end();

  req.on('connect', (res, socket, head) => {
    console.log('got connected!');

    // make a request over an HTTP tunnel
    socket.write('GET / HTTP/1.1\r\n' +
                 'Host: www.google.com:80\r\n' +
                 'Connection: close\r\n' +
                 '\r\n');
    socket.on('data', (chunk) => {
      console.log(chunk.toString());
    });
    socket.on('end', () => {
      proxy.close();
    });
  });
});



Event: 'continue'#



Added in: v0.3.2

function () { }


Emitted when the server sends a '100 Continue' HTTP response, usually because
the request contained 'Expect: 100-continue'. This is an instruction that
the client should send the request body.


Event: 'response'#



Added in: v0.1.0

function (response) { }


Emitted when a response is received to this request. This event is emitted only
once. The response argument will be an instance of http.IncomingMessage.


Event: 'socket'#



Added in: v0.5.3

function (socket) { }


Emitted after a socket is assigned to this request.


Event: 'upgrade'#



Added in: v0.1.94

function (response, socket, head) { }


Emitted each time a server responds to a request with an upgrade. If this
event isn't being listened for, clients receiving an upgrade header will have
their connections closed.


A client server pair that show you how to listen for the 'upgrade' event.


const http = require('http');

// Create an HTTP server
var srv = http.createServer( (req, res) => {
  res.writeHead(200, {'Content-Type': 'text/plain'});
  res.end('okay');
});
srv.on('upgrade', (req, socket, head) => {
  socket.write('HTTP/1.1 101 Web Socket Protocol Handshake\r\n' +
               'Upgrade: WebSocket\r\n' +
               'Connection: Upgrade\r\n' +
               '\r\n');

  socket.pipe(socket); // echo back
});

// now that server is running
srv.listen(1337, '127.0.0.1', () => {

  // make a request
  var options = {
    port: 1337,
    hostname: '127.0.0.1',
    headers: {
      'Connection': 'Upgrade',
      'Upgrade': 'websocket'
    }
  };

  var req = http.request(options);
  req.end();

  req.on('upgrade', (res, socket, upgradeHead) => {
    console.log('got upgraded!');
    socket.end();
    process.exit(0);
  });
});



request.abort()#



Added in: v0.3.8

Marks the request as aborting. Calling this will cause remaining data
in the response to be dropped and the socket to be destroyed.


request.aborted#



Added in: v0.11.14

If a request has been aborted, this value is the time when the request was
aborted, in milliseconds since 1 January 1970 00:00:00 UTC.


request.end([data][, encoding][, callback])#



Added in: v0.1.90

Finishes sending the request. If any parts of the body are
unsent, it will flush them to the stream. If the request is
chunked, this will send the terminating '0\r\n\r\n'.


If data is specified, it is equivalent to calling
response.write(data, encoding) followed by request.end(callback).


If callback is specified, it will be called when the request stream
is finished.


request.flushHeaders()#



Added in: v1.6.0

Flush the request headers.


For efficiency reasons, Node.js normally buffers the request headers until you
call request.end() or write the first chunk of request data.  It then tries
hard to pack the request headers and data into a single TCP packet.


That's usually what you want (it saves a TCP round-trip) but not when the first
data isn't sent until possibly much later.  request.flushHeaders() lets you bypass
the optimization and kickstart the request.


request.setNoDelay([noDelay])#



Added in: v0.5.9

Once a socket is assigned to this request and is connected
socket.setNoDelay() will be called.


request.setSocketKeepAlive([enable][, initialDelay])#



Added in: v0.5.9

Once a socket is assigned to this request and is connected
socket.setKeepAlive() will be called.


request.setTimeout(timeout[, callback])#



Added in: v0.5.9

Once a socket is assigned to this request and is connected
socket.setTimeout() will be called.


    

  • timeout <Number> Milliseconds before a request is considered to be timed out.
    • 

  • callback <Function> Optional function to be called when a timeout occurs. Same as binding to the timeout event.
    • 



Returns request.


request.write(chunk[, encoding][, callback])#



Added in: v0.1.29

Sends a chunk of the body.  By calling this method
many times, the user can stream a request body to a
server--in that case it is suggested to use the
['Transfer-Encoding', 'chunked'] header line when
creating the request.


The chunk argument should be a Buffer or a string.


The encoding argument is optional and only applies when chunk is a string.
Defaults to 'utf8'.


The callback argument is optional and will be called when this chunk of data
is flushed.


Returns request.


Class: http.Server#



Added in: v0.1.17

This class inherits from net.Server and has the following additional events:


Event: 'checkContinue'#



Added in: v0.3.0

function (request, response) { }


Emitted each time a request with an http Expect: 100-continue is received.
If this event isn't listened for, the server will automatically respond
with a 100 Continue as appropriate.


Handling this event involves calling response.writeContinue() if the client
should continue to send the request body, or generating an appropriate HTTP
response (e.g. 400 Bad Request) if the client should not continue to send the
request body.


Note that when this event is emitted and handled, the 'request' event will
not be emitted.


Event: 'clientError'#



Added in: v0.1.94

function (exception, socket) { }


If a client connection emits an 'error' event, it will be forwarded here.


socket is the net.Socket object that the error originated from.


Event: 'close'#



Added in: v0.1.4

function () { }


Emitted when the server closes.


Event: 'connect'#



Added in: v0.7.0

function (request, socket, head) { }


Emitted each time a client requests a http CONNECT method. If this event isn't
listened for, then clients requesting a CONNECT method will have their
connections closed.


    

  • request is the arguments for the http request, as it is in the request
event.
    • 

  • socket is the network socket between the server and client.
    • 

  • head is an instance of Buffer, the first packet of the tunneling stream,
this may be empty.
    • 



After this event is emitted, the request's socket will not have a 'data'
event listener, meaning you will need to bind to it in order to handle data
sent to the server on that socket.


Event: 'connection'#



Added in: v0.1.0

function (socket) { }


When a new TCP stream is established. socket is an object of type
net.Socket. Usually users will not want to access this event. In
particular, the socket will not emit 'readable' events because of how
the protocol parser attaches to the socket. The socket can also be
accessed at request.connection.


Event: 'request'#



Added in: v0.1.0

function (request, response) { }


Emitted each time there is a request. Note that there may be multiple requests
per connection (in the case of keep-alive connections).
 request is an instance of http.IncomingMessage and response is
an instance of http.ServerResponse.


Event: 'upgrade'#



Added in: v0.1.94

function (request, socket, head) { }


Emitted each time a client requests a http upgrade. If this event isn't
listened for, then clients requesting an upgrade will have their connections
closed.


    

  • request is the arguments for the http request, as it is in the request
event.
    • 

  • socket is the network socket between the server and client.
    • 

  • head is an instance of Buffer, the first packet of the upgraded stream,
this may be empty.
    • 



After this event is emitted, the request's socket will not have a 'data'
event listener, meaning you will need to bind to it in order to handle data
sent to the server on that socket.


server.close([callback])#



Added in: v0.1.90

Stops the server from accepting new connections.  See net.Server.close().


server.listen(handle[, callback])#



Added in: v0.5.10



The handle object can be set to either a server or socket (anything
with an underlying _handle member), or a {fd: <n>} object.


This will cause the server to accept connections on the specified
handle, but it is presumed that the file descriptor or handle has
already been bound to a port or domain socket.


Listening on a file descriptor is not supported on Windows.


This function is asynchronous. callback will be added as a listener for the
'listening' event. See also net.Server.listen().


Returns server.


server.listen(path[, callback])#



Added in: v0.1.90

Start a UNIX socket server listening for connections on the given path.


This function is asynchronous. callback will be added as a listener for the
'listening' event.  See also net.Server.listen(path).


server.listen([port][, hostname][, backlog][, callback])#



Added in: v0.1.90

Begin accepting connections on the specified port and hostname. If the
hostname is omitted, the server will accept connections on any IPv6 address
(::) when IPv6 is available, or any IPv4 address (0.0.0.0) otherwise.
Omit the port argument, or use a port value of 0, to have the operating system
assign a random port, which can be retrieved by using server.address().port
after the 'listening' event has been emitted.


To listen to a unix socket, supply a filename instead of port and hostname.


Backlog is the maximum length of the queue of pending connections.
The actual length will be determined by your OS through sysctl settings such as
tcp_max_syn_backlog and somaxconn on linux. The default value of this
parameter is 511 (not 512).


This function is asynchronous. callback will be added as a listener for the
'listening' event.  See also net.Server.listen(port).


server.maxHeadersCount#



Added in: v0.7.0

Limits maximum incoming headers count, equal to 1000 by default. If set to 0 -
no limit will be applied.


server.setTimeout(msecs, callback)#



Added in: v0.9.12



Sets the timeout value for sockets, and emits a 'timeout' event on
the Server object, passing the socket as an argument, if a timeout
occurs.


If there is a 'timeout' event listener on the Server object, then it
will be called with the timed-out socket as an argument.


By default, the Server's timeout value is 2 minutes, and sockets are
destroyed automatically if they time out.  However, if you assign a
callback to the Server's 'timeout' event, then you are responsible
for handling socket timeouts.


Returns server.


server.timeout#



Added in: v0.9.12



The number of milliseconds of inactivity before a socket is presumed
to have timed out.


Note that the socket timeout logic is set up on connection, so
changing this value only affects new connections to the server, not
any existing connections.


Set to 0 to disable any kind of automatic timeout behavior on incoming
connections.


Class: http.ServerResponse#



Added in: v0.1.17

This object is created internally by a HTTP server--not by the user. It is
passed as the second parameter to the 'request' event.


The response implements, but does not inherit from, the Writable Stream
interface. This is an EventEmitter with the following events:


Event: 'close'#



Added in: v0.6.7

function () { }


Indicates that the underlying connection was terminated before
response.end() was called or able to flush.


Event: 'finish'#



Added in: v0.3.6

function () { }


Emitted when the response has been sent. More specifically, this event is
emitted when the last segment of the response headers and body have been
handed off to the operating system for transmission over the network. It
does not imply that the client has received anything yet.


After this event, no more events will be emitted on the response object.


response.addTrailers(headers)#



Added in: v0.3.0

This method adds HTTP trailing headers (a header but at the end of the
message) to the response.


Trailers will only be emitted if chunked encoding is used for the
response; if it is not (e.g. if the request was HTTP/1.0), they will
be silently discarded.


Note that HTTP requires the Trailer header to be sent if you intend to
emit trailers, with a list of the header fields in its value. E.g.,


response.writeHead(200, { 'Content-Type': 'text/plain',
                          'Trailer': 'Content-MD5' });
response.write(fileData);
response.addTrailers({'Content-MD5': '7895bf4b8828b55ceaf47747b4bca667'});
response.end();



Attempting to set a header field name or value that contains invalid characters
will result in a TypeError being thrown.


response.end([data][, encoding][, callback])#



Added in: v0.1.90

This method signals to the server that all of the response headers and body
have been sent; that server should consider this message complete.
The method, response.end(), MUST be called on each response.


If data is specified, it is equivalent to calling
response.write(data, encoding) followed by response.end(callback).


If callback is specified, it will be called when the response stream
is finished.


response.finished#



Added in: v0.0.2

Boolean value that indicates whether the response has completed. Starts
as false. After response.end() executes, the value will be true.


response.getHeader(name)#



Added in: v0.4.0

Reads out a header that's already been queued but not sent to the client.  Note
that the name is case insensitive.  This can only be called before headers get
implicitly flushed.


Example:


var contentType = response.getHeader('content-type');



response.headersSent#



Added in: v0.9.3

Boolean (read-only). True if headers were sent, false otherwise.


response.removeHeader(name)#



Added in: v0.4.0

Removes a header that's queued for implicit sending.


Example:


response.removeHeader('Content-Encoding');



response.sendDate#



Added in: v0.7.5

When true, the Date header will be automatically generated and sent in
the response if it is not already present in the headers. Defaults to true.


This should only be disabled for testing; HTTP requires the Date header
in responses.


response.setHeader(name, value)#



Added in: v0.4.0

Sets a single header value for implicit headers.  If this header already exists
in the to-be-sent headers, its value will be replaced.  Use an array of strings
here if you need to send multiple headers with the same name.


Example:


response.setHeader('Content-Type', 'text/html');



or


response.setHeader('Set-Cookie', ['type=ninja', 'language=javascript']);



Attempting to set a header field name or value that contains invalid characters
will result in a TypeError being thrown.


When headers have been set with response.setHeader(), they will be merged with
any headers passed to response.writeHead(), with the headers passed to
response.writeHead() given precedence.


// returns content-type = text/plain
const server = http.createServer((req,res) => {
  res.setHeader('Content-Type', 'text/html');
  res.setHeader('X-Foo', 'bar');
  res.writeHead(200, {'Content-Type': 'text/plain'});
  res.end('ok');
});



response.setTimeout(msecs, callback)#



Added in: v0.9.12



Sets the Socket's timeout value to msecs.  If a callback is
provided, then it is added as a listener on the 'timeout' event on
the response object.


If no 'timeout' listener is added to the request, the response, or
the server, then sockets are destroyed when they time out.  If you
assign a handler on the request, the response, or the server's
'timeout' events, then it is your responsibility to handle timed out
sockets.


Returns response.


response.statusCode#



Added in: v0.4.0

When using implicit headers (not calling response.writeHead() explicitly),
this property controls the status code that will be sent to the client when
the headers get flushed.


Example:


response.statusCode = 404;



After response header was sent to the client, this property indicates the
status code which was sent out.


response.statusMessage#



Added in: v0.11.8

When using implicit headers (not calling response.writeHead() explicitly), this property
controls the status message that will be sent to the client when the headers get
flushed. If this is left as undefined then the standard message for the status
code will be used.


Example:


response.statusMessage = 'Not found';



After response header was sent to the client, this property indicates the
status message which was sent out.


response.write(chunk[, encoding][, callback])#



Added in: v0.1.29

If this method is called and response.writeHead() has not been called,
it will switch to implicit header mode and flush the implicit headers.


This sends a chunk of the response body. This method may
be called multiple times to provide successive parts of the body.


chunk can be a string or a buffer. If chunk is a string,
the second parameter specifies how to encode it into a byte stream.
By default the encoding is 'utf8'. callback will be called when this chunk
of data is flushed.


Note: This is the raw HTTP body and has nothing to do with
higher-level multi-part body encodings that may be used.


The first time response.write() is called, it will send the buffered
header information and the first body to the client. The second time
response.write() is called, Node.js assumes you're going to be streaming
data, and sends that separately. That is, the response is buffered up to the
first chunk of body.


Returns true if the entire data was flushed successfully to the kernel
buffer. Returns false if all or part of the data was queued in user memory.
'drain' will be emitted when the buffer is free again.


response.writeContinue()#



Added in: v0.3.0

Sends a HTTP/1.1 100 Continue message to the client, indicating that
the request body should be sent. See the 'checkContinue' event on Server.


response.writeHead(statusCode[, statusMessage][, headers])#



Added in: v0.1.30

Sends a response header to the request. The status code is a 3-digit HTTP
status code, like 404. The last argument, headers, are the response headers.
Optionally one can give a human-readable statusMessage as the second
argument.


Example:


var body = 'hello world';
response.writeHead(200, {
  'Content-Length': Buffer.byteLength(body),
  'Content-Type': 'text/plain' });



This method must only be called once on a message and it must
be called before response.end() is called.


If you call response.write() or response.end() before calling this,
the implicit/mutable headers will be calculated and call this function for you.


When headers have been set with response.setHeader(), they will be merged with
any headers passed to response.writeHead(), with the headers passed to
response.writeHead() given precedence.


// returns content-type = text/plain
const server = http.createServer((req,res) => {
  res.setHeader('Content-Type', 'text/html');
  res.setHeader('X-Foo', 'bar');
  res.writeHead(200, {'Content-Type': 'text/plain'});
  res.end('ok');
});



Note that Content-Length is given in bytes not characters. The above example
works because the string 'hello world' contains only single byte characters.
If the body contains higher coded characters then Buffer.byteLength()
should be used to determine the number of bytes in a given encoding.
And Node.js does not check whether Content-Length and the length of the body
which has been transmitted are equal or not.


Attempting to set a header field name or value that contains invalid characters
will result in a TypeError being thrown.


Class: http.IncomingMessage#



Added in: v0.1.17

An IncomingMessage object is created by http.Server or
http.ClientRequest and passed as the first argument to the 'request'
and 'response' event respectively. It may be used to access response status,
headers and data.


It implements the Readable Stream interface, as well as the
following additional events, methods, and properties.


Event: 'aborted'#



Added in: v0.3.8

function () { }


Emitted when the request has been aborted by the client and the network
socket has closed.


Event: 'close'#



Added in: v0.4.2

function () { }


Indicates that the underlying connection was closed.
Just like 'end', this event occurs only once per response.


message.destroy([error])#



Added in: v0.3.0



Calls destroy() on the socket that received the IncomingMessage. If error
is provided, an 'error' event is emitted and error is passed as an argument
to any listeners on the event.


message.headers#



Added in: v0.1.5

The request/response headers object.


Key-value pairs of header names and values. Header names are lower-cased.
Example:


// Prints something like:
//
// { 'user-agent': 'curl/7.22.0',
//   host: '127.0.0.1:8000',
//   accept: '*/*' }
console.log(request.headers);



Duplicates in raw headers are handled in the following ways, depending on the
header name:


    

  • Duplicates of age, authorization, content-length, content-type,
etag, expires, from, host, if-modified-since, if-unmodified-since,
last-modified, location, max-forwards, proxy-authorization, referer,
retry-after, or user-agent are discarded.
    • 

  • set-cookie is always an array. Duplicates are added to the array.
    • 

  • For all other headers, the values are joined together with ', '.
    • 



message.httpVersion#



Added in: v0.1.1

In case of server request, the HTTP version sent by the client. In the case of
client response, the HTTP version of the connected-to server.
Probably either '1.1' or '1.0'.


Also message.httpVersionMajor is the first integer and
message.httpVersionMinor is the second.


message.method#



Added in: v0.1.1

Only valid for request obtained from http.Server.


The request method as a string. Read only. Example:
'GET', 'DELETE'.


message.rawHeaders#



Added in: v0.11.6

The raw request/response headers list exactly as they were received.


Note that the keys and values are in the same list.  It is not a
list of tuples.  So, the even-numbered offsets are key values, and the
odd-numbered offsets are the associated values.


Header names are not lowercased, and duplicates are not merged.


// Prints something like:
//
// [ 'user-agent',
//   'this is invalid because there can be only one',
//   'User-Agent',
//   'curl/7.22.0',
//   'Host',
//   '127.0.0.1:8000',
//   'ACCEPT',
//   '*/*' ]
console.log(request.rawHeaders);



message.rawTrailers#



Added in: v0.11.6

The raw request/response trailer keys and values exactly as they were
received.  Only populated at the 'end' event.


message.setTimeout(msecs, callback)#



Added in: v0.5.9



Calls message.connection.setTimeout(msecs, callback).


Returns message.


message.statusCode#



Added in: v0.1.1

Only valid for response obtained from http.ClientRequest.


The 3-digit HTTP response status code. E.G. 404.


message.statusMessage#



Added in: v0.11.10

Only valid for response obtained from http.ClientRequest.


The HTTP response status message (reason phrase). E.G. OK or Internal Server Error.


message.socket#



Added in: v0.3.0

The net.Socket object associated with the connection.


With HTTPS support, use request.socket.getPeerCertificate() to obtain the
client's authentication details.


message.trailers#



Added in: v0.3.0

The request/response trailers object. Only populated at the 'end' event.


message.url#



Added in: v0.1.90

Only valid for request obtained from http.Server.


Request URL string. This contains only the URL that is
present in the actual HTTP request. If the request is:


GET /status?name=ryan HTTP/1.1\r\n
Accept: text/plain\r\n
\r\n

Then request.url will be:


'/status?name=ryan'

If you would like to parse the URL into its parts, you can use
require('url').parse(request.url).  Example:


$ node
> require('url').parse('/status?name=ryan')
{
  href: '/status?name=ryan',
  search: '?name=ryan',
  query: 'name=ryan',
  pathname: '/status'
}

If you would like to extract the parameters from the query string,
you can use the require('querystring').parse function, or pass
true as the second argument to require('url').parse.  Example:


$ node
> require('url').parse('/status?name=ryan', true)
{
  href: '/status?name=ryan',
  search: '?name=ryan',
  query: {name: 'ryan'},
  pathname: '/status'
}

http.METHODS#



Added in: v0.11.8



A list of the HTTP methods that are supported by the parser.


http.STATUS_CODES#



Added in: v0.1.22



A collection of all the standard HTTP response status codes, and the
short description of each.  For example, http.STATUS_CODES[404] === 'Not
Found'.


http.createClient([port][, host])#



Added in: v0.1.13
Deprecated since: v0.3.6 

Stability: 0 - Deprecated: Use http.request() instead.
Constructs a new HTTP client. port and host refer to the server to be
connected to.


http.createServer([requestListener])#



Added in: v0.1.13

Returns a new instance of http.Server.


The requestListener is a function which is automatically
added to the 'request' event.


http.get(options[, callback])#



Added in: v0.3.6

Since most requests are GET requests without bodies, Node.js provides this
convenience method. The only difference between this method and http.request()
is that it sets the method to GET and calls req.end() automatically.


Example:


http.get('http://www.google.com/index.html', (res) => {
  console.log(`Got response: ${res.statusCode}`);
  // consume response body
  res.resume();
}).on('error', (e) => {
  console.log(`Got error: ${e.message}`);
});



http.globalAgent#



Added in: v0.5.9

Global instance of Agent which is used as the default for all http client
requests.


http.request(options[, callback])#



Added in: v0.3.6

Node.js maintains several connections per server to make HTTP requests.
This function allows one to transparently issue requests.


options can be an object or a string. If options is a string, it is
automatically parsed with url.parse().


Options:


    

  • protocol: Protocol to use. Defaults to 'http:'.
    • 

  • host: A domain name or IP address of the server to issue the request to.
Defaults to 'localhost'.
    • 

  • hostname: Alias for host. To support url.parse() hostname is
preferred over host.
    • 

  • family: IP address family to use when resolving host and hostname.
Valid values are 4 or 6. When unspecified, both IP v4 and v6 will be
used.
    • 

  • port: Port of remote server. Defaults to 80.
    • 

  • localAddress: Local interface to bind for network connections.
    • 

  • socketPath: Unix Domain Socket (use one of host:port or socketPath).
    • 

  • method: A string specifying the HTTP request method. Defaults to 'GET'.
    • 

  • path: Request path. Defaults to '/'. Should include query string if any.
E.G. '/index.html?page=12'. An exception is thrown when the request path
contains illegal characters. Currently, only spaces are rejected but that
may change in the future.
    • 

  • headers: An object containing request headers.
    • 

  • auth: Basic authentication i.e. 'user:password' to compute an
Authorization header.
    • 

  • agent: Controls Agent behavior. When an Agent is used request will
default to Connection: keep-alive. Possible values:
      

    • undefined (default): use http.globalAgent for this host and port.
      • 

    • Agent object: explicitly use the passed in Agent.
      • 

    • false: opts out of connection pooling with an Agent, defaults request to
Connection: close.
      • 

    

    • 



The optional callback parameter will be added as a one time listener for
the 'response' event.


http.request() returns an instance of the http.ClientRequest
class. The ClientRequest instance is a writable stream. If one needs to
upload a file with a POST request, then write to the ClientRequest object.


Example:


var postData = querystring.stringify({
  'msg' : 'Hello World!'
});

var options = {
  hostname: 'www.google.com',
  port: 80,
  path: '/upload',
  method: 'POST',
  headers: {
    'Content-Type': 'application/x-www-form-urlencoded',
    'Content-Length': Buffer.byteLength(postData)
  }
};

var req = http.request(options, (res) => {
  console.log(`STATUS: ${res.statusCode}`);
  console.log(`HEADERS: ${JSON.stringify(res.headers)}`);
  res.setEncoding('utf8');
  res.on('data', (chunk) => {
    console.log(`BODY: ${chunk}`);
  });
  res.on('end', () => {
    console.log('No more data in response.')
  })
});

req.on('error', (e) => {
  console.log(`problem with request: ${e.message}`);
});

// write data to request body
req.write(postData);
req.end();



Note that in the example req.end() was called. With http.request() one
must always call req.end() to signify that you're done with the request -
even if there is no data being written to the request body.


If any error is encountered during the request (be that with DNS resolution,
TCP level errors, or actual HTTP parse errors) an 'error' event is emitted
on the returned request object. As with all 'error' events, if no listeners
are registered the error will be thrown.


There are a few special headers that should be noted.


    

  • Sending a 'Connection: keep-alive' will notify Node.js that the connection to
the server should be persisted until the next request.
    

    • 

  • Sending a 'Content-Length' header will disable the default chunked encoding.
    

    • 

  • Sending an 'Expect' header will immediately send the request headers.
Usually, when sending 'Expect: 100-continue', you should both set a timeout
and listen for the 'continue' event. See RFC2616 Section 8.2.3 for more
information.
    

    • 

  • Sending an Authorization header will override using the auth option
to compute basic authentication.
    

    • 





HTTPS#


Stability: 2 - Stable
HTTPS is the HTTP protocol over TLS/SSL. In Node.js this is implemented as a
separate module.


Class: https.Agent#



Added in: v0.4.5

An Agent object for HTTPS similar to http.Agent.  See https.request()
for more information.


Class: https.Server#



Added in: v0.3.4

This class is a subclass of tls.Server and emits events same as
http.Server. See http.Server for more information.


server.setTimeout(msecs, callback)#



Added in: v0.11.2

See http.Server#setTimeout().


server.timeout#



Added in: v0.11.2

See http.Server#timeout.


https.createServer(options[, requestListener])#



Added in: v0.3.4

Returns a new HTTPS web server object. The options is similar to
tls.createServer().  The requestListener is a function which is
automatically added to the 'request' event.


Example:


// curl -k https://localhost:8000/
const https = require('https');
const fs = require('fs');

const options = {
  key: fs.readFileSync('test/fixtures/keys/agent2-key.pem'),
  cert: fs.readFileSync('test/fixtures/keys/agent2-cert.pem')
};

https.createServer(options, (req, res) => {
  res.writeHead(200);
  res.end('hello world\n');
}).listen(8000);



Or


const https = require('https');
const fs = require('fs');

const options = {
  pfx: fs.readFileSync('server.pfx')
};

https.createServer(options, (req, res) => {
  res.writeHead(200);
  res.end('hello world\n');
}).listen(8000);



server.close([callback])#



Added in: v0.1.90

See http.close() for details.


server.listen(handle[, callback])#


server.listen(path[, callback])#


server.listen(port[, host][, backlog][, callback])#


See http.listen() for details.


https.get(options, callback)#



Added in: v0.3.6

Like http.get() but for HTTPS.


options can be an object or a string. If options is a string, it is
automatically parsed with url.parse().


Example:


const https = require('https');

https.get('https://encrypted.google.com/', (res) => {
  console.log('statusCode:', res.statusCode);
  console.log('headers:', res.headers);

  res.on('data', (d) => {
    process.stdout.write(d);
  });

}).on('error', (e) => {
  console.error(e);
});



https.globalAgent#



Added in: v0.5.9

Global instance of https.Agent for all HTTPS client requests.


https.request(options, callback)#



Added in: v0.3.6

Makes a request to a secure web server.


options can be an object or a string. If options is a string, it is
automatically parsed with url.parse().


All options from http.request() are valid.


Example:


const https = require('https');

var options = {
  hostname: 'encrypted.google.com',
  port: 443,
  path: '/',
  method: 'GET'
};

var req = https.request(options, (res) => {
  console.log('statusCode:', res.statusCode);
  console.log('headers:', res.headers);

  res.on('data', (d) => {
    process.stdout.write(d);
  });
});

req.on('error', (e) => {
  console.error(e);
});
req.end();



The options argument has the following options


    

  • host: A domain name or IP address of the server to issue the request to.
Defaults to 'localhost'.
    • 

  • hostname: Alias for host. To support url.parse() hostname is
preferred over host.
    • 

  • family: IP address family to use when resolving host and hostname.
Valid values are 4 or 6. When unspecified, both IP v4 and v6 will be
used.
    • 

  • port: Port of remote server. Defaults to 443.
    • 

  • localAddress: Local interface to bind for network connections.
    • 

  • socketPath: Unix Domain Socket (use one of host:port or socketPath).
    • 

  • method: A string specifying the HTTP request method. Defaults to 'GET'.
    • 

  • path: Request path. Defaults to '/'. Should include query string if any.
E.G. '/index.html?page=12'. An exception is thrown when the request path
contains illegal characters. Currently, only spaces are rejected but that
may change in the future.
    • 

  • headers: An object containing request headers.
    • 

  • auth: Basic authentication i.e. 'user:password' to compute an
Authorization header.
    • 

  • agent: Controls Agent behavior. When an Agent is used request will
default to Connection: keep-alive. Possible values:
      

    • undefined (default): use globalAgent for this host and port.
      • 

    • Agent object: explicitly use the passed in Agent.
      • 

    • false: opts out of connection pooling with an Agent, defaults request to
Connection: close.
      • 

    

    • 



The following options from tls.connect() can also be specified:


    

  • pfx: Certificate, Private key and CA certificates to use for SSL. Default null.
    • 

  • key: Private key to use for SSL. Default null.
    • 

  • passphrase: A string of passphrase for the private key or pfx. Default null.
    • 

  • cert: Public x509 certificate to use. Default null.
    • 

  • ca: A string, Buffer or array of strings or Buffers of trusted
certificates in PEM format. If this is omitted several well known "root"
CAs will be used, like VeriSign. These are used to authorize connections.
    • 

  • ciphers: A string describing the ciphers to use or exclude. Consult
https://www.openssl.org/docs/apps/ciphers.html#CIPHER-LIST-FORMAT for
details on the format.
    • 

  • rejectUnauthorized: If true, the server certificate is verified against
the list of supplied CAs. An 'error' event is emitted if verification
fails. Verification happens at the connection level, before the HTTP
request is sent. Default true.
    • 

  • secureProtocol: The SSL method to use, e.g. SSLv3_method to force
SSL version 3. The possible values depend on your installation of
OpenSSL and are defined in the constant SSL_METHODS.
    • 

  • servername: Servername for SNI (Server Name Indication) TLS extension.
    • 



In order to specify these options, use a custom Agent.


Example:


var options = {
  hostname: 'encrypted.google.com',
  port: 443,
  path: '/',
  method: 'GET',
  key: fs.readFileSync('test/fixtures/keys/agent2-key.pem'),
  cert: fs.readFileSync('test/fixtures/keys/agent2-cert.pem')
};
options.agent = new https.Agent(options);

var req = https.request(options, (res) => {
  ...
}



Alternatively, opt out of connection pooling by not using an Agent.


Example:


var options = {
  hostname: 'encrypted.google.com',
  port: 443,
  path: '/',
  method: 'GET',
  key: fs.readFileSync('test/fixtures/keys/agent2-key.pem'),
  cert: fs.readFileSync('test/fixtures/keys/agent2-cert.pem'),
  agent: false
};

var req = https.request(options, (res) => {
  ...
}





Modules#


Stability: 3 - Locked


Node.js has a simple module loading system.  In Node.js, files and modules
are in one-to-one correspondence (each file is treated as a separate module).


As an example, consider a file named foo.js:


const circle = require('./circle.js');
console.log(`The area of a circle of radius 4 is ${circle.area(4)}`);



On the first line, foo.js loads the module circle.js that is in the same
directory as foo.js.


Here are the contents of circle.js:


const PI = Math.PI;

exports.area = (r) => PI * r * r;

exports.circumference = (r) => 2 * PI * r;



The module circle.js has exported the functions area() and
circumference().  To add functions and objects to the root of your module,
you can add them to the special exports object.


Variables local to the module will be private, because the module is wrapped
in a function by Node.js (see module wrapper).
In this example, the variable PI is private to circle.js.


If you want the root of your module's export to be a function (such as a
constructor) or if you want to export a complete object in one assignment
instead of building it one property at a time, assign it to module.exports
instead of exports.


Below, bar.js makes use of the square module, which exports a constructor:


const square = require('./square.js');
var mySquare = square(2);
console.log(`The area of my square is ${mySquare.area()}`);



The square module is defined in square.js:


// assigning to exports will not modify module, must use module.exports
module.exports = (width) => {
  return {
    area: () => width * width
  };
}



The module system is implemented in the require("module") module.


Accessing the main module#



When a file is run directly from Node.js, require.main is set to its
module. That means that you can determine whether a file has been run
directly by testing


require.main === module



For a file foo.js, this will be true if run via node foo.js, but
false if run by require('./foo').


Because module provides a filename property (normally equivalent to
__filename), the entry point of the current application can be obtained
by checking require.main.filename.


Addenda: Package Manager Tips#



The semantics of Node.js's require() function were designed to be general
enough to support a number of reasonable directory structures. Package manager
programs such as dpkg, rpm, and npm will hopefully find it possible to
build native packages from Node.js modules without modification.


Below we give a suggested directory structure that could work:


Let's say that we wanted to have the folder at
/usr/lib/node/<some-package>/<some-version> hold the contents of a
specific version of a package.


Packages can depend on one another. In order to install package foo, you
may have to install a specific version of package bar.  The bar package
may itself have dependencies, and in some cases, these dependencies may even
collide or form cycles.


Since Node.js looks up the realpath of any modules it loads (that is,
resolves symlinks), and then looks for their dependencies in the node_modules
folders as described here, this
situation is very simple to resolve with the following architecture:


    

  • /usr/lib/node/foo/1.2.3/ - Contents of the foo package, version 1.2.3.
    • 

  • /usr/lib/node/bar/4.3.2/ - Contents of the bar package that foo
depends on.
    • 

  • /usr/lib/node/foo/1.2.3/node_modules/bar - Symbolic link to
/usr/lib/node/bar/4.3.2/.
    • 

  • /usr/lib/node/bar/4.3.2/node_modules/* - Symbolic links to the packages
that bar depends on.
    • 



Thus, even if a cycle is encountered, or if there are dependency
conflicts, every module will be able to get a version of its dependency
that it can use.


When the code in the foo package does require('bar'), it will get the
version that is symlinked into /usr/lib/node/foo/1.2.3/node_modules/bar.
Then, when the code in the bar package calls require('quux'), it'll get
the version that is symlinked into
/usr/lib/node/bar/4.3.2/node_modules/quux.


Furthermore, to make the module lookup process even more optimal, rather
than putting packages directly in /usr/lib/node, we could put them in
/usr/lib/node_modules/<name>/<version>.  Then Node.js will not bother
looking for missing dependencies in /usr/node_modules or /node_modules.


In order to make modules available to the Node.js REPL, it might be useful to
also add the /usr/lib/node_modules folder to the $NODE_PATH environment
variable.  Since the module lookups using node_modules folders are all
relative, and based on the real path of the files making the calls to
require(), the packages themselves can be anywhere.


All Together...#



To get the exact filename that will be loaded when require() is called, use
the require.resolve() function.


Putting together all of the above, here is the high-level algorithm
in pseudocode of what require.resolve does:


require(X) from module at path Y
1. If X is a core module,
   a. return the core module
   b. STOP
2. If X begins with './' or '/' or '../'
   a. LOAD_AS_FILE(Y + X)
   b. LOAD_AS_DIRECTORY(Y + X)
3. LOAD_NODE_MODULES(X, dirname(Y))
4. THROW "not found"

LOAD_AS_FILE(X)
1. If X is a file, load X as JavaScript text.  STOP
2. If X.js is a file, load X.js as JavaScript text.  STOP
3. If X.json is a file, parse X.json to a JavaScript Object.  STOP
4. If X.node is a file, load X.node as binary addon.  STOP

LOAD_AS_DIRECTORY(X)
1. If X/package.json is a file,
   a. Parse X/package.json, and look for "main" field.
   b. let M = X + (json main field)
   c. LOAD_AS_FILE(M)
2. If X/index.js is a file, load X/index.js as JavaScript text.  STOP
3. If X/index.json is a file, parse X/index.json to a JavaScript object. STOP
4. If X/index.node is a file, load X/index.node as binary addon.  STOP

LOAD_NODE_MODULES(X, START)
1. let DIRS=NODE_MODULES_PATHS(START)
2. for each DIR in DIRS:
   a. LOAD_AS_FILE(DIR/X)
   b. LOAD_AS_DIRECTORY(DIR/X)

NODE_MODULES_PATHS(START)
1. let PARTS = path split(START)
2. let I = count of PARTS - 1
3. let DIRS = []
4. while I >= 0,
   a. if PARTS[I] = "node_modules" CONTINUE
   b. DIR = path join(PARTS[0 .. I] + "node_modules")
   c. DIRS = DIRS + DIR
   d. let I = I - 1
5. return DIRS

Caching#



Modules are cached after the first time they are loaded.  This means
(among other things) that every call to require('foo') will get
exactly the same object returned, if it would resolve to the same file.


Multiple calls to require('foo') may not cause the module code to be
executed multiple times.  This is an important feature.  With it,
"partially done" objects can be returned, thus allowing transitive
dependencies to be loaded even when they would cause cycles.


If you want to have a module execute code multiple times, then export a
function, and call that function.


Module Caching Caveats#



Modules are cached based on their resolved filename.  Since modules may
resolve to a different filename based on the location of the calling
module (loading from node_modules folders), it is not a guarantee
that require('foo') will always return the exact same object, if it
would resolve to different files.


Additionally, on case-insensitive file systems or operating systems, different
resolved filenames can point to the same file, but the cache will still treat
them as different modules and will reload the file multiple times. For example,
require('./foo') and require('./FOO') return two different objects,
irrespective of whether or not ./foo and ./FOO are the same file.


Core Modules#



Node.js has several modules compiled into the binary.  These modules are
described in greater detail elsewhere in this documentation.


The core modules are defined within Node.js's source and are located in the
lib/ folder.


Core modules are always preferentially loaded if their identifier is
passed to require().  For instance, require('http') will always
return the built in HTTP module, even if there is a file by that name.


Cycles#



When there are circular require() calls, a module might not have finished
executing when it is returned.


Consider this situation:


a.js:


console.log('a starting');
exports.done = false;
const b = require('./b.js');
console.log('in a, b.done = %j', b.done);
exports.done = true;
console.log('a done');

b.js:


console.log('b starting');
exports.done = false;
const a = require('./a.js');
console.log('in b, a.done = %j', a.done);
exports.done = true;
console.log('b done');

main.js:


console.log('main starting');
const a = require('./a.js');
const b = require('./b.js');
console.log('in main, a.done=%j, b.done=%j', a.done, b.done);

When main.js loads a.js, then a.js in turn loads b.js.  At that
point, b.js tries to load a.js.  In order to prevent an infinite
loop, an unfinished copy of the a.js exports object is returned to the
b.js module.  b.js then finishes loading, and its exports object is
provided to the a.js module.


By the time main.js has loaded both modules, they're both finished.
The output of this program would thus be:


$ node main.js
main starting
a starting
b starting
in b, a.done = false
b done
in a, b.done = true
a done
in main, a.done=true, b.done=true

If you have cyclic module dependencies in your program, make sure to
plan accordingly.


File Modules#



If the exact filename is not found, then Node.js will attempt to load the
required filename with the added extensions: .js, .json, and finally
.node.


.js files are interpreted as JavaScript text files, and .json files are
parsed as JSON text files. .node files are interpreted as compiled addon
modules loaded with dlopen.


A required module prefixed with '/' is an absolute path to the file.  For
example, require('/home/marco/foo.js') will load the file at
/home/marco/foo.js.


A required module prefixed with './' is relative to the file calling
require(). That is, circle.js must be in the same directory as foo.js for
require('./circle') to find it.


Without a leading '/', './', or '../' to indicate a file, the module must
either be a core module or is loaded from a node_modules folder.


If the given path does not exist, require() will throw an Error with its
code property set to 'MODULE_NOT_FOUND'.


Folders as Modules#



It is convenient to organize programs and libraries into self-contained
directories, and then provide a single entry point to that library.
There are three ways in which a folder may be passed to require() as
an argument.


The first is to create a package.json file in the root of the folder,
which specifies a main module.  An example package.json file might
look like this:


{ "name" : "some-library",
  "main" : "./lib/some-library.js" }

If this was in a folder at ./some-library, then
require('./some-library') would attempt to load
./some-library/lib/some-library.js.


This is the extent of Node.js's awareness of package.json files.


Note: If the file specified by the "main" entry of package.json is missing
and can not be resolved, Node.js will report the entire module as missing with
the default error:


Error: Cannot find module 'some-library'

If there is no package.json file present in the directory, then Node.js
will attempt to load an index.js or index.node file out of that
directory.  For example, if there was no package.json file in the above
example, then require('./some-library') would attempt to load:


    

  • ./some-library/index.js
    • 

  • ./some-library/index.node
    • 



Loading from node_modules Folders#



If the module identifier passed to require() is not a
core module, and does not begin with '/', '../', or
'./', then Node.js starts at the parent directory of the current module, and
adds /node_modules, and attempts to load the module from that location. Node
will not append node_modules to a path already ending in node_modules.


If it is not found there, then it moves to the parent directory, and so
on, until the root of the file system is reached.


For example, if the file at '/home/ry/projects/foo.js' called
require('bar.js'), then Node.js would look in the following locations, in
this order:


    

  • /home/ry/projects/node_modules/bar.js
    • 

  • /home/ry/node_modules/bar.js
    • 

  • /home/node_modules/bar.js
    • 

  • /node_modules/bar.js
    • 



This allows programs to localize their dependencies, so that they do not
clash.


You can require specific files or sub modules distributed with a module by
including a path suffix after the module name. For instance
require('example-module/path/to/file') would resolve path/to/file
relative to where example-module is located. The suffixed path follows the
same module resolution semantics.


Loading from the global folders#



If the NODE_PATH environment variable is set to a colon-delimited list
of absolute paths, then Node.js will search those paths for modules if they
are not found elsewhere.  (Note: On Windows, NODE_PATH is delimited by
semicolons instead of colons.)


NODE_PATH was originally created to support loading modules from
varying paths before the current module resolution algorithm was frozen.


NODE_PATH is still supported, but is less necessary now that the Node.js
ecosystem has settled on a convention for locating dependent modules.
Sometimes deployments that rely on NODE_PATH show surprising behavior
when people are unaware that NODE_PATH must be set.  Sometimes a
module's dependencies change, causing a different version (or even a
different module) to be loaded as the NODE_PATH is searched.


Additionally, Node.js will search in the following locations:


    

  • 1: $HOME/.node_modules
    • 

  • 2: $HOME/.node_libraries
    • 

  • 3: $PREFIX/lib/node
    • 



Where $HOME is the user's home directory, and $PREFIX is Node.js's
configured node_prefix.


These are mostly for historic reasons.  You are highly encouraged
to place your dependencies locally in node_modules folders.  They
will be loaded faster, and more reliably.


The module wrapper#



Before a module's code is executed, Node.js will wrap it with a function
wrapper that looks like the following:


(function (exports, require, module, __filename, __dirname) {
// Your module code actually lives in here
});



By doing this, Node.js achieves a few things:


    

  • It keeps top-level variables (defined with var, const or let) scoped to
the module rather than the global object.
    • 

  • It helps to provide some global-looking variables that are actually specific
to the module, such as:
      

    • The module and exports objects that the implementor can use to export
values from the module.
      • 

    • The convenience variables __filename and __dirname, containing the
module's absolute filename and directory path.
      • 

    

    • 



The module Object#



Added in: v0.1.16





In each module, the module free variable is a reference to the object
representing the current module.  For convenience, module.exports is
also accessible via the exports module-global. module isn't actually
a global but rather local to each module.


module.children#



Added in: v0.1.16



The module objects required by this one.


module.exports#



Added in: v0.1.16



The module.exports object is created by the Module system. Sometimes this is
not acceptable; many want their module to be an instance of some class. To do
this, assign the desired export object to module.exports. Note that assigning
the desired object to exports will simply rebind the local exports variable,
which is probably not what you want to do.


For example suppose we were making a module called a.js


const EventEmitter = require('events');

module.exports = new EventEmitter();

// Do some work, and after some time emit
// the 'ready' event from the module itself.
setTimeout(() => {
  module.exports.emit('ready');
}, 1000);



Then in another file we could do


const a = require('./a');
a.on('ready', () => {
  console.log('module a is ready');
});



Note that assignment to module.exports must be done immediately. It cannot be
done in any callbacks.  This does not work:


x.js:


setTimeout(() => {
  module.exports = { a: 'hello' };
}, 0);



y.js:


const x = require('./x');
console.log(x.a);



exports shortcut#



Added in: v0.1.16

The exports variable is available within a module's file-level scope, and is
assigned the value of module.exports before the module is evaluated.


It allows a shortcut, so that module.exports.f = ... can be written more
succinctly as exports.f = .... However, be aware that like any variable, if a
new value is assigned to exports, it is no longer bound to module.exports:


module.exports.hello = true; // Exported from require of module
exports = { hello: false };  // Not exported, only available in the module



When the module.exports property is being completely replaced by a new
object, it is common to also reassign exports, for example:


module.exports = exports = function Constructor() {
    // ... etc.



To illustrate the behavior, imagine this hypothetical implementation of
require(), which is quite similar to what is actually done by require():


function require(...) {
  var module = { exports: {} };
  ((module, exports) => {
    // Your module code here. In this example, define a function.
    function some_func() {};
    exports = some_func;
    // At this point, exports is no longer a shortcut to module.exports, and
    // this module will still export an empty default object.
    module.exports = some_func;
    // At this point, the module will now export some_func, instead of the
    // default object.
  })(module, module.exports);
  return module.exports;
}



module.filename#



Added in: v0.1.16



The fully resolved filename to the module.


module.id#



Added in: v0.1.16



The identifier for the module.  Typically this is the fully resolved
filename.


module.loaded#



Added in: v0.1.16



Whether or not the module is done loading, or is in the process of
loading.


module.parent#



Added in: v0.1.16



The module that first required this one.


module.require(id)#



Added in: v0.5.1



The module.require method provides a way to load a module as if
require() was called from the original module.


Note that in order to do this, you must get a reference to the module
object.  Since require() returns the module.exports, and the module is
typically only available within a specific module's code, it must be
explicitly exported in order to be used.




Net#


Stability: 2 - Stable
The net module provides you with an asynchronous network wrapper. It contains
functions for creating both servers and clients (called streams). You can include
this module with require('net');.


Class: net.Server#



Added in: v0.1.90

This class is used to create a TCP or local server.


net.Server is an EventEmitter with the following events:


Event: 'close'#



Added in: v0.5.0

Emitted when the server closes. Note that if connections exist, this
event is not emitted until all connections are ended.


Event: 'connection'#



Added in: v0.1.90



Emitted when a new connection is made. socket is an instance of
net.Socket.


Event: 'error'#



Added in: v0.1.90



Emitted when an error occurs. Unlike net.Socket, the 'close'
event will not be emitted directly following this event unless
server.close() is manually called. See the example in discussion of
server.listen().


Event: 'listening'#



Added in: v0.1.90

Emitted when the server has been bound after calling server.listen.


server.address()#



Added in: v0.1.90

Returns the bound address, the address family name, and port of the server
as reported by the operating system.
Useful to find which port was assigned when getting an OS-assigned address.
Returns an object with port, family, and address properties:
{ port: 12346, family: 'IPv4', address: '127.0.0.1' }


Example:


var server = net.createServer((socket) => {
  socket.end('goodbye\n');
}).on('error', (err) => {
  // handle errors here
  throw err;
});

// grab a random port.
server.listen(() => {
  console.log('opened server on', server.address());
});



Don't call server.address() until the 'listening' event has been emitted.


server.close([callback])#



Added in: v0.1.90

Stops the server from accepting new connections and keeps existing
connections. This function is asynchronous, the server is finally
closed when all connections are ended and the server emits a 'close' event.
The optional callback will be called once the 'close' event occurs. Unlike
that event, it will be called with an Error as its only argument if the server
was not open when it was closed.


server.connections#



Added in: v0.2.0
Deprecated since: v0.9.7 

Stability: 0 - Deprecated: Use server.getConnections() instead.
The number of concurrent connections on the server.


This becomes null when sending a socket to a child with
child_process.fork(). To poll forks and get current number of active
connections use asynchronous server.getConnections instead.


server.getConnections(callback)#



Added in: v0.9.7

Asynchronously get the number of concurrent connections on the server. Works
when sockets were sent to forks.


Callback should take two arguments err and count.


server.listen(handle[, backlog][, callback])#



Added in: v0.5.10



The handle object can be set to either a server or socket (anything
with an underlying _handle member), or a {fd: <n>} object.


This will cause the server to accept connections on the specified
handle, but it is presumed that the file descriptor or handle has
already been bound to a port or domain socket.


Listening on a file descriptor is not supported on Windows.


This function is asynchronous.  When the server has been bound,
'listening' event will be emitted.
The last parameter callback will be added as a listener for the
'listening' event.


The parameter backlog behaves the same as in
server.listen([port][, hostname][, backlog][, callback]).


server.listen(options[, callback])#



Added in: v0.11.14



The port, host, and backlog properties of options, as well as the
optional callback function, behave as they do on a call to
server.listen([port][, hostname][, backlog][, callback]).
Alternatively, the path option can be used to specify a UNIX socket.


If exclusive is false (default), then cluster workers will use the same
underlying handle, allowing connection handling duties to be shared. When
exclusive is true, the handle is not shared, and attempted port sharing
results in an error. An example which listens on an exclusive port is
shown below.


server.listen({
  host: 'localhost',
  port: 80,
  exclusive: true
});



server.listen(path[, backlog][, callback])#



Added in: v0.1.90



Start a local socket server listening for connections on the given path.


This function is asynchronous.  When the server has been bound,
'listening' event will be emitted.  The last parameter callback
will be added as a listener for the 'listening' event.


On UNIX, the local domain is usually known as the UNIX domain. The path is a
filesystem path name. It gets truncated to sizeof(sockaddr_un.sun_path)
bytes, decreased by 1. It varies on different operating system between 91 and
107 bytes. The typical values are 107 on Linux and 103 on OS X. The path is
subject to the same naming conventions and permissions checks as would be done
on file creation, will be visible in the filesystem, and will persist until
unlinked.


On Windows, the local domain is implemented using a named pipe. The path must
refer to an entry in \\?\pipe\ or \\.\pipe\. Any characters are permitted,
but the latter may do some processing of pipe names, such as resolving ..
sequences. Despite appearances, the pipe name space is flat.  Pipes will not
persist, they are removed when the last reference to them is closed. Do not
forget JavaScript string escaping requires paths to be specified with
double-backslashes, such as:


net.createServer().listen(
    path.join('\\\\?\\pipe', process.cwd(), 'myctl'))

The parameter backlog behaves the same as in
server.listen([port][, hostname][, backlog][, callback]).


server.listen([port][, hostname][, backlog][, callback])#



Added in: v0.1.90

Begin accepting connections on the specified port and hostname. If the
hostname is omitted, the server will accept connections on any IPv6 address
(::) when IPv6 is available, or any IPv4 address (0.0.0.0) otherwise.
Omit the port argument, or use a port value of 0, to have the operating system
assign a random port, which can be retrieved by using server.address().port
after the 'listening' event has been emitted.


Backlog is the maximum length of the queue of pending connections.
The actual length will be determined by the OS through sysctl settings such as
tcp_max_syn_backlog and somaxconn on Linux. The default value of this
parameter is 511 (not 512).


This function is asynchronous.  When the server has been bound,
'listening' event will be emitted.  The last parameter callback
will be added as a listener for the 'listening' event.


One issue some users run into is getting EADDRINUSE errors. This means that
another server is already running on the requested port. One way of handling this
would be to wait a second and then try again:


server.on('error', (e) => {
  if (e.code == 'EADDRINUSE') {
    console.log('Address in use, retrying...');
    setTimeout(() => {
      server.close();
      server.listen(PORT, HOST);
    }, 1000);
  }
});



(Note: All sockets in Node.js are set SO_REUSEADDR.)


server.maxConnections#



Added in: v0.2.0

Set this property to reject connections when the server's connection count gets
high.


It is not recommended to use this option once a socket has been sent to a child
with child_process.fork().


server.ref()#



Added in: v0.9.1

Opposite of unref, calling ref on a previously unrefd server will not
let the program exit if it's the only server left (the default behavior). If
the server is refd calling ref again will have no effect.


Returns server.


server.unref()#



Added in: v0.9.1

Calling unref on a server will allow the program to exit if this is the only
active server in the event system. If the server is already unrefd calling
unref again will have no effect.


Returns server.


Class: net.Socket#



Added in: v0.3.4

This object is an abstraction of a TCP or local socket.  net.Socket
instances implement a duplex Stream interface.  They can be created by the
user and used as a client (with connect()) or they can be created by Node.js
and passed to the user through the 'connection' event of a server.


new net.Socket(options)#



Added in: v0.3.4

Construct a new socket object.


options is an object with the following defaults:


{
  fd: null,
  allowHalfOpen: false,
  readable: false,
  writable: false
}



fd allows you to specify the existing file descriptor of socket.
Set readable and/or writable to true to allow reads and/or writes on this
socket (NOTE: Works only when fd is passed).
About allowHalfOpen, refer to createServer() and 'end' event.


net.Socket instances are EventEmitter with the following events:


Event: 'close'#



Added in: v0.1.90

    

  • had_error <Boolean> true if the socket had a transmission error.
    • 



Emitted once the socket is fully closed. The argument had_error is a boolean
which says if the socket was closed due to a transmission error.


Event: 'connect'#



Added in: v0.1.90

Emitted when a socket connection is successfully established.
See connect().


Event: 'data'#



Added in: v0.1.90



Emitted when data is received.  The argument data will be a Buffer or
String.  Encoding of data is set by socket.setEncoding().
(See the Readable Stream section for more information.)


Note that the data will be lost if there is no listener when a Socket
emits a 'data' event.


Event: 'drain'#



Added in: v0.1.90

Emitted when the write buffer becomes empty. Can be used to throttle uploads.


See also: the return values of socket.write()


Event: 'end'#



Added in: v0.1.90

Emitted when the other end of the socket sends a FIN packet.


By default (allowHalfOpen == false) the socket will destroy its file
descriptor  once it has written out its pending write queue.  However, by
setting allowHalfOpen == true the socket will not automatically end()
its side allowing the user to write arbitrary amounts of data, with the
caveat that the user is required to end() their side now.


Event: 'error'#



Added in: v0.1.90



Emitted when an error occurs.  The 'close' event will be called directly
following this event.


Event: 'lookup'#



Added in: v0.11.3

Emitted after resolving the hostname but before connecting.
Not applicable to UNIX sockets.



Event: 'timeout'#



Added in: v0.1.90

Emitted if the socket times out from inactivity. This is only to notify that
the socket has been idle. The user must manually close the connection.


See also: socket.setTimeout()


socket.address()#



Added in: v0.1.90

Returns the bound address, the address family name and port of the
socket as reported by the operating system. Returns an object with
three properties, e.g.
{ port: 12346, family: 'IPv4', address: '127.0.0.1' }


socket.bufferSize#



Added in: v0.3.8

net.Socket has the property that socket.write() always works. This is to
help users get up and running quickly. The computer cannot always keep up
with the amount of data that is written to a socket - the network connection
simply might be too slow. Node.js will internally queue up the data written to a
socket and send it out over the wire when it is possible. (Internally it is
polling on the socket's file descriptor for being writable).


The consequence of this internal buffering is that memory may grow. This
property shows the number of characters currently buffered to be written.
(Number of characters is approximately equal to the number of bytes to be
written, but the buffer may contain strings, and the strings are lazily
encoded, so the exact number of bytes is not known.)


Users who experience large or growing bufferSize should attempt to
"throttle" the data flows in their program with pause() and resume().


socket.bytesRead#



Added in: v0.5.3

The amount of received bytes.


socket.bytesWritten#



Added in: v0.5.3

The amount of bytes sent.


socket.connect(options[, connectListener])#



Added in: v0.1.90

Opens the connection for a given socket.


For TCP sockets, options argument should be an object which specifies:


    

  • port: Port the client should connect to (Required).
    

    • 

  • host: Host the client should connect to. Defaults to 'localhost'.
    

    • 

  • localAddress: Local interface to bind to for network connections.
    

    • 

  • localPort: Local port to bind to for network connections.
    

    • 

  • family : Version of IP stack. Defaults to 4.
    

    • 

  • lookup : Custom lookup function. Defaults to dns.lookup.
    

    • 



For local domain sockets, options argument should be an object which
specifies:


    

  • path: Path the client should connect to (Required).
    • 



Normally this method is not needed, as net.createConnection opens the
socket. Use this only if you are implementing a custom Socket.


This function is asynchronous. When the 'connect' event is emitted the
socket is established. If there is a problem connecting, the 'connect' event
will not be emitted, the 'error' event will be emitted with the exception.


The connectListener parameter will be added as a listener for the
'connect' event.


socket.connect(path[, connectListener])#


socket.connect(port[, host][, connectListener])#



Added in: v0.1.90

As socket.connect(options\[, connectListener\]),
with options either as either {port: port, host: host} or {path: path}.


socket.destroy()#



Added in: v0.1.90

Ensures that no more I/O activity happens on this socket. Only necessary in
case of errors (parse error or so).


socket.destroyed#


A Boolean value that indicates if the connection is destroyed or not. Once a
connection is destroyed no further data can be transferred using it.


socket.end([data][, encoding])#



Added in: v0.1.90

Half-closes the socket. i.e., it sends a FIN packet. It is possible the
server will still send some data.


If data is specified, it is equivalent to calling
socket.write(data, encoding) followed by socket.end().


socket.localAddress#



Added in: v0.9.6

The string representation of the local IP address the remote client is
connecting on. For example, if you are listening on '0.0.0.0' and the
client connects on '192.168.1.1', the value would be '192.168.1.1'.


socket.localPort#



Added in: v0.9.6

The numeric representation of the local port. For example,
80 or 21.


socket.pause()#


Pauses the reading of data. That is, 'data' events will not be emitted.
Useful to throttle back an upload.


socket.ref()#



Added in: v0.9.1

Opposite of unref, calling ref on a previously unrefd socket will not
let the program exit if it's the only socket left (the default behavior). If
the socket is refd calling ref again will have no effect.


Returns socket.


socket.remoteAddress#



Added in: v0.5.10

The string representation of the remote IP address. For example,
'74.125.127.100' or '2001:4860:a005::68'. Value may be undefined if
the socket is destroyed (for example, if the client disconnected).


socket.remoteFamily#



Added in: v0.11.14

The string representation of the remote IP family. 'IPv4' or 'IPv6'.


socket.remotePort#



Added in: v0.5.10

The numeric representation of the remote port. For example,
80 or 21.


socket.resume()#


Resumes reading after a call to pause().


socket.setEncoding([encoding])#



Added in: v0.1.90

Set the encoding for the socket as a Readable Stream. See
stream.setEncoding() for more information.


socket.setKeepAlive([enable][, initialDelay])#



Added in: v0.1.92

Enable/disable keep-alive functionality, and optionally set the initial
delay before the first keepalive probe is sent on an idle socket.
enable defaults to false.


Set initialDelay (in milliseconds) to set the delay between the last
data packet received and the first keepalive probe. Setting 0 for
initialDelay will leave the value unchanged from the default
(or previous) setting. Defaults to 0.


Returns socket.


socket.setNoDelay([noDelay])#



Added in: v0.1.90

Disables the Nagle algorithm. By default TCP connections use the Nagle
algorithm, they buffer data before sending it off. Setting true for
noDelay will immediately fire off data each time socket.write() is called.
noDelay defaults to true.


Returns socket.


socket.setTimeout(timeout[, callback])#



Added in: v0.1.90

Sets the socket to timeout after timeout milliseconds of inactivity on
the socket. By default net.Socket do not have a timeout.


When an idle timeout is triggered the socket will receive a 'timeout'
event but the connection will not be severed. The user must manually end()
or destroy() the socket.


If timeout is 0, then the existing idle timeout is disabled.


The optional callback parameter will be added as a one time listener for the
'timeout' event.


Returns socket.


socket.unref()#



Added in: v0.9.1

Calling unref on a socket will allow the program to exit if this is the only
active socket in the event system. If the socket is already unrefd calling
unref again will have no effect.


Returns socket.


socket.write(data[, encoding][, callback])#



Added in: v0.1.90

Sends data on the socket. The second parameter specifies the encoding in the
case of a string--it defaults to UTF8 encoding.


Returns true if the entire data was flushed successfully to the kernel
buffer. Returns false if all or part of the data was queued in user memory.
'drain' will be emitted when the buffer is again free.


The optional callback parameter will be executed when the data is finally
written out - this may not be immediately.


net.connect(options[, connectListener])#



Added in: v0.7.0

A factory function, which returns a new net.Socket and automatically
connects with the supplied options.


The options are passed to both the net.Socket constructor and the
socket.connect method.


The connectListener parameter will be added as a listener for the
'connect' event once.


Here is an example of a client of the previously described echo server:


const net = require('net');
const client = net.connect({port: 8124}, () => {
  // 'connect' listener
  console.log('connected to server!');
  client.write('world!\r\n');
});
client.on('data', (data) => {
  console.log(data.toString());
  client.end();
});
client.on('end', () => {
  console.log('disconnected from server');
});



To connect on the socket /tmp/echo.sock the second line would just be
changed to


const client = net.connect({path: '/tmp/echo.sock'});



net.connect(path[, connectListener])#



Added in: v0.1.90

A factory function, which returns a new unix net.Socket and automatically
connects to the supplied path.


The connectListener parameter will be added as a listener for the
'connect' event once.


net.connect(port[, host][, connectListener])#



Added in: v0.1.90

A factory function, which returns a new net.Socket and automatically
connects to the supplied port and host.


If host is omitted, 'localhost' will be assumed.


The connectListener parameter will be added as a listener for the
'connect' event once.


net.createConnection(options[, connectListener])#



Added in: v0.1.90

A factory function, which returns a new net.Socket and automatically
connects with the supplied options.


The options are passed to both the net.Socket constructor and the
socket.connect method.


The connectListener parameter will be added as a listener for the
'connect' event once.


Here is an example of a client of the previously described echo server:


const net = require('net');
const client = net.createConnection({port: 8124}, () => {
  //'connect' listener
  console.log('connected to server!');
  client.write('world!\r\n');
});
client.on('data', (data) => {
  console.log(data.toString());
  client.end();
});
client.on('end', () => {
  console.log('disconnected from server');
});



To connect on the socket /tmp/echo.sock the second line would just be
changed to


const client = net.connect({path: '/tmp/echo.sock'});



net.createConnection(path[, connectListener])#



Added in: v0.1.90

A factory function, which returns a new unix net.Socket and automatically
connects to the supplied path.


The connectListener parameter will be added as a listener for the
'connect' event once.


net.createConnection(port[, host][, connectListener])#



Added in: v0.1.90

A factory function, which returns a new net.Socket and automatically
connects to the supplied port and host.


If host is omitted, 'localhost' will be assumed.


The connectListener parameter will be added as a listener for the
'connect' event once.


net.createServer([options][, connectionListener])#



Added in: v0.5.0

Creates a new server. The connectionListener argument is
automatically set as a listener for the 'connection' event.


options is an object with the following defaults:


{
  allowHalfOpen: false,
  pauseOnConnect: false
}



If allowHalfOpen is true, then the socket won't automatically send a FIN
packet when the other end of the socket sends a FIN packet. The socket becomes
non-readable, but still writable. You should call the end() method explicitly.
See 'end' event for more information.


If pauseOnConnect is true, then the socket associated with each incoming
connection will be paused, and no data will be read from its handle. This allows
connections to be passed between processes without any data being read by the
original process. To begin reading data from a paused socket, call resume().


Here is an example of an echo server which listens for connections
on port 8124:


const net = require('net');
const server = net.createServer((c) => {
  // 'connection' listener
  console.log('client connected');
  c.on('end', () => {
    console.log('client disconnected');
  });
  c.write('hello\r\n');
  c.pipe(c);
});
server.on('error', (err) => {
  throw err;
});
server.listen(8124, () => {
  console.log('server bound');
});



Test this by using telnet:


telnet localhost 8124

To listen on the socket /tmp/echo.sock the third line from the last would
just be changed to


server.listen('/tmp/echo.sock', () => {
  console.log('server bound');
});



Use nc to connect to a UNIX domain socket server:


nc -U /tmp/echo.sock



net.isIP(input)#



Added in: v0.3.0

Tests if input is an IP address. Returns 0 for invalid strings,
returns 4 for IP version 4 addresses, and returns 6 for IP version 6 addresses.


net.isIPv4(input)#



Added in: v0.3.0

Returns true if input is a version 4 IP address, otherwise returns false.


net.isIPv6(input)#



Added in: v0.3.0

Returns true if input is a version 6 IP address, otherwise returns false.




OS#


Stability: 2 - Stable
Provides a few basic operating-system related utility functions.


Use require('os') to access this module.


os.EOL#



Added in: v0.7.8

A constant defining the appropriate End-of-line marker for the operating
system.


os.arch()#



Added in: v0.5.0

Returns the operating system CPU architecture. Possible values are 'x64',
'arm' and 'ia32'. Returns the value of process.arch.


os.cpus()#



Added in: v0.3.3

Returns an array of objects containing information about each CPU/core
installed: model, speed (in MHz), and times (an object containing the number of
milliseconds the CPU/core spent in: user, nice, sys, idle, and irq).


Example inspection of os.cpus:


[ { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',
    speed: 2926,
    times:
     { user: 252020,
       nice: 0,
       sys: 30340,
       idle: 1070356870,
       irq: 0 } },
  { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',
    speed: 2926,
    times:
     { user: 306960,
       nice: 0,
       sys: 26980,
       idle: 1071569080,
       irq: 0 } },
  { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',
    speed: 2926,
    times:
     { user: 248450,
       nice: 0,
       sys: 21750,
       idle: 1070919370,
       irq: 0 } },
  { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',
    speed: 2926,
    times:
     { user: 256880,
       nice: 0,
       sys: 19430,
       idle: 1070905480,
       irq: 20 } },
  { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',
    speed: 2926,
    times:
     { user: 511580,
       nice: 20,
       sys: 40900,
       idle: 1070842510,
       irq: 0 } },
  { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',
    speed: 2926,
    times:
     { user: 291660,
       nice: 0,
       sys: 34360,
       idle: 1070888000,
       irq: 10 } },
  { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',
    speed: 2926,
    times:
     { user: 308260,
       nice: 0,
       sys: 55410,
       idle: 1071129970,
       irq: 880 } },
  { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',
    speed: 2926,
    times:
     { user: 266450,
       nice: 1480,
       sys: 34920,
       idle: 1072572010,
       irq: 30 } } ]



Note that since nice values are UNIX centric in Windows the nice values of
all processors are always 0.


os.endianness()#



Added in: v0.9.4

Returns the endianness of the CPU. Possible values are 'BE' for big endian
or 'LE' for little endian.


os.freemem()#



Added in: v0.3.3

Returns the amount of free system memory in bytes.


os.homedir()#



Added in: v2.3.0

Returns the home directory of the current user.


os.hostname()#



Added in: v0.3.3

Returns the hostname of the operating system.


os.loadavg()#



Added in: v0.3.3

Returns an array containing the 1, 5, and 15 minute load averages.


The load average is a measure of system activity, calculated by the operating
system and expressed as a fractional number.  As a rule of thumb, the load
average should ideally be less than the number of logical CPUs in the system.


The load average is a very UNIX-y concept; there is no real equivalent on
Windows platforms.  That is why this function always returns [0, 0, 0] on
Windows.


os.networkInterfaces()#



Added in: v0.6.0

Get a list of network interfaces:


{ lo:
   [ { address: '127.0.0.1',
       netmask: '255.0.0.0',
       family: 'IPv4',
       mac: '00:00:00:00:00:00',
       internal: true },
     { address: '::1',
       netmask: 'ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff',
       family: 'IPv6',
       mac: '00:00:00:00:00:00',
       internal: true } ],
  eth0:
   [ { address: '192.168.1.108',
       netmask: '255.255.255.0',
       family: 'IPv4',
       mac: '01:02:03:0a:0b:0c',
       internal: false },
     { address: 'fe80::a00:27ff:fe4e:66a1',
       netmask: 'ffff:ffff:ffff:ffff::',
       family: 'IPv6',
       mac: '01:02:03:0a:0b:0c',
       internal: false } ] }



Note that due to the underlying implementation this will only return network
interfaces that have been assigned an address.


os.platform()#



Added in: v0.5.0

Returns the operating system platform. Possible values are 'darwin',
'freebsd', 'linux', 'sunos' or 'win32'. Returns the value of
process.platform.


os.release()#



Added in: v0.3.3

Returns the operating system release.


os.tmpdir()#



Added in: v0.9.9

Returns the operating system's default directory for temporary files.


os.totalmem()#



Added in: v0.3.3

Returns the total amount of system memory in bytes.


os.type()#



Added in: v0.3.3

Returns the operating system name. For example 'Linux' on Linux, 'Darwin'
on OS X and 'Windows_NT' on Windows.


os.uptime()#



Added in: v0.3.3

Returns the system uptime in seconds.




Path#


Stability: 2 - Stable
This module contains utilities for handling and transforming file
paths.  Almost all these methods perform only string transformations.
The file system is not consulted to check whether paths are valid.


Use require('path') to use this module.  The following methods are provided:


path.basename(p[, ext])#



Added in: v0.1.25

Return the last portion of a path.  Similar to the Unix basename command.


Example:


path.basename('/foo/bar/baz/asdf/quux.html')
// returns 'quux.html'

path.basename('/foo/bar/baz/asdf/quux.html', '.html')
// returns 'quux'



path.delimiter#



Added in: v0.9.3

The platform-specific path delimiter, ; or ':'.


An example on *nix:


console.log(process.env.PATH)
// '/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin'

process.env.PATH.split(path.delimiter)
// returns ['/usr/bin', '/bin', '/usr/sbin', '/sbin', '/usr/local/bin']



An example on Windows:


console.log(process.env.PATH)
// 'C:\Windows\system32;C:\Windows;C:\Program Files\node\'

process.env.PATH.split(path.delimiter)
// returns ['C:\\Windows\\system32', 'C:\\Windows', 'C:\\Program Files\\node\\']



path.dirname(p)#



Added in: v0.1.16

Return the directory name of a path.  Similar to the Unix dirname command.


Example:


path.dirname('/foo/bar/baz/asdf/quux')
// returns '/foo/bar/baz/asdf'



path.extname(p)#



Added in: v0.1.25

Return the extension of the path, from the last '.' to end of string
in the last portion of the path.  If there is no '.' in the last portion
of the path or the first character of it is '.', then it returns
an empty string.  Examples:


path.extname('index.html')
// returns '.html'

path.extname('index.coffee.md')
// returns '.md'

path.extname('index.')
// returns '.'

path.extname('index')
// returns ''

path.extname('.index')
// returns ''



path.format(pathObject)#



Added in: v0.11.15

Returns a path string from an object, the opposite of path.parse.


Examples:


Some Posix system examples:


// If `dir` and `base` are provided, `dir` + platform separator + `base`
// will be returned.
path.format({
    dir: '/home/user/dir',
    base: 'file.txt'
});
// returns '/home/user/dir/file.txt'

// `base` will be returned if `dir` or `root` are not provided.
path.format({
    base: 'file.txt'
});
// returns 'file.txt'



path.isAbsolute(path)#



Added in: v0.11.2

Determines whether path is an absolute path. An absolute path will always
resolve to the same location, regardless of the working directory.


Posix examples:


path.isAbsolute('/foo/bar') // true
path.isAbsolute('/baz/..')  // true
path.isAbsolute('qux/')     // false
path.isAbsolute('.')        // false



Windows examples:


path.isAbsolute('//server')  // true
path.isAbsolute('C:/foo/..') // true
path.isAbsolute('bar\\baz')  // false
path.isAbsolute('.')         // false



Note: If the path string passed as parameter is a zero-length string, unlike
        other path module functions, it will be used as-is and false will be
        returned.


path.join([path1][, path2][, ...])#



Added in: v0.1.16

Join all arguments together and normalize the resulting path.


Arguments must be strings.  In v0.8, non-string arguments were
silently ignored.  In v0.10 and up, an exception is thrown.


Example:


path.join('/foo', 'bar', 'baz/asdf', 'quux', '..')
// returns '/foo/bar/baz/asdf'

path.join('foo', {}, 'bar')
// throws exception
TypeError: Arguments to path.join must be strings



Note: If the arguments to join have zero-length strings, unlike other path
        module functions, they will be ignored. If the joined path string is a
        zero-length string then '.' will be returned, which represents the
        current working directory.


path.normalize(p)#



Added in: v0.1.23

Normalize a string path, taking care of '..' and '.' parts.


When multiple slashes are found, they're replaced by a single one;
when the path contains a trailing slash, it is preserved.
On Windows backslashes are used.


Example:


path.normalize('/foo/bar//baz/asdf/quux/..')
// returns '/foo/bar/baz/asdf'



Note: If the path string passed as argument is a zero-length string then '.'
        will be returned, which represents the current working directory.


path.parse(pathString)#



Added in: v0.11.15

Returns an object from a path string.


An example on *nix:


path.parse('/home/user/dir/file.txt')
// returns
// {
//    root : "/",
//    dir : "/home/user/dir",
//    base : "file.txt",
//    ext : ".txt",
//    name : "file"
// }



An example on Windows:


path.parse('C:\\path\\dir\\index.html')
// returns
// {
//    root : "C:\\",
//    dir : "C:\\path\\dir",
//    base : "index.html",
//    ext : ".html",
//    name : "index"
// }



path.posix#



Added in: v0.11.15

Provide access to aforementioned path methods but always interact in a posix
compatible way.


path.relative(from, to)#



Added in: v0.5.0

Solve the relative path from from to to.


At times we have two absolute paths, and we need to derive the relative
path from one to the other.  This is actually the reverse transform of
path.resolve, which means we see that:


path.resolve(from, path.relative(from, to)) == path.resolve(to)



Examples:


path.relative('C:\\orandea\\test\\aaa', 'C:\\orandea\\impl\\bbb')
// returns '..\\..\\impl\\bbb'

path.relative('/data/orandea/test/aaa', '/data/orandea/impl/bbb')
// returns '../../impl/bbb'



Note: If the arguments to relative have zero-length strings then the current
        working directory will be used instead of the zero-length strings. If
        both the paths are the same then a zero-length string will be returned.


path.resolve([from ...], to)#



Added in: v0.3.4

Resolves to to an absolute path.


If to isn't already absolute from arguments are prepended in right to left
order, until an absolute path is found. If after using all from paths still
no absolute path is found, the current working directory is used as well. The
resulting path is normalized, and trailing slashes are removed unless the path
gets resolved to the root directory. Non-string from arguments are ignored.


Another way to think of it is as a sequence of cd commands in a shell.


path.resolve('foo/bar', '/tmp/file/', '..', 'a/../subfile')



Is similar to:


cd foo/bar
cd /tmp/file/
cd ..
cd a/../subfile
pwd

The difference is that the different paths don't need to exist and may also be
files.


Examples:


path.resolve('/foo/bar', './baz')
// returns '/foo/bar/baz'

path.resolve('/foo/bar', '/tmp/file/')
// returns '/tmp/file'

path.resolve('wwwroot', 'static_files/png/', '../gif/image.gif')
// if currently in /home/myself/node, it returns
// '/home/myself/node/wwwroot/static_files/gif/image.gif'



Note: If the arguments to resolve have zero-length strings then the current
        working directory will be used instead of them.


path.sep#



Added in: v0.7.9

The platform-specific file separator. '\\' or '/'.


An example on *nix:


'foo/bar/baz'.split(path.sep)
// returns ['foo', 'bar', 'baz']



An example on Windows:


'foo\\bar\\baz'.split(path.sep)
// returns ['foo', 'bar', 'baz']



path.win32#



Added in: v0.11.15

Provide access to aforementioned path methods but always interact in a win32
compatible way.




Process#



The process object is a global object and can be accessed from anywhere.
It is an instance of EventEmitter.


Event: 'beforeExit'#



Added in: v0.11.12

This event is emitted when Node.js empties its event loop and has nothing else
to schedule. Normally, Node.js exits when there is no work scheduled, but a
listener for 'beforeExit' can make asynchronous calls, and cause Node.js to
continue.


'beforeExit' is not emitted for conditions causing explicit termination, such
as process.exit() or uncaught exceptions, and should not be used as an
alternative to the 'exit' event unless the intention is to schedule more work.


Event: 'exit'#



Added in: v0.1.7

Emitted when the process is about to exit. There is no way to prevent the
exiting of the event loop at this point, and once all 'exit' listeners have
finished running the process will exit. Therefore you must only perform
synchronous operations in this handler. This is a good hook to perform
checks on the module's state (like for unit tests). The callback takes one
argument, the code the process is exiting with.


This event is only emitted when Node.js exits explicitly by process.exit() or
implicitly by the event loop draining.


Example of listening for 'exit':


process.on('exit', (code) => {
  // do *NOT* do this
  setTimeout(() => {
    console.log('This will not run');
  }, 0);
  console.log('About to exit with code:', code);
});



Event: 'message'#



Added in: v0.5.10



Messages sent by ChildProcess.send() are obtained using the 'message'
event on the child's process object.


Event: 'rejectionHandled'#



Added in: v1.4.1

Emitted whenever a Promise was rejected and an error handler was attached to it
(for example with .catch()) later than after an event loop turn. This event
is emitted with the following arguments:


    

  • p the promise that was previously emitted in an 'unhandledRejection'
event, but which has now gained a rejection handler.
    • 



There is no notion of a top level for a promise chain at which rejections can
always be handled. Being inherently asynchronous in nature, a promise rejection
can be handled at a future point in time — possibly much later than the
event loop turn it takes for the 'unhandledRejection' event to be emitted.


Another way of stating this is that, unlike in synchronous code where there is
an ever-growing list of unhandled exceptions, with promises there is a
growing-and-shrinking list of unhandled rejections. In synchronous code, the
'uncaughtException' event tells you when the list of unhandled exceptions
grows. And in asynchronous code, the 'unhandledRejection' event tells you
when the list of unhandled rejections grows, while the 'rejectionHandled'
event tells you when the list of unhandled rejections shrinks.


For example using the rejection detection hooks in order to keep a map of all
the rejected promise reasons at a given time:


const unhandledRejections = new Map();
process.on('unhandledRejection', (reason, p) => {
  unhandledRejections.set(p, reason);
});
process.on('rejectionHandled', (p) => {
  unhandledRejections.delete(p);
});



This map will grow and shrink over time, reflecting rejections that start
unhandled and then become handled. You could record the errors in some error
log, either periodically (probably best for long-running programs, allowing
you to clear the map, which in the case of a very buggy program could grow
indefinitely) or upon process exit (more convenient for scripts).


Event: 'uncaughtException'#



Added in: v0.1.18

The 'uncaughtException' event is emitted when an exception bubbles all the
way back to the event loop. By default, Node.js handles such exceptions by
printing the stack trace to stderr and exiting. Adding a handler for the
'uncaughtException' event overrides this default behavior.


For example:


process.on('uncaughtException', (err) => {
  console.log(`Caught exception: ${err}`);
});

setTimeout(() => {
  console.log('This will still run.');
}, 500);

// Intentionally cause an exception, but don't catch it.
nonexistentFunc();
console.log('This will not run.');



Warning: Using 'uncaughtException' correctly#


Note that 'uncaughtException' is a crude mechanism for exception handling
intended to be used only as a last resort. The event should not be used as
an equivalent to On Error Resume Next. Unhandled exceptions inherently mean
that an application is in an undefined state. Attempting to resume application
code without properly recovering from the exception can cause additional
unforeseen and unpredictable issues.


Exceptions thrown from within the event handler will not be caught. Instead the
process will exit with a non-zero exit code and the stack trace will be printed.
This is to avoid infinite recursion.


Attempting to resume normally after an uncaught exception can be similar to
pulling out of the power cord when upgrading a computer -- nine out of ten
times nothing happens - but the 10th time, the system becomes corrupted.


The correct use of 'uncaughtException' is to perform synchronous cleanup
of allocated resources (e.g. file descriptors, handles, etc) before shutting
down the process. It is not safe to resume normal operation after
'uncaughtException'.


Event: 'unhandledRejection'#



Added in: v1.4.1

Emitted whenever a Promise is rejected and no error handler is attached to
the promise within a turn of the event loop. When programming with promises
exceptions are encapsulated as rejected promises. Such promises can be caught
and handled using promise.catch(...) and rejections are propagated through
a promise chain. This event is useful for detecting and keeping track of
promises that were rejected whose rejections were not handled yet. This event
is emitted with the following arguments:


    

  • reason the object with which the promise was rejected (usually an
Error instance).
    • 

  • p the promise that was rejected.
    • 



Here is an example that logs every unhandled rejection to the console


process.on('unhandledRejection', (reason, p) => {
  console.log('Unhandled Rejection at: Promise', p, 'reason:', reason);
  // application specific logging, throwing an error, or other logic here
});



For example, here is a rejection that will trigger the 'unhandledRejection'
event:


somePromise.then((res) => {
  return reportToUser(JSON.pasre(res)); // note the typo (`pasre`)
}); // no `.catch` or `.then`



Here is an example of a coding pattern that will also trigger
'unhandledRejection':


function SomeResource() {
  // Initially set the loaded status to a rejected promise
  this.loaded = Promise.reject(new Error('Resource not yet loaded!'));
}

var resource = new SomeResource();
// no .catch or .then on resource.loaded for at least a turn



In cases like this, you may not want to track the rejection as a developer
error like you would for other 'unhandledRejection' events. To address
this, you can either attach a dummy .catch(() => { }) handler to
resource.loaded, preventing the 'unhandledRejection' event from being
emitted, or you can use the 'rejectionHandled' event.


Exit Codes#


Node.js will normally exit with a 0 status code when no more async
operations are pending.  The following status codes are used in other
cases:


    

  • 1 Uncaught Fatal Exception - There was an uncaught exception,
and it was not handled by a domain or an 'uncaughtException' event
handler.
    • 

  • 2 - Unused (reserved by Bash for builtin misuse)
    • 

  • 3 Internal JavaScript Parse Error - The JavaScript source code
internal in Node.js's bootstrapping process caused a parse error.  This
is extremely rare, and generally can only happen during development
of Node.js itself.
    • 

  • 4 Internal JavaScript Evaluation Failure - The JavaScript
source code internal in Node.js's bootstrapping process failed to
return a function value when evaluated.  This is extremely rare, and
generally can only happen during development of Node.js itself.
    • 

  • 5 Fatal Error - There was a fatal unrecoverable error in V8.
Typically a message will be printed to stderr with the prefix FATAL
ERROR.
    • 

  • 6 Non-function Internal Exception Handler - There was an
uncaught exception, but the internal fatal exception handler
function was somehow set to a non-function, and could not be called.
    • 

  • 7 Internal Exception Handler Run-Time Failure - There was an
uncaught exception, and the internal fatal exception handler
function itself threw an error while attempting to handle it.  This
can happen, for example, if a process.on('uncaughtException') or
domain.on('error') handler throws an error.
    • 

  • 8 - Unused.  In previous versions of Node.js, exit code 8 sometimes
indicated an uncaught exception.
    • 

  • 9 - Invalid Argument - Either an unknown option was specified,
or an option requiring a value was provided without a value.
    • 

  • 10 Internal JavaScript Run-Time Failure - The JavaScript
source code internal in Node.js's bootstrapping process threw an error
when the bootstrapping function was called.  This is extremely rare,
and generally can only happen during development of Node.js itself.
    • 

  • 12 Invalid Debug Argument - The --debug and/or --debug-brk
options were set, but an invalid port number was chosen.
    • 

  • >128 Signal Exits - If Node.js receives a fatal signal such as
SIGKILL or SIGHUP, then its exit code will be 128 plus the
value of the signal code.  This is a standard Unix practice, since
exit codes are defined to be 7-bit integers, and signal exits set
the high-order bit, and then contain the value of the signal code.
    • 



Signal Events#




Emitted when the processes receives a signal. See sigaction(7) for a list of
standard POSIX signal names such as SIGINT, SIGHUP, etc.


Example of listening for SIGINT:


// Start reading from stdin so we don't exit.
process.stdin.resume();

process.on('SIGINT', () => {
  console.log('Got SIGINT.  Press Control-D to exit.');
});



An easy way to send the SIGINT signal is with Control-C in most terminal
programs.


Note:


    

  • SIGUSR1 is reserved by Node.js to start the debugger.  It's possible to
install a listener but that won't stop the debugger from starting.
    • 

  • SIGTERM and SIGINT have default handlers on non-Windows platforms that
resets the terminal mode before exiting with code 128 + signal number. If
one of these signals has a listener installed, its default behavior will be
removed (Node.js will no longer exit).
    • 

  • SIGPIPE is ignored by default. It can have a listener installed.
    • 

  • SIGHUP is generated on Windows when the console window is closed, and on other
platforms under various similar conditions, see signal(7). It can have a
listener installed, however Node.js will be unconditionally terminated by
Windows about 10 seconds later. On non-Windows platforms, the default
behavior of SIGHUP is to terminate Node.js, but once a listener has been
installed its default behavior will be removed.
    • 

  • SIGTERM is not supported on Windows, it can be listened on.
    • 

  • SIGINT from the terminal is supported on all platforms, and can usually be
generated with CTRL+C (though this may be configurable). It is not generated
when terminal raw mode is enabled.
    • 

  • SIGBREAK is delivered on Windows when CTRL+BREAK is pressed, on
non-Windows
platforms it can be listened on, but there is no way to send or generate it.
    • 

  • SIGWINCH is delivered when the console has been resized. On Windows, this
will only happen on write to the console when the cursor is being moved, or
when a readable tty is used in raw mode.
    • 

  • SIGKILL cannot have a listener installed, it will unconditionally terminate
Node.js on all platforms.
    • 

  • SIGSTOP cannot have a listener installed.
    • 



Note that Windows does not support sending Signals, but Node.js offers some
emulation with process.kill(), and child_process.kill(). Sending signal 0
can be used to test for the existence of a process. Sending SIGINT,
SIGTERM, and SIGKILL cause the unconditional termination of the target
process.


process.abort()#



Added in: v0.7.0

This causes Node.js to emit an abort. This will cause Node.js to exit and
generate a core file.


process.arch#



Added in: v0.5.0

What processor architecture you're running on: 'arm', 'ia32', or 'x64'.


console.log('This processor architecture is ' + process.arch);



process.argv#



Added in: v0.1.27

An array containing the command line arguments.  The first element will be
'node', the second element will be the name of the JavaScript file.  The
next elements will be any additional command line arguments.


// print process.argv
process.argv.forEach((val, index, array) => {
  console.log(`${index}: ${val}`);
});



This will generate:


$ node process-2.js one two=three four
0: node
1: /Users/mjr/work/node/process-2.js
2: one
3: two=three
4: four

process.chdir(directory)#



Added in: v0.1.17

Changes the current working directory of the process or throws an exception if that fails.


console.log(`Starting directory: ${process.cwd()}`);
try {
  process.chdir('/tmp');
  console.log(`New directory: ${process.cwd()}`);
}
catch (err) {
  console.log(`chdir: ${err}`);
}



process.config#



Added in: v0.7.7

An Object containing the JavaScript representation of the configure options
that were used to compile the current Node.js executable. This is the same as
the config.gypi file that was produced when running the ./configure script.


An example of the possible output looks like:


{
  target_defaults:
   { cflags: [],
     default_configuration: 'Release',
     defines: [],
     include_dirs: [],
     libraries: [] },
  variables:
   {
     host_arch: 'x64',
     node_install_npm: 'true',
     node_prefix: '',
     node_shared_cares: 'false',
     node_shared_http_parser: 'false',
     node_shared_libuv: 'false',
     node_shared_zlib: 'false',
     node_use_dtrace: 'false',
     node_use_openssl: 'true',
     node_shared_openssl: 'false',
     strict_aliasing: 'true',
     target_arch: 'x64',
     v8_use_snapshot: 'true'
   }
}

Note: the process.config property is not read-only and there are existing
modules in the ecosystem that are known to extend, modify, or entirely replace
the value of process.config.


process.connected#



Added in: v0.7.2

    

  • <Boolean> Set to false after process.disconnect() is called
    • 



If process.connected is false, it is no longer possible to send messages.


process.cpuUsage([previousValue])#


Returns the user and system CPU time usage of the current process, in an object
with properties user and system, whose values are microsecond values
(millionth of a second). These values measure time spent in user and
system code respectively, and may end up being greater than actual elapsed time
if multiple CPU cores are performing work for this process.


The result of a previous call to process.cpuUsage() can be passed as the
argument to the function, to get a diff reading.


const startUsage = process.cpuUsage();
// { user: 38579, system: 6986 }

// spin the CPU for 500 milliseconds
const now = Date.now();
while (Date.now() - now < 500);

console.log(process.cpuUsage(startUsage));
// { user: 514883, system: 11226 }



process.cwd()#



Added in: v0.1.8

Returns the current working directory of the process.


console.log(`Current directory: ${process.cwd()}`);



process.disconnect()#



Added in: v0.7.2

Close the IPC channel to the parent process, allowing this child to exit
gracefully once there are no other connections keeping it alive.


Identical to the parent process's ChildProcess.disconnect().


If Node.js was not spawned with an IPC channel, process.disconnect() will be
undefined.


process.env#



Added in: v0.1.27

An object containing the user environment. See environ(7).


An example of this object looks like:


{ TERM: 'xterm-256color',
  SHELL: '/usr/local/bin/bash',
  USER: 'maciej',
  PATH: '~/.bin/:/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin',
  PWD: '/Users/maciej',
  EDITOR: 'vim',
  SHLVL: '1',
  HOME: '/Users/maciej',
  LOGNAME: 'maciej',
  _: '/usr/local/bin/node' }



You can write to this object, but changes won't be reflected outside of your
process. That means that the following won't work:


$ node -e 'process.env.foo = "bar"' && echo $foo

But this will:


process.env.foo = 'bar';
console.log(process.env.foo);



Assigning a property on process.env will implicitly convert the value
to a string.


Example:


process.env.test = null;
console.log(process.env.test);
// => 'null'
process.env.test = undefined;
console.log(process.env.test);
// => 'undefined'



Use delete to delete a property from process.env.


Example:


process.env.TEST = 1;
delete process.env.TEST;
console.log(process.env.TEST);
// => undefined



process.execArgv#



Added in: v0.7.7

This is the set of Node.js-specific command line options from the
executable that started the process.  These options do not show up in
process.argv, and do not include the Node.js executable, the name of
the script, or any options following the script name. These options
are useful in order to spawn child processes with the same execution
environment as the parent.


Example:


$ node --harmony script.js --version

results in process.execArgv:


['--harmony']



and process.argv:


['/usr/local/bin/node', 'script.js', '--version']



process.execPath#



Added in: v0.1.100

This is the absolute pathname of the executable that started the process.


Example:


/usr/local/bin/node

process.exit([code])#



Added in: v0.1.13

Ends the process with the specified code.  If omitted, exit uses the
'success' code 0.


To exit with a 'failure' code:


process.exit(1);



The shell that executed Node.js should see the exit code as 1.


process.exitCode#



Added in: v0.11.8

A number which will be the process exit code, when the process either
exits gracefully, or is exited via process.exit() without specifying
a code.


Specifying a code to process.exit(code) will override any previous
setting of process.exitCode.


process.getegid()#



Added in: v2.0.0

Note: this function is only available on POSIX platforms (i.e. not Windows,
Android)


Gets the effective group identity of the process. (See getegid(2).)
This is the numerical group id, not the group name.


if (process.getegid) {
  console.log(`Current gid: ${process.getegid()}`);
}



process.geteuid()#



Added in: v2.0.0

Note: this function is only available on POSIX platforms (i.e. not Windows,
Android)


Gets the effective user identity of the process. (See geteuid(2).)
This is the numerical userid, not the username.


if (process.geteuid) {
  console.log(`Current uid: ${process.geteuid()}`);
}



process.getgid()#



Added in: v0.1.31

Note: this function is only available on POSIX platforms (i.e. not Windows,
Android)


Gets the group identity of the process. (See getgid(2).)
This is the numerical group id, not the group name.


if (process.getgid) {
  console.log(`Current gid: ${process.getgid()}`);
}



process.getgroups()#



Added in: v0.9.4

Note: this function is only available on POSIX platforms (i.e. not Windows,
Android)


Returns an array with the supplementary group IDs. POSIX leaves it unspecified
if the effective group ID is included but Node.js ensures it always is.


process.getuid()#



Added in: v0.1.28

Note: this function is only available on POSIX platforms (i.e. not Windows,
Android)


Gets the user identity of the process. (See getuid(2).)
This is the numerical userid, not the username.


if (process.getuid) {
  console.log(`Current uid: ${process.getuid()}`);
}



process.hrtime()#



Added in: v0.7.6

Returns the current high-resolution real time in a [seconds, nanoseconds]
tuple Array. It is relative to an arbitrary time in the past. It is not
related to the time of day and therefore not subject to clock drift. The
primary use is for measuring performance between intervals.


You may pass in the result of a previous call to process.hrtime() to get
a diff reading, useful for benchmarks and measuring intervals:


var time = process.hrtime();
// [ 1800216, 25 ]

setTimeout(() => {
  var diff = process.hrtime(time);
  // [ 1, 552 ]

  console.log('benchmark took %d nanoseconds', diff[0] * 1e9 + diff[1]);
  // benchmark took 1000000527 nanoseconds
}, 1000);



process.initgroups(user, extra_group)#



Added in: v0.9.4

Note: this function is only available on POSIX platforms (i.e. not Windows,
Android)


Reads /etc/group and initializes the group access list, using all groups of
which the user is a member. This is a privileged operation, meaning you need
to be root or have the CAP_SETGID capability.


user is a user name or user ID. extra_group is a group name or group ID.


Some care needs to be taken when dropping privileges. Example:


console.log(process.getgroups());         // [ 0 ]
process.initgroups('bnoordhuis', 1000);   // switch user
console.log(process.getgroups());         // [ 27, 30, 46, 1000, 0 ]
process.setgid(1000);                     // drop root gid
console.log(process.getgroups());         // [ 27, 30, 46, 1000 ]



process.kill(pid[, signal])#



Added in: v0.0.6

Send a signal to a process. pid is the process id and signal is the
string describing the signal to send.  Signal names are strings like
SIGINT or SIGHUP.  If omitted, the signal will be SIGTERM.
See Signal Events and kill(2) for more information.


Will throw an error if target does not exist, and as a special case, a signal
of 0 can be used to test for the existence of a process. Windows platforms
will throw an error if the pid is used to kill a process group.


Note that even though the name of this function is process.kill, it is really
just a signal sender, like the kill system call.  The signal sent may do
something other than kill the target process.


Example of sending a signal to yourself:


process.on('SIGHUP', () => {
  console.log('Got SIGHUP signal.');
});

setTimeout(() => {
  console.log('Exiting.');
  process.exit(0);
}, 100);

process.kill(process.pid, 'SIGHUP');



Note: When SIGUSR1 is received by Node.js it starts the debugger, see
Signal Events.


process.mainModule#



Added in: v0.1.17

Alternate way to retrieve require.main. The difference is that if the main
module changes at runtime, require.main might still refer to the original main
module in modules that were required before the change occurred. Generally it's
safe to assume that the two refer to the same module.


As with require.main, it will be undefined if there was no entry script.


process.memoryUsage()#



Added in: v0.1.16

    

  • Returns: <Object>
      

    • rss <Integer>
      • 

    • heapTotal <Integer>
      • 

    • heapUsed <Integer>
      • 

    • external <Integer>
      • 

    

    • 



The process.memoryUsage() method returns an object describing the memory usage
of the Node.js process measured in bytes.


For example, the code:


console.log(process.memoryUsage());



This will generate:


{ rss: 4935680,
  heapTotal: 1826816,
  heapUsed: 650472,
  external: 49879
}



heapTotal and heapUsed refer to V8's memory usage.
external refers to the memory usage of C++ objects bound to JavaScript
objects managed by V8.


process.nextTick(callback[, arg][, ...])#



Added in: v0.1.26



Once the current event loop turn runs to completion, call the callback
function.


This is not a simple alias to setTimeout(fn, 0), it's much more
efficient.  It runs before any additional I/O events (including
timers) fire in subsequent ticks of the event loop.


console.log('start');
process.nextTick(() => {
  console.log('nextTick callback');
});
console.log('scheduled');
// Output:
// start
// scheduled
// nextTick callback



This is important in developing APIs where you want to give the user the
chance to assign event handlers after an object has been constructed,
but before any I/O has occurred.


function MyThing(options) {
  this.setupOptions(options);

  process.nextTick(() => {
    this.startDoingStuff();
  });
}

var thing = new MyThing();
thing.getReadyForStuff();

// thing.startDoingStuff() gets called now, not before.



It is very important for APIs to be either 100% synchronous or 100%
asynchronous.  Consider this example:


// WARNING!  DO NOT USE!  BAD UNSAFE HAZARD!
function maybeSync(arg, cb) {
  if (arg) {
    cb();
    return;
  }

  fs.stat('file', cb);
}



This API is hazardous.  If you do this:


maybeSync(true, () => {
  foo();
});
bar();



then it's not clear whether foo() or bar() will be called first.


This approach is much better:


function definitelyAsync(arg, cb) {
  if (arg) {
    process.nextTick(cb);
    return;
  }

  fs.stat('file', cb);
}



Note: the nextTick queue is completely drained on each pass of the
event loop before additional I/O is processed.  As a result,
recursively setting nextTick callbacks will block any I/O from
happening, just like a while(true); loop.


process.pid#



Added in: v0.1.15

The PID of the process.


console.log(`This process is pid ${process.pid}`);



process.platform#



Added in: v0.1.16

What platform you're running on:
'darwin', 'freebsd', 'linux', 'sunos' or 'win32'


console.log(`This platform is ${process.platform}`);



process.release#



Added in: v3.0.0

An Object containing metadata related to the current release, including URLs
for the source tarball and headers-only tarball.


process.release contains the following properties:


    

  • name: a string with a value that will always be 'node' for Node.js. For
legacy io.js releases, this will be 'io.js'.
    • 

  • sourceUrl: a complete URL pointing to a .tar.gz file containing the
source of the current release.
    • 

  • headersUrl: a complete URL pointing to a .tar.gz file containing only
the header files for the current release. This file is significantly smaller
than the full source file and can be used for compiling add-ons against
Node.js.
    • 

  • libUrl: a complete URL pointing to an node.lib file matching the
architecture and version of the current release. This file is used for
compiling add-ons against Node.js. This property is only present on Windows
builds of Node.js and will be missing on all other platforms.
    • 



e.g.


{ name: 'node',
  sourceUrl: 'https://nodejs.org/download/release/v4.0.0/node-v4.0.0.tar.gz',
  headersUrl: 'https://nodejs.org/download/release/v4.0.0/node-v4.0.0-headers.tar.gz',
  libUrl: 'https://nodejs.org/download/release/v4.0.0/win-x64/node.lib' }



In custom builds from non-release versions of the source tree, only the
name property may be present. The additional properties should not be
relied upon to exist.


process.send(message[, sendHandle][, callback])#



Added in: v0.5.9



When Node.js is spawned with an IPC channel attached, it can send messages to its
parent process using process.send(). Each will be received as a
'message' event on the parent's ChildProcess object.


Note: this function uses JSON.stringify() internally to serialize the message.


If Node.js was not spawned with an IPC channel, process.send() will be undefined.


process.setegid(id)#



Added in: v2.0.0

Note: this function is only available on POSIX platforms (i.e. not Windows,
Android)


Sets the effective group identity of the process. (See setegid(2).)
This accepts either a numerical ID or a groupname string. If a groupname
is specified, this method blocks while resolving it to a numerical ID.


if (process.getegid && process.setegid) {
  console.log(`Current gid: ${process.getegid()}`);
  try {
    process.setegid(501);
    console.log(`New gid: ${process.getegid()}`);
  }
  catch (err) {
    console.log(`Failed to set gid: ${err}`);
  }
}



process.seteuid(id)#



Added in: v2.0.0

Note: this function is only available on POSIX platforms (i.e. not Windows,
Android)


Sets the effective user identity of the process. (See seteuid(2).)
This accepts either a numerical ID or a username string.  If a username
is specified, this method blocks while resolving it to a numerical ID.


if (process.geteuid && process.seteuid) {
  console.log(`Current uid: ${process.geteuid()}`);
  try {
    process.seteuid(501);
    console.log(`New uid: ${process.geteuid()}`);
  }
  catch (err) {
    console.log(`Failed to set uid: ${err}`);
  }
}



process.setgid(id)#



Added in: v0.1.31

Note: this function is only available on POSIX platforms (i.e. not Windows,
Android)


Sets the group identity of the process. (See setgid(2).)  This accepts either
a numerical ID or a groupname string. If a groupname is specified, this method
blocks while resolving it to a numerical ID.


if (process.getgid && process.setgid) {
  console.log(`Current gid: ${process.getgid()}`);
  try {
    process.setgid(501);
    console.log(`New gid: ${process.getgid()}`);
  }
  catch (err) {
    console.log(`Failed to set gid: ${err}`);
  }
}



process.setgroups(groups)#



Added in: v0.9.4

Note: this function is only available on POSIX platforms (i.e. not Windows,
Android)


Sets the supplementary group IDs. This is a privileged operation, meaning you
need to be root or have the CAP_SETGID capability.


The list can contain group IDs, group names or both.


process.setuid(id)#



Added in: v0.1.28

Note: this function is only available on POSIX platforms (i.e. not Windows,
Android)


Sets the user identity of the process. (See setuid(2).)  This accepts either
a numerical ID or a username string.  If a username is specified, this method
blocks while resolving it to a numerical ID.


if (process.getuid && process.setuid) {
  console.log(`Current uid: ${process.getuid()}`);
  try {
    process.setuid(501);
    console.log(`New uid: ${process.getuid()}`);
  }
  catch (err) {
    console.log(`Failed to set uid: ${err}`);
  }
}



process.stderr#


A writable stream to stderr (on fd 2).


process.stderr and process.stdout are unlike other streams in Node.js in
that they cannot be closed (end() will throw), they never emit the finish
event and that writes can block when output is redirected to a file (although
disks are fast and operating systems normally employ write-back caching so it
should be a very rare occurrence indeed.)


Additionally, process.stderr and process.stdout are blocking when outputting
to TTYs (terminals) on OS X as a workaround for the OS's very small, 1kb
buffer size. This is to prevent interleaving between stdout and stderr.


process.stdin#


A Readable Stream for stdin (on fd 0).


Example of opening standard input and listening for both events:


process.stdin.setEncoding('utf8');

process.stdin.on('readable', () => {
  var chunk = process.stdin.read();
  if (chunk !== null) {
    process.stdout.write(`data: ${chunk}`);
  }
});

process.stdin.on('end', () => {
  process.stdout.write('end');
});



As a Stream, process.stdin can also be used in "old" mode that is compatible
with scripts written for node.js prior to v0.10.
For more information see Stream compatibility.


In "old" Streams mode the stdin stream is paused by default, so one
must call process.stdin.resume() to read from it. Note also that calling
process.stdin.resume() itself would switch stream to "old" mode.


If you are starting a new project you should prefer a more recent "new" Streams
mode over "old" one.


process.stdout#


A Writable Stream to stdout (on fd 1).


For example, a console.log equivalent could look like this:


console.log = (msg) => {
  process.stdout.write(`${msg}\n`);
};



process.stderr and process.stdout are unlike other streams in Node.js in
that they cannot be closed (end() will throw), they never emit the 'finish'
event and that writes can block when output is redirected to a file (although
disks are fast and operating systems normally employ write-back caching so it
should be a very rare occurrence indeed.)


Additionally, process.stderr and process.stdout are blocking when outputting
to TTYs (terminals) on OS X as a workaround for the OS's very small, 1kb
buffer size. This is to prevent interleaving between stdout and stderr.


To check if Node.js is being run in a TTY context, read the isTTY property
on process.stderr, process.stdout, or process.stdin:


$ node -p "Boolean(process.stdin.isTTY)"
true
$ echo "foo" | node -p "Boolean(process.stdin.isTTY)"
false

$ node -p "Boolean(process.stdout.isTTY)"
true
$ node -p "Boolean(process.stdout.isTTY)" | cat
false

See the tty docs for more information.


process.title#



Added in: v0.1.104

Getter/setter to set what is displayed in ps.


When used as a setter, the maximum length is platform-specific and probably
short.


On Linux and OS X, it's limited to the size of the binary name plus the
length of the command line arguments because it overwrites the argv memory.


v0.8 allowed for longer process title strings by also overwriting the environ
memory but that was potentially insecure/confusing in some (rather obscure)
cases.


process.umask([mask])#



Added in: v0.1.19

Sets or reads the process's file mode creation mask. Child processes inherit
the mask from the parent process. Returns the old mask if mask argument is
given, otherwise returns the current mask.


const newmask = 0o022;
const oldmask = process.umask(newmask);
console.log(
  `Changed umask from ${oldmask.toString(8)} to ${newmask.toString(8)}`
);



process.uptime()#



Added in: v0.5.0

Number of seconds Node.js has been running.


process.version#



Added in: v0.1.3

A compiled-in property that exposes NODE_VERSION.


console.log(`Version: ${process.version}`);



process.versions#



Added in: v0.2.0

A property exposing version strings of Node.js and its dependencies.


console.log(process.versions);



Will print something like:


{ http_parser: '2.3.0',
  node: '1.1.1',
  v8: '4.1.0.14',
  uv: '1.3.0',
  zlib: '1.2.8',
  ares: '1.10.0-DEV',
  modules: '43',
  icu: '55.1',
  openssl: '1.0.1k' }





Punycode#


Stability: 2 - Stable
Punycode.js is bundled with Node.js v0.5.1+. Use require('punycode') to
access it. (To use it with other Node.js versions, use npm to install the
punycode module first.)


punycode.decode(string)#



Added in: v0.5.1

Converts a Punycode string of ASCII-only symbols to a string of Unicode symbols.


// decode domain name parts
punycode.decode('maana-pta'); // 'mañana'
punycode.decode('--dqo34k'); // '☃-⌘'



punycode.encode(string)#



Added in: v0.5.1

Converts a string of Unicode symbols to a Punycode string of ASCII-only symbols.


// encode domain name parts
punycode.encode('mañana'); // 'maana-pta'
punycode.encode('☃-⌘'); // '--dqo34k'



punycode.toASCII(domain)#



Added in: v0.6.1

Converts a Unicode string representing a domain name to Punycode. Only the
non-ASCII parts of the domain name will be converted, i.e. it doesn't matter if
you call it with a domain that's already in ASCII.


// encode domain names
punycode.toASCII('mañana.com'); // 'xn--maana-pta.com'
punycode.toASCII('☃-⌘.com'); // 'xn----dqo34k.com'



punycode.toUnicode(domain)#



Added in: v0.6.1

Converts a Punycode string representing a domain name to Unicode. Only the
Punycoded parts of the domain name will be converted, i.e. it doesn't matter if
you call it on a string that has already been converted to Unicode.


// decode domain names
punycode.toUnicode('xn--maana-pta.com'); // 'mañana.com'
punycode.toUnicode('xn----dqo34k.com'); // '☃-⌘.com'



punycode.ucs2#



Added in: v0.7.0

punycode.ucs2.decode(string)#



Added in: v0.7.0

Creates an array containing the numeric code point values of each Unicode
symbol in the string. While JavaScript uses UCS-2 internally, this function
will convert a pair of surrogate halves (each of which UCS-2 exposes as
separate characters) into a single code point, matching UTF-16.


punycode.ucs2.decode('abc'); // [0x61, 0x62, 0x63]
// surrogate pair for U+1D306 tetragram for centre:
punycode.ucs2.decode('\uD834\uDF06'); // [0x1D306]



punycode.ucs2.encode(codePoints)#



Added in: v0.7.0

Creates a string based on an array of numeric code point values.


punycode.ucs2.encode([0x61, 0x62, 0x63]); // 'abc'
punycode.ucs2.encode([0x1D306]); // '\uD834\uDF06'



punycode.version#



Added in: v0.6.1

A string representing the current Punycode.js version number.




Query String#


Stability: 2 - Stable


This module provides utilities for dealing with query strings.
It provides the following methods:


querystring.escape#



Added in: v0.1.25

The escape function used by querystring.stringify,
provided so that it could be overridden if necessary.


querystring.parse(str[, sep][, eq][, options])#



Added in: v0.1.25

Deserialize a query string to an object.
Optionally override the default separator ('&') and assignment ('=')
characters.


Options object may contain maxKeys property (equal to 1000 by default), it'll
be used to limit processed keys. Set it to 0 to remove key count limitation.


Options object may contain decodeURIComponent property (querystring.unescape by default),
it can be used to decode a non-utf8 encoding string if necessary.


Example:


querystring.parse('foo=bar&baz=qux&baz=quux&corge')
// returns { foo: 'bar', baz: ['qux', 'quux'], corge: '' }

// Suppose gbkDecodeURIComponent function already exists,
// it can decode `gbk` encoding string
querystring.parse('w=%D6%D0%CE%C4&foo=bar', null, null,
  { decodeURIComponent: gbkDecodeURIComponent })
// returns { w: '中文', foo: 'bar' }



querystring.stringify(obj[, sep][, eq][, options])#



Added in: v0.1.25

Serialize an object to a query string.
Optionally override the default separator ('&') and assignment ('=')
characters.


Options object may contain encodeURIComponent property (querystring.escape by default),
it can be used to encode string with non-utf8 encoding if necessary.


Example:


querystring.stringify({ foo: 'bar', baz: ['qux', 'quux'], corge: '' })
// returns 'foo=bar&baz=qux&baz=quux&corge='

querystring.stringify({foo: 'bar', baz: 'qux'}, ';', ':')
// returns 'foo:bar;baz:qux'

// Suppose gbkEncodeURIComponent function already exists,
// it can encode string with `gbk` encoding
querystring.stringify({ w: '中文', foo: 'bar' }, null, null,
  { encodeURIComponent: gbkEncodeURIComponent })
// returns 'w=%D6%D0%CE%C4&foo=bar'



querystring.unescape#



Added in: v0.1.25

The unescape function used by querystring.parse,
provided so that it could be overridden if necessary.


It will try to use decodeURIComponent in the first place,
but if that fails it falls back to a safer equivalent that
doesn't throw on malformed URLs.




Readline#


Stability: 2 - Stable
To use this module, do require('readline'). Readline allows reading of a
stream (such as process.stdin) on a line-by-line basis.


Note that once you've invoked this module, your Node.js program will not
terminate until you've closed the interface. Here's how to allow your
program to gracefully exit:


const readline = require('readline');

const rl = readline.createInterface({
  input: process.stdin,
  output: process.stdout
});

rl.question('What do you think of Node.js? ', (answer) => {
  // TODO: Log the answer in a database
  console.log('Thank you for your valuable feedback:', answer);

  rl.close();
});



Class: Interface#



Added in: v0.1.104

The class that represents a readline interface with an input and output
stream.


rl.close()#



Added in: v0.1.98

Closes the Interface instance, relinquishing control on the input and
output streams. The 'close' event will also be emitted.


rl.pause()#



Added in: v0.3.4

Pauses the readline input stream, allowing it to be resumed later if needed.


Note that this doesn't immediately pause the stream of events. Several events may
be emitted after calling pause, including line.


rl.prompt([preserveCursor])#



Added in: v0.1.98

Readies readline for input from the user, putting the current setPrompt
options on a new line, giving the user a new spot to write. Set preserveCursor
to true to prevent the cursor placement being reset to 0.


This will also resume the input stream used with createInterface if it has
been paused.


If output is set to null or undefined when calling createInterface, the
prompt is not written.


rl.question(query, callback)#



Added in: v0.3.3

Prepends the prompt with query and invokes callback with the user's
response. Displays the query to the user, and then invokes callback
with the user's response after it has been typed.


This will also resume the input stream used with createInterface if
it has been paused.


If output is set to null or undefined when calling createInterface,
nothing is displayed.


Example usage:


rl.question('What is your favorite food?', (answer) => {
  console.log(`Oh, so your favorite food is ${answer}`);
});



rl.resume()#



Added in: v0.3.4

Resumes the readline input stream.


rl.setPrompt(prompt)#



Added in: v0.1.98

Sets the prompt, for example when you run node on the command line, you see
>, which is Node.js's prompt.


rl.write(data[, key])#



Added in: v0.1.98

Writes data to output stream, unless output is set to null or
undefined when calling createInterface. key is an object literal to
represent a key sequence; available if the terminal is a TTY.


This will also resume the input stream if it has been paused.


Example:


rl.write('Delete me!');
// Simulate ctrl+u to delete the line written previously
rl.write(null, {ctrl: true, name: 'u'});



Events#


Event: 'close'#



Added in: v0.1.98

function () {}


Emitted when close() is called.


Also emitted when the input stream receives its 'end' event. The Interface
instance should be considered "finished" once this is emitted. For example, when
the input stream receives ^D, respectively known as EOT.


This event is also called if there is no SIGINT event listener present when
the input stream receives a ^C, respectively known as SIGINT.


Event: 'line'#



Added in: v0.1.98

function (line) {}


Emitted whenever the input stream receives an end of line (\n, \r, or
\r\n), usually received when the user hits enter, or return. This is a good
hook to listen for user input.


Example of listening for 'line':


rl.on('line', (cmd) => {
  console.log(`You just typed: ${cmd}`);
});



Event: 'pause'#



Added in: v0.7.5

function () {}


Emitted whenever the input stream is paused.


Also emitted whenever the input stream is not paused and receives the
SIGCONT event. (See events SIGTSTP and SIGCONT)


Example of listening for 'pause':


rl.on('pause', () => {
  console.log('Readline paused.');
});



Event: 'resume'#



Added in: v0.7.5

function () {}


Emitted whenever the input stream is resumed.


Example of listening for 'resume':


rl.on('resume', () => {
  console.log('Readline resumed.');
});



Event: 'SIGCONT'#



Added in: v0.7.5

function () {}


This does not work on Windows.


Emitted whenever the input stream is sent to the background with ^Z,
respectively known as SIGTSTP, and then continued with fg(1). This event
only emits if the stream was not paused before sending the program to the
background.


Example of listening for SIGCONT:


rl.on('SIGCONT', () => {
  // `prompt` will automatically resume the stream
  rl.prompt();
});



Event: 'SIGINT'#



Added in: v0.3.0

function () {}


Emitted whenever the input stream receives a ^C, respectively known as
SIGINT. If there is no SIGINT event listener present when the input
stream receives a SIGINT, pause will be triggered.


Example of listening for SIGINT:


rl.on('SIGINT', () => {
  rl.question('Are you sure you want to exit?', (answer) => {
    if (answer.match(/^y(es)?$/i)) rl.pause();
  });
});



Event: 'SIGTSTP'#



Added in: v0.7.5

function () {}


This does not work on Windows.


Emitted whenever the input stream receives a ^Z, respectively known as
SIGTSTP. If there is no SIGTSTP event listener present when the input
stream receives a SIGTSTP, the program will be sent to the background.


When the program is resumed with fg, the 'pause' and SIGCONT events will be
emitted. You can use either to resume the stream.


The 'pause' and SIGCONT events will not be triggered if the stream was paused
before the program was sent to the background.


Example of listening for SIGTSTP:


rl.on('SIGTSTP', () => {
  // This will override SIGTSTP and prevent the program from going to the
  // background.
  console.log('Caught SIGTSTP.');
});



Example: Tiny CLI#


Here's an example of how to use all these together to craft a tiny command
line interface:


const readline = require('readline');
const rl = readline.createInterface(process.stdin, process.stdout);

rl.setPrompt('OHAI> ');
rl.prompt();

rl.on('line', (line) => {
  switch(line.trim()) {
    case 'hello':
      console.log('world!');
      break;
    default:
      console.log('Say what? I might have heard `' + line.trim() + '`');
      break;
  }
  rl.prompt();
}).on('close', () => {
  console.log('Have a great day!');
  process.exit(0);
});



Example: Read File Stream Line-by-Line#


A common case for readline's input option is to pass a filesystem readable
stream to it. This is how one could craft line-by-line parsing of a file:


const readline = require('readline');
const fs = require('fs');

const rl = readline.createInterface({
  input: fs.createReadStream('sample.txt')
});

rl.on('line', (line) => {
  console.log('Line from file:', line);
});



Note: The rl.write() method will write the data to the readline
Interface's input as if it were provided by the user.


readline.clearLine(stream, dir)#



Added in: v0.7.7

Clears current line of given TTY stream in a specified direction.
dir should have one of following values:


    

  • -1 - to the left from cursor
    • 

  • 1 - to the right from cursor
    • 

  • 0 - the entire line
    • 



readline.clearScreenDown(stream)#



Added in: v0.7.7

Clears the screen from the current position of the cursor down.


readline.createInterface(options)#



Added in: v0.1.98

Creates a readline Interface instance. Accepts an options Object that takes
the following values:


    

  • input - the readable stream to listen to (Required).
    

    • 

  • output - the writable stream to write readline data to (Optional).
    

    • 

  • completer - an optional function that is used for Tab autocompletion. See
below for an example of using this.
    

    • 

  • terminal - pass true if the input and output streams should be
treated like a TTY, and have ANSI/VT100 escape codes written to it.
Defaults to checking isTTY on the output stream upon instantiation.
    

    • 

  • historySize - maximum number of history lines retained. Defaults to 30.
    

    • 



The completer function is given the current line entered by the user, and
is supposed to return an Array with 2 entries:


    

  1. An Array with matching entries for the completion.
    

    2. 

  2. The substring that was used for the matching.
    

    3. 



Which ends up looking something like:
[[substr1, substr2, ...], originalsubstring].


Example:


function completer(line) {
  var completions = '.help .error .exit .quit .q'.split(' ')
  var hits = completions.filter((c) => { return c.indexOf(line) == 0 })
  // show all completions if none found
  return [hits.length ? hits : completions, line]
}



Also completer can be run in async mode if it accepts two arguments:


function completer(linePartial, callback) {
  callback(null, [['123'], linePartial]);
}



createInterface is commonly used with process.stdin and
process.stdout in order to accept user input:


const readline = require('readline');
const rl = readline.createInterface({
  input: process.stdin,
  output: process.stdout
});



Once you have a readline instance, you most commonly listen for the
'line' event.


If terminal is true for this instance then the output stream will get
the best compatibility if it defines an output.columns property, and fires
a 'resize' event on the output if/when the columns ever change
(process.stdout does this automatically when it is a TTY).


readline.cursorTo(stream, x, y)#



Added in: v0.7.7

Move cursor to the specified position in a given TTY stream.


readline.emitKeypressEvents(stream[, interface])#



Added in: v0.7.7

Causes stream to begin emitting 'keypress' events corresponding to its
input.
Optionally, interface specifies a readline.Interface instance for which
autocompletion is disabled when copy-pasted input is detected.


readline.moveCursor(stream, dx, dy)#



Added in: v0.7.7

Move cursor relative to it's current position in a given TTY stream.




REPL#


Stability: 2 - Stable
A Read-Eval-Print-Loop (REPL) is available both as a standalone program and
easily includable in other programs. The REPL provides a way to interactively
run JavaScript and see the results.  It can be used for debugging, testing, or
just trying things out.


By executing node without any arguments from the command-line you will be
dropped into the REPL. It has simplistic emacs line-editing.


$ node
Type '.help' for options.
> a = [1, 2, 3];
[ 1, 2, 3 ]
> a.forEach((v) => {
...   console.log(v);
...   });
1
2
3

For advanced line-editors, start Node.js with the environmental variable
NODE_NO_READLINE=1. This will start the main and debugger REPL in canonical
terminal settings which will allow you to use with rlwrap.


For example, you could add this to your bashrc file:


alias node="env NODE_NO_READLINE=1 rlwrap node"

Environment Variable Options#


The built-in repl (invoked by running node or node -i) may be controlled
via the following environment variables:


    

  • NODE_REPL_HISTORY - When a valid path is given, persistent REPL history
will be saved to the specified file rather than .node_repl_history in the
user's home directory. Setting this value to "" will disable persistent
REPL history. Whitespace will be trimmed from the value.
    • 

  • NODE_REPL_HISTORY_SIZE - Defaults to 1000. Controls how many lines of
history will be persisted if history is available. Must be a positive number.
    • 

  • NODE_REPL_MODE - May be any of sloppy, strict, or magic. Defaults
to magic, which will automatically run "strict mode only" statements in
strict mode.
    • 



Persistent History#


By default, the REPL will persist history between node REPL sessions by saving
to a .node_repl_history file in the user's home directory. This can be
disabled by setting the environment variable NODE_REPL_HISTORY="".


NODE_REPL_HISTORY_FILE#


Stability: 0 - Deprecated: Use NODE_REPL_HISTORY instead.
Previously in Node.js/io.js v2.x, REPL history was controlled by using a
NODE_REPL_HISTORY_FILE environment variable, and the history was saved in JSON
format. This variable has now been deprecated, and your REPL history will
automatically be converted to using plain text. The new file will be saved to
either your home directory, or a directory defined by the NODE_REPL_HISTORY
variable, as documented here.


REPL Features#



Inside the REPL, Control+D will exit.  Multi-line expressions can be input.
Tab completion is supported for both global and local variables.


Core modules will be loaded on-demand into the environment. For example,
accessing fs will require() the fs module as global.fs.


The special variable _ (underscore) contains the result of the last expression.


> [ 'a', 'b', 'c' ]
[ 'a', 'b', 'c' ]
> _.length
3
> _ += 1
4

The REPL provides access to any variables in the global scope. You can expose
a variable to the REPL explicitly by assigning it to the context object
associated with each REPLServer.  For example:


// repl_test.js
const repl = require('repl');
var msg = 'message';

repl.start('> ').context.m = msg;



Things in the context object appear as local within the REPL:


$ node repl_test.js
> m
'message'

There are a few special REPL commands:


    

  • .break - While inputting a multi-line expression, sometimes you get lost
or just don't care about completing it. .break will start over.
    • 

  • .clear - Resets the context object to an empty object and clears any
multi-line expression.
    • 

  • .exit - Close the I/O stream, which will cause the REPL to exit.
    • 

  • .help - Show this list of special commands.
    • 

  • .save - Save the current REPL session to a file
.save ./file/to/save.js
    • 

  • .load - Load a file into the current REPL session.
.load ./file/to/load.js
    • 



The following key combinations in the REPL have these special effects:


    

  • <ctrl>C - Similar to the .break keyword.  Terminates the current
command.  Press twice on a blank line to forcibly exit.
    • 

  • <ctrl>D - Similar to the .exit keyword.
    • 

  • <tab> - Show both global and local(scope) variables
    • 



Customizing Object displays in the REPL#


The REPL module internally uses
util.inspect(), when printing values. However, util.inspect delegates the
 call to the object's inspect() function, if it has one. You can read more
 about this delegation here.


For example, if you have defined an inspect() function on an object, like this:


> var obj = {foo: 'this will not show up in the inspect() output'};
undefined
> obj.inspect = () => {
...   return {bar: 'baz'};
... };
[Function]

and try to print obj in REPL, it will invoke the custom inspect() function:


> obj
{bar: 'baz'}

Class: REPLServer#



Added in: v0.1.91

This inherits from Readline Interface with the following events:


Event: 'exit'#



Added in: v0.7.7

function () {}


Emitted when the user exits the REPL in any of the defined ways. Namely, typing
.exit at the repl, pressing Ctrl+C twice to signal SIGINT, or pressing Ctrl+D
to signal 'end' on the input stream.


Example of listening for exit:


replServer.on('exit', () => {
  console.log('Got "exit" event from repl!');
  process.exit();
});



Event: 'reset'#



Added in: v0.11.0

function (context) {}


Emitted when the REPL's context is reset. This happens when you type .clear.
If you start the repl with { useGlobal: true } then this event will never
be emitted.


Example of listening for reset:


// Extend the initial repl context.
var replServer = repl.start({ options ... });
someExtension.extend(r.context);

// When a new context is created extend it as well.
replServer.on('reset', (context) => {
  console.log('repl has a new context');
  someExtension.extend(context);
});



replServer.defineCommand(keyword, cmd)#



Added in: v0.3.0



Makes a command available in the REPL. The command is invoked by typing a .
followed by the keyword. The cmd is an object with the following values:


    

  • help - help text to be displayed when .help is entered (Optional).
    • 

  • action - a function to execute, potentially taking in a string argument,
when the command is invoked, bound to the REPLServer instance (Required).
    • 



If a function is provided instead of an object for cmd, it is treated as the
action.


Example of defining a command:


// repl_test.js
const repl = require('repl');

var replServer = repl.start();
replServer.defineCommand('sayhello', {
  help: 'Say hello',
  action: function(name) {
    this.write(`Hello, ${name}!\n`);
    this.displayPrompt();
  }
});



Example of invoking that command from the REPL:


> .sayhello Node.js User
Hello, Node.js User!

replServer.displayPrompt([preserveCursor])#



Added in: v0.1.91



Like readline.prompt except also adding indents with ellipses when inside
blocks. The preserveCursor argument is passed to readline.prompt. This is
used primarily with defineCommand. It's also used internally to render each
prompt line.


repl.start(options)#


Returns and starts a REPLServer instance, that inherits from
Readline Interface. Accepts an "options" Object that takes
the following values:


    

  • prompt - the prompt and stream for all I/O. Defaults to >.
    

    • 

  • input - the readable stream to listen to. Defaults to process.stdin.
    

    • 

  • output - the writable stream to write readline data to. Defaults to
process.stdout.
    

    • 

  • terminal - pass true if the stream should be treated like a TTY, and
have ANSI/VT100 escape codes written to it. Defaults to checking isTTY
on the output stream upon instantiation.
    

    • 

  • eval - function that will be used to eval each given line. Defaults to
an async wrapper for eval(). See below for an example of a custom eval.
    

    • 

  • useColors - a boolean which specifies whether or not the writer function
should output colors. If a different writer function is set then this does
nothing. Defaults to the repl's terminal value.
    

    • 

  • useGlobal - if set to true, then the repl will use the global object,
instead of running scripts in a separate context. Defaults to false.
    

    • 

  • ignoreUndefined - if set to true, then the repl will not output the
return value of command if it's undefined. Defaults to false.
    

    • 

  • writer - the function to invoke for each command that gets evaluated which
returns the formatting (including coloring) to display. Defaults to
util.inspect.
    

    • 

  • replMode - controls whether the repl runs all commands in strict mode,
default mode, or a hybrid mode ("magic" mode.) Acceptable values are:
    

      

    • repl.REPL_MODE_SLOPPY - run commands in sloppy mode.
      • 

    • repl.REPL_MODE_STRICT - run commands in strict mode. This is equivalent to
prefacing every repl statement with 'use strict'.
      • 

    • repl.REPL_MODE_MAGIC - attempt to run commands in default mode. If they
fail to parse, re-try in strict mode.
      • 

    

    • 



You can use your own eval function if it has following signature:


function eval(cmd, context, filename, callback) {
  callback(null, result);
}

On tab completion, eval will be called with .scope as an input string. It
is expected to return an array of scope names to be used for the auto-completion.


Multiple REPLs may be started against the same running instance of Node.js.  Each
will share the same global object but will have unique I/O.


Here is an example that starts a REPL on stdin, a Unix socket, and a TCP socket:


const net = require('net');
const repl = require('repl');
var connections = 0;

repl.start({
  prompt: 'Node.js via stdin> ',
  input: process.stdin,
  output: process.stdout
});

net.createServer((socket) => {
  connections += 1;
  repl.start({
    prompt: 'Node.js via Unix socket> ',
    input: socket,
    output: socket
  }).on('exit', () => {
    socket.end();
  })
}).listen('/tmp/node-repl-sock');

net.createServer((socket) => {
  connections += 1;
  repl.start({
    prompt: 'Node.js via TCP socket> ',
    input: socket,
    output: socket
  }).on('exit', () => {
    socket.end();
  });
}).listen(5001);



Running this program from the command line will start a REPL on stdin.  Other
REPL clients may connect through the Unix socket or TCP socket. telnet is useful
for connecting to TCP sockets, and socat can be used to connect to both Unix and
TCP sockets.


By starting a REPL from a Unix socket-based server instead of stdin, you can
connect to a long-running Node.js process without restarting it.


For an example of running a "full-featured" (terminal) REPL over
a net.Server and net.Socket instance, see: https://gist.github.com/2209310


For an example of running a REPL instance over curl(1),
see: https://gist.github.com/2053342




Stream#


Stability: 2 - Stable
A stream is an abstract interface implemented by various objects in
Node.js. For example a request to an HTTP server is a
stream, as is process.stdout. Streams are readable, writable, or both. All
streams are instances of EventEmitter.


You can load the Stream base classes by doing require('stream').
There are base classes provided for Readable streams, Writable
streams, Duplex streams, and Transform streams.


This document is split up into 3 sections:


    

  1. The first section explains the parts of the API that you need to be
aware of to use streams in your programs.
    2. 

  2. The second section explains the parts of the API that you need to
use if you implement your own custom streams yourself. The API is designed to
make this easy for you to do.
    3. 

  3. The third section goes into more depth about how streams work,
including some of the internal mechanisms and functions that you
should probably not modify unless you definitely know what you are
doing.
    4. 



API for Stream Consumers#



Streams can be either Readable, Writable, or both (Duplex).


All streams are EventEmitters, but they also have other custom methods
and properties depending on whether they are Readable, Writable, or
Duplex.


If a stream is both Readable and Writable, then it implements all of
the methods and events. So, a Duplex or Transform stream is
fully described by this API, though their implementation may be
somewhat different.


It is not necessary to implement Stream interfaces in order to consume
streams in your programs. If you are implementing streaming
interfaces in your own program, please also refer to
API for Stream Implementors.


Almost all Node.js programs, no matter how simple, use Streams in some
way. Here is an example of using Streams in an Node.js program:


const http = require('http');

var server = http.createServer( (req, res) => {
  // req is an http.IncomingMessage, which is a Readable Stream
  // res is an http.ServerResponse, which is a Writable Stream

  var body = '';
  // we want to get the data as utf8 strings
  // If you don't set an encoding, then you'll get Buffer objects
  req.setEncoding('utf8');

  // Readable streams emit 'data' events once a listener is added
  req.on('data', (chunk) => {
    body += chunk;
  });

  // the end event tells you that you have entire body
  req.on('end', () => {
    try {
      const data = JSON.parse(body);
      // write back something interesting to the user:
      res.write(typeof data);
      res.end();
    } catch (er) {
      // uh oh!  bad json!
      res.statusCode = 400;
      return res.end(`error: ${er.message}`);
    }
  });
});

server.listen(1337);

// $ curl localhost:1337 -d '{}'
// object
// $ curl localhost:1337 -d '"foo"'
// string
// $ curl localhost:1337 -d 'not json'
// error: Unexpected token o



Class: stream.Duplex#


Duplex streams are streams that implement both the Readable and
Writable interfaces.


Examples of Duplex streams include:



Class: stream.Readable#



The Readable stream interface is the abstraction for a source of
data that you are reading from. In other words, data comes out of a
Readable stream.


A Readable stream will not start emitting data until you indicate that
you are ready to receive it.


Readable streams have two "modes": a flowing mode and a paused
mode. When in flowing mode, data is read from the underlying system
and provided to your program as fast as possible. In paused mode, you
must explicitly call stream.read() to get chunks of data out.
Streams start out in paused mode.


Note: If no data event handlers are attached, and there are no
stream.pipe() destinations, and the stream is switched into flowing
mode, then data will be lost.


You can switch to flowing mode by doing any of the following:



You can switch back to paused mode by doing either of the following:


    

  • If there are no pipe destinations, by calling the
stream.pause() method.
    • 

  • If there are pipe destinations, by removing any 'data' event
handlers, and removing all pipe destinations by calling the
stream.unpipe() method.
    • 



Note that, for backwards compatibility reasons, removing 'data'
event handlers will not automatically pause the stream. Also, if
there are piped destinations, then calling stream.pause() will
not guarantee that the stream will remain paused once those
destinations drain and ask for more data.


Examples of readable streams include:



Event: 'close'#


Emitted when the stream and any of its underlying resources (a file
descriptor, for example) have been closed. The event indicates that
no more events will be emitted, and no further computation will occur.


Not all streams will emit the 'close' event as the 'close' event is
optional.


Event: 'data'#




Attaching a 'data' event listener to a stream that has not been
explicitly paused will switch the stream into flowing mode. Data will
then be passed as soon as it is available.


If you just want to get all the data out of the stream as fast as
possible, this is the best way to do so.


var readable = getReadableStreamSomehow();
readable.on('data', (chunk) => {
  console.log('got %d bytes of data', chunk.length);
});



Event: 'end'#


This event fires when there will be no more data to read.


Note that the 'end' event will not fire unless the data is
completely consumed. This can be done by switching into flowing mode,
or by calling stream.read() repeatedly until you get to the
end.


var readable = getReadableStreamSomehow();
readable.on('data', (chunk) => {
  console.log('got %d bytes of data', chunk.length);
});
readable.on('end', () => {
  console.log('there will be no more data.');
});



Event: 'error'#




Emitted if there was an error receiving data.


Event: 'readable'#


When a chunk of data can be read from the stream, it will emit a
'readable' event.


In some cases, listening for a 'readable' event will cause some data
to be read into the internal buffer from the underlying system, if it
hadn't already.


var readable = getReadableStreamSomehow();
readable.on('readable', () => {
  // there is some data to read now
});



Once the internal buffer is drained, a 'readable' event will fire
again when more data is available.


The 'readable' event is not emitted in the "flowing" mode with the
sole exception of the last one, on end-of-stream.


The 'readable' event indicates that the stream has new information:
either new data is available or the end of the stream has been reached.
In the former case, stream.read() will return that data. In the
latter case, stream.read() will return null. For instance, in
the following example, foo.txt is an empty file:


const fs = require('fs');
var rr = fs.createReadStream('foo.txt');
rr.on('readable', () => {
  console.log('readable:', rr.read());
});
rr.on('end', () => {
  console.log('end');
});



The output of running this script is:


$ node test.js
readable: null
end

readable.isPaused()#




This method returns whether or not the readable has been explicitly
paused by client code (using stream.pause() without a
corresponding stream.resume()).


var readable = new stream.Readable

readable.isPaused() // === false
readable.pause()
readable.isPaused() // === true
readable.resume()
readable.isPaused() // === false



readable.pause()#


    

  • Returns: this
    • 



This method will cause a stream in flowing mode to stop emitting
'data' events, switching out of flowing mode. Any data that becomes
available will remain in the internal buffer.


var readable = getReadableStreamSomehow();
readable.on('data', (chunk) => {
  console.log('got %d bytes of data', chunk.length);
  readable.pause();
  console.log('there will be no more data for 1 second');
  setTimeout(() => {
    console.log('now data will start flowing again');
    readable.resume();
  }, 1000);
});



readable.pipe(destination[, options])#




This method pulls all the data out of a readable stream, and writes it
to the supplied destination, automatically managing the flow so that
the destination is not overwhelmed by a fast readable stream.


Multiple destinations can be piped to safely.


var readable = getReadableStreamSomehow();
var writable = fs.createWriteStream('file.txt');
// All the data from readable goes into 'file.txt'
readable.pipe(writable);



This function returns the destination stream, so you can set up pipe
chains like so:


var r = fs.createReadStream('file.txt');
var z = zlib.createGzip();
var w = fs.createWriteStream('file.txt.gz');
r.pipe(z).pipe(w);



For example, emulating the Unix cat command:


process.stdin.pipe(process.stdout);



By default stream.end() is called on the destination when the
source stream emits 'end', so that destination is no longer writable.
Pass { end: false } as options to keep the destination stream open.


This keeps writer open so that "Goodbye" can be written at the
end.


reader.pipe(writer, { end: false });
reader.on('end', () => {
  writer.end('Goodbye\n');
});



Note that process.stderr and process.stdout are never closed until
the process exits, regardless of the specified options.


readable.read([size])#




The read() method pulls some data out of the internal buffer and
returns it. If there is no data available, then it will return
null.


If you pass in a size argument, then it will return that many
bytes. If size bytes are not available, then it will return null,
unless we've ended, in which case it will return the data remaining
in the buffer.


If you do not specify a size argument, then it will return all the
data in the internal buffer.


This method should only be called in paused mode. In flowing mode,
this method is called automatically until the internal buffer is
drained.


var readable = getReadableStreamSomehow();
readable.on('readable', () => {
  var chunk;
  while (null !== (chunk = readable.read())) {
    console.log('got %d bytes of data', chunk.length);
  }
});



If this method returns a data chunk, then it will also trigger the
emission of a 'data' event.


Note that calling stream.read([size]) after the 'end'
event has been triggered will return null. No runtime error will be raised.


readable.resume()#


    

  • Returns: this
    • 



This method will cause the readable stream to resume emitting 'data'
events.


This method will switch the stream into flowing mode. If you do not
want to consume the data from a stream, but you do want to get to
its 'end' event, you can call stream.resume() to open
the flow of data.


var readable = getReadableStreamSomehow();
readable.resume();
readable.on('end', () => {
  console.log('got to the end, but did not read anything');
});



readable.setEncoding(encoding)#


    

  • encoding <String> The encoding to use.
    • 

  • Returns: this
    • 



Call this function to cause the stream to return strings of the specified
encoding instead of Buffer objects. For example, if you do
readable.setEncoding('utf8'), then the output data will be interpreted as
UTF-8 data, and returned as strings. If you do readable.setEncoding('hex'),
then the data will be encoded in hexadecimal string format.


This properly handles multi-byte characters that would otherwise be
potentially mangled if you simply pulled the Buffers directly and
called buf.toString(encoding) on them. If you want to read the data
as strings, always use this method.


Also you can disable any encoding at all with readable.setEncoding(null).
This approach is very useful if you deal with binary data or with large
multi-byte strings spread out over multiple chunks.


var readable = getReadableStreamSomehow();
readable.setEncoding('utf8');
readable.on('data', (chunk) => {
  assert.equal(typeof chunk, 'string');
  console.log('got %d characters of string data', chunk.length);
});



readable.unpipe([destination])#




This method will remove the hooks set up for a previous stream.pipe()
call.


If the destination is not specified, then all pipes are removed.


If the destination is specified, but no pipe is set up for it, then
this is a no-op.


var readable = getReadableStreamSomehow();
var writable = fs.createWriteStream('file.txt');
// All the data from readable goes into 'file.txt',
// but only for the first second
readable.pipe(writable);
setTimeout(() => {
  console.log('stop writing to file.txt');
  readable.unpipe(writable);
  console.log('manually close the file stream');
  writable.end();
}, 1000);



readable.unshift(chunk)#




This is useful in certain cases where a stream is being consumed by a
parser, which needs to "un-consume" some data that it has
optimistically pulled out of the source, so that the stream can be
passed on to some other party.


Note that stream.unshift(chunk) cannot be called after the 'end' event
has been triggered; a runtime error will be raised.


If you find that you must often call stream.unshift(chunk) in your
programs, consider implementing a Transform stream instead. (See API
for Stream Implementors.)


// Pull off a header delimited by \n\n
// use unshift() if we get too much
// Call the callback with (error, header, stream)
const StringDecoder = require('string_decoder').StringDecoder;
function parseHeader(stream, callback) {
  stream.on('error', callback);
  stream.on('readable', onReadable);
  var decoder = new StringDecoder('utf8');
  var header = '';
  function onReadable() {
    var chunk;
    while (null !== (chunk = stream.read())) {
      var str = decoder.write(chunk);
      if (str.match(/\n\n/)) {
        // found the header boundary
        var split = str.split(/\n\n/);
        header += split.shift();
        var remaining = split.join('\n\n');
        var buf = new Buffer(remaining, 'utf8');
        if (buf.length)
          stream.unshift(buf);
        stream.removeListener('error', callback);
        stream.removeListener('readable', onReadable);
        // now the body of the message can be read from the stream.
        callback(null, header, stream);
      } else {
        // still reading the header.
        header += str;
      }
    }
  }
}



Note that, unlike stream.push(chunk), stream.unshift(chunk)
will not end the reading process by resetting the internal reading state of the
stream. This can cause unexpected results if unshift() is called during a
read (i.e. from within a stream._read() implementation on a
custom stream). Following the call to unshift() with an immediate
stream.push('') will reset the reading state appropriately,
however it is best to simply avoid calling unshift() while in the process of
performing a read.


readable.wrap(stream)#


    

  • stream <Stream> An "old style" readable stream
    • 



Versions of Node.js prior to v0.10 had streams that did not implement the
entire Streams API as it is today. (See Compatibility for
more information.)


If you are using an older Node.js library that emits 'data' events and
has a stream.pause() method that is advisory only, then you
can use the wrap() method to create a Readable stream that uses the old
stream as its data source.


You will very rarely ever need to call this function, but it exists
as a convenience for interacting with old Node.js programs and libraries.


For example:


const OldReader = require('./old-api-module.js').OldReader;
const Readable = require('stream').Readable;
const oreader = new OldReader;
const myReader = new Readable().wrap(oreader);

myReader.on('readable', () => {
  myReader.read(); // etc.
});



Class: stream.Transform#


Transform streams are Duplex streams where the output is in some way
computed from the input. They implement both the Readable and
Writable interfaces.


Examples of Transform streams include:



Class: stream.Writable#



The Writable stream interface is an abstraction for a destination
that you are writing data to.


Examples of writable streams include:



Event: 'close'#


Emitted when the stream and any of its underlying resources (a file descriptor,
for example) have been closed. The event indicates that no more events will be
emitted, and no further computation will occur.


Not all streams will emit the 'close' event as the 'close' event is
optional.


Event: 'drain'#


If a stream.write(chunk) call returns false, then the
'drain' event will indicate when it is appropriate to begin writing more data
to the stream.


// Write the data to the supplied writable stream one million times.
// Be attentive to back-pressure.
function writeOneMillionTimes(writer, data, encoding, callback) {
  var i = 1000000;
  write();
  function write() {
    var ok = true;
    do {
      i -= 1;
      if (i === 0) {
        // last time!
        writer.write(data, encoding, callback);
      } else {
        // see if we should continue, or wait
        // don't pass the callback, because we're not done yet.
        ok = writer.write(data, encoding);
      }
    } while (i > 0 && ok);
    if (i > 0) {
      // had to stop early!
      // write some more once it drains
      writer.once('drain', write);
    }
  }
}



Event: 'error'#




Emitted if there was an error when writing or piping data.


Event: 'finish'#


When the stream.end() method has been called, and all data has
been flushed to the underlying system, this event is emitted.


var writer = getWritableStreamSomehow();
for (var i = 0; i < 100; i ++) {
  writer.write('hello, #${i}!\n');
}
writer.end('this is the end\n');
writer.on('finish', () => {
  console.error('all writes are now complete.');
});



Event: 'pipe'#




This is emitted whenever the stream.pipe() method is called on a readable
stream, adding this writable to its set of destinations.


var writer = getWritableStreamSomehow();
var reader = getReadableStreamSomehow();
writer.on('pipe', (src) => {
  console.error('something is piping into the writer');
  assert.equal(src, reader);
});
reader.pipe(writer);



Event: 'unpipe'#




This is emitted whenever the stream.unpipe() method is called on a
readable stream, removing this writable from its set of destinations.


var writer = getWritableStreamSomehow();
var reader = getReadableStreamSomehow();
writer.on('unpipe', (src) => {
  console.error('something has stopped piping into the writer');
  assert.equal(src, reader);
});
reader.pipe(writer);
reader.unpipe(writer);



writable.cork()#


Forces buffering of all writes.


Buffered data will be flushed either at stream.uncork() or at
stream.end() call.


writable.end([chunk][, encoding][, callback])#


    

  • chunk <String> | <Buffer> Optional data to write
    • 

  • encoding <String> The encoding, if chunk is a String
    • 

  • callback <Function> Optional callback for when the stream is finished
    • 



Call this method when no more data will be written to the stream. If supplied,
the callback is attached as a listener on the 'finish' event.


Calling stream.write() after calling
stream.end() will raise an error.


// write 'hello, ' and then end with 'world!'
var file = fs.createWriteStream('example.txt');
file.write('hello, ');
file.end('world!');
// writing more now is not allowed!



writable.setDefaultEncoding(encoding)#


    

  • encoding <String> The new default encoding
    • 



Sets the default encoding for a writable stream.


writable.uncork()#


Flush all data, buffered since stream.cork() call.


writable.write(chunk[, encoding][, callback])#


    

  • chunk <String> | <Buffer> The data to write
    • 

  • encoding <String> The encoding, if chunk is a String
    • 

  • callback <Function> Callback for when this chunk of data is flushed
    • 

  • Returns: <Boolean> true if the data was handled completely.
    • 



This method writes some data to the underlying system, and calls the
supplied callback once the data has been fully handled.  If an error
occurs, the callback may or may not be called with the error as its
first argument.  To detect write errors, listen for the 'error' event.


The return value indicates if you should continue writing right now.
If the data had to be buffered internally, then it will return
false. Otherwise, it will return true.


This return value is strictly advisory. You MAY continue to write,
even if it returns false. However, writes will be buffered in
memory, so it is best not to do this excessively. Instead, wait for
the 'drain' event before writing more data.


API for Stream Implementors#



To implement any sort of stream, the pattern is the same:


    

  1. Extend the appropriate parent class in your own subclass. (The
util.inherits() method is particularly helpful for this.)
    2. 

  2. Call the appropriate parent class constructor in your constructor,
to be sure that the internal mechanisms are set up properly.
    3. 

  3. Implement one or more specific methods, as detailed below.
    4. 



The class to extend and the method(s) to implement depend on the sort
of stream class you are writing:



  
    

      
        
Use-case

      		
      
        
Class

      		
      
        
Method(s) to implement

      		
    

  
  

    
      
Reading only

    		
    
      
Readable

    		
    
      
_read

    		
  

  

    
      
Writing only

    		
    
      
Writable

    		
    
      
_write, _writev

    		
  

  

    
      
Reading and writing

    		
    
      
Duplex

    		
    
      
_read, _write, _writev

    		
  

  

    
      
Operate on written data, then read the result

    		
    
      
Transform

    		
    
      
_transform, _flush

    		
  





In your implementation code, it is very important to never call the methods
described in API for Stream Consumers. Otherwise, you can potentially cause
adverse side effects in programs that consume your streaming interfaces.


Class: stream.Duplex#



A "duplex" stream is one that is both Readable and Writable, such as a TCP
socket connection.


Note that stream.Duplex is an abstract class designed to be extended
with an underlying implementation of the stream._read(size)
and stream._write(chunk, encoding, callback) methods as you
would with a Readable or Writable stream class.


Since JavaScript doesn't have multiple prototypal inheritance, this class
prototypally inherits from Readable, and then parasitically from Writable. It is
thus up to the user to implement both the low-level
stream._read(n) method as well as the low-level
stream._write(chunk, encoding, callback) method on extension
duplex classes.


new stream.Duplex(options)#


    

  • options <Object> Passed to both Writable and Readable
constructors. Also has the following fields:
      

    • allowHalfOpen <Boolean> Default = true. If set to false, then
the stream will automatically end the readable side when the
writable side ends and vice versa.
      • 

    • readableObjectMode <Boolean> Default = false. Sets objectMode
for readable side of the stream. Has no effect if objectMode
is true.
      • 

    • writableObjectMode <Boolean> Default = false. Sets objectMode
for writable side of the stream. Has no effect if objectMode
is true.
      • 

    

    • 



In classes that extend the Duplex class, make sure to call the
constructor so that the buffering settings can be properly
initialized.


Class: stream.PassThrough#


This is a trivial implementation of a Transform stream that simply
passes the input bytes across to the output. Its purpose is mainly
for examples and testing, but there are occasionally use cases where
it can come in handy as a building block for novel sorts of streams.


Class: stream.Readable#



stream.Readable is an abstract class designed to be extended with an
underlying implementation of the stream._read(size) method.


Please see API for Stream Consumers for how to consume
streams in your programs. What follows is an explanation of how to
implement Readable streams in your programs.


new stream.Readable(options)#


    

  • options <Object>
      

    • highWaterMark <Number> The maximum number of bytes to store in
the internal buffer before ceasing to read from the underlying
resource. Default = 16384 (16kb), or 16 for objectMode streams
      • 

    • encoding <String> If specified, then buffers will be decoded to
strings using the specified encoding. Default = null
      • 

    • objectMode <Boolean> Whether this stream should behave
as a stream of objects. Meaning that stream.read(n) returns
a single value instead of a Buffer of size n. Default = false
      • 

    • read <Function> Implementation for the stream._read()
method.
      • 

    

    • 



In classes that extend the Readable class, make sure to call the
Readable constructor so that the buffering settings can be properly
initialized.


readable._read(size)#


    

  • size <Number> Number of bytes to read asynchronously
    • 



Note: Implement this method, but do NOT call it directly.


This method is prefixed with an underscore because it is internal to the
class that defines it and should only be called by the internal Readable
class methods. All Readable stream implementations must provide a _read
method to fetch data from the underlying resource.


When _read() is called, if data is available from the resource, the _read()
implementation should start pushing that data into the read queue by calling
this.push(dataChunk). _read() should continue reading from
the resource and pushing data until push returns false, at which point it
should stop reading from the resource. Only when _read() is called again after
it has stopped should it start reading more data from the resource and pushing
that data onto the queue.


Note: once the _read() method is called, it will not be called again until
the stream.push() method is called.


The size argument is advisory. Implementations where a "read" is a
single call that returns data can use this to know how much data to
fetch. Implementations where that is not relevant, such as TCP or
TLS, may ignore this argument, and simply provide data whenever it
becomes available. There is no need, for example to "wait" until
size bytes are available before calling stream.push(chunk).


readable.push(chunk[, encoding])#


    

  • chunk <Buffer> | <Null> | <String> Chunk of data to push into the read queue
    • 

  • encoding <String> Encoding of String chunks.  Must be a valid
Buffer encoding, such as 'utf8' or 'ascii'
    • 

  • return <Boolean> Whether or not more pushes should be performed
    • 



Note: This method should be called by Readable implementors, NOT
by consumers of Readable streams.


If a value other than null is passed, The push() method adds a chunk of data
into the queue for subsequent stream processors to consume. If null is
passed, it signals the end of the stream (EOF), after which no more data
can be written.


The data added with push() can be pulled out by calling the
stream.read() method when the 'readable' event fires.


This API is designed to be as flexible as possible. For example,
you may be wrapping a lower-level source which has some sort of
pause/resume mechanism, and a data callback. In those cases, you
could wrap the low-level source object by doing something like this:


// source is an object with readStop() and readStart() methods,
// and an `ondata` member that gets called when it has data, and
// an `onend` member that gets called when the data is over.

util.inherits(SourceWrapper, Readable);

function SourceWrapper(options) {
  Readable.call(this, options);

  this._source = getLowlevelSourceObject();

  // Every time there's data, we push it into the internal buffer.
  this._source.ondata = (chunk) => {
    // if push() returns false, then we need to stop reading from source
    if (!this.push(chunk))
      this._source.readStop();
  };

  // When the source ends, we push the EOF-signaling `null` chunk
  this._source.onend = () => {
    this.push(null);
  };
}

// _read will be called when the stream wants to pull more data in
// the advisory size argument is ignored in this case.
SourceWrapper.prototype._read = function(size) {
  this._source.readStart();
};



Example: A Counting Stream#



This is a basic example of a Readable stream. It emits the numerals
from 1 to 1,000,000 in ascending order, and then ends.


const Readable = require('stream').Readable;
const util = require('util');
util.inherits(Counter, Readable);

function Counter(opt) {
  Readable.call(this, opt);
  this._max = 1000000;
  this._index = 1;
}

Counter.prototype._read = function() {
  var i = this._index++;
  if (i > this._max)
    this.push(null);
  else {
    var str = '' + i;
    var buf = new Buffer(str, 'ascii');
    this.push(buf);
  }
};



Example: SimpleProtocol v1 (Sub-optimal)#


This is similar to the parseHeader function described
here, but implemented as a custom stream.
Also, note that this implementation does not convert the incoming data to a
string.


However, this would be better implemented as a Transform stream. See
SimpleProtocol v2 for a better implementation.


// A parser for a simple data protocol.
// The "header" is a JSON object, followed by 2 \n characters, and
// then a message body.
//
// NOTE: This can be done more simply as a Transform stream!
// Using Readable directly for this is sub-optimal. See the
// alternative example below under the Transform section.

const Readable = require('stream').Readable;
const util = require('util');

util.inherits(SimpleProtocol, Readable);

function SimpleProtocol(source, options) {
  if (!(this instanceof SimpleProtocol))
    return new SimpleProtocol(source, options);

  Readable.call(this, options);
  this._inBody = false;
  this._sawFirstCr = false;

  // source is a readable stream, such as a socket or file
  this._source = source;

  source.on('end', () => {
    this.push(null);
  });

  // give it a kick whenever the source is readable
  // read(0) will not consume any bytes
  source.on('readable', () => {
    this.read(0);
  });

  this._rawHeader = [];
  this.header = null;
}

SimpleProtocol.prototype._read = function(n) {
  if (!this._inBody) {
    var chunk = this._source.read();

    // if the source doesn't have data, we don't have data yet.
    if (chunk === null)
      return this.push('');

    // check if the chunk has a \n\n
    var split = -1;
    for (var i = 0; i < chunk.length; i++) {
      if (chunk[i] === 10) { // '\n'
        if (this._sawFirstCr) {
          split = i;
          break;
        } else {
          this._sawFirstCr = true;
        }
      } else {
        this._sawFirstCr = false;
      }
    }

    if (split === -1) {
      // still waiting for the \n\n
      // stash the chunk, and try again.
      this._rawHeader.push(chunk);
      this.push('');
    } else {
      this._inBody = true;
      var h = chunk.slice(0, split);
      this._rawHeader.push(h);
      var header = Buffer.concat(this._rawHeader).toString();
      try {
        this.header = JSON.parse(header);
      } catch (er) {
        this.emit('error', new Error('invalid simple protocol data'));
        return;
      }
      // now, because we got some extra data, unshift the rest
      // back into the read queue so that our consumer will see it.
      var b = chunk.slice(split);
      this.unshift(b);
      // calling unshift by itself does not reset the reading state
      // of the stream; since we're inside _read, doing an additional
      // push('') will reset the state appropriately.
      this.push('');

      // and let them know that we are done parsing the header.
      this.emit('header', this.header);
    }
  } else {
    // from there on, just provide the data to our consumer.
    // careful not to push(null), since that would indicate EOF.
    var chunk = this._source.read();
    if (chunk) this.push(chunk);
  }
};

// Usage:
// var parser = new SimpleProtocol(source);
// Now parser is a readable stream that will emit 'header'
// with the parsed header data.



Class: stream.Transform#


A "transform" stream is a duplex stream where the output is causally
connected in some way to the input, such as a zlib stream or a
crypto stream.


There is no requirement that the output be the same size as the input,
the same number of chunks, or arrive at the same time. For example, a
Hash stream will only ever have a single chunk of output which is
provided when the input is ended. A zlib stream will produce output
that is either much smaller or much larger than its input.


Rather than implement the stream._read() and
stream._write() methods, Transform classes must implement the
stream._transform() method, and may optionally
also implement the stream._flush() method. (See below.)


new stream.Transform(options)#




In classes that extend the Transform class, make sure to call the
constructor so that the buffering settings can be properly
initialized.


Events: 'finish' and 'end'#


The 'finish' and 'end' events are from the parent Writable
and Readable classes respectively. The 'finish' event is fired after
stream.end() is called and all chunks have been processed by
stream._transform(), 'end' is fired after all data has
been output which is after the callback in stream._flush()
has been called.


transform._flush(callback)#


    

  • callback <Function> Call this function (optionally with an error
argument) when you are done flushing any remaining data.
    • 



Note: This function MUST NOT be called directly.  It MAY be implemented
by child classes, and if so, will be called by the internal Transform
class methods only.


In some cases, your transform operation may need to emit a bit more
data at the end of the stream. For example, a Zlib compression
stream will store up some internal state so that it can optimally
compress the output. At the end, however, it needs to do the best it
can with what is left, so that the data will be complete.


In those cases, you can implement a _flush() method, which will be
called at the very end, after all the written data is consumed, but
before emitting 'end' to signal the end of the readable side. Just
like with stream._transform(), call
transform.push(chunk) zero or more times, as appropriate, and call callback
when the flush operation is complete.


This method is prefixed with an underscore because it is internal to
the class that defines it, and should not be called directly by user
programs. However, you are expected to override this method in
your own extension classes.


transform._transform(chunk, encoding, callback)#


    

  • chunk <Buffer> | <String> The chunk to be transformed. Will always
be a buffer unless the decodeStrings option was set to false.
    • 

  • encoding <String> If the chunk is a string, then this is the
encoding type. If chunk is a buffer, then this is the special
value - 'buffer', ignore it in this case.
    • 

  • callback <Function> Call this function (optionally with an error
argument and data) when you are done processing the supplied chunk.
    • 



Note: This function MUST NOT be called directly.  It should be
implemented by child classes, and called by the internal Transform
class methods only.


All Transform stream implementations must provide a _transform()
method to accept input and produce output.


_transform() should do whatever has to be done in this specific
Transform class, to handle the bytes being written, and pass them off
to the readable portion of the interface. Do asynchronous I/O,
process things, and so on.


Call transform.push(outputChunk) 0 or more times to generate output
from this input chunk, depending on how much data you want to output
as a result of this chunk.


Call the callback function only when the current chunk is completely
consumed. Note that there may or may not be output as a result of any
particular input chunk. If you supply a second argument to the callback
it will be passed to the push method. In other words the following are
equivalent:


transform.prototype._transform = function (data, encoding, callback) {
  this.push(data);
  callback();
};

transform.prototype._transform = function (data, encoding, callback) {
  callback(null, data);
};



This method is prefixed with an underscore because it is internal to
the class that defines it, and should not be called directly by user
programs. However, you are expected to override this method in
your own extension classes.


Example: SimpleProtocol parser v2#


The example here of a simple
protocol parser can be implemented simply by using the higher level
Transform stream class, similar to the parseHeader and SimpleProtocol
v1 examples.


In this example, rather than providing the input as an argument, it
would be piped into the parser, which is a more idiomatic Node.js stream
approach.


const util = require('util');
const Transform = require('stream').Transform;
util.inherits(SimpleProtocol, Transform);

function SimpleProtocol(options) {
  if (!(this instanceof SimpleProtocol))
    return new SimpleProtocol(options);

  Transform.call(this, options);
  this._inBody = false;
  this._sawFirstCr = false;
  this._rawHeader = [];
  this.header = null;
}

SimpleProtocol.prototype._transform = function(chunk, encoding, done) {
  if (!this._inBody) {
    // check if the chunk has a \n\n
    var split = -1;
    for (var i = 0; i < chunk.length; i++) {
      if (chunk[i] === 10) { // '\n'
        if (this._sawFirstCr) {
          split = i;
          break;
        } else {
          this._sawFirstCr = true;
        }
      } else {
        this._sawFirstCr = false;
      }
    }

    if (split === -1) {
      // still waiting for the \n\n
      // stash the chunk, and try again.
      this._rawHeader.push(chunk);
    } else {
      this._inBody = true;
      var h = chunk.slice(0, split);
      this._rawHeader.push(h);
      var header = Buffer.concat(this._rawHeader).toString();
      try {
        this.header = JSON.parse(header);
      } catch (er) {
        this.emit('error', new Error('invalid simple protocol data'));
        return;
      }
      // and let them know that we are done parsing the header.
      this.emit('header', this.header);

      // now, because we got some extra data, emit this first.
      this.push(chunk.slice(split));
    }
  } else {
    // from there on, just provide the data to our consumer as-is.
    this.push(chunk);
  }
  done();
};

// Usage:
// var parser = new SimpleProtocol();
// source.pipe(parser)
// Now parser is a readable stream that will emit 'header'
// with the parsed header data.



Class: stream.Writable#



stream.Writable is an abstract class designed to be extended with an
underlying implementation of the
stream._write(chunk, encoding, callback) method.


Please see API for Stream Consumers for how to consume
writable streams in your programs. What follows is an explanation of
how to implement Writable streams in your programs.


new stream.Writable(options)#




In classes that extend the Writable class, make sure to call the
constructor so that the buffering settings can be properly
initialized.


writable._write(chunk, encoding, callback)#


    

  • chunk <Buffer> | <String> The chunk to be written. Will always
be a buffer unless the decodeStrings option was set to false.
    • 

  • encoding <String> If the chunk is a string, then this is the
encoding type. If chunk is a buffer, then this is the special
value - 'buffer', ignore it in this case.
    • 

  • callback <Function> Call this function (optionally with an error
argument) when you are done processing the supplied chunk.
    • 



All Writable stream implementations must provide a
stream._write() method to send data to the underlying
resource.


Note: This function MUST NOT be called directly.  It should be
implemented by child classes, and called by the internal Writable
class methods only.


Call the callback using the standard callback(error) pattern to
signal that the write completed successfully or with an error.


If the decodeStrings flag is set in the constructor options, then
chunk may be a string rather than a Buffer, and encoding will
indicate the sort of string that it is. This is to support
implementations that have an optimized handling for certain string
data encodings. If you do not explicitly set the decodeStrings
option to false, then you can safely ignore the encoding argument,
and assume that chunk will always be a Buffer.


This method is prefixed with an underscore because it is internal to
the class that defines it, and should not be called directly by user
programs. However, you are expected to override this method in
your own extension classes.


writable._writev(chunks, callback)#


    

  • chunks <Array> The chunks to be written. Each chunk has following
format: { chunk: ..., encoding: ... }.
    • 

  • callback <Function> Call this function (optionally with an error
argument) when you are done processing the supplied chunks.
    • 



Note: This function MUST NOT be called directly.  It may be
implemented by child classes, and called by the internal Writable
class methods only.


This function is completely optional to implement. In most cases it is
unnecessary. If implemented, it will be called with all the chunks
that are buffered in the write queue.


Simplified Constructor API#



In simple cases there is now the added benefit of being able to construct a
stream without inheritance.


This can be done by passing the appropriate methods as constructor options:


Examples:


Duplex#


var duplex = new stream.Duplex({
  read: function(n) {
    // sets this._read under the hood

    // push data onto the read queue, passing null
    // will signal the end of the stream (EOF)
    this.push(chunk);
  },
  write: function(chunk, encoding, next) {
    // sets this._write under the hood

    // An optional error can be passed as the first argument
    next()
  }
});

// or

var duplex = new stream.Duplex({
  read: function(n) {
    // sets this._read under the hood

    // push data onto the read queue, passing null
    // will signal the end of the stream (EOF)
    this.push(chunk);
  },
  writev: function(chunks, next) {
    // sets this._writev under the hood

    // An optional error can be passed as the first argument
    next()
  }
});



Readable#


var readable = new stream.Readable({
  read: function(n) {
    // sets this._read under the hood

    // push data onto the read queue, passing null
    // will signal the end of the stream (EOF)
    this.push(chunk);
  }
});



Transform#


var transform = new stream.Transform({
  transform: function(chunk, encoding, next) {
    // sets this._transform under the hood

    // generate output as many times as needed
    // this.push(chunk);

    // call when the current chunk is consumed
    next();
  },
  flush: function(done) {
    // sets this._flush under the hood

    // generate output as many times as needed
    // this.push(chunk);

    done();
  }
});



Writable#


var writable = new stream.Writable({
  write: function(chunk, encoding, next) {
    // sets this._write under the hood

    // An optional error can be passed as the first argument
    next()
  }
});

// or

var writable = new stream.Writable({
  writev: function(chunks, next) {
    // sets this._writev under the hood

    // An optional error can be passed as the first argument
    next()
  }
});



Streams: Under the Hood#



Buffering#



Both Writable and Readable streams will buffer data on an internal
object which can be retrieved from _writableState.getBuffer() or
_readableState.buffer, respectively.


The amount of data that will potentially be buffered depends on the
highWaterMark option which is passed into the constructor.


Buffering in Readable streams happens when the implementation calls
stream.push(chunk). If the consumer of the Stream does not
call stream.read(), then the data will sit in the internal
queue until it is consumed.


Buffering in Writable streams happens when the user calls
stream.write(chunk) repeatedly, even when it returns false.


The purpose of streams, especially with the stream.pipe() method, is to
limit the buffering of data to acceptable levels, so that sources and
destinations of varying speed will not overwhelm the available memory.


Compatibility with Older Node.js Versions#



In versions of Node.js prior to v0.10, the Readable stream interface was
simpler, but also less powerful and less useful.


    

  • Rather than waiting for you to call the stream.read() method,
'data' events would start emitting immediately. If you needed to do
some I/O to decide how to handle data, then you had to store the chunks
in some kind of buffer so that they would not be lost.
    • 

  • The stream.pause() method was advisory, rather than
guaranteed. This meant that you still had to be prepared to receive
'data' events even when the stream was in a paused state.
    • 



In Node.js v0.10, the Readable class was added.
For backwards compatibility with older Node.js programs, Readable streams
switch into "flowing mode" when a 'data' event handler is added, or
when the stream.resume() method is called. The effect is
that, even if you are not using the new stream.read() method
and 'readable' event, you no longer have to worry about losing
'data' chunks.


Most programs will continue to function normally. However, this
introduces an edge case in the following conditions:


    

  • No 'data' event handler is added.
    • 

  • The stream.resume() method is never called.
    • 

  • The stream is not piped to any writable destination.
    • 



For example, consider the following code:


// WARNING!  BROKEN!
net.createServer((socket) => {

  // we add an 'end' method, but never consume the data
  socket.on('end', () => {
    // It will never get here.
    socket.end('I got your message (but didnt read it)\n');
  });

}).listen(1337);



In versions of Node.js prior to v0.10, the incoming message data would be
simply discarded. However, in Node.js v0.10 and beyond,
the socket will remain paused forever.


The workaround in this situation is to call the
stream.resume() method to start the flow of data:


// Workaround
net.createServer((socket) => {

  socket.on('end', () => {
    socket.end('I got your message (but didnt read it)\n');
  });

  // start the flow of data, discarding it.
  socket.resume();

}).listen(1337);



In addition to new Readable streams switching into flowing mode,
pre-v0.10 style streams can be wrapped in a Readable class using the
stream.wrap() method.


Object Mode#



Normally, Streams operate on Strings and Buffers exclusively.


Streams that are in object mode can emit generic JavaScript values
other than Buffers and Strings.


A Readable stream in object mode will always return a single item from
a call to stream.read(size), regardless of what the size
argument is.


A Writable stream in object mode will always ignore the encoding
argument to stream.write(data, encoding).


The special value null still retains its special value for object
mode streams. That is, for object mode readable streams, null as a
return value from stream.read() indicates that there is no more
data, and stream.push(null) will signal the end of stream data
(EOF).


No streams in Node.js core are object mode streams. This pattern is only
used by userland streaming libraries.


You should set objectMode in your stream child class constructor on
the options object. Setting objectMode mid-stream is not safe.


For Duplex streams objectMode can be set exclusively for readable or
writable side with readableObjectMode and writableObjectMode
respectively. These options can be used to implement parsers and
serializers with Transform streams.


const util = require('util');
const StringDecoder = require('string_decoder').StringDecoder;
const Transform = require('stream').Transform;
util.inherits(JSONParseStream, Transform);

// Gets \n-delimited JSON string data, and emits the parsed objects
function JSONParseStream() {
  if (!(this instanceof JSONParseStream))
    return new JSONParseStream();

  Transform.call(this, { readableObjectMode : true });

  this._buffer = '';
  this._decoder = new StringDecoder('utf8');
}

JSONParseStream.prototype._transform = function(chunk, encoding, cb) {
  this._buffer += this._decoder.write(chunk);
  // split on newlines
  var lines = this._buffer.split(/\r?\n/);
  // keep the last partial line buffered
  this._buffer = lines.pop();
  for (var l = 0; l < lines.length; l++) {
    var line = lines[l];
    try {
      var obj = JSON.parse(line);
    } catch (er) {
      this.emit('error', er);
      return;
    }
    // push the parsed object out to the readable consumer
    this.push(obj);
  }
  cb();
};

JSONParseStream.prototype._flush = function(cb) {
  // Just handle any leftover
  var rem = this._buffer.trim();
  if (rem) {
    try {
      var obj = JSON.parse(rem);
    } catch (er) {
      this.emit('error', er);
      return;
    }
    // push the parsed object out to the readable consumer
    this.push(obj);
  }
  cb();
};



stream.read(0)#


There are some cases where you want to trigger a refresh of the
underlying readable stream mechanisms, without actually consuming any
data. In that case, you can call stream.read(0), which will always
return null.


If the internal read buffer is below the highWaterMark, and the
stream is not currently reading, then calling stream.read(0) will trigger
a low-level stream._read() call.


There is almost never a need to do this. However, you will see some
cases in Node.js's internals where this is done, particularly in the
Readable stream class internals.


stream.push('')#


Pushing a zero-byte string or Buffer (when not in Object mode) has an
interesting side effect. Because it is a call to
stream.push(), it will end the reading process. However, it
does not add any data to the readable buffer, so there's nothing for
a user to consume.


Very rarely, there are cases where you have no data to provide now,
but the consumer of your stream (or, perhaps, another bit of your own
code) will know when to check again, by calling stream.read(0).
In those cases, you may call stream.push('').


So far, the only use case for this functionality is in the
tls.CryptoStream class, which is deprecated in Node.js/io.js v1.0. If you
find that you have to use stream.push(''), please consider another
approach, because it almost certainly indicates that something is
horribly wrong.




String Decoder#


Stability: 2 - Stable
To use this module, do require('string_decoder'). StringDecoder decodes a
buffer to a string. It is a simple interface to buffer.toString() but provides
additional support for utf8.


const StringDecoder = require('string_decoder').StringDecoder;
const decoder = new StringDecoder('utf8');

const cent = new Buffer([0xC2, 0xA2]);
console.log(decoder.write(cent));

const euro = new Buffer([0xE2, 0x82, 0xAC]);
console.log(decoder.write(euro));



Class: StringDecoder#



Added in: v0.1.99

Accepts a single argument, encoding which defaults to 'utf8'.


decoder.end()#



Added in: v0.9.3

Returns any trailing bytes that were left in the buffer.


decoder.write(buffer)#



Added in: v0.1.99

Returns a decoded string.




Timers#


Stability: 3 - Locked
All of the timer functions are globals.  You do not need to require()
this module in order to use them.


clearImmediate(immediateObject)#



Added in: v0.9.1

Stops an immediateObject, as created by setImmediate, from triggering.


clearInterval(intervalObject)#



Added in: v0.0.1

Stops an intervalObject, as created by setInterval, from triggering.


clearTimeout(timeoutObject)#



Added in: v0.0.1

Prevents a timeoutObject, as created by setTimeout, from triggering.


ref()#



Added in: v0.9.1

If a timer was previously unref()d, then ref() can be called to explicitly
request the timer hold the program open. If the timer is already refd calling
ref again will have no effect.


Returns the timer.


setImmediate(callback[, arg][, ...])#



Added in: v0.9.1

Schedules "immediate" execution of callback after I/O events'
callbacks and before timers set by setTimeout and setInterval are
triggered. Returns an immediateObject for possible use with
clearImmediate. Additional optional arguments may be passed to the
callback.


Callbacks for immediates are queued in the order in which they were created.
The entire callback queue is processed every event loop iteration. If an
immediate is queued from inside an executing callback, that immediate won't fire
until the next event loop iteration.


setInterval(callback, delay[, arg][, ...])#



Added in: v0.0.1

Schedules repeated execution of callback every delay milliseconds.
Returns a intervalObject for possible use with clearInterval. Additional
optional arguments may be passed to the callback.


To follow browser behavior, when using delays larger than 2147483647
milliseconds (approximately 25 days) or less than 1, Node.js will use 1 as the
delay.


setTimeout(callback, delay[, arg][, ...])#



Added in: v0.0.1

Schedules execution of a one-time callback after delay milliseconds.
Returns a timeoutObject for possible use with clearTimeout. Additional
optional arguments may be passed to the callback.


The callback will likely not be invoked in precisely delay milliseconds.
Node.js makes no guarantees about the exact timing of when callbacks will fire,
nor of their ordering. The callback will be called as close as possible to the
time specified.


To follow browser behavior, when using delays larger than 2147483647
milliseconds (approximately 25 days) or less than 1, the timeout is executed
immediately, as if the delay was set to 1.


unref()#



Added in: v0.9.1

The opaque value returned by setTimeout and setInterval also has the
method timer.unref() which allows the creation of a timer that is active but
if it is the only item left in the event loop, it won't keep the program
running. If the timer is already unrefd calling unref again will have no
effect.


In the case of setTimeout, unref creates a separate timer that will
wakeup the event loop, creating too many of these may adversely effect event
loop performance -- use wisely.


Returns the timer.




TLS (SSL)#


Stability: 2 - Stable
Use require('tls') to access this module.


The tls module uses OpenSSL to provide Transport Layer Security and/or
Secure Socket Layer: encrypted stream communication.


TLS/SSL is a public/private key infrastructure. Each client and each
server must have a private key. A private key is created like this:


openssl genrsa -out ryans-key.pem 2048

All servers and some clients need to have a certificate. Certificates are public
keys signed by a Certificate Authority or self-signed. The first step to
getting a certificate is to create a "Certificate Signing Request" (CSR)
file. This is done with:


openssl req -new -sha256 -key ryans-key.pem -out ryans-csr.pem

To create a self-signed certificate with the CSR, do this:


openssl x509 -req -in ryans-csr.pem -signkey ryans-key.pem -out ryans-cert.pem

Alternatively you can send the CSR to a Certificate Authority for signing.


For Perfect Forward Secrecy, it is required to generate Diffie-Hellman
parameters:


openssl dhparam -outform PEM -out dhparam.pem 2048

To create .pfx or .p12, do this:


openssl pkcs12 -export -in agent5-cert.pem -inkey agent5-key.pem \
      -certfile ca-cert.pem -out agent5.pfx

    

  • in:  certificate
    • 

  • inkey: private key
    • 

  • certfile: all CA certs concatenated in one file like
cat ca1-cert.pem ca2-cert.pem > ca-cert.pem
    • 



Client-initiated renegotiation attack mitigation#



The TLS protocol lets the client renegotiate certain aspects of the TLS session.
Unfortunately, session renegotiation requires a disproportional amount of
server-side resources, which makes it a potential vector for denial-of-service
attacks.


To mitigate this, renegotiations are limited to three times every 10 minutes. An
error is emitted on the tls.TLSSocket instance when the threshold is
exceeded. The limits are configurable:


    

  • tls.CLIENT_RENEG_LIMIT: renegotiation limit, default is 3.
    

    • 

  • tls.CLIENT_RENEG_WINDOW: renegotiation window in seconds, default is
10 minutes.
    

    • 



Don't change the defaults unless you know what you are doing.


To test your server, connect to it with openssl s_client -connect address:port
and tap R<CR> (that's the letter R followed by a carriage return) a few
times.


Modifying the Default TLS Cipher suite#


Node.js is built with a default suite of enabled and disabled TLS ciphers.
Currently, the default cipher suite is:


ECDHE-RSA-AES128-GCM-SHA256:
ECDHE-ECDSA-AES128-GCM-SHA256:
ECDHE-RSA-AES256-GCM-SHA384:
ECDHE-ECDSA-AES256-GCM-SHA384:
DHE-RSA-AES128-GCM-SHA256:
ECDHE-RSA-AES128-SHA256:
DHE-RSA-AES128-SHA256:
ECDHE-RSA-AES256-SHA384:
DHE-RSA-AES256-SHA384:
ECDHE-RSA-AES256-SHA256:
DHE-RSA-AES256-SHA256:
HIGH:
!aNULL:
!eNULL:
!EXPORT:
!DES:
!RC4:
!MD5:
!PSK:
!SRP:
!CAMELLIA

This default can be overriden entirely using the --tls-cipher-list command
line switch. For instance, the following makes
ECDHE-RSA-AES128-GCM-SHA256:!RC4 the default TLS cipher suite:


node --tls-cipher-list="ECDHE-RSA-AES128-GCM-SHA256:!RC4"

Note that the default cipher suite included within Node.js has been carefully
selected to reflect current security best practices and risk mitigation.
Changing the default cipher suite can have a significant impact on the security
of an application. The --tls-cipher-list switch should by used only if
absolutely necessary.


ALPN, NPN and SNI#



ALPN (Application-Layer Protocol Negotiation Extension), NPN (Next
Protocol Negotiation) and SNI (Server Name Indication) are TLS
handshake extensions allowing you:


    

  • ALPN/NPN - to use one TLS server for multiple protocols (HTTP, SPDY, HTTP/2)
    • 

  • SNI - to use one TLS server for multiple hostnames with different SSL
certificates.
    • 



Perfect Forward Secrecy#



The term "Forward Secrecy" or "Perfect Forward Secrecy" describes a feature of
key-agreement (i.e. key-exchange) methods. Practically it means that even if the
private key of a (your) server is compromised, communication can only be
decrypted by eavesdroppers if they manage to obtain the key-pair specifically
generated for each session.


This is achieved by randomly generating a key pair for key-agreement on every
handshake (in contrary to the same key for all sessions). Methods implementing
this technique, thus offering Perfect Forward Secrecy, are called "ephemeral".


Currently two methods are commonly used to achieve Perfect Forward Secrecy (note
the character "E" appended to the traditional abbreviations):


    

  • DHE - An ephemeral version of the Diffie Hellman key-agreement protocol.
    • 

  • ECDHE - An ephemeral version of the Elliptic Curve Diffie Hellman
key-agreement protocol.
    • 



Ephemeral methods may have some performance drawbacks, because key generation
is expensive.


Class: CryptoStream#


Stability: 0 - Deprecated: Use tls.TLSSocket instead.
This is an encrypted stream.


cryptoStream.bytesWritten#


A proxy to the underlying socket's bytesWritten accessor, this will return
the total bytes written to the socket, including the TLS overhead.


Class: SecurePair#


Returned by tls.createSecurePair.


Event: 'secure'#


The event is emitted from the SecurePair once the pair has successfully
established a secure connection.


Similarly to the checking for the server 'secureConnection' event,
pair.cleartext.authorized should be checked to confirm whether the certificate
used properly authorized.


Class: tls.Server#



Added in: v0.3.2

This class is a subclass of net.Server and has the same methods on it.
Instead of accepting just raw TCP connections, this accepts encrypted
connections using TLS or SSL.


Event: 'clientError'#



Added in: v0.11.11

function (exception, tlsSocket) { }


When a client connection emits an 'error' event before a secure connection is
established it will be forwarded here.


tlsSocket is the tls.TLSSocket that the error originated from.


Event: 'newSession'#



Added in: v0.9.2

function (sessionId, sessionData, callback) { }


Emitted on creation of TLS session. May be used to store sessions in external
storage. callback must be invoked eventually, otherwise no data will be
sent or received from secure connection.


NOTE: adding this event listener will have an effect only on connections
established after addition of event listener.


Event: 'OCSPRequest'#



Added in: v0.11.13

function (certificate, issuer, callback) { }


Emitted when the client sends a certificate status request. You could parse
server's current certificate to obtain OCSP url and certificate id, and after
obtaining OCSP response invoke callback(null, resp), where resp is a
Buffer instance. Both certificate and issuer are a Buffer
DER-representations of the primary and issuer's certificates. They could be used
to obtain OCSP certificate id and OCSP endpoint url.


Alternatively, callback(null, null) could be called, meaning that there is no
OCSP response.


Calling callback(err) will result in a socket.destroy(err) call.


Typical flow:


    

  1. Client connects to server and sends 'OCSPRequest' to it (via status info
extension in ClientHello.)
    2. 

  2. Server receives request and invokes 'OCSPRequest' event listener if present
    3. 

  3. Server grabs OCSP url from either certificate or issuer and performs an
OCSP request to the CA
    4. 

  4. Server receives OCSPResponse from CA and sends it back to client via
callback argument
    5. 

  5. Client validates the response and either destroys socket or performs a
handshake.
    6. 



NOTE: issuer could be null, if the certificate is self-signed or if the issuer
is not in the root certificates list. (You could provide an issuer via ca
option.)


NOTE: adding this event listener will have an effect only on connections
established after addition of event listener.


NOTE: you may want to use some npm module like asn1.js to parse the
certificates.


Event: 'resumeSession'#



Added in: v0.9.2

function (sessionId, callback) { }


Emitted when client wants to resume previous TLS session. Event listener may
perform lookup in external storage using given sessionId, and invoke
callback(null, sessionData) once finished. If session can't be resumed
(i.e. doesn't exist in storage) one may call callback(null, null). Calling
callback(err) will terminate incoming connection and destroy socket.


NOTE: adding this event listener will have an effect only on connections
established after addition of event listener.


Here's an example for using TLS session resumption:


var tlsSessionStore = {};
server.on('newSession', (id, data, cb) => {
  tlsSessionStore[id.toString('hex')] = data;
  cb();
});
server.on('resumeSession', (id, cb) => {
  cb(null, tlsSessionStore[id.toString('hex')] || null);
});



Event: 'secureConnection'#



Added in: v0.3.2

function (tlsSocket) {}


This event is emitted after a new connection has been successfully
handshaked. The argument is an instance of tls.TLSSocket. It has all the
common stream methods and events.


socket.authorized is a boolean value which indicates if the
client has verified by one of the supplied certificate authorities for the
server. If socket.authorized is false, then
socket.authorizationError is set to describe how authorization
failed. Implied but worth mentioning: depending on the settings of the TLS
server, you unauthorized connections may be accepted.


socket.npnProtocol is a string containing the selected NPN protocol
and socket.alpnProtocol is a string containing the selected ALPN
protocol, When both NPN and ALPN extensions are received, ALPN takes
precedence over NPN and the next protocol is selected by ALPN. When
ALPN has no selected protocol, this returns false.


socket.servername is a string containing servername requested with
SNI.


server.addContext(hostname, context)#



Added in: v0.5.3

Add secure context that will be used if client request's SNI hostname is
matching passed hostname (wildcards can be used). context can contain
key, cert, ca and/or any other properties from
tls.createSecureContext() options argument.


server.address()#



Added in: v0.6.0

Returns the bound address, the address family name and port of the
server as reported by the operating system.  See net.Server.address() for
more information.


server.close([callback])#



Added in: v0.3.2

Stops the server from accepting new connections. This function is
asynchronous, the server is finally closed when the server emits a 'close'
event.  Optionally, you can pass a callback to listen for the 'close' event.


server.connections#



Added in: v0.3.2

The number of concurrent connections on the server.


server.getTicketKeys()#



Added in: v3.0.0

Returns Buffer instance holding the keys currently used for
encryption/decryption of the TLS Session Tickets


server.listen(port[, hostname][, callback])#



Added in: v0.3.2

Begin accepting connections on the specified port and hostname. If the
hostname is omitted, the server will accept connections on any IPv6 address
(::) when IPv6 is available, or any IPv4 address (0.0.0.0) otherwise. A
port value of zero will assign a random port.


This function is asynchronous. The last parameter callback will be called
when the server has been bound.


See net.Server for more information.


server.maxConnections#



Added in: v0.2.0

Set this property to reject connections when the server's connection count
gets high.


server.setTicketKeys(keys)#



Added in: v3.0.0

Updates the keys for encryption/decryption of the TLS Session Tickets.


NOTE: the buffer should be 48 bytes long. See server ticketKeys option for
more information oh how it is going to be used.


NOTE: the change is effective only for the future server connections. Existing
or currently pending server connections will use previous keys.


Class: tls.TLSSocket#



Added in: v0.11.4

This is a wrapped version of net.Socket that does transparent encryption
of written data and all required TLS negotiation.


This instance implements a duplex Stream interfaces.  It has all the
common stream methods and events.


Methods that return TLS connection meta data (e.g.
tls.TLSSocket.getPeerCertificate() will only return data while the
connection is open.


new tls.TLSSocket(socket[, options])#



Added in: v0.11.4

Construct a new TLSSocket object from existing TCP socket.


socket is an instance of net.Socket


options is an optional object that might contain following properties:


    

  • secureContext: An optional TLS context object from
 tls.createSecureContext()
    

    • 

  • isServer: If true the TLS socket will be instantiated in server-mode.
Default: false
    

    • 

  • server: An optional net.Server instance
    

    • 

  • requestCert: Optional, see tls.createSecurePair()
    

    • 

  • rejectUnauthorized: Optional, see tls.createSecurePair()
    

    • 

  • NPNProtocols: Optional, see tls.createServer()
    

    • 

  • ALPNProtocols: Optional, see [tls.createServer][]
    

    • 

  • SNICallback: Optional, see tls.createServer()
    

    • 

  • session: Optional, a Buffer instance, containing TLS session
    

    • 

  • requestOCSP: Optional, if true the OCSP status request extension will
be added to the client hello, and an 'OCSPResponse' event will be emitted
on the socket before establishing a secure communication
    

    • 



Event: 'OCSPResponse'#



Added in: v0.11.13

function (response) { }


This event will be emitted if requestOCSP option was set. response is a
buffer object, containing server's OCSP response.


Traditionally, the response is a signed object from the server's CA that
contains information about server's certificate revocation status.


Event: 'secureConnect'#



Added in: v0.11.4

This event is emitted after a new connection has been successfully handshaked.
The listener will be called no matter if the server's certificate was
authorized or not. It is up to the user to test tlsSocket.authorized
to see if the server certificate was signed by one of the specified CAs.
If tlsSocket.authorized === false then the error can be found in
tlsSocket.authorizationError. Also if ALPN or NPN was used - you can
check tlsSocket.alpnProtocol or tlsSocket.npnProtocol for the
negotiated protocol.


tlsSocket.address()#



Added in: v0.11.4

Returns the bound address, the address family name and port of the
underlying socket as reported by the operating system. Returns an
object with three properties, e.g.
{ port: 12346, family: 'IPv4', address: '127.0.0.1' }


tlsSocket.authorized#



Added in: v0.11.4

A boolean that is true if the peer certificate was signed by one of the
specified CAs, otherwise false


tlsSocket.authorizationError#



Added in: v0.11.4

The reason why the peer's certificate has not been verified. This property
becomes available only when tlsSocket.authorized === false.


tlsSocket.encrypted#



Added in: v0.11.4

Static boolean value, always true. May be used to distinguish TLS sockets
from regular ones.


tlsSocket.getCipher()#



Added in: v0.11.4

Returns an object representing the cipher name and the SSL/TLS
protocol version of the current connection.


Example:
<name: 'AES256-SHA', version: 'TLSv1/SSLv3'>


See SSL_CIPHER_get_name() and SSL_CIPHER_get_version() in
https://www.openssl.org/docs/ssl/ssl.html#DEALING-WITH-CIPHERS for more
information.


tlsSocket.getPeerCertificate([ detailed ])#



Added in: v0.11.4

Returns an object representing the peer's certificate. The returned object has
some properties corresponding to the field of the certificate. If detailed
argument is true the full chain with issuer property will be returned,
if false only the top certificate without issuer property.


Example:


{ subject:
   { C: 'UK',
     ST: 'Acknack Ltd',
     L: 'Rhys Jones',
     O: 'node.js',
     OU: 'Test TLS Certificate',
     CN: 'localhost' },
  issuerInfo:
   { C: 'UK',
     ST: 'Acknack Ltd',
     L: 'Rhys Jones',
     O: 'node.js',
     OU: 'Test TLS Certificate',
     CN: 'localhost' },
  issuer:
   { ... another certificate ... },
  raw: < RAW DER buffer >,
  valid_from: 'Nov 11 09:52:22 2009 GMT',
  valid_to: 'Nov  6 09:52:22 2029 GMT',
  fingerprint: '2A:7A:C2:DD:E5:F9:CC:53:72:35:99:7A:02:5A:71:38:52:EC:8A:DF',
  serialNumber: 'B9B0D332A1AA5635' }

If the peer does not provide a certificate, it returns null or an empty
object.


tlsSocket.getSession()#



Added in: v0.11.4

Return ASN.1 encoded TLS session or undefined if none was negotiated. Could
be used to speed up handshake establishment when reconnecting to the server.


tlsSocket.getTLSTicket()#



Added in: v0.11.4

NOTE: Works only with client TLS sockets. Useful only for debugging, for
session reuse provide session option to tls.connect().


Return TLS session ticket or undefined if none was negotiated.


tlsSocket.localPort#



Added in: v0.11.4

The numeric representation of the local port.


tlsSocket.localAddress#



Added in: v0.11.4

The string representation of the local IP address.


tlsSocket.remoteAddress#



Added in: v0.11.4

The string representation of the remote IP address. For example,
'74.125.127.100' or '2001:4860:a005::68'.


tlsSocket.remoteFamily#



Added in: v0.11.4

The string representation of the remote IP family. 'IPv4' or 'IPv6'.


tlsSocket.remotePort#



Added in: v0.11.4

The numeric representation of the remote port. For example, 443.


tlsSocket.renegotiate(options, callback)#



Added in: v0.11.8

Initiate TLS renegotiation process. The options may contain the following
fields: rejectUnauthorized, requestCert (See tls.createServer() for
details). callback(err) will be executed with null as err,
once the renegotiation is successfully completed.


NOTE: Can be used to request peer's certificate after the secure connection
has been established.


ANOTHER NOTE: When running as the server, socket will be destroyed
with an error after handshakeTimeout timeout.


tlsSocket.setMaxSendFragment(size)#



Added in: v0.11.11

Set maximum TLS fragment size (default and maximum value is: 16384, minimum
is: 512). Returns true on success, false otherwise.


Smaller fragment size decreases buffering latency on the client: large
fragments are buffered by the TLS layer until the entire fragment is received
and its integrity is verified; large fragments can span multiple roundtrips,
and their processing can be delayed due to packet loss or reordering. However,
smaller fragments add extra TLS framing bytes and CPU overhead, which may
decrease overall server throughput.


tls.connect(options[, callback])#


tls.connect(port[, host][, options][, callback])#



Added in: v0.11.3

Creates a new client connection to the given port and host (old API) or
options.port and options.host. (If host is omitted, it defaults to
localhost.) options should be an object which specifies:


    

  • host: Host the client should connect to
    

    • 

  • port: Port the client should connect to
    

    • 

  • socket: Establish secure connection on a given socket rather than
creating a new socket. If this option is specified, host and port
are ignored.
    

    • 

  • path: Creates unix socket connection to path. If this option is
specified, host and port are ignored.
    

    • 

  • pfx: A string or Buffer containing the private key, certificate and
CA certs of the client in PFX or PKCS12 format.
    

    • 

  • key: A string or Buffer containing the private key of the client in
PEM format. (Could be an array of keys).
    

    • 

  • passphrase: A string of passphrase for the private key or pfx.
    

    • 

  • cert: A string or Buffer containing the certificate key of the client in
PEM format. (Could be an array of certs).
    

    • 

  • ca: A string, Buffer or array of strings or Buffers of trusted
certificates in PEM format. If this is omitted several well known "root"
CAs will be used, like VeriSign. These are used to authorize connections.
    

    • 

  • ciphers: A string describing the ciphers to use or exclude, separated by
:. Uses the same default cipher suite as tls.createServer().
    

    • 

  • rejectUnauthorized: If true, the server certificate is verified against
the list of supplied CAs. An 'error' event is emitted if verification
fails; err.code contains the OpenSSL error code. Default: true.
    

    • 

  • NPNProtocols: An array of strings or Buffers containing supported NPN
protocols. Buffers should have following format: 0x05hello0x05world,
where first byte is next protocol name's length. (Passing array should
usually be much simpler: ['hello', 'world'].)
    

    • 

  • ALPNProtocols: An array of strings or Buffers containing
supported ALPN protocols. Buffers should have following format:
0x05hello0x05world, where the first byte is the next protocol
name's length. (Passing array should usually be much simpler:
['hello', 'world'].)
    

    • 

  • servername: Servername for SNI (Server Name Indication) TLS extension.
    

    • 

  • checkServerIdentity(servername, cert): Provide an override for checking
server's hostname against the certificate. Should return an error if verification
fails. Return undefined if passing.
    

    • 

  • secureProtocol: The SSL method to use, e.g. SSLv3_method to force
SSL version 3. The possible values depend on your installation of
OpenSSL and are defined in the constant SSL_METHODS.
    

    • 

  • secureContext: An optional TLS context object from
 tls.createSecureContext( ... ). Could it be used for caching client
 certificates, key, and CA certificates.
    

    • 

  • session: A Buffer instance, containing TLS session.
    

    • 



The callback parameter will be added as a listener for the
'secureConnect' event.


tls.connect() returns a tls.TLSSocket object.


Here is an example of a client of echo server as described previously:


const tls = require('tls');
const fs = require('fs');

const options = {
  // These are necessary only if using the client certificate authentication
  key: fs.readFileSync('client-key.pem'),
  cert: fs.readFileSync('client-cert.pem'),

  // This is necessary only if the server uses the self-signed certificate
  ca: [ fs.readFileSync('server-cert.pem') ]
};

var socket = tls.connect(8000, options, () => {
  console.log('client connected',
              socket.authorized ? 'authorized' : 'unauthorized');
  process.stdin.pipe(socket);
  process.stdin.resume();
});
socket.setEncoding('utf8');
socket.on('data', (data) => {
  console.log(data);
});
socket.on('end', () => {
  server.close();
});



Or


const tls = require('tls');
const fs = require('fs');

const options = {
  pfx: fs.readFileSync('client.pfx')
};

var socket = tls.connect(8000, options, () => {
  console.log('client connected',
              socket.authorized ? 'authorized' : 'unauthorized');
  process.stdin.pipe(socket);
  process.stdin.resume();
});
socket.setEncoding('utf8');
socket.on('data', (data) => {
  console.log(data);
});
socket.on('end', () => {
  server.close();
});



tls.createSecureContext(details)#



Added in: v0.11.13

Creates a credentials object, with the optional details being a
dictionary with keys:


    

  • pfx : A string or buffer holding the PFX or PKCS12 encoded private
key, certificate and CA certificates
    • 

  • key: A string or Buffer containing the private key of the server in
PEM format. To support multiple keys using different algorithms, an array
can be provided. It can either be a plain array of keys, or an array of
objects in the format {pem: key, passphrase: passphrase}. (Required)
    • 

  • passphrase : A string of passphrase for the private key or pfx
    • 

  • cert : A string holding the PEM encoded certificate
    • 

  • ca: A string, Buffer or array of strings or Buffers of trusted
certificates in PEM format. If this is omitted several well known "root"
CAs will be used, like VeriSign. These are used to authorize connections.
    • 

  • crl : Either a string or list of strings of PEM encoded CRLs
(Certificate Revocation List)
    • 

  • ciphers: A string describing the ciphers to use or exclude.
Consult
https://www.openssl.org/docs/apps/ciphers.html#CIPHER-LIST-FORMAT
for details on the format.
    • 

  • honorCipherOrder : When choosing a cipher, use the server's preferences
instead of the client preferences. For further details see tls module
documentation.
    • 



If no 'ca' details are given, then Node.js will use the default
publicly trusted list of CAs as given in
http://mxr.mozilla.org/mozilla/source/security/nss/lib/ckfw/builtins/certdata.txt.


tls.createSecurePair([context][, isServer][, requestCert][, rejectUnauthorized][, options])#


Creates a new secure pair object with two streams, one of which reads/writes
encrypted data, and one reads/writes cleartext data.
Generally the encrypted one is piped to/from an incoming encrypted data stream,
and the cleartext one is used as a replacement for the initial encrypted stream.


    

  • credentials: A secure context object from tls.createSecureContext( ... )
    

    • 

  • isServer: A boolean indicating whether this tls connection should be
opened as a server or a client.
    

    • 

  • requestCert: A boolean indicating whether a server should request a
certificate from a connecting client. Only applies to server connections.
    

    • 

  • rejectUnauthorized: A boolean indicating whether a server should
automatically reject clients with invalid certificates. Only applies to
servers with requestCert enabled.
    

    • 

  • options: An object with common SSL options. See tls.TLSSocket.
    

    • 



tls.createSecurePair() returns a SecurePair object with cleartext and
encrypted stream properties.


NOTE: cleartext has the same APIs as tls.TLSSocket


tls.createServer(options[, secureConnectionListener])#



Added in: v0.3.2

Creates a new tls.Server.  The connectionListener argument is
automatically set as a listener for the 'secureConnection' event.  The
options object has these possibilities:


    

  • pfx: A string or Buffer containing the private key, certificate and
CA certs of the server in PFX or PKCS12 format. (Mutually exclusive with
the key, cert and ca options.)
    

    • 

  • key: A string or Buffer containing the private key of the server in
PEM format. To support multiple keys using different algorithms, an array
can be provided. It can either be a plain array of keys, or an array of
objects in the format {pem: key, passphrase: passphrase}. (Required)
    

    • 

  • passphrase: A string of passphrase for the private key or pfx.
    

    • 

  • cert: A string or Buffer containing the certificate key of the server in
PEM format. (Could be an array of certs). (Required)
    

    • 

  • ca: A string, Buffer or array of strings or Buffers of trusted
certificates in PEM format. If this is omitted several well known "root"
CAs will be used, like VeriSign. These are used to authorize connections.
    

    • 

  • crl : Either a string or list of strings of PEM encoded CRLs (Certificate
Revocation List)
    

    • 

  • ciphers: A string describing the ciphers to use or exclude, separated by
:. The default cipher suite is:
    

    ECDHE-RSA-AES128-GCM-SHA256:
ECDHE-ECDSA-AES128-GCM-SHA256:
ECDHE-RSA-AES256-GCM-SHA384:
ECDHE-ECDSA-AES256-GCM-SHA384:
DHE-RSA-AES128-GCM-SHA256:
ECDHE-RSA-AES128-SHA256:
DHE-RSA-AES128-SHA256:
ECDHE-RSA-AES256-SHA384:
DHE-RSA-AES256-SHA384:
ECDHE-RSA-AES256-SHA256:
DHE-RSA-AES256-SHA256:
HIGH:
!aNULL:
!eNULL:
!EXPORT:
!DES:
!RC4:
!MD5:
!PSK:
!SRP:
!CAMELLIA

    

    The default cipher suite prefers GCM ciphers for Chrome's 'modern
cryptography' setting and also prefers ECDHE and DHE ciphers for Perfect
Forward secrecy, while offering some backward compatibiltity.
    

    128 bit AES is preferred over 192 and 256 bit AES in light of specific
attacks affecting larger AES key sizes.
    

    Old clients that rely on insecure and deprecated RC4 or DES-based ciphers
(like Internet Explorer 6) aren't able to complete the handshake with the default
configuration. If you absolutely must support these clients, the
TLS recommendations may offer a compatible cipher suite. For more details
on the format, see the OpenSSL cipher list format documentation.
    

    • 

  • ecdhCurve: A string describing a named curve to use for ECDH key agreement
or false to disable ECDH.
    

    Defaults to prime256v1 (NIST P-256). Use crypto.getCurves() to obtain
a list of available curve names. On recent releases,
openssl ecparam -list_curves will also display the name and description of
each available elliptic curve.
    

    • 

  • dhparam: A string or Buffer containing Diffie Hellman parameters,
required for Perfect Forward Secrecy. Use openssl dhparam to create it.
Its key length should be greater than or equal to 1024 bits, otherwise
it throws an error. It is strongly recommended to use 2048 bits or
more for stronger security. If omitted or invalid, it is silently
discarded and DHE ciphers won't be available.
    

    • 

  • handshakeTimeout: Abort the connection if the SSL/TLS handshake does not
finish in this many milliseconds. The default is 120 seconds.
    

    A 'clientError' is emitted on the tls.Server object whenever a handshake
times out.
    

    • 

  • honorCipherOrder : When choosing a cipher, use the server's preferences
instead of the client preferences. Default: true.
    

    • 

  • requestCert: If true the server will request a certificate from
clients that connect and attempt to verify that certificate. Default:
false.
    

    • 

  • rejectUnauthorized: If true the server will reject any connection
which is not authorized with the list of supplied CAs. This option only
has an effect if requestCert is true. Default: false.
    

    • 

  • NPNProtocols: An array or Buffer of possible NPN protocols. (Protocols
should be ordered by their priority).
    

    • 

  • ALPNProtocols: An array or Buffer of possible ALPN
protocols. (Protocols should be ordered by their priority). When
the server receives both NPN and ALPN extensions from the client,
ALPN takes precedence over NPN and the server does not send an NPN
extension to the client.
    

    • 

  • SNICallback(servername, cb): A function that will be called if client
supports SNI TLS extension. Two argument will be passed to it: servername,
and cb. SNICallback should invoke cb(null, ctx), where ctx is a
SecureContext instance.
(You can use tls.createSecureContext(...) to get proper
SecureContext). If SNICallback wasn't provided the default callback with
high-level API will be used (see below).
    

    • 

  • sessionTimeout: An integer specifying the seconds after which TLS
session identifiers and TLS session tickets created by the server are
timed out. See SSL_CTX_set_timeout for more details.
    

    • 

  • ticketKeys: A 48-byte Buffer instance consisting of 16-byte prefix,
16-byte hmac key, 16-byte AES key. You could use it to accept tls session
tickets on multiple instances of tls server.
    

    NOTE: Automatically shared between cluster module workers.
    

    • 

  • sessionIdContext: A string containing an opaque identifier for session
resumption. If requestCert is true, the default is MD5 hash value
generated from command-line. (In FIPS mode a truncated SHA1 hash is
used instead.) Otherwise, the default is not provided.
    

    • 

  • secureProtocol: The SSL method to use, e.g. SSLv3_method to force
SSL version 3. The possible values depend on your installation of
OpenSSL and are defined in the constant SSL_METHODS.
    

    • 



Here is a simple example echo server:


const tls = require('tls');
const fs = require('fs');

const options = {
  key: fs.readFileSync('server-key.pem'),
  cert: fs.readFileSync('server-cert.pem'),

  // This is necessary only if using the client certificate authentication.
  requestCert: true,

  // This is necessary only if the client uses the self-signed certificate.
  ca: [ fs.readFileSync('client-cert.pem') ]
};

var server = tls.createServer(options, (socket) => {
  console.log('server connected',
              socket.authorized ? 'authorized' : 'unauthorized');
  socket.write('welcome!\n');
  socket.setEncoding('utf8');
  socket.pipe(socket);
});
server.listen(8000, () => {
  console.log('server bound');
});



Or


const tls = require('tls');
const fs = require('fs');

const options = {
  pfx: fs.readFileSync('server.pfx'),

  // This is necessary only if using the client certificate authentication.
  requestCert: true,

};

var server = tls.createServer(options, (socket) => {
  console.log('server connected',
              socket.authorized ? 'authorized' : 'unauthorized');
  socket.write('welcome!\n');
  socket.setEncoding('utf8');
  socket.pipe(socket);
});
server.listen(8000, () => {
  console.log('server bound');
});



You can test this server by connecting to it with openssl s_client:


openssl s_client -connect 127.0.0.1:8000

tls.getCiphers()#



Added in: v0.10.2

Returns an array with the names of the supported SSL ciphers.


Example:


var ciphers = tls.getCiphers();
console.log(ciphers); // ['AES128-SHA', 'AES256-SHA', ...]





TTY#


Stability: 2 - Stable
The tty module houses the tty.ReadStream and tty.WriteStream classes. In
most cases, you will not need to use this module directly.


When Node.js detects that it is being run inside a TTY context, then process.stdin
will be a tty.ReadStream instance and process.stdout will be
a tty.WriteStream instance. The preferred way to check if Node.js is being run
in a TTY context is to check process.stdout.isTTY:


$ node -p -e "Boolean(process.stdout.isTTY)"
true
$ node -p -e "Boolean(process.stdout.isTTY)" | cat
false

Class: ReadStream#



Added in: v0.5.8

A net.Socket subclass that represents the readable portion of a tty. In normal
circumstances, process.stdin will be the only tty.ReadStream instance in any
Node.js program (only when isatty(0) is true).


rs.isRaw#



Added in: v0.7.7

A Boolean that is initialized to false. It represents the current "raw" state
of the tty.ReadStream instance.


rs.setRawMode(mode)#



Added in: v0.7.7

mode should be true or false. This sets the properties of the
tty.ReadStream to act either as a raw device or default. isRaw will be set
to the resulting mode.


Class: WriteStream#



Added in: v0.5.8

A net.Socket subclass that represents the writable portion of a tty. In normal
circumstances, process.stdout will be the only tty.WriteStream instance
ever created (and only when isatty(1) is true).


Event: 'resize'#



Added in: v0.7.7

function () {}


Emitted by refreshSize() when either of the columns or rows properties
has changed.


process.stdout.on('resize', () => {
  console.log('screen size has changed!');
  console.log(`${process.stdout.columns}x${process.stdout.rows}`);
});



ws.columns#



Added in: v0.7.7

A Number that gives the number of columns the TTY currently has. This property
gets updated on 'resize' events.


ws.rows#



Added in: v0.7.7

A Number that gives the number of rows the TTY currently has. This property
gets updated on 'resize' events.


tty.isatty(fd)#



Added in: v0.5.8

Returns true or false depending on if the fd is associated with a
terminal.


tty.setRawMode(mode)#


Stability: 0 - Deprecated: Use tty.ReadStream#setRawMode (i.e. process.stdin.setRawMode) instead.



URL#


Stability: 2 - Stable
This module has utilities for URL resolution and parsing.
Call require('url') to use it.


URL Parsing#


Parsed URL objects have some or all of the following fields, depending on
whether or not they exist in the URL string. Any parts that are not in the URL
string will not be in the parsed object. Examples are shown for the URL


'http://user:pass@host.com:8080/p/a/t/h?query=string#hash'


    

  • href: The full URL that was originally parsed. Both the protocol and host are lowercased.
    

      Example: 'http://user:pass@host.com:8080/p/a/t/h?query=string#hash'
    

    • 

  • protocol: The request protocol, lowercased.
    

      Example: 'http:'
    

    • 

  • slashes: The protocol requires slashes after the colon.
    

      Example: true or false
    

    • 

  • host: The full lowercased host portion of the URL, including port
information.
    

      Example: 'host.com:8080'
    

    • 

  • auth: The authentication information portion of a URL.
    

      Example: 'user:pass'
    

    • 

  • hostname: Just the lowercased hostname portion of the host.
    

      Example: 'host.com'
    

    • 

  • port: The port number portion of the host.
    

      Example: '8080'
    

    • 

  • pathname: The path section of the URL, that comes after the host and
before the query, including the initial slash if present. No decoding is
performed.
    

      Example: '/p/a/t/h'
    

    • 

  • search: The 'query string' portion of the URL, including the leading
question mark.
    

      Example: '?query=string'
    

    • 

  • path: Concatenation of pathname and search. No decoding is performed.
    

      Example: '/p/a/t/h?query=string'
    

    • 

  • query: Either the 'params' portion of the query string, or a
querystring-parsed object.
    

      Example: 'query=string' or {'query':'string'}
    

    • 

  • hash: The 'fragment' portion of the URL including the pound-sign.
    

      Example: '#hash'
    

    • 



Escaped Characters#


Spaces (' ') and the following characters will be automatically escaped in the
properties of URL objects:


< > " ` \r \n \t { } | \ ^ '



The following methods are provided by the URL module:


url.format(urlObj)#



Added in: v0.1.25

Take a parsed URL object, and return a formatted URL string.


Here's how the formatting process works:


    

  • href will be ignored.
    • 

  • path will be ignored.
    • 

  • protocol is treated the same with or without the trailing : (colon).
      

    • The protocols http, https, ftp, gopher, file will be
postfixed with :// (colon-slash-slash) as long as host/hostname are present.
      • 

    • All other protocols mailto, xmpp, aim, sftp, foo, etc will
be postfixed with : (colon).
      • 

    

    • 

  • slashes set to true if the protocol requires :// (colon-slash-slash)
      

    • Only needs to be set for protocols not previously listed as requiring
slashes, such as mongodb://localhost:8000/, or if host/hostname are absent.
      • 

    

    • 

  • auth will be used if present.
    • 

  • hostname will only be used if host is absent.
    • 

  • port will only be used if host is absent.
    • 

  • host will be used in place of hostname and port.
    • 

  • pathname is treated the same with or without the leading / (slash).
    • 

  • query (object; see querystring) will only be used if search is absent.
    • 

  • search will be used in place of query.
      

    • It is treated the same with or without the leading ? (question mark).
      • 

    

    • 

  • hash is treated the same with or without the leading # (pound sign, anchor).
    • 



url.parse(urlStr[, parseQueryString][, slashesDenoteHost])#



Added in: v0.1.25

Take a URL string, and return an object.


Pass true as the second argument to also parse the query string using the
querystring module. If true then the query property will always be
assigned an object, and the search property will always be a (possibly
empty) string. If false then the query property will not be parsed or
decoded. Defaults to false.


Pass true as the third argument to treat //foo/bar as
{ host: 'foo', pathname: '/bar' } rather than
{ pathname: '//foo/bar' }. Defaults to false.


url.resolve(from, to)#



Added in: v0.1.25

Take a base URL, and a href URL, and resolve them as a browser would for
an anchor tag.  Examples:


url.resolve('/one/two/three', 'four')         // '/one/two/four'
url.resolve('http://example.com/', '/one')    // 'http://example.com/one'
url.resolve('http://example.com/one', '/two') // 'http://example.com/two'





Util#


Stability: 2 - Stable
These functions are in the module 'util'. Use require('util') to
access them.


The util module is primarily designed to support the needs of Node.js's
internal APIs.  Many of these utilities are useful for your own
programs.  If you find that these functions are lacking for your
purposes, however, you are encouraged to write your own utilities.  We
are not interested in any future additions to the util module that
are unnecessary for Node.js's internal functionality.


util.debug(string)#


Stability: 0 - Deprecated: Use console.error() instead.
Deprecated predecessor of console.error.


util.debuglog(section)#



Added in: v0.11.3

    

  • section <String> The section of the program to be debugged
    • 

  • Returns: <Function> The logging function
    • 



This is used to create a function which conditionally writes to stderr
based on the existence of a NODE_DEBUG environment variable.  If the
section name appears in that environment variable, then the returned
function will be similar to console.error().  If not, then the
returned function is a no-op.


For example:


var debuglog = util.debuglog('foo');

var bar = 123;
debuglog('hello from foo [%d]', bar);



If this program is run with NODE_DEBUG=foo in the environment, then
it will output something like:


FOO 3245: hello from foo [123]

where 3245 is the process id.  If it is not run with that
environment variable set, then it will not print anything.


You may separate multiple NODE_DEBUG environment variables with a
comma.  For example, NODE_DEBUG=fs,net,tls.


util.deprecate(function, string)#



Added in: v0.8.0

Marks that a method should not be used any more.


const util = require('util');

exports.puts = util.deprecate(function() {
  for (var i = 0, len = arguments.length; i < len; ++i) {
    process.stdout.write(arguments[i] + '\n');
  }
}, 'util.puts: Use console.log instead');



It returns a modified function which warns once by default.


If --no-deprecation is set then this function is a NO-OP.  Configurable
at run-time through the process.noDeprecation boolean (only effective
when set before a module is loaded.)


If --trace-deprecation is set, a warning and a stack trace are logged
to the console the first time the deprecated API is used.  Configurable
at run-time through the process.traceDeprecation boolean.


If --throw-deprecation is set then the application throws an exception
when the deprecated API is used.  Configurable at run-time through the
process.throwDeprecation boolean.


process.throwDeprecation takes precedence over process.traceDeprecation.


util.error([...])#



Added in: v0.3.0
Deprecated since: v0.11.3 

Stability: 0 - Deprecated: Use console.error() instead.
Deprecated predecessor of console.error.


util.format(format[, ...])#



Added in: v0.5.3

Returns a formatted string using the first argument as a printf-like format.


The first argument is a string that contains zero or more placeholders.
Each placeholder is replaced with the converted value from its corresponding
argument. Supported placeholders are:


    

  • %s - String.
    • 

  • %d - Number (both integer and float).
    • 

  • %j - JSON.  Replaced with the string '[Circular]' if the argument
contains circular references.
    • 

  • %% - single percent sign ('%'). This does not consume an argument.
    • 



If the placeholder does not have a corresponding argument, the placeholder is
not replaced.


util.format('%s:%s', 'foo'); // 'foo:%s'



If there are more arguments than placeholders, the extra arguments are
coerced to strings (for objects and symbols, util.inspect() is used)
and then concatenated, delimited by a space.


util.format('%s:%s', 'foo', 'bar', 'baz'); // 'foo:bar baz'



If the first argument is not a format string then util.format() returns
a string that is the concatenation of all its arguments separated by spaces.
Each argument is converted to a string with util.inspect().


util.format(1, 2, 3); // '1 2 3'



util.inherits(constructor, superConstructor)#



Added in: v0.3.0

Inherit the prototype methods from one constructor into another.  The
prototype of constructor will be set to a new object created from
superConstructor.


As an additional convenience, superConstructor will be accessible
through the constructor.super_ property.


const util = require('util');
const EventEmitter = require('events');

function MyStream() {
    EventEmitter.call(this);
}

util.inherits(MyStream, EventEmitter);

MyStream.prototype.write = function(data) {
    this.emit('data', data);
}

var stream = new MyStream();

console.log(stream instanceof EventEmitter); // true
console.log(MyStream.super_ === EventEmitter); // true

stream.on('data', (data) => {
  console.log(`Received data: "${data}"`);
})
stream.write('It works!'); // Received data: "It works!"



util.inspect(object[, options])#



Added in: v0.3.0

Return a string representation of object, which is useful for debugging.


An optional options object may be passed that alters certain aspects of the
formatted string:


    

  • showHidden - if true then the object's non-enumerable and symbol
properties will be shown too. Defaults to false.
    

    • 

  • depth - tells inspect how many times to recurse while formatting the
object. This is useful for inspecting large complicated objects. Defaults to
2. To make it recurse indefinitely pass null.
    

    • 

  • colors - if true, then the output will be styled with ANSI color codes.
Defaults to false. Colors are customizable, see Customizing
util.inspect colors.
    

    • 

  • customInspect - if false, then custom inspect(depth, opts) functions
defined on the objects being inspected won't be called. Defaults to true.
    

    • 



Example of inspecting all properties of the util object:


const util = require('util');

console.log(util.inspect(util, { showHidden: true, depth: null }));



Values may supply their own custom inspect(depth, opts) functions, when
called they receive the current depth in the recursive inspection, as well as
the options object passed to util.inspect().


Customizing util.inspect colors#



Color output (if enabled) of util.inspect is customizable globally
via util.inspect.styles and util.inspect.colors objects.


util.inspect.styles is a map assigning each style a color
from util.inspect.colors.
Highlighted styles and their default values are:


    

  • number (yellow)
    • 

  • boolean (yellow)
    • 

  • string (green)
    • 

  • date (magenta)
    • 

  • regexp (red)
    • 

  • null (bold)
    • 

  • undefined (grey)
    • 

  • special - only function at this time (cyan)
    • 

  • name (intentionally no styling)
    • 



Predefined color codes are: white, grey, black, blue, cyan,
green, magenta, red and yellow.
There are also bold, italic, underline and inverse codes.


Custom inspect() function on Objects#



Objects also may define their own inspect(depth) function which util.inspect()
will invoke and use the result of when inspecting the object:


const util = require('util');

var obj = { name: 'nate' };
obj.inspect = function(depth) {
  return `{${this.name}}`;
};

util.inspect(obj);
  // "{nate}"



You may also return another Object entirely, and the returned String will be
formatted according to the returned Object. This is similar to how
JSON.stringify() works:


var obj = { foo: 'this will not show up in the inspect() output' };
obj.inspect = function(depth) {
  return { bar: 'baz' };
};

util.inspect(obj);
  // "{ bar: 'baz' }"



util.isArray(object)#



Added in: v0.6.0
Deprecated since: v4.0.0 

Stability: 0 - Deprecated
Internal alias for Array.isArray.


Returns true if the given "object" is an Array. Otherwise, returns false.


const util = require('util');

util.isArray([])
  // true
util.isArray(new Array)
  // true
util.isArray({})
  // false



util.isBoolean(object)#



Added in: v0.11.5
Deprecated since: v4.0.0 

Stability: 0 - Deprecated
Returns true if the given "object" is a Boolean. Otherwise, returns false.


const util = require('util');

util.isBoolean(1)
  // false
util.isBoolean(0)
  // false
util.isBoolean(false)
  // true



util.isBuffer(object)#



Added in: v0.11.5
Deprecated since: v4.0.0 

Stability: 0 - Deprecated: Use Buffer.isBuffer() instead.
Returns true if the given "object" is a Buffer. Otherwise, returns false.


const util = require('util');

util.isBuffer({ length: 0 })
  // false
util.isBuffer([])
  // false
util.isBuffer(new Buffer('hello world'))
  // true



util.isDate(object)#



Added in: v0.6.0
Deprecated since: v4.0.0 

Stability: 0 - Deprecated
Returns true if the given "object" is a Date. Otherwise, returns false.


const util = require('util');

util.isDate(new Date())
  // true
util.isDate(Date())
  // false (without 'new' returns a String)
util.isDate({})
  // false



util.isError(object)#



Added in: v0.6.0
Deprecated since: v4.0.0 

Stability: 0 - Deprecated
Returns true if the given "object" is an Error. Otherwise, returns
false.


const util = require('util');

util.isError(new Error())
  // true
util.isError(new TypeError())
  // true
util.isError({ name: 'Error', message: 'an error occurred' })
  // false



util.isFunction(object)#



Added in: v0.11.5
Deprecated since: v4.0.0 

Stability: 0 - Deprecated
Returns true if the given "object" is a Function. Otherwise, returns
false.


const util = require('util');

function Foo() {}
var Bar = function() {};

util.isFunction({})
  // false
util.isFunction(Foo)
  // true
util.isFunction(Bar)
  // true



util.isNull(object)#



Added in: v0.11.5
Deprecated since: v4.0.0 

Stability: 0 - Deprecated
Returns true if the given "object" is strictly null. Otherwise, returns
false.


const util = require('util');

util.isNull(0)
  // false
util.isNull(undefined)
  // false
util.isNull(null)
  // true



util.isNullOrUndefined(object)#



Added in: v0.11.5
Deprecated since: v4.0.0 

Stability: 0 - Deprecated
Returns true if the given "object" is null or undefined. Otherwise,
returns false.


const util = require('util');

util.isNullOrUndefined(0)
  // false
util.isNullOrUndefined(undefined)
  // true
util.isNullOrUndefined(null)
  // true



util.isNumber(object)#



Added in: v0.11.5
Deprecated since: v4.0.0 

Stability: 0 - Deprecated
Returns true if the given "object" is a Number. Otherwise, returns false.


const util = require('util');

util.isNumber(false)
  // false
util.isNumber(Infinity)
  // true
util.isNumber(0)
  // true
util.isNumber(NaN)
  // true



util.isObject(object)#



Added in: v0.11.5
Deprecated since: v4.0.0 

Stability: 0 - Deprecated
Returns true if the given "object" is strictly an Object and not a
Function. Otherwise, returns false.


const util = require('util');

util.isObject(5)
  // false
util.isObject(null)
  // false
util.isObject({})
  // true
util.isObject(function(){})
  // false



util.isPrimitive(object)#



Added in: v0.11.5
Deprecated since: v4.0.0 

Stability: 0 - Deprecated
Returns true if the given "object" is a primitive type. Otherwise, returns
false.


const util = require('util');

util.isPrimitive(5)
  // true
util.isPrimitive('foo')
  // true
util.isPrimitive(false)
  // true
util.isPrimitive(null)
  // true
util.isPrimitive(undefined)
  // true
util.isPrimitive({})
  // false
util.isPrimitive(function() {})
  // false
util.isPrimitive(/^$/)
  // false
util.isPrimitive(new Date())
  // false



util.isRegExp(object)#



Added in: v0.6.0
Deprecated since: v4.0.0 

Stability: 0 - Deprecated
Returns true if the given "object" is a RegExp. Otherwise, returns false.


const util = require('util');

util.isRegExp(/some regexp/)
  // true
util.isRegExp(new RegExp('another regexp'))
  // true
util.isRegExp({})
  // false



util.isString(object)#



Added in: v0.11.5
Deprecated since: v4.0.0 

Stability: 0 - Deprecated
Returns true if the given "object" is a String. Otherwise, returns false.


const util = require('util');

util.isString('')
  // true
util.isString('foo')
  // true
util.isString(String('foo'))
  // true
util.isString(5)
  // false



util.isSymbol(object)#



Added in: v0.11.5
Deprecated since: v4.0.0 

Stability: 0 - Deprecated
Returns true if the given "object" is a Symbol. Otherwise, returns false.


const util = require('util');

util.isSymbol(5)
  // false
util.isSymbol('foo')
  // false
util.isSymbol(Symbol('foo'))
  // true



util.isUndefined(object)#



Added in: v0.11.5
Deprecated since: v4.0.0 

Stability: 0 - Deprecated
Returns true if the given "object" is undefined. Otherwise, returns false.


const util = require('util');

var foo;
util.isUndefined(5)
  // false
util.isUndefined(foo)
  // true
util.isUndefined(null)
  // false



util.log(string)#



Added in: v0.3.0
Deprecated since: v6.0.0 

Output with timestamp on stdout.


require('util').log('Timestamped message.');

util.print([...])#



Added in: v0.3.0
Deprecated since: v0.11.3 

Stability: 0 - Deprecated: Use console.log() instead.
Deprecated predecessor of console.log.


util.pump(readableStream, writableStream[, callback])#



Added in: v0.3.0
Deprecated since: v0.9.1 

Stability: 0 - Deprecated: Use readableStream.pipe(writableStream)
Deprecated predecessor of stream.pipe().


util.puts([...])#



Added in: v0.3.0
Deprecated since: v0.11.3 

Stability: 0 - Deprecated: Use console.log() instead.
Deprecated predecessor of console.log.




V8#


Stability: 2 - Stable
This module exposes events and interfaces specific to the version of V8
built with Node.js.  These interfaces are subject to change by upstream and are
therefore not covered under the stability index.


getHeapStatistics()#



Added in: v1.0.0

Returns an object with the following properties


{
  total_heap_size: 7326976,
  total_heap_size_executable: 4194304,
  total_physical_size: 7326976,
  total_available_size: 1152656,
  used_heap_size: 3476208,
  heap_size_limit: 1535115264
}



getHeapSpaceStatistics()#


Returns statistics about the V8 heap spaces, i.e. the segments which make up
the V8 heap. Order of heap spaces nor availability of a heap space can be
guaranteed as the statistics are provided via the V8 GetHeapSpaceStatistics
function.


Example result:


[
  {
    "space_name": "new_space",
    "space_size": 2063872,
    "space_used_size": 951112,
    "space_available_size": 80824,
    "physical_space_size": 2063872
  },
  {
    "space_name": "old_space",
    "space_size": 3090560,
    "space_used_size": 2493792,
    "space_available_size": 0,
    "physical_space_size": 3090560
  },
  {
    "space_name": "code_space",
    "space_size": 1260160,
    "space_used_size": 644256,
    "space_available_size": 960,
    "physical_space_size": 1260160
  },
  {
    "space_name": "map_space",
    "space_size": 1094160,
    "space_used_size": 201608,
    "space_available_size": 0,
    "physical_space_size": 1094160
  },
  {
    "space_name": "large_object_space",
    "space_size": 0,
    "space_used_size": 0,
    "space_available_size": 1490980608,
    "physical_space_size": 0
  }
]

setFlagsFromString(string)#



Added in: v1.0.0

Set additional V8 command line flags.  Use with care; changing settings
after the VM has started may result in unpredictable behavior, including
crashes and data loss.  Or it may simply do nothing.


The V8 options available for a version of Node.js may be determined by running
node --v8-options.  An unofficial, community-maintained list of options
and their effects is available here.


Usage:


// Print GC events to stdout for one minute.
const v8 = require('v8');
v8.setFlagsFromString('--trace_gc');
setTimeout(function() { v8.setFlagsFromString('--notrace_gc'); }, 60e3);





VM (Executing JavaScript)#


Stability: 2 - Stable


You can access this module with:


const vm = require('vm');



JavaScript code can be compiled and run immediately or compiled, saved, and run
later.


Class: Script#



Added in: v0.3.1

A class for holding precompiled scripts, and running them in specific sandboxes.


new vm.Script(code, options)#



Added in: v0.3.1

Creating a new Script compiles code but does not run it. Instead, the
created vm.Script object represents this compiled code. This script can be run
later many times using methods below. The returned script is not bound to any
global object. It is bound before each run, just for that run.


The options when creating a script are:


    

  • filename: allows you to control the filename that shows up in any stack
traces produced from this script.
    • 

  • lineOffset: allows you to add an offset to the line number that is
displayed in stack traces
    • 

  • columnOffset: allows you to add an offset to the column number that is
displayed in stack traces
    • 

  • displayErrors: whether or not to print any errors to stderr, with the
line of code that caused them highlighted, before throwing an exception.
Applies only to syntax errors compiling the code; errors while running the
code are controlled by the options to the script's methods.
    • 

  • timeout: a number of milliseconds to execute code before terminating
execution. If execution is terminated, an Error will be thrown.
    • 



script.runInContext(contextifiedSandbox[, options])#



Added in: v0.3.1

Similar to vm.runInContext() but a method of a precompiled Script
object. script.runInContext() runs script's compiled code in
contextifiedSandbox and returns the result. Running code does not have access
to local scope.


script.runInContext() takes the same options as
script.runInThisContext().


Example: compile code that increments a global variable and sets one, then
execute the code multiple times. These globals are contained in the sandbox.


const util = require('util');
const vm = require('vm');

var sandbox = {
  animal: 'cat',
  count: 2
};

var context = new vm.createContext(sandbox);
var script = new vm.Script('count += 1; name = "kitty"');

for (var i = 0; i < 10; ++i) {
  script.runInContext(context);
}

console.log(util.inspect(sandbox));

// { animal: 'cat', count: 12, name: 'kitty' }



Note that running untrusted code is a tricky business requiring great care.
script.runInContext() is quite useful, but safely running untrusted code
requires a separate process.


script.runInNewContext([sandbox][, options])#



Added in: v0.3.1

Similar to vm.runInNewContext() but a method of a precompiled Script
object. script.runInNewContext() contextifies sandbox if passed or creates a
new contextified sandbox if it's omitted, and then runs script's compiled code
with the sandbox as the global object and returns the result. Running code does
not have access to local scope.


script.runInNewContext() takes the same options as
script.runInThisContext().


Example: compile code that sets a global variable, then execute the code
multiple times in different contexts. These globals are set on and contained in
the sandboxes.


const util = require('util');
const vm = require('vm');

const sandboxes = [{}, {}, {}];

const script = new vm.Script('globalVar = "set"');

sandboxes.forEach((sandbox) => {
  script.runInNewContext(sandbox);
});

console.log(util.inspect(sandboxes));

// [{ globalVar: 'set' }, { globalVar: 'set' }, { globalVar: 'set' }]



Note that running untrusted code is a tricky business requiring great care.
script.runInNewContext() is quite useful, but safely running untrusted code
requires a separate process.


script.runInThisContext(options)#



Added in: v0.3.1

Similar to vm.runInThisContext() but a method of a precompiled Script
object. script.runInThisContext() runs script's compiled code and returns
the result. Running code does not have access to local scope, but does have
access to the current global object.


Example of using script.runInThisContext() to compile code once and run it
multiple times:


const vm = require('vm');

global.globalVar = 0;

const script = new vm.Script('globalVar += 1', { filename: 'myfile.vm' });

for (var i = 0; i < 1000; ++i) {
  script.runInThisContext();
}

console.log(globalVar);

// 1000



The options for running a script are:


    

  • filename: allows you to control the filename that shows up in any stack
traces produced.
    • 

  • lineOffset: allows you to add an offset to the line number that is
displayed in stack traces
    • 

  • columnOffset: allows you to add an offset to the column number that is
displayed in stack traces
    • 

  • displayErrors: whether or not to print any errors to stderr, with the
line of code that caused them highlighted, before throwing an exception.
Applies only to runtime errors executing the code; it is impossible to create
a Script instance with syntax errors, as the constructor will throw.
    • 

  • timeout: a number of milliseconds to execute the script before terminating
execution. If execution is terminated, an Error will be thrown.
    • 



vm.createContext([sandbox])#



Added in: v0.3.1

If given a sandbox object, will "contextify" that sandbox so that it can be
used in calls to vm.runInContext() or script.runInContext(). Inside
scripts run as such, sandbox will be the global object, retaining all its
existing properties but also having the built-in objects and functions any
standard global object has. Outside of scripts run by the vm module,
sandbox will be unchanged.


If not given a sandbox object, returns a new, empty contextified sandbox object
you can use.


This function is useful for creating a sandbox that can be used to run multiple
scripts, e.g. if you were emulating a web browser it could be used to create a
single sandbox representing a window's global object, then run all <script>
tags together inside that sandbox.


vm.isContext(sandbox)#



Added in: v0.11.7

Returns whether or not a sandbox object has been contextified by calling
vm.createContext() on it.


vm.runInContext(code, contextifiedSandbox[, options])#


vm.runInContext() compiles code, then runs it in contextifiedSandbox and
returns the result. Running code does not have access to local scope. The
contextifiedSandbox object must have been previously contextified via
vm.createContext(); it will be used as the global object for code.


vm.runInContext() takes the same options as vm.runInThisContext().


Example: compile and execute different scripts in a single existing context.


const util = require('util');
const vm = require('vm');

const sandbox = { globalVar: 1 };
vm.createContext(sandbox);

for (var i = 0; i < 10; ++i) {
    vm.runInContext('globalVar *= 2;', sandbox);
}
console.log(util.inspect(sandbox));

// { globalVar: 1024 }



Note that running untrusted code is a tricky business requiring great care.
vm.runInContext() is quite useful, but safely running untrusted code requires
a separate process.


vm.runInDebugContext(code)#



Added in: v0.11.14

vm.runInDebugContext() compiles and executes code inside the V8 debug
context. The primary use case is to get access to the V8 debug object:


const vm = require('vm');
const Debug = vm.runInDebugContext('Debug');
console.log(Debug.findScript(process.emit).name);  // 'events.js'
console.log(Debug.findScript(process.exit).name);  // 'internal/process.js'



Note that the debug context and object are intrinsically tied to V8's debugger
implementation and may change (or even get removed) without prior warning.


The debug object can also be exposed with the --expose_debug_as= switch.


vm.runInNewContext(code[, sandbox][, options])#



Added in: v0.3.1

vm.runInNewContext() compiles code, contextifies sandbox if passed or
creates a new contextified sandbox if it's omitted, and then runs the code with
the sandbox as the global object and returns the result.


vm.runInNewContext() takes the same options as vm.runInThisContext().


Example: compile and execute code that increments a global variable and sets a
new one. These globals are contained in the sandbox.


const util = require('util');
const vm = require('vm');

const sandbox = {
  animal: 'cat',
  count: 2
};

vm.runInNewContext('count += 1; name = "kitty"', sandbox);
console.log(util.inspect(sandbox));

// { animal: 'cat', count: 3, name: 'kitty' }



Note that running untrusted code is a tricky business requiring great care.
vm.runInNewContext() is quite useful, but safely running untrusted code requires
a separate process.


vm.runInThisContext(code[, options])#



Added in: v0.3.1

vm.runInThisContext() compiles code, runs it and returns the result. Running
code does not have access to local scope, but does have access to the current
global object.


Example of using vm.runInThisContext() and eval() to run the same code:


const vm = require('vm');
var localVar = 'initial value';

const vmResult = vm.runInThisContext('localVar = "vm";');
console.log('vmResult:', vmResult);
console.log('localVar:', localVar);

const evalResult = eval('localVar = "eval";');
console.log('evalResult:', evalResult);
console.log('localVar:', localVar);

// vmResult: 'vm', localVar: 'initial value'
// evalResult: 'eval', localVar: 'eval'



vm.runInThisContext() does not have access to the local scope, so localVar
is unchanged. eval() does have access to the local scope, so localVar is
changed.


In this way vm.runInThisContext() is much like an indirect eval() call,
e.g. (0,eval)('code'). However, it also has the following additional options:


    

  • filename: allows you to control the filename that shows up in any stack
traces produced.
    • 

  • lineOffset: allows you to add an offset to the line number that is
displayed in stack traces
    • 

  • columnOffset: allows you to add an offset to the column number that is
displayed in stack traces
    • 

  • displayErrors: whether or not to print any errors to stderr, with the
line of code that caused them highlighted, before throwing an exception.
Will capture both syntax errors from compiling code and runtime errors
thrown by executing the compiled code. Defaults to true.
    • 

  • timeout: a number of milliseconds to execute code before terminating
execution. If execution is terminated, an Error will be thrown.
    • 



Example: Run a Server within a VM#


The context of .runInThisContext() refers to the V8 context. The code passed
to this VM context will have it's own isolated scope. To run a simple web server
using the http module, for instance, the code passed to the context must either
call require('http') on its own, or have a reference to the http module passed
to it. For instance:


'use strict';
const vm = require('vm');

let code =
`(function(require) {

   const http = require('http');

   http.createServer( (request, response) => {
     response.writeHead(200, {'Content-Type': 'text/plain'});
     response.end('Hello World\\n');
   }).listen(8124);

   console.log('Server running at http://127.0.0.1:8124/');
 })`;

 vm.runInThisContext(code)(require);



Note: require() in the above case shares the state with context it is passed
from. This might introduce risks when unknown code is executed, e.g. altering
objects from the calling thread's context in unwanted ways. It is advisable to
run vm code in a separate process.




Zlib#


Stability: 2 - Stable
You can access this module with:


const zlib = require('zlib');

This provides bindings to Gzip/Gunzip, Deflate/Inflate, and
DeflateRaw/InflateRaw classes.  Each class takes the same options, and
is a readable/writable Stream.


Examples#


Compressing or decompressing a file can be done by piping an
fs.ReadStream into a zlib stream, then into an fs.WriteStream.


const gzip = zlib.createGzip();
const fs = require('fs');
const inp = fs.createReadStream('input.txt');
const out = fs.createWriteStream('input.txt.gz');

inp.pipe(gzip).pipe(out);



Compressing or decompressing data in one step can be done by using
the convenience methods.


const input = '.................................';
zlib.deflate(input, (err, buffer) => {
  if (!err) {
    console.log(buffer.toString('base64'));
  } else {
    // handle error
  }
});

const buffer = new Buffer('eJzT0yMAAGTvBe8=', 'base64');
zlib.unzip(buffer, (err, buffer) => {
  if (!err) {
    console.log(buffer.toString());
  } else {
    // handle error
  }
});



To use this module in an HTTP client or server, use the accept-encoding
on requests, and the content-encoding header on responses.


Note: these examples are drastically simplified to show
the basic concept.  Zlib encoding can be expensive, and the results
ought to be cached.  See Memory Usage Tuning for more information
on the speed/memory/compression tradeoffs involved in zlib usage.


// client request example
const zlib = require('zlib');
const http = require('http');
const fs = require('fs');
const request = http.get({ host: 'izs.me',
                         path: '/',
                         port: 80,
                         headers: { 'accept-encoding': 'gzip,deflate' } });
request.on('response', (response) => {
  var output = fs.createWriteStream('izs.me_index.html');

  switch (response.headers['content-encoding']) {
    // or, just use zlib.createUnzip() to handle both cases
    case 'gzip':
      response.pipe(zlib.createGunzip()).pipe(output);
      break;
    case 'deflate':
      response.pipe(zlib.createInflate()).pipe(output);
      break;
    default:
      response.pipe(output);
      break;
  }
});

// server example
// Running a gzip operation on every request is quite expensive.
// It would be much more efficient to cache the compressed buffer.
const zlib = require('zlib');
const http = require('http');
const fs = require('fs');
http.createServer((request, response) => {
  var raw = fs.createReadStream('index.html');
  var acceptEncoding = request.headers['accept-encoding'];
  if (!acceptEncoding) {
    acceptEncoding = '';
  }

  // Note: this is not a conformant accept-encoding parser.
  // See http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.3
  if (acceptEncoding.match(/\bdeflate\b/)) {
    response.writeHead(200, { 'content-encoding': 'deflate' });
    raw.pipe(zlib.createDeflate()).pipe(response);
  } else if (acceptEncoding.match(/\bgzip\b/)) {
    response.writeHead(200, { 'content-encoding': 'gzip' });
    raw.pipe(zlib.createGzip()).pipe(response);
  } else {
    response.writeHead(200, {});
    raw.pipe(response);
  }
}).listen(1337);



Memory Usage Tuning#



From zlib/zconf.h, modified to node.js's usage:


The memory requirements for deflate are (in bytes):


(1 << (windowBits+2)) +  (1 << (memLevel+9))

that is: 128K for windowBits=15  +  128K for memLevel = 8
(default values) plus a few kilobytes for small objects.


For example, if you want to reduce
the default memory requirements from 256K to 128K, set the options to:


{ windowBits: 14, memLevel: 7 }

Of course this will generally degrade compression (there's no free lunch).


The memory requirements for inflate are (in bytes)


1 << windowBits

that is, 32K for windowBits=15 (default value) plus a few kilobytes
for small objects.


This is in addition to a single internal output slab buffer of size
chunkSize, which defaults to 16K.


The speed of zlib compression is affected most dramatically by the
level setting.  A higher level will result in better compression, but
will take longer to complete.  A lower level will result in less
compression, but will be much faster.


In general, greater memory usage options will mean that node.js has to make
fewer calls to zlib, since it'll be able to process more data in a
single write operation.  So, this is another factor that affects the
speed, at the cost of memory usage.


Flushing#


Calling .flush() on a compression stream will make zlib return as much
output as currently possible. This may come at the cost of degraded compression
quality, but can be useful when data needs to be available as soon as possible.


In the following example, flush() is used to write a compressed partial
HTTP response to the client:


const zlib = require('zlib');
const http = require('http');

http.createServer((request, response) => {
  // For the sake of simplicity, the Accept-Encoding checks are omitted.
  response.writeHead(200, { 'content-encoding': 'gzip' });
  const output = zlib.createGzip();
  output.pipe(response);

  setInterval(() => {
    output.write(`The current time is ${Date()}\n`, () => {
      // The data has been passed to zlib, but the compression algorithm may
      // have decided to buffer the data for more efficient compression.
      // Calling .flush() will make the data available as soon as the client
      // is ready to receive it.
      output.flush();
    });
  }, 1000);
}).listen(1337);



Constants#



Added in: v0.5.8



All of the constants defined in zlib.h are also defined on
require('zlib').
In the normal course of operations, you will not need to ever set any of
these.  They are documented here so that their presence is not
surprising.  This section is taken almost directly from the
zlib documentation.  See http://zlib.net/manual.html#Constants for more
details.


Allowed flush values.


    

  • zlib.Z_NO_FLUSH
    • 

  • zlib.Z_PARTIAL_FLUSH
    • 

  • zlib.Z_SYNC_FLUSH
    • 

  • zlib.Z_FULL_FLUSH
    • 

  • zlib.Z_FINISH
    • 

  • zlib.Z_BLOCK
    • 

  • zlib.Z_TREES
    • 



Return codes for the compression/decompression functions. Negative
values are errors, positive values are used for special but normal
events.


    

  • zlib.Z_OK
    • 

  • zlib.Z_STREAM_END
    • 

  • zlib.Z_NEED_DICT
    • 

  • zlib.Z_ERRNO
    • 

  • zlib.Z_STREAM_ERROR
    • 

  • zlib.Z_DATA_ERROR
    • 

  • zlib.Z_MEM_ERROR
    • 

  • zlib.Z_BUF_ERROR
    • 

  • zlib.Z_VERSION_ERROR
    • 



Compression levels.


    

  • zlib.Z_NO_COMPRESSION
    • 

  • zlib.Z_BEST_SPEED
    • 

  • zlib.Z_BEST_COMPRESSION
    • 

  • zlib.Z_DEFAULT_COMPRESSION
    • 



Compression strategy.


    

  • zlib.Z_FILTERED
    • 

  • zlib.Z_HUFFMAN_ONLY
    • 

  • zlib.Z_RLE
    • 

  • zlib.Z_FIXED
    • 

  • zlib.Z_DEFAULT_STRATEGY
    • 



The deflate compression method (the only one supported in this version).


    

  • zlib.Z_DEFLATED
    • 



For initializing zalloc, zfree, opaque.


    

  • zlib.Z_NULL
    • 



Class Options#



Added in: v0.11.1



Each class takes an options object.  All options are optional.


Note that some options are only relevant when compressing, and are
ignored by the decompression classes.


    

  • flush (default: zlib.Z_NO_FLUSH)
    • 

  • chunkSize (default: 16*1024)
    • 

  • windowBits
    • 

  • level (compression only)
    • 

  • memLevel (compression only)
    • 

  • strategy (compression only)
    • 

  • dictionary (deflate/inflate only, empty dictionary by default)
    • 



See the description of deflateInit2 and inflateInit2 at
http://zlib.net/manual.html#Advanced for more information on these.


Class: zlib.Deflate#



Added in: v0.5.8

Compress data using deflate.


Class: zlib.DeflateRaw#



Added in: v0.5.8

Compress data using deflate, and do not append a zlib header.


Class: zlib.Gunzip#



Added in: v0.5.8

Decompress a gzip stream.


Class: zlib.Gzip#



Added in: v0.5.8

Compress data using gzip.


Class: zlib.Inflate#



Added in: v0.5.8

Decompress a deflate stream.


Class: zlib.InflateRaw#



Added in: v0.5.8

Decompress a raw deflate stream.


Class: zlib.Unzip#



Added in: v0.5.8

Decompress either a Gzip- or Deflate-compressed stream by auto-detecting
the header.


Class: zlib.Zlib#



Added in: v0.5.8

Not exported by the zlib module. It is documented here because it is the base
class of the compressor/decompressor classes.


zlib.flush([kind], callback)#



Added in: v0.5.8

kind defaults to zlib.Z_FULL_FLUSH.


Flush pending data. Don't call this frivolously, premature flushes negatively
impact the effectiveness of the compression algorithm.


Calling this only flushes data from the internal zlib state, and does not
perform flushing of any kind on the streams level. Rather, it behaves like a
normal call to .write(), i.e. it will be queued up behind other pending
writes and will only produce output when data is being read from the stream.


zlib.params(level, strategy, callback)#



Added in: v0.11.4

Dynamically update the compression level and compression strategy.
Only applicable to deflate algorithm.


zlib.reset()#



Added in: v0.7.0

Reset the compressor/decompressor to factory defaults. Only applicable to
the inflate and deflate algorithms.


zlib.createDeflate(options)#



Added in: v0.5.8

Returns a new Deflate object with an options.


zlib.createDeflateRaw(options)#



Added in: v0.5.8

Returns a new DeflateRaw object with an options.


zlib.createGunzip(options)#



Added in: v0.5.8

Returns a new Gunzip object with an options.


zlib.createGzip(options)#



Added in: v0.5.8

Returns a new Gzip object with an options.


zlib.createInflate(options)#



Added in: v0.5.8

Returns a new Inflate object with an options.


zlib.createInflateRaw(options)#



Added in: v0.5.8

Returns a new InflateRaw object with an options.


zlib.createUnzip(options)#



Added in: v0.5.8

Returns a new Unzip object with an options.


Convenience Methods#



All of these take a Buffer or string as the first argument, an optional second
argument to supply options to the zlib classes and will call the supplied
callback with callback(error, result).


Every method has a *Sync counterpart, which accept the same arguments, but
without a callback.


zlib.deflate(buf[, options], callback)#



Added in: v0.6.0

zlib.deflateSync(buf[, options])#



Added in: v0.11.12

Compress a Buffer or string with Deflate.


zlib.deflateRaw(buf[, options], callback)#



Added in: v0.6.0

zlib.deflateRawSync(buf[, options])#



Added in: v0.11.12

Compress a Buffer or string with DeflateRaw.


zlib.gunzip(buf[, options], callback)#



Added in: v0.6.0

zlib.gunzipSync(buf[, options])#



Added in: v0.11.12

Decompress a Buffer or string with Gunzip.


zlib.gzip(buf[, options], callback)#



Added in: v0.6.0

zlib.gzipSync(buf[, options])#



Added in: v0.11.12

Compress a Buffer or string with Gzip.


zlib.inflate(buf[, options], callback)#



Added in: v0.6.0

zlib.inflateSync(buf[, options])#



Added in: v0.11.12

Decompress a Buffer or string with Inflate.


zlib.inflateRaw(buf[, options], callback)#



Added in: v0.6.0

zlib.inflateRawSync(buf[, options])#



Added in: v0.11.12

Decompress a Buffer or string with InflateRaw.


zlib.unzip(buf[, options], callback)#



Added in: v0.6.0

zlib.unzipSync(buf[, options])#



Added in: v0.11.12

Decompress a Buffer or string with Unzip.



      

    

  

  
  
  
  



node-v4.8.2/doc/api/all.json000644 000766 000024 00005557075 13070706740 015765 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/all.md",
  "desc": [
    {
      "type": "html",
      "pre": false,
      "text": "\n"
    }
  ],
  "miscs": [
    {
      "textRaw": "About this Documentation",
      "name": "About this Documentation",
      "type": "misc",
      "desc": "
The goal of this documentation is to comprehensively explain the Node.js\nAPI, both from a reference as well as a conceptual point of view.  Each\nsection describes a built-in module or high-level concept.
\n
Where appropriate, property types, method arguments, and the arguments\nprovided to event handlers are detailed in a list underneath the topic\nheading.
\n
Every .html document has a corresponding .json document presenting\nthe same information in a structured manner.  This feature is\nexperimental, and added for the benefit of IDEs and other utilities that\nwish to do programmatic things with the documentation.
\n
Every .html and .json file is generated based on the corresponding\n.md file in the doc/api/ folder in Node.js's source tree.  The\ndocumentation is generated using the tools/doc/generate.js program.\nThe HTML template is located at doc/template.html.
\n
If you find an error in this documentation, please submit an issue\nor see the contributing guide for directions on how to submit a patch.
\n",
      "miscs": [
        {
          "textRaw": "Stability Index",
          "name": "Stability Index",
          "type": "misc",
          "desc": "
Throughout the documentation, you will see indications of a section's\nstability.  The Node.js API is still somewhat changing, and as it\nmatures, certain parts are more reliable than others.  Some are so\nproven, and so relied upon, that they are unlikely to ever change at\nall.  Others are brand new and experimental, or known to be hazardous\nand in the process of being redesigned.
\n
The stability indices are as follows:
\n
Stability: 0 - Deprecated\nThis feature is known to be problematic, and changes are\nplanned.  Do not rely on it.  Use of the feature may cause warnings.  Backwards\ncompatibility should not be expected.\n
Stability: 1 - Experimental\nThis feature is subject to change, and is gated by a command line flag.\nIt may change or be removed in future versions.\n
Stability: 2 - Stable\nThe API has proven satisfactory. Compatibility with the npm ecosystem\nis a high priority, and will not be broken unless absolutely necessary.\n
Stability: 3 - Locked\nOnly bug fixes, security fixes, and performance improvements will be accepted.\nPlease do not suggest API changes in this area; they will be refused.\n
"
        },
        {
          "textRaw": "JSON Output",
          "name": "json_output",
          "stability": 1,
          "stabilityText": "Experimental",
          "desc": "
Every HTML file in the markdown has a corresponding JSON file with the\nsame data.
\n
This feature was added in Node.js v0.6.12.  It is experimental.
\n",
          "type": "misc",
          "displayName": "JSON Output"
        },
        {
          "textRaw": "Syscalls and man pages",
          "name": "syscalls_and_man_pages",
          "desc": "
System calls like open(2) and read(2) define the interface between user programs\nand the underlying operating system. Node functions which simply wrap a syscall,\nlike fs.open(), will document that. The docs link to the corresponding man\npages (short for manual pages) which describe how the syscalls work.
\n
Caveat: some syscalls, like lchown(2), are BSD-specific. That means, for\nexample, that fs.lchown() only works on Mac OS X and other BSD-derived systems,\nand is not available on Linux.
\n
Most Unix syscalls have Windows equivalents, but behavior may differ on Windows\nrelative to Linux and OS X. For an example of the subtle ways in which it's\nsometimes impossible to replace Unix syscall semantics on Windows, see Node\nissue 4760.
\n\n\n",
          "type": "misc",
          "displayName": "Syscalls and man pages"
        }
      ]
    },
    {
      "textRaw": "Usage",
      "name": "Usage",
      "type": "misc",
      "desc": "
node [options] [v8 options] [script.js | -e "script"] [arguments]
\n
Please see the Command Line Options document for information about\ndifferent options and ways to run scripts with Node.
\n
Example
\n
An example of a web server written with Node.js which responds with\n'Hello World':
\n
const http = require('http');\n\nconst hostname = '127.0.0.1';\nconst port = 3000;\n\nconst server = http.createServer((req, res) => {\n  res.statusCode = 200;\n  res.setHeader('Content-Type', 'text/plain');\n  res.end('Hello World\\n');\n});\n\nserver.listen(port, hostname, () => {\n  console.log(`Server running at http://${hostname}:${port}/`);\n});\n
\n
To run the server, put the code into a file called example.js and execute\nit with Node.js:
\n
$ node example.js\nServer running at http://127.0.0.1:3000/\n
All of the examples in the documentation can be run similarly.
\n\n\n"
    },
    {
      "textRaw": "Command Line Options",
      "name": "Command Line Options",
      "type": "misc",
      "desc": "
Node.js comes with a variety of CLI options. These options expose built-in\ndebugging, multiple ways to execute scripts, and other helpful runtime options.
\n
To view this documentation as a manual page in your terminal, run man node.
\n",
      "miscs": [
        {
          "textRaw": "Synopsis",
          "name": "synopsis",
          "desc": "
node [options] [v8 options] [script.js | -e "script"] [arguments]
\n
node debug [script.js | -e "script" | <host>:<port>] …
\n
node --v8-options
\n
Execute without arguments to start the REPL.
\n
For more info about node debug, please see the debugger documentation.
\n",
          "type": "misc",
          "displayName": "Synopsis"
        },
        {
          "textRaw": "Options",
          "name": "options",
          "modules": [
            {
              "textRaw": "`-v`, `--version`",
              "name": "`-v`,_`--version`",
              "meta": {
                "added": [
                  "v0.1.3"
                ]
              },
              "desc": "
Print node's version.
\n",
              "type": "module",
              "displayName": "`-v`, `--version`"
            },
            {
              "textRaw": "`-h`, `--help`",
              "name": "`-h`,_`--help`",
              "meta": {
                "added": [
                  "v0.1.3"
                ]
              },
              "desc": "
Print node command line options.\nThe output of this option is less detailed than this document.
\n",
              "type": "module",
              "displayName": "`-h`, `--help`"
            },
            {
              "textRaw": "`-e`, `--eval \"script\"`",
              "name": "`-e`,_`--eval_\"script\"`",
              "meta": {
                "added": [
                  "v0.5.2"
                ]
              },
              "desc": "
Evaluate the following argument as JavaScript.
\n",
              "type": "module",
              "displayName": "`-e`, `--eval \"script\"`"
            },
            {
              "textRaw": "`-p`, `--print \"script\"`",
              "name": "`-p`,_`--print_\"script\"`",
              "meta": {
                "added": [
                  "v0.6.4"
                ]
              },
              "desc": "
Identical to -e but prints the result.
\n",
              "type": "module",
              "displayName": "`-p`, `--print \"script\"`"
            },
            {
              "textRaw": "`-c`, `--check`",
              "name": "`-c`,_`--check`",
              "meta": {
                "added": [
                  "v4.2.0"
                ]
              },
              "desc": "
Syntax check the script without executing.
\n",
              "type": "module",
              "displayName": "`-c`, `--check`"
            },
            {
              "textRaw": "`-i`, `--interactive`",
              "name": "`-i`,_`--interactive`",
              "meta": {
                "added": [
                  "v0.7.7"
                ]
              },
              "desc": "
Opens the REPL even if stdin does not appear to be a terminal.
\n",
              "type": "module",
              "displayName": "`-i`, `--interactive`"
            },
            {
              "textRaw": "`-r`, `--require module`",
              "name": "`-r`,_`--require_module`",
              "meta": {
                "added": [
                  "v1.6.0"
                ]
              },
              "desc": "
Preload the specified module at startup.
\n
Follows require()'s module resolution\nrules. module may be either a path to a file, or a node module name.
\n",
              "type": "module",
              "displayName": "`-r`, `--require module`"
            },
            {
              "textRaw": "`--no-deprecation`",
              "name": "`--no-deprecation`",
              "meta": {
                "added": [
                  "v0.8.0"
                ]
              },
              "desc": "
Silence deprecation warnings.
\n",
              "type": "module",
              "displayName": "`--no-deprecation`"
            },
            {
              "textRaw": "`--trace-deprecation`",
              "name": "`--trace-deprecation`",
              "meta": {
                "added": [
                  "v0.8.0"
                ]
              },
              "desc": "
Print stack traces for deprecations.
\n",
              "type": "module",
              "displayName": "`--trace-deprecation`"
            },
            {
              "textRaw": "`--throw-deprecation`",
              "name": "`--throw-deprecation`",
              "meta": {
                "added": [
                  "v0.11.14"
                ]
              },
              "desc": "
Throw errors for deprecations.
\n",
              "type": "module",
              "displayName": "`--throw-deprecation`"
            },
            {
              "textRaw": "`--trace-sync-io`",
              "name": "`--trace-sync-io`",
              "meta": {
                "added": [
                  "v2.1.0"
                ]
              },
              "desc": "
Prints a stack trace whenever synchronous I/O is detected after the first turn\nof the event loop.
\n",
              "type": "module",
              "displayName": "`--trace-sync-io`"
            },
            {
              "textRaw": "`--zero-fill-buffers`",
              "name": "`--zero-fill-buffers`",
              "meta": {
                "added": [
                  "v4.5.0"
                ]
              },
              "desc": "
Automatically zero-fills all newly allocated Buffer and SlowBuffer\ninstances.
\n",
              "type": "module",
              "displayName": "`--zero-fill-buffers`"
            },
            {
              "textRaw": "`--track-heap-objects`",
              "name": "`--track-heap-objects`",
              "meta": {
                "added": [
                  "v2.4.0"
                ]
              },
              "desc": "
Track heap object allocations for heap snapshots.
\n",
              "type": "module",
              "displayName": "`--track-heap-objects`"
            },
            {
              "textRaw": "`--prof-process`",
              "name": "`--prof-process`",
              "meta": {
                "added": [
                  "v4.4.0"
                ]
              },
              "desc": "
Process v8 profiler output generated using the v8 option --prof.
\n",
              "type": "module",
              "displayName": "`--prof-process`"
            },
            {
              "textRaw": "`--v8-options`",
              "name": "`--v8-options`",
              "meta": {
                "added": [
                  "v0.1.3"
                ]
              },
              "desc": "
Print v8 command line options.
\n",
              "type": "module",
              "displayName": "`--v8-options`"
            },
            {
              "textRaw": "`--tls-cipher-list=list`",
              "name": "`--tls-cipher-list=list`",
              "meta": {
                "added": [
                  "v4.0.0"
                ]
              },
              "desc": "
Specify an alternative default TLS cipher list. (Requires Node.js to be built\nwith crypto support. (Default))
\n",
              "type": "module",
              "displayName": "`--tls-cipher-list=list`"
            },
            {
              "textRaw": "`--enable-fips`",
              "name": "`--enable-fips`",
              "desc": "
Enable FIPS-compliant crypto at startup. (Requires Node.js to be built with\n./configure --openssl-fips)
\n",
              "type": "module",
              "displayName": "`--enable-fips`"
            },
            {
              "textRaw": "`--force-fips`",
              "name": "`--force-fips`",
              "desc": "
Force FIPS-compliant crypto on startup. (Cannot be disabled from script code.)\n(Same requirements as --enable-fips)
\n",
              "type": "module",
              "displayName": "`--force-fips`"
            },
            {
              "textRaw": "`--icu-data-dir=file`",
              "name": "`--icu-data-dir=file`",
              "meta": {
                "added": [
                  "v0.11.15"
                ]
              },
              "desc": "
Specify ICU data load path. (overrides NODE_ICU_DATA)
\n",
              "type": "module",
              "displayName": "`--icu-data-dir=file`"
            }
          ],
          "type": "misc",
          "displayName": "Options"
        },
        {
          "textRaw": "Environment Variables",
          "name": "environment_variables",
          "modules": [
            {
              "textRaw": "`NODE_DEBUG=module[,…]`",
              "name": "`node_debug=module[,…]`",
              "meta": {
                "added": [
                  "v0.1.32"
                ]
              },
              "desc": "
','-separated list of core modules that should print debug information.
\n",
              "type": "module",
              "displayName": "`NODE_DEBUG=module[,…]`"
            },
            {
              "textRaw": "`NODE_PATH=path[:…]`",
              "name": "`node_path=path[:…]`",
              "meta": {
                "added": [
                  "v0.1.32"
                ]
              },
              "desc": "
':'-separated list of directories prefixed to the module search path.
\n
Note: on Windows, this is a ';'-separated list instead.
\n",
              "type": "module",
              "displayName": "`NODE_PATH=path[:…]`"
            },
            {
              "textRaw": "`NODE_DISABLE_COLORS=1`",
              "name": "`node_disable_colors=1`",
              "meta": {
                "added": [
                  "v0.3.0"
                ]
              },
              "desc": "
When set to 1 colors will not be used in the REPL.
\n",
              "type": "module",
              "displayName": "`NODE_DISABLE_COLORS=1`"
            },
            {
              "textRaw": "`NODE_ICU_DATA=file`",
              "name": "`node_icu_data=file`",
              "meta": {
                "added": [
                  "v0.11.15"
                ]
              },
              "desc": "
Data path for ICU (Intl object) data. Will extend linked-in data when compiled\nwith small-icu support.
\n",
              "type": "module",
              "displayName": "`NODE_ICU_DATA=file`"
            },
            {
              "textRaw": "`NODE_REPL_HISTORY=file`",
              "name": "`node_repl_history=file`",
              "meta": {
                "added": [
                  "v3.0.0"
                ]
              },
              "desc": "
Path to the file used to store the persistent REPL history. The default path is\n~/.node_repl_history, which is overridden by this variable. Setting the value\nto an empty string ("" or " ") disables persistent REPL history.
\n",
              "type": "module",
              "displayName": "`NODE_REPL_HISTORY=file`"
            },
            {
              "textRaw": "`NODE_EXTRA_CA_CERTS=file`",
              "name": "`node_extra_ca_certs=file`",
              "meta": {
                "added": [
                  "XXX"
                ]
              },
              "desc": "
When set, the well known "root" CAs (like VeriSign) will be extended with the\nextra certificates in file. The file should consist of one or more trusted\ncertificates in PEM format. A message will be printed to stderr (once)\nif the file is missing or\nmisformatted, but any errors are otherwise ignored.
\n
Note that neither the well known nor extra certificates are used when the ca\noptions property is explicitly specified for a TLS or HTTPS client or server.
\n\n\n",
              "type": "module",
              "displayName": "`NODE_EXTRA_CA_CERTS=file`"
            }
          ],
          "type": "misc",
          "displayName": "Environment Variables"
        }
      ]
    },
    {
      "textRaw": "Debugger",
      "name": "Debugger",
      "stability": 2,
      "stabilityText": "Stable",
      "type": "misc",
      "desc": "
Node.js includes an out-of-process debugging utility accessible via a\nTCP-based protocol and built-in debugging client. To use it, start Node.js\nwith the debug argument followed by the path to the script to debug; a prompt\nwill be displayed indicating successful launch of the debugger:
\n
$ node debug myscript.js\n< debugger listening on port 5858\nconnecting... ok\nbreak in /home/indutny/Code/git/indutny/myscript.js:1\n  1 x = 5;\n  2 setTimeout(() => {\n  3   debugger;\ndebug>\n
Node.js's debugger client is not a full-featured debugger, but simple step and\ninspection are possible.
\n
Inserting the statement debugger; into the source code of a script will\nenable a breakpoint at that position in the code:
\n
// myscript.js\nx = 5;\nsetTimeout(() => {\n  debugger;\n  console.log('world');\n}, 1000);\nconsole.log('hello');\n
\n
Once the debugger is run, a breakpoint will occur at line 4:
\n
$ node debug myscript.js\n< debugger listening on port 5858\nconnecting... ok\nbreak in /home/indutny/Code/git/indutny/myscript.js:1\n  1 x = 5;\n  2 setTimeout(() => {\n  3   debugger;\ndebug> cont\n< hello\nbreak in /home/indutny/Code/git/indutny/myscript.js:3\n  1 x = 5;\n  2 setTimeout(() => {\n  3   debugger;\n  4   console.log('world');\n  5 }, 1000);\ndebug> next\nbreak in /home/indutny/Code/git/indutny/myscript.js:4\n  2 setTimeout(() => {\n  3   debugger;\n  4   console.log('world');\n  5 }, 1000);\n  6 console.log('hello');\ndebug> repl\nPress Ctrl + C to leave debug repl\n> x\n5\n> 2+2\n4\ndebug> next\n< world\nbreak in /home/indutny/Code/git/indutny/myscript.js:5\n  3   debugger;\n  4   console.log('world');\n  5 }, 1000);\n  6 console.log('hello');\n  7\ndebug> quit\n
The repl command allows code to be evaluated remotely. The next command\nsteps to the next line. Type help to see what other commands are available.
\n",
      "miscs": [
        {
          "textRaw": "Watchers",
          "name": "watchers",
          "desc": "
It is possible to watch expression and variable values while debugging. On\nevery breakpoint, each expression from the watchers list will be evaluated\nin the current context and displayed immediately before the breakpoint's\nsource code listing.
\n
To begin watching an expression, type watch('my_expression'). The command\nwatchers will print the active watchers. To remove a watcher, type\nunwatch('my_expression').
\n",
          "type": "misc",
          "displayName": "Watchers"
        },
        {
          "textRaw": "Command reference",
          "name": "command_reference",
          "modules": [
            {
              "textRaw": "Stepping",
              "name": "Stepping",
              "desc": "
    \n
  • cont, c - Continue execution
    • \n
  • next, n - Step next
    • \n
  • step, s - Step in
    • \n
  • out, o - Step out
    • \n
  • pause - Pause running code (like pause button in Developer Tools)
    • \n
\n",
              "type": "module",
              "displayName": "Breakpoints"
            },
            {
              "textRaw": "Breakpoints",
              "name": "breakpoints",
              "desc": "
    \n
  • setBreakpoint(), sb() - Set breakpoint on current line
    • \n
  • setBreakpoint(line), sb(line) - Set breakpoint on specific line
    • \n
  • setBreakpoint('fn()'), sb(...) - Set breakpoint on a first statement in\nfunctions body
    • \n
  • setBreakpoint('script.js', 1), sb(...) - Set breakpoint on first line of\nscript.js
    • \n
  • clearBreakpoint('script.js', 1), cb(...) - Clear breakpoint in script.js\non line 1
    • \n
\n
It is also possible to set a breakpoint in a file (module) that\nisn't loaded yet:
\n
$ node debug test/fixtures/break-in-module/main.js\n< debugger listening on port 5858\nconnecting to port 5858... ok\nbreak in test/fixtures/break-in-module/main.js:1\n  1 var mod = require('./mod.js');\n  2 mod.hello();\n  3 mod.hello();\ndebug> setBreakpoint('mod.js', 23)\nWarning: script 'mod.js' was not loaded yet.\n  1 var mod = require('./mod.js');\n  2 mod.hello();\n  3 mod.hello();\ndebug> c\nbreak in test/fixtures/break-in-module/mod.js:23\n 21\n 22 exports.hello = () => {\n 23   return 'hello from module';\n 24 };\n 25\ndebug>\n
",
              "type": "module",
              "displayName": "Breakpoints"
            },
            {
              "textRaw": "Execution control",
              "name": "Execution control",
              "desc": "
    \n
  • run - Run script (automatically runs on debugger's start)
    • \n
  • restart - Restart script
    • \n
  • kill - Kill script
    • \n
\n",
              "type": "module",
              "displayName": "Various"
            },
            {
              "textRaw": "Various",
              "name": "various",
              "desc": "
    \n
  • scripts - List all loaded scripts
    • \n
  • version - Display V8's version
    • \n
\n",
              "type": "module",
              "displayName": "Various"
            }
          ],
          "type": "misc",
          "displayName": "Command reference"
        },
        {
          "textRaw": "Advanced Usage",
          "name": "advanced_usage",
          "desc": "
An alternative way of enabling and accessing the debugger is to start\nNode.js with the --debug command-line flag or by signaling an existing\nNode.js process with SIGUSR1.
\n
Once a process has been set in debug mode this way, it can be inspected\nusing the Node.js debugger by either connecting to the pid of the running\nprocess or via URI reference to the listening debugger:
\n
    \n
  • node debug -p <pid> - Connects to the process via the pid
    • \n
  • node debug <URI> - Connects to the process via the URI such as\nlocalhost:5858
    • \n
\n\n\n",
          "type": "misc",
          "displayName": "Advanced Usage"
        }
      ]
    },
    {
      "textRaw": "Errors",
      "name": "Errors",
      "type": "misc",
      "desc": "
Applications running in Node.js will generally experience four categories of\nerrors:
\n
    \n
  • Standard JavaScript errors such as:
      \n
    • {EvalError} : thrown when a call to eval() fails.
      • \n
    • {SyntaxError} : thrown in response to improper JavaScript language\nsyntax.
      • \n
    • {RangeError} : thrown when a value is not within an expected range
      • \n
    • {ReferenceError} : thrown when using undefined variables
      • \n
    • {TypeError} : thrown when passing arguments of the wrong type
      • \n
    • {URIError} : thrown when a global URI handling function is misused.
      • \n
    \n
    • \n
  • System errors triggered by underlying operating system constraints such\nas attempting to open a file that does not exist, attempting to send data\nover a closed socket, etc;
    • \n
  • And User-specified errors triggered by application code.
    • \n
  • Assertion Errors are a special class of error that can be triggered whenever\nNode.js detects an exceptional logic violation that should never occur. These\nare raised typically by the assert module.
    • \n
\n
All JavaScript and System errors raised by Node.js inherit from, or are\ninstances of, the standard JavaScript {Error} class and are guaranteed\nto provide at least the properties available on that class.
\n",
      "miscs": [
        {
          "textRaw": "Error Propagation and Interception",
          "name": "Error Propagation and Interception",
          "type": "misc",
          "desc": "
Node.js supports several mechanisms for propagating and handling errors that\noccur while an application is running. How these errors are reported and\nhandled depends entirely on the type of Error and the style of the API that is\ncalled.
\n
All JavaScript errors are handled as exceptions that immediately generate\nand throw an error using the standard JavaScript throw mechanism. These\nare handled using the try / catch construct provided by the JavaScript\nlanguage.
\n
// Throws with a ReferenceError because z is undefined\ntry {\n  const m = 1;\n  const n = m + z;\n} catch (err) {\n  // Handle the error here.\n}\n
\n
Any use of the JavaScript throw mechanism will raise an exception that\nmust be handled using try / catch or the Node.js process will exit\nimmediately.
\n
With few exceptions, Synchronous APIs (any blocking method that does not\naccept a callback function, such as fs.readFileSync), will use throw\nto report errors.
\n
Errors that occur within Asynchronous APIs may be reported in multiple ways:
\n
    \n
  • Most asynchronous methods that accept a callback function will accept an\nError object passed as the first argument to that function. If that first\nargument is not null and is an instance of Error, then an error occurred\nthat should be handled.
    \n
    const fs = require('fs');\nfs.readFile('a file that does not exist', (err, data) => {\n  if (err) {\n    console.error('There was an error reading the file!', err);\n    return;\n  }\n  // Otherwise handle the data\n});\n
    \n
    • \n
  • When an asynchronous method is called on an object that is an EventEmitter,\nerrors can be routed to that object's 'error' event.
    \n
    const net = require('net');\nconst connection = net.connect('localhost');\n\n// Adding an 'error' event handler to a stream:\nconnection.on('error', (err) => {\n  // If the connection is reset by the server, or if it can't\n  // connect at all, or on any sort of error encountered by\n  // the connection, the error will be sent here.\n  console.error(err);\n});\n\nconnection.pipe(process.stdout);\n
    \n
    • \n
  • A handful of typically asynchronous methods in the Node.js API may still\nuse the throw mechanism to raise exceptions that must be handled using\ntry / catch. There is no comprehensive list of such methods; please\nrefer to the documentation of each method to determine the appropriate\nerror handling mechanism required.
    \n
    • \n
\n
The use of the 'error' event mechanism is most common for stream-based\nand event emitter-based APIs, which themselves represent a series of\nasynchronous operations over time (as opposed to a single operation that may\npass or fail).
\n
For all EventEmitter objects, if an 'error' event handler is not\nprovided, the error will be thrown, causing the Node.js process to report an\nunhandled exception and  crash unless either: The domain module is used\nappropriately or a handler has been registered for the\nprocess.on('uncaughtException') event.
\n
const EventEmitter = require('events');\nconst ee = new EventEmitter();\n\nsetImmediate(() => {\n  // This will crash the process because no 'error' event\n  // handler has been added.\n  ee.emit('error', new Error('This will crash'));\n});\n
\n
Errors generated in this way cannot be intercepted using try / catch as\nthey are thrown after the calling code has already exited.
\n
Developers must refer to the documentation for each method to determine\nexactly how errors raised by those methods are propagated.
\n",
          "miscs": [
            {
              "textRaw": "Node.js style callbacks",
              "name": "Node.js style callbacks",
              "type": "misc",
              "desc": "
Most asynchronous methods exposed by the Node.js core API follow an idiomatic\npattern  referred to as a "Node.js style callback". With this pattern, a\ncallback function is passed to the method as an argument. When the operation\neither completes or an error is raised, the callback function is called with\nthe Error object (if any) passed as the first argument. If no error was raised,\nthe first argument will be passed as null.
\n
const fs = require('fs');\n\nfunction nodeStyleCallback(err, data) {\n if (err) {\n   console.error('There was an error', err);\n   return;\n }\n console.log(data);\n}\n\nfs.readFile('/some/file/that/does-not-exist', nodeStyleCallback);\nfs.readFile('/some/file/that/does-exist', nodeStyleCallback)\n
\n
The JavaScript try / catch mechanism cannot be used to intercept errors\ngenerated by asynchronous APIs.  A common mistake for beginners is to try to\nuse throw inside a Node.js style callback:
\n
// THIS WILL NOT WORK:\nconst fs = require('fs');\n\ntry {\n  fs.readFile('/some/file/that/does-not-exist', (err, data) => {\n    // mistaken assumption: throwing here...\n    if (err) {\n      throw err;\n    }\n  });\n} catch(err) {\n  // This will not catch the throw!\n  console.log(err);\n}\n
\n
This will not work because the callback function passed to fs.readFile() is\ncalled asynchronously. By the time the callback has been called, the\nsurrounding code (including the try { } catch(err) { } block will have\nalready exited. Throwing an error inside the callback can crash the Node.js\nprocess in most cases. If domains are enabled, or a handler has been\nregistered with process.on('uncaughtException'), such errors can be\nintercepted.
\n"
            }
          ]
        },
        {
          "textRaw": "Exceptions vs. Errors",
          "name": "Exceptions vs. Errors",
          "type": "misc",
          "desc": "
A JavaScript exception is a value that is thrown as a result of an invalid\noperation or as the target of a throw statement. While it is not required\nthat these values are instances of Error or classes which inherit from\nError, all exceptions thrown by Node.js or the JavaScript runtime will be\ninstances of Error.
\n
Some exceptions are unrecoverable at the JavaScript layer. Such exceptions\nwill always cause the Node.js process to crash. Examples include assert()\nchecks or abort() calls in the C++ layer.
\n"
        },
        {
          "textRaw": "System Errors",
          "name": "system_errors",
          "desc": "
System errors are generated when exceptions occur within the program's\nruntime environment. Typically, these are operational errors that occur\nwhen an application violates an operating system constraint such as attempting\nto read a file that does not exist or when the user does not have sufficient\npermissions.
\n
System errors are typically generated at the syscall level: an exhaustive list\nof error codes and their meanings is available by running man 2 intro or\nman 3 errno on most Unices; or online.
\n
In Node.js, system errors are represented as augmented Error objects with\nadded properties.
\n",
          "classes": [
            {
              "textRaw": "Class: System Error",
              "type": "class",
              "name": "System",
              "properties": [
                {
                  "textRaw": "`code` {String} ",
                  "type": "String",
                  "name": "code",
                  "desc": "
The error.code property is a string representing the error code, which is always\nE followed by a sequence of capital letters.
\n"
                },
                {
                  "textRaw": "`errno` {String | Number} ",
                  "type": "String | Number",
                  "name": "errno",
                  "desc": "
The error.errno property is a number or a string.\nThe number is a negative value which corresponds to the error code defined in\nlibuv Error handling. See uv-errno.h header file (deps/uv/include/uv-errno.h in\nthe Node.js source tree) for details.\nIn case of a string, it is the same as error.code.
\n"
                },
                {
                  "textRaw": "`syscall` {String} ",
                  "type": "String",
                  "name": "syscall",
                  "desc": "
The error.syscall property is a string describing the syscall that failed.
\n"
                },
                {
                  "textRaw": "`path` {String} ",
                  "type": "String",
                  "name": "path",
                  "desc": "
When present (e.g. in fs or child_process), the error.path property is a string\ncontaining a relevant invalid pathname.
\n"
                },
                {
                  "textRaw": "`address` {String} ",
                  "type": "String",
                  "name": "address",
                  "desc": "
When present (e.g. in net or dgram), the error.address property is a string\ndescribing the address to which the connection failed.
\n"
                },
                {
                  "textRaw": "`port` {Number} ",
                  "type": "Number",
                  "name": "port",
                  "desc": "
When present (e.g. in net or dgram), the error.port property is a number representing\nthe connection's port that is not available.
\n"
                }
              ]
            }
          ],
          "modules": [
            {
              "textRaw": "Common System Errors",
              "name": "common_system_errors",
              "desc": "
This list is not exhaustive, but enumerates many of the common system\nerrors encountered when writing a Node.js program. An exhaustive list may be\nfound here.
\n
    \n
  • EACCES (Permission denied): An attempt was made to access a file in a way\nforbidden by its file access permissions.
    \n
    • \n
  • EADDRINUSE (Address already in use):  An attempt to bind a server\n(net, http, or https) to a local address failed due to\nanother server on the local system already occupying that address.
    \n
    • \n
  • ECONNREFUSED (Connection refused): No connection could be made because the\ntarget machine actively refused it. This usually results from trying to\nconnect to a service that is inactive on the foreign host.
    \n
    • \n
  • ECONNRESET (Connection reset by peer): A connection was forcibly closed by\na peer. This normally results from a loss of the connection on the remote\nsocket due to a timeout or reboot. Commonly encountered via the http\nand net modules.
    \n
    • \n
  • EEXIST (File exists): An existing file was the target of an operation that\nrequired that the target not exist.
    \n
    • \n
  • EISDIR (Is a directory): An operation expected a file, but the given\npathname was a directory.
    \n
    • \n
  • EMFILE (Too many open files in system): Maximum number of\nfile descriptors allowable on the system has been reached, and\nrequests for another descriptor cannot be fulfilled until at least one\nhas been closed. This is encountered when opening many files at once in\nparallel, especially on systems (in particular, OS X) where there is a low\nfile descriptor limit for processes. To remedy a low limit, run\nulimit -n 2048 in the same shell that will run the Node.js process.
    \n
    • \n
  • ENOENT (No such file or directory): Commonly raised by fs operations\nto indicate that a component of the specified pathname does not exist -- no\nentity (file or directory) could be found by the given path.
    \n
    • \n
  • ENOTDIR (Not a directory): A component of the given pathname existed, but\nwas not a directory as expected. Commonly raised by fs.readdir.
    \n
    • \n
  • ENOTEMPTY (Directory not empty): A directory with entries was the target\nof an operation that requires an empty directory -- usually fs.unlink.
    \n
    • \n
  • EPERM (Operation not permitted): An attempt was made to perform an\noperation that requires elevated privileges.
    \n
    • \n
  • EPIPE (Broken pipe): A write on a pipe, socket, or FIFO for which there is\nno process to read the data. Commonly encountered at the net and\nhttp layers, indicative that the remote side of the stream being\nwritten to has been closed.
    \n
    • \n
  • ETIMEDOUT (Operation timed out): A connect or send request failed because\nthe connected party did not properly respond after a period of time. Usually\nencountered by http or net -- often a sign that a socket.end()\nwas not properly called.
    \n
    • \n
\n\n\n",
              "type": "module",
              "displayName": "Common System Errors"
            }
          ],
          "type": "misc",
          "displayName": "System Errors"
        }
      ],
      "classes": [
        {
          "textRaw": "Class: Error",
          "type": "class",
          "name": "Error",
          "desc": "
A generic JavaScript Error object that does not denote any specific\ncircumstance of why the error occurred. Error objects capture a "stack trace"\ndetailing the point in the code at which the Error was instantiated, and may\nprovide a text description of the error.
\n
All errors generated by Node.js, including all System and JavaScript errors,\nwill either be instances of, or inherit from, the Error class.
\n",
          "methods": [
            {
              "textRaw": "Error.captureStackTrace(targetObject[, constructorOpt])",
              "type": "method",
              "name": "captureStackTrace",
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`targetObject` {Object} ",
                      "name": "targetObject",
                      "type": "Object"
                    },
                    {
                      "textRaw": "`constructorOpt` {Function} ",
                      "name": "constructorOpt",
                      "type": "Function",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "targetObject"
                    },
                    {
                      "name": "constructorOpt",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Creates a .stack property on targetObject, which when accessed returns\na string representing the location in the code at which\nError.captureStackTrace() was called.
\n
const myObject = {};\nError.captureStackTrace(myObject);\nmyObject.stack  // similar to `new Error().stack`\n
\n
The first line of the trace, instead of being prefixed with ErrorType:\nmessage, will be the result of calling targetObject.toString().
\n
The optional constructorOpt argument accepts a function. If given, all frames\nabove constructorOpt, including constructorOpt, will be omitted from the\ngenerated stack trace.
\n
The constructorOpt argument is useful for hiding implementation\ndetails of error generation from an end user. For instance:
\n
function MyError() {\n  Error.captureStackTrace(this, MyError);\n}\n\n// Without passing MyError to captureStackTrace, the MyError\n// frame would show up in the .stack property. By passing\n// the constructor, we omit that frame and all frames above it.\nnew MyError().stack\n
\n"
            }
          ],
          "properties": [
            {
              "textRaw": "`stackTraceLimit` {Number} ",
              "type": "Number",
              "name": "stackTraceLimit",
              "desc": "
The Error.stackTraceLimit property specifies the number of stack frames\ncollected by a stack trace (whether generated by new Error().stack or\nError.captureStackTrace(obj)).
\n
The default value is 10 but may be set to any valid JavaScript number. Changes\nwill affect any stack trace captured after the value has been changed.
\n
If set to a non-number value, or set to a negative number, stack traces will\nnot capture any frames.
\n",
              "properties": [
                {
                  "textRaw": "`message` {String} ",
                  "type": "String",
                  "name": "message",
                  "desc": "
The error.message property is the string description of the error as set by calling new Error(message).\nThe message passed to the constructor will also appear in the first line of\nthe stack trace of the Error, however changing this property after the\nError object is created may not change the first line of the stack trace\n(for example, when error.stack is read before this property is changed).
\n
const err = new Error('The message');\nconsole.log(err.message);\n  // Prints: The message\n
\n"
                },
                {
                  "textRaw": "`stack` {String} ",
                  "type": "String",
                  "name": "stack",
                  "desc": "
The error.stack property is a string describing the point in the code at which\nthe Error was instantiated.
\n
For example:
\n
Error: Things keep happening!\n   at /home/gbusey/file.js:525:2\n   at Frobnicator.refrobulate (/home/gbusey/business-logic.js:424:21)\n   at Actor.<anonymous> (/home/gbusey/actors.js:400:8)\n   at increaseSynergy (/home/gbusey/actors.js:701:6)\n
The first line is formatted as <error class name>: <error message>, and\nis followed by a series of stack frames (each line beginning with "at ").\nEach frame describes a call site within the code that lead to the error being\ngenerated. V8 attempts to display a name for each function (by variable name,\nfunction name, or object method name), but occasionally it will not be able to\nfind a suitable name. If V8 cannot determine a name for the function, only\nlocation information will be displayed for that frame. Otherwise, the\ndetermined function name will be displayed with location information appended\nin parentheses.
\n
It is important to note that frames are only generated for JavaScript\nfunctions. If, for example, execution synchronously passes through a C++ addon\nfunction called cheetahify, which itself calls a JavaScript function, the\nframe representing the cheetahify call will not be present in the stack\ntraces:
\n
const cheetahify = require('./native-binding.node');\n\nfunction makeFaster() {\n  // cheetahify *synchronously* calls speedy.\n  cheetahify(function speedy() {\n    throw new Error('oh no!');\n  });\n}\n\nmakeFaster(); // will throw:\n  // /home/gbusey/file.js:6\n  //     throw new Error('oh no!');\n  //           ^\n  // Error: oh no!\n  //     at speedy (/home/gbusey/file.js:6:11)\n  //     at makeFaster (/home/gbusey/file.js:5:3)\n  //     at Object.<anonymous> (/home/gbusey/file.js:10:1)\n  //     at Module._compile (module.js:456:26)\n  //     at Object.Module._extensions..js (module.js:474:10)\n  //     at Module.load (module.js:356:32)\n  //     at Function.Module._load (module.js:312:12)\n  //     at Function.Module.runMain (module.js:497:10)\n  //     at startup (node.js:119:16)\n  //     at node.js:906:3\n
\n
The location information will be one of:
\n
    \n
  • native, if the frame represents a call internal to V8 (as in [].forEach).
    • \n
  • plain-filename.js:line:column, if the frame represents a call internal\n to Node.js.
    • \n
  • /absolute/path/to/file.js:line:column, if the frame represents a call in\na user program, or its dependencies.
    • \n
\n
The string representing the stack trace is lazily generated when the\nerror.stack property is accessed.
\n
The number of frames captured by the stack trace is bounded by the smaller of\nError.stackTraceLimit or the number of available frames on the current event\nloop tick.
\n
System-level errors are generated as augmented Error instances, which are\ndetailed here.
\n"
                }
              ]
            }
          ],
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`message` {String} ",
                  "name": "message",
                  "type": "String"
                }
              ],
              "desc": "
Creates a new Error object and sets the error.message property to the\nprovided text message. If an object is passed as message, the text message\nis generated by calling message.toString(). The error.stack property will\nrepresent the point in the code at which new Error() was called. Stack traces\nare dependent on V8's stack trace API. Stack traces extend only to either\n(a) the beginning of  synchronous code execution, or (b) the number of frames\ngiven by the property Error.stackTraceLimit, whichever is smaller.
\n"
            },
            {
              "params": [
                {
                  "name": "message"
                }
              ],
              "desc": "
Creates a new Error object and sets the error.message property to the\nprovided text message. If an object is passed as message, the text message\nis generated by calling message.toString(). The error.stack property will\nrepresent the point in the code at which new Error() was called. Stack traces\nare dependent on V8's stack trace API. Stack traces extend only to either\n(a) the beginning of  synchronous code execution, or (b) the number of frames\ngiven by the property Error.stackTraceLimit, whichever is smaller.
\n"
            }
          ]
        },
        {
          "textRaw": "Class: RangeError",
          "type": "class",
          "name": "RangeError",
          "desc": "
A subclass of Error that indicates that a provided argument was not within the\nset or range of acceptable values for a function; whether that is a numeric\nrange, or outside the set of options for a given function parameter.
\n
For example:
\n
require('net').connect(-1);\n  // throws RangeError, port should be > 0 && < 65536\n
\n
Node.js will generate and throw RangeError instances immediately as a form\nof argument validation.
\n"
        },
        {
          "textRaw": "Class: ReferenceError",
          "type": "class",
          "name": "ReferenceError",
          "desc": "
A subclass of Error that indicates that an attempt is being made to access a\nvariable that is not defined. Such errors commonly indicate typos in code, or\nan otherwise broken program.
\n
While client code may generate and propagate these errors, in practice, only V8\nwill do so.
\n
doesNotExist;\n  // throws ReferenceError, doesNotExist is not a variable in this program.\n
\n
ReferenceError instances will have an error.arguments property whose value\nis an array containing a single element: a string representing the variable\nthat was not defined.
\n
const assert = require('assert');\ntry {\n  doesNotExist;\n} catch(err) {\n  assert(err.arguments[0], 'doesNotExist');\n}\n
\n
Unless an application is dynamically generating and running code,\nReferenceError instances should always be considered a bug in the code\nor its dependencies.
\n"
        },
        {
          "textRaw": "Class: SyntaxError",
          "type": "class",
          "name": "SyntaxError",
          "desc": "
A subclass of Error that indicates that a program is not valid JavaScript.\nThese errors may only be generated and propagated as a result of code\nevaluation. Code evaluation may happen as a result of eval, Function,\nrequire, or vm. These errors are almost always indicative of a broken\nprogram.
\n
try {\n  require('vm').runInThisContext('binary ! isNotOk');\n} catch(err) {\n  // err will be a SyntaxError\n}\n
\n
SyntaxError instances are unrecoverable in the context that created them –\nthey may only be caught by other contexts.
\n"
        },
        {
          "textRaw": "Class: TypeError",
          "type": "class",
          "name": "TypeError",
          "desc": "
A subclass of Error that indicates that a provided argument is not an\nallowable type. For example, passing a function to a parameter which expects a\nstring would be considered a TypeError.
\n
require('url').parse(() => { });\n  // throws TypeError, since it expected a string\n
\n
Node.js will generate and throw TypeError instances immediately as a form\nof argument validation.
\n"
        }
      ]
    },
    {
      "textRaw": "Global Objects",
      "name": "Global Objects",
      "type": "misc",
      "desc": "
These objects are available in all modules. Some of these objects aren't\nactually in the global scope but in the module scope - this will be noted.
\n
The objects listed here are specific to Node.js. There are a number of\nbuilt-in objects that are part of the JavaScript language itself, which are\nalso globally accessible.
\n",
      "globals": [
        {
          "textRaw": "Class: Buffer",
          "type": "global",
          "name": "Buffer",
          "meta": {
            "added": [
              "v0.1.103"
            ]
          },
          "desc": "
    \n
  • {Function}
    • \n
\n
Used to handle binary data. See the buffer section.
\n"
        },
        {
          "textRaw": "clearImmediate(immediateObject)",
          "type": "global",
          "name": "clearImmediate",
          "meta": {
            "added": [
              "v0.9.1"
            ]
          },
          "desc": "
clearImmediate is described in the timers section.
\n"
        },
        {
          "textRaw": "clearInterval(intervalObject)",
          "type": "global",
          "name": "clearInterval",
          "meta": {
            "added": [
              "v0.0.1"
            ]
          },
          "desc": "
clearInterval is described in the timers section.
\n"
        },
        {
          "textRaw": "clearTimeout(timeoutObject)",
          "type": "global",
          "name": "clearTimeout",
          "meta": {
            "added": [
              "v0.0.1"
            ]
          },
          "desc": "
clearTimeout is described in the timers section.
\n"
        },
        {
          "textRaw": "console",
          "name": "console",
          "meta": {
            "added": [
              "v0.1.100"
            ]
          },
          "type": "global",
          "desc": "
    \n
  • {Object}
    • \n
\n
Used to print to stdout and stderr. See the console section.
\n"
        },
        {
          "textRaw": "global",
          "name": "global",
          "meta": {
            "added": [
              "v0.1.27"
            ]
          },
          "type": "global",
          "desc": "
    \n
  • {Object} The global namespace object.
    • \n
\n
In browsers, the top-level scope is the global scope. That means that in\nbrowsers if you're in the global scope var something will define a global\nvariable. In Node.js this is different. The top-level scope is not the global\nscope; var something inside an Node.js module will be local to that module.
\n"
        },
        {
          "textRaw": "process",
          "name": "process",
          "meta": {
            "added": [
              "v0.1.7"
            ]
          },
          "type": "global",
          "desc": "
    \n
  • {Object}
    • \n
\n
The process object. See the process object section.
\n"
        },
        {
          "textRaw": "setImmediate(callback[, arg][, ...])",
          "type": "global",
          "name": "setImmediate",
          "meta": {
            "added": [
              "v0.9.1"
            ]
          },
          "desc": "
setImmediate is described in the timers section.
\n"
        },
        {
          "textRaw": "setInterval(callback, delay[, arg][, ...])",
          "type": "global",
          "name": "setInterval",
          "meta": {
            "added": [
              "v0.0.1"
            ]
          },
          "desc": "
setInterval is described in the timers section.
\n"
        },
        {
          "textRaw": "setTimeout(callback, delay[, arg][, ...])",
          "type": "global",
          "name": "setTimeout",
          "meta": {
            "added": [
              "v0.0.1"
            ]
          },
          "desc": "
setTimeout is described in the timers section.
\n\n\n"
        },
        {
          "textRaw": "Process",
          "name": "Process",
          "type": "global",
          "desc": "
The process object is a global object and can be accessed from anywhere.\nIt is an instance of EventEmitter.
\n",
          "events": [
            {
              "textRaw": "Event: 'beforeExit'",
              "type": "event",
              "name": "beforeExit",
              "meta": {
                "added": [
                  "v0.11.12"
                ]
              },
              "desc": "
This event is emitted when Node.js empties its event loop and has nothing else\nto schedule. Normally, Node.js exits when there is no work scheduled, but a\nlistener for 'beforeExit' can make asynchronous calls, and cause Node.js to\ncontinue.
\n
'beforeExit' is not emitted for conditions causing explicit termination, such\nas process.exit() or uncaught exceptions, and should not be used as an\nalternative to the 'exit' event unless the intention is to schedule more work.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'exit'",
              "type": "event",
              "name": "exit",
              "meta": {
                "added": [
                  "v0.1.7"
                ]
              },
              "desc": "
Emitted when the process is about to exit. There is no way to prevent the\nexiting of the event loop at this point, and once all 'exit' listeners have\nfinished running the process will exit. Therefore you must only perform\nsynchronous operations in this handler. This is a good hook to perform\nchecks on the module's state (like for unit tests). The callback takes one\nargument, the code the process is exiting with.
\n
This event is only emitted when Node.js exits explicitly by process.exit() or\nimplicitly by the event loop draining.
\n
Example of listening for 'exit':
\n
process.on('exit', (code) => {\n  // do *NOT* do this\n  setTimeout(() => {\n    console.log('This will not run');\n  }, 0);\n  console.log('About to exit with code:', code);\n});\n
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'message'",
              "type": "event",
              "name": "message",
              "meta": {
                "added": [
                  "v0.5.10"
                ]
              },
              "params": [],
              "desc": "
Messages sent by ChildProcess.send() are obtained using the 'message'\nevent on the child's process object.
\n"
            },
            {
              "textRaw": "Event: 'rejectionHandled'",
              "type": "event",
              "name": "rejectionHandled",
              "meta": {
                "added": [
                  "v1.4.1"
                ]
              },
              "desc": "
Emitted whenever a Promise was rejected and an error handler was attached to it\n(for example with .catch()) later than after an event loop turn. This event\nis emitted with the following arguments:
\n
    \n
  • p the promise that was previously emitted in an 'unhandledRejection'\nevent, but which has now gained a rejection handler.
    • \n
\n
There is no notion of a top level for a promise chain at which rejections can\nalways be handled. Being inherently asynchronous in nature, a promise rejection\ncan be handled at a future point in time — possibly much later than the\nevent loop turn it takes for the 'unhandledRejection' event to be emitted.
\n
Another way of stating this is that, unlike in synchronous code where there is\nan ever-growing list of unhandled exceptions, with promises there is a\ngrowing-and-shrinking list of unhandled rejections. In synchronous code, the\n'uncaughtException' event tells you when the list of unhandled exceptions\ngrows. And in asynchronous code, the 'unhandledRejection' event tells you\nwhen the list of unhandled rejections grows, while the 'rejectionHandled'\nevent tells you when the list of unhandled rejections shrinks.
\n
For example using the rejection detection hooks in order to keep a map of all\nthe rejected promise reasons at a given time:
\n
const unhandledRejections = new Map();\nprocess.on('unhandledRejection', (reason, p) => {\n  unhandledRejections.set(p, reason);\n});\nprocess.on('rejectionHandled', (p) => {\n  unhandledRejections.delete(p);\n});\n
\n
This map will grow and shrink over time, reflecting rejections that start\nunhandled and then become handled. You could record the errors in some error\nlog, either periodically (probably best for long-running programs, allowing\nyou to clear the map, which in the case of a very buggy program could grow\nindefinitely) or upon process exit (more convenient for scripts).
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'uncaughtException'",
              "type": "event",
              "name": "uncaughtException",
              "meta": {
                "added": [
                  "v0.1.18"
                ]
              },
              "desc": "
The 'uncaughtException' event is emitted when an exception bubbles all the\nway back to the event loop. By default, Node.js handles such exceptions by\nprinting the stack trace to stderr and exiting. Adding a handler for the\n'uncaughtException' event overrides this default behavior.
\n
For example:
\n
process.on('uncaughtException', (err) => {\n  console.log(`Caught exception: ${err}`);\n});\n\nsetTimeout(() => {\n  console.log('This will still run.');\n}, 500);\n\n// Intentionally cause an exception, but don't catch it.\nnonexistentFunc();\nconsole.log('This will not run.');\n
\n",
              "modules": [
                {
                  "textRaw": "Warning: Using `'uncaughtException'` correctly",
                  "name": "warning:_using_`'uncaughtexception'`_correctly",
                  "desc": "
Note that 'uncaughtException' is a crude mechanism for exception handling\nintended to be used only as a last resort. The event should not be used as\nan equivalent to On Error Resume Next. Unhandled exceptions inherently mean\nthat an application is in an undefined state. Attempting to resume application\ncode without properly recovering from the exception can cause additional\nunforeseen and unpredictable issues.
\n
Exceptions thrown from within the event handler will not be caught. Instead the\nprocess will exit with a non-zero exit code and the stack trace will be printed.\nThis is to avoid infinite recursion.
\n
Attempting to resume normally after an uncaught exception can be similar to\npulling out of the power cord when upgrading a computer -- nine out of ten\ntimes nothing happens - but the 10th time, the system becomes corrupted.
\n
The correct use of 'uncaughtException' is to perform synchronous cleanup\nof allocated resources (e.g. file descriptors, handles, etc) before shutting\ndown the process. It is not safe to resume normal operation after\n'uncaughtException'.
\n",
                  "type": "module",
                  "displayName": "Warning: Using `'uncaughtException'` correctly"
                }
              ],
              "params": []
            },
            {
              "textRaw": "Event: 'unhandledRejection'",
              "type": "event",
              "name": "unhandledRejection",
              "meta": {
                "added": [
                  "v1.4.1"
                ]
              },
              "desc": "
Emitted whenever a Promise is rejected and no error handler is attached to\nthe promise within a turn of the event loop. When programming with promises\nexceptions are encapsulated as rejected promises. Such promises can be caught\nand handled using promise.catch(...) and rejections are propagated through\na promise chain. This event is useful for detecting and keeping track of\npromises that were rejected whose rejections were not handled yet. This event\nis emitted with the following arguments:
\n
    \n
  • reason the object with which the promise was rejected (usually an\nError instance).
    • \n
  • p the promise that was rejected.
    • \n
\n
Here is an example that logs every unhandled rejection to the console
\n
process.on('unhandledRejection', (reason, p) => {\n  console.log('Unhandled Rejection at: Promise', p, 'reason:', reason);\n  // application specific logging, throwing an error, or other logic here\n});\n
\n
For example, here is a rejection that will trigger the 'unhandledRejection'\nevent:
\n
somePromise.then((res) => {\n  return reportToUser(JSON.pasre(res)); // note the typo (`pasre`)\n}); // no `.catch` or `.then`\n
\n
Here is an example of a coding pattern that will also trigger\n'unhandledRejection':
\n
function SomeResource() {\n  // Initially set the loaded status to a rejected promise\n  this.loaded = Promise.reject(new Error('Resource not yet loaded!'));\n}\n\nvar resource = new SomeResource();\n// no .catch or .then on resource.loaded for at least a turn\n
\n
In cases like this, you may not want to track the rejection as a developer\nerror like you would for other 'unhandledRejection' events. To address\nthis, you can either attach a dummy .catch(() => { }) handler to\nresource.loaded, preventing the 'unhandledRejection' event from being\nemitted, or you can use the 'rejectionHandled' event.
\n",
              "params": []
            },
            {
              "textRaw": "Signal Events",
              "name": "SIGINT, SIGHUP, etc.",
              "type": "event",
              "desc": "
Emitted when the processes receives a signal. See sigaction(7) for a list of\nstandard POSIX signal names such as SIGINT, SIGHUP, etc.
\n
Example of listening for SIGINT:
\n
// Start reading from stdin so we don't exit.\nprocess.stdin.resume();\n\nprocess.on('SIGINT', () => {\n  console.log('Got SIGINT.  Press Control-D to exit.');\n});\n
\n
An easy way to send the SIGINT signal is with Control-C in most terminal\nprograms.
\n
Note:
\n
    \n
  • SIGUSR1 is reserved by Node.js to start the debugger.  It's possible to\ninstall a listener but that won't stop the debugger from starting.
    • \n
  • SIGTERM and SIGINT have default handlers on non-Windows platforms that\nresets the terminal mode before exiting with code 128 + signal number. If\none of these signals has a listener installed, its default behavior will be\nremoved (Node.js will no longer exit).
    • \n
  • SIGPIPE is ignored by default. It can have a listener installed.
    • \n
  • SIGHUP is generated on Windows when the console window is closed, and on other\nplatforms under various similar conditions, see signal(7). It can have a\nlistener installed, however Node.js will be unconditionally terminated by\nWindows about 10 seconds later. On non-Windows platforms, the default\nbehavior of SIGHUP is to terminate Node.js, but once a listener has been\ninstalled its default behavior will be removed.
    • \n
  • SIGTERM is not supported on Windows, it can be listened on.
    • \n
  • SIGINT from the terminal is supported on all platforms, and can usually be\ngenerated with CTRL+C (though this may be configurable). It is not generated\nwhen terminal raw mode is enabled.
    • \n
  • SIGBREAK is delivered on Windows when CTRL+BREAK is pressed, on\nnon-Windows\nplatforms it can be listened on, but there is no way to send or generate it.
    • \n
  • SIGWINCH is delivered when the console has been resized. On Windows, this\nwill only happen on write to the console when the cursor is being moved, or\nwhen a readable tty is used in raw mode.
    • \n
  • SIGKILL cannot have a listener installed, it will unconditionally terminate\nNode.js on all platforms.
    • \n
  • SIGSTOP cannot have a listener installed.
    • \n
\n
Note that Windows does not support sending Signals, but Node.js offers some\nemulation with process.kill(), and child_process.kill(). Sending signal 0\ncan be used to test for the existence of a process. Sending SIGINT,\nSIGTERM, and SIGKILL cause the unconditional termination of the target\nprocess.
\n",
              "params": []
            }
          ],
          "modules": [
            {
              "textRaw": "Exit Codes",
              "name": "exit_codes",
              "desc": "
Node.js will normally exit with a 0 status code when no more async\noperations are pending.  The following status codes are used in other\ncases:
\n
    \n
  • 1 Uncaught Fatal Exception - There was an uncaught exception,\nand it was not handled by a domain or an 'uncaughtException' event\nhandler.
    • \n
  • 2 - Unused (reserved by Bash for builtin misuse)
    • \n
  • 3 Internal JavaScript Parse Error - The JavaScript source code\ninternal in Node.js's bootstrapping process caused a parse error.  This\nis extremely rare, and generally can only happen during development\nof Node.js itself.
    • \n
  • 4 Internal JavaScript Evaluation Failure - The JavaScript\nsource code internal in Node.js's bootstrapping process failed to\nreturn a function value when evaluated.  This is extremely rare, and\ngenerally can only happen during development of Node.js itself.
    • \n
  • 5 Fatal Error - There was a fatal unrecoverable error in V8.\nTypically a message will be printed to stderr with the prefix FATAL\nERROR.
    • \n
  • 6 Non-function Internal Exception Handler - There was an\nuncaught exception, but the internal fatal exception handler\nfunction was somehow set to a non-function, and could not be called.
    • \n
  • 7 Internal Exception Handler Run-Time Failure - There was an\nuncaught exception, and the internal fatal exception handler\nfunction itself threw an error while attempting to handle it.  This\ncan happen, for example, if a process.on('uncaughtException') or\ndomain.on('error') handler throws an error.
    • \n
  • 8 - Unused.  In previous versions of Node.js, exit code 8 sometimes\nindicated an uncaught exception.
    • \n
  • 9 - Invalid Argument - Either an unknown option was specified,\nor an option requiring a value was provided without a value.
    • \n
  • 10 Internal JavaScript Run-Time Failure - The JavaScript\nsource code internal in Node.js's bootstrapping process threw an error\nwhen the bootstrapping function was called.  This is extremely rare,\nand generally can only happen during development of Node.js itself.
    • \n
  • 12 Invalid Debug Argument - The --debug and/or --debug-brk\noptions were set, but an invalid port number was chosen.
    • \n
  • >128 Signal Exits - If Node.js receives a fatal signal such as\nSIGKILL or SIGHUP, then its exit code will be 128 plus the\nvalue of the signal code.  This is a standard Unix practice, since\nexit codes are defined to be 7-bit integers, and signal exits set\nthe high-order bit, and then contain the value of the signal code.
    • \n
\n",
              "type": "module",
              "displayName": "Exit Codes"
            }
          ],
          "methods": [
            {
              "textRaw": "process.abort()",
              "type": "method",
              "name": "abort",
              "meta": {
                "added": [
                  "v0.7.0"
                ]
              },
              "desc": "
This causes Node.js to emit an abort. This will cause Node.js to exit and\ngenerate a core file.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "process.chdir(directory)",
              "type": "method",
              "name": "chdir",
              "meta": {
                "added": [
                  "v0.1.17"
                ]
              },
              "desc": "
Changes the current working directory of the process or throws an exception if that fails.
\n
console.log(`Starting directory: ${process.cwd()}`);\ntry {\n  process.chdir('/tmp');\n  console.log(`New directory: ${process.cwd()}`);\n}\ncatch (err) {\n  console.log(`chdir: ${err}`);\n}\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "directory"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "process.cpuUsage([previousValue])",
              "type": "method",
              "name": "cpuUsage",
              "desc": "
Returns the user and system CPU time usage of the current process, in an object\nwith properties user and system, whose values are microsecond values\n(millionth of a second). These values measure time spent in user and\nsystem code respectively, and may end up being greater than actual elapsed time\nif multiple CPU cores are performing work for this process.
\n
The result of a previous call to process.cpuUsage() can be passed as the\nargument to the function, to get a diff reading.
\n
const startUsage = process.cpuUsage();\n// { user: 38579, system: 6986 }\n\n// spin the CPU for 500 milliseconds\nconst now = Date.now();\nwhile (Date.now() - now < 500);\n\nconsole.log(process.cpuUsage(startUsage));\n// { user: 514883, system: 11226 }\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "previousValue",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "process.cwd()",
              "type": "method",
              "name": "cwd",
              "meta": {
                "added": [
                  "v0.1.8"
                ]
              },
              "desc": "
Returns the current working directory of the process.
\n
console.log(`Current directory: ${process.cwd()}`);\n
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "process.disconnect()",
              "type": "method",
              "name": "disconnect",
              "meta": {
                "added": [
                  "v0.7.2"
                ]
              },
              "desc": "
Close the IPC channel to the parent process, allowing this child to exit\ngracefully once there are no other connections keeping it alive.
\n
Identical to the parent process's ChildProcess.disconnect().
\n
If Node.js was not spawned with an IPC channel, process.disconnect() will be\nundefined.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "process.exit([code])",
              "type": "method",
              "name": "exit",
              "meta": {
                "added": [
                  "v0.1.13"
                ]
              },
              "desc": "
Ends the process with the specified code.  If omitted, exit uses the\n'success' code 0.
\n
To exit with a 'failure' code:
\n
process.exit(1);\n
\n
The shell that executed Node.js should see the exit code as 1.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "code",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "process.getegid()",
              "type": "method",
              "name": "getegid",
              "meta": {
                "added": [
                  "v2.0.0"
                ]
              },
              "desc": "
Note: this function is only available on POSIX platforms (i.e. not Windows,\nAndroid)
\n
Gets the effective group identity of the process. (See getegid(2).)\nThis is the numerical group id, not the group name.
\n
if (process.getegid) {\n  console.log(`Current gid: ${process.getegid()}`);\n}\n
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "process.geteuid()",
              "type": "method",
              "name": "geteuid",
              "meta": {
                "added": [
                  "v2.0.0"
                ]
              },
              "desc": "
Note: this function is only available on POSIX platforms (i.e. not Windows,\nAndroid)
\n
Gets the effective user identity of the process. (See geteuid(2).)\nThis is the numerical userid, not the username.
\n
if (process.geteuid) {\n  console.log(`Current uid: ${process.geteuid()}`);\n}\n
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "process.getgid()",
              "type": "method",
              "name": "getgid",
              "meta": {
                "added": [
                  "v0.1.31"
                ]
              },
              "desc": "
Note: this function is only available on POSIX platforms (i.e. not Windows,\nAndroid)
\n
Gets the group identity of the process. (See getgid(2).)\nThis is the numerical group id, not the group name.
\n
if (process.getgid) {\n  console.log(`Current gid: ${process.getgid()}`);\n}\n
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "process.getgroups()",
              "type": "method",
              "name": "getgroups",
              "meta": {
                "added": [
                  "v0.9.4"
                ]
              },
              "desc": "
Note: this function is only available on POSIX platforms (i.e. not Windows,\nAndroid)
\n
Returns an array with the supplementary group IDs. POSIX leaves it unspecified\nif the effective group ID is included but Node.js ensures it always is.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "process.getuid()",
              "type": "method",
              "name": "getuid",
              "meta": {
                "added": [
                  "v0.1.28"
                ]
              },
              "desc": "
Note: this function is only available on POSIX platforms (i.e. not Windows,\nAndroid)
\n
Gets the user identity of the process. (See getuid(2).)\nThis is the numerical userid, not the username.
\n
if (process.getuid) {\n  console.log(`Current uid: ${process.getuid()}`);\n}\n
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "process.hrtime()",
              "type": "method",
              "name": "hrtime",
              "meta": {
                "added": [
                  "v0.7.6"
                ]
              },
              "desc": "
Returns the current high-resolution real time in a [seconds, nanoseconds]\ntuple Array. It is relative to an arbitrary time in the past. It is not\nrelated to the time of day and therefore not subject to clock drift. The\nprimary use is for measuring performance between intervals.
\n
You may pass in the result of a previous call to process.hrtime() to get\na diff reading, useful for benchmarks and measuring intervals:
\n
var time = process.hrtime();\n// [ 1800216, 25 ]\n\nsetTimeout(() => {\n  var diff = process.hrtime(time);\n  // [ 1, 552 ]\n\n  console.log('benchmark took %d nanoseconds', diff[0] * 1e9 + diff[1]);\n  // benchmark took 1000000527 nanoseconds\n}, 1000);\n
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "process.initgroups(user, extra_group)",
              "type": "method",
              "name": "initgroups",
              "meta": {
                "added": [
                  "v0.9.4"
                ]
              },
              "desc": "
Note: this function is only available on POSIX platforms (i.e. not Windows,\nAndroid)
\n
Reads /etc/group and initializes the group access list, using all groups of\nwhich the user is a member. This is a privileged operation, meaning you need\nto be root or have the CAP_SETGID capability.
\n
user is a user name or user ID. extra_group is a group name or group ID.
\n
Some care needs to be taken when dropping privileges. Example:
\n
console.log(process.getgroups());         // [ 0 ]\nprocess.initgroups('bnoordhuis', 1000);   // switch user\nconsole.log(process.getgroups());         // [ 27, 30, 46, 1000, 0 ]\nprocess.setgid(1000);                     // drop root gid\nconsole.log(process.getgroups());         // [ 27, 30, 46, 1000 ]\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "user"
                    },
                    {
                      "name": "extra_group"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "process.kill(pid[, signal])",
              "type": "method",
              "name": "kill",
              "meta": {
                "added": [
                  "v0.0.6"
                ]
              },
              "desc": "
Send a signal to a process. pid is the process id and signal is the\nstring describing the signal to send.  Signal names are strings like\nSIGINT or SIGHUP.  If omitted, the signal will be SIGTERM.\nSee Signal Events and kill(2) for more information.
\n
Will throw an error if target does not exist, and as a special case, a signal\nof 0 can be used to test for the existence of a process. Windows platforms\nwill throw an error if the pid is used to kill a process group.
\n
Note that even though the name of this function is process.kill, it is really\njust a signal sender, like the kill system call.  The signal sent may do\nsomething other than kill the target process.
\n
Example of sending a signal to yourself:
\n
process.on('SIGHUP', () => {\n  console.log('Got SIGHUP signal.');\n});\n\nsetTimeout(() => {\n  console.log('Exiting.');\n  process.exit(0);\n}, 100);\n\nprocess.kill(process.pid, 'SIGHUP');\n
\n
Note: When SIGUSR1 is received by Node.js it starts the debugger, see\nSignal Events.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "pid"
                    },
                    {
                      "name": "signal",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "process.memoryUsage()",
              "type": "method",
              "name": "memoryUsage",
              "meta": {
                "added": [
                  "v0.1.16"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Object} ",
                    "options": [
                      {
                        "textRaw": "`rss` {Integer} ",
                        "name": "rss",
                        "type": "Integer"
                      },
                      {
                        "textRaw": "`heapTotal` {Integer} ",
                        "name": "heapTotal",
                        "type": "Integer"
                      },
                      {
                        "textRaw": "`heapUsed` {Integer} ",
                        "name": "heapUsed",
                        "type": "Integer"
                      },
                      {
                        "textRaw": "`external` {Integer} ",
                        "name": "external",
                        "type": "Integer"
                      }
                    ],
                    "name": "return",
                    "type": "Object"
                  },
                  "params": []
                },
                {
                  "params": []
                }
              ],
              "desc": "
The process.memoryUsage() method returns an object describing the memory usage\nof the Node.js process measured in bytes.
\n
For example, the code:
\n
console.log(process.memoryUsage());\n
\n
This will generate:
\n
{ rss: 4935680,\n  heapTotal: 1826816,\n  heapUsed: 650472,\n  external: 49879\n}\n
\n
heapTotal and heapUsed refer to V8's memory usage.\nexternal refers to the memory usage of C++ objects bound to JavaScript\nobjects managed by V8.
\n"
            },
            {
              "textRaw": "process.nextTick(callback[, arg][, ...])",
              "type": "method",
              "name": "nextTick",
              "meta": {
                "added": [
                  "v0.1.26"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`callback` {Function} ",
                      "name": "callback",
                      "type": "Function"
                    },
                    {
                      "name": "arg",
                      "optional": true
                    },
                    {
                      "name": "...",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "callback"
                    },
                    {
                      "name": "arg",
                      "optional": true
                    },
                    {
                      "name": "...",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Once the current event loop turn runs to completion, call the callback\nfunction.
\n
This is not a simple alias to setTimeout(fn, 0), it's much more\nefficient.  It runs before any additional I/O events (including\ntimers) fire in subsequent ticks of the event loop.
\n
console.log('start');\nprocess.nextTick(() => {\n  console.log('nextTick callback');\n});\nconsole.log('scheduled');\n// Output:\n// start\n// scheduled\n// nextTick callback\n
\n
This is important in developing APIs where you want to give the user the\nchance to assign event handlers after an object has been constructed,\nbut before any I/O has occurred.
\n
function MyThing(options) {\n  this.setupOptions(options);\n\n  process.nextTick(() => {\n    this.startDoingStuff();\n  });\n}\n\nvar thing = new MyThing();\nthing.getReadyForStuff();\n\n// thing.startDoingStuff() gets called now, not before.\n
\n
It is very important for APIs to be either 100% synchronous or 100%\nasynchronous.  Consider this example:
\n
// WARNING!  DO NOT USE!  BAD UNSAFE HAZARD!\nfunction maybeSync(arg, cb) {\n  if (arg) {\n    cb();\n    return;\n  }\n\n  fs.stat('file', cb);\n}\n
\n
This API is hazardous.  If you do this:
\n
maybeSync(true, () => {\n  foo();\n});\nbar();\n
\n
then it's not clear whether foo() or bar() will be called first.
\n
This approach is much better:
\n
function definitelyAsync(arg, cb) {\n  if (arg) {\n    process.nextTick(cb);\n    return;\n  }\n\n  fs.stat('file', cb);\n}\n
\n
Note: the nextTick queue is completely drained on each pass of the\nevent loop before additional I/O is processed.  As a result,\nrecursively setting nextTick callbacks will block any I/O from\nhappening, just like a while(true); loop.
\n"
            },
            {
              "textRaw": "process.send(message[, sendHandle][, callback])",
              "type": "method",
              "name": "send",
              "meta": {
                "added": [
                  "v0.5.9"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Boolean} ",
                    "name": "return",
                    "type": "Boolean"
                  },
                  "params": [
                    {
                      "textRaw": "`message` {Object} ",
                      "name": "message",
                      "type": "Object"
                    },
                    {
                      "textRaw": "`sendHandle` {Handle object} ",
                      "name": "sendHandle",
                      "type": "Handle object",
                      "optional": true
                    },
                    {
                      "textRaw": "`callback` {Function} ",
                      "name": "callback",
                      "type": "Function",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "message"
                    },
                    {
                      "name": "sendHandle",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
When Node.js is spawned with an IPC channel attached, it can send messages to its\nparent process using process.send(). Each will be received as a\n'message' event on the parent's ChildProcess object.
\n
Note: this function uses JSON.stringify() internally to serialize the message.
\n
If Node.js was not spawned with an IPC channel, process.send() will be undefined.
\n"
            },
            {
              "textRaw": "process.setegid(id)",
              "type": "method",
              "name": "setegid",
              "meta": {
                "added": [
                  "v2.0.0"
                ]
              },
              "desc": "
Note: this function is only available on POSIX platforms (i.e. not Windows,\nAndroid)
\n
Sets the effective group identity of the process. (See setegid(2).)\nThis accepts either a numerical ID or a groupname string. If a groupname\nis specified, this method blocks while resolving it to a numerical ID.
\n
if (process.getegid && process.setegid) {\n  console.log(`Current gid: ${process.getegid()}`);\n  try {\n    process.setegid(501);\n    console.log(`New gid: ${process.getegid()}`);\n  }\n  catch (err) {\n    console.log(`Failed to set gid: ${err}`);\n  }\n}\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "id"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "process.seteuid(id)",
              "type": "method",
              "name": "seteuid",
              "meta": {
                "added": [
                  "v2.0.0"
                ]
              },
              "desc": "
Note: this function is only available on POSIX platforms (i.e. not Windows,\nAndroid)
\n
Sets the effective user identity of the process. (See seteuid(2).)\nThis accepts either a numerical ID or a username string.  If a username\nis specified, this method blocks while resolving it to a numerical ID.
\n
if (process.geteuid && process.seteuid) {\n  console.log(`Current uid: ${process.geteuid()}`);\n  try {\n    process.seteuid(501);\n    console.log(`New uid: ${process.geteuid()}`);\n  }\n  catch (err) {\n    console.log(`Failed to set uid: ${err}`);\n  }\n}\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "id"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "process.setgid(id)",
              "type": "method",
              "name": "setgid",
              "meta": {
                "added": [
                  "v0.1.31"
                ]
              },
              "desc": "
Note: this function is only available on POSIX platforms (i.e. not Windows,\nAndroid)
\n
Sets the group identity of the process. (See setgid(2).)  This accepts either\na numerical ID or a groupname string. If a groupname is specified, this method\nblocks while resolving it to a numerical ID.
\n
if (process.getgid && process.setgid) {\n  console.log(`Current gid: ${process.getgid()}`);\n  try {\n    process.setgid(501);\n    console.log(`New gid: ${process.getgid()}`);\n  }\n  catch (err) {\n    console.log(`Failed to set gid: ${err}`);\n  }\n}\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "id"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "process.setgroups(groups)",
              "type": "method",
              "name": "setgroups",
              "meta": {
                "added": [
                  "v0.9.4"
                ]
              },
              "desc": "
Note: this function is only available on POSIX platforms (i.e. not Windows,\nAndroid)
\n
Sets the supplementary group IDs. This is a privileged operation, meaning you\nneed to be root or have the CAP_SETGID capability.
\n
The list can contain group IDs, group names or both.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "groups"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "process.setuid(id)",
              "type": "method",
              "name": "setuid",
              "meta": {
                "added": [
                  "v0.1.28"
                ]
              },
              "desc": "
Note: this function is only available on POSIX platforms (i.e. not Windows,\nAndroid)
\n
Sets the user identity of the process. (See setuid(2).)  This accepts either\na numerical ID or a username string.  If a username is specified, this method\nblocks while resolving it to a numerical ID.
\n
if (process.getuid && process.setuid) {\n  console.log(`Current uid: ${process.getuid()}`);\n  try {\n    process.setuid(501);\n    console.log(`New uid: ${process.getuid()}`);\n  }\n  catch (err) {\n    console.log(`Failed to set uid: ${err}`);\n  }\n}\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "id"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "process.umask([mask])",
              "type": "method",
              "name": "umask",
              "meta": {
                "added": [
                  "v0.1.19"
                ]
              },
              "desc": "
Sets or reads the process's file mode creation mask. Child processes inherit\nthe mask from the parent process. Returns the old mask if mask argument is\ngiven, otherwise returns the current mask.
\n
const newmask = 0o022;\nconst oldmask = process.umask(newmask);\nconsole.log(\n  `Changed umask from ${oldmask.toString(8)} to ${newmask.toString(8)}`\n);\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "mask",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "process.uptime()",
              "type": "method",
              "name": "uptime",
              "meta": {
                "added": [
                  "v0.5.0"
                ]
              },
              "desc": "
Number of seconds Node.js has been running.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            }
          ],
          "properties": [
            {
              "textRaw": "process.arch",
              "name": "arch",
              "meta": {
                "added": [
                  "v0.5.0"
                ]
              },
              "desc": "
What processor architecture you're running on: 'arm', 'ia32', or 'x64'.
\n
console.log('This processor architecture is ' + process.arch);\n
\n"
            },
            {
              "textRaw": "process.argv",
              "name": "argv",
              "meta": {
                "added": [
                  "v0.1.27"
                ]
              },
              "desc": "
An array containing the command line arguments.  The first element will be\n'node', the second element will be the name of the JavaScript file.  The\nnext elements will be any additional command line arguments.
\n
// print process.argv\nprocess.argv.forEach((val, index, array) => {\n  console.log(`${index}: ${val}`);\n});\n
\n
This will generate:
\n
$ node process-2.js one two=three four\n0: node\n1: /Users/mjr/work/node/process-2.js\n2: one\n3: two=three\n4: four\n
"
            },
            {
              "textRaw": "process.config",
              "name": "config",
              "meta": {
                "added": [
                  "v0.7.7"
                ]
              },
              "desc": "
An Object containing the JavaScript representation of the configure options\nthat were used to compile the current Node.js executable. This is the same as\nthe config.gypi file that was produced when running the ./configure script.
\n
An example of the possible output looks like:
\n
{\n  target_defaults:\n   { cflags: [],\n     default_configuration: 'Release',\n     defines: [],\n     include_dirs: [],\n     libraries: [] },\n  variables:\n   {\n     host_arch: 'x64',\n     node_install_npm: 'true',\n     node_prefix: '',\n     node_shared_cares: 'false',\n     node_shared_http_parser: 'false',\n     node_shared_libuv: 'false',\n     node_shared_zlib: 'false',\n     node_use_dtrace: 'false',\n     node_use_openssl: 'true',\n     node_shared_openssl: 'false',\n     strict_aliasing: 'true',\n     target_arch: 'x64',\n     v8_use_snapshot: 'true'\n   }\n}\n
Note: the process.config property is not read-only and there are existing\nmodules in the ecosystem that are known to extend, modify, or entirely replace\nthe value of process.config.
\n"
            },
            {
              "textRaw": "`connected` {Boolean} Set to false after `process.disconnect()` is called ",
              "type": "Boolean",
              "name": "connected",
              "meta": {
                "added": [
                  "v0.7.2"
                ]
              },
              "desc": "
If process.connected is false, it is no longer possible to send messages.
\n",
              "shortDesc": "Set to false after `process.disconnect()` is called"
            },
            {
              "textRaw": "process.env",
              "name": "env",
              "meta": {
                "added": [
                  "v0.1.27"
                ]
              },
              "desc": "
An object containing the user environment. See environ(7).
\n
An example of this object looks like:
\n
{ TERM: 'xterm-256color',\n  SHELL: '/usr/local/bin/bash',\n  USER: 'maciej',\n  PATH: '~/.bin/:/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin',\n  PWD: '/Users/maciej',\n  EDITOR: 'vim',\n  SHLVL: '1',\n  HOME: '/Users/maciej',\n  LOGNAME: 'maciej',\n  _: '/usr/local/bin/node' }\n
\n
You can write to this object, but changes won't be reflected outside of your\nprocess. That means that the following won't work:
\n
$ node -e 'process.env.foo = "bar"' && echo $foo\n
But this will:
\n
process.env.foo = 'bar';\nconsole.log(process.env.foo);\n
\n
Assigning a property on process.env will implicitly convert the value\nto a string.
\n
Example:
\n
process.env.test = null;\nconsole.log(process.env.test);\n// => 'null'\nprocess.env.test = undefined;\nconsole.log(process.env.test);\n// => 'undefined'\n
\n
Use delete to delete a property from process.env.
\n
Example:
\n
process.env.TEST = 1;\ndelete process.env.TEST;\nconsole.log(process.env.TEST);\n// => undefined\n
\n"
            },
            {
              "textRaw": "process.execArgv",
              "name": "execArgv",
              "meta": {
                "added": [
                  "v0.7.7"
                ]
              },
              "desc": "
This is the set of Node.js-specific command line options from the\nexecutable that started the process.  These options do not show up in\nprocess.argv, and do not include the Node.js executable, the name of\nthe script, or any options following the script name. These options\nare useful in order to spawn child processes with the same execution\nenvironment as the parent.
\n
Example:
\n
$ node --harmony script.js --version\n
results in process.execArgv:
\n
['--harmony']\n
\n
and process.argv:
\n
['/usr/local/bin/node', 'script.js', '--version']\n
\n"
            },
            {
              "textRaw": "process.execPath",
              "name": "execPath",
              "meta": {
                "added": [
                  "v0.1.100"
                ]
              },
              "desc": "
This is the absolute pathname of the executable that started the process.
\n
Example:
\n
/usr/local/bin/node\n
"
            },
            {
              "textRaw": "process.exitCode",
              "name": "exitCode",
              "meta": {
                "added": [
                  "v0.11.8"
                ]
              },
              "desc": "
A number which will be the process exit code, when the process either\nexits gracefully, or is exited via process.exit() without specifying\na code.
\n
Specifying a code to process.exit(code) will override any previous\nsetting of process.exitCode.
\n"
            },
            {
              "textRaw": "process.mainModule",
              "name": "mainModule",
              "meta": {
                "added": [
                  "v0.1.17"
                ]
              },
              "desc": "
Alternate way to retrieve require.main. The difference is that if the main\nmodule changes at runtime, require.main might still refer to the original main\nmodule in modules that were required before the change occurred. Generally it's\nsafe to assume that the two refer to the same module.
\n
As with require.main, it will be undefined if there was no entry script.
\n"
            },
            {
              "textRaw": "process.pid",
              "name": "pid",
              "meta": {
                "added": [
                  "v0.1.15"
                ]
              },
              "desc": "
The PID of the process.
\n
console.log(`This process is pid ${process.pid}`);\n
\n"
            },
            {
              "textRaw": "process.platform",
              "name": "platform",
              "meta": {
                "added": [
                  "v0.1.16"
                ]
              },
              "desc": "
What platform you're running on:\n'darwin', 'freebsd', 'linux', 'sunos' or 'win32'
\n
console.log(`This platform is ${process.platform}`);\n
\n"
            },
            {
              "textRaw": "process.release",
              "name": "release",
              "meta": {
                "added": [
                  "v3.0.0"
                ]
              },
              "desc": "
An Object containing metadata related to the current release, including URLs\nfor the source tarball and headers-only tarball.
\n
process.release contains the following properties:
\n
    \n
  • name: a string with a value that will always be 'node' for Node.js. For\nlegacy io.js releases, this will be 'io.js'.
    • \n
  • sourceUrl: a complete URL pointing to a .tar.gz file containing the\nsource of the current release.
    • \n
  • headersUrl: a complete URL pointing to a .tar.gz file containing only\nthe header files for the current release. This file is significantly smaller\nthan the full source file and can be used for compiling add-ons against\nNode.js.
    • \n
  • libUrl: a complete URL pointing to an node.lib file matching the\narchitecture and version of the current release. This file is used for\ncompiling add-ons against Node.js. This property is only present on Windows\nbuilds of Node.js and will be missing on all other platforms.
    • \n
\n
e.g.
\n
{ name: 'node',\n  sourceUrl: 'https://nodejs.org/download/release/v4.0.0/node-v4.0.0.tar.gz',\n  headersUrl: 'https://nodejs.org/download/release/v4.0.0/node-v4.0.0-headers.tar.gz',\n  libUrl: 'https://nodejs.org/download/release/v4.0.0/win-x64/node.lib' }\n
\n
In custom builds from non-release versions of the source tree, only the\nname property may be present. The additional properties should not be\nrelied upon to exist.
\n"
            },
            {
              "textRaw": "process.stderr",
              "name": "stderr",
              "desc": "
A writable stream to stderr (on fd 2).
\n
process.stderr and process.stdout are unlike other streams in Node.js in\nthat they cannot be closed (end() will throw), they never emit the finish\nevent and that writes can block when output is redirected to a file (although\ndisks are fast and operating systems normally employ write-back caching so it\nshould be a very rare occurrence indeed.)
\n
Additionally, process.stderr and process.stdout are blocking when outputting\nto TTYs (terminals) on OS X as a workaround for the OS's very small, 1kb\nbuffer size. This is to prevent interleaving between stdout and stderr.
\n"
            },
            {
              "textRaw": "process.stdin",
              "name": "stdin",
              "desc": "
A Readable Stream for stdin (on fd 0).
\n
Example of opening standard input and listening for both events:
\n
process.stdin.setEncoding('utf8');\n\nprocess.stdin.on('readable', () => {\n  var chunk = process.stdin.read();\n  if (chunk !== null) {\n    process.stdout.write(`data: ${chunk}`);\n  }\n});\n\nprocess.stdin.on('end', () => {\n  process.stdout.write('end');\n});\n
\n
As a Stream, process.stdin can also be used in "old" mode that is compatible\nwith scripts written for node.js prior to v0.10.\nFor more information see Stream compatibility.
\n
In "old" Streams mode the stdin stream is paused by default, so one\nmust call process.stdin.resume() to read from it. Note also that calling\nprocess.stdin.resume() itself would switch stream to "old" mode.
\n
If you are starting a new project you should prefer a more recent "new" Streams\nmode over "old" one.
\n"
            },
            {
              "textRaw": "process.stdout",
              "name": "stdout",
              "desc": "
A Writable Stream to stdout (on fd 1).
\n
For example, a console.log equivalent could look like this:
\n
console.log = (msg) => {\n  process.stdout.write(`${msg}\\n`);\n};\n
\n
process.stderr and process.stdout are unlike other streams in Node.js in\nthat they cannot be closed (end() will throw), they never emit the 'finish'\nevent and that writes can block when output is redirected to a file (although\ndisks are fast and operating systems normally employ write-back caching so it\nshould be a very rare occurrence indeed.)
\n
Additionally, process.stderr and process.stdout are blocking when outputting\nto TTYs (terminals) on OS X as a workaround for the OS's very small, 1kb\nbuffer size. This is to prevent interleaving between stdout and stderr.
\n
To check if Node.js is being run in a TTY context, read the isTTY property\non process.stderr, process.stdout, or process.stdin:
\n
$ node -p "Boolean(process.stdin.isTTY)"\ntrue\n$ echo "foo" | node -p "Boolean(process.stdin.isTTY)"\nfalse\n\n$ node -p "Boolean(process.stdout.isTTY)"\ntrue\n$ node -p "Boolean(process.stdout.isTTY)" | cat\nfalse\n
See the tty docs for more information.
\n"
            },
            {
              "textRaw": "process.title",
              "name": "title",
              "meta": {
                "added": [
                  "v0.1.104"
                ]
              },
              "desc": "
Getter/setter to set what is displayed in ps.
\n
When used as a setter, the maximum length is platform-specific and probably\nshort.
\n
On Linux and OS X, it's limited to the size of the binary name plus the\nlength of the command line arguments because it overwrites the argv memory.
\n
v0.8 allowed for longer process title strings by also overwriting the environ\nmemory but that was potentially insecure/confusing in some (rather obscure)\ncases.
\n"
            },
            {
              "textRaw": "process.version",
              "name": "version",
              "meta": {
                "added": [
                  "v0.1.3"
                ]
              },
              "desc": "
A compiled-in property that exposes NODE_VERSION.
\n
console.log(`Version: ${process.version}`);\n
\n"
            },
            {
              "textRaw": "process.versions",
              "name": "versions",
              "meta": {
                "added": [
                  "v0.2.0"
                ]
              },
              "desc": "
A property exposing version strings of Node.js and its dependencies.
\n
console.log(process.versions);\n
\n
Will print something like:
\n
{ http_parser: '2.3.0',\n  node: '1.1.1',\n  v8: '4.1.0.14',\n  uv: '1.3.0',\n  zlib: '1.2.8',\n  ares: '1.10.0-DEV',\n  modules: '43',\n  icu: '55.1',\n  openssl: '1.0.1k' }\n
\n\n\n"
            }
          ]
        }
      ],
      "vars": [
        {
          "textRaw": "\\_\\_dirname",
          "name": "\\_\\_dirname",
          "meta": {
            "added": [
              "v0.1.27"
            ]
          },
          "type": "var",
          "desc": "
    \n
  • {String}
    • \n
\n
The directory name of the current module. This the same as the\npath.dirname() of the __filename.
\n
__dirname isn't actually a global but rather local to each module.
\n
Example: running node example.js from /Users/mjr
\n
console.log(__dirname);\n// Prints: /Users/mjr\nconsole.log(path.dirname(__filename));\n// Prints: /Users/mjr\n
\n"
        },
        {
          "textRaw": "\\_\\_filename",
          "name": "\\_\\_filename",
          "meta": {
            "added": [
              "v0.0.1"
            ]
          },
          "type": "var",
          "desc": "
    \n
  • {String}
    • \n
\n
The file name of the current module. This is the resolved absolute path of the\ncurrent module file.
\n
For a main program this is not necessarily the same as the file name used in the\ncommand line.
\n
See __dirname for the directory name of the current module.
\n
__filename isn't actually a global but rather local to each module.
\n
Examples:
\n
Running node example.js from /Users/mjr
\n
console.log(__filename);\n// Prints: /Users/mjr/example.js\nconsole.log(__dirname);\n// Prints: /Users/mjr\n
\n
Given two modules: a and b, where b is a dependency of\na and there is a directory structure of:
\n
    \n
  • /Users/mjr/app/a.js
    • \n
  • /Users/mjr/app/node_modules/b/b.js
    • \n
\n
References to __filename within b.js will return\n/Users/mjr/app/node_modules/b/b.js while references to __filename within\na.js will return /Users/mjr/app/a.js.
\n"
        },
        {
          "textRaw": "exports",
          "name": "exports",
          "meta": {
            "added": [
              "v0.1.12"
            ]
          },
          "type": "var",
          "desc": "
A reference to the module.exports that is shorter to type.\nSee module system documentation for details on when to use exports and\nwhen to use module.exports.
\n
exports isn't actually a global but rather local to each module.
\n
See the module system documentation for more information.
\n"
        },
        {
          "textRaw": "module",
          "name": "module",
          "meta": {
            "added": [
              "v0.1.16"
            ]
          },
          "type": "var",
          "desc": "
    \n
  • {Object}
    • \n
\n
A reference to the current module. In particular\nmodule.exports is used for defining what a module exports and makes\navailable through require().
\n
module isn't actually a global but rather local to each module.
\n
See the module system documentation for more information.
\n"
        },
        {
          "textRaw": "require()",
          "type": "var",
          "name": "require",
          "meta": {
            "added": [
              "v0.1.13"
            ]
          },
          "desc": "
    \n
  • {Function}
    • \n
\n
To require modules. See the Modules section.  require isn't actually a\nglobal but rather local to each module.
\n",
          "properties": [
            {
              "textRaw": "`cache` {Object} ",
              "type": "Object",
              "name": "cache",
              "meta": {
                "added": [
                  "v0.3.0"
                ]
              },
              "desc": "
Modules are cached in this object when they are required. By deleting a key\nvalue from this object, the next require will reload the module. Note that\nthis does not apply to native addons, for which reloading will result in an\nError.
\n"
            },
            {
              "textRaw": "`extensions` {Object} ",
              "type": "Object",
              "name": "extensions",
              "meta": {
                "added": [
                  "v0.3.0"
                ],
                "deprecated": [
                  "v0.10.6"
                ]
              },
              "stability": 0,
              "stabilityText": "Deprecated",
              "desc": "
Instruct require on how to handle certain file extensions.
\n
Process files with the extension .sjs as .js:
\n
require.extensions['.sjs'] = require.extensions['.js'];\n
\n
Deprecated  In the past, this list has been used to load\nnon-JavaScript modules into Node.js by compiling them on-demand.\nHowever, in practice, there are much better ways to do this, such as\nloading modules via some other Node.js program, or compiling them to\nJavaScript ahead of time.
\n
Since the Module system is locked, this feature will probably never go\naway.  However, it may have subtle bugs and complexities that are best\nleft untouched.
\n"
            }
          ],
          "methods": [
            {
              "textRaw": "require.resolve()",
              "type": "method",
              "name": "resolve",
              "meta": {
                "added": [
                  "v0.3.0"
                ]
              },
              "desc": "
Use the internal require() machinery to look up the location of a module,\nbut rather than loading the module, just return the resolved filename.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "modules": [
    {
      "textRaw": "C/C++ Addons",
      "name": "c/c++_addons",
      "desc": "
Node.js Addons are dynamically-linked shared objects, written in C or C++, that\ncan be loaded into Node.js using the require() function, and used\njust as if they were an ordinary Node.js module. They are used primarily to\nprovide an interface between JavaScript running in Node.js and C/C++ libraries.
\n
At the moment, the method for implementing Addons is rather complicated,\ninvolving knowledge of several components and APIs :
\n
    \n
  • V8: the C++ library Node.js currently uses to provide the\nJavaScript implementation. V8 provides the mechanisms for creating objects,\ncalling functions, etc. V8's API is documented mostly in the\nv8.h header file (deps/v8/include/v8.h in the Node.js source\ntree), which is also available online.
    \n
    • \n
  • libuv: The C library that implements the Node.js event loop, its worker\nthreads and all of the asynchronous behaviors of the platform. It also\nserves as a cross-platform abstraction library, giving easy, POSIX-like\naccess across all major operating systems to many common system tasks, such\nas interacting with the filesystem, sockets, timers and system events. libuv\nalso provides a pthreads-like threading abstraction that may be used to\npower more sophisticated asynchronous Addons that need to move beyond the\nstandard event loop. Addon authors are encouraged to think about how to\navoid blocking the event loop with I/O or other time-intensive tasks by\noff-loading work via libuv to non-blocking system operations, worker threads\nor a custom use of libuv's threads.
    \n
    • \n
  • Internal Node.js libraries. Node.js itself exports a number of C/C++ APIs\nthat Addons can use — the most important of which is the\nnode::ObjectWrap class.
    \n
    • \n
  • Node.js includes a number of other statically linked libraries including\nOpenSSL. These other libraries are located in the deps/ directory in the\nNode.js source tree. Only the V8 and OpenSSL symbols are purposefully\nre-exported by Node.js and may be used to various extents by Addons.\nSee Linking to Node.js' own dependencies for additional information.
    \n
    • \n
\n
All of the following examples are available for download and may\nbe used as a starting-point for your own Addon.
\n",
      "modules": [
        {
          "textRaw": "Hello world",
          "name": "hello_world",
          "desc": "
This "Hello world" example is a simple Addon, written in C++, that is the\nequivalent of the following JavaScript code:
\n
module.exports.hello = () => 'world';\n
\n
First, create the file hello.cc:
\n
// hello.cc\n#include <node.h>\n\nnamespace demo {\n\nusing v8::FunctionCallbackInfo;\nusing v8::Isolate;\nusing v8::Local;\nusing v8::Object;\nusing v8::String;\nusing v8::Value;\n\nvoid Method(const FunctionCallbackInfo<Value>& args) {\n  Isolate* isolate = args.GetIsolate();\n  args.GetReturnValue().Set(String::NewFromUtf8(isolate, "world"));\n}\n\nvoid init(Local<Object> exports) {\n  NODE_SET_METHOD(exports, "hello", Method);\n}\n\nNODE_MODULE(addon, init)\n\n}  // namespace demo\n
\n
Note that all Node.js Addons must export an initialization function following\nthe pattern:
\n
void Initialize(Local<Object> exports);\nNODE_MODULE(module_name, Initialize)\n
\n
There is no semi-colon after NODE_MODULE as it's not a function (see\nnode.h).
\n
The module_name must match the filename of the final binary (excluding\nthe .node suffix).
\n
In the hello.cc example, then, the initialization function is init and the\nAddon module name is addon.
\n",
          "modules": [
            {
              "textRaw": "Building",
              "name": "building",
              "desc": "
Once the source code has been written, it must be compiled into the binary\naddon.node file. To do so, create a file called binding.gyp in the\ntop-level of the project describing the build configuration of your module\nusing a JSON-like format. This file is used by node-gyp -- a tool written\nspecifically to compile Node.js Addons.
\n
{\n  "targets": [\n    {\n      "target_name": "addon",\n      "sources": [ "hello.cc" ]\n    }\n  ]\n}\n
Note: A version of the node-gyp utility is bundled and distributed with\nNode.js as part of npm. This version is not made directly available for\ndevelopers to use and is intended only to support the ability to use the\nnpm install command to compile and install Addons. Developers who wish to\nuse node-gyp directly can install it using the command\nnpm install -g node-gyp. See the node-gyp installation instructions for\nmore information, including platform-specific requirements.
\n
Once the binding.gyp file has been created, use node-gyp configure to\ngenerate the appropriate project build files for the current platform. This\nwill generate either a Makefile (on Unix platforms) or a vcxproj file\n(on Windows) in the build/ directory.
\n
Next, invoke the node-gyp build command to generate the compiled addon.node\nfile. This will be put into the build/Release/ directory.
\n
When using npm install to install a Node.js Addon, npm uses its own bundled\nversion of node-gyp to perform this same set of actions, generating a\ncompiled version of the Addon for the user's platform on demand.
\n
Once built, the binary Addon can be used from within Node.js by pointing\nrequire() to the built addon.node module:
\n
// hello.js\nconst addon = require('./build/Release/addon');\n\nconsole.log(addon.hello()); // 'world'\n
\n
Please see the examples below for further information or\nhttps://github.com/arturadib/node-qt for an example in production.
\n
Because the exact path to the compiled Addon binary can vary depending on how\nit is compiled (i.e. sometimes it may be in ./build/Debug/), Addons can use\nthe bindings package to load the compiled module.
\n
Note that while the bindings package implementation is more sophisticated\nin how it locates Addon modules, it is essentially using a try-catch pattern\nsimilar to:
\n
try {\n  return require('./build/Release/addon.node');\n} catch (err) {\n  return require('./build/Debug/addon.node');\n}\n
\n",
              "type": "module",
              "displayName": "Building"
            },
            {
              "textRaw": "Linking to Node.js' own dependencies",
              "name": "linking_to_node.js'_own_dependencies",
              "desc": "
Node.js uses a number of statically linked libraries such as V8, libuv and\nOpenSSL. All Addons are required to link to V8 and may link to any of the\nother dependencies as well. Typically, this is as simple as including\nthe appropriate #include <...> statements (e.g. #include <v8.h>) and\nnode-gyp will locate the appropriate headers automatically. However, there\nare a few caveats to be aware of:
\n
    \n
  • When node-gyp runs, it will detect the specific release version of Node.js\nand download either the full source tarball or just the headers. If the full\nsource is downloaded, Addons will have complete access to the full set of\nNode.js dependencies. However, if only the Node.js headers are downloaded, then\nonly the symbols exported by Node.js will be available.
    \n
    • \n
  • node-gyp can be run using the --nodedir flag pointing at a local Node.js\nsource image. Using this option, the Addon will have access to the full set of\ndependencies.
    \n
    • \n
\n",
              "type": "module",
              "displayName": "Linking to Node.js' own dependencies"
            },
            {
              "textRaw": "Loading Addons using require()",
              "name": "loading_addons_using_require()",
              "desc": "
The filename extension of the compiled Addon binary is .node (as opposed\nto .dll or .so). The require() function is written to look for\nfiles with the .node file extension and initialize those as dynamically-linked\nlibraries.
\n
When calling require(), the .node extension can usually be\nomitted and Node.js will still find and initialize the Addon. One caveat,\nhowever, is that Node.js will first attempt to locate and load modules or\nJavaScript files that happen to share the same base name. For instance, if\nthere is a file addon.js in the same directory as the binary addon.node,\nthen require('addon') will give precedence to the addon.js file\nand load it instead.
\n",
              "type": "module",
              "displayName": "Loading Addons using require()"
            }
          ],
          "type": "module",
          "displayName": "Hello world"
        },
        {
          "textRaw": "Addon examples",
          "name": "addon_examples",
          "desc": "
Following are some example Addons intended to help developers get started. The\nexamples make use of the V8 APIs. Refer to the online V8 reference\nfor help with the various V8 calls, and V8's Embedder's Guide for an\nexplanation of several concepts used such as handles, scopes, function\ntemplates, etc.
\n
Each of these examples using the following binding.gyp file:
\n
{\n  "targets": [\n    {\n      "target_name": "addon",\n      "sources": [ "addon.cc" ]\n    }\n  ]\n}\n
In cases where there is more than one .cc file, simply add the additional\nfilename to the sources array. For example:
\n
"sources": ["addon.cc", "myexample.cc"]\n
Once the binding.gyp file is ready, the example Addons can be configured and\nbuilt using node-gyp:
\n
$ node-gyp configure build\n
",
          "modules": [
            {
              "textRaw": "Function arguments",
              "name": "function_arguments",
              "desc": "
Addons will typically expose objects and functions that can be accessed from\nJavaScript running within Node.js. When functions are invoked from JavaScript,\nthe input arguments and return value must be mapped to and from the C/C++\ncode.
\n
The following example illustrates how to read function arguments passed from\nJavaScript and how to return a result:
\n
// addon.cc\n#include <node.h>\n\nnamespace demo {\n\nusing v8::Exception;\nusing v8::FunctionCallbackInfo;\nusing v8::Isolate;\nusing v8::Local;\nusing v8::Number;\nusing v8::Object;\nusing v8::String;\nusing v8::Value;\n\n// This is the implementation of the "add" method\n// Input arguments are passed using the\n// const FunctionCallbackInfo<Value>& args struct\nvoid Add(const FunctionCallbackInfo<Value>& args) {\n  Isolate* isolate = args.GetIsolate();\n\n  // Check the number of arguments passed.\n  if (args.Length() < 2) {\n    // Throw an Error that is passed back to JavaScript\n    isolate->ThrowException(Exception::TypeError(\n        String::NewFromUtf8(isolate, "Wrong number of arguments")));\n    return;\n  }\n\n  // Check the argument types\n  if (!args[0]->IsNumber() || !args[1]->IsNumber()) {\n    isolate->ThrowException(Exception::TypeError(\n        String::NewFromUtf8(isolate, "Wrong arguments")));\n    return;\n  }\n\n  // Perform the operation\n  double value = args[0]->NumberValue() + args[1]->NumberValue();\n  Local<Number> num = Number::New(isolate, value);\n\n  // Set the return value (using the passed in\n  // FunctionCallbackInfo<Value>&)\n  args.GetReturnValue().Set(num);\n}\n\nvoid Init(Local<Object> exports) {\n  NODE_SET_METHOD(exports, "add", Add);\n}\n\nNODE_MODULE(addon, Init)\n\n}  // namespace demo\n
\n
Once compiled, the example Addon can be required and used from within Node.js:
\n
// test.js\nconst addon = require('./build/Release/addon');\n\nconsole.log('This should be eight:', addon.add(3, 5));\n
\n",
              "type": "module",
              "displayName": "Function arguments"
            },
            {
              "textRaw": "Callbacks",
              "name": "callbacks",
              "desc": "
It is common practice within Addons to pass JavaScript functions to a C++\nfunction and execute them from there. The following example illustrates how\nto invoke such callbacks:
\n
// addon.cc\n#include <node.h>\n\nnamespace demo {\n\nusing v8::Function;\nusing v8::FunctionCallbackInfo;\nusing v8::Isolate;\nusing v8::Local;\nusing v8::Null;\nusing v8::Object;\nusing v8::String;\nusing v8::Value;\n\nvoid RunCallback(const FunctionCallbackInfo<Value>& args) {\n  Isolate* isolate = args.GetIsolate();\n  Local<Function> cb = Local<Function>::Cast(args[0]);\n  const unsigned argc = 1;\n  Local<Value> argv[argc] = { String::NewFromUtf8(isolate, "hello world") };\n  cb->Call(Null(isolate), argc, argv);\n}\n\nvoid Init(Local<Object> exports, Local<Object> module) {\n  NODE_SET_METHOD(module, "exports", RunCallback);\n}\n\nNODE_MODULE(addon, Init)\n\n}  // namespace demo\n
\n
Note that this example uses a two-argument form of Init() that receives\nthe full module object as the second argument. This allows the Addon\nto completely overwrite exports with a single function instead of\nadding the function as a property of exports.
\n
To test it, run the following JavaScript:
\n
// test.js\nconst addon = require('./build/Release/addon');\n\naddon((msg) => {\n  console.log(msg); // 'hello world'\n});\n
\n
Note that, in this example, the callback function is invoked synchronously.
\n",
              "type": "module",
              "displayName": "Callbacks"
            },
            {
              "textRaw": "Object factory",
              "name": "object_factory",
              "desc": "
Addons can create and return new objects from within a C++ function as\nillustrated in the following example. An object is created and returned with a\nproperty msg that echoes the string passed to createObject():
\n
// addon.cc\n#include <node.h>\n\nnamespace demo {\n\nusing v8::FunctionCallbackInfo;\nusing v8::Isolate;\nusing v8::Local;\nusing v8::Object;\nusing v8::String;\nusing v8::Value;\n\nvoid CreateObject(const FunctionCallbackInfo<Value>& args) {\n  Isolate* isolate = args.GetIsolate();\n\n  Local<Object> obj = Object::New(isolate);\n  obj->Set(String::NewFromUtf8(isolate, "msg"), args[0]->ToString());\n\n  args.GetReturnValue().Set(obj);\n}\n\nvoid Init(Local<Object> exports, Local<Object> module) {\n  NODE_SET_METHOD(module, "exports", CreateObject);\n}\n\nNODE_MODULE(addon, Init)\n\n}  // namespace demo\n
\n
To test it in JavaScript:
\n
// test.js\nconst addon = require('./build/Release/addon');\n\nvar obj1 = addon('hello');\nvar obj2 = addon('world');\nconsole.log(obj1.msg, obj2.msg); // 'hello world'\n
\n",
              "type": "module",
              "displayName": "Object factory"
            },
            {
              "textRaw": "Function factory",
              "name": "function_factory",
              "desc": "
Another common scenario is creating JavaScript functions that wrap C++\nfunctions and returning those back to JavaScript:
\n
// addon.cc\n#include <node.h>\n\nnamespace demo {\n\nusing v8::Function;\nusing v8::FunctionCallbackInfo;\nusing v8::FunctionTemplate;\nusing v8::Isolate;\nusing v8::Local;\nusing v8::Object;\nusing v8::String;\nusing v8::Value;\n\nvoid MyFunction(const FunctionCallbackInfo<Value>& args) {\n  Isolate* isolate = args.GetIsolate();\n  args.GetReturnValue().Set(String::NewFromUtf8(isolate, "hello world"));\n}\n\nvoid CreateFunction(const FunctionCallbackInfo<Value>& args) {\n  Isolate* isolate = args.GetIsolate();\n\n  Local<FunctionTemplate> tpl = FunctionTemplate::New(isolate, MyFunction);\n  Local<Function> fn = tpl->GetFunction();\n\n  // omit this to make it anonymous\n  fn->SetName(String::NewFromUtf8(isolate, "theFunction"));\n\n  args.GetReturnValue().Set(fn);\n}\n\nvoid Init(Local<Object> exports, Local<Object> module) {\n  NODE_SET_METHOD(module, "exports", CreateFunction);\n}\n\nNODE_MODULE(addon, Init)\n\n}  // namespace demo\n
\n
To test:
\n
// test.js\nconst addon = require('./build/Release/addon');\n\nvar fn = addon();\nconsole.log(fn()); // 'hello world'\n
\n",
              "type": "module",
              "displayName": "Function factory"
            },
            {
              "textRaw": "Wrapping C++ objects",
              "name": "wrapping_c++_objects",
              "desc": "
It is also possible to wrap C++ objects/classes in a way that allows new\ninstances to be created using the JavaScript new operator:
\n
// addon.cc\n#include <node.h>\n#include "myobject.h"\n\nnamespace demo {\n\nusing v8::Local;\nusing v8::Object;\n\nvoid InitAll(Local<Object> exports) {\n  MyObject::Init(exports);\n}\n\nNODE_MODULE(addon, InitAll)\n\n}  // namespace demo\n
\n
Then, in myobject.h, the wrapper class inherits from node::ObjectWrap:
\n
// myobject.h\n#ifndef MYOBJECT_H\n#define MYOBJECT_H\n\n#include <node.h>\n#include <node_object_wrap.h>\n\nnamespace demo {\n\nclass MyObject : public node::ObjectWrap {\n public:\n  static void Init(v8::Local<v8::Object> exports);\n\n private:\n  explicit MyObject(double value = 0);\n  ~MyObject();\n\n  static void New(const v8::FunctionCallbackInfo<v8::Value>& args);\n  static void PlusOne(const v8::FunctionCallbackInfo<v8::Value>& args);\n  static v8::Persistent<v8::Function> constructor;\n  double value_;\n};\n\n}  // namespace demo\n\n#endif\n
\n
In myobject.cc, implement the various methods that are to be exposed.\nBelow, the method plusOne() is exposed by adding it to the constructor's\nprototype:
\n
// myobject.cc\n#include "myobject.h"\n\nnamespace demo {\n\nusing v8::Context;\nusing v8::Function;\nusing v8::FunctionCallbackInfo;\nusing v8::FunctionTemplate;\nusing v8::Isolate;\nusing v8::Local;\nusing v8::Number;\nusing v8::Object;\nusing v8::Persistent;\nusing v8::String;\nusing v8::Value;\n\nPersistent<Function> MyObject::constructor;\n\nMyObject::MyObject(double value) : value_(value) {\n}\n\nMyObject::~MyObject() {\n}\n\nvoid MyObject::Init(Local<Object> exports) {\n  Isolate* isolate = exports->GetIsolate();\n\n  // Prepare constructor template\n  Local<FunctionTemplate> tpl = FunctionTemplate::New(isolate, New);\n  tpl->SetClassName(String::NewFromUtf8(isolate, "MyObject"));\n  tpl->InstanceTemplate()->SetInternalFieldCount(1);\n\n  // Prototype\n  NODE_SET_PROTOTYPE_METHOD(tpl, "plusOne", PlusOne);\n\n  constructor.Reset(isolate, tpl->GetFunction());\n  exports->Set(String::NewFromUtf8(isolate, "MyObject"),\n               tpl->GetFunction());\n}\n\nvoid MyObject::New(const FunctionCallbackInfo<Value>& args) {\n  Isolate* isolate = args.GetIsolate();\n\n  if (args.IsConstructCall()) {\n    // Invoked as constructor: `new MyObject(...)`\n    double value = args[0]->IsUndefined() ? 0 : args[0]->NumberValue();\n    MyObject* obj = new MyObject(value);\n    obj->Wrap(args.This());\n    args.GetReturnValue().Set(args.This());\n  } else {\n    // Invoked as plain function `MyObject(...)`, turn into construct call.\n    const int argc = 1;\n    Local<Value> argv[argc] = { args[0] };\n    Local<Context> context = isolate->GetCurrentContext();\n    Local<Function> cons = Local<Function>::New(isolate, constructor);\n    Local<Object> result =\n        cons->NewInstance(context, argc, argv).ToLocalChecked();\n    args.GetReturnValue().Set(result);\n  }\n}\n\nvoid MyObject::PlusOne(const FunctionCallbackInfo<Value>& args) {\n  Isolate* isolate = args.GetIsolate();\n\n  MyObject* obj = ObjectWrap::Unwrap<MyObject>(args.Holder());\n  obj->value_ += 1;\n\n  args.GetReturnValue().Set(Number::New(isolate, obj->value_));\n}\n\n}  // namespace demo\n
\n
To build this example, the myobject.cc file must be added to the\nbinding.gyp:
\n
{\n  "targets": [\n    {\n      "target_name": "addon",\n      "sources": [\n        "addon.cc",\n        "myobject.cc"\n      ]\n    }\n  ]\n}\n
Test it with:
\n
// test.js\nconst addon = require('./build/Release/addon');\n\nvar obj = new addon.MyObject(10);\nconsole.log(obj.plusOne()); // 11\nconsole.log(obj.plusOne()); // 12\nconsole.log(obj.plusOne()); // 13\n
\n",
              "type": "module",
              "displayName": "Wrapping C++ objects"
            },
            {
              "textRaw": "Factory of wrapped objects",
              "name": "factory_of_wrapped_objects",
              "desc": "
Alternatively, it is possible to use a factory pattern to avoid explicitly\ncreating object instances using the JavaScript new operator:
\n
var obj = addon.createObject();\n// instead of:\n// var obj = new addon.Object();\n
\n
First, the createObject() method is implemented in addon.cc:
\n
// addon.cc\n#include <node.h>\n#include "myobject.h"\n\nnamespace demo {\n\nusing v8::FunctionCallbackInfo;\nusing v8::Isolate;\nusing v8::Local;\nusing v8::Object;\nusing v8::String;\nusing v8::Value;\n\nvoid CreateObject(const FunctionCallbackInfo<Value>& args) {\n  MyObject::NewInstance(args);\n}\n\nvoid InitAll(Local<Object> exports, Local<Object> module) {\n  MyObject::Init(exports->GetIsolate());\n\n  NODE_SET_METHOD(module, "exports", CreateObject);\n}\n\nNODE_MODULE(addon, InitAll)\n\n}  // namespace demo\n
\n
In myobject.h, the static method NewInstance() is added to handle\ninstantiating the object. This method takes the place of using new in\nJavaScript:
\n
// myobject.h\n#ifndef MYOBJECT_H\n#define MYOBJECT_H\n\n#include <node.h>\n#include <node_object_wrap.h>\n\nnamespace demo {\n\nclass MyObject : public node::ObjectWrap {\n public:\n  static void Init(v8::Isolate* isolate);\n  static void NewInstance(const v8::FunctionCallbackInfo<v8::Value>& args);\n\n private:\n  explicit MyObject(double value = 0);\n  ~MyObject();\n\n  static void New(const v8::FunctionCallbackInfo<v8::Value>& args);\n  static void PlusOne(const v8::FunctionCallbackInfo<v8::Value>& args);\n  static v8::Persistent<v8::Function> constructor;\n  double value_;\n};\n\n}  // namespace demo\n\n#endif\n
\n
The implementation in myobject.cc is similar to the previous example:
\n
// myobject.cc\n#include <node.h>\n#include "myobject.h"\n\nnamespace demo {\n\nusing v8::Context;\nusing v8::Function;\nusing v8::FunctionCallbackInfo;\nusing v8::FunctionTemplate;\nusing v8::Isolate;\nusing v8::Local;\nusing v8::Number;\nusing v8::Object;\nusing v8::Persistent;\nusing v8::String;\nusing v8::Value;\n\nPersistent<Function> MyObject::constructor;\n\nMyObject::MyObject(double value) : value_(value) {\n}\n\nMyObject::~MyObject() {\n}\n\nvoid MyObject::Init(Isolate* isolate) {\n  // Prepare constructor template\n  Local<FunctionTemplate> tpl = FunctionTemplate::New(isolate, New);\n  tpl->SetClassName(String::NewFromUtf8(isolate, "MyObject"));\n  tpl->InstanceTemplate()->SetInternalFieldCount(1);\n\n  // Prototype\n  NODE_SET_PROTOTYPE_METHOD(tpl, "plusOne", PlusOne);\n\n  constructor.Reset(isolate, tpl->GetFunction());\n}\n\nvoid MyObject::New(const FunctionCallbackInfo<Value>& args) {\n  Isolate* isolate = args.GetIsolate();\n\n  if (args.IsConstructCall()) {\n    // Invoked as constructor: `new MyObject(...)`\n    double value = args[0]->IsUndefined() ? 0 : args[0]->NumberValue();\n    MyObject* obj = new MyObject(value);\n    obj->Wrap(args.This());\n    args.GetReturnValue().Set(args.This());\n  } else {\n    // Invoked as plain function `MyObject(...)`, turn into construct call.\n    const int argc = 1;\n    Local<Value> argv[argc] = { args[0] };\n    Local<Function> cons = Local<Function>::New(isolate, constructor);\n    Local<Context> context = isolate->GetCurrentContext();\n    Local<Object> instance =\n        cons->NewInstance(context, argc, argv).ToLocalChecked();\n    args.GetReturnValue().Set(instance);\n  }\n}\n\nvoid MyObject::NewInstance(const FunctionCallbackInfo<Value>& args) {\n  Isolate* isolate = args.GetIsolate();\n\n  const unsigned argc = 1;\n  Local<Value> argv[argc] = { args[0] };\n  Local<Function> cons = Local<Function>::New(isolate, constructor);\n  Local<Context> context = isolate->GetCurrentContext();\n  Local<Object> instance =\n      cons->NewInstance(context, argc, argv).ToLocalChecked();\n\n  args.GetReturnValue().Set(instance);\n}\n\nvoid MyObject::PlusOne(const FunctionCallbackInfo<Value>& args) {\n  Isolate* isolate = args.GetIsolate();\n\n  MyObject* obj = ObjectWrap::Unwrap<MyObject>(args.Holder());\n  obj->value_ += 1;\n\n  args.GetReturnValue().Set(Number::New(isolate, obj->value_));\n}\n\n}  // namespace demo\n
\n
Once again, to build this example, the myobject.cc file must be added to the\nbinding.gyp:
\n
{\n  "targets": [\n    {\n      "target_name": "addon",\n      "sources": [\n        "addon.cc",\n        "myobject.cc"\n      ]\n    }\n  ]\n}\n
Test it with:
\n
// test.js\nconst createObject = require('./build/Release/addon');\n\nvar obj = createObject(10);\nconsole.log(obj.plusOne()); // 11\nconsole.log(obj.plusOne()); // 12\nconsole.log(obj.plusOne()); // 13\n\nvar obj2 = createObject(20);\nconsole.log(obj2.plusOne()); // 21\nconsole.log(obj2.plusOne()); // 22\nconsole.log(obj2.plusOne()); // 23\n
\n",
              "type": "module",
              "displayName": "Factory of wrapped objects"
            },
            {
              "textRaw": "Passing wrapped objects around",
              "name": "passing_wrapped_objects_around",
              "desc": "
In addition to wrapping and returning C++ objects, it is possible to pass\nwrapped objects around by unwrapping them with the Node.js helper function\nnode::ObjectWrap::Unwrap. The following examples shows a function add()\nthat can take two MyObject objects as input arguments:
\n
// addon.cc\n#include <node.h>\n#include <node_object_wrap.h>\n#include "myobject.h"\n\nnamespace demo {\n\nusing v8::FunctionCallbackInfo;\nusing v8::Isolate;\nusing v8::Local;\nusing v8::Number;\nusing v8::Object;\nusing v8::String;\nusing v8::Value;\n\nvoid CreateObject(const FunctionCallbackInfo<Value>& args) {\n  MyObject::NewInstance(args);\n}\n\nvoid Add(const FunctionCallbackInfo<Value>& args) {\n  Isolate* isolate = args.GetIsolate();\n\n  MyObject* obj1 = node::ObjectWrap::Unwrap<MyObject>(\n      args[0]->ToObject());\n  MyObject* obj2 = node::ObjectWrap::Unwrap<MyObject>(\n      args[1]->ToObject());\n\n  double sum = obj1->value() + obj2->value();\n  args.GetReturnValue().Set(Number::New(isolate, sum));\n}\n\nvoid InitAll(Local<Object> exports) {\n  MyObject::Init(exports->GetIsolate());\n\n  NODE_SET_METHOD(exports, "createObject", CreateObject);\n  NODE_SET_METHOD(exports, "add", Add);\n}\n\nNODE_MODULE(addon, InitAll)\n\n}  // namespace demo\n
\n
In myobject.h, a new public method is added to allow access to private values\nafter unwrapping the object.
\n
// myobject.h\n#ifndef MYOBJECT_H\n#define MYOBJECT_H\n\n#include <node.h>\n#include <node_object_wrap.h>\n\nnamespace demo {\n\nclass MyObject : public node::ObjectWrap {\n public:\n  static void Init(v8::Isolate* isolate);\n  static void NewInstance(const v8::FunctionCallbackInfo<v8::Value>& args);\n  inline double value() const { return value_; }\n\n private:\n  explicit MyObject(double value = 0);\n  ~MyObject();\n\n  static void New(const v8::FunctionCallbackInfo<v8::Value>& args);\n  static v8::Persistent<v8::Function> constructor;\n  double value_;\n};\n\n}  // namespace demo\n\n#endif\n
\n
The implementation of myobject.cc is similar to before:
\n
// myobject.cc\n#include <node.h>\n#include "myobject.h"\n\nnamespace demo {\n\nusing v8::Context;\nusing v8::Function;\nusing v8::FunctionCallbackInfo;\nusing v8::FunctionTemplate;\nusing v8::Isolate;\nusing v8::Local;\nusing v8::Object;\nusing v8::Persistent;\nusing v8::String;\nusing v8::Value;\n\nPersistent<Function> MyObject::constructor;\n\nMyObject::MyObject(double value) : value_(value) {\n}\n\nMyObject::~MyObject() {\n}\n\nvoid MyObject::Init(Isolate* isolate) {\n  // Prepare constructor template\n  Local<FunctionTemplate> tpl = FunctionTemplate::New(isolate, New);\n  tpl->SetClassName(String::NewFromUtf8(isolate, "MyObject"));\n  tpl->InstanceTemplate()->SetInternalFieldCount(1);\n\n  constructor.Reset(isolate, tpl->GetFunction());\n}\n\nvoid MyObject::New(const FunctionCallbackInfo<Value>& args) {\n  Isolate* isolate = args.GetIsolate();\n\n  if (args.IsConstructCall()) {\n    // Invoked as constructor: `new MyObject(...)`\n    double value = args[0]->IsUndefined() ? 0 : args[0]->NumberValue();\n    MyObject* obj = new MyObject(value);\n    obj->Wrap(args.This());\n    args.GetReturnValue().Set(args.This());\n  } else {\n    // Invoked as plain function `MyObject(...)`, turn into construct call.\n    const int argc = 1;\n    Local<Value> argv[argc] = { args[0] };\n    Local<Context> context = isolate->GetCurrentContext();\n    Local<Function> cons = Local<Function>::New(isolate, constructor);\n    Local<Object> instance =\n        cons->NewInstance(context, argc, argv).ToLocalChecked();\n    args.GetReturnValue().Set(instance);\n  }\n}\n\nvoid MyObject::NewInstance(const FunctionCallbackInfo<Value>& args) {\n  Isolate* isolate = args.GetIsolate();\n\n  const unsigned argc = 1;\n  Local<Value> argv[argc] = { args[0] };\n  Local<Function> cons = Local<Function>::New(isolate, constructor);\n  Local<Context> context = isolate->GetCurrentContext();\n  Local<Object> instance =\n      cons->NewInstance(context, argc, argv).ToLocalChecked();\n\n  args.GetReturnValue().Set(instance);\n}\n\n}  // namespace demo\n
\n
Test it with:
\n
// test.js\nconst addon = require('./build/Release/addon');\n\nvar obj1 = addon.createObject(10);\nvar obj2 = addon.createObject(20);\nvar result = addon.add(obj1, obj2);\n\nconsole.log(result); // 30\n
\n",
              "type": "module",
              "displayName": "Passing wrapped objects around"
            },
            {
              "textRaw": "AtExit hooks",
              "name": "atexit_hooks",
              "desc": "
An "AtExit" hook is a function that is invoked after the Node.js event loop\nhas ended but before the JavaScript VM is terminated and Node.js shuts down.\n"AtExit" hooks are registered using the node::AtExit API.
\n",
              "modules": [
                {
                  "textRaw": "void AtExit(callback, args)",
                  "name": "void_atexit(callback,_args)",
                  "desc": "
    \n
  • callback: void (*)(void*) - A pointer to the function to call at exit.
    • \n
  • args: void* - A pointer to pass to the callback at exit.
    • \n
\n
Registers exit hooks that run after the event loop has ended but before the VM\nis killed.
\n
AtExit takes two parameters: a pointer to a callback function to run at exit,\nand a pointer to untyped context data to be passed to that callback.
\n
Callbacks are run in last-in first-out order.
\n
The following addon.cc implements AtExit:
\n
// addon.cc\n#undef NDEBUG\n#include <assert.h>\n#include <stdlib.h>\n#include <node.h>\n\nnamespace demo {\n\nusing node::AtExit;\nusing v8::HandleScope;\nusing v8::Isolate;\nusing v8::Local;\nusing v8::Object;\n\nstatic char cookie[] = "yum yum";\nstatic int at_exit_cb1_called = 0;\nstatic int at_exit_cb2_called = 0;\n\nstatic void at_exit_cb1(void* arg) {\n  Isolate* isolate = static_cast<Isolate*>(arg);\n  HandleScope scope(isolate);\n  Local<Object> obj = Object::New(isolate);\n  assert(!obj.IsEmpty()); // assert VM is still alive\n  assert(obj->IsObject());\n  at_exit_cb1_called++;\n}\n\nstatic void at_exit_cb2(void* arg) {\n  assert(arg == static_cast<void*>(cookie));\n  at_exit_cb2_called++;\n}\n\nstatic void sanity_check(void*) {\n  assert(at_exit_cb1_called == 1);\n  assert(at_exit_cb2_called == 2);\n}\n\nvoid init(Local<Object> exports) {\n  AtExit(sanity_check);\n  AtExit(at_exit_cb2, cookie);\n  AtExit(at_exit_cb2, cookie);\n  AtExit(at_exit_cb1, exports->GetIsolate());\n}\n\nNODE_MODULE(addon, init);\n\n}  // namespace demo\n
\n
Test in JavaScript by running:
\n
// test.js\nconst addon = require('./build/Release/addon');\n
\n\n\n",
                  "type": "module",
                  "displayName": "void AtExit(callback, args)"
                }
              ],
              "type": "module",
              "displayName": "AtExit hooks"
            }
          ],
          "type": "module",
          "displayName": "Addon examples"
        }
      ],
      "properties": [
        {
          "textRaw": "Native Abstractions for Node.js",
          "name": "js",
          "desc": "
Each of the examples illustrated in this document make direct use of the\nNode.js and V8 APIs for implementing Addons. It is important to understand\nthat the V8 API can, and has, changed dramatically from one V8 release to the\nnext (and one major Node.js release to the next). With each change, Addons may\nneed to be updated and recompiled in order to continue functioning. The Node.js\nrelease schedule is designed to minimize the frequency and impact of such\nchanges but there is little that Node.js can do currently to ensure stability\nof the V8 APIs.
\n
The Native Abstractions for Node.js (or nan) provide a set of tools that\nAddon developers are recommended to use to keep compatibility between past and\nfuture releases of V8 and Node.js. See the nan examples for an\nillustration of how it can be used.
\n"
        }
      ],
      "type": "module",
      "displayName": "C/C++ Addons"
    },
    {
      "textRaw": "Assert",
      "name": "assert",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
The assert module provides a simple set of assertion tests that can be used to\ntest invariants.
\n",
      "methods": [
        {
          "textRaw": "assert(value[, message])",
          "type": "method",
          "name": "assert",
          "meta": {
            "added": [
              "v0.5.9"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`value` {any} ",
                  "name": "value",
                  "type": "any"
                },
                {
                  "textRaw": "`message` {any} ",
                  "name": "message",
                  "type": "any",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "value"
                },
                {
                  "name": "message",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "
An alias of assert.ok() .
\n
const assert = require('assert');\n\nassert(true);  // OK\nassert(1);     // OK\nassert(false);\n  // throws "AssertionError: false == true"\nassert(0);\n  // throws "AssertionError: 0 == true"\nassert(false, 'it\\'s false');\n  // throws "AssertionError: it's false"\n
\n"
        },
        {
          "textRaw": "assert.deepEqual(actual, expected[, message])",
          "type": "method",
          "name": "deepEqual",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`actual` {any} ",
                  "name": "actual",
                  "type": "any"
                },
                {
                  "textRaw": "`expected` {any} ",
                  "name": "expected",
                  "type": "any"
                },
                {
                  "textRaw": "`message` {any} ",
                  "name": "message",
                  "type": "any",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "actual"
                },
                {
                  "name": "expected"
                },
                {
                  "name": "message",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "
Tests for deep equality between the actual and expected parameters.\nPrimitive values are compared with the equal comparison operator ( == ).
\n
Only enumerable "own" properties are considered. The deepEqual()\nimplementation does not test object prototypes, attached symbols, or\nnon-enumerable properties. This can lead to some potentially surprising\nresults. For example, the following example does not throw an AssertionError\nbecause the properties on the Error object are non-enumerable:
\n
// WARNING: This does not throw an AssertionError!\nassert.deepEqual(Error('a'), Error('b'));\n
\n
"Deep" equality means that the enumerable "own" properties of child objects\nare evaluated also:
\n
const assert = require('assert');\n\nconst obj1 = {\n  a : {\n    b : 1\n  }\n};\nconst obj2 = {\n  a : {\n    b : 2\n  }\n};\nconst obj3 = {\n  a : {\n    b : 1\n  }\n}\nconst obj4 = Object.create(obj1);\n\nassert.deepEqual(obj1, obj1);\n  // OK, object is equal to itself\n\nassert.deepEqual(obj1, obj2);\n  // AssertionError: { a: { b: 1 } } deepEqual { a: { b: 2 } }\n  // values of b are different\n\nassert.deepEqual(obj1, obj3);\n  // OK, objects are equal\n\nassert.deepEqual(obj1, obj4);\n  // AssertionError: { a: { b: 1 } } deepEqual {}\n  // Prototypes are ignored\n
\n
If the values are not equal, an AssertionError is thrown with a message\nproperty set equal to the value of the message parameter. If the message\nparameter is undefined, a default error message is assigned.
\n"
        },
        {
          "textRaw": "assert.deepStrictEqual(actual, expected[, message])",
          "type": "method",
          "name": "deepStrictEqual",
          "meta": {
            "added": [
              "v1.2.0"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`actual` {any} ",
                  "name": "actual",
                  "type": "any"
                },
                {
                  "textRaw": "`expected` {any} ",
                  "name": "expected",
                  "type": "any"
                },
                {
                  "textRaw": "`message` {any} ",
                  "name": "message",
                  "type": "any",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "actual"
                },
                {
                  "name": "expected"
                },
                {
                  "name": "message",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "
Generally identical to assert.deepEqual() with two exceptions. First,\nprimitive values are compared using the strict equality operator ( === ).\nSecond, object comparisons include a strict equality check of their prototypes.
\n
const assert = require('assert');\n\nassert.deepEqual({a:1}, {a:'1'});\n  // OK, because 1 == '1'\n\nassert.deepStrictEqual({a:1}, {a:'1'});\n  // AssertionError: { a: 1 } deepStrictEqual { a: '1' }\n  // because 1 !== '1' using strict equality\n
\n
If the values are not equal, an AssertionError is thrown with a message\nproperty set equal to the value of the message parameter. If the message\nparameter is undefined, a default error message is assigned.
\n"
        },
        {
          "textRaw": "assert.doesNotThrow(block[, error][, message])",
          "type": "method",
          "name": "doesNotThrow",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`block` {Function} ",
                  "name": "block",
                  "type": "Function"
                },
                {
                  "textRaw": "`error` {RegExp|Function} ",
                  "name": "error",
                  "type": "RegExp|Function",
                  "optional": true
                },
                {
                  "textRaw": "`message` {any} ",
                  "name": "message",
                  "type": "any",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "block"
                },
                {
                  "name": "error",
                  "optional": true
                },
                {
                  "name": "message",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "
Asserts that the function block does not throw an error. See\nassert.throws() for more details.
\n
When assert.doesNotThrow() is called, it will immediately call the block\nfunction.
\n
If an error is thrown and it is the same type as that specified by the error\nparameter, then an AssertionError is thrown. If the error is of a different\ntype, or if the error parameter is undefined, the error is propagated back\nto the caller.
\n
The following, for instance, will throw the TypeError because there is no\nmatching error type in the assertion:
\n
assert.doesNotThrow(\n  () => {\n    throw new TypeError('Wrong value');\n  },\n  SyntaxError\n);\n
\n
However, the following will result in an AssertionError with the message\n'Got unwanted exception (TypeError)..':
\n
assert.doesNotThrow(\n  () => {\n    throw new TypeError('Wrong value');\n  },\n  TypeError\n);\n
\n
If an AssertionError is thrown and a value is provided for the message\nparameter, the value of message will be appended to the AssertionError\nmessage:
\n
assert.doesNotThrow(\n  () => {\n    throw new TypeError('Wrong value');\n  },\n  TypeError,\n  'Whoops'\n);\n// Throws: AssertionError: Got unwanted exception (TypeError). Whoops\n
\n"
        },
        {
          "textRaw": "assert.equal(actual, expected[, message])",
          "type": "method",
          "name": "equal",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`actual` {any} ",
                  "name": "actual",
                  "type": "any"
                },
                {
                  "textRaw": "`expected` {any} ",
                  "name": "expected",
                  "type": "any"
                },
                {
                  "textRaw": "`message` {any} ",
                  "name": "message",
                  "type": "any",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "actual"
                },
                {
                  "name": "expected"
                },
                {
                  "name": "message",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "
Tests shallow, coercive equality between the actual and expected parameters\nusing the equal comparison operator ( == ).
\n
const assert = require('assert');\n\nassert.equal(1, 1);\n  // OK, 1 == 1\nassert.equal(1, '1');\n  // OK, 1 == '1'\n\nassert.equal(1, 2);\n  // AssertionError: 1 == 2\nassert.equal({a: {b: 1}}, {a: {b: 1}});\n  //AssertionError: { a: { b: 1 } } == { a: { b: 1 } }\n
\n
If the values are not equal, an AssertionError is thrown with a message\nproperty set equal to the value of the message parameter. If the message\nparameter is undefined, a default error message is assigned.
\n"
        },
        {
          "textRaw": "assert.fail(actual, expected, message, operator)",
          "type": "method",
          "name": "fail",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`actual` {any} ",
                  "name": "actual",
                  "type": "any"
                },
                {
                  "textRaw": "`expected` {any} ",
                  "name": "expected",
                  "type": "any"
                },
                {
                  "textRaw": "`message` {any} ",
                  "name": "message",
                  "type": "any"
                },
                {
                  "textRaw": "`operator` {String} ",
                  "name": "operator",
                  "type": "String"
                }
              ]
            },
            {
              "params": [
                {
                  "name": "actual"
                },
                {
                  "name": "expected"
                },
                {
                  "name": "message"
                },
                {
                  "name": "operator"
                }
              ]
            }
          ],
          "desc": "
Throws an AssertionError. If message is falsy, the error message is set as\nthe values of actual and expected separated by the provided operator.\nOtherwise, the error message is the value of message.
\n
const assert = require('assert');\n\nassert.fail(1, 2, undefined, '>');\n  // AssertionError: 1 > 2\n\nassert.fail(1, 2, 'whoops', '>');\n  // AssertionError: whoops\n
\n"
        },
        {
          "textRaw": "assert.ifError(value)",
          "type": "method",
          "name": "ifError",
          "meta": {
            "added": [
              "v0.1.97"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`value` {any} ",
                  "name": "value",
                  "type": "any"
                }
              ]
            },
            {
              "params": [
                {
                  "name": "value"
                }
              ]
            }
          ],
          "desc": "
Throws value if value is truthy. This is useful when testing the error\nargument in callbacks.
\n
const assert = require('assert');\n\nassert.ifError(0); // OK\nassert.ifError(1); // Throws 1\nassert.ifError('error') // Throws 'error'\nassert.ifError(new Error()); // Throws Error\n
\n"
        },
        {
          "textRaw": "assert.notDeepEqual(actual, expected[, message])",
          "type": "method",
          "name": "notDeepEqual",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`actual` {any} ",
                  "name": "actual",
                  "type": "any"
                },
                {
                  "textRaw": "`expected` {any} ",
                  "name": "expected",
                  "type": "any"
                },
                {
                  "textRaw": "`message` {any} ",
                  "name": "message",
                  "type": "any",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "actual"
                },
                {
                  "name": "expected"
                },
                {
                  "name": "message",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "
Tests for any deep inequality. Opposite of assert.deepEqual().
\n
const assert = require('assert');\n\nconst obj1 = {\n  a : {\n    b : 1\n  }\n};\nconst obj2 = {\n  a : {\n    b : 2\n  }\n};\nconst obj3 = {\n  a : {\n    b : 1\n  }\n};\nconst obj4 = Object.create(obj1);\n\nassert.notDeepEqual(obj1, obj1);\n  // AssertionError: { a: { b: 1 } } notDeepEqual { a: { b: 1 } }\n\nassert.notDeepEqual(obj1, obj2);\n  // OK, obj1 and obj2 are not deeply equal\n\nassert.notDeepEqual(obj1, obj3);\n  // AssertionError: { a: { b: 1 } } notDeepEqual { a: { b: 1 } }\n\nassert.notDeepEqual(obj1, obj4);\n  // OK, obj1 and obj4 are not deeply equal\n
\n
If the values are deeply equal, an AssertionError is thrown with a message\nproperty set equal to the value of the message parameter. If the message\nparameter is undefined, a default error message is assigned.
\n"
        },
        {
          "textRaw": "assert.notDeepStrictEqual(actual, expected[, message])",
          "type": "method",
          "name": "notDeepStrictEqual",
          "meta": {
            "added": [
              "v1.2.0"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`actual` {any} ",
                  "name": "actual",
                  "type": "any"
                },
                {
                  "textRaw": "`expected` {any} ",
                  "name": "expected",
                  "type": "any"
                },
                {
                  "textRaw": "`message` {any} ",
                  "name": "message",
                  "type": "any",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "actual"
                },
                {
                  "name": "expected"
                },
                {
                  "name": "message",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "
Tests for deep strict inequality. Opposite of assert.deepStrictEqual().
\n
const assert = require('assert');\n\nassert.notDeepEqual({a:1}, {a:'1'});\n  // AssertionError: { a: 1 } notDeepEqual { a: '1' }\n\nassert.notDeepStrictEqual({a:1}, {a:'1'});\n  // OK\n
\n
If the values are deeply and strictly equal, an AssertionError is thrown\nwith a message property set equal to the value of the message parameter. If\nthe message parameter is undefined, a default error message is assigned.
\n"
        },
        {
          "textRaw": "assert.notEqual(actual, expected[, message])",
          "type": "method",
          "name": "notEqual",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`actual` {any} ",
                  "name": "actual",
                  "type": "any"
                },
                {
                  "textRaw": "`expected` {any} ",
                  "name": "expected",
                  "type": "any"
                },
                {
                  "textRaw": "`message` {any} ",
                  "name": "message",
                  "type": "any",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "actual"
                },
                {
                  "name": "expected"
                },
                {
                  "name": "message",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "
Tests shallow, coercive inequality with the not equal comparison operator\n( != ).
\n
const assert = require('assert');\n\nassert.notEqual(1, 2);\n  // OK\n\nassert.notEqual(1, 1);\n  // AssertionError: 1 != 1\n\nassert.notEqual(1, '1');\n  // AssertionError: 1 != '1'\n
\n
If the values are equal, an AssertionError is thrown with a message\nproperty set equal to the value of the message parameter. If the message\nparameter is undefined, a default error message is assigned.
\n"
        },
        {
          "textRaw": "assert.notStrictEqual(actual, expected[, message])",
          "type": "method",
          "name": "notStrictEqual",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`actual` {any} ",
                  "name": "actual",
                  "type": "any"
                },
                {
                  "textRaw": "`expected` {any} ",
                  "name": "expected",
                  "type": "any"
                },
                {
                  "textRaw": "`message` {any} ",
                  "name": "message",
                  "type": "any",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "actual"
                },
                {
                  "name": "expected"
                },
                {
                  "name": "message",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "
Tests strict inequality as determined by the strict not equal operator\n( !== ).
\n
const assert = require('assert');\n\nassert.notStrictEqual(1, 2);\n  // OK\n\nassert.notStrictEqual(1, 1);\n  // AssertionError: 1 !== 1\n\nassert.notStrictEqual(1, '1');\n  // OK\n
\n
If the values are strictly equal, an AssertionError is thrown with a\nmessage property set equal to the value of the message parameter. If the\nmessage parameter is undefined, a default error message is assigned.
\n"
        },
        {
          "textRaw": "assert.ok(value[, message])",
          "type": "method",
          "name": "ok",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`value` {any} ",
                  "name": "value",
                  "type": "any"
                },
                {
                  "textRaw": "`message` {any} ",
                  "name": "message",
                  "type": "any",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "value"
                },
                {
                  "name": "message",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "
Tests if value is truthy. It is equivalent to\nassert.equal(!!value, true, message).
\n
If value is not truthy, an AssertionError is thrown with a message\nproperty set equal to the value of the message parameter. If the message\nparameter is undefined, a default error message is assigned.
\n
const assert = require('assert');\n\nassert.ok(true);  // OK\nassert.ok(1);     // OK\nassert.ok(false);\n  // throws "AssertionError: false == true"\nassert.ok(0);\n  // throws "AssertionError: 0 == true"\nassert.ok(false, 'it\\'s false');\n  // throws "AssertionError: it's false"\n
\n"
        },
        {
          "textRaw": "assert.strictEqual(actual, expected[, message])",
          "type": "method",
          "name": "strictEqual",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`actual` {any} ",
                  "name": "actual",
                  "type": "any"
                },
                {
                  "textRaw": "`expected` {any} ",
                  "name": "expected",
                  "type": "any"
                },
                {
                  "textRaw": "`message` {any} ",
                  "name": "message",
                  "type": "any",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "actual"
                },
                {
                  "name": "expected"
                },
                {
                  "name": "message",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "
Tests strict equality as determined by the strict equality operator ( === ).
\n
const assert = require('assert');\n\nassert.strictEqual(1, 2);\n  // AssertionError: 1 === 2\n\nassert.strictEqual(1, 1);\n  // OK\n\nassert.strictEqual(1, '1');\n  // AssertionError: 1 === '1'\n
\n
If the values are not strictly equal, an AssertionError is thrown with a\nmessage property set equal to the value of the message parameter. If the\nmessage parameter is undefined, a default error message is assigned.
\n"
        },
        {
          "textRaw": "assert.throws(block[, error][, message])",
          "type": "method",
          "name": "throws",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`block` {Function} ",
                  "name": "block",
                  "type": "Function"
                },
                {
                  "textRaw": "`error` {RegExp|Function} ",
                  "name": "error",
                  "type": "RegExp|Function",
                  "optional": true
                },
                {
                  "textRaw": "`message` {any} ",
                  "name": "message",
                  "type": "any",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "block"
                },
                {
                  "name": "error",
                  "optional": true
                },
                {
                  "name": "message",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "
Expects the function block to throw an error.
\n
If specified, error can be a constructor, RegExp, or validation\nfunction.
\n
If specified, message will be the message provided by the AssertionError if\nthe block fails to throw.
\n
Validate instanceof using constructor:
\n
assert.throws(\n  () => {\n    throw new Error('Wrong value');\n  },\n  Error\n);\n
\n
Validate error message using RegExp:
\n
assert.throws(\n  () => {\n    throw new Error('Wrong value');\n  },\n  /value/\n);\n
\n
Custom error validation:
\n
assert.throws(\n  () => {\n    throw new Error('Wrong value');\n  },\n  function(err) {\n    if ( (err instanceof Error) && /value/.test(err) ) {\n      return true;\n    }\n  },\n  'unexpected error'\n);\n
\n
Note that error can not be a string. If a string is provided as the second\nargument, then error is assumed to be omitted and the string will be used for\nmessage instead. This can lead to easy-to-miss mistakes:
\n
// THIS IS A MISTAKE! DO NOT DO THIS!\nassert.throws(myFunction, 'missing foo', 'did not throw with expected message');\n\n// Do this instead.\nassert.throws(myFunction, /missing foo/, 'did not throw with expected message');\n
\n\n\n"
        }
      ],
      "type": "module",
      "displayName": "Assert"
    },
    {
      "textRaw": "Buffer",
      "name": "buffer",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
Prior to the introduction of TypedArray in ECMAScript 2015 (ES6), the\nJavaScript language had no mechanism for reading or manipulating streams\nof binary data. The Buffer class was introduced as part of the Node.js\nAPI to make it possible to interact with octet streams in the context of things\nlike TCP streams and file system operations.
\n
Now that TypedArray has been added in ES6, the Buffer class implements the\nUint8Array API in a manner that is more optimized and suitable for Node.js'\nuse cases.
\n
Instances of the Buffer class are similar to arrays of integers but\ncorrespond to fixed-sized, raw memory allocations outside the V8 heap.\nThe size of the Buffer is established when it is created and cannot be\nresized.
\n
The Buffer class is a global within Node.js, making it unlikely that one\nwould need to ever use require('buffer').Buffer.
\n
const buf1 = new Buffer(10);\n  // creates a buffer of length 10\n  // This is the same as Buffer.allocUnsafe(10), and the returned\n  // Buffer instance might contain old data that needs to be\n  // overwritten using either fill() or write().\n\nconst buf2 = new Buffer([1,2,3]);\n  // creates a buffer containing [01, 02, 03]\n  // This is the same as Buffer.from([1,2,3]).\n\nconst buf3 = new Buffer('test');\n  // creates a buffer containing ASCII bytes [74, 65, 73, 74]\n  // This is the same as Buffer.from('test').\n\nconst buf4 = new Buffer('tést', 'utf8');\n  // creates a buffer containing UTF8 bytes [74, c3, a9, 73, 74]\n  // This is the same as Buffer.from('tést', 'utf8').\n\nconst buf5 = Buffer.alloc(10);\n  // Creates a zero-filled Buffer of length 10.\n\nconst buf6 = Buffer.alloc(10, 1);\n  // Creates a Buffer of length 10, filled with 0x01.\n\nconst buf7 = Buffer.allocUnsafe(10);\n  // Creates an uninitialized buffer of length 10.\n  // This is faster than calling Buffer.alloc() but the returned\n  // Buffer instance might contain old data that needs to be\n  // overwritten using either fill() or write().\n\nconst buf8 = Buffer.from([1,2,3]);\n  // Creates a Buffer containing [01, 02, 03].\n\nconst buf9 = Buffer.from('test');\n  // Creates a Buffer containing ASCII bytes [74, 65, 73, 74].\n\nconst buf8 = Buffer.from('tést', 'utf8');\n  // Creates a Buffer containing UTF8 bytes [74, c3, a9, 73, 74].\n
\n",
      "modules": [
        {
          "textRaw": "`Buffer.from()`, `Buffer.alloc()`, and `Buffer.allocUnsafe()`",
          "name": "`buffer.from()`,_`buffer.alloc()`,_and_`buffer.allocunsafe()`",
          "desc": "
Historically, Buffer instances have been created using the Buffer\nconstructor function, which allocates the returned Buffer\ndifferently based on what arguments are provided:
\n
    \n
  • Passing a number as the first argument to Buffer() (e.g. new Buffer(10)),\nallocates a new Buffer object of the specified size. The memory allocated\nfor such Buffer instances is not initialized and can contain sensitive\ndata. Such Buffer objects must be initialized manually by using either\nbuf.fill(0) or by writing to the Buffer completely. While this\nbehavior is intentional to improve performance, development experience has\ndemonstrated that a more explicit distinction is required between creating a\nfast-but-uninitialized Buffer versus creating a slower-but-safer Buffer.
    • \n
  • Passing a string, array, or Buffer as the first argument copies the\npassed object's data into the Buffer.
    • \n
  • Passing an ArrayBuffer returns a Buffer that shares allocated memory with\nthe given ArrayBuffer.
    • \n
\n
Because the behavior of new Buffer() changes significantly based on the type\nof value passed as the first argument, applications that do not properly\nvalidate the input arguments passed to new Buffer(), or that fail to\nappropriately initialize newly allocated Buffer content, can inadvertently\nintroduce security and reliability issues into their code.
\n
To make the creation of Buffer objects more reliable and less error prone,\nnew Buffer.from(), Buffer.alloc(), and Buffer.allocUnsafe() methods have\nbeen introduced as an alternative means of creating Buffer instances.
\n
Developers should migrate all existing uses of the new Buffer() constructors\nto one of these new APIs.
\n\n
Buffer instances returned by Buffer.allocUnsafe(size) may be allocated\noff a shared internal memory pool if size is less than or equal to half\nBuffer.poolSize. Instances returned by Buffer.allocUnsafeSlow(size) never\nuse the shared internal memory pool.
\n",
          "modules": [
            {
              "textRaw": "What makes `Buffer.allocUnsafe(size)` and `Buffer.allocUnsafeSlow(size)` \"unsafe\"?",
              "name": "what_makes_`buffer.allocunsafe(size)`_and_`buffer.allocunsafeslow(size)`_\"unsafe\"?",
              "desc": "
When calling Buffer.allocUnsafe() (and Buffer.allocUnsafeSlow()), the\nsegment of allocated memory is uninitialized (it is not zeroed-out). While\nthis design makes the allocation of memory quite fast, the allocated segment of\nmemory might contain old data that is potentially sensitive. Using a Buffer\ncreated by Buffer.allocUnsafe() without completely overwriting the memory\ncan allow this old data to be leaked when the Buffer memory is read.
\n
While there are clear performance advantages to using Buffer.allocUnsafe(),\nextra care must be taken in order to avoid introducing security\nvulnerabilities into an application.
\n",
              "type": "module",
              "displayName": "What makes `Buffer.allocUnsafe(size)` and `Buffer.allocUnsafeSlow(size)` \"unsafe\"?"
            }
          ],
          "type": "module",
          "displayName": "`Buffer.from()`, `Buffer.alloc()`, and `Buffer.allocUnsafe()`"
        },
        {
          "textRaw": "Buffers and Character Encodings",
          "name": "buffers_and_character_encodings",
          "desc": "
Buffers are commonly used to represent sequences of encoded characters\nsuch as UTF8, UCS2, Base64 or even Hex-encoded data. It is possible to\nconvert back and forth between Buffers and ordinary JavaScript string objects\nby using an explicit encoding method.
\n
const buf = new Buffer('hello world', 'ascii');\nconsole.log(buf.toString('hex'));\n  // prints: 68656c6c6f20776f726c64\nconsole.log(buf.toString('base64'));\n  // prints: aGVsbG8gd29ybGQ=\n
\n
The character encodings currently supported by Node.js include:
\n
    \n
  • 'ascii' - for 7-bit ASCII data only.  This encoding method is very fast and\nwill strip the high bit if set.
    \n
    • \n
  • 'utf8' - Multibyte encoded Unicode characters. Many web pages and other\ndocument formats use UTF-8.
    \n
    • \n
  • 'utf16le' - 2 or 4 bytes, little-endian encoded Unicode characters.\nSurrogate pairs (U+10000 to U+10FFFF) are supported.
    \n
    • \n
  • 'ucs2' - Alias of 'utf16le'.
    \n
    • \n
  • 'base64' - Base64 string encoding. When creating a buffer from a string,\nthis encoding will also correctly accept "URL and Filename Safe Alphabet" as\nspecified in RFC 4648, Section 5.
    \n
    • \n
  • 'binary' - A way of encoding the buffer into a one-byte (latin-1)\nencoded string. The string 'latin-1' is not supported. Instead, pass\n'binary' to use 'latin-1' encoding.
    \n
    • \n
  • 'hex' - Encode each byte as two hexadecimal characters.
    \n
    • \n
\n",
          "type": "module",
          "displayName": "Buffers and Character Encodings"
        },
        {
          "textRaw": "Buffers and TypedArray",
          "name": "buffers_and_typedarray",
          "desc": "
Buffers are also Uint8Array TypedArray instances. However, there are subtle\nincompatibilities with the TypedArray specification in ECMAScript 2015. For\ninstance, while ArrayBuffer#slice() creates a copy of the slice,\nthe implementation of Buffer#slice() creates a view over the\nexisting Buffer without copying, making Buffer#slice() far more efficient.
\n
It is also possible to create new TypedArray instances from a Buffer with the\nfollowing caveats:
\n
    \n
  1. The Buffer instances's memory is copied to the TypedArray, not shared.
    \n
    2. \n
  2. The Buffer's memory is interpreted as an array of distinct elements, and not\nas a byte array of the target type. That is,\nnew Uint32Array(new Buffer([1,2,3,4])) creates a 4-element Uint32Array\nwith elements [1,2,3,4], not a Uint32Array with a single element\n[0x1020304] or [0x4030201].
    \n
    3. \n
\n
It is possible to create a new Buffer that shares the same allocated memory as\na TypedArray instance by using the TypeArray objects .buffer property:
\n
const arr = new Uint16Array(2);\narr[0] = 5000;\narr[1] = 4000;\n\nconst buf1 = new Buffer(arr); // copies the buffer\nconst buf2 = new Buffer(arr.buffer); // shares the memory with arr;\n\nconsole.log(buf1);\n  // Prints: <Buffer 88 a0>, copied buffer has only two elements\nconsole.log(buf2);\n  // Prints: <Buffer 88 13 a0 0f>\n\narr[1] = 6000;\nconsole.log(buf1);\n  // Prints: <Buffer 88 a0>\nconsole.log(buf2);\n  // Prints: <Buffer 88 13 70 17>\n
\n
Note that when creating a Buffer using the TypeArray's .buffer, it is not\ncurrently possible to use only a portion of the underlying ArrayBuffer. To\ncreate a Buffer that uses only a part of the ArrayBuffer, use the\nbuf.slice() function after the Buffer is created:
\n
const arr = new Uint16Array(20);\nconst buf = new Buffer(arr.buffer).slice(0, 16);\nconsole.log(buf.length);\n  // Prints: 16\n
\n
The Buffer.from() and TypedArray.from() (e.g.Uint8Array.from()) have\ndifferent signatures and implementations. Specifically, the TypedArray variants\naccept a second argument that is a mapping function that is invoked on every\nelement of the typed array:
\n
    \n
  • TypedArray.from(source[, mapFn[, thisArg]])
    • \n
\n
The Buffer.from() method, however, does not support the use of a mapping\nfunction:
\n\n",
          "type": "module",
          "displayName": "Buffers and TypedArray"
        },
        {
          "textRaw": "Buffers and ES6 iteration",
          "name": "buffers_and_es6_iteration",
          "desc": "
Buffers can be iterated over using the ECMAScript 2015 (ES6) for..of syntax:
\n
const buf = new Buffer([1, 2, 3]);\n\nfor (var b of buf)\n  console.log(b)\n\n// Prints:\n//   1\n//   2\n//   3\n
\n
Additionally, the buf.values(), buf.keys(), and\nbuf.entries() methods can be used to create iterators.
\n",
          "type": "module",
          "displayName": "Buffers and ES6 iteration"
        },
        {
          "textRaw": "The `--zero-fill-buffers` command line option",
          "name": "the_`--zero-fill-buffers`_command_line_option",
          "desc": "
Node.js can be started using the --zero-fill-buffers command line option to\nforce all newly allocated Buffer and SlowBuffer instances created using\neither new Buffer(size) and new SlowBuffer(size) to be automatically\nzero-filled upon creation. Use of this flag changes the default behavior of\nthese methods and can have a significant impact on performance. Use of the\n--zero-fill-buffers option is recommended only when absolutely necessary to\nenforce that newly allocated Buffer instances cannot contain potentially\nsensitive data.
\n
$ node --zero-fill-buffers\n> Buffer(5);\n<Buffer 00 00 00 00 00>\n
",
          "type": "module",
          "displayName": "The `--zero-fill-buffers` command line option"
        }
      ],
      "classes": [
        {
          "textRaw": "Class: Buffer",
          "type": "class",
          "name": "Buffer",
          "desc": "
The Buffer class is a global type for dealing with binary data directly.\nIt can be constructed in a variety of ways.
\n",
          "classMethods": [
            {
              "textRaw": "Class Method: Buffer.alloc(size[, fill[, encoding]])",
              "type": "classMethod",
              "name": "alloc",
              "meta": {
                "added": [
                  "v4.5.0"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`size` {Number} ",
                      "name": "size",
                      "type": "Number"
                    },
                    {
                      "textRaw": "`fill` {Value} Default: `undefined` ",
                      "name": "fill",
                      "type": "Value",
                      "desc": "Default: `undefined`",
                      "optional": true
                    },
                    {
                      "textRaw": "`encoding` {String} Default: `utf8` ",
                      "name": "encoding",
                      "type": "String",
                      "desc": "Default: `utf8`",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "size"
                    },
                    {
                      "name": "fill",
                      "optional": true
                    },
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Allocates a new Buffer of size bytes. If fill is undefined, the\nBuffer will be zero-filled.
\n
const buf = Buffer.alloc(5);\nconsole.log(buf);\n  // <Buffer 00 00 00 00 00>\n
\n
The size must be less than or equal to the value of\nrequire('buffer').kMaxLength (on 64-bit architectures, kMaxLength is\n(2^31)-1). Otherwise, a RangeError is thrown. If a size less than 0\nis specified, a zero-length Buffer will be created.
\n
If fill is specified, the allocated Buffer will be initialized by calling\nbuf.fill(fill). See [buf.fill()][] for more information.
\n
const buf = Buffer.alloc(5, 'a');\nconsole.log(buf);\n  // <Buffer 61 61 61 61 61>\n
\n
If both fill and encoding are specified, the allocated Buffer will be\ninitialized by calling buf.fill(fill, encoding). For example:
\n
const buf = Buffer.alloc(11, 'aGVsbG8gd29ybGQ=', 'base64');\nconsole.log(buf);\n  // <Buffer 68 65 6c 6c 6f 20 77 6f 72 6c 64>\n
\n
Calling Buffer.alloc(size) can be significantly slower than the alternative\nBuffer.allocUnsafe(size) but ensures that the newly created Buffer instance\ncontents will never contain sensitive data.
\n
A TypeError will be thrown if size is not a number.
\n"
            },
            {
              "textRaw": "Class Method: Buffer.allocUnsafe(size)",
              "type": "classMethod",
              "name": "allocUnsafe",
              "meta": {
                "added": [
                  "v4.5.0"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`size` {Number} ",
                      "name": "size",
                      "type": "Number"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "size"
                    }
                  ]
                }
              ],
              "desc": "
Allocates a new non-zero-filled Buffer of size bytes.  The size must\nbe less than or equal to the value of require('buffer').kMaxLength (on 64-bit\narchitectures, kMaxLength is (2^31)-1). Otherwise, a RangeError is\nthrown. If a size less than 0 is specified, a zero-length Buffer will be\ncreated.
\n
The underlying memory for Buffer instances created in this way is not\ninitialized. The contents of the newly created Buffer are unknown and\nmay contain sensitive data. Use buf.fill(0) to initialize such\nBuffer instances to zeroes.
\n
const buf = Buffer.allocUnsafe(5);\nconsole.log(buf);\n  // <Buffer 78 e0 82 02 01>\n  // (octets will be different, every time)\nbuf.fill(0);\nconsole.log(buf);\n  // <Buffer 00 00 00 00 00>\n
\n
A TypeError will be thrown if size is not a number.
\n
Note that the Buffer module pre-allocates an internal Buffer instance of\nsize Buffer.poolSize that is used as a pool for the fast allocation of new\nBuffer instances created using Buffer.allocUnsafe(size) (and the\nnew Buffer(size) constructor) only when size is less than or equal to\nBuffer.poolSize >> 1 (floor of Buffer.poolSize divided by two). The default\nvalue of Buffer.poolSize is 8192 but can be modified.
\n
Use of this pre-allocated internal memory pool is a key difference between\ncalling Buffer.alloc(size, fill) vs. Buffer.allocUnsafe(size).fill(fill).\nSpecifically, Buffer.alloc(size, fill) will never use the internal Buffer\npool, while Buffer.allocUnsafe(size).fill(fill) will use the internal\nBuffer pool if size is less than or equal to half Buffer.poolSize. The\ndifference is subtle but can be important when an application requires the\nadditional performance that Buffer.allocUnsafe(size) provides.
\n"
            },
            {
              "textRaw": "Class Method: Buffer.allocUnsafeSlow(size)",
              "type": "classMethod",
              "name": "allocUnsafeSlow",
              "meta": {
                "added": [
                  "v4.5.0"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`size` {Number} ",
                      "name": "size",
                      "type": "Number"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "size"
                    }
                  ]
                }
              ],
              "desc": "
Allocates a new non-zero-filled and non-pooled Buffer of size bytes.  The\nsize must be less than or equal to the value of\nrequire('buffer').kMaxLength (on 64-bit architectures, kMaxLength is\n(2^31)-1). Otherwise, a RangeError is thrown. If a size less than 0\nis specified, a zero-length Buffer will be created.
\n
The underlying memory for Buffer instances created in this way is not\ninitialized. The contents of the newly created Buffer are unknown and\nmay contain sensitive data. Use buf.fill(0) to initialize such\nBuffer instances to zeroes.
\n
When using Buffer.allocUnsafe() to allocate new Buffer instances,\nallocations under 4KB are, by default, sliced from a single pre-allocated\nBuffer. This allows applications to avoid the garbage collection overhead of\ncreating many individually allocated Buffers. This approach improves both\nperformance and memory usage by eliminating the need to track and cleanup as\nmany Persistent objects.
\n
However, in the case where a developer may need to retain a small chunk of\nmemory from a pool for an indeterminate amount of time, it may be appropriate\nto create an un-pooled Buffer instance using Buffer.allocUnsafeSlow() then\ncopy out the relevant bits.
\n
// need to keep around a few small chunks of memory\nconst store = [];\n\nsocket.on('readable', () => {\n  const data = socket.read();\n  // allocate for retained data\n  const sb = Buffer.allocUnsafeSlow(10);\n  // copy the data into the new allocation\n  data.copy(sb, 0, 0, 10);\n  store.push(sb);\n});\n
\n
Use of Buffer.allocUnsafeSlow() should be used only as a last resort after\na developer has observed undue memory retention in their applications.
\n
A TypeError will be thrown if size is not a number.
\n"
            },
            {
              "textRaw": "Class Method: Buffer.byteLength(string[, encoding])",
              "type": "classMethod",
              "name": "byteLength",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`string` {String} ",
                      "name": "string",
                      "type": "String"
                    },
                    {
                      "textRaw": "`encoding` {String} Default: `'utf8'` ",
                      "name": "encoding",
                      "type": "String",
                      "desc": "Default: `'utf8'`",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "string"
                    },
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Returns the actual byte length of a string. This is not the same as\nString.prototype.length since that returns the number of characters in\na string.
\n
Note that for 'base64' and 'hex', this function assumes valid input. For\nstrings that contain non-Base64/Hex-encoded data (e.g. whitespace), the return\nvalue might be greater than the length of a Buffer created from the string.
\n
Example:
\n
const str = '\\u00bd + \\u00bc = \\u00be';\n\nconsole.log(`${str}: ${str.length} characters, ` +\n            `${Buffer.byteLength(str, 'utf8')} bytes`);\n\n// ½ + ¼ = ¾: 9 characters, 12 bytes\n
\n"
            },
            {
              "textRaw": "Class Method: Buffer.compare(buf1, buf2)",
              "type": "classMethod",
              "name": "compare",
              "meta": {
                "added": [
                  "v0.11.13"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`buf1` {Buffer} ",
                      "name": "buf1",
                      "type": "Buffer"
                    },
                    {
                      "textRaw": "`buf2` {Buffer} ",
                      "name": "buf2",
                      "type": "Buffer"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "buf1"
                    },
                    {
                      "name": "buf2"
                    }
                  ]
                }
              ],
              "desc": "
Compares buf1 to buf2 typically for the purpose of sorting arrays of\nBuffers. This is equivalent is calling buf1.compare(buf2).
\n
const arr = [Buffer('1234'), Buffer('0123')];\narr.sort(Buffer.compare);\n
\n"
            },
            {
              "textRaw": "Class Method: Buffer.concat(list[, totalLength])",
              "type": "classMethod",
              "name": "concat",
              "meta": {
                "added": [
                  "v0.7.11"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Buffer} ",
                    "name": "return",
                    "type": "Buffer"
                  },
                  "params": [
                    {
                      "textRaw": "`list` {Array} List of Buffer objects to concat ",
                      "name": "list",
                      "type": "Array",
                      "desc": "List of Buffer objects to concat"
                    },
                    {
                      "textRaw": "`totalLength` {Number} Total length of the Buffers in the list when concatenated ",
                      "name": "totalLength",
                      "type": "Number",
                      "desc": "Total length of the Buffers in the list when concatenated",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "list"
                    },
                    {
                      "name": "totalLength",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Returns a new Buffer which is the result of concatenating all the Buffers in\nthe list together.
\n
If the list has no items, or if the totalLength is 0, then a new zero-length\nBuffer is returned.
\n
If totalLength is not provided, it is calculated from the Buffers in the\nlist. This, however, adds an additional loop to the function, so it is faster\nto provide the length explicitly.
\n
Example: build a single Buffer from a list of three Buffers:
\n
const buf1 = new Buffer(10).fill(0);\nconst buf2 = new Buffer(14).fill(0);\nconst buf3 = new Buffer(18).fill(0);\nconst totalLength = buf1.length + buf2.length + buf3.length;\n\nconsole.log(totalLength);\nconst bufA = Buffer.concat([buf1, buf2, buf3], totalLength);\nconsole.log(bufA);\nconsole.log(bufA.length);\n\n// 42\n// <Buffer 00 00 00 00 ...>\n// 42\n
\n"
            },
            {
              "textRaw": "Class Method: Buffer.from(array)",
              "type": "classMethod",
              "name": "from",
              "meta": {
                "added": [
                  "v4.5.0"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`array` {Array} ",
                      "name": "array",
                      "type": "Array"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "array"
                    }
                  ]
                }
              ],
              "desc": "
Allocates a new Buffer using an array of octets.
\n
const buf = Buffer.from([0x62,0x75,0x66,0x66,0x65,0x72]);\n  // creates a new Buffer containing ASCII bytes\n  // ['b','u','f','f','e','r']\n
\n
A TypeError will be thrown if array is not an Array.
\n"
            },
            {
              "textRaw": "Class Method: Buffer.from(arrayBuffer)",
              "type": "classMethod",
              "name": "from",
              "meta": {
                "added": [
                  "v4.5.0"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`arrayBuffer` {ArrayBuffer} The `.buffer` property of a `TypedArray` or a `new ArrayBuffer()` ",
                      "name": "arrayBuffer",
                      "type": "ArrayBuffer",
                      "desc": "The `.buffer` property of a `TypedArray` or a `new ArrayBuffer()`"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "arrayBuffer"
                    }
                  ]
                }
              ],
              "desc": "
When passed a reference to the .buffer property of a TypedArray instance,\nthe newly created Buffer will share the same allocated memory as the\nTypedArray.
\n
const arr = new Uint16Array(2);\narr[0] = 5000;\narr[1] = 4000;\n\nconst buf = Buffer.from(arr.buffer); // shares the memory with arr;\n\nconsole.log(buf);\n  // Prints: <Buffer 88 13 a0 0f>\n\n// changing the TypedArray changes the Buffer also\narr[1] = 6000;\n\nconsole.log(buf);\n  // Prints: <Buffer 88 13 70 17>\n
\n
A TypeError will be thrown if arrayBuffer is not an ArrayBuffer.
\n"
            },
            {
              "textRaw": "Class Method: Buffer.from(buffer)",
              "type": "classMethod",
              "name": "from",
              "meta": {
                "added": [
                  "v4.5.0"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`buffer` {Buffer} ",
                      "name": "buffer",
                      "type": "Buffer"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "buffer"
                    }
                  ]
                }
              ],
              "desc": "
Copies the passed buffer data onto a new Buffer instance.
\n
const buf1 = Buffer.from('buffer');\nconst buf2 = Buffer.from(buf1);\n\nbuf1[0] = 0x61;\nconsole.log(buf1.toString());\n  // 'auffer'\nconsole.log(buf2.toString());\n  // 'buffer' (copy is not changed)\n
\n
A TypeError will be thrown if buffer is not a Buffer.
\n"
            },
            {
              "textRaw": "Class Method: Buffer.from(str[, encoding])",
              "type": "classMethod",
              "name": "from",
              "meta": {
                "added": [
                  "v4.5.0"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`str` {String} String to encode. ",
                      "name": "str",
                      "type": "String",
                      "desc": "String to encode."
                    },
                    {
                      "textRaw": "`encoding` {String} Encoding to use, Default: `'utf8'` ",
                      "name": "encoding",
                      "type": "String",
                      "desc": "Encoding to use, Default: `'utf8'`",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "str"
                    },
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Creates a new Buffer containing the given JavaScript string str. If\nprovided, the encoding parameter identifies the character encoding.\nIf not provided, encoding defaults to 'utf8'.
\n
const buf1 = Buffer.from('this is a tést');\nconsole.log(buf1.toString());\n  // prints: this is a tést\nconsole.log(buf1.toString('ascii'));\n  // prints: this is a tC)st\n\nconst buf2 = Buffer.from('7468697320697320612074c3a97374', 'hex');\nconsole.log(buf2.toString());\n  // prints: this is a tést\n
\n
A TypeError will be thrown if str is not a string.
\n"
            },
            {
              "textRaw": "Class Method: Buffer.isBuffer(obj)",
              "type": "classMethod",
              "name": "isBuffer",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Boolean} ",
                    "name": "return",
                    "type": "Boolean"
                  },
                  "params": [
                    {
                      "textRaw": "`obj` {Object} ",
                      "name": "obj",
                      "type": "Object"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "obj"
                    }
                  ]
                }
              ],
              "desc": "
Returns 'true' if obj is a Buffer.
\n"
            },
            {
              "textRaw": "Class Method: Buffer.isEncoding(encoding)",
              "type": "classMethod",
              "name": "isEncoding",
              "meta": {
                "added": [
                  "v0.9.1"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Boolean} ",
                    "name": "return",
                    "type": "Boolean"
                  },
                  "params": [
                    {
                      "textRaw": "`encoding` {String} The encoding string to test ",
                      "name": "encoding",
                      "type": "String",
                      "desc": "The encoding string to test"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "encoding"
                    }
                  ]
                }
              ],
              "desc": "
Returns true if the encoding is a valid encoding argument, or false\notherwise.
\n"
            }
          ],
          "properties": [
            {
              "textRaw": "buf[index]",
              "name": "[index]",
              "meta": {
                "type": "property",
                "name": [
                  "index"
                ]
              },
              "desc": "
The index operator [index] can be used to get and set the octet at position\nindex in the Buffer. The values refer to individual bytes, so the legal value\nrange is between 0x00 and 0xFF (hex) or 0 and 255 (decimal).
\n
Example: copy an ASCII string into a Buffer, one byte at a time:
\n
const str = "Node.js";\nconst buf = new Buffer(str.length);\n\nfor (var i = 0; i < str.length ; i++) {\n  buf[i] = str.charCodeAt(i);\n}\n\nconsole.log(buf.toString('ascii'));\n  // Prints: Node.js\n
\n"
            },
            {
              "textRaw": "`length` {Number} ",
              "type": "Number",
              "name": "length",
              "desc": "
Returns the amount of memory allocated for the Buffer in number of bytes. Note\nthat this does not necessarily reflect the amount of usable data within the\nBuffer. For instance, in the example below, a Buffer with 1234 bytes is\nallocated, but only 11 ASCII bytes are written.
\n
const buf = new Buffer(1234);\n\nconsole.log(buf.length);\n  // Prints: 1234\n\nbuf.write('some string', 0, 'ascii');\nconsole.log(buf.length);\n  // Prints: 1234\n
\n
While the length property is not immutable, changing the value of length\ncan result in undefined and inconsistent behavior. Applications that wish to\nmodify the length of a Buffer should therefore treat length as read-only and\nuse buf.slice() to create a new Buffer.
\n
var buf = new Buffer(10);\nbuf.write('abcdefghj', 0, 'ascii');\nconsole.log(buf.length);\n  // Prints: 10\nbuf = buf.slice(0,5);\nconsole.log(buf.length);\n  // Prints: 5\n
\n"
            }
          ],
          "methods": [
            {
              "textRaw": "buf.compare(otherBuffer)",
              "type": "method",
              "name": "compare",
              "meta": {
                "added": [
                  "v0.11.13"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`otherBuffer` {Buffer} ",
                      "name": "otherBuffer",
                      "type": "Buffer"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "otherBuffer"
                    }
                  ]
                }
              ],
              "desc": "
Compares two Buffer instances and returns a number indicating whether buf\ncomes before, after, or is the same as the otherBuffer in sort order.\nComparison is based on the actual sequence of bytes in each Buffer.
\n
    \n
  • 0 is returned if otherBuffer is the same as buf
    • \n
  • 1 is returned if otherBuffer should come before buf when sorted.
    • \n
  • -1 is returned if otherBuffer should come after buf when sorted.
    • \n
\n
const buf1 = new Buffer('ABC');\nconst buf2 = new Buffer('BCD');\nconst buf3 = new Buffer('ABCD');\n\nconsole.log(buf1.compare(buf1));\n  // Prints: 0\nconsole.log(buf1.compare(buf2));\n  // Prints: -1\nconsole.log(buf1.compare(buf3));\n  // Prints: -1\nconsole.log(buf2.compare(buf1));\n  // Prints: 1\nconsole.log(buf2.compare(buf3));\n  // Prints: 1\n\n[buf1, buf2, buf3].sort(Buffer.compare);\n  // produces sort order [buf1, buf3, buf2]\n
\n"
            },
            {
              "textRaw": "buf.copy(targetBuffer[, targetStart[, sourceStart[, sourceEnd]]])",
              "type": "method",
              "name": "copy",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The number of bytes copied. ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The number of bytes copied."
                  },
                  "params": [
                    {
                      "textRaw": "`targetBuffer` {Buffer} Buffer to copy into ",
                      "name": "targetBuffer",
                      "type": "Buffer",
                      "desc": "Buffer to copy into"
                    },
                    {
                      "textRaw": "`targetStart` {Number} Default: 0 ",
                      "name": "targetStart",
                      "type": "Number",
                      "desc": "Default: 0",
                      "optional": true
                    },
                    {
                      "textRaw": "`sourceStart` {Number} Default: 0 ",
                      "name": "sourceStart",
                      "type": "Number",
                      "desc": "Default: 0",
                      "optional": true
                    },
                    {
                      "textRaw": "`sourceEnd` {Number} Default: `buffer.length` ",
                      "name": "sourceEnd",
                      "type": "Number",
                      "desc": "Default: `buffer.length`",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "targetBuffer"
                    },
                    {
                      "name": "targetStart",
                      "optional": true
                    },
                    {
                      "name": "sourceStart",
                      "optional": true
                    },
                    {
                      "name": "sourceEnd",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Copies data from a region of this Buffer to a region in the target Buffer even\nif the target memory region overlaps with the source.
\n
Example: build two Buffers, then copy buf1 from byte 16 through byte 19\ninto buf2, starting at the 8th byte in buf2.
\n
const buf1 = new Buffer(26);\nconst buf2 = new Buffer(26).fill('!');\n\nfor (var i = 0 ; i < 26 ; i++) {\n  buf1[i] = i + 97; // 97 is ASCII a\n}\n\nbuf1.copy(buf2, 8, 16, 20);\nconsole.log(buf2.toString('ascii', 0, 25));\n  // Prints: !!!!!!!!qrst!!!!!!!!!!!!!\n
\n
Example: Build a single Buffer, then copy data from one region to an overlapping\nregion in the same Buffer
\n
const buf = new Buffer(26);\n\nfor (var i = 0 ; i < 26 ; i++) {\n  buf[i] = i + 97; // 97 is ASCII a\n}\n\nbuf.copy(buf, 0, 4, 10);\nconsole.log(buf.toString());\n\n// efghijghijklmnopqrstuvwxyz\n
\n"
            },
            {
              "textRaw": "buf.entries()",
              "type": "method",
              "name": "entries",
              "meta": {
                "added": [
                  "v1.1.0"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Iterator} ",
                    "name": "return",
                    "type": "Iterator"
                  },
                  "params": []
                },
                {
                  "params": []
                }
              ],
              "desc": "
Creates and returns an iterator of [index, byte] pairs from the Buffer\ncontents.
\n
const buf = new Buffer('buffer');\nfor (var pair of buf.entries()) {\n  console.log(pair);\n}\n// prints:\n//   [0, 98]\n//   [1, 117]\n//   [2, 102]\n//   [3, 102]\n//   [4, 101]\n//   [5, 114]\n
\n"
            },
            {
              "textRaw": "buf.equals(otherBuffer)",
              "type": "method",
              "name": "equals",
              "meta": {
                "added": [
                  "v1.0.0"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Boolean} ",
                    "name": "return",
                    "type": "Boolean"
                  },
                  "params": [
                    {
                      "textRaw": "`otherBuffer` {Buffer} ",
                      "name": "otherBuffer",
                      "type": "Buffer"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "otherBuffer"
                    }
                  ]
                }
              ],
              "desc": "
Returns a boolean indicating whether this and otherBuffer have exactly the\nsame bytes.
\n
const buf1 = new Buffer('ABC');\nconst buf2 = new Buffer('414243', 'hex');\nconst buf3 = new Buffer('ABCD');\n\nconsole.log(buf1.equals(buf2));\n  // Prints: true\nconsole.log(buf1.equals(buf3));\n  // Prints: false\n
\n"
            },
            {
              "textRaw": "buf.fill(value[, offset[, end]])",
              "type": "method",
              "name": "fill",
              "meta": {
                "added": [
                  "v0.5.0"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Buffer} ",
                    "name": "return",
                    "type": "Buffer"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {String|Number} ",
                      "name": "value",
                      "type": "String|Number"
                    },
                    {
                      "textRaw": "`offset` {Number} Default: 0 ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "Default: 0",
                      "optional": true
                    },
                    {
                      "textRaw": "`end` {Number} Default: `buffer.length` ",
                      "name": "end",
                      "type": "Number",
                      "desc": "Default: `buffer.length`",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset",
                      "optional": true
                    },
                    {
                      "name": "end",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Fills the Buffer with the specified value. If the offset and end are not\ngiven it will fill the entire Buffer. The method returns a reference to the\nBuffer so calls can be chained.
\n
const b = new Buffer(50).fill('h');\nconsole.log(b.toString());\n  // Prints: hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh\n
\n"
            },
            {
              "textRaw": "buf.indexOf(value[, byteOffset][, encoding])",
              "type": "method",
              "name": "indexOf",
              "meta": {
                "added": [
                  "v1.5.0"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {String|Buffer|Number} ",
                      "name": "value",
                      "type": "String|Buffer|Number"
                    },
                    {
                      "textRaw": "`byteOffset` {Number} Default: 0 ",
                      "name": "byteOffset",
                      "type": "Number",
                      "desc": "Default: 0",
                      "optional": true
                    },
                    {
                      "textRaw": "`encoding` {String} Default: `'utf8'` ",
                      "name": "encoding",
                      "type": "String",
                      "desc": "Default: `'utf8'`",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "byteOffset",
                      "optional": true
                    },
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Operates similar to Array#indexOf() in that it returns either the\nstarting index position of value in Buffer or -1 if the Buffer does not\ncontain value. The value can be a String, Buffer or Number. Strings are by\ndefault interpreted as UTF8. Buffers will use the entire Buffer (to compare a\npartial Buffer use buf.slice()). Numbers will be interpreted as unsigned 8-bit\ninteger values between 0 and 255.
\n
const buf = new Buffer('this is a buffer');\n\nbuf.indexOf('this');\n  // returns 0\nbuf.indexOf('is');\n  // returns 2\nbuf.indexOf(new Buffer('a buffer'));\n  // returns 8\nbuf.indexOf(97); // ascii for 'a'\n  // returns 8\nbuf.indexOf(new Buffer('a buffer example'));\n  // returns -1\nbuf.indexOf(new Buffer('a buffer example').slice(0,8));\n  // returns 8\n\nconst utf16Buffer = new Buffer('\\u039a\\u0391\\u03a3\\u03a3\\u0395', 'ucs2');\n\nutf16Buffer.indexOf('\\u03a3',  0, 'ucs2');\n  // returns 4\nutf16Buffer.indexOf('\\u03a3', -4, 'ucs2');\n  // returns 6\n
\n"
            },
            {
              "textRaw": "buf.keys()",
              "type": "method",
              "name": "keys",
              "meta": {
                "added": [
                  "v1.1.0"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Iterator} ",
                    "name": "return",
                    "type": "Iterator"
                  },
                  "params": []
                },
                {
                  "params": []
                }
              ],
              "desc": "
Creates and returns an iterator of Buffer keys (indices).
\n
const buf = new Buffer('buffer');\nfor (var key of buf.keys()) {\n  console.log(key);\n}\n// prints:\n//   0\n//   1\n//   2\n//   3\n//   4\n//   5\n
\n"
            },
            {
              "textRaw": "buf.readDoubleBE(offset[, noAssert])",
              "type": "method",
              "name": "readDoubleBE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 8` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 8`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Reads a 64-bit double from the Buffer at the specified offset with specified\nendian format (readDoubleBE() returns big endian, readDoubleLE() returns\nlittle endian).
\n
Setting noAssert to true skips validation of the offset. This allows the\noffset to be beyond the end of the Buffer.
\n
const buf = new Buffer([1,2,3,4,5,6,7,8]);\n\nbuf.readDoubleBE();\n  // Returns: 8.20788039913184e-304\nbuf.readDoubleLE();\n  // Returns: 5.447603722011605e-270\nbuf.readDoubleLE(1);\n  // throws RangeError: Index out of range\n\nbuf.readDoubleLE(1, true); // Warning: reads passed end of buffer!\n  // Segmentation fault! don't do this!\n
\n"
            },
            {
              "textRaw": "buf.readDoubleLE(offset[, noAssert])",
              "type": "method",
              "name": "readDoubleLE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 8` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 8`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Reads a 64-bit double from the Buffer at the specified offset with specified\nendian format (readDoubleBE() returns big endian, readDoubleLE() returns\nlittle endian).
\n
Setting noAssert to true skips validation of the offset. This allows the\noffset to be beyond the end of the Buffer.
\n
const buf = new Buffer([1,2,3,4,5,6,7,8]);\n\nbuf.readDoubleBE();\n  // Returns: 8.20788039913184e-304\nbuf.readDoubleLE();\n  // Returns: 5.447603722011605e-270\nbuf.readDoubleLE(1);\n  // throws RangeError: Index out of range\n\nbuf.readDoubleLE(1, true); // Warning: reads passed end of buffer!\n  // Segmentation fault! don't do this!\n
\n"
            },
            {
              "textRaw": "buf.readFloatBE(offset[, noAssert])",
              "type": "method",
              "name": "readFloatBE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 4` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 4`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Reads a 32-bit float from the Buffer at the specified offset with specified\nendian format (readFloatBE() returns big endian, readFloatLE() returns\nlittle endian).
\n
Setting noAssert to true skips validation of the offset. This allows the\noffset to be beyond the end of the Buffer.
\n
const buf = new Buffer([1,2,3,4]);\n\nbuf.readFloatBE();\n  // Returns: 2.387939260590663e-38\nbuf.readFloatLE();\n  // Returns: 1.539989614439558e-36\nbuf.readFloatLE(1);\n  // throws RangeError: Index out of range\n\nbuf.readFloatLE(1, true); // Warning: reads passed end of buffer!\n  // Segmentation fault! don't do this!\n
\n"
            },
            {
              "textRaw": "buf.readFloatLE(offset[, noAssert])",
              "type": "method",
              "name": "readFloatLE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 4` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 4`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Reads a 32-bit float from the Buffer at the specified offset with specified\nendian format (readFloatBE() returns big endian, readFloatLE() returns\nlittle endian).
\n
Setting noAssert to true skips validation of the offset. This allows the\noffset to be beyond the end of the Buffer.
\n
const buf = new Buffer([1,2,3,4]);\n\nbuf.readFloatBE();\n  // Returns: 2.387939260590663e-38\nbuf.readFloatLE();\n  // Returns: 1.539989614439558e-36\nbuf.readFloatLE(1);\n  // throws RangeError: Index out of range\n\nbuf.readFloatLE(1, true); // Warning: reads passed end of buffer!\n  // Segmentation fault! don't do this!\n
\n"
            },
            {
              "textRaw": "buf.readInt8(offset[, noAssert])",
              "type": "method",
              "name": "readInt8",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 1` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 1`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Reads a signed 8-bit integer from the Buffer at the specified offset.
\n
Setting noAssert to true skips validation of the offset. This allows the\noffset to be beyond the end of the Buffer.
\n
Integers read from the Buffer are interpreted as two's complement signed values.
\n
const buf = new Buffer([1,-2,3,4]);\n\nbuf.readInt8(0);\n  // returns 1\nbuf.readInt8(1);\n  // returns -2\n
\n"
            },
            {
              "textRaw": "buf.readInt16BE(offset[, noAssert])",
              "type": "method",
              "name": "readInt16BE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 2` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 2`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Reads a signed 16-bit integer from the Buffer at the specified offset with\nthe specified endian format (readInt16BE() returns big endian,\nreadInt16LE() returns little endian).
\n
Setting noAssert to true skips validation of the offset. This allows the\noffset to be beyond the end of the Buffer.
\n
Integers read from the Buffer are interpreted as two's complement signed values.
\n
const buf = new Buffer([1,-2,3,4]);\n\nbuf.readInt16BE();\n  // returns 510\nbuf.readInt16LE(1);\n  // returns 1022\n
\n"
            },
            {
              "textRaw": "buf.readInt16LE(offset[, noAssert])",
              "type": "method",
              "name": "readInt16LE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 2` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 2`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Reads a signed 16-bit integer from the Buffer at the specified offset with\nthe specified endian format (readInt16BE() returns big endian,\nreadInt16LE() returns little endian).
\n
Setting noAssert to true skips validation of the offset. This allows the\noffset to be beyond the end of the Buffer.
\n
Integers read from the Buffer are interpreted as two's complement signed values.
\n
const buf = new Buffer([1,-2,3,4]);\n\nbuf.readInt16BE();\n  // returns 510\nbuf.readInt16LE(1);\n  // returns 1022\n
\n"
            },
            {
              "textRaw": "buf.readInt32BE(offset[, noAssert])",
              "type": "method",
              "name": "readInt32BE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 4` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 4`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Reads a signed 32-bit integer from the Buffer at the specified offset with\nthe specified endian format (readInt32BE() returns big endian,\nreadInt32LE() returns little endian).
\n
Setting noAssert to true skips validation of the offset. This allows the\noffset to be beyond the end of the Buffer.
\n
Integers read from the Buffer are interpreted as two's complement signed values.
\n
const buf = new Buffer([1,-2,3,4]);\n\nbuf.readInt32BE();\n  // returns 33424132\nbuf.readInt32LE();\n  // returns 67370497\nbuf.readInt32LE(1);\n  // throws RangeError: Index out of range\n
\n"
            },
            {
              "textRaw": "buf.readInt32LE(offset[, noAssert])",
              "type": "method",
              "name": "readInt32LE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 4` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 4`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Reads a signed 32-bit integer from the Buffer at the specified offset with\nthe specified endian format (readInt32BE() returns big endian,\nreadInt32LE() returns little endian).
\n
Setting noAssert to true skips validation of the offset. This allows the\noffset to be beyond the end of the Buffer.
\n
Integers read from the Buffer are interpreted as two's complement signed values.
\n
const buf = new Buffer([1,-2,3,4]);\n\nbuf.readInt32BE();\n  // returns 33424132\nbuf.readInt32LE();\n  // returns 67370497\nbuf.readInt32LE(1);\n  // throws RangeError: Index out of range\n
\n"
            },
            {
              "textRaw": "buf.readIntBE(offset, byteLength[, noAssert])",
              "type": "method",
              "name": "readIntBE",
              "meta": {
                "added": [
                  "v1.0.0"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - byteLength` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - byteLength`"
                    },
                    {
                      "textRaw": "`byteLength` {Number} `0 < byteLength <= 6` ",
                      "name": "byteLength",
                      "type": "Number",
                      "desc": "`0 < byteLength <= 6`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "byteLength"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "byteLength"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Reads byteLength number of bytes from the Buffer at the specified offset\nand interprets the result as a two's complement signed value. Supports up to 48\nbits of accuracy. For example:
\n
const buf = new Buffer(6);\nbuf.writeUInt16LE(0x90ab, 0);\nbuf.writeUInt32LE(0x12345678, 2);\nbuf.readIntLE(0, 6).toString(16);  // Specify 6 bytes (48 bits)\n// Returns: '1234567890ab'\n\nbuf.readIntBE(0, 6).toString(16);\n// Returns: -546f87a9cbee\n
\n
Setting noAssert to true skips validation of the offset. This allows the\noffset to be beyond the end of the Buffer.
\n"
            },
            {
              "textRaw": "buf.readIntLE(offset, byteLength[, noAssert])",
              "type": "method",
              "name": "readIntLE",
              "meta": {
                "added": [
                  "v1.0.0"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - byteLength` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - byteLength`"
                    },
                    {
                      "textRaw": "`byteLength` {Number} `0 < byteLength <= 6` ",
                      "name": "byteLength",
                      "type": "Number",
                      "desc": "`0 < byteLength <= 6`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "byteLength"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Reads byteLength number of bytes from the Buffer at the specified offset\nand interprets the result as a two's complement signed value. Supports up to 48\nbits of accuracy. For example:
\n
const buf = new Buffer(6);\nbuf.writeUInt16LE(0x90ab, 0);\nbuf.writeUInt32LE(0x12345678, 2);\nbuf.readIntLE(0, 6).toString(16);  // Specify 6 bytes (48 bits)\n// Returns: '1234567890ab'\n\nbuf.readIntBE(0, 6).toString(16);\n// Returns: -546f87a9cbee\n
\n
Setting noAssert to true skips validation of the offset. This allows the\noffset to be beyond the end of the Buffer.
\n"
            },
            {
              "textRaw": "buf.readUInt8(offset[, noAssert])",
              "type": "method",
              "name": "readUInt8",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 1` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 1`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Reads an unsigned 8-bit integer from the Buffer at the specified offset.
\n
Setting noAssert to true skips validation of the offset. This allows the\noffset to be beyond the end of the Buffer.
\n
const buf = new Buffer([1,-2,3,4]);\n\nbuf.readUInt8(0);\n  // returns 1\nbuf.readUInt8(1);\n  // returns 254\n
\n"
            },
            {
              "textRaw": "buf.readUInt16BE(offset[, noAssert])",
              "type": "method",
              "name": "readUInt16BE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 2` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 2`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Reads an unsigned 16-bit integer from the Buffer at the specified offset with\nspecified endian format (readUInt16BE() returns big endian,\nreadUInt16LE() returns little endian).
\n
Setting noAssert to true skips validation of the offset. This allows the\noffset to be beyond the end of the Buffer.
\n
Example:
\n
const buf = new Buffer([0x3, 0x4, 0x23, 0x42]);\n\nbuf.readUInt16BE(0);\n  // Returns: 0x0304\nbuf.readUInt16LE(0);\n  // Returns: 0x0403\nbuf.readUInt16BE(1);\n  // Returns: 0x0423\nbuf.readUInt16LE(1);\n  // Returns: 0x2304\nbuf.readUInt16BE(2);\n  // Returns: 0x2342\nbuf.readUInt16LE(2);\n  // Returns: 0x4223\n
\n"
            },
            {
              "textRaw": "buf.readUInt16LE(offset[, noAssert])",
              "type": "method",
              "name": "readUInt16LE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 2` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 2`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Reads an unsigned 16-bit integer from the Buffer at the specified offset with\nspecified endian format (readUInt16BE() returns big endian,\nreadUInt16LE() returns little endian).
\n
Setting noAssert to true skips validation of the offset. This allows the\noffset to be beyond the end of the Buffer.
\n
Example:
\n
const buf = new Buffer([0x3, 0x4, 0x23, 0x42]);\n\nbuf.readUInt16BE(0);\n  // Returns: 0x0304\nbuf.readUInt16LE(0);\n  // Returns: 0x0403\nbuf.readUInt16BE(1);\n  // Returns: 0x0423\nbuf.readUInt16LE(1);\n  // Returns: 0x2304\nbuf.readUInt16BE(2);\n  // Returns: 0x2342\nbuf.readUInt16LE(2);\n  // Returns: 0x4223\n
\n"
            },
            {
              "textRaw": "buf.readUInt32BE(offset[, noAssert])",
              "type": "method",
              "name": "readUInt32BE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 4` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 4`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Reads an unsigned 32-bit integer from the Buffer at the specified offset with\nspecified endian format (readUInt32BE() returns big endian,\nreadUInt32LE() returns little endian).
\n
Setting noAssert to true skips validation of the offset. This allows the\noffset to be beyond the end of the Buffer.
\n
Example:
\n
const buf = new Buffer([0x3, 0x4, 0x23, 0x42]);\n\nbuf.readUInt32BE(0);\n  // Returns: 0x03042342\nconsole.log(buf.readUInt32LE(0));\n  // Returns: 0x42230403\n
\n"
            },
            {
              "textRaw": "buf.readUInt32LE(offset[, noAssert])",
              "type": "method",
              "name": "readUInt32LE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 4` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 4`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Reads an unsigned 32-bit integer from the Buffer at the specified offset with\nspecified endian format (readUInt32BE() returns big endian,\nreadUInt32LE() returns little endian).
\n
Setting noAssert to true skips validation of the offset. This allows the\noffset to be beyond the end of the Buffer.
\n
Example:
\n
const buf = new Buffer([0x3, 0x4, 0x23, 0x42]);\n\nbuf.readUInt32BE(0);\n  // Returns: 0x03042342\nconsole.log(buf.readUInt32LE(0));\n  // Returns: 0x42230403\n
\n"
            },
            {
              "textRaw": "buf.readUIntBE(offset, byteLength[, noAssert])",
              "type": "method",
              "name": "readUIntBE",
              "meta": {
                "added": [
                  "v1.0.0"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - byteLength` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - byteLength`"
                    },
                    {
                      "textRaw": "`byteLength` {Number} `0 < byteLength <= 6` ",
                      "name": "byteLength",
                      "type": "Number",
                      "desc": "`0 < byteLength <= 6`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "byteLength"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "byteLength"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Reads byteLength number of bytes from the Buffer at the specified offset\nand interprets the result as an unsigned integer. Supports up to 48\nbits of accuracy. For example:
\n
const buf = new Buffer(6);\nbuf.writeUInt16LE(0x90ab, 0);\nbuf.writeUInt32LE(0x12345678, 2);\nbuf.readUIntLE(0, 6).toString(16);  // Specify 6 bytes (48 bits)\n// Returns: '1234567890ab'\n\nbuf.readUIntBE(0, 6).toString(16);\n// Returns: ab9078563412\n
\n
Setting noAssert to true skips validation of the offset. This allows the\noffset to be beyond the end of the Buffer.
\n"
            },
            {
              "textRaw": "buf.readUIntLE(offset, byteLength[, noAssert])",
              "type": "method",
              "name": "readUIntLE",
              "meta": {
                "added": [
                  "v1.0.0"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - byteLength` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - byteLength`"
                    },
                    {
                      "textRaw": "`byteLength` {Number} `0 < byteLength <= 6` ",
                      "name": "byteLength",
                      "type": "Number",
                      "desc": "`0 < byteLength <= 6`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "byteLength"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Reads byteLength number of bytes from the Buffer at the specified offset\nand interprets the result as an unsigned integer. Supports up to 48\nbits of accuracy. For example:
\n
const buf = new Buffer(6);\nbuf.writeUInt16LE(0x90ab, 0);\nbuf.writeUInt32LE(0x12345678, 2);\nbuf.readUIntLE(0, 6).toString(16);  // Specify 6 bytes (48 bits)\n// Returns: '1234567890ab'\n\nbuf.readUIntBE(0, 6).toString(16);\n// Returns: ab9078563412\n
\n
Setting noAssert to true skips validation of the offset. This allows the\noffset to be beyond the end of the Buffer.
\n"
            },
            {
              "textRaw": "buf.slice([start[, end]])",
              "type": "method",
              "name": "slice",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Buffer} ",
                    "name": "return",
                    "type": "Buffer"
                  },
                  "params": [
                    {
                      "textRaw": "`start` {Number} Default: 0 ",
                      "name": "start",
                      "type": "Number",
                      "desc": "Default: 0",
                      "optional": true
                    },
                    {
                      "textRaw": "`end` {Number} Default: `buffer.length` ",
                      "name": "end",
                      "type": "Number",
                      "desc": "Default: `buffer.length`",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "start",
                      "optional": true
                    },
                    {
                      "name": "end",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Returns a new Buffer that references the same memory as the original, but\noffset and cropped by the start and end indices.
\n
Note that modifying the new Buffer slice will modify the memory in the\noriginal Buffer because the allocated memory of the two objects overlap.
\n
Example: build a Buffer with the ASCII alphabet, take a slice, then modify one\nbyte from the original Buffer.
\n
const buf1 = new Buffer(26);\n\nfor (var i = 0 ; i < 26 ; i++) {\n  buf1[i] = i + 97; // 97 is ASCII a\n}\n\nconst buf2 = buf1.slice(0, 3);\nbuf2.toString('ascii', 0, buf2.length);\n  // Returns: 'abc'\nbuf1[0] = 33;\nbuf2.toString('ascii', 0, buf2.length);\n  // Returns : '!bc'\n
\n
Specifying negative indexes causes the slice to be generated relative to the\nend of the Buffer rather than the beginning.
\n
const buf = new Buffer('buffer');\n\nbuf.slice(-6, -1).toString();\n  // Returns 'buffe', equivalent to buf.slice(0, 5)\nbuf.slice(-6, -2).toString();\n  // Returns 'buff', equivalent to buf.slice(0, 4)\nbuf.slice(-5, -2).toString();\n  // Returns 'uff', equivalent to buf.slice(1, 4)\n
\n"
            },
            {
              "textRaw": "buf.toString([encoding[, start[, end]]])",
              "type": "method",
              "name": "toString",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {String} ",
                    "name": "return",
                    "type": "String"
                  },
                  "params": [
                    {
                      "textRaw": "`encoding` {String} Default: `'utf8'` ",
                      "name": "encoding",
                      "type": "String",
                      "desc": "Default: `'utf8'`",
                      "optional": true
                    },
                    {
                      "textRaw": "`start` {Number} Default: 0 ",
                      "name": "start",
                      "type": "Number",
                      "desc": "Default: 0",
                      "optional": true
                    },
                    {
                      "textRaw": "`end` {Number} Default: `buffer.length` ",
                      "name": "end",
                      "type": "Number",
                      "desc": "Default: `buffer.length`",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "encoding",
                      "optional": true
                    },
                    {
                      "name": "start",
                      "optional": true
                    },
                    {
                      "name": "end",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Decodes and returns a string from the Buffer data using the specified\ncharacter set encoding.
\n
const buf = new Buffer(26);\nfor (var i = 0 ; i < 26 ; i++) {\n  buf[i] = i + 97; // 97 is ASCII a\n}\nbuf.toString('ascii');\n  // Returns: 'abcdefghijklmnopqrstuvwxyz'\nbuf.toString('ascii',0,5);\n  // Returns: 'abcde'\nbuf.toString('utf8',0,5);\n  // Returns: 'abcde'\nbuf.toString(undefined,0,5);\n  // Returns: 'abcde', encoding defaults to 'utf8'\n
\n"
            },
            {
              "textRaw": "buf.toJSON()",
              "type": "method",
              "name": "toJSON",
              "meta": {
                "added": [
                  "v0.9.2"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Object} ",
                    "name": "return",
                    "type": "Object"
                  },
                  "params": []
                },
                {
                  "params": []
                }
              ],
              "desc": "
Returns a JSON representation of the Buffer instance.  JSON.stringify()\nimplicitly calls this function when stringifying a Buffer instance.
\n
Example:
\n
const buf = new Buffer('test');\nconst json = JSON.stringify(buf);\n\nconsole.log(json);\n// Prints: '{"type":"Buffer","data":[116,101,115,116]}'\n\nconst copy = JSON.parse(json, (key, value) => {\n    return value && value.type === 'Buffer'\n      ? new Buffer(value.data)\n      : value;\n  });\n\nconsole.log(copy.toString());\n// Prints: 'test'\n
\n"
            },
            {
              "textRaw": "buf.values()",
              "type": "method",
              "name": "values",
              "meta": {
                "added": [
                  "v1.1.0"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Iterator} ",
                    "name": "return",
                    "type": "Iterator"
                  },
                  "params": []
                },
                {
                  "params": []
                }
              ],
              "desc": "
Creates and returns an iterator for Buffer values (bytes). This function is\ncalled automatically when the Buffer is used in a for..of statement.
\n
const buf = new Buffer('buffer');\nfor (var value of buf.values()) {\n  console.log(value);\n}\n// prints:\n//   98\n//   117\n//   102\n//   102\n//   101\n//   114\n\nfor (var value of buf) {\n  console.log(value);\n}\n// prints:\n//   98\n//   117\n//   102\n//   102\n//   101\n//   114\n
\n"
            },
            {
              "textRaw": "buf.write(string[, offset[, length]][, encoding])",
              "type": "method",
              "name": "write",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} Numbers of bytes written ",
                    "name": "return",
                    "type": "Number",
                    "desc": "Numbers of bytes written"
                  },
                  "params": [
                    {
                      "textRaw": "`string` {String} Bytes to be written to buffer ",
                      "name": "string",
                      "type": "String",
                      "desc": "Bytes to be written to buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} Default: 0 ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "Default: 0",
                      "optional": true
                    },
                    {
                      "textRaw": "`length` {Number} Default: `buffer.length - offset` ",
                      "name": "length",
                      "type": "Number",
                      "desc": "Default: `buffer.length - offset`",
                      "optional": true
                    },
                    {
                      "textRaw": "`encoding` {String} Default: `'utf8'` ",
                      "name": "encoding",
                      "type": "String",
                      "desc": "Default: `'utf8'`",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "string"
                    },
                    {
                      "name": "offset",
                      "optional": true
                    },
                    {
                      "name": "length",
                      "optional": true
                    },
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes string to the Buffer at offset using the given encoding.\nThe length parameter is the number of bytes to write. If the Buffer did not\ncontain enough space to fit the entire string, only a partial amount of the\nstring will be written however, it will not write only partially encoded\ncharacters.
\n
const buf = new Buffer(256);\nconst len = buf.write('\\u00bd + \\u00bc = \\u00be', 0);\nconsole.log(`${len} bytes: ${buf.toString('utf8', 0, len)}`);\n  // Prints: 12 bytes: ½ + ¼ = ¾\n
\n"
            },
            {
              "textRaw": "buf.writeDoubleBE(value, offset[, noAssert])",
              "type": "method",
              "name": "writeDoubleBE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The offset plus the number of written bytes ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The offset plus the number of written bytes"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {Number} Bytes to be written to Buffer ",
                      "name": "value",
                      "type": "Number",
                      "desc": "Bytes to be written to Buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 8` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 8`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes value to the Buffer at the specified offset with specified endian\nformat (writeDoubleBE() writes big endian, writeDoubleLE() writes little\nendian). The value argument should be a valid 64-bit double. Behavior is\nnot defined when value is anything other than a 64-bit double.
\n
Set noAssert to true to skip validation of value and offset. This means\nthat value may be too large for the specific function and offset may be\nbeyond the end of the Buffer leading to the values being silently dropped. This\nshould not be used unless you are certain of correctness.
\n
Example:
\n
const buf = new Buffer(8);\nbuf.writeDoubleBE(0xdeadbeefcafebabe, 0);\n\nconsole.log(buf);\n  // Prints: <Buffer 43 eb d5 b7 dd f9 5f d7>\n\nbuf.writeDoubleLE(0xdeadbeefcafebabe, 0);\n\nconsole.log(buf);\n  // Prints: <Buffer d7 5f f9 dd b7 d5 eb 43>\n
\n"
            },
            {
              "textRaw": "buf.writeDoubleLE(value, offset[, noAssert])",
              "type": "method",
              "name": "writeDoubleLE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The offset plus the number of written bytes ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The offset plus the number of written bytes"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {Number} Bytes to be written to Buffer ",
                      "name": "value",
                      "type": "Number",
                      "desc": "Bytes to be written to Buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 8` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 8`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes value to the Buffer at the specified offset with specified endian\nformat (writeDoubleBE() writes big endian, writeDoubleLE() writes little\nendian). The value argument should be a valid 64-bit double. Behavior is\nnot defined when value is anything other than a 64-bit double.
\n
Set noAssert to true to skip validation of value and offset. This means\nthat value may be too large for the specific function and offset may be\nbeyond the end of the Buffer leading to the values being silently dropped. This\nshould not be used unless you are certain of correctness.
\n
Example:
\n
const buf = new Buffer(8);\nbuf.writeDoubleBE(0xdeadbeefcafebabe, 0);\n\nconsole.log(buf);\n  // Prints: <Buffer 43 eb d5 b7 dd f9 5f d7>\n\nbuf.writeDoubleLE(0xdeadbeefcafebabe, 0);\n\nconsole.log(buf);\n  // Prints: <Buffer d7 5f f9 dd b7 d5 eb 43>\n
\n"
            },
            {
              "textRaw": "buf.writeFloatBE(value, offset[, noAssert])",
              "type": "method",
              "name": "writeFloatBE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The offset plus the number of written bytes ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The offset plus the number of written bytes"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {Number} Bytes to be written to Buffer ",
                      "name": "value",
                      "type": "Number",
                      "desc": "Bytes to be written to Buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 4` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 4`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes value to the Buffer at the specified offset with specified endian\nformat (writeFloatBE() writes big endian, writeFloatLE() writes little\nendian). Behavior is not defined when value is anything other than a 32-bit\nfloat.
\n
Set noAssert to true to skip validation of value and offset. This means\nthat value may be too large for the specific function and offset may be\nbeyond the end of the Buffer leading to the values being silently dropped. This\nshould not be used unless you are certain of correctness.
\n
Example:
\n
const buf = new Buffer(4);\nbuf.writeFloatBE(0xcafebabe, 0);\n\nconsole.log(buf);\n  // Prints: <Buffer 4f 4a fe bb>\n\nbuf.writeFloatLE(0xcafebabe, 0);\n\nconsole.log(buf);\n  // Prints: <Buffer bb fe 4a 4f>\n
\n"
            },
            {
              "textRaw": "buf.writeFloatLE(value, offset[, noAssert])",
              "type": "method",
              "name": "writeFloatLE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The offset plus the number of written bytes ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The offset plus the number of written bytes"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {Number} Bytes to be written to Buffer ",
                      "name": "value",
                      "type": "Number",
                      "desc": "Bytes to be written to Buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 4` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 4`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes value to the Buffer at the specified offset with specified endian\nformat (writeFloatBE() writes big endian, writeFloatLE() writes little\nendian). Behavior is not defined when value is anything other than a 32-bit\nfloat.
\n
Set noAssert to true to skip validation of value and offset. This means\nthat value may be too large for the specific function and offset may be\nbeyond the end of the Buffer leading to the values being silently dropped. This\nshould not be used unless you are certain of correctness.
\n
Example:
\n
const buf = new Buffer(4);\nbuf.writeFloatBE(0xcafebabe, 0);\n\nconsole.log(buf);\n  // Prints: <Buffer 4f 4a fe bb>\n\nbuf.writeFloatLE(0xcafebabe, 0);\n\nconsole.log(buf);\n  // Prints: <Buffer bb fe 4a 4f>\n
\n"
            },
            {
              "textRaw": "buf.writeInt8(value, offset[, noAssert])",
              "type": "method",
              "name": "writeInt8",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The offset plus the number of written bytes ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The offset plus the number of written bytes"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {Number} Bytes to be written to Buffer ",
                      "name": "value",
                      "type": "Number",
                      "desc": "Bytes to be written to Buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 1` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 1`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes value to the Buffer at the specified offset. The value should be a\nvalid signed 8-bit integer.  Behavior is not defined when value is anything\nother than a signed 8-bit integer.
\n
Set noAssert to true to skip validation of value and offset. This means\nthat value may be too large for the specific function and offset may be\nbeyond the end of the Buffer leading to the values being silently dropped. This\nshould not be used unless you are certain of correctness.
\n
The value is interpreted and written as a two's complement signed integer.
\n
const buf = new Buffer(2);\nbuf.writeInt8(2, 0);\nbuf.writeInt8(-2, 1);\nconsole.log(buf);\n  // Prints: <Buffer 02 fe>\n
\n"
            },
            {
              "textRaw": "buf.writeInt16BE(value, offset[, noAssert])",
              "type": "method",
              "name": "writeInt16BE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The offset plus the number of written bytes ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The offset plus the number of written bytes"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {Number} Bytes to be written to Buffer ",
                      "name": "value",
                      "type": "Number",
                      "desc": "Bytes to be written to Buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 2` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 2`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes value to the Buffer at the specified offset with specified endian\nformat (writeInt16BE() writes big endian, writeInt16LE() writes little\nendian). The value should be a valid signed 16-bit integer. Behavior is\nnot defined when value is anything other than a signed 16-bit integer.
\n
Set noAssert to true to skip validation of value and offset. This means\nthat value may be too large for the specific function and offset may be\nbeyond the end of the Buffer leading to the values being silently dropped. This\nshould not be used unless you are certain of correctness.
\n
The value is interpreted and written as a two's complement signed integer.
\n
const buf = new Buffer(4);\nbuf.writeInt16BE(0x0102,0);\nbuf.writeInt16LE(0x0304,2);\nconsole.log(buf);\n  // Prints: <Buffer 01 02 04 03>\n
\n"
            },
            {
              "textRaw": "buf.writeInt16LE(value, offset[, noAssert])",
              "type": "method",
              "name": "writeInt16LE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The offset plus the number of written bytes ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The offset plus the number of written bytes"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {Number} Bytes to be written to Buffer ",
                      "name": "value",
                      "type": "Number",
                      "desc": "Bytes to be written to Buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 2` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 2`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes value to the Buffer at the specified offset with specified endian\nformat (writeInt16BE() writes big endian, writeInt16LE() writes little\nendian). The value should be a valid signed 16-bit integer. Behavior is\nnot defined when value is anything other than a signed 16-bit integer.
\n
Set noAssert to true to skip validation of value and offset. This means\nthat value may be too large for the specific function and offset may be\nbeyond the end of the Buffer leading to the values being silently dropped. This\nshould not be used unless you are certain of correctness.
\n
The value is interpreted and written as a two's complement signed integer.
\n
const buf = new Buffer(4);\nbuf.writeInt16BE(0x0102,0);\nbuf.writeInt16LE(0x0304,2);\nconsole.log(buf);\n  // Prints: <Buffer 01 02 04 03>\n
\n"
            },
            {
              "textRaw": "buf.writeInt32BE(value, offset[, noAssert])",
              "type": "method",
              "name": "writeInt32BE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The offset plus the number of written bytes ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The offset plus the number of written bytes"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {Number} Bytes to be written to Buffer ",
                      "name": "value",
                      "type": "Number",
                      "desc": "Bytes to be written to Buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 4` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 4`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes value to the Buffer at the specified offset with specified endian\nformat (writeInt32BE() writes big endian, writeInt32LE() writes little\nendian). The value should be a valid signed 32-bit integer. Behavior is\nnot defined when value is anything other than a signed 32-bit integer.
\n
Set noAssert to true to skip validation of value and offset. This means\nthat value may be too large for the specific function and offset may be\nbeyond the end of the Buffer leading to the values being silently dropped. This\nshould not be used unless you are certain of correctness.
\n
The value is interpreted and written as a two's complement signed integer.
\n
const buf = new Buffer(8);\nbuf.writeInt32BE(0x01020304,0);\nbuf.writeInt32LE(0x05060708,4);\nconsole.log(buf);\n  // Prints: <Buffer 01 02 03 04 08 07 06 05>\n
\n"
            },
            {
              "textRaw": "buf.writeInt32LE(value, offset[, noAssert])",
              "type": "method",
              "name": "writeInt32LE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The offset plus the number of written bytes ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The offset plus the number of written bytes"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {Number} Bytes to be written to Buffer ",
                      "name": "value",
                      "type": "Number",
                      "desc": "Bytes to be written to Buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 4` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 4`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes value to the Buffer at the specified offset with specified endian\nformat (writeInt32BE() writes big endian, writeInt32LE() writes little\nendian). The value should be a valid signed 32-bit integer. Behavior is\nnot defined when value is anything other than a signed 32-bit integer.
\n
Set noAssert to true to skip validation of value and offset. This means\nthat value may be too large for the specific function and offset may be\nbeyond the end of the Buffer leading to the values being silently dropped. This\nshould not be used unless you are certain of correctness.
\n
The value is interpreted and written as a two's complement signed integer.
\n
const buf = new Buffer(8);\nbuf.writeInt32BE(0x01020304,0);\nbuf.writeInt32LE(0x05060708,4);\nconsole.log(buf);\n  // Prints: <Buffer 01 02 03 04 08 07 06 05>\n
\n"
            },
            {
              "textRaw": "buf.writeIntBE(value, offset, byteLength[, noAssert])",
              "type": "method",
              "name": "writeIntBE",
              "meta": {
                "added": [
                  "v1.0.0"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The offset plus the number of written bytes ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The offset plus the number of written bytes"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {Number} Bytes to be written to Buffer ",
                      "name": "value",
                      "type": "Number",
                      "desc": "Bytes to be written to Buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - byteLength` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - byteLength`"
                    },
                    {
                      "textRaw": "`byteLength` {Number} `0 < byteLength <= 6` ",
                      "name": "byteLength",
                      "type": "Number",
                      "desc": "`0 < byteLength <= 6`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "byteLength"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "byteLength"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes value to the Buffer at the specified offset and byteLength.\nSupports up to 48 bits of accuracy. For example:
\n
const buf1 = new Buffer(6);\nbuf1.writeUIntBE(0x1234567890ab, 0, 6);\nconsole.log(buf1);\n  // Prints: <Buffer 12 34 56 78 90 ab>\n\nconst buf2 = new Buffer(6);\nbuf2.writeUIntLE(0x1234567890ab, 0, 6);\nconsole.log(buf2);\n  // Prints: <Buffer ab 90 78 56 34 12>\n
\n
Set noAssert to true to skip validation of value and offset. This means\nthat value may be too large for the specific function and offset may be\nbeyond the end of the Buffer leading to the values being silently dropped. This\nshould not be used unless you are certain of correctness.
\n
Behavior is not defined when value is anything other than an integer.
\n"
            },
            {
              "textRaw": "buf.writeIntLE(value, offset, byteLength[, noAssert])",
              "type": "method",
              "name": "writeIntLE",
              "meta": {
                "added": [
                  "v1.0.0"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The offset plus the number of written bytes ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The offset plus the number of written bytes"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {Number} Bytes to be written to Buffer ",
                      "name": "value",
                      "type": "Number",
                      "desc": "Bytes to be written to Buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - byteLength` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - byteLength`"
                    },
                    {
                      "textRaw": "`byteLength` {Number} `0 < byteLength <= 6` ",
                      "name": "byteLength",
                      "type": "Number",
                      "desc": "`0 < byteLength <= 6`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "byteLength"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes value to the Buffer at the specified offset and byteLength.\nSupports up to 48 bits of accuracy. For example:
\n
const buf1 = new Buffer(6);\nbuf1.writeUIntBE(0x1234567890ab, 0, 6);\nconsole.log(buf1);\n  // Prints: <Buffer 12 34 56 78 90 ab>\n\nconst buf2 = new Buffer(6);\nbuf2.writeUIntLE(0x1234567890ab, 0, 6);\nconsole.log(buf2);\n  // Prints: <Buffer ab 90 78 56 34 12>\n
\n
Set noAssert to true to skip validation of value and offset. This means\nthat value may be too large for the specific function and offset may be\nbeyond the end of the Buffer leading to the values being silently dropped. This\nshould not be used unless you are certain of correctness.
\n
Behavior is not defined when value is anything other than an integer.
\n"
            },
            {
              "textRaw": "buf.writeUInt8(value, offset[, noAssert])",
              "type": "method",
              "name": "writeUInt8",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The offset plus the number of written bytes ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The offset plus the number of written bytes"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {Number} Bytes to be written to Buffer ",
                      "name": "value",
                      "type": "Number",
                      "desc": "Bytes to be written to Buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 1` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 1`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes value to the Buffer at the specified offset. The value should be a\nvalid unsigned 8-bit integer.  Behavior is not defined when value is anything\nother than an unsigned 8-bit integer.
\n
Set noAssert to true to skip validation of value and offset. This means\nthat value may be too large for the specific function and offset may be\nbeyond the end of the Buffer leading to the values being silently dropped. This\nshould not be used unless you are certain of correctness.
\n
Example:
\n
const buf = new Buffer(4);\nbuf.writeUInt8(0x3, 0);\nbuf.writeUInt8(0x4, 1);\nbuf.writeUInt8(0x23, 2);\nbuf.writeUInt8(0x42, 3);\n\nconsole.log(buf);\n  // Prints: <Buffer 03 04 23 42>\n
\n"
            },
            {
              "textRaw": "buf.writeUInt16BE(value, offset[, noAssert])",
              "type": "method",
              "name": "writeUInt16BE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The offset plus the number of written bytes ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The offset plus the number of written bytes"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {Number} Bytes to be written to Buffer ",
                      "name": "value",
                      "type": "Number",
                      "desc": "Bytes to be written to Buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 2` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 2`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes value to the Buffer at the specified offset with specified endian\nformat (writeUInt16BE() writes big endian, writeUInt16LE() writes little\nendian). The value should be a valid unsigned 16-bit integer. Behavior is\nnot defined when value is anything other than an unsigned 16-bit integer.
\n
Set noAssert to true to skip validation of value and offset. This means\nthat value may be too large for the specific function and offset may be\nbeyond the end of the Buffer leading to the values being silently dropped. This\nshould not be used unless you are certain of correctness.
\n
Example:
\n
const buf = new Buffer(4);\nbuf.writeUInt16BE(0xdead, 0);\nbuf.writeUInt16BE(0xbeef, 2);\n\nconsole.log(buf);\n  // Prints: <Buffer de ad be ef>\n\nbuf.writeUInt16LE(0xdead, 0);\nbuf.writeUInt16LE(0xbeef, 2);\n\nconsole.log(buf);\n  // Prints: <Buffer ad de ef be>\n
\n"
            },
            {
              "textRaw": "buf.writeUInt16LE(value, offset[, noAssert])",
              "type": "method",
              "name": "writeUInt16LE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The offset plus the number of written bytes ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The offset plus the number of written bytes"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {Number} Bytes to be written to Buffer ",
                      "name": "value",
                      "type": "Number",
                      "desc": "Bytes to be written to Buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 2` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 2`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes value to the Buffer at the specified offset with specified endian\nformat (writeUInt16BE() writes big endian, writeUInt16LE() writes little\nendian). The value should be a valid unsigned 16-bit integer. Behavior is\nnot defined when value is anything other than an unsigned 16-bit integer.
\n
Set noAssert to true to skip validation of value and offset. This means\nthat value may be too large for the specific function and offset may be\nbeyond the end of the Buffer leading to the values being silently dropped. This\nshould not be used unless you are certain of correctness.
\n
Example:
\n
const buf = new Buffer(4);\nbuf.writeUInt16BE(0xdead, 0);\nbuf.writeUInt16BE(0xbeef, 2);\n\nconsole.log(buf);\n  // Prints: <Buffer de ad be ef>\n\nbuf.writeUInt16LE(0xdead, 0);\nbuf.writeUInt16LE(0xbeef, 2);\n\nconsole.log(buf);\n  // Prints: <Buffer ad de ef be>\n
\n"
            },
            {
              "textRaw": "buf.writeUInt32BE(value, offset[, noAssert])",
              "type": "method",
              "name": "writeUInt32BE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The offset plus the number of written bytes ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The offset plus the number of written bytes"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {Number} Bytes to be written to Buffer ",
                      "name": "value",
                      "type": "Number",
                      "desc": "Bytes to be written to Buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 4` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 4`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes value to the Buffer at the specified offset with specified endian\nformat (writeUInt32BE() writes big endian, writeUInt32LE() writes little\nendian). The value should be a valid unsigned 32-bit integer. Behavior is\nnot defined when value is anything other than an unsigned 32-bit integer.
\n
Set noAssert to true to skip validation of value and offset. This means\nthat value may be too large for the specific function and offset may be\nbeyond the end of the Buffer leading to the values being silently dropped. This\nshould not be used unless you are certain of correctness.
\n
Example:
\n
const buf = new Buffer(4);\nbuf.writeUInt32BE(0xfeedface, 0);\n\nconsole.log(buf);\n  // Prints: <Buffer fe ed fa ce>\n\nbuf.writeUInt32LE(0xfeedface, 0);\n\nconsole.log(buf);\n  // Prints: <Buffer ce fa ed fe>\n
\n"
            },
            {
              "textRaw": "buf.writeUInt32LE(value, offset[, noAssert])",
              "type": "method",
              "name": "writeUInt32LE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The offset plus the number of written bytes ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The offset plus the number of written bytes"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {Number} Bytes to be written to Buffer ",
                      "name": "value",
                      "type": "Number",
                      "desc": "Bytes to be written to Buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 4` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 4`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes value to the Buffer at the specified offset with specified endian\nformat (writeUInt32BE() writes big endian, writeUInt32LE() writes little\nendian). The value should be a valid unsigned 32-bit integer. Behavior is\nnot defined when value is anything other than an unsigned 32-bit integer.
\n
Set noAssert to true to skip validation of value and offset. This means\nthat value may be too large for the specific function and offset may be\nbeyond the end of the Buffer leading to the values being silently dropped. This\nshould not be used unless you are certain of correctness.
\n
Example:
\n
const buf = new Buffer(4);\nbuf.writeUInt32BE(0xfeedface, 0);\n\nconsole.log(buf);\n  // Prints: <Buffer fe ed fa ce>\n\nbuf.writeUInt32LE(0xfeedface, 0);\n\nconsole.log(buf);\n  // Prints: <Buffer ce fa ed fe>\n
\n"
            },
            {
              "textRaw": "buf.writeUIntBE(value, offset, byteLength[, noAssert])",
              "type": "method",
              "name": "writeUIntBE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The offset plus the number of written bytes ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The offset plus the number of written bytes"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {Number} Bytes to be written to Buffer ",
                      "name": "value",
                      "type": "Number",
                      "desc": "Bytes to be written to Buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - byteLength` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - byteLength`"
                    },
                    {
                      "textRaw": "`byteLength` {Number} `0 < byteLength <= 6` ",
                      "name": "byteLength",
                      "type": "Number",
                      "desc": "`0 < byteLength <= 6`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "byteLength"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "byteLength"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes value to the Buffer at the specified offset and byteLength.\nSupports up to 48 bits of accuracy. For example:
\n
const buf = new Buffer(6);\nbuf.writeUIntBE(0x1234567890ab, 0, 6);\nconsole.log(buf);\n  // Prints: <Buffer 12 34 56 78 90 ab>\n
\n
Set noAssert to true to skip validation of value and offset. This means\nthat value may be too large for the specific function and offset may be\nbeyond the end of the Buffer leading to the values being silently dropped. This\nshould not be used unless you are certain of correctness.
\n
Behavior is not defined when value is anything other than an unsigned integer.
\n"
            },
            {
              "textRaw": "buf.writeUIntLE(value, offset, byteLength[, noAssert])",
              "type": "method",
              "name": "writeUIntLE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The offset plus the number of written bytes ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The offset plus the number of written bytes"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {Number} Bytes to be written to Buffer ",
                      "name": "value",
                      "type": "Number",
                      "desc": "Bytes to be written to Buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - byteLength` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - byteLength`"
                    },
                    {
                      "textRaw": "`byteLength` {Number} `0 < byteLength <= 6` ",
                      "name": "byteLength",
                      "type": "Number",
                      "desc": "`0 < byteLength <= 6`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "byteLength"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes value to the Buffer at the specified offset and byteLength.\nSupports up to 48 bits of accuracy. For example:
\n
const buf = new Buffer(6);\nbuf.writeUIntBE(0x1234567890ab, 0, 6);\nconsole.log(buf);\n  // Prints: <Buffer 12 34 56 78 90 ab>\n
\n
Set noAssert to true to skip validation of value and offset. This means\nthat value may be too large for the specific function and offset may be\nbeyond the end of the Buffer leading to the values being silently dropped. This\nshould not be used unless you are certain of correctness.
\n
Behavior is not defined when value is anything other than an unsigned integer.
\n"
            }
          ],
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`array` {Array} ",
                  "name": "array",
                  "type": "Array"
                }
              ],
              "desc": "
Allocates a new Buffer using an array of octets.
\n
const buf = new Buffer([0x62,0x75,0x66,0x66,0x65,0x72]);\n  // creates a new Buffer containing ASCII bytes\n  // ['b','u','f','f','e','r']\n
\n"
            },
            {
              "params": [
                {
                  "name": "array"
                }
              ],
              "desc": "
Allocates a new Buffer using an array of octets.
\n
const buf = new Buffer([0x62,0x75,0x66,0x66,0x65,0x72]);\n  // creates a new Buffer containing ASCII bytes\n  // ['b','u','f','f','e','r']\n
\n"
            },
            {
              "params": [
                {
                  "textRaw": "`buffer` {Buffer} ",
                  "name": "buffer",
                  "type": "Buffer"
                }
              ],
              "desc": "
Copies the passed buffer data onto a new Buffer instance.
\n
const buf1 = new Buffer('buffer');\nconst buf2 = new Buffer(buf1);\n\nbuf1[0] = 0x61;\nconsole.log(buf1.toString());\n  // 'auffer'\nconsole.log(buf2.toString());\n  // 'buffer' (copy is not changed)\n
\n"
            },
            {
              "params": [
                {
                  "name": "buffer"
                }
              ],
              "desc": "
Copies the passed buffer data onto a new Buffer instance.
\n
const buf1 = new Buffer('buffer');\nconst buf2 = new Buffer(buf1);\n\nbuf1[0] = 0x61;\nconsole.log(buf1.toString());\n  // 'auffer'\nconsole.log(buf2.toString());\n  // 'buffer' (copy is not changed)\n
\n"
            },
            {
              "params": [
                {
                  "textRaw": "`arrayBuffer` - The `.buffer` property of a `TypedArray` or a `new ArrayBuffer()` ",
                  "name": "arrayBuffer",
                  "desc": "The `.buffer` property of a `TypedArray` or a `new ArrayBuffer()`"
                }
              ],
              "desc": "
When passed a reference to the .buffer property of a TypedArray instance,\nthe newly created Buffer will share the same allocated memory as the\nTypedArray.
\n
const arr = new Uint16Array(2);\narr[0] = 5000;\narr[1] = 4000;\n\nconst buf = new Buffer(arr.buffer); // shares the memory with arr;\n\nconsole.log(buf);\n  // Prints: <Buffer 88 13 a0 0f>\n\n// changing the TypdArray changes the Buffer also\narr[1] = 6000;\n\nconsole.log(buf);\n  // Prints: <Buffer 88 13 70 17>\n
\n"
            },
            {
              "params": [
                {
                  "name": "arrayBuffer"
                }
              ],
              "desc": "
When passed a reference to the .buffer property of a TypedArray instance,\nthe newly created Buffer will share the same allocated memory as the\nTypedArray.
\n
const arr = new Uint16Array(2);\narr[0] = 5000;\narr[1] = 4000;\n\nconst buf = new Buffer(arr.buffer); // shares the memory with arr;\n\nconsole.log(buf);\n  // Prints: <Buffer 88 13 a0 0f>\n\n// changing the TypdArray changes the Buffer also\narr[1] = 6000;\n\nconsole.log(buf);\n  // Prints: <Buffer 88 13 70 17>\n
\n"
            },
            {
              "params": [
                {
                  "textRaw": "`size` {Number} ",
                  "name": "size",
                  "type": "Number"
                }
              ],
              "desc": "
Allocates a new Buffer of size bytes.  The size must be less than\nor equal to the value of require('buffer').kMaxLength (on 64-bit\narchitectures, kMaxLength is (2^31)-1). Otherwise, a RangeError is\nthrown. If a size less than 0 is specified, a zero-length Buffer will be\ncreated.
\n
Unlike ArrayBuffers, the underlying memory for Buffer instances created in\nthis way is not initialized. The contents of a newly created Buffer are\nunknown and could contain sensitive data. Use buf.fill(0) to initialize a\nBuffer to zeroes.
\n
const buf = new Buffer(5);\nconsole.log(buf);\n  // <Buffer 78 e0 82 02 01>\n  // (octets will be different, every time)\nbuf.fill(0);\nconsole.log(buf);\n  // <Buffer 00 00 00 00 00>\n
\n"
            },
            {
              "params": [
                {
                  "name": "size"
                }
              ],
              "desc": "
Allocates a new Buffer of size bytes.  The size must be less than\nor equal to the value of require('buffer').kMaxLength (on 64-bit\narchitectures, kMaxLength is (2^31)-1). Otherwise, a RangeError is\nthrown. If a size less than 0 is specified, a zero-length Buffer will be\ncreated.
\n
Unlike ArrayBuffers, the underlying memory for Buffer instances created in\nthis way is not initialized. The contents of a newly created Buffer are\nunknown and could contain sensitive data. Use buf.fill(0) to initialize a\nBuffer to zeroes.
\n
const buf = new Buffer(5);\nconsole.log(buf);\n  // <Buffer 78 e0 82 02 01>\n  // (octets will be different, every time)\nbuf.fill(0);\nconsole.log(buf);\n  // <Buffer 00 00 00 00 00>\n
\n"
            },
            {
              "params": [
                {
                  "textRaw": "`str` {String} String to encode. ",
                  "name": "str",
                  "type": "String",
                  "desc": "String to encode."
                },
                {
                  "textRaw": "`encoding` {String} Default: `'utf8'` ",
                  "name": "encoding",
                  "type": "String",
                  "desc": "Default: `'utf8'`",
                  "optional": true
                }
              ],
              "desc": "
Creates a new Buffer containing the given JavaScript string str. If\nprovided, the encoding parameter identifies the strings character encoding.
\n
const buf1 = new Buffer('this is a tést');\nconsole.log(buf1.toString());\n  // prints: this is a tést\nconsole.log(buf1.toString('ascii'));\n  // prints: this is a tC)st\n\nconst buf2 = new Buffer('7468697320697320612074c3a97374', 'hex');\nconsole.log(buf2.toString());\n  // prints: this is a tést\n
\n"
            },
            {
              "params": [
                {
                  "name": "str"
                },
                {
                  "name": "encoding",
                  "optional": true
                }
              ],
              "desc": "
Creates a new Buffer containing the given JavaScript string str. If\nprovided, the encoding parameter identifies the strings character encoding.
\n
const buf1 = new Buffer('this is a tést');\nconsole.log(buf1.toString());\n  // prints: this is a tést\nconsole.log(buf1.toString('ascii'));\n  // prints: this is a tC)st\n\nconst buf2 = new Buffer('7468697320697320612074c3a97374', 'hex');\nconsole.log(buf2.toString());\n  // prints: this is a tést\n
\n"
            }
          ]
        },
        {
          "textRaw": "Class: SlowBuffer",
          "type": "class",
          "name": "SlowBuffer",
          "desc": "
Returns an un-pooled Buffer.
\n
In order to avoid the garbage collection overhead of creating many individually\nallocated Buffers, by default allocations under 4KB are sliced from a single\nlarger allocated object. This approach improves both performance and memory\nusage since v8 does not need to track and cleanup as many Persistent objects.
\n
In the case where a developer may need to retain a small chunk of memory from a\npool for an indeterminate amount of time, it may be appropriate to create an\nun-pooled Buffer instance using SlowBuffer then copy out the relevant bits.
\n
// need to keep around a few small chunks of memory\nconst store = [];\n\nsocket.on('readable', () => {\n  var data = socket.read();\n  // allocate for retained data\n  var sb = new SlowBuffer(10);\n  // copy the data into the new allocation\n  data.copy(sb, 0, 0, 10);\n  store.push(sb);\n});\n
\n
Use of SlowBuffer should be used only as a last resort after a developer\nhas observed undue memory retention in their applications.
\n",
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`size` Number ",
                  "name": "size",
                  "desc": "Number"
                }
              ],
              "desc": "
Allocates a new SlowBuffer of size bytes.  The size must be less than\nor equal to the value of require('buffer').kMaxLength (on 64-bit\narchitectures, kMaxLength is (2^31)-1). Otherwise, a RangeError is\nthrown. If a size less than 0 is specified, a zero-length SlowBuffer will be\ncreated.
\n
The underlying memory for SlowBuffer instances is not initialized. The\ncontents of a newly created SlowBuffer are unknown and could contain\nsensitive data. Use buf.fill(0) to initialize a SlowBuffer to zeroes.
\n
const SlowBuffer = require('buffer').SlowBuffer;\nconst buf = new SlowBuffer(5);\nconsole.log(buf);\n  // <Buffer 78 e0 82 02 01>\n  // (octets will be different, every time)\nbuf.fill(0);\nconsole.log(buf);\n  // <Buffer 00 00 00 00 00>\n
\n\n\n"
            },
            {
              "params": [
                {
                  "name": "size"
                }
              ],
              "desc": "
Allocates a new SlowBuffer of size bytes.  The size must be less than\nor equal to the value of require('buffer').kMaxLength (on 64-bit\narchitectures, kMaxLength is (2^31)-1). Otherwise, a RangeError is\nthrown. If a size less than 0 is specified, a zero-length SlowBuffer will be\ncreated.
\n
The underlying memory for SlowBuffer instances is not initialized. The\ncontents of a newly created SlowBuffer are unknown and could contain\nsensitive data. Use buf.fill(0) to initialize a SlowBuffer to zeroes.
\n
const SlowBuffer = require('buffer').SlowBuffer;\nconst buf = new SlowBuffer(5);\nconsole.log(buf);\n  // <Buffer 78 e0 82 02 01>\n  // (octets will be different, every time)\nbuf.fill(0);\nconsole.log(buf);\n  // <Buffer 00 00 00 00 00>\n
\n\n\n"
            }
          ]
        }
      ],
      "properties": [
        {
          "textRaw": "`INSPECT_MAX_BYTES` {Number} Default: 50 ",
          "type": "Number",
          "name": "INSPECT_MAX_BYTES",
          "desc": "
Returns the maximum number of bytes that will be returned when\nbuffer.inspect() is called. This can be overridden by user modules. See\nutil.inspect() for more details on buffer.inspect() behavior.
\n
Note that this is a property on the buffer module as returned by\nrequire('buffer'), not on the Buffer global or a Buffer instance.
\n",
          "shortDesc": "Default: 50"
        }
      ],
      "type": "module",
      "displayName": "Buffer"
    },
    {
      "textRaw": "Child Process",
      "name": "child_process",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
The child_process module provides the ability to spawn child processes in\na manner that is similar, but not identical, to popen(3). This capability\nis primarily provided by the child_process.spawn() function:
\n
const spawn = require('child_process').spawn;\nconst ls = spawn('ls', ['-lh', '/usr']);\n\nls.stdout.on('data', (data) => {\n  console.log(`stdout: ${data}`);\n});\n\nls.stderr.on('data', (data) => {\n  console.log(`stderr: ${data}`);\n});\n\nls.on('close', (code) => {\n  console.log(`child process exited with code ${code}`);\n});\n
\n
By default, pipes for stdin, stdout and stderr are established between\nthe parent Node.js process and the spawned child. It is possible to stream data\nthrough these pipes in a non-blocking way. Note, however, that some programs\nuse line-buffered I/O internally. While that does not affect Node.js, it can\nmean that data sent to the child process may not be immediately consumed.
\n
The child_process.spawn() method spawns the child process asynchronously,\nwithout blocking the Node.js event loop. The child_process.spawnSync()\nfunction provides equivalent functionality in a synchronous manner that blocks\nthe event loop until the spawned process either exits or is terminated.
\n
For convenience, the child_process module provides a handful of synchronous\nand asynchronous alternatives to child_process.spawn() and\nchild_process.spawnSync().  Note that each of these alternatives are\nimplemented on top of child_process.spawn() or child_process.spawnSync().
\n
    \n
  • child_process.exec(): spawns a shell and runs a command within that shell,\npassing the stdout and stderr to a callback function when complete.
    • \n
  • child_process.execFile(): similar to child_process.exec() except that\nit spawns the command directly without first spawning a shell.
    • \n
  • child_process.fork(): spawns a new Node.js process and invokes a\nspecified module with an IPC communication channel established that allows\nsending messages between parent and child.
    • \n
  • child_process.execSync(): a synchronous version of\nchild_process.exec() that will block the Node.js event loop.
    • \n
  • child_process.execFileSync(): a synchronous version of\nchild_process.execFile() that will block the Node.js event loop.
    • \n
\n
For certain use cases, such as automating shell scripts, the\nsynchronous counterparts may be more convenient. In many cases, however,\nthe synchronous methods can have significant impact on performance due to\nstalling the event loop while spawned processes complete.
\n",
      "modules": [
        {
          "textRaw": "Asynchronous Process Creation",
          "name": "asynchronous_process_creation",
          "desc": "
The child_process.spawn(), child_process.fork(), child_process.exec(),\nand child_process.execFile() methods all follow the idiomatic asynchronous\nprogramming pattern typical of other Node.js APIs.
\n
Each of the methods returns a ChildProcess instance. These objects\nimplement the Node.js EventEmitter API, allowing the parent process to\nregister listener functions that are called when certain events occur during\nthe life cycle of the child process.
\n
The child_process.exec() and child_process.execFile() methods additionally\nallow for an optional callback function to be specified that is invoked\nwhen the child process terminates.
\n",
          "modules": [
            {
              "textRaw": "Spawning `.bat` and `.cmd` files on Windows",
              "name": "spawning_`.bat`_and_`.cmd`_files_on_windows",
              "desc": "
The importance of the distinction between child_process.exec() and\nchild_process.execFile() can vary based on platform. On Unix-type operating\nsystems (Unix, Linux, OSX) child_process.execFile() can be more efficient\nbecause it does not spawn a shell. On Windows, however, .bat and .cmd\nfiles are not executable on their own without a terminal, and therefore cannot\nbe launched using child_process.execFile(). When running on Windows, .bat\nand .cmd files can be invoked using child_process.spawn() with the shell\noption set, with child_process.exec(), or by spawning cmd.exe and passing\nthe .bat or .cmd file as an argument (which is what the shell option and\nchild_process.exec() do).
\n
// On Windows Only ...\nconst spawn = require('child_process').spawn;\nconst bat = spawn('cmd.exe', ['/c', 'my.bat']);\n\nbat.stdout.on('data', (data) => {\n  console.log(data);\n});\n\nbat.stderr.on('data', (data) => {\n  console.log(data);\n});\n\nbat.on('exit', (code) => {\n  console.log(`Child exited with code ${code}`);\n});\n\n// OR...\nconst exec = require('child_process').exec;\nexec('my.bat', (err, stdout, stderr) => {\n  if (err) {\n    console.error(err);\n    return;\n  }\n  console.log(stdout);\n});\n
\n",
              "type": "module",
              "displayName": "Spawning `.bat` and `.cmd` files on Windows"
            }
          ],
          "methods": [
            {
              "textRaw": "child_process.exec(command[, options][, callback])",
              "type": "method",
              "name": "exec",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {ChildProcess} ",
                    "name": "return",
                    "type": "ChildProcess"
                  },
                  "params": [
                    {
                      "textRaw": "`command` {String} The command to run, with space-separated arguments ",
                      "name": "command",
                      "type": "String",
                      "desc": "The command to run, with space-separated arguments"
                    },
                    {
                      "textRaw": "`options` {Object} ",
                      "options": [
                        {
                          "textRaw": "`cwd` {String} Current working directory of the child process ",
                          "name": "cwd",
                          "type": "String",
                          "desc": "Current working directory of the child process"
                        },
                        {
                          "textRaw": "`env` {Object} Environment key-value pairs ",
                          "name": "env",
                          "type": "Object",
                          "desc": "Environment key-value pairs"
                        },
                        {
                          "textRaw": "`encoding` {String} (Default: 'utf8') ",
                          "name": "encoding",
                          "default": "utf8",
                          "type": "String"
                        },
                        {
                          "textRaw": "`shell` {String} Shell to execute the command with (Default: '/bin/sh' on UNIX, 'cmd.exe' on Windows,  The shell should  understand the `-c` switch on UNIX or `/s /c` on Windows. On Windows,  command line parsing should be compatible with `cmd.exe`.) ",
                          "name": "shell",
                          "type": "String",
                          "desc": "Shell to execute the command with (Default: '/bin/sh' on UNIX, 'cmd.exe' on Windows,  The shell should  understand the `-c` switch on UNIX or `/s /c` on Windows. On Windows,  command line parsing should be compatible with `cmd.exe`.)"
                        },
                        {
                          "textRaw": "`timeout` {Number} (Default: 0) ",
                          "name": "timeout",
                          "default": "0",
                          "type": "Number"
                        },
                        {
                          "textRaw": "`maxBuffer` {Number} largest amount of data (in bytes) allowed on stdout or stderr - if exceeded child process is killed (Default: `200*1024`) ",
                          "name": "maxBuffer",
                          "default": "200*1024",
                          "type": "Number",
                          "desc": "largest amount of data (in bytes) allowed on stdout or stderr - if exceeded child process is killed"
                        },
                        {
                          "textRaw": "`killSignal` {String|Integer} (Default: 'SIGTERM') ",
                          "name": "killSignal",
                          "default": "SIGTERM",
                          "type": "String|Integer"
                        },
                        {
                          "textRaw": "`uid` {Number} Sets the user identity of the process. (See setuid(2).) ",
                          "name": "uid",
                          "type": "Number",
                          "desc": "Sets the user identity of the process. (See setuid(2).)"
                        },
                        {
                          "textRaw": "`gid` {Number} Sets the group identity of the process. (See setgid(2).) ",
                          "name": "gid",
                          "type": "Number",
                          "desc": "Sets the group identity of the process. (See setgid(2).)"
                        }
                      ],
                      "name": "options",
                      "type": "Object",
                      "optional": true
                    },
                    {
                      "textRaw": "`callback` {Function} called with the output when process terminates ",
                      "options": [
                        {
                          "textRaw": "`error` {Error} ",
                          "name": "error",
                          "type": "Error"
                        },
                        {
                          "textRaw": "`stdout` {String|Buffer} ",
                          "name": "stdout",
                          "type": "String|Buffer"
                        },
                        {
                          "textRaw": "`stderr` {String|Buffer} ",
                          "name": "stderr",
                          "type": "String|Buffer"
                        }
                      ],
                      "name": "callback",
                      "type": "Function",
                      "desc": "called with the output when process terminates",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "command"
                    },
                    {
                      "name": "options",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Spawns a shell then executes the command within that shell, buffering any\ngenerated output.
\n
Note: Never pass unsanitised user input to this function. Any input\ncontaining shell metacharacters may be used to trigger arbitrary command\nexecution.
\n
const exec = require('child_process').exec;\nexec('cat *.js bad_file | wc -l', (error, stdout, stderr) => {\n  if (error) {\n    console.error(`exec error: ${error}`);\n    return;\n  }\n  console.log(`stdout: ${stdout}`);\n  console.log(`stderr: ${stderr}`);\n});\n
\n
If a callback function is provided, it is called with the arguments\n(error, stdout, stderr). On success, error will be null.  On error,\nerror will be an instance of Error. The error.code property will be\nthe exit code of the child process while error.signal will be set to the\nsignal that terminated the process. Any exit code other than 0 is considered\nto be an error.
\n
The stdout and stderr arguments passed to the callback will contain the\nstdout and stderr output of the child process. By default, Node.js will decode\nthe output as UTF-8 and pass strings to the callback. The encoding option\ncan be used to specify the character encoding used to decode the stdout and\nstderr output. If encoding is 'buffer', or an unrecognized character\nencoding, Buffer objects will be passed to the callback instead.
\n
The options argument may be passed as the second argument to customize how\nthe process is spawned. The default options are:
\n
{\n  encoding: 'utf8',\n  timeout: 0,\n  maxBuffer: 200*1024,\n  killSignal: 'SIGTERM',\n  cwd: null,\n  env: null\n}\n
\n
If timeout is greater than 0, the parent will send the the signal\nidentified by the killSignal property (the default is 'SIGTERM') if the\nchild runs longer than timeout milliseconds.
\n
The maxBuffer option specifies the largest amount of data (in bytes) allowed\non stdout or stderr - if this value is exceeded then the child process is\nterminated.
\n
Note: Unlike the exec() POSIX system call, child_process.exec() does not\nreplace the existing process and uses a shell to execute the command.
\n"
            },
            {
              "textRaw": "child_process.execFile(file[, args][, options][, callback])",
              "type": "method",
              "name": "execFile",
              "meta": {
                "added": [
                  "v0.1.91"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {ChildProcess} ",
                    "name": "return",
                    "type": "ChildProcess"
                  },
                  "params": [
                    {
                      "textRaw": "`file` {String} The name or path of the executable file to run ",
                      "name": "file",
                      "type": "String",
                      "desc": "The name or path of the executable file to run"
                    },
                    {
                      "textRaw": "`args` {Array} List of string arguments ",
                      "name": "args",
                      "type": "Array",
                      "desc": "List of string arguments",
                      "optional": true
                    },
                    {
                      "textRaw": "`options` {Object} ",
                      "options": [
                        {
                          "textRaw": "`cwd` {String} Current working directory of the child process ",
                          "name": "cwd",
                          "type": "String",
                          "desc": "Current working directory of the child process"
                        },
                        {
                          "textRaw": "`env` {Object} Environment key-value pairs ",
                          "name": "env",
                          "type": "Object",
                          "desc": "Environment key-value pairs"
                        },
                        {
                          "textRaw": "`encoding` {String} (Default: 'utf8') ",
                          "name": "encoding",
                          "default": "utf8",
                          "type": "String"
                        },
                        {
                          "textRaw": "`timeout` {Number} (Default: 0) ",
                          "name": "timeout",
                          "default": "0",
                          "type": "Number"
                        },
                        {
                          "textRaw": "`maxBuffer` {Number} largest amount of data (in bytes) allowed on stdout or stderr - if exceeded child process is killed (Default: 200\\*1024) ",
                          "name": "maxBuffer",
                          "default": "200\\*1024",
                          "type": "Number",
                          "desc": "largest amount of data (in bytes) allowed on stdout or stderr - if exceeded child process is killed"
                        },
                        {
                          "textRaw": "`killSignal` {String|Integer} (Default: 'SIGTERM') ",
                          "name": "killSignal",
                          "default": "SIGTERM",
                          "type": "String|Integer"
                        },
                        {
                          "textRaw": "`uid` {Number} Sets the user identity of the process. (See setuid(2).) ",
                          "name": "uid",
                          "type": "Number",
                          "desc": "Sets the user identity of the process. (See setuid(2).)"
                        },
                        {
                          "textRaw": "`gid` {Number} Sets the group identity of the process. (See setgid(2).) ",
                          "name": "gid",
                          "type": "Number",
                          "desc": "Sets the group identity of the process. (See setgid(2).)"
                        }
                      ],
                      "name": "options",
                      "type": "Object",
                      "optional": true
                    },
                    {
                      "textRaw": "`callback` {Function} called with the output when process terminates ",
                      "options": [
                        {
                          "textRaw": "`error` {Error} ",
                          "name": "error",
                          "type": "Error"
                        },
                        {
                          "textRaw": "`stdout` {String|Buffer} ",
                          "name": "stdout",
                          "type": "String|Buffer"
                        },
                        {
                          "textRaw": "`stderr` {String|Buffer} ",
                          "name": "stderr",
                          "type": "String|Buffer"
                        }
                      ],
                      "name": "callback",
                      "type": "Function",
                      "desc": "called with the output when process terminates",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "file"
                    },
                    {
                      "name": "args",
                      "optional": true
                    },
                    {
                      "name": "options",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
The child_process.execFile() function is similar to child_process.exec()\nexcept that it does not spawn a shell. Rather, the specified executable file\nis spawned directly as a new process making it slightly more efficient than\nchild_process.exec().
\n
The same options as child_process.exec() are supported. Since a shell is not\nspawned, behaviors such as I/O redirection and file globbing are not supported.
\n
const execFile = require('child_process').execFile;\nconst child = execFile('node', ['--version'], (error, stdout, stderr) => {\n  if (error) {\n    throw error;\n  }\n  console.log(stdout);\n});\n
\n
The stdout and stderr arguments passed to the callback will contain the\nstdout and stderr output of the child process. By default, Node.js will decode\nthe output as UTF-8 and pass strings to the callback. The encoding option\ncan be used to specify the character encoding used to decode the stdout and\nstderr output. If encoding is 'buffer', or an unrecognized character\nencoding, Buffer objects will be passed to the callback instead.
\n"
            },
            {
              "textRaw": "child_process.fork(modulePath[, args][, options])",
              "type": "method",
              "name": "fork",
              "meta": {
                "added": [
                  "v0.5.0"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {ChildProcess} ",
                    "name": "return",
                    "type": "ChildProcess"
                  },
                  "params": [
                    {
                      "textRaw": "`modulePath` {String} The module to run in the child ",
                      "name": "modulePath",
                      "type": "String",
                      "desc": "The module to run in the child"
                    },
                    {
                      "textRaw": "`args` {Array} List of string arguments ",
                      "name": "args",
                      "type": "Array",
                      "desc": "List of string arguments",
                      "optional": true
                    },
                    {
                      "textRaw": "`options` {Object} ",
                      "options": [
                        {
                          "textRaw": "`cwd` {String} Current working directory of the child process ",
                          "name": "cwd",
                          "type": "String",
                          "desc": "Current working directory of the child process"
                        },
                        {
                          "textRaw": "`env` {Object} Environment key-value pairs ",
                          "name": "env",
                          "type": "Object",
                          "desc": "Environment key-value pairs"
                        },
                        {
                          "textRaw": "`execPath` {String} Executable used to create the child process ",
                          "name": "execPath",
                          "type": "String",
                          "desc": "Executable used to create the child process"
                        },
                        {
                          "textRaw": "`execArgv` {Array} List of string arguments passed to the executable (Default: `process.execArgv`) ",
                          "name": "execArgv",
                          "default": "process.execArgv",
                          "type": "Array",
                          "desc": "List of string arguments passed to the executable"
                        },
                        {
                          "textRaw": "`silent` {Boolean} If true, stdin, stdout, and stderr of the child will be piped to the parent, otherwise they will be inherited from the parent, see the `'pipe'` and `'inherit'` options for [`child_process.spawn()`][]'s [`stdio`][] for more details (default is false) ",
                          "name": "silent",
                          "type": "Boolean",
                          "desc": "If true, stdin, stdout, and stderr of the child will be piped to the parent, otherwise they will be inherited from the parent, see the `'pipe'` and `'inherit'` options for [`child_process.spawn()`][]'s [`stdio`][] for more details (default is false)"
                        },
                        {
                          "textRaw": "`uid` {Number} Sets the user identity of the process. (See setuid(2).) ",
                          "name": "uid",
                          "type": "Number",
                          "desc": "Sets the user identity of the process. (See setuid(2).)"
                        },
                        {
                          "textRaw": "`gid` {Number} Sets the group identity of the process. (See setgid(2).) ",
                          "name": "gid",
                          "type": "Number",
                          "desc": "Sets the group identity of the process. (See setgid(2).)"
                        }
                      ],
                      "name": "options",
                      "type": "Object",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "modulePath"
                    },
                    {
                      "name": "args",
                      "optional": true
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
The child_process.fork() method is a special case of\nchild_process.spawn() used specifically to spawn new Node.js processes.\nLike child_process.spawn(), a ChildProcess object is returned. The returned\nChildProcess will have an additional communication channel built-in that\nallows messages to be passed back and forth between the parent and child. See\nChildProcess#send() for details.
\n
It is important to keep in mind that spawned Node.js child processes are\nindependent of the parent with exception of the IPC communication channel\nthat is established between the two. Each process has its own memory, with\ntheir own V8 instances. Because of the additional resource allocations\nrequired, spawning a large number of child Node.js processes is not\nrecommended.
\n
By default, child_process.fork() will spawn new Node.js instances using the\nprocess.execPath of the parent process. The execPath property in the\noptions object allows for an alternative execution path to be used.
\n
Node.js processes launched with a custom execPath will communicate with the\nparent process using the file descriptor (fd) identified using the\nenvironment variable NODE_CHANNEL_FD on the child process. The input and\noutput on this fd is expected to be line delimited JSON objects.
\n
Note: Unlike the fork() POSIX system call, child_process.fork() does\nnot clone the current process.
\n"
            },
            {
              "textRaw": "child_process.spawn(command[, args][, options])",
              "type": "method",
              "name": "spawn",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {ChildProcess} ",
                    "name": "return",
                    "type": "ChildProcess"
                  },
                  "params": [
                    {
                      "textRaw": "`command` {String} The command to run ",
                      "name": "command",
                      "type": "String",
                      "desc": "The command to run"
                    },
                    {
                      "textRaw": "`args` {Array} List of string arguments ",
                      "name": "args",
                      "type": "Array",
                      "desc": "List of string arguments",
                      "optional": true
                    },
                    {
                      "textRaw": "`options` {Object} ",
                      "options": [
                        {
                          "textRaw": "`cwd` {String} Current working directory of the child process ",
                          "name": "cwd",
                          "type": "String",
                          "desc": "Current working directory of the child process"
                        },
                        {
                          "textRaw": "`env` {Object} Environment key-value pairs ",
                          "name": "env",
                          "type": "Object",
                          "desc": "Environment key-value pairs"
                        },
                        {
                          "textRaw": "`stdio` {Array|String} Child's stdio configuration. (See [`options.stdio`][]) ",
                          "name": "stdio",
                          "type": "Array|String",
                          "desc": "Child's stdio configuration. (See [`options.stdio`][])"
                        },
                        {
                          "textRaw": "`detached` {Boolean} Prepare child to run independently of its parent process. Specific behavior depends on the platform, see [`options.detached`][]) ",
                          "name": "detached",
                          "type": "Boolean",
                          "desc": "Prepare child to run independently of its parent process. Specific behavior depends on the platform, see [`options.detached`][])"
                        },
                        {
                          "textRaw": "`uid` {Number} Sets the user identity of the process. (See setuid(2).) ",
                          "name": "uid",
                          "type": "Number",
                          "desc": "Sets the user identity of the process. (See setuid(2).)"
                        },
                        {
                          "textRaw": "`gid` {Number} Sets the group identity of the process. (See setgid(2).) ",
                          "name": "gid",
                          "type": "Number",
                          "desc": "Sets the group identity of the process. (See setgid(2).)"
                        },
                        {
                          "textRaw": "`shell` {Boolean|String} If `true`, runs `command` inside of a shell. Uses '/bin/sh' on UNIX, and 'cmd.exe' on Windows. A different shell can be specified as a string. The shell should understand the `-c` switch on UNIX, or `/s /c` on Windows. Defaults to `false` (no shell). ",
                          "name": "shell",
                          "type": "Boolean|String",
                          "desc": "If `true`, runs `command` inside of a shell. Uses '/bin/sh' on UNIX, and 'cmd.exe' on Windows. A different shell can be specified as a string. The shell should understand the `-c` switch on UNIX, or `/s /c` on Windows. Defaults to `false` (no shell)."
                        }
                      ],
                      "name": "options",
                      "type": "Object",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "command"
                    },
                    {
                      "name": "args",
                      "optional": true
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
The child_process.spawn() method spawns a new process using the given\ncommand, with command line arguments in args. If omitted, args defaults\nto an empty array.
\n
Note: If the shell option is enabled, do not pass unsanitised user input to\nthis function. Any input containing shell metacharacters may be used to\ntrigger arbitrary command execution.
\n
A third argument may be used to specify additional options, with these defaults:
\n
{\n  cwd: undefined,\n  env: process.env\n}\n
\n
Use cwd to specify the working directory from which the process is spawned.\nIf not given, the default is to inherit the current working directory.
\n
Use env to specify environment variables that will be visible to the new\nprocess, the default is process.env.
\n
Example of running ls -lh /usr, capturing stdout, stderr, and the\nexit code:
\n
const spawn = require('child_process').spawn;\nconst ls = spawn('ls', ['-lh', '/usr']);\n\nls.stdout.on('data', (data) => {\n  console.log(`stdout: ${data}`);\n});\n\nls.stderr.on('data', (data) => {\n  console.log(`stderr: ${data}`);\n});\n\nls.on('close', (code) => {\n  console.log(`child process exited with code ${code}`);\n});\n
\n
Example: A very elaborate way to run 'ps ax | grep ssh'
\n
const spawn = require('child_process').spawn;\nconst ps = spawn('ps', ['ax']);\nconst grep = spawn('grep', ['ssh']);\n\nps.stdout.on('data', (data) => {\n  grep.stdin.write(data);\n});\n\nps.stderr.on('data', (data) => {\n  console.log(`ps stderr: ${data}`);\n});\n\nps.on('close', (code) => {\n  if (code !== 0) {\n    console.log(`ps process exited with code ${code}`);\n  }\n  grep.stdin.end();\n});\n\ngrep.stdout.on('data', (data) => {\n  console.log(`${data}`);\n});\n\ngrep.stderr.on('data', (data) => {\n  console.log(`grep stderr: ${data}`);\n});\n\ngrep.on('close', (code) => {\n  if (code !== 0) {\n    console.log(`grep process exited with code ${code}`);\n  }\n});\n
\n
Example of checking for failed exec:
\n
const spawn = require('child_process').spawn;\nconst child = spawn('bad_command');\n\nchild.on('error', (err) => {\n  console.log('Failed to start child process.');\n});\n
\n",
              "properties": [
                {
                  "textRaw": "options.detached",
                  "name": "detached",
                  "meta": {
                    "added": [
                      "v0.7.10"
                    ]
                  },
                  "desc": "
On Windows, setting options.detached to true makes it possible for the\nchild process to continue running after the parent exits. The child will have\nits own console window. Once enabled for a child process, it cannot be\ndisabled.
\n
On non-Windows platforms, if options.detached is set to true, the child\nprocess will be made the leader of a new process group and session. Note that\nchild processes may continue running after the parent exits regardless of\nwhether they are detached or not.  See setsid(2) for more information.
\n
By default, the parent will wait for the detached child to exit. To prevent\nthe parent from waiting for a given child, use the child.unref() method.\nDoing so will cause the parent's event loop to not include the child in its\nreference count, allowing the parent to exit independently of the child, unless\nthere is an established IPC channel between the child and parent.
\n
When using the detached option to start a long-running process, the process\nwill not stay running in the background after the parent exits unless it is\nprovided with a stdio configuration that is not connected to the parent.\nIf the parent's stdio is inherited, the child will remain attached to the\ncontrolling terminal.
\n
Example of a long-running process, by detaching and also ignoring its parent\nstdio file descriptors, in order to ignore the parent's termination:
\n
const spawn = require('child_process').spawn;\n\nconst child = spawn(process.argv[0], ['child_program.js'], {\n  detached: true,\n  stdio: 'ignore'\n});\n\nchild.unref();\n
\n
Alternatively one can redirect the child process' output into files:
\n
const fs = require('fs');\nconst spawn = require('child_process').spawn;\nconst out = fs.openSync('./out.log', 'a');\nconst err = fs.openSync('./out.log', 'a');\n\nconst child = spawn('prg', [], {\n detached: true,\n stdio: [ 'ignore', out, err ]\n});\n\nchild.unref();\n
\n"
                },
                {
                  "textRaw": "options.stdio",
                  "name": "stdio",
                  "meta": {
                    "added": [
                      "v0.7.10"
                    ]
                  },
                  "desc": "
The options.stdio option is used to configure the pipes that are established\nbetween the parent and child process. By default, the child's stdin, stdout,\nand stderr are redirected to corresponding child.stdin, child.stdout, and\nchild.stderr streams on the ChildProcess object. This is equivalent to\nsetting the options.stdio equal to ['pipe', 'pipe', 'pipe'].
\n
For convenience, options.stdio may be one of the following strings:
\n
    \n
  • 'pipe' - equivalent to ['pipe', 'pipe', 'pipe'] (the default)
    • \n
  • 'ignore' - equivalent to ['ignore', 'ignore', 'ignore']
    • \n
  • 'inherit' - equivalent to [process.stdin, process.stdout, process.stderr]\n or [0,1,2]
    • \n
\n
Otherwise, the value of option.stdio is an array where each index corresponds\nto an fd in the child. The fds 0, 1, and 2 correspond to stdin, stdout,\nand stderr, respectively. Additional fds can be specified to create additional\npipes between the parent and child. The value is one of the following:
\n
    \n
  1. 'pipe' - Create a pipe between the child process and the parent process.\nThe parent end of the pipe is exposed to the parent as a property on the\nchild_process object as ChildProcess.stdio[fd]. Pipes created for\nfds 0 - 2 are also available as ChildProcess.stdin, ChildProcess.stdout\nand ChildProcess.stderr, respectively.
    2. \n
  2. 'ipc' - Create an IPC channel for passing messages/file descriptors\nbetween parent and child. A ChildProcess may have at most one IPC stdio\nfile descriptor. Setting this option enables the ChildProcess.send() method.\nIf the child writes JSON messages to this file descriptor, the\nChildProcess.on('message') event handler will be triggered in the parent.\nIf the child is a Node.js process, the presence of an IPC channel will enable\nprocess.send(), process.disconnect(), process.on('disconnect'), and\nprocess.on('message') within the child.
    3. \n
  3. 'ignore' - Instructs Node.js to ignore the fd in the child. While Node.js\nwill always open fds 0 - 2 for the processes it spawns, setting the fd to\n'ignore' will cause Node.js to open /dev/null and attach it to the\nchild's fd.
    4. \n
  4. Stream object - Share a readable or writable stream that refers to a tty,\nfile, socket, or a pipe with the child process. The stream's underlying\nfile descriptor is duplicated in the child process to the fd that\ncorresponds to the index in the stdio array. Note that the stream must\nhave an underlying descriptor (file streams do not until the 'open'\nevent has occurred).
    5. \n
  5. Positive integer - The integer value is interpreted as a file descriptor\nthat is is currently open in the parent process. It is shared with the child\nprocess, similar to how Stream objects can be shared.
    6. \n
  6. null, undefined - Use default value. For stdio fds 0, 1 and 2 (in other\nwords, stdin, stdout, and stderr) a pipe is created. For fd 3 and up, the\ndefault is 'ignore'.
    7. \n
\n
Example:
\n
const spawn = require('child_process').spawn;\n\n// Child will use parent's stdios\nspawn('prg', [], { stdio: 'inherit' });\n\n// Spawn child sharing only stderr\nspawn('prg', [], { stdio: ['pipe', 'pipe', process.stderr] });\n\n// Open an extra fd=4, to interact with programs presenting a\n// startd-style interface.\nspawn('prg', [], { stdio: ['pipe', null, null, null, 'pipe'] });\n
\n
It is worth noting that when an IPC channel is established between the\nparent and child processes, and the child is a Node.js process, the child\nis launched with the IPC channel unreferenced (using unref()) until the\nchild registers an event handler for the process.on('disconnect') event\nor the process.on('message') event.This allows the child to exit normally\nwithout the process being held open by the open IPC channel.
\n
See also: child_process.exec() and child_process.fork()
\n"
                }
              ]
            }
          ],
          "type": "module",
          "displayName": "Asynchronous Process Creation"
        },
        {
          "textRaw": "Synchronous Process Creation",
          "name": "synchronous_process_creation",
          "desc": "
The child_process.spawnSync(), child_process.execSync(), and\nchild_process.execFileSync() methods are synchronous and WILL block\nthe Node.js event loop, pausing execution of any additional code until the\nspawned process exits.
\n
Blocking calls like these are mostly useful for simplifying general purpose\nscripting tasks and for simplifying the loading/processing of application\nconfiguration at startup.
\n",
          "methods": [
            {
              "textRaw": "child_process.execFileSync(file[, args][, options])",
              "type": "method",
              "name": "execFileSync",
              "meta": {
                "added": [
                  "v0.11.12"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Buffer|String} The stdout from the command ",
                    "name": "return",
                    "type": "Buffer|String",
                    "desc": "The stdout from the command"
                  },
                  "params": [
                    {
                      "textRaw": "`file` {String} The name or path of the executable file to run ",
                      "name": "file",
                      "type": "String",
                      "desc": "The name or path of the executable file to run"
                    },
                    {
                      "textRaw": "`args` {Array} List of string arguments ",
                      "name": "args",
                      "type": "Array",
                      "desc": "List of string arguments",
                      "optional": true
                    },
                    {
                      "textRaw": "`options` {Object} ",
                      "options": [
                        {
                          "textRaw": "`cwd` {String} Current working directory of the child process ",
                          "name": "cwd",
                          "type": "String",
                          "desc": "Current working directory of the child process"
                        },
                        {
                          "textRaw": "`input` {String|Buffer} The value which will be passed as stdin to the spawned process ",
                          "options": [
                            {
                              "textRaw": "supplying this value will override `stdio[0]` ",
                              "name": "supplying",
                              "desc": "this value will override `stdio[0]`"
                            }
                          ],
                          "name": "input",
                          "type": "String|Buffer",
                          "desc": "The value which will be passed as stdin to the spawned process"
                        },
                        {
                          "textRaw": "`stdio` {String|Array} Child's stdio configuration. (Default: 'pipe') ",
                          "options": [
                            {
                              "textRaw": "`stderr` by default will be output to the parent process' stderr unless `stdio` is specified ",
                              "name": "stderr",
                              "desc": "by default will be output to the parent process' stderr unless `stdio` is specified"
                            }
                          ],
                          "name": "stdio",
                          "default": "pipe",
                          "type": "String|Array",
                          "desc": "Child's stdio configuration."
                        },
                        {
                          "textRaw": "`env` {Object} Environment key-value pairs ",
                          "name": "env",
                          "type": "Object",
                          "desc": "Environment key-value pairs"
                        },
                        {
                          "textRaw": "`uid` {Number} Sets the user identity of the process. (See setuid(2).) ",
                          "name": "uid",
                          "type": "Number",
                          "desc": "Sets the user identity of the process. (See setuid(2).)"
                        },
                        {
                          "textRaw": "`gid` {Number} Sets the group identity of the process. (See setgid(2).) ",
                          "name": "gid",
                          "type": "Number",
                          "desc": "Sets the group identity of the process. (See setgid(2).)"
                        },
                        {
                          "textRaw": "`timeout` {Number} In milliseconds the maximum amount of time the process is allowed to run. (Default: undefined) ",
                          "name": "timeout",
                          "default": "undefined",
                          "type": "Number",
                          "desc": "In milliseconds the maximum amount of time the process is allowed to run."
                        },
                        {
                          "textRaw": "`killSignal` {String|Integer} The signal value to be used when the spawned process will be killed. (Default: 'SIGTERM') ",
                          "name": "killSignal",
                          "default": "SIGTERM",
                          "type": "String|Integer",
                          "desc": "The signal value to be used when the spawned process will be killed."
                        },
                        {
                          "textRaw": "`maxBuffer` {Number} largest amount of data (in bytes) allowed on stdout or stderr - if exceeded child process is killed ",
                          "name": "maxBuffer",
                          "type": "Number",
                          "desc": "largest amount of data (in bytes) allowed on stdout or stderr - if exceeded child process is killed"
                        },
                        {
                          "textRaw": "`encoding` {String} The encoding used for all stdio inputs and outputs. (Default: 'buffer') ",
                          "name": "encoding",
                          "default": "buffer",
                          "type": "String",
                          "desc": "The encoding used for all stdio inputs and outputs."
                        }
                      ],
                      "name": "options",
                      "type": "Object",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "file"
                    },
                    {
                      "name": "args",
                      "optional": true
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
The child_process.execFileSync() method is generally identical to\nchild_process.execFile() with the exception that the method will not return\nuntil the child process has fully closed. When a timeout has been encountered\nand killSignal is sent, the method won't return until the process has\ncompletely exited. Note that if the child process intercepts and handles\nthe SIGTERM signal and does not exit, the parent process will still wait\nuntil the child process has exited.
\n
If the process times out, or has a non-zero exit code, this method will\nthrow.  The Error object will contain the entire result from\nchild_process.spawnSync()
\n"
            },
            {
              "textRaw": "child_process.execSync(command[, options])",
              "type": "method",
              "name": "execSync",
              "meta": {
                "added": [
                  "v0.11.12"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Buffer|String} The stdout from the command ",
                    "name": "return",
                    "type": "Buffer|String",
                    "desc": "The stdout from the command"
                  },
                  "params": [
                    {
                      "textRaw": "`command` {String} The command to run ",
                      "name": "command",
                      "type": "String",
                      "desc": "The command to run"
                    },
                    {
                      "textRaw": "`options` {Object} ",
                      "options": [
                        {
                          "textRaw": "`cwd` {String} Current working directory of the child process ",
                          "name": "cwd",
                          "type": "String",
                          "desc": "Current working directory of the child process"
                        },
                        {
                          "textRaw": "`input` {String|Buffer} The value which will be passed as stdin to the spawned process ",
                          "options": [
                            {
                              "textRaw": "supplying this value will override `stdio[0]` ",
                              "name": "supplying",
                              "desc": "this value will override `stdio[0]`"
                            }
                          ],
                          "name": "input",
                          "type": "String|Buffer",
                          "desc": "The value which will be passed as stdin to the spawned process"
                        },
                        {
                          "textRaw": "`stdio` {String|Array} Child's stdio configuration. (Default: 'pipe') ",
                          "options": [
                            {
                              "textRaw": "`stderr` by default will be output to the parent process' stderr unless `stdio` is specified ",
                              "name": "stderr",
                              "desc": "by default will be output to the parent process' stderr unless `stdio` is specified"
                            }
                          ],
                          "name": "stdio",
                          "default": "pipe",
                          "type": "String|Array",
                          "desc": "Child's stdio configuration."
                        },
                        {
                          "textRaw": "`env` {Object} Environment key-value pairs ",
                          "name": "env",
                          "type": "Object",
                          "desc": "Environment key-value pairs"
                        },
                        {
                          "textRaw": "`shell` {String} Shell to execute the command with (Default: '/bin/sh' on UNIX, 'cmd.exe' on Windows,  The shell should  understand the `-c` switch on UNIX or `/s /c` on Windows. On Windows,  command line parsing should be compatible with `cmd.exe`.) ",
                          "name": "shell",
                          "type": "String",
                          "desc": "Shell to execute the command with (Default: '/bin/sh' on UNIX, 'cmd.exe' on Windows,  The shell should  understand the `-c` switch on UNIX or `/s /c` on Windows. On Windows,  command line parsing should be compatible with `cmd.exe`.)"
                        },
                        {
                          "textRaw": "`uid` {Number} Sets the user identity of the process. (See setuid(2).) ",
                          "name": "uid",
                          "type": "Number",
                          "desc": "Sets the user identity of the process. (See setuid(2).)"
                        },
                        {
                          "textRaw": "`gid` {Number} Sets the group identity of the process. (See setgid(2).) ",
                          "name": "gid",
                          "type": "Number",
                          "desc": "Sets the group identity of the process. (See setgid(2).)"
                        },
                        {
                          "textRaw": "`timeout` {Number} In milliseconds the maximum amount of time the process is allowed to run. (Default: undefined) ",
                          "name": "timeout",
                          "default": "undefined",
                          "type": "Number",
                          "desc": "In milliseconds the maximum amount of time the process is allowed to run."
                        },
                        {
                          "textRaw": "`killSignal` {String|Integer} The signal value to be used when the spawned process will be killed. (Default: 'SIGTERM') ",
                          "name": "killSignal",
                          "default": "SIGTERM",
                          "type": "String|Integer",
                          "desc": "The signal value to be used when the spawned process will be killed."
                        },
                        {
                          "textRaw": "`maxBuffer` {Number} largest amount of data (in bytes) allowed on stdout or stderr - if exceeded child process is killed ",
                          "name": "maxBuffer",
                          "type": "Number",
                          "desc": "largest amount of data (in bytes) allowed on stdout or stderr - if exceeded child process is killed"
                        },
                        {
                          "textRaw": "`encoding` {String} The encoding used for all stdio inputs and outputs. (Default: 'buffer') ",
                          "name": "encoding",
                          "default": "buffer",
                          "type": "String",
                          "desc": "The encoding used for all stdio inputs and outputs."
                        }
                      ],
                      "name": "options",
                      "type": "Object",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "command"
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
The child_process.execSync() method is generally identical to\nchild_process.exec() with the exception that the method will not return until\nthe child process has fully closed. When a timeout has been encountered and\nkillSignal is sent, the method won't return until the process has completely\nexited. Note that if  the child process intercepts and handles the SIGTERM\nsignal and doesn't exit, the parent process will wait until the child\nprocess has exited.
\n
If the process times out, or has a non-zero exit code, this method will\nthrow.  The Error object will contain the entire result from\nchild_process.spawnSync()
\n
Note: Never pass unsanitised user input to this function. Any input\ncontaining shell metacharacters may be used to trigger arbitrary command\nexecution.
\n"
            },
            {
              "textRaw": "child_process.spawnSync(command[, args][, options])",
              "type": "method",
              "name": "spawnSync",
              "meta": {
                "added": [
                  "v0.11.12"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Object} ",
                    "options": [
                      {
                        "textRaw": "`pid` {Number} Pid of the child process ",
                        "name": "pid",
                        "type": "Number",
                        "desc": "Pid of the child process"
                      },
                      {
                        "textRaw": "`output` {Array} Array of results from stdio output ",
                        "name": "output",
                        "type": "Array",
                        "desc": "Array of results from stdio output"
                      },
                      {
                        "textRaw": "`stdout` {Buffer|String} The contents of `output[1]` ",
                        "name": "stdout",
                        "type": "Buffer|String",
                        "desc": "The contents of `output[1]`"
                      },
                      {
                        "textRaw": "`stderr` {Buffer|String} The contents of `output[2]` ",
                        "name": "stderr",
                        "type": "Buffer|String",
                        "desc": "The contents of `output[2]`"
                      },
                      {
                        "textRaw": "`status` {Number} The exit code of the child process ",
                        "name": "status",
                        "type": "Number",
                        "desc": "The exit code of the child process"
                      },
                      {
                        "textRaw": "`signal` {String} The signal used to kill the child process ",
                        "name": "signal",
                        "type": "String",
                        "desc": "The signal used to kill the child process"
                      },
                      {
                        "textRaw": "`error` {Error} The error object if the child process failed or timed out ",
                        "name": "error",
                        "type": "Error",
                        "desc": "The error object if the child process failed or timed out"
                      }
                    ],
                    "name": "return",
                    "type": "Object"
                  },
                  "params": [
                    {
                      "textRaw": "`command` {String} The command to run ",
                      "name": "command",
                      "type": "String",
                      "desc": "The command to run"
                    },
                    {
                      "textRaw": "`args` {Array} List of string arguments ",
                      "name": "args",
                      "type": "Array",
                      "desc": "List of string arguments",
                      "optional": true
                    },
                    {
                      "textRaw": "`options` {Object} ",
                      "options": [
                        {
                          "textRaw": "`cwd` {String} Current working directory of the child process ",
                          "name": "cwd",
                          "type": "String",
                          "desc": "Current working directory of the child process"
                        },
                        {
                          "textRaw": "`input` {String|Buffer} The value which will be passed as stdin to the spawned process ",
                          "options": [
                            {
                              "textRaw": "supplying this value will override `stdio[0]` ",
                              "name": "supplying",
                              "desc": "this value will override `stdio[0]`"
                            }
                          ],
                          "name": "input",
                          "type": "String|Buffer",
                          "desc": "The value which will be passed as stdin to the spawned process"
                        },
                        {
                          "textRaw": "`stdio` {String|Array} Child's stdio configuration. (Default: 'pipe') ",
                          "name": "stdio",
                          "default": "pipe",
                          "type": "String|Array",
                          "desc": "Child's stdio configuration."
                        },
                        {
                          "textRaw": "`env` {Object} Environment key-value pairs ",
                          "name": "env",
                          "type": "Object",
                          "desc": "Environment key-value pairs"
                        },
                        {
                          "textRaw": "`uid` {Number} Sets the user identity of the process. (See setuid(2).) ",
                          "name": "uid",
                          "type": "Number",
                          "desc": "Sets the user identity of the process. (See setuid(2).)"
                        },
                        {
                          "textRaw": "`gid` {Number} Sets the group identity of the process. (See setgid(2).) ",
                          "name": "gid",
                          "type": "Number",
                          "desc": "Sets the group identity of the process. (See setgid(2).)"
                        },
                        {
                          "textRaw": "`timeout` {Number} In milliseconds the maximum amount of time the process is allowed to run. (Default: undefined) ",
                          "name": "timeout",
                          "default": "undefined",
                          "type": "Number",
                          "desc": "In milliseconds the maximum amount of time the process is allowed to run."
                        },
                        {
                          "textRaw": "`killSignal` {String|Integer} The signal value to be used when the spawned process will be killed. (Default: 'SIGTERM') ",
                          "name": "killSignal",
                          "default": "SIGTERM",
                          "type": "String|Integer",
                          "desc": "The signal value to be used when the spawned process will be killed."
                        },
                        {
                          "textRaw": "`maxBuffer` {Number} largest amount of data (in bytes) allowed on stdout or stderr - if exceeded child process is killed ",
                          "name": "maxBuffer",
                          "type": "Number",
                          "desc": "largest amount of data (in bytes) allowed on stdout or stderr - if exceeded child process is killed"
                        },
                        {
                          "textRaw": "`encoding` {String} The encoding used for all stdio inputs and outputs. (Default: 'buffer') ",
                          "name": "encoding",
                          "default": "buffer",
                          "type": "String",
                          "desc": "The encoding used for all stdio inputs and outputs."
                        },
                        {
                          "textRaw": "`shell` {Boolean|String} If `true`, runs `command` inside of a shell. Uses '/bin/sh' on UNIX, and 'cmd.exe' on Windows. A different shell can be specified as a string. The shell should understand the `-c` switch on UNIX, or `/s /c` on Windows. Defaults to `false` (no shell). ",
                          "name": "shell",
                          "type": "Boolean|String",
                          "desc": "If `true`, runs `command` inside of a shell. Uses '/bin/sh' on UNIX, and 'cmd.exe' on Windows. A different shell can be specified as a string. The shell should understand the `-c` switch on UNIX, or `/s /c` on Windows. Defaults to `false` (no shell)."
                        }
                      ],
                      "name": "options",
                      "type": "Object",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "command"
                    },
                    {
                      "name": "args",
                      "optional": true
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
The child_process.spawnSync() method is generally identical to\nchild_process.spawn() with the exception that the function will not return\nuntil the child process has fully closed. When a timeout has been encountered\nand killSignal is sent, the method won't return until the process has\ncompletely exited. Note that if the process intercepts and handles the\nSIGTERM signal and doesn't exit, the parent process will wait until the child\nprocess has exited.
\n
Note: If the shell option is enabled, do not pass unsanitised user input to\nthis function. Any input containing shell metacharacters may be used to\ntrigger arbitrary command execution.
\n"
            }
          ],
          "type": "module",
          "displayName": "Synchronous Process Creation"
        }
      ],
      "classes": [
        {
          "textRaw": "Class: ChildProcess",
          "type": "class",
          "name": "ChildProcess",
          "meta": {
            "added": [
              "v2.2.0"
            ]
          },
          "desc": "
Instances of the ChildProcess class are EventEmitters that represent\nspawned child processes.
\n
Instances of ChildProcess are not intended to be created directly. Rather,\nuse the child_process.spawn(), child_process.exec(),\nchild_process.execFile(), or child_process.fork() methods to create\ninstances of ChildProcess.
\n",
          "events": [
            {
              "textRaw": "Event: 'close'",
              "type": "event",
              "name": "close",
              "meta": {
                "added": [
                  "v0.7.7"
                ]
              },
              "params": [],
              "desc": "
The 'close' event is emitted when the stdio streams of a child process have\nbeen closed. This is distinct from the 'exit' event, since multiple\nprocesses might share the same stdio streams.
\n"
            },
            {
              "textRaw": "Event: 'disconnect'",
              "type": "event",
              "name": "disconnect",
              "meta": {
                "added": [
                  "v0.7.2"
                ]
              },
              "desc": "
The 'disconnect' event is emitted after calling the\nChildProcess.disconnect() method in the parent or child process. After\ndisconnecting it is no longer possible to send or receive messages, and the\nChildProcess.connected property is false.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'error'",
              "type": "event",
              "name": "error",
              "params": [],
              "desc": "
The 'error' event is emitted whenever:
\n
    \n
  1. The process could not be spawned, or
    2. \n
  2. The process could not be killed, or
    3. \n
  3. Sending a message to the child process failed.
    4. \n
\n
Note that the 'exit' event may or may not fire after an error has occurred.\nIf you are listening to both the 'exit' and 'error' events, it is important\nto guard against accidentally invoking handler functions multiple times.
\n
See also ChildProcess#kill() and ChildProcess#send().
\n"
            },
            {
              "textRaw": "Event: 'exit'",
              "type": "event",
              "name": "exit",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "params": [],
              "desc": "
The 'exit' event is emitted after the child process ends. If the process\nexited, code is the final exit code of the process, otherwise null. If the\nprocess terminated due to receipt of a signal, signal is the string name of\nthe signal, otherwise null. One of the two will always be non-null.
\n
Note that when the 'exit' event is triggered, child process stdio streams\nmight still be open.
\n
Also, note that Node.js establishes signal handlers for SIGINT and\nSIGTERM and Node.js processes will not terminate immediately due to receipt\nof those signals. Rather, Node.js will perform a sequence of cleanup actions\nand then will re-raise the handled signal.
\n
See waitpid(2).
\n"
            },
            {
              "textRaw": "Event: 'message'",
              "type": "event",
              "name": "message",
              "meta": {
                "added": [
                  "v0.5.9"
                ]
              },
              "params": [],
              "desc": "
The 'message' event is triggered when a child process uses process.send()\nto send messages.
\n"
            }
          ],
          "properties": [
            {
              "textRaw": "`connected` {Boolean} Set to false after `.disconnect` is called ",
              "type": "Boolean",
              "name": "connected",
              "meta": {
                "added": [
                  "v0.7.2"
                ]
              },
              "desc": "
The child.connected property indicates whether it is still possible to send\nand receive messages from a child process. When child.connected is false, it\nis no longer possible to send or receive messages.
\n",
              "shortDesc": "Set to false after `.disconnect` is called"
            },
            {
              "textRaw": "`pid` {Number} Integer ",
              "type": "Number",
              "name": "pid",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Returns the process identifier (PID) of the child process.
\n
Example:
\n
const spawn = require('child_process').spawn;\nconst grep = spawn('grep', ['ssh']);\n\nconsole.log(`Spawned child pid: ${grep.pid}`);\ngrep.stdin.end();\n
\n",
              "shortDesc": "Integer"
            },
            {
              "textRaw": "`stderr` {Stream} ",
              "type": "Stream",
              "name": "stderr",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
A Readable Stream that represents the child process's stderr.
\n
If the child was spawned with stdio[2] set to anything other than 'pipe',\nthen this will be undefined.
\n
child.stderr is an alias for child.stdio[2]. Both properties will refer to\nthe same value.
\n"
            },
            {
              "textRaw": "`stdin` {Stream} ",
              "type": "Stream",
              "name": "stdin",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
A Writable Stream that represents the child process's stdin.
\n
Note that if a child process waits to read all of its input, the child will not\ncontinue until this stream has been closed via end().
\n
If the child was spawned with stdio[0] set to anything other than 'pipe',\nthen this will be undefined.
\n
child.stdin is an alias for child.stdio[0]. Both properties will refer to\nthe same value.
\n"
            },
            {
              "textRaw": "`stdio` {Array} ",
              "type": "Array",
              "name": "stdio",
              "meta": {
                "added": [
                  "v0.7.10"
                ]
              },
              "desc": "
A sparse array of pipes to the child process, corresponding with positions in\nthe stdio option passed to child_process.spawn() that have been set\nto the value 'pipe'. Note that child.stdio[0], child.stdio[1], and\nchild.stdio[2] are also available as child.stdin, child.stdout, and\nchild.stderr, respectively.
\n
In the following example, only the child's fd 1 (stdout) is configured as a\npipe, so only the parent's child.stdio[1] is a stream, all other values in\nthe array are null.
\n
const assert = require('assert');\nconst fs = require('fs');\nconst child_process = require('child_process');\n\nconst child = child_process.spawn('ls', {\n    stdio: [\n      0, // Use parents stdin for child\n      'pipe', // Pipe child's stdout to parent\n      fs.openSync('err.out', 'w') // Direct child's stderr to a file\n    ]\n});\n\nassert.equal(child.stdio[0], null);\nassert.equal(child.stdio[0], child.stdin);\n\nassert(child.stdout);\nassert.equal(child.stdio[1], child.stdout);\n\nassert.equal(child.stdio[2], null);\nassert.equal(child.stdio[2], child.stderr);\n
\n"
            },
            {
              "textRaw": "`stdout` {Stream} ",
              "type": "Stream",
              "name": "stdout",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
A Readable Stream that represents the child process's stdout.
\n
If the child was spawned with stdio[1] set to anything other than 'pipe',\nthen this will be undefined.
\n
child.stdout is an alias for child.stdio[1]. Both properties will refer\nto the same value.
\n\n\n"
            }
          ],
          "methods": [
            {
              "textRaw": "child.disconnect()",
              "type": "method",
              "name": "disconnect",
              "meta": {
                "added": [
                  "v0.7.2"
                ]
              },
              "desc": "
Closes the IPC channel between parent and child, allowing the child to exit\ngracefully once there are no other connections keeping it alive. After calling\nthis method the child.connected and process.connected properties in both\nthe parent and child (respectively) will be set to false, and it will be no\nlonger possible to pass messages between the processes.
\n
The 'disconnect' event will be emitted when there are no messages in the\nprocess of being received. This will most often be triggered immediately after\ncalling child.disconnect().
\n
Note that when the child process is a Node.js instance (e.g. spawned using\nchild_process.fork()), the process.disconnect() method can be invoked\nwithin the child process to close the IPC channel as well.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "child.kill([signal])",
              "type": "method",
              "name": "kill",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`signal` {String} ",
                      "name": "signal",
                      "type": "String",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "signal",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
The child.kill() methods sends a signal to the child process. If no argument\nis given, the process will be sent the 'SIGTERM' signal. See signal(7) for\na list of available signals.
\n
const spawn = require('child_process').spawn;\nconst grep = spawn('grep', ['ssh']);\n\ngrep.on('close', (code, signal) => {\n  console.log(\n    `child process terminated due to receipt of signal ${signal}`);\n});\n\n// Send SIGHUP to process\ngrep.kill('SIGHUP');\n
\n
The ChildProcess object may emit an 'error' event if the signal cannot be\ndelivered. Sending a signal to a child process that has already exited is not\nan error but may have unforeseen consequences. Specifically, if the process\nidentifier (PID) has been reassigned to another process, the signal will be\ndelivered to that process instead which can have unexpected results.
\n
Note that while the function is called kill, the signal delivered to the\nchild process may not actually terminate the process.
\n
See kill(2) for reference.
\n
Also note: on Linux, child processes of child processes will not be terminated\nwhen attempting to kill their parent. This is likely to happen when running a\nnew process in a shell or with use of the shell option of ChildProcess, such\nas in this example:
\n
'use strict';\nconst spawn = require('child_process').spawn;\n\nlet child = spawn('sh', ['-c',\n  `node -e "setInterval(() => {\n      console.log(process.pid, 'is alive')\n    }, 500);"`\n  ], {\n    stdio: ['inherit', 'inherit', 'inherit']\n  });\n\nsetTimeout(() => {\n  child.kill(); // does not terminate the node process in the shell\n}, 2000);\n
\n"
            },
            {
              "textRaw": "child.send(message[, sendHandle][, callback])",
              "type": "method",
              "name": "send",
              "meta": {
                "added": [
                  "v0.5.9"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Boolean} ",
                    "name": "return",
                    "type": "Boolean"
                  },
                  "params": [
                    {
                      "textRaw": "`message` {Object} ",
                      "name": "message",
                      "type": "Object"
                    },
                    {
                      "textRaw": "`sendHandle` {Handle} ",
                      "name": "sendHandle",
                      "type": "Handle",
                      "optional": true
                    },
                    {
                      "textRaw": "`callback` {Function} ",
                      "name": "callback",
                      "type": "Function",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "message"
                    },
                    {
                      "name": "sendHandle",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
When an IPC channel has been established between the parent and child (\ni.e. when using child_process.fork()), the child.send() method can be\nused to send messages to the child process. When the child process is a Node.js\ninstance, these messages can be received via the process.on('message') event.
\n
For example, in the parent script:
\n
const cp = require('child_process');\nconst n = cp.fork(`${__dirname}/sub.js`);\n\nn.on('message', (m) => {\n  console.log('PARENT got message:', m);\n});\n\nn.send({ hello: 'world' });\n
\n
And then the child script, 'sub.js' might look like this:
\n
process.on('message', (m) => {\n  console.log('CHILD got message:', m);\n});\n\nprocess.send({ foo: 'bar' });\n
\n
Child Node.js processes will have a process.send() method of their own that\nallows the child to send messages back to the parent.
\n
There is a special case when sending a {cmd: 'NODE_foo'} message. All messages\ncontaining a NODE_ prefix in its cmd property are considered to be reserved\nfor use within Node.js core and will not be emitted in the child's\nprocess.on('message') event. Rather, such messages are emitted using the\nprocess.on('internalMessage') event and are consumed internally by Node.js.\nApplications should avoid using such messages or listening for\n'internalMessage' events as it is subject to change without notice.
\n
The optional sendHandle argument that may be passed to child.send() is for\npassing a TCP server or socket object to the child process. The child will\nreceive the object as the second argument passed to the callback function\nregistered on the process.on('message') event. Any data that is received and\nbuffered in the socket will not be sent to the child.
\n
The optional callback is a function that is invoked after the message is\nsent but before the child may have received it.  The function is called with a\nsingle argument: null on success, or an Error object on failure.
\n
If no callback function is provided and the message cannot be sent, an\n'error' event will be emitted by the ChildProcess object. This can happen,\nfor instance, when the child process has already exited.
\n
child.send() will return false if the channel has closed or when the\nbacklog of unsent messages exceeds a threshold that makes it unwise to send\nmore. Otherwise, the method returns true. The callback function can be\nused to implement flow control.
\n
Example: sending a server object
\n
The sendHandle argument can be used, for instance, to pass the handle of\na TCP server object to the child process as illustrated in the example below:
\n
const child = require('child_process').fork('child.js');\n\n// Open up the server object and send the handle.\nconst server = require('net').createServer();\nserver.on('connection', (socket) => {\n  socket.end('handled by parent');\n});\nserver.listen(1337, () => {\n  child.send('server', server);\n});\n
\n
The child would then receive the server object as:
\n
process.on('message', (m, server) => {\n  if (m === 'server') {\n    server.on('connection', (socket) => {\n      socket.end('handled by child');\n    });\n  }\n});\n
\n
Once the server is now shared between the parent and child, some connections\ncan be handled by the parent and some by the child.
\n
While the example above uses a server created using the net module, dgram\nmodule servers use exactly the same workflow with the exceptions of listening on\na 'message' event instead of 'connection' and using server.bind instead of\nserver.listen. This is, however, currently only supported on UNIX platforms.
\n
Example: sending a socket object
\n
Similarly, the sendHandler argument can be used to pass the handle of a\nsocket to the child process. The example below spawns two children that each\nhandle connections with "normal" or "special" priority:
\n
const normal = require('child_process').fork('child.js', ['normal']);\nconst special = require('child_process').fork('child.js', ['special']);\n\n// Open up the server and send sockets to child\nconst server = require('net').createServer();\nserver.on('connection', (socket) => {\n\n  // If this is special priority\n  if (socket.remoteAddress === '74.125.127.100') {\n    special.send('socket', socket);\n    return;\n  }\n  // This is normal priority\n  normal.send('socket', socket);\n});\nserver.listen(1337);\n
\n
The child.js would receive the socket handle as the second argument passed\nto the event callback function:
\n
process.on('message', (m, socket) => {\n  if (m === 'socket') {\n    socket.end(`Request handled with ${process.argv[2]} priority`);\n  }\n});\n
\n
Once a socket has been passed to a child, the parent is no longer capable of\ntracking when the socket is destroyed. To indicate this, the .connections\nproperty becomes null. It is recommended not to use .maxConnections when\nthis occurs.
\n
Note: this function uses JSON.stringify() internally to serialize the message.
\n"
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "Child Process"
    },
    {
      "textRaw": "Cluster",
      "name": "cluster",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
A single instance of Node.js runs in a single thread. To take advantage of\nmulti-core systems the user will sometimes want to launch a cluster of Node.js\nprocesses to handle the load.
\n
The cluster module allows you to easily create child processes that\nall share server ports.
\n
const cluster = require('cluster');\nconst http = require('http');\nconst numCPUs = require('os').cpus().length;\n\nif (cluster.isMaster) {\n  // Fork workers.\n  for (var i = 0; i < numCPUs; i++) {\n    cluster.fork();\n  }\n\n  cluster.on('exit', (worker, code, signal) => {\n    console.log(`worker ${worker.process.pid} died`);\n  });\n} else {\n  // Workers can share any TCP connection\n  // In this case it is an HTTP server\n  http.createServer((req, res) => {\n    res.writeHead(200);\n    res.end('hello world\\n');\n  }).listen(8000);\n}\n
\n
Running Node.js will now share port 8000 between the workers:
\n
$ NODE_DEBUG=cluster node server.js\n23521,Master Worker 23524 online\n23521,Master Worker 23526 online\n23521,Master Worker 23523 online\n23521,Master Worker 23528 online\n
Please note that, on Windows, it is not yet possible to set up a named pipe\nserver in a worker.
\n",
      "miscs": [
        {
          "textRaw": "How It Works",
          "name": "How It Works",
          "type": "misc",
          "desc": "
The worker processes are spawned using the child_process.fork() method,\nso that they can communicate with the parent via IPC and pass server\nhandles back and forth.
\n
The cluster module supports two methods of distributing incoming\nconnections.
\n
The first one (and the default one on all platforms except Windows),\nis the round-robin approach, where the master process listens on a\nport, accepts new connections and distributes them across the workers\nin a round-robin fashion, with some built-in smarts to avoid\noverloading a worker process.
\n
The second approach is where the master process creates the listen\nsocket and sends it to interested workers. The workers then accept\nincoming connections directly.
\n
The second approach should, in theory, give the best performance.\nIn practice however, distribution tends to be very unbalanced due\nto operating system scheduler vagaries. Loads have been observed\nwhere over 70% of all connections ended up in just two processes,\nout of a total of eight.
\n
Because server.listen() hands off most of the work to the master\nprocess, there are three cases where the behavior between a normal\nNode.js process and a cluster worker differs:
\n
    \n
  1. server.listen({fd: 7}) Because the message is passed to the master,\nfile descriptor 7 in the parent will be listened on, and the\nhandle passed to the worker, rather than listening to the worker's\nidea of what the number 7 file descriptor references.
    2. \n
  2. server.listen(handle) Listening on handles explicitly will cause\nthe worker to use the supplied handle, rather than talk to the master\nprocess.  If the worker already has the handle, then it's presumed\nthat you know what you are doing.
    3. \n
  3. server.listen(0) Normally, this will cause servers to listen on a\nrandom port.  However, in a cluster, each worker will receive the\nsame "random" port each time they do listen(0).  In essence, the\nport is random the first time, but predictable thereafter.  If you\nwant to listen on a unique port, generate a port number based on the\ncluster worker ID.
    4. \n
\n
There is no routing logic in Node.js, or in your program, and no shared\nstate between the workers.  Therefore, it is important to design your\nprogram such that it does not rely too heavily on in-memory data objects\nfor things like sessions and login.
\n
Because workers are all separate processes, they can be killed or\nre-spawned depending on your program's needs, without affecting other\nworkers.  As long as there are some workers still alive, the server will\ncontinue to accept connections.  If no workers are alive, existing connections\nwill be dropped and new connections will be refused.  Node.js does not\nautomatically manage the number of workers for you, however.  It is your\nresponsibility to manage the worker pool for your application's needs.
\n"
        }
      ],
      "classes": [
        {
          "textRaw": "Class: Worker",
          "type": "class",
          "name": "Worker",
          "meta": {
            "added": [
              "v0.7.0"
            ]
          },
          "desc": "
A Worker object contains all public information and method about a worker.\nIn the master it can be obtained using cluster.workers. In a worker\nit can be obtained using cluster.worker.
\n",
          "events": [
            {
              "textRaw": "Event: 'disconnect'",
              "type": "event",
              "name": "disconnect",
              "meta": {
                "added": [
                  "v0.7.7"
                ]
              },
              "desc": "
Similar to the cluster.on('disconnect') event, but specific to this worker.
\n
cluster.fork().on('disconnect', () => {\n  // Worker has disconnected\n});\n
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'error'",
              "type": "event",
              "name": "error",
              "meta": {
                "added": [
                  "v0.7.3"
                ]
              },
              "desc": "
This event is the same as the one provided by child_process.fork().
\n
In a worker you can also use process.on('error').
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'exit'",
              "type": "event",
              "name": "exit",
              "meta": {
                "added": [
                  "v0.11.2"
                ]
              },
              "params": [],
              "desc": "
Similar to the cluster.on('exit') event, but specific to this worker.
\n
const worker = cluster.fork();\nworker.on('exit', (code, signal) => {\n  if (signal) {\n    console.log(`worker was killed by signal: ${signal}`);\n  } else if (code !== 0) {\n    console.log(`worker exited with error code: ${code}`);\n  } else {\n    console.log('worker success!');\n  }\n});\n
\n"
            },
            {
              "textRaw": "Event: 'listening'",
              "type": "event",
              "name": "listening",
              "meta": {
                "added": [
                  "v0.7.0"
                ]
              },
              "params": [],
              "desc": "
Similar to the cluster.on('listening') event, but specific to this worker.
\n
cluster.fork().on('listening', (address) => {\n  // Worker is listening\n});\n
\n
It is not emitted in the worker.
\n"
            },
            {
              "textRaw": "Event: 'message'",
              "type": "event",
              "name": "message",
              "meta": {
                "added": [
                  "v0.7.0"
                ]
              },
              "params": [],
              "desc": "
Similar to the cluster.on('message') event, but specific to this worker. In a\nworker you can also use process.on('message').
\n
See process event: 'message'.
\n
As an example, here is a cluster that keeps count of the number of requests\nin the master process using the message system:
\n
const cluster = require('cluster');\nconst http = require('http');\n\nif (cluster.isMaster) {\n\n  // Keep track of http requests\n  var numReqs = 0;\n  setInterval(() => {\n    console.log('numReqs =', numReqs);\n  }, 1000);\n\n  // Count requests\n  function messageHandler(msg) {\n    if (msg.cmd && msg.cmd == 'notifyRequest') {\n      numReqs += 1;\n    }\n  }\n\n  // Start workers and listen for messages containing notifyRequest\n  const numCPUs = require('os').cpus().length;\n  for (var i = 0; i < numCPUs; i++) {\n    cluster.fork();\n  }\n\n  Object.keys(cluster.workers).forEach((id) => {\n    cluster.workers[id].on('message', messageHandler);\n  });\n\n} else {\n\n  // Worker processes have a http server.\n  http.Server((req, res) => {\n    res.writeHead(200);\n    res.end('hello world\\n');\n\n    // notify master about the request\n    process.send({ cmd: 'notifyRequest' });\n  }).listen(8000);\n}\n
\n"
            },
            {
              "textRaw": "Event: 'online'",
              "type": "event",
              "name": "online",
              "meta": {
                "added": [
                  "v0.7.0"
                ]
              },
              "desc": "
Similar to the cluster.on('online') event, but specific to this worker.
\n
cluster.fork().on('online', () => {\n  // Worker is online\n});\n
\n
It is not emitted in the worker.
\n",
              "params": []
            }
          ],
          "methods": [
            {
              "textRaw": "worker.disconnect()",
              "type": "method",
              "name": "disconnect",
              "meta": {
                "added": [
                  "v0.7.7"
                ]
              },
              "desc": "
In a worker, this function will close all servers, wait for the 'close' event on\nthose servers, and then disconnect the IPC channel.
\n
In the master, an internal message is sent to the worker causing it to call\n.disconnect() on itself.
\n
Causes .suicide to be set.
\n
Note that after a server is closed, it will no longer accept new connections,\nbut connections may be accepted by any other listening worker. Existing\nconnections will be allowed to close as usual. When no more connections exist,\nsee server.close(), the IPC channel to the worker will close allowing it to\ndie gracefully.
\n
The above applies only to server connections, client connections are not\nautomatically closed by workers, and disconnect does not wait for them to close\nbefore exiting.
\n
Note that in a worker, process.disconnect exists, but it is not this function,\nit is disconnect.
\n
Because long living server connections may block workers from disconnecting, it\nmay be useful to send a message, so application specific actions may be taken to\nclose them. It also may be useful to implement a timeout, killing a worker if\nthe 'disconnect' event has not been emitted after some time.
\n
if (cluster.isMaster) {\n  var worker = cluster.fork();\n  var timeout;\n\n  worker.on('listening', (address) => {\n    worker.send('shutdown');\n    worker.disconnect();\n    timeout = setTimeout(() => {\n      worker.kill();\n    }, 2000);\n  });\n\n  worker.on('disconnect', () => {\n    clearTimeout(timeout);\n  });\n\n} else if (cluster.isWorker) {\n  const net = require('net');\n  var server = net.createServer((socket) => {\n    // connections never end\n  });\n\n  server.listen(8000);\n\n  process.on('message', (msg) => {\n    if (msg === 'shutdown') {\n      // initiate graceful close of any connections to server\n    }\n  });\n}\n
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "worker.isConnected()",
              "type": "method",
              "name": "isConnected",
              "meta": {
                "added": [
                  "v0.11.14"
                ]
              },
              "desc": "
This function returns true if the worker is connected to its master via its IPC\nchannel, false otherwise. A worker is connected to its master after it's been\ncreated. It is disconnected after the 'disconnect' event is emitted.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "worker.isDead()",
              "type": "method",
              "name": "isDead",
              "meta": {
                "added": [
                  "v0.11.14"
                ]
              },
              "desc": "
This function returns true if the worker's process has terminated (either\nbecause of exiting or being signaled). Otherwise, it returns false.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "worker.kill([signal='SIGTERM'])",
              "type": "method",
              "name": "kill",
              "meta": {
                "added": [
                  "v0.9.12"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`signal` {String} Name of the kill signal to send to the worker process. ",
                      "name": "signal",
                      "type": "String",
                      "desc": "Name of the kill signal to send to the worker process.",
                      "optional": true,
                      "default": "'SIGTERM'"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "signal",
                      "optional": true,
                      "default": "'SIGTERM'"
                    }
                  ]
                }
              ],
              "desc": "
This function will kill the worker. In the master, it does this by disconnecting\nthe worker.process, and once disconnected, killing with signal. In the\nworker, it does it by disconnecting the channel, and then exiting with code 0.
\n
Causes .suicide to be set.
\n
This method is aliased as worker.destroy() for backwards compatibility.
\n
Note that in a worker, process.kill() exists, but it is not this function,\nit is kill.
\n"
            },
            {
              "textRaw": "worker.send(message[, sendHandle][, callback])",
              "type": "method",
              "name": "send",
              "meta": {
                "added": [
                  "v0.7.0"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: Boolean ",
                    "name": "return",
                    "desc": "Boolean"
                  },
                  "params": [
                    {
                      "textRaw": "`message` {Object} ",
                      "name": "message",
                      "type": "Object"
                    },
                    {
                      "textRaw": "`sendHandle` {Handle} ",
                      "name": "sendHandle",
                      "type": "Handle",
                      "optional": true
                    },
                    {
                      "textRaw": "`callback` {Function} ",
                      "name": "callback",
                      "type": "Function",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "message"
                    },
                    {
                      "name": "sendHandle",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Send a message to a worker or master, optionally with a handle.
\n
In the master this sends a message to a specific worker. It is identical to\nChildProcess.send().
\n
In a worker this sends a message to the master. It is identical to\nprocess.send().
\n
This example will echo back all messages from the master:
\n
if (cluster.isMaster) {\n  var worker = cluster.fork();\n  worker.send('hi there');\n\n} else if (cluster.isWorker) {\n  process.on('message', (msg) => {\n    process.send(msg);\n  });\n}\n
\n"
            }
          ],
          "properties": [
            {
              "textRaw": "`id` {Number} ",
              "type": "Number",
              "name": "id",
              "meta": {
                "added": [
                  "v0.8.0"
                ]
              },
              "desc": "
Each new worker is given its own unique id, this id is stored in the\nid.
\n
While a worker is alive, this is the key that indexes it in\ncluster.workers
\n"
            },
            {
              "textRaw": "`process` {ChildProcess} ",
              "type": "ChildProcess",
              "name": "process",
              "meta": {
                "added": [
                  "v0.7.0"
                ]
              },
              "desc": "
All workers are created using child_process.fork(), the returned object\nfrom this function is stored as .process. In a worker, the global process\nis stored.
\n
See: Child Process module
\n
Note that workers will call process.exit(0) if the 'disconnect' event occurs\non process and .suicide is not true. This protects against accidental\ndisconnection.
\n"
            },
            {
              "textRaw": "`suicide` {Boolean} ",
              "type": "Boolean",
              "name": "suicide",
              "meta": {
                "added": [
                  "v0.7.0"
                ],
                "deprecated": [
                  "v6.0.0"
                ]
              },
              "desc": "
Set by calling .kill() or .disconnect(), until then it is undefined.
\n
The boolean worker.suicide lets you distinguish between voluntary and accidental\nexit, the master may choose not to respawn a worker based on this value.
\n
cluster.on('exit', (worker, code, signal) => {\n  if (worker.suicide === true) {\n    console.log('Oh, it was just suicide\\' – no need to worry').\n  }\n});\n\n// kill worker\nworker.kill();\n
\n"
            }
          ]
        }
      ],
      "events": [
        {
          "textRaw": "Event: 'disconnect'",
          "type": "event",
          "name": "disconnect",
          "meta": {
            "added": [
              "v0.7.9"
            ]
          },
          "params": [],
          "desc": "
Emitted after the worker IPC channel has disconnected. This can occur when a\nworker exits gracefully, is killed, or is disconnected manually (such as with\nworker.disconnect()).
\n
There may be a delay between the 'disconnect' and 'exit' events.  These events\ncan be used to detect if the process is stuck in a cleanup or if there are\nlong-living connections.
\n
cluster.on('disconnect', (worker) => {\n  console.log(`The worker #${worker.id} has disconnected`);\n});\n
\n"
        },
        {
          "textRaw": "Event: 'exit'",
          "type": "event",
          "name": "exit",
          "meta": {
            "added": [
              "v0.7.9"
            ]
          },
          "params": [],
          "desc": "
When any of the workers die the cluster module will emit the 'exit' event.
\n
This can be used to restart the worker by calling .fork() again.
\n
cluster.on('exit', (worker, code, signal) => {\n  console.log('worker %d died (%s). restarting...',\n    worker.process.pid, signal || code);\n  cluster.fork();\n});\n
\n
See child_process event: 'exit'.
\n"
        },
        {
          "textRaw": "Event: 'fork'",
          "type": "event",
          "name": "fork",
          "meta": {
            "added": [
              "v0.7.0"
            ]
          },
          "params": [],
          "desc": "
When a new worker is forked the cluster module will emit a 'fork' event.\nThis can be used to log worker activity, and create your own timeout.
\n
var timeouts = [];\nfunction errorMsg() {\n  console.error('Something must be wrong with the connection ...');\n}\n\ncluster.on('fork', (worker) => {\n  timeouts[worker.id] = setTimeout(errorMsg, 2000);\n});\ncluster.on('listening', (worker, address) => {\n  clearTimeout(timeouts[worker.id]);\n});\ncluster.on('exit', (worker, code, signal) => {\n  clearTimeout(timeouts[worker.id]);\n  errorMsg();\n});\n
\n"
        },
        {
          "textRaw": "Event: 'listening'",
          "type": "event",
          "name": "listening",
          "meta": {
            "added": [
              "v0.7.0"
            ]
          },
          "params": [],
          "desc": "
After calling listen() from a worker, when the 'listening' event is emitted on\nthe server, a 'listening' event will also be emitted on cluster in the master.
\n
The event handler is executed with two arguments, the worker contains the worker\nobject and the address object contains the following connection properties:\naddress, port and addressType. This is very useful if the worker is listening\non more than one address.
\n
cluster.on('listening', (worker, address) => {\n  console.log(\n    `A worker is now connected to ${address.address}:${address.port}`);\n});\n
\n
The addressType is one of:
\n
    \n
  • 4 (TCPv4)
    • \n
  • 6 (TCPv6)
    • \n
  • -1 (unix domain socket)
    • \n
  • "udp4" or "udp6" (UDP v4 or v6)
    • \n
\n"
        },
        {
          "textRaw": "Event: 'message'",
          "type": "event",
          "name": "message",
          "params": [],
          "desc": "
Emitted when the cluster master receives a message from any worker.
\n
See child_process event: 'message'.
\n"
        },
        {
          "textRaw": "Event: 'online'",
          "type": "event",
          "name": "online",
          "meta": {
            "added": [
              "v0.7.0"
            ]
          },
          "params": [],
          "desc": "
After forking a new worker, the worker should respond with an online message.\nWhen the master receives an online message it will emit this event.\nThe difference between 'fork' and 'online' is that fork is emitted when the\nmaster forks a worker, and 'online' is emitted when the worker is running.
\n
cluster.on('online', (worker) => {\n  console.log('Yay, the worker responded after it was forked');\n});\n
\n"
        },
        {
          "textRaw": "Event: 'setup'",
          "type": "event",
          "name": "setup",
          "meta": {
            "added": [
              "v0.7.1"
            ]
          },
          "params": [],
          "desc": "
Emitted every time .setupMaster() is called.
\n
The settings object is the cluster.settings object at the time\n.setupMaster() was called and is advisory only, since multiple calls to\n.setupMaster() can be made in a single tick.
\n
If accuracy is important, use cluster.settings.
\n"
        }
      ],
      "methods": [
        {
          "textRaw": "cluster.disconnect([callback])",
          "type": "method",
          "name": "disconnect",
          "meta": {
            "added": [
              "v0.7.7"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`callback` {Function} called when all workers are disconnected and handles are closed ",
                  "name": "callback",
                  "type": "Function",
                  "desc": "called when all workers are disconnected and handles are closed",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "callback",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "
Calls .disconnect() on each worker in cluster.workers.
\n
When they are disconnected all internal handles will be closed, allowing the\nmaster process to die gracefully if no other event is waiting.
\n
The method takes an optional callback argument which will be called when finished.
\n
This can only be called from the master process.
\n"
        },
        {
          "textRaw": "cluster.fork([env])",
          "type": "method",
          "name": "fork",
          "meta": {
            "added": [
              "v0.6.0"
            ]
          },
          "signatures": [
            {
              "return": {
                "textRaw": "return {cluster.Worker} ",
                "name": "return",
                "type": "cluster.Worker"
              },
              "params": [
                {
                  "textRaw": "`env` {Object} Key/value pairs to add to worker process environment. ",
                  "name": "env",
                  "type": "Object",
                  "desc": "Key/value pairs to add to worker process environment.",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "env",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "
Spawn a new worker process.
\n
This can only be called from the master process.
\n"
        },
        {
          "textRaw": "cluster.setupMaster([settings])",
          "type": "method",
          "name": "setupMaster",
          "meta": {
            "added": [
              "v0.7.1"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`settings` {Object} ",
                  "options": [
                    {
                      "textRaw": "`exec` {String} file path to worker file.  (Default=`process.argv[1]`) ",
                      "name": "exec",
                      "default": "process.argv[1]",
                      "type": "String",
                      "desc": "file path to worker file."
                    },
                    {
                      "textRaw": "`args` {Array} string arguments passed to worker. (Default=`process.argv.slice(2)`) ",
                      "name": "args",
                      "default": "process.argv.slice(2)",
                      "type": "Array",
                      "desc": "string arguments passed to worker."
                    },
                    {
                      "textRaw": "`silent` {Boolean} whether or not to send output to parent's stdio. (Default=`false`) ",
                      "name": "silent",
                      "default": "false",
                      "type": "Boolean",
                      "desc": "whether or not to send output to parent's stdio."
                    }
                  ],
                  "name": "settings",
                  "type": "Object",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "settings",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "
setupMaster is used to change the default 'fork' behavior. Once called,\nthe settings will be present in cluster.settings.
\n
Note that:
\n
    \n
  • any settings changes only affect future calls to .fork() and have no\neffect on workers that are already running
    • \n
  • The only attribute of a worker that cannot be set via .setupMaster() is\nthe env passed to .fork()
    • \n
  • the defaults above apply to the first call only, the defaults for later\ncalls is the current value at the time of cluster.setupMaster() is called
    • \n
\n
Example:
\n
const cluster = require('cluster');\ncluster.setupMaster({\n  exec: 'worker.js',\n  args: ['--use', 'https'],\n  silent: true\n});\ncluster.fork(); // https worker\ncluster.setupMaster({\n  exec: 'worker.js',\n  args: ['--use', 'http']\n});\ncluster.fork(); // http worker\n
\n
This can only be called from the master process.
\n"
        }
      ],
      "properties": [
        {
          "textRaw": "`isMaster` {Boolean} ",
          "type": "Boolean",
          "name": "isMaster",
          "meta": {
            "added": [
              "v0.8.1"
            ]
          },
          "desc": "
True if the process is a master. This is determined\nby the process.env.NODE_UNIQUE_ID. If process.env.NODE_UNIQUE_ID is\nundefined, then isMaster is true.
\n"
        },
        {
          "textRaw": "`isWorker` {Boolean} ",
          "type": "Boolean",
          "name": "isWorker",
          "meta": {
            "added": [
              "v0.6.0"
            ]
          },
          "desc": "
True if the process is not a master (it is the negation of cluster.isMaster).
\n"
        },
        {
          "textRaw": "cluster.schedulingPolicy",
          "name": "schedulingPolicy",
          "meta": {
            "added": [
              "v0.11.2"
            ]
          },
          "desc": "
The scheduling policy, either cluster.SCHED_RR for round-robin or\ncluster.SCHED_NONE to leave it to the operating system. This is a\nglobal setting and effectively frozen once you spawn the first worker\nor call cluster.setupMaster(), whatever comes first.
\n
SCHED_RR is the default on all operating systems except Windows.\nWindows will change to SCHED_RR once libuv is able to effectively\ndistribute IOCP handles without incurring a large performance hit.
\n
cluster.schedulingPolicy can also be set through the\nNODE_CLUSTER_SCHED_POLICY environment variable. Valid\nvalues are "rr" and "none".
\n"
        },
        {
          "textRaw": "`settings` {Object} ",
          "type": "Object",
          "name": "settings",
          "meta": {
            "added": [
              "v0.7.1"
            ]
          },
          "options": [
            {
              "textRaw": "`execArgv` {Array} list of string arguments passed to the Node.js executable. (Default=`process.execArgv`) ",
              "name": "execArgv",
              "default": "process.execArgv",
              "type": "Array",
              "desc": "list of string arguments passed to the Node.js executable."
            },
            {
              "textRaw": "`exec` {String} file path to worker file.  (Default=`process.argv[1]`) ",
              "name": "exec",
              "default": "process.argv[1]",
              "type": "String",
              "desc": "file path to worker file."
            },
            {
              "textRaw": "`args` {Array} string arguments passed to worker. (Default=`process.argv.slice(2)`) ",
              "name": "args",
              "default": "process.argv.slice(2)",
              "type": "Array",
              "desc": "string arguments passed to worker."
            },
            {
              "textRaw": "`silent` {Boolean} whether or not to send output to parent's stdio. (Default=`false`) ",
              "name": "silent",
              "default": "false",
              "type": "Boolean",
              "desc": "whether or not to send output to parent's stdio."
            },
            {
              "textRaw": "`uid` {Number} Sets the user identity of the process. (See setuid(2).) ",
              "name": "uid",
              "type": "Number",
              "desc": "Sets the user identity of the process. (See setuid(2).)"
            },
            {
              "textRaw": "`gid` {Number} Sets the group identity of the process. (See setgid(2).) ",
              "name": "gid",
              "type": "Number",
              "desc": "Sets the group identity of the process. (See setgid(2).)"
            }
          ],
          "desc": "
After calling .setupMaster() (or .fork()) this settings object will contain\nthe settings, including the default values.
\n
This object is not supposed to be changed or set manually, by you.
\n"
        },
        {
          "textRaw": "`worker` {Object} ",
          "type": "Object",
          "name": "worker",
          "meta": {
            "added": [
              "v0.7.0"
            ]
          },
          "desc": "
A reference to the current worker object. Not available in the master process.
\n
const cluster = require('cluster');\n\nif (cluster.isMaster) {\n  console.log('I am master');\n  cluster.fork();\n  cluster.fork();\n} else if (cluster.isWorker) {\n  console.log(`I am worker #${cluster.worker.id}`);\n}\n
\n"
        },
        {
          "textRaw": "`workers` {Object} ",
          "type": "Object",
          "name": "workers",
          "meta": {
            "added": [
              "v0.7.0"
            ]
          },
          "desc": "
A hash that stores the active worker objects, keyed by id field. Makes it\neasy to loop through all the workers. It is only available in the master\nprocess.
\n
A worker is removed from cluster.workers after the worker has disconnected and\nexited. The order between these two events cannot be determined in advance.\nHowever, it is guaranteed that the removal from the cluster.workers list happens\nbefore last 'disconnect' or 'exit' event is emitted.
\n
// Go through all workers\nfunction eachWorker(callback) {\n  for (var id in cluster.workers) {\n    callback(cluster.workers[id]);\n  }\n}\neachWorker((worker) => {\n  worker.send('big announcement to all workers');\n});\n
\n
Should you wish to reference a worker over a communication channel, using\nthe worker's unique id is the easiest way to find the worker.
\n
socket.on('data', (id) => {\n  var worker = cluster.workers[id];\n});\n
\n\n\n"
        }
      ],
      "type": "module",
      "displayName": "Cluster"
    },
    {
      "textRaw": "Console",
      "name": "console",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
The console module provides a simple debugging console that is similar to the\nJavaScript console mechanism provided by web browsers.
\n
The module exports two specific components:
\n
    \n
  • A Console class with methods such as console.log(), console.error() and\nconsole.warn() that can be used to write to any Node.js stream.
    • \n
  • A global console instance configured to write to stdout and stderr.\nBecause this object is global, it can be used without calling\nrequire('console').
    • \n
\n
Example using the global console:
\n
console.log('hello world');\n  // Prints: hello world, to stdout\nconsole.log('hello %s', 'world');\n  // Prints: hello world, to stdout\nconsole.error(new Error('Whoops, something bad happened'));\n  // Prints: [Error: Whoops, something bad happened], to stderr\n\nconst name = 'Will Robinson';\nconsole.warn(`Danger ${name}! Danger!`);\n  // Prints: Danger Will Robinson! Danger!, to stderr\n
\n
Example using the Console class:
\n
const out = getStreamSomehow();\nconst err = getStreamSomehow();\nconst myConsole = new console.Console(out, err);\n\nmyConsole.log('hello world');\n  // Prints: hello world, to out\nmyConsole.log('hello %s', 'world');\n  // Prints: hello world, to out\nmyConsole.error(new Error('Whoops, something bad happened'));\n  // Prints: [Error: Whoops, something bad happened], to err\n\nconst name = 'Will Robinson';\nmyConsole.warn(`Danger ${name}! Danger!`);\n  // Prints: Danger Will Robinson! Danger!, to err\n
\n
While the API for the Console class is designed fundamentally around the\nbrowser console object, the Console in Node.js is not intended to\nduplicate the browser's functionality exactly.
\n",
      "modules": [
        {
          "textRaw": "Asynchronous vs Synchronous Consoles",
          "name": "asynchronous_vs_synchronous_consoles",
          "desc": "
The console functions are usually asynchronous unless the destination is a file.\nDisks are fast and operating systems normally employ write-back caching;\nit should be a very rare occurrence indeed that a write blocks, but it\nis possible.
\n
Additionally, console functions are blocking when outputting to TTYs\n(terminals) on OS X as a workaround for the OS's very small, 1kb buffer size.\nThis is to prevent interleaving between stdout and stderr.
\n",
          "type": "module",
          "displayName": "Asynchronous vs Synchronous Consoles"
        }
      ],
      "classes": [
        {
          "textRaw": "Class: Console",
          "type": "class",
          "name": "Console",
          "desc": "
The Console class can be used to create a simple logger with configurable\noutput streams and can be accessed using either require('console').Console\nor console.Console:
\n
const Console = require('console').Console;\nconst Console = console.Console;\n
\n",
          "methods": [
            {
              "textRaw": "console.assert(value[, message][, ...])",
              "type": "method",
              "name": "assert",
              "meta": {
                "added": [
                  "v0.1.101"
                ]
              },
              "desc": "
A simple assertion test that verifies whether value is truthy. If it is not,\nan AssertionError is thrown. If provided, the error message is formatted\nusing util.format() and used as the error message.
\n
console.assert(true, 'does nothing');\n  // OK\nconsole.assert(false, 'Whoops %s', 'didn\\'t work');\n  // AssertionError: Whoops didn't work\n
\n
Note: the console.assert() method is implemented differently in Node.js\nthan the console.assert() method available in browsers.
\n
Specifically, in browsers, calling console.assert() with a falsy\nassertion will cause the message to be printed to the console without\ninterrupting execution of subsequent code. In Node.js, however, a falsy\nassertion will cause an AssertionError to be thrown.
\n
Functionality approximating that implemented by browsers can be implemented\nby extending Node.js' console and overriding the console.assert() method.
\n
In the following example, a simple module is created that extends and overrides\nthe default behavior of console in Node.js.
\n
'use strict';\n\n// Creates a simple extension of console with a\n// new impl for assert without monkey-patching.\nconst myConsole = Object.create(console, {\n  assert: {\n    value: function assert(assertion, message, ...args) {\n      try {\n        console.assert(assertion, message, ...args);\n      } catch (err) {\n        console.error(err.stack);\n      }\n    },\n    configurable: true,\n    enumerable: true,\n    writable: true,\n  },\n});\n\nmodule.exports = myConsole;\n
\n
This can then be used as a direct replacement for the built in console:
\n
const console = require('./myConsole');\nconsole.assert(false, 'this message will print, but no error thrown');\nconsole.log('this will also print');\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "message",
                      "optional": true
                    },
                    {
                      "name": "...",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "console.dir(obj[, options])",
              "type": "method",
              "name": "dir",
              "meta": {
                "added": [
                  "v0.1.101"
                ]
              },
              "desc": "
Uses util.inspect() on obj and prints the resulting string to stdout.\nThis function bypasses any custom inspect() function defined on obj. An\noptional options object may be passed to alter certain aspects of the\nformatted string:
\n
    \n
  • showHidden - if true then the object's non-enumerable and symbol\nproperties will be shown too. Defaults to false.
    \n
    • \n
  • depth - tells util.inspect() how many times to recurse while\nformatting the object. This is useful for inspecting large complicated objects.\nDefaults to 2. To make it recurse indefinitely, pass null.
    \n
    • \n
  • colors - if true, then the output will be styled with ANSI color codes.\nDefaults to false. Colors are customizable; see\ncustomizing util.inspect() colors.
    \n
    • \n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "obj"
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "console.error([data][, ...])",
              "type": "method",
              "name": "error",
              "meta": {
                "added": [
                  "v0.1.100"
                ]
              },
              "desc": "
Prints to stderr with newline. Multiple arguments can be passed, with the\nfirst used as the primary message and all additional used as substitution\nvalues similar to printf(3) (the arguments are all passed to\nutil.format()).
\n
const code = 5;\nconsole.error('error #%d', code);\n  // Prints: error #5, to stderr\nconsole.error('error', code);\n  // Prints: error 5, to stderr\n
\n
If formatting elements (e.g. %d) are not found in the first string then\nutil.inspect() is called on each argument and the resulting string\nvalues are concatenated. See util.format() for more information.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "data",
                      "optional": true
                    },
                    {
                      "name": "...",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "console.info([data][, ...])",
              "type": "method",
              "name": "info",
              "meta": {
                "added": [
                  "v0.1.100"
                ]
              },
              "desc": "
The console.info() function is an alias for console.log().
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "data",
                      "optional": true
                    },
                    {
                      "name": "...",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "console.log([data][, ...])",
              "type": "method",
              "name": "log",
              "meta": {
                "added": [
                  "v0.1.100"
                ]
              },
              "desc": "
Prints to stdout with newline. Multiple arguments can be passed, with the\nfirst used as the primary message and all additional used as substitution\nvalues similar to printf(3) (the arguments are all passed to\nutil.format()).
\n
const count = 5;\nconsole.log('count: %d', count);\n  // Prints: count: 5, to stdout\nconsole.log('count:', count);\n  // Prints: count: 5, to stdout\n
\n
If formatting elements (e.g. %d) are not found in the first string then\nutil.inspect() is called on each argument and the resulting string\nvalues are concatenated. See util.format() for more information.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "data",
                      "optional": true
                    },
                    {
                      "name": "...",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "console.time(label)",
              "type": "method",
              "name": "time",
              "meta": {
                "added": [
                  "v0.1.104"
                ]
              },
              "desc": "
Used to calculate the duration of a specific operation. To start a timer, call\nthe console.time() method, giving it a unique label as the only parameter. To stop the\ntimer, and to get the elapsed time in milliseconds, just call the\nconsole.timeEnd() method, again passing the\ntimer's unique label as the parameter.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "label"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "console.timeEnd(label)",
              "type": "method",
              "name": "timeEnd",
              "meta": {
                "added": [
                  "v0.1.104"
                ]
              },
              "desc": "
Stops a timer that was previously started by calling console.time() and\nprints the result to stdout:
\n
console.time('100-elements');\nfor (let i = 0; i < 100; i++) {\n  ;\n}\nconsole.timeEnd('100-elements');\n// prints 100-elements: 262ms\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "label"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "console.trace(message[, ...])",
              "type": "method",
              "name": "trace",
              "meta": {
                "added": [
                  "v0.1.104"
                ]
              },
              "desc": "
Prints to stderr the string 'Trace :', followed by the util.format()\nformatted message and stack trace to the current position in the code.
\n
console.trace('Show me');\n  // Prints: (stack trace will vary based on where trace is called)\n  //  Trace: Show me\n  //    at repl:2:9\n  //    at REPLServer.defaultEval (repl.js:248:27)\n  //    at bound (domain.js:287:14)\n  //    at REPLServer.runBound [as eval] (domain.js:300:12)\n  //    at REPLServer.<anonymous> (repl.js:412:12)\n  //    at emitOne (events.js:82:20)\n  //    at REPLServer.emit (events.js:169:7)\n  //    at REPLServer.Interface._onLine (readline.js:210:10)\n  //    at REPLServer.Interface._line (readline.js:549:8)\n  //    at REPLServer.Interface._ttyWrite (readline.js:826:14)\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "message"
                    },
                    {
                      "name": "...",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "console.warn([data][, ...])",
              "type": "method",
              "name": "warn",
              "meta": {
                "added": [
                  "v0.1.100"
                ]
              },
              "desc": "
The console.warn() function is an alias for console.error().
\n\n\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "data",
                      "optional": true
                    },
                    {
                      "name": "...",
                      "optional": true
                    }
                  ]
                }
              ]
            }
          ],
          "signatures": [
            {
              "params": [
                {
                  "name": "stdout"
                },
                {
                  "name": "stderr",
                  "optional": true
                }
              ],
              "desc": "
Creates a new Console by passing one or two writable stream instances.\nstdout is a writable stream to print log or info output. stderr\nis used for warning or error output. If stderr isn't passed, warning and error\noutput will be sent to stdout.
\n
const output = fs.createWriteStream('./stdout.log');\nconst errorOutput = fs.createWriteStream('./stderr.log');\n// custom simple logger\nconst logger = new Console(output, errorOutput);\n// use it like console\nconst count = 5;\nlogger.log('count: %d', count);\n// in stdout.log: count 5\n
\n
The global console is a special Console whose output is sent to\nprocess.stdout and process.stderr. It is equivalent to calling:
\n
new Console(process.stdout, process.stderr);\n
\n"
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "Console"
    },
    {
      "textRaw": "Crypto",
      "name": "crypto",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
The crypto module provides cryptographic functionality that includes a set of\nwrappers for OpenSSL's hash, HMAC, cipher, decipher, sign and verify functions.
\n
Use require('crypto') to access this module.
\n
const crypto = require('crypto');\n\nconst secret = 'abcdefg';\nconst hash = crypto.createHmac('sha256', secret)\n                   .update('I love cupcakes')\n                   .digest('hex');\nconsole.log(hash);\n  // Prints:\n  //   c0fa1bc00531bd78ef38c628449c5102aeabd49b5dc3a2a516ea6ea959d6658e\n
\n",
      "classes": [
        {
          "textRaw": "Class: Certificate",
          "type": "class",
          "name": "Certificate",
          "meta": {
            "added": [
              "v0.11.8"
            ]
          },
          "desc": "
SPKAC is a Certificate Signing Request mechanism originally implemented by\nNetscape and now specified formally as part of HTML5's keygen element.
\n
The crypto module provides the Certificate class for working with SPKAC\ndata. The most common usage is handling output generated by the HTML5\n<keygen> element. Node.js uses OpenSSL's SPKAC implementation internally.
\n",
          "methods": [
            {
              "textRaw": "new crypto.Certificate()",
              "type": "method",
              "name": "Certificate",
              "desc": "
Instances of the Certificate class can be created using the new keyword\nor by calling crypto.Certificate() as a function:
\n
const crypto = require('crypto');\n\nconst cert1 = new crypto.Certificate();\nconst cert2 = crypto.Certificate();\n
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "certificate.exportChallenge(spkac)",
              "type": "method",
              "name": "exportChallenge",
              "meta": {
                "added": [
                  "v0.11.8"
                ]
              },
              "desc": "
The spkac data structure includes a public key and a challenge. The\ncertificate.exportChallenge() returns the challenge component in the\nform of a Node.js Buffer. The spkac argument can be either a string\nor a Buffer.
\n
const cert = require('crypto').Certificate();\nconst spkac = getSpkacSomehow();\nconst challenge = cert.exportChallenge(spkac);\nconsole.log(challenge.toString('utf8'));\n  // Prints the challenge as a UTF8 string\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "spkac"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "certificate.exportPublicKey(spkac)",
              "type": "method",
              "name": "exportPublicKey",
              "meta": {
                "added": [
                  "v0.11.8"
                ]
              },
              "desc": "
The spkac data structure includes a public key and a challenge. The\ncertificate.exportPublicKey() returns the public key component in the\nform of a Node.js Buffer. The spkac argument can be either a string\nor a Buffer.
\n
const cert = require('crypto').Certificate();\nconst spkac = getSpkacSomehow();\nconst publicKey = cert.exportPublicKey(spkac);\nconsole.log(publicKey);\n  // Prints the public key as <Buffer ...>\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "spkac"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "certificate.verifySpkac(spkac)",
              "type": "method",
              "name": "verifySpkac",
              "meta": {
                "added": [
                  "v0.11.8"
                ]
              },
              "desc": "
Returns true if the given spkac data structure is valid, false otherwise.\nThe spkac argument must be a Node.js Buffer.
\n
const cert = require('crypto').Certificate();\nconst spkac = getSpkacSomehow();\nconsole.log(cert.verifySpkac(new Buffer(spkac)));\n  // Prints true or false\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "spkac"
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "textRaw": "Class: Cipher",
          "type": "class",
          "name": "Cipher",
          "meta": {
            "added": [
              "v0.1.94"
            ]
          },
          "desc": "
Instances of the Cipher class are used to encrypt data. The class can be\nused in one of two ways:
\n
    \n
  • As a stream that is both readable and writable, where plain unencrypted\ndata is written to produce encrypted data on the readable side, or
    • \n
  • Using the cipher.update() and cipher.final() methods to produce\nthe encrypted data.
    • \n
\n
The crypto.createCipher() or crypto.createCipheriv() methods are\nused to create Cipher instances. Cipher objects are not to be created\ndirectly using the new keyword.
\n
Example: Using Cipher objects as streams:
\n
const crypto = require('crypto');\nconst cipher = crypto.createCipher('aes192', 'a password');\n\nvar encrypted = '';\ncipher.on('readable', () => {\n  var data = cipher.read();\n  if (data)\n    encrypted += data.toString('hex');\n});\ncipher.on('end', () => {\n  console.log(encrypted);\n  // Prints: ca981be48e90867604588e75d04feabb63cc007a8f8ad89b10616ed84d815504\n});\n\ncipher.write('some clear text data');\ncipher.end();\n
\n
Example: Using Cipher and piped streams:
\n
const crypto = require('crypto');\nconst fs = require('fs');\nconst cipher = crypto.createCipher('aes192', 'a password');\n\nconst input = fs.createReadStream('test.js');\nconst output = fs.createWriteStream('test.enc');\n\ninput.pipe(cipher).pipe(output);\n
\n
Example: Using the cipher.update() and cipher.final() methods:
\n
const crypto = require('crypto');\nconst cipher = crypto.createCipher('aes192', 'a password');\n\nvar encrypted = cipher.update('some clear text data', 'utf8', 'hex');\nencrypted += cipher.final('hex');\nconsole.log(encrypted);\n  // Prints: ca981be48e90867604588e75d04feabb63cc007a8f8ad89b10616ed84d815504\n
\n",
          "methods": [
            {
              "textRaw": "cipher.final([output_encoding])",
              "type": "method",
              "name": "final",
              "meta": {
                "added": [
                  "v0.1.94"
                ]
              },
              "desc": "
Returns any remaining enciphered contents. If output_encoding\nparameter is one of 'binary', 'base64' or 'hex', a string is returned.\nIf an output_encoding is not provided, a Buffer is returned.
\n
Once the cipher.final() method has been called, the Cipher object can no\nlonger be used to encrypt data. Attempts to call cipher.final() more than\nonce will result in an error being thrown.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "output_encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "cipher.setAAD(buffer)",
              "type": "method",
              "name": "setAAD",
              "meta": {
                "added": [
                  "v1.0.0"
                ]
              },
              "desc": "
When using an authenticated encryption mode (only GCM is currently\nsupported), the cipher.setAAD() method sets the value used for the\nadditional authenticated data (AAD) input parameter.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "buffer"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "cipher.getAuthTag()",
              "type": "method",
              "name": "getAuthTag",
              "meta": {
                "added": [
                  "v1.0.0"
                ]
              },
              "desc": "
When using an authenticated encryption mode (only GCM is currently\nsupported), the cipher.getAuthTag() method returns a Buffer containing\nthe authentication tag that has been computed from the given data.
\n
The cipher.getAuthTag() method should only be called after encryption has\nbeen completed using the cipher.final() method.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "cipher.setAutoPadding(auto_padding=true)",
              "type": "method",
              "name": "setAutoPadding",
              "meta": {
                "added": [
                  "v0.7.1"
                ]
              },
              "desc": "
When using block encryption algorithms, the Cipher class will automatically\nadd padding to the input data to the appropriate block size. To disable the\ndefault padding call cipher.setAutoPadding(false).
\n
When auto_padding is false, the length of the entire input data must be a\nmultiple of the cipher's block size or cipher.final() will throw an Error.\nDisabling automatic padding is useful for non-standard padding, for instance\nusing 0x0 instead of PKCS padding.
\n
The cipher.setAutoPadding() method must be called before cipher.final().
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "auto_padding",
                      "default": "true"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "cipher.update(data[, input_encoding][, output_encoding])",
              "type": "method",
              "name": "update",
              "meta": {
                "added": [
                  "v0.1.94"
                ]
              },
              "desc": "
Updates the cipher with data. If the input_encoding argument is given,\nit's value must be one of 'utf8', 'ascii', or 'binary' and the data\nargument is a string using the specified encoding. If the input_encoding\nargument is not given, data must be a Buffer. If data is a\nBuffer then input_encoding is ignored.
\n
The output_encoding specifies the output format of the enciphered\ndata, and can be 'binary', 'base64' or 'hex'. If the output_encoding\nis specified, a string using the specified encoding is returned. If no\noutput_encoding is provided, a Buffer is returned.
\n
The cipher.update() method can be called multiple times with new data until\ncipher.final() is called. Calling cipher.update() after\ncipher.final() will result in an error being thrown.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "data"
                    },
                    {
                      "name": "input_encoding",
                      "optional": true
                    },
                    {
                      "name": "output_encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "textRaw": "Class: Decipher",
          "type": "class",
          "name": "Decipher",
          "meta": {
            "added": [
              "v0.1.94"
            ]
          },
          "desc": "
Instances of the Decipher class are used to decrypt data. The class can be\nused in one of two ways:
\n
    \n
  • As a stream that is both readable and writable, where plain encrypted\ndata is written to produce unencrypted data on the readable side, or
    • \n
  • Using the decipher.update() and decipher.final() methods to\nproduce the unencrypted data.
    • \n
\n
The crypto.createDecipher() or crypto.createDecipheriv() methods are\nused to create Decipher instances. Decipher objects are not to be created\ndirectly using the new keyword.
\n
Example: Using Decipher objects as streams:
\n
const crypto = require('crypto');\nconst decipher = crypto.createDecipher('aes192', 'a password');\n\nvar decrypted = '';\ndecipher.on('readable', () => {\n  var data = decipher.read();\n  if (data)\n  decrypted += data.toString('utf8');\n});\ndecipher.on('end', () => {\n  console.log(decrypted);\n  // Prints: some clear text data\n});\n\nvar encrypted = 'ca981be48e90867604588e75d04feabb63cc007a8f8ad89b10616ed84d815504';\ndecipher.write(encrypted, 'hex');\ndecipher.end();\n
\n
Example: Using Decipher and piped streams:
\n
const crypto = require('crypto');\nconst fs = require('fs');\nconst decipher = crypto.createDecipher('aes192', 'a password');\n\nconst input = fs.createReadStream('test.enc');\nconst output = fs.createWriteStream('test.js');\n\ninput.pipe(decipher).pipe(output);\n
\n
Example: Using the decipher.update() and decipher.final() methods:
\n
const crypto = require('crypto');\nconst decipher = crypto.createDecipher('aes192', 'a password');\n\nvar encrypted = 'ca981be48e90867604588e75d04feabb63cc007a8f8ad89b10616ed84d815504';\nvar decrypted = decipher.update(encrypted, 'hex', 'utf8');\ndecrypted += decipher.final('utf8');\nconsole.log(decrypted);\n  // Prints: some clear text data\n
\n",
          "methods": [
            {
              "textRaw": "decipher.final([output_encoding])",
              "type": "method",
              "name": "final",
              "meta": {
                "added": [
                  "v0.1.94"
                ]
              },
              "desc": "
Returns any remaining deciphered contents. If output_encoding\nparameter is one of 'binary', 'base64' or 'hex', a string is returned.\nIf an output_encoding is not provided, a Buffer is returned.
\n
Once the decipher.final() method has been called, the Decipher object can\nno longer be used to decrypt data. Attempts to call decipher.final() more\nthan once will result in an error being thrown.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "output_encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "decipher.setAAD(buffer)",
              "type": "method",
              "name": "setAAD",
              "meta": {
                "added": [
                  "v1.0.0"
                ]
              },
              "desc": "
When using an authenticated encryption mode (only GCM is currently\nsupported), the decipher.setAAD() method sets the value used for the\nadditional authenticated data (AAD) input parameter.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "buffer"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "decipher.setAuthTag(buffer)",
              "type": "method",
              "name": "setAuthTag",
              "meta": {
                "added": [
                  "v1.0.0"
                ]
              },
              "desc": "
When using an authenticated encryption mode (only GCM is currently\nsupported), the decipher.setAuthTag() method is used to pass in the\nreceived authentication tag. If no tag is provided, or if the cipher text\nhas been tampered with, decipher.final() with throw, indicating that the\ncipher text should be discarded due to failed authentication.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "buffer"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "decipher.setAutoPadding(auto_padding=true)",
              "type": "method",
              "name": "setAutoPadding",
              "meta": {
                "added": [
                  "v0.7.1"
                ]
              },
              "desc": "
When data has been encrypted without standard block padding, calling\ndecipher.setAutoPadding(false) will disable automatic padding to prevent\ndecipher.final() from checking for and removing padding.
\n
Turning auto padding off will only work if the input data's length is a\nmultiple of the ciphers block size.
\n
The decipher.setAutoPadding() method must be called before\ndecipher.update().
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "auto_padding",
                      "default": "true"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "decipher.update(data[, input_encoding][, output_encoding])",
              "type": "method",
              "name": "update",
              "meta": {
                "added": [
                  "v0.1.94"
                ]
              },
              "desc": "
Updates the decipher with data. If the input_encoding argument is given,\nit's value must be one of 'binary', 'base64', or 'hex' and the data\nargument is a string using the specified encoding. If the input_encoding\nargument is not given, data must be a Buffer. If data is a\nBuffer then input_encoding is ignored.
\n
The output_encoding specifies the output format of the enciphered\ndata, and can be 'binary', 'ascii' or 'utf8'. If the output_encoding\nis specified, a string using the specified encoding is returned. If no\noutput_encoding is provided, a Buffer is returned.
\n
The decipher.update() method can be called multiple times with new data until\ndecipher.final() is called. Calling decipher.update() after\ndecipher.final() will result in an error being thrown.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "data"
                    },
                    {
                      "name": "input_encoding",
                      "optional": true
                    },
                    {
                      "name": "output_encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "textRaw": "Class: DiffieHellman",
          "type": "class",
          "name": "DiffieHellman",
          "meta": {
            "added": [
              "v0.5.0"
            ]
          },
          "desc": "
The DiffieHellman class is a utility for creating Diffie-Hellman key\nexchanges.
\n
Instances of the DiffieHellman class can be created using the\ncrypto.createDiffieHellman() function.
\n
const crypto = require('crypto');\nconst assert = require('assert');\n\n// Generate Alice's keys...\nconst alice = crypto.createDiffieHellman(2048);\nconst alice_key = alice.generateKeys();\n\n// Generate Bob's keys...\nconst bob = crypto.createDiffieHellman(alice.getPrime(), alice.getGenerator());\nconst bob_key = bob.generateKeys();\n\n// Exchange and generate the secret...\nconst alice_secret = alice.computeSecret(bob_key);\nconst bob_secret = bob.computeSecret(alice_key);\n\n// OK\nassert.equal(alice_secret.toString('hex'), bob_secret.toString('hex'));\n
\n",
          "methods": [
            {
              "textRaw": "diffieHellman.computeSecret(other_public_key[, input_encoding][, output_encoding])",
              "type": "method",
              "name": "computeSecret",
              "meta": {
                "added": [
                  "v0.5.0"
                ]
              },
              "desc": "
Computes the shared secret using other_public_key as the other\nparty's public key and returns the computed shared secret. The supplied\nkey is interpreted using the specified input_encoding, and secret is\nencoded using specified output_encoding. Encodings can be\n'binary', 'hex', or 'base64'. If the input_encoding is not\nprovided, other_public_key is expected to be a Buffer.
\n
If output_encoding is given a string is returned; otherwise, a\nBuffer is returned.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "other_public_key"
                    },
                    {
                      "name": "input_encoding",
                      "optional": true
                    },
                    {
                      "name": "output_encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "diffieHellman.generateKeys([encoding])",
              "type": "method",
              "name": "generateKeys",
              "meta": {
                "added": [
                  "v0.5.0"
                ]
              },
              "desc": "
Generates private and public Diffie-Hellman key values, and returns\nthe public key in the specified encoding. This key should be\ntransferred to the other party. Encoding can be 'binary', 'hex',\nor 'base64'. If encoding is provided a string is returned; otherwise a\nBuffer is returned.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "diffieHellman.getGenerator([encoding])",
              "type": "method",
              "name": "getGenerator",
              "meta": {
                "added": [
                  "v0.5.0"
                ]
              },
              "desc": "
Returns the Diffie-Hellman generator in the specified encoding, which can\nbe 'binary', 'hex', or 'base64'. If  encoding is provided a string is\nreturned; otherwise a Buffer is returned.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "diffieHellman.getPrime([encoding])",
              "type": "method",
              "name": "getPrime",
              "meta": {
                "added": [
                  "v0.5.0"
                ]
              },
              "desc": "
Returns the Diffie-Hellman prime in the specified encoding, which can\nbe 'binary', 'hex', or 'base64'. If encoding is provided a string is\nreturned; otherwise a Buffer is returned.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "diffieHellman.getPrivateKey([encoding])",
              "type": "method",
              "name": "getPrivateKey",
              "meta": {
                "added": [
                  "v0.5.0"
                ]
              },
              "desc": "
Returns the Diffie-Hellman private key in the specified encoding,\nwhich can be 'binary', 'hex', or 'base64'. If encoding is provided a\nstring is returned; otherwise a Buffer is returned.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "diffieHellman.getPublicKey([encoding])",
              "type": "method",
              "name": "getPublicKey",
              "meta": {
                "added": [
                  "v0.5.0"
                ]
              },
              "desc": "
Returns the Diffie-Hellman public key in the specified encoding, which\ncan be 'binary', 'hex', or 'base64'. If encoding is provided a\nstring is returned; otherwise a Buffer is returned.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "diffieHellman.setPrivateKey(private_key[, encoding])",
              "type": "method",
              "name": "setPrivateKey",
              "meta": {
                "added": [
                  "v0.5.0"
                ]
              },
              "desc": "
Sets the Diffie-Hellman private key. If the encoding argument is provided\nand is either 'binary', 'hex', or 'base64', private_key is expected\nto be a string. If no encoding is provided, private_key is expected\nto be a Buffer.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "private_key"
                    },
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "diffieHellman.setPublicKey(public_key[, encoding])",
              "type": "method",
              "name": "setPublicKey",
              "meta": {
                "added": [
                  "v0.5.0"
                ]
              },
              "desc": "
Sets the Diffie-Hellman public key. If the encoding argument is provided\nand is either 'binary', 'hex' or 'base64', public_key is expected\nto be a string. If no encoding is provided, public_key is expected\nto be a Buffer.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "public_key"
                    },
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            }
          ],
          "properties": [
            {
              "textRaw": "diffieHellman.verifyError",
              "name": "verifyError",
              "meta": {
                "added": [
                  "v0.11.12"
                ]
              },
              "desc": "
A bit field containing any warnings and/or errors resulting from a check\nperformed during initialization of the DiffieHellman object.
\n
The following values are valid for this property (as defined in constants\nmodule):
\n
    \n
  • DH_CHECK_P_NOT_SAFE_PRIME
    • \n
  • DH_CHECK_P_NOT_PRIME
    • \n
  • DH_UNABLE_TO_CHECK_GENERATOR
    • \n
  • DH_NOT_SUITABLE_GENERATOR
    • \n
\n"
            }
          ]
        },
        {
          "textRaw": "Class: ECDH",
          "type": "class",
          "name": "ECDH",
          "meta": {
            "added": [
              "v0.11.14"
            ]
          },
          "desc": "
The ECDH class is a utility for creating Elliptic Curve Diffie-Hellman (ECDH)\nkey exchanges.
\n
Instances of the ECDH class can be created using the\ncrypto.createECDH() function.
\n
const crypto = require('crypto');\nconst assert = require('assert');\n\n// Generate Alice's keys...\nconst alice = crypto.createECDH('secp521r1');\nconst alice_key = alice.generateKeys();\n\n// Generate Bob's keys...\nconst bob = crypto.createECDH('secp521r1');\nconst bob_key = bob.generateKeys();\n\n// Exchange and generate the secret...\nconst alice_secret = alice.computeSecret(bob_key);\nconst bob_secret = bob.computeSecret(alice_key);\n\nassert(alice_secret, bob_secret);\n  // OK\n
\n",
          "methods": [
            {
              "textRaw": "ecdh.computeSecret(other_public_key[, input_encoding][, output_encoding])",
              "type": "method",
              "name": "computeSecret",
              "meta": {
                "added": [
                  "v0.11.14"
                ]
              },
              "desc": "
Computes the shared secret using other_public_key as the other\nparty's public key and returns the computed shared secret. The supplied\nkey is interpreted using specified input_encoding, and the returned secret\nis encoded using the specified output_encoding. Encodings can be\n'binary', 'hex', or 'base64'. If the input_encoding is not\nprovided, other_public_key is expected to be a Buffer.
\n
If output_encoding is given a string will be returned; otherwise a\nBuffer is returned.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "other_public_key"
                    },
                    {
                      "name": "input_encoding",
                      "optional": true
                    },
                    {
                      "name": "output_encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "ecdh.generateKeys([encoding[, format]])",
              "type": "method",
              "name": "generateKeys",
              "meta": {
                "added": [
                  "v0.11.14"
                ]
              },
              "desc": "
Generates private and public EC Diffie-Hellman key values, and returns\nthe public key in the specified format and encoding. This key should be\ntransferred to the other party.
\n
The format arguments specifies point encoding and can be 'compressed',\n'uncompressed', or 'hybrid'. If format is not specified, the point will\nbe returned in 'uncompressed' format.
\n
The encoding argument can be 'binary', 'hex', or 'base64'. If\nencoding is provided a string is returned; otherwise a Buffer\nis returned.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "encoding",
                      "optional": true
                    },
                    {
                      "name": "format",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "ecdh.getPrivateKey([encoding])",
              "type": "method",
              "name": "getPrivateKey",
              "meta": {
                "added": [
                  "v0.11.14"
                ]
              },
              "desc": "
Returns the EC Diffie-Hellman private key in the specified encoding,\nwhich can be 'binary', 'hex', or 'base64'. If encoding is provided\na string is returned; otherwise a Buffer is returned.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "ecdh.getPublicKey([encoding[, format]])",
              "type": "method",
              "name": "getPublicKey",
              "meta": {
                "added": [
                  "v0.11.14"
                ]
              },
              "desc": "
Returns the EC Diffie-Hellman public key in the specified encoding and\nformat.
\n
The format argument specifies point encoding and can be 'compressed',\n'uncompressed', or 'hybrid'. If format is not specified the point will be\nreturned in 'uncompressed' format.
\n
The encoding argument can be 'binary', 'hex', or 'base64'. If\nencoding is specified, a string is returned; otherwise a Buffer is\nreturned.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "encoding",
                      "optional": true
                    },
                    {
                      "name": "format",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "ecdh.setPrivateKey(private_key[, encoding])",
              "type": "method",
              "name": "setPrivateKey",
              "meta": {
                "added": [
                  "v0.11.14"
                ]
              },
              "desc": "
Sets the EC Diffie-Hellman private key. The encoding can be 'binary',\n'hex' or 'base64'. If encoding is provided, private_key is expected\nto be a string; otherwise private_key is expected to be a Buffer. If\nprivate_key is not valid for the curve specified when the ECDH object was\ncreated, an error is thrown. Upon setting the private key, the associated\npublic point (key) is also generated and set in the ECDH object.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "private_key"
                    },
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "ecdh.setPublicKey(public_key[, encoding])",
              "type": "method",
              "name": "setPublicKey",
              "meta": {
                "added": [
                  "v0.11.14"
                ],
                "deprecated": [
                  "v5.2.0"
                ]
              },
              "stability": 0,
              "stabilityText": "Deprecated",
              "desc": "
Sets the EC Diffie-Hellman public key. Key encoding can be 'binary',\n'hex' or 'base64'. If encoding is provided public_key is expected to\nbe a string; otherwise a Buffer is expected.
\n
Note that there is not normally a reason to call this method because ECDH\nonly requires a private key and the other party's public key to compute the\nshared secret. Typically either ecdh.generateKeys() or\necdh.setPrivateKey() will be called. The ecdh.setPrivateKey() method\nattempts to generate the public point/key associated with the private key being\nset.
\n
Example (obtaining a shared secret):
\n
const crypto = require('crypto');\nconst alice = crypto.createECDH('secp256k1');\nconst bob = crypto.createECDH('secp256k1');\n\n// Note: This is a shortcut way to specify one of Alice's previous private\n// keys. It would be unwise to use such a predictable private key in a real\n// application.\nalice.setPrivateKey(\n  crypto.createHash('sha256').update('alice', 'utf8').digest()\n);\n\n// Bob uses a newly generated cryptographically strong\n// pseudorandom key pair bob.generateKeys();\n\nconst alice_secret = alice.computeSecret(bob.getPublicKey(), null, 'hex');\nconst bob_secret = bob.computeSecret(alice.getPublicKey(), null, 'hex');\n\n// alice_secret and bob_secret should be the same shared secret value\nconsole.log(alice_secret === bob_secret);\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "public_key"
                    },
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "textRaw": "Class: Hash",
          "type": "class",
          "name": "Hash",
          "meta": {
            "added": [
              "v0.1.92"
            ]
          },
          "desc": "
The Hash class is a utility for creating hash digests of data. It can be\nused in one of two ways:
\n
    \n
  • As a stream that is both readable and writable, where data is written\nto produce a computed hash digest on the readable side, or
    • \n
  • Using the hash.update() and hash.digest() methods to produce the\ncomputed hash.
    • \n
\n
The crypto.createHash() method is used to create Hash instances. Hash\nobjects are not to be created directly using the new keyword.
\n
Example: Using Hash objects as streams:
\n
const crypto = require('crypto');\nconst hash = crypto.createHash('sha256');\n\nhash.on('readable', () => {\n  var data = hash.read();\n  if (data)\n    console.log(data.toString('hex'));\n    // Prints:\n    //   6a2da20943931e9834fc12cfe5bb47bbd9ae43489a30726962b576f4e3993e50\n});\n\nhash.write('some data to hash');\nhash.end();\n
\n
Example: Using Hash and piped streams:
\n
const crypto = require('crypto');\nconst fs = require('fs');\nconst hash = crypto.createHash('sha256');\n\nconst input = fs.createReadStream('test.js');\ninput.pipe(hash).pipe(process.stdout);\n
\n
Example: Using the hash.update() and hash.digest() methods:
\n
const crypto = require('crypto');\nconst hash = crypto.createHash('sha256');\n\nhash.update('some data to hash');\nconsole.log(hash.digest('hex'));\n  // Prints:\n  //   6a2da20943931e9834fc12cfe5bb47bbd9ae43489a30726962b576f4e3993e50\n
\n",
          "methods": [
            {
              "textRaw": "hash.digest([encoding])",
              "type": "method",
              "name": "digest",
              "meta": {
                "added": [
                  "v0.1.92"
                ]
              },
              "desc": "
Calculates the digest of all of the data passed to be hashed (using the\nhash.update() method). The encoding can be 'hex', 'binary' or\n'base64'. If encoding is provided a string will be returned; otherwise\na Buffer is returned.
\n
The Hash object can not be used again after hash.digest() method has been\ncalled. Multiple calls will cause an error to be thrown.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "hash.update(data[, input_encoding])",
              "type": "method",
              "name": "update",
              "meta": {
                "added": [
                  "v0.1.92"
                ]
              },
              "desc": "
Updates the hash content with the given data, the encoding of which\nis given in input_encoding and can be 'utf8', 'ascii' or\n'binary'. If encoding is not provided, and the data is a string, an\nencoding of 'binary' is enforced. If data is a Buffer then\ninput_encoding is ignored.
\n
This can be called many times with new data as it is streamed.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "data"
                    },
                    {
                      "name": "input_encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "textRaw": "Class: Hmac",
          "type": "class",
          "name": "Hmac",
          "meta": {
            "added": [
              "v0.1.94"
            ]
          },
          "desc": "
The Hmac Class is a utility for creating cryptographic HMAC digests. It can\nbe used in one of two ways:
\n
    \n
  • As a stream that is both readable and writable, where data is written\nto produce a computed HMAC digest on the readable side, or
    • \n
  • Using the hmac.update() and hmac.digest() methods to produce the\ncomputed HMAC digest.
    • \n
\n
The crypto.createHmac() method is used to create Hmac instances. Hmac\nobjects are not to be created directly using the new keyword.
\n
Example: Using Hmac objects as streams:
\n
const crypto = require('crypto');\nconst hmac = crypto.createHmac('sha256', 'a secret');\n\nhmac.on('readable', () => {\n  var data = hmac.read();\n  if (data)\n    console.log(data.toString('hex'));\n    // Prints:\n    //   7fd04df92f636fd450bc841c9418e5825c17f33ad9c87c518115a45971f7f77e\n});\n\nhmac.write('some data to hash');\nhmac.end();\n
\n
Example: Using Hmac and piped streams:
\n
const crypto = require('crypto');\nconst fs = require('fs');\nconst hmac = crypto.createHmac('sha256', 'a secret');\n\nconst input = fs.createReadStream('test.js');\ninput.pipe(hmac).pipe(process.stdout);\n
\n
Example: Using the hmac.update() and hmac.digest() methods:
\n
const crypto = require('crypto');\nconst hmac = crypto.createHmac('sha256', 'a secret');\n\nhmac.update('some data to hash');\nconsole.log(hmac.digest('hex'));\n  // Prints:\n  //   7fd04df92f636fd450bc841c9418e5825c17f33ad9c87c518115a45971f7f77e\n
\n",
          "methods": [
            {
              "textRaw": "hmac.digest([encoding])",
              "type": "method",
              "name": "digest",
              "meta": {
                "added": [
                  "v0.1.94"
                ]
              },
              "desc": "
Calculates the HMAC digest of all of the data passed using hmac.update().\nThe encoding can be 'hex', 'binary' or 'base64'. If encoding is\nprovided a string is returned; otherwise a Buffer is returned;
\n
The Hmac object can not be used again after hmac.digest() has been\ncalled. Multiple calls to hmac.digest() will result in an error being thrown.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "hmac.update(data[, input_encoding])",
              "type": "method",
              "name": "update",
              "meta": {
                "added": [
                  "v0.1.94"
                ]
              },
              "desc": "
Updates the Hmac content with the given data, the encoding of which\nis given in input_encoding and can be 'utf8', 'ascii' or\n'binary'. If encoding is not provided, and the data is a string, an\nencoding of 'utf8' is enforced. If data is a Buffer then\ninput_encoding is ignored.
\n
This can be called many times with new data as it is streamed.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "data"
                    },
                    {
                      "name": "input_encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "textRaw": "Class: Sign",
          "type": "class",
          "name": "Sign",
          "meta": {
            "added": [
              "v0.1.92"
            ]
          },
          "desc": "
The Sign Class is a utility for generating signatures. It can be used in one\nof two ways:
\n
    \n
  • As a writable stream, where data to be signed is written and the\nsign.sign() method is used to generate and return the signature, or
    • \n
  • Using the sign.update() and sign.sign() methods to produce the\nsignature.
    • \n
\n
The crypto.createSign() method is used to create Sign instances. Sign\nobjects are not to be created directly using the new keyword.
\n
Example: Using Sign objects as streams:
\n
const crypto = require('crypto');\nconst sign = crypto.createSign('RSA-SHA256');\n\nsign.write('some data to sign');\nsign.end();\n\nconst private_key = getPrivateKeySomehow();\nconsole.log(sign.sign(private_key, 'hex'));\n  // Prints the calculated signature\n
\n
Example: Using the sign.update() and sign.sign() methods:
\n
const crypto = require('crypto');\nconst sign = crypto.createSign('RSA-SHA256');\n\nsign.update('some data to sign');\n\nconst private_key = getPrivateKeySomehow();\nconsole.log(sign.sign(private_key, 'hex'));\n  // Prints the calculated signature\n
\n
A Sign instance can also be created by just passing in the digest\nalgorithm name, in which case OpenSSL will infer the full signature algorithm\nfrom the type of the PEM-formatted private key, including algorithms that\ndo not have directly exposed name constants, e.g. 'ecdsa-with-SHA256'.
\n
Example: signing using ECDSA with SHA256
\n
const crypto = require('crypto');\nconst sign = crypto.createSign('sha256');\n\nsign.update('some data to sign');\n\nconst private_key = '-----BEGIN EC PRIVATE KEY-----\\n' +\n        'MHcCAQEEIF+jnWY1D5kbVYDNvxxo/Y+ku2uJPDwS0r/VuPZQrjjVoAoGCCqGSM49\\n' +\n        'AwEHoUQDQgAEurOxfSxmqIRYzJVagdZfMMSjRNNhB8i3mXyIMq704m2m52FdfKZ2\\n' +\n        'pQhByd5eyj3lgZ7m7jbchtdgyOF8Io/1ng==\\n' +\n        '-----END EC PRIVATE KEY-----\\n';\n\nconsole.log(sign.sign(private_key).toString('hex'));\n
\n",
          "methods": [
            {
              "textRaw": "sign.sign(private_key[, output_format])",
              "type": "method",
              "name": "sign",
              "meta": {
                "added": [
                  "v0.1.92"
                ]
              },
              "desc": "
Calculates the signature on all the data passed through using either\nsign.update() or sign.write().
\n
The private_key argument can be an object or a string. If private_key is a\nstring, it is treated as a raw key with no passphrase. If private_key is an\nobject, it is interpreted as a hash containing two properties:
\n
    \n
  • key : {String} - PEM encoded private key
    • \n
  • passphrase : {String} - passphrase for the private key
    • \n
\n
The output_format can specify one of 'binary', 'hex' or 'base64'. If\noutput_format is provided a string is returned; otherwise a Buffer is\nreturned.
\n
The Sign object can not be again used after sign.sign() method has been\ncalled. Multiple calls to sign.sign() will result in an error being thrown.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "private_key"
                    },
                    {
                      "name": "output_format",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "sign.update(data[, input_encoding])",
              "type": "method",
              "name": "update",
              "meta": {
                "added": [
                  "v0.1.92"
                ]
              },
              "desc": "
Updates the Sign content with the given data, the encoding of which\nis given in input_encoding and can be 'utf8', 'ascii' or\n'binary'. If encoding is not provided, and the data is a string, an\nencoding of 'utf8' is enforced. If data is a Buffer then\ninput_encoding is ignored.
\n
This can be called many times with new data as it is streamed.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "data"
                    },
                    {
                      "name": "input_encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "textRaw": "Class: Verify",
          "type": "class",
          "name": "Verify",
          "meta": {
            "added": [
              "v0.1.92"
            ]
          },
          "desc": "
The Verify class is a utility for verifying signatures. It can be used in one\nof two ways:
\n
    \n
  • As a writable stream where written data is used to validate against the\nsupplied signature, or
    • \n
  • Using the verify.update() and verify.verify() methods to verify\nthe signature.
    • \n
\n
The [crypto.createVerify()][] method is used to create Verify instances.\nVerify objects are not to be created directly using the new keyword.
\n
Example: Using Verify objects as streams:
\n
const crypto = require('crypto');\nconst verify = crypto.createVerify('RSA-SHA256');\n\nverify.write('some data to sign');\nverify.end();\n\nconst public_key = getPublicKeySomehow();\nconst signature = getSignatureToVerify();\nconsole.log(verify.verify(public_key, signature));\n  // Prints true or false\n
\n
Example: Using the verify.update() and verify.verify() methods:
\n
const crypto = require('crypto');\nconst verify = crypto.createVerify('RSA-SHA256');\n\nverify.update('some data to sign');\n\nconst public_key = getPublicKeySomehow();\nconst signature = getSignatureToVerify();\nconsole.log(verify.verify(public_key, signature));\n  // Prints true or false\n
\n",
          "methods": [
            {
              "textRaw": "verifier.update(data[, input_encoding])",
              "type": "method",
              "name": "update",
              "meta": {
                "added": [
                  "v0.1.92"
                ]
              },
              "desc": "
Updates the Verify content with the given data, the encoding of which\nis given in input_encoding and can be 'utf8', 'ascii' or\n'binary'. If encoding is not provided, and the data is a string, an\nencoding of 'utf8' is enforced. If data is a Buffer then\ninput_encoding is ignored.
\n
This can be called many times with new data as it is streamed.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "data"
                    },
                    {
                      "name": "input_encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "verifier.verify(object, signature[, signature_format])",
              "type": "method",
              "name": "verify",
              "meta": {
                "added": [
                  "v0.1.92"
                ]
              },
              "desc": "
Verifies the provided data using the given object and signature.\nThe object argument is a string containing a PEM encoded object, which can be\none an RSA public key, a DSA public key, or an X.509 certificate.\nThe signature argument is the previously calculated signature for the data, in\nthe signature_format which can be 'binary', 'hex' or 'base64'.\nIf a signature_format is specified, the signature is expected to be a\nstring; otherwise signature is expected to be a Buffer.
\n
Returns true or false depending on the validity of the signature for\nthe data and public key.
\n
The verifier object can not be used again after verify.verify() has been\ncalled. Multiple calls to verify.verify() will result in an error being\nthrown.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "object"
                    },
                    {
                      "name": "signature"
                    },
                    {
                      "name": "signature_format",
                      "optional": true
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "modules": [
        {
          "textRaw": "`crypto` module methods and properties",
          "name": "`crypto`_module_methods_and_properties",
          "properties": [
            {
              "textRaw": "crypto.DEFAULT_ENCODING",
              "name": "DEFAULT_ENCODING",
              "meta": {
                "added": [
                  "v0.9.3"
                ]
              },
              "desc": "
The default encoding to use for functions that can take either strings\nor buffers. The default value is 'buffer', which makes methods\ndefault to Buffer objects.
\n
The crypto.DEFAULT_ENCODING mechanism is provided for backwards compatibility\nwith legacy programs that expect 'binary' to be the default encoding.
\n
New applications should expect the default to be 'buffer'. This property may\nbecome deprecated in a future Node.js release.
\n"
            }
          ],
          "methods": [
            {
              "textRaw": "crypto.createCipher(algorithm, password)",
              "type": "method",
              "name": "createCipher",
              "meta": {
                "added": [
                  "v0.1.94"
                ]
              },
              "desc": "
Creates and returns a Cipher object that uses the given algorithm and\npassword.
\n
The algorithm is dependent on OpenSSL, examples are 'aes192', etc. On\nrecent OpenSSL releases, openssl list-cipher-algorithms will display the\navailable cipher algorithms.
\n
The password is used to derive the cipher key and initialization vector (IV).\nThe value must be either a 'binary' encoded string or a Buffer.
\n
The implementation of crypto.createCipher() derives keys using the OpenSSL\nfunction EVP_BytesToKey with the digest algorithm set to MD5, one\niteration, and no salt. The lack of salt allows dictionary attacks as the same\npassword always creates the same key. The low iteration count and\nnon-cryptographically secure hash algorithm allow passwords to be tested very\nrapidly.
\n
In line with OpenSSL's recommendation to use pbkdf2 instead of\nEVP_BytesToKey it is recommended that developers derive a key and IV on\ntheir own using crypto.pbkdf2() and to use crypto.createCipheriv()\nto create the Cipher object.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "algorithm"
                    },
                    {
                      "name": "password"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.createCipheriv(algorithm, key, iv)",
              "type": "method",
              "name": "createCipheriv",
              "desc": "
Creates and returns a Cipher object, with the given algorithm, key and\ninitialization vector (iv).
\n
The algorithm is dependent on OpenSSL, examples are 'aes192', etc. On\nrecent OpenSSL releases, openssl list-cipher-algorithms will display the\navailable cipher algorithms.
\n
The key is the raw key used by the algorithm and iv is an\ninitialization vector. Both arguments must be 'binary' encoded strings or\nbuffers.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "algorithm"
                    },
                    {
                      "name": "key"
                    },
                    {
                      "name": "iv"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.createCredentials(details)",
              "type": "method",
              "name": "createCredentials",
              "meta": {
                "added": [
                  "v0.1.92"
                ],
                "deprecated": [
                  "v0.11.13"
                ]
              },
              "stability": 0,
              "stabilityText": "Deprecated: Use [`tls.createSecureContext()`][] instead.",
              "desc": "
The crypto.createCredentials() method is a deprecated alias for creating\nand returning a tls.SecureContext object. The crypto.createCredentials()\nmethod should not be used.
\n
The optional details argument is a hash object with keys:
\n
    \n
  • pfx : {String|Buffer} - PFX or PKCS12 encoded private\nkey, certificate and CA certificates
    • \n
  • key : {String} - PEM encoded private key
    • \n
  • passphrase : {String} - passphrase for the private key or PFX
    • \n
  • cert : {String} - PEM encoded certificate
    • \n
  • ca : {String|Array} - Either a string or array of strings of PEM encoded CA\ncertificates to trust.
    • \n
  • crl : {String|Array} - Either a string or array of strings of PEM encoded CRLs\n(Certificate Revocation List)
    • \n
  • ciphers: {String} using the OpenSSL cipher list format describing the\ncipher algorithms to use or exclude.
    • \n
\n
If no 'ca' details are given, Node.js will use Mozilla's default\npublicly trusted list of CAs.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "details"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.createDecipher(algorithm, password)",
              "type": "method",
              "name": "createDecipher",
              "meta": {
                "added": [
                  "v0.1.94"
                ]
              },
              "desc": "
Creates and returns a Decipher object that uses the given algorithm and\npassword (key).
\n
The implementation of crypto.createDecipher() derives keys using the OpenSSL\nfunction EVP_BytesToKey with the digest algorithm set to MD5, one\niteration, and no salt. The lack of salt allows dictionary attacks as the same\npassword always creates the same key. The low iteration count and\nnon-cryptographically secure hash algorithm allow passwords to be tested very\nrapidly.
\n
In line with OpenSSL's recommendation to use pbkdf2 instead of\nEVP_BytesToKey it is recommended that developers derive a key and IV on\ntheir own using crypto.pbkdf2() and to use crypto.createDecipheriv()\nto create the Decipher object.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "algorithm"
                    },
                    {
                      "name": "password"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.createDecipheriv(algorithm, key, iv)",
              "type": "method",
              "name": "createDecipheriv",
              "meta": {
                "added": [
                  "v0.1.94"
                ]
              },
              "desc": "
Creates and returns a Decipher object that uses the given algorithm, key\nand initialization vector (iv).
\n
The algorithm is dependent on OpenSSL, examples are 'aes192', etc. On\nrecent OpenSSL releases, openssl list-cipher-algorithms will display the\navailable cipher algorithms.
\n
The key is the raw key used by the algorithm and iv is an\ninitialization vector. Both arguments must be 'binary' encoded strings or\nbuffers.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "algorithm"
                    },
                    {
                      "name": "key"
                    },
                    {
                      "name": "iv"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.createDiffieHellman(prime[, prime_encoding][, generator][, generator_encoding])",
              "type": "method",
              "name": "createDiffieHellman",
              "meta": {
                "added": [
                  "v0.11.12"
                ]
              },
              "desc": "
Creates a DiffieHellman key exchange object using the supplied prime and an\noptional specific generator.
\n
The generator argument can be a number, string, or Buffer. If\ngenerator is not specified, the value 2 is used.
\n
The prime_encoding and generator_encoding arguments can be 'binary',\n'hex', or 'base64'.
\n
If prime_encoding is specified, prime is expected to be a string; otherwise\na Buffer is expected.
\n
If generator_encoding is specified, generator is expected to be a string;\notherwise either a number or Buffer is expected.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "prime"
                    },
                    {
                      "name": "prime_encoding",
                      "optional": true
                    },
                    {
                      "name": "generator",
                      "optional": true
                    },
                    {
                      "name": "generator_encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.createDiffieHellman(prime_length[, generator])",
              "type": "method",
              "name": "createDiffieHellman",
              "meta": {
                "added": [
                  "v0.5.0"
                ]
              },
              "desc": "
Creates a DiffieHellman key exchange object and generates a prime of\nprime_length bits using an optional specific numeric generator.\nIf generator is not specified, the value 2 is used.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "prime_length"
                    },
                    {
                      "name": "generator",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.createECDH(curve_name)",
              "type": "method",
              "name": "createECDH",
              "meta": {
                "added": [
                  "v0.11.14"
                ]
              },
              "desc": "
Creates an Elliptic Curve Diffie-Hellman (ECDH) key exchange object using a\npredefined curve specified by the curve_name string. Use\ncrypto.getCurves() to obtain a list of available curve names. On recent\nOpenSSL releases, openssl ecparam -list_curves will also display the name\nand description of each available elliptic curve.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "curve_name"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.createHash(algorithm)",
              "type": "method",
              "name": "createHash",
              "meta": {
                "added": [
                  "v0.1.92"
                ]
              },
              "desc": "
Creates and returns a Hash object that can be used to generate hash digests\nusing the given algorithm.
\n
The algorithm is dependent on the available algorithms supported by the\nversion of OpenSSL on the platform. Examples are 'sha256', 'sha512', etc.\nOn recent releases of OpenSSL, openssl list-message-digest-algorithms will\ndisplay the available digest algorithms.
\n
Example: generating the sha256 sum of a file
\n
const filename = process.argv[2];\nconst crypto = require('crypto');\nconst fs = require('fs');\n\nconst hash = crypto.createHash('sha256');\n\nconst input = fs.createReadStream(filename);\ninput.on('readable', () => {\n  var data = input.read();\n  if (data)\n    hash.update(data);\n  else {\n    console.log(`${hash.digest('hex')} ${filename}`);\n  }\n});\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "algorithm"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.createHmac(algorithm, key)",
              "type": "method",
              "name": "createHmac",
              "meta": {
                "added": [
                  "v0.1.94"
                ]
              },
              "desc": "
Creates and returns an Hmac object that uses the given algorithm and key.
\n
The algorithm is dependent on the available algorithms supported by the\nversion of OpenSSL on the platform. Examples are 'sha256', 'sha512', etc.\nOn recent releases of OpenSSL, openssl list-message-digest-algorithms will\ndisplay the available digest algorithms.
\n
The key is the HMAC key used to generate the cryptographic HMAC hash.
\n
Example: generating the sha256 HMAC of a file
\n
const filename = process.argv[2];\nconst crypto = require('crypto');\nconst fs = require('fs');\n\nconst hmac = crypto.createHmac('sha256', 'a secret');\n\nconst input = fs.createReadStream(filename);\ninput.on('readable', () => {\n  var data = input.read();\n  if (data)\n    hmac.update(data);\n  else {\n    console.log(`${hmac.digest('hex')} ${filename}`);\n  }\n});\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "algorithm"
                    },
                    {
                      "name": "key"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.createSign(algorithm)",
              "type": "method",
              "name": "createSign",
              "meta": {
                "added": [
                  "v0.1.92"
                ]
              },
              "desc": "
Creates and returns a Sign object that uses the given algorithm.\nUse crypto.getHashes() to obtain an array of names of the available\nsigning algorithms.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "algorithm"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.createVerify(algorithm)",
              "type": "method",
              "name": "createVerify",
              "meta": {
                "added": [
                  "v0.1.92"
                ]
              },
              "desc": "
Creates and returns a Verify object that uses the given algorithm.\nUse crypto.getHashes() to obtain an array of names of the available\nsigning algorithms.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "algorithm"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.getCiphers()",
              "type": "method",
              "name": "getCiphers",
              "meta": {
                "added": [
                  "v0.9.3"
                ]
              },
              "desc": "
Returns an array with the names of the supported cipher algorithms.
\n
Example:
\n
const ciphers = crypto.getCiphers();\nconsole.log(ciphers); // ['aes-128-cbc', 'aes-128-ccm', ...]\n
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "crypto.getCurves()",
              "type": "method",
              "name": "getCurves",
              "meta": {
                "added": [
                  "v2.3.0"
                ]
              },
              "desc": "
Returns an array with the names of the supported elliptic curves.
\n
Example:
\n
const curves = crypto.getCurves();\nconsole.log(curves); // ['secp256k1', 'secp384r1', ...]\n
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "crypto.getDiffieHellman(group_name)",
              "type": "method",
              "name": "getDiffieHellman",
              "meta": {
                "added": [
                  "v0.7.5"
                ]
              },
              "desc": "
Creates a predefined DiffieHellman key exchange object. The\nsupported groups are: 'modp1', 'modp2', 'modp5' (defined in\nRFC 2412, but see Caveats) and 'modp14', 'modp15',\n'modp16', 'modp17', 'modp18' (defined in RFC 3526). The\nreturned object mimics the interface of objects created by\ncrypto.createDiffieHellman(), but will not allow changing\nthe keys (with diffieHellman.setPublicKey() for example). The\nadvantage of using this method is that the parties do not have to\ngenerate nor exchange a group modulus beforehand, saving both processor\nand communication time.
\n
Example (obtaining a shared secret):
\n
const crypto = require('crypto');\nconst alice = crypto.getDiffieHellman('modp14');\nconst bob = crypto.getDiffieHellman('modp14');\n\nalice.generateKeys();\nbob.generateKeys();\n\nconst alice_secret = alice.computeSecret(bob.getPublicKey(), null, 'hex');\nconst bob_secret = bob.computeSecret(alice.getPublicKey(), null, 'hex');\n\n/* alice_secret and bob_secret should be the same */\nconsole.log(alice_secret == bob_secret);\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "group_name"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.getHashes()",
              "type": "method",
              "name": "getHashes",
              "meta": {
                "added": [
                  "v0.9.3"
                ]
              },
              "desc": "
Returns an array of the names of the supported hash algorithms,\nsuch as RSA-SHA256.
\n
Example:
\n
const hashes = crypto.getHashes();\nconsole.log(hashes); // ['sha', 'sha1', 'sha1WithRSAEncryption', ...]\n
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "crypto.pbkdf2(password, salt, iterations, keylen[, digest], callback)",
              "type": "method",
              "name": "pbkdf2",
              "meta": {
                "added": [
                  "v0.5.5"
                ]
              },
              "desc": "
Provides an asynchronous Password-Based Key Derivation Function 2 (PBKDF2)\nimplementation. A selected HMAC digest algorithm specified by digest is\napplied to derive a key of the requested byte length (keylen) from the\npassword, salt and iterations. If the digest algorithm is not specified,\na default of 'sha1' is used.
\n
The supplied callback function is called with two arguments: err and\nderivedKey. If an error occurs, err will be set; otherwise err will be\nnull. The successfully generated derivedKey will be passed as a Buffer.
\n
The iterations argument must be a number set as high as possible. The\nhigher the number of iterations, the more secure the derived key will be,\nbut will take a longer amount of time to complete.
\n
The salt should also be as unique as possible. It is recommended that the\nsalts are random and their lengths are greater than 16 bytes. See\nNIST SP 800-132 for details.
\n
Example:
\n
const crypto = require('crypto');\ncrypto.pbkdf2('secret', 'salt', 100000, 512, 'sha512', (err, key) => {\n  if (err) throw err;\n  console.log(key.toString('hex'));  // 'c5e478d...1469e50'\n});\n
\n
An array of supported digest functions can be retrieved using\ncrypto.getHashes().
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "password"
                    },
                    {
                      "name": "salt"
                    },
                    {
                      "name": "iterations"
                    },
                    {
                      "name": "keylen"
                    },
                    {
                      "name": "digest",
                      "optional": true
                    },
                    {
                      "name": "callback"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.pbkdf2Sync(password, salt, iterations, keylen[, digest])",
              "type": "method",
              "name": "pbkdf2Sync",
              "meta": {
                "added": [
                  "v0.9.3"
                ]
              },
              "desc": "
Provides a synchronous Password-Based Key Derivation Function 2 (PBKDF2)\nimplementation. A selected HMAC digest algorithm specified by digest is\napplied to derive a key of the requested byte length (keylen) from the\npassword, salt and iterations. If the digest algorithm is not specified,\na default of 'sha1' is used.
\n
If an error occurs an Error will be thrown, otherwise the derived key will be\nreturned as a Buffer.
\n
The iterations argument must be a number set as high as possible. The\nhigher the number of iterations, the more secure the derived key will be,\nbut will take a longer amount of time to complete.
\n
The salt should also be as unique as possible. It is recommended that the\nsalts are random and their lengths are greater than 16 bytes. See\nNIST SP 800-132 for details.
\n
Example:
\n
const crypto = require('crypto');\nconst key = crypto.pbkdf2Sync('secret', 'salt', 100000, 512, 'sha512');\nconsole.log(key.toString('hex'));  // 'c5e478d...1469e50'\n
\n
An array of supported digest functions can be retrieved using\ncrypto.getHashes().
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "password"
                    },
                    {
                      "name": "salt"
                    },
                    {
                      "name": "iterations"
                    },
                    {
                      "name": "keylen"
                    },
                    {
                      "name": "digest",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.privateDecrypt(private_key, buffer)",
              "type": "method",
              "name": "privateDecrypt",
              "meta": {
                "added": [
                  "v0.11.14"
                ]
              },
              "desc": "
Decrypts buffer with private_key.
\n
private_key can be an object or a string. If private_key is a string, it is\ntreated as the key with no passphrase and will use RSA_PKCS1_OAEP_PADDING.\nIf private_key is an object, it is interpreted as a hash object with the\nkeys:
\n
    \n
  • key : {String} - PEM encoded private key
    • \n
  • passphrase : {String} - Optional passphrase for the private key
    • \n
  • padding : An optional padding value, one of the following:
      \n
    • constants.RSA_NO_PADDING
      • \n
    • constants.RSA_PKCS1_PADDING
      • \n
    • constants.RSA_PKCS1_OAEP_PADDING
      • \n
    \n
    • \n
\n
All paddings are defined in the constants module.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "private_key"
                    },
                    {
                      "name": "buffer"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.privateEncrypt(private_key, buffer)",
              "type": "method",
              "name": "privateEncrypt",
              "meta": {
                "added": [
                  "v1.1.0"
                ]
              },
              "desc": "
Encrypts buffer with private_key.
\n
private_key can be an object or a string. If private_key is a string, it is\ntreated as the key with no passphrase and will use RSA_PKCS1_PADDING.\nIf private_key is an object, it is interpreted as a hash object with the\nkeys:
\n
    \n
  • key : {String} - PEM encoded private key
    • \n
  • passphrase : {String} - Optional passphrase for the private key
    • \n
  • padding : An optional padding value, one of the following:
      \n
    • constants.RSA_NO_PADDING
      • \n
    • constants.RSA_PKCS1_PADDING
      • \n
    \n
    • \n
\n
All paddings are defined in the constants module.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "private_key"
                    },
                    {
                      "name": "buffer"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.publicDecrypt(public_key, buffer)",
              "type": "method",
              "name": "publicDecrypt",
              "meta": {
                "added": [
                  "v1.1.0"
                ]
              },
              "desc": "
Decrypts buffer with public_key.
\n
public_key can be an object or a string. If public_key is a string, it is\ntreated as the key with no passphrase and will use RSA_PKCS1_PADDING.\nIf public_key is an object, it is interpreted as a hash object with the\nkeys:
\n
    \n
  • key : {String} - PEM encoded public key
    • \n
  • passphrase : {String} - Optional passphrase for the private key
    • \n
  • padding : An optional padding value, one of the following:
      \n
    • constants.RSA_NO_PADDING
      • \n
    • constants.RSA_PKCS1_PADDING
      • \n
    • constants.RSA_PKCS1_OAEP_PADDING
      • \n
    \n
    • \n
\n
Because RSA public keys can be derived from private keys, a private key may\nbe passed instead of a public key.
\n
All paddings are defined in the constants module.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "public_key"
                    },
                    {
                      "name": "buffer"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.publicEncrypt(public_key, buffer)",
              "type": "method",
              "name": "publicEncrypt",
              "meta": {
                "added": [
                  "v0.11.14"
                ]
              },
              "desc": "
Encrypts buffer with public_key.
\n
public_key can be an object or a string. If public_key is a string, it is\ntreated as the key with no passphrase and will use RSA_PKCS1_OAEP_PADDING.\nIf public_key is an object, it is interpreted as a hash object with the\nkeys:
\n
    \n
  • key : {String} - PEM encoded public key
    • \n
  • passphrase : {String} - Optional passphrase for the private key
    • \n
  • padding : An optional padding value, one of the following:
      \n
    • constants.RSA_NO_PADDING
      • \n
    • constants.RSA_PKCS1_PADDING
      • \n
    • constants.RSA_PKCS1_OAEP_PADDING
      • \n
    \n
    • \n
\n
Because RSA public keys can be derived from private keys, a private key may\nbe passed instead of a public key.
\n
All paddings are defined in the constants module.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "public_key"
                    },
                    {
                      "name": "buffer"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.randomBytes(size[, callback])",
              "type": "method",
              "name": "randomBytes",
              "meta": {
                "added": [
                  "v0.5.8"
                ]
              },
              "desc": "
Generates cryptographically strong pseudo-random data. The size argument\nis a number indicating the number of bytes to generate.
\n
If a callback function is provided, the bytes are generated asynchronously\nand the callback function is invoked with two arguments: err and buf.\nIf an error occurs, err will be an Error object; otherwise it is null. The\nbuf argument is a Buffer containing the generated bytes.
\n
// Asynchronous\nconst crypto = require('crypto');\ncrypto.randomBytes(256, (err, buf) => {\n  if (err) throw err;\n  console.log(`${buf.length} bytes of random data: ${buf.toString('hex')}`);\n});\n
\n
If the callback function is not provided, the random bytes are generated\nsynchronously and returned as a Buffer. An error will be thrown if\nthere is a problem generating the bytes.
\n
// Synchronous\nconst buf = crypto.randomBytes(256);\nconsole.log(\n  `${buf.length} bytes of random data: ${buf.toString('hex')}`);\n
\n
The crypto.randomBytes() method will block until there is sufficient entropy.\nThis should normally never take longer than a few milliseconds. The only time\nwhen generating the random bytes may conceivably block for a longer period of\ntime is right after boot, when the whole system is still low on entropy.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "size"
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.setEngine(engine[, flags])",
              "type": "method",
              "name": "setEngine",
              "meta": {
                "added": [
                  "v0.11.11"
                ]
              },
              "desc": "
Load and set the engine for some or all OpenSSL functions (selected by flags).
\n
engine could be either an id or a path to the engine's shared library.
\n
The optional flags argument uses ENGINE_METHOD_ALL by default. The flags\nis a bit field taking one of or a mix of the following flags (defined in the\nconstants module):
\n
    \n
  • ENGINE_METHOD_RSA
    • \n
  • ENGINE_METHOD_DSA
    • \n
  • ENGINE_METHOD_DH
    • \n
  • ENGINE_METHOD_RAND
    • \n
  • ENGINE_METHOD_ECDH
    • \n
  • ENGINE_METHOD_ECDSA
    • \n
  • ENGINE_METHOD_CIPHERS
    • \n
  • ENGINE_METHOD_DIGESTS
    • \n
  • ENGINE_METHOD_STORE
    • \n
  • ENGINE_METHOD_PKEY_METH
    • \n
  • ENGINE_METHOD_PKEY_ASN1_METH
    • \n
  • ENGINE_METHOD_ALL
    • \n
  • ENGINE_METHOD_NONE
    • \n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "engine"
                    },
                    {
                      "name": "flags",
                      "optional": true
                    }
                  ]
                }
              ]
            }
          ],
          "type": "module",
          "displayName": "`crypto` module methods and properties"
        },
        {
          "textRaw": "Notes",
          "name": "notes",
          "modules": [
            {
              "textRaw": "Legacy Streams API (pre Node.js v0.10)",
              "name": "legacy_streams_api_(pre_node.js_v0.10)",
              "desc": "
The Crypto module was added to Node.js before there was the concept of a\nunified Stream API, and before there were Buffer objects for handling\nbinary data. As such, the many of the crypto defined classes have methods not\ntypically found on other Node.js classes that implement the streams\nAPI (e.g. update(), final(), or digest()). Also, many methods accepted\nand returned 'binary' encoded strings by default rather than Buffers. This\ndefault was changed after Node.js v0.8 to use Buffer objects by default\ninstead.
\n",
              "type": "module",
              "displayName": "Legacy Streams API (pre Node.js v0.10)"
            },
            {
              "textRaw": "Recent ECDH Changes",
              "name": "recent_ecdh_changes",
              "desc": "
Usage of ECDH with non-dynamically generated key pairs has been simplified.\nNow, ecdh.setPrivateKey() can be called with a preselected private key\nand the associated public point (key) will be computed and stored in the object.\nThis allows code to only store and provide the private part of the EC key pair.\necdh.setPrivateKey() now also validates that the private key is valid for\nthe selected curve.
\n
The ecdh.setPublicKey() method is now deprecated as its inclusion in the\nAPI is not useful. Either a previously stored private key should be set, which\nautomatically generates the associated public key, or ecdh.generateKeys()\nshould be called. The main drawback of using ecdh.setPublicKey() is that\nit can be used to put the ECDH key pair into an inconsistent state.
\n",
              "type": "module",
              "displayName": "Recent ECDH Changes"
            },
            {
              "textRaw": "Support for weak or compromised algorithms",
              "name": "support_for_weak_or_compromised_algorithms",
              "desc": "
The crypto module still supports some algorithms which are already\ncompromised and are not currently recommended for use. The API also allows\nthe use of ciphers and hashes with a small key size that are considered to be\ntoo weak for safe use.
\n
Users should take full responsibility for selecting the crypto\nalgorithm and key size according to their security requirements.
\n
Based on the recommendations of NIST SP 800-131A:
\n
    \n
  • MD5 and SHA-1 are no longer acceptable where collision resistance is\nrequired such as digital signatures.
    • \n
  • The key used with RSA, DSA and DH algorithms is recommended to have\nat least 2048 bits and that of the curve of ECDSA and ECDH at least\n224 bits, to be safe to use for several years.
    • \n
  • The DH groups of modp1, modp2 and modp5 have a key size\nsmaller than 2048 bits and are not recommended.
    • \n
\n
See the reference for other recommendations and details.
\n\n\n",
              "type": "module",
              "displayName": "Support for weak or compromised algorithms"
            }
          ],
          "type": "module",
          "displayName": "Notes"
        }
      ],
      "type": "module",
      "displayName": "Crypto"
    },
    {
      "textRaw": "UDP / Datagram Sockets",
      "name": "dgram",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
The dgram module provides an implementation of UDP Datagram sockets.
\n
const dgram = require('dgram');\nconst server = dgram.createSocket('udp4');\n\nserver.on('error', (err) => {\n  console.log(`server error:\\n${err.stack}`);\n  server.close();\n});\n\nserver.on('message', (msg, rinfo) => {\n  console.log(`server got: ${msg} from ${rinfo.address}:${rinfo.port}`);\n});\n\nserver.on('listening', () => {\n  var address = server.address();\n  console.log(`server listening ${address.address}:${address.port}`);\n});\n\nserver.bind(41234);\n// server listening 0.0.0.0:41234\n
\n",
      "classes": [
        {
          "textRaw": "Class: dgram.Socket",
          "type": "class",
          "name": "dgram.Socket",
          "meta": {
            "added": [
              "v0.1.99"
            ]
          },
          "desc": "
The dgram.Socket object is an EventEmitter that encapsulates the\ndatagram functionality.
\n
New instances of dgram.Socket are created using dgram.createSocket().\nThe new keyword is not to be used to create dgram.Socket instances.
\n",
          "events": [
            {
              "textRaw": "Event: 'close'",
              "type": "event",
              "name": "close",
              "meta": {
                "added": [
                  "v0.1.99"
                ]
              },
              "desc": "
The 'close' event is emitted after a socket is closed with close().\nOnce triggered, no new 'message' events will be emitted on this socket.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'error'",
              "type": "event",
              "name": "error",
              "meta": {
                "added": [
                  "v0.1.99"
                ]
              },
              "params": [],
              "desc": "
The 'error' event is emitted whenever any error occurs. The event handler\nfunction is passed a single Error object.
\n"
            },
            {
              "textRaw": "Event: 'listening'",
              "type": "event",
              "name": "listening",
              "meta": {
                "added": [
                  "v0.1.99"
                ]
              },
              "desc": "
The 'listening' event is emitted whenever a socket begins listening for\ndatagram messages. This occurs as soon as UDP sockets are created.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'message'",
              "type": "event",
              "name": "message",
              "meta": {
                "added": [
                  "v0.1.99"
                ]
              },
              "desc": "
The 'message' event is emitted when a new datagram is available on a socket.\nThe event handler function is passed two arguments: msg and rinfo.
\n
    \n
  • msg {Buffer} - The message
    • \n
  • rinfo {Object} - Remote address information
      \n
    • address {String} The sender address
      • \n
    • family {String} The address family ('IPv4' or 'IPv6')
      • \n
    • port {Number} The sender port
      • \n
    • size {Number} The message size
      • \n
    \n
    • \n
\n",
              "params": []
            }
          ],
          "methods": [
            {
              "textRaw": "socket.addMembership(multicastAddress[, multicastInterface])",
              "type": "method",
              "name": "addMembership",
              "meta": {
                "added": [
                  "v0.6.9"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`multicastAddress` {String} ",
                      "name": "multicastAddress",
                      "type": "String"
                    },
                    {
                      "textRaw": "`multicastInterface` {String}, Optional ",
                      "name": "multicastInterface",
                      "type": "String",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "multicastAddress"
                    },
                    {
                      "name": "multicastInterface",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Tells the kernel to join a multicast group at the given multicastAddress and\nmulticastInterface using the IP_ADD_MEMBERSHIP socket option. If the\nmulticastInterface argument is not specified, the operating system will choose\none interface and will add membership to it. To add membership to every\navailable interface, call addMembership multiple times, once per interface.
\n"
            },
            {
              "textRaw": "socket.address()",
              "type": "method",
              "name": "address",
              "meta": {
                "added": [
                  "v0.1.99"
                ]
              },
              "desc": "
Returns an object containing the address information for a socket.\nFor UDP sockets, this object will contain address, family and port\nproperties.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "socket.bind([port][, address][, callback])",
              "type": "method",
              "name": "bind",
              "meta": {
                "added": [
                  "v0.1.99"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`port` {Number} - Integer, Optional ",
                      "name": "port",
                      "type": "Number",
                      "optional": true,
                      "desc": "Integer"
                    },
                    {
                      "textRaw": "`address` {String}, Optional ",
                      "name": "address",
                      "type": "String",
                      "optional": true
                    },
                    {
                      "textRaw": "`callback` {Function} with no parameters, Optional. Called when binding is complete. ",
                      "name": "callback",
                      "type": "Function",
                      "desc": "with no parameters, Optional. Called when binding is complete.",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "port",
                      "optional": true
                    },
                    {
                      "name": "address",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
For UDP sockets, causes the dgram.Socket to listen for datagram\nmessages on a named port and optional address. If port is not\nspecified or is 0, the operating system will attempt to bind to a\nrandom port. If address is not specified, the operating system will\nattempt to listen on all addresses.  Once binding is complete, a\n'listening' event is emitted and the optional callback function is\ncalled.
\n
Note that specifying both a 'listening' event listener and passing a\ncallback to the socket.bind() method is not harmful but not very\nuseful.
\n
A bound datagram socket keeps the Node.js process running to receive\ndatagram messages.
\n
If binding fails, an 'error' event is generated. In rare case (e.g.\nattempting to bind with a closed socket), an Error may be thrown.
\n
Example of a UDP server listening on port 41234:
\n
const dgram = require('dgram');\nconst server = dgram.createSocket('udp4');\n\nserver.on('error', (err) => {\n  console.log(`server error:\\n${err.stack}`);\n  server.close();\n});\n\nserver.on('message', (msg, rinfo) => {\n  console.log(`server got: ${msg} from ${rinfo.address}:${rinfo.port}`);\n});\n\nserver.on('listening', () => {\n  var address = server.address();\n  console.log(`server listening ${address.address}:${address.port}`);\n});\n\nserver.bind(41234);\n// server listening 0.0.0.0:41234\n
\n"
            },
            {
              "textRaw": "socket.bind(options[, callback])",
              "type": "method",
              "name": "bind",
              "meta": {
                "added": [
                  "v0.11.14"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`options` {Object} - Required. Supports the following properties: ",
                      "options": [
                        {
                          "textRaw": "`port` {Number} - Optional. ",
                          "name": "port",
                          "type": "Number",
                          "desc": "Optional."
                        },
                        {
                          "textRaw": "`address` {String} - Optional. ",
                          "name": "address",
                          "type": "String",
                          "desc": "Optional."
                        },
                        {
                          "textRaw": "`exclusive` {Boolean} - Optional. ",
                          "name": "exclusive",
                          "type": "Boolean",
                          "desc": "Optional."
                        }
                      ],
                      "name": "options",
                      "type": "Object",
                      "desc": "Required. Supports the following properties:"
                    },
                    {
                      "textRaw": "`callback` {Function} - Optional. ",
                      "name": "callback",
                      "type": "Function",
                      "desc": "Optional.",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "options"
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
For UDP sockets, causes the dgram.Socket to listen for datagram\nmessages on a named port and optional address that are passed as\nproperties of an options object passed as the first argument. If\nport is not specified or is 0, the operating system will attempt\nto bind to a random port. If address is not specified, the operating\nsystem will attempt to listen on all addresses.  Once binding is\ncomplete, a 'listening' event is emitted and the optional callback\nfunction is called.
\n
Note that specifying both a 'listening' event listener and passing a\ncallback to the socket.bind() method is not harmful but not very\nuseful.
\n
The options object may contain an additional exclusive property that is\nuse when using dgram.Socket objects with the cluster module. When\nexclusive is set to false (the default), cluster workers will use the same\nunderlying socket handle allowing connection handling duties to be shared.\nWhen exclusive is true, however, the handle is not shared and attempted\nport sharing results in an error.
\n
A bound datagram socket keeps the Node.js process running to receive\ndatagram messages.
\n
If binding fails, an 'error' event is generated. In rare case (e.g.\nattempting to bind with a closed socket), an Error may be thrown.
\n
An example socket listening on an exclusive port is shown below.
\n
socket.bind({\n  address: 'localhost',\n  port: 8000,\n  exclusive: true\n});\n
\n"
            },
            {
              "textRaw": "socket.close([callback])",
              "type": "method",
              "name": "close",
              "meta": {
                "added": [
                  "v0.1.99"
                ]
              },
              "desc": "
Close the underlying socket and stop listening for data on it. If a callback is\nprovided, it is added as a listener for the 'close' event.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "socket.dropMembership(multicastAddress[, multicastInterface])",
              "type": "method",
              "name": "dropMembership",
              "meta": {
                "added": [
                  "v0.6.9"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`multicastAddress` {String} ",
                      "name": "multicastAddress",
                      "type": "String"
                    },
                    {
                      "textRaw": "`multicastInterface` {String}, Optional ",
                      "name": "multicastInterface",
                      "type": "String",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "multicastAddress"
                    },
                    {
                      "name": "multicastInterface",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Instructs the kernel to leave a multicast group at multicastAddress using the\nIP_DROP_MEMBERSHIP socket option. This method is automatically called by the\nkernel when the socket is closed or the process terminates, so most apps will\nnever have reason to call this.
\n
If multicastInterface is not specified, the operating system will attempt to\ndrop membership on all valid interfaces.
\n"
            },
            {
              "textRaw": "socket.send(buf, offset, length, port, address[, callback])",
              "type": "method",
              "name": "send",
              "meta": {
                "added": [
                  "v0.1.99"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`buf` {Buffer|String} Message to be sent ",
                      "name": "buf",
                      "type": "Buffer|String",
                      "desc": "Message to be sent"
                    },
                    {
                      "textRaw": "`offset` {Number} Integer. Offset in the buffer where the message starts. ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "Integer. Offset in the buffer where the message starts."
                    },
                    {
                      "textRaw": "`length` {Number} Integer. Number of bytes in the message. ",
                      "name": "length",
                      "type": "Number",
                      "desc": "Integer. Number of bytes in the message."
                    },
                    {
                      "textRaw": "`port` {Number} Integer. Destination port. ",
                      "name": "port",
                      "type": "Number",
                      "desc": "Integer. Destination port."
                    },
                    {
                      "textRaw": "`address` {String} Destination hostname or IP address. ",
                      "name": "address",
                      "type": "String",
                      "desc": "Destination hostname or IP address."
                    },
                    {
                      "textRaw": "`callback` {Function} Called when the message has been sent. Optional. ",
                      "name": "callback",
                      "type": "Function",
                      "desc": "Called when the message has been sent. Optional.",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "length"
                    },
                    {
                      "name": "port"
                    },
                    {
                      "name": "address"
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Broadcasts a datagram on the socket. The destination port and address must\nbe specified.
\n
The buf argument is a Buffer object containing the message. The offset\nand length specify the offset within the Buffer where the message begins\nand the number of bytes in the message, respectively. With messages that\ncontain  multi-byte characters, offset and length will be calculated with\nrespect to byte length and not the character position.
\n
The address argument is a string. If the value of address is a host name,\nDNS will be used to resolve the address of the host. If the address is not\nspecified or is an empty string, '0.0.0.0' or '::0' will be used instead.\nIt is possible, depending on the network configuration, that these defaults\nmay not work; accordingly, it is best to be explicit about the destination\naddress.
\n
If the socket has not been previously bound with a call to bind, the socket\nis assigned a random port number and is bound to the "all interfaces" address\n('0.0.0.0' for udp4 sockets, '::0' for udp6 sockets.)
\n
An optional callback function  may be specified to as a way of reporting\nDNS errors or for determining when it is safe to reuse the buf object.\nNote that DNS lookups delay the time to send for at least one tick of the\nNode.js event loop.
\n
The only way to know for sure that the datagram has been sent is by using a\ncallback. If an error occurs and a callback is given, the error will be\npassed as the first argument to the callback. If a callback is not given,\nthe error is emitted as an 'error' event on the socket object.
\n
Example of sending a UDP packet to a random port on localhost;
\n
const dgram = require('dgram');\nconst message = new Buffer('Some bytes');\nconst client = dgram.createSocket('udp4');\nclient.send(message, 0, message.length, 41234, 'localhost', (err) => {\n  client.close();\n});\n
\n
A Note about UDP datagram size
\n
The maximum size of an IPv4/v6 datagram depends on the MTU\n(Maximum Transmission Unit) and on the Payload Length field size.
\n
    \n
  • The Payload Length field is 16 bits wide, which means that a normal\npayload exceed 64K octets including the internet header and data\n(65,507 bytes = 65,535 − 8 bytes UDP header − 20 bytes IP header);\nthis is generally true for loopback interfaces, but such long datagram\nmessages are impractical for most hosts and networks.
    \n
    • \n
  • The MTU is the largest size a given link layer technology can support for\ndatagram messages. For any link, IPv4 mandates a minimum MTU of 68\noctets, while the recommended MTU for IPv4 is 576 (typically recommended\nas the MTU for dial-up type applications), whether they arrive whole or in\nfragments.
    \n
    For IPv6, the minimum MTU is 1280 octets, however, the mandatory minimum\nfragment reassembly buffer size is 1500 octets. The value of 68 octets is\nvery small, since most current link layer technologies, like Ethernet, have a\nminimum MTU of 1500.
    \n
    • \n
\n
It is impossible to know in advance the MTU of each link through which\na packet might travel. Sending a datagram greater than the receiver MTU will\nnot work because the packet will get silently dropped without informing the\nsource that the data did not reach its intended recipient.
\n"
            },
            {
              "textRaw": "socket.setBroadcast(flag)",
              "type": "method",
              "name": "setBroadcast",
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`flag` {Boolean} ",
                      "name": "flag",
                      "type": "Boolean"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "flag"
                    }
                  ]
                }
              ],
              "desc": "
Sets or clears the SO_BROADCAST socket option.  When set to true, UDP\npackets may be sent to a local interface's broadcast address.
\n"
            },
            {
              "textRaw": "socket.setMulticastLoopback(flag)",
              "type": "method",
              "name": "setMulticastLoopback",
              "meta": {
                "added": [
                  "v0.3.8"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`flag` {Boolean} ",
                      "name": "flag",
                      "type": "Boolean"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "flag"
                    }
                  ]
                }
              ],
              "desc": "
Sets or clears the IP_MULTICAST_LOOP socket option.  When set to true,\nmulticast packets will also be received on the local interface.
\n"
            },
            {
              "textRaw": "socket.setMulticastTTL(ttl)",
              "type": "method",
              "name": "setMulticastTTL",
              "meta": {
                "added": [
                  "v0.3.8"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`ttl` {Number} Integer ",
                      "name": "ttl",
                      "type": "Number",
                      "desc": "Integer"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "ttl"
                    }
                  ]
                }
              ],
              "desc": "
Sets the IP_MULTICAST_TTL socket option.  While TTL generally stands for\n"Time to Live", in this context it specifies the number of IP hops that a\npacket is allowed to travel through, specifically for multicast traffic.  Each\nrouter or gateway that forwards a packet decrements the TTL. If the TTL is\ndecremented to 0 by a router, it will not be forwarded.
\n
The argument passed to to socket.setMulticastTTL() is a number of hops\nbetween 0 and 255. The default on most systems is 1 but can vary.
\n"
            },
            {
              "textRaw": "socket.setTTL(ttl)",
              "type": "method",
              "name": "setTTL",
              "meta": {
                "added": [
                  "v0.1.101"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`ttl` {Number} Integer ",
                      "name": "ttl",
                      "type": "Number",
                      "desc": "Integer"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "ttl"
                    }
                  ]
                }
              ],
              "desc": "
Sets the IP_TTL socket option. While TTL generally stands for "Time to Live",\nin this context it specifies the number of IP hops that a packet is allowed to\ntravel through.  Each router or gateway that forwards a packet decrements the\nTTL.  If the TTL is decremented to 0 by a router, it will not be forwarded.\nChanging TTL values is typically done for network probes or when multicasting.
\n
The argument to socket.setTTL() is a number of hops between 1 and 255.\nThe default on most systems is 64 but can vary.
\n"
            },
            {
              "textRaw": "socket.ref()",
              "type": "method",
              "name": "ref",
              "meta": {
                "added": [
                  "v0.9.1"
                ]
              },
              "desc": "
By default, binding a socket will cause it to block the Node.js process from\nexiting as long as the socket is open. The socket.unref() method can be used\nto exclude the socket from the reference counting that keeps the Node.js\nprocess active. The socket.ref() method adds the socket back to the reference\ncounting and restores the default behavior.
\n
Calling socket.ref() multiples times will have no additional effect.
\n
The socket.ref() method returns a reference to the socket so calls can be\nchained.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "socket.unref()",
              "type": "method",
              "name": "unref",
              "meta": {
                "added": [
                  "v0.9.1"
                ]
              },
              "desc": "
By default, binding a socket will cause it to block the Node.js process from\nexiting as long as the socket is open. The socket.unref() method can be used\nto exclude the socket from the reference counting that keeps the Node.js\nprocess active, allowing the process to exit even if the socket is still\nlistening.
\n
Calling socket.unref() multiple times will have no addition effect.
\n
The socket.unref() method returns a reference to the socket so calls can be\nchained.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            }
          ],
          "modules": [
            {
              "textRaw": "Change to asynchronous `socket.bind()` behavior",
              "name": "change_to_asynchronous_`socket.bind()`_behavior",
              "desc": "
As of Node.js v0.10, dgram.Socket#bind() changed to an asynchronous\nexecution model. Legacy code that assumes synchronous behavior, as in the\nfollowing example:
\n
const s = dgram.createSocket('udp4');\ns.bind(1234);\ns.addMembership('224.0.0.114');\n
\n
Must be changed to pass a callback function to the dgram.Socket#bind()\nfunction:
\n
const s = dgram.createSocket('udp4');\ns.bind(1234, () => {\n  s.addMembership('224.0.0.114');\n});\n
\n",
              "type": "module",
              "displayName": "Change to asynchronous `socket.bind()` behavior"
            }
          ]
        }
      ],
      "modules": [
        {
          "textRaw": "`dgram` module functions",
          "name": "`dgram`_module_functions",
          "methods": [
            {
              "textRaw": "dgram.createSocket(options[, callback])",
              "type": "method",
              "name": "createSocket",
              "meta": {
                "added": [
                  "v0.11.13"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {dgram.Socket} ",
                    "name": "return",
                    "type": "dgram.Socket"
                  },
                  "params": [
                    {
                      "textRaw": "`options` {Object} ",
                      "name": "options",
                      "type": "Object"
                    },
                    {
                      "textRaw": "`callback` {Function} Attached as a listener to `'message'` events. ",
                      "name": "callback",
                      "type": "Function",
                      "desc": "Attached as a listener to `'message'` events.",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "options"
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Creates a dgram.Socket object. The options argument is an object that\nshould contain a type field of either udp4 or udp6 and an optional\nboolean reuseAddr field.
\n
When reuseAddr is true socket.bind() will reuse the address, even if\nanother process has already bound a socket on it. reuseAddr defaults to\nfalse. The optional callback function is added as a listener for 'message'\nevents.
\n
Once the socket is created, calling socket.bind() will instruct the\nsocket to begin listening for datagram messages. When address and port are\nnot passed to  socket.bind() the method will bind the socket to the "all\ninterfaces" address on a random port (it does the right thing for both udp4\nand udp6 sockets). The bound address and port can be retrieved using\nsocket.address().address and socket.address().port.
\n"
            },
            {
              "textRaw": "dgram.createSocket(type[, callback])",
              "type": "method",
              "name": "createSocket",
              "meta": {
                "added": [
                  "v0.1.99"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {dgram.Socket} ",
                    "name": "return",
                    "type": "dgram.Socket"
                  },
                  "params": [
                    {
                      "textRaw": "`type` {String} - Either 'udp4' or 'udp6' ",
                      "name": "type",
                      "type": "String",
                      "desc": "Either 'udp4' or 'udp6'"
                    },
                    {
                      "textRaw": "`callback` {Function} - Attached as a listener to `'message'` events. Optional ",
                      "name": "callback",
                      "type": "Function",
                      "optional": true,
                      "desc": "Attached as a listener to `'message'` events."
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "type"
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Creates a dgram.Socket object of the specified type. The type argument\ncan be either udp4 or udp6. An optional callback function can be passed\nwhich is added as a listener for 'message' events.
\n
Once the socket is created, calling socket.bind() will instruct the\nsocket to begin listening for datagram messages. When address and port are\nnot passed to  socket.bind() the method will bind the socket to the "all\ninterfaces" address on a random port (it does the right thing for both udp4\nand udp6 sockets). The bound address and port can be retrieved using\nsocket.address().address and socket.address().port.
\n\n\n"
            }
          ],
          "type": "module",
          "displayName": "`dgram` module functions"
        }
      ],
      "type": "module",
      "displayName": "dgram"
    },
    {
      "textRaw": "DNS",
      "name": "dns",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
The dns module contains functions belonging to two different categories:
\n
1) Functions that use the underlying operating system facilities to perform\nname resolution, and that do not necessarily perform any network communication.\nThis category contains only one function: dns.lookup(). Developers\nlooking to perform name resolution in the same way that other applications on\nthe same operating system behave should use dns.lookup().
\n
For example, looking up iana.org.
\n
const dns = require('dns');\n\ndns.lookup('nodejs.org', (err, addresses, family) => {\n  console.log('addresses:', addresses);\n});\n// address: "192.0.43.8" family: IPv4\n
\n
2) Functions that connect to an actual DNS server to perform name resolution,\nand that always use the network to perform DNS queries. This category\ncontains all functions in the dns module except dns.lookup(). These\nfunctions do not use the same set of configuration files used by\ndns.lookup() (e.g. /etc/hosts). These functions should be used by\ndevelopers who do not want to use the underlying operating system's facilities\nfor name resolution, and instead want to always perform DNS queries.
\n
Below is an example that resolves 'archive.org' then reverse resolves the IP\naddresses that are returned.
\n
const dns = require('dns');\n\ndns.resolve4('archive.org', (err, addresses) => {\n  if (err) throw err;\n\n  console.log(`addresses: ${JSON.stringify(addresses)}`);\n\n  addresses.forEach((a) => {\n    dns.reverse(a, (err, hostnames) => {\n      if (err) {\n        throw err;\n      }\n      console.log(`reverse for ${a}: ${JSON.stringify(hostnames)}`);\n    });\n  });\n});\n
\n
There are subtle consequences in choosing one over the other, please consult\nthe Implementation considerations section for more information.
\n",
      "methods": [
        {
          "textRaw": "dns.getServers()",
          "type": "method",
          "name": "getServers",
          "meta": {
            "added": [
              "v0.11.3"
            ]
          },
          "desc": "
Returns an array of IP address strings that are being used for name\nresolution.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "dns.lookup(hostname[, options], callback)",
          "type": "method",
          "name": "lookup",
          "meta": {
            "added": [
              "v0.1.90"
            ]
          },
          "desc": "
Resolves a hostname (e.g. 'nodejs.org') into the first found A (IPv4) or\nAAAA (IPv6) record. options can be an object or integer. If options is\nnot provided, then IPv4 and IPv6 addresses are both valid. If options is\nan integer, then it must be 4 or 6.
\n
Alternatively, options can be an object containing these properties:
\n
    \n
  • family {Number} - The record family. If present, must be the integer\n4 or 6. If not provided, both IP v4 and v6 addresses are accepted.
    • \n
  • hints: {Number} - If present, it should be one or more of the supported\ngetaddrinfo flags. If hints is not provided, then no flags are passed to\ngetaddrinfo. Multiple flags can be passed through hints by bitwise\nORing their values.\nSee supported getaddrinfo flags for more information on supported\nflags.
    • \n
  • all: {Boolean} - When true, the callback returns all resolved addresses\nin an array, otherwise returns a single address. Defaults to false.
    • \n
\n
All properties are optional. An example usage of options is shown below.
\n
{\n  family: 4,\n  hints: dns.ADDRCONFIG | dns.V4MAPPED,\n  all: false\n}\n
The callback function has arguments (err, address, family). address is a\nstring representation of an IPv4 or IPv6 address. family is either the\ninteger 4 or 6 and denotes the family of address (not necessarily the\nvalue initially passed to lookup).
\n
With the all option set to true, the arguments change to\n(err, addresses), with addresses being an array of objects with the\nproperties address and family.
\n
On error, err is an Error object, where err.code is the error code.\nKeep in mind that err.code will be set to 'ENOENT' not only when\nthe hostname does not exist but also when the lookup fails in other ways\nsuch as no available file descriptors.
\n
dns.lookup() does not necessarily have anything to do with the DNS protocol.\nThe implementation uses an operating system facility that can associate names\nwith addresses, and vice versa. This implementation can have subtle but\nimportant consequences on the behavior of any Node.js program. Please take some\ntime to consult the Implementation considerations section before using\ndns.lookup().
\n
Example usage:
\n
const dns = require('dns');\nconst options = {\n  family: 6,\n  hints: dns.ADDRCONFIG | dns.V4MAPPED,\n};\ndns.lookup('example.com', options, (err, address, family) =>\n  console.log('address: %j family: IPv%s', address, family));\n// address: "2606:2800:220:1:248:1893:25c8:1946" family: IPv6\n\n// When options.all is true, the result will be an Array.\noptions.all = true;\ndns.lookup('example.com', options, (err, addresses) =>\n  console.log('addresses: %j', addresses));\n// addresses: [{"address":"2606:2800:220:1:248:1893:25c8:1946","family":6}]\n
\n",
          "modules": [
            {
              "textRaw": "Supported getaddrinfo flags",
              "name": "supported_getaddrinfo_flags",
              "desc": "
The following flags can be passed as hints to dns.lookup().
\n
    \n
  • dns.ADDRCONFIG: Returned address types are determined by the types\nof addresses supported by the current system. For example, IPv4 addresses\nare only returned if the current system has at least one IPv4 address\nconfigured. Loopback addresses are not considered.
    • \n
  • dns.V4MAPPED: If the IPv6 family was specified, but no IPv6 addresses were\nfound, then return IPv4 mapped IPv6 addresses. Note that it is not supported\non some operating systems (e.g FreeBSD 10.1).
    • \n
\n",
              "type": "module",
              "displayName": "Supported getaddrinfo flags"
            }
          ],
          "signatures": [
            {
              "params": [
                {
                  "name": "hostname"
                },
                {
                  "name": "options",
                  "optional": true
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "dns.lookupService(address, port, callback)",
          "type": "method",
          "name": "lookupService",
          "meta": {
            "added": [
              "v0.11.14"
            ]
          },
          "desc": "
Resolves the given address and port into a hostname and service using\nthe operating system's underlying getnameinfo implementation.
\n
The callback has arguments (err, hostname, service). The hostname and\nservice arguments are strings (e.g. 'localhost' and 'http' respectively).
\n
On error, err is an Error object, where err.code is the error code.
\n
const dns = require('dns');\ndns.lookupService('127.0.0.1', 22, (err, hostname, service) => {\n  console.log(hostname, service);\n    // Prints: localhost ssh\n});\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "address"
                },
                {
                  "name": "port"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "dns.resolve(hostname[, rrtype], callback)",
          "type": "method",
          "name": "resolve",
          "meta": {
            "added": [
              "v0.1.27"
            ]
          },
          "desc": "
Uses the DNS protocol to resolve a hostname (e.g. 'nodejs.org') into an\narray of the record types specified by rrtype.
\n
Valid values for rrtype are:
\n
    \n
  • 'A' - IPV4 addresses, default
    • \n
  • 'AAAA' - IPV6 addresses
    • \n
  • 'MX' - mail exchange records
    • \n
  • 'TXT' - text records
    • \n
  • 'SRV' - SRV records
    • \n
  • 'PTR' - used for reverse IP lookups
    • \n
  • 'NS' - name server records
    • \n
  • 'CNAME' - canonical name records
    • \n
  • 'SOA' - start of authority record
    • \n
  • 'NAPTR' - name authority pointer record
    • \n
\n
The callback function has arguments (err, addresses). When successful,\naddresses will be an array, except when resolving an SOA record which returns\nan object structured in the same manner as one returned by the\ndns.resolveSoa() method. The type of each item in addresses is\ndetermined by the record type, and described in the documentation for the\ncorresponding lookup methods.
\n
On error, err is an Error object, where err.code is\none of the error codes listed here.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "hostname"
                },
                {
                  "name": "rrtype",
                  "optional": true
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "dns.resolve4(hostname, callback)",
          "type": "method",
          "name": "resolve4",
          "meta": {
            "added": [
              "v0.1.16"
            ]
          },
          "desc": "
Uses the DNS protocol to resolve a IPv4 addresses (A records) for the\nhostname. The addresses argument passed to the callback function\nwill contain an array of IPv4 addresses (e.g.\n['74.125.79.104', '74.125.79.105', '74.125.79.106']).
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "hostname"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "dns.resolve6(hostname, callback)",
          "type": "method",
          "name": "resolve6",
          "meta": {
            "added": [
              "v0.1.16"
            ]
          },
          "desc": "
Uses the DNS protocol to resolve a IPv6 addresses (AAAA records) for the\nhostname. The addresses argument passed to the callback function\nwill contain an array of IPv6 addresses.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "hostname"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "dns.resolveCname(hostname, callback)",
          "type": "method",
          "name": "resolveCname",
          "meta": {
            "added": [
              "v0.3.2"
            ]
          },
          "desc": "
Uses the DNS protocol to resolve CNAME records for the hostname. The\naddresses argument passed to the callback function\nwill contain an array of canonical name records available for the hostname\n(e.g. ['bar.example.com']).
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "hostname"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "dns.resolveMx(hostname, callback)",
          "type": "method",
          "name": "resolveMx",
          "meta": {
            "added": [
              "v0.1.27"
            ]
          },
          "desc": "
Uses the DNS protocol to resolve mail exchange records (MX records) for the\nhostname. The addresses argument passed to the callback function will\ncontain an array of objects containing both a priority and exchange\nproperty (e.g. [{priority: 10, exchange: 'mx.example.com'}, ...]).
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "hostname"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "dns.resolveNaptr(hostname, callback)",
          "type": "method",
          "name": "resolveNaptr",
          "meta": {
            "added": [
              "v0.9.12"
            ]
          },
          "desc": "
Uses the DNS protocol to resolve regular expression based records (NAPTR\nrecords) for the hostname. The callback function has arguments\n(err, addresses).  The addresses argument passed to the callback function\nwill contain an array of objects with the following properties:
\n
    \n
  • flags
    • \n
  • service
    • \n
  • regexp
    • \n
  • replacement
    • \n
  • order
    • \n
  • preference
    • \n
\n
For example:
\n
{\n  flags: 's',\n  service: 'SIP+D2U',\n  regexp: '',\n  replacement: '_sip._udp.example.com',\n  order: 30,\n  preference: 100\n}\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "hostname"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "dns.resolveNs(hostname, callback)",
          "type": "method",
          "name": "resolveNs",
          "meta": {
            "added": [
              "v0.1.90"
            ]
          },
          "desc": "
Uses the DNS protocol to resolve name server records (NS records) for the\nhostname. The addresses argument passed to the callback function will\ncontain an array of name server records available for hostname\n(e.g. ['ns1.example.com', 'ns2.example.com']).
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "hostname"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "dns.resolveSoa(hostname, callback)",
          "type": "method",
          "name": "resolveSoa",
          "meta": {
            "added": [
              "v0.11.10"
            ]
          },
          "desc": "
Uses the DNS protocol to resolve a start of authority record (SOA record) for\nthe hostname. The addresses argument passed to the callback function will\nbe an object with the following properties:
\n
    \n
  • nsname
    • \n
  • hostmaster
    • \n
  • serial
    • \n
  • refresh
    • \n
  • retry
    • \n
  • expire
    • \n
  • minttl
    • \n
\n
{\n  nsname: 'ns.example.com',\n  hostmaster: 'root.example.com',\n  serial: 2013101809,\n  refresh: 10000,\n  retry: 2400,\n  expire: 604800,\n  minttl: 3600\n}\n
",
          "signatures": [
            {
              "params": [
                {
                  "name": "hostname"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "dns.resolveSrv(hostname, callback)",
          "type": "method",
          "name": "resolveSrv",
          "meta": {
            "added": [
              "v0.1.27"
            ]
          },
          "desc": "
Uses the DNS protocol to resolve service records (SRV records) for the\nhostname. The addresses argument passed to the callback function will\nbe an array of objects with the following properties:
\n
    \n
  • priority
    • \n
  • weight
    • \n
  • port
    • \n
  • name
    • \n
\n
{\n  priority: 10,\n  weight: 5,\n  port: 21223,\n  name: 'service.example.com'\n}\n
",
          "signatures": [
            {
              "params": [
                {
                  "name": "hostname"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "dns.resolveTxt(hostname, callback)",
          "type": "method",
          "name": "resolveTxt",
          "meta": {
            "added": [
              "v0.1.27"
            ]
          },
          "desc": "
Uses the DNS protocol to resolve text queries (TXT records) for the\nhostname. The addresses argument passed to the callback function is\nis a two-dimentional array of the text records available for hostname (e.g.,\n[ ['v=spf1 ip4:0.0.0.0 ', '~all' ] ]). Each sub-array contains TXT chunks of\none record. Depending on the use case, these could be either joined together or\ntreated separately.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "hostname"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "dns.reverse(ip, callback)",
          "type": "method",
          "name": "reverse",
          "meta": {
            "added": [
              "v0.1.16"
            ]
          },
          "desc": "
Performs a reverse DNS query that resolves an IPv4 or IPv6 address to an\narray of hostnames.
\n
The callback function has arguments (err, hostnames), where hostnames\nis an array of resolved hostnames for the given ip.
\n
On error, err is an Error object, where err.code is\none of the DNS error codes.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "ip"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "dns.setServers(servers)",
          "type": "method",
          "name": "setServers",
          "meta": {
            "added": [
              "v0.11.3"
            ]
          },
          "desc": "
Sets the IP addresses of the servers to be used when resolving. The servers\nargument is an array of IPv4 or IPv6 addresses.
\n
If a port specified on the address it will be removed.
\n
An error will be thrown if an invalid address is provided.
\n
The dns.setServers() method must not be called while a DNS query is in\nprogress.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "servers"
                }
              ]
            }
          ]
        }
      ],
      "modules": [
        {
          "textRaw": "Error codes",
          "name": "error_codes",
          "desc": "
Each DNS query can return one of the following error codes:
\n
    \n
  • dns.NODATA: DNS server returned answer with no data.
    • \n
  • dns.FORMERR: DNS server claims query was misformatted.
    • \n
  • dns.SERVFAIL: DNS server returned general failure.
    • \n
  • dns.NOTFOUND: Domain name not found.
    • \n
  • dns.NOTIMP: DNS server does not implement requested operation.
    • \n
  • dns.REFUSED: DNS server refused query.
    • \n
  • dns.BADQUERY: Misformatted DNS query.
    • \n
  • dns.BADNAME: Misformatted hostname.
    • \n
  • dns.BADFAMILY: Unsupported address family.
    • \n
  • dns.BADRESP: Misformatted DNS reply.
    • \n
  • dns.CONNREFUSED: Could not contact DNS servers.
    • \n
  • dns.TIMEOUT: Timeout while contacting DNS servers.
    • \n
  • dns.EOF: End of file.
    • \n
  • dns.FILE: Error reading file.
    • \n
  • dns.NOMEM: Out of memory.
    • \n
  • dns.DESTRUCTION: Channel is being destroyed.
    • \n
  • dns.BADSTR: Misformatted string.
    • \n
  • dns.BADFLAGS: Illegal flags specified.
    • \n
  • dns.NONAME: Given hostname is not numeric.
    • \n
  • dns.BADHINTS: Illegal hints flags specified.
    • \n
  • dns.NOTINITIALIZED: c-ares library initialization not yet performed.
    • \n
  • dns.LOADIPHLPAPI: Error loading iphlpapi.dll.
    • \n
  • dns.ADDRGETNETWORKPARAMS: Could not find GetNetworkParams function.
    • \n
  • dns.CANCELLED: DNS query cancelled.
    • \n
\n",
          "type": "module",
          "displayName": "Error codes"
        },
        {
          "textRaw": "Implementation considerations",
          "name": "implementation_considerations",
          "desc": "
Although dns.lookup() and the various dns.resolve*()/dns.reverse()\nfunctions have the same goal of associating a network name with a network\naddress (or vice versa), their behavior is quite different. These differences\ncan have subtle but significant consequences on the behavior of Node.js\nprograms.
\n",
          "modules": [
            {
              "textRaw": "`dns.lookup()`",
              "name": "`dns.lookup()`",
              "desc": "
Under the hood, dns.lookup() uses the same operating system facilities\nas most other programs. For instance, dns.lookup() will almost always\nresolve a given name the same way as the ping command. On most POSIX-like\noperating systems, the behavior of the dns.lookup() function can be\nmodified by changing settings in nsswitch.conf(5) and/or resolv.conf(5),\nbut note that changing these files will change the behavior of all other\nprograms running on the same operating system.
\n
Though the call to dns.lookup() will be asynchronous from JavaScript's\nperspective, it is implemented as a synchronous call to getaddrinfo(3) that\nruns on libuv's threadpool. Because libuv's threadpool has a fixed size, it\nmeans that if for whatever reason the call to getaddrinfo(3) takes a long\ntime, other operations that could run on libuv's threadpool (such as filesystem\noperations) will experience degraded performance. In order to mitigate this\nissue, one potential solution is to increase the size of libuv's threadpool by\nsetting the 'UV_THREADPOOL_SIZE' environment variable to a value greater than\n4 (its current default value). For more information on libuv's threadpool, see\nthe official libuv documentation.
\n",
              "type": "module",
              "displayName": "`dns.lookup()`"
            },
            {
              "textRaw": "`dns.resolve()`, `dns.resolve*()` and `dns.reverse()`",
              "name": "`dns.resolve()`,_`dns.resolve*()`_and_`dns.reverse()`",
              "desc": "
These functions are implemented quite differently than dns.lookup(). They\ndo not use getaddrinfo(3) and they always perform a DNS query on the\nnetwork. This network communication is always done asynchronously, and does not\nuse libuv's threadpool.
\n
As a result, these functions cannot have the same negative impact on other\nprocessing that happens on libuv's threadpool that dns.lookup() can have.
\n
They do not use the same set of configuration files than what dns.lookup()\nuses. For instance, they do not use the configuration from /etc/hosts.
\n\n\n",
              "type": "module",
              "displayName": "`dns.resolve()`, `dns.resolve*()` and `dns.reverse()`"
            }
          ],
          "type": "module",
          "displayName": "Implementation considerations"
        }
      ],
      "type": "module",
      "displayName": "DNS"
    },
    {
      "textRaw": "Domain",
      "name": "domain",
      "stability": 0,
      "stabilityText": "Deprecated",
      "desc": "
This module is pending deprecation. Once a replacement API has been\nfinalized, this module will be fully deprecated. Most end users should\nnot have cause to use this module. Users who absolutely must have\nthe functionality that domains provide may rely on it for the time being\nbut should expect to have to migrate to a different solution\nin the future.
\n
Domains provide a way to handle multiple different IO operations as a\nsingle group.  If any of the event emitters or callbacks registered to a\ndomain emit an 'error' event, or throw an error, then the domain object\nwill be notified, rather than losing the context of the error in the\nprocess.on('uncaughtException') handler, or causing the program to\nexit immediately with an error code.
\n",
      "miscs": [
        {
          "textRaw": "Warning: Don't Ignore Errors!",
          "name": "Warning: Don't Ignore Errors!",
          "type": "misc",
          "desc": "
Domain error handlers are not a substitute for closing down your\nprocess when an error occurs.
\n
By the very nature of how throw works in JavaScript, there is almost\nnever any way to safely "pick up where you left off", without leaking\nreferences, or creating some other sort of undefined brittle state.
\n
The safest way to respond to a thrown error is to shut down the\nprocess.  Of course, in a normal web server, you might have many\nconnections open, and it is not reasonable to abruptly shut those down\nbecause an error was triggered by someone else.
\n
The better approach is to send an error response to the request that\ntriggered the error, while letting the others finish in their normal\ntime, and stop listening for new requests in that worker.
\n
In this way, domain usage goes hand-in-hand with the cluster module,\nsince the master process can fork a new worker when a worker\nencounters an error.  For Node.js programs that scale to multiple\nmachines, the terminating proxy or service registry can take note of\nthe failure, and react accordingly.
\n
For example, this is not a good idea:
\n
// XXX WARNING!  BAD IDEA!\n\nconst d = require('domain').create();\nd.on('error', (er) => {\n  // The error won't crash the process, but what it does is worse!\n  // Though we've prevented abrupt process restarting, we are leaking\n  // resources like crazy if this ever happens.\n  // This is no better than process.on('uncaughtException')!\n  console.log(`error, but oh well ${er.message}`);\n});\nd.run(() => {\n  require('http').createServer((req, res) => {\n    handleRequest(req, res);\n  }).listen(PORT);\n});\n
\n
By using the context of a domain, and the resilience of separating our\nprogram into multiple worker processes, we can react more\nappropriately, and handle errors with much greater safety.
\n
// Much better!\n\nconst cluster = require('cluster');\nconst PORT = +process.env.PORT || 1337;\n\nif (cluster.isMaster) {\n  // In real life, you'd probably use more than just 2 workers,\n  // and perhaps not put the master and worker in the same file.\n  //\n  // You can also of course get a bit fancier about logging, and\n  // implement whatever custom logic you need to prevent DoS\n  // attacks and other bad behavior.\n  //\n  // See the options in the cluster documentation.\n  //\n  // The important thing is that the master does very little,\n  // increasing our resilience to unexpected errors.\n\n  cluster.fork();\n  cluster.fork();\n\n  cluster.on('disconnect', (worker) => {\n    console.error('disconnect!');\n    cluster.fork();\n  });\n\n} else {\n  // the worker\n  //\n  // This is where we put our bugs!\n\n  const domain = require('domain');\n\n  // See the cluster documentation for more details about using\n  // worker processes to serve requests.  How it works, caveats, etc.\n\n  const server = require('http').createServer((req, res) => {\n    const d = domain.create();\n    d.on('error', (er) => {\n      console.error(`error ${er.stack}`);\n\n      // Note: we're in dangerous territory!\n      // By definition, something unexpected occurred,\n      // which we probably didn't want.\n      // Anything can happen now!  Be very careful!\n\n      try {\n        // make sure we close down within 30 seconds\n        const killtimer = setTimeout(() => {\n          process.exit(1);\n        }, 30000);\n        // But don't keep the process open just for that!\n        killtimer.unref();\n\n        // stop taking new requests.\n        server.close();\n\n        // Let the master know we're dead.  This will trigger a\n        // 'disconnect' in the cluster master, and then it will fork\n        // a new worker.\n        cluster.worker.disconnect();\n\n        // try to send an error to the request that triggered the problem\n        res.statusCode = 500;\n        res.setHeader('content-type', 'text/plain');\n        res.end('Oops, there was a problem!\\n');\n      } catch (er2) {\n        // oh well, not much we can do at this point.\n        console.error(`Error sending 500! ${er2.stack}`);\n      }\n    });\n\n    // Because req and res were created before this domain existed,\n    // we need to explicitly add them.\n    // See the explanation of implicit vs explicit binding below.\n    d.add(req);\n    d.add(res);\n\n    // Now run the handler function in the domain.\n    d.run(() => {\n      handleRequest(req, res);\n    });\n  });\n  server.listen(PORT);\n}\n\n// This part isn't important.  Just an example routing thing.\n// You'd put your fancy application logic here.\nfunction handleRequest(req, res) {\n  switch (req.url) {\n    case '/error':\n      // We do some async stuff, and then...\n      setTimeout(() => {\n        // Whoops!\n        flerb.bark();\n      });\n      break;\n    default:\n      res.end('ok');\n  }\n}\n
\n"
        },
        {
          "textRaw": "Additions to Error objects",
          "name": "Additions to Error objects",
          "type": "misc",
          "desc": "
Any time an Error object is routed through a domain, a few extra fields\nare added to it.
\n
    \n
  • error.domain The domain that first handled the error.
    • \n
  • error.domainEmitter The event emitter that emitted an 'error' event\nwith the error object.
    • \n
  • error.domainBound The callback function which was bound to the\ndomain, and passed an error as its first argument.
    • \n
  • error.domainThrown A boolean indicating whether the error was\nthrown, emitted, or passed to a bound callback function.
    • \n
\n"
        },
        {
          "textRaw": "Implicit Binding",
          "name": "Implicit Binding",
          "type": "misc",
          "desc": "
If domains are in use, then all new EventEmitter objects (including\nStream objects, requests, responses, etc.) will be implicitly bound to\nthe active domain at the time of their creation.
\n
Additionally, callbacks passed to lowlevel event loop requests (such as\nto fs.open, or other callback-taking methods) will automatically be\nbound to the active domain.  If they throw, then the domain will catch\nthe error.
\n
In order to prevent excessive memory usage, Domain objects themselves\nare not implicitly added as children of the active domain.  If they\nwere, then it would be too easy to prevent request and response objects\nfrom being properly garbage collected.
\n
If you want to nest Domain objects as children of a parent Domain,\nthen you must explicitly add them.
\n
Implicit binding routes thrown errors and 'error' events to the\nDomain's 'error' event, but does not register the EventEmitter on the\nDomain, so domain.dispose() will not shut down the EventEmitter.\nImplicit binding only takes care of thrown errors and 'error' events.
\n"
        },
        {
          "textRaw": "Explicit Binding",
          "name": "Explicit Binding",
          "type": "misc",
          "desc": "
Sometimes, the domain in use is not the one that ought to be used for a\nspecific event emitter.  Or, the event emitter could have been created\nin the context of one domain, but ought to instead be bound to some\nother domain.
\n
For example, there could be one domain in use for an HTTP server, but\nperhaps we would like to have a separate domain to use for each request.
\n
That is possible via explicit binding.
\n
For example:
\n
// create a top-level domain for the server\nconst domain = require('domain');\nconst http = require('http');\nconst serverDomain = domain.create();\n\nserverDomain.run(() => {\n  // server is created in the scope of serverDomain\n  http.createServer((req, res) => {\n    // req and res are also created in the scope of serverDomain\n    // however, we'd prefer to have a separate domain for each request.\n    // create it first thing, and add req and res to it.\n    const reqd = domain.create();\n    reqd.add(req);\n    reqd.add(res);\n    reqd.on('error', (er) => {\n      console.error('Error', er, req.url);\n      try {\n        res.writeHead(500);\n        res.end('Error occurred, sorry.');\n      } catch (er2) {\n        console.error('Error sending 500', er2, req.url);\n      }\n    });\n  }).listen(1337);\n});\n
\n"
        }
      ],
      "methods": [
        {
          "textRaw": "domain.create()",
          "type": "method",
          "name": "create",
          "signatures": [
            {
              "return": {
                "textRaw": "Returns: {Domain} ",
                "name": "return",
                "type": "Domain"
              },
              "params": []
            },
            {
              "params": []
            }
          ],
          "desc": "
Returns a new Domain object.
\n"
        }
      ],
      "classes": [
        {
          "textRaw": "Class: Domain",
          "type": "class",
          "name": "Domain",
          "desc": "
The Domain class encapsulates the functionality of routing errors and\nuncaught exceptions to the active Domain object.
\n
Domain is a child class of EventEmitter.  To handle the errors that it\ncatches, listen to its 'error' event.
\n",
          "methods": [
            {
              "textRaw": "domain.run(fn[, arg][, ...])",
              "type": "method",
              "name": "run",
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`fn` {Function} ",
                      "name": "fn",
                      "type": "Function"
                    },
                    {
                      "name": "arg",
                      "optional": true
                    },
                    {
                      "name": "...",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "fn"
                    },
                    {
                      "name": "arg",
                      "optional": true
                    },
                    {
                      "name": "...",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Run the supplied function in the context of the domain, implicitly\nbinding all event emitters, timers, and lowlevel requests that are\ncreated in that context. Optionally, arguments can be passed to\nthe function.
\n
This is the most basic way to use a domain.
\n
Example:
\n
const domain = require('domain');\nconst fs = require('fs');\nconst d = domain.create();\nd.on('error', (er) => {\n  console.error('Caught error!', er);\n});\nd.run(() => {\n  process.nextTick(() => {\n    setTimeout(() => { // simulating some various async stuff\n      fs.open('non-existent file', 'r', (er, fd) => {\n        if (er) throw er;\n        // proceed...\n      });\n    }, 100);\n  });\n});\n
\n
In this example, the d.on('error') handler will be triggered, rather\nthan crashing the program.
\n"
            },
            {
              "textRaw": "domain.add(emitter)",
              "type": "method",
              "name": "add",
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`emitter` {EventEmitter|Timer} emitter or timer to be added to the domain ",
                      "name": "emitter",
                      "type": "EventEmitter|Timer",
                      "desc": "emitter or timer to be added to the domain"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "emitter"
                    }
                  ]
                }
              ],
              "desc": "
Explicitly adds an emitter to the domain.  If any event handlers called by\nthe emitter throw an error, or if the emitter emits an 'error' event, it\nwill be routed to the domain's 'error' event, just like with implicit\nbinding.
\n
This also works with timers that are returned from setInterval() and\nsetTimeout().  If their callback function throws, it will be caught by\nthe domain 'error' handler.
\n
If the Timer or EventEmitter was already bound to a domain, it is removed\nfrom that one, and bound to this one instead.
\n"
            },
            {
              "textRaw": "domain.remove(emitter)",
              "type": "method",
              "name": "remove",
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`emitter` {EventEmitter|Timer} emitter or timer to be removed from the domain ",
                      "name": "emitter",
                      "type": "EventEmitter|Timer",
                      "desc": "emitter or timer to be removed from the domain"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "emitter"
                    }
                  ]
                }
              ],
              "desc": "
The opposite of domain.add(emitter).  Removes domain handling from the\nspecified emitter.
\n"
            },
            {
              "textRaw": "domain.bind(callback)",
              "type": "method",
              "name": "bind",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Function} The bound function ",
                    "name": "return",
                    "type": "Function",
                    "desc": "The bound function"
                  },
                  "params": [
                    {
                      "textRaw": "`callback` {Function} The callback function ",
                      "name": "callback",
                      "type": "Function",
                      "desc": "The callback function"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "callback"
                    }
                  ]
                }
              ],
              "desc": "
The returned function will be a wrapper around the supplied callback\nfunction.  When the returned function is called, any errors that are\nthrown will be routed to the domain's 'error' event.
\n
Example
\n
const d = domain.create();\n\nfunction readSomeFile(filename, cb) {\n  fs.readFile(filename, 'utf8', d.bind((er, data) => {\n    // if this throws, it will also be passed to the domain\n    return cb(er, data ? JSON.parse(data) : null);\n  }));\n}\n\nd.on('error', (er) => {\n  // an error occurred somewhere.\n  // if we throw it now, it will crash the program\n  // with the normal line number and stack message.\n});\n
\n"
            },
            {
              "textRaw": "domain.intercept(callback)",
              "type": "method",
              "name": "intercept",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Function} The intercepted function ",
                    "name": "return",
                    "type": "Function",
                    "desc": "The intercepted function"
                  },
                  "params": [
                    {
                      "textRaw": "`callback` {Function} The callback function ",
                      "name": "callback",
                      "type": "Function",
                      "desc": "The callback function"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "callback"
                    }
                  ]
                }
              ],
              "desc": "
This method is almost identical to domain.bind(callback).  However, in\naddition to catching thrown errors, it will also intercept Error\nobjects sent as the first argument to the function.
\n
In this way, the common if (err) return callback(err); pattern can be replaced\nwith a single error handler in a single place.
\n
Example
\n
const d = domain.create();\n\nfunction readSomeFile(filename, cb) {\n  fs.readFile(filename, 'utf8', d.intercept((data) => {\n    // note, the first argument is never passed to the\n    // callback since it is assumed to be the 'Error' argument\n    // and thus intercepted by the domain.\n\n    // if this throws, it will also be passed to the domain\n    // so the error-handling logic can be moved to the 'error'\n    // event on the domain instead of being repeated throughout\n    // the program.\n    return cb(null, JSON.parse(data));\n  }));\n}\n\nd.on('error', (er) => {\n  // an error occurred somewhere.\n  // if we throw it now, it will crash the program\n  // with the normal line number and stack message.\n});\n
\n"
            },
            {
              "textRaw": "domain.enter()",
              "type": "method",
              "name": "enter",
              "desc": "
The enter method is plumbing used by the run, bind, and intercept\nmethods to set the active domain. It sets domain.active and process.domain\nto the domain, and implicitly pushes the domain onto the domain stack managed\nby the domain module (see domain.exit() for details on the domain stack). The\ncall to enter delimits the beginning of a chain of asynchronous calls and I/O\noperations bound to a domain.
\n
Calling enter changes only the active domain, and does not alter the domain\nitself. enter and exit can be called an arbitrary number of times on a\nsingle domain.
\n
If the domain on which enter is called has been disposed, enter will return\nwithout setting the domain.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "domain.exit()",
              "type": "method",
              "name": "exit",
              "desc": "
The exit method exits the current domain, popping it off the domain stack.\nAny time execution is going to switch to the context of a different chain of\nasynchronous calls, it's important to ensure that the current domain is exited.\nThe call to exit delimits either the end of or an interruption to the chain\nof asynchronous calls and I/O operations bound to a domain.
\n
If there are multiple, nested domains bound to the current execution context,\nexit will exit any domains nested within this domain.
\n
Calling exit changes only the active domain, and does not alter the domain\nitself. enter and exit can be called an arbitrary number of times on a\nsingle domain.
\n
If the domain on which exit is called has been disposed, exit will return\nwithout exiting the domain.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "domain.dispose()",
              "type": "method",
              "name": "dispose",
              "desc": "
Stability: 0 - Deprecated.  Please recover from failed IO actions\nexplicitly via error event handlers set on the domain.
\n
Once dispose has been called, the domain will no longer be used by callbacks\nbound into the domain via run, bind, or intercept, and a 'dispose' event\nis emitted.
\n\n\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            }
          ],
          "properties": [
            {
              "textRaw": "`members` {Array} ",
              "type": "Array",
              "name": "members",
              "desc": "
An array of timers and event emitters that have been explicitly added\nto the domain.
\n"
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "Domain"
    },
    {
      "textRaw": "Events",
      "name": "Events",
      "stability": 2,
      "stabilityText": "Stable",
      "type": "module",
      "desc": "
Much of the Node.js core API is built around an idiomatic asynchronous\nevent-driven architecture in which certain kinds of objects (called "emitters")\nperiodically emit named events that cause Function objects ("listeners") to be\ncalled.
\n
For instance: a net.Server object emits an event each time a peer\nconnects to it; a fs.ReadStream emits an event when the file is opened;\na stream emits an event whenever data is available to be read.
\n
All objects that emit events are instances of the EventEmitter class. These\nobjects expose an eventEmitter.on() function that allows one or more\nFunctions to be attached to named events emitted by the object. Typically,\nevent names are camel-cased strings but any valid JavaScript property key\ncan be used.
\n
When the EventEmitter object emits an event, all of the Functions attached\nto that specific event are called synchronously. Any values returned by the\ncalled listeners are ignored and will be discarded.
\n
The following example shows a simple EventEmitter instance with a single\nlistener. The eventEmitter.on() method is used to register listeners, while\nthe eventEmitter.emit() method is used to trigger the event.
\n
const EventEmitter = require('events');\nconst util = require('util');\n\nfunction MyEmitter() {\n  EventEmitter.call(this);\n}\nutil.inherits(MyEmitter, EventEmitter);\n\nconst myEmitter = new MyEmitter();\nmyEmitter.on('event', () => {\n  console.log('an event occurred!');\n});\nmyEmitter.emit('event');\n
\n
Any object can become an EventEmitter through inheritance. The example above\nuses the traditional Node.js style prototypical inheritance using\nthe util.inherits() method. It is, however, possible to use ES6 classes as\nwell:
\n
const EventEmitter = require('events');\n\nclass MyEmitter extends EventEmitter {}\n\nconst myEmitter = new MyEmitter();\nmyEmitter.on('event', () => {\n  console.log('an event occurred!');\n});\nmyEmitter.emit('event');\n
\n",
      "modules": [
        {
          "textRaw": "Passing arguments and `this` to listeners",
          "name": "passing_arguments_and_`this`_to_listeners",
          "desc": "
The eventEmitter.emit() method allows an arbitrary set of arguments to be\npassed to the listener functions. It is important to keep in mind that when an\nordinary listener function is called by the EventEmitter, the standard this\nkeyword is intentionally set to reference the EventEmitter to which the\nlistener is attached.
\n
const myEmitter = new MyEmitter();\nmyEmitter.on('event', function(a, b) {\n  console.log(a, b, this);\n    // Prints:\n    //   a b MyEmitter {\n    //     domain: null,\n    //     _events: { event: [Function] },\n    //     _eventsCount: 1,\n    //     _maxListeners: undefined }\n});\nmyEmitter.emit('event', 'a', 'b');\n
\n
It is possible to use ES6 Arrow Functions as listeners, however, when doing so,\nthe this keyword will no longer reference the EventEmitter instance:
\n
const myEmitter = new MyEmitter();\nmyEmitter.on('event', (a, b) => {\n  console.log(a, b, this);\n    // Prints: a b {}\n});\nmyEmitter.emit('event', 'a', 'b');\n
\n",
          "type": "module",
          "displayName": "Passing arguments and `this` to listeners"
        },
        {
          "textRaw": "Asynchronous vs. Synchronous",
          "name": "asynchronous_vs._synchronous",
          "desc": "
The EventListener calls all listeners synchronously in the order in which\nthey were registered. This is important to ensure the proper sequencing of\nevents and to avoid race conditions or logic errors. When appropriate,\nlistener functions can switch to an asynchronous mode of operation using\nthe setImmediate() or process.nextTick() methods:
\n
const myEmitter = new MyEmitter();\nmyEmitter.on('event', (a, b) => {\n  setImmediate(() => {\n    console.log('this happens asynchronously');\n  });\n});\nmyEmitter.emit('event', 'a', 'b');\n
\n",
          "type": "module",
          "displayName": "Asynchronous vs. Synchronous"
        },
        {
          "textRaw": "Handling events only once",
          "name": "handling_events_only_once",
          "desc": "
When a listener is registered using the eventEmitter.on() method, that\nlistener will be invoked every time the named event is emitted.
\n
const myEmitter = new MyEmitter();\nvar m = 0;\nmyEmitter.on('event', () => {\n  console.log(++m);\n});\nmyEmitter.emit('event');\n  // Prints: 1\nmyEmitter.emit('event');\n  // Prints: 2\n
\n
Using the eventEmitter.once() method, it is possible to register a listener\nthat is unregistered before it is called.
\n
const myEmitter = new MyEmitter();\nvar m = 0;\nmyEmitter.once('event', () => {\n  console.log(++m);\n});\nmyEmitter.emit('event');\n  // Prints: 1\nmyEmitter.emit('event');\n  // Ignored\n
\n",
          "type": "module",
          "displayName": "Handling events only once"
        },
        {
          "textRaw": "Error events",
          "name": "error_events",
          "desc": "
When an error occurs within an EventEmitter instance, the typical action is\nfor an 'error' event to be emitted. These are treated as a special case\nwithin Node.js.
\n
If an EventEmitter does not have at least one listener registered for the\n'error' event, and an 'error' event is emitted, the error is thrown, a\nstack trace is printed, and the Node.js process exits.
\n
const myEmitter = new MyEmitter();\nmyEmitter.emit('error', new Error('whoops!'));\n  // Throws and crashes Node.js\n
\n
To guard against crashing the Node.js process, developers can either register\na listener for the process.on('uncaughtException') event or use the\ndomain module (Note, however, that the domain module has been\ndeprecated).
\n
const myEmitter = new MyEmitter();\n\nprocess.on('uncaughtException', (err) => {\n  console.log('whoops! there was an error');\n});\n\nmyEmitter.emit('error', new Error('whoops!'));\n  // Prints: whoops! there was an error\n
\n
As a best practice, developers should always register listeners for the\n'error' event:
\n
const myEmitter = new MyEmitter();\nmyEmitter.on('error', (err) => {\n  console.log('whoops! there was an error');\n});\nmyEmitter.emit('error', new Error('whoops!'));\n  // Prints: whoops! there was an error\n
\n",
          "type": "module",
          "displayName": "Error events"
        }
      ],
      "classes": [
        {
          "textRaw": "Class: EventEmitter",
          "type": "class",
          "name": "EventEmitter",
          "meta": {
            "added": [
              "v0.1.26"
            ]
          },
          "desc": "
The EventEmitter class is defined and exposed by the events module:
\n
const EventEmitter = require('events');\n
\n
All EventEmitters emit the event 'newListener' when new listeners are\nadded and 'removeListener' when a listener is removed.
\n",
          "events": [
            {
              "textRaw": "Event: 'newListener'",
              "type": "event",
              "name": "newListener",
              "meta": {
                "added": [
                  "v0.1.26"
                ]
              },
              "params": [],
              "desc": "
The EventEmitter instance will emit it's own 'newListener' event before\na listener is added to it's internal array of listeners.
\n
Listeners registered for the 'newListener' event will be passed the event\nname and a reference to the listener being added.
\n
The fact that the event is triggered before adding the listener has a subtle\nbut important side effect: any additional listeners registered to the same\nname within the 'newListener' callback will be inserted before the\nlistener that is in the process of being added.
\n
const myEmitter = new MyEmitter();\n// Only do this once so we don't loop forever\nmyEmitter.once('newListener', (event, listener) => {\n  if (event === 'event') {\n    // Insert a new listener in front\n    myEmitter.on('event', () => {\n      console.log('B');\n    });\n  }\n});\nmyEmitter.on('event', () => {\n  console.log('A');\n});\nmyEmitter.emit('event');\n  // Prints:\n  //   B\n  //   A\n
\n"
            },
            {
              "textRaw": "Event: 'removeListener'",
              "type": "event",
              "name": "removeListener",
              "meta": {
                "added": [
                  "v0.9.3"
                ]
              },
              "params": [],
              "desc": "
The 'removeListener' event is emitted after a listener is removed.
\n"
            }
          ],
          "methods": [
            {
              "textRaw": "EventEmitter.listenerCount(emitter, eventName)",
              "type": "method",
              "name": "listenerCount",
              "meta": {
                "added": [
                  "v0.9.12"
                ],
                "deprecated": [
                  "v4.0.0"
                ]
              },
              "stability": 0,
              "stabilityText": "Deprecated: Use [`emitter.listenerCount()`][] instead.",
              "desc": "
A class method that returns the number of listeners for the given eventName\nregistered on the given emitter.
\n
const myEmitter = new MyEmitter();\nmyEmitter.on('event', () => {});\nmyEmitter.on('event', () => {});\nconsole.log(EventEmitter.listenerCount(myEmitter, 'event'));\n  // Prints: 2\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "emitter"
                    },
                    {
                      "name": "eventName"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "emitter.addListener(eventName, listener)",
              "type": "method",
              "name": "addListener",
              "meta": {
                "added": [
                  "v0.1.26"
                ]
              },
              "desc": "
Alias for emitter.on(eventName, listener).
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "eventName"
                    },
                    {
                      "name": "listener"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "emitter.emit(eventName[, arg1][, arg2][, ...])",
              "type": "method",
              "name": "emit",
              "meta": {
                "added": [
                  "v0.1.26"
                ]
              },
              "desc": "
Synchronously calls each of the listeners registered for the event named\neventName, in the order they were registered, passing the supplied arguments\nto each.
\n
Returns true if the event had listeners, false otherwise.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "eventName"
                    },
                    {
                      "name": "arg1",
                      "optional": true
                    },
                    {
                      "name": "arg2",
                      "optional": true
                    },
                    {
                      "name": "...",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "emitter.getMaxListeners()",
              "type": "method",
              "name": "getMaxListeners",
              "meta": {
                "added": [
                  "v1.0.0"
                ]
              },
              "desc": "
Returns the current max listener value for the EventEmitter which is either\nset by emitter.setMaxListeners(n) or defaults to\nEventEmitter.defaultMaxListeners.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "emitter.listenerCount(eventName)",
              "type": "method",
              "name": "listenerCount",
              "meta": {
                "added": [
                  "v3.2.0"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`eventName` {Value} The name of the event being listened for ",
                      "name": "eventName",
                      "type": "Value",
                      "desc": "The name of the event being listened for"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "eventName"
                    }
                  ]
                }
              ],
              "desc": "
Returns the number of listeners listening to the event named eventName.
\n"
            },
            {
              "textRaw": "emitter.listeners(eventName)",
              "type": "method",
              "name": "listeners",
              "meta": {
                "added": [
                  "v0.1.26"
                ]
              },
              "desc": "
Returns a copy of the array of listeners for the event named eventName.
\n
server.on('connection', (stream) => {\n  console.log('someone connected!');\n});\nconsole.log(util.inspect(server.listeners('connection')));\n  // Prints: [ [Function] ]\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "eventName"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "emitter.on(eventName, listener)",
              "type": "method",
              "name": "on",
              "meta": {
                "added": [
                  "v0.1.101"
                ]
              },
              "desc": "
Adds the listener function to the end of the listeners array for the\nevent named eventName. No checks are made to see if the listener has\nalready been added. Multiple calls passing the same combination of eventName\nand listener will result in the listener being added, and called, multiple\ntimes.
\n
server.on('connection', (stream) => {\n  console.log('someone connected!');\n});\n
\n
Returns a reference to the EventEmitter so calls can be chained.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "eventName"
                    },
                    {
                      "name": "listener"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "emitter.once(eventName, listener)",
              "type": "method",
              "name": "once",
              "meta": {
                "added": [
                  "v0.3.0"
                ]
              },
              "desc": "
Adds a one time listener function for the event named eventName. The\nnext time eventName is triggered, this listener is removed and then invoked.
\n
server.once('connection', (stream) => {\n  console.log('Ah, we have our first user!');\n});\n
\n
Returns a reference to the EventEmitter so calls can be chained.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "eventName"
                    },
                    {
                      "name": "listener"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "emitter.removeAllListeners([eventName])",
              "type": "method",
              "name": "removeAllListeners",
              "meta": {
                "added": [
                  "v0.1.26"
                ]
              },
              "desc": "
Removes all listeners, or those of the specified eventName.
\n
Note that it is bad practice to remove listeners added elsewhere in the code,\nparticularly when the EventEmitter instance was created by some other\ncomponent or module (e.g. sockets or file streams).
\n
Returns a reference to the EventEmitter so calls can be chained.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "eventName",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "emitter.removeListener(eventName, listener)",
              "type": "method",
              "name": "removeListener",
              "meta": {
                "added": [
                  "v0.1.26"
                ]
              },
              "desc": "
Removes the specified listener from the listener array for the event named\neventName.
\n
var callback = (stream) => {\n  console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n
\n
removeListener will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified eventName, then removeListener must be\ncalled multiple times to remove each instance.
\n
Note that once an event has been emitted, all listeners attached to it at the\ntime of emitting will be called in order. This implies that any removeListener()\nor removeAllListeners() calls after emitting and before the last listener\nfinishes execution will not remove them from emit() in progress. Subsequent\nevents will behave as expected.
\n
const myEmitter = new MyEmitter();\n\nvar callbackA = () => {\n  console.log('A');\n  myEmitter.removeListener('event', callbackB);\n};\n\nvar callbackB = () => {\n  console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n  // Prints:\n  //   A\n  //   B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n  // Prints:\n  //   A\n
\n
Because listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered after the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it will means that any copies of the listener array as returned by\nthe emitter.listeners() method will need to be recreated.
\n
Returns a reference to the EventEmitter so calls can be chained.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "eventName"
                    },
                    {
                      "name": "listener"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "emitter.setMaxListeners(n)",
              "type": "method",
              "name": "setMaxListeners",
              "meta": {
                "added": [
                  "v0.3.5"
                ]
              },
              "desc": "
By default EventEmitters will print a warning if more than 10 listeners are\nadded for a particular event. This is a useful default that helps finding\nmemory leaks. Obviously, not all events should be limited to just 10 listeners.\nThe emitter.setMaxListeners() method allows the limit to be modified for this\nspecific EventEmitter instance. The value can be set to Infinity (or 0)\nto indicate an unlimited number of listeners.
\n
Returns a reference to the EventEmitter so calls can be chained.
\n\n\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "n"
                    }
                  ]
                }
              ]
            }
          ],
          "properties": [
            {
              "textRaw": "EventEmitter.defaultMaxListeners",
              "name": "defaultMaxListeners",
              "meta": {
                "added": [
                  "v0.11.2"
                ]
              },
              "desc": "
By default, a maximum of 10 listeners can be registered for any single\nevent. This limit can be changed for individual EventEmitter instances\nusing the emitter.setMaxListeners(n) method. To change the default\nfor all EventEmitter instances, the EventEmitter.defaultMaxListeners\nproperty can be used.
\n
Take caution when setting the EventEmitter.defaultMaxListeners because the\nchange effects all EventEmitter instances, including those created before\nthe change is made. However, calling emitter.setMaxListeners(n) still has\nprecedence over EventEmitter.defaultMaxListeners.
\n
Note that this is not a hard limit. The EventEmitter instance will allow\nmore listeners to be added but will output a trace warning to stderr indicating\nthat a possible EventEmitter memory leak has been detected. For any single\nEventEmitter, the emitter.getMaxListeners() and emitter.setMaxListeners()\nmethods can be used to temporarily avoid this warning:
\n
emitter.setMaxListeners(emitter.getMaxListeners() + 1);\nemitter.once('event', () => {\n  // do stuff\n  emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0));\n});\n
\n"
            }
          ]
        }
      ]
    },
    {
      "textRaw": "File System",
      "name": "fs",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
File I/O is provided by simple wrappers around standard POSIX functions.  To\nuse this module do require('fs'). All the methods have asynchronous and\nsynchronous forms.
\n
The asynchronous form always takes a completion callback as its last argument.\nThe arguments passed to the completion callback depend on the method, but the\nfirst argument is always reserved for an exception. If the operation was\ncompleted successfully, then the first argument will be null or undefined.
\n
When using the synchronous form any exceptions are immediately thrown.\nYou can use try/catch to handle exceptions or allow them to bubble up.
\n
Here is an example of the asynchronous version:
\n
const fs = require('fs');\n\nfs.unlink('/tmp/hello', (err) => {\n  if (err) throw err;\n  console.log('successfully deleted /tmp/hello');\n});\n
\n
Here is the synchronous version:
\n
const fs = require('fs');\n\nfs.unlinkSync('/tmp/hello');\nconsole.log('successfully deleted /tmp/hello');\n
\n
With the asynchronous methods there is no guaranteed ordering. So the\nfollowing is prone to error:
\n
fs.rename('/tmp/hello', '/tmp/world', (err) => {\n  if (err) throw err;\n  console.log('renamed complete');\n});\nfs.stat('/tmp/world', (err, stats) => {\n  if (err) throw err;\n  console.log(`stats: ${JSON.stringify(stats)}`);\n});\n
\n
It could be that fs.stat is executed before fs.rename.\nThe correct way to do this is to chain the callbacks.
\n
fs.rename('/tmp/hello', '/tmp/world', (err) => {\n  if (err) throw err;\n  fs.stat('/tmp/world', (err, stats) => {\n    if (err) throw err;\n    console.log(`stats: ${JSON.stringify(stats)}`);\n  });\n});\n
\n
In busy processes, the programmer is strongly encouraged to use the\nasynchronous versions of these calls. The synchronous versions will block\nthe entire process until they complete--halting all connections.
\n
The relative path to a filename can be used. Remember, however, that this path\nwill be relative to process.cwd().
\n
Most fs functions let you omit the callback argument. If you do, a default\ncallback is used that rethrows errors. To get a trace to the original call\nsite, set the NODE_DEBUG environment variable:
\n
$ cat script.js\nfunction bad() {\n  require('fs').readFile('/');\n}\nbad();\n\n$ env NODE_DEBUG=fs node script.js\nfs.js:66\n        throw err;\n              ^\nError: EISDIR, read\n    at rethrow (fs.js:61:21)\n    at maybeCallback (fs.js:79:42)\n    at Object.fs.readFile (fs.js:153:18)\n    at bad (/path/to/script.js:2:17)\n    at Object.<anonymous> (/path/to/script.js:5:1)\n    <etc.>\n
",
      "classes": [
        {
          "textRaw": "Class: fs.FSWatcher",
          "type": "class",
          "name": "fs.FSWatcher",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
Objects returned from fs.watch() are of this type.
\n",
          "events": [
            {
              "textRaw": "Event: 'change'",
              "type": "event",
              "name": "change",
              "meta": {
                "added": [
                  "v0.5.8"
                ]
              },
              "params": [],
              "desc": "
Emitted when something changes in a watched directory or file.\nSee more details in fs.watch().
\n"
            },
            {
              "textRaw": "Event: 'error'",
              "type": "event",
              "name": "error",
              "meta": {
                "added": [
                  "v0.5.8"
                ]
              },
              "params": [],
              "desc": "
Emitted when an error occurs.
\n"
            }
          ],
          "methods": [
            {
              "textRaw": "watcher.close()",
              "type": "method",
              "name": "close",
              "meta": {
                "added": [
                  "v0.5.8"
                ]
              },
              "desc": "
Stop watching for changes on the given fs.FSWatcher.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            }
          ]
        },
        {
          "textRaw": "Class: fs.ReadStream",
          "type": "class",
          "name": "fs.ReadStream",
          "meta": {
            "added": [
              "v0.1.93"
            ]
          },
          "desc": "
ReadStream is a Readable Stream.
\n",
          "events": [
            {
              "textRaw": "Event: 'open'",
              "type": "event",
              "name": "open",
              "meta": {
                "added": [
                  "v0.1.93"
                ]
              },
              "params": [],
              "desc": "
Emitted when the ReadStream's file is opened.
\n"
            },
            {
              "textRaw": "Event: 'close'",
              "type": "event",
              "name": "close",
              "meta": {
                "added": [
                  "v0.1.93"
                ]
              },
              "desc": "
Emitted when the ReadStream's underlying file descriptor has been closed\nusing the fs.close() method.
\n",
              "params": []
            }
          ],
          "properties": [
            {
              "textRaw": "readStream.path",
              "name": "path",
              "meta": {
                "added": [
                  "v0.1.93"
                ]
              },
              "desc": "
The path to the file the stream is reading from.
\n"
            }
          ]
        },
        {
          "textRaw": "Class: fs.Stats",
          "type": "class",
          "name": "fs.Stats",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "desc": "
Objects returned from fs.stat(), fs.lstat() and fs.fstat() and their\nsynchronous counterparts are of this type.
\n
    \n
  • stats.isFile()
    • \n
  • stats.isDirectory()
    • \n
  • stats.isBlockDevice()
    • \n
  • stats.isCharacterDevice()
    • \n
  • stats.isSymbolicLink() (only valid with fs.lstat())
    • \n
  • stats.isFIFO()
    • \n
  • stats.isSocket()
    • \n
\n
For a regular file util.inspect(stats) would return a string very\nsimilar to this:
\n
{\n  dev: 2114,\n  ino: 48064969,\n  mode: 33188,\n  nlink: 1,\n  uid: 85,\n  gid: 100,\n  rdev: 0,\n  size: 527,\n  blksize: 4096,\n  blocks: 8,\n  atime: Mon, 10 Oct 2011 23:24:11 GMT,\n  mtime: Mon, 10 Oct 2011 23:24:11 GMT,\n  ctime: Mon, 10 Oct 2011 23:24:11 GMT,\n  birthtime: Mon, 10 Oct 2011 23:24:11 GMT\n}\n
\n
Please note that atime, mtime, birthtime, and ctime are\ninstances of Date object and to compare the values of\nthese objects you should use appropriate methods. For most general\nuses getTime() will return the number of\nmilliseconds elapsed since 1 January 1970 00:00:00 UTC and this\ninteger should be sufficient for any comparison, however there are\nadditional methods which can be used for displaying fuzzy information.\nMore details can be found in the MDN JavaScript Reference\npage.
\n",
          "modules": [
            {
              "textRaw": "Stat Time Values",
              "name": "stat_time_values",
              "desc": "
The times in the stat object have the following semantics:
\n
    \n
  • atime "Access Time" - Time when file data last accessed.  Changed\nby the mknod(2), utimes(2), and read(2) system calls.
    • \n
  • mtime "Modified Time" - Time when file data last modified.\nChanged by the mknod(2), utimes(2), and write(2) system calls.
    • \n
  • ctime "Change Time" - Time when file status was last changed\n(inode data modification).  Changed by the chmod(2), chown(2),\nlink(2), mknod(2), rename(2), unlink(2), utimes(2),\nread(2), and write(2) system calls.
    • \n
  • birthtime "Birth Time" -  Time of file creation. Set once when the\nfile is created.  On filesystems where birthtime is not available,\nthis field may instead hold either the ctime or\n1970-01-01T00:00Z (ie, unix epoch timestamp 0). Note that this\nvalue may be greater than atime or mtime in this case. On Darwin\nand other FreeBSD variants, also set if the atime is explicitly\nset to an earlier value than the current birthtime using the\nutimes(2) system call.
    • \n
\n
Prior to Node v0.12, the ctime held the birthtime on Windows\nsystems.  Note that as of v0.12, ctime is not "creation time", and\non Unix systems, it never was.
\n",
              "type": "module",
              "displayName": "Stat Time Values"
            }
          ]
        },
        {
          "textRaw": "Class: fs.WriteStream",
          "type": "class",
          "name": "fs.WriteStream",
          "meta": {
            "added": [
              "v0.1.93"
            ]
          },
          "desc": "
WriteStream is a Writable Stream.
\n",
          "events": [
            {
              "textRaw": "Event: 'open'",
              "type": "event",
              "name": "open",
              "meta": {
                "added": [
                  "v0.1.93"
                ]
              },
              "params": [],
              "desc": "
Emitted when the WriteStream's file is opened.
\n"
            },
            {
              "textRaw": "Event: 'close'",
              "type": "event",
              "name": "close",
              "meta": {
                "added": [
                  "v0.1.93"
                ]
              },
              "desc": "
Emitted when the WriteStream's underlying file descriptor has been closed\nusing the fs.close() method.
\n",
              "params": []
            }
          ],
          "properties": [
            {
              "textRaw": "writeStream.bytesWritten",
              "name": "bytesWritten",
              "meta": {
                "added": [
                  "v0.4.7"
                ]
              },
              "desc": "
The number of bytes written so far. Does not include data that is still queued\nfor writing.
\n"
            },
            {
              "textRaw": "writeStream.path",
              "name": "path",
              "meta": {
                "added": [
                  "v0.1.93"
                ]
              },
              "desc": "
The path to the file the stream is writing to.
\n"
            }
          ]
        }
      ],
      "methods": [
        {
          "textRaw": "fs.access(path[, mode], callback)",
          "type": "method",
          "name": "access",
          "meta": {
            "added": [
              "v0.11.15"
            ]
          },
          "desc": "
Tests a user's permissions for the file specified by path. mode is an\noptional integer that specifies the accessibility checks to be performed. The\nfollowing constants define the possible values of mode. It is possible to\ncreate a mask consisting of the bitwise OR of two or more values.
\n
    \n
  • fs.F_OK - File is visible to the calling process. This is useful for\ndetermining if a file exists, but says nothing about rwx permissions.\nDefault if no mode is specified.
    • \n
  • fs.R_OK - File can be read by the calling process.
    • \n
  • fs.W_OK - File can be written by the calling process.
    • \n
  • fs.X_OK - File can be executed by the calling process. This has no effect\non Windows (will behave like fs.F_OK).
    • \n
\n
The final argument, callback, is a callback function that is invoked with\na possible error argument. If any of the accessibility checks fail, the error\nargument will be populated. The following example checks if the file\n/etc/passwd can be read and written by the current process.
\n
fs.access('/etc/passwd', fs.R_OK | fs.W_OK, (err) => {\n  console.log(err ? 'no access!' : 'can read/write');\n});\n
\n
Using fs.access() to check for the accessibility of a file before calling\nfs.open(), fs.readFile() or fs.writeFile() is not recommended. Doing\nso introduces a race condition, since other processes may change the file's\nstate between the two calls. Instead, user code should open/read/write the\nfile directly and handle the error raised if the file is not accessible.
\n
For example:
\n
write (NOT RECOMMENDED)
\n
fs.access('myfile', (err) => {\n  if (!err) {\n    console.error('myfile already exists');\n    return;\n  }\n\n  fs.open('myfile', 'wx', (err, fd) => {\n    if (err) throw err;\n    writeMyData(fd);\n  });\n});\n
\n
write (RECOMMENDED)
\n
fs.open('myfile', 'wx', (err, fd) => {\n  if (err) {\n    if (err.code === "EEXIST") {\n      console.error('myfile already exists');\n      return;\n    } else {\n      throw err;\n    }\n  }\n\n  writeMyData(fd);\n});\n
\n
read (NOT RECOMMENDED)
\n
fs.access('myfile', (err) => {\n  if (err) {\n    if (err.code === "ENOENT") {\n      console.error('myfile does not exist');\n      return;\n    } else {\n      throw err;\n    }\n  }\n\n  fs.open('myfile', 'r', (err, fd) => {\n    if (err) throw err;\n    readMyData(fd);\n  });\n});\n
\n
read (RECOMMENDED)
\n
fs.open('myfile', 'r', (err, fd) => {\n  if (err) {\n    if (err.code === "ENOENT") {\n      console.error('myfile does not exist');\n      return;\n    } else {\n      throw err;\n    }\n  }\n\n  readMyData(fd);\n});\n
\n
The "not recommended" examples above check for accessibility and then use the\nfile; the "recommended" examples are better because they use the file directly\nand handle the error, if any.
\n
In general, check for the accessibility of a file only if the file won’t be\nused directly, for example when its accessibility is a signal from another\nprocess.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "mode",
                  "optional": true
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.accessSync(path[, mode])",
          "type": "method",
          "name": "accessSync",
          "meta": {
            "added": [
              "v0.11.15"
            ]
          },
          "desc": "
Synchronous version of fs.access(). This throws if any accessibility checks\nfail, and does nothing otherwise.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "mode",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.appendFile(file, data[, options], callback)",
          "type": "method",
          "name": "appendFile",
          "meta": {
            "added": [
              "v0.6.7"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`file` {String} filename ",
                  "name": "file",
                  "type": "String",
                  "desc": "filename"
                },
                {
                  "textRaw": "`data` {String|Buffer} ",
                  "name": "data",
                  "type": "String|Buffer"
                },
                {
                  "textRaw": "`options` {Object|String} ",
                  "options": [
                    {
                      "textRaw": "`encoding` {String|Null} default = `'utf8'` ",
                      "name": "encoding",
                      "type": "String|Null",
                      "desc": "default = `'utf8'`"
                    },
                    {
                      "textRaw": "`mode` {Number} default = `0o666` ",
                      "name": "mode",
                      "type": "Number",
                      "desc": "default = `0o666`"
                    },
                    {
                      "textRaw": "`flag` {String} default = `'a'` ",
                      "name": "flag",
                      "type": "String",
                      "desc": "default = `'a'`"
                    }
                  ],
                  "name": "options",
                  "type": "Object|String",
                  "optional": true
                },
                {
                  "textRaw": "`callback` {Function} ",
                  "name": "callback",
                  "type": "Function"
                }
              ]
            },
            {
              "params": [
                {
                  "name": "file"
                },
                {
                  "name": "data"
                },
                {
                  "name": "options",
                  "optional": true
                },
                {
                  "name": "callback"
                }
              ]
            }
          ],
          "desc": "
Asynchronously append data to a file, creating the file if it does not yet exist.\ndata can be a string or a buffer.
\n
Example:
\n
fs.appendFile('message.txt', 'data to append', (err) => {\n  if (err) throw err;\n  console.log('The "data to append" was appended to file!');\n});\n
\n
If options is a string, then it specifies the encoding. Example:
\n
fs.appendFile('message.txt', 'data to append', 'utf8', callback);\n
\n"
        },
        {
          "textRaw": "fs.appendFileSync(file, data[, options])",
          "type": "method",
          "name": "appendFileSync",
          "meta": {
            "added": [
              "v0.6.7"
            ]
          },
          "desc": "
The synchronous version of fs.appendFile(). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "file"
                },
                {
                  "name": "data"
                },
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.chmod(path, mode, callback)",
          "type": "method",
          "name": "chmod",
          "meta": {
            "added": [
              "v0.1.30"
            ]
          },
          "desc": "
Asynchronous chmod(2). No arguments other than a possible exception are given\nto the completion callback.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "mode"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.chmodSync(path, mode)",
          "type": "method",
          "name": "chmodSync",
          "meta": {
            "added": [
              "v0.6.7"
            ]
          },
          "desc": "
Synchronous chmod(2). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "mode"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.chown(path, uid, gid, callback)",
          "type": "method",
          "name": "chown",
          "meta": {
            "added": [
              "v0.1.97"
            ]
          },
          "desc": "
Asynchronous chown(2). No arguments other than a possible exception are given\nto the completion callback.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "uid"
                },
                {
                  "name": "gid"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.chownSync(path, uid, gid)",
          "type": "method",
          "name": "chownSync",
          "meta": {
            "added": [
              "v0.1.97"
            ]
          },
          "desc": "
Synchronous chown(2). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "uid"
                },
                {
                  "name": "gid"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.close(fd, callback)",
          "type": "method",
          "name": "close",
          "meta": {
            "added": [
              "v0.0.2"
            ]
          },
          "desc": "
Asynchronous close(2).  No arguments other than a possible exception are given\nto the completion callback.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.closeSync(fd)",
          "type": "method",
          "name": "closeSync",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "desc": "
Synchronous close(2). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.createReadStream(path[, options])",
          "type": "method",
          "name": "createReadStream",
          "meta": {
            "added": [
              "v0.1.31"
            ]
          },
          "desc": "
Returns a new ReadStream object. (See Readable Stream).
\n
Be aware that, unlike the default value set for highWaterMark on a\nreadable stream (16 kb), the stream returned by this method has a\ndefault value of 64 kb for the same parameter.
\n
options is an object or string with the following defaults:
\n
{\n  flags: 'r',\n  encoding: null,\n  fd: null,\n  mode: 0o666,\n  autoClose: true\n}\n
\n
options can include start and end values to read a range of bytes from\nthe file instead of the entire file.  Both start and end are inclusive and\nstart counting at 0. If fd is specified and start is omitted or undefined,\nfs.createReadStream() reads sequentially from the current file position.\nThe encoding can be any one of those accepted by Buffer.
\n
If fd is specified, ReadStream will ignore the path argument and will use\nthe specified file descriptor. This means that no 'open' event will be emitted.\nNote that fd should be blocking; non-blocking fds should be passed to\nnet.Socket.
\n
If autoClose is false, then the file descriptor won't be closed, even if\nthere's an error.  It is your responsibility to close it and make sure\nthere's no file descriptor leak.  If autoClose is set to true (default\nbehavior), on error or end the file descriptor will be closed\nautomatically.
\n
mode sets the file mode (permission and sticky bits), but only if the\nfile was created.
\n
An example to read the last 10 bytes of a file which is 100 bytes long:
\n
fs.createReadStream('sample.txt', {start: 90, end: 99});\n
\n
If options is a string, then it specifies the encoding.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.createWriteStream(path[, options])",
          "type": "method",
          "name": "createWriteStream",
          "meta": {
            "added": [
              "v0.1.31"
            ]
          },
          "desc": "
Returns a new WriteStream object. (See Writable Stream).
\n
options is an object or string with the following defaults:
\n
{\n  flags: 'w',\n  defaultEncoding: 'utf8',\n  fd: null,\n  mode: 0o666\n}\n
\n
options may also include a start option to allow writing data at\nsome position past the beginning of the file.  Modifying a file rather\nthan replacing it may require a flags mode of r+ rather than the\ndefault mode w. The defaultEncoding can be any one of those accepted by Buffer.
\n
Like ReadStream, if fd is specified, WriteStream will ignore the\npath argument and will use the specified file descriptor. This means that no\n'open' event will be emitted. Note that fd should be blocking; non-blocking\nfds should be passed to net.Socket.
\n
If options is a string, then it specifies the encoding.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.exists(path, callback)",
          "type": "method",
          "name": "exists",
          "meta": {
            "added": [
              "v0.0.2"
            ],
            "deprecated": [
              "v1.0.0"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated: Use [`fs.stat()`][] or [`fs.access()`][] instead.",
          "desc": "
Test whether or not the given path exists by checking with the file system.\nThen call the callback argument with either true or false.  Example:
\n
fs.exists('/etc/passwd', (exists) => {\n  console.log(exists ? 'it\\'s there' : 'no passwd!');\n});\n
\n
Using fs.exists() to check for the existence of a file before calling\nfs.open(), fs.readFile() or fs.writeFile() is not recommended. Doing\nso introduces a race condition, since other processes may change the file's\nstate between the two calls. Instead, user code should open/read/write the\nfile directly and handle the error raised if the file does not exist.
\n
For example:
\n
write (NOT RECOMMENDED)
\n
fs.exists('myfile', (exists) => {\n  if (exists) {\n    console.error('myfile already exists');\n  } else {\n    fs.open('myfile', 'wx', (err, fd) => {\n      if (err) throw err;\n      writeMyData(fd);\n    });\n  }\n});\n
\n
write (RECOMMENDED)
\n
fs.open('myfile', 'wx', (err, fd) => {\n  if (err) {\n    if (err.code === "EEXIST") {\n      console.error('myfile already exists');\n      return;\n    } else {\n      throw err;\n    }\n  }\n  writeMyData(fd);\n});\n
\n
read (NOT RECOMMENDED)
\n
fs.exists('myfile', (exists) => {\n  if (exists) {\n    fs.open('myfile', 'r', (err, fd) => {\n      readMyData(fd);\n    });\n  } else {\n    console.error('myfile does not exist');\n  }\n});\n
\n
read (RECOMMENDED)
\n
fs.open('myfile', 'r', (err, fd) => {\n  if (err) {\n    if (err.code === "ENOENT") {\n      console.error('myfile does not exist');\n      return;\n    } else {\n      throw err;\n    }\n  } else {\n    readMyData(fd);\n  }\n});\n
\n
The "not recommended" examples above check for existence and then use the\nfile; the "recommended" examples are better because they use the file directly\nand handle the error, if any.
\n
In general, check for the existence of a file only if the file won’t be\nused directly, for example when its existence is a signal from another\nprocess.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.existsSync(path)",
          "type": "method",
          "name": "existsSync",
          "meta": {
            "added": [
              "v0.1.21"
            ],
            "deprecated": [
              "v1.0.0"
            ]
          },
          "desc": "
Stability: 0 - Deprecated: Use fs.statSync() or fs.accessSync()\ninstead.
\n
Synchronous version of fs.exists().\nReturns true if the file exists, false otherwise.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.fchmod(fd, mode, callback)",
          "type": "method",
          "name": "fchmod",
          "meta": {
            "added": [
              "v0.4.7"
            ]
          },
          "desc": "
Asynchronous fchmod(2). No arguments other than a possible exception\nare given to the completion callback.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "mode"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.fchmodSync(fd, mode)",
          "type": "method",
          "name": "fchmodSync",
          "meta": {
            "added": [
              "v0.4.7"
            ]
          },
          "desc": "
Synchronous fchmod(2). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "mode"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.fchown(fd, uid, gid, callback)",
          "type": "method",
          "name": "fchown",
          "meta": {
            "added": [
              "v0.4.7"
            ]
          },
          "desc": "
Asynchronous fchown(2). No arguments other than a possible exception are given\nto the completion callback.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "uid"
                },
                {
                  "name": "gid"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.fchownSync(fd, uid, gid)",
          "type": "method",
          "name": "fchownSync",
          "meta": {
            "added": [
              "v0.4.7"
            ]
          },
          "desc": "
Synchronous fchown(2). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "uid"
                },
                {
                  "name": "gid"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.fdatasync(fd, callback)",
          "type": "method",
          "name": "fdatasync",
          "meta": {
            "added": [
              "v0.1.96"
            ]
          },
          "desc": "
Asynchronous fdatasync(2). No arguments other than a possible exception are\ngiven to the completion callback.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.fdatasyncSync(fd)",
          "type": "method",
          "name": "fdatasyncSync",
          "meta": {
            "added": [
              "v0.1.96"
            ]
          },
          "desc": "
Synchronous fdatasync(2). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.fstat(fd, callback)",
          "type": "method",
          "name": "fstat",
          "meta": {
            "added": [
              "v0.1.95"
            ]
          },
          "desc": "
Asynchronous fstat(2). The callback gets two arguments (err, stats) where\nstats is a fs.Stats object. fstat() is identical to stat(),\nexcept that the file to be stat-ed is specified by the file descriptor fd.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.fstatSync(fd)",
          "type": "method",
          "name": "fstatSync",
          "meta": {
            "added": [
              "v0.1.95"
            ]
          },
          "desc": "
Synchronous fstat(2). Returns an instance of fs.Stats.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.fsync(fd, callback)",
          "type": "method",
          "name": "fsync",
          "meta": {
            "added": [
              "v0.1.96"
            ]
          },
          "desc": "
Asynchronous fsync(2). No arguments other than a possible exception are given\nto the completion callback.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.fsyncSync(fd)",
          "type": "method",
          "name": "fsyncSync",
          "meta": {
            "added": [
              "v0.1.96"
            ]
          },
          "desc": "
Synchronous fsync(2). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.ftruncate(fd, len, callback)",
          "type": "method",
          "name": "ftruncate",
          "meta": {
            "added": [
              "v0.8.6"
            ]
          },
          "desc": "
Asynchronous ftruncate(2). No arguments other than a possible exception are\ngiven to the completion callback.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "len"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.ftruncateSync(fd, len)",
          "type": "method",
          "name": "ftruncateSync",
          "meta": {
            "added": [
              "v0.8.6"
            ]
          },
          "desc": "
Synchronous ftruncate(2). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "len"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.futimes(fd, atime, mtime, callback)",
          "type": "method",
          "name": "futimes",
          "meta": {
            "added": [
              "v0.4.2"
            ]
          },
          "desc": "
Change the file timestamps of a file referenced by the supplied file\ndescriptor.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "atime"
                },
                {
                  "name": "mtime"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.futimesSync(fd, atime, mtime)",
          "type": "method",
          "name": "futimesSync",
          "meta": {
            "added": [
              "v0.4.2"
            ]
          },
          "desc": "
Synchronous version of fs.futimes(). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "atime"
                },
                {
                  "name": "mtime"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.lchmod(path, mode, callback)",
          "type": "method",
          "name": "lchmod",
          "meta": {
            "deprecated": [
              "v0.4.7"
            ]
          },
          "desc": "
Asynchronous lchmod(2). No arguments other than a possible exception\nare given to the completion callback.
\n
Only available on Mac OS X.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "mode"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.lchmodSync(path, mode)",
          "type": "method",
          "name": "lchmodSync",
          "meta": {
            "deprecated": [
              "v0.4.7"
            ]
          },
          "desc": "
Synchronous lchmod(2). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "mode"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.lchown(path, uid, gid, callback)",
          "type": "method",
          "name": "lchown",
          "meta": {
            "deprecated": [
              "v0.4.7"
            ]
          },
          "desc": "
Asynchronous lchown(2). No arguments other than a possible exception are given\nto the completion callback.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "uid"
                },
                {
                  "name": "gid"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.lchownSync(path, uid, gid)",
          "type": "method",
          "name": "lchownSync",
          "meta": {
            "deprecated": [
              "v0.4.7"
            ]
          },
          "desc": "
Synchronous lchown(2). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "uid"
                },
                {
                  "name": "gid"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.link(srcpath, dstpath, callback)",
          "type": "method",
          "name": "link",
          "meta": {
            "added": [
              "v0.1.31"
            ]
          },
          "desc": "
Asynchronous link(2). No arguments other than a possible exception are given to\nthe completion callback.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "srcpath"
                },
                {
                  "name": "dstpath"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.linkSync(srcpath, dstpath)",
          "type": "method",
          "name": "linkSync",
          "meta": {
            "added": [
              "v0.1.31"
            ]
          },
          "desc": "
Synchronous link(2). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "srcpath"
                },
                {
                  "name": "dstpath"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.lstat(path, callback)",
          "type": "method",
          "name": "lstat",
          "meta": {
            "added": [
              "v0.1.30"
            ]
          },
          "desc": "
Asynchronous lstat(2). The callback gets two arguments (err, stats) where\nstats is a fs.Stats object. lstat() is identical to stat(),\nexcept that if path is a symbolic link, then the link itself is stat-ed,\nnot the file that it refers to.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.lstatSync(path)",
          "type": "method",
          "name": "lstatSync",
          "meta": {
            "added": [
              "v0.1.30"
            ]
          },
          "desc": "
Synchronous lstat(2). Returns an instance of fs.Stats.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.mkdir(path[, mode], callback)",
          "type": "method",
          "name": "mkdir",
          "meta": {
            "added": [
              "v0.1.8"
            ]
          },
          "desc": "
Asynchronous mkdir(2). No arguments other than a possible exception are given\nto the completion callback. mode defaults to 0o777.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "mode",
                  "optional": true
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.mkdirSync(path[, mode])",
          "type": "method",
          "name": "mkdirSync",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "desc": "
Synchronous mkdir(2). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "mode",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.mkdtemp(prefix, callback)",
          "type": "method",
          "name": "mkdtemp",
          "desc": "
Creates a unique temporary directory.
\n
Generates six random characters to be appended behind a required\nprefix to create a unique temporary directory.
\n
The created folder path is passed as a string to the callback's second\nparameter.
\n
Example:
\n
fs.mkdtemp('/tmp/foo-', (err, folder) => {\n  console.log(folder);\n    // Prints: /tmp/foo-itXde2\n});\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "prefix"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.mkdtempSync(template)",
          "type": "method",
          "name": "mkdtempSync",
          "desc": "
The synchronous version of [fs.mkdtemp()][]. Returns the created\nfolder path.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "template"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.open(path, flags[, mode], callback)",
          "type": "method",
          "name": "open",
          "meta": {
            "added": [
              "v0.0.2"
            ]
          },
          "desc": "
Asynchronous file open. See open(2). flags can be:
\n
    \n
  • 'r' - Open file for reading.\nAn exception occurs if the file does not exist.
    \n
    • \n
  • 'r+' - Open file for reading and writing.\nAn exception occurs if the file does not exist.
    \n
    • \n
  • 'rs' - Open file for reading in synchronous mode. Instructs the operating\nsystem to bypass the local file system cache.
    \n
    This is primarily useful for opening files on NFS mounts as it allows you to\nskip the potentially stale local cache. It has a very real impact on I/O\nperformance so don't use this flag unless you need it.
    \n
    Note that this doesn't turn fs.open() into a synchronous blocking call.\nIf that's what you want then you should be using fs.openSync()
    \n
    • \n
  • 'rs+' - Open file for reading and writing, telling the OS to open it\nsynchronously. See notes for 'rs' about using this with caution.
    \n
    • \n
  • 'w' - Open file for writing.\nThe file is created (if it does not exist) or truncated (if it exists).
    \n
    • \n
  • 'wx' - Like 'w' but fails if path exists.
    \n
    • \n
  • 'w+' - Open file for reading and writing.\nThe file is created (if it does not exist) or truncated (if it exists).
    \n
    • \n
  • 'wx+' - Like 'w+' but fails if path exists.
    \n
    • \n
  • 'a' - Open file for appending.\nThe file is created if it does not exist.
    \n
    • \n
  • 'ax' - Like 'a' but fails if path exists.
    \n
    • \n
  • 'a+' - Open file for reading and appending.\nThe file is created if it does not exist.
    \n
    • \n
  • 'ax+' - Like 'a+' but fails if path exists.
    \n
    • \n
\n
mode sets the file mode (permission and sticky bits), but only if the file was\ncreated. It defaults to 0666, readable and writable.
\n
The callback gets two arguments (err, fd).
\n
The exclusive flag 'x' (O_EXCL flag in open(2)) ensures that path is newly\ncreated. On POSIX systems, path is considered to exist even if it is a symlink\nto a non-existent file. The exclusive flag may or may not work with network file\nsystems.
\n
flags can also be a number as documented by open(2); commonly used constants\nare available from require('constants').  On Windows, flags are translated to\ntheir equivalent ones where applicable, e.g. O_WRONLY to FILE_GENERIC_WRITE,\nor O_EXCL|O_CREAT to CREATE_NEW, as accepted by CreateFileW.
\n
On Linux, positional writes don't work when the file is opened in append mode.\nThe kernel ignores the position argument and always appends the data to\nthe end of the file.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "flags"
                },
                {
                  "name": "mode",
                  "optional": true
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.openSync(path, flags[, mode])",
          "type": "method",
          "name": "openSync",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "desc": "
Synchronous version of fs.open(). Returns an integer representing the file\ndescriptor.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "flags"
                },
                {
                  "name": "mode",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.read(fd, buffer, offset, length, position, callback)",
          "type": "method",
          "name": "read",
          "meta": {
            "added": [
              "v0.0.2"
            ]
          },
          "desc": "
Read data from the file specified by fd.
\n
buffer is the buffer that the data will be written to.
\n
offset is the offset in the buffer to start writing at.
\n
length is an integer specifying the number of bytes to read.
\n
position is an integer specifying where to begin reading from in the file.\nIf position is null, data will be read from the current file position.
\n
The callback is given the three arguments, (err, bytesRead, buffer).
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "buffer"
                },
                {
                  "name": "offset"
                },
                {
                  "name": "length"
                },
                {
                  "name": "position"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.readdir(path, callback)",
          "type": "method",
          "name": "readdir",
          "meta": {
            "added": [
              "v0.1.8"
            ]
          },
          "desc": "
Asynchronous readdir(3).  Reads the contents of a directory.\nThe callback gets two arguments (err, files) where files is an array of\nthe names of the files in the directory excluding '.' and '..'.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.readdirSync(path)",
          "type": "method",
          "name": "readdirSync",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "desc": "
Synchronous readdir(3). Returns an array of filenames excluding '.' and\n'..'.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.readFile(file[, options], callback)",
          "type": "method",
          "name": "readFile",
          "meta": {
            "added": [
              "v0.1.29"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`file` {String} filename ",
                  "name": "file",
                  "type": "String",
                  "desc": "filename"
                },
                {
                  "textRaw": "`options` {Object | String} ",
                  "options": [
                    {
                      "textRaw": "`encoding` {String | Null} default = `null` ",
                      "name": "encoding",
                      "type": "String | Null",
                      "desc": "default = `null`"
                    },
                    {
                      "textRaw": "`flag` {String} default = `'r'` ",
                      "name": "flag",
                      "type": "String",
                      "desc": "default = `'r'`"
                    }
                  ],
                  "name": "options",
                  "type": "Object | String",
                  "optional": true
                },
                {
                  "textRaw": "`callback` {Function} ",
                  "name": "callback",
                  "type": "Function"
                }
              ]
            },
            {
              "params": [
                {
                  "name": "file"
                },
                {
                  "name": "options",
                  "optional": true
                },
                {
                  "name": "callback"
                }
              ]
            }
          ],
          "desc": "
Asynchronously reads the entire contents of a file. Example:
\n
fs.readFile('/etc/passwd', (err, data) => {\n  if (err) throw err;\n  console.log(data);\n});\n
\n
The callback is passed two arguments (err, data), where data is the\ncontents of the file.
\n
If no encoding is specified, then the raw buffer is returned.
\n
If options is a string, then it specifies the encoding. Example:
\n
fs.readFile('/etc/passwd', 'utf8', callback);\n
\n"
        },
        {
          "textRaw": "fs.readFileSync(file[, options])",
          "type": "method",
          "name": "readFileSync",
          "meta": {
            "added": [
              "v0.1.8"
            ]
          },
          "desc": "
Synchronous version of fs.readFile. Returns the contents of the file.
\n
If the encoding option is specified then this function returns a\nstring. Otherwise it returns a buffer.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "file"
                },
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.readlink(path, callback)",
          "type": "method",
          "name": "readlink",
          "meta": {
            "added": [
              "v0.1.31"
            ]
          },
          "desc": "
Asynchronous readlink(2). The callback gets two arguments (err,\nlinkString).
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.readlinkSync(path)",
          "type": "method",
          "name": "readlinkSync",
          "meta": {
            "added": [
              "v0.1.31"
            ]
          },
          "desc": "
Synchronous readlink(2). Returns the symbolic link's string value.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.realpath(path[, cache], callback)",
          "type": "method",
          "name": "realpath",
          "meta": {
            "added": [
              "v0.1.31"
            ]
          },
          "desc": "
Asynchronous realpath(2). The callback gets two arguments (err,\nresolvedPath). May use process.cwd to resolve relative paths. cache is an\nobject literal of mapped paths that can be used to force a specific path\nresolution or avoid additional fs.stat calls for known real paths.
\n
Example:
\n
var cache = {'/etc':'/private/etc'};\nfs.realpath('/etc/passwd', cache, (err, resolvedPath) => {\n  if (err) throw err;\n  console.log(resolvedPath);\n});\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "cache",
                  "optional": true
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.readSync(fd, buffer, offset, length, position)",
          "type": "method",
          "name": "readSync",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "desc": "
Synchronous version of fs.read(). Returns the number of bytesRead.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "buffer"
                },
                {
                  "name": "offset"
                },
                {
                  "name": "length"
                },
                {
                  "name": "position"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.realpathSync(path[, cache])",
          "type": "method",
          "name": "realpathSync",
          "meta": {
            "added": [
              "v0.1.31"
            ]
          },
          "desc": "
Synchronous realpath(2). Returns the resolved path. cache is an\nobject literal of mapped paths that can be used to force a specific path\nresolution or avoid additional fs.stat calls for known real paths.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "cache",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.rename(oldPath, newPath, callback)",
          "type": "method",
          "name": "rename",
          "meta": {
            "added": [
              "v0.0.2"
            ]
          },
          "desc": "
Asynchronous rename(2). No arguments other than a possible exception are given\nto the completion callback.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "oldPath"
                },
                {
                  "name": "newPath"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.renameSync(oldPath, newPath)",
          "type": "method",
          "name": "renameSync",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "desc": "
Synchronous rename(2). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "oldPath"
                },
                {
                  "name": "newPath"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.rmdir(path, callback)",
          "type": "method",
          "name": "rmdir",
          "meta": {
            "added": [
              "v0.0.2"
            ]
          },
          "desc": "
Asynchronous rmdir(2). No arguments other than a possible exception are given\nto the completion callback.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.rmdirSync(path)",
          "type": "method",
          "name": "rmdirSync",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "desc": "
Synchronous rmdir(2). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.stat(path, callback)",
          "type": "method",
          "name": "stat",
          "meta": {
            "added": [
              "v0.0.2"
            ]
          },
          "desc": "
Asynchronous stat(2). The callback gets two arguments (err, stats) where\nstats is a fs.Stats object.  See the fs.Stats section for more\ninformation.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.statSync(path)",
          "type": "method",
          "name": "statSync",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "desc": "
Synchronous stat(2). Returns an instance of fs.Stats.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.symlink(target, path[, type], callback)",
          "type": "method",
          "name": "symlink",
          "meta": {
            "added": [
              "v0.1.31"
            ]
          },
          "desc": "
Asynchronous symlink(2). No arguments other than a possible exception are given\nto the completion callback.\nThe type argument can be set to 'dir', 'file', or 'junction' (default\nis 'file') and is only available on Windows (ignored on other platforms).\nNote that Windows junction points require the destination path to be absolute.  When using\n'junction', the target argument will automatically be normalized to absolute path.
\n
Here is an example below:
\n
fs.symlink('./foo', './new-port');\n
\n
It creates a symbolic link named "new-port" that points to "foo".
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "target"
                },
                {
                  "name": "path"
                },
                {
                  "name": "type",
                  "optional": true
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.symlinkSync(target, path[, type])",
          "type": "method",
          "name": "symlinkSync",
          "meta": {
            "added": [
              "v0.1.31"
            ]
          },
          "desc": "
Synchronous symlink(2). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "target"
                },
                {
                  "name": "path"
                },
                {
                  "name": "type",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.truncate(path, len, callback)",
          "type": "method",
          "name": "truncate",
          "meta": {
            "added": [
              "v0.8.6"
            ]
          },
          "desc": "
Asynchronous truncate(2). No arguments other than a possible exception are\ngiven to the completion callback. A file descriptor can also be passed as the\nfirst argument. In this case, fs.ftruncate() is called.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "len"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.truncateSync(path, len)",
          "type": "method",
          "name": "truncateSync",
          "meta": {
            "added": [
              "v0.8.6"
            ]
          },
          "desc": "
Synchronous truncate(2). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "len"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.unlink(path, callback)",
          "type": "method",
          "name": "unlink",
          "meta": {
            "added": [
              "v0.0.2"
            ]
          },
          "desc": "
Asynchronous unlink(2). No arguments other than a possible exception are given\nto the completion callback.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.unlinkSync(path)",
          "type": "method",
          "name": "unlinkSync",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "desc": "
Synchronous unlink(2). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.unwatchFile(filename[, listener])",
          "type": "method",
          "name": "unwatchFile",
          "meta": {
            "added": [
              "v0.1.31"
            ]
          },
          "desc": "
Stop watching for changes on filename. If listener is specified, only that\nparticular listener is removed. Otherwise, all listeners are removed and you\nhave effectively stopped watching filename.
\n
Calling fs.unwatchFile() with a filename that is not being watched is a\nno-op, not an error.
\n
Note: fs.watch() is more efficient than fs.watchFile() and fs.unwatchFile().\nfs.watch() should be used instead of fs.watchFile() and fs.unwatchFile()\nwhen possible.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "filename"
                },
                {
                  "name": "listener",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.utimes(path, atime, mtime, callback)",
          "type": "method",
          "name": "utimes",
          "meta": {
            "added": [
              "v0.4.2"
            ]
          },
          "desc": "
Change file timestamps of the file referenced by the supplied path.
\n
Note: the arguments atime and mtime of the following related functions does\nfollow the below rules:
\n
    \n
  • If the value is a numberable string like '123456789', the value would get\nconverted to corresponding number.
    • \n
  • If the value is NaN or Infinity, the value would get converted to\nDate.now().
    • \n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "atime"
                },
                {
                  "name": "mtime"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.utimesSync(path, atime, mtime)",
          "type": "method",
          "name": "utimesSync",
          "meta": {
            "added": [
              "v0.4.2"
            ]
          },
          "desc": "
Synchronous version of fs.utimes(). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "atime"
                },
                {
                  "name": "mtime"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.watch(filename[, options][, listener])",
          "type": "method",
          "name": "watch",
          "meta": {
            "added": [
              "v0.5.10"
            ]
          },
          "desc": "
Watch for changes on filename, where filename is either a file or a\ndirectory.  The returned object is a fs.FSWatcher.
\n
The second argument is optional. The options if provided should be an object.\nThe supported boolean members are persistent and recursive. persistent\nindicates whether the process should continue to run as long as files are being\nwatched. recursive indicates whether all subdirectories should be watched, or\nonly the current directory. This applies when a directory is specified, and only\non supported platforms (See Caveats).
\n
The default is { persistent: true, recursive: false }.
\n
The listener callback gets two arguments (event, filename).  event is either\n'rename' or 'change', and filename is the name of the file which triggered\nthe event.
\n",
          "miscs": [
            {
              "textRaw": "Caveats",
              "name": "Caveats",
              "type": "misc",
              "desc": "
The fs.watch API is not 100% consistent across platforms, and is\nunavailable in some situations.
\n
The recursive option is only supported on OS X and Windows.
\n",
              "miscs": [
                {
                  "textRaw": "Availability",
                  "name": "Availability",
                  "type": "misc",
                  "desc": "
This feature depends on the underlying operating system providing a way\nto be notified of filesystem changes.
\n
    \n
  • On Linux systems, this uses inotify.
    • \n
  • On BSD systems, this uses kqueue.
    • \n
  • On OS X, this uses kqueue for files and 'FSEvents' for directories.
    • \n
  • On SunOS systems (including Solaris and SmartOS), this uses event ports.
    • \n
  • On Windows systems, this feature depends on ReadDirectoryChangesW.
    • \n
  • On Aix systems, this feature depends on AHAFS, which must be enabled.
    • \n
\n
If the underlying functionality is not available for some reason, then\nfs.watch will not be able to function. For example, watching files or\ndirectories can be unreliable, and in some cases impossible, on network file\nsystems (NFS, SMB, etc), or host file systems when using virtualization software\nsuch as Vagrant, Docker, etc.
\n
You can still use fs.watchFile, which uses stat polling, but it is slower and\nless reliable.
\n"
                },
                {
                  "textRaw": "Inodes",
                  "name": "Inodes",
                  "type": "misc",
                  "desc": "
On Linux and OS X systems, fs.watch() resolves the path to an inode and\nwatches the inode. If the watched path is deleted and recreated, it is assigned\na new inode. The watch will emit an event for the delete but will continue\nwatching the original inode. Events for the new inode will not be emitted.\nThis is expected behavior.
\n"
                },
                {
                  "textRaw": "Filename Argument",
                  "name": "Filename Argument",
                  "type": "misc",
                  "desc": "
Providing filename argument in the callback is only supported on Linux and\nWindows.  Even on supported platforms, filename is not always guaranteed to\nbe provided. Therefore, don't assume that filename argument is always\nprovided in the callback, and have some fallback logic if it is null.
\n
fs.watch('somedir', (event, filename) => {\n  console.log(`event is: ${event}`);\n  if (filename) {\n    console.log(`filename provided: ${filename}`);\n  } else {\n    console.log('filename not provided');\n  }\n});\n
\n"
                }
              ]
            }
          ],
          "signatures": [
            {
              "params": [
                {
                  "name": "filename"
                },
                {
                  "name": "options",
                  "optional": true
                },
                {
                  "name": "listener",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.watchFile(filename[, options], listener)",
          "type": "method",
          "name": "watchFile",
          "meta": {
            "added": [
              "v0.1.31"
            ]
          },
          "desc": "
Watch for changes on filename. The callback listener will be called each\ntime the file is accessed.
\n
The options argument may be omitted. If provided, it should be an object. The\noptions object may contain a boolean named persistent that indicates\nwhether the process should continue to run as long as files are being watched.\nThe options object may specify an interval property indicating how often the\ntarget should be polled in milliseconds. The default is\n{ persistent: true, interval: 5007 }.
\n
The listener gets two arguments the current stat object and the previous\nstat object:
\n
fs.watchFile('message.text', (curr, prev) => {\n  console.log(`the current mtime is: ${curr.mtime}`);\n  console.log(`the previous mtime was: ${prev.mtime}`);\n});\n
\n
These stat objects are instances of fs.Stat.
\n
If you want to be notified when the file was modified, not just accessed,\nyou need to compare curr.mtime and prev.mtime.
\n
Note: when an fs.watchFile operation results in an ENOENT error, it will\n invoke the listener once, with all the fields zeroed (or, for dates, the Unix\n Epoch). In Windows, blksize and blocks fields will be undefined, instead\n of zero. If the file is created later on, the listener will be called again,\n with the latest stat objects. This is a change in functionality since v0.10.
\n
Note: fs.watch() is more efficient than fs.watchFile and fs.unwatchFile.\nfs.watch should be used instead of fs.watchFile and fs.unwatchFile\nwhen possible.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "filename"
                },
                {
                  "name": "options",
                  "optional": true
                },
                {
                  "name": "listener"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.write(fd, buffer, offset, length[, position], callback)",
          "type": "method",
          "name": "write",
          "meta": {
            "added": [
              "v0.0.2"
            ]
          },
          "desc": "
Write buffer to the file specified by fd.
\n
offset determines the part of the buffer to be written, and length is\nan integer specifying the number of bytes to write.
\n
position refers to the offset from the beginning of the file where this data\nshould be written. If typeof position !== 'number', the data will be written\nat the current position. See pwrite(2).
\n
The callback will be given three arguments (err, written, buffer) where\nwritten specifies how many bytes were written from buffer.
\n
Note that it is unsafe to use fs.write multiple times on the same file\nwithout waiting for the callback. For this scenario,\nfs.createWriteStream is strongly recommended.
\n
On Linux, positional writes don't work when the file is opened in append mode.\nThe kernel ignores the position argument and always appends the data to\nthe end of the file.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "buffer"
                },
                {
                  "name": "offset"
                },
                {
                  "name": "length"
                },
                {
                  "name": "position",
                  "optional": true
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.write(fd, data[, position[, encoding]], callback)",
          "type": "method",
          "name": "write",
          "meta": {
            "added": [
              "v0.11.5"
            ]
          },
          "desc": "
Write data to the file specified by fd.  If data is not a Buffer instance\nthen the value will be coerced to a string.
\n
position refers to the offset from the beginning of the file where this data\nshould be written. If typeof position !== 'number' the data will be written at\nthe current position. See pwrite(2).
\n
encoding is the expected string encoding.
\n
The callback will receive the arguments (err, written, string) where written\nspecifies how many bytes the passed string required to be written. Note that\nbytes written is not the same as string characters. See Buffer.byteLength.
\n
Unlike when writing buffer, the entire string must be written. No substring\nmay be specified. This is because the byte offset of the resulting data may not\nbe the same as the string offset.
\n
Note that it is unsafe to use fs.write multiple times on the same file\nwithout waiting for the callback. For this scenario,\nfs.createWriteStream is strongly recommended.
\n
On Linux, positional writes don't work when the file is opened in append mode.\nThe kernel ignores the position argument and always appends the data to\nthe end of the file.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "data"
                },
                {
                  "name": "position",
                  "optional": true
                },
                {
                  "name": "encoding",
                  "optional": true
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.writeFile(file, data[, options], callback)",
          "type": "method",
          "name": "writeFile",
          "meta": {
            "added": [
              "v0.1.29"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`file` {String} filename ",
                  "name": "file",
                  "type": "String",
                  "desc": "filename"
                },
                {
                  "textRaw": "`data` {String | Buffer} ",
                  "name": "data",
                  "type": "String | Buffer"
                },
                {
                  "textRaw": "`options` {Object | String} ",
                  "options": [
                    {
                      "textRaw": "`encoding` {String | Null} default = `'utf8'` ",
                      "name": "encoding",
                      "type": "String | Null",
                      "desc": "default = `'utf8'`"
                    },
                    {
                      "textRaw": "`mode` {Number} default = `0o666` ",
                      "name": "mode",
                      "type": "Number",
                      "desc": "default = `0o666`"
                    },
                    {
                      "textRaw": "`flag` {String} default = `'w'` ",
                      "name": "flag",
                      "type": "String",
                      "desc": "default = `'w'`"
                    }
                  ],
                  "name": "options",
                  "type": "Object | String",
                  "optional": true
                },
                {
                  "textRaw": "`callback` {Function} ",
                  "name": "callback",
                  "type": "Function"
                }
              ]
            },
            {
              "params": [
                {
                  "name": "file"
                },
                {
                  "name": "data"
                },
                {
                  "name": "options",
                  "optional": true
                },
                {
                  "name": "callback"
                }
              ]
            }
          ],
          "desc": "
Asynchronously writes data to a file, replacing the file if it already exists.\ndata can be a string or a buffer.
\n
The encoding option is ignored if data is a buffer. It defaults\nto 'utf8'.
\n
Example:
\n
fs.writeFile('message.txt', 'Hello Node.js', (err) => {\n  if (err) throw err;\n  console.log('It\\'s saved!');\n});\n
\n
If options is a string, then it specifies the encoding. Example:
\n
fs.writeFile('message.txt', 'Hello Node.js', 'utf8', callback);\n
\n
Note that it is unsafe to use fs.writeFile multiple times on the same file\nwithout waiting for the callback. For this scenario,\nfs.createWriteStream is strongly recommended.
\n"
        },
        {
          "textRaw": "fs.writeFileSync(file, data[, options])",
          "type": "method",
          "name": "writeFileSync",
          "meta": {
            "added": [
              "v0.1.29"
            ]
          },
          "desc": "
The synchronous version of fs.writeFile(). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "file"
                },
                {
                  "name": "data"
                },
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.writeSync(fd, buffer, offset, length[, position])",
          "type": "method",
          "name": "writeSync",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "desc": "
Synchronous versions of fs.write(). Returns the number of bytes written.
\n\n\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "data"
                },
                {
                  "name": "position",
                  "optional": true
                },
                {
                  "name": "encoding",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "buffer"
                },
                {
                  "name": "offset"
                },
                {
                  "name": "length"
                },
                {
                  "name": "position",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.writeSync(fd, data[, position[, encoding]])",
          "type": "method",
          "name": "writeSync",
          "meta": {
            "added": [
              "v0.11.5"
            ]
          },
          "desc": "
Synchronous versions of fs.write(). Returns the number of bytes written.
\n\n\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "data"
                },
                {
                  "name": "position",
                  "optional": true
                },
                {
                  "name": "encoding",
                  "optional": true
                }
              ]
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "fs"
    },
    {
      "textRaw": "HTTP",
      "name": "http",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
To use the HTTP server and client one must require('http').
\n
The HTTP interfaces in Node.js are designed to support many features\nof the protocol which have been traditionally difficult to use.\nIn particular, large, possibly chunk-encoded, messages. The interface is\ncareful to never buffer entire requests or responses--the\nuser is able to stream data.
\n
HTTP message headers are represented by an object like this:
\n
{ 'content-length': '123',\n  'content-type': 'text/plain',\n  'connection': 'keep-alive',\n  'host': 'mysite.com',\n  'accept': '*/*' }\n
Keys are lowercased. Values are not modified.
\n
In order to support the full spectrum of possible HTTP applications, Node.js's\nHTTP API is very low-level. It deals with stream handling and message\nparsing only. It parses a message into headers and body but it does not\nparse the actual headers or the body.
\n
See message.headers for details on how duplicate headers are handled.
\n
The raw headers as they were received are retained in the rawHeaders\nproperty, which is an array of [key, value, key2, value2, ...].  For\nexample, the previous message header object might have a rawHeaders\nlist like the following:
\n
[ 'ConTent-Length', '123456',\n  'content-LENGTH', '123',\n  'content-type', 'text/plain',\n  'CONNECTION', 'keep-alive',\n  'Host', 'mysite.com',\n  'accepT', '*/*' ]\n
",
      "classes": [
        {
          "textRaw": "Class: http.Agent",
          "type": "class",
          "name": "http.Agent",
          "meta": {
            "added": [
              "v0.3.4"
            ]
          },
          "desc": "
The HTTP Agent is used for pooling sockets used in HTTP client\nrequests.
\n
The HTTP Agent also defaults client requests to using\nConnection:keep-alive. If no pending HTTP requests are waiting on a\nsocket to become free the socket is closed. This means that Node.js's\npool has the benefit of keep-alive when under load but still does not\nrequire developers to manually close the HTTP clients using\nKeepAlive.
\n
If you opt into using HTTP KeepAlive, you can create an Agent object\nwith that flag set to true.  (See the constructor options.)\nThen, the Agent will keep unused sockets in a pool for later use.  They\nwill be explicitly marked so as to not keep the Node.js process running.\nHowever, it is still a good idea to explicitly destroy() KeepAlive\nagents when they are no longer in use, so that the Sockets will be shut\ndown.
\n
Sockets are removed from the agent's pool when the socket emits either\na 'close' event or a special 'agentRemove' event. This means that if\nyou intend to keep one HTTP request open for a long time and don't\nwant it to stay in the pool you can do something along the lines of:
\n
http.get(options, (res) => {\n  // Do stuff\n}).on('socket', (socket) => {\n  socket.emit('agentRemove');\n});\n
\n
Alternatively, you could just opt out of pooling entirely using\nagent:false:
\n
http.get({\n  hostname: 'localhost',\n  port: 80,\n  path: '/',\n  agent: false  // create a new agent just for this one request\n}, (res) => {\n  // Do stuff with response\n})\n
\n",
          "methods": [
            {
              "textRaw": "agent.destroy()",
              "type": "method",
              "name": "destroy",
              "meta": {
                "added": [
                  "v0.11.4"
                ]
              },
              "desc": "
Destroy any sockets that are currently in use by the agent.
\n
It is usually not necessary to do this.  However, if you are using an\nagent with KeepAlive enabled, then it is best to explicitly shut down\nthe agent when you know that it will no longer be used.  Otherwise,\nsockets may hang open for quite a long time before the server\nterminates them.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "agent.getName(options)",
              "type": "method",
              "name": "getName",
              "meta": {
                "added": [
                  "v0.11.4"
                ]
              },
              "desc": "
Get a unique name for a set of request options, to determine whether a\nconnection can be reused.  In the http agent, this returns\nhost:port:localAddress.  In the https agent, the name includes the\nCA, cert, ciphers, and other HTTPS/TLS-specific options that determine\nsocket reusability.
\n
Options:
\n
    \n
  • host: A domain name or IP address of the server to issue the request to.
    • \n
  • port: Port of remote server.
    • \n
  • localAddress: Local interface to bind for network connections when issuing\nthe request.
    • \n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "options"
                    }
                  ]
                }
              ]
            }
          ],
          "properties": [
            {
              "textRaw": "agent.freeSockets",
              "name": "freeSockets",
              "meta": {
                "added": [
                  "v0.11.4"
                ]
              },
              "desc": "
An object which contains arrays of sockets currently awaiting use by\nthe Agent when HTTP KeepAlive is used.  Do not modify.
\n"
            },
            {
              "textRaw": "agent.maxFreeSockets",
              "name": "maxFreeSockets",
              "meta": {
                "added": [
                  "v0.11.7"
                ]
              },
              "desc": "
By default set to 256.  For Agents supporting HTTP KeepAlive, this\nsets the maximum number of sockets that will be left open in the free\nstate.
\n"
            },
            {
              "textRaw": "agent.maxSockets",
              "name": "maxSockets",
              "meta": {
                "added": [
                  "v0.3.6"
                ]
              },
              "desc": "
By default set to Infinity. Determines how many concurrent sockets the agent\ncan have open per origin. Origin is either a 'host:port' or\n'host:port:localAddress' combination.
\n"
            },
            {
              "textRaw": "agent.requests",
              "name": "requests",
              "meta": {
                "added": [
                  "v0.5.9"
                ]
              },
              "desc": "
An object which contains queues of requests that have not yet been assigned to\nsockets. Do not modify.
\n"
            },
            {
              "textRaw": "agent.sockets",
              "name": "sockets",
              "meta": {
                "added": [
                  "v0.3.6"
                ]
              },
              "desc": "
An object which contains arrays of sockets currently in use by the\nAgent.  Do not modify.
\n"
            }
          ],
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`options` {Object} Set of configurable options to set on the agent. Can have the following fields: ",
                  "options": [
                    {
                      "textRaw": "`keepAlive` {Boolean} Keep sockets around even when there are no outstanding requests, so they can be used for future requests without having to reestablish a TCP connection. Default = `false` ",
                      "name": "keepAlive",
                      "type": "Boolean",
                      "desc": "Keep sockets around even when there are no outstanding requests, so they can be used for future requests without having to reestablish a TCP connection. Default = `false`"
                    },
                    {
                      "textRaw": "`keepAliveMsecs` {Integer} When using the `keepAlive` option, specifies the [initial delay](net.html#net_socket_setkeepalive_enable_initialdelay) for TCP Keep-Alive packets. Ignored when the `keepAlive` option is `false` or `undefined`. Default = `1000`. ",
                      "name": "keepAliveMsecs",
                      "type": "Integer",
                      "desc": "When using the `keepAlive` option, specifies the [initial delay](net.html#net_socket_setkeepalive_enable_initialdelay) for TCP Keep-Alive packets. Ignored when the `keepAlive` option is `false` or `undefined`. Default = `1000`."
                    },
                    {
                      "textRaw": "`maxSockets` {Number} Maximum number of sockets to allow per host.  Default = `Infinity`. ",
                      "name": "maxSockets",
                      "type": "Number",
                      "desc": "Maximum number of sockets to allow per host.  Default = `Infinity`."
                    },
                    {
                      "textRaw": "`maxFreeSockets` {Number} Maximum number of sockets to leave open in a free state.  Only relevant if `keepAlive` is set to `true`. Default = `256`. ",
                      "name": "maxFreeSockets",
                      "type": "Number",
                      "desc": "Maximum number of sockets to leave open in a free state.  Only relevant if `keepAlive` is set to `true`. Default = `256`."
                    }
                  ],
                  "name": "options",
                  "type": "Object",
                  "desc": "Set of configurable options to set on the agent. Can have the following fields:",
                  "optional": true
                }
              ],
              "desc": "
The default http.globalAgent that is used by http.request() has all\nof these values set to their respective defaults.
\n
To configure any of them, you must create your own http.Agent object.
\n
const http = require('http');\nvar keepAliveAgent = new http.Agent({ keepAlive: true });\noptions.agent = keepAliveAgent;\nhttp.request(options, onResponseCallback);\n
\n"
            },
            {
              "params": [
                {
                  "name": "options",
                  "optional": true
                }
              ],
              "desc": "
The default http.globalAgent that is used by http.request() has all\nof these values set to their respective defaults.
\n
To configure any of them, you must create your own http.Agent object.
\n
const http = require('http');\nvar keepAliveAgent = new http.Agent({ keepAlive: true });\noptions.agent = keepAliveAgent;\nhttp.request(options, onResponseCallback);\n
\n"
            }
          ]
        },
        {
          "textRaw": "Class: http.ClientRequest",
          "type": "class",
          "name": "http.ClientRequest",
          "meta": {
            "added": [
              "v0.1.17"
            ]
          },
          "desc": "
This object is created internally and returned from http.request().  It\nrepresents an in-progress request whose header has already been queued.  The\nheader is still mutable using the setHeader(name, value), getHeader(name),\nremoveHeader(name) API.  The actual header will be sent along with the first\ndata chunk or when closing the connection.
\n
To get the response, add a listener for 'response' to the request object.\n'response' will be emitted from the request object when the response\nheaders have been received.  The 'response' event is executed with one\nargument which is an instance of http.IncomingMessage.
\n
During the 'response' event, one can add listeners to the\nresponse object; particularly to listen for the 'data' event.
\n
If no 'response' handler is added, then the response will be\nentirely discarded.  However, if you add a 'response' event handler,\nthen you must consume the data from the response object, either by\ncalling response.read() whenever there is a 'readable' event, or\nby adding a 'data' handler, or by calling the .resume() method.\nUntil the data is consumed, the 'end' event will not fire.  Also, until\nthe data is read it will consume memory that can eventually lead to a\n'process out of memory' error.
\n
Note: Node.js does not check whether Content-Length and the length of the body\nwhich has been transmitted are equal or not.
\n
The request implements the Writable Stream interface. This is an\nEventEmitter with the following events:
\n",
          "events": [
            {
              "textRaw": "Event: 'abort'",
              "type": "event",
              "name": "abort",
              "meta": {
                "added": [
                  "v1.4.1"
                ]
              },
              "desc": "
function () { }
\n
Emitted when the request has been aborted by the client. This event is only\nemitted on the first call to abort().
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'aborted'",
              "type": "event",
              "name": "aborted",
              "meta": {
                "added": [
                  "v0.3.8"
                ]
              },
              "desc": "
function () { }
\n
Emitted when the request has been aborted by the server and the network\nsocket has closed.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'connect'",
              "type": "event",
              "name": "connect",
              "meta": {
                "added": [
                  "v0.7.0"
                ]
              },
              "desc": "
function (response, socket, head) { }
\n
Emitted each time a server responds to a request with a CONNECT method. If this\nevent isn't being listened for, clients receiving a CONNECT method will have\ntheir connections closed.
\n
A client and server pair that shows you how to listen for the 'connect' event:
\n
const http = require('http');\nconst net = require('net');\nconst url = require('url');\n\n// Create an HTTP tunneling proxy\nvar proxy = http.createServer( (req, res) => {\n  res.writeHead(200, {'Content-Type': 'text/plain'});\n  res.end('okay');\n});\nproxy.on('connect', (req, cltSocket, head) => {\n  // connect to an origin server\n  var srvUrl = url.parse(`http://${req.url}`);\n  var srvSocket = net.connect(srvUrl.port, srvUrl.hostname, () => {\n    cltSocket.write('HTTP/1.1 200 Connection Established\\r\\n' +\n                    'Proxy-agent: Node.js-Proxy\\r\\n' +\n                    '\\r\\n');\n    srvSocket.write(head);\n    srvSocket.pipe(cltSocket);\n    cltSocket.pipe(srvSocket);\n  });\n});\n\n// now that proxy is running\nproxy.listen(1337, '127.0.0.1', () => {\n\n  // make a request to a tunneling proxy\n  var options = {\n    port: 1337,\n    hostname: '127.0.0.1',\n    method: 'CONNECT',\n    path: 'www.google.com:80'\n  };\n\n  var req = http.request(options);\n  req.end();\n\n  req.on('connect', (res, socket, head) => {\n    console.log('got connected!');\n\n    // make a request over an HTTP tunnel\n    socket.write('GET / HTTP/1.1\\r\\n' +\n                 'Host: www.google.com:80\\r\\n' +\n                 'Connection: close\\r\\n' +\n                 '\\r\\n');\n    socket.on('data', (chunk) => {\n      console.log(chunk.toString());\n    });\n    socket.on('end', () => {\n      proxy.close();\n    });\n  });\n});\n
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'continue'",
              "type": "event",
              "name": "continue",
              "meta": {
                "added": [
                  "v0.3.2"
                ]
              },
              "desc": "
function () { }
\n
Emitted when the server sends a '100 Continue' HTTP response, usually because\nthe request contained 'Expect: 100-continue'. This is an instruction that\nthe client should send the request body.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'response'",
              "type": "event",
              "name": "response",
              "meta": {
                "added": [
                  "v0.1.0"
                ]
              },
              "desc": "
function (response) { }
\n
Emitted when a response is received to this request. This event is emitted only\nonce. The response argument will be an instance of http.IncomingMessage.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'socket'",
              "type": "event",
              "name": "socket",
              "meta": {
                "added": [
                  "v0.5.3"
                ]
              },
              "desc": "
function (socket) { }
\n
Emitted after a socket is assigned to this request.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'upgrade'",
              "type": "event",
              "name": "upgrade",
              "meta": {
                "added": [
                  "v0.1.94"
                ]
              },
              "desc": "
function (response, socket, head) { }
\n
Emitted each time a server responds to a request with an upgrade. If this\nevent isn't being listened for, clients receiving an upgrade header will have\ntheir connections closed.
\n
A client server pair that show you how to listen for the 'upgrade' event.
\n
const http = require('http');\n\n// Create an HTTP server\nvar srv = http.createServer( (req, res) => {\n  res.writeHead(200, {'Content-Type': 'text/plain'});\n  res.end('okay');\n});\nsrv.on('upgrade', (req, socket, head) => {\n  socket.write('HTTP/1.1 101 Web Socket Protocol Handshake\\r\\n' +\n               'Upgrade: WebSocket\\r\\n' +\n               'Connection: Upgrade\\r\\n' +\n               '\\r\\n');\n\n  socket.pipe(socket); // echo back\n});\n\n// now that server is running\nsrv.listen(1337, '127.0.0.1', () => {\n\n  // make a request\n  var options = {\n    port: 1337,\n    hostname: '127.0.0.1',\n    headers: {\n      'Connection': 'Upgrade',\n      'Upgrade': 'websocket'\n    }\n  };\n\n  var req = http.request(options);\n  req.end();\n\n  req.on('upgrade', (res, socket, upgradeHead) => {\n    console.log('got upgraded!');\n    socket.end();\n    process.exit(0);\n  });\n});\n
\n",
              "params": []
            }
          ],
          "methods": [
            {
              "textRaw": "request.abort()",
              "type": "method",
              "name": "abort",
              "meta": {
                "added": [
                  "v0.3.8"
                ]
              },
              "desc": "
Marks the request as aborting. Calling this will cause remaining data\nin the response to be dropped and the socket to be destroyed.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "request.end([data][, encoding][, callback])",
              "type": "method",
              "name": "end",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Finishes sending the request. If any parts of the body are\nunsent, it will flush them to the stream. If the request is\nchunked, this will send the terminating '0\\r\\n\\r\\n'.
\n
If data is specified, it is equivalent to calling\nresponse.write(data, encoding) followed by request.end(callback).
\n
If callback is specified, it will be called when the request stream\nis finished.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "data",
                      "optional": true
                    },
                    {
                      "name": "encoding",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "request.flushHeaders()",
              "type": "method",
              "name": "flushHeaders",
              "meta": {
                "added": [
                  "v1.6.0"
                ]
              },
              "desc": "
Flush the request headers.
\n
For efficiency reasons, Node.js normally buffers the request headers until you\ncall request.end() or write the first chunk of request data.  It then tries\nhard to pack the request headers and data into a single TCP packet.
\n
That's usually what you want (it saves a TCP round-trip) but not when the first\ndata isn't sent until possibly much later.  request.flushHeaders() lets you bypass\nthe optimization and kickstart the request.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "request.setNoDelay([noDelay])",
              "type": "method",
              "name": "setNoDelay",
              "meta": {
                "added": [
                  "v0.5.9"
                ]
              },
              "desc": "
Once a socket is assigned to this request and is connected\nsocket.setNoDelay() will be called.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "noDelay",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "request.setSocketKeepAlive([enable][, initialDelay])",
              "type": "method",
              "name": "setSocketKeepAlive",
              "meta": {
                "added": [
                  "v0.5.9"
                ]
              },
              "desc": "
Once a socket is assigned to this request and is connected\nsocket.setKeepAlive() will be called.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "enable",
                      "optional": true
                    },
                    {
                      "name": "initialDelay",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "request.setTimeout(timeout[, callback])",
              "type": "method",
              "name": "setTimeout",
              "meta": {
                "added": [
                  "v0.5.9"
                ]
              },
              "desc": "
Once a socket is assigned to this request and is connected\nsocket.setTimeout() will be called.
\n
    \n
  • timeout {Number} Milliseconds before a request is considered to be timed out.
    • \n
  • callback {Function} Optional function to be called when a timeout occurs. Same as binding to the timeout event.
    • \n
\n
Returns request.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "timeout"
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "request.write(chunk[, encoding][, callback])",
              "type": "method",
              "name": "write",
              "meta": {
                "added": [
                  "v0.1.29"
                ]
              },
              "desc": "
Sends a chunk of the body.  By calling this method\nmany times, the user can stream a request body to a\nserver--in that case it is suggested to use the\n['Transfer-Encoding', 'chunked'] header line when\ncreating the request.
\n
The chunk argument should be a Buffer or a string.
\n
The encoding argument is optional and only applies when chunk is a string.\nDefaults to 'utf8'.
\n
The callback argument is optional and will be called when this chunk of data\nis flushed.
\n
Returns request.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "chunk"
                    },
                    {
                      "name": "encoding",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            }
          ],
          "properties": [
            {
              "textRaw": "request.aborted",
              "name": "aborted",
              "meta": {
                "added": [
                  "v0.11.14"
                ]
              },
              "desc": "
If a request has been aborted, this value is the time when the request was\naborted, in milliseconds since 1 January 1970 00:00:00 UTC.
\n"
            }
          ]
        },
        {
          "textRaw": "Class: http.Server",
          "type": "class",
          "name": "http.Server",
          "meta": {
            "added": [
              "v0.1.17"
            ]
          },
          "desc": "
This class inherits from net.Server and has the following additional events:
\n",
          "events": [
            {
              "textRaw": "Event: 'checkContinue'",
              "type": "event",
              "name": "checkContinue",
              "meta": {
                "added": [
                  "v0.3.0"
                ]
              },
              "desc": "
function (request, response) { }
\n
Emitted each time a request with an http Expect: 100-continue is received.\nIf this event isn't listened for, the server will automatically respond\nwith a 100 Continue as appropriate.
\n
Handling this event involves calling response.writeContinue() if the client\nshould continue to send the request body, or generating an appropriate HTTP\nresponse (e.g. 400 Bad Request) if the client should not continue to send the\nrequest body.
\n
Note that when this event is emitted and handled, the 'request' event will\nnot be emitted.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'clientError'",
              "type": "event",
              "name": "clientError",
              "meta": {
                "added": [
                  "v0.1.94"
                ]
              },
              "desc": "
function (exception, socket) { }
\n
If a client connection emits an 'error' event, it will be forwarded here.
\n
socket is the net.Socket object that the error originated from.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'close'",
              "type": "event",
              "name": "close",
              "meta": {
                "added": [
                  "v0.1.4"
                ]
              },
              "desc": "
function () { }
\n
Emitted when the server closes.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'connect'",
              "type": "event",
              "name": "connect",
              "meta": {
                "added": [
                  "v0.7.0"
                ]
              },
              "desc": "
function (request, socket, head) { }
\n
Emitted each time a client requests a http CONNECT method. If this event isn't\nlistened for, then clients requesting a CONNECT method will have their\nconnections closed.
\n
    \n
  • request is the arguments for the http request, as it is in the request\nevent.
    • \n
  • socket is the network socket between the server and client.
    • \n
  • head is an instance of Buffer, the first packet of the tunneling stream,\nthis may be empty.
    • \n
\n
After this event is emitted, the request's socket will not have a 'data'\nevent listener, meaning you will need to bind to it in order to handle data\nsent to the server on that socket.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'connection'",
              "type": "event",
              "name": "connection",
              "meta": {
                "added": [
                  "v0.1.0"
                ]
              },
              "desc": "
function (socket) { }
\n
When a new TCP stream is established. socket is an object of type\nnet.Socket. Usually users will not want to access this event. In\nparticular, the socket will not emit 'readable' events because of how\nthe protocol parser attaches to the socket. The socket can also be\naccessed at request.connection.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'request'",
              "type": "event",
              "name": "request",
              "meta": {
                "added": [
                  "v0.1.0"
                ]
              },
              "desc": "
function (request, response) { }
\n
Emitted each time there is a request. Note that there may be multiple requests\nper connection (in the case of keep-alive connections).\n request is an instance of http.IncomingMessage and response is\nan instance of http.ServerResponse.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'upgrade'",
              "type": "event",
              "name": "upgrade",
              "meta": {
                "added": [
                  "v0.1.94"
                ]
              },
              "desc": "
function (request, socket, head) { }
\n
Emitted each time a client requests a http upgrade. If this event isn't\nlistened for, then clients requesting an upgrade will have their connections\nclosed.
\n
    \n
  • request is the arguments for the http request, as it is in the request\nevent.
    • \n
  • socket is the network socket between the server and client.
    • \n
  • head is an instance of Buffer, the first packet of the upgraded stream,\nthis may be empty.
    • \n
\n
After this event is emitted, the request's socket will not have a 'data'\nevent listener, meaning you will need to bind to it in order to handle data\nsent to the server on that socket.
\n",
              "params": []
            }
          ],
          "methods": [
            {
              "textRaw": "server.close([callback])",
              "type": "method",
              "name": "close",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Stops the server from accepting new connections.  See net.Server.close().
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "server.listen(handle[, callback])",
              "type": "method",
              "name": "listen",
              "meta": {
                "added": [
                  "v0.5.10"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`handle` {Object} ",
                      "name": "handle",
                      "type": "Object"
                    },
                    {
                      "textRaw": "`callback` {Function} ",
                      "name": "callback",
                      "type": "Function",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "handle"
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
The handle object can be set to either a server or socket (anything\nwith an underlying _handle member), or a {fd: <n>} object.
\n
This will cause the server to accept connections on the specified\nhandle, but it is presumed that the file descriptor or handle has\nalready been bound to a port or domain socket.
\n
Listening on a file descriptor is not supported on Windows.
\n
This function is asynchronous. callback will be added as a listener for the\n'listening' event. See also net.Server.listen().
\n
Returns server.
\n"
            },
            {
              "textRaw": "server.listen(path[, callback])",
              "type": "method",
              "name": "listen",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Start a UNIX socket server listening for connections on the given path.
\n
This function is asynchronous. callback will be added as a listener for the\n'listening' event.  See also net.Server.listen(path).
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "path"
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "server.listen([port][, hostname][, backlog][, callback])",
              "type": "method",
              "name": "listen",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Begin accepting connections on the specified port and hostname. If the\nhostname is omitted, the server will accept connections on any IPv6 address\n(::) when IPv6 is available, or any IPv4 address (0.0.0.0) otherwise.\nOmit the port argument, or use a port value of 0, to have the operating system\nassign a random port, which can be retrieved by using server.address().port\nafter the 'listening' event has been emitted.
\n
To listen to a unix socket, supply a filename instead of port and hostname.
\n
Backlog is the maximum length of the queue of pending connections.\nThe actual length will be determined by your OS through sysctl settings such as\ntcp_max_syn_backlog and somaxconn on linux. The default value of this\nparameter is 511 (not 512).
\n
This function is asynchronous. callback will be added as a listener for the\n'listening' event.  See also net.Server.listen(port).
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "port",
                      "optional": true
                    },
                    {
                      "name": "hostname",
                      "optional": true
                    },
                    {
                      "name": "backlog",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "server.setTimeout(msecs, callback)",
              "type": "method",
              "name": "setTimeout",
              "meta": {
                "added": [
                  "v0.9.12"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`msecs` {Number} ",
                      "name": "msecs",
                      "type": "Number"
                    },
                    {
                      "textRaw": "`callback` {Function} ",
                      "name": "callback",
                      "type": "Function"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "msecs"
                    },
                    {
                      "name": "callback"
                    }
                  ]
                }
              ],
              "desc": "
Sets the timeout value for sockets, and emits a 'timeout' event on\nthe Server object, passing the socket as an argument, if a timeout\noccurs.
\n
If there is a 'timeout' event listener on the Server object, then it\nwill be called with the timed-out socket as an argument.
\n
By default, the Server's timeout value is 2 minutes, and sockets are\ndestroyed automatically if they time out.  However, if you assign a\ncallback to the Server's 'timeout' event, then you are responsible\nfor handling socket timeouts.
\n
Returns server.
\n"
            }
          ],
          "properties": [
            {
              "textRaw": "server.maxHeadersCount",
              "name": "maxHeadersCount",
              "meta": {
                "added": [
                  "v0.7.0"
                ]
              },
              "desc": "
Limits maximum incoming headers count, equal to 1000 by default. If set to 0 -\nno limit will be applied.
\n"
            },
            {
              "textRaw": "`timeout` {Number} Default = 120000 (2 minutes) ",
              "type": "Number",
              "name": "timeout",
              "meta": {
                "added": [
                  "v0.9.12"
                ]
              },
              "desc": "
The number of milliseconds of inactivity before a socket is presumed\nto have timed out.
\n
Note that the socket timeout logic is set up on connection, so\nchanging this value only affects new connections to the server, not\nany existing connections.
\n
Set to 0 to disable any kind of automatic timeout behavior on incoming\nconnections.
\n",
              "shortDesc": "Default = 120000 (2 minutes)"
            }
          ]
        },
        {
          "textRaw": "Class: http.ServerResponse",
          "type": "class",
          "name": "http.ServerResponse",
          "meta": {
            "added": [
              "v0.1.17"
            ]
          },
          "desc": "
This object is created internally by a HTTP server--not by the user. It is\npassed as the second parameter to the 'request' event.
\n
The response implements, but does not inherit from, the Writable Stream\ninterface. This is an EventEmitter with the following events:
\n",
          "events": [
            {
              "textRaw": "Event: 'close'",
              "type": "event",
              "name": "close",
              "meta": {
                "added": [
                  "v0.6.7"
                ]
              },
              "desc": "
function () { }
\n
Indicates that the underlying connection was terminated before\nresponse.end() was called or able to flush.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'finish'",
              "type": "event",
              "name": "finish",
              "meta": {
                "added": [
                  "v0.3.6"
                ]
              },
              "desc": "
function () { }
\n
Emitted when the response has been sent. More specifically, this event is\nemitted when the last segment of the response headers and body have been\nhanded off to the operating system for transmission over the network. It\ndoes not imply that the client has received anything yet.
\n
After this event, no more events will be emitted on the response object.
\n",
              "params": []
            }
          ],
          "methods": [
            {
              "textRaw": "response.addTrailers(headers)",
              "type": "method",
              "name": "addTrailers",
              "meta": {
                "added": [
                  "v0.3.0"
                ]
              },
              "desc": "
This method adds HTTP trailing headers (a header but at the end of the\nmessage) to the response.
\n
Trailers will only be emitted if chunked encoding is used for the\nresponse; if it is not (e.g. if the request was HTTP/1.0), they will\nbe silently discarded.
\n
Note that HTTP requires the Trailer header to be sent if you intend to\nemit trailers, with a list of the header fields in its value. E.g.,
\n
response.writeHead(200, { 'Content-Type': 'text/plain',\n                          'Trailer': 'Content-MD5' });\nresponse.write(fileData);\nresponse.addTrailers({'Content-MD5': '7895bf4b8828b55ceaf47747b4bca667'});\nresponse.end();\n
\n
Attempting to set a header field name or value that contains invalid characters\nwill result in a TypeError being thrown.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "headers"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "response.end([data][, encoding][, callback])",
              "type": "method",
              "name": "end",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
This method signals to the server that all of the response headers and body\nhave been sent; that server should consider this message complete.\nThe method, response.end(), MUST be called on each response.
\n
If data is specified, it is equivalent to calling\nresponse.write(data, encoding) followed by response.end(callback).
\n
If callback is specified, it will be called when the response stream\nis finished.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "data",
                      "optional": true
                    },
                    {
                      "name": "encoding",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "response.getHeader(name)",
              "type": "method",
              "name": "getHeader",
              "meta": {
                "added": [
                  "v0.4.0"
                ]
              },
              "desc": "
Reads out a header that's already been queued but not sent to the client.  Note\nthat the name is case insensitive.  This can only be called before headers get\nimplicitly flushed.
\n
Example:
\n
var contentType = response.getHeader('content-type');\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "name"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "response.removeHeader(name)",
              "type": "method",
              "name": "removeHeader",
              "meta": {
                "added": [
                  "v0.4.0"
                ]
              },
              "desc": "
Removes a header that's queued for implicit sending.
\n
Example:
\n
response.removeHeader('Content-Encoding');\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "name"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "response.setHeader(name, value)",
              "type": "method",
              "name": "setHeader",
              "meta": {
                "added": [
                  "v0.4.0"
                ]
              },
              "desc": "
Sets a single header value for implicit headers.  If this header already exists\nin the to-be-sent headers, its value will be replaced.  Use an array of strings\nhere if you need to send multiple headers with the same name.
\n
Example:
\n
response.setHeader('Content-Type', 'text/html');\n
\n
or
\n
response.setHeader('Set-Cookie', ['type=ninja', 'language=javascript']);\n
\n
Attempting to set a header field name or value that contains invalid characters\nwill result in a TypeError being thrown.
\n
When headers have been set with response.setHeader(), they will be merged with\nany headers passed to response.writeHead(), with the headers passed to\nresponse.writeHead() given precedence.
\n
// returns content-type = text/plain\nconst server = http.createServer((req,res) => {\n  res.setHeader('Content-Type', 'text/html');\n  res.setHeader('X-Foo', 'bar');\n  res.writeHead(200, {'Content-Type': 'text/plain'});\n  res.end('ok');\n});\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "name"
                    },
                    {
                      "name": "value"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "response.setTimeout(msecs, callback)",
              "type": "method",
              "name": "setTimeout",
              "meta": {
                "added": [
                  "v0.9.12"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`msecs` {Number} ",
                      "name": "msecs",
                      "type": "Number"
                    },
                    {
                      "textRaw": "`callback` {Function} ",
                      "name": "callback",
                      "type": "Function"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "msecs"
                    },
                    {
                      "name": "callback"
                    }
                  ]
                }
              ],
              "desc": "
Sets the Socket's timeout value to msecs.  If a callback is\nprovided, then it is added as a listener on the 'timeout' event on\nthe response object.
\n
If no 'timeout' listener is added to the request, the response, or\nthe server, then sockets are destroyed when they time out.  If you\nassign a handler on the request, the response, or the server's\n'timeout' events, then it is your responsibility to handle timed out\nsockets.
\n
Returns response.
\n"
            },
            {
              "textRaw": "response.write(chunk[, encoding][, callback])",
              "type": "method",
              "name": "write",
              "meta": {
                "added": [
                  "v0.1.29"
                ]
              },
              "desc": "
If this method is called and response.writeHead() has not been called,\nit will switch to implicit header mode and flush the implicit headers.
\n
This sends a chunk of the response body. This method may\nbe called multiple times to provide successive parts of the body.
\n
chunk can be a string or a buffer. If chunk is a string,\nthe second parameter specifies how to encode it into a byte stream.\nBy default the encoding is 'utf8'. callback will be called when this chunk\nof data is flushed.
\n
Note: This is the raw HTTP body and has nothing to do with\nhigher-level multi-part body encodings that may be used.
\n
The first time response.write() is called, it will send the buffered\nheader information and the first body to the client. The second time\nresponse.write() is called, Node.js assumes you're going to be streaming\ndata, and sends that separately. That is, the response is buffered up to the\nfirst chunk of body.
\n
Returns true if the entire data was flushed successfully to the kernel\nbuffer. Returns false if all or part of the data was queued in user memory.\n'drain' will be emitted when the buffer is free again.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "chunk"
                    },
                    {
                      "name": "encoding",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "response.writeContinue()",
              "type": "method",
              "name": "writeContinue",
              "meta": {
                "added": [
                  "v0.3.0"
                ]
              },
              "desc": "
Sends a HTTP/1.1 100 Continue message to the client, indicating that\nthe request body should be sent. See the 'checkContinue' event on Server.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "response.writeHead(statusCode[, statusMessage][, headers])",
              "type": "method",
              "name": "writeHead",
              "meta": {
                "added": [
                  "v0.1.30"
                ]
              },
              "desc": "
Sends a response header to the request. The status code is a 3-digit HTTP\nstatus code, like 404. The last argument, headers, are the response headers.\nOptionally one can give a human-readable statusMessage as the second\nargument.
\n
Example:
\n
var body = 'hello world';\nresponse.writeHead(200, {\n  'Content-Length': Buffer.byteLength(body),\n  'Content-Type': 'text/plain' });\n
\n
This method must only be called once on a message and it must\nbe called before response.end() is called.
\n
If you call response.write() or response.end() before calling this,\nthe implicit/mutable headers will be calculated and call this function for you.
\n
When headers have been set with response.setHeader(), they will be merged with\nany headers passed to response.writeHead(), with the headers passed to\nresponse.writeHead() given precedence.
\n
// returns content-type = text/plain\nconst server = http.createServer((req,res) => {\n  res.setHeader('Content-Type', 'text/html');\n  res.setHeader('X-Foo', 'bar');\n  res.writeHead(200, {'Content-Type': 'text/plain'});\n  res.end('ok');\n});\n
\n
Note that Content-Length is given in bytes not characters. The above example\nworks because the string 'hello world' contains only single byte characters.\nIf the body contains higher coded characters then Buffer.byteLength()\nshould be used to determine the number of bytes in a given encoding.\nAnd Node.js does not check whether Content-Length and the length of the body\nwhich has been transmitted are equal or not.
\n
Attempting to set a header field name or value that contains invalid characters\nwill result in a TypeError being thrown.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "statusCode"
                    },
                    {
                      "name": "statusMessage",
                      "optional": true
                    },
                    {
                      "name": "headers",
                      "optional": true
                    }
                  ]
                }
              ]
            }
          ],
          "properties": [
            {
              "textRaw": "response.finished",
              "name": "finished",
              "meta": {
                "added": [
                  "v0.0.2"
                ]
              },
              "desc": "
Boolean value that indicates whether the response has completed. Starts\nas false. After response.end() executes, the value will be true.
\n"
            },
            {
              "textRaw": "response.headersSent",
              "name": "headersSent",
              "meta": {
                "added": [
                  "v0.9.3"
                ]
              },
              "desc": "
Boolean (read-only). True if headers were sent, false otherwise.
\n"
            },
            {
              "textRaw": "response.sendDate",
              "name": "sendDate",
              "meta": {
                "added": [
                  "v0.7.5"
                ]
              },
              "desc": "
When true, the Date header will be automatically generated and sent in\nthe response if it is not already present in the headers. Defaults to true.
\n
This should only be disabled for testing; HTTP requires the Date header\nin responses.
\n"
            },
            {
              "textRaw": "response.statusCode",
              "name": "statusCode",
              "meta": {
                "added": [
                  "v0.4.0"
                ]
              },
              "desc": "
When using implicit headers (not calling response.writeHead() explicitly),\nthis property controls the status code that will be sent to the client when\nthe headers get flushed.
\n
Example:
\n
response.statusCode = 404;\n
\n
After response header was sent to the client, this property indicates the\nstatus code which was sent out.
\n"
            },
            {
              "textRaw": "response.statusMessage",
              "name": "statusMessage",
              "meta": {
                "added": [
                  "v0.11.8"
                ]
              },
              "desc": "
When using implicit headers (not calling response.writeHead() explicitly), this property\ncontrols the status message that will be sent to the client when the headers get\nflushed. If this is left as undefined then the standard message for the status\ncode will be used.
\n
Example:
\n
response.statusMessage = 'Not found';\n
\n
After response header was sent to the client, this property indicates the\nstatus message which was sent out.
\n"
            }
          ]
        },
        {
          "textRaw": "Class: http.IncomingMessage",
          "type": "class",
          "name": "http.IncomingMessage",
          "meta": {
            "added": [
              "v0.1.17"
            ]
          },
          "desc": "
An IncomingMessage object is created by http.Server or\nhttp.ClientRequest and passed as the first argument to the 'request'\nand 'response' event respectively. It may be used to access response status,\nheaders and data.
\n
It implements the Readable Stream interface, as well as the\nfollowing additional events, methods, and properties.
\n",
          "events": [
            {
              "textRaw": "Event: 'aborted'",
              "type": "event",
              "name": "aborted",
              "meta": {
                "added": [
                  "v0.3.8"
                ]
              },
              "desc": "
function () { }
\n
Emitted when the request has been aborted by the client and the network\nsocket has closed.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'close'",
              "type": "event",
              "name": "close",
              "meta": {
                "added": [
                  "v0.4.2"
                ]
              },
              "desc": "
function () { }
\n
Indicates that the underlying connection was closed.\nJust like 'end', this event occurs only once per response.
\n",
              "params": []
            }
          ],
          "methods": [
            {
              "textRaw": "message.destroy([error])",
              "type": "method",
              "name": "destroy",
              "meta": {
                "added": [
                  "v0.3.0"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`error` {Error} ",
                      "name": "error",
                      "type": "Error",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "error",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Calls destroy() on the socket that received the IncomingMessage. If error\nis provided, an 'error' event is emitted and error is passed as an argument\nto any listeners on the event.
\n"
            },
            {
              "textRaw": "message.setTimeout(msecs, callback)",
              "type": "method",
              "name": "setTimeout",
              "meta": {
                "added": [
                  "v0.5.9"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`msecs` {Number} ",
                      "name": "msecs",
                      "type": "Number"
                    },
                    {
                      "textRaw": "`callback` {Function} ",
                      "name": "callback",
                      "type": "Function"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "msecs"
                    },
                    {
                      "name": "callback"
                    }
                  ]
                }
              ],
              "desc": "
Calls message.connection.setTimeout(msecs, callback).
\n
Returns message.
\n"
            }
          ],
          "properties": [
            {
              "textRaw": "message.headers",
              "name": "headers",
              "meta": {
                "added": [
                  "v0.1.5"
                ]
              },
              "desc": "
The request/response headers object.
\n
Key-value pairs of header names and values. Header names are lower-cased.\nExample:
\n
// Prints something like:\n//\n// { 'user-agent': 'curl/7.22.0',\n//   host: '127.0.0.1:8000',\n//   accept: '*/*' }\nconsole.log(request.headers);\n
\n
Duplicates in raw headers are handled in the following ways, depending on the\nheader name:
\n
    \n
  • Duplicates of age, authorization, content-length, content-type,\netag, expires, from, host, if-modified-since, if-unmodified-since,\nlast-modified, location, max-forwards, proxy-authorization, referer,\nretry-after, or user-agent are discarded.
    • \n
  • set-cookie is always an array. Duplicates are added to the array.
    • \n
  • For all other headers, the values are joined together with ', '.
    • \n
\n"
            },
            {
              "textRaw": "message.httpVersion",
              "name": "httpVersion",
              "meta": {
                "added": [
                  "v0.1.1"
                ]
              },
              "desc": "
In case of server request, the HTTP version sent by the client. In the case of\nclient response, the HTTP version of the connected-to server.\nProbably either '1.1' or '1.0'.
\n
Also message.httpVersionMajor is the first integer and\nmessage.httpVersionMinor is the second.
\n"
            },
            {
              "textRaw": "message.method",
              "name": "method",
              "meta": {
                "added": [
                  "v0.1.1"
                ]
              },
              "desc": "
Only valid for request obtained from http.Server.
\n
The request method as a string. Read only. Example:\n'GET', 'DELETE'.
\n"
            },
            {
              "textRaw": "message.rawHeaders",
              "name": "rawHeaders",
              "meta": {
                "added": [
                  "v0.11.6"
                ]
              },
              "desc": "
The raw request/response headers list exactly as they were received.
\n
Note that the keys and values are in the same list.  It is not a\nlist of tuples.  So, the even-numbered offsets are key values, and the\nodd-numbered offsets are the associated values.
\n
Header names are not lowercased, and duplicates are not merged.
\n
// Prints something like:\n//\n// [ 'user-agent',\n//   'this is invalid because there can be only one',\n//   'User-Agent',\n//   'curl/7.22.0',\n//   'Host',\n//   '127.0.0.1:8000',\n//   'ACCEPT',\n//   '*/*' ]\nconsole.log(request.rawHeaders);\n
\n"
            },
            {
              "textRaw": "message.rawTrailers",
              "name": "rawTrailers",
              "meta": {
                "added": [
                  "v0.11.6"
                ]
              },
              "desc": "
The raw request/response trailer keys and values exactly as they were\nreceived.  Only populated at the 'end' event.
\n"
            },
            {
              "textRaw": "message.statusCode",
              "name": "statusCode",
              "meta": {
                "added": [
                  "v0.1.1"
                ]
              },
              "desc": "
Only valid for response obtained from http.ClientRequest.
\n
The 3-digit HTTP response status code. E.G. 404.
\n"
            },
            {
              "textRaw": "message.statusMessage",
              "name": "statusMessage",
              "meta": {
                "added": [
                  "v0.11.10"
                ]
              },
              "desc": "
Only valid for response obtained from http.ClientRequest.
\n
The HTTP response status message (reason phrase). E.G. OK or Internal Server Error.
\n"
            },
            {
              "textRaw": "message.socket",
              "name": "socket",
              "meta": {
                "added": [
                  "v0.3.0"
                ]
              },
              "desc": "
The net.Socket object associated with the connection.
\n
With HTTPS support, use request.socket.getPeerCertificate() to obtain the\nclient's authentication details.
\n"
            },
            {
              "textRaw": "message.trailers",
              "name": "trailers",
              "meta": {
                "added": [
                  "v0.3.0"
                ]
              },
              "desc": "
The request/response trailers object. Only populated at the 'end' event.
\n"
            },
            {
              "textRaw": "message.url",
              "name": "url",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Only valid for request obtained from http.Server.
\n
Request URL string. This contains only the URL that is\npresent in the actual HTTP request. If the request is:
\n
GET /status?name=ryan HTTP/1.1\\r\\n\nAccept: text/plain\\r\\n\n\\r\\n\n
Then request.url will be:
\n
'/status?name=ryan'\n
If you would like to parse the URL into its parts, you can use\nrequire('url').parse(request.url).  Example:
\n
$ node\n> require('url').parse('/status?name=ryan')\n{\n  href: '/status?name=ryan',\n  search: '?name=ryan',\n  query: 'name=ryan',\n  pathname: '/status'\n}\n
If you would like to extract the parameters from the query string,\nyou can use the require('querystring').parse function, or pass\ntrue as the second argument to require('url').parse.  Example:
\n
$ node\n> require('url').parse('/status?name=ryan', true)\n{\n  href: '/status?name=ryan',\n  search: '?name=ryan',\n  query: {name: 'ryan'},\n  pathname: '/status'\n}\n
"
            }
          ]
        }
      ],
      "properties": [
        {
          "textRaw": "`METHODS` {Array} ",
          "type": "Array",
          "name": "METHODS",
          "meta": {
            "added": [
              "v0.11.8"
            ]
          },
          "desc": "
A list of the HTTP methods that are supported by the parser.
\n"
        },
        {
          "textRaw": "`STATUS_CODES` {Object} ",
          "type": "Object",
          "name": "STATUS_CODES",
          "meta": {
            "added": [
              "v0.1.22"
            ]
          },
          "desc": "
A collection of all the standard HTTP response status codes, and the\nshort description of each.  For example, http.STATUS_CODES[404] === 'Not\nFound'.
\n"
        },
        {
          "textRaw": "http.globalAgent",
          "name": "globalAgent",
          "meta": {
            "added": [
              "v0.5.9"
            ]
          },
          "desc": "
Global instance of Agent which is used as the default for all http client\nrequests.
\n"
        }
      ],
      "methods": [
        {
          "textRaw": "http.createClient([port][, host])",
          "type": "method",
          "name": "createClient",
          "meta": {
            "added": [
              "v0.1.13"
            ],
            "deprecated": [
              "v0.3.6"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated: Use [`http.request()`][] instead.",
          "desc": "
Constructs a new HTTP client. port and host refer to the server to be\nconnected to.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "port",
                  "optional": true
                },
                {
                  "name": "host",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "http.createServer([requestListener])",
          "type": "method",
          "name": "createServer",
          "meta": {
            "added": [
              "v0.1.13"
            ]
          },
          "desc": "
Returns a new instance of http.Server.
\n
The requestListener is a function which is automatically\nadded to the 'request' event.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "requestListener",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "http.get(options[, callback])",
          "type": "method",
          "name": "get",
          "meta": {
            "added": [
              "v0.3.6"
            ]
          },
          "desc": "
Since most requests are GET requests without bodies, Node.js provides this\nconvenience method. The only difference between this method and http.request()\nis that it sets the method to GET and calls req.end() automatically.
\n
Example:
\n
http.get('http://www.google.com/index.html', (res) => {\n  console.log(`Got response: ${res.statusCode}`);\n  // consume response body\n  res.resume();\n}).on('error', (e) => {\n  console.log(`Got error: ${e.message}`);\n});\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "options"
                },
                {
                  "name": "callback",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "http.request(options[, callback])",
          "type": "method",
          "name": "request",
          "meta": {
            "added": [
              "v0.3.6"
            ]
          },
          "desc": "
Node.js maintains several connections per server to make HTTP requests.\nThis function allows one to transparently issue requests.
\n
options can be an object or a string. If options is a string, it is\nautomatically parsed with url.parse().
\n
Options:
\n
    \n
  • protocol: Protocol to use. Defaults to 'http:'.
    • \n
  • host: A domain name or IP address of the server to issue the request to.\nDefaults to 'localhost'.
    • \n
  • hostname: Alias for host. To support url.parse() hostname is\npreferred over host.
    • \n
  • family: IP address family to use when resolving host and hostname.\nValid values are 4 or 6. When unspecified, both IP v4 and v6 will be\nused.
    • \n
  • port: Port of remote server. Defaults to 80.
    • \n
  • localAddress: Local interface to bind for network connections.
    • \n
  • socketPath: Unix Domain Socket (use one of host:port or socketPath).
    • \n
  • method: A string specifying the HTTP request method. Defaults to 'GET'.
    • \n
  • path: Request path. Defaults to '/'. Should include query string if any.\nE.G. '/index.html?page=12'. An exception is thrown when the request path\ncontains illegal characters. Currently, only spaces are rejected but that\nmay change in the future.
    • \n
  • headers: An object containing request headers.
    • \n
  • auth: Basic authentication i.e. 'user:password' to compute an\nAuthorization header.
    • \n
  • agent: Controls Agent behavior. When an Agent is used request will\ndefault to Connection: keep-alive. Possible values:
      \n
    • undefined (default): use http.globalAgent for this host and port.
      • \n
    • Agent object: explicitly use the passed in Agent.
      • \n
    • false: opts out of connection pooling with an Agent, defaults request to\nConnection: close.
      • \n
    \n
    • \n
\n
The optional callback parameter will be added as a one time listener for\nthe 'response' event.
\n
http.request() returns an instance of the http.ClientRequest\nclass. The ClientRequest instance is a writable stream. If one needs to\nupload a file with a POST request, then write to the ClientRequest object.
\n
Example:
\n
var postData = querystring.stringify({\n  'msg' : 'Hello World!'\n});\n\nvar options = {\n  hostname: 'www.google.com',\n  port: 80,\n  path: '/upload',\n  method: 'POST',\n  headers: {\n    'Content-Type': 'application/x-www-form-urlencoded',\n    'Content-Length': Buffer.byteLength(postData)\n  }\n};\n\nvar req = http.request(options, (res) => {\n  console.log(`STATUS: ${res.statusCode}`);\n  console.log(`HEADERS: ${JSON.stringify(res.headers)}`);\n  res.setEncoding('utf8');\n  res.on('data', (chunk) => {\n    console.log(`BODY: ${chunk}`);\n  });\n  res.on('end', () => {\n    console.log('No more data in response.')\n  })\n});\n\nreq.on('error', (e) => {\n  console.log(`problem with request: ${e.message}`);\n});\n\n// write data to request body\nreq.write(postData);\nreq.end();\n
\n
Note that in the example req.end() was called. With http.request() one\nmust always call req.end() to signify that you're done with the request -\neven if there is no data being written to the request body.
\n
If any error is encountered during the request (be that with DNS resolution,\nTCP level errors, or actual HTTP parse errors) an 'error' event is emitted\non the returned request object. As with all 'error' events, if no listeners\nare registered the error will be thrown.
\n
There are a few special headers that should be noted.
\n
    \n
  • Sending a 'Connection: keep-alive' will notify Node.js that the connection to\nthe server should be persisted until the next request.
    \n
    • \n
  • Sending a 'Content-Length' header will disable the default chunked encoding.
    \n
    • \n
  • Sending an 'Expect' header will immediately send the request headers.\nUsually, when sending 'Expect: 100-continue', you should both set a timeout\nand listen for the 'continue' event. See RFC2616 Section 8.2.3 for more\ninformation.
    \n
    • \n
  • Sending an Authorization header will override using the auth option\nto compute basic authentication.
    \n
    • \n
\n\n\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "options"
                },
                {
                  "name": "callback",
                  "optional": true
                }
              ]
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "HTTP"
    },
    {
      "textRaw": "HTTPS",
      "name": "https",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
HTTPS is the HTTP protocol over TLS/SSL. In Node.js this is implemented as a\nseparate module.
\n",
      "classes": [
        {
          "textRaw": "Class: https.Agent",
          "type": "class",
          "name": "https.Agent",
          "meta": {
            "added": [
              "v0.4.5"
            ]
          },
          "desc": "
An Agent object for HTTPS similar to http.Agent.  See https.request()\nfor more information.
\n"
        },
        {
          "textRaw": "Class: https.Server",
          "type": "class",
          "name": "https.Server",
          "meta": {
            "added": [
              "v0.3.4"
            ]
          },
          "desc": "
This class is a subclass of tls.Server and emits events same as\nhttp.Server. See http.Server for more information.
\n",
          "methods": [
            {
              "textRaw": "server.setTimeout(msecs, callback)",
              "type": "method",
              "name": "setTimeout",
              "meta": {
                "added": [
                  "v0.11.2"
                ]
              },
              "desc": "
See http.Server#setTimeout().
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "msecs"
                    },
                    {
                      "name": "callback"
                    }
                  ]
                }
              ]
            }
          ],
          "properties": [
            {
              "textRaw": "server.timeout",
              "name": "timeout",
              "meta": {
                "added": [
                  "v0.11.2"
                ]
              },
              "desc": "
See http.Server#timeout.
\n"
            }
          ]
        }
      ],
      "methods": [
        {
          "textRaw": "https.createServer(options[, requestListener])",
          "type": "method",
          "name": "createServer",
          "meta": {
            "added": [
              "v0.3.4"
            ]
          },
          "desc": "
Returns a new HTTPS web server object. The options is similar to\ntls.createServer().  The requestListener is a function which is\nautomatically added to the 'request' event.
\n
Example:
\n
// curl -k https://localhost:8000/\nconst https = require('https');\nconst fs = require('fs');\n\nconst options = {\n  key: fs.readFileSync('test/fixtures/keys/agent2-key.pem'),\n  cert: fs.readFileSync('test/fixtures/keys/agent2-cert.pem')\n};\n\nhttps.createServer(options, (req, res) => {\n  res.writeHead(200);\n  res.end('hello world\\n');\n}).listen(8000);\n
\n
Or
\n
const https = require('https');\nconst fs = require('fs');\n\nconst options = {\n  pfx: fs.readFileSync('server.pfx')\n};\n\nhttps.createServer(options, (req, res) => {\n  res.writeHead(200);\n  res.end('hello world\\n');\n}).listen(8000);\n
\n",
          "methods": [
            {
              "textRaw": "server.close([callback])",
              "type": "method",
              "name": "close",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
See http.close() for details.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "server.listen(path[, callback])",
              "type": "method",
              "name": "listen",
              "desc": "
See http.listen() for details.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "port"
                    },
                    {
                      "name": "host",
                      "optional": true
                    },
                    {
                      "name": "backlog",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "path"
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "server.listen(port[, host][, backlog][, callback])",
              "type": "method",
              "name": "listen",
              "desc": "
See http.listen() for details.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "port"
                    },
                    {
                      "name": "host",
                      "optional": true
                    },
                    {
                      "name": "backlog",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            }
          ],
          "signatures": [
            {
              "params": [
                {
                  "name": "options"
                },
                {
                  "name": "requestListener",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "https.get(options, callback)",
          "type": "method",
          "name": "get",
          "meta": {
            "added": [
              "v0.3.6"
            ]
          },
          "desc": "
Like http.get() but for HTTPS.
\n
options can be an object or a string. If options is a string, it is\nautomatically parsed with url.parse().
\n
Example:
\n
const https = require('https');\n\nhttps.get('https://encrypted.google.com/', (res) => {\n  console.log('statusCode:', res.statusCode);\n  console.log('headers:', res.headers);\n\n  res.on('data', (d) => {\n    process.stdout.write(d);\n  });\n\n}).on('error', (e) => {\n  console.error(e);\n});\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "options"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "https.request(options, callback)",
          "type": "method",
          "name": "request",
          "meta": {
            "added": [
              "v0.3.6"
            ]
          },
          "desc": "
Makes a request to a secure web server.
\n
options can be an object or a string. If options is a string, it is\nautomatically parsed with url.parse().
\n
All options from http.request() are valid.
\n
Example:
\n
const https = require('https');\n\nvar options = {\n  hostname: 'encrypted.google.com',\n  port: 443,\n  path: '/',\n  method: 'GET'\n};\n\nvar req = https.request(options, (res) => {\n  console.log('statusCode:', res.statusCode);\n  console.log('headers:', res.headers);\n\n  res.on('data', (d) => {\n    process.stdout.write(d);\n  });\n});\n\nreq.on('error', (e) => {\n  console.error(e);\n});\nreq.end();\n
\n
The options argument has the following options
\n
    \n
  • host: A domain name or IP address of the server to issue the request to.\nDefaults to 'localhost'.
    • \n
  • hostname: Alias for host. To support url.parse() hostname is\npreferred over host.
    • \n
  • family: IP address family to use when resolving host and hostname.\nValid values are 4 or 6. When unspecified, both IP v4 and v6 will be\nused.
    • \n
  • port: Port of remote server. Defaults to 443.
    • \n
  • localAddress: Local interface to bind for network connections.
    • \n
  • socketPath: Unix Domain Socket (use one of host:port or socketPath).
    • \n
  • method: A string specifying the HTTP request method. Defaults to 'GET'.
    • \n
  • path: Request path. Defaults to '/'. Should include query string if any.\nE.G. '/index.html?page=12'. An exception is thrown when the request path\ncontains illegal characters. Currently, only spaces are rejected but that\nmay change in the future.
    • \n
  • headers: An object containing request headers.
    • \n
  • auth: Basic authentication i.e. 'user:password' to compute an\nAuthorization header.
    • \n
  • agent: Controls Agent behavior. When an Agent is used request will\ndefault to Connection: keep-alive. Possible values:
      \n
    • undefined (default): use globalAgent for this host and port.
      • \n
    • Agent object: explicitly use the passed in Agent.
      • \n
    • false: opts out of connection pooling with an Agent, defaults request to\nConnection: close.
      • \n
    \n
    • \n
\n
The following options from tls.connect() can also be specified:
\n
    \n
  • pfx: Certificate, Private key and CA certificates to use for SSL. Default null.
    • \n
  • key: Private key to use for SSL. Default null.
    • \n
  • passphrase: A string of passphrase for the private key or pfx. Default null.
    • \n
  • cert: Public x509 certificate to use. Default null.
    • \n
  • ca: A string, Buffer or array of strings or Buffers of trusted\ncertificates in PEM format. If this is omitted several well known "root"\nCAs will be used, like VeriSign. These are used to authorize connections.
    • \n
  • ciphers: A string describing the ciphers to use or exclude. Consult\nhttps://www.openssl.org/docs/apps/ciphers.html#CIPHER-LIST-FORMAT for\ndetails on the format.
    • \n
  • rejectUnauthorized: If true, the server certificate is verified against\nthe list of supplied CAs. An 'error' event is emitted if verification\nfails. Verification happens at the connection level, before the HTTP\nrequest is sent. Default true.
    • \n
  • secureProtocol: The SSL method to use, e.g. SSLv3_method to force\nSSL version 3. The possible values depend on your installation of\nOpenSSL and are defined in the constant SSL_METHODS.
    • \n
  • servername: Servername for SNI (Server Name Indication) TLS extension.
    • \n
\n
In order to specify these options, use a custom Agent.
\n
Example:
\n
var options = {\n  hostname: 'encrypted.google.com',\n  port: 443,\n  path: '/',\n  method: 'GET',\n  key: fs.readFileSync('test/fixtures/keys/agent2-key.pem'),\n  cert: fs.readFileSync('test/fixtures/keys/agent2-cert.pem')\n};\noptions.agent = new https.Agent(options);\n\nvar req = https.request(options, (res) => {\n  ...\n}\n
\n
Alternatively, opt out of connection pooling by not using an Agent.
\n
Example:
\n
var options = {\n  hostname: 'encrypted.google.com',\n  port: 443,\n  path: '/',\n  method: 'GET',\n  key: fs.readFileSync('test/fixtures/keys/agent2-key.pem'),\n  cert: fs.readFileSync('test/fixtures/keys/agent2-cert.pem'),\n  agent: false\n};\n\nvar req = https.request(options, (res) => {\n  ...\n}\n
\n\n\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "options"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        }
      ],
      "properties": [
        {
          "textRaw": "https.globalAgent",
          "name": "globalAgent",
          "meta": {
            "added": [
              "v0.5.9"
            ]
          },
          "desc": "
Global instance of https.Agent for all HTTPS client requests.
\n"
        }
      ],
      "type": "module",
      "displayName": "HTTPS"
    },
    {
      "textRaw": "Modules",
      "name": "module",
      "stability": 3,
      "stabilityText": "Locked",
      "desc": "
Node.js has a simple module loading system.  In Node.js, files and modules\nare in one-to-one correspondence (each file is treated as a separate module).
\n
As an example, consider a file named foo.js:
\n
const circle = require('./circle.js');\nconsole.log(`The area of a circle of radius 4 is ${circle.area(4)}`);\n
\n
On the first line, foo.js loads the module circle.js that is in the same\ndirectory as foo.js.
\n
Here are the contents of circle.js:
\n
const PI = Math.PI;\n\nexports.area = (r) => PI * r * r;\n\nexports.circumference = (r) => 2 * PI * r;\n
\n
The module circle.js has exported the functions area() and\ncircumference().  To add functions and objects to the root of your module,\nyou can add them to the special exports object.
\n
Variables local to the module will be private, because the module is wrapped\nin a function by Node.js (see module wrapper).\nIn this example, the variable PI is private to circle.js.
\n
If you want the root of your module's export to be a function (such as a\nconstructor) or if you want to export a complete object in one assignment\ninstead of building it one property at a time, assign it to module.exports\ninstead of exports.
\n
Below, bar.js makes use of the square module, which exports a constructor:
\n
const square = require('./square.js');\nvar mySquare = square(2);\nconsole.log(`The area of my square is ${mySquare.area()}`);\n
\n
The square module is defined in square.js:
\n
// assigning to exports will not modify module, must use module.exports\nmodule.exports = (width) => {\n  return {\n    area: () => width * width\n  };\n}\n
\n
The module system is implemented in the require("module") module.
\n",
      "miscs": [
        {
          "textRaw": "Accessing the main module",
          "name": "Accessing the main module",
          "type": "misc",
          "desc": "
When a file is run directly from Node.js, require.main is set to its\nmodule. That means that you can determine whether a file has been run\ndirectly by testing
\n
require.main === module\n
\n
For a file foo.js, this will be true if run via node foo.js, but\nfalse if run by require('./foo').
\n
Because module provides a filename property (normally equivalent to\n__filename), the entry point of the current application can be obtained\nby checking require.main.filename.
\n"
        },
        {
          "textRaw": "Addenda: Package Manager Tips",
          "name": "Addenda: Package Manager Tips",
          "type": "misc",
          "desc": "
The semantics of Node.js's require() function were designed to be general\nenough to support a number of reasonable directory structures. Package manager\nprograms such as dpkg, rpm, and npm will hopefully find it possible to\nbuild native packages from Node.js modules without modification.
\n
Below we give a suggested directory structure that could work:
\n
Let's say that we wanted to have the folder at\n/usr/lib/node/<some-package>/<some-version> hold the contents of a\nspecific version of a package.
\n
Packages can depend on one another. In order to install package foo, you\nmay have to install a specific version of package bar.  The bar package\nmay itself have dependencies, and in some cases, these dependencies may even\ncollide or form cycles.
\n
Since Node.js looks up the realpath of any modules it loads (that is,\nresolves symlinks), and then looks for their dependencies in the node_modules\nfolders as described here, this\nsituation is very simple to resolve with the following architecture:
\n
    \n
  • /usr/lib/node/foo/1.2.3/ - Contents of the foo package, version 1.2.3.
    • \n
  • /usr/lib/node/bar/4.3.2/ - Contents of the bar package that foo\ndepends on.
    • \n
  • /usr/lib/node/foo/1.2.3/node_modules/bar - Symbolic link to\n/usr/lib/node/bar/4.3.2/.
    • \n
  • /usr/lib/node/bar/4.3.2/node_modules/* - Symbolic links to the packages\nthat bar depends on.
    • \n
\n
Thus, even if a cycle is encountered, or if there are dependency\nconflicts, every module will be able to get a version of its dependency\nthat it can use.
\n
When the code in the foo package does require('bar'), it will get the\nversion that is symlinked into /usr/lib/node/foo/1.2.3/node_modules/bar.\nThen, when the code in the bar package calls require('quux'), it'll get\nthe version that is symlinked into\n/usr/lib/node/bar/4.3.2/node_modules/quux.
\n
Furthermore, to make the module lookup process even more optimal, rather\nthan putting packages directly in /usr/lib/node, we could put them in\n/usr/lib/node_modules/<name>/<version>.  Then Node.js will not bother\nlooking for missing dependencies in /usr/node_modules or /node_modules.
\n
In order to make modules available to the Node.js REPL, it might be useful to\nalso add the /usr/lib/node_modules folder to the $NODE_PATH environment\nvariable.  Since the module lookups using node_modules folders are all\nrelative, and based on the real path of the files making the calls to\nrequire(), the packages themselves can be anywhere.
\n"
        },
        {
          "textRaw": "All Together...",
          "name": "All Together...",
          "type": "misc",
          "desc": "
To get the exact filename that will be loaded when require() is called, use\nthe require.resolve() function.
\n
Putting together all of the above, here is the high-level algorithm\nin pseudocode of what require.resolve does:
\n
require(X) from module at path Y\n1. If X is a core module,\n   a. return the core module\n   b. STOP\n2. If X begins with './' or '/' or '../'\n   a. LOAD_AS_FILE(Y + X)\n   b. LOAD_AS_DIRECTORY(Y + X)\n3. LOAD_NODE_MODULES(X, dirname(Y))\n4. THROW "not found"\n\nLOAD_AS_FILE(X)\n1. If X is a file, load X as JavaScript text.  STOP\n2. If X.js is a file, load X.js as JavaScript text.  STOP\n3. If X.json is a file, parse X.json to a JavaScript Object.  STOP\n4. If X.node is a file, load X.node as binary addon.  STOP\n\nLOAD_AS_DIRECTORY(X)\n1. If X/package.json is a file,\n   a. Parse X/package.json, and look for "main" field.\n   b. let M = X + (json main field)\n   c. LOAD_AS_FILE(M)\n2. If X/index.js is a file, load X/index.js as JavaScript text.  STOP\n3. If X/index.json is a file, parse X/index.json to a JavaScript object. STOP\n4. If X/index.node is a file, load X/index.node as binary addon.  STOP\n\nLOAD_NODE_MODULES(X, START)\n1. let DIRS=NODE_MODULES_PATHS(START)\n2. for each DIR in DIRS:\n   a. LOAD_AS_FILE(DIR/X)\n   b. LOAD_AS_DIRECTORY(DIR/X)\n\nNODE_MODULES_PATHS(START)\n1. let PARTS = path split(START)\n2. let I = count of PARTS - 1\n3. let DIRS = []\n4. while I >= 0,\n   a. if PARTS[I] = "node_modules" CONTINUE\n   b. DIR = path join(PARTS[0 .. I] + "node_modules")\n   c. DIRS = DIRS + DIR\n   d. let I = I - 1\n5. return DIRS\n
"
        },
        {
          "textRaw": "Caching",
          "name": "Caching",
          "type": "misc",
          "desc": "
Modules are cached after the first time they are loaded.  This means\n(among other things) that every call to require('foo') will get\nexactly the same object returned, if it would resolve to the same file.
\n
Multiple calls to require('foo') may not cause the module code to be\nexecuted multiple times.  This is an important feature.  With it,\n"partially done" objects can be returned, thus allowing transitive\ndependencies to be loaded even when they would cause cycles.
\n
If you want to have a module execute code multiple times, then export a\nfunction, and call that function.
\n",
          "miscs": [
            {
              "textRaw": "Module Caching Caveats",
              "name": "Module Caching Caveats",
              "type": "misc",
              "desc": "
Modules are cached based on their resolved filename.  Since modules may\nresolve to a different filename based on the location of the calling\nmodule (loading from node_modules folders), it is not a guarantee\nthat require('foo') will always return the exact same object, if it\nwould resolve to different files.
\n
Additionally, on case-insensitive file systems or operating systems, different\nresolved filenames can point to the same file, but the cache will still treat\nthem as different modules and will reload the file multiple times. For example,\nrequire('./foo') and require('./FOO') return two different objects,\nirrespective of whether or not ./foo and ./FOO are the same file.
\n"
            }
          ]
        },
        {
          "textRaw": "Core Modules",
          "name": "Core Modules",
          "type": "misc",
          "desc": "
Node.js has several modules compiled into the binary.  These modules are\ndescribed in greater detail elsewhere in this documentation.
\n
The core modules are defined within Node.js's source and are located in the\nlib/ folder.
\n
Core modules are always preferentially loaded if their identifier is\npassed to require().  For instance, require('http') will always\nreturn the built in HTTP module, even if there is a file by that name.
\n"
        },
        {
          "textRaw": "Cycles",
          "name": "Cycles",
          "type": "misc",
          "desc": "
When there are circular require() calls, a module might not have finished\nexecuting when it is returned.
\n
Consider this situation:
\n
a.js:
\n
console.log('a starting');\nexports.done = false;\nconst b = require('./b.js');\nconsole.log('in a, b.done = %j', b.done);\nexports.done = true;\nconsole.log('a done');\n
b.js:
\n
console.log('b starting');\nexports.done = false;\nconst a = require('./a.js');\nconsole.log('in b, a.done = %j', a.done);\nexports.done = true;\nconsole.log('b done');\n
main.js:
\n
console.log('main starting');\nconst a = require('./a.js');\nconst b = require('./b.js');\nconsole.log('in main, a.done=%j, b.done=%j', a.done, b.done);\n
When main.js loads a.js, then a.js in turn loads b.js.  At that\npoint, b.js tries to load a.js.  In order to prevent an infinite\nloop, an unfinished copy of the a.js exports object is returned to the\nb.js module.  b.js then finishes loading, and its exports object is\nprovided to the a.js module.
\n
By the time main.js has loaded both modules, they're both finished.\nThe output of this program would thus be:
\n
$ node main.js\nmain starting\na starting\nb starting\nin b, a.done = false\nb done\nin a, b.done = true\na done\nin main, a.done=true, b.done=true\n
If you have cyclic module dependencies in your program, make sure to\nplan accordingly.
\n"
        },
        {
          "textRaw": "File Modules",
          "name": "File Modules",
          "type": "misc",
          "desc": "
If the exact filename is not found, then Node.js will attempt to load the\nrequired filename with the added extensions: .js, .json, and finally\n.node.
\n
.js files are interpreted as JavaScript text files, and .json files are\nparsed as JSON text files. .node files are interpreted as compiled addon\nmodules loaded with dlopen.
\n
A required module prefixed with '/' is an absolute path to the file.  For\nexample, require('/home/marco/foo.js') will load the file at\n/home/marco/foo.js.
\n
A required module prefixed with './' is relative to the file calling\nrequire(). That is, circle.js must be in the same directory as foo.js for\nrequire('./circle') to find it.
\n
Without a leading '/', './', or '../' to indicate a file, the module must\neither be a core module or is loaded from a node_modules folder.
\n
If the given path does not exist, require() will throw an Error with its\ncode property set to 'MODULE_NOT_FOUND'.
\n"
        },
        {
          "textRaw": "Folders as Modules",
          "name": "Folders as Modules",
          "type": "misc",
          "desc": "
It is convenient to organize programs and libraries into self-contained\ndirectories, and then provide a single entry point to that library.\nThere are three ways in which a folder may be passed to require() as\nan argument.
\n
The first is to create a package.json file in the root of the folder,\nwhich specifies a main module.  An example package.json file might\nlook like this:
\n
{ "name" : "some-library",\n  "main" : "./lib/some-library.js" }\n
If this was in a folder at ./some-library, then\nrequire('./some-library') would attempt to load\n./some-library/lib/some-library.js.
\n
This is the extent of Node.js's awareness of package.json files.
\n
Note: If the file specified by the "main" entry of package.json is missing\nand can not be resolved, Node.js will report the entire module as missing with\nthe default error:
\n
Error: Cannot find module 'some-library'\n
If there is no package.json file present in the directory, then Node.js\nwill attempt to load an index.js or index.node file out of that\ndirectory.  For example, if there was no package.json file in the above\nexample, then require('./some-library') would attempt to load:
\n
    \n
  • ./some-library/index.js
    • \n
  • ./some-library/index.node
    • \n
\n"
        },
        {
          "textRaw": "Loading from `node_modules` Folders",
          "name": "Loading from `node_modules` Folders",
          "type": "misc",
          "desc": "
If the module identifier passed to require() is not a\ncore module, and does not begin with '/', '../', or\n'./', then Node.js starts at the parent directory of the current module, and\nadds /node_modules, and attempts to load the module from that location. Node\nwill not append node_modules to a path already ending in node_modules.
\n
If it is not found there, then it moves to the parent directory, and so\non, until the root of the file system is reached.
\n
For example, if the file at '/home/ry/projects/foo.js' called\nrequire('bar.js'), then Node.js would look in the following locations, in\nthis order:
\n
    \n
  • /home/ry/projects/node_modules/bar.js
    • \n
  • /home/ry/node_modules/bar.js
    • \n
  • /home/node_modules/bar.js
    • \n
  • /node_modules/bar.js
    • \n
\n
This allows programs to localize their dependencies, so that they do not\nclash.
\n
You can require specific files or sub modules distributed with a module by\nincluding a path suffix after the module name. For instance\nrequire('example-module/path/to/file') would resolve path/to/file\nrelative to where example-module is located. The suffixed path follows the\nsame module resolution semantics.
\n"
        },
        {
          "textRaw": "Loading from the global folders",
          "name": "Loading from the global folders",
          "type": "misc",
          "desc": "
If the NODE_PATH environment variable is set to a colon-delimited list\nof absolute paths, then Node.js will search those paths for modules if they\nare not found elsewhere.  (Note: On Windows, NODE_PATH is delimited by\nsemicolons instead of colons.)
\n
NODE_PATH was originally created to support loading modules from\nvarying paths before the current module resolution algorithm was frozen.
\n
NODE_PATH is still supported, but is less necessary now that the Node.js\necosystem has settled on a convention for locating dependent modules.\nSometimes deployments that rely on NODE_PATH show surprising behavior\nwhen people are unaware that NODE_PATH must be set.  Sometimes a\nmodule's dependencies change, causing a different version (or even a\ndifferent module) to be loaded as the NODE_PATH is searched.
\n
Additionally, Node.js will search in the following locations:
\n
    \n
  • 1: $HOME/.node_modules
    • \n
  • 2: $HOME/.node_libraries
    • \n
  • 3: $PREFIX/lib/node
    • \n
\n
Where $HOME is the user's home directory, and $PREFIX is Node.js's\nconfigured node_prefix.
\n
These are mostly for historic reasons.  You are highly encouraged\nto place your dependencies locally in node_modules folders.  They\nwill be loaded faster, and more reliably.
\n"
        },
        {
          "textRaw": "The module wrapper",
          "name": "The module wrapper",
          "type": "misc",
          "desc": "
Before a module's code is executed, Node.js will wrap it with a function\nwrapper that looks like the following:
\n
(function (exports, require, module, __filename, __dirname) {\n// Your module code actually lives in here\n});\n
\n
By doing this, Node.js achieves a few things:
\n
    \n
  • It keeps top-level variables (defined with var, const or let) scoped to\nthe module rather than the global object.
    • \n
  • It helps to provide some global-looking variables that are actually specific\nto the module, such as:
      \n
    • The module and exports objects that the implementor can use to export\nvalues from the module.
      • \n
    • The convenience variables __filename and __dirname, containing the\nmodule's absolute filename and directory path.
      • \n
    \n
    • \n
\n"
        }
      ],
      "vars": [
        {
          "textRaw": "The `module` Object",
          "name": "module",
          "meta": {
            "added": [
              "v0.1.16"
            ]
          },
          "type": "var",
          "desc": "
    \n
  • {Object}
    • \n
\n
In each module, the module free variable is a reference to the object\nrepresenting the current module.  For convenience, module.exports is\nalso accessible via the exports module-global. module isn't actually\na global but rather local to each module.
\n",
          "properties": [
            {
              "textRaw": "`children` {Array} ",
              "type": "Array",
              "name": "children",
              "meta": {
                "added": [
                  "v0.1.16"
                ]
              },
              "desc": "
The module objects required by this one.
\n"
            },
            {
              "textRaw": "`exports` {Object} ",
              "type": "Object",
              "name": "exports",
              "meta": {
                "added": [
                  "v0.1.16"
                ]
              },
              "desc": "
The module.exports object is created by the Module system. Sometimes this is\nnot acceptable; many want their module to be an instance of some class. To do\nthis, assign the desired export object to module.exports. Note that assigning\nthe desired object to exports will simply rebind the local exports variable,\nwhich is probably not what you want to do.
\n
For example suppose we were making a module called a.js
\n
const EventEmitter = require('events');\n\nmodule.exports = new EventEmitter();\n\n// Do some work, and after some time emit\n// the 'ready' event from the module itself.\nsetTimeout(() => {\n  module.exports.emit('ready');\n}, 1000);\n
\n
Then in another file we could do
\n
const a = require('./a');\na.on('ready', () => {\n  console.log('module a is ready');\n});\n
\n
Note that assignment to module.exports must be done immediately. It cannot be\ndone in any callbacks.  This does not work:
\n
x.js:
\n
setTimeout(() => {\n  module.exports = { a: 'hello' };\n}, 0);\n
\n
y.js:
\n
const x = require('./x');\nconsole.log(x.a);\n
\n",
              "modules": [
                {
                  "textRaw": "exports shortcut",
                  "name": "exports_shortcut",
                  "meta": {
                    "added": [
                      "v0.1.16"
                    ]
                  },
                  "desc": "
The exports variable is available within a module's file-level scope, and is\nassigned the value of module.exports before the module is evaluated.
\n
It allows a shortcut, so that module.exports.f = ... can be written more\nsuccinctly as exports.f = .... However, be aware that like any variable, if a\nnew value is assigned to exports, it is no longer bound to module.exports:
\n
module.exports.hello = true; // Exported from require of module\nexports = { hello: false };  // Not exported, only available in the module\n
\n
When the module.exports property is being completely replaced by a new\nobject, it is common to also reassign exports, for example:
\n
module.exports = exports = function Constructor() {\n    // ... etc.\n
\n
To illustrate the behavior, imagine this hypothetical implementation of\nrequire(), which is quite similar to what is actually done by require():
\n
function require(...) {\n  var module = { exports: {} };\n  ((module, exports) => {\n    // Your module code here. In this example, define a function.\n    function some_func() {};\n    exports = some_func;\n    // At this point, exports is no longer a shortcut to module.exports, and\n    // this module will still export an empty default object.\n    module.exports = some_func;\n    // At this point, the module will now export some_func, instead of the\n    // default object.\n  })(module, module.exports);\n  return module.exports;\n}\n
\n",
                  "type": "module",
                  "displayName": "exports shortcut"
                }
              ]
            },
            {
              "textRaw": "`filename` {String} ",
              "type": "String",
              "name": "filename",
              "meta": {
                "added": [
                  "v0.1.16"
                ]
              },
              "desc": "
The fully resolved filename to the module.
\n"
            },
            {
              "textRaw": "`id` {String} ",
              "type": "String",
              "name": "id",
              "meta": {
                "added": [
                  "v0.1.16"
                ]
              },
              "desc": "
The identifier for the module.  Typically this is the fully resolved\nfilename.
\n"
            },
            {
              "textRaw": "`loaded` {Boolean} ",
              "type": "Boolean",
              "name": "loaded",
              "meta": {
                "added": [
                  "v0.1.16"
                ]
              },
              "desc": "
Whether or not the module is done loading, or is in the process of\nloading.
\n"
            },
            {
              "textRaw": "`parent` {Object} Module object ",
              "type": "Object",
              "name": "parent",
              "meta": {
                "added": [
                  "v0.1.16"
                ]
              },
              "desc": "
The module that first required this one.
\n",
              "shortDesc": "Module object"
            }
          ],
          "methods": [
            {
              "textRaw": "module.require(id)",
              "type": "method",
              "name": "require",
              "meta": {
                "added": [
                  "v0.5.1"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Object} `module.exports` from the resolved module ",
                    "name": "return",
                    "type": "Object",
                    "desc": "`module.exports` from the resolved module"
                  },
                  "params": [
                    {
                      "textRaw": "`id` {String} ",
                      "name": "id",
                      "type": "String"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "id"
                    }
                  ]
                }
              ],
              "desc": "
The module.require method provides a way to load a module as if\nrequire() was called from the original module.
\n
Note that in order to do this, you must get a reference to the module\nobject.  Since require() returns the module.exports, and the module is\ntypically only available within a specific module's code, it must be\nexplicitly exported in order to be used.
\n\n\n"
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "module"
    },
    {
      "textRaw": "Net",
      "name": "net",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
The net module provides you with an asynchronous network wrapper. It contains\nfunctions for creating both servers and clients (called streams). You can include\nthis module with require('net');.
\n",
      "classes": [
        {
          "textRaw": "Class: net.Server",
          "type": "class",
          "name": "net.Server",
          "meta": {
            "added": [
              "v0.1.90"
            ]
          },
          "desc": "
This class is used to create a TCP or local server.
\n
net.Server is an EventEmitter with the following events:
\n",
          "events": [
            {
              "textRaw": "Event: 'close'",
              "type": "event",
              "name": "close",
              "meta": {
                "added": [
                  "v0.5.0"
                ]
              },
              "desc": "
Emitted when the server closes. Note that if connections exist, this\nevent is not emitted until all connections are ended.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'connection'",
              "type": "event",
              "name": "connection",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "params": [],
              "desc": "
Emitted when a new connection is made. socket is an instance of\nnet.Socket.
\n"
            },
            {
              "textRaw": "Event: 'error'",
              "type": "event",
              "name": "error",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "params": [],
              "desc": "
Emitted when an error occurs. Unlike net.Socket, the 'close'\nevent will not be emitted directly following this event unless\nserver.close() is manually called. See the example in discussion of\nserver.listen().
\n"
            },
            {
              "textRaw": "Event: 'listening'",
              "type": "event",
              "name": "listening",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Emitted when the server has been bound after calling server.listen.
\n",
              "params": []
            }
          ],
          "methods": [
            {
              "textRaw": "server.address()",
              "type": "method",
              "name": "address",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Returns the bound address, the address family name, and port of the server\nas reported by the operating system.\nUseful to find which port was assigned when getting an OS-assigned address.\nReturns an object with port, family, and address properties:\n{ port: 12346, family: 'IPv4', address: '127.0.0.1' }
\n
Example:
\n
var server = net.createServer((socket) => {\n  socket.end('goodbye\\n');\n}).on('error', (err) => {\n  // handle errors here\n  throw err;\n});\n\n// grab a random port.\nserver.listen(() => {\n  console.log('opened server on', server.address());\n});\n
\n
Don't call server.address() until the 'listening' event has been emitted.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "server.close([callback])",
              "type": "method",
              "name": "close",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Stops the server from accepting new connections and keeps existing\nconnections. This function is asynchronous, the server is finally\nclosed when all connections are ended and the server emits a 'close' event.\nThe optional callback will be called once the 'close' event occurs. Unlike\nthat event, it will be called with an Error as its only argument if the server\nwas not open when it was closed.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "server.getConnections(callback)",
              "type": "method",
              "name": "getConnections",
              "meta": {
                "added": [
                  "v0.9.7"
                ]
              },
              "desc": "
Asynchronously get the number of concurrent connections on the server. Works\nwhen sockets were sent to forks.
\n
Callback should take two arguments err and count.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "callback"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "server.listen(handle[, backlog][, callback])",
              "type": "method",
              "name": "listen",
              "meta": {
                "added": [
                  "v0.5.10"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`handle` {Object} ",
                      "name": "handle",
                      "type": "Object"
                    },
                    {
                      "textRaw": "`backlog` {Number} ",
                      "name": "backlog",
                      "type": "Number",
                      "optional": true
                    },
                    {
                      "textRaw": "`callback` {Function} ",
                      "name": "callback",
                      "type": "Function",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "handle"
                    },
                    {
                      "name": "backlog",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
The handle object can be set to either a server or socket (anything\nwith an underlying _handle member), or a {fd: <n>} object.
\n
This will cause the server to accept connections on the specified\nhandle, but it is presumed that the file descriptor or handle has\nalready been bound to a port or domain socket.
\n
Listening on a file descriptor is not supported on Windows.
\n
This function is asynchronous.  When the server has been bound,\n'listening' event will be emitted.\nThe last parameter callback will be added as a listener for the\n'listening' event.
\n
The parameter backlog behaves the same as in\nserver.listen([port][, hostname][, backlog][, callback]).
\n"
            },
            {
              "textRaw": "server.listen(options[, callback])",
              "type": "method",
              "name": "listen",
              "meta": {
                "added": [
                  "v0.11.14"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`options` {Object} - Required. Supports the following properties: ",
                      "options": [
                        {
                          "textRaw": "`port` {Number} - Optional. ",
                          "name": "port",
                          "type": "Number",
                          "desc": "Optional."
                        },
                        {
                          "textRaw": "`host` {String} - Optional. ",
                          "name": "host",
                          "type": "String",
                          "desc": "Optional."
                        },
                        {
                          "textRaw": "`backlog` {Number} - Optional. ",
                          "name": "backlog",
                          "type": "Number",
                          "desc": "Optional."
                        },
                        {
                          "textRaw": "`path` {String} - Optional. ",
                          "name": "path",
                          "type": "String",
                          "desc": "Optional."
                        },
                        {
                          "textRaw": "`exclusive` {Boolean} - Optional. ",
                          "name": "exclusive",
                          "type": "Boolean",
                          "desc": "Optional."
                        }
                      ],
                      "name": "options",
                      "type": "Object",
                      "desc": "Required. Supports the following properties:"
                    },
                    {
                      "textRaw": "`callback` {Function} - Optional. ",
                      "name": "callback",
                      "type": "Function",
                      "desc": "Optional.",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "options"
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
The port, host, and backlog properties of options, as well as the\noptional callback function, behave as they do on a call to\nserver.listen([port][, hostname][, backlog][, callback]).\nAlternatively, the path option can be used to specify a UNIX socket.
\n
If exclusive is false (default), then cluster workers will use the same\nunderlying handle, allowing connection handling duties to be shared. When\nexclusive is true, the handle is not shared, and attempted port sharing\nresults in an error. An example which listens on an exclusive port is\nshown below.
\n
server.listen({\n  host: 'localhost',\n  port: 80,\n  exclusive: true\n});\n
\n"
            },
            {
              "textRaw": "server.listen(path[, backlog][, callback])",
              "type": "method",
              "name": "listen",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`path` {String} ",
                      "name": "path",
                      "type": "String"
                    },
                    {
                      "textRaw": "`backlog` {Number} ",
                      "name": "backlog",
                      "type": "Number",
                      "optional": true
                    },
                    {
                      "textRaw": "`callback` {Function} ",
                      "name": "callback",
                      "type": "Function",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "path"
                    },
                    {
                      "name": "backlog",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Start a local socket server listening for connections on the given path.
\n
This function is asynchronous.  When the server has been bound,\n'listening' event will be emitted.  The last parameter callback\nwill be added as a listener for the 'listening' event.
\n
On UNIX, the local domain is usually known as the UNIX domain. The path is a\nfilesystem path name. It gets truncated to sizeof(sockaddr_un.sun_path)\nbytes, decreased by 1. It varies on different operating system between 91 and\n107 bytes. The typical values are 107 on Linux and 103 on OS X. The path is\nsubject to the same naming conventions and permissions checks as would be done\non file creation, will be visible in the filesystem, and will persist until\nunlinked.
\n
On Windows, the local domain is implemented using a named pipe. The path must\nrefer to an entry in \\\\?\\pipe\\ or \\\\.\\pipe\\. Any characters are permitted,\nbut the latter may do some processing of pipe names, such as resolving ..\nsequences. Despite appearances, the pipe name space is flat.  Pipes will not\npersist, they are removed when the last reference to them is closed. Do not\nforget JavaScript string escaping requires paths to be specified with\ndouble-backslashes, such as:
\n
net.createServer().listen(\n    path.join('\\\\\\\\?\\\\pipe', process.cwd(), 'myctl'))\n
The parameter backlog behaves the same as in\nserver.listen([port][, hostname][, backlog][, callback]).
\n"
            },
            {
              "textRaw": "server.listen([port][, hostname][, backlog][, callback])",
              "type": "method",
              "name": "listen",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Begin accepting connections on the specified port and hostname. If the\nhostname is omitted, the server will accept connections on any IPv6 address\n(::) when IPv6 is available, or any IPv4 address (0.0.0.0) otherwise.\nOmit the port argument, or use a port value of 0, to have the operating system\nassign a random port, which can be retrieved by using server.address().port\nafter the 'listening' event has been emitted.
\n
Backlog is the maximum length of the queue of pending connections.\nThe actual length will be determined by the OS through sysctl settings such as\ntcp_max_syn_backlog and somaxconn on Linux. The default value of this\nparameter is 511 (not 512).
\n
This function is asynchronous.  When the server has been bound,\n'listening' event will be emitted.  The last parameter callback\nwill be added as a listener for the 'listening' event.
\n
One issue some users run into is getting EADDRINUSE errors. This means that\nanother server is already running on the requested port. One way of handling this\nwould be to wait a second and then try again:
\n
server.on('error', (e) => {\n  if (e.code == 'EADDRINUSE') {\n    console.log('Address in use, retrying...');\n    setTimeout(() => {\n      server.close();\n      server.listen(PORT, HOST);\n    }, 1000);\n  }\n});\n
\n
(Note: All sockets in Node.js are set SO_REUSEADDR.)
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "port",
                      "optional": true
                    },
                    {
                      "name": "hostname",
                      "optional": true
                    },
                    {
                      "name": "backlog",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "server.ref()",
              "type": "method",
              "name": "ref",
              "meta": {
                "added": [
                  "v0.9.1"
                ]
              },
              "desc": "
Opposite of unref, calling ref on a previously unrefd server will not\nlet the program exit if it's the only server left (the default behavior). If\nthe server is refd calling ref again will have no effect.
\n
Returns server.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "server.unref()",
              "type": "method",
              "name": "unref",
              "meta": {
                "added": [
                  "v0.9.1"
                ]
              },
              "desc": "
Calling unref on a server will allow the program to exit if this is the only\nactive server in the event system. If the server is already unrefd calling\nunref again will have no effect.
\n
Returns server.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            }
          ],
          "properties": [
            {
              "textRaw": "server.connections",
              "name": "connections",
              "meta": {
                "added": [
                  "v0.2.0"
                ],
                "deprecated": [
                  "v0.9.7"
                ]
              },
              "stability": 0,
              "stabilityText": "Deprecated: Use [`server.getConnections()`][] instead.",
              "desc": "
The number of concurrent connections on the server.
\n
This becomes null when sending a socket to a child with\nchild_process.fork(). To poll forks and get current number of active\nconnections use asynchronous server.getConnections instead.
\n"
            },
            {
              "textRaw": "server.maxConnections",
              "name": "maxConnections",
              "meta": {
                "added": [
                  "v0.2.0"
                ]
              },
              "desc": "
Set this property to reject connections when the server's connection count gets\nhigh.
\n
It is not recommended to use this option once a socket has been sent to a child\nwith child_process.fork().
\n"
            }
          ]
        },
        {
          "textRaw": "Class: net.Socket",
          "type": "class",
          "name": "net.Socket",
          "meta": {
            "added": [
              "v0.3.4"
            ]
          },
          "desc": "
This object is an abstraction of a TCP or local socket.  net.Socket\ninstances implement a duplex Stream interface.  They can be created by the\nuser and used as a client (with connect()) or they can be created by Node.js\nand passed to the user through the 'connection' event of a server.
\n",
          "methods": [
            {
              "textRaw": "new net.Socket([options])",
              "type": "method",
              "name": "Socket",
              "meta": {
                "added": [
                  "v0.3.4"
                ]
              },
              "desc": "
Construct a new socket object.
\n
options is an object with the following defaults:
\n
{\n  fd: null,\n  allowHalfOpen: false,\n  readable: false,\n  writable: false\n}\n
\n
fd allows you to specify the existing file descriptor of socket.\nSet readable and/or writable to true to allow reads and/or writes on this\nsocket (NOTE: Works only when fd is passed).\nAbout allowHalfOpen, refer to createServer() and 'end' event.
\n
net.Socket instances are EventEmitter with the following events:
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "socket.address()",
              "type": "method",
              "name": "address",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Returns the bound address, the address family name and port of the\nsocket as reported by the operating system. Returns an object with\nthree properties, e.g.\n{ port: 12346, family: 'IPv4', address: '127.0.0.1' }
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "socket.connect(options[, connectListener])",
              "type": "method",
              "name": "connect",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Opens the connection for a given socket.
\n
For TCP sockets, options argument should be an object which specifies:
\n
    \n
  • port: Port the client should connect to (Required).
    \n
    • \n
  • host: Host the client should connect to. Defaults to 'localhost'.
    \n
    • \n
  • localAddress: Local interface to bind to for network connections.
    \n
    • \n
  • localPort: Local port to bind to for network connections.
    \n
    • \n
  • family : Version of IP stack. Defaults to 4.
    \n
    • \n
  • lookup : Custom lookup function. Defaults to dns.lookup.
    \n
    • \n
\n
For local domain sockets, options argument should be an object which\nspecifies:
\n
    \n
  • path: Path the client should connect to (Required).
    • \n
\n
Normally this method is not needed, as net.createConnection opens the\nsocket. Use this only if you are implementing a custom Socket.
\n
This function is asynchronous. When the 'connect' event is emitted the\nsocket is established. If there is a problem connecting, the 'connect' event\nwill not be emitted, the 'error' event will be emitted with the exception.
\n
The connectListener parameter will be added as a listener for the\n'connect' event.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "options"
                    },
                    {
                      "name": "connectListener",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "socket.connect(path[, connectListener])",
              "type": "method",
              "name": "connect",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
As socket.connect(options\\[, connectListener\\]),\nwith options either as either {port: port, host: host} or {path: path}.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "port"
                    },
                    {
                      "name": "host",
                      "optional": true
                    },
                    {
                      "name": "connectListener",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "path"
                    },
                    {
                      "name": "connectListener",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "socket.connect(port[, host][, connectListener])",
              "type": "method",
              "name": "connect",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
As socket.connect(options\\[, connectListener\\]),\nwith options either as either {port: port, host: host} or {path: path}.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "port"
                    },
                    {
                      "name": "host",
                      "optional": true
                    },
                    {
                      "name": "connectListener",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "socket.destroy()",
              "type": "method",
              "name": "destroy",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Ensures that no more I/O activity happens on this socket. Only necessary in\ncase of errors (parse error or so).
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "socket.end([data][, encoding])",
              "type": "method",
              "name": "end",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Half-closes the socket. i.e., it sends a FIN packet. It is possible the\nserver will still send some data.
\n
If data is specified, it is equivalent to calling\nsocket.write(data, encoding) followed by socket.end().
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "data",
                      "optional": true
                    },
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "socket.pause()",
              "type": "method",
              "name": "pause",
              "desc": "
Pauses the reading of data. That is, 'data' events will not be emitted.\nUseful to throttle back an upload.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "socket.ref()",
              "type": "method",
              "name": "ref",
              "meta": {
                "added": [
                  "v0.9.1"
                ]
              },
              "desc": "
Opposite of unref, calling ref on a previously unrefd socket will not\nlet the program exit if it's the only socket left (the default behavior). If\nthe socket is refd calling ref again will have no effect.
\n
Returns socket.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "socket.resume()",
              "type": "method",
              "name": "resume",
              "desc": "
Resumes reading after a call to pause().
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "socket.setEncoding([encoding])",
              "type": "method",
              "name": "setEncoding",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Set the encoding for the socket as a Readable Stream. See\nstream.setEncoding() for more information.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "socket.setKeepAlive([enable][, initialDelay])",
              "type": "method",
              "name": "setKeepAlive",
              "meta": {
                "added": [
                  "v0.1.92"
                ]
              },
              "desc": "
Enable/disable keep-alive functionality, and optionally set the initial\ndelay before the first keepalive probe is sent on an idle socket.\nenable defaults to false.
\n
Set initialDelay (in milliseconds) to set the delay between the last\ndata packet received and the first keepalive probe. Setting 0 for\ninitialDelay will leave the value unchanged from the default\n(or previous) setting. Defaults to 0.
\n
Returns socket.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "enable",
                      "optional": true
                    },
                    {
                      "name": "initialDelay",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "socket.setNoDelay([noDelay])",
              "type": "method",
              "name": "setNoDelay",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Disables the Nagle algorithm. By default TCP connections use the Nagle\nalgorithm, they buffer data before sending it off. Setting true for\nnoDelay will immediately fire off data each time socket.write() is called.\nnoDelay defaults to true.
\n
Returns socket.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "noDelay",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "socket.setTimeout(timeout[, callback])",
              "type": "method",
              "name": "setTimeout",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Sets the socket to timeout after timeout milliseconds of inactivity on\nthe socket. By default net.Socket do not have a timeout.
\n
When an idle timeout is triggered the socket will receive a 'timeout'\nevent but the connection will not be severed. The user must manually end()\nor destroy() the socket.
\n
If timeout is 0, then the existing idle timeout is disabled.
\n
The optional callback parameter will be added as a one time listener for the\n'timeout' event.
\n
Returns socket.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "timeout"
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "socket.unref()",
              "type": "method",
              "name": "unref",
              "meta": {
                "added": [
                  "v0.9.1"
                ]
              },
              "desc": "
Calling unref on a socket will allow the program to exit if this is the only\nactive socket in the event system. If the socket is already unrefd calling\nunref again will have no effect.
\n
Returns socket.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "socket.write(data[, encoding][, callback])",
              "type": "method",
              "name": "write",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Sends data on the socket. The second parameter specifies the encoding in the\ncase of a string--it defaults to UTF8 encoding.
\n
Returns true if the entire data was flushed successfully to the kernel\nbuffer. Returns false if all or part of the data was queued in user memory.\n'drain' will be emitted when the buffer is again free.
\n
The optional callback parameter will be executed when the data is finally\nwritten out - this may not be immediately.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "data"
                    },
                    {
                      "name": "encoding",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            }
          ],
          "events": [
            {
              "textRaw": "Event: 'close'",
              "type": "event",
              "name": "close",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "params": [],
              "desc": "
Emitted once the socket is fully closed. The argument had_error is a boolean\nwhich says if the socket was closed due to a transmission error.
\n"
            },
            {
              "textRaw": "Event: 'connect'",
              "type": "event",
              "name": "connect",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Emitted when a socket connection is successfully established.\nSee connect().
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'data'",
              "type": "event",
              "name": "data",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "params": [],
              "desc": "
Emitted when data is received.  The argument data will be a Buffer or\nString.  Encoding of data is set by socket.setEncoding().\n(See the Readable Stream section for more information.)
\n
Note that the data will be lost if there is no listener when a Socket\nemits a 'data' event.
\n"
            },
            {
              "textRaw": "Event: 'drain'",
              "type": "event",
              "name": "drain",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Emitted when the write buffer becomes empty. Can be used to throttle uploads.
\n
See also: the return values of socket.write()
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'end'",
              "type": "event",
              "name": "end",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Emitted when the other end of the socket sends a FIN packet.
\n
By default (allowHalfOpen == false) the socket will destroy its file\ndescriptor  once it has written out its pending write queue.  However, by\nsetting allowHalfOpen == true the socket will not automatically end()\nits side allowing the user to write arbitrary amounts of data, with the\ncaveat that the user is required to end() their side now.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'error'",
              "type": "event",
              "name": "error",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "params": [],
              "desc": "
Emitted when an error occurs.  The 'close' event will be called directly\nfollowing this event.
\n"
            },
            {
              "textRaw": "Event: 'lookup'",
              "type": "event",
              "name": "lookup",
              "meta": {
                "added": [
                  "v0.11.3"
                ]
              },
              "desc": "
Emitted after resolving the hostname but before connecting.\nNot applicable to UNIX sockets.
\n
    \n
  • err {Error|Null} The error object.  See dns.lookup().
    • \n
  • address {String} The IP address.
    • \n
  • family {String|Null} The address type.  See dns.lookup().
    • \n
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'timeout'",
              "type": "event",
              "name": "timeout",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Emitted if the socket times out from inactivity. This is only to notify that\nthe socket has been idle. The user must manually close the connection.
\n
See also: socket.setTimeout()
\n",
              "params": []
            }
          ],
          "properties": [
            {
              "textRaw": "socket.bufferSize",
              "name": "bufferSize",
              "meta": {
                "added": [
                  "v0.3.8"
                ]
              },
              "desc": "
net.Socket has the property that socket.write() always works. This is to\nhelp users get up and running quickly. The computer cannot always keep up\nwith the amount of data that is written to a socket - the network connection\nsimply might be too slow. Node.js will internally queue up the data written to a\nsocket and send it out over the wire when it is possible. (Internally it is\npolling on the socket's file descriptor for being writable).
\n
The consequence of this internal buffering is that memory may grow. This\nproperty shows the number of characters currently buffered to be written.\n(Number of characters is approximately equal to the number of bytes to be\nwritten, but the buffer may contain strings, and the strings are lazily\nencoded, so the exact number of bytes is not known.)
\n
Users who experience large or growing bufferSize should attempt to\n"throttle" the data flows in their program with pause() and resume().
\n"
            },
            {
              "textRaw": "socket.bytesRead",
              "name": "bytesRead",
              "meta": {
                "added": [
                  "v0.5.3"
                ]
              },
              "desc": "
The amount of received bytes.
\n"
            },
            {
              "textRaw": "socket.bytesWritten",
              "name": "bytesWritten",
              "meta": {
                "added": [
                  "v0.5.3"
                ]
              },
              "desc": "
The amount of bytes sent.
\n"
            },
            {
              "textRaw": "socket.destroyed",
              "name": "destroyed",
              "desc": "
A Boolean value that indicates if the connection is destroyed or not. Once a\nconnection is destroyed no further data can be transferred using it.
\n"
            },
            {
              "textRaw": "socket.localAddress",
              "name": "localAddress",
              "meta": {
                "added": [
                  "v0.9.6"
                ]
              },
              "desc": "
The string representation of the local IP address the remote client is\nconnecting on. For example, if you are listening on '0.0.0.0' and the\nclient connects on '192.168.1.1', the value would be '192.168.1.1'.
\n"
            },
            {
              "textRaw": "socket.localPort",
              "name": "localPort",
              "meta": {
                "added": [
                  "v0.9.6"
                ]
              },
              "desc": "
The numeric representation of the local port. For example,\n80 or 21.
\n"
            },
            {
              "textRaw": "socket.remoteAddress",
              "name": "remoteAddress",
              "meta": {
                "added": [
                  "v0.5.10"
                ]
              },
              "desc": "
The string representation of the remote IP address. For example,\n'74.125.127.100' or '2001:4860:a005::68'. Value may be undefined if\nthe socket is destroyed (for example, if the client disconnected).
\n"
            },
            {
              "textRaw": "socket.remoteFamily",
              "name": "remoteFamily",
              "meta": {
                "added": [
                  "v0.11.14"
                ]
              },
              "desc": "
The string representation of the remote IP family. 'IPv4' or 'IPv6'.
\n"
            },
            {
              "textRaw": "socket.remotePort",
              "name": "remotePort",
              "meta": {
                "added": [
                  "v0.5.10"
                ]
              },
              "desc": "
The numeric representation of the remote port. For example,\n80 or 21.
\n"
            }
          ]
        }
      ],
      "methods": [
        {
          "textRaw": "net.connect(options[, connectListener])",
          "type": "method",
          "name": "connect",
          "meta": {
            "added": [
              "v0.7.0"
            ]
          },
          "desc": "
A factory function, which returns a new net.Socket and automatically\nconnects with the supplied options.
\n
The options are passed to both the net.Socket constructor and the\nsocket.connect method.
\n
The connectListener parameter will be added as a listener for the\n'connect' event once.
\n
Here is an example of a client of the previously described echo server:
\n
const net = require('net');\nconst client = net.connect({port: 8124}, () => {\n  // 'connect' listener\n  console.log('connected to server!');\n  client.write('world!\\r\\n');\n});\nclient.on('data', (data) => {\n  console.log(data.toString());\n  client.end();\n});\nclient.on('end', () => {\n  console.log('disconnected from server');\n});\n
\n
To connect on the socket /tmp/echo.sock the second line would just be\nchanged to
\n
const client = net.connect({path: '/tmp/echo.sock'});\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "options"
                },
                {
                  "name": "connectListener",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "net.connect(path[, connectListener])",
          "type": "method",
          "name": "connect",
          "meta": {
            "added": [
              "v0.1.90"
            ]
          },
          "desc": "
A factory function, which returns a new unix net.Socket and automatically\nconnects to the supplied path.
\n
The connectListener parameter will be added as a listener for the\n'connect' event once.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "connectListener",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "net.connect(port[, host][, connectListener])",
          "type": "method",
          "name": "connect",
          "meta": {
            "added": [
              "v0.1.90"
            ]
          },
          "desc": "
A factory function, which returns a new net.Socket and automatically\nconnects to the supplied port and host.
\n
If host is omitted, 'localhost' will be assumed.
\n
The connectListener parameter will be added as a listener for the\n'connect' event once.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "port"
                },
                {
                  "name": "host",
                  "optional": true
                },
                {
                  "name": "connectListener",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "net.createConnection(options[, connectListener])",
          "type": "method",
          "name": "createConnection",
          "meta": {
            "added": [
              "v0.1.90"
            ]
          },
          "desc": "
A factory function, which returns a new net.Socket and automatically\nconnects with the supplied options.
\n
The options are passed to both the net.Socket constructor and the\nsocket.connect method.
\n
The connectListener parameter will be added as a listener for the\n'connect' event once.
\n
Here is an example of a client of the previously described echo server:
\n
const net = require('net');\nconst client = net.createConnection({port: 8124}, () => {\n  //'connect' listener\n  console.log('connected to server!');\n  client.write('world!\\r\\n');\n});\nclient.on('data', (data) => {\n  console.log(data.toString());\n  client.end();\n});\nclient.on('end', () => {\n  console.log('disconnected from server');\n});\n
\n
To connect on the socket /tmp/echo.sock the second line would just be\nchanged to
\n
const client = net.connect({path: '/tmp/echo.sock'});\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "options"
                },
                {
                  "name": "connectListener",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "net.createConnection(path[, connectListener])",
          "type": "method",
          "name": "createConnection",
          "meta": {
            "added": [
              "v0.1.90"
            ]
          },
          "desc": "
A factory function, which returns a new unix net.Socket and automatically\nconnects to the supplied path.
\n
The connectListener parameter will be added as a listener for the\n'connect' event once.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "connectListener",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "net.createConnection(port[, host][, connectListener])",
          "type": "method",
          "name": "createConnection",
          "meta": {
            "added": [
              "v0.1.90"
            ]
          },
          "desc": "
A factory function, which returns a new net.Socket and automatically\nconnects to the supplied port and host.
\n
If host is omitted, 'localhost' will be assumed.
\n
The connectListener parameter will be added as a listener for the\n'connect' event once.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "port"
                },
                {
                  "name": "host",
                  "optional": true
                },
                {
                  "name": "connectListener",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "net.createServer([options][, connectionListener])",
          "type": "method",
          "name": "createServer",
          "meta": {
            "added": [
              "v0.5.0"
            ]
          },
          "desc": "
Creates a new server. The connectionListener argument is\nautomatically set as a listener for the 'connection' event.
\n
options is an object with the following defaults:
\n
{\n  allowHalfOpen: false,\n  pauseOnConnect: false\n}\n
\n
If allowHalfOpen is true, then the socket won't automatically send a FIN\npacket when the other end of the socket sends a FIN packet. The socket becomes\nnon-readable, but still writable. You should call the end() method explicitly.\nSee 'end' event for more information.
\n
If pauseOnConnect is true, then the socket associated with each incoming\nconnection will be paused, and no data will be read from its handle. This allows\nconnections to be passed between processes without any data being read by the\noriginal process. To begin reading data from a paused socket, call resume().
\n
Here is an example of an echo server which listens for connections\non port 8124:
\n
const net = require('net');\nconst server = net.createServer((c) => {\n  // 'connection' listener\n  console.log('client connected');\n  c.on('end', () => {\n    console.log('client disconnected');\n  });\n  c.write('hello\\r\\n');\n  c.pipe(c);\n});\nserver.on('error', (err) => {\n  throw err;\n});\nserver.listen(8124, () => {\n  console.log('server bound');\n});\n
\n
Test this by using telnet:
\n
telnet localhost 8124\n
To listen on the socket /tmp/echo.sock the third line from the last would\njust be changed to
\n
server.listen('/tmp/echo.sock', () => {\n  console.log('server bound');\n});\n
\n
Use nc to connect to a UNIX domain socket server:
\n
nc -U /tmp/echo.sock\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "options",
                  "optional": true
                },
                {
                  "name": "connectionListener",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "net.isIP(input)",
          "type": "method",
          "name": "isIP",
          "meta": {
            "added": [
              "v0.3.0"
            ]
          },
          "desc": "
Tests if input is an IP address. Returns 0 for invalid strings,\nreturns 4 for IP version 4 addresses, and returns 6 for IP version 6 addresses.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "input"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "net.isIPv4(input)",
          "type": "method",
          "name": "isIPv4",
          "meta": {
            "added": [
              "v0.3.0"
            ]
          },
          "desc": "
Returns true if input is a version 4 IP address, otherwise returns false.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "input"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "net.isIPv6(input)",
          "type": "method",
          "name": "isIPv6",
          "meta": {
            "added": [
              "v0.3.0"
            ]
          },
          "desc": "
Returns true if input is a version 6 IP address, otherwise returns false.
\n\n\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "input"
                }
              ]
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "Net"
    },
    {
      "textRaw": "OS",
      "name": "os",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
Provides a few basic operating-system related utility functions.
\n
Use require('os') to access this module.
\n",
      "properties": [
        {
          "textRaw": "os.EOL",
          "name": "EOL",
          "meta": {
            "added": [
              "v0.7.8"
            ]
          },
          "desc": "
A constant defining the appropriate End-of-line marker for the operating\nsystem.
\n"
        }
      ],
      "methods": [
        {
          "textRaw": "os.arch()",
          "type": "method",
          "name": "arch",
          "meta": {
            "added": [
              "v0.5.0"
            ]
          },
          "desc": "
Returns the operating system CPU architecture. Possible values are 'x64',\n'arm' and 'ia32'. Returns the value of process.arch.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "os.cpus()",
          "type": "method",
          "name": "cpus",
          "meta": {
            "added": [
              "v0.3.3"
            ]
          },
          "desc": "
Returns an array of objects containing information about each CPU/core\ninstalled: model, speed (in MHz), and times (an object containing the number of\nmilliseconds the CPU/core spent in: user, nice, sys, idle, and irq).
\n
Example inspection of os.cpus:
\n
[ { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',\n    speed: 2926,\n    times:\n     { user: 252020,\n       nice: 0,\n       sys: 30340,\n       idle: 1070356870,\n       irq: 0 } },\n  { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',\n    speed: 2926,\n    times:\n     { user: 306960,\n       nice: 0,\n       sys: 26980,\n       idle: 1071569080,\n       irq: 0 } },\n  { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',\n    speed: 2926,\n    times:\n     { user: 248450,\n       nice: 0,\n       sys: 21750,\n       idle: 1070919370,\n       irq: 0 } },\n  { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',\n    speed: 2926,\n    times:\n     { user: 256880,\n       nice: 0,\n       sys: 19430,\n       idle: 1070905480,\n       irq: 20 } },\n  { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',\n    speed: 2926,\n    times:\n     { user: 511580,\n       nice: 20,\n       sys: 40900,\n       idle: 1070842510,\n       irq: 0 } },\n  { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',\n    speed: 2926,\n    times:\n     { user: 291660,\n       nice: 0,\n       sys: 34360,\n       idle: 1070888000,\n       irq: 10 } },\n  { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',\n    speed: 2926,\n    times:\n     { user: 308260,\n       nice: 0,\n       sys: 55410,\n       idle: 1071129970,\n       irq: 880 } },\n  { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',\n    speed: 2926,\n    times:\n     { user: 266450,\n       nice: 1480,\n       sys: 34920,\n       idle: 1072572010,\n       irq: 30 } } ]\n
\n
Note that since nice values are UNIX centric in Windows the nice values of\nall processors are always 0.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "os.endianness()",
          "type": "method",
          "name": "endianness",
          "meta": {
            "added": [
              "v0.9.4"
            ]
          },
          "desc": "
Returns the endianness of the CPU. Possible values are 'BE' for big endian\nor 'LE' for little endian.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "os.freemem()",
          "type": "method",
          "name": "freemem",
          "meta": {
            "added": [
              "v0.3.3"
            ]
          },
          "desc": "
Returns the amount of free system memory in bytes.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "os.homedir()",
          "type": "method",
          "name": "homedir",
          "meta": {
            "added": [
              "v2.3.0"
            ]
          },
          "desc": "
Returns the home directory of the current user.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "os.hostname()",
          "type": "method",
          "name": "hostname",
          "meta": {
            "added": [
              "v0.3.3"
            ]
          },
          "desc": "
Returns the hostname of the operating system.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "os.loadavg()",
          "type": "method",
          "name": "loadavg",
          "meta": {
            "added": [
              "v0.3.3"
            ]
          },
          "desc": "
Returns an array containing the 1, 5, and 15 minute load averages.
\n
The load average is a measure of system activity, calculated by the operating\nsystem and expressed as a fractional number.  As a rule of thumb, the load\naverage should ideally be less than the number of logical CPUs in the system.
\n
The load average is a very UNIX-y concept; there is no real equivalent on\nWindows platforms.  That is why this function always returns [0, 0, 0] on\nWindows.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "os.networkInterfaces()",
          "type": "method",
          "name": "networkInterfaces",
          "meta": {
            "added": [
              "v0.6.0"
            ]
          },
          "desc": "
Get a list of network interfaces:
\n
{ lo:\n   [ { address: '127.0.0.1',\n       netmask: '255.0.0.0',\n       family: 'IPv4',\n       mac: '00:00:00:00:00:00',\n       internal: true },\n     { address: '::1',\n       netmask: 'ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff',\n       family: 'IPv6',\n       mac: '00:00:00:00:00:00',\n       internal: true } ],\n  eth0:\n   [ { address: '192.168.1.108',\n       netmask: '255.255.255.0',\n       family: 'IPv4',\n       mac: '01:02:03:0a:0b:0c',\n       internal: false },\n     { address: 'fe80::a00:27ff:fe4e:66a1',\n       netmask: 'ffff:ffff:ffff:ffff::',\n       family: 'IPv6',\n       mac: '01:02:03:0a:0b:0c',\n       internal: false } ] }\n
\n
Note that due to the underlying implementation this will only return network\ninterfaces that have been assigned an address.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "os.platform()",
          "type": "method",
          "name": "platform",
          "meta": {
            "added": [
              "v0.5.0"
            ]
          },
          "desc": "
Returns the operating system platform. Possible values are 'darwin',\n'freebsd', 'linux', 'sunos' or 'win32'. Returns the value of\nprocess.platform.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "os.release()",
          "type": "method",
          "name": "release",
          "meta": {
            "added": [
              "v0.3.3"
            ]
          },
          "desc": "
Returns the operating system release.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "os.tmpdir()",
          "type": "method",
          "name": "tmpdir",
          "meta": {
            "added": [
              "v0.9.9"
            ]
          },
          "desc": "
Returns the operating system's default directory for temporary files.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "os.totalmem()",
          "type": "method",
          "name": "totalmem",
          "meta": {
            "added": [
              "v0.3.3"
            ]
          },
          "desc": "
Returns the total amount of system memory in bytes.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "os.type()",
          "type": "method",
          "name": "type",
          "meta": {
            "added": [
              "v0.3.3"
            ]
          },
          "desc": "
Returns the operating system name. For example 'Linux' on Linux, 'Darwin'\non OS X and 'Windows_NT' on Windows.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "os.uptime()",
          "type": "method",
          "name": "uptime",
          "meta": {
            "added": [
              "v0.3.3"
            ]
          },
          "desc": "
Returns the system uptime in seconds.
\n\n\n",
          "signatures": [
            {
              "params": []
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "OS"
    },
    {
      "textRaw": "Path",
      "name": "path",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
This module contains utilities for handling and transforming file\npaths.  Almost all these methods perform only string transformations.\nThe file system is not consulted to check whether paths are valid.
\n
Use require('path') to use this module.  The following methods are provided:
\n",
      "methods": [
        {
          "textRaw": "path.basename(p[, ext])",
          "type": "method",
          "name": "basename",
          "meta": {
            "added": [
              "v0.1.25"
            ]
          },
          "desc": "
Return the last portion of a path.  Similar to the Unix basename command.
\n
Example:
\n
path.basename('/foo/bar/baz/asdf/quux.html')\n// returns 'quux.html'\n\npath.basename('/foo/bar/baz/asdf/quux.html', '.html')\n// returns 'quux'\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "p"
                },
                {
                  "name": "ext",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "path.dirname(p)",
          "type": "method",
          "name": "dirname",
          "meta": {
            "added": [
              "v0.1.16"
            ]
          },
          "desc": "
Return the directory name of a path.  Similar to the Unix dirname command.
\n
Example:
\n
path.dirname('/foo/bar/baz/asdf/quux')\n// returns '/foo/bar/baz/asdf'\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "p"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "path.extname(p)",
          "type": "method",
          "name": "extname",
          "meta": {
            "added": [
              "v0.1.25"
            ]
          },
          "desc": "
Return the extension of the path, from the last '.' to end of string\nin the last portion of the path.  If there is no '.' in the last portion\nof the path or the first character of it is '.', then it returns\nan empty string.  Examples:
\n
path.extname('index.html')\n// returns '.html'\n\npath.extname('index.coffee.md')\n// returns '.md'\n\npath.extname('index.')\n// returns '.'\n\npath.extname('index')\n// returns ''\n\npath.extname('.index')\n// returns ''\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "p"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "path.format(pathObject)",
          "type": "method",
          "name": "format",
          "meta": {
            "added": [
              "v0.11.15"
            ]
          },
          "desc": "
Returns a path string from an object, the opposite of path.parse.
\n
Examples:
\n
Some Posix system examples:
\n
// If `dir` and `base` are provided, `dir` + platform separator + `base`\n// will be returned.\npath.format({\n    dir: '/home/user/dir',\n    base: 'file.txt'\n});\n// returns '/home/user/dir/file.txt'\n\n// `base` will be returned if `dir` or `root` are not provided.\npath.format({\n    base: 'file.txt'\n});\n// returns 'file.txt'\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "pathObject"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "path.isAbsolute(path)",
          "type": "method",
          "name": "isAbsolute",
          "meta": {
            "added": [
              "v0.11.2"
            ]
          },
          "desc": "
Determines whether path is an absolute path. An absolute path will always\nresolve to the same location, regardless of the working directory.
\n
Posix examples:
\n
path.isAbsolute('/foo/bar') // true\npath.isAbsolute('/baz/..')  // true\npath.isAbsolute('qux/')     // false\npath.isAbsolute('.')        // false\n
\n
Windows examples:
\n
path.isAbsolute('//server')  // true\npath.isAbsolute('C:/foo/..') // true\npath.isAbsolute('bar\\\\baz')  // false\npath.isAbsolute('.')         // false\n
\n
Note: If the path string passed as parameter is a zero-length string, unlike\n        other path module functions, it will be used as-is and false will be\n        returned.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "path.join([path1][, path2][, ...])",
          "type": "method",
          "name": "join",
          "meta": {
            "added": [
              "v0.1.16"
            ]
          },
          "desc": "
Join all arguments together and normalize the resulting path.
\n
Arguments must be strings.  In v0.8, non-string arguments were\nsilently ignored.  In v0.10 and up, an exception is thrown.
\n
Example:
\n
path.join('/foo', 'bar', 'baz/asdf', 'quux', '..')\n// returns '/foo/bar/baz/asdf'\n\npath.join('foo', {}, 'bar')\n// throws exception\nTypeError: Arguments to path.join must be strings\n
\n
Note: If the arguments to join have zero-length strings, unlike other path\n        module functions, they will be ignored. If the joined path string is a\n        zero-length string then '.' will be returned, which represents the\n        current working directory.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path1",
                  "optional": true
                },
                {
                  "name": "path2",
                  "optional": true
                },
                {
                  "name": "...",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "path.normalize(p)",
          "type": "method",
          "name": "normalize",
          "meta": {
            "added": [
              "v0.1.23"
            ]
          },
          "desc": "
Normalize a string path, taking care of '..' and '.' parts.
\n
When multiple slashes are found, they're replaced by a single one;\nwhen the path contains a trailing slash, it is preserved.\nOn Windows backslashes are used.
\n
Example:
\n
path.normalize('/foo/bar//baz/asdf/quux/..')\n// returns '/foo/bar/baz/asdf'\n
\n
Note: If the path string passed as argument is a zero-length string then '.'\n        will be returned, which represents the current working directory.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "p"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "path.parse(pathString)",
          "type": "method",
          "name": "parse",
          "meta": {
            "added": [
              "v0.11.15"
            ]
          },
          "desc": "
Returns an object from a path string.
\n
An example on *nix:
\n
path.parse('/home/user/dir/file.txt')\n// returns\n// {\n//    root : "/",\n//    dir : "/home/user/dir",\n//    base : "file.txt",\n//    ext : ".txt",\n//    name : "file"\n// }\n
\n
An example on Windows:
\n
path.parse('C:\\\\path\\\\dir\\\\index.html')\n// returns\n// {\n//    root : "C:\\\\",\n//    dir : "C:\\\\path\\\\dir",\n//    base : "index.html",\n//    ext : ".html",\n//    name : "index"\n// }\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "pathString"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "path.relative(from, to)",
          "type": "method",
          "name": "relative",
          "meta": {
            "added": [
              "v0.5.0"
            ]
          },
          "desc": "
Solve the relative path from from to to.
\n
At times we have two absolute paths, and we need to derive the relative\npath from one to the other.  This is actually the reverse transform of\npath.resolve, which means we see that:
\n
path.resolve(from, path.relative(from, to)) == path.resolve(to)\n
\n
Examples:
\n
path.relative('C:\\\\orandea\\\\test\\\\aaa', 'C:\\\\orandea\\\\impl\\\\bbb')\n// returns '..\\\\..\\\\impl\\\\bbb'\n\npath.relative('/data/orandea/test/aaa', '/data/orandea/impl/bbb')\n// returns '../../impl/bbb'\n
\n
Note: If the arguments to relative have zero-length strings then the current\n        working directory will be used instead of the zero-length strings. If\n        both the paths are the same then a zero-length string will be returned.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "from"
                },
                {
                  "name": "to"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "path.resolve([from ...], to)",
          "type": "method",
          "name": "resolve",
          "meta": {
            "added": [
              "v0.3.4"
            ]
          },
          "desc": "
Resolves to to an absolute path.
\n
If to isn't already absolute from arguments are prepended in right to left\norder, until an absolute path is found. If after using all from paths still\nno absolute path is found, the current working directory is used as well. The\nresulting path is normalized, and trailing slashes are removed unless the path\ngets resolved to the root directory. Non-string from arguments are ignored.
\n
Another way to think of it is as a sequence of cd commands in a shell.
\n
path.resolve('foo/bar', '/tmp/file/', '..', 'a/../subfile')\n
\n
Is similar to:
\n
cd foo/bar\ncd /tmp/file/\ncd ..\ncd a/../subfile\npwd\n
The difference is that the different paths don't need to exist and may also be\nfiles.
\n
Examples:
\n
path.resolve('/foo/bar', './baz')\n// returns '/foo/bar/baz'\n\npath.resolve('/foo/bar', '/tmp/file/')\n// returns '/tmp/file'\n\npath.resolve('wwwroot', 'static_files/png/', '../gif/image.gif')\n// if currently in /home/myself/node, it returns\n// '/home/myself/node/wwwroot/static_files/gif/image.gif'\n
\n
Note: If the arguments to resolve have zero-length strings then the current\n        working directory will be used instead of them.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "from ...",
                  "optional": true
                },
                {
                  "name": "to"
                }
              ]
            }
          ]
        }
      ],
      "properties": [
        {
          "textRaw": "path.delimiter",
          "name": "delimiter",
          "meta": {
            "added": [
              "v0.9.3"
            ]
          },
          "desc": "
The platform-specific path delimiter, ; or ':'.
\n
An example on *nix:
\n
console.log(process.env.PATH)\n// '/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin'\n\nprocess.env.PATH.split(path.delimiter)\n// returns ['/usr/bin', '/bin', '/usr/sbin', '/sbin', '/usr/local/bin']\n
\n
An example on Windows:
\n
console.log(process.env.PATH)\n// 'C:\\Windows\\system32;C:\\Windows;C:\\Program Files\\node\\'\n\nprocess.env.PATH.split(path.delimiter)\n// returns ['C:\\\\Windows\\\\system32', 'C:\\\\Windows', 'C:\\\\Program Files\\\\node\\\\']\n
\n"
        },
        {
          "textRaw": "path.posix",
          "name": "posix",
          "meta": {
            "added": [
              "v0.11.15"
            ]
          },
          "desc": "
Provide access to aforementioned path methods but always interact in a posix\ncompatible way.
\n"
        },
        {
          "textRaw": "path.sep",
          "name": "sep",
          "meta": {
            "added": [
              "v0.7.9"
            ]
          },
          "desc": "
The platform-specific file separator. '\\\\' or '/'.
\n
An example on *nix:
\n
'foo/bar/baz'.split(path.sep)\n// returns ['foo', 'bar', 'baz']\n
\n
An example on Windows:
\n
'foo\\\\bar\\\\baz'.split(path.sep)\n// returns ['foo', 'bar', 'baz']\n
\n"
        },
        {
          "textRaw": "path.win32",
          "name": "win32",
          "meta": {
            "added": [
              "v0.11.15"
            ]
          },
          "desc": "
Provide access to aforementioned path methods but always interact in a win32\ncompatible way.
\n\n\n"
        }
      ],
      "type": "module",
      "displayName": "Path"
    },
    {
      "textRaw": "Punycode",
      "name": "punycode",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
Punycode.js is bundled with Node.js v0.5.1+. Use require('punycode') to\naccess it. (To use it with other Node.js versions, use npm to install the\npunycode module first.)
\n",
      "methods": [
        {
          "textRaw": "punycode.decode(string)",
          "type": "method",
          "name": "decode",
          "meta": {
            "added": [
              "v0.5.1"
            ]
          },
          "desc": "
Converts a Punycode string of ASCII-only symbols to a string of Unicode symbols.
\n
// decode domain name parts\npunycode.decode('maana-pta'); // 'mañana'\npunycode.decode('--dqo34k'); // '☃-⌘'\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "string"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "punycode.encode(string)",
          "type": "method",
          "name": "encode",
          "meta": {
            "added": [
              "v0.5.1"
            ]
          },
          "desc": "
Converts a string of Unicode symbols to a Punycode string of ASCII-only symbols.
\n
// encode domain name parts\npunycode.encode('mañana'); // 'maana-pta'\npunycode.encode('☃-⌘'); // '--dqo34k'\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "string"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "punycode.toASCII(domain)",
          "type": "method",
          "name": "toASCII",
          "meta": {
            "added": [
              "v0.6.1"
            ]
          },
          "desc": "
Converts a Unicode string representing a domain name to Punycode. Only the\nnon-ASCII parts of the domain name will be converted, i.e. it doesn't matter if\nyou call it with a domain that's already in ASCII.
\n
// encode domain names\npunycode.toASCII('mañana.com'); // 'xn--maana-pta.com'\npunycode.toASCII('☃-⌘.com'); // 'xn----dqo34k.com'\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "domain"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "punycode.toUnicode(domain)",
          "type": "method",
          "name": "toUnicode",
          "meta": {
            "added": [
              "v0.6.1"
            ]
          },
          "desc": "
Converts a Punycode string representing a domain name to Unicode. Only the\nPunycoded parts of the domain name will be converted, i.e. it doesn't matter if\nyou call it on a string that has already been converted to Unicode.
\n
// decode domain names\npunycode.toUnicode('xn--maana-pta.com'); // 'mañana.com'\npunycode.toUnicode('xn----dqo34k.com'); // '☃-⌘.com'\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "domain"
                }
              ]
            }
          ]
        }
      ],
      "properties": [
        {
          "textRaw": "punycode.ucs2",
          "name": "ucs2",
          "meta": {
            "added": [
              "v0.7.0"
            ]
          },
          "modules": [
            {
              "textRaw": "punycode.ucs2.decode(string)",
              "name": "punycode.ucs2.decode(string)",
              "meta": {
                "added": [
                  "v0.7.0"
                ]
              },
              "desc": "
Creates an array containing the numeric code point values of each Unicode\nsymbol in the string. While JavaScript uses UCS-2 internally, this function\nwill convert a pair of surrogate halves (each of which UCS-2 exposes as\nseparate characters) into a single code point, matching UTF-16.
\n
punycode.ucs2.decode('abc'); // [0x61, 0x62, 0x63]\n// surrogate pair for U+1D306 tetragram for centre:\npunycode.ucs2.decode('\\uD834\\uDF06'); // [0x1D306]\n
\n",
              "type": "module",
              "displayName": "punycode.ucs2.decode(string)"
            },
            {
              "textRaw": "punycode.ucs2.encode(codePoints)",
              "name": "punycode.ucs2.encode(codepoints)",
              "meta": {
                "added": [
                  "v0.7.0"
                ]
              },
              "desc": "
Creates a string based on an array of numeric code point values.
\n
punycode.ucs2.encode([0x61, 0x62, 0x63]); // 'abc'\npunycode.ucs2.encode([0x1D306]); // '\\uD834\\uDF06'\n
\n",
              "type": "module",
              "displayName": "punycode.ucs2.encode(codePoints)"
            }
          ]
        },
        {
          "textRaw": "punycode.version",
          "name": "version",
          "meta": {
            "added": [
              "v0.6.1"
            ]
          },
          "desc": "
A string representing the current Punycode.js version number.
\n\n\n"
        }
      ],
      "type": "module",
      "displayName": "Punycode"
    },
    {
      "textRaw": "Query String",
      "name": "querystring",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
This module provides utilities for dealing with query strings.\nIt provides the following methods:
\n",
      "properties": [
        {
          "textRaw": "querystring.escape",
          "name": "escape",
          "meta": {
            "added": [
              "v0.1.25"
            ]
          },
          "desc": "
The escape function used by querystring.stringify,\nprovided so that it could be overridden if necessary.
\n"
        },
        {
          "textRaw": "querystring.unescape",
          "name": "unescape",
          "meta": {
            "added": [
              "v0.1.25"
            ]
          },
          "desc": "
The unescape function used by querystring.parse,\nprovided so that it could be overridden if necessary.
\n
It will try to use decodeURIComponent in the first place,\nbut if that fails it falls back to a safer equivalent that\ndoesn't throw on malformed URLs.
\n\n\n"
        }
      ],
      "methods": [
        {
          "textRaw": "querystring.parse(str[, sep][, eq][, options])",
          "type": "method",
          "name": "parse",
          "meta": {
            "added": [
              "v0.1.25"
            ]
          },
          "desc": "
Deserialize a query string to an object.\nOptionally override the default separator ('&') and assignment ('=')\ncharacters.
\n
Options object may contain maxKeys property (equal to 1000 by default), it'll\nbe used to limit processed keys. Set it to 0 to remove key count limitation.
\n
Options object may contain decodeURIComponent property (querystring.unescape by default),\nit can be used to decode a non-utf8 encoding string if necessary.
\n
Example:
\n
querystring.parse('foo=bar&baz=qux&baz=quux&corge')\n// returns { foo: 'bar', baz: ['qux', 'quux'], corge: '' }\n\n// Suppose gbkDecodeURIComponent function already exists,\n// it can decode `gbk` encoding string\nquerystring.parse('w=%D6%D0%CE%C4&foo=bar', null, null,\n  { decodeURIComponent: gbkDecodeURIComponent })\n// returns { w: '中文', foo: 'bar' }\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "str"
                },
                {
                  "name": "sep",
                  "optional": true
                },
                {
                  "name": "eq",
                  "optional": true
                },
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "querystring.stringify(obj[, sep][, eq][, options])",
          "type": "method",
          "name": "stringify",
          "meta": {
            "added": [
              "v0.1.25"
            ]
          },
          "desc": "
Serialize an object to a query string.\nOptionally override the default separator ('&') and assignment ('=')\ncharacters.
\n
Options object may contain encodeURIComponent property (querystring.escape by default),\nit can be used to encode string with non-utf8 encoding if necessary.
\n
Example:
\n
querystring.stringify({ foo: 'bar', baz: ['qux', 'quux'], corge: '' })\n// returns 'foo=bar&baz=qux&baz=quux&corge='\n\nquerystring.stringify({foo: 'bar', baz: 'qux'}, ';', ':')\n// returns 'foo:bar;baz:qux'\n\n// Suppose gbkEncodeURIComponent function already exists,\n// it can encode string with `gbk` encoding\nquerystring.stringify({ w: '中文', foo: 'bar' }, null, null,\n  { encodeURIComponent: gbkEncodeURIComponent })\n// returns 'w=%D6%D0%CE%C4&foo=bar'\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "obj"
                },
                {
                  "name": "sep",
                  "optional": true
                },
                {
                  "name": "eq",
                  "optional": true
                },
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "querystring"
    },
    {
      "textRaw": "Readline",
      "name": "readline",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
To use this module, do require('readline'). Readline allows reading of a\nstream (such as process.stdin) on a line-by-line basis.
\n
Note that once you've invoked this module, your Node.js program will not\nterminate until you've closed the interface. Here's how to allow your\nprogram to gracefully exit:
\n
const readline = require('readline');\n\nconst rl = readline.createInterface({\n  input: process.stdin,\n  output: process.stdout\n});\n\nrl.question('What do you think of Node.js? ', (answer) => {\n  // TODO: Log the answer in a database\n  console.log('Thank you for your valuable feedback:', answer);\n\n  rl.close();\n});\n
\n",
      "classes": [
        {
          "textRaw": "Class: Interface",
          "type": "class",
          "name": "Interface",
          "meta": {
            "added": [
              "v0.1.104"
            ]
          },
          "desc": "
The class that represents a readline interface with an input and output\nstream.
\n",
          "methods": [
            {
              "textRaw": "rl.close()",
              "type": "method",
              "name": "close",
              "meta": {
                "added": [
                  "v0.1.98"
                ]
              },
              "desc": "
Closes the Interface instance, relinquishing control on the input and\noutput streams. The 'close' event will also be emitted.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "rl.pause()",
              "type": "method",
              "name": "pause",
              "meta": {
                "added": [
                  "v0.3.4"
                ]
              },
              "desc": "
Pauses the readline input stream, allowing it to be resumed later if needed.
\n
Note that this doesn't immediately pause the stream of events. Several events may\nbe emitted after calling pause, including line.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "rl.prompt([preserveCursor])",
              "type": "method",
              "name": "prompt",
              "meta": {
                "added": [
                  "v0.1.98"
                ]
              },
              "desc": "
Readies readline for input from the user, putting the current setPrompt\noptions on a new line, giving the user a new spot to write. Set preserveCursor\nto true to prevent the cursor placement being reset to 0.
\n
This will also resume the input stream used with createInterface if it has\nbeen paused.
\n
If output is set to null or undefined when calling createInterface, the\nprompt is not written.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "preserveCursor",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "rl.question(query, callback)",
              "type": "method",
              "name": "question",
              "meta": {
                "added": [
                  "v0.3.3"
                ]
              },
              "desc": "
Prepends the prompt with query and invokes callback with the user's\nresponse. Displays the query to the user, and then invokes callback\nwith the user's response after it has been typed.
\n
This will also resume the input stream used with createInterface if\nit has been paused.
\n
If output is set to null or undefined when calling createInterface,\nnothing is displayed.
\n
Example usage:
\n
rl.question('What is your favorite food?', (answer) => {\n  console.log(`Oh, so your favorite food is ${answer}`);\n});\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "query"
                    },
                    {
                      "name": "callback"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "rl.resume()",
              "type": "method",
              "name": "resume",
              "meta": {
                "added": [
                  "v0.3.4"
                ]
              },
              "desc": "
Resumes the readline input stream.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "rl.setPrompt(prompt)",
              "type": "method",
              "name": "setPrompt",
              "meta": {
                "added": [
                  "v0.1.98"
                ]
              },
              "desc": "
Sets the prompt, for example when you run node on the command line, you see\n>, which is Node.js's prompt.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "prompt"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "rl.write(data[, key])",
              "type": "method",
              "name": "write",
              "meta": {
                "added": [
                  "v0.1.98"
                ]
              },
              "desc": "
Writes data to output stream, unless output is set to null or\nundefined when calling createInterface. key is an object literal to\nrepresent a key sequence; available if the terminal is a TTY.
\n
This will also resume the input stream if it has been paused.
\n
Example:
\n
rl.write('Delete me!');\n// Simulate ctrl+u to delete the line written previously\nrl.write(null, {ctrl: true, name: 'u'});\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "data"
                    },
                    {
                      "name": "key",
                      "optional": true
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "modules": [
        {
          "textRaw": "Events",
          "name": "events",
          "events": [
            {
              "textRaw": "Event: 'close'",
              "type": "event",
              "name": "close",
              "meta": {
                "added": [
                  "v0.1.98"
                ]
              },
              "desc": "
function () {}
\n
Emitted when close() is called.
\n
Also emitted when the input stream receives its 'end' event. The Interface\ninstance should be considered "finished" once this is emitted. For example, when\nthe input stream receives ^D, respectively known as EOT.
\n
This event is also called if there is no SIGINT event listener present when\nthe input stream receives a ^C, respectively known as SIGINT.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'line'",
              "type": "event",
              "name": "line",
              "meta": {
                "added": [
                  "v0.1.98"
                ]
              },
              "desc": "
function (line) {}
\n
Emitted whenever the input stream receives an end of line (\\n, \\r, or\n\\r\\n), usually received when the user hits enter, or return. This is a good\nhook to listen for user input.
\n
Example of listening for 'line':
\n
rl.on('line', (cmd) => {\n  console.log(`You just typed: ${cmd}`);\n});\n
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'pause'",
              "type": "event",
              "name": "pause",
              "meta": {
                "added": [
                  "v0.7.5"
                ]
              },
              "desc": "
function () {}
\n
Emitted whenever the input stream is paused.
\n
Also emitted whenever the input stream is not paused and receives the\nSIGCONT event. (See events SIGTSTP and SIGCONT)
\n
Example of listening for 'pause':
\n
rl.on('pause', () => {\n  console.log('Readline paused.');\n});\n
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'resume'",
              "type": "event",
              "name": "resume",
              "meta": {
                "added": [
                  "v0.7.5"
                ]
              },
              "desc": "
function () {}
\n
Emitted whenever the input stream is resumed.
\n
Example of listening for 'resume':
\n
rl.on('resume', () => {\n  console.log('Readline resumed.');\n});\n
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'SIGCONT'",
              "type": "event",
              "name": "SIGCONT",
              "meta": {
                "added": [
                  "v0.7.5"
                ]
              },
              "desc": "
function () {}
\n
This does not work on Windows.
\n
Emitted whenever the input stream is sent to the background with ^Z,\nrespectively known as SIGTSTP, and then continued with fg(1). This event\nonly emits if the stream was not paused before sending the program to the\nbackground.
\n
Example of listening for SIGCONT:
\n
rl.on('SIGCONT', () => {\n  // `prompt` will automatically resume the stream\n  rl.prompt();\n});\n
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'SIGINT'",
              "type": "event",
              "name": "SIGINT",
              "meta": {
                "added": [
                  "v0.3.0"
                ]
              },
              "desc": "
function () {}
\n
Emitted whenever the input stream receives a ^C, respectively known as\nSIGINT. If there is no SIGINT event listener present when the input\nstream receives a SIGINT, pause will be triggered.
\n
Example of listening for SIGINT:
\n
rl.on('SIGINT', () => {\n  rl.question('Are you sure you want to exit?', (answer) => {\n    if (answer.match(/^y(es)?$/i)) rl.pause();\n  });\n});\n
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'SIGTSTP'",
              "type": "event",
              "name": "SIGTSTP",
              "meta": {
                "added": [
                  "v0.7.5"
                ]
              },
              "desc": "
function () {}
\n
This does not work on Windows.
\n
Emitted whenever the input stream receives a ^Z, respectively known as\nSIGTSTP. If there is no SIGTSTP event listener present when the input\nstream receives a SIGTSTP, the program will be sent to the background.
\n
When the program is resumed with fg, the 'pause' and SIGCONT events will be\nemitted. You can use either to resume the stream.
\n
The 'pause' and SIGCONT events will not be triggered if the stream was paused\nbefore the program was sent to the background.
\n
Example of listening for SIGTSTP:
\n
rl.on('SIGTSTP', () => {\n  // This will override SIGTSTP and prevent the program from going to the\n  // background.\n  console.log('Caught SIGTSTP.');\n});\n
\n
Example: Tiny CLI
\n
Here's an example of how to use all these together to craft a tiny command\nline interface:
\n
const readline = require('readline');\nconst rl = readline.createInterface(process.stdin, process.stdout);\n\nrl.setPrompt('OHAI> ');\nrl.prompt();\n\nrl.on('line', (line) => {\n  switch(line.trim()) {\n    case 'hello':\n      console.log('world!');\n      break;\n    default:\n      console.log('Say what? I might have heard `' + line.trim() + '`');\n      break;\n  }\n  rl.prompt();\n}).on('close', () => {\n  console.log('Have a great day!');\n  process.exit(0);\n});\n
\n
Example: Read File Stream Line-by-Line
\n
A common case for readline's input option is to pass a filesystem readable\nstream to it. This is how one could craft line-by-line parsing of a file:
\n
const readline = require('readline');\nconst fs = require('fs');\n\nconst rl = readline.createInterface({\n  input: fs.createReadStream('sample.txt')\n});\n\nrl.on('line', (line) => {\n  console.log('Line from file:', line);\n});\n
\n
Note: The rl.write() method will write the data to the readline\nInterface's input as if it were provided by the user.
\n",
              "params": []
            }
          ],
          "type": "module",
          "displayName": "Events"
        }
      ],
      "methods": [
        {
          "textRaw": "readline.clearLine(stream, dir)",
          "type": "method",
          "name": "clearLine",
          "meta": {
            "added": [
              "v0.7.7"
            ]
          },
          "desc": "
Clears current line of given TTY stream in a specified direction.\ndir should have one of following values:
\n
    \n
  • -1 - to the left from cursor
    • \n
  • 1 - to the right from cursor
    • \n
  • 0 - the entire line
    • \n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "stream"
                },
                {
                  "name": "dir"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "readline.clearScreenDown(stream)",
          "type": "method",
          "name": "clearScreenDown",
          "meta": {
            "added": [
              "v0.7.7"
            ]
          },
          "desc": "
Clears the screen from the current position of the cursor down.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "stream"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "readline.createInterface(options)",
          "type": "method",
          "name": "createInterface",
          "meta": {
            "added": [
              "v0.1.98"
            ]
          },
          "desc": "
Creates a readline Interface instance. Accepts an options Object that takes\nthe following values:
\n
    \n
  • input - the readable stream to listen to (Required).
    \n
    • \n
  • output - the writable stream to write readline data to (Optional).
    \n
    • \n
  • completer - an optional function that is used for Tab autocompletion. See\nbelow for an example of using this.
    \n
    • \n
  • terminal - pass true if the input and output streams should be\ntreated like a TTY, and have ANSI/VT100 escape codes written to it.\nDefaults to checking isTTY on the output stream upon instantiation.
    \n
    • \n
  • historySize - maximum number of history lines retained. Defaults to 30.
    \n
    • \n
\n
The completer function is given the current line entered by the user, and\nis supposed to return an Array with 2 entries:
\n
    \n
  1. An Array with matching entries for the completion.
    \n
    2. \n
  2. The substring that was used for the matching.
    \n
    3. \n
\n
Which ends up looking something like:\n[[substr1, substr2, ...], originalsubstring].
\n
Example:
\n
function completer(line) {\n  var completions = '.help .error .exit .quit .q'.split(' ')\n  var hits = completions.filter((c) => { return c.indexOf(line) == 0 })\n  // show all completions if none found\n  return [hits.length ? hits : completions, line]\n}\n
\n
Also completer can be run in async mode if it accepts two arguments:
\n
function completer(linePartial, callback) {\n  callback(null, [['123'], linePartial]);\n}\n
\n
createInterface is commonly used with process.stdin and\nprocess.stdout in order to accept user input:
\n
const readline = require('readline');\nconst rl = readline.createInterface({\n  input: process.stdin,\n  output: process.stdout\n});\n
\n
Once you have a readline instance, you most commonly listen for the\n'line' event.
\n
If terminal is true for this instance then the output stream will get\nthe best compatibility if it defines an output.columns property, and fires\na 'resize' event on the output if/when the columns ever change\n(process.stdout does this automatically when it is a TTY).
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "options"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "readline.cursorTo(stream, x, y)",
          "type": "method",
          "name": "cursorTo",
          "meta": {
            "added": [
              "v0.7.7"
            ]
          },
          "desc": "
Move cursor to the specified position in a given TTY stream.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "stream"
                },
                {
                  "name": "x"
                },
                {
                  "name": "y"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "readline.emitKeypressEvents(stream[, interface])",
          "type": "method",
          "name": "emitKeypressEvents",
          "meta": {
            "added": [
              "v0.7.7"
            ]
          },
          "desc": "
Causes stream to begin emitting 'keypress' events corresponding to its\ninput.\nOptionally, interface specifies a readline.Interface instance for which\nautocompletion is disabled when copy-pasted input is detected.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "stream"
                },
                {
                  "name": "interface",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "readline.moveCursor(stream, dx, dy)",
          "type": "method",
          "name": "moveCursor",
          "meta": {
            "added": [
              "v0.7.7"
            ]
          },
          "desc": "
Move cursor relative to it's current position in a given TTY stream.
\n\n\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "stream"
                },
                {
                  "name": "dx"
                },
                {
                  "name": "dy"
                }
              ]
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "Readline"
    },
    {
      "textRaw": "REPL",
      "name": "repl",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
A Read-Eval-Print-Loop (REPL) is available both as a standalone program and\neasily includable in other programs. The REPL provides a way to interactively\nrun JavaScript and see the results.  It can be used for debugging, testing, or\njust trying things out.
\n
By executing node without any arguments from the command-line you will be\ndropped into the REPL. It has simplistic emacs line-editing.
\n
$ node\nType '.help' for options.\n> a = [1, 2, 3];\n[ 1, 2, 3 ]\n> a.forEach((v) => {\n...   console.log(v);\n...   });\n1\n2\n3\n
For advanced line-editors, start Node.js with the environmental variable\nNODE_NO_READLINE=1. This will start the main and debugger REPL in canonical\nterminal settings which will allow you to use with rlwrap.
\n
For example, you could add this to your bashrc file:
\n
alias node="env NODE_NO_READLINE=1 rlwrap node"\n
",
      "modules": [
        {
          "textRaw": "Environment Variable Options",
          "name": "environment_variable_options",
          "desc": "
The built-in repl (invoked by running node or node -i) may be controlled\nvia the following environment variables:
\n
    \n
  • NODE_REPL_HISTORY - When a valid path is given, persistent REPL history\nwill be saved to the specified file rather than .node_repl_history in the\nuser's home directory. Setting this value to "" will disable persistent\nREPL history. Whitespace will be trimmed from the value.
    • \n
  • NODE_REPL_HISTORY_SIZE - Defaults to 1000. Controls how many lines of\nhistory will be persisted if history is available. Must be a positive number.
    • \n
  • NODE_REPL_MODE - May be any of sloppy, strict, or magic. Defaults\nto magic, which will automatically run "strict mode only" statements in\nstrict mode.
    • \n
\n",
          "type": "module",
          "displayName": "Environment Variable Options"
        },
        {
          "textRaw": "Persistent History",
          "name": "persistent_history",
          "desc": "
By default, the REPL will persist history between node REPL sessions by saving\nto a .node_repl_history file in the user's home directory. This can be\ndisabled by setting the environment variable NODE_REPL_HISTORY="".
\n",
          "modules": [
            {
              "textRaw": "NODE_REPL_HISTORY_FILE",
              "name": "node_repl_history_file",
              "stability": 0,
              "stabilityText": "Deprecated: Use `NODE_REPL_HISTORY` instead.",
              "desc": "
Previously in Node.js/io.js v2.x, REPL history was controlled by using a\nNODE_REPL_HISTORY_FILE environment variable, and the history was saved in JSON\nformat. This variable has now been deprecated, and your REPL history will\nautomatically be converted to using plain text. The new file will be saved to\neither your home directory, or a directory defined by the NODE_REPL_HISTORY\nvariable, as documented here.
\n",
              "type": "module",
              "displayName": "NODE_REPL_HISTORY_FILE"
            }
          ],
          "type": "module",
          "displayName": "Persistent History"
        }
      ],
      "miscs": [
        {
          "textRaw": "REPL Features",
          "name": "REPL Features",
          "type": "misc",
          "desc": "
Inside the REPL, Control+D will exit.  Multi-line expressions can be input.\nTab completion is supported for both global and local variables.
\n
Core modules will be loaded on-demand into the environment. For example,\naccessing fs will require() the fs module as global.fs.
\n
The special variable _ (underscore) contains the result of the last expression.
\n
> [ 'a', 'b', 'c' ]\n[ 'a', 'b', 'c' ]\n> _.length\n3\n> _ += 1\n4\n
The REPL provides access to any variables in the global scope. You can expose\na variable to the REPL explicitly by assigning it to the context object\nassociated with each REPLServer.  For example:
\n
// repl_test.js\nconst repl = require('repl');\nvar msg = 'message';\n\nrepl.start('> ').context.m = msg;\n
\n
Things in the context object appear as local within the REPL:
\n
$ node repl_test.js\n> m\n'message'\n
There are a few special REPL commands:
\n
    \n
  • .break - While inputting a multi-line expression, sometimes you get lost\nor just don't care about completing it. .break will start over.
    • \n
  • .clear - Resets the context object to an empty object and clears any\nmulti-line expression.
    • \n
  • .exit - Close the I/O stream, which will cause the REPL to exit.
    • \n
  • .help - Show this list of special commands.
    • \n
  • .save - Save the current REPL session to a file
    \n
    .save ./file/to/save.js
    \n
    \n
    • \n
  • .load - Load a file into the current REPL session.
    \n
    .load ./file/to/load.js
    \n
    \n
    • \n
\n
The following key combinations in the REPL have these special effects:
\n
    \n
  • <ctrl>C - Similar to the .break keyword.  Terminates the current\ncommand.  Press twice on a blank line to forcibly exit.
    • \n
  • <ctrl>D - Similar to the .exit keyword.
    • \n
  • <tab> - Show both global and local(scope) variables
    • \n
\n",
          "miscs": [
            {
              "textRaw": "Customizing Object displays in the REPL",
              "name": "customizing_object_displays_in_the_repl",
              "desc": "
The REPL module internally uses\nutil.inspect(), when printing values. However, util.inspect delegates the\n call to the object's inspect() function, if it has one. You can read more\n about this delegation here.
\n
For example, if you have defined an inspect() function on an object, like this:
\n
> var obj = {foo: 'this will not show up in the inspect() output'};\nundefined\n> obj.inspect = () => {\n...   return {bar: 'baz'};\n... };\n[Function]\n
and try to print obj in REPL, it will invoke the custom inspect() function:
\n
> obj\n{bar: 'baz'}\n
",
              "type": "misc",
              "displayName": "Customizing Object displays in the REPL"
            }
          ]
        }
      ],
      "classes": [
        {
          "textRaw": "Class: REPLServer",
          "type": "class",
          "name": "REPLServer",
          "meta": {
            "added": [
              "v0.1.91"
            ]
          },
          "desc": "
This inherits from Readline Interface with the following events:
\n",
          "events": [
            {
              "textRaw": "Event: 'exit'",
              "type": "event",
              "name": "exit",
              "meta": {
                "added": [
                  "v0.7.7"
                ]
              },
              "desc": "
function () {}
\n
Emitted when the user exits the REPL in any of the defined ways. Namely, typing\n.exit at the repl, pressing Ctrl+C twice to signal SIGINT, or pressing Ctrl+D\nto signal 'end' on the input stream.
\n
Example of listening for exit:
\n
replServer.on('exit', () => {\n  console.log('Got "exit" event from repl!');\n  process.exit();\n});\n
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'reset'",
              "type": "event",
              "name": "reset",
              "meta": {
                "added": [
                  "v0.11.0"
                ]
              },
              "desc": "
function (context) {}
\n
Emitted when the REPL's context is reset. This happens when you type .clear.\nIf you start the repl with { useGlobal: true } then this event will never\nbe emitted.
\n
Example of listening for reset:
\n
// Extend the initial repl context.\nvar replServer = repl.start({ options ... });\nsomeExtension.extend(r.context);\n\n// When a new context is created extend it as well.\nreplServer.on('reset', (context) => {\n  console.log('repl has a new context');\n  someExtension.extend(context);\n});\n
\n",
              "params": []
            }
          ],
          "methods": [
            {
              "textRaw": "replServer.defineCommand(keyword, cmd)",
              "type": "method",
              "name": "defineCommand",
              "meta": {
                "added": [
                  "v0.3.0"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`keyword` {String} ",
                      "name": "keyword",
                      "type": "String"
                    },
                    {
                      "textRaw": "`cmd` {Object|Function} ",
                      "name": "cmd",
                      "type": "Object|Function"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "keyword"
                    },
                    {
                      "name": "cmd"
                    }
                  ]
                }
              ],
              "desc": "
Makes a command available in the REPL. The command is invoked by typing a .\nfollowed by the keyword. The cmd is an object with the following values:
\n
    \n
  • help - help text to be displayed when .help is entered (Optional).
    • \n
  • action - a function to execute, potentially taking in a string argument,\nwhen the command is invoked, bound to the REPLServer instance (Required).
    • \n
\n
If a function is provided instead of an object for cmd, it is treated as the\naction.
\n
Example of defining a command:
\n
// repl_test.js\nconst repl = require('repl');\n\nvar replServer = repl.start();\nreplServer.defineCommand('sayhello', {\n  help: 'Say hello',\n  action: function(name) {\n    this.write(`Hello, ${name}!\\n`);\n    this.displayPrompt();\n  }\n});\n
\n
Example of invoking that command from the REPL:
\n
> .sayhello Node.js User\nHello, Node.js User!\n
"
            },
            {
              "textRaw": "replServer.displayPrompt([preserveCursor])",
              "type": "method",
              "name": "displayPrompt",
              "meta": {
                "added": [
                  "v0.1.91"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`preserveCursor` {Boolean} ",
                      "name": "preserveCursor",
                      "type": "Boolean",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "preserveCursor",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Like readline.prompt except also adding indents with ellipses when inside\nblocks. The preserveCursor argument is passed to readline.prompt. This is\nused primarily with defineCommand. It's also used internally to render each\nprompt line.
\n"
            }
          ]
        }
      ],
      "methods": [
        {
          "textRaw": "repl.start(options)",
          "type": "method",
          "name": "start",
          "desc": "
Returns and starts a REPLServer instance, that inherits from\nReadline Interface. Accepts an "options" Object that takes\nthe following values:
\n
    \n
  • prompt - the prompt and stream for all I/O. Defaults to >.
    \n
    • \n
  • input - the readable stream to listen to. Defaults to process.stdin.
    \n
    • \n
  • output - the writable stream to write readline data to. Defaults to\nprocess.stdout.
    \n
    • \n
  • terminal - pass true if the stream should be treated like a TTY, and\nhave ANSI/VT100 escape codes written to it. Defaults to checking isTTY\non the output stream upon instantiation.
    \n
    • \n
  • eval - function that will be used to eval each given line. Defaults to\nan async wrapper for eval(). See below for an example of a custom eval.
    \n
    • \n
  • useColors - a boolean which specifies whether or not the writer function\nshould output colors. If a different writer function is set then this does\nnothing. Defaults to the repl's terminal value.
    \n
    • \n
  • useGlobal - if set to true, then the repl will use the global object,\ninstead of running scripts in a separate context. Defaults to false.
    \n
    • \n
  • ignoreUndefined - if set to true, then the repl will not output the\nreturn value of command if it's undefined. Defaults to false.
    \n
    • \n
  • writer - the function to invoke for each command that gets evaluated which\nreturns the formatting (including coloring) to display. Defaults to\nutil.inspect.
    \n
    • \n
  • replMode - controls whether the repl runs all commands in strict mode,\ndefault mode, or a hybrid mode ("magic" mode.) Acceptable values are:
    \n
      \n
    • repl.REPL_MODE_SLOPPY - run commands in sloppy mode.
      • \n
    • repl.REPL_MODE_STRICT - run commands in strict mode. This is equivalent to\nprefacing every repl statement with 'use strict'.
      • \n
    • repl.REPL_MODE_MAGIC - attempt to run commands in default mode. If they\nfail to parse, re-try in strict mode.
      • \n
    \n
    • \n
\n
You can use your own eval function if it has following signature:
\n
function eval(cmd, context, filename, callback) {\n  callback(null, result);\n}\n
On tab completion, eval will be called with .scope as an input string. It\nis expected to return an array of scope names to be used for the auto-completion.
\n
Multiple REPLs may be started against the same running instance of Node.js.  Each\nwill share the same global object but will have unique I/O.
\n
Here is an example that starts a REPL on stdin, a Unix socket, and a TCP socket:
\n
const net = require('net');\nconst repl = require('repl');\nvar connections = 0;\n\nrepl.start({\n  prompt: 'Node.js via stdin> ',\n  input: process.stdin,\n  output: process.stdout\n});\n\nnet.createServer((socket) => {\n  connections += 1;\n  repl.start({\n    prompt: 'Node.js via Unix socket> ',\n    input: socket,\n    output: socket\n  }).on('exit', () => {\n    socket.end();\n  })\n}).listen('/tmp/node-repl-sock');\n\nnet.createServer((socket) => {\n  connections += 1;\n  repl.start({\n    prompt: 'Node.js via TCP socket> ',\n    input: socket,\n    output: socket\n  }).on('exit', () => {\n    socket.end();\n  });\n}).listen(5001);\n
\n
Running this program from the command line will start a REPL on stdin.  Other\nREPL clients may connect through the Unix socket or TCP socket. telnet is useful\nfor connecting to TCP sockets, and socat can be used to connect to both Unix and\nTCP sockets.
\n
By starting a REPL from a Unix socket-based server instead of stdin, you can\nconnect to a long-running Node.js process without restarting it.
\n
For an example of running a "full-featured" (terminal) REPL over\na net.Server and net.Socket instance, see: https://gist.github.com/2209310
\n
For an example of running a REPL instance over curl(1),\nsee: https://gist.github.com/2053342
\n\n\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "options"
                }
              ]
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "REPL"
    },
    {
      "textRaw": "Stream",
      "name": "stream",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
A stream is an abstract interface implemented by various objects in\nNode.js. For example a request to an HTTP server is a\nstream, as is process.stdout. Streams are readable, writable, or both. All\nstreams are instances of EventEmitter.
\n
You can load the Stream base classes by doing require('stream').\nThere are base classes provided for Readable streams, Writable\nstreams, Duplex streams, and Transform streams.
\n
This document is split up into 3 sections:
\n
    \n
  1. The first section explains the parts of the API that you need to be\naware of to use streams in your programs.
    2. \n
  2. The second section explains the parts of the API that you need to\nuse if you implement your own custom streams yourself. The API is designed to\nmake this easy for you to do.
    3. \n
  3. The third section goes into more depth about how streams work,\nincluding some of the internal mechanisms and functions that you\nshould probably not modify unless you definitely know what you are\ndoing.
    4. \n
\n",
      "classes": [
        {
          "textRaw": "Class: stream.Duplex",
          "type": "class",
          "name": "stream.Duplex",
          "desc": "
Duplex streams are streams that implement both the Readable and\nWritable interfaces.
\n
Examples of Duplex streams include:
\n\n"
        },
        {
          "textRaw": "Class: stream.Readable",
          "type": "class",
          "name": "stream.Readable",
          "desc": "
The Readable stream interface is the abstraction for a source of\ndata that you are reading from. In other words, data comes out of a\nReadable stream.
\n
A Readable stream will not start emitting data until you indicate that\nyou are ready to receive it.
\n
Readable streams have two "modes": a flowing mode and a paused\nmode. When in flowing mode, data is read from the underlying system\nand provided to your program as fast as possible. In paused mode, you\nmust explicitly call stream.read() to get chunks of data out.\nStreams start out in paused mode.
\n
Note: If no data event handlers are attached, and there are no\nstream.pipe() destinations, and the stream is switched into flowing\nmode, then data will be lost.
\n
You can switch to flowing mode by doing any of the following:
\n\n
You can switch back to paused mode by doing either of the following:
\n
    \n
  • If there are no pipe destinations, by calling the\nstream.pause() method.
    • \n
  • If there are pipe destinations, by removing any 'data' event\nhandlers, and removing all pipe destinations by calling the\nstream.unpipe() method.
    • \n
\n
Note that, for backwards compatibility reasons, removing 'data'\nevent handlers will not automatically pause the stream. Also, if\nthere are piped destinations, then calling stream.pause() will\nnot guarantee that the stream will remain paused once those\ndestinations drain and ask for more data.
\n
Examples of readable streams include:
\n\n",
          "events": [
            {
              "textRaw": "Event: 'close'",
              "type": "event",
              "name": "close",
              "desc": "
Emitted when the stream and any of its underlying resources (a file\ndescriptor, for example) have been closed. The event indicates that\nno more events will be emitted, and no further computation will occur.
\n
Not all streams will emit the 'close' event as the 'close' event is\noptional.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'data'",
              "type": "event",
              "name": "data",
              "params": [],
              "desc": "
Attaching a 'data' event listener to a stream that has not been\nexplicitly paused will switch the stream into flowing mode. Data will\nthen be passed as soon as it is available.
\n
If you just want to get all the data out of the stream as fast as\npossible, this is the best way to do so.
\n
var readable = getReadableStreamSomehow();\nreadable.on('data', (chunk) => {\n  console.log('got %d bytes of data', chunk.length);\n});\n
\n"
            },
            {
              "textRaw": "Event: 'end'",
              "type": "event",
              "name": "end",
              "desc": "
This event fires when there will be no more data to read.
\n
Note that the 'end' event will not fire unless the data is\ncompletely consumed. This can be done by switching into flowing mode,\nor by calling stream.read() repeatedly until you get to the\nend.
\n
var readable = getReadableStreamSomehow();\nreadable.on('data', (chunk) => {\n  console.log('got %d bytes of data', chunk.length);\n});\nreadable.on('end', () => {\n  console.log('there will be no more data.');\n});\n
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'error'",
              "type": "event",
              "name": "error",
              "params": [],
              "desc": "
Emitted if there was an error receiving data.
\n"
            },
            {
              "textRaw": "Event: 'readable'",
              "type": "event",
              "name": "readable",
              "desc": "
When a chunk of data can be read from the stream, it will emit a\n'readable' event.
\n
In some cases, listening for a 'readable' event will cause some data\nto be read into the internal buffer from the underlying system, if it\nhadn't already.
\n
var readable = getReadableStreamSomehow();\nreadable.on('readable', () => {\n  // there is some data to read now\n});\n
\n
Once the internal buffer is drained, a 'readable' event will fire\nagain when more data is available.
\n
The 'readable' event is not emitted in the "flowing" mode with the\nsole exception of the last one, on end-of-stream.
\n
The 'readable' event indicates that the stream has new information:\neither new data is available or the end of the stream has been reached.\nIn the former case, stream.read() will return that data. In the\nlatter case, stream.read() will return null. For instance, in\nthe following example, foo.txt is an empty file:
\n
const fs = require('fs');\nvar rr = fs.createReadStream('foo.txt');\nrr.on('readable', () => {\n  console.log('readable:', rr.read());\n});\nrr.on('end', () => {\n  console.log('end');\n});\n
\n
The output of running this script is:
\n
$ node test.js\nreadable: null\nend\n
",
              "params": []
            }
          ],
          "methods": [
            {
              "textRaw": "readable.isPaused()",
              "type": "method",
              "name": "isPaused",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Boolean} ",
                    "name": "return",
                    "type": "Boolean"
                  },
                  "params": []
                },
                {
                  "params": []
                }
              ],
              "desc": "
This method returns whether or not the readable has been explicitly\npaused by client code (using stream.pause() without a\ncorresponding stream.resume()).
\n
var readable = new stream.Readable\n\nreadable.isPaused() // === false\nreadable.pause()\nreadable.isPaused() // === true\nreadable.resume()\nreadable.isPaused() // === false\n
\n"
            },
            {
              "textRaw": "readable.pause()",
              "type": "method",
              "name": "pause",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: `this` ",
                    "name": "return",
                    "desc": "`this`"
                  },
                  "params": []
                },
                {
                  "params": []
                }
              ],
              "desc": "
This method will cause a stream in flowing mode to stop emitting\n'data' events, switching out of flowing mode. Any data that becomes\navailable will remain in the internal buffer.
\n
var readable = getReadableStreamSomehow();\nreadable.on('data', (chunk) => {\n  console.log('got %d bytes of data', chunk.length);\n  readable.pause();\n  console.log('there will be no more data for 1 second');\n  setTimeout(() => {\n    console.log('now data will start flowing again');\n    readable.resume();\n  }, 1000);\n});\n
\n"
            },
            {
              "textRaw": "readable.pipe(destination[, options])",
              "type": "method",
              "name": "pipe",
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`destination` {stream.Writable} The destination for writing data ",
                      "name": "destination",
                      "type": "stream.Writable",
                      "desc": "The destination for writing data"
                    },
                    {
                      "textRaw": "`options` {Object} Pipe options ",
                      "options": [
                        {
                          "textRaw": "`end` {Boolean} End the writer when the reader ends. Default = `true` ",
                          "name": "end",
                          "type": "Boolean",
                          "desc": "End the writer when the reader ends. Default = `true`"
                        }
                      ],
                      "name": "options",
                      "type": "Object",
                      "desc": "Pipe options",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "destination"
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
This method pulls all the data out of a readable stream, and writes it\nto the supplied destination, automatically managing the flow so that\nthe destination is not overwhelmed by a fast readable stream.
\n
Multiple destinations can be piped to safely.
\n
var readable = getReadableStreamSomehow();\nvar writable = fs.createWriteStream('file.txt');\n// All the data from readable goes into 'file.txt'\nreadable.pipe(writable);\n
\n
This function returns the destination stream, so you can set up pipe\nchains like so:
\n
var r = fs.createReadStream('file.txt');\nvar z = zlib.createGzip();\nvar w = fs.createWriteStream('file.txt.gz');\nr.pipe(z).pipe(w);\n
\n
For example, emulating the Unix cat command:
\n
process.stdin.pipe(process.stdout);\n
\n
By default stream.end() is called on the destination when the\nsource stream emits 'end', so that destination is no longer writable.\nPass { end: false } as options to keep the destination stream open.
\n
This keeps writer open so that "Goodbye" can be written at the\nend.
\n
reader.pipe(writer, { end: false });\nreader.on('end', () => {\n  writer.end('Goodbye\\n');\n});\n
\n
Note that process.stderr and process.stdout are never closed until\nthe process exits, regardless of the specified options.
\n"
            },
            {
              "textRaw": "readable.read([size])",
              "type": "method",
              "name": "read",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Return {String|Buffer|Null} ",
                    "name": "return",
                    "type": "String|Buffer|Null"
                  },
                  "params": [
                    {
                      "textRaw": "`size` {Number} Optional argument to specify how much data to read. ",
                      "name": "size",
                      "type": "Number",
                      "desc": "Optional argument to specify how much data to read.",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "size",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
The read() method pulls some data out of the internal buffer and\nreturns it. If there is no data available, then it will return\nnull.
\n
If you pass in a size argument, then it will return that many\nbytes. If size bytes are not available, then it will return null,\nunless we've ended, in which case it will return the data remaining\nin the buffer.
\n
If you do not specify a size argument, then it will return all the\ndata in the internal buffer.
\n
This method should only be called in paused mode. In flowing mode,\nthis method is called automatically until the internal buffer is\ndrained.
\n
var readable = getReadableStreamSomehow();\nreadable.on('readable', () => {\n  var chunk;\n  while (null !== (chunk = readable.read())) {\n    console.log('got %d bytes of data', chunk.length);\n  }\n});\n
\n
If this method returns a data chunk, then it will also trigger the\nemission of a 'data' event.
\n
Note that calling stream.read([size]) after the 'end'\nevent has been triggered will return null. No runtime error will be raised.
\n"
            },
            {
              "textRaw": "readable.resume()",
              "type": "method",
              "name": "resume",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: `this` ",
                    "name": "return",
                    "desc": "`this`"
                  },
                  "params": []
                },
                {
                  "params": []
                }
              ],
              "desc": "
This method will cause the readable stream to resume emitting 'data'\nevents.
\n
This method will switch the stream into flowing mode. If you do not\nwant to consume the data from a stream, but you do want to get to\nits 'end' event, you can call stream.resume() to open\nthe flow of data.
\n
var readable = getReadableStreamSomehow();\nreadable.resume();\nreadable.on('end', () => {\n  console.log('got to the end, but did not read anything');\n});\n
\n"
            },
            {
              "textRaw": "readable.setEncoding(encoding)",
              "type": "method",
              "name": "setEncoding",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: `this` ",
                    "name": "return",
                    "desc": "`this`"
                  },
                  "params": [
                    {
                      "textRaw": "`encoding` {String} The encoding to use. ",
                      "name": "encoding",
                      "type": "String",
                      "desc": "The encoding to use."
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "encoding"
                    }
                  ]
                }
              ],
              "desc": "
Call this function to cause the stream to return strings of the specified\nencoding instead of Buffer objects. For example, if you do\nreadable.setEncoding('utf8'), then the output data will be interpreted as\nUTF-8 data, and returned as strings. If you do readable.setEncoding('hex'),\nthen the data will be encoded in hexadecimal string format.
\n
This properly handles multi-byte characters that would otherwise be\npotentially mangled if you simply pulled the Buffers directly and\ncalled buf.toString(encoding) on them. If you want to read the data\nas strings, always use this method.
\n
Also you can disable any encoding at all with readable.setEncoding(null).\nThis approach is very useful if you deal with binary data or with large\nmulti-byte strings spread out over multiple chunks.
\n
var readable = getReadableStreamSomehow();\nreadable.setEncoding('utf8');\nreadable.on('data', (chunk) => {\n  assert.equal(typeof chunk, 'string');\n  console.log('got %d characters of string data', chunk.length);\n});\n
\n"
            },
            {
              "textRaw": "readable.unpipe([destination])",
              "type": "method",
              "name": "unpipe",
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`destination` {stream.Writable} Optional specific stream to unpipe ",
                      "name": "destination",
                      "type": "stream.Writable",
                      "desc": "Optional specific stream to unpipe",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "destination",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
This method will remove the hooks set up for a previous stream.pipe()\ncall.
\n
If the destination is not specified, then all pipes are removed.
\n
If the destination is specified, but no pipe is set up for it, then\nthis is a no-op.
\n
var readable = getReadableStreamSomehow();\nvar writable = fs.createWriteStream('file.txt');\n// All the data from readable goes into 'file.txt',\n// but only for the first second\nreadable.pipe(writable);\nsetTimeout(() => {\n  console.log('stop writing to file.txt');\n  readable.unpipe(writable);\n  console.log('manually close the file stream');\n  writable.end();\n}, 1000);\n
\n"
            },
            {
              "textRaw": "readable.unshift(chunk)",
              "type": "method",
              "name": "unshift",
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`chunk` {Buffer|String} Chunk of data to unshift onto the read queue ",
                      "name": "chunk",
                      "type": "Buffer|String",
                      "desc": "Chunk of data to unshift onto the read queue"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "chunk"
                    }
                  ]
                }
              ],
              "desc": "
This is useful in certain cases where a stream is being consumed by a\nparser, which needs to "un-consume" some data that it has\noptimistically pulled out of the source, so that the stream can be\npassed on to some other party.
\n
Note that stream.unshift(chunk) cannot be called after the 'end' event\nhas been triggered; a runtime error will be raised.
\n
If you find that you must often call stream.unshift(chunk) in your\nprograms, consider implementing a Transform stream instead. (See API\nfor Stream Implementors.)
\n
// Pull off a header delimited by \\n\\n\n// use unshift() if we get too much\n// Call the callback with (error, header, stream)\nconst StringDecoder = require('string_decoder').StringDecoder;\nfunction parseHeader(stream, callback) {\n  stream.on('error', callback);\n  stream.on('readable', onReadable);\n  var decoder = new StringDecoder('utf8');\n  var header = '';\n  function onReadable() {\n    var chunk;\n    while (null !== (chunk = stream.read())) {\n      var str = decoder.write(chunk);\n      if (str.match(/\\n\\n/)) {\n        // found the header boundary\n        var split = str.split(/\\n\\n/);\n        header += split.shift();\n        var remaining = split.join('\\n\\n');\n        var buf = new Buffer(remaining, 'utf8');\n        if (buf.length)\n          stream.unshift(buf);\n        stream.removeListener('error', callback);\n        stream.removeListener('readable', onReadable);\n        // now the body of the message can be read from the stream.\n        callback(null, header, stream);\n      } else {\n        // still reading the header.\n        header += str;\n      }\n    }\n  }\n}\n
\n
Note that, unlike stream.push(chunk), stream.unshift(chunk)\nwill not end the reading process by resetting the internal reading state of the\nstream. This can cause unexpected results if unshift() is called during a\nread (i.e. from within a stream._read() implementation on a\ncustom stream). Following the call to unshift() with an immediate\nstream.push('') will reset the reading state appropriately,\nhowever it is best to simply avoid calling unshift() while in the process of\nperforming a read.
\n"
            },
            {
              "textRaw": "readable.wrap(stream)",
              "type": "method",
              "name": "wrap",
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`stream` {Stream} An \"old style\" readable stream ",
                      "name": "stream",
                      "type": "Stream",
                      "desc": "An \"old style\" readable stream"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "stream"
                    }
                  ]
                }
              ],
              "desc": "
Versions of Node.js prior to v0.10 had streams that did not implement the\nentire Streams API as it is today. (See Compatibility for\nmore information.)
\n
If you are using an older Node.js library that emits 'data' events and\nhas a stream.pause() method that is advisory only, then you\ncan use the wrap() method to create a Readable stream that uses the old\nstream as its data source.
\n
You will very rarely ever need to call this function, but it exists\nas a convenience for interacting with old Node.js programs and libraries.
\n
For example:
\n
const OldReader = require('./old-api-module.js').OldReader;\nconst Readable = require('stream').Readable;\nconst oreader = new OldReader;\nconst myReader = new Readable().wrap(oreader);\n\nmyReader.on('readable', () => {\n  myReader.read(); // etc.\n});\n
\n"
            }
          ]
        },
        {
          "textRaw": "Class: stream.Transform",
          "type": "class",
          "name": "stream.Transform",
          "desc": "
Transform streams are Duplex streams where the output is in some way\ncomputed from the input. They implement both the Readable and\nWritable interfaces.
\n
Examples of Transform streams include:
\n\n"
        },
        {
          "textRaw": "Class: stream.Writable",
          "type": "class",
          "name": "stream.Writable",
          "desc": "
The Writable stream interface is an abstraction for a destination\nthat you are writing data to.
\n
Examples of writable streams include:
\n\n",
          "events": [
            {
              "textRaw": "Event: 'close'",
              "type": "event",
              "name": "close",
              "desc": "
Emitted when the stream and any of its underlying resources (a file descriptor,\nfor example) have been closed. The event indicates that no more events will be\nemitted, and no further computation will occur.
\n
Not all streams will emit the 'close' event as the 'close' event is\noptional.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'drain'",
              "type": "event",
              "name": "drain",
              "desc": "
If a stream.write(chunk) call returns false, then the\n'drain' event will indicate when it is appropriate to begin writing more data\nto the stream.
\n
// Write the data to the supplied writable stream one million times.\n// Be attentive to back-pressure.\nfunction writeOneMillionTimes(writer, data, encoding, callback) {\n  var i = 1000000;\n  write();\n  function write() {\n    var ok = true;\n    do {\n      i -= 1;\n      if (i === 0) {\n        // last time!\n        writer.write(data, encoding, callback);\n      } else {\n        // see if we should continue, or wait\n        // don't pass the callback, because we're not done yet.\n        ok = writer.write(data, encoding);\n      }\n    } while (i > 0 && ok);\n    if (i > 0) {\n      // had to stop early!\n      // write some more once it drains\n      writer.once('drain', write);\n    }\n  }\n}\n
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'error'",
              "type": "event",
              "name": "error",
              "params": [],
              "desc": "
Emitted if there was an error when writing or piping data.
\n"
            },
            {
              "textRaw": "Event: 'finish'",
              "type": "event",
              "name": "finish",
              "desc": "
When the stream.end() method has been called, and all data has\nbeen flushed to the underlying system, this event is emitted.
\n
var writer = getWritableStreamSomehow();\nfor (var i = 0; i < 100; i ++) {\n  writer.write('hello, #${i}!\\n');\n}\nwriter.end('this is the end\\n');\nwriter.on('finish', () => {\n  console.error('all writes are now complete.');\n});\n
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'pipe'",
              "type": "event",
              "name": "pipe",
              "params": [],
              "desc": "
This is emitted whenever the stream.pipe() method is called on a readable\nstream, adding this writable to its set of destinations.
\n
var writer = getWritableStreamSomehow();\nvar reader = getReadableStreamSomehow();\nwriter.on('pipe', (src) => {\n  console.error('something is piping into the writer');\n  assert.equal(src, reader);\n});\nreader.pipe(writer);\n
\n"
            },
            {
              "textRaw": "Event: 'unpipe'",
              "type": "event",
              "name": "unpipe",
              "params": [],
              "desc": "
This is emitted whenever the stream.unpipe() method is called on a\nreadable stream, removing this writable from its set of destinations.
\n
var writer = getWritableStreamSomehow();\nvar reader = getReadableStreamSomehow();\nwriter.on('unpipe', (src) => {\n  console.error('something has stopped piping into the writer');\n  assert.equal(src, reader);\n});\nreader.pipe(writer);\nreader.unpipe(writer);\n
\n"
            }
          ],
          "methods": [
            {
              "textRaw": "writable.cork()",
              "type": "method",
              "name": "cork",
              "desc": "
Forces buffering of all writes.
\n
Buffered data will be flushed either at stream.uncork() or at\nstream.end() call.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "writable.end([chunk][, encoding][, callback])",
              "type": "method",
              "name": "end",
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`chunk` {String|Buffer} Optional data to write ",
                      "name": "chunk",
                      "type": "String|Buffer",
                      "desc": "Optional data to write",
                      "optional": true
                    },
                    {
                      "textRaw": "`encoding` {String} The encoding, if `chunk` is a String ",
                      "name": "encoding",
                      "type": "String",
                      "desc": "The encoding, if `chunk` is a String",
                      "optional": true
                    },
                    {
                      "textRaw": "`callback` {Function} Optional callback for when the stream is finished ",
                      "name": "callback",
                      "type": "Function",
                      "desc": "Optional callback for when the stream is finished",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "chunk",
                      "optional": true
                    },
                    {
                      "name": "encoding",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Call this method when no more data will be written to the stream. If supplied,\nthe callback is attached as a listener on the 'finish' event.
\n
Calling stream.write() after calling\nstream.end() will raise an error.
\n
// write 'hello, ' and then end with 'world!'\nvar file = fs.createWriteStream('example.txt');\nfile.write('hello, ');\nfile.end('world!');\n// writing more now is not allowed!\n
\n"
            },
            {
              "textRaw": "writable.setDefaultEncoding(encoding)",
              "type": "method",
              "name": "setDefaultEncoding",
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`encoding` {String} The new default encoding ",
                      "name": "encoding",
                      "type": "String",
                      "desc": "The new default encoding"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "encoding"
                    }
                  ]
                }
              ],
              "desc": "
Sets the default encoding for a writable stream.
\n"
            },
            {
              "textRaw": "writable.uncork()",
              "type": "method",
              "name": "uncork",
              "desc": "
Flush all data, buffered since stream.cork() call.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "writable.write(chunk[, encoding][, callback])",
              "type": "method",
              "name": "write",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Boolean} `true` if the data was handled completely. ",
                    "name": "return",
                    "type": "Boolean",
                    "desc": "`true` if the data was handled completely."
                  },
                  "params": [
                    {
                      "textRaw": "`chunk` {String|Buffer} The data to write ",
                      "name": "chunk",
                      "type": "String|Buffer",
                      "desc": "The data to write"
                    },
                    {
                      "textRaw": "`encoding` {String} The encoding, if `chunk` is a String ",
                      "name": "encoding",
                      "type": "String",
                      "desc": "The encoding, if `chunk` is a String",
                      "optional": true
                    },
                    {
                      "textRaw": "`callback` {Function} Callback for when this chunk of data is flushed ",
                      "name": "callback",
                      "type": "Function",
                      "desc": "Callback for when this chunk of data is flushed",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "chunk"
                    },
                    {
                      "name": "encoding",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
This method writes some data to the underlying system, and calls the\nsupplied callback once the data has been fully handled.  If an error\noccurs, the callback may or may not be called with the error as its\nfirst argument.  To detect write errors, listen for the 'error' event.
\n
The return value indicates if you should continue writing right now.\nIf the data had to be buffered internally, then it will return\nfalse. Otherwise, it will return true.
\n
This return value is strictly advisory. You MAY continue to write,\neven if it returns false. However, writes will be buffered in\nmemory, so it is best not to do this excessively. Instead, wait for\nthe 'drain' event before writing more data.
\n"
            }
          ]
        }
      ],
      "miscs": [
        {
          "textRaw": "API for Stream Consumers",
          "name": "API for Stream Consumers",
          "type": "misc",
          "desc": "
Streams can be either Readable, Writable, or both (Duplex).
\n
All streams are EventEmitters, but they also have other custom methods\nand properties depending on whether they are Readable, Writable, or\nDuplex.
\n
If a stream is both Readable and Writable, then it implements all of\nthe methods and events. So, a Duplex or Transform stream is\nfully described by this API, though their implementation may be\nsomewhat different.
\n
It is not necessary to implement Stream interfaces in order to consume\nstreams in your programs. If you are implementing streaming\ninterfaces in your own program, please also refer to\nAPI for Stream Implementors.
\n
Almost all Node.js programs, no matter how simple, use Streams in some\nway. Here is an example of using Streams in an Node.js program:
\n
const http = require('http');\n\nvar server = http.createServer( (req, res) => {\n  // req is an http.IncomingMessage, which is a Readable Stream\n  // res is an http.ServerResponse, which is a Writable Stream\n\n  var body = '';\n  // we want to get the data as utf8 strings\n  // If you don't set an encoding, then you'll get Buffer objects\n  req.setEncoding('utf8');\n\n  // Readable streams emit 'data' events once a listener is added\n  req.on('data', (chunk) => {\n    body += chunk;\n  });\n\n  // the end event tells you that you have entire body\n  req.on('end', () => {\n    try {\n      const data = JSON.parse(body);\n      // write back something interesting to the user:\n      res.write(typeof data);\n      res.end();\n    } catch (er) {\n      // uh oh!  bad json!\n      res.statusCode = 400;\n      return res.end(`error: ${er.message}`);\n    }\n  });\n});\n\nserver.listen(1337);\n\n// $ curl localhost:1337 -d '{}'\n// object\n// $ curl localhost:1337 -d '"foo"'\n// string\n// $ curl localhost:1337 -d 'not json'\n// error: Unexpected token o\n
\n",
          "classes": [
            {
              "textRaw": "Class: stream.Duplex",
              "type": "class",
              "name": "stream.Duplex",
              "desc": "
Duplex streams are streams that implement both the Readable and\nWritable interfaces.
\n
Examples of Duplex streams include:
\n\n"
            },
            {
              "textRaw": "Class: stream.Readable",
              "type": "class",
              "name": "stream.Readable",
              "desc": "
The Readable stream interface is the abstraction for a source of\ndata that you are reading from. In other words, data comes out of a\nReadable stream.
\n
A Readable stream will not start emitting data until you indicate that\nyou are ready to receive it.
\n
Readable streams have two "modes": a flowing mode and a paused\nmode. When in flowing mode, data is read from the underlying system\nand provided to your program as fast as possible. In paused mode, you\nmust explicitly call stream.read() to get chunks of data out.\nStreams start out in paused mode.
\n
Note: If no data event handlers are attached, and there are no\nstream.pipe() destinations, and the stream is switched into flowing\nmode, then data will be lost.
\n
You can switch to flowing mode by doing any of the following:
\n\n
You can switch back to paused mode by doing either of the following:
\n
    \n
  • If there are no pipe destinations, by calling the\nstream.pause() method.
    • \n
  • If there are pipe destinations, by removing any 'data' event\nhandlers, and removing all pipe destinations by calling the\nstream.unpipe() method.
    • \n
\n
Note that, for backwards compatibility reasons, removing 'data'\nevent handlers will not automatically pause the stream. Also, if\nthere are piped destinations, then calling stream.pause() will\nnot guarantee that the stream will remain paused once those\ndestinations drain and ask for more data.
\n
Examples of readable streams include:
\n\n",
              "events": [
                {
                  "textRaw": "Event: 'close'",
                  "type": "event",
                  "name": "close",
                  "desc": "
Emitted when the stream and any of its underlying resources (a file\ndescriptor, for example) have been closed. The event indicates that\nno more events will be emitted, and no further computation will occur.
\n
Not all streams will emit the 'close' event as the 'close' event is\noptional.
\n",
                  "params": []
                },
                {
                  "textRaw": "Event: 'data'",
                  "type": "event",
                  "name": "data",
                  "params": [],
                  "desc": "
Attaching a 'data' event listener to a stream that has not been\nexplicitly paused will switch the stream into flowing mode. Data will\nthen be passed as soon as it is available.
\n
If you just want to get all the data out of the stream as fast as\npossible, this is the best way to do so.
\n
var readable = getReadableStreamSomehow();\nreadable.on('data', (chunk) => {\n  console.log('got %d bytes of data', chunk.length);\n});\n
\n"
                },
                {
                  "textRaw": "Event: 'end'",
                  "type": "event",
                  "name": "end",
                  "desc": "
This event fires when there will be no more data to read.
\n
Note that the 'end' event will not fire unless the data is\ncompletely consumed. This can be done by switching into flowing mode,\nor by calling stream.read() repeatedly until you get to the\nend.
\n
var readable = getReadableStreamSomehow();\nreadable.on('data', (chunk) => {\n  console.log('got %d bytes of data', chunk.length);\n});\nreadable.on('end', () => {\n  console.log('there will be no more data.');\n});\n
\n",
                  "params": []
                },
                {
                  "textRaw": "Event: 'error'",
                  "type": "event",
                  "name": "error",
                  "params": [],
                  "desc": "
Emitted if there was an error receiving data.
\n"
                },
                {
                  "textRaw": "Event: 'readable'",
                  "type": "event",
                  "name": "readable",
                  "desc": "
When a chunk of data can be read from the stream, it will emit a\n'readable' event.
\n
In some cases, listening for a 'readable' event will cause some data\nto be read into the internal buffer from the underlying system, if it\nhadn't already.
\n
var readable = getReadableStreamSomehow();\nreadable.on('readable', () => {\n  // there is some data to read now\n});\n
\n
Once the internal buffer is drained, a 'readable' event will fire\nagain when more data is available.
\n
The 'readable' event is not emitted in the "flowing" mode with the\nsole exception of the last one, on end-of-stream.
\n
The 'readable' event indicates that the stream has new information:\neither new data is available or the end of the stream has been reached.\nIn the former case, stream.read() will return that data. In the\nlatter case, stream.read() will return null. For instance, in\nthe following example, foo.txt is an empty file:
\n
const fs = require('fs');\nvar rr = fs.createReadStream('foo.txt');\nrr.on('readable', () => {\n  console.log('readable:', rr.read());\n});\nrr.on('end', () => {\n  console.log('end');\n});\n
\n
The output of running this script is:
\n
$ node test.js\nreadable: null\nend\n
",
                  "params": []
                }
              ],
              "methods": [
                {
                  "textRaw": "readable.isPaused()",
                  "type": "method",
                  "name": "isPaused",
                  "signatures": [
                    {
                      "return": {
                        "textRaw": "Returns: {Boolean} ",
                        "name": "return",
                        "type": "Boolean"
                      },
                      "params": []
                    },
                    {
                      "params": []
                    }
                  ],
                  "desc": "
This method returns whether or not the readable has been explicitly\npaused by client code (using stream.pause() without a\ncorresponding stream.resume()).
\n
var readable = new stream.Readable\n\nreadable.isPaused() // === false\nreadable.pause()\nreadable.isPaused() // === true\nreadable.resume()\nreadable.isPaused() // === false\n
\n"
                },
                {
                  "textRaw": "readable.pause()",
                  "type": "method",
                  "name": "pause",
                  "signatures": [
                    {
                      "return": {
                        "textRaw": "Returns: `this` ",
                        "name": "return",
                        "desc": "`this`"
                      },
                      "params": []
                    },
                    {
                      "params": []
                    }
                  ],
                  "desc": "
This method will cause a stream in flowing mode to stop emitting\n'data' events, switching out of flowing mode. Any data that becomes\navailable will remain in the internal buffer.
\n
var readable = getReadableStreamSomehow();\nreadable.on('data', (chunk) => {\n  console.log('got %d bytes of data', chunk.length);\n  readable.pause();\n  console.log('there will be no more data for 1 second');\n  setTimeout(() => {\n    console.log('now data will start flowing again');\n    readable.resume();\n  }, 1000);\n});\n
\n"
                },
                {
                  "textRaw": "readable.pipe(destination[, options])",
                  "type": "method",
                  "name": "pipe",
                  "signatures": [
                    {
                      "params": [
                        {
                          "textRaw": "`destination` {stream.Writable} The destination for writing data ",
                          "name": "destination",
                          "type": "stream.Writable",
                          "desc": "The destination for writing data"
                        },
                        {
                          "textRaw": "`options` {Object} Pipe options ",
                          "options": [
                            {
                              "textRaw": "`end` {Boolean} End the writer when the reader ends. Default = `true` ",
                              "name": "end",
                              "type": "Boolean",
                              "desc": "End the writer when the reader ends. Default = `true`"
                            }
                          ],
                          "name": "options",
                          "type": "Object",
                          "desc": "Pipe options",
                          "optional": true
                        }
                      ]
                    },
                    {
                      "params": [
                        {
                          "name": "destination"
                        },
                        {
                          "name": "options",
                          "optional": true
                        }
                      ]
                    }
                  ],
                  "desc": "
This method pulls all the data out of a readable stream, and writes it\nto the supplied destination, automatically managing the flow so that\nthe destination is not overwhelmed by a fast readable stream.
\n
Multiple destinations can be piped to safely.
\n
var readable = getReadableStreamSomehow();\nvar writable = fs.createWriteStream('file.txt');\n// All the data from readable goes into 'file.txt'\nreadable.pipe(writable);\n
\n
This function returns the destination stream, so you can set up pipe\nchains like so:
\n
var r = fs.createReadStream('file.txt');\nvar z = zlib.createGzip();\nvar w = fs.createWriteStream('file.txt.gz');\nr.pipe(z).pipe(w);\n
\n
For example, emulating the Unix cat command:
\n
process.stdin.pipe(process.stdout);\n
\n
By default stream.end() is called on the destination when the\nsource stream emits 'end', so that destination is no longer writable.\nPass { end: false } as options to keep the destination stream open.
\n
This keeps writer open so that "Goodbye" can be written at the\nend.
\n
reader.pipe(writer, { end: false });\nreader.on('end', () => {\n  writer.end('Goodbye\\n');\n});\n
\n
Note that process.stderr and process.stdout are never closed until\nthe process exits, regardless of the specified options.
\n"
                },
                {
                  "textRaw": "readable.read([size])",
                  "type": "method",
                  "name": "read",
                  "signatures": [
                    {
                      "return": {
                        "textRaw": "Return {String|Buffer|Null} ",
                        "name": "return",
                        "type": "String|Buffer|Null"
                      },
                      "params": [
                        {
                          "textRaw": "`size` {Number} Optional argument to specify how much data to read. ",
                          "name": "size",
                          "type": "Number",
                          "desc": "Optional argument to specify how much data to read.",
                          "optional": true
                        }
                      ]
                    },
                    {
                      "params": [
                        {
                          "name": "size",
                          "optional": true
                        }
                      ]
                    }
                  ],
                  "desc": "
The read() method pulls some data out of the internal buffer and\nreturns it. If there is no data available, then it will return\nnull.
\n
If you pass in a size argument, then it will return that many\nbytes. If size bytes are not available, then it will return null,\nunless we've ended, in which case it will return the data remaining\nin the buffer.
\n
If you do not specify a size argument, then it will return all the\ndata in the internal buffer.
\n
This method should only be called in paused mode. In flowing mode,\nthis method is called automatically until the internal buffer is\ndrained.
\n
var readable = getReadableStreamSomehow();\nreadable.on('readable', () => {\n  var chunk;\n  while (null !== (chunk = readable.read())) {\n    console.log('got %d bytes of data', chunk.length);\n  }\n});\n
\n
If this method returns a data chunk, then it will also trigger the\nemission of a 'data' event.
\n
Note that calling stream.read([size]) after the 'end'\nevent has been triggered will return null. No runtime error will be raised.
\n"
                },
                {
                  "textRaw": "readable.resume()",
                  "type": "method",
                  "name": "resume",
                  "signatures": [
                    {
                      "return": {
                        "textRaw": "Returns: `this` ",
                        "name": "return",
                        "desc": "`this`"
                      },
                      "params": []
                    },
                    {
                      "params": []
                    }
                  ],
                  "desc": "
This method will cause the readable stream to resume emitting 'data'\nevents.
\n
This method will switch the stream into flowing mode. If you do not\nwant to consume the data from a stream, but you do want to get to\nits 'end' event, you can call stream.resume() to open\nthe flow of data.
\n
var readable = getReadableStreamSomehow();\nreadable.resume();\nreadable.on('end', () => {\n  console.log('got to the end, but did not read anything');\n});\n
\n"
                },
                {
                  "textRaw": "readable.setEncoding(encoding)",
                  "type": "method",
                  "name": "setEncoding",
                  "signatures": [
                    {
                      "return": {
                        "textRaw": "Returns: `this` ",
                        "name": "return",
                        "desc": "`this`"
                      },
                      "params": [
                        {
                          "textRaw": "`encoding` {String} The encoding to use. ",
                          "name": "encoding",
                          "type": "String",
                          "desc": "The encoding to use."
                        }
                      ]
                    },
                    {
                      "params": [
                        {
                          "name": "encoding"
                        }
                      ]
                    }
                  ],
                  "desc": "
Call this function to cause the stream to return strings of the specified\nencoding instead of Buffer objects. For example, if you do\nreadable.setEncoding('utf8'), then the output data will be interpreted as\nUTF-8 data, and returned as strings. If you do readable.setEncoding('hex'),\nthen the data will be encoded in hexadecimal string format.
\n
This properly handles multi-byte characters that would otherwise be\npotentially mangled if you simply pulled the Buffers directly and\ncalled buf.toString(encoding) on them. If you want to read the data\nas strings, always use this method.
\n
Also you can disable any encoding at all with readable.setEncoding(null).\nThis approach is very useful if you deal with binary data or with large\nmulti-byte strings spread out over multiple chunks.
\n
var readable = getReadableStreamSomehow();\nreadable.setEncoding('utf8');\nreadable.on('data', (chunk) => {\n  assert.equal(typeof chunk, 'string');\n  console.log('got %d characters of string data', chunk.length);\n});\n
\n"
                },
                {
                  "textRaw": "readable.unpipe([destination])",
                  "type": "method",
                  "name": "unpipe",
                  "signatures": [
                    {
                      "params": [
                        {
                          "textRaw": "`destination` {stream.Writable} Optional specific stream to unpipe ",
                          "name": "destination",
                          "type": "stream.Writable",
                          "desc": "Optional specific stream to unpipe",
                          "optional": true
                        }
                      ]
                    },
                    {
                      "params": [
                        {
                          "name": "destination",
                          "optional": true
                        }
                      ]
                    }
                  ],
                  "desc": "
This method will remove the hooks set up for a previous stream.pipe()\ncall.
\n
If the destination is not specified, then all pipes are removed.
\n
If the destination is specified, but no pipe is set up for it, then\nthis is a no-op.
\n
var readable = getReadableStreamSomehow();\nvar writable = fs.createWriteStream('file.txt');\n// All the data from readable goes into 'file.txt',\n// but only for the first second\nreadable.pipe(writable);\nsetTimeout(() => {\n  console.log('stop writing to file.txt');\n  readable.unpipe(writable);\n  console.log('manually close the file stream');\n  writable.end();\n}, 1000);\n
\n"
                },
                {
                  "textRaw": "readable.unshift(chunk)",
                  "type": "method",
                  "name": "unshift",
                  "signatures": [
                    {
                      "params": [
                        {
                          "textRaw": "`chunk` {Buffer|String} Chunk of data to unshift onto the read queue ",
                          "name": "chunk",
                          "type": "Buffer|String",
                          "desc": "Chunk of data to unshift onto the read queue"
                        }
                      ]
                    },
                    {
                      "params": [
                        {
                          "name": "chunk"
                        }
                      ]
                    }
                  ],
                  "desc": "
This is useful in certain cases where a stream is being consumed by a\nparser, which needs to "un-consume" some data that it has\noptimistically pulled out of the source, so that the stream can be\npassed on to some other party.
\n
Note that stream.unshift(chunk) cannot be called after the 'end' event\nhas been triggered; a runtime error will be raised.
\n
If you find that you must often call stream.unshift(chunk) in your\nprograms, consider implementing a Transform stream instead. (See API\nfor Stream Implementors.)
\n
// Pull off a header delimited by \\n\\n\n// use unshift() if we get too much\n// Call the callback with (error, header, stream)\nconst StringDecoder = require('string_decoder').StringDecoder;\nfunction parseHeader(stream, callback) {\n  stream.on('error', callback);\n  stream.on('readable', onReadable);\n  var decoder = new StringDecoder('utf8');\n  var header = '';\n  function onReadable() {\n    var chunk;\n    while (null !== (chunk = stream.read())) {\n      var str = decoder.write(chunk);\n      if (str.match(/\\n\\n/)) {\n        // found the header boundary\n        var split = str.split(/\\n\\n/);\n        header += split.shift();\n        var remaining = split.join('\\n\\n');\n        var buf = new Buffer(remaining, 'utf8');\n        if (buf.length)\n          stream.unshift(buf);\n        stream.removeListener('error', callback);\n        stream.removeListener('readable', onReadable);\n        // now the body of the message can be read from the stream.\n        callback(null, header, stream);\n      } else {\n        // still reading the header.\n        header += str;\n      }\n    }\n  }\n}\n
\n
Note that, unlike stream.push(chunk), stream.unshift(chunk)\nwill not end the reading process by resetting the internal reading state of the\nstream. This can cause unexpected results if unshift() is called during a\nread (i.e. from within a stream._read() implementation on a\ncustom stream). Following the call to unshift() with an immediate\nstream.push('') will reset the reading state appropriately,\nhowever it is best to simply avoid calling unshift() while in the process of\nperforming a read.
\n"
                },
                {
                  "textRaw": "readable.wrap(stream)",
                  "type": "method",
                  "name": "wrap",
                  "signatures": [
                    {
                      "params": [
                        {
                          "textRaw": "`stream` {Stream} An \"old style\" readable stream ",
                          "name": "stream",
                          "type": "Stream",
                          "desc": "An \"old style\" readable stream"
                        }
                      ]
                    },
                    {
                      "params": [
                        {
                          "name": "stream"
                        }
                      ]
                    }
                  ],
                  "desc": "
Versions of Node.js prior to v0.10 had streams that did not implement the\nentire Streams API as it is today. (See Compatibility for\nmore information.)
\n
If you are using an older Node.js library that emits 'data' events and\nhas a stream.pause() method that is advisory only, then you\ncan use the wrap() method to create a Readable stream that uses the old\nstream as its data source.
\n
You will very rarely ever need to call this function, but it exists\nas a convenience for interacting with old Node.js programs and libraries.
\n
For example:
\n
const OldReader = require('./old-api-module.js').OldReader;\nconst Readable = require('stream').Readable;\nconst oreader = new OldReader;\nconst myReader = new Readable().wrap(oreader);\n\nmyReader.on('readable', () => {\n  myReader.read(); // etc.\n});\n
\n"
                }
              ]
            },
            {
              "textRaw": "Class: stream.Transform",
              "type": "class",
              "name": "stream.Transform",
              "desc": "
Transform streams are Duplex streams where the output is in some way\ncomputed from the input. They implement both the Readable and\nWritable interfaces.
\n
Examples of Transform streams include:
\n\n"
            },
            {
              "textRaw": "Class: stream.Writable",
              "type": "class",
              "name": "stream.Writable",
              "desc": "
The Writable stream interface is an abstraction for a destination\nthat you are writing data to.
\n
Examples of writable streams include:
\n\n",
              "events": [
                {
                  "textRaw": "Event: 'close'",
                  "type": "event",
                  "name": "close",
                  "desc": "
Emitted when the stream and any of its underlying resources (a file descriptor,\nfor example) have been closed. The event indicates that no more events will be\nemitted, and no further computation will occur.
\n
Not all streams will emit the 'close' event as the 'close' event is\noptional.
\n",
                  "params": []
                },
                {
                  "textRaw": "Event: 'drain'",
                  "type": "event",
                  "name": "drain",
                  "desc": "
If a stream.write(chunk) call returns false, then the\n'drain' event will indicate when it is appropriate to begin writing more data\nto the stream.
\n
// Write the data to the supplied writable stream one million times.\n// Be attentive to back-pressure.\nfunction writeOneMillionTimes(writer, data, encoding, callback) {\n  var i = 1000000;\n  write();\n  function write() {\n    var ok = true;\n    do {\n      i -= 1;\n      if (i === 0) {\n        // last time!\n        writer.write(data, encoding, callback);\n      } else {\n        // see if we should continue, or wait\n        // don't pass the callback, because we're not done yet.\n        ok = writer.write(data, encoding);\n      }\n    } while (i > 0 && ok);\n    if (i > 0) {\n      // had to stop early!\n      // write some more once it drains\n      writer.once('drain', write);\n    }\n  }\n}\n
\n",
                  "params": []
                },
                {
                  "textRaw": "Event: 'error'",
                  "type": "event",
                  "name": "error",
                  "params": [],
                  "desc": "
Emitted if there was an error when writing or piping data.
\n"
                },
                {
                  "textRaw": "Event: 'finish'",
                  "type": "event",
                  "name": "finish",
                  "desc": "
When the stream.end() method has been called, and all data has\nbeen flushed to the underlying system, this event is emitted.
\n
var writer = getWritableStreamSomehow();\nfor (var i = 0; i < 100; i ++) {\n  writer.write('hello, #${i}!\\n');\n}\nwriter.end('this is the end\\n');\nwriter.on('finish', () => {\n  console.error('all writes are now complete.');\n});\n
\n",
                  "params": []
                },
                {
                  "textRaw": "Event: 'pipe'",
                  "type": "event",
                  "name": "pipe",
                  "params": [],
                  "desc": "
This is emitted whenever the stream.pipe() method is called on a readable\nstream, adding this writable to its set of destinations.
\n
var writer = getWritableStreamSomehow();\nvar reader = getReadableStreamSomehow();\nwriter.on('pipe', (src) => {\n  console.error('something is piping into the writer');\n  assert.equal(src, reader);\n});\nreader.pipe(writer);\n
\n"
                },
                {
                  "textRaw": "Event: 'unpipe'",
                  "type": "event",
                  "name": "unpipe",
                  "params": [],
                  "desc": "
This is emitted whenever the stream.unpipe() method is called on a\nreadable stream, removing this writable from its set of destinations.
\n
var writer = getWritableStreamSomehow();\nvar reader = getReadableStreamSomehow();\nwriter.on('unpipe', (src) => {\n  console.error('something has stopped piping into the writer');\n  assert.equal(src, reader);\n});\nreader.pipe(writer);\nreader.unpipe(writer);\n
\n"
                }
              ],
              "methods": [
                {
                  "textRaw": "writable.cork()",
                  "type": "method",
                  "name": "cork",
                  "desc": "
Forces buffering of all writes.
\n
Buffered data will be flushed either at stream.uncork() or at\nstream.end() call.
\n",
                  "signatures": [
                    {
                      "params": []
                    }
                  ]
                },
                {
                  "textRaw": "writable.end([chunk][, encoding][, callback])",
                  "type": "method",
                  "name": "end",
                  "signatures": [
                    {
                      "params": [
                        {
                          "textRaw": "`chunk` {String|Buffer} Optional data to write ",
                          "name": "chunk",
                          "type": "String|Buffer",
                          "desc": "Optional data to write",
                          "optional": true
                        },
                        {
                          "textRaw": "`encoding` {String} The encoding, if `chunk` is a String ",
                          "name": "encoding",
                          "type": "String",
                          "desc": "The encoding, if `chunk` is a String",
                          "optional": true
                        },
                        {
                          "textRaw": "`callback` {Function} Optional callback for when the stream is finished ",
                          "name": "callback",
                          "type": "Function",
                          "desc": "Optional callback for when the stream is finished",
                          "optional": true
                        }
                      ]
                    },
                    {
                      "params": [
                        {
                          "name": "chunk",
                          "optional": true
                        },
                        {
                          "name": "encoding",
                          "optional": true
                        },
                        {
                          "name": "callback",
                          "optional": true
                        }
                      ]
                    }
                  ],
                  "desc": "
Call this method when no more data will be written to the stream. If supplied,\nthe callback is attached as a listener on the 'finish' event.
\n
Calling stream.write() after calling\nstream.end() will raise an error.
\n
// write 'hello, ' and then end with 'world!'\nvar file = fs.createWriteStream('example.txt');\nfile.write('hello, ');\nfile.end('world!');\n// writing more now is not allowed!\n
\n"
                },
                {
                  "textRaw": "writable.setDefaultEncoding(encoding)",
                  "type": "method",
                  "name": "setDefaultEncoding",
                  "signatures": [
                    {
                      "params": [
                        {
                          "textRaw": "`encoding` {String} The new default encoding ",
                          "name": "encoding",
                          "type": "String",
                          "desc": "The new default encoding"
                        }
                      ]
                    },
                    {
                      "params": [
                        {
                          "name": "encoding"
                        }
                      ]
                    }
                  ],
                  "desc": "
Sets the default encoding for a writable stream.
\n"
                },
                {
                  "textRaw": "writable.uncork()",
                  "type": "method",
                  "name": "uncork",
                  "desc": "
Flush all data, buffered since stream.cork() call.
\n",
                  "signatures": [
                    {
                      "params": []
                    }
                  ]
                },
                {
                  "textRaw": "writable.write(chunk[, encoding][, callback])",
                  "type": "method",
                  "name": "write",
                  "signatures": [
                    {
                      "return": {
                        "textRaw": "Returns: {Boolean} `true` if the data was handled completely. ",
                        "name": "return",
                        "type": "Boolean",
                        "desc": "`true` if the data was handled completely."
                      },
                      "params": [
                        {
                          "textRaw": "`chunk` {String|Buffer} The data to write ",
                          "name": "chunk",
                          "type": "String|Buffer",
                          "desc": "The data to write"
                        },
                        {
                          "textRaw": "`encoding` {String} The encoding, if `chunk` is a String ",
                          "name": "encoding",
                          "type": "String",
                          "desc": "The encoding, if `chunk` is a String",
                          "optional": true
                        },
                        {
                          "textRaw": "`callback` {Function} Callback for when this chunk of data is flushed ",
                          "name": "callback",
                          "type": "Function",
                          "desc": "Callback for when this chunk of data is flushed",
                          "optional": true
                        }
                      ]
                    },
                    {
                      "params": [
                        {
                          "name": "chunk"
                        },
                        {
                          "name": "encoding",
                          "optional": true
                        },
                        {
                          "name": "callback",
                          "optional": true
                        }
                      ]
                    }
                  ],
                  "desc": "
This method writes some data to the underlying system, and calls the\nsupplied callback once the data has been fully handled.  If an error\noccurs, the callback may or may not be called with the error as its\nfirst argument.  To detect write errors, listen for the 'error' event.
\n
The return value indicates if you should continue writing right now.\nIf the data had to be buffered internally, then it will return\nfalse. Otherwise, it will return true.
\n
This return value is strictly advisory. You MAY continue to write,\neven if it returns false. However, writes will be buffered in\nmemory, so it is best not to do this excessively. Instead, wait for\nthe 'drain' event before writing more data.
\n"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "API for Stream Implementors",
          "name": "API for Stream Implementors",
          "type": "misc",
          "desc": "
To implement any sort of stream, the pattern is the same:
\n
    \n
  1. Extend the appropriate parent class in your own subclass. (The\nutil.inherits() method is particularly helpful for this.)
    2. \n
  2. Call the appropriate parent class constructor in your constructor,\nto be sure that the internal mechanisms are set up properly.
    3. \n
  3. Implement one or more specific methods, as detailed below.
    4. \n
\n
The class to extend and the method(s) to implement depend on the sort\nof stream class you are writing:
\n\n  \n    \n      \n      \n      \n    \n  \n  \n    \n    \n    \n  \n  \n    \n    \n    \n  \n  \n    \n    \n    \n  \n  \n    \n    \n    \n  \n
\n        
Use-case
\n      		\n        
Class
\n      		\n        
Method(s) to implement
\n      
\n      
Reading only
\n    		\n      
Readable
\n    		\n      
_read
\n    
\n      
Writing only
\n    		\n      
Writable
\n    		\n      
_write, _writev
\n    
\n      
Reading and writing
\n    		\n      
Duplex
\n    		\n      
_read, _write, _writev
\n    
\n      
Operate on written data, then read the result
\n    		\n      
Transform
\n    		\n      
_transform, _flush
\n    
\n\n
In your implementation code, it is very important to never call the methods\ndescribed in API for Stream Consumers. Otherwise, you can potentially cause\nadverse side effects in programs that consume your streaming interfaces.
\n",
          "classes": [
            {
              "textRaw": "Class: stream.Duplex",
              "type": "class",
              "name": "stream.Duplex",
              "desc": "
A "duplex" stream is one that is both Readable and Writable, such as a TCP\nsocket connection.
\n
Note that stream.Duplex is an abstract class designed to be extended\nwith an underlying implementation of the stream._read(size)\nand stream._write(chunk, encoding, callback) methods as you\nwould with a Readable or Writable stream class.
\n
Since JavaScript doesn't have multiple prototypal inheritance, this class\nprototypally inherits from Readable, and then parasitically from Writable. It is\nthus up to the user to implement both the low-level\nstream._read(n) method as well as the low-level\nstream._write(chunk, encoding, callback) method on extension\nduplex classes.
\n",
              "methods": [
                {
                  "textRaw": "new stream.Duplex(options)",
                  "type": "method",
                  "name": "Duplex",
                  "signatures": [
                    {
                      "params": [
                        {
                          "textRaw": "`options` {Object} Passed to both Writable and Readable constructors. Also has the following fields: ",
                          "options": [
                            {
                              "textRaw": "`allowHalfOpen` {Boolean} Default = `true`. If set to `false`, then the stream will automatically end the readable side when the writable side ends and vice versa. ",
                              "name": "allowHalfOpen",
                              "type": "Boolean",
                              "desc": "Default = `true`. If set to `false`, then the stream will automatically end the readable side when the writable side ends and vice versa."
                            },
                            {
                              "textRaw": "`readableObjectMode` {Boolean} Default = `false`. Sets `objectMode` for readable side of the stream. Has no effect if `objectMode` is `true`. ",
                              "name": "readableObjectMode",
                              "type": "Boolean",
                              "desc": "Default = `false`. Sets `objectMode` for readable side of the stream. Has no effect if `objectMode` is `true`."
                            },
                            {
                              "textRaw": "`writableObjectMode` {Boolean} Default = `false`. Sets `objectMode` for writable side of the stream. Has no effect if `objectMode` is `true`. ",
                              "name": "writableObjectMode",
                              "type": "Boolean",
                              "desc": "Default = `false`. Sets `objectMode` for writable side of the stream. Has no effect if `objectMode` is `true`."
                            }
                          ],
                          "name": "options",
                          "type": "Object",
                          "desc": "Passed to both Writable and Readable constructors. Also has the following fields:"
                        }
                      ]
                    },
                    {
                      "params": [
                        {
                          "name": "options"
                        }
                      ]
                    }
                  ],
                  "desc": "
In classes that extend the Duplex class, make sure to call the\nconstructor so that the buffering settings can be properly\ninitialized.
\n"
                }
              ]
            },
            {
              "textRaw": "Class: stream.PassThrough",
              "type": "class",
              "name": "stream.PassThrough",
              "desc": "
This is a trivial implementation of a Transform stream that simply\npasses the input bytes across to the output. Its purpose is mainly\nfor examples and testing, but there are occasionally use cases where\nit can come in handy as a building block for novel sorts of streams.
\n"
            },
            {
              "textRaw": "Class: stream.Readable",
              "type": "class",
              "name": "stream.Readable",
              "desc": "
stream.Readable is an abstract class designed to be extended with an\nunderlying implementation of the stream._read(size) method.
\n
Please see API for Stream Consumers for how to consume\nstreams in your programs. What follows is an explanation of how to\nimplement Readable streams in your programs.
\n",
              "methods": [
                {
                  "textRaw": "new stream.Readable([options])",
                  "type": "method",
                  "name": "Readable",
                  "signatures": [
                    {
                      "params": [
                        {
                          "textRaw": "`options` {Object} ",
                          "options": [
                            {
                              "textRaw": "`highWaterMark` {Number} The maximum number of bytes to store in the internal buffer before ceasing to read from the underlying resource. Default = `16384` (16kb), or `16` for `objectMode` streams ",
                              "name": "highWaterMark",
                              "type": "Number",
                              "desc": "The maximum number of bytes to store in the internal buffer before ceasing to read from the underlying resource. Default = `16384` (16kb), or `16` for `objectMode` streams"
                            },
                            {
                              "textRaw": "`encoding` {String} If specified, then buffers will be decoded to strings using the specified encoding. Default = `null` ",
                              "name": "encoding",
                              "type": "String",
                              "desc": "If specified, then buffers will be decoded to strings using the specified encoding. Default = `null`"
                            },
                            {
                              "textRaw": "`objectMode` {Boolean} Whether this stream should behave as a stream of objects. Meaning that [`stream.read(n)`][stream-read] returns a single value instead of a Buffer of size n. Default = `false` ",
                              "name": "objectMode",
                              "type": "Boolean",
                              "desc": "Whether this stream should behave as a stream of objects. Meaning that [`stream.read(n)`][stream-read] returns a single value instead of a Buffer of size n. Default = `false`"
                            },
                            {
                              "textRaw": "`read` {Function} Implementation for the [`stream._read()`][stream-_read] method. ",
                              "name": "read",
                              "type": "Function",
                              "desc": "Implementation for the [`stream._read()`][stream-_read] method."
                            }
                          ],
                          "name": "options",
                          "type": "Object",
                          "optional": true
                        }
                      ]
                    },
                    {
                      "params": [
                        {
                          "name": "options",
                          "optional": true
                        }
                      ]
                    }
                  ],
                  "desc": "
In classes that extend the Readable class, make sure to call the\nReadable constructor so that the buffering settings can be properly\ninitialized.
\n"
                },
                {
                  "textRaw": "readable._read(size)",
                  "type": "method",
                  "name": "_read",
                  "signatures": [
                    {
                      "params": [
                        {
                          "textRaw": "`size` {Number} Number of bytes to read asynchronously ",
                          "name": "size",
                          "type": "Number",
                          "desc": "Number of bytes to read asynchronously"
                        }
                      ]
                    },
                    {
                      "params": [
                        {
                          "name": "size"
                        }
                      ]
                    }
                  ],
                  "desc": "
Note: Implement this method, but do NOT call it directly.
\n
This method is prefixed with an underscore because it is internal to the\nclass that defines it and should only be called by the internal Readable\nclass methods. All Readable stream implementations must provide a _read\nmethod to fetch data from the underlying resource.
\n
When _read() is called, if data is available from the resource, the _read()\nimplementation should start pushing that data into the read queue by calling\nthis.push(dataChunk). _read() should continue reading from\nthe resource and pushing data until push returns false, at which point it\nshould stop reading from the resource. Only when _read() is called again after\nit has stopped should it start reading more data from the resource and pushing\nthat data onto the queue.
\n
Note: once the _read() method is called, it will not be called again until\nthe stream.push() method is called.
\n
The size argument is advisory. Implementations where a "read" is a\nsingle call that returns data can use this to know how much data to\nfetch. Implementations where that is not relevant, such as TCP or\nTLS, may ignore this argument, and simply provide data whenever it\nbecomes available. There is no need, for example to "wait" until\nsize bytes are available before calling stream.push(chunk).
\n"
                }
              ],
              "examples": [
                {
                  "textRaw": "readable.push(chunk[, encoding])",
                  "type": "example",
                  "name": "push",
                  "signatures": [
                    {
                      "return": {
                        "textRaw": "return {Boolean} Whether or not more pushes should be performed ",
                        "name": "return",
                        "type": "Boolean",
                        "desc": "Whether or not more pushes should be performed"
                      },
                      "params": [
                        {
                          "textRaw": "`chunk` {Buffer|Null|String} Chunk of data to push into the read queue ",
                          "name": "chunk",
                          "type": "Buffer|Null|String",
                          "desc": "Chunk of data to push into the read queue"
                        },
                        {
                          "textRaw": "`encoding` {String} Encoding of String chunks.  Must be a valid Buffer encoding, such as `'utf8'` or `'ascii'` ",
                          "name": "encoding",
                          "type": "String",
                          "desc": "Encoding of String chunks.  Must be a valid Buffer encoding, such as `'utf8'` or `'ascii'`",
                          "optional": true
                        }
                      ]
                    }
                  ],
                  "desc": "
Note: This method should be called by Readable implementors, NOT\nby consumers of Readable streams.
\n
If a value other than null is passed, The push() method adds a chunk of data\ninto the queue for subsequent stream processors to consume. If null is\npassed, it signals the end of the stream (EOF), after which no more data\ncan be written.
\n
The data added with push() can be pulled out by calling the\nstream.read() method when the 'readable' event fires.
\n
This API is designed to be as flexible as possible. For example,\nyou may be wrapping a lower-level source which has some sort of\npause/resume mechanism, and a data callback. In those cases, you\ncould wrap the low-level source object by doing something like this:
\n
// source is an object with readStop() and readStart() methods,\n// and an `ondata` member that gets called when it has data, and\n// an `onend` member that gets called when the data is over.\n\nutil.inherits(SourceWrapper, Readable);\n\nfunction SourceWrapper(options) {\n  Readable.call(this, options);\n\n  this._source = getLowlevelSourceObject();\n\n  // Every time there's data, we push it into the internal buffer.\n  this._source.ondata = (chunk) => {\n    // if push() returns false, then we need to stop reading from source\n    if (!this.push(chunk))\n      this._source.readStop();\n  };\n\n  // When the source ends, we push the EOF-signaling `null` chunk\n  this._source.onend = () => {\n    this.push(null);\n  };\n}\n\n// _read will be called when the stream wants to pull more data in\n// the advisory size argument is ignored in this case.\nSourceWrapper.prototype._read = function(size) {\n  this._source.readStart();\n};\n
\n
Example: A Counting Stream
\n
This is a basic example of a Readable stream. It emits the numerals\nfrom 1 to 1,000,000 in ascending order, and then ends.
\n
const Readable = require('stream').Readable;\nconst util = require('util');\nutil.inherits(Counter, Readable);\n\nfunction Counter(opt) {\n  Readable.call(this, opt);\n  this._max = 1000000;\n  this._index = 1;\n}\n\nCounter.prototype._read = function() {\n  var i = this._index++;\n  if (i > this._max)\n    this.push(null);\n  else {\n    var str = '' + i;\n    var buf = new Buffer(str, 'ascii');\n    this.push(buf);\n  }\n};\n
\n
Example: SimpleProtocol v1 (Sub-optimal)
\n
This is similar to the parseHeader function described\nhere, but implemented as a custom stream.\nAlso, note that this implementation does not convert the incoming data to a\nstring.
\n
However, this would be better implemented as a Transform stream. See\nSimpleProtocol v2 for a better implementation.
\n
// A parser for a simple data protocol.\n// The "header" is a JSON object, followed by 2 \\n characters, and\n// then a message body.\n//\n// NOTE: This can be done more simply as a Transform stream!\n// Using Readable directly for this is sub-optimal. See the\n// alternative example below under the Transform section.\n\nconst Readable = require('stream').Readable;\nconst util = require('util');\n\nutil.inherits(SimpleProtocol, Readable);\n\nfunction SimpleProtocol(source, options) {\n  if (!(this instanceof SimpleProtocol))\n    return new SimpleProtocol(source, options);\n\n  Readable.call(this, options);\n  this._inBody = false;\n  this._sawFirstCr = false;\n\n  // source is a readable stream, such as a socket or file\n  this._source = source;\n\n  source.on('end', () => {\n    this.push(null);\n  });\n\n  // give it a kick whenever the source is readable\n  // read(0) will not consume any bytes\n  source.on('readable', () => {\n    this.read(0);\n  });\n\n  this._rawHeader = [];\n  this.header = null;\n}\n\nSimpleProtocol.prototype._read = function(n) {\n  if (!this._inBody) {\n    var chunk = this._source.read();\n\n    // if the source doesn't have data, we don't have data yet.\n    if (chunk === null)\n      return this.push('');\n\n    // check if the chunk has a \\n\\n\n    var split = -1;\n    for (var i = 0; i < chunk.length; i++) {\n      if (chunk[i] === 10) { // '\\n'\n        if (this._sawFirstCr) {\n          split = i;\n          break;\n        } else {\n          this._sawFirstCr = true;\n        }\n      } else {\n        this._sawFirstCr = false;\n      }\n    }\n\n    if (split === -1) {\n      // still waiting for the \\n\\n\n      // stash the chunk, and try again.\n      this._rawHeader.push(chunk);\n      this.push('');\n    } else {\n      this._inBody = true;\n      var h = chunk.slice(0, split);\n      this._rawHeader.push(h);\n      var header = Buffer.concat(this._rawHeader).toString();\n      try {\n        this.header = JSON.parse(header);\n      } catch (er) {\n        this.emit('error', new Error('invalid simple protocol data'));\n        return;\n      }\n      // now, because we got some extra data, unshift the rest\n      // back into the read queue so that our consumer will see it.\n      var b = chunk.slice(split);\n      this.unshift(b);\n      // calling unshift by itself does not reset the reading state\n      // of the stream; since we're inside _read, doing an additional\n      // push('') will reset the state appropriately.\n      this.push('');\n\n      // and let them know that we are done parsing the header.\n      this.emit('header', this.header);\n    }\n  } else {\n    // from there on, just provide the data to our consumer.\n    // careful not to push(null), since that would indicate EOF.\n    var chunk = this._source.read();\n    if (chunk) this.push(chunk);\n  }\n};\n\n// Usage:\n// var parser = new SimpleProtocol(source);\n// Now parser is a readable stream that will emit 'header'\n// with the parsed header data.\n
\n"
                }
              ]
            },
            {
              "textRaw": "Class: stream.Transform",
              "type": "class",
              "name": "stream.Transform",
              "desc": "
A "transform" stream is a duplex stream where the output is causally\nconnected in some way to the input, such as a zlib stream or a\ncrypto stream.
\n
There is no requirement that the output be the same size as the input,\nthe same number of chunks, or arrive at the same time. For example, a\nHash stream will only ever have a single chunk of output which is\nprovided when the input is ended. A zlib stream will produce output\nthat is either much smaller or much larger than its input.
\n
Rather than implement the stream._read() and\nstream._write() methods, Transform classes must implement the\nstream._transform() method, and may optionally\nalso implement the stream._flush() method. (See below.)
\n",
              "methods": [
                {
                  "textRaw": "new stream.Transform([options])",
                  "type": "method",
                  "name": "Transform",
                  "signatures": [
                    {
                      "params": [
                        {
                          "textRaw": "`options` {Object} Passed to both Writable and Readable constructors. Also has the following fields: ",
                          "options": [
                            {
                              "textRaw": "`transform` {Function} Implementation for the [`stream._transform()`][stream-_transform] method. ",
                              "name": "transform",
                              "type": "Function",
                              "desc": "Implementation for the [`stream._transform()`][stream-_transform] method."
                            },
                            {
                              "textRaw": "`flush` {Function} Implementation for the [`stream._flush()`][stream-_flush] method. ",
                              "name": "flush",
                              "type": "Function",
                              "desc": "Implementation for the [`stream._flush()`][stream-_flush] method."
                            }
                          ],
                          "name": "options",
                          "type": "Object",
                          "desc": "Passed to both Writable and Readable constructors. Also has the following fields:",
                          "optional": true
                        }
                      ]
                    },
                    {
                      "params": [
                        {
                          "name": "options",
                          "optional": true
                        }
                      ]
                    }
                  ],
                  "desc": "
In classes that extend the Transform class, make sure to call the\nconstructor so that the buffering settings can be properly\ninitialized.
\n"
                },
                {
                  "textRaw": "transform._flush(callback)",
                  "type": "method",
                  "name": "_flush",
                  "signatures": [
                    {
                      "params": [
                        {
                          "textRaw": "`callback` {Function} Call this function (optionally with an error argument) when you are done flushing any remaining data. ",
                          "name": "callback",
                          "type": "Function",
                          "desc": "Call this function (optionally with an error argument) when you are done flushing any remaining data."
                        }
                      ]
                    },
                    {
                      "params": [
                        {
                          "name": "callback"
                        }
                      ]
                    }
                  ],
                  "desc": "
Note: This function MUST NOT be called directly.  It MAY be implemented\nby child classes, and if so, will be called by the internal Transform\nclass methods only.
\n
In some cases, your transform operation may need to emit a bit more\ndata at the end of the stream. For example, a Zlib compression\nstream will store up some internal state so that it can optimally\ncompress the output. At the end, however, it needs to do the best it\ncan with what is left, so that the data will be complete.
\n
In those cases, you can implement a _flush() method, which will be\ncalled at the very end, after all the written data is consumed, but\nbefore emitting 'end' to signal the end of the readable side. Just\nlike with stream._transform(), call\ntransform.push(chunk) zero or more times, as appropriate, and call callback\nwhen the flush operation is complete.
\n
This method is prefixed with an underscore because it is internal to\nthe class that defines it, and should not be called directly by user\nprograms. However, you are expected to override this method in\nyour own extension classes.
\n"
                },
                {
                  "textRaw": "transform._transform(chunk, encoding, callback)",
                  "type": "method",
                  "name": "_transform",
                  "signatures": [
                    {
                      "params": [
                        {
                          "textRaw": "`chunk` {Buffer|String} The chunk to be transformed. Will **always** be a buffer unless the `decodeStrings` option was set to `false`. ",
                          "name": "chunk",
                          "type": "Buffer|String",
                          "desc": "The chunk to be transformed. Will **always** be a buffer unless the `decodeStrings` option was set to `false`."
                        },
                        {
                          "textRaw": "`encoding` {String} If the chunk is a string, then this is the encoding type. If chunk is a buffer, then this is the special value - 'buffer', ignore it in this case. ",
                          "name": "encoding",
                          "type": "String",
                          "desc": "If the chunk is a string, then this is the encoding type. If chunk is a buffer, then this is the special value - 'buffer', ignore it in this case."
                        },
                        {
                          "textRaw": "`callback` {Function} Call this function (optionally with an error argument and data) when you are done processing the supplied chunk. ",
                          "name": "callback",
                          "type": "Function",
                          "desc": "Call this function (optionally with an error argument and data) when you are done processing the supplied chunk."
                        }
                      ]
                    },
                    {
                      "params": [
                        {
                          "name": "chunk"
                        },
                        {
                          "name": "encoding"
                        },
                        {
                          "name": "callback"
                        }
                      ]
                    }
                  ],
                  "desc": "
Note: This function MUST NOT be called directly.  It should be\nimplemented by child classes, and called by the internal Transform\nclass methods only.
\n
All Transform stream implementations must provide a _transform()\nmethod to accept input and produce output.
\n
_transform() should do whatever has to be done in this specific\nTransform class, to handle the bytes being written, and pass them off\nto the readable portion of the interface. Do asynchronous I/O,\nprocess things, and so on.
\n
Call transform.push(outputChunk) 0 or more times to generate output\nfrom this input chunk, depending on how much data you want to output\nas a result of this chunk.
\n
Call the callback function only when the current chunk is completely\nconsumed. Note that there may or may not be output as a result of any\nparticular input chunk. If you supply a second argument to the callback\nit will be passed to the push method. In other words the following are\nequivalent:
\n
transform.prototype._transform = function (data, encoding, callback) {\n  this.push(data);\n  callback();\n};\n\ntransform.prototype._transform = function (data, encoding, callback) {\n  callback(null, data);\n};\n
\n
This method is prefixed with an underscore because it is internal to\nthe class that defines it, and should not be called directly by user\nprograms. However, you are expected to override this method in\nyour own extension classes.
\n
Example: SimpleProtocol parser v2
\n
The example here of a simple\nprotocol parser can be implemented simply by using the higher level\nTransform stream class, similar to the parseHeader and SimpleProtocol\nv1 examples.
\n
In this example, rather than providing the input as an argument, it\nwould be piped into the parser, which is a more idiomatic Node.js stream\napproach.
\n
const util = require('util');\nconst Transform = require('stream').Transform;\nutil.inherits(SimpleProtocol, Transform);\n\nfunction SimpleProtocol(options) {\n  if (!(this instanceof SimpleProtocol))\n    return new SimpleProtocol(options);\n\n  Transform.call(this, options);\n  this._inBody = false;\n  this._sawFirstCr = false;\n  this._rawHeader = [];\n  this.header = null;\n}\n\nSimpleProtocol.prototype._transform = function(chunk, encoding, done) {\n  if (!this._inBody) {\n    // check if the chunk has a \\n\\n\n    var split = -1;\n    for (var i = 0; i < chunk.length; i++) {\n      if (chunk[i] === 10) { // '\\n'\n        if (this._sawFirstCr) {\n          split = i;\n          break;\n        } else {\n          this._sawFirstCr = true;\n        }\n      } else {\n        this._sawFirstCr = false;\n      }\n    }\n\n    if (split === -1) {\n      // still waiting for the \\n\\n\n      // stash the chunk, and try again.\n      this._rawHeader.push(chunk);\n    } else {\n      this._inBody = true;\n      var h = chunk.slice(0, split);\n      this._rawHeader.push(h);\n      var header = Buffer.concat(this._rawHeader).toString();\n      try {\n        this.header = JSON.parse(header);\n      } catch (er) {\n        this.emit('error', new Error('invalid simple protocol data'));\n        return;\n      }\n      // and let them know that we are done parsing the header.\n      this.emit('header', this.header);\n\n      // now, because we got some extra data, emit this first.\n      this.push(chunk.slice(split));\n    }\n  } else {\n    // from there on, just provide the data to our consumer as-is.\n    this.push(chunk);\n  }\n  done();\n};\n\n// Usage:\n// var parser = new SimpleProtocol();\n// source.pipe(parser)\n// Now parser is a readable stream that will emit 'header'\n// with the parsed header data.\n
\n"
                }
              ],
              "modules": [
                {
                  "textRaw": "Events: 'finish' and 'end'",
                  "name": "events:_'finish'_and_'end'",
                  "desc": "
The 'finish' and 'end' events are from the parent Writable\nand Readable classes respectively. The 'finish' event is fired after\nstream.end() is called and all chunks have been processed by\nstream._transform(), 'end' is fired after all data has\nbeen output which is after the callback in stream._flush()\nhas been called.
\n",
                  "type": "module",
                  "displayName": "Events: 'finish' and 'end'"
                }
              ]
            },
            {
              "textRaw": "Class: stream.Writable",
              "type": "class",
              "name": "stream.Writable",
              "desc": "
stream.Writable is an abstract class designed to be extended with an\nunderlying implementation of the\nstream._write(chunk, encoding, callback) method.
\n
Please see API for Stream Consumers for how to consume\nwritable streams in your programs. What follows is an explanation of\nhow to implement Writable streams in your programs.
\n",
              "methods": [
                {
                  "textRaw": "new stream.Writable([options])",
                  "type": "method",
                  "name": "Writable",
                  "signatures": [
                    {
                      "params": [
                        {
                          "textRaw": "`options` {Object} ",
                          "options": [
                            {
                              "textRaw": "`highWaterMark` {Number} Buffer level when [`stream.write()`][stream-write] starts returning `false`. Default = `16384` (16kb), or `16` for `objectMode` streams. ",
                              "name": "highWaterMark",
                              "type": "Number",
                              "desc": "Buffer level when [`stream.write()`][stream-write] starts returning `false`. Default = `16384` (16kb), or `16` for `objectMode` streams."
                            },
                            {
                              "textRaw": "`decodeStrings` {Boolean} Whether or not to decode strings into Buffers before passing them to [`stream._write()`][stream-_write]. Default = `true` ",
                              "name": "decodeStrings",
                              "type": "Boolean",
                              "desc": "Whether or not to decode strings into Buffers before passing them to [`stream._write()`][stream-_write]. Default = `true`"
                            },
                            {
                              "textRaw": "`objectMode` {Boolean} Whether or not the [`stream.write(anyObj)`][stream-write] is a valid operation. If set you can write arbitrary data instead of only `Buffer` / `String` data. Default = `false` ",
                              "name": "objectMode",
                              "type": "Boolean",
                              "desc": "Whether or not the [`stream.write(anyObj)`][stream-write] is a valid operation. If set you can write arbitrary data instead of only `Buffer` / `String` data. Default = `false`"
                            },
                            {
                              "textRaw": "`write` {Function} Implementation for the [`stream._write()`][stream-_write] method. ",
                              "name": "write",
                              "type": "Function",
                              "desc": "Implementation for the [`stream._write()`][stream-_write] method."
                            },
                            {
                              "textRaw": "`writev` {Function} Implementation for the [`stream._writev()`][stream-_writev] method. ",
                              "name": "writev",
                              "type": "Function",
                              "desc": "Implementation for the [`stream._writev()`][stream-_writev] method."
                            }
                          ],
                          "name": "options",
                          "type": "Object",
                          "optional": true
                        }
                      ]
                    },
                    {
                      "params": [
                        {
                          "name": "options",
                          "optional": true
                        }
                      ]
                    }
                  ],
                  "desc": "
In classes that extend the Writable class, make sure to call the\nconstructor so that the buffering settings can be properly\ninitialized.
\n"
                },
                {
                  "textRaw": "writable._write(chunk, encoding, callback)",
                  "type": "method",
                  "name": "_write",
                  "signatures": [
                    {
                      "params": [
                        {
                          "textRaw": "`chunk` {Buffer|String} The chunk to be written. Will **always** be a buffer unless the `decodeStrings` option was set to `false`. ",
                          "name": "chunk",
                          "type": "Buffer|String",
                          "desc": "The chunk to be written. Will **always** be a buffer unless the `decodeStrings` option was set to `false`."
                        },
                        {
                          "textRaw": "`encoding` {String} If the chunk is a string, then this is the encoding type. If chunk is a buffer, then this is the special value - 'buffer', ignore it in this case. ",
                          "name": "encoding",
                          "type": "String",
                          "desc": "If the chunk is a string, then this is the encoding type. If chunk is a buffer, then this is the special value - 'buffer', ignore it in this case."
                        },
                        {
                          "textRaw": "`callback` {Function} Call this function (optionally with an error argument) when you are done processing the supplied chunk. ",
                          "name": "callback",
                          "type": "Function",
                          "desc": "Call this function (optionally with an error argument) when you are done processing the supplied chunk."
                        }
                      ]
                    },
                    {
                      "params": [
                        {
                          "name": "chunk"
                        },
                        {
                          "name": "encoding"
                        },
                        {
                          "name": "callback"
                        }
                      ]
                    }
                  ],
                  "desc": "
All Writable stream implementations must provide a\nstream._write() method to send data to the underlying\nresource.
\n
Note: This function MUST NOT be called directly.  It should be\nimplemented by child classes, and called by the internal Writable\nclass methods only.
\n
Call the callback using the standard callback(error) pattern to\nsignal that the write completed successfully or with an error.
\n
If the decodeStrings flag is set in the constructor options, then\nchunk may be a string rather than a Buffer, and encoding will\nindicate the sort of string that it is. This is to support\nimplementations that have an optimized handling for certain string\ndata encodings. If you do not explicitly set the decodeStrings\noption to false, then you can safely ignore the encoding argument,\nand assume that chunk will always be a Buffer.
\n
This method is prefixed with an underscore because it is internal to\nthe class that defines it, and should not be called directly by user\nprograms. However, you are expected to override this method in\nyour own extension classes.
\n"
                },
                {
                  "textRaw": "writable._writev(chunks, callback)",
                  "type": "method",
                  "name": "_writev",
                  "signatures": [
                    {
                      "params": [
                        {
                          "textRaw": "`chunks` {Array} The chunks to be written. Each chunk has following format: `{ chunk: ..., encoding: ... }`. ",
                          "name": "chunks",
                          "type": "Array",
                          "desc": "The chunks to be written. Each chunk has following format: `{ chunk: ..., encoding: ... }`."
                        },
                        {
                          "textRaw": "`callback` {Function} Call this function (optionally with an error argument) when you are done processing the supplied chunks. ",
                          "name": "callback",
                          "type": "Function",
                          "desc": "Call this function (optionally with an error argument) when you are done processing the supplied chunks."
                        }
                      ]
                    },
                    {
                      "params": [
                        {
                          "name": "chunks"
                        },
                        {
                          "name": "callback"
                        }
                      ]
                    }
                  ],
                  "desc": "
Note: This function MUST NOT be called directly.  It may be\nimplemented by child classes, and called by the internal Writable\nclass methods only.
\n
This function is completely optional to implement. In most cases it is\nunnecessary. If implemented, it will be called with all the chunks\nthat are buffered in the write queue.
\n"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "Simplified Constructor API",
          "name": "Simplified Constructor API",
          "type": "misc",
          "desc": "
In simple cases there is now the added benefit of being able to construct a\nstream without inheritance.
\n
This can be done by passing the appropriate methods as constructor options:
\n
Examples:
\n",
          "miscs": [
            {
              "textRaw": "Duplex",
              "name": "duplex",
              "desc": "
var duplex = new stream.Duplex({\n  read: function(n) {\n    // sets this._read under the hood\n\n    // push data onto the read queue, passing null\n    // will signal the end of the stream (EOF)\n    this.push(chunk);\n  },\n  write: function(chunk, encoding, next) {\n    // sets this._write under the hood\n\n    // An optional error can be passed as the first argument\n    next()\n  }\n});\n\n// or\n\nvar duplex = new stream.Duplex({\n  read: function(n) {\n    // sets this._read under the hood\n\n    // push data onto the read queue, passing null\n    // will signal the end of the stream (EOF)\n    this.push(chunk);\n  },\n  writev: function(chunks, next) {\n    // sets this._writev under the hood\n\n    // An optional error can be passed as the first argument\n    next()\n  }\n});\n
\n",
              "type": "misc",
              "displayName": "Duplex"
            },
            {
              "textRaw": "Readable",
              "name": "readable",
              "desc": "
var readable = new stream.Readable({\n  read: function(n) {\n    // sets this._read under the hood\n\n    // push data onto the read queue, passing null\n    // will signal the end of the stream (EOF)\n    this.push(chunk);\n  }\n});\n
\n",
              "type": "misc",
              "displayName": "Readable"
            },
            {
              "textRaw": "Transform",
              "name": "transform",
              "desc": "
var transform = new stream.Transform({\n  transform: function(chunk, encoding, next) {\n    // sets this._transform under the hood\n\n    // generate output as many times as needed\n    // this.push(chunk);\n\n    // call when the current chunk is consumed\n    next();\n  },\n  flush: function(done) {\n    // sets this._flush under the hood\n\n    // generate output as many times as needed\n    // this.push(chunk);\n\n    done();\n  }\n});\n
\n",
              "type": "misc",
              "displayName": "Transform"
            },
            {
              "textRaw": "Writable",
              "name": "writable",
              "desc": "
var writable = new stream.Writable({\n  write: function(chunk, encoding, next) {\n    // sets this._write under the hood\n\n    // An optional error can be passed as the first argument\n    next()\n  }\n});\n\n// or\n\nvar writable = new stream.Writable({\n  writev: function(chunks, next) {\n    // sets this._writev under the hood\n\n    // An optional error can be passed as the first argument\n    next()\n  }\n});\n
\n",
              "type": "misc",
              "displayName": "Writable"
            }
          ]
        },
        {
          "textRaw": "Streams: Under the Hood",
          "name": "Streams: Under the Hood",
          "type": "misc",
          "miscs": [
            {
              "textRaw": "Buffering",
              "name": "Buffering",
              "type": "misc",
              "desc": "
Both Writable and Readable streams will buffer data on an internal\nobject which can be retrieved from _writableState.getBuffer() or\n_readableState.buffer, respectively.
\n
The amount of data that will potentially be buffered depends on the\nhighWaterMark option which is passed into the constructor.
\n
Buffering in Readable streams happens when the implementation calls\nstream.push(chunk). If the consumer of the Stream does not\ncall stream.read(), then the data will sit in the internal\nqueue until it is consumed.
\n
Buffering in Writable streams happens when the user calls\nstream.write(chunk) repeatedly, even when it returns false.
\n
The purpose of streams, especially with the stream.pipe() method, is to\nlimit the buffering of data to acceptable levels, so that sources and\ndestinations of varying speed will not overwhelm the available memory.
\n"
            },
            {
              "textRaw": "Compatibility with Older Node.js Versions",
              "name": "Compatibility with Older Node.js Versions",
              "type": "misc",
              "desc": "
In versions of Node.js prior to v0.10, the Readable stream interface was\nsimpler, but also less powerful and less useful.
\n
    \n
  • Rather than waiting for you to call the stream.read() method,\n'data' events would start emitting immediately. If you needed to do\nsome I/O to decide how to handle data, then you had to store the chunks\nin some kind of buffer so that they would not be lost.
    • \n
  • The stream.pause() method was advisory, rather than\nguaranteed. This meant that you still had to be prepared to receive\n'data' events even when the stream was in a paused state.
    • \n
\n
In Node.js v0.10, the Readable class was added.\nFor backwards compatibility with older Node.js programs, Readable streams\nswitch into "flowing mode" when a 'data' event handler is added, or\nwhen the stream.resume() method is called. The effect is\nthat, even if you are not using the new stream.read() method\nand 'readable' event, you no longer have to worry about losing\n'data' chunks.
\n
Most programs will continue to function normally. However, this\nintroduces an edge case in the following conditions:
\n
    \n
  • No 'data' event handler is added.
    • \n
  • The stream.resume() method is never called.
    • \n
  • The stream is not piped to any writable destination.
    • \n
\n
For example, consider the following code:
\n
// WARNING!  BROKEN!\nnet.createServer((socket) => {\n\n  // we add an 'end' method, but never consume the data\n  socket.on('end', () => {\n    // It will never get here.\n    socket.end('I got your message (but didnt read it)\\n');\n  });\n\n}).listen(1337);\n
\n
In versions of Node.js prior to v0.10, the incoming message data would be\nsimply discarded. However, in Node.js v0.10 and beyond,\nthe socket will remain paused forever.
\n
The workaround in this situation is to call the\nstream.resume() method to start the flow of data:
\n
// Workaround\nnet.createServer((socket) => {\n\n  socket.on('end', () => {\n    socket.end('I got your message (but didnt read it)\\n');\n  });\n\n  // start the flow of data, discarding it.\n  socket.resume();\n\n}).listen(1337);\n
\n
In addition to new Readable streams switching into flowing mode,\npre-v0.10 style streams can be wrapped in a Readable class using the\nstream.wrap() method.
\n"
            },
            {
              "textRaw": "Object Mode",
              "name": "Object Mode",
              "type": "misc",
              "desc": "
Normally, Streams operate on Strings and Buffers exclusively.
\n
Streams that are in object mode can emit generic JavaScript values\nother than Buffers and Strings.
\n
A Readable stream in object mode will always return a single item from\na call to stream.read(size), regardless of what the size\nargument is.
\n
A Writable stream in object mode will always ignore the encoding\nargument to stream.write(data, encoding).
\n
The special value null still retains its special value for object\nmode streams. That is, for object mode readable streams, null as a\nreturn value from stream.read() indicates that there is no more\ndata, and stream.push(null) will signal the end of stream data\n(EOF).
\n
No streams in Node.js core are object mode streams. This pattern is only\nused by userland streaming libraries.
\n
You should set objectMode in your stream child class constructor on\nthe options object. Setting objectMode mid-stream is not safe.
\n
For Duplex streams objectMode can be set exclusively for readable or\nwritable side with readableObjectMode and writableObjectMode\nrespectively. These options can be used to implement parsers and\nserializers with Transform streams.
\n
const util = require('util');\nconst StringDecoder = require('string_decoder').StringDecoder;\nconst Transform = require('stream').Transform;\nutil.inherits(JSONParseStream, Transform);\n\n// Gets \\n-delimited JSON string data, and emits the parsed objects\nfunction JSONParseStream() {\n  if (!(this instanceof JSONParseStream))\n    return new JSONParseStream();\n\n  Transform.call(this, { readableObjectMode : true });\n\n  this._buffer = '';\n  this._decoder = new StringDecoder('utf8');\n}\n\nJSONParseStream.prototype._transform = function(chunk, encoding, cb) {\n  this._buffer += this._decoder.write(chunk);\n  // split on newlines\n  var lines = this._buffer.split(/\\r?\\n/);\n  // keep the last partial line buffered\n  this._buffer = lines.pop();\n  for (var l = 0; l < lines.length; l++) {\n    var line = lines[l];\n    try {\n      var obj = JSON.parse(line);\n    } catch (er) {\n      this.emit('error', er);\n      return;\n    }\n    // push the parsed object out to the readable consumer\n    this.push(obj);\n  }\n  cb();\n};\n\nJSONParseStream.prototype._flush = function(cb) {\n  // Just handle any leftover\n  var rem = this._buffer.trim();\n  if (rem) {\n    try {\n      var obj = JSON.parse(rem);\n    } catch (er) {\n      this.emit('error', er);\n      return;\n    }\n    // push the parsed object out to the readable consumer\n    this.push(obj);\n  }\n  cb();\n};\n
\n"
            },
            {
              "textRaw": "`stream.read(0)`",
              "name": "`stream.read(0)`",
              "desc": "
There are some cases where you want to trigger a refresh of the\nunderlying readable stream mechanisms, without actually consuming any\ndata. In that case, you can call stream.read(0), which will always\nreturn null.
\n
If the internal read buffer is below the highWaterMark, and the\nstream is not currently reading, then calling stream.read(0) will trigger\na low-level stream._read() call.
\n
There is almost never a need to do this. However, you will see some\ncases in Node.js's internals where this is done, particularly in the\nReadable stream class internals.
\n",
              "type": "misc",
              "displayName": "`stream.read(0)`"
            },
            {
              "textRaw": "`stream.push('')`",
              "name": "`stream.push('')`",
              "desc": "
Pushing a zero-byte string or Buffer (when not in Object mode) has an\ninteresting side effect. Because it is a call to\nstream.push(), it will end the reading process. However, it\ndoes not add any data to the readable buffer, so there's nothing for\na user to consume.
\n
Very rarely, there are cases where you have no data to provide now,\nbut the consumer of your stream (or, perhaps, another bit of your own\ncode) will know when to check again, by calling stream.read(0).\nIn those cases, you may call stream.push('').
\n
So far, the only use case for this functionality is in the\ntls.CryptoStream class, which is deprecated in Node.js/io.js v1.0. If you\nfind that you have to use stream.push(''), please consider another\napproach, because it almost certainly indicates that something is\nhorribly wrong.
\n\n\n",
              "type": "misc",
              "displayName": "`stream.push('')`"
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "Stream"
    },
    {
      "textRaw": "String Decoder",
      "name": "string_decoder",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
To use this module, do require('string_decoder'). StringDecoder decodes a\nbuffer to a string. It is a simple interface to buffer.toString() but provides\nadditional support for utf8.
\n
const StringDecoder = require('string_decoder').StringDecoder;\nconst decoder = new StringDecoder('utf8');\n\nconst cent = new Buffer([0xC2, 0xA2]);\nconsole.log(decoder.write(cent));\n\nconst euro = new Buffer([0xE2, 0x82, 0xAC]);\nconsole.log(decoder.write(euro));\n
\n",
      "classes": [
        {
          "textRaw": "Class: StringDecoder",
          "type": "class",
          "name": "StringDecoder",
          "meta": {
            "added": [
              "v0.1.99"
            ]
          },
          "desc": "
Accepts a single argument, encoding which defaults to 'utf8'.
\n",
          "methods": [
            {
              "textRaw": "decoder.end()",
              "type": "method",
              "name": "end",
              "meta": {
                "added": [
                  "v0.9.3"
                ]
              },
              "desc": "
Returns any trailing bytes that were left in the buffer.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "decoder.write(buffer)",
              "type": "method",
              "name": "write",
              "meta": {
                "added": [
                  "v0.1.99"
                ]
              },
              "desc": "
Returns a decoded string.
\n\n\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "buffer"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "String Decoder"
    },
    {
      "textRaw": "Timers",
      "name": "timers",
      "stability": 3,
      "stabilityText": "Locked",
      "desc": "
All of the timer functions are globals.  You do not need to require()\nthis module in order to use them.
\n",
      "methods": [
        {
          "textRaw": "clearImmediate(immediateObject)",
          "type": "method",
          "name": "clearImmediate",
          "meta": {
            "added": [
              "v0.9.1"
            ]
          },
          "desc": "
Stops an immediateObject, as created by setImmediate, from triggering.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "immediateObject"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "clearInterval(intervalObject)",
          "type": "method",
          "name": "clearInterval",
          "meta": {
            "added": [
              "v0.0.1"
            ]
          },
          "desc": "
Stops an intervalObject, as created by setInterval, from triggering.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "intervalObject"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "clearTimeout(timeoutObject)",
          "type": "method",
          "name": "clearTimeout",
          "meta": {
            "added": [
              "v0.0.1"
            ]
          },
          "desc": "
Prevents a timeoutObject, as created by setTimeout, from triggering.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "timeoutObject"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "ref()",
          "type": "method",
          "name": "ref",
          "meta": {
            "added": [
              "v0.9.1"
            ]
          },
          "desc": "
If a timer was previously unref()d, then ref() can be called to explicitly\nrequest the timer hold the program open. If the timer is already refd calling\nref again will have no effect.
\n
Returns the timer.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "setImmediate(callback[, arg][, ...])",
          "type": "method",
          "name": "setImmediate",
          "meta": {
            "added": [
              "v0.9.1"
            ]
          },
          "desc": "
Schedules "immediate" execution of callback after I/O events'\ncallbacks and before timers set by setTimeout and setInterval are\ntriggered. Returns an immediateObject for possible use with\nclearImmediate. Additional optional arguments may be passed to the\ncallback.
\n
Callbacks for immediates are queued in the order in which they were created.\nThe entire callback queue is processed every event loop iteration. If an\nimmediate is queued from inside an executing callback, that immediate won't fire\nuntil the next event loop iteration.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "callback"
                },
                {
                  "name": "arg",
                  "optional": true
                },
                {
                  "name": "...",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "setInterval(callback, delay[, arg][, ...])",
          "type": "method",
          "name": "setInterval",
          "meta": {
            "added": [
              "v0.0.1"
            ]
          },
          "desc": "
Schedules repeated execution of callback every delay milliseconds.\nReturns a intervalObject for possible use with clearInterval. Additional\noptional arguments may be passed to the callback.
\n
To follow browser behavior, when using delays larger than 2147483647\nmilliseconds (approximately 25 days) or less than 1, Node.js will use 1 as the\ndelay.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "callback"
                },
                {
                  "name": "delay"
                },
                {
                  "name": "arg",
                  "optional": true
                },
                {
                  "name": "...",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "setTimeout(callback, delay[, arg][, ...])",
          "type": "method",
          "name": "setTimeout",
          "meta": {
            "added": [
              "v0.0.1"
            ]
          },
          "desc": "
Schedules execution of a one-time callback after delay milliseconds.\nReturns a timeoutObject for possible use with clearTimeout. Additional\noptional arguments may be passed to the callback.
\n
The callback will likely not be invoked in precisely delay milliseconds.\nNode.js makes no guarantees about the exact timing of when callbacks will fire,\nnor of their ordering. The callback will be called as close as possible to the\ntime specified.
\n
To follow browser behavior, when using delays larger than 2147483647\nmilliseconds (approximately 25 days) or less than 1, the timeout is executed\nimmediately, as if the delay was set to 1.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "callback"
                },
                {
                  "name": "delay"
                },
                {
                  "name": "arg",
                  "optional": true
                },
                {
                  "name": "...",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "unref()",
          "type": "method",
          "name": "unref",
          "meta": {
            "added": [
              "v0.9.1"
            ]
          },
          "desc": "
The opaque value returned by setTimeout and setInterval also has the\nmethod timer.unref() which allows the creation of a timer that is active but\nif it is the only item left in the event loop, it won't keep the program\nrunning. If the timer is already unrefd calling unref again will have no\neffect.
\n
In the case of setTimeout, unref creates a separate timer that will\nwakeup the event loop, creating too many of these may adversely effect event\nloop performance -- use wisely.
\n
Returns the timer.
\n\n\n",
          "signatures": [
            {
              "params": []
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "Timers"
    },
    {
      "textRaw": "TLS (SSL)",
      "name": "tls_(ssl)",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
Use require('tls') to access this module.
\n
The tls module uses OpenSSL to provide Transport Layer Security and/or\nSecure Socket Layer: encrypted stream communication.
\n
TLS/SSL is a public/private key infrastructure. Each client and each\nserver must have a private key. A private key is created like this:
\n
openssl genrsa -out ryans-key.pem 2048\n
All servers and some clients need to have a certificate. Certificates are public\nkeys signed by a Certificate Authority or self-signed. The first step to\ngetting a certificate is to create a "Certificate Signing Request" (CSR)\nfile. This is done with:
\n
openssl req -new -sha256 -key ryans-key.pem -out ryans-csr.pem\n
To create a self-signed certificate with the CSR, do this:
\n
openssl x509 -req -in ryans-csr.pem -signkey ryans-key.pem -out ryans-cert.pem\n
Alternatively you can send the CSR to a Certificate Authority for signing.
\n
For Perfect Forward Secrecy, it is required to generate Diffie-Hellman\nparameters:
\n
openssl dhparam -outform PEM -out dhparam.pem 2048\n
To create .pfx or .p12, do this:
\n
openssl pkcs12 -export -in agent5-cert.pem -inkey agent5-key.pem \\\n      -certfile ca-cert.pem -out agent5.pfx\n
    \n
  • in:  certificate
    • \n
  • inkey: private key
    • \n
  • certfile: all CA certs concatenated in one file like\ncat ca1-cert.pem ca2-cert.pem > ca-cert.pem
    • \n
\n",
      "miscs": [
        {
          "textRaw": "Client-initiated renegotiation attack mitigation",
          "name": "Client-initiated renegotiation attack mitigation",
          "type": "misc",
          "desc": "
The TLS protocol lets the client renegotiate certain aspects of the TLS session.\nUnfortunately, session renegotiation requires a disproportional amount of\nserver-side resources, which makes it a potential vector for denial-of-service\nattacks.
\n
To mitigate this, renegotiations are limited to three times every 10 minutes. An\nerror is emitted on the tls.TLSSocket instance when the threshold is\nexceeded. The limits are configurable:
\n
    \n
  • tls.CLIENT_RENEG_LIMIT: renegotiation limit, default is 3.
    \n
    • \n
  • tls.CLIENT_RENEG_WINDOW: renegotiation window in seconds, default is\n10 minutes.
    \n
    • \n
\n
Don't change the defaults unless you know what you are doing.
\n
To test your server, connect to it with openssl s_client -connect address:port\nand tap R<CR> (that's the letter R followed by a carriage return) a few\ntimes.
\n"
        },
        {
          "textRaw": "ALPN, NPN and SNI",
          "name": "ALPN, NPN and SNI",
          "type": "misc",
          "desc": "
ALPN (Application-Layer Protocol Negotiation Extension), NPN (Next\nProtocol Negotiation) and SNI (Server Name Indication) are TLS\nhandshake extensions allowing you:
\n
    \n
  • ALPN/NPN - to use one TLS server for multiple protocols (HTTP, SPDY, HTTP/2)
    • \n
  • SNI - to use one TLS server for multiple hostnames with different SSL\ncertificates.
    • \n
\n"
        },
        {
          "textRaw": "Perfect Forward Secrecy",
          "name": "Perfect Forward Secrecy",
          "type": "misc",
          "desc": "
The term "Forward Secrecy" or "Perfect Forward Secrecy" describes a feature of\nkey-agreement (i.e. key-exchange) methods. Practically it means that even if the\nprivate key of a (your) server is compromised, communication can only be\ndecrypted by eavesdroppers if they manage to obtain the key-pair specifically\ngenerated for each session.
\n
This is achieved by randomly generating a key pair for key-agreement on every\nhandshake (in contrary to the same key for all sessions). Methods implementing\nthis technique, thus offering Perfect Forward Secrecy, are called "ephemeral".
\n
Currently two methods are commonly used to achieve Perfect Forward Secrecy (note\nthe character "E" appended to the traditional abbreviations):
\n
    \n
  • DHE - An ephemeral version of the Diffie Hellman key-agreement protocol.
    • \n
  • ECDHE - An ephemeral version of the Elliptic Curve Diffie Hellman\nkey-agreement protocol.
    • \n
\n
Ephemeral methods may have some performance drawbacks, because key generation\nis expensive.
\n"
        }
      ],
      "modules": [
        {
          "textRaw": "Modifying the Default TLS Cipher suite",
          "name": "modifying_the_default_tls_cipher_suite",
          "desc": "
Node.js is built with a default suite of enabled and disabled TLS ciphers.\nCurrently, the default cipher suite is:
\n
ECDHE-RSA-AES128-GCM-SHA256:\nECDHE-ECDSA-AES128-GCM-SHA256:\nECDHE-RSA-AES256-GCM-SHA384:\nECDHE-ECDSA-AES256-GCM-SHA384:\nDHE-RSA-AES128-GCM-SHA256:\nECDHE-RSA-AES128-SHA256:\nDHE-RSA-AES128-SHA256:\nECDHE-RSA-AES256-SHA384:\nDHE-RSA-AES256-SHA384:\nECDHE-RSA-AES256-SHA256:\nDHE-RSA-AES256-SHA256:\nHIGH:\n!aNULL:\n!eNULL:\n!EXPORT:\n!DES:\n!RC4:\n!MD5:\n!PSK:\n!SRP:\n!CAMELLIA\n
This default can be overriden entirely using the --tls-cipher-list command\nline switch. For instance, the following makes\nECDHE-RSA-AES128-GCM-SHA256:!RC4 the default TLS cipher suite:
\n
node --tls-cipher-list="ECDHE-RSA-AES128-GCM-SHA256:!RC4"\n
Note that the default cipher suite included within Node.js has been carefully\nselected to reflect current security best practices and risk mitigation.\nChanging the default cipher suite can have a significant impact on the security\nof an application. The --tls-cipher-list switch should by used only if\nabsolutely necessary.
\n",
          "type": "module",
          "displayName": "Modifying the Default TLS Cipher suite"
        }
      ],
      "classes": [
        {
          "textRaw": "Class: CryptoStream",
          "type": "class",
          "name": "CryptoStream",
          "stability": 0,
          "stabilityText": "Deprecated: Use [`tls.TLSSocket`][] instead.",
          "desc": "
This is an encrypted stream.
\n",
          "properties": [
            {
              "textRaw": "cryptoStream.bytesWritten",
              "name": "bytesWritten",
              "desc": "
A proxy to the underlying socket's bytesWritten accessor, this will return\nthe total bytes written to the socket, including the TLS overhead.
\n"
            }
          ]
        },
        {
          "textRaw": "Class: SecurePair",
          "type": "class",
          "name": "SecurePair",
          "desc": "
Returned by tls.createSecurePair.
\n",
          "events": [
            {
              "textRaw": "Event: 'secure'",
              "type": "event",
              "name": "secure",
              "desc": "
The event is emitted from the SecurePair once the pair has successfully\nestablished a secure connection.
\n
Similarly to the checking for the server 'secureConnection' event,\npair.cleartext.authorized should be checked to confirm whether the certificate\nused properly authorized.
\n",
              "params": []
            }
          ]
        },
        {
          "textRaw": "Class: tls.Server",
          "type": "class",
          "name": "tls.Server",
          "meta": {
            "added": [
              "v0.3.2"
            ]
          },
          "desc": "
This class is a subclass of net.Server and has the same methods on it.\nInstead of accepting just raw TCP connections, this accepts encrypted\nconnections using TLS or SSL.
\n",
          "events": [
            {
              "textRaw": "Event: 'clientError'",
              "type": "event",
              "name": "clientError",
              "meta": {
                "added": [
                  "v0.11.11"
                ]
              },
              "desc": "
function (exception, tlsSocket) { }
\n
When a client connection emits an 'error' event before a secure connection is\nestablished it will be forwarded here.
\n
tlsSocket is the tls.TLSSocket that the error originated from.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'newSession'",
              "type": "event",
              "name": "newSession",
              "meta": {
                "added": [
                  "v0.9.2"
                ]
              },
              "desc": "
function (sessionId, sessionData, callback) { }
\n
Emitted on creation of TLS session. May be used to store sessions in external\nstorage. callback must be invoked eventually, otherwise no data will be\nsent or received from secure connection.
\n
NOTE: adding this event listener will have an effect only on connections\nestablished after addition of event listener.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'OCSPRequest'",
              "type": "event",
              "name": "OCSPRequest",
              "meta": {
                "added": [
                  "v0.11.13"
                ]
              },
              "desc": "
function (certificate, issuer, callback) { }
\n
Emitted when the client sends a certificate status request. You could parse\nserver's current certificate to obtain OCSP url and certificate id, and after\nobtaining OCSP response invoke callback(null, resp), where resp is a\nBuffer instance. Both certificate and issuer are a Buffer\nDER-representations of the primary and issuer's certificates. They could be used\nto obtain OCSP certificate id and OCSP endpoint url.
\n
Alternatively, callback(null, null) could be called, meaning that there is no\nOCSP response.
\n
Calling callback(err) will result in a socket.destroy(err) call.
\n
Typical flow:
\n
    \n
  1. Client connects to server and sends 'OCSPRequest' to it (via status info\nextension in ClientHello.)
    2. \n
  2. Server receives request and invokes 'OCSPRequest' event listener if present
    3. \n
  3. Server grabs OCSP url from either certificate or issuer and performs an\nOCSP request to the CA
    4. \n
  4. Server receives OCSPResponse from CA and sends it back to client via\ncallback argument
    5. \n
  5. Client validates the response and either destroys socket or performs a\nhandshake.
    6. \n
\n
NOTE: issuer could be null, if the certificate is self-signed or if the issuer\nis not in the root certificates list. (You could provide an issuer via ca\noption.)
\n
NOTE: adding this event listener will have an effect only on connections\nestablished after addition of event listener.
\n
NOTE: you may want to use some npm module like asn1.js to parse the\ncertificates.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'resumeSession'",
              "type": "event",
              "name": "resumeSession",
              "meta": {
                "added": [
                  "v0.9.2"
                ]
              },
              "desc": "
function (sessionId, callback) { }
\n
Emitted when client wants to resume previous TLS session. Event listener may\nperform lookup in external storage using given sessionId, and invoke\ncallback(null, sessionData) once finished. If session can't be resumed\n(i.e. doesn't exist in storage) one may call callback(null, null). Calling\ncallback(err) will terminate incoming connection and destroy socket.
\n
NOTE: adding this event listener will have an effect only on connections\nestablished after addition of event listener.
\n
Here's an example for using TLS session resumption:
\n
var tlsSessionStore = {};\nserver.on('newSession', (id, data, cb) => {\n  tlsSessionStore[id.toString('hex')] = data;\n  cb();\n});\nserver.on('resumeSession', (id, cb) => {\n  cb(null, tlsSessionStore[id.toString('hex')] || null);\n});\n
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'secureConnection'",
              "type": "event",
              "name": "secureConnection",
              "meta": {
                "added": [
                  "v0.3.2"
                ]
              },
              "desc": "
function (tlsSocket) {}
\n
This event is emitted after a new connection has been successfully\nhandshaked. The argument is an instance of tls.TLSSocket. It has all the\ncommon stream methods and events.
\n
socket.authorized is a boolean value which indicates if the\nclient has verified by one of the supplied certificate authorities for the\nserver. If socket.authorized is false, then\nsocket.authorizationError is set to describe how authorization\nfailed. Implied but worth mentioning: depending on the settings of the TLS\nserver, you unauthorized connections may be accepted.
\n
socket.npnProtocol is a string containing the selected NPN protocol\nand socket.alpnProtocol is a string containing the selected ALPN\nprotocol, When both NPN and ALPN extensions are received, ALPN takes\nprecedence over NPN and the next protocol is selected by ALPN. When\nALPN has no selected protocol, this returns false.
\n
socket.servername is a string containing servername requested with\nSNI.
\n",
              "params": []
            }
          ],
          "methods": [
            {
              "textRaw": "server.addContext(hostname, context)",
              "type": "method",
              "name": "addContext",
              "meta": {
                "added": [
                  "v0.5.3"
                ]
              },
              "desc": "
Add secure context that will be used if client request's SNI hostname is\nmatching passed hostname (wildcards can be used). context can contain\nkey, cert, ca and/or any other properties from\ntls.createSecureContext() options argument.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "hostname"
                    },
                    {
                      "name": "context"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "server.address()",
              "type": "method",
              "name": "address",
              "meta": {
                "added": [
                  "v0.6.0"
                ]
              },
              "desc": "
Returns the bound address, the address family name and port of the\nserver as reported by the operating system.  See net.Server.address() for\nmore information.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "server.close([callback])",
              "type": "method",
              "name": "close",
              "meta": {
                "added": [
                  "v0.3.2"
                ]
              },
              "desc": "
Stops the server from accepting new connections. This function is\nasynchronous, the server is finally closed when the server emits a 'close'\nevent.  Optionally, you can pass a callback to listen for the 'close' event.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "server.getTicketKeys()",
              "type": "method",
              "name": "getTicketKeys",
              "meta": {
                "added": [
                  "v3.0.0"
                ]
              },
              "desc": "
Returns Buffer instance holding the keys currently used for\nencryption/decryption of the TLS Session Tickets
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "server.listen(port[, hostname][, callback])",
              "type": "method",
              "name": "listen",
              "meta": {
                "added": [
                  "v0.3.2"
                ]
              },
              "desc": "
Begin accepting connections on the specified port and hostname. If the\nhostname is omitted, the server will accept connections on any IPv6 address\n(::) when IPv6 is available, or any IPv4 address (0.0.0.0) otherwise. A\nport value of zero will assign a random port.
\n
This function is asynchronous. The last parameter callback will be called\nwhen the server has been bound.
\n
See net.Server for more information.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "port"
                    },
                    {
                      "name": "hostname",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "server.setTicketKeys(keys)",
              "type": "method",
              "name": "setTicketKeys",
              "meta": {
                "added": [
                  "v3.0.0"
                ]
              },
              "desc": "
Updates the keys for encryption/decryption of the TLS Session Tickets.
\n
NOTE: the buffer should be 48 bytes long. See server ticketKeys option for\nmore information oh how it is going to be used.
\n
NOTE: the change is effective only for the future server connections. Existing\nor currently pending server connections will use previous keys.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "keys"
                    }
                  ]
                }
              ]
            }
          ],
          "properties": [
            {
              "textRaw": "server.connections",
              "name": "connections",
              "meta": {
                "added": [
                  "v0.3.2"
                ]
              },
              "desc": "
The number of concurrent connections on the server.
\n"
            },
            {
              "textRaw": "server.maxConnections",
              "name": "maxConnections",
              "meta": {
                "added": [
                  "v0.2.0"
                ]
              },
              "desc": "
Set this property to reject connections when the server's connection count\ngets high.
\n"
            }
          ]
        },
        {
          "textRaw": "Class: tls.TLSSocket",
          "type": "class",
          "name": "tls.TLSSocket",
          "meta": {
            "added": [
              "v0.11.4"
            ]
          },
          "desc": "
This is a wrapped version of net.Socket that does transparent encryption\nof written data and all required TLS negotiation.
\n
This instance implements a duplex Stream interfaces.  It has all the\ncommon stream methods and events.
\n
Methods that return TLS connection meta data (e.g.\ntls.TLSSocket.getPeerCertificate() will only return data while the\nconnection is open.
\n"
        }
      ],
      "methods": [
        {
          "textRaw": "new tls.TLSSocket(socket[, options])",
          "type": "method",
          "name": "TLSSocket",
          "meta": {
            "added": [
              "v0.11.4"
            ]
          },
          "desc": "
Construct a new TLSSocket object from existing TCP socket.
\n
socket is an instance of net.Socket
\n
options is an optional object that might contain following properties:
\n
    \n
  • secureContext: An optional TLS context object from\n tls.createSecureContext()
    \n
    • \n
  • isServer: If true the TLS socket will be instantiated in server-mode.\nDefault: false
    \n
    • \n
  • server: An optional net.Server instance
    \n
    • \n
  • requestCert: Optional, see tls.createSecurePair()
    \n
    • \n
  • rejectUnauthorized: Optional, see tls.createSecurePair()
    \n
    • \n
  • NPNProtocols: Optional, see tls.createServer()
    \n
    • \n
  • ALPNProtocols: Optional, see [tls.createServer][]
    \n
    • \n
  • SNICallback: Optional, see tls.createServer()
    \n
    • \n
  • session: Optional, a Buffer instance, containing TLS session
    \n
    • \n
  • requestOCSP: Optional, if true the OCSP status request extension will\nbe added to the client hello, and an 'OCSPResponse' event will be emitted\non the socket before establishing a secure communication
    \n
    • \n
\n",
          "events": [
            {
              "textRaw": "Event: 'OCSPResponse'",
              "type": "event",
              "name": "OCSPResponse",
              "meta": {
                "added": [
                  "v0.11.13"
                ]
              },
              "desc": "
function (response) { }
\n
This event will be emitted if requestOCSP option was set. response is a\nbuffer object, containing server's OCSP response.
\n
Traditionally, the response is a signed object from the server's CA that\ncontains information about server's certificate revocation status.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'secureConnect'",
              "type": "event",
              "name": "secureConnect",
              "meta": {
                "added": [
                  "v0.11.4"
                ]
              },
              "desc": "
This event is emitted after a new connection has been successfully handshaked.\nThe listener will be called no matter if the server's certificate was\nauthorized or not. It is up to the user to test tlsSocket.authorized\nto see if the server certificate was signed by one of the specified CAs.\nIf tlsSocket.authorized === false then the error can be found in\ntlsSocket.authorizationError. Also if ALPN or NPN was used - you can\ncheck tlsSocket.alpnProtocol or tlsSocket.npnProtocol for the\nnegotiated protocol.
\n",
              "params": []
            }
          ],
          "methods": [
            {
              "textRaw": "tlsSocket.address()",
              "type": "method",
              "name": "address",
              "meta": {
                "added": [
                  "v0.11.4"
                ]
              },
              "desc": "
Returns the bound address, the address family name and port of the\nunderlying socket as reported by the operating system. Returns an\nobject with three properties, e.g.\n{ port: 12346, family: 'IPv4', address: '127.0.0.1' }
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "tlsSocket.getCipher()",
              "type": "method",
              "name": "getCipher",
              "meta": {
                "added": [
                  "v0.11.4"
                ]
              },
              "desc": "
Returns an object representing the cipher name and the SSL/TLS\nprotocol version of the current connection.
\n
Example:\n{ name: 'AES256-SHA', version: 'TLSv1/SSLv3' }
\n
See SSL_CIPHER_get_name() and SSL_CIPHER_get_version() in\nhttps://www.openssl.org/docs/ssl/ssl.html#DEALING-WITH-CIPHERS for more\ninformation.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "tlsSocket.getPeerCertificate([ detailed ])",
              "type": "method",
              "name": "getPeerCertificate",
              "meta": {
                "added": [
                  "v0.11.4"
                ]
              },
              "desc": "
Returns an object representing the peer's certificate. The returned object has\nsome properties corresponding to the field of the certificate. If detailed\nargument is true the full chain with issuer property will be returned,\nif false only the top certificate without issuer property.
\n
Example:
\n
{ subject:\n   { C: 'UK',\n     ST: 'Acknack Ltd',\n     L: 'Rhys Jones',\n     O: 'node.js',\n     OU: 'Test TLS Certificate',\n     CN: 'localhost' },\n  issuerInfo:\n   { C: 'UK',\n     ST: 'Acknack Ltd',\n     L: 'Rhys Jones',\n     O: 'node.js',\n     OU: 'Test TLS Certificate',\n     CN: 'localhost' },\n  issuer:\n   { ... another certificate ... },\n  raw: < RAW DER buffer >,\n  valid_from: 'Nov 11 09:52:22 2009 GMT',\n  valid_to: 'Nov  6 09:52:22 2029 GMT',\n  fingerprint: '2A:7A:C2:DD:E5:F9:CC:53:72:35:99:7A:02:5A:71:38:52:EC:8A:DF',\n  serialNumber: 'B9B0D332A1AA5635' }\n
If the peer does not provide a certificate, it returns null or an empty\nobject.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "detailed",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "tlsSocket.getSession()",
              "type": "method",
              "name": "getSession",
              "meta": {
                "added": [
                  "v0.11.4"
                ]
              },
              "desc": "
Return ASN.1 encoded TLS session or undefined if none was negotiated. Could\nbe used to speed up handshake establishment when reconnecting to the server.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "tlsSocket.getTLSTicket()",
              "type": "method",
              "name": "getTLSTicket",
              "meta": {
                "added": [
                  "v0.11.4"
                ]
              },
              "desc": "
NOTE: Works only with client TLS sockets. Useful only for debugging, for\nsession reuse provide session option to tls.connect().
\n
Return TLS session ticket or undefined if none was negotiated.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "tlsSocket.renegotiate(options, callback)",
              "type": "method",
              "name": "renegotiate",
              "meta": {
                "added": [
                  "v0.11.8"
                ]
              },
              "desc": "
Initiate TLS renegotiation process. The options may contain the following\nfields: rejectUnauthorized, requestCert (See tls.createServer() for\ndetails). callback(err) will be executed with null as err,\nonce the renegotiation is successfully completed.
\n
NOTE: Can be used to request peer's certificate after the secure connection\nhas been established.
\n
ANOTHER NOTE: When running as the server, socket will be destroyed\nwith an error after handshakeTimeout timeout.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "options"
                    },
                    {
                      "name": "callback"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "tlsSocket.setMaxSendFragment(size)",
              "type": "method",
              "name": "setMaxSendFragment",
              "meta": {
                "added": [
                  "v0.11.11"
                ]
              },
              "desc": "
Set maximum TLS fragment size (default and maximum value is: 16384, minimum\nis: 512). Returns true on success, false otherwise.
\n
Smaller fragment size decreases buffering latency on the client: large\nfragments are buffered by the TLS layer until the entire fragment is received\nand its integrity is verified; large fragments can span multiple roundtrips,\nand their processing can be delayed due to packet loss or reordering. However,\nsmaller fragments add extra TLS framing bytes and CPU overhead, which may\ndecrease overall server throughput.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "size"
                    }
                  ]
                }
              ]
            }
          ],
          "properties": [
            {
              "textRaw": "tlsSocket.authorized",
              "name": "authorized",
              "meta": {
                "added": [
                  "v0.11.4"
                ]
              },
              "desc": "
A boolean that is true if the peer certificate was signed by one of the\nspecified CAs, otherwise false
\n"
            },
            {
              "textRaw": "tlsSocket.authorizationError",
              "name": "authorizationError",
              "meta": {
                "added": [
                  "v0.11.4"
                ]
              },
              "desc": "
The reason why the peer's certificate has not been verified. This property\nbecomes available only when tlsSocket.authorized === false.
\n"
            },
            {
              "textRaw": "tlsSocket.encrypted",
              "name": "encrypted",
              "meta": {
                "added": [
                  "v0.11.4"
                ]
              },
              "desc": "
Static boolean value, always true. May be used to distinguish TLS sockets\nfrom regular ones.
\n"
            },
            {
              "textRaw": "tlsSocket.localPort",
              "name": "localPort",
              "meta": {
                "added": [
                  "v0.11.4"
                ]
              },
              "desc": "
The numeric representation of the local port.
\n"
            },
            {
              "textRaw": "tlsSocket.localAddress",
              "name": "localAddress",
              "meta": {
                "added": [
                  "v0.11.4"
                ]
              },
              "desc": "
The string representation of the local IP address.
\n"
            },
            {
              "textRaw": "tlsSocket.remoteAddress",
              "name": "remoteAddress",
              "meta": {
                "added": [
                  "v0.11.4"
                ]
              },
              "desc": "
The string representation of the remote IP address. For example,\n'74.125.127.100' or '2001:4860:a005::68'.
\n"
            },
            {
              "textRaw": "tlsSocket.remoteFamily",
              "name": "remoteFamily",
              "meta": {
                "added": [
                  "v0.11.4"
                ]
              },
              "desc": "
The string representation of the remote IP family. 'IPv4' or 'IPv6'.
\n"
            },
            {
              "textRaw": "tlsSocket.remotePort",
              "name": "remotePort",
              "meta": {
                "added": [
                  "v0.11.4"
                ]
              },
              "desc": "
The numeric representation of the remote port. For example, 443.
\n"
            }
          ],
          "signatures": [
            {
              "params": [
                {
                  "name": "socket"
                },
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "tls.connect(options[, callback])",
          "type": "method",
          "name": "connect",
          "meta": {
            "added": [
              "v0.11.3"
            ]
          },
          "desc": "
Creates a new client connection to the given port and host (old API) or\noptions.port and options.host. (If host is omitted, it defaults to\nlocalhost.) options should be an object which specifies:
\n
    \n
  • host: Host the client should connect to
    \n
    • \n
  • port: Port the client should connect to
    \n
    • \n
  • socket: Establish secure connection on a given socket rather than\ncreating a new socket. If this option is specified, host and port\nare ignored.
    \n
    • \n
  • path: Creates unix socket connection to path. If this option is\nspecified, host and port are ignored.
    \n
    • \n
  • pfx: A string or Buffer containing the private key, certificate and\nCA certs of the client in PFX or PKCS12 format.
    \n
    • \n
  • key: A string or Buffer containing the private key of the client in\nPEM format. (Could be an array of keys).
    \n
    • \n
  • passphrase: A string of passphrase for the private key or pfx.
    \n
    • \n
  • cert: A string or Buffer containing the certificate key of the client in\nPEM format. (Could be an array of certs).
    \n
    • \n
  • ca: A string, Buffer or array of strings or Buffers of trusted\ncertificates in PEM format. If this is omitted several well known "root"\nCAs will be used, like VeriSign. These are used to authorize connections.
    \n
    • \n
  • ciphers: A string describing the ciphers to use or exclude, separated by\n:. Uses the same default cipher suite as tls.createServer().
    \n
    • \n
  • rejectUnauthorized: If true, the server certificate is verified against\nthe list of supplied CAs. An 'error' event is emitted if verification\nfails; err.code contains the OpenSSL error code. Default: true.
    \n
    • \n
  • NPNProtocols: An array of strings or Buffers containing supported NPN\nprotocols. Buffers should have following format: 0x05hello0x05world,\nwhere first byte is next protocol name's length. (Passing array should\nusually be much simpler: ['hello', 'world'].)
    \n
    • \n
  • ALPNProtocols: An array of strings or Buffers containing\nsupported ALPN protocols. Buffers should have following format:\n0x05hello0x05world, where the first byte is the next protocol\nname's length. (Passing array should usually be much simpler:\n['hello', 'world'].)
    \n
    • \n
  • servername: Servername for SNI (Server Name Indication) TLS extension.
    \n
    • \n
  • checkServerIdentity(servername, cert): Provide an override for checking\nserver's hostname against the certificate. Should return an error if verification\nfails. Return undefined if passing.
    \n
    • \n
  • secureProtocol: The SSL method to use, e.g. SSLv3_method to force\nSSL version 3. The possible values depend on your installation of\nOpenSSL and are defined in the constant SSL_METHODS.
    \n
    • \n
  • secureContext: An optional TLS context object from\n tls.createSecureContext( ... ). Could it be used for caching client\n certificates, key, and CA certificates.
    \n
    • \n
  • session: A Buffer instance, containing TLS session.
    \n
    • \n
\n
The callback parameter will be added as a listener for the\n'secureConnect' event.
\n
tls.connect() returns a tls.TLSSocket object.
\n
Here is an example of a client of echo server as described previously:
\n
const tls = require('tls');\nconst fs = require('fs');\n\nconst options = {\n  // These are necessary only if using the client certificate authentication\n  key: fs.readFileSync('client-key.pem'),\n  cert: fs.readFileSync('client-cert.pem'),\n\n  // This is necessary only if the server uses the self-signed certificate\n  ca: [ fs.readFileSync('server-cert.pem') ]\n};\n\nvar socket = tls.connect(8000, options, () => {\n  console.log('client connected',\n              socket.authorized ? 'authorized' : 'unauthorized');\n  process.stdin.pipe(socket);\n  process.stdin.resume();\n});\nsocket.setEncoding('utf8');\nsocket.on('data', (data) => {\n  console.log(data);\n});\nsocket.on('end', () => {\n  server.close();\n});\n
\n
Or
\n
const tls = require('tls');\nconst fs = require('fs');\n\nconst options = {\n  pfx: fs.readFileSync('client.pfx')\n};\n\nvar socket = tls.connect(8000, options, () => {\n  console.log('client connected',\n              socket.authorized ? 'authorized' : 'unauthorized');\n  process.stdin.pipe(socket);\n  process.stdin.resume();\n});\nsocket.setEncoding('utf8');\nsocket.on('data', (data) => {\n  console.log(data);\n});\nsocket.on('end', () => {\n  server.close();\n});\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "port"
                },
                {
                  "name": "host",
                  "optional": true
                },
                {
                  "name": "options",
                  "optional": true
                },
                {
                  "name": "callback",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "options"
                },
                {
                  "name": "callback",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "tls.connect(port[, host][, options][, callback])",
          "type": "method",
          "name": "connect",
          "meta": {
            "added": [
              "v0.11.3"
            ]
          },
          "desc": "
Creates a new client connection to the given port and host (old API) or\noptions.port and options.host. (If host is omitted, it defaults to\nlocalhost.) options should be an object which specifies:
\n
    \n
  • host: Host the client should connect to
    \n
    • \n
  • port: Port the client should connect to
    \n
    • \n
  • socket: Establish secure connection on a given socket rather than\ncreating a new socket. If this option is specified, host and port\nare ignored.
    \n
    • \n
  • path: Creates unix socket connection to path. If this option is\nspecified, host and port are ignored.
    \n
    • \n
  • pfx: A string or Buffer containing the private key, certificate and\nCA certs of the client in PFX or PKCS12 format.
    \n
    • \n
  • key: A string or Buffer containing the private key of the client in\nPEM format. (Could be an array of keys).
    \n
    • \n
  • passphrase: A string of passphrase for the private key or pfx.
    \n
    • \n
  • cert: A string or Buffer containing the certificate key of the client in\nPEM format. (Could be an array of certs).
    \n
    • \n
  • ca: A string, Buffer or array of strings or Buffers of trusted\ncertificates in PEM format. If this is omitted several well known "root"\nCAs will be used, like VeriSign. These are used to authorize connections.
    \n
    • \n
  • ciphers: A string describing the ciphers to use or exclude, separated by\n:. Uses the same default cipher suite as tls.createServer().
    \n
    • \n
  • rejectUnauthorized: If true, the server certificate is verified against\nthe list of supplied CAs. An 'error' event is emitted if verification\nfails; err.code contains the OpenSSL error code. Default: true.
    \n
    • \n
  • NPNProtocols: An array of strings or Buffers containing supported NPN\nprotocols. Buffers should have following format: 0x05hello0x05world,\nwhere first byte is next protocol name's length. (Passing array should\nusually be much simpler: ['hello', 'world'].)
    \n
    • \n
  • ALPNProtocols: An array of strings or Buffers containing\nsupported ALPN protocols. Buffers should have following format:\n0x05hello0x05world, where the first byte is the next protocol\nname's length. (Passing array should usually be much simpler:\n['hello', 'world'].)
    \n
    • \n
  • servername: Servername for SNI (Server Name Indication) TLS extension.
    \n
    • \n
  • checkServerIdentity(servername, cert): Provide an override for checking\nserver's hostname against the certificate. Should return an error if verification\nfails. Return undefined if passing.
    \n
    • \n
  • secureProtocol: The SSL method to use, e.g. SSLv3_method to force\nSSL version 3. The possible values depend on your installation of\nOpenSSL and are defined in the constant SSL_METHODS.
    \n
    • \n
  • secureContext: An optional TLS context object from\n tls.createSecureContext( ... ). Could it be used for caching client\n certificates, key, and CA certificates.
    \n
    • \n
  • session: A Buffer instance, containing TLS session.
    \n
    • \n
\n
The callback parameter will be added as a listener for the\n'secureConnect' event.
\n
tls.connect() returns a tls.TLSSocket object.
\n
Here is an example of a client of echo server as described previously:
\n
const tls = require('tls');\nconst fs = require('fs');\n\nconst options = {\n  // These are necessary only if using the client certificate authentication\n  key: fs.readFileSync('client-key.pem'),\n  cert: fs.readFileSync('client-cert.pem'),\n\n  // This is necessary only if the server uses the self-signed certificate\n  ca: [ fs.readFileSync('server-cert.pem') ]\n};\n\nvar socket = tls.connect(8000, options, () => {\n  console.log('client connected',\n              socket.authorized ? 'authorized' : 'unauthorized');\n  process.stdin.pipe(socket);\n  process.stdin.resume();\n});\nsocket.setEncoding('utf8');\nsocket.on('data', (data) => {\n  console.log(data);\n});\nsocket.on('end', () => {\n  server.close();\n});\n
\n
Or
\n
const tls = require('tls');\nconst fs = require('fs');\n\nconst options = {\n  pfx: fs.readFileSync('client.pfx')\n};\n\nvar socket = tls.connect(8000, options, () => {\n  console.log('client connected',\n              socket.authorized ? 'authorized' : 'unauthorized');\n  process.stdin.pipe(socket);\n  process.stdin.resume();\n});\nsocket.setEncoding('utf8');\nsocket.on('data', (data) => {\n  console.log(data);\n});\nsocket.on('end', () => {\n  server.close();\n});\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "port"
                },
                {
                  "name": "host",
                  "optional": true
                },
                {
                  "name": "options",
                  "optional": true
                },
                {
                  "name": "callback",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "tls.createSecureContext(details)",
          "type": "method",
          "name": "createSecureContext",
          "meta": {
            "added": [
              "v0.11.13"
            ]
          },
          "desc": "
Creates a credentials object, with the optional details being a\ndictionary with keys:
\n
    \n
  • pfx : A string or buffer holding the PFX or PKCS12 encoded private\nkey, certificate and CA certificates
    • \n
  • key: A string or Buffer containing the private key of the server in\nPEM format. To support multiple keys using different algorithms, an array\ncan be provided. It can either be a plain array of keys, or an array of\nobjects in the format {pem: key, passphrase: passphrase}. (Required)
    • \n
  • passphrase : A string of passphrase for the private key or pfx
    • \n
  • cert : A string holding the PEM encoded certificate
    • \n
  • ca: A string, Buffer or array of strings or Buffers of trusted\ncertificates in PEM format. If this is omitted several well known "root"\nCAs will be used, like VeriSign. These are used to authorize connections.
    • \n
  • crl : Either a string or list of strings of PEM encoded CRLs\n(Certificate Revocation List)
    • \n
  • ciphers: A string describing the ciphers to use or exclude.\nConsult\nhttps://www.openssl.org/docs/apps/ciphers.html#CIPHER-LIST-FORMAT\nfor details on the format.
    • \n
  • honorCipherOrder : When choosing a cipher, use the server's preferences\ninstead of the client preferences. For further details see tls module\ndocumentation.
    • \n
\n
If no 'ca' details are given, then Node.js will use the default\npublicly trusted list of CAs as given in\nhttp://mxr.mozilla.org/mozilla/source/security/nss/lib/ckfw/builtins/certdata.txt.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "details"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "tls.createSecurePair([context][, isServer][, requestCert][, rejectUnauthorized][, options])",
          "type": "method",
          "name": "createSecurePair",
          "desc": "
Creates a new secure pair object with two streams, one of which reads/writes\nencrypted data, and one reads/writes cleartext data.\nGenerally the encrypted one is piped to/from an incoming encrypted data stream,\nand the cleartext one is used as a replacement for the initial encrypted stream.
\n
    \n
  • credentials: A secure context object from tls.createSecureContext( ... )
    \n
    • \n
  • isServer: A boolean indicating whether this tls connection should be\nopened as a server or a client.
    \n
    • \n
  • requestCert: A boolean indicating whether a server should request a\ncertificate from a connecting client. Only applies to server connections.
    \n
    • \n
  • rejectUnauthorized: A boolean indicating whether a server should\nautomatically reject clients with invalid certificates. Only applies to\nservers with requestCert enabled.
    \n
    • \n
  • options: An object with common SSL options. See tls.TLSSocket.
    \n
    • \n
\n
tls.createSecurePair() returns a SecurePair object with cleartext and\nencrypted stream properties.
\n
NOTE: cleartext has the same APIs as tls.TLSSocket
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "context",
                  "optional": true
                },
                {
                  "name": "isServer",
                  "optional": true
                },
                {
                  "name": "requestCert",
                  "optional": true
                },
                {
                  "name": "rejectUnauthorized",
                  "optional": true
                },
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "tls.createServer(options[, secureConnectionListener])",
          "type": "method",
          "name": "createServer",
          "meta": {
            "added": [
              "v0.3.2"
            ]
          },
          "desc": "
Creates a new tls.Server.  The connectionListener argument is\nautomatically set as a listener for the 'secureConnection' event.  The\noptions object has these possibilities:
\n
    \n
  • pfx: A string or Buffer containing the private key, certificate and\nCA certs of the server in PFX or PKCS12 format. (Mutually exclusive with\nthe key, cert and ca options.)
    \n
    • \n
  • key: A string or Buffer containing the private key of the server in\nPEM format. To support multiple keys using different algorithms, an array\ncan be provided. It can either be a plain array of keys, or an array of\nobjects in the format {pem: key, passphrase: passphrase}. (Required)
    \n
    • \n
  • passphrase: A string of passphrase for the private key or pfx.
    \n
    • \n
  • cert: A string or Buffer containing the certificate key of the server in\nPEM format. (Could be an array of certs). (Required)
    \n
    • \n
  • ca: A string, Buffer or array of strings or Buffers of trusted\ncertificates in PEM format. If this is omitted several well known "root"\nCAs will be used, like VeriSign. These are used to authorize connections.
    \n
    • \n
  • crl : Either a string or list of strings of PEM encoded CRLs (Certificate\nRevocation List)
    \n
    • \n
  • ciphers: A string describing the ciphers to use or exclude, separated by\n:. The default cipher suite is:
    \n
    ECDHE-RSA-AES128-GCM-SHA256:\nECDHE-ECDSA-AES128-GCM-SHA256:\nECDHE-RSA-AES256-GCM-SHA384:\nECDHE-ECDSA-AES256-GCM-SHA384:\nDHE-RSA-AES128-GCM-SHA256:\nECDHE-RSA-AES128-SHA256:\nDHE-RSA-AES128-SHA256:\nECDHE-RSA-AES256-SHA384:\nDHE-RSA-AES256-SHA384:\nECDHE-RSA-AES256-SHA256:\nDHE-RSA-AES256-SHA256:\nHIGH:\n!aNULL:\n!eNULL:\n!EXPORT:\n!DES:\n!RC4:\n!MD5:\n!PSK:\n!SRP:\n!CAMELLIA\n
    \n
    The default cipher suite prefers GCM ciphers for Chrome's 'modern\ncryptography' setting and also prefers ECDHE and DHE ciphers for Perfect\nForward secrecy, while offering some backward compatibiltity.
    \n
    128 bit AES is preferred over 192 and 256 bit AES in light of specific\nattacks affecting larger AES key sizes.
    \n
    Old clients that rely on insecure and deprecated RC4 or DES-based ciphers\n(like Internet Explorer 6) aren't able to complete the handshake with the default\nconfiguration. If you absolutely must support these clients, the\nTLS recommendations may offer a compatible cipher suite. For more details\non the format, see the OpenSSL cipher list format documentation.
    \n
    • \n
  • ecdhCurve: A string describing a named curve to use for ECDH key agreement\nor false to disable ECDH.
    \n
    Defaults to prime256v1 (NIST P-256). Use crypto.getCurves() to obtain\na list of available curve names. On recent releases,\nopenssl ecparam -list_curves will also display the name and description of\neach available elliptic curve.
    \n
    • \n
  • dhparam: A string or Buffer containing Diffie Hellman parameters,\nrequired for Perfect Forward Secrecy. Use openssl dhparam to create it.\nIts key length should be greater than or equal to 1024 bits, otherwise\nit throws an error. It is strongly recommended to use 2048 bits or\nmore for stronger security. If omitted or invalid, it is silently\ndiscarded and DHE ciphers won't be available.
    \n
    • \n
  • handshakeTimeout: Abort the connection if the SSL/TLS handshake does not\nfinish in this many milliseconds. The default is 120 seconds.
    \n
    A 'clientError' is emitted on the tls.Server object whenever a handshake\ntimes out.
    \n
    • \n
  • honorCipherOrder : When choosing a cipher, use the server's preferences\ninstead of the client preferences. Default: true.
    \n
    • \n
  • requestCert: If true the server will request a certificate from\nclients that connect and attempt to verify that certificate. Default:\nfalse.
    \n
    • \n
  • rejectUnauthorized: If true the server will reject any connection\nwhich is not authorized with the list of supplied CAs. This option only\nhas an effect if requestCert is true. Default: false.
    \n
    • \n
  • NPNProtocols: An array or Buffer of possible NPN protocols. (Protocols\nshould be ordered by their priority).
    \n
    • \n
  • ALPNProtocols: An array or Buffer of possible ALPN\nprotocols. (Protocols should be ordered by their priority). When\nthe server receives both NPN and ALPN extensions from the client,\nALPN takes precedence over NPN and the server does not send an NPN\nextension to the client.
    \n
    • \n
  • SNICallback(servername, cb): A function that will be called if client\nsupports SNI TLS extension. Two argument will be passed to it: servername,\nand cb. SNICallback should invoke cb(null, ctx), where ctx is a\nSecureContext instance.\n(You can use tls.createSecureContext(...) to get proper\nSecureContext). If SNICallback wasn't provided the default callback with\nhigh-level API will be used (see below).
    \n
    • \n
  • sessionTimeout: An integer specifying the seconds after which TLS\nsession identifiers and TLS session tickets created by the server are\ntimed out. See SSL_CTX_set_timeout for more details.
    \n
    • \n
  • ticketKeys: A 48-byte Buffer instance consisting of 16-byte prefix,\n16-byte hmac key, 16-byte AES key. You could use it to accept tls session\ntickets on multiple instances of tls server.
    \n
    NOTE: Automatically shared between cluster module workers.
    \n
    • \n
  • sessionIdContext: A string containing an opaque identifier for session\nresumption. If requestCert is true, the default is MD5 hash value\ngenerated from command-line. (In FIPS mode a truncated SHA1 hash is\nused instead.) Otherwise, the default is not provided.
    \n
    • \n
  • secureProtocol: The SSL method to use, e.g. SSLv3_method to force\nSSL version 3. The possible values depend on your installation of\nOpenSSL and are defined in the constant SSL_METHODS.
    \n
    • \n
\n
Here is a simple example echo server:
\n
const tls = require('tls');\nconst fs = require('fs');\n\nconst options = {\n  key: fs.readFileSync('server-key.pem'),\n  cert: fs.readFileSync('server-cert.pem'),\n\n  // This is necessary only if using the client certificate authentication.\n  requestCert: true,\n\n  // This is necessary only if the client uses the self-signed certificate.\n  ca: [ fs.readFileSync('client-cert.pem') ]\n};\n\nvar server = tls.createServer(options, (socket) => {\n  console.log('server connected',\n              socket.authorized ? 'authorized' : 'unauthorized');\n  socket.write('welcome!\\n');\n  socket.setEncoding('utf8');\n  socket.pipe(socket);\n});\nserver.listen(8000, () => {\n  console.log('server bound');\n});\n
\n
Or
\n
const tls = require('tls');\nconst fs = require('fs');\n\nconst options = {\n  pfx: fs.readFileSync('server.pfx'),\n\n  // This is necessary only if using the client certificate authentication.\n  requestCert: true,\n\n};\n\nvar server = tls.createServer(options, (socket) => {\n  console.log('server connected',\n              socket.authorized ? 'authorized' : 'unauthorized');\n  socket.write('welcome!\\n');\n  socket.setEncoding('utf8');\n  socket.pipe(socket);\n});\nserver.listen(8000, () => {\n  console.log('server bound');\n});\n
\n
You can test this server by connecting to it with openssl s_client:
\n
openssl s_client -connect 127.0.0.1:8000\n
",
          "signatures": [
            {
              "params": [
                {
                  "name": "options"
                },
                {
                  "name": "secureConnectionListener",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "tls.getCiphers()",
          "type": "method",
          "name": "getCiphers",
          "meta": {
            "added": [
              "v0.10.2"
            ]
          },
          "desc": "
Returns an array with the names of the supported SSL ciphers.
\n
Example:
\n
var ciphers = tls.getCiphers();\nconsole.log(ciphers); // ['AES128-SHA', 'AES256-SHA', ...]\n
\n\n\n",
          "signatures": [
            {
              "params": []
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "TLS (SSL)"
    },
    {
      "textRaw": "TTY",
      "name": "tty",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
The tty module houses the tty.ReadStream and tty.WriteStream classes. In\nmost cases, you will not need to use this module directly.
\n
When Node.js detects that it is being run inside a TTY context, then process.stdin\nwill be a tty.ReadStream instance and process.stdout will be\na tty.WriteStream instance. The preferred way to check if Node.js is being run\nin a TTY context is to check process.stdout.isTTY:
\n
$ node -p -e "Boolean(process.stdout.isTTY)"\ntrue\n$ node -p -e "Boolean(process.stdout.isTTY)" | cat\nfalse\n
",
      "classes": [
        {
          "textRaw": "Class: ReadStream",
          "type": "class",
          "name": "ReadStream",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
A net.Socket subclass that represents the readable portion of a tty. In normal\ncircumstances, process.stdin will be the only tty.ReadStream instance in any\nNode.js program (only when isatty(0) is true).
\n",
          "properties": [
            {
              "textRaw": "rs.isRaw",
              "name": "isRaw",
              "meta": {
                "added": [
                  "v0.7.7"
                ]
              },
              "desc": "
A Boolean that is initialized to false. It represents the current "raw" state\nof the tty.ReadStream instance.
\n"
            }
          ],
          "methods": [
            {
              "textRaw": "rs.setRawMode(mode)",
              "type": "method",
              "name": "setRawMode",
              "meta": {
                "added": [
                  "v0.7.7"
                ]
              },
              "desc": "
mode should be true or false. This sets the properties of the\ntty.ReadStream to act either as a raw device or default. isRaw will be set\nto the resulting mode.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "mode"
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "textRaw": "Class: WriteStream",
          "type": "class",
          "name": "WriteStream",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
A net.Socket subclass that represents the writable portion of a tty. In normal\ncircumstances, process.stdout will be the only tty.WriteStream instance\never created (and only when isatty(1) is true).
\n",
          "events": [
            {
              "textRaw": "Event: 'resize'",
              "type": "event",
              "name": "resize",
              "meta": {
                "added": [
                  "v0.7.7"
                ]
              },
              "desc": "
function () {}
\n
Emitted by refreshSize() when either of the columns or rows properties\nhas changed.
\n
process.stdout.on('resize', () => {\n  console.log('screen size has changed!');\n  console.log(`${process.stdout.columns}x${process.stdout.rows}`);\n});\n
\n",
              "params": []
            }
          ],
          "properties": [
            {
              "textRaw": "ws.columns",
              "name": "columns",
              "meta": {
                "added": [
                  "v0.7.7"
                ]
              },
              "desc": "
A Number that gives the number of columns the TTY currently has. This property\ngets updated on 'resize' events.
\n"
            },
            {
              "textRaw": "ws.rows",
              "name": "rows",
              "meta": {
                "added": [
                  "v0.7.7"
                ]
              },
              "desc": "
A Number that gives the number of rows the TTY currently has. This property\ngets updated on 'resize' events.
\n"
            }
          ]
        }
      ],
      "methods": [
        {
          "textRaw": "tty.isatty(fd)",
          "type": "method",
          "name": "isatty",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
Returns true or false depending on if the fd is associated with a\nterminal.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "tty.setRawMode(mode)",
          "type": "method",
          "name": "setRawMode",
          "stability": 0,
          "stabilityText": "Deprecated: Use [tty.ReadStream#setRawMode][] (i.e. process.stdin.setRawMode) instead.",
          "desc": "\n\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "mode"
                }
              ]
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "TTY"
    },
    {
      "textRaw": "URL",
      "name": "url",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
This module has utilities for URL resolution and parsing.\nCall require('url') to use it.
\n",
      "modules": [
        {
          "textRaw": "URL Parsing",
          "name": "url_parsing",
          "desc": "
Parsed URL objects have some or all of the following fields, depending on\nwhether or not they exist in the URL string. Any parts that are not in the URL\nstring will not be in the parsed object. Examples are shown for the URL
\n
'http://user:pass@host.com:8080/p/a/t/h?query=string#hash'
\n
    \n
  • href: The full URL that was originally parsed. Both the protocol and host are lowercased.
    \n
      Example: 'http://user:pass@host.com:8080/p/a/t/h?query=string#hash'
    \n
    • \n
  • protocol: The request protocol, lowercased.
    \n
      Example: 'http:'
    \n
    • \n
  • slashes: The protocol requires slashes after the colon.
    \n
      Example: true or false
    \n
    • \n
  • host: The full lowercased host portion of the URL, including port\ninformation.
    \n
      Example: 'host.com:8080'
    \n
    • \n
  • auth: The authentication information portion of a URL.
    \n
      Example: 'user:pass'
    \n
    • \n
  • hostname: Just the lowercased hostname portion of the host.
    \n
      Example: 'host.com'
    \n
    • \n
  • port: The port number portion of the host.
    \n
      Example: '8080'
    \n
    • \n
  • pathname: The path section of the URL, that comes after the host and\nbefore the query, including the initial slash if present. No decoding is\nperformed.
    \n
      Example: '/p/a/t/h'
    \n
    • \n
  • search: The 'query string' portion of the URL, including the leading\nquestion mark.
    \n
      Example: '?query=string'
    \n
    • \n
  • path: Concatenation of pathname and search. No decoding is performed.
    \n
      Example: '/p/a/t/h?query=string'
    \n
    • \n
  • query: Either the 'params' portion of the query string, or a\nquerystring-parsed object.
    \n
      Example: 'query=string' or {'query':'string'}
    \n
    • \n
  • hash: The 'fragment' portion of the URL including the pound-sign.
    \n
      Example: '#hash'
    \n
    • \n
\n",
          "modules": [
            {
              "textRaw": "Escaped Characters",
              "name": "escaped_characters",
              "desc": "
Spaces (' ') and the following characters will be automatically escaped in the\nproperties of URL objects:
\n
< > " ` \\r \\n \\t { } | \\ ^ '\n
\n
The following methods are provided by the URL module:
\n",
              "type": "module",
              "displayName": "Escaped Characters"
            }
          ],
          "type": "module",
          "displayName": "URL Parsing"
        }
      ],
      "methods": [
        {
          "textRaw": "url.format(urlObj)",
          "type": "method",
          "name": "format",
          "meta": {
            "added": [
              "v0.1.25"
            ]
          },
          "desc": "
Take a parsed URL object, and return a formatted URL string.
\n
Here's how the formatting process works:
\n
    \n
  • href will be ignored.
    • \n
  • path will be ignored.
    • \n
  • protocol is treated the same with or without the trailing : (colon).
      \n
    • The protocols http, https, ftp, gopher, file will be\npostfixed with :// (colon-slash-slash) as long as host/hostname are present.
      • \n
    • All other protocols mailto, xmpp, aim, sftp, foo, etc will\nbe postfixed with : (colon).
      • \n
    \n
    • \n
  • slashes set to true if the protocol requires :// (colon-slash-slash)
      \n
    • Only needs to be set for protocols not previously listed as requiring\nslashes, such as mongodb://localhost:8000/, or if host/hostname are absent.
      • \n
    \n
    • \n
  • auth will be used if present.
    • \n
  • hostname will only be used if host is absent.
    • \n
  • port will only be used if host is absent.
    • \n
  • host will be used in place of hostname and port.
    • \n
  • pathname is treated the same with or without the leading / (slash).
    • \n
  • query (object; see querystring) will only be used if search is absent.
    • \n
  • search will be used in place of query.
      \n
    • It is treated the same with or without the leading ? (question mark).
      • \n
    \n
    • \n
  • hash is treated the same with or without the leading # (pound sign, anchor).
    • \n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "urlObj"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "url.parse(urlStr[, parseQueryString][, slashesDenoteHost])",
          "type": "method",
          "name": "parse",
          "meta": {
            "added": [
              "v0.1.25"
            ]
          },
          "desc": "
Take a URL string, and return an object.
\n
Pass true as the second argument to also parse the query string using the\nquerystring module. If true then the query property will always be\nassigned an object, and the search property will always be a (possibly\nempty) string. If false then the query property will not be parsed or\ndecoded. Defaults to false.
\n
Pass true as the third argument to treat //foo/bar as\n{ host: 'foo', pathname: '/bar' } rather than\n{ pathname: '//foo/bar' }. Defaults to false.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "urlStr"
                },
                {
                  "name": "parseQueryString",
                  "optional": true
                },
                {
                  "name": "slashesDenoteHost",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "url.resolve(from, to)",
          "type": "method",
          "name": "resolve",
          "meta": {
            "added": [
              "v0.1.25"
            ]
          },
          "desc": "
Take a base URL, and a href URL, and resolve them as a browser would for\nan anchor tag.  Examples:
\n
url.resolve('/one/two/three', 'four')         // '/one/two/four'\nurl.resolve('http://example.com/', '/one')    // 'http://example.com/one'\nurl.resolve('http://example.com/one', '/two') // 'http://example.com/two'\n
\n\n\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "from"
                },
                {
                  "name": "to"
                }
              ]
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "URL"
    },
    {
      "textRaw": "Util",
      "name": "util",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
These functions are in the module 'util'. Use require('util') to\naccess them.
\n
The util module is primarily designed to support the needs of Node.js's\ninternal APIs.  Many of these utilities are useful for your own\nprograms.  If you find that these functions are lacking for your\npurposes, however, you are encouraged to write your own utilities.  We\nare not interested in any future additions to the util module that\nare unnecessary for Node.js's internal functionality.
\n",
      "methods": [
        {
          "textRaw": "util.debug(string)",
          "type": "method",
          "name": "debug",
          "stability": 0,
          "stabilityText": "Deprecated: Use [`console.error()`][] instead.",
          "desc": "
Deprecated predecessor of console.error.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "string"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.debuglog(section)",
          "type": "method",
          "name": "debuglog",
          "meta": {
            "added": [
              "v0.11.3"
            ]
          },
          "signatures": [
            {
              "return": {
                "textRaw": "Returns: {Function} The logging function ",
                "name": "return",
                "type": "Function",
                "desc": "The logging function"
              },
              "params": [
                {
                  "textRaw": "`section` {String} The section of the program to be debugged ",
                  "name": "section",
                  "type": "String",
                  "desc": "The section of the program to be debugged"
                }
              ]
            },
            {
              "params": [
                {
                  "name": "section"
                }
              ]
            }
          ],
          "desc": "
This is used to create a function which conditionally writes to stderr\nbased on the existence of a NODE_DEBUG environment variable.  If the\nsection name appears in that environment variable, then the returned\nfunction will be similar to console.error().  If not, then the\nreturned function is a no-op.
\n
For example:
\n
var debuglog = util.debuglog('foo');\n\nvar bar = 123;\ndebuglog('hello from foo [%d]', bar);\n
\n
If this program is run with NODE_DEBUG=foo in the environment, then\nit will output something like:
\n
FOO 3245: hello from foo [123]\n
where 3245 is the process id.  If it is not run with that\nenvironment variable set, then it will not print anything.
\n
You may separate multiple NODE_DEBUG environment variables with a\ncomma.  For example, NODE_DEBUG=fs,net,tls.
\n"
        },
        {
          "textRaw": "util.deprecate(function, string)",
          "type": "method",
          "name": "deprecate",
          "meta": {
            "added": [
              "v0.8.0"
            ]
          },
          "desc": "
Marks that a method should not be used any more.
\n
const util = require('util');\n\nexports.puts = util.deprecate(function() {\n  for (var i = 0, len = arguments.length; i < len; ++i) {\n    process.stdout.write(arguments[i] + '\\n');\n  }\n}, 'util.puts: Use console.log instead');\n
\n
It returns a modified function which warns once by default.
\n
If --no-deprecation is set then this function is a NO-OP.  Configurable\nat run-time through the process.noDeprecation boolean (only effective\nwhen set before a module is loaded.)
\n
If --trace-deprecation is set, a warning and a stack trace are logged\nto the console the first time the deprecated API is used.  Configurable\nat run-time through the process.traceDeprecation boolean.
\n
If --throw-deprecation is set then the application throws an exception\nwhen the deprecated API is used.  Configurable at run-time through the\nprocess.throwDeprecation boolean.
\n
process.throwDeprecation takes precedence over process.traceDeprecation.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "function"
                },
                {
                  "name": "string"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.error([...])",
          "type": "method",
          "name": "error",
          "meta": {
            "added": [
              "v0.3.0"
            ],
            "deprecated": [
              "v0.11.3"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated: Use [`console.error()`][] instead.",
          "desc": "
Deprecated predecessor of console.error.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "...",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.format(format[, ...])",
          "type": "method",
          "name": "format",
          "meta": {
            "added": [
              "v0.5.3"
            ]
          },
          "desc": "
Returns a formatted string using the first argument as a printf-like format.
\n
The first argument is a string that contains zero or more placeholders.\nEach placeholder is replaced with the converted value from its corresponding\nargument. Supported placeholders are:
\n
    \n
  • %s - String.
    • \n
  • %d - Number (both integer and float).
    • \n
  • %j - JSON.  Replaced with the string '[Circular]' if the argument\ncontains circular references.
    • \n
  • %% - single percent sign ('%'). This does not consume an argument.
    • \n
\n
If the placeholder does not have a corresponding argument, the placeholder is\nnot replaced.
\n
util.format('%s:%s', 'foo'); // 'foo:%s'\n
\n
If there are more arguments than placeholders, the extra arguments are\ncoerced to strings (for objects and symbols, util.inspect() is used)\nand then concatenated, delimited by a space.
\n
util.format('%s:%s', 'foo', 'bar', 'baz'); // 'foo:bar baz'\n
\n
If the first argument is not a format string then util.format() returns\na string that is the concatenation of all its arguments separated by spaces.\nEach argument is converted to a string with util.inspect().
\n
util.format(1, 2, 3); // '1 2 3'\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "format"
                },
                {
                  "name": "...",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.inherits(constructor, superConstructor)",
          "type": "method",
          "name": "inherits",
          "meta": {
            "added": [
              "v0.3.0"
            ]
          },
          "desc": "
Inherit the prototype methods from one constructor into another.  The\nprototype of constructor will be set to a new object created from\nsuperConstructor.
\n
As an additional convenience, superConstructor will be accessible\nthrough the constructor.super_ property.
\n
const util = require('util');\nconst EventEmitter = require('events');\n\nfunction MyStream() {\n    EventEmitter.call(this);\n}\n\nutil.inherits(MyStream, EventEmitter);\n\nMyStream.prototype.write = function(data) {\n    this.emit('data', data);\n}\n\nvar stream = new MyStream();\n\nconsole.log(stream instanceof EventEmitter); // true\nconsole.log(MyStream.super_ === EventEmitter); // true\n\nstream.on('data', (data) => {\n  console.log(`Received data: "${data}"`);\n})\nstream.write('It works!'); // Received data: "It works!"\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "constructor"
                },
                {
                  "name": "superConstructor"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.inspect(object[, options])",
          "type": "method",
          "name": "inspect",
          "meta": {
            "added": [
              "v0.3.0"
            ]
          },
          "desc": "
Return a string representation of object, which is useful for debugging.
\n
An optional options object may be passed that alters certain aspects of the\nformatted string:
\n
    \n
  • showHidden - if true then the object's non-enumerable and symbol\nproperties will be shown too. Defaults to false.
    \n
    • \n
  • depth - tells inspect how many times to recurse while formatting the\nobject. This is useful for inspecting large complicated objects. Defaults to\n2. To make it recurse indefinitely pass null.
    \n
    • \n
  • colors - if true, then the output will be styled with ANSI color codes.\nDefaults to false. Colors are customizable, see Customizing\nutil.inspect colors.
    \n
    • \n
  • customInspect - if false, then custom inspect(depth, opts) functions\ndefined on the objects being inspected won't be called. Defaults to true.
    \n
    • \n
\n
Example of inspecting all properties of the util object:
\n
const util = require('util');\n\nconsole.log(util.inspect(util, { showHidden: true, depth: null }));\n
\n
Values may supply their own custom inspect(depth, opts) functions, when\ncalled they receive the current depth in the recursive inspection, as well as\nthe options object passed to util.inspect().
\n",
          "miscs": [
            {
              "textRaw": "Customizing `util.inspect` colors",
              "name": "Customizing `util.inspect` colors",
              "type": "misc",
              "desc": "
Color output (if enabled) of util.inspect is customizable globally\nvia util.inspect.styles and util.inspect.colors objects.
\n
util.inspect.styles is a map assigning each style a color\nfrom util.inspect.colors.\nHighlighted styles and their default values are:
\n
    \n
  • number (yellow)
    • \n
  • boolean (yellow)
    • \n
  • string (green)
    • \n
  • date (magenta)
    • \n
  • regexp (red)
    • \n
  • null (bold)
    • \n
  • undefined (grey)
    • \n
  • special - only function at this time (cyan)
    • \n
  • name (intentionally no styling)
    • \n
\n
Predefined color codes are: white, grey, black, blue, cyan,\ngreen, magenta, red and yellow.\nThere are also bold, italic, underline and inverse codes.
\n"
            },
            {
              "textRaw": "Custom `inspect()` function on Objects",
              "name": "Custom `inspect()` function on Objects",
              "type": "misc",
              "desc": "
Objects also may define their own inspect(depth) function which util.inspect()\nwill invoke and use the result of when inspecting the object:
\n
const util = require('util');\n\nvar obj = { name: 'nate' };\nobj.inspect = function(depth) {\n  return `{${this.name}}`;\n};\n\nutil.inspect(obj);\n  // "{nate}"\n
\n
You may also return another Object entirely, and the returned String will be\nformatted according to the returned Object. This is similar to how\nJSON.stringify() works:
\n
var obj = { foo: 'this will not show up in the inspect() output' };\nobj.inspect = function(depth) {\n  return { bar: 'baz' };\n};\n\nutil.inspect(obj);\n  // "{ bar: 'baz' }"\n
\n"
            }
          ],
          "signatures": [
            {
              "params": [
                {
                  "name": "object"
                },
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.isArray(object)",
          "type": "method",
          "name": "isArray",
          "meta": {
            "added": [
              "v0.6.0"
            ],
            "deprecated": [
              "v4.0.0"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated",
          "desc": "
Internal alias for Array.isArray.
\n
Returns true if the given "object" is an Array. Otherwise, returns false.
\n
const util = require('util');\n\nutil.isArray([])\n  // true\nutil.isArray(new Array)\n  // true\nutil.isArray({})\n  // false\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "object"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.isBoolean(object)",
          "type": "method",
          "name": "isBoolean",
          "meta": {
            "added": [
              "v0.11.5"
            ],
            "deprecated": [
              "v4.0.0"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated",
          "desc": "
Returns true if the given "object" is a Boolean. Otherwise, returns false.
\n
const util = require('util');\n\nutil.isBoolean(1)\n  // false\nutil.isBoolean(0)\n  // false\nutil.isBoolean(false)\n  // true\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "object"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.isBuffer(object)",
          "type": "method",
          "name": "isBuffer",
          "meta": {
            "added": [
              "v0.11.5"
            ],
            "deprecated": [
              "v4.0.0"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated: Use [`Buffer.isBuffer()`][] instead.",
          "desc": "
Returns true if the given "object" is a Buffer. Otherwise, returns false.
\n
const util = require('util');\n\nutil.isBuffer({ length: 0 })\n  // false\nutil.isBuffer([])\n  // false\nutil.isBuffer(new Buffer('hello world'))\n  // true\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "object"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.isDate(object)",
          "type": "method",
          "name": "isDate",
          "meta": {
            "added": [
              "v0.6.0"
            ],
            "deprecated": [
              "v4.0.0"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated",
          "desc": "
Returns true if the given "object" is a Date. Otherwise, returns false.
\n
const util = require('util');\n\nutil.isDate(new Date())\n  // true\nutil.isDate(Date())\n  // false (without 'new' returns a String)\nutil.isDate({})\n  // false\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "object"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.isError(object)",
          "type": "method",
          "name": "isError",
          "meta": {
            "added": [
              "v0.6.0"
            ],
            "deprecated": [
              "v4.0.0"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated",
          "desc": "
Returns true if the given "object" is an Error. Otherwise, returns\nfalse.
\n
const util = require('util');\n\nutil.isError(new Error())\n  // true\nutil.isError(new TypeError())\n  // true\nutil.isError({ name: 'Error', message: 'an error occurred' })\n  // false\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "object"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.isFunction(object)",
          "type": "method",
          "name": "isFunction",
          "meta": {
            "added": [
              "v0.11.5"
            ],
            "deprecated": [
              "v4.0.0"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated",
          "desc": "
Returns true if the given "object" is a Function. Otherwise, returns\nfalse.
\n
const util = require('util');\n\nfunction Foo() {}\nvar Bar = function() {};\n\nutil.isFunction({})\n  // false\nutil.isFunction(Foo)\n  // true\nutil.isFunction(Bar)\n  // true\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "object"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.isNull(object)",
          "type": "method",
          "name": "isNull",
          "meta": {
            "added": [
              "v0.11.5"
            ],
            "deprecated": [
              "v4.0.0"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated",
          "desc": "
Returns true if the given "object" is strictly null. Otherwise, returns\nfalse.
\n
const util = require('util');\n\nutil.isNull(0)\n  // false\nutil.isNull(undefined)\n  // false\nutil.isNull(null)\n  // true\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "object"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.isNullOrUndefined(object)",
          "type": "method",
          "name": "isNullOrUndefined",
          "meta": {
            "added": [
              "v0.11.5"
            ],
            "deprecated": [
              "v4.0.0"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated",
          "desc": "
Returns true if the given "object" is null or undefined. Otherwise,\nreturns false.
\n
const util = require('util');\n\nutil.isNullOrUndefined(0)\n  // false\nutil.isNullOrUndefined(undefined)\n  // true\nutil.isNullOrUndefined(null)\n  // true\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "object"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.isNumber(object)",
          "type": "method",
          "name": "isNumber",
          "meta": {
            "added": [
              "v0.11.5"
            ],
            "deprecated": [
              "v4.0.0"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated",
          "desc": "
Returns true if the given "object" is a Number. Otherwise, returns false.
\n
const util = require('util');\n\nutil.isNumber(false)\n  // false\nutil.isNumber(Infinity)\n  // true\nutil.isNumber(0)\n  // true\nutil.isNumber(NaN)\n  // true\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "object"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.isObject(object)",
          "type": "method",
          "name": "isObject",
          "meta": {
            "added": [
              "v0.11.5"
            ],
            "deprecated": [
              "v4.0.0"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated",
          "desc": "
Returns true if the given "object" is strictly an Object and not a\nFunction. Otherwise, returns false.
\n
const util = require('util');\n\nutil.isObject(5)\n  // false\nutil.isObject(null)\n  // false\nutil.isObject({})\n  // true\nutil.isObject(function(){})\n  // false\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "object"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.isPrimitive(object)",
          "type": "method",
          "name": "isPrimitive",
          "meta": {
            "added": [
              "v0.11.5"
            ],
            "deprecated": [
              "v4.0.0"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated",
          "desc": "
Returns true if the given "object" is a primitive type. Otherwise, returns\nfalse.
\n
const util = require('util');\n\nutil.isPrimitive(5)\n  // true\nutil.isPrimitive('foo')\n  // true\nutil.isPrimitive(false)\n  // true\nutil.isPrimitive(null)\n  // true\nutil.isPrimitive(undefined)\n  // true\nutil.isPrimitive({})\n  // false\nutil.isPrimitive(function() {})\n  // false\nutil.isPrimitive(/^$/)\n  // false\nutil.isPrimitive(new Date())\n  // false\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "object"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.isRegExp(object)",
          "type": "method",
          "name": "isRegExp",
          "meta": {
            "added": [
              "v0.6.0"
            ],
            "deprecated": [
              "v4.0.0"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated",
          "desc": "
Returns true if the given "object" is a RegExp. Otherwise, returns false.
\n
const util = require('util');\n\nutil.isRegExp(/some regexp/)\n  // true\nutil.isRegExp(new RegExp('another regexp'))\n  // true\nutil.isRegExp({})\n  // false\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "object"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.isString(object)",
          "type": "method",
          "name": "isString",
          "meta": {
            "added": [
              "v0.11.5"
            ],
            "deprecated": [
              "v4.0.0"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated",
          "desc": "
Returns true if the given "object" is a String. Otherwise, returns false.
\n
const util = require('util');\n\nutil.isString('')\n  // true\nutil.isString('foo')\n  // true\nutil.isString(String('foo'))\n  // true\nutil.isString(5)\n  // false\n
\n",
          "methods": [
            {
              "textRaw": "util.isSymbol(object)",
              "type": "method",
              "name": "isSymbol",
              "meta": {
                "added": [
                  "v0.11.5"
                ],
                "deprecated": [
                  "v4.0.0"
                ]
              },
              "stability": 0,
              "stabilityText": "Deprecated",
              "desc": "
Returns true if the given "object" is a Symbol. Otherwise, returns false.
\n
const util = require('util');\n\nutil.isSymbol(5)\n  // false\nutil.isSymbol('foo')\n  // false\nutil.isSymbol(Symbol('foo'))\n  // true\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "object"
                    }
                  ]
                }
              ]
            }
          ],
          "signatures": [
            {
              "params": [
                {
                  "name": "object"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.isUndefined(object)",
          "type": "method",
          "name": "isUndefined",
          "meta": {
            "added": [
              "v0.11.5"
            ],
            "deprecated": [
              "v4.0.0"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated",
          "desc": "
Returns true if the given "object" is undefined. Otherwise, returns false.
\n
const util = require('util');\n\nvar foo;\nutil.isUndefined(5)\n  // false\nutil.isUndefined(foo)\n  // true\nutil.isUndefined(null)\n  // false\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "object"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.log(string)",
          "type": "method",
          "name": "log",
          "meta": {
            "added": [
              "v0.3.0"
            ],
            "deprecated": [
              "v6.0.0"
            ]
          },
          "desc": "
Output with timestamp on stdout.
\n
require('util').log('Timestamped message.');\n
",
          "signatures": [
            {
              "params": [
                {
                  "name": "string"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.print([...])",
          "type": "method",
          "name": "print",
          "meta": {
            "added": [
              "v0.3.0"
            ],
            "deprecated": [
              "v0.11.3"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated: Use [`console.log()`][] instead.",
          "desc": "
Deprecated predecessor of console.log.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "...",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.pump(readableStream, writableStream[, callback])",
          "type": "method",
          "name": "pump",
          "meta": {
            "added": [
              "v0.3.0"
            ],
            "deprecated": [
              "v0.9.1"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated: Use readableStream.pipe(writableStream)",
          "desc": "
Deprecated predecessor of stream.pipe().
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "readableStream"
                },
                {
                  "name": "writableStream"
                },
                {
                  "name": "callback",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.puts([...])",
          "type": "method",
          "name": "puts",
          "meta": {
            "added": [
              "v0.3.0"
            ],
            "deprecated": [
              "v0.11.3"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated: Use [`console.log()`][] instead.",
          "desc": "
Deprecated predecessor of console.log.
\n\n\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "...",
                  "optional": true
                }
              ]
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "Util"
    },
    {
      "textRaw": "V8",
      "name": "v8",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
This module exposes events and interfaces specific to the version of V8\nbuilt with Node.js.  These interfaces are subject to change by upstream and are\ntherefore not covered under the stability index.
\n",
      "methods": [
        {
          "textRaw": "getHeapStatistics()",
          "type": "method",
          "name": "getHeapStatistics",
          "meta": {
            "added": [
              "v1.0.0"
            ]
          },
          "desc": "
Returns an object with the following properties
\n
{\n  total_heap_size: 7326976,\n  total_heap_size_executable: 4194304,\n  total_physical_size: 7326976,\n  total_available_size: 1152656,\n  used_heap_size: 3476208,\n  heap_size_limit: 1535115264\n}\n
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "getHeapSpaceStatistics()",
          "type": "method",
          "name": "getHeapSpaceStatistics",
          "desc": "
Returns statistics about the V8 heap spaces, i.e. the segments which make up\nthe V8 heap. Order of heap spaces nor availability of a heap space can be\nguaranteed as the statistics are provided via the V8 GetHeapSpaceStatistics\nfunction.
\n
Example result:
\n
[\n  {\n    "space_name": "new_space",\n    "space_size": 2063872,\n    "space_used_size": 951112,\n    "space_available_size": 80824,\n    "physical_space_size": 2063872\n  },\n  {\n    "space_name": "old_space",\n    "space_size": 3090560,\n    "space_used_size": 2493792,\n    "space_available_size": 0,\n    "physical_space_size": 3090560\n  },\n  {\n    "space_name": "code_space",\n    "space_size": 1260160,\n    "space_used_size": 644256,\n    "space_available_size": 960,\n    "physical_space_size": 1260160\n  },\n  {\n    "space_name": "map_space",\n    "space_size": 1094160,\n    "space_used_size": 201608,\n    "space_available_size": 0,\n    "physical_space_size": 1094160\n  },\n  {\n    "space_name": "large_object_space",\n    "space_size": 0,\n    "space_used_size": 0,\n    "space_available_size": 1490980608,\n    "physical_space_size": 0\n  }\n]\n
",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "setFlagsFromString(string)",
          "type": "method",
          "name": "setFlagsFromString",
          "meta": {
            "added": [
              "v1.0.0"
            ]
          },
          "desc": "
Set additional V8 command line flags.  Use with care; changing settings\nafter the VM has started may result in unpredictable behavior, including\ncrashes and data loss.  Or it may simply do nothing.
\n
The V8 options available for a version of Node.js may be determined by running\nnode --v8-options.  An unofficial, community-maintained list of options\nand their effects is available here.
\n
Usage:
\n
// Print GC events to stdout for one minute.\nconst v8 = require('v8');\nv8.setFlagsFromString('--trace_gc');\nsetTimeout(function() { v8.setFlagsFromString('--notrace_gc'); }, 60e3);\n
\n\n\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "string"
                }
              ]
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "V8"
    },
    {
      "textRaw": "VM (Executing JavaScript)",
      "name": "vm",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
You can access this module with:
\n
const vm = require('vm');\n
\n
JavaScript code can be compiled and run immediately or compiled, saved, and run\nlater.
\n",
      "classes": [
        {
          "textRaw": "Class: Script",
          "type": "class",
          "name": "Script",
          "meta": {
            "added": [
              "v0.3.1"
            ]
          },
          "desc": "
A class for holding precompiled scripts, and running them in specific sandboxes.
\n",
          "methods": [
            {
              "textRaw": "new vm.Script(code, options)",
              "type": "method",
              "name": "Script",
              "meta": {
                "added": [
                  "v0.3.1"
                ]
              },
              "desc": "
Creating a new Script compiles code but does not run it. Instead, the\ncreated vm.Script object represents this compiled code. This script can be run\nlater many times using methods below. The returned script is not bound to any\nglobal object. It is bound before each run, just for that run.
\n
The options when creating a script are:
\n
    \n
  • filename: allows you to control the filename that shows up in any stack\ntraces produced from this script.
    • \n
  • lineOffset: allows you to add an offset to the line number that is\ndisplayed in stack traces
    • \n
  • columnOffset: allows you to add an offset to the column number that is\ndisplayed in stack traces
    • \n
  • displayErrors: whether or not to print any errors to stderr, with the\nline of code that caused them highlighted, before throwing an exception.\nApplies only to syntax errors compiling the code; errors while running the\ncode are controlled by the options to the script's methods.
    • \n
  • timeout: a number of milliseconds to execute code before terminating\nexecution. If execution is terminated, an Error will be thrown.
    • \n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "code"
                    },
                    {
                      "name": "options"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "script.runInContext(contextifiedSandbox[, options])",
              "type": "method",
              "name": "runInContext",
              "meta": {
                "added": [
                  "v0.3.1"
                ]
              },
              "desc": "
Similar to vm.runInContext() but a method of a precompiled Script\nobject. script.runInContext() runs script's compiled code in\ncontextifiedSandbox and returns the result. Running code does not have access\nto local scope.
\n
script.runInContext() takes the same options as\nscript.runInThisContext().
\n
Example: compile code that increments a global variable and sets one, then\nexecute the code multiple times. These globals are contained in the sandbox.
\n
const util = require('util');\nconst vm = require('vm');\n\nvar sandbox = {\n  animal: 'cat',\n  count: 2\n};\n\nvar context = new vm.createContext(sandbox);\nvar script = new vm.Script('count += 1; name = "kitty"');\n\nfor (var i = 0; i < 10; ++i) {\n  script.runInContext(context);\n}\n\nconsole.log(util.inspect(sandbox));\n\n// { animal: 'cat', count: 12, name: 'kitty' }\n
\n
Note that running untrusted code is a tricky business requiring great care.\nscript.runInContext() is quite useful, but safely running untrusted code\nrequires a separate process.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "contextifiedSandbox"
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "script.runInNewContext([sandbox][, options])",
              "type": "method",
              "name": "runInNewContext",
              "meta": {
                "added": [
                  "v0.3.1"
                ]
              },
              "desc": "
Similar to vm.runInNewContext() but a method of a precompiled Script\nobject. script.runInNewContext() contextifies sandbox if passed or creates a\nnew contextified sandbox if it's omitted, and then runs script's compiled code\nwith the sandbox as the global object and returns the result. Running code does\nnot have access to local scope.
\n
script.runInNewContext() takes the same options as\nscript.runInThisContext().
\n
Example: compile code that sets a global variable, then execute the code\nmultiple times in different contexts. These globals are set on and contained in\nthe sandboxes.
\n
const util = require('util');\nconst vm = require('vm');\n\nconst sandboxes = [{}, {}, {}];\n\nconst script = new vm.Script('globalVar = "set"');\n\nsandboxes.forEach((sandbox) => {\n  script.runInNewContext(sandbox);\n});\n\nconsole.log(util.inspect(sandboxes));\n\n// [{ globalVar: 'set' }, { globalVar: 'set' }, { globalVar: 'set' }]\n
\n
Note that running untrusted code is a tricky business requiring great care.\nscript.runInNewContext() is quite useful, but safely running untrusted code\nrequires a separate process.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "sandbox",
                      "optional": true
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "script.runInThisContext([options])",
              "type": "method",
              "name": "runInThisContext",
              "meta": {
                "added": [
                  "v0.3.1"
                ]
              },
              "desc": "
Similar to vm.runInThisContext() but a method of a precompiled Script\nobject. script.runInThisContext() runs script's compiled code and returns\nthe result. Running code does not have access to local scope, but does have\naccess to the current global object.
\n
Example of using script.runInThisContext() to compile code once and run it\nmultiple times:
\n
const vm = require('vm');\n\nglobal.globalVar = 0;\n\nconst script = new vm.Script('globalVar += 1', { filename: 'myfile.vm' });\n\nfor (var i = 0; i < 1000; ++i) {\n  script.runInThisContext();\n}\n\nconsole.log(globalVar);\n\n// 1000\n
\n
The options for running a script are:
\n
    \n
  • filename: allows you to control the filename that shows up in any stack\ntraces produced.
    • \n
  • lineOffset: allows you to add an offset to the line number that is\ndisplayed in stack traces
    • \n
  • columnOffset: allows you to add an offset to the column number that is\ndisplayed in stack traces
    • \n
  • displayErrors: whether or not to print any errors to stderr, with the\nline of code that caused them highlighted, before throwing an exception.\nApplies only to runtime errors executing the code; it is impossible to create\na Script instance with syntax errors, as the constructor will throw.
    • \n
  • timeout: a number of milliseconds to execute the script before terminating\nexecution. If execution is terminated, an Error will be thrown.
    • \n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "methods": [
        {
          "textRaw": "vm.createContext([sandbox])",
          "type": "method",
          "name": "createContext",
          "meta": {
            "added": [
              "v0.3.1"
            ]
          },
          "desc": "
If given a sandbox object, will "contextify" that sandbox so that it can be\nused in calls to vm.runInContext() or script.runInContext(). Inside\nscripts run as such, sandbox will be the global object, retaining all its\nexisting properties but also having the built-in objects and functions any\nstandard global object has. Outside of scripts run by the vm module,\nsandbox will be unchanged.
\n
If not given a sandbox object, returns a new, empty contextified sandbox object\nyou can use.
\n
This function is useful for creating a sandbox that can be used to run multiple\nscripts, e.g. if you were emulating a web browser it could be used to create a\nsingle sandbox representing a window's global object, then run all <script>\ntags together inside that sandbox.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "sandbox",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "vm.isContext(sandbox)",
          "type": "method",
          "name": "isContext",
          "meta": {
            "added": [
              "v0.11.7"
            ]
          },
          "desc": "
Returns whether or not a sandbox object has been contextified by calling\nvm.createContext() on it.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "sandbox"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "vm.runInContext(code, contextifiedSandbox[, options])",
          "type": "method",
          "name": "runInContext",
          "desc": "
vm.runInContext() compiles code, then runs it in contextifiedSandbox and\nreturns the result. Running code does not have access to local scope. The\ncontextifiedSandbox object must have been previously contextified via\nvm.createContext(); it will be used as the global object for code.
\n
vm.runInContext() takes the same options as vm.runInThisContext().
\n
Example: compile and execute different scripts in a single existing context.
\n
const util = require('util');\nconst vm = require('vm');\n\nconst sandbox = { globalVar: 1 };\nvm.createContext(sandbox);\n\nfor (var i = 0; i < 10; ++i) {\n    vm.runInContext('globalVar *= 2;', sandbox);\n}\nconsole.log(util.inspect(sandbox));\n\n// { globalVar: 1024 }\n
\n
Note that running untrusted code is a tricky business requiring great care.\nvm.runInContext() is quite useful, but safely running untrusted code requires\na separate process.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "code"
                },
                {
                  "name": "contextifiedSandbox"
                },
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "vm.runInDebugContext(code)",
          "type": "method",
          "name": "runInDebugContext",
          "meta": {
            "added": [
              "v0.11.14"
            ]
          },
          "desc": "
vm.runInDebugContext() compiles and executes code inside the V8 debug\ncontext. The primary use case is to get access to the V8 debug object:
\n
const vm = require('vm');\nconst Debug = vm.runInDebugContext('Debug');\nconsole.log(Debug.findScript(process.emit).name);  // 'events.js'\nconsole.log(Debug.findScript(process.exit).name);  // 'internal/process.js'\n
\n
Note that the debug context and object are intrinsically tied to V8's debugger\nimplementation and may change (or even get removed) without prior warning.
\n
The debug object can also be exposed with the --expose_debug_as= switch.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "code"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "vm.runInNewContext(code[, sandbox][, options])",
          "type": "method",
          "name": "runInNewContext",
          "meta": {
            "added": [
              "v0.3.1"
            ]
          },
          "desc": "
vm.runInNewContext() compiles code, contextifies sandbox if passed or\ncreates a new contextified sandbox if it's omitted, and then runs the code with\nthe sandbox as the global object and returns the result.
\n
vm.runInNewContext() takes the same options as vm.runInThisContext().
\n
Example: compile and execute code that increments a global variable and sets a\nnew one. These globals are contained in the sandbox.
\n
const util = require('util');\nconst vm = require('vm');\n\nconst sandbox = {\n  animal: 'cat',\n  count: 2\n};\n\nvm.runInNewContext('count += 1; name = "kitty"', sandbox);\nconsole.log(util.inspect(sandbox));\n\n// { animal: 'cat', count: 3, name: 'kitty' }\n
\n
Note that running untrusted code is a tricky business requiring great care.\nvm.runInNewContext() is quite useful, but safely running untrusted code requires\na separate process.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "code"
                },
                {
                  "name": "sandbox",
                  "optional": true
                },
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "vm.runInThisContext(code[, options])",
          "type": "method",
          "name": "runInThisContext",
          "meta": {
            "added": [
              "v0.3.1"
            ]
          },
          "desc": "
vm.runInThisContext() compiles code, runs it and returns the result. Running\ncode does not have access to local scope, but does have access to the current\nglobal object.
\n
Example of using vm.runInThisContext() and eval() to run the same code:
\n
const vm = require('vm');\nvar localVar = 'initial value';\n\nconst vmResult = vm.runInThisContext('localVar = "vm";');\nconsole.log('vmResult:', vmResult);\nconsole.log('localVar:', localVar);\n\nconst evalResult = eval('localVar = "eval";');\nconsole.log('evalResult:', evalResult);\nconsole.log('localVar:', localVar);\n\n// vmResult: 'vm', localVar: 'initial value'\n// evalResult: 'eval', localVar: 'eval'\n
\n
vm.runInThisContext() does not have access to the local scope, so localVar\nis unchanged. eval() does have access to the local scope, so localVar is\nchanged.
\n
In this way vm.runInThisContext() is much like an indirect eval() call,\ne.g. (0,eval)('code'). However, it also has the following additional options:
\n
    \n
  • filename: allows you to control the filename that shows up in any stack\ntraces produced.
    • \n
  • lineOffset: allows you to add an offset to the line number that is\ndisplayed in stack traces
    • \n
  • columnOffset: allows you to add an offset to the column number that is\ndisplayed in stack traces
    • \n
  • displayErrors: whether or not to print any errors to stderr, with the\nline of code that caused them highlighted, before throwing an exception.\nWill capture both syntax errors from compiling code and runtime errors\nthrown by executing the compiled code. Defaults to true.
    • \n
  • timeout: a number of milliseconds to execute code before terminating\nexecution. If execution is terminated, an Error will be thrown.
    • \n
\n
Example: Run a Server within a VM
\n
The context of .runInThisContext() refers to the V8 context. The code passed\nto this VM context will have it's own isolated scope. To run a simple web server\nusing the http module, for instance, the code passed to the context must either\ncall require('http') on its own, or have a reference to the http module passed\nto it. For instance:
\n
'use strict';\nconst vm = require('vm');\n\nlet code =\n`(function(require) {\n\n   const http = require('http');\n\n   http.createServer( (request, response) => {\n     response.writeHead(200, {'Content-Type': 'text/plain'});\n     response.end('Hello World\\\\n');\n   }).listen(8124);\n\n   console.log('Server running at http://127.0.0.1:8124/');\n })`;\n\n vm.runInThisContext(code)(require);\n
\n
Note: require() in the above case shares the state with context it is passed\nfrom. This might introduce risks when unknown code is executed, e.g. altering\nobjects from the calling thread's context in unwanted ways. It is advisable to\nrun vm code in a separate process.
\n\n\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "code"
                },
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "vm"
    },
    {
      "textRaw": "Zlib",
      "name": "zlib",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
You can access this module with:
\n
const zlib = require('zlib');\n
This provides bindings to Gzip/Gunzip, Deflate/Inflate, and\nDeflateRaw/InflateRaw classes.  Each class takes the same options, and\nis a readable/writable Stream.
\n
Examples
\n
Compressing or decompressing a file can be done by piping an\nfs.ReadStream into a zlib stream, then into an fs.WriteStream.
\n
const gzip = zlib.createGzip();\nconst fs = require('fs');\nconst inp = fs.createReadStream('input.txt');\nconst out = fs.createWriteStream('input.txt.gz');\n\ninp.pipe(gzip).pipe(out);\n
\n
Compressing or decompressing data in one step can be done by using\nthe convenience methods.
\n
const input = '.................................';\nzlib.deflate(input, (err, buffer) => {\n  if (!err) {\n    console.log(buffer.toString('base64'));\n  } else {\n    // handle error\n  }\n});\n\nconst buffer = new Buffer('eJzT0yMAAGTvBe8=', 'base64');\nzlib.unzip(buffer, (err, buffer) => {\n  if (!err) {\n    console.log(buffer.toString());\n  } else {\n    // handle error\n  }\n});\n
\n
To use this module in an HTTP client or server, use the accept-encoding\non requests, and the content-encoding header on responses.
\n
Note: these examples are drastically simplified to show\nthe basic concept.  Zlib encoding can be expensive, and the results\nought to be cached.  See Memory Usage Tuning for more information\non the speed/memory/compression tradeoffs involved in zlib usage.
\n
// client request example\nconst zlib = require('zlib');\nconst http = require('http');\nconst fs = require('fs');\nconst request = http.get({ host: 'izs.me',\n                         path: '/',\n                         port: 80,\n                         headers: { 'accept-encoding': 'gzip,deflate' } });\nrequest.on('response', (response) => {\n  var output = fs.createWriteStream('izs.me_index.html');\n\n  switch (response.headers['content-encoding']) {\n    // or, just use zlib.createUnzip() to handle both cases\n    case 'gzip':\n      response.pipe(zlib.createGunzip()).pipe(output);\n      break;\n    case 'deflate':\n      response.pipe(zlib.createInflate()).pipe(output);\n      break;\n    default:\n      response.pipe(output);\n      break;\n  }\n});\n\n// server example\n// Running a gzip operation on every request is quite expensive.\n// It would be much more efficient to cache the compressed buffer.\nconst zlib = require('zlib');\nconst http = require('http');\nconst fs = require('fs');\nhttp.createServer((request, response) => {\n  var raw = fs.createReadStream('index.html');\n  var acceptEncoding = request.headers['accept-encoding'];\n  if (!acceptEncoding) {\n    acceptEncoding = '';\n  }\n\n  // Note: this is not a conformant accept-encoding parser.\n  // See http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.3\n  if (acceptEncoding.match(/\\bdeflate\\b/)) {\n    response.writeHead(200, { 'content-encoding': 'deflate' });\n    raw.pipe(zlib.createDeflate()).pipe(response);\n  } else if (acceptEncoding.match(/\\bgzip\\b/)) {\n    response.writeHead(200, { 'content-encoding': 'gzip' });\n    raw.pipe(zlib.createGzip()).pipe(response);\n  } else {\n    response.writeHead(200, {});\n    raw.pipe(response);\n  }\n}).listen(1337);\n
\n",
      "miscs": [
        {
          "textRaw": "Memory Usage Tuning",
          "name": "Memory Usage Tuning",
          "type": "misc",
          "desc": "
From zlib/zconf.h, modified to node.js's usage:
\n
The memory requirements for deflate are (in bytes):
\n
(1 << (windowBits+2)) +  (1 << (memLevel+9))\n
that is: 128K for windowBits=15  +  128K for memLevel = 8\n(default values) plus a few kilobytes for small objects.
\n
For example, if you want to reduce\nthe default memory requirements from 256K to 128K, set the options to:
\n
{ windowBits: 14, memLevel: 7 }\n
Of course this will generally degrade compression (there's no free lunch).
\n
The memory requirements for inflate are (in bytes)
\n
1 << windowBits\n
that is, 32K for windowBits=15 (default value) plus a few kilobytes\nfor small objects.
\n
This is in addition to a single internal output slab buffer of size\nchunkSize, which defaults to 16K.
\n
The speed of zlib compression is affected most dramatically by the\nlevel setting.  A higher level will result in better compression, but\nwill take longer to complete.  A lower level will result in less\ncompression, but will be much faster.
\n
In general, greater memory usage options will mean that node.js has to make\nfewer calls to zlib, since it'll be able to process more data in a\nsingle write operation.  So, this is another factor that affects the\nspeed, at the cost of memory usage.
\n"
        },
        {
          "textRaw": "Constants",
          "name": "Constants",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "type": "misc",
          "desc": "
All of the constants defined in zlib.h are also defined on\nrequire('zlib').\nIn the normal course of operations, you will not need to ever set any of\nthese.  They are documented here so that their presence is not\nsurprising.  This section is taken almost directly from the\nzlib documentation.  See http://zlib.net/manual.html#Constants for more\ndetails.
\n
Allowed flush values.
\n
    \n
  • zlib.Z_NO_FLUSH
    • \n
  • zlib.Z_PARTIAL_FLUSH
    • \n
  • zlib.Z_SYNC_FLUSH
    • \n
  • zlib.Z_FULL_FLUSH
    • \n
  • zlib.Z_FINISH
    • \n
  • zlib.Z_BLOCK
    • \n
  • zlib.Z_TREES
    • \n
\n
Return codes for the compression/decompression functions. Negative\nvalues are errors, positive values are used for special but normal\nevents.
\n
    \n
  • zlib.Z_OK
    • \n
  • zlib.Z_STREAM_END
    • \n
  • zlib.Z_NEED_DICT
    • \n
  • zlib.Z_ERRNO
    • \n
  • zlib.Z_STREAM_ERROR
    • \n
  • zlib.Z_DATA_ERROR
    • \n
  • zlib.Z_MEM_ERROR
    • \n
  • zlib.Z_BUF_ERROR
    • \n
  • zlib.Z_VERSION_ERROR
    • \n
\n
Compression levels.
\n
    \n
  • zlib.Z_NO_COMPRESSION
    • \n
  • zlib.Z_BEST_SPEED
    • \n
  • zlib.Z_BEST_COMPRESSION
    • \n
  • zlib.Z_DEFAULT_COMPRESSION
    • \n
\n
Compression strategy.
\n
    \n
  • zlib.Z_FILTERED
    • \n
  • zlib.Z_HUFFMAN_ONLY
    • \n
  • zlib.Z_RLE
    • \n
  • zlib.Z_FIXED
    • \n
  • zlib.Z_DEFAULT_STRATEGY
    • \n
\n
The deflate compression method (the only one supported in this version).
\n
    \n
  • zlib.Z_DEFLATED
    • \n
\n
For initializing zalloc, zfree, opaque.
\n
    \n
  • zlib.Z_NULL
    • \n
\n"
        },
        {
          "textRaw": "Class Options",
          "name": "Class Options",
          "meta": {
            "added": [
              "v0.11.1"
            ]
          },
          "type": "misc",
          "desc": "
Each class takes an options object.  All options are optional.
\n
Note that some options are only relevant when compressing, and are\nignored by the decompression classes.
\n
    \n
  • flush (default: zlib.Z_NO_FLUSH)
    • \n
  • chunkSize (default: 16*1024)
    • \n
  • windowBits
    • \n
  • level (compression only)
    • \n
  • memLevel (compression only)
    • \n
  • strategy (compression only)
    • \n
  • dictionary (deflate/inflate only, empty dictionary by default)
    • \n
\n
See the description of deflateInit2 and inflateInit2 at\nhttp://zlib.net/manual.html#Advanced for more information on these.
\n"
        },
        {
          "textRaw": "Convenience Methods",
          "name": "Convenience Methods",
          "type": "misc",
          "desc": "
All of these take a Buffer or string as the first argument, an optional second\nargument to supply options to the zlib classes and will call the supplied\ncallback with callback(error, result).
\n
Every method has a *Sync counterpart, which accept the same arguments, but\nwithout a callback.
\n",
          "methods": [
            {
              "textRaw": "zlib.deflate(buf[, options], callback)",
              "type": "method",
              "name": "deflate",
              "meta": {
                "added": [
                  "v0.6.0"
                ]
              },
              "desc": "
Compress a Buffer or string with Deflate.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    },
                    {
                      "name": "callback"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "zlib.deflateSync(buf[, options])",
              "type": "method",
              "name": "deflateSync",
              "meta": {
                "added": [
                  "v0.11.12"
                ]
              },
              "desc": "
Compress a Buffer or string with Deflate.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "zlib.deflateRaw(buf[, options], callback)",
              "type": "method",
              "name": "deflateRaw",
              "meta": {
                "added": [
                  "v0.6.0"
                ]
              },
              "desc": "
Compress a Buffer or string with DeflateRaw.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    },
                    {
                      "name": "callback"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "zlib.deflateRawSync(buf[, options])",
              "type": "method",
              "name": "deflateRawSync",
              "meta": {
                "added": [
                  "v0.11.12"
                ]
              },
              "desc": "
Compress a Buffer or string with DeflateRaw.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "zlib.gunzip(buf[, options], callback)",
              "type": "method",
              "name": "gunzip",
              "meta": {
                "added": [
                  "v0.6.0"
                ]
              },
              "desc": "
Decompress a Buffer or string with Gunzip.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    },
                    {
                      "name": "callback"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "zlib.gunzipSync(buf[, options])",
              "type": "method",
              "name": "gunzipSync",
              "meta": {
                "added": [
                  "v0.11.12"
                ]
              },
              "desc": "
Decompress a Buffer or string with Gunzip.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "zlib.gzip(buf[, options], callback)",
              "type": "method",
              "name": "gzip",
              "meta": {
                "added": [
                  "v0.6.0"
                ]
              },
              "desc": "
Compress a Buffer or string with Gzip.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    },
                    {
                      "name": "callback"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "zlib.gzipSync(buf[, options])",
              "type": "method",
              "name": "gzipSync",
              "meta": {
                "added": [
                  "v0.11.12"
                ]
              },
              "desc": "
Compress a Buffer or string with Gzip.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "zlib.inflate(buf[, options], callback)",
              "type": "method",
              "name": "inflate",
              "meta": {
                "added": [
                  "v0.6.0"
                ]
              },
              "desc": "
Decompress a Buffer or string with Inflate.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    },
                    {
                      "name": "callback"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "zlib.inflateSync(buf[, options])",
              "type": "method",
              "name": "inflateSync",
              "meta": {
                "added": [
                  "v0.11.12"
                ]
              },
              "desc": "
Decompress a Buffer or string with Inflate.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "zlib.inflateRaw(buf[, options], callback)",
              "type": "method",
              "name": "inflateRaw",
              "meta": {
                "added": [
                  "v0.6.0"
                ]
              },
              "desc": "
Decompress a Buffer or string with InflateRaw.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    },
                    {
                      "name": "callback"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "zlib.inflateRawSync(buf[, options])",
              "type": "method",
              "name": "inflateRawSync",
              "meta": {
                "added": [
                  "v0.11.12"
                ]
              },
              "desc": "
Decompress a Buffer or string with InflateRaw.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "zlib.unzip(buf[, options], callback)",
              "type": "method",
              "name": "unzip",
              "meta": {
                "added": [
                  "v0.6.0"
                ]
              },
              "desc": "
Decompress a Buffer or string with Unzip.
\n\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    },
                    {
                      "name": "callback"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "zlib.unzipSync(buf[, options])",
              "type": "method",
              "name": "unzipSync",
              "meta": {
                "added": [
                  "v0.11.12"
                ]
              },
              "desc": "
Decompress a Buffer or string with Unzip.
\n\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "modules": [
        {
          "textRaw": "Flushing",
          "name": "flushing",
          "desc": "
Calling .flush() on a compression stream will make zlib return as much\noutput as currently possible. This may come at the cost of degraded compression\nquality, but can be useful when data needs to be available as soon as possible.
\n
In the following example, flush() is used to write a compressed partial\nHTTP response to the client:
\n
const zlib = require('zlib');\nconst http = require('http');\n\nhttp.createServer((request, response) => {\n  // For the sake of simplicity, the Accept-Encoding checks are omitted.\n  response.writeHead(200, { 'content-encoding': 'gzip' });\n  const output = zlib.createGzip();\n  output.pipe(response);\n\n  setInterval(() => {\n    output.write(`The current time is ${Date()}\\n`, () => {\n      // The data has been passed to zlib, but the compression algorithm may\n      // have decided to buffer the data for more efficient compression.\n      // Calling .flush() will make the data available as soon as the client\n      // is ready to receive it.\n      output.flush();\n    });\n  }, 1000);\n}).listen(1337);\n
\n",
          "type": "module",
          "displayName": "Flushing"
        }
      ],
      "meta": {
        "added": [
          "v0.5.8"
        ]
      },
      "classes": [
        {
          "textRaw": "Class: zlib.Deflate",
          "type": "class",
          "name": "zlib.Deflate",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
Compress data using deflate.
\n"
        },
        {
          "textRaw": "Class: zlib.DeflateRaw",
          "type": "class",
          "name": "zlib.DeflateRaw",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
Compress data using deflate, and do not append a zlib header.
\n"
        },
        {
          "textRaw": "Class: zlib.Gunzip",
          "type": "class",
          "name": "zlib.Gunzip",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
Decompress a gzip stream.
\n"
        },
        {
          "textRaw": "Class: zlib.Gzip",
          "type": "class",
          "name": "zlib.Gzip",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
Compress data using gzip.
\n"
        },
        {
          "textRaw": "Class: zlib.Inflate",
          "type": "class",
          "name": "zlib.Inflate",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
Decompress a deflate stream.
\n"
        },
        {
          "textRaw": "Class: zlib.InflateRaw",
          "type": "class",
          "name": "zlib.InflateRaw",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
Decompress a raw deflate stream.
\n"
        },
        {
          "textRaw": "Class: zlib.Unzip",
          "type": "class",
          "name": "zlib.Unzip",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
Decompress either a Gzip- or Deflate-compressed stream by auto-detecting\nthe header.
\n"
        },
        {
          "textRaw": "Class: zlib.Zlib",
          "type": "class",
          "name": "zlib.Zlib",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
Not exported by the zlib module. It is documented here because it is the base\nclass of the compressor/decompressor classes.
\n",
          "methods": [
            {
              "textRaw": "zlib.flush([kind], callback)",
              "type": "method",
              "name": "flush",
              "meta": {
                "added": [
                  "v0.5.8"
                ]
              },
              "desc": "
kind defaults to zlib.Z_FULL_FLUSH.
\n
Flush pending data. Don't call this frivolously, premature flushes negatively\nimpact the effectiveness of the compression algorithm.
\n
Calling this only flushes data from the internal zlib state, and does not\nperform flushing of any kind on the streams level. Rather, it behaves like a\nnormal call to .write(), i.e. it will be queued up behind other pending\nwrites and will only produce output when data is being read from the stream.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "kind",
                      "optional": true
                    },
                    {
                      "name": "callback"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "zlib.params(level, strategy, callback)",
              "type": "method",
              "name": "params",
              "meta": {
                "added": [
                  "v0.11.4"
                ]
              },
              "desc": "
Dynamically update the compression level and compression strategy.\nOnly applicable to deflate algorithm.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "level"
                    },
                    {
                      "name": "strategy"
                    },
                    {
                      "name": "callback"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "zlib.reset()",
              "type": "method",
              "name": "reset",
              "meta": {
                "added": [
                  "v0.7.0"
                ]
              },
              "desc": "
Reset the compressor/decompressor to factory defaults. Only applicable to\nthe inflate and deflate algorithms.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            }
          ]
        }
      ],
      "methods": [
        {
          "textRaw": "zlib.createDeflate([options])",
          "type": "method",
          "name": "createDeflate",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
Returns a new Deflate object with an options.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "zlib.createDeflateRaw([options])",
          "type": "method",
          "name": "createDeflateRaw",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
Returns a new DeflateRaw object with an options.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "zlib.createGunzip([options])",
          "type": "method",
          "name": "createGunzip",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
Returns a new Gunzip object with an options.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "zlib.createGzip([options])",
          "type": "method",
          "name": "createGzip",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
Returns a new Gzip object with an options.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "zlib.createInflate([options])",
          "type": "method",
          "name": "createInflate",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
Returns a new Inflate object with an options.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "zlib.createInflateRaw([options])",
          "type": "method",
          "name": "createInflateRaw",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
Returns a new InflateRaw object with an options.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "zlib.createUnzip([options])",
          "type": "method",
          "name": "createUnzip",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
Returns a new Unzip object with an options.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "Zlib"
    }
  ],
  "stability": 2,
  "stabilityText": "Stable",
  "classes": [
    {
      "textRaw": "Class: Error",
      "type": "class",
      "name": "Error",
      "desc": "
A generic JavaScript Error object that does not denote any specific\ncircumstance of why the error occurred. Error objects capture a "stack trace"\ndetailing the point in the code at which the Error was instantiated, and may\nprovide a text description of the error.
\n
All errors generated by Node.js, including all System and JavaScript errors,\nwill either be instances of, or inherit from, the Error class.
\n",
      "methods": [
        {
          "textRaw": "Error.captureStackTrace(targetObject[, constructorOpt])",
          "type": "method",
          "name": "captureStackTrace",
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`targetObject` {Object} ",
                  "name": "targetObject",
                  "type": "Object"
                },
                {
                  "textRaw": "`constructorOpt` {Function} ",
                  "name": "constructorOpt",
                  "type": "Function",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "targetObject"
                },
                {
                  "name": "constructorOpt",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "
Creates a .stack property on targetObject, which when accessed returns\na string representing the location in the code at which\nError.captureStackTrace() was called.
\n
const myObject = {};\nError.captureStackTrace(myObject);\nmyObject.stack  // similar to `new Error().stack`\n
\n
The first line of the trace, instead of being prefixed with ErrorType:\nmessage, will be the result of calling targetObject.toString().
\n
The optional constructorOpt argument accepts a function. If given, all frames\nabove constructorOpt, including constructorOpt, will be omitted from the\ngenerated stack trace.
\n
The constructorOpt argument is useful for hiding implementation\ndetails of error generation from an end user. For instance:
\n
function MyError() {\n  Error.captureStackTrace(this, MyError);\n}\n\n// Without passing MyError to captureStackTrace, the MyError\n// frame would show up in the .stack property. By passing\n// the constructor, we omit that frame and all frames above it.\nnew MyError().stack\n
\n"
        }
      ],
      "properties": [
        {
          "textRaw": "`stackTraceLimit` {Number} ",
          "type": "Number",
          "name": "stackTraceLimit",
          "desc": "
The Error.stackTraceLimit property specifies the number of stack frames\ncollected by a stack trace (whether generated by new Error().stack or\nError.captureStackTrace(obj)).
\n
The default value is 10 but may be set to any valid JavaScript number. Changes\nwill affect any stack trace captured after the value has been changed.
\n
If set to a non-number value, or set to a negative number, stack traces will\nnot capture any frames.
\n",
          "properties": [
            {
              "textRaw": "`message` {String} ",
              "type": "String",
              "name": "message",
              "desc": "
The error.message property is the string description of the error as set by calling new Error(message).\nThe message passed to the constructor will also appear in the first line of\nthe stack trace of the Error, however changing this property after the\nError object is created may not change the first line of the stack trace\n(for example, when error.stack is read before this property is changed).
\n
const err = new Error('The message');\nconsole.log(err.message);\n  // Prints: The message\n
\n"
            },
            {
              "textRaw": "`stack` {String} ",
              "type": "String",
              "name": "stack",
              "desc": "
The error.stack property is a string describing the point in the code at which\nthe Error was instantiated.
\n
For example:
\n
Error: Things keep happening!\n   at /home/gbusey/file.js:525:2\n   at Frobnicator.refrobulate (/home/gbusey/business-logic.js:424:21)\n   at Actor.<anonymous> (/home/gbusey/actors.js:400:8)\n   at increaseSynergy (/home/gbusey/actors.js:701:6)\n
The first line is formatted as <error class name>: <error message>, and\nis followed by a series of stack frames (each line beginning with "at ").\nEach frame describes a call site within the code that lead to the error being\ngenerated. V8 attempts to display a name for each function (by variable name,\nfunction name, or object method name), but occasionally it will not be able to\nfind a suitable name. If V8 cannot determine a name for the function, only\nlocation information will be displayed for that frame. Otherwise, the\ndetermined function name will be displayed with location information appended\nin parentheses.
\n
It is important to note that frames are only generated for JavaScript\nfunctions. If, for example, execution synchronously passes through a C++ addon\nfunction called cheetahify, which itself calls a JavaScript function, the\nframe representing the cheetahify call will not be present in the stack\ntraces:
\n
const cheetahify = require('./native-binding.node');\n\nfunction makeFaster() {\n  // cheetahify *synchronously* calls speedy.\n  cheetahify(function speedy() {\n    throw new Error('oh no!');\n  });\n}\n\nmakeFaster(); // will throw:\n  // /home/gbusey/file.js:6\n  //     throw new Error('oh no!');\n  //           ^\n  // Error: oh no!\n  //     at speedy (/home/gbusey/file.js:6:11)\n  //     at makeFaster (/home/gbusey/file.js:5:3)\n  //     at Object.<anonymous> (/home/gbusey/file.js:10:1)\n  //     at Module._compile (module.js:456:26)\n  //     at Object.Module._extensions..js (module.js:474:10)\n  //     at Module.load (module.js:356:32)\n  //     at Function.Module._load (module.js:312:12)\n  //     at Function.Module.runMain (module.js:497:10)\n  //     at startup (node.js:119:16)\n  //     at node.js:906:3\n
\n
The location information will be one of:
\n
    \n
  • native, if the frame represents a call internal to V8 (as in [].forEach).
    • \n
  • plain-filename.js:line:column, if the frame represents a call internal\n to Node.js.
    • \n
  • /absolute/path/to/file.js:line:column, if the frame represents a call in\na user program, or its dependencies.
    • \n
\n
The string representing the stack trace is lazily generated when the\nerror.stack property is accessed.
\n
The number of frames captured by the stack trace is bounded by the smaller of\nError.stackTraceLimit or the number of available frames on the current event\nloop tick.
\n
System-level errors are generated as augmented Error instances, which are\ndetailed here.
\n"
            }
          ]
        }
      ],
      "signatures": [
        {
          "params": [
            {
              "textRaw": "`message` {String} ",
              "name": "message",
              "type": "String"
            }
          ],
          "desc": "
Creates a new Error object and sets the error.message property to the\nprovided text message. If an object is passed as message, the text message\nis generated by calling message.toString(). The error.stack property will\nrepresent the point in the code at which new Error() was called. Stack traces\nare dependent on V8's stack trace API. Stack traces extend only to either\n(a) the beginning of  synchronous code execution, or (b) the number of frames\ngiven by the property Error.stackTraceLimit, whichever is smaller.
\n"
        },
        {
          "params": [
            {
              "name": "message"
            }
          ],
          "desc": "
Creates a new Error object and sets the error.message property to the\nprovided text message. If an object is passed as message, the text message\nis generated by calling message.toString(). The error.stack property will\nrepresent the point in the code at which new Error() was called. Stack traces\nare dependent on V8's stack trace API. Stack traces extend only to either\n(a) the beginning of  synchronous code execution, or (b) the number of frames\ngiven by the property Error.stackTraceLimit, whichever is smaller.
\n"
        }
      ]
    },
    {
      "textRaw": "Class: RangeError",
      "type": "class",
      "name": "RangeError",
      "desc": "
A subclass of Error that indicates that a provided argument was not within the\nset or range of acceptable values for a function; whether that is a numeric\nrange, or outside the set of options for a given function parameter.
\n
For example:
\n
require('net').connect(-1);\n  // throws RangeError, port should be > 0 && < 65536\n
\n
Node.js will generate and throw RangeError instances immediately as a form\nof argument validation.
\n"
    },
    {
      "textRaw": "Class: ReferenceError",
      "type": "class",
      "name": "ReferenceError",
      "desc": "
A subclass of Error that indicates that an attempt is being made to access a\nvariable that is not defined. Such errors commonly indicate typos in code, or\nan otherwise broken program.
\n
While client code may generate and propagate these errors, in practice, only V8\nwill do so.
\n
doesNotExist;\n  // throws ReferenceError, doesNotExist is not a variable in this program.\n
\n
ReferenceError instances will have an error.arguments property whose value\nis an array containing a single element: a string representing the variable\nthat was not defined.
\n
const assert = require('assert');\ntry {\n  doesNotExist;\n} catch(err) {\n  assert(err.arguments[0], 'doesNotExist');\n}\n
\n
Unless an application is dynamically generating and running code,\nReferenceError instances should always be considered a bug in the code\nor its dependencies.
\n"
    },
    {
      "textRaw": "Class: SyntaxError",
      "type": "class",
      "name": "SyntaxError",
      "desc": "
A subclass of Error that indicates that a program is not valid JavaScript.\nThese errors may only be generated and propagated as a result of code\nevaluation. Code evaluation may happen as a result of eval, Function,\nrequire, or vm. These errors are almost always indicative of a broken\nprogram.
\n
try {\n  require('vm').runInThisContext('binary ! isNotOk');\n} catch(err) {\n  // err will be a SyntaxError\n}\n
\n
SyntaxError instances are unrecoverable in the context that created them –\nthey may only be caught by other contexts.
\n"
    },
    {
      "textRaw": "Class: TypeError",
      "type": "class",
      "name": "TypeError",
      "desc": "
A subclass of Error that indicates that a provided argument is not an\nallowable type. For example, passing a function to a parameter which expects a\nstring would be considered a TypeError.
\n
require('url').parse(() => { });\n  // throws TypeError, since it expected a string\n
\n
Node.js will generate and throw TypeError instances immediately as a form\nof argument validation.
\n"
    }
  ],
  "globals": [
    {
      "textRaw": "Class: Buffer",
      "type": "global",
      "name": "Buffer",
      "meta": {
        "added": [
          "v0.1.103"
        ]
      },
      "desc": "
    \n
  • {Function}
    • \n
\n
Used to handle binary data. See the buffer section.
\n"
    },
    {
      "textRaw": "clearImmediate(immediateObject)",
      "type": "global",
      "name": "clearImmediate",
      "meta": {
        "added": [
          "v0.9.1"
        ]
      },
      "desc": "
clearImmediate is described in the timers section.
\n"
    },
    {
      "textRaw": "clearInterval(intervalObject)",
      "type": "global",
      "name": "clearInterval",
      "meta": {
        "added": [
          "v0.0.1"
        ]
      },
      "desc": "
clearInterval is described in the timers section.
\n"
    },
    {
      "textRaw": "clearTimeout(timeoutObject)",
      "type": "global",
      "name": "clearTimeout",
      "meta": {
        "added": [
          "v0.0.1"
        ]
      },
      "desc": "
clearTimeout is described in the timers section.
\n"
    },
    {
      "textRaw": "console",
      "name": "console",
      "meta": {
        "added": [
          "v0.1.100"
        ]
      },
      "type": "global",
      "desc": "
    \n
  • {Object}
    • \n
\n
Used to print to stdout and stderr. See the console section.
\n"
    },
    {
      "textRaw": "global",
      "name": "global",
      "meta": {
        "added": [
          "v0.1.27"
        ]
      },
      "type": "global",
      "desc": "
    \n
  • {Object} The global namespace object.
    • \n
\n
In browsers, the top-level scope is the global scope. That means that in\nbrowsers if you're in the global scope var something will define a global\nvariable. In Node.js this is different. The top-level scope is not the global\nscope; var something inside an Node.js module will be local to that module.
\n"
    },
    {
      "textRaw": "process",
      "name": "process",
      "meta": {
        "added": [
          "v0.1.7"
        ]
      },
      "type": "global",
      "desc": "
    \n
  • {Object}
    • \n
\n
The process object. See the process object section.
\n"
    },
    {
      "textRaw": "setImmediate(callback[, arg][, ...])",
      "type": "global",
      "name": "setImmediate",
      "meta": {
        "added": [
          "v0.9.1"
        ]
      },
      "desc": "
setImmediate is described in the timers section.
\n"
    },
    {
      "textRaw": "setInterval(callback, delay[, arg][, ...])",
      "type": "global",
      "name": "setInterval",
      "meta": {
        "added": [
          "v0.0.1"
        ]
      },
      "desc": "
setInterval is described in the timers section.
\n"
    },
    {
      "textRaw": "setTimeout(callback, delay[, arg][, ...])",
      "type": "global",
      "name": "setTimeout",
      "meta": {
        "added": [
          "v0.0.1"
        ]
      },
      "desc": "
setTimeout is described in the timers section.
\n\n\n"
    },
    {
      "textRaw": "Process",
      "name": "Process",
      "type": "global",
      "desc": "
The process object is a global object and can be accessed from anywhere.\nIt is an instance of EventEmitter.
\n",
      "events": [
        {
          "textRaw": "Event: 'beforeExit'",
          "type": "event",
          "name": "beforeExit",
          "meta": {
            "added": [
              "v0.11.12"
            ]
          },
          "desc": "
This event is emitted when Node.js empties its event loop and has nothing else\nto schedule. Normally, Node.js exits when there is no work scheduled, but a\nlistener for 'beforeExit' can make asynchronous calls, and cause Node.js to\ncontinue.
\n
'beforeExit' is not emitted for conditions causing explicit termination, such\nas process.exit() or uncaught exceptions, and should not be used as an\nalternative to the 'exit' event unless the intention is to schedule more work.
\n",
          "params": []
        },
        {
          "textRaw": "Event: 'exit'",
          "type": "event",
          "name": "exit",
          "meta": {
            "added": [
              "v0.1.7"
            ]
          },
          "desc": "
Emitted when the process is about to exit. There is no way to prevent the\nexiting of the event loop at this point, and once all 'exit' listeners have\nfinished running the process will exit. Therefore you must only perform\nsynchronous operations in this handler. This is a good hook to perform\nchecks on the module's state (like for unit tests). The callback takes one\nargument, the code the process is exiting with.
\n
This event is only emitted when Node.js exits explicitly by process.exit() or\nimplicitly by the event loop draining.
\n
Example of listening for 'exit':
\n
process.on('exit', (code) => {\n  // do *NOT* do this\n  setTimeout(() => {\n    console.log('This will not run');\n  }, 0);\n  console.log('About to exit with code:', code);\n});\n
\n",
          "params": []
        },
        {
          "textRaw": "Event: 'message'",
          "type": "event",
          "name": "message",
          "meta": {
            "added": [
              "v0.5.10"
            ]
          },
          "params": [],
          "desc": "
Messages sent by ChildProcess.send() are obtained using the 'message'\nevent on the child's process object.
\n"
        },
        {
          "textRaw": "Event: 'rejectionHandled'",
          "type": "event",
          "name": "rejectionHandled",
          "meta": {
            "added": [
              "v1.4.1"
            ]
          },
          "desc": "
Emitted whenever a Promise was rejected and an error handler was attached to it\n(for example with .catch()) later than after an event loop turn. This event\nis emitted with the following arguments:
\n
    \n
  • p the promise that was previously emitted in an 'unhandledRejection'\nevent, but which has now gained a rejection handler.
    • \n
\n
There is no notion of a top level for a promise chain at which rejections can\nalways be handled. Being inherently asynchronous in nature, a promise rejection\ncan be handled at a future point in time — possibly much later than the\nevent loop turn it takes for the 'unhandledRejection' event to be emitted.
\n
Another way of stating this is that, unlike in synchronous code where there is\nan ever-growing list of unhandled exceptions, with promises there is a\ngrowing-and-shrinking list of unhandled rejections. In synchronous code, the\n'uncaughtException' event tells you when the list of unhandled exceptions\ngrows. And in asynchronous code, the 'unhandledRejection' event tells you\nwhen the list of unhandled rejections grows, while the 'rejectionHandled'\nevent tells you when the list of unhandled rejections shrinks.
\n
For example using the rejection detection hooks in order to keep a map of all\nthe rejected promise reasons at a given time:
\n
const unhandledRejections = new Map();\nprocess.on('unhandledRejection', (reason, p) => {\n  unhandledRejections.set(p, reason);\n});\nprocess.on('rejectionHandled', (p) => {\n  unhandledRejections.delete(p);\n});\n
\n
This map will grow and shrink over time, reflecting rejections that start\nunhandled and then become handled. You could record the errors in some error\nlog, either periodically (probably best for long-running programs, allowing\nyou to clear the map, which in the case of a very buggy program could grow\nindefinitely) or upon process exit (more convenient for scripts).
\n",
          "params": []
        },
        {
          "textRaw": "Event: 'uncaughtException'",
          "type": "event",
          "name": "uncaughtException",
          "meta": {
            "added": [
              "v0.1.18"
            ]
          },
          "desc": "
The 'uncaughtException' event is emitted when an exception bubbles all the\nway back to the event loop. By default, Node.js handles such exceptions by\nprinting the stack trace to stderr and exiting. Adding a handler for the\n'uncaughtException' event overrides this default behavior.
\n
For example:
\n
process.on('uncaughtException', (err) => {\n  console.log(`Caught exception: ${err}`);\n});\n\nsetTimeout(() => {\n  console.log('This will still run.');\n}, 500);\n\n// Intentionally cause an exception, but don't catch it.\nnonexistentFunc();\nconsole.log('This will not run.');\n
\n",
          "modules": [
            {
              "textRaw": "Warning: Using `'uncaughtException'` correctly",
              "name": "warning:_using_`'uncaughtexception'`_correctly",
              "desc": "
Note that 'uncaughtException' is a crude mechanism for exception handling\nintended to be used only as a last resort. The event should not be used as\nan equivalent to On Error Resume Next. Unhandled exceptions inherently mean\nthat an application is in an undefined state. Attempting to resume application\ncode without properly recovering from the exception can cause additional\nunforeseen and unpredictable issues.
\n
Exceptions thrown from within the event handler will not be caught. Instead the\nprocess will exit with a non-zero exit code and the stack trace will be printed.\nThis is to avoid infinite recursion.
\n
Attempting to resume normally after an uncaught exception can be similar to\npulling out of the power cord when upgrading a computer -- nine out of ten\ntimes nothing happens - but the 10th time, the system becomes corrupted.
\n
The correct use of 'uncaughtException' is to perform synchronous cleanup\nof allocated resources (e.g. file descriptors, handles, etc) before shutting\ndown the process. It is not safe to resume normal operation after\n'uncaughtException'.
\n",
              "type": "module",
              "displayName": "Warning: Using `'uncaughtException'` correctly"
            }
          ],
          "params": []
        },
        {
          "textRaw": "Event: 'unhandledRejection'",
          "type": "event",
          "name": "unhandledRejection",
          "meta": {
            "added": [
              "v1.4.1"
            ]
          },
          "desc": "
Emitted whenever a Promise is rejected and no error handler is attached to\nthe promise within a turn of the event loop. When programming with promises\nexceptions are encapsulated as rejected promises. Such promises can be caught\nand handled using promise.catch(...) and rejections are propagated through\na promise chain. This event is useful for detecting and keeping track of\npromises that were rejected whose rejections were not handled yet. This event\nis emitted with the following arguments:
\n
    \n
  • reason the object with which the promise was rejected (usually an\nError instance).
    • \n
  • p the promise that was rejected.
    • \n
\n
Here is an example that logs every unhandled rejection to the console
\n
process.on('unhandledRejection', (reason, p) => {\n  console.log('Unhandled Rejection at: Promise', p, 'reason:', reason);\n  // application specific logging, throwing an error, or other logic here\n});\n
\n
For example, here is a rejection that will trigger the 'unhandledRejection'\nevent:
\n
somePromise.then((res) => {\n  return reportToUser(JSON.pasre(res)); // note the typo (`pasre`)\n}); // no `.catch` or `.then`\n
\n
Here is an example of a coding pattern that will also trigger\n'unhandledRejection':
\n
function SomeResource() {\n  // Initially set the loaded status to a rejected promise\n  this.loaded = Promise.reject(new Error('Resource not yet loaded!'));\n}\n\nvar resource = new SomeResource();\n// no .catch or .then on resource.loaded for at least a turn\n
\n
In cases like this, you may not want to track the rejection as a developer\nerror like you would for other 'unhandledRejection' events. To address\nthis, you can either attach a dummy .catch(() => { }) handler to\nresource.loaded, preventing the 'unhandledRejection' event from being\nemitted, or you can use the 'rejectionHandled' event.
\n",
          "params": []
        },
        {
          "textRaw": "Signal Events",
          "name": "SIGINT, SIGHUP, etc.",
          "type": "event",
          "desc": "
Emitted when the processes receives a signal. See sigaction(7) for a list of\nstandard POSIX signal names such as SIGINT, SIGHUP, etc.
\n
Example of listening for SIGINT:
\n
// Start reading from stdin so we don't exit.\nprocess.stdin.resume();\n\nprocess.on('SIGINT', () => {\n  console.log('Got SIGINT.  Press Control-D to exit.');\n});\n
\n
An easy way to send the SIGINT signal is with Control-C in most terminal\nprograms.
\n
Note:
\n
    \n
  • SIGUSR1 is reserved by Node.js to start the debugger.  It's possible to\ninstall a listener but that won't stop the debugger from starting.
    • \n
  • SIGTERM and SIGINT have default handlers on non-Windows platforms that\nresets the terminal mode before exiting with code 128 + signal number. If\none of these signals has a listener installed, its default behavior will be\nremoved (Node.js will no longer exit).
    • \n
  • SIGPIPE is ignored by default. It can have a listener installed.
    • \n
  • SIGHUP is generated on Windows when the console window is closed, and on other\nplatforms under various similar conditions, see signal(7). It can have a\nlistener installed, however Node.js will be unconditionally terminated by\nWindows about 10 seconds later. On non-Windows platforms, the default\nbehavior of SIGHUP is to terminate Node.js, but once a listener has been\ninstalled its default behavior will be removed.
    • \n
  • SIGTERM is not supported on Windows, it can be listened on.
    • \n
  • SIGINT from the terminal is supported on all platforms, and can usually be\ngenerated with CTRL+C (though this may be configurable). It is not generated\nwhen terminal raw mode is enabled.
    • \n
  • SIGBREAK is delivered on Windows when CTRL+BREAK is pressed, on\nnon-Windows\nplatforms it can be listened on, but there is no way to send or generate it.
    • \n
  • SIGWINCH is delivered when the console has been resized. On Windows, this\nwill only happen on write to the console when the cursor is being moved, or\nwhen a readable tty is used in raw mode.
    • \n
  • SIGKILL cannot have a listener installed, it will unconditionally terminate\nNode.js on all platforms.
    • \n
  • SIGSTOP cannot have a listener installed.
    • \n
\n
Note that Windows does not support sending Signals, but Node.js offers some\nemulation with process.kill(), and child_process.kill(). Sending signal 0\ncan be used to test for the existence of a process. Sending SIGINT,\nSIGTERM, and SIGKILL cause the unconditional termination of the target\nprocess.
\n",
          "params": []
        }
      ],
      "modules": [
        {
          "textRaw": "Exit Codes",
          "name": "exit_codes",
          "desc": "
Node.js will normally exit with a 0 status code when no more async\noperations are pending.  The following status codes are used in other\ncases:
\n
    \n
  • 1 Uncaught Fatal Exception - There was an uncaught exception,\nand it was not handled by a domain or an 'uncaughtException' event\nhandler.
    • \n
  • 2 - Unused (reserved by Bash for builtin misuse)
    • \n
  • 3 Internal JavaScript Parse Error - The JavaScript source code\ninternal in Node.js's bootstrapping process caused a parse error.  This\nis extremely rare, and generally can only happen during development\nof Node.js itself.
    • \n
  • 4 Internal JavaScript Evaluation Failure - The JavaScript\nsource code internal in Node.js's bootstrapping process failed to\nreturn a function value when evaluated.  This is extremely rare, and\ngenerally can only happen during development of Node.js itself.
    • \n
  • 5 Fatal Error - There was a fatal unrecoverable error in V8.\nTypically a message will be printed to stderr with the prefix FATAL\nERROR.
    • \n
  • 6 Non-function Internal Exception Handler - There was an\nuncaught exception, but the internal fatal exception handler\nfunction was somehow set to a non-function, and could not be called.
    • \n
  • 7 Internal Exception Handler Run-Time Failure - There was an\nuncaught exception, and the internal fatal exception handler\nfunction itself threw an error while attempting to handle it.  This\ncan happen, for example, if a process.on('uncaughtException') or\ndomain.on('error') handler throws an error.
    • \n
  • 8 - Unused.  In previous versions of Node.js, exit code 8 sometimes\nindicated an uncaught exception.
    • \n
  • 9 - Invalid Argument - Either an unknown option was specified,\nor an option requiring a value was provided without a value.
    • \n
  • 10 Internal JavaScript Run-Time Failure - The JavaScript\nsource code internal in Node.js's bootstrapping process threw an error\nwhen the bootstrapping function was called.  This is extremely rare,\nand generally can only happen during development of Node.js itself.
    • \n
  • 12 Invalid Debug Argument - The --debug and/or --debug-brk\noptions were set, but an invalid port number was chosen.
    • \n
  • >128 Signal Exits - If Node.js receives a fatal signal such as\nSIGKILL or SIGHUP, then its exit code will be 128 plus the\nvalue of the signal code.  This is a standard Unix practice, since\nexit codes are defined to be 7-bit integers, and signal exits set\nthe high-order bit, and then contain the value of the signal code.
    • \n
\n",
          "type": "module",
          "displayName": "Exit Codes"
        }
      ],
      "methods": [
        {
          "textRaw": "process.abort()",
          "type": "method",
          "name": "abort",
          "meta": {
            "added": [
              "v0.7.0"
            ]
          },
          "desc": "
This causes Node.js to emit an abort. This will cause Node.js to exit and\ngenerate a core file.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "process.chdir(directory)",
          "type": "method",
          "name": "chdir",
          "meta": {
            "added": [
              "v0.1.17"
            ]
          },
          "desc": "
Changes the current working directory of the process or throws an exception if that fails.
\n
console.log(`Starting directory: ${process.cwd()}`);\ntry {\n  process.chdir('/tmp');\n  console.log(`New directory: ${process.cwd()}`);\n}\ncatch (err) {\n  console.log(`chdir: ${err}`);\n}\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "directory"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "process.cpuUsage([previousValue])",
          "type": "method",
          "name": "cpuUsage",
          "desc": "
Returns the user and system CPU time usage of the current process, in an object\nwith properties user and system, whose values are microsecond values\n(millionth of a second). These values measure time spent in user and\nsystem code respectively, and may end up being greater than actual elapsed time\nif multiple CPU cores are performing work for this process.
\n
The result of a previous call to process.cpuUsage() can be passed as the\nargument to the function, to get a diff reading.
\n
const startUsage = process.cpuUsage();\n// { user: 38579, system: 6986 }\n\n// spin the CPU for 500 milliseconds\nconst now = Date.now();\nwhile (Date.now() - now < 500);\n\nconsole.log(process.cpuUsage(startUsage));\n// { user: 514883, system: 11226 }\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "previousValue",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "process.cwd()",
          "type": "method",
          "name": "cwd",
          "meta": {
            "added": [
              "v0.1.8"
            ]
          },
          "desc": "
Returns the current working directory of the process.
\n
console.log(`Current directory: ${process.cwd()}`);\n
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "process.disconnect()",
          "type": "method",
          "name": "disconnect",
          "meta": {
            "added": [
              "v0.7.2"
            ]
          },
          "desc": "
Close the IPC channel to the parent process, allowing this child to exit\ngracefully once there are no other connections keeping it alive.
\n
Identical to the parent process's ChildProcess.disconnect().
\n
If Node.js was not spawned with an IPC channel, process.disconnect() will be\nundefined.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "process.exit([code])",
          "type": "method",
          "name": "exit",
          "meta": {
            "added": [
              "v0.1.13"
            ]
          },
          "desc": "
Ends the process with the specified code.  If omitted, exit uses the\n'success' code 0.
\n
To exit with a 'failure' code:
\n
process.exit(1);\n
\n
The shell that executed Node.js should see the exit code as 1.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "code",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "process.getegid()",
          "type": "method",
          "name": "getegid",
          "meta": {
            "added": [
              "v2.0.0"
            ]
          },
          "desc": "
Note: this function is only available on POSIX platforms (i.e. not Windows,\nAndroid)
\n
Gets the effective group identity of the process. (See getegid(2).)\nThis is the numerical group id, not the group name.
\n
if (process.getegid) {\n  console.log(`Current gid: ${process.getegid()}`);\n}\n
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "process.geteuid()",
          "type": "method",
          "name": "geteuid",
          "meta": {
            "added": [
              "v2.0.0"
            ]
          },
          "desc": "
Note: this function is only available on POSIX platforms (i.e. not Windows,\nAndroid)
\n
Gets the effective user identity of the process. (See geteuid(2).)\nThis is the numerical userid, not the username.
\n
if (process.geteuid) {\n  console.log(`Current uid: ${process.geteuid()}`);\n}\n
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "process.getgid()",
          "type": "method",
          "name": "getgid",
          "meta": {
            "added": [
              "v0.1.31"
            ]
          },
          "desc": "
Note: this function is only available on POSIX platforms (i.e. not Windows,\nAndroid)
\n
Gets the group identity of the process. (See getgid(2).)\nThis is the numerical group id, not the group name.
\n
if (process.getgid) {\n  console.log(`Current gid: ${process.getgid()}`);\n}\n
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "process.getgroups()",
          "type": "method",
          "name": "getgroups",
          "meta": {
            "added": [
              "v0.9.4"
            ]
          },
          "desc": "
Note: this function is only available on POSIX platforms (i.e. not Windows,\nAndroid)
\n
Returns an array with the supplementary group IDs. POSIX leaves it unspecified\nif the effective group ID is included but Node.js ensures it always is.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "process.getuid()",
          "type": "method",
          "name": "getuid",
          "meta": {
            "added": [
              "v0.1.28"
            ]
          },
          "desc": "
Note: this function is only available on POSIX platforms (i.e. not Windows,\nAndroid)
\n
Gets the user identity of the process. (See getuid(2).)\nThis is the numerical userid, not the username.
\n
if (process.getuid) {\n  console.log(`Current uid: ${process.getuid()}`);\n}\n
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "process.hrtime()",
          "type": "method",
          "name": "hrtime",
          "meta": {
            "added": [
              "v0.7.6"
            ]
          },
          "desc": "
Returns the current high-resolution real time in a [seconds, nanoseconds]\ntuple Array. It is relative to an arbitrary time in the past. It is not\nrelated to the time of day and therefore not subject to clock drift. The\nprimary use is for measuring performance between intervals.
\n
You may pass in the result of a previous call to process.hrtime() to get\na diff reading, useful for benchmarks and measuring intervals:
\n
var time = process.hrtime();\n// [ 1800216, 25 ]\n\nsetTimeout(() => {\n  var diff = process.hrtime(time);\n  // [ 1, 552 ]\n\n  console.log('benchmark took %d nanoseconds', diff[0] * 1e9 + diff[1]);\n  // benchmark took 1000000527 nanoseconds\n}, 1000);\n
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "process.initgroups(user, extra_group)",
          "type": "method",
          "name": "initgroups",
          "meta": {
            "added": [
              "v0.9.4"
            ]
          },
          "desc": "
Note: this function is only available on POSIX platforms (i.e. not Windows,\nAndroid)
\n
Reads /etc/group and initializes the group access list, using all groups of\nwhich the user is a member. This is a privileged operation, meaning you need\nto be root or have the CAP_SETGID capability.
\n
user is a user name or user ID. extra_group is a group name or group ID.
\n
Some care needs to be taken when dropping privileges. Example:
\n
console.log(process.getgroups());         // [ 0 ]\nprocess.initgroups('bnoordhuis', 1000);   // switch user\nconsole.log(process.getgroups());         // [ 27, 30, 46, 1000, 0 ]\nprocess.setgid(1000);                     // drop root gid\nconsole.log(process.getgroups());         // [ 27, 30, 46, 1000 ]\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "user"
                },
                {
                  "name": "extra_group"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "process.kill(pid[, signal])",
          "type": "method",
          "name": "kill",
          "meta": {
            "added": [
              "v0.0.6"
            ]
          },
          "desc": "
Send a signal to a process. pid is the process id and signal is the\nstring describing the signal to send.  Signal names are strings like\nSIGINT or SIGHUP.  If omitted, the signal will be SIGTERM.\nSee Signal Events and kill(2) for more information.
\n
Will throw an error if target does not exist, and as a special case, a signal\nof 0 can be used to test for the existence of a process. Windows platforms\nwill throw an error if the pid is used to kill a process group.
\n
Note that even though the name of this function is process.kill, it is really\njust a signal sender, like the kill system call.  The signal sent may do\nsomething other than kill the target process.
\n
Example of sending a signal to yourself:
\n
process.on('SIGHUP', () => {\n  console.log('Got SIGHUP signal.');\n});\n\nsetTimeout(() => {\n  console.log('Exiting.');\n  process.exit(0);\n}, 100);\n\nprocess.kill(process.pid, 'SIGHUP');\n
\n
Note: When SIGUSR1 is received by Node.js it starts the debugger, see\nSignal Events.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "pid"
                },
                {
                  "name": "signal",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "process.memoryUsage()",
          "type": "method",
          "name": "memoryUsage",
          "meta": {
            "added": [
              "v0.1.16"
            ]
          },
          "signatures": [
            {
              "return": {
                "textRaw": "Returns: {Object} ",
                "options": [
                  {
                    "textRaw": "`rss` {Integer} ",
                    "name": "rss",
                    "type": "Integer"
                  },
                  {
                    "textRaw": "`heapTotal` {Integer} ",
                    "name": "heapTotal",
                    "type": "Integer"
                  },
                  {
                    "textRaw": "`heapUsed` {Integer} ",
                    "name": "heapUsed",
                    "type": "Integer"
                  },
                  {
                    "textRaw": "`external` {Integer} ",
                    "name": "external",
                    "type": "Integer"
                  }
                ],
                "name": "return",
                "type": "Object"
              },
              "params": []
            },
            {
              "params": []
            }
          ],
          "desc": "
The process.memoryUsage() method returns an object describing the memory usage\nof the Node.js process measured in bytes.
\n
For example, the code:
\n
console.log(process.memoryUsage());\n
\n
This will generate:
\n
{ rss: 4935680,\n  heapTotal: 1826816,\n  heapUsed: 650472,\n  external: 49879\n}\n
\n
heapTotal and heapUsed refer to V8's memory usage.\nexternal refers to the memory usage of C++ objects bound to JavaScript\nobjects managed by V8.
\n"
        },
        {
          "textRaw": "process.nextTick(callback[, arg][, ...])",
          "type": "method",
          "name": "nextTick",
          "meta": {
            "added": [
              "v0.1.26"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`callback` {Function} ",
                  "name": "callback",
                  "type": "Function"
                },
                {
                  "name": "arg",
                  "optional": true
                },
                {
                  "name": "...",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "callback"
                },
                {
                  "name": "arg",
                  "optional": true
                },
                {
                  "name": "...",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "
Once the current event loop turn runs to completion, call the callback\nfunction.
\n
This is not a simple alias to setTimeout(fn, 0), it's much more\nefficient.  It runs before any additional I/O events (including\ntimers) fire in subsequent ticks of the event loop.
\n
console.log('start');\nprocess.nextTick(() => {\n  console.log('nextTick callback');\n});\nconsole.log('scheduled');\n// Output:\n// start\n// scheduled\n// nextTick callback\n
\n
This is important in developing APIs where you want to give the user the\nchance to assign event handlers after an object has been constructed,\nbut before any I/O has occurred.
\n
function MyThing(options) {\n  this.setupOptions(options);\n\n  process.nextTick(() => {\n    this.startDoingStuff();\n  });\n}\n\nvar thing = new MyThing();\nthing.getReadyForStuff();\n\n// thing.startDoingStuff() gets called now, not before.\n
\n
It is very important for APIs to be either 100% synchronous or 100%\nasynchronous.  Consider this example:
\n
// WARNING!  DO NOT USE!  BAD UNSAFE HAZARD!\nfunction maybeSync(arg, cb) {\n  if (arg) {\n    cb();\n    return;\n  }\n\n  fs.stat('file', cb);\n}\n
\n
This API is hazardous.  If you do this:
\n
maybeSync(true, () => {\n  foo();\n});\nbar();\n
\n
then it's not clear whether foo() or bar() will be called first.
\n
This approach is much better:
\n
function definitelyAsync(arg, cb) {\n  if (arg) {\n    process.nextTick(cb);\n    return;\n  }\n\n  fs.stat('file', cb);\n}\n
\n
Note: the nextTick queue is completely drained on each pass of the\nevent loop before additional I/O is processed.  As a result,\nrecursively setting nextTick callbacks will block any I/O from\nhappening, just like a while(true); loop.
\n"
        },
        {
          "textRaw": "process.send(message[, sendHandle][, callback])",
          "type": "method",
          "name": "send",
          "meta": {
            "added": [
              "v0.5.9"
            ]
          },
          "signatures": [
            {
              "return": {
                "textRaw": "Returns: {Boolean} ",
                "name": "return",
                "type": "Boolean"
              },
              "params": [
                {
                  "textRaw": "`message` {Object} ",
                  "name": "message",
                  "type": "Object"
                },
                {
                  "textRaw": "`sendHandle` {Handle object} ",
                  "name": "sendHandle",
                  "type": "Handle object",
                  "optional": true
                },
                {
                  "textRaw": "`callback` {Function} ",
                  "name": "callback",
                  "type": "Function",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "message"
                },
                {
                  "name": "sendHandle",
                  "optional": true
                },
                {
                  "name": "callback",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "
When Node.js is spawned with an IPC channel attached, it can send messages to its\nparent process using process.send(). Each will be received as a\n'message' event on the parent's ChildProcess object.
\n
Note: this function uses JSON.stringify() internally to serialize the message.
\n
If Node.js was not spawned with an IPC channel, process.send() will be undefined.
\n"
        },
        {
          "textRaw": "process.setegid(id)",
          "type": "method",
          "name": "setegid",
          "meta": {
            "added": [
              "v2.0.0"
            ]
          },
          "desc": "
Note: this function is only available on POSIX platforms (i.e. not Windows,\nAndroid)
\n
Sets the effective group identity of the process. (See setegid(2).)\nThis accepts either a numerical ID or a groupname string. If a groupname\nis specified, this method blocks while resolving it to a numerical ID.
\n
if (process.getegid && process.setegid) {\n  console.log(`Current gid: ${process.getegid()}`);\n  try {\n    process.setegid(501);\n    console.log(`New gid: ${process.getegid()}`);\n  }\n  catch (err) {\n    console.log(`Failed to set gid: ${err}`);\n  }\n}\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "id"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "process.seteuid(id)",
          "type": "method",
          "name": "seteuid",
          "meta": {
            "added": [
              "v2.0.0"
            ]
          },
          "desc": "
Note: this function is only available on POSIX platforms (i.e. not Windows,\nAndroid)
\n
Sets the effective user identity of the process. (See seteuid(2).)\nThis accepts either a numerical ID or a username string.  If a username\nis specified, this method blocks while resolving it to a numerical ID.
\n
if (process.geteuid && process.seteuid) {\n  console.log(`Current uid: ${process.geteuid()}`);\n  try {\n    process.seteuid(501);\n    console.log(`New uid: ${process.geteuid()}`);\n  }\n  catch (err) {\n    console.log(`Failed to set uid: ${err}`);\n  }\n}\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "id"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "process.setgid(id)",
          "type": "method",
          "name": "setgid",
          "meta": {
            "added": [
              "v0.1.31"
            ]
          },
          "desc": "
Note: this function is only available on POSIX platforms (i.e. not Windows,\nAndroid)
\n
Sets the group identity of the process. (See setgid(2).)  This accepts either\na numerical ID or a groupname string. If a groupname is specified, this method\nblocks while resolving it to a numerical ID.
\n
if (process.getgid && process.setgid) {\n  console.log(`Current gid: ${process.getgid()}`);\n  try {\n    process.setgid(501);\n    console.log(`New gid: ${process.getgid()}`);\n  }\n  catch (err) {\n    console.log(`Failed to set gid: ${err}`);\n  }\n}\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "id"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "process.setgroups(groups)",
          "type": "method",
          "name": "setgroups",
          "meta": {
            "added": [
              "v0.9.4"
            ]
          },
          "desc": "
Note: this function is only available on POSIX platforms (i.e. not Windows,\nAndroid)
\n
Sets the supplementary group IDs. This is a privileged operation, meaning you\nneed to be root or have the CAP_SETGID capability.
\n
The list can contain group IDs, group names or both.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "groups"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "process.setuid(id)",
          "type": "method",
          "name": "setuid",
          "meta": {
            "added": [
              "v0.1.28"
            ]
          },
          "desc": "
Note: this function is only available on POSIX platforms (i.e. not Windows,\nAndroid)
\n
Sets the user identity of the process. (See setuid(2).)  This accepts either\na numerical ID or a username string.  If a username is specified, this method\nblocks while resolving it to a numerical ID.
\n
if (process.getuid && process.setuid) {\n  console.log(`Current uid: ${process.getuid()}`);\n  try {\n    process.setuid(501);\n    console.log(`New uid: ${process.getuid()}`);\n  }\n  catch (err) {\n    console.log(`Failed to set uid: ${err}`);\n  }\n}\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "id"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "process.umask([mask])",
          "type": "method",
          "name": "umask",
          "meta": {
            "added": [
              "v0.1.19"
            ]
          },
          "desc": "
Sets or reads the process's file mode creation mask. Child processes inherit\nthe mask from the parent process. Returns the old mask if mask argument is\ngiven, otherwise returns the current mask.
\n
const newmask = 0o022;\nconst oldmask = process.umask(newmask);\nconsole.log(\n  `Changed umask from ${oldmask.toString(8)} to ${newmask.toString(8)}`\n);\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "mask",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "process.uptime()",
          "type": "method",
          "name": "uptime",
          "meta": {
            "added": [
              "v0.5.0"
            ]
          },
          "desc": "
Number of seconds Node.js has been running.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        }
      ],
      "properties": [
        {
          "textRaw": "process.arch",
          "name": "arch",
          "meta": {
            "added": [
              "v0.5.0"
            ]
          },
          "desc": "
What processor architecture you're running on: 'arm', 'ia32', or 'x64'.
\n
console.log('This processor architecture is ' + process.arch);\n
\n"
        },
        {
          "textRaw": "process.argv",
          "name": "argv",
          "meta": {
            "added": [
              "v0.1.27"
            ]
          },
          "desc": "
An array containing the command line arguments.  The first element will be\n'node', the second element will be the name of the JavaScript file.  The\nnext elements will be any additional command line arguments.
\n
// print process.argv\nprocess.argv.forEach((val, index, array) => {\n  console.log(`${index}: ${val}`);\n});\n
\n
This will generate:
\n
$ node process-2.js one two=three four\n0: node\n1: /Users/mjr/work/node/process-2.js\n2: one\n3: two=three\n4: four\n
"
        },
        {
          "textRaw": "process.config",
          "name": "config",
          "meta": {
            "added": [
              "v0.7.7"
            ]
          },
          "desc": "
An Object containing the JavaScript representation of the configure options\nthat were used to compile the current Node.js executable. This is the same as\nthe config.gypi file that was produced when running the ./configure script.
\n
An example of the possible output looks like:
\n
{\n  target_defaults:\n   { cflags: [],\n     default_configuration: 'Release',\n     defines: [],\n     include_dirs: [],\n     libraries: [] },\n  variables:\n   {\n     host_arch: 'x64',\n     node_install_npm: 'true',\n     node_prefix: '',\n     node_shared_cares: 'false',\n     node_shared_http_parser: 'false',\n     node_shared_libuv: 'false',\n     node_shared_zlib: 'false',\n     node_use_dtrace: 'false',\n     node_use_openssl: 'true',\n     node_shared_openssl: 'false',\n     strict_aliasing: 'true',\n     target_arch: 'x64',\n     v8_use_snapshot: 'true'\n   }\n}\n
Note: the process.config property is not read-only and there are existing\nmodules in the ecosystem that are known to extend, modify, or entirely replace\nthe value of process.config.
\n"
        },
        {
          "textRaw": "`connected` {Boolean} Set to false after `process.disconnect()` is called ",
          "type": "Boolean",
          "name": "connected",
          "meta": {
            "added": [
              "v0.7.2"
            ]
          },
          "desc": "
If process.connected is false, it is no longer possible to send messages.
\n",
          "shortDesc": "Set to false after `process.disconnect()` is called"
        },
        {
          "textRaw": "process.env",
          "name": "env",
          "meta": {
            "added": [
              "v0.1.27"
            ]
          },
          "desc": "
An object containing the user environment. See environ(7).
\n
An example of this object looks like:
\n
{ TERM: 'xterm-256color',\n  SHELL: '/usr/local/bin/bash',\n  USER: 'maciej',\n  PATH: '~/.bin/:/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin',\n  PWD: '/Users/maciej',\n  EDITOR: 'vim',\n  SHLVL: '1',\n  HOME: '/Users/maciej',\n  LOGNAME: 'maciej',\n  _: '/usr/local/bin/node' }\n
\n
You can write to this object, but changes won't be reflected outside of your\nprocess. That means that the following won't work:
\n
$ node -e 'process.env.foo = "bar"' && echo $foo\n
But this will:
\n
process.env.foo = 'bar';\nconsole.log(process.env.foo);\n
\n
Assigning a property on process.env will implicitly convert the value\nto a string.
\n
Example:
\n
process.env.test = null;\nconsole.log(process.env.test);\n// => 'null'\nprocess.env.test = undefined;\nconsole.log(process.env.test);\n// => 'undefined'\n
\n
Use delete to delete a property from process.env.
\n
Example:
\n
process.env.TEST = 1;\ndelete process.env.TEST;\nconsole.log(process.env.TEST);\n// => undefined\n
\n"
        },
        {
          "textRaw": "process.execArgv",
          "name": "execArgv",
          "meta": {
            "added": [
              "v0.7.7"
            ]
          },
          "desc": "
This is the set of Node.js-specific command line options from the\nexecutable that started the process.  These options do not show up in\nprocess.argv, and do not include the Node.js executable, the name of\nthe script, or any options following the script name. These options\nare useful in order to spawn child processes with the same execution\nenvironment as the parent.
\n
Example:
\n
$ node --harmony script.js --version\n
results in process.execArgv:
\n
['--harmony']\n
\n
and process.argv:
\n
['/usr/local/bin/node', 'script.js', '--version']\n
\n"
        },
        {
          "textRaw": "process.execPath",
          "name": "execPath",
          "meta": {
            "added": [
              "v0.1.100"
            ]
          },
          "desc": "
This is the absolute pathname of the executable that started the process.
\n
Example:
\n
/usr/local/bin/node\n
"
        },
        {
          "textRaw": "process.exitCode",
          "name": "exitCode",
          "meta": {
            "added": [
              "v0.11.8"
            ]
          },
          "desc": "
A number which will be the process exit code, when the process either\nexits gracefully, or is exited via process.exit() without specifying\na code.
\n
Specifying a code to process.exit(code) will override any previous\nsetting of process.exitCode.
\n"
        },
        {
          "textRaw": "process.mainModule",
          "name": "mainModule",
          "meta": {
            "added": [
              "v0.1.17"
            ]
          },
          "desc": "
Alternate way to retrieve require.main. The difference is that if the main\nmodule changes at runtime, require.main might still refer to the original main\nmodule in modules that were required before the change occurred. Generally it's\nsafe to assume that the two refer to the same module.
\n
As with require.main, it will be undefined if there was no entry script.
\n"
        },
        {
          "textRaw": "process.pid",
          "name": "pid",
          "meta": {
            "added": [
              "v0.1.15"
            ]
          },
          "desc": "
The PID of the process.
\n
console.log(`This process is pid ${process.pid}`);\n
\n"
        },
        {
          "textRaw": "process.platform",
          "name": "platform",
          "meta": {
            "added": [
              "v0.1.16"
            ]
          },
          "desc": "
What platform you're running on:\n'darwin', 'freebsd', 'linux', 'sunos' or 'win32'
\n
console.log(`This platform is ${process.platform}`);\n
\n"
        },
        {
          "textRaw": "process.release",
          "name": "release",
          "meta": {
            "added": [
              "v3.0.0"
            ]
          },
          "desc": "
An Object containing metadata related to the current release, including URLs\nfor the source tarball and headers-only tarball.
\n
process.release contains the following properties:
\n
    \n
  • name: a string with a value that will always be 'node' for Node.js. For\nlegacy io.js releases, this will be 'io.js'.
    • \n
  • sourceUrl: a complete URL pointing to a .tar.gz file containing the\nsource of the current release.
    • \n
  • headersUrl: a complete URL pointing to a .tar.gz file containing only\nthe header files for the current release. This file is significantly smaller\nthan the full source file and can be used for compiling add-ons against\nNode.js.
    • \n
  • libUrl: a complete URL pointing to an node.lib file matching the\narchitecture and version of the current release. This file is used for\ncompiling add-ons against Node.js. This property is only present on Windows\nbuilds of Node.js and will be missing on all other platforms.
    • \n
\n
e.g.
\n
{ name: 'node',\n  sourceUrl: 'https://nodejs.org/download/release/v4.0.0/node-v4.0.0.tar.gz',\n  headersUrl: 'https://nodejs.org/download/release/v4.0.0/node-v4.0.0-headers.tar.gz',\n  libUrl: 'https://nodejs.org/download/release/v4.0.0/win-x64/node.lib' }\n
\n
In custom builds from non-release versions of the source tree, only the\nname property may be present. The additional properties should not be\nrelied upon to exist.
\n"
        },
        {
          "textRaw": "process.stderr",
          "name": "stderr",
          "desc": "
A writable stream to stderr (on fd 2).
\n
process.stderr and process.stdout are unlike other streams in Node.js in\nthat they cannot be closed (end() will throw), they never emit the finish\nevent and that writes can block when output is redirected to a file (although\ndisks are fast and operating systems normally employ write-back caching so it\nshould be a very rare occurrence indeed.)
\n
Additionally, process.stderr and process.stdout are blocking when outputting\nto TTYs (terminals) on OS X as a workaround for the OS's very small, 1kb\nbuffer size. This is to prevent interleaving between stdout and stderr.
\n"
        },
        {
          "textRaw": "process.stdin",
          "name": "stdin",
          "desc": "
A Readable Stream for stdin (on fd 0).
\n
Example of opening standard input and listening for both events:
\n
process.stdin.setEncoding('utf8');\n\nprocess.stdin.on('readable', () => {\n  var chunk = process.stdin.read();\n  if (chunk !== null) {\n    process.stdout.write(`data: ${chunk}`);\n  }\n});\n\nprocess.stdin.on('end', () => {\n  process.stdout.write('end');\n});\n
\n
As a Stream, process.stdin can also be used in "old" mode that is compatible\nwith scripts written for node.js prior to v0.10.\nFor more information see Stream compatibility.
\n
In "old" Streams mode the stdin stream is paused by default, so one\nmust call process.stdin.resume() to read from it. Note also that calling\nprocess.stdin.resume() itself would switch stream to "old" mode.
\n
If you are starting a new project you should prefer a more recent "new" Streams\nmode over "old" one.
\n"
        },
        {
          "textRaw": "process.stdout",
          "name": "stdout",
          "desc": "
A Writable Stream to stdout (on fd 1).
\n
For example, a console.log equivalent could look like this:
\n
console.log = (msg) => {\n  process.stdout.write(`${msg}\\n`);\n};\n
\n
process.stderr and process.stdout are unlike other streams in Node.js in\nthat they cannot be closed (end() will throw), they never emit the 'finish'\nevent and that writes can block when output is redirected to a file (although\ndisks are fast and operating systems normally employ write-back caching so it\nshould be a very rare occurrence indeed.)
\n
Additionally, process.stderr and process.stdout are blocking when outputting\nto TTYs (terminals) on OS X as a workaround for the OS's very small, 1kb\nbuffer size. This is to prevent interleaving between stdout and stderr.
\n
To check if Node.js is being run in a TTY context, read the isTTY property\non process.stderr, process.stdout, or process.stdin:
\n
$ node -p "Boolean(process.stdin.isTTY)"\ntrue\n$ echo "foo" | node -p "Boolean(process.stdin.isTTY)"\nfalse\n\n$ node -p "Boolean(process.stdout.isTTY)"\ntrue\n$ node -p "Boolean(process.stdout.isTTY)" | cat\nfalse\n
See the tty docs for more information.
\n"
        },
        {
          "textRaw": "process.title",
          "name": "title",
          "meta": {
            "added": [
              "v0.1.104"
            ]
          },
          "desc": "
Getter/setter to set what is displayed in ps.
\n
When used as a setter, the maximum length is platform-specific and probably\nshort.
\n
On Linux and OS X, it's limited to the size of the binary name plus the\nlength of the command line arguments because it overwrites the argv memory.
\n
v0.8 allowed for longer process title strings by also overwriting the environ\nmemory but that was potentially insecure/confusing in some (rather obscure)\ncases.
\n"
        },
        {
          "textRaw": "process.version",
          "name": "version",
          "meta": {
            "added": [
              "v0.1.3"
            ]
          },
          "desc": "
A compiled-in property that exposes NODE_VERSION.
\n
console.log(`Version: ${process.version}`);\n
\n"
        },
        {
          "textRaw": "process.versions",
          "name": "versions",
          "meta": {
            "added": [
              "v0.2.0"
            ]
          },
          "desc": "
A property exposing version strings of Node.js and its dependencies.
\n
console.log(process.versions);\n
\n
Will print something like:
\n
{ http_parser: '2.3.0',\n  node: '1.1.1',\n  v8: '4.1.0.14',\n  uv: '1.3.0',\n  zlib: '1.2.8',\n  ares: '1.10.0-DEV',\n  modules: '43',\n  icu: '55.1',\n  openssl: '1.0.1k' }\n
\n\n\n"
        }
      ]
    }
  ],
  "vars": [
    {
      "textRaw": "\\_\\_dirname",
      "name": "\\_\\_dirname",
      "meta": {
        "added": [
          "v0.1.27"
        ]
      },
      "type": "var",
      "desc": "
    \n
  • {String}
    • \n
\n
The directory name of the current module. This the same as the\npath.dirname() of the __filename.
\n
__dirname isn't actually a global but rather local to each module.
\n
Example: running node example.js from /Users/mjr
\n
console.log(__dirname);\n// Prints: /Users/mjr\nconsole.log(path.dirname(__filename));\n// Prints: /Users/mjr\n
\n"
    },
    {
      "textRaw": "\\_\\_filename",
      "name": "\\_\\_filename",
      "meta": {
        "added": [
          "v0.0.1"
        ]
      },
      "type": "var",
      "desc": "
    \n
  • {String}
    • \n
\n
The file name of the current module. This is the resolved absolute path of the\ncurrent module file.
\n
For a main program this is not necessarily the same as the file name used in the\ncommand line.
\n
See __dirname for the directory name of the current module.
\n
__filename isn't actually a global but rather local to each module.
\n
Examples:
\n
Running node example.js from /Users/mjr
\n
console.log(__filename);\n// Prints: /Users/mjr/example.js\nconsole.log(__dirname);\n// Prints: /Users/mjr\n
\n
Given two modules: a and b, where b is a dependency of\na and there is a directory structure of:
\n
    \n
  • /Users/mjr/app/a.js
    • \n
  • /Users/mjr/app/node_modules/b/b.js
    • \n
\n
References to __filename within b.js will return\n/Users/mjr/app/node_modules/b/b.js while references to __filename within\na.js will return /Users/mjr/app/a.js.
\n"
    },
    {
      "textRaw": "exports",
      "name": "exports",
      "meta": {
        "added": [
          "v0.1.12"
        ]
      },
      "type": "var",
      "desc": "
A reference to the module.exports that is shorter to type.\nSee module system documentation for details on when to use exports and\nwhen to use module.exports.
\n
exports isn't actually a global but rather local to each module.
\n
See the module system documentation for more information.
\n"
    },
    {
      "textRaw": "module",
      "name": "module",
      "meta": {
        "added": [
          "v0.1.16"
        ]
      },
      "type": "var",
      "desc": "
    \n
  • {Object}
    • \n
\n
A reference to the current module. In particular\nmodule.exports is used for defining what a module exports and makes\navailable through require().
\n
module isn't actually a global but rather local to each module.
\n
See the module system documentation for more information.
\n"
    },
    {
      "textRaw": "require()",
      "type": "var",
      "name": "require",
      "meta": {
        "added": [
          "v0.1.13"
        ]
      },
      "desc": "
    \n
  • {Function}
    • \n
\n
To require modules. See the Modules section.  require isn't actually a\nglobal but rather local to each module.
\n",
      "properties": [
        {
          "textRaw": "`cache` {Object} ",
          "type": "Object",
          "name": "cache",
          "meta": {
            "added": [
              "v0.3.0"
            ]
          },
          "desc": "
Modules are cached in this object when they are required. By deleting a key\nvalue from this object, the next require will reload the module. Note that\nthis does not apply to native addons, for which reloading will result in an\nError.
\n"
        },
        {
          "textRaw": "`extensions` {Object} ",
          "type": "Object",
          "name": "extensions",
          "meta": {
            "added": [
              "v0.3.0"
            ],
            "deprecated": [
              "v0.10.6"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated",
          "desc": "
Instruct require on how to handle certain file extensions.
\n
Process files with the extension .sjs as .js:
\n
require.extensions['.sjs'] = require.extensions['.js'];\n
\n
Deprecated  In the past, this list has been used to load\nnon-JavaScript modules into Node.js by compiling them on-demand.\nHowever, in practice, there are much better ways to do this, such as\nloading modules via some other Node.js program, or compiling them to\nJavaScript ahead of time.
\n
Since the Module system is locked, this feature will probably never go\naway.  However, it may have subtle bugs and complexities that are best\nleft untouched.
\n"
        }
      ],
      "methods": [
        {
          "textRaw": "require.resolve()",
          "type": "method",
          "name": "resolve",
          "meta": {
            "added": [
              "v0.3.0"
            ]
          },
          "desc": "
Use the internal require() machinery to look up the location of a module,\nbut rather than loading the module, just return the resolved filename.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        }
      ]
    }
  ]
}
node-v4.8.2/doc/api/all.md000644 000766 000024 00000001152 13070706735 015367 0ustar00iojsstaff000000 000000 @include documentation
@include synopsis
@include addons
@include assert
@include buffer
@include child_process
@include cluster
@include cli
@include console
@include crypto
@include debugger
@include dgram
@include dns
@include domain
@include errors
@include events
@include fs
@include globals
@include http
@include https
@include modules
@include net
@include os
@include path
@include process
@include punycode
@include querystring
@include readline
@include repl
@include stream
@include string_decoder
@include timers
@include tls
@include tty
@include url
@include util
@include v8
@include vm
@include zlib
node-v4.8.2/doc/api/assert.html000644 000766 000024 00000063026 13070706740 016470 0ustar00iojsstaff000000 000000 


  
  Assert | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

      

        
Assert#


Stability: 2 - Stable
The assert module provides a simple set of assertion tests that can be used to
test invariants.


assert(value[, message])#



Added in: v0.5.9

    

  • value <any>
    • 

  • message <any>
    • 



An alias of assert.ok() .


const assert = require('assert');

assert(true);  // OK
assert(1);     // OK
assert(false);
  // throws "AssertionError: false == true"
assert(0);
  // throws "AssertionError: 0 == true"
assert(false, 'it\'s false');
  // throws "AssertionError: it's false"



assert.deepEqual(actual, expected[, message])#



Added in: v0.1.21

    

  • actual <any>
    • 

  • expected <any>
    • 

  • message <any>
    • 



Tests for deep equality between the actual and expected parameters.
Primitive values are compared with the equal comparison operator ( == ).


Only enumerable "own" properties are considered. The deepEqual()
implementation does not test object prototypes, attached symbols, or
non-enumerable properties. This can lead to some potentially surprising
results. For example, the following example does not throw an AssertionError
because the properties on the Error object are non-enumerable:


// WARNING: This does not throw an AssertionError!
assert.deepEqual(Error('a'), Error('b'));



"Deep" equality means that the enumerable "own" properties of child objects
are evaluated also:


const assert = require('assert');

const obj1 = {
  a : {
    b : 1
  }
};
const obj2 = {
  a : {
    b : 2
  }
};
const obj3 = {
  a : {
    b : 1
  }
}
const obj4 = Object.create(obj1);

assert.deepEqual(obj1, obj1);
  // OK, object is equal to itself

assert.deepEqual(obj1, obj2);
  // AssertionError: { a: { b: 1 } } deepEqual { a: { b: 2 } }
  // values of b are different

assert.deepEqual(obj1, obj3);
  // OK, objects are equal

assert.deepEqual(obj1, obj4);
  // AssertionError: { a: { b: 1 } } deepEqual {}
  // Prototypes are ignored



If the values are not equal, an AssertionError is thrown with a message
property set equal to the value of the message parameter. If the message
parameter is undefined, a default error message is assigned.


assert.deepStrictEqual(actual, expected[, message])#



Added in: v1.2.0

    

  • actual <any>
    • 

  • expected <any>
    • 

  • message <any>
    • 



Generally identical to assert.deepEqual() with two exceptions. First,
primitive values are compared using the strict equality operator ( === ).
Second, object comparisons include a strict equality check of their prototypes.


const assert = require('assert');

assert.deepEqual({a:1}, {a:'1'});
  // OK, because 1 == '1'

assert.deepStrictEqual({a:1}, {a:'1'});
  // AssertionError: { a: 1 } deepStrictEqual { a: '1' }
  // because 1 !== '1' using strict equality



If the values are not equal, an AssertionError is thrown with a message
property set equal to the value of the message parameter. If the message
parameter is undefined, a default error message is assigned.


assert.doesNotThrow(block[, error][, message])#



Added in: v0.1.21



Asserts that the function block does not throw an error. See
assert.throws() for more details.


When assert.doesNotThrow() is called, it will immediately call the block
function.


If an error is thrown and it is the same type as that specified by the error
parameter, then an AssertionError is thrown. If the error is of a different
type, or if the error parameter is undefined, the error is propagated back
to the caller.


The following, for instance, will throw the TypeError because there is no
matching error type in the assertion:


assert.doesNotThrow(
  () => {
    throw new TypeError('Wrong value');
  },
  SyntaxError
);



However, the following will result in an AssertionError with the message
'Got unwanted exception (TypeError)..':


assert.doesNotThrow(
  () => {
    throw new TypeError('Wrong value');
  },
  TypeError
);



If an AssertionError is thrown and a value is provided for the message
parameter, the value of message will be appended to the AssertionError
message:


assert.doesNotThrow(
  () => {
    throw new TypeError('Wrong value');
  },
  TypeError,
  'Whoops'
);
// Throws: AssertionError: Got unwanted exception (TypeError). Whoops



assert.equal(actual, expected[, message])#



Added in: v0.1.21

    

  • actual <any>
    • 

  • expected <any>
    • 

  • message <any>
    • 



Tests shallow, coercive equality between the actual and expected parameters
using the equal comparison operator ( == ).


const assert = require('assert');

assert.equal(1, 1);
  // OK, 1 == 1
assert.equal(1, '1');
  // OK, 1 == '1'

assert.equal(1, 2);
  // AssertionError: 1 == 2
assert.equal({a: {b: 1}}, {a: {b: 1}});
  //AssertionError: { a: { b: 1 } } == { a: { b: 1 } }



If the values are not equal, an AssertionError is thrown with a message
property set equal to the value of the message parameter. If the message
parameter is undefined, a default error message is assigned.


assert.fail(actual, expected, message, operator)#



Added in: v0.1.21

    

  • actual <any>
    • 

  • expected <any>
    • 

  • message <any>
    • 

  • operator <String>
    • 



Throws an AssertionError. If message is falsy, the error message is set as
the values of actual and expected separated by the provided operator.
Otherwise, the error message is the value of message.


const assert = require('assert');

assert.fail(1, 2, undefined, '>');
  // AssertionError: 1 > 2

assert.fail(1, 2, 'whoops', '>');
  // AssertionError: whoops



assert.ifError(value)#



Added in: v0.1.97

    

  • value <any>
    • 



Throws value if value is truthy. This is useful when testing the error
argument in callbacks.


const assert = require('assert');

assert.ifError(0); // OK
assert.ifError(1); // Throws 1
assert.ifError('error') // Throws 'error'
assert.ifError(new Error()); // Throws Error



assert.notDeepEqual(actual, expected[, message])#



Added in: v0.1.21

    

  • actual <any>
    • 

  • expected <any>
    • 

  • message <any>
    • 



Tests for any deep inequality. Opposite of assert.deepEqual().


const assert = require('assert');

const obj1 = {
  a : {
    b : 1
  }
};
const obj2 = {
  a : {
    b : 2
  }
};
const obj3 = {
  a : {
    b : 1
  }
};
const obj4 = Object.create(obj1);

assert.notDeepEqual(obj1, obj1);
  // AssertionError: { a: { b: 1 } } notDeepEqual { a: { b: 1 } }

assert.notDeepEqual(obj1, obj2);
  // OK, obj1 and obj2 are not deeply equal

assert.notDeepEqual(obj1, obj3);
  // AssertionError: { a: { b: 1 } } notDeepEqual { a: { b: 1 } }

assert.notDeepEqual(obj1, obj4);
  // OK, obj1 and obj4 are not deeply equal



If the values are deeply equal, an AssertionError is thrown with a message
property set equal to the value of the message parameter. If the message
parameter is undefined, a default error message is assigned.


assert.notDeepStrictEqual(actual, expected[, message])#



Added in: v1.2.0

    

  • actual <any>
    • 

  • expected <any>
    • 

  • message <any>
    • 



Tests for deep strict inequality. Opposite of assert.deepStrictEqual().


const assert = require('assert');

assert.notDeepEqual({a:1}, {a:'1'});
  // AssertionError: { a: 1 } notDeepEqual { a: '1' }

assert.notDeepStrictEqual({a:1}, {a:'1'});
  // OK



If the values are deeply and strictly equal, an AssertionError is thrown
with a message property set equal to the value of the message parameter. If
the message parameter is undefined, a default error message is assigned.


assert.notEqual(actual, expected[, message])#



Added in: v0.1.21

    

  • actual <any>
    • 

  • expected <any>
    • 

  • message <any>
    • 



Tests shallow, coercive inequality with the not equal comparison operator
( != ).


const assert = require('assert');

assert.notEqual(1, 2);
  // OK

assert.notEqual(1, 1);
  // AssertionError: 1 != 1

assert.notEqual(1, '1');
  // AssertionError: 1 != '1'



If the values are equal, an AssertionError is thrown with a message
property set equal to the value of the message parameter. If the message
parameter is undefined, a default error message is assigned.


assert.notStrictEqual(actual, expected[, message])#



Added in: v0.1.21

    

  • actual <any>
    • 

  • expected <any>
    • 

  • message <any>
    • 



Tests strict inequality as determined by the strict not equal operator
( !== ).


const assert = require('assert');

assert.notStrictEqual(1, 2);
  // OK

assert.notStrictEqual(1, 1);
  // AssertionError: 1 !== 1

assert.notStrictEqual(1, '1');
  // OK



If the values are strictly equal, an AssertionError is thrown with a
message property set equal to the value of the message parameter. If the
message parameter is undefined, a default error message is assigned.


assert.ok(value[, message])#



Added in: v0.1.21

    

  • value <any>
    • 

  • message <any>
    • 



Tests if value is truthy. It is equivalent to
assert.equal(!!value, true, message).


If value is not truthy, an AssertionError is thrown with a message
property set equal to the value of the message parameter. If the message
parameter is undefined, a default error message is assigned.


const assert = require('assert');

assert.ok(true);  // OK
assert.ok(1);     // OK
assert.ok(false);
  // throws "AssertionError: false == true"
assert.ok(0);
  // throws "AssertionError: 0 == true"
assert.ok(false, 'it\'s false');
  // throws "AssertionError: it's false"



assert.strictEqual(actual, expected[, message])#



Added in: v0.1.21

    

  • actual <any>
    • 

  • expected <any>
    • 

  • message <any>
    • 



Tests strict equality as determined by the strict equality operator ( === ).


const assert = require('assert');

assert.strictEqual(1, 2);
  // AssertionError: 1 === 2

assert.strictEqual(1, 1);
  // OK

assert.strictEqual(1, '1');
  // AssertionError: 1 === '1'



If the values are not strictly equal, an AssertionError is thrown with a
message property set equal to the value of the message parameter. If the
message parameter is undefined, a default error message is assigned.


assert.throws(block[, error][, message])#



Added in: v0.1.21



Expects the function block to throw an error.


If specified, error can be a constructor, RegExp, or validation
function.


If specified, message will be the message provided by the AssertionError if
the block fails to throw.


Validate instanceof using constructor:


assert.throws(
  () => {
    throw new Error('Wrong value');
  },
  Error
);



Validate error message using RegExp:


assert.throws(
  () => {
    throw new Error('Wrong value');
  },
  /value/
);



Custom error validation:


assert.throws(
  () => {
    throw new Error('Wrong value');
  },
  function(err) {
    if ( (err instanceof Error) && /value/.test(err) ) {
      return true;
    }
  },
  'unexpected error'
);



Note that error can not be a string. If a string is provided as the second
argument, then error is assumed to be omitted and the string will be used for
message instead. This can lead to easy-to-miss mistakes:


// THIS IS A MISTAKE! DO NOT DO THIS!
assert.throws(myFunction, 'missing foo', 'did not throw with expected message');

// Do this instead.
assert.throws(myFunction, /missing foo/, 'did not throw with expected message');



      

    

  

  
  
  
  



node-v4.8.2/doc/api/assert.json000644 000766 000024 00000071021 13070706740 016467 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/assert.md",
  "modules": [
    {
      "textRaw": "Assert",
      "name": "assert",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
The assert module provides a simple set of assertion tests that can be used to\ntest invariants.
\n",
      "methods": [
        {
          "textRaw": "assert(value[, message])",
          "type": "method",
          "name": "assert",
          "meta": {
            "added": [
              "v0.5.9"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`value` {any} ",
                  "name": "value",
                  "type": "any"
                },
                {
                  "textRaw": "`message` {any} ",
                  "name": "message",
                  "type": "any",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "value"
                },
                {
                  "name": "message",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "
An alias of assert.ok() .
\n
const assert = require('assert');\n\nassert(true);  // OK\nassert(1);     // OK\nassert(false);\n  // throws "AssertionError: false == true"\nassert(0);\n  // throws "AssertionError: 0 == true"\nassert(false, 'it\\'s false');\n  // throws "AssertionError: it's false"\n
\n"
        },
        {
          "textRaw": "assert.deepEqual(actual, expected[, message])",
          "type": "method",
          "name": "deepEqual",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`actual` {any} ",
                  "name": "actual",
                  "type": "any"
                },
                {
                  "textRaw": "`expected` {any} ",
                  "name": "expected",
                  "type": "any"
                },
                {
                  "textRaw": "`message` {any} ",
                  "name": "message",
                  "type": "any",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "actual"
                },
                {
                  "name": "expected"
                },
                {
                  "name": "message",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "
Tests for deep equality between the actual and expected parameters.\nPrimitive values are compared with the equal comparison operator ( == ).
\n
Only enumerable "own" properties are considered. The deepEqual()\nimplementation does not test object prototypes, attached symbols, or\nnon-enumerable properties. This can lead to some potentially surprising\nresults. For example, the following example does not throw an AssertionError\nbecause the properties on the Error object are non-enumerable:
\n
// WARNING: This does not throw an AssertionError!\nassert.deepEqual(Error('a'), Error('b'));\n
\n
"Deep" equality means that the enumerable "own" properties of child objects\nare evaluated also:
\n
const assert = require('assert');\n\nconst obj1 = {\n  a : {\n    b : 1\n  }\n};\nconst obj2 = {\n  a : {\n    b : 2\n  }\n};\nconst obj3 = {\n  a : {\n    b : 1\n  }\n}\nconst obj4 = Object.create(obj1);\n\nassert.deepEqual(obj1, obj1);\n  // OK, object is equal to itself\n\nassert.deepEqual(obj1, obj2);\n  // AssertionError: { a: { b: 1 } } deepEqual { a: { b: 2 } }\n  // values of b are different\n\nassert.deepEqual(obj1, obj3);\n  // OK, objects are equal\n\nassert.deepEqual(obj1, obj4);\n  // AssertionError: { a: { b: 1 } } deepEqual {}\n  // Prototypes are ignored\n
\n
If the values are not equal, an AssertionError is thrown with a message\nproperty set equal to the value of the message parameter. If the message\nparameter is undefined, a default error message is assigned.
\n"
        },
        {
          "textRaw": "assert.deepStrictEqual(actual, expected[, message])",
          "type": "method",
          "name": "deepStrictEqual",
          "meta": {
            "added": [
              "v1.2.0"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`actual` {any} ",
                  "name": "actual",
                  "type": "any"
                },
                {
                  "textRaw": "`expected` {any} ",
                  "name": "expected",
                  "type": "any"
                },
                {
                  "textRaw": "`message` {any} ",
                  "name": "message",
                  "type": "any",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "actual"
                },
                {
                  "name": "expected"
                },
                {
                  "name": "message",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "
Generally identical to assert.deepEqual() with two exceptions. First,\nprimitive values are compared using the strict equality operator ( === ).\nSecond, object comparisons include a strict equality check of their prototypes.
\n
const assert = require('assert');\n\nassert.deepEqual({a:1}, {a:'1'});\n  // OK, because 1 == '1'\n\nassert.deepStrictEqual({a:1}, {a:'1'});\n  // AssertionError: { a: 1 } deepStrictEqual { a: '1' }\n  // because 1 !== '1' using strict equality\n
\n
If the values are not equal, an AssertionError is thrown with a message\nproperty set equal to the value of the message parameter. If the message\nparameter is undefined, a default error message is assigned.
\n"
        },
        {
          "textRaw": "assert.doesNotThrow(block[, error][, message])",
          "type": "method",
          "name": "doesNotThrow",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`block` {Function} ",
                  "name": "block",
                  "type": "Function"
                },
                {
                  "textRaw": "`error` {RegExp|Function} ",
                  "name": "error",
                  "type": "RegExp|Function",
                  "optional": true
                },
                {
                  "textRaw": "`message` {any} ",
                  "name": "message",
                  "type": "any",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "block"
                },
                {
                  "name": "error",
                  "optional": true
                },
                {
                  "name": "message",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "
Asserts that the function block does not throw an error. See\nassert.throws() for more details.
\n
When assert.doesNotThrow() is called, it will immediately call the block\nfunction.
\n
If an error is thrown and it is the same type as that specified by the error\nparameter, then an AssertionError is thrown. If the error is of a different\ntype, or if the error parameter is undefined, the error is propagated back\nto the caller.
\n
The following, for instance, will throw the TypeError because there is no\nmatching error type in the assertion:
\n
assert.doesNotThrow(\n  () => {\n    throw new TypeError('Wrong value');\n  },\n  SyntaxError\n);\n
\n
However, the following will result in an AssertionError with the message\n'Got unwanted exception (TypeError)..':
\n
assert.doesNotThrow(\n  () => {\n    throw new TypeError('Wrong value');\n  },\n  TypeError\n);\n
\n
If an AssertionError is thrown and a value is provided for the message\nparameter, the value of message will be appended to the AssertionError\nmessage:
\n
assert.doesNotThrow(\n  () => {\n    throw new TypeError('Wrong value');\n  },\n  TypeError,\n  'Whoops'\n);\n// Throws: AssertionError: Got unwanted exception (TypeError). Whoops\n
\n"
        },
        {
          "textRaw": "assert.equal(actual, expected[, message])",
          "type": "method",
          "name": "equal",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`actual` {any} ",
                  "name": "actual",
                  "type": "any"
                },
                {
                  "textRaw": "`expected` {any} ",
                  "name": "expected",
                  "type": "any"
                },
                {
                  "textRaw": "`message` {any} ",
                  "name": "message",
                  "type": "any",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "actual"
                },
                {
                  "name": "expected"
                },
                {
                  "name": "message",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "
Tests shallow, coercive equality between the actual and expected parameters\nusing the equal comparison operator ( == ).
\n
const assert = require('assert');\n\nassert.equal(1, 1);\n  // OK, 1 == 1\nassert.equal(1, '1');\n  // OK, 1 == '1'\n\nassert.equal(1, 2);\n  // AssertionError: 1 == 2\nassert.equal({a: {b: 1}}, {a: {b: 1}});\n  //AssertionError: { a: { b: 1 } } == { a: { b: 1 } }\n
\n
If the values are not equal, an AssertionError is thrown with a message\nproperty set equal to the value of the message parameter. If the message\nparameter is undefined, a default error message is assigned.
\n"
        },
        {
          "textRaw": "assert.fail(actual, expected, message, operator)",
          "type": "method",
          "name": "fail",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`actual` {any} ",
                  "name": "actual",
                  "type": "any"
                },
                {
                  "textRaw": "`expected` {any} ",
                  "name": "expected",
                  "type": "any"
                },
                {
                  "textRaw": "`message` {any} ",
                  "name": "message",
                  "type": "any"
                },
                {
                  "textRaw": "`operator` {String} ",
                  "name": "operator",
                  "type": "String"
                }
              ]
            },
            {
              "params": [
                {
                  "name": "actual"
                },
                {
                  "name": "expected"
                },
                {
                  "name": "message"
                },
                {
                  "name": "operator"
                }
              ]
            }
          ],
          "desc": "
Throws an AssertionError. If message is falsy, the error message is set as\nthe values of actual and expected separated by the provided operator.\nOtherwise, the error message is the value of message.
\n
const assert = require('assert');\n\nassert.fail(1, 2, undefined, '>');\n  // AssertionError: 1 > 2\n\nassert.fail(1, 2, 'whoops', '>');\n  // AssertionError: whoops\n
\n"
        },
        {
          "textRaw": "assert.ifError(value)",
          "type": "method",
          "name": "ifError",
          "meta": {
            "added": [
              "v0.1.97"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`value` {any} ",
                  "name": "value",
                  "type": "any"
                }
              ]
            },
            {
              "params": [
                {
                  "name": "value"
                }
              ]
            }
          ],
          "desc": "
Throws value if value is truthy. This is useful when testing the error\nargument in callbacks.
\n
const assert = require('assert');\n\nassert.ifError(0); // OK\nassert.ifError(1); // Throws 1\nassert.ifError('error') // Throws 'error'\nassert.ifError(new Error()); // Throws Error\n
\n"
        },
        {
          "textRaw": "assert.notDeepEqual(actual, expected[, message])",
          "type": "method",
          "name": "notDeepEqual",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`actual` {any} ",
                  "name": "actual",
                  "type": "any"
                },
                {
                  "textRaw": "`expected` {any} ",
                  "name": "expected",
                  "type": "any"
                },
                {
                  "textRaw": "`message` {any} ",
                  "name": "message",
                  "type": "any",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "actual"
                },
                {
                  "name": "expected"
                },
                {
                  "name": "message",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "
Tests for any deep inequality. Opposite of assert.deepEqual().
\n
const assert = require('assert');\n\nconst obj1 = {\n  a : {\n    b : 1\n  }\n};\nconst obj2 = {\n  a : {\n    b : 2\n  }\n};\nconst obj3 = {\n  a : {\n    b : 1\n  }\n};\nconst obj4 = Object.create(obj1);\n\nassert.notDeepEqual(obj1, obj1);\n  // AssertionError: { a: { b: 1 } } notDeepEqual { a: { b: 1 } }\n\nassert.notDeepEqual(obj1, obj2);\n  // OK, obj1 and obj2 are not deeply equal\n\nassert.notDeepEqual(obj1, obj3);\n  // AssertionError: { a: { b: 1 } } notDeepEqual { a: { b: 1 } }\n\nassert.notDeepEqual(obj1, obj4);\n  // OK, obj1 and obj4 are not deeply equal\n
\n
If the values are deeply equal, an AssertionError is thrown with a message\nproperty set equal to the value of the message parameter. If the message\nparameter is undefined, a default error message is assigned.
\n"
        },
        {
          "textRaw": "assert.notDeepStrictEqual(actual, expected[, message])",
          "type": "method",
          "name": "notDeepStrictEqual",
          "meta": {
            "added": [
              "v1.2.0"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`actual` {any} ",
                  "name": "actual",
                  "type": "any"
                },
                {
                  "textRaw": "`expected` {any} ",
                  "name": "expected",
                  "type": "any"
                },
                {
                  "textRaw": "`message` {any} ",
                  "name": "message",
                  "type": "any",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "actual"
                },
                {
                  "name": "expected"
                },
                {
                  "name": "message",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "
Tests for deep strict inequality. Opposite of assert.deepStrictEqual().
\n
const assert = require('assert');\n\nassert.notDeepEqual({a:1}, {a:'1'});\n  // AssertionError: { a: 1 } notDeepEqual { a: '1' }\n\nassert.notDeepStrictEqual({a:1}, {a:'1'});\n  // OK\n
\n
If the values are deeply and strictly equal, an AssertionError is thrown\nwith a message property set equal to the value of the message parameter. If\nthe message parameter is undefined, a default error message is assigned.
\n"
        },
        {
          "textRaw": "assert.notEqual(actual, expected[, message])",
          "type": "method",
          "name": "notEqual",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`actual` {any} ",
                  "name": "actual",
                  "type": "any"
                },
                {
                  "textRaw": "`expected` {any} ",
                  "name": "expected",
                  "type": "any"
                },
                {
                  "textRaw": "`message` {any} ",
                  "name": "message",
                  "type": "any",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "actual"
                },
                {
                  "name": "expected"
                },
                {
                  "name": "message",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "
Tests shallow, coercive inequality with the not equal comparison operator\n( != ).
\n
const assert = require('assert');\n\nassert.notEqual(1, 2);\n  // OK\n\nassert.notEqual(1, 1);\n  // AssertionError: 1 != 1\n\nassert.notEqual(1, '1');\n  // AssertionError: 1 != '1'\n
\n
If the values are equal, an AssertionError is thrown with a message\nproperty set equal to the value of the message parameter. If the message\nparameter is undefined, a default error message is assigned.
\n"
        },
        {
          "textRaw": "assert.notStrictEqual(actual, expected[, message])",
          "type": "method",
          "name": "notStrictEqual",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`actual` {any} ",
                  "name": "actual",
                  "type": "any"
                },
                {
                  "textRaw": "`expected` {any} ",
                  "name": "expected",
                  "type": "any"
                },
                {
                  "textRaw": "`message` {any} ",
                  "name": "message",
                  "type": "any",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "actual"
                },
                {
                  "name": "expected"
                },
                {
                  "name": "message",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "
Tests strict inequality as determined by the strict not equal operator\n( !== ).
\n
const assert = require('assert');\n\nassert.notStrictEqual(1, 2);\n  // OK\n\nassert.notStrictEqual(1, 1);\n  // AssertionError: 1 !== 1\n\nassert.notStrictEqual(1, '1');\n  // OK\n
\n
If the values are strictly equal, an AssertionError is thrown with a\nmessage property set equal to the value of the message parameter. If the\nmessage parameter is undefined, a default error message is assigned.
\n"
        },
        {
          "textRaw": "assert.ok(value[, message])",
          "type": "method",
          "name": "ok",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`value` {any} ",
                  "name": "value",
                  "type": "any"
                },
                {
                  "textRaw": "`message` {any} ",
                  "name": "message",
                  "type": "any",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "value"
                },
                {
                  "name": "message",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "
Tests if value is truthy. It is equivalent to\nassert.equal(!!value, true, message).
\n
If value is not truthy, an AssertionError is thrown with a message\nproperty set equal to the value of the message parameter. If the message\nparameter is undefined, a default error message is assigned.
\n
const assert = require('assert');\n\nassert.ok(true);  // OK\nassert.ok(1);     // OK\nassert.ok(false);\n  // throws "AssertionError: false == true"\nassert.ok(0);\n  // throws "AssertionError: 0 == true"\nassert.ok(false, 'it\\'s false');\n  // throws "AssertionError: it's false"\n
\n"
        },
        {
          "textRaw": "assert.strictEqual(actual, expected[, message])",
          "type": "method",
          "name": "strictEqual",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`actual` {any} ",
                  "name": "actual",
                  "type": "any"
                },
                {
                  "textRaw": "`expected` {any} ",
                  "name": "expected",
                  "type": "any"
                },
                {
                  "textRaw": "`message` {any} ",
                  "name": "message",
                  "type": "any",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "actual"
                },
                {
                  "name": "expected"
                },
                {
                  "name": "message",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "
Tests strict equality as determined by the strict equality operator ( === ).
\n
const assert = require('assert');\n\nassert.strictEqual(1, 2);\n  // AssertionError: 1 === 2\n\nassert.strictEqual(1, 1);\n  // OK\n\nassert.strictEqual(1, '1');\n  // AssertionError: 1 === '1'\n
\n
If the values are not strictly equal, an AssertionError is thrown with a\nmessage property set equal to the value of the message parameter. If the\nmessage parameter is undefined, a default error message is assigned.
\n"
        },
        {
          "textRaw": "assert.throws(block[, error][, message])",
          "type": "method",
          "name": "throws",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`block` {Function} ",
                  "name": "block",
                  "type": "Function"
                },
                {
                  "textRaw": "`error` {RegExp|Function} ",
                  "name": "error",
                  "type": "RegExp|Function",
                  "optional": true
                },
                {
                  "textRaw": "`message` {any} ",
                  "name": "message",
                  "type": "any",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "block"
                },
                {
                  "name": "error",
                  "optional": true
                },
                {
                  "name": "message",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "
Expects the function block to throw an error.
\n
If specified, error can be a constructor, RegExp, or validation\nfunction.
\n
If specified, message will be the message provided by the AssertionError if\nthe block fails to throw.
\n
Validate instanceof using constructor:
\n
assert.throws(\n  () => {\n    throw new Error('Wrong value');\n  },\n  Error\n);\n
\n
Validate error message using RegExp:
\n
assert.throws(\n  () => {\n    throw new Error('Wrong value');\n  },\n  /value/\n);\n
\n
Custom error validation:
\n
assert.throws(\n  () => {\n    throw new Error('Wrong value');\n  },\n  function(err) {\n    if ( (err instanceof Error) && /value/.test(err) ) {\n      return true;\n    }\n  },\n  'unexpected error'\n);\n
\n
Note that error can not be a string. If a string is provided as the second\nargument, then error is assumed to be omitted and the string will be used for\nmessage instead. This can lead to easy-to-miss mistakes:
\n
// THIS IS A MISTAKE! DO NOT DO THIS!\nassert.throws(myFunction, 'missing foo', 'did not throw with expected message');\n\n// Do this instead.\nassert.throws(myFunction, /missing foo/, 'did not throw with expected message');\n
\n"
        }
      ],
      "type": "module",
      "displayName": "Assert"
    }
  ]
}
node-v4.8.2/doc/api/assert.md000644 000766 000024 00000027236 13070706735 016133 0ustar00iojsstaff000000 000000 # Assert

> Stability: 2 - Stable

The `assert` module provides a simple set of assertion tests that can be used to
test invariants.

## assert(value[, message])

* `value` {any}
* `message` {any}

An alias of [`assert.ok()`][] .

```js
const assert = require('assert');

assert(true);  // OK
assert(1);     // OK
assert(false);
  // throws "AssertionError: false == true"
assert(0);
  // throws "AssertionError: 0 == true"
assert(false, 'it\'s false');
  // throws "AssertionError: it's false"
```

## assert.deepEqual(actual, expected[, message])

* `actual` {any}
* `expected` {any}
* `message` {any}

Tests for deep equality between the `actual` and `expected` parameters.
Primitive values are compared with the equal comparison operator ( `==` ).

Only enumerable "own" properties are considered. The `deepEqual()`
implementation does not test object prototypes, attached symbols, or
non-enumerable properties. This can lead to some potentially surprising
results. For example, the following example does not throw an `AssertionError`
because the properties on the [`Error`][] object are non-enumerable:

```js
// WARNING: This does not throw an AssertionError!
assert.deepEqual(Error('a'), Error('b'));
```

"Deep" equality means that the enumerable "own" properties of child objects
are evaluated also:

```js
const assert = require('assert');

const obj1 = {
  a : {
    b : 1
  }
};
const obj2 = {
  a : {
    b : 2
  }
};
const obj3 = {
  a : {
    b : 1
  }
}
const obj4 = Object.create(obj1);

assert.deepEqual(obj1, obj1);
  // OK, object is equal to itself

assert.deepEqual(obj1, obj2);
  // AssertionError: { a: { b: 1 } } deepEqual { a: { b: 2 } }
  // values of b are different

assert.deepEqual(obj1, obj3);
  // OK, objects are equal

assert.deepEqual(obj1, obj4);
  // AssertionError: { a: { b: 1 } } deepEqual {}
  // Prototypes are ignored
```

If the values are not equal, an `AssertionError` is thrown with a `message`
property set equal to the value of the `message` parameter. If the `message`
parameter is undefined, a default error message is assigned.

## assert.deepStrictEqual(actual, expected[, message])

* `actual` {any}
* `expected` {any}
* `message` {any}

Generally identical to `assert.deepEqual()` with two exceptions. First,
primitive values are compared using the strict equality operator ( `===` ).
Second, object comparisons include a strict equality check of their prototypes.

```js
const assert = require('assert');

assert.deepEqual({a:1}, {a:'1'});
  // OK, because 1 == '1'

assert.deepStrictEqual({a:1}, {a:'1'});
  // AssertionError: { a: 1 } deepStrictEqual { a: '1' }
  // because 1 !== '1' using strict equality
```

If the values are not equal, an `AssertionError` is thrown with a `message`
property set equal to the value of the `message` parameter. If the `message`
parameter is undefined, a default error message is assigned.

## assert.doesNotThrow(block[, error][, message])

* `block` {Function}
* `error` {RegExp|Function}
* `message` {any}

Asserts that the function `block` does not throw an error. See
[`assert.throws()`][] for more details.

When `assert.doesNotThrow()` is called, it will immediately call the `block`
function.

If an error is thrown and it is the same type as that specified by the `error`
parameter, then an `AssertionError` is thrown. If the error is of a different
type, or if the `error` parameter is undefined, the error is propagated back
to the caller.

The following, for instance, will throw the [`TypeError`][] because there is no
matching error type in the assertion:

```js
assert.doesNotThrow(
  () => {
    throw new TypeError('Wrong value');
  },
  SyntaxError
);
```

However, the following will result in an `AssertionError` with the message
'Got unwanted exception (TypeError)..':

```js
assert.doesNotThrow(
  () => {
    throw new TypeError('Wrong value');
  },
  TypeError
);
```

If an `AssertionError` is thrown and a value is provided for the `message`
parameter, the value of `message` will be appended to the `AssertionError`
message:

```js
assert.doesNotThrow(
  () => {
    throw new TypeError('Wrong value');
  },
  TypeError,
  'Whoops'
);
// Throws: AssertionError: Got unwanted exception (TypeError). Whoops
```

## assert.equal(actual, expected[, message])

* `actual` {any}
* `expected` {any}
* `message` {any}

Tests shallow, coercive equality between the `actual` and `expected` parameters
using the equal comparison operator ( `==` ).

```js
const assert = require('assert');

assert.equal(1, 1);
  // OK, 1 == 1
assert.equal(1, '1');
  // OK, 1 == '1'

assert.equal(1, 2);
  // AssertionError: 1 == 2
assert.equal({a: {b: 1}}, {a: {b: 1}});
  //AssertionError: { a: { b: 1 } } == { a: { b: 1 } }
```

If the values are not equal, an `AssertionError` is thrown with a `message`
property set equal to the value of the `message` parameter. If the `message`
parameter is undefined, a default error message is assigned.

## assert.fail(actual, expected, message, operator)

* `actual` {any}
* `expected` {any}
* `message` {any}
* `operator` {String}

Throws an `AssertionError`. If `message` is falsy, the error message is set as
the values of `actual` and `expected` separated by the provided `operator`.
Otherwise, the error message is the value of `message`.

```js
const assert = require('assert');

assert.fail(1, 2, undefined, '>');
  // AssertionError: 1 > 2

assert.fail(1, 2, 'whoops', '>');
  // AssertionError: whoops
```

## assert.ifError(value)

* `value` {any}

Throws `value` if `value` is truthy. This is useful when testing the `error`
argument in callbacks.

```js
const assert = require('assert');

assert.ifError(0); // OK
assert.ifError(1); // Throws 1
assert.ifError('error') // Throws 'error'
assert.ifError(new Error()); // Throws Error
```

## assert.notDeepEqual(actual, expected[, message])

* `actual` {any}
* `expected` {any}
* `message` {any}

Tests for any deep inequality. Opposite of [`assert.deepEqual()`][].

```js
const assert = require('assert');

const obj1 = {
  a : {
    b : 1
  }
};
const obj2 = {
  a : {
    b : 2
  }
};
const obj3 = {
  a : {
    b : 1
  }
};
const obj4 = Object.create(obj1);

assert.notDeepEqual(obj1, obj1);
  // AssertionError: { a: { b: 1 } } notDeepEqual { a: { b: 1 } }

assert.notDeepEqual(obj1, obj2);
  // OK, obj1 and obj2 are not deeply equal

assert.notDeepEqual(obj1, obj3);
  // AssertionError: { a: { b: 1 } } notDeepEqual { a: { b: 1 } }

assert.notDeepEqual(obj1, obj4);
  // OK, obj1 and obj4 are not deeply equal
```

If the values are deeply equal, an `AssertionError` is thrown with a `message`
property set equal to the value of the `message` parameter. If the `message`
parameter is undefined, a default error message is assigned.

## assert.notDeepStrictEqual(actual, expected[, message])

* `actual` {any}
* `expected` {any}
* `message` {any}

Tests for deep strict inequality. Opposite of [`assert.deepStrictEqual()`][].

```js
const assert = require('assert');

assert.notDeepEqual({a:1}, {a:'1'});
  // AssertionError: { a: 1 } notDeepEqual { a: '1' }

assert.notDeepStrictEqual({a:1}, {a:'1'});
  // OK
```

If the values are deeply and strictly equal, an `AssertionError` is thrown
with a `message` property set equal to the value of the `message` parameter. If
the `message` parameter is undefined, a default error message is assigned.

## assert.notEqual(actual, expected[, message])

* `actual` {any}
* `expected` {any}
* `message` {any}

Tests shallow, coercive inequality with the not equal comparison operator
( `!=` ).

```js
const assert = require('assert');

assert.notEqual(1, 2);
  // OK

assert.notEqual(1, 1);
  // AssertionError: 1 != 1

assert.notEqual(1, '1');
  // AssertionError: 1 != '1'
```

If the values are equal, an `AssertionError` is thrown with a `message`
property set equal to the value of the `message` parameter. If the `message`
parameter is undefined, a default error message is assigned.

## assert.notStrictEqual(actual, expected[, message])

* `actual` {any}
* `expected` {any}
* `message` {any}

Tests strict inequality as determined by the strict not equal operator
( `!==` ).

```js
const assert = require('assert');

assert.notStrictEqual(1, 2);
  // OK

assert.notStrictEqual(1, 1);
  // AssertionError: 1 !== 1

assert.notStrictEqual(1, '1');
  // OK
```

If the values are strictly equal, an `AssertionError` is thrown with a
`message` property set equal to the value of the `message` parameter. If the
`message` parameter is undefined, a default error message is assigned.

## assert.ok(value[, message])

* `value` {any}
* `message` {any}

Tests if `value` is truthy. It is equivalent to
`assert.equal(!!value, true, message)`.

If `value` is not truthy, an `AssertionError` is thrown with a `message`
property set equal to the value of the `message` parameter. If the `message`
parameter is `undefined`, a default error message is assigned.

```js
const assert = require('assert');

assert.ok(true);  // OK
assert.ok(1);     // OK
assert.ok(false);
  // throws "AssertionError: false == true"
assert.ok(0);
  // throws "AssertionError: 0 == true"
assert.ok(false, 'it\'s false');
  // throws "AssertionError: it's false"
```

## assert.strictEqual(actual, expected[, message])

* `actual` {any}
* `expected` {any}
* `message` {any}

Tests strict equality as determined by the strict equality operator ( `===` ).

```js
const assert = require('assert');

assert.strictEqual(1, 2);
  // AssertionError: 1 === 2

assert.strictEqual(1, 1);
  // OK

assert.strictEqual(1, '1');
  // AssertionError: 1 === '1'
```

If the values are not strictly equal, an `AssertionError` is thrown with a
`message` property set equal to the value of the `message` parameter. If the
`message` parameter is undefined, a default error message is assigned.

## assert.throws(block[, error][, message])

* `block` {Function}
* `error` {RegExp|Function}
* `message` {any}

Expects the function `block` to throw an error.

If specified, `error` can be a constructor, [`RegExp`][], or validation
function.

If specified, `message` will be the message provided by the `AssertionError` if
the block fails to throw.

Validate instanceof using constructor:

```js
assert.throws(
  () => {
    throw new Error('Wrong value');
  },
  Error
);
```

Validate error message using [`RegExp`][]:

```js
assert.throws(
  () => {
    throw new Error('Wrong value');
  },
  /value/
);
```

Custom error validation:

```js
assert.throws(
  () => {
    throw new Error('Wrong value');
  },
  function(err) {
    if ( (err instanceof Error) && /value/.test(err) ) {
      return true;
    }
  },
  'unexpected error'
);
```

Note that `error` can not be a string. If a string is provided as the second
argument, then `error` is assumed to be omitted and the string will be used for
`message` instead. This can lead to easy-to-miss mistakes:

```js
// THIS IS A MISTAKE! DO NOT DO THIS!
assert.throws(myFunction, 'missing foo', 'did not throw with expected message');

// Do this instead.
assert.throws(myFunction, /missing foo/, 'did not throw with expected message');
```

[`assert.deepEqual()`]: #assert_assert_deepequal_actual_expected_message
[`assert.deepStrictEqual()`]: #assert_assert_deepstrictequal_actual_expected_message
[`assert.ok()`]: #assert_assert_ok_value_message
[`assert.throws()`]: #assert_assert_throws_block_error_message
[`Error`]: errors.html#errors_class_error
[`RegExp`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
[`TypeError`]: errors.html#errors_class_typeerror
node-v4.8.2/doc/api/assets/000755 000766 000024 00000000000 13070706740 015574 5ustar00iojsstaff000000 000000 node-v4.8.2/doc/api/buffer.html000644 000766 000024 00000332671 13070706740 016445 0ustar00iojsstaff000000 000000 


  
  Buffer | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

        
Table of Contents

        

      


      

        
Buffer#


Stability: 2 - Stable
Prior to the introduction of TypedArray in ECMAScript 2015 (ES6), the
JavaScript language had no mechanism for reading or manipulating streams
of binary data. The Buffer class was introduced as part of the Node.js
API to make it possible to interact with octet streams in the context of things
like TCP streams and file system operations.


Now that TypedArray has been added in ES6, the Buffer class implements the
Uint8Array API in a manner that is more optimized and suitable for Node.js'
use cases.


Instances of the Buffer class are similar to arrays of integers but
correspond to fixed-sized, raw memory allocations outside the V8 heap.
The size of the Buffer is established when it is created and cannot be
resized.


The Buffer class is a global within Node.js, making it unlikely that one
would need to ever use require('buffer').Buffer.


const buf1 = new Buffer(10);
  // creates a buffer of length 10
  // This is the same as Buffer.allocUnsafe(10), and the returned
  // Buffer instance might contain old data that needs to be
  // overwritten using either fill() or write().

const buf2 = new Buffer([1,2,3]);
  // creates a buffer containing [01, 02, 03]
  // This is the same as Buffer.from([1,2,3]).

const buf3 = new Buffer('test');
  // creates a buffer containing ASCII bytes [74, 65, 73, 74]
  // This is the same as Buffer.from('test').

const buf4 = new Buffer('tést', 'utf8');
  // creates a buffer containing UTF8 bytes [74, c3, a9, 73, 74]
  // This is the same as Buffer.from('tést', 'utf8').

const buf5 = Buffer.alloc(10);
  // Creates a zero-filled Buffer of length 10.

const buf6 = Buffer.alloc(10, 1);
  // Creates a Buffer of length 10, filled with 0x01.

const buf7 = Buffer.allocUnsafe(10);
  // Creates an uninitialized buffer of length 10.
  // This is faster than calling Buffer.alloc() but the returned
  // Buffer instance might contain old data that needs to be
  // overwritten using either fill() or write().

const buf8 = Buffer.from([1,2,3]);
  // Creates a Buffer containing [01, 02, 03].

const buf9 = Buffer.from('test');
  // Creates a Buffer containing ASCII bytes [74, 65, 73, 74].

const buf8 = Buffer.from('tést', 'utf8');
  // Creates a Buffer containing UTF8 bytes [74, c3, a9, 73, 74].



Buffer.from(), Buffer.alloc(), and Buffer.allocUnsafe()#


Historically, Buffer instances have been created using the Buffer
constructor function, which allocates the returned Buffer
differently based on what arguments are provided:


    

  • Passing a number as the first argument to Buffer() (e.g. new Buffer(10)),
allocates a new Buffer object of the specified size. The memory allocated
for such Buffer instances is not initialized and can contain sensitive
data. Such Buffer objects must be initialized manually by using either
buf.fill(0) or by writing to the Buffer completely. While this
behavior is intentional to improve performance, development experience has
demonstrated that a more explicit distinction is required between creating a
fast-but-uninitialized Buffer versus creating a slower-but-safer Buffer.
    • 

  • Passing a string, array, or Buffer as the first argument copies the
passed object's data into the Buffer.
    • 

  • Passing an ArrayBuffer returns a Buffer that shares allocated memory with
the given ArrayBuffer.
    • 



Because the behavior of new Buffer() changes significantly based on the type
of value passed as the first argument, applications that do not properly
validate the input arguments passed to new Buffer(), or that fail to
appropriately initialize newly allocated Buffer content, can inadvertently
introduce security and reliability issues into their code.


To make the creation of Buffer objects more reliable and less error prone,
new Buffer.from(), Buffer.alloc(), and Buffer.allocUnsafe() methods have
been introduced as an alternative means of creating Buffer instances.


Developers should migrate all existing uses of the new Buffer() constructors
to one of these new APIs.



Buffer instances returned by Buffer.allocUnsafe(size) may be allocated
off a shared internal memory pool if size is less than or equal to half
Buffer.poolSize. Instances returned by Buffer.allocUnsafeSlow(size) never
use the shared internal memory pool.


What makes Buffer.allocUnsafe(size) and Buffer.allocUnsafeSlow(size) "unsafe"?#


When calling Buffer.allocUnsafe() (and Buffer.allocUnsafeSlow()), the
segment of allocated memory is uninitialized (it is not zeroed-out). While
this design makes the allocation of memory quite fast, the allocated segment of
memory might contain old data that is potentially sensitive. Using a Buffer
created by Buffer.allocUnsafe() without completely overwriting the memory
can allow this old data to be leaked when the Buffer memory is read.


While there are clear performance advantages to using Buffer.allocUnsafe(),
extra care must be taken in order to avoid introducing security
vulnerabilities into an application.


Buffers and Character Encodings#


Buffers are commonly used to represent sequences of encoded characters
such as UTF8, UCS2, Base64 or even Hex-encoded data. It is possible to
convert back and forth between Buffers and ordinary JavaScript string objects
by using an explicit encoding method.


const buf = new Buffer('hello world', 'ascii');
console.log(buf.toString('hex'));
  // prints: 68656c6c6f20776f726c64
console.log(buf.toString('base64'));
  // prints: aGVsbG8gd29ybGQ=



The character encodings currently supported by Node.js include:


    

  • 'ascii' - for 7-bit ASCII data only.  This encoding method is very fast and
will strip the high bit if set.
    

    • 

  • 'utf8' - Multibyte encoded Unicode characters. Many web pages and other
document formats use UTF-8.
    

    • 

  • 'utf16le' - 2 or 4 bytes, little-endian encoded Unicode characters.
Surrogate pairs (U+10000 to U+10FFFF) are supported.
    

    • 

  • 'ucs2' - Alias of 'utf16le'.
    

    • 

  • 'base64' - Base64 string encoding. When creating a buffer from a string,
this encoding will also correctly accept "URL and Filename Safe Alphabet" as
specified in RFC 4648, Section 5.
    

    • 

  • 'binary' - A way of encoding the buffer into a one-byte (latin-1)
encoded string. The string 'latin-1' is not supported. Instead, pass
'binary' to use 'latin-1' encoding.
    

    • 

  • 'hex' - Encode each byte as two hexadecimal characters.
    

    • 



Buffers and TypedArray#


Buffers are also Uint8Array TypedArray instances. However, there are subtle
incompatibilities with the TypedArray specification in ECMAScript 2015. For
instance, while ArrayBuffer#slice() creates a copy of the slice,
the implementation of Buffer#slice() creates a view over the
existing Buffer without copying, making Buffer#slice() far more efficient.


It is also possible to create new TypedArray instances from a Buffer with the
following caveats:


    

  1. The Buffer instances's memory is copied to the TypedArray, not shared.
    

    2. 

  2. The Buffer's memory is interpreted as an array of distinct elements, and not
as a byte array of the target type. That is,
new Uint32Array(new Buffer([1,2,3,4])) creates a 4-element Uint32Array
with elements [1,2,3,4], not a Uint32Array with a single element
[0x1020304] or [0x4030201].
    

    3. 



It is possible to create a new Buffer that shares the same allocated memory as
a TypedArray instance by using the TypeArray objects .buffer property:


const arr = new Uint16Array(2);
arr[0] = 5000;
arr[1] = 4000;

const buf1 = new Buffer(arr); // copies the buffer
const buf2 = new Buffer(arr.buffer); // shares the memory with arr;

console.log(buf1);
  // Prints: <Buffer 88 a0>, copied buffer has only two elements
console.log(buf2);
  // Prints: <Buffer 88 13 a0 0f>

arr[1] = 6000;
console.log(buf1);
  // Prints: <Buffer 88 a0>
console.log(buf2);
  // Prints: <Buffer 88 13 70 17>



Note that when creating a Buffer using the TypeArray's .buffer, it is not
currently possible to use only a portion of the underlying ArrayBuffer. To
create a Buffer that uses only a part of the ArrayBuffer, use the
buf.slice() function after the Buffer is created:


const arr = new Uint16Array(20);
const buf = new Buffer(arr.buffer).slice(0, 16);
console.log(buf.length);
  // Prints: 16



The Buffer.from() and TypedArray.from() (e.g.Uint8Array.from()) have
different signatures and implementations. Specifically, the TypedArray variants
accept a second argument that is a mapping function that is invoked on every
element of the typed array:


    

  • TypedArray.from(source[, mapFn[, thisArg]])
    • 



The Buffer.from() method, however, does not support the use of a mapping
function:



Buffers and ES6 iteration#


Buffers can be iterated over using the ECMAScript 2015 (ES6) for..of syntax:


const buf = new Buffer([1, 2, 3]);

for (var b of buf)
  console.log(b)

// Prints:
//   1
//   2
//   3



Additionally, the buf.values(), buf.keys(), and
buf.entries() methods can be used to create iterators.


The --zero-fill-buffers command line option#


Node.js can be started using the --zero-fill-buffers command line option to
force all newly allocated Buffer and SlowBuffer instances created using
either new Buffer(size) and new SlowBuffer(size) to be automatically
zero-filled upon creation. Use of this flag changes the default behavior of
these methods and can have a significant impact on performance. Use of the
--zero-fill-buffers option is recommended only when absolutely necessary to
enforce that newly allocated Buffer instances cannot contain potentially
sensitive data.


$ node --zero-fill-buffers
> Buffer(5);
<Buffer 00 00 00 00 00>

Class: Buffer#


The Buffer class is a global type for dealing with binary data directly.
It can be constructed in a variety of ways.


new Buffer(array)#




Allocates a new Buffer using an array of octets.


const buf = new Buffer([0x62,0x75,0x66,0x66,0x65,0x72]);
  // creates a new Buffer containing ASCII bytes
  // ['b','u','f','f','e','r']



new Buffer(buffer)#




Copies the passed buffer data onto a new Buffer instance.


const buf1 = new Buffer('buffer');
const buf2 = new Buffer(buf1);

buf1[0] = 0x61;
console.log(buf1.toString());
  // 'auffer'
console.log(buf2.toString());
  // 'buffer' (copy is not changed)



new Buffer(arrayBuffer)#


    

  • arrayBuffer - The .buffer property of a TypedArray or a new
ArrayBuffer()
    • 



When passed a reference to the .buffer property of a TypedArray instance,
the newly created Buffer will share the same allocated memory as the
TypedArray.


const arr = new Uint16Array(2);
arr[0] = 5000;
arr[1] = 4000;

const buf = new Buffer(arr.buffer); // shares the memory with arr;

console.log(buf);
  // Prints: <Buffer 88 13 a0 0f>

// changing the TypdArray changes the Buffer also
arr[1] = 6000;

console.log(buf);
  // Prints: <Buffer 88 13 70 17>



new Buffer(size)#




Allocates a new Buffer of size bytes.  The size must be less than
or equal to the value of require('buffer').kMaxLength (on 64-bit
architectures, kMaxLength is (2^31)-1). Otherwise, a RangeError is
thrown. If a size less than 0 is specified, a zero-length Buffer will be
created.


Unlike ArrayBuffers, the underlying memory for Buffer instances created in
this way is not initialized. The contents of a newly created Buffer are
unknown and could contain sensitive data. Use buf.fill(0) to initialize a
Buffer to zeroes.


const buf = new Buffer(5);
console.log(buf);
  // <Buffer 78 e0 82 02 01>
  // (octets will be different, every time)
buf.fill(0);
console.log(buf);
  // <Buffer 00 00 00 00 00>



new Buffer(str[, encoding])#




Creates a new Buffer containing the given JavaScript string str. If
provided, the encoding parameter identifies the strings character encoding.


const buf1 = new Buffer('this is a tést');
console.log(buf1.toString());
  // prints: this is a tést
console.log(buf1.toString('ascii'));
  // prints: this is a tC)st

const buf2 = new Buffer('7468697320697320612074c3a97374', 'hex');
console.log(buf2.toString());
  // prints: this is a tést



Class Method: Buffer.alloc(size[, fill[, encoding]])#



Added in: v4.5.0



Allocates a new Buffer of size bytes. If fill is undefined, the
Buffer will be zero-filled.


const buf = Buffer.alloc(5);
console.log(buf);
  // <Buffer 00 00 00 00 00>



The size must be less than or equal to the value of
require('buffer').kMaxLength (on 64-bit architectures, kMaxLength is
(2^31)-1). Otherwise, a RangeError is thrown. If a size less than 0
is specified, a zero-length Buffer will be created.


If fill is specified, the allocated Buffer will be initialized by calling
buf.fill(fill). See [buf.fill()][] for more information.


const buf = Buffer.alloc(5, 'a');
console.log(buf);
  // <Buffer 61 61 61 61 61>



If both fill and encoding are specified, the allocated Buffer will be
initialized by calling buf.fill(fill, encoding). For example:


const buf = Buffer.alloc(11, 'aGVsbG8gd29ybGQ=', 'base64');
console.log(buf);
  // <Buffer 68 65 6c 6c 6f 20 77 6f 72 6c 64>



Calling Buffer.alloc(size) can be significantly slower than the alternative
Buffer.allocUnsafe(size) but ensures that the newly created Buffer instance
contents will never contain sensitive data.


A TypeError will be thrown if size is not a number.


Class Method: Buffer.allocUnsafe(size)#



Added in: v4.5.0



Allocates a new non-zero-filled Buffer of size bytes.  The size must
be less than or equal to the value of require('buffer').kMaxLength (on 64-bit
architectures, kMaxLength is (2^31)-1). Otherwise, a RangeError is
thrown. If a size less than 0 is specified, a zero-length Buffer will be
created.


The underlying memory for Buffer instances created in this way is not
initialized. The contents of the newly created Buffer are unknown and
may contain sensitive data. Use buf.fill(0) to initialize such
Buffer instances to zeroes.


const buf = Buffer.allocUnsafe(5);
console.log(buf);
  // <Buffer 78 e0 82 02 01>
  // (octets will be different, every time)
buf.fill(0);
console.log(buf);
  // <Buffer 00 00 00 00 00>



A TypeError will be thrown if size is not a number.


Note that the Buffer module pre-allocates an internal Buffer instance of
size Buffer.poolSize that is used as a pool for the fast allocation of new
Buffer instances created using Buffer.allocUnsafe(size) (and the
new Buffer(size) constructor) only when size is less than or equal to
Buffer.poolSize >> 1 (floor of Buffer.poolSize divided by two). The default
value of Buffer.poolSize is 8192 but can be modified.


Use of this pre-allocated internal memory pool is a key difference between
calling Buffer.alloc(size, fill) vs. Buffer.allocUnsafe(size).fill(fill).
Specifically, Buffer.alloc(size, fill) will never use the internal Buffer
pool, while Buffer.allocUnsafe(size).fill(fill) will use the internal
Buffer pool if size is less than or equal to half Buffer.poolSize. The
difference is subtle but can be important when an application requires the
additional performance that Buffer.allocUnsafe(size) provides.


Class Method: Buffer.allocUnsafeSlow(size)#



Added in: v4.5.0



Allocates a new non-zero-filled and non-pooled Buffer of size bytes.  The
size must be less than or equal to the value of
require('buffer').kMaxLength (on 64-bit architectures, kMaxLength is
(2^31)-1). Otherwise, a RangeError is thrown. If a size less than 0
is specified, a zero-length Buffer will be created.


The underlying memory for Buffer instances created in this way is not
initialized. The contents of the newly created Buffer are unknown and
may contain sensitive data. Use buf.fill(0) to initialize such
Buffer instances to zeroes.


When using Buffer.allocUnsafe() to allocate new Buffer instances,
allocations under 4KB are, by default, sliced from a single pre-allocated
Buffer. This allows applications to avoid the garbage collection overhead of
creating many individually allocated Buffers. This approach improves both
performance and memory usage by eliminating the need to track and cleanup as
many Persistent objects.


However, in the case where a developer may need to retain a small chunk of
memory from a pool for an indeterminate amount of time, it may be appropriate
to create an un-pooled Buffer instance using Buffer.allocUnsafeSlow() then
copy out the relevant bits.


// need to keep around a few small chunks of memory
const store = [];

socket.on('readable', () => {
  const data = socket.read();
  // allocate for retained data
  const sb = Buffer.allocUnsafeSlow(10);
  // copy the data into the new allocation
  data.copy(sb, 0, 0, 10);
  store.push(sb);
});



Use of Buffer.allocUnsafeSlow() should be used only as a last resort after
a developer has observed undue memory retention in their applications.


A TypeError will be thrown if size is not a number.


Class Method: Buffer.byteLength(string[, encoding])#




Returns the actual byte length of a string. This is not the same as
String.prototype.length since that returns the number of characters in
a string.


Note that for 'base64' and 'hex', this function assumes valid input. For
strings that contain non-Base64/Hex-encoded data (e.g. whitespace), the return
value might be greater than the length of a Buffer created from the string.


Example:


const str = '\u00bd + \u00bc = \u00be';

console.log(`${str}: ${str.length} characters, ` +
            `${Buffer.byteLength(str, 'utf8')} bytes`);

// ½ + ¼ = ¾: 9 characters, 12 bytes



Class Method: Buffer.compare(buf1, buf2)#



Added in: v0.11.13



Compares buf1 to buf2 typically for the purpose of sorting arrays of
Buffers. This is equivalent is calling buf1.compare(buf2).


const arr = [Buffer('1234'), Buffer('0123')];
arr.sort(Buffer.compare);



Class Method: Buffer.concat(list[, totalLength])#



Added in: v0.7.11

    

  • list <Array> List of Buffer objects to concat
    • 

  • totalLength <Number> Total length of the Buffers in the list when concatenated
    • 

  • Returns: <Buffer>
    • 



Returns a new Buffer which is the result of concatenating all the Buffers in
the list together.


If the list has no items, or if the totalLength is 0, then a new zero-length
Buffer is returned.


If totalLength is not provided, it is calculated from the Buffers in the
list. This, however, adds an additional loop to the function, so it is faster
to provide the length explicitly.


Example: build a single Buffer from a list of three Buffers:


const buf1 = new Buffer(10).fill(0);
const buf2 = new Buffer(14).fill(0);
const buf3 = new Buffer(18).fill(0);
const totalLength = buf1.length + buf2.length + buf3.length;

console.log(totalLength);
const bufA = Buffer.concat([buf1, buf2, buf3], totalLength);
console.log(bufA);
console.log(bufA.length);

// 42
// <Buffer 00 00 00 00 ...>
// 42



Class Method: Buffer.from(array)#



Added in: v4.5.0



Allocates a new Buffer using an array of octets.


const buf = Buffer.from([0x62,0x75,0x66,0x66,0x65,0x72]);
  // creates a new Buffer containing ASCII bytes
  // ['b','u','f','f','e','r']



A TypeError will be thrown if array is not an Array.


Class Method: Buffer.from(arrayBuffer)#



Added in: v4.5.0

    

  • arrayBuffer <ArrayBuffer> The .buffer property of a TypedArray or
a new ArrayBuffer()
    • 



When passed a reference to the .buffer property of a TypedArray instance,
the newly created Buffer will share the same allocated memory as the
TypedArray.


const arr = new Uint16Array(2);
arr[0] = 5000;
arr[1] = 4000;

const buf = Buffer.from(arr.buffer); // shares the memory with arr;

console.log(buf);
  // Prints: <Buffer 88 13 a0 0f>

// changing the TypedArray changes the Buffer also
arr[1] = 6000;

console.log(buf);
  // Prints: <Buffer 88 13 70 17>



A TypeError will be thrown if arrayBuffer is not an ArrayBuffer.


Class Method: Buffer.from(buffer)#



Added in: v4.5.0



Copies the passed buffer data onto a new Buffer instance.


const buf1 = Buffer.from('buffer');
const buf2 = Buffer.from(buf1);

buf1[0] = 0x61;
console.log(buf1.toString());
  // 'auffer'
console.log(buf2.toString());
  // 'buffer' (copy is not changed)



A TypeError will be thrown if buffer is not a Buffer.


Class Method: Buffer.from(str[, encoding])#



Added in: v4.5.0

    

  • str <String> String to encode.
    • 

  • encoding <String> Encoding to use, Default: 'utf8'
    • 



Creates a new Buffer containing the given JavaScript string str. If
provided, the encoding parameter identifies the character encoding.
If not provided, encoding defaults to 'utf8'.


const buf1 = Buffer.from('this is a tést');
console.log(buf1.toString());
  // prints: this is a tést
console.log(buf1.toString('ascii'));
  // prints: this is a tC)st

const buf2 = Buffer.from('7468697320697320612074c3a97374', 'hex');
console.log(buf2.toString());
  // prints: this is a tést



A TypeError will be thrown if str is not a string.


Class Method: Buffer.isBuffer(obj)#




Returns 'true' if obj is a Buffer.


Class Method: Buffer.isEncoding(encoding)#



Added in: v0.9.1



Returns true if the encoding is a valid encoding argument, or false
otherwise.


buf[index]#




The index operator [index] can be used to get and set the octet at position
index in the Buffer. The values refer to individual bytes, so the legal value
range is between 0x00 and 0xFF (hex) or 0 and 255 (decimal).


Example: copy an ASCII string into a Buffer, one byte at a time:


const str = "Node.js";
const buf = new Buffer(str.length);

for (var i = 0; i < str.length ; i++) {
  buf[i] = str.charCodeAt(i);
}

console.log(buf.toString('ascii'));
  // Prints: Node.js



buf.compare(otherBuffer)#



Added in: v0.11.13



Compares two Buffer instances and returns a number indicating whether buf
comes before, after, or is the same as the otherBuffer in sort order.
Comparison is based on the actual sequence of bytes in each Buffer.


    

  • 0 is returned if otherBuffer is the same as buf
    • 

  • 1 is returned if otherBuffer should come before buf when sorted.
    • 

  • -1 is returned if otherBuffer should come after buf when sorted.
    • 



const buf1 = new Buffer('ABC');
const buf2 = new Buffer('BCD');
const buf3 = new Buffer('ABCD');

console.log(buf1.compare(buf1));
  // Prints: 0
console.log(buf1.compare(buf2));
  // Prints: -1
console.log(buf1.compare(buf3));
  // Prints: -1
console.log(buf2.compare(buf1));
  // Prints: 1
console.log(buf2.compare(buf3));
  // Prints: 1

[buf1, buf2, buf3].sort(Buffer.compare);
  // produces sort order [buf1, buf3, buf2]



buf.copy(targetBuffer[, targetStart[, sourceStart[, sourceEnd]]])#




Copies data from a region of this Buffer to a region in the target Buffer even
if the target memory region overlaps with the source.


Example: build two Buffers, then copy buf1 from byte 16 through byte 19
into buf2, starting at the 8th byte in buf2.


const buf1 = new Buffer(26);
const buf2 = new Buffer(26).fill('!');

for (var i = 0 ; i < 26 ; i++) {
  buf1[i] = i + 97; // 97 is ASCII a
}

buf1.copy(buf2, 8, 16, 20);
console.log(buf2.toString('ascii', 0, 25));
  // Prints: !!!!!!!!qrst!!!!!!!!!!!!!



Example: Build a single Buffer, then copy data from one region to an overlapping
region in the same Buffer


const buf = new Buffer(26);

for (var i = 0 ; i < 26 ; i++) {
  buf[i] = i + 97; // 97 is ASCII a
}

buf.copy(buf, 0, 4, 10);
console.log(buf.toString());

// efghijghijklmnopqrstuvwxyz



buf.entries()#



Added in: v1.1.0

    

  • Returns: <Iterator>
    • 



Creates and returns an iterator of [index, byte] pairs from the Buffer
contents.


const buf = new Buffer('buffer');
for (var pair of buf.entries()) {
  console.log(pair);
}
// prints:
//   [0, 98]
//   [1, 117]
//   [2, 102]
//   [3, 102]
//   [4, 101]
//   [5, 114]



buf.equals(otherBuffer)#



Added in: v1.0.0



Returns a boolean indicating whether this and otherBuffer have exactly the
same bytes.


const buf1 = new Buffer('ABC');
const buf2 = new Buffer('414243', 'hex');
const buf3 = new Buffer('ABCD');

console.log(buf1.equals(buf2));
  // Prints: true
console.log(buf1.equals(buf3));
  // Prints: false



buf.fill(value[, offset[, end]])#



Added in: v0.5.0



Fills the Buffer with the specified value. If the offset and end are not
given it will fill the entire Buffer. The method returns a reference to the
Buffer so calls can be chained.


const b = new Buffer(50).fill('h');
console.log(b.toString());
  // Prints: hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh



buf.indexOf(value[, byteOffset][, encoding])#



Added in: v1.5.0



Operates similar to Array#indexOf() in that it returns either the
starting index position of value in Buffer or -1 if the Buffer does not
contain value. The value can be a String, Buffer or Number. Strings are by
default interpreted as UTF8. Buffers will use the entire Buffer (to compare a
partial Buffer use buf.slice()). Numbers will be interpreted as unsigned 8-bit
integer values between 0 and 255.


const buf = new Buffer('this is a buffer');

buf.indexOf('this');
  // returns 0
buf.indexOf('is');
  // returns 2
buf.indexOf(new Buffer('a buffer'));
  // returns 8
buf.indexOf(97); // ascii for 'a'
  // returns 8
buf.indexOf(new Buffer('a buffer example'));
  // returns -1
buf.indexOf(new Buffer('a buffer example').slice(0,8));
  // returns 8

const utf16Buffer = new Buffer('\u039a\u0391\u03a3\u03a3\u0395', 'ucs2');

utf16Buffer.indexOf('\u03a3',  0, 'ucs2');
  // returns 4
utf16Buffer.indexOf('\u03a3', -4, 'ucs2');
  // returns 6



buf.keys()#



Added in: v1.1.0

    

  • Returns: <Iterator>
    • 



Creates and returns an iterator of Buffer keys (indices).


const buf = new Buffer('buffer');
for (var key of buf.keys()) {
  console.log(key);
}
// prints:
//   0
//   1
//   2
//   3
//   4
//   5



buf.length#




Returns the amount of memory allocated for the Buffer in number of bytes. Note
that this does not necessarily reflect the amount of usable data within the
Buffer. For instance, in the example below, a Buffer with 1234 bytes is
allocated, but only 11 ASCII bytes are written.


const buf = new Buffer(1234);

console.log(buf.length);
  // Prints: 1234

buf.write('some string', 0, 'ascii');
console.log(buf.length);
  // Prints: 1234



While the length property is not immutable, changing the value of length
can result in undefined and inconsistent behavior. Applications that wish to
modify the length of a Buffer should therefore treat length as read-only and
use buf.slice() to create a new Buffer.


var buf = new Buffer(10);
buf.write('abcdefghj', 0, 'ascii');
console.log(buf.length);
  // Prints: 10
buf = buf.slice(0,5);
console.log(buf.length);
  // Prints: 5



buf.readDoubleBE(offset[, noAssert])#


buf.readDoubleLE(offset[, noAssert])#




Reads a 64-bit double from the Buffer at the specified offset with specified
endian format (readDoubleBE() returns big endian, readDoubleLE() returns
little endian).


Setting noAssert to true skips validation of the offset. This allows the
offset to be beyond the end of the Buffer.


const buf = new Buffer([1,2,3,4,5,6,7,8]);

buf.readDoubleBE();
  // Returns: 8.20788039913184e-304
buf.readDoubleLE();
  // Returns: 5.447603722011605e-270
buf.readDoubleLE(1);
  // throws RangeError: Index out of range

buf.readDoubleLE(1, true); // Warning: reads passed end of buffer!
  // Segmentation fault! don't do this!



buf.readFloatBE(offset[, noAssert])#


buf.readFloatLE(offset[, noAssert])#




Reads a 32-bit float from the Buffer at the specified offset with specified
endian format (readFloatBE() returns big endian, readFloatLE() returns
little endian).


Setting noAssert to true skips validation of the offset. This allows the
offset to be beyond the end of the Buffer.


const buf = new Buffer([1,2,3,4]);

buf.readFloatBE();
  // Returns: 2.387939260590663e-38
buf.readFloatLE();
  // Returns: 1.539989614439558e-36
buf.readFloatLE(1);
  // throws RangeError: Index out of range

buf.readFloatLE(1, true); // Warning: reads passed end of buffer!
  // Segmentation fault! don't do this!



buf.readInt8(offset[, noAssert])#




Reads a signed 8-bit integer from the Buffer at the specified offset.


Setting noAssert to true skips validation of the offset. This allows the
offset to be beyond the end of the Buffer.


Integers read from the Buffer are interpreted as two's complement signed values.


const buf = new Buffer([1,-2,3,4]);

buf.readInt8(0);
  // returns 1
buf.readInt8(1);
  // returns -2



buf.readInt16BE(offset[, noAssert])#


buf.readInt16LE(offset[, noAssert])#




Reads a signed 16-bit integer from the Buffer at the specified offset with
the specified endian format (readInt16BE() returns big endian,
readInt16LE() returns little endian).


Setting noAssert to true skips validation of the offset. This allows the
offset to be beyond the end of the Buffer.


Integers read from the Buffer are interpreted as two's complement signed values.


const buf = new Buffer([1,-2,3,4]);

buf.readInt16BE();
  // returns 510
buf.readInt16LE(1);
  // returns 1022



buf.readInt32BE(offset[, noAssert])#


buf.readInt32LE(offset[, noAssert])#




Reads a signed 32-bit integer from the Buffer at the specified offset with
the specified endian format (readInt32BE() returns big endian,
readInt32LE() returns little endian).


Setting noAssert to true skips validation of the offset. This allows the
offset to be beyond the end of the Buffer.


Integers read from the Buffer are interpreted as two's complement signed values.


const buf = new Buffer([1,-2,3,4]);

buf.readInt32BE();
  // returns 33424132
buf.readInt32LE();
  // returns 67370497
buf.readInt32LE(1);
  // throws RangeError: Index out of range



buf.readIntBE(offset, byteLength[, noAssert])#


buf.readIntLE(offset, byteLength[, noAssert])#



Added in: v1.0.0



Reads byteLength number of bytes from the Buffer at the specified offset
and interprets the result as a two's complement signed value. Supports up to 48
bits of accuracy. For example:


const buf = new Buffer(6);
buf.writeUInt16LE(0x90ab, 0);
buf.writeUInt32LE(0x12345678, 2);
buf.readIntLE(0, 6).toString(16);  // Specify 6 bytes (48 bits)
// Returns: '1234567890ab'

buf.readIntBE(0, 6).toString(16);
// Returns: -546f87a9cbee



Setting noAssert to true skips validation of the offset. This allows the
offset to be beyond the end of the Buffer.


buf.readUInt8(offset[, noAssert])#




Reads an unsigned 8-bit integer from the Buffer at the specified offset.


Setting noAssert to true skips validation of the offset. This allows the
offset to be beyond the end of the Buffer.


const buf = new Buffer([1,-2,3,4]);

buf.readUInt8(0);
  // returns 1
buf.readUInt8(1);
  // returns 254



buf.readUInt16BE(offset[, noAssert])#


buf.readUInt16LE(offset[, noAssert])#




Reads an unsigned 16-bit integer from the Buffer at the specified offset with
specified endian format (readUInt16BE() returns big endian,
readUInt16LE() returns little endian).


Setting noAssert to true skips validation of the offset. This allows the
offset to be beyond the end of the Buffer.


Example:


const buf = new Buffer([0x3, 0x4, 0x23, 0x42]);

buf.readUInt16BE(0);
  // Returns: 0x0304
buf.readUInt16LE(0);
  // Returns: 0x0403
buf.readUInt16BE(1);
  // Returns: 0x0423
buf.readUInt16LE(1);
  // Returns: 0x2304
buf.readUInt16BE(2);
  // Returns: 0x2342
buf.readUInt16LE(2);
  // Returns: 0x4223



buf.readUInt32BE(offset[, noAssert])#


buf.readUInt32LE(offset[, noAssert])#




Reads an unsigned 32-bit integer from the Buffer at the specified offset with
specified endian format (readUInt32BE() returns big endian,
readUInt32LE() returns little endian).


Setting noAssert to true skips validation of the offset. This allows the
offset to be beyond the end of the Buffer.


Example:


const buf = new Buffer([0x3, 0x4, 0x23, 0x42]);

buf.readUInt32BE(0);
  // Returns: 0x03042342
console.log(buf.readUInt32LE(0));
  // Returns: 0x42230403



buf.readUIntBE(offset, byteLength[, noAssert])#


buf.readUIntLE(offset, byteLength[, noAssert])#



Added in: v1.0.0



Reads byteLength number of bytes from the Buffer at the specified offset
and interprets the result as an unsigned integer. Supports up to 48
bits of accuracy. For example:


const buf = new Buffer(6);
buf.writeUInt16LE(0x90ab, 0);
buf.writeUInt32LE(0x12345678, 2);
buf.readUIntLE(0, 6).toString(16);  // Specify 6 bytes (48 bits)
// Returns: '1234567890ab'

buf.readUIntBE(0, 6).toString(16);
// Returns: ab9078563412



Setting noAssert to true skips validation of the offset. This allows the
offset to be beyond the end of the Buffer.


buf.slice([start[, end]])#




Returns a new Buffer that references the same memory as the original, but
offset and cropped by the start and end indices.


Note that modifying the new Buffer slice will modify the memory in the
original Buffer because the allocated memory of the two objects overlap.


Example: build a Buffer with the ASCII alphabet, take a slice, then modify one
byte from the original Buffer.


const buf1 = new Buffer(26);

for (var i = 0 ; i < 26 ; i++) {
  buf1[i] = i + 97; // 97 is ASCII a
}

const buf2 = buf1.slice(0, 3);
buf2.toString('ascii', 0, buf2.length);
  // Returns: 'abc'
buf1[0] = 33;
buf2.toString('ascii', 0, buf2.length);
  // Returns : '!bc'



Specifying negative indexes causes the slice to be generated relative to the
end of the Buffer rather than the beginning.


const buf = new Buffer('buffer');

buf.slice(-6, -1).toString();
  // Returns 'buffe', equivalent to buf.slice(0, 5)
buf.slice(-6, -2).toString();
  // Returns 'buff', equivalent to buf.slice(0, 4)
buf.slice(-5, -2).toString();
  // Returns 'uff', equivalent to buf.slice(1, 4)



buf.toString([encoding[, start[, end]]])#




Decodes and returns a string from the Buffer data using the specified
character set encoding.


const buf = new Buffer(26);
for (var i = 0 ; i < 26 ; i++) {
  buf[i] = i + 97; // 97 is ASCII a
}
buf.toString('ascii');
  // Returns: 'abcdefghijklmnopqrstuvwxyz'
buf.toString('ascii',0,5);
  // Returns: 'abcde'
buf.toString('utf8',0,5);
  // Returns: 'abcde'
buf.toString(undefined,0,5);
  // Returns: 'abcde', encoding defaults to 'utf8'



buf.toJSON()#



Added in: v0.9.2



Returns a JSON representation of the Buffer instance.  JSON.stringify()
implicitly calls this function when stringifying a Buffer instance.


Example:


const buf = new Buffer('test');
const json = JSON.stringify(buf);

console.log(json);
// Prints: '{"type":"Buffer","data":[116,101,115,116]}'

const copy = JSON.parse(json, (key, value) => {
    return value && value.type === 'Buffer'
      ? new Buffer(value.data)
      : value;
  });

console.log(copy.toString());
// Prints: 'test'



buf.values()#



Added in: v1.1.0

    

  • Returns: <Iterator>
    • 



Creates and returns an iterator for Buffer values (bytes). This function is
called automatically when the Buffer is used in a for..of statement.


const buf = new Buffer('buffer');
for (var value of buf.values()) {
  console.log(value);
}
// prints:
//   98
//   117
//   102
//   102
//   101
//   114

for (var value of buf) {
  console.log(value);
}
// prints:
//   98
//   117
//   102
//   102
//   101
//   114



buf.write(string[, offset[, length]][, encoding])#




Writes string to the Buffer at offset using the given encoding.
The length parameter is the number of bytes to write. If the Buffer did not
contain enough space to fit the entire string, only a partial amount of the
string will be written however, it will not write only partially encoded
characters.


const buf = new Buffer(256);
const len = buf.write('\u00bd + \u00bc = \u00be', 0);
console.log(`${len} bytes: ${buf.toString('utf8', 0, len)}`);
  // Prints: 12 bytes: ½ + ¼ = ¾



buf.writeDoubleBE(value, offset[, noAssert])#


buf.writeDoubleLE(value, offset[, noAssert])#


    

  • value <Number> Bytes to be written to Buffer
    • 

  • offset <Number> 0 <= offset <= buf.length - 8
    • 

  • noAssert <Boolean> Default: false
    • 

  • Returns: <Number> The offset plus the number of written bytes
    • 



Writes value to the Buffer at the specified offset with specified endian
format (writeDoubleBE() writes big endian, writeDoubleLE() writes little
endian). The value argument should be a valid 64-bit double. Behavior is
not defined when value is anything other than a 64-bit double.


Set noAssert to true to skip validation of value and offset. This means
that value may be too large for the specific function and offset may be
beyond the end of the Buffer leading to the values being silently dropped. This
should not be used unless you are certain of correctness.


Example:


const buf = new Buffer(8);
buf.writeDoubleBE(0xdeadbeefcafebabe, 0);

console.log(buf);
  // Prints: <Buffer 43 eb d5 b7 dd f9 5f d7>

buf.writeDoubleLE(0xdeadbeefcafebabe, 0);

console.log(buf);
  // Prints: <Buffer d7 5f f9 dd b7 d5 eb 43>



buf.writeFloatBE(value, offset[, noAssert])#


buf.writeFloatLE(value, offset[, noAssert])#


    

  • value <Number> Bytes to be written to Buffer
    • 

  • offset <Number> 0 <= offset <= buf.length - 4
    • 

  • noAssert <Boolean> Default: false
    • 

  • Returns: <Number> The offset plus the number of written bytes
    • 



Writes value to the Buffer at the specified offset with specified endian
format (writeFloatBE() writes big endian, writeFloatLE() writes little
endian). Behavior is not defined when value is anything other than a 32-bit
float.


Set noAssert to true to skip validation of value and offset. This means
that value may be too large for the specific function and offset may be
beyond the end of the Buffer leading to the values being silently dropped. This
should not be used unless you are certain of correctness.


Example:


const buf = new Buffer(4);
buf.writeFloatBE(0xcafebabe, 0);

console.log(buf);
  // Prints: <Buffer 4f 4a fe bb>

buf.writeFloatLE(0xcafebabe, 0);

console.log(buf);
  // Prints: <Buffer bb fe 4a 4f>



buf.writeInt8(value, offset[, noAssert])#


    

  • value <Number> Bytes to be written to Buffer
    • 

  • offset <Number> 0 <= offset <= buf.length - 1
    • 

  • noAssert <Boolean> Default: false
    • 

  • Returns: <Number> The offset plus the number of written bytes
    • 



Writes value to the Buffer at the specified offset. The value should be a
valid signed 8-bit integer.  Behavior is not defined when value is anything
other than a signed 8-bit integer.


Set noAssert to true to skip validation of value and offset. This means
that value may be too large for the specific function and offset may be
beyond the end of the Buffer leading to the values being silently dropped. This
should not be used unless you are certain of correctness.


The value is interpreted and written as a two's complement signed integer.


const buf = new Buffer(2);
buf.writeInt8(2, 0);
buf.writeInt8(-2, 1);
console.log(buf);
  // Prints: <Buffer 02 fe>



buf.writeInt16BE(value, offset[, noAssert])#


buf.writeInt16LE(value, offset[, noAssert])#


    

  • value <Number> Bytes to be written to Buffer
    • 

  • offset <Number> 0 <= offset <= buf.length - 2
    • 

  • noAssert <Boolean> Default: false
    • 

  • Returns: <Number> The offset plus the number of written bytes
    • 



Writes value to the Buffer at the specified offset with specified endian
format (writeInt16BE() writes big endian, writeInt16LE() writes little
endian). The value should be a valid signed 16-bit integer. Behavior is
not defined when value is anything other than a signed 16-bit integer.


Set noAssert to true to skip validation of value and offset. This means
that value may be too large for the specific function and offset may be
beyond the end of the Buffer leading to the values being silently dropped. This
should not be used unless you are certain of correctness.


The value is interpreted and written as a two's complement signed integer.


const buf = new Buffer(4);
buf.writeInt16BE(0x0102,0);
buf.writeInt16LE(0x0304,2);
console.log(buf);
  // Prints: <Buffer 01 02 04 03>



buf.writeInt32BE(value, offset[, noAssert])#


buf.writeInt32LE(value, offset[, noAssert])#


    

  • value <Number> Bytes to be written to Buffer
    • 

  • offset <Number> 0 <= offset <= buf.length - 4
    • 

  • noAssert <Boolean> Default: false
    • 

  • Returns: <Number> The offset plus the number of written bytes
    • 



Writes value to the Buffer at the specified offset with specified endian
format (writeInt32BE() writes big endian, writeInt32LE() writes little
endian). The value should be a valid signed 32-bit integer. Behavior is
not defined when value is anything other than a signed 32-bit integer.


Set noAssert to true to skip validation of value and offset. This means
that value may be too large for the specific function and offset may be
beyond the end of the Buffer leading to the values being silently dropped. This
should not be used unless you are certain of correctness.


The value is interpreted and written as a two's complement signed integer.


const buf = new Buffer(8);
buf.writeInt32BE(0x01020304,0);
buf.writeInt32LE(0x05060708,4);
console.log(buf);
  // Prints: <Buffer 01 02 03 04 08 07 06 05>



buf.writeIntBE(value, offset, byteLength[, noAssert])#


buf.writeIntLE(value, offset, byteLength[, noAssert])#



Added in: v1.0.0

    

  • value <Number> Bytes to be written to Buffer
    • 

  • offset <Number> 0 <= offset <= buf.length - byteLength
    • 

  • byteLength <Number> 0 < byteLength <= 6
    • 

  • noAssert <Boolean> Default: false
    • 

  • Returns: <Number> The offset plus the number of written bytes
    • 



Writes value to the Buffer at the specified offset and byteLength.
Supports up to 48 bits of accuracy. For example:


const buf1 = new Buffer(6);
buf1.writeUIntBE(0x1234567890ab, 0, 6);
console.log(buf1);
  // Prints: <Buffer 12 34 56 78 90 ab>

const buf2 = new Buffer(6);
buf2.writeUIntLE(0x1234567890ab, 0, 6);
console.log(buf2);
  // Prints: <Buffer ab 90 78 56 34 12>



Set noAssert to true to skip validation of value and offset. This means
that value may be too large for the specific function and offset may be
beyond the end of the Buffer leading to the values being silently dropped. This
should not be used unless you are certain of correctness.


Behavior is not defined when value is anything other than an integer.


buf.writeUInt8(value, offset[, noAssert])#


    

  • value <Number> Bytes to be written to Buffer
    • 

  • offset <Number> 0 <= offset <= buf.length - 1
    • 

  • noAssert <Boolean> Default: false
    • 

  • Returns: <Number> The offset plus the number of written bytes
    • 



Writes value to the Buffer at the specified offset. The value should be a
valid unsigned 8-bit integer.  Behavior is not defined when value is anything
other than an unsigned 8-bit integer.


Set noAssert to true to skip validation of value and offset. This means
that value may be too large for the specific function and offset may be
beyond the end of the Buffer leading to the values being silently dropped. This
should not be used unless you are certain of correctness.


Example:


const buf = new Buffer(4);
buf.writeUInt8(0x3, 0);
buf.writeUInt8(0x4, 1);
buf.writeUInt8(0x23, 2);
buf.writeUInt8(0x42, 3);

console.log(buf);
  // Prints: <Buffer 03 04 23 42>



buf.writeUInt16BE(value, offset[, noAssert])#


buf.writeUInt16LE(value, offset[, noAssert])#


    

  • value <Number> Bytes to be written to Buffer
    • 

  • offset <Number> 0 <= offset <= buf.length - 2
    • 

  • noAssert <Boolean> Default: false
    • 

  • Returns: <Number> The offset plus the number of written bytes
    • 



Writes value to the Buffer at the specified offset with specified endian
format (writeUInt16BE() writes big endian, writeUInt16LE() writes little
endian). The value should be a valid unsigned 16-bit integer. Behavior is
not defined when value is anything other than an unsigned 16-bit integer.


Set noAssert to true to skip validation of value and offset. This means
that value may be too large for the specific function and offset may be
beyond the end of the Buffer leading to the values being silently dropped. This
should not be used unless you are certain of correctness.


Example:


const buf = new Buffer(4);
buf.writeUInt16BE(0xdead, 0);
buf.writeUInt16BE(0xbeef, 2);

console.log(buf);
  // Prints: <Buffer de ad be ef>

buf.writeUInt16LE(0xdead, 0);
buf.writeUInt16LE(0xbeef, 2);

console.log(buf);
  // Prints: <Buffer ad de ef be>



buf.writeUInt32BE(value, offset[, noAssert])#


buf.writeUInt32LE(value, offset[, noAssert])#


    

  • value <Number> Bytes to be written to Buffer
    • 

  • offset <Number> 0 <= offset <= buf.length - 4
    • 

  • noAssert <Boolean> Default: false
    • 

  • Returns: <Number> The offset plus the number of written bytes
    • 



Writes value to the Buffer at the specified offset with specified endian
format (writeUInt32BE() writes big endian, writeUInt32LE() writes little
endian). The value should be a valid unsigned 32-bit integer. Behavior is
not defined when value is anything other than an unsigned 32-bit integer.


Set noAssert to true to skip validation of value and offset. This means
that value may be too large for the specific function and offset may be
beyond the end of the Buffer leading to the values being silently dropped. This
should not be used unless you are certain of correctness.


Example:


const buf = new Buffer(4);
buf.writeUInt32BE(0xfeedface, 0);

console.log(buf);
  // Prints: <Buffer fe ed fa ce>

buf.writeUInt32LE(0xfeedface, 0);

console.log(buf);
  // Prints: <Buffer ce fa ed fe>



buf.writeUIntBE(value, offset, byteLength[, noAssert])#


buf.writeUIntLE(value, offset, byteLength[, noAssert])#


    

  • value <Number> Bytes to be written to Buffer
    • 

  • offset <Number> 0 <= offset <= buf.length - byteLength
    • 

  • byteLength <Number> 0 < byteLength <= 6
    • 

  • noAssert <Boolean> Default: false
    • 

  • Returns: <Number> The offset plus the number of written bytes
    • 



Writes value to the Buffer at the specified offset and byteLength.
Supports up to 48 bits of accuracy. For example:


const buf = new Buffer(6);
buf.writeUIntBE(0x1234567890ab, 0, 6);
console.log(buf);
  // Prints: <Buffer 12 34 56 78 90 ab>



Set noAssert to true to skip validation of value and offset. This means
that value may be too large for the specific function and offset may be
beyond the end of the Buffer leading to the values being silently dropped. This
should not be used unless you are certain of correctness.


Behavior is not defined when value is anything other than an unsigned integer.


buffer.INSPECT_MAX_BYTES#




Returns the maximum number of bytes that will be returned when
buffer.inspect() is called. This can be overridden by user modules. See
util.inspect() for more details on buffer.inspect() behavior.


Note that this is a property on the buffer module as returned by
require('buffer'), not on the Buffer global or a Buffer instance.


Class: SlowBuffer#


Returns an un-pooled Buffer.


In order to avoid the garbage collection overhead of creating many individually
allocated Buffers, by default allocations under 4KB are sliced from a single
larger allocated object. This approach improves both performance and memory
usage since v8 does not need to track and cleanup as many Persistent objects.


In the case where a developer may need to retain a small chunk of memory from a
pool for an indeterminate amount of time, it may be appropriate to create an
un-pooled Buffer instance using SlowBuffer then copy out the relevant bits.


// need to keep around a few small chunks of memory
const store = [];

socket.on('readable', () => {
  var data = socket.read();
  // allocate for retained data
  var sb = new SlowBuffer(10);
  // copy the data into the new allocation
  data.copy(sb, 0, 0, 10);
  store.push(sb);
});



Use of SlowBuffer should be used only as a last resort after a developer
has observed undue memory retention in their applications.


new SlowBuffer(size)#


    

  • size Number
    • 



Allocates a new SlowBuffer of size bytes.  The size must be less than
or equal to the value of require('buffer').kMaxLength (on 64-bit
architectures, kMaxLength is (2^31)-1). Otherwise, a RangeError is
thrown. If a size less than 0 is specified, a zero-length SlowBuffer will be
created.


The underlying memory for SlowBuffer instances is not initialized. The
contents of a newly created SlowBuffer are unknown and could contain
sensitive data. Use buf.fill(0) to initialize a SlowBuffer to zeroes.


const SlowBuffer = require('buffer').SlowBuffer;
const buf = new SlowBuffer(5);
console.log(buf);
  // <Buffer 78 e0 82 02 01>
  // (octets will be different, every time)
buf.fill(0);
console.log(buf);
  // <Buffer 00 00 00 00 00>



      

    

  

  
  
  
  



node-v4.8.2/doc/api/buffer.json000644 000766 000024 00000532565 13070706740 016456 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/buffer.md",
  "modules": [
    {
      "textRaw": "Buffer",
      "name": "buffer",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
Prior to the introduction of TypedArray in ECMAScript 2015 (ES6), the\nJavaScript language had no mechanism for reading or manipulating streams\nof binary data. The Buffer class was introduced as part of the Node.js\nAPI to make it possible to interact with octet streams in the context of things\nlike TCP streams and file system operations.
\n
Now that TypedArray has been added in ES6, the Buffer class implements the\nUint8Array API in a manner that is more optimized and suitable for Node.js'\nuse cases.
\n
Instances of the Buffer class are similar to arrays of integers but\ncorrespond to fixed-sized, raw memory allocations outside the V8 heap.\nThe size of the Buffer is established when it is created and cannot be\nresized.
\n
The Buffer class is a global within Node.js, making it unlikely that one\nwould need to ever use require('buffer').Buffer.
\n
const buf1 = new Buffer(10);\n  // creates a buffer of length 10\n  // This is the same as Buffer.allocUnsafe(10), and the returned\n  // Buffer instance might contain old data that needs to be\n  // overwritten using either fill() or write().\n\nconst buf2 = new Buffer([1,2,3]);\n  // creates a buffer containing [01, 02, 03]\n  // This is the same as Buffer.from([1,2,3]).\n\nconst buf3 = new Buffer('test');\n  // creates a buffer containing ASCII bytes [74, 65, 73, 74]\n  // This is the same as Buffer.from('test').\n\nconst buf4 = new Buffer('tést', 'utf8');\n  // creates a buffer containing UTF8 bytes [74, c3, a9, 73, 74]\n  // This is the same as Buffer.from('tést', 'utf8').\n\nconst buf5 = Buffer.alloc(10);\n  // Creates a zero-filled Buffer of length 10.\n\nconst buf6 = Buffer.alloc(10, 1);\n  // Creates a Buffer of length 10, filled with 0x01.\n\nconst buf7 = Buffer.allocUnsafe(10);\n  // Creates an uninitialized buffer of length 10.\n  // This is faster than calling Buffer.alloc() but the returned\n  // Buffer instance might contain old data that needs to be\n  // overwritten using either fill() or write().\n\nconst buf8 = Buffer.from([1,2,3]);\n  // Creates a Buffer containing [01, 02, 03].\n\nconst buf9 = Buffer.from('test');\n  // Creates a Buffer containing ASCII bytes [74, 65, 73, 74].\n\nconst buf8 = Buffer.from('tést', 'utf8');\n  // Creates a Buffer containing UTF8 bytes [74, c3, a9, 73, 74].\n
\n",
      "modules": [
        {
          "textRaw": "`Buffer.from()`, `Buffer.alloc()`, and `Buffer.allocUnsafe()`",
          "name": "`buffer.from()`,_`buffer.alloc()`,_and_`buffer.allocunsafe()`",
          "desc": "
Historically, Buffer instances have been created using the Buffer\nconstructor function, which allocates the returned Buffer\ndifferently based on what arguments are provided:
\n
    \n
  • Passing a number as the first argument to Buffer() (e.g. new Buffer(10)),\nallocates a new Buffer object of the specified size. The memory allocated\nfor such Buffer instances is not initialized and can contain sensitive\ndata. Such Buffer objects must be initialized manually by using either\nbuf.fill(0) or by writing to the Buffer completely. While this\nbehavior is intentional to improve performance, development experience has\ndemonstrated that a more explicit distinction is required between creating a\nfast-but-uninitialized Buffer versus creating a slower-but-safer Buffer.
    • \n
  • Passing a string, array, or Buffer as the first argument copies the\npassed object's data into the Buffer.
    • \n
  • Passing an ArrayBuffer returns a Buffer that shares allocated memory with\nthe given ArrayBuffer.
    • \n
\n
Because the behavior of new Buffer() changes significantly based on the type\nof value passed as the first argument, applications that do not properly\nvalidate the input arguments passed to new Buffer(), or that fail to\nappropriately initialize newly allocated Buffer content, can inadvertently\nintroduce security and reliability issues into their code.
\n
To make the creation of Buffer objects more reliable and less error prone,\nnew Buffer.from(), Buffer.alloc(), and Buffer.allocUnsafe() methods have\nbeen introduced as an alternative means of creating Buffer instances.
\n
Developers should migrate all existing uses of the new Buffer() constructors\nto one of these new APIs.
\n\n
Buffer instances returned by Buffer.allocUnsafe(size) may be allocated\noff a shared internal memory pool if size is less than or equal to half\nBuffer.poolSize. Instances returned by Buffer.allocUnsafeSlow(size) never\nuse the shared internal memory pool.
\n",
          "modules": [
            {
              "textRaw": "What makes `Buffer.allocUnsafe(size)` and `Buffer.allocUnsafeSlow(size)` \"unsafe\"?",
              "name": "what_makes_`buffer.allocunsafe(size)`_and_`buffer.allocunsafeslow(size)`_\"unsafe\"?",
              "desc": "
When calling Buffer.allocUnsafe() (and Buffer.allocUnsafeSlow()), the\nsegment of allocated memory is uninitialized (it is not zeroed-out). While\nthis design makes the allocation of memory quite fast, the allocated segment of\nmemory might contain old data that is potentially sensitive. Using a Buffer\ncreated by Buffer.allocUnsafe() without completely overwriting the memory\ncan allow this old data to be leaked when the Buffer memory is read.
\n
While there are clear performance advantages to using Buffer.allocUnsafe(),\nextra care must be taken in order to avoid introducing security\nvulnerabilities into an application.
\n",
              "type": "module",
              "displayName": "What makes `Buffer.allocUnsafe(size)` and `Buffer.allocUnsafeSlow(size)` \"unsafe\"?"
            }
          ],
          "type": "module",
          "displayName": "`Buffer.from()`, `Buffer.alloc()`, and `Buffer.allocUnsafe()`"
        },
        {
          "textRaw": "Buffers and Character Encodings",
          "name": "buffers_and_character_encodings",
          "desc": "
Buffers are commonly used to represent sequences of encoded characters\nsuch as UTF8, UCS2, Base64 or even Hex-encoded data. It is possible to\nconvert back and forth between Buffers and ordinary JavaScript string objects\nby using an explicit encoding method.
\n
const buf = new Buffer('hello world', 'ascii');\nconsole.log(buf.toString('hex'));\n  // prints: 68656c6c6f20776f726c64\nconsole.log(buf.toString('base64'));\n  // prints: aGVsbG8gd29ybGQ=\n
\n
The character encodings currently supported by Node.js include:
\n
    \n
  • 'ascii' - for 7-bit ASCII data only.  This encoding method is very fast and\nwill strip the high bit if set.
    \n
    • \n
  • 'utf8' - Multibyte encoded Unicode characters. Many web pages and other\ndocument formats use UTF-8.
    \n
    • \n
  • 'utf16le' - 2 or 4 bytes, little-endian encoded Unicode characters.\nSurrogate pairs (U+10000 to U+10FFFF) are supported.
    \n
    • \n
  • 'ucs2' - Alias of 'utf16le'.
    \n
    • \n
  • 'base64' - Base64 string encoding. When creating a buffer from a string,\nthis encoding will also correctly accept "URL and Filename Safe Alphabet" as\nspecified in RFC 4648, Section 5.
    \n
    • \n
  • 'binary' - A way of encoding the buffer into a one-byte (latin-1)\nencoded string. The string 'latin-1' is not supported. Instead, pass\n'binary' to use 'latin-1' encoding.
    \n
    • \n
  • 'hex' - Encode each byte as two hexadecimal characters.
    \n
    • \n
\n",
          "type": "module",
          "displayName": "Buffers and Character Encodings"
        },
        {
          "textRaw": "Buffers and TypedArray",
          "name": "buffers_and_typedarray",
          "desc": "
Buffers are also Uint8Array TypedArray instances. However, there are subtle\nincompatibilities with the TypedArray specification in ECMAScript 2015. For\ninstance, while ArrayBuffer#slice() creates a copy of the slice,\nthe implementation of Buffer#slice() creates a view over the\nexisting Buffer without copying, making Buffer#slice() far more efficient.
\n
It is also possible to create new TypedArray instances from a Buffer with the\nfollowing caveats:
\n
    \n
  1. The Buffer instances's memory is copied to the TypedArray, not shared.
    \n
    2. \n
  2. The Buffer's memory is interpreted as an array of distinct elements, and not\nas a byte array of the target type. That is,\nnew Uint32Array(new Buffer([1,2,3,4])) creates a 4-element Uint32Array\nwith elements [1,2,3,4], not a Uint32Array with a single element\n[0x1020304] or [0x4030201].
    \n
    3. \n
\n
It is possible to create a new Buffer that shares the same allocated memory as\na TypedArray instance by using the TypeArray objects .buffer property:
\n
const arr = new Uint16Array(2);\narr[0] = 5000;\narr[1] = 4000;\n\nconst buf1 = new Buffer(arr); // copies the buffer\nconst buf2 = new Buffer(arr.buffer); // shares the memory with arr;\n\nconsole.log(buf1);\n  // Prints: <Buffer 88 a0>, copied buffer has only two elements\nconsole.log(buf2);\n  // Prints: <Buffer 88 13 a0 0f>\n\narr[1] = 6000;\nconsole.log(buf1);\n  // Prints: <Buffer 88 a0>\nconsole.log(buf2);\n  // Prints: <Buffer 88 13 70 17>\n
\n
Note that when creating a Buffer using the TypeArray's .buffer, it is not\ncurrently possible to use only a portion of the underlying ArrayBuffer. To\ncreate a Buffer that uses only a part of the ArrayBuffer, use the\nbuf.slice() function after the Buffer is created:
\n
const arr = new Uint16Array(20);\nconst buf = new Buffer(arr.buffer).slice(0, 16);\nconsole.log(buf.length);\n  // Prints: 16\n
\n
The Buffer.from() and TypedArray.from() (e.g.Uint8Array.from()) have\ndifferent signatures and implementations. Specifically, the TypedArray variants\naccept a second argument that is a mapping function that is invoked on every\nelement of the typed array:
\n
    \n
  • TypedArray.from(source[, mapFn[, thisArg]])
    • \n
\n
The Buffer.from() method, however, does not support the use of a mapping\nfunction:
\n\n",
          "type": "module",
          "displayName": "Buffers and TypedArray"
        },
        {
          "textRaw": "Buffers and ES6 iteration",
          "name": "buffers_and_es6_iteration",
          "desc": "
Buffers can be iterated over using the ECMAScript 2015 (ES6) for..of syntax:
\n
const buf = new Buffer([1, 2, 3]);\n\nfor (var b of buf)\n  console.log(b)\n\n// Prints:\n//   1\n//   2\n//   3\n
\n
Additionally, the buf.values(), buf.keys(), and\nbuf.entries() methods can be used to create iterators.
\n",
          "type": "module",
          "displayName": "Buffers and ES6 iteration"
        },
        {
          "textRaw": "The `--zero-fill-buffers` command line option",
          "name": "the_`--zero-fill-buffers`_command_line_option",
          "desc": "
Node.js can be started using the --zero-fill-buffers command line option to\nforce all newly allocated Buffer and SlowBuffer instances created using\neither new Buffer(size) and new SlowBuffer(size) to be automatically\nzero-filled upon creation. Use of this flag changes the default behavior of\nthese methods and can have a significant impact on performance. Use of the\n--zero-fill-buffers option is recommended only when absolutely necessary to\nenforce that newly allocated Buffer instances cannot contain potentially\nsensitive data.
\n
$ node --zero-fill-buffers\n> Buffer(5);\n<Buffer 00 00 00 00 00>\n
",
          "type": "module",
          "displayName": "The `--zero-fill-buffers` command line option"
        }
      ],
      "classes": [
        {
          "textRaw": "Class: Buffer",
          "type": "class",
          "name": "Buffer",
          "desc": "
The Buffer class is a global type for dealing with binary data directly.\nIt can be constructed in a variety of ways.
\n",
          "classMethods": [
            {
              "textRaw": "Class Method: Buffer.alloc(size[, fill[, encoding]])",
              "type": "classMethod",
              "name": "alloc",
              "meta": {
                "added": [
                  "v4.5.0"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`size` {Number} ",
                      "name": "size",
                      "type": "Number"
                    },
                    {
                      "textRaw": "`fill` {Value} Default: `undefined` ",
                      "name": "fill",
                      "type": "Value",
                      "desc": "Default: `undefined`",
                      "optional": true
                    },
                    {
                      "textRaw": "`encoding` {String} Default: `utf8` ",
                      "name": "encoding",
                      "type": "String",
                      "desc": "Default: `utf8`",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "size"
                    },
                    {
                      "name": "fill",
                      "optional": true
                    },
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Allocates a new Buffer of size bytes. If fill is undefined, the\nBuffer will be zero-filled.
\n
const buf = Buffer.alloc(5);\nconsole.log(buf);\n  // <Buffer 00 00 00 00 00>\n
\n
The size must be less than or equal to the value of\nrequire('buffer').kMaxLength (on 64-bit architectures, kMaxLength is\n(2^31)-1). Otherwise, a RangeError is thrown. If a size less than 0\nis specified, a zero-length Buffer will be created.
\n
If fill is specified, the allocated Buffer will be initialized by calling\nbuf.fill(fill). See [buf.fill()][] for more information.
\n
const buf = Buffer.alloc(5, 'a');\nconsole.log(buf);\n  // <Buffer 61 61 61 61 61>\n
\n
If both fill and encoding are specified, the allocated Buffer will be\ninitialized by calling buf.fill(fill, encoding). For example:
\n
const buf = Buffer.alloc(11, 'aGVsbG8gd29ybGQ=', 'base64');\nconsole.log(buf);\n  // <Buffer 68 65 6c 6c 6f 20 77 6f 72 6c 64>\n
\n
Calling Buffer.alloc(size) can be significantly slower than the alternative\nBuffer.allocUnsafe(size) but ensures that the newly created Buffer instance\ncontents will never contain sensitive data.
\n
A TypeError will be thrown if size is not a number.
\n"
            },
            {
              "textRaw": "Class Method: Buffer.allocUnsafe(size)",
              "type": "classMethod",
              "name": "allocUnsafe",
              "meta": {
                "added": [
                  "v4.5.0"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`size` {Number} ",
                      "name": "size",
                      "type": "Number"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "size"
                    }
                  ]
                }
              ],
              "desc": "
Allocates a new non-zero-filled Buffer of size bytes.  The size must\nbe less than or equal to the value of require('buffer').kMaxLength (on 64-bit\narchitectures, kMaxLength is (2^31)-1). Otherwise, a RangeError is\nthrown. If a size less than 0 is specified, a zero-length Buffer will be\ncreated.
\n
The underlying memory for Buffer instances created in this way is not\ninitialized. The contents of the newly created Buffer are unknown and\nmay contain sensitive data. Use buf.fill(0) to initialize such\nBuffer instances to zeroes.
\n
const buf = Buffer.allocUnsafe(5);\nconsole.log(buf);\n  // <Buffer 78 e0 82 02 01>\n  // (octets will be different, every time)\nbuf.fill(0);\nconsole.log(buf);\n  // <Buffer 00 00 00 00 00>\n
\n
A TypeError will be thrown if size is not a number.
\n
Note that the Buffer module pre-allocates an internal Buffer instance of\nsize Buffer.poolSize that is used as a pool for the fast allocation of new\nBuffer instances created using Buffer.allocUnsafe(size) (and the\nnew Buffer(size) constructor) only when size is less than or equal to\nBuffer.poolSize >> 1 (floor of Buffer.poolSize divided by two). The default\nvalue of Buffer.poolSize is 8192 but can be modified.
\n
Use of this pre-allocated internal memory pool is a key difference between\ncalling Buffer.alloc(size, fill) vs. Buffer.allocUnsafe(size).fill(fill).\nSpecifically, Buffer.alloc(size, fill) will never use the internal Buffer\npool, while Buffer.allocUnsafe(size).fill(fill) will use the internal\nBuffer pool if size is less than or equal to half Buffer.poolSize. The\ndifference is subtle but can be important when an application requires the\nadditional performance that Buffer.allocUnsafe(size) provides.
\n"
            },
            {
              "textRaw": "Class Method: Buffer.allocUnsafeSlow(size)",
              "type": "classMethod",
              "name": "allocUnsafeSlow",
              "meta": {
                "added": [
                  "v4.5.0"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`size` {Number} ",
                      "name": "size",
                      "type": "Number"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "size"
                    }
                  ]
                }
              ],
              "desc": "
Allocates a new non-zero-filled and non-pooled Buffer of size bytes.  The\nsize must be less than or equal to the value of\nrequire('buffer').kMaxLength (on 64-bit architectures, kMaxLength is\n(2^31)-1). Otherwise, a RangeError is thrown. If a size less than 0\nis specified, a zero-length Buffer will be created.
\n
The underlying memory for Buffer instances created in this way is not\ninitialized. The contents of the newly created Buffer are unknown and\nmay contain sensitive data. Use buf.fill(0) to initialize such\nBuffer instances to zeroes.
\n
When using Buffer.allocUnsafe() to allocate new Buffer instances,\nallocations under 4KB are, by default, sliced from a single pre-allocated\nBuffer. This allows applications to avoid the garbage collection overhead of\ncreating many individually allocated Buffers. This approach improves both\nperformance and memory usage by eliminating the need to track and cleanup as\nmany Persistent objects.
\n
However, in the case where a developer may need to retain a small chunk of\nmemory from a pool for an indeterminate amount of time, it may be appropriate\nto create an un-pooled Buffer instance using Buffer.allocUnsafeSlow() then\ncopy out the relevant bits.
\n
// need to keep around a few small chunks of memory\nconst store = [];\n\nsocket.on('readable', () => {\n  const data = socket.read();\n  // allocate for retained data\n  const sb = Buffer.allocUnsafeSlow(10);\n  // copy the data into the new allocation\n  data.copy(sb, 0, 0, 10);\n  store.push(sb);\n});\n
\n
Use of Buffer.allocUnsafeSlow() should be used only as a last resort after\na developer has observed undue memory retention in their applications.
\n
A TypeError will be thrown if size is not a number.
\n"
            },
            {
              "textRaw": "Class Method: Buffer.byteLength(string[, encoding])",
              "type": "classMethod",
              "name": "byteLength",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`string` {String} ",
                      "name": "string",
                      "type": "String"
                    },
                    {
                      "textRaw": "`encoding` {String} Default: `'utf8'` ",
                      "name": "encoding",
                      "type": "String",
                      "desc": "Default: `'utf8'`",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "string"
                    },
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Returns the actual byte length of a string. This is not the same as\nString.prototype.length since that returns the number of characters in\na string.
\n
Note that for 'base64' and 'hex', this function assumes valid input. For\nstrings that contain non-Base64/Hex-encoded data (e.g. whitespace), the return\nvalue might be greater than the length of a Buffer created from the string.
\n
Example:
\n
const str = '\\u00bd + \\u00bc = \\u00be';\n\nconsole.log(`${str}: ${str.length} characters, ` +\n            `${Buffer.byteLength(str, 'utf8')} bytes`);\n\n// ½ + ¼ = ¾: 9 characters, 12 bytes\n
\n"
            },
            {
              "textRaw": "Class Method: Buffer.compare(buf1, buf2)",
              "type": "classMethod",
              "name": "compare",
              "meta": {
                "added": [
                  "v0.11.13"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`buf1` {Buffer} ",
                      "name": "buf1",
                      "type": "Buffer"
                    },
                    {
                      "textRaw": "`buf2` {Buffer} ",
                      "name": "buf2",
                      "type": "Buffer"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "buf1"
                    },
                    {
                      "name": "buf2"
                    }
                  ]
                }
              ],
              "desc": "
Compares buf1 to buf2 typically for the purpose of sorting arrays of\nBuffers. This is equivalent is calling buf1.compare(buf2).
\n
const arr = [Buffer('1234'), Buffer('0123')];\narr.sort(Buffer.compare);\n
\n"
            },
            {
              "textRaw": "Class Method: Buffer.concat(list[, totalLength])",
              "type": "classMethod",
              "name": "concat",
              "meta": {
                "added": [
                  "v0.7.11"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Buffer} ",
                    "name": "return",
                    "type": "Buffer"
                  },
                  "params": [
                    {
                      "textRaw": "`list` {Array} List of Buffer objects to concat ",
                      "name": "list",
                      "type": "Array",
                      "desc": "List of Buffer objects to concat"
                    },
                    {
                      "textRaw": "`totalLength` {Number} Total length of the Buffers in the list when concatenated ",
                      "name": "totalLength",
                      "type": "Number",
                      "desc": "Total length of the Buffers in the list when concatenated",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "list"
                    },
                    {
                      "name": "totalLength",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Returns a new Buffer which is the result of concatenating all the Buffers in\nthe list together.
\n
If the list has no items, or if the totalLength is 0, then a new zero-length\nBuffer is returned.
\n
If totalLength is not provided, it is calculated from the Buffers in the\nlist. This, however, adds an additional loop to the function, so it is faster\nto provide the length explicitly.
\n
Example: build a single Buffer from a list of three Buffers:
\n
const buf1 = new Buffer(10).fill(0);\nconst buf2 = new Buffer(14).fill(0);\nconst buf3 = new Buffer(18).fill(0);\nconst totalLength = buf1.length + buf2.length + buf3.length;\n\nconsole.log(totalLength);\nconst bufA = Buffer.concat([buf1, buf2, buf3], totalLength);\nconsole.log(bufA);\nconsole.log(bufA.length);\n\n// 42\n// <Buffer 00 00 00 00 ...>\n// 42\n
\n"
            },
            {
              "textRaw": "Class Method: Buffer.from(array)",
              "type": "classMethod",
              "name": "from",
              "meta": {
                "added": [
                  "v4.5.0"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`array` {Array} ",
                      "name": "array",
                      "type": "Array"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "array"
                    }
                  ]
                }
              ],
              "desc": "
Allocates a new Buffer using an array of octets.
\n
const buf = Buffer.from([0x62,0x75,0x66,0x66,0x65,0x72]);\n  // creates a new Buffer containing ASCII bytes\n  // ['b','u','f','f','e','r']\n
\n
A TypeError will be thrown if array is not an Array.
\n"
            },
            {
              "textRaw": "Class Method: Buffer.from(arrayBuffer)",
              "type": "classMethod",
              "name": "from",
              "meta": {
                "added": [
                  "v4.5.0"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`arrayBuffer` {ArrayBuffer} The `.buffer` property of a `TypedArray` or a `new ArrayBuffer()` ",
                      "name": "arrayBuffer",
                      "type": "ArrayBuffer",
                      "desc": "The `.buffer` property of a `TypedArray` or a `new ArrayBuffer()`"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "arrayBuffer"
                    }
                  ]
                }
              ],
              "desc": "
When passed a reference to the .buffer property of a TypedArray instance,\nthe newly created Buffer will share the same allocated memory as the\nTypedArray.
\n
const arr = new Uint16Array(2);\narr[0] = 5000;\narr[1] = 4000;\n\nconst buf = Buffer.from(arr.buffer); // shares the memory with arr;\n\nconsole.log(buf);\n  // Prints: <Buffer 88 13 a0 0f>\n\n// changing the TypedArray changes the Buffer also\narr[1] = 6000;\n\nconsole.log(buf);\n  // Prints: <Buffer 88 13 70 17>\n
\n
A TypeError will be thrown if arrayBuffer is not an ArrayBuffer.
\n"
            },
            {
              "textRaw": "Class Method: Buffer.from(buffer)",
              "type": "classMethod",
              "name": "from",
              "meta": {
                "added": [
                  "v4.5.0"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`buffer` {Buffer} ",
                      "name": "buffer",
                      "type": "Buffer"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "buffer"
                    }
                  ]
                }
              ],
              "desc": "
Copies the passed buffer data onto a new Buffer instance.
\n
const buf1 = Buffer.from('buffer');\nconst buf2 = Buffer.from(buf1);\n\nbuf1[0] = 0x61;\nconsole.log(buf1.toString());\n  // 'auffer'\nconsole.log(buf2.toString());\n  // 'buffer' (copy is not changed)\n
\n
A TypeError will be thrown if buffer is not a Buffer.
\n"
            },
            {
              "textRaw": "Class Method: Buffer.from(str[, encoding])",
              "type": "classMethod",
              "name": "from",
              "meta": {
                "added": [
                  "v4.5.0"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`str` {String} String to encode. ",
                      "name": "str",
                      "type": "String",
                      "desc": "String to encode."
                    },
                    {
                      "textRaw": "`encoding` {String} Encoding to use, Default: `'utf8'` ",
                      "name": "encoding",
                      "type": "String",
                      "desc": "Encoding to use, Default: `'utf8'`",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "str"
                    },
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Creates a new Buffer containing the given JavaScript string str. If\nprovided, the encoding parameter identifies the character encoding.\nIf not provided, encoding defaults to 'utf8'.
\n
const buf1 = Buffer.from('this is a tést');\nconsole.log(buf1.toString());\n  // prints: this is a tést\nconsole.log(buf1.toString('ascii'));\n  // prints: this is a tC)st\n\nconst buf2 = Buffer.from('7468697320697320612074c3a97374', 'hex');\nconsole.log(buf2.toString());\n  // prints: this is a tést\n
\n
A TypeError will be thrown if str is not a string.
\n"
            },
            {
              "textRaw": "Class Method: Buffer.isBuffer(obj)",
              "type": "classMethod",
              "name": "isBuffer",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Boolean} ",
                    "name": "return",
                    "type": "Boolean"
                  },
                  "params": [
                    {
                      "textRaw": "`obj` {Object} ",
                      "name": "obj",
                      "type": "Object"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "obj"
                    }
                  ]
                }
              ],
              "desc": "
Returns 'true' if obj is a Buffer.
\n"
            },
            {
              "textRaw": "Class Method: Buffer.isEncoding(encoding)",
              "type": "classMethod",
              "name": "isEncoding",
              "meta": {
                "added": [
                  "v0.9.1"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Boolean} ",
                    "name": "return",
                    "type": "Boolean"
                  },
                  "params": [
                    {
                      "textRaw": "`encoding` {String} The encoding string to test ",
                      "name": "encoding",
                      "type": "String",
                      "desc": "The encoding string to test"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "encoding"
                    }
                  ]
                }
              ],
              "desc": "
Returns true if the encoding is a valid encoding argument, or false\notherwise.
\n"
            }
          ],
          "properties": [
            {
              "textRaw": "buf[index]",
              "name": "[index]",
              "meta": {
                "type": "property",
                "name": [
                  "index"
                ]
              },
              "desc": "
The index operator [index] can be used to get and set the octet at position\nindex in the Buffer. The values refer to individual bytes, so the legal value\nrange is between 0x00 and 0xFF (hex) or 0 and 255 (decimal).
\n
Example: copy an ASCII string into a Buffer, one byte at a time:
\n
const str = "Node.js";\nconst buf = new Buffer(str.length);\n\nfor (var i = 0; i < str.length ; i++) {\n  buf[i] = str.charCodeAt(i);\n}\n\nconsole.log(buf.toString('ascii'));\n  // Prints: Node.js\n
\n"
            },
            {
              "textRaw": "`length` {Number} ",
              "type": "Number",
              "name": "length",
              "desc": "
Returns the amount of memory allocated for the Buffer in number of bytes. Note\nthat this does not necessarily reflect the amount of usable data within the\nBuffer. For instance, in the example below, a Buffer with 1234 bytes is\nallocated, but only 11 ASCII bytes are written.
\n
const buf = new Buffer(1234);\n\nconsole.log(buf.length);\n  // Prints: 1234\n\nbuf.write('some string', 0, 'ascii');\nconsole.log(buf.length);\n  // Prints: 1234\n
\n
While the length property is not immutable, changing the value of length\ncan result in undefined and inconsistent behavior. Applications that wish to\nmodify the length of a Buffer should therefore treat length as read-only and\nuse buf.slice() to create a new Buffer.
\n
var buf = new Buffer(10);\nbuf.write('abcdefghj', 0, 'ascii');\nconsole.log(buf.length);\n  // Prints: 10\nbuf = buf.slice(0,5);\nconsole.log(buf.length);\n  // Prints: 5\n
\n"
            }
          ],
          "methods": [
            {
              "textRaw": "buf.compare(otherBuffer)",
              "type": "method",
              "name": "compare",
              "meta": {
                "added": [
                  "v0.11.13"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`otherBuffer` {Buffer} ",
                      "name": "otherBuffer",
                      "type": "Buffer"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "otherBuffer"
                    }
                  ]
                }
              ],
              "desc": "
Compares two Buffer instances and returns a number indicating whether buf\ncomes before, after, or is the same as the otherBuffer in sort order.\nComparison is based on the actual sequence of bytes in each Buffer.
\n
    \n
  • 0 is returned if otherBuffer is the same as buf
    • \n
  • 1 is returned if otherBuffer should come before buf when sorted.
    • \n
  • -1 is returned if otherBuffer should come after buf when sorted.
    • \n
\n
const buf1 = new Buffer('ABC');\nconst buf2 = new Buffer('BCD');\nconst buf3 = new Buffer('ABCD');\n\nconsole.log(buf1.compare(buf1));\n  // Prints: 0\nconsole.log(buf1.compare(buf2));\n  // Prints: -1\nconsole.log(buf1.compare(buf3));\n  // Prints: -1\nconsole.log(buf2.compare(buf1));\n  // Prints: 1\nconsole.log(buf2.compare(buf3));\n  // Prints: 1\n\n[buf1, buf2, buf3].sort(Buffer.compare);\n  // produces sort order [buf1, buf3, buf2]\n
\n"
            },
            {
              "textRaw": "buf.copy(targetBuffer[, targetStart[, sourceStart[, sourceEnd]]])",
              "type": "method",
              "name": "copy",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The number of bytes copied. ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The number of bytes copied."
                  },
                  "params": [
                    {
                      "textRaw": "`targetBuffer` {Buffer} Buffer to copy into ",
                      "name": "targetBuffer",
                      "type": "Buffer",
                      "desc": "Buffer to copy into"
                    },
                    {
                      "textRaw": "`targetStart` {Number} Default: 0 ",
                      "name": "targetStart",
                      "type": "Number",
                      "desc": "Default: 0",
                      "optional": true
                    },
                    {
                      "textRaw": "`sourceStart` {Number} Default: 0 ",
                      "name": "sourceStart",
                      "type": "Number",
                      "desc": "Default: 0",
                      "optional": true
                    },
                    {
                      "textRaw": "`sourceEnd` {Number} Default: `buffer.length` ",
                      "name": "sourceEnd",
                      "type": "Number",
                      "desc": "Default: `buffer.length`",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "targetBuffer"
                    },
                    {
                      "name": "targetStart",
                      "optional": true
                    },
                    {
                      "name": "sourceStart",
                      "optional": true
                    },
                    {
                      "name": "sourceEnd",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Copies data from a region of this Buffer to a region in the target Buffer even\nif the target memory region overlaps with the source.
\n
Example: build two Buffers, then copy buf1 from byte 16 through byte 19\ninto buf2, starting at the 8th byte in buf2.
\n
const buf1 = new Buffer(26);\nconst buf2 = new Buffer(26).fill('!');\n\nfor (var i = 0 ; i < 26 ; i++) {\n  buf1[i] = i + 97; // 97 is ASCII a\n}\n\nbuf1.copy(buf2, 8, 16, 20);\nconsole.log(buf2.toString('ascii', 0, 25));\n  // Prints: !!!!!!!!qrst!!!!!!!!!!!!!\n
\n
Example: Build a single Buffer, then copy data from one region to an overlapping\nregion in the same Buffer
\n
const buf = new Buffer(26);\n\nfor (var i = 0 ; i < 26 ; i++) {\n  buf[i] = i + 97; // 97 is ASCII a\n}\n\nbuf.copy(buf, 0, 4, 10);\nconsole.log(buf.toString());\n\n// efghijghijklmnopqrstuvwxyz\n
\n"
            },
            {
              "textRaw": "buf.entries()",
              "type": "method",
              "name": "entries",
              "meta": {
                "added": [
                  "v1.1.0"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Iterator} ",
                    "name": "return",
                    "type": "Iterator"
                  },
                  "params": []
                },
                {
                  "params": []
                }
              ],
              "desc": "
Creates and returns an iterator of [index, byte] pairs from the Buffer\ncontents.
\n
const buf = new Buffer('buffer');\nfor (var pair of buf.entries()) {\n  console.log(pair);\n}\n// prints:\n//   [0, 98]\n//   [1, 117]\n//   [2, 102]\n//   [3, 102]\n//   [4, 101]\n//   [5, 114]\n
\n"
            },
            {
              "textRaw": "buf.equals(otherBuffer)",
              "type": "method",
              "name": "equals",
              "meta": {
                "added": [
                  "v1.0.0"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Boolean} ",
                    "name": "return",
                    "type": "Boolean"
                  },
                  "params": [
                    {
                      "textRaw": "`otherBuffer` {Buffer} ",
                      "name": "otherBuffer",
                      "type": "Buffer"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "otherBuffer"
                    }
                  ]
                }
              ],
              "desc": "
Returns a boolean indicating whether this and otherBuffer have exactly the\nsame bytes.
\n
const buf1 = new Buffer('ABC');\nconst buf2 = new Buffer('414243', 'hex');\nconst buf3 = new Buffer('ABCD');\n\nconsole.log(buf1.equals(buf2));\n  // Prints: true\nconsole.log(buf1.equals(buf3));\n  // Prints: false\n
\n"
            },
            {
              "textRaw": "buf.fill(value[, offset[, end]])",
              "type": "method",
              "name": "fill",
              "meta": {
                "added": [
                  "v0.5.0"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Buffer} ",
                    "name": "return",
                    "type": "Buffer"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {String|Number} ",
                      "name": "value",
                      "type": "String|Number"
                    },
                    {
                      "textRaw": "`offset` {Number} Default: 0 ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "Default: 0",
                      "optional": true
                    },
                    {
                      "textRaw": "`end` {Number} Default: `buffer.length` ",
                      "name": "end",
                      "type": "Number",
                      "desc": "Default: `buffer.length`",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset",
                      "optional": true
                    },
                    {
                      "name": "end",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Fills the Buffer with the specified value. If the offset and end are not\ngiven it will fill the entire Buffer. The method returns a reference to the\nBuffer so calls can be chained.
\n
const b = new Buffer(50).fill('h');\nconsole.log(b.toString());\n  // Prints: hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh\n
\n"
            },
            {
              "textRaw": "buf.indexOf(value[, byteOffset][, encoding])",
              "type": "method",
              "name": "indexOf",
              "meta": {
                "added": [
                  "v1.5.0"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {String|Buffer|Number} ",
                      "name": "value",
                      "type": "String|Buffer|Number"
                    },
                    {
                      "textRaw": "`byteOffset` {Number} Default: 0 ",
                      "name": "byteOffset",
                      "type": "Number",
                      "desc": "Default: 0",
                      "optional": true
                    },
                    {
                      "textRaw": "`encoding` {String} Default: `'utf8'` ",
                      "name": "encoding",
                      "type": "String",
                      "desc": "Default: `'utf8'`",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "byteOffset",
                      "optional": true
                    },
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Operates similar to Array#indexOf() in that it returns either the\nstarting index position of value in Buffer or -1 if the Buffer does not\ncontain value. The value can be a String, Buffer or Number. Strings are by\ndefault interpreted as UTF8. Buffers will use the entire Buffer (to compare a\npartial Buffer use buf.slice()). Numbers will be interpreted as unsigned 8-bit\ninteger values between 0 and 255.
\n
const buf = new Buffer('this is a buffer');\n\nbuf.indexOf('this');\n  // returns 0\nbuf.indexOf('is');\n  // returns 2\nbuf.indexOf(new Buffer('a buffer'));\n  // returns 8\nbuf.indexOf(97); // ascii for 'a'\n  // returns 8\nbuf.indexOf(new Buffer('a buffer example'));\n  // returns -1\nbuf.indexOf(new Buffer('a buffer example').slice(0,8));\n  // returns 8\n\nconst utf16Buffer = new Buffer('\\u039a\\u0391\\u03a3\\u03a3\\u0395', 'ucs2');\n\nutf16Buffer.indexOf('\\u03a3',  0, 'ucs2');\n  // returns 4\nutf16Buffer.indexOf('\\u03a3', -4, 'ucs2');\n  // returns 6\n
\n"
            },
            {
              "textRaw": "buf.keys()",
              "type": "method",
              "name": "keys",
              "meta": {
                "added": [
                  "v1.1.0"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Iterator} ",
                    "name": "return",
                    "type": "Iterator"
                  },
                  "params": []
                },
                {
                  "params": []
                }
              ],
              "desc": "
Creates and returns an iterator of Buffer keys (indices).
\n
const buf = new Buffer('buffer');\nfor (var key of buf.keys()) {\n  console.log(key);\n}\n// prints:\n//   0\n//   1\n//   2\n//   3\n//   4\n//   5\n
\n"
            },
            {
              "textRaw": "buf.readDoubleBE(offset[, noAssert])",
              "type": "method",
              "name": "readDoubleBE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 8` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 8`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Reads a 64-bit double from the Buffer at the specified offset with specified\nendian format (readDoubleBE() returns big endian, readDoubleLE() returns\nlittle endian).
\n
Setting noAssert to true skips validation of the offset. This allows the\noffset to be beyond the end of the Buffer.
\n
const buf = new Buffer([1,2,3,4,5,6,7,8]);\n\nbuf.readDoubleBE();\n  // Returns: 8.20788039913184e-304\nbuf.readDoubleLE();\n  // Returns: 5.447603722011605e-270\nbuf.readDoubleLE(1);\n  // throws RangeError: Index out of range\n\nbuf.readDoubleLE(1, true); // Warning: reads passed end of buffer!\n  // Segmentation fault! don't do this!\n
\n"
            },
            {
              "textRaw": "buf.readDoubleLE(offset[, noAssert])",
              "type": "method",
              "name": "readDoubleLE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 8` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 8`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Reads a 64-bit double from the Buffer at the specified offset with specified\nendian format (readDoubleBE() returns big endian, readDoubleLE() returns\nlittle endian).
\n
Setting noAssert to true skips validation of the offset. This allows the\noffset to be beyond the end of the Buffer.
\n
const buf = new Buffer([1,2,3,4,5,6,7,8]);\n\nbuf.readDoubleBE();\n  // Returns: 8.20788039913184e-304\nbuf.readDoubleLE();\n  // Returns: 5.447603722011605e-270\nbuf.readDoubleLE(1);\n  // throws RangeError: Index out of range\n\nbuf.readDoubleLE(1, true); // Warning: reads passed end of buffer!\n  // Segmentation fault! don't do this!\n
\n"
            },
            {
              "textRaw": "buf.readFloatBE(offset[, noAssert])",
              "type": "method",
              "name": "readFloatBE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 4` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 4`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Reads a 32-bit float from the Buffer at the specified offset with specified\nendian format (readFloatBE() returns big endian, readFloatLE() returns\nlittle endian).
\n
Setting noAssert to true skips validation of the offset. This allows the\noffset to be beyond the end of the Buffer.
\n
const buf = new Buffer([1,2,3,4]);\n\nbuf.readFloatBE();\n  // Returns: 2.387939260590663e-38\nbuf.readFloatLE();\n  // Returns: 1.539989614439558e-36\nbuf.readFloatLE(1);\n  // throws RangeError: Index out of range\n\nbuf.readFloatLE(1, true); // Warning: reads passed end of buffer!\n  // Segmentation fault! don't do this!\n
\n"
            },
            {
              "textRaw": "buf.readFloatLE(offset[, noAssert])",
              "type": "method",
              "name": "readFloatLE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 4` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 4`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Reads a 32-bit float from the Buffer at the specified offset with specified\nendian format (readFloatBE() returns big endian, readFloatLE() returns\nlittle endian).
\n
Setting noAssert to true skips validation of the offset. This allows the\noffset to be beyond the end of the Buffer.
\n
const buf = new Buffer([1,2,3,4]);\n\nbuf.readFloatBE();\n  // Returns: 2.387939260590663e-38\nbuf.readFloatLE();\n  // Returns: 1.539989614439558e-36\nbuf.readFloatLE(1);\n  // throws RangeError: Index out of range\n\nbuf.readFloatLE(1, true); // Warning: reads passed end of buffer!\n  // Segmentation fault! don't do this!\n
\n"
            },
            {
              "textRaw": "buf.readInt8(offset[, noAssert])",
              "type": "method",
              "name": "readInt8",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 1` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 1`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Reads a signed 8-bit integer from the Buffer at the specified offset.
\n
Setting noAssert to true skips validation of the offset. This allows the\noffset to be beyond the end of the Buffer.
\n
Integers read from the Buffer are interpreted as two's complement signed values.
\n
const buf = new Buffer([1,-2,3,4]);\n\nbuf.readInt8(0);\n  // returns 1\nbuf.readInt8(1);\n  // returns -2\n
\n"
            },
            {
              "textRaw": "buf.readInt16BE(offset[, noAssert])",
              "type": "method",
              "name": "readInt16BE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 2` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 2`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Reads a signed 16-bit integer from the Buffer at the specified offset with\nthe specified endian format (readInt16BE() returns big endian,\nreadInt16LE() returns little endian).
\n
Setting noAssert to true skips validation of the offset. This allows the\noffset to be beyond the end of the Buffer.
\n
Integers read from the Buffer are interpreted as two's complement signed values.
\n
const buf = new Buffer([1,-2,3,4]);\n\nbuf.readInt16BE();\n  // returns 510\nbuf.readInt16LE(1);\n  // returns 1022\n
\n"
            },
            {
              "textRaw": "buf.readInt16LE(offset[, noAssert])",
              "type": "method",
              "name": "readInt16LE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 2` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 2`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Reads a signed 16-bit integer from the Buffer at the specified offset with\nthe specified endian format (readInt16BE() returns big endian,\nreadInt16LE() returns little endian).
\n
Setting noAssert to true skips validation of the offset. This allows the\noffset to be beyond the end of the Buffer.
\n
Integers read from the Buffer are interpreted as two's complement signed values.
\n
const buf = new Buffer([1,-2,3,4]);\n\nbuf.readInt16BE();\n  // returns 510\nbuf.readInt16LE(1);\n  // returns 1022\n
\n"
            },
            {
              "textRaw": "buf.readInt32BE(offset[, noAssert])",
              "type": "method",
              "name": "readInt32BE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 4` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 4`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Reads a signed 32-bit integer from the Buffer at the specified offset with\nthe specified endian format (readInt32BE() returns big endian,\nreadInt32LE() returns little endian).
\n
Setting noAssert to true skips validation of the offset. This allows the\noffset to be beyond the end of the Buffer.
\n
Integers read from the Buffer are interpreted as two's complement signed values.
\n
const buf = new Buffer([1,-2,3,4]);\n\nbuf.readInt32BE();\n  // returns 33424132\nbuf.readInt32LE();\n  // returns 67370497\nbuf.readInt32LE(1);\n  // throws RangeError: Index out of range\n
\n"
            },
            {
              "textRaw": "buf.readInt32LE(offset[, noAssert])",
              "type": "method",
              "name": "readInt32LE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 4` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 4`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Reads a signed 32-bit integer from the Buffer at the specified offset with\nthe specified endian format (readInt32BE() returns big endian,\nreadInt32LE() returns little endian).
\n
Setting noAssert to true skips validation of the offset. This allows the\noffset to be beyond the end of the Buffer.
\n
Integers read from the Buffer are interpreted as two's complement signed values.
\n
const buf = new Buffer([1,-2,3,4]);\n\nbuf.readInt32BE();\n  // returns 33424132\nbuf.readInt32LE();\n  // returns 67370497\nbuf.readInt32LE(1);\n  // throws RangeError: Index out of range\n
\n"
            },
            {
              "textRaw": "buf.readIntBE(offset, byteLength[, noAssert])",
              "type": "method",
              "name": "readIntBE",
              "meta": {
                "added": [
                  "v1.0.0"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - byteLength` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - byteLength`"
                    },
                    {
                      "textRaw": "`byteLength` {Number} `0 < byteLength <= 6` ",
                      "name": "byteLength",
                      "type": "Number",
                      "desc": "`0 < byteLength <= 6`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "byteLength"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "byteLength"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Reads byteLength number of bytes from the Buffer at the specified offset\nand interprets the result as a two's complement signed value. Supports up to 48\nbits of accuracy. For example:
\n
const buf = new Buffer(6);\nbuf.writeUInt16LE(0x90ab, 0);\nbuf.writeUInt32LE(0x12345678, 2);\nbuf.readIntLE(0, 6).toString(16);  // Specify 6 bytes (48 bits)\n// Returns: '1234567890ab'\n\nbuf.readIntBE(0, 6).toString(16);\n// Returns: -546f87a9cbee\n
\n
Setting noAssert to true skips validation of the offset. This allows the\noffset to be beyond the end of the Buffer.
\n"
            },
            {
              "textRaw": "buf.readIntLE(offset, byteLength[, noAssert])",
              "type": "method",
              "name": "readIntLE",
              "meta": {
                "added": [
                  "v1.0.0"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - byteLength` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - byteLength`"
                    },
                    {
                      "textRaw": "`byteLength` {Number} `0 < byteLength <= 6` ",
                      "name": "byteLength",
                      "type": "Number",
                      "desc": "`0 < byteLength <= 6`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "byteLength"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Reads byteLength number of bytes from the Buffer at the specified offset\nand interprets the result as a two's complement signed value. Supports up to 48\nbits of accuracy. For example:
\n
const buf = new Buffer(6);\nbuf.writeUInt16LE(0x90ab, 0);\nbuf.writeUInt32LE(0x12345678, 2);\nbuf.readIntLE(0, 6).toString(16);  // Specify 6 bytes (48 bits)\n// Returns: '1234567890ab'\n\nbuf.readIntBE(0, 6).toString(16);\n// Returns: -546f87a9cbee\n
\n
Setting noAssert to true skips validation of the offset. This allows the\noffset to be beyond the end of the Buffer.
\n"
            },
            {
              "textRaw": "buf.readUInt8(offset[, noAssert])",
              "type": "method",
              "name": "readUInt8",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 1` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 1`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Reads an unsigned 8-bit integer from the Buffer at the specified offset.
\n
Setting noAssert to true skips validation of the offset. This allows the\noffset to be beyond the end of the Buffer.
\n
const buf = new Buffer([1,-2,3,4]);\n\nbuf.readUInt8(0);\n  // returns 1\nbuf.readUInt8(1);\n  // returns 254\n
\n"
            },
            {
              "textRaw": "buf.readUInt16BE(offset[, noAssert])",
              "type": "method",
              "name": "readUInt16BE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 2` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 2`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Reads an unsigned 16-bit integer from the Buffer at the specified offset with\nspecified endian format (readUInt16BE() returns big endian,\nreadUInt16LE() returns little endian).
\n
Setting noAssert to true skips validation of the offset. This allows the\noffset to be beyond the end of the Buffer.
\n
Example:
\n
const buf = new Buffer([0x3, 0x4, 0x23, 0x42]);\n\nbuf.readUInt16BE(0);\n  // Returns: 0x0304\nbuf.readUInt16LE(0);\n  // Returns: 0x0403\nbuf.readUInt16BE(1);\n  // Returns: 0x0423\nbuf.readUInt16LE(1);\n  // Returns: 0x2304\nbuf.readUInt16BE(2);\n  // Returns: 0x2342\nbuf.readUInt16LE(2);\n  // Returns: 0x4223\n
\n"
            },
            {
              "textRaw": "buf.readUInt16LE(offset[, noAssert])",
              "type": "method",
              "name": "readUInt16LE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 2` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 2`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Reads an unsigned 16-bit integer from the Buffer at the specified offset with\nspecified endian format (readUInt16BE() returns big endian,\nreadUInt16LE() returns little endian).
\n
Setting noAssert to true skips validation of the offset. This allows the\noffset to be beyond the end of the Buffer.
\n
Example:
\n
const buf = new Buffer([0x3, 0x4, 0x23, 0x42]);\n\nbuf.readUInt16BE(0);\n  // Returns: 0x0304\nbuf.readUInt16LE(0);\n  // Returns: 0x0403\nbuf.readUInt16BE(1);\n  // Returns: 0x0423\nbuf.readUInt16LE(1);\n  // Returns: 0x2304\nbuf.readUInt16BE(2);\n  // Returns: 0x2342\nbuf.readUInt16LE(2);\n  // Returns: 0x4223\n
\n"
            },
            {
              "textRaw": "buf.readUInt32BE(offset[, noAssert])",
              "type": "method",
              "name": "readUInt32BE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 4` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 4`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Reads an unsigned 32-bit integer from the Buffer at the specified offset with\nspecified endian format (readUInt32BE() returns big endian,\nreadUInt32LE() returns little endian).
\n
Setting noAssert to true skips validation of the offset. This allows the\noffset to be beyond the end of the Buffer.
\n
Example:
\n
const buf = new Buffer([0x3, 0x4, 0x23, 0x42]);\n\nbuf.readUInt32BE(0);\n  // Returns: 0x03042342\nconsole.log(buf.readUInt32LE(0));\n  // Returns: 0x42230403\n
\n"
            },
            {
              "textRaw": "buf.readUInt32LE(offset[, noAssert])",
              "type": "method",
              "name": "readUInt32LE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 4` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 4`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Reads an unsigned 32-bit integer from the Buffer at the specified offset with\nspecified endian format (readUInt32BE() returns big endian,\nreadUInt32LE() returns little endian).
\n
Setting noAssert to true skips validation of the offset. This allows the\noffset to be beyond the end of the Buffer.
\n
Example:
\n
const buf = new Buffer([0x3, 0x4, 0x23, 0x42]);\n\nbuf.readUInt32BE(0);\n  // Returns: 0x03042342\nconsole.log(buf.readUInt32LE(0));\n  // Returns: 0x42230403\n
\n"
            },
            {
              "textRaw": "buf.readUIntBE(offset, byteLength[, noAssert])",
              "type": "method",
              "name": "readUIntBE",
              "meta": {
                "added": [
                  "v1.0.0"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - byteLength` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - byteLength`"
                    },
                    {
                      "textRaw": "`byteLength` {Number} `0 < byteLength <= 6` ",
                      "name": "byteLength",
                      "type": "Number",
                      "desc": "`0 < byteLength <= 6`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "byteLength"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "byteLength"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Reads byteLength number of bytes from the Buffer at the specified offset\nand interprets the result as an unsigned integer. Supports up to 48\nbits of accuracy. For example:
\n
const buf = new Buffer(6);\nbuf.writeUInt16LE(0x90ab, 0);\nbuf.writeUInt32LE(0x12345678, 2);\nbuf.readUIntLE(0, 6).toString(16);  // Specify 6 bytes (48 bits)\n// Returns: '1234567890ab'\n\nbuf.readUIntBE(0, 6).toString(16);\n// Returns: ab9078563412\n
\n
Setting noAssert to true skips validation of the offset. This allows the\noffset to be beyond the end of the Buffer.
\n"
            },
            {
              "textRaw": "buf.readUIntLE(offset, byteLength[, noAssert])",
              "type": "method",
              "name": "readUIntLE",
              "meta": {
                "added": [
                  "v1.0.0"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} ",
                    "name": "return",
                    "type": "Number"
                  },
                  "params": [
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - byteLength` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - byteLength`"
                    },
                    {
                      "textRaw": "`byteLength` {Number} `0 < byteLength <= 6` ",
                      "name": "byteLength",
                      "type": "Number",
                      "desc": "`0 < byteLength <= 6`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "offset"
                    },
                    {
                      "name": "byteLength"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Reads byteLength number of bytes from the Buffer at the specified offset\nand interprets the result as an unsigned integer. Supports up to 48\nbits of accuracy. For example:
\n
const buf = new Buffer(6);\nbuf.writeUInt16LE(0x90ab, 0);\nbuf.writeUInt32LE(0x12345678, 2);\nbuf.readUIntLE(0, 6).toString(16);  // Specify 6 bytes (48 bits)\n// Returns: '1234567890ab'\n\nbuf.readUIntBE(0, 6).toString(16);\n// Returns: ab9078563412\n
\n
Setting noAssert to true skips validation of the offset. This allows the\noffset to be beyond the end of the Buffer.
\n"
            },
            {
              "textRaw": "buf.slice([start[, end]])",
              "type": "method",
              "name": "slice",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Buffer} ",
                    "name": "return",
                    "type": "Buffer"
                  },
                  "params": [
                    {
                      "textRaw": "`start` {Number} Default: 0 ",
                      "name": "start",
                      "type": "Number",
                      "desc": "Default: 0",
                      "optional": true
                    },
                    {
                      "textRaw": "`end` {Number} Default: `buffer.length` ",
                      "name": "end",
                      "type": "Number",
                      "desc": "Default: `buffer.length`",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "start",
                      "optional": true
                    },
                    {
                      "name": "end",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Returns a new Buffer that references the same memory as the original, but\noffset and cropped by the start and end indices.
\n
Note that modifying the new Buffer slice will modify the memory in the\noriginal Buffer because the allocated memory of the two objects overlap.
\n
Example: build a Buffer with the ASCII alphabet, take a slice, then modify one\nbyte from the original Buffer.
\n
const buf1 = new Buffer(26);\n\nfor (var i = 0 ; i < 26 ; i++) {\n  buf1[i] = i + 97; // 97 is ASCII a\n}\n\nconst buf2 = buf1.slice(0, 3);\nbuf2.toString('ascii', 0, buf2.length);\n  // Returns: 'abc'\nbuf1[0] = 33;\nbuf2.toString('ascii', 0, buf2.length);\n  // Returns : '!bc'\n
\n
Specifying negative indexes causes the slice to be generated relative to the\nend of the Buffer rather than the beginning.
\n
const buf = new Buffer('buffer');\n\nbuf.slice(-6, -1).toString();\n  // Returns 'buffe', equivalent to buf.slice(0, 5)\nbuf.slice(-6, -2).toString();\n  // Returns 'buff', equivalent to buf.slice(0, 4)\nbuf.slice(-5, -2).toString();\n  // Returns 'uff', equivalent to buf.slice(1, 4)\n
\n"
            },
            {
              "textRaw": "buf.toString([encoding[, start[, end]]])",
              "type": "method",
              "name": "toString",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {String} ",
                    "name": "return",
                    "type": "String"
                  },
                  "params": [
                    {
                      "textRaw": "`encoding` {String} Default: `'utf8'` ",
                      "name": "encoding",
                      "type": "String",
                      "desc": "Default: `'utf8'`",
                      "optional": true
                    },
                    {
                      "textRaw": "`start` {Number} Default: 0 ",
                      "name": "start",
                      "type": "Number",
                      "desc": "Default: 0",
                      "optional": true
                    },
                    {
                      "textRaw": "`end` {Number} Default: `buffer.length` ",
                      "name": "end",
                      "type": "Number",
                      "desc": "Default: `buffer.length`",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "encoding",
                      "optional": true
                    },
                    {
                      "name": "start",
                      "optional": true
                    },
                    {
                      "name": "end",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Decodes and returns a string from the Buffer data using the specified\ncharacter set encoding.
\n
const buf = new Buffer(26);\nfor (var i = 0 ; i < 26 ; i++) {\n  buf[i] = i + 97; // 97 is ASCII a\n}\nbuf.toString('ascii');\n  // Returns: 'abcdefghijklmnopqrstuvwxyz'\nbuf.toString('ascii',0,5);\n  // Returns: 'abcde'\nbuf.toString('utf8',0,5);\n  // Returns: 'abcde'\nbuf.toString(undefined,0,5);\n  // Returns: 'abcde', encoding defaults to 'utf8'\n
\n"
            },
            {
              "textRaw": "buf.toJSON()",
              "type": "method",
              "name": "toJSON",
              "meta": {
                "added": [
                  "v0.9.2"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Object} ",
                    "name": "return",
                    "type": "Object"
                  },
                  "params": []
                },
                {
                  "params": []
                }
              ],
              "desc": "
Returns a JSON representation of the Buffer instance.  JSON.stringify()\nimplicitly calls this function when stringifying a Buffer instance.
\n
Example:
\n
const buf = new Buffer('test');\nconst json = JSON.stringify(buf);\n\nconsole.log(json);\n// Prints: '{"type":"Buffer","data":[116,101,115,116]}'\n\nconst copy = JSON.parse(json, (key, value) => {\n    return value && value.type === 'Buffer'\n      ? new Buffer(value.data)\n      : value;\n  });\n\nconsole.log(copy.toString());\n// Prints: 'test'\n
\n"
            },
            {
              "textRaw": "buf.values()",
              "type": "method",
              "name": "values",
              "meta": {
                "added": [
                  "v1.1.0"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Iterator} ",
                    "name": "return",
                    "type": "Iterator"
                  },
                  "params": []
                },
                {
                  "params": []
                }
              ],
              "desc": "
Creates and returns an iterator for Buffer values (bytes). This function is\ncalled automatically when the Buffer is used in a for..of statement.
\n
const buf = new Buffer('buffer');\nfor (var value of buf.values()) {\n  console.log(value);\n}\n// prints:\n//   98\n//   117\n//   102\n//   102\n//   101\n//   114\n\nfor (var value of buf) {\n  console.log(value);\n}\n// prints:\n//   98\n//   117\n//   102\n//   102\n//   101\n//   114\n
\n"
            },
            {
              "textRaw": "buf.write(string[, offset[, length]][, encoding])",
              "type": "method",
              "name": "write",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} Numbers of bytes written ",
                    "name": "return",
                    "type": "Number",
                    "desc": "Numbers of bytes written"
                  },
                  "params": [
                    {
                      "textRaw": "`string` {String} Bytes to be written to buffer ",
                      "name": "string",
                      "type": "String",
                      "desc": "Bytes to be written to buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} Default: 0 ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "Default: 0",
                      "optional": true
                    },
                    {
                      "textRaw": "`length` {Number} Default: `buffer.length - offset` ",
                      "name": "length",
                      "type": "Number",
                      "desc": "Default: `buffer.length - offset`",
                      "optional": true
                    },
                    {
                      "textRaw": "`encoding` {String} Default: `'utf8'` ",
                      "name": "encoding",
                      "type": "String",
                      "desc": "Default: `'utf8'`",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "string"
                    },
                    {
                      "name": "offset",
                      "optional": true
                    },
                    {
                      "name": "length",
                      "optional": true
                    },
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes string to the Buffer at offset using the given encoding.\nThe length parameter is the number of bytes to write. If the Buffer did not\ncontain enough space to fit the entire string, only a partial amount of the\nstring will be written however, it will not write only partially encoded\ncharacters.
\n
const buf = new Buffer(256);\nconst len = buf.write('\\u00bd + \\u00bc = \\u00be', 0);\nconsole.log(`${len} bytes: ${buf.toString('utf8', 0, len)}`);\n  // Prints: 12 bytes: ½ + ¼ = ¾\n
\n"
            },
            {
              "textRaw": "buf.writeDoubleBE(value, offset[, noAssert])",
              "type": "method",
              "name": "writeDoubleBE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The offset plus the number of written bytes ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The offset plus the number of written bytes"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {Number} Bytes to be written to Buffer ",
                      "name": "value",
                      "type": "Number",
                      "desc": "Bytes to be written to Buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 8` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 8`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes value to the Buffer at the specified offset with specified endian\nformat (writeDoubleBE() writes big endian, writeDoubleLE() writes little\nendian). The value argument should be a valid 64-bit double. Behavior is\nnot defined when value is anything other than a 64-bit double.
\n
Set noAssert to true to skip validation of value and offset. This means\nthat value may be too large for the specific function and offset may be\nbeyond the end of the Buffer leading to the values being silently dropped. This\nshould not be used unless you are certain of correctness.
\n
Example:
\n
const buf = new Buffer(8);\nbuf.writeDoubleBE(0xdeadbeefcafebabe, 0);\n\nconsole.log(buf);\n  // Prints: <Buffer 43 eb d5 b7 dd f9 5f d7>\n\nbuf.writeDoubleLE(0xdeadbeefcafebabe, 0);\n\nconsole.log(buf);\n  // Prints: <Buffer d7 5f f9 dd b7 d5 eb 43>\n
\n"
            },
            {
              "textRaw": "buf.writeDoubleLE(value, offset[, noAssert])",
              "type": "method",
              "name": "writeDoubleLE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The offset plus the number of written bytes ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The offset plus the number of written bytes"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {Number} Bytes to be written to Buffer ",
                      "name": "value",
                      "type": "Number",
                      "desc": "Bytes to be written to Buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 8` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 8`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes value to the Buffer at the specified offset with specified endian\nformat (writeDoubleBE() writes big endian, writeDoubleLE() writes little\nendian). The value argument should be a valid 64-bit double. Behavior is\nnot defined when value is anything other than a 64-bit double.
\n
Set noAssert to true to skip validation of value and offset. This means\nthat value may be too large for the specific function and offset may be\nbeyond the end of the Buffer leading to the values being silently dropped. This\nshould not be used unless you are certain of correctness.
\n
Example:
\n
const buf = new Buffer(8);\nbuf.writeDoubleBE(0xdeadbeefcafebabe, 0);\n\nconsole.log(buf);\n  // Prints: <Buffer 43 eb d5 b7 dd f9 5f d7>\n\nbuf.writeDoubleLE(0xdeadbeefcafebabe, 0);\n\nconsole.log(buf);\n  // Prints: <Buffer d7 5f f9 dd b7 d5 eb 43>\n
\n"
            },
            {
              "textRaw": "buf.writeFloatBE(value, offset[, noAssert])",
              "type": "method",
              "name": "writeFloatBE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The offset plus the number of written bytes ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The offset plus the number of written bytes"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {Number} Bytes to be written to Buffer ",
                      "name": "value",
                      "type": "Number",
                      "desc": "Bytes to be written to Buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 4` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 4`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes value to the Buffer at the specified offset with specified endian\nformat (writeFloatBE() writes big endian, writeFloatLE() writes little\nendian). Behavior is not defined when value is anything other than a 32-bit\nfloat.
\n
Set noAssert to true to skip validation of value and offset. This means\nthat value may be too large for the specific function and offset may be\nbeyond the end of the Buffer leading to the values being silently dropped. This\nshould not be used unless you are certain of correctness.
\n
Example:
\n
const buf = new Buffer(4);\nbuf.writeFloatBE(0xcafebabe, 0);\n\nconsole.log(buf);\n  // Prints: <Buffer 4f 4a fe bb>\n\nbuf.writeFloatLE(0xcafebabe, 0);\n\nconsole.log(buf);\n  // Prints: <Buffer bb fe 4a 4f>\n
\n"
            },
            {
              "textRaw": "buf.writeFloatLE(value, offset[, noAssert])",
              "type": "method",
              "name": "writeFloatLE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The offset plus the number of written bytes ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The offset plus the number of written bytes"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {Number} Bytes to be written to Buffer ",
                      "name": "value",
                      "type": "Number",
                      "desc": "Bytes to be written to Buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 4` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 4`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes value to the Buffer at the specified offset with specified endian\nformat (writeFloatBE() writes big endian, writeFloatLE() writes little\nendian). Behavior is not defined when value is anything other than a 32-bit\nfloat.
\n
Set noAssert to true to skip validation of value and offset. This means\nthat value may be too large for the specific function and offset may be\nbeyond the end of the Buffer leading to the values being silently dropped. This\nshould not be used unless you are certain of correctness.
\n
Example:
\n
const buf = new Buffer(4);\nbuf.writeFloatBE(0xcafebabe, 0);\n\nconsole.log(buf);\n  // Prints: <Buffer 4f 4a fe bb>\n\nbuf.writeFloatLE(0xcafebabe, 0);\n\nconsole.log(buf);\n  // Prints: <Buffer bb fe 4a 4f>\n
\n"
            },
            {
              "textRaw": "buf.writeInt8(value, offset[, noAssert])",
              "type": "method",
              "name": "writeInt8",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The offset plus the number of written bytes ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The offset plus the number of written bytes"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {Number} Bytes to be written to Buffer ",
                      "name": "value",
                      "type": "Number",
                      "desc": "Bytes to be written to Buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 1` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 1`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes value to the Buffer at the specified offset. The value should be a\nvalid signed 8-bit integer.  Behavior is not defined when value is anything\nother than a signed 8-bit integer.
\n
Set noAssert to true to skip validation of value and offset. This means\nthat value may be too large for the specific function and offset may be\nbeyond the end of the Buffer leading to the values being silently dropped. This\nshould not be used unless you are certain of correctness.
\n
The value is interpreted and written as a two's complement signed integer.
\n
const buf = new Buffer(2);\nbuf.writeInt8(2, 0);\nbuf.writeInt8(-2, 1);\nconsole.log(buf);\n  // Prints: <Buffer 02 fe>\n
\n"
            },
            {
              "textRaw": "buf.writeInt16BE(value, offset[, noAssert])",
              "type": "method",
              "name": "writeInt16BE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The offset plus the number of written bytes ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The offset plus the number of written bytes"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {Number} Bytes to be written to Buffer ",
                      "name": "value",
                      "type": "Number",
                      "desc": "Bytes to be written to Buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 2` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 2`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes value to the Buffer at the specified offset with specified endian\nformat (writeInt16BE() writes big endian, writeInt16LE() writes little\nendian). The value should be a valid signed 16-bit integer. Behavior is\nnot defined when value is anything other than a signed 16-bit integer.
\n
Set noAssert to true to skip validation of value and offset. This means\nthat value may be too large for the specific function and offset may be\nbeyond the end of the Buffer leading to the values being silently dropped. This\nshould not be used unless you are certain of correctness.
\n
The value is interpreted and written as a two's complement signed integer.
\n
const buf = new Buffer(4);\nbuf.writeInt16BE(0x0102,0);\nbuf.writeInt16LE(0x0304,2);\nconsole.log(buf);\n  // Prints: <Buffer 01 02 04 03>\n
\n"
            },
            {
              "textRaw": "buf.writeInt16LE(value, offset[, noAssert])",
              "type": "method",
              "name": "writeInt16LE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The offset plus the number of written bytes ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The offset plus the number of written bytes"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {Number} Bytes to be written to Buffer ",
                      "name": "value",
                      "type": "Number",
                      "desc": "Bytes to be written to Buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 2` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 2`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes value to the Buffer at the specified offset with specified endian\nformat (writeInt16BE() writes big endian, writeInt16LE() writes little\nendian). The value should be a valid signed 16-bit integer. Behavior is\nnot defined when value is anything other than a signed 16-bit integer.
\n
Set noAssert to true to skip validation of value and offset. This means\nthat value may be too large for the specific function and offset may be\nbeyond the end of the Buffer leading to the values being silently dropped. This\nshould not be used unless you are certain of correctness.
\n
The value is interpreted and written as a two's complement signed integer.
\n
const buf = new Buffer(4);\nbuf.writeInt16BE(0x0102,0);\nbuf.writeInt16LE(0x0304,2);\nconsole.log(buf);\n  // Prints: <Buffer 01 02 04 03>\n
\n"
            },
            {
              "textRaw": "buf.writeInt32BE(value, offset[, noAssert])",
              "type": "method",
              "name": "writeInt32BE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The offset plus the number of written bytes ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The offset plus the number of written bytes"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {Number} Bytes to be written to Buffer ",
                      "name": "value",
                      "type": "Number",
                      "desc": "Bytes to be written to Buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 4` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 4`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes value to the Buffer at the specified offset with specified endian\nformat (writeInt32BE() writes big endian, writeInt32LE() writes little\nendian). The value should be a valid signed 32-bit integer. Behavior is\nnot defined when value is anything other than a signed 32-bit integer.
\n
Set noAssert to true to skip validation of value and offset. This means\nthat value may be too large for the specific function and offset may be\nbeyond the end of the Buffer leading to the values being silently dropped. This\nshould not be used unless you are certain of correctness.
\n
The value is interpreted and written as a two's complement signed integer.
\n
const buf = new Buffer(8);\nbuf.writeInt32BE(0x01020304,0);\nbuf.writeInt32LE(0x05060708,4);\nconsole.log(buf);\n  // Prints: <Buffer 01 02 03 04 08 07 06 05>\n
\n"
            },
            {
              "textRaw": "buf.writeInt32LE(value, offset[, noAssert])",
              "type": "method",
              "name": "writeInt32LE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The offset plus the number of written bytes ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The offset plus the number of written bytes"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {Number} Bytes to be written to Buffer ",
                      "name": "value",
                      "type": "Number",
                      "desc": "Bytes to be written to Buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 4` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 4`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes value to the Buffer at the specified offset with specified endian\nformat (writeInt32BE() writes big endian, writeInt32LE() writes little\nendian). The value should be a valid signed 32-bit integer. Behavior is\nnot defined when value is anything other than a signed 32-bit integer.
\n
Set noAssert to true to skip validation of value and offset. This means\nthat value may be too large for the specific function and offset may be\nbeyond the end of the Buffer leading to the values being silently dropped. This\nshould not be used unless you are certain of correctness.
\n
The value is interpreted and written as a two's complement signed integer.
\n
const buf = new Buffer(8);\nbuf.writeInt32BE(0x01020304,0);\nbuf.writeInt32LE(0x05060708,4);\nconsole.log(buf);\n  // Prints: <Buffer 01 02 03 04 08 07 06 05>\n
\n"
            },
            {
              "textRaw": "buf.writeIntBE(value, offset, byteLength[, noAssert])",
              "type": "method",
              "name": "writeIntBE",
              "meta": {
                "added": [
                  "v1.0.0"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The offset plus the number of written bytes ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The offset plus the number of written bytes"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {Number} Bytes to be written to Buffer ",
                      "name": "value",
                      "type": "Number",
                      "desc": "Bytes to be written to Buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - byteLength` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - byteLength`"
                    },
                    {
                      "textRaw": "`byteLength` {Number} `0 < byteLength <= 6` ",
                      "name": "byteLength",
                      "type": "Number",
                      "desc": "`0 < byteLength <= 6`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "byteLength"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "byteLength"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes value to the Buffer at the specified offset and byteLength.\nSupports up to 48 bits of accuracy. For example:
\n
const buf1 = new Buffer(6);\nbuf1.writeUIntBE(0x1234567890ab, 0, 6);\nconsole.log(buf1);\n  // Prints: <Buffer 12 34 56 78 90 ab>\n\nconst buf2 = new Buffer(6);\nbuf2.writeUIntLE(0x1234567890ab, 0, 6);\nconsole.log(buf2);\n  // Prints: <Buffer ab 90 78 56 34 12>\n
\n
Set noAssert to true to skip validation of value and offset. This means\nthat value may be too large for the specific function and offset may be\nbeyond the end of the Buffer leading to the values being silently dropped. This\nshould not be used unless you are certain of correctness.
\n
Behavior is not defined when value is anything other than an integer.
\n"
            },
            {
              "textRaw": "buf.writeIntLE(value, offset, byteLength[, noAssert])",
              "type": "method",
              "name": "writeIntLE",
              "meta": {
                "added": [
                  "v1.0.0"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The offset plus the number of written bytes ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The offset plus the number of written bytes"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {Number} Bytes to be written to Buffer ",
                      "name": "value",
                      "type": "Number",
                      "desc": "Bytes to be written to Buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - byteLength` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - byteLength`"
                    },
                    {
                      "textRaw": "`byteLength` {Number} `0 < byteLength <= 6` ",
                      "name": "byteLength",
                      "type": "Number",
                      "desc": "`0 < byteLength <= 6`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "byteLength"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes value to the Buffer at the specified offset and byteLength.\nSupports up to 48 bits of accuracy. For example:
\n
const buf1 = new Buffer(6);\nbuf1.writeUIntBE(0x1234567890ab, 0, 6);\nconsole.log(buf1);\n  // Prints: <Buffer 12 34 56 78 90 ab>\n\nconst buf2 = new Buffer(6);\nbuf2.writeUIntLE(0x1234567890ab, 0, 6);\nconsole.log(buf2);\n  // Prints: <Buffer ab 90 78 56 34 12>\n
\n
Set noAssert to true to skip validation of value and offset. This means\nthat value may be too large for the specific function and offset may be\nbeyond the end of the Buffer leading to the values being silently dropped. This\nshould not be used unless you are certain of correctness.
\n
Behavior is not defined when value is anything other than an integer.
\n"
            },
            {
              "textRaw": "buf.writeUInt8(value, offset[, noAssert])",
              "type": "method",
              "name": "writeUInt8",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The offset plus the number of written bytes ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The offset plus the number of written bytes"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {Number} Bytes to be written to Buffer ",
                      "name": "value",
                      "type": "Number",
                      "desc": "Bytes to be written to Buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 1` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 1`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes value to the Buffer at the specified offset. The value should be a\nvalid unsigned 8-bit integer.  Behavior is not defined when value is anything\nother than an unsigned 8-bit integer.
\n
Set noAssert to true to skip validation of value and offset. This means\nthat value may be too large for the specific function and offset may be\nbeyond the end of the Buffer leading to the values being silently dropped. This\nshould not be used unless you are certain of correctness.
\n
Example:
\n
const buf = new Buffer(4);\nbuf.writeUInt8(0x3, 0);\nbuf.writeUInt8(0x4, 1);\nbuf.writeUInt8(0x23, 2);\nbuf.writeUInt8(0x42, 3);\n\nconsole.log(buf);\n  // Prints: <Buffer 03 04 23 42>\n
\n"
            },
            {
              "textRaw": "buf.writeUInt16BE(value, offset[, noAssert])",
              "type": "method",
              "name": "writeUInt16BE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The offset plus the number of written bytes ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The offset plus the number of written bytes"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {Number} Bytes to be written to Buffer ",
                      "name": "value",
                      "type": "Number",
                      "desc": "Bytes to be written to Buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 2` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 2`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes value to the Buffer at the specified offset with specified endian\nformat (writeUInt16BE() writes big endian, writeUInt16LE() writes little\nendian). The value should be a valid unsigned 16-bit integer. Behavior is\nnot defined when value is anything other than an unsigned 16-bit integer.
\n
Set noAssert to true to skip validation of value and offset. This means\nthat value may be too large for the specific function and offset may be\nbeyond the end of the Buffer leading to the values being silently dropped. This\nshould not be used unless you are certain of correctness.
\n
Example:
\n
const buf = new Buffer(4);\nbuf.writeUInt16BE(0xdead, 0);\nbuf.writeUInt16BE(0xbeef, 2);\n\nconsole.log(buf);\n  // Prints: <Buffer de ad be ef>\n\nbuf.writeUInt16LE(0xdead, 0);\nbuf.writeUInt16LE(0xbeef, 2);\n\nconsole.log(buf);\n  // Prints: <Buffer ad de ef be>\n
\n"
            },
            {
              "textRaw": "buf.writeUInt16LE(value, offset[, noAssert])",
              "type": "method",
              "name": "writeUInt16LE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The offset plus the number of written bytes ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The offset plus the number of written bytes"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {Number} Bytes to be written to Buffer ",
                      "name": "value",
                      "type": "Number",
                      "desc": "Bytes to be written to Buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 2` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 2`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes value to the Buffer at the specified offset with specified endian\nformat (writeUInt16BE() writes big endian, writeUInt16LE() writes little\nendian). The value should be a valid unsigned 16-bit integer. Behavior is\nnot defined when value is anything other than an unsigned 16-bit integer.
\n
Set noAssert to true to skip validation of value and offset. This means\nthat value may be too large for the specific function and offset may be\nbeyond the end of the Buffer leading to the values being silently dropped. This\nshould not be used unless you are certain of correctness.
\n
Example:
\n
const buf = new Buffer(4);\nbuf.writeUInt16BE(0xdead, 0);\nbuf.writeUInt16BE(0xbeef, 2);\n\nconsole.log(buf);\n  // Prints: <Buffer de ad be ef>\n\nbuf.writeUInt16LE(0xdead, 0);\nbuf.writeUInt16LE(0xbeef, 2);\n\nconsole.log(buf);\n  // Prints: <Buffer ad de ef be>\n
\n"
            },
            {
              "textRaw": "buf.writeUInt32BE(value, offset[, noAssert])",
              "type": "method",
              "name": "writeUInt32BE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The offset plus the number of written bytes ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The offset plus the number of written bytes"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {Number} Bytes to be written to Buffer ",
                      "name": "value",
                      "type": "Number",
                      "desc": "Bytes to be written to Buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 4` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 4`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes value to the Buffer at the specified offset with specified endian\nformat (writeUInt32BE() writes big endian, writeUInt32LE() writes little\nendian). The value should be a valid unsigned 32-bit integer. Behavior is\nnot defined when value is anything other than an unsigned 32-bit integer.
\n
Set noAssert to true to skip validation of value and offset. This means\nthat value may be too large for the specific function and offset may be\nbeyond the end of the Buffer leading to the values being silently dropped. This\nshould not be used unless you are certain of correctness.
\n
Example:
\n
const buf = new Buffer(4);\nbuf.writeUInt32BE(0xfeedface, 0);\n\nconsole.log(buf);\n  // Prints: <Buffer fe ed fa ce>\n\nbuf.writeUInt32LE(0xfeedface, 0);\n\nconsole.log(buf);\n  // Prints: <Buffer ce fa ed fe>\n
\n"
            },
            {
              "textRaw": "buf.writeUInt32LE(value, offset[, noAssert])",
              "type": "method",
              "name": "writeUInt32LE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The offset plus the number of written bytes ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The offset plus the number of written bytes"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {Number} Bytes to be written to Buffer ",
                      "name": "value",
                      "type": "Number",
                      "desc": "Bytes to be written to Buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - 4` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - 4`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes value to the Buffer at the specified offset with specified endian\nformat (writeUInt32BE() writes big endian, writeUInt32LE() writes little\nendian). The value should be a valid unsigned 32-bit integer. Behavior is\nnot defined when value is anything other than an unsigned 32-bit integer.
\n
Set noAssert to true to skip validation of value and offset. This means\nthat value may be too large for the specific function and offset may be\nbeyond the end of the Buffer leading to the values being silently dropped. This\nshould not be used unless you are certain of correctness.
\n
Example:
\n
const buf = new Buffer(4);\nbuf.writeUInt32BE(0xfeedface, 0);\n\nconsole.log(buf);\n  // Prints: <Buffer fe ed fa ce>\n\nbuf.writeUInt32LE(0xfeedface, 0);\n\nconsole.log(buf);\n  // Prints: <Buffer ce fa ed fe>\n
\n"
            },
            {
              "textRaw": "buf.writeUIntBE(value, offset, byteLength[, noAssert])",
              "type": "method",
              "name": "writeUIntBE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The offset plus the number of written bytes ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The offset plus the number of written bytes"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {Number} Bytes to be written to Buffer ",
                      "name": "value",
                      "type": "Number",
                      "desc": "Bytes to be written to Buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - byteLength` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - byteLength`"
                    },
                    {
                      "textRaw": "`byteLength` {Number} `0 < byteLength <= 6` ",
                      "name": "byteLength",
                      "type": "Number",
                      "desc": "`0 < byteLength <= 6`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "byteLength"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "byteLength"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes value to the Buffer at the specified offset and byteLength.\nSupports up to 48 bits of accuracy. For example:
\n
const buf = new Buffer(6);\nbuf.writeUIntBE(0x1234567890ab, 0, 6);\nconsole.log(buf);\n  // Prints: <Buffer 12 34 56 78 90 ab>\n
\n
Set noAssert to true to skip validation of value and offset. This means\nthat value may be too large for the specific function and offset may be\nbeyond the end of the Buffer leading to the values being silently dropped. This\nshould not be used unless you are certain of correctness.
\n
Behavior is not defined when value is anything other than an unsigned integer.
\n"
            },
            {
              "textRaw": "buf.writeUIntLE(value, offset, byteLength[, noAssert])",
              "type": "method",
              "name": "writeUIntLE",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Number} The offset plus the number of written bytes ",
                    "name": "return",
                    "type": "Number",
                    "desc": "The offset plus the number of written bytes"
                  },
                  "params": [
                    {
                      "textRaw": "`value` {Number} Bytes to be written to Buffer ",
                      "name": "value",
                      "type": "Number",
                      "desc": "Bytes to be written to Buffer"
                    },
                    {
                      "textRaw": "`offset` {Number} `0 <= offset <= buf.length - byteLength` ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "`0 <= offset <= buf.length - byteLength`"
                    },
                    {
                      "textRaw": "`byteLength` {Number} `0 < byteLength <= 6` ",
                      "name": "byteLength",
                      "type": "Number",
                      "desc": "`0 < byteLength <= 6`"
                    },
                    {
                      "textRaw": "`noAssert` {Boolean} Default: false ",
                      "name": "noAssert",
                      "type": "Boolean",
                      "desc": "Default: false",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "byteLength"
                    },
                    {
                      "name": "noAssert",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Writes value to the Buffer at the specified offset and byteLength.\nSupports up to 48 bits of accuracy. For example:
\n
const buf = new Buffer(6);\nbuf.writeUIntBE(0x1234567890ab, 0, 6);\nconsole.log(buf);\n  // Prints: <Buffer 12 34 56 78 90 ab>\n
\n
Set noAssert to true to skip validation of value and offset. This means\nthat value may be too large for the specific function and offset may be\nbeyond the end of the Buffer leading to the values being silently dropped. This\nshould not be used unless you are certain of correctness.
\n
Behavior is not defined when value is anything other than an unsigned integer.
\n"
            }
          ],
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`array` {Array} ",
                  "name": "array",
                  "type": "Array"
                }
              ],
              "desc": "
Allocates a new Buffer using an array of octets.
\n
const buf = new Buffer([0x62,0x75,0x66,0x66,0x65,0x72]);\n  // creates a new Buffer containing ASCII bytes\n  // ['b','u','f','f','e','r']\n
\n"
            },
            {
              "params": [
                {
                  "name": "array"
                }
              ],
              "desc": "
Allocates a new Buffer using an array of octets.
\n
const buf = new Buffer([0x62,0x75,0x66,0x66,0x65,0x72]);\n  // creates a new Buffer containing ASCII bytes\n  // ['b','u','f','f','e','r']\n
\n"
            },
            {
              "params": [
                {
                  "textRaw": "`buffer` {Buffer} ",
                  "name": "buffer",
                  "type": "Buffer"
                }
              ],
              "desc": "
Copies the passed buffer data onto a new Buffer instance.
\n
const buf1 = new Buffer('buffer');\nconst buf2 = new Buffer(buf1);\n\nbuf1[0] = 0x61;\nconsole.log(buf1.toString());\n  // 'auffer'\nconsole.log(buf2.toString());\n  // 'buffer' (copy is not changed)\n
\n"
            },
            {
              "params": [
                {
                  "name": "buffer"
                }
              ],
              "desc": "
Copies the passed buffer data onto a new Buffer instance.
\n
const buf1 = new Buffer('buffer');\nconst buf2 = new Buffer(buf1);\n\nbuf1[0] = 0x61;\nconsole.log(buf1.toString());\n  // 'auffer'\nconsole.log(buf2.toString());\n  // 'buffer' (copy is not changed)\n
\n"
            },
            {
              "params": [
                {
                  "textRaw": "`arrayBuffer` - The `.buffer` property of a `TypedArray` or a `new ArrayBuffer()` ",
                  "name": "arrayBuffer",
                  "desc": "The `.buffer` property of a `TypedArray` or a `new ArrayBuffer()`"
                }
              ],
              "desc": "
When passed a reference to the .buffer property of a TypedArray instance,\nthe newly created Buffer will share the same allocated memory as the\nTypedArray.
\n
const arr = new Uint16Array(2);\narr[0] = 5000;\narr[1] = 4000;\n\nconst buf = new Buffer(arr.buffer); // shares the memory with arr;\n\nconsole.log(buf);\n  // Prints: <Buffer 88 13 a0 0f>\n\n// changing the TypdArray changes the Buffer also\narr[1] = 6000;\n\nconsole.log(buf);\n  // Prints: <Buffer 88 13 70 17>\n
\n"
            },
            {
              "params": [
                {
                  "name": "arrayBuffer"
                }
              ],
              "desc": "
When passed a reference to the .buffer property of a TypedArray instance,\nthe newly created Buffer will share the same allocated memory as the\nTypedArray.
\n
const arr = new Uint16Array(2);\narr[0] = 5000;\narr[1] = 4000;\n\nconst buf = new Buffer(arr.buffer); // shares the memory with arr;\n\nconsole.log(buf);\n  // Prints: <Buffer 88 13 a0 0f>\n\n// changing the TypdArray changes the Buffer also\narr[1] = 6000;\n\nconsole.log(buf);\n  // Prints: <Buffer 88 13 70 17>\n
\n"
            },
            {
              "params": [
                {
                  "textRaw": "`size` {Number} ",
                  "name": "size",
                  "type": "Number"
                }
              ],
              "desc": "
Allocates a new Buffer of size bytes.  The size must be less than\nor equal to the value of require('buffer').kMaxLength (on 64-bit\narchitectures, kMaxLength is (2^31)-1). Otherwise, a RangeError is\nthrown. If a size less than 0 is specified, a zero-length Buffer will be\ncreated.
\n
Unlike ArrayBuffers, the underlying memory for Buffer instances created in\nthis way is not initialized. The contents of a newly created Buffer are\nunknown and could contain sensitive data. Use buf.fill(0) to initialize a\nBuffer to zeroes.
\n
const buf = new Buffer(5);\nconsole.log(buf);\n  // <Buffer 78 e0 82 02 01>\n  // (octets will be different, every time)\nbuf.fill(0);\nconsole.log(buf);\n  // <Buffer 00 00 00 00 00>\n
\n"
            },
            {
              "params": [
                {
                  "name": "size"
                }
              ],
              "desc": "
Allocates a new Buffer of size bytes.  The size must be less than\nor equal to the value of require('buffer').kMaxLength (on 64-bit\narchitectures, kMaxLength is (2^31)-1). Otherwise, a RangeError is\nthrown. If a size less than 0 is specified, a zero-length Buffer will be\ncreated.
\n
Unlike ArrayBuffers, the underlying memory for Buffer instances created in\nthis way is not initialized. The contents of a newly created Buffer are\nunknown and could contain sensitive data. Use buf.fill(0) to initialize a\nBuffer to zeroes.
\n
const buf = new Buffer(5);\nconsole.log(buf);\n  // <Buffer 78 e0 82 02 01>\n  // (octets will be different, every time)\nbuf.fill(0);\nconsole.log(buf);\n  // <Buffer 00 00 00 00 00>\n
\n"
            },
            {
              "params": [
                {
                  "textRaw": "`str` {String} String to encode. ",
                  "name": "str",
                  "type": "String",
                  "desc": "String to encode."
                },
                {
                  "textRaw": "`encoding` {String} Default: `'utf8'` ",
                  "name": "encoding",
                  "type": "String",
                  "desc": "Default: `'utf8'`",
                  "optional": true
                }
              ],
              "desc": "
Creates a new Buffer containing the given JavaScript string str. If\nprovided, the encoding parameter identifies the strings character encoding.
\n
const buf1 = new Buffer('this is a tést');\nconsole.log(buf1.toString());\n  // prints: this is a tést\nconsole.log(buf1.toString('ascii'));\n  // prints: this is a tC)st\n\nconst buf2 = new Buffer('7468697320697320612074c3a97374', 'hex');\nconsole.log(buf2.toString());\n  // prints: this is a tést\n
\n"
            },
            {
              "params": [
                {
                  "name": "str"
                },
                {
                  "name": "encoding",
                  "optional": true
                }
              ],
              "desc": "
Creates a new Buffer containing the given JavaScript string str. If\nprovided, the encoding parameter identifies the strings character encoding.
\n
const buf1 = new Buffer('this is a tést');\nconsole.log(buf1.toString());\n  // prints: this is a tést\nconsole.log(buf1.toString('ascii'));\n  // prints: this is a tC)st\n\nconst buf2 = new Buffer('7468697320697320612074c3a97374', 'hex');\nconsole.log(buf2.toString());\n  // prints: this is a tést\n
\n"
            }
          ]
        },
        {
          "textRaw": "Class: SlowBuffer",
          "type": "class",
          "name": "SlowBuffer",
          "desc": "
Returns an un-pooled Buffer.
\n
In order to avoid the garbage collection overhead of creating many individually\nallocated Buffers, by default allocations under 4KB are sliced from a single\nlarger allocated object. This approach improves both performance and memory\nusage since v8 does not need to track and cleanup as many Persistent objects.
\n
In the case where a developer may need to retain a small chunk of memory from a\npool for an indeterminate amount of time, it may be appropriate to create an\nun-pooled Buffer instance using SlowBuffer then copy out the relevant bits.
\n
// need to keep around a few small chunks of memory\nconst store = [];\n\nsocket.on('readable', () => {\n  var data = socket.read();\n  // allocate for retained data\n  var sb = new SlowBuffer(10);\n  // copy the data into the new allocation\n  data.copy(sb, 0, 0, 10);\n  store.push(sb);\n});\n
\n
Use of SlowBuffer should be used only as a last resort after a developer\nhas observed undue memory retention in their applications.
\n",
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`size` Number ",
                  "name": "size",
                  "desc": "Number"
                }
              ],
              "desc": "
Allocates a new SlowBuffer of size bytes.  The size must be less than\nor equal to the value of require('buffer').kMaxLength (on 64-bit\narchitectures, kMaxLength is (2^31)-1). Otherwise, a RangeError is\nthrown. If a size less than 0 is specified, a zero-length SlowBuffer will be\ncreated.
\n
The underlying memory for SlowBuffer instances is not initialized. The\ncontents of a newly created SlowBuffer are unknown and could contain\nsensitive data. Use buf.fill(0) to initialize a SlowBuffer to zeroes.
\n
const SlowBuffer = require('buffer').SlowBuffer;\nconst buf = new SlowBuffer(5);\nconsole.log(buf);\n  // <Buffer 78 e0 82 02 01>\n  // (octets will be different, every time)\nbuf.fill(0);\nconsole.log(buf);\n  // <Buffer 00 00 00 00 00>\n
\n"
            },
            {
              "params": [
                {
                  "name": "size"
                }
              ],
              "desc": "
Allocates a new SlowBuffer of size bytes.  The size must be less than\nor equal to the value of require('buffer').kMaxLength (on 64-bit\narchitectures, kMaxLength is (2^31)-1). Otherwise, a RangeError is\nthrown. If a size less than 0 is specified, a zero-length SlowBuffer will be\ncreated.
\n
The underlying memory for SlowBuffer instances is not initialized. The\ncontents of a newly created SlowBuffer are unknown and could contain\nsensitive data. Use buf.fill(0) to initialize a SlowBuffer to zeroes.
\n
const SlowBuffer = require('buffer').SlowBuffer;\nconst buf = new SlowBuffer(5);\nconsole.log(buf);\n  // <Buffer 78 e0 82 02 01>\n  // (octets will be different, every time)\nbuf.fill(0);\nconsole.log(buf);\n  // <Buffer 00 00 00 00 00>\n
\n"
            }
          ]
        }
      ],
      "properties": [
        {
          "textRaw": "`INSPECT_MAX_BYTES` {Number} Default: 50 ",
          "type": "Number",
          "name": "INSPECT_MAX_BYTES",
          "desc": "
Returns the maximum number of bytes that will be returned when\nbuffer.inspect() is called. This can be overridden by user modules. See\nutil.inspect() for more details on buffer.inspect() behavior.
\n
Note that this is a property on the buffer module as returned by\nrequire('buffer'), not on the Buffer global or a Buffer instance.
\n",
          "shortDesc": "Default: 50"
        }
      ],
      "type": "module",
      "displayName": "Buffer"
    }
  ]
}
node-v4.8.2/doc/api/buffer.md000644 000766 000024 00000154446 13070706735 016107 0ustar00iojsstaff000000 000000 # Buffer

> Stability: 2 - Stable

Prior to the introduction of `TypedArray` in ECMAScript 2015 (ES6), the
JavaScript language had no mechanism for reading or manipulating streams
of binary data. The `Buffer` class was introduced as part of the Node.js
API to make it possible to interact with octet streams in the context of things
like TCP streams and file system operations.

Now that `TypedArray` has been added in ES6, the `Buffer` class implements the
`Uint8Array` API in a manner that is more optimized and suitable for Node.js'
use cases.

Instances of the `Buffer` class are similar to arrays of integers but
correspond to fixed-sized, raw memory allocations outside the V8 heap.
The size of the `Buffer` is established when it is created and cannot be
resized.

The `Buffer` class is a global within Node.js, making it unlikely that one
would need to ever use `require('buffer').Buffer`.

```js
const buf1 = new Buffer(10);
  // creates a buffer of length 10
  // This is the same as Buffer.allocUnsafe(10), and the returned
  // Buffer instance might contain old data that needs to be
  // overwritten using either fill() or write().

const buf2 = new Buffer([1,2,3]);
  // creates a buffer containing [01, 02, 03]
  // This is the same as Buffer.from([1,2,3]).

const buf3 = new Buffer('test');
  // creates a buffer containing ASCII bytes [74, 65, 73, 74]
  // This is the same as Buffer.from('test').

const buf4 = new Buffer('tést', 'utf8');
  // creates a buffer containing UTF8 bytes [74, c3, a9, 73, 74]
  // This is the same as Buffer.from('tést', 'utf8').

const buf5 = Buffer.alloc(10);
  // Creates a zero-filled Buffer of length 10.

const buf6 = Buffer.alloc(10, 1);
  // Creates a Buffer of length 10, filled with 0x01.

const buf7 = Buffer.allocUnsafe(10);
  // Creates an uninitialized buffer of length 10.
  // This is faster than calling Buffer.alloc() but the returned
  // Buffer instance might contain old data that needs to be
  // overwritten using either fill() or write().

const buf8 = Buffer.from([1,2,3]);
  // Creates a Buffer containing [01, 02, 03].

const buf9 = Buffer.from('test');
  // Creates a Buffer containing ASCII bytes [74, 65, 73, 74].

const buf8 = Buffer.from('tést', 'utf8');
  // Creates a Buffer containing UTF8 bytes [74, c3, a9, 73, 74].
```

## `Buffer.from()`, `Buffer.alloc()`, and `Buffer.allocUnsafe()`

Historically, `Buffer` instances have been created using the `Buffer`
constructor function, which allocates the returned `Buffer`
differently based on what arguments are provided:

* Passing a number as the first argument to `Buffer()` (e.g. `new Buffer(10)`),
  allocates a new `Buffer` object of the specified size. The memory allocated
  for such `Buffer` instances is *not* initialized and *can contain sensitive
  data*. Such `Buffer` objects *must* be initialized *manually* by using either
  [`buf.fill(0)`][] or by writing to the `Buffer` completely. While this
  behavior is *intentional* to improve performance, development experience has
  demonstrated that a more explicit distinction is required between creating a
  fast-but-uninitialized `Buffer` versus creating a slower-but-safer `Buffer`.
* Passing a string, array, or `Buffer` as the first argument copies the
  passed object's data into the `Buffer`.
* Passing an `ArrayBuffer` returns a `Buffer` that shares allocated memory with
  the given `ArrayBuffer`.

Because the behavior of `new Buffer()` changes significantly based on the type
of value passed as the first argument, applications that do not properly
validate the input arguments passed to `new Buffer()`, or that fail to
appropriately initialize newly allocated `Buffer` content, can inadvertently
introduce security and reliability issues into their code.

To make the creation of `Buffer` objects more reliable and less error prone,
new `Buffer.from()`, `Buffer.alloc()`, and `Buffer.allocUnsafe()` methods have
been introduced as an alternative means of creating `Buffer` instances.

*Developers should migrate all existing uses of the `new Buffer()` constructors
to one of these new APIs.*

* [`Buffer.from(array)`][buffer_from_array] returns a new `Buffer` containing
  a *copy* of the provided octets.
* [`Buffer.from(arrayBuffer)`][buffer_from_arraybuf] returns a new `Buffer`
  that *shares* the same allocated memory as the given `ArrayBuffer`.
* [`Buffer.from(buffer)`][buffer_from_buffer] returns a new `Buffer`
  containing a *copy* of the contents of the given `Buffer`.
* [`Buffer.from(str[, encoding])`][buffer_from_string] returns a new `Buffer`
  containing a *copy* of the provided string.
* [`Buffer.alloc(size[, fill[, encoding]])`][buffer_alloc] returns a "filled"
  `Buffer` instance of the specified size. This method can be significantly
  slower than [`Buffer.allocUnsafe(size)`][buffer_allocunsafe] but ensures
  that newly created `Buffer` instances never contain old and potentially
  sensitive data.
* [`Buffer.allocUnsafe(size)`][buffer_allocunsafe] and
  [`Buffer.allocUnsafeSlow(size)`][buffer_allocunsafeslow] each return a
  new `Buffer` of the specified `size` whose content *must* be initialized
  using either [`buf.fill(0)`][] or written to completely.

`Buffer` instances returned by `Buffer.allocUnsafe(size)` *may* be allocated
off a shared internal memory pool if `size` is less than or equal to half
`Buffer.poolSize`. Instances returned by `Buffer.allocUnsafeSlow(size)` *never*
use the shared internal memory pool.

### What makes `Buffer.allocUnsafe(size)` and `Buffer.allocUnsafeSlow(size)` "unsafe"?

When calling `Buffer.allocUnsafe()` (and `Buffer.allocUnsafeSlow()`), the
segment of allocated memory is *uninitialized* (it is not zeroed-out). While
this design makes the allocation of memory quite fast, the allocated segment of
memory might contain old data that is potentially sensitive. Using a `Buffer`
created by `Buffer.allocUnsafe()` without *completely* overwriting the memory
can allow this old data to be leaked when the `Buffer` memory is read.

While there are clear performance advantages to using `Buffer.allocUnsafe()`,
extra care *must* be taken in order to avoid introducing security
vulnerabilities into an application.

## Buffers and Character Encodings

Buffers are commonly used to represent sequences of encoded characters
such as UTF8, UCS2, Base64 or even Hex-encoded data. It is possible to
convert back and forth between Buffers and ordinary JavaScript string objects
by using an explicit encoding method.

```js
const buf = new Buffer('hello world', 'ascii');
console.log(buf.toString('hex'));
  // prints: 68656c6c6f20776f726c64
console.log(buf.toString('base64'));
  // prints: aGVsbG8gd29ybGQ=
```

The character encodings currently supported by Node.js include:

* `'ascii'` - for 7-bit ASCII data only.  This encoding method is very fast and
  will strip the high bit if set.

* `'utf8'` - Multibyte encoded Unicode characters. Many web pages and other
  document formats use UTF-8.

* `'utf16le'` - 2 or 4 bytes, little-endian encoded Unicode characters.
  Surrogate pairs (U+10000 to U+10FFFF) are supported.

* `'ucs2'` - Alias of `'utf16le'`.

* `'base64'` - Base64 string encoding. When creating a buffer from a string,
  this encoding will also correctly accept "URL and Filename Safe Alphabet" as
  specified in [RFC 4648, Section 5].

* `'binary'` - A way of encoding the buffer into a one-byte (`latin-1`)
  encoded string. The string `'latin-1'` is not supported. Instead, pass
  `'binary'` to use `'latin-1'` encoding.

* `'hex'` - Encode each byte as two hexadecimal characters.

## Buffers and TypedArray

Buffers are also `Uint8Array` TypedArray instances. However, there are subtle
incompatibilities with the TypedArray specification in ECMAScript 2015. For
instance, while `ArrayBuffer#slice()` creates a copy of the slice,
the implementation of [`Buffer#slice()`][`buf.slice()`] creates a view over the
existing Buffer without copying, making `Buffer#slice()` far more efficient.

It is also possible to create new TypedArray instances from a `Buffer` with the
following caveats:

1. The Buffer instances's memory is copied to the TypedArray, not shared.

2. The Buffer's memory is interpreted as an array of distinct elements, and not
as a byte array of the target type. That is,
`new Uint32Array(new Buffer([1,2,3,4]))` creates a 4-element `Uint32Array`
   with elements `[1,2,3,4]`, not a `Uint32Array` with a single element
   `[0x1020304]` or `[0x4030201]`.

It is possible to create a new Buffer that shares the same allocated memory as
a TypedArray instance by using the TypeArray objects `.buffer` property:

```js
const arr = new Uint16Array(2);
arr[0] = 5000;
arr[1] = 4000;

const buf1 = new Buffer(arr); // copies the buffer
const buf2 = new Buffer(arr.buffer); // shares the memory with arr;

console.log(buf1);
  // Prints: , copied buffer has only two elements
console.log(buf2);
  // Prints: 

arr[1] = 6000;
console.log(buf1);
  // Prints: 
console.log(buf2);
  // Prints: 
```

Note that when creating a Buffer using the TypeArray's `.buffer`, it is not
currently possible to use only a portion of the underlying `ArrayBuffer`. To
create a Buffer that uses only a part of the `ArrayBuffer`, use the
[`buf.slice()`][] function after the Buffer is created:

```js
const arr = new Uint16Array(20);
const buf = new Buffer(arr.buffer).slice(0, 16);
console.log(buf.length);
  // Prints: 16
```

The `Buffer.from()` and [`TypedArray.from()`][] (e.g.`Uint8Array.from()`) have
different signatures and implementations. Specifically, the TypedArray variants
accept a second argument that is a mapping function that is invoked on every
element of the typed array:

* `TypedArray.from(source[, mapFn[, thisArg]])`

The `Buffer.from()` method, however, does not support the use of a mapping
function:

* [`Buffer.from(array)`][buffer_from_array]
* [`Buffer.from(buffer)`][buffer_from_buffer]
* [`Buffer.from(arrayBuffer)`][buffer_from_arraybuf]
* [`Buffer.from(str[, encoding])`][buffer_from_string]

## Buffers and ES6 iteration

Buffers can be iterated over using the ECMAScript 2015 (ES6) `for..of` syntax:

```js
const buf = new Buffer([1, 2, 3]);

for (var b of buf)
  console.log(b)

// Prints:
//   1
//   2
//   3
```

Additionally, the [`buf.values()`][], [`buf.keys()`][], and
[`buf.entries()`][] methods can be used to create iterators.

## The `--zero-fill-buffers` command line option

Node.js can be started using the `--zero-fill-buffers` command line option to
force all newly allocated `Buffer` and `SlowBuffer` instances created using
either `new Buffer(size)` and `new SlowBuffer(size)` to be *automatically
zero-filled* upon creation. Use of this flag *changes the default behavior* of
these methods and *can have a significant impact* on performance. Use of the
`--zero-fill-buffers` option is recommended only when absolutely necessary to
enforce that newly allocated `Buffer` instances cannot contain potentially
sensitive data.

```
$ node --zero-fill-buffers
> Buffer(5);

```

## Class: Buffer

The Buffer class is a global type for dealing with binary data directly.
It can be constructed in a variety of ways.

### new Buffer(array)

* `array` {Array}

Allocates a new Buffer using an `array` of octets.

```js
const buf = new Buffer([0x62,0x75,0x66,0x66,0x65,0x72]);
  // creates a new Buffer containing ASCII bytes
  // ['b','u','f','f','e','r']
```

### new Buffer(buffer)

* `buffer` {Buffer}

Copies the passed `buffer` data onto a new `Buffer` instance.

```js
const buf1 = new Buffer('buffer');
const buf2 = new Buffer(buf1);

buf1[0] = 0x61;
console.log(buf1.toString());
  // 'auffer'
console.log(buf2.toString());
  // 'buffer' (copy is not changed)
```

### new Buffer(arrayBuffer)

* `arrayBuffer` - The `.buffer` property of a `TypedArray` or a `new
  ArrayBuffer()`

When passed a reference to the `.buffer` property of a `TypedArray` instance,
the newly created Buffer will share the same allocated memory as the
TypedArray.

```js
const arr = new Uint16Array(2);
arr[0] = 5000;
arr[1] = 4000;

const buf = new Buffer(arr.buffer); // shares the memory with arr;

console.log(buf);
  // Prints: 

// changing the TypdArray changes the Buffer also
arr[1] = 6000;

console.log(buf);
  // Prints: 
```

### new Buffer(size)

* `size` {Number}

Allocates a new Buffer of `size` bytes.  The `size` must be less than
or equal to the value of `require('buffer').kMaxLength` (on 64-bit
architectures, `kMaxLength` is `(2^31)-1`). Otherwise, a [`RangeError`][] is
thrown. If a `size` less than 0 is specified, a zero-length Buffer will be
created.

Unlike `ArrayBuffers`, the underlying memory for Buffer instances created in
this way is not initialized. The contents of a newly created `Buffer` are
unknown and could contain sensitive data. Use [`buf.fill(0)`][] to initialize a
Buffer to zeroes.

```js
const buf = new Buffer(5);
console.log(buf);
  // 
  // (octets will be different, every time)
buf.fill(0);
console.log(buf);
  // 
```

### new Buffer(str[, encoding])

* `str` {String} String to encode.
* `encoding` {String} Default: `'utf8'`

Creates a new Buffer containing the given JavaScript string `str`. If
provided, the `encoding` parameter identifies the strings character encoding.

```js
const buf1 = new Buffer('this is a tést');
console.log(buf1.toString());
  // prints: this is a tést
console.log(buf1.toString('ascii'));
  // prints: this is a tC)st

const buf2 = new Buffer('7468697320697320612074c3a97374', 'hex');
console.log(buf2.toString());
  // prints: this is a tést
```

### Class Method: Buffer.alloc(size[, fill[, encoding]])


* `size` {Number}
* `fill` {Value} Default: `undefined`
* `encoding` {String} Default: `utf8`

Allocates a new `Buffer` of `size` bytes. If `fill` is `undefined`, the
`Buffer` will be *zero-filled*.

```js
const buf = Buffer.alloc(5);
console.log(buf);
  // 
```

The `size` must be less than or equal to the value of
`require('buffer').kMaxLength` (on 64-bit architectures, `kMaxLength` is
`(2^31)-1`). Otherwise, a [`RangeError`][] is thrown. If a `size` less than 0
is specified, a zero-length `Buffer` will be created.

If `fill` is specified, the allocated `Buffer` will be initialized by calling
`buf.fill(fill)`. See [`buf.fill()`][] for more information.

```js
const buf = Buffer.alloc(5, 'a');
console.log(buf);
  // 
```

If both `fill` and `encoding` are specified, the allocated `Buffer` will be
initialized by calling `buf.fill(fill, encoding)`. For example:

```js
const buf = Buffer.alloc(11, 'aGVsbG8gd29ybGQ=', 'base64');
console.log(buf);
  // 
```

Calling `Buffer.alloc(size)` can be significantly slower than the alternative
`Buffer.allocUnsafe(size)` but ensures that the newly created `Buffer` instance
contents will *never contain sensitive data*.

A `TypeError` will be thrown if `size` is not a number.

### Class Method: Buffer.allocUnsafe(size)


* `size` {Number}

Allocates a new *non-zero-filled* `Buffer` of `size` bytes.  The `size` must
be less than or equal to the value of `require('buffer').kMaxLength` (on 64-bit
architectures, `kMaxLength` is `(2^31)-1`). Otherwise, a [`RangeError`][] is
thrown. If a `size` less than 0 is specified, a zero-length `Buffer` will be
created.

The underlying memory for `Buffer` instances created in this way is *not
initialized*. The contents of the newly created `Buffer` are unknown and
*may contain sensitive data*. Use [`buf.fill(0)`][] to initialize such
`Buffer` instances to zeroes.

```js
const buf = Buffer.allocUnsafe(5);
console.log(buf);
  // 
  // (octets will be different, every time)
buf.fill(0);
console.log(buf);
  // 
```

A `TypeError` will be thrown if `size` is not a number.

Note that the `Buffer` module pre-allocates an internal `Buffer` instance of
size `Buffer.poolSize` that is used as a pool for the fast allocation of new
`Buffer` instances created using `Buffer.allocUnsafe(size)` (and the
`new Buffer(size)` constructor) only when `size` is less than or equal to
`Buffer.poolSize >> 1` (floor of `Buffer.poolSize` divided by two). The default
value of `Buffer.poolSize` is `8192` but can be modified.

Use of this pre-allocated internal memory pool is a key difference between
calling `Buffer.alloc(size, fill)` vs. `Buffer.allocUnsafe(size).fill(fill)`.
Specifically, `Buffer.alloc(size, fill)` will *never* use the internal Buffer
pool, while `Buffer.allocUnsafe(size).fill(fill)` *will* use the internal
Buffer pool if `size` is less than or equal to half `Buffer.poolSize`. The
difference is subtle but can be important when an application requires the
additional performance that `Buffer.allocUnsafe(size)` provides.

### Class Method: Buffer.allocUnsafeSlow(size)


* `size` {Number}

Allocates a new *non-zero-filled* and non-pooled `Buffer` of `size` bytes.  The
`size` must be less than or equal to the value of
`require('buffer').kMaxLength` (on 64-bit architectures, `kMaxLength` is
`(2^31)-1`). Otherwise, a [`RangeError`][] is thrown. If a `size` less than 0
is specified, a zero-length `Buffer` will be created.

The underlying memory for `Buffer` instances created in this way is *not
initialized*. The contents of the newly created `Buffer` are unknown and
*may contain sensitive data*. Use [`buf.fill(0)`][] to initialize such
`Buffer` instances to zeroes.

When using `Buffer.allocUnsafe()` to allocate new `Buffer` instances,
allocations under 4KB are, by default, sliced from a single pre-allocated
`Buffer`. This allows applications to avoid the garbage collection overhead of
creating many individually allocated Buffers. This approach improves both
performance and memory usage by eliminating the need to track and cleanup as
many `Persistent` objects.

However, in the case where a developer may need to retain a small chunk of
memory from a pool for an indeterminate amount of time, it may be appropriate
to create an un-pooled Buffer instance using `Buffer.allocUnsafeSlow()` then
copy out the relevant bits.

```js
// need to keep around a few small chunks of memory
const store = [];

socket.on('readable', () => {
  const data = socket.read();
  // allocate for retained data
  const sb = Buffer.allocUnsafeSlow(10);
  // copy the data into the new allocation
  data.copy(sb, 0, 0, 10);
  store.push(sb);
});
```

Use of `Buffer.allocUnsafeSlow()` should be used only as a last resort *after*
a developer has observed undue memory retention in their applications.

A `TypeError` will be thrown if `size` is not a number.

### Class Method: Buffer.byteLength(string[, encoding])

* `string` {String}
* `encoding` {String} Default: `'utf8'`
* Returns: {Number}

Returns the actual byte length of a string. This is not the same as
[`String.prototype.length`][] since that returns the number of *characters* in
a string.

*Note* that for `'base64'` and `'hex'`, this function assumes valid input. For
strings that contain non-Base64/Hex-encoded data (e.g. whitespace), the return
value might be greater than the length of a `Buffer` created from the string.

Example:

```js
const str = '\u00bd + \u00bc = \u00be';

console.log(`${str}: ${str.length} characters, ` +
            `${Buffer.byteLength(str, 'utf8')} bytes`);

// ½ + ¼ = ¾: 9 characters, 12 bytes
```

### Class Method: Buffer.compare(buf1, buf2)


* `buf1` {Buffer}
* `buf2` {Buffer}
* Returns: {Number}

Compares `buf1` to `buf2` typically for the purpose of sorting arrays of
Buffers. This is equivalent is calling [`buf1.compare(buf2)`][].

```js
const arr = [Buffer('1234'), Buffer('0123')];
arr.sort(Buffer.compare);
```

### Class Method: Buffer.concat(list[, totalLength])


* `list` {Array} List of Buffer objects to concat
* `totalLength` {Number} Total length of the Buffers in the list when concatenated
* Returns: {Buffer}

Returns a new Buffer which is the result of concatenating all the Buffers in
the `list` together.

If the list has no items, or if the `totalLength` is 0, then a new zero-length
Buffer is returned.

If `totalLength` is not provided, it is calculated from the Buffers in the
`list`. This, however, adds an additional loop to the function, so it is faster
to provide the length explicitly.

Example: build a single Buffer from a list of three Buffers:

```js
const buf1 = new Buffer(10).fill(0);
const buf2 = new Buffer(14).fill(0);
const buf3 = new Buffer(18).fill(0);
const totalLength = buf1.length + buf2.length + buf3.length;

console.log(totalLength);
const bufA = Buffer.concat([buf1, buf2, buf3], totalLength);
console.log(bufA);
console.log(bufA.length);

// 42
// 
// 42
```

### Class Method: Buffer.from(array)


* `array` {Array}

Allocates a new `Buffer` using an `array` of octets.

```js
const buf = Buffer.from([0x62,0x75,0x66,0x66,0x65,0x72]);
  // creates a new Buffer containing ASCII bytes
  // ['b','u','f','f','e','r']
```

A `TypeError` will be thrown if `array` is not an `Array`.

### Class Method: Buffer.from(arrayBuffer)


* `arrayBuffer` {ArrayBuffer} The `.buffer` property of a `TypedArray` or
  a `new ArrayBuffer()`

When passed a reference to the `.buffer` property of a `TypedArray` instance,
the newly created `Buffer` will share the same allocated memory as the
TypedArray.

```js
const arr = new Uint16Array(2);
arr[0] = 5000;
arr[1] = 4000;

const buf = Buffer.from(arr.buffer); // shares the memory with arr;

console.log(buf);
  // Prints: 

// changing the TypedArray changes the Buffer also
arr[1] = 6000;

console.log(buf);
  // Prints: 
```

A `TypeError` will be thrown if `arrayBuffer` is not an `ArrayBuffer`.

### Class Method: Buffer.from(buffer)


* `buffer` {Buffer}

Copies the passed `buffer` data onto a new `Buffer` instance.

```js
const buf1 = Buffer.from('buffer');
const buf2 = Buffer.from(buf1);

buf1[0] = 0x61;
console.log(buf1.toString());
  // 'auffer'
console.log(buf2.toString());
  // 'buffer' (copy is not changed)
```

A `TypeError` will be thrown if `buffer` is not a `Buffer`.

### Class Method: Buffer.from(str[, encoding])


* `str` {String} String to encode.
* `encoding` {String} Encoding to use, Default: `'utf8'`

Creates a new `Buffer` containing the given JavaScript string `str`. If
provided, the `encoding` parameter identifies the character encoding.
If not provided, `encoding` defaults to `'utf8'`.

```js
const buf1 = Buffer.from('this is a tést');
console.log(buf1.toString());
  // prints: this is a tést
console.log(buf1.toString('ascii'));
  // prints: this is a tC)st

const buf2 = Buffer.from('7468697320697320612074c3a97374', 'hex');
console.log(buf2.toString());
  // prints: this is a tést
```

A `TypeError` will be thrown if `str` is not a string.

### Class Method: Buffer.isBuffer(obj)

* `obj` {Object}
* Returns: {Boolean}

Returns 'true' if `obj` is a Buffer.

### Class Method: Buffer.isEncoding(encoding)


* `encoding` {String} The encoding string to test
* Returns: {Boolean}

Returns true if the `encoding` is a valid encoding argument, or false
otherwise.

### buf[index]


The index operator `[index]` can be used to get and set the octet at position
`index` in the Buffer. The values refer to individual bytes, so the legal value
range is between `0x00` and `0xFF` (hex) or `0` and `255` (decimal).

Example: copy an ASCII string into a Buffer, one byte at a time:

```js
const str = "Node.js";
const buf = new Buffer(str.length);

for (var i = 0; i < str.length ; i++) {
  buf[i] = str.charCodeAt(i);
}

console.log(buf.toString('ascii'));
  // Prints: Node.js
```

### buf.compare(otherBuffer)


* `otherBuffer` {Buffer}
* Returns: {Number}

Compares two Buffer instances and returns a number indicating whether `buf`
comes before, after, or is the same as the `otherBuffer` in sort order.
Comparison is based on the actual sequence of bytes in each Buffer.

* `0` is returned if `otherBuffer` is the same as `buf`
* `1` is returned if `otherBuffer` should come *before* `buf` when sorted.
* `-1` is returned if `otherBuffer` should come *after* `buf` when sorted.

```js
const buf1 = new Buffer('ABC');
const buf2 = new Buffer('BCD');
const buf3 = new Buffer('ABCD');

console.log(buf1.compare(buf1));
  // Prints: 0
console.log(buf1.compare(buf2));
  // Prints: -1
console.log(buf1.compare(buf3));
  // Prints: -1
console.log(buf2.compare(buf1));
  // Prints: 1
console.log(buf2.compare(buf3));
  // Prints: 1

[buf1, buf2, buf3].sort(Buffer.compare);
  // produces sort order [buf1, buf3, buf2]
```

### buf.copy(targetBuffer[, targetStart[, sourceStart[, sourceEnd]]])

* `targetBuffer` {Buffer} Buffer to copy into
* `targetStart` {Number} Default: 0
* `sourceStart` {Number} Default: 0
* `sourceEnd` {Number} Default: `buffer.length`
* Returns: {Number} The number of bytes copied.

Copies data from a region of this Buffer to a region in the target Buffer even
if the target memory region overlaps with the source.

Example: build two Buffers, then copy `buf1` from byte 16 through byte 19
into `buf2`, starting at the 8th byte in `buf2`.

```js
const buf1 = new Buffer(26);
const buf2 = new Buffer(26).fill('!');

for (var i = 0 ; i < 26 ; i++) {
  buf1[i] = i + 97; // 97 is ASCII a
}

buf1.copy(buf2, 8, 16, 20);
console.log(buf2.toString('ascii', 0, 25));
  // Prints: !!!!!!!!qrst!!!!!!!!!!!!!
```

Example: Build a single Buffer, then copy data from one region to an overlapping
region in the same Buffer

```js
const buf = new Buffer(26);

for (var i = 0 ; i < 26 ; i++) {
  buf[i] = i + 97; // 97 is ASCII a
}

buf.copy(buf, 0, 4, 10);
console.log(buf.toString());

// efghijghijklmnopqrstuvwxyz
```

### buf.entries()


* Returns: {Iterator}

Creates and returns an [iterator][] of `[index, byte]` pairs from the Buffer
contents.

```js
const buf = new Buffer('buffer');
for (var pair of buf.entries()) {
  console.log(pair);
}
// prints:
//   [0, 98]
//   [1, 117]
//   [2, 102]
//   [3, 102]
//   [4, 101]
//   [5, 114]
```

### buf.equals(otherBuffer)


* `otherBuffer` {Buffer}
* Returns: {Boolean}

Returns a boolean indicating whether `this` and `otherBuffer` have exactly the
same bytes.

```js
const buf1 = new Buffer('ABC');
const buf2 = new Buffer('414243', 'hex');
const buf3 = new Buffer('ABCD');

console.log(buf1.equals(buf2));
  // Prints: true
console.log(buf1.equals(buf3));
  // Prints: false
```

### buf.fill(value[, offset[, end]])


* `value` {String|Number}
* `offset` {Number} Default: 0
* `end` {Number} Default: `buffer.length`
* Returns: {Buffer}

Fills the Buffer with the specified value. If the `offset` and `end` are not
given it will fill the entire Buffer. The method returns a reference to the
Buffer so calls can be chained.

```js
const b = new Buffer(50).fill('h');
console.log(b.toString());
  // Prints: hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh
```

### buf.indexOf(value[, byteOffset][, encoding])


* `value` {String|Buffer|Number}
* `byteOffset` {Number} Default: 0
* `encoding` {String} Default: `'utf8'`
* Returns: {Number}

Operates similar to [`Array#indexOf()`][] in that it returns either the
starting index position of `value` in Buffer or `-1` if the Buffer does not
contain `value`. The `value` can be a String, Buffer or Number. Strings are by
default interpreted as UTF8. Buffers will use the entire Buffer (to compare a
partial Buffer use [`buf.slice()`][]). Numbers will be interpreted as unsigned 8-bit
integer values between `0` and `255`.

```js
const buf = new Buffer('this is a buffer');

buf.indexOf('this');
  // returns 0
buf.indexOf('is');
  // returns 2
buf.indexOf(new Buffer('a buffer'));
  // returns 8
buf.indexOf(97); // ascii for 'a'
  // returns 8
buf.indexOf(new Buffer('a buffer example'));
  // returns -1
buf.indexOf(new Buffer('a buffer example').slice(0,8));
  // returns 8

const utf16Buffer = new Buffer('\u039a\u0391\u03a3\u03a3\u0395', 'ucs2');

utf16Buffer.indexOf('\u03a3',  0, 'ucs2');
  // returns 4
utf16Buffer.indexOf('\u03a3', -4, 'ucs2');
  // returns 6
```

### buf.keys()


* Returns: {Iterator}

Creates and returns an [iterator][] of Buffer keys (indices).

```js
const buf = new Buffer('buffer');
for (var key of buf.keys()) {
  console.log(key);
}
// prints:
//   0
//   1
//   2
//   3
//   4
//   5
```

### buf.length

* {Number}

Returns the amount of memory allocated for the Buffer in number of bytes. Note
that this does not necessarily reflect the amount of usable data within the
Buffer. For instance, in the example below, a Buffer with 1234 bytes is
allocated, but only 11 ASCII bytes are written.

```js
const buf = new Buffer(1234);

console.log(buf.length);
  // Prints: 1234

buf.write('some string', 0, 'ascii');
console.log(buf.length);
  // Prints: 1234
```

While the `length` property is not immutable, changing the value of `length`
can result in undefined and inconsistent behavior. Applications that wish to
modify the length of a Buffer should therefore treat `length` as read-only and
use [`buf.slice()`][] to create a new Buffer.

```js
var buf = new Buffer(10);
buf.write('abcdefghj', 0, 'ascii');
console.log(buf.length);
  // Prints: 10
buf = buf.slice(0,5);
console.log(buf.length);
  // Prints: 5
```

### buf.readDoubleBE(offset[, noAssert])
### buf.readDoubleLE(offset[, noAssert])

* `offset` {Number} `0 <= offset <= buf.length - 8`
* `noAssert` {Boolean} Default: false
* Returns: {Number}

Reads a 64-bit double from the Buffer at the specified `offset` with specified
endian format (`readDoubleBE()` returns big endian, `readDoubleLE()` returns
little endian).

Setting `noAssert` to `true` skips validation of the `offset`. This allows the
`offset` to be beyond the end of the Buffer.

```js
const buf = new Buffer([1,2,3,4,5,6,7,8]);

buf.readDoubleBE();
  // Returns: 8.20788039913184e-304
buf.readDoubleLE();
  // Returns: 5.447603722011605e-270
buf.readDoubleLE(1);
  // throws RangeError: Index out of range

buf.readDoubleLE(1, true); // Warning: reads passed end of buffer!
  // Segmentation fault! don't do this!
```

### buf.readFloatBE(offset[, noAssert])
### buf.readFloatLE(offset[, noAssert])

* `offset` {Number} `0 <= offset <= buf.length - 4`
* `noAssert` {Boolean} Default: false
* Returns: {Number}

Reads a 32-bit float from the Buffer at the specified `offset` with specified
endian format (`readFloatBE()` returns big endian, `readFloatLE()` returns
little endian).

Setting `noAssert` to `true` skips validation of the `offset`. This allows the
`offset` to be beyond the end of the Buffer.

```js
const buf = new Buffer([1,2,3,4]);

buf.readFloatBE();
  // Returns: 2.387939260590663e-38
buf.readFloatLE();
  // Returns: 1.539989614439558e-36
buf.readFloatLE(1);
  // throws RangeError: Index out of range

buf.readFloatLE(1, true); // Warning: reads passed end of buffer!
  // Segmentation fault! don't do this!
```

### buf.readInt8(offset[, noAssert])

* `offset` {Number} `0 <= offset <= buf.length - 1`
* `noAssert` {Boolean} Default: false
* Returns: {Number}

Reads a signed 8-bit integer from the Buffer at the specified `offset`.

Setting `noAssert` to `true` skips validation of the `offset`. This allows the
`offset` to be beyond the end of the Buffer.

Integers read from the Buffer are interpreted as two's complement signed values.

```js
const buf = new Buffer([1,-2,3,4]);

buf.readInt8(0);
  // returns 1
buf.readInt8(1);
  // returns -2
```

### buf.readInt16BE(offset[, noAssert])
### buf.readInt16LE(offset[, noAssert])

* `offset` {Number} `0 <= offset <= buf.length - 2`
* `noAssert` {Boolean} Default: false
* Returns: {Number}

Reads a signed 16-bit integer from the Buffer at the specified `offset` with
the specified endian format (`readInt16BE()` returns big endian,
`readInt16LE()` returns little endian).

Setting `noAssert` to `true` skips validation of the `offset`. This allows the
`offset` to be beyond the end of the Buffer.

Integers read from the Buffer are interpreted as two's complement signed values.

```js
const buf = new Buffer([1,-2,3,4]);

buf.readInt16BE();
  // returns 510
buf.readInt16LE(1);
  // returns 1022
```

### buf.readInt32BE(offset[, noAssert])
### buf.readInt32LE(offset[, noAssert])

* `offset` {Number} `0 <= offset <= buf.length - 4`
* `noAssert` {Boolean} Default: false
* Returns: {Number}

Reads a signed 32-bit integer from the Buffer at the specified `offset` with
the specified endian format (`readInt32BE()` returns big endian,
`readInt32LE()` returns little endian).

Setting `noAssert` to `true` skips validation of the `offset`. This allows the
`offset` to be beyond the end of the Buffer.

Integers read from the Buffer are interpreted as two's complement signed values.

```js
const buf = new Buffer([1,-2,3,4]);

buf.readInt32BE();
  // returns 33424132
buf.readInt32LE();
  // returns 67370497
buf.readInt32LE(1);
  // throws RangeError: Index out of range
```

### buf.readIntBE(offset, byteLength[, noAssert])
### buf.readIntLE(offset, byteLength[, noAssert])


* `offset` {Number} `0 <= offset <= buf.length - byteLength`
* `byteLength` {Number} `0 < byteLength <= 6`
* `noAssert` {Boolean} Default: false
* Returns: {Number}

Reads `byteLength` number of bytes from the Buffer at the specified `offset`
and interprets the result as a two's complement signed value. Supports up to 48
bits of accuracy. For example:

```js
const buf = new Buffer(6);
buf.writeUInt16LE(0x90ab, 0);
buf.writeUInt32LE(0x12345678, 2);
buf.readIntLE(0, 6).toString(16);  // Specify 6 bytes (48 bits)
// Returns: '1234567890ab'

buf.readIntBE(0, 6).toString(16);
// Returns: -546f87a9cbee
```

Setting `noAssert` to `true` skips validation of the `offset`. This allows the
`offset` to be beyond the end of the Buffer.

### buf.readUInt8(offset[, noAssert])

* `offset` {Number} `0 <= offset <= buf.length - 1`
* `noAssert` {Boolean} Default: false
* Returns: {Number}

Reads an unsigned 8-bit integer from the Buffer at the specified `offset`.

Setting `noAssert` to `true` skips validation of the `offset`. This allows the
`offset` to be beyond the end of the Buffer.

```js
const buf = new Buffer([1,-2,3,4]);

buf.readUInt8(0);
  // returns 1
buf.readUInt8(1);
  // returns 254
```

### buf.readUInt16BE(offset[, noAssert])
### buf.readUInt16LE(offset[, noAssert])

* `offset` {Number} `0 <= offset <= buf.length - 2`
* `noAssert` {Boolean} Default: false
* Returns: {Number}

Reads an unsigned 16-bit integer from the Buffer at the specified `offset` with
specified endian format (`readUInt16BE()` returns big endian,
`readUInt16LE()` returns little endian).

Setting `noAssert` to `true` skips validation of the `offset`. This allows the
`offset` to be beyond the end of the Buffer.

Example:

```js
const buf = new Buffer([0x3, 0x4, 0x23, 0x42]);

buf.readUInt16BE(0);
  // Returns: 0x0304
buf.readUInt16LE(0);
  // Returns: 0x0403
buf.readUInt16BE(1);
  // Returns: 0x0423
buf.readUInt16LE(1);
  // Returns: 0x2304
buf.readUInt16BE(2);
  // Returns: 0x2342
buf.readUInt16LE(2);
  // Returns: 0x4223
```

### buf.readUInt32BE(offset[, noAssert])
### buf.readUInt32LE(offset[, noAssert])

* `offset` {Number} `0 <= offset <= buf.length - 4`
* `noAssert` {Boolean} Default: false
* Returns: {Number}

Reads an unsigned 32-bit integer from the Buffer at the specified `offset` with
specified endian format (`readUInt32BE()` returns big endian,
`readUInt32LE()` returns little endian).

Setting `noAssert` to `true` skips validation of the `offset`. This allows the
`offset` to be beyond the end of the Buffer.

Example:

```js
const buf = new Buffer([0x3, 0x4, 0x23, 0x42]);

buf.readUInt32BE(0);
  // Returns: 0x03042342
console.log(buf.readUInt32LE(0));
  // Returns: 0x42230403
```

### buf.readUIntBE(offset, byteLength[, noAssert])
### buf.readUIntLE(offset, byteLength[, noAssert])


* `offset` {Number} `0 <= offset <= buf.length - byteLength`
* `byteLength` {Number} `0 < byteLength <= 6`
* `noAssert` {Boolean} Default: false
* Returns: {Number}

Reads `byteLength` number of bytes from the Buffer at the specified `offset`
and interprets the result as an unsigned integer. Supports up to 48
bits of accuracy. For example:

```js
const buf = new Buffer(6);
buf.writeUInt16LE(0x90ab, 0);
buf.writeUInt32LE(0x12345678, 2);
buf.readUIntLE(0, 6).toString(16);  // Specify 6 bytes (48 bits)
// Returns: '1234567890ab'

buf.readUIntBE(0, 6).toString(16);
// Returns: ab9078563412
```

Setting `noAssert` to `true` skips validation of the `offset`. This allows the
`offset` to be beyond the end of the Buffer.

### buf.slice([start[, end]])

* `start` {Number} Default: 0
* `end` {Number} Default: `buffer.length`
* Returns: {Buffer}

Returns a new Buffer that references the same memory as the original, but
offset and cropped by the `start` and `end` indices.

**Note that modifying the new Buffer slice will modify the memory in the
original Buffer because the allocated memory of the two objects overlap.**

Example: build a Buffer with the ASCII alphabet, take a slice, then modify one
byte from the original Buffer.

```js
const buf1 = new Buffer(26);

for (var i = 0 ; i < 26 ; i++) {
  buf1[i] = i + 97; // 97 is ASCII a
}

const buf2 = buf1.slice(0, 3);
buf2.toString('ascii', 0, buf2.length);
  // Returns: 'abc'
buf1[0] = 33;
buf2.toString('ascii', 0, buf2.length);
  // Returns : '!bc'
```

Specifying negative indexes causes the slice to be generated relative to the
end of the Buffer rather than the beginning.

```js
const buf = new Buffer('buffer');

buf.slice(-6, -1).toString();
  // Returns 'buffe', equivalent to buf.slice(0, 5)
buf.slice(-6, -2).toString();
  // Returns 'buff', equivalent to buf.slice(0, 4)
buf.slice(-5, -2).toString();
  // Returns 'uff', equivalent to buf.slice(1, 4)
```

### buf.toString([encoding[, start[, end]]])

* `encoding` {String} Default: `'utf8'`
* `start` {Number} Default: 0
* `end` {Number} Default: `buffer.length`
* Returns: {String}

Decodes and returns a string from the Buffer data using the specified
character set `encoding`.

```js
const buf = new Buffer(26);
for (var i = 0 ; i < 26 ; i++) {
  buf[i] = i + 97; // 97 is ASCII a
}
buf.toString('ascii');
  // Returns: 'abcdefghijklmnopqrstuvwxyz'
buf.toString('ascii',0,5);
  // Returns: 'abcde'
buf.toString('utf8',0,5);
  // Returns: 'abcde'
buf.toString(undefined,0,5);
  // Returns: 'abcde', encoding defaults to 'utf8'
```

### buf.toJSON()


* Returns: {Object}

Returns a JSON representation of the Buffer instance.  [`JSON.stringify()`][]
implicitly calls this function when stringifying a Buffer instance.

Example:

```js
const buf = new Buffer('test');
const json = JSON.stringify(buf);

console.log(json);
// Prints: '{"type":"Buffer","data":[116,101,115,116]}'

const copy = JSON.parse(json, (key, value) => {
    return value && value.type === 'Buffer'
      ? new Buffer(value.data)
      : value;
  });

console.log(copy.toString());
// Prints: 'test'
```

### buf.values()


* Returns: {Iterator}

Creates and returns an [iterator][] for Buffer values (bytes). This function is
called automatically when the Buffer is used in a `for..of` statement.

```js
const buf = new Buffer('buffer');
for (var value of buf.values()) {
  console.log(value);
}
// prints:
//   98
//   117
//   102
//   102
//   101
//   114

for (var value of buf) {
  console.log(value);
}
// prints:
//   98
//   117
//   102
//   102
//   101
//   114
```

### buf.write(string[, offset[, length]][, encoding])

* `string` {String} Bytes to be written to buffer
* `offset` {Number} Default: 0
* `length` {Number} Default: `buffer.length - offset`
* `encoding` {String} Default: `'utf8'`
* Returns: {Number} Numbers of bytes written

Writes `string` to the Buffer at `offset` using the given `encoding`.
The `length` parameter is the number of bytes to write. If the Buffer did not
contain enough space to fit the entire string, only a partial amount of the
string will be written however, it will not write only partially encoded
characters.

```js
const buf = new Buffer(256);
const len = buf.write('\u00bd + \u00bc = \u00be', 0);
console.log(`${len} bytes: ${buf.toString('utf8', 0, len)}`);
  // Prints: 12 bytes: ½ + ¼ = ¾
```

### buf.writeDoubleBE(value, offset[, noAssert])
### buf.writeDoubleLE(value, offset[, noAssert])

* `value` {Number} Bytes to be written to Buffer
* `offset` {Number} `0 <= offset <= buf.length - 8`
* `noAssert` {Boolean} Default: false
* Returns: {Number} The offset plus the number of written bytes

Writes `value` to the Buffer at the specified `offset` with specified endian
format (`writeDoubleBE()` writes big endian, `writeDoubleLE()` writes little
endian). The `value` argument *should* be a valid 64-bit double. Behavior is
not defined when `value` is anything other than a 64-bit double.

Set `noAssert` to true to skip validation of `value` and `offset`. This means
that `value` may be too large for the specific function and `offset` may be
beyond the end of the Buffer leading to the values being silently dropped. This
should not be used unless you are certain of correctness.

Example:

```js
const buf = new Buffer(8);
buf.writeDoubleBE(0xdeadbeefcafebabe, 0);

console.log(buf);
  // Prints: 

buf.writeDoubleLE(0xdeadbeefcafebabe, 0);

console.log(buf);
  // Prints: 
```

### buf.writeFloatBE(value, offset[, noAssert])
### buf.writeFloatLE(value, offset[, noAssert])

* `value` {Number} Bytes to be written to Buffer
* `offset` {Number} `0 <= offset <= buf.length - 4`
* `noAssert` {Boolean} Default: false
* Returns: {Number} The offset plus the number of written bytes

Writes `value` to the Buffer at the specified `offset` with specified endian
format (`writeFloatBE()` writes big endian, `writeFloatLE()` writes little
endian). Behavior is not defined when `value` is anything other than a 32-bit
float.

Set `noAssert` to true to skip validation of `value` and `offset`. This means
that `value` may be too large for the specific function and `offset` may be
beyond the end of the Buffer leading to the values being silently dropped. This
should not be used unless you are certain of correctness.

Example:

```js
const buf = new Buffer(4);
buf.writeFloatBE(0xcafebabe, 0);

console.log(buf);
  // Prints: 

buf.writeFloatLE(0xcafebabe, 0);

console.log(buf);
  // Prints: 
```

### buf.writeInt8(value, offset[, noAssert])

* `value` {Number} Bytes to be written to Buffer
* `offset` {Number} `0 <= offset <= buf.length - 1`
* `noAssert` {Boolean} Default: false
* Returns: {Number} The offset plus the number of written bytes

Writes `value` to the Buffer at the specified `offset`. The `value` should be a
valid signed 8-bit integer.  Behavior is not defined when `value` is anything
other than a signed 8-bit integer.

Set `noAssert` to true to skip validation of `value` and `offset`. This means
that `value` may be too large for the specific function and `offset` may be
beyond the end of the Buffer leading to the values being silently dropped. This
should not be used unless you are certain of correctness.

The `value` is interpreted and written as a two's complement signed integer.

```js
const buf = new Buffer(2);
buf.writeInt8(2, 0);
buf.writeInt8(-2, 1);
console.log(buf);
  // Prints: 
```

### buf.writeInt16BE(value, offset[, noAssert])
### buf.writeInt16LE(value, offset[, noAssert])

* `value` {Number} Bytes to be written to Buffer
* `offset` {Number} `0 <= offset <= buf.length - 2`
* `noAssert` {Boolean} Default: false
* Returns: {Number} The offset plus the number of written bytes

Writes `value` to the Buffer at the specified `offset` with specified endian
format (`writeInt16BE()` writes big endian, `writeInt16LE()` writes little
endian). The `value` should be a valid signed 16-bit integer. Behavior is
not defined when `value` is anything other than a signed 16-bit integer.

Set `noAssert` to true to skip validation of `value` and `offset`. This means
that `value` may be too large for the specific function and `offset` may be
beyond the end of the Buffer leading to the values being silently dropped. This
should not be used unless you are certain of correctness.

The `value` is interpreted and written as a two's complement signed integer.

```js
const buf = new Buffer(4);
buf.writeInt16BE(0x0102,0);
buf.writeInt16LE(0x0304,2);
console.log(buf);
  // Prints: 
```

### buf.writeInt32BE(value, offset[, noAssert])
### buf.writeInt32LE(value, offset[, noAssert])

* `value` {Number} Bytes to be written to Buffer
* `offset` {Number} `0 <= offset <= buf.length - 4`
* `noAssert` {Boolean} Default: false
* Returns: {Number} The offset plus the number of written bytes

Writes `value` to the Buffer at the specified `offset` with specified endian
format (`writeInt32BE()` writes big endian, `writeInt32LE()` writes little
endian). The `value` should be a valid signed 32-bit integer. Behavior is
not defined when `value` is anything other than a signed 32-bit integer.

Set `noAssert` to true to skip validation of `value` and `offset`. This means
that `value` may be too large for the specific function and `offset` may be
beyond the end of the Buffer leading to the values being silently dropped. This
should not be used unless you are certain of correctness.

The `value` is interpreted and written as a two's complement signed integer.

```js
const buf = new Buffer(8);
buf.writeInt32BE(0x01020304,0);
buf.writeInt32LE(0x05060708,4);
console.log(buf);
  // Prints: 
```

### buf.writeIntBE(value, offset, byteLength[, noAssert])
### buf.writeIntLE(value, offset, byteLength[, noAssert])


* `value` {Number} Bytes to be written to Buffer
* `offset` {Number} `0 <= offset <= buf.length - byteLength`
* `byteLength` {Number} `0 < byteLength <= 6`
* `noAssert` {Boolean} Default: false
* Returns: {Number} The offset plus the number of written bytes

Writes `value` to the Buffer at the specified `offset` and `byteLength`.
Supports up to 48 bits of accuracy. For example:

```js
const buf1 = new Buffer(6);
buf1.writeUIntBE(0x1234567890ab, 0, 6);
console.log(buf1);
  // Prints: 

const buf2 = new Buffer(6);
buf2.writeUIntLE(0x1234567890ab, 0, 6);
console.log(buf2);
  // Prints: 
```

Set `noAssert` to true to skip validation of `value` and `offset`. This means
that `value` may be too large for the specific function and `offset` may be
beyond the end of the Buffer leading to the values being silently dropped. This
should not be used unless you are certain of correctness.

Behavior is not defined when `value` is anything other than an integer.

### buf.writeUInt8(value, offset[, noAssert])

* `value` {Number} Bytes to be written to Buffer
* `offset` {Number} `0 <= offset <= buf.length - 1`
* `noAssert` {Boolean} Default: false
* Returns: {Number} The offset plus the number of written bytes

Writes `value` to the Buffer at the specified `offset`. The `value` should be a
valid unsigned 8-bit integer.  Behavior is not defined when `value` is anything
other than an unsigned 8-bit integer.

Set `noAssert` to true to skip validation of `value` and `offset`. This means
that `value` may be too large for the specific function and `offset` may be
beyond the end of the Buffer leading to the values being silently dropped. This
should not be used unless you are certain of correctness.

Example:

```js
const buf = new Buffer(4);
buf.writeUInt8(0x3, 0);
buf.writeUInt8(0x4, 1);
buf.writeUInt8(0x23, 2);
buf.writeUInt8(0x42, 3);

console.log(buf);
  // Prints: 
```

### buf.writeUInt16BE(value, offset[, noAssert])
### buf.writeUInt16LE(value, offset[, noAssert])

* `value` {Number} Bytes to be written to Buffer
* `offset` {Number} `0 <= offset <= buf.length - 2`
* `noAssert` {Boolean} Default: false
* Returns: {Number} The offset plus the number of written bytes

Writes `value` to the Buffer at the specified `offset` with specified endian
format (`writeUInt16BE()` writes big endian, `writeUInt16LE()` writes little
endian). The `value` should be a valid unsigned 16-bit integer. Behavior is
not defined when `value` is anything other than an unsigned 16-bit integer.

Set `noAssert` to true to skip validation of `value` and `offset`. This means
that `value` may be too large for the specific function and `offset` may be
beyond the end of the Buffer leading to the values being silently dropped. This
should not be used unless you are certain of correctness.

Example:

```js
const buf = new Buffer(4);
buf.writeUInt16BE(0xdead, 0);
buf.writeUInt16BE(0xbeef, 2);

console.log(buf);
  // Prints: 

buf.writeUInt16LE(0xdead, 0);
buf.writeUInt16LE(0xbeef, 2);

console.log(buf);
  // Prints: 
```

### buf.writeUInt32BE(value, offset[, noAssert])
### buf.writeUInt32LE(value, offset[, noAssert])

* `value` {Number} Bytes to be written to Buffer
* `offset` {Number} `0 <= offset <= buf.length - 4`
* `noAssert` {Boolean} Default: false
* Returns: {Number} The offset plus the number of written bytes

Writes `value` to the Buffer at the specified `offset` with specified endian
format (`writeUInt32BE()` writes big endian, `writeUInt32LE()` writes little
endian). The `value` should be a valid unsigned 32-bit integer. Behavior is
not defined when `value` is anything other than an unsigned 32-bit integer.

Set `noAssert` to true to skip validation of `value` and `offset`. This means
that `value` may be too large for the specific function and `offset` may be
beyond the end of the Buffer leading to the values being silently dropped. This
should not be used unless you are certain of correctness.

Example:

```js
const buf = new Buffer(4);
buf.writeUInt32BE(0xfeedface, 0);

console.log(buf);
  // Prints: 

buf.writeUInt32LE(0xfeedface, 0);

console.log(buf);
  // Prints: 
```

### buf.writeUIntBE(value, offset, byteLength[, noAssert])
### buf.writeUIntLE(value, offset, byteLength[, noAssert])

* `value` {Number} Bytes to be written to Buffer
* `offset` {Number} `0 <= offset <= buf.length - byteLength`
* `byteLength` {Number} `0 < byteLength <= 6`
* `noAssert` {Boolean} Default: false
* Returns: {Number} The offset plus the number of written bytes

Writes `value` to the Buffer at the specified `offset` and `byteLength`.
Supports up to 48 bits of accuracy. For example:

```js
const buf = new Buffer(6);
buf.writeUIntBE(0x1234567890ab, 0, 6);
console.log(buf);
  // Prints: 
```

Set `noAssert` to true to skip validation of `value` and `offset`. This means
that `value` may be too large for the specific function and `offset` may be
beyond the end of the Buffer leading to the values being silently dropped. This
should not be used unless you are certain of correctness.

Behavior is not defined when `value` is anything other than an unsigned integer.

## buffer.INSPECT_MAX_BYTES

* {Number} Default: 50

Returns the maximum number of bytes that will be returned when
`buffer.inspect()` is called. This can be overridden by user modules. See
[`util.inspect()`][] for more details on `buffer.inspect()` behavior.

Note that this is a property on the `buffer` module as returned by
`require('buffer')`, not on the Buffer global or a Buffer instance.

## Class: SlowBuffer

Returns an un-pooled `Buffer`.

In order to avoid the garbage collection overhead of creating many individually
allocated Buffers, by default allocations under 4KB are sliced from a single
larger allocated object. This approach improves both performance and memory
usage since v8 does not need to track and cleanup as many `Persistent` objects.

In the case where a developer may need to retain a small chunk of memory from a
pool for an indeterminate amount of time, it may be appropriate to create an
un-pooled Buffer instance using `SlowBuffer` then copy out the relevant bits.

```js
// need to keep around a few small chunks of memory
const store = [];

socket.on('readable', () => {
  var data = socket.read();
  // allocate for retained data
  var sb = new SlowBuffer(10);
  // copy the data into the new allocation
  data.copy(sb, 0, 0, 10);
  store.push(sb);
});
```

Use of `SlowBuffer` should be used only as a last resort *after* a developer
has observed undue memory retention in their applications.

### new SlowBuffer(size)

* `size` Number

Allocates a new `SlowBuffer` of `size` bytes.  The `size` must be less than
or equal to the value of `require('buffer').kMaxLength` (on 64-bit
architectures, `kMaxLength` is `(2^31)-1`). Otherwise, a [`RangeError`][] is
thrown. If a `size` less than 0 is specified, a zero-length `SlowBuffer` will be
created.

The underlying memory for `SlowBuffer` instances is *not initialized*. The
contents of a newly created `SlowBuffer` are unknown and could contain
sensitive data. Use [`buf.fill(0)`][] to initialize a `SlowBuffer` to zeroes.

```js
const SlowBuffer = require('buffer').SlowBuffer;
const buf = new SlowBuffer(5);
console.log(buf);
  // 
  // (octets will be different, every time)
buf.fill(0);
console.log(buf);
  // 
```

[`Array#includes()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/includes
[`Array#indexOf()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/indexOf
[`buf.entries()`]: #buffer_buf_entries
[`buf.fill(0)`]: #buffer_buf_fill_value_offset_end
[`buf.keys()`]: #buffer_buf_keys
[`buf.slice()`]: #buffer_buf_slice_start_end
[`buf.values()`]: #buffer_buf_values
[`buf1.compare(buf2)`]: #buffer_buf_compare_otherbuffer
[`JSON.stringify()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify
[`RangeError`]: errors.html#errors_class_rangeerror
[`String.prototype.length`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/length
[`util.inspect()`]: util.html#util_util_inspect_object_options
[iterator]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols
[RFC 4648, Section 5]: https://tools.ietf.org/html/rfc4648#section-5
[buffer_from_array]: #buffer_class_method_buffer_from_array
[buffer_from_buffer]: #buffer_class_method_buffer_from_buffer
[buffer_from_arraybuf]: #buffer_class_method_buffer_from_arraybuffer
[buffer_from_string]: #buffer_class_method_buffer_from_str_encoding
[buffer_allocunsafe]: #buffer_class_method_buffer_allocunsafe_size
[buffer_allocunsafeslow]: #buffer_class_method_buffer_allocunsafeslow_size
[buffer_alloc]: #buffer_class_method_buffer_alloc_size_fill_encoding
[`TypedArray.from()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/from
node-v4.8.2/doc/api/child_process.html000644 000766 000024 00000241701 13070706740 020006 0ustar00iojsstaff000000 000000 


  
  Child Process | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

      

        
Child Process#


Stability: 2 - Stable
The child_process module provides the ability to spawn child processes in
a manner that is similar, but not identical, to popen(3). This capability
is primarily provided by the child_process.spawn() function:


const spawn = require('child_process').spawn;
const ls = spawn('ls', ['-lh', '/usr']);

ls.stdout.on('data', (data) => {
  console.log(`stdout: ${data}`);
});

ls.stderr.on('data', (data) => {
  console.log(`stderr: ${data}`);
});

ls.on('close', (code) => {
  console.log(`child process exited with code ${code}`);
});



By default, pipes for stdin, stdout and stderr are established between
the parent Node.js process and the spawned child. It is possible to stream data
through these pipes in a non-blocking way. Note, however, that some programs
use line-buffered I/O internally. While that does not affect Node.js, it can
mean that data sent to the child process may not be immediately consumed.


The child_process.spawn() method spawns the child process asynchronously,
without blocking the Node.js event loop. The child_process.spawnSync()
function provides equivalent functionality in a synchronous manner that blocks
the event loop until the spawned process either exits or is terminated.


For convenience, the child_process module provides a handful of synchronous
and asynchronous alternatives to child_process.spawn() and
child_process.spawnSync().  Note that each of these alternatives are
implemented on top of child_process.spawn() or child_process.spawnSync().


    

  • child_process.exec(): spawns a shell and runs a command within that shell,
passing the stdout and stderr to a callback function when complete.
    • 

  • child_process.execFile(): similar to child_process.exec() except that
it spawns the command directly without first spawning a shell.
    • 

  • child_process.fork(): spawns a new Node.js process and invokes a
specified module with an IPC communication channel established that allows
sending messages between parent and child.
    • 

  • child_process.execSync(): a synchronous version of
child_process.exec() that will block the Node.js event loop.
    • 

  • child_process.execFileSync(): a synchronous version of
child_process.execFile() that will block the Node.js event loop.
    • 



For certain use cases, such as automating shell scripts, the
synchronous counterparts may be more convenient. In many cases, however,
the synchronous methods can have significant impact on performance due to
stalling the event loop while spawned processes complete.


Asynchronous Process Creation#


The child_process.spawn(), child_process.fork(), child_process.exec(),
and child_process.execFile() methods all follow the idiomatic asynchronous
programming pattern typical of other Node.js APIs.


Each of the methods returns a ChildProcess instance. These objects
implement the Node.js EventEmitter API, allowing the parent process to
register listener functions that are called when certain events occur during
the life cycle of the child process.


The child_process.exec() and child_process.execFile() methods additionally
allow for an optional callback function to be specified that is invoked
when the child process terminates.


Spawning .bat and .cmd files on Windows#


The importance of the distinction between child_process.exec() and
child_process.execFile() can vary based on platform. On Unix-type operating
systems (Unix, Linux, OSX) child_process.execFile() can be more efficient
because it does not spawn a shell. On Windows, however, .bat and .cmd
files are not executable on their own without a terminal, and therefore cannot
be launched using child_process.execFile(). When running on Windows, .bat
and .cmd files can be invoked using child_process.spawn() with the shell
option set, with child_process.exec(), or by spawning cmd.exe and passing
the .bat or .cmd file as an argument (which is what the shell option and
child_process.exec() do).


// On Windows Only ...
const spawn = require('child_process').spawn;
const bat = spawn('cmd.exe', ['/c', 'my.bat']);

bat.stdout.on('data', (data) => {
  console.log(data);
});

bat.stderr.on('data', (data) => {
  console.log(data);
});

bat.on('exit', (code) => {
  console.log(`Child exited with code ${code}`);
});

// OR...
const exec = require('child_process').exec;
exec('my.bat', (err, stdout, stderr) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log(stdout);
});



child_process.exec(command[, options][, callback])#



Added in: v0.1.90

    

  • command <String> The command to run, with space-separated arguments
    • 

  • options <Object>
      

    • cwd <String> Current working directory of the child process
      • 

    • env <Object> Environment key-value pairs
      • 

    • encoding <String> (Default: 'utf8')
      • 

    • shell <String> Shell to execute the command with
(Default: '/bin/sh' on UNIX, 'cmd.exe' on Windows,  The shell should
 understand the -c switch on UNIX or /s /c on Windows. On Windows,
 command line parsing should be compatible with cmd.exe.)
      • 

    • timeout <Number> (Default: 0)
      • 

    • maxBuffer <Number> largest amount of data (in bytes) allowed on stdout or
stderr - if exceeded child process is killed (Default: 200*1024)
      • 

    • killSignal <String> | <Integer> (Default: 'SIGTERM')
      • 

    • uid <Number> Sets the user identity of the process. (See setuid(2).)
      • 

    • gid <Number> Sets the group identity of the process. (See setgid(2).)
      • 

    

    • 

  • callback <Function> called with the output when process terminates

    • 

  • Returns: <ChildProcess>
    • 



Spawns a shell then executes the command within that shell, buffering any
generated output.


Note: Never pass unsanitised user input to this function. Any input
containing shell metacharacters may be used to trigger arbitrary command
execution.


const exec = require('child_process').exec;
exec('cat *.js bad_file | wc -l', (error, stdout, stderr) => {
  if (error) {
    console.error(`exec error: ${error}`);
    return;
  }
  console.log(`stdout: ${stdout}`);
  console.log(`stderr: ${stderr}`);
});



If a callback function is provided, it is called with the arguments
(error, stdout, stderr). On success, error will be null.  On error,
error will be an instance of Error. The error.code property will be
the exit code of the child process while error.signal will be set to the
signal that terminated the process. Any exit code other than 0 is considered
to be an error.


The stdout and stderr arguments passed to the callback will contain the
stdout and stderr output of the child process. By default, Node.js will decode
the output as UTF-8 and pass strings to the callback. The encoding option
can be used to specify the character encoding used to decode the stdout and
stderr output. If encoding is 'buffer', or an unrecognized character
encoding, Buffer objects will be passed to the callback instead.


The options argument may be passed as the second argument to customize how
the process is spawned. The default options are:


{
  encoding: 'utf8',
  timeout: 0,
  maxBuffer: 200*1024,
  killSignal: 'SIGTERM',
  cwd: null,
  env: null
}



If timeout is greater than 0, the parent will send the the signal
identified by the killSignal property (the default is 'SIGTERM') if the
child runs longer than timeout milliseconds.


The maxBuffer option specifies the largest amount of data (in bytes) allowed
on stdout or stderr - if this value is exceeded then the child process is
terminated.


Note: Unlike the exec() POSIX system call, child_process.exec() does not
replace the existing process and uses a shell to execute the command.


child_process.execFile(file[, args][, options][, callback])#



Added in: v0.1.91



The child_process.execFile() function is similar to child_process.exec()
except that it does not spawn a shell. Rather, the specified executable file
is spawned directly as a new process making it slightly more efficient than
child_process.exec().


The same options as child_process.exec() are supported. Since a shell is not
spawned, behaviors such as I/O redirection and file globbing are not supported.


const execFile = require('child_process').execFile;
const child = execFile('node', ['--version'], (error, stdout, stderr) => {
  if (error) {
    throw error;
  }
  console.log(stdout);
});



The stdout and stderr arguments passed to the callback will contain the
stdout and stderr output of the child process. By default, Node.js will decode
the output as UTF-8 and pass strings to the callback. The encoding option
can be used to specify the character encoding used to decode the stdout and
stderr output. If encoding is 'buffer', or an unrecognized character
encoding, Buffer objects will be passed to the callback instead.


child_process.fork(modulePath[, args][, options])#



Added in: v0.5.0

    

  • modulePath <String> The module to run in the child
    • 

  • args <Array> List of string arguments
    • 

  • options <Object>
      

    • cwd <String> Current working directory of the child process
      • 

    • env <Object> Environment key-value pairs
      • 

    • execPath <String> Executable used to create the child process
      • 

    • execArgv <Array> List of string arguments passed to the executable
(Default: process.execArgv)
      • 

    • silent <Boolean> If true, stdin, stdout, and stderr of the child will be
piped to the parent, otherwise they will be inherited from the parent, see
the 'pipe' and 'inherit' options for child_process.spawn()'s
stdio for more details (default is false)
      • 

    • uid <Number> Sets the user identity of the process. (See setuid(2).)
      • 

    • gid <Number> Sets the group identity of the process. (See setgid(2).)
      • 

    

    • 

  • Returns: <ChildProcess>
    • 



The child_process.fork() method is a special case of
child_process.spawn() used specifically to spawn new Node.js processes.
Like child_process.spawn(), a ChildProcess object is returned. The returned
ChildProcess will have an additional communication channel built-in that
allows messages to be passed back and forth between the parent and child. See
ChildProcess#send() for details.


It is important to keep in mind that spawned Node.js child processes are
independent of the parent with exception of the IPC communication channel
that is established between the two. Each process has its own memory, with
their own V8 instances. Because of the additional resource allocations
required, spawning a large number of child Node.js processes is not
recommended.


By default, child_process.fork() will spawn new Node.js instances using the
process.execPath of the parent process. The execPath property in the
options object allows for an alternative execution path to be used.


Node.js processes launched with a custom execPath will communicate with the
parent process using the file descriptor (fd) identified using the
environment variable NODE_CHANNEL_FD on the child process. The input and
output on this fd is expected to be line delimited JSON objects.


Note: Unlike the fork() POSIX system call, child_process.fork() does
not clone the current process.


child_process.spawn(command[, args][, options])#



Added in: v0.1.90

    

  • command <String> The command to run
    • 

  • args <Array> List of string arguments
    • 

  • options <Object>
      

    • cwd <String> Current working directory of the child process
      • 

    • env <Object> Environment key-value pairs
      • 

    • stdio <Array> | <String> Child's stdio configuration. (See
options.stdio)
      • 

    • detached <Boolean> Prepare child to run independently of its parent
process. Specific behavior depends on the platform, see
options.detached)
      • 

    • uid <Number> Sets the user identity of the process. (See setuid(2).)
      • 

    • gid <Number> Sets the group identity of the process. (See setgid(2).)
      • 

    • shell <Boolean> | <String> If true, runs command inside of a shell. Uses
'/bin/sh' on UNIX, and 'cmd.exe' on Windows. A different shell can be
specified as a string. The shell should understand the -c switch on UNIX,
or /s /c on Windows. Defaults to false (no shell).
      • 

    

    • 

  • Returns: <ChildProcess>
    • 



The child_process.spawn() method spawns a new process using the given
command, with command line arguments in args. If omitted, args defaults
to an empty array.


Note: If the shell option is enabled, do not pass unsanitised user input to
this function. Any input containing shell metacharacters may be used to
trigger arbitrary command execution.


A third argument may be used to specify additional options, with these defaults:


{
  cwd: undefined,
  env: process.env
}



Use cwd to specify the working directory from which the process is spawned.
If not given, the default is to inherit the current working directory.


Use env to specify environment variables that will be visible to the new
process, the default is process.env.


Example of running ls -lh /usr, capturing stdout, stderr, and the
exit code:


const spawn = require('child_process').spawn;
const ls = spawn('ls', ['-lh', '/usr']);

ls.stdout.on('data', (data) => {
  console.log(`stdout: ${data}`);
});

ls.stderr.on('data', (data) => {
  console.log(`stderr: ${data}`);
});

ls.on('close', (code) => {
  console.log(`child process exited with code ${code}`);
});



Example: A very elaborate way to run 'ps ax | grep ssh'


const spawn = require('child_process').spawn;
const ps = spawn('ps', ['ax']);
const grep = spawn('grep', ['ssh']);

ps.stdout.on('data', (data) => {
  grep.stdin.write(data);
});

ps.stderr.on('data', (data) => {
  console.log(`ps stderr: ${data}`);
});

ps.on('close', (code) => {
  if (code !== 0) {
    console.log(`ps process exited with code ${code}`);
  }
  grep.stdin.end();
});

grep.stdout.on('data', (data) => {
  console.log(`${data}`);
});

grep.stderr.on('data', (data) => {
  console.log(`grep stderr: ${data}`);
});

grep.on('close', (code) => {
  if (code !== 0) {
    console.log(`grep process exited with code ${code}`);
  }
});



Example of checking for failed exec:


const spawn = require('child_process').spawn;
const child = spawn('bad_command');

child.on('error', (err) => {
  console.log('Failed to start child process.');
});



options.detached#



Added in: v0.7.10

On Windows, setting options.detached to true makes it possible for the
child process to continue running after the parent exits. The child will have
its own console window. Once enabled for a child process, it cannot be
disabled.


On non-Windows platforms, if options.detached is set to true, the child
process will be made the leader of a new process group and session. Note that
child processes may continue running after the parent exits regardless of
whether they are detached or not.  See setsid(2) for more information.


By default, the parent will wait for the detached child to exit. To prevent
the parent from waiting for a given child, use the child.unref() method.
Doing so will cause the parent's event loop to not include the child in its
reference count, allowing the parent to exit independently of the child, unless
there is an established IPC channel between the child and parent.


When using the detached option to start a long-running process, the process
will not stay running in the background after the parent exits unless it is
provided with a stdio configuration that is not connected to the parent.
If the parent's stdio is inherited, the child will remain attached to the
controlling terminal.


Example of a long-running process, by detaching and also ignoring its parent
stdio file descriptors, in order to ignore the parent's termination:


const spawn = require('child_process').spawn;

const child = spawn(process.argv[0], ['child_program.js'], {
  detached: true,
  stdio: 'ignore'
});

child.unref();



Alternatively one can redirect the child process' output into files:


const fs = require('fs');
const spawn = require('child_process').spawn;
const out = fs.openSync('./out.log', 'a');
const err = fs.openSync('./out.log', 'a');

const child = spawn('prg', [], {
 detached: true,
 stdio: [ 'ignore', out, err ]
});

child.unref();



options.stdio#



Added in: v0.7.10

The options.stdio option is used to configure the pipes that are established
between the parent and child process. By default, the child's stdin, stdout,
and stderr are redirected to corresponding child.stdin, child.stdout, and
child.stderr streams on the ChildProcess object. This is equivalent to
setting the options.stdio equal to ['pipe', 'pipe', 'pipe'].


For convenience, options.stdio may be one of the following strings:


    

  • 'pipe' - equivalent to ['pipe', 'pipe', 'pipe'] (the default)
    • 

  • 'ignore' - equivalent to ['ignore', 'ignore', 'ignore']
    • 

  • 'inherit' - equivalent to [process.stdin, process.stdout, process.stderr]
 or [0,1,2]
    • 



Otherwise, the value of option.stdio is an array where each index corresponds
to an fd in the child. The fds 0, 1, and 2 correspond to stdin, stdout,
and stderr, respectively. Additional fds can be specified to create additional
pipes between the parent and child. The value is one of the following:


    

  1. 'pipe' - Create a pipe between the child process and the parent process.
The parent end of the pipe is exposed to the parent as a property on the
child_process object as ChildProcess.stdio[fd]. Pipes created for
fds 0 - 2 are also available as ChildProcess.stdin, ChildProcess.stdout
and ChildProcess.stderr, respectively.
    2. 

  2. 'ipc' - Create an IPC channel for passing messages/file descriptors
between parent and child. A ChildProcess may have at most one IPC stdio
file descriptor. Setting this option enables the ChildProcess.send() method.
If the child writes JSON messages to this file descriptor, the
ChildProcess.on('message') event handler will be triggered in the parent.
If the child is a Node.js process, the presence of an IPC channel will enable
process.send(), process.disconnect(), process.on('disconnect'), and
process.on('message') within the child.
    3. 

  3. 'ignore' - Instructs Node.js to ignore the fd in the child. While Node.js
will always open fds 0 - 2 for the processes it spawns, setting the fd to
'ignore' will cause Node.js to open /dev/null and attach it to the
child's fd.
    4. 

  4. Stream object - Share a readable or writable stream that refers to a tty,
file, socket, or a pipe with the child process. The stream's underlying
file descriptor is duplicated in the child process to the fd that
corresponds to the index in the stdio array. Note that the stream must
have an underlying descriptor (file streams do not until the 'open'
event has occurred).
    5. 

  5. Positive integer - The integer value is interpreted as a file descriptor
that is is currently open in the parent process. It is shared with the child
process, similar to how Stream objects can be shared.
    6. 

  6. null, undefined - Use default value. For stdio fds 0, 1 and 2 (in other
words, stdin, stdout, and stderr) a pipe is created. For fd 3 and up, the
default is 'ignore'.
    7. 



Example:


const spawn = require('child_process').spawn;

// Child will use parent's stdios
spawn('prg', [], { stdio: 'inherit' });

// Spawn child sharing only stderr
spawn('prg', [], { stdio: ['pipe', 'pipe', process.stderr] });

// Open an extra fd=4, to interact with programs presenting a
// startd-style interface.
spawn('prg', [], { stdio: ['pipe', null, null, null, 'pipe'] });



It is worth noting that when an IPC channel is established between the
parent and child processes, and the child is a Node.js process, the child
is launched with the IPC channel unreferenced (using unref()) until the
child registers an event handler for the process.on('disconnect') event
or the process.on('message') event.This allows the child to exit normally
without the process being held open by the open IPC channel.


See also: child_process.exec() and child_process.fork()


Synchronous Process Creation#


The child_process.spawnSync(), child_process.execSync(), and
child_process.execFileSync() methods are synchronous and WILL block
the Node.js event loop, pausing execution of any additional code until the
spawned process exits.


Blocking calls like these are mostly useful for simplifying general purpose
scripting tasks and for simplifying the loading/processing of application
configuration at startup.


child_process.execFileSync(file[, args][, options])#



Added in: v0.11.12

    

  • file <String> The name or path of the executable file to run
    • 

  • args <Array> List of string arguments
    • 

  • options <Object>
      

    • cwd <String> Current working directory of the child process
      • 

    • input <String> | <Buffer> The value which will be passed as stdin to the spawned process
        

      • supplying this value will override stdio[0]
        • 

      

      • 

    • stdio <String> | <Array> Child's stdio configuration. (Default: 'pipe')
        

      • stderr by default will be output to the parent process' stderr unless
stdio is specified
        • 

      

      • 

    • env <Object> Environment key-value pairs
      • 

    • uid <Number> Sets the user identity of the process. (See setuid(2).)
      • 

    • gid <Number> Sets the group identity of the process. (See setgid(2).)
      • 

    • timeout <Number> In milliseconds the maximum amount of time the process is allowed to run. (Default: undefined)
      • 

    • killSignal <String> | <Integer> The signal value to be used when the spawned process will be killed. (Default: 'SIGTERM')
      • 

    • maxBuffer <Number> largest amount of data (in bytes) allowed on stdout or
stderr - if exceeded child process is killed
      • 

    • encoding <String> The encoding used for all stdio inputs and outputs. (Default: 'buffer')
      • 

    

    • 

  • Returns: <Buffer> | <String> The stdout from the command
    • 



The child_process.execFileSync() method is generally identical to
child_process.execFile() with the exception that the method will not return
until the child process has fully closed. When a timeout has been encountered
and killSignal is sent, the method won't return until the process has
completely exited. Note that if the child process intercepts and handles
the SIGTERM signal and does not exit, the parent process will still wait
until the child process has exited.


If the process times out, or has a non-zero exit code, this method will
throw.  The Error object will contain the entire result from
child_process.spawnSync()


child_process.execSync(command[, options])#



Added in: v0.11.12

    

  • command <String> The command to run
    • 

  • options <Object>
      

    • cwd <String> Current working directory of the child process
      • 

    • input <String> | <Buffer> The value which will be passed as stdin to the spawned process
        

      • supplying this value will override stdio[0]
        • 

      

      • 

    • stdio <String> | <Array> Child's stdio configuration. (Default: 'pipe')
        

      • stderr by default will be output to the parent process' stderr unless
stdio is specified
        • 

      

      • 

    • env <Object> Environment key-value pairs
      • 

    • shell <String> Shell to execute the command with
(Default: '/bin/sh' on UNIX, 'cmd.exe' on Windows,  The shell should
 understand the -c switch on UNIX or /s /c on Windows. On Windows,
 command line parsing should be compatible with cmd.exe.)
      • 

    • uid <Number> Sets the user identity of the process. (See setuid(2).)
      • 

    • gid <Number> Sets the group identity of the process. (See setgid(2).)
      • 

    • timeout <Number> In milliseconds the maximum amount of time the process is allowed to run. (Default: undefined)
      • 

    • killSignal <String> | <Integer> The signal value to be used when the spawned process will be killed. (Default: 'SIGTERM')
      • 

    • maxBuffer <Number> largest amount of data (in bytes) allowed on stdout or
stderr - if exceeded child process is killed
      • 

    • encoding <String> The encoding used for all stdio inputs and outputs. (Default: 'buffer')
      • 

    

    • 

  • Returns: <Buffer> | <String> The stdout from the command
    • 



The child_process.execSync() method is generally identical to
child_process.exec() with the exception that the method will not return until
the child process has fully closed. When a timeout has been encountered and
killSignal is sent, the method won't return until the process has completely
exited. Note that if  the child process intercepts and handles the SIGTERM
signal and doesn't exit, the parent process will wait until the child
process has exited.


If the process times out, or has a non-zero exit code, this method will
throw.  The Error object will contain the entire result from
child_process.spawnSync()


Note: Never pass unsanitised user input to this function. Any input
containing shell metacharacters may be used to trigger arbitrary command
execution.


child_process.spawnSync(command[, args][, options])#



Added in: v0.11.12

    

  • command <String> The command to run
    • 

  • args <Array> List of string arguments
    • 

  • options <Object>
      

    • cwd <String> Current working directory of the child process
      • 

    • input <String> | <Buffer> The value which will be passed as stdin to the spawned process
        

      • supplying this value will override stdio[0]
        • 

      

      • 

    • stdio <String> | <Array> Child's stdio configuration. (Default: 'pipe')
      • 

    • env <Object> Environment key-value pairs
      • 

    • uid <Number> Sets the user identity of the process. (See setuid(2).)
      • 

    • gid <Number> Sets the group identity of the process. (See setgid(2).)
      • 

    • timeout <Number> In milliseconds the maximum amount of time the process is allowed to run. (Default: undefined)
      • 

    • killSignal <String> | <Integer> The signal value to be used when the spawned process will be killed. (Default: 'SIGTERM')
      • 

    • maxBuffer <Number> largest amount of data (in bytes) allowed on stdout or
stderr - if exceeded child process is killed
      • 

    • encoding <String> The encoding used for all stdio inputs and outputs. (Default: 'buffer')
      • 

    • shell <Boolean> | <String> If true, runs command inside of a shell. Uses
'/bin/sh' on UNIX, and 'cmd.exe' on Windows. A different shell can be
specified as a string. The shell should understand the -c switch on UNIX,
or /s /c on Windows. Defaults to false (no shell).
      • 

    

    • 

  • Returns: <Object>
      

    • pid <Number> Pid of the child process
      • 

    • output <Array> Array of results from stdio output
      • 

    • stdout <Buffer> | <String> The contents of output[1]
      • 

    • stderr <Buffer> | <String> The contents of output[2]
      • 

    • status <Number> The exit code of the child process
      • 

    • signal <String> The signal used to kill the child process
      • 

    • error <Error> The error object if the child process failed or timed out
      • 

    

    • 



The child_process.spawnSync() method is generally identical to
child_process.spawn() with the exception that the function will not return
until the child process has fully closed. When a timeout has been encountered
and killSignal is sent, the method won't return until the process has
completely exited. Note that if the process intercepts and handles the
SIGTERM signal and doesn't exit, the parent process will wait until the child
process has exited.


Note: If the shell option is enabled, do not pass unsanitised user input to
this function. Any input containing shell metacharacters may be used to
trigger arbitrary command execution.


Class: ChildProcess#



Added in: v2.2.0

Instances of the ChildProcess class are EventEmitters that represent
spawned child processes.


Instances of ChildProcess are not intended to be created directly. Rather,
use the child_process.spawn(), child_process.exec(),
child_process.execFile(), or child_process.fork() methods to create
instances of ChildProcess.


Event: 'close'#



Added in: v0.7.7

    

  • code <Number> the exit code if the child exited on its own.
    • 

  • signal <String> the signal by which the child process was terminated.
    • 



The 'close' event is emitted when the stdio streams of a child process have
been closed. This is distinct from the 'exit' event, since multiple
processes might share the same stdio streams.


Event: 'disconnect'#



Added in: v0.7.2

The 'disconnect' event is emitted after calling the
ChildProcess.disconnect() method in the parent or child process. After
disconnecting it is no longer possible to send or receive messages, and the
ChildProcess.connected property is false.


Event: 'error'#




The 'error' event is emitted whenever:


    

  1. The process could not be spawned, or
    2. 

  2. The process could not be killed, or
    3. 

  3. Sending a message to the child process failed.
    4. 



Note that the 'exit' event may or may not fire after an error has occurred.
If you are listening to both the 'exit' and 'error' events, it is important
to guard against accidentally invoking handler functions multiple times.


See also ChildProcess#kill() and ChildProcess#send().


Event: 'exit'#



Added in: v0.1.90

    

  • code <Number> the exit code if the child exited on its own.
    • 

  • signal <String> the signal by which the child process was terminated.
    • 



The 'exit' event is emitted after the child process ends. If the process
exited, code is the final exit code of the process, otherwise null. If the
process terminated due to receipt of a signal, signal is the string name of
the signal, otherwise null. One of the two will always be non-null.


Note that when the 'exit' event is triggered, child process stdio streams
might still be open.


Also, note that Node.js establishes signal handlers for SIGINT and
SIGTERM and Node.js processes will not terminate immediately due to receipt
of those signals. Rather, Node.js will perform a sequence of cleanup actions
and then will re-raise the handled signal.


See waitpid(2).


Event: 'message'#



Added in: v0.5.9



The 'message' event is triggered when a child process uses process.send()
to send messages.


child.connected#



Added in: v0.7.2

    

  • <Boolean> Set to false after .disconnect is called
    • 



The child.connected property indicates whether it is still possible to send
and receive messages from a child process. When child.connected is false, it
is no longer possible to send or receive messages.


child.disconnect()#



Added in: v0.7.2

Closes the IPC channel between parent and child, allowing the child to exit
gracefully once there are no other connections keeping it alive. After calling
this method the child.connected and process.connected properties in both
the parent and child (respectively) will be set to false, and it will be no
longer possible to pass messages between the processes.


The 'disconnect' event will be emitted when there are no messages in the
process of being received. This will most often be triggered immediately after
calling child.disconnect().


Note that when the child process is a Node.js instance (e.g. spawned using
child_process.fork()), the process.disconnect() method can be invoked
within the child process to close the IPC channel as well.


child.kill([signal])#



Added in: v0.1.90



The child.kill() methods sends a signal to the child process. If no argument
is given, the process will be sent the 'SIGTERM' signal. See signal(7) for
a list of available signals.


const spawn = require('child_process').spawn;
const grep = spawn('grep', ['ssh']);

grep.on('close', (code, signal) => {
  console.log(
    `child process terminated due to receipt of signal ${signal}`);
});

// Send SIGHUP to process
grep.kill('SIGHUP');



The ChildProcess object may emit an 'error' event if the signal cannot be
delivered. Sending a signal to a child process that has already exited is not
an error but may have unforeseen consequences. Specifically, if the process
identifier (PID) has been reassigned to another process, the signal will be
delivered to that process instead which can have unexpected results.


Note that while the function is called kill, the signal delivered to the
child process may not actually terminate the process.


See kill(2) for reference.


Also note: on Linux, child processes of child processes will not be terminated
when attempting to kill their parent. This is likely to happen when running a
new process in a shell or with use of the shell option of ChildProcess, such
as in this example:


'use strict';
const spawn = require('child_process').spawn;

let child = spawn('sh', ['-c',
  `node -e "setInterval(() => {
      console.log(process.pid, 'is alive')
    }, 500);"`
  ], {
    stdio: ['inherit', 'inherit', 'inherit']
  });

setTimeout(() => {
  child.kill(); // does not terminate the node process in the shell
}, 2000);



child.pid#



Added in: v0.1.90



Returns the process identifier (PID) of the child process.


Example:


const spawn = require('child_process').spawn;
const grep = spawn('grep', ['ssh']);

console.log(`Spawned child pid: ${grep.pid}`);
grep.stdin.end();



child.send(message[, sendHandle][, callback])#



Added in: v0.5.9



When an IPC channel has been established between the parent and child (
i.e. when using child_process.fork()), the child.send() method can be
used to send messages to the child process. When the child process is a Node.js
instance, these messages can be received via the process.on('message') event.


For example, in the parent script:


const cp = require('child_process');
const n = cp.fork(`${__dirname}/sub.js`);

n.on('message', (m) => {
  console.log('PARENT got message:', m);
});

n.send({ hello: 'world' });



And then the child script, 'sub.js' might look like this:


process.on('message', (m) => {
  console.log('CHILD got message:', m);
});

process.send({ foo: 'bar' });



Child Node.js processes will have a process.send() method of their own that
allows the child to send messages back to the parent.


There is a special case when sending a {cmd: 'NODE_foo'} message. All messages
containing a NODE_ prefix in its cmd property are considered to be reserved
for use within Node.js core and will not be emitted in the child's
process.on('message') event. Rather, such messages are emitted using the
process.on('internalMessage') event and are consumed internally by Node.js.
Applications should avoid using such messages or listening for
'internalMessage' events as it is subject to change without notice.


The optional sendHandle argument that may be passed to child.send() is for
passing a TCP server or socket object to the child process. The child will
receive the object as the second argument passed to the callback function
registered on the process.on('message') event. Any data that is received and
buffered in the socket will not be sent to the child.


The optional callback is a function that is invoked after the message is
sent but before the child may have received it.  The function is called with a
single argument: null on success, or an Error object on failure.


If no callback function is provided and the message cannot be sent, an
'error' event will be emitted by the ChildProcess object. This can happen,
for instance, when the child process has already exited.


child.send() will return false if the channel has closed or when the
backlog of unsent messages exceeds a threshold that makes it unwise to send
more. Otherwise, the method returns true. The callback function can be
used to implement flow control.


Example: sending a server object#


The sendHandle argument can be used, for instance, to pass the handle of
a TCP server object to the child process as illustrated in the example below:


const child = require('child_process').fork('child.js');

// Open up the server object and send the handle.
const server = require('net').createServer();
server.on('connection', (socket) => {
  socket.end('handled by parent');
});
server.listen(1337, () => {
  child.send('server', server);
});



The child would then receive the server object as:


process.on('message', (m, server) => {
  if (m === 'server') {
    server.on('connection', (socket) => {
      socket.end('handled by child');
    });
  }
});



Once the server is now shared between the parent and child, some connections
can be handled by the parent and some by the child.


While the example above uses a server created using the net module, dgram
module servers use exactly the same workflow with the exceptions of listening on
a 'message' event instead of 'connection' and using server.bind instead of
server.listen. This is, however, currently only supported on UNIX platforms.


Example: sending a socket object#


Similarly, the sendHandler argument can be used to pass the handle of a
socket to the child process. The example below spawns two children that each
handle connections with "normal" or "special" priority:


const normal = require('child_process').fork('child.js', ['normal']);
const special = require('child_process').fork('child.js', ['special']);

// Open up the server and send sockets to child
const server = require('net').createServer();
server.on('connection', (socket) => {

  // If this is special priority
  if (socket.remoteAddress === '74.125.127.100') {
    special.send('socket', socket);
    return;
  }
  // This is normal priority
  normal.send('socket', socket);
});
server.listen(1337);



The child.js would receive the socket handle as the second argument passed
to the event callback function:


process.on('message', (m, socket) => {
  if (m === 'socket') {
    socket.end(`Request handled with ${process.argv[2]} priority`);
  }
});



Once a socket has been passed to a child, the parent is no longer capable of
tracking when the socket is destroyed. To indicate this, the .connections
property becomes null. It is recommended not to use .maxConnections when
this occurs.


Note: this function uses JSON.stringify() internally to serialize the message.


child.stderr#



Added in: v0.1.90



A Readable Stream that represents the child process's stderr.


If the child was spawned with stdio[2] set to anything other than 'pipe',
then this will be undefined.


child.stderr is an alias for child.stdio[2]. Both properties will refer to
the same value.


child.stdin#



Added in: v0.1.90



A Writable Stream that represents the child process's stdin.


Note that if a child process waits to read all of its input, the child will not
continue until this stream has been closed via end().


If the child was spawned with stdio[0] set to anything other than 'pipe',
then this will be undefined.


child.stdin is an alias for child.stdio[0]. Both properties will refer to
the same value.


child.stdio#



Added in: v0.7.10



A sparse array of pipes to the child process, corresponding with positions in
the stdio option passed to child_process.spawn() that have been set
to the value 'pipe'. Note that child.stdio[0], child.stdio[1], and
child.stdio[2] are also available as child.stdin, child.stdout, and
child.stderr, respectively.


In the following example, only the child's fd 1 (stdout) is configured as a
pipe, so only the parent's child.stdio[1] is a stream, all other values in
the array are null.


const assert = require('assert');
const fs = require('fs');
const child_process = require('child_process');

const child = child_process.spawn('ls', {
    stdio: [
      0, // Use parents stdin for child
      'pipe', // Pipe child's stdout to parent
      fs.openSync('err.out', 'w') // Direct child's stderr to a file
    ]
});

assert.equal(child.stdio[0], null);
assert.equal(child.stdio[0], child.stdin);

assert(child.stdout);
assert.equal(child.stdio[1], child.stdout);

assert.equal(child.stdio[2], null);
assert.equal(child.stdio[2], child.stderr);



child.stdout#



Added in: v0.1.90



A Readable Stream that represents the child process's stdout.


If the child was spawned with stdio[1] set to anything other than 'pipe',
then this will be undefined.


child.stdout is an alias for child.stdio[1]. Both properties will refer
to the same value.


      

    

  

  
  
  
  



node-v4.8.2/doc/api/child_process.json000644 000766 000024 00000264143 13070706740 020020 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/child_process.md",
  "modules": [
    {
      "textRaw": "Child Process",
      "name": "child_process",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
The child_process module provides the ability to spawn child processes in\na manner that is similar, but not identical, to popen(3). This capability\nis primarily provided by the child_process.spawn() function:
\n
const spawn = require('child_process').spawn;\nconst ls = spawn('ls', ['-lh', '/usr']);\n\nls.stdout.on('data', (data) => {\n  console.log(`stdout: ${data}`);\n});\n\nls.stderr.on('data', (data) => {\n  console.log(`stderr: ${data}`);\n});\n\nls.on('close', (code) => {\n  console.log(`child process exited with code ${code}`);\n});\n
\n
By default, pipes for stdin, stdout and stderr are established between\nthe parent Node.js process and the spawned child. It is possible to stream data\nthrough these pipes in a non-blocking way. Note, however, that some programs\nuse line-buffered I/O internally. While that does not affect Node.js, it can\nmean that data sent to the child process may not be immediately consumed.
\n
The child_process.spawn() method spawns the child process asynchronously,\nwithout blocking the Node.js event loop. The child_process.spawnSync()\nfunction provides equivalent functionality in a synchronous manner that blocks\nthe event loop until the spawned process either exits or is terminated.
\n
For convenience, the child_process module provides a handful of synchronous\nand asynchronous alternatives to child_process.spawn() and\nchild_process.spawnSync().  Note that each of these alternatives are\nimplemented on top of child_process.spawn() or child_process.spawnSync().
\n
    \n
  • child_process.exec(): spawns a shell and runs a command within that shell,\npassing the stdout and stderr to a callback function when complete.
    • \n
  • child_process.execFile(): similar to child_process.exec() except that\nit spawns the command directly without first spawning a shell.
    • \n
  • child_process.fork(): spawns a new Node.js process and invokes a\nspecified module with an IPC communication channel established that allows\nsending messages between parent and child.
    • \n
  • child_process.execSync(): a synchronous version of\nchild_process.exec() that will block the Node.js event loop.
    • \n
  • child_process.execFileSync(): a synchronous version of\nchild_process.execFile() that will block the Node.js event loop.
    • \n
\n
For certain use cases, such as automating shell scripts, the\nsynchronous counterparts may be more convenient. In many cases, however,\nthe synchronous methods can have significant impact on performance due to\nstalling the event loop while spawned processes complete.
\n",
      "modules": [
        {
          "textRaw": "Asynchronous Process Creation",
          "name": "asynchronous_process_creation",
          "desc": "
The child_process.spawn(), child_process.fork(), child_process.exec(),\nand child_process.execFile() methods all follow the idiomatic asynchronous\nprogramming pattern typical of other Node.js APIs.
\n
Each of the methods returns a ChildProcess instance. These objects\nimplement the Node.js EventEmitter API, allowing the parent process to\nregister listener functions that are called when certain events occur during\nthe life cycle of the child process.
\n
The child_process.exec() and child_process.execFile() methods additionally\nallow for an optional callback function to be specified that is invoked\nwhen the child process terminates.
\n",
          "modules": [
            {
              "textRaw": "Spawning `.bat` and `.cmd` files on Windows",
              "name": "spawning_`.bat`_and_`.cmd`_files_on_windows",
              "desc": "
The importance of the distinction between child_process.exec() and\nchild_process.execFile() can vary based on platform. On Unix-type operating\nsystems (Unix, Linux, OSX) child_process.execFile() can be more efficient\nbecause it does not spawn a shell. On Windows, however, .bat and .cmd\nfiles are not executable on their own without a terminal, and therefore cannot\nbe launched using child_process.execFile(). When running on Windows, .bat\nand .cmd files can be invoked using child_process.spawn() with the shell\noption set, with child_process.exec(), or by spawning cmd.exe and passing\nthe .bat or .cmd file as an argument (which is what the shell option and\nchild_process.exec() do).
\n
// On Windows Only ...\nconst spawn = require('child_process').spawn;\nconst bat = spawn('cmd.exe', ['/c', 'my.bat']);\n\nbat.stdout.on('data', (data) => {\n  console.log(data);\n});\n\nbat.stderr.on('data', (data) => {\n  console.log(data);\n});\n\nbat.on('exit', (code) => {\n  console.log(`Child exited with code ${code}`);\n});\n\n// OR...\nconst exec = require('child_process').exec;\nexec('my.bat', (err, stdout, stderr) => {\n  if (err) {\n    console.error(err);\n    return;\n  }\n  console.log(stdout);\n});\n
\n",
              "type": "module",
              "displayName": "Spawning `.bat` and `.cmd` files on Windows"
            }
          ],
          "methods": [
            {
              "textRaw": "child_process.exec(command[, options][, callback])",
              "type": "method",
              "name": "exec",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {ChildProcess} ",
                    "name": "return",
                    "type": "ChildProcess"
                  },
                  "params": [
                    {
                      "textRaw": "`command` {String} The command to run, with space-separated arguments ",
                      "name": "command",
                      "type": "String",
                      "desc": "The command to run, with space-separated arguments"
                    },
                    {
                      "textRaw": "`options` {Object} ",
                      "options": [
                        {
                          "textRaw": "`cwd` {String} Current working directory of the child process ",
                          "name": "cwd",
                          "type": "String",
                          "desc": "Current working directory of the child process"
                        },
                        {
                          "textRaw": "`env` {Object} Environment key-value pairs ",
                          "name": "env",
                          "type": "Object",
                          "desc": "Environment key-value pairs"
                        },
                        {
                          "textRaw": "`encoding` {String} (Default: 'utf8') ",
                          "name": "encoding",
                          "default": "utf8",
                          "type": "String"
                        },
                        {
                          "textRaw": "`shell` {String} Shell to execute the command with (Default: '/bin/sh' on UNIX, 'cmd.exe' on Windows,  The shell should  understand the `-c` switch on UNIX or `/s /c` on Windows. On Windows,  command line parsing should be compatible with `cmd.exe`.) ",
                          "name": "shell",
                          "type": "String",
                          "desc": "Shell to execute the command with (Default: '/bin/sh' on UNIX, 'cmd.exe' on Windows,  The shell should  understand the `-c` switch on UNIX or `/s /c` on Windows. On Windows,  command line parsing should be compatible with `cmd.exe`.)"
                        },
                        {
                          "textRaw": "`timeout` {Number} (Default: 0) ",
                          "name": "timeout",
                          "default": "0",
                          "type": "Number"
                        },
                        {
                          "textRaw": "`maxBuffer` {Number} largest amount of data (in bytes) allowed on stdout or stderr - if exceeded child process is killed (Default: `200*1024`) ",
                          "name": "maxBuffer",
                          "default": "200*1024",
                          "type": "Number",
                          "desc": "largest amount of data (in bytes) allowed on stdout or stderr - if exceeded child process is killed"
                        },
                        {
                          "textRaw": "`killSignal` {String|Integer} (Default: 'SIGTERM') ",
                          "name": "killSignal",
                          "default": "SIGTERM",
                          "type": "String|Integer"
                        },
                        {
                          "textRaw": "`uid` {Number} Sets the user identity of the process. (See setuid(2).) ",
                          "name": "uid",
                          "type": "Number",
                          "desc": "Sets the user identity of the process. (See setuid(2).)"
                        },
                        {
                          "textRaw": "`gid` {Number} Sets the group identity of the process. (See setgid(2).) ",
                          "name": "gid",
                          "type": "Number",
                          "desc": "Sets the group identity of the process. (See setgid(2).)"
                        }
                      ],
                      "name": "options",
                      "type": "Object",
                      "optional": true
                    },
                    {
                      "textRaw": "`callback` {Function} called with the output when process terminates ",
                      "options": [
                        {
                          "textRaw": "`error` {Error} ",
                          "name": "error",
                          "type": "Error"
                        },
                        {
                          "textRaw": "`stdout` {String|Buffer} ",
                          "name": "stdout",
                          "type": "String|Buffer"
                        },
                        {
                          "textRaw": "`stderr` {String|Buffer} ",
                          "name": "stderr",
                          "type": "String|Buffer"
                        }
                      ],
                      "name": "callback",
                      "type": "Function",
                      "desc": "called with the output when process terminates",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "command"
                    },
                    {
                      "name": "options",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Spawns a shell then executes the command within that shell, buffering any\ngenerated output.
\n
Note: Never pass unsanitised user input to this function. Any input\ncontaining shell metacharacters may be used to trigger arbitrary command\nexecution.
\n
const exec = require('child_process').exec;\nexec('cat *.js bad_file | wc -l', (error, stdout, stderr) => {\n  if (error) {\n    console.error(`exec error: ${error}`);\n    return;\n  }\n  console.log(`stdout: ${stdout}`);\n  console.log(`stderr: ${stderr}`);\n});\n
\n
If a callback function is provided, it is called with the arguments\n(error, stdout, stderr). On success, error will be null.  On error,\nerror will be an instance of Error. The error.code property will be\nthe exit code of the child process while error.signal will be set to the\nsignal that terminated the process. Any exit code other than 0 is considered\nto be an error.
\n
The stdout and stderr arguments passed to the callback will contain the\nstdout and stderr output of the child process. By default, Node.js will decode\nthe output as UTF-8 and pass strings to the callback. The encoding option\ncan be used to specify the character encoding used to decode the stdout and\nstderr output. If encoding is 'buffer', or an unrecognized character\nencoding, Buffer objects will be passed to the callback instead.
\n
The options argument may be passed as the second argument to customize how\nthe process is spawned. The default options are:
\n
{\n  encoding: 'utf8',\n  timeout: 0,\n  maxBuffer: 200*1024,\n  killSignal: 'SIGTERM',\n  cwd: null,\n  env: null\n}\n
\n
If timeout is greater than 0, the parent will send the the signal\nidentified by the killSignal property (the default is 'SIGTERM') if the\nchild runs longer than timeout milliseconds.
\n
The maxBuffer option specifies the largest amount of data (in bytes) allowed\non stdout or stderr - if this value is exceeded then the child process is\nterminated.
\n
Note: Unlike the exec() POSIX system call, child_process.exec() does not\nreplace the existing process and uses a shell to execute the command.
\n"
            },
            {
              "textRaw": "child_process.execFile(file[, args][, options][, callback])",
              "type": "method",
              "name": "execFile",
              "meta": {
                "added": [
                  "v0.1.91"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {ChildProcess} ",
                    "name": "return",
                    "type": "ChildProcess"
                  },
                  "params": [
                    {
                      "textRaw": "`file` {String} The name or path of the executable file to run ",
                      "name": "file",
                      "type": "String",
                      "desc": "The name or path of the executable file to run"
                    },
                    {
                      "textRaw": "`args` {Array} List of string arguments ",
                      "name": "args",
                      "type": "Array",
                      "desc": "List of string arguments",
                      "optional": true
                    },
                    {
                      "textRaw": "`options` {Object} ",
                      "options": [
                        {
                          "textRaw": "`cwd` {String} Current working directory of the child process ",
                          "name": "cwd",
                          "type": "String",
                          "desc": "Current working directory of the child process"
                        },
                        {
                          "textRaw": "`env` {Object} Environment key-value pairs ",
                          "name": "env",
                          "type": "Object",
                          "desc": "Environment key-value pairs"
                        },
                        {
                          "textRaw": "`encoding` {String} (Default: 'utf8') ",
                          "name": "encoding",
                          "default": "utf8",
                          "type": "String"
                        },
                        {
                          "textRaw": "`timeout` {Number} (Default: 0) ",
                          "name": "timeout",
                          "default": "0",
                          "type": "Number"
                        },
                        {
                          "textRaw": "`maxBuffer` {Number} largest amount of data (in bytes) allowed on stdout or stderr - if exceeded child process is killed (Default: 200\\*1024) ",
                          "name": "maxBuffer",
                          "default": "200\\*1024",
                          "type": "Number",
                          "desc": "largest amount of data (in bytes) allowed on stdout or stderr - if exceeded child process is killed"
                        },
                        {
                          "textRaw": "`killSignal` {String|Integer} (Default: 'SIGTERM') ",
                          "name": "killSignal",
                          "default": "SIGTERM",
                          "type": "String|Integer"
                        },
                        {
                          "textRaw": "`uid` {Number} Sets the user identity of the process. (See setuid(2).) ",
                          "name": "uid",
                          "type": "Number",
                          "desc": "Sets the user identity of the process. (See setuid(2).)"
                        },
                        {
                          "textRaw": "`gid` {Number} Sets the group identity of the process. (See setgid(2).) ",
                          "name": "gid",
                          "type": "Number",
                          "desc": "Sets the group identity of the process. (See setgid(2).)"
                        }
                      ],
                      "name": "options",
                      "type": "Object",
                      "optional": true
                    },
                    {
                      "textRaw": "`callback` {Function} called with the output when process terminates ",
                      "options": [
                        {
                          "textRaw": "`error` {Error} ",
                          "name": "error",
                          "type": "Error"
                        },
                        {
                          "textRaw": "`stdout` {String|Buffer} ",
                          "name": "stdout",
                          "type": "String|Buffer"
                        },
                        {
                          "textRaw": "`stderr` {String|Buffer} ",
                          "name": "stderr",
                          "type": "String|Buffer"
                        }
                      ],
                      "name": "callback",
                      "type": "Function",
                      "desc": "called with the output when process terminates",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "file"
                    },
                    {
                      "name": "args",
                      "optional": true
                    },
                    {
                      "name": "options",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
The child_process.execFile() function is similar to child_process.exec()\nexcept that it does not spawn a shell. Rather, the specified executable file\nis spawned directly as a new process making it slightly more efficient than\nchild_process.exec().
\n
The same options as child_process.exec() are supported. Since a shell is not\nspawned, behaviors such as I/O redirection and file globbing are not supported.
\n
const execFile = require('child_process').execFile;\nconst child = execFile('node', ['--version'], (error, stdout, stderr) => {\n  if (error) {\n    throw error;\n  }\n  console.log(stdout);\n});\n
\n
The stdout and stderr arguments passed to the callback will contain the\nstdout and stderr output of the child process. By default, Node.js will decode\nthe output as UTF-8 and pass strings to the callback. The encoding option\ncan be used to specify the character encoding used to decode the stdout and\nstderr output. If encoding is 'buffer', or an unrecognized character\nencoding, Buffer objects will be passed to the callback instead.
\n"
            },
            {
              "textRaw": "child_process.fork(modulePath[, args][, options])",
              "type": "method",
              "name": "fork",
              "meta": {
                "added": [
                  "v0.5.0"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {ChildProcess} ",
                    "name": "return",
                    "type": "ChildProcess"
                  },
                  "params": [
                    {
                      "textRaw": "`modulePath` {String} The module to run in the child ",
                      "name": "modulePath",
                      "type": "String",
                      "desc": "The module to run in the child"
                    },
                    {
                      "textRaw": "`args` {Array} List of string arguments ",
                      "name": "args",
                      "type": "Array",
                      "desc": "List of string arguments",
                      "optional": true
                    },
                    {
                      "textRaw": "`options` {Object} ",
                      "options": [
                        {
                          "textRaw": "`cwd` {String} Current working directory of the child process ",
                          "name": "cwd",
                          "type": "String",
                          "desc": "Current working directory of the child process"
                        },
                        {
                          "textRaw": "`env` {Object} Environment key-value pairs ",
                          "name": "env",
                          "type": "Object",
                          "desc": "Environment key-value pairs"
                        },
                        {
                          "textRaw": "`execPath` {String} Executable used to create the child process ",
                          "name": "execPath",
                          "type": "String",
                          "desc": "Executable used to create the child process"
                        },
                        {
                          "textRaw": "`execArgv` {Array} List of string arguments passed to the executable (Default: `process.execArgv`) ",
                          "name": "execArgv",
                          "default": "process.execArgv",
                          "type": "Array",
                          "desc": "List of string arguments passed to the executable"
                        },
                        {
                          "textRaw": "`silent` {Boolean} If true, stdin, stdout, and stderr of the child will be piped to the parent, otherwise they will be inherited from the parent, see the `'pipe'` and `'inherit'` options for [`child_process.spawn()`][]'s [`stdio`][] for more details (default is false) ",
                          "name": "silent",
                          "type": "Boolean",
                          "desc": "If true, stdin, stdout, and stderr of the child will be piped to the parent, otherwise they will be inherited from the parent, see the `'pipe'` and `'inherit'` options for [`child_process.spawn()`][]'s [`stdio`][] for more details (default is false)"
                        },
                        {
                          "textRaw": "`uid` {Number} Sets the user identity of the process. (See setuid(2).) ",
                          "name": "uid",
                          "type": "Number",
                          "desc": "Sets the user identity of the process. (See setuid(2).)"
                        },
                        {
                          "textRaw": "`gid` {Number} Sets the group identity of the process. (See setgid(2).) ",
                          "name": "gid",
                          "type": "Number",
                          "desc": "Sets the group identity of the process. (See setgid(2).)"
                        }
                      ],
                      "name": "options",
                      "type": "Object",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "modulePath"
                    },
                    {
                      "name": "args",
                      "optional": true
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
The child_process.fork() method is a special case of\nchild_process.spawn() used specifically to spawn new Node.js processes.\nLike child_process.spawn(), a ChildProcess object is returned. The returned\nChildProcess will have an additional communication channel built-in that\nallows messages to be passed back and forth between the parent and child. See\nChildProcess#send() for details.
\n
It is important to keep in mind that spawned Node.js child processes are\nindependent of the parent with exception of the IPC communication channel\nthat is established between the two. Each process has its own memory, with\ntheir own V8 instances. Because of the additional resource allocations\nrequired, spawning a large number of child Node.js processes is not\nrecommended.
\n
By default, child_process.fork() will spawn new Node.js instances using the\nprocess.execPath of the parent process. The execPath property in the\noptions object allows for an alternative execution path to be used.
\n
Node.js processes launched with a custom execPath will communicate with the\nparent process using the file descriptor (fd) identified using the\nenvironment variable NODE_CHANNEL_FD on the child process. The input and\noutput on this fd is expected to be line delimited JSON objects.
\n
Note: Unlike the fork() POSIX system call, child_process.fork() does\nnot clone the current process.
\n"
            },
            {
              "textRaw": "child_process.spawn(command[, args][, options])",
              "type": "method",
              "name": "spawn",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {ChildProcess} ",
                    "name": "return",
                    "type": "ChildProcess"
                  },
                  "params": [
                    {
                      "textRaw": "`command` {String} The command to run ",
                      "name": "command",
                      "type": "String",
                      "desc": "The command to run"
                    },
                    {
                      "textRaw": "`args` {Array} List of string arguments ",
                      "name": "args",
                      "type": "Array",
                      "desc": "List of string arguments",
                      "optional": true
                    },
                    {
                      "textRaw": "`options` {Object} ",
                      "options": [
                        {
                          "textRaw": "`cwd` {String} Current working directory of the child process ",
                          "name": "cwd",
                          "type": "String",
                          "desc": "Current working directory of the child process"
                        },
                        {
                          "textRaw": "`env` {Object} Environment key-value pairs ",
                          "name": "env",
                          "type": "Object",
                          "desc": "Environment key-value pairs"
                        },
                        {
                          "textRaw": "`stdio` {Array|String} Child's stdio configuration. (See [`options.stdio`][]) ",
                          "name": "stdio",
                          "type": "Array|String",
                          "desc": "Child's stdio configuration. (See [`options.stdio`][])"
                        },
                        {
                          "textRaw": "`detached` {Boolean} Prepare child to run independently of its parent process. Specific behavior depends on the platform, see [`options.detached`][]) ",
                          "name": "detached",
                          "type": "Boolean",
                          "desc": "Prepare child to run independently of its parent process. Specific behavior depends on the platform, see [`options.detached`][])"
                        },
                        {
                          "textRaw": "`uid` {Number} Sets the user identity of the process. (See setuid(2).) ",
                          "name": "uid",
                          "type": "Number",
                          "desc": "Sets the user identity of the process. (See setuid(2).)"
                        },
                        {
                          "textRaw": "`gid` {Number} Sets the group identity of the process. (See setgid(2).) ",
                          "name": "gid",
                          "type": "Number",
                          "desc": "Sets the group identity of the process. (See setgid(2).)"
                        },
                        {
                          "textRaw": "`shell` {Boolean|String} If `true`, runs `command` inside of a shell. Uses '/bin/sh' on UNIX, and 'cmd.exe' on Windows. A different shell can be specified as a string. The shell should understand the `-c` switch on UNIX, or `/s /c` on Windows. Defaults to `false` (no shell). ",
                          "name": "shell",
                          "type": "Boolean|String",
                          "desc": "If `true`, runs `command` inside of a shell. Uses '/bin/sh' on UNIX, and 'cmd.exe' on Windows. A different shell can be specified as a string. The shell should understand the `-c` switch on UNIX, or `/s /c` on Windows. Defaults to `false` (no shell)."
                        }
                      ],
                      "name": "options",
                      "type": "Object",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "command"
                    },
                    {
                      "name": "args",
                      "optional": true
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
The child_process.spawn() method spawns a new process using the given\ncommand, with command line arguments in args. If omitted, args defaults\nto an empty array.
\n
Note: If the shell option is enabled, do not pass unsanitised user input to\nthis function. Any input containing shell metacharacters may be used to\ntrigger arbitrary command execution.
\n
A third argument may be used to specify additional options, with these defaults:
\n
{\n  cwd: undefined,\n  env: process.env\n}\n
\n
Use cwd to specify the working directory from which the process is spawned.\nIf not given, the default is to inherit the current working directory.
\n
Use env to specify environment variables that will be visible to the new\nprocess, the default is process.env.
\n
Example of running ls -lh /usr, capturing stdout, stderr, and the\nexit code:
\n
const spawn = require('child_process').spawn;\nconst ls = spawn('ls', ['-lh', '/usr']);\n\nls.stdout.on('data', (data) => {\n  console.log(`stdout: ${data}`);\n});\n\nls.stderr.on('data', (data) => {\n  console.log(`stderr: ${data}`);\n});\n\nls.on('close', (code) => {\n  console.log(`child process exited with code ${code}`);\n});\n
\n
Example: A very elaborate way to run 'ps ax | grep ssh'
\n
const spawn = require('child_process').spawn;\nconst ps = spawn('ps', ['ax']);\nconst grep = spawn('grep', ['ssh']);\n\nps.stdout.on('data', (data) => {\n  grep.stdin.write(data);\n});\n\nps.stderr.on('data', (data) => {\n  console.log(`ps stderr: ${data}`);\n});\n\nps.on('close', (code) => {\n  if (code !== 0) {\n    console.log(`ps process exited with code ${code}`);\n  }\n  grep.stdin.end();\n});\n\ngrep.stdout.on('data', (data) => {\n  console.log(`${data}`);\n});\n\ngrep.stderr.on('data', (data) => {\n  console.log(`grep stderr: ${data}`);\n});\n\ngrep.on('close', (code) => {\n  if (code !== 0) {\n    console.log(`grep process exited with code ${code}`);\n  }\n});\n
\n
Example of checking for failed exec:
\n
const spawn = require('child_process').spawn;\nconst child = spawn('bad_command');\n\nchild.on('error', (err) => {\n  console.log('Failed to start child process.');\n});\n
\n",
              "properties": [
                {
                  "textRaw": "options.detached",
                  "name": "detached",
                  "meta": {
                    "added": [
                      "v0.7.10"
                    ]
                  },
                  "desc": "
On Windows, setting options.detached to true makes it possible for the\nchild process to continue running after the parent exits. The child will have\nits own console window. Once enabled for a child process, it cannot be\ndisabled.
\n
On non-Windows platforms, if options.detached is set to true, the child\nprocess will be made the leader of a new process group and session. Note that\nchild processes may continue running after the parent exits regardless of\nwhether they are detached or not.  See setsid(2) for more information.
\n
By default, the parent will wait for the detached child to exit. To prevent\nthe parent from waiting for a given child, use the child.unref() method.\nDoing so will cause the parent's event loop to not include the child in its\nreference count, allowing the parent to exit independently of the child, unless\nthere is an established IPC channel between the child and parent.
\n
When using the detached option to start a long-running process, the process\nwill not stay running in the background after the parent exits unless it is\nprovided with a stdio configuration that is not connected to the parent.\nIf the parent's stdio is inherited, the child will remain attached to the\ncontrolling terminal.
\n
Example of a long-running process, by detaching and also ignoring its parent\nstdio file descriptors, in order to ignore the parent's termination:
\n
const spawn = require('child_process').spawn;\n\nconst child = spawn(process.argv[0], ['child_program.js'], {\n  detached: true,\n  stdio: 'ignore'\n});\n\nchild.unref();\n
\n
Alternatively one can redirect the child process' output into files:
\n
const fs = require('fs');\nconst spawn = require('child_process').spawn;\nconst out = fs.openSync('./out.log', 'a');\nconst err = fs.openSync('./out.log', 'a');\n\nconst child = spawn('prg', [], {\n detached: true,\n stdio: [ 'ignore', out, err ]\n});\n\nchild.unref();\n
\n"
                },
                {
                  "textRaw": "options.stdio",
                  "name": "stdio",
                  "meta": {
                    "added": [
                      "v0.7.10"
                    ]
                  },
                  "desc": "
The options.stdio option is used to configure the pipes that are established\nbetween the parent and child process. By default, the child's stdin, stdout,\nand stderr are redirected to corresponding child.stdin, child.stdout, and\nchild.stderr streams on the ChildProcess object. This is equivalent to\nsetting the options.stdio equal to ['pipe', 'pipe', 'pipe'].
\n
For convenience, options.stdio may be one of the following strings:
\n
    \n
  • 'pipe' - equivalent to ['pipe', 'pipe', 'pipe'] (the default)
    • \n
  • 'ignore' - equivalent to ['ignore', 'ignore', 'ignore']
    • \n
  • 'inherit' - equivalent to [process.stdin, process.stdout, process.stderr]\n or [0,1,2]
    • \n
\n
Otherwise, the value of option.stdio is an array where each index corresponds\nto an fd in the child. The fds 0, 1, and 2 correspond to stdin, stdout,\nand stderr, respectively. Additional fds can be specified to create additional\npipes between the parent and child. The value is one of the following:
\n
    \n
  1. 'pipe' - Create a pipe between the child process and the parent process.\nThe parent end of the pipe is exposed to the parent as a property on the\nchild_process object as ChildProcess.stdio[fd]. Pipes created for\nfds 0 - 2 are also available as ChildProcess.stdin, ChildProcess.stdout\nand ChildProcess.stderr, respectively.
    2. \n
  2. 'ipc' - Create an IPC channel for passing messages/file descriptors\nbetween parent and child. A ChildProcess may have at most one IPC stdio\nfile descriptor. Setting this option enables the ChildProcess.send() method.\nIf the child writes JSON messages to this file descriptor, the\nChildProcess.on('message') event handler will be triggered in the parent.\nIf the child is a Node.js process, the presence of an IPC channel will enable\nprocess.send(), process.disconnect(), process.on('disconnect'), and\nprocess.on('message') within the child.
    3. \n
  3. 'ignore' - Instructs Node.js to ignore the fd in the child. While Node.js\nwill always open fds 0 - 2 for the processes it spawns, setting the fd to\n'ignore' will cause Node.js to open /dev/null and attach it to the\nchild's fd.
    4. \n
  4. Stream object - Share a readable or writable stream that refers to a tty,\nfile, socket, or a pipe with the child process. The stream's underlying\nfile descriptor is duplicated in the child process to the fd that\ncorresponds to the index in the stdio array. Note that the stream must\nhave an underlying descriptor (file streams do not until the 'open'\nevent has occurred).
    5. \n
  5. Positive integer - The integer value is interpreted as a file descriptor\nthat is is currently open in the parent process. It is shared with the child\nprocess, similar to how Stream objects can be shared.
    6. \n
  6. null, undefined - Use default value. For stdio fds 0, 1 and 2 (in other\nwords, stdin, stdout, and stderr) a pipe is created. For fd 3 and up, the\ndefault is 'ignore'.
    7. \n
\n
Example:
\n
const spawn = require('child_process').spawn;\n\n// Child will use parent's stdios\nspawn('prg', [], { stdio: 'inherit' });\n\n// Spawn child sharing only stderr\nspawn('prg', [], { stdio: ['pipe', 'pipe', process.stderr] });\n\n// Open an extra fd=4, to interact with programs presenting a\n// startd-style interface.\nspawn('prg', [], { stdio: ['pipe', null, null, null, 'pipe'] });\n
\n
It is worth noting that when an IPC channel is established between the\nparent and child processes, and the child is a Node.js process, the child\nis launched with the IPC channel unreferenced (using unref()) until the\nchild registers an event handler for the process.on('disconnect') event\nor the process.on('message') event.This allows the child to exit normally\nwithout the process being held open by the open IPC channel.
\n
See also: child_process.exec() and child_process.fork()
\n"
                }
              ]
            }
          ],
          "type": "module",
          "displayName": "Asynchronous Process Creation"
        },
        {
          "textRaw": "Synchronous Process Creation",
          "name": "synchronous_process_creation",
          "desc": "
The child_process.spawnSync(), child_process.execSync(), and\nchild_process.execFileSync() methods are synchronous and WILL block\nthe Node.js event loop, pausing execution of any additional code until the\nspawned process exits.
\n
Blocking calls like these are mostly useful for simplifying general purpose\nscripting tasks and for simplifying the loading/processing of application\nconfiguration at startup.
\n",
          "methods": [
            {
              "textRaw": "child_process.execFileSync(file[, args][, options])",
              "type": "method",
              "name": "execFileSync",
              "meta": {
                "added": [
                  "v0.11.12"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Buffer|String} The stdout from the command ",
                    "name": "return",
                    "type": "Buffer|String",
                    "desc": "The stdout from the command"
                  },
                  "params": [
                    {
                      "textRaw": "`file` {String} The name or path of the executable file to run ",
                      "name": "file",
                      "type": "String",
                      "desc": "The name or path of the executable file to run"
                    },
                    {
                      "textRaw": "`args` {Array} List of string arguments ",
                      "name": "args",
                      "type": "Array",
                      "desc": "List of string arguments",
                      "optional": true
                    },
                    {
                      "textRaw": "`options` {Object} ",
                      "options": [
                        {
                          "textRaw": "`cwd` {String} Current working directory of the child process ",
                          "name": "cwd",
                          "type": "String",
                          "desc": "Current working directory of the child process"
                        },
                        {
                          "textRaw": "`input` {String|Buffer} The value which will be passed as stdin to the spawned process ",
                          "options": [
                            {
                              "textRaw": "supplying this value will override `stdio[0]` ",
                              "name": "supplying",
                              "desc": "this value will override `stdio[0]`"
                            }
                          ],
                          "name": "input",
                          "type": "String|Buffer",
                          "desc": "The value which will be passed as stdin to the spawned process"
                        },
                        {
                          "textRaw": "`stdio` {String|Array} Child's stdio configuration. (Default: 'pipe') ",
                          "options": [
                            {
                              "textRaw": "`stderr` by default will be output to the parent process' stderr unless `stdio` is specified ",
                              "name": "stderr",
                              "desc": "by default will be output to the parent process' stderr unless `stdio` is specified"
                            }
                          ],
                          "name": "stdio",
                          "default": "pipe",
                          "type": "String|Array",
                          "desc": "Child's stdio configuration."
                        },
                        {
                          "textRaw": "`env` {Object} Environment key-value pairs ",
                          "name": "env",
                          "type": "Object",
                          "desc": "Environment key-value pairs"
                        },
                        {
                          "textRaw": "`uid` {Number} Sets the user identity of the process. (See setuid(2).) ",
                          "name": "uid",
                          "type": "Number",
                          "desc": "Sets the user identity of the process. (See setuid(2).)"
                        },
                        {
                          "textRaw": "`gid` {Number} Sets the group identity of the process. (See setgid(2).) ",
                          "name": "gid",
                          "type": "Number",
                          "desc": "Sets the group identity of the process. (See setgid(2).)"
                        },
                        {
                          "textRaw": "`timeout` {Number} In milliseconds the maximum amount of time the process is allowed to run. (Default: undefined) ",
                          "name": "timeout",
                          "default": "undefined",
                          "type": "Number",
                          "desc": "In milliseconds the maximum amount of time the process is allowed to run."
                        },
                        {
                          "textRaw": "`killSignal` {String|Integer} The signal value to be used when the spawned process will be killed. (Default: 'SIGTERM') ",
                          "name": "killSignal",
                          "default": "SIGTERM",
                          "type": "String|Integer",
                          "desc": "The signal value to be used when the spawned process will be killed."
                        },
                        {
                          "textRaw": "`maxBuffer` {Number} largest amount of data (in bytes) allowed on stdout or stderr - if exceeded child process is killed ",
                          "name": "maxBuffer",
                          "type": "Number",
                          "desc": "largest amount of data (in bytes) allowed on stdout or stderr - if exceeded child process is killed"
                        },
                        {
                          "textRaw": "`encoding` {String} The encoding used for all stdio inputs and outputs. (Default: 'buffer') ",
                          "name": "encoding",
                          "default": "buffer",
                          "type": "String",
                          "desc": "The encoding used for all stdio inputs and outputs."
                        }
                      ],
                      "name": "options",
                      "type": "Object",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "file"
                    },
                    {
                      "name": "args",
                      "optional": true
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
The child_process.execFileSync() method is generally identical to\nchild_process.execFile() with the exception that the method will not return\nuntil the child process has fully closed. When a timeout has been encountered\nand killSignal is sent, the method won't return until the process has\ncompletely exited. Note that if the child process intercepts and handles\nthe SIGTERM signal and does not exit, the parent process will still wait\nuntil the child process has exited.
\n
If the process times out, or has a non-zero exit code, this method will\nthrow.  The Error object will contain the entire result from\nchild_process.spawnSync()
\n"
            },
            {
              "textRaw": "child_process.execSync(command[, options])",
              "type": "method",
              "name": "execSync",
              "meta": {
                "added": [
                  "v0.11.12"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Buffer|String} The stdout from the command ",
                    "name": "return",
                    "type": "Buffer|String",
                    "desc": "The stdout from the command"
                  },
                  "params": [
                    {
                      "textRaw": "`command` {String} The command to run ",
                      "name": "command",
                      "type": "String",
                      "desc": "The command to run"
                    },
                    {
                      "textRaw": "`options` {Object} ",
                      "options": [
                        {
                          "textRaw": "`cwd` {String} Current working directory of the child process ",
                          "name": "cwd",
                          "type": "String",
                          "desc": "Current working directory of the child process"
                        },
                        {
                          "textRaw": "`input` {String|Buffer} The value which will be passed as stdin to the spawned process ",
                          "options": [
                            {
                              "textRaw": "supplying this value will override `stdio[0]` ",
                              "name": "supplying",
                              "desc": "this value will override `stdio[0]`"
                            }
                          ],
                          "name": "input",
                          "type": "String|Buffer",
                          "desc": "The value which will be passed as stdin to the spawned process"
                        },
                        {
                          "textRaw": "`stdio` {String|Array} Child's stdio configuration. (Default: 'pipe') ",
                          "options": [
                            {
                              "textRaw": "`stderr` by default will be output to the parent process' stderr unless `stdio` is specified ",
                              "name": "stderr",
                              "desc": "by default will be output to the parent process' stderr unless `stdio` is specified"
                            }
                          ],
                          "name": "stdio",
                          "default": "pipe",
                          "type": "String|Array",
                          "desc": "Child's stdio configuration."
                        },
                        {
                          "textRaw": "`env` {Object} Environment key-value pairs ",
                          "name": "env",
                          "type": "Object",
                          "desc": "Environment key-value pairs"
                        },
                        {
                          "textRaw": "`shell` {String} Shell to execute the command with (Default: '/bin/sh' on UNIX, 'cmd.exe' on Windows,  The shell should  understand the `-c` switch on UNIX or `/s /c` on Windows. On Windows,  command line parsing should be compatible with `cmd.exe`.) ",
                          "name": "shell",
                          "type": "String",
                          "desc": "Shell to execute the command with (Default: '/bin/sh' on UNIX, 'cmd.exe' on Windows,  The shell should  understand the `-c` switch on UNIX or `/s /c` on Windows. On Windows,  command line parsing should be compatible with `cmd.exe`.)"
                        },
                        {
                          "textRaw": "`uid` {Number} Sets the user identity of the process. (See setuid(2).) ",
                          "name": "uid",
                          "type": "Number",
                          "desc": "Sets the user identity of the process. (See setuid(2).)"
                        },
                        {
                          "textRaw": "`gid` {Number} Sets the group identity of the process. (See setgid(2).) ",
                          "name": "gid",
                          "type": "Number",
                          "desc": "Sets the group identity of the process. (See setgid(2).)"
                        },
                        {
                          "textRaw": "`timeout` {Number} In milliseconds the maximum amount of time the process is allowed to run. (Default: undefined) ",
                          "name": "timeout",
                          "default": "undefined",
                          "type": "Number",
                          "desc": "In milliseconds the maximum amount of time the process is allowed to run."
                        },
                        {
                          "textRaw": "`killSignal` {String|Integer} The signal value to be used when the spawned process will be killed. (Default: 'SIGTERM') ",
                          "name": "killSignal",
                          "default": "SIGTERM",
                          "type": "String|Integer",
                          "desc": "The signal value to be used when the spawned process will be killed."
                        },
                        {
                          "textRaw": "`maxBuffer` {Number} largest amount of data (in bytes) allowed on stdout or stderr - if exceeded child process is killed ",
                          "name": "maxBuffer",
                          "type": "Number",
                          "desc": "largest amount of data (in bytes) allowed on stdout or stderr - if exceeded child process is killed"
                        },
                        {
                          "textRaw": "`encoding` {String} The encoding used for all stdio inputs and outputs. (Default: 'buffer') ",
                          "name": "encoding",
                          "default": "buffer",
                          "type": "String",
                          "desc": "The encoding used for all stdio inputs and outputs."
                        }
                      ],
                      "name": "options",
                      "type": "Object",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "command"
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
The child_process.execSync() method is generally identical to\nchild_process.exec() with the exception that the method will not return until\nthe child process has fully closed. When a timeout has been encountered and\nkillSignal is sent, the method won't return until the process has completely\nexited. Note that if  the child process intercepts and handles the SIGTERM\nsignal and doesn't exit, the parent process will wait until the child\nprocess has exited.
\n
If the process times out, or has a non-zero exit code, this method will\nthrow.  The Error object will contain the entire result from\nchild_process.spawnSync()
\n
Note: Never pass unsanitised user input to this function. Any input\ncontaining shell metacharacters may be used to trigger arbitrary command\nexecution.
\n"
            },
            {
              "textRaw": "child_process.spawnSync(command[, args][, options])",
              "type": "method",
              "name": "spawnSync",
              "meta": {
                "added": [
                  "v0.11.12"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Object} ",
                    "options": [
                      {
                        "textRaw": "`pid` {Number} Pid of the child process ",
                        "name": "pid",
                        "type": "Number",
                        "desc": "Pid of the child process"
                      },
                      {
                        "textRaw": "`output` {Array} Array of results from stdio output ",
                        "name": "output",
                        "type": "Array",
                        "desc": "Array of results from stdio output"
                      },
                      {
                        "textRaw": "`stdout` {Buffer|String} The contents of `output[1]` ",
                        "name": "stdout",
                        "type": "Buffer|String",
                        "desc": "The contents of `output[1]`"
                      },
                      {
                        "textRaw": "`stderr` {Buffer|String} The contents of `output[2]` ",
                        "name": "stderr",
                        "type": "Buffer|String",
                        "desc": "The contents of `output[2]`"
                      },
                      {
                        "textRaw": "`status` {Number} The exit code of the child process ",
                        "name": "status",
                        "type": "Number",
                        "desc": "The exit code of the child process"
                      },
                      {
                        "textRaw": "`signal` {String} The signal used to kill the child process ",
                        "name": "signal",
                        "type": "String",
                        "desc": "The signal used to kill the child process"
                      },
                      {
                        "textRaw": "`error` {Error} The error object if the child process failed or timed out ",
                        "name": "error",
                        "type": "Error",
                        "desc": "The error object if the child process failed or timed out"
                      }
                    ],
                    "name": "return",
                    "type": "Object"
                  },
                  "params": [
                    {
                      "textRaw": "`command` {String} The command to run ",
                      "name": "command",
                      "type": "String",
                      "desc": "The command to run"
                    },
                    {
                      "textRaw": "`args` {Array} List of string arguments ",
                      "name": "args",
                      "type": "Array",
                      "desc": "List of string arguments",
                      "optional": true
                    },
                    {
                      "textRaw": "`options` {Object} ",
                      "options": [
                        {
                          "textRaw": "`cwd` {String} Current working directory of the child process ",
                          "name": "cwd",
                          "type": "String",
                          "desc": "Current working directory of the child process"
                        },
                        {
                          "textRaw": "`input` {String|Buffer} The value which will be passed as stdin to the spawned process ",
                          "options": [
                            {
                              "textRaw": "supplying this value will override `stdio[0]` ",
                              "name": "supplying",
                              "desc": "this value will override `stdio[0]`"
                            }
                          ],
                          "name": "input",
                          "type": "String|Buffer",
                          "desc": "The value which will be passed as stdin to the spawned process"
                        },
                        {
                          "textRaw": "`stdio` {String|Array} Child's stdio configuration. (Default: 'pipe') ",
                          "name": "stdio",
                          "default": "pipe",
                          "type": "String|Array",
                          "desc": "Child's stdio configuration."
                        },
                        {
                          "textRaw": "`env` {Object} Environment key-value pairs ",
                          "name": "env",
                          "type": "Object",
                          "desc": "Environment key-value pairs"
                        },
                        {
                          "textRaw": "`uid` {Number} Sets the user identity of the process. (See setuid(2).) ",
                          "name": "uid",
                          "type": "Number",
                          "desc": "Sets the user identity of the process. (See setuid(2).)"
                        },
                        {
                          "textRaw": "`gid` {Number} Sets the group identity of the process. (See setgid(2).) ",
                          "name": "gid",
                          "type": "Number",
                          "desc": "Sets the group identity of the process. (See setgid(2).)"
                        },
                        {
                          "textRaw": "`timeout` {Number} In milliseconds the maximum amount of time the process is allowed to run. (Default: undefined) ",
                          "name": "timeout",
                          "default": "undefined",
                          "type": "Number",
                          "desc": "In milliseconds the maximum amount of time the process is allowed to run."
                        },
                        {
                          "textRaw": "`killSignal` {String|Integer} The signal value to be used when the spawned process will be killed. (Default: 'SIGTERM') ",
                          "name": "killSignal",
                          "default": "SIGTERM",
                          "type": "String|Integer",
                          "desc": "The signal value to be used when the spawned process will be killed."
                        },
                        {
                          "textRaw": "`maxBuffer` {Number} largest amount of data (in bytes) allowed on stdout or stderr - if exceeded child process is killed ",
                          "name": "maxBuffer",
                          "type": "Number",
                          "desc": "largest amount of data (in bytes) allowed on stdout or stderr - if exceeded child process is killed"
                        },
                        {
                          "textRaw": "`encoding` {String} The encoding used for all stdio inputs and outputs. (Default: 'buffer') ",
                          "name": "encoding",
                          "default": "buffer",
                          "type": "String",
                          "desc": "The encoding used for all stdio inputs and outputs."
                        },
                        {
                          "textRaw": "`shell` {Boolean|String} If `true`, runs `command` inside of a shell. Uses '/bin/sh' on UNIX, and 'cmd.exe' on Windows. A different shell can be specified as a string. The shell should understand the `-c` switch on UNIX, or `/s /c` on Windows. Defaults to `false` (no shell). ",
                          "name": "shell",
                          "type": "Boolean|String",
                          "desc": "If `true`, runs `command` inside of a shell. Uses '/bin/sh' on UNIX, and 'cmd.exe' on Windows. A different shell can be specified as a string. The shell should understand the `-c` switch on UNIX, or `/s /c` on Windows. Defaults to `false` (no shell)."
                        }
                      ],
                      "name": "options",
                      "type": "Object",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "command"
                    },
                    {
                      "name": "args",
                      "optional": true
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
The child_process.spawnSync() method is generally identical to\nchild_process.spawn() with the exception that the function will not return\nuntil the child process has fully closed. When a timeout has been encountered\nand killSignal is sent, the method won't return until the process has\ncompletely exited. Note that if the process intercepts and handles the\nSIGTERM signal and doesn't exit, the parent process will wait until the child\nprocess has exited.
\n
Note: If the shell option is enabled, do not pass unsanitised user input to\nthis function. Any input containing shell metacharacters may be used to\ntrigger arbitrary command execution.
\n"
            }
          ],
          "type": "module",
          "displayName": "Synchronous Process Creation"
        }
      ],
      "classes": [
        {
          "textRaw": "Class: ChildProcess",
          "type": "class",
          "name": "ChildProcess",
          "meta": {
            "added": [
              "v2.2.0"
            ]
          },
          "desc": "
Instances of the ChildProcess class are EventEmitters that represent\nspawned child processes.
\n
Instances of ChildProcess are not intended to be created directly. Rather,\nuse the child_process.spawn(), child_process.exec(),\nchild_process.execFile(), or child_process.fork() methods to create\ninstances of ChildProcess.
\n",
          "events": [
            {
              "textRaw": "Event: 'close'",
              "type": "event",
              "name": "close",
              "meta": {
                "added": [
                  "v0.7.7"
                ]
              },
              "params": [],
              "desc": "
The 'close' event is emitted when the stdio streams of a child process have\nbeen closed. This is distinct from the 'exit' event, since multiple\nprocesses might share the same stdio streams.
\n"
            },
            {
              "textRaw": "Event: 'disconnect'",
              "type": "event",
              "name": "disconnect",
              "meta": {
                "added": [
                  "v0.7.2"
                ]
              },
              "desc": "
The 'disconnect' event is emitted after calling the\nChildProcess.disconnect() method in the parent or child process. After\ndisconnecting it is no longer possible to send or receive messages, and the\nChildProcess.connected property is false.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'error'",
              "type": "event",
              "name": "error",
              "params": [],
              "desc": "
The 'error' event is emitted whenever:
\n
    \n
  1. The process could not be spawned, or
    2. \n
  2. The process could not be killed, or
    3. \n
  3. Sending a message to the child process failed.
    4. \n
\n
Note that the 'exit' event may or may not fire after an error has occurred.\nIf you are listening to both the 'exit' and 'error' events, it is important\nto guard against accidentally invoking handler functions multiple times.
\n
See also ChildProcess#kill() and ChildProcess#send().
\n"
            },
            {
              "textRaw": "Event: 'exit'",
              "type": "event",
              "name": "exit",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "params": [],
              "desc": "
The 'exit' event is emitted after the child process ends. If the process\nexited, code is the final exit code of the process, otherwise null. If the\nprocess terminated due to receipt of a signal, signal is the string name of\nthe signal, otherwise null. One of the two will always be non-null.
\n
Note that when the 'exit' event is triggered, child process stdio streams\nmight still be open.
\n
Also, note that Node.js establishes signal handlers for SIGINT and\nSIGTERM and Node.js processes will not terminate immediately due to receipt\nof those signals. Rather, Node.js will perform a sequence of cleanup actions\nand then will re-raise the handled signal.
\n
See waitpid(2).
\n"
            },
            {
              "textRaw": "Event: 'message'",
              "type": "event",
              "name": "message",
              "meta": {
                "added": [
                  "v0.5.9"
                ]
              },
              "params": [],
              "desc": "
The 'message' event is triggered when a child process uses process.send()\nto send messages.
\n"
            }
          ],
          "properties": [
            {
              "textRaw": "`connected` {Boolean} Set to false after `.disconnect` is called ",
              "type": "Boolean",
              "name": "connected",
              "meta": {
                "added": [
                  "v0.7.2"
                ]
              },
              "desc": "
The child.connected property indicates whether it is still possible to send\nand receive messages from a child process. When child.connected is false, it\nis no longer possible to send or receive messages.
\n",
              "shortDesc": "Set to false after `.disconnect` is called"
            },
            {
              "textRaw": "`pid` {Number} Integer ",
              "type": "Number",
              "name": "pid",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Returns the process identifier (PID) of the child process.
\n
Example:
\n
const spawn = require('child_process').spawn;\nconst grep = spawn('grep', ['ssh']);\n\nconsole.log(`Spawned child pid: ${grep.pid}`);\ngrep.stdin.end();\n
\n",
              "shortDesc": "Integer"
            },
            {
              "textRaw": "`stderr` {Stream} ",
              "type": "Stream",
              "name": "stderr",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
A Readable Stream that represents the child process's stderr.
\n
If the child was spawned with stdio[2] set to anything other than 'pipe',\nthen this will be undefined.
\n
child.stderr is an alias for child.stdio[2]. Both properties will refer to\nthe same value.
\n"
            },
            {
              "textRaw": "`stdin` {Stream} ",
              "type": "Stream",
              "name": "stdin",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
A Writable Stream that represents the child process's stdin.
\n
Note that if a child process waits to read all of its input, the child will not\ncontinue until this stream has been closed via end().
\n
If the child was spawned with stdio[0] set to anything other than 'pipe',\nthen this will be undefined.
\n
child.stdin is an alias for child.stdio[0]. Both properties will refer to\nthe same value.
\n"
            },
            {
              "textRaw": "`stdio` {Array} ",
              "type": "Array",
              "name": "stdio",
              "meta": {
                "added": [
                  "v0.7.10"
                ]
              },
              "desc": "
A sparse array of pipes to the child process, corresponding with positions in\nthe stdio option passed to child_process.spawn() that have been set\nto the value 'pipe'. Note that child.stdio[0], child.stdio[1], and\nchild.stdio[2] are also available as child.stdin, child.stdout, and\nchild.stderr, respectively.
\n
In the following example, only the child's fd 1 (stdout) is configured as a\npipe, so only the parent's child.stdio[1] is a stream, all other values in\nthe array are null.
\n
const assert = require('assert');\nconst fs = require('fs');\nconst child_process = require('child_process');\n\nconst child = child_process.spawn('ls', {\n    stdio: [\n      0, // Use parents stdin for child\n      'pipe', // Pipe child's stdout to parent\n      fs.openSync('err.out', 'w') // Direct child's stderr to a file\n    ]\n});\n\nassert.equal(child.stdio[0], null);\nassert.equal(child.stdio[0], child.stdin);\n\nassert(child.stdout);\nassert.equal(child.stdio[1], child.stdout);\n\nassert.equal(child.stdio[2], null);\nassert.equal(child.stdio[2], child.stderr);\n
\n"
            },
            {
              "textRaw": "`stdout` {Stream} ",
              "type": "Stream",
              "name": "stdout",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
A Readable Stream that represents the child process's stdout.
\n
If the child was spawned with stdio[1] set to anything other than 'pipe',\nthen this will be undefined.
\n
child.stdout is an alias for child.stdio[1]. Both properties will refer\nto the same value.
\n"
            }
          ],
          "methods": [
            {
              "textRaw": "child.disconnect()",
              "type": "method",
              "name": "disconnect",
              "meta": {
                "added": [
                  "v0.7.2"
                ]
              },
              "desc": "
Closes the IPC channel between parent and child, allowing the child to exit\ngracefully once there are no other connections keeping it alive. After calling\nthis method the child.connected and process.connected properties in both\nthe parent and child (respectively) will be set to false, and it will be no\nlonger possible to pass messages between the processes.
\n
The 'disconnect' event will be emitted when there are no messages in the\nprocess of being received. This will most often be triggered immediately after\ncalling child.disconnect().
\n
Note that when the child process is a Node.js instance (e.g. spawned using\nchild_process.fork()), the process.disconnect() method can be invoked\nwithin the child process to close the IPC channel as well.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "child.kill([signal])",
              "type": "method",
              "name": "kill",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`signal` {String} ",
                      "name": "signal",
                      "type": "String",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "signal",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
The child.kill() methods sends a signal to the child process. If no argument\nis given, the process will be sent the 'SIGTERM' signal. See signal(7) for\na list of available signals.
\n
const spawn = require('child_process').spawn;\nconst grep = spawn('grep', ['ssh']);\n\ngrep.on('close', (code, signal) => {\n  console.log(\n    `child process terminated due to receipt of signal ${signal}`);\n});\n\n// Send SIGHUP to process\ngrep.kill('SIGHUP');\n
\n
The ChildProcess object may emit an 'error' event if the signal cannot be\ndelivered. Sending a signal to a child process that has already exited is not\nan error but may have unforeseen consequences. Specifically, if the process\nidentifier (PID) has been reassigned to another process, the signal will be\ndelivered to that process instead which can have unexpected results.
\n
Note that while the function is called kill, the signal delivered to the\nchild process may not actually terminate the process.
\n
See kill(2) for reference.
\n
Also note: on Linux, child processes of child processes will not be terminated\nwhen attempting to kill their parent. This is likely to happen when running a\nnew process in a shell or with use of the shell option of ChildProcess, such\nas in this example:
\n
'use strict';\nconst spawn = require('child_process').spawn;\n\nlet child = spawn('sh', ['-c',\n  `node -e "setInterval(() => {\n      console.log(process.pid, 'is alive')\n    }, 500);"`\n  ], {\n    stdio: ['inherit', 'inherit', 'inherit']\n  });\n\nsetTimeout(() => {\n  child.kill(); // does not terminate the node process in the shell\n}, 2000);\n
\n"
            },
            {
              "textRaw": "child.send(message[, sendHandle][, callback])",
              "type": "method",
              "name": "send",
              "meta": {
                "added": [
                  "v0.5.9"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Boolean} ",
                    "name": "return",
                    "type": "Boolean"
                  },
                  "params": [
                    {
                      "textRaw": "`message` {Object} ",
                      "name": "message",
                      "type": "Object"
                    },
                    {
                      "textRaw": "`sendHandle` {Handle} ",
                      "name": "sendHandle",
                      "type": "Handle",
                      "optional": true
                    },
                    {
                      "textRaw": "`callback` {Function} ",
                      "name": "callback",
                      "type": "Function",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "message"
                    },
                    {
                      "name": "sendHandle",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
When an IPC channel has been established between the parent and child (\ni.e. when using child_process.fork()), the child.send() method can be\nused to send messages to the child process. When the child process is a Node.js\ninstance, these messages can be received via the process.on('message') event.
\n
For example, in the parent script:
\n
const cp = require('child_process');\nconst n = cp.fork(`${__dirname}/sub.js`);\n\nn.on('message', (m) => {\n  console.log('PARENT got message:', m);\n});\n\nn.send({ hello: 'world' });\n
\n
And then the child script, 'sub.js' might look like this:
\n
process.on('message', (m) => {\n  console.log('CHILD got message:', m);\n});\n\nprocess.send({ foo: 'bar' });\n
\n
Child Node.js processes will have a process.send() method of their own that\nallows the child to send messages back to the parent.
\n
There is a special case when sending a {cmd: 'NODE_foo'} message. All messages\ncontaining a NODE_ prefix in its cmd property are considered to be reserved\nfor use within Node.js core and will not be emitted in the child's\nprocess.on('message') event. Rather, such messages are emitted using the\nprocess.on('internalMessage') event and are consumed internally by Node.js.\nApplications should avoid using such messages or listening for\n'internalMessage' events as it is subject to change without notice.
\n
The optional sendHandle argument that may be passed to child.send() is for\npassing a TCP server or socket object to the child process. The child will\nreceive the object as the second argument passed to the callback function\nregistered on the process.on('message') event. Any data that is received and\nbuffered in the socket will not be sent to the child.
\n
The optional callback is a function that is invoked after the message is\nsent but before the child may have received it.  The function is called with a\nsingle argument: null on success, or an Error object on failure.
\n
If no callback function is provided and the message cannot be sent, an\n'error' event will be emitted by the ChildProcess object. This can happen,\nfor instance, when the child process has already exited.
\n
child.send() will return false if the channel has closed or when the\nbacklog of unsent messages exceeds a threshold that makes it unwise to send\nmore. Otherwise, the method returns true. The callback function can be\nused to implement flow control.
\n
Example: sending a server object
\n
The sendHandle argument can be used, for instance, to pass the handle of\na TCP server object to the child process as illustrated in the example below:
\n
const child = require('child_process').fork('child.js');\n\n// Open up the server object and send the handle.\nconst server = require('net').createServer();\nserver.on('connection', (socket) => {\n  socket.end('handled by parent');\n});\nserver.listen(1337, () => {\n  child.send('server', server);\n});\n
\n
The child would then receive the server object as:
\n
process.on('message', (m, server) => {\n  if (m === 'server') {\n    server.on('connection', (socket) => {\n      socket.end('handled by child');\n    });\n  }\n});\n
\n
Once the server is now shared between the parent and child, some connections\ncan be handled by the parent and some by the child.
\n
While the example above uses a server created using the net module, dgram\nmodule servers use exactly the same workflow with the exceptions of listening on\na 'message' event instead of 'connection' and using server.bind instead of\nserver.listen. This is, however, currently only supported on UNIX platforms.
\n
Example: sending a socket object
\n
Similarly, the sendHandler argument can be used to pass the handle of a\nsocket to the child process. The example below spawns two children that each\nhandle connections with "normal" or "special" priority:
\n
const normal = require('child_process').fork('child.js', ['normal']);\nconst special = require('child_process').fork('child.js', ['special']);\n\n// Open up the server and send sockets to child\nconst server = require('net').createServer();\nserver.on('connection', (socket) => {\n\n  // If this is special priority\n  if (socket.remoteAddress === '74.125.127.100') {\n    special.send('socket', socket);\n    return;\n  }\n  // This is normal priority\n  normal.send('socket', socket);\n});\nserver.listen(1337);\n
\n
The child.js would receive the socket handle as the second argument passed\nto the event callback function:
\n
process.on('message', (m, socket) => {\n  if (m === 'socket') {\n    socket.end(`Request handled with ${process.argv[2]} priority`);\n  }\n});\n
\n
Once a socket has been passed to a child, the parent is no longer capable of\ntracking when the socket is destroyed. To indicate this, the .connections\nproperty becomes null. It is recommended not to use .maxConnections when\nthis occurs.
\n
Note: this function uses JSON.stringify() internally to serialize the message.
\n"
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "Child Process"
    }
  ]
}
node-v4.8.2/doc/api/child_process.md000644 000766 000024 00000123777 13070706735 017462 0ustar00iojsstaff000000 000000 # Child Process

> Stability: 2 - Stable

The `child_process` module provides the ability to spawn child processes in
a manner that is similar, but not identical, to [`popen(3)`][]. This capability
is primarily provided by the `child_process.spawn()` function:

```js
const spawn = require('child_process').spawn;
const ls = spawn('ls', ['-lh', '/usr']);

ls.stdout.on('data', (data) => {
  console.log(`stdout: ${data}`);
});

ls.stderr.on('data', (data) => {
  console.log(`stderr: ${data}`);
});

ls.on('close', (code) => {
  console.log(`child process exited with code ${code}`);
});
```

By default, pipes for `stdin`, `stdout` and `stderr` are established between
the parent Node.js process and the spawned child. It is possible to stream data
through these pipes in a non-blocking way. *Note, however, that some programs
use line-buffered I/O internally. While that does not affect Node.js, it can
mean that data sent to the child process may not be immediately consumed.*

The `child_process.spawn()` method spawns the child process asynchronously,
without blocking the Node.js event loop. The `child_process.spawnSync()`
function provides equivalent functionality in a synchronous manner that blocks
the event loop until the spawned process either exits or is terminated.

For convenience, the `child_process` module provides a handful of synchronous
and asynchronous alternatives to [`child_process.spawn()`][] and
[`child_process.spawnSync()`][].  *Note that each of these alternatives are
implemented on top of `child_process.spawn()` or `child_process.spawnSync()`.*

  * `child_process.exec()`: spawns a shell and runs a command within that shell,
    passing the `stdout` and `stderr` to a callback function when complete.
  * `child_process.execFile()`: similar to `child_process.exec()` except that
    it spawns the command directly without first spawning a shell.
  * `child_process.fork()`: spawns a new Node.js process and invokes a
    specified module with an IPC communication channel established that allows
    sending messages between parent and child.
  * `child_process.execSync()`: a synchronous version of
    `child_process.exec()` that *will* block the Node.js event loop.
  * `child_process.execFileSync()`: a synchronous version of
    `child_process.execFile()` that *will* block the Node.js event loop.

For certain use cases, such as automating shell scripts, the
[synchronous counterparts][] may be more convenient. In many cases, however,
the synchronous methods can have significant impact on performance due to
stalling the event loop while spawned processes complete.

## Asynchronous Process Creation

The `child_process.spawn()`, `child_process.fork()`, `child_process.exec()`,
and `child_process.execFile()` methods all follow the idiomatic asynchronous
programming pattern typical of other Node.js APIs.

Each of the methods returns a [`ChildProcess`][] instance. These objects
implement the Node.js [`EventEmitter`][] API, allowing the parent process to
register listener functions that are called when certain events occur during
the life cycle of the child process.

The `child_process.exec()` and `child_process.execFile()` methods additionally
allow for an optional `callback` function to be specified that is invoked
when the child process terminates.

### Spawning `.bat` and `.cmd` files on Windows

The importance of the distinction between `child_process.exec()` and
`child_process.execFile()` can vary based on platform. On Unix-type operating
systems (Unix, Linux, OSX) `child_process.execFile()` can be more efficient
because it does not spawn a shell. On Windows, however, `.bat` and `.cmd`
files are not executable on their own without a terminal, and therefore cannot
be launched using `child_process.execFile()`. When running on Windows, `.bat`
and `.cmd` files can be invoked using `child_process.spawn()` with the `shell`
option set, with `child_process.exec()`, or by spawning `cmd.exe` and passing
the `.bat` or `.cmd` file as an argument (which is what the `shell` option and
`child_process.exec()` do).

```js
// On Windows Only ...
const spawn = require('child_process').spawn;
const bat = spawn('cmd.exe', ['/c', 'my.bat']);

bat.stdout.on('data', (data) => {
  console.log(data);
});

bat.stderr.on('data', (data) => {
  console.log(data);
});

bat.on('exit', (code) => {
  console.log(`Child exited with code ${code}`);
});

// OR...
const exec = require('child_process').exec;
exec('my.bat', (err, stdout, stderr) => {
  if (err) {
    console.error(err);
    return;
  }
  console.log(stdout);
});
```

### child_process.exec(command[, options][, callback])


* `command` {String} The command to run, with space-separated arguments
* `options` {Object}
  * `cwd` {String} Current working directory of the child process
  * `env` {Object} Environment key-value pairs
  * `encoding` {String} (Default: 'utf8')
  * `shell` {String} Shell to execute the command with
    (Default: '/bin/sh' on UNIX, 'cmd.exe' on Windows,  The shell should
     understand the `-c` switch on UNIX or `/s /c` on Windows. On Windows,
     command line parsing should be compatible with `cmd.exe`.)
  * `timeout` {Number} (Default: 0)
  * `maxBuffer` {Number} largest amount of data (in bytes) allowed on stdout or
    stderr - if exceeded child process is killed (Default: `200*1024`)
  * `killSignal` {String|Integer} (Default: 'SIGTERM')
  * `uid` {Number} Sets the user identity of the process. (See setuid(2).)
  * `gid` {Number} Sets the group identity of the process. (See setgid(2).)
* `callback` {Function} called with the output when process terminates
  * `error` {Error}
  * `stdout` {String|Buffer}
  * `stderr` {String|Buffer}
* Returns: {ChildProcess}

Spawns a shell then executes the `command` within that shell, buffering any
generated output.

**Note: Never pass unsanitised user input to this function. Any input
containing shell metacharacters may be used to trigger arbitrary command
execution.**

```js
const exec = require('child_process').exec;
exec('cat *.js bad_file | wc -l', (error, stdout, stderr) => {
  if (error) {
    console.error(`exec error: ${error}`);
    return;
  }
  console.log(`stdout: ${stdout}`);
  console.log(`stderr: ${stderr}`);
});
```

If a `callback` function is provided, it is called with the arguments
`(error, stdout, stderr)`. On success, `error` will be `null`.  On error,
`error` will be an instance of [`Error`][]. The `error.code` property will be
the exit code of the child process while `error.signal` will be set to the
signal that terminated the process. Any exit code other than `0` is considered
to be an error.

The `stdout` and `stderr` arguments passed to the callback will contain the
stdout and stderr output of the child process. By default, Node.js will decode
the output as UTF-8 and pass strings to the callback. The `encoding` option
can be used to specify the character encoding used to decode the stdout and
stderr output. If `encoding` is `'buffer'`, or an unrecognized character
encoding, `Buffer` objects will be passed to the callback instead.

The `options` argument may be passed as the second argument to customize how
the process is spawned. The default options are:

```js
{
  encoding: 'utf8',
  timeout: 0,
  maxBuffer: 200*1024,
  killSignal: 'SIGTERM',
  cwd: null,
  env: null
}
```

If `timeout` is greater than `0`, the parent will send the the signal
identified by the `killSignal` property (the default is `'SIGTERM'`) if the
child runs longer than `timeout` milliseconds.

The `maxBuffer` option specifies the largest amount of data (in bytes) allowed
on stdout or stderr - if this value is exceeded then the child process is
terminated.

*Note: Unlike the `exec()` POSIX system call, `child_process.exec()` does not
replace the existing process and uses a shell to execute the command.*

### child_process.execFile(file[, args][, options][, callback])


* `file` {String} The name or path of the executable file to run
* `args` {Array} List of string arguments
* `options` {Object}
  * `cwd` {String} Current working directory of the child process
  * `env` {Object} Environment key-value pairs
  * `encoding` {String} (Default: 'utf8')
  * `timeout` {Number} (Default: 0)
  * `maxBuffer` {Number} largest amount of data (in bytes) allowed on stdout or
    stderr - if exceeded child process is killed (Default: 200\*1024)
  * `killSignal` {String|Integer} (Default: 'SIGTERM')
  * `uid` {Number} Sets the user identity of the process. (See setuid(2).)
  * `gid` {Number} Sets the group identity of the process. (See setgid(2).)
* `callback` {Function} called with the output when process terminates
  * `error` {Error}
  * `stdout` {String|Buffer}
  * `stderr` {String|Buffer}
* Returns: {ChildProcess}

The `child_process.execFile()` function is similar to [`child_process.exec()`][]
except that it does not spawn a shell. Rather, the specified executable `file`
is spawned directly as a new process making it slightly more efficient than
[`child_process.exec()`][].

The same options as `child_process.exec()` are supported. Since a shell is not
spawned, behaviors such as I/O redirection and file globbing are not supported.

```js
const execFile = require('child_process').execFile;
const child = execFile('node', ['--version'], (error, stdout, stderr) => {
  if (error) {
    throw error;
  }
  console.log(stdout);
});
```

The `stdout` and `stderr` arguments passed to the callback will contain the
stdout and stderr output of the child process. By default, Node.js will decode
the output as UTF-8 and pass strings to the callback. The `encoding` option
can be used to specify the character encoding used to decode the stdout and
stderr output. If `encoding` is `'buffer'`, or an unrecognized character
encoding, `Buffer` objects will be passed to the callback instead.

### child_process.fork(modulePath[, args][, options])


* `modulePath` {String} The module to run in the child
* `args` {Array} List of string arguments
* `options` {Object}
  * `cwd` {String} Current working directory of the child process
  * `env` {Object} Environment key-value pairs
  * `execPath` {String} Executable used to create the child process
  * `execArgv` {Array} List of string arguments passed to the executable
    (Default: `process.execArgv`)
  * `silent` {Boolean} If true, stdin, stdout, and stderr of the child will be
    piped to the parent, otherwise they will be inherited from the parent, see
    the `'pipe'` and `'inherit'` options for [`child_process.spawn()`][]'s
    [`stdio`][] for more details (default is false)
  * `uid` {Number} Sets the user identity of the process. (See setuid(2).)
  * `gid` {Number} Sets the group identity of the process. (See setgid(2).)
* Returns: {ChildProcess}

The `child_process.fork()` method is a special case of
[`child_process.spawn()`][] used specifically to spawn new Node.js processes.
Like `child_process.spawn()`, a `ChildProcess` object is returned. The returned
`ChildProcess` will have an additional communication channel built-in that
allows messages to be passed back and forth between the parent and child. See
[`ChildProcess#send()`][] for details.

It is important to keep in mind that spawned Node.js child processes are
independent of the parent with exception of the IPC communication channel
that is established between the two. Each process has its own memory, with
their own V8 instances. Because of the additional resource allocations
required, spawning a large number of child Node.js processes is not
recommended.

By default, `child_process.fork()` will spawn new Node.js instances using the
`process.execPath` of the parent process. The `execPath` property in the
`options` object allows for an alternative execution path to be used.

Node.js processes launched with a custom `execPath` will communicate with the
parent process using the file descriptor (fd) identified using the
environment variable `NODE_CHANNEL_FD` on the child process. The input and
output on this fd is expected to be line delimited JSON objects.

*Note: Unlike the `fork()` POSIX system call, [`child_process.fork()`][] does
not clone the current process.*

### child_process.spawn(command[, args][, options])


* `command` {String} The command to run
* `args` {Array} List of string arguments
* `options` {Object}
  * `cwd` {String} Current working directory of the child process
  * `env` {Object} Environment key-value pairs
  * `stdio` {Array|String} Child's stdio configuration. (See
    [`options.stdio`][])
  * `detached` {Boolean} Prepare child to run independently of its parent
    process. Specific behavior depends on the platform, see
    [`options.detached`][])
  * `uid` {Number} Sets the user identity of the process. (See setuid(2).)
  * `gid` {Number} Sets the group identity of the process. (See setgid(2).)
  * `shell` {Boolean|String} If `true`, runs `command` inside of a shell. Uses
    '/bin/sh' on UNIX, and 'cmd.exe' on Windows. A different shell can be
    specified as a string. The shell should understand the `-c` switch on UNIX,
    or `/s /c` on Windows. Defaults to `false` (no shell).
* Returns: {ChildProcess}

The `child_process.spawn()` method spawns a new process using the given
`command`, with command line arguments in `args`. If omitted, `args` defaults
to an empty array.

**Note: If the `shell` option is enabled, do not pass unsanitised user input to
this function. Any input containing shell metacharacters may be used to
trigger arbitrary command execution.**

A third argument may be used to specify additional options, with these defaults:

```js
{
  cwd: undefined,
  env: process.env
}
```

Use `cwd` to specify the working directory from which the process is spawned.
If not given, the default is to inherit the current working directory.

Use `env` to specify environment variables that will be visible to the new
process, the default is `process.env`.

Example of running `ls -lh /usr`, capturing `stdout`, `stderr`, and the
exit code:

```js
const spawn = require('child_process').spawn;
const ls = spawn('ls', ['-lh', '/usr']);

ls.stdout.on('data', (data) => {
  console.log(`stdout: ${data}`);
});

ls.stderr.on('data', (data) => {
  console.log(`stderr: ${data}`);
});

ls.on('close', (code) => {
  console.log(`child process exited with code ${code}`);
});
```


Example: A very elaborate way to run 'ps ax | grep ssh'

```js
const spawn = require('child_process').spawn;
const ps = spawn('ps', ['ax']);
const grep = spawn('grep', ['ssh']);

ps.stdout.on('data', (data) => {
  grep.stdin.write(data);
});

ps.stderr.on('data', (data) => {
  console.log(`ps stderr: ${data}`);
});

ps.on('close', (code) => {
  if (code !== 0) {
    console.log(`ps process exited with code ${code}`);
  }
  grep.stdin.end();
});

grep.stdout.on('data', (data) => {
  console.log(`${data}`);
});

grep.stderr.on('data', (data) => {
  console.log(`grep stderr: ${data}`);
});

grep.on('close', (code) => {
  if (code !== 0) {
    console.log(`grep process exited with code ${code}`);
  }
});
```


Example of checking for failed exec:

```js
const spawn = require('child_process').spawn;
const child = spawn('bad_command');

child.on('error', (err) => {
  console.log('Failed to start child process.');
});
```

#### options.detached


On Windows, setting `options.detached` to `true` makes it possible for the
child process to continue running after the parent exits. The child will have
its own console window. *Once enabled for a child process, it cannot be
disabled*.

On non-Windows platforms, if `options.detached` is set to `true`, the child
process will be made the leader of a new process group and session. Note that
child processes may continue running after the parent exits regardless of
whether they are detached or not.  See `setsid(2)` for more information.

By default, the parent will wait for the detached child to exit. To prevent
the parent from waiting for a given `child`, use the `child.unref()` method.
Doing so will cause the parent's event loop to not include the child in its
reference count, allowing the parent to exit independently of the child, unless
there is an established IPC channel between the child and parent.

When using the `detached` option to start a long-running process, the process
will not stay running in the background after the parent exits unless it is
provided with a `stdio` configuration that is not connected to the parent.
If the parent's `stdio` is inherited, the child will remain attached to the
controlling terminal.

Example of a long-running process, by detaching and also ignoring its parent
`stdio` file descriptors, in order to ignore the parent's termination:

```js
const spawn = require('child_process').spawn;

const child = spawn(process.argv[0], ['child_program.js'], {
  detached: true,
  stdio: 'ignore'
});

child.unref();
```

Alternatively one can redirect the child process' output into files:

```js
const fs = require('fs');
const spawn = require('child_process').spawn;
const out = fs.openSync('./out.log', 'a');
const err = fs.openSync('./out.log', 'a');

const child = spawn('prg', [], {
 detached: true,
 stdio: [ 'ignore', out, err ]
});

child.unref();
```

#### options.stdio


The `options.stdio` option is used to configure the pipes that are established
between the parent and child process. By default, the child's stdin, stdout,
and stderr are redirected to corresponding `child.stdin`, `child.stdout`, and
`child.stderr` streams on the `ChildProcess` object. This is equivalent to
setting the `options.stdio` equal to `['pipe', 'pipe', 'pipe']`.

For convenience, `options.stdio` may be one of the following strings:

* `'pipe'` - equivalent to `['pipe', 'pipe', 'pipe']` (the default)
* `'ignore'` - equivalent to `['ignore', 'ignore', 'ignore']`
* `'inherit'` - equivalent to `[process.stdin, process.stdout, process.stderr]`
   or `[0,1,2]`

Otherwise, the value of `option.stdio` is an array where each index corresponds
to an fd in the child. The fds 0, 1, and 2 correspond to stdin, stdout,
and stderr, respectively. Additional fds can be specified to create additional
pipes between the parent and child. The value is one of the following:

1. `'pipe'` - Create a pipe between the child process and the parent process.
   The parent end of the pipe is exposed to the parent as a property on the
   `child_process` object as `ChildProcess.stdio[fd]`. Pipes created for
   fds 0 - 2 are also available as ChildProcess.stdin, ChildProcess.stdout
   and ChildProcess.stderr, respectively.
2. `'ipc'` - Create an IPC channel for passing messages/file descriptors
   between parent and child. A ChildProcess may have at most *one* IPC stdio
   file descriptor. Setting this option enables the ChildProcess.send() method.
   If the child writes JSON messages to this file descriptor, the
   `ChildProcess.on('message')` event handler will be triggered in the parent.
   If the child is a Node.js process, the presence of an IPC channel will enable
   `process.send()`, `process.disconnect()`, `process.on('disconnect')`, and
   `process.on('message')` within the child.
3. `'ignore'` - Instructs Node.js to ignore the fd in the child. While Node.js
   will always open fds 0 - 2 for the processes it spawns, setting the fd to
   `'ignore'` will cause Node.js to open `/dev/null` and attach it to the
   child's fd.
4. `Stream` object - Share a readable or writable stream that refers to a tty,
   file, socket, or a pipe with the child process. The stream's underlying
   file descriptor is duplicated in the child process to the fd that
   corresponds to the index in the `stdio` array. Note that the stream must
   have an underlying descriptor (file streams do not until the `'open'`
   event has occurred).
5. Positive integer - The integer value is interpreted as a file descriptor
   that is is currently open in the parent process. It is shared with the child
   process, similar to how `Stream` objects can be shared.
6. `null`, `undefined` - Use default value. For stdio fds 0, 1 and 2 (in other
   words, stdin, stdout, and stderr) a pipe is created. For fd 3 and up, the
   default is `'ignore'`.

Example:

```js
const spawn = require('child_process').spawn;

// Child will use parent's stdios
spawn('prg', [], { stdio: 'inherit' });

// Spawn child sharing only stderr
spawn('prg', [], { stdio: ['pipe', 'pipe', process.stderr] });

// Open an extra fd=4, to interact with programs presenting a
// startd-style interface.
spawn('prg', [], { stdio: ['pipe', null, null, null, 'pipe'] });
```

*It is worth noting that when an IPC channel is established between the
parent and child processes, and the child is a Node.js process, the child
is launched with the IPC channel unreferenced (using `unref()`) until the
child registers an event handler for the `process.on('disconnect')` event
or the `process.on('message')` event.This allows the child to exit normally
without the process being held open by the open IPC channel.*

See also: [`child_process.exec()`][] and [`child_process.fork()`][]

## Synchronous Process Creation

The `child_process.spawnSync()`, `child_process.execSync()`, and
`child_process.execFileSync()` methods are **synchronous** and **WILL** block
the Node.js event loop, pausing execution of any additional code until the
spawned process exits.

Blocking calls like these are mostly useful for simplifying general purpose
scripting tasks and for simplifying the loading/processing of application
configuration at startup.

### child_process.execFileSync(file[, args][, options])


* `file` {String} The name or path of the executable file to run
* `args` {Array} List of string arguments
* `options` {Object}
  * `cwd` {String} Current working directory of the child process
  * `input` {String|Buffer} The value which will be passed as stdin to the spawned process
    - supplying this value will override `stdio[0]`
  * `stdio` {String|Array} Child's stdio configuration. (Default: 'pipe')
    - `stderr` by default will be output to the parent process' stderr unless
      `stdio` is specified
  * `env` {Object} Environment key-value pairs
  * `uid` {Number} Sets the user identity of the process. (See setuid(2).)
  * `gid` {Number} Sets the group identity of the process. (See setgid(2).)
  * `timeout` {Number} In milliseconds the maximum amount of time the process is allowed to run. (Default: undefined)
  * `killSignal` {String|Integer} The signal value to be used when the spawned process will be killed. (Default: 'SIGTERM')
  * `maxBuffer` {Number} largest amount of data (in bytes) allowed on stdout or
    stderr - if exceeded child process is killed
  * `encoding` {String} The encoding used for all stdio inputs and outputs. (Default: 'buffer')
* Returns: {Buffer|String} The stdout from the command

The `child_process.execFileSync()` method is generally identical to
`child_process.execFile()` with the exception that the method will not return
until the child process has fully closed. When a timeout has been encountered
and `killSignal` is sent, the method won't return until the process has
completely exited. *Note that if the child process intercepts and handles
the `SIGTERM` signal and does not exit, the parent process will still wait
until the child process has exited.*

If the process times out, or has a non-zero exit code, this method ***will***
throw.  The [`Error`][] object will contain the entire result from
[`child_process.spawnSync()`][]

### child_process.execSync(command[, options])


* `command` {String} The command to run
* `options` {Object}
  * `cwd` {String} Current working directory of the child process
  * `input` {String|Buffer} The value which will be passed as stdin to the spawned process
    - supplying this value will override `stdio[0]`
  * `stdio` {String|Array} Child's stdio configuration. (Default: 'pipe')
    - `stderr` by default will be output to the parent process' stderr unless
      `stdio` is specified
  * `env` {Object} Environment key-value pairs
  * `shell` {String} Shell to execute the command with
    (Default: '/bin/sh' on UNIX, 'cmd.exe' on Windows,  The shell should
     understand the `-c` switch on UNIX or `/s /c` on Windows. On Windows,
     command line parsing should be compatible with `cmd.exe`.)
  * `uid` {Number} Sets the user identity of the process. (See setuid(2).)
  * `gid` {Number} Sets the group identity of the process. (See setgid(2).)
  * `timeout` {Number} In milliseconds the maximum amount of time the process is allowed to run. (Default: undefined)
  * `killSignal` {String|Integer} The signal value to be used when the spawned process will be killed. (Default: 'SIGTERM')
  * `maxBuffer` {Number} largest amount of data (in bytes) allowed on stdout or
    stderr - if exceeded child process is killed
  * `encoding` {String} The encoding used for all stdio inputs and outputs. (Default: 'buffer')
* Returns: {Buffer|String} The stdout from the command

The `child_process.execSync()` method is generally identical to
`child_process.exec()` with the exception that the method will not return until
the child process has fully closed. When a timeout has been encountered and
`killSignal` is sent, the method won't return until the process has completely
exited. *Note that if  the child process intercepts and handles the `SIGTERM`
signal and doesn't exit, the parent process will wait until the child
process has exited.*

If the process times out, or has a non-zero exit code, this method ***will***
throw.  The [`Error`][] object will contain the entire result from
[`child_process.spawnSync()`][]

**Note: Never pass unsanitised user input to this function. Any input
containing shell metacharacters may be used to trigger arbitrary command
execution.**

### child_process.spawnSync(command[, args][, options])


* `command` {String} The command to run
* `args` {Array} List of string arguments
* `options` {Object}
  * `cwd` {String} Current working directory of the child process
  * `input` {String|Buffer} The value which will be passed as stdin to the spawned process
    - supplying this value will override `stdio[0]`
  * `stdio` {String|Array} Child's stdio configuration. (Default: 'pipe')
  * `env` {Object} Environment key-value pairs
  * `uid` {Number} Sets the user identity of the process. (See setuid(2).)
  * `gid` {Number} Sets the group identity of the process. (See setgid(2).)
  * `timeout` {Number} In milliseconds the maximum amount of time the process is allowed to run. (Default: undefined)
  * `killSignal` {String|Integer} The signal value to be used when the spawned process will be killed. (Default: 'SIGTERM')
  * `maxBuffer` {Number} largest amount of data (in bytes) allowed on stdout or
    stderr - if exceeded child process is killed
  * `encoding` {String} The encoding used for all stdio inputs and outputs. (Default: 'buffer')
  * `shell` {Boolean|String} If `true`, runs `command` inside of a shell. Uses
    '/bin/sh' on UNIX, and 'cmd.exe' on Windows. A different shell can be
    specified as a string. The shell should understand the `-c` switch on UNIX,
    or `/s /c` on Windows. Defaults to `false` (no shell).
* Returns: {Object}
  * `pid` {Number} Pid of the child process
  * `output` {Array} Array of results from stdio output
  * `stdout` {Buffer|String} The contents of `output[1]`
  * `stderr` {Buffer|String} The contents of `output[2]`
  * `status` {Number} The exit code of the child process
  * `signal` {String} The signal used to kill the child process
  * `error` {Error} The error object if the child process failed or timed out

The `child_process.spawnSync()` method is generally identical to
`child_process.spawn()` with the exception that the function will not return
until the child process has fully closed. When a timeout has been encountered
and `killSignal` is sent, the method won't return until the process has
completely exited. Note that if the process intercepts and handles the
`SIGTERM` signal and doesn't exit, the parent process will wait until the child
process has exited.

**Note: If the `shell` option is enabled, do not pass unsanitised user input to
this function. Any input containing shell metacharacters may be used to
trigger arbitrary command execution.**

## Class: ChildProcess


Instances of the `ChildProcess` class are [`EventEmitters`][] that represent
spawned child processes.

Instances of `ChildProcess` are not intended to be created directly. Rather,
use the [`child_process.spawn()`][], [`child_process.exec()`][],
[`child_process.execFile()`][], or [`child_process.fork()`][] methods to create
instances of `ChildProcess`.

### Event: 'close'


* `code` {Number} the exit code if the child exited on its own.
* `signal` {String} the signal by which the child process was terminated.

The `'close'` event is emitted when the stdio streams of a child process have
been closed. This is distinct from the `'exit'` event, since multiple
processes might share the same stdio streams.

### Event: 'disconnect'


The `'disconnect'` event is emitted after calling the
`ChildProcess.disconnect()` method in the parent or child process. After
disconnecting it is no longer possible to send or receive messages, and the
`ChildProcess.connected` property is false.

### Event: 'error'

* `err` {Error} the error.

The `'error'` event is emitted whenever:

1. The process could not be spawned, or
2. The process could not be killed, or
3. Sending a message to the child process failed.

Note that the `'exit'` event may or may not fire after an error has occurred.
If you are listening to both the `'exit'` and `'error'` events, it is important
to guard against accidentally invoking handler functions multiple times.

See also [`ChildProcess#kill()`][] and [`ChildProcess#send()`][].

### Event: 'exit'


* `code` {Number} the exit code if the child exited on its own.
* `signal` {String} the signal by which the child process was terminated.

The `'exit'` event is emitted after the child process ends. If the process
exited, `code` is the final exit code of the process, otherwise `null`. If the
process terminated due to receipt of a signal, `signal` is the string name of
the signal, otherwise `null`. One of the two will always be non-null.

Note that when the `'exit'` event is triggered, child process stdio streams
might still be open.

Also, note that Node.js establishes signal handlers for `SIGINT` and
`SIGTERM` and Node.js processes will not terminate immediately due to receipt
of those signals. Rather, Node.js will perform a sequence of cleanup actions
and then will re-raise the handled signal.

See `waitpid(2)`.

### Event: 'message'


* `message` {Object} a parsed JSON object or primitive value.
* `sendHandle` {Handle} a [`net.Socket`][] or [`net.Server`][] object, or
  undefined.

The `'message'` event is triggered when a child process uses `process.send()`
to send messages.

### child.connected


* {Boolean} Set to false after `.disconnect` is called

The `child.connected` property indicates whether it is still possible to send
and receive messages from a child process. When `child.connected` is false, it
is no longer possible to send or receive messages.

### child.disconnect()


Closes the IPC channel between parent and child, allowing the child to exit
gracefully once there are no other connections keeping it alive. After calling
this method the `child.connected` and `process.connected` properties in both
the parent and child (respectively) will be set to `false`, and it will be no
longer possible to pass messages between the processes.

The `'disconnect'` event will be emitted when there are no messages in the
process of being received. This will most often be triggered immediately after
calling `child.disconnect()`.

Note that when the child process is a Node.js instance (e.g. spawned using
[`child_process.fork()`]), the `process.disconnect()` method can be invoked
within the child process to close the IPC channel as well.

### child.kill([signal])


* `signal` {String}

The `child.kill()` methods sends a signal to the child process. If no argument
is given, the process will be sent the `'SIGTERM'` signal. See signal(7) for
a list of available signals.

```js
const spawn = require('child_process').spawn;
const grep = spawn('grep', ['ssh']);

grep.on('close', (code, signal) => {
  console.log(
    `child process terminated due to receipt of signal ${signal}`);
});

// Send SIGHUP to process
grep.kill('SIGHUP');
```

The `ChildProcess` object may emit an `'error'` event if the signal cannot be
delivered. Sending a signal to a child process that has already exited is not
an error but may have unforeseen consequences. Specifically, if the process
identifier (PID) has been reassigned to another process, the signal will be
delivered to that process instead which can have unexpected results.

Note that while the function is called `kill`, the signal delivered to the
child process may not actually terminate the process.

See `kill(2)` for reference.

Also note: on Linux, child processes of child processes will not be terminated
when attempting to kill their parent. This is likely to happen when running a
new process in a shell or with use of the `shell` option of `ChildProcess`, such
as in this example:

```js
'use strict';
const spawn = require('child_process').spawn;

let child = spawn('sh', ['-c',
  `node -e "setInterval(() => {
      console.log(process.pid, 'is alive')
    }, 500);"`
  ], {
    stdio: ['inherit', 'inherit', 'inherit']
  });

setTimeout(() => {
  child.kill(); // does not terminate the node process in the shell
}, 2000);
```

### child.pid


* {Number} Integer

Returns the process identifier (PID) of the child process.

Example:

```js
const spawn = require('child_process').spawn;
const grep = spawn('grep', ['ssh']);

console.log(`Spawned child pid: ${grep.pid}`);
grep.stdin.end();
```

### child.send(message[, sendHandle][, callback])


* `message` {Object}
* `sendHandle` {Handle}
* `callback` {Function}
* Returns: {Boolean}

When an IPC channel has been established between the parent and child (
i.e. when using [`child_process.fork()`][]), the `child.send()` method can be
used to send messages to the child process. When the child process is a Node.js
instance, these messages can be received via the `process.on('message')` event.

For example, in the parent script:

```js
const cp = require('child_process');
const n = cp.fork(`${__dirname}/sub.js`);

n.on('message', (m) => {
  console.log('PARENT got message:', m);
});

n.send({ hello: 'world' });
```

And then the child script, `'sub.js'` might look like this:

```js
process.on('message', (m) => {
  console.log('CHILD got message:', m);
});

process.send({ foo: 'bar' });
```

Child Node.js processes will have a `process.send()` method of their own that
allows the child to send messages back to the parent.

There is a special case when sending a `{cmd: 'NODE_foo'}` message. All messages
containing a `NODE_` prefix in its `cmd` property are considered to be reserved
for use within Node.js core and will not be emitted in the child's
`process.on('message')` event. Rather, such messages are emitted using the
`process.on('internalMessage')` event and are consumed internally by Node.js.
Applications should avoid using such messages or listening for
`'internalMessage'` events as it is subject to change without notice.

The optional `sendHandle` argument that may be passed to `child.send()` is for
passing a TCP server or socket object to the child process. The child will
receive the object as the second argument passed to the callback function
registered on the `process.on('message')` event. Any data that is received and
buffered in the socket will not be sent to the child.

The optional `callback` is a function that is invoked after the message is
sent but before the child may have received it.  The function is called with a
single argument: `null` on success, or an [`Error`][] object on failure.

If no `callback` function is provided and the message cannot be sent, an
`'error'` event will be emitted by the `ChildProcess` object. This can happen,
for instance, when the child process has already exited.

`child.send()` will return `false` if the channel has closed or when the
backlog of unsent messages exceeds a threshold that makes it unwise to send
more. Otherwise, the method returns `true`. The `callback` function can be
used to implement flow control.

#### Example: sending a server object

The `sendHandle` argument can be used, for instance, to pass the handle of
a TCP server object to the child process as illustrated in the example below:

```js
const child = require('child_process').fork('child.js');

// Open up the server object and send the handle.
const server = require('net').createServer();
server.on('connection', (socket) => {
  socket.end('handled by parent');
});
server.listen(1337, () => {
  child.send('server', server);
});
```

The child would then receive the server object as:

```js
process.on('message', (m, server) => {
  if (m === 'server') {
    server.on('connection', (socket) => {
      socket.end('handled by child');
    });
  }
});
```

Once the server is now shared between the parent and child, some connections
can be handled by the parent and some by the child.

While the example above uses a server created using the `net` module, `dgram`
module servers use exactly the same workflow with the exceptions of listening on
a `'message'` event instead of `'connection'` and using `server.bind` instead of
`server.listen`. This is, however, currently only supported on UNIX platforms.

#### Example: sending a socket object

Similarly, the `sendHandler` argument can be used to pass the handle of a
socket to the child process. The example below spawns two children that each
handle connections with "normal" or "special" priority:

```js
const normal = require('child_process').fork('child.js', ['normal']);
const special = require('child_process').fork('child.js', ['special']);

// Open up the server and send sockets to child
const server = require('net').createServer();
server.on('connection', (socket) => {

  // If this is special priority
  if (socket.remoteAddress === '74.125.127.100') {
    special.send('socket', socket);
    return;
  }
  // This is normal priority
  normal.send('socket', socket);
});
server.listen(1337);
```

The `child.js` would receive the socket handle as the second argument passed
to the event callback function:

```js
process.on('message', (m, socket) => {
  if (m === 'socket') {
    socket.end(`Request handled with ${process.argv[2]} priority`);
  }
});
```

Once a socket has been passed to a child, the parent is no longer capable of
tracking when the socket is destroyed. To indicate this, the `.connections`
property becomes `null`. It is recommended not to use `.maxConnections` when
this occurs.

*Note: this function uses [`JSON.stringify()`][] internally to serialize the `message`.*

### child.stderr


* {Stream}

A `Readable Stream` that represents the child process's `stderr`.

If the child was spawned with `stdio[2]` set to anything other than `'pipe'`,
then this will be `undefined`.

`child.stderr` is an alias for `child.stdio[2]`. Both properties will refer to
the same value.

### child.stdin


* {Stream}

A `Writable Stream` that represents the child process's `stdin`.

*Note that if a child process waits to read all of its input, the child will not
continue until this stream has been closed via `end()`.*

If the child was spawned with `stdio[0]` set to anything other than `'pipe'`,
then this will be `undefined`.

`child.stdin` is an alias for `child.stdio[0]`. Both properties will refer to
the same value.

### child.stdio


* {Array}

A sparse array of pipes to the child process, corresponding with positions in
the [`stdio`][] option passed to [`child_process.spawn()`][] that have been set
to the value `'pipe'`. Note that `child.stdio[0]`, `child.stdio[1]`, and
`child.stdio[2]` are also available as `child.stdin`, `child.stdout`, and
`child.stderr`, respectively.

In the following example, only the child's fd `1` (stdout) is configured as a
pipe, so only the parent's `child.stdio[1]` is a stream, all other values in
the array are `null`.

```js
const assert = require('assert');
const fs = require('fs');
const child_process = require('child_process');

const child = child_process.spawn('ls', {
    stdio: [
      0, // Use parents stdin for child
      'pipe', // Pipe child's stdout to parent
      fs.openSync('err.out', 'w') // Direct child's stderr to a file
    ]
});

assert.equal(child.stdio[0], null);
assert.equal(child.stdio[0], child.stdin);

assert(child.stdout);
assert.equal(child.stdio[1], child.stdout);

assert.equal(child.stdio[2], null);
assert.equal(child.stdio[2], child.stderr);
```

### child.stdout


* {Stream}

A `Readable Stream` that represents the child process's `stdout`.

If the child was spawned with `stdio[1]` set to anything other than `'pipe'`,
then this will be `undefined`.

`child.stdout` is an alias for `child.stdio[1]`. Both properties will refer
to the same value.

[`popen(3)`]: http://linux.die.net/man/3/popen
[`ChildProcess`]: #child_process_child_process
[`child_process.exec()`]: #child_process_child_process_exec_command_options_callback
[`child_process.execFile()`]: #child_process_child_process_execfile_file_args_options_callback
[`child_process.fork()`]: #child_process_child_process_fork_modulepath_args_options
[`child_process.spawn()`]: #child_process_child_process_spawn_command_args_options
[`child_process.spawnSync()`]: #child_process_child_process_spawnsync_command_args_options
[`ChildProcess#kill()`]: #child_process_child_kill_signal
[`ChildProcess#send()`]: #child_process_child_send_message_sendhandle_callback
[`Error`]: errors.html#errors_class_error
[`EventEmitter`]: events.html#events_class_events_eventemitter
[`EventEmitters`]: events.html#events_class_events_eventemitter
[`net.Server`]: net.html#net_class_net_server
[`net.Socket`]: net.html#net_class_net_socket
[`options.detached`]: #child_process_options_detached
[`options.stdio`]: #child_process_options_stdio
[`stdio`]: #child_process_options_stdio
[synchronous counterparts]: #child_process_synchronous_process_creation
[`JSON.stringify()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify
node-v4.8.2/doc/api/cli.html000644 000766 000024 00000040023 13070706740 015726 0ustar00iojsstaff000000 000000 


  
  Command Line Options | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

      

        
Command Line Options#



Node.js comes with a variety of CLI options. These options expose built-in
debugging, multiple ways to execute scripts, and other helpful runtime options.


To view this documentation as a manual page in your terminal, run man node.


Synopsis#


node [options] [v8 options] [script.js | -e "script"] [arguments]


node debug [script.js | -e "script" | <host>:<port>] …


node --v8-options


Execute without arguments to start the REPL.


For more info about node debug, please see the debugger documentation.


Options#


-v, --version#



Added in: v0.1.3

Print node's version.


-h, --help#



Added in: v0.1.3

Print node command line options.
The output of this option is less detailed than this document.


-e, --eval "script"#



Added in: v0.5.2

Evaluate the following argument as JavaScript.


-p, --print "script"#



Added in: v0.6.4

Identical to -e but prints the result.


-c, --check#



Added in: v4.2.0

Syntax check the script without executing.


-i, --interactive#



Added in: v0.7.7

Opens the REPL even if stdin does not appear to be a terminal.


-r, --require module#



Added in: v1.6.0

Preload the specified module at startup.


Follows require()'s module resolution
rules. module may be either a path to a file, or a node module name.


--no-deprecation#



Added in: v0.8.0

Silence deprecation warnings.


--trace-deprecation#



Added in: v0.8.0

Print stack traces for deprecations.


--throw-deprecation#



Added in: v0.11.14

Throw errors for deprecations.


--trace-sync-io#



Added in: v2.1.0

Prints a stack trace whenever synchronous I/O is detected after the first turn
of the event loop.


--zero-fill-buffers#



Added in: v4.5.0

Automatically zero-fills all newly allocated Buffer and SlowBuffer
instances.


--track-heap-objects#



Added in: v2.4.0

Track heap object allocations for heap snapshots.


--prof-process#



Added in: v4.4.0

Process v8 profiler output generated using the v8 option --prof.


--v8-options#



Added in: v0.1.3

Print v8 command line options.


--tls-cipher-list=list#



Added in: v4.0.0

Specify an alternative default TLS cipher list. (Requires Node.js to be built
with crypto support. (Default))


--enable-fips#


Enable FIPS-compliant crypto at startup. (Requires Node.js to be built with
./configure --openssl-fips)


--force-fips#


Force FIPS-compliant crypto on startup. (Cannot be disabled from script code.)
(Same requirements as --enable-fips)


--icu-data-dir=file#



Added in: v0.11.15

Specify ICU data load path. (overrides NODE_ICU_DATA)


Environment Variables#


NODE_DEBUG=module[,…]#



Added in: v0.1.32

','-separated list of core modules that should print debug information.


NODE_PATH=path[:…]#



Added in: v0.1.32

':'-separated list of directories prefixed to the module search path.


Note: on Windows, this is a ';'-separated list instead.


NODE_DISABLE_COLORS=1#



Added in: v0.3.0

When set to 1 colors will not be used in the REPL.


NODE_ICU_DATA=file#



Added in: v0.11.15

Data path for ICU (Intl object) data. Will extend linked-in data when compiled
with small-icu support.


NODE_REPL_HISTORY=file#



Added in: v3.0.0

Path to the file used to store the persistent REPL history. The default path is
~/.node_repl_history, which is overridden by this variable. Setting the value
to an empty string ("" or " ") disables persistent REPL history.


NODE_EXTRA_CA_CERTS=file#



Added in: XXX

When set, the well known "root" CAs (like VeriSign) will be extended with the
extra certificates in file. The file should consist of one or more trusted
certificates in PEM format. A message will be printed to stderr (once)
if the file is missing or
misformatted, but any errors are otherwise ignored.


Note that neither the well known nor extra certificates are used when the ca
options property is explicitly specified for a TLS or HTTPS client or server.


      

    

  

  
  
  
  



node-v4.8.2/doc/api/cli.json000644 000766 000024 00000031071 13070706740 015736 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/cli.md",
  "miscs": [
    {
      "textRaw": "Command Line Options",
      "name": "Command Line Options",
      "type": "misc",
      "desc": "
Node.js comes with a variety of CLI options. These options expose built-in\ndebugging, multiple ways to execute scripts, and other helpful runtime options.
\n
To view this documentation as a manual page in your terminal, run man node.
\n",
      "miscs": [
        {
          "textRaw": "Synopsis",
          "name": "synopsis",
          "desc": "
node [options] [v8 options] [script.js | -e "script"] [arguments]
\n
node debug [script.js | -e "script" | <host>:<port>] …
\n
node --v8-options
\n
Execute without arguments to start the REPL.
\n
For more info about node debug, please see the debugger documentation.
\n",
          "type": "misc",
          "displayName": "Synopsis"
        },
        {
          "textRaw": "Options",
          "name": "options",
          "modules": [
            {
              "textRaw": "`-v`, `--version`",
              "name": "`-v`,_`--version`",
              "meta": {
                "added": [
                  "v0.1.3"
                ]
              },
              "desc": "
Print node's version.
\n",
              "type": "module",
              "displayName": "`-v`, `--version`"
            },
            {
              "textRaw": "`-h`, `--help`",
              "name": "`-h`,_`--help`",
              "meta": {
                "added": [
                  "v0.1.3"
                ]
              },
              "desc": "
Print node command line options.\nThe output of this option is less detailed than this document.
\n",
              "type": "module",
              "displayName": "`-h`, `--help`"
            },
            {
              "textRaw": "`-e`, `--eval \"script\"`",
              "name": "`-e`,_`--eval_\"script\"`",
              "meta": {
                "added": [
                  "v0.5.2"
                ]
              },
              "desc": "
Evaluate the following argument as JavaScript.
\n",
              "type": "module",
              "displayName": "`-e`, `--eval \"script\"`"
            },
            {
              "textRaw": "`-p`, `--print \"script\"`",
              "name": "`-p`,_`--print_\"script\"`",
              "meta": {
                "added": [
                  "v0.6.4"
                ]
              },
              "desc": "
Identical to -e but prints the result.
\n",
              "type": "module",
              "displayName": "`-p`, `--print \"script\"`"
            },
            {
              "textRaw": "`-c`, `--check`",
              "name": "`-c`,_`--check`",
              "meta": {
                "added": [
                  "v4.2.0"
                ]
              },
              "desc": "
Syntax check the script without executing.
\n",
              "type": "module",
              "displayName": "`-c`, `--check`"
            },
            {
              "textRaw": "`-i`, `--interactive`",
              "name": "`-i`,_`--interactive`",
              "meta": {
                "added": [
                  "v0.7.7"
                ]
              },
              "desc": "
Opens the REPL even if stdin does not appear to be a terminal.
\n",
              "type": "module",
              "displayName": "`-i`, `--interactive`"
            },
            {
              "textRaw": "`-r`, `--require module`",
              "name": "`-r`,_`--require_module`",
              "meta": {
                "added": [
                  "v1.6.0"
                ]
              },
              "desc": "
Preload the specified module at startup.
\n
Follows require()'s module resolution\nrules. module may be either a path to a file, or a node module name.
\n",
              "type": "module",
              "displayName": "`-r`, `--require module`"
            },
            {
              "textRaw": "`--no-deprecation`",
              "name": "`--no-deprecation`",
              "meta": {
                "added": [
                  "v0.8.0"
                ]
              },
              "desc": "
Silence deprecation warnings.
\n",
              "type": "module",
              "displayName": "`--no-deprecation`"
            },
            {
              "textRaw": "`--trace-deprecation`",
              "name": "`--trace-deprecation`",
              "meta": {
                "added": [
                  "v0.8.0"
                ]
              },
              "desc": "
Print stack traces for deprecations.
\n",
              "type": "module",
              "displayName": "`--trace-deprecation`"
            },
            {
              "textRaw": "`--throw-deprecation`",
              "name": "`--throw-deprecation`",
              "meta": {
                "added": [
                  "v0.11.14"
                ]
              },
              "desc": "
Throw errors for deprecations.
\n",
              "type": "module",
              "displayName": "`--throw-deprecation`"
            },
            {
              "textRaw": "`--trace-sync-io`",
              "name": "`--trace-sync-io`",
              "meta": {
                "added": [
                  "v2.1.0"
                ]
              },
              "desc": "
Prints a stack trace whenever synchronous I/O is detected after the first turn\nof the event loop.
\n",
              "type": "module",
              "displayName": "`--trace-sync-io`"
            },
            {
              "textRaw": "`--zero-fill-buffers`",
              "name": "`--zero-fill-buffers`",
              "meta": {
                "added": [
                  "v4.5.0"
                ]
              },
              "desc": "
Automatically zero-fills all newly allocated Buffer and SlowBuffer\ninstances.
\n",
              "type": "module",
              "displayName": "`--zero-fill-buffers`"
            },
            {
              "textRaw": "`--track-heap-objects`",
              "name": "`--track-heap-objects`",
              "meta": {
                "added": [
                  "v2.4.0"
                ]
              },
              "desc": "
Track heap object allocations for heap snapshots.
\n",
              "type": "module",
              "displayName": "`--track-heap-objects`"
            },
            {
              "textRaw": "`--prof-process`",
              "name": "`--prof-process`",
              "meta": {
                "added": [
                  "v4.4.0"
                ]
              },
              "desc": "
Process v8 profiler output generated using the v8 option --prof.
\n",
              "type": "module",
              "displayName": "`--prof-process`"
            },
            {
              "textRaw": "`--v8-options`",
              "name": "`--v8-options`",
              "meta": {
                "added": [
                  "v0.1.3"
                ]
              },
              "desc": "
Print v8 command line options.
\n",
              "type": "module",
              "displayName": "`--v8-options`"
            },
            {
              "textRaw": "`--tls-cipher-list=list`",
              "name": "`--tls-cipher-list=list`",
              "meta": {
                "added": [
                  "v4.0.0"
                ]
              },
              "desc": "
Specify an alternative default TLS cipher list. (Requires Node.js to be built\nwith crypto support. (Default))
\n",
              "type": "module",
              "displayName": "`--tls-cipher-list=list`"
            },
            {
              "textRaw": "`--enable-fips`",
              "name": "`--enable-fips`",
              "desc": "
Enable FIPS-compliant crypto at startup. (Requires Node.js to be built with\n./configure --openssl-fips)
\n",
              "type": "module",
              "displayName": "`--enable-fips`"
            },
            {
              "textRaw": "`--force-fips`",
              "name": "`--force-fips`",
              "desc": "
Force FIPS-compliant crypto on startup. (Cannot be disabled from script code.)\n(Same requirements as --enable-fips)
\n",
              "type": "module",
              "displayName": "`--force-fips`"
            },
            {
              "textRaw": "`--icu-data-dir=file`",
              "name": "`--icu-data-dir=file`",
              "meta": {
                "added": [
                  "v0.11.15"
                ]
              },
              "desc": "
Specify ICU data load path. (overrides NODE_ICU_DATA)
\n",
              "type": "module",
              "displayName": "`--icu-data-dir=file`"
            }
          ],
          "type": "misc",
          "displayName": "Options"
        },
        {
          "textRaw": "Environment Variables",
          "name": "environment_variables",
          "modules": [
            {
              "textRaw": "`NODE_DEBUG=module[,…]`",
              "name": "`node_debug=module[,…]`",
              "meta": {
                "added": [
                  "v0.1.32"
                ]
              },
              "desc": "
','-separated list of core modules that should print debug information.
\n",
              "type": "module",
              "displayName": "`NODE_DEBUG=module[,…]`"
            },
            {
              "textRaw": "`NODE_PATH=path[:…]`",
              "name": "`node_path=path[:…]`",
              "meta": {
                "added": [
                  "v0.1.32"
                ]
              },
              "desc": "
':'-separated list of directories prefixed to the module search path.
\n
Note: on Windows, this is a ';'-separated list instead.
\n",
              "type": "module",
              "displayName": "`NODE_PATH=path[:…]`"
            },
            {
              "textRaw": "`NODE_DISABLE_COLORS=1`",
              "name": "`node_disable_colors=1`",
              "meta": {
                "added": [
                  "v0.3.0"
                ]
              },
              "desc": "
When set to 1 colors will not be used in the REPL.
\n",
              "type": "module",
              "displayName": "`NODE_DISABLE_COLORS=1`"
            },
            {
              "textRaw": "`NODE_ICU_DATA=file`",
              "name": "`node_icu_data=file`",
              "meta": {
                "added": [
                  "v0.11.15"
                ]
              },
              "desc": "
Data path for ICU (Intl object) data. Will extend linked-in data when compiled\nwith small-icu support.
\n",
              "type": "module",
              "displayName": "`NODE_ICU_DATA=file`"
            },
            {
              "textRaw": "`NODE_REPL_HISTORY=file`",
              "name": "`node_repl_history=file`",
              "meta": {
                "added": [
                  "v3.0.0"
                ]
              },
              "desc": "
Path to the file used to store the persistent REPL history. The default path is\n~/.node_repl_history, which is overridden by this variable. Setting the value\nto an empty string ("" or " ") disables persistent REPL history.
\n",
              "type": "module",
              "displayName": "`NODE_REPL_HISTORY=file`"
            },
            {
              "textRaw": "`NODE_EXTRA_CA_CERTS=file`",
              "name": "`node_extra_ca_certs=file`",
              "meta": {
                "added": [
                  "XXX"
                ]
              },
              "desc": "
When set, the well known "root" CAs (like VeriSign) will be extended with the\nextra certificates in file. The file should consist of one or more trusted\ncertificates in PEM format. A message will be printed to stderr (once)\nif the file is missing or\nmisformatted, but any errors are otherwise ignored.
\n
Note that neither the well known nor extra certificates are used when the ca\noptions property is explicitly specified for a TLS or HTTPS client or server.
\n",
              "type": "module",
              "displayName": "`NODE_EXTRA_CA_CERTS=file`"
            }
          ],
          "type": "misc",
          "displayName": "Environment Variables"
        }
      ]
    }
  ]
}
node-v4.8.2/doc/api/cli.md000644 000766 000024 00000010630 13070706735 015367 0ustar00iojsstaff000000 000000 # Command Line Options



Node.js comes with a variety of CLI options. These options expose built-in
debugging, multiple ways to execute scripts, and other helpful runtime options.

To view this documentation as a manual page in your terminal, run `man node`.


## Synopsis

`node [options] [v8 options] [script.js | -e "script"] [arguments]`

`node debug [script.js | -e "script" | :] …`

`node --v8-options`

Execute without arguments to start the [REPL][].

_For more info about `node debug`, please see the [debugger][] documentation._


## Options

### `-v`, `--version`


Print node's version.


### `-h`, `--help`


Print node command line options.
The output of this option is less detailed than this document.


### `-e`, `--eval "script"`


Evaluate the following argument as JavaScript.


### `-p`, `--print "script"`


Identical to `-e` but prints the result.


### `-c`, `--check`


Syntax check the script without executing.


### `-i`, `--interactive`


Opens the REPL even if stdin does not appear to be a terminal.


### `-r`, `--require module`


Preload the specified module at startup.

Follows `require()`'s module resolution
rules. `module` may be either a path to a file, or a node module name.


### `--no-deprecation`


Silence deprecation warnings.


### `--trace-deprecation`


Print stack traces for deprecations.


### `--throw-deprecation`


Throw errors for deprecations.


### `--trace-sync-io`


Prints a stack trace whenever synchronous I/O is detected after the first turn
of the event loop.


### `--zero-fill-buffers`


Automatically zero-fills all newly allocated [Buffer][] and [SlowBuffer][]
instances.


### `--track-heap-objects`


Track heap object allocations for heap snapshots.


### `--prof-process`


Process v8 profiler output generated using the v8 option `--prof`.


### `--v8-options`


Print v8 command line options.


### `--tls-cipher-list=list`


Specify an alternative default TLS cipher list. (Requires Node.js to be built
with crypto support. (Default))


### `--enable-fips`

Enable FIPS-compliant crypto at startup. (Requires Node.js to be built with
`./configure --openssl-fips`)


### `--force-fips`

Force FIPS-compliant crypto on startup. (Cannot be disabled from script code.)
(Same requirements as `--enable-fips`)


### `--icu-data-dir=file`


Specify ICU data load path. (overrides `NODE_ICU_DATA`)


## Environment Variables

### `NODE_DEBUG=module[,…]`


`','`-separated list of core modules that should print debug information.


### `NODE_PATH=path[:…]`


`':'`-separated list of directories prefixed to the module search path.

_Note: on Windows, this is a `';'`-separated list instead._


### `NODE_DISABLE_COLORS=1`


When set to `1` colors will not be used in the REPL.


### `NODE_ICU_DATA=file`


Data path for ICU (Intl object) data. Will extend linked-in data when compiled
with small-icu support.


### `NODE_REPL_HISTORY=file`


Path to the file used to store the persistent REPL history. The default path is
`~/.node_repl_history`, which is overridden by this variable. Setting the value
to an empty string (`""` or `" "`) disables persistent REPL history.


### `NODE_EXTRA_CA_CERTS=file`


When set, the well known "root" CAs (like VeriSign) will be extended with the
extra certificates in `file`. The file should consist of one or more trusted
certificates in PEM format. A message will be printed to stderr (once)
if the file is missing or
misformatted, but any errors are otherwise ignored.

Note that neither the well known nor extra certificates are used when the `ca`
options property is explicitly specified for a TLS or HTTPS client or server.

[emit_warning]: process.html#process_process_emitwarning_warning_name_ctor
[Buffer]: buffer.html#buffer_buffer
[debugger]: debugger.html
[REPL]: repl.html
[SlowBuffer]: buffer.html#buffer_class_slowbuffer
node-v4.8.2/doc/api/cluster.html000644 000766 000024 00000123051 13070706740 016643 0ustar00iojsstaff000000 000000 


  
  Cluster | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

      

        
Cluster#


Stability: 2 - Stable
A single instance of Node.js runs in a single thread. To take advantage of
multi-core systems the user will sometimes want to launch a cluster of Node.js
processes to handle the load.


The cluster module allows you to easily create child processes that
all share server ports.


const cluster = require('cluster');
const http = require('http');
const numCPUs = require('os').cpus().length;

if (cluster.isMaster) {
  // Fork workers.
  for (var i = 0; i < numCPUs; i++) {
    cluster.fork();
  }

  cluster.on('exit', (worker, code, signal) => {
    console.log(`worker ${worker.process.pid} died`);
  });
} else {
  // Workers can share any TCP connection
  // In this case it is an HTTP server
  http.createServer((req, res) => {
    res.writeHead(200);
    res.end('hello world\n');
  }).listen(8000);
}



Running Node.js will now share port 8000 between the workers:


$ NODE_DEBUG=cluster node server.js
23521,Master Worker 23524 online
23521,Master Worker 23526 online
23521,Master Worker 23523 online
23521,Master Worker 23528 online

Please note that, on Windows, it is not yet possible to set up a named pipe
server in a worker.


How It Works#



The worker processes are spawned using the child_process.fork() method,
so that they can communicate with the parent via IPC and pass server
handles back and forth.


The cluster module supports two methods of distributing incoming
connections.


The first one (and the default one on all platforms except Windows),
is the round-robin approach, where the master process listens on a
port, accepts new connections and distributes them across the workers
in a round-robin fashion, with some built-in smarts to avoid
overloading a worker process.


The second approach is where the master process creates the listen
socket and sends it to interested workers. The workers then accept
incoming connections directly.


The second approach should, in theory, give the best performance.
In practice however, distribution tends to be very unbalanced due
to operating system scheduler vagaries. Loads have been observed
where over 70% of all connections ended up in just two processes,
out of a total of eight.


Because server.listen() hands off most of the work to the master
process, there are three cases where the behavior between a normal
Node.js process and a cluster worker differs:


    

  1. server.listen({fd: 7}) Because the message is passed to the master,
file descriptor 7 in the parent will be listened on, and the
handle passed to the worker, rather than listening to the worker's
idea of what the number 7 file descriptor references.
    2. 

  2. server.listen(handle) Listening on handles explicitly will cause
the worker to use the supplied handle, rather than talk to the master
process.  If the worker already has the handle, then it's presumed
that you know what you are doing.
    3. 

  3. server.listen(0) Normally, this will cause servers to listen on a
random port.  However, in a cluster, each worker will receive the
same "random" port each time they do listen(0).  In essence, the
port is random the first time, but predictable thereafter.  If you
want to listen on a unique port, generate a port number based on the
cluster worker ID.
    4. 



There is no routing logic in Node.js, or in your program, and no shared
state between the workers.  Therefore, it is important to design your
program such that it does not rely too heavily on in-memory data objects
for things like sessions and login.


Because workers are all separate processes, they can be killed or
re-spawned depending on your program's needs, without affecting other
workers.  As long as there are some workers still alive, the server will
continue to accept connections.  If no workers are alive, existing connections
will be dropped and new connections will be refused.  Node.js does not
automatically manage the number of workers for you, however.  It is your
responsibility to manage the worker pool for your application's needs.


Class: Worker#



Added in: v0.7.0

A Worker object contains all public information and method about a worker.
In the master it can be obtained using cluster.workers. In a worker
it can be obtained using cluster.worker.


Event: 'disconnect'#



Added in: v0.7.7

Similar to the cluster.on('disconnect') event, but specific to this worker.


cluster.fork().on('disconnect', () => {
  // Worker has disconnected
});



Event: 'error'#



Added in: v0.7.3

This event is the same as the one provided by child_process.fork().


In a worker you can also use process.on('error').


Event: 'exit'#



Added in: v0.11.2

    

  • code <Number> the exit code, if it exited normally.
    • 

  • signal <String> the name of the signal (e.g. 'SIGHUP') that caused
the process to be killed.
    • 



Similar to the cluster.on('exit') event, but specific to this worker.


const worker = cluster.fork();
worker.on('exit', (code, signal) => {
  if (signal) {
    console.log(`worker was killed by signal: ${signal}`);
  } else if (code !== 0) {
    console.log(`worker exited with error code: ${code}`);
  } else {
    console.log('worker success!');
  }
});



Event: 'listening'#



Added in: v0.7.0



Similar to the cluster.on('listening') event, but specific to this worker.


cluster.fork().on('listening', (address) => {
  // Worker is listening
});



It is not emitted in the worker.


Event: 'message'#



Added in: v0.7.0



Similar to the cluster.on('message') event, but specific to this worker. In a
worker you can also use process.on('message').


See process event: 'message'.


As an example, here is a cluster that keeps count of the number of requests
in the master process using the message system:


const cluster = require('cluster');
const http = require('http');

if (cluster.isMaster) {

  // Keep track of http requests
  var numReqs = 0;
  setInterval(() => {
    console.log('numReqs =', numReqs);
  }, 1000);

  // Count requests
  function messageHandler(msg) {
    if (msg.cmd && msg.cmd == 'notifyRequest') {
      numReqs += 1;
    }
  }

  // Start workers and listen for messages containing notifyRequest
  const numCPUs = require('os').cpus().length;
  for (var i = 0; i < numCPUs; i++) {
    cluster.fork();
  }

  Object.keys(cluster.workers).forEach((id) => {
    cluster.workers[id].on('message', messageHandler);
  });

} else {

  // Worker processes have a http server.
  http.Server((req, res) => {
    res.writeHead(200);
    res.end('hello world\n');

    // notify master about the request
    process.send({ cmd: 'notifyRequest' });
  }).listen(8000);
}



Event: 'online'#



Added in: v0.7.0

Similar to the cluster.on('online') event, but specific to this worker.


cluster.fork().on('online', () => {
  // Worker is online
});



It is not emitted in the worker.


worker.disconnect()#



Added in: v0.7.7

In a worker, this function will close all servers, wait for the 'close' event on
those servers, and then disconnect the IPC channel.


In the master, an internal message is sent to the worker causing it to call
.disconnect() on itself.


Causes .suicide to be set.


Note that after a server is closed, it will no longer accept new connections,
but connections may be accepted by any other listening worker. Existing
connections will be allowed to close as usual. When no more connections exist,
see server.close(), the IPC channel to the worker will close allowing it to
die gracefully.


The above applies only to server connections, client connections are not
automatically closed by workers, and disconnect does not wait for them to close
before exiting.


Note that in a worker, process.disconnect exists, but it is not this function,
it is disconnect.


Because long living server connections may block workers from disconnecting, it
may be useful to send a message, so application specific actions may be taken to
close them. It also may be useful to implement a timeout, killing a worker if
the 'disconnect' event has not been emitted after some time.


if (cluster.isMaster) {
  var worker = cluster.fork();
  var timeout;

  worker.on('listening', (address) => {
    worker.send('shutdown');
    worker.disconnect();
    timeout = setTimeout(() => {
      worker.kill();
    }, 2000);
  });

  worker.on('disconnect', () => {
    clearTimeout(timeout);
  });

} else if (cluster.isWorker) {
  const net = require('net');
  var server = net.createServer((socket) => {
    // connections never end
  });

  server.listen(8000);

  process.on('message', (msg) => {
    if (msg === 'shutdown') {
      // initiate graceful close of any connections to server
    }
  });
}



worker.id#



Added in: v0.8.0



Each new worker is given its own unique id, this id is stored in the
id.


While a worker is alive, this is the key that indexes it in
cluster.workers


worker.isConnected()#



Added in: v0.11.14

This function returns true if the worker is connected to its master via its IPC
channel, false otherwise. A worker is connected to its master after it's been
created. It is disconnected after the 'disconnect' event is emitted.


worker.isDead()#



Added in: v0.11.14

This function returns true if the worker's process has terminated (either
because of exiting or being signaled). Otherwise, it returns false.


worker.kill([signal='SIGTERM'])#



Added in: v0.9.12

    

  • signal <String> Name of the kill signal to send to the worker
process.
    • 



This function will kill the worker. In the master, it does this by disconnecting
the worker.process, and once disconnected, killing with signal. In the
worker, it does it by disconnecting the channel, and then exiting with code 0.


Causes .suicide to be set.


This method is aliased as worker.destroy() for backwards compatibility.


Note that in a worker, process.kill() exists, but it is not this function,
it is kill.


worker.process#



Added in: v0.7.0



All workers are created using child_process.fork(), the returned object
from this function is stored as .process. In a worker, the global process
is stored.


See: Child Process module


Note that workers will call process.exit(0) if the 'disconnect' event occurs
on process and .suicide is not true. This protects against accidental
disconnection.


worker.send(message[, sendHandle][, callback])#



Added in: v0.7.0



Send a message to a worker or master, optionally with a handle.


In the master this sends a message to a specific worker. It is identical to
ChildProcess.send().


In a worker this sends a message to the master. It is identical to
process.send().


This example will echo back all messages from the master:


if (cluster.isMaster) {
  var worker = cluster.fork();
  worker.send('hi there');

} else if (cluster.isWorker) {
  process.on('message', (msg) => {
    process.send(msg);
  });
}



worker.suicide#



Added in: v0.7.0
Deprecated since: v6.0.0 



Set by calling .kill() or .disconnect(), until then it is undefined.


The boolean worker.suicide lets you distinguish between voluntary and accidental
exit, the master may choose not to respawn a worker based on this value.


cluster.on('exit', (worker, code, signal) => {
  if (worker.suicide === true) {
    console.log('Oh, it was just suicide\' – no need to worry').
  }
});

// kill worker
worker.kill();



Event: 'disconnect'#



Added in: v0.7.9



Emitted after the worker IPC channel has disconnected. This can occur when a
worker exits gracefully, is killed, or is disconnected manually (such as with
worker.disconnect()).


There may be a delay between the 'disconnect' and 'exit' events.  These events
can be used to detect if the process is stuck in a cleanup or if there are
long-living connections.


cluster.on('disconnect', (worker) => {
  console.log(`The worker #${worker.id} has disconnected`);
});



Event: 'exit'#



Added in: v0.7.9

    

  • worker <cluster.Worker>
    • 

  • code <Number> the exit code, if it exited normally.
    • 

  • signal <String> the name of the signal (e.g. 'SIGHUP') that caused
the process to be killed.
    • 



When any of the workers die the cluster module will emit the 'exit' event.


This can be used to restart the worker by calling .fork() again.


cluster.on('exit', (worker, code, signal) => {
  console.log('worker %d died (%s). restarting...',
    worker.process.pid, signal || code);
  cluster.fork();
});



See child_process event: 'exit'.


Event: 'fork'#



Added in: v0.7.0



When a new worker is forked the cluster module will emit a 'fork' event.
This can be used to log worker activity, and create your own timeout.


var timeouts = [];
function errorMsg() {
  console.error('Something must be wrong with the connection ...');
}

cluster.on('fork', (worker) => {
  timeouts[worker.id] = setTimeout(errorMsg, 2000);
});
cluster.on('listening', (worker, address) => {
  clearTimeout(timeouts[worker.id]);
});
cluster.on('exit', (worker, code, signal) => {
  clearTimeout(timeouts[worker.id]);
  errorMsg();
});



Event: 'listening'#



Added in: v0.7.0



After calling listen() from a worker, when the 'listening' event is emitted on
the server, a 'listening' event will also be emitted on cluster in the master.


The event handler is executed with two arguments, the worker contains the worker
object and the address object contains the following connection properties:
address, port and addressType. This is very useful if the worker is listening
on more than one address.


cluster.on('listening', (worker, address) => {
  console.log(
    `A worker is now connected to ${address.address}:${address.port}`);
});



The addressType is one of:


    

  • 4 (TCPv4)
    • 

  • 6 (TCPv6)
    • 

  • -1 (unix domain socket)
    • 

  • "udp4" or "udp6" (UDP v4 or v6)
    • 



Event: 'message'#




Emitted when the cluster master receives a message from any worker.


See child_process event: 'message'.


Event: 'online'#



Added in: v0.7.0



After forking a new worker, the worker should respond with an online message.
When the master receives an online message it will emit this event.
The difference between 'fork' and 'online' is that fork is emitted when the
master forks a worker, and 'online' is emitted when the worker is running.


cluster.on('online', (worker) => {
  console.log('Yay, the worker responded after it was forked');
});



Event: 'setup'#



Added in: v0.7.1



Emitted every time .setupMaster() is called.


The settings object is the cluster.settings object at the time
.setupMaster() was called and is advisory only, since multiple calls to
.setupMaster() can be made in a single tick.


If accuracy is important, use cluster.settings.


cluster.disconnect([callback])#



Added in: v0.7.7

    

  • callback <Function> called when all workers are disconnected and handles are
closed
    • 



Calls .disconnect() on each worker in cluster.workers.


When they are disconnected all internal handles will be closed, allowing the
master process to die gracefully if no other event is waiting.


The method takes an optional callback argument which will be called when finished.


This can only be called from the master process.


cluster.fork([env])#



Added in: v0.6.0



Spawn a new worker process.


This can only be called from the master process.


cluster.isMaster#



Added in: v0.8.1



True if the process is a master. This is determined
by the process.env.NODE_UNIQUE_ID. If process.env.NODE_UNIQUE_ID is
undefined, then isMaster is true.


cluster.isWorker#



Added in: v0.6.0



True if the process is not a master (it is the negation of cluster.isMaster).


cluster.schedulingPolicy#



Added in: v0.11.2

The scheduling policy, either cluster.SCHED_RR for round-robin or
cluster.SCHED_NONE to leave it to the operating system. This is a
global setting and effectively frozen once you spawn the first worker
or call cluster.setupMaster(), whatever comes first.


SCHED_RR is the default on all operating systems except Windows.
Windows will change to SCHED_RR once libuv is able to effectively
distribute IOCP handles without incurring a large performance hit.


cluster.schedulingPolicy can also be set through the
NODE_CLUSTER_SCHED_POLICY environment variable. Valid
values are "rr" and "none".


cluster.settings#



Added in: v0.7.1

    

  • <Object>
      

    • execArgv <Array> list of string arguments passed to the Node.js
executable. (Default=process.execArgv)
      • 

    • exec <String> file path to worker file.  (Default=process.argv[1])
      • 

    • args <Array> string arguments passed to worker.
(Default=process.argv.slice(2))
      • 

    • silent <Boolean> whether or not to send output to parent's stdio.
(Default=false)
      • 

    • uid <Number> Sets the user identity of the process. (See setuid(2).)
      • 

    • gid <Number> Sets the group identity of the process. (See setgid(2).)
      • 

    

    • 



After calling .setupMaster() (or .fork()) this settings object will contain
the settings, including the default values.


This object is not supposed to be changed or set manually, by you.


cluster.setupMaster([settings])#



Added in: v0.7.1

    

  • settings <Object>
      

    • exec <String> file path to worker file.  (Default=process.argv[1])
      • 

    • args <Array> string arguments passed to worker.
(Default=process.argv.slice(2))
      • 

    • silent <Boolean> whether or not to send output to parent's stdio.
(Default=false)
      • 

    

    • 



setupMaster is used to change the default 'fork' behavior. Once called,
the settings will be present in cluster.settings.


Note that:


    

  • any settings changes only affect future calls to .fork() and have no
effect on workers that are already running
    • 

  • The only attribute of a worker that cannot be set via .setupMaster() is
the env passed to .fork()
    • 

  • the defaults above apply to the first call only, the defaults for later
calls is the current value at the time of cluster.setupMaster() is called
    • 



Example:


const cluster = require('cluster');
cluster.setupMaster({
  exec: 'worker.js',
  args: ['--use', 'https'],
  silent: true
});
cluster.fork(); // https worker
cluster.setupMaster({
  exec: 'worker.js',
  args: ['--use', 'http']
});
cluster.fork(); // http worker



This can only be called from the master process.


cluster.worker#



Added in: v0.7.0



A reference to the current worker object. Not available in the master process.


const cluster = require('cluster');

if (cluster.isMaster) {
  console.log('I am master');
  cluster.fork();
  cluster.fork();
} else if (cluster.isWorker) {
  console.log(`I am worker #${cluster.worker.id}`);
}



cluster.workers#



Added in: v0.7.0



A hash that stores the active worker objects, keyed by id field. Makes it
easy to loop through all the workers. It is only available in the master
process.


A worker is removed from cluster.workers after the worker has disconnected and
exited. The order between these two events cannot be determined in advance.
However, it is guaranteed that the removal from the cluster.workers list happens
before last 'disconnect' or 'exit' event is emitted.


// Go through all workers
function eachWorker(callback) {
  for (var id in cluster.workers) {
    callback(cluster.workers[id]);
  }
}
eachWorker((worker) => {
  worker.send('big announcement to all workers');
});



Should you wish to reference a worker over a communication channel, using
the worker's unique id is the easiest way to find the worker.


socket.on('data', (id) => {
  var worker = cluster.workers[id];
});



      

    

  

  
  
  
  



node-v4.8.2/doc/api/cluster.json000644 000766 000024 00000111215 13070706740 016647 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/cluster.md",
  "modules": [
    {
      "textRaw": "Cluster",
      "name": "cluster",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
A single instance of Node.js runs in a single thread. To take advantage of\nmulti-core systems the user will sometimes want to launch a cluster of Node.js\nprocesses to handle the load.
\n
The cluster module allows you to easily create child processes that\nall share server ports.
\n
const cluster = require('cluster');\nconst http = require('http');\nconst numCPUs = require('os').cpus().length;\n\nif (cluster.isMaster) {\n  // Fork workers.\n  for (var i = 0; i < numCPUs; i++) {\n    cluster.fork();\n  }\n\n  cluster.on('exit', (worker, code, signal) => {\n    console.log(`worker ${worker.process.pid} died`);\n  });\n} else {\n  // Workers can share any TCP connection\n  // In this case it is an HTTP server\n  http.createServer((req, res) => {\n    res.writeHead(200);\n    res.end('hello world\\n');\n  }).listen(8000);\n}\n
\n
Running Node.js will now share port 8000 between the workers:
\n
$ NODE_DEBUG=cluster node server.js\n23521,Master Worker 23524 online\n23521,Master Worker 23526 online\n23521,Master Worker 23523 online\n23521,Master Worker 23528 online\n
Please note that, on Windows, it is not yet possible to set up a named pipe\nserver in a worker.
\n",
      "miscs": [
        {
          "textRaw": "How It Works",
          "name": "How It Works",
          "type": "misc",
          "desc": "
The worker processes are spawned using the child_process.fork() method,\nso that they can communicate with the parent via IPC and pass server\nhandles back and forth.
\n
The cluster module supports two methods of distributing incoming\nconnections.
\n
The first one (and the default one on all platforms except Windows),\nis the round-robin approach, where the master process listens on a\nport, accepts new connections and distributes them across the workers\nin a round-robin fashion, with some built-in smarts to avoid\noverloading a worker process.
\n
The second approach is where the master process creates the listen\nsocket and sends it to interested workers. The workers then accept\nincoming connections directly.
\n
The second approach should, in theory, give the best performance.\nIn practice however, distribution tends to be very unbalanced due\nto operating system scheduler vagaries. Loads have been observed\nwhere over 70% of all connections ended up in just two processes,\nout of a total of eight.
\n
Because server.listen() hands off most of the work to the master\nprocess, there are three cases where the behavior between a normal\nNode.js process and a cluster worker differs:
\n
    \n
  1. server.listen({fd: 7}) Because the message is passed to the master,\nfile descriptor 7 in the parent will be listened on, and the\nhandle passed to the worker, rather than listening to the worker's\nidea of what the number 7 file descriptor references.
    2. \n
  2. server.listen(handle) Listening on handles explicitly will cause\nthe worker to use the supplied handle, rather than talk to the master\nprocess.  If the worker already has the handle, then it's presumed\nthat you know what you are doing.
    3. \n
  3. server.listen(0) Normally, this will cause servers to listen on a\nrandom port.  However, in a cluster, each worker will receive the\nsame "random" port each time they do listen(0).  In essence, the\nport is random the first time, but predictable thereafter.  If you\nwant to listen on a unique port, generate a port number based on the\ncluster worker ID.
    4. \n
\n
There is no routing logic in Node.js, or in your program, and no shared\nstate between the workers.  Therefore, it is important to design your\nprogram such that it does not rely too heavily on in-memory data objects\nfor things like sessions and login.
\n
Because workers are all separate processes, they can be killed or\nre-spawned depending on your program's needs, without affecting other\nworkers.  As long as there are some workers still alive, the server will\ncontinue to accept connections.  If no workers are alive, existing connections\nwill be dropped and new connections will be refused.  Node.js does not\nautomatically manage the number of workers for you, however.  It is your\nresponsibility to manage the worker pool for your application's needs.
\n"
        }
      ],
      "classes": [
        {
          "textRaw": "Class: Worker",
          "type": "class",
          "name": "Worker",
          "meta": {
            "added": [
              "v0.7.0"
            ]
          },
          "desc": "
A Worker object contains all public information and method about a worker.\nIn the master it can be obtained using cluster.workers. In a worker\nit can be obtained using cluster.worker.
\n",
          "events": [
            {
              "textRaw": "Event: 'disconnect'",
              "type": "event",
              "name": "disconnect",
              "meta": {
                "added": [
                  "v0.7.7"
                ]
              },
              "desc": "
Similar to the cluster.on('disconnect') event, but specific to this worker.
\n
cluster.fork().on('disconnect', () => {\n  // Worker has disconnected\n});\n
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'error'",
              "type": "event",
              "name": "error",
              "meta": {
                "added": [
                  "v0.7.3"
                ]
              },
              "desc": "
This event is the same as the one provided by child_process.fork().
\n
In a worker you can also use process.on('error').
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'exit'",
              "type": "event",
              "name": "exit",
              "meta": {
                "added": [
                  "v0.11.2"
                ]
              },
              "params": [],
              "desc": "
Similar to the cluster.on('exit') event, but specific to this worker.
\n
const worker = cluster.fork();\nworker.on('exit', (code, signal) => {\n  if (signal) {\n    console.log(`worker was killed by signal: ${signal}`);\n  } else if (code !== 0) {\n    console.log(`worker exited with error code: ${code}`);\n  } else {\n    console.log('worker success!');\n  }\n});\n
\n"
            },
            {
              "textRaw": "Event: 'listening'",
              "type": "event",
              "name": "listening",
              "meta": {
                "added": [
                  "v0.7.0"
                ]
              },
              "params": [],
              "desc": "
Similar to the cluster.on('listening') event, but specific to this worker.
\n
cluster.fork().on('listening', (address) => {\n  // Worker is listening\n});\n
\n
It is not emitted in the worker.
\n"
            },
            {
              "textRaw": "Event: 'message'",
              "type": "event",
              "name": "message",
              "meta": {
                "added": [
                  "v0.7.0"
                ]
              },
              "params": [],
              "desc": "
Similar to the cluster.on('message') event, but specific to this worker. In a\nworker you can also use process.on('message').
\n
See process event: 'message'.
\n
As an example, here is a cluster that keeps count of the number of requests\nin the master process using the message system:
\n
const cluster = require('cluster');\nconst http = require('http');\n\nif (cluster.isMaster) {\n\n  // Keep track of http requests\n  var numReqs = 0;\n  setInterval(() => {\n    console.log('numReqs =', numReqs);\n  }, 1000);\n\n  // Count requests\n  function messageHandler(msg) {\n    if (msg.cmd && msg.cmd == 'notifyRequest') {\n      numReqs += 1;\n    }\n  }\n\n  // Start workers and listen for messages containing notifyRequest\n  const numCPUs = require('os').cpus().length;\n  for (var i = 0; i < numCPUs; i++) {\n    cluster.fork();\n  }\n\n  Object.keys(cluster.workers).forEach((id) => {\n    cluster.workers[id].on('message', messageHandler);\n  });\n\n} else {\n\n  // Worker processes have a http server.\n  http.Server((req, res) => {\n    res.writeHead(200);\n    res.end('hello world\\n');\n\n    // notify master about the request\n    process.send({ cmd: 'notifyRequest' });\n  }).listen(8000);\n}\n
\n"
            },
            {
              "textRaw": "Event: 'online'",
              "type": "event",
              "name": "online",
              "meta": {
                "added": [
                  "v0.7.0"
                ]
              },
              "desc": "
Similar to the cluster.on('online') event, but specific to this worker.
\n
cluster.fork().on('online', () => {\n  // Worker is online\n});\n
\n
It is not emitted in the worker.
\n",
              "params": []
            }
          ],
          "methods": [
            {
              "textRaw": "worker.disconnect()",
              "type": "method",
              "name": "disconnect",
              "meta": {
                "added": [
                  "v0.7.7"
                ]
              },
              "desc": "
In a worker, this function will close all servers, wait for the 'close' event on\nthose servers, and then disconnect the IPC channel.
\n
In the master, an internal message is sent to the worker causing it to call\n.disconnect() on itself.
\n
Causes .suicide to be set.
\n
Note that after a server is closed, it will no longer accept new connections,\nbut connections may be accepted by any other listening worker. Existing\nconnections will be allowed to close as usual. When no more connections exist,\nsee server.close(), the IPC channel to the worker will close allowing it to\ndie gracefully.
\n
The above applies only to server connections, client connections are not\nautomatically closed by workers, and disconnect does not wait for them to close\nbefore exiting.
\n
Note that in a worker, process.disconnect exists, but it is not this function,\nit is disconnect.
\n
Because long living server connections may block workers from disconnecting, it\nmay be useful to send a message, so application specific actions may be taken to\nclose them. It also may be useful to implement a timeout, killing a worker if\nthe 'disconnect' event has not been emitted after some time.
\n
if (cluster.isMaster) {\n  var worker = cluster.fork();\n  var timeout;\n\n  worker.on('listening', (address) => {\n    worker.send('shutdown');\n    worker.disconnect();\n    timeout = setTimeout(() => {\n      worker.kill();\n    }, 2000);\n  });\n\n  worker.on('disconnect', () => {\n    clearTimeout(timeout);\n  });\n\n} else if (cluster.isWorker) {\n  const net = require('net');\n  var server = net.createServer((socket) => {\n    // connections never end\n  });\n\n  server.listen(8000);\n\n  process.on('message', (msg) => {\n    if (msg === 'shutdown') {\n      // initiate graceful close of any connections to server\n    }\n  });\n}\n
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "worker.isConnected()",
              "type": "method",
              "name": "isConnected",
              "meta": {
                "added": [
                  "v0.11.14"
                ]
              },
              "desc": "
This function returns true if the worker is connected to its master via its IPC\nchannel, false otherwise. A worker is connected to its master after it's been\ncreated. It is disconnected after the 'disconnect' event is emitted.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "worker.isDead()",
              "type": "method",
              "name": "isDead",
              "meta": {
                "added": [
                  "v0.11.14"
                ]
              },
              "desc": "
This function returns true if the worker's process has terminated (either\nbecause of exiting or being signaled). Otherwise, it returns false.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "worker.kill([signal='SIGTERM'])",
              "type": "method",
              "name": "kill",
              "meta": {
                "added": [
                  "v0.9.12"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`signal` {String} Name of the kill signal to send to the worker process. ",
                      "name": "signal",
                      "type": "String",
                      "desc": "Name of the kill signal to send to the worker process.",
                      "optional": true,
                      "default": "'SIGTERM'"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "signal",
                      "optional": true,
                      "default": "'SIGTERM'"
                    }
                  ]
                }
              ],
              "desc": "
This function will kill the worker. In the master, it does this by disconnecting\nthe worker.process, and once disconnected, killing with signal. In the\nworker, it does it by disconnecting the channel, and then exiting with code 0.
\n
Causes .suicide to be set.
\n
This method is aliased as worker.destroy() for backwards compatibility.
\n
Note that in a worker, process.kill() exists, but it is not this function,\nit is kill.
\n"
            },
            {
              "textRaw": "worker.send(message[, sendHandle][, callback])",
              "type": "method",
              "name": "send",
              "meta": {
                "added": [
                  "v0.7.0"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: Boolean ",
                    "name": "return",
                    "desc": "Boolean"
                  },
                  "params": [
                    {
                      "textRaw": "`message` {Object} ",
                      "name": "message",
                      "type": "Object"
                    },
                    {
                      "textRaw": "`sendHandle` {Handle} ",
                      "name": "sendHandle",
                      "type": "Handle",
                      "optional": true
                    },
                    {
                      "textRaw": "`callback` {Function} ",
                      "name": "callback",
                      "type": "Function",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "message"
                    },
                    {
                      "name": "sendHandle",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Send a message to a worker or master, optionally with a handle.
\n
In the master this sends a message to a specific worker. It is identical to\nChildProcess.send().
\n
In a worker this sends a message to the master. It is identical to\nprocess.send().
\n
This example will echo back all messages from the master:
\n
if (cluster.isMaster) {\n  var worker = cluster.fork();\n  worker.send('hi there');\n\n} else if (cluster.isWorker) {\n  process.on('message', (msg) => {\n    process.send(msg);\n  });\n}\n
\n"
            }
          ],
          "properties": [
            {
              "textRaw": "`id` {Number} ",
              "type": "Number",
              "name": "id",
              "meta": {
                "added": [
                  "v0.8.0"
                ]
              },
              "desc": "
Each new worker is given its own unique id, this id is stored in the\nid.
\n
While a worker is alive, this is the key that indexes it in\ncluster.workers
\n"
            },
            {
              "textRaw": "`process` {ChildProcess} ",
              "type": "ChildProcess",
              "name": "process",
              "meta": {
                "added": [
                  "v0.7.0"
                ]
              },
              "desc": "
All workers are created using child_process.fork(), the returned object\nfrom this function is stored as .process. In a worker, the global process\nis stored.
\n
See: Child Process module
\n
Note that workers will call process.exit(0) if the 'disconnect' event occurs\non process and .suicide is not true. This protects against accidental\ndisconnection.
\n"
            },
            {
              "textRaw": "`suicide` {Boolean} ",
              "type": "Boolean",
              "name": "suicide",
              "meta": {
                "added": [
                  "v0.7.0"
                ],
                "deprecated": [
                  "v6.0.0"
                ]
              },
              "desc": "
Set by calling .kill() or .disconnect(), until then it is undefined.
\n
The boolean worker.suicide lets you distinguish between voluntary and accidental\nexit, the master may choose not to respawn a worker based on this value.
\n
cluster.on('exit', (worker, code, signal) => {\n  if (worker.suicide === true) {\n    console.log('Oh, it was just suicide\\' – no need to worry').\n  }\n});\n\n// kill worker\nworker.kill();\n
\n"
            }
          ]
        }
      ],
      "events": [
        {
          "textRaw": "Event: 'disconnect'",
          "type": "event",
          "name": "disconnect",
          "meta": {
            "added": [
              "v0.7.9"
            ]
          },
          "params": [],
          "desc": "
Emitted after the worker IPC channel has disconnected. This can occur when a\nworker exits gracefully, is killed, or is disconnected manually (such as with\nworker.disconnect()).
\n
There may be a delay between the 'disconnect' and 'exit' events.  These events\ncan be used to detect if the process is stuck in a cleanup or if there are\nlong-living connections.
\n
cluster.on('disconnect', (worker) => {\n  console.log(`The worker #${worker.id} has disconnected`);\n});\n
\n"
        },
        {
          "textRaw": "Event: 'exit'",
          "type": "event",
          "name": "exit",
          "meta": {
            "added": [
              "v0.7.9"
            ]
          },
          "params": [],
          "desc": "
When any of the workers die the cluster module will emit the 'exit' event.
\n
This can be used to restart the worker by calling .fork() again.
\n
cluster.on('exit', (worker, code, signal) => {\n  console.log('worker %d died (%s). restarting...',\n    worker.process.pid, signal || code);\n  cluster.fork();\n});\n
\n
See child_process event: 'exit'.
\n"
        },
        {
          "textRaw": "Event: 'fork'",
          "type": "event",
          "name": "fork",
          "meta": {
            "added": [
              "v0.7.0"
            ]
          },
          "params": [],
          "desc": "
When a new worker is forked the cluster module will emit a 'fork' event.\nThis can be used to log worker activity, and create your own timeout.
\n
var timeouts = [];\nfunction errorMsg() {\n  console.error('Something must be wrong with the connection ...');\n}\n\ncluster.on('fork', (worker) => {\n  timeouts[worker.id] = setTimeout(errorMsg, 2000);\n});\ncluster.on('listening', (worker, address) => {\n  clearTimeout(timeouts[worker.id]);\n});\ncluster.on('exit', (worker, code, signal) => {\n  clearTimeout(timeouts[worker.id]);\n  errorMsg();\n});\n
\n"
        },
        {
          "textRaw": "Event: 'listening'",
          "type": "event",
          "name": "listening",
          "meta": {
            "added": [
              "v0.7.0"
            ]
          },
          "params": [],
          "desc": "
After calling listen() from a worker, when the 'listening' event is emitted on\nthe server, a 'listening' event will also be emitted on cluster in the master.
\n
The event handler is executed with two arguments, the worker contains the worker\nobject and the address object contains the following connection properties:\naddress, port and addressType. This is very useful if the worker is listening\non more than one address.
\n
cluster.on('listening', (worker, address) => {\n  console.log(\n    `A worker is now connected to ${address.address}:${address.port}`);\n});\n
\n
The addressType is one of:
\n
    \n
  • 4 (TCPv4)
    • \n
  • 6 (TCPv6)
    • \n
  • -1 (unix domain socket)
    • \n
  • "udp4" or "udp6" (UDP v4 or v6)
    • \n
\n"
        },
        {
          "textRaw": "Event: 'message'",
          "type": "event",
          "name": "message",
          "params": [],
          "desc": "
Emitted when the cluster master receives a message from any worker.
\n
See child_process event: 'message'.
\n"
        },
        {
          "textRaw": "Event: 'online'",
          "type": "event",
          "name": "online",
          "meta": {
            "added": [
              "v0.7.0"
            ]
          },
          "params": [],
          "desc": "
After forking a new worker, the worker should respond with an online message.\nWhen the master receives an online message it will emit this event.\nThe difference between 'fork' and 'online' is that fork is emitted when the\nmaster forks a worker, and 'online' is emitted when the worker is running.
\n
cluster.on('online', (worker) => {\n  console.log('Yay, the worker responded after it was forked');\n});\n
\n"
        },
        {
          "textRaw": "Event: 'setup'",
          "type": "event",
          "name": "setup",
          "meta": {
            "added": [
              "v0.7.1"
            ]
          },
          "params": [],
          "desc": "
Emitted every time .setupMaster() is called.
\n
The settings object is the cluster.settings object at the time\n.setupMaster() was called and is advisory only, since multiple calls to\n.setupMaster() can be made in a single tick.
\n
If accuracy is important, use cluster.settings.
\n"
        }
      ],
      "methods": [
        {
          "textRaw": "cluster.disconnect([callback])",
          "type": "method",
          "name": "disconnect",
          "meta": {
            "added": [
              "v0.7.7"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`callback` {Function} called when all workers are disconnected and handles are closed ",
                  "name": "callback",
                  "type": "Function",
                  "desc": "called when all workers are disconnected and handles are closed",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "callback",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "
Calls .disconnect() on each worker in cluster.workers.
\n
When they are disconnected all internal handles will be closed, allowing the\nmaster process to die gracefully if no other event is waiting.
\n
The method takes an optional callback argument which will be called when finished.
\n
This can only be called from the master process.
\n"
        },
        {
          "textRaw": "cluster.fork([env])",
          "type": "method",
          "name": "fork",
          "meta": {
            "added": [
              "v0.6.0"
            ]
          },
          "signatures": [
            {
              "return": {
                "textRaw": "return {cluster.Worker} ",
                "name": "return",
                "type": "cluster.Worker"
              },
              "params": [
                {
                  "textRaw": "`env` {Object} Key/value pairs to add to worker process environment. ",
                  "name": "env",
                  "type": "Object",
                  "desc": "Key/value pairs to add to worker process environment.",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "env",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "
Spawn a new worker process.
\n
This can only be called from the master process.
\n"
        },
        {
          "textRaw": "cluster.setupMaster([settings])",
          "type": "method",
          "name": "setupMaster",
          "meta": {
            "added": [
              "v0.7.1"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`settings` {Object} ",
                  "options": [
                    {
                      "textRaw": "`exec` {String} file path to worker file.  (Default=`process.argv[1]`) ",
                      "name": "exec",
                      "default": "process.argv[1]",
                      "type": "String",
                      "desc": "file path to worker file."
                    },
                    {
                      "textRaw": "`args` {Array} string arguments passed to worker. (Default=`process.argv.slice(2)`) ",
                      "name": "args",
                      "default": "process.argv.slice(2)",
                      "type": "Array",
                      "desc": "string arguments passed to worker."
                    },
                    {
                      "textRaw": "`silent` {Boolean} whether or not to send output to parent's stdio. (Default=`false`) ",
                      "name": "silent",
                      "default": "false",
                      "type": "Boolean",
                      "desc": "whether or not to send output to parent's stdio."
                    }
                  ],
                  "name": "settings",
                  "type": "Object",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "settings",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "
setupMaster is used to change the default 'fork' behavior. Once called,\nthe settings will be present in cluster.settings.
\n
Note that:
\n
    \n
  • any settings changes only affect future calls to .fork() and have no\neffect on workers that are already running
    • \n
  • The only attribute of a worker that cannot be set via .setupMaster() is\nthe env passed to .fork()
    • \n
  • the defaults above apply to the first call only, the defaults for later\ncalls is the current value at the time of cluster.setupMaster() is called
    • \n
\n
Example:
\n
const cluster = require('cluster');\ncluster.setupMaster({\n  exec: 'worker.js',\n  args: ['--use', 'https'],\n  silent: true\n});\ncluster.fork(); // https worker\ncluster.setupMaster({\n  exec: 'worker.js',\n  args: ['--use', 'http']\n});\ncluster.fork(); // http worker\n
\n
This can only be called from the master process.
\n"
        }
      ],
      "properties": [
        {
          "textRaw": "`isMaster` {Boolean} ",
          "type": "Boolean",
          "name": "isMaster",
          "meta": {
            "added": [
              "v0.8.1"
            ]
          },
          "desc": "
True if the process is a master. This is determined\nby the process.env.NODE_UNIQUE_ID. If process.env.NODE_UNIQUE_ID is\nundefined, then isMaster is true.
\n"
        },
        {
          "textRaw": "`isWorker` {Boolean} ",
          "type": "Boolean",
          "name": "isWorker",
          "meta": {
            "added": [
              "v0.6.0"
            ]
          },
          "desc": "
True if the process is not a master (it is the negation of cluster.isMaster).
\n"
        },
        {
          "textRaw": "cluster.schedulingPolicy",
          "name": "schedulingPolicy",
          "meta": {
            "added": [
              "v0.11.2"
            ]
          },
          "desc": "
The scheduling policy, either cluster.SCHED_RR for round-robin or\ncluster.SCHED_NONE to leave it to the operating system. This is a\nglobal setting and effectively frozen once you spawn the first worker\nor call cluster.setupMaster(), whatever comes first.
\n
SCHED_RR is the default on all operating systems except Windows.\nWindows will change to SCHED_RR once libuv is able to effectively\ndistribute IOCP handles without incurring a large performance hit.
\n
cluster.schedulingPolicy can also be set through the\nNODE_CLUSTER_SCHED_POLICY environment variable. Valid\nvalues are "rr" and "none".
\n"
        },
        {
          "textRaw": "`settings` {Object} ",
          "type": "Object",
          "name": "settings",
          "meta": {
            "added": [
              "v0.7.1"
            ]
          },
          "options": [
            {
              "textRaw": "`execArgv` {Array} list of string arguments passed to the Node.js executable. (Default=`process.execArgv`) ",
              "name": "execArgv",
              "default": "process.execArgv",
              "type": "Array",
              "desc": "list of string arguments passed to the Node.js executable."
            },
            {
              "textRaw": "`exec` {String} file path to worker file.  (Default=`process.argv[1]`) ",
              "name": "exec",
              "default": "process.argv[1]",
              "type": "String",
              "desc": "file path to worker file."
            },
            {
              "textRaw": "`args` {Array} string arguments passed to worker. (Default=`process.argv.slice(2)`) ",
              "name": "args",
              "default": "process.argv.slice(2)",
              "type": "Array",
              "desc": "string arguments passed to worker."
            },
            {
              "textRaw": "`silent` {Boolean} whether or not to send output to parent's stdio. (Default=`false`) ",
              "name": "silent",
              "default": "false",
              "type": "Boolean",
              "desc": "whether or not to send output to parent's stdio."
            },
            {
              "textRaw": "`uid` {Number} Sets the user identity of the process. (See setuid(2).) ",
              "name": "uid",
              "type": "Number",
              "desc": "Sets the user identity of the process. (See setuid(2).)"
            },
            {
              "textRaw": "`gid` {Number} Sets the group identity of the process. (See setgid(2).) ",
              "name": "gid",
              "type": "Number",
              "desc": "Sets the group identity of the process. (See setgid(2).)"
            }
          ],
          "desc": "
After calling .setupMaster() (or .fork()) this settings object will contain\nthe settings, including the default values.
\n
This object is not supposed to be changed or set manually, by you.
\n"
        },
        {
          "textRaw": "`worker` {Object} ",
          "type": "Object",
          "name": "worker",
          "meta": {
            "added": [
              "v0.7.0"
            ]
          },
          "desc": "
A reference to the current worker object. Not available in the master process.
\n
const cluster = require('cluster');\n\nif (cluster.isMaster) {\n  console.log('I am master');\n  cluster.fork();\n  cluster.fork();\n} else if (cluster.isWorker) {\n  console.log(`I am worker #${cluster.worker.id}`);\n}\n
\n"
        },
        {
          "textRaw": "`workers` {Object} ",
          "type": "Object",
          "name": "workers",
          "meta": {
            "added": [
              "v0.7.0"
            ]
          },
          "desc": "
A hash that stores the active worker objects, keyed by id field. Makes it\neasy to loop through all the workers. It is only available in the master\nprocess.
\n
A worker is removed from cluster.workers after the worker has disconnected and\nexited. The order between these two events cannot be determined in advance.\nHowever, it is guaranteed that the removal from the cluster.workers list happens\nbefore last 'disconnect' or 'exit' event is emitted.
\n
// Go through all workers\nfunction eachWorker(callback) {\n  for (var id in cluster.workers) {\n    callback(cluster.workers[id]);\n  }\n}\neachWorker((worker) => {\n  worker.send('big announcement to all workers');\n});\n
\n
Should you wish to reference a worker over a communication channel, using\nthe worker's unique id is the easiest way to find the worker.
\n
socket.on('data', (id) => {\n  var worker = cluster.workers[id];\n});\n
\n"
        }
      ],
      "type": "module",
      "displayName": "Cluster"
    }
  ]
}
node-v4.8.2/doc/api/cluster.md000644 000766 000024 00000051264 13070706735 016311 0ustar00iojsstaff000000 000000 # Cluster

> Stability: 2 - Stable

A single instance of Node.js runs in a single thread. To take advantage of
multi-core systems the user will sometimes want to launch a cluster of Node.js
processes to handle the load.

The cluster module allows you to easily create child processes that
all share server ports.

```js
const cluster = require('cluster');
const http = require('http');
const numCPUs = require('os').cpus().length;

if (cluster.isMaster) {
  // Fork workers.
  for (var i = 0; i < numCPUs; i++) {
    cluster.fork();
  }

  cluster.on('exit', (worker, code, signal) => {
    console.log(`worker ${worker.process.pid} died`);
  });
} else {
  // Workers can share any TCP connection
  // In this case it is an HTTP server
  http.createServer((req, res) => {
    res.writeHead(200);
    res.end('hello world\n');
  }).listen(8000);
}
```

Running Node.js will now share port 8000 between the workers:

```
$ NODE_DEBUG=cluster node server.js
23521,Master Worker 23524 online
23521,Master Worker 23526 online
23521,Master Worker 23523 online
23521,Master Worker 23528 online
```

Please note that, on Windows, it is not yet possible to set up a named pipe
server in a worker.

## How It Works



The worker processes are spawned using the [`child_process.fork()`][] method,
so that they can communicate with the parent via IPC and pass server
handles back and forth.

The cluster module supports two methods of distributing incoming
connections.

The first one (and the default one on all platforms except Windows),
is the round-robin approach, where the master process listens on a
port, accepts new connections and distributes them across the workers
in a round-robin fashion, with some built-in smarts to avoid
overloading a worker process.

The second approach is where the master process creates the listen
socket and sends it to interested workers. The workers then accept
incoming connections directly.

The second approach should, in theory, give the best performance.
In practice however, distribution tends to be very unbalanced due
to operating system scheduler vagaries. Loads have been observed
where over 70% of all connections ended up in just two processes,
out of a total of eight.

Because `server.listen()` hands off most of the work to the master
process, there are three cases where the behavior between a normal
Node.js process and a cluster worker differs:

1. `server.listen({fd: 7})` Because the message is passed to the master,
   file descriptor 7 **in the parent** will be listened on, and the
   handle passed to the worker, rather than listening to the worker's
   idea of what the number 7 file descriptor references.
2. `server.listen(handle)` Listening on handles explicitly will cause
   the worker to use the supplied handle, rather than talk to the master
   process.  If the worker already has the handle, then it's presumed
   that you know what you are doing.
3. `server.listen(0)` Normally, this will cause servers to listen on a
   random port.  However, in a cluster, each worker will receive the
   same "random" port each time they do `listen(0)`.  In essence, the
   port is random the first time, but predictable thereafter.  If you
   want to listen on a unique port, generate a port number based on the
   cluster worker ID.

There is no routing logic in Node.js, or in your program, and no shared
state between the workers.  Therefore, it is important to design your
program such that it does not rely too heavily on in-memory data objects
for things like sessions and login.

Because workers are all separate processes, they can be killed or
re-spawned depending on your program's needs, without affecting other
workers.  As long as there are some workers still alive, the server will
continue to accept connections.  If no workers are alive, existing connections
will be dropped and new connections will be refused.  Node.js does not
automatically manage the number of workers for you, however.  It is your
responsibility to manage the worker pool for your application's needs.



## Class: Worker


A Worker object contains all public information and method about a worker.
In the master it can be obtained using `cluster.workers`. In a worker
it can be obtained using `cluster.worker`.

### Event: 'disconnect'


Similar to the `cluster.on('disconnect')` event, but specific to this worker.

```js
cluster.fork().on('disconnect', () => {
  // Worker has disconnected
});
```

### Event: 'error'


This event is the same as the one provided by [`child_process.fork()`][].

In a worker you can also use `process.on('error')`.

### Event: 'exit'


* `code` {Number} the exit code, if it exited normally.
* `signal` {String} the name of the signal (e.g. `'SIGHUP'`) that caused
  the process to be killed.

Similar to the `cluster.on('exit')` event, but specific to this worker.

```js
const worker = cluster.fork();
worker.on('exit', (code, signal) => {
  if (signal) {
    console.log(`worker was killed by signal: ${signal}`);
  } else if (code !== 0) {
    console.log(`worker exited with error code: ${code}`);
  } else {
    console.log('worker success!');
  }
});
```

### Event: 'listening'


* `address` {Object}

Similar to the `cluster.on('listening')` event, but specific to this worker.

```js
cluster.fork().on('listening', (address) => {
  // Worker is listening
});
```

It is not emitted in the worker.

### Event: 'message'


* `message` {Object}
* `handle` {undefined|Object}

Similar to the `cluster.on('message')` event, but specific to this worker. In a
worker you can also use `process.on('message')`.

See [`process` event: `'message'`][].

As an example, here is a cluster that keeps count of the number of requests
in the master process using the message system:

```js
const cluster = require('cluster');
const http = require('http');

if (cluster.isMaster) {

  // Keep track of http requests
  var numReqs = 0;
  setInterval(() => {
    console.log('numReqs =', numReqs);
  }, 1000);

  // Count requests
  function messageHandler(msg) {
    if (msg.cmd && msg.cmd == 'notifyRequest') {
      numReqs += 1;
    }
  }

  // Start workers and listen for messages containing notifyRequest
  const numCPUs = require('os').cpus().length;
  for (var i = 0; i < numCPUs; i++) {
    cluster.fork();
  }

  Object.keys(cluster.workers).forEach((id) => {
    cluster.workers[id].on('message', messageHandler);
  });

} else {

  // Worker processes have a http server.
  http.Server((req, res) => {
    res.writeHead(200);
    res.end('hello world\n');

    // notify master about the request
    process.send({ cmd: 'notifyRequest' });
  }).listen(8000);
}
```

### Event: 'online'


Similar to the `cluster.on('online')` event, but specific to this worker.

```js
cluster.fork().on('online', () => {
  // Worker is online
});
```

It is not emitted in the worker.

### worker.disconnect()


In a worker, this function will close all servers, wait for the `'close'` event on
those servers, and then disconnect the IPC channel.

In the master, an internal message is sent to the worker causing it to call
`.disconnect()` on itself.

Causes `.suicide` to be set.

Note that after a server is closed, it will no longer accept new connections,
but connections may be accepted by any other listening worker. Existing
connections will be allowed to close as usual. When no more connections exist,
see [`server.close()`][], the IPC channel to the worker will close allowing it to
die gracefully.

The above applies *only* to server connections, client connections are not
automatically closed by workers, and disconnect does not wait for them to close
before exiting.

Note that in a worker, `process.disconnect` exists, but it is not this function,
it is [`disconnect`][].

Because long living server connections may block workers from disconnecting, it
may be useful to send a message, so application specific actions may be taken to
close them. It also may be useful to implement a timeout, killing a worker if
the `'disconnect'` event has not been emitted after some time.

```js
if (cluster.isMaster) {
  var worker = cluster.fork();
  var timeout;

  worker.on('listening', (address) => {
    worker.send('shutdown');
    worker.disconnect();
    timeout = setTimeout(() => {
      worker.kill();
    }, 2000);
  });

  worker.on('disconnect', () => {
    clearTimeout(timeout);
  });

} else if (cluster.isWorker) {
  const net = require('net');
  var server = net.createServer((socket) => {
    // connections never end
  });

  server.listen(8000);

  process.on('message', (msg) => {
    if (msg === 'shutdown') {
      // initiate graceful close of any connections to server
    }
  });
}
```

### worker.id


* {Number}

Each new worker is given its own unique id, this id is stored in the
`id`.

While a worker is alive, this is the key that indexes it in
cluster.workers

### worker.isConnected()


This function returns `true` if the worker is connected to its master via its IPC
channel, `false` otherwise. A worker is connected to its master after it's been
created. It is disconnected after the `'disconnect'` event is emitted.

### worker.isDead()


This function returns `true` if the worker's process has terminated (either
because of exiting or being signaled). Otherwise, it returns `false`.

### worker.kill([signal='SIGTERM'])


* `signal` {String} Name of the kill signal to send to the worker
  process.

This function will kill the worker. In the master, it does this by disconnecting
the `worker.process`, and once disconnected, killing with `signal`. In the
worker, it does it by disconnecting the channel, and then exiting with code `0`.

Causes `.suicide` to be set.

This method is aliased as `worker.destroy()` for backwards compatibility.

Note that in a worker, `process.kill()` exists, but it is not this function,
it is [`kill`][].

### worker.process


* {ChildProcess}

All workers are created using [`child_process.fork()`][], the returned object
from this function is stored as `.process`. In a worker, the global `process`
is stored.

See: [Child Process module][]

Note that workers will call `process.exit(0)` if the `'disconnect'` event occurs
on `process` and `.suicide` is not `true`. This protects against accidental
disconnection.

### worker.send(message[, sendHandle][, callback])


* `message` {Object}
* `sendHandle` {Handle}
* `callback` {Function}
* Returns: Boolean

Send a message to a worker or master, optionally with a handle.

In the master this sends a message to a specific worker. It is identical to
[`ChildProcess.send()`][].

In a worker this sends a message to the master. It is identical to
`process.send()`.

This example will echo back all messages from the master:

```js
if (cluster.isMaster) {
  var worker = cluster.fork();
  worker.send('hi there');

} else if (cluster.isWorker) {
  process.on('message', (msg) => {
    process.send(msg);
  });
}
```

### worker.suicide


* {Boolean}

Set by calling `.kill()` or `.disconnect()`, until then it is `undefined`.

The boolean `worker.suicide` lets you distinguish between voluntary and accidental
exit, the master may choose not to respawn a worker based on this value.

```js
cluster.on('exit', (worker, code, signal) => {
  if (worker.suicide === true) {
    console.log('Oh, it was just suicide\' – no need to worry').
  }
});

// kill worker
worker.kill();
```

## Event: 'disconnect'


* `worker` {cluster.Worker}

Emitted after the worker IPC channel has disconnected. This can occur when a
worker exits gracefully, is killed, or is disconnected manually (such as with
worker.disconnect()).

There may be a delay between the `'disconnect'` and `'exit'` events.  These events
can be used to detect if the process is stuck in a cleanup or if there are
long-living connections.

```js
cluster.on('disconnect', (worker) => {
  console.log(`The worker #${worker.id} has disconnected`);
});
```

## Event: 'exit'


* `worker` {cluster.Worker}
* `code` {Number} the exit code, if it exited normally.
* `signal` {String} the name of the signal (e.g. `'SIGHUP'`) that caused
  the process to be killed.

When any of the workers die the cluster module will emit the `'exit'` event.

This can be used to restart the worker by calling `.fork()` again.

```js
cluster.on('exit', (worker, code, signal) => {
  console.log('worker %d died (%s). restarting...',
    worker.process.pid, signal || code);
  cluster.fork();
});
```

See [child_process event: 'exit'][].

## Event: 'fork'


* `worker` {cluster.Worker}

When a new worker is forked the cluster module will emit a `'fork'` event.
This can be used to log worker activity, and create your own timeout.

```js
var timeouts = [];
function errorMsg() {
  console.error('Something must be wrong with the connection ...');
}

cluster.on('fork', (worker) => {
  timeouts[worker.id] = setTimeout(errorMsg, 2000);
});
cluster.on('listening', (worker, address) => {
  clearTimeout(timeouts[worker.id]);
});
cluster.on('exit', (worker, code, signal) => {
  clearTimeout(timeouts[worker.id]);
  errorMsg();
});
```

## Event: 'listening'


* `worker` {cluster.Worker}
* `address` {Object}

After calling `listen()` from a worker, when the `'listening'` event is emitted on
the server, a `'listening'` event will also be emitted on `cluster` in the master.

The event handler is executed with two arguments, the `worker` contains the worker
object and the `address` object contains the following connection properties:
`address`, `port` and `addressType`. This is very useful if the worker is listening
on more than one address.

```js
cluster.on('listening', (worker, address) => {
  console.log(
    `A worker is now connected to ${address.address}:${address.port}`);
});
```

The `addressType` is one of:

* `4` (TCPv4)
* `6` (TCPv6)
* `-1` (unix domain socket)
* `"udp4"` or `"udp6"` (UDP v4 or v6)

## Event: 'message'

* `message` {Object}
* `handle` {undefined|Object}

Emitted when the cluster master receives a message from any worker.

See [child_process event: 'message'][].

## Event: 'online'


* `worker` {cluster.Worker}

After forking a new worker, the worker should respond with an online message.
When the master receives an online message it will emit this event.
The difference between `'fork'` and `'online'` is that fork is emitted when the
master forks a worker, and 'online' is emitted when the worker is running.

```js
cluster.on('online', (worker) => {
  console.log('Yay, the worker responded after it was forked');
});
```

## Event: 'setup'


* `settings` {Object}

Emitted every time `.setupMaster()` is called.

The `settings` object is the `cluster.settings` object at the time
`.setupMaster()` was called and is advisory only, since multiple calls to
`.setupMaster()` can be made in a single tick.

If accuracy is important, use `cluster.settings`.

## cluster.disconnect([callback])


* `callback` {Function} called when all workers are disconnected and handles are
  closed

Calls `.disconnect()` on each worker in `cluster.workers`.

When they are disconnected all internal handles will be closed, allowing the
master process to die gracefully if no other event is waiting.

The method takes an optional callback argument which will be called when finished.

This can only be called from the master process.

## cluster.fork([env])


* `env` {Object} Key/value pairs to add to worker process environment.
* return {cluster.Worker}

Spawn a new worker process.

This can only be called from the master process.

## cluster.isMaster


* {Boolean}

True if the process is a master. This is determined
by the `process.env.NODE_UNIQUE_ID`. If `process.env.NODE_UNIQUE_ID` is
undefined, then `isMaster` is `true`.

## cluster.isWorker


* {Boolean}

True if the process is not a master (it is the negation of `cluster.isMaster`).

## cluster.schedulingPolicy


The scheduling policy, either `cluster.SCHED_RR` for round-robin or
`cluster.SCHED_NONE` to leave it to the operating system. This is a
global setting and effectively frozen once you spawn the first worker
or call `cluster.setupMaster()`, whatever comes first.

`SCHED_RR` is the default on all operating systems except Windows.
Windows will change to `SCHED_RR` once libuv is able to effectively
distribute IOCP handles without incurring a large performance hit.

`cluster.schedulingPolicy` can also be set through the
`NODE_CLUSTER_SCHED_POLICY` environment variable. Valid
values are `"rr"` and `"none"`.

## cluster.settings


* {Object}
  * `execArgv` {Array} list of string arguments passed to the Node.js
    executable. (Default=`process.execArgv`)
  * `exec` {String} file path to worker file.  (Default=`process.argv[1]`)
  * `args` {Array} string arguments passed to worker.
    (Default=`process.argv.slice(2)`)
  * `silent` {Boolean} whether or not to send output to parent's stdio.
    (Default=`false`)
  * `uid` {Number} Sets the user identity of the process. (See setuid(2).)
  * `gid` {Number} Sets the group identity of the process. (See setgid(2).)

After calling `.setupMaster()` (or `.fork()`) this settings object will contain
the settings, including the default values.

This object is not supposed to be changed or set manually, by you.

## cluster.setupMaster([settings])


* `settings` {Object}
  * `exec` {String} file path to worker file.  (Default=`process.argv[1]`)
  * `args` {Array} string arguments passed to worker.
    (Default=`process.argv.slice(2)`)
  * `silent` {Boolean} whether or not to send output to parent's stdio.
    (Default=`false`)

`setupMaster` is used to change the default 'fork' behavior. Once called,
the settings will be present in `cluster.settings`.

Note that:

* any settings changes only affect future calls to `.fork()` and have no
  effect on workers that are already running
* The *only* attribute of a worker that cannot be set via `.setupMaster()` is
  the `env` passed to `.fork()`
* the defaults above apply to the first call only, the defaults for later
  calls is the current value at the time of `cluster.setupMaster()` is called

Example:

```js
const cluster = require('cluster');
cluster.setupMaster({
  exec: 'worker.js',
  args: ['--use', 'https'],
  silent: true
});
cluster.fork(); // https worker
cluster.setupMaster({
  exec: 'worker.js',
  args: ['--use', 'http']
});
cluster.fork(); // http worker
```

This can only be called from the master process.

## cluster.worker


* {Object}

A reference to the current worker object. Not available in the master process.

```js
const cluster = require('cluster');

if (cluster.isMaster) {
  console.log('I am master');
  cluster.fork();
  cluster.fork();
} else if (cluster.isWorker) {
  console.log(`I am worker #${cluster.worker.id}`);
}
```

## cluster.workers


* {Object}

A hash that stores the active worker objects, keyed by `id` field. Makes it
easy to loop through all the workers. It is only available in the master
process.

A worker is removed from cluster.workers after the worker has disconnected _and_
exited. The order between these two events cannot be determined in advance.
However, it is guaranteed that the removal from the cluster.workers list happens
before last `'disconnect'` or `'exit'` event is emitted.

```js
// Go through all workers
function eachWorker(callback) {
  for (var id in cluster.workers) {
    callback(cluster.workers[id]);
  }
}
eachWorker((worker) => {
  worker.send('big announcement to all workers');
});
```

Should you wish to reference a worker over a communication channel, using
the worker's unique id is the easiest way to find the worker.

```js
socket.on('data', (id) => {
  var worker = cluster.workers[id];
});
```

[`child_process.fork()`]: child_process.html#child_process_child_process_fork_modulepath_args_options
[`ChildProcess.send()`]: child_process.html#child_process_child_send_message_sendhandle_callback
[`disconnect`]: child_process.html#child_process_child_disconnect
[`kill`]: process.html#process_process_kill_pid_signal
[`server.close()`]: net.html#net_event_close
[Child Process module]: child_process.html#child_process_child_process_fork_modulepath_args_options
[child_process event: 'exit']: child_process.html#child_process_event_exit
[child_process event: 'message']: child_process.html#child_process_event_message
[`process` event: `'message'`]: process.html#process_event_message
node-v4.8.2/doc/api/console.html000644 000766 000024 00000045637 13070706740 016641 0ustar00iojsstaff000000 000000 


  
  Console | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

      

        
Console#


Stability: 2 - Stable
The console module provides a simple debugging console that is similar to the
JavaScript console mechanism provided by web browsers.


The module exports two specific components:


    

  • A Console class with methods such as console.log(), console.error() and
console.warn() that can be used to write to any Node.js stream.
    • 

  • A global console instance configured to write to stdout and stderr.
Because this object is global, it can be used without calling
require('console').
    • 



Example using the global console:


console.log('hello world');
  // Prints: hello world, to stdout
console.log('hello %s', 'world');
  // Prints: hello world, to stdout
console.error(new Error('Whoops, something bad happened'));
  // Prints: [Error: Whoops, something bad happened], to stderr

const name = 'Will Robinson';
console.warn(`Danger ${name}! Danger!`);
  // Prints: Danger Will Robinson! Danger!, to stderr



Example using the Console class:


const out = getStreamSomehow();
const err = getStreamSomehow();
const myConsole = new console.Console(out, err);

myConsole.log('hello world');
  // Prints: hello world, to out
myConsole.log('hello %s', 'world');
  // Prints: hello world, to out
myConsole.error(new Error('Whoops, something bad happened'));
  // Prints: [Error: Whoops, something bad happened], to err

const name = 'Will Robinson';
myConsole.warn(`Danger ${name}! Danger!`);
  // Prints: Danger Will Robinson! Danger!, to err



While the API for the Console class is designed fundamentally around the
browser console object, the Console in Node.js is not intended to
duplicate the browser's functionality exactly.


Asynchronous vs Synchronous Consoles#


The console functions are usually asynchronous unless the destination is a file.
Disks are fast and operating systems normally employ write-back caching;
it should be a very rare occurrence indeed that a write blocks, but it
is possible.


Additionally, console functions are blocking when outputting to TTYs
(terminals) on OS X as a workaround for the OS's very small, 1kb buffer size.
This is to prevent interleaving between stdout and stderr.


Class: Console#



The Console class can be used to create a simple logger with configurable
output streams and can be accessed using either require('console').Console
or console.Console:


const Console = require('console').Console;
const Console = console.Console;



new Console(stdout[, stderr])#


Creates a new Console by passing one or two writable stream instances.
stdout is a writable stream to print log or info output. stderr
is used for warning or error output. If stderr isn't passed, warning and error
output will be sent to stdout.


const output = fs.createWriteStream('./stdout.log');
const errorOutput = fs.createWriteStream('./stderr.log');
// custom simple logger
const logger = new Console(output, errorOutput);
// use it like console
const count = 5;
logger.log('count: %d', count);
// in stdout.log: count 5



The global console is a special Console whose output is sent to
process.stdout and process.stderr. It is equivalent to calling:


new Console(process.stdout, process.stderr);



console.assert(value[, message][, ...])#



Added in: v0.1.101

A simple assertion test that verifies whether value is truthy. If it is not,
an AssertionError is thrown. If provided, the error message is formatted
using util.format() and used as the error message.


console.assert(true, 'does nothing');
  // OK
console.assert(false, 'Whoops %s', 'didn\'t work');
  // AssertionError: Whoops didn't work



Note: the console.assert() method is implemented differently in Node.js
than the console.assert() method available in browsers.


Specifically, in browsers, calling console.assert() with a falsy
assertion will cause the message to be printed to the console without
interrupting execution of subsequent code. In Node.js, however, a falsy
assertion will cause an AssertionError to be thrown.


Functionality approximating that implemented by browsers can be implemented
by extending Node.js' console and overriding the console.assert() method.


In the following example, a simple module is created that extends and overrides
the default behavior of console in Node.js.


'use strict';

// Creates a simple extension of console with a
// new impl for assert without monkey-patching.
const myConsole = Object.create(console, {
  assert: {
    value: function assert(assertion, message, ...args) {
      try {
        console.assert(assertion, message, ...args);
      } catch (err) {
        console.error(err.stack);
      }
    },
    configurable: true,
    enumerable: true,
    writable: true,
  },
});

module.exports = myConsole;



This can then be used as a direct replacement for the built in console:


const console = require('./myConsole');
console.assert(false, 'this message will print, but no error thrown');
console.log('this will also print');



console.dir(obj[, options])#



Added in: v0.1.101

Uses util.inspect() on obj and prints the resulting string to stdout.
This function bypasses any custom inspect() function defined on obj. An
optional options object may be passed to alter certain aspects of the
formatted string:


    

  • showHidden - if true then the object's non-enumerable and symbol
properties will be shown too. Defaults to false.
    

    • 

  • depth - tells util.inspect() how many times to recurse while
formatting the object. This is useful for inspecting large complicated objects.
Defaults to 2. To make it recurse indefinitely, pass null.
    

    • 

  • colors - if true, then the output will be styled with ANSI color codes.
Defaults to false. Colors are customizable; see
customizing util.inspect() colors.
    

    • 



console.error([data][, ...])#



Added in: v0.1.100

Prints to stderr with newline. Multiple arguments can be passed, with the
first used as the primary message and all additional used as substitution
values similar to printf(3) (the arguments are all passed to
util.format()).


const code = 5;
console.error('error #%d', code);
  // Prints: error #5, to stderr
console.error('error', code);
  // Prints: error 5, to stderr



If formatting elements (e.g. %d) are not found in the first string then
util.inspect() is called on each argument and the resulting string
values are concatenated. See util.format() for more information.


console.info([data][, ...])#



Added in: v0.1.100

The console.info() function is an alias for console.log().


console.log([data][, ...])#



Added in: v0.1.100

Prints to stdout with newline. Multiple arguments can be passed, with the
first used as the primary message and all additional used as substitution
values similar to printf(3) (the arguments are all passed to
util.format()).


const count = 5;
console.log('count: %d', count);
  // Prints: count: 5, to stdout
console.log('count:', count);
  // Prints: count: 5, to stdout



If formatting elements (e.g. %d) are not found in the first string then
util.inspect() is called on each argument and the resulting string
values are concatenated. See util.format() for more information.


console.time(label)#



Added in: v0.1.104

Used to calculate the duration of a specific operation. To start a timer, call
the console.time() method, giving it a unique label as the only parameter. To stop the
timer, and to get the elapsed time in milliseconds, just call the
console.timeEnd() method, again passing the
timer's unique label as the parameter.


console.timeEnd(label)#



Added in: v0.1.104

Stops a timer that was previously started by calling console.time() and
prints the result to stdout:


console.time('100-elements');
for (let i = 0; i < 100; i++) {
  ;
}
console.timeEnd('100-elements');
// prints 100-elements: 262ms



console.trace(message[, ...])#



Added in: v0.1.104

Prints to stderr the string 'Trace :', followed by the util.format()
formatted message and stack trace to the current position in the code.


console.trace('Show me');
  // Prints: (stack trace will vary based on where trace is called)
  //  Trace: Show me
  //    at repl:2:9
  //    at REPLServer.defaultEval (repl.js:248:27)
  //    at bound (domain.js:287:14)
  //    at REPLServer.runBound [as eval] (domain.js:300:12)
  //    at REPLServer.<anonymous> (repl.js:412:12)
  //    at emitOne (events.js:82:20)
  //    at REPLServer.emit (events.js:169:7)
  //    at REPLServer.Interface._onLine (readline.js:210:10)
  //    at REPLServer.Interface._line (readline.js:549:8)
  //    at REPLServer.Interface._ttyWrite (readline.js:826:14)



console.warn([data][, ...])#



Added in: v0.1.100

The console.warn() function is an alias for console.error().


      

    

  

  
  
  
  



node-v4.8.2/doc/api/console.json000644 000766 000024 00000042747 13070706740 016645 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/console.md",
  "modules": [
    {
      "textRaw": "Console",
      "name": "console",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
The console module provides a simple debugging console that is similar to the\nJavaScript console mechanism provided by web browsers.
\n
The module exports two specific components:
\n
    \n
  • A Console class with methods such as console.log(), console.error() and\nconsole.warn() that can be used to write to any Node.js stream.
    • \n
  • A global console instance configured to write to stdout and stderr.\nBecause this object is global, it can be used without calling\nrequire('console').
    • \n
\n
Example using the global console:
\n
console.log('hello world');\n  // Prints: hello world, to stdout\nconsole.log('hello %s', 'world');\n  // Prints: hello world, to stdout\nconsole.error(new Error('Whoops, something bad happened'));\n  // Prints: [Error: Whoops, something bad happened], to stderr\n\nconst name = 'Will Robinson';\nconsole.warn(`Danger ${name}! Danger!`);\n  // Prints: Danger Will Robinson! Danger!, to stderr\n
\n
Example using the Console class:
\n
const out = getStreamSomehow();\nconst err = getStreamSomehow();\nconst myConsole = new console.Console(out, err);\n\nmyConsole.log('hello world');\n  // Prints: hello world, to out\nmyConsole.log('hello %s', 'world');\n  // Prints: hello world, to out\nmyConsole.error(new Error('Whoops, something bad happened'));\n  // Prints: [Error: Whoops, something bad happened], to err\n\nconst name = 'Will Robinson';\nmyConsole.warn(`Danger ${name}! Danger!`);\n  // Prints: Danger Will Robinson! Danger!, to err\n
\n
While the API for the Console class is designed fundamentally around the\nbrowser console object, the Console in Node.js is not intended to\nduplicate the browser's functionality exactly.
\n",
      "modules": [
        {
          "textRaw": "Asynchronous vs Synchronous Consoles",
          "name": "asynchronous_vs_synchronous_consoles",
          "desc": "
The console functions are usually asynchronous unless the destination is a file.\nDisks are fast and operating systems normally employ write-back caching;\nit should be a very rare occurrence indeed that a write blocks, but it\nis possible.
\n
Additionally, console functions are blocking when outputting to TTYs\n(terminals) on OS X as a workaround for the OS's very small, 1kb buffer size.\nThis is to prevent interleaving between stdout and stderr.
\n",
          "type": "module",
          "displayName": "Asynchronous vs Synchronous Consoles"
        }
      ],
      "classes": [
        {
          "textRaw": "Class: Console",
          "type": "class",
          "name": "Console",
          "desc": "
The Console class can be used to create a simple logger with configurable\noutput streams and can be accessed using either require('console').Console\nor console.Console:
\n
const Console = require('console').Console;\nconst Console = console.Console;\n
\n",
          "methods": [
            {
              "textRaw": "console.assert(value[, message][, ...])",
              "type": "method",
              "name": "assert",
              "meta": {
                "added": [
                  "v0.1.101"
                ]
              },
              "desc": "
A simple assertion test that verifies whether value is truthy. If it is not,\nan AssertionError is thrown. If provided, the error message is formatted\nusing util.format() and used as the error message.
\n
console.assert(true, 'does nothing');\n  // OK\nconsole.assert(false, 'Whoops %s', 'didn\\'t work');\n  // AssertionError: Whoops didn't work\n
\n
Note: the console.assert() method is implemented differently in Node.js\nthan the console.assert() method available in browsers.
\n
Specifically, in browsers, calling console.assert() with a falsy\nassertion will cause the message to be printed to the console without\ninterrupting execution of subsequent code. In Node.js, however, a falsy\nassertion will cause an AssertionError to be thrown.
\n
Functionality approximating that implemented by browsers can be implemented\nby extending Node.js' console and overriding the console.assert() method.
\n
In the following example, a simple module is created that extends and overrides\nthe default behavior of console in Node.js.
\n
'use strict';\n\n// Creates a simple extension of console with a\n// new impl for assert without monkey-patching.\nconst myConsole = Object.create(console, {\n  assert: {\n    value: function assert(assertion, message, ...args) {\n      try {\n        console.assert(assertion, message, ...args);\n      } catch (err) {\n        console.error(err.stack);\n      }\n    },\n    configurable: true,\n    enumerable: true,\n    writable: true,\n  },\n});\n\nmodule.exports = myConsole;\n
\n
This can then be used as a direct replacement for the built in console:
\n
const console = require('./myConsole');\nconsole.assert(false, 'this message will print, but no error thrown');\nconsole.log('this will also print');\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "value"
                    },
                    {
                      "name": "message",
                      "optional": true
                    },
                    {
                      "name": "...",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "console.dir(obj[, options])",
              "type": "method",
              "name": "dir",
              "meta": {
                "added": [
                  "v0.1.101"
                ]
              },
              "desc": "
Uses util.inspect() on obj and prints the resulting string to stdout.\nThis function bypasses any custom inspect() function defined on obj. An\noptional options object may be passed to alter certain aspects of the\nformatted string:
\n
    \n
  • showHidden - if true then the object's non-enumerable and symbol\nproperties will be shown too. Defaults to false.
    \n
    • \n
  • depth - tells util.inspect() how many times to recurse while\nformatting the object. This is useful for inspecting large complicated objects.\nDefaults to 2. To make it recurse indefinitely, pass null.
    \n
    • \n
  • colors - if true, then the output will be styled with ANSI color codes.\nDefaults to false. Colors are customizable; see\ncustomizing util.inspect() colors.
    \n
    • \n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "obj"
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "console.error([data][, ...])",
              "type": "method",
              "name": "error",
              "meta": {
                "added": [
                  "v0.1.100"
                ]
              },
              "desc": "
Prints to stderr with newline. Multiple arguments can be passed, with the\nfirst used as the primary message and all additional used as substitution\nvalues similar to printf(3) (the arguments are all passed to\nutil.format()).
\n
const code = 5;\nconsole.error('error #%d', code);\n  // Prints: error #5, to stderr\nconsole.error('error', code);\n  // Prints: error 5, to stderr\n
\n
If formatting elements (e.g. %d) are not found in the first string then\nutil.inspect() is called on each argument and the resulting string\nvalues are concatenated. See util.format() for more information.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "data",
                      "optional": true
                    },
                    {
                      "name": "...",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "console.info([data][, ...])",
              "type": "method",
              "name": "info",
              "meta": {
                "added": [
                  "v0.1.100"
                ]
              },
              "desc": "
The console.info() function is an alias for console.log().
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "data",
                      "optional": true
                    },
                    {
                      "name": "...",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "console.log([data][, ...])",
              "type": "method",
              "name": "log",
              "meta": {
                "added": [
                  "v0.1.100"
                ]
              },
              "desc": "
Prints to stdout with newline. Multiple arguments can be passed, with the\nfirst used as the primary message and all additional used as substitution\nvalues similar to printf(3) (the arguments are all passed to\nutil.format()).
\n
const count = 5;\nconsole.log('count: %d', count);\n  // Prints: count: 5, to stdout\nconsole.log('count:', count);\n  // Prints: count: 5, to stdout\n
\n
If formatting elements (e.g. %d) are not found in the first string then\nutil.inspect() is called on each argument and the resulting string\nvalues are concatenated. See util.format() for more information.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "data",
                      "optional": true
                    },
                    {
                      "name": "...",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "console.time(label)",
              "type": "method",
              "name": "time",
              "meta": {
                "added": [
                  "v0.1.104"
                ]
              },
              "desc": "
Used to calculate the duration of a specific operation. To start a timer, call\nthe console.time() method, giving it a unique label as the only parameter. To stop the\ntimer, and to get the elapsed time in milliseconds, just call the\nconsole.timeEnd() method, again passing the\ntimer's unique label as the parameter.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "label"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "console.timeEnd(label)",
              "type": "method",
              "name": "timeEnd",
              "meta": {
                "added": [
                  "v0.1.104"
                ]
              },
              "desc": "
Stops a timer that was previously started by calling console.time() and\nprints the result to stdout:
\n
console.time('100-elements');\nfor (let i = 0; i < 100; i++) {\n  ;\n}\nconsole.timeEnd('100-elements');\n// prints 100-elements: 262ms\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "label"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "console.trace(message[, ...])",
              "type": "method",
              "name": "trace",
              "meta": {
                "added": [
                  "v0.1.104"
                ]
              },
              "desc": "
Prints to stderr the string 'Trace :', followed by the util.format()\nformatted message and stack trace to the current position in the code.
\n
console.trace('Show me');\n  // Prints: (stack trace will vary based on where trace is called)\n  //  Trace: Show me\n  //    at repl:2:9\n  //    at REPLServer.defaultEval (repl.js:248:27)\n  //    at bound (domain.js:287:14)\n  //    at REPLServer.runBound [as eval] (domain.js:300:12)\n  //    at REPLServer.<anonymous> (repl.js:412:12)\n  //    at emitOne (events.js:82:20)\n  //    at REPLServer.emit (events.js:169:7)\n  //    at REPLServer.Interface._onLine (readline.js:210:10)\n  //    at REPLServer.Interface._line (readline.js:549:8)\n  //    at REPLServer.Interface._ttyWrite (readline.js:826:14)\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "message"
                    },
                    {
                      "name": "...",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "console.warn([data][, ...])",
              "type": "method",
              "name": "warn",
              "meta": {
                "added": [
                  "v0.1.100"
                ]
              },
              "desc": "
The console.warn() function is an alias for console.error().
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "data",
                      "optional": true
                    },
                    {
                      "name": "...",
                      "optional": true
                    }
                  ]
                }
              ]
            }
          ],
          "signatures": [
            {
              "params": [
                {
                  "name": "stdout"
                },
                {
                  "name": "stderr",
                  "optional": true
                }
              ],
              "desc": "
Creates a new Console by passing one or two writable stream instances.\nstdout is a writable stream to print log or info output. stderr\nis used for warning or error output. If stderr isn't passed, warning and error\noutput will be sent to stdout.
\n
const output = fs.createWriteStream('./stdout.log');\nconst errorOutput = fs.createWriteStream('./stderr.log');\n// custom simple logger\nconst logger = new Console(output, errorOutput);\n// use it like console\nconst count = 5;\nlogger.log('count: %d', count);\n// in stdout.log: count 5\n
\n
The global console is a special Console whose output is sent to\nprocess.stdout and process.stderr. It is equivalent to calling:
\n
new Console(process.stdout, process.stderr);\n
\n"
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "Console"
    }
  ]
}
node-v4.8.2/doc/api/console.md000644 000766 000024 00000022671 13070706735 016272 0ustar00iojsstaff000000 000000 # Console

> Stability: 2 - Stable

The `console` module provides a simple debugging console that is similar to the
JavaScript console mechanism provided by web browsers.

The module exports two specific components:

* A `Console` class with methods such as `console.log()`, `console.error()` and
  `console.warn()` that can be used to write to any Node.js stream.
* A global `console` instance configured to write to `stdout` and `stderr`.
  Because this object is global, it can be used without calling
  `require('console')`.

Example using the global `console`:

```js
console.log('hello world');
  // Prints: hello world, to stdout
console.log('hello %s', 'world');
  // Prints: hello world, to stdout
console.error(new Error('Whoops, something bad happened'));
  // Prints: [Error: Whoops, something bad happened], to stderr

const name = 'Will Robinson';
console.warn(`Danger ${name}! Danger!`);
  // Prints: Danger Will Robinson! Danger!, to stderr
```

Example using the `Console` class:

```js
const out = getStreamSomehow();
const err = getStreamSomehow();
const myConsole = new console.Console(out, err);

myConsole.log('hello world');
  // Prints: hello world, to out
myConsole.log('hello %s', 'world');
  // Prints: hello world, to out
myConsole.error(new Error('Whoops, something bad happened'));
  // Prints: [Error: Whoops, something bad happened], to err

const name = 'Will Robinson';
myConsole.warn(`Danger ${name}! Danger!`);
  // Prints: Danger Will Robinson! Danger!, to err
```

While the API for the `Console` class is designed fundamentally around the
browser `console` object, the `Console` in Node.js is *not* intended to
duplicate the browser's functionality exactly.

## Asynchronous vs Synchronous Consoles

The console functions are usually asynchronous unless the destination is a file.
Disks are fast and operating systems normally employ write-back caching;
it should be a very rare occurrence indeed that a write blocks, but it
is possible.

Additionally, console functions are blocking when outputting to TTYs
(terminals) on OS X as a workaround for the OS's very small, 1kb buffer size.
This is to prevent interleaving between `stdout` and `stderr`.

## Class: Console



The `Console` class can be used to create a simple logger with configurable
output streams and can be accessed using either `require('console').Console`
or `console.Console`:

```js
const Console = require('console').Console;
const Console = console.Console;
```

### new Console(stdout[, stderr])

Creates a new `Console` by passing one or two writable stream instances.
`stdout` is a writable stream to print log or info output. `stderr`
is used for warning or error output. If `stderr` isn't passed, warning and error
output will be sent to `stdout`.

```js
const output = fs.createWriteStream('./stdout.log');
const errorOutput = fs.createWriteStream('./stderr.log');
// custom simple logger
const logger = new Console(output, errorOutput);
// use it like console
const count = 5;
logger.log('count: %d', count);
// in stdout.log: count 5
```

The global `console` is a special `Console` whose output is sent to
[`process.stdout`][] and [`process.stderr`][]. It is equivalent to calling:

```js
new Console(process.stdout, process.stderr);
```

### console.assert(value[, message][, ...])


A simple assertion test that verifies whether `value` is truthy. If it is not,
an `AssertionError` is thrown. If provided, the error `message` is formatted
using [`util.format()`][] and used as the error message.

```js
console.assert(true, 'does nothing');
  // OK
console.assert(false, 'Whoops %s', 'didn\'t work');
  // AssertionError: Whoops didn't work
```

*Note: the `console.assert()` method is implemented differently in Node.js
than the `console.assert()` method [available in browsers][web-api-assert].*

Specifically, in browsers, calling `console.assert()` with a falsy
assertion will cause the `message` to be printed to the console without
interrupting execution of subsequent code. In Node.js, however, a falsy
assertion will cause an `AssertionError` to be thrown.

Functionality approximating that implemented by browsers can be implemented
by extending Node.js' `console` and overriding the `console.assert()` method.

In the following example, a simple module is created that extends and overrides
the default behavior of `console` in Node.js.

```js
'use strict';

// Creates a simple extension of console with a
// new impl for assert without monkey-patching.
const myConsole = Object.create(console, {
  assert: {
    value: function assert(assertion, message, ...args) {
      try {
        console.assert(assertion, message, ...args);
      } catch (err) {
        console.error(err.stack);
      }
    },
    configurable: true,
    enumerable: true,
    writable: true,
  },
});

module.exports = myConsole;
```

This can then be used as a direct replacement for the built in console:

```js
const console = require('./myConsole');
console.assert(false, 'this message will print, but no error thrown');
console.log('this will also print');
```

### console.dir(obj[, options])


Uses [`util.inspect()`][] on `obj` and prints the resulting string to `stdout`.
This function bypasses any custom `inspect()` function defined on `obj`. An
optional `options` object may be passed to alter certain aspects of the
formatted string:

- `showHidden` - if `true` then the object's non-enumerable and symbol
properties will be shown too. Defaults to `false`.

- `depth` - tells [`util.inspect()`][] how many times to recurse while
formatting the object. This is useful for inspecting large complicated objects.
Defaults to `2`. To make it recurse indefinitely, pass `null`.

- `colors` - if `true`, then the output will be styled with ANSI color codes.
Defaults to `false`. Colors are customizable; see
[customizing `util.inspect()` colors][].

### console.error([data][, ...])


Prints to `stderr` with newline. Multiple arguments can be passed, with the
first used as the primary message and all additional used as substitution
values similar to printf(3) (the arguments are all passed to
[`util.format()`][]).

```js
const code = 5;
console.error('error #%d', code);
  // Prints: error #5, to stderr
console.error('error', code);
  // Prints: error 5, to stderr
```

If formatting elements (e.g. `%d`) are not found in the first string then
[`util.inspect()`][] is called on each argument and the resulting string
values are concatenated. See [`util.format()`][] for more information.

### console.info([data][, ...])


The `console.info()` function is an alias for [`console.log()`][].

### console.log([data][, ...])


Prints to `stdout` with newline. Multiple arguments can be passed, with the
first used as the primary message and all additional used as substitution
values similar to printf(3) (the arguments are all passed to
[`util.format()`][]).

```js
const count = 5;
console.log('count: %d', count);
  // Prints: count: 5, to stdout
console.log('count:', count);
  // Prints: count: 5, to stdout
```

If formatting elements (e.g. `%d`) are not found in the first string then
[`util.inspect()`][] is called on each argument and the resulting string
values are concatenated. See [`util.format()`][] for more information.

### console.time(label)


Used to calculate the duration of a specific operation. To start a timer, call
the `console.time()` method, giving it a unique `label` as the only parameter. To stop the
timer, and to get the elapsed time in milliseconds, just call the
[`console.timeEnd()`][] method, again passing the
timer's unique `label` as the parameter.

### console.timeEnd(label)


Stops a timer that was previously started by calling [`console.time()`][] and
prints the result to stdout:

```js
console.time('100-elements');
for (let i = 0; i < 100; i++) {
  ;
}
console.timeEnd('100-elements');
// prints 100-elements: 262ms
```

### console.trace(message[, ...])


Prints to `stderr` the string `'Trace :'`, followed by the [`util.format()`][]
formatted message and stack trace to the current position in the code.

```js
console.trace('Show me');
  // Prints: (stack trace will vary based on where trace is called)
  //  Trace: Show me
  //    at repl:2:9
  //    at REPLServer.defaultEval (repl.js:248:27)
  //    at bound (domain.js:287:14)
  //    at REPLServer.runBound [as eval] (domain.js:300:12)
  //    at REPLServer. (repl.js:412:12)
  //    at emitOne (events.js:82:20)
  //    at REPLServer.emit (events.js:169:7)
  //    at REPLServer.Interface._onLine (readline.js:210:10)
  //    at REPLServer.Interface._line (readline.js:549:8)
  //    at REPLServer.Interface._ttyWrite (readline.js:826:14)
```

### console.warn([data][, ...])


The `console.warn()` function is an alias for [`console.error()`][].

[`console.error()`]: #console_console_error_data
[`console.log()`]: #console_console_log_data
[`console.time()`]: #console_console_time_label
[`console.timeEnd()`]: #console_console_timeend_label
[`process.stderr`]: process.html#process_process_stderr
[`process.stdout`]: process.html#process_process_stdout
[`util.format()`]: util.html#util_util_format_format
[`util.inspect()`]: util.html#util_util_inspect_object_options
[customizing `util.inspect()` colors]: util.html#util_customizing_util_inspect_colors
[web-api-assert]: https://developer.mozilla.org/en-US/docs/Web/API/console/assert
node-v4.8.2/doc/api/crypto.html000644 000766 000024 00000301466 13070706740 016512 0ustar00iojsstaff000000 000000 


  
  Crypto | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

        
Table of Contents

        

      


      

        
Crypto#


Stability: 2 - Stable
The crypto module provides cryptographic functionality that includes a set of
wrappers for OpenSSL's hash, HMAC, cipher, decipher, sign and verify functions.


Use require('crypto') to access this module.


const crypto = require('crypto');

const secret = 'abcdefg';
const hash = crypto.createHmac('sha256', secret)
                   .update('I love cupcakes')
                   .digest('hex');
console.log(hash);
  // Prints:
  //   c0fa1bc00531bd78ef38c628449c5102aeabd49b5dc3a2a516ea6ea959d6658e



Class: Certificate#



Added in: v0.11.8

SPKAC is a Certificate Signing Request mechanism originally implemented by
Netscape and now specified formally as part of HTML5's keygen element.


The crypto module provides the Certificate class for working with SPKAC
data. The most common usage is handling output generated by the HTML5
<keygen> element. Node.js uses OpenSSL's SPKAC implementation internally.


new crypto.Certificate()#


Instances of the Certificate class can be created using the new keyword
or by calling crypto.Certificate() as a function:


const crypto = require('crypto');

const cert1 = new crypto.Certificate();
const cert2 = crypto.Certificate();



certificate.exportChallenge(spkac)#



Added in: v0.11.8

The spkac data structure includes a public key and a challenge. The
certificate.exportChallenge() returns the challenge component in the
form of a Node.js Buffer. The spkac argument can be either a string
or a Buffer.


const cert = require('crypto').Certificate();
const spkac = getSpkacSomehow();
const challenge = cert.exportChallenge(spkac);
console.log(challenge.toString('utf8'));
  // Prints the challenge as a UTF8 string



certificate.exportPublicKey(spkac)#



Added in: v0.11.8

The spkac data structure includes a public key and a challenge. The
certificate.exportPublicKey() returns the public key component in the
form of a Node.js Buffer. The spkac argument can be either a string
or a Buffer.


const cert = require('crypto').Certificate();
const spkac = getSpkacSomehow();
const publicKey = cert.exportPublicKey(spkac);
console.log(publicKey);
  // Prints the public key as <Buffer ...>



certificate.verifySpkac(spkac)#



Added in: v0.11.8

Returns true if the given spkac data structure is valid, false otherwise.
The spkac argument must be a Node.js Buffer.


const cert = require('crypto').Certificate();
const spkac = getSpkacSomehow();
console.log(cert.verifySpkac(new Buffer(spkac)));
  // Prints true or false



Class: Cipher#



Added in: v0.1.94

Instances of the Cipher class are used to encrypt data. The class can be
used in one of two ways:


    

  • As a stream that is both readable and writable, where plain unencrypted
data is written to produce encrypted data on the readable side, or
    • 

  • Using the cipher.update() and cipher.final() methods to produce
the encrypted data.
    • 



The crypto.createCipher() or crypto.createCipheriv() methods are
used to create Cipher instances. Cipher objects are not to be created
directly using the new keyword.


Example: Using Cipher objects as streams:


const crypto = require('crypto');
const cipher = crypto.createCipher('aes192', 'a password');

var encrypted = '';
cipher.on('readable', () => {
  var data = cipher.read();
  if (data)
    encrypted += data.toString('hex');
});
cipher.on('end', () => {
  console.log(encrypted);
  // Prints: ca981be48e90867604588e75d04feabb63cc007a8f8ad89b10616ed84d815504
});

cipher.write('some clear text data');
cipher.end();



Example: Using Cipher and piped streams:


const crypto = require('crypto');
const fs = require('fs');
const cipher = crypto.createCipher('aes192', 'a password');

const input = fs.createReadStream('test.js');
const output = fs.createWriteStream('test.enc');

input.pipe(cipher).pipe(output);



Example: Using the cipher.update() and cipher.final() methods:


const crypto = require('crypto');
const cipher = crypto.createCipher('aes192', 'a password');

var encrypted = cipher.update('some clear text data', 'utf8', 'hex');
encrypted += cipher.final('hex');
console.log(encrypted);
  // Prints: ca981be48e90867604588e75d04feabb63cc007a8f8ad89b10616ed84d815504



cipher.final([output_encoding])#



Added in: v0.1.94

Returns any remaining enciphered contents. If output_encoding
parameter is one of 'binary', 'base64' or 'hex', a string is returned.
If an output_encoding is not provided, a Buffer is returned.


Once the cipher.final() method has been called, the Cipher object can no
longer be used to encrypt data. Attempts to call cipher.final() more than
once will result in an error being thrown.


cipher.setAAD(buffer)#



Added in: v1.0.0

When using an authenticated encryption mode (only GCM is currently
supported), the cipher.setAAD() method sets the value used for the
additional authenticated data (AAD) input parameter.


cipher.getAuthTag()#



Added in: v1.0.0

When using an authenticated encryption mode (only GCM is currently
supported), the cipher.getAuthTag() method returns a Buffer containing
the authentication tag that has been computed from the given data.


The cipher.getAuthTag() method should only be called after encryption has
been completed using the cipher.final() method.


cipher.setAutoPadding(auto_padding=true)#



Added in: v0.7.1

When using block encryption algorithms, the Cipher class will automatically
add padding to the input data to the appropriate block size. To disable the
default padding call cipher.setAutoPadding(false).


When auto_padding is false, the length of the entire input data must be a
multiple of the cipher's block size or cipher.final() will throw an Error.
Disabling automatic padding is useful for non-standard padding, for instance
using 0x0 instead of PKCS padding.


The cipher.setAutoPadding() method must be called before cipher.final().


cipher.update(data[, input_encoding][, output_encoding])#



Added in: v0.1.94

Updates the cipher with data. If the input_encoding argument is given,
it's value must be one of 'utf8', 'ascii', or 'binary' and the data
argument is a string using the specified encoding. If the input_encoding
argument is not given, data must be a Buffer. If data is a
Buffer then input_encoding is ignored.


The output_encoding specifies the output format of the enciphered
data, and can be 'binary', 'base64' or 'hex'. If the output_encoding
is specified, a string using the specified encoding is returned. If no
output_encoding is provided, a Buffer is returned.


The cipher.update() method can be called multiple times with new data until
cipher.final() is called. Calling cipher.update() after
cipher.final() will result in an error being thrown.


Class: Decipher#



Added in: v0.1.94

Instances of the Decipher class are used to decrypt data. The class can be
used in one of two ways:


    

  • As a stream that is both readable and writable, where plain encrypted
data is written to produce unencrypted data on the readable side, or
    • 

  • Using the decipher.update() and decipher.final() methods to
produce the unencrypted data.
    • 



The crypto.createDecipher() or crypto.createDecipheriv() methods are
used to create Decipher instances. Decipher objects are not to be created
directly using the new keyword.


Example: Using Decipher objects as streams:


const crypto = require('crypto');
const decipher = crypto.createDecipher('aes192', 'a password');

var decrypted = '';
decipher.on('readable', () => {
  var data = decipher.read();
  if (data)
  decrypted += data.toString('utf8');
});
decipher.on('end', () => {
  console.log(decrypted);
  // Prints: some clear text data
});

var encrypted = 'ca981be48e90867604588e75d04feabb63cc007a8f8ad89b10616ed84d815504';
decipher.write(encrypted, 'hex');
decipher.end();



Example: Using Decipher and piped streams:


const crypto = require('crypto');
const fs = require('fs');
const decipher = crypto.createDecipher('aes192', 'a password');

const input = fs.createReadStream('test.enc');
const output = fs.createWriteStream('test.js');

input.pipe(decipher).pipe(output);



Example: Using the decipher.update() and decipher.final() methods:


const crypto = require('crypto');
const decipher = crypto.createDecipher('aes192', 'a password');

var encrypted = 'ca981be48e90867604588e75d04feabb63cc007a8f8ad89b10616ed84d815504';
var decrypted = decipher.update(encrypted, 'hex', 'utf8');
decrypted += decipher.final('utf8');
console.log(decrypted);
  // Prints: some clear text data



decipher.final([output_encoding])#



Added in: v0.1.94

Returns any remaining deciphered contents. If output_encoding
parameter is one of 'binary', 'base64' or 'hex', a string is returned.
If an output_encoding is not provided, a Buffer is returned.


Once the decipher.final() method has been called, the Decipher object can
no longer be used to decrypt data. Attempts to call decipher.final() more
than once will result in an error being thrown.


decipher.setAAD(buffer)#



Added in: v1.0.0

When using an authenticated encryption mode (only GCM is currently
supported), the decipher.setAAD() method sets the value used for the
additional authenticated data (AAD) input parameter.


decipher.setAuthTag(buffer)#



Added in: v1.0.0

When using an authenticated encryption mode (only GCM is currently
supported), the decipher.setAuthTag() method is used to pass in the
received authentication tag. If no tag is provided, or if the cipher text
has been tampered with, decipher.final() with throw, indicating that the
cipher text should be discarded due to failed authentication.


decipher.setAutoPadding(auto_padding=true)#



Added in: v0.7.1

When data has been encrypted without standard block padding, calling
decipher.setAutoPadding(false) will disable automatic padding to prevent
decipher.final() from checking for and removing padding.


Turning auto padding off will only work if the input data's length is a
multiple of the ciphers block size.


The decipher.setAutoPadding() method must be called before
decipher.update().


decipher.update(data[, input_encoding][, output_encoding])#



Added in: v0.1.94

Updates the decipher with data. If the input_encoding argument is given,
it's value must be one of 'binary', 'base64', or 'hex' and the data
argument is a string using the specified encoding. If the input_encoding
argument is not given, data must be a Buffer. If data is a
Buffer then input_encoding is ignored.


The output_encoding specifies the output format of the enciphered
data, and can be 'binary', 'ascii' or 'utf8'. If the output_encoding
is specified, a string using the specified encoding is returned. If no
output_encoding is provided, a Buffer is returned.


The decipher.update() method can be called multiple times with new data until
decipher.final() is called. Calling decipher.update() after
decipher.final() will result in an error being thrown.


Class: DiffieHellman#



Added in: v0.5.0

The DiffieHellman class is a utility for creating Diffie-Hellman key
exchanges.


Instances of the DiffieHellman class can be created using the
crypto.createDiffieHellman() function.


const crypto = require('crypto');
const assert = require('assert');

// Generate Alice's keys...
const alice = crypto.createDiffieHellman(2048);
const alice_key = alice.generateKeys();

// Generate Bob's keys...
const bob = crypto.createDiffieHellman(alice.getPrime(), alice.getGenerator());
const bob_key = bob.generateKeys();

// Exchange and generate the secret...
const alice_secret = alice.computeSecret(bob_key);
const bob_secret = bob.computeSecret(alice_key);

// OK
assert.equal(alice_secret.toString('hex'), bob_secret.toString('hex'));



diffieHellman.computeSecret(other_public_key[, input_encoding][, output_encoding])#



Added in: v0.5.0

Computes the shared secret using other_public_key as the other
party's public key and returns the computed shared secret. The supplied
key is interpreted using the specified input_encoding, and secret is
encoded using specified output_encoding. Encodings can be
'binary', 'hex', or 'base64'. If the input_encoding is not
provided, other_public_key is expected to be a Buffer.


If output_encoding is given a string is returned; otherwise, a
Buffer is returned.


diffieHellman.generateKeys([encoding])#



Added in: v0.5.0

Generates private and public Diffie-Hellman key values, and returns
the public key in the specified encoding. This key should be
transferred to the other party. Encoding can be 'binary', 'hex',
or 'base64'. If encoding is provided a string is returned; otherwise a
Buffer is returned.


diffieHellman.getGenerator([encoding])#



Added in: v0.5.0

Returns the Diffie-Hellman generator in the specified encoding, which can
be 'binary', 'hex', or 'base64'. If  encoding is provided a string is
returned; otherwise a Buffer is returned.


diffieHellman.getPrime([encoding])#



Added in: v0.5.0

Returns the Diffie-Hellman prime in the specified encoding, which can
be 'binary', 'hex', or 'base64'. If encoding is provided a string is
returned; otherwise a Buffer is returned.


diffieHellman.getPrivateKey([encoding])#



Added in: v0.5.0

Returns the Diffie-Hellman private key in the specified encoding,
which can be 'binary', 'hex', or 'base64'. If encoding is provided a
string is returned; otherwise a Buffer is returned.


diffieHellman.getPublicKey([encoding])#



Added in: v0.5.0

Returns the Diffie-Hellman public key in the specified encoding, which
can be 'binary', 'hex', or 'base64'. If encoding is provided a
string is returned; otherwise a Buffer is returned.


diffieHellman.setPrivateKey(private_key[, encoding])#



Added in: v0.5.0

Sets the Diffie-Hellman private key. If the encoding argument is provided
and is either 'binary', 'hex', or 'base64', private_key is expected
to be a string. If no encoding is provided, private_key is expected
to be a Buffer.


diffieHellman.setPublicKey(public_key[, encoding])#



Added in: v0.5.0

Sets the Diffie-Hellman public key. If the encoding argument is provided
and is either 'binary', 'hex' or 'base64', public_key is expected
to be a string. If no encoding is provided, public_key is expected
to be a Buffer.


diffieHellman.verifyError#



Added in: v0.11.12

A bit field containing any warnings and/or errors resulting from a check
performed during initialization of the DiffieHellman object.


The following values are valid for this property (as defined in constants
module):


    

  • DH_CHECK_P_NOT_SAFE_PRIME
    • 

  • DH_CHECK_P_NOT_PRIME
    • 

  • DH_UNABLE_TO_CHECK_GENERATOR
    • 

  • DH_NOT_SUITABLE_GENERATOR
    • 



Class: ECDH#



Added in: v0.11.14

The ECDH class is a utility for creating Elliptic Curve Diffie-Hellman (ECDH)
key exchanges.


Instances of the ECDH class can be created using the
crypto.createECDH() function.


const crypto = require('crypto');
const assert = require('assert');

// Generate Alice's keys...
const alice = crypto.createECDH('secp521r1');
const alice_key = alice.generateKeys();

// Generate Bob's keys...
const bob = crypto.createECDH('secp521r1');
const bob_key = bob.generateKeys();

// Exchange and generate the secret...
const alice_secret = alice.computeSecret(bob_key);
const bob_secret = bob.computeSecret(alice_key);

assert(alice_secret, bob_secret);
  // OK



ecdh.computeSecret(other_public_key[, input_encoding][, output_encoding])#



Added in: v0.11.14

Computes the shared secret using other_public_key as the other
party's public key and returns the computed shared secret. The supplied
key is interpreted using specified input_encoding, and the returned secret
is encoded using the specified output_encoding. Encodings can be
'binary', 'hex', or 'base64'. If the input_encoding is not
provided, other_public_key is expected to be a Buffer.


If output_encoding is given a string will be returned; otherwise a
Buffer is returned.


ecdh.generateKeys([encoding[, format]])#



Added in: v0.11.14

Generates private and public EC Diffie-Hellman key values, and returns
the public key in the specified format and encoding. This key should be
transferred to the other party.


The format arguments specifies point encoding and can be 'compressed',
'uncompressed', or 'hybrid'. If format is not specified, the point will
be returned in 'uncompressed' format.


The encoding argument can be 'binary', 'hex', or 'base64'. If
encoding is provided a string is returned; otherwise a Buffer
is returned.


ecdh.getPrivateKey([encoding])#



Added in: v0.11.14

Returns the EC Diffie-Hellman private key in the specified encoding,
which can be 'binary', 'hex', or 'base64'. If encoding is provided
a string is returned; otherwise a Buffer is returned.


ecdh.getPublicKey([encoding[, format]])#



Added in: v0.11.14

Returns the EC Diffie-Hellman public key in the specified encoding and
format.


The format argument specifies point encoding and can be 'compressed',
'uncompressed', or 'hybrid'. If format is not specified the point will be
returned in 'uncompressed' format.


The encoding argument can be 'binary', 'hex', or 'base64'. If
encoding is specified, a string is returned; otherwise a Buffer is
returned.


ecdh.setPrivateKey(private_key[, encoding])#



Added in: v0.11.14

Sets the EC Diffie-Hellman private key. The encoding can be 'binary',
'hex' or 'base64'. If encoding is provided, private_key is expected
to be a string; otherwise private_key is expected to be a Buffer. If
private_key is not valid for the curve specified when the ECDH object was
created, an error is thrown. Upon setting the private key, the associated
public point (key) is also generated and set in the ECDH object.


ecdh.setPublicKey(public_key[, encoding])#



Added in: v0.11.14
Deprecated since: v5.2.0 

Stability: 0 - Deprecated
Sets the EC Diffie-Hellman public key. Key encoding can be 'binary',
'hex' or 'base64'. If encoding is provided public_key is expected to
be a string; otherwise a Buffer is expected.


Note that there is not normally a reason to call this method because ECDH
only requires a private key and the other party's public key to compute the
shared secret. Typically either ecdh.generateKeys() or
ecdh.setPrivateKey() will be called. The ecdh.setPrivateKey() method
attempts to generate the public point/key associated with the private key being
set.


Example (obtaining a shared secret):


const crypto = require('crypto');
const alice = crypto.createECDH('secp256k1');
const bob = crypto.createECDH('secp256k1');

// Note: This is a shortcut way to specify one of Alice's previous private
// keys. It would be unwise to use such a predictable private key in a real
// application.
alice.setPrivateKey(
  crypto.createHash('sha256').update('alice', 'utf8').digest()
);

// Bob uses a newly generated cryptographically strong
// pseudorandom key pair bob.generateKeys();

const alice_secret = alice.computeSecret(bob.getPublicKey(), null, 'hex');
const bob_secret = bob.computeSecret(alice.getPublicKey(), null, 'hex');

// alice_secret and bob_secret should be the same shared secret value
console.log(alice_secret === bob_secret);



Class: Hash#



Added in: v0.1.92

The Hash class is a utility for creating hash digests of data. It can be
used in one of two ways:


    

  • As a stream that is both readable and writable, where data is written
to produce a computed hash digest on the readable side, or
    • 

  • Using the hash.update() and hash.digest() methods to produce the
computed hash.
    • 



The crypto.createHash() method is used to create Hash instances. Hash
objects are not to be created directly using the new keyword.


Example: Using Hash objects as streams:


const crypto = require('crypto');
const hash = crypto.createHash('sha256');

hash.on('readable', () => {
  var data = hash.read();
  if (data)
    console.log(data.toString('hex'));
    // Prints:
    //   6a2da20943931e9834fc12cfe5bb47bbd9ae43489a30726962b576f4e3993e50
});

hash.write('some data to hash');
hash.end();



Example: Using Hash and piped streams:


const crypto = require('crypto');
const fs = require('fs');
const hash = crypto.createHash('sha256');

const input = fs.createReadStream('test.js');
input.pipe(hash).pipe(process.stdout);



Example: Using the hash.update() and hash.digest() methods:


const crypto = require('crypto');
const hash = crypto.createHash('sha256');

hash.update('some data to hash');
console.log(hash.digest('hex'));
  // Prints:
  //   6a2da20943931e9834fc12cfe5bb47bbd9ae43489a30726962b576f4e3993e50



hash.digest([encoding])#



Added in: v0.1.92

Calculates the digest of all of the data passed to be hashed (using the
hash.update() method). The encoding can be 'hex', 'binary' or
'base64'. If encoding is provided a string will be returned; otherwise
a Buffer is returned.


The Hash object can not be used again after hash.digest() method has been
called. Multiple calls will cause an error to be thrown.


hash.update(data[, input_encoding])#



Added in: v0.1.92

Updates the hash content with the given data, the encoding of which
is given in input_encoding and can be 'utf8', 'ascii' or
'binary'. If encoding is not provided, and the data is a string, an
encoding of 'binary' is enforced. If data is a Buffer then
input_encoding is ignored.


This can be called many times with new data as it is streamed.


Class: Hmac#



Added in: v0.1.94

The Hmac Class is a utility for creating cryptographic HMAC digests. It can
be used in one of two ways:


    

  • As a stream that is both readable and writable, where data is written
to produce a computed HMAC digest on the readable side, or
    • 

  • Using the hmac.update() and hmac.digest() methods to produce the
computed HMAC digest.
    • 



The crypto.createHmac() method is used to create Hmac instances. Hmac
objects are not to be created directly using the new keyword.


Example: Using Hmac objects as streams:


const crypto = require('crypto');
const hmac = crypto.createHmac('sha256', 'a secret');

hmac.on('readable', () => {
  var data = hmac.read();
  if (data)
    console.log(data.toString('hex'));
    // Prints:
    //   7fd04df92f636fd450bc841c9418e5825c17f33ad9c87c518115a45971f7f77e
});

hmac.write('some data to hash');
hmac.end();



Example: Using Hmac and piped streams:


const crypto = require('crypto');
const fs = require('fs');
const hmac = crypto.createHmac('sha256', 'a secret');

const input = fs.createReadStream('test.js');
input.pipe(hmac).pipe(process.stdout);



Example: Using the hmac.update() and hmac.digest() methods:


const crypto = require('crypto');
const hmac = crypto.createHmac('sha256', 'a secret');

hmac.update('some data to hash');
console.log(hmac.digest('hex'));
  // Prints:
  //   7fd04df92f636fd450bc841c9418e5825c17f33ad9c87c518115a45971f7f77e



hmac.digest([encoding])#



Added in: v0.1.94

Calculates the HMAC digest of all of the data passed using hmac.update().
The encoding can be 'hex', 'binary' or 'base64'. If encoding is
provided a string is returned; otherwise a Buffer is returned;


The Hmac object can not be used again after hmac.digest() has been
called. Multiple calls to hmac.digest() will result in an error being thrown.


hmac.update(data[, input_encoding])#



Added in: v0.1.94

Updates the Hmac content with the given data, the encoding of which
is given in input_encoding and can be 'utf8', 'ascii' or
'binary'. If encoding is not provided, and the data is a string, an
encoding of 'utf8' is enforced. If data is a Buffer then
input_encoding is ignored.


This can be called many times with new data as it is streamed.


Class: Sign#



Added in: v0.1.92

The Sign Class is a utility for generating signatures. It can be used in one
of two ways:


    

  • As a writable stream, where data to be signed is written and the
sign.sign() method is used to generate and return the signature, or
    • 

  • Using the sign.update() and sign.sign() methods to produce the
signature.
    • 



The crypto.createSign() method is used to create Sign instances. Sign
objects are not to be created directly using the new keyword.


Example: Using Sign objects as streams:


const crypto = require('crypto');
const sign = crypto.createSign('RSA-SHA256');

sign.write('some data to sign');
sign.end();

const private_key = getPrivateKeySomehow();
console.log(sign.sign(private_key, 'hex'));
  // Prints the calculated signature



Example: Using the sign.update() and sign.sign() methods:


const crypto = require('crypto');
const sign = crypto.createSign('RSA-SHA256');

sign.update('some data to sign');

const private_key = getPrivateKeySomehow();
console.log(sign.sign(private_key, 'hex'));
  // Prints the calculated signature



A Sign instance can also be created by just passing in the digest
algorithm name, in which case OpenSSL will infer the full signature algorithm
from the type of the PEM-formatted private key, including algorithms that
do not have directly exposed name constants, e.g. 'ecdsa-with-SHA256'.


Example: signing using ECDSA with SHA256


const crypto = require('crypto');
const sign = crypto.createSign('sha256');

sign.update('some data to sign');

const private_key = '-----BEGIN EC PRIVATE KEY-----\n' +
        'MHcCAQEEIF+jnWY1D5kbVYDNvxxo/Y+ku2uJPDwS0r/VuPZQrjjVoAoGCCqGSM49\n' +
        'AwEHoUQDQgAEurOxfSxmqIRYzJVagdZfMMSjRNNhB8i3mXyIMq704m2m52FdfKZ2\n' +
        'pQhByd5eyj3lgZ7m7jbchtdgyOF8Io/1ng==\n' +
        '-----END EC PRIVATE KEY-----\n';

console.log(sign.sign(private_key).toString('hex'));



sign.sign(private_key[, output_format])#



Added in: v0.1.92

Calculates the signature on all the data passed through using either
sign.update() or sign.write().


The private_key argument can be an object or a string. If private_key is a
string, it is treated as a raw key with no passphrase. If private_key is an
object, it is interpreted as a hash containing two properties:


    

  • key : <String> - PEM encoded private key
    • 

  • passphrase : <String> - passphrase for the private key
    • 



The output_format can specify one of 'binary', 'hex' or 'base64'. If
output_format is provided a string is returned; otherwise a Buffer is
returned.


The Sign object can not be again used after sign.sign() method has been
called. Multiple calls to sign.sign() will result in an error being thrown.


sign.update(data[, input_encoding])#



Added in: v0.1.92

Updates the Sign content with the given data, the encoding of which
is given in input_encoding and can be 'utf8', 'ascii' or
'binary'. If encoding is not provided, and the data is a string, an
encoding of 'utf8' is enforced. If data is a Buffer then
input_encoding is ignored.


This can be called many times with new data as it is streamed.


Class: Verify#



Added in: v0.1.92

The Verify class is a utility for verifying signatures. It can be used in one
of two ways:



The [crypto.createVerify()][] method is used to create Verify instances.
Verify objects are not to be created directly using the new keyword.


Example: Using Verify objects as streams:


const crypto = require('crypto');
const verify = crypto.createVerify('RSA-SHA256');

verify.write('some data to sign');
verify.end();

const public_key = getPublicKeySomehow();
const signature = getSignatureToVerify();
console.log(verify.verify(public_key, signature));
  // Prints true or false



Example: Using the verify.update() and verify.verify() methods:


const crypto = require('crypto');
const verify = crypto.createVerify('RSA-SHA256');

verify.update('some data to sign');

const public_key = getPublicKeySomehow();
const signature = getSignatureToVerify();
console.log(verify.verify(public_key, signature));
  // Prints true or false



verifier.update(data[, input_encoding])#



Added in: v0.1.92

Updates the Verify content with the given data, the encoding of which
is given in input_encoding and can be 'utf8', 'ascii' or
'binary'. If encoding is not provided, and the data is a string, an
encoding of 'utf8' is enforced. If data is a Buffer then
input_encoding is ignored.


This can be called many times with new data as it is streamed.


verifier.verify(object, signature[, signature_format])#



Added in: v0.1.92

Verifies the provided data using the given object and signature.
The object argument is a string containing a PEM encoded object, which can be
one an RSA public key, a DSA public key, or an X.509 certificate.
The signature argument is the previously calculated signature for the data, in
the signature_format which can be 'binary', 'hex' or 'base64'.
If a signature_format is specified, the signature is expected to be a
string; otherwise signature is expected to be a Buffer.


Returns true or false depending on the validity of the signature for
the data and public key.


The verifier object can not be used again after verify.verify() has been
called. Multiple calls to verify.verify() will result in an error being
thrown.


crypto module methods and properties#


crypto.DEFAULT_ENCODING#



Added in: v0.9.3

The default encoding to use for functions that can take either strings
or buffers. The default value is 'buffer', which makes methods
default to Buffer objects.


The crypto.DEFAULT_ENCODING mechanism is provided for backwards compatibility
with legacy programs that expect 'binary' to be the default encoding.


New applications should expect the default to be 'buffer'. This property may
become deprecated in a future Node.js release.


crypto.createCipher(algorithm, password)#



Added in: v0.1.94

Creates and returns a Cipher object that uses the given algorithm and
password.


The algorithm is dependent on OpenSSL, examples are 'aes192', etc. On
recent OpenSSL releases, openssl list-cipher-algorithms will display the
available cipher algorithms.


The password is used to derive the cipher key and initialization vector (IV).
The value must be either a 'binary' encoded string or a Buffer.


The implementation of crypto.createCipher() derives keys using the OpenSSL
function EVP_BytesToKey with the digest algorithm set to MD5, one
iteration, and no salt. The lack of salt allows dictionary attacks as the same
password always creates the same key. The low iteration count and
non-cryptographically secure hash algorithm allow passwords to be tested very
rapidly.


In line with OpenSSL's recommendation to use pbkdf2 instead of
EVP_BytesToKey it is recommended that developers derive a key and IV on
their own using crypto.pbkdf2() and to use crypto.createCipheriv()
to create the Cipher object.


crypto.createCipheriv(algorithm, key, iv)#


Creates and returns a Cipher object, with the given algorithm, key and
initialization vector (iv).


The algorithm is dependent on OpenSSL, examples are 'aes192', etc. On
recent OpenSSL releases, openssl list-cipher-algorithms will display the
available cipher algorithms.


The key is the raw key used by the algorithm and iv is an
initialization vector. Both arguments must be 'binary' encoded strings or
buffers.


crypto.createCredentials(details)#



Added in: v0.1.92
Deprecated since: v0.11.13 

Stability: 0 - Deprecated: Use tls.createSecureContext() instead.
The crypto.createCredentials() method is a deprecated alias for creating
and returning a tls.SecureContext object. The crypto.createCredentials()
method should not be used.


The optional details argument is a hash object with keys:


    

  • pfx : <String> | <Buffer> - PFX or PKCS12 encoded private
key, certificate and CA certificates
    • 

  • key : <String> - PEM encoded private key
    • 

  • passphrase : <String> - passphrase for the private key or PFX
    • 

  • cert : <String> - PEM encoded certificate
    • 

  • ca : <String> | <Array> - Either a string or array of strings of PEM encoded CA
certificates to trust.
    • 

  • crl : <String> | <Array> - Either a string or array of strings of PEM encoded CRLs
(Certificate Revocation List)
    • 

  • ciphers: <String> using the OpenSSL cipher list format describing the
cipher algorithms to use or exclude.
    • 



If no 'ca' details are given, Node.js will use Mozilla's default
publicly trusted list of CAs.


crypto.createDecipher(algorithm, password)#



Added in: v0.1.94

Creates and returns a Decipher object that uses the given algorithm and
password (key).


The implementation of crypto.createDecipher() derives keys using the OpenSSL
function EVP_BytesToKey with the digest algorithm set to MD5, one
iteration, and no salt. The lack of salt allows dictionary attacks as the same
password always creates the same key. The low iteration count and
non-cryptographically secure hash algorithm allow passwords to be tested very
rapidly.


In line with OpenSSL's recommendation to use pbkdf2 instead of
EVP_BytesToKey it is recommended that developers derive a key and IV on
their own using crypto.pbkdf2() and to use crypto.createDecipheriv()
to create the Decipher object.


crypto.createDecipheriv(algorithm, key, iv)#



Added in: v0.1.94

Creates and returns a Decipher object that uses the given algorithm, key
and initialization vector (iv).


The algorithm is dependent on OpenSSL, examples are 'aes192', etc. On
recent OpenSSL releases, openssl list-cipher-algorithms will display the
available cipher algorithms.


The key is the raw key used by the algorithm and iv is an
initialization vector. Both arguments must be 'binary' encoded strings or
buffers.


crypto.createDiffieHellman(prime[, prime_encoding][, generator][, generator_encoding])#



Added in: v0.11.12

Creates a DiffieHellman key exchange object using the supplied prime and an
optional specific generator.


The generator argument can be a number, string, or Buffer. If
generator is not specified, the value 2 is used.


The prime_encoding and generator_encoding arguments can be 'binary',
'hex', or 'base64'.


If prime_encoding is specified, prime is expected to be a string; otherwise
a Buffer is expected.


If generator_encoding is specified, generator is expected to be a string;
otherwise either a number or Buffer is expected.


crypto.createDiffieHellman(prime_length[, generator])#



Added in: v0.5.0

Creates a DiffieHellman key exchange object and generates a prime of
prime_length bits using an optional specific numeric generator.
If generator is not specified, the value 2 is used.


crypto.createECDH(curve_name)#



Added in: v0.11.14

Creates an Elliptic Curve Diffie-Hellman (ECDH) key exchange object using a
predefined curve specified by the curve_name string. Use
crypto.getCurves() to obtain a list of available curve names. On recent
OpenSSL releases, openssl ecparam -list_curves will also display the name
and description of each available elliptic curve.


crypto.createHash(algorithm)#



Added in: v0.1.92

Creates and returns a Hash object that can be used to generate hash digests
using the given algorithm.


The algorithm is dependent on the available algorithms supported by the
version of OpenSSL on the platform. Examples are 'sha256', 'sha512', etc.
On recent releases of OpenSSL, openssl list-message-digest-algorithms will
display the available digest algorithms.


Example: generating the sha256 sum of a file


const filename = process.argv[2];
const crypto = require('crypto');
const fs = require('fs');

const hash = crypto.createHash('sha256');

const input = fs.createReadStream(filename);
input.on('readable', () => {
  var data = input.read();
  if (data)
    hash.update(data);
  else {
    console.log(`${hash.digest('hex')} ${filename}`);
  }
});



crypto.createHmac(algorithm, key)#



Added in: v0.1.94

Creates and returns an Hmac object that uses the given algorithm and key.


The algorithm is dependent on the available algorithms supported by the
version of OpenSSL on the platform. Examples are 'sha256', 'sha512', etc.
On recent releases of OpenSSL, openssl list-message-digest-algorithms will
display the available digest algorithms.


The key is the HMAC key used to generate the cryptographic HMAC hash.


Example: generating the sha256 HMAC of a file


const filename = process.argv[2];
const crypto = require('crypto');
const fs = require('fs');

const hmac = crypto.createHmac('sha256', 'a secret');

const input = fs.createReadStream(filename);
input.on('readable', () => {
  var data = input.read();
  if (data)
    hmac.update(data);
  else {
    console.log(`${hmac.digest('hex')} ${filename}`);
  }
});



crypto.createSign(algorithm)#



Added in: v0.1.92

Creates and returns a Sign object that uses the given algorithm.
Use crypto.getHashes() to obtain an array of names of the available
signing algorithms.


crypto.createVerify(algorithm)#



Added in: v0.1.92

Creates and returns a Verify object that uses the given algorithm.
Use crypto.getHashes() to obtain an array of names of the available
signing algorithms.


crypto.getCiphers()#



Added in: v0.9.3

Returns an array with the names of the supported cipher algorithms.


Example:


const ciphers = crypto.getCiphers();
console.log(ciphers); // ['aes-128-cbc', 'aes-128-ccm', ...]



crypto.getCurves()#



Added in: v2.3.0

Returns an array with the names of the supported elliptic curves.


Example:


const curves = crypto.getCurves();
console.log(curves); // ['secp256k1', 'secp384r1', ...]



crypto.getDiffieHellman(group_name)#



Added in: v0.7.5

Creates a predefined DiffieHellman key exchange object. The
supported groups are: 'modp1', 'modp2', 'modp5' (defined in
RFC 2412, but see Caveats) and 'modp14', 'modp15',
'modp16', 'modp17', 'modp18' (defined in RFC 3526). The
returned object mimics the interface of objects created by
crypto.createDiffieHellman(), but will not allow changing
the keys (with diffieHellman.setPublicKey() for example). The
advantage of using this method is that the parties do not have to
generate nor exchange a group modulus beforehand, saving both processor
and communication time.


Example (obtaining a shared secret):


const crypto = require('crypto');
const alice = crypto.getDiffieHellman('modp14');
const bob = crypto.getDiffieHellman('modp14');

alice.generateKeys();
bob.generateKeys();

const alice_secret = alice.computeSecret(bob.getPublicKey(), null, 'hex');
const bob_secret = bob.computeSecret(alice.getPublicKey(), null, 'hex');

/* alice_secret and bob_secret should be the same */
console.log(alice_secret == bob_secret);



crypto.getHashes()#



Added in: v0.9.3

Returns an array of the names of the supported hash algorithms,
such as RSA-SHA256.


Example:


const hashes = crypto.getHashes();
console.log(hashes); // ['sha', 'sha1', 'sha1WithRSAEncryption', ...]



crypto.pbkdf2(password, salt, iterations, keylen[, digest], callback)#



Added in: v0.5.5

Provides an asynchronous Password-Based Key Derivation Function 2 (PBKDF2)
implementation. A selected HMAC digest algorithm specified by digest is
applied to derive a key of the requested byte length (keylen) from the
password, salt and iterations. If the digest algorithm is not specified,
a default of 'sha1' is used.


The supplied callback function is called with two arguments: err and
derivedKey. If an error occurs, err will be set; otherwise err will be
null. The successfully generated derivedKey will be passed as a Buffer.


The iterations argument must be a number set as high as possible. The
higher the number of iterations, the more secure the derived key will be,
but will take a longer amount of time to complete.


The salt should also be as unique as possible. It is recommended that the
salts are random and their lengths are greater than 16 bytes. See
NIST SP 800-132 for details.


Example:


const crypto = require('crypto');
crypto.pbkdf2('secret', 'salt', 100000, 512, 'sha512', (err, key) => {
  if (err) throw err;
  console.log(key.toString('hex'));  // 'c5e478d...1469e50'
});



An array of supported digest functions can be retrieved using
crypto.getHashes().


crypto.pbkdf2Sync(password, salt, iterations, keylen[, digest])#



Added in: v0.9.3

Provides a synchronous Password-Based Key Derivation Function 2 (PBKDF2)
implementation. A selected HMAC digest algorithm specified by digest is
applied to derive a key of the requested byte length (keylen) from the
password, salt and iterations. If the digest algorithm is not specified,
a default of 'sha1' is used.


If an error occurs an Error will be thrown, otherwise the derived key will be
returned as a Buffer.


The iterations argument must be a number set as high as possible. The
higher the number of iterations, the more secure the derived key will be,
but will take a longer amount of time to complete.


The salt should also be as unique as possible. It is recommended that the
salts are random and their lengths are greater than 16 bytes. See
NIST SP 800-132 for details.


Example:


const crypto = require('crypto');
const key = crypto.pbkdf2Sync('secret', 'salt', 100000, 512, 'sha512');
console.log(key.toString('hex'));  // 'c5e478d...1469e50'



An array of supported digest functions can be retrieved using
crypto.getHashes().


crypto.privateDecrypt(private_key, buffer)#



Added in: v0.11.14

Decrypts buffer with private_key.


private_key can be an object or a string. If private_key is a string, it is
treated as the key with no passphrase and will use RSA_PKCS1_OAEP_PADDING.
If private_key is an object, it is interpreted as a hash object with the
keys:


    

  • key : <String> - PEM encoded private key
    • 

  • passphrase : <String> - Optional passphrase for the private key
    • 

  • padding : An optional padding value, one of the following:
      

    • constants.RSA_NO_PADDING
      • 

    • constants.RSA_PKCS1_PADDING
      • 

    • constants.RSA_PKCS1_OAEP_PADDING
      • 

    

    • 



All paddings are defined in the constants module.


crypto.privateEncrypt(private_key, buffer)#



Added in: v1.1.0

Encrypts buffer with private_key.


private_key can be an object or a string. If private_key is a string, it is
treated as the key with no passphrase and will use RSA_PKCS1_PADDING.
If private_key is an object, it is interpreted as a hash object with the
keys:


    

  • key : <String> - PEM encoded private key
    • 

  • passphrase : <String> - Optional passphrase for the private key
    • 

  • padding : An optional padding value, one of the following:
      

    • constants.RSA_NO_PADDING
      • 

    • constants.RSA_PKCS1_PADDING
      • 

    

    • 



All paddings are defined in the constants module.


crypto.publicDecrypt(public_key, buffer)#



Added in: v1.1.0

Decrypts buffer with public_key.


public_key can be an object or a string. If public_key is a string, it is
treated as the key with no passphrase and will use RSA_PKCS1_PADDING.
If public_key is an object, it is interpreted as a hash object with the
keys:


    

  • key : <String> - PEM encoded public key
    • 

  • passphrase : <String> - Optional passphrase for the private key
    • 

  • padding : An optional padding value, one of the following:
      

    • constants.RSA_NO_PADDING
      • 

    • constants.RSA_PKCS1_PADDING
      • 

    • constants.RSA_PKCS1_OAEP_PADDING
      • 

    

    • 



Because RSA public keys can be derived from private keys, a private key may
be passed instead of a public key.


All paddings are defined in the constants module.


crypto.publicEncrypt(public_key, buffer)#



Added in: v0.11.14

Encrypts buffer with public_key.


public_key can be an object or a string. If public_key is a string, it is
treated as the key with no passphrase and will use RSA_PKCS1_OAEP_PADDING.
If public_key is an object, it is interpreted as a hash object with the
keys:


    

  • key : <String> - PEM encoded public key
    • 

  • passphrase : <String> - Optional passphrase for the private key
    • 

  • padding : An optional padding value, one of the following:
      

    • constants.RSA_NO_PADDING
      • 

    • constants.RSA_PKCS1_PADDING
      • 

    • constants.RSA_PKCS1_OAEP_PADDING
      • 

    

    • 



Because RSA public keys can be derived from private keys, a private key may
be passed instead of a public key.


All paddings are defined in the constants module.


crypto.randomBytes(size[, callback])#



Added in: v0.5.8

Generates cryptographically strong pseudo-random data. The size argument
is a number indicating the number of bytes to generate.


If a callback function is provided, the bytes are generated asynchronously
and the callback function is invoked with two arguments: err and buf.
If an error occurs, err will be an Error object; otherwise it is null. The
buf argument is a Buffer containing the generated bytes.


// Asynchronous
const crypto = require('crypto');
crypto.randomBytes(256, (err, buf) => {
  if (err) throw err;
  console.log(`${buf.length} bytes of random data: ${buf.toString('hex')}`);
});



If the callback function is not provided, the random bytes are generated
synchronously and returned as a Buffer. An error will be thrown if
there is a problem generating the bytes.


// Synchronous
const buf = crypto.randomBytes(256);
console.log(
  `${buf.length} bytes of random data: ${buf.toString('hex')}`);



The crypto.randomBytes() method will block until there is sufficient entropy.
This should normally never take longer than a few milliseconds. The only time
when generating the random bytes may conceivably block for a longer period of
time is right after boot, when the whole system is still low on entropy.


crypto.setEngine(engine[, flags])#



Added in: v0.11.11

Load and set the engine for some or all OpenSSL functions (selected by flags).


engine could be either an id or a path to the engine's shared library.


The optional flags argument uses ENGINE_METHOD_ALL by default. The flags
is a bit field taking one of or a mix of the following flags (defined in the
constants module):


    

  • ENGINE_METHOD_RSA
    • 

  • ENGINE_METHOD_DSA
    • 

  • ENGINE_METHOD_DH
    • 

  • ENGINE_METHOD_RAND
    • 

  • ENGINE_METHOD_ECDH
    • 

  • ENGINE_METHOD_ECDSA
    • 

  • ENGINE_METHOD_CIPHERS
    • 

  • ENGINE_METHOD_DIGESTS
    • 

  • ENGINE_METHOD_STORE
    • 

  • ENGINE_METHOD_PKEY_METH
    • 

  • ENGINE_METHOD_PKEY_ASN1_METH
    • 

  • ENGINE_METHOD_ALL
    • 

  • ENGINE_METHOD_NONE
    • 



Notes#


Legacy Streams API (pre Node.js v0.10)#


The Crypto module was added to Node.js before there was the concept of a
unified Stream API, and before there were Buffer objects for handling
binary data. As such, the many of the crypto defined classes have methods not
typically found on other Node.js classes that implement the streams
API (e.g. update(), final(), or digest()). Also, many methods accepted
and returned 'binary' encoded strings by default rather than Buffers. This
default was changed after Node.js v0.8 to use Buffer objects by default
instead.


Recent ECDH Changes#


Usage of ECDH with non-dynamically generated key pairs has been simplified.
Now, ecdh.setPrivateKey() can be called with a preselected private key
and the associated public point (key) will be computed and stored in the object.
This allows code to only store and provide the private part of the EC key pair.
ecdh.setPrivateKey() now also validates that the private key is valid for
the selected curve.


The ecdh.setPublicKey() method is now deprecated as its inclusion in the
API is not useful. Either a previously stored private key should be set, which
automatically generates the associated public key, or ecdh.generateKeys()
should be called. The main drawback of using ecdh.setPublicKey() is that
it can be used to put the ECDH key pair into an inconsistent state.


Support for weak or compromised algorithms#


The crypto module still supports some algorithms which are already
compromised and are not currently recommended for use. The API also allows
the use of ciphers and hashes with a small key size that are considered to be
too weak for safe use.


Users should take full responsibility for selecting the crypto
algorithm and key size according to their security requirements.


Based on the recommendations of NIST SP 800-131A:


    

  • MD5 and SHA-1 are no longer acceptable where collision resistance is
required such as digital signatures.
    • 

  • The key used with RSA, DSA and DH algorithms is recommended to have
at least 2048 bits and that of the curve of ECDSA and ECDH at least
224 bits, to be safe to use for several years.
    • 

  • The DH groups of modp1, modp2 and modp5 have a key size
smaller than 2048 bits and are not recommended.
    • 



See the reference for other recommendations and details.


      

    

  

  
  
  
  



node-v4.8.2/doc/api/crypto.json000644 000766 000024 00000317554 13070706740 016524 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/crypto.md",
  "modules": [
    {
      "textRaw": "Crypto",
      "name": "crypto",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
The crypto module provides cryptographic functionality that includes a set of\nwrappers for OpenSSL's hash, HMAC, cipher, decipher, sign and verify functions.
\n
Use require('crypto') to access this module.
\n
const crypto = require('crypto');\n\nconst secret = 'abcdefg';\nconst hash = crypto.createHmac('sha256', secret)\n                   .update('I love cupcakes')\n                   .digest('hex');\nconsole.log(hash);\n  // Prints:\n  //   c0fa1bc00531bd78ef38c628449c5102aeabd49b5dc3a2a516ea6ea959d6658e\n
\n",
      "classes": [
        {
          "textRaw": "Class: Certificate",
          "type": "class",
          "name": "Certificate",
          "meta": {
            "added": [
              "v0.11.8"
            ]
          },
          "desc": "
SPKAC is a Certificate Signing Request mechanism originally implemented by\nNetscape and now specified formally as part of HTML5's keygen element.
\n
The crypto module provides the Certificate class for working with SPKAC\ndata. The most common usage is handling output generated by the HTML5\n<keygen> element. Node.js uses OpenSSL's SPKAC implementation internally.
\n",
          "methods": [
            {
              "textRaw": "new crypto.Certificate()",
              "type": "method",
              "name": "Certificate",
              "desc": "
Instances of the Certificate class can be created using the new keyword\nor by calling crypto.Certificate() as a function:
\n
const crypto = require('crypto');\n\nconst cert1 = new crypto.Certificate();\nconst cert2 = crypto.Certificate();\n
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "certificate.exportChallenge(spkac)",
              "type": "method",
              "name": "exportChallenge",
              "meta": {
                "added": [
                  "v0.11.8"
                ]
              },
              "desc": "
The spkac data structure includes a public key and a challenge. The\ncertificate.exportChallenge() returns the challenge component in the\nform of a Node.js Buffer. The spkac argument can be either a string\nor a Buffer.
\n
const cert = require('crypto').Certificate();\nconst spkac = getSpkacSomehow();\nconst challenge = cert.exportChallenge(spkac);\nconsole.log(challenge.toString('utf8'));\n  // Prints the challenge as a UTF8 string\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "spkac"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "certificate.exportPublicKey(spkac)",
              "type": "method",
              "name": "exportPublicKey",
              "meta": {
                "added": [
                  "v0.11.8"
                ]
              },
              "desc": "
The spkac data structure includes a public key and a challenge. The\ncertificate.exportPublicKey() returns the public key component in the\nform of a Node.js Buffer. The spkac argument can be either a string\nor a Buffer.
\n
const cert = require('crypto').Certificate();\nconst spkac = getSpkacSomehow();\nconst publicKey = cert.exportPublicKey(spkac);\nconsole.log(publicKey);\n  // Prints the public key as <Buffer ...>\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "spkac"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "certificate.verifySpkac(spkac)",
              "type": "method",
              "name": "verifySpkac",
              "meta": {
                "added": [
                  "v0.11.8"
                ]
              },
              "desc": "
Returns true if the given spkac data structure is valid, false otherwise.\nThe spkac argument must be a Node.js Buffer.
\n
const cert = require('crypto').Certificate();\nconst spkac = getSpkacSomehow();\nconsole.log(cert.verifySpkac(new Buffer(spkac)));\n  // Prints true or false\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "spkac"
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "textRaw": "Class: Cipher",
          "type": "class",
          "name": "Cipher",
          "meta": {
            "added": [
              "v0.1.94"
            ]
          },
          "desc": "
Instances of the Cipher class are used to encrypt data. The class can be\nused in one of two ways:
\n
    \n
  • As a stream that is both readable and writable, where plain unencrypted\ndata is written to produce encrypted data on the readable side, or
    • \n
  • Using the cipher.update() and cipher.final() methods to produce\nthe encrypted data.
    • \n
\n
The crypto.createCipher() or crypto.createCipheriv() methods are\nused to create Cipher instances. Cipher objects are not to be created\ndirectly using the new keyword.
\n
Example: Using Cipher objects as streams:
\n
const crypto = require('crypto');\nconst cipher = crypto.createCipher('aes192', 'a password');\n\nvar encrypted = '';\ncipher.on('readable', () => {\n  var data = cipher.read();\n  if (data)\n    encrypted += data.toString('hex');\n});\ncipher.on('end', () => {\n  console.log(encrypted);\n  // Prints: ca981be48e90867604588e75d04feabb63cc007a8f8ad89b10616ed84d815504\n});\n\ncipher.write('some clear text data');\ncipher.end();\n
\n
Example: Using Cipher and piped streams:
\n
const crypto = require('crypto');\nconst fs = require('fs');\nconst cipher = crypto.createCipher('aes192', 'a password');\n\nconst input = fs.createReadStream('test.js');\nconst output = fs.createWriteStream('test.enc');\n\ninput.pipe(cipher).pipe(output);\n
\n
Example: Using the cipher.update() and cipher.final() methods:
\n
const crypto = require('crypto');\nconst cipher = crypto.createCipher('aes192', 'a password');\n\nvar encrypted = cipher.update('some clear text data', 'utf8', 'hex');\nencrypted += cipher.final('hex');\nconsole.log(encrypted);\n  // Prints: ca981be48e90867604588e75d04feabb63cc007a8f8ad89b10616ed84d815504\n
\n",
          "methods": [
            {
              "textRaw": "cipher.final([output_encoding])",
              "type": "method",
              "name": "final",
              "meta": {
                "added": [
                  "v0.1.94"
                ]
              },
              "desc": "
Returns any remaining enciphered contents. If output_encoding\nparameter is one of 'binary', 'base64' or 'hex', a string is returned.\nIf an output_encoding is not provided, a Buffer is returned.
\n
Once the cipher.final() method has been called, the Cipher object can no\nlonger be used to encrypt data. Attempts to call cipher.final() more than\nonce will result in an error being thrown.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "output_encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "cipher.setAAD(buffer)",
              "type": "method",
              "name": "setAAD",
              "meta": {
                "added": [
                  "v1.0.0"
                ]
              },
              "desc": "
When using an authenticated encryption mode (only GCM is currently\nsupported), the cipher.setAAD() method sets the value used for the\nadditional authenticated data (AAD) input parameter.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "buffer"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "cipher.getAuthTag()",
              "type": "method",
              "name": "getAuthTag",
              "meta": {
                "added": [
                  "v1.0.0"
                ]
              },
              "desc": "
When using an authenticated encryption mode (only GCM is currently\nsupported), the cipher.getAuthTag() method returns a Buffer containing\nthe authentication tag that has been computed from the given data.
\n
The cipher.getAuthTag() method should only be called after encryption has\nbeen completed using the cipher.final() method.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "cipher.setAutoPadding(auto_padding=true)",
              "type": "method",
              "name": "setAutoPadding",
              "meta": {
                "added": [
                  "v0.7.1"
                ]
              },
              "desc": "
When using block encryption algorithms, the Cipher class will automatically\nadd padding to the input data to the appropriate block size. To disable the\ndefault padding call cipher.setAutoPadding(false).
\n
When auto_padding is false, the length of the entire input data must be a\nmultiple of the cipher's block size or cipher.final() will throw an Error.\nDisabling automatic padding is useful for non-standard padding, for instance\nusing 0x0 instead of PKCS padding.
\n
The cipher.setAutoPadding() method must be called before cipher.final().
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "auto_padding",
                      "default": "true"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "cipher.update(data[, input_encoding][, output_encoding])",
              "type": "method",
              "name": "update",
              "meta": {
                "added": [
                  "v0.1.94"
                ]
              },
              "desc": "
Updates the cipher with data. If the input_encoding argument is given,\nit's value must be one of 'utf8', 'ascii', or 'binary' and the data\nargument is a string using the specified encoding. If the input_encoding\nargument is not given, data must be a Buffer. If data is a\nBuffer then input_encoding is ignored.
\n
The output_encoding specifies the output format of the enciphered\ndata, and can be 'binary', 'base64' or 'hex'. If the output_encoding\nis specified, a string using the specified encoding is returned. If no\noutput_encoding is provided, a Buffer is returned.
\n
The cipher.update() method can be called multiple times with new data until\ncipher.final() is called. Calling cipher.update() after\ncipher.final() will result in an error being thrown.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "data"
                    },
                    {
                      "name": "input_encoding",
                      "optional": true
                    },
                    {
                      "name": "output_encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "textRaw": "Class: Decipher",
          "type": "class",
          "name": "Decipher",
          "meta": {
            "added": [
              "v0.1.94"
            ]
          },
          "desc": "
Instances of the Decipher class are used to decrypt data. The class can be\nused in one of two ways:
\n
    \n
  • As a stream that is both readable and writable, where plain encrypted\ndata is written to produce unencrypted data on the readable side, or
    • \n
  • Using the decipher.update() and decipher.final() methods to\nproduce the unencrypted data.
    • \n
\n
The crypto.createDecipher() or crypto.createDecipheriv() methods are\nused to create Decipher instances. Decipher objects are not to be created\ndirectly using the new keyword.
\n
Example: Using Decipher objects as streams:
\n
const crypto = require('crypto');\nconst decipher = crypto.createDecipher('aes192', 'a password');\n\nvar decrypted = '';\ndecipher.on('readable', () => {\n  var data = decipher.read();\n  if (data)\n  decrypted += data.toString('utf8');\n});\ndecipher.on('end', () => {\n  console.log(decrypted);\n  // Prints: some clear text data\n});\n\nvar encrypted = 'ca981be48e90867604588e75d04feabb63cc007a8f8ad89b10616ed84d815504';\ndecipher.write(encrypted, 'hex');\ndecipher.end();\n
\n
Example: Using Decipher and piped streams:
\n
const crypto = require('crypto');\nconst fs = require('fs');\nconst decipher = crypto.createDecipher('aes192', 'a password');\n\nconst input = fs.createReadStream('test.enc');\nconst output = fs.createWriteStream('test.js');\n\ninput.pipe(decipher).pipe(output);\n
\n
Example: Using the decipher.update() and decipher.final() methods:
\n
const crypto = require('crypto');\nconst decipher = crypto.createDecipher('aes192', 'a password');\n\nvar encrypted = 'ca981be48e90867604588e75d04feabb63cc007a8f8ad89b10616ed84d815504';\nvar decrypted = decipher.update(encrypted, 'hex', 'utf8');\ndecrypted += decipher.final('utf8');\nconsole.log(decrypted);\n  // Prints: some clear text data\n
\n",
          "methods": [
            {
              "textRaw": "decipher.final([output_encoding])",
              "type": "method",
              "name": "final",
              "meta": {
                "added": [
                  "v0.1.94"
                ]
              },
              "desc": "
Returns any remaining deciphered contents. If output_encoding\nparameter is one of 'binary', 'base64' or 'hex', a string is returned.\nIf an output_encoding is not provided, a Buffer is returned.
\n
Once the decipher.final() method has been called, the Decipher object can\nno longer be used to decrypt data. Attempts to call decipher.final() more\nthan once will result in an error being thrown.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "output_encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "decipher.setAAD(buffer)",
              "type": "method",
              "name": "setAAD",
              "meta": {
                "added": [
                  "v1.0.0"
                ]
              },
              "desc": "
When using an authenticated encryption mode (only GCM is currently\nsupported), the decipher.setAAD() method sets the value used for the\nadditional authenticated data (AAD) input parameter.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "buffer"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "decipher.setAuthTag(buffer)",
              "type": "method",
              "name": "setAuthTag",
              "meta": {
                "added": [
                  "v1.0.0"
                ]
              },
              "desc": "
When using an authenticated encryption mode (only GCM is currently\nsupported), the decipher.setAuthTag() method is used to pass in the\nreceived authentication tag. If no tag is provided, or if the cipher text\nhas been tampered with, decipher.final() with throw, indicating that the\ncipher text should be discarded due to failed authentication.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "buffer"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "decipher.setAutoPadding(auto_padding=true)",
              "type": "method",
              "name": "setAutoPadding",
              "meta": {
                "added": [
                  "v0.7.1"
                ]
              },
              "desc": "
When data has been encrypted without standard block padding, calling\ndecipher.setAutoPadding(false) will disable automatic padding to prevent\ndecipher.final() from checking for and removing padding.
\n
Turning auto padding off will only work if the input data's length is a\nmultiple of the ciphers block size.
\n
The decipher.setAutoPadding() method must be called before\ndecipher.update().
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "auto_padding",
                      "default": "true"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "decipher.update(data[, input_encoding][, output_encoding])",
              "type": "method",
              "name": "update",
              "meta": {
                "added": [
                  "v0.1.94"
                ]
              },
              "desc": "
Updates the decipher with data. If the input_encoding argument is given,\nit's value must be one of 'binary', 'base64', or 'hex' and the data\nargument is a string using the specified encoding. If the input_encoding\nargument is not given, data must be a Buffer. If data is a\nBuffer then input_encoding is ignored.
\n
The output_encoding specifies the output format of the enciphered\ndata, and can be 'binary', 'ascii' or 'utf8'. If the output_encoding\nis specified, a string using the specified encoding is returned. If no\noutput_encoding is provided, a Buffer is returned.
\n
The decipher.update() method can be called multiple times with new data until\ndecipher.final() is called. Calling decipher.update() after\ndecipher.final() will result in an error being thrown.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "data"
                    },
                    {
                      "name": "input_encoding",
                      "optional": true
                    },
                    {
                      "name": "output_encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "textRaw": "Class: DiffieHellman",
          "type": "class",
          "name": "DiffieHellman",
          "meta": {
            "added": [
              "v0.5.0"
            ]
          },
          "desc": "
The DiffieHellman class is a utility for creating Diffie-Hellman key\nexchanges.
\n
Instances of the DiffieHellman class can be created using the\ncrypto.createDiffieHellman() function.
\n
const crypto = require('crypto');\nconst assert = require('assert');\n\n// Generate Alice's keys...\nconst alice = crypto.createDiffieHellman(2048);\nconst alice_key = alice.generateKeys();\n\n// Generate Bob's keys...\nconst bob = crypto.createDiffieHellman(alice.getPrime(), alice.getGenerator());\nconst bob_key = bob.generateKeys();\n\n// Exchange and generate the secret...\nconst alice_secret = alice.computeSecret(bob_key);\nconst bob_secret = bob.computeSecret(alice_key);\n\n// OK\nassert.equal(alice_secret.toString('hex'), bob_secret.toString('hex'));\n
\n",
          "methods": [
            {
              "textRaw": "diffieHellman.computeSecret(other_public_key[, input_encoding][, output_encoding])",
              "type": "method",
              "name": "computeSecret",
              "meta": {
                "added": [
                  "v0.5.0"
                ]
              },
              "desc": "
Computes the shared secret using other_public_key as the other\nparty's public key and returns the computed shared secret. The supplied\nkey is interpreted using the specified input_encoding, and secret is\nencoded using specified output_encoding. Encodings can be\n'binary', 'hex', or 'base64'. If the input_encoding is not\nprovided, other_public_key is expected to be a Buffer.
\n
If output_encoding is given a string is returned; otherwise, a\nBuffer is returned.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "other_public_key"
                    },
                    {
                      "name": "input_encoding",
                      "optional": true
                    },
                    {
                      "name": "output_encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "diffieHellman.generateKeys([encoding])",
              "type": "method",
              "name": "generateKeys",
              "meta": {
                "added": [
                  "v0.5.0"
                ]
              },
              "desc": "
Generates private and public Diffie-Hellman key values, and returns\nthe public key in the specified encoding. This key should be\ntransferred to the other party. Encoding can be 'binary', 'hex',\nor 'base64'. If encoding is provided a string is returned; otherwise a\nBuffer is returned.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "diffieHellman.getGenerator([encoding])",
              "type": "method",
              "name": "getGenerator",
              "meta": {
                "added": [
                  "v0.5.0"
                ]
              },
              "desc": "
Returns the Diffie-Hellman generator in the specified encoding, which can\nbe 'binary', 'hex', or 'base64'. If  encoding is provided a string is\nreturned; otherwise a Buffer is returned.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "diffieHellman.getPrime([encoding])",
              "type": "method",
              "name": "getPrime",
              "meta": {
                "added": [
                  "v0.5.0"
                ]
              },
              "desc": "
Returns the Diffie-Hellman prime in the specified encoding, which can\nbe 'binary', 'hex', or 'base64'. If encoding is provided a string is\nreturned; otherwise a Buffer is returned.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "diffieHellman.getPrivateKey([encoding])",
              "type": "method",
              "name": "getPrivateKey",
              "meta": {
                "added": [
                  "v0.5.0"
                ]
              },
              "desc": "
Returns the Diffie-Hellman private key in the specified encoding,\nwhich can be 'binary', 'hex', or 'base64'. If encoding is provided a\nstring is returned; otherwise a Buffer is returned.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "diffieHellman.getPublicKey([encoding])",
              "type": "method",
              "name": "getPublicKey",
              "meta": {
                "added": [
                  "v0.5.0"
                ]
              },
              "desc": "
Returns the Diffie-Hellman public key in the specified encoding, which\ncan be 'binary', 'hex', or 'base64'. If encoding is provided a\nstring is returned; otherwise a Buffer is returned.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "diffieHellman.setPrivateKey(private_key[, encoding])",
              "type": "method",
              "name": "setPrivateKey",
              "meta": {
                "added": [
                  "v0.5.0"
                ]
              },
              "desc": "
Sets the Diffie-Hellman private key. If the encoding argument is provided\nand is either 'binary', 'hex', or 'base64', private_key is expected\nto be a string. If no encoding is provided, private_key is expected\nto be a Buffer.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "private_key"
                    },
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "diffieHellman.setPublicKey(public_key[, encoding])",
              "type": "method",
              "name": "setPublicKey",
              "meta": {
                "added": [
                  "v0.5.0"
                ]
              },
              "desc": "
Sets the Diffie-Hellman public key. If the encoding argument is provided\nand is either 'binary', 'hex' or 'base64', public_key is expected\nto be a string. If no encoding is provided, public_key is expected\nto be a Buffer.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "public_key"
                    },
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            }
          ],
          "properties": [
            {
              "textRaw": "diffieHellman.verifyError",
              "name": "verifyError",
              "meta": {
                "added": [
                  "v0.11.12"
                ]
              },
              "desc": "
A bit field containing any warnings and/or errors resulting from a check\nperformed during initialization of the DiffieHellman object.
\n
The following values are valid for this property (as defined in constants\nmodule):
\n
    \n
  • DH_CHECK_P_NOT_SAFE_PRIME
    • \n
  • DH_CHECK_P_NOT_PRIME
    • \n
  • DH_UNABLE_TO_CHECK_GENERATOR
    • \n
  • DH_NOT_SUITABLE_GENERATOR
    • \n
\n"
            }
          ]
        },
        {
          "textRaw": "Class: ECDH",
          "type": "class",
          "name": "ECDH",
          "meta": {
            "added": [
              "v0.11.14"
            ]
          },
          "desc": "
The ECDH class is a utility for creating Elliptic Curve Diffie-Hellman (ECDH)\nkey exchanges.
\n
Instances of the ECDH class can be created using the\ncrypto.createECDH() function.
\n
const crypto = require('crypto');\nconst assert = require('assert');\n\n// Generate Alice's keys...\nconst alice = crypto.createECDH('secp521r1');\nconst alice_key = alice.generateKeys();\n\n// Generate Bob's keys...\nconst bob = crypto.createECDH('secp521r1');\nconst bob_key = bob.generateKeys();\n\n// Exchange and generate the secret...\nconst alice_secret = alice.computeSecret(bob_key);\nconst bob_secret = bob.computeSecret(alice_key);\n\nassert(alice_secret, bob_secret);\n  // OK\n
\n",
          "methods": [
            {
              "textRaw": "ecdh.computeSecret(other_public_key[, input_encoding][, output_encoding])",
              "type": "method",
              "name": "computeSecret",
              "meta": {
                "added": [
                  "v0.11.14"
                ]
              },
              "desc": "
Computes the shared secret using other_public_key as the other\nparty's public key and returns the computed shared secret. The supplied\nkey is interpreted using specified input_encoding, and the returned secret\nis encoded using the specified output_encoding. Encodings can be\n'binary', 'hex', or 'base64'. If the input_encoding is not\nprovided, other_public_key is expected to be a Buffer.
\n
If output_encoding is given a string will be returned; otherwise a\nBuffer is returned.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "other_public_key"
                    },
                    {
                      "name": "input_encoding",
                      "optional": true
                    },
                    {
                      "name": "output_encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "ecdh.generateKeys([encoding[, format]])",
              "type": "method",
              "name": "generateKeys",
              "meta": {
                "added": [
                  "v0.11.14"
                ]
              },
              "desc": "
Generates private and public EC Diffie-Hellman key values, and returns\nthe public key in the specified format and encoding. This key should be\ntransferred to the other party.
\n
The format arguments specifies point encoding and can be 'compressed',\n'uncompressed', or 'hybrid'. If format is not specified, the point will\nbe returned in 'uncompressed' format.
\n
The encoding argument can be 'binary', 'hex', or 'base64'. If\nencoding is provided a string is returned; otherwise a Buffer\nis returned.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "encoding",
                      "optional": true
                    },
                    {
                      "name": "format",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "ecdh.getPrivateKey([encoding])",
              "type": "method",
              "name": "getPrivateKey",
              "meta": {
                "added": [
                  "v0.11.14"
                ]
              },
              "desc": "
Returns the EC Diffie-Hellman private key in the specified encoding,\nwhich can be 'binary', 'hex', or 'base64'. If encoding is provided\na string is returned; otherwise a Buffer is returned.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "ecdh.getPublicKey([encoding[, format]])",
              "type": "method",
              "name": "getPublicKey",
              "meta": {
                "added": [
                  "v0.11.14"
                ]
              },
              "desc": "
Returns the EC Diffie-Hellman public key in the specified encoding and\nformat.
\n
The format argument specifies point encoding and can be 'compressed',\n'uncompressed', or 'hybrid'. If format is not specified the point will be\nreturned in 'uncompressed' format.
\n
The encoding argument can be 'binary', 'hex', or 'base64'. If\nencoding is specified, a string is returned; otherwise a Buffer is\nreturned.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "encoding",
                      "optional": true
                    },
                    {
                      "name": "format",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "ecdh.setPrivateKey(private_key[, encoding])",
              "type": "method",
              "name": "setPrivateKey",
              "meta": {
                "added": [
                  "v0.11.14"
                ]
              },
              "desc": "
Sets the EC Diffie-Hellman private key. The encoding can be 'binary',\n'hex' or 'base64'. If encoding is provided, private_key is expected\nto be a string; otherwise private_key is expected to be a Buffer. If\nprivate_key is not valid for the curve specified when the ECDH object was\ncreated, an error is thrown. Upon setting the private key, the associated\npublic point (key) is also generated and set in the ECDH object.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "private_key"
                    },
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "ecdh.setPublicKey(public_key[, encoding])",
              "type": "method",
              "name": "setPublicKey",
              "meta": {
                "added": [
                  "v0.11.14"
                ],
                "deprecated": [
                  "v5.2.0"
                ]
              },
              "stability": 0,
              "stabilityText": "Deprecated",
              "desc": "
Sets the EC Diffie-Hellman public key. Key encoding can be 'binary',\n'hex' or 'base64'. If encoding is provided public_key is expected to\nbe a string; otherwise a Buffer is expected.
\n
Note that there is not normally a reason to call this method because ECDH\nonly requires a private key and the other party's public key to compute the\nshared secret. Typically either ecdh.generateKeys() or\necdh.setPrivateKey() will be called. The ecdh.setPrivateKey() method\nattempts to generate the public point/key associated with the private key being\nset.
\n
Example (obtaining a shared secret):
\n
const crypto = require('crypto');\nconst alice = crypto.createECDH('secp256k1');\nconst bob = crypto.createECDH('secp256k1');\n\n// Note: This is a shortcut way to specify one of Alice's previous private\n// keys. It would be unwise to use such a predictable private key in a real\n// application.\nalice.setPrivateKey(\n  crypto.createHash('sha256').update('alice', 'utf8').digest()\n);\n\n// Bob uses a newly generated cryptographically strong\n// pseudorandom key pair bob.generateKeys();\n\nconst alice_secret = alice.computeSecret(bob.getPublicKey(), null, 'hex');\nconst bob_secret = bob.computeSecret(alice.getPublicKey(), null, 'hex');\n\n// alice_secret and bob_secret should be the same shared secret value\nconsole.log(alice_secret === bob_secret);\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "public_key"
                    },
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "textRaw": "Class: Hash",
          "type": "class",
          "name": "Hash",
          "meta": {
            "added": [
              "v0.1.92"
            ]
          },
          "desc": "
The Hash class is a utility for creating hash digests of data. It can be\nused in one of two ways:
\n
    \n
  • As a stream that is both readable and writable, where data is written\nto produce a computed hash digest on the readable side, or
    • \n
  • Using the hash.update() and hash.digest() methods to produce the\ncomputed hash.
    • \n
\n
The crypto.createHash() method is used to create Hash instances. Hash\nobjects are not to be created directly using the new keyword.
\n
Example: Using Hash objects as streams:
\n
const crypto = require('crypto');\nconst hash = crypto.createHash('sha256');\n\nhash.on('readable', () => {\n  var data = hash.read();\n  if (data)\n    console.log(data.toString('hex'));\n    // Prints:\n    //   6a2da20943931e9834fc12cfe5bb47bbd9ae43489a30726962b576f4e3993e50\n});\n\nhash.write('some data to hash');\nhash.end();\n
\n
Example: Using Hash and piped streams:
\n
const crypto = require('crypto');\nconst fs = require('fs');\nconst hash = crypto.createHash('sha256');\n\nconst input = fs.createReadStream('test.js');\ninput.pipe(hash).pipe(process.stdout);\n
\n
Example: Using the hash.update() and hash.digest() methods:
\n
const crypto = require('crypto');\nconst hash = crypto.createHash('sha256');\n\nhash.update('some data to hash');\nconsole.log(hash.digest('hex'));\n  // Prints:\n  //   6a2da20943931e9834fc12cfe5bb47bbd9ae43489a30726962b576f4e3993e50\n
\n",
          "methods": [
            {
              "textRaw": "hash.digest([encoding])",
              "type": "method",
              "name": "digest",
              "meta": {
                "added": [
                  "v0.1.92"
                ]
              },
              "desc": "
Calculates the digest of all of the data passed to be hashed (using the\nhash.update() method). The encoding can be 'hex', 'binary' or\n'base64'. If encoding is provided a string will be returned; otherwise\na Buffer is returned.
\n
The Hash object can not be used again after hash.digest() method has been\ncalled. Multiple calls will cause an error to be thrown.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "hash.update(data[, input_encoding])",
              "type": "method",
              "name": "update",
              "meta": {
                "added": [
                  "v0.1.92"
                ]
              },
              "desc": "
Updates the hash content with the given data, the encoding of which\nis given in input_encoding and can be 'utf8', 'ascii' or\n'binary'. If encoding is not provided, and the data is a string, an\nencoding of 'binary' is enforced. If data is a Buffer then\ninput_encoding is ignored.
\n
This can be called many times with new data as it is streamed.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "data"
                    },
                    {
                      "name": "input_encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "textRaw": "Class: Hmac",
          "type": "class",
          "name": "Hmac",
          "meta": {
            "added": [
              "v0.1.94"
            ]
          },
          "desc": "
The Hmac Class is a utility for creating cryptographic HMAC digests. It can\nbe used in one of two ways:
\n
    \n
  • As a stream that is both readable and writable, where data is written\nto produce a computed HMAC digest on the readable side, or
    • \n
  • Using the hmac.update() and hmac.digest() methods to produce the\ncomputed HMAC digest.
    • \n
\n
The crypto.createHmac() method is used to create Hmac instances. Hmac\nobjects are not to be created directly using the new keyword.
\n
Example: Using Hmac objects as streams:
\n
const crypto = require('crypto');\nconst hmac = crypto.createHmac('sha256', 'a secret');\n\nhmac.on('readable', () => {\n  var data = hmac.read();\n  if (data)\n    console.log(data.toString('hex'));\n    // Prints:\n    //   7fd04df92f636fd450bc841c9418e5825c17f33ad9c87c518115a45971f7f77e\n});\n\nhmac.write('some data to hash');\nhmac.end();\n
\n
Example: Using Hmac and piped streams:
\n
const crypto = require('crypto');\nconst fs = require('fs');\nconst hmac = crypto.createHmac('sha256', 'a secret');\n\nconst input = fs.createReadStream('test.js');\ninput.pipe(hmac).pipe(process.stdout);\n
\n
Example: Using the hmac.update() and hmac.digest() methods:
\n
const crypto = require('crypto');\nconst hmac = crypto.createHmac('sha256', 'a secret');\n\nhmac.update('some data to hash');\nconsole.log(hmac.digest('hex'));\n  // Prints:\n  //   7fd04df92f636fd450bc841c9418e5825c17f33ad9c87c518115a45971f7f77e\n
\n",
          "methods": [
            {
              "textRaw": "hmac.digest([encoding])",
              "type": "method",
              "name": "digest",
              "meta": {
                "added": [
                  "v0.1.94"
                ]
              },
              "desc": "
Calculates the HMAC digest of all of the data passed using hmac.update().\nThe encoding can be 'hex', 'binary' or 'base64'. If encoding is\nprovided a string is returned; otherwise a Buffer is returned;
\n
The Hmac object can not be used again after hmac.digest() has been\ncalled. Multiple calls to hmac.digest() will result in an error being thrown.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "hmac.update(data[, input_encoding])",
              "type": "method",
              "name": "update",
              "meta": {
                "added": [
                  "v0.1.94"
                ]
              },
              "desc": "
Updates the Hmac content with the given data, the encoding of which\nis given in input_encoding and can be 'utf8', 'ascii' or\n'binary'. If encoding is not provided, and the data is a string, an\nencoding of 'utf8' is enforced. If data is a Buffer then\ninput_encoding is ignored.
\n
This can be called many times with new data as it is streamed.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "data"
                    },
                    {
                      "name": "input_encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "textRaw": "Class: Sign",
          "type": "class",
          "name": "Sign",
          "meta": {
            "added": [
              "v0.1.92"
            ]
          },
          "desc": "
The Sign Class is a utility for generating signatures. It can be used in one\nof two ways:
\n
    \n
  • As a writable stream, where data to be signed is written and the\nsign.sign() method is used to generate and return the signature, or
    • \n
  • Using the sign.update() and sign.sign() methods to produce the\nsignature.
    • \n
\n
The crypto.createSign() method is used to create Sign instances. Sign\nobjects are not to be created directly using the new keyword.
\n
Example: Using Sign objects as streams:
\n
const crypto = require('crypto');\nconst sign = crypto.createSign('RSA-SHA256');\n\nsign.write('some data to sign');\nsign.end();\n\nconst private_key = getPrivateKeySomehow();\nconsole.log(sign.sign(private_key, 'hex'));\n  // Prints the calculated signature\n
\n
Example: Using the sign.update() and sign.sign() methods:
\n
const crypto = require('crypto');\nconst sign = crypto.createSign('RSA-SHA256');\n\nsign.update('some data to sign');\n\nconst private_key = getPrivateKeySomehow();\nconsole.log(sign.sign(private_key, 'hex'));\n  // Prints the calculated signature\n
\n
A Sign instance can also be created by just passing in the digest\nalgorithm name, in which case OpenSSL will infer the full signature algorithm\nfrom the type of the PEM-formatted private key, including algorithms that\ndo not have directly exposed name constants, e.g. 'ecdsa-with-SHA256'.
\n
Example: signing using ECDSA with SHA256
\n
const crypto = require('crypto');\nconst sign = crypto.createSign('sha256');\n\nsign.update('some data to sign');\n\nconst private_key = '-----BEGIN EC PRIVATE KEY-----\\n' +\n        'MHcCAQEEIF+jnWY1D5kbVYDNvxxo/Y+ku2uJPDwS0r/VuPZQrjjVoAoGCCqGSM49\\n' +\n        'AwEHoUQDQgAEurOxfSxmqIRYzJVagdZfMMSjRNNhB8i3mXyIMq704m2m52FdfKZ2\\n' +\n        'pQhByd5eyj3lgZ7m7jbchtdgyOF8Io/1ng==\\n' +\n        '-----END EC PRIVATE KEY-----\\n';\n\nconsole.log(sign.sign(private_key).toString('hex'));\n
\n",
          "methods": [
            {
              "textRaw": "sign.sign(private_key[, output_format])",
              "type": "method",
              "name": "sign",
              "meta": {
                "added": [
                  "v0.1.92"
                ]
              },
              "desc": "
Calculates the signature on all the data passed through using either\nsign.update() or sign.write().
\n
The private_key argument can be an object or a string. If private_key is a\nstring, it is treated as a raw key with no passphrase. If private_key is an\nobject, it is interpreted as a hash containing two properties:
\n
    \n
  • key : {String} - PEM encoded private key
    • \n
  • passphrase : {String} - passphrase for the private key
    • \n
\n
The output_format can specify one of 'binary', 'hex' or 'base64'. If\noutput_format is provided a string is returned; otherwise a Buffer is\nreturned.
\n
The Sign object can not be again used after sign.sign() method has been\ncalled. Multiple calls to sign.sign() will result in an error being thrown.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "private_key"
                    },
                    {
                      "name": "output_format",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "sign.update(data[, input_encoding])",
              "type": "method",
              "name": "update",
              "meta": {
                "added": [
                  "v0.1.92"
                ]
              },
              "desc": "
Updates the Sign content with the given data, the encoding of which\nis given in input_encoding and can be 'utf8', 'ascii' or\n'binary'. If encoding is not provided, and the data is a string, an\nencoding of 'utf8' is enforced. If data is a Buffer then\ninput_encoding is ignored.
\n
This can be called many times with new data as it is streamed.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "data"
                    },
                    {
                      "name": "input_encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "textRaw": "Class: Verify",
          "type": "class",
          "name": "Verify",
          "meta": {
            "added": [
              "v0.1.92"
            ]
          },
          "desc": "
The Verify class is a utility for verifying signatures. It can be used in one\nof two ways:
\n
    \n
  • As a writable stream where written data is used to validate against the\nsupplied signature, or
    • \n
  • Using the verify.update() and verify.verify() methods to verify\nthe signature.
    • \n
\n
The [crypto.createVerify()][] method is used to create Verify instances.\nVerify objects are not to be created directly using the new keyword.
\n
Example: Using Verify objects as streams:
\n
const crypto = require('crypto');\nconst verify = crypto.createVerify('RSA-SHA256');\n\nverify.write('some data to sign');\nverify.end();\n\nconst public_key = getPublicKeySomehow();\nconst signature = getSignatureToVerify();\nconsole.log(verify.verify(public_key, signature));\n  // Prints true or false\n
\n
Example: Using the verify.update() and verify.verify() methods:
\n
const crypto = require('crypto');\nconst verify = crypto.createVerify('RSA-SHA256');\n\nverify.update('some data to sign');\n\nconst public_key = getPublicKeySomehow();\nconst signature = getSignatureToVerify();\nconsole.log(verify.verify(public_key, signature));\n  // Prints true or false\n
\n",
          "methods": [
            {
              "textRaw": "verifier.update(data[, input_encoding])",
              "type": "method",
              "name": "update",
              "meta": {
                "added": [
                  "v0.1.92"
                ]
              },
              "desc": "
Updates the Verify content with the given data, the encoding of which\nis given in input_encoding and can be 'utf8', 'ascii' or\n'binary'. If encoding is not provided, and the data is a string, an\nencoding of 'utf8' is enforced. If data is a Buffer then\ninput_encoding is ignored.
\n
This can be called many times with new data as it is streamed.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "data"
                    },
                    {
                      "name": "input_encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "verifier.verify(object, signature[, signature_format])",
              "type": "method",
              "name": "verify",
              "meta": {
                "added": [
                  "v0.1.92"
                ]
              },
              "desc": "
Verifies the provided data using the given object and signature.\nThe object argument is a string containing a PEM encoded object, which can be\none an RSA public key, a DSA public key, or an X.509 certificate.\nThe signature argument is the previously calculated signature for the data, in\nthe signature_format which can be 'binary', 'hex' or 'base64'.\nIf a signature_format is specified, the signature is expected to be a\nstring; otherwise signature is expected to be a Buffer.
\n
Returns true or false depending on the validity of the signature for\nthe data and public key.
\n
The verifier object can not be used again after verify.verify() has been\ncalled. Multiple calls to verify.verify() will result in an error being\nthrown.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "object"
                    },
                    {
                      "name": "signature"
                    },
                    {
                      "name": "signature_format",
                      "optional": true
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "modules": [
        {
          "textRaw": "`crypto` module methods and properties",
          "name": "`crypto`_module_methods_and_properties",
          "properties": [
            {
              "textRaw": "crypto.DEFAULT_ENCODING",
              "name": "DEFAULT_ENCODING",
              "meta": {
                "added": [
                  "v0.9.3"
                ]
              },
              "desc": "
The default encoding to use for functions that can take either strings\nor buffers. The default value is 'buffer', which makes methods\ndefault to Buffer objects.
\n
The crypto.DEFAULT_ENCODING mechanism is provided for backwards compatibility\nwith legacy programs that expect 'binary' to be the default encoding.
\n
New applications should expect the default to be 'buffer'. This property may\nbecome deprecated in a future Node.js release.
\n"
            }
          ],
          "methods": [
            {
              "textRaw": "crypto.createCipher(algorithm, password)",
              "type": "method",
              "name": "createCipher",
              "meta": {
                "added": [
                  "v0.1.94"
                ]
              },
              "desc": "
Creates and returns a Cipher object that uses the given algorithm and\npassword.
\n
The algorithm is dependent on OpenSSL, examples are 'aes192', etc. On\nrecent OpenSSL releases, openssl list-cipher-algorithms will display the\navailable cipher algorithms.
\n
The password is used to derive the cipher key and initialization vector (IV).\nThe value must be either a 'binary' encoded string or a Buffer.
\n
The implementation of crypto.createCipher() derives keys using the OpenSSL\nfunction EVP_BytesToKey with the digest algorithm set to MD5, one\niteration, and no salt. The lack of salt allows dictionary attacks as the same\npassword always creates the same key. The low iteration count and\nnon-cryptographically secure hash algorithm allow passwords to be tested very\nrapidly.
\n
In line with OpenSSL's recommendation to use pbkdf2 instead of\nEVP_BytesToKey it is recommended that developers derive a key and IV on\ntheir own using crypto.pbkdf2() and to use crypto.createCipheriv()\nto create the Cipher object.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "algorithm"
                    },
                    {
                      "name": "password"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.createCipheriv(algorithm, key, iv)",
              "type": "method",
              "name": "createCipheriv",
              "desc": "
Creates and returns a Cipher object, with the given algorithm, key and\ninitialization vector (iv).
\n
The algorithm is dependent on OpenSSL, examples are 'aes192', etc. On\nrecent OpenSSL releases, openssl list-cipher-algorithms will display the\navailable cipher algorithms.
\n
The key is the raw key used by the algorithm and iv is an\ninitialization vector. Both arguments must be 'binary' encoded strings or\nbuffers.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "algorithm"
                    },
                    {
                      "name": "key"
                    },
                    {
                      "name": "iv"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.createCredentials(details)",
              "type": "method",
              "name": "createCredentials",
              "meta": {
                "added": [
                  "v0.1.92"
                ],
                "deprecated": [
                  "v0.11.13"
                ]
              },
              "stability": 0,
              "stabilityText": "Deprecated: Use [`tls.createSecureContext()`][] instead.",
              "desc": "
The crypto.createCredentials() method is a deprecated alias for creating\nand returning a tls.SecureContext object. The crypto.createCredentials()\nmethod should not be used.
\n
The optional details argument is a hash object with keys:
\n
    \n
  • pfx : {String|Buffer} - PFX or PKCS12 encoded private\nkey, certificate and CA certificates
    • \n
  • key : {String} - PEM encoded private key
    • \n
  • passphrase : {String} - passphrase for the private key or PFX
    • \n
  • cert : {String} - PEM encoded certificate
    • \n
  • ca : {String|Array} - Either a string or array of strings of PEM encoded CA\ncertificates to trust.
    • \n
  • crl : {String|Array} - Either a string or array of strings of PEM encoded CRLs\n(Certificate Revocation List)
    • \n
  • ciphers: {String} using the OpenSSL cipher list format describing the\ncipher algorithms to use or exclude.
    • \n
\n
If no 'ca' details are given, Node.js will use Mozilla's default\npublicly trusted list of CAs.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "details"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.createDecipher(algorithm, password)",
              "type": "method",
              "name": "createDecipher",
              "meta": {
                "added": [
                  "v0.1.94"
                ]
              },
              "desc": "
Creates and returns a Decipher object that uses the given algorithm and\npassword (key).
\n
The implementation of crypto.createDecipher() derives keys using the OpenSSL\nfunction EVP_BytesToKey with the digest algorithm set to MD5, one\niteration, and no salt. The lack of salt allows dictionary attacks as the same\npassword always creates the same key. The low iteration count and\nnon-cryptographically secure hash algorithm allow passwords to be tested very\nrapidly.
\n
In line with OpenSSL's recommendation to use pbkdf2 instead of\nEVP_BytesToKey it is recommended that developers derive a key and IV on\ntheir own using crypto.pbkdf2() and to use crypto.createDecipheriv()\nto create the Decipher object.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "algorithm"
                    },
                    {
                      "name": "password"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.createDecipheriv(algorithm, key, iv)",
              "type": "method",
              "name": "createDecipheriv",
              "meta": {
                "added": [
                  "v0.1.94"
                ]
              },
              "desc": "
Creates and returns a Decipher object that uses the given algorithm, key\nand initialization vector (iv).
\n
The algorithm is dependent on OpenSSL, examples are 'aes192', etc. On\nrecent OpenSSL releases, openssl list-cipher-algorithms will display the\navailable cipher algorithms.
\n
The key is the raw key used by the algorithm and iv is an\ninitialization vector. Both arguments must be 'binary' encoded strings or\nbuffers.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "algorithm"
                    },
                    {
                      "name": "key"
                    },
                    {
                      "name": "iv"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.createDiffieHellman(prime[, prime_encoding][, generator][, generator_encoding])",
              "type": "method",
              "name": "createDiffieHellman",
              "meta": {
                "added": [
                  "v0.11.12"
                ]
              },
              "desc": "
Creates a DiffieHellman key exchange object using the supplied prime and an\noptional specific generator.
\n
The generator argument can be a number, string, or Buffer. If\ngenerator is not specified, the value 2 is used.
\n
The prime_encoding and generator_encoding arguments can be 'binary',\n'hex', or 'base64'.
\n
If prime_encoding is specified, prime is expected to be a string; otherwise\na Buffer is expected.
\n
If generator_encoding is specified, generator is expected to be a string;\notherwise either a number or Buffer is expected.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "prime"
                    },
                    {
                      "name": "prime_encoding",
                      "optional": true
                    },
                    {
                      "name": "generator",
                      "optional": true
                    },
                    {
                      "name": "generator_encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.createDiffieHellman(prime_length[, generator])",
              "type": "method",
              "name": "createDiffieHellman",
              "meta": {
                "added": [
                  "v0.5.0"
                ]
              },
              "desc": "
Creates a DiffieHellman key exchange object and generates a prime of\nprime_length bits using an optional specific numeric generator.\nIf generator is not specified, the value 2 is used.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "prime_length"
                    },
                    {
                      "name": "generator",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.createECDH(curve_name)",
              "type": "method",
              "name": "createECDH",
              "meta": {
                "added": [
                  "v0.11.14"
                ]
              },
              "desc": "
Creates an Elliptic Curve Diffie-Hellman (ECDH) key exchange object using a\npredefined curve specified by the curve_name string. Use\ncrypto.getCurves() to obtain a list of available curve names. On recent\nOpenSSL releases, openssl ecparam -list_curves will also display the name\nand description of each available elliptic curve.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "curve_name"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.createHash(algorithm)",
              "type": "method",
              "name": "createHash",
              "meta": {
                "added": [
                  "v0.1.92"
                ]
              },
              "desc": "
Creates and returns a Hash object that can be used to generate hash digests\nusing the given algorithm.
\n
The algorithm is dependent on the available algorithms supported by the\nversion of OpenSSL on the platform. Examples are 'sha256', 'sha512', etc.\nOn recent releases of OpenSSL, openssl list-message-digest-algorithms will\ndisplay the available digest algorithms.
\n
Example: generating the sha256 sum of a file
\n
const filename = process.argv[2];\nconst crypto = require('crypto');\nconst fs = require('fs');\n\nconst hash = crypto.createHash('sha256');\n\nconst input = fs.createReadStream(filename);\ninput.on('readable', () => {\n  var data = input.read();\n  if (data)\n    hash.update(data);\n  else {\n    console.log(`${hash.digest('hex')} ${filename}`);\n  }\n});\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "algorithm"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.createHmac(algorithm, key)",
              "type": "method",
              "name": "createHmac",
              "meta": {
                "added": [
                  "v0.1.94"
                ]
              },
              "desc": "
Creates and returns an Hmac object that uses the given algorithm and key.
\n
The algorithm is dependent on the available algorithms supported by the\nversion of OpenSSL on the platform. Examples are 'sha256', 'sha512', etc.\nOn recent releases of OpenSSL, openssl list-message-digest-algorithms will\ndisplay the available digest algorithms.
\n
The key is the HMAC key used to generate the cryptographic HMAC hash.
\n
Example: generating the sha256 HMAC of a file
\n
const filename = process.argv[2];\nconst crypto = require('crypto');\nconst fs = require('fs');\n\nconst hmac = crypto.createHmac('sha256', 'a secret');\n\nconst input = fs.createReadStream(filename);\ninput.on('readable', () => {\n  var data = input.read();\n  if (data)\n    hmac.update(data);\n  else {\n    console.log(`${hmac.digest('hex')} ${filename}`);\n  }\n});\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "algorithm"
                    },
                    {
                      "name": "key"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.createSign(algorithm)",
              "type": "method",
              "name": "createSign",
              "meta": {
                "added": [
                  "v0.1.92"
                ]
              },
              "desc": "
Creates and returns a Sign object that uses the given algorithm.\nUse crypto.getHashes() to obtain an array of names of the available\nsigning algorithms.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "algorithm"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.createVerify(algorithm)",
              "type": "method",
              "name": "createVerify",
              "meta": {
                "added": [
                  "v0.1.92"
                ]
              },
              "desc": "
Creates and returns a Verify object that uses the given algorithm.\nUse crypto.getHashes() to obtain an array of names of the available\nsigning algorithms.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "algorithm"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.getCiphers()",
              "type": "method",
              "name": "getCiphers",
              "meta": {
                "added": [
                  "v0.9.3"
                ]
              },
              "desc": "
Returns an array with the names of the supported cipher algorithms.
\n
Example:
\n
const ciphers = crypto.getCiphers();\nconsole.log(ciphers); // ['aes-128-cbc', 'aes-128-ccm', ...]\n
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "crypto.getCurves()",
              "type": "method",
              "name": "getCurves",
              "meta": {
                "added": [
                  "v2.3.0"
                ]
              },
              "desc": "
Returns an array with the names of the supported elliptic curves.
\n
Example:
\n
const curves = crypto.getCurves();\nconsole.log(curves); // ['secp256k1', 'secp384r1', ...]\n
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "crypto.getDiffieHellman(group_name)",
              "type": "method",
              "name": "getDiffieHellman",
              "meta": {
                "added": [
                  "v0.7.5"
                ]
              },
              "desc": "
Creates a predefined DiffieHellman key exchange object. The\nsupported groups are: 'modp1', 'modp2', 'modp5' (defined in\nRFC 2412, but see Caveats) and 'modp14', 'modp15',\n'modp16', 'modp17', 'modp18' (defined in RFC 3526). The\nreturned object mimics the interface of objects created by\ncrypto.createDiffieHellman(), but will not allow changing\nthe keys (with diffieHellman.setPublicKey() for example). The\nadvantage of using this method is that the parties do not have to\ngenerate nor exchange a group modulus beforehand, saving both processor\nand communication time.
\n
Example (obtaining a shared secret):
\n
const crypto = require('crypto');\nconst alice = crypto.getDiffieHellman('modp14');\nconst bob = crypto.getDiffieHellman('modp14');\n\nalice.generateKeys();\nbob.generateKeys();\n\nconst alice_secret = alice.computeSecret(bob.getPublicKey(), null, 'hex');\nconst bob_secret = bob.computeSecret(alice.getPublicKey(), null, 'hex');\n\n/* alice_secret and bob_secret should be the same */\nconsole.log(alice_secret == bob_secret);\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "group_name"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.getHashes()",
              "type": "method",
              "name": "getHashes",
              "meta": {
                "added": [
                  "v0.9.3"
                ]
              },
              "desc": "
Returns an array of the names of the supported hash algorithms,\nsuch as RSA-SHA256.
\n
Example:
\n
const hashes = crypto.getHashes();\nconsole.log(hashes); // ['sha', 'sha1', 'sha1WithRSAEncryption', ...]\n
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "crypto.pbkdf2(password, salt, iterations, keylen[, digest], callback)",
              "type": "method",
              "name": "pbkdf2",
              "meta": {
                "added": [
                  "v0.5.5"
                ]
              },
              "desc": "
Provides an asynchronous Password-Based Key Derivation Function 2 (PBKDF2)\nimplementation. A selected HMAC digest algorithm specified by digest is\napplied to derive a key of the requested byte length (keylen) from the\npassword, salt and iterations. If the digest algorithm is not specified,\na default of 'sha1' is used.
\n
The supplied callback function is called with two arguments: err and\nderivedKey. If an error occurs, err will be set; otherwise err will be\nnull. The successfully generated derivedKey will be passed as a Buffer.
\n
The iterations argument must be a number set as high as possible. The\nhigher the number of iterations, the more secure the derived key will be,\nbut will take a longer amount of time to complete.
\n
The salt should also be as unique as possible. It is recommended that the\nsalts are random and their lengths are greater than 16 bytes. See\nNIST SP 800-132 for details.
\n
Example:
\n
const crypto = require('crypto');\ncrypto.pbkdf2('secret', 'salt', 100000, 512, 'sha512', (err, key) => {\n  if (err) throw err;\n  console.log(key.toString('hex'));  // 'c5e478d...1469e50'\n});\n
\n
An array of supported digest functions can be retrieved using\ncrypto.getHashes().
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "password"
                    },
                    {
                      "name": "salt"
                    },
                    {
                      "name": "iterations"
                    },
                    {
                      "name": "keylen"
                    },
                    {
                      "name": "digest",
                      "optional": true
                    },
                    {
                      "name": "callback"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.pbkdf2Sync(password, salt, iterations, keylen[, digest])",
              "type": "method",
              "name": "pbkdf2Sync",
              "meta": {
                "added": [
                  "v0.9.3"
                ]
              },
              "desc": "
Provides a synchronous Password-Based Key Derivation Function 2 (PBKDF2)\nimplementation. A selected HMAC digest algorithm specified by digest is\napplied to derive a key of the requested byte length (keylen) from the\npassword, salt and iterations. If the digest algorithm is not specified,\na default of 'sha1' is used.
\n
If an error occurs an Error will be thrown, otherwise the derived key will be\nreturned as a Buffer.
\n
The iterations argument must be a number set as high as possible. The\nhigher the number of iterations, the more secure the derived key will be,\nbut will take a longer amount of time to complete.
\n
The salt should also be as unique as possible. It is recommended that the\nsalts are random and their lengths are greater than 16 bytes. See\nNIST SP 800-132 for details.
\n
Example:
\n
const crypto = require('crypto');\nconst key = crypto.pbkdf2Sync('secret', 'salt', 100000, 512, 'sha512');\nconsole.log(key.toString('hex'));  // 'c5e478d...1469e50'\n
\n
An array of supported digest functions can be retrieved using\ncrypto.getHashes().
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "password"
                    },
                    {
                      "name": "salt"
                    },
                    {
                      "name": "iterations"
                    },
                    {
                      "name": "keylen"
                    },
                    {
                      "name": "digest",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.privateDecrypt(private_key, buffer)",
              "type": "method",
              "name": "privateDecrypt",
              "meta": {
                "added": [
                  "v0.11.14"
                ]
              },
              "desc": "
Decrypts buffer with private_key.
\n
private_key can be an object or a string. If private_key is a string, it is\ntreated as the key with no passphrase and will use RSA_PKCS1_OAEP_PADDING.\nIf private_key is an object, it is interpreted as a hash object with the\nkeys:
\n
    \n
  • key : {String} - PEM encoded private key
    • \n
  • passphrase : {String} - Optional passphrase for the private key
    • \n
  • padding : An optional padding value, one of the following:
      \n
    • constants.RSA_NO_PADDING
      • \n
    • constants.RSA_PKCS1_PADDING
      • \n
    • constants.RSA_PKCS1_OAEP_PADDING
      • \n
    \n
    • \n
\n
All paddings are defined in the constants module.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "private_key"
                    },
                    {
                      "name": "buffer"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.privateEncrypt(private_key, buffer)",
              "type": "method",
              "name": "privateEncrypt",
              "meta": {
                "added": [
                  "v1.1.0"
                ]
              },
              "desc": "
Encrypts buffer with private_key.
\n
private_key can be an object or a string. If private_key is a string, it is\ntreated as the key with no passphrase and will use RSA_PKCS1_PADDING.\nIf private_key is an object, it is interpreted as a hash object with the\nkeys:
\n
    \n
  • key : {String} - PEM encoded private key
    • \n
  • passphrase : {String} - Optional passphrase for the private key
    • \n
  • padding : An optional padding value, one of the following:
      \n
    • constants.RSA_NO_PADDING
      • \n
    • constants.RSA_PKCS1_PADDING
      • \n
    \n
    • \n
\n
All paddings are defined in the constants module.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "private_key"
                    },
                    {
                      "name": "buffer"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.publicDecrypt(public_key, buffer)",
              "type": "method",
              "name": "publicDecrypt",
              "meta": {
                "added": [
                  "v1.1.0"
                ]
              },
              "desc": "
Decrypts buffer with public_key.
\n
public_key can be an object or a string. If public_key is a string, it is\ntreated as the key with no passphrase and will use RSA_PKCS1_PADDING.\nIf public_key is an object, it is interpreted as a hash object with the\nkeys:
\n
    \n
  • key : {String} - PEM encoded public key
    • \n
  • passphrase : {String} - Optional passphrase for the private key
    • \n
  • padding : An optional padding value, one of the following:
      \n
    • constants.RSA_NO_PADDING
      • \n
    • constants.RSA_PKCS1_PADDING
      • \n
    • constants.RSA_PKCS1_OAEP_PADDING
      • \n
    \n
    • \n
\n
Because RSA public keys can be derived from private keys, a private key may\nbe passed instead of a public key.
\n
All paddings are defined in the constants module.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "public_key"
                    },
                    {
                      "name": "buffer"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.publicEncrypt(public_key, buffer)",
              "type": "method",
              "name": "publicEncrypt",
              "meta": {
                "added": [
                  "v0.11.14"
                ]
              },
              "desc": "
Encrypts buffer with public_key.
\n
public_key can be an object or a string. If public_key is a string, it is\ntreated as the key with no passphrase and will use RSA_PKCS1_OAEP_PADDING.\nIf public_key is an object, it is interpreted as a hash object with the\nkeys:
\n
    \n
  • key : {String} - PEM encoded public key
    • \n
  • passphrase : {String} - Optional passphrase for the private key
    • \n
  • padding : An optional padding value, one of the following:
      \n
    • constants.RSA_NO_PADDING
      • \n
    • constants.RSA_PKCS1_PADDING
      • \n
    • constants.RSA_PKCS1_OAEP_PADDING
      • \n
    \n
    • \n
\n
Because RSA public keys can be derived from private keys, a private key may\nbe passed instead of a public key.
\n
All paddings are defined in the constants module.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "public_key"
                    },
                    {
                      "name": "buffer"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.randomBytes(size[, callback])",
              "type": "method",
              "name": "randomBytes",
              "meta": {
                "added": [
                  "v0.5.8"
                ]
              },
              "desc": "
Generates cryptographically strong pseudo-random data. The size argument\nis a number indicating the number of bytes to generate.
\n
If a callback function is provided, the bytes are generated asynchronously\nand the callback function is invoked with two arguments: err and buf.\nIf an error occurs, err will be an Error object; otherwise it is null. The\nbuf argument is a Buffer containing the generated bytes.
\n
// Asynchronous\nconst crypto = require('crypto');\ncrypto.randomBytes(256, (err, buf) => {\n  if (err) throw err;\n  console.log(`${buf.length} bytes of random data: ${buf.toString('hex')}`);\n});\n
\n
If the callback function is not provided, the random bytes are generated\nsynchronously and returned as a Buffer. An error will be thrown if\nthere is a problem generating the bytes.
\n
// Synchronous\nconst buf = crypto.randomBytes(256);\nconsole.log(\n  `${buf.length} bytes of random data: ${buf.toString('hex')}`);\n
\n
The crypto.randomBytes() method will block until there is sufficient entropy.\nThis should normally never take longer than a few milliseconds. The only time\nwhen generating the random bytes may conceivably block for a longer period of\ntime is right after boot, when the whole system is still low on entropy.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "size"
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "crypto.setEngine(engine[, flags])",
              "type": "method",
              "name": "setEngine",
              "meta": {
                "added": [
                  "v0.11.11"
                ]
              },
              "desc": "
Load and set the engine for some or all OpenSSL functions (selected by flags).
\n
engine could be either an id or a path to the engine's shared library.
\n
The optional flags argument uses ENGINE_METHOD_ALL by default. The flags\nis a bit field taking one of or a mix of the following flags (defined in the\nconstants module):
\n
    \n
  • ENGINE_METHOD_RSA
    • \n
  • ENGINE_METHOD_DSA
    • \n
  • ENGINE_METHOD_DH
    • \n
  • ENGINE_METHOD_RAND
    • \n
  • ENGINE_METHOD_ECDH
    • \n
  • ENGINE_METHOD_ECDSA
    • \n
  • ENGINE_METHOD_CIPHERS
    • \n
  • ENGINE_METHOD_DIGESTS
    • \n
  • ENGINE_METHOD_STORE
    • \n
  • ENGINE_METHOD_PKEY_METH
    • \n
  • ENGINE_METHOD_PKEY_ASN1_METH
    • \n
  • ENGINE_METHOD_ALL
    • \n
  • ENGINE_METHOD_NONE
    • \n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "engine"
                    },
                    {
                      "name": "flags",
                      "optional": true
                    }
                  ]
                }
              ]
            }
          ],
          "type": "module",
          "displayName": "`crypto` module methods and properties"
        },
        {
          "textRaw": "Notes",
          "name": "notes",
          "modules": [
            {
              "textRaw": "Legacy Streams API (pre Node.js v0.10)",
              "name": "legacy_streams_api_(pre_node.js_v0.10)",
              "desc": "
The Crypto module was added to Node.js before there was the concept of a\nunified Stream API, and before there were Buffer objects for handling\nbinary data. As such, the many of the crypto defined classes have methods not\ntypically found on other Node.js classes that implement the streams\nAPI (e.g. update(), final(), or digest()). Also, many methods accepted\nand returned 'binary' encoded strings by default rather than Buffers. This\ndefault was changed after Node.js v0.8 to use Buffer objects by default\ninstead.
\n",
              "type": "module",
              "displayName": "Legacy Streams API (pre Node.js v0.10)"
            },
            {
              "textRaw": "Recent ECDH Changes",
              "name": "recent_ecdh_changes",
              "desc": "
Usage of ECDH with non-dynamically generated key pairs has been simplified.\nNow, ecdh.setPrivateKey() can be called with a preselected private key\nand the associated public point (key) will be computed and stored in the object.\nThis allows code to only store and provide the private part of the EC key pair.\necdh.setPrivateKey() now also validates that the private key is valid for\nthe selected curve.
\n
The ecdh.setPublicKey() method is now deprecated as its inclusion in the\nAPI is not useful. Either a previously stored private key should be set, which\nautomatically generates the associated public key, or ecdh.generateKeys()\nshould be called. The main drawback of using ecdh.setPublicKey() is that\nit can be used to put the ECDH key pair into an inconsistent state.
\n",
              "type": "module",
              "displayName": "Recent ECDH Changes"
            },
            {
              "textRaw": "Support for weak or compromised algorithms",
              "name": "support_for_weak_or_compromised_algorithms",
              "desc": "
The crypto module still supports some algorithms which are already\ncompromised and are not currently recommended for use. The API also allows\nthe use of ciphers and hashes with a small key size that are considered to be\ntoo weak for safe use.
\n
Users should take full responsibility for selecting the crypto\nalgorithm and key size according to their security requirements.
\n
Based on the recommendations of NIST SP 800-131A:
\n
    \n
  • MD5 and SHA-1 are no longer acceptable where collision resistance is\nrequired such as digital signatures.
    • \n
  • The key used with RSA, DSA and DH algorithms is recommended to have\nat least 2048 bits and that of the curve of ECDSA and ECDH at least\n224 bits, to be safe to use for several years.
    • \n
  • The DH groups of modp1, modp2 and modp5 have a key size\nsmaller than 2048 bits and are not recommended.
    • \n
\n
See the reference for other recommendations and details.
\n",
              "type": "module",
              "displayName": "Support for weak or compromised algorithms"
            }
          ],
          "type": "module",
          "displayName": "Notes"
        }
      ],
      "type": "module",
      "displayName": "Crypto"
    }
  ]
}
node-v4.8.2/doc/api/crypto.md000644 000766 000024 00000150625 13070706735 016151 0ustar00iojsstaff000000 000000 # Crypto

> Stability: 2 - Stable

The `crypto` module provides cryptographic functionality that includes a set of
wrappers for OpenSSL's hash, HMAC, cipher, decipher, sign and verify functions.

Use `require('crypto')` to access this module.

```js
const crypto = require('crypto');

const secret = 'abcdefg';
const hash = crypto.createHmac('sha256', secret)
                   .update('I love cupcakes')
                   .digest('hex');
console.log(hash);
  // Prints:
  //   c0fa1bc00531bd78ef38c628449c5102aeabd49b5dc3a2a516ea6ea959d6658e
```

## Class: Certificate


SPKAC is a Certificate Signing Request mechanism originally implemented by
Netscape and now specified formally as part of [HTML5's `keygen` element][].

The `crypto` module provides the `Certificate` class for working with SPKAC
data. The most common usage is handling output generated by the HTML5
`` element. Node.js uses [OpenSSL's SPKAC implementation][] internally.

### new crypto.Certificate()

Instances of the `Certificate` class can be created using the `new` keyword
or by calling `crypto.Certificate()` as a function:

```js
const crypto = require('crypto');

const cert1 = new crypto.Certificate();
const cert2 = crypto.Certificate();
```

### certificate.exportChallenge(spkac)


The `spkac` data structure includes a public key and a challenge. The
`certificate.exportChallenge()` returns the challenge component in the
form of a Node.js [`Buffer`][]. The `spkac` argument can be either a string
or a [`Buffer`][].

```js
const cert = require('crypto').Certificate();
const spkac = getSpkacSomehow();
const challenge = cert.exportChallenge(spkac);
console.log(challenge.toString('utf8'));
  // Prints the challenge as a UTF8 string
```

### certificate.exportPublicKey(spkac)


The `spkac` data structure includes a public key and a challenge. The
`certificate.exportPublicKey()` returns the public key component in the
form of a Node.js [`Buffer`][]. The `spkac` argument can be either a string
or a [`Buffer`][].

```js
const cert = require('crypto').Certificate();
const spkac = getSpkacSomehow();
const publicKey = cert.exportPublicKey(spkac);
console.log(publicKey);
  // Prints the public key as 
```

### certificate.verifySpkac(spkac)


Returns `true` if the given `spkac` data structure is valid, `false` otherwise.
The `spkac` argument must be a Node.js [`Buffer`][].

```js
const cert = require('crypto').Certificate();
const spkac = getSpkacSomehow();
console.log(cert.verifySpkac(new Buffer(spkac)));
  // Prints true or false
```

## Class: Cipher


Instances of the `Cipher` class are used to encrypt data. The class can be
used in one of two ways:

- As a [stream][] that is both readable and writable, where plain unencrypted
  data is written to produce encrypted data on the readable side, or
- Using the [`cipher.update()`][] and [`cipher.final()`][] methods to produce
  the encrypted data.

The [`crypto.createCipher()`][] or [`crypto.createCipheriv()`][] methods are
used to create `Cipher` instances. `Cipher` objects are not to be created
directly using the `new` keyword.

Example: Using `Cipher` objects as streams:

```js
const crypto = require('crypto');
const cipher = crypto.createCipher('aes192', 'a password');

var encrypted = '';
cipher.on('readable', () => {
  var data = cipher.read();
  if (data)
    encrypted += data.toString('hex');
});
cipher.on('end', () => {
  console.log(encrypted);
  // Prints: ca981be48e90867604588e75d04feabb63cc007a8f8ad89b10616ed84d815504
});

cipher.write('some clear text data');
cipher.end();
```

Example: Using `Cipher` and piped streams:

```js
const crypto = require('crypto');
const fs = require('fs');
const cipher = crypto.createCipher('aes192', 'a password');

const input = fs.createReadStream('test.js');
const output = fs.createWriteStream('test.enc');

input.pipe(cipher).pipe(output);
```

Example: Using the [`cipher.update()`][] and [`cipher.final()`][] methods:

```js
const crypto = require('crypto');
const cipher = crypto.createCipher('aes192', 'a password');

var encrypted = cipher.update('some clear text data', 'utf8', 'hex');
encrypted += cipher.final('hex');
console.log(encrypted);
  // Prints: ca981be48e90867604588e75d04feabb63cc007a8f8ad89b10616ed84d815504
```

### cipher.final([output_encoding])


Returns any remaining enciphered contents. If `output_encoding`
parameter is one of `'binary'`, `'base64'` or `'hex'`, a string is returned.
If an `output_encoding` is not provided, a [`Buffer`][] is returned.

Once the `cipher.final()` method has been called, the `Cipher` object can no
longer be used to encrypt data. Attempts to call `cipher.final()` more than
once will result in an error being thrown.

### cipher.setAAD(buffer)


When using an authenticated encryption mode (only `GCM` is currently
supported), the `cipher.setAAD()` method sets the value used for the
_additional authenticated data_ (AAD) input parameter.

### cipher.getAuthTag()


When using an authenticated encryption mode (only `GCM` is currently
supported), the `cipher.getAuthTag()` method returns a [`Buffer`][] containing
the _authentication tag_ that has been computed from the given data.

The `cipher.getAuthTag()` method should only be called after encryption has
been completed using the [`cipher.final()`][] method.

### cipher.setAutoPadding(auto_padding=true)


When using block encryption algorithms, the `Cipher` class will automatically
add padding to the input data to the appropriate block size. To disable the
default padding call `cipher.setAutoPadding(false)`.

When `auto_padding` is `false`, the length of the entire input data must be a
multiple of the cipher's block size or [`cipher.final()`][] will throw an Error.
Disabling automatic padding is useful for non-standard padding, for instance
using `0x0` instead of PKCS padding.

The `cipher.setAutoPadding()` method must be called before [`cipher.final()`][].

### cipher.update(data[, input_encoding][, output_encoding])


Updates the cipher with `data`. If the `input_encoding` argument is given,
it's value must be one of `'utf8'`, `'ascii'`, or `'binary'` and the `data`
argument is a string using the specified encoding. If the `input_encoding`
argument is not given, `data` must be a [`Buffer`][]. If `data` is a
[`Buffer`][] then `input_encoding` is ignored.

The `output_encoding` specifies the output format of the enciphered
data, and can be `'binary'`, `'base64'` or `'hex'`. If the `output_encoding`
is specified, a string using the specified encoding is returned. If no
`output_encoding` is provided, a [`Buffer`][] is returned.

The `cipher.update()` method can be called multiple times with new data until
[`cipher.final()`][] is called. Calling `cipher.update()` after
[`cipher.final()`][] will result in an error being thrown.

## Class: Decipher


Instances of the `Decipher` class are used to decrypt data. The class can be
used in one of two ways:

- As a [stream][] that is both readable and writable, where plain encrypted
  data is written to produce unencrypted data on the readable side, or
- Using the [`decipher.update()`][] and [`decipher.final()`][] methods to
  produce the unencrypted data.

The [`crypto.createDecipher()`][] or [`crypto.createDecipheriv()`][] methods are
used to create `Decipher` instances. `Decipher` objects are not to be created
directly using the `new` keyword.

Example: Using `Decipher` objects as streams:

```js
const crypto = require('crypto');
const decipher = crypto.createDecipher('aes192', 'a password');

var decrypted = '';
decipher.on('readable', () => {
  var data = decipher.read();
  if (data)
  decrypted += data.toString('utf8');
});
decipher.on('end', () => {
  console.log(decrypted);
  // Prints: some clear text data
});

var encrypted = 'ca981be48e90867604588e75d04feabb63cc007a8f8ad89b10616ed84d815504';
decipher.write(encrypted, 'hex');
decipher.end();
```

Example: Using `Decipher` and piped streams:

```js
const crypto = require('crypto');
const fs = require('fs');
const decipher = crypto.createDecipher('aes192', 'a password');

const input = fs.createReadStream('test.enc');
const output = fs.createWriteStream('test.js');

input.pipe(decipher).pipe(output);
```

Example: Using the [`decipher.update()`][] and [`decipher.final()`][] methods:

```js
const crypto = require('crypto');
const decipher = crypto.createDecipher('aes192', 'a password');

var encrypted = 'ca981be48e90867604588e75d04feabb63cc007a8f8ad89b10616ed84d815504';
var decrypted = decipher.update(encrypted, 'hex', 'utf8');
decrypted += decipher.final('utf8');
console.log(decrypted);
  // Prints: some clear text data
```

### decipher.final([output_encoding])


Returns any remaining deciphered contents. If `output_encoding`
parameter is one of `'binary'`, `'base64'` or `'hex'`, a string is returned.
If an `output_encoding` is not provided, a [`Buffer`][] is returned.

Once the `decipher.final()` method has been called, the `Decipher` object can
no longer be used to decrypt data. Attempts to call `decipher.final()` more
than once will result in an error being thrown.

### decipher.setAAD(buffer)


When using an authenticated encryption mode (only `GCM` is currently
supported), the `decipher.setAAD()` method sets the value used for the
_additional authenticated data_ (AAD) input parameter.

### decipher.setAuthTag(buffer)


When using an authenticated encryption mode (only `GCM` is currently
supported), the `decipher.setAuthTag()` method is used to pass in the
received _authentication tag_. If no tag is provided, or if the cipher text
has been tampered with, [`decipher.final()`][] with throw, indicating that the
cipher text should be discarded due to failed authentication.

### decipher.setAutoPadding(auto_padding=true)


When data has been encrypted without standard block padding, calling
`decipher.setAutoPadding(false)` will disable automatic padding to prevent
[`decipher.final()`][] from checking for and removing padding.

Turning auto padding off will only work if the input data's length is a
multiple of the ciphers block size.

The `decipher.setAutoPadding()` method must be called before
[`decipher.update()`][].

### decipher.update(data[, input_encoding][, output_encoding])


Updates the decipher with `data`. If the `input_encoding` argument is given,
it's value must be one of `'binary'`, `'base64'`, or `'hex'` and the `data`
argument is a string using the specified encoding. If the `input_encoding`
argument is not given, `data` must be a [`Buffer`][]. If `data` is a
[`Buffer`][] then `input_encoding` is ignored.

The `output_encoding` specifies the output format of the enciphered
data, and can be `'binary'`, `'ascii'` or `'utf8'`. If the `output_encoding`
is specified, a string using the specified encoding is returned. If no
`output_encoding` is provided, a [`Buffer`][] is returned.

The `decipher.update()` method can be called multiple times with new data until
[`decipher.final()`][] is called. Calling `decipher.update()` after
[`decipher.final()`][] will result in an error being thrown.

## Class: DiffieHellman


The `DiffieHellman` class is a utility for creating Diffie-Hellman key
exchanges.

Instances of the `DiffieHellman` class can be created using the
[`crypto.createDiffieHellman()`][] function.

```js
const crypto = require('crypto');
const assert = require('assert');

// Generate Alice's keys...
const alice = crypto.createDiffieHellman(2048);
const alice_key = alice.generateKeys();

// Generate Bob's keys...
const bob = crypto.createDiffieHellman(alice.getPrime(), alice.getGenerator());
const bob_key = bob.generateKeys();

// Exchange and generate the secret...
const alice_secret = alice.computeSecret(bob_key);
const bob_secret = bob.computeSecret(alice_key);

// OK
assert.equal(alice_secret.toString('hex'), bob_secret.toString('hex'));
```

### diffieHellman.computeSecret(other_public_key[, input_encoding][, output_encoding])


Computes the shared secret using `other_public_key` as the other
party's public key and returns the computed shared secret. The supplied
key is interpreted using the specified `input_encoding`, and secret is
encoded using specified `output_encoding`. Encodings can be
`'binary'`, `'hex'`, or `'base64'`. If the `input_encoding` is not
provided, `other_public_key` is expected to be a [`Buffer`][].

If `output_encoding` is given a string is returned; otherwise, a
[`Buffer`][] is returned.

### diffieHellman.generateKeys([encoding])


Generates private and public Diffie-Hellman key values, and returns
the public key in the specified `encoding`. This key should be
transferred to the other party. Encoding can be `'binary'`, `'hex'`,
or `'base64'`. If `encoding` is provided a string is returned; otherwise a
[`Buffer`][] is returned.

### diffieHellman.getGenerator([encoding])


Returns the Diffie-Hellman generator in the specified `encoding`, which can
be `'binary'`, `'hex'`, or `'base64'`. If  `encoding` is provided a string is
returned; otherwise a [`Buffer`][] is returned.

### diffieHellman.getPrime([encoding])


Returns the Diffie-Hellman prime in the specified `encoding`, which can
be `'binary'`, `'hex'`, or `'base64'`. If `encoding` is provided a string is
returned; otherwise a [`Buffer`][] is returned.

### diffieHellman.getPrivateKey([encoding])


Returns the Diffie-Hellman private key in the specified `encoding`,
which can be `'binary'`, `'hex'`, or `'base64'`. If `encoding` is provided a
string is returned; otherwise a [`Buffer`][] is returned.

### diffieHellman.getPublicKey([encoding])


Returns the Diffie-Hellman public key in the specified `encoding`, which
can be `'binary'`, `'hex'`, or `'base64'`. If `encoding` is provided a
string is returned; otherwise a [`Buffer`][] is returned.

### diffieHellman.setPrivateKey(private_key[, encoding])


Sets the Diffie-Hellman private key. If the `encoding` argument is provided
and is either `'binary'`, `'hex'`, or `'base64'`, `private_key` is expected
to be a string. If no `encoding` is provided, `private_key` is expected
to be a [`Buffer`][].

### diffieHellman.setPublicKey(public_key[, encoding])


Sets the Diffie-Hellman public key. If the `encoding` argument is provided
and is either `'binary'`, `'hex'` or `'base64'`, `public_key` is expected
to be a string. If no `encoding` is provided, `public_key` is expected
to be a [`Buffer`][].

### diffieHellman.verifyError


A bit field containing any warnings and/or errors resulting from a check
performed during initialization of the `DiffieHellman` object.

The following values are valid for this property (as defined in `constants`
module):

* `DH_CHECK_P_NOT_SAFE_PRIME`
* `DH_CHECK_P_NOT_PRIME`
* `DH_UNABLE_TO_CHECK_GENERATOR`
* `DH_NOT_SUITABLE_GENERATOR`

## Class: ECDH


The `ECDH` class is a utility for creating Elliptic Curve Diffie-Hellman (ECDH)
key exchanges.

Instances of the `ECDH` class can be created using the
[`crypto.createECDH()`][] function.

```js
const crypto = require('crypto');
const assert = require('assert');

// Generate Alice's keys...
const alice = crypto.createECDH('secp521r1');
const alice_key = alice.generateKeys();

// Generate Bob's keys...
const bob = crypto.createECDH('secp521r1');
const bob_key = bob.generateKeys();

// Exchange and generate the secret...
const alice_secret = alice.computeSecret(bob_key);
const bob_secret = bob.computeSecret(alice_key);

assert(alice_secret, bob_secret);
  // OK
```

### ecdh.computeSecret(other_public_key[, input_encoding][, output_encoding])


Computes the shared secret using `other_public_key` as the other
party's public key and returns the computed shared secret. The supplied
key is interpreted using specified `input_encoding`, and the returned secret
is encoded using the specified `output_encoding`. Encodings can be
`'binary'`, `'hex'`, or `'base64'`. If the `input_encoding` is not
provided, `other_public_key` is expected to be a [`Buffer`][].

If `output_encoding` is given a string will be returned; otherwise a
[`Buffer`][] is returned.

### ecdh.generateKeys([encoding[, format]])


Generates private and public EC Diffie-Hellman key values, and returns
the public key in the specified `format` and `encoding`. This key should be
transferred to the other party.

The `format` arguments specifies point encoding and can be `'compressed'`,
`'uncompressed'`, or `'hybrid'`. If `format` is not specified, the point will
be returned in `'uncompressed'` format.

The `encoding` argument can be `'binary'`, `'hex'`, or `'base64'`. If
`encoding` is provided a string is returned; otherwise a [`Buffer`][]
is returned.

### ecdh.getPrivateKey([encoding])


Returns the EC Diffie-Hellman private key in the specified `encoding`,
which can be `'binary'`, `'hex'`, or `'base64'`. If `encoding` is provided
a string is returned; otherwise a [`Buffer`][] is returned.

### ecdh.getPublicKey([encoding[, format]])


Returns the EC Diffie-Hellman public key in the specified `encoding` and
`format`.

The `format` argument specifies point encoding and can be `'compressed'`,
`'uncompressed'`, or `'hybrid'`. If `format` is not specified the point will be
returned in `'uncompressed'` format.

The `encoding` argument can be `'binary'`, `'hex'`, or `'base64'`. If
`encoding` is specified, a string is returned; otherwise a [`Buffer`][] is
returned.

### ecdh.setPrivateKey(private_key[, encoding])


Sets the EC Diffie-Hellman private key. The `encoding` can be `'binary'`,
`'hex'` or `'base64'`. If `encoding` is provided, `private_key` is expected
to be a string; otherwise `private_key` is expected to be a [`Buffer`][]. If
`private_key` is not valid for the curve specified when the `ECDH` object was
created, an error is thrown. Upon setting the private key, the associated
public point (key) is also generated and set in the ECDH object.

### ecdh.setPublicKey(public_key[, encoding])


> Stability: 0 - Deprecated

Sets the EC Diffie-Hellman public key. Key encoding can be `'binary'`,
`'hex'` or `'base64'`. If `encoding` is provided `public_key` is expected to
be a string; otherwise a [`Buffer`][] is expected.

Note that there is not normally a reason to call this method because `ECDH`
only requires a private key and the other party's public key to compute the
shared secret. Typically either [`ecdh.generateKeys()`][] or
[`ecdh.setPrivateKey()`][] will be called. The [`ecdh.setPrivateKey()`][] method
attempts to generate the public point/key associated with the private key being
set.

Example (obtaining a shared secret):

```js
const crypto = require('crypto');
const alice = crypto.createECDH('secp256k1');
const bob = crypto.createECDH('secp256k1');

// Note: This is a shortcut way to specify one of Alice's previous private
// keys. It would be unwise to use such a predictable private key in a real
// application.
alice.setPrivateKey(
  crypto.createHash('sha256').update('alice', 'utf8').digest()
);

// Bob uses a newly generated cryptographically strong
// pseudorandom key pair bob.generateKeys();

const alice_secret = alice.computeSecret(bob.getPublicKey(), null, 'hex');
const bob_secret = bob.computeSecret(alice.getPublicKey(), null, 'hex');

// alice_secret and bob_secret should be the same shared secret value
console.log(alice_secret === bob_secret);
```

## Class: Hash


The `Hash` class is a utility for creating hash digests of data. It can be
used in one of two ways:

- As a [stream][] that is both readable and writable, where data is written
  to produce a computed hash digest on the readable side, or
- Using the [`hash.update()`][] and [`hash.digest()`][] methods to produce the
  computed hash.

The [`crypto.createHash()`][] method is used to create `Hash` instances. `Hash`
objects are not to be created directly using the `new` keyword.

Example: Using `Hash` objects as streams:

```js
const crypto = require('crypto');
const hash = crypto.createHash('sha256');

hash.on('readable', () => {
  var data = hash.read();
  if (data)
    console.log(data.toString('hex'));
    // Prints:
    //   6a2da20943931e9834fc12cfe5bb47bbd9ae43489a30726962b576f4e3993e50
});

hash.write('some data to hash');
hash.end();
```

Example: Using `Hash` and piped streams:

```js
const crypto = require('crypto');
const fs = require('fs');
const hash = crypto.createHash('sha256');

const input = fs.createReadStream('test.js');
input.pipe(hash).pipe(process.stdout);
```

Example: Using the [`hash.update()`][] and [`hash.digest()`][] methods:

```js
const crypto = require('crypto');
const hash = crypto.createHash('sha256');

hash.update('some data to hash');
console.log(hash.digest('hex'));
  // Prints:
  //   6a2da20943931e9834fc12cfe5bb47bbd9ae43489a30726962b576f4e3993e50
```

### hash.digest([encoding])


Calculates the digest of all of the data passed to be hashed (using the
[`hash.update()`][] method). The `encoding` can be `'hex'`, `'binary'` or
`'base64'`. If `encoding` is provided a string will be returned; otherwise
a [`Buffer`][] is returned.

The `Hash` object can not be used again after `hash.digest()` method has been
called. Multiple calls will cause an error to be thrown.

### hash.update(data[, input_encoding])


Updates the hash content with the given `data`, the encoding of which
is given in `input_encoding` and can be `'utf8'`, `'ascii'` or
`'binary'`. If `encoding` is not provided, and the `data` is a string, an
encoding of `'binary'` is enforced. If `data` is a [`Buffer`][] then
`input_encoding` is ignored.

This can be called many times with new data as it is streamed.

## Class: Hmac


The `Hmac` Class is a utility for creating cryptographic HMAC digests. It can
be used in one of two ways:

- As a [stream][] that is both readable and writable, where data is written
  to produce a computed HMAC digest on the readable side, or
- Using the [`hmac.update()`][] and [`hmac.digest()`][] methods to produce the
  computed HMAC digest.

The [`crypto.createHmac()`][] method is used to create `Hmac` instances. `Hmac`
objects are not to be created directly using the `new` keyword.

Example: Using `Hmac` objects as streams:

```js
const crypto = require('crypto');
const hmac = crypto.createHmac('sha256', 'a secret');

hmac.on('readable', () => {
  var data = hmac.read();
  if (data)
    console.log(data.toString('hex'));
    // Prints:
    //   7fd04df92f636fd450bc841c9418e5825c17f33ad9c87c518115a45971f7f77e
});

hmac.write('some data to hash');
hmac.end();
```

Example: Using `Hmac` and piped streams:

```js
const crypto = require('crypto');
const fs = require('fs');
const hmac = crypto.createHmac('sha256', 'a secret');

const input = fs.createReadStream('test.js');
input.pipe(hmac).pipe(process.stdout);
```

Example: Using the [`hmac.update()`][] and [`hmac.digest()`][] methods:

```js
const crypto = require('crypto');
const hmac = crypto.createHmac('sha256', 'a secret');

hmac.update('some data to hash');
console.log(hmac.digest('hex'));
  // Prints:
  //   7fd04df92f636fd450bc841c9418e5825c17f33ad9c87c518115a45971f7f77e
```

### hmac.digest([encoding])


Calculates the HMAC digest of all of the data passed using [`hmac.update()`][].
The `encoding` can be `'hex'`, `'binary'` or `'base64'`. If `encoding` is
provided a string is returned; otherwise a [`Buffer`][] is returned;

The `Hmac` object can not be used again after `hmac.digest()` has been
called. Multiple calls to `hmac.digest()` will result in an error being thrown.

### hmac.update(data[, input_encoding])


Updates the `Hmac` content with the given `data`, the encoding of which
is given in `input_encoding` and can be `'utf8'`, `'ascii'` or
`'binary'`. If `encoding` is not provided, and the `data` is a string, an
encoding of `'utf8'` is enforced. If `data` is a [`Buffer`][] then
`input_encoding` is ignored.

This can be called many times with new data as it is streamed.

## Class: Sign


The `Sign` Class is a utility for generating signatures. It can be used in one
of two ways:

- As a writable [stream][], where data to be signed is written and the
  [`sign.sign()`][] method is used to generate and return the signature, or
- Using the [`sign.update()`][] and [`sign.sign()`][] methods to produce the
  signature.

The [`crypto.createSign()`][] method is used to create `Sign` instances. `Sign`
objects are not to be created directly using the `new` keyword.

Example: Using `Sign` objects as streams:

```js
const crypto = require('crypto');
const sign = crypto.createSign('RSA-SHA256');

sign.write('some data to sign');
sign.end();

const private_key = getPrivateKeySomehow();
console.log(sign.sign(private_key, 'hex'));
  // Prints the calculated signature
```

Example: Using the [`sign.update()`][] and [`sign.sign()`][] methods:

```js
const crypto = require('crypto');
const sign = crypto.createSign('RSA-SHA256');

sign.update('some data to sign');

const private_key = getPrivateKeySomehow();
console.log(sign.sign(private_key, 'hex'));
  // Prints the calculated signature
```

A `Sign` instance can also be created by just passing in the digest
algorithm name, in which case OpenSSL will infer the full signature algorithm
from the type of the PEM-formatted private key, including algorithms that
do not have directly exposed name constants, e.g. 'ecdsa-with-SHA256'.

Example: signing using ECDSA with SHA256

```js
const crypto = require('crypto');
const sign = crypto.createSign('sha256');

sign.update('some data to sign');

const private_key = '-----BEGIN EC PRIVATE KEY-----\n' +
        'MHcCAQEEIF+jnWY1D5kbVYDNvxxo/Y+ku2uJPDwS0r/VuPZQrjjVoAoGCCqGSM49\n' +
        'AwEHoUQDQgAEurOxfSxmqIRYzJVagdZfMMSjRNNhB8i3mXyIMq704m2m52FdfKZ2\n' +
        'pQhByd5eyj3lgZ7m7jbchtdgyOF8Io/1ng==\n' +
        '-----END EC PRIVATE KEY-----\n';

console.log(sign.sign(private_key).toString('hex'));
```

### sign.sign(private_key[, output_format])


Calculates the signature on all the data passed through using either
[`sign.update()`][] or [`sign.write()`][stream-writable-write].

The `private_key` argument can be an object or a string. If `private_key` is a
string, it is treated as a raw key with no passphrase. If `private_key` is an
object, it is interpreted as a hash containing two properties:

* `key` : {String} - PEM encoded private key
* `passphrase` : {String} - passphrase for the private key

The `output_format` can specify one of `'binary'`, `'hex'` or `'base64'`. If
`output_format` is provided a string is returned; otherwise a [`Buffer`][] is
returned.

The `Sign` object can not be again used after `sign.sign()` method has been
called. Multiple calls to `sign.sign()` will result in an error being thrown.

### sign.update(data[, input_encoding])


Updates the `Sign` content with the given `data`, the encoding of which
is given in `input_encoding` and can be `'utf8'`, `'ascii'` or
`'binary'`. If `encoding` is not provided, and the `data` is a string, an
encoding of `'utf8'` is enforced. If `data` is a [`Buffer`][] then
`input_encoding` is ignored.

This can be called many times with new data as it is streamed.

## Class: Verify


The `Verify` class is a utility for verifying signatures. It can be used in one
of two ways:

- As a writable [stream][] where written data is used to validate against the
  supplied signature, or
- Using the [`verify.update()`][] and [`verify.verify()`][] methods to verify
  the signature.

The [`crypto.createVerify()`][] method is used to create `Verify` instances.
`Verify` objects are not to be created directly using the `new` keyword.

Example: Using `Verify` objects as streams:

```js
const crypto = require('crypto');
const verify = crypto.createVerify('RSA-SHA256');

verify.write('some data to sign');
verify.end();

const public_key = getPublicKeySomehow();
const signature = getSignatureToVerify();
console.log(verify.verify(public_key, signature));
  // Prints true or false
```

Example: Using the [`verify.update()`][] and [`verify.verify()`][] methods:

```js
const crypto = require('crypto');
const verify = crypto.createVerify('RSA-SHA256');

verify.update('some data to sign');

const public_key = getPublicKeySomehow();
const signature = getSignatureToVerify();
console.log(verify.verify(public_key, signature));
  // Prints true or false
```

### verifier.update(data[, input_encoding])


Updates the `Verify` content with the given `data`, the encoding of which
is given in `input_encoding` and can be `'utf8'`, `'ascii'` or
`'binary'`. If `encoding` is not provided, and the `data` is a string, an
encoding of `'utf8'` is enforced. If `data` is a [`Buffer`][] then
`input_encoding` is ignored.

This can be called many times with new data as it is streamed.

### verifier.verify(object, signature[, signature_format])


Verifies the provided data using the given `object` and `signature`.
The `object` argument is a string containing a PEM encoded object, which can be
one an RSA public key, a DSA public key, or an X.509 certificate.
The `signature` argument is the previously calculated signature for the data, in
the `signature_format` which can be `'binary'`, `'hex'` or `'base64'`.
If a `signature_format` is specified, the `signature` is expected to be a
string; otherwise `signature` is expected to be a [`Buffer`][].

Returns `true` or `false` depending on the validity of the signature for
the data and public key.

The `verifier` object can not be used again after `verify.verify()` has been
called. Multiple calls to `verify.verify()` will result in an error being
thrown.

## `crypto` module methods and properties

### crypto.DEFAULT_ENCODING


The default encoding to use for functions that can take either strings
or [buffers][`Buffer`]. The default value is `'buffer'`, which makes methods
default to [`Buffer`][] objects.

The `crypto.DEFAULT_ENCODING` mechanism is provided for backwards compatibility
with legacy programs that expect `'binary'` to be the default encoding.

New applications should expect the default to be `'buffer'`. This property may
become deprecated in a future Node.js release.

### crypto.createCipher(algorithm, password)


Creates and returns a `Cipher` object that uses the given `algorithm` and
`password`.

The `algorithm` is dependent on OpenSSL, examples are `'aes192'`, etc. On
recent OpenSSL releases, `openssl list-cipher-algorithms` will display the
available cipher algorithms.

The `password` is used to derive the cipher key and initialization vector (IV).
The value must be either a `'binary'` encoded string or a [`Buffer`][].

The implementation of `crypto.createCipher()` derives keys using the OpenSSL
function [`EVP_BytesToKey`][] with the digest algorithm set to MD5, one
iteration, and no salt. The lack of salt allows dictionary attacks as the same
password always creates the same key. The low iteration count and
non-cryptographically secure hash algorithm allow passwords to be tested very
rapidly.

In line with OpenSSL's recommendation to use pbkdf2 instead of
[`EVP_BytesToKey`][] it is recommended that developers derive a key and IV on
their own using [`crypto.pbkdf2()`][] and to use [`crypto.createCipheriv()`][]
to create the `Cipher` object.

### crypto.createCipheriv(algorithm, key, iv)

Creates and returns a `Cipher` object, with the given `algorithm`, `key` and
initialization vector (`iv`).

The `algorithm` is dependent on OpenSSL, examples are `'aes192'`, etc. On
recent OpenSSL releases, `openssl list-cipher-algorithms` will display the
available cipher algorithms.

The `key` is the raw key used by the `algorithm` and `iv` is an
[initialization vector][]. Both arguments must be `'binary'` encoded strings or
[buffers][`Buffer`].

### crypto.createCredentials(details)


> Stability: 0 - Deprecated: Use [`tls.createSecureContext()`][] instead.

The `crypto.createCredentials()` method is a deprecated alias for creating
and returning a `tls.SecureContext` object. The `crypto.createCredentials()`
method should not be used.

The optional `details` argument is a hash object with keys:

* `pfx` : {String|Buffer} - PFX or PKCS12 encoded private
  key, certificate and CA certificates
* `key` : {String} - PEM encoded private key
* `passphrase` : {String} - passphrase for the private key or PFX
* `cert` : {String} - PEM encoded certificate
* `ca` : {String|Array} - Either a string or array of strings of PEM encoded CA
  certificates to trust.
* `crl` : {String|Array} - Either a string or array of strings of PEM encoded CRLs
  (Certificate Revocation List)
* `ciphers`: {String} using the [OpenSSL cipher list format][] describing the
  cipher algorithms to use or exclude.

If no 'ca' details are given, Node.js will use Mozilla's default
[publicly trusted list of CAs][].

### crypto.createDecipher(algorithm, password)


Creates and returns a `Decipher` object that uses the given `algorithm` and
`password` (key).

The implementation of `crypto.createDecipher()` derives keys using the OpenSSL
function [`EVP_BytesToKey`][] with the digest algorithm set to MD5, one
iteration, and no salt. The lack of salt allows dictionary attacks as the same
password always creates the same key. The low iteration count and
non-cryptographically secure hash algorithm allow passwords to be tested very
rapidly.

In line with OpenSSL's recommendation to use pbkdf2 instead of
[`EVP_BytesToKey`][] it is recommended that developers derive a key and IV on
their own using [`crypto.pbkdf2()`][] and to use [`crypto.createDecipheriv()`][]
to create the `Decipher` object.

### crypto.createDecipheriv(algorithm, key, iv)


Creates and returns a `Decipher` object that uses the given `algorithm`, `key`
and initialization vector (`iv`).

The `algorithm` is dependent on OpenSSL, examples are `'aes192'`, etc. On
recent OpenSSL releases, `openssl list-cipher-algorithms` will display the
available cipher algorithms.

The `key` is the raw key used by the `algorithm` and `iv` is an
[initialization vector][]. Both arguments must be `'binary'` encoded strings or
[buffers][`Buffer`].

### crypto.createDiffieHellman(prime[, prime_encoding][, generator][, generator_encoding])


Creates a `DiffieHellman` key exchange object using the supplied `prime` and an
optional specific `generator`.

The `generator` argument can be a number, string, or [`Buffer`][]. If
`generator` is not specified, the value `2` is used.

The `prime_encoding` and `generator_encoding` arguments can be `'binary'`,
`'hex'`, or `'base64'`.

If `prime_encoding` is specified, `prime` is expected to be a string; otherwise
a [`Buffer`][] is expected.

If `generator_encoding` is specified, `generator` is expected to be a string;
otherwise either a number or [`Buffer`][] is expected.

### crypto.createDiffieHellman(prime_length[, generator])


Creates a `DiffieHellman` key exchange object and generates a prime of
`prime_length` bits using an optional specific numeric `generator`.
If `generator` is not specified, the value `2` is used.

### crypto.createECDH(curve_name)


Creates an Elliptic Curve Diffie-Hellman (`ECDH`) key exchange object using a
predefined curve specified by the `curve_name` string. Use
[`crypto.getCurves()`][] to obtain a list of available curve names. On recent
OpenSSL releases, `openssl ecparam -list_curves` will also display the name
and description of each available elliptic curve.

### crypto.createHash(algorithm)


Creates and returns a `Hash` object that can be used to generate hash digests
using the given `algorithm`.

The `algorithm` is dependent on the available algorithms supported by the
version of OpenSSL on the platform. Examples are `'sha256'`, `'sha512'`, etc.
On recent releases of OpenSSL, `openssl list-message-digest-algorithms` will
display the available digest algorithms.

Example: generating the sha256 sum of a file

```js
const filename = process.argv[2];
const crypto = require('crypto');
const fs = require('fs');

const hash = crypto.createHash('sha256');

const input = fs.createReadStream(filename);
input.on('readable', () => {
  var data = input.read();
  if (data)
    hash.update(data);
  else {
    console.log(`${hash.digest('hex')} ${filename}`);
  }
});
```

### crypto.createHmac(algorithm, key)


Creates and returns an `Hmac` object that uses the given `algorithm` and `key`.

The `algorithm` is dependent on the available algorithms supported by the
version of OpenSSL on the platform. Examples are `'sha256'`, `'sha512'`, etc.
On recent releases of OpenSSL, `openssl list-message-digest-algorithms` will
display the available digest algorithms.

The `key` is the HMAC key used to generate the cryptographic HMAC hash.

Example: generating the sha256 HMAC of a file

```js
const filename = process.argv[2];
const crypto = require('crypto');
const fs = require('fs');

const hmac = crypto.createHmac('sha256', 'a secret');

const input = fs.createReadStream(filename);
input.on('readable', () => {
  var data = input.read();
  if (data)
    hmac.update(data);
  else {
    console.log(`${hmac.digest('hex')} ${filename}`);
  }
});
```

### crypto.createSign(algorithm)


Creates and returns a `Sign` object that uses the given `algorithm`.
Use [`crypto.getHashes()`][] to obtain an array of names of the available
signing algorithms.

### crypto.createVerify(algorithm)


Creates and returns a `Verify` object that uses the given algorithm.
Use [`crypto.getHashes()`][] to obtain an array of names of the available
signing algorithms.

### crypto.getCiphers()


Returns an array with the names of the supported cipher algorithms.

Example:

```js
const ciphers = crypto.getCiphers();
console.log(ciphers); // ['aes-128-cbc', 'aes-128-ccm', ...]
```

### crypto.getCurves()


Returns an array with the names of the supported elliptic curves.

Example:

```js
const curves = crypto.getCurves();
console.log(curves); // ['secp256k1', 'secp384r1', ...]
```

### crypto.getDiffieHellman(group_name)


Creates a predefined `DiffieHellman` key exchange object. The
supported groups are: `'modp1'`, `'modp2'`, `'modp5'` (defined in
[RFC 2412][], but see [Caveats][]) and `'modp14'`, `'modp15'`,
`'modp16'`, `'modp17'`, `'modp18'` (defined in [RFC 3526][]). The
returned object mimics the interface of objects created by
[`crypto.createDiffieHellman()`][], but will not allow changing
the keys (with [`diffieHellman.setPublicKey()`][] for example). The
advantage of using this method is that the parties do not have to
generate nor exchange a group modulus beforehand, saving both processor
and communication time.

Example (obtaining a shared secret):

```js
const crypto = require('crypto');
const alice = crypto.getDiffieHellman('modp14');
const bob = crypto.getDiffieHellman('modp14');

alice.generateKeys();
bob.generateKeys();

const alice_secret = alice.computeSecret(bob.getPublicKey(), null, 'hex');
const bob_secret = bob.computeSecret(alice.getPublicKey(), null, 'hex');

/* alice_secret and bob_secret should be the same */
console.log(alice_secret == bob_secret);
```

### crypto.getHashes()


Returns an array of the names of the supported hash algorithms,
such as `RSA-SHA256`.

Example:

```js
const hashes = crypto.getHashes();
console.log(hashes); // ['sha', 'sha1', 'sha1WithRSAEncryption', ...]
```

### crypto.pbkdf2(password, salt, iterations, keylen[, digest], callback)


Provides an asynchronous Password-Based Key Derivation Function 2 (PBKDF2)
implementation. A selected HMAC digest algorithm specified by `digest` is
applied to derive a key of the requested byte length (`keylen`) from the
`password`, `salt` and `iterations`. If the `digest` algorithm is not specified,
a default of `'sha1'` is used.

The supplied `callback` function is called with two arguments: `err` and
`derivedKey`. If an error occurs, `err` will be set; otherwise `err` will be
null. The successfully generated `derivedKey` will be passed as a [`Buffer`][].

The `iterations` argument must be a number set as high as possible. The
higher the number of iterations, the more secure the derived key will be,
but will take a longer amount of time to complete.

The `salt` should also be as unique as possible. It is recommended that the
salts are random and their lengths are greater than 16 bytes. See
[NIST SP 800-132][] for details.

Example:

```js
const crypto = require('crypto');
crypto.pbkdf2('secret', 'salt', 100000, 512, 'sha512', (err, key) => {
  if (err) throw err;
  console.log(key.toString('hex'));  // 'c5e478d...1469e50'
});
```

An array of supported digest functions can be retrieved using
[`crypto.getHashes()`][].

### crypto.pbkdf2Sync(password, salt, iterations, keylen[, digest])


Provides a synchronous Password-Based Key Derivation Function 2 (PBKDF2)
implementation. A selected HMAC digest algorithm specified by `digest` is
applied to derive a key of the requested byte length (`keylen`) from the
`password`, `salt` and `iterations`. If the `digest` algorithm is not specified,
a default of `'sha1'` is used.

If an error occurs an Error will be thrown, otherwise the derived key will be
returned as a [`Buffer`][].

The `iterations` argument must be a number set as high as possible. The
higher the number of iterations, the more secure the derived key will be,
but will take a longer amount of time to complete.

The `salt` should also be as unique as possible. It is recommended that the
salts are random and their lengths are greater than 16 bytes. See
[NIST SP 800-132][] for details.

Example:

```js
const crypto = require('crypto');
const key = crypto.pbkdf2Sync('secret', 'salt', 100000, 512, 'sha512');
console.log(key.toString('hex'));  // 'c5e478d...1469e50'
```

An array of supported digest functions can be retrieved using
[`crypto.getHashes()`][].

### crypto.privateDecrypt(private_key, buffer)


Decrypts `buffer` with `private_key`.

`private_key` can be an object or a string. If `private_key` is a string, it is
treated as the key with no passphrase and will use `RSA_PKCS1_OAEP_PADDING`.
If `private_key` is an object, it is interpreted as a hash object with the
keys:

* `key` : {String} - PEM encoded private key
* `passphrase` : {String} - Optional passphrase for the private key
* `padding` : An optional padding value, one of the following:
  * `constants.RSA_NO_PADDING`
  * `constants.RSA_PKCS1_PADDING`
  * `constants.RSA_PKCS1_OAEP_PADDING`

All paddings are defined in the `constants` module.

### crypto.privateEncrypt(private_key, buffer)


Encrypts `buffer` with `private_key`.

`private_key` can be an object or a string. If `private_key` is a string, it is
treated as the key with no passphrase and will use `RSA_PKCS1_PADDING`.
If `private_key` is an object, it is interpreted as a hash object with the
keys:

* `key` : {String} - PEM encoded private key
* `passphrase` : {String} - Optional passphrase for the private key
* `padding` : An optional padding value, one of the following:
  * `constants.RSA_NO_PADDING`
  * `constants.RSA_PKCS1_PADDING`

All paddings are defined in the `constants` module.

### crypto.publicDecrypt(public_key, buffer)


Decrypts `buffer` with `public_key`.

`public_key` can be an object or a string. If `public_key` is a string, it is
treated as the key with no passphrase and will use `RSA_PKCS1_PADDING`.
If `public_key` is an object, it is interpreted as a hash object with the
keys:

* `key` : {String} - PEM encoded public key
* `passphrase` : {String} - Optional passphrase for the private key
* `padding` : An optional padding value, one of the following:
  * `constants.RSA_NO_PADDING`
  * `constants.RSA_PKCS1_PADDING`
  * `constants.RSA_PKCS1_OAEP_PADDING`

Because RSA public keys can be derived from private keys, a private key may
be passed instead of a public key.

All paddings are defined in the `constants` module.

### crypto.publicEncrypt(public_key, buffer)


Encrypts `buffer` with `public_key`.

`public_key` can be an object or a string. If `public_key` is a string, it is
treated as the key with no passphrase and will use `RSA_PKCS1_OAEP_PADDING`.
If `public_key` is an object, it is interpreted as a hash object with the
keys:

* `key` : {String} - PEM encoded public key
* `passphrase` : {String} - Optional passphrase for the private key
* `padding` : An optional padding value, one of the following:
  * `constants.RSA_NO_PADDING`
  * `constants.RSA_PKCS1_PADDING`
  * `constants.RSA_PKCS1_OAEP_PADDING`

Because RSA public keys can be derived from private keys, a private key may
be passed instead of a public key.

All paddings are defined in the `constants` module.

### crypto.randomBytes(size[, callback])


Generates cryptographically strong pseudo-random data. The `size` argument
is a number indicating the number of bytes to generate.

If a `callback` function is provided, the bytes are generated asynchronously
and the `callback` function is invoked with two arguments: `err` and `buf`.
If an error occurs, `err` will be an Error object; otherwise it is null. The
`buf` argument is a [`Buffer`][] containing the generated bytes.

```js
// Asynchronous
const crypto = require('crypto');
crypto.randomBytes(256, (err, buf) => {
  if (err) throw err;
  console.log(`${buf.length} bytes of random data: ${buf.toString('hex')}`);
});
```

If the `callback` function is not provided, the random bytes are generated
synchronously and returned as a [`Buffer`][]. An error will be thrown if
there is a problem generating the bytes.

```js
// Synchronous
const buf = crypto.randomBytes(256);
console.log(
  `${buf.length} bytes of random data: ${buf.toString('hex')}`);
```

The `crypto.randomBytes()` method will block until there is sufficient entropy.
This should normally never take longer than a few milliseconds. The only time
when generating the random bytes may conceivably block for a longer period of
time is right after boot, when the whole system is still low on entropy.

### crypto.setEngine(engine[, flags])


Load and set the `engine` for some or all OpenSSL functions (selected by flags).

`engine` could be either an id or a path to the engine's shared library.

The optional `flags` argument uses `ENGINE_METHOD_ALL` by default. The `flags`
is a bit field taking one of or a mix of the following flags (defined in the
`constants` module):

* `ENGINE_METHOD_RSA`
* `ENGINE_METHOD_DSA`
* `ENGINE_METHOD_DH`
* `ENGINE_METHOD_RAND`
* `ENGINE_METHOD_ECDH`
* `ENGINE_METHOD_ECDSA`
* `ENGINE_METHOD_CIPHERS`
* `ENGINE_METHOD_DIGESTS`
* `ENGINE_METHOD_STORE`
* `ENGINE_METHOD_PKEY_METH`
* `ENGINE_METHOD_PKEY_ASN1_METH`
* `ENGINE_METHOD_ALL`
* `ENGINE_METHOD_NONE`

## Notes

### Legacy Streams API (pre Node.js v0.10)

The Crypto module was added to Node.js before there was the concept of a
unified Stream API, and before there were [`Buffer`][] objects for handling
binary data. As such, the many of the `crypto` defined classes have methods not
typically found on other Node.js classes that implement the [streams][stream]
API (e.g. `update()`, `final()`, or `digest()`). Also, many methods accepted
and returned `'binary'` encoded strings by default rather than Buffers. This
default was changed after Node.js v0.8 to use [`Buffer`][] objects by default
instead.

### Recent ECDH Changes

Usage of `ECDH` with non-dynamically generated key pairs has been simplified.
Now, [`ecdh.setPrivateKey()`][] can be called with a preselected private key
and the associated public point (key) will be computed and stored in the object.
This allows code to only store and provide the private part of the EC key pair.
[`ecdh.setPrivateKey()`][] now also validates that the private key is valid for
the selected curve.

The [`ecdh.setPublicKey()`][] method is now deprecated as its inclusion in the
API is not useful. Either a previously stored private key should be set, which
automatically generates the associated public key, or [`ecdh.generateKeys()`][]
should be called. The main drawback of using [`ecdh.setPublicKey()`][] is that
it can be used to put the ECDH key pair into an inconsistent state.

### Support for weak or compromised algorithms

The `crypto` module still supports some algorithms which are already
compromised and are not currently recommended for use. The API also allows
the use of ciphers and hashes with a small key size that are considered to be
too weak for safe use.

Users should take full responsibility for selecting the crypto
algorithm and key size according to their security requirements.

Based on the recommendations of [NIST SP 800-131A][]:

- MD5 and SHA-1 are no longer acceptable where collision resistance is
  required such as digital signatures.
- The key used with RSA, DSA and DH algorithms is recommended to have
  at least 2048 bits and that of the curve of ECDSA and ECDH at least
  224 bits, to be safe to use for several years.
- The DH groups of `modp1`, `modp2` and `modp5` have a key size
  smaller than 2048 bits and are not recommended.

See the reference for other recommendations and details.

[`Buffer`]: buffer.html
[`cipher.final()`]: #crypto_cipher_final_output_encoding
[`cipher.update()`]: #crypto_cipher_update_data_input_encoding_output_encoding
[`crypto.createCipher()`]: #crypto_crypto_createcipher_algorithm_password
[`crypto.createCipheriv()`]: #crypto_crypto_createcipheriv_algorithm_key_iv
[`crypto.createDecipher()`]: #crypto_crypto_createdecipher_algorithm_password
[`crypto.createDecipheriv()`]: #crypto_crypto_createdecipheriv_algorithm_key_iv
[`crypto.createDiffieHellman()`]: #crypto_crypto_creatediffiehellman_prime_prime_encoding_generator_generator_encoding
[`crypto.createECDH()`]: #crypto_crypto_createecdh_curve_name
[`crypto.createHash()`]: #crypto_crypto_createhash_algorithm
[`crypto.createHmac()`]: #crypto_crypto_createhmac_algorithm_key
[`crypto.createSign()`]: #crypto_crypto_createsign_algorithm
[`crypto.getCurves()`]: #crypto_crypto_getcurves
[`crypto.getHashes()`]: #crypto_crypto_gethashes
[`crypto.pbkdf2()`]: #crypto_crypto_pbkdf2_password_salt_iterations_keylen_digest_callback
[`decipher.final()`]: #crypto_decipher_final_output_encoding
[`decipher.update()`]: #crypto_decipher_update_data_input_encoding_output_encoding
[`diffieHellman.setPublicKey()`]: #crypto_diffiehellman_setpublickey_public_key_encoding
[`ecdh.generateKeys()`]: #crypto_ecdh_generatekeys_encoding_format
[`ecdh.setPrivateKey()`]: #crypto_ecdh_setprivatekey_private_key_encoding
[`ecdh.setPublicKey()`]: #crypto_ecdh_setpublickey_public_key_encoding
[`EVP_BytesToKey`]: https://www.openssl.org/docs/crypto/EVP_BytesToKey.html
[`hash.digest()`]: #crypto_hash_digest_encoding
[`hash.update()`]: #crypto_hash_update_data_input_encoding
[`hmac.digest()`]: #crypto_hmac_digest_encoding
[`hmac.update()`]: #crypto_hmac_update_data
[`sign.sign()`]: #crypto_sign_sign_private_key_output_format
[`sign.update()`]: #crypto_sign_update_data
[`tls.createSecureContext()`]: tls.html#tls_tls_createsecurecontext_details
[`verify.update()`]: #crypto_verifier_update_data
[`verify.verify()`]: #crypto_verifier_verify_object_signature_signature_format
[Caveats]: #crypto_support_for_weak_or_compromised_algorithms
[HTML5's `keygen` element]: http://www.w3.org/TR/html5/forms.html#the-keygen-element
[initialization vector]: https://en.wikipedia.org/wiki/Initialization_vector
[NIST SP 800-131A]: http://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-131Ar1.pdf
[NIST SP 800-132]: http://csrc.nist.gov/publications/nistpubs/800-132/nist-sp800-132.pdf
[OpenSSL cipher list format]: https://www.openssl.org/docs/apps/ciphers.html#CIPHER-LIST-FORMAT
[OpenSSL's SPKAC implementation]: https://www.openssl.org/docs/apps/spkac.html
[publicly trusted list of CAs]: https://mxr.mozilla.org/mozilla/source/security/nss/lib/ckfw/builtins/certdata.txt
[RFC 2412]: https://www.rfc-editor.org/rfc/rfc2412.txt
[RFC 3526]: https://www.rfc-editor.org/rfc/rfc3526.txt
[stream]: stream.html
[stream-writable-write]: stream.html#stream_writable_write_chunk_encoding_callback
node-v4.8.2/doc/api/debugger.html000644 000766 000024 00000027602 13070706740 016753 0ustar00iojsstaff000000 000000 


  
  Debugger | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

      

        
Debugger#


Stability: 2 - Stable


Node.js includes an out-of-process debugging utility accessible via a
TCP-based protocol and built-in debugging client. To use it, start Node.js
with the debug argument followed by the path to the script to debug; a prompt
will be displayed indicating successful launch of the debugger:


$ node debug myscript.js
< debugger listening on port 5858
connecting... ok
break in /home/indutny/Code/git/indutny/myscript.js:1
  1 x = 5;
  2 setTimeout(() => {
  3   debugger;
debug>

Node.js's debugger client is not a full-featured debugger, but simple step and
inspection are possible.


Inserting the statement debugger; into the source code of a script will
enable a breakpoint at that position in the code:


// myscript.js
x = 5;
setTimeout(() => {
  debugger;
  console.log('world');
}, 1000);
console.log('hello');



Once the debugger is run, a breakpoint will occur at line 4:


$ node debug myscript.js
< debugger listening on port 5858
connecting... ok
break in /home/indutny/Code/git/indutny/myscript.js:1
  1 x = 5;
  2 setTimeout(() => {
  3   debugger;
debug> cont
< hello
break in /home/indutny/Code/git/indutny/myscript.js:3
  1 x = 5;
  2 setTimeout(() => {
  3   debugger;
  4   console.log('world');
  5 }, 1000);
debug> next
break in /home/indutny/Code/git/indutny/myscript.js:4
  2 setTimeout(() => {
  3   debugger;
  4   console.log('world');
  5 }, 1000);
  6 console.log('hello');
debug> repl
Press Ctrl + C to leave debug repl
> x
5
> 2+2
4
debug> next
< world
break in /home/indutny/Code/git/indutny/myscript.js:5
  3   debugger;
  4   console.log('world');
  5 }, 1000);
  6 console.log('hello');
  7
debug> quit

The repl command allows code to be evaluated remotely. The next command
steps to the next line. Type help to see what other commands are available.


Watchers#


It is possible to watch expression and variable values while debugging. On
every breakpoint, each expression from the watchers list will be evaluated
in the current context and displayed immediately before the breakpoint's
source code listing.


To begin watching an expression, type watch('my_expression'). The command
watchers will print the active watchers. To remove a watcher, type
unwatch('my_expression').


Command reference#


Stepping#


    

  • cont, c - Continue execution
    • 

  • next, n - Step next
    • 

  • step, s - Step in
    • 

  • out, o - Step out
    • 

  • pause - Pause running code (like pause button in Developer Tools)
    • 



Breakpoints#


    

  • setBreakpoint(), sb() - Set breakpoint on current line
    • 

  • setBreakpoint(line), sb(line) - Set breakpoint on specific line
    • 

  • setBreakpoint('fn()'), sb(...) - Set breakpoint on a first statement in
functions body
    • 

  • setBreakpoint('script.js', 1), sb(...) - Set breakpoint on first line of
script.js
    • 

  • clearBreakpoint('script.js', 1), cb(...) - Clear breakpoint in script.js
on line 1
    • 



It is also possible to set a breakpoint in a file (module) that
isn't loaded yet:


$ node debug test/fixtures/break-in-module/main.js
< debugger listening on port 5858
connecting to port 5858... ok
break in test/fixtures/break-in-module/main.js:1
  1 var mod = require('./mod.js');
  2 mod.hello();
  3 mod.hello();
debug> setBreakpoint('mod.js', 23)
Warning: script 'mod.js' was not loaded yet.
  1 var mod = require('./mod.js');
  2 mod.hello();
  3 mod.hello();
debug> c
break in test/fixtures/break-in-module/mod.js:23
 21
 22 exports.hello = () => {
 23   return 'hello from module';
 24 };
 25
debug>

Information#


    

  • backtrace, bt - Print backtrace of current execution frame
    • 

  • list(5) - List scripts source code with 5 line context (5 lines before and
after)
    • 

  • watch(expr) - Add expression to watch list
    • 

  • unwatch(expr) - Remove expression from watch list
    • 

  • watchers - List all watchers and their values (automatically listed on each
breakpoint)
    • 

  • repl - Open debugger's repl for evaluation in debugging script's context
    • 

  • exec expr - Execute an expression in debugging script's context
    • 



Execution control#


    

  • run - Run script (automatically runs on debugger's start)
    • 

  • restart - Restart script
    • 

  • kill - Kill script
    • 



Various#


    

  • scripts - List all loaded scripts
    • 

  • version - Display V8's version
    • 



Advanced Usage#


An alternative way of enabling and accessing the debugger is to start
Node.js with the --debug command-line flag or by signaling an existing
Node.js process with SIGUSR1.


Once a process has been set in debug mode this way, it can be inspected
using the Node.js debugger by either connecting to the pid of the running
process or via URI reference to the listening debugger:


    

  • node debug -p <pid> - Connects to the process via the pid
    • 

  • node debug <URI> - Connects to the process via the URI such as
localhost:5858
    • 



      

    

  

  
  
  
  



node-v4.8.2/doc/api/debugger.json000644 000766 000024 00000015475 13070706740 016765 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/debugger.md",
  "stability": 2,
  "stabilityText": "Stable",
  "miscs": [
    {
      "textRaw": "Debugger",
      "name": "Debugger",
      "stability": 2,
      "stabilityText": "Stable",
      "type": "misc",
      "desc": "
Node.js includes an out-of-process debugging utility accessible via a\nTCP-based protocol and built-in debugging client. To use it, start Node.js\nwith the debug argument followed by the path to the script to debug; a prompt\nwill be displayed indicating successful launch of the debugger:
\n
$ node debug myscript.js\n< debugger listening on port 5858\nconnecting... ok\nbreak in /home/indutny/Code/git/indutny/myscript.js:1\n  1 x = 5;\n  2 setTimeout(() => {\n  3   debugger;\ndebug>\n
Node.js's debugger client is not a full-featured debugger, but simple step and\ninspection are possible.
\n
Inserting the statement debugger; into the source code of a script will\nenable a breakpoint at that position in the code:
\n
// myscript.js\nx = 5;\nsetTimeout(() => {\n  debugger;\n  console.log('world');\n}, 1000);\nconsole.log('hello');\n
\n
Once the debugger is run, a breakpoint will occur at line 4:
\n
$ node debug myscript.js\n< debugger listening on port 5858\nconnecting... ok\nbreak in /home/indutny/Code/git/indutny/myscript.js:1\n  1 x = 5;\n  2 setTimeout(() => {\n  3   debugger;\ndebug> cont\n< hello\nbreak in /home/indutny/Code/git/indutny/myscript.js:3\n  1 x = 5;\n  2 setTimeout(() => {\n  3   debugger;\n  4   console.log('world');\n  5 }, 1000);\ndebug> next\nbreak in /home/indutny/Code/git/indutny/myscript.js:4\n  2 setTimeout(() => {\n  3   debugger;\n  4   console.log('world');\n  5 }, 1000);\n  6 console.log('hello');\ndebug> repl\nPress Ctrl + C to leave debug repl\n> x\n5\n> 2+2\n4\ndebug> next\n< world\nbreak in /home/indutny/Code/git/indutny/myscript.js:5\n  3   debugger;\n  4   console.log('world');\n  5 }, 1000);\n  6 console.log('hello');\n  7\ndebug> quit\n
The repl command allows code to be evaluated remotely. The next command\nsteps to the next line. Type help to see what other commands are available.
\n",
      "miscs": [
        {
          "textRaw": "Watchers",
          "name": "watchers",
          "desc": "
It is possible to watch expression and variable values while debugging. On\nevery breakpoint, each expression from the watchers list will be evaluated\nin the current context and displayed immediately before the breakpoint's\nsource code listing.
\n
To begin watching an expression, type watch('my_expression'). The command\nwatchers will print the active watchers. To remove a watcher, type\nunwatch('my_expression').
\n",
          "type": "misc",
          "displayName": "Watchers"
        },
        {
          "textRaw": "Command reference",
          "name": "command_reference",
          "modules": [
            {
              "textRaw": "Stepping",
              "name": "Stepping",
              "desc": "
    \n
  • cont, c - Continue execution
    • \n
  • next, n - Step next
    • \n
  • step, s - Step in
    • \n
  • out, o - Step out
    • \n
  • pause - Pause running code (like pause button in Developer Tools)
    • \n
\n",
              "type": "module",
              "displayName": "Breakpoints"
            },
            {
              "textRaw": "Breakpoints",
              "name": "breakpoints",
              "desc": "
    \n
  • setBreakpoint(), sb() - Set breakpoint on current line
    • \n
  • setBreakpoint(line), sb(line) - Set breakpoint on specific line
    • \n
  • setBreakpoint('fn()'), sb(...) - Set breakpoint on a first statement in\nfunctions body
    • \n
  • setBreakpoint('script.js', 1), sb(...) - Set breakpoint on first line of\nscript.js
    • \n
  • clearBreakpoint('script.js', 1), cb(...) - Clear breakpoint in script.js\non line 1
    • \n
\n
It is also possible to set a breakpoint in a file (module) that\nisn't loaded yet:
\n
$ node debug test/fixtures/break-in-module/main.js\n< debugger listening on port 5858\nconnecting to port 5858... ok\nbreak in test/fixtures/break-in-module/main.js:1\n  1 var mod = require('./mod.js');\n  2 mod.hello();\n  3 mod.hello();\ndebug> setBreakpoint('mod.js', 23)\nWarning: script 'mod.js' was not loaded yet.\n  1 var mod = require('./mod.js');\n  2 mod.hello();\n  3 mod.hello();\ndebug> c\nbreak in test/fixtures/break-in-module/mod.js:23\n 21\n 22 exports.hello = () => {\n 23   return 'hello from module';\n 24 };\n 25\ndebug>\n
",
              "type": "module",
              "displayName": "Breakpoints"
            },
            {
              "textRaw": "Execution control",
              "name": "Execution control",
              "desc": "
    \n
  • run - Run script (automatically runs on debugger's start)
    • \n
  • restart - Restart script
    • \n
  • kill - Kill script
    • \n
\n",
              "type": "module",
              "displayName": "Various"
            },
            {
              "textRaw": "Various",
              "name": "various",
              "desc": "
    \n
  • scripts - List all loaded scripts
    • \n
  • version - Display V8's version
    • \n
\n",
              "type": "module",
              "displayName": "Various"
            }
          ],
          "type": "misc",
          "displayName": "Command reference"
        },
        {
          "textRaw": "Advanced Usage",
          "name": "advanced_usage",
          "desc": "
An alternative way of enabling and accessing the debugger is to start\nNode.js with the --debug command-line flag or by signaling an existing\nNode.js process with SIGUSR1.
\n
Once a process has been set in debug mode this way, it can be inspected\nusing the Node.js debugger by either connecting to the pid of the running\nprocess or via URI reference to the listening debugger:
\n
    \n
  • node debug -p <pid> - Connects to the process via the pid
    • \n
  • node debug <URI> - Connects to the process via the URI such as\nlocalhost:5858
    • \n
\n",
          "type": "misc",
          "displayName": "Advanced Usage"
        }
      ]
    }
  ]
}
node-v4.8.2/doc/api/debugger.md000644 000766 000024 00000011460 13070706735 016406 0ustar00iojsstaff000000 000000 # Debugger

> Stability: 2 - Stable



Node.js includes an out-of-process debugging utility accessible via a
[TCP-based protocol][] and built-in debugging client. To use it, start Node.js
with the `debug` argument followed by the path to the script to debug; a prompt
will be displayed indicating successful launch of the debugger:

```
$ node debug myscript.js
< debugger listening on port 5858
connecting... ok
break in /home/indutny/Code/git/indutny/myscript.js:1
  1 x = 5;
  2 setTimeout(() => {
  3   debugger;
debug>
```

Node.js's debugger client is not a full-featured debugger, but simple step and
inspection are possible.

Inserting the statement `debugger;` into the source code of a script will
enable a breakpoint at that position in the code:

```js
// myscript.js
x = 5;
setTimeout(() => {
  debugger;
  console.log('world');
}, 1000);
console.log('hello');
```

Once the debugger is run, a breakpoint will occur at line 4:

```
$ node debug myscript.js
< debugger listening on port 5858
connecting... ok
break in /home/indutny/Code/git/indutny/myscript.js:1
  1 x = 5;
  2 setTimeout(() => {
  3   debugger;
debug> cont
< hello
break in /home/indutny/Code/git/indutny/myscript.js:3
  1 x = 5;
  2 setTimeout(() => {
  3   debugger;
  4   console.log('world');
  5 }, 1000);
debug> next
break in /home/indutny/Code/git/indutny/myscript.js:4
  2 setTimeout(() => {
  3   debugger;
  4   console.log('world');
  5 }, 1000);
  6 console.log('hello');
debug> repl
Press Ctrl + C to leave debug repl
> x
5
> 2+2
4
debug> next
< world
break in /home/indutny/Code/git/indutny/myscript.js:5
  3   debugger;
  4   console.log('world');
  5 }, 1000);
  6 console.log('hello');
  7
debug> quit
```

The `repl` command allows code to be evaluated remotely. The `next` command
steps to the next line. Type `help` to see what other commands are available.

## Watchers

It is possible to watch expression and variable values while debugging. On
every breakpoint, each expression from the watchers list will be evaluated
in the current context and displayed immediately before the breakpoint's
source code listing.

To begin watching an expression, type `watch('my_expression')`. The command
`watchers` will print the active watchers. To remove a watcher, type
`unwatch('my_expression')`.

## Command reference

### Stepping

* `cont`, `c` - Continue execution
* `next`, `n` - Step next
* `step`, `s` - Step in
* `out`, `o` - Step out
* `pause` - Pause running code (like pause button in Developer Tools)

### Breakpoints

* `setBreakpoint()`, `sb()` - Set breakpoint on current line
* `setBreakpoint(line)`, `sb(line)` - Set breakpoint on specific line
* `setBreakpoint('fn()')`, `sb(...)` - Set breakpoint on a first statement in
functions body
* `setBreakpoint('script.js', 1)`, `sb(...)` - Set breakpoint on first line of
script.js
* `clearBreakpoint('script.js', 1)`, `cb(...)` - Clear breakpoint in script.js
on line 1

It is also possible to set a breakpoint in a file (module) that
isn't loaded yet:


```
$ node debug test/fixtures/break-in-module/main.js
< debugger listening on port 5858
connecting to port 5858... ok
break in test/fixtures/break-in-module/main.js:1
  1 var mod = require('./mod.js');
  2 mod.hello();
  3 mod.hello();
debug> setBreakpoint('mod.js', 23)
Warning: script 'mod.js' was not loaded yet.
  1 var mod = require('./mod.js');
  2 mod.hello();
  3 mod.hello();
debug> c
break in test/fixtures/break-in-module/mod.js:23
 21
 22 exports.hello = () => {
 23   return 'hello from module';
 24 };
 25
debug>
```

### Information

* `backtrace`, `bt` - Print backtrace of current execution frame
* `list(5)` - List scripts source code with 5 line context (5 lines before and
after)
* `watch(expr)` - Add expression to watch list
* `unwatch(expr)` - Remove expression from watch list
* `watchers` - List all watchers and their values (automatically listed on each
breakpoint)
* `repl` - Open debugger's repl for evaluation in debugging script's context
* `exec expr` - Execute an expression in debugging script's context

### Execution control

* `run` - Run script (automatically runs on debugger's start)
* `restart` - Restart script
* `kill` - Kill script

### Various

* `scripts` - List all loaded scripts
* `version` - Display V8's version

## Advanced Usage

An alternative way of enabling and accessing the debugger is to start
Node.js with the `--debug` command-line flag or by signaling an existing
Node.js process with `SIGUSR1`.

Once a process has been set in debug mode this way, it can be inspected
using the Node.js debugger by either connecting to the `pid` of the running
process or via URI reference to the listening debugger:

* `node debug -p ` - Connects to the process via the `pid`
* `node debug ` - Connects to the process via the URI such as
localhost:5858

[TCP-based protocol]: https://github.com/v8/v8/wiki/Debugging-Protocol
node-v4.8.2/doc/api/dgram.html000644 000766 000024 00000104130 13070706740 016251 0ustar00iojsstaff000000 000000 


  
  UDP / Datagram Sockets | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

      

        
UDP / Datagram Sockets#


Stability: 2 - Stable


The dgram module provides an implementation of UDP Datagram sockets.


const dgram = require('dgram');
const server = dgram.createSocket('udp4');

server.on('error', (err) => {
  console.log(`server error:\n${err.stack}`);
  server.close();
});

server.on('message', (msg, rinfo) => {
  console.log(`server got: ${msg} from ${rinfo.address}:${rinfo.port}`);
});

server.on('listening', () => {
  var address = server.address();
  console.log(`server listening ${address.address}:${address.port}`);
});

server.bind(41234);
// server listening 0.0.0.0:41234



Class: dgram.Socket#



Added in: v0.1.99

The dgram.Socket object is an EventEmitter that encapsulates the
datagram functionality.


New instances of dgram.Socket are created using dgram.createSocket().
The new keyword is not to be used to create dgram.Socket instances.


Event: 'close'#



Added in: v0.1.99

The 'close' event is emitted after a socket is closed with close().
Once triggered, no new 'message' events will be emitted on this socket.


Event: 'error'#



Added in: v0.1.99



The 'error' event is emitted whenever any error occurs. The event handler
function is passed a single Error object.


Event: 'listening'#



Added in: v0.1.99

The 'listening' event is emitted whenever a socket begins listening for
datagram messages. This occurs as soon as UDP sockets are created.


Event: 'message'#



Added in: v0.1.99

The 'message' event is emitted when a new datagram is available on a socket.
The event handler function is passed two arguments: msg and rinfo.



socket.addMembership(multicastAddress[, multicastInterface])#



Added in: v0.6.9



Tells the kernel to join a multicast group at the given multicastAddress and
multicastInterface using the IP_ADD_MEMBERSHIP socket option. If the
multicastInterface argument is not specified, the operating system will choose
one interface and will add membership to it. To add membership to every
available interface, call addMembership multiple times, once per interface.


socket.address()#



Added in: v0.1.99

Returns an object containing the address information for a socket.
For UDP sockets, this object will contain address, family and port
properties.


socket.bind([port][, address][, callback])#



Added in: v0.1.99

    

  • port <Number> - Integer, Optional
    • 

  • address <String>, Optional
    • 

  • callback <Function> with no parameters, Optional. Called when
binding is complete.
    • 



For UDP sockets, causes the dgram.Socket to listen for datagram
messages on a named port and optional address. If port is not
specified or is 0, the operating system will attempt to bind to a
random port. If address is not specified, the operating system will
attempt to listen on all addresses.  Once binding is complete, a
'listening' event is emitted and the optional callback function is
called.


Note that specifying both a 'listening' event listener and passing a
callback to the socket.bind() method is not harmful but not very
useful.


A bound datagram socket keeps the Node.js process running to receive
datagram messages.


If binding fails, an 'error' event is generated. In rare case (e.g.
attempting to bind with a closed socket), an Error may be thrown.


Example of a UDP server listening on port 41234:


const dgram = require('dgram');
const server = dgram.createSocket('udp4');

server.on('error', (err) => {
  console.log(`server error:\n${err.stack}`);
  server.close();
});

server.on('message', (msg, rinfo) => {
  console.log(`server got: ${msg} from ${rinfo.address}:${rinfo.port}`);
});

server.on('listening', () => {
  var address = server.address();
  console.log(`server listening ${address.address}:${address.port}`);
});

server.bind(41234);
// server listening 0.0.0.0:41234



socket.bind(options[, callback])#



Added in: v0.11.14



For UDP sockets, causes the dgram.Socket to listen for datagram
messages on a named port and optional address that are passed as
properties of an options object passed as the first argument. If
port is not specified or is 0, the operating system will attempt
to bind to a random port. If address is not specified, the operating
system will attempt to listen on all addresses.  Once binding is
complete, a 'listening' event is emitted and the optional callback
function is called.


Note that specifying both a 'listening' event listener and passing a
callback to the socket.bind() method is not harmful but not very
useful.


The options object may contain an additional exclusive property that is
use when using dgram.Socket objects with the cluster module. When
exclusive is set to false (the default), cluster workers will use the same
underlying socket handle allowing connection handling duties to be shared.
When exclusive is true, however, the handle is not shared and attempted
port sharing results in an error.


A bound datagram socket keeps the Node.js process running to receive
datagram messages.


If binding fails, an 'error' event is generated. In rare case (e.g.
attempting to bind with a closed socket), an Error may be thrown.


An example socket listening on an exclusive port is shown below.


socket.bind({
  address: 'localhost',
  port: 8000,
  exclusive: true
});



socket.close([callback])#



Added in: v0.1.99

Close the underlying socket and stop listening for data on it. If a callback is
provided, it is added as a listener for the 'close' event.


socket.dropMembership(multicastAddress[, multicastInterface])#



Added in: v0.6.9



Instructs the kernel to leave a multicast group at multicastAddress using the
IP_DROP_MEMBERSHIP socket option. This method is automatically called by the
kernel when the socket is closed or the process terminates, so most apps will
never have reason to call this.


If multicastInterface is not specified, the operating system will attempt to
drop membership on all valid interfaces.


socket.send(buf, offset, length, port, address[, callback])#



Added in: v0.1.99

    

  • buf <Buffer> | <String> Message to be sent
    • 

  • offset <Number> Integer. Offset in the buffer where the message starts.
    • 

  • length <Number> Integer. Number of bytes in the message.
    • 

  • port <Number> Integer. Destination port.
    • 

  • address <String> Destination hostname or IP address.
    • 

  • callback <Function> Called when the message has been sent. Optional.
    • 



Broadcasts a datagram on the socket. The destination port and address must
be specified.


The buf argument is a Buffer object containing the message. The offset
and length specify the offset within the Buffer where the message begins
and the number of bytes in the message, respectively. With messages that
contain  multi-byte characters, offset and length will be calculated with
respect to byte length and not the character position.


The address argument is a string. If the value of address is a host name,
DNS will be used to resolve the address of the host. If the address is not
specified or is an empty string, '0.0.0.0' or '::0' will be used instead.
It is possible, depending on the network configuration, that these defaults
may not work; accordingly, it is best to be explicit about the destination
address.


If the socket has not been previously bound with a call to bind, the socket
is assigned a random port number and is bound to the "all interfaces" address
('0.0.0.0' for udp4 sockets, '::0' for udp6 sockets.)


An optional callback function  may be specified to as a way of reporting
DNS errors or for determining when it is safe to reuse the buf object.
Note that DNS lookups delay the time to send for at least one tick of the
Node.js event loop.


The only way to know for sure that the datagram has been sent is by using a
callback. If an error occurs and a callback is given, the error will be
passed as the first argument to the callback. If a callback is not given,
the error is emitted as an 'error' event on the socket object.


Example of sending a UDP packet to a random port on localhost;


const dgram = require('dgram');
const message = new Buffer('Some bytes');
const client = dgram.createSocket('udp4');
client.send(message, 0, message.length, 41234, 'localhost', (err) => {
  client.close();
});



A Note about UDP datagram size


The maximum size of an IPv4/v6 datagram depends on the MTU
(Maximum Transmission Unit) and on the Payload Length field size.


    

  • The Payload Length field is 16 bits wide, which means that a normal
payload exceed 64K octets including the internet header and data
(65,507 bytes = 65,535 − 8 bytes UDP header − 20 bytes IP header);
this is generally true for loopback interfaces, but such long datagram
messages are impractical for most hosts and networks.
    

    • 

  • The MTU is the largest size a given link layer technology can support for
datagram messages. For any link, IPv4 mandates a minimum MTU of 68
octets, while the recommended MTU for IPv4 is 576 (typically recommended
as the MTU for dial-up type applications), whether they arrive whole or in
fragments.
    

    For IPv6, the minimum MTU is 1280 octets, however, the mandatory minimum
fragment reassembly buffer size is 1500 octets. The value of 68 octets is
very small, since most current link layer technologies, like Ethernet, have a
minimum MTU of 1500.
    

    • 



It is impossible to know in advance the MTU of each link through which
a packet might travel. Sending a datagram greater than the receiver MTU will
not work because the packet will get silently dropped without informing the
source that the data did not reach its intended recipient.


socket.setBroadcast(flag)#




Sets or clears the SO_BROADCAST socket option.  When set to true, UDP
packets may be sent to a local interface's broadcast address.


socket.setMulticastLoopback(flag)#



Added in: v0.3.8



Sets or clears the IP_MULTICAST_LOOP socket option.  When set to true,
multicast packets will also be received on the local interface.


socket.setMulticastTTL(ttl)#



Added in: v0.3.8



Sets the IP_MULTICAST_TTL socket option.  While TTL generally stands for
"Time to Live", in this context it specifies the number of IP hops that a
packet is allowed to travel through, specifically for multicast traffic.  Each
router or gateway that forwards a packet decrements the TTL. If the TTL is
decremented to 0 by a router, it will not be forwarded.


The argument passed to to socket.setMulticastTTL() is a number of hops
between 0 and 255. The default on most systems is 1 but can vary.


socket.setTTL(ttl)#



Added in: v0.1.101



Sets the IP_TTL socket option. While TTL generally stands for "Time to Live",
in this context it specifies the number of IP hops that a packet is allowed to
travel through.  Each router or gateway that forwards a packet decrements the
TTL.  If the TTL is decremented to 0 by a router, it will not be forwarded.
Changing TTL values is typically done for network probes or when multicasting.


The argument to socket.setTTL() is a number of hops between 1 and 255.
The default on most systems is 64 but can vary.


socket.ref()#



Added in: v0.9.1

By default, binding a socket will cause it to block the Node.js process from
exiting as long as the socket is open. The socket.unref() method can be used
to exclude the socket from the reference counting that keeps the Node.js
process active. The socket.ref() method adds the socket back to the reference
counting and restores the default behavior.


Calling socket.ref() multiples times will have no additional effect.


The socket.ref() method returns a reference to the socket so calls can be
chained.


socket.unref()#



Added in: v0.9.1

By default, binding a socket will cause it to block the Node.js process from
exiting as long as the socket is open. The socket.unref() method can be used
to exclude the socket from the reference counting that keeps the Node.js
process active, allowing the process to exit even if the socket is still
listening.


Calling socket.unref() multiple times will have no addition effect.


The socket.unref() method returns a reference to the socket so calls can be
chained.


Change to asynchronous socket.bind() behavior#


As of Node.js v0.10, dgram.Socket#bind() changed to an asynchronous
execution model. Legacy code that assumes synchronous behavior, as in the
following example:


const s = dgram.createSocket('udp4');
s.bind(1234);
s.addMembership('224.0.0.114');



Must be changed to pass a callback function to the dgram.Socket#bind()
function:


const s = dgram.createSocket('udp4');
s.bind(1234, () => {
  s.addMembership('224.0.0.114');
});



dgram module functions#


dgram.createSocket(options[, callback])#



Added in: v0.11.13



Creates a dgram.Socket object. The options argument is an object that
should contain a type field of either udp4 or udp6 and an optional
boolean reuseAddr field.


When reuseAddr is true socket.bind() will reuse the address, even if
another process has already bound a socket on it. reuseAddr defaults to
false. The optional callback function is added as a listener for 'message'
events.


Once the socket is created, calling socket.bind() will instruct the
socket to begin listening for datagram messages. When address and port are
not passed to  socket.bind() the method will bind the socket to the "all
interfaces" address on a random port (it does the right thing for both udp4
and udp6 sockets). The bound address and port can be retrieved using
socket.address().address and socket.address().port.


dgram.createSocket(type[, callback])#



Added in: v0.1.99



Creates a dgram.Socket object of the specified type. The type argument
can be either udp4 or udp6. An optional callback function can be passed
which is added as a listener for 'message' events.


Once the socket is created, calling socket.bind() will instruct the
socket to begin listening for datagram messages. When address and port are
not passed to  socket.bind() the method will bind the socket to the "all
interfaces" address on a random port (it does the right thing for both udp4
and udp6 sockets). The bound address and port can be retrieved using
socket.address().address and socket.address().port.


      

    

  

  
  
  
  



node-v4.8.2/doc/api/dgram.json000644 000766 000024 00000107226 13070706740 016267 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/dgram.md",
  "modules": [
    {
      "textRaw": "UDP / Datagram Sockets",
      "name": "dgram",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
The dgram module provides an implementation of UDP Datagram sockets.
\n
const dgram = require('dgram');\nconst server = dgram.createSocket('udp4');\n\nserver.on('error', (err) => {\n  console.log(`server error:\\n${err.stack}`);\n  server.close();\n});\n\nserver.on('message', (msg, rinfo) => {\n  console.log(`server got: ${msg} from ${rinfo.address}:${rinfo.port}`);\n});\n\nserver.on('listening', () => {\n  var address = server.address();\n  console.log(`server listening ${address.address}:${address.port}`);\n});\n\nserver.bind(41234);\n// server listening 0.0.0.0:41234\n
\n",
      "classes": [
        {
          "textRaw": "Class: dgram.Socket",
          "type": "class",
          "name": "dgram.Socket",
          "meta": {
            "added": [
              "v0.1.99"
            ]
          },
          "desc": "
The dgram.Socket object is an EventEmitter that encapsulates the\ndatagram functionality.
\n
New instances of dgram.Socket are created using dgram.createSocket().\nThe new keyword is not to be used to create dgram.Socket instances.
\n",
          "events": [
            {
              "textRaw": "Event: 'close'",
              "type": "event",
              "name": "close",
              "meta": {
                "added": [
                  "v0.1.99"
                ]
              },
              "desc": "
The 'close' event is emitted after a socket is closed with close().\nOnce triggered, no new 'message' events will be emitted on this socket.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'error'",
              "type": "event",
              "name": "error",
              "meta": {
                "added": [
                  "v0.1.99"
                ]
              },
              "params": [],
              "desc": "
The 'error' event is emitted whenever any error occurs. The event handler\nfunction is passed a single Error object.
\n"
            },
            {
              "textRaw": "Event: 'listening'",
              "type": "event",
              "name": "listening",
              "meta": {
                "added": [
                  "v0.1.99"
                ]
              },
              "desc": "
The 'listening' event is emitted whenever a socket begins listening for\ndatagram messages. This occurs as soon as UDP sockets are created.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'message'",
              "type": "event",
              "name": "message",
              "meta": {
                "added": [
                  "v0.1.99"
                ]
              },
              "desc": "
The 'message' event is emitted when a new datagram is available on a socket.\nThe event handler function is passed two arguments: msg and rinfo.
\n
    \n
  • msg {Buffer} - The message
    • \n
  • rinfo {Object} - Remote address information
      \n
    • address {String} The sender address
      • \n
    • family {String} The address family ('IPv4' or 'IPv6')
      • \n
    • port {Number} The sender port
      • \n
    • size {Number} The message size
      • \n
    \n
    • \n
\n",
              "params": []
            }
          ],
          "methods": [
            {
              "textRaw": "socket.addMembership(multicastAddress[, multicastInterface])",
              "type": "method",
              "name": "addMembership",
              "meta": {
                "added": [
                  "v0.6.9"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`multicastAddress` {String} ",
                      "name": "multicastAddress",
                      "type": "String"
                    },
                    {
                      "textRaw": "`multicastInterface` {String}, Optional ",
                      "name": "multicastInterface",
                      "type": "String",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "multicastAddress"
                    },
                    {
                      "name": "multicastInterface",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Tells the kernel to join a multicast group at the given multicastAddress and\nmulticastInterface using the IP_ADD_MEMBERSHIP socket option. If the\nmulticastInterface argument is not specified, the operating system will choose\none interface and will add membership to it. To add membership to every\navailable interface, call addMembership multiple times, once per interface.
\n"
            },
            {
              "textRaw": "socket.address()",
              "type": "method",
              "name": "address",
              "meta": {
                "added": [
                  "v0.1.99"
                ]
              },
              "desc": "
Returns an object containing the address information for a socket.\nFor UDP sockets, this object will contain address, family and port\nproperties.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "socket.bind([port][, address][, callback])",
              "type": "method",
              "name": "bind",
              "meta": {
                "added": [
                  "v0.1.99"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`port` {Number} - Integer, Optional ",
                      "name": "port",
                      "type": "Number",
                      "optional": true,
                      "desc": "Integer"
                    },
                    {
                      "textRaw": "`address` {String}, Optional ",
                      "name": "address",
                      "type": "String",
                      "optional": true
                    },
                    {
                      "textRaw": "`callback` {Function} with no parameters, Optional. Called when binding is complete. ",
                      "name": "callback",
                      "type": "Function",
                      "desc": "with no parameters, Optional. Called when binding is complete.",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "port",
                      "optional": true
                    },
                    {
                      "name": "address",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
For UDP sockets, causes the dgram.Socket to listen for datagram\nmessages on a named port and optional address. If port is not\nspecified or is 0, the operating system will attempt to bind to a\nrandom port. If address is not specified, the operating system will\nattempt to listen on all addresses.  Once binding is complete, a\n'listening' event is emitted and the optional callback function is\ncalled.
\n
Note that specifying both a 'listening' event listener and passing a\ncallback to the socket.bind() method is not harmful but not very\nuseful.
\n
A bound datagram socket keeps the Node.js process running to receive\ndatagram messages.
\n
If binding fails, an 'error' event is generated. In rare case (e.g.\nattempting to bind with a closed socket), an Error may be thrown.
\n
Example of a UDP server listening on port 41234:
\n
const dgram = require('dgram');\nconst server = dgram.createSocket('udp4');\n\nserver.on('error', (err) => {\n  console.log(`server error:\\n${err.stack}`);\n  server.close();\n});\n\nserver.on('message', (msg, rinfo) => {\n  console.log(`server got: ${msg} from ${rinfo.address}:${rinfo.port}`);\n});\n\nserver.on('listening', () => {\n  var address = server.address();\n  console.log(`server listening ${address.address}:${address.port}`);\n});\n\nserver.bind(41234);\n// server listening 0.0.0.0:41234\n
\n"
            },
            {
              "textRaw": "socket.bind(options[, callback])",
              "type": "method",
              "name": "bind",
              "meta": {
                "added": [
                  "v0.11.14"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`options` {Object} - Required. Supports the following properties: ",
                      "options": [
                        {
                          "textRaw": "`port` {Number} - Optional. ",
                          "name": "port",
                          "type": "Number",
                          "desc": "Optional."
                        },
                        {
                          "textRaw": "`address` {String} - Optional. ",
                          "name": "address",
                          "type": "String",
                          "desc": "Optional."
                        },
                        {
                          "textRaw": "`exclusive` {Boolean} - Optional. ",
                          "name": "exclusive",
                          "type": "Boolean",
                          "desc": "Optional."
                        }
                      ],
                      "name": "options",
                      "type": "Object",
                      "desc": "Required. Supports the following properties:"
                    },
                    {
                      "textRaw": "`callback` {Function} - Optional. ",
                      "name": "callback",
                      "type": "Function",
                      "desc": "Optional.",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "options"
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
For UDP sockets, causes the dgram.Socket to listen for datagram\nmessages on a named port and optional address that are passed as\nproperties of an options object passed as the first argument. If\nport is not specified or is 0, the operating system will attempt\nto bind to a random port. If address is not specified, the operating\nsystem will attempt to listen on all addresses.  Once binding is\ncomplete, a 'listening' event is emitted and the optional callback\nfunction is called.
\n
Note that specifying both a 'listening' event listener and passing a\ncallback to the socket.bind() method is not harmful but not very\nuseful.
\n
The options object may contain an additional exclusive property that is\nuse when using dgram.Socket objects with the cluster module. When\nexclusive is set to false (the default), cluster workers will use the same\nunderlying socket handle allowing connection handling duties to be shared.\nWhen exclusive is true, however, the handle is not shared and attempted\nport sharing results in an error.
\n
A bound datagram socket keeps the Node.js process running to receive\ndatagram messages.
\n
If binding fails, an 'error' event is generated. In rare case (e.g.\nattempting to bind with a closed socket), an Error may be thrown.
\n
An example socket listening on an exclusive port is shown below.
\n
socket.bind({\n  address: 'localhost',\n  port: 8000,\n  exclusive: true\n});\n
\n"
            },
            {
              "textRaw": "socket.close([callback])",
              "type": "method",
              "name": "close",
              "meta": {
                "added": [
                  "v0.1.99"
                ]
              },
              "desc": "
Close the underlying socket and stop listening for data on it. If a callback is\nprovided, it is added as a listener for the 'close' event.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "socket.dropMembership(multicastAddress[, multicastInterface])",
              "type": "method",
              "name": "dropMembership",
              "meta": {
                "added": [
                  "v0.6.9"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`multicastAddress` {String} ",
                      "name": "multicastAddress",
                      "type": "String"
                    },
                    {
                      "textRaw": "`multicastInterface` {String}, Optional ",
                      "name": "multicastInterface",
                      "type": "String",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "multicastAddress"
                    },
                    {
                      "name": "multicastInterface",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Instructs the kernel to leave a multicast group at multicastAddress using the\nIP_DROP_MEMBERSHIP socket option. This method is automatically called by the\nkernel when the socket is closed or the process terminates, so most apps will\nnever have reason to call this.
\n
If multicastInterface is not specified, the operating system will attempt to\ndrop membership on all valid interfaces.
\n"
            },
            {
              "textRaw": "socket.send(buf, offset, length, port, address[, callback])",
              "type": "method",
              "name": "send",
              "meta": {
                "added": [
                  "v0.1.99"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`buf` {Buffer|String} Message to be sent ",
                      "name": "buf",
                      "type": "Buffer|String",
                      "desc": "Message to be sent"
                    },
                    {
                      "textRaw": "`offset` {Number} Integer. Offset in the buffer where the message starts. ",
                      "name": "offset",
                      "type": "Number",
                      "desc": "Integer. Offset in the buffer where the message starts."
                    },
                    {
                      "textRaw": "`length` {Number} Integer. Number of bytes in the message. ",
                      "name": "length",
                      "type": "Number",
                      "desc": "Integer. Number of bytes in the message."
                    },
                    {
                      "textRaw": "`port` {Number} Integer. Destination port. ",
                      "name": "port",
                      "type": "Number",
                      "desc": "Integer. Destination port."
                    },
                    {
                      "textRaw": "`address` {String} Destination hostname or IP address. ",
                      "name": "address",
                      "type": "String",
                      "desc": "Destination hostname or IP address."
                    },
                    {
                      "textRaw": "`callback` {Function} Called when the message has been sent. Optional. ",
                      "name": "callback",
                      "type": "Function",
                      "desc": "Called when the message has been sent. Optional.",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "offset"
                    },
                    {
                      "name": "length"
                    },
                    {
                      "name": "port"
                    },
                    {
                      "name": "address"
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Broadcasts a datagram on the socket. The destination port and address must\nbe specified.
\n
The buf argument is a Buffer object containing the message. The offset\nand length specify the offset within the Buffer where the message begins\nand the number of bytes in the message, respectively. With messages that\ncontain  multi-byte characters, offset and length will be calculated with\nrespect to byte length and not the character position.
\n
The address argument is a string. If the value of address is a host name,\nDNS will be used to resolve the address of the host. If the address is not\nspecified or is an empty string, '0.0.0.0' or '::0' will be used instead.\nIt is possible, depending on the network configuration, that these defaults\nmay not work; accordingly, it is best to be explicit about the destination\naddress.
\n
If the socket has not been previously bound with a call to bind, the socket\nis assigned a random port number and is bound to the "all interfaces" address\n('0.0.0.0' for udp4 sockets, '::0' for udp6 sockets.)
\n
An optional callback function  may be specified to as a way of reporting\nDNS errors or for determining when it is safe to reuse the buf object.\nNote that DNS lookups delay the time to send for at least one tick of the\nNode.js event loop.
\n
The only way to know for sure that the datagram has been sent is by using a\ncallback. If an error occurs and a callback is given, the error will be\npassed as the first argument to the callback. If a callback is not given,\nthe error is emitted as an 'error' event on the socket object.
\n
Example of sending a UDP packet to a random port on localhost;
\n
const dgram = require('dgram');\nconst message = new Buffer('Some bytes');\nconst client = dgram.createSocket('udp4');\nclient.send(message, 0, message.length, 41234, 'localhost', (err) => {\n  client.close();\n});\n
\n
A Note about UDP datagram size
\n
The maximum size of an IPv4/v6 datagram depends on the MTU\n(Maximum Transmission Unit) and on the Payload Length field size.
\n
    \n
  • The Payload Length field is 16 bits wide, which means that a normal\npayload exceed 64K octets including the internet header and data\n(65,507 bytes = 65,535 − 8 bytes UDP header − 20 bytes IP header);\nthis is generally true for loopback interfaces, but such long datagram\nmessages are impractical for most hosts and networks.
    \n
    • \n
  • The MTU is the largest size a given link layer technology can support for\ndatagram messages. For any link, IPv4 mandates a minimum MTU of 68\noctets, while the recommended MTU for IPv4 is 576 (typically recommended\nas the MTU for dial-up type applications), whether they arrive whole or in\nfragments.
    \n
    For IPv6, the minimum MTU is 1280 octets, however, the mandatory minimum\nfragment reassembly buffer size is 1500 octets. The value of 68 octets is\nvery small, since most current link layer technologies, like Ethernet, have a\nminimum MTU of 1500.
    \n
    • \n
\n
It is impossible to know in advance the MTU of each link through which\na packet might travel. Sending a datagram greater than the receiver MTU will\nnot work because the packet will get silently dropped without informing the\nsource that the data did not reach its intended recipient.
\n"
            },
            {
              "textRaw": "socket.setBroadcast(flag)",
              "type": "method",
              "name": "setBroadcast",
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`flag` {Boolean} ",
                      "name": "flag",
                      "type": "Boolean"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "flag"
                    }
                  ]
                }
              ],
              "desc": "
Sets or clears the SO_BROADCAST socket option.  When set to true, UDP\npackets may be sent to a local interface's broadcast address.
\n"
            },
            {
              "textRaw": "socket.setMulticastLoopback(flag)",
              "type": "method",
              "name": "setMulticastLoopback",
              "meta": {
                "added": [
                  "v0.3.8"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`flag` {Boolean} ",
                      "name": "flag",
                      "type": "Boolean"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "flag"
                    }
                  ]
                }
              ],
              "desc": "
Sets or clears the IP_MULTICAST_LOOP socket option.  When set to true,\nmulticast packets will also be received on the local interface.
\n"
            },
            {
              "textRaw": "socket.setMulticastTTL(ttl)",
              "type": "method",
              "name": "setMulticastTTL",
              "meta": {
                "added": [
                  "v0.3.8"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`ttl` {Number} Integer ",
                      "name": "ttl",
                      "type": "Number",
                      "desc": "Integer"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "ttl"
                    }
                  ]
                }
              ],
              "desc": "
Sets the IP_MULTICAST_TTL socket option.  While TTL generally stands for\n"Time to Live", in this context it specifies the number of IP hops that a\npacket is allowed to travel through, specifically for multicast traffic.  Each\nrouter or gateway that forwards a packet decrements the TTL. If the TTL is\ndecremented to 0 by a router, it will not be forwarded.
\n
The argument passed to to socket.setMulticastTTL() is a number of hops\nbetween 0 and 255. The default on most systems is 1 but can vary.
\n"
            },
            {
              "textRaw": "socket.setTTL(ttl)",
              "type": "method",
              "name": "setTTL",
              "meta": {
                "added": [
                  "v0.1.101"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`ttl` {Number} Integer ",
                      "name": "ttl",
                      "type": "Number",
                      "desc": "Integer"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "ttl"
                    }
                  ]
                }
              ],
              "desc": "
Sets the IP_TTL socket option. While TTL generally stands for "Time to Live",\nin this context it specifies the number of IP hops that a packet is allowed to\ntravel through.  Each router or gateway that forwards a packet decrements the\nTTL.  If the TTL is decremented to 0 by a router, it will not be forwarded.\nChanging TTL values is typically done for network probes or when multicasting.
\n
The argument to socket.setTTL() is a number of hops between 1 and 255.\nThe default on most systems is 64 but can vary.
\n"
            },
            {
              "textRaw": "socket.ref()",
              "type": "method",
              "name": "ref",
              "meta": {
                "added": [
                  "v0.9.1"
                ]
              },
              "desc": "
By default, binding a socket will cause it to block the Node.js process from\nexiting as long as the socket is open. The socket.unref() method can be used\nto exclude the socket from the reference counting that keeps the Node.js\nprocess active. The socket.ref() method adds the socket back to the reference\ncounting and restores the default behavior.
\n
Calling socket.ref() multiples times will have no additional effect.
\n
The socket.ref() method returns a reference to the socket so calls can be\nchained.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "socket.unref()",
              "type": "method",
              "name": "unref",
              "meta": {
                "added": [
                  "v0.9.1"
                ]
              },
              "desc": "
By default, binding a socket will cause it to block the Node.js process from\nexiting as long as the socket is open. The socket.unref() method can be used\nto exclude the socket from the reference counting that keeps the Node.js\nprocess active, allowing the process to exit even if the socket is still\nlistening.
\n
Calling socket.unref() multiple times will have no addition effect.
\n
The socket.unref() method returns a reference to the socket so calls can be\nchained.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            }
          ],
          "modules": [
            {
              "textRaw": "Change to asynchronous `socket.bind()` behavior",
              "name": "change_to_asynchronous_`socket.bind()`_behavior",
              "desc": "
As of Node.js v0.10, dgram.Socket#bind() changed to an asynchronous\nexecution model. Legacy code that assumes synchronous behavior, as in the\nfollowing example:
\n
const s = dgram.createSocket('udp4');\ns.bind(1234);\ns.addMembership('224.0.0.114');\n
\n
Must be changed to pass a callback function to the dgram.Socket#bind()\nfunction:
\n
const s = dgram.createSocket('udp4');\ns.bind(1234, () => {\n  s.addMembership('224.0.0.114');\n});\n
\n",
              "type": "module",
              "displayName": "Change to asynchronous `socket.bind()` behavior"
            }
          ]
        }
      ],
      "modules": [
        {
          "textRaw": "`dgram` module functions",
          "name": "`dgram`_module_functions",
          "methods": [
            {
              "textRaw": "dgram.createSocket(options[, callback])",
              "type": "method",
              "name": "createSocket",
              "meta": {
                "added": [
                  "v0.11.13"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {dgram.Socket} ",
                    "name": "return",
                    "type": "dgram.Socket"
                  },
                  "params": [
                    {
                      "textRaw": "`options` {Object} ",
                      "name": "options",
                      "type": "Object"
                    },
                    {
                      "textRaw": "`callback` {Function} Attached as a listener to `'message'` events. ",
                      "name": "callback",
                      "type": "Function",
                      "desc": "Attached as a listener to `'message'` events.",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "options"
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Creates a dgram.Socket object. The options argument is an object that\nshould contain a type field of either udp4 or udp6 and an optional\nboolean reuseAddr field.
\n
When reuseAddr is true socket.bind() will reuse the address, even if\nanother process has already bound a socket on it. reuseAddr defaults to\nfalse. The optional callback function is added as a listener for 'message'\nevents.
\n
Once the socket is created, calling socket.bind() will instruct the\nsocket to begin listening for datagram messages. When address and port are\nnot passed to  socket.bind() the method will bind the socket to the "all\ninterfaces" address on a random port (it does the right thing for both udp4\nand udp6 sockets). The bound address and port can be retrieved using\nsocket.address().address and socket.address().port.
\n"
            },
            {
              "textRaw": "dgram.createSocket(type[, callback])",
              "type": "method",
              "name": "createSocket",
              "meta": {
                "added": [
                  "v0.1.99"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {dgram.Socket} ",
                    "name": "return",
                    "type": "dgram.Socket"
                  },
                  "params": [
                    {
                      "textRaw": "`type` {String} - Either 'udp4' or 'udp6' ",
                      "name": "type",
                      "type": "String",
                      "desc": "Either 'udp4' or 'udp6'"
                    },
                    {
                      "textRaw": "`callback` {Function} - Attached as a listener to `'message'` events. Optional ",
                      "name": "callback",
                      "type": "Function",
                      "optional": true,
                      "desc": "Attached as a listener to `'message'` events."
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "type"
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Creates a dgram.Socket object of the specified type. The type argument\ncan be either udp4 or udp6. An optional callback function can be passed\nwhich is added as a listener for 'message' events.
\n
Once the socket is created, calling socket.bind() will instruct the\nsocket to begin listening for datagram messages. When address and port are\nnot passed to  socket.bind() the method will bind the socket to the "all\ninterfaces" address on a random port (it does the right thing for both udp4\nand udp6 sockets). The bound address and port can be retrieved using\nsocket.address().address and socket.address().port.
\n"
            }
          ],
          "type": "module",
          "displayName": "`dgram` module functions"
        }
      ],
      "type": "module",
      "displayName": "dgram"
    }
  ]
}
node-v4.8.2/doc/api/dgram.md000644 000766 000024 00000037760 13070706735 015727 0ustar00iojsstaff000000 000000 # UDP / Datagram Sockets

> Stability: 2 - Stable



The `dgram` module provides an implementation of UDP Datagram sockets.

```js
const dgram = require('dgram');
const server = dgram.createSocket('udp4');

server.on('error', (err) => {
  console.log(`server error:\n${err.stack}`);
  server.close();
});

server.on('message', (msg, rinfo) => {
  console.log(`server got: ${msg} from ${rinfo.address}:${rinfo.port}`);
});

server.on('listening', () => {
  var address = server.address();
  console.log(`server listening ${address.address}:${address.port}`);
});

server.bind(41234);
// server listening 0.0.0.0:41234
```

## Class: dgram.Socket


The `dgram.Socket` object is an [`EventEmitter`][] that encapsulates the
datagram functionality.

New instances of `dgram.Socket` are created using [`dgram.createSocket()`][].
The `new` keyword is not to be used to create `dgram.Socket` instances.

### Event: 'close'


The `'close'` event is emitted after a socket is closed with [`close()`][].
Once triggered, no new `'message'` events will be emitted on this socket.

### Event: 'error'


* `exception` {Error}

The `'error'` event is emitted whenever any error occurs. The event handler
function is passed a single Error object.

### Event: 'listening'


The `'listening'` event is emitted whenever a socket begins listening for
datagram messages. This occurs as soon as UDP sockets are created.

### Event: 'message'


The `'message'` event is emitted when a new datagram is available on a socket.
The event handler function is passed two arguments: `msg` and `rinfo`.
* `msg` {Buffer} - The message
* `rinfo` {Object} - Remote address information
  * `address` {String} The sender address
  * `family` {String} The address family (`'IPv4'` or `'IPv6'`)
  * `port` {Number} The sender port
  * `size` {Number} The message size

### socket.addMembership(multicastAddress[, multicastInterface])


* `multicastAddress` {String}
* `multicastInterface` {String}, Optional

Tells the kernel to join a multicast group at the given `multicastAddress` and
`multicastInterface` using the `IP_ADD_MEMBERSHIP` socket option. If the
`multicastInterface` argument is not specified, the operating system will choose
one interface and will add membership to it. To add membership to every
available interface, call `addMembership` multiple times, once per interface.

### socket.address()


Returns an object containing the address information for a socket.
For UDP sockets, this object will contain `address`, `family` and `port`
properties.

### socket.bind([port][, address][, callback])


* `port` {Number} - Integer, Optional
* `address` {String}, Optional
* `callback` {Function} with no parameters, Optional. Called when
  binding is complete.

For UDP sockets, causes the `dgram.Socket` to listen for datagram
messages on a named `port` and optional `address`. If `port` is not
specified or is `0`, the operating system will attempt to bind to a
random port. If `address` is not specified, the operating system will
attempt to listen on all addresses.  Once binding is complete, a
`'listening'` event is emitted and the optional `callback` function is
called.

Note that specifying both a `'listening'` event listener and passing a
`callback` to the `socket.bind()` method is not harmful but not very
useful.

A bound datagram socket keeps the Node.js process running to receive
datagram messages.

If binding fails, an `'error'` event is generated. In rare case (e.g.
attempting to bind with a closed socket), an [`Error`][] may be thrown.

Example of a UDP server listening on port 41234:

```js
const dgram = require('dgram');
const server = dgram.createSocket('udp4');

server.on('error', (err) => {
  console.log(`server error:\n${err.stack}`);
  server.close();
});

server.on('message', (msg, rinfo) => {
  console.log(`server got: ${msg} from ${rinfo.address}:${rinfo.port}`);
});

server.on('listening', () => {
  var address = server.address();
  console.log(`server listening ${address.address}:${address.port}`);
});

server.bind(41234);
// server listening 0.0.0.0:41234
```

### socket.bind(options[, callback])


* `options` {Object} - Required. Supports the following properties:
  * `port` {Number} - Optional.
  * `address` {String} - Optional.
  * `exclusive` {Boolean} - Optional.
* `callback` {Function} - Optional.

For UDP sockets, causes the `dgram.Socket` to listen for datagram
messages on a named `port` and optional `address` that are passed as
properties of an `options` object passed as the first argument. If
`port` is not specified or is `0`, the operating system will attempt
to bind to a random port. If `address` is not specified, the operating
system will attempt to listen on all addresses.  Once binding is
complete, a `'listening'` event is emitted and the optional `callback`
function is called.

Note that specifying both a `'listening'` event listener and passing a
`callback` to the `socket.bind()` method is not harmful but not very
useful.

The `options` object may contain an additional `exclusive` property that is
use when using `dgram.Socket` objects with the [`cluster`] module. When
`exclusive` is set to `false` (the default), cluster workers will use the same
underlying socket handle allowing connection handling duties to be shared.
When `exclusive` is `true`, however, the handle is not shared and attempted
port sharing results in an error.

A bound datagram socket keeps the Node.js process running to receive
datagram messages.

If binding fails, an `'error'` event is generated. In rare case (e.g.
attempting to bind with a closed socket), an [`Error`][] may be thrown.

An example socket listening on an exclusive port is shown below.

```js
socket.bind({
  address: 'localhost',
  port: 8000,
  exclusive: true
});
```

### socket.close([callback])


Close the underlying socket and stop listening for data on it. If a callback is
provided, it is added as a listener for the [`'close'`][] event.

### socket.dropMembership(multicastAddress[, multicastInterface])


* `multicastAddress` {String}
* `multicastInterface` {String}, Optional

Instructs the kernel to leave a multicast group at `multicastAddress` using the
`IP_DROP_MEMBERSHIP` socket option. This method is automatically called by the
kernel when the socket is closed or the process terminates, so most apps will
never have reason to call this.

If `multicastInterface` is not specified, the operating system will attempt to
drop membership on all valid interfaces.

### socket.send(buf, offset, length, port, address[, callback])


* `buf` {Buffer|String} Message to be sent
* `offset` {Number} Integer. Offset in the buffer where the message starts.
* `length` {Number} Integer. Number of bytes in the message.
* `port` {Number} Integer. Destination port.
* `address` {String} Destination hostname or IP address.
* `callback` {Function} Called when the message has been sent. Optional.

Broadcasts a datagram on the socket. The destination `port` and `address` must
be specified.

The `buf` argument is a [`Buffer`] object containing the message. The `offset`
and `length` specify the offset within the `Buffer` where the message begins
and the number of bytes in the message, respectively. With messages that
contain  multi-byte characters, `offset` and `length` will be calculated with
respect to [byte length][] and not the character position.

The `address` argument is a string. If the value of `address` is a host name,
DNS will be used to resolve the address of the host. If the `address` is not
specified or is an empty string, `'0.0.0.0'` or `'::0'` will be used instead.
It is possible, depending on the network configuration, that these defaults
may not work; accordingly, it is best to be explicit about the destination
address.

If the socket has not been previously bound with a call to `bind`, the socket
is assigned a random port number and is bound to the "all interfaces" address
(`'0.0.0.0'` for `udp4` sockets, `'::0'` for `udp6` sockets.)

An optional `callback` function  may be specified to as a way of reporting
DNS errors or for determining when it is safe to reuse the `buf` object.
Note that DNS lookups delay the time to send for at least one tick of the
Node.js event loop.

The only way to know for sure that the datagram has been sent is by using a
`callback`. If an error occurs and a `callback` is given, the error will be
passed as the first argument to the `callback`. If a `callback` is not given,
the error is emitted as an `'error'` event on the `socket` object.

Example of sending a UDP packet to a random port on `localhost`;

```js
const dgram = require('dgram');
const message = new Buffer('Some bytes');
const client = dgram.createSocket('udp4');
client.send(message, 0, message.length, 41234, 'localhost', (err) => {
  client.close();
});
```

**A Note about UDP datagram size**

The maximum size of an `IPv4/v6` datagram depends on the `MTU`
(_Maximum Transmission Unit_) and on the `Payload Length` field size.

- The `Payload Length` field is `16 bits` wide, which means that a normal
  payload exceed 64K octets _including_ the internet header and data
  (65,507 bytes = 65,535 − 8 bytes UDP header − 20 bytes IP header);
  this is generally true for loopback interfaces, but such long datagram
  messages are impractical for most hosts and networks.

- The `MTU` is the largest size a given link layer technology can support for
  datagram messages. For any link, `IPv4` mandates a minimum `MTU` of `68`
  octets, while the recommended `MTU` for IPv4 is `576` (typically recommended
  as the `MTU` for dial-up type applications), whether they arrive whole or in
  fragments.

  For `IPv6`, the minimum `MTU` is `1280` octets, however, the mandatory minimum
  fragment reassembly buffer size is `1500` octets. The value of `68` octets is
  very small, since most current link layer technologies, like Ethernet, have a
  minimum `MTU` of `1500`.

It is impossible to know in advance the MTU of each link through which
a packet might travel. Sending a datagram greater than the receiver `MTU` will
not work because the packet will get silently dropped without informing the
source that the data did not reach its intended recipient.

### socket.setBroadcast(flag)

* `flag` {Boolean}

Sets or clears the `SO_BROADCAST` socket option.  When set to `true`, UDP
packets may be sent to a local interface's broadcast address.

### socket.setMulticastLoopback(flag)


* `flag` {Boolean}

Sets or clears the `IP_MULTICAST_LOOP` socket option.  When set to `true`,
multicast packets will also be received on the local interface.

### socket.setMulticastTTL(ttl)


* `ttl` {Number} Integer

Sets the `IP_MULTICAST_TTL` socket option.  While TTL generally stands for
"Time to Live", in this context it specifies the number of IP hops that a
packet is allowed to travel through, specifically for multicast traffic.  Each
router or gateway that forwards a packet decrements the TTL. If the TTL is
decremented to 0 by a router, it will not be forwarded.

The argument passed to to `socket.setMulticastTTL()` is a number of hops
between 0 and 255. The default on most systems is `1` but can vary.

### socket.setTTL(ttl)


* `ttl` {Number} Integer

Sets the `IP_TTL` socket option. While TTL generally stands for "Time to Live",
in this context it specifies the number of IP hops that a packet is allowed to
travel through.  Each router or gateway that forwards a packet decrements the
TTL.  If the TTL is decremented to 0 by a router, it will not be forwarded.
Changing TTL values is typically done for network probes or when multicasting.

The argument to `socket.setTTL()` is a number of hops between 1 and 255.
The default on most systems is 64 but can vary.

### socket.ref()


By default, binding a socket will cause it to block the Node.js process from
exiting as long as the socket is open. The `socket.unref()` method can be used
to exclude the socket from the reference counting that keeps the Node.js
process active. The `socket.ref()` method adds the socket back to the reference
counting and restores the default behavior.

Calling `socket.ref()` multiples times will have no additional effect.

The `socket.ref()` method returns a reference to the socket so calls can be
chained.

### socket.unref()


By default, binding a socket will cause it to block the Node.js process from
exiting as long as the socket is open. The `socket.unref()` method can be used
to exclude the socket from the reference counting that keeps the Node.js
process active, allowing the process to exit even if the socket is still
listening.

Calling `socket.unref()` multiple times will have no addition effect.

The `socket.unref()` method returns a reference to the socket so calls can be
chained.

### Change to asynchronous `socket.bind()` behavior

As of Node.js v0.10, [`dgram.Socket#bind()`][] changed to an asynchronous
execution model. Legacy code that assumes synchronous behavior, as in the
following example:

```js
const s = dgram.createSocket('udp4');
s.bind(1234);
s.addMembership('224.0.0.114');
```

Must be changed to pass a callback function to the [`dgram.Socket#bind()`][]
function:

```js
const s = dgram.createSocket('udp4');
s.bind(1234, () => {
  s.addMembership('224.0.0.114');
});
```

## `dgram` module functions

### dgram.createSocket(options[, callback])


* `options` {Object}
* `callback` {Function} Attached as a listener to `'message'` events.
* Returns: {dgram.Socket}

Creates a `dgram.Socket` object. The `options` argument is an object that
should contain a `type` field of either `udp4` or `udp6` and an optional
boolean `reuseAddr` field.

When `reuseAddr` is `true` [`socket.bind()`][] will reuse the address, even if
another process has already bound a socket on it. `reuseAddr` defaults to
`false`. The optional `callback` function is added as a listener for `'message'`
events.

Once the socket is created, calling [`socket.bind()`][] will instruct the
socket to begin listening for datagram messages. When `address` and `port` are
not passed to  [`socket.bind()`][] the method will bind the socket to the "all
interfaces" address on a random port (it does the right thing for both `udp4`
and `udp6` sockets). The bound address and port can be retrieved using
[`socket.address().address`][] and [`socket.address().port`][].

### dgram.createSocket(type[, callback])


* `type` {String} - Either 'udp4' or 'udp6'
* `callback` {Function} - Attached as a listener to `'message'` events.
  Optional
* Returns: {dgram.Socket}

Creates a `dgram.Socket` object of the specified `type`. The `type` argument
can be either `udp4` or `udp6`. An optional `callback` function can be passed
which is added as a listener for `'message'` events.

Once the socket is created, calling [`socket.bind()`][] will instruct the
socket to begin listening for datagram messages. When `address` and `port` are
not passed to  [`socket.bind()`][] the method will bind the socket to the "all
interfaces" address on a random port (it does the right thing for both `udp4`
and `udp6` sockets). The bound address and port can be retrieved using
[`socket.address().address`][] and [`socket.address().port`][].

[`EventEmitter`]: events.html
[`Buffer`]: buffer.html
[`'close'`]: #dgram_event_close
[`addMembership()`]: #dgram_socket_addmembership_multicastaddress_multicastinterface
[`close()`]: #dgram_socket_close_callback
[`cluster`]: cluster.html
[`dgram.createSocket()`]: #dgram_dgram_createsocket_options_callback
[`dgram.Socket#bind()`]: #dgram_socket_bind_options_callback
[`Error`]: errors.html#errors_class_error
[`socket.address().address`]: #dgram_socket_address
[`socket.address().port`]: #dgram_socket_address
[`socket.bind()`]: #dgram_socket_bind_port_address_callback
[byte length]: buffer.html#buffer_class_method_buffer_bytelength_string_encoding
node-v4.8.2/doc/api/dns.html000644 000766 000024 00000073057 13070706740 015760 0ustar00iojsstaff000000 000000 


  
  DNS | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

      

        
DNS#


Stability: 2 - Stable
The dns module contains functions belonging to two different categories:


1) Functions that use the underlying operating system facilities to perform
name resolution, and that do not necessarily perform any network communication.
This category contains only one function: dns.lookup(). Developers
looking to perform name resolution in the same way that other applications on
the same operating system behave should use dns.lookup().


For example, looking up iana.org.


const dns = require('dns');

dns.lookup('nodejs.org', (err, addresses, family) => {
  console.log('addresses:', addresses);
});
// address: "192.0.43.8" family: IPv4



2) Functions that connect to an actual DNS server to perform name resolution,
and that always use the network to perform DNS queries. This category
contains all functions in the dns module except dns.lookup(). These
functions do not use the same set of configuration files used by
dns.lookup() (e.g. /etc/hosts). These functions should be used by
developers who do not want to use the underlying operating system's facilities
for name resolution, and instead want to always perform DNS queries.


Below is an example that resolves 'archive.org' then reverse resolves the IP
addresses that are returned.


const dns = require('dns');

dns.resolve4('archive.org', (err, addresses) => {
  if (err) throw err;

  console.log(`addresses: ${JSON.stringify(addresses)}`);

  addresses.forEach((a) => {
    dns.reverse(a, (err, hostnames) => {
      if (err) {
        throw err;
      }
      console.log(`reverse for ${a}: ${JSON.stringify(hostnames)}`);
    });
  });
});



There are subtle consequences in choosing one over the other, please consult
the Implementation considerations section for more information.


dns.getServers()#



Added in: v0.11.3

Returns an array of IP address strings that are being used for name
resolution.


dns.lookup(hostname[, options], callback)#



Added in: v0.1.90

Resolves a hostname (e.g. 'nodejs.org') into the first found A (IPv4) or
AAAA (IPv6) record. options can be an object or integer. If options is
not provided, then IPv4 and IPv6 addresses are both valid. If options is
an integer, then it must be 4 or 6.


Alternatively, options can be an object containing these properties:


    

  • family <Number> - The record family. If present, must be the integer
4 or 6. If not provided, both IP v4 and v6 addresses are accepted.
    • 

  • hints: <Number> - If present, it should be one or more of the supported
getaddrinfo flags. If hints is not provided, then no flags are passed to
getaddrinfo. Multiple flags can be passed through hints by bitwise
ORing their values.
See supported getaddrinfo flags for more information on supported
flags.
    • 

  • all: <Boolean> - When true, the callback returns all resolved addresses
in an array, otherwise returns a single address. Defaults to false.
    • 



All properties are optional. An example usage of options is shown below.


{
  family: 4,
  hints: dns.ADDRCONFIG | dns.V4MAPPED,
  all: false
}

The callback function has arguments (err, address, family). address is a
string representation of an IPv4 or IPv6 address. family is either the
integer 4 or 6 and denotes the family of address (not necessarily the
value initially passed to lookup).


With the all option set to true, the arguments change to
(err, addresses), with addresses being an array of objects with the
properties address and family.


On error, err is an Error object, where err.code is the error code.
Keep in mind that err.code will be set to 'ENOENT' not only when
the hostname does not exist but also when the lookup fails in other ways
such as no available file descriptors.


dns.lookup() does not necessarily have anything to do with the DNS protocol.
The implementation uses an operating system facility that can associate names
with addresses, and vice versa. This implementation can have subtle but
important consequences on the behavior of any Node.js program. Please take some
time to consult the Implementation considerations section before using
dns.lookup().


Example usage:


const dns = require('dns');
const options = {
  family: 6,
  hints: dns.ADDRCONFIG | dns.V4MAPPED,
};
dns.lookup('example.com', options, (err, address, family) =>
  console.log('address: %j family: IPv%s', address, family));
// address: "2606:2800:220:1:248:1893:25c8:1946" family: IPv6

// When options.all is true, the result will be an Array.
options.all = true;
dns.lookup('example.com', options, (err, addresses) =>
  console.log('addresses: %j', addresses));
// addresses: [{"address":"2606:2800:220:1:248:1893:25c8:1946","family":6}]



Supported getaddrinfo flags#


The following flags can be passed as hints to dns.lookup().


    

  • dns.ADDRCONFIG: Returned address types are determined by the types
of addresses supported by the current system. For example, IPv4 addresses
are only returned if the current system has at least one IPv4 address
configured. Loopback addresses are not considered.
    • 

  • dns.V4MAPPED: If the IPv6 family was specified, but no IPv6 addresses were
found, then return IPv4 mapped IPv6 addresses. Note that it is not supported
on some operating systems (e.g FreeBSD 10.1).
    • 



dns.lookupService(address, port, callback)#



Added in: v0.11.14

Resolves the given address and port into a hostname and service using
the operating system's underlying getnameinfo implementation.


The callback has arguments (err, hostname, service). The hostname and
service arguments are strings (e.g. 'localhost' and 'http' respectively).


On error, err is an Error object, where err.code is the error code.


const dns = require('dns');
dns.lookupService('127.0.0.1', 22, (err, hostname, service) => {
  console.log(hostname, service);
    // Prints: localhost ssh
});



dns.resolve(hostname[, rrtype], callback)#



Added in: v0.1.27

Uses the DNS protocol to resolve a hostname (e.g. 'nodejs.org') into an
array of the record types specified by rrtype.


Valid values for rrtype are:


    

  • 'A' - IPV4 addresses, default
    • 

  • 'AAAA' - IPV6 addresses
    • 

  • 'MX' - mail exchange records
    • 

  • 'TXT' - text records
    • 

  • 'SRV' - SRV records
    • 

  • 'PTR' - used for reverse IP lookups
    • 

  • 'NS' - name server records
    • 

  • 'CNAME' - canonical name records
    • 

  • 'SOA' - start of authority record
    • 

  • 'NAPTR' - name authority pointer record
    • 



The callback function has arguments (err, addresses). When successful,
addresses will be an array, except when resolving an SOA record which returns
an object structured in the same manner as one returned by the
dns.resolveSoa() method. The type of each item in addresses is
determined by the record type, and described in the documentation for the
corresponding lookup methods.


On error, err is an Error object, where err.code is
one of the error codes listed here.


dns.resolve4(hostname, callback)#



Added in: v0.1.16

Uses the DNS protocol to resolve a IPv4 addresses (A records) for the
hostname. The addresses argument passed to the callback function
will contain an array of IPv4 addresses (e.g.
['74.125.79.104', '74.125.79.105', '74.125.79.106']).


dns.resolve6(hostname, callback)#



Added in: v0.1.16

Uses the DNS protocol to resolve a IPv6 addresses (AAAA records) for the
hostname. The addresses argument passed to the callback function
will contain an array of IPv6 addresses.


dns.resolveCname(hostname, callback)#



Added in: v0.3.2

Uses the DNS protocol to resolve CNAME records for the hostname. The
addresses argument passed to the callback function
will contain an array of canonical name records available for the hostname
(e.g. ['bar.example.com']).


dns.resolveMx(hostname, callback)#



Added in: v0.1.27

Uses the DNS protocol to resolve mail exchange records (MX records) for the
hostname. The addresses argument passed to the callback function will
contain an array of objects containing both a priority and exchange
property (e.g. [{priority: 10, exchange: 'mx.example.com'}, ...]).


dns.resolveNaptr(hostname, callback)#



Added in: v0.9.12

Uses the DNS protocol to resolve regular expression based records (NAPTR
records) for the hostname. The callback function has arguments
(err, addresses).  The addresses argument passed to the callback function
will contain an array of objects with the following properties:


    

  • flags
    • 

  • service
    • 

  • regexp
    • 

  • replacement
    • 

  • order
    • 

  • preference
    • 



For example:


{
  flags: 's',
  service: 'SIP+D2U',
  regexp: '',
  replacement: '_sip._udp.example.com',
  order: 30,
  preference: 100
}



dns.resolveNs(hostname, callback)#



Added in: v0.1.90

Uses the DNS protocol to resolve name server records (NS records) for the
hostname. The addresses argument passed to the callback function will
contain an array of name server records available for hostname
(e.g. ['ns1.example.com', 'ns2.example.com']).


dns.resolveSoa(hostname, callback)#



Added in: v0.11.10

Uses the DNS protocol to resolve a start of authority record (SOA record) for
the hostname. The addresses argument passed to the callback function will
be an object with the following properties:


    

  • nsname
    • 

  • hostmaster
    • 

  • serial
    • 

  • refresh
    • 

  • retry
    • 

  • expire
    • 

  • minttl
    • 



{
  nsname: 'ns.example.com',
  hostmaster: 'root.example.com',
  serial: 2013101809,
  refresh: 10000,
  retry: 2400,
  expire: 604800,
  minttl: 3600
}

dns.resolveSrv(hostname, callback)#



Added in: v0.1.27

Uses the DNS protocol to resolve service records (SRV records) for the
hostname. The addresses argument passed to the callback function will
be an array of objects with the following properties:


    

  • priority
    • 

  • weight
    • 

  • port
    • 

  • name
    • 



{
  priority: 10,
  weight: 5,
  port: 21223,
  name: 'service.example.com'
}

dns.resolveTxt(hostname, callback)#



Added in: v0.1.27

Uses the DNS protocol to resolve text queries (TXT records) for the
hostname. The addresses argument passed to the callback function is
is a two-dimentional array of the text records available for hostname (e.g.,
[ ['v=spf1 ip4:0.0.0.0 ', '~all' ] ]). Each sub-array contains TXT chunks of
one record. Depending on the use case, these could be either joined together or
treated separately.


dns.reverse(ip, callback)#



Added in: v0.1.16

Performs a reverse DNS query that resolves an IPv4 or IPv6 address to an
array of hostnames.


The callback function has arguments (err, hostnames), where hostnames
is an array of resolved hostnames for the given ip.


On error, err is an Error object, where err.code is
one of the DNS error codes.


dns.setServers(servers)#



Added in: v0.11.3

Sets the IP addresses of the servers to be used when resolving. The servers
argument is an array of IPv4 or IPv6 addresses.


If a port specified on the address it will be removed.


An error will be thrown if an invalid address is provided.


The dns.setServers() method must not be called while a DNS query is in
progress.


Error codes#


Each DNS query can return one of the following error codes:


    

  • dns.NODATA: DNS server returned answer with no data.
    • 

  • dns.FORMERR: DNS server claims query was misformatted.
    • 

  • dns.SERVFAIL: DNS server returned general failure.
    • 

  • dns.NOTFOUND: Domain name not found.
    • 

  • dns.NOTIMP: DNS server does not implement requested operation.
    • 

  • dns.REFUSED: DNS server refused query.
    • 

  • dns.BADQUERY: Misformatted DNS query.
    • 

  • dns.BADNAME: Misformatted hostname.
    • 

  • dns.BADFAMILY: Unsupported address family.
    • 

  • dns.BADRESP: Misformatted DNS reply.
    • 

  • dns.CONNREFUSED: Could not contact DNS servers.
    • 

  • dns.TIMEOUT: Timeout while contacting DNS servers.
    • 

  • dns.EOF: End of file.
    • 

  • dns.FILE: Error reading file.
    • 

  • dns.NOMEM: Out of memory.
    • 

  • dns.DESTRUCTION: Channel is being destroyed.
    • 

  • dns.BADSTR: Misformatted string.
    • 

  • dns.BADFLAGS: Illegal flags specified.
    • 

  • dns.NONAME: Given hostname is not numeric.
    • 

  • dns.BADHINTS: Illegal hints flags specified.
    • 

  • dns.NOTINITIALIZED: c-ares library initialization not yet performed.
    • 

  • dns.LOADIPHLPAPI: Error loading iphlpapi.dll.
    • 

  • dns.ADDRGETNETWORKPARAMS: Could not find GetNetworkParams function.
    • 

  • dns.CANCELLED: DNS query cancelled.
    • 



Implementation considerations#


Although dns.lookup() and the various dns.resolve*()/dns.reverse()
functions have the same goal of associating a network name with a network
address (or vice versa), their behavior is quite different. These differences
can have subtle but significant consequences on the behavior of Node.js
programs.


dns.lookup()#


Under the hood, dns.lookup() uses the same operating system facilities
as most other programs. For instance, dns.lookup() will almost always
resolve a given name the same way as the ping command. On most POSIX-like
operating systems, the behavior of the dns.lookup() function can be
modified by changing settings in nsswitch.conf(5) and/or resolv.conf(5),
but note that changing these files will change the behavior of all other
programs running on the same operating system.


Though the call to dns.lookup() will be asynchronous from JavaScript's
perspective, it is implemented as a synchronous call to getaddrinfo(3) that
runs on libuv's threadpool. Because libuv's threadpool has a fixed size, it
means that if for whatever reason the call to getaddrinfo(3) takes a long
time, other operations that could run on libuv's threadpool (such as filesystem
operations) will experience degraded performance. In order to mitigate this
issue, one potential solution is to increase the size of libuv's threadpool by
setting the 'UV_THREADPOOL_SIZE' environment variable to a value greater than
4 (its current default value). For more information on libuv's threadpool, see
the official libuv documentation.


dns.resolve(), dns.resolve*() and dns.reverse()#


These functions are implemented quite differently than dns.lookup(). They
do not use getaddrinfo(3) and they always perform a DNS query on the
network. This network communication is always done asynchronously, and does not
use libuv's threadpool.


As a result, these functions cannot have the same negative impact on other
processing that happens on libuv's threadpool that dns.lookup() can have.


They do not use the same set of configuration files than what dns.lookup()
uses. For instance, they do not use the configuration from /etc/hosts.


      

    

  

  
  
  
  



node-v4.8.2/doc/api/dns.json000644 000766 000024 00000066452 13070706740 015766 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/dns.md",
  "modules": [
    {
      "textRaw": "DNS",
      "name": "dns",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
The dns module contains functions belonging to two different categories:
\n
1) Functions that use the underlying operating system facilities to perform\nname resolution, and that do not necessarily perform any network communication.\nThis category contains only one function: dns.lookup(). Developers\nlooking to perform name resolution in the same way that other applications on\nthe same operating system behave should use dns.lookup().
\n
For example, looking up iana.org.
\n
const dns = require('dns');\n\ndns.lookup('nodejs.org', (err, addresses, family) => {\n  console.log('addresses:', addresses);\n});\n// address: "192.0.43.8" family: IPv4\n
\n
2) Functions that connect to an actual DNS server to perform name resolution,\nand that always use the network to perform DNS queries. This category\ncontains all functions in the dns module except dns.lookup(). These\nfunctions do not use the same set of configuration files used by\ndns.lookup() (e.g. /etc/hosts). These functions should be used by\ndevelopers who do not want to use the underlying operating system's facilities\nfor name resolution, and instead want to always perform DNS queries.
\n
Below is an example that resolves 'archive.org' then reverse resolves the IP\naddresses that are returned.
\n
const dns = require('dns');\n\ndns.resolve4('archive.org', (err, addresses) => {\n  if (err) throw err;\n\n  console.log(`addresses: ${JSON.stringify(addresses)}`);\n\n  addresses.forEach((a) => {\n    dns.reverse(a, (err, hostnames) => {\n      if (err) {\n        throw err;\n      }\n      console.log(`reverse for ${a}: ${JSON.stringify(hostnames)}`);\n    });\n  });\n});\n
\n
There are subtle consequences in choosing one over the other, please consult\nthe Implementation considerations section for more information.
\n",
      "methods": [
        {
          "textRaw": "dns.getServers()",
          "type": "method",
          "name": "getServers",
          "meta": {
            "added": [
              "v0.11.3"
            ]
          },
          "desc": "
Returns an array of IP address strings that are being used for name\nresolution.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "dns.lookup(hostname[, options], callback)",
          "type": "method",
          "name": "lookup",
          "meta": {
            "added": [
              "v0.1.90"
            ]
          },
          "desc": "
Resolves a hostname (e.g. 'nodejs.org') into the first found A (IPv4) or\nAAAA (IPv6) record. options can be an object or integer. If options is\nnot provided, then IPv4 and IPv6 addresses are both valid. If options is\nan integer, then it must be 4 or 6.
\n
Alternatively, options can be an object containing these properties:
\n
    \n
  • family {Number} - The record family. If present, must be the integer\n4 or 6. If not provided, both IP v4 and v6 addresses are accepted.
    • \n
  • hints: {Number} - If present, it should be one or more of the supported\ngetaddrinfo flags. If hints is not provided, then no flags are passed to\ngetaddrinfo. Multiple flags can be passed through hints by bitwise\nORing their values.\nSee supported getaddrinfo flags for more information on supported\nflags.
    • \n
  • all: {Boolean} - When true, the callback returns all resolved addresses\nin an array, otherwise returns a single address. Defaults to false.
    • \n
\n
All properties are optional. An example usage of options is shown below.
\n
{\n  family: 4,\n  hints: dns.ADDRCONFIG | dns.V4MAPPED,\n  all: false\n}\n
The callback function has arguments (err, address, family). address is a\nstring representation of an IPv4 or IPv6 address. family is either the\ninteger 4 or 6 and denotes the family of address (not necessarily the\nvalue initially passed to lookup).
\n
With the all option set to true, the arguments change to\n(err, addresses), with addresses being an array of objects with the\nproperties address and family.
\n
On error, err is an Error object, where err.code is the error code.\nKeep in mind that err.code will be set to 'ENOENT' not only when\nthe hostname does not exist but also when the lookup fails in other ways\nsuch as no available file descriptors.
\n
dns.lookup() does not necessarily have anything to do with the DNS protocol.\nThe implementation uses an operating system facility that can associate names\nwith addresses, and vice versa. This implementation can have subtle but\nimportant consequences on the behavior of any Node.js program. Please take some\ntime to consult the Implementation considerations section before using\ndns.lookup().
\n
Example usage:
\n
const dns = require('dns');\nconst options = {\n  family: 6,\n  hints: dns.ADDRCONFIG | dns.V4MAPPED,\n};\ndns.lookup('example.com', options, (err, address, family) =>\n  console.log('address: %j family: IPv%s', address, family));\n// address: "2606:2800:220:1:248:1893:25c8:1946" family: IPv6\n\n// When options.all is true, the result will be an Array.\noptions.all = true;\ndns.lookup('example.com', options, (err, addresses) =>\n  console.log('addresses: %j', addresses));\n// addresses: [{"address":"2606:2800:220:1:248:1893:25c8:1946","family":6}]\n
\n",
          "modules": [
            {
              "textRaw": "Supported getaddrinfo flags",
              "name": "supported_getaddrinfo_flags",
              "desc": "
The following flags can be passed as hints to dns.lookup().
\n
    \n
  • dns.ADDRCONFIG: Returned address types are determined by the types\nof addresses supported by the current system. For example, IPv4 addresses\nare only returned if the current system has at least one IPv4 address\nconfigured. Loopback addresses are not considered.
    • \n
  • dns.V4MAPPED: If the IPv6 family was specified, but no IPv6 addresses were\nfound, then return IPv4 mapped IPv6 addresses. Note that it is not supported\non some operating systems (e.g FreeBSD 10.1).
    • \n
\n",
              "type": "module",
              "displayName": "Supported getaddrinfo flags"
            }
          ],
          "signatures": [
            {
              "params": [
                {
                  "name": "hostname"
                },
                {
                  "name": "options",
                  "optional": true
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "dns.lookupService(address, port, callback)",
          "type": "method",
          "name": "lookupService",
          "meta": {
            "added": [
              "v0.11.14"
            ]
          },
          "desc": "
Resolves the given address and port into a hostname and service using\nthe operating system's underlying getnameinfo implementation.
\n
The callback has arguments (err, hostname, service). The hostname and\nservice arguments are strings (e.g. 'localhost' and 'http' respectively).
\n
On error, err is an Error object, where err.code is the error code.
\n
const dns = require('dns');\ndns.lookupService('127.0.0.1', 22, (err, hostname, service) => {\n  console.log(hostname, service);\n    // Prints: localhost ssh\n});\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "address"
                },
                {
                  "name": "port"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "dns.resolve(hostname[, rrtype], callback)",
          "type": "method",
          "name": "resolve",
          "meta": {
            "added": [
              "v0.1.27"
            ]
          },
          "desc": "
Uses the DNS protocol to resolve a hostname (e.g. 'nodejs.org') into an\narray of the record types specified by rrtype.
\n
Valid values for rrtype are:
\n
    \n
  • 'A' - IPV4 addresses, default
    • \n
  • 'AAAA' - IPV6 addresses
    • \n
  • 'MX' - mail exchange records
    • \n
  • 'TXT' - text records
    • \n
  • 'SRV' - SRV records
    • \n
  • 'PTR' - used for reverse IP lookups
    • \n
  • 'NS' - name server records
    • \n
  • 'CNAME' - canonical name records
    • \n
  • 'SOA' - start of authority record
    • \n
  • 'NAPTR' - name authority pointer record
    • \n
\n
The callback function has arguments (err, addresses). When successful,\naddresses will be an array, except when resolving an SOA record which returns\nan object structured in the same manner as one returned by the\ndns.resolveSoa() method. The type of each item in addresses is\ndetermined by the record type, and described in the documentation for the\ncorresponding lookup methods.
\n
On error, err is an Error object, where err.code is\none of the error codes listed here.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "hostname"
                },
                {
                  "name": "rrtype",
                  "optional": true
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "dns.resolve4(hostname, callback)",
          "type": "method",
          "name": "resolve4",
          "meta": {
            "added": [
              "v0.1.16"
            ]
          },
          "desc": "
Uses the DNS protocol to resolve a IPv4 addresses (A records) for the\nhostname. The addresses argument passed to the callback function\nwill contain an array of IPv4 addresses (e.g.\n['74.125.79.104', '74.125.79.105', '74.125.79.106']).
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "hostname"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "dns.resolve6(hostname, callback)",
          "type": "method",
          "name": "resolve6",
          "meta": {
            "added": [
              "v0.1.16"
            ]
          },
          "desc": "
Uses the DNS protocol to resolve a IPv6 addresses (AAAA records) for the\nhostname. The addresses argument passed to the callback function\nwill contain an array of IPv6 addresses.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "hostname"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "dns.resolveCname(hostname, callback)",
          "type": "method",
          "name": "resolveCname",
          "meta": {
            "added": [
              "v0.3.2"
            ]
          },
          "desc": "
Uses the DNS protocol to resolve CNAME records for the hostname. The\naddresses argument passed to the callback function\nwill contain an array of canonical name records available for the hostname\n(e.g. ['bar.example.com']).
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "hostname"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "dns.resolveMx(hostname, callback)",
          "type": "method",
          "name": "resolveMx",
          "meta": {
            "added": [
              "v0.1.27"
            ]
          },
          "desc": "
Uses the DNS protocol to resolve mail exchange records (MX records) for the\nhostname. The addresses argument passed to the callback function will\ncontain an array of objects containing both a priority and exchange\nproperty (e.g. [{priority: 10, exchange: 'mx.example.com'}, ...]).
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "hostname"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "dns.resolveNaptr(hostname, callback)",
          "type": "method",
          "name": "resolveNaptr",
          "meta": {
            "added": [
              "v0.9.12"
            ]
          },
          "desc": "
Uses the DNS protocol to resolve regular expression based records (NAPTR\nrecords) for the hostname. The callback function has arguments\n(err, addresses).  The addresses argument passed to the callback function\nwill contain an array of objects with the following properties:
\n
    \n
  • flags
    • \n
  • service
    • \n
  • regexp
    • \n
  • replacement
    • \n
  • order
    • \n
  • preference
    • \n
\n
For example:
\n
{\n  flags: 's',\n  service: 'SIP+D2U',\n  regexp: '',\n  replacement: '_sip._udp.example.com',\n  order: 30,\n  preference: 100\n}\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "hostname"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "dns.resolveNs(hostname, callback)",
          "type": "method",
          "name": "resolveNs",
          "meta": {
            "added": [
              "v0.1.90"
            ]
          },
          "desc": "
Uses the DNS protocol to resolve name server records (NS records) for the\nhostname. The addresses argument passed to the callback function will\ncontain an array of name server records available for hostname\n(e.g. ['ns1.example.com', 'ns2.example.com']).
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "hostname"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "dns.resolveSoa(hostname, callback)",
          "type": "method",
          "name": "resolveSoa",
          "meta": {
            "added": [
              "v0.11.10"
            ]
          },
          "desc": "
Uses the DNS protocol to resolve a start of authority record (SOA record) for\nthe hostname. The addresses argument passed to the callback function will\nbe an object with the following properties:
\n
    \n
  • nsname
    • \n
  • hostmaster
    • \n
  • serial
    • \n
  • refresh
    • \n
  • retry
    • \n
  • expire
    • \n
  • minttl
    • \n
\n
{\n  nsname: 'ns.example.com',\n  hostmaster: 'root.example.com',\n  serial: 2013101809,\n  refresh: 10000,\n  retry: 2400,\n  expire: 604800,\n  minttl: 3600\n}\n
",
          "signatures": [
            {
              "params": [
                {
                  "name": "hostname"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "dns.resolveSrv(hostname, callback)",
          "type": "method",
          "name": "resolveSrv",
          "meta": {
            "added": [
              "v0.1.27"
            ]
          },
          "desc": "
Uses the DNS protocol to resolve service records (SRV records) for the\nhostname. The addresses argument passed to the callback function will\nbe an array of objects with the following properties:
\n
    \n
  • priority
    • \n
  • weight
    • \n
  • port
    • \n
  • name
    • \n
\n
{\n  priority: 10,\n  weight: 5,\n  port: 21223,\n  name: 'service.example.com'\n}\n
",
          "signatures": [
            {
              "params": [
                {
                  "name": "hostname"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "dns.resolveTxt(hostname, callback)",
          "type": "method",
          "name": "resolveTxt",
          "meta": {
            "added": [
              "v0.1.27"
            ]
          },
          "desc": "
Uses the DNS protocol to resolve text queries (TXT records) for the\nhostname. The addresses argument passed to the callback function is\nis a two-dimentional array of the text records available for hostname (e.g.,\n[ ['v=spf1 ip4:0.0.0.0 ', '~all' ] ]). Each sub-array contains TXT chunks of\none record. Depending on the use case, these could be either joined together or\ntreated separately.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "hostname"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "dns.reverse(ip, callback)",
          "type": "method",
          "name": "reverse",
          "meta": {
            "added": [
              "v0.1.16"
            ]
          },
          "desc": "
Performs a reverse DNS query that resolves an IPv4 or IPv6 address to an\narray of hostnames.
\n
The callback function has arguments (err, hostnames), where hostnames\nis an array of resolved hostnames for the given ip.
\n
On error, err is an Error object, where err.code is\none of the DNS error codes.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "ip"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "dns.setServers(servers)",
          "type": "method",
          "name": "setServers",
          "meta": {
            "added": [
              "v0.11.3"
            ]
          },
          "desc": "
Sets the IP addresses of the servers to be used when resolving. The servers\nargument is an array of IPv4 or IPv6 addresses.
\n
If a port specified on the address it will be removed.
\n
An error will be thrown if an invalid address is provided.
\n
The dns.setServers() method must not be called while a DNS query is in\nprogress.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "servers"
                }
              ]
            }
          ]
        }
      ],
      "modules": [
        {
          "textRaw": "Error codes",
          "name": "error_codes",
          "desc": "
Each DNS query can return one of the following error codes:
\n
    \n
  • dns.NODATA: DNS server returned answer with no data.
    • \n
  • dns.FORMERR: DNS server claims query was misformatted.
    • \n
  • dns.SERVFAIL: DNS server returned general failure.
    • \n
  • dns.NOTFOUND: Domain name not found.
    • \n
  • dns.NOTIMP: DNS server does not implement requested operation.
    • \n
  • dns.REFUSED: DNS server refused query.
    • \n
  • dns.BADQUERY: Misformatted DNS query.
    • \n
  • dns.BADNAME: Misformatted hostname.
    • \n
  • dns.BADFAMILY: Unsupported address family.
    • \n
  • dns.BADRESP: Misformatted DNS reply.
    • \n
  • dns.CONNREFUSED: Could not contact DNS servers.
    • \n
  • dns.TIMEOUT: Timeout while contacting DNS servers.
    • \n
  • dns.EOF: End of file.
    • \n
  • dns.FILE: Error reading file.
    • \n
  • dns.NOMEM: Out of memory.
    • \n
  • dns.DESTRUCTION: Channel is being destroyed.
    • \n
  • dns.BADSTR: Misformatted string.
    • \n
  • dns.BADFLAGS: Illegal flags specified.
    • \n
  • dns.NONAME: Given hostname is not numeric.
    • \n
  • dns.BADHINTS: Illegal hints flags specified.
    • \n
  • dns.NOTINITIALIZED: c-ares library initialization not yet performed.
    • \n
  • dns.LOADIPHLPAPI: Error loading iphlpapi.dll.
    • \n
  • dns.ADDRGETNETWORKPARAMS: Could not find GetNetworkParams function.
    • \n
  • dns.CANCELLED: DNS query cancelled.
    • \n
\n",
          "type": "module",
          "displayName": "Error codes"
        },
        {
          "textRaw": "Implementation considerations",
          "name": "implementation_considerations",
          "desc": "
Although dns.lookup() and the various dns.resolve*()/dns.reverse()\nfunctions have the same goal of associating a network name with a network\naddress (or vice versa), their behavior is quite different. These differences\ncan have subtle but significant consequences on the behavior of Node.js\nprograms.
\n",
          "modules": [
            {
              "textRaw": "`dns.lookup()`",
              "name": "`dns.lookup()`",
              "desc": "
Under the hood, dns.lookup() uses the same operating system facilities\nas most other programs. For instance, dns.lookup() will almost always\nresolve a given name the same way as the ping command. On most POSIX-like\noperating systems, the behavior of the dns.lookup() function can be\nmodified by changing settings in nsswitch.conf(5) and/or resolv.conf(5),\nbut note that changing these files will change the behavior of all other\nprograms running on the same operating system.
\n
Though the call to dns.lookup() will be asynchronous from JavaScript's\nperspective, it is implemented as a synchronous call to getaddrinfo(3) that\nruns on libuv's threadpool. Because libuv's threadpool has a fixed size, it\nmeans that if for whatever reason the call to getaddrinfo(3) takes a long\ntime, other operations that could run on libuv's threadpool (such as filesystem\noperations) will experience degraded performance. In order to mitigate this\nissue, one potential solution is to increase the size of libuv's threadpool by\nsetting the 'UV_THREADPOOL_SIZE' environment variable to a value greater than\n4 (its current default value). For more information on libuv's threadpool, see\nthe official libuv documentation.
\n",
              "type": "module",
              "displayName": "`dns.lookup()`"
            },
            {
              "textRaw": "`dns.resolve()`, `dns.resolve*()` and `dns.reverse()`",
              "name": "`dns.resolve()`,_`dns.resolve*()`_and_`dns.reverse()`",
              "desc": "
These functions are implemented quite differently than dns.lookup(). They\ndo not use getaddrinfo(3) and they always perform a DNS query on the\nnetwork. This network communication is always done asynchronously, and does not\nuse libuv's threadpool.
\n
As a result, these functions cannot have the same negative impact on other\nprocessing that happens on libuv's threadpool that dns.lookup() can have.
\n
They do not use the same set of configuration files than what dns.lookup()\nuses. For instance, they do not use the configuration from /etc/hosts.
\n",
              "type": "module",
              "displayName": "`dns.resolve()`, `dns.resolve*()` and `dns.reverse()`"
            }
          ],
          "type": "module",
          "displayName": "Implementation considerations"
        }
      ],
      "type": "module",
      "displayName": "DNS"
    }
  ]
}
node-v4.8.2/doc/api/dns.md000644 000766 000024 00000036066 13070706735 015417 0ustar00iojsstaff000000 000000 # DNS

> Stability: 2 - Stable

The `dns` module contains functions belonging to two different categories:

1) Functions that use the underlying operating system facilities to perform
name resolution, and that do not necessarily perform any network communication.
This category contains only one function: [`dns.lookup()`][]. __Developers
looking to perform name resolution in the same way that other applications on
the same operating system behave should use [`dns.lookup()`][].__

For example, looking up `iana.org`.

```js
const dns = require('dns');

dns.lookup('nodejs.org', (err, addresses, family) => {
  console.log('addresses:', addresses);
});
// address: "192.0.43.8" family: IPv4
```

2) Functions that connect to an actual DNS server to perform name resolution,
and that _always_ use the network to perform DNS queries. This category
contains all functions in the `dns` module _except_ [`dns.lookup()`][]. These
functions do not use the same set of configuration files used by
[`dns.lookup()`][] (e.g. `/etc/hosts`). These functions should be used by
developers who do not want to use the underlying operating system's facilities
for name resolution, and instead want to _always_ perform DNS queries.

Below is an example that resolves `'archive.org'` then reverse resolves the IP
addresses that are returned.

```js
const dns = require('dns');

dns.resolve4('archive.org', (err, addresses) => {
  if (err) throw err;

  console.log(`addresses: ${JSON.stringify(addresses)}`);

  addresses.forEach((a) => {
    dns.reverse(a, (err, hostnames) => {
      if (err) {
        throw err;
      }
      console.log(`reverse for ${a}: ${JSON.stringify(hostnames)}`);
    });
  });
});
```

There are subtle consequences in choosing one over the other, please consult
the [Implementation considerations section][] for more information.

## dns.getServers()


Returns an array of IP address strings that are being used for name
resolution.

## dns.lookup(hostname[, options], callback)


Resolves a hostname (e.g. `'nodejs.org'`) into the first found A (IPv4) or
AAAA (IPv6) record. `options` can be an object or integer. If `options` is
not provided, then IPv4 and IPv6 addresses are both valid. If `options` is
an integer, then it must be `4` or `6`.

Alternatively, `options` can be an object containing these properties:

* `family` {Number} - The record family. If present, must be the integer
  `4` or `6`. If not provided, both IP v4 and v6 addresses are accepted.
* `hints`: {Number} - If present, it should be one or more of the supported
  `getaddrinfo` flags. If `hints` is not provided, then no flags are passed to
  `getaddrinfo`. Multiple flags can be passed through `hints` by bitwise
  `OR`ing their values.
  See [supported `getaddrinfo` flags][] for more information on supported
  flags.
* `all`: {Boolean} - When `true`, the callback returns all resolved addresses
  in an array, otherwise returns a single address. Defaults to `false`.

All properties are optional. An example usage of options is shown below.

```
{
  family: 4,
  hints: dns.ADDRCONFIG | dns.V4MAPPED,
  all: false
}
```

The `callback` function has arguments `(err, address, family)`. `address` is a
string representation of an IPv4 or IPv6 address. `family` is either the
integer `4` or `6` and denotes the family of `address` (not necessarily the
value initially passed to `lookup`).

With the `all` option set to `true`, the arguments change to
`(err, addresses)`, with `addresses` being an array of objects with the
properties `address` and `family`.

On error, `err` is an [`Error`][] object, where `err.code` is the error code.
Keep in mind that `err.code` will be set to `'ENOENT'` not only when
the hostname does not exist but also when the lookup fails in other ways
such as no available file descriptors.

`dns.lookup()` does not necessarily have anything to do with the DNS protocol.
The implementation uses an operating system facility that can associate names
with addresses, and vice versa. This implementation can have subtle but
important consequences on the behavior of any Node.js program. Please take some
time to consult the [Implementation considerations section][] before using
`dns.lookup()`.

Example usage:

```js
const dns = require('dns');
const options = {
  family: 6,
  hints: dns.ADDRCONFIG | dns.V4MAPPED,
};
dns.lookup('example.com', options, (err, address, family) =>
  console.log('address: %j family: IPv%s', address, family));
// address: "2606:2800:220:1:248:1893:25c8:1946" family: IPv6

// When options.all is true, the result will be an Array.
options.all = true;
dns.lookup('example.com', options, (err, addresses) =>
  console.log('addresses: %j', addresses));
// addresses: [{"address":"2606:2800:220:1:248:1893:25c8:1946","family":6}]
```

### Supported getaddrinfo flags

The following flags can be passed as hints to [`dns.lookup()`][].

- `dns.ADDRCONFIG`: Returned address types are determined by the types
of addresses supported by the current system. For example, IPv4 addresses
are only returned if the current system has at least one IPv4 address
configured. Loopback addresses are not considered.
- `dns.V4MAPPED`: If the IPv6 family was specified, but no IPv6 addresses were
found, then return IPv4 mapped IPv6 addresses. Note that it is not supported
on some operating systems (e.g FreeBSD 10.1).

## dns.lookupService(address, port, callback)


Resolves the given `address` and `port` into a hostname and service using
the operating system's underlying `getnameinfo` implementation.

The callback has arguments `(err, hostname, service)`. The `hostname` and
`service` arguments are strings (e.g. `'localhost'` and `'http'` respectively).

On error, `err` is an [`Error`][] object, where `err.code` is the error code.

```js
const dns = require('dns');
dns.lookupService('127.0.0.1', 22, (err, hostname, service) => {
  console.log(hostname, service);
    // Prints: localhost ssh
});
```

## dns.resolve(hostname[, rrtype], callback)


Uses the DNS protocol to resolve a hostname (e.g. `'nodejs.org'`) into an
array of the record types specified by `rrtype`.

Valid values for `rrtype` are:

 * `'A'` - IPV4 addresses, default
 * `'AAAA'` - IPV6 addresses
 * `'MX'` - mail exchange records
 * `'TXT'` - text records
 * `'SRV'` - SRV records
 * `'PTR'` - used for reverse IP lookups
 * `'NS'` - name server records
 * `'CNAME'` - canonical name records
 * `'SOA'` - start of authority record
 * `'NAPTR'` - name authority pointer record

The `callback` function has arguments `(err, addresses)`. When successful,
`addresses` will be an array, except when resolving an SOA record which returns
an object structured in the same manner as one returned by the
[`dns.resolveSoa()`][] method. The type of each item in `addresses` is
determined by the record type, and described in the documentation for the
corresponding lookup methods.

On error, `err` is an [`Error`][] object, where `err.code` is
one of the error codes listed [here](#dns_error_codes).

## dns.resolve4(hostname, callback)


Uses the DNS protocol to resolve a IPv4 addresses (`A` records) for the
`hostname`. The `addresses` argument passed to the `callback` function
will contain an array of IPv4 addresses (e.g.
`['74.125.79.104', '74.125.79.105', '74.125.79.106']`).

## dns.resolve6(hostname, callback)


Uses the DNS protocol to resolve a IPv6 addresses (`AAAA` records) for the
`hostname`. The `addresses` argument passed to the `callback` function
will contain an array of IPv6 addresses.

## dns.resolveCname(hostname, callback)


Uses the DNS protocol to resolve `CNAME` records for the `hostname`. The
`addresses` argument passed to the `callback` function
will contain an array of canonical name records available for the `hostname`
(e.g. `['bar.example.com']`).

## dns.resolveMx(hostname, callback)


Uses the DNS protocol to resolve mail exchange records (`MX` records) for the
`hostname`. The `addresses` argument passed to the `callback` function will
contain an array of objects containing both a `priority` and `exchange`
property (e.g. `[{priority: 10, exchange: 'mx.example.com'}, ...]`).

## dns.resolveNaptr(hostname, callback)


Uses the DNS protocol to resolve regular expression based records (`NAPTR`
records) for the `hostname`. The `callback` function has arguments
`(err, addresses)`.  The `addresses` argument passed to the `callback` function
will contain an array of objects with the following properties:

* `flags`
* `service`
* `regexp`
* `replacement`
* `order`
* `preference`

For example:

```js
{
  flags: 's',
  service: 'SIP+D2U',
  regexp: '',
  replacement: '_sip._udp.example.com',
  order: 30,
  preference: 100
}
```

## dns.resolveNs(hostname, callback)


Uses the DNS protocol to resolve name server records (`NS` records) for the
`hostname`. The `addresses` argument passed to the `callback` function will
contain an array of name server records available for `hostname`
(e.g. `['ns1.example.com', 'ns2.example.com']`).

## dns.resolveSoa(hostname, callback)


Uses the DNS protocol to resolve a start of authority record (`SOA` record) for
the `hostname`. The `addresses` argument passed to the `callback` function will
be an object with the following properties:

* `nsname`
* `hostmaster`
* `serial`
* `refresh`
* `retry`
* `expire`
* `minttl`

```
{
  nsname: 'ns.example.com',
  hostmaster: 'root.example.com',
  serial: 2013101809,
  refresh: 10000,
  retry: 2400,
  expire: 604800,
  minttl: 3600
}
```

## dns.resolveSrv(hostname, callback)


Uses the DNS protocol to resolve service records (`SRV` records) for the
`hostname`. The `addresses` argument passed to the `callback` function will
be an array of objects with the following properties:

* `priority`
* `weight`
* `port`
* `name`

```
{
  priority: 10,
  weight: 5,
  port: 21223,
  name: 'service.example.com'
}
```

## dns.resolveTxt(hostname, callback)


Uses the DNS protocol to resolve text queries (`TXT` records) for the
`hostname`. The `addresses` argument passed to the `callback` function is
is a two-dimentional array of the text records available for `hostname` (e.g.,
`[ ['v=spf1 ip4:0.0.0.0 ', '~all' ] ]`). Each sub-array contains TXT chunks of
one record. Depending on the use case, these could be either joined together or
treated separately.

## dns.reverse(ip, callback)


Performs a reverse DNS query that resolves an IPv4 or IPv6 address to an
array of hostnames.

The `callback` function has arguments `(err, hostnames)`, where `hostnames`
is an array of resolved hostnames for the given `ip`.

On error, `err` is an [`Error`][] object, where `err.code` is
one of the [DNS error codes][].

## dns.setServers(servers)


Sets the IP addresses of the servers to be used when resolving. The `servers`
argument is an array of IPv4 or IPv6 addresses.

If a port specified on the address it will be removed.

An error will be thrown if an invalid address is provided.

The `dns.setServers()` method must not be called while a DNS query is in
progress.

## Error codes

Each DNS query can return one of the following error codes:

- `dns.NODATA`: DNS server returned answer with no data.
- `dns.FORMERR`: DNS server claims query was misformatted.
- `dns.SERVFAIL`: DNS server returned general failure.
- `dns.NOTFOUND`: Domain name not found.
- `dns.NOTIMP`: DNS server does not implement requested operation.
- `dns.REFUSED`: DNS server refused query.
- `dns.BADQUERY`: Misformatted DNS query.
- `dns.BADNAME`: Misformatted hostname.
- `dns.BADFAMILY`: Unsupported address family.
- `dns.BADRESP`: Misformatted DNS reply.
- `dns.CONNREFUSED`: Could not contact DNS servers.
- `dns.TIMEOUT`: Timeout while contacting DNS servers.
- `dns.EOF`: End of file.
- `dns.FILE`: Error reading file.
- `dns.NOMEM`: Out of memory.
- `dns.DESTRUCTION`: Channel is being destroyed.
- `dns.BADSTR`: Misformatted string.
- `dns.BADFLAGS`: Illegal flags specified.
- `dns.NONAME`: Given hostname is not numeric.
- `dns.BADHINTS`: Illegal hints flags specified.
- `dns.NOTINITIALIZED`: c-ares library initialization not yet performed.
- `dns.LOADIPHLPAPI`: Error loading iphlpapi.dll.
- `dns.ADDRGETNETWORKPARAMS`: Could not find GetNetworkParams function.
- `dns.CANCELLED`: DNS query cancelled.

## Implementation considerations

Although [`dns.lookup()`][] and the various `dns.resolve*()/dns.reverse()`
functions have the same goal of associating a network name with a network
address (or vice versa), their behavior is quite different. These differences
can have subtle but significant consequences on the behavior of Node.js
programs.

### `dns.lookup()`

Under the hood, [`dns.lookup()`][] uses the same operating system facilities
as most other programs. For instance, [`dns.lookup()`][] will almost always
resolve a given name the same way as the `ping` command. On most POSIX-like
operating systems, the behavior of the [`dns.lookup()`][] function can be
modified by changing settings in nsswitch.conf(5) and/or resolv.conf(5),
but note that changing these files will change the behavior of _all other
programs running on the same operating system_.

Though the call to `dns.lookup()` will be asynchronous from JavaScript's
perspective, it is implemented as a synchronous call to getaddrinfo(3) that
runs on libuv's threadpool. Because libuv's threadpool has a fixed size, it
means that if for whatever reason the call to getaddrinfo(3) takes a long
time, other operations that could run on libuv's threadpool (such as filesystem
operations) will experience degraded performance. In order to mitigate this
issue, one potential solution is to increase the size of libuv's threadpool by
setting the `'UV_THREADPOOL_SIZE'` environment variable to a value greater than
`4` (its current default value). For more information on libuv's threadpool, see
[the official libuv documentation][].

### `dns.resolve()`, `dns.resolve*()` and `dns.reverse()`

These functions are implemented quite differently than [`dns.lookup()`][]. They
do not use getaddrinfo(3) and they _always_ perform a DNS query on the
network. This network communication is always done asynchronously, and does not
use libuv's threadpool.

As a result, these functions cannot have the same negative impact on other
processing that happens on libuv's threadpool that [`dns.lookup()`][] can have.

They do not use the same set of configuration files than what [`dns.lookup()`][]
uses. For instance, _they do not use the configuration from `/etc/hosts`_.

[DNS error codes]: #dns_error_codes
[`dns.lookup()`]: #dns_dns_lookup_hostname_options_callback
[`dns.resolve()`]: #dns_dns_resolve_hostname_rrtype_callback
[`dns.resolve4()`]: #dns_dns_resolve4_hostname_callback
[`dns.resolveSoa()`]: #dns_dns_resolvesoa_hostname_callback
[`Error`]: errors.html#errors_class_error
[Implementation considerations section]: #dns_implementation_considerations
[supported `getaddrinfo` flags]: #dns_supported_getaddrinfo_flags
[the official libuv documentation]: http://docs.libuv.org/en/latest/threadpool.html
node-v4.8.2/doc/api/documentation.html000644 000766 000024 00000021747 13070706740 020044 0ustar00iojsstaff000000 000000 


  
  About this Documentation | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

      

        
About this Documentation#



The goal of this documentation is to comprehensively explain the Node.js
API, both from a reference as well as a conceptual point of view.  Each
section describes a built-in module or high-level concept.


Where appropriate, property types, method arguments, and the arguments
provided to event handlers are detailed in a list underneath the topic
heading.


Every .html document has a corresponding .json document presenting
the same information in a structured manner.  This feature is
experimental, and added for the benefit of IDEs and other utilities that
wish to do programmatic things with the documentation.


Every .html and .json file is generated based on the corresponding
.md file in the doc/api/ folder in Node.js's source tree.  The
documentation is generated using the tools/doc/generate.js program.
The HTML template is located at doc/template.html.


If you find an error in this documentation, please submit an issue
or see the contributing guide for directions on how to submit a patch.


Stability Index#



Throughout the documentation, you will see indications of a section's
stability.  The Node.js API is still somewhat changing, and as it
matures, certain parts are more reliable than others.  Some are so
proven, and so relied upon, that they are unlikely to ever change at
all.  Others are brand new and experimental, or known to be hazardous
and in the process of being redesigned.


The stability indices are as follows:


Stability: 0 - Deprecated This feature is known to be problematic, and changes are planned.  Do not rely on it.  Use of the feature may cause warnings.  Backwards compatibility should not be expected.
Stability: 1 - Experimental This feature is subject to change, and is gated by a command line flag. It may change or be removed in future versions.
Stability: 2 - Stable The API has proven satisfactory. Compatibility with the npm ecosystem is a high priority, and will not be broken unless absolutely necessary.
Stability: 3 - Locked Only bug fixes, security fixes, and performance improvements will be accepted. Please do not suggest API changes in this area; they will be refused.
JSON Output#


Stability: 1 - Experimental
Every HTML file in the markdown has a corresponding JSON file with the
same data.


This feature was added in Node.js v0.6.12.  It is experimental.


Syscalls and man pages#


System calls like open(2) and read(2) define the interface between user programs
and the underlying operating system. Node functions which simply wrap a syscall,
like fs.open(), will document that. The docs link to the corresponding man
pages (short for manual pages) which describe how the syscalls work.


Caveat: some syscalls, like lchown(2), are BSD-specific. That means, for
example, that fs.lchown() only works on Mac OS X and other BSD-derived systems,
and is not available on Linux.


Most Unix syscalls have Windows equivalents, but behavior may differ on Windows
relative to Linux and OS X. For an example of the subtle ways in which it's
sometimes impossible to replace Unix syscall semantics on Windows, see Node
issue 4760.


      

    

  

  
  
  
  



node-v4.8.2/doc/api/documentation.json000644 000766 000024 00000010445 13070706740 020042 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/documentation.md",
  "miscs": [
    {
      "textRaw": "About this Documentation",
      "name": "About this Documentation",
      "type": "misc",
      "desc": "
The goal of this documentation is to comprehensively explain the Node.js\nAPI, both from a reference as well as a conceptual point of view.  Each\nsection describes a built-in module or high-level concept.
\n
Where appropriate, property types, method arguments, and the arguments\nprovided to event handlers are detailed in a list underneath the topic\nheading.
\n
Every .html document has a corresponding .json document presenting\nthe same information in a structured manner.  This feature is\nexperimental, and added for the benefit of IDEs and other utilities that\nwish to do programmatic things with the documentation.
\n
Every .html and .json file is generated based on the corresponding\n.md file in the doc/api/ folder in Node.js's source tree.  The\ndocumentation is generated using the tools/doc/generate.js program.\nThe HTML template is located at doc/template.html.
\n
If you find an error in this documentation, please submit an issue\nor see the contributing guide for directions on how to submit a patch.
\n",
      "miscs": [
        {
          "textRaw": "Stability Index",
          "name": "Stability Index",
          "type": "misc",
          "desc": "
Throughout the documentation, you will see indications of a section's\nstability.  The Node.js API is still somewhat changing, and as it\nmatures, certain parts are more reliable than others.  Some are so\nproven, and so relied upon, that they are unlikely to ever change at\nall.  Others are brand new and experimental, or known to be hazardous\nand in the process of being redesigned.
\n
The stability indices are as follows:
\n
Stability: 0 - Deprecated\nThis feature is known to be problematic, and changes are\nplanned.  Do not rely on it.  Use of the feature may cause warnings.  Backwards\ncompatibility should not be expected.\n
Stability: 1 - Experimental\nThis feature is subject to change, and is gated by a command line flag.\nIt may change or be removed in future versions.\n
Stability: 2 - Stable\nThe API has proven satisfactory. Compatibility with the npm ecosystem\nis a high priority, and will not be broken unless absolutely necessary.\n
Stability: 3 - Locked\nOnly bug fixes, security fixes, and performance improvements will be accepted.\nPlease do not suggest API changes in this area; they will be refused.\n
"
        },
        {
          "textRaw": "JSON Output",
          "name": "json_output",
          "stability": 1,
          "stabilityText": "Experimental",
          "desc": "
Every HTML file in the markdown has a corresponding JSON file with the\nsame data.
\n
This feature was added in Node.js v0.6.12.  It is experimental.
\n",
          "type": "misc",
          "displayName": "JSON Output"
        },
        {
          "textRaw": "Syscalls and man pages",
          "name": "syscalls_and_man_pages",
          "desc": "
System calls like open(2) and read(2) define the interface between user programs\nand the underlying operating system. Node functions which simply wrap a syscall,\nlike fs.open(), will document that. The docs link to the corresponding man\npages (short for manual pages) which describe how the syscalls work.
\n
Caveat: some syscalls, like lchown(2), are BSD-specific. That means, for\nexample, that fs.lchown() only works on Mac OS X and other BSD-derived systems,\nand is not available on Linux.
\n
Most Unix syscalls have Windows equivalents, but behavior may differ on Windows\nrelative to Linux and OS X. For an example of the subtle ways in which it's\nsometimes impossible to replace Unix syscall semantics on Windows, see Node\nissue 4760.
\n",
          "type": "misc",
          "displayName": "Syscalls and man pages"
        }
      ]
    }
  ]
}
node-v4.8.2/doc/api/documentation.md000644 000766 000024 00000006530 13070706735 017475 0ustar00iojsstaff000000 000000 # About this Documentation



The goal of this documentation is to comprehensively explain the Node.js
API, both from a reference as well as a conceptual point of view.  Each
section describes a built-in module or high-level concept.

Where appropriate, property types, method arguments, and the arguments
provided to event handlers are detailed in a list underneath the topic
heading.

Every `.html` document has a corresponding `.json` document presenting
the same information in a structured manner.  This feature is
experimental, and added for the benefit of IDEs and other utilities that
wish to do programmatic things with the documentation.

Every `.html` and `.json` file is generated based on the corresponding
`.md` file in the `doc/api/` folder in Node.js's source tree.  The
documentation is generated using the `tools/doc/generate.js` program.
The HTML template is located at `doc/template.html`.


If you find an error in this documentation, please [submit an issue][]
or see [the contributing guide][] for directions on how to submit a patch.

## Stability Index



Throughout the documentation, you will see indications of a section's
stability.  The Node.js API is still somewhat changing, and as it
matures, certain parts are more reliable than others.  Some are so
proven, and so relied upon, that they are unlikely to ever change at
all.  Others are brand new and experimental, or known to be hazardous
and in the process of being redesigned.

The stability indices are as follows:

```
Stability: 0 - Deprecated
This feature is known to be problematic, and changes are
planned.  Do not rely on it.  Use of the feature may cause warnings.  Backwards
compatibility should not be expected.
```

```
Stability: 1 - Experimental
This feature is subject to change, and is gated by a command line flag.
It may change or be removed in future versions.
```

```
Stability: 2 - Stable
The API has proven satisfactory. Compatibility with the npm ecosystem
is a high priority, and will not be broken unless absolutely necessary.
```

```
Stability: 3 - Locked
Only bug fixes, security fixes, and performance improvements will be accepted.
Please do not suggest API changes in this area; they will be refused.
```

## JSON Output

> Stability: 1 - Experimental

Every HTML file in the markdown has a corresponding JSON file with the
same data.

This feature was added in Node.js v0.6.12.  It is experimental.

## Syscalls and man pages

System calls like open(2) and read(2) define the interface between user programs
and the underlying operating system. Node functions which simply wrap a syscall,
like `fs.open()`, will document that. The docs link to the corresponding man
pages (short for manual pages) which describe how the syscalls work.

**Caveat:** some syscalls, like lchown(2), are BSD-specific. That means, for
example, that `fs.lchown()` only works on Mac OS X and other BSD-derived systems,
and is not available on Linux.

Most Unix syscalls have Windows equivalents, but behavior may differ on Windows
relative to Linux and OS X. For an example of the subtle ways in which it's
sometimes impossible to replace Unix syscall semantics on Windows, see [Node
issue 4760](https://github.com/nodejs/node/issues/4760).

[submit an issue]: https://github.com/nodejs/node/issues/new
[the contributing guide]: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md
node-v4.8.2/doc/api/domain.html000644 000766 000024 00000062371 13070706740 016440 0ustar00iojsstaff000000 000000 


  
  Domain | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

      

        
Domain#


Stability: 0 - Deprecated
This module is pending deprecation. Once a replacement API has been
finalized, this module will be fully deprecated. Most end users should
not have cause to use this module. Users who absolutely must have
the functionality that domains provide may rely on it for the time being
but should expect to have to migrate to a different solution
in the future.


Domains provide a way to handle multiple different IO operations as a
single group.  If any of the event emitters or callbacks registered to a
domain emit an 'error' event, or throw an error, then the domain object
will be notified, rather than losing the context of the error in the
process.on('uncaughtException') handler, or causing the program to
exit immediately with an error code.


Warning: Don't Ignore Errors!#



Domain error handlers are not a substitute for closing down your
process when an error occurs.


By the very nature of how throw works in JavaScript, there is almost
never any way to safely "pick up where you left off", without leaking
references, or creating some other sort of undefined brittle state.


The safest way to respond to a thrown error is to shut down the
process.  Of course, in a normal web server, you might have many
connections open, and it is not reasonable to abruptly shut those down
because an error was triggered by someone else.


The better approach is to send an error response to the request that
triggered the error, while letting the others finish in their normal
time, and stop listening for new requests in that worker.


In this way, domain usage goes hand-in-hand with the cluster module,
since the master process can fork a new worker when a worker
encounters an error.  For Node.js programs that scale to multiple
machines, the terminating proxy or service registry can take note of
the failure, and react accordingly.


For example, this is not a good idea:


// XXX WARNING!  BAD IDEA!

const d = require('domain').create();
d.on('error', (er) => {
  // The error won't crash the process, but what it does is worse!
  // Though we've prevented abrupt process restarting, we are leaking
  // resources like crazy if this ever happens.
  // This is no better than process.on('uncaughtException')!
  console.log(`error, but oh well ${er.message}`);
});
d.run(() => {
  require('http').createServer((req, res) => {
    handleRequest(req, res);
  }).listen(PORT);
});



By using the context of a domain, and the resilience of separating our
program into multiple worker processes, we can react more
appropriately, and handle errors with much greater safety.


// Much better!

const cluster = require('cluster');
const PORT = +process.env.PORT || 1337;

if (cluster.isMaster) {
  // In real life, you'd probably use more than just 2 workers,
  // and perhaps not put the master and worker in the same file.
  //
  // You can also of course get a bit fancier about logging, and
  // implement whatever custom logic you need to prevent DoS
  // attacks and other bad behavior.
  //
  // See the options in the cluster documentation.
  //
  // The important thing is that the master does very little,
  // increasing our resilience to unexpected errors.

  cluster.fork();
  cluster.fork();

  cluster.on('disconnect', (worker) => {
    console.error('disconnect!');
    cluster.fork();
  });

} else {
  // the worker
  //
  // This is where we put our bugs!

  const domain = require('domain');

  // See the cluster documentation for more details about using
  // worker processes to serve requests.  How it works, caveats, etc.

  const server = require('http').createServer((req, res) => {
    const d = domain.create();
    d.on('error', (er) => {
      console.error(`error ${er.stack}`);

      // Note: we're in dangerous territory!
      // By definition, something unexpected occurred,
      // which we probably didn't want.
      // Anything can happen now!  Be very careful!

      try {
        // make sure we close down within 30 seconds
        const killtimer = setTimeout(() => {
          process.exit(1);
        }, 30000);
        // But don't keep the process open just for that!
        killtimer.unref();

        // stop taking new requests.
        server.close();

        // Let the master know we're dead.  This will trigger a
        // 'disconnect' in the cluster master, and then it will fork
        // a new worker.
        cluster.worker.disconnect();

        // try to send an error to the request that triggered the problem
        res.statusCode = 500;
        res.setHeader('content-type', 'text/plain');
        res.end('Oops, there was a problem!\n');
      } catch (er2) {
        // oh well, not much we can do at this point.
        console.error(`Error sending 500! ${er2.stack}`);
      }
    });

    // Because req and res were created before this domain existed,
    // we need to explicitly add them.
    // See the explanation of implicit vs explicit binding below.
    d.add(req);
    d.add(res);

    // Now run the handler function in the domain.
    d.run(() => {
      handleRequest(req, res);
    });
  });
  server.listen(PORT);
}

// This part isn't important.  Just an example routing thing.
// You'd put your fancy application logic here.
function handleRequest(req, res) {
  switch (req.url) {
    case '/error':
      // We do some async stuff, and then...
      setTimeout(() => {
        // Whoops!
        flerb.bark();
      });
      break;
    default:
      res.end('ok');
  }
}



Additions to Error objects#



Any time an Error object is routed through a domain, a few extra fields
are added to it.


    

  • error.domain The domain that first handled the error.
    • 

  • error.domainEmitter The event emitter that emitted an 'error' event
with the error object.
    • 

  • error.domainBound The callback function which was bound to the
domain, and passed an error as its first argument.
    • 

  • error.domainThrown A boolean indicating whether the error was
thrown, emitted, or passed to a bound callback function.
    • 



Implicit Binding#



If domains are in use, then all new EventEmitter objects (including
Stream objects, requests, responses, etc.) will be implicitly bound to
the active domain at the time of their creation.


Additionally, callbacks passed to lowlevel event loop requests (such as
to fs.open, or other callback-taking methods) will automatically be
bound to the active domain.  If they throw, then the domain will catch
the error.


In order to prevent excessive memory usage, Domain objects themselves
are not implicitly added as children of the active domain.  If they
were, then it would be too easy to prevent request and response objects
from being properly garbage collected.


If you want to nest Domain objects as children of a parent Domain,
then you must explicitly add them.


Implicit binding routes thrown errors and 'error' events to the
Domain's 'error' event, but does not register the EventEmitter on the
Domain, so domain.dispose() will not shut down the EventEmitter.
Implicit binding only takes care of thrown errors and 'error' events.


Explicit Binding#



Sometimes, the domain in use is not the one that ought to be used for a
specific event emitter.  Or, the event emitter could have been created
in the context of one domain, but ought to instead be bound to some
other domain.


For example, there could be one domain in use for an HTTP server, but
perhaps we would like to have a separate domain to use for each request.


That is possible via explicit binding.


For example:


// create a top-level domain for the server
const domain = require('domain');
const http = require('http');
const serverDomain = domain.create();

serverDomain.run(() => {
  // server is created in the scope of serverDomain
  http.createServer((req, res) => {
    // req and res are also created in the scope of serverDomain
    // however, we'd prefer to have a separate domain for each request.
    // create it first thing, and add req and res to it.
    const reqd = domain.create();
    reqd.add(req);
    reqd.add(res);
    reqd.on('error', (er) => {
      console.error('Error', er, req.url);
      try {
        res.writeHead(500);
        res.end('Error occurred, sorry.');
      } catch (er2) {
        console.error('Error sending 500', er2, req.url);
      }
    });
  }).listen(1337);
});



domain.create()#


    

  • Returns: <Domain>
    • 



Returns a new Domain object.


Class: Domain#


The Domain class encapsulates the functionality of routing errors and
uncaught exceptions to the active Domain object.


Domain is a child class of EventEmitter.  To handle the errors that it
catches, listen to its 'error' event.


domain.run(fn[, arg][, ...])#




Run the supplied function in the context of the domain, implicitly
binding all event emitters, timers, and lowlevel requests that are
created in that context. Optionally, arguments can be passed to
the function.


This is the most basic way to use a domain.


Example:


const domain = require('domain');
const fs = require('fs');
const d = domain.create();
d.on('error', (er) => {
  console.error('Caught error!', er);
});
d.run(() => {
  process.nextTick(() => {
    setTimeout(() => { // simulating some various async stuff
      fs.open('non-existent file', 'r', (er, fd) => {
        if (er) throw er;
        // proceed...
      });
    }, 100);
  });
});



In this example, the d.on('error') handler will be triggered, rather
than crashing the program.


domain.members#




An array of timers and event emitters that have been explicitly added
to the domain.


domain.add(emitter)#




Explicitly adds an emitter to the domain.  If any event handlers called by
the emitter throw an error, or if the emitter emits an 'error' event, it
will be routed to the domain's 'error' event, just like with implicit
binding.


This also works with timers that are returned from setInterval() and
setTimeout().  If their callback function throws, it will be caught by
the domain 'error' handler.


If the Timer or EventEmitter was already bound to a domain, it is removed
from that one, and bound to this one instead.


domain.remove(emitter)#




The opposite of domain.add(emitter).  Removes domain handling from the
specified emitter.


domain.bind(callback)#




The returned function will be a wrapper around the supplied callback
function.  When the returned function is called, any errors that are
thrown will be routed to the domain's 'error' event.


Example#


const d = domain.create();

function readSomeFile(filename, cb) {
  fs.readFile(filename, 'utf8', d.bind((er, data) => {
    // if this throws, it will also be passed to the domain
    return cb(er, data ? JSON.parse(data) : null);
  }));
}

d.on('error', (er) => {
  // an error occurred somewhere.
  // if we throw it now, it will crash the program
  // with the normal line number and stack message.
});



domain.intercept(callback)#




This method is almost identical to domain.bind(callback).  However, in
addition to catching thrown errors, it will also intercept Error
objects sent as the first argument to the function.


In this way, the common if (err) return callback(err); pattern can be replaced
with a single error handler in a single place.


Example#


const d = domain.create();

function readSomeFile(filename, cb) {
  fs.readFile(filename, 'utf8', d.intercept((data) => {
    // note, the first argument is never passed to the
    // callback since it is assumed to be the 'Error' argument
    // and thus intercepted by the domain.

    // if this throws, it will also be passed to the domain
    // so the error-handling logic can be moved to the 'error'
    // event on the domain instead of being repeated throughout
    // the program.
    return cb(null, JSON.parse(data));
  }));
}

d.on('error', (er) => {
  // an error occurred somewhere.
  // if we throw it now, it will crash the program
  // with the normal line number and stack message.
});



domain.enter()#


The enter method is plumbing used by the run, bind, and intercept
methods to set the active domain. It sets domain.active and process.domain
to the domain, and implicitly pushes the domain onto the domain stack managed
by the domain module (see domain.exit() for details on the domain stack). The
call to enter delimits the beginning of a chain of asynchronous calls and I/O
operations bound to a domain.


Calling enter changes only the active domain, and does not alter the domain
itself. enter and exit can be called an arbitrary number of times on a
single domain.


If the domain on which enter is called has been disposed, enter will return
without setting the domain.


domain.exit()#


The exit method exits the current domain, popping it off the domain stack.
Any time execution is going to switch to the context of a different chain of
asynchronous calls, it's important to ensure that the current domain is exited.
The call to exit delimits either the end of or an interruption to the chain
of asynchronous calls and I/O operations bound to a domain.


If there are multiple, nested domains bound to the current execution context,
exit will exit any domains nested within this domain.


Calling exit changes only the active domain, and does not alter the domain
itself. enter and exit can be called an arbitrary number of times on a
single domain.


If the domain on which exit is called has been disposed, exit will return
without exiting the domain.


domain.dispose()#


Stability: 0 - Deprecated.  Please recover from failed IO actions explicitly via error event handlers set on the domain.
Once dispose has been called, the domain will no longer be used by callbacks
bound into the domain via run, bind, or intercept, and a 'dispose' event
is emitted.


      

    

  

  
  
  
  



node-v4.8.2/doc/api/domain.json000644 000766 000024 00000055236 13070706740 016447 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/domain.md",
  "modules": [
    {
      "textRaw": "Domain",
      "name": "domain",
      "stability": 0,
      "stabilityText": "Deprecated",
      "desc": "
This module is pending deprecation. Once a replacement API has been\nfinalized, this module will be fully deprecated. Most end users should\nnot have cause to use this module. Users who absolutely must have\nthe functionality that domains provide may rely on it for the time being\nbut should expect to have to migrate to a different solution\nin the future.
\n
Domains provide a way to handle multiple different IO operations as a\nsingle group.  If any of the event emitters or callbacks registered to a\ndomain emit an 'error' event, or throw an error, then the domain object\nwill be notified, rather than losing the context of the error in the\nprocess.on('uncaughtException') handler, or causing the program to\nexit immediately with an error code.
\n",
      "miscs": [
        {
          "textRaw": "Warning: Don't Ignore Errors!",
          "name": "Warning: Don't Ignore Errors!",
          "type": "misc",
          "desc": "
Domain error handlers are not a substitute for closing down your\nprocess when an error occurs.
\n
By the very nature of how throw works in JavaScript, there is almost\nnever any way to safely "pick up where you left off", without leaking\nreferences, or creating some other sort of undefined brittle state.
\n
The safest way to respond to a thrown error is to shut down the\nprocess.  Of course, in a normal web server, you might have many\nconnections open, and it is not reasonable to abruptly shut those down\nbecause an error was triggered by someone else.
\n
The better approach is to send an error response to the request that\ntriggered the error, while letting the others finish in their normal\ntime, and stop listening for new requests in that worker.
\n
In this way, domain usage goes hand-in-hand with the cluster module,\nsince the master process can fork a new worker when a worker\nencounters an error.  For Node.js programs that scale to multiple\nmachines, the terminating proxy or service registry can take note of\nthe failure, and react accordingly.
\n
For example, this is not a good idea:
\n
// XXX WARNING!  BAD IDEA!\n\nconst d = require('domain').create();\nd.on('error', (er) => {\n  // The error won't crash the process, but what it does is worse!\n  // Though we've prevented abrupt process restarting, we are leaking\n  // resources like crazy if this ever happens.\n  // This is no better than process.on('uncaughtException')!\n  console.log(`error, but oh well ${er.message}`);\n});\nd.run(() => {\n  require('http').createServer((req, res) => {\n    handleRequest(req, res);\n  }).listen(PORT);\n});\n
\n
By using the context of a domain, and the resilience of separating our\nprogram into multiple worker processes, we can react more\nappropriately, and handle errors with much greater safety.
\n
// Much better!\n\nconst cluster = require('cluster');\nconst PORT = +process.env.PORT || 1337;\n\nif (cluster.isMaster) {\n  // In real life, you'd probably use more than just 2 workers,\n  // and perhaps not put the master and worker in the same file.\n  //\n  // You can also of course get a bit fancier about logging, and\n  // implement whatever custom logic you need to prevent DoS\n  // attacks and other bad behavior.\n  //\n  // See the options in the cluster documentation.\n  //\n  // The important thing is that the master does very little,\n  // increasing our resilience to unexpected errors.\n\n  cluster.fork();\n  cluster.fork();\n\n  cluster.on('disconnect', (worker) => {\n    console.error('disconnect!');\n    cluster.fork();\n  });\n\n} else {\n  // the worker\n  //\n  // This is where we put our bugs!\n\n  const domain = require('domain');\n\n  // See the cluster documentation for more details about using\n  // worker processes to serve requests.  How it works, caveats, etc.\n\n  const server = require('http').createServer((req, res) => {\n    const d = domain.create();\n    d.on('error', (er) => {\n      console.error(`error ${er.stack}`);\n\n      // Note: we're in dangerous territory!\n      // By definition, something unexpected occurred,\n      // which we probably didn't want.\n      // Anything can happen now!  Be very careful!\n\n      try {\n        // make sure we close down within 30 seconds\n        const killtimer = setTimeout(() => {\n          process.exit(1);\n        }, 30000);\n        // But don't keep the process open just for that!\n        killtimer.unref();\n\n        // stop taking new requests.\n        server.close();\n\n        // Let the master know we're dead.  This will trigger a\n        // 'disconnect' in the cluster master, and then it will fork\n        // a new worker.\n        cluster.worker.disconnect();\n\n        // try to send an error to the request that triggered the problem\n        res.statusCode = 500;\n        res.setHeader('content-type', 'text/plain');\n        res.end('Oops, there was a problem!\\n');\n      } catch (er2) {\n        // oh well, not much we can do at this point.\n        console.error(`Error sending 500! ${er2.stack}`);\n      }\n    });\n\n    // Because req and res were created before this domain existed,\n    // we need to explicitly add them.\n    // See the explanation of implicit vs explicit binding below.\n    d.add(req);\n    d.add(res);\n\n    // Now run the handler function in the domain.\n    d.run(() => {\n      handleRequest(req, res);\n    });\n  });\n  server.listen(PORT);\n}\n\n// This part isn't important.  Just an example routing thing.\n// You'd put your fancy application logic here.\nfunction handleRequest(req, res) {\n  switch (req.url) {\n    case '/error':\n      // We do some async stuff, and then...\n      setTimeout(() => {\n        // Whoops!\n        flerb.bark();\n      });\n      break;\n    default:\n      res.end('ok');\n  }\n}\n
\n"
        },
        {
          "textRaw": "Additions to Error objects",
          "name": "Additions to Error objects",
          "type": "misc",
          "desc": "
Any time an Error object is routed through a domain, a few extra fields\nare added to it.
\n
    \n
  • error.domain The domain that first handled the error.
    • \n
  • error.domainEmitter The event emitter that emitted an 'error' event\nwith the error object.
    • \n
  • error.domainBound The callback function which was bound to the\ndomain, and passed an error as its first argument.
    • \n
  • error.domainThrown A boolean indicating whether the error was\nthrown, emitted, or passed to a bound callback function.
    • \n
\n"
        },
        {
          "textRaw": "Implicit Binding",
          "name": "Implicit Binding",
          "type": "misc",
          "desc": "
If domains are in use, then all new EventEmitter objects (including\nStream objects, requests, responses, etc.) will be implicitly bound to\nthe active domain at the time of their creation.
\n
Additionally, callbacks passed to lowlevel event loop requests (such as\nto fs.open, or other callback-taking methods) will automatically be\nbound to the active domain.  If they throw, then the domain will catch\nthe error.
\n
In order to prevent excessive memory usage, Domain objects themselves\nare not implicitly added as children of the active domain.  If they\nwere, then it would be too easy to prevent request and response objects\nfrom being properly garbage collected.
\n
If you want to nest Domain objects as children of a parent Domain,\nthen you must explicitly add them.
\n
Implicit binding routes thrown errors and 'error' events to the\nDomain's 'error' event, but does not register the EventEmitter on the\nDomain, so domain.dispose() will not shut down the EventEmitter.\nImplicit binding only takes care of thrown errors and 'error' events.
\n"
        },
        {
          "textRaw": "Explicit Binding",
          "name": "Explicit Binding",
          "type": "misc",
          "desc": "
Sometimes, the domain in use is not the one that ought to be used for a\nspecific event emitter.  Or, the event emitter could have been created\nin the context of one domain, but ought to instead be bound to some\nother domain.
\n
For example, there could be one domain in use for an HTTP server, but\nperhaps we would like to have a separate domain to use for each request.
\n
That is possible via explicit binding.
\n
For example:
\n
// create a top-level domain for the server\nconst domain = require('domain');\nconst http = require('http');\nconst serverDomain = domain.create();\n\nserverDomain.run(() => {\n  // server is created in the scope of serverDomain\n  http.createServer((req, res) => {\n    // req and res are also created in the scope of serverDomain\n    // however, we'd prefer to have a separate domain for each request.\n    // create it first thing, and add req and res to it.\n    const reqd = domain.create();\n    reqd.add(req);\n    reqd.add(res);\n    reqd.on('error', (er) => {\n      console.error('Error', er, req.url);\n      try {\n        res.writeHead(500);\n        res.end('Error occurred, sorry.');\n      } catch (er2) {\n        console.error('Error sending 500', er2, req.url);\n      }\n    });\n  }).listen(1337);\n});\n
\n"
        }
      ],
      "methods": [
        {
          "textRaw": "domain.create()",
          "type": "method",
          "name": "create",
          "signatures": [
            {
              "return": {
                "textRaw": "Returns: {Domain} ",
                "name": "return",
                "type": "Domain"
              },
              "params": []
            },
            {
              "params": []
            }
          ],
          "desc": "
Returns a new Domain object.
\n"
        }
      ],
      "classes": [
        {
          "textRaw": "Class: Domain",
          "type": "class",
          "name": "Domain",
          "desc": "
The Domain class encapsulates the functionality of routing errors and\nuncaught exceptions to the active Domain object.
\n
Domain is a child class of EventEmitter.  To handle the errors that it\ncatches, listen to its 'error' event.
\n",
          "methods": [
            {
              "textRaw": "domain.run(fn[, arg][, ...])",
              "type": "method",
              "name": "run",
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`fn` {Function} ",
                      "name": "fn",
                      "type": "Function"
                    },
                    {
                      "name": "arg",
                      "optional": true
                    },
                    {
                      "name": "...",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "fn"
                    },
                    {
                      "name": "arg",
                      "optional": true
                    },
                    {
                      "name": "...",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Run the supplied function in the context of the domain, implicitly\nbinding all event emitters, timers, and lowlevel requests that are\ncreated in that context. Optionally, arguments can be passed to\nthe function.
\n
This is the most basic way to use a domain.
\n
Example:
\n
const domain = require('domain');\nconst fs = require('fs');\nconst d = domain.create();\nd.on('error', (er) => {\n  console.error('Caught error!', er);\n});\nd.run(() => {\n  process.nextTick(() => {\n    setTimeout(() => { // simulating some various async stuff\n      fs.open('non-existent file', 'r', (er, fd) => {\n        if (er) throw er;\n        // proceed...\n      });\n    }, 100);\n  });\n});\n
\n
In this example, the d.on('error') handler will be triggered, rather\nthan crashing the program.
\n"
            },
            {
              "textRaw": "domain.add(emitter)",
              "type": "method",
              "name": "add",
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`emitter` {EventEmitter|Timer} emitter or timer to be added to the domain ",
                      "name": "emitter",
                      "type": "EventEmitter|Timer",
                      "desc": "emitter or timer to be added to the domain"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "emitter"
                    }
                  ]
                }
              ],
              "desc": "
Explicitly adds an emitter to the domain.  If any event handlers called by\nthe emitter throw an error, or if the emitter emits an 'error' event, it\nwill be routed to the domain's 'error' event, just like with implicit\nbinding.
\n
This also works with timers that are returned from setInterval() and\nsetTimeout().  If their callback function throws, it will be caught by\nthe domain 'error' handler.
\n
If the Timer or EventEmitter was already bound to a domain, it is removed\nfrom that one, and bound to this one instead.
\n"
            },
            {
              "textRaw": "domain.remove(emitter)",
              "type": "method",
              "name": "remove",
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`emitter` {EventEmitter|Timer} emitter or timer to be removed from the domain ",
                      "name": "emitter",
                      "type": "EventEmitter|Timer",
                      "desc": "emitter or timer to be removed from the domain"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "emitter"
                    }
                  ]
                }
              ],
              "desc": "
The opposite of domain.add(emitter).  Removes domain handling from the\nspecified emitter.
\n"
            },
            {
              "textRaw": "domain.bind(callback)",
              "type": "method",
              "name": "bind",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Function} The bound function ",
                    "name": "return",
                    "type": "Function",
                    "desc": "The bound function"
                  },
                  "params": [
                    {
                      "textRaw": "`callback` {Function} The callback function ",
                      "name": "callback",
                      "type": "Function",
                      "desc": "The callback function"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "callback"
                    }
                  ]
                }
              ],
              "desc": "
The returned function will be a wrapper around the supplied callback\nfunction.  When the returned function is called, any errors that are\nthrown will be routed to the domain's 'error' event.
\n
Example
\n
const d = domain.create();\n\nfunction readSomeFile(filename, cb) {\n  fs.readFile(filename, 'utf8', d.bind((er, data) => {\n    // if this throws, it will also be passed to the domain\n    return cb(er, data ? JSON.parse(data) : null);\n  }));\n}\n\nd.on('error', (er) => {\n  // an error occurred somewhere.\n  // if we throw it now, it will crash the program\n  // with the normal line number and stack message.\n});\n
\n"
            },
            {
              "textRaw": "domain.intercept(callback)",
              "type": "method",
              "name": "intercept",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Function} The intercepted function ",
                    "name": "return",
                    "type": "Function",
                    "desc": "The intercepted function"
                  },
                  "params": [
                    {
                      "textRaw": "`callback` {Function} The callback function ",
                      "name": "callback",
                      "type": "Function",
                      "desc": "The callback function"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "callback"
                    }
                  ]
                }
              ],
              "desc": "
This method is almost identical to domain.bind(callback).  However, in\naddition to catching thrown errors, it will also intercept Error\nobjects sent as the first argument to the function.
\n
In this way, the common if (err) return callback(err); pattern can be replaced\nwith a single error handler in a single place.
\n
Example
\n
const d = domain.create();\n\nfunction readSomeFile(filename, cb) {\n  fs.readFile(filename, 'utf8', d.intercept((data) => {\n    // note, the first argument is never passed to the\n    // callback since it is assumed to be the 'Error' argument\n    // and thus intercepted by the domain.\n\n    // if this throws, it will also be passed to the domain\n    // so the error-handling logic can be moved to the 'error'\n    // event on the domain instead of being repeated throughout\n    // the program.\n    return cb(null, JSON.parse(data));\n  }));\n}\n\nd.on('error', (er) => {\n  // an error occurred somewhere.\n  // if we throw it now, it will crash the program\n  // with the normal line number and stack message.\n});\n
\n"
            },
            {
              "textRaw": "domain.enter()",
              "type": "method",
              "name": "enter",
              "desc": "
The enter method is plumbing used by the run, bind, and intercept\nmethods to set the active domain. It sets domain.active and process.domain\nto the domain, and implicitly pushes the domain onto the domain stack managed\nby the domain module (see domain.exit() for details on the domain stack). The\ncall to enter delimits the beginning of a chain of asynchronous calls and I/O\noperations bound to a domain.
\n
Calling enter changes only the active domain, and does not alter the domain\nitself. enter and exit can be called an arbitrary number of times on a\nsingle domain.
\n
If the domain on which enter is called has been disposed, enter will return\nwithout setting the domain.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "domain.exit()",
              "type": "method",
              "name": "exit",
              "desc": "
The exit method exits the current domain, popping it off the domain stack.\nAny time execution is going to switch to the context of a different chain of\nasynchronous calls, it's important to ensure that the current domain is exited.\nThe call to exit delimits either the end of or an interruption to the chain\nof asynchronous calls and I/O operations bound to a domain.
\n
If there are multiple, nested domains bound to the current execution context,\nexit will exit any domains nested within this domain.
\n
Calling exit changes only the active domain, and does not alter the domain\nitself. enter and exit can be called an arbitrary number of times on a\nsingle domain.
\n
If the domain on which exit is called has been disposed, exit will return\nwithout exiting the domain.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "domain.dispose()",
              "type": "method",
              "name": "dispose",
              "desc": "
Stability: 0 - Deprecated.  Please recover from failed IO actions\nexplicitly via error event handlers set on the domain.
\n
Once dispose has been called, the domain will no longer be used by callbacks\nbound into the domain via run, bind, or intercept, and a 'dispose' event\nis emitted.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            }
          ],
          "properties": [
            {
              "textRaw": "`members` {Array} ",
              "type": "Array",
              "name": "members",
              "desc": "
An array of timers and event emitters that have been explicitly added\nto the domain.
\n"
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "Domain"
    }
  ]
}
node-v4.8.2/doc/api/domain.md000644 000766 000024 00000035033 13070706735 016073 0ustar00iojsstaff000000 000000 # Domain

> Stability: 0 - Deprecated

**This module is pending deprecation**. Once a replacement API has been
finalized, this module will be fully deprecated. Most end users should
**not** have cause to use this module. Users who absolutely must have
the functionality that domains provide may rely on it for the time being
but should expect to have to migrate to a different solution
in the future.

Domains provide a way to handle multiple different IO operations as a
single group.  If any of the event emitters or callbacks registered to a
domain emit an `'error'` event, or throw an error, then the domain object
will be notified, rather than losing the context of the error in the
`process.on('uncaughtException')` handler, or causing the program to
exit immediately with an error code.

## Warning: Don't Ignore Errors!



Domain error handlers are not a substitute for closing down your
process when an error occurs.

By the very nature of how [`throw`][] works in JavaScript, there is almost
never any way to safely "pick up where you left off", without leaking
references, or creating some other sort of undefined brittle state.

The safest way to respond to a thrown error is to shut down the
process.  Of course, in a normal web server, you might have many
connections open, and it is not reasonable to abruptly shut those down
because an error was triggered by someone else.

The better approach is to send an error response to the request that
triggered the error, while letting the others finish in their normal
time, and stop listening for new requests in that worker.

In this way, `domain` usage goes hand-in-hand with the cluster module,
since the master process can fork a new worker when a worker
encounters an error.  For Node.js programs that scale to multiple
machines, the terminating proxy or service registry can take note of
the failure, and react accordingly.

For example, this is not a good idea:

```js
// XXX WARNING!  BAD IDEA!

const d = require('domain').create();
d.on('error', (er) => {
  // The error won't crash the process, but what it does is worse!
  // Though we've prevented abrupt process restarting, we are leaking
  // resources like crazy if this ever happens.
  // This is no better than process.on('uncaughtException')!
  console.log(`error, but oh well ${er.message}`);
});
d.run(() => {
  require('http').createServer((req, res) => {
    handleRequest(req, res);
  }).listen(PORT);
});
```

By using the context of a domain, and the resilience of separating our
program into multiple worker processes, we can react more
appropriately, and handle errors with much greater safety.

```js
// Much better!

const cluster = require('cluster');
const PORT = +process.env.PORT || 1337;

if (cluster.isMaster) {
  // In real life, you'd probably use more than just 2 workers,
  // and perhaps not put the master and worker in the same file.
  //
  // You can also of course get a bit fancier about logging, and
  // implement whatever custom logic you need to prevent DoS
  // attacks and other bad behavior.
  //
  // See the options in the cluster documentation.
  //
  // The important thing is that the master does very little,
  // increasing our resilience to unexpected errors.

  cluster.fork();
  cluster.fork();

  cluster.on('disconnect', (worker) => {
    console.error('disconnect!');
    cluster.fork();
  });

} else {
  // the worker
  //
  // This is where we put our bugs!

  const domain = require('domain');

  // See the cluster documentation for more details about using
  // worker processes to serve requests.  How it works, caveats, etc.

  const server = require('http').createServer((req, res) => {
    const d = domain.create();
    d.on('error', (er) => {
      console.error(`error ${er.stack}`);

      // Note: we're in dangerous territory!
      // By definition, something unexpected occurred,
      // which we probably didn't want.
      // Anything can happen now!  Be very careful!

      try {
        // make sure we close down within 30 seconds
        const killtimer = setTimeout(() => {
          process.exit(1);
        }, 30000);
        // But don't keep the process open just for that!
        killtimer.unref();

        // stop taking new requests.
        server.close();

        // Let the master know we're dead.  This will trigger a
        // 'disconnect' in the cluster master, and then it will fork
        // a new worker.
        cluster.worker.disconnect();

        // try to send an error to the request that triggered the problem
        res.statusCode = 500;
        res.setHeader('content-type', 'text/plain');
        res.end('Oops, there was a problem!\n');
      } catch (er2) {
        // oh well, not much we can do at this point.
        console.error(`Error sending 500! ${er2.stack}`);
      }
    });

    // Because req and res were created before this domain existed,
    // we need to explicitly add them.
    // See the explanation of implicit vs explicit binding below.
    d.add(req);
    d.add(res);

    // Now run the handler function in the domain.
    d.run(() => {
      handleRequest(req, res);
    });
  });
  server.listen(PORT);
}

// This part isn't important.  Just an example routing thing.
// You'd put your fancy application logic here.
function handleRequest(req, res) {
  switch (req.url) {
    case '/error':
      // We do some async stuff, and then...
      setTimeout(() => {
        // Whoops!
        flerb.bark();
      });
      break;
    default:
      res.end('ok');
  }
}
```

## Additions to Error objects



Any time an `Error` object is routed through a domain, a few extra fields
are added to it.

* `error.domain` The domain that first handled the error.
* `error.domainEmitter` The event emitter that emitted an `'error'` event
  with the error object.
* `error.domainBound` The callback function which was bound to the
  domain, and passed an error as its first argument.
* `error.domainThrown` A boolean indicating whether the error was
  thrown, emitted, or passed to a bound callback function.

## Implicit Binding



If domains are in use, then all **new** EventEmitter objects (including
Stream objects, requests, responses, etc.) will be implicitly bound to
the active domain at the time of their creation.

Additionally, callbacks passed to lowlevel event loop requests (such as
to fs.open, or other callback-taking methods) will automatically be
bound to the active domain.  If they throw, then the domain will catch
the error.

In order to prevent excessive memory usage, Domain objects themselves
are not implicitly added as children of the active domain.  If they
were, then it would be too easy to prevent request and response objects
from being properly garbage collected.

If you *want* to nest Domain objects as children of a parent Domain,
then you must explicitly add them.

Implicit binding routes thrown errors and `'error'` events to the
Domain's `'error'` event, but does not register the EventEmitter on the
Domain, so [`domain.dispose()`][] will not shut down the EventEmitter.
Implicit binding only takes care of thrown errors and `'error'` events.

## Explicit Binding



Sometimes, the domain in use is not the one that ought to be used for a
specific event emitter.  Or, the event emitter could have been created
in the context of one domain, but ought to instead be bound to some
other domain.

For example, there could be one domain in use for an HTTP server, but
perhaps we would like to have a separate domain to use for each request.

That is possible via explicit binding.

For example:

```js
// create a top-level domain for the server
const domain = require('domain');
const http = require('http');
const serverDomain = domain.create();

serverDomain.run(() => {
  // server is created in the scope of serverDomain
  http.createServer((req, res) => {
    // req and res are also created in the scope of serverDomain
    // however, we'd prefer to have a separate domain for each request.
    // create it first thing, and add req and res to it.
    const reqd = domain.create();
    reqd.add(req);
    reqd.add(res);
    reqd.on('error', (er) => {
      console.error('Error', er, req.url);
      try {
        res.writeHead(500);
        res.end('Error occurred, sorry.');
      } catch (er2) {
        console.error('Error sending 500', er2, req.url);
      }
    });
  }).listen(1337);
});
```

## domain.create()

* Returns: {Domain}

Returns a new Domain object.

## Class: Domain

The Domain class encapsulates the functionality of routing errors and
uncaught exceptions to the active Domain object.

Domain is a child class of [`EventEmitter`][].  To handle the errors that it
catches, listen to its `'error'` event.

### domain.run(fn[, arg][, ...])

* `fn` {Function}

Run the supplied function in the context of the domain, implicitly
binding all event emitters, timers, and lowlevel requests that are
created in that context. Optionally, arguments can be passed to
the function.

This is the most basic way to use a domain.

Example:

```js
const domain = require('domain');
const fs = require('fs');
const d = domain.create();
d.on('error', (er) => {
  console.error('Caught error!', er);
});
d.run(() => {
  process.nextTick(() => {
    setTimeout(() => { // simulating some various async stuff
      fs.open('non-existent file', 'r', (er, fd) => {
        if (er) throw er;
        // proceed...
      });
    }, 100);
  });
});
```

In this example, the `d.on('error')` handler will be triggered, rather
than crashing the program.

### domain.members

* {Array}

An array of timers and event emitters that have been explicitly added
to the domain.

### domain.add(emitter)

* `emitter` {EventEmitter|Timer} emitter or timer to be added to the domain

Explicitly adds an emitter to the domain.  If any event handlers called by
the emitter throw an error, or if the emitter emits an `'error'` event, it
will be routed to the domain's `'error'` event, just like with implicit
binding.

This also works with timers that are returned from [`setInterval()`][] and
[`setTimeout()`][].  If their callback function throws, it will be caught by
the domain 'error' handler.

If the Timer or EventEmitter was already bound to a domain, it is removed
from that one, and bound to this one instead.

### domain.remove(emitter)

* `emitter` {EventEmitter|Timer} emitter or timer to be removed from the domain

The opposite of [`domain.add(emitter)`][].  Removes domain handling from the
specified emitter.

### domain.bind(callback)

* `callback` {Function} The callback function
* Returns: {Function} The bound function

The returned function will be a wrapper around the supplied callback
function.  When the returned function is called, any errors that are
thrown will be routed to the domain's `'error'` event.

#### Example

```js
const d = domain.create();

function readSomeFile(filename, cb) {
  fs.readFile(filename, 'utf8', d.bind((er, data) => {
    // if this throws, it will also be passed to the domain
    return cb(er, data ? JSON.parse(data) : null);
  }));
}

d.on('error', (er) => {
  // an error occurred somewhere.
  // if we throw it now, it will crash the program
  // with the normal line number and stack message.
});
```

### domain.intercept(callback)

* `callback` {Function} The callback function
* Returns: {Function} The intercepted function

This method is almost identical to [`domain.bind(callback)`][].  However, in
addition to catching thrown errors, it will also intercept [`Error`][]
objects sent as the first argument to the function.

In this way, the common `if (err) return callback(err);` pattern can be replaced
with a single error handler in a single place.

#### Example

```js
const d = domain.create();

function readSomeFile(filename, cb) {
  fs.readFile(filename, 'utf8', d.intercept((data) => {
    // note, the first argument is never passed to the
    // callback since it is assumed to be the 'Error' argument
    // and thus intercepted by the domain.

    // if this throws, it will also be passed to the domain
    // so the error-handling logic can be moved to the 'error'
    // event on the domain instead of being repeated throughout
    // the program.
    return cb(null, JSON.parse(data));
  }));
}

d.on('error', (er) => {
  // an error occurred somewhere.
  // if we throw it now, it will crash the program
  // with the normal line number and stack message.
});
```

### domain.enter()

The `enter` method is plumbing used by the `run`, `bind`, and `intercept`
methods to set the active domain. It sets `domain.active` and `process.domain`
to the domain, and implicitly pushes the domain onto the domain stack managed
by the domain module (see [`domain.exit()`][] for details on the domain stack). The
call to `enter` delimits the beginning of a chain of asynchronous calls and I/O
operations bound to a domain.

Calling `enter` changes only the active domain, and does not alter the domain
itself. `enter` and `exit` can be called an arbitrary number of times on a
single domain.

If the domain on which `enter` is called has been disposed, `enter` will return
without setting the domain.

### domain.exit()

The `exit` method exits the current domain, popping it off the domain stack.
Any time execution is going to switch to the context of a different chain of
asynchronous calls, it's important to ensure that the current domain is exited.
The call to `exit` delimits either the end of or an interruption to the chain
of asynchronous calls and I/O operations bound to a domain.

If there are multiple, nested domains bound to the current execution context,
`exit` will exit any domains nested within this domain.

Calling `exit` changes only the active domain, and does not alter the domain
itself. `enter` and `exit` can be called an arbitrary number of times on a
single domain.

If the domain on which `exit` is called has been disposed, `exit` will return
without exiting the domain.

### domain.dispose()

> Stability: 0 - Deprecated.  Please recover from failed IO actions
> explicitly via error event handlers set on the domain.

Once `dispose` has been called, the domain will no longer be used by callbacks
bound into the domain via `run`, `bind`, or `intercept`, and a `'dispose'` event
is emitted.

[`domain.add(emitter)`]: #domain_domain_add_emitter
[`domain.bind(callback)`]: #domain_domain_bind_callback
[`domain.dispose()`]: #domain_domain_dispose
[`domain.exit()`]: #domain_domain_exit
[`Error`]: errors.html#errors_class_error
[`EventEmitter`]: events.html#events_class_events_eventemitter
[`setInterval()`]: timers.html#timers_setinterval_callback_delay_arg
[`setTimeout()`]: timers.html#timers_settimeout_callback_delay_arg
[`throw`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/throw
node-v4.8.2/doc/api/errors.html000644 000766 000024 00000106616 13070706740 016506 0ustar00iojsstaff000000 000000 


  
  Errors | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

      

        
Errors#



Applications running in Node.js will generally experience four categories of
errors:


    

  • Standard JavaScript errors such as:
      

    • <EvalError> : thrown when a call to eval() fails.
      • 

    • <SyntaxError> : thrown in response to improper JavaScript language
syntax.
      • 

    • <RangeError> : thrown when a value is not within an expected range
      • 

    • <ReferenceError> : thrown when using undefined variables
      • 

    • <TypeError> : thrown when passing arguments of the wrong type
      • 

    • <URIError> : thrown when a global URI handling function is misused.
      • 

    

    • 

  • System errors triggered by underlying operating system constraints such
as attempting to open a file that does not exist, attempting to send data
over a closed socket, etc;
    • 

  • And User-specified errors triggered by application code.
    • 

  • Assertion Errors are a special class of error that can be triggered whenever
Node.js detects an exceptional logic violation that should never occur. These
are raised typically by the assert module.
    • 



All JavaScript and System errors raised by Node.js inherit from, or are
instances of, the standard JavaScript <Error> class and are guaranteed
to provide at least the properties available on that class.


Error Propagation and Interception#



Node.js supports several mechanisms for propagating and handling errors that
occur while an application is running. How these errors are reported and
handled depends entirely on the type of Error and the style of the API that is
called.


All JavaScript errors are handled as exceptions that immediately generate
and throw an error using the standard JavaScript throw mechanism. These
are handled using the try / catch construct provided by the JavaScript
language.


// Throws with a ReferenceError because z is undefined
try {
  const m = 1;
  const n = m + z;
} catch (err) {
  // Handle the error here.
}



Any use of the JavaScript throw mechanism will raise an exception that
must be handled using try / catch or the Node.js process will exit
immediately.


With few exceptions, Synchronous APIs (any blocking method that does not
accept a callback function, such as fs.readFileSync), will use throw
to report errors.


Errors that occur within Asynchronous APIs may be reported in multiple ways:


    

  • Most asynchronous methods that accept a callback function will accept an
Error object passed as the first argument to that function. If that first
argument is not null and is an instance of Error, then an error occurred
that should be handled.
    

    const fs = require('fs');
fs.readFile('a file that does not exist', (err, data) => {
  if (err) {
    console.error('There was an error reading the file!', err);
    return;
  }
  // Otherwise handle the data
});

    

    • 

  • When an asynchronous method is called on an object that is an EventEmitter,
errors can be routed to that object's 'error' event.
    

    const net = require('net');
const connection = net.connect('localhost');

// Adding an 'error' event handler to a stream:
connection.on('error', (err) => {
  // If the connection is reset by the server, or if it can't
  // connect at all, or on any sort of error encountered by
  // the connection, the error will be sent here.
  console.error(err);
});

connection.pipe(process.stdout);

    

    • 

  • A handful of typically asynchronous methods in the Node.js API may still
use the throw mechanism to raise exceptions that must be handled using
try / catch. There is no comprehensive list of such methods; please
refer to the documentation of each method to determine the appropriate
error handling mechanism required.
    

    • 



The use of the 'error' event mechanism is most common for stream-based
and event emitter-based APIs, which themselves represent a series of
asynchronous operations over time (as opposed to a single operation that may
pass or fail).


For all EventEmitter objects, if an 'error' event handler is not
provided, the error will be thrown, causing the Node.js process to report an
unhandled exception and  crash unless either: The domain module is used
appropriately or a handler has been registered for the
process.on('uncaughtException') event.


const EventEmitter = require('events');
const ee = new EventEmitter();

setImmediate(() => {
  // This will crash the process because no 'error' event
  // handler has been added.
  ee.emit('error', new Error('This will crash'));
});



Errors generated in this way cannot be intercepted using try / catch as
they are thrown after the calling code has already exited.


Developers must refer to the documentation for each method to determine
exactly how errors raised by those methods are propagated.


Node.js style callbacks#



Most asynchronous methods exposed by the Node.js core API follow an idiomatic
pattern  referred to as a "Node.js style callback". With this pattern, a
callback function is passed to the method as an argument. When the operation
either completes or an error is raised, the callback function is called with
the Error object (if any) passed as the first argument. If no error was raised,
the first argument will be passed as null.


const fs = require('fs');

function nodeStyleCallback(err, data) {
 if (err) {
   console.error('There was an error', err);
   return;
 }
 console.log(data);
}

fs.readFile('/some/file/that/does-not-exist', nodeStyleCallback);
fs.readFile('/some/file/that/does-exist', nodeStyleCallback)



The JavaScript try / catch mechanism cannot be used to intercept errors
generated by asynchronous APIs.  A common mistake for beginners is to try to
use throw inside a Node.js style callback:


// THIS WILL NOT WORK:
const fs = require('fs');

try {
  fs.readFile('/some/file/that/does-not-exist', (err, data) => {
    // mistaken assumption: throwing here...
    if (err) {
      throw err;
    }
  });
} catch(err) {
  // This will not catch the throw!
  console.log(err);
}



This will not work because the callback function passed to fs.readFile() is
called asynchronously. By the time the callback has been called, the
surrounding code (including the try { } catch(err) { } block will have
already exited. Throwing an error inside the callback can crash the Node.js
process in most cases. If domains are enabled, or a handler has been
registered with process.on('uncaughtException'), such errors can be
intercepted.


Class: Error#



A generic JavaScript Error object that does not denote any specific
circumstance of why the error occurred. Error objects capture a "stack trace"
detailing the point in the code at which the Error was instantiated, and may
provide a text description of the error.


All errors generated by Node.js, including all System and JavaScript errors,
will either be instances of, or inherit from, the Error class.


new Error(message)#




Creates a new Error object and sets the error.message property to the
provided text message. If an object is passed as message, the text message
is generated by calling message.toString(). The error.stack property will
represent the point in the code at which new Error() was called. Stack traces
are dependent on V8's stack trace API. Stack traces extend only to either
(a) the beginning of  synchronous code execution, or (b) the number of frames
given by the property Error.stackTraceLimit, whichever is smaller.


Error.captureStackTrace(targetObject[, constructorOpt])#




Creates a .stack property on targetObject, which when accessed returns
a string representing the location in the code at which
Error.captureStackTrace() was called.


const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack  // similar to `new Error().stack`



The first line of the trace, instead of being prefixed with ErrorType:
message, will be the result of calling targetObject.toString().


The optional constructorOpt argument accepts a function. If given, all frames
above constructorOpt, including constructorOpt, will be omitted from the
generated stack trace.


The constructorOpt argument is useful for hiding implementation
details of error generation from an end user. For instance:


function MyError() {
  Error.captureStackTrace(this, MyError);
}

// Without passing MyError to captureStackTrace, the MyError
// frame would show up in the .stack property. By passing
// the constructor, we omit that frame and all frames above it.
new MyError().stack



Error.stackTraceLimit#




The Error.stackTraceLimit property specifies the number of stack frames
collected by a stack trace (whether generated by new Error().stack or
Error.captureStackTrace(obj)).


The default value is 10 but may be set to any valid JavaScript number. Changes
will affect any stack trace captured after the value has been changed.


If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.


error.message#




The error.message property is the string description of the error as set by calling new Error(message).
The message passed to the constructor will also appear in the first line of
the stack trace of the Error, however changing this property after the
Error object is created may not change the first line of the stack trace
(for example, when error.stack is read before this property is changed).


const err = new Error('The message');
console.log(err.message);
  // Prints: The message



error.stack#




The error.stack property is a string describing the point in the code at which
the Error was instantiated.


For example:


Error: Things keep happening!
   at /home/gbusey/file.js:525:2
   at Frobnicator.refrobulate (/home/gbusey/business-logic.js:424:21)
   at Actor.<anonymous> (/home/gbusey/actors.js:400:8)
   at increaseSynergy (/home/gbusey/actors.js:701:6)

The first line is formatted as <error class name>: <error message>, and
is followed by a series of stack frames (each line beginning with "at ").
Each frame describes a call site within the code that lead to the error being
generated. V8 attempts to display a name for each function (by variable name,
function name, or object method name), but occasionally it will not be able to
find a suitable name. If V8 cannot determine a name for the function, only
location information will be displayed for that frame. Otherwise, the
determined function name will be displayed with location information appended
in parentheses.


It is important to note that frames are only generated for JavaScript
functions. If, for example, execution synchronously passes through a C++ addon
function called cheetahify, which itself calls a JavaScript function, the
frame representing the cheetahify call will not be present in the stack
traces:


const cheetahify = require('./native-binding.node');

function makeFaster() {
  // cheetahify *synchronously* calls speedy.
  cheetahify(function speedy() {
    throw new Error('oh no!');
  });
}

makeFaster(); // will throw:
  // /home/gbusey/file.js:6
  //     throw new Error('oh no!');
  //           ^
  // Error: oh no!
  //     at speedy (/home/gbusey/file.js:6:11)
  //     at makeFaster (/home/gbusey/file.js:5:3)
  //     at Object.<anonymous> (/home/gbusey/file.js:10:1)
  //     at Module._compile (module.js:456:26)
  //     at Object.Module._extensions..js (module.js:474:10)
  //     at Module.load (module.js:356:32)
  //     at Function.Module._load (module.js:312:12)
  //     at Function.Module.runMain (module.js:497:10)
  //     at startup (node.js:119:16)
  //     at node.js:906:3



The location information will be one of:


    

  • native, if the frame represents a call internal to V8 (as in [].forEach).
    • 

  • plain-filename.js:line:column, if the frame represents a call internal
 to Node.js.
    • 

  • /absolute/path/to/file.js:line:column, if the frame represents a call in
a user program, or its dependencies.
    • 



The string representing the stack trace is lazily generated when the
error.stack property is accessed.


The number of frames captured by the stack trace is bounded by the smaller of
Error.stackTraceLimit or the number of available frames on the current event
loop tick.


System-level errors are generated as augmented Error instances, which are
detailed here.


Class: RangeError#


A subclass of Error that indicates that a provided argument was not within the
set or range of acceptable values for a function; whether that is a numeric
range, or outside the set of options for a given function parameter.


For example:


require('net').connect(-1);
  // throws RangeError, port should be > 0 && < 65536



Node.js will generate and throw RangeError instances immediately as a form
of argument validation.


Class: ReferenceError#


A subclass of Error that indicates that an attempt is being made to access a
variable that is not defined. Such errors commonly indicate typos in code, or
an otherwise broken program.


While client code may generate and propagate these errors, in practice, only V8
will do so.


doesNotExist;
  // throws ReferenceError, doesNotExist is not a variable in this program.



ReferenceError instances will have an error.arguments property whose value
is an array containing a single element: a string representing the variable
that was not defined.


const assert = require('assert');
try {
  doesNotExist;
} catch(err) {
  assert(err.arguments[0], 'doesNotExist');
}



Unless an application is dynamically generating and running code,
ReferenceError instances should always be considered a bug in the code
or its dependencies.


Class: SyntaxError#


A subclass of Error that indicates that a program is not valid JavaScript.
These errors may only be generated and propagated as a result of code
evaluation. Code evaluation may happen as a result of eval, Function,
require, or vm. These errors are almost always indicative of a broken
program.


try {
  require('vm').runInThisContext('binary ! isNotOk');
} catch(err) {
  // err will be a SyntaxError
}



SyntaxError instances are unrecoverable in the context that created them –
they may only be caught by other contexts.


Class: TypeError#


A subclass of Error that indicates that a provided argument is not an
allowable type. For example, passing a function to a parameter which expects a
string would be considered a TypeError.


require('url').parse(() => { });
  // throws TypeError, since it expected a string



Node.js will generate and throw TypeError instances immediately as a form
of argument validation.


Exceptions vs. Errors#



A JavaScript exception is a value that is thrown as a result of an invalid
operation or as the target of a throw statement. While it is not required
that these values are instances of Error or classes which inherit from
Error, all exceptions thrown by Node.js or the JavaScript runtime will be
instances of Error.


Some exceptions are unrecoverable at the JavaScript layer. Such exceptions
will always cause the Node.js process to crash. Examples include assert()
checks or abort() calls in the C++ layer.


System Errors#


System errors are generated when exceptions occur within the program's
runtime environment. Typically, these are operational errors that occur
when an application violates an operating system constraint such as attempting
to read a file that does not exist or when the user does not have sufficient
permissions.


System errors are typically generated at the syscall level: an exhaustive list
of error codes and their meanings is available by running man 2 intro or
man 3 errno on most Unices; or online.


In Node.js, system errors are represented as augmented Error objects with
added properties.


Class: System Error#


error.code#




The error.code property is a string representing the error code, which is always
E followed by a sequence of capital letters.


error.errno#




The error.errno property is a number or a string.
The number is a negative value which corresponds to the error code defined in
libuv Error handling. See uv-errno.h header file (deps/uv/include/uv-errno.h in
the Node.js source tree) for details.
In case of a string, it is the same as error.code.


error.syscall#




The error.syscall property is a string describing the syscall that failed.


error.path#




When present (e.g. in fs or child_process), the error.path property is a string
containing a relevant invalid pathname.


error.address#




When present (e.g. in net or dgram), the error.address property is a string
describing the address to which the connection failed.


error.port#




When present (e.g. in net or dgram), the error.port property is a number representing
the connection's port that is not available.


Common System Errors#


This list is not exhaustive, but enumerates many of the common system
errors encountered when writing a Node.js program. An exhaustive list may be
found here.


    

  • EACCES (Permission denied): An attempt was made to access a file in a way
forbidden by its file access permissions.
    

    • 

  • EADDRINUSE (Address already in use):  An attempt to bind a server
(net, http, or https) to a local address failed due to
another server on the local system already occupying that address.
    

    • 

  • ECONNREFUSED (Connection refused): No connection could be made because the
target machine actively refused it. This usually results from trying to
connect to a service that is inactive on the foreign host.
    

    • 

  • ECONNRESET (Connection reset by peer): A connection was forcibly closed by
a peer. This normally results from a loss of the connection on the remote
socket due to a timeout or reboot. Commonly encountered via the http
and net modules.
    

    • 

  • EEXIST (File exists): An existing file was the target of an operation that
required that the target not exist.
    

    • 

  • EISDIR (Is a directory): An operation expected a file, but the given
pathname was a directory.
    

    • 

  • EMFILE (Too many open files in system): Maximum number of
file descriptors allowable on the system has been reached, and
requests for another descriptor cannot be fulfilled until at least one
has been closed. This is encountered when opening many files at once in
parallel, especially on systems (in particular, OS X) where there is a low
file descriptor limit for processes. To remedy a low limit, run
ulimit -n 2048 in the same shell that will run the Node.js process.
    

    • 

  • ENOENT (No such file or directory): Commonly raised by fs operations
to indicate that a component of the specified pathname does not exist -- no
entity (file or directory) could be found by the given path.
    

    • 

  • ENOTDIR (Not a directory): A component of the given pathname existed, but
was not a directory as expected. Commonly raised by fs.readdir.
    

    • 

  • ENOTEMPTY (Directory not empty): A directory with entries was the target
of an operation that requires an empty directory -- usually fs.unlink.
    

    • 

  • EPERM (Operation not permitted): An attempt was made to perform an
operation that requires elevated privileges.
    

    • 

  • EPIPE (Broken pipe): A write on a pipe, socket, or FIFO for which there is
no process to read the data. Commonly encountered at the net and
http layers, indicative that the remote side of the stream being
written to has been closed.
    

    • 

  • ETIMEDOUT (Operation timed out): A connect or send request failed because
the connected party did not properly respond after a period of time. Usually
encountered by http or net -- often a sign that a socket.end()
was not properly called.
    

    • 



      

    

  

  
  
  
  



node-v4.8.2/doc/api/errors.json000644 000766 000024 00000123602 13070706740 016505 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/errors.md",
  "classes": [
    {
      "textRaw": "Class: Error",
      "type": "class",
      "name": "Error",
      "desc": "
A generic JavaScript Error object that does not denote any specific\ncircumstance of why the error occurred. Error objects capture a "stack trace"\ndetailing the point in the code at which the Error was instantiated, and may\nprovide a text description of the error.
\n
All errors generated by Node.js, including all System and JavaScript errors,\nwill either be instances of, or inherit from, the Error class.
\n",
      "methods": [
        {
          "textRaw": "Error.captureStackTrace(targetObject[, constructorOpt])",
          "type": "method",
          "name": "captureStackTrace",
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`targetObject` {Object} ",
                  "name": "targetObject",
                  "type": "Object"
                },
                {
                  "textRaw": "`constructorOpt` {Function} ",
                  "name": "constructorOpt",
                  "type": "Function",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "targetObject"
                },
                {
                  "name": "constructorOpt",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "
Creates a .stack property on targetObject, which when accessed returns\na string representing the location in the code at which\nError.captureStackTrace() was called.
\n
const myObject = {};\nError.captureStackTrace(myObject);\nmyObject.stack  // similar to `new Error().stack`\n
\n
The first line of the trace, instead of being prefixed with ErrorType:\nmessage, will be the result of calling targetObject.toString().
\n
The optional constructorOpt argument accepts a function. If given, all frames\nabove constructorOpt, including constructorOpt, will be omitted from the\ngenerated stack trace.
\n
The constructorOpt argument is useful for hiding implementation\ndetails of error generation from an end user. For instance:
\n
function MyError() {\n  Error.captureStackTrace(this, MyError);\n}\n\n// Without passing MyError to captureStackTrace, the MyError\n// frame would show up in the .stack property. By passing\n// the constructor, we omit that frame and all frames above it.\nnew MyError().stack\n
\n"
        }
      ],
      "properties": [
        {
          "textRaw": "`stackTraceLimit` {Number} ",
          "type": "Number",
          "name": "stackTraceLimit",
          "desc": "
The Error.stackTraceLimit property specifies the number of stack frames\ncollected by a stack trace (whether generated by new Error().stack or\nError.captureStackTrace(obj)).
\n
The default value is 10 but may be set to any valid JavaScript number. Changes\nwill affect any stack trace captured after the value has been changed.
\n
If set to a non-number value, or set to a negative number, stack traces will\nnot capture any frames.
\n",
          "properties": [
            {
              "textRaw": "`message` {String} ",
              "type": "String",
              "name": "message",
              "desc": "
The error.message property is the string description of the error as set by calling new Error(message).\nThe message passed to the constructor will also appear in the first line of\nthe stack trace of the Error, however changing this property after the\nError object is created may not change the first line of the stack trace\n(for example, when error.stack is read before this property is changed).
\n
const err = new Error('The message');\nconsole.log(err.message);\n  // Prints: The message\n
\n"
            },
            {
              "textRaw": "`stack` {String} ",
              "type": "String",
              "name": "stack",
              "desc": "
The error.stack property is a string describing the point in the code at which\nthe Error was instantiated.
\n
For example:
\n
Error: Things keep happening!\n   at /home/gbusey/file.js:525:2\n   at Frobnicator.refrobulate (/home/gbusey/business-logic.js:424:21)\n   at Actor.<anonymous> (/home/gbusey/actors.js:400:8)\n   at increaseSynergy (/home/gbusey/actors.js:701:6)\n
The first line is formatted as <error class name>: <error message>, and\nis followed by a series of stack frames (each line beginning with "at ").\nEach frame describes a call site within the code that lead to the error being\ngenerated. V8 attempts to display a name for each function (by variable name,\nfunction name, or object method name), but occasionally it will not be able to\nfind a suitable name. If V8 cannot determine a name for the function, only\nlocation information will be displayed for that frame. Otherwise, the\ndetermined function name will be displayed with location information appended\nin parentheses.
\n
It is important to note that frames are only generated for JavaScript\nfunctions. If, for example, execution synchronously passes through a C++ addon\nfunction called cheetahify, which itself calls a JavaScript function, the\nframe representing the cheetahify call will not be present in the stack\ntraces:
\n
const cheetahify = require('./native-binding.node');\n\nfunction makeFaster() {\n  // cheetahify *synchronously* calls speedy.\n  cheetahify(function speedy() {\n    throw new Error('oh no!');\n  });\n}\n\nmakeFaster(); // will throw:\n  // /home/gbusey/file.js:6\n  //     throw new Error('oh no!');\n  //           ^\n  // Error: oh no!\n  //     at speedy (/home/gbusey/file.js:6:11)\n  //     at makeFaster (/home/gbusey/file.js:5:3)\n  //     at Object.<anonymous> (/home/gbusey/file.js:10:1)\n  //     at Module._compile (module.js:456:26)\n  //     at Object.Module._extensions..js (module.js:474:10)\n  //     at Module.load (module.js:356:32)\n  //     at Function.Module._load (module.js:312:12)\n  //     at Function.Module.runMain (module.js:497:10)\n  //     at startup (node.js:119:16)\n  //     at node.js:906:3\n
\n
The location information will be one of:
\n
    \n
  • native, if the frame represents a call internal to V8 (as in [].forEach).
    • \n
  • plain-filename.js:line:column, if the frame represents a call internal\n to Node.js.
    • \n
  • /absolute/path/to/file.js:line:column, if the frame represents a call in\na user program, or its dependencies.
    • \n
\n
The string representing the stack trace is lazily generated when the\nerror.stack property is accessed.
\n
The number of frames captured by the stack trace is bounded by the smaller of\nError.stackTraceLimit or the number of available frames on the current event\nloop tick.
\n
System-level errors are generated as augmented Error instances, which are\ndetailed here.
\n"
            }
          ]
        }
      ],
      "signatures": [
        {
          "params": [
            {
              "textRaw": "`message` {String} ",
              "name": "message",
              "type": "String"
            }
          ],
          "desc": "
Creates a new Error object and sets the error.message property to the\nprovided text message. If an object is passed as message, the text message\nis generated by calling message.toString(). The error.stack property will\nrepresent the point in the code at which new Error() was called. Stack traces\nare dependent on V8's stack trace API. Stack traces extend only to either\n(a) the beginning of  synchronous code execution, or (b) the number of frames\ngiven by the property Error.stackTraceLimit, whichever is smaller.
\n"
        },
        {
          "params": [
            {
              "name": "message"
            }
          ],
          "desc": "
Creates a new Error object and sets the error.message property to the\nprovided text message. If an object is passed as message, the text message\nis generated by calling message.toString(). The error.stack property will\nrepresent the point in the code at which new Error() was called. Stack traces\nare dependent on V8's stack trace API. Stack traces extend only to either\n(a) the beginning of  synchronous code execution, or (b) the number of frames\ngiven by the property Error.stackTraceLimit, whichever is smaller.
\n"
        }
      ]
    },
    {
      "textRaw": "Class: RangeError",
      "type": "class",
      "name": "RangeError",
      "desc": "
A subclass of Error that indicates that a provided argument was not within the\nset or range of acceptable values for a function; whether that is a numeric\nrange, or outside the set of options for a given function parameter.
\n
For example:
\n
require('net').connect(-1);\n  // throws RangeError, port should be > 0 && < 65536\n
\n
Node.js will generate and throw RangeError instances immediately as a form\nof argument validation.
\n"
    },
    {
      "textRaw": "Class: ReferenceError",
      "type": "class",
      "name": "ReferenceError",
      "desc": "
A subclass of Error that indicates that an attempt is being made to access a\nvariable that is not defined. Such errors commonly indicate typos in code, or\nan otherwise broken program.
\n
While client code may generate and propagate these errors, in practice, only V8\nwill do so.
\n
doesNotExist;\n  // throws ReferenceError, doesNotExist is not a variable in this program.\n
\n
ReferenceError instances will have an error.arguments property whose value\nis an array containing a single element: a string representing the variable\nthat was not defined.
\n
const assert = require('assert');\ntry {\n  doesNotExist;\n} catch(err) {\n  assert(err.arguments[0], 'doesNotExist');\n}\n
\n
Unless an application is dynamically generating and running code,\nReferenceError instances should always be considered a bug in the code\nor its dependencies.
\n"
    },
    {
      "textRaw": "Class: SyntaxError",
      "type": "class",
      "name": "SyntaxError",
      "desc": "
A subclass of Error that indicates that a program is not valid JavaScript.\nThese errors may only be generated and propagated as a result of code\nevaluation. Code evaluation may happen as a result of eval, Function,\nrequire, or vm. These errors are almost always indicative of a broken\nprogram.
\n
try {\n  require('vm').runInThisContext('binary ! isNotOk');\n} catch(err) {\n  // err will be a SyntaxError\n}\n
\n
SyntaxError instances are unrecoverable in the context that created them –\nthey may only be caught by other contexts.
\n"
    },
    {
      "textRaw": "Class: TypeError",
      "type": "class",
      "name": "TypeError",
      "desc": "
A subclass of Error that indicates that a provided argument is not an\nallowable type. For example, passing a function to a parameter which expects a\nstring would be considered a TypeError.
\n
require('url').parse(() => { });\n  // throws TypeError, since it expected a string\n
\n
Node.js will generate and throw TypeError instances immediately as a form\nof argument validation.
\n"
    }
  ],
  "miscs": [
    {
      "textRaw": "Errors",
      "name": "Errors",
      "type": "misc",
      "desc": "
Applications running in Node.js will generally experience four categories of\nerrors:
\n
    \n
  • Standard JavaScript errors such as:
      \n
    • {EvalError} : thrown when a call to eval() fails.
      • \n
    • {SyntaxError} : thrown in response to improper JavaScript language\nsyntax.
      • \n
    • {RangeError} : thrown when a value is not within an expected range
      • \n
    • {ReferenceError} : thrown when using undefined variables
      • \n
    • {TypeError} : thrown when passing arguments of the wrong type
      • \n
    • {URIError} : thrown when a global URI handling function is misused.
      • \n
    \n
    • \n
  • System errors triggered by underlying operating system constraints such\nas attempting to open a file that does not exist, attempting to send data\nover a closed socket, etc;
    • \n
  • And User-specified errors triggered by application code.
    • \n
  • Assertion Errors are a special class of error that can be triggered whenever\nNode.js detects an exceptional logic violation that should never occur. These\nare raised typically by the assert module.
    • \n
\n
All JavaScript and System errors raised by Node.js inherit from, or are\ninstances of, the standard JavaScript {Error} class and are guaranteed\nto provide at least the properties available on that class.
\n",
      "miscs": [
        {
          "textRaw": "Error Propagation and Interception",
          "name": "Error Propagation and Interception",
          "type": "misc",
          "desc": "
Node.js supports several mechanisms for propagating and handling errors that\noccur while an application is running. How these errors are reported and\nhandled depends entirely on the type of Error and the style of the API that is\ncalled.
\n
All JavaScript errors are handled as exceptions that immediately generate\nand throw an error using the standard JavaScript throw mechanism. These\nare handled using the try / catch construct provided by the JavaScript\nlanguage.
\n
// Throws with a ReferenceError because z is undefined\ntry {\n  const m = 1;\n  const n = m + z;\n} catch (err) {\n  // Handle the error here.\n}\n
\n
Any use of the JavaScript throw mechanism will raise an exception that\nmust be handled using try / catch or the Node.js process will exit\nimmediately.
\n
With few exceptions, Synchronous APIs (any blocking method that does not\naccept a callback function, such as fs.readFileSync), will use throw\nto report errors.
\n
Errors that occur within Asynchronous APIs may be reported in multiple ways:
\n
    \n
  • Most asynchronous methods that accept a callback function will accept an\nError object passed as the first argument to that function. If that first\nargument is not null and is an instance of Error, then an error occurred\nthat should be handled.
    \n
    const fs = require('fs');\nfs.readFile('a file that does not exist', (err, data) => {\n  if (err) {\n    console.error('There was an error reading the file!', err);\n    return;\n  }\n  // Otherwise handle the data\n});\n
    \n
    • \n
  • When an asynchronous method is called on an object that is an EventEmitter,\nerrors can be routed to that object's 'error' event.
    \n
    const net = require('net');\nconst connection = net.connect('localhost');\n\n// Adding an 'error' event handler to a stream:\nconnection.on('error', (err) => {\n  // If the connection is reset by the server, or if it can't\n  // connect at all, or on any sort of error encountered by\n  // the connection, the error will be sent here.\n  console.error(err);\n});\n\nconnection.pipe(process.stdout);\n
    \n
    • \n
  • A handful of typically asynchronous methods in the Node.js API may still\nuse the throw mechanism to raise exceptions that must be handled using\ntry / catch. There is no comprehensive list of such methods; please\nrefer to the documentation of each method to determine the appropriate\nerror handling mechanism required.
    \n
    • \n
\n
The use of the 'error' event mechanism is most common for stream-based\nand event emitter-based APIs, which themselves represent a series of\nasynchronous operations over time (as opposed to a single operation that may\npass or fail).
\n
For all EventEmitter objects, if an 'error' event handler is not\nprovided, the error will be thrown, causing the Node.js process to report an\nunhandled exception and  crash unless either: The domain module is used\nappropriately or a handler has been registered for the\nprocess.on('uncaughtException') event.
\n
const EventEmitter = require('events');\nconst ee = new EventEmitter();\n\nsetImmediate(() => {\n  // This will crash the process because no 'error' event\n  // handler has been added.\n  ee.emit('error', new Error('This will crash'));\n});\n
\n
Errors generated in this way cannot be intercepted using try / catch as\nthey are thrown after the calling code has already exited.
\n
Developers must refer to the documentation for each method to determine\nexactly how errors raised by those methods are propagated.
\n",
          "miscs": [
            {
              "textRaw": "Node.js style callbacks",
              "name": "Node.js style callbacks",
              "type": "misc",
              "desc": "
Most asynchronous methods exposed by the Node.js core API follow an idiomatic\npattern  referred to as a "Node.js style callback". With this pattern, a\ncallback function is passed to the method as an argument. When the operation\neither completes or an error is raised, the callback function is called with\nthe Error object (if any) passed as the first argument. If no error was raised,\nthe first argument will be passed as null.
\n
const fs = require('fs');\n\nfunction nodeStyleCallback(err, data) {\n if (err) {\n   console.error('There was an error', err);\n   return;\n }\n console.log(data);\n}\n\nfs.readFile('/some/file/that/does-not-exist', nodeStyleCallback);\nfs.readFile('/some/file/that/does-exist', nodeStyleCallback)\n
\n
The JavaScript try / catch mechanism cannot be used to intercept errors\ngenerated by asynchronous APIs.  A common mistake for beginners is to try to\nuse throw inside a Node.js style callback:
\n
// THIS WILL NOT WORK:\nconst fs = require('fs');\n\ntry {\n  fs.readFile('/some/file/that/does-not-exist', (err, data) => {\n    // mistaken assumption: throwing here...\n    if (err) {\n      throw err;\n    }\n  });\n} catch(err) {\n  // This will not catch the throw!\n  console.log(err);\n}\n
\n
This will not work because the callback function passed to fs.readFile() is\ncalled asynchronously. By the time the callback has been called, the\nsurrounding code (including the try { } catch(err) { } block will have\nalready exited. Throwing an error inside the callback can crash the Node.js\nprocess in most cases. If domains are enabled, or a handler has been\nregistered with process.on('uncaughtException'), such errors can be\nintercepted.
\n"
            }
          ]
        },
        {
          "textRaw": "Exceptions vs. Errors",
          "name": "Exceptions vs. Errors",
          "type": "misc",
          "desc": "
A JavaScript exception is a value that is thrown as a result of an invalid\noperation or as the target of a throw statement. While it is not required\nthat these values are instances of Error or classes which inherit from\nError, all exceptions thrown by Node.js or the JavaScript runtime will be\ninstances of Error.
\n
Some exceptions are unrecoverable at the JavaScript layer. Such exceptions\nwill always cause the Node.js process to crash. Examples include assert()\nchecks or abort() calls in the C++ layer.
\n"
        },
        {
          "textRaw": "System Errors",
          "name": "system_errors",
          "desc": "
System errors are generated when exceptions occur within the program's\nruntime environment. Typically, these are operational errors that occur\nwhen an application violates an operating system constraint such as attempting\nto read a file that does not exist or when the user does not have sufficient\npermissions.
\n
System errors are typically generated at the syscall level: an exhaustive list\nof error codes and their meanings is available by running man 2 intro or\nman 3 errno on most Unices; or online.
\n
In Node.js, system errors are represented as augmented Error objects with\nadded properties.
\n",
          "classes": [
            {
              "textRaw": "Class: System Error",
              "type": "class",
              "name": "System",
              "properties": [
                {
                  "textRaw": "`code` {String} ",
                  "type": "String",
                  "name": "code",
                  "desc": "
The error.code property is a string representing the error code, which is always\nE followed by a sequence of capital letters.
\n"
                },
                {
                  "textRaw": "`errno` {String | Number} ",
                  "type": "String | Number",
                  "name": "errno",
                  "desc": "
The error.errno property is a number or a string.\nThe number is a negative value which corresponds to the error code defined in\nlibuv Error handling. See uv-errno.h header file (deps/uv/include/uv-errno.h in\nthe Node.js source tree) for details.\nIn case of a string, it is the same as error.code.
\n"
                },
                {
                  "textRaw": "`syscall` {String} ",
                  "type": "String",
                  "name": "syscall",
                  "desc": "
The error.syscall property is a string describing the syscall that failed.
\n"
                },
                {
                  "textRaw": "`path` {String} ",
                  "type": "String",
                  "name": "path",
                  "desc": "
When present (e.g. in fs or child_process), the error.path property is a string\ncontaining a relevant invalid pathname.
\n"
                },
                {
                  "textRaw": "`address` {String} ",
                  "type": "String",
                  "name": "address",
                  "desc": "
When present (e.g. in net or dgram), the error.address property is a string\ndescribing the address to which the connection failed.
\n"
                },
                {
                  "textRaw": "`port` {Number} ",
                  "type": "Number",
                  "name": "port",
                  "desc": "
When present (e.g. in net or dgram), the error.port property is a number representing\nthe connection's port that is not available.
\n"
                }
              ]
            }
          ],
          "modules": [
            {
              "textRaw": "Common System Errors",
              "name": "common_system_errors",
              "desc": "
This list is not exhaustive, but enumerates many of the common system\nerrors encountered when writing a Node.js program. An exhaustive list may be\nfound here.
\n
    \n
  • EACCES (Permission denied): An attempt was made to access a file in a way\nforbidden by its file access permissions.
    \n
    • \n
  • EADDRINUSE (Address already in use):  An attempt to bind a server\n(net, http, or https) to a local address failed due to\nanother server on the local system already occupying that address.
    \n
    • \n
  • ECONNREFUSED (Connection refused): No connection could be made because the\ntarget machine actively refused it. This usually results from trying to\nconnect to a service that is inactive on the foreign host.
    \n
    • \n
  • ECONNRESET (Connection reset by peer): A connection was forcibly closed by\na peer. This normally results from a loss of the connection on the remote\nsocket due to a timeout or reboot. Commonly encountered via the http\nand net modules.
    \n
    • \n
  • EEXIST (File exists): An existing file was the target of an operation that\nrequired that the target not exist.
    \n
    • \n
  • EISDIR (Is a directory): An operation expected a file, but the given\npathname was a directory.
    \n
    • \n
  • EMFILE (Too many open files in system): Maximum number of\nfile descriptors allowable on the system has been reached, and\nrequests for another descriptor cannot be fulfilled until at least one\nhas been closed. This is encountered when opening many files at once in\nparallel, especially on systems (in particular, OS X) where there is a low\nfile descriptor limit for processes. To remedy a low limit, run\nulimit -n 2048 in the same shell that will run the Node.js process.
    \n
    • \n
  • ENOENT (No such file or directory): Commonly raised by fs operations\nto indicate that a component of the specified pathname does not exist -- no\nentity (file or directory) could be found by the given path.
    \n
    • \n
  • ENOTDIR (Not a directory): A component of the given pathname existed, but\nwas not a directory as expected. Commonly raised by fs.readdir.
    \n
    • \n
  • ENOTEMPTY (Directory not empty): A directory with entries was the target\nof an operation that requires an empty directory -- usually fs.unlink.
    \n
    • \n
  • EPERM (Operation not permitted): An attempt was made to perform an\noperation that requires elevated privileges.
    \n
    • \n
  • EPIPE (Broken pipe): A write on a pipe, socket, or FIFO for which there is\nno process to read the data. Commonly encountered at the net and\nhttp layers, indicative that the remote side of the stream being\nwritten to has been closed.
    \n
    • \n
  • ETIMEDOUT (Operation timed out): A connect or send request failed because\nthe connected party did not properly respond after a period of time. Usually\nencountered by http or net -- often a sign that a socket.end()\nwas not properly called.
    \n
    • \n
\n",
              "type": "module",
              "displayName": "Common System Errors"
            }
          ],
          "type": "misc",
          "displayName": "System Errors"
        }
      ],
      "classes": [
        {
          "textRaw": "Class: Error",
          "type": "class",
          "name": "Error",
          "desc": "
A generic JavaScript Error object that does not denote any specific\ncircumstance of why the error occurred. Error objects capture a "stack trace"\ndetailing the point in the code at which the Error was instantiated, and may\nprovide a text description of the error.
\n
All errors generated by Node.js, including all System and JavaScript errors,\nwill either be instances of, or inherit from, the Error class.
\n",
          "methods": [
            {
              "textRaw": "Error.captureStackTrace(targetObject[, constructorOpt])",
              "type": "method",
              "name": "captureStackTrace",
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`targetObject` {Object} ",
                      "name": "targetObject",
                      "type": "Object"
                    },
                    {
                      "textRaw": "`constructorOpt` {Function} ",
                      "name": "constructorOpt",
                      "type": "Function",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "targetObject"
                    },
                    {
                      "name": "constructorOpt",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Creates a .stack property on targetObject, which when accessed returns\na string representing the location in the code at which\nError.captureStackTrace() was called.
\n
const myObject = {};\nError.captureStackTrace(myObject);\nmyObject.stack  // similar to `new Error().stack`\n
\n
The first line of the trace, instead of being prefixed with ErrorType:\nmessage, will be the result of calling targetObject.toString().
\n
The optional constructorOpt argument accepts a function. If given, all frames\nabove constructorOpt, including constructorOpt, will be omitted from the\ngenerated stack trace.
\n
The constructorOpt argument is useful for hiding implementation\ndetails of error generation from an end user. For instance:
\n
function MyError() {\n  Error.captureStackTrace(this, MyError);\n}\n\n// Without passing MyError to captureStackTrace, the MyError\n// frame would show up in the .stack property. By passing\n// the constructor, we omit that frame and all frames above it.\nnew MyError().stack\n
\n"
            }
          ],
          "properties": [
            {
              "textRaw": "`stackTraceLimit` {Number} ",
              "type": "Number",
              "name": "stackTraceLimit",
              "desc": "
The Error.stackTraceLimit property specifies the number of stack frames\ncollected by a stack trace (whether generated by new Error().stack or\nError.captureStackTrace(obj)).
\n
The default value is 10 but may be set to any valid JavaScript number. Changes\nwill affect any stack trace captured after the value has been changed.
\n
If set to a non-number value, or set to a negative number, stack traces will\nnot capture any frames.
\n",
              "properties": [
                {
                  "textRaw": "`message` {String} ",
                  "type": "String",
                  "name": "message",
                  "desc": "
The error.message property is the string description of the error as set by calling new Error(message).\nThe message passed to the constructor will also appear in the first line of\nthe stack trace of the Error, however changing this property after the\nError object is created may not change the first line of the stack trace\n(for example, when error.stack is read before this property is changed).
\n
const err = new Error('The message');\nconsole.log(err.message);\n  // Prints: The message\n
\n"
                },
                {
                  "textRaw": "`stack` {String} ",
                  "type": "String",
                  "name": "stack",
                  "desc": "
The error.stack property is a string describing the point in the code at which\nthe Error was instantiated.
\n
For example:
\n
Error: Things keep happening!\n   at /home/gbusey/file.js:525:2\n   at Frobnicator.refrobulate (/home/gbusey/business-logic.js:424:21)\n   at Actor.<anonymous> (/home/gbusey/actors.js:400:8)\n   at increaseSynergy (/home/gbusey/actors.js:701:6)\n
The first line is formatted as <error class name>: <error message>, and\nis followed by a series of stack frames (each line beginning with "at ").\nEach frame describes a call site within the code that lead to the error being\ngenerated. V8 attempts to display a name for each function (by variable name,\nfunction name, or object method name), but occasionally it will not be able to\nfind a suitable name. If V8 cannot determine a name for the function, only\nlocation information will be displayed for that frame. Otherwise, the\ndetermined function name will be displayed with location information appended\nin parentheses.
\n
It is important to note that frames are only generated for JavaScript\nfunctions. If, for example, execution synchronously passes through a C++ addon\nfunction called cheetahify, which itself calls a JavaScript function, the\nframe representing the cheetahify call will not be present in the stack\ntraces:
\n
const cheetahify = require('./native-binding.node');\n\nfunction makeFaster() {\n  // cheetahify *synchronously* calls speedy.\n  cheetahify(function speedy() {\n    throw new Error('oh no!');\n  });\n}\n\nmakeFaster(); // will throw:\n  // /home/gbusey/file.js:6\n  //     throw new Error('oh no!');\n  //           ^\n  // Error: oh no!\n  //     at speedy (/home/gbusey/file.js:6:11)\n  //     at makeFaster (/home/gbusey/file.js:5:3)\n  //     at Object.<anonymous> (/home/gbusey/file.js:10:1)\n  //     at Module._compile (module.js:456:26)\n  //     at Object.Module._extensions..js (module.js:474:10)\n  //     at Module.load (module.js:356:32)\n  //     at Function.Module._load (module.js:312:12)\n  //     at Function.Module.runMain (module.js:497:10)\n  //     at startup (node.js:119:16)\n  //     at node.js:906:3\n
\n
The location information will be one of:
\n
    \n
  • native, if the frame represents a call internal to V8 (as in [].forEach).
    • \n
  • plain-filename.js:line:column, if the frame represents a call internal\n to Node.js.
    • \n
  • /absolute/path/to/file.js:line:column, if the frame represents a call in\na user program, or its dependencies.
    • \n
\n
The string representing the stack trace is lazily generated when the\nerror.stack property is accessed.
\n
The number of frames captured by the stack trace is bounded by the smaller of\nError.stackTraceLimit or the number of available frames on the current event\nloop tick.
\n
System-level errors are generated as augmented Error instances, which are\ndetailed here.
\n"
                }
              ]
            }
          ],
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`message` {String} ",
                  "name": "message",
                  "type": "String"
                }
              ],
              "desc": "
Creates a new Error object and sets the error.message property to the\nprovided text message. If an object is passed as message, the text message\nis generated by calling message.toString(). The error.stack property will\nrepresent the point in the code at which new Error() was called. Stack traces\nare dependent on V8's stack trace API. Stack traces extend only to either\n(a) the beginning of  synchronous code execution, or (b) the number of frames\ngiven by the property Error.stackTraceLimit, whichever is smaller.
\n"
            },
            {
              "params": [
                {
                  "name": "message"
                }
              ],
              "desc": "
Creates a new Error object and sets the error.message property to the\nprovided text message. If an object is passed as message, the text message\nis generated by calling message.toString(). The error.stack property will\nrepresent the point in the code at which new Error() was called. Stack traces\nare dependent on V8's stack trace API. Stack traces extend only to either\n(a) the beginning of  synchronous code execution, or (b) the number of frames\ngiven by the property Error.stackTraceLimit, whichever is smaller.
\n"
            }
          ]
        },
        {
          "textRaw": "Class: RangeError",
          "type": "class",
          "name": "RangeError",
          "desc": "
A subclass of Error that indicates that a provided argument was not within the\nset or range of acceptable values for a function; whether that is a numeric\nrange, or outside the set of options for a given function parameter.
\n
For example:
\n
require('net').connect(-1);\n  // throws RangeError, port should be > 0 && < 65536\n
\n
Node.js will generate and throw RangeError instances immediately as a form\nof argument validation.
\n"
        },
        {
          "textRaw": "Class: ReferenceError",
          "type": "class",
          "name": "ReferenceError",
          "desc": "
A subclass of Error that indicates that an attempt is being made to access a\nvariable that is not defined. Such errors commonly indicate typos in code, or\nan otherwise broken program.
\n
While client code may generate and propagate these errors, in practice, only V8\nwill do so.
\n
doesNotExist;\n  // throws ReferenceError, doesNotExist is not a variable in this program.\n
\n
ReferenceError instances will have an error.arguments property whose value\nis an array containing a single element: a string representing the variable\nthat was not defined.
\n
const assert = require('assert');\ntry {\n  doesNotExist;\n} catch(err) {\n  assert(err.arguments[0], 'doesNotExist');\n}\n
\n
Unless an application is dynamically generating and running code,\nReferenceError instances should always be considered a bug in the code\nor its dependencies.
\n"
        },
        {
          "textRaw": "Class: SyntaxError",
          "type": "class",
          "name": "SyntaxError",
          "desc": "
A subclass of Error that indicates that a program is not valid JavaScript.\nThese errors may only be generated and propagated as a result of code\nevaluation. Code evaluation may happen as a result of eval, Function,\nrequire, or vm. These errors are almost always indicative of a broken\nprogram.
\n
try {\n  require('vm').runInThisContext('binary ! isNotOk');\n} catch(err) {\n  // err will be a SyntaxError\n}\n
\n
SyntaxError instances are unrecoverable in the context that created them –\nthey may only be caught by other contexts.
\n"
        },
        {
          "textRaw": "Class: TypeError",
          "type": "class",
          "name": "TypeError",
          "desc": "
A subclass of Error that indicates that a provided argument is not an\nallowable type. For example, passing a function to a parameter which expects a\nstring would be considered a TypeError.
\n
require('url').parse(() => { });\n  // throws TypeError, since it expected a string\n
\n
Node.js will generate and throw TypeError instances immediately as a form\nof argument validation.
\n"
        }
      ]
    }
  ]
}
node-v4.8.2/doc/api/errors.md000644 000766 000024 00000051055 13070706735 016142 0ustar00iojsstaff000000 000000 # Errors



Applications running in Node.js will generally experience four categories of
errors:

- Standard JavaScript errors such as:
  - {EvalError} : thrown when a call to `eval()` fails.
  - {SyntaxError} : thrown in response to improper JavaScript language
    syntax.
  - {RangeError} : thrown when a value is not within an expected range
  - {ReferenceError} : thrown when using undefined variables
  - {TypeError} : thrown when passing arguments of the wrong type
  - {URIError} : thrown when a global URI handling function is misused.
- System errors triggered by underlying operating system constraints such
  as attempting to open a file that does not exist, attempting to send data
  over a closed socket, etc;
- And User-specified errors triggered by application code.
- Assertion Errors are a special class of error that can be triggered whenever
  Node.js detects an exceptional logic violation that should never occur. These
  are raised typically by the `assert` module.

All JavaScript and System errors raised by Node.js inherit from, or are
instances of, the standard JavaScript {Error} class and are guaranteed
to provide *at least* the properties available on that class.

## Error Propagation and Interception



Node.js supports several mechanisms for propagating and handling errors that
occur while an application is running. How these errors are reported and
handled depends entirely on the type of Error and the style of the API that is
called.

All JavaScript errors are handled as exceptions that *immediately* generate
and throw an error using the standard JavaScript `throw` mechanism. These
are handled using the [`try / catch` construct][try-catch] provided by the JavaScript
language.

```js
// Throws with a ReferenceError because z is undefined
try {
  const m = 1;
  const n = m + z;
} catch (err) {
  // Handle the error here.
}
```

Any use of the JavaScript `throw` mechanism will raise an exception that
*must* be handled using `try / catch` or the Node.js process will exit
immediately.

With few exceptions, _Synchronous_ APIs (any blocking method that does not
accept a `callback` function, such as [`fs.readFileSync`][]), will use `throw`
to report errors.

Errors that occur within _Asynchronous APIs_ may be reported in multiple ways:

- Most asynchronous methods that accept a `callback` function will accept an
  `Error` object passed as the first argument to that function. If that first
  argument is not `null` and is an instance of `Error`, then an error occurred
  that should be handled.

  ```js
  const fs = require('fs');
  fs.readFile('a file that does not exist', (err, data) => {
    if (err) {
      console.error('There was an error reading the file!', err);
      return;
    }
    // Otherwise handle the data
  });
  ```
- When an asynchronous method is called on an object that is an `EventEmitter`,
  errors can be routed to that object's `'error'` event.

  ```js
  const net = require('net');
  const connection = net.connect('localhost');

  // Adding an 'error' event handler to a stream:
  connection.on('error', (err) => {
    // If the connection is reset by the server, or if it can't
    // connect at all, or on any sort of error encountered by
    // the connection, the error will be sent here.
    console.error(err);
  });

  connection.pipe(process.stdout);
  ```

- A handful of typically asynchronous methods in the Node.js API may still
  use the `throw` mechanism to raise exceptions that must be handled using
  `try / catch`. There is no comprehensive list of such methods; please
  refer to the documentation of each method to determine the appropriate
  error handling mechanism required.

The use of the `'error'` event mechanism is most common for [stream-based][]
and [event emitter-based][] APIs, which themselves represent a series of
asynchronous operations over time (as opposed to a single operation that may
pass or fail).

For *all* `EventEmitter` objects, if an `'error'` event handler is not
provided, the error will be thrown, causing the Node.js process to report an
unhandled exception and  crash unless either: The [`domain`][domains] module is used
appropriately or a handler has been registered for the
[`process.on('uncaughtException')`][] event.

```js
const EventEmitter = require('events');
const ee = new EventEmitter();

setImmediate(() => {
  // This will crash the process because no 'error' event
  // handler has been added.
  ee.emit('error', new Error('This will crash'));
});
```

Errors generated in this way *cannot* be intercepted using `try / catch` as
they are thrown *after* the calling code has already exited.

Developers must refer to the documentation for each method to determine
exactly how errors raised by those methods are propagated.

### Node.js style callbacks



Most asynchronous methods exposed by the Node.js core API follow an idiomatic
pattern  referred to as a "Node.js style callback". With this pattern, a
callback function is passed to the method as an argument. When the operation
either completes or an error is raised, the callback function is called with
the Error object (if any) passed as the first argument. If no error was raised,
the first argument will be passed as `null`.

```js
const fs = require('fs');

function nodeStyleCallback(err, data) {
 if (err) {
   console.error('There was an error', err);
   return;
 }
 console.log(data);
}

fs.readFile('/some/file/that/does-not-exist', nodeStyleCallback);
fs.readFile('/some/file/that/does-exist', nodeStyleCallback)
```

The JavaScript `try / catch` mechanism **cannot** be used to intercept errors
generated by asynchronous APIs.  A common mistake for beginners is to try to
use `throw` inside a Node.js style callback:

```js
// THIS WILL NOT WORK:
const fs = require('fs');

try {
  fs.readFile('/some/file/that/does-not-exist', (err, data) => {
    // mistaken assumption: throwing here...
    if (err) {
      throw err;
    }
  });
} catch(err) {
  // This will not catch the throw!
  console.log(err);
}
```

This will not work because the callback function passed to `fs.readFile()` is
called asynchronously. By the time the callback has been called, the
surrounding code (including the `try { } catch(err) { }` block will have
already exited. Throwing an error inside the callback **can crash the Node.js
process** in most cases. If [domains][] are enabled, or a handler has been
registered with `process.on('uncaughtException')`, such errors can be
intercepted.

## Class: Error



A generic JavaScript `Error` object that does not denote any specific
circumstance of why the error occurred. `Error` objects capture a "stack trace"
detailing the point in the code at which the `Error` was instantiated, and may
provide a text description of the error.

All errors generated by Node.js, including all System and JavaScript errors,
will either be instances of, or inherit from, the `Error` class.

### new Error(message)

* `message` {String}

Creates a new `Error` object and sets the `error.message` property to the
provided text message. If an object is passed as `message`, the text message
is generated by calling `message.toString()`. The `error.stack` property will
represent the point in the code at which `new Error()` was called. Stack traces
are dependent on [V8's stack trace API][]. Stack traces extend only to either
(a) the beginning of  *synchronous code execution*, or (b) the number of frames
given by the property `Error.stackTraceLimit`, whichever is smaller.

### Error.captureStackTrace(targetObject[, constructorOpt])

* `targetObject` {Object}
* `constructorOpt` {Function}

Creates a `.stack` property on `targetObject`, which when accessed returns
a string representing the location in the code at which
`Error.captureStackTrace()` was called.

```js
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack  // similar to `new Error().stack`
```

The first line of the trace, instead of being prefixed with `ErrorType:
message`, will be the result of calling `targetObject.toString()`.

The optional `constructorOpt` argument accepts a function. If given, all frames
above `constructorOpt`, including `constructorOpt`, will be omitted from the
generated stack trace.

The `constructorOpt` argument is useful for hiding implementation
details of error generation from an end user. For instance:

```js
function MyError() {
  Error.captureStackTrace(this, MyError);
}

// Without passing MyError to captureStackTrace, the MyError
// frame would show up in the .stack property. By passing
// the constructor, we omit that frame and all frames above it.
new MyError().stack
```

### Error.stackTraceLimit

* {Number}

The `Error.stackTraceLimit` property specifies the number of stack frames
collected by a stack trace (whether generated by `new Error().stack` or
`Error.captureStackTrace(obj)`).

The default value is `10` but may be set to any valid JavaScript number. Changes
will affect any stack trace captured *after* the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will
not capture any frames.

#### error.message

* {String}

The `error.message` property is the string description of the error as set by calling `new Error(message)`.
The `message` passed to the constructor will also appear in the first line of
the stack trace of the `Error`, however changing this property after the
`Error` object is created *may not* change the first line of the stack trace
(for example, when `error.stack` is read before this property is changed).

```js
const err = new Error('The message');
console.log(err.message);
  // Prints: The message
```

#### error.stack

* {String}

The `error.stack` property is a string describing the point in the code at which
the `Error` was instantiated.

For example:

```
Error: Things keep happening!
   at /home/gbusey/file.js:525:2
   at Frobnicator.refrobulate (/home/gbusey/business-logic.js:424:21)
   at Actor. (/home/gbusey/actors.js:400:8)
   at increaseSynergy (/home/gbusey/actors.js:701:6)
```

The first line is formatted as `: `, and
is followed by a series of stack frames (each line beginning with "at ").
Each frame describes a call site within the code that lead to the error being
generated. V8 attempts to display a name for each function (by variable name,
function name, or object method name), but occasionally it will not be able to
find a suitable name. If V8 cannot determine a name for the function, only
location information will be displayed for that frame. Otherwise, the
determined function name will be displayed with location information appended
in parentheses.

It is important to note that frames are **only** generated for JavaScript
functions. If, for example, execution synchronously passes through a C++ addon
function called `cheetahify`, which itself calls a JavaScript function, the
frame representing the `cheetahify` call will **not** be present in the stack
traces:

```js
const cheetahify = require('./native-binding.node');

function makeFaster() {
  // cheetahify *synchronously* calls speedy.
  cheetahify(function speedy() {
    throw new Error('oh no!');
  });
}

makeFaster(); // will throw:
  // /home/gbusey/file.js:6
  //     throw new Error('oh no!');
  //           ^
  // Error: oh no!
  //     at speedy (/home/gbusey/file.js:6:11)
  //     at makeFaster (/home/gbusey/file.js:5:3)
  //     at Object. (/home/gbusey/file.js:10:1)
  //     at Module._compile (module.js:456:26)
  //     at Object.Module._extensions..js (module.js:474:10)
  //     at Module.load (module.js:356:32)
  //     at Function.Module._load (module.js:312:12)
  //     at Function.Module.runMain (module.js:497:10)
  //     at startup (node.js:119:16)
  //     at node.js:906:3
```

The location information will be one of:

* `native`, if the frame represents a call internal to V8 (as in `[].forEach`).
* `plain-filename.js:line:column`, if the frame represents a call internal
   to Node.js.
* `/absolute/path/to/file.js:line:column`, if the frame represents a call in
  a user program, or its dependencies.

The string representing the stack trace is lazily generated when the
`error.stack` property is **accessed**.

The number of frames captured by the stack trace is bounded by the smaller of
`Error.stackTraceLimit` or the number of available frames on the current event
loop tick.

System-level errors are generated as augmented `Error` instances, which are
detailed [here](#errors_system_errors).

## Class: RangeError

A subclass of `Error` that indicates that a provided argument was not within the
set or range of acceptable values for a function; whether that is a numeric
range, or outside the set of options for a given function parameter.

For example:

```js
require('net').connect(-1);
  // throws RangeError, port should be > 0 && < 65536
```

Node.js will generate and throw `RangeError` instances *immediately* as a form
of argument validation.

## Class: ReferenceError

A subclass of `Error` that indicates that an attempt is being made to access a
variable that is not defined. Such errors commonly indicate typos in code, or
an otherwise broken program.

While client code may generate and propagate these errors, in practice, only V8
will do so.

```js
doesNotExist;
  // throws ReferenceError, doesNotExist is not a variable in this program.
```

`ReferenceError` instances will have an `error.arguments` property whose value
is an array containing a single element: a string representing the variable
that was not defined.

```js
const assert = require('assert');
try {
  doesNotExist;
} catch(err) {
  assert(err.arguments[0], 'doesNotExist');
}
```

Unless an application is dynamically generating and running code,
`ReferenceError` instances should always be considered a bug in the code
or its dependencies.

## Class: SyntaxError

A subclass of `Error` that indicates that a program is not valid JavaScript.
These errors may only be generated and propagated as a result of code
evaluation. Code evaluation may happen as a result of `eval`, `Function`,
`require`, or [vm][]. These errors are almost always indicative of a broken
program.

```js
try {
  require('vm').runInThisContext('binary ! isNotOk');
} catch(err) {
  // err will be a SyntaxError
}
```

`SyntaxError` instances are unrecoverable in the context that created them –
they may only be caught by other contexts.

## Class: TypeError

A subclass of `Error` that indicates that a provided argument is not an
allowable type. For example, passing a function to a parameter which expects a
string would be considered a TypeError.

```js
require('url').parse(() => { });
  // throws TypeError, since it expected a string
```

Node.js will generate and throw `TypeError` instances *immediately* as a form
of argument validation.

## Exceptions vs. Errors



A JavaScript exception is a value that is thrown as a result of an invalid
operation or as the target of a `throw` statement. While it is not required
that these values are instances of `Error` or classes which inherit from
`Error`, all exceptions thrown by Node.js or the JavaScript runtime *will* be
instances of Error.

Some exceptions are *unrecoverable* at the JavaScript layer. Such exceptions
will *always* cause the Node.js process to crash. Examples include `assert()`
checks or `abort()` calls in the C++ layer.

## System Errors

System errors are generated when exceptions occur within the program's
runtime environment. Typically, these are operational errors that occur
when an application violates an operating system constraint such as attempting
to read a file that does not exist or when the user does not have sufficient
permissions.

System errors are typically generated at the syscall level: an exhaustive list
of error codes and their meanings is available by running `man 2 intro` or
`man 3 errno` on most Unices; or [online][].

In Node.js, system errors are represented as augmented `Error` objects with
added properties.

### Class: System Error

#### error.code

* {String}

The `error.code` property is a string representing the error code, which is always
`E` followed by a sequence of capital letters.

#### error.errno

* {String | Number}

The `error.errno` property is a number or a string.
The number is a **negative** value which corresponds to the error code defined in
[`libuv Error handling`]. See uv-errno.h header file (`deps/uv/include/uv-errno.h` in
the Node.js source tree) for details.
In case of a string, it is the same as `error.code`.

#### error.syscall

* {String}

The `error.syscall` property is a string describing the [syscall][] that failed.

#### error.path

* {String}

When present (e.g. in `fs` or `child_process`), the `error.path` property is a string
containing a relevant invalid pathname.

#### error.address

* {String}

When present (e.g. in `net` or `dgram`), the `error.address` property is a string
describing the address to which the connection failed.

#### error.port

* {Number}

When present (e.g. in `net` or `dgram`), the `error.port` property is a number representing
the connection's port that is not available.

### Common System Errors

This list is **not exhaustive**, but enumerates many of the common system
errors encountered when writing a Node.js program. An exhaustive list may be
found [here][online].

- `EACCES` (Permission denied): An attempt was made to access a file in a way
  forbidden by its file access permissions.

- `EADDRINUSE` (Address already in use):  An attempt to bind a server
  ([`net`][], [`http`][], or [`https`][]) to a local address failed due to
  another server on the local system already occupying that address.

- `ECONNREFUSED` (Connection refused): No connection could be made because the
  target machine actively refused it. This usually results from trying to
  connect to a service that is inactive on the foreign host.

- `ECONNRESET` (Connection reset by peer): A connection was forcibly closed by
  a peer. This normally results from a loss of the connection on the remote
  socket due to a timeout or reboot. Commonly encountered via the [`http`][]
  and [`net`][] modules.

- `EEXIST` (File exists): An existing file was the target of an operation that
  required that the target not exist.

- `EISDIR` (Is a directory): An operation expected a file, but the given
  pathname was a directory.

- `EMFILE` (Too many open files in system): Maximum number of
  [file descriptors][] allowable on the system has been reached, and
  requests for another descriptor cannot be fulfilled until at least one
  has been closed. This is encountered when opening many files at once in
  parallel, especially on systems (in particular, OS X) where there is a low
  file descriptor limit for processes. To remedy a low limit, run
  `ulimit -n 2048` in the same shell that will run the Node.js process.

- `ENOENT` (No such file or directory): Commonly raised by [`fs`][] operations
  to indicate that a component of the specified pathname does not exist -- no
  entity (file or directory) could be found by the given path.

- `ENOTDIR` (Not a directory): A component of the given pathname existed, but
  was not a directory as expected. Commonly raised by [`fs.readdir`][].

- `ENOTEMPTY` (Directory not empty): A directory with entries was the target
  of an operation that requires an empty directory -- usually [`fs.unlink`][].

- `EPERM` (Operation not permitted): An attempt was made to perform an
  operation that requires elevated privileges.

- `EPIPE` (Broken pipe): A write on a pipe, socket, or FIFO for which there is
  no process to read the data. Commonly encountered at the [`net`][] and
  [`http`][] layers, indicative that the remote side of the stream being
  written to has been closed.

- `ETIMEDOUT` (Operation timed out): A connect or send request failed because
  the connected party did not properly respond after a period of time. Usually
  encountered by [`http`][] or [`net`][] -- often a sign that a `socket.end()`
  was not properly called.

[`fs.readdir`]: fs.html#fs_fs_readdir_path_callback
[`fs.readFileSync`]: fs.html#fs_fs_readfilesync_file_options
[`fs.unlink`]: fs.html#fs_fs_unlink_path_callback
[`fs`]: fs.html
[`http`]: http.html
[`https`]: https.html
[`libuv Error handling`]: http://docs.libuv.org/en/v1.x/errors.html
[`net`]: net.html
[`process.on('uncaughtException')`]: process.html#process_event_uncaughtexception
[domains]: domain.html
[event emitter-based]: events.html#events_class_events_eventemitter
[file descriptors]: https://en.wikipedia.org/wiki/File_descriptor
[online]: http://man7.org/linux/man-pages/man3/errno.3.html
[stream-based]: stream.html
[syscall]: http://man7.org/linux/man-pages/man2/syscall.2.html
[try-catch]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/try...catch
[V8's stack trace API]: https://github.com/v8/v8/wiki/Stack-Trace-API
[vm]: vm.html
node-v4.8.2/doc/api/events.html000644 000766 000024 00000066373 13070706740 016503 0ustar00iojsstaff000000 000000 


  
  Events | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

      

        
Events#


Stability: 2 - Stable


Much of the Node.js core API is built around an idiomatic asynchronous
event-driven architecture in which certain kinds of objects (called "emitters")
periodically emit named events that cause Function objects ("listeners") to be
called.


For instance: a net.Server object emits an event each time a peer
connects to it; a fs.ReadStream emits an event when the file is opened;
a stream emits an event whenever data is available to be read.


All objects that emit events are instances of the EventEmitter class. These
objects expose an eventEmitter.on() function that allows one or more
Functions to be attached to named events emitted by the object. Typically,
event names are camel-cased strings but any valid JavaScript property key
can be used.


When the EventEmitter object emits an event, all of the Functions attached
to that specific event are called synchronously. Any values returned by the
called listeners are ignored and will be discarded.


The following example shows a simple EventEmitter instance with a single
listener. The eventEmitter.on() method is used to register listeners, while
the eventEmitter.emit() method is used to trigger the event.


const EventEmitter = require('events');
const util = require('util');

function MyEmitter() {
  EventEmitter.call(this);
}
util.inherits(MyEmitter, EventEmitter);

const myEmitter = new MyEmitter();
myEmitter.on('event', () => {
  console.log('an event occurred!');
});
myEmitter.emit('event');



Any object can become an EventEmitter through inheritance. The example above
uses the traditional Node.js style prototypical inheritance using
the util.inherits() method. It is, however, possible to use ES6 classes as
well:


const EventEmitter = require('events');

class MyEmitter extends EventEmitter {}

const myEmitter = new MyEmitter();
myEmitter.on('event', () => {
  console.log('an event occurred!');
});
myEmitter.emit('event');



Passing arguments and this to listeners#


The eventEmitter.emit() method allows an arbitrary set of arguments to be
passed to the listener functions. It is important to keep in mind that when an
ordinary listener function is called by the EventEmitter, the standard this
keyword is intentionally set to reference the EventEmitter to which the
listener is attached.


const myEmitter = new MyEmitter();
myEmitter.on('event', function(a, b) {
  console.log(a, b, this);
    // Prints:
    //   a b MyEmitter {
    //     domain: null,
    //     _events: { event: [Function] },
    //     _eventsCount: 1,
    //     _maxListeners: undefined }
});
myEmitter.emit('event', 'a', 'b');



It is possible to use ES6 Arrow Functions as listeners, however, when doing so,
the this keyword will no longer reference the EventEmitter instance:


const myEmitter = new MyEmitter();
myEmitter.on('event', (a, b) => {
  console.log(a, b, this);
    // Prints: a b {}
});
myEmitter.emit('event', 'a', 'b');



Asynchronous vs. Synchronous#


The EventListener calls all listeners synchronously in the order in which
they were registered. This is important to ensure the proper sequencing of
events and to avoid race conditions or logic errors. When appropriate,
listener functions can switch to an asynchronous mode of operation using
the setImmediate() or process.nextTick() methods:


const myEmitter = new MyEmitter();
myEmitter.on('event', (a, b) => {
  setImmediate(() => {
    console.log('this happens asynchronously');
  });
});
myEmitter.emit('event', 'a', 'b');



Handling events only once#


When a listener is registered using the eventEmitter.on() method, that
listener will be invoked every time the named event is emitted.


const myEmitter = new MyEmitter();
var m = 0;
myEmitter.on('event', () => {
  console.log(++m);
});
myEmitter.emit('event');
  // Prints: 1
myEmitter.emit('event');
  // Prints: 2



Using the eventEmitter.once() method, it is possible to register a listener
that is unregistered before it is called.


const myEmitter = new MyEmitter();
var m = 0;
myEmitter.once('event', () => {
  console.log(++m);
});
myEmitter.emit('event');
  // Prints: 1
myEmitter.emit('event');
  // Ignored



Error events#


When an error occurs within an EventEmitter instance, the typical action is
for an 'error' event to be emitted. These are treated as a special case
within Node.js.


If an EventEmitter does not have at least one listener registered for the
'error' event, and an 'error' event is emitted, the error is thrown, a
stack trace is printed, and the Node.js process exits.


const myEmitter = new MyEmitter();
myEmitter.emit('error', new Error('whoops!'));
  // Throws and crashes Node.js



To guard against crashing the Node.js process, developers can either register
a listener for the process.on('uncaughtException') event or use the
domain module (Note, however, that the domain module has been
deprecated).


const myEmitter = new MyEmitter();

process.on('uncaughtException', (err) => {
  console.log('whoops! there was an error');
});

myEmitter.emit('error', new Error('whoops!'));
  // Prints: whoops! there was an error



As a best practice, developers should always register listeners for the
'error' event:


const myEmitter = new MyEmitter();
myEmitter.on('error', (err) => {
  console.log('whoops! there was an error');
});
myEmitter.emit('error', new Error('whoops!'));
  // Prints: whoops! there was an error



Class: EventEmitter#



Added in: v0.1.26

The EventEmitter class is defined and exposed by the events module:


const EventEmitter = require('events');



All EventEmitters emit the event 'newListener' when new listeners are
added and 'removeListener' when a listener is removed.


Event: 'newListener'#



Added in: v0.1.26



The EventEmitter instance will emit it's own 'newListener' event before
a listener is added to it's internal array of listeners.


Listeners registered for the 'newListener' event will be passed the event
name and a reference to the listener being added.


The fact that the event is triggered before adding the listener has a subtle
but important side effect: any additional listeners registered to the same
name within the 'newListener' callback will be inserted before the
listener that is in the process of being added.


const myEmitter = new MyEmitter();
// Only do this once so we don't loop forever
myEmitter.once('newListener', (event, listener) => {
  if (event === 'event') {
    // Insert a new listener in front
    myEmitter.on('event', () => {
      console.log('B');
    });
  }
});
myEmitter.on('event', () => {
  console.log('A');
});
myEmitter.emit('event');
  // Prints:
  //   B
  //   A



Event: 'removeListener'#



Added in: v0.9.3



The 'removeListener' event is emitted after a listener is removed.


EventEmitter.listenerCount(emitter, eventName)#



Added in: v0.9.12
Deprecated since: v4.0.0 

Stability: 0 - Deprecated: Use emitter.listenerCount() instead.
A class method that returns the number of listeners for the given eventName
registered on the given emitter.


const myEmitter = new MyEmitter();
myEmitter.on('event', () => {});
myEmitter.on('event', () => {});
console.log(EventEmitter.listenerCount(myEmitter, 'event'));
  // Prints: 2



EventEmitter.defaultMaxListeners#



Added in: v0.11.2

By default, a maximum of 10 listeners can be registered for any single
event. This limit can be changed for individual EventEmitter instances
using the emitter.setMaxListeners(n) method. To change the default
for all EventEmitter instances, the EventEmitter.defaultMaxListeners
property can be used.


Take caution when setting the EventEmitter.defaultMaxListeners because the
change effects all EventEmitter instances, including those created before
the change is made. However, calling emitter.setMaxListeners(n) still has
precedence over EventEmitter.defaultMaxListeners.


Note that this is not a hard limit. The EventEmitter instance will allow
more listeners to be added but will output a trace warning to stderr indicating
that a possible EventEmitter memory leak has been detected. For any single
EventEmitter, the emitter.getMaxListeners() and emitter.setMaxListeners()
methods can be used to temporarily avoid this warning:


emitter.setMaxListeners(emitter.getMaxListeners() + 1);
emitter.once('event', () => {
  // do stuff
  emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0));
});



emitter.addListener(eventName, listener)#



Added in: v0.1.26

Alias for emitter.on(eventName, listener).


emitter.emit(eventName[, arg1][, arg2][, ...])#



Added in: v0.1.26

Synchronously calls each of the listeners registered for the event named
eventName, in the order they were registered, passing the supplied arguments
to each.


Returns true if the event had listeners, false otherwise.


emitter.getMaxListeners()#



Added in: v1.0.0

Returns the current max listener value for the EventEmitter which is either
set by emitter.setMaxListeners(n) or defaults to
EventEmitter.defaultMaxListeners.


emitter.listenerCount(eventName)#



Added in: v3.2.0

    

  • eventName <Value> The name of the event being listened for
    • 



Returns the number of listeners listening to the event named eventName.


emitter.listeners(eventName)#



Added in: v0.1.26

Returns a copy of the array of listeners for the event named eventName.


server.on('connection', (stream) => {
  console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
  // Prints: [ [Function] ]



emitter.on(eventName, listener)#



Added in: v0.1.101

Adds the listener function to the end of the listeners array for the
event named eventName. No checks are made to see if the listener has
already been added. Multiple calls passing the same combination of eventName
and listener will result in the listener being added, and called, multiple
times.


server.on('connection', (stream) => {
  console.log('someone connected!');
});



Returns a reference to the EventEmitter so calls can be chained.


emitter.once(eventName, listener)#



Added in: v0.3.0

Adds a one time listener function for the event named eventName. The
next time eventName is triggered, this listener is removed and then invoked.


server.once('connection', (stream) => {
  console.log('Ah, we have our first user!');
});



Returns a reference to the EventEmitter so calls can be chained.


emitter.removeAllListeners([eventName])#



Added in: v0.1.26

Removes all listeners, or those of the specified eventName.


Note that it is bad practice to remove listeners added elsewhere in the code,
particularly when the EventEmitter instance was created by some other
component or module (e.g. sockets or file streams).


Returns a reference to the EventEmitter so calls can be chained.


emitter.removeListener(eventName, listener)#



Added in: v0.1.26

Removes the specified listener from the listener array for the event named
eventName.


var callback = (stream) => {
  console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);



removeListener will remove, at most, one instance of a listener from the
listener array. If any single listener has been added multiple times to the
listener array for the specified eventName, then removeListener must be
called multiple times to remove each instance.


Note that once an event has been emitted, all listeners attached to it at the
time of emitting will be called in order. This implies that any removeListener()
or removeAllListeners() calls after emitting and before the last listener
finishes execution will not remove them from emit() in progress. Subsequent
events will behave as expected.


const myEmitter = new MyEmitter();

var callbackA = () => {
  console.log('A');
  myEmitter.removeListener('event', callbackB);
};

var callbackB = () => {
  console.log('B');
};

myEmitter.on('event', callbackA);

myEmitter.on('event', callbackB);

// callbackA removes listener callbackB but it will still be called.
// Internal listener array at time of emit [callbackA, callbackB]
myEmitter.emit('event');
  // Prints:
  //   A
  //   B

// callbackB is now removed.
// Internal listener array [callbackA]
myEmitter.emit('event');
  // Prints:
  //   A



Because listeners are managed using an internal array, calling this will
change the position indices of any listener registered after the listener
being removed. This will not impact the order in which listeners are called,
but it will means that any copies of the listener array as returned by
the emitter.listeners() method will need to be recreated.


Returns a reference to the EventEmitter so calls can be chained.


emitter.setMaxListeners(n)#



Added in: v0.3.5

By default EventEmitters will print a warning if more than 10 listeners are
added for a particular event. This is a useful default that helps finding
memory leaks. Obviously, not all events should be limited to just 10 listeners.
The emitter.setMaxListeners() method allows the limit to be modified for this
specific EventEmitter instance. The value can be set to Infinity (or 0)
to indicate an unlimited number of listeners.


Returns a reference to the EventEmitter so calls can be chained.


      

    

  

  
  
  
  



node-v4.8.2/doc/api/events.json000644 000766 000024 00000061212 13070706740 016473 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/events.md",
  "modules": [
    {
      "textRaw": "Events",
      "name": "Events",
      "stability": 2,
      "stabilityText": "Stable",
      "type": "module",
      "desc": "
Much of the Node.js core API is built around an idiomatic asynchronous\nevent-driven architecture in which certain kinds of objects (called "emitters")\nperiodically emit named events that cause Function objects ("listeners") to be\ncalled.
\n
For instance: a net.Server object emits an event each time a peer\nconnects to it; a fs.ReadStream emits an event when the file is opened;\na stream emits an event whenever data is available to be read.
\n
All objects that emit events are instances of the EventEmitter class. These\nobjects expose an eventEmitter.on() function that allows one or more\nFunctions to be attached to named events emitted by the object. Typically,\nevent names are camel-cased strings but any valid JavaScript property key\ncan be used.
\n
When the EventEmitter object emits an event, all of the Functions attached\nto that specific event are called synchronously. Any values returned by the\ncalled listeners are ignored and will be discarded.
\n
The following example shows a simple EventEmitter instance with a single\nlistener. The eventEmitter.on() method is used to register listeners, while\nthe eventEmitter.emit() method is used to trigger the event.
\n
const EventEmitter = require('events');\nconst util = require('util');\n\nfunction MyEmitter() {\n  EventEmitter.call(this);\n}\nutil.inherits(MyEmitter, EventEmitter);\n\nconst myEmitter = new MyEmitter();\nmyEmitter.on('event', () => {\n  console.log('an event occurred!');\n});\nmyEmitter.emit('event');\n
\n
Any object can become an EventEmitter through inheritance. The example above\nuses the traditional Node.js style prototypical inheritance using\nthe util.inherits() method. It is, however, possible to use ES6 classes as\nwell:
\n
const EventEmitter = require('events');\n\nclass MyEmitter extends EventEmitter {}\n\nconst myEmitter = new MyEmitter();\nmyEmitter.on('event', () => {\n  console.log('an event occurred!');\n});\nmyEmitter.emit('event');\n
\n",
      "modules": [
        {
          "textRaw": "Passing arguments and `this` to listeners",
          "name": "passing_arguments_and_`this`_to_listeners",
          "desc": "
The eventEmitter.emit() method allows an arbitrary set of arguments to be\npassed to the listener functions. It is important to keep in mind that when an\nordinary listener function is called by the EventEmitter, the standard this\nkeyword is intentionally set to reference the EventEmitter to which the\nlistener is attached.
\n
const myEmitter = new MyEmitter();\nmyEmitter.on('event', function(a, b) {\n  console.log(a, b, this);\n    // Prints:\n    //   a b MyEmitter {\n    //     domain: null,\n    //     _events: { event: [Function] },\n    //     _eventsCount: 1,\n    //     _maxListeners: undefined }\n});\nmyEmitter.emit('event', 'a', 'b');\n
\n
It is possible to use ES6 Arrow Functions as listeners, however, when doing so,\nthe this keyword will no longer reference the EventEmitter instance:
\n
const myEmitter = new MyEmitter();\nmyEmitter.on('event', (a, b) => {\n  console.log(a, b, this);\n    // Prints: a b {}\n});\nmyEmitter.emit('event', 'a', 'b');\n
\n",
          "type": "module",
          "displayName": "Passing arguments and `this` to listeners"
        },
        {
          "textRaw": "Asynchronous vs. Synchronous",
          "name": "asynchronous_vs._synchronous",
          "desc": "
The EventListener calls all listeners synchronously in the order in which\nthey were registered. This is important to ensure the proper sequencing of\nevents and to avoid race conditions or logic errors. When appropriate,\nlistener functions can switch to an asynchronous mode of operation using\nthe setImmediate() or process.nextTick() methods:
\n
const myEmitter = new MyEmitter();\nmyEmitter.on('event', (a, b) => {\n  setImmediate(() => {\n    console.log('this happens asynchronously');\n  });\n});\nmyEmitter.emit('event', 'a', 'b');\n
\n",
          "type": "module",
          "displayName": "Asynchronous vs. Synchronous"
        },
        {
          "textRaw": "Handling events only once",
          "name": "handling_events_only_once",
          "desc": "
When a listener is registered using the eventEmitter.on() method, that\nlistener will be invoked every time the named event is emitted.
\n
const myEmitter = new MyEmitter();\nvar m = 0;\nmyEmitter.on('event', () => {\n  console.log(++m);\n});\nmyEmitter.emit('event');\n  // Prints: 1\nmyEmitter.emit('event');\n  // Prints: 2\n
\n
Using the eventEmitter.once() method, it is possible to register a listener\nthat is unregistered before it is called.
\n
const myEmitter = new MyEmitter();\nvar m = 0;\nmyEmitter.once('event', () => {\n  console.log(++m);\n});\nmyEmitter.emit('event');\n  // Prints: 1\nmyEmitter.emit('event');\n  // Ignored\n
\n",
          "type": "module",
          "displayName": "Handling events only once"
        },
        {
          "textRaw": "Error events",
          "name": "error_events",
          "desc": "
When an error occurs within an EventEmitter instance, the typical action is\nfor an 'error' event to be emitted. These are treated as a special case\nwithin Node.js.
\n
If an EventEmitter does not have at least one listener registered for the\n'error' event, and an 'error' event is emitted, the error is thrown, a\nstack trace is printed, and the Node.js process exits.
\n
const myEmitter = new MyEmitter();\nmyEmitter.emit('error', new Error('whoops!'));\n  // Throws and crashes Node.js\n
\n
To guard against crashing the Node.js process, developers can either register\na listener for the process.on('uncaughtException') event or use the\ndomain module (Note, however, that the domain module has been\ndeprecated).
\n
const myEmitter = new MyEmitter();\n\nprocess.on('uncaughtException', (err) => {\n  console.log('whoops! there was an error');\n});\n\nmyEmitter.emit('error', new Error('whoops!'));\n  // Prints: whoops! there was an error\n
\n
As a best practice, developers should always register listeners for the\n'error' event:
\n
const myEmitter = new MyEmitter();\nmyEmitter.on('error', (err) => {\n  console.log('whoops! there was an error');\n});\nmyEmitter.emit('error', new Error('whoops!'));\n  // Prints: whoops! there was an error\n
\n",
          "type": "module",
          "displayName": "Error events"
        }
      ],
      "classes": [
        {
          "textRaw": "Class: EventEmitter",
          "type": "class",
          "name": "EventEmitter",
          "meta": {
            "added": [
              "v0.1.26"
            ]
          },
          "desc": "
The EventEmitter class is defined and exposed by the events module:
\n
const EventEmitter = require('events');\n
\n
All EventEmitters emit the event 'newListener' when new listeners are\nadded and 'removeListener' when a listener is removed.
\n",
          "events": [
            {
              "textRaw": "Event: 'newListener'",
              "type": "event",
              "name": "newListener",
              "meta": {
                "added": [
                  "v0.1.26"
                ]
              },
              "params": [],
              "desc": "
The EventEmitter instance will emit it's own 'newListener' event before\na listener is added to it's internal array of listeners.
\n
Listeners registered for the 'newListener' event will be passed the event\nname and a reference to the listener being added.
\n
The fact that the event is triggered before adding the listener has a subtle\nbut important side effect: any additional listeners registered to the same\nname within the 'newListener' callback will be inserted before the\nlistener that is in the process of being added.
\n
const myEmitter = new MyEmitter();\n// Only do this once so we don't loop forever\nmyEmitter.once('newListener', (event, listener) => {\n  if (event === 'event') {\n    // Insert a new listener in front\n    myEmitter.on('event', () => {\n      console.log('B');\n    });\n  }\n});\nmyEmitter.on('event', () => {\n  console.log('A');\n});\nmyEmitter.emit('event');\n  // Prints:\n  //   B\n  //   A\n
\n"
            },
            {
              "textRaw": "Event: 'removeListener'",
              "type": "event",
              "name": "removeListener",
              "meta": {
                "added": [
                  "v0.9.3"
                ]
              },
              "params": [],
              "desc": "
The 'removeListener' event is emitted after a listener is removed.
\n"
            }
          ],
          "methods": [
            {
              "textRaw": "EventEmitter.listenerCount(emitter, eventName)",
              "type": "method",
              "name": "listenerCount",
              "meta": {
                "added": [
                  "v0.9.12"
                ],
                "deprecated": [
                  "v4.0.0"
                ]
              },
              "stability": 0,
              "stabilityText": "Deprecated: Use [`emitter.listenerCount()`][] instead.",
              "desc": "
A class method that returns the number of listeners for the given eventName\nregistered on the given emitter.
\n
const myEmitter = new MyEmitter();\nmyEmitter.on('event', () => {});\nmyEmitter.on('event', () => {});\nconsole.log(EventEmitter.listenerCount(myEmitter, 'event'));\n  // Prints: 2\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "emitter"
                    },
                    {
                      "name": "eventName"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "emitter.addListener(eventName, listener)",
              "type": "method",
              "name": "addListener",
              "meta": {
                "added": [
                  "v0.1.26"
                ]
              },
              "desc": "
Alias for emitter.on(eventName, listener).
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "eventName"
                    },
                    {
                      "name": "listener"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "emitter.emit(eventName[, arg1][, arg2][, ...])",
              "type": "method",
              "name": "emit",
              "meta": {
                "added": [
                  "v0.1.26"
                ]
              },
              "desc": "
Synchronously calls each of the listeners registered for the event named\neventName, in the order they were registered, passing the supplied arguments\nto each.
\n
Returns true if the event had listeners, false otherwise.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "eventName"
                    },
                    {
                      "name": "arg1",
                      "optional": true
                    },
                    {
                      "name": "arg2",
                      "optional": true
                    },
                    {
                      "name": "...",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "emitter.getMaxListeners()",
              "type": "method",
              "name": "getMaxListeners",
              "meta": {
                "added": [
                  "v1.0.0"
                ]
              },
              "desc": "
Returns the current max listener value for the EventEmitter which is either\nset by emitter.setMaxListeners(n) or defaults to\nEventEmitter.defaultMaxListeners.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "emitter.listenerCount(eventName)",
              "type": "method",
              "name": "listenerCount",
              "meta": {
                "added": [
                  "v3.2.0"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`eventName` {Value} The name of the event being listened for ",
                      "name": "eventName",
                      "type": "Value",
                      "desc": "The name of the event being listened for"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "eventName"
                    }
                  ]
                }
              ],
              "desc": "
Returns the number of listeners listening to the event named eventName.
\n"
            },
            {
              "textRaw": "emitter.listeners(eventName)",
              "type": "method",
              "name": "listeners",
              "meta": {
                "added": [
                  "v0.1.26"
                ]
              },
              "desc": "
Returns a copy of the array of listeners for the event named eventName.
\n
server.on('connection', (stream) => {\n  console.log('someone connected!');\n});\nconsole.log(util.inspect(server.listeners('connection')));\n  // Prints: [ [Function] ]\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "eventName"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "emitter.on(eventName, listener)",
              "type": "method",
              "name": "on",
              "meta": {
                "added": [
                  "v0.1.101"
                ]
              },
              "desc": "
Adds the listener function to the end of the listeners array for the\nevent named eventName. No checks are made to see if the listener has\nalready been added. Multiple calls passing the same combination of eventName\nand listener will result in the listener being added, and called, multiple\ntimes.
\n
server.on('connection', (stream) => {\n  console.log('someone connected!');\n});\n
\n
Returns a reference to the EventEmitter so calls can be chained.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "eventName"
                    },
                    {
                      "name": "listener"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "emitter.once(eventName, listener)",
              "type": "method",
              "name": "once",
              "meta": {
                "added": [
                  "v0.3.0"
                ]
              },
              "desc": "
Adds a one time listener function for the event named eventName. The\nnext time eventName is triggered, this listener is removed and then invoked.
\n
server.once('connection', (stream) => {\n  console.log('Ah, we have our first user!');\n});\n
\n
Returns a reference to the EventEmitter so calls can be chained.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "eventName"
                    },
                    {
                      "name": "listener"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "emitter.removeAllListeners([eventName])",
              "type": "method",
              "name": "removeAllListeners",
              "meta": {
                "added": [
                  "v0.1.26"
                ]
              },
              "desc": "
Removes all listeners, or those of the specified eventName.
\n
Note that it is bad practice to remove listeners added elsewhere in the code,\nparticularly when the EventEmitter instance was created by some other\ncomponent or module (e.g. sockets or file streams).
\n
Returns a reference to the EventEmitter so calls can be chained.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "eventName",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "emitter.removeListener(eventName, listener)",
              "type": "method",
              "name": "removeListener",
              "meta": {
                "added": [
                  "v0.1.26"
                ]
              },
              "desc": "
Removes the specified listener from the listener array for the event named\neventName.
\n
var callback = (stream) => {\n  console.log('someone connected!');\n};\nserver.on('connection', callback);\n// ...\nserver.removeListener('connection', callback);\n
\n
removeListener will remove, at most, one instance of a listener from the\nlistener array. If any single listener has been added multiple times to the\nlistener array for the specified eventName, then removeListener must be\ncalled multiple times to remove each instance.
\n
Note that once an event has been emitted, all listeners attached to it at the\ntime of emitting will be called in order. This implies that any removeListener()\nor removeAllListeners() calls after emitting and before the last listener\nfinishes execution will not remove them from emit() in progress. Subsequent\nevents will behave as expected.
\n
const myEmitter = new MyEmitter();\n\nvar callbackA = () => {\n  console.log('A');\n  myEmitter.removeListener('event', callbackB);\n};\n\nvar callbackB = () => {\n  console.log('B');\n};\n\nmyEmitter.on('event', callbackA);\n\nmyEmitter.on('event', callbackB);\n\n// callbackA removes listener callbackB but it will still be called.\n// Internal listener array at time of emit [callbackA, callbackB]\nmyEmitter.emit('event');\n  // Prints:\n  //   A\n  //   B\n\n// callbackB is now removed.\n// Internal listener array [callbackA]\nmyEmitter.emit('event');\n  // Prints:\n  //   A\n
\n
Because listeners are managed using an internal array, calling this will\nchange the position indices of any listener registered after the listener\nbeing removed. This will not impact the order in which listeners are called,\nbut it will means that any copies of the listener array as returned by\nthe emitter.listeners() method will need to be recreated.
\n
Returns a reference to the EventEmitter so calls can be chained.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "eventName"
                    },
                    {
                      "name": "listener"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "emitter.setMaxListeners(n)",
              "type": "method",
              "name": "setMaxListeners",
              "meta": {
                "added": [
                  "v0.3.5"
                ]
              },
              "desc": "
By default EventEmitters will print a warning if more than 10 listeners are\nadded for a particular event. This is a useful default that helps finding\nmemory leaks. Obviously, not all events should be limited to just 10 listeners.\nThe emitter.setMaxListeners() method allows the limit to be modified for this\nspecific EventEmitter instance. The value can be set to Infinity (or 0)\nto indicate an unlimited number of listeners.
\n
Returns a reference to the EventEmitter so calls can be chained.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "n"
                    }
                  ]
                }
              ]
            }
          ],
          "properties": [
            {
              "textRaw": "EventEmitter.defaultMaxListeners",
              "name": "defaultMaxListeners",
              "meta": {
                "added": [
                  "v0.11.2"
                ]
              },
              "desc": "
By default, a maximum of 10 listeners can be registered for any single\nevent. This limit can be changed for individual EventEmitter instances\nusing the emitter.setMaxListeners(n) method. To change the default\nfor all EventEmitter instances, the EventEmitter.defaultMaxListeners\nproperty can be used.
\n
Take caution when setting the EventEmitter.defaultMaxListeners because the\nchange effects all EventEmitter instances, including those created before\nthe change is made. However, calling emitter.setMaxListeners(n) still has\nprecedence over EventEmitter.defaultMaxListeners.
\n
Note that this is not a hard limit. The EventEmitter instance will allow\nmore listeners to be added but will output a trace warning to stderr indicating\nthat a possible EventEmitter memory leak has been detected. For any single\nEventEmitter, the emitter.getMaxListeners() and emitter.setMaxListeners()\nmethods can be used to temporarily avoid this warning:
\n
emitter.setMaxListeners(emitter.getMaxListeners() + 1);\nemitter.once('event', () => {\n  // do stuff\n  emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0));\n});\n
\n"
            }
          ]
        }
      ]
    }
  ]
}
node-v4.8.2/doc/api/events.md000644 000766 000024 00000033751 13070706735 016135 0ustar00iojsstaff000000 000000 # Events

> Stability: 2 - Stable



Much of the Node.js core API is built around an idiomatic asynchronous
event-driven architecture in which certain kinds of objects (called "emitters")
periodically emit named events that cause Function objects ("listeners") to be
called.

For instance: a [`net.Server`][] object emits an event each time a peer
connects to it; a [`fs.ReadStream`][] emits an event when the file is opened;
a [stream][] emits an event whenever data is available to be read.

All objects that emit events are instances of the `EventEmitter` class. These
objects expose an `eventEmitter.on()` function that allows one or more
Functions to be attached to named events emitted by the object. Typically,
event names are camel-cased strings but any valid JavaScript property key
can be used.

When the `EventEmitter` object emits an event, all of the Functions attached
to that specific event are called _synchronously_. Any values returned by the
called listeners are _ignored_ and will be discarded.

The following example shows a simple `EventEmitter` instance with a single
listener. The `eventEmitter.on()` method is used to register listeners, while
the `eventEmitter.emit()` method is used to trigger the event.

```js
const EventEmitter = require('events');
const util = require('util');

function MyEmitter() {
  EventEmitter.call(this);
}
util.inherits(MyEmitter, EventEmitter);

const myEmitter = new MyEmitter();
myEmitter.on('event', () => {
  console.log('an event occurred!');
});
myEmitter.emit('event');
```

Any object can become an `EventEmitter` through inheritance. The example above
uses the traditional Node.js style prototypical inheritance using
the `util.inherits()` method. It is, however, possible to use ES6 classes as
well:

```js
const EventEmitter = require('events');

class MyEmitter extends EventEmitter {}

const myEmitter = new MyEmitter();
myEmitter.on('event', () => {
  console.log('an event occurred!');
});
myEmitter.emit('event');
```

## Passing arguments and `this` to listeners

The `eventEmitter.emit()` method allows an arbitrary set of arguments to be
passed to the listener functions. It is important to keep in mind that when an
ordinary listener function is called by the `EventEmitter`, the standard `this`
keyword is intentionally set to reference the `EventEmitter` to which the
listener is attached.

```js
const myEmitter = new MyEmitter();
myEmitter.on('event', function(a, b) {
  console.log(a, b, this);
    // Prints:
    //   a b MyEmitter {
    //     domain: null,
    //     _events: { event: [Function] },
    //     _eventsCount: 1,
    //     _maxListeners: undefined }
});
myEmitter.emit('event', 'a', 'b');
```

It is possible to use ES6 Arrow Functions as listeners, however, when doing so,
the `this` keyword will no longer reference the `EventEmitter` instance:

```js
const myEmitter = new MyEmitter();
myEmitter.on('event', (a, b) => {
  console.log(a, b, this);
    // Prints: a b {}
});
myEmitter.emit('event', 'a', 'b');
```

## Asynchronous vs. Synchronous

The `EventListener` calls all listeners synchronously in the order in which
they were registered. This is important to ensure the proper sequencing of
events and to avoid race conditions or logic errors. When appropriate,
listener functions can switch to an asynchronous mode of operation using
the `setImmediate()` or `process.nextTick()` methods:

```js
const myEmitter = new MyEmitter();
myEmitter.on('event', (a, b) => {
  setImmediate(() => {
    console.log('this happens asynchronously');
  });
});
myEmitter.emit('event', 'a', 'b');
```

## Handling events only once

When a listener is registered using the `eventEmitter.on()` method, that
listener will be invoked _every time_ the named event is emitted.

```js
const myEmitter = new MyEmitter();
var m = 0;
myEmitter.on('event', () => {
  console.log(++m);
});
myEmitter.emit('event');
  // Prints: 1
myEmitter.emit('event');
  // Prints: 2
```

Using the `eventEmitter.once()` method, it is possible to register a listener
that is unregistered before it is called.

```js
const myEmitter = new MyEmitter();
var m = 0;
myEmitter.once('event', () => {
  console.log(++m);
});
myEmitter.emit('event');
  // Prints: 1
myEmitter.emit('event');
  // Ignored
```

## Error events

When an error occurs within an `EventEmitter` instance, the typical action is
for an `'error'` event to be emitted. These are treated as a special case
within Node.js.

If an `EventEmitter` does _not_ have at least one listener registered for the
`'error'` event, and an `'error'` event is emitted, the error is thrown, a
stack trace is printed, and the Node.js process exits.

```js
const myEmitter = new MyEmitter();
myEmitter.emit('error', new Error('whoops!'));
  // Throws and crashes Node.js
```

To guard against crashing the Node.js process, developers can either register
a listener for the `process.on('uncaughtException')` event or use the
[`domain`][] module (_Note, however, that the `domain` module has been
deprecated_).

```js
const myEmitter = new MyEmitter();

process.on('uncaughtException', (err) => {
  console.log('whoops! there was an error');
});

myEmitter.emit('error', new Error('whoops!'));
  // Prints: whoops! there was an error
```

As a best practice, developers should always register listeners for the
`'error'` event:

```js
const myEmitter = new MyEmitter();
myEmitter.on('error', (err) => {
  console.log('whoops! there was an error');
});
myEmitter.emit('error', new Error('whoops!'));
  // Prints: whoops! there was an error
```

## Class: EventEmitter


The `EventEmitter` class is defined and exposed by the `events` module:

```js
const EventEmitter = require('events');
```

All EventEmitters emit the event `'newListener'` when new listeners are
added and `'removeListener'` when a listener is removed.

### Event: 'newListener'


* `eventName` {String|Symbol} The name of the event being listened for
* `listener` {Function} The event handler function

The `EventEmitter` instance will emit it's own `'newListener'` event *before*
a listener is added to it's internal array of listeners.

Listeners registered for the `'newListener'` event will be passed the event
name and a reference to the listener being added.

The fact that the event is triggered before adding the listener has a subtle
but important side effect: any *additional* listeners registered to the same
`name` *within* the `'newListener'` callback will be inserted *before* the
listener that is in the process of being added.

```js
const myEmitter = new MyEmitter();
// Only do this once so we don't loop forever
myEmitter.once('newListener', (event, listener) => {
  if (event === 'event') {
    // Insert a new listener in front
    myEmitter.on('event', () => {
      console.log('B');
    });
  }
});
myEmitter.on('event', () => {
  console.log('A');
});
myEmitter.emit('event');
  // Prints:
  //   B
  //   A
```

### Event: 'removeListener'


* `eventName` {String|Symbol} The event name
* `listener` {Function} The event handler function

The `'removeListener'` event is emitted *after* a listener is removed.

### EventEmitter.listenerCount(emitter, eventName)


> Stability: 0 - Deprecated: Use [`emitter.listenerCount()`][] instead.

A class method that returns the number of listeners for the given `eventName`
registered on the given `emitter`.

```js
const myEmitter = new MyEmitter();
myEmitter.on('event', () => {});
myEmitter.on('event', () => {});
console.log(EventEmitter.listenerCount(myEmitter, 'event'));
  // Prints: 2
```

### EventEmitter.defaultMaxListeners


By default, a maximum of `10` listeners can be registered for any single
event. This limit can be changed for individual `EventEmitter` instances
using the [`emitter.setMaxListeners(n)`][] method. To change the default
for *all* `EventEmitter` instances, the `EventEmitter.defaultMaxListeners`
property can be used.

Take caution when setting the `EventEmitter.defaultMaxListeners` because the
change effects *all* `EventEmitter` instances, including those created before
the change is made. However, calling [`emitter.setMaxListeners(n)`][] still has
precedence over `EventEmitter.defaultMaxListeners`.

Note that this is not a hard limit. The `EventEmitter` instance will allow
more listeners to be added but will output a trace warning to stderr indicating
that a `possible EventEmitter memory leak` has been detected. For any single
`EventEmitter`, the `emitter.getMaxListeners()` and `emitter.setMaxListeners()`
methods can be used to temporarily avoid this warning:

```js
emitter.setMaxListeners(emitter.getMaxListeners() + 1);
emitter.once('event', () => {
  // do stuff
  emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0));
});
```

### emitter.addListener(eventName, listener)


Alias for `emitter.on(eventName, listener)`.

### emitter.emit(eventName[, arg1][, arg2][, ...])


Synchronously calls each of the listeners registered for the event named
`eventName`, in the order they were registered, passing the supplied arguments
to each.

Returns `true` if the event had listeners, `false` otherwise.

### emitter.getMaxListeners()


Returns the current max listener value for the `EventEmitter` which is either
set by [`emitter.setMaxListeners(n)`][] or defaults to
[`EventEmitter.defaultMaxListeners`][].

### emitter.listenerCount(eventName)


* `eventName` {Value} The name of the event being listened for

Returns the number of listeners listening to the event named `eventName`.

### emitter.listeners(eventName)


Returns a copy of the array of listeners for the event named `eventName`.

```js
server.on('connection', (stream) => {
  console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
  // Prints: [ [Function] ]
```

### emitter.on(eventName, listener)


Adds the `listener` function to the end of the listeners array for the
event named `eventName`. No checks are made to see if the `listener` has
already been added. Multiple calls passing the same combination of `eventName`
and `listener` will result in the `listener` being added, and called, multiple
times.

```js
server.on('connection', (stream) => {
  console.log('someone connected!');
});
```

Returns a reference to the `EventEmitter` so calls can be chained.

### emitter.once(eventName, listener)


Adds a **one time** `listener` function for the event named `eventName`. The
next time `eventName` is triggered, this listener is removed and then invoked.

```js
server.once('connection', (stream) => {
  console.log('Ah, we have our first user!');
});
```

Returns a reference to the `EventEmitter` so calls can be chained.

### emitter.removeAllListeners([eventName])


Removes all listeners, or those of the specified `eventName`.

Note that it is bad practice to remove listeners added elsewhere in the code,
particularly when the `EventEmitter` instance was created by some other
component or module (e.g. sockets or file streams).

Returns a reference to the `EventEmitter` so calls can be chained.

### emitter.removeListener(eventName, listener)


Removes the specified `listener` from the listener array for the event named
`eventName`.

```js
var callback = (stream) => {
  console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);
```

`removeListener` will remove, at most, one instance of a listener from the
listener array. If any single listener has been added multiple times to the
listener array for the specified `eventName`, then `removeListener` must be
called multiple times to remove each instance.

Note that once an event has been emitted, all listeners attached to it at the
time of emitting will be called in order. This implies that any `removeListener()`
or `removeAllListeners()` calls *after* emitting and *before* the last listener
finishes execution will not remove them from `emit()` in progress. Subsequent
events will behave as expected.

```js
const myEmitter = new MyEmitter();

var callbackA = () => {
  console.log('A');
  myEmitter.removeListener('event', callbackB);
};

var callbackB = () => {
  console.log('B');
};

myEmitter.on('event', callbackA);

myEmitter.on('event', callbackB);

// callbackA removes listener callbackB but it will still be called.
// Internal listener array at time of emit [callbackA, callbackB]
myEmitter.emit('event');
  // Prints:
  //   A
  //   B

// callbackB is now removed.
// Internal listener array [callbackA]
myEmitter.emit('event');
  // Prints:
  //   A

```

Because listeners are managed using an internal array, calling this will
change the position indices of any listener registered *after* the listener
being removed. This will not impact the order in which listeners are called,
but it will means that any copies of the listener array as returned by
the `emitter.listeners()` method will need to be recreated.

Returns a reference to the `EventEmitter` so calls can be chained.

### emitter.setMaxListeners(n)


By default EventEmitters will print a warning if more than `10` listeners are
added for a particular event. This is a useful default that helps finding
memory leaks. Obviously, not all events should be limited to just 10 listeners.
The `emitter.setMaxListeners()` method allows the limit to be modified for this
specific `EventEmitter` instance. The value can be set to `Infinity` (or `0`)
to indicate an unlimited number of listeners.

Returns a reference to the `EventEmitter` so calls can be chained.

[`net.Server`]: net.html#net_class_net_server
[`fs.ReadStream`]: fs.html#fs_class_fs_readstream
[`emitter.setMaxListeners(n)`]: #events_emitter_setmaxlisteners_n
[`EventEmitter.defaultMaxListeners`]: #events_eventemitter_defaultmaxlisteners
[`emitter.listenerCount()`]: #events_emitter_listenercount_event
[`domain`]: domain.html
[stream]: stream.html
node-v4.8.2/doc/api/fs.html000644 000766 000024 00000247605 13070706740 015606 0ustar00iojsstaff000000 000000 


  
  File System | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

        
Table of Contents

        

      


      

        
File System#


Stability: 2 - Stable


File I/O is provided by simple wrappers around standard POSIX functions.  To
use this module do require('fs'). All the methods have asynchronous and
synchronous forms.


The asynchronous form always takes a completion callback as its last argument.
The arguments passed to the completion callback depend on the method, but the
first argument is always reserved for an exception. If the operation was
completed successfully, then the first argument will be null or undefined.


When using the synchronous form any exceptions are immediately thrown.
You can use try/catch to handle exceptions or allow them to bubble up.


Here is an example of the asynchronous version:


const fs = require('fs');

fs.unlink('/tmp/hello', (err) => {
  if (err) throw err;
  console.log('successfully deleted /tmp/hello');
});



Here is the synchronous version:


const fs = require('fs');

fs.unlinkSync('/tmp/hello');
console.log('successfully deleted /tmp/hello');



With the asynchronous methods there is no guaranteed ordering. So the
following is prone to error:


fs.rename('/tmp/hello', '/tmp/world', (err) => {
  if (err) throw err;
  console.log('renamed complete');
});
fs.stat('/tmp/world', (err, stats) => {
  if (err) throw err;
  console.log(`stats: ${JSON.stringify(stats)}`);
});



It could be that fs.stat is executed before fs.rename.
The correct way to do this is to chain the callbacks.


fs.rename('/tmp/hello', '/tmp/world', (err) => {
  if (err) throw err;
  fs.stat('/tmp/world', (err, stats) => {
    if (err) throw err;
    console.log(`stats: ${JSON.stringify(stats)}`);
  });
});



In busy processes, the programmer is strongly encouraged to use the
asynchronous versions of these calls. The synchronous versions will block
the entire process until they complete--halting all connections.


The relative path to a filename can be used. Remember, however, that this path
will be relative to process.cwd().


Most fs functions let you omit the callback argument. If you do, a default
callback is used that rethrows errors. To get a trace to the original call
site, set the NODE_DEBUG environment variable:


$ cat script.js
function bad() {
  require('fs').readFile('/');
}
bad();

$ env NODE_DEBUG=fs node script.js
fs.js:66
        throw err;
              ^
Error: EISDIR, read
    at rethrow (fs.js:61:21)
    at maybeCallback (fs.js:79:42)
    at Object.fs.readFile (fs.js:153:18)
    at bad (/path/to/script.js:2:17)
    at Object.<anonymous> (/path/to/script.js:5:1)
    <etc.>

Class: fs.FSWatcher#



Added in: v0.5.8

Objects returned from fs.watch() are of this type.


Event: 'change'#



Added in: v0.5.8

    

  • event <String> The type of fs change
    • 

  • filename <String> The filename that changed (if relevant/available)
    • 



Emitted when something changes in a watched directory or file.
See more details in fs.watch().


Event: 'error'#



Added in: v0.5.8



Emitted when an error occurs.


watcher.close()#



Added in: v0.5.8

Stop watching for changes on the given fs.FSWatcher.


Class: fs.ReadStream#



Added in: v0.1.93

ReadStream is a Readable Stream.


Event: 'open'#



Added in: v0.1.93

    

  • fd <Number> Integer file descriptor used by the ReadStream.
    • 



Emitted when the ReadStream's file is opened.


Event: 'close'#



Added in: v0.1.93

Emitted when the ReadStream's underlying file descriptor has been closed
using the fs.close() method.


readStream.path#



Added in: v0.1.93

The path to the file the stream is reading from.


Class: fs.Stats#



Added in: v0.1.21

Objects returned from fs.stat(), fs.lstat() and fs.fstat() and their
synchronous counterparts are of this type.


    

  • stats.isFile()
    • 

  • stats.isDirectory()
    • 

  • stats.isBlockDevice()
    • 

  • stats.isCharacterDevice()
    • 

  • stats.isSymbolicLink() (only valid with fs.lstat())
    • 

  • stats.isFIFO()
    • 

  • stats.isSocket()
    • 



For a regular file util.inspect(stats) would return a string very
similar to this:


{
  dev: 2114,
  ino: 48064969,
  mode: 33188,
  nlink: 1,
  uid: 85,
  gid: 100,
  rdev: 0,
  size: 527,
  blksize: 4096,
  blocks: 8,
  atime: Mon, 10 Oct 2011 23:24:11 GMT,
  mtime: Mon, 10 Oct 2011 23:24:11 GMT,
  ctime: Mon, 10 Oct 2011 23:24:11 GMT,
  birthtime: Mon, 10 Oct 2011 23:24:11 GMT
}



Please note that atime, mtime, birthtime, and ctime are
instances of Date object and to compare the values of
these objects you should use appropriate methods. For most general
uses getTime() will return the number of
milliseconds elapsed since 1 January 1970 00:00:00 UTC and this
integer should be sufficient for any comparison, however there are
additional methods which can be used for displaying fuzzy information.
More details can be found in the MDN JavaScript Reference
page.


Stat Time Values#


The times in the stat object have the following semantics:


    

  • atime "Access Time" - Time when file data last accessed.  Changed
by the mknod(2), utimes(2), and read(2) system calls.
    • 

  • mtime "Modified Time" - Time when file data last modified.
Changed by the mknod(2), utimes(2), and write(2) system calls.
    • 

  • ctime "Change Time" - Time when file status was last changed
(inode data modification).  Changed by the chmod(2), chown(2),
link(2), mknod(2), rename(2), unlink(2), utimes(2),
read(2), and write(2) system calls.
    • 

  • birthtime "Birth Time" -  Time of file creation. Set once when the
file is created.  On filesystems where birthtime is not available,
this field may instead hold either the ctime or
1970-01-01T00:00Z (ie, unix epoch timestamp 0). Note that this
value may be greater than atime or mtime in this case. On Darwin
and other FreeBSD variants, also set if the atime is explicitly
set to an earlier value than the current birthtime using the
utimes(2) system call.
    • 



Prior to Node v0.12, the ctime held the birthtime on Windows
systems.  Note that as of v0.12, ctime is not "creation time", and
on Unix systems, it never was.


Class: fs.WriteStream#



Added in: v0.1.93

WriteStream is a Writable Stream.


Event: 'open'#



Added in: v0.1.93

    

  • fd <Number> Integer file descriptor used by the WriteStream.
    • 



Emitted when the WriteStream's file is opened.


Event: 'close'#



Added in: v0.1.93

Emitted when the WriteStream's underlying file descriptor has been closed
using the fs.close() method.


writeStream.bytesWritten#



Added in: v0.4.7

The number of bytes written so far. Does not include data that is still queued
for writing.


writeStream.path#



Added in: v0.1.93

The path to the file the stream is writing to.


fs.access(path[, mode], callback)#



Added in: v0.11.15

Tests a user's permissions for the file specified by path. mode is an
optional integer that specifies the accessibility checks to be performed. The
following constants define the possible values of mode. It is possible to
create a mask consisting of the bitwise OR of two or more values.


    

  • fs.F_OK - File is visible to the calling process. This is useful for
determining if a file exists, but says nothing about rwx permissions.
Default if no mode is specified.
    • 

  • fs.R_OK - File can be read by the calling process.
    • 

  • fs.W_OK - File can be written by the calling process.
    • 

  • fs.X_OK - File can be executed by the calling process. This has no effect
on Windows (will behave like fs.F_OK).
    • 



The final argument, callback, is a callback function that is invoked with
a possible error argument. If any of the accessibility checks fail, the error
argument will be populated. The following example checks if the file
/etc/passwd can be read and written by the current process.


fs.access('/etc/passwd', fs.R_OK | fs.W_OK, (err) => {
  console.log(err ? 'no access!' : 'can read/write');
});



Using fs.access() to check for the accessibility of a file before calling
fs.open(), fs.readFile() or fs.writeFile() is not recommended. Doing
so introduces a race condition, since other processes may change the file's
state between the two calls. Instead, user code should open/read/write the
file directly and handle the error raised if the file is not accessible.


For example:


write (NOT RECOMMENDED)


fs.access('myfile', (err) => {
  if (!err) {
    console.error('myfile already exists');
    return;
  }

  fs.open('myfile', 'wx', (err, fd) => {
    if (err) throw err;
    writeMyData(fd);
  });
});



write (RECOMMENDED)


fs.open('myfile', 'wx', (err, fd) => {
  if (err) {
    if (err.code === "EEXIST") {
      console.error('myfile already exists');
      return;
    } else {
      throw err;
    }
  }

  writeMyData(fd);
});



read (NOT RECOMMENDED)


fs.access('myfile', (err) => {
  if (err) {
    if (err.code === "ENOENT") {
      console.error('myfile does not exist');
      return;
    } else {
      throw err;
    }
  }

  fs.open('myfile', 'r', (err, fd) => {
    if (err) throw err;
    readMyData(fd);
  });
});



read (RECOMMENDED)


fs.open('myfile', 'r', (err, fd) => {
  if (err) {
    if (err.code === "ENOENT") {
      console.error('myfile does not exist');
      return;
    } else {
      throw err;
    }
  }

  readMyData(fd);
});



The "not recommended" examples above check for accessibility and then use the
file; the "recommended" examples are better because they use the file directly
and handle the error, if any.


In general, check for the accessibility of a file only if the file won’t be
used directly, for example when its accessibility is a signal from another
process.


fs.accessSync(path[, mode])#



Added in: v0.11.15

Synchronous version of fs.access(). This throws if any accessibility checks
fail, and does nothing otherwise.


fs.appendFile(file, data[, options], callback)#



Added in: v0.6.7



Asynchronously append data to a file, creating the file if it does not yet exist.
data can be a string or a buffer.


Example:


fs.appendFile('message.txt', 'data to append', (err) => {
  if (err) throw err;
  console.log('The "data to append" was appended to file!');
});



If options is a string, then it specifies the encoding. Example:


fs.appendFile('message.txt', 'data to append', 'utf8', callback);



fs.appendFileSync(file, data[, options])#



Added in: v0.6.7

The synchronous version of fs.appendFile(). Returns undefined.


fs.chmod(path, mode, callback)#



Added in: v0.1.30

Asynchronous chmod(2). No arguments other than a possible exception are given
to the completion callback.


fs.chmodSync(path, mode)#



Added in: v0.6.7

Synchronous chmod(2). Returns undefined.


fs.chown(path, uid, gid, callback)#



Added in: v0.1.97

Asynchronous chown(2). No arguments other than a possible exception are given
to the completion callback.


fs.chownSync(path, uid, gid)#



Added in: v0.1.97

Synchronous chown(2). Returns undefined.


fs.close(fd, callback)#



Added in: v0.0.2

Asynchronous close(2).  No arguments other than a possible exception are given
to the completion callback.


fs.closeSync(fd)#



Added in: v0.1.21

Synchronous close(2). Returns undefined.


fs.createReadStream(path[, options])#



Added in: v0.1.31

Returns a new ReadStream object. (See Readable Stream).


Be aware that, unlike the default value set for highWaterMark on a
readable stream (16 kb), the stream returned by this method has a
default value of 64 kb for the same parameter.


options is an object or string with the following defaults:


{
  flags: 'r',
  encoding: null,
  fd: null,
  mode: 0o666,
  autoClose: true
}



options can include start and end values to read a range of bytes from
the file instead of the entire file.  Both start and end are inclusive and
start counting at 0. If fd is specified and start is omitted or undefined,
fs.createReadStream() reads sequentially from the current file position.
The encoding can be any one of those accepted by Buffer.


If fd is specified, ReadStream will ignore the path argument and will use
the specified file descriptor. This means that no 'open' event will be emitted.
Note that fd should be blocking; non-blocking fds should be passed to
net.Socket.


If autoClose is false, then the file descriptor won't be closed, even if
there's an error.  It is your responsibility to close it and make sure
there's no file descriptor leak.  If autoClose is set to true (default
behavior), on error or end the file descriptor will be closed
automatically.


mode sets the file mode (permission and sticky bits), but only if the
file was created.


An example to read the last 10 bytes of a file which is 100 bytes long:


fs.createReadStream('sample.txt', {start: 90, end: 99});



If options is a string, then it specifies the encoding.


fs.createWriteStream(path[, options])#



Added in: v0.1.31

Returns a new WriteStream object. (See Writable Stream).


options is an object or string with the following defaults:


{
  flags: 'w',
  defaultEncoding: 'utf8',
  fd: null,
  mode: 0o666
}



options may also include a start option to allow writing data at
some position past the beginning of the file.  Modifying a file rather
than replacing it may require a flags mode of r+ rather than the
default mode w. The defaultEncoding can be any one of those accepted by Buffer.


Like ReadStream, if fd is specified, WriteStream will ignore the
path argument and will use the specified file descriptor. This means that no
'open' event will be emitted. Note that fd should be blocking; non-blocking
fds should be passed to net.Socket.


If options is a string, then it specifies the encoding.


fs.exists(path, callback)#



Added in: v0.0.2
Deprecated since: v1.0.0 

Stability: 0 - Deprecated: Use fs.stat() or fs.access() instead.
Test whether or not the given path exists by checking with the file system.
Then call the callback argument with either true or false.  Example:


fs.exists('/etc/passwd', (exists) => {
  console.log(exists ? 'it\'s there' : 'no passwd!');
});



Using fs.exists() to check for the existence of a file before calling
fs.open(), fs.readFile() or fs.writeFile() is not recommended. Doing
so introduces a race condition, since other processes may change the file's
state between the two calls. Instead, user code should open/read/write the
file directly and handle the error raised if the file does not exist.


For example:


write (NOT RECOMMENDED)


fs.exists('myfile', (exists) => {
  if (exists) {
    console.error('myfile already exists');
  } else {
    fs.open('myfile', 'wx', (err, fd) => {
      if (err) throw err;
      writeMyData(fd);
    });
  }
});



write (RECOMMENDED)


fs.open('myfile', 'wx', (err, fd) => {
  if (err) {
    if (err.code === "EEXIST") {
      console.error('myfile already exists');
      return;
    } else {
      throw err;
    }
  }
  writeMyData(fd);
});



read (NOT RECOMMENDED)


fs.exists('myfile', (exists) => {
  if (exists) {
    fs.open('myfile', 'r', (err, fd) => {
      readMyData(fd);
    });
  } else {
    console.error('myfile does not exist');
  }
});



read (RECOMMENDED)


fs.open('myfile', 'r', (err, fd) => {
  if (err) {
    if (err.code === "ENOENT") {
      console.error('myfile does not exist');
      return;
    } else {
      throw err;
    }
  } else {
    readMyData(fd);
  }
});



The "not recommended" examples above check for existence and then use the
file; the "recommended" examples are better because they use the file directly
and handle the error, if any.


In general, check for the existence of a file only if the file won’t be
used directly, for example when its existence is a signal from another
process.


fs.existsSync(path)#



Added in: v0.1.21
Deprecated since: v1.0.0 

Stability: 0 - Deprecated: Use fs.statSync() or fs.accessSync() instead.
Synchronous version of fs.exists().
Returns true if the file exists, false otherwise.


fs.fchmod(fd, mode, callback)#



Added in: v0.4.7

Asynchronous fchmod(2). No arguments other than a possible exception
are given to the completion callback.


fs.fchmodSync(fd, mode)#



Added in: v0.4.7

Synchronous fchmod(2). Returns undefined.


fs.fchown(fd, uid, gid, callback)#



Added in: v0.4.7

Asynchronous fchown(2). No arguments other than a possible exception are given
to the completion callback.


fs.fchownSync(fd, uid, gid)#



Added in: v0.4.7

Synchronous fchown(2). Returns undefined.


fs.fdatasync(fd, callback)#



Added in: v0.1.96

Asynchronous fdatasync(2). No arguments other than a possible exception are
given to the completion callback.


fs.fdatasyncSync(fd)#



Added in: v0.1.96

Synchronous fdatasync(2). Returns undefined.


fs.fstat(fd, callback)#



Added in: v0.1.95

Asynchronous fstat(2). The callback gets two arguments (err, stats) where
stats is a fs.Stats object. fstat() is identical to stat(),
except that the file to be stat-ed is specified by the file descriptor fd.


fs.fstatSync(fd)#



Added in: v0.1.95

Synchronous fstat(2). Returns an instance of fs.Stats.


fs.fsync(fd, callback)#



Added in: v0.1.96

Asynchronous fsync(2). No arguments other than a possible exception are given
to the completion callback.


fs.fsyncSync(fd)#



Added in: v0.1.96

Synchronous fsync(2). Returns undefined.


fs.ftruncate(fd, len, callback)#



Added in: v0.8.6

Asynchronous ftruncate(2). No arguments other than a possible exception are
given to the completion callback.


fs.ftruncateSync(fd, len)#



Added in: v0.8.6

Synchronous ftruncate(2). Returns undefined.


fs.futimes(fd, atime, mtime, callback)#



Added in: v0.4.2

Change the file timestamps of a file referenced by the supplied file
descriptor.


fs.futimesSync(fd, atime, mtime)#



Added in: v0.4.2

Synchronous version of fs.futimes(). Returns undefined.


fs.lchmod(path, mode, callback)#



Deprecated since: v0.4.7 

Asynchronous lchmod(2). No arguments other than a possible exception
are given to the completion callback.


Only available on Mac OS X.


fs.lchmodSync(path, mode)#



Deprecated since: v0.4.7 

Synchronous lchmod(2). Returns undefined.


fs.lchown(path, uid, gid, callback)#



Deprecated since: v0.4.7 

Asynchronous lchown(2). No arguments other than a possible exception are given
to the completion callback.


fs.lchownSync(path, uid, gid)#



Deprecated since: v0.4.7 

Synchronous lchown(2). Returns undefined.


fs.link(srcpath, dstpath, callback)#



Added in: v0.1.31

Asynchronous link(2). No arguments other than a possible exception are given to
the completion callback.


fs.linkSync(srcpath, dstpath)#



Added in: v0.1.31

Synchronous link(2). Returns undefined.


fs.lstat(path, callback)#



Added in: v0.1.30

Asynchronous lstat(2). The callback gets two arguments (err, stats) where
stats is a fs.Stats object. lstat() is identical to stat(),
except that if path is a symbolic link, then the link itself is stat-ed,
not the file that it refers to.


fs.lstatSync(path)#



Added in: v0.1.30

Synchronous lstat(2). Returns an instance of fs.Stats.


fs.mkdir(path[, mode], callback)#



Added in: v0.1.8

Asynchronous mkdir(2). No arguments other than a possible exception are given
to the completion callback. mode defaults to 0o777.


fs.mkdirSync(path[, mode])#



Added in: v0.1.21

Synchronous mkdir(2). Returns undefined.


fs.mkdtemp(prefix, callback)#


Creates a unique temporary directory.


Generates six random characters to be appended behind a required
prefix to create a unique temporary directory.


The created folder path is passed as a string to the callback's second
parameter.


Example:


fs.mkdtemp('/tmp/foo-', (err, folder) => {
  console.log(folder);
    // Prints: /tmp/foo-itXde2
});



fs.mkdtempSync(template)#


The synchronous version of [fs.mkdtemp()][]. Returns the created
folder path.


fs.open(path, flags[, mode], callback)#



Added in: v0.0.2

Asynchronous file open. See open(2). flags can be:


    

  • 'r' - Open file for reading.
An exception occurs if the file does not exist.
    

    • 

  • 'r+' - Open file for reading and writing.
An exception occurs if the file does not exist.
    

    • 

  • 'rs' - Open file for reading in synchronous mode. Instructs the operating
system to bypass the local file system cache.
    

    This is primarily useful for opening files on NFS mounts as it allows you to
skip the potentially stale local cache. It has a very real impact on I/O
performance so don't use this flag unless you need it.
    

    Note that this doesn't turn fs.open() into a synchronous blocking call.
If that's what you want then you should be using fs.openSync()
    

    • 

  • 'rs+' - Open file for reading and writing, telling the OS to open it
synchronously. See notes for 'rs' about using this with caution.
    

    • 

  • 'w' - Open file for writing.
The file is created (if it does not exist) or truncated (if it exists).
    

    • 

  • 'wx' - Like 'w' but fails if path exists.
    

    • 

  • 'w+' - Open file for reading and writing.
The file is created (if it does not exist) or truncated (if it exists).
    

    • 

  • 'wx+' - Like 'w+' but fails if path exists.
    

    • 

  • 'a' - Open file for appending.
The file is created if it does not exist.
    

    • 

  • 'ax' - Like 'a' but fails if path exists.
    

    • 

  • 'a+' - Open file for reading and appending.
The file is created if it does not exist.
    

    • 

  • 'ax+' - Like 'a+' but fails if path exists.
    

    • 



mode sets the file mode (permission and sticky bits), but only if the file was
created. It defaults to 0666, readable and writable.


The callback gets two arguments (err, fd).


The exclusive flag 'x' (O_EXCL flag in open(2)) ensures that path is newly
created. On POSIX systems, path is considered to exist even if it is a symlink
to a non-existent file. The exclusive flag may or may not work with network file
systems.


flags can also be a number as documented by open(2); commonly used constants
are available from require('constants').  On Windows, flags are translated to
their equivalent ones where applicable, e.g. O_WRONLY to FILE_GENERIC_WRITE,
or O_EXCL|O_CREAT to CREATE_NEW, as accepted by CreateFileW.


On Linux, positional writes don't work when the file is opened in append mode.
The kernel ignores the position argument and always appends the data to
the end of the file.


fs.openSync(path, flags[, mode])#



Added in: v0.1.21

Synchronous version of fs.open(). Returns an integer representing the file
descriptor.


fs.read(fd, buffer, offset, length, position, callback)#



Added in: v0.0.2

Read data from the file specified by fd.


buffer is the buffer that the data will be written to.


offset is the offset in the buffer to start writing at.


length is an integer specifying the number of bytes to read.


position is an integer specifying where to begin reading from in the file.
If position is null, data will be read from the current file position.


The callback is given the three arguments, (err, bytesRead, buffer).


fs.readdir(path, callback)#



Added in: v0.1.8

Asynchronous readdir(3).  Reads the contents of a directory.
The callback gets two arguments (err, files) where files is an array of
the names of the files in the directory excluding '.' and '..'.


fs.readdirSync(path)#



Added in: v0.1.21

Synchronous readdir(3). Returns an array of filenames excluding '.' and
'..'.


fs.readFile(file[, options], callback)#



Added in: v0.1.29



Asynchronously reads the entire contents of a file. Example:


fs.readFile('/etc/passwd', (err, data) => {
  if (err) throw err;
  console.log(data);
});



The callback is passed two arguments (err, data), where data is the
contents of the file.


If no encoding is specified, then the raw buffer is returned.


If options is a string, then it specifies the encoding. Example:


fs.readFile('/etc/passwd', 'utf8', callback);



fs.readFileSync(file[, options])#



Added in: v0.1.8

Synchronous version of fs.readFile. Returns the contents of the file.


If the encoding option is specified then this function returns a
string. Otherwise it returns a buffer.


fs.readlink(path, callback)#



Added in: v0.1.31

Asynchronous readlink(2). The callback gets two arguments (err,
linkString).


fs.readlinkSync(path)#



Added in: v0.1.31

Synchronous readlink(2). Returns the symbolic link's string value.


fs.realpath(path[, cache], callback)#



Added in: v0.1.31

Asynchronous realpath(2). The callback gets two arguments (err,
resolvedPath). May use process.cwd to resolve relative paths. cache is an
object literal of mapped paths that can be used to force a specific path
resolution or avoid additional fs.stat calls for known real paths.


Example:


var cache = {'/etc':'/private/etc'};
fs.realpath('/etc/passwd', cache, (err, resolvedPath) => {
  if (err) throw err;
  console.log(resolvedPath);
});



fs.readSync(fd, buffer, offset, length, position)#



Added in: v0.1.21

Synchronous version of fs.read(). Returns the number of bytesRead.


fs.realpathSync(path[, cache])#



Added in: v0.1.31

Synchronous realpath(2). Returns the resolved path. cache is an
object literal of mapped paths that can be used to force a specific path
resolution or avoid additional fs.stat calls for known real paths.


fs.rename(oldPath, newPath, callback)#



Added in: v0.0.2

Asynchronous rename(2). No arguments other than a possible exception are given
to the completion callback.


fs.renameSync(oldPath, newPath)#



Added in: v0.1.21

Synchronous rename(2). Returns undefined.


fs.rmdir(path, callback)#



Added in: v0.0.2

Asynchronous rmdir(2). No arguments other than a possible exception are given
to the completion callback.


fs.rmdirSync(path)#



Added in: v0.1.21

Synchronous rmdir(2). Returns undefined.


fs.stat(path, callback)#



Added in: v0.0.2

Asynchronous stat(2). The callback gets two arguments (err, stats) where
stats is a fs.Stats object.  See the fs.Stats section for more
information.


fs.statSync(path)#



Added in: v0.1.21

Synchronous stat(2). Returns an instance of fs.Stats.


fs.symlink(target, path[, type], callback)#



Added in: v0.1.31

Asynchronous symlink(2). No arguments other than a possible exception are given
to the completion callback.
The type argument can be set to 'dir', 'file', or 'junction' (default
is 'file') and is only available on Windows (ignored on other platforms).
Note that Windows junction points require the destination path to be absolute.  When using
'junction', the target argument will automatically be normalized to absolute path.


Here is an example below:


fs.symlink('./foo', './new-port');



It creates a symbolic link named "new-port" that points to "foo".


fs.symlinkSync(target, path[, type])#



Added in: v0.1.31

Synchronous symlink(2). Returns undefined.


fs.truncate(path, len, callback)#



Added in: v0.8.6

Asynchronous truncate(2). No arguments other than a possible exception are
given to the completion callback. A file descriptor can also be passed as the
first argument. In this case, fs.ftruncate() is called.


fs.truncateSync(path, len)#



Added in: v0.8.6

Synchronous truncate(2). Returns undefined.


fs.unlink(path, callback)#



Added in: v0.0.2

Asynchronous unlink(2). No arguments other than a possible exception are given
to the completion callback.


fs.unlinkSync(path)#



Added in: v0.1.21

Synchronous unlink(2). Returns undefined.


fs.unwatchFile(filename[, listener])#



Added in: v0.1.31

Stop watching for changes on filename. If listener is specified, only that
particular listener is removed. Otherwise, all listeners are removed and you
have effectively stopped watching filename.


Calling fs.unwatchFile() with a filename that is not being watched is a
no-op, not an error.


Note: fs.watch() is more efficient than fs.watchFile() and fs.unwatchFile().
fs.watch() should be used instead of fs.watchFile() and fs.unwatchFile()
when possible.


fs.utimes(path, atime, mtime, callback)#



Added in: v0.4.2

Change file timestamps of the file referenced by the supplied path.


Note: the arguments atime and mtime of the following related functions does
follow the below rules:


    

  • If the value is a numberable string like '123456789', the value would get
converted to corresponding number.
    • 

  • If the value is NaN or Infinity, the value would get converted to
Date.now().
    • 



fs.utimesSync(path, atime, mtime)#



Added in: v0.4.2

Synchronous version of fs.utimes(). Returns undefined.


fs.watch(filename[, options][, listener])#



Added in: v0.5.10

Watch for changes on filename, where filename is either a file or a
directory.  The returned object is a fs.FSWatcher.


The second argument is optional. The options if provided should be an object.
The supported boolean members are persistent and recursive. persistent
indicates whether the process should continue to run as long as files are being
watched. recursive indicates whether all subdirectories should be watched, or
only the current directory. This applies when a directory is specified, and only
on supported platforms (See Caveats).


The default is { persistent: true, recursive: false }.


The listener callback gets two arguments (event, filename).  event is either
'rename' or 'change', and filename is the name of the file which triggered
the event.


Caveats#



The fs.watch API is not 100% consistent across platforms, and is
unavailable in some situations.


The recursive option is only supported on OS X and Windows.


Availability#



This feature depends on the underlying operating system providing a way
to be notified of filesystem changes.


    

  • On Linux systems, this uses inotify.
    • 

  • On BSD systems, this uses kqueue.
    • 

  • On OS X, this uses kqueue for files and 'FSEvents' for directories.
    • 

  • On SunOS systems (including Solaris and SmartOS), this uses event ports.
    • 

  • On Windows systems, this feature depends on ReadDirectoryChangesW.
    • 

  • On Aix systems, this feature depends on AHAFS, which must be enabled.
    • 



If the underlying functionality is not available for some reason, then
fs.watch will not be able to function. For example, watching files or
directories can be unreliable, and in some cases impossible, on network file
systems (NFS, SMB, etc), or host file systems when using virtualization software
such as Vagrant, Docker, etc.


You can still use fs.watchFile, which uses stat polling, but it is slower and
less reliable.


Inodes#



On Linux and OS X systems, fs.watch() resolves the path to an inode and
watches the inode. If the watched path is deleted and recreated, it is assigned
a new inode. The watch will emit an event for the delete but will continue
watching the original inode. Events for the new inode will not be emitted.
This is expected behavior.


Filename Argument#



Providing filename argument in the callback is only supported on Linux and
Windows.  Even on supported platforms, filename is not always guaranteed to
be provided. Therefore, don't assume that filename argument is always
provided in the callback, and have some fallback logic if it is null.


fs.watch('somedir', (event, filename) => {
  console.log(`event is: ${event}`);
  if (filename) {
    console.log(`filename provided: ${filename}`);
  } else {
    console.log('filename not provided');
  }
});



fs.watchFile(filename[, options], listener)#



Added in: v0.1.31

Watch for changes on filename. The callback listener will be called each
time the file is accessed.


The options argument may be omitted. If provided, it should be an object. The
options object may contain a boolean named persistent that indicates
whether the process should continue to run as long as files are being watched.
The options object may specify an interval property indicating how often the
target should be polled in milliseconds. The default is
{ persistent: true, interval: 5007 }.


The listener gets two arguments the current stat object and the previous
stat object:


fs.watchFile('message.text', (curr, prev) => {
  console.log(`the current mtime is: ${curr.mtime}`);
  console.log(`the previous mtime was: ${prev.mtime}`);
});



These stat objects are instances of fs.Stat.


If you want to be notified when the file was modified, not just accessed,
you need to compare curr.mtime and prev.mtime.


Note: when an fs.watchFile operation results in an ENOENT error, it will
 invoke the listener once, with all the fields zeroed (or, for dates, the Unix
 Epoch). In Windows, blksize and blocks fields will be undefined, instead
 of zero. If the file is created later on, the listener will be called again,
 with the latest stat objects. This is a change in functionality since v0.10.


Note: fs.watch() is more efficient than fs.watchFile and fs.unwatchFile.
fs.watch should be used instead of fs.watchFile and fs.unwatchFile
when possible.


fs.write(fd, buffer, offset, length[, position], callback)#



Added in: v0.0.2

Write buffer to the file specified by fd.


offset determines the part of the buffer to be written, and length is
an integer specifying the number of bytes to write.


position refers to the offset from the beginning of the file where this data
should be written. If typeof position !== 'number', the data will be written
at the current position. See pwrite(2).


The callback will be given three arguments (err, written, buffer) where
written specifies how many bytes were written from buffer.


Note that it is unsafe to use fs.write multiple times on the same file
without waiting for the callback. For this scenario,
fs.createWriteStream is strongly recommended.


On Linux, positional writes don't work when the file is opened in append mode.
The kernel ignores the position argument and always appends the data to
the end of the file.


fs.write(fd, data[, position[, encoding]], callback)#



Added in: v0.11.5

Write data to the file specified by fd.  If data is not a Buffer instance
then the value will be coerced to a string.


position refers to the offset from the beginning of the file where this data
should be written. If typeof position !== 'number' the data will be written at
the current position. See pwrite(2).


encoding is the expected string encoding.


The callback will receive the arguments (err, written, string) where written
specifies how many bytes the passed string required to be written. Note that
bytes written is not the same as string characters. See Buffer.byteLength.


Unlike when writing buffer, the entire string must be written. No substring
may be specified. This is because the byte offset of the resulting data may not
be the same as the string offset.


Note that it is unsafe to use fs.write multiple times on the same file
without waiting for the callback. For this scenario,
fs.createWriteStream is strongly recommended.


On Linux, positional writes don't work when the file is opened in append mode.
The kernel ignores the position argument and always appends the data to
the end of the file.


fs.writeFile(file, data[, options], callback)#



Added in: v0.1.29



Asynchronously writes data to a file, replacing the file if it already exists.
data can be a string or a buffer.


The encoding option is ignored if data is a buffer. It defaults
to 'utf8'.


Example:


fs.writeFile('message.txt', 'Hello Node.js', (err) => {
  if (err) throw err;
  console.log('It\'s saved!');
});



If options is a string, then it specifies the encoding. Example:


fs.writeFile('message.txt', 'Hello Node.js', 'utf8', callback);



Note that it is unsafe to use fs.writeFile multiple times on the same file
without waiting for the callback. For this scenario,
fs.createWriteStream is strongly recommended.


fs.writeFileSync(file, data[, options])#



Added in: v0.1.29

The synchronous version of fs.writeFile(). Returns undefined.


fs.writeSync(fd, buffer, offset, length[, position])#



Added in: v0.1.21

fs.writeSync(fd, data[, position[, encoding]])#



Added in: v0.11.5

Synchronous versions of fs.write(). Returns the number of bytes written.


      

    

  

  
  
  
  



node-v4.8.2/doc/api/fs.json000644 000766 000024 00000270101 13070706740 015576 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/fs.md",
  "modules": [
    {
      "textRaw": "File System",
      "name": "fs",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
File I/O is provided by simple wrappers around standard POSIX functions.  To\nuse this module do require('fs'). All the methods have asynchronous and\nsynchronous forms.
\n
The asynchronous form always takes a completion callback as its last argument.\nThe arguments passed to the completion callback depend on the method, but the\nfirst argument is always reserved for an exception. If the operation was\ncompleted successfully, then the first argument will be null or undefined.
\n
When using the synchronous form any exceptions are immediately thrown.\nYou can use try/catch to handle exceptions or allow them to bubble up.
\n
Here is an example of the asynchronous version:
\n
const fs = require('fs');\n\nfs.unlink('/tmp/hello', (err) => {\n  if (err) throw err;\n  console.log('successfully deleted /tmp/hello');\n});\n
\n
Here is the synchronous version:
\n
const fs = require('fs');\n\nfs.unlinkSync('/tmp/hello');\nconsole.log('successfully deleted /tmp/hello');\n
\n
With the asynchronous methods there is no guaranteed ordering. So the\nfollowing is prone to error:
\n
fs.rename('/tmp/hello', '/tmp/world', (err) => {\n  if (err) throw err;\n  console.log('renamed complete');\n});\nfs.stat('/tmp/world', (err, stats) => {\n  if (err) throw err;\n  console.log(`stats: ${JSON.stringify(stats)}`);\n});\n
\n
It could be that fs.stat is executed before fs.rename.\nThe correct way to do this is to chain the callbacks.
\n
fs.rename('/tmp/hello', '/tmp/world', (err) => {\n  if (err) throw err;\n  fs.stat('/tmp/world', (err, stats) => {\n    if (err) throw err;\n    console.log(`stats: ${JSON.stringify(stats)}`);\n  });\n});\n
\n
In busy processes, the programmer is strongly encouraged to use the\nasynchronous versions of these calls. The synchronous versions will block\nthe entire process until they complete--halting all connections.
\n
The relative path to a filename can be used. Remember, however, that this path\nwill be relative to process.cwd().
\n
Most fs functions let you omit the callback argument. If you do, a default\ncallback is used that rethrows errors. To get a trace to the original call\nsite, set the NODE_DEBUG environment variable:
\n
$ cat script.js\nfunction bad() {\n  require('fs').readFile('/');\n}\nbad();\n\n$ env NODE_DEBUG=fs node script.js\nfs.js:66\n        throw err;\n              ^\nError: EISDIR, read\n    at rethrow (fs.js:61:21)\n    at maybeCallback (fs.js:79:42)\n    at Object.fs.readFile (fs.js:153:18)\n    at bad (/path/to/script.js:2:17)\n    at Object.<anonymous> (/path/to/script.js:5:1)\n    <etc.>\n
",
      "classes": [
        {
          "textRaw": "Class: fs.FSWatcher",
          "type": "class",
          "name": "fs.FSWatcher",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
Objects returned from fs.watch() are of this type.
\n",
          "events": [
            {
              "textRaw": "Event: 'change'",
              "type": "event",
              "name": "change",
              "meta": {
                "added": [
                  "v0.5.8"
                ]
              },
              "params": [],
              "desc": "
Emitted when something changes in a watched directory or file.\nSee more details in fs.watch().
\n"
            },
            {
              "textRaw": "Event: 'error'",
              "type": "event",
              "name": "error",
              "meta": {
                "added": [
                  "v0.5.8"
                ]
              },
              "params": [],
              "desc": "
Emitted when an error occurs.
\n"
            }
          ],
          "methods": [
            {
              "textRaw": "watcher.close()",
              "type": "method",
              "name": "close",
              "meta": {
                "added": [
                  "v0.5.8"
                ]
              },
              "desc": "
Stop watching for changes on the given fs.FSWatcher.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            }
          ]
        },
        {
          "textRaw": "Class: fs.ReadStream",
          "type": "class",
          "name": "fs.ReadStream",
          "meta": {
            "added": [
              "v0.1.93"
            ]
          },
          "desc": "
ReadStream is a Readable Stream.
\n",
          "events": [
            {
              "textRaw": "Event: 'open'",
              "type": "event",
              "name": "open",
              "meta": {
                "added": [
                  "v0.1.93"
                ]
              },
              "params": [],
              "desc": "
Emitted when the ReadStream's file is opened.
\n"
            },
            {
              "textRaw": "Event: 'close'",
              "type": "event",
              "name": "close",
              "meta": {
                "added": [
                  "v0.1.93"
                ]
              },
              "desc": "
Emitted when the ReadStream's underlying file descriptor has been closed\nusing the fs.close() method.
\n",
              "params": []
            }
          ],
          "properties": [
            {
              "textRaw": "readStream.path",
              "name": "path",
              "meta": {
                "added": [
                  "v0.1.93"
                ]
              },
              "desc": "
The path to the file the stream is reading from.
\n"
            }
          ]
        },
        {
          "textRaw": "Class: fs.Stats",
          "type": "class",
          "name": "fs.Stats",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "desc": "
Objects returned from fs.stat(), fs.lstat() and fs.fstat() and their\nsynchronous counterparts are of this type.
\n
    \n
  • stats.isFile()
    • \n
  • stats.isDirectory()
    • \n
  • stats.isBlockDevice()
    • \n
  • stats.isCharacterDevice()
    • \n
  • stats.isSymbolicLink() (only valid with fs.lstat())
    • \n
  • stats.isFIFO()
    • \n
  • stats.isSocket()
    • \n
\n
For a regular file util.inspect(stats) would return a string very\nsimilar to this:
\n
{\n  dev: 2114,\n  ino: 48064969,\n  mode: 33188,\n  nlink: 1,\n  uid: 85,\n  gid: 100,\n  rdev: 0,\n  size: 527,\n  blksize: 4096,\n  blocks: 8,\n  atime: Mon, 10 Oct 2011 23:24:11 GMT,\n  mtime: Mon, 10 Oct 2011 23:24:11 GMT,\n  ctime: Mon, 10 Oct 2011 23:24:11 GMT,\n  birthtime: Mon, 10 Oct 2011 23:24:11 GMT\n}\n
\n
Please note that atime, mtime, birthtime, and ctime are\ninstances of Date object and to compare the values of\nthese objects you should use appropriate methods. For most general\nuses getTime() will return the number of\nmilliseconds elapsed since 1 January 1970 00:00:00 UTC and this\ninteger should be sufficient for any comparison, however there are\nadditional methods which can be used for displaying fuzzy information.\nMore details can be found in the MDN JavaScript Reference\npage.
\n",
          "modules": [
            {
              "textRaw": "Stat Time Values",
              "name": "stat_time_values",
              "desc": "
The times in the stat object have the following semantics:
\n
    \n
  • atime "Access Time" - Time when file data last accessed.  Changed\nby the mknod(2), utimes(2), and read(2) system calls.
    • \n
  • mtime "Modified Time" - Time when file data last modified.\nChanged by the mknod(2), utimes(2), and write(2) system calls.
    • \n
  • ctime "Change Time" - Time when file status was last changed\n(inode data modification).  Changed by the chmod(2), chown(2),\nlink(2), mknod(2), rename(2), unlink(2), utimes(2),\nread(2), and write(2) system calls.
    • \n
  • birthtime "Birth Time" -  Time of file creation. Set once when the\nfile is created.  On filesystems where birthtime is not available,\nthis field may instead hold either the ctime or\n1970-01-01T00:00Z (ie, unix epoch timestamp 0). Note that this\nvalue may be greater than atime or mtime in this case. On Darwin\nand other FreeBSD variants, also set if the atime is explicitly\nset to an earlier value than the current birthtime using the\nutimes(2) system call.
    • \n
\n
Prior to Node v0.12, the ctime held the birthtime on Windows\nsystems.  Note that as of v0.12, ctime is not "creation time", and\non Unix systems, it never was.
\n",
              "type": "module",
              "displayName": "Stat Time Values"
            }
          ]
        },
        {
          "textRaw": "Class: fs.WriteStream",
          "type": "class",
          "name": "fs.WriteStream",
          "meta": {
            "added": [
              "v0.1.93"
            ]
          },
          "desc": "
WriteStream is a Writable Stream.
\n",
          "events": [
            {
              "textRaw": "Event: 'open'",
              "type": "event",
              "name": "open",
              "meta": {
                "added": [
                  "v0.1.93"
                ]
              },
              "params": [],
              "desc": "
Emitted when the WriteStream's file is opened.
\n"
            },
            {
              "textRaw": "Event: 'close'",
              "type": "event",
              "name": "close",
              "meta": {
                "added": [
                  "v0.1.93"
                ]
              },
              "desc": "
Emitted when the WriteStream's underlying file descriptor has been closed\nusing the fs.close() method.
\n",
              "params": []
            }
          ],
          "properties": [
            {
              "textRaw": "writeStream.bytesWritten",
              "name": "bytesWritten",
              "meta": {
                "added": [
                  "v0.4.7"
                ]
              },
              "desc": "
The number of bytes written so far. Does not include data that is still queued\nfor writing.
\n"
            },
            {
              "textRaw": "writeStream.path",
              "name": "path",
              "meta": {
                "added": [
                  "v0.1.93"
                ]
              },
              "desc": "
The path to the file the stream is writing to.
\n"
            }
          ]
        }
      ],
      "methods": [
        {
          "textRaw": "fs.access(path[, mode], callback)",
          "type": "method",
          "name": "access",
          "meta": {
            "added": [
              "v0.11.15"
            ]
          },
          "desc": "
Tests a user's permissions for the file specified by path. mode is an\noptional integer that specifies the accessibility checks to be performed. The\nfollowing constants define the possible values of mode. It is possible to\ncreate a mask consisting of the bitwise OR of two or more values.
\n
    \n
  • fs.F_OK - File is visible to the calling process. This is useful for\ndetermining if a file exists, but says nothing about rwx permissions.\nDefault if no mode is specified.
    • \n
  • fs.R_OK - File can be read by the calling process.
    • \n
  • fs.W_OK - File can be written by the calling process.
    • \n
  • fs.X_OK - File can be executed by the calling process. This has no effect\non Windows (will behave like fs.F_OK).
    • \n
\n
The final argument, callback, is a callback function that is invoked with\na possible error argument. If any of the accessibility checks fail, the error\nargument will be populated. The following example checks if the file\n/etc/passwd can be read and written by the current process.
\n
fs.access('/etc/passwd', fs.R_OK | fs.W_OK, (err) => {\n  console.log(err ? 'no access!' : 'can read/write');\n});\n
\n
Using fs.access() to check for the accessibility of a file before calling\nfs.open(), fs.readFile() or fs.writeFile() is not recommended. Doing\nso introduces a race condition, since other processes may change the file's\nstate between the two calls. Instead, user code should open/read/write the\nfile directly and handle the error raised if the file is not accessible.
\n
For example:
\n
write (NOT RECOMMENDED)
\n
fs.access('myfile', (err) => {\n  if (!err) {\n    console.error('myfile already exists');\n    return;\n  }\n\n  fs.open('myfile', 'wx', (err, fd) => {\n    if (err) throw err;\n    writeMyData(fd);\n  });\n});\n
\n
write (RECOMMENDED)
\n
fs.open('myfile', 'wx', (err, fd) => {\n  if (err) {\n    if (err.code === "EEXIST") {\n      console.error('myfile already exists');\n      return;\n    } else {\n      throw err;\n    }\n  }\n\n  writeMyData(fd);\n});\n
\n
read (NOT RECOMMENDED)
\n
fs.access('myfile', (err) => {\n  if (err) {\n    if (err.code === "ENOENT") {\n      console.error('myfile does not exist');\n      return;\n    } else {\n      throw err;\n    }\n  }\n\n  fs.open('myfile', 'r', (err, fd) => {\n    if (err) throw err;\n    readMyData(fd);\n  });\n});\n
\n
read (RECOMMENDED)
\n
fs.open('myfile', 'r', (err, fd) => {\n  if (err) {\n    if (err.code === "ENOENT") {\n      console.error('myfile does not exist');\n      return;\n    } else {\n      throw err;\n    }\n  }\n\n  readMyData(fd);\n});\n
\n
The "not recommended" examples above check for accessibility and then use the\nfile; the "recommended" examples are better because they use the file directly\nand handle the error, if any.
\n
In general, check for the accessibility of a file only if the file won’t be\nused directly, for example when its accessibility is a signal from another\nprocess.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "mode",
                  "optional": true
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.accessSync(path[, mode])",
          "type": "method",
          "name": "accessSync",
          "meta": {
            "added": [
              "v0.11.15"
            ]
          },
          "desc": "
Synchronous version of fs.access(). This throws if any accessibility checks\nfail, and does nothing otherwise.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "mode",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.appendFile(file, data[, options], callback)",
          "type": "method",
          "name": "appendFile",
          "meta": {
            "added": [
              "v0.6.7"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`file` {String} filename ",
                  "name": "file",
                  "type": "String",
                  "desc": "filename"
                },
                {
                  "textRaw": "`data` {String|Buffer} ",
                  "name": "data",
                  "type": "String|Buffer"
                },
                {
                  "textRaw": "`options` {Object|String} ",
                  "options": [
                    {
                      "textRaw": "`encoding` {String|Null} default = `'utf8'` ",
                      "name": "encoding",
                      "type": "String|Null",
                      "desc": "default = `'utf8'`"
                    },
                    {
                      "textRaw": "`mode` {Number} default = `0o666` ",
                      "name": "mode",
                      "type": "Number",
                      "desc": "default = `0o666`"
                    },
                    {
                      "textRaw": "`flag` {String} default = `'a'` ",
                      "name": "flag",
                      "type": "String",
                      "desc": "default = `'a'`"
                    }
                  ],
                  "name": "options",
                  "type": "Object|String",
                  "optional": true
                },
                {
                  "textRaw": "`callback` {Function} ",
                  "name": "callback",
                  "type": "Function"
                }
              ]
            },
            {
              "params": [
                {
                  "name": "file"
                },
                {
                  "name": "data"
                },
                {
                  "name": "options",
                  "optional": true
                },
                {
                  "name": "callback"
                }
              ]
            }
          ],
          "desc": "
Asynchronously append data to a file, creating the file if it does not yet exist.\ndata can be a string or a buffer.
\n
Example:
\n
fs.appendFile('message.txt', 'data to append', (err) => {\n  if (err) throw err;\n  console.log('The "data to append" was appended to file!');\n});\n
\n
If options is a string, then it specifies the encoding. Example:
\n
fs.appendFile('message.txt', 'data to append', 'utf8', callback);\n
\n"
        },
        {
          "textRaw": "fs.appendFileSync(file, data[, options])",
          "type": "method",
          "name": "appendFileSync",
          "meta": {
            "added": [
              "v0.6.7"
            ]
          },
          "desc": "
The synchronous version of fs.appendFile(). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "file"
                },
                {
                  "name": "data"
                },
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.chmod(path, mode, callback)",
          "type": "method",
          "name": "chmod",
          "meta": {
            "added": [
              "v0.1.30"
            ]
          },
          "desc": "
Asynchronous chmod(2). No arguments other than a possible exception are given\nto the completion callback.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "mode"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.chmodSync(path, mode)",
          "type": "method",
          "name": "chmodSync",
          "meta": {
            "added": [
              "v0.6.7"
            ]
          },
          "desc": "
Synchronous chmod(2). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "mode"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.chown(path, uid, gid, callback)",
          "type": "method",
          "name": "chown",
          "meta": {
            "added": [
              "v0.1.97"
            ]
          },
          "desc": "
Asynchronous chown(2). No arguments other than a possible exception are given\nto the completion callback.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "uid"
                },
                {
                  "name": "gid"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.chownSync(path, uid, gid)",
          "type": "method",
          "name": "chownSync",
          "meta": {
            "added": [
              "v0.1.97"
            ]
          },
          "desc": "
Synchronous chown(2). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "uid"
                },
                {
                  "name": "gid"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.close(fd, callback)",
          "type": "method",
          "name": "close",
          "meta": {
            "added": [
              "v0.0.2"
            ]
          },
          "desc": "
Asynchronous close(2).  No arguments other than a possible exception are given\nto the completion callback.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.closeSync(fd)",
          "type": "method",
          "name": "closeSync",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "desc": "
Synchronous close(2). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.createReadStream(path[, options])",
          "type": "method",
          "name": "createReadStream",
          "meta": {
            "added": [
              "v0.1.31"
            ]
          },
          "desc": "
Returns a new ReadStream object. (See Readable Stream).
\n
Be aware that, unlike the default value set for highWaterMark on a\nreadable stream (16 kb), the stream returned by this method has a\ndefault value of 64 kb for the same parameter.
\n
options is an object or string with the following defaults:
\n
{\n  flags: 'r',\n  encoding: null,\n  fd: null,\n  mode: 0o666,\n  autoClose: true\n}\n
\n
options can include start and end values to read a range of bytes from\nthe file instead of the entire file.  Both start and end are inclusive and\nstart counting at 0. If fd is specified and start is omitted or undefined,\nfs.createReadStream() reads sequentially from the current file position.\nThe encoding can be any one of those accepted by Buffer.
\n
If fd is specified, ReadStream will ignore the path argument and will use\nthe specified file descriptor. This means that no 'open' event will be emitted.\nNote that fd should be blocking; non-blocking fds should be passed to\nnet.Socket.
\n
If autoClose is false, then the file descriptor won't be closed, even if\nthere's an error.  It is your responsibility to close it and make sure\nthere's no file descriptor leak.  If autoClose is set to true (default\nbehavior), on error or end the file descriptor will be closed\nautomatically.
\n
mode sets the file mode (permission and sticky bits), but only if the\nfile was created.
\n
An example to read the last 10 bytes of a file which is 100 bytes long:
\n
fs.createReadStream('sample.txt', {start: 90, end: 99});\n
\n
If options is a string, then it specifies the encoding.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.createWriteStream(path[, options])",
          "type": "method",
          "name": "createWriteStream",
          "meta": {
            "added": [
              "v0.1.31"
            ]
          },
          "desc": "
Returns a new WriteStream object. (See Writable Stream).
\n
options is an object or string with the following defaults:
\n
{\n  flags: 'w',\n  defaultEncoding: 'utf8',\n  fd: null,\n  mode: 0o666\n}\n
\n
options may also include a start option to allow writing data at\nsome position past the beginning of the file.  Modifying a file rather\nthan replacing it may require a flags mode of r+ rather than the\ndefault mode w. The defaultEncoding can be any one of those accepted by Buffer.
\n
Like ReadStream, if fd is specified, WriteStream will ignore the\npath argument and will use the specified file descriptor. This means that no\n'open' event will be emitted. Note that fd should be blocking; non-blocking\nfds should be passed to net.Socket.
\n
If options is a string, then it specifies the encoding.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.exists(path, callback)",
          "type": "method",
          "name": "exists",
          "meta": {
            "added": [
              "v0.0.2"
            ],
            "deprecated": [
              "v1.0.0"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated: Use [`fs.stat()`][] or [`fs.access()`][] instead.",
          "desc": "
Test whether or not the given path exists by checking with the file system.\nThen call the callback argument with either true or false.  Example:
\n
fs.exists('/etc/passwd', (exists) => {\n  console.log(exists ? 'it\\'s there' : 'no passwd!');\n});\n
\n
Using fs.exists() to check for the existence of a file before calling\nfs.open(), fs.readFile() or fs.writeFile() is not recommended. Doing\nso introduces a race condition, since other processes may change the file's\nstate between the two calls. Instead, user code should open/read/write the\nfile directly and handle the error raised if the file does not exist.
\n
For example:
\n
write (NOT RECOMMENDED)
\n
fs.exists('myfile', (exists) => {\n  if (exists) {\n    console.error('myfile already exists');\n  } else {\n    fs.open('myfile', 'wx', (err, fd) => {\n      if (err) throw err;\n      writeMyData(fd);\n    });\n  }\n});\n
\n
write (RECOMMENDED)
\n
fs.open('myfile', 'wx', (err, fd) => {\n  if (err) {\n    if (err.code === "EEXIST") {\n      console.error('myfile already exists');\n      return;\n    } else {\n      throw err;\n    }\n  }\n  writeMyData(fd);\n});\n
\n
read (NOT RECOMMENDED)
\n
fs.exists('myfile', (exists) => {\n  if (exists) {\n    fs.open('myfile', 'r', (err, fd) => {\n      readMyData(fd);\n    });\n  } else {\n    console.error('myfile does not exist');\n  }\n});\n
\n
read (RECOMMENDED)
\n
fs.open('myfile', 'r', (err, fd) => {\n  if (err) {\n    if (err.code === "ENOENT") {\n      console.error('myfile does not exist');\n      return;\n    } else {\n      throw err;\n    }\n  } else {\n    readMyData(fd);\n  }\n});\n
\n
The "not recommended" examples above check for existence and then use the\nfile; the "recommended" examples are better because they use the file directly\nand handle the error, if any.
\n
In general, check for the existence of a file only if the file won’t be\nused directly, for example when its existence is a signal from another\nprocess.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.existsSync(path)",
          "type": "method",
          "name": "existsSync",
          "meta": {
            "added": [
              "v0.1.21"
            ],
            "deprecated": [
              "v1.0.0"
            ]
          },
          "desc": "
Stability: 0 - Deprecated: Use fs.statSync() or fs.accessSync()\ninstead.
\n
Synchronous version of fs.exists().\nReturns true if the file exists, false otherwise.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.fchmod(fd, mode, callback)",
          "type": "method",
          "name": "fchmod",
          "meta": {
            "added": [
              "v0.4.7"
            ]
          },
          "desc": "
Asynchronous fchmod(2). No arguments other than a possible exception\nare given to the completion callback.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "mode"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.fchmodSync(fd, mode)",
          "type": "method",
          "name": "fchmodSync",
          "meta": {
            "added": [
              "v0.4.7"
            ]
          },
          "desc": "
Synchronous fchmod(2). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "mode"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.fchown(fd, uid, gid, callback)",
          "type": "method",
          "name": "fchown",
          "meta": {
            "added": [
              "v0.4.7"
            ]
          },
          "desc": "
Asynchronous fchown(2). No arguments other than a possible exception are given\nto the completion callback.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "uid"
                },
                {
                  "name": "gid"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.fchownSync(fd, uid, gid)",
          "type": "method",
          "name": "fchownSync",
          "meta": {
            "added": [
              "v0.4.7"
            ]
          },
          "desc": "
Synchronous fchown(2). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "uid"
                },
                {
                  "name": "gid"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.fdatasync(fd, callback)",
          "type": "method",
          "name": "fdatasync",
          "meta": {
            "added": [
              "v0.1.96"
            ]
          },
          "desc": "
Asynchronous fdatasync(2). No arguments other than a possible exception are\ngiven to the completion callback.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.fdatasyncSync(fd)",
          "type": "method",
          "name": "fdatasyncSync",
          "meta": {
            "added": [
              "v0.1.96"
            ]
          },
          "desc": "
Synchronous fdatasync(2). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.fstat(fd, callback)",
          "type": "method",
          "name": "fstat",
          "meta": {
            "added": [
              "v0.1.95"
            ]
          },
          "desc": "
Asynchronous fstat(2). The callback gets two arguments (err, stats) where\nstats is a fs.Stats object. fstat() is identical to stat(),\nexcept that the file to be stat-ed is specified by the file descriptor fd.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.fstatSync(fd)",
          "type": "method",
          "name": "fstatSync",
          "meta": {
            "added": [
              "v0.1.95"
            ]
          },
          "desc": "
Synchronous fstat(2). Returns an instance of fs.Stats.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.fsync(fd, callback)",
          "type": "method",
          "name": "fsync",
          "meta": {
            "added": [
              "v0.1.96"
            ]
          },
          "desc": "
Asynchronous fsync(2). No arguments other than a possible exception are given\nto the completion callback.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.fsyncSync(fd)",
          "type": "method",
          "name": "fsyncSync",
          "meta": {
            "added": [
              "v0.1.96"
            ]
          },
          "desc": "
Synchronous fsync(2). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.ftruncate(fd, len, callback)",
          "type": "method",
          "name": "ftruncate",
          "meta": {
            "added": [
              "v0.8.6"
            ]
          },
          "desc": "
Asynchronous ftruncate(2). No arguments other than a possible exception are\ngiven to the completion callback.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "len"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.ftruncateSync(fd, len)",
          "type": "method",
          "name": "ftruncateSync",
          "meta": {
            "added": [
              "v0.8.6"
            ]
          },
          "desc": "
Synchronous ftruncate(2). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "len"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.futimes(fd, atime, mtime, callback)",
          "type": "method",
          "name": "futimes",
          "meta": {
            "added": [
              "v0.4.2"
            ]
          },
          "desc": "
Change the file timestamps of a file referenced by the supplied file\ndescriptor.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "atime"
                },
                {
                  "name": "mtime"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.futimesSync(fd, atime, mtime)",
          "type": "method",
          "name": "futimesSync",
          "meta": {
            "added": [
              "v0.4.2"
            ]
          },
          "desc": "
Synchronous version of fs.futimes(). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "atime"
                },
                {
                  "name": "mtime"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.lchmod(path, mode, callback)",
          "type": "method",
          "name": "lchmod",
          "meta": {
            "deprecated": [
              "v0.4.7"
            ]
          },
          "desc": "
Asynchronous lchmod(2). No arguments other than a possible exception\nare given to the completion callback.
\n
Only available on Mac OS X.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "mode"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.lchmodSync(path, mode)",
          "type": "method",
          "name": "lchmodSync",
          "meta": {
            "deprecated": [
              "v0.4.7"
            ]
          },
          "desc": "
Synchronous lchmod(2). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "mode"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.lchown(path, uid, gid, callback)",
          "type": "method",
          "name": "lchown",
          "meta": {
            "deprecated": [
              "v0.4.7"
            ]
          },
          "desc": "
Asynchronous lchown(2). No arguments other than a possible exception are given\nto the completion callback.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "uid"
                },
                {
                  "name": "gid"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.lchownSync(path, uid, gid)",
          "type": "method",
          "name": "lchownSync",
          "meta": {
            "deprecated": [
              "v0.4.7"
            ]
          },
          "desc": "
Synchronous lchown(2). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "uid"
                },
                {
                  "name": "gid"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.link(srcpath, dstpath, callback)",
          "type": "method",
          "name": "link",
          "meta": {
            "added": [
              "v0.1.31"
            ]
          },
          "desc": "
Asynchronous link(2). No arguments other than a possible exception are given to\nthe completion callback.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "srcpath"
                },
                {
                  "name": "dstpath"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.linkSync(srcpath, dstpath)",
          "type": "method",
          "name": "linkSync",
          "meta": {
            "added": [
              "v0.1.31"
            ]
          },
          "desc": "
Synchronous link(2). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "srcpath"
                },
                {
                  "name": "dstpath"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.lstat(path, callback)",
          "type": "method",
          "name": "lstat",
          "meta": {
            "added": [
              "v0.1.30"
            ]
          },
          "desc": "
Asynchronous lstat(2). The callback gets two arguments (err, stats) where\nstats is a fs.Stats object. lstat() is identical to stat(),\nexcept that if path is a symbolic link, then the link itself is stat-ed,\nnot the file that it refers to.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.lstatSync(path)",
          "type": "method",
          "name": "lstatSync",
          "meta": {
            "added": [
              "v0.1.30"
            ]
          },
          "desc": "
Synchronous lstat(2). Returns an instance of fs.Stats.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.mkdir(path[, mode], callback)",
          "type": "method",
          "name": "mkdir",
          "meta": {
            "added": [
              "v0.1.8"
            ]
          },
          "desc": "
Asynchronous mkdir(2). No arguments other than a possible exception are given\nto the completion callback. mode defaults to 0o777.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "mode",
                  "optional": true
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.mkdirSync(path[, mode])",
          "type": "method",
          "name": "mkdirSync",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "desc": "
Synchronous mkdir(2). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "mode",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.mkdtemp(prefix, callback)",
          "type": "method",
          "name": "mkdtemp",
          "desc": "
Creates a unique temporary directory.
\n
Generates six random characters to be appended behind a required\nprefix to create a unique temporary directory.
\n
The created folder path is passed as a string to the callback's second\nparameter.
\n
Example:
\n
fs.mkdtemp('/tmp/foo-', (err, folder) => {\n  console.log(folder);\n    // Prints: /tmp/foo-itXde2\n});\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "prefix"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.mkdtempSync(template)",
          "type": "method",
          "name": "mkdtempSync",
          "desc": "
The synchronous version of [fs.mkdtemp()][]. Returns the created\nfolder path.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "template"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.open(path, flags[, mode], callback)",
          "type": "method",
          "name": "open",
          "meta": {
            "added": [
              "v0.0.2"
            ]
          },
          "desc": "
Asynchronous file open. See open(2). flags can be:
\n
    \n
  • 'r' - Open file for reading.\nAn exception occurs if the file does not exist.
    \n
    • \n
  • 'r+' - Open file for reading and writing.\nAn exception occurs if the file does not exist.
    \n
    • \n
  • 'rs' - Open file for reading in synchronous mode. Instructs the operating\nsystem to bypass the local file system cache.
    \n
    This is primarily useful for opening files on NFS mounts as it allows you to\nskip the potentially stale local cache. It has a very real impact on I/O\nperformance so don't use this flag unless you need it.
    \n
    Note that this doesn't turn fs.open() into a synchronous blocking call.\nIf that's what you want then you should be using fs.openSync()
    \n
    • \n
  • 'rs+' - Open file for reading and writing, telling the OS to open it\nsynchronously. See notes for 'rs' about using this with caution.
    \n
    • \n
  • 'w' - Open file for writing.\nThe file is created (if it does not exist) or truncated (if it exists).
    \n
    • \n
  • 'wx' - Like 'w' but fails if path exists.
    \n
    • \n
  • 'w+' - Open file for reading and writing.\nThe file is created (if it does not exist) or truncated (if it exists).
    \n
    • \n
  • 'wx+' - Like 'w+' but fails if path exists.
    \n
    • \n
  • 'a' - Open file for appending.\nThe file is created if it does not exist.
    \n
    • \n
  • 'ax' - Like 'a' but fails if path exists.
    \n
    • \n
  • 'a+' - Open file for reading and appending.\nThe file is created if it does not exist.
    \n
    • \n
  • 'ax+' - Like 'a+' but fails if path exists.
    \n
    • \n
\n
mode sets the file mode (permission and sticky bits), but only if the file was\ncreated. It defaults to 0666, readable and writable.
\n
The callback gets two arguments (err, fd).
\n
The exclusive flag 'x' (O_EXCL flag in open(2)) ensures that path is newly\ncreated. On POSIX systems, path is considered to exist even if it is a symlink\nto a non-existent file. The exclusive flag may or may not work with network file\nsystems.
\n
flags can also be a number as documented by open(2); commonly used constants\nare available from require('constants').  On Windows, flags are translated to\ntheir equivalent ones where applicable, e.g. O_WRONLY to FILE_GENERIC_WRITE,\nor O_EXCL|O_CREAT to CREATE_NEW, as accepted by CreateFileW.
\n
On Linux, positional writes don't work when the file is opened in append mode.\nThe kernel ignores the position argument and always appends the data to\nthe end of the file.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "flags"
                },
                {
                  "name": "mode",
                  "optional": true
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.openSync(path, flags[, mode])",
          "type": "method",
          "name": "openSync",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "desc": "
Synchronous version of fs.open(). Returns an integer representing the file\ndescriptor.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "flags"
                },
                {
                  "name": "mode",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.read(fd, buffer, offset, length, position, callback)",
          "type": "method",
          "name": "read",
          "meta": {
            "added": [
              "v0.0.2"
            ]
          },
          "desc": "
Read data from the file specified by fd.
\n
buffer is the buffer that the data will be written to.
\n
offset is the offset in the buffer to start writing at.
\n
length is an integer specifying the number of bytes to read.
\n
position is an integer specifying where to begin reading from in the file.\nIf position is null, data will be read from the current file position.
\n
The callback is given the three arguments, (err, bytesRead, buffer).
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "buffer"
                },
                {
                  "name": "offset"
                },
                {
                  "name": "length"
                },
                {
                  "name": "position"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.readdir(path, callback)",
          "type": "method",
          "name": "readdir",
          "meta": {
            "added": [
              "v0.1.8"
            ]
          },
          "desc": "
Asynchronous readdir(3).  Reads the contents of a directory.\nThe callback gets two arguments (err, files) where files is an array of\nthe names of the files in the directory excluding '.' and '..'.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.readdirSync(path)",
          "type": "method",
          "name": "readdirSync",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "desc": "
Synchronous readdir(3). Returns an array of filenames excluding '.' and\n'..'.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.readFile(file[, options], callback)",
          "type": "method",
          "name": "readFile",
          "meta": {
            "added": [
              "v0.1.29"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`file` {String} filename ",
                  "name": "file",
                  "type": "String",
                  "desc": "filename"
                },
                {
                  "textRaw": "`options` {Object | String} ",
                  "options": [
                    {
                      "textRaw": "`encoding` {String | Null} default = `null` ",
                      "name": "encoding",
                      "type": "String | Null",
                      "desc": "default = `null`"
                    },
                    {
                      "textRaw": "`flag` {String} default = `'r'` ",
                      "name": "flag",
                      "type": "String",
                      "desc": "default = `'r'`"
                    }
                  ],
                  "name": "options",
                  "type": "Object | String",
                  "optional": true
                },
                {
                  "textRaw": "`callback` {Function} ",
                  "name": "callback",
                  "type": "Function"
                }
              ]
            },
            {
              "params": [
                {
                  "name": "file"
                },
                {
                  "name": "options",
                  "optional": true
                },
                {
                  "name": "callback"
                }
              ]
            }
          ],
          "desc": "
Asynchronously reads the entire contents of a file. Example:
\n
fs.readFile('/etc/passwd', (err, data) => {\n  if (err) throw err;\n  console.log(data);\n});\n
\n
The callback is passed two arguments (err, data), where data is the\ncontents of the file.
\n
If no encoding is specified, then the raw buffer is returned.
\n
If options is a string, then it specifies the encoding. Example:
\n
fs.readFile('/etc/passwd', 'utf8', callback);\n
\n"
        },
        {
          "textRaw": "fs.readFileSync(file[, options])",
          "type": "method",
          "name": "readFileSync",
          "meta": {
            "added": [
              "v0.1.8"
            ]
          },
          "desc": "
Synchronous version of fs.readFile. Returns the contents of the file.
\n
If the encoding option is specified then this function returns a\nstring. Otherwise it returns a buffer.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "file"
                },
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.readlink(path, callback)",
          "type": "method",
          "name": "readlink",
          "meta": {
            "added": [
              "v0.1.31"
            ]
          },
          "desc": "
Asynchronous readlink(2). The callback gets two arguments (err,\nlinkString).
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.readlinkSync(path)",
          "type": "method",
          "name": "readlinkSync",
          "meta": {
            "added": [
              "v0.1.31"
            ]
          },
          "desc": "
Synchronous readlink(2). Returns the symbolic link's string value.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.realpath(path[, cache], callback)",
          "type": "method",
          "name": "realpath",
          "meta": {
            "added": [
              "v0.1.31"
            ]
          },
          "desc": "
Asynchronous realpath(2). The callback gets two arguments (err,\nresolvedPath). May use process.cwd to resolve relative paths. cache is an\nobject literal of mapped paths that can be used to force a specific path\nresolution or avoid additional fs.stat calls for known real paths.
\n
Example:
\n
var cache = {'/etc':'/private/etc'};\nfs.realpath('/etc/passwd', cache, (err, resolvedPath) => {\n  if (err) throw err;\n  console.log(resolvedPath);\n});\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "cache",
                  "optional": true
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.readSync(fd, buffer, offset, length, position)",
          "type": "method",
          "name": "readSync",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "desc": "
Synchronous version of fs.read(). Returns the number of bytesRead.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "buffer"
                },
                {
                  "name": "offset"
                },
                {
                  "name": "length"
                },
                {
                  "name": "position"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.realpathSync(path[, cache])",
          "type": "method",
          "name": "realpathSync",
          "meta": {
            "added": [
              "v0.1.31"
            ]
          },
          "desc": "
Synchronous realpath(2). Returns the resolved path. cache is an\nobject literal of mapped paths that can be used to force a specific path\nresolution or avoid additional fs.stat calls for known real paths.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "cache",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.rename(oldPath, newPath, callback)",
          "type": "method",
          "name": "rename",
          "meta": {
            "added": [
              "v0.0.2"
            ]
          },
          "desc": "
Asynchronous rename(2). No arguments other than a possible exception are given\nto the completion callback.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "oldPath"
                },
                {
                  "name": "newPath"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.renameSync(oldPath, newPath)",
          "type": "method",
          "name": "renameSync",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "desc": "
Synchronous rename(2). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "oldPath"
                },
                {
                  "name": "newPath"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.rmdir(path, callback)",
          "type": "method",
          "name": "rmdir",
          "meta": {
            "added": [
              "v0.0.2"
            ]
          },
          "desc": "
Asynchronous rmdir(2). No arguments other than a possible exception are given\nto the completion callback.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.rmdirSync(path)",
          "type": "method",
          "name": "rmdirSync",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "desc": "
Synchronous rmdir(2). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.stat(path, callback)",
          "type": "method",
          "name": "stat",
          "meta": {
            "added": [
              "v0.0.2"
            ]
          },
          "desc": "
Asynchronous stat(2). The callback gets two arguments (err, stats) where\nstats is a fs.Stats object.  See the fs.Stats section for more\ninformation.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.statSync(path)",
          "type": "method",
          "name": "statSync",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "desc": "
Synchronous stat(2). Returns an instance of fs.Stats.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.symlink(target, path[, type], callback)",
          "type": "method",
          "name": "symlink",
          "meta": {
            "added": [
              "v0.1.31"
            ]
          },
          "desc": "
Asynchronous symlink(2). No arguments other than a possible exception are given\nto the completion callback.\nThe type argument can be set to 'dir', 'file', or 'junction' (default\nis 'file') and is only available on Windows (ignored on other platforms).\nNote that Windows junction points require the destination path to be absolute.  When using\n'junction', the target argument will automatically be normalized to absolute path.
\n
Here is an example below:
\n
fs.symlink('./foo', './new-port');\n
\n
It creates a symbolic link named "new-port" that points to "foo".
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "target"
                },
                {
                  "name": "path"
                },
                {
                  "name": "type",
                  "optional": true
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.symlinkSync(target, path[, type])",
          "type": "method",
          "name": "symlinkSync",
          "meta": {
            "added": [
              "v0.1.31"
            ]
          },
          "desc": "
Synchronous symlink(2). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "target"
                },
                {
                  "name": "path"
                },
                {
                  "name": "type",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.truncate(path, len, callback)",
          "type": "method",
          "name": "truncate",
          "meta": {
            "added": [
              "v0.8.6"
            ]
          },
          "desc": "
Asynchronous truncate(2). No arguments other than a possible exception are\ngiven to the completion callback. A file descriptor can also be passed as the\nfirst argument. In this case, fs.ftruncate() is called.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "len"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.truncateSync(path, len)",
          "type": "method",
          "name": "truncateSync",
          "meta": {
            "added": [
              "v0.8.6"
            ]
          },
          "desc": "
Synchronous truncate(2). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "len"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.unlink(path, callback)",
          "type": "method",
          "name": "unlink",
          "meta": {
            "added": [
              "v0.0.2"
            ]
          },
          "desc": "
Asynchronous unlink(2). No arguments other than a possible exception are given\nto the completion callback.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.unlinkSync(path)",
          "type": "method",
          "name": "unlinkSync",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "desc": "
Synchronous unlink(2). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.unwatchFile(filename[, listener])",
          "type": "method",
          "name": "unwatchFile",
          "meta": {
            "added": [
              "v0.1.31"
            ]
          },
          "desc": "
Stop watching for changes on filename. If listener is specified, only that\nparticular listener is removed. Otherwise, all listeners are removed and you\nhave effectively stopped watching filename.
\n
Calling fs.unwatchFile() with a filename that is not being watched is a\nno-op, not an error.
\n
Note: fs.watch() is more efficient than fs.watchFile() and fs.unwatchFile().\nfs.watch() should be used instead of fs.watchFile() and fs.unwatchFile()\nwhen possible.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "filename"
                },
                {
                  "name": "listener",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.utimes(path, atime, mtime, callback)",
          "type": "method",
          "name": "utimes",
          "meta": {
            "added": [
              "v0.4.2"
            ]
          },
          "desc": "
Change file timestamps of the file referenced by the supplied path.
\n
Note: the arguments atime and mtime of the following related functions does\nfollow the below rules:
\n
    \n
  • If the value is a numberable string like '123456789', the value would get\nconverted to corresponding number.
    • \n
  • If the value is NaN or Infinity, the value would get converted to\nDate.now().
    • \n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "atime"
                },
                {
                  "name": "mtime"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.utimesSync(path, atime, mtime)",
          "type": "method",
          "name": "utimesSync",
          "meta": {
            "added": [
              "v0.4.2"
            ]
          },
          "desc": "
Synchronous version of fs.utimes(). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "atime"
                },
                {
                  "name": "mtime"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.watch(filename[, options][, listener])",
          "type": "method",
          "name": "watch",
          "meta": {
            "added": [
              "v0.5.10"
            ]
          },
          "desc": "
Watch for changes on filename, where filename is either a file or a\ndirectory.  The returned object is a fs.FSWatcher.
\n
The second argument is optional. The options if provided should be an object.\nThe supported boolean members are persistent and recursive. persistent\nindicates whether the process should continue to run as long as files are being\nwatched. recursive indicates whether all subdirectories should be watched, or\nonly the current directory. This applies when a directory is specified, and only\non supported platforms (See Caveats).
\n
The default is { persistent: true, recursive: false }.
\n
The listener callback gets two arguments (event, filename).  event is either\n'rename' or 'change', and filename is the name of the file which triggered\nthe event.
\n",
          "miscs": [
            {
              "textRaw": "Caveats",
              "name": "Caveats",
              "type": "misc",
              "desc": "
The fs.watch API is not 100% consistent across platforms, and is\nunavailable in some situations.
\n
The recursive option is only supported on OS X and Windows.
\n",
              "miscs": [
                {
                  "textRaw": "Availability",
                  "name": "Availability",
                  "type": "misc",
                  "desc": "
This feature depends on the underlying operating system providing a way\nto be notified of filesystem changes.
\n
    \n
  • On Linux systems, this uses inotify.
    • \n
  • On BSD systems, this uses kqueue.
    • \n
  • On OS X, this uses kqueue for files and 'FSEvents' for directories.
    • \n
  • On SunOS systems (including Solaris and SmartOS), this uses event ports.
    • \n
  • On Windows systems, this feature depends on ReadDirectoryChangesW.
    • \n
  • On Aix systems, this feature depends on AHAFS, which must be enabled.
    • \n
\n
If the underlying functionality is not available for some reason, then\nfs.watch will not be able to function. For example, watching files or\ndirectories can be unreliable, and in some cases impossible, on network file\nsystems (NFS, SMB, etc), or host file systems when using virtualization software\nsuch as Vagrant, Docker, etc.
\n
You can still use fs.watchFile, which uses stat polling, but it is slower and\nless reliable.
\n"
                },
                {
                  "textRaw": "Inodes",
                  "name": "Inodes",
                  "type": "misc",
                  "desc": "
On Linux and OS X systems, fs.watch() resolves the path to an inode and\nwatches the inode. If the watched path is deleted and recreated, it is assigned\na new inode. The watch will emit an event for the delete but will continue\nwatching the original inode. Events for the new inode will not be emitted.\nThis is expected behavior.
\n"
                },
                {
                  "textRaw": "Filename Argument",
                  "name": "Filename Argument",
                  "type": "misc",
                  "desc": "
Providing filename argument in the callback is only supported on Linux and\nWindows.  Even on supported platforms, filename is not always guaranteed to\nbe provided. Therefore, don't assume that filename argument is always\nprovided in the callback, and have some fallback logic if it is null.
\n
fs.watch('somedir', (event, filename) => {\n  console.log(`event is: ${event}`);\n  if (filename) {\n    console.log(`filename provided: ${filename}`);\n  } else {\n    console.log('filename not provided');\n  }\n});\n
\n"
                }
              ]
            }
          ],
          "signatures": [
            {
              "params": [
                {
                  "name": "filename"
                },
                {
                  "name": "options",
                  "optional": true
                },
                {
                  "name": "listener",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.watchFile(filename[, options], listener)",
          "type": "method",
          "name": "watchFile",
          "meta": {
            "added": [
              "v0.1.31"
            ]
          },
          "desc": "
Watch for changes on filename. The callback listener will be called each\ntime the file is accessed.
\n
The options argument may be omitted. If provided, it should be an object. The\noptions object may contain a boolean named persistent that indicates\nwhether the process should continue to run as long as files are being watched.\nThe options object may specify an interval property indicating how often the\ntarget should be polled in milliseconds. The default is\n{ persistent: true, interval: 5007 }.
\n
The listener gets two arguments the current stat object and the previous\nstat object:
\n
fs.watchFile('message.text', (curr, prev) => {\n  console.log(`the current mtime is: ${curr.mtime}`);\n  console.log(`the previous mtime was: ${prev.mtime}`);\n});\n
\n
These stat objects are instances of fs.Stat.
\n
If you want to be notified when the file was modified, not just accessed,\nyou need to compare curr.mtime and prev.mtime.
\n
Note: when an fs.watchFile operation results in an ENOENT error, it will\n invoke the listener once, with all the fields zeroed (or, for dates, the Unix\n Epoch). In Windows, blksize and blocks fields will be undefined, instead\n of zero. If the file is created later on, the listener will be called again,\n with the latest stat objects. This is a change in functionality since v0.10.
\n
Note: fs.watch() is more efficient than fs.watchFile and fs.unwatchFile.\nfs.watch should be used instead of fs.watchFile and fs.unwatchFile\nwhen possible.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "filename"
                },
                {
                  "name": "options",
                  "optional": true
                },
                {
                  "name": "listener"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.write(fd, buffer, offset, length[, position], callback)",
          "type": "method",
          "name": "write",
          "meta": {
            "added": [
              "v0.0.2"
            ]
          },
          "desc": "
Write buffer to the file specified by fd.
\n
offset determines the part of the buffer to be written, and length is\nan integer specifying the number of bytes to write.
\n
position refers to the offset from the beginning of the file where this data\nshould be written. If typeof position !== 'number', the data will be written\nat the current position. See pwrite(2).
\n
The callback will be given three arguments (err, written, buffer) where\nwritten specifies how many bytes were written from buffer.
\n
Note that it is unsafe to use fs.write multiple times on the same file\nwithout waiting for the callback. For this scenario,\nfs.createWriteStream is strongly recommended.
\n
On Linux, positional writes don't work when the file is opened in append mode.\nThe kernel ignores the position argument and always appends the data to\nthe end of the file.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "buffer"
                },
                {
                  "name": "offset"
                },
                {
                  "name": "length"
                },
                {
                  "name": "position",
                  "optional": true
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.write(fd, data[, position[, encoding]], callback)",
          "type": "method",
          "name": "write",
          "meta": {
            "added": [
              "v0.11.5"
            ]
          },
          "desc": "
Write data to the file specified by fd.  If data is not a Buffer instance\nthen the value will be coerced to a string.
\n
position refers to the offset from the beginning of the file where this data\nshould be written. If typeof position !== 'number' the data will be written at\nthe current position. See pwrite(2).
\n
encoding is the expected string encoding.
\n
The callback will receive the arguments (err, written, string) where written\nspecifies how many bytes the passed string required to be written. Note that\nbytes written is not the same as string characters. See Buffer.byteLength.
\n
Unlike when writing buffer, the entire string must be written. No substring\nmay be specified. This is because the byte offset of the resulting data may not\nbe the same as the string offset.
\n
Note that it is unsafe to use fs.write multiple times on the same file\nwithout waiting for the callback. For this scenario,\nfs.createWriteStream is strongly recommended.
\n
On Linux, positional writes don't work when the file is opened in append mode.\nThe kernel ignores the position argument and always appends the data to\nthe end of the file.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "data"
                },
                {
                  "name": "position",
                  "optional": true
                },
                {
                  "name": "encoding",
                  "optional": true
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.writeFile(file, data[, options], callback)",
          "type": "method",
          "name": "writeFile",
          "meta": {
            "added": [
              "v0.1.29"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`file` {String} filename ",
                  "name": "file",
                  "type": "String",
                  "desc": "filename"
                },
                {
                  "textRaw": "`data` {String | Buffer} ",
                  "name": "data",
                  "type": "String | Buffer"
                },
                {
                  "textRaw": "`options` {Object | String} ",
                  "options": [
                    {
                      "textRaw": "`encoding` {String | Null} default = `'utf8'` ",
                      "name": "encoding",
                      "type": "String | Null",
                      "desc": "default = `'utf8'`"
                    },
                    {
                      "textRaw": "`mode` {Number} default = `0o666` ",
                      "name": "mode",
                      "type": "Number",
                      "desc": "default = `0o666`"
                    },
                    {
                      "textRaw": "`flag` {String} default = `'w'` ",
                      "name": "flag",
                      "type": "String",
                      "desc": "default = `'w'`"
                    }
                  ],
                  "name": "options",
                  "type": "Object | String",
                  "optional": true
                },
                {
                  "textRaw": "`callback` {Function} ",
                  "name": "callback",
                  "type": "Function"
                }
              ]
            },
            {
              "params": [
                {
                  "name": "file"
                },
                {
                  "name": "data"
                },
                {
                  "name": "options",
                  "optional": true
                },
                {
                  "name": "callback"
                }
              ]
            }
          ],
          "desc": "
Asynchronously writes data to a file, replacing the file if it already exists.\ndata can be a string or a buffer.
\n
The encoding option is ignored if data is a buffer. It defaults\nto 'utf8'.
\n
Example:
\n
fs.writeFile('message.txt', 'Hello Node.js', (err) => {\n  if (err) throw err;\n  console.log('It\\'s saved!');\n});\n
\n
If options is a string, then it specifies the encoding. Example:
\n
fs.writeFile('message.txt', 'Hello Node.js', 'utf8', callback);\n
\n
Note that it is unsafe to use fs.writeFile multiple times on the same file\nwithout waiting for the callback. For this scenario,\nfs.createWriteStream is strongly recommended.
\n"
        },
        {
          "textRaw": "fs.writeFileSync(file, data[, options])",
          "type": "method",
          "name": "writeFileSync",
          "meta": {
            "added": [
              "v0.1.29"
            ]
          },
          "desc": "
The synchronous version of fs.writeFile(). Returns undefined.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "file"
                },
                {
                  "name": "data"
                },
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.writeSync(fd, buffer, offset, length[, position])",
          "type": "method",
          "name": "writeSync",
          "meta": {
            "added": [
              "v0.1.21"
            ]
          },
          "desc": "
Synchronous versions of fs.write(). Returns the number of bytes written.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "data"
                },
                {
                  "name": "position",
                  "optional": true
                },
                {
                  "name": "encoding",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "buffer"
                },
                {
                  "name": "offset"
                },
                {
                  "name": "length"
                },
                {
                  "name": "position",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "fs.writeSync(fd, data[, position[, encoding]])",
          "type": "method",
          "name": "writeSync",
          "meta": {
            "added": [
              "v0.11.5"
            ]
          },
          "desc": "
Synchronous versions of fs.write(). Returns the number of bytes written.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                },
                {
                  "name": "data"
                },
                {
                  "name": "position",
                  "optional": true
                },
                {
                  "name": "encoding",
                  "optional": true
                }
              ]
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "fs"
    }
  ]
}
node-v4.8.2/doc/api/fs.md000644 000766 000024 00000115614 13070706735 015240 0ustar00iojsstaff000000 000000 # File System

> Stability: 2 - Stable



File I/O is provided by simple wrappers around standard POSIX functions.  To
use this module do `require('fs')`. All the methods have asynchronous and
synchronous forms.

The asynchronous form always takes a completion callback as its last argument.
The arguments passed to the completion callback depend on the method, but the
first argument is always reserved for an exception. If the operation was
completed successfully, then the first argument will be `null` or `undefined`.

When using the synchronous form any exceptions are immediately thrown.
You can use try/catch to handle exceptions or allow them to bubble up.

Here is an example of the asynchronous version:

```js
const fs = require('fs');

fs.unlink('/tmp/hello', (err) => {
  if (err) throw err;
  console.log('successfully deleted /tmp/hello');
});
```

Here is the synchronous version:

```js
const fs = require('fs');

fs.unlinkSync('/tmp/hello');
console.log('successfully deleted /tmp/hello');
```

With the asynchronous methods there is no guaranteed ordering. So the
following is prone to error:

```js
fs.rename('/tmp/hello', '/tmp/world', (err) => {
  if (err) throw err;
  console.log('renamed complete');
});
fs.stat('/tmp/world', (err, stats) => {
  if (err) throw err;
  console.log(`stats: ${JSON.stringify(stats)}`);
});
```

It could be that `fs.stat` is executed before `fs.rename`.
The correct way to do this is to chain the callbacks.

```js
fs.rename('/tmp/hello', '/tmp/world', (err) => {
  if (err) throw err;
  fs.stat('/tmp/world', (err, stats) => {
    if (err) throw err;
    console.log(`stats: ${JSON.stringify(stats)}`);
  });
});
```

In busy processes, the programmer is _strongly encouraged_ to use the
asynchronous versions of these calls. The synchronous versions will block
the entire process until they complete--halting all connections.

The relative path to a filename can be used. Remember, however, that this path
will be relative to `process.cwd()`.

Most fs functions let you omit the callback argument. If you do, a default
callback is used that rethrows errors. To get a trace to the original call
site, set the `NODE_DEBUG` environment variable:

```
$ cat script.js
function bad() {
  require('fs').readFile('/');
}
bad();

$ env NODE_DEBUG=fs node script.js
fs.js:66
        throw err;
              ^
Error: EISDIR, read
    at rethrow (fs.js:61:21)
    at maybeCallback (fs.js:79:42)
    at Object.fs.readFile (fs.js:153:18)
    at bad (/path/to/script.js:2:17)
    at Object. (/path/to/script.js:5:1)
    
```

## Class: fs.FSWatcher


Objects returned from `fs.watch()` are of this type.

### Event: 'change'


* `event` {String} The type of fs change
* `filename` {String} The filename that changed (if relevant/available)

Emitted when something changes in a watched directory or file.
See more details in [`fs.watch()`][].

### Event: 'error'


* `error` {Error}

Emitted when an error occurs.

### watcher.close()


Stop watching for changes on the given `fs.FSWatcher`.

## Class: fs.ReadStream


`ReadStream` is a [Readable Stream][].

### Event: 'open'


* `fd` {Number} Integer file descriptor used by the ReadStream.

Emitted when the ReadStream's file is opened.

### Event: 'close'


Emitted when the `ReadStream`'s underlying file descriptor has been closed
using the `fs.close()` method.

### readStream.path


The path to the file the stream is reading from.

## Class: fs.Stats


Objects returned from [`fs.stat()`][], [`fs.lstat()`][] and [`fs.fstat()`][] and their
synchronous counterparts are of this type.

 - `stats.isFile()`
 - `stats.isDirectory()`
 - `stats.isBlockDevice()`
 - `stats.isCharacterDevice()`
 - `stats.isSymbolicLink()` (only valid with [`fs.lstat()`][])
 - `stats.isFIFO()`
 - `stats.isSocket()`

For a regular file [`util.inspect(stats)`][] would return a string very
similar to this:

```js
{
  dev: 2114,
  ino: 48064969,
  mode: 33188,
  nlink: 1,
  uid: 85,
  gid: 100,
  rdev: 0,
  size: 527,
  blksize: 4096,
  blocks: 8,
  atime: Mon, 10 Oct 2011 23:24:11 GMT,
  mtime: Mon, 10 Oct 2011 23:24:11 GMT,
  ctime: Mon, 10 Oct 2011 23:24:11 GMT,
  birthtime: Mon, 10 Oct 2011 23:24:11 GMT
}
```

Please note that `atime`, `mtime`, `birthtime`, and `ctime` are
instances of [`Date`][MDN-Date] object and to compare the values of
these objects you should use appropriate methods. For most general
uses [`getTime()`][MDN-Date-getTime] will return the number of
milliseconds elapsed since _1 January 1970 00:00:00 UTC_ and this
integer should be sufficient for any comparison, however there are
additional methods which can be used for displaying fuzzy information.
More details can be found in the [MDN JavaScript Reference][MDN-Date]
page.

### Stat Time Values

The times in the stat object have the following semantics:

* `atime` "Access Time" - Time when file data last accessed.  Changed
  by the mknod(2), utimes(2), and read(2) system calls.
* `mtime` "Modified Time" - Time when file data last modified.
  Changed by the mknod(2), utimes(2), and write(2) system calls.
* `ctime` "Change Time" - Time when file status was last changed
  (inode data modification).  Changed by the chmod(2), chown(2),
  link(2), mknod(2), rename(2), unlink(2), utimes(2),
  read(2), and write(2) system calls.
* `birthtime` "Birth Time" -  Time of file creation. Set once when the
  file is created.  On filesystems where birthtime is not available,
  this field may instead hold either the `ctime` or
  `1970-01-01T00:00Z` (ie, unix epoch timestamp `0`). Note that this
  value may be greater than `atime` or `mtime` in this case. On Darwin
  and other FreeBSD variants, also set if the `atime` is explicitly
  set to an earlier value than the current `birthtime` using the
  utimes(2) system call.

Prior to Node v0.12, the `ctime` held the `birthtime` on Windows
systems.  Note that as of v0.12, `ctime` is not "creation time", and
on Unix systems, it never was.

## Class: fs.WriteStream


`WriteStream` is a [Writable Stream][].

### Event: 'open'


* `fd` {Number} Integer file descriptor used by the WriteStream.

Emitted when the WriteStream's file is opened.

### Event: 'close'


Emitted when the `WriteStream`'s underlying file descriptor has been closed
using the `fs.close()` method.

### writeStream.bytesWritten


The number of bytes written so far. Does not include data that is still queued
for writing.

### writeStream.path


The path to the file the stream is writing to.

## fs.access(path[, mode], callback)


Tests a user's permissions for the file specified by `path`. `mode` is an
optional integer that specifies the accessibility checks to be performed. The
following constants define the possible values of `mode`. It is possible to
create a mask consisting of the bitwise OR of two or more values.

- `fs.F_OK` - File is visible to the calling process. This is useful for
determining if a file exists, but says nothing about `rwx` permissions.
Default if no `mode` is specified.
- `fs.R_OK` - File can be read by the calling process.
- `fs.W_OK` - File can be written by the calling process.
- `fs.X_OK` - File can be executed by the calling process. This has no effect
on Windows (will behave like `fs.F_OK`).

The final argument, `callback`, is a callback function that is invoked with
a possible error argument. If any of the accessibility checks fail, the error
argument will be populated. The following example checks if the file
`/etc/passwd` can be read and written by the current process.

```js
fs.access('/etc/passwd', fs.R_OK | fs.W_OK, (err) => {
  console.log(err ? 'no access!' : 'can read/write');
});
```

Using `fs.access()` to check for the accessibility of a file before calling
`fs.open()`, `fs.readFile()` or `fs.writeFile()` is not recommended. Doing
so introduces a race condition, since other processes may change the file's
state between the two calls. Instead, user code should open/read/write the
file directly and handle the error raised if the file is not accessible.

For example:


**write (NOT RECOMMENDED)**

```js
fs.access('myfile', (err) => {
  if (!err) {
    console.error('myfile already exists');
    return;
  }

  fs.open('myfile', 'wx', (err, fd) => {
    if (err) throw err;
    writeMyData(fd);
  });
});
```

**write (RECOMMENDED)**

```js
fs.open('myfile', 'wx', (err, fd) => {
  if (err) {
    if (err.code === "EEXIST") {
      console.error('myfile already exists');
      return;
    } else {
      throw err;
    }
  }

  writeMyData(fd);
});
```

**read (NOT RECOMMENDED)**

```js
fs.access('myfile', (err) => {
  if (err) {
    if (err.code === "ENOENT") {
      console.error('myfile does not exist');
      return;
    } else {
      throw err;
    }
  }

  fs.open('myfile', 'r', (err, fd) => {
    if (err) throw err;
    readMyData(fd);
  });
});
```

**read (RECOMMENDED)**

```js
fs.open('myfile', 'r', (err, fd) => {
  if (err) {
    if (err.code === "ENOENT") {
      console.error('myfile does not exist');
      return;
    } else {
      throw err;
    }
  }

  readMyData(fd);
});
```

The "not recommended" examples above check for accessibility and then use the
file; the "recommended" examples are better because they use the file directly
and handle the error, if any.

In general, check for the accessibility of a file only if the file won’t be
used directly, for example when its accessibility is a signal from another
process.

## fs.accessSync(path[, mode])


Synchronous version of [`fs.access()`][]. This throws if any accessibility checks
fail, and does nothing otherwise.

## fs.appendFile(file, data[, options], callback)


* `file` {String} filename
* `data` {String|Buffer}
* `options` {Object|String}
  * `encoding` {String|Null} default = `'utf8'`
  * `mode` {Number} default = `0o666`
  * `flag` {String} default = `'a'`
* `callback` {Function}

Asynchronously append data to a file, creating the file if it does not yet exist.
`data` can be a string or a buffer.

Example:

```js
fs.appendFile('message.txt', 'data to append', (err) => {
  if (err) throw err;
  console.log('The "data to append" was appended to file!');
});
```

If `options` is a string, then it specifies the encoding. Example:

```js
fs.appendFile('message.txt', 'data to append', 'utf8', callback);
```

## fs.appendFileSync(file, data[, options])


The synchronous version of [`fs.appendFile()`][]. Returns `undefined`.

## fs.chmod(path, mode, callback)


Asynchronous chmod(2). No arguments other than a possible exception are given
to the completion callback.

## fs.chmodSync(path, mode)


Synchronous chmod(2). Returns `undefined`.

## fs.chown(path, uid, gid, callback)


Asynchronous chown(2). No arguments other than a possible exception are given
to the completion callback.

## fs.chownSync(path, uid, gid)


Synchronous chown(2). Returns `undefined`.

## fs.close(fd, callback)


Asynchronous close(2).  No arguments other than a possible exception are given
to the completion callback.

## fs.closeSync(fd)


Synchronous close(2). Returns `undefined`.

## fs.createReadStream(path[, options])


Returns a new [`ReadStream`][] object. (See [Readable Stream][]).

Be aware that, unlike the default value set for `highWaterMark` on a
readable stream (16 kb), the stream returned by this method has a
default value of 64 kb for the same parameter.

`options` is an object or string with the following defaults:

```js
{
  flags: 'r',
  encoding: null,
  fd: null,
  mode: 0o666,
  autoClose: true
}
```

`options` can include `start` and `end` values to read a range of bytes from
the file instead of the entire file.  Both `start` and `end` are inclusive and
start counting at 0. If `fd` is specified and `start` is omitted or `undefined`,
`fs.createReadStream()` reads sequentially from the current file position.
The `encoding` can be any one of those accepted by [`Buffer`][].

If `fd` is specified, `ReadStream` will ignore the `path` argument and will use
the specified file descriptor. This means that no `'open'` event will be emitted.
Note that `fd` should be blocking; non-blocking `fd`s should be passed to
[`net.Socket`][].

If `autoClose` is false, then the file descriptor won't be closed, even if
there's an error.  It is your responsibility to close it and make sure
there's no file descriptor leak.  If `autoClose` is set to true (default
behavior), on `error` or `end` the file descriptor will be closed
automatically.

`mode` sets the file mode (permission and sticky bits), but only if the
file was created.

An example to read the last 10 bytes of a file which is 100 bytes long:

```js
fs.createReadStream('sample.txt', {start: 90, end: 99});
```

If `options` is a string, then it specifies the encoding.

## fs.createWriteStream(path[, options])


Returns a new [`WriteStream`][] object. (See [Writable Stream][]).

`options` is an object or string with the following defaults:

```js
{
  flags: 'w',
  defaultEncoding: 'utf8',
  fd: null,
  mode: 0o666
}
```

`options` may also include a `start` option to allow writing data at
some position past the beginning of the file.  Modifying a file rather
than replacing it may require a `flags` mode of `r+` rather than the
default mode `w`. The `defaultEncoding` can be any one of those accepted by [`Buffer`][].

Like [`ReadStream`][], if `fd` is specified, `WriteStream` will ignore the
`path` argument and will use the specified file descriptor. This means that no
`'open'` event will be emitted. Note that `fd` should be blocking; non-blocking
`fd`s should be passed to [`net.Socket`][].

If `options` is a string, then it specifies the encoding.

## fs.exists(path, callback)


> Stability: 0 - Deprecated: Use [`fs.stat()`][] or [`fs.access()`][] instead.

Test whether or not the given path exists by checking with the file system.
Then call the `callback` argument with either true or false.  Example:

```js
fs.exists('/etc/passwd', (exists) => {
  console.log(exists ? 'it\'s there' : 'no passwd!');
});
```

Using `fs.exists()` to check for the existence of a file before calling
`fs.open()`, `fs.readFile()` or `fs.writeFile()` is not recommended. Doing
so introduces a race condition, since other processes may change the file's
state between the two calls. Instead, user code should open/read/write the
file directly and handle the error raised if the file does not exist.

For example:

**write (NOT RECOMMENDED)**

```js
fs.exists('myfile', (exists) => {
  if (exists) {
    console.error('myfile already exists');
  } else {
    fs.open('myfile', 'wx', (err, fd) => {
      if (err) throw err;
      writeMyData(fd);
    });
  }
});
```

**write (RECOMMENDED)**

```js
fs.open('myfile', 'wx', (err, fd) => {
  if (err) {
    if (err.code === "EEXIST") {
      console.error('myfile already exists');
      return;
    } else {
      throw err;
    }
  }
  writeMyData(fd);
});
```

**read (NOT RECOMMENDED)**

```js
fs.exists('myfile', (exists) => {
  if (exists) {
    fs.open('myfile', 'r', (err, fd) => {
      readMyData(fd);
    });
  } else {
    console.error('myfile does not exist');
  }
});
```

**read (RECOMMENDED)**

```js
fs.open('myfile', 'r', (err, fd) => {
  if (err) {
    if (err.code === "ENOENT") {
      console.error('myfile does not exist');
      return;
    } else {
      throw err;
    }
  } else {
    readMyData(fd);
  }
});
```

The "not recommended" examples above check for existence and then use the
file; the "recommended" examples are better because they use the file directly
and handle the error, if any.

In general, check for the existence of a file only if the file won’t be
used directly, for example when its existence is a signal from another
process.

## fs.existsSync(path)


> Stability: 0 - Deprecated: Use [`fs.statSync()`][] or [`fs.accessSync()`][]
> instead.

Synchronous version of [`fs.exists()`][].
Returns `true` if the file exists, `false` otherwise.

## fs.fchmod(fd, mode, callback)


Asynchronous fchmod(2). No arguments other than a possible exception
are given to the completion callback.

## fs.fchmodSync(fd, mode)


Synchronous fchmod(2). Returns `undefined`.

## fs.fchown(fd, uid, gid, callback)


Asynchronous fchown(2). No arguments other than a possible exception are given
to the completion callback.

## fs.fchownSync(fd, uid, gid)


Synchronous fchown(2). Returns `undefined`.

## fs.fdatasync(fd, callback)


Asynchronous fdatasync(2). No arguments other than a possible exception are
given to the completion callback.

## fs.fdatasyncSync(fd)


Synchronous fdatasync(2). Returns `undefined`.

## fs.fstat(fd, callback)


Asynchronous fstat(2). The callback gets two arguments `(err, stats)` where
`stats` is a [`fs.Stats`][] object. `fstat()` is identical to [`stat()`][],
except that the file to be stat-ed is specified by the file descriptor `fd`.

## fs.fstatSync(fd)


Synchronous fstat(2). Returns an instance of `fs.Stats`.

## fs.fsync(fd, callback)


Asynchronous fsync(2). No arguments other than a possible exception are given
to the completion callback.

## fs.fsyncSync(fd)


Synchronous fsync(2). Returns `undefined`.

## fs.ftruncate(fd, len, callback)


Asynchronous ftruncate(2). No arguments other than a possible exception are
given to the completion callback.

## fs.ftruncateSync(fd, len)


Synchronous ftruncate(2). Returns `undefined`.

## fs.futimes(fd, atime, mtime, callback)


Change the file timestamps of a file referenced by the supplied file
descriptor.

## fs.futimesSync(fd, atime, mtime)


Synchronous version of [`fs.futimes()`][]. Returns `undefined`.

## fs.lchmod(path, mode, callback)


Asynchronous lchmod(2). No arguments other than a possible exception
are given to the completion callback.

Only available on Mac OS X.

## fs.lchmodSync(path, mode)


Synchronous lchmod(2). Returns `undefined`.

## fs.lchown(path, uid, gid, callback)


Asynchronous lchown(2). No arguments other than a possible exception are given
to the completion callback.

## fs.lchownSync(path, uid, gid)


Synchronous lchown(2). Returns `undefined`.

## fs.link(srcpath, dstpath, callback)


Asynchronous link(2). No arguments other than a possible exception are given to
the completion callback.

## fs.linkSync(srcpath, dstpath)


Synchronous link(2). Returns `undefined`.

## fs.lstat(path, callback)


Asynchronous lstat(2). The callback gets two arguments `(err, stats)` where
`stats` is a [`fs.Stats`][] object. `lstat()` is identical to `stat()`,
except that if `path` is a symbolic link, then the link itself is stat-ed,
not the file that it refers to.

## fs.lstatSync(path)


Synchronous lstat(2). Returns an instance of `fs.Stats`.

## fs.mkdir(path[, mode], callback)


Asynchronous mkdir(2). No arguments other than a possible exception are given
to the completion callback. `mode` defaults to `0o777`.

## fs.mkdirSync(path[, mode])


Synchronous mkdir(2). Returns `undefined`.

## fs.mkdtemp(prefix, callback)

Creates a unique temporary directory.

Generates six random characters to be appended behind a required
`prefix` to create a unique temporary directory.

The created folder path is passed as a string to the callback's second
parameter.

Example:

```js
fs.mkdtemp('/tmp/foo-', (err, folder) => {
  console.log(folder);
    // Prints: /tmp/foo-itXde2
});
```

## fs.mkdtempSync(template)

The synchronous version of [`fs.mkdtemp()`][]. Returns the created
folder path.

## fs.open(path, flags[, mode], callback)


Asynchronous file open. See open(2). `flags` can be:

* `'r'` - Open file for reading.
An exception occurs if the file does not exist.

* `'r+'` - Open file for reading and writing.
An exception occurs if the file does not exist.

* `'rs'` - Open file for reading in synchronous mode. Instructs the operating
  system to bypass the local file system cache.

  This is primarily useful for opening files on NFS mounts as it allows you to
  skip the potentially stale local cache. It has a very real impact on I/O
  performance so don't use this flag unless you need it.

  Note that this doesn't turn `fs.open()` into a synchronous blocking call.
  If that's what you want then you should be using `fs.openSync()`

* `'rs+'` - Open file for reading and writing, telling the OS to open it
  synchronously. See notes for `'rs'` about using this with caution.

* `'w'` - Open file for writing.
The file is created (if it does not exist) or truncated (if it exists).

* `'wx'` - Like `'w'` but fails if `path` exists.

* `'w+'` - Open file for reading and writing.
The file is created (if it does not exist) or truncated (if it exists).

* `'wx+'` - Like `'w+'` but fails if `path` exists.

* `'a'` - Open file for appending.
The file is created if it does not exist.

* `'ax'` - Like `'a'` but fails if `path` exists.

* `'a+'` - Open file for reading and appending.
The file is created if it does not exist.

* `'ax+'` - Like `'a+'` but fails if `path` exists.

`mode` sets the file mode (permission and sticky bits), but only if the file was
created. It defaults to `0666`, readable and writable.

The callback gets two arguments `(err, fd)`.

The exclusive flag `'x'` (`O_EXCL` flag in open(2)) ensures that `path` is newly
created. On POSIX systems, `path` is considered to exist even if it is a symlink
to a non-existent file. The exclusive flag may or may not work with network file
systems.

`flags` can also be a number as documented by open(2); commonly used constants
are available from `require('constants')`.  On Windows, flags are translated to
their equivalent ones where applicable, e.g. `O_WRONLY` to `FILE_GENERIC_WRITE`,
or `O_EXCL|O_CREAT` to `CREATE_NEW`, as accepted by CreateFileW.

On Linux, positional writes don't work when the file is opened in append mode.
The kernel ignores the position argument and always appends the data to
the end of the file.

## fs.openSync(path, flags[, mode])


Synchronous version of [`fs.open()`][]. Returns an integer representing the file
descriptor.

## fs.read(fd, buffer, offset, length, position, callback)


Read data from the file specified by `fd`.

`buffer` is the buffer that the data will be written to.

`offset` is the offset in the buffer to start writing at.

`length` is an integer specifying the number of bytes to read.

`position` is an integer specifying where to begin reading from in the file.
If `position` is `null`, data will be read from the current file position.

The callback is given the three arguments, `(err, bytesRead, buffer)`.

## fs.readdir(path, callback)


Asynchronous readdir(3).  Reads the contents of a directory.
The callback gets two arguments `(err, files)` where `files` is an array of
the names of the files in the directory excluding `'.'` and `'..'`.

## fs.readdirSync(path)


Synchronous readdir(3). Returns an array of filenames excluding `'.'` and
`'..'`.

## fs.readFile(file[, options], callback)


* `file` {String} filename
* `options` {Object | String}
  * `encoding` {String | Null} default = `null`
  * `flag` {String} default = `'r'`
* `callback` {Function}

Asynchronously reads the entire contents of a file. Example:

```js
fs.readFile('/etc/passwd', (err, data) => {
  if (err) throw err;
  console.log(data);
});
```

The callback is passed two arguments `(err, data)`, where `data` is the
contents of the file.

If no encoding is specified, then the raw buffer is returned.

If `options` is a string, then it specifies the encoding. Example:

```js
fs.readFile('/etc/passwd', 'utf8', callback);
```

## fs.readFileSync(file[, options])


Synchronous version of [`fs.readFile`][]. Returns the contents of the `file`.

If the `encoding` option is specified then this function returns a
string. Otherwise it returns a buffer.

## fs.readlink(path, callback)


Asynchronous readlink(2). The callback gets two arguments `(err,
linkString)`.

## fs.readlinkSync(path)


Synchronous readlink(2). Returns the symbolic link's string value.

## fs.realpath(path[, cache], callback)


Asynchronous realpath(2). The `callback` gets two arguments `(err,
resolvedPath)`. May use `process.cwd` to resolve relative paths. `cache` is an
object literal of mapped paths that can be used to force a specific path
resolution or avoid additional `fs.stat` calls for known real paths.

Example:

```js
var cache = {'/etc':'/private/etc'};
fs.realpath('/etc/passwd', cache, (err, resolvedPath) => {
  if (err) throw err;
  console.log(resolvedPath);
});
```

## fs.readSync(fd, buffer, offset, length, position)


Synchronous version of [`fs.read()`][]. Returns the number of `bytesRead`.

## fs.realpathSync(path[, cache])


Synchronous realpath(2). Returns the resolved path. `cache` is an
object literal of mapped paths that can be used to force a specific path
resolution or avoid additional `fs.stat` calls for known real paths.

## fs.rename(oldPath, newPath, callback)


Asynchronous rename(2). No arguments other than a possible exception are given
to the completion callback.

## fs.renameSync(oldPath, newPath)


Synchronous rename(2). Returns `undefined`.

## fs.rmdir(path, callback)


Asynchronous rmdir(2). No arguments other than a possible exception are given
to the completion callback.

## fs.rmdirSync(path)


Synchronous rmdir(2). Returns `undefined`.

## fs.stat(path, callback)


Asynchronous stat(2). The callback gets two arguments `(err, stats)` where
`stats` is a [`fs.Stats`][] object.  See the [`fs.Stats`][] section for more
information.

## fs.statSync(path)


Synchronous stat(2). Returns an instance of [`fs.Stats`][].

## fs.symlink(target, path[, type], callback)


Asynchronous symlink(2). No arguments other than a possible exception are given
to the completion callback.
The `type` argument can be set to `'dir'`, `'file'`, or `'junction'` (default
is `'file'`) and is only available on Windows (ignored on other platforms).
Note that Windows junction points require the destination path to be absolute.  When using
`'junction'`, the `target` argument will automatically be normalized to absolute path.

Here is an example below:

```js
fs.symlink('./foo', './new-port');
```

It creates a symbolic link named "new-port" that points to "foo".

## fs.symlinkSync(target, path[, type])


Synchronous symlink(2). Returns `undefined`.

## fs.truncate(path, len, callback)


Asynchronous truncate(2). No arguments other than a possible exception are
given to the completion callback. A file descriptor can also be passed as the
first argument. In this case, `fs.ftruncate()` is called.

## fs.truncateSync(path, len)


Synchronous truncate(2). Returns `undefined`.

## fs.unlink(path, callback)


Asynchronous unlink(2). No arguments other than a possible exception are given
to the completion callback.

## fs.unlinkSync(path)


Synchronous unlink(2). Returns `undefined`.

## fs.unwatchFile(filename[, listener])


Stop watching for changes on `filename`. If `listener` is specified, only that
particular listener is removed. Otherwise, *all* listeners are removed and you
have effectively stopped watching `filename`.

Calling `fs.unwatchFile()` with a filename that is not being watched is a
no-op, not an error.

_Note: [`fs.watch()`][] is more efficient than `fs.watchFile()` and `fs.unwatchFile()`.
`fs.watch()` should be used instead of `fs.watchFile()` and `fs.unwatchFile()`
when possible._

## fs.utimes(path, atime, mtime, callback)


Change file timestamps of the file referenced by the supplied path.

Note: the arguments `atime` and `mtime` of the following related functions does
follow the below rules:

- If the value is a numberable string like `'123456789'`, the value would get
  converted to corresponding number.
- If the value is `NaN` or `Infinity`, the value would get converted to
  `Date.now()`.

## fs.utimesSync(path, atime, mtime)


Synchronous version of [`fs.utimes()`][]. Returns `undefined`.

## fs.watch(filename[, options][, listener])


Watch for changes on `filename`, where `filename` is either a file or a
directory.  The returned object is a [`fs.FSWatcher`][].

The second argument is optional. The `options` if provided should be an object.
The supported boolean members are `persistent` and `recursive`. `persistent`
indicates whether the process should continue to run as long as files are being
watched. `recursive` indicates whether all subdirectories should be watched, or
only the current directory. This applies when a directory is specified, and only
on supported platforms (See [Caveats][]).

The default is `{ persistent: true, recursive: false }`.

The listener callback gets two arguments `(event, filename)`.  `event` is either
`'rename'` or `'change'`, and `filename` is the name of the file which triggered
the event.

### Caveats



The `fs.watch` API is not 100% consistent across platforms, and is
unavailable in some situations.

The recursive option is only supported on OS X and Windows.

#### Availability



This feature depends on the underlying operating system providing a way
to be notified of filesystem changes.

* On Linux systems, this uses `inotify`.
* On BSD systems, this uses `kqueue`.
* On OS X, this uses `kqueue` for files and 'FSEvents' for directories.
* On SunOS systems (including Solaris and SmartOS), this uses `event ports`.
* On Windows systems, this feature depends on `ReadDirectoryChangesW`.
* On Aix systems, this feature depends on `AHAFS`, which must be enabled.

If the underlying functionality is not available for some reason, then
`fs.watch` will not be able to function. For example, watching files or
directories can be unreliable, and in some cases impossible, on network file
systems (NFS, SMB, etc), or host file systems when using virtualization software
such as Vagrant, Docker, etc.

You can still use `fs.watchFile`, which uses stat polling, but it is slower and
less reliable.

#### Inodes



On Linux and OS X systems, `fs.watch()` resolves the path to an [inode][] and
watches the inode. If the watched path is deleted and recreated, it is assigned
a new inode. The watch will emit an event for the delete but will continue
watching the *original* inode. Events for the new inode will not be emitted.
This is expected behavior.

#### Filename Argument



Providing `filename` argument in the callback is only supported on Linux and
Windows.  Even on supported platforms, `filename` is not always guaranteed to
be provided. Therefore, don't assume that `filename` argument is always
provided in the callback, and have some fallback logic if it is null.

```js
fs.watch('somedir', (event, filename) => {
  console.log(`event is: ${event}`);
  if (filename) {
    console.log(`filename provided: ${filename}`);
  } else {
    console.log('filename not provided');
  }
});
```

## fs.watchFile(filename[, options], listener)


Watch for changes on `filename`. The callback `listener` will be called each
time the file is accessed.

The `options` argument may be omitted. If provided, it should be an object. The
`options` object may contain a boolean named `persistent` that indicates
whether the process should continue to run as long as files are being watched.
The `options` object may specify an `interval` property indicating how often the
target should be polled in milliseconds. The default is
`{ persistent: true, interval: 5007 }`.

The `listener` gets two arguments the current stat object and the previous
stat object:

```js
fs.watchFile('message.text', (curr, prev) => {
  console.log(`the current mtime is: ${curr.mtime}`);
  console.log(`the previous mtime was: ${prev.mtime}`);
});
```

These stat objects are instances of `fs.Stat`.

If you want to be notified when the file was modified, not just accessed,
you need to compare `curr.mtime` and `prev.mtime`.

_Note: when an `fs.watchFile` operation results in an `ENOENT` error, it will
 invoke the listener once, with all the fields zeroed (or, for dates, the Unix
 Epoch). In Windows, `blksize` and `blocks` fields will be `undefined`, instead
 of zero. If the file is created later on, the listener will be called again,
 with the latest stat objects. This is a change in functionality since v0.10._

_Note: [`fs.watch()`][] is more efficient than `fs.watchFile` and `fs.unwatchFile`.
`fs.watch` should be used instead of `fs.watchFile` and `fs.unwatchFile`
when possible._

## fs.write(fd, buffer, offset, length[, position], callback)


Write `buffer` to the file specified by `fd`.

`offset` determines the part of the buffer to be written, and `length` is
an integer specifying the number of bytes to write.

`position` refers to the offset from the beginning of the file where this data
should be written. If `typeof position !== 'number'`, the data will be written
at the current position. See pwrite(2).

The callback will be given three arguments `(err, written, buffer)` where
`written` specifies how many _bytes_ were written from `buffer`.

Note that it is unsafe to use `fs.write` multiple times on the same file
without waiting for the callback. For this scenario,
`fs.createWriteStream` is strongly recommended.

On Linux, positional writes don't work when the file is opened in append mode.
The kernel ignores the position argument and always appends the data to
the end of the file.

## fs.write(fd, data[, position[, encoding]], callback)


Write `data` to the file specified by `fd`.  If `data` is not a Buffer instance
then the value will be coerced to a string.

`position` refers to the offset from the beginning of the file where this data
should be written. If `typeof position !== 'number'` the data will be written at
the current position. See pwrite(2).

`encoding` is the expected string encoding.

The callback will receive the arguments `(err, written, string)` where `written`
specifies how many _bytes_ the passed string required to be written. Note that
bytes written is not the same as string characters. See [`Buffer.byteLength`][].

Unlike when writing `buffer`, the entire string must be written. No substring
may be specified. This is because the byte offset of the resulting data may not
be the same as the string offset.

Note that it is unsafe to use `fs.write` multiple times on the same file
without waiting for the callback. For this scenario,
`fs.createWriteStream` is strongly recommended.

On Linux, positional writes don't work when the file is opened in append mode.
The kernel ignores the position argument and always appends the data to
the end of the file.

## fs.writeFile(file, data[, options], callback)


* `file` {String} filename
* `data` {String | Buffer}
* `options` {Object | String}
  * `encoding` {String | Null} default = `'utf8'`
  * `mode` {Number} default = `0o666`
  * `flag` {String} default = `'w'`
* `callback` {Function}

Asynchronously writes data to a file, replacing the file if it already exists.
`data` can be a string or a buffer.

The `encoding` option is ignored if `data` is a buffer. It defaults
to `'utf8'`.

Example:

```js
fs.writeFile('message.txt', 'Hello Node.js', (err) => {
  if (err) throw err;
  console.log('It\'s saved!');
});
```

If `options` is a string, then it specifies the encoding. Example:

```js
fs.writeFile('message.txt', 'Hello Node.js', 'utf8', callback);
```

Note that it is unsafe to use `fs.writeFile` multiple times on the same file
without waiting for the callback. For this scenario,
`fs.createWriteStream` is strongly recommended.

## fs.writeFileSync(file, data[, options])


The synchronous version of [`fs.writeFile()`][]. Returns `undefined`.

## fs.writeSync(fd, buffer, offset, length[, position])


## fs.writeSync(fd, data[, position[, encoding]])


Synchronous versions of [`fs.write()`][]. Returns the number of bytes written.

[`Buffer.byteLength`]: buffer.html#buffer_class_method_buffer_bytelength_string_encoding
[`Buffer`]: buffer.html#buffer_buffer
[Caveats]: #fs_caveats
[`fs.access()`]: #fs_fs_access_path_mode_callback
[`fs.accessSync()`]: #fs_fs_accesssync_path_mode
[`fs.appendFile()`]: fs.html#fs_fs_appendfile_file_data_options_callback
[`fs.exists()`]: fs.html#fs_fs_exists_path_callback
[`fs.fstat()`]: #fs_fs_fstat_fd_callback
[`fs.FSWatcher`]: #fs_class_fs_fswatcher
[`fs.futimes()`]: #fs_fs_futimes_fd_atime_mtime_callback
[`fs.lstat()`]: #fs_fs_lstat_path_callback
[`fs.open()`]: #fs_fs_open_path_flags_mode_callback
[`fs.read()`]: #fs_fs_read_fd_buffer_offset_length_position_callback
[`fs.readFile`]: #fs_fs_readfile_file_options_callback
[`fs.stat()`]: #fs_fs_stat_path_callback
[`fs.Stats`]: #fs_class_fs_stats
[`fs.statSync()`]: #fs_fs_statsync_path
[`fs.utimes()`]: #fs_fs_futimes_fd_atime_mtime_callback
[`fs.watch()`]: #fs_fs_watch_filename_options_listener
[`fs.write()`]: #fs_fs_write_fd_buffer_offset_length_position_callback
[`fs.writeFile()`]: #fs_fs_writefile_file_data_options_callback
[`net.Socket`]: net.html#net_class_net_socket
[`ReadStream`]: #fs_class_fs_readstream
[`stat()`]: fs.html#fs_fs_stat_path_callback
[`util.inspect(stats)`]: util.html#util_util_inspect_object_options
[`WriteStream`]: #fs_class_fs_writestream
[MDN-Date-getTime]: https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Date/getTime
[MDN-Date]: https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Date
[Readable Stream]: stream.html#stream_class_stream_readable
[Writable Stream]: stream.html#stream_class_stream_writable
[inode]: http://www.linux.org/threads/intro-to-inodes.4130
node-v4.8.2/doc/api/globals.html000644 000766 000024 00000042274 13070706740 016614 0ustar00iojsstaff000000 000000 


  
  Global Objects | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

      

        
Global Objects#



These objects are available in all modules. Some of these objects aren't
actually in the global scope but in the module scope - this will be noted.


The objects listed here are specific to Node.js. There are a number of
built-in objects that are part of the JavaScript language itself, which are
also globally accessible.


Class: Buffer#



Added in: v0.1.103




Used to handle binary data. See the buffer section.


__dirname#



Added in: v0.1.27




The directory name of the current module. This the same as the
path.dirname() of the __filename.


__dirname isn't actually a global but rather local to each module.


Example: running node example.js from /Users/mjr


console.log(__dirname);
// Prints: /Users/mjr
console.log(path.dirname(__filename));
// Prints: /Users/mjr



__filename#



Added in: v0.0.1




The file name of the current module. This is the resolved absolute path of the
current module file.


For a main program this is not necessarily the same as the file name used in the
command line.


See __dirname for the directory name of the current module.


__filename isn't actually a global but rather local to each module.


Examples:


Running node example.js from /Users/mjr


console.log(__filename);
// Prints: /Users/mjr/example.js
console.log(__dirname);
// Prints: /Users/mjr



Given two modules: a and b, where b is a dependency of
a and there is a directory structure of:


    

  • /Users/mjr/app/a.js
    • 

  • /Users/mjr/app/node_modules/b/b.js
    • 



References to __filename within b.js will return
/Users/mjr/app/node_modules/b/b.js while references to __filename within
a.js will return /Users/mjr/app/a.js.


clearImmediate(immediateObject)#



Added in: v0.9.1



clearImmediate is described in the timers section.


clearInterval(intervalObject)#



Added in: v0.0.1



clearInterval is described in the timers section.


clearTimeout(timeoutObject)#



Added in: v0.0.1



clearTimeout is described in the timers section.


console#



Added in: v0.1.100




Used to print to stdout and stderr. See the console section.


exports#



Added in: v0.1.12



A reference to the module.exports that is shorter to type.
See module system documentation for details on when to use exports and
when to use module.exports.


exports isn't actually a global but rather local to each module.


See the module system documentation for more information.


global#



Added in: v0.1.27




In browsers, the top-level scope is the global scope. That means that in
browsers if you're in the global scope var something will define a global
variable. In Node.js this is different. The top-level scope is not the global
scope; var something inside an Node.js module will be local to that module.


module#



Added in: v0.1.16




A reference to the current module. In particular
module.exports is used for defining what a module exports and makes
available through require().


module isn't actually a global but rather local to each module.


See the module system documentation for more information.


process#



Added in: v0.1.7




The process object. See the process object section.


require()#



Added in: v0.1.13




To require modules. See the Modules section.  require isn't actually a
global but rather local to each module.


require.cache#



Added in: v0.3.0



Modules are cached in this object when they are required. By deleting a key
value from this object, the next require will reload the module. Note that
this does not apply to native addons, for which reloading will result in an
Error.


require.extensions#



Added in: v0.3.0
Deprecated since: v0.10.6 

Stability: 0 - Deprecated


Instruct require on how to handle certain file extensions.


Process files with the extension .sjs as .js:


require.extensions['.sjs'] = require.extensions['.js'];



Deprecated  In the past, this list has been used to load
non-JavaScript modules into Node.js by compiling them on-demand.
However, in practice, there are much better ways to do this, such as
loading modules via some other Node.js program, or compiling them to
JavaScript ahead of time.


Since the Module system is locked, this feature will probably never go
away.  However, it may have subtle bugs and complexities that are best
left untouched.


require.resolve()#



Added in: v0.3.0

Use the internal require() machinery to look up the location of a module,
but rather than loading the module, just return the resolved filename.


setImmediate(callback[, arg][, ...])#



Added in: v0.9.1



setImmediate is described in the timers section.


setInterval(callback, delay[, arg][, ...])#



Added in: v0.0.1



setInterval is described in the timers section.


setTimeout(callback, delay[, arg][, ...])#



Added in: v0.0.1



setTimeout is described in the timers section.


      

    

  

  
  
  
  



node-v4.8.2/doc/api/globals.json000644 000766 000024 00000051044 13070706740 016614 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/globals.md",
  "globals": [
    {
      "textRaw": "Class: Buffer",
      "type": "global",
      "name": "Buffer",
      "meta": {
        "added": [
          "v0.1.103"
        ]
      },
      "desc": "
    \n
  • {Function}
    • \n
\n
Used to handle binary data. See the buffer section.
\n"
    },
    {
      "textRaw": "clearImmediate(immediateObject)",
      "type": "global",
      "name": "clearImmediate",
      "meta": {
        "added": [
          "v0.9.1"
        ]
      },
      "desc": "
clearImmediate is described in the timers section.
\n"
    },
    {
      "textRaw": "clearInterval(intervalObject)",
      "type": "global",
      "name": "clearInterval",
      "meta": {
        "added": [
          "v0.0.1"
        ]
      },
      "desc": "
clearInterval is described in the timers section.
\n"
    },
    {
      "textRaw": "clearTimeout(timeoutObject)",
      "type": "global",
      "name": "clearTimeout",
      "meta": {
        "added": [
          "v0.0.1"
        ]
      },
      "desc": "
clearTimeout is described in the timers section.
\n"
    },
    {
      "textRaw": "console",
      "name": "console",
      "meta": {
        "added": [
          "v0.1.100"
        ]
      },
      "type": "global",
      "desc": "
    \n
  • {Object}
    • \n
\n
Used to print to stdout and stderr. See the console section.
\n"
    },
    {
      "textRaw": "global",
      "name": "global",
      "meta": {
        "added": [
          "v0.1.27"
        ]
      },
      "type": "global",
      "desc": "
    \n
  • {Object} The global namespace object.
    • \n
\n
In browsers, the top-level scope is the global scope. That means that in\nbrowsers if you're in the global scope var something will define a global\nvariable. In Node.js this is different. The top-level scope is not the global\nscope; var something inside an Node.js module will be local to that module.
\n"
    },
    {
      "textRaw": "process",
      "name": "process",
      "meta": {
        "added": [
          "v0.1.7"
        ]
      },
      "type": "global",
      "desc": "
    \n
  • {Object}
    • \n
\n
The process object. See the process object section.
\n"
    },
    {
      "textRaw": "setImmediate(callback[, arg][, ...])",
      "type": "global",
      "name": "setImmediate",
      "meta": {
        "added": [
          "v0.9.1"
        ]
      },
      "desc": "
setImmediate is described in the timers section.
\n"
    },
    {
      "textRaw": "setInterval(callback, delay[, arg][, ...])",
      "type": "global",
      "name": "setInterval",
      "meta": {
        "added": [
          "v0.0.1"
        ]
      },
      "desc": "
setInterval is described in the timers section.
\n"
    },
    {
      "textRaw": "setTimeout(callback, delay[, arg][, ...])",
      "type": "global",
      "name": "setTimeout",
      "meta": {
        "added": [
          "v0.0.1"
        ]
      },
      "desc": "
setTimeout is described in the timers section.
\n"
    }
  ],
  "vars": [
    {
      "textRaw": "\\_\\_dirname",
      "name": "\\_\\_dirname",
      "meta": {
        "added": [
          "v0.1.27"
        ]
      },
      "type": "var",
      "desc": "
    \n
  • {String}
    • \n
\n
The directory name of the current module. This the same as the\npath.dirname() of the __filename.
\n
__dirname isn't actually a global but rather local to each module.
\n
Example: running node example.js from /Users/mjr
\n
console.log(__dirname);\n// Prints: /Users/mjr\nconsole.log(path.dirname(__filename));\n// Prints: /Users/mjr\n
\n"
    },
    {
      "textRaw": "\\_\\_filename",
      "name": "\\_\\_filename",
      "meta": {
        "added": [
          "v0.0.1"
        ]
      },
      "type": "var",
      "desc": "
    \n
  • {String}
    • \n
\n
The file name of the current module. This is the resolved absolute path of the\ncurrent module file.
\n
For a main program this is not necessarily the same as the file name used in the\ncommand line.
\n
See __dirname for the directory name of the current module.
\n
__filename isn't actually a global but rather local to each module.
\n
Examples:
\n
Running node example.js from /Users/mjr
\n
console.log(__filename);\n// Prints: /Users/mjr/example.js\nconsole.log(__dirname);\n// Prints: /Users/mjr\n
\n
Given two modules: a and b, where b is a dependency of\na and there is a directory structure of:
\n
    \n
  • /Users/mjr/app/a.js
    • \n
  • /Users/mjr/app/node_modules/b/b.js
    • \n
\n
References to __filename within b.js will return\n/Users/mjr/app/node_modules/b/b.js while references to __filename within\na.js will return /Users/mjr/app/a.js.
\n"
    },
    {
      "textRaw": "exports",
      "name": "exports",
      "meta": {
        "added": [
          "v0.1.12"
        ]
      },
      "type": "var",
      "desc": "
A reference to the module.exports that is shorter to type.\nSee module system documentation for details on when to use exports and\nwhen to use module.exports.
\n
exports isn't actually a global but rather local to each module.
\n
See the module system documentation for more information.
\n"
    },
    {
      "textRaw": "module",
      "name": "module",
      "meta": {
        "added": [
          "v0.1.16"
        ]
      },
      "type": "var",
      "desc": "
    \n
  • {Object}
    • \n
\n
A reference to the current module. In particular\nmodule.exports is used for defining what a module exports and makes\navailable through require().
\n
module isn't actually a global but rather local to each module.
\n
See the module system documentation for more information.
\n"
    },
    {
      "textRaw": "require()",
      "type": "var",
      "name": "require",
      "meta": {
        "added": [
          "v0.1.13"
        ]
      },
      "desc": "
    \n
  • {Function}
    • \n
\n
To require modules. See the Modules section.  require isn't actually a\nglobal but rather local to each module.
\n",
      "properties": [
        {
          "textRaw": "`cache` {Object} ",
          "type": "Object",
          "name": "cache",
          "meta": {
            "added": [
              "v0.3.0"
            ]
          },
          "desc": "
Modules are cached in this object when they are required. By deleting a key\nvalue from this object, the next require will reload the module. Note that\nthis does not apply to native addons, for which reloading will result in an\nError.
\n"
        },
        {
          "textRaw": "`extensions` {Object} ",
          "type": "Object",
          "name": "extensions",
          "meta": {
            "added": [
              "v0.3.0"
            ],
            "deprecated": [
              "v0.10.6"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated",
          "desc": "
Instruct require on how to handle certain file extensions.
\n
Process files with the extension .sjs as .js:
\n
require.extensions['.sjs'] = require.extensions['.js'];\n
\n
Deprecated  In the past, this list has been used to load\nnon-JavaScript modules into Node.js by compiling them on-demand.\nHowever, in practice, there are much better ways to do this, such as\nloading modules via some other Node.js program, or compiling them to\nJavaScript ahead of time.
\n
Since the Module system is locked, this feature will probably never go\naway.  However, it may have subtle bugs and complexities that are best\nleft untouched.
\n"
        }
      ],
      "methods": [
        {
          "textRaw": "require.resolve()",
          "type": "method",
          "name": "resolve",
          "meta": {
            "added": [
              "v0.3.0"
            ]
          },
          "desc": "
Use the internal require() machinery to look up the location of a module,\nbut rather than loading the module, just return the resolved filename.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        }
      ]
    }
  ],
  "miscs": [
    {
      "textRaw": "Global Objects",
      "name": "Global Objects",
      "type": "misc",
      "desc": "
These objects are available in all modules. Some of these objects aren't\nactually in the global scope but in the module scope - this will be noted.
\n
The objects listed here are specific to Node.js. There are a number of\nbuilt-in objects that are part of the JavaScript language itself, which are\nalso globally accessible.
\n",
      "globals": [
        {
          "textRaw": "Class: Buffer",
          "type": "global",
          "name": "Buffer",
          "meta": {
            "added": [
              "v0.1.103"
            ]
          },
          "desc": "
    \n
  • {Function}
    • \n
\n
Used to handle binary data. See the buffer section.
\n"
        },
        {
          "textRaw": "clearImmediate(immediateObject)",
          "type": "global",
          "name": "clearImmediate",
          "meta": {
            "added": [
              "v0.9.1"
            ]
          },
          "desc": "
clearImmediate is described in the timers section.
\n"
        },
        {
          "textRaw": "clearInterval(intervalObject)",
          "type": "global",
          "name": "clearInterval",
          "meta": {
            "added": [
              "v0.0.1"
            ]
          },
          "desc": "
clearInterval is described in the timers section.
\n"
        },
        {
          "textRaw": "clearTimeout(timeoutObject)",
          "type": "global",
          "name": "clearTimeout",
          "meta": {
            "added": [
              "v0.0.1"
            ]
          },
          "desc": "
clearTimeout is described in the timers section.
\n"
        },
        {
          "textRaw": "console",
          "name": "console",
          "meta": {
            "added": [
              "v0.1.100"
            ]
          },
          "type": "global",
          "desc": "
    \n
  • {Object}
    • \n
\n
Used to print to stdout and stderr. See the console section.
\n"
        },
        {
          "textRaw": "global",
          "name": "global",
          "meta": {
            "added": [
              "v0.1.27"
            ]
          },
          "type": "global",
          "desc": "
    \n
  • {Object} The global namespace object.
    • \n
\n
In browsers, the top-level scope is the global scope. That means that in\nbrowsers if you're in the global scope var something will define a global\nvariable. In Node.js this is different. The top-level scope is not the global\nscope; var something inside an Node.js module will be local to that module.
\n"
        },
        {
          "textRaw": "process",
          "name": "process",
          "meta": {
            "added": [
              "v0.1.7"
            ]
          },
          "type": "global",
          "desc": "
    \n
  • {Object}
    • \n
\n
The process object. See the process object section.
\n"
        },
        {
          "textRaw": "setImmediate(callback[, arg][, ...])",
          "type": "global",
          "name": "setImmediate",
          "meta": {
            "added": [
              "v0.9.1"
            ]
          },
          "desc": "
setImmediate is described in the timers section.
\n"
        },
        {
          "textRaw": "setInterval(callback, delay[, arg][, ...])",
          "type": "global",
          "name": "setInterval",
          "meta": {
            "added": [
              "v0.0.1"
            ]
          },
          "desc": "
setInterval is described in the timers section.
\n"
        },
        {
          "textRaw": "setTimeout(callback, delay[, arg][, ...])",
          "type": "global",
          "name": "setTimeout",
          "meta": {
            "added": [
              "v0.0.1"
            ]
          },
          "desc": "
setTimeout is described in the timers section.
\n"
        }
      ],
      "vars": [
        {
          "textRaw": "\\_\\_dirname",
          "name": "\\_\\_dirname",
          "meta": {
            "added": [
              "v0.1.27"
            ]
          },
          "type": "var",
          "desc": "
    \n
  • {String}
    • \n
\n
The directory name of the current module. This the same as the\npath.dirname() of the __filename.
\n
__dirname isn't actually a global but rather local to each module.
\n
Example: running node example.js from /Users/mjr
\n
console.log(__dirname);\n// Prints: /Users/mjr\nconsole.log(path.dirname(__filename));\n// Prints: /Users/mjr\n
\n"
        },
        {
          "textRaw": "\\_\\_filename",
          "name": "\\_\\_filename",
          "meta": {
            "added": [
              "v0.0.1"
            ]
          },
          "type": "var",
          "desc": "
    \n
  • {String}
    • \n
\n
The file name of the current module. This is the resolved absolute path of the\ncurrent module file.
\n
For a main program this is not necessarily the same as the file name used in the\ncommand line.
\n
See __dirname for the directory name of the current module.
\n
__filename isn't actually a global but rather local to each module.
\n
Examples:
\n
Running node example.js from /Users/mjr
\n
console.log(__filename);\n// Prints: /Users/mjr/example.js\nconsole.log(__dirname);\n// Prints: /Users/mjr\n
\n
Given two modules: a and b, where b is a dependency of\na and there is a directory structure of:
\n
    \n
  • /Users/mjr/app/a.js
    • \n
  • /Users/mjr/app/node_modules/b/b.js
    • \n
\n
References to __filename within b.js will return\n/Users/mjr/app/node_modules/b/b.js while references to __filename within\na.js will return /Users/mjr/app/a.js.
\n"
        },
        {
          "textRaw": "exports",
          "name": "exports",
          "meta": {
            "added": [
              "v0.1.12"
            ]
          },
          "type": "var",
          "desc": "
A reference to the module.exports that is shorter to type.\nSee module system documentation for details on when to use exports and\nwhen to use module.exports.
\n
exports isn't actually a global but rather local to each module.
\n
See the module system documentation for more information.
\n"
        },
        {
          "textRaw": "module",
          "name": "module",
          "meta": {
            "added": [
              "v0.1.16"
            ]
          },
          "type": "var",
          "desc": "
    \n
  • {Object}
    • \n
\n
A reference to the current module. In particular\nmodule.exports is used for defining what a module exports and makes\navailable through require().
\n
module isn't actually a global but rather local to each module.
\n
See the module system documentation for more information.
\n"
        },
        {
          "textRaw": "require()",
          "type": "var",
          "name": "require",
          "meta": {
            "added": [
              "v0.1.13"
            ]
          },
          "desc": "
    \n
  • {Function}
    • \n
\n
To require modules. See the Modules section.  require isn't actually a\nglobal but rather local to each module.
\n",
          "properties": [
            {
              "textRaw": "`cache` {Object} ",
              "type": "Object",
              "name": "cache",
              "meta": {
                "added": [
                  "v0.3.0"
                ]
              },
              "desc": "
Modules are cached in this object when they are required. By deleting a key\nvalue from this object, the next require will reload the module. Note that\nthis does not apply to native addons, for which reloading will result in an\nError.
\n"
            },
            {
              "textRaw": "`extensions` {Object} ",
              "type": "Object",
              "name": "extensions",
              "meta": {
                "added": [
                  "v0.3.0"
                ],
                "deprecated": [
                  "v0.10.6"
                ]
              },
              "stability": 0,
              "stabilityText": "Deprecated",
              "desc": "
Instruct require on how to handle certain file extensions.
\n
Process files with the extension .sjs as .js:
\n
require.extensions['.sjs'] = require.extensions['.js'];\n
\n
Deprecated  In the past, this list has been used to load\nnon-JavaScript modules into Node.js by compiling them on-demand.\nHowever, in practice, there are much better ways to do this, such as\nloading modules via some other Node.js program, or compiling them to\nJavaScript ahead of time.
\n
Since the Module system is locked, this feature will probably never go\naway.  However, it may have subtle bugs and complexities that are best\nleft untouched.
\n"
            }
          ],
          "methods": [
            {
              "textRaw": "require.resolve()",
              "type": "method",
              "name": "resolve",
              "meta": {
                "added": [
                  "v0.3.0"
                ]
              },
              "desc": "
Use the internal require() machinery to look up the location of a module,\nbut rather than loading the module, just return the resolved filename.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}
node-v4.8.2/doc/api/globals.md000644 000766 000024 00000014432 13070706735 016247 0ustar00iojsstaff000000 000000 # Global Objects



These objects are available in all modules. Some of these objects aren't
actually in the global scope but in the module scope - this will be noted.

The objects listed here are specific to Node.js. There are a number of
[built-in objects][] that are part of the JavaScript language itself, which are
also globally accessible.

## Class: Buffer




* {Function}

Used to handle binary data. See the [buffer section][].

## \_\_dirname




* {String}

The directory name of the current module. This the same as the
[`path.dirname()`][] of the [`__filename`][].

`__dirname` isn't actually a global but rather local to each module.

Example: running `node example.js` from `/Users/mjr`

```js
console.log(__dirname);
// Prints: /Users/mjr
console.log(path.dirname(__filename));
// Prints: /Users/mjr
```

## \_\_filename




* {String}

The file name of the current module. This is the resolved absolute path of the
current module file.

For a main program this is not necessarily the same as the file name used in the
command line.

See [`__dirname`][] for the directory name of the current module.

`__filename` isn't actually a global but rather local to each module.

Examples:

Running `node example.js` from `/Users/mjr`

```js
console.log(__filename);
// Prints: /Users/mjr/example.js
console.log(__dirname);
// Prints: /Users/mjr
```

Given two modules: `a` and `b`, where `b` is a dependency of
`a` and there is a directory structure of:

* `/Users/mjr/app/a.js`
* `/Users/mjr/app/node_modules/b/b.js`

References to `__filename` within `b.js` will return
`/Users/mjr/app/node_modules/b/b.js` while references to `__filename` within
`a.js` will return `/Users/mjr/app/a.js`.

## clearImmediate(immediateObject)




[`clearImmediate`] is described in the [timers][] section.

## clearInterval(intervalObject)




[`clearInterval`] is described in the [timers][] section.

## clearTimeout(timeoutObject)




[`clearTimeout`] is described in the [timers][] section.

## console




* {Object}

Used to print to stdout and stderr. See the [`console`][] section.

## exports




A reference to the `module.exports` that is shorter to type.
See [module system documentation][] for details on when to use `exports` and
when to use `module.exports`.

`exports` isn't actually a global but rather local to each module.

See the [module system documentation][] for more information.

## global




* {Object} The global namespace object.

In browsers, the top-level scope is the global scope. That means that in
browsers if you're in the global scope `var something` will define a global
variable. In Node.js this is different. The top-level scope is not the global
scope; `var something` inside an Node.js module will be local to that module.

## module




* {Object}

A reference to the current module. In particular
`module.exports` is used for defining what a module exports and makes
available through `require()`.

`module` isn't actually a global but rather local to each module.

See the [module system documentation][] for more information.

## process




* {Object}

The process object. See the [`process` object][] section.

## require()




* {Function}

To require modules. See the [Modules][] section.  `require` isn't actually a
global but rather local to each module.

### require.cache


* {Object}

Modules are cached in this object when they are required. By deleting a key
value from this object, the next `require` will reload the module. Note that
this does not apply to [native addons][], for which reloading will result in an
Error.

### require.extensions


> Stability: 0 - Deprecated

* {Object}

Instruct `require` on how to handle certain file extensions.

Process files with the extension `.sjs` as `.js`:

```js
require.extensions['.sjs'] = require.extensions['.js'];
```

**Deprecated**  In the past, this list has been used to load
non-JavaScript modules into Node.js by compiling them on-demand.
However, in practice, there are much better ways to do this, such as
loading modules via some other Node.js program, or compiling them to
JavaScript ahead of time.

Since the Module system is locked, this feature will probably never go
away.  However, it may have subtle bugs and complexities that are best
left untouched.

### require.resolve()


Use the internal `require()` machinery to look up the location of a module,
but rather than loading the module, just return the resolved filename.

## setImmediate(callback[, arg][, ...])




[`setImmediate`] is described in the [timers][] section.

## setInterval(callback, delay[, arg][, ...])




[`setInterval`] is described in the [timers][] section.

## setTimeout(callback, delay[, arg][, ...])




[`setTimeout`] is described in the [timers][] section.

[`__dirname`]: #globals_dirname
[`__filename`]: #globals_filename
[`console`]: console.html
[`path.dirname()`]: path.html#path_path_dirname_path
[`process` object]: process.html#process_process
[buffer section]: buffer.html
[module system documentation]: modules.html
[Modules]: modules.html#modules_modules
[native addons]: addons.html
[timers]: timers.html
[`clearImmediate`]: timers.html#timers_clearimmediate_immediateobject
[`clearInterval`]: timers.html#timers_clearinterval_intervalobject
[`clearTimeout`]: timers.html#timers_cleartimeout_timeoutobject
[`setImmediate`]: timers.html#timers_setimmediate_callback_arg
[`setInterval`]: timers.html#timers_setinterval_callback_delay_arg
[`setTimeout`]: timers.html#timers_settimeout_callback_delay_arg
[built-in objects]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects
node-v4.8.2/doc/api/http.html000644 000766 000024 00000231565 13070706740 016153 0ustar00iojsstaff000000 000000 


  
  HTTP | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

        
Table of Contents

        

      


      

        
HTTP#


Stability: 2 - Stable
To use the HTTP server and client one must require('http').


The HTTP interfaces in Node.js are designed to support many features
of the protocol which have been traditionally difficult to use.
In particular, large, possibly chunk-encoded, messages. The interface is
careful to never buffer entire requests or responses--the
user is able to stream data.


HTTP message headers are represented by an object like this:


{ 'content-length': '123',
  'content-type': 'text/plain',
  'connection': 'keep-alive',
  'host': 'mysite.com',
  'accept': '*/*' }

Keys are lowercased. Values are not modified.


In order to support the full spectrum of possible HTTP applications, Node.js's
HTTP API is very low-level. It deals with stream handling and message
parsing only. It parses a message into headers and body but it does not
parse the actual headers or the body.


See message.headers for details on how duplicate headers are handled.


The raw headers as they were received are retained in the rawHeaders
property, which is an array of [key, value, key2, value2, ...].  For
example, the previous message header object might have a rawHeaders
list like the following:


[ 'ConTent-Length', '123456',
  'content-LENGTH', '123',
  'content-type', 'text/plain',
  'CONNECTION', 'keep-alive',
  'Host', 'mysite.com',
  'accepT', '*/*' ]

Class: http.Agent#



Added in: v0.3.4

The HTTP Agent is used for pooling sockets used in HTTP client
requests.


The HTTP Agent also defaults client requests to using
Connection:keep-alive. If no pending HTTP requests are waiting on a
socket to become free the socket is closed. This means that Node.js's
pool has the benefit of keep-alive when under load but still does not
require developers to manually close the HTTP clients using
KeepAlive.


If you opt into using HTTP KeepAlive, you can create an Agent object
with that flag set to true.  (See the constructor options.)
Then, the Agent will keep unused sockets in a pool for later use.  They
will be explicitly marked so as to not keep the Node.js process running.
However, it is still a good idea to explicitly destroy() KeepAlive
agents when they are no longer in use, so that the Sockets will be shut
down.


Sockets are removed from the agent's pool when the socket emits either
a 'close' event or a special 'agentRemove' event. This means that if
you intend to keep one HTTP request open for a long time and don't
want it to stay in the pool you can do something along the lines of:


http.get(options, (res) => {
  // Do stuff
}).on('socket', (socket) => {
  socket.emit('agentRemove');
});



Alternatively, you could just opt out of pooling entirely using
agent:false:


http.get({
  hostname: 'localhost',
  port: 80,
  path: '/',
  agent: false  // create a new agent just for this one request
}, (res) => {
  // Do stuff with response
})



new Agent([options])#



Added in: v0.3.4

    

  • options <Object> Set of configurable options to set on the agent.
Can have the following fields:
      

    • keepAlive <Boolean> Keep sockets around even when there are no
outstanding requests, so they can be used for future requests without
having to reestablish a TCP connection. Default = false
      • 

    • keepAliveMsecs <Integer> When using the keepAlive option, specifies
the initial delay
for TCP Keep-Alive packets. Ignored when the
keepAlive option is false or undefined. Default = 1000.
      • 

    • maxSockets <Number> Maximum number of sockets to allow per
host.  Default = Infinity.
      • 

    • maxFreeSockets <Number> Maximum number of sockets to leave open
in a free state.  Only relevant if keepAlive is set to true.
Default = 256.
      • 

    

    • 



The default http.globalAgent that is used by http.request() has all
of these values set to their respective defaults.


To configure any of them, you must create your own http.Agent object.


const http = require('http');
var keepAliveAgent = new http.Agent({ keepAlive: true });
options.agent = keepAliveAgent;
http.request(options, onResponseCallback);



agent.destroy()#



Added in: v0.11.4

Destroy any sockets that are currently in use by the agent.


It is usually not necessary to do this.  However, if you are using an
agent with KeepAlive enabled, then it is best to explicitly shut down
the agent when you know that it will no longer be used.  Otherwise,
sockets may hang open for quite a long time before the server
terminates them.


agent.freeSockets#



Added in: v0.11.4

An object which contains arrays of sockets currently awaiting use by
the Agent when HTTP KeepAlive is used.  Do not modify.


agent.getName(options)#



Added in: v0.11.4

Get a unique name for a set of request options, to determine whether a
connection can be reused.  In the http agent, this returns
host:port:localAddress.  In the https agent, the name includes the
CA, cert, ciphers, and other HTTPS/TLS-specific options that determine
socket reusability.


Options:


    

  • host: A domain name or IP address of the server to issue the request to.
    • 

  • port: Port of remote server.
    • 

  • localAddress: Local interface to bind for network connections when issuing
the request.
    • 



agent.maxFreeSockets#



Added in: v0.11.7

By default set to 256.  For Agents supporting HTTP KeepAlive, this
sets the maximum number of sockets that will be left open in the free
state.


agent.maxSockets#



Added in: v0.3.6

By default set to Infinity. Determines how many concurrent sockets the agent
can have open per origin. Origin is either a 'host:port' or
'host:port:localAddress' combination.


agent.requests#



Added in: v0.5.9

An object which contains queues of requests that have not yet been assigned to
sockets. Do not modify.


agent.sockets#



Added in: v0.3.6

An object which contains arrays of sockets currently in use by the
Agent.  Do not modify.


Class: http.ClientRequest#



Added in: v0.1.17

This object is created internally and returned from http.request().  It
represents an in-progress request whose header has already been queued.  The
header is still mutable using the setHeader(name, value), getHeader(name),
removeHeader(name) API.  The actual header will be sent along with the first
data chunk or when closing the connection.


To get the response, add a listener for 'response' to the request object.
'response' will be emitted from the request object when the response
headers have been received.  The 'response' event is executed with one
argument which is an instance of http.IncomingMessage.


During the 'response' event, one can add listeners to the
response object; particularly to listen for the 'data' event.


If no 'response' handler is added, then the response will be
entirely discarded.  However, if you add a 'response' event handler,
then you must consume the data from the response object, either by
calling response.read() whenever there is a 'readable' event, or
by adding a 'data' handler, or by calling the .resume() method.
Until the data is consumed, the 'end' event will not fire.  Also, until
the data is read it will consume memory that can eventually lead to a
'process out of memory' error.


Note: Node.js does not check whether Content-Length and the length of the body
which has been transmitted are equal or not.


The request implements the Writable Stream interface. This is an
EventEmitter with the following events:


Event: 'abort'#



Added in: v1.4.1

function () { }


Emitted when the request has been aborted by the client. This event is only
emitted on the first call to abort().


Event: 'aborted'#



Added in: v0.3.8

function () { }


Emitted when the request has been aborted by the server and the network
socket has closed.


Event: 'connect'#



Added in: v0.7.0

function (response, socket, head) { }


Emitted each time a server responds to a request with a CONNECT method. If this
event isn't being listened for, clients receiving a CONNECT method will have
their connections closed.


A client and server pair that shows you how to listen for the 'connect' event:


const http = require('http');
const net = require('net');
const url = require('url');

// Create an HTTP tunneling proxy
var proxy = http.createServer( (req, res) => {
  res.writeHead(200, {'Content-Type': 'text/plain'});
  res.end('okay');
});
proxy.on('connect', (req, cltSocket, head) => {
  // connect to an origin server
  var srvUrl = url.parse(`http://${req.url}`);
  var srvSocket = net.connect(srvUrl.port, srvUrl.hostname, () => {
    cltSocket.write('HTTP/1.1 200 Connection Established\r\n' +
                    'Proxy-agent: Node.js-Proxy\r\n' +
                    '\r\n');
    srvSocket.write(head);
    srvSocket.pipe(cltSocket);
    cltSocket.pipe(srvSocket);
  });
});

// now that proxy is running
proxy.listen(1337, '127.0.0.1', () => {

  // make a request to a tunneling proxy
  var options = {
    port: 1337,
    hostname: '127.0.0.1',
    method: 'CONNECT',
    path: 'www.google.com:80'
  };

  var req = http.request(options);
  req.end();

  req.on('connect', (res, socket, head) => {
    console.log('got connected!');

    // make a request over an HTTP tunnel
    socket.write('GET / HTTP/1.1\r\n' +
                 'Host: www.google.com:80\r\n' +
                 'Connection: close\r\n' +
                 '\r\n');
    socket.on('data', (chunk) => {
      console.log(chunk.toString());
    });
    socket.on('end', () => {
      proxy.close();
    });
  });
});



Event: 'continue'#



Added in: v0.3.2

function () { }


Emitted when the server sends a '100 Continue' HTTP response, usually because
the request contained 'Expect: 100-continue'. This is an instruction that
the client should send the request body.


Event: 'response'#



Added in: v0.1.0

function (response) { }


Emitted when a response is received to this request. This event is emitted only
once. The response argument will be an instance of http.IncomingMessage.


Event: 'socket'#



Added in: v0.5.3

function (socket) { }


Emitted after a socket is assigned to this request.


Event: 'upgrade'#



Added in: v0.1.94

function (response, socket, head) { }


Emitted each time a server responds to a request with an upgrade. If this
event isn't being listened for, clients receiving an upgrade header will have
their connections closed.


A client server pair that show you how to listen for the 'upgrade' event.


const http = require('http');

// Create an HTTP server
var srv = http.createServer( (req, res) => {
  res.writeHead(200, {'Content-Type': 'text/plain'});
  res.end('okay');
});
srv.on('upgrade', (req, socket, head) => {
  socket.write('HTTP/1.1 101 Web Socket Protocol Handshake\r\n' +
               'Upgrade: WebSocket\r\n' +
               'Connection: Upgrade\r\n' +
               '\r\n');

  socket.pipe(socket); // echo back
});

// now that server is running
srv.listen(1337, '127.0.0.1', () => {

  // make a request
  var options = {
    port: 1337,
    hostname: '127.0.0.1',
    headers: {
      'Connection': 'Upgrade',
      'Upgrade': 'websocket'
    }
  };

  var req = http.request(options);
  req.end();

  req.on('upgrade', (res, socket, upgradeHead) => {
    console.log('got upgraded!');
    socket.end();
    process.exit(0);
  });
});



request.abort()#



Added in: v0.3.8

Marks the request as aborting. Calling this will cause remaining data
in the response to be dropped and the socket to be destroyed.


request.aborted#



Added in: v0.11.14

If a request has been aborted, this value is the time when the request was
aborted, in milliseconds since 1 January 1970 00:00:00 UTC.


request.end([data][, encoding][, callback])#



Added in: v0.1.90

Finishes sending the request. If any parts of the body are
unsent, it will flush them to the stream. If the request is
chunked, this will send the terminating '0\r\n\r\n'.


If data is specified, it is equivalent to calling
response.write(data, encoding) followed by request.end(callback).


If callback is specified, it will be called when the request stream
is finished.


request.flushHeaders()#



Added in: v1.6.0

Flush the request headers.


For efficiency reasons, Node.js normally buffers the request headers until you
call request.end() or write the first chunk of request data.  It then tries
hard to pack the request headers and data into a single TCP packet.


That's usually what you want (it saves a TCP round-trip) but not when the first
data isn't sent until possibly much later.  request.flushHeaders() lets you bypass
the optimization and kickstart the request.


request.setNoDelay([noDelay])#



Added in: v0.5.9

Once a socket is assigned to this request and is connected
socket.setNoDelay() will be called.


request.setSocketKeepAlive([enable][, initialDelay])#



Added in: v0.5.9

Once a socket is assigned to this request and is connected
socket.setKeepAlive() will be called.


request.setTimeout(timeout[, callback])#



Added in: v0.5.9

Once a socket is assigned to this request and is connected
socket.setTimeout() will be called.


    

  • timeout <Number> Milliseconds before a request is considered to be timed out.
    • 

  • callback <Function> Optional function to be called when a timeout occurs. Same as binding to the timeout event.
    • 



Returns request.


request.write(chunk[, encoding][, callback])#



Added in: v0.1.29

Sends a chunk of the body.  By calling this method
many times, the user can stream a request body to a
server--in that case it is suggested to use the
['Transfer-Encoding', 'chunked'] header line when
creating the request.


The chunk argument should be a Buffer or a string.


The encoding argument is optional and only applies when chunk is a string.
Defaults to 'utf8'.


The callback argument is optional and will be called when this chunk of data
is flushed.


Returns request.


Class: http.Server#



Added in: v0.1.17

This class inherits from net.Server and has the following additional events:


Event: 'checkContinue'#



Added in: v0.3.0

function (request, response) { }


Emitted each time a request with an http Expect: 100-continue is received.
If this event isn't listened for, the server will automatically respond
with a 100 Continue as appropriate.


Handling this event involves calling response.writeContinue() if the client
should continue to send the request body, or generating an appropriate HTTP
response (e.g. 400 Bad Request) if the client should not continue to send the
request body.


Note that when this event is emitted and handled, the 'request' event will
not be emitted.


Event: 'clientError'#



Added in: v0.1.94

function (exception, socket) { }


If a client connection emits an 'error' event, it will be forwarded here.


socket is the net.Socket object that the error originated from.


Event: 'close'#



Added in: v0.1.4

function () { }


Emitted when the server closes.


Event: 'connect'#



Added in: v0.7.0

function (request, socket, head) { }


Emitted each time a client requests a http CONNECT method. If this event isn't
listened for, then clients requesting a CONNECT method will have their
connections closed.


    

  • request is the arguments for the http request, as it is in the request
event.
    • 

  • socket is the network socket between the server and client.
    • 

  • head is an instance of Buffer, the first packet of the tunneling stream,
this may be empty.
    • 



After this event is emitted, the request's socket will not have a 'data'
event listener, meaning you will need to bind to it in order to handle data
sent to the server on that socket.


Event: 'connection'#



Added in: v0.1.0

function (socket) { }


When a new TCP stream is established. socket is an object of type
net.Socket. Usually users will not want to access this event. In
particular, the socket will not emit 'readable' events because of how
the protocol parser attaches to the socket. The socket can also be
accessed at request.connection.


Event: 'request'#



Added in: v0.1.0

function (request, response) { }


Emitted each time there is a request. Note that there may be multiple requests
per connection (in the case of keep-alive connections).
 request is an instance of http.IncomingMessage and response is
an instance of http.ServerResponse.


Event: 'upgrade'#



Added in: v0.1.94

function (request, socket, head) { }


Emitted each time a client requests a http upgrade. If this event isn't
listened for, then clients requesting an upgrade will have their connections
closed.


    

  • request is the arguments for the http request, as it is in the request
event.
    • 

  • socket is the network socket between the server and client.
    • 

  • head is an instance of Buffer, the first packet of the upgraded stream,
this may be empty.
    • 



After this event is emitted, the request's socket will not have a 'data'
event listener, meaning you will need to bind to it in order to handle data
sent to the server on that socket.


server.close([callback])#



Added in: v0.1.90

Stops the server from accepting new connections.  See net.Server.close().


server.listen(handle[, callback])#



Added in: v0.5.10



The handle object can be set to either a server or socket (anything
with an underlying _handle member), or a {fd: <n>} object.


This will cause the server to accept connections on the specified
handle, but it is presumed that the file descriptor or handle has
already been bound to a port or domain socket.


Listening on a file descriptor is not supported on Windows.


This function is asynchronous. callback will be added as a listener for the
'listening' event. See also net.Server.listen().


Returns server.


server.listen(path[, callback])#



Added in: v0.1.90

Start a UNIX socket server listening for connections on the given path.


This function is asynchronous. callback will be added as a listener for the
'listening' event.  See also net.Server.listen(path).


server.listen([port][, hostname][, backlog][, callback])#



Added in: v0.1.90

Begin accepting connections on the specified port and hostname. If the
hostname is omitted, the server will accept connections on any IPv6 address
(::) when IPv6 is available, or any IPv4 address (0.0.0.0) otherwise.
Omit the port argument, or use a port value of 0, to have the operating system
assign a random port, which can be retrieved by using server.address().port
after the 'listening' event has been emitted.


To listen to a unix socket, supply a filename instead of port and hostname.


Backlog is the maximum length of the queue of pending connections.
The actual length will be determined by your OS through sysctl settings such as
tcp_max_syn_backlog and somaxconn on linux. The default value of this
parameter is 511 (not 512).


This function is asynchronous. callback will be added as a listener for the
'listening' event.  See also net.Server.listen(port).


server.maxHeadersCount#



Added in: v0.7.0

Limits maximum incoming headers count, equal to 1000 by default. If set to 0 -
no limit will be applied.


server.setTimeout(msecs, callback)#



Added in: v0.9.12



Sets the timeout value for sockets, and emits a 'timeout' event on
the Server object, passing the socket as an argument, if a timeout
occurs.


If there is a 'timeout' event listener on the Server object, then it
will be called with the timed-out socket as an argument.


By default, the Server's timeout value is 2 minutes, and sockets are
destroyed automatically if they time out.  However, if you assign a
callback to the Server's 'timeout' event, then you are responsible
for handling socket timeouts.


Returns server.


server.timeout#



Added in: v0.9.12



The number of milliseconds of inactivity before a socket is presumed
to have timed out.


Note that the socket timeout logic is set up on connection, so
changing this value only affects new connections to the server, not
any existing connections.


Set to 0 to disable any kind of automatic timeout behavior on incoming
connections.


Class: http.ServerResponse#



Added in: v0.1.17

This object is created internally by a HTTP server--not by the user. It is
passed as the second parameter to the 'request' event.


The response implements, but does not inherit from, the Writable Stream
interface. This is an EventEmitter with the following events:


Event: 'close'#



Added in: v0.6.7

function () { }


Indicates that the underlying connection was terminated before
response.end() was called or able to flush.


Event: 'finish'#



Added in: v0.3.6

function () { }


Emitted when the response has been sent. More specifically, this event is
emitted when the last segment of the response headers and body have been
handed off to the operating system for transmission over the network. It
does not imply that the client has received anything yet.


After this event, no more events will be emitted on the response object.


response.addTrailers(headers)#



Added in: v0.3.0

This method adds HTTP trailing headers (a header but at the end of the
message) to the response.


Trailers will only be emitted if chunked encoding is used for the
response; if it is not (e.g. if the request was HTTP/1.0), they will
be silently discarded.


Note that HTTP requires the Trailer header to be sent if you intend to
emit trailers, with a list of the header fields in its value. E.g.,


response.writeHead(200, { 'Content-Type': 'text/plain',
                          'Trailer': 'Content-MD5' });
response.write(fileData);
response.addTrailers({'Content-MD5': '7895bf4b8828b55ceaf47747b4bca667'});
response.end();



Attempting to set a header field name or value that contains invalid characters
will result in a TypeError being thrown.


response.end([data][, encoding][, callback])#



Added in: v0.1.90

This method signals to the server that all of the response headers and body
have been sent; that server should consider this message complete.
The method, response.end(), MUST be called on each response.


If data is specified, it is equivalent to calling
response.write(data, encoding) followed by response.end(callback).


If callback is specified, it will be called when the response stream
is finished.


response.finished#



Added in: v0.0.2

Boolean value that indicates whether the response has completed. Starts
as false. After response.end() executes, the value will be true.


response.getHeader(name)#



Added in: v0.4.0

Reads out a header that's already been queued but not sent to the client.  Note
that the name is case insensitive.  This can only be called before headers get
implicitly flushed.


Example:


var contentType = response.getHeader('content-type');



response.headersSent#



Added in: v0.9.3

Boolean (read-only). True if headers were sent, false otherwise.


response.removeHeader(name)#



Added in: v0.4.0

Removes a header that's queued for implicit sending.


Example:


response.removeHeader('Content-Encoding');



response.sendDate#



Added in: v0.7.5

When true, the Date header will be automatically generated and sent in
the response if it is not already present in the headers. Defaults to true.


This should only be disabled for testing; HTTP requires the Date header
in responses.


response.setHeader(name, value)#



Added in: v0.4.0

Sets a single header value for implicit headers.  If this header already exists
in the to-be-sent headers, its value will be replaced.  Use an array of strings
here if you need to send multiple headers with the same name.


Example:


response.setHeader('Content-Type', 'text/html');



or


response.setHeader('Set-Cookie', ['type=ninja', 'language=javascript']);



Attempting to set a header field name or value that contains invalid characters
will result in a TypeError being thrown.


When headers have been set with response.setHeader(), they will be merged with
any headers passed to response.writeHead(), with the headers passed to
response.writeHead() given precedence.


// returns content-type = text/plain
const server = http.createServer((req,res) => {
  res.setHeader('Content-Type', 'text/html');
  res.setHeader('X-Foo', 'bar');
  res.writeHead(200, {'Content-Type': 'text/plain'});
  res.end('ok');
});



response.setTimeout(msecs, callback)#



Added in: v0.9.12



Sets the Socket's timeout value to msecs.  If a callback is
provided, then it is added as a listener on the 'timeout' event on
the response object.


If no 'timeout' listener is added to the request, the response, or
the server, then sockets are destroyed when they time out.  If you
assign a handler on the request, the response, or the server's
'timeout' events, then it is your responsibility to handle timed out
sockets.


Returns response.


response.statusCode#



Added in: v0.4.0

When using implicit headers (not calling response.writeHead() explicitly),
this property controls the status code that will be sent to the client when
the headers get flushed.


Example:


response.statusCode = 404;



After response header was sent to the client, this property indicates the
status code which was sent out.


response.statusMessage#



Added in: v0.11.8

When using implicit headers (not calling response.writeHead() explicitly), this property
controls the status message that will be sent to the client when the headers get
flushed. If this is left as undefined then the standard message for the status
code will be used.


Example:


response.statusMessage = 'Not found';



After response header was sent to the client, this property indicates the
status message which was sent out.


response.write(chunk[, encoding][, callback])#



Added in: v0.1.29

If this method is called and response.writeHead() has not been called,
it will switch to implicit header mode and flush the implicit headers.


This sends a chunk of the response body. This method may
be called multiple times to provide successive parts of the body.


chunk can be a string or a buffer. If chunk is a string,
the second parameter specifies how to encode it into a byte stream.
By default the encoding is 'utf8'. callback will be called when this chunk
of data is flushed.


Note: This is the raw HTTP body and has nothing to do with
higher-level multi-part body encodings that may be used.


The first time response.write() is called, it will send the buffered
header information and the first body to the client. The second time
response.write() is called, Node.js assumes you're going to be streaming
data, and sends that separately. That is, the response is buffered up to the
first chunk of body.


Returns true if the entire data was flushed successfully to the kernel
buffer. Returns false if all or part of the data was queued in user memory.
'drain' will be emitted when the buffer is free again.


response.writeContinue()#



Added in: v0.3.0

Sends a HTTP/1.1 100 Continue message to the client, indicating that
the request body should be sent. See the 'checkContinue' event on Server.


response.writeHead(statusCode[, statusMessage][, headers])#



Added in: v0.1.30

Sends a response header to the request. The status code is a 3-digit HTTP
status code, like 404. The last argument, headers, are the response headers.
Optionally one can give a human-readable statusMessage as the second
argument.


Example:


var body = 'hello world';
response.writeHead(200, {
  'Content-Length': Buffer.byteLength(body),
  'Content-Type': 'text/plain' });



This method must only be called once on a message and it must
be called before response.end() is called.


If you call response.write() or response.end() before calling this,
the implicit/mutable headers will be calculated and call this function for you.


When headers have been set with response.setHeader(), they will be merged with
any headers passed to response.writeHead(), with the headers passed to
response.writeHead() given precedence.


// returns content-type = text/plain
const server = http.createServer((req,res) => {
  res.setHeader('Content-Type', 'text/html');
  res.setHeader('X-Foo', 'bar');
  res.writeHead(200, {'Content-Type': 'text/plain'});
  res.end('ok');
});



Note that Content-Length is given in bytes not characters. The above example
works because the string 'hello world' contains only single byte characters.
If the body contains higher coded characters then Buffer.byteLength()
should be used to determine the number of bytes in a given encoding.
And Node.js does not check whether Content-Length and the length of the body
which has been transmitted are equal or not.


Attempting to set a header field name or value that contains invalid characters
will result in a TypeError being thrown.


Class: http.IncomingMessage#



Added in: v0.1.17

An IncomingMessage object is created by http.Server or
http.ClientRequest and passed as the first argument to the 'request'
and 'response' event respectively. It may be used to access response status,
headers and data.


It implements the Readable Stream interface, as well as the
following additional events, methods, and properties.


Event: 'aborted'#



Added in: v0.3.8

function () { }


Emitted when the request has been aborted by the client and the network
socket has closed.


Event: 'close'#



Added in: v0.4.2

function () { }


Indicates that the underlying connection was closed.
Just like 'end', this event occurs only once per response.


message.destroy([error])#



Added in: v0.3.0



Calls destroy() on the socket that received the IncomingMessage. If error
is provided, an 'error' event is emitted and error is passed as an argument
to any listeners on the event.


message.headers#



Added in: v0.1.5

The request/response headers object.


Key-value pairs of header names and values. Header names are lower-cased.
Example:


// Prints something like:
//
// { 'user-agent': 'curl/7.22.0',
//   host: '127.0.0.1:8000',
//   accept: '*/*' }
console.log(request.headers);



Duplicates in raw headers are handled in the following ways, depending on the
header name:


    

  • Duplicates of age, authorization, content-length, content-type,
etag, expires, from, host, if-modified-since, if-unmodified-since,
last-modified, location, max-forwards, proxy-authorization, referer,
retry-after, or user-agent are discarded.
    • 

  • set-cookie is always an array. Duplicates are added to the array.
    • 

  • For all other headers, the values are joined together with ', '.
    • 



message.httpVersion#



Added in: v0.1.1

In case of server request, the HTTP version sent by the client. In the case of
client response, the HTTP version of the connected-to server.
Probably either '1.1' or '1.0'.


Also message.httpVersionMajor is the first integer and
message.httpVersionMinor is the second.


message.method#



Added in: v0.1.1

Only valid for request obtained from http.Server.


The request method as a string. Read only. Example:
'GET', 'DELETE'.


message.rawHeaders#



Added in: v0.11.6

The raw request/response headers list exactly as they were received.


Note that the keys and values are in the same list.  It is not a
list of tuples.  So, the even-numbered offsets are key values, and the
odd-numbered offsets are the associated values.


Header names are not lowercased, and duplicates are not merged.


// Prints something like:
//
// [ 'user-agent',
//   'this is invalid because there can be only one',
//   'User-Agent',
//   'curl/7.22.0',
//   'Host',
//   '127.0.0.1:8000',
//   'ACCEPT',
//   '*/*' ]
console.log(request.rawHeaders);



message.rawTrailers#



Added in: v0.11.6

The raw request/response trailer keys and values exactly as they were
received.  Only populated at the 'end' event.


message.setTimeout(msecs, callback)#



Added in: v0.5.9



Calls message.connection.setTimeout(msecs, callback).


Returns message.


message.statusCode#



Added in: v0.1.1

Only valid for response obtained from http.ClientRequest.


The 3-digit HTTP response status code. E.G. 404.


message.statusMessage#



Added in: v0.11.10

Only valid for response obtained from http.ClientRequest.


The HTTP response status message (reason phrase). E.G. OK or Internal Server Error.


message.socket#



Added in: v0.3.0

The net.Socket object associated with the connection.


With HTTPS support, use request.socket.getPeerCertificate() to obtain the
client's authentication details.


message.trailers#



Added in: v0.3.0

The request/response trailers object. Only populated at the 'end' event.


message.url#



Added in: v0.1.90

Only valid for request obtained from http.Server.


Request URL string. This contains only the URL that is
present in the actual HTTP request. If the request is:


GET /status?name=ryan HTTP/1.1\r\n
Accept: text/plain\r\n
\r\n

Then request.url will be:


'/status?name=ryan'

If you would like to parse the URL into its parts, you can use
require('url').parse(request.url).  Example:


$ node
> require('url').parse('/status?name=ryan')
{
  href: '/status?name=ryan',
  search: '?name=ryan',
  query: 'name=ryan',
  pathname: '/status'
}

If you would like to extract the parameters from the query string,
you can use the require('querystring').parse function, or pass
true as the second argument to require('url').parse.  Example:


$ node
> require('url').parse('/status?name=ryan', true)
{
  href: '/status?name=ryan',
  search: '?name=ryan',
  query: {name: 'ryan'},
  pathname: '/status'
}

http.METHODS#



Added in: v0.11.8



A list of the HTTP methods that are supported by the parser.


http.STATUS_CODES#



Added in: v0.1.22



A collection of all the standard HTTP response status codes, and the
short description of each.  For example, http.STATUS_CODES[404] === 'Not
Found'.


http.createClient([port][, host])#



Added in: v0.1.13
Deprecated since: v0.3.6 

Stability: 0 - Deprecated: Use http.request() instead.
Constructs a new HTTP client. port and host refer to the server to be
connected to.


http.createServer([requestListener])#



Added in: v0.1.13

Returns a new instance of http.Server.


The requestListener is a function which is automatically
added to the 'request' event.


http.get(options[, callback])#



Added in: v0.3.6

Since most requests are GET requests without bodies, Node.js provides this
convenience method. The only difference between this method and http.request()
is that it sets the method to GET and calls req.end() automatically.


Example:


http.get('http://www.google.com/index.html', (res) => {
  console.log(`Got response: ${res.statusCode}`);
  // consume response body
  res.resume();
}).on('error', (e) => {
  console.log(`Got error: ${e.message}`);
});



http.globalAgent#



Added in: v0.5.9

Global instance of Agent which is used as the default for all http client
requests.


http.request(options[, callback])#



Added in: v0.3.6

Node.js maintains several connections per server to make HTTP requests.
This function allows one to transparently issue requests.


options can be an object or a string. If options is a string, it is
automatically parsed with url.parse().


Options:


    

  • protocol: Protocol to use. Defaults to 'http:'.
    • 

  • host: A domain name or IP address of the server to issue the request to.
Defaults to 'localhost'.
    • 

  • hostname: Alias for host. To support url.parse() hostname is
preferred over host.
    • 

  • family: IP address family to use when resolving host and hostname.
Valid values are 4 or 6. When unspecified, both IP v4 and v6 will be
used.
    • 

  • port: Port of remote server. Defaults to 80.
    • 

  • localAddress: Local interface to bind for network connections.
    • 

  • socketPath: Unix Domain Socket (use one of host:port or socketPath).
    • 

  • method: A string specifying the HTTP request method. Defaults to 'GET'.
    • 

  • path: Request path. Defaults to '/'. Should include query string if any.
E.G. '/index.html?page=12'. An exception is thrown when the request path
contains illegal characters. Currently, only spaces are rejected but that
may change in the future.
    • 

  • headers: An object containing request headers.
    • 

  • auth: Basic authentication i.e. 'user:password' to compute an
Authorization header.
    • 

  • agent: Controls Agent behavior. When an Agent is used request will
default to Connection: keep-alive. Possible values:
      

    • undefined (default): use http.globalAgent for this host and port.
      • 

    • Agent object: explicitly use the passed in Agent.
      • 

    • false: opts out of connection pooling with an Agent, defaults request to
Connection: close.
      • 

    

    • 



The optional callback parameter will be added as a one time listener for
the 'response' event.


http.request() returns an instance of the http.ClientRequest
class. The ClientRequest instance is a writable stream. If one needs to
upload a file with a POST request, then write to the ClientRequest object.


Example:


var postData = querystring.stringify({
  'msg' : 'Hello World!'
});

var options = {
  hostname: 'www.google.com',
  port: 80,
  path: '/upload',
  method: 'POST',
  headers: {
    'Content-Type': 'application/x-www-form-urlencoded',
    'Content-Length': Buffer.byteLength(postData)
  }
};

var req = http.request(options, (res) => {
  console.log(`STATUS: ${res.statusCode}`);
  console.log(`HEADERS: ${JSON.stringify(res.headers)}`);
  res.setEncoding('utf8');
  res.on('data', (chunk) => {
    console.log(`BODY: ${chunk}`);
  });
  res.on('end', () => {
    console.log('No more data in response.')
  })
});

req.on('error', (e) => {
  console.log(`problem with request: ${e.message}`);
});

// write data to request body
req.write(postData);
req.end();



Note that in the example req.end() was called. With http.request() one
must always call req.end() to signify that you're done with the request -
even if there is no data being written to the request body.


If any error is encountered during the request (be that with DNS resolution,
TCP level errors, or actual HTTP parse errors) an 'error' event is emitted
on the returned request object. As with all 'error' events, if no listeners
are registered the error will be thrown.


There are a few special headers that should be noted.


    

  • Sending a 'Connection: keep-alive' will notify Node.js that the connection to
the server should be persisted until the next request.
    

    • 

  • Sending a 'Content-Length' header will disable the default chunked encoding.
    

    • 

  • Sending an 'Expect' header will immediately send the request headers.
Usually, when sending 'Expect: 100-continue', you should both set a timeout
and listen for the 'continue' event. See RFC2616 Section 8.2.3 for more
information.
    

    • 

  • Sending an Authorization header will override using the auth option
to compute basic authentication.
    

    • 



      

    

  

  
  
  
  



node-v4.8.2/doc/api/http.json000644 000766 000024 00000242545 13070706740 016160 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/http.md",
  "modules": [
    {
      "textRaw": "HTTP",
      "name": "http",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
To use the HTTP server and client one must require('http').
\n
The HTTP interfaces in Node.js are designed to support many features\nof the protocol which have been traditionally difficult to use.\nIn particular, large, possibly chunk-encoded, messages. The interface is\ncareful to never buffer entire requests or responses--the\nuser is able to stream data.
\n
HTTP message headers are represented by an object like this:
\n
{ 'content-length': '123',\n  'content-type': 'text/plain',\n  'connection': 'keep-alive',\n  'host': 'mysite.com',\n  'accept': '*/*' }\n
Keys are lowercased. Values are not modified.
\n
In order to support the full spectrum of possible HTTP applications, Node.js's\nHTTP API is very low-level. It deals with stream handling and message\nparsing only. It parses a message into headers and body but it does not\nparse the actual headers or the body.
\n
See message.headers for details on how duplicate headers are handled.
\n
The raw headers as they were received are retained in the rawHeaders\nproperty, which is an array of [key, value, key2, value2, ...].  For\nexample, the previous message header object might have a rawHeaders\nlist like the following:
\n
[ 'ConTent-Length', '123456',\n  'content-LENGTH', '123',\n  'content-type', 'text/plain',\n  'CONNECTION', 'keep-alive',\n  'Host', 'mysite.com',\n  'accepT', '*/*' ]\n
",
      "classes": [
        {
          "textRaw": "Class: http.Agent",
          "type": "class",
          "name": "http.Agent",
          "meta": {
            "added": [
              "v0.3.4"
            ]
          },
          "desc": "
The HTTP Agent is used for pooling sockets used in HTTP client\nrequests.
\n
The HTTP Agent also defaults client requests to using\nConnection:keep-alive. If no pending HTTP requests are waiting on a\nsocket to become free the socket is closed. This means that Node.js's\npool has the benefit of keep-alive when under load but still does not\nrequire developers to manually close the HTTP clients using\nKeepAlive.
\n
If you opt into using HTTP KeepAlive, you can create an Agent object\nwith that flag set to true.  (See the constructor options.)\nThen, the Agent will keep unused sockets in a pool for later use.  They\nwill be explicitly marked so as to not keep the Node.js process running.\nHowever, it is still a good idea to explicitly destroy() KeepAlive\nagents when they are no longer in use, so that the Sockets will be shut\ndown.
\n
Sockets are removed from the agent's pool when the socket emits either\na 'close' event or a special 'agentRemove' event. This means that if\nyou intend to keep one HTTP request open for a long time and don't\nwant it to stay in the pool you can do something along the lines of:
\n
http.get(options, (res) => {\n  // Do stuff\n}).on('socket', (socket) => {\n  socket.emit('agentRemove');\n});\n
\n
Alternatively, you could just opt out of pooling entirely using\nagent:false:
\n
http.get({\n  hostname: 'localhost',\n  port: 80,\n  path: '/',\n  agent: false  // create a new agent just for this one request\n}, (res) => {\n  // Do stuff with response\n})\n
\n",
          "methods": [
            {
              "textRaw": "agent.destroy()",
              "type": "method",
              "name": "destroy",
              "meta": {
                "added": [
                  "v0.11.4"
                ]
              },
              "desc": "
Destroy any sockets that are currently in use by the agent.
\n
It is usually not necessary to do this.  However, if you are using an\nagent with KeepAlive enabled, then it is best to explicitly shut down\nthe agent when you know that it will no longer be used.  Otherwise,\nsockets may hang open for quite a long time before the server\nterminates them.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "agent.getName(options)",
              "type": "method",
              "name": "getName",
              "meta": {
                "added": [
                  "v0.11.4"
                ]
              },
              "desc": "
Get a unique name for a set of request options, to determine whether a\nconnection can be reused.  In the http agent, this returns\nhost:port:localAddress.  In the https agent, the name includes the\nCA, cert, ciphers, and other HTTPS/TLS-specific options that determine\nsocket reusability.
\n
Options:
\n
    \n
  • host: A domain name or IP address of the server to issue the request to.
    • \n
  • port: Port of remote server.
    • \n
  • localAddress: Local interface to bind for network connections when issuing\nthe request.
    • \n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "options"
                    }
                  ]
                }
              ]
            }
          ],
          "properties": [
            {
              "textRaw": "agent.freeSockets",
              "name": "freeSockets",
              "meta": {
                "added": [
                  "v0.11.4"
                ]
              },
              "desc": "
An object which contains arrays of sockets currently awaiting use by\nthe Agent when HTTP KeepAlive is used.  Do not modify.
\n"
            },
            {
              "textRaw": "agent.maxFreeSockets",
              "name": "maxFreeSockets",
              "meta": {
                "added": [
                  "v0.11.7"
                ]
              },
              "desc": "
By default set to 256.  For Agents supporting HTTP KeepAlive, this\nsets the maximum number of sockets that will be left open in the free\nstate.
\n"
            },
            {
              "textRaw": "agent.maxSockets",
              "name": "maxSockets",
              "meta": {
                "added": [
                  "v0.3.6"
                ]
              },
              "desc": "
By default set to Infinity. Determines how many concurrent sockets the agent\ncan have open per origin. Origin is either a 'host:port' or\n'host:port:localAddress' combination.
\n"
            },
            {
              "textRaw": "agent.requests",
              "name": "requests",
              "meta": {
                "added": [
                  "v0.5.9"
                ]
              },
              "desc": "
An object which contains queues of requests that have not yet been assigned to\nsockets. Do not modify.
\n"
            },
            {
              "textRaw": "agent.sockets",
              "name": "sockets",
              "meta": {
                "added": [
                  "v0.3.6"
                ]
              },
              "desc": "
An object which contains arrays of sockets currently in use by the\nAgent.  Do not modify.
\n"
            }
          ],
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`options` {Object} Set of configurable options to set on the agent. Can have the following fields: ",
                  "options": [
                    {
                      "textRaw": "`keepAlive` {Boolean} Keep sockets around even when there are no outstanding requests, so they can be used for future requests without having to reestablish a TCP connection. Default = `false` ",
                      "name": "keepAlive",
                      "type": "Boolean",
                      "desc": "Keep sockets around even when there are no outstanding requests, so they can be used for future requests without having to reestablish a TCP connection. Default = `false`"
                    },
                    {
                      "textRaw": "`keepAliveMsecs` {Integer} When using the `keepAlive` option, specifies the [initial delay](net.html#net_socket_setkeepalive_enable_initialdelay) for TCP Keep-Alive packets. Ignored when the `keepAlive` option is `false` or `undefined`. Default = `1000`. ",
                      "name": "keepAliveMsecs",
                      "type": "Integer",
                      "desc": "When using the `keepAlive` option, specifies the [initial delay](net.html#net_socket_setkeepalive_enable_initialdelay) for TCP Keep-Alive packets. Ignored when the `keepAlive` option is `false` or `undefined`. Default = `1000`."
                    },
                    {
                      "textRaw": "`maxSockets` {Number} Maximum number of sockets to allow per host.  Default = `Infinity`. ",
                      "name": "maxSockets",
                      "type": "Number",
                      "desc": "Maximum number of sockets to allow per host.  Default = `Infinity`."
                    },
                    {
                      "textRaw": "`maxFreeSockets` {Number} Maximum number of sockets to leave open in a free state.  Only relevant if `keepAlive` is set to `true`. Default = `256`. ",
                      "name": "maxFreeSockets",
                      "type": "Number",
                      "desc": "Maximum number of sockets to leave open in a free state.  Only relevant if `keepAlive` is set to `true`. Default = `256`."
                    }
                  ],
                  "name": "options",
                  "type": "Object",
                  "desc": "Set of configurable options to set on the agent. Can have the following fields:",
                  "optional": true
                }
              ],
              "desc": "
The default http.globalAgent that is used by http.request() has all\nof these values set to their respective defaults.
\n
To configure any of them, you must create your own http.Agent object.
\n
const http = require('http');\nvar keepAliveAgent = new http.Agent({ keepAlive: true });\noptions.agent = keepAliveAgent;\nhttp.request(options, onResponseCallback);\n
\n"
            },
            {
              "params": [
                {
                  "name": "options",
                  "optional": true
                }
              ],
              "desc": "
The default http.globalAgent that is used by http.request() has all\nof these values set to their respective defaults.
\n
To configure any of them, you must create your own http.Agent object.
\n
const http = require('http');\nvar keepAliveAgent = new http.Agent({ keepAlive: true });\noptions.agent = keepAliveAgent;\nhttp.request(options, onResponseCallback);\n
\n"
            }
          ]
        },
        {
          "textRaw": "Class: http.ClientRequest",
          "type": "class",
          "name": "http.ClientRequest",
          "meta": {
            "added": [
              "v0.1.17"
            ]
          },
          "desc": "
This object is created internally and returned from http.request().  It\nrepresents an in-progress request whose header has already been queued.  The\nheader is still mutable using the setHeader(name, value), getHeader(name),\nremoveHeader(name) API.  The actual header will be sent along with the first\ndata chunk or when closing the connection.
\n
To get the response, add a listener for 'response' to the request object.\n'response' will be emitted from the request object when the response\nheaders have been received.  The 'response' event is executed with one\nargument which is an instance of http.IncomingMessage.
\n
During the 'response' event, one can add listeners to the\nresponse object; particularly to listen for the 'data' event.
\n
If no 'response' handler is added, then the response will be\nentirely discarded.  However, if you add a 'response' event handler,\nthen you must consume the data from the response object, either by\ncalling response.read() whenever there is a 'readable' event, or\nby adding a 'data' handler, or by calling the .resume() method.\nUntil the data is consumed, the 'end' event will not fire.  Also, until\nthe data is read it will consume memory that can eventually lead to a\n'process out of memory' error.
\n
Note: Node.js does not check whether Content-Length and the length of the body\nwhich has been transmitted are equal or not.
\n
The request implements the Writable Stream interface. This is an\nEventEmitter with the following events:
\n",
          "events": [
            {
              "textRaw": "Event: 'abort'",
              "type": "event",
              "name": "abort",
              "meta": {
                "added": [
                  "v1.4.1"
                ]
              },
              "desc": "
function () { }
\n
Emitted when the request has been aborted by the client. This event is only\nemitted on the first call to abort().
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'aborted'",
              "type": "event",
              "name": "aborted",
              "meta": {
                "added": [
                  "v0.3.8"
                ]
              },
              "desc": "
function () { }
\n
Emitted when the request has been aborted by the server and the network\nsocket has closed.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'connect'",
              "type": "event",
              "name": "connect",
              "meta": {
                "added": [
                  "v0.7.0"
                ]
              },
              "desc": "
function (response, socket, head) { }
\n
Emitted each time a server responds to a request with a CONNECT method. If this\nevent isn't being listened for, clients receiving a CONNECT method will have\ntheir connections closed.
\n
A client and server pair that shows you how to listen for the 'connect' event:
\n
const http = require('http');\nconst net = require('net');\nconst url = require('url');\n\n// Create an HTTP tunneling proxy\nvar proxy = http.createServer( (req, res) => {\n  res.writeHead(200, {'Content-Type': 'text/plain'});\n  res.end('okay');\n});\nproxy.on('connect', (req, cltSocket, head) => {\n  // connect to an origin server\n  var srvUrl = url.parse(`http://${req.url}`);\n  var srvSocket = net.connect(srvUrl.port, srvUrl.hostname, () => {\n    cltSocket.write('HTTP/1.1 200 Connection Established\\r\\n' +\n                    'Proxy-agent: Node.js-Proxy\\r\\n' +\n                    '\\r\\n');\n    srvSocket.write(head);\n    srvSocket.pipe(cltSocket);\n    cltSocket.pipe(srvSocket);\n  });\n});\n\n// now that proxy is running\nproxy.listen(1337, '127.0.0.1', () => {\n\n  // make a request to a tunneling proxy\n  var options = {\n    port: 1337,\n    hostname: '127.0.0.1',\n    method: 'CONNECT',\n    path: 'www.google.com:80'\n  };\n\n  var req = http.request(options);\n  req.end();\n\n  req.on('connect', (res, socket, head) => {\n    console.log('got connected!');\n\n    // make a request over an HTTP tunnel\n    socket.write('GET / HTTP/1.1\\r\\n' +\n                 'Host: www.google.com:80\\r\\n' +\n                 'Connection: close\\r\\n' +\n                 '\\r\\n');\n    socket.on('data', (chunk) => {\n      console.log(chunk.toString());\n    });\n    socket.on('end', () => {\n      proxy.close();\n    });\n  });\n});\n
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'continue'",
              "type": "event",
              "name": "continue",
              "meta": {
                "added": [
                  "v0.3.2"
                ]
              },
              "desc": "
function () { }
\n
Emitted when the server sends a '100 Continue' HTTP response, usually because\nthe request contained 'Expect: 100-continue'. This is an instruction that\nthe client should send the request body.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'response'",
              "type": "event",
              "name": "response",
              "meta": {
                "added": [
                  "v0.1.0"
                ]
              },
              "desc": "
function (response) { }
\n
Emitted when a response is received to this request. This event is emitted only\nonce. The response argument will be an instance of http.IncomingMessage.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'socket'",
              "type": "event",
              "name": "socket",
              "meta": {
                "added": [
                  "v0.5.3"
                ]
              },
              "desc": "
function (socket) { }
\n
Emitted after a socket is assigned to this request.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'upgrade'",
              "type": "event",
              "name": "upgrade",
              "meta": {
                "added": [
                  "v0.1.94"
                ]
              },
              "desc": "
function (response, socket, head) { }
\n
Emitted each time a server responds to a request with an upgrade. If this\nevent isn't being listened for, clients receiving an upgrade header will have\ntheir connections closed.
\n
A client server pair that show you how to listen for the 'upgrade' event.
\n
const http = require('http');\n\n// Create an HTTP server\nvar srv = http.createServer( (req, res) => {\n  res.writeHead(200, {'Content-Type': 'text/plain'});\n  res.end('okay');\n});\nsrv.on('upgrade', (req, socket, head) => {\n  socket.write('HTTP/1.1 101 Web Socket Protocol Handshake\\r\\n' +\n               'Upgrade: WebSocket\\r\\n' +\n               'Connection: Upgrade\\r\\n' +\n               '\\r\\n');\n\n  socket.pipe(socket); // echo back\n});\n\n// now that server is running\nsrv.listen(1337, '127.0.0.1', () => {\n\n  // make a request\n  var options = {\n    port: 1337,\n    hostname: '127.0.0.1',\n    headers: {\n      'Connection': 'Upgrade',\n      'Upgrade': 'websocket'\n    }\n  };\n\n  var req = http.request(options);\n  req.end();\n\n  req.on('upgrade', (res, socket, upgradeHead) => {\n    console.log('got upgraded!');\n    socket.end();\n    process.exit(0);\n  });\n});\n
\n",
              "params": []
            }
          ],
          "methods": [
            {
              "textRaw": "request.abort()",
              "type": "method",
              "name": "abort",
              "meta": {
                "added": [
                  "v0.3.8"
                ]
              },
              "desc": "
Marks the request as aborting. Calling this will cause remaining data\nin the response to be dropped and the socket to be destroyed.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "request.end([data][, encoding][, callback])",
              "type": "method",
              "name": "end",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Finishes sending the request. If any parts of the body are\nunsent, it will flush them to the stream. If the request is\nchunked, this will send the terminating '0\\r\\n\\r\\n'.
\n
If data is specified, it is equivalent to calling\nresponse.write(data, encoding) followed by request.end(callback).
\n
If callback is specified, it will be called when the request stream\nis finished.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "data",
                      "optional": true
                    },
                    {
                      "name": "encoding",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "request.flushHeaders()",
              "type": "method",
              "name": "flushHeaders",
              "meta": {
                "added": [
                  "v1.6.0"
                ]
              },
              "desc": "
Flush the request headers.
\n
For efficiency reasons, Node.js normally buffers the request headers until you\ncall request.end() or write the first chunk of request data.  It then tries\nhard to pack the request headers and data into a single TCP packet.
\n
That's usually what you want (it saves a TCP round-trip) but not when the first\ndata isn't sent until possibly much later.  request.flushHeaders() lets you bypass\nthe optimization and kickstart the request.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "request.setNoDelay([noDelay])",
              "type": "method",
              "name": "setNoDelay",
              "meta": {
                "added": [
                  "v0.5.9"
                ]
              },
              "desc": "
Once a socket is assigned to this request and is connected\nsocket.setNoDelay() will be called.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "noDelay",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "request.setSocketKeepAlive([enable][, initialDelay])",
              "type": "method",
              "name": "setSocketKeepAlive",
              "meta": {
                "added": [
                  "v0.5.9"
                ]
              },
              "desc": "
Once a socket is assigned to this request and is connected\nsocket.setKeepAlive() will be called.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "enable",
                      "optional": true
                    },
                    {
                      "name": "initialDelay",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "request.setTimeout(timeout[, callback])",
              "type": "method",
              "name": "setTimeout",
              "meta": {
                "added": [
                  "v0.5.9"
                ]
              },
              "desc": "
Once a socket is assigned to this request and is connected\nsocket.setTimeout() will be called.
\n
    \n
  • timeout {Number} Milliseconds before a request is considered to be timed out.
    • \n
  • callback {Function} Optional function to be called when a timeout occurs. Same as binding to the timeout event.
    • \n
\n
Returns request.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "timeout"
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "request.write(chunk[, encoding][, callback])",
              "type": "method",
              "name": "write",
              "meta": {
                "added": [
                  "v0.1.29"
                ]
              },
              "desc": "
Sends a chunk of the body.  By calling this method\nmany times, the user can stream a request body to a\nserver--in that case it is suggested to use the\n['Transfer-Encoding', 'chunked'] header line when\ncreating the request.
\n
The chunk argument should be a Buffer or a string.
\n
The encoding argument is optional and only applies when chunk is a string.\nDefaults to 'utf8'.
\n
The callback argument is optional and will be called when this chunk of data\nis flushed.
\n
Returns request.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "chunk"
                    },
                    {
                      "name": "encoding",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            }
          ],
          "properties": [
            {
              "textRaw": "request.aborted",
              "name": "aborted",
              "meta": {
                "added": [
                  "v0.11.14"
                ]
              },
              "desc": "
If a request has been aborted, this value is the time when the request was\naborted, in milliseconds since 1 January 1970 00:00:00 UTC.
\n"
            }
          ]
        },
        {
          "textRaw": "Class: http.Server",
          "type": "class",
          "name": "http.Server",
          "meta": {
            "added": [
              "v0.1.17"
            ]
          },
          "desc": "
This class inherits from net.Server and has the following additional events:
\n",
          "events": [
            {
              "textRaw": "Event: 'checkContinue'",
              "type": "event",
              "name": "checkContinue",
              "meta": {
                "added": [
                  "v0.3.0"
                ]
              },
              "desc": "
function (request, response) { }
\n
Emitted each time a request with an http Expect: 100-continue is received.\nIf this event isn't listened for, the server will automatically respond\nwith a 100 Continue as appropriate.
\n
Handling this event involves calling response.writeContinue() if the client\nshould continue to send the request body, or generating an appropriate HTTP\nresponse (e.g. 400 Bad Request) if the client should not continue to send the\nrequest body.
\n
Note that when this event is emitted and handled, the 'request' event will\nnot be emitted.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'clientError'",
              "type": "event",
              "name": "clientError",
              "meta": {
                "added": [
                  "v0.1.94"
                ]
              },
              "desc": "
function (exception, socket) { }
\n
If a client connection emits an 'error' event, it will be forwarded here.
\n
socket is the net.Socket object that the error originated from.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'close'",
              "type": "event",
              "name": "close",
              "meta": {
                "added": [
                  "v0.1.4"
                ]
              },
              "desc": "
function () { }
\n
Emitted when the server closes.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'connect'",
              "type": "event",
              "name": "connect",
              "meta": {
                "added": [
                  "v0.7.0"
                ]
              },
              "desc": "
function (request, socket, head) { }
\n
Emitted each time a client requests a http CONNECT method. If this event isn't\nlistened for, then clients requesting a CONNECT method will have their\nconnections closed.
\n
    \n
  • request is the arguments for the http request, as it is in the request\nevent.
    • \n
  • socket is the network socket between the server and client.
    • \n
  • head is an instance of Buffer, the first packet of the tunneling stream,\nthis may be empty.
    • \n
\n
After this event is emitted, the request's socket will not have a 'data'\nevent listener, meaning you will need to bind to it in order to handle data\nsent to the server on that socket.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'connection'",
              "type": "event",
              "name": "connection",
              "meta": {
                "added": [
                  "v0.1.0"
                ]
              },
              "desc": "
function (socket) { }
\n
When a new TCP stream is established. socket is an object of type\nnet.Socket. Usually users will not want to access this event. In\nparticular, the socket will not emit 'readable' events because of how\nthe protocol parser attaches to the socket. The socket can also be\naccessed at request.connection.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'request'",
              "type": "event",
              "name": "request",
              "meta": {
                "added": [
                  "v0.1.0"
                ]
              },
              "desc": "
function (request, response) { }
\n
Emitted each time there is a request. Note that there may be multiple requests\nper connection (in the case of keep-alive connections).\n request is an instance of http.IncomingMessage and response is\nan instance of http.ServerResponse.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'upgrade'",
              "type": "event",
              "name": "upgrade",
              "meta": {
                "added": [
                  "v0.1.94"
                ]
              },
              "desc": "
function (request, socket, head) { }
\n
Emitted each time a client requests a http upgrade. If this event isn't\nlistened for, then clients requesting an upgrade will have their connections\nclosed.
\n
    \n
  • request is the arguments for the http request, as it is in the request\nevent.
    • \n
  • socket is the network socket between the server and client.
    • \n
  • head is an instance of Buffer, the first packet of the upgraded stream,\nthis may be empty.
    • \n
\n
After this event is emitted, the request's socket will not have a 'data'\nevent listener, meaning you will need to bind to it in order to handle data\nsent to the server on that socket.
\n",
              "params": []
            }
          ],
          "methods": [
            {
              "textRaw": "server.close([callback])",
              "type": "method",
              "name": "close",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Stops the server from accepting new connections.  See net.Server.close().
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "server.listen(handle[, callback])",
              "type": "method",
              "name": "listen",
              "meta": {
                "added": [
                  "v0.5.10"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`handle` {Object} ",
                      "name": "handle",
                      "type": "Object"
                    },
                    {
                      "textRaw": "`callback` {Function} ",
                      "name": "callback",
                      "type": "Function",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "handle"
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
The handle object can be set to either a server or socket (anything\nwith an underlying _handle member), or a {fd: <n>} object.
\n
This will cause the server to accept connections on the specified\nhandle, but it is presumed that the file descriptor or handle has\nalready been bound to a port or domain socket.
\n
Listening on a file descriptor is not supported on Windows.
\n
This function is asynchronous. callback will be added as a listener for the\n'listening' event. See also net.Server.listen().
\n
Returns server.
\n"
            },
            {
              "textRaw": "server.listen(path[, callback])",
              "type": "method",
              "name": "listen",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Start a UNIX socket server listening for connections on the given path.
\n
This function is asynchronous. callback will be added as a listener for the\n'listening' event.  See also net.Server.listen(path).
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "path"
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "server.listen([port][, hostname][, backlog][, callback])",
              "type": "method",
              "name": "listen",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Begin accepting connections on the specified port and hostname. If the\nhostname is omitted, the server will accept connections on any IPv6 address\n(::) when IPv6 is available, or any IPv4 address (0.0.0.0) otherwise.\nOmit the port argument, or use a port value of 0, to have the operating system\nassign a random port, which can be retrieved by using server.address().port\nafter the 'listening' event has been emitted.
\n
To listen to a unix socket, supply a filename instead of port and hostname.
\n
Backlog is the maximum length of the queue of pending connections.\nThe actual length will be determined by your OS through sysctl settings such as\ntcp_max_syn_backlog and somaxconn on linux. The default value of this\nparameter is 511 (not 512).
\n
This function is asynchronous. callback will be added as a listener for the\n'listening' event.  See also net.Server.listen(port).
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "port",
                      "optional": true
                    },
                    {
                      "name": "hostname",
                      "optional": true
                    },
                    {
                      "name": "backlog",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "server.setTimeout(msecs, callback)",
              "type": "method",
              "name": "setTimeout",
              "meta": {
                "added": [
                  "v0.9.12"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`msecs` {Number} ",
                      "name": "msecs",
                      "type": "Number"
                    },
                    {
                      "textRaw": "`callback` {Function} ",
                      "name": "callback",
                      "type": "Function"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "msecs"
                    },
                    {
                      "name": "callback"
                    }
                  ]
                }
              ],
              "desc": "
Sets the timeout value for sockets, and emits a 'timeout' event on\nthe Server object, passing the socket as an argument, if a timeout\noccurs.
\n
If there is a 'timeout' event listener on the Server object, then it\nwill be called with the timed-out socket as an argument.
\n
By default, the Server's timeout value is 2 minutes, and sockets are\ndestroyed automatically if they time out.  However, if you assign a\ncallback to the Server's 'timeout' event, then you are responsible\nfor handling socket timeouts.
\n
Returns server.
\n"
            }
          ],
          "properties": [
            {
              "textRaw": "server.maxHeadersCount",
              "name": "maxHeadersCount",
              "meta": {
                "added": [
                  "v0.7.0"
                ]
              },
              "desc": "
Limits maximum incoming headers count, equal to 1000 by default. If set to 0 -\nno limit will be applied.
\n"
            },
            {
              "textRaw": "`timeout` {Number} Default = 120000 (2 minutes) ",
              "type": "Number",
              "name": "timeout",
              "meta": {
                "added": [
                  "v0.9.12"
                ]
              },
              "desc": "
The number of milliseconds of inactivity before a socket is presumed\nto have timed out.
\n
Note that the socket timeout logic is set up on connection, so\nchanging this value only affects new connections to the server, not\nany existing connections.
\n
Set to 0 to disable any kind of automatic timeout behavior on incoming\nconnections.
\n",
              "shortDesc": "Default = 120000 (2 minutes)"
            }
          ]
        },
        {
          "textRaw": "Class: http.ServerResponse",
          "type": "class",
          "name": "http.ServerResponse",
          "meta": {
            "added": [
              "v0.1.17"
            ]
          },
          "desc": "
This object is created internally by a HTTP server--not by the user. It is\npassed as the second parameter to the 'request' event.
\n
The response implements, but does not inherit from, the Writable Stream\ninterface. This is an EventEmitter with the following events:
\n",
          "events": [
            {
              "textRaw": "Event: 'close'",
              "type": "event",
              "name": "close",
              "meta": {
                "added": [
                  "v0.6.7"
                ]
              },
              "desc": "
function () { }
\n
Indicates that the underlying connection was terminated before\nresponse.end() was called or able to flush.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'finish'",
              "type": "event",
              "name": "finish",
              "meta": {
                "added": [
                  "v0.3.6"
                ]
              },
              "desc": "
function () { }
\n
Emitted when the response has been sent. More specifically, this event is\nemitted when the last segment of the response headers and body have been\nhanded off to the operating system for transmission over the network. It\ndoes not imply that the client has received anything yet.
\n
After this event, no more events will be emitted on the response object.
\n",
              "params": []
            }
          ],
          "methods": [
            {
              "textRaw": "response.addTrailers(headers)",
              "type": "method",
              "name": "addTrailers",
              "meta": {
                "added": [
                  "v0.3.0"
                ]
              },
              "desc": "
This method adds HTTP trailing headers (a header but at the end of the\nmessage) to the response.
\n
Trailers will only be emitted if chunked encoding is used for the\nresponse; if it is not (e.g. if the request was HTTP/1.0), they will\nbe silently discarded.
\n
Note that HTTP requires the Trailer header to be sent if you intend to\nemit trailers, with a list of the header fields in its value. E.g.,
\n
response.writeHead(200, { 'Content-Type': 'text/plain',\n                          'Trailer': 'Content-MD5' });\nresponse.write(fileData);\nresponse.addTrailers({'Content-MD5': '7895bf4b8828b55ceaf47747b4bca667'});\nresponse.end();\n
\n
Attempting to set a header field name or value that contains invalid characters\nwill result in a TypeError being thrown.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "headers"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "response.end([data][, encoding][, callback])",
              "type": "method",
              "name": "end",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
This method signals to the server that all of the response headers and body\nhave been sent; that server should consider this message complete.\nThe method, response.end(), MUST be called on each response.
\n
If data is specified, it is equivalent to calling\nresponse.write(data, encoding) followed by response.end(callback).
\n
If callback is specified, it will be called when the response stream\nis finished.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "data",
                      "optional": true
                    },
                    {
                      "name": "encoding",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "response.getHeader(name)",
              "type": "method",
              "name": "getHeader",
              "meta": {
                "added": [
                  "v0.4.0"
                ]
              },
              "desc": "
Reads out a header that's already been queued but not sent to the client.  Note\nthat the name is case insensitive.  This can only be called before headers get\nimplicitly flushed.
\n
Example:
\n
var contentType = response.getHeader('content-type');\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "name"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "response.removeHeader(name)",
              "type": "method",
              "name": "removeHeader",
              "meta": {
                "added": [
                  "v0.4.0"
                ]
              },
              "desc": "
Removes a header that's queued for implicit sending.
\n
Example:
\n
response.removeHeader('Content-Encoding');\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "name"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "response.setHeader(name, value)",
              "type": "method",
              "name": "setHeader",
              "meta": {
                "added": [
                  "v0.4.0"
                ]
              },
              "desc": "
Sets a single header value for implicit headers.  If this header already exists\nin the to-be-sent headers, its value will be replaced.  Use an array of strings\nhere if you need to send multiple headers with the same name.
\n
Example:
\n
response.setHeader('Content-Type', 'text/html');\n
\n
or
\n
response.setHeader('Set-Cookie', ['type=ninja', 'language=javascript']);\n
\n
Attempting to set a header field name or value that contains invalid characters\nwill result in a TypeError being thrown.
\n
When headers have been set with response.setHeader(), they will be merged with\nany headers passed to response.writeHead(), with the headers passed to\nresponse.writeHead() given precedence.
\n
// returns content-type = text/plain\nconst server = http.createServer((req,res) => {\n  res.setHeader('Content-Type', 'text/html');\n  res.setHeader('X-Foo', 'bar');\n  res.writeHead(200, {'Content-Type': 'text/plain'});\n  res.end('ok');\n});\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "name"
                    },
                    {
                      "name": "value"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "response.setTimeout(msecs, callback)",
              "type": "method",
              "name": "setTimeout",
              "meta": {
                "added": [
                  "v0.9.12"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`msecs` {Number} ",
                      "name": "msecs",
                      "type": "Number"
                    },
                    {
                      "textRaw": "`callback` {Function} ",
                      "name": "callback",
                      "type": "Function"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "msecs"
                    },
                    {
                      "name": "callback"
                    }
                  ]
                }
              ],
              "desc": "
Sets the Socket's timeout value to msecs.  If a callback is\nprovided, then it is added as a listener on the 'timeout' event on\nthe response object.
\n
If no 'timeout' listener is added to the request, the response, or\nthe server, then sockets are destroyed when they time out.  If you\nassign a handler on the request, the response, or the server's\n'timeout' events, then it is your responsibility to handle timed out\nsockets.
\n
Returns response.
\n"
            },
            {
              "textRaw": "response.write(chunk[, encoding][, callback])",
              "type": "method",
              "name": "write",
              "meta": {
                "added": [
                  "v0.1.29"
                ]
              },
              "desc": "
If this method is called and response.writeHead() has not been called,\nit will switch to implicit header mode and flush the implicit headers.
\n
This sends a chunk of the response body. This method may\nbe called multiple times to provide successive parts of the body.
\n
chunk can be a string or a buffer. If chunk is a string,\nthe second parameter specifies how to encode it into a byte stream.\nBy default the encoding is 'utf8'. callback will be called when this chunk\nof data is flushed.
\n
Note: This is the raw HTTP body and has nothing to do with\nhigher-level multi-part body encodings that may be used.
\n
The first time response.write() is called, it will send the buffered\nheader information and the first body to the client. The second time\nresponse.write() is called, Node.js assumes you're going to be streaming\ndata, and sends that separately. That is, the response is buffered up to the\nfirst chunk of body.
\n
Returns true if the entire data was flushed successfully to the kernel\nbuffer. Returns false if all or part of the data was queued in user memory.\n'drain' will be emitted when the buffer is free again.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "chunk"
                    },
                    {
                      "name": "encoding",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "response.writeContinue()",
              "type": "method",
              "name": "writeContinue",
              "meta": {
                "added": [
                  "v0.3.0"
                ]
              },
              "desc": "
Sends a HTTP/1.1 100 Continue message to the client, indicating that\nthe request body should be sent. See the 'checkContinue' event on Server.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "response.writeHead(statusCode[, statusMessage][, headers])",
              "type": "method",
              "name": "writeHead",
              "meta": {
                "added": [
                  "v0.1.30"
                ]
              },
              "desc": "
Sends a response header to the request. The status code is a 3-digit HTTP\nstatus code, like 404. The last argument, headers, are the response headers.\nOptionally one can give a human-readable statusMessage as the second\nargument.
\n
Example:
\n
var body = 'hello world';\nresponse.writeHead(200, {\n  'Content-Length': Buffer.byteLength(body),\n  'Content-Type': 'text/plain' });\n
\n
This method must only be called once on a message and it must\nbe called before response.end() is called.
\n
If you call response.write() or response.end() before calling this,\nthe implicit/mutable headers will be calculated and call this function for you.
\n
When headers have been set with response.setHeader(), they will be merged with\nany headers passed to response.writeHead(), with the headers passed to\nresponse.writeHead() given precedence.
\n
// returns content-type = text/plain\nconst server = http.createServer((req,res) => {\n  res.setHeader('Content-Type', 'text/html');\n  res.setHeader('X-Foo', 'bar');\n  res.writeHead(200, {'Content-Type': 'text/plain'});\n  res.end('ok');\n});\n
\n
Note that Content-Length is given in bytes not characters. The above example\nworks because the string 'hello world' contains only single byte characters.\nIf the body contains higher coded characters then Buffer.byteLength()\nshould be used to determine the number of bytes in a given encoding.\nAnd Node.js does not check whether Content-Length and the length of the body\nwhich has been transmitted are equal or not.
\n
Attempting to set a header field name or value that contains invalid characters\nwill result in a TypeError being thrown.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "statusCode"
                    },
                    {
                      "name": "statusMessage",
                      "optional": true
                    },
                    {
                      "name": "headers",
                      "optional": true
                    }
                  ]
                }
              ]
            }
          ],
          "properties": [
            {
              "textRaw": "response.finished",
              "name": "finished",
              "meta": {
                "added": [
                  "v0.0.2"
                ]
              },
              "desc": "
Boolean value that indicates whether the response has completed. Starts\nas false. After response.end() executes, the value will be true.
\n"
            },
            {
              "textRaw": "response.headersSent",
              "name": "headersSent",
              "meta": {
                "added": [
                  "v0.9.3"
                ]
              },
              "desc": "
Boolean (read-only). True if headers were sent, false otherwise.
\n"
            },
            {
              "textRaw": "response.sendDate",
              "name": "sendDate",
              "meta": {
                "added": [
                  "v0.7.5"
                ]
              },
              "desc": "
When true, the Date header will be automatically generated and sent in\nthe response if it is not already present in the headers. Defaults to true.
\n
This should only be disabled for testing; HTTP requires the Date header\nin responses.
\n"
            },
            {
              "textRaw": "response.statusCode",
              "name": "statusCode",
              "meta": {
                "added": [
                  "v0.4.0"
                ]
              },
              "desc": "
When using implicit headers (not calling response.writeHead() explicitly),\nthis property controls the status code that will be sent to the client when\nthe headers get flushed.
\n
Example:
\n
response.statusCode = 404;\n
\n
After response header was sent to the client, this property indicates the\nstatus code which was sent out.
\n"
            },
            {
              "textRaw": "response.statusMessage",
              "name": "statusMessage",
              "meta": {
                "added": [
                  "v0.11.8"
                ]
              },
              "desc": "
When using implicit headers (not calling response.writeHead() explicitly), this property\ncontrols the status message that will be sent to the client when the headers get\nflushed. If this is left as undefined then the standard message for the status\ncode will be used.
\n
Example:
\n
response.statusMessage = 'Not found';\n
\n
After response header was sent to the client, this property indicates the\nstatus message which was sent out.
\n"
            }
          ]
        },
        {
          "textRaw": "Class: http.IncomingMessage",
          "type": "class",
          "name": "http.IncomingMessage",
          "meta": {
            "added": [
              "v0.1.17"
            ]
          },
          "desc": "
An IncomingMessage object is created by http.Server or\nhttp.ClientRequest and passed as the first argument to the 'request'\nand 'response' event respectively. It may be used to access response status,\nheaders and data.
\n
It implements the Readable Stream interface, as well as the\nfollowing additional events, methods, and properties.
\n",
          "events": [
            {
              "textRaw": "Event: 'aborted'",
              "type": "event",
              "name": "aborted",
              "meta": {
                "added": [
                  "v0.3.8"
                ]
              },
              "desc": "
function () { }
\n
Emitted when the request has been aborted by the client and the network\nsocket has closed.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'close'",
              "type": "event",
              "name": "close",
              "meta": {
                "added": [
                  "v0.4.2"
                ]
              },
              "desc": "
function () { }
\n
Indicates that the underlying connection was closed.\nJust like 'end', this event occurs only once per response.
\n",
              "params": []
            }
          ],
          "methods": [
            {
              "textRaw": "message.destroy([error])",
              "type": "method",
              "name": "destroy",
              "meta": {
                "added": [
                  "v0.3.0"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`error` {Error} ",
                      "name": "error",
                      "type": "Error",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "error",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Calls destroy() on the socket that received the IncomingMessage. If error\nis provided, an 'error' event is emitted and error is passed as an argument\nto any listeners on the event.
\n"
            },
            {
              "textRaw": "message.setTimeout(msecs, callback)",
              "type": "method",
              "name": "setTimeout",
              "meta": {
                "added": [
                  "v0.5.9"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`msecs` {Number} ",
                      "name": "msecs",
                      "type": "Number"
                    },
                    {
                      "textRaw": "`callback` {Function} ",
                      "name": "callback",
                      "type": "Function"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "msecs"
                    },
                    {
                      "name": "callback"
                    }
                  ]
                }
              ],
              "desc": "
Calls message.connection.setTimeout(msecs, callback).
\n
Returns message.
\n"
            }
          ],
          "properties": [
            {
              "textRaw": "message.headers",
              "name": "headers",
              "meta": {
                "added": [
                  "v0.1.5"
                ]
              },
              "desc": "
The request/response headers object.
\n
Key-value pairs of header names and values. Header names are lower-cased.\nExample:
\n
// Prints something like:\n//\n// { 'user-agent': 'curl/7.22.0',\n//   host: '127.0.0.1:8000',\n//   accept: '*/*' }\nconsole.log(request.headers);\n
\n
Duplicates in raw headers are handled in the following ways, depending on the\nheader name:
\n
    \n
  • Duplicates of age, authorization, content-length, content-type,\netag, expires, from, host, if-modified-since, if-unmodified-since,\nlast-modified, location, max-forwards, proxy-authorization, referer,\nretry-after, or user-agent are discarded.
    • \n
  • set-cookie is always an array. Duplicates are added to the array.
    • \n
  • For all other headers, the values are joined together with ', '.
    • \n
\n"
            },
            {
              "textRaw": "message.httpVersion",
              "name": "httpVersion",
              "meta": {
                "added": [
                  "v0.1.1"
                ]
              },
              "desc": "
In case of server request, the HTTP version sent by the client. In the case of\nclient response, the HTTP version of the connected-to server.\nProbably either '1.1' or '1.0'.
\n
Also message.httpVersionMajor is the first integer and\nmessage.httpVersionMinor is the second.
\n"
            },
            {
              "textRaw": "message.method",
              "name": "method",
              "meta": {
                "added": [
                  "v0.1.1"
                ]
              },
              "desc": "
Only valid for request obtained from http.Server.
\n
The request method as a string. Read only. Example:\n'GET', 'DELETE'.
\n"
            },
            {
              "textRaw": "message.rawHeaders",
              "name": "rawHeaders",
              "meta": {
                "added": [
                  "v0.11.6"
                ]
              },
              "desc": "
The raw request/response headers list exactly as they were received.
\n
Note that the keys and values are in the same list.  It is not a\nlist of tuples.  So, the even-numbered offsets are key values, and the\nodd-numbered offsets are the associated values.
\n
Header names are not lowercased, and duplicates are not merged.
\n
// Prints something like:\n//\n// [ 'user-agent',\n//   'this is invalid because there can be only one',\n//   'User-Agent',\n//   'curl/7.22.0',\n//   'Host',\n//   '127.0.0.1:8000',\n//   'ACCEPT',\n//   '*/*' ]\nconsole.log(request.rawHeaders);\n
\n"
            },
            {
              "textRaw": "message.rawTrailers",
              "name": "rawTrailers",
              "meta": {
                "added": [
                  "v0.11.6"
                ]
              },
              "desc": "
The raw request/response trailer keys and values exactly as they were\nreceived.  Only populated at the 'end' event.
\n"
            },
            {
              "textRaw": "message.statusCode",
              "name": "statusCode",
              "meta": {
                "added": [
                  "v0.1.1"
                ]
              },
              "desc": "
Only valid for response obtained from http.ClientRequest.
\n
The 3-digit HTTP response status code. E.G. 404.
\n"
            },
            {
              "textRaw": "message.statusMessage",
              "name": "statusMessage",
              "meta": {
                "added": [
                  "v0.11.10"
                ]
              },
              "desc": "
Only valid for response obtained from http.ClientRequest.
\n
The HTTP response status message (reason phrase). E.G. OK or Internal Server Error.
\n"
            },
            {
              "textRaw": "message.socket",
              "name": "socket",
              "meta": {
                "added": [
                  "v0.3.0"
                ]
              },
              "desc": "
The net.Socket object associated with the connection.
\n
With HTTPS support, use request.socket.getPeerCertificate() to obtain the\nclient's authentication details.
\n"
            },
            {
              "textRaw": "message.trailers",
              "name": "trailers",
              "meta": {
                "added": [
                  "v0.3.0"
                ]
              },
              "desc": "
The request/response trailers object. Only populated at the 'end' event.
\n"
            },
            {
              "textRaw": "message.url",
              "name": "url",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Only valid for request obtained from http.Server.
\n
Request URL string. This contains only the URL that is\npresent in the actual HTTP request. If the request is:
\n
GET /status?name=ryan HTTP/1.1\\r\\n\nAccept: text/plain\\r\\n\n\\r\\n\n
Then request.url will be:
\n
'/status?name=ryan'\n
If you would like to parse the URL into its parts, you can use\nrequire('url').parse(request.url).  Example:
\n
$ node\n> require('url').parse('/status?name=ryan')\n{\n  href: '/status?name=ryan',\n  search: '?name=ryan',\n  query: 'name=ryan',\n  pathname: '/status'\n}\n
If you would like to extract the parameters from the query string,\nyou can use the require('querystring').parse function, or pass\ntrue as the second argument to require('url').parse.  Example:
\n
$ node\n> require('url').parse('/status?name=ryan', true)\n{\n  href: '/status?name=ryan',\n  search: '?name=ryan',\n  query: {name: 'ryan'},\n  pathname: '/status'\n}\n
"
            }
          ]
        }
      ],
      "properties": [
        {
          "textRaw": "`METHODS` {Array} ",
          "type": "Array",
          "name": "METHODS",
          "meta": {
            "added": [
              "v0.11.8"
            ]
          },
          "desc": "
A list of the HTTP methods that are supported by the parser.
\n"
        },
        {
          "textRaw": "`STATUS_CODES` {Object} ",
          "type": "Object",
          "name": "STATUS_CODES",
          "meta": {
            "added": [
              "v0.1.22"
            ]
          },
          "desc": "
A collection of all the standard HTTP response status codes, and the\nshort description of each.  For example, http.STATUS_CODES[404] === 'Not\nFound'.
\n"
        },
        {
          "textRaw": "http.globalAgent",
          "name": "globalAgent",
          "meta": {
            "added": [
              "v0.5.9"
            ]
          },
          "desc": "
Global instance of Agent which is used as the default for all http client\nrequests.
\n"
        }
      ],
      "methods": [
        {
          "textRaw": "http.createClient([port][, host])",
          "type": "method",
          "name": "createClient",
          "meta": {
            "added": [
              "v0.1.13"
            ],
            "deprecated": [
              "v0.3.6"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated: Use [`http.request()`][] instead.",
          "desc": "
Constructs a new HTTP client. port and host refer to the server to be\nconnected to.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "port",
                  "optional": true
                },
                {
                  "name": "host",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "http.createServer([requestListener])",
          "type": "method",
          "name": "createServer",
          "meta": {
            "added": [
              "v0.1.13"
            ]
          },
          "desc": "
Returns a new instance of http.Server.
\n
The requestListener is a function which is automatically\nadded to the 'request' event.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "requestListener",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "http.get(options[, callback])",
          "type": "method",
          "name": "get",
          "meta": {
            "added": [
              "v0.3.6"
            ]
          },
          "desc": "
Since most requests are GET requests without bodies, Node.js provides this\nconvenience method. The only difference between this method and http.request()\nis that it sets the method to GET and calls req.end() automatically.
\n
Example:
\n
http.get('http://www.google.com/index.html', (res) => {\n  console.log(`Got response: ${res.statusCode}`);\n  // consume response body\n  res.resume();\n}).on('error', (e) => {\n  console.log(`Got error: ${e.message}`);\n});\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "options"
                },
                {
                  "name": "callback",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "http.request(options[, callback])",
          "type": "method",
          "name": "request",
          "meta": {
            "added": [
              "v0.3.6"
            ]
          },
          "desc": "
Node.js maintains several connections per server to make HTTP requests.\nThis function allows one to transparently issue requests.
\n
options can be an object or a string. If options is a string, it is\nautomatically parsed with url.parse().
\n
Options:
\n
    \n
  • protocol: Protocol to use. Defaults to 'http:'.
    • \n
  • host: A domain name or IP address of the server to issue the request to.\nDefaults to 'localhost'.
    • \n
  • hostname: Alias for host. To support url.parse() hostname is\npreferred over host.
    • \n
  • family: IP address family to use when resolving host and hostname.\nValid values are 4 or 6. When unspecified, both IP v4 and v6 will be\nused.
    • \n
  • port: Port of remote server. Defaults to 80.
    • \n
  • localAddress: Local interface to bind for network connections.
    • \n
  • socketPath: Unix Domain Socket (use one of host:port or socketPath).
    • \n
  • method: A string specifying the HTTP request method. Defaults to 'GET'.
    • \n
  • path: Request path. Defaults to '/'. Should include query string if any.\nE.G. '/index.html?page=12'. An exception is thrown when the request path\ncontains illegal characters. Currently, only spaces are rejected but that\nmay change in the future.
    • \n
  • headers: An object containing request headers.
    • \n
  • auth: Basic authentication i.e. 'user:password' to compute an\nAuthorization header.
    • \n
  • agent: Controls Agent behavior. When an Agent is used request will\ndefault to Connection: keep-alive. Possible values:
      \n
    • undefined (default): use http.globalAgent for this host and port.
      • \n
    • Agent object: explicitly use the passed in Agent.
      • \n
    • false: opts out of connection pooling with an Agent, defaults request to\nConnection: close.
      • \n
    \n
    • \n
\n
The optional callback parameter will be added as a one time listener for\nthe 'response' event.
\n
http.request() returns an instance of the http.ClientRequest\nclass. The ClientRequest instance is a writable stream. If one needs to\nupload a file with a POST request, then write to the ClientRequest object.
\n
Example:
\n
var postData = querystring.stringify({\n  'msg' : 'Hello World!'\n});\n\nvar options = {\n  hostname: 'www.google.com',\n  port: 80,\n  path: '/upload',\n  method: 'POST',\n  headers: {\n    'Content-Type': 'application/x-www-form-urlencoded',\n    'Content-Length': Buffer.byteLength(postData)\n  }\n};\n\nvar req = http.request(options, (res) => {\n  console.log(`STATUS: ${res.statusCode}`);\n  console.log(`HEADERS: ${JSON.stringify(res.headers)}`);\n  res.setEncoding('utf8');\n  res.on('data', (chunk) => {\n    console.log(`BODY: ${chunk}`);\n  });\n  res.on('end', () => {\n    console.log('No more data in response.')\n  })\n});\n\nreq.on('error', (e) => {\n  console.log(`problem with request: ${e.message}`);\n});\n\n// write data to request body\nreq.write(postData);\nreq.end();\n
\n
Note that in the example req.end() was called. With http.request() one\nmust always call req.end() to signify that you're done with the request -\neven if there is no data being written to the request body.
\n
If any error is encountered during the request (be that with DNS resolution,\nTCP level errors, or actual HTTP parse errors) an 'error' event is emitted\non the returned request object. As with all 'error' events, if no listeners\nare registered the error will be thrown.
\n
There are a few special headers that should be noted.
\n
    \n
  • Sending a 'Connection: keep-alive' will notify Node.js that the connection to\nthe server should be persisted until the next request.
    \n
    • \n
  • Sending a 'Content-Length' header will disable the default chunked encoding.
    \n
    • \n
  • Sending an 'Expect' header will immediately send the request headers.\nUsually, when sending 'Expect: 100-continue', you should both set a timeout\nand listen for the 'continue' event. See RFC2616 Section 8.2.3 for more\ninformation.
    \n
    • \n
  • Sending an Authorization header will override using the auth option\nto compute basic authentication.
    \n
    • \n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "options"
                },
                {
                  "name": "callback",
                  "optional": true
                }
              ]
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "HTTP"
    }
  ]
}
node-v4.8.2/doc/api/http.md000644 000766 000024 00000123112 13070706735 015577 0ustar00iojsstaff000000 000000 # HTTP

> Stability: 2 - Stable

To use the HTTP server and client one must `require('http')`.

The HTTP interfaces in Node.js are designed to support many features
of the protocol which have been traditionally difficult to use.
In particular, large, possibly chunk-encoded, messages. The interface is
careful to never buffer entire requests or responses--the
user is able to stream data.

HTTP message headers are represented by an object like this:

```
{ 'content-length': '123',
  'content-type': 'text/plain',
  'connection': 'keep-alive',
  'host': 'mysite.com',
  'accept': '*/*' }
```

Keys are lowercased. Values are not modified.

In order to support the full spectrum of possible HTTP applications, Node.js's
HTTP API is very low-level. It deals with stream handling and message
parsing only. It parses a message into headers and body but it does not
parse the actual headers or the body.

See [`message.headers`][] for details on how duplicate headers are handled.

The raw headers as they were received are retained in the `rawHeaders`
property, which is an array of `[key, value, key2, value2, ...]`.  For
example, the previous message header object might have a `rawHeaders`
list like the following:

```
[ 'ConTent-Length', '123456',
  'content-LENGTH', '123',
  'content-type', 'text/plain',
  'CONNECTION', 'keep-alive',
  'Host', 'mysite.com',
  'accepT', '*/*' ]
```

## Class: http.Agent


The HTTP Agent is used for pooling sockets used in HTTP client
requests.

The HTTP Agent also defaults client requests to using
Connection:keep-alive. If no pending HTTP requests are waiting on a
socket to become free the socket is closed. This means that Node.js's
pool has the benefit of keep-alive when under load but still does not
require developers to manually close the HTTP clients using
KeepAlive.

If you opt into using HTTP KeepAlive, you can create an Agent object
with that flag set to `true`.  (See the [constructor options][].)
Then, the Agent will keep unused sockets in a pool for later use.  They
will be explicitly marked so as to not keep the Node.js process running.
However, it is still a good idea to explicitly [`destroy()`][] KeepAlive
agents when they are no longer in use, so that the Sockets will be shut
down.

Sockets are removed from the agent's pool when the socket emits either
a `'close'` event or a special `'agentRemove'` event. This means that if
you intend to keep one HTTP request open for a long time and don't
want it to stay in the pool you can do something along the lines of:

```js
http.get(options, (res) => {
  // Do stuff
}).on('socket', (socket) => {
  socket.emit('agentRemove');
});
```

Alternatively, you could just opt out of pooling entirely using
`agent:false`:

```js
http.get({
  hostname: 'localhost',
  port: 80,
  path: '/',
  agent: false  // create a new agent just for this one request
}, (res) => {
  // Do stuff with response
})
```

### new Agent([options])


* `options` {Object} Set of configurable options to set on the agent.
  Can have the following fields:
  * `keepAlive` {Boolean} Keep sockets around even when there are no
    outstanding requests, so they can be used for future requests without
    having to reestablish a TCP connection. Default = `false`
  * `keepAliveMsecs` {Integer} When using the `keepAlive` option, specifies
    the [initial delay](net.html#net_socket_setkeepalive_enable_initialdelay)
    for TCP Keep-Alive packets. Ignored when the
    `keepAlive` option is `false` or `undefined`. Default = `1000`.
  * `maxSockets` {Number} Maximum number of sockets to allow per
    host.  Default = `Infinity`.
  * `maxFreeSockets` {Number} Maximum number of sockets to leave open
    in a free state.  Only relevant if `keepAlive` is set to `true`.
    Default = `256`.

The default [`http.globalAgent`][] that is used by [`http.request()`][] has all
of these values set to their respective defaults.

To configure any of them, you must create your own [`http.Agent`][] object.

```js
const http = require('http');
var keepAliveAgent = new http.Agent({ keepAlive: true });
options.agent = keepAliveAgent;
http.request(options, onResponseCallback);
```

### agent.destroy()


Destroy any sockets that are currently in use by the agent.

It is usually not necessary to do this.  However, if you are using an
agent with KeepAlive enabled, then it is best to explicitly shut down
the agent when you know that it will no longer be used.  Otherwise,
sockets may hang open for quite a long time before the server
terminates them.

### agent.freeSockets


An object which contains arrays of sockets currently awaiting use by
the Agent when HTTP KeepAlive is used.  Do not modify.

### agent.getName(options)


Get a unique name for a set of request options, to determine whether a
connection can be reused.  In the http agent, this returns
`host:port:localAddress`.  In the https agent, the name includes the
CA, cert, ciphers, and other HTTPS/TLS-specific options that determine
socket reusability.

Options:

- `host`: A domain name or IP address of the server to issue the request to.
- `port`: Port of remote server.
- `localAddress`: Local interface to bind for network connections when issuing
  the request.

### agent.maxFreeSockets


By default set to 256.  For Agents supporting HTTP KeepAlive, this
sets the maximum number of sockets that will be left open in the free
state.

### agent.maxSockets


By default set to Infinity. Determines how many concurrent sockets the agent
can have open per origin. Origin is either a 'host:port' or
'host:port:localAddress' combination.

### agent.requests


An object which contains queues of requests that have not yet been assigned to
sockets. Do not modify.

### agent.sockets


An object which contains arrays of sockets currently in use by the
Agent.  Do not modify.

## Class: http.ClientRequest


This object is created internally and returned from [`http.request()`][].  It
represents an _in-progress_ request whose header has already been queued.  The
header is still mutable using the `setHeader(name, value)`, `getHeader(name)`,
`removeHeader(name)` API.  The actual header will be sent along with the first
data chunk or when closing the connection.

To get the response, add a listener for `'response'` to the request object.
`'response'` will be emitted from the request object when the response
headers have been received.  The `'response'` event is executed with one
argument which is an instance of [`http.IncomingMessage`][].

During the `'response'` event, one can add listeners to the
response object; particularly to listen for the `'data'` event.

If no `'response'` handler is added, then the response will be
entirely discarded.  However, if you add a `'response'` event handler,
then you **must** consume the data from the response object, either by
calling `response.read()` whenever there is a `'readable'` event, or
by adding a `'data'` handler, or by calling the `.resume()` method.
Until the data is consumed, the `'end'` event will not fire.  Also, until
the data is read it will consume memory that can eventually lead to a
'process out of memory' error.

Note: Node.js does not check whether Content-Length and the length of the body
which has been transmitted are equal or not.

The request implements the [Writable Stream][] interface. This is an
[`EventEmitter`][] with the following events:

### Event: 'abort'


`function () { }`

Emitted when the request has been aborted by the client. This event is only
emitted on the first call to `abort()`.

### Event: 'aborted'


`function () { }`

Emitted when the request has been aborted by the server and the network
socket has closed.

### Event: 'connect'


`function (response, socket, head) { }`

Emitted each time a server responds to a request with a `CONNECT` method. If this
event isn't being listened for, clients receiving a `CONNECT` method will have
their connections closed.

A client and server pair that shows you how to listen for the `'connect'` event:

```js
const http = require('http');
const net = require('net');
const url = require('url');

// Create an HTTP tunneling proxy
var proxy = http.createServer( (req, res) => {
  res.writeHead(200, {'Content-Type': 'text/plain'});
  res.end('okay');
});
proxy.on('connect', (req, cltSocket, head) => {
  // connect to an origin server
  var srvUrl = url.parse(`http://${req.url}`);
  var srvSocket = net.connect(srvUrl.port, srvUrl.hostname, () => {
    cltSocket.write('HTTP/1.1 200 Connection Established\r\n' +
                    'Proxy-agent: Node.js-Proxy\r\n' +
                    '\r\n');
    srvSocket.write(head);
    srvSocket.pipe(cltSocket);
    cltSocket.pipe(srvSocket);
  });
});

// now that proxy is running
proxy.listen(1337, '127.0.0.1', () => {

  // make a request to a tunneling proxy
  var options = {
    port: 1337,
    hostname: '127.0.0.1',
    method: 'CONNECT',
    path: 'www.google.com:80'
  };

  var req = http.request(options);
  req.end();

  req.on('connect', (res, socket, head) => {
    console.log('got connected!');

    // make a request over an HTTP tunnel
    socket.write('GET / HTTP/1.1\r\n' +
                 'Host: www.google.com:80\r\n' +
                 'Connection: close\r\n' +
                 '\r\n');
    socket.on('data', (chunk) => {
      console.log(chunk.toString());
    });
    socket.on('end', () => {
      proxy.close();
    });
  });
});
```

### Event: 'continue'


`function () { }`

Emitted when the server sends a '100 Continue' HTTP response, usually because
the request contained 'Expect: 100-continue'. This is an instruction that
the client should send the request body.

### Event: 'response'


`function (response) { }`

Emitted when a response is received to this request. This event is emitted only
once. The `response` argument will be an instance of [`http.IncomingMessage`][].

### Event: 'socket'


`function (socket) { }`

Emitted after a socket is assigned to this request.

### Event: 'upgrade'


`function (response, socket, head) { }`

Emitted each time a server responds to a request with an upgrade. If this
event isn't being listened for, clients receiving an upgrade header will have
their connections closed.

A client server pair that show you how to listen for the `'upgrade'` event.

```js
const http = require('http');

// Create an HTTP server
var srv = http.createServer( (req, res) => {
  res.writeHead(200, {'Content-Type': 'text/plain'});
  res.end('okay');
});
srv.on('upgrade', (req, socket, head) => {
  socket.write('HTTP/1.1 101 Web Socket Protocol Handshake\r\n' +
               'Upgrade: WebSocket\r\n' +
               'Connection: Upgrade\r\n' +
               '\r\n');

  socket.pipe(socket); // echo back
});

// now that server is running
srv.listen(1337, '127.0.0.1', () => {

  // make a request
  var options = {
    port: 1337,
    hostname: '127.0.0.1',
    headers: {
      'Connection': 'Upgrade',
      'Upgrade': 'websocket'
    }
  };

  var req = http.request(options);
  req.end();

  req.on('upgrade', (res, socket, upgradeHead) => {
    console.log('got upgraded!');
    socket.end();
    process.exit(0);
  });
});
```

### request.abort()


Marks the request as aborting. Calling this will cause remaining data
in the response to be dropped and the socket to be destroyed.

### request.aborted


If a request has been aborted, this value is the time when the request was
aborted, in milliseconds since 1 January 1970 00:00:00 UTC.

### request.end([data][, encoding][, callback])


Finishes sending the request. If any parts of the body are
unsent, it will flush them to the stream. If the request is
chunked, this will send the terminating `'0\r\n\r\n'`.

If `data` is specified, it is equivalent to calling
[`response.write(data, encoding)`][] followed by `request.end(callback)`.

If `callback` is specified, it will be called when the request stream
is finished.

### request.flushHeaders()


Flush the request headers.

For efficiency reasons, Node.js normally buffers the request headers until you
call `request.end()` or write the first chunk of request data.  It then tries
hard to pack the request headers and data into a single TCP packet.

That's usually what you want (it saves a TCP round-trip) but not when the first
data isn't sent until possibly much later.  `request.flushHeaders()` lets you bypass
the optimization and kickstart the request.

### request.setNoDelay([noDelay])


Once a socket is assigned to this request and is connected
[`socket.setNoDelay()`][] will be called.

### request.setSocketKeepAlive([enable][, initialDelay])


Once a socket is assigned to this request and is connected
[`socket.setKeepAlive()`][] will be called.

### request.setTimeout(timeout[, callback])


Once a socket is assigned to this request and is connected
[`socket.setTimeout()`][] will be called.

* `timeout` {Number} Milliseconds before a request is considered to be timed out.
* `callback` {Function} Optional function to be called when a timeout occurs. Same as binding to the `timeout` event.

Returns `request`.

### request.write(chunk[, encoding][, callback])


Sends a chunk of the body.  By calling this method
many times, the user can stream a request body to a
server--in that case it is suggested to use the
`['Transfer-Encoding', 'chunked']` header line when
creating the request.

The `chunk` argument should be a [`Buffer`][] or a string.

The `encoding` argument is optional and only applies when `chunk` is a string.
Defaults to `'utf8'`.

The `callback` argument is optional and will be called when this chunk of data
is flushed.

Returns `request`.

## Class: http.Server


This class inherits from [`net.Server`][] and has the following additional events:

### Event: 'checkContinue'


`function (request, response) { }`

Emitted each time a request with an http Expect: 100-continue is received.
If this event isn't listened for, the server will automatically respond
with a 100 Continue as appropriate.

Handling this event involves calling [`response.writeContinue()`][] if the client
should continue to send the request body, or generating an appropriate HTTP
response (e.g. 400 Bad Request) if the client should not continue to send the
request body.

Note that when this event is emitted and handled, the `'request'` event will
not be emitted.

### Event: 'clientError'


`function (exception, socket) { }`

If a client connection emits an `'error'` event, it will be forwarded here.

`socket` is the [`net.Socket`][] object that the error originated from.

### Event: 'close'


`function () { }`

Emitted when the server closes.

### Event: 'connect'


`function (request, socket, head) { }`

Emitted each time a client requests a http `CONNECT` method. If this event isn't
listened for, then clients requesting a `CONNECT` method will have their
connections closed.

* `request` is the arguments for the http request, as it is in the request
  event.
* `socket` is the network socket between the server and client.
* `head` is an instance of Buffer, the first packet of the tunneling stream,
  this may be empty.

After this event is emitted, the request's socket will not have a `'data'`
event listener, meaning you will need to bind to it in order to handle data
sent to the server on that socket.

### Event: 'connection'


`function (socket) { }`

When a new TCP stream is established. `socket` is an object of type
[`net.Socket`][]. Usually users will not want to access this event. In
particular, the socket will not emit `'readable'` events because of how
the protocol parser attaches to the socket. The `socket` can also be
accessed at `request.connection`.

### Event: 'request'


`function (request, response) { }`

Emitted each time there is a request. Note that there may be multiple requests
per connection (in the case of keep-alive connections).
 `request` is an instance of [`http.IncomingMessage`][] and `response` is
an instance of [`http.ServerResponse`][].

### Event: 'upgrade'


`function (request, socket, head) { }`

Emitted each time a client requests a http upgrade. If this event isn't
listened for, then clients requesting an upgrade will have their connections
closed.

* `request` is the arguments for the http request, as it is in the request
  event.
* `socket` is the network socket between the server and client.
* `head` is an instance of Buffer, the first packet of the upgraded stream,
  this may be empty.

After this event is emitted, the request's socket will not have a `'data'`
event listener, meaning you will need to bind to it in order to handle data
sent to the server on that socket.

### server.close([callback])


Stops the server from accepting new connections.  See [`net.Server.close()`][].

### server.listen(handle[, callback])


* `handle` {Object}
* `callback` {Function}

The `handle` object can be set to either a server or socket (anything
with an underlying `_handle` member), or a `{fd: }` object.

This will cause the server to accept connections on the specified
handle, but it is presumed that the file descriptor or handle has
already been bound to a port or domain socket.

Listening on a file descriptor is not supported on Windows.

This function is asynchronous. `callback` will be added as a listener for the
`'listening'` event. See also [`net.Server.listen()`][].

Returns `server`.

### server.listen(path[, callback])


Start a UNIX socket server listening for connections on the given `path`.

This function is asynchronous. `callback` will be added as a listener for the
`'listening'` event.  See also [`net.Server.listen(path)`][].

### server.listen([port][, hostname][, backlog][, callback])


Begin accepting connections on the specified `port` and `hostname`. If the
`hostname` is omitted, the server will accept connections on any IPv6 address
(`::`) when IPv6 is available, or any IPv4 address (`0.0.0.0`) otherwise.
Omit the port argument, or use a port value of `0`, to have the operating system
assign a random port, which can be retrieved by using `server.address().port`
after the `'listening'` event has been emitted.

To listen to a unix socket, supply a filename instead of port and hostname.

Backlog is the maximum length of the queue of pending connections.
The actual length will be determined by your OS through sysctl settings such as
`tcp_max_syn_backlog` and `somaxconn` on linux. The default value of this
parameter is 511 (not 512).

This function is asynchronous. `callback` will be added as a listener for the
`'listening'` event.  See also [`net.Server.listen(port)`][].

### server.maxHeadersCount


Limits maximum incoming headers count, equal to 1000 by default. If set to 0 -
no limit will be applied.

### server.setTimeout(msecs, callback)


* `msecs` {Number}
* `callback` {Function}

Sets the timeout value for sockets, and emits a `'timeout'` event on
the Server object, passing the socket as an argument, if a timeout
occurs.

If there is a `'timeout'` event listener on the Server object, then it
will be called with the timed-out socket as an argument.

By default, the Server's timeout value is 2 minutes, and sockets are
destroyed automatically if they time out.  However, if you assign a
callback to the Server's `'timeout'` event, then you are responsible
for handling socket timeouts.

Returns `server`.

### server.timeout


* {Number} Default = 120000 (2 minutes)

The number of milliseconds of inactivity before a socket is presumed
to have timed out.

Note that the socket timeout logic is set up on connection, so
changing this value only affects *new* connections to the server, not
any existing connections.

Set to 0 to disable any kind of automatic timeout behavior on incoming
connections.

## Class: http.ServerResponse


This object is created internally by a HTTP server--not by the user. It is
passed as the second parameter to the `'request'` event.

The response implements, but does not inherit from, the [Writable Stream][]
interface. This is an [`EventEmitter`][] with the following events:

### Event: 'close'


`function () { }`

Indicates that the underlying connection was terminated before
[`response.end()`][] was called or able to flush.

### Event: 'finish'


`function () { }`

Emitted when the response has been sent. More specifically, this event is
emitted when the last segment of the response headers and body have been
handed off to the operating system for transmission over the network. It
does not imply that the client has received anything yet.

After this event, no more events will be emitted on the response object.

### response.addTrailers(headers)


This method adds HTTP trailing headers (a header but at the end of the
message) to the response.

Trailers will **only** be emitted if chunked encoding is used for the
response; if it is not (e.g. if the request was HTTP/1.0), they will
be silently discarded.

Note that HTTP requires the `Trailer` header to be sent if you intend to
emit trailers, with a list of the header fields in its value. E.g.,

```js
response.writeHead(200, { 'Content-Type': 'text/plain',
                          'Trailer': 'Content-MD5' });
response.write(fileData);
response.addTrailers({'Content-MD5': '7895bf4b8828b55ceaf47747b4bca667'});
response.end();
```

Attempting to set a header field name or value that contains invalid characters
will result in a [`TypeError`][] being thrown.

### response.end([data][, encoding][, callback])


This method signals to the server that all of the response headers and body
have been sent; that server should consider this message complete.
The method, `response.end()`, MUST be called on each response.

If `data` is specified, it is equivalent to calling
[`response.write(data, encoding)`][] followed by `response.end(callback)`.

If `callback` is specified, it will be called when the response stream
is finished.

### response.finished


Boolean value that indicates whether the response has completed. Starts
as `false`. After [`response.end()`][] executes, the value will be `true`.

### response.getHeader(name)


Reads out a header that's already been queued but not sent to the client.  Note
that the name is case insensitive.  This can only be called before headers get
implicitly flushed.

Example:

```js
var contentType = response.getHeader('content-type');
```

### response.headersSent


Boolean (read-only). True if headers were sent, false otherwise.

### response.removeHeader(name)


Removes a header that's queued for implicit sending.

Example:

```js
response.removeHeader('Content-Encoding');
```

### response.sendDate


When true, the Date header will be automatically generated and sent in
the response if it is not already present in the headers. Defaults to true.

This should only be disabled for testing; HTTP requires the Date header
in responses.

### response.setHeader(name, value)


Sets a single header value for implicit headers.  If this header already exists
in the to-be-sent headers, its value will be replaced.  Use an array of strings
here if you need to send multiple headers with the same name.

Example:

```js
response.setHeader('Content-Type', 'text/html');
```

or

```js
response.setHeader('Set-Cookie', ['type=ninja', 'language=javascript']);
```

Attempting to set a header field name or value that contains invalid characters
will result in a [`TypeError`][] being thrown.

When headers have been set with [`response.setHeader()`][], they will be merged with
any headers passed to [`response.writeHead()`][], with the headers passed to
[`response.writeHead()`][] given precedence.

```js
// returns content-type = text/plain
const server = http.createServer((req,res) => {
  res.setHeader('Content-Type', 'text/html');
  res.setHeader('X-Foo', 'bar');
  res.writeHead(200, {'Content-Type': 'text/plain'});
  res.end('ok');
});
```

### response.setTimeout(msecs, callback)


* `msecs` {Number}
* `callback` {Function}

Sets the Socket's timeout value to `msecs`.  If a callback is
provided, then it is added as a listener on the `'timeout'` event on
the response object.

If no `'timeout'` listener is added to the request, the response, or
the server, then sockets are destroyed when they time out.  If you
assign a handler on the request, the response, or the server's
`'timeout'` events, then it is your responsibility to handle timed out
sockets.

Returns `response`.

### response.statusCode


When using implicit headers (not calling [`response.writeHead()`][] explicitly),
this property controls the status code that will be sent to the client when
the headers get flushed.

Example:

```js
response.statusCode = 404;
```

After response header was sent to the client, this property indicates the
status code which was sent out.

### response.statusMessage


When using implicit headers (not calling [`response.writeHead()`][] explicitly), this property
controls the status message that will be sent to the client when the headers get
flushed. If this is left as `undefined` then the standard message for the status
code will be used.

Example:

```js
response.statusMessage = 'Not found';
```

After response header was sent to the client, this property indicates the
status message which was sent out.

### response.write(chunk[, encoding][, callback])


If this method is called and [`response.writeHead()`][] has not been called,
it will switch to implicit header mode and flush the implicit headers.

This sends a chunk of the response body. This method may
be called multiple times to provide successive parts of the body.

`chunk` can be a string or a buffer. If `chunk` is a string,
the second parameter specifies how to encode it into a byte stream.
By default the `encoding` is `'utf8'`. `callback` will be called when this chunk
of data is flushed.

**Note**: This is the raw HTTP body and has nothing to do with
higher-level multi-part body encodings that may be used.

The first time [`response.write()`][] is called, it will send the buffered
header information and the first body to the client. The second time
[`response.write()`][] is called, Node.js assumes you're going to be streaming
data, and sends that separately. That is, the response is buffered up to the
first chunk of body.

Returns `true` if the entire data was flushed successfully to the kernel
buffer. Returns `false` if all or part of the data was queued in user memory.
`'drain'` will be emitted when the buffer is free again.

### response.writeContinue()


Sends a HTTP/1.1 100 Continue message to the client, indicating that
the request body should be sent. See the [`'checkContinue'`][] event on `Server`.

### response.writeHead(statusCode[, statusMessage][, headers])


Sends a response header to the request. The status code is a 3-digit HTTP
status code, like `404`. The last argument, `headers`, are the response headers.
Optionally one can give a human-readable `statusMessage` as the second
argument.

Example:

```js
var body = 'hello world';
response.writeHead(200, {
  'Content-Length': Buffer.byteLength(body),
  'Content-Type': 'text/plain' });
```

This method must only be called once on a message and it must
be called before [`response.end()`][] is called.

If you call [`response.write()`][] or [`response.end()`][] before calling this,
the implicit/mutable headers will be calculated and call this function for you.

When headers have been set with [`response.setHeader()`][], they will be merged with
any headers passed to [`response.writeHead()`][], with the headers passed to
[`response.writeHead()`][] given precedence.

```js
// returns content-type = text/plain
const server = http.createServer((req,res) => {
  res.setHeader('Content-Type', 'text/html');
  res.setHeader('X-Foo', 'bar');
  res.writeHead(200, {'Content-Type': 'text/plain'});
  res.end('ok');
});
```

Note that Content-Length is given in bytes not characters. The above example
works because the string `'hello world'` contains only single byte characters.
If the body contains higher coded characters then `Buffer.byteLength()`
should be used to determine the number of bytes in a given encoding.
And Node.js does not check whether Content-Length and the length of the body
which has been transmitted are equal or not.

Attempting to set a header field name or value that contains invalid characters
will result in a [`TypeError`][] being thrown.

## Class: http.IncomingMessage


An `IncomingMessage` object is created by [`http.Server`][] or
[`http.ClientRequest`][] and passed as the first argument to the `'request'`
and `'response'` event respectively. It may be used to access response status,
headers and data.

It implements the [Readable Stream][] interface, as well as the
following additional events, methods, and properties.

### Event: 'aborted'


`function () { }`

Emitted when the request has been aborted by the client and the network
socket has closed.

### Event: 'close'


`function () { }`

Indicates that the underlying connection was closed.
Just like `'end'`, this event occurs only once per response.

### message.destroy([error])


* `error` {Error}

Calls `destroy()` on the socket that received the `IncomingMessage`. If `error`
is provided, an `'error'` event is emitted and `error` is passed as an argument
to any listeners on the event.

### message.headers


The request/response headers object.

Key-value pairs of header names and values. Header names are lower-cased.
Example:

```js
// Prints something like:
//
// { 'user-agent': 'curl/7.22.0',
//   host: '127.0.0.1:8000',
//   accept: '*/*' }
console.log(request.headers);
```

Duplicates in raw headers are handled in the following ways, depending on the
header name:

* Duplicates of `age`, `authorization`, `content-length`, `content-type`,
`etag`, `expires`, `from`, `host`, `if-modified-since`, `if-unmodified-since`,
`last-modified`, `location`, `max-forwards`, `proxy-authorization`, `referer`,
`retry-after`, or `user-agent` are discarded.
* `set-cookie` is always an array. Duplicates are added to the array.
* For all other headers, the values are joined together with ', '.

### message.httpVersion


In case of server request, the HTTP version sent by the client. In the case of
client response, the HTTP version of the connected-to server.
Probably either `'1.1'` or `'1.0'`.

Also `message.httpVersionMajor` is the first integer and
`message.httpVersionMinor` is the second.

### message.method


**Only valid for request obtained from [`http.Server`][].**

The request method as a string. Read only. Example:
`'GET'`, `'DELETE'`.

### message.rawHeaders


The raw request/response headers list exactly as they were received.

Note that the keys and values are in the same list.  It is *not* a
list of tuples.  So, the even-numbered offsets are key values, and the
odd-numbered offsets are the associated values.

Header names are not lowercased, and duplicates are not merged.

```js
// Prints something like:
//
// [ 'user-agent',
//   'this is invalid because there can be only one',
//   'User-Agent',
//   'curl/7.22.0',
//   'Host',
//   '127.0.0.1:8000',
//   'ACCEPT',
//   '*/*' ]
console.log(request.rawHeaders);
```

### message.rawTrailers


The raw request/response trailer keys and values exactly as they were
received.  Only populated at the `'end'` event.

### message.setTimeout(msecs, callback)


* `msecs` {Number}
* `callback` {Function}

Calls `message.connection.setTimeout(msecs, callback)`.

Returns `message`.

### message.statusCode


**Only valid for response obtained from [`http.ClientRequest`][].**

The 3-digit HTTP response status code. E.G. `404`.

### message.statusMessage


**Only valid for response obtained from [`http.ClientRequest`][].**

The HTTP response status message (reason phrase). E.G. `OK` or `Internal Server Error`.

### message.socket


The [`net.Socket`][] object associated with the connection.

With HTTPS support, use [`request.socket.getPeerCertificate()`][] to obtain the
client's authentication details.

### message.trailers


The request/response trailers object. Only populated at the `'end'` event.

### message.url


**Only valid for request obtained from [`http.Server`][].**

Request URL string. This contains only the URL that is
present in the actual HTTP request. If the request is:

```
GET /status?name=ryan HTTP/1.1\r\n
Accept: text/plain\r\n
\r\n
```

Then `request.url` will be:

```
'/status?name=ryan'
```

If you would like to parse the URL into its parts, you can use
`require('url').parse(request.url)`.  Example:

```
$ node
> require('url').parse('/status?name=ryan')
{
  href: '/status?name=ryan',
  search: '?name=ryan',
  query: 'name=ryan',
  pathname: '/status'
}
```

If you would like to extract the parameters from the query string,
you can use the `require('querystring').parse` function, or pass
`true` as the second argument to `require('url').parse`.  Example:

```
$ node
> require('url').parse('/status?name=ryan', true)
{
  href: '/status?name=ryan',
  search: '?name=ryan',
  query: {name: 'ryan'},
  pathname: '/status'
}
```

## http.METHODS


* {Array}

A list of the HTTP methods that are supported by the parser.

## http.STATUS_CODES


* {Object}

A collection of all the standard HTTP response status codes, and the
short description of each.  For example, `http.STATUS_CODES[404] === 'Not
Found'`.

## http.createClient([port][, host])


> Stability: 0 - Deprecated: Use [`http.request()`][] instead.

Constructs a new HTTP client. `port` and `host` refer to the server to be
connected to.

## http.createServer([requestListener])


Returns a new instance of [`http.Server`][].

The `requestListener` is a function which is automatically
added to the `'request'` event.

## http.get(options[, callback])


Since most requests are GET requests without bodies, Node.js provides this
convenience method. The only difference between this method and [`http.request()`][]
is that it sets the method to GET and calls `req.end()` automatically.

Example:

```js
http.get('http://www.google.com/index.html', (res) => {
  console.log(`Got response: ${res.statusCode}`);
  // consume response body
  res.resume();
}).on('error', (e) => {
  console.log(`Got error: ${e.message}`);
});
```

## http.globalAgent


Global instance of Agent which is used as the default for all http client
requests.

## http.request(options[, callback])


Node.js maintains several connections per server to make HTTP requests.
This function allows one to transparently issue requests.

`options` can be an object or a string. If `options` is a string, it is
automatically parsed with [`url.parse()`][].

Options:

- `protocol`: Protocol to use. Defaults to `'http:'`.
- `host`: A domain name or IP address of the server to issue the request to.
  Defaults to `'localhost'`.
- `hostname`: Alias for `host`. To support [`url.parse()`][] `hostname` is
  preferred over `host`.
- `family`: IP address family to use when resolving `host` and `hostname`.
  Valid values are `4` or `6`. When unspecified, both IP v4 and v6 will be
  used.
- `port`: Port of remote server. Defaults to 80.
- `localAddress`: Local interface to bind for network connections.
- `socketPath`: Unix Domain Socket (use one of host:port or socketPath).
- `method`: A string specifying the HTTP request method. Defaults to `'GET'`.
- `path`: Request path. Defaults to `'/'`. Should include query string if any.
  E.G. `'/index.html?page=12'`. An exception is thrown when the request path
  contains illegal characters. Currently, only spaces are rejected but that
  may change in the future.
- `headers`: An object containing request headers.
- `auth`: Basic authentication i.e. `'user:password'` to compute an
  Authorization header.
- `agent`: Controls [`Agent`][] behavior. When an Agent is used request will
  default to `Connection: keep-alive`. Possible values:
 - `undefined` (default): use [`http.globalAgent`][] for this host and port.
 - `Agent` object: explicitly use the passed in `Agent`.
 - `false`: opts out of connection pooling with an Agent, defaults request to
   `Connection: close`.

The optional `callback` parameter will be added as a one time listener for
the `'response'` event.

`http.request()` returns an instance of the [`http.ClientRequest`][]
class. The `ClientRequest` instance is a writable stream. If one needs to
upload a file with a POST request, then write to the `ClientRequest` object.

Example:

```js
var postData = querystring.stringify({
  'msg' : 'Hello World!'
});

var options = {
  hostname: 'www.google.com',
  port: 80,
  path: '/upload',
  method: 'POST',
  headers: {
    'Content-Type': 'application/x-www-form-urlencoded',
    'Content-Length': Buffer.byteLength(postData)
  }
};

var req = http.request(options, (res) => {
  console.log(`STATUS: ${res.statusCode}`);
  console.log(`HEADERS: ${JSON.stringify(res.headers)}`);
  res.setEncoding('utf8');
  res.on('data', (chunk) => {
    console.log(`BODY: ${chunk}`);
  });
  res.on('end', () => {
    console.log('No more data in response.')
  })
});

req.on('error', (e) => {
  console.log(`problem with request: ${e.message}`);
});

// write data to request body
req.write(postData);
req.end();
```

Note that in the example `req.end()` was called. With `http.request()` one
must always call `req.end()` to signify that you're done with the request -
even if there is no data being written to the request body.

If any error is encountered during the request (be that with DNS resolution,
TCP level errors, or actual HTTP parse errors) an `'error'` event is emitted
on the returned request object. As with all `'error'` events, if no listeners
are registered the error will be thrown.

There are a few special headers that should be noted.

* Sending a 'Connection: keep-alive' will notify Node.js that the connection to
  the server should be persisted until the next request.

* Sending a 'Content-Length' header will disable the default chunked encoding.

* Sending an 'Expect' header will immediately send the request headers.
  Usually, when sending 'Expect: 100-continue', you should both set a timeout
  and listen for the `'continue'` event. See RFC2616 Section 8.2.3 for more
  information.

* Sending an Authorization header will override using the `auth` option
  to compute basic authentication.

[`'checkContinue'`]: #http_event_checkcontinue
[`'listening'`]: net.html#net_event_listening
[`'response'`]: #http_event_response
[`Agent`]: #http_class_http_agent
[`Buffer`]: buffer.html#buffer_buffer
[`destroy()`]: #http_agent_destroy
[`EventEmitter`]: events.html#events_class_events_eventemitter
[`http.Agent`]: #http_class_http_agent
[`http.ClientRequest`]: #http_class_http_clientrequest
[`http.globalAgent`]: #http_http_globalagent
[`http.IncomingMessage`]: #http_class_http_incomingmessage
[`http.request()`]: #http_http_request_options_callback
[`http.Server`]: #http_class_http_server
[`http.ServerResponse`]: #http_class_http_serverresponse
[`message.headers`]: #http_message_headers
[`net.Server`]: net.html#net_class_net_server
[`net.Server.close()`]: net.html#net_server_close_callback
[`net.Server.listen()`]: net.html#net_server_listen_handle_callback
[`net.Server.listen(path)`]: net.html#net_server_listen_path_callback
[`net.Server.listen(port)`]: net.html#net_server_listen_port_hostname_backlog_callback
[`net.Socket`]: net.html#net_class_net_socket
[`request.socket.getPeerCertificate()`]: tls.html#tls_tlssocket_getpeercertificate_detailed
[`response.end()`]: #http_response_end_data_encoding_callback
[`response.setHeader()`]: #http_response_setheader_name_value
[`response.write()`]: #http_response_write_chunk_encoding_callback
[`response.write(data, encoding)`]: #http_response_write_chunk_encoding_callback
[`response.writeContinue()`]: #http_response_writecontinue
[`response.writeHead()`]: #http_response_writehead_statuscode_statusmessage_headers
[`socket.setKeepAlive()`]: net.html#net_socket_setkeepalive_enable_initialdelay
[`socket.setNoDelay()`]: net.html#net_socket_setnodelay_nodelay
[`socket.setTimeout()`]: net.html#net_socket_settimeout_timeout_callback
[`stream.setEncoding()`]: stream.html#stream_stream_setencoding_encoding
[`TypeError`]: errors.html#errors_class_typeerror
[`url.parse()`]: url.html#url_url_parse_urlstr_parsequerystring_slashesdenotehost
[constructor options]: #http_new_agent_options
[Readable Stream]: stream.html#stream_class_stream_readable
[Writable Stream]: stream.html#stream_class_stream_writable
node-v4.8.2/doc/api/https.html000644 000766 000024 00000041410 13070706740 016322 0ustar00iojsstaff000000 000000 


  
  HTTPS | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

      

        
HTTPS#


Stability: 2 - Stable
HTTPS is the HTTP protocol over TLS/SSL. In Node.js this is implemented as a
separate module.


Class: https.Agent#



Added in: v0.4.5

An Agent object for HTTPS similar to http.Agent.  See https.request()
for more information.


Class: https.Server#



Added in: v0.3.4

This class is a subclass of tls.Server and emits events same as
http.Server. See http.Server for more information.


server.setTimeout(msecs, callback)#



Added in: v0.11.2

See http.Server#setTimeout().


server.timeout#



Added in: v0.11.2

See http.Server#timeout.


https.createServer(options[, requestListener])#



Added in: v0.3.4

Returns a new HTTPS web server object. The options is similar to
tls.createServer().  The requestListener is a function which is
automatically added to the 'request' event.


Example:


// curl -k https://localhost:8000/
const https = require('https');
const fs = require('fs');

const options = {
  key: fs.readFileSync('test/fixtures/keys/agent2-key.pem'),
  cert: fs.readFileSync('test/fixtures/keys/agent2-cert.pem')
};

https.createServer(options, (req, res) => {
  res.writeHead(200);
  res.end('hello world\n');
}).listen(8000);



Or


const https = require('https');
const fs = require('fs');

const options = {
  pfx: fs.readFileSync('server.pfx')
};

https.createServer(options, (req, res) => {
  res.writeHead(200);
  res.end('hello world\n');
}).listen(8000);



server.close([callback])#



Added in: v0.1.90

See http.close() for details.


server.listen(handle[, callback])#


server.listen(path[, callback])#


server.listen(port[, host][, backlog][, callback])#


See http.listen() for details.


https.get(options, callback)#



Added in: v0.3.6

Like http.get() but for HTTPS.


options can be an object or a string. If options is a string, it is
automatically parsed with url.parse().


Example:


const https = require('https');

https.get('https://encrypted.google.com/', (res) => {
  console.log('statusCode:', res.statusCode);
  console.log('headers:', res.headers);

  res.on('data', (d) => {
    process.stdout.write(d);
  });

}).on('error', (e) => {
  console.error(e);
});



https.globalAgent#



Added in: v0.5.9

Global instance of https.Agent for all HTTPS client requests.


https.request(options, callback)#



Added in: v0.3.6

Makes a request to a secure web server.


options can be an object or a string. If options is a string, it is
automatically parsed with url.parse().


All options from http.request() are valid.


Example:


const https = require('https');

var options = {
  hostname: 'encrypted.google.com',
  port: 443,
  path: '/',
  method: 'GET'
};

var req = https.request(options, (res) => {
  console.log('statusCode:', res.statusCode);
  console.log('headers:', res.headers);

  res.on('data', (d) => {
    process.stdout.write(d);
  });
});

req.on('error', (e) => {
  console.error(e);
});
req.end();



The options argument has the following options


    

  • host: A domain name or IP address of the server to issue the request to.
Defaults to 'localhost'.
    • 

  • hostname: Alias for host. To support url.parse() hostname is
preferred over host.
    • 

  • family: IP address family to use when resolving host and hostname.
Valid values are 4 or 6. When unspecified, both IP v4 and v6 will be
used.
    • 

  • port: Port of remote server. Defaults to 443.
    • 

  • localAddress: Local interface to bind for network connections.
    • 

  • socketPath: Unix Domain Socket (use one of host:port or socketPath).
    • 

  • method: A string specifying the HTTP request method. Defaults to 'GET'.
    • 

  • path: Request path. Defaults to '/'. Should include query string if any.
E.G. '/index.html?page=12'. An exception is thrown when the request path
contains illegal characters. Currently, only spaces are rejected but that
may change in the future.
    • 

  • headers: An object containing request headers.
    • 

  • auth: Basic authentication i.e. 'user:password' to compute an
Authorization header.
    • 

  • agent: Controls Agent behavior. When an Agent is used request will
default to Connection: keep-alive. Possible values:
      

    • undefined (default): use globalAgent for this host and port.
      • 

    • Agent object: explicitly use the passed in Agent.
      • 

    • false: opts out of connection pooling with an Agent, defaults request to
Connection: close.
      • 

    

    • 



The following options from tls.connect() can also be specified:


    

  • pfx: Certificate, Private key and CA certificates to use for SSL. Default null.
    • 

  • key: Private key to use for SSL. Default null.
    • 

  • passphrase: A string of passphrase for the private key or pfx. Default null.
    • 

  • cert: Public x509 certificate to use. Default null.
    • 

  • ca: A string, Buffer or array of strings or Buffers of trusted
certificates in PEM format. If this is omitted several well known "root"
CAs will be used, like VeriSign. These are used to authorize connections.
    • 

  • ciphers: A string describing the ciphers to use or exclude. Consult
https://www.openssl.org/docs/apps/ciphers.html#CIPHER-LIST-FORMAT for
details on the format.
    • 

  • rejectUnauthorized: If true, the server certificate is verified against
the list of supplied CAs. An 'error' event is emitted if verification
fails. Verification happens at the connection level, before the HTTP
request is sent. Default true.
    • 

  • secureProtocol: The SSL method to use, e.g. SSLv3_method to force
SSL version 3. The possible values depend on your installation of
OpenSSL and are defined in the constant SSL_METHODS.
    • 

  • servername: Servername for SNI (Server Name Indication) TLS extension.
    • 



In order to specify these options, use a custom Agent.


Example:


var options = {
  hostname: 'encrypted.google.com',
  port: 443,
  path: '/',
  method: 'GET',
  key: fs.readFileSync('test/fixtures/keys/agent2-key.pem'),
  cert: fs.readFileSync('test/fixtures/keys/agent2-cert.pem')
};
options.agent = new https.Agent(options);

var req = https.request(options, (res) => {
  ...
}



Alternatively, opt out of connection pooling by not using an Agent.


Example:


var options = {
  hostname: 'encrypted.google.com',
  port: 443,
  path: '/',
  method: 'GET',
  key: fs.readFileSync('test/fixtures/keys/agent2-key.pem'),
  cert: fs.readFileSync('test/fixtures/keys/agent2-cert.pem'),
  agent: false
};

var req = https.request(options, (res) => {
  ...
}



      

    

  

  
  
  
  



node-v4.8.2/doc/api/https.json000644 000766 000024 00000035302 13070706740 016332 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/https.md",
  "modules": [
    {
      "textRaw": "HTTPS",
      "name": "https",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
HTTPS is the HTTP protocol over TLS/SSL. In Node.js this is implemented as a\nseparate module.
\n",
      "classes": [
        {
          "textRaw": "Class: https.Agent",
          "type": "class",
          "name": "https.Agent",
          "meta": {
            "added": [
              "v0.4.5"
            ]
          },
          "desc": "
An Agent object for HTTPS similar to http.Agent.  See https.request()\nfor more information.
\n"
        },
        {
          "textRaw": "Class: https.Server",
          "type": "class",
          "name": "https.Server",
          "meta": {
            "added": [
              "v0.3.4"
            ]
          },
          "desc": "
This class is a subclass of tls.Server and emits events same as\nhttp.Server. See http.Server for more information.
\n",
          "methods": [
            {
              "textRaw": "server.setTimeout(msecs, callback)",
              "type": "method",
              "name": "setTimeout",
              "meta": {
                "added": [
                  "v0.11.2"
                ]
              },
              "desc": "
See http.Server#setTimeout().
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "msecs"
                    },
                    {
                      "name": "callback"
                    }
                  ]
                }
              ]
            }
          ],
          "properties": [
            {
              "textRaw": "server.timeout",
              "name": "timeout",
              "meta": {
                "added": [
                  "v0.11.2"
                ]
              },
              "desc": "
See http.Server#timeout.
\n"
            }
          ]
        }
      ],
      "methods": [
        {
          "textRaw": "https.createServer(options[, requestListener])",
          "type": "method",
          "name": "createServer",
          "meta": {
            "added": [
              "v0.3.4"
            ]
          },
          "desc": "
Returns a new HTTPS web server object. The options is similar to\ntls.createServer().  The requestListener is a function which is\nautomatically added to the 'request' event.
\n
Example:
\n
// curl -k https://localhost:8000/\nconst https = require('https');\nconst fs = require('fs');\n\nconst options = {\n  key: fs.readFileSync('test/fixtures/keys/agent2-key.pem'),\n  cert: fs.readFileSync('test/fixtures/keys/agent2-cert.pem')\n};\n\nhttps.createServer(options, (req, res) => {\n  res.writeHead(200);\n  res.end('hello world\\n');\n}).listen(8000);\n
\n
Or
\n
const https = require('https');\nconst fs = require('fs');\n\nconst options = {\n  pfx: fs.readFileSync('server.pfx')\n};\n\nhttps.createServer(options, (req, res) => {\n  res.writeHead(200);\n  res.end('hello world\\n');\n}).listen(8000);\n
\n",
          "methods": [
            {
              "textRaw": "server.close([callback])",
              "type": "method",
              "name": "close",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
See http.close() for details.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "server.listen(path[, callback])",
              "type": "method",
              "name": "listen",
              "desc": "
See http.listen() for details.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "port"
                    },
                    {
                      "name": "host",
                      "optional": true
                    },
                    {
                      "name": "backlog",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "path"
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "server.listen(port[, host][, backlog][, callback])",
              "type": "method",
              "name": "listen",
              "desc": "
See http.listen() for details.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "port"
                    },
                    {
                      "name": "host",
                      "optional": true
                    },
                    {
                      "name": "backlog",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            }
          ],
          "signatures": [
            {
              "params": [
                {
                  "name": "options"
                },
                {
                  "name": "requestListener",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "https.get(options, callback)",
          "type": "method",
          "name": "get",
          "meta": {
            "added": [
              "v0.3.6"
            ]
          },
          "desc": "
Like http.get() but for HTTPS.
\n
options can be an object or a string. If options is a string, it is\nautomatically parsed with url.parse().
\n
Example:
\n
const https = require('https');\n\nhttps.get('https://encrypted.google.com/', (res) => {\n  console.log('statusCode:', res.statusCode);\n  console.log('headers:', res.headers);\n\n  res.on('data', (d) => {\n    process.stdout.write(d);\n  });\n\n}).on('error', (e) => {\n  console.error(e);\n});\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "options"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "https.request(options, callback)",
          "type": "method",
          "name": "request",
          "meta": {
            "added": [
              "v0.3.6"
            ]
          },
          "desc": "
Makes a request to a secure web server.
\n
options can be an object or a string. If options is a string, it is\nautomatically parsed with url.parse().
\n
All options from http.request() are valid.
\n
Example:
\n
const https = require('https');\n\nvar options = {\n  hostname: 'encrypted.google.com',\n  port: 443,\n  path: '/',\n  method: 'GET'\n};\n\nvar req = https.request(options, (res) => {\n  console.log('statusCode:', res.statusCode);\n  console.log('headers:', res.headers);\n\n  res.on('data', (d) => {\n    process.stdout.write(d);\n  });\n});\n\nreq.on('error', (e) => {\n  console.error(e);\n});\nreq.end();\n
\n
The options argument has the following options
\n
    \n
  • host: A domain name or IP address of the server to issue the request to.\nDefaults to 'localhost'.
    • \n
  • hostname: Alias for host. To support url.parse() hostname is\npreferred over host.
    • \n
  • family: IP address family to use when resolving host and hostname.\nValid values are 4 or 6. When unspecified, both IP v4 and v6 will be\nused.
    • \n
  • port: Port of remote server. Defaults to 443.
    • \n
  • localAddress: Local interface to bind for network connections.
    • \n
  • socketPath: Unix Domain Socket (use one of host:port or socketPath).
    • \n
  • method: A string specifying the HTTP request method. Defaults to 'GET'.
    • \n
  • path: Request path. Defaults to '/'. Should include query string if any.\nE.G. '/index.html?page=12'. An exception is thrown when the request path\ncontains illegal characters. Currently, only spaces are rejected but that\nmay change in the future.
    • \n
  • headers: An object containing request headers.
    • \n
  • auth: Basic authentication i.e. 'user:password' to compute an\nAuthorization header.
    • \n
  • agent: Controls Agent behavior. When an Agent is used request will\ndefault to Connection: keep-alive. Possible values:
      \n
    • undefined (default): use globalAgent for this host and port.
      • \n
    • Agent object: explicitly use the passed in Agent.
      • \n
    • false: opts out of connection pooling with an Agent, defaults request to\nConnection: close.
      • \n
    \n
    • \n
\n
The following options from tls.connect() can also be specified:
\n
    \n
  • pfx: Certificate, Private key and CA certificates to use for SSL. Default null.
    • \n
  • key: Private key to use for SSL. Default null.
    • \n
  • passphrase: A string of passphrase for the private key or pfx. Default null.
    • \n
  • cert: Public x509 certificate to use. Default null.
    • \n
  • ca: A string, Buffer or array of strings or Buffers of trusted\ncertificates in PEM format. If this is omitted several well known "root"\nCAs will be used, like VeriSign. These are used to authorize connections.
    • \n
  • ciphers: A string describing the ciphers to use or exclude. Consult\nhttps://www.openssl.org/docs/apps/ciphers.html#CIPHER-LIST-FORMAT for\ndetails on the format.
    • \n
  • rejectUnauthorized: If true, the server certificate is verified against\nthe list of supplied CAs. An 'error' event is emitted if verification\nfails. Verification happens at the connection level, before the HTTP\nrequest is sent. Default true.
    • \n
  • secureProtocol: The SSL method to use, e.g. SSLv3_method to force\nSSL version 3. The possible values depend on your installation of\nOpenSSL and are defined in the constant SSL_METHODS.
    • \n
  • servername: Servername for SNI (Server Name Indication) TLS extension.
    • \n
\n
In order to specify these options, use a custom Agent.
\n
Example:
\n
var options = {\n  hostname: 'encrypted.google.com',\n  port: 443,\n  path: '/',\n  method: 'GET',\n  key: fs.readFileSync('test/fixtures/keys/agent2-key.pem'),\n  cert: fs.readFileSync('test/fixtures/keys/agent2-cert.pem')\n};\noptions.agent = new https.Agent(options);\n\nvar req = https.request(options, (res) => {\n  ...\n}\n
\n
Alternatively, opt out of connection pooling by not using an Agent.
\n
Example:
\n
var options = {\n  hostname: 'encrypted.google.com',\n  port: 443,\n  path: '/',\n  method: 'GET',\n  key: fs.readFileSync('test/fixtures/keys/agent2-key.pem'),\n  cert: fs.readFileSync('test/fixtures/keys/agent2-cert.pem'),\n  agent: false\n};\n\nvar req = https.request(options, (res) => {\n  ...\n}\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "options"
                },
                {
                  "name": "callback"
                }
              ]
            }
          ]
        }
      ],
      "properties": [
        {
          "textRaw": "https.globalAgent",
          "name": "globalAgent",
          "meta": {
            "added": [
              "v0.5.9"
            ]
          },
          "desc": "
Global instance of https.Agent for all HTTPS client requests.
\n"
        }
      ],
      "type": "module",
      "displayName": "HTTPS"
    }
  ]
}
node-v4.8.2/doc/api/https.md000644 000766 000024 00000016753 13070706735 015776 0ustar00iojsstaff000000 000000 # HTTPS

> Stability: 2 - Stable

HTTPS is the HTTP protocol over TLS/SSL. In Node.js this is implemented as a
separate module.

## Class: https.Agent


An Agent object for HTTPS similar to [`http.Agent`][].  See [`https.request()`][]
for more information.

## Class: https.Server


This class is a subclass of `tls.Server` and emits events same as
[`http.Server`][]. See [`http.Server`][] for more information.

### server.setTimeout(msecs, callback)


See [`http.Server#setTimeout()`][].

### server.timeout


See [`http.Server#timeout`][].

## https.createServer(options[, requestListener])


Returns a new HTTPS web server object. The `options` is similar to
[`tls.createServer()`][].  The `requestListener` is a function which is
automatically added to the `'request'` event.

Example:

```js
// curl -k https://localhost:8000/
const https = require('https');
const fs = require('fs');

const options = {
  key: fs.readFileSync('test/fixtures/keys/agent2-key.pem'),
  cert: fs.readFileSync('test/fixtures/keys/agent2-cert.pem')
};

https.createServer(options, (req, res) => {
  res.writeHead(200);
  res.end('hello world\n');
}).listen(8000);
```

Or

```js
const https = require('https');
const fs = require('fs');

const options = {
  pfx: fs.readFileSync('server.pfx')
};

https.createServer(options, (req, res) => {
  res.writeHead(200);
  res.end('hello world\n');
}).listen(8000);
```

### server.close([callback])


See [`http.close()`][] for details.

### server.listen(handle[, callback])
### server.listen(path[, callback])
### server.listen(port[, host][, backlog][, callback])

See [`http.listen()`][] for details.

## https.get(options, callback)


Like [`http.get()`][] but for HTTPS.

`options` can be an object or a string. If `options` is a string, it is
automatically parsed with [`url.parse()`][].

Example:

```js
const https = require('https');

https.get('https://encrypted.google.com/', (res) => {
  console.log('statusCode:', res.statusCode);
  console.log('headers:', res.headers);

  res.on('data', (d) => {
    process.stdout.write(d);
  });

}).on('error', (e) => {
  console.error(e);
});
```

## https.globalAgent


Global instance of [`https.Agent`][] for all HTTPS client requests.

## https.request(options, callback)


Makes a request to a secure web server.

`options` can be an object or a string. If `options` is a string, it is
automatically parsed with [`url.parse()`][].

All options from [`http.request()`][] are valid.

Example:

```js
const https = require('https');

var options = {
  hostname: 'encrypted.google.com',
  port: 443,
  path: '/',
  method: 'GET'
};

var req = https.request(options, (res) => {
  console.log('statusCode:', res.statusCode);
  console.log('headers:', res.headers);

  res.on('data', (d) => {
    process.stdout.write(d);
  });
});

req.on('error', (e) => {
  console.error(e);
});
req.end();
```

The options argument has the following options

- `host`: A domain name or IP address of the server to issue the request to.
  Defaults to `'localhost'`.
- `hostname`: Alias for `host`. To support `url.parse()` `hostname` is
  preferred over `host`.
- `family`: IP address family to use when resolving `host` and `hostname`.
  Valid values are `4` or `6`. When unspecified, both IP v4 and v6 will be
  used.
- `port`: Port of remote server. Defaults to 443.
- `localAddress`: Local interface to bind for network connections.
- `socketPath`: Unix Domain Socket (use one of host:port or socketPath).
- `method`: A string specifying the HTTP request method. Defaults to `'GET'`.
- `path`: Request path. Defaults to `'/'`. Should include query string if any.
  E.G. `'/index.html?page=12'`. An exception is thrown when the request path
  contains illegal characters. Currently, only spaces are rejected but that
  may change in the future.
- `headers`: An object containing request headers.
- `auth`: Basic authentication i.e. `'user:password'` to compute an
  Authorization header.
- `agent`: Controls [`Agent`][] behavior. When an Agent is used request will
  default to `Connection: keep-alive`. Possible values:
 - `undefined` (default): use [`globalAgent`][] for this host and port.
 - `Agent` object: explicitly use the passed in `Agent`.
 - `false`: opts out of connection pooling with an Agent, defaults request to
   `Connection: close`.

The following options from [`tls.connect()`][] can also be specified:

- `pfx`: Certificate, Private key and CA certificates to use for SSL. Default `null`.
- `key`: Private key to use for SSL. Default `null`.
- `passphrase`: A string of passphrase for the private key or pfx. Default `null`.
- `cert`: Public x509 certificate to use. Default `null`.
- `ca`: A string, [`Buffer`][] or array of strings or [`Buffer`][]s of trusted
  certificates in PEM format. If this is omitted several well known "root"
  CAs will be used, like VeriSign. These are used to authorize connections.
- `ciphers`: A string describing the ciphers to use or exclude. Consult
   for
  details on the format.
- `rejectUnauthorized`: If `true`, the server certificate is verified against
  the list of supplied CAs. An `'error'` event is emitted if verification
  fails. Verification happens at the connection level, *before* the HTTP
  request is sent. Default `true`.
- `secureProtocol`: The SSL method to use, e.g. `SSLv3_method` to force
  SSL version 3. The possible values depend on your installation of
  OpenSSL and are defined in the constant [`SSL_METHODS`][].
- `servername`: Servername for SNI (Server Name Indication) TLS extension.

In order to specify these options, use a custom [`Agent`][].

Example:

```js
var options = {
  hostname: 'encrypted.google.com',
  port: 443,
  path: '/',
  method: 'GET',
  key: fs.readFileSync('test/fixtures/keys/agent2-key.pem'),
  cert: fs.readFileSync('test/fixtures/keys/agent2-cert.pem')
};
options.agent = new https.Agent(options);

var req = https.request(options, (res) => {
  ...
}
```

Alternatively, opt out of connection pooling by not using an `Agent`.

Example:

```js
var options = {
  hostname: 'encrypted.google.com',
  port: 443,
  path: '/',
  method: 'GET',
  key: fs.readFileSync('test/fixtures/keys/agent2-key.pem'),
  cert: fs.readFileSync('test/fixtures/keys/agent2-cert.pem'),
  agent: false
};

var req = https.request(options, (res) => {
  ...
}
```

[`Agent`]: #https_class_https_agent
[`Buffer`]: buffer.html#buffer_buffer
[`globalAgent`]: #https_https_globalagent
[`http.Agent`]: http.html#http_class_http_agent
[`http.close()`]: http.html#http_server_close_callback
[`http.get()`]: http.html#http_http_get_options_callback
[`http.listen()`]: http.html#http_server_listen_port_hostname_backlog_callback
[`http.request()`]: http.html#http_http_request_options_callback
[`http.Server#setTimeout()`]: http.html#http_server_settimeout_msecs_callback
[`http.Server#timeout`]: http.html#http_server_timeout
[`http.Server`]: http.html#http_class_http_server
[`https.Agent`]: #https_class_https_agent
[`https.request()`]: #https_https_request_options_callback
[`SSL_METHODS`]: https://www.openssl.org/docs/ssl/ssl.html#DEALING-WITH-PROTOCOL-METHODS
[`tls.connect()`]: tls.html#tls_tls_connect_options_callback
[`tls.createServer()`]: tls.html#tls_tls_createserver_options_secureconnectionlistener
[`url.parse()`]: url.html#url_url_parse_urlstr_parsequerystring_slashesdenotehost
node-v4.8.2/doc/api/index.html000644 000766 000024 00000014060 13070706740 016270 0ustar00iojsstaff000000 000000 


  
  Index | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    
  

  
  
  
  



node-v4.8.2/doc/api/index.json000644 000766 000024 00000016735 13070706740 016310 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/index.md",
  "desc": [
    {
      "type": "html",
      "pre": false,
      "text": "\n"
    },
    {
      "type": "space"
    },
    {
      "type": "list_start",
      "ordered": false
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[About these Docs](documentation.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Usage & Example](synopsis.html)"
    },
    {
      "type": "space"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_end"
    },
    {
      "type": "html",
      "pre": false,
      "text": "
\n\n"
    },
    {
      "type": "list_start",
      "ordered": false
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Assertion Testing](assert.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Buffer](buffer.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[C/C++ Addons](addons.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Child Processes](child_process.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Cluster](cluster.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Command Line Options](cli.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Console](console.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Crypto](crypto.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Debugger](debugger.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[DNS](dns.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Domain](domain.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Errors](errors.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Events](events.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[File System](fs.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Globals](globals.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[HTTP](http.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[HTTPS](https.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Modules](modules.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Net](net.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[OS](os.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Path](path.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Process](process.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Punycode](punycode.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Query Strings](querystring.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Readline](readline.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[REPL](repl.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Stream](stream.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[String Decoder](string_decoder.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Timers](timers.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[TLS/SSL](tls.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[TTY](tty.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[UDP/Datagram](dgram.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[URL](url.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Utilities](util.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[V8](v8.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[VM](vm.html)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[ZLIB](zlib.html)"
    },
    {
      "type": "space"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_end"
    },
    {
      "type": "html",
      "pre": false,
      "text": "
\n\n"
    },
    {
      "type": "list_start",
      "ordered": false
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[GitHub Repo & Issue Tracker](https://github.com/nodejs/node)"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_item_start"
    },
    {
      "type": "text",
      "text": "[Mailing List](http://groups.google.com/group/nodejs)"
    },
    {
      "type": "space"
    },
    {
      "type": "list_item_end"
    },
    {
      "type": "list_end"
    },
    {
      "type": "html",
      "pre": false,
      "text": "\n"
    }
  ]
}
node-v4.8.2/doc/api/index.md000644 000766 000024 00000000021 13070706735 015720 0ustar00iojsstaff000000 000000 @include _toc.md
node-v4.8.2/doc/api/modules.html000644 000766 000024 00000102056 13070706740 016634 0ustar00iojsstaff000000 000000 


  
  Modules | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

      

        
Modules#


Stability: 3 - Locked


Node.js has a simple module loading system.  In Node.js, files and modules
are in one-to-one correspondence (each file is treated as a separate module).


As an example, consider a file named foo.js:


const circle = require('./circle.js');
console.log(`The area of a circle of radius 4 is ${circle.area(4)}`);



On the first line, foo.js loads the module circle.js that is in the same
directory as foo.js.


Here are the contents of circle.js:


const PI = Math.PI;

exports.area = (r) => PI * r * r;

exports.circumference = (r) => 2 * PI * r;



The module circle.js has exported the functions area() and
circumference().  To add functions and objects to the root of your module,
you can add them to the special exports object.


Variables local to the module will be private, because the module is wrapped
in a function by Node.js (see module wrapper).
In this example, the variable PI is private to circle.js.


If you want the root of your module's export to be a function (such as a
constructor) or if you want to export a complete object in one assignment
instead of building it one property at a time, assign it to module.exports
instead of exports.


Below, bar.js makes use of the square module, which exports a constructor:


const square = require('./square.js');
var mySquare = square(2);
console.log(`The area of my square is ${mySquare.area()}`);



The square module is defined in square.js:


// assigning to exports will not modify module, must use module.exports
module.exports = (width) => {
  return {
    area: () => width * width
  };
}



The module system is implemented in the require("module") module.


Accessing the main module#



When a file is run directly from Node.js, require.main is set to its
module. That means that you can determine whether a file has been run
directly by testing


require.main === module



For a file foo.js, this will be true if run via node foo.js, but
false if run by require('./foo').


Because module provides a filename property (normally equivalent to
__filename), the entry point of the current application can be obtained
by checking require.main.filename.


Addenda: Package Manager Tips#



The semantics of Node.js's require() function were designed to be general
enough to support a number of reasonable directory structures. Package manager
programs such as dpkg, rpm, and npm will hopefully find it possible to
build native packages from Node.js modules without modification.


Below we give a suggested directory structure that could work:


Let's say that we wanted to have the folder at
/usr/lib/node/<some-package>/<some-version> hold the contents of a
specific version of a package.


Packages can depend on one another. In order to install package foo, you
may have to install a specific version of package bar.  The bar package
may itself have dependencies, and in some cases, these dependencies may even
collide or form cycles.


Since Node.js looks up the realpath of any modules it loads (that is,
resolves symlinks), and then looks for their dependencies in the node_modules
folders as described here, this
situation is very simple to resolve with the following architecture:


    

  • /usr/lib/node/foo/1.2.3/ - Contents of the foo package, version 1.2.3.
    • 

  • /usr/lib/node/bar/4.3.2/ - Contents of the bar package that foo
depends on.
    • 

  • /usr/lib/node/foo/1.2.3/node_modules/bar - Symbolic link to
/usr/lib/node/bar/4.3.2/.
    • 

  • /usr/lib/node/bar/4.3.2/node_modules/* - Symbolic links to the packages
that bar depends on.
    • 



Thus, even if a cycle is encountered, or if there are dependency
conflicts, every module will be able to get a version of its dependency
that it can use.


When the code in the foo package does require('bar'), it will get the
version that is symlinked into /usr/lib/node/foo/1.2.3/node_modules/bar.
Then, when the code in the bar package calls require('quux'), it'll get
the version that is symlinked into
/usr/lib/node/bar/4.3.2/node_modules/quux.


Furthermore, to make the module lookup process even more optimal, rather
than putting packages directly in /usr/lib/node, we could put them in
/usr/lib/node_modules/<name>/<version>.  Then Node.js will not bother
looking for missing dependencies in /usr/node_modules or /node_modules.


In order to make modules available to the Node.js REPL, it might be useful to
also add the /usr/lib/node_modules folder to the $NODE_PATH environment
variable.  Since the module lookups using node_modules folders are all
relative, and based on the real path of the files making the calls to
require(), the packages themselves can be anywhere.


All Together...#



To get the exact filename that will be loaded when require() is called, use
the require.resolve() function.


Putting together all of the above, here is the high-level algorithm
in pseudocode of what require.resolve does:


require(X) from module at path Y
1. If X is a core module,
   a. return the core module
   b. STOP
2. If X begins with './' or '/' or '../'
   a. LOAD_AS_FILE(Y + X)
   b. LOAD_AS_DIRECTORY(Y + X)
3. LOAD_NODE_MODULES(X, dirname(Y))
4. THROW "not found"

LOAD_AS_FILE(X)
1. If X is a file, load X as JavaScript text.  STOP
2. If X.js is a file, load X.js as JavaScript text.  STOP
3. If X.json is a file, parse X.json to a JavaScript Object.  STOP
4. If X.node is a file, load X.node as binary addon.  STOP

LOAD_AS_DIRECTORY(X)
1. If X/package.json is a file,
   a. Parse X/package.json, and look for "main" field.
   b. let M = X + (json main field)
   c. LOAD_AS_FILE(M)
2. If X/index.js is a file, load X/index.js as JavaScript text.  STOP
3. If X/index.json is a file, parse X/index.json to a JavaScript object. STOP
4. If X/index.node is a file, load X/index.node as binary addon.  STOP

LOAD_NODE_MODULES(X, START)
1. let DIRS=NODE_MODULES_PATHS(START)
2. for each DIR in DIRS:
   a. LOAD_AS_FILE(DIR/X)
   b. LOAD_AS_DIRECTORY(DIR/X)

NODE_MODULES_PATHS(START)
1. let PARTS = path split(START)
2. let I = count of PARTS - 1
3. let DIRS = []
4. while I >= 0,
   a. if PARTS[I] = "node_modules" CONTINUE
   b. DIR = path join(PARTS[0 .. I] + "node_modules")
   c. DIRS = DIRS + DIR
   d. let I = I - 1
5. return DIRS

Caching#



Modules are cached after the first time they are loaded.  This means
(among other things) that every call to require('foo') will get
exactly the same object returned, if it would resolve to the same file.


Multiple calls to require('foo') may not cause the module code to be
executed multiple times.  This is an important feature.  With it,
"partially done" objects can be returned, thus allowing transitive
dependencies to be loaded even when they would cause cycles.


If you want to have a module execute code multiple times, then export a
function, and call that function.


Module Caching Caveats#



Modules are cached based on their resolved filename.  Since modules may
resolve to a different filename based on the location of the calling
module (loading from node_modules folders), it is not a guarantee
that require('foo') will always return the exact same object, if it
would resolve to different files.


Additionally, on case-insensitive file systems or operating systems, different
resolved filenames can point to the same file, but the cache will still treat
them as different modules and will reload the file multiple times. For example,
require('./foo') and require('./FOO') return two different objects,
irrespective of whether or not ./foo and ./FOO are the same file.


Core Modules#



Node.js has several modules compiled into the binary.  These modules are
described in greater detail elsewhere in this documentation.


The core modules are defined within Node.js's source and are located in the
lib/ folder.


Core modules are always preferentially loaded if their identifier is
passed to require().  For instance, require('http') will always
return the built in HTTP module, even if there is a file by that name.


Cycles#



When there are circular require() calls, a module might not have finished
executing when it is returned.


Consider this situation:


a.js:


console.log('a starting');
exports.done = false;
const b = require('./b.js');
console.log('in a, b.done = %j', b.done);
exports.done = true;
console.log('a done');

b.js:


console.log('b starting');
exports.done = false;
const a = require('./a.js');
console.log('in b, a.done = %j', a.done);
exports.done = true;
console.log('b done');

main.js:


console.log('main starting');
const a = require('./a.js');
const b = require('./b.js');
console.log('in main, a.done=%j, b.done=%j', a.done, b.done);

When main.js loads a.js, then a.js in turn loads b.js.  At that
point, b.js tries to load a.js.  In order to prevent an infinite
loop, an unfinished copy of the a.js exports object is returned to the
b.js module.  b.js then finishes loading, and its exports object is
provided to the a.js module.


By the time main.js has loaded both modules, they're both finished.
The output of this program would thus be:


$ node main.js
main starting
a starting
b starting
in b, a.done = false
b done
in a, b.done = true
a done
in main, a.done=true, b.done=true

If you have cyclic module dependencies in your program, make sure to
plan accordingly.


File Modules#



If the exact filename is not found, then Node.js will attempt to load the
required filename with the added extensions: .js, .json, and finally
.node.


.js files are interpreted as JavaScript text files, and .json files are
parsed as JSON text files. .node files are interpreted as compiled addon
modules loaded with dlopen.


A required module prefixed with '/' is an absolute path to the file.  For
example, require('/home/marco/foo.js') will load the file at
/home/marco/foo.js.


A required module prefixed with './' is relative to the file calling
require(). That is, circle.js must be in the same directory as foo.js for
require('./circle') to find it.


Without a leading '/', './', or '../' to indicate a file, the module must
either be a core module or is loaded from a node_modules folder.


If the given path does not exist, require() will throw an Error with its
code property set to 'MODULE_NOT_FOUND'.


Folders as Modules#



It is convenient to organize programs and libraries into self-contained
directories, and then provide a single entry point to that library.
There are three ways in which a folder may be passed to require() as
an argument.


The first is to create a package.json file in the root of the folder,
which specifies a main module.  An example package.json file might
look like this:


{ "name" : "some-library",
  "main" : "./lib/some-library.js" }

If this was in a folder at ./some-library, then
require('./some-library') would attempt to load
./some-library/lib/some-library.js.


This is the extent of Node.js's awareness of package.json files.


Note: If the file specified by the "main" entry of package.json is missing
and can not be resolved, Node.js will report the entire module as missing with
the default error:


Error: Cannot find module 'some-library'

If there is no package.json file present in the directory, then Node.js
will attempt to load an index.js or index.node file out of that
directory.  For example, if there was no package.json file in the above
example, then require('./some-library') would attempt to load:


    

  • ./some-library/index.js
    • 

  • ./some-library/index.node
    • 



Loading from node_modules Folders#



If the module identifier passed to require() is not a
core module, and does not begin with '/', '../', or
'./', then Node.js starts at the parent directory of the current module, and
adds /node_modules, and attempts to load the module from that location. Node
will not append node_modules to a path already ending in node_modules.


If it is not found there, then it moves to the parent directory, and so
on, until the root of the file system is reached.


For example, if the file at '/home/ry/projects/foo.js' called
require('bar.js'), then Node.js would look in the following locations, in
this order:


    

  • /home/ry/projects/node_modules/bar.js
    • 

  • /home/ry/node_modules/bar.js
    • 

  • /home/node_modules/bar.js
    • 

  • /node_modules/bar.js
    • 



This allows programs to localize their dependencies, so that they do not
clash.


You can require specific files or sub modules distributed with a module by
including a path suffix after the module name. For instance
require('example-module/path/to/file') would resolve path/to/file
relative to where example-module is located. The suffixed path follows the
same module resolution semantics.


Loading from the global folders#



If the NODE_PATH environment variable is set to a colon-delimited list
of absolute paths, then Node.js will search those paths for modules if they
are not found elsewhere.  (Note: On Windows, NODE_PATH is delimited by
semicolons instead of colons.)


NODE_PATH was originally created to support loading modules from
varying paths before the current module resolution algorithm was frozen.


NODE_PATH is still supported, but is less necessary now that the Node.js
ecosystem has settled on a convention for locating dependent modules.
Sometimes deployments that rely on NODE_PATH show surprising behavior
when people are unaware that NODE_PATH must be set.  Sometimes a
module's dependencies change, causing a different version (or even a
different module) to be loaded as the NODE_PATH is searched.


Additionally, Node.js will search in the following locations:


    

  • 1: $HOME/.node_modules
    • 

  • 2: $HOME/.node_libraries
    • 

  • 3: $PREFIX/lib/node
    • 



Where $HOME is the user's home directory, and $PREFIX is Node.js's
configured node_prefix.


These are mostly for historic reasons.  You are highly encouraged
to place your dependencies locally in node_modules folders.  They
will be loaded faster, and more reliably.


The module wrapper#



Before a module's code is executed, Node.js will wrap it with a function
wrapper that looks like the following:


(function (exports, require, module, __filename, __dirname) {
// Your module code actually lives in here
});



By doing this, Node.js achieves a few things:


    

  • It keeps top-level variables (defined with var, const or let) scoped to
the module rather than the global object.
    • 

  • It helps to provide some global-looking variables that are actually specific
to the module, such as:
      

    • The module and exports objects that the implementor can use to export
values from the module.
      • 

    • The convenience variables __filename and __dirname, containing the
module's absolute filename and directory path.
      • 

    

    • 



The module Object#



Added in: v0.1.16





In each module, the module free variable is a reference to the object
representing the current module.  For convenience, module.exports is
also accessible via the exports module-global. module isn't actually
a global but rather local to each module.


module.children#



Added in: v0.1.16



The module objects required by this one.


module.exports#



Added in: v0.1.16



The module.exports object is created by the Module system. Sometimes this is
not acceptable; many want their module to be an instance of some class. To do
this, assign the desired export object to module.exports. Note that assigning
the desired object to exports will simply rebind the local exports variable,
which is probably not what you want to do.


For example suppose we were making a module called a.js


const EventEmitter = require('events');

module.exports = new EventEmitter();

// Do some work, and after some time emit
// the 'ready' event from the module itself.
setTimeout(() => {
  module.exports.emit('ready');
}, 1000);



Then in another file we could do


const a = require('./a');
a.on('ready', () => {
  console.log('module a is ready');
});



Note that assignment to module.exports must be done immediately. It cannot be
done in any callbacks.  This does not work:


x.js:


setTimeout(() => {
  module.exports = { a: 'hello' };
}, 0);



y.js:


const x = require('./x');
console.log(x.a);



exports shortcut#



Added in: v0.1.16

The exports variable is available within a module's file-level scope, and is
assigned the value of module.exports before the module is evaluated.


It allows a shortcut, so that module.exports.f = ... can be written more
succinctly as exports.f = .... However, be aware that like any variable, if a
new value is assigned to exports, it is no longer bound to module.exports:


module.exports.hello = true; // Exported from require of module
exports = { hello: false };  // Not exported, only available in the module



When the module.exports property is being completely replaced by a new
object, it is common to also reassign exports, for example:


module.exports = exports = function Constructor() {
    // ... etc.



To illustrate the behavior, imagine this hypothetical implementation of
require(), which is quite similar to what is actually done by require():


function require(...) {
  var module = { exports: {} };
  ((module, exports) => {
    // Your module code here. In this example, define a function.
    function some_func() {};
    exports = some_func;
    // At this point, exports is no longer a shortcut to module.exports, and
    // this module will still export an empty default object.
    module.exports = some_func;
    // At this point, the module will now export some_func, instead of the
    // default object.
  })(module, module.exports);
  return module.exports;
}



module.filename#



Added in: v0.1.16



The fully resolved filename to the module.


module.id#



Added in: v0.1.16



The identifier for the module.  Typically this is the fully resolved
filename.


module.loaded#



Added in: v0.1.16



Whether or not the module is done loading, or is in the process of
loading.


module.parent#



Added in: v0.1.16



The module that first required this one.


module.require(id)#



Added in: v0.5.1



The module.require method provides a way to load a module as if
require() was called from the original module.


Note that in order to do this, you must get a reference to the module
object.  Since require() returns the module.exports, and the module is
typically only available within a specific module's code, it must be
explicitly exported in order to be used.


      

    

  

  
  
  
  



node-v4.8.2/doc/api/modules.json000644 000766 000024 00000067143 13070706740 016650 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/modules.md",
  "modules": [
    {
      "textRaw": "Modules",
      "name": "module",
      "stability": 3,
      "stabilityText": "Locked",
      "desc": "
Node.js has a simple module loading system.  In Node.js, files and modules\nare in one-to-one correspondence (each file is treated as a separate module).
\n
As an example, consider a file named foo.js:
\n
const circle = require('./circle.js');\nconsole.log(`The area of a circle of radius 4 is ${circle.area(4)}`);\n
\n
On the first line, foo.js loads the module circle.js that is in the same\ndirectory as foo.js.
\n
Here are the contents of circle.js:
\n
const PI = Math.PI;\n\nexports.area = (r) => PI * r * r;\n\nexports.circumference = (r) => 2 * PI * r;\n
\n
The module circle.js has exported the functions area() and\ncircumference().  To add functions and objects to the root of your module,\nyou can add them to the special exports object.
\n
Variables local to the module will be private, because the module is wrapped\nin a function by Node.js (see module wrapper).\nIn this example, the variable PI is private to circle.js.
\n
If you want the root of your module's export to be a function (such as a\nconstructor) or if you want to export a complete object in one assignment\ninstead of building it one property at a time, assign it to module.exports\ninstead of exports.
\n
Below, bar.js makes use of the square module, which exports a constructor:
\n
const square = require('./square.js');\nvar mySquare = square(2);\nconsole.log(`The area of my square is ${mySquare.area()}`);\n
\n
The square module is defined in square.js:
\n
// assigning to exports will not modify module, must use module.exports\nmodule.exports = (width) => {\n  return {\n    area: () => width * width\n  };\n}\n
\n
The module system is implemented in the require("module") module.
\n",
      "miscs": [
        {
          "textRaw": "Accessing the main module",
          "name": "Accessing the main module",
          "type": "misc",
          "desc": "
When a file is run directly from Node.js, require.main is set to its\nmodule. That means that you can determine whether a file has been run\ndirectly by testing
\n
require.main === module\n
\n
For a file foo.js, this will be true if run via node foo.js, but\nfalse if run by require('./foo').
\n
Because module provides a filename property (normally equivalent to\n__filename), the entry point of the current application can be obtained\nby checking require.main.filename.
\n"
        },
        {
          "textRaw": "Addenda: Package Manager Tips",
          "name": "Addenda: Package Manager Tips",
          "type": "misc",
          "desc": "
The semantics of Node.js's require() function were designed to be general\nenough to support a number of reasonable directory structures. Package manager\nprograms such as dpkg, rpm, and npm will hopefully find it possible to\nbuild native packages from Node.js modules without modification.
\n
Below we give a suggested directory structure that could work:
\n
Let's say that we wanted to have the folder at\n/usr/lib/node/<some-package>/<some-version> hold the contents of a\nspecific version of a package.
\n
Packages can depend on one another. In order to install package foo, you\nmay have to install a specific version of package bar.  The bar package\nmay itself have dependencies, and in some cases, these dependencies may even\ncollide or form cycles.
\n
Since Node.js looks up the realpath of any modules it loads (that is,\nresolves symlinks), and then looks for their dependencies in the node_modules\nfolders as described here, this\nsituation is very simple to resolve with the following architecture:
\n
    \n
  • /usr/lib/node/foo/1.2.3/ - Contents of the foo package, version 1.2.3.
    • \n
  • /usr/lib/node/bar/4.3.2/ - Contents of the bar package that foo\ndepends on.
    • \n
  • /usr/lib/node/foo/1.2.3/node_modules/bar - Symbolic link to\n/usr/lib/node/bar/4.3.2/.
    • \n
  • /usr/lib/node/bar/4.3.2/node_modules/* - Symbolic links to the packages\nthat bar depends on.
    • \n
\n
Thus, even if a cycle is encountered, or if there are dependency\nconflicts, every module will be able to get a version of its dependency\nthat it can use.
\n
When the code in the foo package does require('bar'), it will get the\nversion that is symlinked into /usr/lib/node/foo/1.2.3/node_modules/bar.\nThen, when the code in the bar package calls require('quux'), it'll get\nthe version that is symlinked into\n/usr/lib/node/bar/4.3.2/node_modules/quux.
\n
Furthermore, to make the module lookup process even more optimal, rather\nthan putting packages directly in /usr/lib/node, we could put them in\n/usr/lib/node_modules/<name>/<version>.  Then Node.js will not bother\nlooking for missing dependencies in /usr/node_modules or /node_modules.
\n
In order to make modules available to the Node.js REPL, it might be useful to\nalso add the /usr/lib/node_modules folder to the $NODE_PATH environment\nvariable.  Since the module lookups using node_modules folders are all\nrelative, and based on the real path of the files making the calls to\nrequire(), the packages themselves can be anywhere.
\n"
        },
        {
          "textRaw": "All Together...",
          "name": "All Together...",
          "type": "misc",
          "desc": "
To get the exact filename that will be loaded when require() is called, use\nthe require.resolve() function.
\n
Putting together all of the above, here is the high-level algorithm\nin pseudocode of what require.resolve does:
\n
require(X) from module at path Y\n1. If X is a core module,\n   a. return the core module\n   b. STOP\n2. If X begins with './' or '/' or '../'\n   a. LOAD_AS_FILE(Y + X)\n   b. LOAD_AS_DIRECTORY(Y + X)\n3. LOAD_NODE_MODULES(X, dirname(Y))\n4. THROW "not found"\n\nLOAD_AS_FILE(X)\n1. If X is a file, load X as JavaScript text.  STOP\n2. If X.js is a file, load X.js as JavaScript text.  STOP\n3. If X.json is a file, parse X.json to a JavaScript Object.  STOP\n4. If X.node is a file, load X.node as binary addon.  STOP\n\nLOAD_AS_DIRECTORY(X)\n1. If X/package.json is a file,\n   a. Parse X/package.json, and look for "main" field.\n   b. let M = X + (json main field)\n   c. LOAD_AS_FILE(M)\n2. If X/index.js is a file, load X/index.js as JavaScript text.  STOP\n3. If X/index.json is a file, parse X/index.json to a JavaScript object. STOP\n4. If X/index.node is a file, load X/index.node as binary addon.  STOP\n\nLOAD_NODE_MODULES(X, START)\n1. let DIRS=NODE_MODULES_PATHS(START)\n2. for each DIR in DIRS:\n   a. LOAD_AS_FILE(DIR/X)\n   b. LOAD_AS_DIRECTORY(DIR/X)\n\nNODE_MODULES_PATHS(START)\n1. let PARTS = path split(START)\n2. let I = count of PARTS - 1\n3. let DIRS = []\n4. while I >= 0,\n   a. if PARTS[I] = "node_modules" CONTINUE\n   b. DIR = path join(PARTS[0 .. I] + "node_modules")\n   c. DIRS = DIRS + DIR\n   d. let I = I - 1\n5. return DIRS\n
"
        },
        {
          "textRaw": "Caching",
          "name": "Caching",
          "type": "misc",
          "desc": "
Modules are cached after the first time they are loaded.  This means\n(among other things) that every call to require('foo') will get\nexactly the same object returned, if it would resolve to the same file.
\n
Multiple calls to require('foo') may not cause the module code to be\nexecuted multiple times.  This is an important feature.  With it,\n"partially done" objects can be returned, thus allowing transitive\ndependencies to be loaded even when they would cause cycles.
\n
If you want to have a module execute code multiple times, then export a\nfunction, and call that function.
\n",
          "miscs": [
            {
              "textRaw": "Module Caching Caveats",
              "name": "Module Caching Caveats",
              "type": "misc",
              "desc": "
Modules are cached based on their resolved filename.  Since modules may\nresolve to a different filename based on the location of the calling\nmodule (loading from node_modules folders), it is not a guarantee\nthat require('foo') will always return the exact same object, if it\nwould resolve to different files.
\n
Additionally, on case-insensitive file systems or operating systems, different\nresolved filenames can point to the same file, but the cache will still treat\nthem as different modules and will reload the file multiple times. For example,\nrequire('./foo') and require('./FOO') return two different objects,\nirrespective of whether or not ./foo and ./FOO are the same file.
\n"
            }
          ]
        },
        {
          "textRaw": "Core Modules",
          "name": "Core Modules",
          "type": "misc",
          "desc": "
Node.js has several modules compiled into the binary.  These modules are\ndescribed in greater detail elsewhere in this documentation.
\n
The core modules are defined within Node.js's source and are located in the\nlib/ folder.
\n
Core modules are always preferentially loaded if their identifier is\npassed to require().  For instance, require('http') will always\nreturn the built in HTTP module, even if there is a file by that name.
\n"
        },
        {
          "textRaw": "Cycles",
          "name": "Cycles",
          "type": "misc",
          "desc": "
When there are circular require() calls, a module might not have finished\nexecuting when it is returned.
\n
Consider this situation:
\n
a.js:
\n
console.log('a starting');\nexports.done = false;\nconst b = require('./b.js');\nconsole.log('in a, b.done = %j', b.done);\nexports.done = true;\nconsole.log('a done');\n
b.js:
\n
console.log('b starting');\nexports.done = false;\nconst a = require('./a.js');\nconsole.log('in b, a.done = %j', a.done);\nexports.done = true;\nconsole.log('b done');\n
main.js:
\n
console.log('main starting');\nconst a = require('./a.js');\nconst b = require('./b.js');\nconsole.log('in main, a.done=%j, b.done=%j', a.done, b.done);\n
When main.js loads a.js, then a.js in turn loads b.js.  At that\npoint, b.js tries to load a.js.  In order to prevent an infinite\nloop, an unfinished copy of the a.js exports object is returned to the\nb.js module.  b.js then finishes loading, and its exports object is\nprovided to the a.js module.
\n
By the time main.js has loaded both modules, they're both finished.\nThe output of this program would thus be:
\n
$ node main.js\nmain starting\na starting\nb starting\nin b, a.done = false\nb done\nin a, b.done = true\na done\nin main, a.done=true, b.done=true\n
If you have cyclic module dependencies in your program, make sure to\nplan accordingly.
\n"
        },
        {
          "textRaw": "File Modules",
          "name": "File Modules",
          "type": "misc",
          "desc": "
If the exact filename is not found, then Node.js will attempt to load the\nrequired filename with the added extensions: .js, .json, and finally\n.node.
\n
.js files are interpreted as JavaScript text files, and .json files are\nparsed as JSON text files. .node files are interpreted as compiled addon\nmodules loaded with dlopen.
\n
A required module prefixed with '/' is an absolute path to the file.  For\nexample, require('/home/marco/foo.js') will load the file at\n/home/marco/foo.js.
\n
A required module prefixed with './' is relative to the file calling\nrequire(). That is, circle.js must be in the same directory as foo.js for\nrequire('./circle') to find it.
\n
Without a leading '/', './', or '../' to indicate a file, the module must\neither be a core module or is loaded from a node_modules folder.
\n
If the given path does not exist, require() will throw an Error with its\ncode property set to 'MODULE_NOT_FOUND'.
\n"
        },
        {
          "textRaw": "Folders as Modules",
          "name": "Folders as Modules",
          "type": "misc",
          "desc": "
It is convenient to organize programs and libraries into self-contained\ndirectories, and then provide a single entry point to that library.\nThere are three ways in which a folder may be passed to require() as\nan argument.
\n
The first is to create a package.json file in the root of the folder,\nwhich specifies a main module.  An example package.json file might\nlook like this:
\n
{ "name" : "some-library",\n  "main" : "./lib/some-library.js" }\n
If this was in a folder at ./some-library, then\nrequire('./some-library') would attempt to load\n./some-library/lib/some-library.js.
\n
This is the extent of Node.js's awareness of package.json files.
\n
Note: If the file specified by the "main" entry of package.json is missing\nand can not be resolved, Node.js will report the entire module as missing with\nthe default error:
\n
Error: Cannot find module 'some-library'\n
If there is no package.json file present in the directory, then Node.js\nwill attempt to load an index.js or index.node file out of that\ndirectory.  For example, if there was no package.json file in the above\nexample, then require('./some-library') would attempt to load:
\n
    \n
  • ./some-library/index.js
    • \n
  • ./some-library/index.node
    • \n
\n"
        },
        {
          "textRaw": "Loading from `node_modules` Folders",
          "name": "Loading from `node_modules` Folders",
          "type": "misc",
          "desc": "
If the module identifier passed to require() is not a\ncore module, and does not begin with '/', '../', or\n'./', then Node.js starts at the parent directory of the current module, and\nadds /node_modules, and attempts to load the module from that location. Node\nwill not append node_modules to a path already ending in node_modules.
\n
If it is not found there, then it moves to the parent directory, and so\non, until the root of the file system is reached.
\n
For example, if the file at '/home/ry/projects/foo.js' called\nrequire('bar.js'), then Node.js would look in the following locations, in\nthis order:
\n
    \n
  • /home/ry/projects/node_modules/bar.js
    • \n
  • /home/ry/node_modules/bar.js
    • \n
  • /home/node_modules/bar.js
    • \n
  • /node_modules/bar.js
    • \n
\n
This allows programs to localize their dependencies, so that they do not\nclash.
\n
You can require specific files or sub modules distributed with a module by\nincluding a path suffix after the module name. For instance\nrequire('example-module/path/to/file') would resolve path/to/file\nrelative to where example-module is located. The suffixed path follows the\nsame module resolution semantics.
\n"
        },
        {
          "textRaw": "Loading from the global folders",
          "name": "Loading from the global folders",
          "type": "misc",
          "desc": "
If the NODE_PATH environment variable is set to a colon-delimited list\nof absolute paths, then Node.js will search those paths for modules if they\nare not found elsewhere.  (Note: On Windows, NODE_PATH is delimited by\nsemicolons instead of colons.)
\n
NODE_PATH was originally created to support loading modules from\nvarying paths before the current module resolution algorithm was frozen.
\n
NODE_PATH is still supported, but is less necessary now that the Node.js\necosystem has settled on a convention for locating dependent modules.\nSometimes deployments that rely on NODE_PATH show surprising behavior\nwhen people are unaware that NODE_PATH must be set.  Sometimes a\nmodule's dependencies change, causing a different version (or even a\ndifferent module) to be loaded as the NODE_PATH is searched.
\n
Additionally, Node.js will search in the following locations:
\n
    \n
  • 1: $HOME/.node_modules
    • \n
  • 2: $HOME/.node_libraries
    • \n
  • 3: $PREFIX/lib/node
    • \n
\n
Where $HOME is the user's home directory, and $PREFIX is Node.js's\nconfigured node_prefix.
\n
These are mostly for historic reasons.  You are highly encouraged\nto place your dependencies locally in node_modules folders.  They\nwill be loaded faster, and more reliably.
\n"
        },
        {
          "textRaw": "The module wrapper",
          "name": "The module wrapper",
          "type": "misc",
          "desc": "
Before a module's code is executed, Node.js will wrap it with a function\nwrapper that looks like the following:
\n
(function (exports, require, module, __filename, __dirname) {\n// Your module code actually lives in here\n});\n
\n
By doing this, Node.js achieves a few things:
\n
    \n
  • It keeps top-level variables (defined with var, const or let) scoped to\nthe module rather than the global object.
    • \n
  • It helps to provide some global-looking variables that are actually specific\nto the module, such as:
      \n
    • The module and exports objects that the implementor can use to export\nvalues from the module.
      • \n
    • The convenience variables __filename and __dirname, containing the\nmodule's absolute filename and directory path.
      • \n
    \n
    • \n
\n"
        }
      ],
      "vars": [
        {
          "textRaw": "The `module` Object",
          "name": "module",
          "meta": {
            "added": [
              "v0.1.16"
            ]
          },
          "type": "var",
          "desc": "
    \n
  • {Object}
    • \n
\n
In each module, the module free variable is a reference to the object\nrepresenting the current module.  For convenience, module.exports is\nalso accessible via the exports module-global. module isn't actually\na global but rather local to each module.
\n",
          "properties": [
            {
              "textRaw": "`children` {Array} ",
              "type": "Array",
              "name": "children",
              "meta": {
                "added": [
                  "v0.1.16"
                ]
              },
              "desc": "
The module objects required by this one.
\n"
            },
            {
              "textRaw": "`exports` {Object} ",
              "type": "Object",
              "name": "exports",
              "meta": {
                "added": [
                  "v0.1.16"
                ]
              },
              "desc": "
The module.exports object is created by the Module system. Sometimes this is\nnot acceptable; many want their module to be an instance of some class. To do\nthis, assign the desired export object to module.exports. Note that assigning\nthe desired object to exports will simply rebind the local exports variable,\nwhich is probably not what you want to do.
\n
For example suppose we were making a module called a.js
\n
const EventEmitter = require('events');\n\nmodule.exports = new EventEmitter();\n\n// Do some work, and after some time emit\n// the 'ready' event from the module itself.\nsetTimeout(() => {\n  module.exports.emit('ready');\n}, 1000);\n
\n
Then in another file we could do
\n
const a = require('./a');\na.on('ready', () => {\n  console.log('module a is ready');\n});\n
\n
Note that assignment to module.exports must be done immediately. It cannot be\ndone in any callbacks.  This does not work:
\n
x.js:
\n
setTimeout(() => {\n  module.exports = { a: 'hello' };\n}, 0);\n
\n
y.js:
\n
const x = require('./x');\nconsole.log(x.a);\n
\n",
              "modules": [
                {
                  "textRaw": "exports shortcut",
                  "name": "exports_shortcut",
                  "meta": {
                    "added": [
                      "v0.1.16"
                    ]
                  },
                  "desc": "
The exports variable is available within a module's file-level scope, and is\nassigned the value of module.exports before the module is evaluated.
\n
It allows a shortcut, so that module.exports.f = ... can be written more\nsuccinctly as exports.f = .... However, be aware that like any variable, if a\nnew value is assigned to exports, it is no longer bound to module.exports:
\n
module.exports.hello = true; // Exported from require of module\nexports = { hello: false };  // Not exported, only available in the module\n
\n
When the module.exports property is being completely replaced by a new\nobject, it is common to also reassign exports, for example:
\n
module.exports = exports = function Constructor() {\n    // ... etc.\n
\n
To illustrate the behavior, imagine this hypothetical implementation of\nrequire(), which is quite similar to what is actually done by require():
\n
function require(...) {\n  var module = { exports: {} };\n  ((module, exports) => {\n    // Your module code here. In this example, define a function.\n    function some_func() {};\n    exports = some_func;\n    // At this point, exports is no longer a shortcut to module.exports, and\n    // this module will still export an empty default object.\n    module.exports = some_func;\n    // At this point, the module will now export some_func, instead of the\n    // default object.\n  })(module, module.exports);\n  return module.exports;\n}\n
\n",
                  "type": "module",
                  "displayName": "exports shortcut"
                }
              ]
            },
            {
              "textRaw": "`filename` {String} ",
              "type": "String",
              "name": "filename",
              "meta": {
                "added": [
                  "v0.1.16"
                ]
              },
              "desc": "
The fully resolved filename to the module.
\n"
            },
            {
              "textRaw": "`id` {String} ",
              "type": "String",
              "name": "id",
              "meta": {
                "added": [
                  "v0.1.16"
                ]
              },
              "desc": "
The identifier for the module.  Typically this is the fully resolved\nfilename.
\n"
            },
            {
              "textRaw": "`loaded` {Boolean} ",
              "type": "Boolean",
              "name": "loaded",
              "meta": {
                "added": [
                  "v0.1.16"
                ]
              },
              "desc": "
Whether or not the module is done loading, or is in the process of\nloading.
\n"
            },
            {
              "textRaw": "`parent` {Object} Module object ",
              "type": "Object",
              "name": "parent",
              "meta": {
                "added": [
                  "v0.1.16"
                ]
              },
              "desc": "
The module that first required this one.
\n",
              "shortDesc": "Module object"
            }
          ],
          "methods": [
            {
              "textRaw": "module.require(id)",
              "type": "method",
              "name": "require",
              "meta": {
                "added": [
                  "v0.5.1"
                ]
              },
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Object} `module.exports` from the resolved module ",
                    "name": "return",
                    "type": "Object",
                    "desc": "`module.exports` from the resolved module"
                  },
                  "params": [
                    {
                      "textRaw": "`id` {String} ",
                      "name": "id",
                      "type": "String"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "id"
                    }
                  ]
                }
              ],
              "desc": "
The module.require method provides a way to load a module as if\nrequire() was called from the original module.
\n
Note that in order to do this, you must get a reference to the module\nobject.  Since require() returns the module.exports, and the module is\ntypically only available within a specific module's code, it must be\nexplicitly exported in order to be used.
\n"
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "module"
    }
  ]
}
node-v4.8.2/doc/api/modules.md000644 000766 000024 00000045747 13070706735 016311 0ustar00iojsstaff000000 000000 # Modules

> Stability: 3 - Locked



Node.js has a simple module loading system.  In Node.js, files and modules
are in one-to-one correspondence (each file is treated as a separate module).

As an example, consider a file named `foo.js`:

```js
const circle = require('./circle.js');
console.log(`The area of a circle of radius 4 is ${circle.area(4)}`);
```

On the first line, `foo.js` loads the module `circle.js` that is in the same
directory as `foo.js`.

Here are the contents of `circle.js`:

```js
const PI = Math.PI;

exports.area = (r) => PI * r * r;

exports.circumference = (r) => 2 * PI * r;
```

The module `circle.js` has exported the functions `area()` and
`circumference()`.  To add functions and objects to the root of your module,
you can add them to the special `exports` object.

Variables local to the module will be private, because the module is wrapped
in a function by Node.js (see [module wrapper](#modules_the_module_wrapper)).
In this example, the variable `PI` is private to `circle.js`.

If you want the root of your module's export to be a function (such as a
constructor) or if you want to export a complete object in one assignment
instead of building it one property at a time, assign it to `module.exports`
instead of `exports`.

Below, `bar.js` makes use of the `square` module, which exports a constructor:

```js
const square = require('./square.js');
var mySquare = square(2);
console.log(`The area of my square is ${mySquare.area()}`);
```

The `square` module is defined in `square.js`:

```js
// assigning to exports will not modify module, must use module.exports
module.exports = (width) => {
  return {
    area: () => width * width
  };
}
```

The module system is implemented in the `require("module")` module.

## Accessing the main module



When a file is run directly from Node.js, `require.main` is set to its
`module`. That means that you can determine whether a file has been run
directly by testing

```js
require.main === module
```

For a file `foo.js`, this will be `true` if run via `node foo.js`, but
`false` if run by `require('./foo')`.

Because `module` provides a `filename` property (normally equivalent to
`__filename`), the entry point of the current application can be obtained
by checking `require.main.filename`.

## Addenda: Package Manager Tips



The semantics of Node.js's `require()` function were designed to be general
enough to support a number of reasonable directory structures. Package manager
programs such as `dpkg`, `rpm`, and `npm` will hopefully find it possible to
build native packages from Node.js modules without modification.

Below we give a suggested directory structure that could work:

Let's say that we wanted to have the folder at
`/usr/lib/node//` hold the contents of a
specific version of a package.

Packages can depend on one another. In order to install package `foo`, you
may have to install a specific version of package `bar`.  The `bar` package
may itself have dependencies, and in some cases, these dependencies may even
collide or form cycles.

Since Node.js looks up the `realpath` of any modules it loads (that is,
resolves symlinks), and then looks for their dependencies in the `node_modules`
folders as described [here](#modules_loading_from_node_modules_folders), this
situation is very simple to resolve with the following architecture:

* `/usr/lib/node/foo/1.2.3/` - Contents of the `foo` package, version 1.2.3.
* `/usr/lib/node/bar/4.3.2/` - Contents of the `bar` package that `foo`
  depends on.
* `/usr/lib/node/foo/1.2.3/node_modules/bar` - Symbolic link to
  `/usr/lib/node/bar/4.3.2/`.
* `/usr/lib/node/bar/4.3.2/node_modules/*` - Symbolic links to the packages
  that `bar` depends on.

Thus, even if a cycle is encountered, or if there are dependency
conflicts, every module will be able to get a version of its dependency
that it can use.

When the code in the `foo` package does `require('bar')`, it will get the
version that is symlinked into `/usr/lib/node/foo/1.2.3/node_modules/bar`.
Then, when the code in the `bar` package calls `require('quux')`, it'll get
the version that is symlinked into
`/usr/lib/node/bar/4.3.2/node_modules/quux`.

Furthermore, to make the module lookup process even more optimal, rather
than putting packages directly in `/usr/lib/node`, we could put them in
`/usr/lib/node_modules//`.  Then Node.js will not bother
looking for missing dependencies in `/usr/node_modules` or `/node_modules`.

In order to make modules available to the Node.js REPL, it might be useful to
also add the `/usr/lib/node_modules` folder to the `$NODE_PATH` environment
variable.  Since the module lookups using `node_modules` folders are all
relative, and based on the real path of the files making the calls to
`require()`, the packages themselves can be anywhere.

## All Together...



To get the exact filename that will be loaded when `require()` is called, use
the `require.resolve()` function.

Putting together all of the above, here is the high-level algorithm
in pseudocode of what require.resolve does:

```
require(X) from module at path Y
1. If X is a core module,
   a. return the core module
   b. STOP
2. If X begins with './' or '/' or '../'
   a. LOAD_AS_FILE(Y + X)
   b. LOAD_AS_DIRECTORY(Y + X)
3. LOAD_NODE_MODULES(X, dirname(Y))
4. THROW "not found"

LOAD_AS_FILE(X)
1. If X is a file, load X as JavaScript text.  STOP
2. If X.js is a file, load X.js as JavaScript text.  STOP
3. If X.json is a file, parse X.json to a JavaScript Object.  STOP
4. If X.node is a file, load X.node as binary addon.  STOP

LOAD_AS_DIRECTORY(X)
1. If X/package.json is a file,
   a. Parse X/package.json, and look for "main" field.
   b. let M = X + (json main field)
   c. LOAD_AS_FILE(M)
2. If X/index.js is a file, load X/index.js as JavaScript text.  STOP
3. If X/index.json is a file, parse X/index.json to a JavaScript object. STOP
4. If X/index.node is a file, load X/index.node as binary addon.  STOP

LOAD_NODE_MODULES(X, START)
1. let DIRS=NODE_MODULES_PATHS(START)
2. for each DIR in DIRS:
   a. LOAD_AS_FILE(DIR/X)
   b. LOAD_AS_DIRECTORY(DIR/X)

NODE_MODULES_PATHS(START)
1. let PARTS = path split(START)
2. let I = count of PARTS - 1
3. let DIRS = []
4. while I >= 0,
   a. if PARTS[I] = "node_modules" CONTINUE
   b. DIR = path join(PARTS[0 .. I] + "node_modules")
   c. DIRS = DIRS + DIR
   d. let I = I - 1
5. return DIRS
```

## Caching



Modules are cached after the first time they are loaded.  This means
(among other things) that every call to `require('foo')` will get
exactly the same object returned, if it would resolve to the same file.

Multiple calls to `require('foo')` may not cause the module code to be
executed multiple times.  This is an important feature.  With it,
"partially done" objects can be returned, thus allowing transitive
dependencies to be loaded even when they would cause cycles.

If you want to have a module execute code multiple times, then export a
function, and call that function.

### Module Caching Caveats



Modules are cached based on their resolved filename.  Since modules may
resolve to a different filename based on the location of the calling
module (loading from `node_modules` folders), it is not a *guarantee*
that `require('foo')` will always return the exact same object, if it
would resolve to different files.

Additionally, on case-insensitive file systems or operating systems, different
resolved filenames can point to the same file, but the cache will still treat
them as different modules and will reload the file multiple times. For example,
`require('./foo')` and `require('./FOO')` return two different objects,
irrespective of whether or not `./foo` and `./FOO` are the same file.

## Core Modules



Node.js has several modules compiled into the binary.  These modules are
described in greater detail elsewhere in this documentation.

The core modules are defined within Node.js's source and are located in the
`lib/` folder.

Core modules are always preferentially loaded if their identifier is
passed to `require()`.  For instance, `require('http')` will always
return the built in HTTP module, even if there is a file by that name.

## Cycles



When there are circular `require()` calls, a module might not have finished
executing when it is returned.

Consider this situation:

`a.js`:

```
console.log('a starting');
exports.done = false;
const b = require('./b.js');
console.log('in a, b.done = %j', b.done);
exports.done = true;
console.log('a done');
```

`b.js`:

```
console.log('b starting');
exports.done = false;
const a = require('./a.js');
console.log('in b, a.done = %j', a.done);
exports.done = true;
console.log('b done');
```

`main.js`:

```
console.log('main starting');
const a = require('./a.js');
const b = require('./b.js');
console.log('in main, a.done=%j, b.done=%j', a.done, b.done);
```

When `main.js` loads `a.js`, then `a.js` in turn loads `b.js`.  At that
point, `b.js` tries to load `a.js`.  In order to prevent an infinite
loop, an **unfinished copy** of the `a.js` exports object is returned to the
`b.js` module.  `b.js` then finishes loading, and its `exports` object is
provided to the `a.js` module.

By the time `main.js` has loaded both modules, they're both finished.
The output of this program would thus be:

```
$ node main.js
main starting
a starting
b starting
in b, a.done = false
b done
in a, b.done = true
a done
in main, a.done=true, b.done=true
```

If you have cyclic module dependencies in your program, make sure to
plan accordingly.

## File Modules



If the exact filename is not found, then Node.js will attempt to load the
required filename with the added extensions: `.js`, `.json`, and finally
`.node`.

`.js` files are interpreted as JavaScript text files, and `.json` files are
parsed as JSON text files. `.node` files are interpreted as compiled addon
modules loaded with `dlopen`.

A required module prefixed with `'/'` is an absolute path to the file.  For
example, `require('/home/marco/foo.js')` will load the file at
`/home/marco/foo.js`.

A required module prefixed with `'./'` is relative to the file calling
`require()`. That is, `circle.js` must be in the same directory as `foo.js` for
`require('./circle')` to find it.

Without a leading '/', './', or '../' to indicate a file, the module must
either be a core module or is loaded from a `node_modules` folder.

If the given path does not exist, `require()` will throw an [`Error`][] with its
`code` property set to `'MODULE_NOT_FOUND'`.

## Folders as Modules



It is convenient to organize programs and libraries into self-contained
directories, and then provide a single entry point to that library.
There are three ways in which a folder may be passed to `require()` as
an argument.

The first is to create a `package.json` file in the root of the folder,
which specifies a `main` module.  An example package.json file might
look like this:

```
{ "name" : "some-library",
  "main" : "./lib/some-library.js" }
```

If this was in a folder at `./some-library`, then
`require('./some-library')` would attempt to load
`./some-library/lib/some-library.js`.

This is the extent of Node.js's awareness of package.json files.

Note: If the file specified by the `"main"` entry of `package.json` is missing
and can not be resolved, Node.js will report the entire module as missing with
the default error:

```
Error: Cannot find module 'some-library'
```

If there is no package.json file present in the directory, then Node.js
will attempt to load an `index.js` or `index.node` file out of that
directory.  For example, if there was no package.json file in the above
example, then `require('./some-library')` would attempt to load:

* `./some-library/index.js`
* `./some-library/index.node`

## Loading from `node_modules` Folders



If the module identifier passed to `require()` is not a
[core](#modules_core_modules) module, and does not begin with `'/'`, `'../'`, or
`'./'`, then Node.js starts at the parent directory of the current module, and
adds `/node_modules`, and attempts to load the module from that location. Node
will not append `node_modules` to a path already ending in `node_modules`.

If it is not found there, then it moves to the parent directory, and so
on, until the root of the file system is reached.

For example, if the file at `'/home/ry/projects/foo.js'` called
`require('bar.js')`, then Node.js would look in the following locations, in
this order:

* `/home/ry/projects/node_modules/bar.js`
* `/home/ry/node_modules/bar.js`
* `/home/node_modules/bar.js`
* `/node_modules/bar.js`

This allows programs to localize their dependencies, so that they do not
clash.

You can require specific files or sub modules distributed with a module by
including a path suffix after the module name. For instance
`require('example-module/path/to/file')` would resolve `path/to/file`
relative to where `example-module` is located. The suffixed path follows the
same module resolution semantics.

## Loading from the global folders



If the `NODE_PATH` environment variable is set to a colon-delimited list
of absolute paths, then Node.js will search those paths for modules if they
are not found elsewhere.  (Note: On Windows, `NODE_PATH` is delimited by
semicolons instead of colons.)

`NODE_PATH` was originally created to support loading modules from
varying paths before the current [module resolution][] algorithm was frozen.

`NODE_PATH` is still supported, but is less necessary now that the Node.js
ecosystem has settled on a convention for locating dependent modules.
Sometimes deployments that rely on `NODE_PATH` show surprising behavior
when people are unaware that `NODE_PATH` must be set.  Sometimes a
module's dependencies change, causing a different version (or even a
different module) to be loaded as the `NODE_PATH` is searched.

Additionally, Node.js will search in the following locations:

* 1: `$HOME/.node_modules`
* 2: `$HOME/.node_libraries`
* 3: `$PREFIX/lib/node`

Where `$HOME` is the user's home directory, and `$PREFIX` is Node.js's
configured `node_prefix`.

These are mostly for historic reasons.  **You are highly encouraged
to place your dependencies locally in `node_modules` folders.**  They
will be loaded faster, and more reliably.

## The module wrapper



Before a module's code is executed, Node.js will wrap it with a function
wrapper that looks like the following:

```js
(function (exports, require, module, __filename, __dirname) {
// Your module code actually lives in here
});
```

By doing this, Node.js achieves a few things:

- It keeps top-level variables (defined with `var`, `const` or `let`) scoped to
the module rather than the global object.
- It helps to provide some global-looking variables that are actually specific
to the module, such as:
  - The `module` and `exports` objects that the implementor can use to export
  values from the module.
  - The convenience variables `__filename` and `__dirname`, containing the
  module's absolute filename and directory path.

## The `module` Object





* {Object}

In each module, the `module` free variable is a reference to the object
representing the current module.  For convenience, `module.exports` is
also accessible via the `exports` module-global. `module` isn't actually
a global but rather local to each module.

### module.children


* {Array}

The module objects required by this one.

### module.exports


* {Object}

The `module.exports` object is created by the Module system. Sometimes this is
not acceptable; many want their module to be an instance of some class. To do
this, assign the desired export object to `module.exports`. Note that assigning
the desired object to `exports` will simply rebind the local `exports` variable,
which is probably not what you want to do.

For example suppose we were making a module called `a.js`

```js
const EventEmitter = require('events');

module.exports = new EventEmitter();

// Do some work, and after some time emit
// the 'ready' event from the module itself.
setTimeout(() => {
  module.exports.emit('ready');
}, 1000);
```

Then in another file we could do

```js
const a = require('./a');
a.on('ready', () => {
  console.log('module a is ready');
});
```


Note that assignment to `module.exports` must be done immediately. It cannot be
done in any callbacks.  This does not work:

x.js:

```js
setTimeout(() => {
  module.exports = { a: 'hello' };
}, 0);
```

y.js:

```js
const x = require('./x');
console.log(x.a);
```

#### exports shortcut


The `exports` variable is available within a module's file-level scope, and is
assigned the value of `module.exports` before the module is evaluated.

It allows a shortcut, so that `module.exports.f = ...` can be written more
succinctly as `exports.f = ...`. However, be aware that like any variable, if a
new value is assigned to `exports`, it is no longer bound to `module.exports`:

```js
module.exports.hello = true; // Exported from require of module
exports = { hello: false };  // Not exported, only available in the module
```

When the `module.exports` property is being completely replaced by a new
object, it is common to also reassign `exports`, for example:

```js
module.exports = exports = function Constructor() {
    // ... etc.
```

To illustrate the behavior, imagine this hypothetical implementation of
`require()`, which is quite similar to what is actually done by `require()`:

```js
function require(...) {
  var module = { exports: {} };
  ((module, exports) => {
    // Your module code here. In this example, define a function.
    function some_func() {};
    exports = some_func;
    // At this point, exports is no longer a shortcut to module.exports, and
    // this module will still export an empty default object.
    module.exports = some_func;
    // At this point, the module will now export some_func, instead of the
    // default object.
  })(module, module.exports);
  return module.exports;
}
```

### module.filename


* {String}

The fully resolved filename to the module.

### module.id


* {String}

The identifier for the module.  Typically this is the fully resolved
filename.

### module.loaded


* {Boolean}

Whether or not the module is done loading, or is in the process of
loading.

### module.parent


* {Object} Module object

The module that first required this one.

### module.require(id)


* `id` {String}
* Returns: {Object} `module.exports` from the resolved module

The `module.require` method provides a way to load a module as if
`require()` was called from the original module.

Note that in order to do this, you must get a reference to the `module`
object.  Since `require()` returns the `module.exports`, and the `module` is
typically *only* available within a specific module's code, it must be
explicitly exported in order to be used.

[`Error`]: errors.html#errors_class_error
[module resolution]: #modules_all_together
node-v4.8.2/doc/api/net.html000644 000766 000024 00000152231 13070706740 015752 0ustar00iojsstaff000000 000000 


  
  Net | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

        
Table of Contents

        

      


      

        
Net#


Stability: 2 - Stable
The net module provides you with an asynchronous network wrapper. It contains
functions for creating both servers and clients (called streams). You can include
this module with require('net');.


Class: net.Server#



Added in: v0.1.90

This class is used to create a TCP or local server.


net.Server is an EventEmitter with the following events:


Event: 'close'#



Added in: v0.5.0

Emitted when the server closes. Note that if connections exist, this
event is not emitted until all connections are ended.


Event: 'connection'#



Added in: v0.1.90



Emitted when a new connection is made. socket is an instance of
net.Socket.


Event: 'error'#



Added in: v0.1.90



Emitted when an error occurs. Unlike net.Socket, the 'close'
event will not be emitted directly following this event unless
server.close() is manually called. See the example in discussion of
server.listen().


Event: 'listening'#



Added in: v0.1.90

Emitted when the server has been bound after calling server.listen.


server.address()#



Added in: v0.1.90

Returns the bound address, the address family name, and port of the server
as reported by the operating system.
Useful to find which port was assigned when getting an OS-assigned address.
Returns an object with port, family, and address properties:
{ port: 12346, family: 'IPv4', address: '127.0.0.1' }


Example:


var server = net.createServer((socket) => {
  socket.end('goodbye\n');
}).on('error', (err) => {
  // handle errors here
  throw err;
});

// grab a random port.
server.listen(() => {
  console.log('opened server on', server.address());
});



Don't call server.address() until the 'listening' event has been emitted.


server.close([callback])#



Added in: v0.1.90

Stops the server from accepting new connections and keeps existing
connections. This function is asynchronous, the server is finally
closed when all connections are ended and the server emits a 'close' event.
The optional callback will be called once the 'close' event occurs. Unlike
that event, it will be called with an Error as its only argument if the server
was not open when it was closed.


server.connections#



Added in: v0.2.0
Deprecated since: v0.9.7 

Stability: 0 - Deprecated: Use server.getConnections() instead.
The number of concurrent connections on the server.


This becomes null when sending a socket to a child with
child_process.fork(). To poll forks and get current number of active
connections use asynchronous server.getConnections instead.


server.getConnections(callback)#



Added in: v0.9.7

Asynchronously get the number of concurrent connections on the server. Works
when sockets were sent to forks.


Callback should take two arguments err and count.


server.listen(handle[, backlog][, callback])#



Added in: v0.5.10



The handle object can be set to either a server or socket (anything
with an underlying _handle member), or a {fd: <n>} object.


This will cause the server to accept connections on the specified
handle, but it is presumed that the file descriptor or handle has
already been bound to a port or domain socket.


Listening on a file descriptor is not supported on Windows.


This function is asynchronous.  When the server has been bound,
'listening' event will be emitted.
The last parameter callback will be added as a listener for the
'listening' event.


The parameter backlog behaves the same as in
server.listen([port][, hostname][, backlog][, callback]).


server.listen(options[, callback])#



Added in: v0.11.14



The port, host, and backlog properties of options, as well as the
optional callback function, behave as they do on a call to
server.listen([port][, hostname][, backlog][, callback]).
Alternatively, the path option can be used to specify a UNIX socket.


If exclusive is false (default), then cluster workers will use the same
underlying handle, allowing connection handling duties to be shared. When
exclusive is true, the handle is not shared, and attempted port sharing
results in an error. An example which listens on an exclusive port is
shown below.


server.listen({
  host: 'localhost',
  port: 80,
  exclusive: true
});



server.listen(path[, backlog][, callback])#



Added in: v0.1.90



Start a local socket server listening for connections on the given path.


This function is asynchronous.  When the server has been bound,
'listening' event will be emitted.  The last parameter callback
will be added as a listener for the 'listening' event.


On UNIX, the local domain is usually known as the UNIX domain. The path is a
filesystem path name. It gets truncated to sizeof(sockaddr_un.sun_path)
bytes, decreased by 1. It varies on different operating system between 91 and
107 bytes. The typical values are 107 on Linux and 103 on OS X. The path is
subject to the same naming conventions and permissions checks as would be done
on file creation, will be visible in the filesystem, and will persist until
unlinked.


On Windows, the local domain is implemented using a named pipe. The path must
refer to an entry in \\?\pipe\ or \\.\pipe\. Any characters are permitted,
but the latter may do some processing of pipe names, such as resolving ..
sequences. Despite appearances, the pipe name space is flat.  Pipes will not
persist, they are removed when the last reference to them is closed. Do not
forget JavaScript string escaping requires paths to be specified with
double-backslashes, such as:


net.createServer().listen(
    path.join('\\\\?\\pipe', process.cwd(), 'myctl'))

The parameter backlog behaves the same as in
server.listen([port][, hostname][, backlog][, callback]).


server.listen([port][, hostname][, backlog][, callback])#



Added in: v0.1.90

Begin accepting connections on the specified port and hostname. If the
hostname is omitted, the server will accept connections on any IPv6 address
(::) when IPv6 is available, or any IPv4 address (0.0.0.0) otherwise.
Omit the port argument, or use a port value of 0, to have the operating system
assign a random port, which can be retrieved by using server.address().port
after the 'listening' event has been emitted.


Backlog is the maximum length of the queue of pending connections.
The actual length will be determined by the OS through sysctl settings such as
tcp_max_syn_backlog and somaxconn on Linux. The default value of this
parameter is 511 (not 512).


This function is asynchronous.  When the server has been bound,
'listening' event will be emitted.  The last parameter callback
will be added as a listener for the 'listening' event.


One issue some users run into is getting EADDRINUSE errors. This means that
another server is already running on the requested port. One way of handling this
would be to wait a second and then try again:


server.on('error', (e) => {
  if (e.code == 'EADDRINUSE') {
    console.log('Address in use, retrying...');
    setTimeout(() => {
      server.close();
      server.listen(PORT, HOST);
    }, 1000);
  }
});



(Note: All sockets in Node.js are set SO_REUSEADDR.)


server.maxConnections#



Added in: v0.2.0

Set this property to reject connections when the server's connection count gets
high.


It is not recommended to use this option once a socket has been sent to a child
with child_process.fork().


server.ref()#



Added in: v0.9.1

Opposite of unref, calling ref on a previously unrefd server will not
let the program exit if it's the only server left (the default behavior). If
the server is refd calling ref again will have no effect.


Returns server.


server.unref()#



Added in: v0.9.1

Calling unref on a server will allow the program to exit if this is the only
active server in the event system. If the server is already unrefd calling
unref again will have no effect.


Returns server.


Class: net.Socket#



Added in: v0.3.4

This object is an abstraction of a TCP or local socket.  net.Socket
instances implement a duplex Stream interface.  They can be created by the
user and used as a client (with connect()) or they can be created by Node.js
and passed to the user through the 'connection' event of a server.


new net.Socket([options])#



Added in: v0.3.4

Construct a new socket object.


options is an object with the following defaults:


{
  fd: null,
  allowHalfOpen: false,
  readable: false,
  writable: false
}



fd allows you to specify the existing file descriptor of socket.
Set readable and/or writable to true to allow reads and/or writes on this
socket (NOTE: Works only when fd is passed).
About allowHalfOpen, refer to createServer() and 'end' event.


net.Socket instances are EventEmitter with the following events:


Event: 'close'#



Added in: v0.1.90

    

  • had_error <Boolean> true if the socket had a transmission error.
    • 



Emitted once the socket is fully closed. The argument had_error is a boolean
which says if the socket was closed due to a transmission error.


Event: 'connect'#



Added in: v0.1.90

Emitted when a socket connection is successfully established.
See connect().


Event: 'data'#



Added in: v0.1.90



Emitted when data is received.  The argument data will be a Buffer or
String.  Encoding of data is set by socket.setEncoding().
(See the Readable Stream section for more information.)


Note that the data will be lost if there is no listener when a Socket
emits a 'data' event.


Event: 'drain'#



Added in: v0.1.90

Emitted when the write buffer becomes empty. Can be used to throttle uploads.


See also: the return values of socket.write()


Event: 'end'#



Added in: v0.1.90

Emitted when the other end of the socket sends a FIN packet.


By default (allowHalfOpen == false) the socket will destroy its file
descriptor  once it has written out its pending write queue.  However, by
setting allowHalfOpen == true the socket will not automatically end()
its side allowing the user to write arbitrary amounts of data, with the
caveat that the user is required to end() their side now.


Event: 'error'#



Added in: v0.1.90



Emitted when an error occurs.  The 'close' event will be called directly
following this event.


Event: 'lookup'#



Added in: v0.11.3

Emitted after resolving the hostname but before connecting.
Not applicable to UNIX sockets.



Event: 'timeout'#



Added in: v0.1.90

Emitted if the socket times out from inactivity. This is only to notify that
the socket has been idle. The user must manually close the connection.


See also: socket.setTimeout()


socket.address()#



Added in: v0.1.90

Returns the bound address, the address family name and port of the
socket as reported by the operating system. Returns an object with
three properties, e.g.
{ port: 12346, family: 'IPv4', address: '127.0.0.1' }


socket.bufferSize#



Added in: v0.3.8

net.Socket has the property that socket.write() always works. This is to
help users get up and running quickly. The computer cannot always keep up
with the amount of data that is written to a socket - the network connection
simply might be too slow. Node.js will internally queue up the data written to a
socket and send it out over the wire when it is possible. (Internally it is
polling on the socket's file descriptor for being writable).


The consequence of this internal buffering is that memory may grow. This
property shows the number of characters currently buffered to be written.
(Number of characters is approximately equal to the number of bytes to be
written, but the buffer may contain strings, and the strings are lazily
encoded, so the exact number of bytes is not known.)


Users who experience large or growing bufferSize should attempt to
"throttle" the data flows in their program with pause() and resume().


socket.bytesRead#



Added in: v0.5.3

The amount of received bytes.


socket.bytesWritten#



Added in: v0.5.3

The amount of bytes sent.


socket.connect(options[, connectListener])#



Added in: v0.1.90

Opens the connection for a given socket.


For TCP sockets, options argument should be an object which specifies:


    

  • port: Port the client should connect to (Required).
    

    • 

  • host: Host the client should connect to. Defaults to 'localhost'.
    

    • 

  • localAddress: Local interface to bind to for network connections.
    

    • 

  • localPort: Local port to bind to for network connections.
    

    • 

  • family : Version of IP stack. Defaults to 4.
    

    • 

  • lookup : Custom lookup function. Defaults to dns.lookup.
    

    • 



For local domain sockets, options argument should be an object which
specifies:


    

  • path: Path the client should connect to (Required).
    • 



Normally this method is not needed, as net.createConnection opens the
socket. Use this only if you are implementing a custom Socket.


This function is asynchronous. When the 'connect' event is emitted the
socket is established. If there is a problem connecting, the 'connect' event
will not be emitted, the 'error' event will be emitted with the exception.


The connectListener parameter will be added as a listener for the
'connect' event.


socket.connect(path[, connectListener])#


socket.connect(port[, host][, connectListener])#



Added in: v0.1.90

As socket.connect(options\[, connectListener\]),
with options either as either {port: port, host: host} or {path: path}.


socket.destroy()#



Added in: v0.1.90

Ensures that no more I/O activity happens on this socket. Only necessary in
case of errors (parse error or so).


socket.destroyed#


A Boolean value that indicates if the connection is destroyed or not. Once a
connection is destroyed no further data can be transferred using it.


socket.end([data][, encoding])#



Added in: v0.1.90

Half-closes the socket. i.e., it sends a FIN packet. It is possible the
server will still send some data.


If data is specified, it is equivalent to calling
socket.write(data, encoding) followed by socket.end().


socket.localAddress#



Added in: v0.9.6

The string representation of the local IP address the remote client is
connecting on. For example, if you are listening on '0.0.0.0' and the
client connects on '192.168.1.1', the value would be '192.168.1.1'.


socket.localPort#



Added in: v0.9.6

The numeric representation of the local port. For example,
80 or 21.


socket.pause()#


Pauses the reading of data. That is, 'data' events will not be emitted.
Useful to throttle back an upload.


socket.ref()#



Added in: v0.9.1

Opposite of unref, calling ref on a previously unrefd socket will not
let the program exit if it's the only socket left (the default behavior). If
the socket is refd calling ref again will have no effect.


Returns socket.


socket.remoteAddress#



Added in: v0.5.10

The string representation of the remote IP address. For example,
'74.125.127.100' or '2001:4860:a005::68'. Value may be undefined if
the socket is destroyed (for example, if the client disconnected).


socket.remoteFamily#



Added in: v0.11.14

The string representation of the remote IP family. 'IPv4' or 'IPv6'.


socket.remotePort#



Added in: v0.5.10

The numeric representation of the remote port. For example,
80 or 21.


socket.resume()#


Resumes reading after a call to pause().


socket.setEncoding([encoding])#



Added in: v0.1.90

Set the encoding for the socket as a Readable Stream. See
stream.setEncoding() for more information.


socket.setKeepAlive([enable][, initialDelay])#



Added in: v0.1.92

Enable/disable keep-alive functionality, and optionally set the initial
delay before the first keepalive probe is sent on an idle socket.
enable defaults to false.


Set initialDelay (in milliseconds) to set the delay between the last
data packet received and the first keepalive probe. Setting 0 for
initialDelay will leave the value unchanged from the default
(or previous) setting. Defaults to 0.


Returns socket.


socket.setNoDelay([noDelay])#



Added in: v0.1.90

Disables the Nagle algorithm. By default TCP connections use the Nagle
algorithm, they buffer data before sending it off. Setting true for
noDelay will immediately fire off data each time socket.write() is called.
noDelay defaults to true.


Returns socket.


socket.setTimeout(timeout[, callback])#



Added in: v0.1.90

Sets the socket to timeout after timeout milliseconds of inactivity on
the socket. By default net.Socket do not have a timeout.


When an idle timeout is triggered the socket will receive a 'timeout'
event but the connection will not be severed. The user must manually end()
or destroy() the socket.


If timeout is 0, then the existing idle timeout is disabled.


The optional callback parameter will be added as a one time listener for the
'timeout' event.


Returns socket.


socket.unref()#



Added in: v0.9.1

Calling unref on a socket will allow the program to exit if this is the only
active socket in the event system. If the socket is already unrefd calling
unref again will have no effect.


Returns socket.


socket.write(data[, encoding][, callback])#



Added in: v0.1.90

Sends data on the socket. The second parameter specifies the encoding in the
case of a string--it defaults to UTF8 encoding.


Returns true if the entire data was flushed successfully to the kernel
buffer. Returns false if all or part of the data was queued in user memory.
'drain' will be emitted when the buffer is again free.


The optional callback parameter will be executed when the data is finally
written out - this may not be immediately.


net.connect(options[, connectListener])#



Added in: v0.7.0

A factory function, which returns a new net.Socket and automatically
connects with the supplied options.


The options are passed to both the net.Socket constructor and the
socket.connect method.


The connectListener parameter will be added as a listener for the
'connect' event once.


Here is an example of a client of the previously described echo server:


const net = require('net');
const client = net.connect({port: 8124}, () => {
  // 'connect' listener
  console.log('connected to server!');
  client.write('world!\r\n');
});
client.on('data', (data) => {
  console.log(data.toString());
  client.end();
});
client.on('end', () => {
  console.log('disconnected from server');
});



To connect on the socket /tmp/echo.sock the second line would just be
changed to


const client = net.connect({path: '/tmp/echo.sock'});



net.connect(path[, connectListener])#



Added in: v0.1.90

A factory function, which returns a new unix net.Socket and automatically
connects to the supplied path.


The connectListener parameter will be added as a listener for the
'connect' event once.


net.connect(port[, host][, connectListener])#



Added in: v0.1.90

A factory function, which returns a new net.Socket and automatically
connects to the supplied port and host.


If host is omitted, 'localhost' will be assumed.


The connectListener parameter will be added as a listener for the
'connect' event once.


net.createConnection(options[, connectListener])#



Added in: v0.1.90

A factory function, which returns a new net.Socket and automatically
connects with the supplied options.


The options are passed to both the net.Socket constructor and the
socket.connect method.


The connectListener parameter will be added as a listener for the
'connect' event once.


Here is an example of a client of the previously described echo server:


const net = require('net');
const client = net.createConnection({port: 8124}, () => {
  //'connect' listener
  console.log('connected to server!');
  client.write('world!\r\n');
});
client.on('data', (data) => {
  console.log(data.toString());
  client.end();
});
client.on('end', () => {
  console.log('disconnected from server');
});



To connect on the socket /tmp/echo.sock the second line would just be
changed to


const client = net.connect({path: '/tmp/echo.sock'});



net.createConnection(path[, connectListener])#



Added in: v0.1.90

A factory function, which returns a new unix net.Socket and automatically
connects to the supplied path.


The connectListener parameter will be added as a listener for the
'connect' event once.


net.createConnection(port[, host][, connectListener])#



Added in: v0.1.90

A factory function, which returns a new net.Socket and automatically
connects to the supplied port and host.


If host is omitted, 'localhost' will be assumed.


The connectListener parameter will be added as a listener for the
'connect' event once.


net.createServer([options][, connectionListener])#



Added in: v0.5.0

Creates a new server. The connectionListener argument is
automatically set as a listener for the 'connection' event.


options is an object with the following defaults:


{
  allowHalfOpen: false,
  pauseOnConnect: false
}



If allowHalfOpen is true, then the socket won't automatically send a FIN
packet when the other end of the socket sends a FIN packet. The socket becomes
non-readable, but still writable. You should call the end() method explicitly.
See 'end' event for more information.


If pauseOnConnect is true, then the socket associated with each incoming
connection will be paused, and no data will be read from its handle. This allows
connections to be passed between processes without any data being read by the
original process. To begin reading data from a paused socket, call resume().


Here is an example of an echo server which listens for connections
on port 8124:


const net = require('net');
const server = net.createServer((c) => {
  // 'connection' listener
  console.log('client connected');
  c.on('end', () => {
    console.log('client disconnected');
  });
  c.write('hello\r\n');
  c.pipe(c);
});
server.on('error', (err) => {
  throw err;
});
server.listen(8124, () => {
  console.log('server bound');
});



Test this by using telnet:


telnet localhost 8124

To listen on the socket /tmp/echo.sock the third line from the last would
just be changed to


server.listen('/tmp/echo.sock', () => {
  console.log('server bound');
});



Use nc to connect to a UNIX domain socket server:


nc -U /tmp/echo.sock



net.isIP(input)#



Added in: v0.3.0

Tests if input is an IP address. Returns 0 for invalid strings,
returns 4 for IP version 4 addresses, and returns 6 for IP version 6 addresses.


net.isIPv4(input)#



Added in: v0.3.0

Returns true if input is a version 4 IP address, otherwise returns false.


net.isIPv6(input)#



Added in: v0.3.0

Returns true if input is a version 6 IP address, otherwise returns false.


      

    

  

  
  
  
  



node-v4.8.2/doc/api/net.json000644 000766 000024 00000162550 13070706740 015764 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/net.md",
  "modules": [
    {
      "textRaw": "Net",
      "name": "net",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
The net module provides you with an asynchronous network wrapper. It contains\nfunctions for creating both servers and clients (called streams). You can include\nthis module with require('net');.
\n",
      "classes": [
        {
          "textRaw": "Class: net.Server",
          "type": "class",
          "name": "net.Server",
          "meta": {
            "added": [
              "v0.1.90"
            ]
          },
          "desc": "
This class is used to create a TCP or local server.
\n
net.Server is an EventEmitter with the following events:
\n",
          "events": [
            {
              "textRaw": "Event: 'close'",
              "type": "event",
              "name": "close",
              "meta": {
                "added": [
                  "v0.5.0"
                ]
              },
              "desc": "
Emitted when the server closes. Note that if connections exist, this\nevent is not emitted until all connections are ended.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'connection'",
              "type": "event",
              "name": "connection",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "params": [],
              "desc": "
Emitted when a new connection is made. socket is an instance of\nnet.Socket.
\n"
            },
            {
              "textRaw": "Event: 'error'",
              "type": "event",
              "name": "error",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "params": [],
              "desc": "
Emitted when an error occurs. Unlike net.Socket, the 'close'\nevent will not be emitted directly following this event unless\nserver.close() is manually called. See the example in discussion of\nserver.listen().
\n"
            },
            {
              "textRaw": "Event: 'listening'",
              "type": "event",
              "name": "listening",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Emitted when the server has been bound after calling server.listen.
\n",
              "params": []
            }
          ],
          "methods": [
            {
              "textRaw": "server.address()",
              "type": "method",
              "name": "address",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Returns the bound address, the address family name, and port of the server\nas reported by the operating system.\nUseful to find which port was assigned when getting an OS-assigned address.\nReturns an object with port, family, and address properties:\n{ port: 12346, family: 'IPv4', address: '127.0.0.1' }
\n
Example:
\n
var server = net.createServer((socket) => {\n  socket.end('goodbye\\n');\n}).on('error', (err) => {\n  // handle errors here\n  throw err;\n});\n\n// grab a random port.\nserver.listen(() => {\n  console.log('opened server on', server.address());\n});\n
\n
Don't call server.address() until the 'listening' event has been emitted.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "server.close([callback])",
              "type": "method",
              "name": "close",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Stops the server from accepting new connections and keeps existing\nconnections. This function is asynchronous, the server is finally\nclosed when all connections are ended and the server emits a 'close' event.\nThe optional callback will be called once the 'close' event occurs. Unlike\nthat event, it will be called with an Error as its only argument if the server\nwas not open when it was closed.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "server.getConnections(callback)",
              "type": "method",
              "name": "getConnections",
              "meta": {
                "added": [
                  "v0.9.7"
                ]
              },
              "desc": "
Asynchronously get the number of concurrent connections on the server. Works\nwhen sockets were sent to forks.
\n
Callback should take two arguments err and count.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "callback"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "server.listen(handle[, backlog][, callback])",
              "type": "method",
              "name": "listen",
              "meta": {
                "added": [
                  "v0.5.10"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`handle` {Object} ",
                      "name": "handle",
                      "type": "Object"
                    },
                    {
                      "textRaw": "`backlog` {Number} ",
                      "name": "backlog",
                      "type": "Number",
                      "optional": true
                    },
                    {
                      "textRaw": "`callback` {Function} ",
                      "name": "callback",
                      "type": "Function",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "handle"
                    },
                    {
                      "name": "backlog",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
The handle object can be set to either a server or socket (anything\nwith an underlying _handle member), or a {fd: <n>} object.
\n
This will cause the server to accept connections on the specified\nhandle, but it is presumed that the file descriptor or handle has\nalready been bound to a port or domain socket.
\n
Listening on a file descriptor is not supported on Windows.
\n
This function is asynchronous.  When the server has been bound,\n'listening' event will be emitted.\nThe last parameter callback will be added as a listener for the\n'listening' event.
\n
The parameter backlog behaves the same as in\nserver.listen([port][, hostname][, backlog][, callback]).
\n"
            },
            {
              "textRaw": "server.listen(options[, callback])",
              "type": "method",
              "name": "listen",
              "meta": {
                "added": [
                  "v0.11.14"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`options` {Object} - Required. Supports the following properties: ",
                      "options": [
                        {
                          "textRaw": "`port` {Number} - Optional. ",
                          "name": "port",
                          "type": "Number",
                          "desc": "Optional."
                        },
                        {
                          "textRaw": "`host` {String} - Optional. ",
                          "name": "host",
                          "type": "String",
                          "desc": "Optional."
                        },
                        {
                          "textRaw": "`backlog` {Number} - Optional. ",
                          "name": "backlog",
                          "type": "Number",
                          "desc": "Optional."
                        },
                        {
                          "textRaw": "`path` {String} - Optional. ",
                          "name": "path",
                          "type": "String",
                          "desc": "Optional."
                        },
                        {
                          "textRaw": "`exclusive` {Boolean} - Optional. ",
                          "name": "exclusive",
                          "type": "Boolean",
                          "desc": "Optional."
                        }
                      ],
                      "name": "options",
                      "type": "Object",
                      "desc": "Required. Supports the following properties:"
                    },
                    {
                      "textRaw": "`callback` {Function} - Optional. ",
                      "name": "callback",
                      "type": "Function",
                      "desc": "Optional.",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "options"
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
The port, host, and backlog properties of options, as well as the\noptional callback function, behave as they do on a call to\nserver.listen([port][, hostname][, backlog][, callback]).\nAlternatively, the path option can be used to specify a UNIX socket.
\n
If exclusive is false (default), then cluster workers will use the same\nunderlying handle, allowing connection handling duties to be shared. When\nexclusive is true, the handle is not shared, and attempted port sharing\nresults in an error. An example which listens on an exclusive port is\nshown below.
\n
server.listen({\n  host: 'localhost',\n  port: 80,\n  exclusive: true\n});\n
\n"
            },
            {
              "textRaw": "server.listen(path[, backlog][, callback])",
              "type": "method",
              "name": "listen",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`path` {String} ",
                      "name": "path",
                      "type": "String"
                    },
                    {
                      "textRaw": "`backlog` {Number} ",
                      "name": "backlog",
                      "type": "Number",
                      "optional": true
                    },
                    {
                      "textRaw": "`callback` {Function} ",
                      "name": "callback",
                      "type": "Function",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "path"
                    },
                    {
                      "name": "backlog",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Start a local socket server listening for connections on the given path.
\n
This function is asynchronous.  When the server has been bound,\n'listening' event will be emitted.  The last parameter callback\nwill be added as a listener for the 'listening' event.
\n
On UNIX, the local domain is usually known as the UNIX domain. The path is a\nfilesystem path name. It gets truncated to sizeof(sockaddr_un.sun_path)\nbytes, decreased by 1. It varies on different operating system between 91 and\n107 bytes. The typical values are 107 on Linux and 103 on OS X. The path is\nsubject to the same naming conventions and permissions checks as would be done\non file creation, will be visible in the filesystem, and will persist until\nunlinked.
\n
On Windows, the local domain is implemented using a named pipe. The path must\nrefer to an entry in \\\\?\\pipe\\ or \\\\.\\pipe\\. Any characters are permitted,\nbut the latter may do some processing of pipe names, such as resolving ..\nsequences. Despite appearances, the pipe name space is flat.  Pipes will not\npersist, they are removed when the last reference to them is closed. Do not\nforget JavaScript string escaping requires paths to be specified with\ndouble-backslashes, such as:
\n
net.createServer().listen(\n    path.join('\\\\\\\\?\\\\pipe', process.cwd(), 'myctl'))\n
The parameter backlog behaves the same as in\nserver.listen([port][, hostname][, backlog][, callback]).
\n"
            },
            {
              "textRaw": "server.listen([port][, hostname][, backlog][, callback])",
              "type": "method",
              "name": "listen",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Begin accepting connections on the specified port and hostname. If the\nhostname is omitted, the server will accept connections on any IPv6 address\n(::) when IPv6 is available, or any IPv4 address (0.0.0.0) otherwise.\nOmit the port argument, or use a port value of 0, to have the operating system\nassign a random port, which can be retrieved by using server.address().port\nafter the 'listening' event has been emitted.
\n
Backlog is the maximum length of the queue of pending connections.\nThe actual length will be determined by the OS through sysctl settings such as\ntcp_max_syn_backlog and somaxconn on Linux. The default value of this\nparameter is 511 (not 512).
\n
This function is asynchronous.  When the server has been bound,\n'listening' event will be emitted.  The last parameter callback\nwill be added as a listener for the 'listening' event.
\n
One issue some users run into is getting EADDRINUSE errors. This means that\nanother server is already running on the requested port. One way of handling this\nwould be to wait a second and then try again:
\n
server.on('error', (e) => {\n  if (e.code == 'EADDRINUSE') {\n    console.log('Address in use, retrying...');\n    setTimeout(() => {\n      server.close();\n      server.listen(PORT, HOST);\n    }, 1000);\n  }\n});\n
\n
(Note: All sockets in Node.js are set SO_REUSEADDR.)
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "port",
                      "optional": true
                    },
                    {
                      "name": "hostname",
                      "optional": true
                    },
                    {
                      "name": "backlog",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "server.ref()",
              "type": "method",
              "name": "ref",
              "meta": {
                "added": [
                  "v0.9.1"
                ]
              },
              "desc": "
Opposite of unref, calling ref on a previously unrefd server will not\nlet the program exit if it's the only server left (the default behavior). If\nthe server is refd calling ref again will have no effect.
\n
Returns server.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "server.unref()",
              "type": "method",
              "name": "unref",
              "meta": {
                "added": [
                  "v0.9.1"
                ]
              },
              "desc": "
Calling unref on a server will allow the program to exit if this is the only\nactive server in the event system. If the server is already unrefd calling\nunref again will have no effect.
\n
Returns server.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            }
          ],
          "properties": [
            {
              "textRaw": "server.connections",
              "name": "connections",
              "meta": {
                "added": [
                  "v0.2.0"
                ],
                "deprecated": [
                  "v0.9.7"
                ]
              },
              "stability": 0,
              "stabilityText": "Deprecated: Use [`server.getConnections()`][] instead.",
              "desc": "
The number of concurrent connections on the server.
\n
This becomes null when sending a socket to a child with\nchild_process.fork(). To poll forks and get current number of active\nconnections use asynchronous server.getConnections instead.
\n"
            },
            {
              "textRaw": "server.maxConnections",
              "name": "maxConnections",
              "meta": {
                "added": [
                  "v0.2.0"
                ]
              },
              "desc": "
Set this property to reject connections when the server's connection count gets\nhigh.
\n
It is not recommended to use this option once a socket has been sent to a child\nwith child_process.fork().
\n"
            }
          ]
        },
        {
          "textRaw": "Class: net.Socket",
          "type": "class",
          "name": "net.Socket",
          "meta": {
            "added": [
              "v0.3.4"
            ]
          },
          "desc": "
This object is an abstraction of a TCP or local socket.  net.Socket\ninstances implement a duplex Stream interface.  They can be created by the\nuser and used as a client (with connect()) or they can be created by Node.js\nand passed to the user through the 'connection' event of a server.
\n",
          "methods": [
            {
              "textRaw": "new net.Socket([options])",
              "type": "method",
              "name": "Socket",
              "meta": {
                "added": [
                  "v0.3.4"
                ]
              },
              "desc": "
Construct a new socket object.
\n
options is an object with the following defaults:
\n
{\n  fd: null,\n  allowHalfOpen: false,\n  readable: false,\n  writable: false\n}\n
\n
fd allows you to specify the existing file descriptor of socket.\nSet readable and/or writable to true to allow reads and/or writes on this\nsocket (NOTE: Works only when fd is passed).\nAbout allowHalfOpen, refer to createServer() and 'end' event.
\n
net.Socket instances are EventEmitter with the following events:
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "socket.address()",
              "type": "method",
              "name": "address",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Returns the bound address, the address family name and port of the\nsocket as reported by the operating system. Returns an object with\nthree properties, e.g.\n{ port: 12346, family: 'IPv4', address: '127.0.0.1' }
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "socket.connect(options[, connectListener])",
              "type": "method",
              "name": "connect",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Opens the connection for a given socket.
\n
For TCP sockets, options argument should be an object which specifies:
\n
    \n
  • port: Port the client should connect to (Required).
    \n
    • \n
  • host: Host the client should connect to. Defaults to 'localhost'.
    \n
    • \n
  • localAddress: Local interface to bind to for network connections.
    \n
    • \n
  • localPort: Local port to bind to for network connections.
    \n
    • \n
  • family : Version of IP stack. Defaults to 4.
    \n
    • \n
  • lookup : Custom lookup function. Defaults to dns.lookup.
    \n
    • \n
\n
For local domain sockets, options argument should be an object which\nspecifies:
\n
    \n
  • path: Path the client should connect to (Required).
    • \n
\n
Normally this method is not needed, as net.createConnection opens the\nsocket. Use this only if you are implementing a custom Socket.
\n
This function is asynchronous. When the 'connect' event is emitted the\nsocket is established. If there is a problem connecting, the 'connect' event\nwill not be emitted, the 'error' event will be emitted with the exception.
\n
The connectListener parameter will be added as a listener for the\n'connect' event.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "options"
                    },
                    {
                      "name": "connectListener",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "socket.connect(path[, connectListener])",
              "type": "method",
              "name": "connect",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
As socket.connect(options\\[, connectListener\\]),\nwith options either as either {port: port, host: host} or {path: path}.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "port"
                    },
                    {
                      "name": "host",
                      "optional": true
                    },
                    {
                      "name": "connectListener",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "path"
                    },
                    {
                      "name": "connectListener",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "socket.connect(port[, host][, connectListener])",
              "type": "method",
              "name": "connect",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
As socket.connect(options\\[, connectListener\\]),\nwith options either as either {port: port, host: host} or {path: path}.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "port"
                    },
                    {
                      "name": "host",
                      "optional": true
                    },
                    {
                      "name": "connectListener",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "socket.destroy()",
              "type": "method",
              "name": "destroy",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Ensures that no more I/O activity happens on this socket. Only necessary in\ncase of errors (parse error or so).
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "socket.end([data][, encoding])",
              "type": "method",
              "name": "end",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Half-closes the socket. i.e., it sends a FIN packet. It is possible the\nserver will still send some data.
\n
If data is specified, it is equivalent to calling\nsocket.write(data, encoding) followed by socket.end().
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "data",
                      "optional": true
                    },
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "socket.pause()",
              "type": "method",
              "name": "pause",
              "desc": "
Pauses the reading of data. That is, 'data' events will not be emitted.\nUseful to throttle back an upload.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "socket.ref()",
              "type": "method",
              "name": "ref",
              "meta": {
                "added": [
                  "v0.9.1"
                ]
              },
              "desc": "
Opposite of unref, calling ref on a previously unrefd socket will not\nlet the program exit if it's the only socket left (the default behavior). If\nthe socket is refd calling ref again will have no effect.
\n
Returns socket.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "socket.resume()",
              "type": "method",
              "name": "resume",
              "desc": "
Resumes reading after a call to pause().
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "socket.setEncoding([encoding])",
              "type": "method",
              "name": "setEncoding",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Set the encoding for the socket as a Readable Stream. See\nstream.setEncoding() for more information.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "encoding",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "socket.setKeepAlive([enable][, initialDelay])",
              "type": "method",
              "name": "setKeepAlive",
              "meta": {
                "added": [
                  "v0.1.92"
                ]
              },
              "desc": "
Enable/disable keep-alive functionality, and optionally set the initial\ndelay before the first keepalive probe is sent on an idle socket.\nenable defaults to false.
\n
Set initialDelay (in milliseconds) to set the delay between the last\ndata packet received and the first keepalive probe. Setting 0 for\ninitialDelay will leave the value unchanged from the default\n(or previous) setting. Defaults to 0.
\n
Returns socket.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "enable",
                      "optional": true
                    },
                    {
                      "name": "initialDelay",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "socket.setNoDelay([noDelay])",
              "type": "method",
              "name": "setNoDelay",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Disables the Nagle algorithm. By default TCP connections use the Nagle\nalgorithm, they buffer data before sending it off. Setting true for\nnoDelay will immediately fire off data each time socket.write() is called.\nnoDelay defaults to true.
\n
Returns socket.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "noDelay",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "socket.setTimeout(timeout[, callback])",
              "type": "method",
              "name": "setTimeout",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Sets the socket to timeout after timeout milliseconds of inactivity on\nthe socket. By default net.Socket do not have a timeout.
\n
When an idle timeout is triggered the socket will receive a 'timeout'\nevent but the connection will not be severed. The user must manually end()\nor destroy() the socket.
\n
If timeout is 0, then the existing idle timeout is disabled.
\n
The optional callback parameter will be added as a one time listener for the\n'timeout' event.
\n
Returns socket.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "timeout"
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "socket.unref()",
              "type": "method",
              "name": "unref",
              "meta": {
                "added": [
                  "v0.9.1"
                ]
              },
              "desc": "
Calling unref on a socket will allow the program to exit if this is the only\nactive socket in the event system. If the socket is already unrefd calling\nunref again will have no effect.
\n
Returns socket.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "socket.write(data[, encoding][, callback])",
              "type": "method",
              "name": "write",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Sends data on the socket. The second parameter specifies the encoding in the\ncase of a string--it defaults to UTF8 encoding.
\n
Returns true if the entire data was flushed successfully to the kernel\nbuffer. Returns false if all or part of the data was queued in user memory.\n'drain' will be emitted when the buffer is again free.
\n
The optional callback parameter will be executed when the data is finally\nwritten out - this may not be immediately.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "data"
                    },
                    {
                      "name": "encoding",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            }
          ],
          "events": [
            {
              "textRaw": "Event: 'close'",
              "type": "event",
              "name": "close",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "params": [],
              "desc": "
Emitted once the socket is fully closed. The argument had_error is a boolean\nwhich says if the socket was closed due to a transmission error.
\n"
            },
            {
              "textRaw": "Event: 'connect'",
              "type": "event",
              "name": "connect",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Emitted when a socket connection is successfully established.\nSee connect().
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'data'",
              "type": "event",
              "name": "data",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "params": [],
              "desc": "
Emitted when data is received.  The argument data will be a Buffer or\nString.  Encoding of data is set by socket.setEncoding().\n(See the Readable Stream section for more information.)
\n
Note that the data will be lost if there is no listener when a Socket\nemits a 'data' event.
\n"
            },
            {
              "textRaw": "Event: 'drain'",
              "type": "event",
              "name": "drain",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Emitted when the write buffer becomes empty. Can be used to throttle uploads.
\n
See also: the return values of socket.write()
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'end'",
              "type": "event",
              "name": "end",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Emitted when the other end of the socket sends a FIN packet.
\n
By default (allowHalfOpen == false) the socket will destroy its file\ndescriptor  once it has written out its pending write queue.  However, by\nsetting allowHalfOpen == true the socket will not automatically end()\nits side allowing the user to write arbitrary amounts of data, with the\ncaveat that the user is required to end() their side now.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'error'",
              "type": "event",
              "name": "error",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "params": [],
              "desc": "
Emitted when an error occurs.  The 'close' event will be called directly\nfollowing this event.
\n"
            },
            {
              "textRaw": "Event: 'lookup'",
              "type": "event",
              "name": "lookup",
              "meta": {
                "added": [
                  "v0.11.3"
                ]
              },
              "desc": "
Emitted after resolving the hostname but before connecting.\nNot applicable to UNIX sockets.
\n
    \n
  • err {Error|Null} The error object.  See dns.lookup().
    • \n
  • address {String} The IP address.
    • \n
  • family {String|Null} The address type.  See dns.lookup().
    • \n
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'timeout'",
              "type": "event",
              "name": "timeout",
              "meta": {
                "added": [
                  "v0.1.90"
                ]
              },
              "desc": "
Emitted if the socket times out from inactivity. This is only to notify that\nthe socket has been idle. The user must manually close the connection.
\n
See also: socket.setTimeout()
\n",
              "params": []
            }
          ],
          "properties": [
            {
              "textRaw": "socket.bufferSize",
              "name": "bufferSize",
              "meta": {
                "added": [
                  "v0.3.8"
                ]
              },
              "desc": "
net.Socket has the property that socket.write() always works. This is to\nhelp users get up and running quickly. The computer cannot always keep up\nwith the amount of data that is written to a socket - the network connection\nsimply might be too slow. Node.js will internally queue up the data written to a\nsocket and send it out over the wire when it is possible. (Internally it is\npolling on the socket's file descriptor for being writable).
\n
The consequence of this internal buffering is that memory may grow. This\nproperty shows the number of characters currently buffered to be written.\n(Number of characters is approximately equal to the number of bytes to be\nwritten, but the buffer may contain strings, and the strings are lazily\nencoded, so the exact number of bytes is not known.)
\n
Users who experience large or growing bufferSize should attempt to\n"throttle" the data flows in their program with pause() and resume().
\n"
            },
            {
              "textRaw": "socket.bytesRead",
              "name": "bytesRead",
              "meta": {
                "added": [
                  "v0.5.3"
                ]
              },
              "desc": "
The amount of received bytes.
\n"
            },
            {
              "textRaw": "socket.bytesWritten",
              "name": "bytesWritten",
              "meta": {
                "added": [
                  "v0.5.3"
                ]
              },
              "desc": "
The amount of bytes sent.
\n"
            },
            {
              "textRaw": "socket.destroyed",
              "name": "destroyed",
              "desc": "
A Boolean value that indicates if the connection is destroyed or not. Once a\nconnection is destroyed no further data can be transferred using it.
\n"
            },
            {
              "textRaw": "socket.localAddress",
              "name": "localAddress",
              "meta": {
                "added": [
                  "v0.9.6"
                ]
              },
              "desc": "
The string representation of the local IP address the remote client is\nconnecting on. For example, if you are listening on '0.0.0.0' and the\nclient connects on '192.168.1.1', the value would be '192.168.1.1'.
\n"
            },
            {
              "textRaw": "socket.localPort",
              "name": "localPort",
              "meta": {
                "added": [
                  "v0.9.6"
                ]
              },
              "desc": "
The numeric representation of the local port. For example,\n80 or 21.
\n"
            },
            {
              "textRaw": "socket.remoteAddress",
              "name": "remoteAddress",
              "meta": {
                "added": [
                  "v0.5.10"
                ]
              },
              "desc": "
The string representation of the remote IP address. For example,\n'74.125.127.100' or '2001:4860:a005::68'. Value may be undefined if\nthe socket is destroyed (for example, if the client disconnected).
\n"
            },
            {
              "textRaw": "socket.remoteFamily",
              "name": "remoteFamily",
              "meta": {
                "added": [
                  "v0.11.14"
                ]
              },
              "desc": "
The string representation of the remote IP family. 'IPv4' or 'IPv6'.
\n"
            },
            {
              "textRaw": "socket.remotePort",
              "name": "remotePort",
              "meta": {
                "added": [
                  "v0.5.10"
                ]
              },
              "desc": "
The numeric representation of the remote port. For example,\n80 or 21.
\n"
            }
          ]
        }
      ],
      "methods": [
        {
          "textRaw": "net.connect(options[, connectListener])",
          "type": "method",
          "name": "connect",
          "meta": {
            "added": [
              "v0.7.0"
            ]
          },
          "desc": "
A factory function, which returns a new net.Socket and automatically\nconnects with the supplied options.
\n
The options are passed to both the net.Socket constructor and the\nsocket.connect method.
\n
The connectListener parameter will be added as a listener for the\n'connect' event once.
\n
Here is an example of a client of the previously described echo server:
\n
const net = require('net');\nconst client = net.connect({port: 8124}, () => {\n  // 'connect' listener\n  console.log('connected to server!');\n  client.write('world!\\r\\n');\n});\nclient.on('data', (data) => {\n  console.log(data.toString());\n  client.end();\n});\nclient.on('end', () => {\n  console.log('disconnected from server');\n});\n
\n
To connect on the socket /tmp/echo.sock the second line would just be\nchanged to
\n
const client = net.connect({path: '/tmp/echo.sock'});\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "options"
                },
                {
                  "name": "connectListener",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "net.connect(path[, connectListener])",
          "type": "method",
          "name": "connect",
          "meta": {
            "added": [
              "v0.1.90"
            ]
          },
          "desc": "
A factory function, which returns a new unix net.Socket and automatically\nconnects to the supplied path.
\n
The connectListener parameter will be added as a listener for the\n'connect' event once.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "connectListener",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "net.connect(port[, host][, connectListener])",
          "type": "method",
          "name": "connect",
          "meta": {
            "added": [
              "v0.1.90"
            ]
          },
          "desc": "
A factory function, which returns a new net.Socket and automatically\nconnects to the supplied port and host.
\n
If host is omitted, 'localhost' will be assumed.
\n
The connectListener parameter will be added as a listener for the\n'connect' event once.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "port"
                },
                {
                  "name": "host",
                  "optional": true
                },
                {
                  "name": "connectListener",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "net.createConnection(options[, connectListener])",
          "type": "method",
          "name": "createConnection",
          "meta": {
            "added": [
              "v0.1.90"
            ]
          },
          "desc": "
A factory function, which returns a new net.Socket and automatically\nconnects with the supplied options.
\n
The options are passed to both the net.Socket constructor and the\nsocket.connect method.
\n
The connectListener parameter will be added as a listener for the\n'connect' event once.
\n
Here is an example of a client of the previously described echo server:
\n
const net = require('net');\nconst client = net.createConnection({port: 8124}, () => {\n  //'connect' listener\n  console.log('connected to server!');\n  client.write('world!\\r\\n');\n});\nclient.on('data', (data) => {\n  console.log(data.toString());\n  client.end();\n});\nclient.on('end', () => {\n  console.log('disconnected from server');\n});\n
\n
To connect on the socket /tmp/echo.sock the second line would just be\nchanged to
\n
const client = net.connect({path: '/tmp/echo.sock'});\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "options"
                },
                {
                  "name": "connectListener",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "net.createConnection(path[, connectListener])",
          "type": "method",
          "name": "createConnection",
          "meta": {
            "added": [
              "v0.1.90"
            ]
          },
          "desc": "
A factory function, which returns a new unix net.Socket and automatically\nconnects to the supplied path.
\n
The connectListener parameter will be added as a listener for the\n'connect' event once.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                },
                {
                  "name": "connectListener",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "net.createConnection(port[, host][, connectListener])",
          "type": "method",
          "name": "createConnection",
          "meta": {
            "added": [
              "v0.1.90"
            ]
          },
          "desc": "
A factory function, which returns a new net.Socket and automatically\nconnects to the supplied port and host.
\n
If host is omitted, 'localhost' will be assumed.
\n
The connectListener parameter will be added as a listener for the\n'connect' event once.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "port"
                },
                {
                  "name": "host",
                  "optional": true
                },
                {
                  "name": "connectListener",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "net.createServer([options][, connectionListener])",
          "type": "method",
          "name": "createServer",
          "meta": {
            "added": [
              "v0.5.0"
            ]
          },
          "desc": "
Creates a new server. The connectionListener argument is\nautomatically set as a listener for the 'connection' event.
\n
options is an object with the following defaults:
\n
{\n  allowHalfOpen: false,\n  pauseOnConnect: false\n}\n
\n
If allowHalfOpen is true, then the socket won't automatically send a FIN\npacket when the other end of the socket sends a FIN packet. The socket becomes\nnon-readable, but still writable. You should call the end() method explicitly.\nSee 'end' event for more information.
\n
If pauseOnConnect is true, then the socket associated with each incoming\nconnection will be paused, and no data will be read from its handle. This allows\nconnections to be passed between processes without any data being read by the\noriginal process. To begin reading data from a paused socket, call resume().
\n
Here is an example of an echo server which listens for connections\non port 8124:
\n
const net = require('net');\nconst server = net.createServer((c) => {\n  // 'connection' listener\n  console.log('client connected');\n  c.on('end', () => {\n    console.log('client disconnected');\n  });\n  c.write('hello\\r\\n');\n  c.pipe(c);\n});\nserver.on('error', (err) => {\n  throw err;\n});\nserver.listen(8124, () => {\n  console.log('server bound');\n});\n
\n
Test this by using telnet:
\n
telnet localhost 8124\n
To listen on the socket /tmp/echo.sock the third line from the last would\njust be changed to
\n
server.listen('/tmp/echo.sock', () => {\n  console.log('server bound');\n});\n
\n
Use nc to connect to a UNIX domain socket server:
\n
nc -U /tmp/echo.sock\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "options",
                  "optional": true
                },
                {
                  "name": "connectionListener",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "net.isIP(input)",
          "type": "method",
          "name": "isIP",
          "meta": {
            "added": [
              "v0.3.0"
            ]
          },
          "desc": "
Tests if input is an IP address. Returns 0 for invalid strings,\nreturns 4 for IP version 4 addresses, and returns 6 for IP version 6 addresses.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "input"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "net.isIPv4(input)",
          "type": "method",
          "name": "isIPv4",
          "meta": {
            "added": [
              "v0.3.0"
            ]
          },
          "desc": "
Returns true if input is a version 4 IP address, otherwise returns false.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "input"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "net.isIPv6(input)",
          "type": "method",
          "name": "isIPv6",
          "meta": {
            "added": [
              "v0.3.0"
            ]
          },
          "desc": "
Returns true if input is a version 6 IP address, otherwise returns false.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "input"
                }
              ]
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "Net"
    }
  ]
}
node-v4.8.2/doc/api/net.md000644 000766 000024 00000062334 13070706735 015416 0ustar00iojsstaff000000 000000 # Net

> Stability: 2 - Stable

The `net` module provides you with an asynchronous network wrapper. It contains
functions for creating both servers and clients (called streams). You can include
this module with `require('net');`.

## Class: net.Server


This class is used to create a TCP or local server.

`net.Server` is an [`EventEmitter`][] with the following events:

### Event: 'close'


Emitted when the server closes. Note that if connections exist, this
event is not emitted until all connections are ended.

### Event: 'connection'


* {net.Socket} The connection object

Emitted when a new connection is made. `socket` is an instance of
`net.Socket`.

### Event: 'error'


* {Error}

Emitted when an error occurs. Unlike [`net.Socket`][], the [`'close'`][]
event will **not** be emitted directly following this event unless
[`server.close()`][] is manually called. See the example in discussion of
[`server.listen()`][`server.listen(port, host, backlog, callback)`].

### Event: 'listening'


Emitted when the server has been bound after calling `server.listen`.

### server.address()


Returns the bound address, the address family name, and port of the server
as reported by the operating system.
Useful to find which port was assigned when getting an OS-assigned address.
Returns an object with `port`, `family`, and `address` properties:
`{ port: 12346, family: 'IPv4', address: '127.0.0.1' }`

Example:

```js
var server = net.createServer((socket) => {
  socket.end('goodbye\n');
}).on('error', (err) => {
  // handle errors here
  throw err;
});

// grab a random port.
server.listen(() => {
  console.log('opened server on', server.address());
});
```

Don't call `server.address()` until the `'listening'` event has been emitted.

### server.close([callback])


Stops the server from accepting new connections and keeps existing
connections. This function is asynchronous, the server is finally
closed when all connections are ended and the server emits a [`'close'`][] event.
The optional `callback` will be called once the `'close'` event occurs. Unlike
that event, it will be called with an Error as its only argument if the server
was not open when it was closed.

### server.connections


> Stability: 0 - Deprecated: Use [`server.getConnections()`][] instead.

The number of concurrent connections on the server.

This becomes `null` when sending a socket to a child with
[`child_process.fork()`][]. To poll forks and get current number of active
connections use asynchronous `server.getConnections` instead.

### server.getConnections(callback)


Asynchronously get the number of concurrent connections on the server. Works
when sockets were sent to forks.

Callback should take two arguments `err` and `count`.

### server.listen(handle[, backlog][, callback])


* `handle` {Object}
* `backlog` {Number}
* `callback` {Function}

The `handle` object can be set to either a server or socket (anything
with an underlying `_handle` member), or a `{fd: }` object.

This will cause the server to accept connections on the specified
handle, but it is presumed that the file descriptor or handle has
already been bound to a port or domain socket.

Listening on a file descriptor is not supported on Windows.

This function is asynchronous.  When the server has been bound,
[`'listening'`][] event will be emitted.
The last parameter `callback` will be added as a listener for the
[`'listening'`][] event.

The parameter `backlog` behaves the same as in
[`server.listen([port][, hostname][, backlog][, callback])`][`server.listen(port, host, backlog, callback)`].

### server.listen(options[, callback])


* `options` {Object} - Required. Supports the following properties:
  * `port` {Number} - Optional.
  * `host` {String} - Optional.
  * `backlog` {Number} - Optional.
  * `path` {String} - Optional.
  * `exclusive` {Boolean} - Optional.
* `callback` {Function} - Optional.

The `port`, `host`, and `backlog` properties of `options`, as well as the
optional callback function, behave as they do on a call to
[`server.listen([port][, hostname][, backlog][, callback])`][`server.listen(port, host, backlog, callback)`].
Alternatively, the `path` option can be used to specify a UNIX socket.

If `exclusive` is `false` (default), then cluster workers will use the same
underlying handle, allowing connection handling duties to be shared. When
`exclusive` is `true`, the handle is not shared, and attempted port sharing
results in an error. An example which listens on an exclusive port is
shown below.

```js
server.listen({
  host: 'localhost',
  port: 80,
  exclusive: true
});
```

### server.listen(path[, backlog][, callback])


* `path` {String}
* `backlog` {Number}
* `callback` {Function}

Start a local socket server listening for connections on the given `path`.

This function is asynchronous.  When the server has been bound,
[`'listening'`][] event will be emitted.  The last parameter `callback`
will be added as a listener for the [`'listening'`][] event.

On UNIX, the local domain is usually known as the UNIX domain. The path is a
filesystem path name. It gets truncated to `sizeof(sockaddr_un.sun_path)`
bytes, decreased by 1. It varies on different operating system between 91 and
107 bytes. The typical values are 107 on Linux and 103 on OS X. The path is
subject to the same naming conventions and permissions checks as would be done
on file creation, will be visible in the filesystem, and will *persist until
unlinked*.

On Windows, the local domain is implemented using a named pipe. The path *must*
refer to an entry in `\\?\pipe\` or `\\.\pipe\`. Any characters are permitted,
but the latter may do some processing of pipe names, such as resolving `..`
sequences. Despite appearances, the pipe name space is flat.  Pipes will *not
persist*, they are removed when the last reference to them is closed. Do not
forget JavaScript string escaping requires paths to be specified with
double-backslashes, such as:

    net.createServer().listen(
        path.join('\\\\?\\pipe', process.cwd(), 'myctl'))

The parameter `backlog` behaves the same as in
[`server.listen([port][, hostname][, backlog][, callback])`][`server.listen(port, host, backlog, callback)`].

### server.listen([port][, hostname][, backlog][, callback])


Begin accepting connections on the specified `port` and `hostname`. If the
`hostname` is omitted, the server will accept connections on any IPv6 address
(`::`) when IPv6 is available, or any IPv4 address (`0.0.0.0`) otherwise.
Omit the port argument, or use a port value of `0`, to have the operating system
assign a random port, which can be retrieved by using `server.address().port`
after the `'listening'` event has been emitted.

Backlog is the maximum length of the queue of pending connections.
The actual length will be determined by the OS through sysctl settings such as
`tcp_max_syn_backlog` and `somaxconn` on Linux. The default value of this
parameter is 511 (not 512).

This function is asynchronous.  When the server has been bound,
[`'listening'`][] event will be emitted.  The last parameter `callback`
will be added as a listener for the [`'listening'`][] event.

One issue some users run into is getting `EADDRINUSE` errors. This means that
another server is already running on the requested port. One way of handling this
would be to wait a second and then try again:

```js
server.on('error', (e) => {
  if (e.code == 'EADDRINUSE') {
    console.log('Address in use, retrying...');
    setTimeout(() => {
      server.close();
      server.listen(PORT, HOST);
    }, 1000);
  }
});
```

(Note: All sockets in Node.js are set `SO_REUSEADDR`.)

### server.maxConnections


Set this property to reject connections when the server's connection count gets
high.

It is not recommended to use this option once a socket has been sent to a child
with [`child_process.fork()`][].

### server.ref()


Opposite of `unref`, calling `ref` on a previously `unref`d server will *not*
let the program exit if it's the only server left (the default behavior). If
the server is `ref`d calling `ref` again will have no effect.

Returns `server`.

### server.unref()


Calling `unref` on a server will allow the program to exit if this is the only
active server in the event system. If the server is already `unref`d calling
`unref` again will have no effect.

Returns `server`.

## Class: net.Socket


This object is an abstraction of a TCP or local socket.  `net.Socket`
instances implement a duplex Stream interface.  They can be created by the
user and used as a client (with [`connect()`][]) or they can be created by Node.js
and passed to the user through the `'connection'` event of a server.

### new net.Socket([options])


Construct a new socket object.

`options` is an object with the following defaults:

```js
{
  fd: null,
  allowHalfOpen: false,
  readable: false,
  writable: false
}
```

`fd` allows you to specify the existing file descriptor of socket.
Set `readable` and/or `writable` to `true` to allow reads and/or writes on this
socket (NOTE: Works only when `fd` is passed).
About `allowHalfOpen`, refer to `createServer()` and `'end'` event.

`net.Socket` instances are [`EventEmitter`][] with the following events:

### Event: 'close'


* `had_error` {Boolean} `true` if the socket had a transmission error.

Emitted once the socket is fully closed. The argument `had_error` is a boolean
which says if the socket was closed due to a transmission error.

### Event: 'connect'


Emitted when a socket connection is successfully established.
See [`connect()`][].

### Event: 'data'


* {Buffer}

Emitted when data is received.  The argument `data` will be a `Buffer` or
`String`.  Encoding of data is set by `socket.setEncoding()`.
(See the [Readable Stream][] section for more information.)

Note that the __data will be lost__ if there is no listener when a `Socket`
emits a `'data'` event.

### Event: 'drain'


Emitted when the write buffer becomes empty. Can be used to throttle uploads.

See also: the return values of `socket.write()`

### Event: 'end'


Emitted when the other end of the socket sends a FIN packet.

By default (`allowHalfOpen == false`) the socket will destroy its file
descriptor  once it has written out its pending write queue.  However, by
setting `allowHalfOpen == true` the socket will not automatically `end()`
its side allowing the user to write arbitrary amounts of data, with the
caveat that the user is required to `end()` their side now.

### Event: 'error'


* {Error}

Emitted when an error occurs.  The `'close'` event will be called directly
following this event.

### Event: 'lookup'


Emitted after resolving the hostname but before connecting.
Not applicable to UNIX sockets.

* `err` {Error|Null} The error object.  See [`dns.lookup()`][].
* `address` {String} The IP address.
* `family` {String|Null} The address type.  See [`dns.lookup()`][].

### Event: 'timeout'


Emitted if the socket times out from inactivity. This is only to notify that
the socket has been idle. The user must manually close the connection.

See also: [`socket.setTimeout()`][]

### socket.address()


Returns the bound address, the address family name and port of the
socket as reported by the operating system. Returns an object with
three properties, e.g.
`{ port: 12346, family: 'IPv4', address: '127.0.0.1' }`

### socket.bufferSize


`net.Socket` has the property that `socket.write()` always works. This is to
help users get up and running quickly. The computer cannot always keep up
with the amount of data that is written to a socket - the network connection
simply might be too slow. Node.js will internally queue up the data written to a
socket and send it out over the wire when it is possible. (Internally it is
polling on the socket's file descriptor for being writable).

The consequence of this internal buffering is that memory may grow. This
property shows the number of characters currently buffered to be written.
(Number of characters is approximately equal to the number of bytes to be
written, but the buffer may contain strings, and the strings are lazily
encoded, so the exact number of bytes is not known.)

Users who experience large or growing `bufferSize` should attempt to
"throttle" the data flows in their program with [`pause()`][] and [`resume()`][].

### socket.bytesRead


The amount of received bytes.

### socket.bytesWritten


The amount of bytes sent.

### socket.connect(options[, connectListener])


Opens the connection for a given socket.

For TCP sockets, `options` argument should be an object which specifies:

  - `port`: Port the client should connect to (Required).

  - `host`: Host the client should connect to. Defaults to `'localhost'`.

  - `localAddress`: Local interface to bind to for network connections.

  - `localPort`: Local port to bind to for network connections.

  - `family` : Version of IP stack. Defaults to `4`.

  - `lookup` : Custom lookup function. Defaults to `dns.lookup`.

For local domain sockets, `options` argument should be an object which
specifies:

  - `path`: Path the client should connect to (Required).

Normally this method is not needed, as `net.createConnection` opens the
socket. Use this only if you are implementing a custom Socket.

This function is asynchronous. When the [`'connect'`][] event is emitted the
socket is established. If there is a problem connecting, the `'connect'` event
will not be emitted, the [`'error'`][] event will be emitted with the exception.

The `connectListener` parameter will be added as a listener for the
[`'connect'`][] event.

### socket.connect(path[, connectListener])
### socket.connect(port[, host][, connectListener])


As [`socket.connect(options\[, connectListener\])`][`socket.connect(options, connectListener)`],
with options either as either `{port: port, host: host}` or `{path: path}`.

### socket.destroy()


Ensures that no more I/O activity happens on this socket. Only necessary in
case of errors (parse error or so).

### socket.destroyed

A Boolean value that indicates if the connection is destroyed or not. Once a
connection is destroyed no further data can be transferred using it.

### socket.end([data][, encoding])


Half-closes the socket. i.e., it sends a FIN packet. It is possible the
server will still send some data.

If `data` is specified, it is equivalent to calling
`socket.write(data, encoding)` followed by `socket.end()`.

### socket.localAddress


The string representation of the local IP address the remote client is
connecting on. For example, if you are listening on `'0.0.0.0'` and the
client connects on `'192.168.1.1'`, the value would be `'192.168.1.1'`.

### socket.localPort


The numeric representation of the local port. For example,
`80` or `21`.

### socket.pause()

Pauses the reading of data. That is, [`'data'`][] events will not be emitted.
Useful to throttle back an upload.

### socket.ref()


Opposite of `unref`, calling `ref` on a previously `unref`d socket will *not*
let the program exit if it's the only socket left (the default behavior). If
the socket is `ref`d calling `ref` again will have no effect.

Returns `socket`.

### socket.remoteAddress


The string representation of the remote IP address. For example,
`'74.125.127.100'` or `'2001:4860:a005::68'`. Value may be `undefined` if
the socket is destroyed (for example, if the client disconnected).

### socket.remoteFamily


The string representation of the remote IP family. `'IPv4'` or `'IPv6'`.

### socket.remotePort


The numeric representation of the remote port. For example,
`80` or `21`.

### socket.resume()

Resumes reading after a call to [`pause()`][].

### socket.setEncoding([encoding])


Set the encoding for the socket as a [Readable Stream][]. See
[`stream.setEncoding()`][] for more information.

### socket.setKeepAlive([enable][, initialDelay])


Enable/disable keep-alive functionality, and optionally set the initial
delay before the first keepalive probe is sent on an idle socket.
`enable` defaults to `false`.

Set `initialDelay` (in milliseconds) to set the delay between the last
data packet received and the first keepalive probe. Setting 0 for
initialDelay will leave the value unchanged from the default
(or previous) setting. Defaults to `0`.

Returns `socket`.

### socket.setNoDelay([noDelay])


Disables the Nagle algorithm. By default TCP connections use the Nagle
algorithm, they buffer data before sending it off. Setting `true` for
`noDelay` will immediately fire off data each time `socket.write()` is called.
`noDelay` defaults to `true`.

Returns `socket`.

### socket.setTimeout(timeout[, callback])


Sets the socket to timeout after `timeout` milliseconds of inactivity on
the socket. By default `net.Socket` do not have a timeout.

When an idle timeout is triggered the socket will receive a [`'timeout'`][]
event but the connection will not be severed. The user must manually [`end()`][]
or [`destroy()`][] the socket.

If `timeout` is 0, then the existing idle timeout is disabled.

The optional `callback` parameter will be added as a one time listener for the
[`'timeout'`][] event.

Returns `socket`.

### socket.unref()


Calling `unref` on a socket will allow the program to exit if this is the only
active socket in the event system. If the socket is already `unref`d calling
`unref` again will have no effect.

Returns `socket`.

### socket.write(data[, encoding][, callback])


Sends data on the socket. The second parameter specifies the encoding in the
case of a string--it defaults to UTF8 encoding.

Returns `true` if the entire data was flushed successfully to the kernel
buffer. Returns `false` if all or part of the data was queued in user memory.
[`'drain'`][] will be emitted when the buffer is again free.

The optional `callback` parameter will be executed when the data is finally
written out - this may not be immediately.

## net.connect(options[, connectListener])


A factory function, which returns a new [`net.Socket`][] and automatically
connects with the supplied `options`.

The options are passed to both the [`net.Socket`][] constructor and the
[`socket.connect`][] method.

The `connectListener` parameter will be added as a listener for the
[`'connect'`][] event once.

Here is an example of a client of the previously described echo server:

```js
const net = require('net');
const client = net.connect({port: 8124}, () => {
  // 'connect' listener
  console.log('connected to server!');
  client.write('world!\r\n');
});
client.on('data', (data) => {
  console.log(data.toString());
  client.end();
});
client.on('end', () => {
  console.log('disconnected from server');
});
```

To connect on the socket `/tmp/echo.sock` the second line would just be
changed to

```js
const client = net.connect({path: '/tmp/echo.sock'});
```

## net.connect(path[, connectListener])


A factory function, which returns a new unix [`net.Socket`][] and automatically
connects to the supplied `path`.

The `connectListener` parameter will be added as a listener for the
[`'connect'`][] event once.

## net.connect(port[, host][, connectListener])


A factory function, which returns a new [`net.Socket`][] and automatically
connects to the supplied `port` and `host`.

If `host` is omitted, `'localhost'` will be assumed.

The `connectListener` parameter will be added as a listener for the
[`'connect'`][] event once.

## net.createConnection(options[, connectListener])


A factory function, which returns a new [`net.Socket`][] and automatically
connects with the supplied `options`.

The options are passed to both the [`net.Socket`][] constructor and the
[`socket.connect`][] method.

The `connectListener` parameter will be added as a listener for the
[`'connect'`][] event once.

Here is an example of a client of the previously described echo server:

```js
const net = require('net');
const client = net.createConnection({port: 8124}, () => {
  //'connect' listener
  console.log('connected to server!');
  client.write('world!\r\n');
});
client.on('data', (data) => {
  console.log(data.toString());
  client.end();
});
client.on('end', () => {
  console.log('disconnected from server');
});
```

To connect on the socket `/tmp/echo.sock` the second line would just be
changed to

```js
const client = net.connect({path: '/tmp/echo.sock'});
```

## net.createConnection(path[, connectListener])


A factory function, which returns a new unix [`net.Socket`][] and automatically
connects to the supplied `path`.

The `connectListener` parameter will be added as a listener for the
[`'connect'`][] event once.

## net.createConnection(port[, host][, connectListener])


A factory function, which returns a new [`net.Socket`][] and automatically
connects to the supplied `port` and `host`.

If `host` is omitted, `'localhost'` will be assumed.

The `connectListener` parameter will be added as a listener for the
[`'connect'`][] event once.

## net.createServer([options][, connectionListener])


Creates a new server. The `connectionListener` argument is
automatically set as a listener for the [`'connection'`][] event.

`options` is an object with the following defaults:

```js
{
  allowHalfOpen: false,
  pauseOnConnect: false
}
```

If `allowHalfOpen` is `true`, then the socket won't automatically send a FIN
packet when the other end of the socket sends a FIN packet. The socket becomes
non-readable, but still writable. You should call the [`end()`][] method explicitly.
See [`'end'`][] event for more information.

If `pauseOnConnect` is `true`, then the socket associated with each incoming
connection will be paused, and no data will be read from its handle. This allows
connections to be passed between processes without any data being read by the
original process. To begin reading data from a paused socket, call [`resume()`][].

Here is an example of an echo server which listens for connections
on port 8124:

```js
const net = require('net');
const server = net.createServer((c) => {
  // 'connection' listener
  console.log('client connected');
  c.on('end', () => {
    console.log('client disconnected');
  });
  c.write('hello\r\n');
  c.pipe(c);
});
server.on('error', (err) => {
  throw err;
});
server.listen(8124, () => {
  console.log('server bound');
});
```

Test this by using `telnet`:

```
telnet localhost 8124
```

To listen on the socket `/tmp/echo.sock` the third line from the last would
just be changed to

```js
server.listen('/tmp/echo.sock', () => {
  console.log('server bound');
});
```

Use `nc` to connect to a UNIX domain socket server:

```js
nc -U /tmp/echo.sock
```

## net.isIP(input)


Tests if input is an IP address. Returns 0 for invalid strings,
returns 4 for IP version 4 addresses, and returns 6 for IP version 6 addresses.


## net.isIPv4(input)


Returns true if input is a version 4 IP address, otherwise returns false.


## net.isIPv6(input)


Returns true if input is a version 6 IP address, otherwise returns false.

[`'close'`]: #net_event_close
[`'connect'`]: #net_event_connect
[`'connection'`]: #net_event_connection
[`'data'`]: #net_event_data
[`'drain'`]: #net_event_drain
[`'end'`]: #net_event_end
[`'error'`]: #net_event_error_1
[`'listening'`]: #net_event_listening
[`'timeout'`]: #net_event_timeout
[`child_process.fork()`]: child_process.html#child_process_child_process_fork_modulepath_args_options
[`connect()`]: #net_socket_connect_options_connectlistener
[`destroy()`]: #net_socket_destroy
[`dns.lookup()`]: dns.html#dns_dns_lookup_hostname_options_callback
[`end()`]: #net_socket_end_data_encoding
[`EventEmitter`]: events.html#events_class_events_eventemitter
[`net.Socket`]: #net_class_net_socket
[`pause()`]: #net_socket_pause
[`resume()`]: #net_socket_resume
[`server.getConnections()`]: #net_server_getconnections_callback
[`server.listen(port, host, backlog, callback)`]: #net_server_listen_port_hostname_backlog_callback
[`server.close()`]: #net_server_close_callback
[`socket.connect(options, connectListener)`]: #net_socket_connect_options_connectlistener
[`socket.connect`]: #net_socket_connect_options_connectlistener
[`socket.setTimeout()`]: #net_socket_settimeout_timeout_callback
[`stream.setEncoding()`]: stream.html#stream_readable_setencoding_encoding
[Readable Stream]: stream.html#stream_class_stream_readable
node-v4.8.2/doc/api/os.html000644 000766 000024 00000031651 13070706740 015607 0ustar00iojsstaff000000 000000 


  
  OS | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

      

        
OS#


Stability: 2 - Stable
Provides a few basic operating-system related utility functions.


Use require('os') to access this module.


os.EOL#



Added in: v0.7.8

A constant defining the appropriate End-of-line marker for the operating
system.


os.arch()#



Added in: v0.5.0

Returns the operating system CPU architecture. Possible values are 'x64',
'arm' and 'ia32'. Returns the value of process.arch.


os.cpus()#



Added in: v0.3.3

Returns an array of objects containing information about each CPU/core
installed: model, speed (in MHz), and times (an object containing the number of
milliseconds the CPU/core spent in: user, nice, sys, idle, and irq).


Example inspection of os.cpus:


[ { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',
    speed: 2926,
    times:
     { user: 252020,
       nice: 0,
       sys: 30340,
       idle: 1070356870,
       irq: 0 } },
  { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',
    speed: 2926,
    times:
     { user: 306960,
       nice: 0,
       sys: 26980,
       idle: 1071569080,
       irq: 0 } },
  { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',
    speed: 2926,
    times:
     { user: 248450,
       nice: 0,
       sys: 21750,
       idle: 1070919370,
       irq: 0 } },
  { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',
    speed: 2926,
    times:
     { user: 256880,
       nice: 0,
       sys: 19430,
       idle: 1070905480,
       irq: 20 } },
  { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',
    speed: 2926,
    times:
     { user: 511580,
       nice: 20,
       sys: 40900,
       idle: 1070842510,
       irq: 0 } },
  { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',
    speed: 2926,
    times:
     { user: 291660,
       nice: 0,
       sys: 34360,
       idle: 1070888000,
       irq: 10 } },
  { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',
    speed: 2926,
    times:
     { user: 308260,
       nice: 0,
       sys: 55410,
       idle: 1071129970,
       irq: 880 } },
  { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',
    speed: 2926,
    times:
     { user: 266450,
       nice: 1480,
       sys: 34920,
       idle: 1072572010,
       irq: 30 } } ]



Note that since nice values are UNIX centric in Windows the nice values of
all processors are always 0.


os.endianness()#



Added in: v0.9.4

Returns the endianness of the CPU. Possible values are 'BE' for big endian
or 'LE' for little endian.


os.freemem()#



Added in: v0.3.3

Returns the amount of free system memory in bytes.


os.homedir()#



Added in: v2.3.0

Returns the home directory of the current user.


os.hostname()#



Added in: v0.3.3

Returns the hostname of the operating system.


os.loadavg()#



Added in: v0.3.3

Returns an array containing the 1, 5, and 15 minute load averages.


The load average is a measure of system activity, calculated by the operating
system and expressed as a fractional number.  As a rule of thumb, the load
average should ideally be less than the number of logical CPUs in the system.


The load average is a very UNIX-y concept; there is no real equivalent on
Windows platforms.  That is why this function always returns [0, 0, 0] on
Windows.


os.networkInterfaces()#



Added in: v0.6.0

Get a list of network interfaces:


{ lo:
   [ { address: '127.0.0.1',
       netmask: '255.0.0.0',
       family: 'IPv4',
       mac: '00:00:00:00:00:00',
       internal: true },
     { address: '::1',
       netmask: 'ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff',
       family: 'IPv6',
       mac: '00:00:00:00:00:00',
       internal: true } ],
  eth0:
   [ { address: '192.168.1.108',
       netmask: '255.255.255.0',
       family: 'IPv4',
       mac: '01:02:03:0a:0b:0c',
       internal: false },
     { address: 'fe80::a00:27ff:fe4e:66a1',
       netmask: 'ffff:ffff:ffff:ffff::',
       family: 'IPv6',
       mac: '01:02:03:0a:0b:0c',
       internal: false } ] }



Note that due to the underlying implementation this will only return network
interfaces that have been assigned an address.


os.platform()#



Added in: v0.5.0

Returns the operating system platform. Possible values are 'darwin',
'freebsd', 'linux', 'sunos' or 'win32'. Returns the value of
process.platform.


os.release()#



Added in: v0.3.3

Returns the operating system release.


os.tmpdir()#



Added in: v0.9.9

Returns the operating system's default directory for temporary files.


os.totalmem()#



Added in: v0.3.3

Returns the total amount of system memory in bytes.


os.type()#



Added in: v0.3.3

Returns the operating system name. For example 'Linux' on Linux, 'Darwin'
on OS X and 'Windows_NT' on Windows.


os.uptime()#



Added in: v0.3.3

Returns the system uptime in seconds.


      

    

  

  
  
  
  



node-v4.8.2/doc/api/os.json000644 000766 000024 00000023711 13070706740 015612 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/os.md",
  "modules": [
    {
      "textRaw": "OS",
      "name": "os",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
Provides a few basic operating-system related utility functions.
\n
Use require('os') to access this module.
\n",
      "properties": [
        {
          "textRaw": "os.EOL",
          "name": "EOL",
          "meta": {
            "added": [
              "v0.7.8"
            ]
          },
          "desc": "
A constant defining the appropriate End-of-line marker for the operating\nsystem.
\n"
        }
      ],
      "methods": [
        {
          "textRaw": "os.arch()",
          "type": "method",
          "name": "arch",
          "meta": {
            "added": [
              "v0.5.0"
            ]
          },
          "desc": "
Returns the operating system CPU architecture. Possible values are 'x64',\n'arm' and 'ia32'. Returns the value of process.arch.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "os.cpus()",
          "type": "method",
          "name": "cpus",
          "meta": {
            "added": [
              "v0.3.3"
            ]
          },
          "desc": "
Returns an array of objects containing information about each CPU/core\ninstalled: model, speed (in MHz), and times (an object containing the number of\nmilliseconds the CPU/core spent in: user, nice, sys, idle, and irq).
\n
Example inspection of os.cpus:
\n
[ { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',\n    speed: 2926,\n    times:\n     { user: 252020,\n       nice: 0,\n       sys: 30340,\n       idle: 1070356870,\n       irq: 0 } },\n  { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',\n    speed: 2926,\n    times:\n     { user: 306960,\n       nice: 0,\n       sys: 26980,\n       idle: 1071569080,\n       irq: 0 } },\n  { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',\n    speed: 2926,\n    times:\n     { user: 248450,\n       nice: 0,\n       sys: 21750,\n       idle: 1070919370,\n       irq: 0 } },\n  { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',\n    speed: 2926,\n    times:\n     { user: 256880,\n       nice: 0,\n       sys: 19430,\n       idle: 1070905480,\n       irq: 20 } },\n  { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',\n    speed: 2926,\n    times:\n     { user: 511580,\n       nice: 20,\n       sys: 40900,\n       idle: 1070842510,\n       irq: 0 } },\n  { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',\n    speed: 2926,\n    times:\n     { user: 291660,\n       nice: 0,\n       sys: 34360,\n       idle: 1070888000,\n       irq: 10 } },\n  { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',\n    speed: 2926,\n    times:\n     { user: 308260,\n       nice: 0,\n       sys: 55410,\n       idle: 1071129970,\n       irq: 880 } },\n  { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',\n    speed: 2926,\n    times:\n     { user: 266450,\n       nice: 1480,\n       sys: 34920,\n       idle: 1072572010,\n       irq: 30 } } ]\n
\n
Note that since nice values are UNIX centric in Windows the nice values of\nall processors are always 0.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "os.endianness()",
          "type": "method",
          "name": "endianness",
          "meta": {
            "added": [
              "v0.9.4"
            ]
          },
          "desc": "
Returns the endianness of the CPU. Possible values are 'BE' for big endian\nor 'LE' for little endian.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "os.freemem()",
          "type": "method",
          "name": "freemem",
          "meta": {
            "added": [
              "v0.3.3"
            ]
          },
          "desc": "
Returns the amount of free system memory in bytes.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "os.homedir()",
          "type": "method",
          "name": "homedir",
          "meta": {
            "added": [
              "v2.3.0"
            ]
          },
          "desc": "
Returns the home directory of the current user.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "os.hostname()",
          "type": "method",
          "name": "hostname",
          "meta": {
            "added": [
              "v0.3.3"
            ]
          },
          "desc": "
Returns the hostname of the operating system.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "os.loadavg()",
          "type": "method",
          "name": "loadavg",
          "meta": {
            "added": [
              "v0.3.3"
            ]
          },
          "desc": "
Returns an array containing the 1, 5, and 15 minute load averages.
\n
The load average is a measure of system activity, calculated by the operating\nsystem and expressed as a fractional number.  As a rule of thumb, the load\naverage should ideally be less than the number of logical CPUs in the system.
\n
The load average is a very UNIX-y concept; there is no real equivalent on\nWindows platforms.  That is why this function always returns [0, 0, 0] on\nWindows.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "os.networkInterfaces()",
          "type": "method",
          "name": "networkInterfaces",
          "meta": {
            "added": [
              "v0.6.0"
            ]
          },
          "desc": "
Get a list of network interfaces:
\n
{ lo:\n   [ { address: '127.0.0.1',\n       netmask: '255.0.0.0',\n       family: 'IPv4',\n       mac: '00:00:00:00:00:00',\n       internal: true },\n     { address: '::1',\n       netmask: 'ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff',\n       family: 'IPv6',\n       mac: '00:00:00:00:00:00',\n       internal: true } ],\n  eth0:\n   [ { address: '192.168.1.108',\n       netmask: '255.255.255.0',\n       family: 'IPv4',\n       mac: '01:02:03:0a:0b:0c',\n       internal: false },\n     { address: 'fe80::a00:27ff:fe4e:66a1',\n       netmask: 'ffff:ffff:ffff:ffff::',\n       family: 'IPv6',\n       mac: '01:02:03:0a:0b:0c',\n       internal: false } ] }\n
\n
Note that due to the underlying implementation this will only return network\ninterfaces that have been assigned an address.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "os.platform()",
          "type": "method",
          "name": "platform",
          "meta": {
            "added": [
              "v0.5.0"
            ]
          },
          "desc": "
Returns the operating system platform. Possible values are 'darwin',\n'freebsd', 'linux', 'sunos' or 'win32'. Returns the value of\nprocess.platform.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "os.release()",
          "type": "method",
          "name": "release",
          "meta": {
            "added": [
              "v0.3.3"
            ]
          },
          "desc": "
Returns the operating system release.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "os.tmpdir()",
          "type": "method",
          "name": "tmpdir",
          "meta": {
            "added": [
              "v0.9.9"
            ]
          },
          "desc": "
Returns the operating system's default directory for temporary files.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "os.totalmem()",
          "type": "method",
          "name": "totalmem",
          "meta": {
            "added": [
              "v0.3.3"
            ]
          },
          "desc": "
Returns the total amount of system memory in bytes.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "os.type()",
          "type": "method",
          "name": "type",
          "meta": {
            "added": [
              "v0.3.3"
            ]
          },
          "desc": "
Returns the operating system name. For example 'Linux' on Linux, 'Darwin'\non OS X and 'Windows_NT' on Windows.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "os.uptime()",
          "type": "method",
          "name": "uptime",
          "meta": {
            "added": [
              "v0.3.3"
            ]
          },
          "desc": "
Returns the system uptime in seconds.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "OS"
    }
  ]
}
node-v4.8.2/doc/api/os.md000644 000766 000024 00000011703 13070706735 015243 0ustar00iojsstaff000000 000000 # OS

> Stability: 2 - Stable

Provides a few basic operating-system related utility functions.

Use `require('os')` to access this module.

## os.EOL


A constant defining the appropriate End-of-line marker for the operating
system.

## os.arch()


Returns the operating system CPU architecture. Possible values are `'x64'`,
`'arm'` and `'ia32'`. Returns the value of [`process.arch`][].

## os.cpus()


Returns an array of objects containing information about each CPU/core
installed: model, speed (in MHz), and times (an object containing the number of
milliseconds the CPU/core spent in: user, nice, sys, idle, and irq).

Example inspection of os.cpus:

```js
[ { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',
    speed: 2926,
    times:
     { user: 252020,
       nice: 0,
       sys: 30340,
       idle: 1070356870,
       irq: 0 } },
  { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',
    speed: 2926,
    times:
     { user: 306960,
       nice: 0,
       sys: 26980,
       idle: 1071569080,
       irq: 0 } },
  { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',
    speed: 2926,
    times:
     { user: 248450,
       nice: 0,
       sys: 21750,
       idle: 1070919370,
       irq: 0 } },
  { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',
    speed: 2926,
    times:
     { user: 256880,
       nice: 0,
       sys: 19430,
       idle: 1070905480,
       irq: 20 } },
  { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',
    speed: 2926,
    times:
     { user: 511580,
       nice: 20,
       sys: 40900,
       idle: 1070842510,
       irq: 0 } },
  { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',
    speed: 2926,
    times:
     { user: 291660,
       nice: 0,
       sys: 34360,
       idle: 1070888000,
       irq: 10 } },
  { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',
    speed: 2926,
    times:
     { user: 308260,
       nice: 0,
       sys: 55410,
       idle: 1071129970,
       irq: 880 } },
  { model: 'Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz',
    speed: 2926,
    times:
     { user: 266450,
       nice: 1480,
       sys: 34920,
       idle: 1072572010,
       irq: 30 } } ]
```

Note that since `nice` values are UNIX centric in Windows the `nice` values of
all processors are always 0.

## os.endianness()


Returns the endianness of the CPU. Possible values are `'BE'` for big endian
or `'LE'` for little endian.

## os.freemem()


Returns the amount of free system memory in bytes.

## os.homedir()


Returns the home directory of the current user.

## os.hostname()


Returns the hostname of the operating system.

## os.loadavg()


Returns an array containing the 1, 5, and 15 minute load averages.

The load average is a measure of system activity, calculated by the operating
system and expressed as a fractional number.  As a rule of thumb, the load
average should ideally be less than the number of logical CPUs in the system.

The load average is a very UNIX-y concept; there is no real equivalent on
Windows platforms.  That is why this function always returns `[0, 0, 0]` on
Windows.

## os.networkInterfaces()


Get a list of network interfaces:

```js
{ lo:
   [ { address: '127.0.0.1',
       netmask: '255.0.0.0',
       family: 'IPv4',
       mac: '00:00:00:00:00:00',
       internal: true },
     { address: '::1',
       netmask: 'ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff',
       family: 'IPv6',
       mac: '00:00:00:00:00:00',
       internal: true } ],
  eth0:
   [ { address: '192.168.1.108',
       netmask: '255.255.255.0',
       family: 'IPv4',
       mac: '01:02:03:0a:0b:0c',
       internal: false },
     { address: 'fe80::a00:27ff:fe4e:66a1',
       netmask: 'ffff:ffff:ffff:ffff::',
       family: 'IPv6',
       mac: '01:02:03:0a:0b:0c',
       internal: false } ] }
```

Note that due to the underlying implementation this will only return network
interfaces that have been assigned an address.

## os.platform()


Returns the operating system platform. Possible values are `'darwin'`,
`'freebsd'`, `'linux'`, `'sunos'` or `'win32'`. Returns the value of
[`process.platform`][].

## os.release()


Returns the operating system release.

## os.tmpdir()


Returns the operating system's default directory for temporary files.

## os.totalmem()


Returns the total amount of system memory in bytes.

## os.type()


Returns the operating system name. For example `'Linux'` on Linux, `'Darwin'`
on OS X and `'Windows_NT'` on Windows.

## os.uptime()


Returns the system uptime in seconds.

[`process.arch`]: process.html#process_process_arch
[`process.platform`]: process.html#process_process_platform
node-v4.8.2/doc/api/path.html000644 000766 000024 00000041670 13070706740 016124 0ustar00iojsstaff000000 000000 


  
  Path | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

      

        
Path#


Stability: 2 - Stable
This module contains utilities for handling and transforming file
paths.  Almost all these methods perform only string transformations.
The file system is not consulted to check whether paths are valid.


Use require('path') to use this module.  The following methods are provided:


path.basename(p[, ext])#



Added in: v0.1.25

Return the last portion of a path.  Similar to the Unix basename command.


Example:


path.basename('/foo/bar/baz/asdf/quux.html')
// returns 'quux.html'

path.basename('/foo/bar/baz/asdf/quux.html', '.html')
// returns 'quux'



path.delimiter#



Added in: v0.9.3

The platform-specific path delimiter, ; or ':'.


An example on *nix:


console.log(process.env.PATH)
// '/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin'

process.env.PATH.split(path.delimiter)
// returns ['/usr/bin', '/bin', '/usr/sbin', '/sbin', '/usr/local/bin']



An example on Windows:


console.log(process.env.PATH)
// 'C:\Windows\system32;C:\Windows;C:\Program Files\node\'

process.env.PATH.split(path.delimiter)
// returns ['C:\\Windows\\system32', 'C:\\Windows', 'C:\\Program Files\\node\\']



path.dirname(p)#



Added in: v0.1.16

Return the directory name of a path.  Similar to the Unix dirname command.


Example:


path.dirname('/foo/bar/baz/asdf/quux')
// returns '/foo/bar/baz/asdf'



path.extname(p)#



Added in: v0.1.25

Return the extension of the path, from the last '.' to end of string
in the last portion of the path.  If there is no '.' in the last portion
of the path or the first character of it is '.', then it returns
an empty string.  Examples:


path.extname('index.html')
// returns '.html'

path.extname('index.coffee.md')
// returns '.md'

path.extname('index.')
// returns '.'

path.extname('index')
// returns ''

path.extname('.index')
// returns ''



path.format(pathObject)#



Added in: v0.11.15

Returns a path string from an object, the opposite of path.parse.


Examples:


Some Posix system examples:


// If `dir` and `base` are provided, `dir` + platform separator + `base`
// will be returned.
path.format({
    dir: '/home/user/dir',
    base: 'file.txt'
});
// returns '/home/user/dir/file.txt'

// `base` will be returned if `dir` or `root` are not provided.
path.format({
    base: 'file.txt'
});
// returns 'file.txt'



path.isAbsolute(path)#



Added in: v0.11.2

Determines whether path is an absolute path. An absolute path will always
resolve to the same location, regardless of the working directory.


Posix examples:


path.isAbsolute('/foo/bar') // true
path.isAbsolute('/baz/..')  // true
path.isAbsolute('qux/')     // false
path.isAbsolute('.')        // false



Windows examples:


path.isAbsolute('//server')  // true
path.isAbsolute('C:/foo/..') // true
path.isAbsolute('bar\\baz')  // false
path.isAbsolute('.')         // false



Note: If the path string passed as parameter is a zero-length string, unlike
        other path module functions, it will be used as-is and false will be
        returned.


path.join([path1][, path2][, ...])#



Added in: v0.1.16

Join all arguments together and normalize the resulting path.


Arguments must be strings.  In v0.8, non-string arguments were
silently ignored.  In v0.10 and up, an exception is thrown.


Example:


path.join('/foo', 'bar', 'baz/asdf', 'quux', '..')
// returns '/foo/bar/baz/asdf'

path.join('foo', {}, 'bar')
// throws exception
TypeError: Arguments to path.join must be strings



Note: If the arguments to join have zero-length strings, unlike other path
        module functions, they will be ignored. If the joined path string is a
        zero-length string then '.' will be returned, which represents the
        current working directory.


path.normalize(p)#



Added in: v0.1.23

Normalize a string path, taking care of '..' and '.' parts.


When multiple slashes are found, they're replaced by a single one;
when the path contains a trailing slash, it is preserved.
On Windows backslashes are used.


Example:


path.normalize('/foo/bar//baz/asdf/quux/..')
// returns '/foo/bar/baz/asdf'



Note: If the path string passed as argument is a zero-length string then '.'
        will be returned, which represents the current working directory.


path.parse(pathString)#



Added in: v0.11.15

Returns an object from a path string.


An example on *nix:


path.parse('/home/user/dir/file.txt')
// returns
// {
//    root : "/",
//    dir : "/home/user/dir",
//    base : "file.txt",
//    ext : ".txt",
//    name : "file"
// }



An example on Windows:


path.parse('C:\\path\\dir\\index.html')
// returns
// {
//    root : "C:\\",
//    dir : "C:\\path\\dir",
//    base : "index.html",
//    ext : ".html",
//    name : "index"
// }



path.posix#



Added in: v0.11.15

Provide access to aforementioned path methods but always interact in a posix
compatible way.


path.relative(from, to)#



Added in: v0.5.0

Solve the relative path from from to to.


At times we have two absolute paths, and we need to derive the relative
path from one to the other.  This is actually the reverse transform of
path.resolve, which means we see that:


path.resolve(from, path.relative(from, to)) == path.resolve(to)



Examples:


path.relative('C:\\orandea\\test\\aaa', 'C:\\orandea\\impl\\bbb')
// returns '..\\..\\impl\\bbb'

path.relative('/data/orandea/test/aaa', '/data/orandea/impl/bbb')
// returns '../../impl/bbb'



Note: If the arguments to relative have zero-length strings then the current
        working directory will be used instead of the zero-length strings. If
        both the paths are the same then a zero-length string will be returned.


path.resolve([from ...], to)#



Added in: v0.3.4

Resolves to to an absolute path.


If to isn't already absolute from arguments are prepended in right to left
order, until an absolute path is found. If after using all from paths still
no absolute path is found, the current working directory is used as well. The
resulting path is normalized, and trailing slashes are removed unless the path
gets resolved to the root directory. Non-string from arguments are ignored.


Another way to think of it is as a sequence of cd commands in a shell.


path.resolve('foo/bar', '/tmp/file/', '..', 'a/../subfile')



Is similar to:


cd foo/bar
cd /tmp/file/
cd ..
cd a/../subfile
pwd

The difference is that the different paths don't need to exist and may also be
files.


Examples:


path.resolve('/foo/bar', './baz')
// returns '/foo/bar/baz'

path.resolve('/foo/bar', '/tmp/file/')
// returns '/tmp/file'

path.resolve('wwwroot', 'static_files/png/', '../gif/image.gif')
// if currently in /home/myself/node, it returns
// '/home/myself/node/wwwroot/static_files/gif/image.gif'



Note: If the arguments to resolve have zero-length strings then the current
        working directory will be used instead of them.


path.sep#



Added in: v0.7.9

The platform-specific file separator. '\\' or '/'.


An example on *nix:


'foo/bar/baz'.split(path.sep)
// returns ['foo', 'bar', 'baz']



An example on Windows:


'foo\\bar\\baz'.split(path.sep)
// returns ['foo', 'bar', 'baz']



path.win32#



Added in: v0.11.15

Provide access to aforementioned path methods but always interact in a win32
compatible way.


      

    

  

  
  
  
  



node-v4.8.2/doc/api/path.json000644 000766 000024 00000035100 13070706740 016120 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/path.md",
  "modules": [
    {
      "textRaw": "Path",
      "name": "path",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
This module contains utilities for handling and transforming file\npaths.  Almost all these methods perform only string transformations.\nThe file system is not consulted to check whether paths are valid.
\n
Use require('path') to use this module.  The following methods are provided:
\n",
      "methods": [
        {
          "textRaw": "path.basename(p[, ext])",
          "type": "method",
          "name": "basename",
          "meta": {
            "added": [
              "v0.1.25"
            ]
          },
          "desc": "
Return the last portion of a path.  Similar to the Unix basename command.
\n
Example:
\n
path.basename('/foo/bar/baz/asdf/quux.html')\n// returns 'quux.html'\n\npath.basename('/foo/bar/baz/asdf/quux.html', '.html')\n// returns 'quux'\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "p"
                },
                {
                  "name": "ext",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "path.dirname(p)",
          "type": "method",
          "name": "dirname",
          "meta": {
            "added": [
              "v0.1.16"
            ]
          },
          "desc": "
Return the directory name of a path.  Similar to the Unix dirname command.
\n
Example:
\n
path.dirname('/foo/bar/baz/asdf/quux')\n// returns '/foo/bar/baz/asdf'\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "p"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "path.extname(p)",
          "type": "method",
          "name": "extname",
          "meta": {
            "added": [
              "v0.1.25"
            ]
          },
          "desc": "
Return the extension of the path, from the last '.' to end of string\nin the last portion of the path.  If there is no '.' in the last portion\nof the path or the first character of it is '.', then it returns\nan empty string.  Examples:
\n
path.extname('index.html')\n// returns '.html'\n\npath.extname('index.coffee.md')\n// returns '.md'\n\npath.extname('index.')\n// returns '.'\n\npath.extname('index')\n// returns ''\n\npath.extname('.index')\n// returns ''\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "p"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "path.format(pathObject)",
          "type": "method",
          "name": "format",
          "meta": {
            "added": [
              "v0.11.15"
            ]
          },
          "desc": "
Returns a path string from an object, the opposite of path.parse.
\n
Examples:
\n
Some Posix system examples:
\n
// If `dir` and `base` are provided, `dir` + platform separator + `base`\n// will be returned.\npath.format({\n    dir: '/home/user/dir',\n    base: 'file.txt'\n});\n// returns '/home/user/dir/file.txt'\n\n// `base` will be returned if `dir` or `root` are not provided.\npath.format({\n    base: 'file.txt'\n});\n// returns 'file.txt'\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "pathObject"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "path.isAbsolute(path)",
          "type": "method",
          "name": "isAbsolute",
          "meta": {
            "added": [
              "v0.11.2"
            ]
          },
          "desc": "
Determines whether path is an absolute path. An absolute path will always\nresolve to the same location, regardless of the working directory.
\n
Posix examples:
\n
path.isAbsolute('/foo/bar') // true\npath.isAbsolute('/baz/..')  // true\npath.isAbsolute('qux/')     // false\npath.isAbsolute('.')        // false\n
\n
Windows examples:
\n
path.isAbsolute('//server')  // true\npath.isAbsolute('C:/foo/..') // true\npath.isAbsolute('bar\\\\baz')  // false\npath.isAbsolute('.')         // false\n
\n
Note: If the path string passed as parameter is a zero-length string, unlike\n        other path module functions, it will be used as-is and false will be\n        returned.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "path.join([path1][, path2][, ...])",
          "type": "method",
          "name": "join",
          "meta": {
            "added": [
              "v0.1.16"
            ]
          },
          "desc": "
Join all arguments together and normalize the resulting path.
\n
Arguments must be strings.  In v0.8, non-string arguments were\nsilently ignored.  In v0.10 and up, an exception is thrown.
\n
Example:
\n
path.join('/foo', 'bar', 'baz/asdf', 'quux', '..')\n// returns '/foo/bar/baz/asdf'\n\npath.join('foo', {}, 'bar')\n// throws exception\nTypeError: Arguments to path.join must be strings\n
\n
Note: If the arguments to join have zero-length strings, unlike other path\n        module functions, they will be ignored. If the joined path string is a\n        zero-length string then '.' will be returned, which represents the\n        current working directory.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "path1",
                  "optional": true
                },
                {
                  "name": "path2",
                  "optional": true
                },
                {
                  "name": "...",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "path.normalize(p)",
          "type": "method",
          "name": "normalize",
          "meta": {
            "added": [
              "v0.1.23"
            ]
          },
          "desc": "
Normalize a string path, taking care of '..' and '.' parts.
\n
When multiple slashes are found, they're replaced by a single one;\nwhen the path contains a trailing slash, it is preserved.\nOn Windows backslashes are used.
\n
Example:
\n
path.normalize('/foo/bar//baz/asdf/quux/..')\n// returns '/foo/bar/baz/asdf'\n
\n
Note: If the path string passed as argument is a zero-length string then '.'\n        will be returned, which represents the current working directory.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "p"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "path.parse(pathString)",
          "type": "method",
          "name": "parse",
          "meta": {
            "added": [
              "v0.11.15"
            ]
          },
          "desc": "
Returns an object from a path string.
\n
An example on *nix:
\n
path.parse('/home/user/dir/file.txt')\n// returns\n// {\n//    root : "/",\n//    dir : "/home/user/dir",\n//    base : "file.txt",\n//    ext : ".txt",\n//    name : "file"\n// }\n
\n
An example on Windows:
\n
path.parse('C:\\\\path\\\\dir\\\\index.html')\n// returns\n// {\n//    root : "C:\\\\",\n//    dir : "C:\\\\path\\\\dir",\n//    base : "index.html",\n//    ext : ".html",\n//    name : "index"\n// }\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "pathString"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "path.relative(from, to)",
          "type": "method",
          "name": "relative",
          "meta": {
            "added": [
              "v0.5.0"
            ]
          },
          "desc": "
Solve the relative path from from to to.
\n
At times we have two absolute paths, and we need to derive the relative\npath from one to the other.  This is actually the reverse transform of\npath.resolve, which means we see that:
\n
path.resolve(from, path.relative(from, to)) == path.resolve(to)\n
\n
Examples:
\n
path.relative('C:\\\\orandea\\\\test\\\\aaa', 'C:\\\\orandea\\\\impl\\\\bbb')\n// returns '..\\\\..\\\\impl\\\\bbb'\n\npath.relative('/data/orandea/test/aaa', '/data/orandea/impl/bbb')\n// returns '../../impl/bbb'\n
\n
Note: If the arguments to relative have zero-length strings then the current\n        working directory will be used instead of the zero-length strings. If\n        both the paths are the same then a zero-length string will be returned.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "from"
                },
                {
                  "name": "to"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "path.resolve([from ...], to)",
          "type": "method",
          "name": "resolve",
          "meta": {
            "added": [
              "v0.3.4"
            ]
          },
          "desc": "
Resolves to to an absolute path.
\n
If to isn't already absolute from arguments are prepended in right to left\norder, until an absolute path is found. If after using all from paths still\nno absolute path is found, the current working directory is used as well. The\nresulting path is normalized, and trailing slashes are removed unless the path\ngets resolved to the root directory. Non-string from arguments are ignored.
\n
Another way to think of it is as a sequence of cd commands in a shell.
\n
path.resolve('foo/bar', '/tmp/file/', '..', 'a/../subfile')\n
\n
Is similar to:
\n
cd foo/bar\ncd /tmp/file/\ncd ..\ncd a/../subfile\npwd\n
The difference is that the different paths don't need to exist and may also be\nfiles.
\n
Examples:
\n
path.resolve('/foo/bar', './baz')\n// returns '/foo/bar/baz'\n\npath.resolve('/foo/bar', '/tmp/file/')\n// returns '/tmp/file'\n\npath.resolve('wwwroot', 'static_files/png/', '../gif/image.gif')\n// if currently in /home/myself/node, it returns\n// '/home/myself/node/wwwroot/static_files/gif/image.gif'\n
\n
Note: If the arguments to resolve have zero-length strings then the current\n        working directory will be used instead of them.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "from ...",
                  "optional": true
                },
                {
                  "name": "to"
                }
              ]
            }
          ]
        }
      ],
      "properties": [
        {
          "textRaw": "path.delimiter",
          "name": "delimiter",
          "meta": {
            "added": [
              "v0.9.3"
            ]
          },
          "desc": "
The platform-specific path delimiter, ; or ':'.
\n
An example on *nix:
\n
console.log(process.env.PATH)\n// '/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin'\n\nprocess.env.PATH.split(path.delimiter)\n// returns ['/usr/bin', '/bin', '/usr/sbin', '/sbin', '/usr/local/bin']\n
\n
An example on Windows:
\n
console.log(process.env.PATH)\n// 'C:\\Windows\\system32;C:\\Windows;C:\\Program Files\\node\\'\n\nprocess.env.PATH.split(path.delimiter)\n// returns ['C:\\\\Windows\\\\system32', 'C:\\\\Windows', 'C:\\\\Program Files\\\\node\\\\']\n
\n"
        },
        {
          "textRaw": "path.posix",
          "name": "posix",
          "meta": {
            "added": [
              "v0.11.15"
            ]
          },
          "desc": "
Provide access to aforementioned path methods but always interact in a posix\ncompatible way.
\n"
        },
        {
          "textRaw": "path.sep",
          "name": "sep",
          "meta": {
            "added": [
              "v0.7.9"
            ]
          },
          "desc": "
The platform-specific file separator. '\\\\' or '/'.
\n
An example on *nix:
\n
'foo/bar/baz'.split(path.sep)\n// returns ['foo', 'bar', 'baz']\n
\n
An example on Windows:
\n
'foo\\\\bar\\\\baz'.split(path.sep)\n// returns ['foo', 'bar', 'baz']\n
\n"
        },
        {
          "textRaw": "path.win32",
          "name": "win32",
          "meta": {
            "added": [
              "v0.11.15"
            ]
          },
          "desc": "
Provide access to aforementioned path methods but always interact in a win32\ncompatible way.
\n"
        }
      ],
      "type": "module",
      "displayName": "Path"
    }
  ]
}
node-v4.8.2/doc/api/path.md000644 000766 000024 00000016662 13070706735 015567 0ustar00iojsstaff000000 000000 # Path

> Stability: 2 - Stable

This module contains utilities for handling and transforming file
paths.  Almost all these methods perform only string transformations.
The file system is not consulted to check whether paths are valid.

Use `require('path')` to use this module.  The following methods are provided:

## path.basename(p[, ext])


Return the last portion of a path.  Similar to the Unix `basename` command.

Example:

```js
path.basename('/foo/bar/baz/asdf/quux.html')
// returns 'quux.html'

path.basename('/foo/bar/baz/asdf/quux.html', '.html')
// returns 'quux'
```

## path.delimiter


The platform-specific path delimiter, `;` or `':'`.

An example on \*nix:

```js
console.log(process.env.PATH)
// '/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin'

process.env.PATH.split(path.delimiter)
// returns ['/usr/bin', '/bin', '/usr/sbin', '/sbin', '/usr/local/bin']
```

An example on Windows:

```js
console.log(process.env.PATH)
// 'C:\Windows\system32;C:\Windows;C:\Program Files\node\'

process.env.PATH.split(path.delimiter)
// returns ['C:\\Windows\\system32', 'C:\\Windows', 'C:\\Program Files\\node\\']
```

## path.dirname(p)


Return the directory name of a path.  Similar to the Unix `dirname` command.

Example:

```js
path.dirname('/foo/bar/baz/asdf/quux')
// returns '/foo/bar/baz/asdf'
```

## path.extname(p)


Return the extension of the path, from the last '.' to end of string
in the last portion of the path.  If there is no '.' in the last portion
of the path or the first character of it is '.', then it returns
an empty string.  Examples:

```js
path.extname('index.html')
// returns '.html'

path.extname('index.coffee.md')
// returns '.md'

path.extname('index.')
// returns '.'

path.extname('index')
// returns ''

path.extname('.index')
// returns ''
```

## path.format(pathObject)


Returns a path string from an object, the opposite of [`path.parse`][].

Examples:

Some Posix system examples:

```js
// If `dir` and `base` are provided, `dir` + platform separator + `base`
// will be returned.
path.format({
    dir: '/home/user/dir',
    base: 'file.txt'
});
// returns '/home/user/dir/file.txt'

// `base` will be returned if `dir` or `root` are not provided.
path.format({
    base: 'file.txt'
});
// returns 'file.txt'
```

## path.isAbsolute(path)


Determines whether `path` is an absolute path. An absolute path will always
resolve to the same location, regardless of the working directory.

Posix examples:

```js
path.isAbsolute('/foo/bar') // true
path.isAbsolute('/baz/..')  // true
path.isAbsolute('qux/')     // false
path.isAbsolute('.')        // false
```

Windows examples:

```js
path.isAbsolute('//server')  // true
path.isAbsolute('C:/foo/..') // true
path.isAbsolute('bar\\baz')  // false
path.isAbsolute('.')         // false
```

*Note:* If the path string passed as parameter is a zero-length string, unlike
        other path module functions, it will be used as-is and `false` will be
        returned.

## path.join([path1][, path2][, ...])


Join all arguments together and normalize the resulting path.

Arguments must be strings.  In v0.8, non-string arguments were
silently ignored.  In v0.10 and up, an exception is thrown.

Example:

```js
path.join('/foo', 'bar', 'baz/asdf', 'quux', '..')
// returns '/foo/bar/baz/asdf'

path.join('foo', {}, 'bar')
// throws exception
TypeError: Arguments to path.join must be strings
```

*Note:* If the arguments to `join` have zero-length strings, unlike other path
        module functions, they will be ignored. If the joined path string is a
        zero-length string then `'.'` will be returned, which represents the
        current working directory.

## path.normalize(p)


Normalize a string path, taking care of `'..'` and `'.'` parts.

When multiple slashes are found, they're replaced by a single one;
when the path contains a trailing slash, it is preserved.
On Windows backslashes are used.

Example:

```js
path.normalize('/foo/bar//baz/asdf/quux/..')
// returns '/foo/bar/baz/asdf'
```

*Note:* If the path string passed as argument is a zero-length string then `'.'`
        will be returned, which represents the current working directory.

## path.parse(pathString)


Returns an object from a path string.

An example on \*nix:

```js
path.parse('/home/user/dir/file.txt')
// returns
// {
//    root : "/",
//    dir : "/home/user/dir",
//    base : "file.txt",
//    ext : ".txt",
//    name : "file"
// }
```

An example on Windows:

```js
path.parse('C:\\path\\dir\\index.html')
// returns
// {
//    root : "C:\\",
//    dir : "C:\\path\\dir",
//    base : "index.html",
//    ext : ".html",
//    name : "index"
// }
```

## path.posix


Provide access to aforementioned `path` methods but always interact in a posix
compatible way.

## path.relative(from, to)


Solve the relative path from `from` to `to`.

At times we have two absolute paths, and we need to derive the relative
path from one to the other.  This is actually the reverse transform of
`path.resolve`, which means we see that:

```js
path.resolve(from, path.relative(from, to)) == path.resolve(to)
```

Examples:

```js
path.relative('C:\\orandea\\test\\aaa', 'C:\\orandea\\impl\\bbb')
// returns '..\\..\\impl\\bbb'

path.relative('/data/orandea/test/aaa', '/data/orandea/impl/bbb')
// returns '../../impl/bbb'
```

*Note:* If the arguments to `relative` have zero-length strings then the current
        working directory will be used instead of the zero-length strings. If
        both the paths are the same then a zero-length string will be returned.

## path.resolve([from ...], to)


Resolves `to` to an absolute path.

If `to` isn't already absolute `from` arguments are prepended in right to left
order, until an absolute path is found. If after using all `from` paths still
no absolute path is found, the current working directory is used as well. The
resulting path is normalized, and trailing slashes are removed unless the path
gets resolved to the root directory. Non-string `from` arguments are ignored.

Another way to think of it is as a sequence of `cd` commands in a shell.

```js
path.resolve('foo/bar', '/tmp/file/', '..', 'a/../subfile')
```

Is similar to:

```
cd foo/bar
cd /tmp/file/
cd ..
cd a/../subfile
pwd
```

The difference is that the different paths don't need to exist and may also be
files.

Examples:

```js
path.resolve('/foo/bar', './baz')
// returns '/foo/bar/baz'

path.resolve('/foo/bar', '/tmp/file/')
// returns '/tmp/file'

path.resolve('wwwroot', 'static_files/png/', '../gif/image.gif')
// if currently in /home/myself/node, it returns
// '/home/myself/node/wwwroot/static_files/gif/image.gif'
```

*Note:* If the arguments to `resolve` have zero-length strings then the current
        working directory will be used instead of them.

## path.sep


The platform-specific file separator. `'\\'` or `'/'`.

An example on \*nix:

```js
'foo/bar/baz'.split(path.sep)
// returns ['foo', 'bar', 'baz']
```

An example on Windows:

```js
'foo\\bar\\baz'.split(path.sep)
// returns ['foo', 'bar', 'baz']
```

## path.win32


Provide access to aforementioned `path` methods but always interact in a win32
compatible way.

[`path.parse`]: #path_path_parse_pathstring
node-v4.8.2/doc/api/process.html000644 000766 000024 00000167715 13070706740 016657 0ustar00iojsstaff000000 000000 


  
  Process | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

      

        
Process#



The process object is a global object and can be accessed from anywhere.
It is an instance of EventEmitter.


Event: 'beforeExit'#



Added in: v0.11.12

This event is emitted when Node.js empties its event loop and has nothing else
to schedule. Normally, Node.js exits when there is no work scheduled, but a
listener for 'beforeExit' can make asynchronous calls, and cause Node.js to
continue.


'beforeExit' is not emitted for conditions causing explicit termination, such
as process.exit() or uncaught exceptions, and should not be used as an
alternative to the 'exit' event unless the intention is to schedule more work.


Event: 'exit'#



Added in: v0.1.7

Emitted when the process is about to exit. There is no way to prevent the
exiting of the event loop at this point, and once all 'exit' listeners have
finished running the process will exit. Therefore you must only perform
synchronous operations in this handler. This is a good hook to perform
checks on the module's state (like for unit tests). The callback takes one
argument, the code the process is exiting with.


This event is only emitted when Node.js exits explicitly by process.exit() or
implicitly by the event loop draining.


Example of listening for 'exit':


process.on('exit', (code) => {
  // do *NOT* do this
  setTimeout(() => {
    console.log('This will not run');
  }, 0);
  console.log('About to exit with code:', code);
});



Event: 'message'#



Added in: v0.5.10



Messages sent by ChildProcess.send() are obtained using the 'message'
event on the child's process object.


Event: 'rejectionHandled'#



Added in: v1.4.1

Emitted whenever a Promise was rejected and an error handler was attached to it
(for example with .catch()) later than after an event loop turn. This event
is emitted with the following arguments:


    

  • p the promise that was previously emitted in an 'unhandledRejection'
event, but which has now gained a rejection handler.
    • 



There is no notion of a top level for a promise chain at which rejections can
always be handled. Being inherently asynchronous in nature, a promise rejection
can be handled at a future point in time — possibly much later than the
event loop turn it takes for the 'unhandledRejection' event to be emitted.


Another way of stating this is that, unlike in synchronous code where there is
an ever-growing list of unhandled exceptions, with promises there is a
growing-and-shrinking list of unhandled rejections. In synchronous code, the
'uncaughtException' event tells you when the list of unhandled exceptions
grows. And in asynchronous code, the 'unhandledRejection' event tells you
when the list of unhandled rejections grows, while the 'rejectionHandled'
event tells you when the list of unhandled rejections shrinks.


For example using the rejection detection hooks in order to keep a map of all
the rejected promise reasons at a given time:


const unhandledRejections = new Map();
process.on('unhandledRejection', (reason, p) => {
  unhandledRejections.set(p, reason);
});
process.on('rejectionHandled', (p) => {
  unhandledRejections.delete(p);
});



This map will grow and shrink over time, reflecting rejections that start
unhandled and then become handled. You could record the errors in some error
log, either periodically (probably best for long-running programs, allowing
you to clear the map, which in the case of a very buggy program could grow
indefinitely) or upon process exit (more convenient for scripts).


Event: 'uncaughtException'#



Added in: v0.1.18

The 'uncaughtException' event is emitted when an exception bubbles all the
way back to the event loop. By default, Node.js handles such exceptions by
printing the stack trace to stderr and exiting. Adding a handler for the
'uncaughtException' event overrides this default behavior.


For example:


process.on('uncaughtException', (err) => {
  console.log(`Caught exception: ${err}`);
});

setTimeout(() => {
  console.log('This will still run.');
}, 500);

// Intentionally cause an exception, but don't catch it.
nonexistentFunc();
console.log('This will not run.');



Warning: Using 'uncaughtException' correctly#


Note that 'uncaughtException' is a crude mechanism for exception handling
intended to be used only as a last resort. The event should not be used as
an equivalent to On Error Resume Next. Unhandled exceptions inherently mean
that an application is in an undefined state. Attempting to resume application
code without properly recovering from the exception can cause additional
unforeseen and unpredictable issues.


Exceptions thrown from within the event handler will not be caught. Instead the
process will exit with a non-zero exit code and the stack trace will be printed.
This is to avoid infinite recursion.


Attempting to resume normally after an uncaught exception can be similar to
pulling out of the power cord when upgrading a computer -- nine out of ten
times nothing happens - but the 10th time, the system becomes corrupted.


The correct use of 'uncaughtException' is to perform synchronous cleanup
of allocated resources (e.g. file descriptors, handles, etc) before shutting
down the process. It is not safe to resume normal operation after
'uncaughtException'.


Event: 'unhandledRejection'#



Added in: v1.4.1

Emitted whenever a Promise is rejected and no error handler is attached to
the promise within a turn of the event loop. When programming with promises
exceptions are encapsulated as rejected promises. Such promises can be caught
and handled using promise.catch(...) and rejections are propagated through
a promise chain. This event is useful for detecting and keeping track of
promises that were rejected whose rejections were not handled yet. This event
is emitted with the following arguments:


    

  • reason the object with which the promise was rejected (usually an
Error instance).
    • 

  • p the promise that was rejected.
    • 



Here is an example that logs every unhandled rejection to the console


process.on('unhandledRejection', (reason, p) => {
  console.log('Unhandled Rejection at: Promise', p, 'reason:', reason);
  // application specific logging, throwing an error, or other logic here
});



For example, here is a rejection that will trigger the 'unhandledRejection'
event:


somePromise.then((res) => {
  return reportToUser(JSON.pasre(res)); // note the typo (`pasre`)
}); // no `.catch` or `.then`



Here is an example of a coding pattern that will also trigger
'unhandledRejection':


function SomeResource() {
  // Initially set the loaded status to a rejected promise
  this.loaded = Promise.reject(new Error('Resource not yet loaded!'));
}

var resource = new SomeResource();
// no .catch or .then on resource.loaded for at least a turn



In cases like this, you may not want to track the rejection as a developer
error like you would for other 'unhandledRejection' events. To address
this, you can either attach a dummy .catch(() => { }) handler to
resource.loaded, preventing the 'unhandledRejection' event from being
emitted, or you can use the 'rejectionHandled' event.


Exit Codes#


Node.js will normally exit with a 0 status code when no more async
operations are pending.  The following status codes are used in other
cases:


    

  • 1 Uncaught Fatal Exception - There was an uncaught exception,
and it was not handled by a domain or an 'uncaughtException' event
handler.
    • 

  • 2 - Unused (reserved by Bash for builtin misuse)
    • 

  • 3 Internal JavaScript Parse Error - The JavaScript source code
internal in Node.js's bootstrapping process caused a parse error.  This
is extremely rare, and generally can only happen during development
of Node.js itself.
    • 

  • 4 Internal JavaScript Evaluation Failure - The JavaScript
source code internal in Node.js's bootstrapping process failed to
return a function value when evaluated.  This is extremely rare, and
generally can only happen during development of Node.js itself.
    • 

  • 5 Fatal Error - There was a fatal unrecoverable error in V8.
Typically a message will be printed to stderr with the prefix FATAL
ERROR.
    • 

  • 6 Non-function Internal Exception Handler - There was an
uncaught exception, but the internal fatal exception handler
function was somehow set to a non-function, and could not be called.
    • 

  • 7 Internal Exception Handler Run-Time Failure - There was an
uncaught exception, and the internal fatal exception handler
function itself threw an error while attempting to handle it.  This
can happen, for example, if a process.on('uncaughtException') or
domain.on('error') handler throws an error.
    • 

  • 8 - Unused.  In previous versions of Node.js, exit code 8 sometimes
indicated an uncaught exception.
    • 

  • 9 - Invalid Argument - Either an unknown option was specified,
or an option requiring a value was provided without a value.
    • 

  • 10 Internal JavaScript Run-Time Failure - The JavaScript
source code internal in Node.js's bootstrapping process threw an error
when the bootstrapping function was called.  This is extremely rare,
and generally can only happen during development of Node.js itself.
    • 

  • 12 Invalid Debug Argument - The --debug and/or --debug-brk
options were set, but an invalid port number was chosen.
    • 

  • >128 Signal Exits - If Node.js receives a fatal signal such as
SIGKILL or SIGHUP, then its exit code will be 128 plus the
value of the signal code.  This is a standard Unix practice, since
exit codes are defined to be 7-bit integers, and signal exits set
the high-order bit, and then contain the value of the signal code.
    • 



Signal Events#




Emitted when the processes receives a signal. See sigaction(7) for a list of
standard POSIX signal names such as SIGINT, SIGHUP, etc.


Example of listening for SIGINT:


// Start reading from stdin so we don't exit.
process.stdin.resume();

process.on('SIGINT', () => {
  console.log('Got SIGINT.  Press Control-D to exit.');
});



An easy way to send the SIGINT signal is with Control-C in most terminal
programs.


Note:


    

  • SIGUSR1 is reserved by Node.js to start the debugger.  It's possible to
install a listener but that won't stop the debugger from starting.
    • 

  • SIGTERM and SIGINT have default handlers on non-Windows platforms that
resets the terminal mode before exiting with code 128 + signal number. If
one of these signals has a listener installed, its default behavior will be
removed (Node.js will no longer exit).
    • 

  • SIGPIPE is ignored by default. It can have a listener installed.
    • 

  • SIGHUP is generated on Windows when the console window is closed, and on other
platforms under various similar conditions, see signal(7). It can have a
listener installed, however Node.js will be unconditionally terminated by
Windows about 10 seconds later. On non-Windows platforms, the default
behavior of SIGHUP is to terminate Node.js, but once a listener has been
installed its default behavior will be removed.
    • 

  • SIGTERM is not supported on Windows, it can be listened on.
    • 

  • SIGINT from the terminal is supported on all platforms, and can usually be
generated with CTRL+C (though this may be configurable). It is not generated
when terminal raw mode is enabled.
    • 

  • SIGBREAK is delivered on Windows when CTRL+BREAK is pressed, on
non-Windows
platforms it can be listened on, but there is no way to send or generate it.
    • 

  • SIGWINCH is delivered when the console has been resized. On Windows, this
will only happen on write to the console when the cursor is being moved, or
when a readable tty is used in raw mode.
    • 

  • SIGKILL cannot have a listener installed, it will unconditionally terminate
Node.js on all platforms.
    • 

  • SIGSTOP cannot have a listener installed.
    • 



Note that Windows does not support sending Signals, but Node.js offers some
emulation with process.kill(), and child_process.kill(). Sending signal 0
can be used to test for the existence of a process. Sending SIGINT,
SIGTERM, and SIGKILL cause the unconditional termination of the target
process.


process.abort()#



Added in: v0.7.0

This causes Node.js to emit an abort. This will cause Node.js to exit and
generate a core file.


process.arch#



Added in: v0.5.0

What processor architecture you're running on: 'arm', 'ia32', or 'x64'.


console.log('This processor architecture is ' + process.arch);



process.argv#



Added in: v0.1.27

An array containing the command line arguments.  The first element will be
'node', the second element will be the name of the JavaScript file.  The
next elements will be any additional command line arguments.


// print process.argv
process.argv.forEach((val, index, array) => {
  console.log(`${index}: ${val}`);
});



This will generate:


$ node process-2.js one two=three four
0: node
1: /Users/mjr/work/node/process-2.js
2: one
3: two=three
4: four

process.chdir(directory)#



Added in: v0.1.17

Changes the current working directory of the process or throws an exception if that fails.


console.log(`Starting directory: ${process.cwd()}`);
try {
  process.chdir('/tmp');
  console.log(`New directory: ${process.cwd()}`);
}
catch (err) {
  console.log(`chdir: ${err}`);
}



process.config#



Added in: v0.7.7

An Object containing the JavaScript representation of the configure options
that were used to compile the current Node.js executable. This is the same as
the config.gypi file that was produced when running the ./configure script.


An example of the possible output looks like:


{
  target_defaults:
   { cflags: [],
     default_configuration: 'Release',
     defines: [],
     include_dirs: [],
     libraries: [] },
  variables:
   {
     host_arch: 'x64',
     node_install_npm: 'true',
     node_prefix: '',
     node_shared_cares: 'false',
     node_shared_http_parser: 'false',
     node_shared_libuv: 'false',
     node_shared_zlib: 'false',
     node_use_dtrace: 'false',
     node_use_openssl: 'true',
     node_shared_openssl: 'false',
     strict_aliasing: 'true',
     target_arch: 'x64',
     v8_use_snapshot: 'true'
   }
}

Note: the process.config property is not read-only and there are existing
modules in the ecosystem that are known to extend, modify, or entirely replace
the value of process.config.


process.connected#



Added in: v0.7.2

    

  • <Boolean> Set to false after process.disconnect() is called
    • 



If process.connected is false, it is no longer possible to send messages.


process.cpuUsage([previousValue])#


Returns the user and system CPU time usage of the current process, in an object
with properties user and system, whose values are microsecond values
(millionth of a second). These values measure time spent in user and
system code respectively, and may end up being greater than actual elapsed time
if multiple CPU cores are performing work for this process.


The result of a previous call to process.cpuUsage() can be passed as the
argument to the function, to get a diff reading.


const startUsage = process.cpuUsage();
// { user: 38579, system: 6986 }

// spin the CPU for 500 milliseconds
const now = Date.now();
while (Date.now() - now < 500);

console.log(process.cpuUsage(startUsage));
// { user: 514883, system: 11226 }



process.cwd()#



Added in: v0.1.8

Returns the current working directory of the process.


console.log(`Current directory: ${process.cwd()}`);



process.disconnect()#



Added in: v0.7.2

Close the IPC channel to the parent process, allowing this child to exit
gracefully once there are no other connections keeping it alive.


Identical to the parent process's ChildProcess.disconnect().


If Node.js was not spawned with an IPC channel, process.disconnect() will be
undefined.


process.env#



Added in: v0.1.27

An object containing the user environment. See environ(7).


An example of this object looks like:


{ TERM: 'xterm-256color',
  SHELL: '/usr/local/bin/bash',
  USER: 'maciej',
  PATH: '~/.bin/:/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin',
  PWD: '/Users/maciej',
  EDITOR: 'vim',
  SHLVL: '1',
  HOME: '/Users/maciej',
  LOGNAME: 'maciej',
  _: '/usr/local/bin/node' }



You can write to this object, but changes won't be reflected outside of your
process. That means that the following won't work:


$ node -e 'process.env.foo = "bar"' && echo $foo

But this will:


process.env.foo = 'bar';
console.log(process.env.foo);



Assigning a property on process.env will implicitly convert the value
to a string.


Example:


process.env.test = null;
console.log(process.env.test);
// => 'null'
process.env.test = undefined;
console.log(process.env.test);
// => 'undefined'



Use delete to delete a property from process.env.


Example:


process.env.TEST = 1;
delete process.env.TEST;
console.log(process.env.TEST);
// => undefined



process.execArgv#



Added in: v0.7.7

This is the set of Node.js-specific command line options from the
executable that started the process.  These options do not show up in
process.argv, and do not include the Node.js executable, the name of
the script, or any options following the script name. These options
are useful in order to spawn child processes with the same execution
environment as the parent.


Example:


$ node --harmony script.js --version

results in process.execArgv:


['--harmony']



and process.argv:


['/usr/local/bin/node', 'script.js', '--version']



process.execPath#



Added in: v0.1.100

This is the absolute pathname of the executable that started the process.


Example:


/usr/local/bin/node

process.exit([code])#



Added in: v0.1.13

Ends the process with the specified code.  If omitted, exit uses the
'success' code 0.


To exit with a 'failure' code:


process.exit(1);



The shell that executed Node.js should see the exit code as 1.


process.exitCode#



Added in: v0.11.8

A number which will be the process exit code, when the process either
exits gracefully, or is exited via process.exit() without specifying
a code.


Specifying a code to process.exit(code) will override any previous
setting of process.exitCode.


process.getegid()#



Added in: v2.0.0

Note: this function is only available on POSIX platforms (i.e. not Windows,
Android)


Gets the effective group identity of the process. (See getegid(2).)
This is the numerical group id, not the group name.


if (process.getegid) {
  console.log(`Current gid: ${process.getegid()}`);
}



process.geteuid()#



Added in: v2.0.0

Note: this function is only available on POSIX platforms (i.e. not Windows,
Android)


Gets the effective user identity of the process. (See geteuid(2).)
This is the numerical userid, not the username.


if (process.geteuid) {
  console.log(`Current uid: ${process.geteuid()}`);
}



process.getgid()#



Added in: v0.1.31

Note: this function is only available on POSIX platforms (i.e. not Windows,
Android)


Gets the group identity of the process. (See getgid(2).)
This is the numerical group id, not the group name.


if (process.getgid) {
  console.log(`Current gid: ${process.getgid()}`);
}



process.getgroups()#



Added in: v0.9.4

Note: this function is only available on POSIX platforms (i.e. not Windows,
Android)


Returns an array with the supplementary group IDs. POSIX leaves it unspecified
if the effective group ID is included but Node.js ensures it always is.


process.getuid()#



Added in: v0.1.28

Note: this function is only available on POSIX platforms (i.e. not Windows,
Android)


Gets the user identity of the process. (See getuid(2).)
This is the numerical userid, not the username.


if (process.getuid) {
  console.log(`Current uid: ${process.getuid()}`);
}



process.hrtime()#



Added in: v0.7.6

Returns the current high-resolution real time in a [seconds, nanoseconds]
tuple Array. It is relative to an arbitrary time in the past. It is not
related to the time of day and therefore not subject to clock drift. The
primary use is for measuring performance between intervals.


You may pass in the result of a previous call to process.hrtime() to get
a diff reading, useful for benchmarks and measuring intervals:


var time = process.hrtime();
// [ 1800216, 25 ]

setTimeout(() => {
  var diff = process.hrtime(time);
  // [ 1, 552 ]

  console.log('benchmark took %d nanoseconds', diff[0] * 1e9 + diff[1]);
  // benchmark took 1000000527 nanoseconds
}, 1000);



process.initgroups(user, extra_group)#



Added in: v0.9.4

Note: this function is only available on POSIX platforms (i.e. not Windows,
Android)


Reads /etc/group and initializes the group access list, using all groups of
which the user is a member. This is a privileged operation, meaning you need
to be root or have the CAP_SETGID capability.


user is a user name or user ID. extra_group is a group name or group ID.


Some care needs to be taken when dropping privileges. Example:


console.log(process.getgroups());         // [ 0 ]
process.initgroups('bnoordhuis', 1000);   // switch user
console.log(process.getgroups());         // [ 27, 30, 46, 1000, 0 ]
process.setgid(1000);                     // drop root gid
console.log(process.getgroups());         // [ 27, 30, 46, 1000 ]



process.kill(pid[, signal])#



Added in: v0.0.6

Send a signal to a process. pid is the process id and signal is the
string describing the signal to send.  Signal names are strings like
SIGINT or SIGHUP.  If omitted, the signal will be SIGTERM.
See Signal Events and kill(2) for more information.


Will throw an error if target does not exist, and as a special case, a signal
of 0 can be used to test for the existence of a process. Windows platforms
will throw an error if the pid is used to kill a process group.


Note that even though the name of this function is process.kill, it is really
just a signal sender, like the kill system call.  The signal sent may do
something other than kill the target process.


Example of sending a signal to yourself:


process.on('SIGHUP', () => {
  console.log('Got SIGHUP signal.');
});

setTimeout(() => {
  console.log('Exiting.');
  process.exit(0);
}, 100);

process.kill(process.pid, 'SIGHUP');



Note: When SIGUSR1 is received by Node.js it starts the debugger, see
Signal Events.


process.mainModule#



Added in: v0.1.17

Alternate way to retrieve require.main. The difference is that if the main
module changes at runtime, require.main might still refer to the original main
module in modules that were required before the change occurred. Generally it's
safe to assume that the two refer to the same module.


As with require.main, it will be undefined if there was no entry script.


process.memoryUsage()#



Added in: v0.1.16

    

  • Returns: <Object>
      

    • rss <Integer>
      • 

    • heapTotal <Integer>
      • 

    • heapUsed <Integer>
      • 

    • external <Integer>
      • 

    

    • 



The process.memoryUsage() method returns an object describing the memory usage
of the Node.js process measured in bytes.


For example, the code:


console.log(process.memoryUsage());



This will generate:


{ rss: 4935680,
  heapTotal: 1826816,
  heapUsed: 650472,
  external: 49879
}



heapTotal and heapUsed refer to V8's memory usage.
external refers to the memory usage of C++ objects bound to JavaScript
objects managed by V8.


process.nextTick(callback[, arg][, ...])#



Added in: v0.1.26



Once the current event loop turn runs to completion, call the callback
function.


This is not a simple alias to setTimeout(fn, 0), it's much more
efficient.  It runs before any additional I/O events (including
timers) fire in subsequent ticks of the event loop.


console.log('start');
process.nextTick(() => {
  console.log('nextTick callback');
});
console.log('scheduled');
// Output:
// start
// scheduled
// nextTick callback



This is important in developing APIs where you want to give the user the
chance to assign event handlers after an object has been constructed,
but before any I/O has occurred.


function MyThing(options) {
  this.setupOptions(options);

  process.nextTick(() => {
    this.startDoingStuff();
  });
}

var thing = new MyThing();
thing.getReadyForStuff();

// thing.startDoingStuff() gets called now, not before.



It is very important for APIs to be either 100% synchronous or 100%
asynchronous.  Consider this example:


// WARNING!  DO NOT USE!  BAD UNSAFE HAZARD!
function maybeSync(arg, cb) {
  if (arg) {
    cb();
    return;
  }

  fs.stat('file', cb);
}



This API is hazardous.  If you do this:


maybeSync(true, () => {
  foo();
});
bar();



then it's not clear whether foo() or bar() will be called first.


This approach is much better:


function definitelyAsync(arg, cb) {
  if (arg) {
    process.nextTick(cb);
    return;
  }

  fs.stat('file', cb);
}



Note: the nextTick queue is completely drained on each pass of the
event loop before additional I/O is processed.  As a result,
recursively setting nextTick callbacks will block any I/O from
happening, just like a while(true); loop.


process.pid#



Added in: v0.1.15

The PID of the process.


console.log(`This process is pid ${process.pid}`);



process.platform#



Added in: v0.1.16

What platform you're running on:
'darwin', 'freebsd', 'linux', 'sunos' or 'win32'


console.log(`This platform is ${process.platform}`);



process.release#



Added in: v3.0.0

An Object containing metadata related to the current release, including URLs
for the source tarball and headers-only tarball.


process.release contains the following properties:


    

  • name: a string with a value that will always be 'node' for Node.js. For
legacy io.js releases, this will be 'io.js'.
    • 

  • sourceUrl: a complete URL pointing to a .tar.gz file containing the
source of the current release.
    • 

  • headersUrl: a complete URL pointing to a .tar.gz file containing only
the header files for the current release. This file is significantly smaller
than the full source file and can be used for compiling add-ons against
Node.js.
    • 

  • libUrl: a complete URL pointing to an node.lib file matching the
architecture and version of the current release. This file is used for
compiling add-ons against Node.js. This property is only present on Windows
builds of Node.js and will be missing on all other platforms.
    • 



e.g.


{ name: 'node',
  sourceUrl: 'https://nodejs.org/download/release/v4.0.0/node-v4.0.0.tar.gz',
  headersUrl: 'https://nodejs.org/download/release/v4.0.0/node-v4.0.0-headers.tar.gz',
  libUrl: 'https://nodejs.org/download/release/v4.0.0/win-x64/node.lib' }



In custom builds from non-release versions of the source tree, only the
name property may be present. The additional properties should not be
relied upon to exist.


process.send(message[, sendHandle][, callback])#



Added in: v0.5.9



When Node.js is spawned with an IPC channel attached, it can send messages to its
parent process using process.send(). Each will be received as a
'message' event on the parent's ChildProcess object.


Note: this function uses JSON.stringify() internally to serialize the message.


If Node.js was not spawned with an IPC channel, process.send() will be undefined.


process.setegid(id)#



Added in: v2.0.0

Note: this function is only available on POSIX platforms (i.e. not Windows,
Android)


Sets the effective group identity of the process. (See setegid(2).)
This accepts either a numerical ID or a groupname string. If a groupname
is specified, this method blocks while resolving it to a numerical ID.


if (process.getegid && process.setegid) {
  console.log(`Current gid: ${process.getegid()}`);
  try {
    process.setegid(501);
    console.log(`New gid: ${process.getegid()}`);
  }
  catch (err) {
    console.log(`Failed to set gid: ${err}`);
  }
}



process.seteuid(id)#



Added in: v2.0.0

Note: this function is only available on POSIX platforms (i.e. not Windows,
Android)


Sets the effective user identity of the process. (See seteuid(2).)
This accepts either a numerical ID or a username string.  If a username
is specified, this method blocks while resolving it to a numerical ID.


if (process.geteuid && process.seteuid) {
  console.log(`Current uid: ${process.geteuid()}`);
  try {
    process.seteuid(501);
    console.log(`New uid: ${process.geteuid()}`);
  }
  catch (err) {
    console.log(`Failed to set uid: ${err}`);
  }
}



process.setgid(id)#



Added in: v0.1.31

Note: this function is only available on POSIX platforms (i.e. not Windows,
Android)


Sets the group identity of the process. (See setgid(2).)  This accepts either
a numerical ID or a groupname string. If a groupname is specified, this method
blocks while resolving it to a numerical ID.


if (process.getgid && process.setgid) {
  console.log(`Current gid: ${process.getgid()}`);
  try {
    process.setgid(501);
    console.log(`New gid: ${process.getgid()}`);
  }
  catch (err) {
    console.log(`Failed to set gid: ${err}`);
  }
}



process.setgroups(groups)#



Added in: v0.9.4

Note: this function is only available on POSIX platforms (i.e. not Windows,
Android)


Sets the supplementary group IDs. This is a privileged operation, meaning you
need to be root or have the CAP_SETGID capability.


The list can contain group IDs, group names or both.


process.setuid(id)#



Added in: v0.1.28

Note: this function is only available on POSIX platforms (i.e. not Windows,
Android)


Sets the user identity of the process. (See setuid(2).)  This accepts either
a numerical ID or a username string.  If a username is specified, this method
blocks while resolving it to a numerical ID.


if (process.getuid && process.setuid) {
  console.log(`Current uid: ${process.getuid()}`);
  try {
    process.setuid(501);
    console.log(`New uid: ${process.getuid()}`);
  }
  catch (err) {
    console.log(`Failed to set uid: ${err}`);
  }
}



process.stderr#


A writable stream to stderr (on fd 2).


process.stderr and process.stdout are unlike other streams in Node.js in
that they cannot be closed (end() will throw), they never emit the finish
event and that writes can block when output is redirected to a file (although
disks are fast and operating systems normally employ write-back caching so it
should be a very rare occurrence indeed.)


Additionally, process.stderr and process.stdout are blocking when outputting
to TTYs (terminals) on OS X as a workaround for the OS's very small, 1kb
buffer size. This is to prevent interleaving between stdout and stderr.


process.stdin#


A Readable Stream for stdin (on fd 0).


Example of opening standard input and listening for both events:


process.stdin.setEncoding('utf8');

process.stdin.on('readable', () => {
  var chunk = process.stdin.read();
  if (chunk !== null) {
    process.stdout.write(`data: ${chunk}`);
  }
});

process.stdin.on('end', () => {
  process.stdout.write('end');
});



As a Stream, process.stdin can also be used in "old" mode that is compatible
with scripts written for node.js prior to v0.10.
For more information see Stream compatibility.


In "old" Streams mode the stdin stream is paused by default, so one
must call process.stdin.resume() to read from it. Note also that calling
process.stdin.resume() itself would switch stream to "old" mode.


If you are starting a new project you should prefer a more recent "new" Streams
mode over "old" one.


process.stdout#


A Writable Stream to stdout (on fd 1).


For example, a console.log equivalent could look like this:


console.log = (msg) => {
  process.stdout.write(`${msg}\n`);
};



process.stderr and process.stdout are unlike other streams in Node.js in
that they cannot be closed (end() will throw), they never emit the 'finish'
event and that writes can block when output is redirected to a file (although
disks are fast and operating systems normally employ write-back caching so it
should be a very rare occurrence indeed.)


Additionally, process.stderr and process.stdout are blocking when outputting
to TTYs (terminals) on OS X as a workaround for the OS's very small, 1kb
buffer size. This is to prevent interleaving between stdout and stderr.


To check if Node.js is being run in a TTY context, read the isTTY property
on process.stderr, process.stdout, or process.stdin:


$ node -p "Boolean(process.stdin.isTTY)"
true
$ echo "foo" | node -p "Boolean(process.stdin.isTTY)"
false

$ node -p "Boolean(process.stdout.isTTY)"
true
$ node -p "Boolean(process.stdout.isTTY)" | cat
false

See the tty docs for more information.


process.title#



Added in: v0.1.104

Getter/setter to set what is displayed in ps.


When used as a setter, the maximum length is platform-specific and probably
short.


On Linux and OS X, it's limited to the size of the binary name plus the
length of the command line arguments because it overwrites the argv memory.


v0.8 allowed for longer process title strings by also overwriting the environ
memory but that was potentially insecure/confusing in some (rather obscure)
cases.


process.umask([mask])#



Added in: v0.1.19

Sets or reads the process's file mode creation mask. Child processes inherit
the mask from the parent process. Returns the old mask if mask argument is
given, otherwise returns the current mask.


const newmask = 0o022;
const oldmask = process.umask(newmask);
console.log(
  `Changed umask from ${oldmask.toString(8)} to ${newmask.toString(8)}`
);



process.uptime()#



Added in: v0.5.0

Number of seconds Node.js has been running.


process.version#



Added in: v0.1.3

A compiled-in property that exposes NODE_VERSION.


console.log(`Version: ${process.version}`);



process.versions#



Added in: v0.2.0

A property exposing version strings of Node.js and its dependencies.


console.log(process.versions);



Will print something like:


{ http_parser: '2.3.0',
  node: '1.1.1',
  v8: '4.1.0.14',
  uv: '1.3.0',
  zlib: '1.2.8',
  ares: '1.10.0-DEV',
  modules: '43',
  icu: '55.1',
  openssl: '1.0.1k' }



      

    

  

  
  
  
  



node-v4.8.2/doc/api/process.json000644 000766 000024 00000161102 13070706740 016644 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/process.md",
  "globals": [
    {
      "textRaw": "Process",
      "name": "Process",
      "type": "global",
      "desc": "
The process object is a global object and can be accessed from anywhere.\nIt is an instance of EventEmitter.
\n",
      "events": [
        {
          "textRaw": "Event: 'beforeExit'",
          "type": "event",
          "name": "beforeExit",
          "meta": {
            "added": [
              "v0.11.12"
            ]
          },
          "desc": "
This event is emitted when Node.js empties its event loop and has nothing else\nto schedule. Normally, Node.js exits when there is no work scheduled, but a\nlistener for 'beforeExit' can make asynchronous calls, and cause Node.js to\ncontinue.
\n
'beforeExit' is not emitted for conditions causing explicit termination, such\nas process.exit() or uncaught exceptions, and should not be used as an\nalternative to the 'exit' event unless the intention is to schedule more work.
\n",
          "params": []
        },
        {
          "textRaw": "Event: 'exit'",
          "type": "event",
          "name": "exit",
          "meta": {
            "added": [
              "v0.1.7"
            ]
          },
          "desc": "
Emitted when the process is about to exit. There is no way to prevent the\nexiting of the event loop at this point, and once all 'exit' listeners have\nfinished running the process will exit. Therefore you must only perform\nsynchronous operations in this handler. This is a good hook to perform\nchecks on the module's state (like for unit tests). The callback takes one\nargument, the code the process is exiting with.
\n
This event is only emitted when Node.js exits explicitly by process.exit() or\nimplicitly by the event loop draining.
\n
Example of listening for 'exit':
\n
process.on('exit', (code) => {\n  // do *NOT* do this\n  setTimeout(() => {\n    console.log('This will not run');\n  }, 0);\n  console.log('About to exit with code:', code);\n});\n
\n",
          "params": []
        },
        {
          "textRaw": "Event: 'message'",
          "type": "event",
          "name": "message",
          "meta": {
            "added": [
              "v0.5.10"
            ]
          },
          "params": [],
          "desc": "
Messages sent by ChildProcess.send() are obtained using the 'message'\nevent on the child's process object.
\n"
        },
        {
          "textRaw": "Event: 'rejectionHandled'",
          "type": "event",
          "name": "rejectionHandled",
          "meta": {
            "added": [
              "v1.4.1"
            ]
          },
          "desc": "
Emitted whenever a Promise was rejected and an error handler was attached to it\n(for example with .catch()) later than after an event loop turn. This event\nis emitted with the following arguments:
\n
    \n
  • p the promise that was previously emitted in an 'unhandledRejection'\nevent, but which has now gained a rejection handler.
    • \n
\n
There is no notion of a top level for a promise chain at which rejections can\nalways be handled. Being inherently asynchronous in nature, a promise rejection\ncan be handled at a future point in time — possibly much later than the\nevent loop turn it takes for the 'unhandledRejection' event to be emitted.
\n
Another way of stating this is that, unlike in synchronous code where there is\nan ever-growing list of unhandled exceptions, with promises there is a\ngrowing-and-shrinking list of unhandled rejections. In synchronous code, the\n'uncaughtException' event tells you when the list of unhandled exceptions\ngrows. And in asynchronous code, the 'unhandledRejection' event tells you\nwhen the list of unhandled rejections grows, while the 'rejectionHandled'\nevent tells you when the list of unhandled rejections shrinks.
\n
For example using the rejection detection hooks in order to keep a map of all\nthe rejected promise reasons at a given time:
\n
const unhandledRejections = new Map();\nprocess.on('unhandledRejection', (reason, p) => {\n  unhandledRejections.set(p, reason);\n});\nprocess.on('rejectionHandled', (p) => {\n  unhandledRejections.delete(p);\n});\n
\n
This map will grow and shrink over time, reflecting rejections that start\nunhandled and then become handled. You could record the errors in some error\nlog, either periodically (probably best for long-running programs, allowing\nyou to clear the map, which in the case of a very buggy program could grow\nindefinitely) or upon process exit (more convenient for scripts).
\n",
          "params": []
        },
        {
          "textRaw": "Event: 'uncaughtException'",
          "type": "event",
          "name": "uncaughtException",
          "meta": {
            "added": [
              "v0.1.18"
            ]
          },
          "desc": "
The 'uncaughtException' event is emitted when an exception bubbles all the\nway back to the event loop. By default, Node.js handles such exceptions by\nprinting the stack trace to stderr and exiting. Adding a handler for the\n'uncaughtException' event overrides this default behavior.
\n
For example:
\n
process.on('uncaughtException', (err) => {\n  console.log(`Caught exception: ${err}`);\n});\n\nsetTimeout(() => {\n  console.log('This will still run.');\n}, 500);\n\n// Intentionally cause an exception, but don't catch it.\nnonexistentFunc();\nconsole.log('This will not run.');\n
\n",
          "modules": [
            {
              "textRaw": "Warning: Using `'uncaughtException'` correctly",
              "name": "warning:_using_`'uncaughtexception'`_correctly",
              "desc": "
Note that 'uncaughtException' is a crude mechanism for exception handling\nintended to be used only as a last resort. The event should not be used as\nan equivalent to On Error Resume Next. Unhandled exceptions inherently mean\nthat an application is in an undefined state. Attempting to resume application\ncode without properly recovering from the exception can cause additional\nunforeseen and unpredictable issues.
\n
Exceptions thrown from within the event handler will not be caught. Instead the\nprocess will exit with a non-zero exit code and the stack trace will be printed.\nThis is to avoid infinite recursion.
\n
Attempting to resume normally after an uncaught exception can be similar to\npulling out of the power cord when upgrading a computer -- nine out of ten\ntimes nothing happens - but the 10th time, the system becomes corrupted.
\n
The correct use of 'uncaughtException' is to perform synchronous cleanup\nof allocated resources (e.g. file descriptors, handles, etc) before shutting\ndown the process. It is not safe to resume normal operation after\n'uncaughtException'.
\n",
              "type": "module",
              "displayName": "Warning: Using `'uncaughtException'` correctly"
            }
          ],
          "params": []
        },
        {
          "textRaw": "Event: 'unhandledRejection'",
          "type": "event",
          "name": "unhandledRejection",
          "meta": {
            "added": [
              "v1.4.1"
            ]
          },
          "desc": "
Emitted whenever a Promise is rejected and no error handler is attached to\nthe promise within a turn of the event loop. When programming with promises\nexceptions are encapsulated as rejected promises. Such promises can be caught\nand handled using promise.catch(...) and rejections are propagated through\na promise chain. This event is useful for detecting and keeping track of\npromises that were rejected whose rejections were not handled yet. This event\nis emitted with the following arguments:
\n
    \n
  • reason the object with which the promise was rejected (usually an\nError instance).
    • \n
  • p the promise that was rejected.
    • \n
\n
Here is an example that logs every unhandled rejection to the console
\n
process.on('unhandledRejection', (reason, p) => {\n  console.log('Unhandled Rejection at: Promise', p, 'reason:', reason);\n  // application specific logging, throwing an error, or other logic here\n});\n
\n
For example, here is a rejection that will trigger the 'unhandledRejection'\nevent:
\n
somePromise.then((res) => {\n  return reportToUser(JSON.pasre(res)); // note the typo (`pasre`)\n}); // no `.catch` or `.then`\n
\n
Here is an example of a coding pattern that will also trigger\n'unhandledRejection':
\n
function SomeResource() {\n  // Initially set the loaded status to a rejected promise\n  this.loaded = Promise.reject(new Error('Resource not yet loaded!'));\n}\n\nvar resource = new SomeResource();\n// no .catch or .then on resource.loaded for at least a turn\n
\n
In cases like this, you may not want to track the rejection as a developer\nerror like you would for other 'unhandledRejection' events. To address\nthis, you can either attach a dummy .catch(() => { }) handler to\nresource.loaded, preventing the 'unhandledRejection' event from being\nemitted, or you can use the 'rejectionHandled' event.
\n",
          "params": []
        },
        {
          "textRaw": "Signal Events",
          "name": "SIGINT, SIGHUP, etc.",
          "type": "event",
          "desc": "
Emitted when the processes receives a signal. See sigaction(7) for a list of\nstandard POSIX signal names such as SIGINT, SIGHUP, etc.
\n
Example of listening for SIGINT:
\n
// Start reading from stdin so we don't exit.\nprocess.stdin.resume();\n\nprocess.on('SIGINT', () => {\n  console.log('Got SIGINT.  Press Control-D to exit.');\n});\n
\n
An easy way to send the SIGINT signal is with Control-C in most terminal\nprograms.
\n
Note:
\n
    \n
  • SIGUSR1 is reserved by Node.js to start the debugger.  It's possible to\ninstall a listener but that won't stop the debugger from starting.
    • \n
  • SIGTERM and SIGINT have default handlers on non-Windows platforms that\nresets the terminal mode before exiting with code 128 + signal number. If\none of these signals has a listener installed, its default behavior will be\nremoved (Node.js will no longer exit).
    • \n
  • SIGPIPE is ignored by default. It can have a listener installed.
    • \n
  • SIGHUP is generated on Windows when the console window is closed, and on other\nplatforms under various similar conditions, see signal(7). It can have a\nlistener installed, however Node.js will be unconditionally terminated by\nWindows about 10 seconds later. On non-Windows platforms, the default\nbehavior of SIGHUP is to terminate Node.js, but once a listener has been\ninstalled its default behavior will be removed.
    • \n
  • SIGTERM is not supported on Windows, it can be listened on.
    • \n
  • SIGINT from the terminal is supported on all platforms, and can usually be\ngenerated with CTRL+C (though this may be configurable). It is not generated\nwhen terminal raw mode is enabled.
    • \n
  • SIGBREAK is delivered on Windows when CTRL+BREAK is pressed, on\nnon-Windows\nplatforms it can be listened on, but there is no way to send or generate it.
    • \n
  • SIGWINCH is delivered when the console has been resized. On Windows, this\nwill only happen on write to the console when the cursor is being moved, or\nwhen a readable tty is used in raw mode.
    • \n
  • SIGKILL cannot have a listener installed, it will unconditionally terminate\nNode.js on all platforms.
    • \n
  • SIGSTOP cannot have a listener installed.
    • \n
\n
Note that Windows does not support sending Signals, but Node.js offers some\nemulation with process.kill(), and child_process.kill(). Sending signal 0\ncan be used to test for the existence of a process. Sending SIGINT,\nSIGTERM, and SIGKILL cause the unconditional termination of the target\nprocess.
\n",
          "params": []
        }
      ],
      "modules": [
        {
          "textRaw": "Exit Codes",
          "name": "exit_codes",
          "desc": "
Node.js will normally exit with a 0 status code when no more async\noperations are pending.  The following status codes are used in other\ncases:
\n
    \n
  • 1 Uncaught Fatal Exception - There was an uncaught exception,\nand it was not handled by a domain or an 'uncaughtException' event\nhandler.
    • \n
  • 2 - Unused (reserved by Bash for builtin misuse)
    • \n
  • 3 Internal JavaScript Parse Error - The JavaScript source code\ninternal in Node.js's bootstrapping process caused a parse error.  This\nis extremely rare, and generally can only happen during development\nof Node.js itself.
    • \n
  • 4 Internal JavaScript Evaluation Failure - The JavaScript\nsource code internal in Node.js's bootstrapping process failed to\nreturn a function value when evaluated.  This is extremely rare, and\ngenerally can only happen during development of Node.js itself.
    • \n
  • 5 Fatal Error - There was a fatal unrecoverable error in V8.\nTypically a message will be printed to stderr with the prefix FATAL\nERROR.
    • \n
  • 6 Non-function Internal Exception Handler - There was an\nuncaught exception, but the internal fatal exception handler\nfunction was somehow set to a non-function, and could not be called.
    • \n
  • 7 Internal Exception Handler Run-Time Failure - There was an\nuncaught exception, and the internal fatal exception handler\nfunction itself threw an error while attempting to handle it.  This\ncan happen, for example, if a process.on('uncaughtException') or\ndomain.on('error') handler throws an error.
    • \n
  • 8 - Unused.  In previous versions of Node.js, exit code 8 sometimes\nindicated an uncaught exception.
    • \n
  • 9 - Invalid Argument - Either an unknown option was specified,\nor an option requiring a value was provided without a value.
    • \n
  • 10 Internal JavaScript Run-Time Failure - The JavaScript\nsource code internal in Node.js's bootstrapping process threw an error\nwhen the bootstrapping function was called.  This is extremely rare,\nand generally can only happen during development of Node.js itself.
    • \n
  • 12 Invalid Debug Argument - The --debug and/or --debug-brk\noptions were set, but an invalid port number was chosen.
    • \n
  • >128 Signal Exits - If Node.js receives a fatal signal such as\nSIGKILL or SIGHUP, then its exit code will be 128 plus the\nvalue of the signal code.  This is a standard Unix practice, since\nexit codes are defined to be 7-bit integers, and signal exits set\nthe high-order bit, and then contain the value of the signal code.
    • \n
\n",
          "type": "module",
          "displayName": "Exit Codes"
        }
      ],
      "methods": [
        {
          "textRaw": "process.abort()",
          "type": "method",
          "name": "abort",
          "meta": {
            "added": [
              "v0.7.0"
            ]
          },
          "desc": "
This causes Node.js to emit an abort. This will cause Node.js to exit and\ngenerate a core file.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "process.chdir(directory)",
          "type": "method",
          "name": "chdir",
          "meta": {
            "added": [
              "v0.1.17"
            ]
          },
          "desc": "
Changes the current working directory of the process or throws an exception if that fails.
\n
console.log(`Starting directory: ${process.cwd()}`);\ntry {\n  process.chdir('/tmp');\n  console.log(`New directory: ${process.cwd()}`);\n}\ncatch (err) {\n  console.log(`chdir: ${err}`);\n}\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "directory"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "process.cpuUsage([previousValue])",
          "type": "method",
          "name": "cpuUsage",
          "desc": "
Returns the user and system CPU time usage of the current process, in an object\nwith properties user and system, whose values are microsecond values\n(millionth of a second). These values measure time spent in user and\nsystem code respectively, and may end up being greater than actual elapsed time\nif multiple CPU cores are performing work for this process.
\n
The result of a previous call to process.cpuUsage() can be passed as the\nargument to the function, to get a diff reading.
\n
const startUsage = process.cpuUsage();\n// { user: 38579, system: 6986 }\n\n// spin the CPU for 500 milliseconds\nconst now = Date.now();\nwhile (Date.now() - now < 500);\n\nconsole.log(process.cpuUsage(startUsage));\n// { user: 514883, system: 11226 }\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "previousValue",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "process.cwd()",
          "type": "method",
          "name": "cwd",
          "meta": {
            "added": [
              "v0.1.8"
            ]
          },
          "desc": "
Returns the current working directory of the process.
\n
console.log(`Current directory: ${process.cwd()}`);\n
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "process.disconnect()",
          "type": "method",
          "name": "disconnect",
          "meta": {
            "added": [
              "v0.7.2"
            ]
          },
          "desc": "
Close the IPC channel to the parent process, allowing this child to exit\ngracefully once there are no other connections keeping it alive.
\n
Identical to the parent process's ChildProcess.disconnect().
\n
If Node.js was not spawned with an IPC channel, process.disconnect() will be\nundefined.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "process.exit([code])",
          "type": "method",
          "name": "exit",
          "meta": {
            "added": [
              "v0.1.13"
            ]
          },
          "desc": "
Ends the process with the specified code.  If omitted, exit uses the\n'success' code 0.
\n
To exit with a 'failure' code:
\n
process.exit(1);\n
\n
The shell that executed Node.js should see the exit code as 1.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "code",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "process.getegid()",
          "type": "method",
          "name": "getegid",
          "meta": {
            "added": [
              "v2.0.0"
            ]
          },
          "desc": "
Note: this function is only available on POSIX platforms (i.e. not Windows,\nAndroid)
\n
Gets the effective group identity of the process. (See getegid(2).)\nThis is the numerical group id, not the group name.
\n
if (process.getegid) {\n  console.log(`Current gid: ${process.getegid()}`);\n}\n
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "process.geteuid()",
          "type": "method",
          "name": "geteuid",
          "meta": {
            "added": [
              "v2.0.0"
            ]
          },
          "desc": "
Note: this function is only available on POSIX platforms (i.e. not Windows,\nAndroid)
\n
Gets the effective user identity of the process. (See geteuid(2).)\nThis is the numerical userid, not the username.
\n
if (process.geteuid) {\n  console.log(`Current uid: ${process.geteuid()}`);\n}\n
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "process.getgid()",
          "type": "method",
          "name": "getgid",
          "meta": {
            "added": [
              "v0.1.31"
            ]
          },
          "desc": "
Note: this function is only available on POSIX platforms (i.e. not Windows,\nAndroid)
\n
Gets the group identity of the process. (See getgid(2).)\nThis is the numerical group id, not the group name.
\n
if (process.getgid) {\n  console.log(`Current gid: ${process.getgid()}`);\n}\n
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "process.getgroups()",
          "type": "method",
          "name": "getgroups",
          "meta": {
            "added": [
              "v0.9.4"
            ]
          },
          "desc": "
Note: this function is only available on POSIX platforms (i.e. not Windows,\nAndroid)
\n
Returns an array with the supplementary group IDs. POSIX leaves it unspecified\nif the effective group ID is included but Node.js ensures it always is.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "process.getuid()",
          "type": "method",
          "name": "getuid",
          "meta": {
            "added": [
              "v0.1.28"
            ]
          },
          "desc": "
Note: this function is only available on POSIX platforms (i.e. not Windows,\nAndroid)
\n
Gets the user identity of the process. (See getuid(2).)\nThis is the numerical userid, not the username.
\n
if (process.getuid) {\n  console.log(`Current uid: ${process.getuid()}`);\n}\n
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "process.hrtime()",
          "type": "method",
          "name": "hrtime",
          "meta": {
            "added": [
              "v0.7.6"
            ]
          },
          "desc": "
Returns the current high-resolution real time in a [seconds, nanoseconds]\ntuple Array. It is relative to an arbitrary time in the past. It is not\nrelated to the time of day and therefore not subject to clock drift. The\nprimary use is for measuring performance between intervals.
\n
You may pass in the result of a previous call to process.hrtime() to get\na diff reading, useful for benchmarks and measuring intervals:
\n
var time = process.hrtime();\n// [ 1800216, 25 ]\n\nsetTimeout(() => {\n  var diff = process.hrtime(time);\n  // [ 1, 552 ]\n\n  console.log('benchmark took %d nanoseconds', diff[0] * 1e9 + diff[1]);\n  // benchmark took 1000000527 nanoseconds\n}, 1000);\n
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "process.initgroups(user, extra_group)",
          "type": "method",
          "name": "initgroups",
          "meta": {
            "added": [
              "v0.9.4"
            ]
          },
          "desc": "
Note: this function is only available on POSIX platforms (i.e. not Windows,\nAndroid)
\n
Reads /etc/group and initializes the group access list, using all groups of\nwhich the user is a member. This is a privileged operation, meaning you need\nto be root or have the CAP_SETGID capability.
\n
user is a user name or user ID. extra_group is a group name or group ID.
\n
Some care needs to be taken when dropping privileges. Example:
\n
console.log(process.getgroups());         // [ 0 ]\nprocess.initgroups('bnoordhuis', 1000);   // switch user\nconsole.log(process.getgroups());         // [ 27, 30, 46, 1000, 0 ]\nprocess.setgid(1000);                     // drop root gid\nconsole.log(process.getgroups());         // [ 27, 30, 46, 1000 ]\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "user"
                },
                {
                  "name": "extra_group"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "process.kill(pid[, signal])",
          "type": "method",
          "name": "kill",
          "meta": {
            "added": [
              "v0.0.6"
            ]
          },
          "desc": "
Send a signal to a process. pid is the process id and signal is the\nstring describing the signal to send.  Signal names are strings like\nSIGINT or SIGHUP.  If omitted, the signal will be SIGTERM.\nSee Signal Events and kill(2) for more information.
\n
Will throw an error if target does not exist, and as a special case, a signal\nof 0 can be used to test for the existence of a process. Windows platforms\nwill throw an error if the pid is used to kill a process group.
\n
Note that even though the name of this function is process.kill, it is really\njust a signal sender, like the kill system call.  The signal sent may do\nsomething other than kill the target process.
\n
Example of sending a signal to yourself:
\n
process.on('SIGHUP', () => {\n  console.log('Got SIGHUP signal.');\n});\n\nsetTimeout(() => {\n  console.log('Exiting.');\n  process.exit(0);\n}, 100);\n\nprocess.kill(process.pid, 'SIGHUP');\n
\n
Note: When SIGUSR1 is received by Node.js it starts the debugger, see\nSignal Events.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "pid"
                },
                {
                  "name": "signal",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "process.memoryUsage()",
          "type": "method",
          "name": "memoryUsage",
          "meta": {
            "added": [
              "v0.1.16"
            ]
          },
          "signatures": [
            {
              "return": {
                "textRaw": "Returns: {Object} ",
                "options": [
                  {
                    "textRaw": "`rss` {Integer} ",
                    "name": "rss",
                    "type": "Integer"
                  },
                  {
                    "textRaw": "`heapTotal` {Integer} ",
                    "name": "heapTotal",
                    "type": "Integer"
                  },
                  {
                    "textRaw": "`heapUsed` {Integer} ",
                    "name": "heapUsed",
                    "type": "Integer"
                  },
                  {
                    "textRaw": "`external` {Integer} ",
                    "name": "external",
                    "type": "Integer"
                  }
                ],
                "name": "return",
                "type": "Object"
              },
              "params": []
            },
            {
              "params": []
            }
          ],
          "desc": "
The process.memoryUsage() method returns an object describing the memory usage\nof the Node.js process measured in bytes.
\n
For example, the code:
\n
console.log(process.memoryUsage());\n
\n
This will generate:
\n
{ rss: 4935680,\n  heapTotal: 1826816,\n  heapUsed: 650472,\n  external: 49879\n}\n
\n
heapTotal and heapUsed refer to V8's memory usage.\nexternal refers to the memory usage of C++ objects bound to JavaScript\nobjects managed by V8.
\n"
        },
        {
          "textRaw": "process.nextTick(callback[, arg][, ...])",
          "type": "method",
          "name": "nextTick",
          "meta": {
            "added": [
              "v0.1.26"
            ]
          },
          "signatures": [
            {
              "params": [
                {
                  "textRaw": "`callback` {Function} ",
                  "name": "callback",
                  "type": "Function"
                },
                {
                  "name": "arg",
                  "optional": true
                },
                {
                  "name": "...",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "callback"
                },
                {
                  "name": "arg",
                  "optional": true
                },
                {
                  "name": "...",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "
Once the current event loop turn runs to completion, call the callback\nfunction.
\n
This is not a simple alias to setTimeout(fn, 0), it's much more\nefficient.  It runs before any additional I/O events (including\ntimers) fire in subsequent ticks of the event loop.
\n
console.log('start');\nprocess.nextTick(() => {\n  console.log('nextTick callback');\n});\nconsole.log('scheduled');\n// Output:\n// start\n// scheduled\n// nextTick callback\n
\n
This is important in developing APIs where you want to give the user the\nchance to assign event handlers after an object has been constructed,\nbut before any I/O has occurred.
\n
function MyThing(options) {\n  this.setupOptions(options);\n\n  process.nextTick(() => {\n    this.startDoingStuff();\n  });\n}\n\nvar thing = new MyThing();\nthing.getReadyForStuff();\n\n// thing.startDoingStuff() gets called now, not before.\n
\n
It is very important for APIs to be either 100% synchronous or 100%\nasynchronous.  Consider this example:
\n
// WARNING!  DO NOT USE!  BAD UNSAFE HAZARD!\nfunction maybeSync(arg, cb) {\n  if (arg) {\n    cb();\n    return;\n  }\n\n  fs.stat('file', cb);\n}\n
\n
This API is hazardous.  If you do this:
\n
maybeSync(true, () => {\n  foo();\n});\nbar();\n
\n
then it's not clear whether foo() or bar() will be called first.
\n
This approach is much better:
\n
function definitelyAsync(arg, cb) {\n  if (arg) {\n    process.nextTick(cb);\n    return;\n  }\n\n  fs.stat('file', cb);\n}\n
\n
Note: the nextTick queue is completely drained on each pass of the\nevent loop before additional I/O is processed.  As a result,\nrecursively setting nextTick callbacks will block any I/O from\nhappening, just like a while(true); loop.
\n"
        },
        {
          "textRaw": "process.send(message[, sendHandle][, callback])",
          "type": "method",
          "name": "send",
          "meta": {
            "added": [
              "v0.5.9"
            ]
          },
          "signatures": [
            {
              "return": {
                "textRaw": "Returns: {Boolean} ",
                "name": "return",
                "type": "Boolean"
              },
              "params": [
                {
                  "textRaw": "`message` {Object} ",
                  "name": "message",
                  "type": "Object"
                },
                {
                  "textRaw": "`sendHandle` {Handle object} ",
                  "name": "sendHandle",
                  "type": "Handle object",
                  "optional": true
                },
                {
                  "textRaw": "`callback` {Function} ",
                  "name": "callback",
                  "type": "Function",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "message"
                },
                {
                  "name": "sendHandle",
                  "optional": true
                },
                {
                  "name": "callback",
                  "optional": true
                }
              ]
            }
          ],
          "desc": "
When Node.js is spawned with an IPC channel attached, it can send messages to its\nparent process using process.send(). Each will be received as a\n'message' event on the parent's ChildProcess object.
\n
Note: this function uses JSON.stringify() internally to serialize the message.
\n
If Node.js was not spawned with an IPC channel, process.send() will be undefined.
\n"
        },
        {
          "textRaw": "process.setegid(id)",
          "type": "method",
          "name": "setegid",
          "meta": {
            "added": [
              "v2.0.0"
            ]
          },
          "desc": "
Note: this function is only available on POSIX platforms (i.e. not Windows,\nAndroid)
\n
Sets the effective group identity of the process. (See setegid(2).)\nThis accepts either a numerical ID or a groupname string. If a groupname\nis specified, this method blocks while resolving it to a numerical ID.
\n
if (process.getegid && process.setegid) {\n  console.log(`Current gid: ${process.getegid()}`);\n  try {\n    process.setegid(501);\n    console.log(`New gid: ${process.getegid()}`);\n  }\n  catch (err) {\n    console.log(`Failed to set gid: ${err}`);\n  }\n}\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "id"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "process.seteuid(id)",
          "type": "method",
          "name": "seteuid",
          "meta": {
            "added": [
              "v2.0.0"
            ]
          },
          "desc": "
Note: this function is only available on POSIX platforms (i.e. not Windows,\nAndroid)
\n
Sets the effective user identity of the process. (See seteuid(2).)\nThis accepts either a numerical ID or a username string.  If a username\nis specified, this method blocks while resolving it to a numerical ID.
\n
if (process.geteuid && process.seteuid) {\n  console.log(`Current uid: ${process.geteuid()}`);\n  try {\n    process.seteuid(501);\n    console.log(`New uid: ${process.geteuid()}`);\n  }\n  catch (err) {\n    console.log(`Failed to set uid: ${err}`);\n  }\n}\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "id"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "process.setgid(id)",
          "type": "method",
          "name": "setgid",
          "meta": {
            "added": [
              "v0.1.31"
            ]
          },
          "desc": "
Note: this function is only available on POSIX platforms (i.e. not Windows,\nAndroid)
\n
Sets the group identity of the process. (See setgid(2).)  This accepts either\na numerical ID or a groupname string. If a groupname is specified, this method\nblocks while resolving it to a numerical ID.
\n
if (process.getgid && process.setgid) {\n  console.log(`Current gid: ${process.getgid()}`);\n  try {\n    process.setgid(501);\n    console.log(`New gid: ${process.getgid()}`);\n  }\n  catch (err) {\n    console.log(`Failed to set gid: ${err}`);\n  }\n}\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "id"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "process.setgroups(groups)",
          "type": "method",
          "name": "setgroups",
          "meta": {
            "added": [
              "v0.9.4"
            ]
          },
          "desc": "
Note: this function is only available on POSIX platforms (i.e. not Windows,\nAndroid)
\n
Sets the supplementary group IDs. This is a privileged operation, meaning you\nneed to be root or have the CAP_SETGID capability.
\n
The list can contain group IDs, group names or both.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "groups"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "process.setuid(id)",
          "type": "method",
          "name": "setuid",
          "meta": {
            "added": [
              "v0.1.28"
            ]
          },
          "desc": "
Note: this function is only available on POSIX platforms (i.e. not Windows,\nAndroid)
\n
Sets the user identity of the process. (See setuid(2).)  This accepts either\na numerical ID or a username string.  If a username is specified, this method\nblocks while resolving it to a numerical ID.
\n
if (process.getuid && process.setuid) {\n  console.log(`Current uid: ${process.getuid()}`);\n  try {\n    process.setuid(501);\n    console.log(`New uid: ${process.getuid()}`);\n  }\n  catch (err) {\n    console.log(`Failed to set uid: ${err}`);\n  }\n}\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "id"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "process.umask([mask])",
          "type": "method",
          "name": "umask",
          "meta": {
            "added": [
              "v0.1.19"
            ]
          },
          "desc": "
Sets or reads the process's file mode creation mask. Child processes inherit\nthe mask from the parent process. Returns the old mask if mask argument is\ngiven, otherwise returns the current mask.
\n
const newmask = 0o022;\nconst oldmask = process.umask(newmask);\nconsole.log(\n  `Changed umask from ${oldmask.toString(8)} to ${newmask.toString(8)}`\n);\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "mask",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "process.uptime()",
          "type": "method",
          "name": "uptime",
          "meta": {
            "added": [
              "v0.5.0"
            ]
          },
          "desc": "
Number of seconds Node.js has been running.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        }
      ],
      "properties": [
        {
          "textRaw": "process.arch",
          "name": "arch",
          "meta": {
            "added": [
              "v0.5.0"
            ]
          },
          "desc": "
What processor architecture you're running on: 'arm', 'ia32', or 'x64'.
\n
console.log('This processor architecture is ' + process.arch);\n
\n"
        },
        {
          "textRaw": "process.argv",
          "name": "argv",
          "meta": {
            "added": [
              "v0.1.27"
            ]
          },
          "desc": "
An array containing the command line arguments.  The first element will be\n'node', the second element will be the name of the JavaScript file.  The\nnext elements will be any additional command line arguments.
\n
// print process.argv\nprocess.argv.forEach((val, index, array) => {\n  console.log(`${index}: ${val}`);\n});\n
\n
This will generate:
\n
$ node process-2.js one two=three four\n0: node\n1: /Users/mjr/work/node/process-2.js\n2: one\n3: two=three\n4: four\n
"
        },
        {
          "textRaw": "process.config",
          "name": "config",
          "meta": {
            "added": [
              "v0.7.7"
            ]
          },
          "desc": "
An Object containing the JavaScript representation of the configure options\nthat were used to compile the current Node.js executable. This is the same as\nthe config.gypi file that was produced when running the ./configure script.
\n
An example of the possible output looks like:
\n
{\n  target_defaults:\n   { cflags: [],\n     default_configuration: 'Release',\n     defines: [],\n     include_dirs: [],\n     libraries: [] },\n  variables:\n   {\n     host_arch: 'x64',\n     node_install_npm: 'true',\n     node_prefix: '',\n     node_shared_cares: 'false',\n     node_shared_http_parser: 'false',\n     node_shared_libuv: 'false',\n     node_shared_zlib: 'false',\n     node_use_dtrace: 'false',\n     node_use_openssl: 'true',\n     node_shared_openssl: 'false',\n     strict_aliasing: 'true',\n     target_arch: 'x64',\n     v8_use_snapshot: 'true'\n   }\n}\n
Note: the process.config property is not read-only and there are existing\nmodules in the ecosystem that are known to extend, modify, or entirely replace\nthe value of process.config.
\n"
        },
        {
          "textRaw": "`connected` {Boolean} Set to false after `process.disconnect()` is called ",
          "type": "Boolean",
          "name": "connected",
          "meta": {
            "added": [
              "v0.7.2"
            ]
          },
          "desc": "
If process.connected is false, it is no longer possible to send messages.
\n",
          "shortDesc": "Set to false after `process.disconnect()` is called"
        },
        {
          "textRaw": "process.env",
          "name": "env",
          "meta": {
            "added": [
              "v0.1.27"
            ]
          },
          "desc": "
An object containing the user environment. See environ(7).
\n
An example of this object looks like:
\n
{ TERM: 'xterm-256color',\n  SHELL: '/usr/local/bin/bash',\n  USER: 'maciej',\n  PATH: '~/.bin/:/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin',\n  PWD: '/Users/maciej',\n  EDITOR: 'vim',\n  SHLVL: '1',\n  HOME: '/Users/maciej',\n  LOGNAME: 'maciej',\n  _: '/usr/local/bin/node' }\n
\n
You can write to this object, but changes won't be reflected outside of your\nprocess. That means that the following won't work:
\n
$ node -e 'process.env.foo = "bar"' && echo $foo\n
But this will:
\n
process.env.foo = 'bar';\nconsole.log(process.env.foo);\n
\n
Assigning a property on process.env will implicitly convert the value\nto a string.
\n
Example:
\n
process.env.test = null;\nconsole.log(process.env.test);\n// => 'null'\nprocess.env.test = undefined;\nconsole.log(process.env.test);\n// => 'undefined'\n
\n
Use delete to delete a property from process.env.
\n
Example:
\n
process.env.TEST = 1;\ndelete process.env.TEST;\nconsole.log(process.env.TEST);\n// => undefined\n
\n"
        },
        {
          "textRaw": "process.execArgv",
          "name": "execArgv",
          "meta": {
            "added": [
              "v0.7.7"
            ]
          },
          "desc": "
This is the set of Node.js-specific command line options from the\nexecutable that started the process.  These options do not show up in\nprocess.argv, and do not include the Node.js executable, the name of\nthe script, or any options following the script name. These options\nare useful in order to spawn child processes with the same execution\nenvironment as the parent.
\n
Example:
\n
$ node --harmony script.js --version\n
results in process.execArgv:
\n
['--harmony']\n
\n
and process.argv:
\n
['/usr/local/bin/node', 'script.js', '--version']\n
\n"
        },
        {
          "textRaw": "process.execPath",
          "name": "execPath",
          "meta": {
            "added": [
              "v0.1.100"
            ]
          },
          "desc": "
This is the absolute pathname of the executable that started the process.
\n
Example:
\n
/usr/local/bin/node\n
"
        },
        {
          "textRaw": "process.exitCode",
          "name": "exitCode",
          "meta": {
            "added": [
              "v0.11.8"
            ]
          },
          "desc": "
A number which will be the process exit code, when the process either\nexits gracefully, or is exited via process.exit() without specifying\na code.
\n
Specifying a code to process.exit(code) will override any previous\nsetting of process.exitCode.
\n"
        },
        {
          "textRaw": "process.mainModule",
          "name": "mainModule",
          "meta": {
            "added": [
              "v0.1.17"
            ]
          },
          "desc": "
Alternate way to retrieve require.main. The difference is that if the main\nmodule changes at runtime, require.main might still refer to the original main\nmodule in modules that were required before the change occurred. Generally it's\nsafe to assume that the two refer to the same module.
\n
As with require.main, it will be undefined if there was no entry script.
\n"
        },
        {
          "textRaw": "process.pid",
          "name": "pid",
          "meta": {
            "added": [
              "v0.1.15"
            ]
          },
          "desc": "
The PID of the process.
\n
console.log(`This process is pid ${process.pid}`);\n
\n"
        },
        {
          "textRaw": "process.platform",
          "name": "platform",
          "meta": {
            "added": [
              "v0.1.16"
            ]
          },
          "desc": "
What platform you're running on:\n'darwin', 'freebsd', 'linux', 'sunos' or 'win32'
\n
console.log(`This platform is ${process.platform}`);\n
\n"
        },
        {
          "textRaw": "process.release",
          "name": "release",
          "meta": {
            "added": [
              "v3.0.0"
            ]
          },
          "desc": "
An Object containing metadata related to the current release, including URLs\nfor the source tarball and headers-only tarball.
\n
process.release contains the following properties:
\n
    \n
  • name: a string with a value that will always be 'node' for Node.js. For\nlegacy io.js releases, this will be 'io.js'.
    • \n
  • sourceUrl: a complete URL pointing to a .tar.gz file containing the\nsource of the current release.
    • \n
  • headersUrl: a complete URL pointing to a .tar.gz file containing only\nthe header files for the current release. This file is significantly smaller\nthan the full source file and can be used for compiling add-ons against\nNode.js.
    • \n
  • libUrl: a complete URL pointing to an node.lib file matching the\narchitecture and version of the current release. This file is used for\ncompiling add-ons against Node.js. This property is only present on Windows\nbuilds of Node.js and will be missing on all other platforms.
    • \n
\n
e.g.
\n
{ name: 'node',\n  sourceUrl: 'https://nodejs.org/download/release/v4.0.0/node-v4.0.0.tar.gz',\n  headersUrl: 'https://nodejs.org/download/release/v4.0.0/node-v4.0.0-headers.tar.gz',\n  libUrl: 'https://nodejs.org/download/release/v4.0.0/win-x64/node.lib' }\n
\n
In custom builds from non-release versions of the source tree, only the\nname property may be present. The additional properties should not be\nrelied upon to exist.
\n"
        },
        {
          "textRaw": "process.stderr",
          "name": "stderr",
          "desc": "
A writable stream to stderr (on fd 2).
\n
process.stderr and process.stdout are unlike other streams in Node.js in\nthat they cannot be closed (end() will throw), they never emit the finish\nevent and that writes can block when output is redirected to a file (although\ndisks are fast and operating systems normally employ write-back caching so it\nshould be a very rare occurrence indeed.)
\n
Additionally, process.stderr and process.stdout are blocking when outputting\nto TTYs (terminals) on OS X as a workaround for the OS's very small, 1kb\nbuffer size. This is to prevent interleaving between stdout and stderr.
\n"
        },
        {
          "textRaw": "process.stdin",
          "name": "stdin",
          "desc": "
A Readable Stream for stdin (on fd 0).
\n
Example of opening standard input and listening for both events:
\n
process.stdin.setEncoding('utf8');\n\nprocess.stdin.on('readable', () => {\n  var chunk = process.stdin.read();\n  if (chunk !== null) {\n    process.stdout.write(`data: ${chunk}`);\n  }\n});\n\nprocess.stdin.on('end', () => {\n  process.stdout.write('end');\n});\n
\n
As a Stream, process.stdin can also be used in "old" mode that is compatible\nwith scripts written for node.js prior to v0.10.\nFor more information see Stream compatibility.
\n
In "old" Streams mode the stdin stream is paused by default, so one\nmust call process.stdin.resume() to read from it. Note also that calling\nprocess.stdin.resume() itself would switch stream to "old" mode.
\n
If you are starting a new project you should prefer a more recent "new" Streams\nmode over "old" one.
\n"
        },
        {
          "textRaw": "process.stdout",
          "name": "stdout",
          "desc": "
A Writable Stream to stdout (on fd 1).
\n
For example, a console.log equivalent could look like this:
\n
console.log = (msg) => {\n  process.stdout.write(`${msg}\\n`);\n};\n
\n
process.stderr and process.stdout are unlike other streams in Node.js in\nthat they cannot be closed (end() will throw), they never emit the 'finish'\nevent and that writes can block when output is redirected to a file (although\ndisks are fast and operating systems normally employ write-back caching so it\nshould be a very rare occurrence indeed.)
\n
Additionally, process.stderr and process.stdout are blocking when outputting\nto TTYs (terminals) on OS X as a workaround for the OS's very small, 1kb\nbuffer size. This is to prevent interleaving between stdout and stderr.
\n
To check if Node.js is being run in a TTY context, read the isTTY property\non process.stderr, process.stdout, or process.stdin:
\n
$ node -p "Boolean(process.stdin.isTTY)"\ntrue\n$ echo "foo" | node -p "Boolean(process.stdin.isTTY)"\nfalse\n\n$ node -p "Boolean(process.stdout.isTTY)"\ntrue\n$ node -p "Boolean(process.stdout.isTTY)" | cat\nfalse\n
See the tty docs for more information.
\n"
        },
        {
          "textRaw": "process.title",
          "name": "title",
          "meta": {
            "added": [
              "v0.1.104"
            ]
          },
          "desc": "
Getter/setter to set what is displayed in ps.
\n
When used as a setter, the maximum length is platform-specific and probably\nshort.
\n
On Linux and OS X, it's limited to the size of the binary name plus the\nlength of the command line arguments because it overwrites the argv memory.
\n
v0.8 allowed for longer process title strings by also overwriting the environ\nmemory but that was potentially insecure/confusing in some (rather obscure)\ncases.
\n"
        },
        {
          "textRaw": "process.version",
          "name": "version",
          "meta": {
            "added": [
              "v0.1.3"
            ]
          },
          "desc": "
A compiled-in property that exposes NODE_VERSION.
\n
console.log(`Version: ${process.version}`);\n
\n"
        },
        {
          "textRaw": "process.versions",
          "name": "versions",
          "meta": {
            "added": [
              "v0.2.0"
            ]
          },
          "desc": "
A property exposing version strings of Node.js and its dependencies.
\n
console.log(process.versions);\n
\n
Will print something like:
\n
{ http_parser: '2.3.0',\n  node: '1.1.1',\n  v8: '4.1.0.14',\n  uv: '1.3.0',\n  zlib: '1.2.8',\n  ares: '1.10.0-DEV',\n  modules: '43',\n  icu: '55.1',\n  openssl: '1.0.1k' }\n
\n"
        }
      ]
    }
  ]
}
node-v4.8.2/doc/api/process.md000644 000766 000024 00000106637 13070706735 016313 0ustar00iojsstaff000000 000000 # Process



The `process` object is a global object and can be accessed from anywhere.
It is an instance of [`EventEmitter`][].

## Event: 'beforeExit'


This event is emitted when Node.js empties its event loop and has nothing else
to schedule. Normally, Node.js exits when there is no work scheduled, but a
listener for `'beforeExit'` can make asynchronous calls, and cause Node.js to
continue.

`'beforeExit'` is not emitted for conditions causing explicit termination, such
as [`process.exit()`][] or uncaught exceptions, and should not be used as an
alternative to the `'exit'` event unless the intention is to schedule more work.

## Event: 'exit'


Emitted when the process is about to exit. There is no way to prevent the
exiting of the event loop at this point, and once all `'exit'` listeners have
finished running the process will exit. Therefore you **must** only perform
**synchronous** operations in this handler. This is a good hook to perform
checks on the module's state (like for unit tests). The callback takes one
argument, the code the process is exiting with.

This event is only emitted when Node.js exits explicitly by process.exit() or
implicitly by the event loop draining.

Example of listening for `'exit'`:

```js
process.on('exit', (code) => {
  // do *NOT* do this
  setTimeout(() => {
    console.log('This will not run');
  }, 0);
  console.log('About to exit with code:', code);
});
```

## Event: 'message'


* `message` {Object} a parsed JSON object or primitive value
* `sendHandle` {Handle object} a [`net.Socket`][] or [`net.Server`][] object, or
  undefined.

Messages sent by [`ChildProcess.send()`][] are obtained using the `'message'`
event on the child's process object.

## Event: 'rejectionHandled'


Emitted whenever a Promise was rejected and an error handler was attached to it
(for example with `.catch()`) later than after an event loop turn. This event
is emitted with the following arguments:

 - `p` the promise that was previously emitted in an `'unhandledRejection'`
 event, but which has now gained a rejection handler.

There is no notion of a top level for a promise chain at which rejections can
always be handled. Being inherently asynchronous in nature, a promise rejection
can be handled at a future point in time — possibly much later than the
event loop turn it takes for the `'unhandledRejection'` event to be emitted.

Another way of stating this is that, unlike in synchronous code where there is
an ever-growing list of unhandled exceptions, with promises there is a
growing-and-shrinking list of unhandled rejections. In synchronous code, the
`'uncaughtException'` event tells you when the list of unhandled exceptions
grows. And in asynchronous code, the `'unhandledRejection'` event tells you
when the list of unhandled rejections grows, while the `'rejectionHandled'`
event tells you when the list of unhandled rejections shrinks.

For example using the rejection detection hooks in order to keep a map of all
the rejected promise reasons at a given time:

```js
const unhandledRejections = new Map();
process.on('unhandledRejection', (reason, p) => {
  unhandledRejections.set(p, reason);
});
process.on('rejectionHandled', (p) => {
  unhandledRejections.delete(p);
});
```

This map will grow and shrink over time, reflecting rejections that start
unhandled and then become handled. You could record the errors in some error
log, either periodically (probably best for long-running programs, allowing
you to clear the map, which in the case of a very buggy program could grow
indefinitely) or upon process exit (more convenient for scripts).

## Event: 'uncaughtException'


The `'uncaughtException'` event is emitted when an exception bubbles all the
way back to the event loop. By default, Node.js handles such exceptions by
printing the stack trace to stderr and exiting. Adding a handler for the
`'uncaughtException'` event overrides this default behavior.

For example:

```js
process.on('uncaughtException', (err) => {
  console.log(`Caught exception: ${err}`);
});

setTimeout(() => {
  console.log('This will still run.');
}, 500);

// Intentionally cause an exception, but don't catch it.
nonexistentFunc();
console.log('This will not run.');
```

### Warning: Using `'uncaughtException'` correctly

Note that `'uncaughtException'` is a crude mechanism for exception handling
intended to be used only as a last resort. The event *should not* be used as
an equivalent to `On Error Resume Next`. Unhandled exceptions inherently mean
that an application is in an undefined state. Attempting to resume application
code without properly recovering from the exception can cause additional
unforeseen and unpredictable issues.

Exceptions thrown from within the event handler will not be caught. Instead the
process will exit with a non-zero exit code and the stack trace will be printed.
This is to avoid infinite recursion.

Attempting to resume normally after an uncaught exception can be similar to
pulling out of the power cord when upgrading a computer -- nine out of ten
times nothing happens - but the 10th time, the system becomes corrupted.

The correct use of `'uncaughtException'` is to perform synchronous cleanup
of allocated resources (e.g. file descriptors, handles, etc) before shutting
down the process. It is not safe to resume normal operation after
`'uncaughtException'`.

## Event: 'unhandledRejection'


Emitted whenever a `Promise` is rejected and no error handler is attached to
the promise within a turn of the event loop. When programming with promises
exceptions are encapsulated as rejected promises. Such promises can be caught
and handled using [`promise.catch(...)`][] and rejections are propagated through
a promise chain. This event is useful for detecting and keeping track of
promises that were rejected whose rejections were not handled yet. This event
is emitted with the following arguments:

 - `reason` the object with which the promise was rejected (usually an
   [`Error`][] instance).
 - `p` the promise that was rejected.

Here is an example that logs every unhandled rejection to the console

```js
process.on('unhandledRejection', (reason, p) => {
  console.log('Unhandled Rejection at: Promise', p, 'reason:', reason);
  // application specific logging, throwing an error, or other logic here
});
```

For example, here is a rejection that will trigger the `'unhandledRejection'`
event:

```js
somePromise.then((res) => {
  return reportToUser(JSON.pasre(res)); // note the typo (`pasre`)
}); // no `.catch` or `.then`
```

Here is an example of a coding pattern that will also trigger
`'unhandledRejection'`:

```js
function SomeResource() {
  // Initially set the loaded status to a rejected promise
  this.loaded = Promise.reject(new Error('Resource not yet loaded!'));
}

var resource = new SomeResource();
// no .catch or .then on resource.loaded for at least a turn
```

In cases like this, you may not want to track the rejection as a developer
error like you would for other `'unhandledRejection'` events. To address
this, you can either attach a dummy `.catch(() => { })` handler to
`resource.loaded`, preventing the `'unhandledRejection'` event from being
emitted, or you can use the [`'rejectionHandled'`][] event.

## Exit Codes

Node.js will normally exit with a `0` status code when no more async
operations are pending.  The following status codes are used in other
cases:

* `1` **Uncaught Fatal Exception** - There was an uncaught exception,
  and it was not handled by a domain or an `'uncaughtException'` event
  handler.
* `2` - Unused (reserved by Bash for builtin misuse)
* `3` **Internal JavaScript Parse Error** - The JavaScript source code
  internal in Node.js's bootstrapping process caused a parse error.  This
  is extremely rare, and generally can only happen during development
  of Node.js itself.
* `4` **Internal JavaScript Evaluation Failure** - The JavaScript
  source code internal in Node.js's bootstrapping process failed to
  return a function value when evaluated.  This is extremely rare, and
  generally can only happen during development of Node.js itself.
* `5` **Fatal Error** - There was a fatal unrecoverable error in V8.
  Typically a message will be printed to stderr with the prefix `FATAL
  ERROR`.
* `6` **Non-function Internal Exception Handler** - There was an
  uncaught exception, but the internal fatal exception handler
  function was somehow set to a non-function, and could not be called.
* `7` **Internal Exception Handler Run-Time Failure** - There was an
  uncaught exception, and the internal fatal exception handler
  function itself threw an error while attempting to handle it.  This
  can happen, for example, if a `process.on('uncaughtException')` or
  `domain.on('error')` handler throws an error.
* `8` - Unused.  In previous versions of Node.js, exit code 8 sometimes
  indicated an uncaught exception.
* `9` - **Invalid Argument** - Either an unknown option was specified,
  or an option requiring a value was provided without a value.
* `10` **Internal JavaScript Run-Time Failure** - The JavaScript
  source code internal in Node.js's bootstrapping process threw an error
  when the bootstrapping function was called.  This is extremely rare,
  and generally can only happen during development of Node.js itself.
* `12` **Invalid Debug Argument** - The `--debug` and/or `--debug-brk`
  options were set, but an invalid port number was chosen.
* `>128` **Signal Exits** - If Node.js receives a fatal signal such as
  `SIGKILL` or `SIGHUP`, then its exit code will be `128` plus the
  value of the signal code.  This is a standard Unix practice, since
  exit codes are defined to be 7-bit integers, and signal exits set
  the high-order bit, and then contain the value of the signal code.

## Signal Events




Emitted when the processes receives a signal. See sigaction(7) for a list of
standard POSIX signal names such as `SIGINT`, `SIGHUP`, etc.

Example of listening for `SIGINT`:

```js
// Start reading from stdin so we don't exit.
process.stdin.resume();

process.on('SIGINT', () => {
  console.log('Got SIGINT.  Press Control-D to exit.');
});
```

An easy way to send the `SIGINT` signal is with `Control-C` in most terminal
programs.

Note:

- `SIGUSR1` is reserved by Node.js to start the debugger.  It's possible to
  install a listener but that won't stop the debugger from starting.
- `SIGTERM` and `SIGINT` have default handlers on non-Windows platforms that
  resets the terminal mode before exiting with code `128 + signal number`. If
  one of these signals has a listener installed, its default behavior will be
  removed (Node.js will no longer exit).
- `SIGPIPE` is ignored by default. It can have a listener installed.
- `SIGHUP` is generated on Windows when the console window is closed, and on other
  platforms under various similar conditions, see signal(7). It can have a
  listener installed, however Node.js will be unconditionally terminated by
  Windows about 10 seconds later. On non-Windows platforms, the default
  behavior of `SIGHUP` is to terminate Node.js, but once a listener has been
  installed its default behavior will be removed.
- `SIGTERM` is not supported on Windows, it can be listened on.
- `SIGINT` from the terminal is supported on all platforms, and can usually be
  generated with `CTRL+C` (though this may be configurable). It is not generated
  when terminal raw mode is enabled.
- `SIGBREAK` is delivered on Windows when `CTRL+BREAK` is pressed, on
  non-Windows
  platforms it can be listened on, but there is no way to send or generate it.
- `SIGWINCH` is delivered when the console has been resized. On Windows, this
  will only happen on write to the console when the cursor is being moved, or
  when a readable tty is used in raw mode.
- `SIGKILL` cannot have a listener installed, it will unconditionally terminate
  Node.js on all platforms.
- `SIGSTOP` cannot have a listener installed.

Note that Windows does not support sending Signals, but Node.js offers some
emulation with `process.kill()`, and `child_process.kill()`. Sending signal `0`
can be used to test for the existence of a process. Sending `SIGINT`,
`SIGTERM`, and `SIGKILL` cause the unconditional termination of the target
process.

## process.abort()


This causes Node.js to emit an abort. This will cause Node.js to exit and
generate a core file.

## process.arch


What processor architecture you're running on: `'arm'`, `'ia32'`, or `'x64'`.

```js
console.log('This processor architecture is ' + process.arch);
```

## process.argv


An array containing the command line arguments.  The first element will be
'node', the second element will be the name of the JavaScript file.  The
next elements will be any additional command line arguments.

```js
// print process.argv
process.argv.forEach((val, index, array) => {
  console.log(`${index}: ${val}`);
});
```

This will generate:

```
$ node process-2.js one two=three four
0: node
1: /Users/mjr/work/node/process-2.js
2: one
3: two=three
4: four
```

## process.chdir(directory)


Changes the current working directory of the process or throws an exception if that fails.

```js
console.log(`Starting directory: ${process.cwd()}`);
try {
  process.chdir('/tmp');
  console.log(`New directory: ${process.cwd()}`);
}
catch (err) {
  console.log(`chdir: ${err}`);
}
```

## process.config


An Object containing the JavaScript representation of the configure options
that were used to compile the current Node.js executable. This is the same as
the `config.gypi` file that was produced when running the `./configure` script.

An example of the possible output looks like:

```
{
  target_defaults:
   { cflags: [],
     default_configuration: 'Release',
     defines: [],
     include_dirs: [],
     libraries: [] },
  variables:
   {
     host_arch: 'x64',
     node_install_npm: 'true',
     node_prefix: '',
     node_shared_cares: 'false',
     node_shared_http_parser: 'false',
     node_shared_libuv: 'false',
     node_shared_zlib: 'false',
     node_use_dtrace: 'false',
     node_use_openssl: 'true',
     node_shared_openssl: 'false',
     strict_aliasing: 'true',
     target_arch: 'x64',
     v8_use_snapshot: 'true'
   }
}
```

*Note: the `process.config` property is **not** read-only and there are existing
modules in the ecosystem that are known to extend, modify, or entirely replace
the value of `process.config`.*

## process.connected


* {Boolean} Set to false after `process.disconnect()` is called

If `process.connected` is false, it is no longer possible to send messages.

## process.cpuUsage([previousValue])

Returns the user and system CPU time usage of the current process, in an object
with properties `user` and `system`, whose values are microsecond values
(millionth of a second). These values measure time spent in user and
system code respectively, and may end up being greater than actual elapsed time
if multiple CPU cores are performing work for this process.

The result of a previous call to `process.cpuUsage()` can be passed as the
argument to the function, to get a diff reading.

```js
const startUsage = process.cpuUsage();
// { user: 38579, system: 6986 }

// spin the CPU for 500 milliseconds
const now = Date.now();
while (Date.now() - now < 500);

console.log(process.cpuUsage(startUsage));
// { user: 514883, system: 11226 }
```

## process.cwd()


Returns the current working directory of the process.

```js
console.log(`Current directory: ${process.cwd()}`);
```

## process.disconnect()


Close the IPC channel to the parent process, allowing this child to exit
gracefully once there are no other connections keeping it alive.

Identical to the parent process's [`ChildProcess.disconnect()`][].

If Node.js was not spawned with an IPC channel, `process.disconnect()` will be
undefined.

## process.env


An object containing the user environment. See environ(7).

An example of this object looks like:

```js
{ TERM: 'xterm-256color',
  SHELL: '/usr/local/bin/bash',
  USER: 'maciej',
  PATH: '~/.bin/:/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin',
  PWD: '/Users/maciej',
  EDITOR: 'vim',
  SHLVL: '1',
  HOME: '/Users/maciej',
  LOGNAME: 'maciej',
  _: '/usr/local/bin/node' }
```

You can write to this object, but changes won't be reflected outside of your
process. That means that the following won't work:

```
$ node -e 'process.env.foo = "bar"' && echo $foo
```

But this will:

```js
process.env.foo = 'bar';
console.log(process.env.foo);
```

Assigning a property on `process.env` will implicitly convert the value
to a string.

Example:

```js
process.env.test = null;
console.log(process.env.test);
// => 'null'
process.env.test = undefined;
console.log(process.env.test);
// => 'undefined'
```

Use `delete` to delete a property from `process.env`.

Example:

```js
process.env.TEST = 1;
delete process.env.TEST;
console.log(process.env.TEST);
// => undefined
```

## process.execArgv


This is the set of Node.js-specific command line options from the
executable that started the process.  These options do not show up in
`process.argv`, and do not include the Node.js executable, the name of
the script, or any options following the script name. These options
are useful in order to spawn child processes with the same execution
environment as the parent.

Example:

```
$ node --harmony script.js --version
```

results in process.execArgv:

```js
['--harmony']
```

and process.argv:

```js
['/usr/local/bin/node', 'script.js', '--version']
```

## process.execPath


This is the absolute pathname of the executable that started the process.

Example:

```
/usr/local/bin/node
```


## process.exit([code])


Ends the process with the specified `code`.  If omitted, exit uses the
'success' code `0`.

To exit with a 'failure' code:

```js
process.exit(1);
```

The shell that executed Node.js should see the exit code as 1.


## process.exitCode


A number which will be the process exit code, when the process either
exits gracefully, or is exited via [`process.exit()`][] without specifying
a code.

Specifying a code to `process.exit(code)` will override any previous
setting of `process.exitCode`.


## process.getegid()


Note: this function is only available on POSIX platforms (i.e. not Windows,
Android)

Gets the effective group identity of the process. (See getegid(2).)
This is the numerical group id, not the group name.

```js
if (process.getegid) {
  console.log(`Current gid: ${process.getegid()}`);
}
```


## process.geteuid()


Note: this function is only available on POSIX platforms (i.e. not Windows,
Android)

Gets the effective user identity of the process. (See geteuid(2).)
This is the numerical userid, not the username.

```js
if (process.geteuid) {
  console.log(`Current uid: ${process.geteuid()}`);
}
```

## process.getgid()


Note: this function is only available on POSIX platforms (i.e. not Windows,
Android)

Gets the group identity of the process. (See getgid(2).)
This is the numerical group id, not the group name.

```js
if (process.getgid) {
  console.log(`Current gid: ${process.getgid()}`);
}
```

## process.getgroups()


Note: this function is only available on POSIX platforms (i.e. not Windows,
Android)

Returns an array with the supplementary group IDs. POSIX leaves it unspecified
if the effective group ID is included but Node.js ensures it always is.

## process.getuid()


Note: this function is only available on POSIX platforms (i.e. not Windows,
Android)

Gets the user identity of the process. (See getuid(2).)
This is the numerical userid, not the username.

```js
if (process.getuid) {
  console.log(`Current uid: ${process.getuid()}`);
}
```

## process.hrtime()


Returns the current high-resolution real time in a `[seconds, nanoseconds]`
tuple Array. It is relative to an arbitrary time in the past. It is not
related to the time of day and therefore not subject to clock drift. The
primary use is for measuring performance between intervals.

You may pass in the result of a previous call to `process.hrtime()` to get
a diff reading, useful for benchmarks and measuring intervals:

```js
var time = process.hrtime();
// [ 1800216, 25 ]

setTimeout(() => {
  var diff = process.hrtime(time);
  // [ 1, 552 ]

  console.log('benchmark took %d nanoseconds', diff[0] * 1e9 + diff[1]);
  // benchmark took 1000000527 nanoseconds
}, 1000);
```


## process.initgroups(user, extra_group)


Note: this function is only available on POSIX platforms (i.e. not Windows,
Android)

Reads /etc/group and initializes the group access list, using all groups of
which the user is a member. This is a privileged operation, meaning you need
to be root or have the `CAP_SETGID` capability.

`user` is a user name or user ID. `extra_group` is a group name or group ID.

Some care needs to be taken when dropping privileges. Example:

```js
console.log(process.getgroups());         // [ 0 ]
process.initgroups('bnoordhuis', 1000);   // switch user
console.log(process.getgroups());         // [ 27, 30, 46, 1000, 0 ]
process.setgid(1000);                     // drop root gid
console.log(process.getgroups());         // [ 27, 30, 46, 1000 ]
```

## process.kill(pid[, signal])


Send a signal to a process. `pid` is the process id and `signal` is the
string describing the signal to send.  Signal names are strings like
`SIGINT` or `SIGHUP`.  If omitted, the signal will be `SIGTERM`.
See [Signal Events][] and kill(2) for more information.

Will throw an error if target does not exist, and as a special case, a signal
of `0` can be used to test for the existence of a process. Windows platforms
will throw an error if the `pid` is used to kill a process group.

Note that even though the name of this function is `process.kill`, it is really
just a signal sender, like the `kill` system call.  The signal sent may do
something other than kill the target process.

Example of sending a signal to yourself:

```js
process.on('SIGHUP', () => {
  console.log('Got SIGHUP signal.');
});

setTimeout(() => {
  console.log('Exiting.');
  process.exit(0);
}, 100);

process.kill(process.pid, 'SIGHUP');
```

Note: When SIGUSR1 is received by Node.js it starts the debugger, see
[Signal Events][].

## process.mainModule


Alternate way to retrieve [`require.main`][]. The difference is that if the main
module changes at runtime, `require.main` might still refer to the original main
module in modules that were required before the change occurred. Generally it's
safe to assume that the two refer to the same module.

As with `require.main`, it will be `undefined` if there was no entry script.

## process.memoryUsage()


* Returns: {Object}
    * `rss` {Integer}
    * `heapTotal` {Integer}
    * `heapUsed` {Integer}
    * `external` {Integer}

The `process.memoryUsage()` method returns an object describing the memory usage
of the Node.js process measured in bytes.

For example, the code:

```js
console.log(process.memoryUsage());
```

This will generate:

```js
{ rss: 4935680,
  heapTotal: 1826816,
  heapUsed: 650472,
  external: 49879
}
```

`heapTotal` and `heapUsed` refer to V8's memory usage.
`external` refers to the memory usage of C++ objects bound to JavaScript
objects managed by V8.


## process.nextTick(callback[, arg][, ...])


* `callback` {Function}

Once the current event loop turn runs to completion, call the callback
function.

This is *not* a simple alias to [`setTimeout(fn, 0)`][], it's much more
efficient.  It runs before any additional I/O events (including
timers) fire in subsequent ticks of the event loop.

```js
console.log('start');
process.nextTick(() => {
  console.log('nextTick callback');
});
console.log('scheduled');
// Output:
// start
// scheduled
// nextTick callback
```

This is important in developing APIs where you want to give the user the
chance to assign event handlers after an object has been constructed,
but before any I/O has occurred.

```js
function MyThing(options) {
  this.setupOptions(options);

  process.nextTick(() => {
    this.startDoingStuff();
  });
}

var thing = new MyThing();
thing.getReadyForStuff();

// thing.startDoingStuff() gets called now, not before.
```

It is very important for APIs to be either 100% synchronous or 100%
asynchronous.  Consider this example:

```js
// WARNING!  DO NOT USE!  BAD UNSAFE HAZARD!
function maybeSync(arg, cb) {
  if (arg) {
    cb();
    return;
  }

  fs.stat('file', cb);
}
```

This API is hazardous.  If you do this:

```js
maybeSync(true, () => {
  foo();
});
bar();
```

then it's not clear whether `foo()` or `bar()` will be called first.

This approach is much better:

```js
function definitelyAsync(arg, cb) {
  if (arg) {
    process.nextTick(cb);
    return;
  }

  fs.stat('file', cb);
}
```

Note: the nextTick queue is completely drained on each pass of the
event loop **before** additional I/O is processed.  As a result,
recursively setting nextTick callbacks will block any I/O from
happening, just like a `while(true);` loop.

## process.pid


The PID of the process.

```js
console.log(`This process is pid ${process.pid}`);
```

## process.platform


What platform you're running on:
`'darwin'`, `'freebsd'`, `'linux'`, `'sunos'` or `'win32'`

```js
console.log(`This platform is ${process.platform}`);
```

## process.release


An Object containing metadata related to the current release, including URLs
for the source tarball and headers-only tarball.

`process.release` contains the following properties:

* `name`: a string with a value that will always be `'node'` for Node.js. For
  legacy io.js releases, this will be `'io.js'`.
* `sourceUrl`: a complete URL pointing to a _.tar.gz_ file containing the
  source of the current release.
* `headersUrl`: a complete URL pointing to a _.tar.gz_ file containing only
  the header files for the current release. This file is significantly smaller
  than the full source file and can be used for compiling add-ons against
  Node.js.
* `libUrl`: a complete URL pointing to an _node.lib_ file matching the
  architecture and version of the current release. This file is used for
  compiling add-ons against Node.js. _This property is only present on Windows
  builds of Node.js and will be missing on all other platforms._

e.g.

```js
{ name: 'node',
  sourceUrl: 'https://nodejs.org/download/release/v4.0.0/node-v4.0.0.tar.gz',
  headersUrl: 'https://nodejs.org/download/release/v4.0.0/node-v4.0.0-headers.tar.gz',
  libUrl: 'https://nodejs.org/download/release/v4.0.0/win-x64/node.lib' }
```

In custom builds from non-release versions of the source tree, only the
`name` property may be present. The additional properties should not be
relied upon to exist.

## process.send(message[, sendHandle][, callback])


* `message` {Object}
* `sendHandle` {Handle object}
* `callback` {Function}
* Returns: {Boolean}

When Node.js is spawned with an IPC channel attached, it can send messages to its
parent process using `process.send()`. Each will be received as a
[`'message'`][] event on the parent's `ChildProcess` object.

*Note: this function uses [`JSON.stringify()`][] internally to serialize the `message`.*

If Node.js was not spawned with an IPC channel, `process.send()` will be undefined.

## process.setegid(id)


Note: this function is only available on POSIX platforms (i.e. not Windows,
Android)

Sets the effective group identity of the process. (See setegid(2).)
This accepts either a numerical ID or a groupname string. If a groupname
is specified, this method blocks while resolving it to a numerical ID.

```js
if (process.getegid && process.setegid) {
  console.log(`Current gid: ${process.getegid()}`);
  try {
    process.setegid(501);
    console.log(`New gid: ${process.getegid()}`);
  }
  catch (err) {
    console.log(`Failed to set gid: ${err}`);
  }
}
```

## process.seteuid(id)


Note: this function is only available on POSIX platforms (i.e. not Windows,
Android)

Sets the effective user identity of the process. (See seteuid(2).)
This accepts either a numerical ID or a username string.  If a username
is specified, this method blocks while resolving it to a numerical ID.

```js
if (process.geteuid && process.seteuid) {
  console.log(`Current uid: ${process.geteuid()}`);
  try {
    process.seteuid(501);
    console.log(`New uid: ${process.geteuid()}`);
  }
  catch (err) {
    console.log(`Failed to set uid: ${err}`);
  }
}
```

## process.setgid(id)


Note: this function is only available on POSIX platforms (i.e. not Windows,
Android)

Sets the group identity of the process. (See setgid(2).)  This accepts either
a numerical ID or a groupname string. If a groupname is specified, this method
blocks while resolving it to a numerical ID.

```js
if (process.getgid && process.setgid) {
  console.log(`Current gid: ${process.getgid()}`);
  try {
    process.setgid(501);
    console.log(`New gid: ${process.getgid()}`);
  }
  catch (err) {
    console.log(`Failed to set gid: ${err}`);
  }
}
```

## process.setgroups(groups)


Note: this function is only available on POSIX platforms (i.e. not Windows,
Android)

Sets the supplementary group IDs. This is a privileged operation, meaning you
need to be root or have the `CAP_SETGID` capability.

The list can contain group IDs, group names or both.

## process.setuid(id)


Note: this function is only available on POSIX platforms (i.e. not Windows,
Android)

Sets the user identity of the process. (See setuid(2).)  This accepts either
a numerical ID or a username string.  If a username is specified, this method
blocks while resolving it to a numerical ID.

```js
if (process.getuid && process.setuid) {
  console.log(`Current uid: ${process.getuid()}`);
  try {
    process.setuid(501);
    console.log(`New uid: ${process.getuid()}`);
  }
  catch (err) {
    console.log(`Failed to set uid: ${err}`);
  }
}
```

## process.stderr

A writable stream to stderr (on fd `2`).

`process.stderr` and `process.stdout` are unlike other streams in Node.js in
that they cannot be closed (`end()` will throw), they never emit the `finish`
event and that writes can block when output is redirected to a file (although
disks are fast and operating systems normally employ write-back caching so it
should be a very rare occurrence indeed.)

Additionally, `process.stderr` and `process.stdout` are blocking when outputting
to TTYs (terminals) on OS X as a workaround for the OS's very small, 1kb
buffer size. This is to prevent interleaving between `stdout` and `stderr`.

## process.stdin

A `Readable Stream` for stdin (on fd `0`).

Example of opening standard input and listening for both events:

```js
process.stdin.setEncoding('utf8');

process.stdin.on('readable', () => {
  var chunk = process.stdin.read();
  if (chunk !== null) {
    process.stdout.write(`data: ${chunk}`);
  }
});

process.stdin.on('end', () => {
  process.stdout.write('end');
});
```

As a Stream, `process.stdin` can also be used in "old" mode that is compatible
with scripts written for node.js prior to v0.10.
For more information see [Stream compatibility][].

In "old" Streams mode the stdin stream is paused by default, so one
must call `process.stdin.resume()` to read from it. Note also that calling
`process.stdin.resume()` itself would switch stream to "old" mode.

If you are starting a new project you should prefer a more recent "new" Streams
mode over "old" one.

## process.stdout

A `Writable Stream` to `stdout` (on fd `1`).

For example, a `console.log` equivalent could look like this:

```js
console.log = (msg) => {
  process.stdout.write(`${msg}\n`);
};
```

`process.stderr` and `process.stdout` are unlike other streams in Node.js in
that they cannot be closed (`end()` will throw), they never emit the `'finish'`
event and that writes can block when output is redirected to a file (although
disks are fast and operating systems normally employ write-back caching so it
should be a very rare occurrence indeed.)

Additionally, `process.stderr` and `process.stdout` are blocking when outputting
to TTYs (terminals) on OS X as a workaround for the OS's very small, 1kb
buffer size. This is to prevent interleaving between `stdout` and `stderr`.

To check if Node.js is being run in a TTY context, read the `isTTY` property
on `process.stderr`, `process.stdout`, or `process.stdin`:

```
$ node -p "Boolean(process.stdin.isTTY)"
true
$ echo "foo" | node -p "Boolean(process.stdin.isTTY)"
false

$ node -p "Boolean(process.stdout.isTTY)"
true
$ node -p "Boolean(process.stdout.isTTY)" | cat
false
```

See [the tty docs][] for more information.

## process.title


Getter/setter to set what is displayed in `ps`.

When used as a setter, the maximum length is platform-specific and probably
short.

On Linux and OS X, it's limited to the size of the binary name plus the
length of the command line arguments because it overwrites the argv memory.

v0.8 allowed for longer process title strings by also overwriting the environ
memory but that was potentially insecure/confusing in some (rather obscure)
cases.

## process.umask([mask])


Sets or reads the process's file mode creation mask. Child processes inherit
the mask from the parent process. Returns the old mask if `mask` argument is
given, otherwise returns the current mask.

```js
const newmask = 0o022;
const oldmask = process.umask(newmask);
console.log(
  `Changed umask from ${oldmask.toString(8)} to ${newmask.toString(8)}`
);
```


## process.uptime()


Number of seconds Node.js has been running.

## process.version


A compiled-in property that exposes `NODE_VERSION`.

```js
console.log(`Version: ${process.version}`);
```

## process.versions


A property exposing version strings of Node.js and its dependencies.

```js
console.log(process.versions);
```

Will print something like:

```js
{ http_parser: '2.3.0',
  node: '1.1.1',
  v8: '4.1.0.14',
  uv: '1.3.0',
  zlib: '1.2.8',
  ares: '1.10.0-DEV',
  modules: '43',
  icu: '55.1',
  openssl: '1.0.1k' }
```

[`'message'`]: child_process.html#child_process_event_message
[`ChildProcess.disconnect()`]: child_process.html#child_process_child_disconnect
[`ChildProcess.send()`]: child_process.html#child_process_child_send_message_sendhandle_callback
[`Error`]: errors.html#errors_class_error
[`EventEmitter`]: events.html#events_class_events_eventemitter
[`net.Server`]: net.html#net_class_net_server
[`net.Socket`]: net.html#net_class_net_socket
[`process.exit()`]: #process_process_exit_code
[`promise.catch(...)`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/catch
[`'rejectionHandled'`]: #process_event_rejectionhandled
[`require.main`]: modules.html#modules_accessing_the_main_module
[`setTimeout(fn, 0)`]: timers.html#timers_settimeout_callback_delay_arg
[Signal Events]: #process_signal_events
[Stream compatibility]: stream.html#stream_compatibility_with_older_node_js_versions
[the tty docs]: tty.html#tty_tty
[`JSON.stringify()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify
node-v4.8.2/doc/api/punycode.html000644 000766 000024 00000022701 13070706740 017010 0ustar00iojsstaff000000 000000 


  
  Punycode | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

      

        
Punycode#


Stability: 2 - Stable
Punycode.js is bundled with Node.js v0.5.1+. Use require('punycode') to
access it. (To use it with other Node.js versions, use npm to install the
punycode module first.)


punycode.decode(string)#



Added in: v0.5.1

Converts a Punycode string of ASCII-only symbols to a string of Unicode symbols.


// decode domain name parts
punycode.decode('maana-pta'); // 'mañana'
punycode.decode('--dqo34k'); // '☃-⌘'



punycode.encode(string)#



Added in: v0.5.1

Converts a string of Unicode symbols to a Punycode string of ASCII-only symbols.


// encode domain name parts
punycode.encode('mañana'); // 'maana-pta'
punycode.encode('☃-⌘'); // '--dqo34k'



punycode.toASCII(domain)#



Added in: v0.6.1

Converts a Unicode string representing a domain name to Punycode. Only the
non-ASCII parts of the domain name will be converted, i.e. it doesn't matter if
you call it with a domain that's already in ASCII.


// encode domain names
punycode.toASCII('mañana.com'); // 'xn--maana-pta.com'
punycode.toASCII('☃-⌘.com'); // 'xn----dqo34k.com'



punycode.toUnicode(domain)#



Added in: v0.6.1

Converts a Punycode string representing a domain name to Unicode. Only the
Punycoded parts of the domain name will be converted, i.e. it doesn't matter if
you call it on a string that has already been converted to Unicode.


// decode domain names
punycode.toUnicode('xn--maana-pta.com'); // 'mañana.com'
punycode.toUnicode('xn----dqo34k.com'); // '☃-⌘.com'



punycode.ucs2#



Added in: v0.7.0

punycode.ucs2.decode(string)#



Added in: v0.7.0

Creates an array containing the numeric code point values of each Unicode
symbol in the string. While JavaScript uses UCS-2 internally, this function
will convert a pair of surrogate halves (each of which UCS-2 exposes as
separate characters) into a single code point, matching UTF-16.


punycode.ucs2.decode('abc'); // [0x61, 0x62, 0x63]
// surrogate pair for U+1D306 tetragram for centre:
punycode.ucs2.decode('\uD834\uDF06'); // [0x1D306]



punycode.ucs2.encode(codePoints)#



Added in: v0.7.0

Creates a string based on an array of numeric code point values.


punycode.ucs2.encode([0x61, 0x62, 0x63]); // 'abc'
punycode.ucs2.encode([0x1D306]); // '\uD834\uDF06'



punycode.version#



Added in: v0.6.1

A string representing the current Punycode.js version number.


      

    

  

  
  
  
  



node-v4.8.2/doc/api/punycode.json000644 000766 000024 00000013206 13070706740 017015 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/punycode.md",
  "modules": [
    {
      "textRaw": "Punycode",
      "name": "punycode",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
Punycode.js is bundled with Node.js v0.5.1+. Use require('punycode') to\naccess it. (To use it with other Node.js versions, use npm to install the\npunycode module first.)
\n",
      "methods": [
        {
          "textRaw": "punycode.decode(string)",
          "type": "method",
          "name": "decode",
          "meta": {
            "added": [
              "v0.5.1"
            ]
          },
          "desc": "
Converts a Punycode string of ASCII-only symbols to a string of Unicode symbols.
\n
// decode domain name parts\npunycode.decode('maana-pta'); // 'mañana'\npunycode.decode('--dqo34k'); // '☃-⌘'\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "string"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "punycode.encode(string)",
          "type": "method",
          "name": "encode",
          "meta": {
            "added": [
              "v0.5.1"
            ]
          },
          "desc": "
Converts a string of Unicode symbols to a Punycode string of ASCII-only symbols.
\n
// encode domain name parts\npunycode.encode('mañana'); // 'maana-pta'\npunycode.encode('☃-⌘'); // '--dqo34k'\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "string"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "punycode.toASCII(domain)",
          "type": "method",
          "name": "toASCII",
          "meta": {
            "added": [
              "v0.6.1"
            ]
          },
          "desc": "
Converts a Unicode string representing a domain name to Punycode. Only the\nnon-ASCII parts of the domain name will be converted, i.e. it doesn't matter if\nyou call it with a domain that's already in ASCII.
\n
// encode domain names\npunycode.toASCII('mañana.com'); // 'xn--maana-pta.com'\npunycode.toASCII('☃-⌘.com'); // 'xn----dqo34k.com'\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "domain"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "punycode.toUnicode(domain)",
          "type": "method",
          "name": "toUnicode",
          "meta": {
            "added": [
              "v0.6.1"
            ]
          },
          "desc": "
Converts a Punycode string representing a domain name to Unicode. Only the\nPunycoded parts of the domain name will be converted, i.e. it doesn't matter if\nyou call it on a string that has already been converted to Unicode.
\n
// decode domain names\npunycode.toUnicode('xn--maana-pta.com'); // 'mañana.com'\npunycode.toUnicode('xn----dqo34k.com'); // '☃-⌘.com'\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "domain"
                }
              ]
            }
          ]
        }
      ],
      "properties": [
        {
          "textRaw": "punycode.ucs2",
          "name": "ucs2",
          "meta": {
            "added": [
              "v0.7.0"
            ]
          },
          "modules": [
            {
              "textRaw": "punycode.ucs2.decode(string)",
              "name": "punycode.ucs2.decode(string)",
              "meta": {
                "added": [
                  "v0.7.0"
                ]
              },
              "desc": "
Creates an array containing the numeric code point values of each Unicode\nsymbol in the string. While JavaScript uses UCS-2 internally, this function\nwill convert a pair of surrogate halves (each of which UCS-2 exposes as\nseparate characters) into a single code point, matching UTF-16.
\n
punycode.ucs2.decode('abc'); // [0x61, 0x62, 0x63]\n// surrogate pair for U+1D306 tetragram for centre:\npunycode.ucs2.decode('\\uD834\\uDF06'); // [0x1D306]\n
\n",
              "type": "module",
              "displayName": "punycode.ucs2.decode(string)"
            },
            {
              "textRaw": "punycode.ucs2.encode(codePoints)",
              "name": "punycode.ucs2.encode(codepoints)",
              "meta": {
                "added": [
                  "v0.7.0"
                ]
              },
              "desc": "
Creates a string based on an array of numeric code point values.
\n
punycode.ucs2.encode([0x61, 0x62, 0x63]); // 'abc'\npunycode.ucs2.encode([0x1D306]); // '\\uD834\\uDF06'\n
\n",
              "type": "module",
              "displayName": "punycode.ucs2.encode(codePoints)"
            }
          ]
        },
        {
          "textRaw": "punycode.version",
          "name": "version",
          "meta": {
            "added": [
              "v0.6.1"
            ]
          },
          "desc": "
A string representing the current Punycode.js version number.
\n"
        }
      ],
      "type": "module",
      "displayName": "Punycode"
    }
  ]
}
node-v4.8.2/doc/api/punycode.md000644 000766 000024 00000005105 13070706735 016447 0ustar00iojsstaff000000 000000 # Punycode

> Stability: 2 - Stable

[Punycode.js][] is bundled with Node.js v0.5.1+. Use `require('punycode')` to
access it. (To use it with other Node.js versions, use npm to install the
`punycode` module first.)

## punycode.decode(string)


Converts a Punycode string of ASCII-only symbols to a string of Unicode symbols.

```js
// decode domain name parts
punycode.decode('maana-pta'); // 'mañana'
punycode.decode('--dqo34k'); // '☃-⌘'
```

## punycode.encode(string)


Converts a string of Unicode symbols to a Punycode string of ASCII-only symbols.

```js
// encode domain name parts
punycode.encode('mañana'); // 'maana-pta'
punycode.encode('☃-⌘'); // '--dqo34k'
```

## punycode.toASCII(domain)


Converts a Unicode string representing a domain name to Punycode. Only the
non-ASCII parts of the domain name will be converted, i.e. it doesn't matter if
you call it with a domain that's already in ASCII.

```js
// encode domain names
punycode.toASCII('mañana.com'); // 'xn--maana-pta.com'
punycode.toASCII('☃-⌘.com'); // 'xn----dqo34k.com'
```

## punycode.toUnicode(domain)


Converts a Punycode string representing a domain name to Unicode. Only the
Punycoded parts of the domain name will be converted, i.e. it doesn't matter if
you call it on a string that has already been converted to Unicode.

```js
// decode domain names
punycode.toUnicode('xn--maana-pta.com'); // 'mañana.com'
punycode.toUnicode('xn----dqo34k.com'); // '☃-⌘.com'
```

## punycode.ucs2


### punycode.ucs2.decode(string)


Creates an array containing the numeric code point values of each Unicode
symbol in the string. While [JavaScript uses UCS-2 internally][], this function
will convert a pair of surrogate halves (each of which UCS-2 exposes as
separate characters) into a single code point, matching UTF-16.

```js
punycode.ucs2.decode('abc'); // [0x61, 0x62, 0x63]
// surrogate pair for U+1D306 tetragram for centre:
punycode.ucs2.decode('\uD834\uDF06'); // [0x1D306]
```

### punycode.ucs2.encode(codePoints)


Creates a string based on an array of numeric code point values.

```js
punycode.ucs2.encode([0x61, 0x62, 0x63]); // 'abc'
punycode.ucs2.encode([0x1D306]); // '\uD834\uDF06'
```

## punycode.version


A string representing the current Punycode.js version number.

[Punycode.js]: https://mths.be/punycode
[JavaScript uses UCS-2 internally]: https://mathiasbynens.be/notes/javascript-encoding
node-v4.8.2/doc/api/querystring.html000644 000766 000024 00000020703 13070706740 017556 0ustar00iojsstaff000000 000000 


  
  Query String | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

      

        
Query String#


Stability: 2 - Stable


This module provides utilities for dealing with query strings.
It provides the following methods:


querystring.escape#



Added in: v0.1.25

The escape function used by querystring.stringify,
provided so that it could be overridden if necessary.


querystring.parse(str[, sep][, eq][, options])#



Added in: v0.1.25

Deserialize a query string to an object.
Optionally override the default separator ('&') and assignment ('=')
characters.


Options object may contain maxKeys property (equal to 1000 by default), it'll
be used to limit processed keys. Set it to 0 to remove key count limitation.


Options object may contain decodeURIComponent property (querystring.unescape by default),
it can be used to decode a non-utf8 encoding string if necessary.


Example:


querystring.parse('foo=bar&baz=qux&baz=quux&corge')
// returns { foo: 'bar', baz: ['qux', 'quux'], corge: '' }

// Suppose gbkDecodeURIComponent function already exists,
// it can decode `gbk` encoding string
querystring.parse('w=%D6%D0%CE%C4&foo=bar', null, null,
  { decodeURIComponent: gbkDecodeURIComponent })
// returns { w: '中文', foo: 'bar' }



querystring.stringify(obj[, sep][, eq][, options])#



Added in: v0.1.25

Serialize an object to a query string.
Optionally override the default separator ('&') and assignment ('=')
characters.


Options object may contain encodeURIComponent property (querystring.escape by default),
it can be used to encode string with non-utf8 encoding if necessary.


Example:


querystring.stringify({ foo: 'bar', baz: ['qux', 'quux'], corge: '' })
// returns 'foo=bar&baz=qux&baz=quux&corge='

querystring.stringify({foo: 'bar', baz: 'qux'}, ';', ':')
// returns 'foo:bar;baz:qux'

// Suppose gbkEncodeURIComponent function already exists,
// it can encode string with `gbk` encoding
querystring.stringify({ w: '中文', foo: 'bar' }, null, null,
  { encodeURIComponent: gbkEncodeURIComponent })
// returns 'w=%D6%D0%CE%C4&foo=bar'



querystring.unescape#



Added in: v0.1.25

The unescape function used by querystring.parse,
provided so that it could be overridden if necessary.


It will try to use decodeURIComponent in the first place,
but if that fails it falls back to a safer equivalent that
doesn't throw on malformed URLs.


      

    

  

  
  
  
  



node-v4.8.2/doc/api/querystring.json000644 000766 000024 00000011435 13070706740 017565 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/querystring.md",
  "modules": [
    {
      "textRaw": "Query String",
      "name": "querystring",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
This module provides utilities for dealing with query strings.\nIt provides the following methods:
\n",
      "properties": [
        {
          "textRaw": "querystring.escape",
          "name": "escape",
          "meta": {
            "added": [
              "v0.1.25"
            ]
          },
          "desc": "
The escape function used by querystring.stringify,\nprovided so that it could be overridden if necessary.
\n"
        },
        {
          "textRaw": "querystring.unescape",
          "name": "unescape",
          "meta": {
            "added": [
              "v0.1.25"
            ]
          },
          "desc": "
The unescape function used by querystring.parse,\nprovided so that it could be overridden if necessary.
\n
It will try to use decodeURIComponent in the first place,\nbut if that fails it falls back to a safer equivalent that\ndoesn't throw on malformed URLs.
\n"
        }
      ],
      "methods": [
        {
          "textRaw": "querystring.parse(str[, sep][, eq][, options])",
          "type": "method",
          "name": "parse",
          "meta": {
            "added": [
              "v0.1.25"
            ]
          },
          "desc": "
Deserialize a query string to an object.\nOptionally override the default separator ('&') and assignment ('=')\ncharacters.
\n
Options object may contain maxKeys property (equal to 1000 by default), it'll\nbe used to limit processed keys. Set it to 0 to remove key count limitation.
\n
Options object may contain decodeURIComponent property (querystring.unescape by default),\nit can be used to decode a non-utf8 encoding string if necessary.
\n
Example:
\n
querystring.parse('foo=bar&baz=qux&baz=quux&corge')\n// returns { foo: 'bar', baz: ['qux', 'quux'], corge: '' }\n\n// Suppose gbkDecodeURIComponent function already exists,\n// it can decode `gbk` encoding string\nquerystring.parse('w=%D6%D0%CE%C4&foo=bar', null, null,\n  { decodeURIComponent: gbkDecodeURIComponent })\n// returns { w: '中文', foo: 'bar' }\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "str"
                },
                {
                  "name": "sep",
                  "optional": true
                },
                {
                  "name": "eq",
                  "optional": true
                },
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "querystring.stringify(obj[, sep][, eq][, options])",
          "type": "method",
          "name": "stringify",
          "meta": {
            "added": [
              "v0.1.25"
            ]
          },
          "desc": "
Serialize an object to a query string.\nOptionally override the default separator ('&') and assignment ('=')\ncharacters.
\n
Options object may contain encodeURIComponent property (querystring.escape by default),\nit can be used to encode string with non-utf8 encoding if necessary.
\n
Example:
\n
querystring.stringify({ foo: 'bar', baz: ['qux', 'quux'], corge: '' })\n// returns 'foo=bar&baz=qux&baz=quux&corge='\n\nquerystring.stringify({foo: 'bar', baz: 'qux'}, ';', ':')\n// returns 'foo:bar;baz:qux'\n\n// Suppose gbkEncodeURIComponent function already exists,\n// it can encode string with `gbk` encoding\nquerystring.stringify({ w: '中文', foo: 'bar' }, null, null,\n  { encodeURIComponent: gbkEncodeURIComponent })\n// returns 'w=%D6%D0%CE%C4&foo=bar'\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "obj"
                },
                {
                  "name": "sep",
                  "optional": true
                },
                {
                  "name": "eq",
                  "optional": true
                },
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "querystring"
    }
  ]
}
node-v4.8.2/doc/api/querystring.md000644 000766 000024 00000004524 13070706735 017221 0ustar00iojsstaff000000 000000 # Query String

> Stability: 2 - Stable



This module provides utilities for dealing with query strings.
It provides the following methods:

## querystring.escape


The escape function used by `querystring.stringify`,
provided so that it could be overridden if necessary.

## querystring.parse(str[, sep][, eq][, options])


Deserialize a query string to an object.
Optionally override the default separator (`'&'`) and assignment (`'='`)
characters.

Options object may contain `maxKeys` property (equal to 1000 by default), it'll
be used to limit processed keys. Set it to 0 to remove key count limitation.

Options object may contain `decodeURIComponent` property (`querystring.unescape` by default),
it can be used to decode a `non-utf8` encoding string if necessary.

Example:

```js
querystring.parse('foo=bar&baz=qux&baz=quux&corge')
// returns { foo: 'bar', baz: ['qux', 'quux'], corge: '' }

// Suppose gbkDecodeURIComponent function already exists,
// it can decode `gbk` encoding string
querystring.parse('w=%D6%D0%CE%C4&foo=bar', null, null,
  { decodeURIComponent: gbkDecodeURIComponent })
// returns { w: '中文', foo: 'bar' }
```

## querystring.stringify(obj[, sep][, eq][, options])


Serialize an object to a query string.
Optionally override the default separator (`'&'`) and assignment (`'='`)
characters.

Options object may contain `encodeURIComponent` property (`querystring.escape` by default),
it can be used to encode string with `non-utf8` encoding if necessary.

Example:

```js
querystring.stringify({ foo: 'bar', baz: ['qux', 'quux'], corge: '' })
// returns 'foo=bar&baz=qux&baz=quux&corge='

querystring.stringify({foo: 'bar', baz: 'qux'}, ';', ':')
// returns 'foo:bar;baz:qux'

// Suppose gbkEncodeURIComponent function already exists,
// it can encode string with `gbk` encoding
querystring.stringify({ w: '中文', foo: 'bar' }, null, null,
  { encodeURIComponent: gbkEncodeURIComponent })
// returns 'w=%D6%D0%CE%C4&foo=bar'
```

## querystring.unescape


The unescape function used by `querystring.parse`,
provided so that it could be overridden if necessary.

It will try to use `decodeURIComponent` in the first place,
but if that fails it falls back to a safer equivalent that
doesn't throw on malformed URLs.
node-v4.8.2/doc/api/readline.html000644 000766 000024 00000057367 13070706740 016765 0ustar00iojsstaff000000 000000 


  
  Readline | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

      

        
Readline#


Stability: 2 - Stable
To use this module, do require('readline'). Readline allows reading of a
stream (such as process.stdin) on a line-by-line basis.


Note that once you've invoked this module, your Node.js program will not
terminate until you've closed the interface. Here's how to allow your
program to gracefully exit:


const readline = require('readline');

const rl = readline.createInterface({
  input: process.stdin,
  output: process.stdout
});

rl.question('What do you think of Node.js? ', (answer) => {
  // TODO: Log the answer in a database
  console.log('Thank you for your valuable feedback:', answer);

  rl.close();
});



Class: Interface#



Added in: v0.1.104

The class that represents a readline interface with an input and output
stream.


rl.close()#



Added in: v0.1.98

Closes the Interface instance, relinquishing control on the input and
output streams. The 'close' event will also be emitted.


rl.pause()#



Added in: v0.3.4

Pauses the readline input stream, allowing it to be resumed later if needed.


Note that this doesn't immediately pause the stream of events. Several events may
be emitted after calling pause, including line.


rl.prompt([preserveCursor])#



Added in: v0.1.98

Readies readline for input from the user, putting the current setPrompt
options on a new line, giving the user a new spot to write. Set preserveCursor
to true to prevent the cursor placement being reset to 0.


This will also resume the input stream used with createInterface if it has
been paused.


If output is set to null or undefined when calling createInterface, the
prompt is not written.


rl.question(query, callback)#



Added in: v0.3.3

Prepends the prompt with query and invokes callback with the user's
response. Displays the query to the user, and then invokes callback
with the user's response after it has been typed.


This will also resume the input stream used with createInterface if
it has been paused.


If output is set to null or undefined when calling createInterface,
nothing is displayed.


Example usage:


rl.question('What is your favorite food?', (answer) => {
  console.log(`Oh, so your favorite food is ${answer}`);
});



rl.resume()#



Added in: v0.3.4

Resumes the readline input stream.


rl.setPrompt(prompt)#



Added in: v0.1.98

Sets the prompt, for example when you run node on the command line, you see
>, which is Node.js's prompt.


rl.write(data[, key])#



Added in: v0.1.98

Writes data to output stream, unless output is set to null or
undefined when calling createInterface. key is an object literal to
represent a key sequence; available if the terminal is a TTY.


This will also resume the input stream if it has been paused.


Example:


rl.write('Delete me!');
// Simulate ctrl+u to delete the line written previously
rl.write(null, {ctrl: true, name: 'u'});



Events#


Event: 'close'#



Added in: v0.1.98

function () {}


Emitted when close() is called.


Also emitted when the input stream receives its 'end' event. The Interface
instance should be considered "finished" once this is emitted. For example, when
the input stream receives ^D, respectively known as EOT.


This event is also called if there is no SIGINT event listener present when
the input stream receives a ^C, respectively known as SIGINT.


Event: 'line'#



Added in: v0.1.98

function (line) {}


Emitted whenever the input stream receives an end of line (\n, \r, or
\r\n), usually received when the user hits enter, or return. This is a good
hook to listen for user input.


Example of listening for 'line':


rl.on('line', (cmd) => {
  console.log(`You just typed: ${cmd}`);
});



Event: 'pause'#



Added in: v0.7.5

function () {}


Emitted whenever the input stream is paused.


Also emitted whenever the input stream is not paused and receives the
SIGCONT event. (See events SIGTSTP and SIGCONT)


Example of listening for 'pause':


rl.on('pause', () => {
  console.log('Readline paused.');
});



Event: 'resume'#



Added in: v0.7.5

function () {}


Emitted whenever the input stream is resumed.


Example of listening for 'resume':


rl.on('resume', () => {
  console.log('Readline resumed.');
});



Event: 'SIGCONT'#



Added in: v0.7.5

function () {}


This does not work on Windows.


Emitted whenever the input stream is sent to the background with ^Z,
respectively known as SIGTSTP, and then continued with fg(1). This event
only emits if the stream was not paused before sending the program to the
background.


Example of listening for SIGCONT:


rl.on('SIGCONT', () => {
  // `prompt` will automatically resume the stream
  rl.prompt();
});



Event: 'SIGINT'#



Added in: v0.3.0

function () {}


Emitted whenever the input stream receives a ^C, respectively known as
SIGINT. If there is no SIGINT event listener present when the input
stream receives a SIGINT, pause will be triggered.


Example of listening for SIGINT:


rl.on('SIGINT', () => {
  rl.question('Are you sure you want to exit?', (answer) => {
    if (answer.match(/^y(es)?$/i)) rl.pause();
  });
});



Event: 'SIGTSTP'#



Added in: v0.7.5

function () {}


This does not work on Windows.


Emitted whenever the input stream receives a ^Z, respectively known as
SIGTSTP. If there is no SIGTSTP event listener present when the input
stream receives a SIGTSTP, the program will be sent to the background.


When the program is resumed with fg, the 'pause' and SIGCONT events will be
emitted. You can use either to resume the stream.


The 'pause' and SIGCONT events will not be triggered if the stream was paused
before the program was sent to the background.


Example of listening for SIGTSTP:


rl.on('SIGTSTP', () => {
  // This will override SIGTSTP and prevent the program from going to the
  // background.
  console.log('Caught SIGTSTP.');
});



Example: Tiny CLI#


Here's an example of how to use all these together to craft a tiny command
line interface:


const readline = require('readline');
const rl = readline.createInterface(process.stdin, process.stdout);

rl.setPrompt('OHAI> ');
rl.prompt();

rl.on('line', (line) => {
  switch(line.trim()) {
    case 'hello':
      console.log('world!');
      break;
    default:
      console.log('Say what? I might have heard `' + line.trim() + '`');
      break;
  }
  rl.prompt();
}).on('close', () => {
  console.log('Have a great day!');
  process.exit(0);
});



Example: Read File Stream Line-by-Line#


A common case for readline's input option is to pass a filesystem readable
stream to it. This is how one could craft line-by-line parsing of a file:


const readline = require('readline');
const fs = require('fs');

const rl = readline.createInterface({
  input: fs.createReadStream('sample.txt')
});

rl.on('line', (line) => {
  console.log('Line from file:', line);
});



Note: The rl.write() method will write the data to the readline
Interface's input as if it were provided by the user.


readline.clearLine(stream, dir)#



Added in: v0.7.7

Clears current line of given TTY stream in a specified direction.
dir should have one of following values:


    

  • -1 - to the left from cursor
    • 

  • 1 - to the right from cursor
    • 

  • 0 - the entire line
    • 



readline.clearScreenDown(stream)#



Added in: v0.7.7

Clears the screen from the current position of the cursor down.


readline.createInterface(options)#



Added in: v0.1.98

Creates a readline Interface instance. Accepts an options Object that takes
the following values:


    

  • input - the readable stream to listen to (Required).
    

    • 

  • output - the writable stream to write readline data to (Optional).
    

    • 

  • completer - an optional function that is used for Tab autocompletion. See
below for an example of using this.
    

    • 

  • terminal - pass true if the input and output streams should be
treated like a TTY, and have ANSI/VT100 escape codes written to it.
Defaults to checking isTTY on the output stream upon instantiation.
    

    • 

  • historySize - maximum number of history lines retained. Defaults to 30.
    

    • 



The completer function is given the current line entered by the user, and
is supposed to return an Array with 2 entries:


    

  1. An Array with matching entries for the completion.
    

    2. 

  2. The substring that was used for the matching.
    

    3. 



Which ends up looking something like:
[[substr1, substr2, ...], originalsubstring].


Example:


function completer(line) {
  var completions = '.help .error .exit .quit .q'.split(' ')
  var hits = completions.filter((c) => { return c.indexOf(line) == 0 })
  // show all completions if none found
  return [hits.length ? hits : completions, line]
}



Also completer can be run in async mode if it accepts two arguments:


function completer(linePartial, callback) {
  callback(null, [['123'], linePartial]);
}



createInterface is commonly used with process.stdin and
process.stdout in order to accept user input:


const readline = require('readline');
const rl = readline.createInterface({
  input: process.stdin,
  output: process.stdout
});



Once you have a readline instance, you most commonly listen for the
'line' event.


If terminal is true for this instance then the output stream will get
the best compatibility if it defines an output.columns property, and fires
a 'resize' event on the output if/when the columns ever change
(process.stdout does this automatically when it is a TTY).


readline.cursorTo(stream, x, y)#



Added in: v0.7.7

Move cursor to the specified position in a given TTY stream.


readline.emitKeypressEvents(stream[, interface])#



Added in: v0.7.7

Causes stream to begin emitting 'keypress' events corresponding to its
input.
Optionally, interface specifies a readline.Interface instance for which
autocompletion is disabled when copy-pasted input is detected.


readline.moveCursor(stream, dx, dy)#



Added in: v0.7.7

Move cursor relative to it's current position in a given TTY stream.


      

    

  

  
  
  
  



node-v4.8.2/doc/api/readline.json000644 000766 000024 00000052667 13070706740 016770 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/readline.md",
  "modules": [
    {
      "textRaw": "Readline",
      "name": "readline",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
To use this module, do require('readline'). Readline allows reading of a\nstream (such as process.stdin) on a line-by-line basis.
\n
Note that once you've invoked this module, your Node.js program will not\nterminate until you've closed the interface. Here's how to allow your\nprogram to gracefully exit:
\n
const readline = require('readline');\n\nconst rl = readline.createInterface({\n  input: process.stdin,\n  output: process.stdout\n});\n\nrl.question('What do you think of Node.js? ', (answer) => {\n  // TODO: Log the answer in a database\n  console.log('Thank you for your valuable feedback:', answer);\n\n  rl.close();\n});\n
\n",
      "classes": [
        {
          "textRaw": "Class: Interface",
          "type": "class",
          "name": "Interface",
          "meta": {
            "added": [
              "v0.1.104"
            ]
          },
          "desc": "
The class that represents a readline interface with an input and output\nstream.
\n",
          "methods": [
            {
              "textRaw": "rl.close()",
              "type": "method",
              "name": "close",
              "meta": {
                "added": [
                  "v0.1.98"
                ]
              },
              "desc": "
Closes the Interface instance, relinquishing control on the input and\noutput streams. The 'close' event will also be emitted.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "rl.pause()",
              "type": "method",
              "name": "pause",
              "meta": {
                "added": [
                  "v0.3.4"
                ]
              },
              "desc": "
Pauses the readline input stream, allowing it to be resumed later if needed.
\n
Note that this doesn't immediately pause the stream of events. Several events may\nbe emitted after calling pause, including line.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "rl.prompt([preserveCursor])",
              "type": "method",
              "name": "prompt",
              "meta": {
                "added": [
                  "v0.1.98"
                ]
              },
              "desc": "
Readies readline for input from the user, putting the current setPrompt\noptions on a new line, giving the user a new spot to write. Set preserveCursor\nto true to prevent the cursor placement being reset to 0.
\n
This will also resume the input stream used with createInterface if it has\nbeen paused.
\n
If output is set to null or undefined when calling createInterface, the\nprompt is not written.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "preserveCursor",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "rl.question(query, callback)",
              "type": "method",
              "name": "question",
              "meta": {
                "added": [
                  "v0.3.3"
                ]
              },
              "desc": "
Prepends the prompt with query and invokes callback with the user's\nresponse. Displays the query to the user, and then invokes callback\nwith the user's response after it has been typed.
\n
This will also resume the input stream used with createInterface if\nit has been paused.
\n
If output is set to null or undefined when calling createInterface,\nnothing is displayed.
\n
Example usage:
\n
rl.question('What is your favorite food?', (answer) => {\n  console.log(`Oh, so your favorite food is ${answer}`);\n});\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "query"
                    },
                    {
                      "name": "callback"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "rl.resume()",
              "type": "method",
              "name": "resume",
              "meta": {
                "added": [
                  "v0.3.4"
                ]
              },
              "desc": "
Resumes the readline input stream.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "rl.setPrompt(prompt)",
              "type": "method",
              "name": "setPrompt",
              "meta": {
                "added": [
                  "v0.1.98"
                ]
              },
              "desc": "
Sets the prompt, for example when you run node on the command line, you see\n>, which is Node.js's prompt.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "prompt"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "rl.write(data[, key])",
              "type": "method",
              "name": "write",
              "meta": {
                "added": [
                  "v0.1.98"
                ]
              },
              "desc": "
Writes data to output stream, unless output is set to null or\nundefined when calling createInterface. key is an object literal to\nrepresent a key sequence; available if the terminal is a TTY.
\n
This will also resume the input stream if it has been paused.
\n
Example:
\n
rl.write('Delete me!');\n// Simulate ctrl+u to delete the line written previously\nrl.write(null, {ctrl: true, name: 'u'});\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "data"
                    },
                    {
                      "name": "key",
                      "optional": true
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "modules": [
        {
          "textRaw": "Events",
          "name": "events",
          "events": [
            {
              "textRaw": "Event: 'close'",
              "type": "event",
              "name": "close",
              "meta": {
                "added": [
                  "v0.1.98"
                ]
              },
              "desc": "
function () {}
\n
Emitted when close() is called.
\n
Also emitted when the input stream receives its 'end' event. The Interface\ninstance should be considered "finished" once this is emitted. For example, when\nthe input stream receives ^D, respectively known as EOT.
\n
This event is also called if there is no SIGINT event listener present when\nthe input stream receives a ^C, respectively known as SIGINT.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'line'",
              "type": "event",
              "name": "line",
              "meta": {
                "added": [
                  "v0.1.98"
                ]
              },
              "desc": "
function (line) {}
\n
Emitted whenever the input stream receives an end of line (\\n, \\r, or\n\\r\\n), usually received when the user hits enter, or return. This is a good\nhook to listen for user input.
\n
Example of listening for 'line':
\n
rl.on('line', (cmd) => {\n  console.log(`You just typed: ${cmd}`);\n});\n
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'pause'",
              "type": "event",
              "name": "pause",
              "meta": {
                "added": [
                  "v0.7.5"
                ]
              },
              "desc": "
function () {}
\n
Emitted whenever the input stream is paused.
\n
Also emitted whenever the input stream is not paused and receives the\nSIGCONT event. (See events SIGTSTP and SIGCONT)
\n
Example of listening for 'pause':
\n
rl.on('pause', () => {\n  console.log('Readline paused.');\n});\n
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'resume'",
              "type": "event",
              "name": "resume",
              "meta": {
                "added": [
                  "v0.7.5"
                ]
              },
              "desc": "
function () {}
\n
Emitted whenever the input stream is resumed.
\n
Example of listening for 'resume':
\n
rl.on('resume', () => {\n  console.log('Readline resumed.');\n});\n
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'SIGCONT'",
              "type": "event",
              "name": "SIGCONT",
              "meta": {
                "added": [
                  "v0.7.5"
                ]
              },
              "desc": "
function () {}
\n
This does not work on Windows.
\n
Emitted whenever the input stream is sent to the background with ^Z,\nrespectively known as SIGTSTP, and then continued with fg(1). This event\nonly emits if the stream was not paused before sending the program to the\nbackground.
\n
Example of listening for SIGCONT:
\n
rl.on('SIGCONT', () => {\n  // `prompt` will automatically resume the stream\n  rl.prompt();\n});\n
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'SIGINT'",
              "type": "event",
              "name": "SIGINT",
              "meta": {
                "added": [
                  "v0.3.0"
                ]
              },
              "desc": "
function () {}
\n
Emitted whenever the input stream receives a ^C, respectively known as\nSIGINT. If there is no SIGINT event listener present when the input\nstream receives a SIGINT, pause will be triggered.
\n
Example of listening for SIGINT:
\n
rl.on('SIGINT', () => {\n  rl.question('Are you sure you want to exit?', (answer) => {\n    if (answer.match(/^y(es)?$/i)) rl.pause();\n  });\n});\n
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'SIGTSTP'",
              "type": "event",
              "name": "SIGTSTP",
              "meta": {
                "added": [
                  "v0.7.5"
                ]
              },
              "desc": "
function () {}
\n
This does not work on Windows.
\n
Emitted whenever the input stream receives a ^Z, respectively known as\nSIGTSTP. If there is no SIGTSTP event listener present when the input\nstream receives a SIGTSTP, the program will be sent to the background.
\n
When the program is resumed with fg, the 'pause' and SIGCONT events will be\nemitted. You can use either to resume the stream.
\n
The 'pause' and SIGCONT events will not be triggered if the stream was paused\nbefore the program was sent to the background.
\n
Example of listening for SIGTSTP:
\n
rl.on('SIGTSTP', () => {\n  // This will override SIGTSTP and prevent the program from going to the\n  // background.\n  console.log('Caught SIGTSTP.');\n});\n
\n
Example: Tiny CLI
\n
Here's an example of how to use all these together to craft a tiny command\nline interface:
\n
const readline = require('readline');\nconst rl = readline.createInterface(process.stdin, process.stdout);\n\nrl.setPrompt('OHAI> ');\nrl.prompt();\n\nrl.on('line', (line) => {\n  switch(line.trim()) {\n    case 'hello':\n      console.log('world!');\n      break;\n    default:\n      console.log('Say what? I might have heard `' + line.trim() + '`');\n      break;\n  }\n  rl.prompt();\n}).on('close', () => {\n  console.log('Have a great day!');\n  process.exit(0);\n});\n
\n
Example: Read File Stream Line-by-Line
\n
A common case for readline's input option is to pass a filesystem readable\nstream to it. This is how one could craft line-by-line parsing of a file:
\n
const readline = require('readline');\nconst fs = require('fs');\n\nconst rl = readline.createInterface({\n  input: fs.createReadStream('sample.txt')\n});\n\nrl.on('line', (line) => {\n  console.log('Line from file:', line);\n});\n
\n
Note: The rl.write() method will write the data to the readline\nInterface's input as if it were provided by the user.
\n",
              "params": []
            }
          ],
          "type": "module",
          "displayName": "Events"
        }
      ],
      "methods": [
        {
          "textRaw": "readline.clearLine(stream, dir)",
          "type": "method",
          "name": "clearLine",
          "meta": {
            "added": [
              "v0.7.7"
            ]
          },
          "desc": "
Clears current line of given TTY stream in a specified direction.\ndir should have one of following values:
\n
    \n
  • -1 - to the left from cursor
    • \n
  • 1 - to the right from cursor
    • \n
  • 0 - the entire line
    • \n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "stream"
                },
                {
                  "name": "dir"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "readline.clearScreenDown(stream)",
          "type": "method",
          "name": "clearScreenDown",
          "meta": {
            "added": [
              "v0.7.7"
            ]
          },
          "desc": "
Clears the screen from the current position of the cursor down.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "stream"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "readline.createInterface(options)",
          "type": "method",
          "name": "createInterface",
          "meta": {
            "added": [
              "v0.1.98"
            ]
          },
          "desc": "
Creates a readline Interface instance. Accepts an options Object that takes\nthe following values:
\n
    \n
  • input - the readable stream to listen to (Required).
    \n
    • \n
  • output - the writable stream to write readline data to (Optional).
    \n
    • \n
  • completer - an optional function that is used for Tab autocompletion. See\nbelow for an example of using this.
    \n
    • \n
  • terminal - pass true if the input and output streams should be\ntreated like a TTY, and have ANSI/VT100 escape codes written to it.\nDefaults to checking isTTY on the output stream upon instantiation.
    \n
    • \n
  • historySize - maximum number of history lines retained. Defaults to 30.
    \n
    • \n
\n
The completer function is given the current line entered by the user, and\nis supposed to return an Array with 2 entries:
\n
    \n
  1. An Array with matching entries for the completion.
    \n
    2. \n
  2. The substring that was used for the matching.
    \n
    3. \n
\n
Which ends up looking something like:\n[[substr1, substr2, ...], originalsubstring].
\n
Example:
\n
function completer(line) {\n  var completions = '.help .error .exit .quit .q'.split(' ')\n  var hits = completions.filter((c) => { return c.indexOf(line) == 0 })\n  // show all completions if none found\n  return [hits.length ? hits : completions, line]\n}\n
\n
Also completer can be run in async mode if it accepts two arguments:
\n
function completer(linePartial, callback) {\n  callback(null, [['123'], linePartial]);\n}\n
\n
createInterface is commonly used with process.stdin and\nprocess.stdout in order to accept user input:
\n
const readline = require('readline');\nconst rl = readline.createInterface({\n  input: process.stdin,\n  output: process.stdout\n});\n
\n
Once you have a readline instance, you most commonly listen for the\n'line' event.
\n
If terminal is true for this instance then the output stream will get\nthe best compatibility if it defines an output.columns property, and fires\na 'resize' event on the output if/when the columns ever change\n(process.stdout does this automatically when it is a TTY).
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "options"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "readline.cursorTo(stream, x, y)",
          "type": "method",
          "name": "cursorTo",
          "meta": {
            "added": [
              "v0.7.7"
            ]
          },
          "desc": "
Move cursor to the specified position in a given TTY stream.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "stream"
                },
                {
                  "name": "x"
                },
                {
                  "name": "y"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "readline.emitKeypressEvents(stream[, interface])",
          "type": "method",
          "name": "emitKeypressEvents",
          "meta": {
            "added": [
              "v0.7.7"
            ]
          },
          "desc": "
Causes stream to begin emitting 'keypress' events corresponding to its\ninput.\nOptionally, interface specifies a readline.Interface instance for which\nautocompletion is disabled when copy-pasted input is detected.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "stream"
                },
                {
                  "name": "interface",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "readline.moveCursor(stream, dx, dy)",
          "type": "method",
          "name": "moveCursor",
          "meta": {
            "added": [
              "v0.7.7"
            ]
          },
          "desc": "
Move cursor relative to it's current position in a given TTY stream.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "stream"
                },
                {
                  "name": "dx"
                },
                {
                  "name": "dy"
                }
              ]
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "Readline"
    }
  ]
}
node-v4.8.2/doc/api/readline.md000644 000766 000024 00000024444 13070706735 016413 0ustar00iojsstaff000000 000000 # Readline

> Stability: 2 - Stable

To use this module, do `require('readline')`. Readline allows reading of a
stream (such as [`process.stdin`][]) on a line-by-line basis.

Note that once you've invoked this module, your Node.js program will not
terminate until you've closed the interface. Here's how to allow your
program to gracefully exit:

```js
const readline = require('readline');

const rl = readline.createInterface({
  input: process.stdin,
  output: process.stdout
});

rl.question('What do you think of Node.js? ', (answer) => {
  // TODO: Log the answer in a database
  console.log('Thank you for your valuable feedback:', answer);

  rl.close();
});
```

## Class: Interface


The class that represents a readline interface with an input and output
stream.

### rl.close()


Closes the `Interface` instance, relinquishing control on the `input` and
`output` streams. The `'close'` event will also be emitted.

### rl.pause()


Pauses the readline `input` stream, allowing it to be resumed later if needed.

Note that this doesn't immediately pause the stream of events. Several events may
be emitted after calling `pause`, including `line`.

### rl.prompt([preserveCursor])


Readies readline for input from the user, putting the current `setPrompt`
options on a new line, giving the user a new spot to write. Set `preserveCursor`
to `true` to prevent the cursor placement being reset to `0`.

This will also resume the `input` stream used with `createInterface` if it has
been paused.

If `output` is set to `null` or `undefined` when calling `createInterface`, the
prompt is not written.

### rl.question(query, callback)


Prepends the prompt with `query` and invokes `callback` with the user's
response. Displays the query to the user, and then invokes `callback`
with the user's response after it has been typed.

This will also resume the `input` stream used with `createInterface` if
it has been paused.

If `output` is set to `null` or `undefined` when calling `createInterface`,
nothing is displayed.

Example usage:

```js
rl.question('What is your favorite food?', (answer) => {
  console.log(`Oh, so your favorite food is ${answer}`);
});
```

### rl.resume()


Resumes the readline `input` stream.

### rl.setPrompt(prompt)


Sets the prompt, for example when you run `node` on the command line, you see
`> `, which is Node.js's prompt.

### rl.write(data[, key])


Writes `data` to `output` stream, unless `output` is set to `null` or
`undefined` when calling `createInterface`. `key` is an object literal to
represent a key sequence; available if the terminal is a TTY.

This will also resume the `input` stream if it has been paused.

Example:

```js
rl.write('Delete me!');
// Simulate ctrl+u to delete the line written previously
rl.write(null, {ctrl: true, name: 'u'});
```

## Events

### Event: 'close'


`function () {}`

Emitted when `close()` is called.

Also emitted when the `input` stream receives its `'end'` event. The `Interface`
instance should be considered "finished" once this is emitted. For example, when
the `input` stream receives `^D`, respectively known as `EOT`.

This event is also called if there is no `SIGINT` event listener present when
the `input` stream receives a `^C`, respectively known as `SIGINT`.

### Event: 'line'


`function (line) {}`

Emitted whenever the `input` stream receives an end of line (`\n`, `\r`, or
`\r\n`), usually received when the user hits enter, or return. This is a good
hook to listen for user input.

Example of listening for `'line'`:

```js
rl.on('line', (cmd) => {
  console.log(`You just typed: ${cmd}`);
});
```

### Event: 'pause'


`function () {}`

Emitted whenever the `input` stream is paused.

Also emitted whenever the `input` stream is not paused and receives the
`SIGCONT` event. (See events `SIGTSTP` and `SIGCONT`)

Example of listening for `'pause'`:

```js
rl.on('pause', () => {
  console.log('Readline paused.');
});
```

### Event: 'resume'


`function () {}`

Emitted whenever the `input` stream is resumed.

Example of listening for `'resume'`:

```js
rl.on('resume', () => {
  console.log('Readline resumed.');
});
```

### Event: 'SIGCONT'


`function () {}`

**This does not work on Windows.**

Emitted whenever the `input` stream is sent to the background with `^Z`,
respectively known as `SIGTSTP`, and then continued with fg(1). This event
only emits if the stream was not paused before sending the program to the
background.

Example of listening for `SIGCONT`:

```js
rl.on('SIGCONT', () => {
  // `prompt` will automatically resume the stream
  rl.prompt();
});
```

### Event: 'SIGINT'


`function () {}`

Emitted whenever the `input` stream receives a `^C`, respectively known as
`SIGINT`. If there is no `SIGINT` event listener present when the `input`
stream receives a `SIGINT`, `pause` will be triggered.

Example of listening for `SIGINT`:

```js
rl.on('SIGINT', () => {
  rl.question('Are you sure you want to exit?', (answer) => {
    if (answer.match(/^y(es)?$/i)) rl.pause();
  });
});
```

### Event: 'SIGTSTP'


`function () {}`

**This does not work on Windows.**

Emitted whenever the `input` stream receives a `^Z`, respectively known as
`SIGTSTP`. If there is no `SIGTSTP` event listener present when the `input`
stream receives a `SIGTSTP`, the program will be sent to the background.

When the program is resumed with `fg`, the `'pause'` and `SIGCONT` events will be
emitted. You can use either to resume the stream.

The `'pause'` and `SIGCONT` events will not be triggered if the stream was paused
before the program was sent to the background.

Example of listening for `SIGTSTP`:

```js
rl.on('SIGTSTP', () => {
  // This will override SIGTSTP and prevent the program from going to the
  // background.
  console.log('Caught SIGTSTP.');
});
```

## Example: Tiny CLI

Here's an example of how to use all these together to craft a tiny command
line interface:

```js
const readline = require('readline');
const rl = readline.createInterface(process.stdin, process.stdout);

rl.setPrompt('OHAI> ');
rl.prompt();

rl.on('line', (line) => {
  switch(line.trim()) {
    case 'hello':
      console.log('world!');
      break;
    default:
      console.log('Say what? I might have heard `' + line.trim() + '`');
      break;
  }
  rl.prompt();
}).on('close', () => {
  console.log('Have a great day!');
  process.exit(0);
});
```

## Example: Read File Stream Line-by-Line

A common case for `readline`'s `input` option is to pass a filesystem readable
stream to it. This is how one could craft line-by-line parsing of a file:

```js
const readline = require('readline');
const fs = require('fs');

const rl = readline.createInterface({
  input: fs.createReadStream('sample.txt')
});

rl.on('line', (line) => {
  console.log('Line from file:', line);
});
```

*Note*: The `rl.write()` method will write the data to the `readline`
Interface's `input` *as if it were provided by the user*.

## readline.clearLine(stream, dir)


Clears current line of given TTY stream in a specified direction.
`dir` should have one of following values:

* `-1` - to the left from cursor
* `1` - to the right from cursor
* `0` - the entire line

## readline.clearScreenDown(stream)


Clears the screen from the current position of the cursor down.

## readline.createInterface(options)


Creates a readline `Interface` instance. Accepts an `options` Object that takes
the following values:

 - `input` - the readable stream to listen to (Required).

 - `output` - the writable stream to write readline data to (Optional).

 - `completer` - an optional function that is used for Tab autocompletion. See
   below for an example of using this.

 - `terminal` - pass `true` if the `input` and `output` streams should be
   treated like a TTY, and have ANSI/VT100 escape codes written to it.
   Defaults to checking `isTTY` on the `output` stream upon instantiation.

 - `historySize` - maximum number of history lines retained. Defaults to `30`.

The `completer` function is given the current line entered by the user, and
is supposed to return an Array with 2 entries:

 1. An Array with matching entries for the completion.

 2. The substring that was used for the matching.

Which ends up looking something like:
`[[substr1, substr2, ...], originalsubstring]`.

Example:

```js
function completer(line) {
  var completions = '.help .error .exit .quit .q'.split(' ')
  var hits = completions.filter((c) => { return c.indexOf(line) == 0 })
  // show all completions if none found
  return [hits.length ? hits : completions, line]
}
```

Also `completer` can be run in async mode if it accepts two arguments:

```js
function completer(linePartial, callback) {
  callback(null, [['123'], linePartial]);
}
```

`createInterface` is commonly used with [`process.stdin`][] and
[`process.stdout`][] in order to accept user input:

```js
const readline = require('readline');
const rl = readline.createInterface({
  input: process.stdin,
  output: process.stdout
});
```

Once you have a readline instance, you most commonly listen for the
`'line'` event.

If `terminal` is `true` for this instance then the `output` stream will get
the best compatibility if it defines an `output.columns` property, and fires
a `'resize'` event on the `output` if/when the columns ever change
([`process.stdout`][] does this automatically when it is a TTY).

## readline.cursorTo(stream, x, y)


Move cursor to the specified position in a given TTY stream.

## readline.emitKeypressEvents(stream[, interface])


Causes `stream` to begin emitting `'keypress'` events corresponding to its
input.
Optionally, `interface` specifies a `readline.Interface` instance for which
autocompletion is disabled when copy-pasted input is detected.

## readline.moveCursor(stream, dx, dy)


Move cursor relative to it's current position in a given TTY stream.

[`process.stdin`]: process.html#process_process_stdin
[`process.stdout`]: process.html#process_process_stdout
node-v4.8.2/doc/api/repl.html000644 000766 000024 00000052176 13070706740 016135 0ustar00iojsstaff000000 000000 


  
  REPL | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

      

        
REPL#


Stability: 2 - Stable
A Read-Eval-Print-Loop (REPL) is available both as a standalone program and
easily includable in other programs. The REPL provides a way to interactively
run JavaScript and see the results.  It can be used for debugging, testing, or
just trying things out.


By executing node without any arguments from the command-line you will be
dropped into the REPL. It has simplistic emacs line-editing.


$ node
Type '.help' for options.
> a = [1, 2, 3];
[ 1, 2, 3 ]
> a.forEach((v) => {
...   console.log(v);
...   });
1
2
3

For advanced line-editors, start Node.js with the environmental variable
NODE_NO_READLINE=1. This will start the main and debugger REPL in canonical
terminal settings which will allow you to use with rlwrap.


For example, you could add this to your bashrc file:


alias node="env NODE_NO_READLINE=1 rlwrap node"

Environment Variable Options#


The built-in repl (invoked by running node or node -i) may be controlled
via the following environment variables:


    

  • NODE_REPL_HISTORY - When a valid path is given, persistent REPL history
will be saved to the specified file rather than .node_repl_history in the
user's home directory. Setting this value to "" will disable persistent
REPL history. Whitespace will be trimmed from the value.
    • 

  • NODE_REPL_HISTORY_SIZE - Defaults to 1000. Controls how many lines of
history will be persisted if history is available. Must be a positive number.
    • 

  • NODE_REPL_MODE - May be any of sloppy, strict, or magic. Defaults
to magic, which will automatically run "strict mode only" statements in
strict mode.
    • 



Persistent History#


By default, the REPL will persist history between node REPL sessions by saving
to a .node_repl_history file in the user's home directory. This can be
disabled by setting the environment variable NODE_REPL_HISTORY="".


NODE_REPL_HISTORY_FILE#


Stability: 0 - Deprecated: Use NODE_REPL_HISTORY instead.
Previously in Node.js/io.js v2.x, REPL history was controlled by using a
NODE_REPL_HISTORY_FILE environment variable, and the history was saved in JSON
format. This variable has now been deprecated, and your REPL history will
automatically be converted to using plain text. The new file will be saved to
either your home directory, or a directory defined by the NODE_REPL_HISTORY
variable, as documented here.


REPL Features#



Inside the REPL, Control+D will exit.  Multi-line expressions can be input.
Tab completion is supported for both global and local variables.


Core modules will be loaded on-demand into the environment. For example,
accessing fs will require() the fs module as global.fs.


The special variable _ (underscore) contains the result of the last expression.


> [ 'a', 'b', 'c' ]
[ 'a', 'b', 'c' ]
> _.length
3
> _ += 1
4

The REPL provides access to any variables in the global scope. You can expose
a variable to the REPL explicitly by assigning it to the context object
associated with each REPLServer.  For example:


// repl_test.js
const repl = require('repl');
var msg = 'message';

repl.start('> ').context.m = msg;



Things in the context object appear as local within the REPL:


$ node repl_test.js
> m
'message'

There are a few special REPL commands:


    

  • .break - While inputting a multi-line expression, sometimes you get lost
or just don't care about completing it. .break will start over.
    • 

  • .clear - Resets the context object to an empty object and clears any
multi-line expression.
    • 

  • .exit - Close the I/O stream, which will cause the REPL to exit.
    • 

  • .help - Show this list of special commands.
    • 

  • .save - Save the current REPL session to a file
.save ./file/to/save.js
    • 

  • .load - Load a file into the current REPL session.
.load ./file/to/load.js
    • 



The following key combinations in the REPL have these special effects:


    

  • <ctrl>C - Similar to the .break keyword.  Terminates the current
command.  Press twice on a blank line to forcibly exit.
    • 

  • <ctrl>D - Similar to the .exit keyword.
    • 

  • <tab> - Show both global and local(scope) variables
    • 



Customizing Object displays in the REPL#


The REPL module internally uses
util.inspect(), when printing values. However, util.inspect delegates the
 call to the object's inspect() function, if it has one. You can read more
 about this delegation here.


For example, if you have defined an inspect() function on an object, like this:


> var obj = {foo: 'this will not show up in the inspect() output'};
undefined
> obj.inspect = () => {
...   return {bar: 'baz'};
... };
[Function]

and try to print obj in REPL, it will invoke the custom inspect() function:


> obj
{bar: 'baz'}

Class: REPLServer#



Added in: v0.1.91

This inherits from Readline Interface with the following events:


Event: 'exit'#



Added in: v0.7.7

function () {}


Emitted when the user exits the REPL in any of the defined ways. Namely, typing
.exit at the repl, pressing Ctrl+C twice to signal SIGINT, or pressing Ctrl+D
to signal 'end' on the input stream.


Example of listening for exit:


replServer.on('exit', () => {
  console.log('Got "exit" event from repl!');
  process.exit();
});



Event: 'reset'#



Added in: v0.11.0

function (context) {}


Emitted when the REPL's context is reset. This happens when you type .clear.
If you start the repl with { useGlobal: true } then this event will never
be emitted.


Example of listening for reset:


// Extend the initial repl context.
var replServer = repl.start({ options ... });
someExtension.extend(r.context);

// When a new context is created extend it as well.
replServer.on('reset', (context) => {
  console.log('repl has a new context');
  someExtension.extend(context);
});



replServer.defineCommand(keyword, cmd)#



Added in: v0.3.0



Makes a command available in the REPL. The command is invoked by typing a .
followed by the keyword. The cmd is an object with the following values:


    

  • help - help text to be displayed when .help is entered (Optional).
    • 

  • action - a function to execute, potentially taking in a string argument,
when the command is invoked, bound to the REPLServer instance (Required).
    • 



If a function is provided instead of an object for cmd, it is treated as the
action.


Example of defining a command:


// repl_test.js
const repl = require('repl');

var replServer = repl.start();
replServer.defineCommand('sayhello', {
  help: 'Say hello',
  action: function(name) {
    this.write(`Hello, ${name}!\n`);
    this.displayPrompt();
  }
});



Example of invoking that command from the REPL:


> .sayhello Node.js User
Hello, Node.js User!

replServer.displayPrompt([preserveCursor])#



Added in: v0.1.91



Like readline.prompt except also adding indents with ellipses when inside
blocks. The preserveCursor argument is passed to readline.prompt. This is
used primarily with defineCommand. It's also used internally to render each
prompt line.


repl.start(options)#


Returns and starts a REPLServer instance, that inherits from
Readline Interface. Accepts an "options" Object that takes
the following values:


    

  • prompt - the prompt and stream for all I/O. Defaults to >.
    

    • 

  • input - the readable stream to listen to. Defaults to process.stdin.
    

    • 

  • output - the writable stream to write readline data to. Defaults to
process.stdout.
    

    • 

  • terminal - pass true if the stream should be treated like a TTY, and
have ANSI/VT100 escape codes written to it. Defaults to checking isTTY
on the output stream upon instantiation.
    

    • 

  • eval - function that will be used to eval each given line. Defaults to
an async wrapper for eval(). See below for an example of a custom eval.
    

    • 

  • useColors - a boolean which specifies whether or not the writer function
should output colors. If a different writer function is set then this does
nothing. Defaults to the repl's terminal value.
    

    • 

  • useGlobal - if set to true, then the repl will use the global object,
instead of running scripts in a separate context. Defaults to false.
    

    • 

  • ignoreUndefined - if set to true, then the repl will not output the
return value of command if it's undefined. Defaults to false.
    

    • 

  • writer - the function to invoke for each command that gets evaluated which
returns the formatting (including coloring) to display. Defaults to
util.inspect.
    

    • 

  • replMode - controls whether the repl runs all commands in strict mode,
default mode, or a hybrid mode ("magic" mode.) Acceptable values are:
    

      

    • repl.REPL_MODE_SLOPPY - run commands in sloppy mode.
      • 

    • repl.REPL_MODE_STRICT - run commands in strict mode. This is equivalent to
prefacing every repl statement with 'use strict'.
      • 

    • repl.REPL_MODE_MAGIC - attempt to run commands in default mode. If they
fail to parse, re-try in strict mode.
      • 

    

    • 



You can use your own eval function if it has following signature:


function eval(cmd, context, filename, callback) {
  callback(null, result);
}

On tab completion, eval will be called with .scope as an input string. It
is expected to return an array of scope names to be used for the auto-completion.


Multiple REPLs may be started against the same running instance of Node.js.  Each
will share the same global object but will have unique I/O.


Here is an example that starts a REPL on stdin, a Unix socket, and a TCP socket:


const net = require('net');
const repl = require('repl');
var connections = 0;

repl.start({
  prompt: 'Node.js via stdin> ',
  input: process.stdin,
  output: process.stdout
});

net.createServer((socket) => {
  connections += 1;
  repl.start({
    prompt: 'Node.js via Unix socket> ',
    input: socket,
    output: socket
  }).on('exit', () => {
    socket.end();
  })
}).listen('/tmp/node-repl-sock');

net.createServer((socket) => {
  connections += 1;
  repl.start({
    prompt: 'Node.js via TCP socket> ',
    input: socket,
    output: socket
  }).on('exit', () => {
    socket.end();
  });
}).listen(5001);



Running this program from the command line will start a REPL on stdin.  Other
REPL clients may connect through the Unix socket or TCP socket. telnet is useful
for connecting to TCP sockets, and socat can be used to connect to both Unix and
TCP sockets.


By starting a REPL from a Unix socket-based server instead of stdin, you can
connect to a long-running Node.js process without restarting it.


For an example of running a "full-featured" (terminal) REPL over
a net.Server and net.Socket instance, see: https://gist.github.com/2209310


For an example of running a REPL instance over curl(1),
see: https://gist.github.com/2053342


      

    

  

  
  
  
  



node-v4.8.2/doc/api/repl.json000644 000766 000024 00000043622 13070706740 016136 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/repl.md",
  "modules": [
    {
      "textRaw": "REPL",
      "name": "repl",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
A Read-Eval-Print-Loop (REPL) is available both as a standalone program and\neasily includable in other programs. The REPL provides a way to interactively\nrun JavaScript and see the results.  It can be used for debugging, testing, or\njust trying things out.
\n
By executing node without any arguments from the command-line you will be\ndropped into the REPL. It has simplistic emacs line-editing.
\n
$ node\nType '.help' for options.\n> a = [1, 2, 3];\n[ 1, 2, 3 ]\n> a.forEach((v) => {\n...   console.log(v);\n...   });\n1\n2\n3\n
For advanced line-editors, start Node.js with the environmental variable\nNODE_NO_READLINE=1. This will start the main and debugger REPL in canonical\nterminal settings which will allow you to use with rlwrap.
\n
For example, you could add this to your bashrc file:
\n
alias node="env NODE_NO_READLINE=1 rlwrap node"\n
",
      "modules": [
        {
          "textRaw": "Environment Variable Options",
          "name": "environment_variable_options",
          "desc": "
The built-in repl (invoked by running node or node -i) may be controlled\nvia the following environment variables:
\n
    \n
  • NODE_REPL_HISTORY - When a valid path is given, persistent REPL history\nwill be saved to the specified file rather than .node_repl_history in the\nuser's home directory. Setting this value to "" will disable persistent\nREPL history. Whitespace will be trimmed from the value.
    • \n
  • NODE_REPL_HISTORY_SIZE - Defaults to 1000. Controls how many lines of\nhistory will be persisted if history is available. Must be a positive number.
    • \n
  • NODE_REPL_MODE - May be any of sloppy, strict, or magic. Defaults\nto magic, which will automatically run "strict mode only" statements in\nstrict mode.
    • \n
\n",
          "type": "module",
          "displayName": "Environment Variable Options"
        },
        {
          "textRaw": "Persistent History",
          "name": "persistent_history",
          "desc": "
By default, the REPL will persist history between node REPL sessions by saving\nto a .node_repl_history file in the user's home directory. This can be\ndisabled by setting the environment variable NODE_REPL_HISTORY="".
\n",
          "modules": [
            {
              "textRaw": "NODE_REPL_HISTORY_FILE",
              "name": "node_repl_history_file",
              "stability": 0,
              "stabilityText": "Deprecated: Use `NODE_REPL_HISTORY` instead.",
              "desc": "
Previously in Node.js/io.js v2.x, REPL history was controlled by using a\nNODE_REPL_HISTORY_FILE environment variable, and the history was saved in JSON\nformat. This variable has now been deprecated, and your REPL history will\nautomatically be converted to using plain text. The new file will be saved to\neither your home directory, or a directory defined by the NODE_REPL_HISTORY\nvariable, as documented here.
\n",
              "type": "module",
              "displayName": "NODE_REPL_HISTORY_FILE"
            }
          ],
          "type": "module",
          "displayName": "Persistent History"
        }
      ],
      "miscs": [
        {
          "textRaw": "REPL Features",
          "name": "REPL Features",
          "type": "misc",
          "desc": "
Inside the REPL, Control+D will exit.  Multi-line expressions can be input.\nTab completion is supported for both global and local variables.
\n
Core modules will be loaded on-demand into the environment. For example,\naccessing fs will require() the fs module as global.fs.
\n
The special variable _ (underscore) contains the result of the last expression.
\n
> [ 'a', 'b', 'c' ]\n[ 'a', 'b', 'c' ]\n> _.length\n3\n> _ += 1\n4\n
The REPL provides access to any variables in the global scope. You can expose\na variable to the REPL explicitly by assigning it to the context object\nassociated with each REPLServer.  For example:
\n
// repl_test.js\nconst repl = require('repl');\nvar msg = 'message';\n\nrepl.start('> ').context.m = msg;\n
\n
Things in the context object appear as local within the REPL:
\n
$ node repl_test.js\n> m\n'message'\n
There are a few special REPL commands:
\n
    \n
  • .break - While inputting a multi-line expression, sometimes you get lost\nor just don't care about completing it. .break will start over.
    • \n
  • .clear - Resets the context object to an empty object and clears any\nmulti-line expression.
    • \n
  • .exit - Close the I/O stream, which will cause the REPL to exit.
    • \n
  • .help - Show this list of special commands.
    • \n
  • .save - Save the current REPL session to a file
    \n
    .save ./file/to/save.js
    \n
    \n
    • \n
  • .load - Load a file into the current REPL session.
    \n
    .load ./file/to/load.js
    \n
    \n
    • \n
\n
The following key combinations in the REPL have these special effects:
\n
    \n
  • <ctrl>C - Similar to the .break keyword.  Terminates the current\ncommand.  Press twice on a blank line to forcibly exit.
    • \n
  • <ctrl>D - Similar to the .exit keyword.
    • \n
  • <tab> - Show both global and local(scope) variables
    • \n
\n",
          "miscs": [
            {
              "textRaw": "Customizing Object displays in the REPL",
              "name": "customizing_object_displays_in_the_repl",
              "desc": "
The REPL module internally uses\nutil.inspect(), when printing values. However, util.inspect delegates the\n call to the object's inspect() function, if it has one. You can read more\n about this delegation here.
\n
For example, if you have defined an inspect() function on an object, like this:
\n
> var obj = {foo: 'this will not show up in the inspect() output'};\nundefined\n> obj.inspect = () => {\n...   return {bar: 'baz'};\n... };\n[Function]\n
and try to print obj in REPL, it will invoke the custom inspect() function:
\n
> obj\n{bar: 'baz'}\n
",
              "type": "misc",
              "displayName": "Customizing Object displays in the REPL"
            }
          ]
        }
      ],
      "classes": [
        {
          "textRaw": "Class: REPLServer",
          "type": "class",
          "name": "REPLServer",
          "meta": {
            "added": [
              "v0.1.91"
            ]
          },
          "desc": "
This inherits from Readline Interface with the following events:
\n",
          "events": [
            {
              "textRaw": "Event: 'exit'",
              "type": "event",
              "name": "exit",
              "meta": {
                "added": [
                  "v0.7.7"
                ]
              },
              "desc": "
function () {}
\n
Emitted when the user exits the REPL in any of the defined ways. Namely, typing\n.exit at the repl, pressing Ctrl+C twice to signal SIGINT, or pressing Ctrl+D\nto signal 'end' on the input stream.
\n
Example of listening for exit:
\n
replServer.on('exit', () => {\n  console.log('Got "exit" event from repl!');\n  process.exit();\n});\n
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'reset'",
              "type": "event",
              "name": "reset",
              "meta": {
                "added": [
                  "v0.11.0"
                ]
              },
              "desc": "
function (context) {}
\n
Emitted when the REPL's context is reset. This happens when you type .clear.\nIf you start the repl with { useGlobal: true } then this event will never\nbe emitted.
\n
Example of listening for reset:
\n
// Extend the initial repl context.\nvar replServer = repl.start({ options ... });\nsomeExtension.extend(r.context);\n\n// When a new context is created extend it as well.\nreplServer.on('reset', (context) => {\n  console.log('repl has a new context');\n  someExtension.extend(context);\n});\n
\n",
              "params": []
            }
          ],
          "methods": [
            {
              "textRaw": "replServer.defineCommand(keyword, cmd)",
              "type": "method",
              "name": "defineCommand",
              "meta": {
                "added": [
                  "v0.3.0"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`keyword` {String} ",
                      "name": "keyword",
                      "type": "String"
                    },
                    {
                      "textRaw": "`cmd` {Object|Function} ",
                      "name": "cmd",
                      "type": "Object|Function"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "keyword"
                    },
                    {
                      "name": "cmd"
                    }
                  ]
                }
              ],
              "desc": "
Makes a command available in the REPL. The command is invoked by typing a .\nfollowed by the keyword. The cmd is an object with the following values:
\n
    \n
  • help - help text to be displayed when .help is entered (Optional).
    • \n
  • action - a function to execute, potentially taking in a string argument,\nwhen the command is invoked, bound to the REPLServer instance (Required).
    • \n
\n
If a function is provided instead of an object for cmd, it is treated as the\naction.
\n
Example of defining a command:
\n
// repl_test.js\nconst repl = require('repl');\n\nvar replServer = repl.start();\nreplServer.defineCommand('sayhello', {\n  help: 'Say hello',\n  action: function(name) {\n    this.write(`Hello, ${name}!\\n`);\n    this.displayPrompt();\n  }\n});\n
\n
Example of invoking that command from the REPL:
\n
> .sayhello Node.js User\nHello, Node.js User!\n
"
            },
            {
              "textRaw": "replServer.displayPrompt([preserveCursor])",
              "type": "method",
              "name": "displayPrompt",
              "meta": {
                "added": [
                  "v0.1.91"
                ]
              },
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`preserveCursor` {Boolean} ",
                      "name": "preserveCursor",
                      "type": "Boolean",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "preserveCursor",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Like readline.prompt except also adding indents with ellipses when inside\nblocks. The preserveCursor argument is passed to readline.prompt. This is\nused primarily with defineCommand. It's also used internally to render each\nprompt line.
\n"
            }
          ]
        }
      ],
      "methods": [
        {
          "textRaw": "repl.start(options)",
          "type": "method",
          "name": "start",
          "desc": "
Returns and starts a REPLServer instance, that inherits from\nReadline Interface. Accepts an "options" Object that takes\nthe following values:
\n
    \n
  • prompt - the prompt and stream for all I/O. Defaults to >.
    \n
    • \n
  • input - the readable stream to listen to. Defaults to process.stdin.
    \n
    • \n
  • output - the writable stream to write readline data to. Defaults to\nprocess.stdout.
    \n
    • \n
  • terminal - pass true if the stream should be treated like a TTY, and\nhave ANSI/VT100 escape codes written to it. Defaults to checking isTTY\non the output stream upon instantiation.
    \n
    • \n
  • eval - function that will be used to eval each given line. Defaults to\nan async wrapper for eval(). See below for an example of a custom eval.
    \n
    • \n
  • useColors - a boolean which specifies whether or not the writer function\nshould output colors. If a different writer function is set then this does\nnothing. Defaults to the repl's terminal value.
    \n
    • \n
  • useGlobal - if set to true, then the repl will use the global object,\ninstead of running scripts in a separate context. Defaults to false.
    \n
    • \n
  • ignoreUndefined - if set to true, then the repl will not output the\nreturn value of command if it's undefined. Defaults to false.
    \n
    • \n
  • writer - the function to invoke for each command that gets evaluated which\nreturns the formatting (including coloring) to display. Defaults to\nutil.inspect.
    \n
    • \n
  • replMode - controls whether the repl runs all commands in strict mode,\ndefault mode, or a hybrid mode ("magic" mode.) Acceptable values are:
    \n
      \n
    • repl.REPL_MODE_SLOPPY - run commands in sloppy mode.
      • \n
    • repl.REPL_MODE_STRICT - run commands in strict mode. This is equivalent to\nprefacing every repl statement with 'use strict'.
      • \n
    • repl.REPL_MODE_MAGIC - attempt to run commands in default mode. If they\nfail to parse, re-try in strict mode.
      • \n
    \n
    • \n
\n
You can use your own eval function if it has following signature:
\n
function eval(cmd, context, filename, callback) {\n  callback(null, result);\n}\n
On tab completion, eval will be called with .scope as an input string. It\nis expected to return an array of scope names to be used for the auto-completion.
\n
Multiple REPLs may be started against the same running instance of Node.js.  Each\nwill share the same global object but will have unique I/O.
\n
Here is an example that starts a REPL on stdin, a Unix socket, and a TCP socket:
\n
const net = require('net');\nconst repl = require('repl');\nvar connections = 0;\n\nrepl.start({\n  prompt: 'Node.js via stdin> ',\n  input: process.stdin,\n  output: process.stdout\n});\n\nnet.createServer((socket) => {\n  connections += 1;\n  repl.start({\n    prompt: 'Node.js via Unix socket> ',\n    input: socket,\n    output: socket\n  }).on('exit', () => {\n    socket.end();\n  })\n}).listen('/tmp/node-repl-sock');\n\nnet.createServer((socket) => {\n  connections += 1;\n  repl.start({\n    prompt: 'Node.js via TCP socket> ',\n    input: socket,\n    output: socket\n  }).on('exit', () => {\n    socket.end();\n  });\n}).listen(5001);\n
\n
Running this program from the command line will start a REPL on stdin.  Other\nREPL clients may connect through the Unix socket or TCP socket. telnet is useful\nfor connecting to TCP sockets, and socat can be used to connect to both Unix and\nTCP sockets.
\n
By starting a REPL from a Unix socket-based server instead of stdin, you can\nconnect to a long-running Node.js process without restarting it.
\n
For an example of running a "full-featured" (terminal) REPL over\na net.Server and net.Socket instance, see: https://gist.github.com/2209310
\n
For an example of running a REPL instance over curl(1),\nsee: https://gist.github.com/2053342
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "options"
                }
              ]
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "REPL"
    }
  ]
}
node-v4.8.2/doc/api/repl.md000644 000766 000024 00000026026 13070706735 015570 0ustar00iojsstaff000000 000000 # REPL

> Stability: 2 - Stable

A Read-Eval-Print-Loop (REPL) is available both as a standalone program and
easily includable in other programs. The REPL provides a way to interactively
run JavaScript and see the results.  It can be used for debugging, testing, or
just trying things out.

By executing `node` without any arguments from the command-line you will be
dropped into the REPL. It has simplistic emacs line-editing.

```
$ node
Type '.help' for options.
> a = [1, 2, 3];
[ 1, 2, 3 ]
> a.forEach((v) => {
...   console.log(v);
...   });
1
2
3
```

For advanced line-editors, start Node.js with the environmental variable
`NODE_NO_READLINE=1`. This will start the main and debugger REPL in canonical
terminal settings which will allow you to use with `rlwrap`.

For example, you could add this to your bashrc file:

```
alias node="env NODE_NO_READLINE=1 rlwrap node"
```

## Environment Variable Options

The built-in repl (invoked by running `node` or `node -i`) may be controlled
via the following environment variables:

 - `NODE_REPL_HISTORY` - When a valid path is given, persistent REPL history
   will be saved to the specified file rather than `.node_repl_history` in the
   user's home directory. Setting this value to `""` will disable persistent
   REPL history. Whitespace will be trimmed from the value.
 - `NODE_REPL_HISTORY_SIZE` - Defaults to `1000`. Controls how many lines of
   history will be persisted if history is available. Must be a positive number.
 - `NODE_REPL_MODE` - May be any of `sloppy`, `strict`, or `magic`. Defaults
   to `magic`, which will automatically run "strict mode only" statements in
   strict mode.

## Persistent History

By default, the REPL will persist history between `node` REPL sessions by saving
to a `.node_repl_history` file in the user's home directory. This can be
disabled by setting the environment variable `NODE_REPL_HISTORY=""`.

### NODE_REPL_HISTORY_FILE

> Stability: 0 - Deprecated: Use `NODE_REPL_HISTORY` instead.

Previously in Node.js/io.js v2.x, REPL history was controlled by using a
`NODE_REPL_HISTORY_FILE` environment variable, and the history was saved in JSON
format. This variable has now been deprecated, and your REPL history will
automatically be converted to using plain text. The new file will be saved to
either your home directory, or a directory defined by the `NODE_REPL_HISTORY`
variable, as documented [here](#repl_environment_variable_options).

## REPL Features



Inside the REPL, Control+D will exit.  Multi-line expressions can be input.
Tab completion is supported for both global and local variables.

Core modules will be loaded on-demand into the environment. For example,
accessing `fs` will `require()` the `fs` module as `global.fs`.

The special variable `_` (underscore) contains the result of the last expression.

```
> [ 'a', 'b', 'c' ]
[ 'a', 'b', 'c' ]
> _.length
3
> _ += 1
4
```

The REPL provides access to any variables in the global scope. You can expose
a variable to the REPL explicitly by assigning it to the `context` object
associated with each `REPLServer`.  For example:

```js
// repl_test.js
const repl = require('repl');
var msg = 'message';

repl.start('> ').context.m = msg;
```

Things in the `context` object appear as local within the REPL:

```
$ node repl_test.js
> m
'message'
```

There are a few special REPL commands:

  - `.break` - While inputting a multi-line expression, sometimes you get lost
    or just don't care about completing it. `.break` will start over.
  - `.clear` - Resets the `context` object to an empty object and clears any
    multi-line expression.
  - `.exit` - Close the I/O stream, which will cause the REPL to exit.
  - `.help` - Show this list of special commands.
  - `.save` - Save the current REPL session to a file
    >.save ./file/to/save.js
  - `.load` - Load a file into the current REPL session.
    >.load ./file/to/load.js

The following key combinations in the REPL have these special effects:

  - `C` - Similar to the `.break` keyword.  Terminates the current
    command.  Press twice on a blank line to forcibly exit.
  - `D` - Similar to the `.exit` keyword.
  - `` - Show both global and local(scope) variables


### Customizing Object displays in the REPL

The REPL module internally uses
[`util.inspect()`][], when printing values. However, `util.inspect` delegates the
 call to the object's `inspect()` function, if it has one. You can read more
 about this delegation [here][].

For example, if you have defined an `inspect()` function on an object, like this:

```
> var obj = {foo: 'this will not show up in the inspect() output'};
undefined
> obj.inspect = () => {
...   return {bar: 'baz'};
... };
[Function]
```

and try to print `obj` in REPL, it will invoke the custom `inspect()` function:

```
> obj
{bar: 'baz'}
```

## Class: REPLServer


This inherits from [Readline Interface][] with the following events:

### Event: 'exit'


`function () {}`

Emitted when the user exits the REPL in any of the defined ways. Namely, typing
`.exit` at the repl, pressing Ctrl+C twice to signal `SIGINT`, or pressing Ctrl+D
to signal `'end'` on the `input` stream.

Example of listening for `exit`:

```js
replServer.on('exit', () => {
  console.log('Got "exit" event from repl!');
  process.exit();
});
```


### Event: 'reset'


`function (context) {}`

Emitted when the REPL's context is reset. This happens when you type `.clear`.
If you start the repl with `{ useGlobal: true }` then this event will never
be emitted.

Example of listening for `reset`:

```js
// Extend the initial repl context.
var replServer = repl.start({ options ... });
someExtension.extend(r.context);

// When a new context is created extend it as well.
replServer.on('reset', (context) => {
  console.log('repl has a new context');
  someExtension.extend(context);
});
```

### replServer.defineCommand(keyword, cmd)


* `keyword` {String}
* `cmd` {Object|Function}

Makes a command available in the REPL. The command is invoked by typing a `.`
followed by the keyword. The `cmd` is an object with the following values:

 - `help` - help text to be displayed when `.help` is entered (Optional).
 - `action` - a function to execute, potentially taking in a string argument,
   when the command is invoked, bound to the REPLServer instance (Required).

If a function is provided instead of an object for `cmd`, it is treated as the
`action`.

Example of defining a command:

```js
// repl_test.js
const repl = require('repl');

var replServer = repl.start();
replServer.defineCommand('sayhello', {
  help: 'Say hello',
  action: function(name) {
    this.write(`Hello, ${name}!\n`);
    this.displayPrompt();
  }
});
```

Example of invoking that command from the REPL:

```
> .sayhello Node.js User
Hello, Node.js User!
```

### replServer.displayPrompt([preserveCursor])


* `preserveCursor` {Boolean}

Like [`readline.prompt`][] except also adding indents with ellipses when inside
blocks. The `preserveCursor` argument is passed to [`readline.prompt`][]. This is
used primarily with `defineCommand`. It's also used internally to render each
prompt line.

## repl.start(options)

Returns and starts a `REPLServer` instance, that inherits from
[Readline Interface][]. Accepts an "options" Object that takes
the following values:

 - `prompt` - the prompt and `stream` for all I/O. Defaults to `> `.

 - `input` - the readable stream to listen to. Defaults to `process.stdin`.

 - `output` - the writable stream to write readline data to. Defaults to
   `process.stdout`.

 - `terminal` - pass `true` if the `stream` should be treated like a TTY, and
   have ANSI/VT100 escape codes written to it. Defaults to checking `isTTY`
   on the `output` stream upon instantiation.

 - `eval` - function that will be used to eval each given line. Defaults to
   an async wrapper for `eval()`. See below for an example of a custom `eval`.

 - `useColors` - a boolean which specifies whether or not the `writer` function
   should output colors. If a different `writer` function is set then this does
   nothing. Defaults to the repl's `terminal` value.

 - `useGlobal` - if set to `true`, then the repl will use the `global` object,
   instead of running scripts in a separate context. Defaults to `false`.

 - `ignoreUndefined` - if set to `true`, then the repl will not output the
   return value of command if it's `undefined`. Defaults to `false`.

 - `writer` - the function to invoke for each command that gets evaluated which
   returns the formatting (including coloring) to display. Defaults to
   `util.inspect`.

 - `replMode` - controls whether the repl runs all commands in strict mode,
   default mode, or a hybrid mode ("magic" mode.) Acceptable values are:
  * `repl.REPL_MODE_SLOPPY` - run commands in sloppy mode.
  * `repl.REPL_MODE_STRICT` - run commands in strict mode. This is equivalent to
  prefacing every repl statement with `'use strict'`.
  * `repl.REPL_MODE_MAGIC` - attempt to run commands in default mode. If they
  fail to parse, re-try in strict mode.

You can use your own `eval` function if it has following signature:

    function eval(cmd, context, filename, callback) {
      callback(null, result);
    }

On tab completion, `eval` will be called with `.scope` as an input string. It
is expected to return an array of scope names to be used for the auto-completion.

Multiple REPLs may be started against the same running instance of Node.js.  Each
will share the same global object but will have unique I/O.

Here is an example that starts a REPL on stdin, a Unix socket, and a TCP socket:

```js
const net = require('net');
const repl = require('repl');
var connections = 0;

repl.start({
  prompt: 'Node.js via stdin> ',
  input: process.stdin,
  output: process.stdout
});

net.createServer((socket) => {
  connections += 1;
  repl.start({
    prompt: 'Node.js via Unix socket> ',
    input: socket,
    output: socket
  }).on('exit', () => {
    socket.end();
  })
}).listen('/tmp/node-repl-sock');

net.createServer((socket) => {
  connections += 1;
  repl.start({
    prompt: 'Node.js via TCP socket> ',
    input: socket,
    output: socket
  }).on('exit', () => {
    socket.end();
  });
}).listen(5001);
```

Running this program from the command line will start a REPL on stdin.  Other
REPL clients may connect through the Unix socket or TCP socket. `telnet` is useful
for connecting to TCP sockets, and `socat` can be used to connect to both Unix and
TCP sockets.

By starting a REPL from a Unix socket-based server instead of stdin, you can
connect to a long-running Node.js process without restarting it.

For an example of running a "full-featured" (`terminal`) REPL over
a `net.Server` and `net.Socket` instance, see: https://gist.github.com/2209310

For an example of running a REPL instance over curl(1),
see: https://gist.github.com/2053342

[`readline.prompt`]: readline.html#readline_rl_prompt_preservecursor
[`util.inspect()`]: util.html#util_util_inspect_object_options
[here]: util.html#util_custom_inspect_function_on_objects
[Readline Interface]: readline.html#readline_class_interface
node-v4.8.2/doc/api/stream.html000644 000766 000024 00000272656 13070706740 016475 0ustar00iojsstaff000000 000000 


  
  Stream | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

      

        
Stream#


Stability: 2 - Stable
A stream is an abstract interface implemented by various objects in
Node.js. For example a request to an HTTP server is a
stream, as is process.stdout. Streams are readable, writable, or both. All
streams are instances of EventEmitter.


You can load the Stream base classes by doing require('stream').
There are base classes provided for Readable streams, Writable
streams, Duplex streams, and Transform streams.


This document is split up into 3 sections:


    

  1. The first section explains the parts of the API that you need to be
aware of to use streams in your programs.
    2. 

  2. The second section explains the parts of the API that you need to
use if you implement your own custom streams yourself. The API is designed to
make this easy for you to do.
    3. 

  3. The third section goes into more depth about how streams work,
including some of the internal mechanisms and functions that you
should probably not modify unless you definitely know what you are
doing.
    4. 



API for Stream Consumers#



Streams can be either Readable, Writable, or both (Duplex).


All streams are EventEmitters, but they also have other custom methods
and properties depending on whether they are Readable, Writable, or
Duplex.


If a stream is both Readable and Writable, then it implements all of
the methods and events. So, a Duplex or Transform stream is
fully described by this API, though their implementation may be
somewhat different.


It is not necessary to implement Stream interfaces in order to consume
streams in your programs. If you are implementing streaming
interfaces in your own program, please also refer to
API for Stream Implementors.


Almost all Node.js programs, no matter how simple, use Streams in some
way. Here is an example of using Streams in an Node.js program:


const http = require('http');

var server = http.createServer( (req, res) => {
  // req is an http.IncomingMessage, which is a Readable Stream
  // res is an http.ServerResponse, which is a Writable Stream

  var body = '';
  // we want to get the data as utf8 strings
  // If you don't set an encoding, then you'll get Buffer objects
  req.setEncoding('utf8');

  // Readable streams emit 'data' events once a listener is added
  req.on('data', (chunk) => {
    body += chunk;
  });

  // the end event tells you that you have entire body
  req.on('end', () => {
    try {
      const data = JSON.parse(body);
      // write back something interesting to the user:
      res.write(typeof data);
      res.end();
    } catch (er) {
      // uh oh!  bad json!
      res.statusCode = 400;
      return res.end(`error: ${er.message}`);
    }
  });
});

server.listen(1337);

// $ curl localhost:1337 -d '{}'
// object
// $ curl localhost:1337 -d '"foo"'
// string
// $ curl localhost:1337 -d 'not json'
// error: Unexpected token o



Class: stream.Duplex#


Duplex streams are streams that implement both the Readable and
Writable interfaces.


Examples of Duplex streams include:



Class: stream.Readable#



The Readable stream interface is the abstraction for a source of
data that you are reading from. In other words, data comes out of a
Readable stream.


A Readable stream will not start emitting data until you indicate that
you are ready to receive it.


Readable streams have two "modes": a flowing mode and a paused
mode. When in flowing mode, data is read from the underlying system
and provided to your program as fast as possible. In paused mode, you
must explicitly call stream.read() to get chunks of data out.
Streams start out in paused mode.


Note: If no data event handlers are attached, and there are no
stream.pipe() destinations, and the stream is switched into flowing
mode, then data will be lost.


You can switch to flowing mode by doing any of the following:



You can switch back to paused mode by doing either of the following:


    

  • If there are no pipe destinations, by calling the
stream.pause() method.
    • 

  • If there are pipe destinations, by removing any 'data' event
handlers, and removing all pipe destinations by calling the
stream.unpipe() method.
    • 



Note that, for backwards compatibility reasons, removing 'data'
event handlers will not automatically pause the stream. Also, if
there are piped destinations, then calling stream.pause() will
not guarantee that the stream will remain paused once those
destinations drain and ask for more data.


Examples of readable streams include:



Event: 'close'#


Emitted when the stream and any of its underlying resources (a file
descriptor, for example) have been closed. The event indicates that
no more events will be emitted, and no further computation will occur.


Not all streams will emit the 'close' event as the 'close' event is
optional.


Event: 'data'#




Attaching a 'data' event listener to a stream that has not been
explicitly paused will switch the stream into flowing mode. Data will
then be passed as soon as it is available.


If you just want to get all the data out of the stream as fast as
possible, this is the best way to do so.


var readable = getReadableStreamSomehow();
readable.on('data', (chunk) => {
  console.log('got %d bytes of data', chunk.length);
});



Event: 'end'#


This event fires when there will be no more data to read.


Note that the 'end' event will not fire unless the data is
completely consumed. This can be done by switching into flowing mode,
or by calling stream.read() repeatedly until you get to the
end.


var readable = getReadableStreamSomehow();
readable.on('data', (chunk) => {
  console.log('got %d bytes of data', chunk.length);
});
readable.on('end', () => {
  console.log('there will be no more data.');
});



Event: 'error'#




Emitted if there was an error receiving data.


Event: 'readable'#


When a chunk of data can be read from the stream, it will emit a
'readable' event.


In some cases, listening for a 'readable' event will cause some data
to be read into the internal buffer from the underlying system, if it
hadn't already.


var readable = getReadableStreamSomehow();
readable.on('readable', () => {
  // there is some data to read now
});



Once the internal buffer is drained, a 'readable' event will fire
again when more data is available.


The 'readable' event is not emitted in the "flowing" mode with the
sole exception of the last one, on end-of-stream.


The 'readable' event indicates that the stream has new information:
either new data is available or the end of the stream has been reached.
In the former case, stream.read() will return that data. In the
latter case, stream.read() will return null. For instance, in
the following example, foo.txt is an empty file:


const fs = require('fs');
var rr = fs.createReadStream('foo.txt');
rr.on('readable', () => {
  console.log('readable:', rr.read());
});
rr.on('end', () => {
  console.log('end');
});



The output of running this script is:


$ node test.js
readable: null
end

readable.isPaused()#




This method returns whether or not the readable has been explicitly
paused by client code (using stream.pause() without a
corresponding stream.resume()).


var readable = new stream.Readable

readable.isPaused() // === false
readable.pause()
readable.isPaused() // === true
readable.resume()
readable.isPaused() // === false



readable.pause()#


    

  • Returns: this
    • 



This method will cause a stream in flowing mode to stop emitting
'data' events, switching out of flowing mode. Any data that becomes
available will remain in the internal buffer.


var readable = getReadableStreamSomehow();
readable.on('data', (chunk) => {
  console.log('got %d bytes of data', chunk.length);
  readable.pause();
  console.log('there will be no more data for 1 second');
  setTimeout(() => {
    console.log('now data will start flowing again');
    readable.resume();
  }, 1000);
});



readable.pipe(destination[, options])#




This method pulls all the data out of a readable stream, and writes it
to the supplied destination, automatically managing the flow so that
the destination is not overwhelmed by a fast readable stream.


Multiple destinations can be piped to safely.


var readable = getReadableStreamSomehow();
var writable = fs.createWriteStream('file.txt');
// All the data from readable goes into 'file.txt'
readable.pipe(writable);



This function returns the destination stream, so you can set up pipe
chains like so:


var r = fs.createReadStream('file.txt');
var z = zlib.createGzip();
var w = fs.createWriteStream('file.txt.gz');
r.pipe(z).pipe(w);



For example, emulating the Unix cat command:


process.stdin.pipe(process.stdout);



By default stream.end() is called on the destination when the
source stream emits 'end', so that destination is no longer writable.
Pass { end: false } as options to keep the destination stream open.


This keeps writer open so that "Goodbye" can be written at the
end.


reader.pipe(writer, { end: false });
reader.on('end', () => {
  writer.end('Goodbye\n');
});



Note that process.stderr and process.stdout are never closed until
the process exits, regardless of the specified options.


readable.read([size])#




The read() method pulls some data out of the internal buffer and
returns it. If there is no data available, then it will return
null.


If you pass in a size argument, then it will return that many
bytes. If size bytes are not available, then it will return null,
unless we've ended, in which case it will return the data remaining
in the buffer.


If you do not specify a size argument, then it will return all the
data in the internal buffer.


This method should only be called in paused mode. In flowing mode,
this method is called automatically until the internal buffer is
drained.


var readable = getReadableStreamSomehow();
readable.on('readable', () => {
  var chunk;
  while (null !== (chunk = readable.read())) {
    console.log('got %d bytes of data', chunk.length);
  }
});



If this method returns a data chunk, then it will also trigger the
emission of a 'data' event.


Note that calling stream.read([size]) after the 'end'
event has been triggered will return null. No runtime error will be raised.


readable.resume()#


    

  • Returns: this
    • 



This method will cause the readable stream to resume emitting 'data'
events.


This method will switch the stream into flowing mode. If you do not
want to consume the data from a stream, but you do want to get to
its 'end' event, you can call stream.resume() to open
the flow of data.


var readable = getReadableStreamSomehow();
readable.resume();
readable.on('end', () => {
  console.log('got to the end, but did not read anything');
});



readable.setEncoding(encoding)#


    

  • encoding <String> The encoding to use.
    • 

  • Returns: this
    • 



Call this function to cause the stream to return strings of the specified
encoding instead of Buffer objects. For example, if you do
readable.setEncoding('utf8'), then the output data will be interpreted as
UTF-8 data, and returned as strings. If you do readable.setEncoding('hex'),
then the data will be encoded in hexadecimal string format.


This properly handles multi-byte characters that would otherwise be
potentially mangled if you simply pulled the Buffers directly and
called buf.toString(encoding) on them. If you want to read the data
as strings, always use this method.


Also you can disable any encoding at all with readable.setEncoding(null).
This approach is very useful if you deal with binary data or with large
multi-byte strings spread out over multiple chunks.


var readable = getReadableStreamSomehow();
readable.setEncoding('utf8');
readable.on('data', (chunk) => {
  assert.equal(typeof chunk, 'string');
  console.log('got %d characters of string data', chunk.length);
});



readable.unpipe([destination])#




This method will remove the hooks set up for a previous stream.pipe()
call.


If the destination is not specified, then all pipes are removed.


If the destination is specified, but no pipe is set up for it, then
this is a no-op.


var readable = getReadableStreamSomehow();
var writable = fs.createWriteStream('file.txt');
// All the data from readable goes into 'file.txt',
// but only for the first second
readable.pipe(writable);
setTimeout(() => {
  console.log('stop writing to file.txt');
  readable.unpipe(writable);
  console.log('manually close the file stream');
  writable.end();
}, 1000);



readable.unshift(chunk)#




This is useful in certain cases where a stream is being consumed by a
parser, which needs to "un-consume" some data that it has
optimistically pulled out of the source, so that the stream can be
passed on to some other party.


Note that stream.unshift(chunk) cannot be called after the 'end' event
has been triggered; a runtime error will be raised.


If you find that you must often call stream.unshift(chunk) in your
programs, consider implementing a Transform stream instead. (See API
for Stream Implementors.)


// Pull off a header delimited by \n\n
// use unshift() if we get too much
// Call the callback with (error, header, stream)
const StringDecoder = require('string_decoder').StringDecoder;
function parseHeader(stream, callback) {
  stream.on('error', callback);
  stream.on('readable', onReadable);
  var decoder = new StringDecoder('utf8');
  var header = '';
  function onReadable() {
    var chunk;
    while (null !== (chunk = stream.read())) {
      var str = decoder.write(chunk);
      if (str.match(/\n\n/)) {
        // found the header boundary
        var split = str.split(/\n\n/);
        header += split.shift();
        var remaining = split.join('\n\n');
        var buf = new Buffer(remaining, 'utf8');
        if (buf.length)
          stream.unshift(buf);
        stream.removeListener('error', callback);
        stream.removeListener('readable', onReadable);
        // now the body of the message can be read from the stream.
        callback(null, header, stream);
      } else {
        // still reading the header.
        header += str;
      }
    }
  }
}



Note that, unlike stream.push(chunk), stream.unshift(chunk)
will not end the reading process by resetting the internal reading state of the
stream. This can cause unexpected results if unshift() is called during a
read (i.e. from within a stream._read() implementation on a
custom stream). Following the call to unshift() with an immediate
stream.push('') will reset the reading state appropriately,
however it is best to simply avoid calling unshift() while in the process of
performing a read.


readable.wrap(stream)#


    

  • stream <Stream> An "old style" readable stream
    • 



Versions of Node.js prior to v0.10 had streams that did not implement the
entire Streams API as it is today. (See Compatibility for
more information.)


If you are using an older Node.js library that emits 'data' events and
has a stream.pause() method that is advisory only, then you
can use the wrap() method to create a Readable stream that uses the old
stream as its data source.


You will very rarely ever need to call this function, but it exists
as a convenience for interacting with old Node.js programs and libraries.


For example:


const OldReader = require('./old-api-module.js').OldReader;
const Readable = require('stream').Readable;
const oreader = new OldReader;
const myReader = new Readable().wrap(oreader);

myReader.on('readable', () => {
  myReader.read(); // etc.
});



Class: stream.Transform#


Transform streams are Duplex streams where the output is in some way
computed from the input. They implement both the Readable and
Writable interfaces.


Examples of Transform streams include:



Class: stream.Writable#



The Writable stream interface is an abstraction for a destination
that you are writing data to.


Examples of writable streams include:



Event: 'close'#


Emitted when the stream and any of its underlying resources (a file descriptor,
for example) have been closed. The event indicates that no more events will be
emitted, and no further computation will occur.


Not all streams will emit the 'close' event as the 'close' event is
optional.


Event: 'drain'#


If a stream.write(chunk) call returns false, then the
'drain' event will indicate when it is appropriate to begin writing more data
to the stream.


// Write the data to the supplied writable stream one million times.
// Be attentive to back-pressure.
function writeOneMillionTimes(writer, data, encoding, callback) {
  var i = 1000000;
  write();
  function write() {
    var ok = true;
    do {
      i -= 1;
      if (i === 0) {
        // last time!
        writer.write(data, encoding, callback);
      } else {
        // see if we should continue, or wait
        // don't pass the callback, because we're not done yet.
        ok = writer.write(data, encoding);
      }
    } while (i > 0 && ok);
    if (i > 0) {
      // had to stop early!
      // write some more once it drains
      writer.once('drain', write);
    }
  }
}



Event: 'error'#




Emitted if there was an error when writing or piping data.


Event: 'finish'#


When the stream.end() method has been called, and all data has
been flushed to the underlying system, this event is emitted.


var writer = getWritableStreamSomehow();
for (var i = 0; i < 100; i ++) {
  writer.write('hello, #${i}!\n');
}
writer.end('this is the end\n');
writer.on('finish', () => {
  console.error('all writes are now complete.');
});



Event: 'pipe'#




This is emitted whenever the stream.pipe() method is called on a readable
stream, adding this writable to its set of destinations.


var writer = getWritableStreamSomehow();
var reader = getReadableStreamSomehow();
writer.on('pipe', (src) => {
  console.error('something is piping into the writer');
  assert.equal(src, reader);
});
reader.pipe(writer);



Event: 'unpipe'#




This is emitted whenever the stream.unpipe() method is called on a
readable stream, removing this writable from its set of destinations.


var writer = getWritableStreamSomehow();
var reader = getReadableStreamSomehow();
writer.on('unpipe', (src) => {
  console.error('something has stopped piping into the writer');
  assert.equal(src, reader);
});
reader.pipe(writer);
reader.unpipe(writer);



writable.cork()#


Forces buffering of all writes.


Buffered data will be flushed either at stream.uncork() or at
stream.end() call.


writable.end([chunk][, encoding][, callback])#


    

  • chunk <String> | <Buffer> Optional data to write
    • 

  • encoding <String> The encoding, if chunk is a String
    • 

  • callback <Function> Optional callback for when the stream is finished
    • 



Call this method when no more data will be written to the stream. If supplied,
the callback is attached as a listener on the 'finish' event.


Calling stream.write() after calling
stream.end() will raise an error.


// write 'hello, ' and then end with 'world!'
var file = fs.createWriteStream('example.txt');
file.write('hello, ');
file.end('world!');
// writing more now is not allowed!



writable.setDefaultEncoding(encoding)#


    

  • encoding <String> The new default encoding
    • 



Sets the default encoding for a writable stream.


writable.uncork()#


Flush all data, buffered since stream.cork() call.


writable.write(chunk[, encoding][, callback])#


    

  • chunk <String> | <Buffer> The data to write
    • 

  • encoding <String> The encoding, if chunk is a String
    • 

  • callback <Function> Callback for when this chunk of data is flushed
    • 

  • Returns: <Boolean> true if the data was handled completely.
    • 



This method writes some data to the underlying system, and calls the
supplied callback once the data has been fully handled.  If an error
occurs, the callback may or may not be called with the error as its
first argument.  To detect write errors, listen for the 'error' event.


The return value indicates if you should continue writing right now.
If the data had to be buffered internally, then it will return
false. Otherwise, it will return true.


This return value is strictly advisory. You MAY continue to write,
even if it returns false. However, writes will be buffered in
memory, so it is best not to do this excessively. Instead, wait for
the 'drain' event before writing more data.


API for Stream Implementors#



To implement any sort of stream, the pattern is the same:


    

  1. Extend the appropriate parent class in your own subclass. (The
util.inherits() method is particularly helpful for this.)
    2. 

  2. Call the appropriate parent class constructor in your constructor,
to be sure that the internal mechanisms are set up properly.
    3. 

  3. Implement one or more specific methods, as detailed below.
    4. 



The class to extend and the method(s) to implement depend on the sort
of stream class you are writing:



  
    

      
        
Use-case

      		
      
        
Class

      		
      
        
Method(s) to implement

      		
    

  
  

    
      
Reading only

    		
    
      
Readable

    		
    
      
_read

    		
  

  

    
      
Writing only

    		
    
      
Writable

    		
    
      
_write, _writev

    		
  

  

    
      
Reading and writing

    		
    
      
Duplex

    		
    
      
_read, _write, _writev

    		
  

  

    
      
Operate on written data, then read the result

    		
    
      
Transform

    		
    
      
_transform, _flush

    		
  





In your implementation code, it is very important to never call the methods
described in API for Stream Consumers. Otherwise, you can potentially cause
adverse side effects in programs that consume your streaming interfaces.


Class: stream.Duplex#



A "duplex" stream is one that is both Readable and Writable, such as a TCP
socket connection.


Note that stream.Duplex is an abstract class designed to be extended
with an underlying implementation of the stream._read(size)
and stream._write(chunk, encoding, callback) methods as you
would with a Readable or Writable stream class.


Since JavaScript doesn't have multiple prototypal inheritance, this class
prototypally inherits from Readable, and then parasitically from Writable. It is
thus up to the user to implement both the low-level
stream._read(n) method as well as the low-level
stream._write(chunk, encoding, callback) method on extension
duplex classes.


new stream.Duplex(options)#


    

  • options <Object> Passed to both Writable and Readable
constructors. Also has the following fields:
      

    • allowHalfOpen <Boolean> Default = true. If set to false, then
the stream will automatically end the readable side when the
writable side ends and vice versa.
      • 

    • readableObjectMode <Boolean> Default = false. Sets objectMode
for readable side of the stream. Has no effect if objectMode
is true.
      • 

    • writableObjectMode <Boolean> Default = false. Sets objectMode
for writable side of the stream. Has no effect if objectMode
is true.
      • 

    

    • 



In classes that extend the Duplex class, make sure to call the
constructor so that the buffering settings can be properly
initialized.


Class: stream.PassThrough#


This is a trivial implementation of a Transform stream that simply
passes the input bytes across to the output. Its purpose is mainly
for examples and testing, but there are occasionally use cases where
it can come in handy as a building block for novel sorts of streams.


Class: stream.Readable#



stream.Readable is an abstract class designed to be extended with an
underlying implementation of the stream._read(size) method.


Please see API for Stream Consumers for how to consume
streams in your programs. What follows is an explanation of how to
implement Readable streams in your programs.


new stream.Readable([options])#


    

  • options <Object>
      

    • highWaterMark <Number> The maximum number of bytes to store in
the internal buffer before ceasing to read from the underlying
resource. Default = 16384 (16kb), or 16 for objectMode streams
      • 

    • encoding <String> If specified, then buffers will be decoded to
strings using the specified encoding. Default = null
      • 

    • objectMode <Boolean> Whether this stream should behave
as a stream of objects. Meaning that stream.read(n) returns
a single value instead of a Buffer of size n. Default = false
      • 

    • read <Function> Implementation for the stream._read()
method.
      • 

    

    • 



In classes that extend the Readable class, make sure to call the
Readable constructor so that the buffering settings can be properly
initialized.


readable._read(size)#


    

  • size <Number> Number of bytes to read asynchronously
    • 



Note: Implement this method, but do NOT call it directly.


This method is prefixed with an underscore because it is internal to the
class that defines it and should only be called by the internal Readable
class methods. All Readable stream implementations must provide a _read
method to fetch data from the underlying resource.


When _read() is called, if data is available from the resource, the _read()
implementation should start pushing that data into the read queue by calling
this.push(dataChunk). _read() should continue reading from
the resource and pushing data until push returns false, at which point it
should stop reading from the resource. Only when _read() is called again after
it has stopped should it start reading more data from the resource and pushing
that data onto the queue.


Note: once the _read() method is called, it will not be called again until
the stream.push() method is called.


The size argument is advisory. Implementations where a "read" is a
single call that returns data can use this to know how much data to
fetch. Implementations where that is not relevant, such as TCP or
TLS, may ignore this argument, and simply provide data whenever it
becomes available. There is no need, for example to "wait" until
size bytes are available before calling stream.push(chunk).


readable.push(chunk[, encoding])#


    

  • chunk <Buffer> | <Null> | <String> Chunk of data to push into the read queue
    • 

  • encoding <String> Encoding of String chunks.  Must be a valid
Buffer encoding, such as 'utf8' or 'ascii'
    • 

  • return <Boolean> Whether or not more pushes should be performed
    • 



Note: This method should be called by Readable implementors, NOT
by consumers of Readable streams.


If a value other than null is passed, The push() method adds a chunk of data
into the queue for subsequent stream processors to consume. If null is
passed, it signals the end of the stream (EOF), after which no more data
can be written.


The data added with push() can be pulled out by calling the
stream.read() method when the 'readable' event fires.


This API is designed to be as flexible as possible. For example,
you may be wrapping a lower-level source which has some sort of
pause/resume mechanism, and a data callback. In those cases, you
could wrap the low-level source object by doing something like this:


// source is an object with readStop() and readStart() methods,
// and an `ondata` member that gets called when it has data, and
// an `onend` member that gets called when the data is over.

util.inherits(SourceWrapper, Readable);

function SourceWrapper(options) {
  Readable.call(this, options);

  this._source = getLowlevelSourceObject();

  // Every time there's data, we push it into the internal buffer.
  this._source.ondata = (chunk) => {
    // if push() returns false, then we need to stop reading from source
    if (!this.push(chunk))
      this._source.readStop();
  };

  // When the source ends, we push the EOF-signaling `null` chunk
  this._source.onend = () => {
    this.push(null);
  };
}

// _read will be called when the stream wants to pull more data in
// the advisory size argument is ignored in this case.
SourceWrapper.prototype._read = function(size) {
  this._source.readStart();
};



Example: A Counting Stream#



This is a basic example of a Readable stream. It emits the numerals
from 1 to 1,000,000 in ascending order, and then ends.


const Readable = require('stream').Readable;
const util = require('util');
util.inherits(Counter, Readable);

function Counter(opt) {
  Readable.call(this, opt);
  this._max = 1000000;
  this._index = 1;
}

Counter.prototype._read = function() {
  var i = this._index++;
  if (i > this._max)
    this.push(null);
  else {
    var str = '' + i;
    var buf = new Buffer(str, 'ascii');
    this.push(buf);
  }
};



Example: SimpleProtocol v1 (Sub-optimal)#


This is similar to the parseHeader function described
here, but implemented as a custom stream.
Also, note that this implementation does not convert the incoming data to a
string.


However, this would be better implemented as a Transform stream. See
SimpleProtocol v2 for a better implementation.


// A parser for a simple data protocol.
// The "header" is a JSON object, followed by 2 \n characters, and
// then a message body.
//
// NOTE: This can be done more simply as a Transform stream!
// Using Readable directly for this is sub-optimal. See the
// alternative example below under the Transform section.

const Readable = require('stream').Readable;
const util = require('util');

util.inherits(SimpleProtocol, Readable);

function SimpleProtocol(source, options) {
  if (!(this instanceof SimpleProtocol))
    return new SimpleProtocol(source, options);

  Readable.call(this, options);
  this._inBody = false;
  this._sawFirstCr = false;

  // source is a readable stream, such as a socket or file
  this._source = source;

  source.on('end', () => {
    this.push(null);
  });

  // give it a kick whenever the source is readable
  // read(0) will not consume any bytes
  source.on('readable', () => {
    this.read(0);
  });

  this._rawHeader = [];
  this.header = null;
}

SimpleProtocol.prototype._read = function(n) {
  if (!this._inBody) {
    var chunk = this._source.read();

    // if the source doesn't have data, we don't have data yet.
    if (chunk === null)
      return this.push('');

    // check if the chunk has a \n\n
    var split = -1;
    for (var i = 0; i < chunk.length; i++) {
      if (chunk[i] === 10) { // '\n'
        if (this._sawFirstCr) {
          split = i;
          break;
        } else {
          this._sawFirstCr = true;
        }
      } else {
        this._sawFirstCr = false;
      }
    }

    if (split === -1) {
      // still waiting for the \n\n
      // stash the chunk, and try again.
      this._rawHeader.push(chunk);
      this.push('');
    } else {
      this._inBody = true;
      var h = chunk.slice(0, split);
      this._rawHeader.push(h);
      var header = Buffer.concat(this._rawHeader).toString();
      try {
        this.header = JSON.parse(header);
      } catch (er) {
        this.emit('error', new Error('invalid simple protocol data'));
        return;
      }
      // now, because we got some extra data, unshift the rest
      // back into the read queue so that our consumer will see it.
      var b = chunk.slice(split);
      this.unshift(b);
      // calling unshift by itself does not reset the reading state
      // of the stream; since we're inside _read, doing an additional
      // push('') will reset the state appropriately.
      this.push('');

      // and let them know that we are done parsing the header.
      this.emit('header', this.header);
    }
  } else {
    // from there on, just provide the data to our consumer.
    // careful not to push(null), since that would indicate EOF.
    var chunk = this._source.read();
    if (chunk) this.push(chunk);
  }
};

// Usage:
// var parser = new SimpleProtocol(source);
// Now parser is a readable stream that will emit 'header'
// with the parsed header data.



Class: stream.Transform#


A "transform" stream is a duplex stream where the output is causally
connected in some way to the input, such as a zlib stream or a
crypto stream.


There is no requirement that the output be the same size as the input,
the same number of chunks, or arrive at the same time. For example, a
Hash stream will only ever have a single chunk of output which is
provided when the input is ended. A zlib stream will produce output
that is either much smaller or much larger than its input.


Rather than implement the stream._read() and
stream._write() methods, Transform classes must implement the
stream._transform() method, and may optionally
also implement the stream._flush() method. (See below.)


new stream.Transform([options])#




In classes that extend the Transform class, make sure to call the
constructor so that the buffering settings can be properly
initialized.


Events: 'finish' and 'end'#


The 'finish' and 'end' events are from the parent Writable
and Readable classes respectively. The 'finish' event is fired after
stream.end() is called and all chunks have been processed by
stream._transform(), 'end' is fired after all data has
been output which is after the callback in stream._flush()
has been called.


transform._flush(callback)#


    

  • callback <Function> Call this function (optionally with an error
argument) when you are done flushing any remaining data.
    • 



Note: This function MUST NOT be called directly.  It MAY be implemented
by child classes, and if so, will be called by the internal Transform
class methods only.


In some cases, your transform operation may need to emit a bit more
data at the end of the stream. For example, a Zlib compression
stream will store up some internal state so that it can optimally
compress the output. At the end, however, it needs to do the best it
can with what is left, so that the data will be complete.


In those cases, you can implement a _flush() method, which will be
called at the very end, after all the written data is consumed, but
before emitting 'end' to signal the end of the readable side. Just
like with stream._transform(), call
transform.push(chunk) zero or more times, as appropriate, and call callback
when the flush operation is complete.


This method is prefixed with an underscore because it is internal to
the class that defines it, and should not be called directly by user
programs. However, you are expected to override this method in
your own extension classes.


transform._transform(chunk, encoding, callback)#


    

  • chunk <Buffer> | <String> The chunk to be transformed. Will always
be a buffer unless the decodeStrings option was set to false.
    • 

  • encoding <String> If the chunk is a string, then this is the
encoding type. If chunk is a buffer, then this is the special
value - 'buffer', ignore it in this case.
    • 

  • callback <Function> Call this function (optionally with an error
argument and data) when you are done processing the supplied chunk.
    • 



Note: This function MUST NOT be called directly.  It should be
implemented by child classes, and called by the internal Transform
class methods only.


All Transform stream implementations must provide a _transform()
method to accept input and produce output.


_transform() should do whatever has to be done in this specific
Transform class, to handle the bytes being written, and pass them off
to the readable portion of the interface. Do asynchronous I/O,
process things, and so on.


Call transform.push(outputChunk) 0 or more times to generate output
from this input chunk, depending on how much data you want to output
as a result of this chunk.


Call the callback function only when the current chunk is completely
consumed. Note that there may or may not be output as a result of any
particular input chunk. If you supply a second argument to the callback
it will be passed to the push method. In other words the following are
equivalent:


transform.prototype._transform = function (data, encoding, callback) {
  this.push(data);
  callback();
};

transform.prototype._transform = function (data, encoding, callback) {
  callback(null, data);
};



This method is prefixed with an underscore because it is internal to
the class that defines it, and should not be called directly by user
programs. However, you are expected to override this method in
your own extension classes.


Example: SimpleProtocol parser v2#


The example here of a simple
protocol parser can be implemented simply by using the higher level
Transform stream class, similar to the parseHeader and SimpleProtocol
v1 examples.


In this example, rather than providing the input as an argument, it
would be piped into the parser, which is a more idiomatic Node.js stream
approach.


const util = require('util');
const Transform = require('stream').Transform;
util.inherits(SimpleProtocol, Transform);

function SimpleProtocol(options) {
  if (!(this instanceof SimpleProtocol))
    return new SimpleProtocol(options);

  Transform.call(this, options);
  this._inBody = false;
  this._sawFirstCr = false;
  this._rawHeader = [];
  this.header = null;
}

SimpleProtocol.prototype._transform = function(chunk, encoding, done) {
  if (!this._inBody) {
    // check if the chunk has a \n\n
    var split = -1;
    for (var i = 0; i < chunk.length; i++) {
      if (chunk[i] === 10) { // '\n'
        if (this._sawFirstCr) {
          split = i;
          break;
        } else {
          this._sawFirstCr = true;
        }
      } else {
        this._sawFirstCr = false;
      }
    }

    if (split === -1) {
      // still waiting for the \n\n
      // stash the chunk, and try again.
      this._rawHeader.push(chunk);
    } else {
      this._inBody = true;
      var h = chunk.slice(0, split);
      this._rawHeader.push(h);
      var header = Buffer.concat(this._rawHeader).toString();
      try {
        this.header = JSON.parse(header);
      } catch (er) {
        this.emit('error', new Error('invalid simple protocol data'));
        return;
      }
      // and let them know that we are done parsing the header.
      this.emit('header', this.header);

      // now, because we got some extra data, emit this first.
      this.push(chunk.slice(split));
    }
  } else {
    // from there on, just provide the data to our consumer as-is.
    this.push(chunk);
  }
  done();
};

// Usage:
// var parser = new SimpleProtocol();
// source.pipe(parser)
// Now parser is a readable stream that will emit 'header'
// with the parsed header data.



Class: stream.Writable#



stream.Writable is an abstract class designed to be extended with an
underlying implementation of the
stream._write(chunk, encoding, callback) method.


Please see API for Stream Consumers for how to consume
writable streams in your programs. What follows is an explanation of
how to implement Writable streams in your programs.


new stream.Writable([options])#




In classes that extend the Writable class, make sure to call the
constructor so that the buffering settings can be properly
initialized.


writable._write(chunk, encoding, callback)#


    

  • chunk <Buffer> | <String> The chunk to be written. Will always
be a buffer unless the decodeStrings option was set to false.
    • 

  • encoding <String> If the chunk is a string, then this is the
encoding type. If chunk is a buffer, then this is the special
value - 'buffer', ignore it in this case.
    • 

  • callback <Function> Call this function (optionally with an error
argument) when you are done processing the supplied chunk.
    • 



All Writable stream implementations must provide a
stream._write() method to send data to the underlying
resource.


Note: This function MUST NOT be called directly.  It should be
implemented by child classes, and called by the internal Writable
class methods only.


Call the callback using the standard callback(error) pattern to
signal that the write completed successfully or with an error.


If the decodeStrings flag is set in the constructor options, then
chunk may be a string rather than a Buffer, and encoding will
indicate the sort of string that it is. This is to support
implementations that have an optimized handling for certain string
data encodings. If you do not explicitly set the decodeStrings
option to false, then you can safely ignore the encoding argument,
and assume that chunk will always be a Buffer.


This method is prefixed with an underscore because it is internal to
the class that defines it, and should not be called directly by user
programs. However, you are expected to override this method in
your own extension classes.


writable._writev(chunks, callback)#


    

  • chunks <Array> The chunks to be written. Each chunk has following
format: { chunk: ..., encoding: ... }.
    • 

  • callback <Function> Call this function (optionally with an error
argument) when you are done processing the supplied chunks.
    • 



Note: This function MUST NOT be called directly.  It may be
implemented by child classes, and called by the internal Writable
class methods only.


This function is completely optional to implement. In most cases it is
unnecessary. If implemented, it will be called with all the chunks
that are buffered in the write queue.


Simplified Constructor API#



In simple cases there is now the added benefit of being able to construct a
stream without inheritance.


This can be done by passing the appropriate methods as constructor options:


Examples:


Duplex#


var duplex = new stream.Duplex({
  read: function(n) {
    // sets this._read under the hood

    // push data onto the read queue, passing null
    // will signal the end of the stream (EOF)
    this.push(chunk);
  },
  write: function(chunk, encoding, next) {
    // sets this._write under the hood

    // An optional error can be passed as the first argument
    next()
  }
});

// or

var duplex = new stream.Duplex({
  read: function(n) {
    // sets this._read under the hood

    // push data onto the read queue, passing null
    // will signal the end of the stream (EOF)
    this.push(chunk);
  },
  writev: function(chunks, next) {
    // sets this._writev under the hood

    // An optional error can be passed as the first argument
    next()
  }
});



Readable#


var readable = new stream.Readable({
  read: function(n) {
    // sets this._read under the hood

    // push data onto the read queue, passing null
    // will signal the end of the stream (EOF)
    this.push(chunk);
  }
});



Transform#


var transform = new stream.Transform({
  transform: function(chunk, encoding, next) {
    // sets this._transform under the hood

    // generate output as many times as needed
    // this.push(chunk);

    // call when the current chunk is consumed
    next();
  },
  flush: function(done) {
    // sets this._flush under the hood

    // generate output as many times as needed
    // this.push(chunk);

    done();
  }
});



Writable#


var writable = new stream.Writable({
  write: function(chunk, encoding, next) {
    // sets this._write under the hood

    // An optional error can be passed as the first argument
    next()
  }
});

// or

var writable = new stream.Writable({
  writev: function(chunks, next) {
    // sets this._writev under the hood

    // An optional error can be passed as the first argument
    next()
  }
});



Streams: Under the Hood#



Buffering#



Both Writable and Readable streams will buffer data on an internal
object which can be retrieved from _writableState.getBuffer() or
_readableState.buffer, respectively.


The amount of data that will potentially be buffered depends on the
highWaterMark option which is passed into the constructor.


Buffering in Readable streams happens when the implementation calls
stream.push(chunk). If the consumer of the Stream does not
call stream.read(), then the data will sit in the internal
queue until it is consumed.


Buffering in Writable streams happens when the user calls
stream.write(chunk) repeatedly, even when it returns false.


The purpose of streams, especially with the stream.pipe() method, is to
limit the buffering of data to acceptable levels, so that sources and
destinations of varying speed will not overwhelm the available memory.


Compatibility with Older Node.js Versions#



In versions of Node.js prior to v0.10, the Readable stream interface was
simpler, but also less powerful and less useful.


    

  • Rather than waiting for you to call the stream.read() method,
'data' events would start emitting immediately. If you needed to do
some I/O to decide how to handle data, then you had to store the chunks
in some kind of buffer so that they would not be lost.
    • 

  • The stream.pause() method was advisory, rather than
guaranteed. This meant that you still had to be prepared to receive
'data' events even when the stream was in a paused state.
    • 



In Node.js v0.10, the Readable class was added.
For backwards compatibility with older Node.js programs, Readable streams
switch into "flowing mode" when a 'data' event handler is added, or
when the stream.resume() method is called. The effect is
that, even if you are not using the new stream.read() method
and 'readable' event, you no longer have to worry about losing
'data' chunks.


Most programs will continue to function normally. However, this
introduces an edge case in the following conditions:


    

  • No 'data' event handler is added.
    • 

  • The stream.resume() method is never called.
    • 

  • The stream is not piped to any writable destination.
    • 



For example, consider the following code:


// WARNING!  BROKEN!
net.createServer((socket) => {

  // we add an 'end' method, but never consume the data
  socket.on('end', () => {
    // It will never get here.
    socket.end('I got your message (but didnt read it)\n');
  });

}).listen(1337);



In versions of Node.js prior to v0.10, the incoming message data would be
simply discarded. However, in Node.js v0.10 and beyond,
the socket will remain paused forever.


The workaround in this situation is to call the
stream.resume() method to start the flow of data:


// Workaround
net.createServer((socket) => {

  socket.on('end', () => {
    socket.end('I got your message (but didnt read it)\n');
  });

  // start the flow of data, discarding it.
  socket.resume();

}).listen(1337);



In addition to new Readable streams switching into flowing mode,
pre-v0.10 style streams can be wrapped in a Readable class using the
stream.wrap() method.


Object Mode#



Normally, Streams operate on Strings and Buffers exclusively.


Streams that are in object mode can emit generic JavaScript values
other than Buffers and Strings.


A Readable stream in object mode will always return a single item from
a call to stream.read(size), regardless of what the size
argument is.


A Writable stream in object mode will always ignore the encoding
argument to stream.write(data, encoding).


The special value null still retains its special value for object
mode streams. That is, for object mode readable streams, null as a
return value from stream.read() indicates that there is no more
data, and stream.push(null) will signal the end of stream data
(EOF).


No streams in Node.js core are object mode streams. This pattern is only
used by userland streaming libraries.


You should set objectMode in your stream child class constructor on
the options object. Setting objectMode mid-stream is not safe.


For Duplex streams objectMode can be set exclusively for readable or
writable side with readableObjectMode and writableObjectMode
respectively. These options can be used to implement parsers and
serializers with Transform streams.


const util = require('util');
const StringDecoder = require('string_decoder').StringDecoder;
const Transform = require('stream').Transform;
util.inherits(JSONParseStream, Transform);

// Gets \n-delimited JSON string data, and emits the parsed objects
function JSONParseStream() {
  if (!(this instanceof JSONParseStream))
    return new JSONParseStream();

  Transform.call(this, { readableObjectMode : true });

  this._buffer = '';
  this._decoder = new StringDecoder('utf8');
}

JSONParseStream.prototype._transform = function(chunk, encoding, cb) {
  this._buffer += this._decoder.write(chunk);
  // split on newlines
  var lines = this._buffer.split(/\r?\n/);
  // keep the last partial line buffered
  this._buffer = lines.pop();
  for (var l = 0; l < lines.length; l++) {
    var line = lines[l];
    try {
      var obj = JSON.parse(line);
    } catch (er) {
      this.emit('error', er);
      return;
    }
    // push the parsed object out to the readable consumer
    this.push(obj);
  }
  cb();
};

JSONParseStream.prototype._flush = function(cb) {
  // Just handle any leftover
  var rem = this._buffer.trim();
  if (rem) {
    try {
      var obj = JSON.parse(rem);
    } catch (er) {
      this.emit('error', er);
      return;
    }
    // push the parsed object out to the readable consumer
    this.push(obj);
  }
  cb();
};



stream.read(0)#


There are some cases where you want to trigger a refresh of the
underlying readable stream mechanisms, without actually consuming any
data. In that case, you can call stream.read(0), which will always
return null.


If the internal read buffer is below the highWaterMark, and the
stream is not currently reading, then calling stream.read(0) will trigger
a low-level stream._read() call.


There is almost never a need to do this. However, you will see some
cases in Node.js's internals where this is done, particularly in the
Readable stream class internals.


stream.push('')#


Pushing a zero-byte string or Buffer (when not in Object mode) has an
interesting side effect. Because it is a call to
stream.push(), it will end the reading process. However, it
does not add any data to the readable buffer, so there's nothing for
a user to consume.


Very rarely, there are cases where you have no data to provide now,
but the consumer of your stream (or, perhaps, another bit of your own
code) will know when to check again, by calling stream.read(0).
In those cases, you may call stream.push('').


So far, the only use case for this functionality is in the
tls.CryptoStream class, which is deprecated in Node.js/io.js v1.0. If you
find that you have to use stream.push(''), please consider another
approach, because it almost certainly indicates that something is
horribly wrong.


      

    

  

  
  
  
  



node-v4.8.2/doc/api/stream.json000644 000766 000024 00000427656 13070706740 016504 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/stream.md",
  "modules": [
    {
      "textRaw": "Stream",
      "name": "stream",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
A stream is an abstract interface implemented by various objects in\nNode.js. For example a request to an HTTP server is a\nstream, as is process.stdout. Streams are readable, writable, or both. All\nstreams are instances of EventEmitter.
\n
You can load the Stream base classes by doing require('stream').\nThere are base classes provided for Readable streams, Writable\nstreams, Duplex streams, and Transform streams.
\n
This document is split up into 3 sections:
\n
    \n
  1. The first section explains the parts of the API that you need to be\naware of to use streams in your programs.
    2. \n
  2. The second section explains the parts of the API that you need to\nuse if you implement your own custom streams yourself. The API is designed to\nmake this easy for you to do.
    3. \n
  3. The third section goes into more depth about how streams work,\nincluding some of the internal mechanisms and functions that you\nshould probably not modify unless you definitely know what you are\ndoing.
    4. \n
\n",
      "classes": [
        {
          "textRaw": "Class: stream.Duplex",
          "type": "class",
          "name": "stream.Duplex",
          "desc": "
Duplex streams are streams that implement both the Readable and\nWritable interfaces.
\n
Examples of Duplex streams include:
\n\n"
        },
        {
          "textRaw": "Class: stream.Readable",
          "type": "class",
          "name": "stream.Readable",
          "desc": "
The Readable stream interface is the abstraction for a source of\ndata that you are reading from. In other words, data comes out of a\nReadable stream.
\n
A Readable stream will not start emitting data until you indicate that\nyou are ready to receive it.
\n
Readable streams have two "modes": a flowing mode and a paused\nmode. When in flowing mode, data is read from the underlying system\nand provided to your program as fast as possible. In paused mode, you\nmust explicitly call stream.read() to get chunks of data out.\nStreams start out in paused mode.
\n
Note: If no data event handlers are attached, and there are no\nstream.pipe() destinations, and the stream is switched into flowing\nmode, then data will be lost.
\n
You can switch to flowing mode by doing any of the following:
\n\n
You can switch back to paused mode by doing either of the following:
\n
    \n
  • If there are no pipe destinations, by calling the\nstream.pause() method.
    • \n
  • If there are pipe destinations, by removing any 'data' event\nhandlers, and removing all pipe destinations by calling the\nstream.unpipe() method.
    • \n
\n
Note that, for backwards compatibility reasons, removing 'data'\nevent handlers will not automatically pause the stream. Also, if\nthere are piped destinations, then calling stream.pause() will\nnot guarantee that the stream will remain paused once those\ndestinations drain and ask for more data.
\n
Examples of readable streams include:
\n\n",
          "events": [
            {
              "textRaw": "Event: 'close'",
              "type": "event",
              "name": "close",
              "desc": "
Emitted when the stream and any of its underlying resources (a file\ndescriptor, for example) have been closed. The event indicates that\nno more events will be emitted, and no further computation will occur.
\n
Not all streams will emit the 'close' event as the 'close' event is\noptional.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'data'",
              "type": "event",
              "name": "data",
              "params": [],
              "desc": "
Attaching a 'data' event listener to a stream that has not been\nexplicitly paused will switch the stream into flowing mode. Data will\nthen be passed as soon as it is available.
\n
If you just want to get all the data out of the stream as fast as\npossible, this is the best way to do so.
\n
var readable = getReadableStreamSomehow();\nreadable.on('data', (chunk) => {\n  console.log('got %d bytes of data', chunk.length);\n});\n
\n"
            },
            {
              "textRaw": "Event: 'end'",
              "type": "event",
              "name": "end",
              "desc": "
This event fires when there will be no more data to read.
\n
Note that the 'end' event will not fire unless the data is\ncompletely consumed. This can be done by switching into flowing mode,\nor by calling stream.read() repeatedly until you get to the\nend.
\n
var readable = getReadableStreamSomehow();\nreadable.on('data', (chunk) => {\n  console.log('got %d bytes of data', chunk.length);\n});\nreadable.on('end', () => {\n  console.log('there will be no more data.');\n});\n
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'error'",
              "type": "event",
              "name": "error",
              "params": [],
              "desc": "
Emitted if there was an error receiving data.
\n"
            },
            {
              "textRaw": "Event: 'readable'",
              "type": "event",
              "name": "readable",
              "desc": "
When a chunk of data can be read from the stream, it will emit a\n'readable' event.
\n
In some cases, listening for a 'readable' event will cause some data\nto be read into the internal buffer from the underlying system, if it\nhadn't already.
\n
var readable = getReadableStreamSomehow();\nreadable.on('readable', () => {\n  // there is some data to read now\n});\n
\n
Once the internal buffer is drained, a 'readable' event will fire\nagain when more data is available.
\n
The 'readable' event is not emitted in the "flowing" mode with the\nsole exception of the last one, on end-of-stream.
\n
The 'readable' event indicates that the stream has new information:\neither new data is available or the end of the stream has been reached.\nIn the former case, stream.read() will return that data. In the\nlatter case, stream.read() will return null. For instance, in\nthe following example, foo.txt is an empty file:
\n
const fs = require('fs');\nvar rr = fs.createReadStream('foo.txt');\nrr.on('readable', () => {\n  console.log('readable:', rr.read());\n});\nrr.on('end', () => {\n  console.log('end');\n});\n
\n
The output of running this script is:
\n
$ node test.js\nreadable: null\nend\n
",
              "params": []
            }
          ],
          "methods": [
            {
              "textRaw": "readable.isPaused()",
              "type": "method",
              "name": "isPaused",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Boolean} ",
                    "name": "return",
                    "type": "Boolean"
                  },
                  "params": []
                },
                {
                  "params": []
                }
              ],
              "desc": "
This method returns whether or not the readable has been explicitly\npaused by client code (using stream.pause() without a\ncorresponding stream.resume()).
\n
var readable = new stream.Readable\n\nreadable.isPaused() // === false\nreadable.pause()\nreadable.isPaused() // === true\nreadable.resume()\nreadable.isPaused() // === false\n
\n"
            },
            {
              "textRaw": "readable.pause()",
              "type": "method",
              "name": "pause",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: `this` ",
                    "name": "return",
                    "desc": "`this`"
                  },
                  "params": []
                },
                {
                  "params": []
                }
              ],
              "desc": "
This method will cause a stream in flowing mode to stop emitting\n'data' events, switching out of flowing mode. Any data that becomes\navailable will remain in the internal buffer.
\n
var readable = getReadableStreamSomehow();\nreadable.on('data', (chunk) => {\n  console.log('got %d bytes of data', chunk.length);\n  readable.pause();\n  console.log('there will be no more data for 1 second');\n  setTimeout(() => {\n    console.log('now data will start flowing again');\n    readable.resume();\n  }, 1000);\n});\n
\n"
            },
            {
              "textRaw": "readable.pipe(destination[, options])",
              "type": "method",
              "name": "pipe",
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`destination` {stream.Writable} The destination for writing data ",
                      "name": "destination",
                      "type": "stream.Writable",
                      "desc": "The destination for writing data"
                    },
                    {
                      "textRaw": "`options` {Object} Pipe options ",
                      "options": [
                        {
                          "textRaw": "`end` {Boolean} End the writer when the reader ends. Default = `true` ",
                          "name": "end",
                          "type": "Boolean",
                          "desc": "End the writer when the reader ends. Default = `true`"
                        }
                      ],
                      "name": "options",
                      "type": "Object",
                      "desc": "Pipe options",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "destination"
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
This method pulls all the data out of a readable stream, and writes it\nto the supplied destination, automatically managing the flow so that\nthe destination is not overwhelmed by a fast readable stream.
\n
Multiple destinations can be piped to safely.
\n
var readable = getReadableStreamSomehow();\nvar writable = fs.createWriteStream('file.txt');\n// All the data from readable goes into 'file.txt'\nreadable.pipe(writable);\n
\n
This function returns the destination stream, so you can set up pipe\nchains like so:
\n
var r = fs.createReadStream('file.txt');\nvar z = zlib.createGzip();\nvar w = fs.createWriteStream('file.txt.gz');\nr.pipe(z).pipe(w);\n
\n
For example, emulating the Unix cat command:
\n
process.stdin.pipe(process.stdout);\n
\n
By default stream.end() is called on the destination when the\nsource stream emits 'end', so that destination is no longer writable.\nPass { end: false } as options to keep the destination stream open.
\n
This keeps writer open so that "Goodbye" can be written at the\nend.
\n
reader.pipe(writer, { end: false });\nreader.on('end', () => {\n  writer.end('Goodbye\\n');\n});\n
\n
Note that process.stderr and process.stdout are never closed until\nthe process exits, regardless of the specified options.
\n"
            },
            {
              "textRaw": "readable.read([size])",
              "type": "method",
              "name": "read",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Return {String|Buffer|Null} ",
                    "name": "return",
                    "type": "String|Buffer|Null"
                  },
                  "params": [
                    {
                      "textRaw": "`size` {Number} Optional argument to specify how much data to read. ",
                      "name": "size",
                      "type": "Number",
                      "desc": "Optional argument to specify how much data to read.",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "size",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
The read() method pulls some data out of the internal buffer and\nreturns it. If there is no data available, then it will return\nnull.
\n
If you pass in a size argument, then it will return that many\nbytes. If size bytes are not available, then it will return null,\nunless we've ended, in which case it will return the data remaining\nin the buffer.
\n
If you do not specify a size argument, then it will return all the\ndata in the internal buffer.
\n
This method should only be called in paused mode. In flowing mode,\nthis method is called automatically until the internal buffer is\ndrained.
\n
var readable = getReadableStreamSomehow();\nreadable.on('readable', () => {\n  var chunk;\n  while (null !== (chunk = readable.read())) {\n    console.log('got %d bytes of data', chunk.length);\n  }\n});\n
\n
If this method returns a data chunk, then it will also trigger the\nemission of a 'data' event.
\n
Note that calling stream.read([size]) after the 'end'\nevent has been triggered will return null. No runtime error will be raised.
\n"
            },
            {
              "textRaw": "readable.resume()",
              "type": "method",
              "name": "resume",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: `this` ",
                    "name": "return",
                    "desc": "`this`"
                  },
                  "params": []
                },
                {
                  "params": []
                }
              ],
              "desc": "
This method will cause the readable stream to resume emitting 'data'\nevents.
\n
This method will switch the stream into flowing mode. If you do not\nwant to consume the data from a stream, but you do want to get to\nits 'end' event, you can call stream.resume() to open\nthe flow of data.
\n
var readable = getReadableStreamSomehow();\nreadable.resume();\nreadable.on('end', () => {\n  console.log('got to the end, but did not read anything');\n});\n
\n"
            },
            {
              "textRaw": "readable.setEncoding(encoding)",
              "type": "method",
              "name": "setEncoding",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: `this` ",
                    "name": "return",
                    "desc": "`this`"
                  },
                  "params": [
                    {
                      "textRaw": "`encoding` {String} The encoding to use. ",
                      "name": "encoding",
                      "type": "String",
                      "desc": "The encoding to use."
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "encoding"
                    }
                  ]
                }
              ],
              "desc": "
Call this function to cause the stream to return strings of the specified\nencoding instead of Buffer objects. For example, if you do\nreadable.setEncoding('utf8'), then the output data will be interpreted as\nUTF-8 data, and returned as strings. If you do readable.setEncoding('hex'),\nthen the data will be encoded in hexadecimal string format.
\n
This properly handles multi-byte characters that would otherwise be\npotentially mangled if you simply pulled the Buffers directly and\ncalled buf.toString(encoding) on them. If you want to read the data\nas strings, always use this method.
\n
Also you can disable any encoding at all with readable.setEncoding(null).\nThis approach is very useful if you deal with binary data or with large\nmulti-byte strings spread out over multiple chunks.
\n
var readable = getReadableStreamSomehow();\nreadable.setEncoding('utf8');\nreadable.on('data', (chunk) => {\n  assert.equal(typeof chunk, 'string');\n  console.log('got %d characters of string data', chunk.length);\n});\n
\n"
            },
            {
              "textRaw": "readable.unpipe([destination])",
              "type": "method",
              "name": "unpipe",
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`destination` {stream.Writable} Optional specific stream to unpipe ",
                      "name": "destination",
                      "type": "stream.Writable",
                      "desc": "Optional specific stream to unpipe",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "destination",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
This method will remove the hooks set up for a previous stream.pipe()\ncall.
\n
If the destination is not specified, then all pipes are removed.
\n
If the destination is specified, but no pipe is set up for it, then\nthis is a no-op.
\n
var readable = getReadableStreamSomehow();\nvar writable = fs.createWriteStream('file.txt');\n// All the data from readable goes into 'file.txt',\n// but only for the first second\nreadable.pipe(writable);\nsetTimeout(() => {\n  console.log('stop writing to file.txt');\n  readable.unpipe(writable);\n  console.log('manually close the file stream');\n  writable.end();\n}, 1000);\n
\n"
            },
            {
              "textRaw": "readable.unshift(chunk)",
              "type": "method",
              "name": "unshift",
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`chunk` {Buffer|String} Chunk of data to unshift onto the read queue ",
                      "name": "chunk",
                      "type": "Buffer|String",
                      "desc": "Chunk of data to unshift onto the read queue"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "chunk"
                    }
                  ]
                }
              ],
              "desc": "
This is useful in certain cases where a stream is being consumed by a\nparser, which needs to "un-consume" some data that it has\noptimistically pulled out of the source, so that the stream can be\npassed on to some other party.
\n
Note that stream.unshift(chunk) cannot be called after the 'end' event\nhas been triggered; a runtime error will be raised.
\n
If you find that you must often call stream.unshift(chunk) in your\nprograms, consider implementing a Transform stream instead. (See API\nfor Stream Implementors.)
\n
// Pull off a header delimited by \\n\\n\n// use unshift() if we get too much\n// Call the callback with (error, header, stream)\nconst StringDecoder = require('string_decoder').StringDecoder;\nfunction parseHeader(stream, callback) {\n  stream.on('error', callback);\n  stream.on('readable', onReadable);\n  var decoder = new StringDecoder('utf8');\n  var header = '';\n  function onReadable() {\n    var chunk;\n    while (null !== (chunk = stream.read())) {\n      var str = decoder.write(chunk);\n      if (str.match(/\\n\\n/)) {\n        // found the header boundary\n        var split = str.split(/\\n\\n/);\n        header += split.shift();\n        var remaining = split.join('\\n\\n');\n        var buf = new Buffer(remaining, 'utf8');\n        if (buf.length)\n          stream.unshift(buf);\n        stream.removeListener('error', callback);\n        stream.removeListener('readable', onReadable);\n        // now the body of the message can be read from the stream.\n        callback(null, header, stream);\n      } else {\n        // still reading the header.\n        header += str;\n      }\n    }\n  }\n}\n
\n
Note that, unlike stream.push(chunk), stream.unshift(chunk)\nwill not end the reading process by resetting the internal reading state of the\nstream. This can cause unexpected results if unshift() is called during a\nread (i.e. from within a stream._read() implementation on a\ncustom stream). Following the call to unshift() with an immediate\nstream.push('') will reset the reading state appropriately,\nhowever it is best to simply avoid calling unshift() while in the process of\nperforming a read.
\n"
            },
            {
              "textRaw": "readable.wrap(stream)",
              "type": "method",
              "name": "wrap",
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`stream` {Stream} An \"old style\" readable stream ",
                      "name": "stream",
                      "type": "Stream",
                      "desc": "An \"old style\" readable stream"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "stream"
                    }
                  ]
                }
              ],
              "desc": "
Versions of Node.js prior to v0.10 had streams that did not implement the\nentire Streams API as it is today. (See Compatibility for\nmore information.)
\n
If you are using an older Node.js library that emits 'data' events and\nhas a stream.pause() method that is advisory only, then you\ncan use the wrap() method to create a Readable stream that uses the old\nstream as its data source.
\n
You will very rarely ever need to call this function, but it exists\nas a convenience for interacting with old Node.js programs and libraries.
\n
For example:
\n
const OldReader = require('./old-api-module.js').OldReader;\nconst Readable = require('stream').Readable;\nconst oreader = new OldReader;\nconst myReader = new Readable().wrap(oreader);\n\nmyReader.on('readable', () => {\n  myReader.read(); // etc.\n});\n
\n"
            }
          ]
        },
        {
          "textRaw": "Class: stream.Transform",
          "type": "class",
          "name": "stream.Transform",
          "desc": "
Transform streams are Duplex streams where the output is in some way\ncomputed from the input. They implement both the Readable and\nWritable interfaces.
\n
Examples of Transform streams include:
\n\n"
        },
        {
          "textRaw": "Class: stream.Writable",
          "type": "class",
          "name": "stream.Writable",
          "desc": "
The Writable stream interface is an abstraction for a destination\nthat you are writing data to.
\n
Examples of writable streams include:
\n\n",
          "events": [
            {
              "textRaw": "Event: 'close'",
              "type": "event",
              "name": "close",
              "desc": "
Emitted when the stream and any of its underlying resources (a file descriptor,\nfor example) have been closed. The event indicates that no more events will be\nemitted, and no further computation will occur.
\n
Not all streams will emit the 'close' event as the 'close' event is\noptional.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'drain'",
              "type": "event",
              "name": "drain",
              "desc": "
If a stream.write(chunk) call returns false, then the\n'drain' event will indicate when it is appropriate to begin writing more data\nto the stream.
\n
// Write the data to the supplied writable stream one million times.\n// Be attentive to back-pressure.\nfunction writeOneMillionTimes(writer, data, encoding, callback) {\n  var i = 1000000;\n  write();\n  function write() {\n    var ok = true;\n    do {\n      i -= 1;\n      if (i === 0) {\n        // last time!\n        writer.write(data, encoding, callback);\n      } else {\n        // see if we should continue, or wait\n        // don't pass the callback, because we're not done yet.\n        ok = writer.write(data, encoding);\n      }\n    } while (i > 0 && ok);\n    if (i > 0) {\n      // had to stop early!\n      // write some more once it drains\n      writer.once('drain', write);\n    }\n  }\n}\n
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'error'",
              "type": "event",
              "name": "error",
              "params": [],
              "desc": "
Emitted if there was an error when writing or piping data.
\n"
            },
            {
              "textRaw": "Event: 'finish'",
              "type": "event",
              "name": "finish",
              "desc": "
When the stream.end() method has been called, and all data has\nbeen flushed to the underlying system, this event is emitted.
\n
var writer = getWritableStreamSomehow();\nfor (var i = 0; i < 100; i ++) {\n  writer.write('hello, #${i}!\\n');\n}\nwriter.end('this is the end\\n');\nwriter.on('finish', () => {\n  console.error('all writes are now complete.');\n});\n
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'pipe'",
              "type": "event",
              "name": "pipe",
              "params": [],
              "desc": "
This is emitted whenever the stream.pipe() method is called on a readable\nstream, adding this writable to its set of destinations.
\n
var writer = getWritableStreamSomehow();\nvar reader = getReadableStreamSomehow();\nwriter.on('pipe', (src) => {\n  console.error('something is piping into the writer');\n  assert.equal(src, reader);\n});\nreader.pipe(writer);\n
\n"
            },
            {
              "textRaw": "Event: 'unpipe'",
              "type": "event",
              "name": "unpipe",
              "params": [],
              "desc": "
This is emitted whenever the stream.unpipe() method is called on a\nreadable stream, removing this writable from its set of destinations.
\n
var writer = getWritableStreamSomehow();\nvar reader = getReadableStreamSomehow();\nwriter.on('unpipe', (src) => {\n  console.error('something has stopped piping into the writer');\n  assert.equal(src, reader);\n});\nreader.pipe(writer);\nreader.unpipe(writer);\n
\n"
            }
          ],
          "methods": [
            {
              "textRaw": "writable.cork()",
              "type": "method",
              "name": "cork",
              "desc": "
Forces buffering of all writes.
\n
Buffered data will be flushed either at stream.uncork() or at\nstream.end() call.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "writable.end([chunk][, encoding][, callback])",
              "type": "method",
              "name": "end",
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`chunk` {String|Buffer} Optional data to write ",
                      "name": "chunk",
                      "type": "String|Buffer",
                      "desc": "Optional data to write",
                      "optional": true
                    },
                    {
                      "textRaw": "`encoding` {String} The encoding, if `chunk` is a String ",
                      "name": "encoding",
                      "type": "String",
                      "desc": "The encoding, if `chunk` is a String",
                      "optional": true
                    },
                    {
                      "textRaw": "`callback` {Function} Optional callback for when the stream is finished ",
                      "name": "callback",
                      "type": "Function",
                      "desc": "Optional callback for when the stream is finished",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "chunk",
                      "optional": true
                    },
                    {
                      "name": "encoding",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
Call this method when no more data will be written to the stream. If supplied,\nthe callback is attached as a listener on the 'finish' event.
\n
Calling stream.write() after calling\nstream.end() will raise an error.
\n
// write 'hello, ' and then end with 'world!'\nvar file = fs.createWriteStream('example.txt');\nfile.write('hello, ');\nfile.end('world!');\n// writing more now is not allowed!\n
\n"
            },
            {
              "textRaw": "writable.setDefaultEncoding(encoding)",
              "type": "method",
              "name": "setDefaultEncoding",
              "signatures": [
                {
                  "params": [
                    {
                      "textRaw": "`encoding` {String} The new default encoding ",
                      "name": "encoding",
                      "type": "String",
                      "desc": "The new default encoding"
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "encoding"
                    }
                  ]
                }
              ],
              "desc": "
Sets the default encoding for a writable stream.
\n"
            },
            {
              "textRaw": "writable.uncork()",
              "type": "method",
              "name": "uncork",
              "desc": "
Flush all data, buffered since stream.cork() call.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "writable.write(chunk[, encoding][, callback])",
              "type": "method",
              "name": "write",
              "signatures": [
                {
                  "return": {
                    "textRaw": "Returns: {Boolean} `true` if the data was handled completely. ",
                    "name": "return",
                    "type": "Boolean",
                    "desc": "`true` if the data was handled completely."
                  },
                  "params": [
                    {
                      "textRaw": "`chunk` {String|Buffer} The data to write ",
                      "name": "chunk",
                      "type": "String|Buffer",
                      "desc": "The data to write"
                    },
                    {
                      "textRaw": "`encoding` {String} The encoding, if `chunk` is a String ",
                      "name": "encoding",
                      "type": "String",
                      "desc": "The encoding, if `chunk` is a String",
                      "optional": true
                    },
                    {
                      "textRaw": "`callback` {Function} Callback for when this chunk of data is flushed ",
                      "name": "callback",
                      "type": "Function",
                      "desc": "Callback for when this chunk of data is flushed",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "chunk"
                    },
                    {
                      "name": "encoding",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ],
              "desc": "
This method writes some data to the underlying system, and calls the\nsupplied callback once the data has been fully handled.  If an error\noccurs, the callback may or may not be called with the error as its\nfirst argument.  To detect write errors, listen for the 'error' event.
\n
The return value indicates if you should continue writing right now.\nIf the data had to be buffered internally, then it will return\nfalse. Otherwise, it will return true.
\n
This return value is strictly advisory. You MAY continue to write,\neven if it returns false. However, writes will be buffered in\nmemory, so it is best not to do this excessively. Instead, wait for\nthe 'drain' event before writing more data.
\n"
            }
          ]
        }
      ],
      "miscs": [
        {
          "textRaw": "API for Stream Consumers",
          "name": "API for Stream Consumers",
          "type": "misc",
          "desc": "
Streams can be either Readable, Writable, or both (Duplex).
\n
All streams are EventEmitters, but they also have other custom methods\nand properties depending on whether they are Readable, Writable, or\nDuplex.
\n
If a stream is both Readable and Writable, then it implements all of\nthe methods and events. So, a Duplex or Transform stream is\nfully described by this API, though their implementation may be\nsomewhat different.
\n
It is not necessary to implement Stream interfaces in order to consume\nstreams in your programs. If you are implementing streaming\ninterfaces in your own program, please also refer to\nAPI for Stream Implementors.
\n
Almost all Node.js programs, no matter how simple, use Streams in some\nway. Here is an example of using Streams in an Node.js program:
\n
const http = require('http');\n\nvar server = http.createServer( (req, res) => {\n  // req is an http.IncomingMessage, which is a Readable Stream\n  // res is an http.ServerResponse, which is a Writable Stream\n\n  var body = '';\n  // we want to get the data as utf8 strings\n  // If you don't set an encoding, then you'll get Buffer objects\n  req.setEncoding('utf8');\n\n  // Readable streams emit 'data' events once a listener is added\n  req.on('data', (chunk) => {\n    body += chunk;\n  });\n\n  // the end event tells you that you have entire body\n  req.on('end', () => {\n    try {\n      const data = JSON.parse(body);\n      // write back something interesting to the user:\n      res.write(typeof data);\n      res.end();\n    } catch (er) {\n      // uh oh!  bad json!\n      res.statusCode = 400;\n      return res.end(`error: ${er.message}`);\n    }\n  });\n});\n\nserver.listen(1337);\n\n// $ curl localhost:1337 -d '{}'\n// object\n// $ curl localhost:1337 -d '"foo"'\n// string\n// $ curl localhost:1337 -d 'not json'\n// error: Unexpected token o\n
\n",
          "classes": [
            {
              "textRaw": "Class: stream.Duplex",
              "type": "class",
              "name": "stream.Duplex",
              "desc": "
Duplex streams are streams that implement both the Readable and\nWritable interfaces.
\n
Examples of Duplex streams include:
\n\n"
            },
            {
              "textRaw": "Class: stream.Readable",
              "type": "class",
              "name": "stream.Readable",
              "desc": "
The Readable stream interface is the abstraction for a source of\ndata that you are reading from. In other words, data comes out of a\nReadable stream.
\n
A Readable stream will not start emitting data until you indicate that\nyou are ready to receive it.
\n
Readable streams have two "modes": a flowing mode and a paused\nmode. When in flowing mode, data is read from the underlying system\nand provided to your program as fast as possible. In paused mode, you\nmust explicitly call stream.read() to get chunks of data out.\nStreams start out in paused mode.
\n
Note: If no data event handlers are attached, and there are no\nstream.pipe() destinations, and the stream is switched into flowing\nmode, then data will be lost.
\n
You can switch to flowing mode by doing any of the following:
\n\n
You can switch back to paused mode by doing either of the following:
\n
    \n
  • If there are no pipe destinations, by calling the\nstream.pause() method.
    • \n
  • If there are pipe destinations, by removing any 'data' event\nhandlers, and removing all pipe destinations by calling the\nstream.unpipe() method.
    • \n
\n
Note that, for backwards compatibility reasons, removing 'data'\nevent handlers will not automatically pause the stream. Also, if\nthere are piped destinations, then calling stream.pause() will\nnot guarantee that the stream will remain paused once those\ndestinations drain and ask for more data.
\n
Examples of readable streams include:
\n\n",
              "events": [
                {
                  "textRaw": "Event: 'close'",
                  "type": "event",
                  "name": "close",
                  "desc": "
Emitted when the stream and any of its underlying resources (a file\ndescriptor, for example) have been closed. The event indicates that\nno more events will be emitted, and no further computation will occur.
\n
Not all streams will emit the 'close' event as the 'close' event is\noptional.
\n",
                  "params": []
                },
                {
                  "textRaw": "Event: 'data'",
                  "type": "event",
                  "name": "data",
                  "params": [],
                  "desc": "
Attaching a 'data' event listener to a stream that has not been\nexplicitly paused will switch the stream into flowing mode. Data will\nthen be passed as soon as it is available.
\n
If you just want to get all the data out of the stream as fast as\npossible, this is the best way to do so.
\n
var readable = getReadableStreamSomehow();\nreadable.on('data', (chunk) => {\n  console.log('got %d bytes of data', chunk.length);\n});\n
\n"
                },
                {
                  "textRaw": "Event: 'end'",
                  "type": "event",
                  "name": "end",
                  "desc": "
This event fires when there will be no more data to read.
\n
Note that the 'end' event will not fire unless the data is\ncompletely consumed. This can be done by switching into flowing mode,\nor by calling stream.read() repeatedly until you get to the\nend.
\n
var readable = getReadableStreamSomehow();\nreadable.on('data', (chunk) => {\n  console.log('got %d bytes of data', chunk.length);\n});\nreadable.on('end', () => {\n  console.log('there will be no more data.');\n});\n
\n",
                  "params": []
                },
                {
                  "textRaw": "Event: 'error'",
                  "type": "event",
                  "name": "error",
                  "params": [],
                  "desc": "
Emitted if there was an error receiving data.
\n"
                },
                {
                  "textRaw": "Event: 'readable'",
                  "type": "event",
                  "name": "readable",
                  "desc": "
When a chunk of data can be read from the stream, it will emit a\n'readable' event.
\n
In some cases, listening for a 'readable' event will cause some data\nto be read into the internal buffer from the underlying system, if it\nhadn't already.
\n
var readable = getReadableStreamSomehow();\nreadable.on('readable', () => {\n  // there is some data to read now\n});\n
\n
Once the internal buffer is drained, a 'readable' event will fire\nagain when more data is available.
\n
The 'readable' event is not emitted in the "flowing" mode with the\nsole exception of the last one, on end-of-stream.
\n
The 'readable' event indicates that the stream has new information:\neither new data is available or the end of the stream has been reached.\nIn the former case, stream.read() will return that data. In the\nlatter case, stream.read() will return null. For instance, in\nthe following example, foo.txt is an empty file:
\n
const fs = require('fs');\nvar rr = fs.createReadStream('foo.txt');\nrr.on('readable', () => {\n  console.log('readable:', rr.read());\n});\nrr.on('end', () => {\n  console.log('end');\n});\n
\n
The output of running this script is:
\n
$ node test.js\nreadable: null\nend\n
",
                  "params": []
                }
              ],
              "methods": [
                {
                  "textRaw": "readable.isPaused()",
                  "type": "method",
                  "name": "isPaused",
                  "signatures": [
                    {
                      "return": {
                        "textRaw": "Returns: {Boolean} ",
                        "name": "return",
                        "type": "Boolean"
                      },
                      "params": []
                    },
                    {
                      "params": []
                    }
                  ],
                  "desc": "
This method returns whether or not the readable has been explicitly\npaused by client code (using stream.pause() without a\ncorresponding stream.resume()).
\n
var readable = new stream.Readable\n\nreadable.isPaused() // === false\nreadable.pause()\nreadable.isPaused() // === true\nreadable.resume()\nreadable.isPaused() // === false\n
\n"
                },
                {
                  "textRaw": "readable.pause()",
                  "type": "method",
                  "name": "pause",
                  "signatures": [
                    {
                      "return": {
                        "textRaw": "Returns: `this` ",
                        "name": "return",
                        "desc": "`this`"
                      },
                      "params": []
                    },
                    {
                      "params": []
                    }
                  ],
                  "desc": "
This method will cause a stream in flowing mode to stop emitting\n'data' events, switching out of flowing mode. Any data that becomes\navailable will remain in the internal buffer.
\n
var readable = getReadableStreamSomehow();\nreadable.on('data', (chunk) => {\n  console.log('got %d bytes of data', chunk.length);\n  readable.pause();\n  console.log('there will be no more data for 1 second');\n  setTimeout(() => {\n    console.log('now data will start flowing again');\n    readable.resume();\n  }, 1000);\n});\n
\n"
                },
                {
                  "textRaw": "readable.pipe(destination[, options])",
                  "type": "method",
                  "name": "pipe",
                  "signatures": [
                    {
                      "params": [
                        {
                          "textRaw": "`destination` {stream.Writable} The destination for writing data ",
                          "name": "destination",
                          "type": "stream.Writable",
                          "desc": "The destination for writing data"
                        },
                        {
                          "textRaw": "`options` {Object} Pipe options ",
                          "options": [
                            {
                              "textRaw": "`end` {Boolean} End the writer when the reader ends. Default = `true` ",
                              "name": "end",
                              "type": "Boolean",
                              "desc": "End the writer when the reader ends. Default = `true`"
                            }
                          ],
                          "name": "options",
                          "type": "Object",
                          "desc": "Pipe options",
                          "optional": true
                        }
                      ]
                    },
                    {
                      "params": [
                        {
                          "name": "destination"
                        },
                        {
                          "name": "options",
                          "optional": true
                        }
                      ]
                    }
                  ],
                  "desc": "
This method pulls all the data out of a readable stream, and writes it\nto the supplied destination, automatically managing the flow so that\nthe destination is not overwhelmed by a fast readable stream.
\n
Multiple destinations can be piped to safely.
\n
var readable = getReadableStreamSomehow();\nvar writable = fs.createWriteStream('file.txt');\n// All the data from readable goes into 'file.txt'\nreadable.pipe(writable);\n
\n
This function returns the destination stream, so you can set up pipe\nchains like so:
\n
var r = fs.createReadStream('file.txt');\nvar z = zlib.createGzip();\nvar w = fs.createWriteStream('file.txt.gz');\nr.pipe(z).pipe(w);\n
\n
For example, emulating the Unix cat command:
\n
process.stdin.pipe(process.stdout);\n
\n
By default stream.end() is called on the destination when the\nsource stream emits 'end', so that destination is no longer writable.\nPass { end: false } as options to keep the destination stream open.
\n
This keeps writer open so that "Goodbye" can be written at the\nend.
\n
reader.pipe(writer, { end: false });\nreader.on('end', () => {\n  writer.end('Goodbye\\n');\n});\n
\n
Note that process.stderr and process.stdout are never closed until\nthe process exits, regardless of the specified options.
\n"
                },
                {
                  "textRaw": "readable.read([size])",
                  "type": "method",
                  "name": "read",
                  "signatures": [
                    {
                      "return": {
                        "textRaw": "Return {String|Buffer|Null} ",
                        "name": "return",
                        "type": "String|Buffer|Null"
                      },
                      "params": [
                        {
                          "textRaw": "`size` {Number} Optional argument to specify how much data to read. ",
                          "name": "size",
                          "type": "Number",
                          "desc": "Optional argument to specify how much data to read.",
                          "optional": true
                        }
                      ]
                    },
                    {
                      "params": [
                        {
                          "name": "size",
                          "optional": true
                        }
                      ]
                    }
                  ],
                  "desc": "
The read() method pulls some data out of the internal buffer and\nreturns it. If there is no data available, then it will return\nnull.
\n
If you pass in a size argument, then it will return that many\nbytes. If size bytes are not available, then it will return null,\nunless we've ended, in which case it will return the data remaining\nin the buffer.
\n
If you do not specify a size argument, then it will return all the\ndata in the internal buffer.
\n
This method should only be called in paused mode. In flowing mode,\nthis method is called automatically until the internal buffer is\ndrained.
\n
var readable = getReadableStreamSomehow();\nreadable.on('readable', () => {\n  var chunk;\n  while (null !== (chunk = readable.read())) {\n    console.log('got %d bytes of data', chunk.length);\n  }\n});\n
\n
If this method returns a data chunk, then it will also trigger the\nemission of a 'data' event.
\n
Note that calling stream.read([size]) after the 'end'\nevent has been triggered will return null. No runtime error will be raised.
\n"
                },
                {
                  "textRaw": "readable.resume()",
                  "type": "method",
                  "name": "resume",
                  "signatures": [
                    {
                      "return": {
                        "textRaw": "Returns: `this` ",
                        "name": "return",
                        "desc": "`this`"
                      },
                      "params": []
                    },
                    {
                      "params": []
                    }
                  ],
                  "desc": "
This method will cause the readable stream to resume emitting 'data'\nevents.
\n
This method will switch the stream into flowing mode. If you do not\nwant to consume the data from a stream, but you do want to get to\nits 'end' event, you can call stream.resume() to open\nthe flow of data.
\n
var readable = getReadableStreamSomehow();\nreadable.resume();\nreadable.on('end', () => {\n  console.log('got to the end, but did not read anything');\n});\n
\n"
                },
                {
                  "textRaw": "readable.setEncoding(encoding)",
                  "type": "method",
                  "name": "setEncoding",
                  "signatures": [
                    {
                      "return": {
                        "textRaw": "Returns: `this` ",
                        "name": "return",
                        "desc": "`this`"
                      },
                      "params": [
                        {
                          "textRaw": "`encoding` {String} The encoding to use. ",
                          "name": "encoding",
                          "type": "String",
                          "desc": "The encoding to use."
                        }
                      ]
                    },
                    {
                      "params": [
                        {
                          "name": "encoding"
                        }
                      ]
                    }
                  ],
                  "desc": "
Call this function to cause the stream to return strings of the specified\nencoding instead of Buffer objects. For example, if you do\nreadable.setEncoding('utf8'), then the output data will be interpreted as\nUTF-8 data, and returned as strings. If you do readable.setEncoding('hex'),\nthen the data will be encoded in hexadecimal string format.
\n
This properly handles multi-byte characters that would otherwise be\npotentially mangled if you simply pulled the Buffers directly and\ncalled buf.toString(encoding) on them. If you want to read the data\nas strings, always use this method.
\n
Also you can disable any encoding at all with readable.setEncoding(null).\nThis approach is very useful if you deal with binary data or with large\nmulti-byte strings spread out over multiple chunks.
\n
var readable = getReadableStreamSomehow();\nreadable.setEncoding('utf8');\nreadable.on('data', (chunk) => {\n  assert.equal(typeof chunk, 'string');\n  console.log('got %d characters of string data', chunk.length);\n});\n
\n"
                },
                {
                  "textRaw": "readable.unpipe([destination])",
                  "type": "method",
                  "name": "unpipe",
                  "signatures": [
                    {
                      "params": [
                        {
                          "textRaw": "`destination` {stream.Writable} Optional specific stream to unpipe ",
                          "name": "destination",
                          "type": "stream.Writable",
                          "desc": "Optional specific stream to unpipe",
                          "optional": true
                        }
                      ]
                    },
                    {
                      "params": [
                        {
                          "name": "destination",
                          "optional": true
                        }
                      ]
                    }
                  ],
                  "desc": "
This method will remove the hooks set up for a previous stream.pipe()\ncall.
\n
If the destination is not specified, then all pipes are removed.
\n
If the destination is specified, but no pipe is set up for it, then\nthis is a no-op.
\n
var readable = getReadableStreamSomehow();\nvar writable = fs.createWriteStream('file.txt');\n// All the data from readable goes into 'file.txt',\n// but only for the first second\nreadable.pipe(writable);\nsetTimeout(() => {\n  console.log('stop writing to file.txt');\n  readable.unpipe(writable);\n  console.log('manually close the file stream');\n  writable.end();\n}, 1000);\n
\n"
                },
                {
                  "textRaw": "readable.unshift(chunk)",
                  "type": "method",
                  "name": "unshift",
                  "signatures": [
                    {
                      "params": [
                        {
                          "textRaw": "`chunk` {Buffer|String} Chunk of data to unshift onto the read queue ",
                          "name": "chunk",
                          "type": "Buffer|String",
                          "desc": "Chunk of data to unshift onto the read queue"
                        }
                      ]
                    },
                    {
                      "params": [
                        {
                          "name": "chunk"
                        }
                      ]
                    }
                  ],
                  "desc": "
This is useful in certain cases where a stream is being consumed by a\nparser, which needs to "un-consume" some data that it has\noptimistically pulled out of the source, so that the stream can be\npassed on to some other party.
\n
Note that stream.unshift(chunk) cannot be called after the 'end' event\nhas been triggered; a runtime error will be raised.
\n
If you find that you must often call stream.unshift(chunk) in your\nprograms, consider implementing a Transform stream instead. (See API\nfor Stream Implementors.)
\n
// Pull off a header delimited by \\n\\n\n// use unshift() if we get too much\n// Call the callback with (error, header, stream)\nconst StringDecoder = require('string_decoder').StringDecoder;\nfunction parseHeader(stream, callback) {\n  stream.on('error', callback);\n  stream.on('readable', onReadable);\n  var decoder = new StringDecoder('utf8');\n  var header = '';\n  function onReadable() {\n    var chunk;\n    while (null !== (chunk = stream.read())) {\n      var str = decoder.write(chunk);\n      if (str.match(/\\n\\n/)) {\n        // found the header boundary\n        var split = str.split(/\\n\\n/);\n        header += split.shift();\n        var remaining = split.join('\\n\\n');\n        var buf = new Buffer(remaining, 'utf8');\n        if (buf.length)\n          stream.unshift(buf);\n        stream.removeListener('error', callback);\n        stream.removeListener('readable', onReadable);\n        // now the body of the message can be read from the stream.\n        callback(null, header, stream);\n      } else {\n        // still reading the header.\n        header += str;\n      }\n    }\n  }\n}\n
\n
Note that, unlike stream.push(chunk), stream.unshift(chunk)\nwill not end the reading process by resetting the internal reading state of the\nstream. This can cause unexpected results if unshift() is called during a\nread (i.e. from within a stream._read() implementation on a\ncustom stream). Following the call to unshift() with an immediate\nstream.push('') will reset the reading state appropriately,\nhowever it is best to simply avoid calling unshift() while in the process of\nperforming a read.
\n"
                },
                {
                  "textRaw": "readable.wrap(stream)",
                  "type": "method",
                  "name": "wrap",
                  "signatures": [
                    {
                      "params": [
                        {
                          "textRaw": "`stream` {Stream} An \"old style\" readable stream ",
                          "name": "stream",
                          "type": "Stream",
                          "desc": "An \"old style\" readable stream"
                        }
                      ]
                    },
                    {
                      "params": [
                        {
                          "name": "stream"
                        }
                      ]
                    }
                  ],
                  "desc": "
Versions of Node.js prior to v0.10 had streams that did not implement the\nentire Streams API as it is today. (See Compatibility for\nmore information.)
\n
If you are using an older Node.js library that emits 'data' events and\nhas a stream.pause() method that is advisory only, then you\ncan use the wrap() method to create a Readable stream that uses the old\nstream as its data source.
\n
You will very rarely ever need to call this function, but it exists\nas a convenience for interacting with old Node.js programs and libraries.
\n
For example:
\n
const OldReader = require('./old-api-module.js').OldReader;\nconst Readable = require('stream').Readable;\nconst oreader = new OldReader;\nconst myReader = new Readable().wrap(oreader);\n\nmyReader.on('readable', () => {\n  myReader.read(); // etc.\n});\n
\n"
                }
              ]
            },
            {
              "textRaw": "Class: stream.Transform",
              "type": "class",
              "name": "stream.Transform",
              "desc": "
Transform streams are Duplex streams where the output is in some way\ncomputed from the input. They implement both the Readable and\nWritable interfaces.
\n
Examples of Transform streams include:
\n\n"
            },
            {
              "textRaw": "Class: stream.Writable",
              "type": "class",
              "name": "stream.Writable",
              "desc": "
The Writable stream interface is an abstraction for a destination\nthat you are writing data to.
\n
Examples of writable streams include:
\n\n",
              "events": [
                {
                  "textRaw": "Event: 'close'",
                  "type": "event",
                  "name": "close",
                  "desc": "
Emitted when the stream and any of its underlying resources (a file descriptor,\nfor example) have been closed. The event indicates that no more events will be\nemitted, and no further computation will occur.
\n
Not all streams will emit the 'close' event as the 'close' event is\noptional.
\n",
                  "params": []
                },
                {
                  "textRaw": "Event: 'drain'",
                  "type": "event",
                  "name": "drain",
                  "desc": "
If a stream.write(chunk) call returns false, then the\n'drain' event will indicate when it is appropriate to begin writing more data\nto the stream.
\n
// Write the data to the supplied writable stream one million times.\n// Be attentive to back-pressure.\nfunction writeOneMillionTimes(writer, data, encoding, callback) {\n  var i = 1000000;\n  write();\n  function write() {\n    var ok = true;\n    do {\n      i -= 1;\n      if (i === 0) {\n        // last time!\n        writer.write(data, encoding, callback);\n      } else {\n        // see if we should continue, or wait\n        // don't pass the callback, because we're not done yet.\n        ok = writer.write(data, encoding);\n      }\n    } while (i > 0 && ok);\n    if (i > 0) {\n      // had to stop early!\n      // write some more once it drains\n      writer.once('drain', write);\n    }\n  }\n}\n
\n",
                  "params": []
                },
                {
                  "textRaw": "Event: 'error'",
                  "type": "event",
                  "name": "error",
                  "params": [],
                  "desc": "
Emitted if there was an error when writing or piping data.
\n"
                },
                {
                  "textRaw": "Event: 'finish'",
                  "type": "event",
                  "name": "finish",
                  "desc": "
When the stream.end() method has been called, and all data has\nbeen flushed to the underlying system, this event is emitted.
\n
var writer = getWritableStreamSomehow();\nfor (var i = 0; i < 100; i ++) {\n  writer.write('hello, #${i}!\\n');\n}\nwriter.end('this is the end\\n');\nwriter.on('finish', () => {\n  console.error('all writes are now complete.');\n});\n
\n",
                  "params": []
                },
                {
                  "textRaw": "Event: 'pipe'",
                  "type": "event",
                  "name": "pipe",
                  "params": [],
                  "desc": "
This is emitted whenever the stream.pipe() method is called on a readable\nstream, adding this writable to its set of destinations.
\n
var writer = getWritableStreamSomehow();\nvar reader = getReadableStreamSomehow();\nwriter.on('pipe', (src) => {\n  console.error('something is piping into the writer');\n  assert.equal(src, reader);\n});\nreader.pipe(writer);\n
\n"
                },
                {
                  "textRaw": "Event: 'unpipe'",
                  "type": "event",
                  "name": "unpipe",
                  "params": [],
                  "desc": "
This is emitted whenever the stream.unpipe() method is called on a\nreadable stream, removing this writable from its set of destinations.
\n
var writer = getWritableStreamSomehow();\nvar reader = getReadableStreamSomehow();\nwriter.on('unpipe', (src) => {\n  console.error('something has stopped piping into the writer');\n  assert.equal(src, reader);\n});\nreader.pipe(writer);\nreader.unpipe(writer);\n
\n"
                }
              ],
              "methods": [
                {
                  "textRaw": "writable.cork()",
                  "type": "method",
                  "name": "cork",
                  "desc": "
Forces buffering of all writes.
\n
Buffered data will be flushed either at stream.uncork() or at\nstream.end() call.
\n",
                  "signatures": [
                    {
                      "params": []
                    }
                  ]
                },
                {
                  "textRaw": "writable.end([chunk][, encoding][, callback])",
                  "type": "method",
                  "name": "end",
                  "signatures": [
                    {
                      "params": [
                        {
                          "textRaw": "`chunk` {String|Buffer} Optional data to write ",
                          "name": "chunk",
                          "type": "String|Buffer",
                          "desc": "Optional data to write",
                          "optional": true
                        },
                        {
                          "textRaw": "`encoding` {String} The encoding, if `chunk` is a String ",
                          "name": "encoding",
                          "type": "String",
                          "desc": "The encoding, if `chunk` is a String",
                          "optional": true
                        },
                        {
                          "textRaw": "`callback` {Function} Optional callback for when the stream is finished ",
                          "name": "callback",
                          "type": "Function",
                          "desc": "Optional callback for when the stream is finished",
                          "optional": true
                        }
                      ]
                    },
                    {
                      "params": [
                        {
                          "name": "chunk",
                          "optional": true
                        },
                        {
                          "name": "encoding",
                          "optional": true
                        },
                        {
                          "name": "callback",
                          "optional": true
                        }
                      ]
                    }
                  ],
                  "desc": "
Call this method when no more data will be written to the stream. If supplied,\nthe callback is attached as a listener on the 'finish' event.
\n
Calling stream.write() after calling\nstream.end() will raise an error.
\n
// write 'hello, ' and then end with 'world!'\nvar file = fs.createWriteStream('example.txt');\nfile.write('hello, ');\nfile.end('world!');\n// writing more now is not allowed!\n
\n"
                },
                {
                  "textRaw": "writable.setDefaultEncoding(encoding)",
                  "type": "method",
                  "name": "setDefaultEncoding",
                  "signatures": [
                    {
                      "params": [
                        {
                          "textRaw": "`encoding` {String} The new default encoding ",
                          "name": "encoding",
                          "type": "String",
                          "desc": "The new default encoding"
                        }
                      ]
                    },
                    {
                      "params": [
                        {
                          "name": "encoding"
                        }
                      ]
                    }
                  ],
                  "desc": "
Sets the default encoding for a writable stream.
\n"
                },
                {
                  "textRaw": "writable.uncork()",
                  "type": "method",
                  "name": "uncork",
                  "desc": "
Flush all data, buffered since stream.cork() call.
\n",
                  "signatures": [
                    {
                      "params": []
                    }
                  ]
                },
                {
                  "textRaw": "writable.write(chunk[, encoding][, callback])",
                  "type": "method",
                  "name": "write",
                  "signatures": [
                    {
                      "return": {
                        "textRaw": "Returns: {Boolean} `true` if the data was handled completely. ",
                        "name": "return",
                        "type": "Boolean",
                        "desc": "`true` if the data was handled completely."
                      },
                      "params": [
                        {
                          "textRaw": "`chunk` {String|Buffer} The data to write ",
                          "name": "chunk",
                          "type": "String|Buffer",
                          "desc": "The data to write"
                        },
                        {
                          "textRaw": "`encoding` {String} The encoding, if `chunk` is a String ",
                          "name": "encoding",
                          "type": "String",
                          "desc": "The encoding, if `chunk` is a String",
                          "optional": true
                        },
                        {
                          "textRaw": "`callback` {Function} Callback for when this chunk of data is flushed ",
                          "name": "callback",
                          "type": "Function",
                          "desc": "Callback for when this chunk of data is flushed",
                          "optional": true
                        }
                      ]
                    },
                    {
                      "params": [
                        {
                          "name": "chunk"
                        },
                        {
                          "name": "encoding",
                          "optional": true
                        },
                        {
                          "name": "callback",
                          "optional": true
                        }
                      ]
                    }
                  ],
                  "desc": "
This method writes some data to the underlying system, and calls the\nsupplied callback once the data has been fully handled.  If an error\noccurs, the callback may or may not be called with the error as its\nfirst argument.  To detect write errors, listen for the 'error' event.
\n
The return value indicates if you should continue writing right now.\nIf the data had to be buffered internally, then it will return\nfalse. Otherwise, it will return true.
\n
This return value is strictly advisory. You MAY continue to write,\neven if it returns false. However, writes will be buffered in\nmemory, so it is best not to do this excessively. Instead, wait for\nthe 'drain' event before writing more data.
\n"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "API for Stream Implementors",
          "name": "API for Stream Implementors",
          "type": "misc",
          "desc": "
To implement any sort of stream, the pattern is the same:
\n
    \n
  1. Extend the appropriate parent class in your own subclass. (The\nutil.inherits() method is particularly helpful for this.)
    2. \n
  2. Call the appropriate parent class constructor in your constructor,\nto be sure that the internal mechanisms are set up properly.
    3. \n
  3. Implement one or more specific methods, as detailed below.
    4. \n
\n
The class to extend and the method(s) to implement depend on the sort\nof stream class you are writing:
\n\n  \n    \n      \n      \n      \n    \n  \n  \n    \n    \n    \n  \n  \n    \n    \n    \n  \n  \n    \n    \n    \n  \n  \n    \n    \n    \n  \n
\n        
Use-case
\n      		\n        
Class
\n      		\n        
Method(s) to implement
\n      
\n      
Reading only
\n    		\n      
Readable
\n    		\n      
_read
\n    
\n      
Writing only
\n    		\n      
Writable
\n    		\n      
_write, _writev
\n    
\n      
Reading and writing
\n    		\n      
Duplex
\n    		\n      
_read, _write, _writev
\n    
\n      
Operate on written data, then read the result
\n    		\n      
Transform
\n    		\n      
_transform, _flush
\n    
\n\n
In your implementation code, it is very important to never call the methods\ndescribed in API for Stream Consumers. Otherwise, you can potentially cause\nadverse side effects in programs that consume your streaming interfaces.
\n",
          "classes": [
            {
              "textRaw": "Class: stream.Duplex",
              "type": "class",
              "name": "stream.Duplex",
              "desc": "
A "duplex" stream is one that is both Readable and Writable, such as a TCP\nsocket connection.
\n
Note that stream.Duplex is an abstract class designed to be extended\nwith an underlying implementation of the stream._read(size)\nand stream._write(chunk, encoding, callback) methods as you\nwould with a Readable or Writable stream class.
\n
Since JavaScript doesn't have multiple prototypal inheritance, this class\nprototypally inherits from Readable, and then parasitically from Writable. It is\nthus up to the user to implement both the low-level\nstream._read(n) method as well as the low-level\nstream._write(chunk, encoding, callback) method on extension\nduplex classes.
\n",
              "methods": [
                {
                  "textRaw": "new stream.Duplex(options)",
                  "type": "method",
                  "name": "Duplex",
                  "signatures": [
                    {
                      "params": [
                        {
                          "textRaw": "`options` {Object} Passed to both Writable and Readable constructors. Also has the following fields: ",
                          "options": [
                            {
                              "textRaw": "`allowHalfOpen` {Boolean} Default = `true`. If set to `false`, then the stream will automatically end the readable side when the writable side ends and vice versa. ",
                              "name": "allowHalfOpen",
                              "type": "Boolean",
                              "desc": "Default = `true`. If set to `false`, then the stream will automatically end the readable side when the writable side ends and vice versa."
                            },
                            {
                              "textRaw": "`readableObjectMode` {Boolean} Default = `false`. Sets `objectMode` for readable side of the stream. Has no effect if `objectMode` is `true`. ",
                              "name": "readableObjectMode",
                              "type": "Boolean",
                              "desc": "Default = `false`. Sets `objectMode` for readable side of the stream. Has no effect if `objectMode` is `true`."
                            },
                            {
                              "textRaw": "`writableObjectMode` {Boolean} Default = `false`. Sets `objectMode` for writable side of the stream. Has no effect if `objectMode` is `true`. ",
                              "name": "writableObjectMode",
                              "type": "Boolean",
                              "desc": "Default = `false`. Sets `objectMode` for writable side of the stream. Has no effect if `objectMode` is `true`."
                            }
                          ],
                          "name": "options",
                          "type": "Object",
                          "desc": "Passed to both Writable and Readable constructors. Also has the following fields:"
                        }
                      ]
                    },
                    {
                      "params": [
                        {
                          "name": "options"
                        }
                      ]
                    }
                  ],
                  "desc": "
In classes that extend the Duplex class, make sure to call the\nconstructor so that the buffering settings can be properly\ninitialized.
\n"
                }
              ]
            },
            {
              "textRaw": "Class: stream.PassThrough",
              "type": "class",
              "name": "stream.PassThrough",
              "desc": "
This is a trivial implementation of a Transform stream that simply\npasses the input bytes across to the output. Its purpose is mainly\nfor examples and testing, but there are occasionally use cases where\nit can come in handy as a building block for novel sorts of streams.
\n"
            },
            {
              "textRaw": "Class: stream.Readable",
              "type": "class",
              "name": "stream.Readable",
              "desc": "
stream.Readable is an abstract class designed to be extended with an\nunderlying implementation of the stream._read(size) method.
\n
Please see API for Stream Consumers for how to consume\nstreams in your programs. What follows is an explanation of how to\nimplement Readable streams in your programs.
\n",
              "methods": [
                {
                  "textRaw": "new stream.Readable([options])",
                  "type": "method",
                  "name": "Readable",
                  "signatures": [
                    {
                      "params": [
                        {
                          "textRaw": "`options` {Object} ",
                          "options": [
                            {
                              "textRaw": "`highWaterMark` {Number} The maximum number of bytes to store in the internal buffer before ceasing to read from the underlying resource. Default = `16384` (16kb), or `16` for `objectMode` streams ",
                              "name": "highWaterMark",
                              "type": "Number",
                              "desc": "The maximum number of bytes to store in the internal buffer before ceasing to read from the underlying resource. Default = `16384` (16kb), or `16` for `objectMode` streams"
                            },
                            {
                              "textRaw": "`encoding` {String} If specified, then buffers will be decoded to strings using the specified encoding. Default = `null` ",
                              "name": "encoding",
                              "type": "String",
                              "desc": "If specified, then buffers will be decoded to strings using the specified encoding. Default = `null`"
                            },
                            {
                              "textRaw": "`objectMode` {Boolean} Whether this stream should behave as a stream of objects. Meaning that [`stream.read(n)`][stream-read] returns a single value instead of a Buffer of size n. Default = `false` ",
                              "name": "objectMode",
                              "type": "Boolean",
                              "desc": "Whether this stream should behave as a stream of objects. Meaning that [`stream.read(n)`][stream-read] returns a single value instead of a Buffer of size n. Default = `false`"
                            },
                            {
                              "textRaw": "`read` {Function} Implementation for the [`stream._read()`][stream-_read] method. ",
                              "name": "read",
                              "type": "Function",
                              "desc": "Implementation for the [`stream._read()`][stream-_read] method."
                            }
                          ],
                          "name": "options",
                          "type": "Object",
                          "optional": true
                        }
                      ]
                    },
                    {
                      "params": [
                        {
                          "name": "options",
                          "optional": true
                        }
                      ]
                    }
                  ],
                  "desc": "
In classes that extend the Readable class, make sure to call the\nReadable constructor so that the buffering settings can be properly\ninitialized.
\n"
                },
                {
                  "textRaw": "readable._read(size)",
                  "type": "method",
                  "name": "_read",
                  "signatures": [
                    {
                      "params": [
                        {
                          "textRaw": "`size` {Number} Number of bytes to read asynchronously ",
                          "name": "size",
                          "type": "Number",
                          "desc": "Number of bytes to read asynchronously"
                        }
                      ]
                    },
                    {
                      "params": [
                        {
                          "name": "size"
                        }
                      ]
                    }
                  ],
                  "desc": "
Note: Implement this method, but do NOT call it directly.
\n
This method is prefixed with an underscore because it is internal to the\nclass that defines it and should only be called by the internal Readable\nclass methods. All Readable stream implementations must provide a _read\nmethod to fetch data from the underlying resource.
\n
When _read() is called, if data is available from the resource, the _read()\nimplementation should start pushing that data into the read queue by calling\nthis.push(dataChunk). _read() should continue reading from\nthe resource and pushing data until push returns false, at which point it\nshould stop reading from the resource. Only when _read() is called again after\nit has stopped should it start reading more data from the resource and pushing\nthat data onto the queue.
\n
Note: once the _read() method is called, it will not be called again until\nthe stream.push() method is called.
\n
The size argument is advisory. Implementations where a "read" is a\nsingle call that returns data can use this to know how much data to\nfetch. Implementations where that is not relevant, such as TCP or\nTLS, may ignore this argument, and simply provide data whenever it\nbecomes available. There is no need, for example to "wait" until\nsize bytes are available before calling stream.push(chunk).
\n"
                }
              ],
              "examples": [
                {
                  "textRaw": "readable.push(chunk[, encoding])",
                  "type": "example",
                  "name": "push",
                  "signatures": [
                    {
                      "return": {
                        "textRaw": "return {Boolean} Whether or not more pushes should be performed ",
                        "name": "return",
                        "type": "Boolean",
                        "desc": "Whether or not more pushes should be performed"
                      },
                      "params": [
                        {
                          "textRaw": "`chunk` {Buffer|Null|String} Chunk of data to push into the read queue ",
                          "name": "chunk",
                          "type": "Buffer|Null|String",
                          "desc": "Chunk of data to push into the read queue"
                        },
                        {
                          "textRaw": "`encoding` {String} Encoding of String chunks.  Must be a valid Buffer encoding, such as `'utf8'` or `'ascii'` ",
                          "name": "encoding",
                          "type": "String",
                          "desc": "Encoding of String chunks.  Must be a valid Buffer encoding, such as `'utf8'` or `'ascii'`",
                          "optional": true
                        }
                      ]
                    }
                  ],
                  "desc": "
Note: This method should be called by Readable implementors, NOT\nby consumers of Readable streams.
\n
If a value other than null is passed, The push() method adds a chunk of data\ninto the queue for subsequent stream processors to consume. If null is\npassed, it signals the end of the stream (EOF), after which no more data\ncan be written.
\n
The data added with push() can be pulled out by calling the\nstream.read() method when the 'readable' event fires.
\n
This API is designed to be as flexible as possible. For example,\nyou may be wrapping a lower-level source which has some sort of\npause/resume mechanism, and a data callback. In those cases, you\ncould wrap the low-level source object by doing something like this:
\n
// source is an object with readStop() and readStart() methods,\n// and an `ondata` member that gets called when it has data, and\n// an `onend` member that gets called when the data is over.\n\nutil.inherits(SourceWrapper, Readable);\n\nfunction SourceWrapper(options) {\n  Readable.call(this, options);\n\n  this._source = getLowlevelSourceObject();\n\n  // Every time there's data, we push it into the internal buffer.\n  this._source.ondata = (chunk) => {\n    // if push() returns false, then we need to stop reading from source\n    if (!this.push(chunk))\n      this._source.readStop();\n  };\n\n  // When the source ends, we push the EOF-signaling `null` chunk\n  this._source.onend = () => {\n    this.push(null);\n  };\n}\n\n// _read will be called when the stream wants to pull more data in\n// the advisory size argument is ignored in this case.\nSourceWrapper.prototype._read = function(size) {\n  this._source.readStart();\n};\n
\n
Example: A Counting Stream
\n
This is a basic example of a Readable stream. It emits the numerals\nfrom 1 to 1,000,000 in ascending order, and then ends.
\n
const Readable = require('stream').Readable;\nconst util = require('util');\nutil.inherits(Counter, Readable);\n\nfunction Counter(opt) {\n  Readable.call(this, opt);\n  this._max = 1000000;\n  this._index = 1;\n}\n\nCounter.prototype._read = function() {\n  var i = this._index++;\n  if (i > this._max)\n    this.push(null);\n  else {\n    var str = '' + i;\n    var buf = new Buffer(str, 'ascii');\n    this.push(buf);\n  }\n};\n
\n
Example: SimpleProtocol v1 (Sub-optimal)
\n
This is similar to the parseHeader function described\nhere, but implemented as a custom stream.\nAlso, note that this implementation does not convert the incoming data to a\nstring.
\n
However, this would be better implemented as a Transform stream. See\nSimpleProtocol v2 for a better implementation.
\n
// A parser for a simple data protocol.\n// The "header" is a JSON object, followed by 2 \\n characters, and\n// then a message body.\n//\n// NOTE: This can be done more simply as a Transform stream!\n// Using Readable directly for this is sub-optimal. See the\n// alternative example below under the Transform section.\n\nconst Readable = require('stream').Readable;\nconst util = require('util');\n\nutil.inherits(SimpleProtocol, Readable);\n\nfunction SimpleProtocol(source, options) {\n  if (!(this instanceof SimpleProtocol))\n    return new SimpleProtocol(source, options);\n\n  Readable.call(this, options);\n  this._inBody = false;\n  this._sawFirstCr = false;\n\n  // source is a readable stream, such as a socket or file\n  this._source = source;\n\n  source.on('end', () => {\n    this.push(null);\n  });\n\n  // give it a kick whenever the source is readable\n  // read(0) will not consume any bytes\n  source.on('readable', () => {\n    this.read(0);\n  });\n\n  this._rawHeader = [];\n  this.header = null;\n}\n\nSimpleProtocol.prototype._read = function(n) {\n  if (!this._inBody) {\n    var chunk = this._source.read();\n\n    // if the source doesn't have data, we don't have data yet.\n    if (chunk === null)\n      return this.push('');\n\n    // check if the chunk has a \\n\\n\n    var split = -1;\n    for (var i = 0; i < chunk.length; i++) {\n      if (chunk[i] === 10) { // '\\n'\n        if (this._sawFirstCr) {\n          split = i;\n          break;\n        } else {\n          this._sawFirstCr = true;\n        }\n      } else {\n        this._sawFirstCr = false;\n      }\n    }\n\n    if (split === -1) {\n      // still waiting for the \\n\\n\n      // stash the chunk, and try again.\n      this._rawHeader.push(chunk);\n      this.push('');\n    } else {\n      this._inBody = true;\n      var h = chunk.slice(0, split);\n      this._rawHeader.push(h);\n      var header = Buffer.concat(this._rawHeader).toString();\n      try {\n        this.header = JSON.parse(header);\n      } catch (er) {\n        this.emit('error', new Error('invalid simple protocol data'));\n        return;\n      }\n      // now, because we got some extra data, unshift the rest\n      // back into the read queue so that our consumer will see it.\n      var b = chunk.slice(split);\n      this.unshift(b);\n      // calling unshift by itself does not reset the reading state\n      // of the stream; since we're inside _read, doing an additional\n      // push('') will reset the state appropriately.\n      this.push('');\n\n      // and let them know that we are done parsing the header.\n      this.emit('header', this.header);\n    }\n  } else {\n    // from there on, just provide the data to our consumer.\n    // careful not to push(null), since that would indicate EOF.\n    var chunk = this._source.read();\n    if (chunk) this.push(chunk);\n  }\n};\n\n// Usage:\n// var parser = new SimpleProtocol(source);\n// Now parser is a readable stream that will emit 'header'\n// with the parsed header data.\n
\n"
                }
              ]
            },
            {
              "textRaw": "Class: stream.Transform",
              "type": "class",
              "name": "stream.Transform",
              "desc": "
A "transform" stream is a duplex stream where the output is causally\nconnected in some way to the input, such as a zlib stream or a\ncrypto stream.
\n
There is no requirement that the output be the same size as the input,\nthe same number of chunks, or arrive at the same time. For example, a\nHash stream will only ever have a single chunk of output which is\nprovided when the input is ended. A zlib stream will produce output\nthat is either much smaller or much larger than its input.
\n
Rather than implement the stream._read() and\nstream._write() methods, Transform classes must implement the\nstream._transform() method, and may optionally\nalso implement the stream._flush() method. (See below.)
\n",
              "methods": [
                {
                  "textRaw": "new stream.Transform([options])",
                  "type": "method",
                  "name": "Transform",
                  "signatures": [
                    {
                      "params": [
                        {
                          "textRaw": "`options` {Object} Passed to both Writable and Readable constructors. Also has the following fields: ",
                          "options": [
                            {
                              "textRaw": "`transform` {Function} Implementation for the [`stream._transform()`][stream-_transform] method. ",
                              "name": "transform",
                              "type": "Function",
                              "desc": "Implementation for the [`stream._transform()`][stream-_transform] method."
                            },
                            {
                              "textRaw": "`flush` {Function} Implementation for the [`stream._flush()`][stream-_flush] method. ",
                              "name": "flush",
                              "type": "Function",
                              "desc": "Implementation for the [`stream._flush()`][stream-_flush] method."
                            }
                          ],
                          "name": "options",
                          "type": "Object",
                          "desc": "Passed to both Writable and Readable constructors. Also has the following fields:",
                          "optional": true
                        }
                      ]
                    },
                    {
                      "params": [
                        {
                          "name": "options",
                          "optional": true
                        }
                      ]
                    }
                  ],
                  "desc": "
In classes that extend the Transform class, make sure to call the\nconstructor so that the buffering settings can be properly\ninitialized.
\n"
                },
                {
                  "textRaw": "transform._flush(callback)",
                  "type": "method",
                  "name": "_flush",
                  "signatures": [
                    {
                      "params": [
                        {
                          "textRaw": "`callback` {Function} Call this function (optionally with an error argument) when you are done flushing any remaining data. ",
                          "name": "callback",
                          "type": "Function",
                          "desc": "Call this function (optionally with an error argument) when you are done flushing any remaining data."
                        }
                      ]
                    },
                    {
                      "params": [
                        {
                          "name": "callback"
                        }
                      ]
                    }
                  ],
                  "desc": "
Note: This function MUST NOT be called directly.  It MAY be implemented\nby child classes, and if so, will be called by the internal Transform\nclass methods only.
\n
In some cases, your transform operation may need to emit a bit more\ndata at the end of the stream. For example, a Zlib compression\nstream will store up some internal state so that it can optimally\ncompress the output. At the end, however, it needs to do the best it\ncan with what is left, so that the data will be complete.
\n
In those cases, you can implement a _flush() method, which will be\ncalled at the very end, after all the written data is consumed, but\nbefore emitting 'end' to signal the end of the readable side. Just\nlike with stream._transform(), call\ntransform.push(chunk) zero or more times, as appropriate, and call callback\nwhen the flush operation is complete.
\n
This method is prefixed with an underscore because it is internal to\nthe class that defines it, and should not be called directly by user\nprograms. However, you are expected to override this method in\nyour own extension classes.
\n"
                },
                {
                  "textRaw": "transform._transform(chunk, encoding, callback)",
                  "type": "method",
                  "name": "_transform",
                  "signatures": [
                    {
                      "params": [
                        {
                          "textRaw": "`chunk` {Buffer|String} The chunk to be transformed. Will **always** be a buffer unless the `decodeStrings` option was set to `false`. ",
                          "name": "chunk",
                          "type": "Buffer|String",
                          "desc": "The chunk to be transformed. Will **always** be a buffer unless the `decodeStrings` option was set to `false`."
                        },
                        {
                          "textRaw": "`encoding` {String} If the chunk is a string, then this is the encoding type. If chunk is a buffer, then this is the special value - 'buffer', ignore it in this case. ",
                          "name": "encoding",
                          "type": "String",
                          "desc": "If the chunk is a string, then this is the encoding type. If chunk is a buffer, then this is the special value - 'buffer', ignore it in this case."
                        },
                        {
                          "textRaw": "`callback` {Function} Call this function (optionally with an error argument and data) when you are done processing the supplied chunk. ",
                          "name": "callback",
                          "type": "Function",
                          "desc": "Call this function (optionally with an error argument and data) when you are done processing the supplied chunk."
                        }
                      ]
                    },
                    {
                      "params": [
                        {
                          "name": "chunk"
                        },
                        {
                          "name": "encoding"
                        },
                        {
                          "name": "callback"
                        }
                      ]
                    }
                  ],
                  "desc": "
Note: This function MUST NOT be called directly.  It should be\nimplemented by child classes, and called by the internal Transform\nclass methods only.
\n
All Transform stream implementations must provide a _transform()\nmethod to accept input and produce output.
\n
_transform() should do whatever has to be done in this specific\nTransform class, to handle the bytes being written, and pass them off\nto the readable portion of the interface. Do asynchronous I/O,\nprocess things, and so on.
\n
Call transform.push(outputChunk) 0 or more times to generate output\nfrom this input chunk, depending on how much data you want to output\nas a result of this chunk.
\n
Call the callback function only when the current chunk is completely\nconsumed. Note that there may or may not be output as a result of any\nparticular input chunk. If you supply a second argument to the callback\nit will be passed to the push method. In other words the following are\nequivalent:
\n
transform.prototype._transform = function (data, encoding, callback) {\n  this.push(data);\n  callback();\n};\n\ntransform.prototype._transform = function (data, encoding, callback) {\n  callback(null, data);\n};\n
\n
This method is prefixed with an underscore because it is internal to\nthe class that defines it, and should not be called directly by user\nprograms. However, you are expected to override this method in\nyour own extension classes.
\n
Example: SimpleProtocol parser v2
\n
The example here of a simple\nprotocol parser can be implemented simply by using the higher level\nTransform stream class, similar to the parseHeader and SimpleProtocol\nv1 examples.
\n
In this example, rather than providing the input as an argument, it\nwould be piped into the parser, which is a more idiomatic Node.js stream\napproach.
\n
const util = require('util');\nconst Transform = require('stream').Transform;\nutil.inherits(SimpleProtocol, Transform);\n\nfunction SimpleProtocol(options) {\n  if (!(this instanceof SimpleProtocol))\n    return new SimpleProtocol(options);\n\n  Transform.call(this, options);\n  this._inBody = false;\n  this._sawFirstCr = false;\n  this._rawHeader = [];\n  this.header = null;\n}\n\nSimpleProtocol.prototype._transform = function(chunk, encoding, done) {\n  if (!this._inBody) {\n    // check if the chunk has a \\n\\n\n    var split = -1;\n    for (var i = 0; i < chunk.length; i++) {\n      if (chunk[i] === 10) { // '\\n'\n        if (this._sawFirstCr) {\n          split = i;\n          break;\n        } else {\n          this._sawFirstCr = true;\n        }\n      } else {\n        this._sawFirstCr = false;\n      }\n    }\n\n    if (split === -1) {\n      // still waiting for the \\n\\n\n      // stash the chunk, and try again.\n      this._rawHeader.push(chunk);\n    } else {\n      this._inBody = true;\n      var h = chunk.slice(0, split);\n      this._rawHeader.push(h);\n      var header = Buffer.concat(this._rawHeader).toString();\n      try {\n        this.header = JSON.parse(header);\n      } catch (er) {\n        this.emit('error', new Error('invalid simple protocol data'));\n        return;\n      }\n      // and let them know that we are done parsing the header.\n      this.emit('header', this.header);\n\n      // now, because we got some extra data, emit this first.\n      this.push(chunk.slice(split));\n    }\n  } else {\n    // from there on, just provide the data to our consumer as-is.\n    this.push(chunk);\n  }\n  done();\n};\n\n// Usage:\n// var parser = new SimpleProtocol();\n// source.pipe(parser)\n// Now parser is a readable stream that will emit 'header'\n// with the parsed header data.\n
\n"
                }
              ],
              "modules": [
                {
                  "textRaw": "Events: 'finish' and 'end'",
                  "name": "events:_'finish'_and_'end'",
                  "desc": "
The 'finish' and 'end' events are from the parent Writable\nand Readable classes respectively. The 'finish' event is fired after\nstream.end() is called and all chunks have been processed by\nstream._transform(), 'end' is fired after all data has\nbeen output which is after the callback in stream._flush()\nhas been called.
\n",
                  "type": "module",
                  "displayName": "Events: 'finish' and 'end'"
                }
              ]
            },
            {
              "textRaw": "Class: stream.Writable",
              "type": "class",
              "name": "stream.Writable",
              "desc": "
stream.Writable is an abstract class designed to be extended with an\nunderlying implementation of the\nstream._write(chunk, encoding, callback) method.
\n
Please see API for Stream Consumers for how to consume\nwritable streams in your programs. What follows is an explanation of\nhow to implement Writable streams in your programs.
\n",
              "methods": [
                {
                  "textRaw": "new stream.Writable([options])",
                  "type": "method",
                  "name": "Writable",
                  "signatures": [
                    {
                      "params": [
                        {
                          "textRaw": "`options` {Object} ",
                          "options": [
                            {
                              "textRaw": "`highWaterMark` {Number} Buffer level when [`stream.write()`][stream-write] starts returning `false`. Default = `16384` (16kb), or `16` for `objectMode` streams. ",
                              "name": "highWaterMark",
                              "type": "Number",
                              "desc": "Buffer level when [`stream.write()`][stream-write] starts returning `false`. Default = `16384` (16kb), or `16` for `objectMode` streams."
                            },
                            {
                              "textRaw": "`decodeStrings` {Boolean} Whether or not to decode strings into Buffers before passing them to [`stream._write()`][stream-_write]. Default = `true` ",
                              "name": "decodeStrings",
                              "type": "Boolean",
                              "desc": "Whether or not to decode strings into Buffers before passing them to [`stream._write()`][stream-_write]. Default = `true`"
                            },
                            {
                              "textRaw": "`objectMode` {Boolean} Whether or not the [`stream.write(anyObj)`][stream-write] is a valid operation. If set you can write arbitrary data instead of only `Buffer` / `String` data. Default = `false` ",
                              "name": "objectMode",
                              "type": "Boolean",
                              "desc": "Whether or not the [`stream.write(anyObj)`][stream-write] is a valid operation. If set you can write arbitrary data instead of only `Buffer` / `String` data. Default = `false`"
                            },
                            {
                              "textRaw": "`write` {Function} Implementation for the [`stream._write()`][stream-_write] method. ",
                              "name": "write",
                              "type": "Function",
                              "desc": "Implementation for the [`stream._write()`][stream-_write] method."
                            },
                            {
                              "textRaw": "`writev` {Function} Implementation for the [`stream._writev()`][stream-_writev] method. ",
                              "name": "writev",
                              "type": "Function",
                              "desc": "Implementation for the [`stream._writev()`][stream-_writev] method."
                            }
                          ],
                          "name": "options",
                          "type": "Object",
                          "optional": true
                        }
                      ]
                    },
                    {
                      "params": [
                        {
                          "name": "options",
                          "optional": true
                        }
                      ]
                    }
                  ],
                  "desc": "
In classes that extend the Writable class, make sure to call the\nconstructor so that the buffering settings can be properly\ninitialized.
\n"
                },
                {
                  "textRaw": "writable._write(chunk, encoding, callback)",
                  "type": "method",
                  "name": "_write",
                  "signatures": [
                    {
                      "params": [
                        {
                          "textRaw": "`chunk` {Buffer|String} The chunk to be written. Will **always** be a buffer unless the `decodeStrings` option was set to `false`. ",
                          "name": "chunk",
                          "type": "Buffer|String",
                          "desc": "The chunk to be written. Will **always** be a buffer unless the `decodeStrings` option was set to `false`."
                        },
                        {
                          "textRaw": "`encoding` {String} If the chunk is a string, then this is the encoding type. If chunk is a buffer, then this is the special value - 'buffer', ignore it in this case. ",
                          "name": "encoding",
                          "type": "String",
                          "desc": "If the chunk is a string, then this is the encoding type. If chunk is a buffer, then this is the special value - 'buffer', ignore it in this case."
                        },
                        {
                          "textRaw": "`callback` {Function} Call this function (optionally with an error argument) when you are done processing the supplied chunk. ",
                          "name": "callback",
                          "type": "Function",
                          "desc": "Call this function (optionally with an error argument) when you are done processing the supplied chunk."
                        }
                      ]
                    },
                    {
                      "params": [
                        {
                          "name": "chunk"
                        },
                        {
                          "name": "encoding"
                        },
                        {
                          "name": "callback"
                        }
                      ]
                    }
                  ],
                  "desc": "
All Writable stream implementations must provide a\nstream._write() method to send data to the underlying\nresource.
\n
Note: This function MUST NOT be called directly.  It should be\nimplemented by child classes, and called by the internal Writable\nclass methods only.
\n
Call the callback using the standard callback(error) pattern to\nsignal that the write completed successfully or with an error.
\n
If the decodeStrings flag is set in the constructor options, then\nchunk may be a string rather than a Buffer, and encoding will\nindicate the sort of string that it is. This is to support\nimplementations that have an optimized handling for certain string\ndata encodings. If you do not explicitly set the decodeStrings\noption to false, then you can safely ignore the encoding argument,\nand assume that chunk will always be a Buffer.
\n
This method is prefixed with an underscore because it is internal to\nthe class that defines it, and should not be called directly by user\nprograms. However, you are expected to override this method in\nyour own extension classes.
\n"
                },
                {
                  "textRaw": "writable._writev(chunks, callback)",
                  "type": "method",
                  "name": "_writev",
                  "signatures": [
                    {
                      "params": [
                        {
                          "textRaw": "`chunks` {Array} The chunks to be written. Each chunk has following format: `{ chunk: ..., encoding: ... }`. ",
                          "name": "chunks",
                          "type": "Array",
                          "desc": "The chunks to be written. Each chunk has following format: `{ chunk: ..., encoding: ... }`."
                        },
                        {
                          "textRaw": "`callback` {Function} Call this function (optionally with an error argument) when you are done processing the supplied chunks. ",
                          "name": "callback",
                          "type": "Function",
                          "desc": "Call this function (optionally with an error argument) when you are done processing the supplied chunks."
                        }
                      ]
                    },
                    {
                      "params": [
                        {
                          "name": "chunks"
                        },
                        {
                          "name": "callback"
                        }
                      ]
                    }
                  ],
                  "desc": "
Note: This function MUST NOT be called directly.  It may be\nimplemented by child classes, and called by the internal Writable\nclass methods only.
\n
This function is completely optional to implement. In most cases it is\nunnecessary. If implemented, it will be called with all the chunks\nthat are buffered in the write queue.
\n"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "Simplified Constructor API",
          "name": "Simplified Constructor API",
          "type": "misc",
          "desc": "
In simple cases there is now the added benefit of being able to construct a\nstream without inheritance.
\n
This can be done by passing the appropriate methods as constructor options:
\n
Examples:
\n",
          "miscs": [
            {
              "textRaw": "Duplex",
              "name": "duplex",
              "desc": "
var duplex = new stream.Duplex({\n  read: function(n) {\n    // sets this._read under the hood\n\n    // push data onto the read queue, passing null\n    // will signal the end of the stream (EOF)\n    this.push(chunk);\n  },\n  write: function(chunk, encoding, next) {\n    // sets this._write under the hood\n\n    // An optional error can be passed as the first argument\n    next()\n  }\n});\n\n// or\n\nvar duplex = new stream.Duplex({\n  read: function(n) {\n    // sets this._read under the hood\n\n    // push data onto the read queue, passing null\n    // will signal the end of the stream (EOF)\n    this.push(chunk);\n  },\n  writev: function(chunks, next) {\n    // sets this._writev under the hood\n\n    // An optional error can be passed as the first argument\n    next()\n  }\n});\n
\n",
              "type": "misc",
              "displayName": "Duplex"
            },
            {
              "textRaw": "Readable",
              "name": "readable",
              "desc": "
var readable = new stream.Readable({\n  read: function(n) {\n    // sets this._read under the hood\n\n    // push data onto the read queue, passing null\n    // will signal the end of the stream (EOF)\n    this.push(chunk);\n  }\n});\n
\n",
              "type": "misc",
              "displayName": "Readable"
            },
            {
              "textRaw": "Transform",
              "name": "transform",
              "desc": "
var transform = new stream.Transform({\n  transform: function(chunk, encoding, next) {\n    // sets this._transform under the hood\n\n    // generate output as many times as needed\n    // this.push(chunk);\n\n    // call when the current chunk is consumed\n    next();\n  },\n  flush: function(done) {\n    // sets this._flush under the hood\n\n    // generate output as many times as needed\n    // this.push(chunk);\n\n    done();\n  }\n});\n
\n",
              "type": "misc",
              "displayName": "Transform"
            },
            {
              "textRaw": "Writable",
              "name": "writable",
              "desc": "
var writable = new stream.Writable({\n  write: function(chunk, encoding, next) {\n    // sets this._write under the hood\n\n    // An optional error can be passed as the first argument\n    next()\n  }\n});\n\n// or\n\nvar writable = new stream.Writable({\n  writev: function(chunks, next) {\n    // sets this._writev under the hood\n\n    // An optional error can be passed as the first argument\n    next()\n  }\n});\n
\n",
              "type": "misc",
              "displayName": "Writable"
            }
          ]
        },
        {
          "textRaw": "Streams: Under the Hood",
          "name": "Streams: Under the Hood",
          "type": "misc",
          "miscs": [
            {
              "textRaw": "Buffering",
              "name": "Buffering",
              "type": "misc",
              "desc": "
Both Writable and Readable streams will buffer data on an internal\nobject which can be retrieved from _writableState.getBuffer() or\n_readableState.buffer, respectively.
\n
The amount of data that will potentially be buffered depends on the\nhighWaterMark option which is passed into the constructor.
\n
Buffering in Readable streams happens when the implementation calls\nstream.push(chunk). If the consumer of the Stream does not\ncall stream.read(), then the data will sit in the internal\nqueue until it is consumed.
\n
Buffering in Writable streams happens when the user calls\nstream.write(chunk) repeatedly, even when it returns false.
\n
The purpose of streams, especially with the stream.pipe() method, is to\nlimit the buffering of data to acceptable levels, so that sources and\ndestinations of varying speed will not overwhelm the available memory.
\n"
            },
            {
              "textRaw": "Compatibility with Older Node.js Versions",
              "name": "Compatibility with Older Node.js Versions",
              "type": "misc",
              "desc": "
In versions of Node.js prior to v0.10, the Readable stream interface was\nsimpler, but also less powerful and less useful.
\n
    \n
  • Rather than waiting for you to call the stream.read() method,\n'data' events would start emitting immediately. If you needed to do\nsome I/O to decide how to handle data, then you had to store the chunks\nin some kind of buffer so that they would not be lost.
    • \n
  • The stream.pause() method was advisory, rather than\nguaranteed. This meant that you still had to be prepared to receive\n'data' events even when the stream was in a paused state.
    • \n
\n
In Node.js v0.10, the Readable class was added.\nFor backwards compatibility with older Node.js programs, Readable streams\nswitch into "flowing mode" when a 'data' event handler is added, or\nwhen the stream.resume() method is called. The effect is\nthat, even if you are not using the new stream.read() method\nand 'readable' event, you no longer have to worry about losing\n'data' chunks.
\n
Most programs will continue to function normally. However, this\nintroduces an edge case in the following conditions:
\n
    \n
  • No 'data' event handler is added.
    • \n
  • The stream.resume() method is never called.
    • \n
  • The stream is not piped to any writable destination.
    • \n
\n
For example, consider the following code:
\n
// WARNING!  BROKEN!\nnet.createServer((socket) => {\n\n  // we add an 'end' method, but never consume the data\n  socket.on('end', () => {\n    // It will never get here.\n    socket.end('I got your message (but didnt read it)\\n');\n  });\n\n}).listen(1337);\n
\n
In versions of Node.js prior to v0.10, the incoming message data would be\nsimply discarded. However, in Node.js v0.10 and beyond,\nthe socket will remain paused forever.
\n
The workaround in this situation is to call the\nstream.resume() method to start the flow of data:
\n
// Workaround\nnet.createServer((socket) => {\n\n  socket.on('end', () => {\n    socket.end('I got your message (but didnt read it)\\n');\n  });\n\n  // start the flow of data, discarding it.\n  socket.resume();\n\n}).listen(1337);\n
\n
In addition to new Readable streams switching into flowing mode,\npre-v0.10 style streams can be wrapped in a Readable class using the\nstream.wrap() method.
\n"
            },
            {
              "textRaw": "Object Mode",
              "name": "Object Mode",
              "type": "misc",
              "desc": "
Normally, Streams operate on Strings and Buffers exclusively.
\n
Streams that are in object mode can emit generic JavaScript values\nother than Buffers and Strings.
\n
A Readable stream in object mode will always return a single item from\na call to stream.read(size), regardless of what the size\nargument is.
\n
A Writable stream in object mode will always ignore the encoding\nargument to stream.write(data, encoding).
\n
The special value null still retains its special value for object\nmode streams. That is, for object mode readable streams, null as a\nreturn value from stream.read() indicates that there is no more\ndata, and stream.push(null) will signal the end of stream data\n(EOF).
\n
No streams in Node.js core are object mode streams. This pattern is only\nused by userland streaming libraries.
\n
You should set objectMode in your stream child class constructor on\nthe options object. Setting objectMode mid-stream is not safe.
\n
For Duplex streams objectMode can be set exclusively for readable or\nwritable side with readableObjectMode and writableObjectMode\nrespectively. These options can be used to implement parsers and\nserializers with Transform streams.
\n
const util = require('util');\nconst StringDecoder = require('string_decoder').StringDecoder;\nconst Transform = require('stream').Transform;\nutil.inherits(JSONParseStream, Transform);\n\n// Gets \\n-delimited JSON string data, and emits the parsed objects\nfunction JSONParseStream() {\n  if (!(this instanceof JSONParseStream))\n    return new JSONParseStream();\n\n  Transform.call(this, { readableObjectMode : true });\n\n  this._buffer = '';\n  this._decoder = new StringDecoder('utf8');\n}\n\nJSONParseStream.prototype._transform = function(chunk, encoding, cb) {\n  this._buffer += this._decoder.write(chunk);\n  // split on newlines\n  var lines = this._buffer.split(/\\r?\\n/);\n  // keep the last partial line buffered\n  this._buffer = lines.pop();\n  for (var l = 0; l < lines.length; l++) {\n    var line = lines[l];\n    try {\n      var obj = JSON.parse(line);\n    } catch (er) {\n      this.emit('error', er);\n      return;\n    }\n    // push the parsed object out to the readable consumer\n    this.push(obj);\n  }\n  cb();\n};\n\nJSONParseStream.prototype._flush = function(cb) {\n  // Just handle any leftover\n  var rem = this._buffer.trim();\n  if (rem) {\n    try {\n      var obj = JSON.parse(rem);\n    } catch (er) {\n      this.emit('error', er);\n      return;\n    }\n    // push the parsed object out to the readable consumer\n    this.push(obj);\n  }\n  cb();\n};\n
\n"
            },
            {
              "textRaw": "`stream.read(0)`",
              "name": "`stream.read(0)`",
              "desc": "
There are some cases where you want to trigger a refresh of the\nunderlying readable stream mechanisms, without actually consuming any\ndata. In that case, you can call stream.read(0), which will always\nreturn null.
\n
If the internal read buffer is below the highWaterMark, and the\nstream is not currently reading, then calling stream.read(0) will trigger\na low-level stream._read() call.
\n
There is almost never a need to do this. However, you will see some\ncases in Node.js's internals where this is done, particularly in the\nReadable stream class internals.
\n",
              "type": "misc",
              "displayName": "`stream.read(0)`"
            },
            {
              "textRaw": "`stream.push('')`",
              "name": "`stream.push('')`",
              "desc": "
Pushing a zero-byte string or Buffer (when not in Object mode) has an\ninteresting side effect. Because it is a call to\nstream.push(), it will end the reading process. However, it\ndoes not add any data to the readable buffer, so there's nothing for\na user to consume.
\n
Very rarely, there are cases where you have no data to provide now,\nbut the consumer of your stream (or, perhaps, another bit of your own\ncode) will know when to check again, by calling stream.read(0).\nIn those cases, you may call stream.push('').
\n
So far, the only use case for this functionality is in the\ntls.CryptoStream class, which is deprecated in Node.js/io.js v1.0. If you\nfind that you have to use stream.push(''), please consider another\napproach, because it almost certainly indicates that something is\nhorribly wrong.
\n",
              "type": "misc",
              "displayName": "`stream.push('')`"
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "Stream"
    }
  ]
}
node-v4.8.2/doc/api/stream.md000644 000766 000024 00000160706 13070706735 016125 0ustar00iojsstaff000000 000000 # Stream

> Stability: 2 - Stable

A stream is an abstract interface implemented by various objects in
Node.js. For example a [request to an HTTP server][http-incoming-message] is a
stream, as is [`process.stdout`][]. Streams are readable, writable, or both. All
streams are instances of [`EventEmitter`][].

You can load the Stream base classes by doing `require('stream')`.
There are base classes provided for [Readable][] streams, [Writable][]
streams, [Duplex][] streams, and [Transform][] streams.

This document is split up into 3 sections:

1. The first section explains the parts of the API that you need to be
   aware of to use streams in your programs.
2. The second section explains the parts of the API that you need to
   use if you implement your own custom streams yourself. The API is designed to
   make this easy for you to do.
3. The third section goes into more depth about how streams work,
   including some of the internal mechanisms and functions that you
   should probably not modify unless you definitely know what you are
   doing.


## API for Stream Consumers



Streams can be either [Readable][], [Writable][], or both ([Duplex][]).

All streams are EventEmitters, but they also have other custom methods
and properties depending on whether they are Readable, Writable, or
Duplex.

If a stream is both Readable and Writable, then it implements all of
the methods and events. So, a [Duplex][] or [Transform][] stream is
fully described by this API, though their implementation may be
somewhat different.

It is not necessary to implement Stream interfaces in order to consume
streams in your programs. If you **are** implementing streaming
interfaces in your own program, please also refer to
[API for Stream Implementors][].

Almost all Node.js programs, no matter how simple, use Streams in some
way. Here is an example of using Streams in an Node.js program:

```js
const http = require('http');

var server = http.createServer( (req, res) => {
  // req is an http.IncomingMessage, which is a Readable Stream
  // res is an http.ServerResponse, which is a Writable Stream

  var body = '';
  // we want to get the data as utf8 strings
  // If you don't set an encoding, then you'll get Buffer objects
  req.setEncoding('utf8');

  // Readable streams emit 'data' events once a listener is added
  req.on('data', (chunk) => {
    body += chunk;
  });

  // the end event tells you that you have entire body
  req.on('end', () => {
    try {
      const data = JSON.parse(body);
      // write back something interesting to the user:
      res.write(typeof data);
      res.end();
    } catch (er) {
      // uh oh!  bad json!
      res.statusCode = 400;
      return res.end(`error: ${er.message}`);
    }
  });
});

server.listen(1337);

// $ curl localhost:1337 -d '{}'
// object
// $ curl localhost:1337 -d '"foo"'
// string
// $ curl localhost:1337 -d 'not json'
// error: Unexpected token o
```

### Class: stream.Duplex

Duplex streams are streams that implement both the [Readable][] and
[Writable][] interfaces.

Examples of Duplex streams include:

* [TCP sockets][]
* [zlib streams][zlib]
* [crypto streams][crypto]

### Class: stream.Readable



The Readable stream interface is the abstraction for a *source* of
data that you are reading from. In other words, data comes *out* of a
Readable stream.

A Readable stream will not start emitting data until you indicate that
you are ready to receive it.

Readable streams have two "modes": a **flowing mode** and a **paused
mode**. When in flowing mode, data is read from the underlying system
and provided to your program as fast as possible. In paused mode, you
must explicitly call [`stream.read()`][stream-read] to get chunks of data out.
Streams start out in paused mode.

**Note**: If no data event handlers are attached, and there are no
[`stream.pipe()`][] destinations, and the stream is switched into flowing
mode, then data will be lost.

You can switch to flowing mode by doing any of the following:

* Adding a [`'data'`][] event handler to listen for data.
* Calling the [`stream.resume()`][stream-resume] method to explicitly open the
  flow.
* Calling the [`stream.pipe()`][] method to send the data to a [Writable][].

You can switch back to paused mode by doing either of the following:

* If there are no pipe destinations, by calling the
  [`stream.pause()`][stream-pause] method.
* If there are pipe destinations, by removing any [`'data'`][] event
  handlers, and removing all pipe destinations by calling the
  [`stream.unpipe()`][] method.

Note that, for backwards compatibility reasons, removing [`'data'`][]
event handlers will **not** automatically pause the stream. Also, if
there are piped destinations, then calling [`stream.pause()`][stream-pause] will
not guarantee that the stream will *remain* paused once those
destinations drain and ask for more data.

Examples of readable streams include:

* [HTTP responses, on the client][http-incoming-message]
* [HTTP requests, on the server][http-incoming-message]
* [fs read streams][]
* [zlib streams][zlib]
* [crypto streams][crypto]
* [TCP sockets][]
* [child process stdout and stderr][]
* [`process.stdin`][]

#### Event: 'close'

Emitted when the stream and any of its underlying resources (a file
descriptor, for example) have been closed. The event indicates that
no more events will be emitted, and no further computation will occur.

Not all streams will emit the `'close'` event as the `'close'` event is
optional.

#### Event: 'data'

* `chunk` {Buffer|String} The chunk of data.

Attaching a `'data'` event listener to a stream that has not been
explicitly paused will switch the stream into flowing mode. Data will
then be passed as soon as it is available.

If you just want to get all the data out of the stream as fast as
possible, this is the best way to do so.

```js
var readable = getReadableStreamSomehow();
readable.on('data', (chunk) => {
  console.log('got %d bytes of data', chunk.length);
});
```

#### Event: 'end'

This event fires when there will be no more data to read.

Note that the `'end'` event **will not fire** unless the data is
completely consumed. This can be done by switching into flowing mode,
or by calling [`stream.read()`][stream-read] repeatedly until you get to the
end.

```js
var readable = getReadableStreamSomehow();
readable.on('data', (chunk) => {
  console.log('got %d bytes of data', chunk.length);
});
readable.on('end', () => {
  console.log('there will be no more data.');
});
```

#### Event: 'error'

* {Error}

Emitted if there was an error receiving data.

#### Event: 'readable'

When a chunk of data can be read from the stream, it will emit a
`'readable'` event.

In some cases, listening for a `'readable'` event will cause some data
to be read into the internal buffer from the underlying system, if it
hadn't already.

```javascript
var readable = getReadableStreamSomehow();
readable.on('readable', () => {
  // there is some data to read now
});
```

Once the internal buffer is drained, a `'readable'` event will fire
again when more data is available.

The `'readable'` event is not emitted in the "flowing" mode with the
sole exception of the last one, on end-of-stream.

The `'readable'` event indicates that the stream has new information:
either new data is available or the end of the stream has been reached.
In the former case, [`stream.read()`][stream-read] will return that data. In the
latter case, [`stream.read()`][stream-read] will return null. For instance, in
the following example, `foo.txt` is an empty file:

```js
const fs = require('fs');
var rr = fs.createReadStream('foo.txt');
rr.on('readable', () => {
  console.log('readable:', rr.read());
});
rr.on('end', () => {
  console.log('end');
});
```

The output of running this script is:

```
$ node test.js
readable: null
end
```

#### readable.isPaused()

* Returns: {Boolean}

This method returns whether or not the `readable` has been **explicitly**
paused by client code (using [`stream.pause()`][stream-pause] without a
corresponding [`stream.resume()`][stream-resume]).

```js
var readable = new stream.Readable

readable.isPaused() // === false
readable.pause()
readable.isPaused() // === true
readable.resume()
readable.isPaused() // === false
```

#### readable.pause()

* Returns: `this`

This method will cause a stream in flowing mode to stop emitting
[`'data'`][] events, switching out of flowing mode. Any data that becomes
available will remain in the internal buffer.

```js
var readable = getReadableStreamSomehow();
readable.on('data', (chunk) => {
  console.log('got %d bytes of data', chunk.length);
  readable.pause();
  console.log('there will be no more data for 1 second');
  setTimeout(() => {
    console.log('now data will start flowing again');
    readable.resume();
  }, 1000);
});
```

#### readable.pipe(destination[, options])

* `destination` {stream.Writable} The destination for writing data
* `options` {Object} Pipe options
  * `end` {Boolean} End the writer when the reader ends. Default = `true`

This method pulls all the data out of a readable stream, and writes it
to the supplied destination, automatically managing the flow so that
the destination is not overwhelmed by a fast readable stream.

Multiple destinations can be piped to safely.

```js
var readable = getReadableStreamSomehow();
var writable = fs.createWriteStream('file.txt');
// All the data from readable goes into 'file.txt'
readable.pipe(writable);
```

This function returns the destination stream, so you can set up pipe
chains like so:

```js
var r = fs.createReadStream('file.txt');
var z = zlib.createGzip();
var w = fs.createWriteStream('file.txt.gz');
r.pipe(z).pipe(w);
```

For example, emulating the Unix `cat` command:

```js
process.stdin.pipe(process.stdout);
```

By default [`stream.end()`][stream-end] is called on the destination when the
source stream emits [`'end'`][], so that `destination` is no longer writable.
Pass `{ end: false }` as `options` to keep the destination stream open.

This keeps `writer` open so that "Goodbye" can be written at the
end.

```js
reader.pipe(writer, { end: false });
reader.on('end', () => {
  writer.end('Goodbye\n');
});
```

Note that [`process.stderr`][] and [`process.stdout`][] are never closed until
the process exits, regardless of the specified options.

#### readable.read([size])

* `size` {Number} Optional argument to specify how much data to read.
* Return {String|Buffer|Null}

The `read()` method pulls some data out of the internal buffer and
returns it. If there is no data available, then it will return
`null`.

If you pass in a `size` argument, then it will return that many
bytes. If `size` bytes are not available, then it will return `null`,
unless we've ended, in which case it will return the data remaining
in the buffer.

If you do not specify a `size` argument, then it will return all the
data in the internal buffer.

This method should only be called in paused mode. In flowing mode,
this method is called automatically until the internal buffer is
drained.

```js
var readable = getReadableStreamSomehow();
readable.on('readable', () => {
  var chunk;
  while (null !== (chunk = readable.read())) {
    console.log('got %d bytes of data', chunk.length);
  }
});
```

If this method returns a data chunk, then it will also trigger the
emission of a [`'data'`][] event.

Note that calling [`stream.read([size])`][stream-read] after the [`'end'`][]
event has been triggered will return `null`. No runtime error will be raised.

#### readable.resume()

* Returns: `this`

This method will cause the readable stream to resume emitting [`'data'`][]
events.

This method will switch the stream into flowing mode. If you do *not*
want to consume the data from a stream, but you *do* want to get to
its [`'end'`][] event, you can call [`stream.resume()`][stream-resume] to open
the flow of data.

```js
var readable = getReadableStreamSomehow();
readable.resume();
readable.on('end', () => {
  console.log('got to the end, but did not read anything');
});
```

#### readable.setEncoding(encoding)

* `encoding` {String} The encoding to use.
* Returns: `this`

Call this function to cause the stream to return strings of the specified
encoding instead of Buffer objects. For example, if you do
`readable.setEncoding('utf8')`, then the output data will be interpreted as
UTF-8 data, and returned as strings. If you do `readable.setEncoding('hex')`,
then the data will be encoded in hexadecimal string format.

This properly handles multi-byte characters that would otherwise be
potentially mangled if you simply pulled the Buffers directly and
called [`buf.toString(encoding)`][] on them. If you want to read the data
as strings, always use this method.

Also you can disable any encoding at all with `readable.setEncoding(null)`.
This approach is very useful if you deal with binary data or with large
multi-byte strings spread out over multiple chunks.

```js
var readable = getReadableStreamSomehow();
readable.setEncoding('utf8');
readable.on('data', (chunk) => {
  assert.equal(typeof chunk, 'string');
  console.log('got %d characters of string data', chunk.length);
});
```

#### readable.unpipe([destination])

* `destination` {stream.Writable} Optional specific stream to unpipe

This method will remove the hooks set up for a previous [`stream.pipe()`][]
call.

If the destination is not specified, then all pipes are removed.

If the destination is specified, but no pipe is set up for it, then
this is a no-op.

```js
var readable = getReadableStreamSomehow();
var writable = fs.createWriteStream('file.txt');
// All the data from readable goes into 'file.txt',
// but only for the first second
readable.pipe(writable);
setTimeout(() => {
  console.log('stop writing to file.txt');
  readable.unpipe(writable);
  console.log('manually close the file stream');
  writable.end();
}, 1000);
```

#### readable.unshift(chunk)

* `chunk` {Buffer|String} Chunk of data to unshift onto the read queue

This is useful in certain cases where a stream is being consumed by a
parser, which needs to "un-consume" some data that it has
optimistically pulled out of the source, so that the stream can be
passed on to some other party.

Note that `stream.unshift(chunk)` cannot be called after the [`'end'`][] event
has been triggered; a runtime error will be raised.

If you find that you must often call `stream.unshift(chunk)` in your
programs, consider implementing a [Transform][] stream instead. (See [API
for Stream Implementors][].)

```js
// Pull off a header delimited by \n\n
// use unshift() if we get too much
// Call the callback with (error, header, stream)
const StringDecoder = require('string_decoder').StringDecoder;
function parseHeader(stream, callback) {
  stream.on('error', callback);
  stream.on('readable', onReadable);
  var decoder = new StringDecoder('utf8');
  var header = '';
  function onReadable() {
    var chunk;
    while (null !== (chunk = stream.read())) {
      var str = decoder.write(chunk);
      if (str.match(/\n\n/)) {
        // found the header boundary
        var split = str.split(/\n\n/);
        header += split.shift();
        var remaining = split.join('\n\n');
        var buf = new Buffer(remaining, 'utf8');
        if (buf.length)
          stream.unshift(buf);
        stream.removeListener('error', callback);
        stream.removeListener('readable', onReadable);
        // now the body of the message can be read from the stream.
        callback(null, header, stream);
      } else {
        // still reading the header.
        header += str;
      }
    }
  }
}
```

Note that, unlike [`stream.push(chunk)`][stream-push], `stream.unshift(chunk)`
will not end the reading process by resetting the internal reading state of the
stream. This can cause unexpected results if `unshift()` is called during a
read (i.e. from within a [`stream._read()`][stream-_read] implementation on a
custom stream). Following the call to `unshift()` with an immediate
[`stream.push('')`][stream-push] will reset the reading state appropriately,
however it is best to simply avoid calling `unshift()` while in the process of
performing a read.

#### readable.wrap(stream)

* `stream` {Stream} An "old style" readable stream

Versions of Node.js prior to v0.10 had streams that did not implement the
entire Streams API as it is today. (See [Compatibility][] for
more information.)

If you are using an older Node.js library that emits [`'data'`][] events and
has a [`stream.pause()`][stream-pause] method that is advisory only, then you
can use the `wrap()` method to create a [Readable][] stream that uses the old
stream as its data source.

You will very rarely ever need to call this function, but it exists
as a convenience for interacting with old Node.js programs and libraries.

For example:

```js
const OldReader = require('./old-api-module.js').OldReader;
const Readable = require('stream').Readable;
const oreader = new OldReader;
const myReader = new Readable().wrap(oreader);

myReader.on('readable', () => {
  myReader.read(); // etc.
});
```

### Class: stream.Transform

Transform streams are [Duplex][] streams where the output is in some way
computed from the input. They implement both the [Readable][] and
[Writable][] interfaces.

Examples of Transform streams include:

* [zlib streams][zlib]
* [crypto streams][crypto]

### Class: stream.Writable



The Writable stream interface is an abstraction for a *destination*
that you are writing data *to*.

Examples of writable streams include:

* [HTTP requests, on the client][]
* [HTTP responses, on the server][]
* [fs write streams][]
* [zlib streams][zlib]
* [crypto streams][crypto]
* [TCP sockets][]
* [child process stdin][]
* [`process.stdout`][], [`process.stderr`][]

#### Event: 'close'

Emitted when the stream and any of its underlying resources (a file descriptor,
for example) have been closed. The event indicates that no more events will be
emitted, and no further computation will occur.

Not all streams will emit the `'close'` event as the `'close'` event is
optional.

#### Event: 'drain'

If a [`stream.write(chunk)`][stream-write] call returns `false`, then the
`'drain'` event will indicate when it is appropriate to begin writing more data
to the stream.

```js
// Write the data to the supplied writable stream one million times.
// Be attentive to back-pressure.
function writeOneMillionTimes(writer, data, encoding, callback) {
  var i = 1000000;
  write();
  function write() {
    var ok = true;
    do {
      i -= 1;
      if (i === 0) {
        // last time!
        writer.write(data, encoding, callback);
      } else {
        // see if we should continue, or wait
        // don't pass the callback, because we're not done yet.
        ok = writer.write(data, encoding);
      }
    } while (i > 0 && ok);
    if (i > 0) {
      // had to stop early!
      // write some more once it drains
      writer.once('drain', write);
    }
  }
}
```

#### Event: 'error'

* {Error}

Emitted if there was an error when writing or piping data.

#### Event: 'finish'

When the [`stream.end()`][stream-end] method has been called, and all data has
been flushed to the underlying system, this event is emitted.

```javascript
var writer = getWritableStreamSomehow();
for (var i = 0; i < 100; i ++) {
  writer.write('hello, #${i}!\n');
}
writer.end('this is the end\n');
writer.on('finish', () => {
  console.error('all writes are now complete.');
});
```

#### Event: 'pipe'

* `src` {stream.Readable} source stream that is piping to this writable

This is emitted whenever the [`stream.pipe()`][] method is called on a readable
stream, adding this writable to its set of destinations.

```js
var writer = getWritableStreamSomehow();
var reader = getReadableStreamSomehow();
writer.on('pipe', (src) => {
  console.error('something is piping into the writer');
  assert.equal(src, reader);
});
reader.pipe(writer);
```

#### Event: 'unpipe'

* `src` {[Readable][] Stream} The source stream that
  [unpiped][`stream.unpipe()`] this writable

This is emitted whenever the [`stream.unpipe()`][] method is called on a
readable stream, removing this writable from its set of destinations.

```js
var writer = getWritableStreamSomehow();
var reader = getReadableStreamSomehow();
writer.on('unpipe', (src) => {
  console.error('something has stopped piping into the writer');
  assert.equal(src, reader);
});
reader.pipe(writer);
reader.unpipe(writer);
```

#### writable.cork()

Forces buffering of all writes.

Buffered data will be flushed either at [`stream.uncork()`][] or at
[`stream.end()`][stream-end] call.

#### writable.end([chunk][, encoding][, callback])

* `chunk` {String|Buffer} Optional data to write
* `encoding` {String} The encoding, if `chunk` is a String
* `callback` {Function} Optional callback for when the stream is finished

Call this method when no more data will be written to the stream. If supplied,
the callback is attached as a listener on the [`'finish'`][] event.

Calling [`stream.write()`][stream-write] after calling
[`stream.end()`][stream-end] will raise an error.

```js
// write 'hello, ' and then end with 'world!'
var file = fs.createWriteStream('example.txt');
file.write('hello, ');
file.end('world!');
// writing more now is not allowed!
```

#### writable.setDefaultEncoding(encoding)

* `encoding` {String} The new default encoding

Sets the default encoding for a writable stream.

#### writable.uncork()

Flush all data, buffered since [`stream.cork()`][] call.

#### writable.write(chunk[, encoding][, callback])

* `chunk` {String|Buffer} The data to write
* `encoding` {String} The encoding, if `chunk` is a String
* `callback` {Function} Callback for when this chunk of data is flushed
* Returns: {Boolean} `true` if the data was handled completely.

This method writes some data to the underlying system, and calls the
supplied callback once the data has been fully handled.  If an error
occurs, the callback may or may not be called with the error as its
first argument.  To detect write errors, listen for the `'error'` event.

The return value indicates if you should continue writing right now.
If the data had to be buffered internally, then it will return
`false`. Otherwise, it will return `true`.

This return value is strictly advisory. You MAY continue to write,
even if it returns `false`. However, writes will be buffered in
memory, so it is best not to do this excessively. Instead, wait for
the [`'drain'`][] event before writing more data.


## API for Stream Implementors



To implement any sort of stream, the pattern is the same:

1. Extend the appropriate parent class in your own subclass. (The
   [`util.inherits()`][] method is particularly helpful for this.)
2. Call the appropriate parent class constructor in your constructor,
   to be sure that the internal mechanisms are set up properly.
3. Implement one or more specific methods, as detailed below.

The class to extend and the method(s) to implement depend on the sort
of stream class you are writing:



  
    

      
        
Use-case

      		
      
        
Class

      		
      
        
Method(s) to implement

      		
    

  
  

    
      
Reading only

    		
    
      
[Readable](#stream_class_stream_readable_1)

    		
    
      
[_read][stream-_read]

    		
  

  

    
      
Writing only

    		
    
      
[Writable](#stream_class_stream_writable_1)

    		
    
      
[_write][stream-_write], [_writev][stream-_writev]

    		
  

  

    
      
Reading and writing

    		
    
      
[Duplex](#stream_class_stream_duplex_1)

    		
    
      
[_read][stream-_read], [_write][stream-_write], [_writev][stream-_writev]

    		
  

  

    
      
Operate on written data, then read the result

    		
    
      
[Transform](#stream_class_stream_transform_1)

    		
    
      
[_transform][stream-_transform], [_flush][stream-_flush]

    		
  




In your implementation code, it is very important to never call the methods
described in [API for Stream Consumers][]. Otherwise, you can potentially cause
adverse side effects in programs that consume your streaming interfaces.

### Class: stream.Duplex



A "duplex" stream is one that is both Readable and Writable, such as a TCP
socket connection.

Note that `stream.Duplex` is an abstract class designed to be extended
with an underlying implementation of the [`stream._read(size)`][stream-_read]
and [`stream._write(chunk, encoding, callback)`][stream-_write] methods as you
would with a Readable or Writable stream class.

Since JavaScript doesn't have multiple prototypal inheritance, this class
prototypally inherits from Readable, and then parasitically from Writable. It is
thus up to the user to implement both the low-level
[`stream._read(n)`][stream-_read] method as well as the low-level
[`stream._write(chunk, encoding, callback)`][stream-_write] method on extension
duplex classes.

#### new stream.Duplex(options)

* `options` {Object} Passed to both Writable and Readable
  constructors. Also has the following fields:
  * `allowHalfOpen` {Boolean} Default = `true`. If set to `false`, then
    the stream will automatically end the readable side when the
    writable side ends and vice versa.
  * `readableObjectMode` {Boolean} Default = `false`. Sets `objectMode`
    for readable side of the stream. Has no effect if `objectMode`
    is `true`.
  * `writableObjectMode` {Boolean} Default = `false`. Sets `objectMode`
    for writable side of the stream. Has no effect if `objectMode`
    is `true`.

In classes that extend the Duplex class, make sure to call the
constructor so that the buffering settings can be properly
initialized.

### Class: stream.PassThrough

This is a trivial implementation of a [Transform][] stream that simply
passes the input bytes across to the output. Its purpose is mainly
for examples and testing, but there are occasionally use cases where
it can come in handy as a building block for novel sorts of streams.

### Class: stream.Readable



`stream.Readable` is an abstract class designed to be extended with an
underlying implementation of the [`stream._read(size)`][stream-_read] method.

Please see [API for Stream Consumers][] for how to consume
streams in your programs. What follows is an explanation of how to
implement Readable streams in your programs.

#### new stream.Readable([options])

* `options` {Object}
  * `highWaterMark` {Number} The maximum number of bytes to store in
    the internal buffer before ceasing to read from the underlying
    resource. Default = `16384` (16kb), or `16` for `objectMode` streams
  * `encoding` {String} If specified, then buffers will be decoded to
    strings using the specified encoding. Default = `null`
  * `objectMode` {Boolean} Whether this stream should behave
    as a stream of objects. Meaning that [`stream.read(n)`][stream-read] returns
    a single value instead of a Buffer of size n. Default = `false`
  * `read` {Function} Implementation for the [`stream._read()`][stream-_read]
    method.

In classes that extend the Readable class, make sure to call the
Readable constructor so that the buffering settings can be properly
initialized.

#### readable._read(size)

* `size` {Number} Number of bytes to read asynchronously

Note: **Implement this method, but do NOT call it directly.**

This method is prefixed with an underscore because it is internal to the
class that defines it and should only be called by the internal Readable
class methods. All Readable stream implementations must provide a \_read
method to fetch data from the underlying resource.

When `_read()` is called, if data is available from the resource, the `_read()`
implementation should start pushing that data into the read queue by calling
[`this.push(dataChunk)`][stream-push]. `_read()` should continue reading from
the resource and pushing data until push returns `false`, at which point it
should stop reading from the resource. Only when `_read()` is called again after
it has stopped should it start reading more data from the resource and pushing
that data onto the queue.

Note: once the `_read()` method is called, it will not be called again until
the [`stream.push()`][stream-push] method is called.

The `size` argument is advisory. Implementations where a "read" is a
single call that returns data can use this to know how much data to
fetch. Implementations where that is not relevant, such as TCP or
TLS, may ignore this argument, and simply provide data whenever it
becomes available. There is no need, for example to "wait" until
`size` bytes are available before calling [`stream.push(chunk)`][stream-push].

#### readable.push(chunk[, encoding])


* `chunk` {Buffer|Null|String} Chunk of data to push into the read queue
* `encoding` {String} Encoding of String chunks.  Must be a valid
  Buffer encoding, such as `'utf8'` or `'ascii'`
* return {Boolean} Whether or not more pushes should be performed

Note: **This method should be called by Readable implementors, NOT
by consumers of Readable streams.**

If a value other than null is passed, The `push()` method adds a chunk of data
into the queue for subsequent stream processors to consume. If `null` is
passed, it signals the end of the stream (EOF), after which no more data
can be written.

The data added with `push()` can be pulled out by calling the
[`stream.read()`][stream-read] method when the [`'readable'`][] event fires.

This API is designed to be as flexible as possible. For example,
you may be wrapping a lower-level source which has some sort of
pause/resume mechanism, and a data callback. In those cases, you
could wrap the low-level source object by doing something like this:

```js
// source is an object with readStop() and readStart() methods,
// and an `ondata` member that gets called when it has data, and
// an `onend` member that gets called when the data is over.

util.inherits(SourceWrapper, Readable);

function SourceWrapper(options) {
  Readable.call(this, options);

  this._source = getLowlevelSourceObject();

  // Every time there's data, we push it into the internal buffer.
  this._source.ondata = (chunk) => {
    // if push() returns false, then we need to stop reading from source
    if (!this.push(chunk))
      this._source.readStop();
  };

  // When the source ends, we push the EOF-signaling `null` chunk
  this._source.onend = () => {
    this.push(null);
  };
}

// _read will be called when the stream wants to pull more data in
// the advisory size argument is ignored in this case.
SourceWrapper.prototype._read = function(size) {
  this._source.readStart();
};
```

#### Example: A Counting Stream



This is a basic example of a Readable stream. It emits the numerals
from 1 to 1,000,000 in ascending order, and then ends.

```js
const Readable = require('stream').Readable;
const util = require('util');
util.inherits(Counter, Readable);

function Counter(opt) {
  Readable.call(this, opt);
  this._max = 1000000;
  this._index = 1;
}

Counter.prototype._read = function() {
  var i = this._index++;
  if (i > this._max)
    this.push(null);
  else {
    var str = '' + i;
    var buf = new Buffer(str, 'ascii');
    this.push(buf);
  }
};
```

#### Example: SimpleProtocol v1 (Sub-optimal)

This is similar to the `parseHeader` function described
[here](#stream_readable_unshift_chunk), but implemented as a custom stream.
Also, note that this implementation does not convert the incoming data to a
string.

However, this would be better implemented as a [Transform][] stream. See
[SimpleProtocol v2][] for a better implementation.

```js
// A parser for a simple data protocol.
// The "header" is a JSON object, followed by 2 \n characters, and
// then a message body.
//
// NOTE: This can be done more simply as a Transform stream!
// Using Readable directly for this is sub-optimal. See the
// alternative example below under the Transform section.

const Readable = require('stream').Readable;
const util = require('util');

util.inherits(SimpleProtocol, Readable);

function SimpleProtocol(source, options) {
  if (!(this instanceof SimpleProtocol))
    return new SimpleProtocol(source, options);

  Readable.call(this, options);
  this._inBody = false;
  this._sawFirstCr = false;

  // source is a readable stream, such as a socket or file
  this._source = source;

  source.on('end', () => {
    this.push(null);
  });

  // give it a kick whenever the source is readable
  // read(0) will not consume any bytes
  source.on('readable', () => {
    this.read(0);
  });

  this._rawHeader = [];
  this.header = null;
}

SimpleProtocol.prototype._read = function(n) {
  if (!this._inBody) {
    var chunk = this._source.read();

    // if the source doesn't have data, we don't have data yet.
    if (chunk === null)
      return this.push('');

    // check if the chunk has a \n\n
    var split = -1;
    for (var i = 0; i < chunk.length; i++) {
      if (chunk[i] === 10) { // '\n'
        if (this._sawFirstCr) {
          split = i;
          break;
        } else {
          this._sawFirstCr = true;
        }
      } else {
        this._sawFirstCr = false;
      }
    }

    if (split === -1) {
      // still waiting for the \n\n
      // stash the chunk, and try again.
      this._rawHeader.push(chunk);
      this.push('');
    } else {
      this._inBody = true;
      var h = chunk.slice(0, split);
      this._rawHeader.push(h);
      var header = Buffer.concat(this._rawHeader).toString();
      try {
        this.header = JSON.parse(header);
      } catch (er) {
        this.emit('error', new Error('invalid simple protocol data'));
        return;
      }
      // now, because we got some extra data, unshift the rest
      // back into the read queue so that our consumer will see it.
      var b = chunk.slice(split);
      this.unshift(b);
      // calling unshift by itself does not reset the reading state
      // of the stream; since we're inside _read, doing an additional
      // push('') will reset the state appropriately.
      this.push('');

      // and let them know that we are done parsing the header.
      this.emit('header', this.header);
    }
  } else {
    // from there on, just provide the data to our consumer.
    // careful not to push(null), since that would indicate EOF.
    var chunk = this._source.read();
    if (chunk) this.push(chunk);
  }
};

// Usage:
// var parser = new SimpleProtocol(source);
// Now parser is a readable stream that will emit 'header'
// with the parsed header data.
```

### Class: stream.Transform

A "transform" stream is a duplex stream where the output is causally
connected in some way to the input, such as a [zlib][] stream or a
[crypto][] stream.

There is no requirement that the output be the same size as the input,
the same number of chunks, or arrive at the same time. For example, a
Hash stream will only ever have a single chunk of output which is
provided when the input is ended. A zlib stream will produce output
that is either much smaller or much larger than its input.

Rather than implement the [`stream._read()`][stream-_read] and
[`stream._write()`][stream-_write] methods, Transform classes must implement the
[`stream._transform()`][stream-_transform] method, and may optionally
also implement the [`stream._flush()`][stream-_flush] method. (See below.)

#### new stream.Transform([options])

* `options` {Object} Passed to both Writable and Readable
  constructors. Also has the following fields:
  * `transform` {Function} Implementation for the
    [`stream._transform()`][stream-_transform] method.
  * `flush` {Function} Implementation for the [`stream._flush()`][stream-_flush]
    method.

In classes that extend the Transform class, make sure to call the
constructor so that the buffering settings can be properly
initialized.

#### Events: 'finish' and 'end'

The [`'finish'`][] and [`'end'`][] events are from the parent Writable
and Readable classes respectively. The `'finish'` event is fired after
[`stream.end()`][stream-end] is called and all chunks have been processed by
[`stream._transform()`][stream-_transform], `'end'` is fired after all data has
been output which is after the callback in [`stream._flush()`][stream-_flush]
has been called.

#### transform._flush(callback)

* `callback` {Function} Call this function (optionally with an error
  argument) when you are done flushing any remaining data.

Note: **This function MUST NOT be called directly.**  It MAY be implemented
by child classes, and if so, will be called by the internal Transform
class methods only.

In some cases, your transform operation may need to emit a bit more
data at the end of the stream. For example, a `Zlib` compression
stream will store up some internal state so that it can optimally
compress the output. At the end, however, it needs to do the best it
can with what is left, so that the data will be complete.

In those cases, you can implement a `_flush()` method, which will be
called at the very end, after all the written data is consumed, but
before emitting [`'end'`][] to signal the end of the readable side. Just
like with [`stream._transform()`][stream-_transform], call
`transform.push(chunk)` zero or more times, as appropriate, and call `callback`
when the flush operation is complete.

This method is prefixed with an underscore because it is internal to
the class that defines it, and should not be called directly by user
programs. However, you **are** expected to override this method in
your own extension classes.

#### transform._transform(chunk, encoding, callback)

* `chunk` {Buffer|String} The chunk to be transformed. Will **always**
  be a buffer unless the `decodeStrings` option was set to `false`.
* `encoding` {String} If the chunk is a string, then this is the
  encoding type. If chunk is a buffer, then this is the special
  value - 'buffer', ignore it in this case.
* `callback` {Function} Call this function (optionally with an error
  argument and data) when you are done processing the supplied chunk.

Note: **This function MUST NOT be called directly.**  It should be
implemented by child classes, and called by the internal Transform
class methods only.

All Transform stream implementations must provide a `_transform()`
method to accept input and produce output.

`_transform()` should do whatever has to be done in this specific
Transform class, to handle the bytes being written, and pass them off
to the readable portion of the interface. Do asynchronous I/O,
process things, and so on.

Call `transform.push(outputChunk)` 0 or more times to generate output
from this input chunk, depending on how much data you want to output
as a result of this chunk.

Call the callback function only when the current chunk is completely
consumed. Note that there may or may not be output as a result of any
particular input chunk. If you supply a second argument to the callback
it will be passed to the push method. In other words the following are
equivalent:

```js
transform.prototype._transform = function (data, encoding, callback) {
  this.push(data);
  callback();
};

transform.prototype._transform = function (data, encoding, callback) {
  callback(null, data);
};
```

This method is prefixed with an underscore because it is internal to
the class that defines it, and should not be called directly by user
programs. However, you **are** expected to override this method in
your own extension classes.

#### Example: `SimpleProtocol` parser v2

The example [here](#stream_example_simpleprotocol_v1_sub_optimal) of a simple
protocol parser can be implemented simply by using the higher level
[Transform][] stream class, similar to the `parseHeader` and `SimpleProtocol
v1` examples.

In this example, rather than providing the input as an argument, it
would be piped into the parser, which is a more idiomatic Node.js stream
approach.

```javascript
const util = require('util');
const Transform = require('stream').Transform;
util.inherits(SimpleProtocol, Transform);

function SimpleProtocol(options) {
  if (!(this instanceof SimpleProtocol))
    return new SimpleProtocol(options);

  Transform.call(this, options);
  this._inBody = false;
  this._sawFirstCr = false;
  this._rawHeader = [];
  this.header = null;
}

SimpleProtocol.prototype._transform = function(chunk, encoding, done) {
  if (!this._inBody) {
    // check if the chunk has a \n\n
    var split = -1;
    for (var i = 0; i < chunk.length; i++) {
      if (chunk[i] === 10) { // '\n'
        if (this._sawFirstCr) {
          split = i;
          break;
        } else {
          this._sawFirstCr = true;
        }
      } else {
        this._sawFirstCr = false;
      }
    }

    if (split === -1) {
      // still waiting for the \n\n
      // stash the chunk, and try again.
      this._rawHeader.push(chunk);
    } else {
      this._inBody = true;
      var h = chunk.slice(0, split);
      this._rawHeader.push(h);
      var header = Buffer.concat(this._rawHeader).toString();
      try {
        this.header = JSON.parse(header);
      } catch (er) {
        this.emit('error', new Error('invalid simple protocol data'));
        return;
      }
      // and let them know that we are done parsing the header.
      this.emit('header', this.header);

      // now, because we got some extra data, emit this first.
      this.push(chunk.slice(split));
    }
  } else {
    // from there on, just provide the data to our consumer as-is.
    this.push(chunk);
  }
  done();
};

// Usage:
// var parser = new SimpleProtocol();
// source.pipe(parser)
// Now parser is a readable stream that will emit 'header'
// with the parsed header data.
```

### Class: stream.Writable



`stream.Writable` is an abstract class designed to be extended with an
underlying implementation of the
[`stream._write(chunk, encoding, callback)`][stream-_write] method.

Please see [API for Stream Consumers][] for how to consume
writable streams in your programs. What follows is an explanation of
how to implement Writable streams in your programs.

#### new stream.Writable([options])

* `options` {Object}
  * `highWaterMark` {Number} Buffer level when
    [`stream.write()`][stream-write] starts returning `false`. Default = `16384`
    (16kb), or `16` for `objectMode` streams.
  * `decodeStrings` {Boolean} Whether or not to decode strings into
    Buffers before passing them to [`stream._write()`][stream-_write].
    Default = `true`
  * `objectMode` {Boolean} Whether or not the
    [`stream.write(anyObj)`][stream-write] is a valid operation. If set you can
    write arbitrary data instead of only `Buffer` / `String` data.
    Default = `false`
  * `write` {Function} Implementation for the
    [`stream._write()`][stream-_write] method.
  * `writev` {Function} Implementation for the
    [`stream._writev()`][stream-_writev] method.

In classes that extend the Writable class, make sure to call the
constructor so that the buffering settings can be properly
initialized.

#### writable._write(chunk, encoding, callback)

* `chunk` {Buffer|String} The chunk to be written. Will **always**
  be a buffer unless the `decodeStrings` option was set to `false`.
* `encoding` {String} If the chunk is a string, then this is the
  encoding type. If chunk is a buffer, then this is the special
  value - 'buffer', ignore it in this case.
* `callback` {Function} Call this function (optionally with an error
  argument) when you are done processing the supplied chunk.

All Writable stream implementations must provide a
[`stream._write()`][stream-_write] method to send data to the underlying
resource.

Note: **This function MUST NOT be called directly.**  It should be
implemented by child classes, and called by the internal Writable
class methods only.

Call the callback using the standard `callback(error)` pattern to
signal that the write completed successfully or with an error.

If the `decodeStrings` flag is set in the constructor options, then
`chunk` may be a string rather than a Buffer, and `encoding` will
indicate the sort of string that it is. This is to support
implementations that have an optimized handling for certain string
data encodings. If you do not explicitly set the `decodeStrings`
option to `false`, then you can safely ignore the `encoding` argument,
and assume that `chunk` will always be a Buffer.

This method is prefixed with an underscore because it is internal to
the class that defines it, and should not be called directly by user
programs. However, you **are** expected to override this method in
your own extension classes.

#### writable._writev(chunks, callback)

* `chunks` {Array} The chunks to be written. Each chunk has following
  format: `{ chunk: ..., encoding: ... }`.
* `callback` {Function} Call this function (optionally with an error
  argument) when you are done processing the supplied chunks.

Note: **This function MUST NOT be called directly.**  It may be
implemented by child classes, and called by the internal Writable
class methods only.

This function is completely optional to implement. In most cases it is
unnecessary. If implemented, it will be called with all the chunks
that are buffered in the write queue.


## Simplified Constructor API



In simple cases there is now the added benefit of being able to construct a
stream without inheritance.

This can be done by passing the appropriate methods as constructor options:

Examples:

### Duplex

```js
var duplex = new stream.Duplex({
  read: function(n) {
    // sets this._read under the hood

    // push data onto the read queue, passing null
    // will signal the end of the stream (EOF)
    this.push(chunk);
  },
  write: function(chunk, encoding, next) {
    // sets this._write under the hood

    // An optional error can be passed as the first argument
    next()
  }
});

// or

var duplex = new stream.Duplex({
  read: function(n) {
    // sets this._read under the hood

    // push data onto the read queue, passing null
    // will signal the end of the stream (EOF)
    this.push(chunk);
  },
  writev: function(chunks, next) {
    // sets this._writev under the hood

    // An optional error can be passed as the first argument
    next()
  }
});
```

### Readable

```js
var readable = new stream.Readable({
  read: function(n) {
    // sets this._read under the hood

    // push data onto the read queue, passing null
    // will signal the end of the stream (EOF)
    this.push(chunk);
  }
});
```

### Transform

```js
var transform = new stream.Transform({
  transform: function(chunk, encoding, next) {
    // sets this._transform under the hood

    // generate output as many times as needed
    // this.push(chunk);

    // call when the current chunk is consumed
    next();
  },
  flush: function(done) {
    // sets this._flush under the hood

    // generate output as many times as needed
    // this.push(chunk);

    done();
  }
});
```

### Writable

```js
var writable = new stream.Writable({
  write: function(chunk, encoding, next) {
    // sets this._write under the hood

    // An optional error can be passed as the first argument
    next()
  }
});

// or

var writable = new stream.Writable({
  writev: function(chunks, next) {
    // sets this._writev under the hood

    // An optional error can be passed as the first argument
    next()
  }
});
```

## Streams: Under the Hood



### Buffering



Both Writable and Readable streams will buffer data on an internal
object which can be retrieved from `_writableState.getBuffer()` or
`_readableState.buffer`, respectively.

The amount of data that will potentially be buffered depends on the
`highWaterMark` option which is passed into the constructor.

Buffering in Readable streams happens when the implementation calls
[`stream.push(chunk)`][stream-push]. If the consumer of the Stream does not
call [`stream.read()`][stream-read], then the data will sit in the internal
queue until it is consumed.

Buffering in Writable streams happens when the user calls
[`stream.write(chunk)`][stream-write] repeatedly, even when it returns `false`.

The purpose of streams, especially with the [`stream.pipe()`][] method, is to
limit the buffering of data to acceptable levels, so that sources and
destinations of varying speed will not overwhelm the available memory.

### Compatibility with Older Node.js Versions



In versions of Node.js prior to v0.10, the Readable stream interface was
simpler, but also less powerful and less useful.

* Rather than waiting for you to call the [`stream.read()`][stream-read] method,
  [`'data'`][] events would start emitting immediately. If you needed to do
  some I/O to decide how to handle data, then you had to store the chunks
  in some kind of buffer so that they would not be lost.
* The [`stream.pause()`][stream-pause] method was advisory, rather than
  guaranteed. This meant that you still had to be prepared to receive
  [`'data'`][] events even when the stream was in a paused state.

In Node.js v0.10, the [Readable][] class was added.
For backwards compatibility with older Node.js programs, Readable streams
switch into "flowing mode" when a [`'data'`][] event handler is added, or
when the [`stream.resume()`][stream-resume] method is called. The effect is
that, even if you are not using the new [`stream.read()`][stream-read] method
and [`'readable'`][] event, you no longer have to worry about losing
[`'data'`][] chunks.

Most programs will continue to function normally. However, this
introduces an edge case in the following conditions:

* No [`'data'`][] event handler is added.
* The [`stream.resume()`][stream-resume] method is never called.
* The stream is not piped to any writable destination.

For example, consider the following code:

```js
// WARNING!  BROKEN!
net.createServer((socket) => {

  // we add an 'end' method, but never consume the data
  socket.on('end', () => {
    // It will never get here.
    socket.end('I got your message (but didnt read it)\n');
  });

}).listen(1337);
```

In versions of Node.js prior to v0.10, the incoming message data would be
simply discarded. However, in Node.js v0.10 and beyond,
the socket will remain paused forever.

The workaround in this situation is to call the
[`stream.resume()`][stream-resume] method to start the flow of data:

```js
// Workaround
net.createServer((socket) => {

  socket.on('end', () => {
    socket.end('I got your message (but didnt read it)\n');
  });

  // start the flow of data, discarding it.
  socket.resume();

}).listen(1337);
```

In addition to new Readable streams switching into flowing mode,
pre-v0.10 style streams can be wrapped in a Readable class using the
[`stream.wrap()`][] method.


### Object Mode



Normally, Streams operate on Strings and Buffers exclusively.

Streams that are in **object mode** can emit generic JavaScript values
other than Buffers and Strings.

A Readable stream in object mode will always return a single item from
a call to [`stream.read(size)`][stream-read], regardless of what the size
argument is.

A Writable stream in object mode will always ignore the `encoding`
argument to [`stream.write(data, encoding)`][stream-write].

The special value `null` still retains its special value for object
mode streams. That is, for object mode readable streams, `null` as a
return value from [`stream.read()`][stream-read] indicates that there is no more
data, and [`stream.push(null)`][stream-push] will signal the end of stream data
(`EOF`).

No streams in Node.js core are object mode streams. This pattern is only
used by userland streaming libraries.

You should set `objectMode` in your stream child class constructor on
the options object. Setting `objectMode` mid-stream is not safe.

For Duplex streams `objectMode` can be set exclusively for readable or
writable side with `readableObjectMode` and `writableObjectMode`
respectively. These options can be used to implement parsers and
serializers with Transform streams.

```js
const util = require('util');
const StringDecoder = require('string_decoder').StringDecoder;
const Transform = require('stream').Transform;
util.inherits(JSONParseStream, Transform);

// Gets \n-delimited JSON string data, and emits the parsed objects
function JSONParseStream() {
  if (!(this instanceof JSONParseStream))
    return new JSONParseStream();

  Transform.call(this, { readableObjectMode : true });

  this._buffer = '';
  this._decoder = new StringDecoder('utf8');
}

JSONParseStream.prototype._transform = function(chunk, encoding, cb) {
  this._buffer += this._decoder.write(chunk);
  // split on newlines
  var lines = this._buffer.split(/\r?\n/);
  // keep the last partial line buffered
  this._buffer = lines.pop();
  for (var l = 0; l < lines.length; l++) {
    var line = lines[l];
    try {
      var obj = JSON.parse(line);
    } catch (er) {
      this.emit('error', er);
      return;
    }
    // push the parsed object out to the readable consumer
    this.push(obj);
  }
  cb();
};

JSONParseStream.prototype._flush = function(cb) {
  // Just handle any leftover
  var rem = this._buffer.trim();
  if (rem) {
    try {
      var obj = JSON.parse(rem);
    } catch (er) {
      this.emit('error', er);
      return;
    }
    // push the parsed object out to the readable consumer
    this.push(obj);
  }
  cb();
};
```

### `stream.read(0)`

There are some cases where you want to trigger a refresh of the
underlying readable stream mechanisms, without actually consuming any
data. In that case, you can call `stream.read(0)`, which will always
return null.

If the internal read buffer is below the `highWaterMark`, and the
stream is not currently reading, then calling `stream.read(0)` will trigger
a low-level [`stream._read()`][stream-_read] call.

There is almost never a need to do this. However, you will see some
cases in Node.js's internals where this is done, particularly in the
Readable stream class internals.

### `stream.push('')`

Pushing a zero-byte string or Buffer (when not in [Object mode][]) has an
interesting side effect. Because it *is* a call to
[`stream.push()`][stream-push], it will end the `reading` process. However, it
does *not* add any data to the readable buffer, so there's nothing for
a user to consume.

Very rarely, there are cases where you have no data to provide now,
but the consumer of your stream (or, perhaps, another bit of your own
code) will know when to check again, by calling [`stream.read(0)`][stream-read].
In those cases, you *may* call `stream.push('')`.

So far, the only use case for this functionality is in the
[`tls.CryptoStream`][] class, which is deprecated in Node.js/io.js v1.0. If you
find that you have to use `stream.push('')`, please consider another
approach, because it almost certainly indicates that something is
horribly wrong.

[`'data'`]: #stream_event_data
[`'drain'`]: #stream_event_drain
[`'end'`]: #stream_event_end
[`'finish'`]: #stream_event_finish
[`'readable'`]: #stream_event_readable
[`buf.toString(encoding)`]: buffer.html#buffer_buf_tostring_encoding_start_end
[`EventEmitter`]: events.html#events_class_eventemitter
[`process.stderr`]: process.html#process_process_stderr
[`process.stdin`]: process.html#process_process_stdin
[`process.stdout`]: process.html#process_process_stdout
[`stream.cork()`]: #stream_writable_cork
[`stream.pipe()`]: #stream_readable_pipe_destination_options
[`stream.uncork()`]: #stream_writable_uncork
[`stream.unpipe()`]: #stream_readable_unpipe_destination
[`stream.wrap()`]: #stream_readable_wrap_stream
[`tls.CryptoStream`]: tls.html#tls_class_cryptostream
[`util.inherits()`]: util.html#util_util_inherits_constructor_superconstructor
[API for Stream Consumers]: #stream_api_for_stream_consumers
[API for Stream Implementors]: #stream_api_for_stream_implementors
[child process stdin]: child_process.html#child_process_child_stdin
[child process stdout and stderr]: child_process.html#child_process_child_stdout
[Compatibility]: #stream_compatibility_with_older_node_js_versions
[crypto]: crypto.html
[Duplex]: #stream_class_stream_duplex
[fs read streams]: fs.html#fs_class_fs_readstream
[fs write streams]: fs.html#fs_class_fs_writestream
[HTTP requests, on the client]: http.html#http_class_http_clientrequest
[HTTP responses, on the server]: http.html#http_class_http_serverresponse
[http-incoming-message]: http.html#http_class_http_incomingmessage
[Object mode]: #stream_object_mode
[Readable]: #stream_class_stream_readable
[SimpleProtocol v2]: #stream_example_simpleprotocol_parser_v2
[stream-_flush]: #stream_transform_flush_callback
[stream-_read]: #stream_readable_read_size_1
[stream-_transform]: #stream_transform_transform_chunk_encoding_callback
[stream-_write]: #stream_writable_write_chunk_encoding_callback_1
[stream-_writev]: #stream_writable_writev_chunks_callback
[stream-end]: #stream_writable_end_chunk_encoding_callback
[stream-pause]: #stream_readable_pause
[stream-push]: #stream_readable_push_chunk_encoding
[stream-read]: #stream_readable_read_size
[stream-resume]: #stream_readable_resume
[stream-write]: #stream_writable_write_chunk_encoding_callback
[TCP sockets]: net.html#net_class_net_socket
[Transform]: #stream_class_stream_transform
[Writable]: #stream_class_stream_writable
[zlib]: zlib.html
node-v4.8.2/doc/api/string_decoder.html000644 000766 000024 00000014176 13070706740 020164 0ustar00iojsstaff000000 000000 


  
  String Decoder | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

      

        
String Decoder#


Stability: 2 - Stable
To use this module, do require('string_decoder'). StringDecoder decodes a
buffer to a string. It is a simple interface to buffer.toString() but provides
additional support for utf8.


const StringDecoder = require('string_decoder').StringDecoder;
const decoder = new StringDecoder('utf8');

const cent = new Buffer([0xC2, 0xA2]);
console.log(decoder.write(cent));

const euro = new Buffer([0xE2, 0x82, 0xAC]);
console.log(decoder.write(euro));



Class: StringDecoder#



Added in: v0.1.99

Accepts a single argument, encoding which defaults to 'utf8'.


decoder.end()#



Added in: v0.9.3

Returns any trailing bytes that were left in the buffer.


decoder.write(buffer)#



Added in: v0.1.99

Returns a decoded string.


      

    

  

  
  
  
  



node-v4.8.2/doc/api/string_decoder.json000644 000766 000024 00000004255 13070706740 020166 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/string_decoder.md",
  "modules": [
    {
      "textRaw": "String Decoder",
      "name": "string_decoder",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
To use this module, do require('string_decoder'). StringDecoder decodes a\nbuffer to a string. It is a simple interface to buffer.toString() but provides\nadditional support for utf8.
\n
const StringDecoder = require('string_decoder').StringDecoder;\nconst decoder = new StringDecoder('utf8');\n\nconst cent = new Buffer([0xC2, 0xA2]);\nconsole.log(decoder.write(cent));\n\nconst euro = new Buffer([0xE2, 0x82, 0xAC]);\nconsole.log(decoder.write(euro));\n
\n",
      "classes": [
        {
          "textRaw": "Class: StringDecoder",
          "type": "class",
          "name": "StringDecoder",
          "meta": {
            "added": [
              "v0.1.99"
            ]
          },
          "desc": "
Accepts a single argument, encoding which defaults to 'utf8'.
\n",
          "methods": [
            {
              "textRaw": "decoder.end()",
              "type": "method",
              "name": "end",
              "meta": {
                "added": [
                  "v0.9.3"
                ]
              },
              "desc": "
Returns any trailing bytes that were left in the buffer.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "decoder.write(buffer)",
              "type": "method",
              "name": "write",
              "meta": {
                "added": [
                  "v0.1.99"
                ]
              },
              "desc": "
Returns a decoded string.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "buffer"
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "String Decoder"
    }
  ]
}
node-v4.8.2/doc/api/string_decoder.md000644 000766 000024 00000001451 13070706735 017614 0ustar00iojsstaff000000 000000 # String Decoder

> Stability: 2 - Stable

To use this module, do `require('string_decoder')`. StringDecoder decodes a
buffer to a string. It is a simple interface to `buffer.toString()` but provides
additional support for utf8.

```js
const StringDecoder = require('string_decoder').StringDecoder;
const decoder = new StringDecoder('utf8');

const cent = new Buffer([0xC2, 0xA2]);
console.log(decoder.write(cent));

const euro = new Buffer([0xE2, 0x82, 0xAC]);
console.log(decoder.write(euro));
```

## Class: StringDecoder


Accepts a single argument, `encoding` which defaults to `'utf8'`.

### decoder.end()


Returns any trailing bytes that were left in the buffer.

### decoder.write(buffer)


Returns a decoded string.
node-v4.8.2/doc/api/synopsis.html000644 000766 000024 00000013105 13070706740 017047 0ustar00iojsstaff000000 000000 


  
  Usage | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

        
Table of Contents

        

      


      

        
Usage#



node [options] [v8 options] [script.js | -e "script"] [arguments]


Please see the Command Line Options document for information about
different options and ways to run scripts with Node.


Example#


An example of a web server written with Node.js which responds with
'Hello World':


const http = require('http');

const hostname = '127.0.0.1';
const port = 3000;

const server = http.createServer((req, res) => {
  res.statusCode = 200;
  res.setHeader('Content-Type', 'text/plain');
  res.end('Hello World\n');
});

server.listen(port, hostname, () => {
  console.log(`Server running at http://${hostname}:${port}/`);
});



To run the server, put the code into a file called example.js and execute
it with Node.js:


$ node example.js
Server running at http://127.0.0.1:3000/

All of the examples in the documentation can be run similarly.


      

    

  

  
  
  
  



node-v4.8.2/doc/api/synopsis.json000644 000766 000024 00000002427 13070706740 017061 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/synopsis.md",
  "miscs": [
    {
      "textRaw": "Usage",
      "name": "Usage",
      "type": "misc",
      "desc": "
node [options] [v8 options] [script.js | -e "script"] [arguments]
\n
Please see the Command Line Options document for information about\ndifferent options and ways to run scripts with Node.
\n
Example
\n
An example of a web server written with Node.js which responds with\n'Hello World':
\n
const http = require('http');\n\nconst hostname = '127.0.0.1';\nconst port = 3000;\n\nconst server = http.createServer((req, res) => {\n  res.statusCode = 200;\n  res.setHeader('Content-Type', 'text/plain');\n  res.end('Hello World\\n');\n});\n\nserver.listen(port, hostname, () => {\n  console.log(`Server running at http://${hostname}:${port}/`);\n});\n
\n
To run the server, put the code into a file called example.js and execute\nit with Node.js:
\n
$ node example.js\nServer running at http://127.0.0.1:3000/\n
All of the examples in the documentation can be run similarly.
\n"
    }
  ]
}
node-v4.8.2/doc/api/synopsis.md000644 000766 000024 00000001726 13070706735 016515 0ustar00iojsstaff000000 000000 # Usage



`node [options] [v8 options] [script.js | -e "script"] [arguments]`

Please see the [Command Line Options][] document for information about
different options and ways to run scripts with Node.

## Example

An example of a [web server][] written with Node.js which responds with
`'Hello World'`:

```js
const http = require('http');

const hostname = '127.0.0.1';
const port = 3000;

const server = http.createServer((req, res) => {
  res.statusCode = 200;
  res.setHeader('Content-Type', 'text/plain');
  res.end('Hello World\n');
});

server.listen(port, hostname, () => {
  console.log(`Server running at http://${hostname}:${port}/`);
});
```

To run the server, put the code into a file called `example.js` and execute
it with Node.js:

```
$ node example.js
Server running at http://127.0.0.1:3000/
```

All of the examples in the documentation can be run similarly.

[Command Line Options]: cli.html#cli_command_line_options
[web server]: http.html
node-v4.8.2/doc/api/timers.html000644 000766 000024 00000025177 13070706740 016477 0ustar00iojsstaff000000 000000 


  
  Timers | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

      

        
Timers#


Stability: 3 - Locked
All of the timer functions are globals.  You do not need to require()
this module in order to use them.


clearImmediate(immediateObject)#



Added in: v0.9.1

Stops an immediateObject, as created by setImmediate, from triggering.


clearInterval(intervalObject)#



Added in: v0.0.1

Stops an intervalObject, as created by setInterval, from triggering.


clearTimeout(timeoutObject)#



Added in: v0.0.1

Prevents a timeoutObject, as created by setTimeout, from triggering.


ref()#



Added in: v0.9.1

If a timer was previously unref()d, then ref() can be called to explicitly
request the timer hold the program open. If the timer is already refd calling
ref again will have no effect.


Returns the timer.


setImmediate(callback[, arg][, ...])#



Added in: v0.9.1

Schedules "immediate" execution of callback after I/O events'
callbacks and before timers set by setTimeout and setInterval are
triggered. Returns an immediateObject for possible use with
clearImmediate. Additional optional arguments may be passed to the
callback.


Callbacks for immediates are queued in the order in which they were created.
The entire callback queue is processed every event loop iteration. If an
immediate is queued from inside an executing callback, that immediate won't fire
until the next event loop iteration.


setInterval(callback, delay[, arg][, ...])#



Added in: v0.0.1

Schedules repeated execution of callback every delay milliseconds.
Returns a intervalObject for possible use with clearInterval. Additional
optional arguments may be passed to the callback.


To follow browser behavior, when using delays larger than 2147483647
milliseconds (approximately 25 days) or less than 1, Node.js will use 1 as the
delay.


setTimeout(callback, delay[, arg][, ...])#



Added in: v0.0.1

Schedules execution of a one-time callback after delay milliseconds.
Returns a timeoutObject for possible use with clearTimeout. Additional
optional arguments may be passed to the callback.


The callback will likely not be invoked in precisely delay milliseconds.
Node.js makes no guarantees about the exact timing of when callbacks will fire,
nor of their ordering. The callback will be called as close as possible to the
time specified.


To follow browser behavior, when using delays larger than 2147483647
milliseconds (approximately 25 days) or less than 1, the timeout is executed
immediately, as if the delay was set to 1.


unref()#



Added in: v0.9.1

The opaque value returned by setTimeout and setInterval also has the
method timer.unref() which allows the creation of a timer that is active but
if it is the only item left in the event loop, it won't keep the program
running. If the timer is already unrefd calling unref again will have no
effect.


In the case of setTimeout, unref creates a separate timer that will
wakeup the event loop, creating too many of these may adversely effect event
loop performance -- use wisely.


Returns the timer.


      

    

  

  
  
  
  



node-v4.8.2/doc/api/timers.json000644 000766 000024 00000017750 13070706740 016502 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/timers.md",
  "modules": [
    {
      "textRaw": "Timers",
      "name": "timers",
      "stability": 3,
      "stabilityText": "Locked",
      "desc": "
All of the timer functions are globals.  You do not need to require()\nthis module in order to use them.
\n",
      "methods": [
        {
          "textRaw": "clearImmediate(immediateObject)",
          "type": "method",
          "name": "clearImmediate",
          "meta": {
            "added": [
              "v0.9.1"
            ]
          },
          "desc": "
Stops an immediateObject, as created by setImmediate, from triggering.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "immediateObject"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "clearInterval(intervalObject)",
          "type": "method",
          "name": "clearInterval",
          "meta": {
            "added": [
              "v0.0.1"
            ]
          },
          "desc": "
Stops an intervalObject, as created by setInterval, from triggering.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "intervalObject"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "clearTimeout(timeoutObject)",
          "type": "method",
          "name": "clearTimeout",
          "meta": {
            "added": [
              "v0.0.1"
            ]
          },
          "desc": "
Prevents a timeoutObject, as created by setTimeout, from triggering.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "timeoutObject"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "ref()",
          "type": "method",
          "name": "ref",
          "meta": {
            "added": [
              "v0.9.1"
            ]
          },
          "desc": "
If a timer was previously unref()d, then ref() can be called to explicitly\nrequest the timer hold the program open. If the timer is already refd calling\nref again will have no effect.
\n
Returns the timer.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "setImmediate(callback[, arg][, ...])",
          "type": "method",
          "name": "setImmediate",
          "meta": {
            "added": [
              "v0.9.1"
            ]
          },
          "desc": "
Schedules "immediate" execution of callback after I/O events'\ncallbacks and before timers set by setTimeout and setInterval are\ntriggered. Returns an immediateObject for possible use with\nclearImmediate. Additional optional arguments may be passed to the\ncallback.
\n
Callbacks for immediates are queued in the order in which they were created.\nThe entire callback queue is processed every event loop iteration. If an\nimmediate is queued from inside an executing callback, that immediate won't fire\nuntil the next event loop iteration.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "callback"
                },
                {
                  "name": "arg",
                  "optional": true
                },
                {
                  "name": "...",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "setInterval(callback, delay[, arg][, ...])",
          "type": "method",
          "name": "setInterval",
          "meta": {
            "added": [
              "v0.0.1"
            ]
          },
          "desc": "
Schedules repeated execution of callback every delay milliseconds.\nReturns a intervalObject for possible use with clearInterval. Additional\noptional arguments may be passed to the callback.
\n
To follow browser behavior, when using delays larger than 2147483647\nmilliseconds (approximately 25 days) or less than 1, Node.js will use 1 as the\ndelay.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "callback"
                },
                {
                  "name": "delay"
                },
                {
                  "name": "arg",
                  "optional": true
                },
                {
                  "name": "...",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "setTimeout(callback, delay[, arg][, ...])",
          "type": "method",
          "name": "setTimeout",
          "meta": {
            "added": [
              "v0.0.1"
            ]
          },
          "desc": "
Schedules execution of a one-time callback after delay milliseconds.\nReturns a timeoutObject for possible use with clearTimeout. Additional\noptional arguments may be passed to the callback.
\n
The callback will likely not be invoked in precisely delay milliseconds.\nNode.js makes no guarantees about the exact timing of when callbacks will fire,\nnor of their ordering. The callback will be called as close as possible to the\ntime specified.
\n
To follow browser behavior, when using delays larger than 2147483647\nmilliseconds (approximately 25 days) or less than 1, the timeout is executed\nimmediately, as if the delay was set to 1.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "callback"
                },
                {
                  "name": "delay"
                },
                {
                  "name": "arg",
                  "optional": true
                },
                {
                  "name": "...",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "unref()",
          "type": "method",
          "name": "unref",
          "meta": {
            "added": [
              "v0.9.1"
            ]
          },
          "desc": "
The opaque value returned by setTimeout and setInterval also has the\nmethod timer.unref() which allows the creation of a timer that is active but\nif it is the only item left in the event loop, it won't keep the program\nrunning. If the timer is already unrefd calling unref again will have no\neffect.
\n
In the case of setTimeout, unref creates a separate timer that will\nwakeup the event loop, creating too many of these may adversely effect event\nloop performance -- use wisely.
\n
Returns the timer.
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "Timers"
    }
  ]
}
node-v4.8.2/doc/api/timers.md000644 000766 000024 00000006746 13070706735 016140 0ustar00iojsstaff000000 000000 # Timers

> Stability: 3 - Locked

All of the timer functions are globals.  You do not need to `require()`
this module in order to use them.

## clearImmediate(immediateObject)


Stops an `immediateObject`, as created by [`setImmediate`][], from triggering.

## clearInterval(intervalObject)


Stops an `intervalObject`, as created by [`setInterval`][], from triggering.

## clearTimeout(timeoutObject)


Prevents a `timeoutObject`, as created by [`setTimeout`][], from triggering.

## ref()


If a timer was previously `unref()`d, then `ref()` can be called to explicitly
request the timer hold the program open. If the timer is already `ref`d calling
`ref` again will have no effect.

Returns the timer.

## setImmediate(callback[, arg][, ...])


Schedules "immediate" execution of `callback` after I/O events'
callbacks and before timers set by [`setTimeout`][] and [`setInterval`][] are
triggered. Returns an `immediateObject` for possible use with
[`clearImmediate`][]. Additional optional arguments may be passed to the
callback.

Callbacks for immediates are queued in the order in which they were created.
The entire callback queue is processed every event loop iteration. If an
immediate is queued from inside an executing callback, that immediate won't fire
until the next event loop iteration.

## setInterval(callback, delay[, arg][, ...])


Schedules repeated execution of `callback` every `delay` milliseconds.
Returns a `intervalObject` for possible use with [`clearInterval`][]. Additional
optional arguments may be passed to the callback.

To follow browser behavior, when using delays larger than 2147483647
milliseconds (approximately 25 days) or less than 1, Node.js will use 1 as the
`delay`.

## setTimeout(callback, delay[, arg][, ...])


Schedules execution of a one-time `callback` after `delay` milliseconds.
Returns a `timeoutObject` for possible use with [`clearTimeout`][]. Additional
optional arguments may be passed to the callback.

The callback will likely not be invoked in precisely `delay` milliseconds.
Node.js makes no guarantees about the exact timing of when callbacks will fire,
nor of their ordering. The callback will be called as close as possible to the
time specified.

To follow browser behavior, when using delays larger than 2147483647
milliseconds (approximately 25 days) or less than 1, the timeout is executed
immediately, as if the `delay` was set to 1.

## unref()


The opaque value returned by [`setTimeout`][] and [`setInterval`][] also has the
method `timer.unref()` which allows the creation of a timer that is active but
if it is the only item left in the event loop, it won't keep the program
running. If the timer is already `unref`d calling `unref` again will have no
effect.

In the case of [`setTimeout`][], `unref` creates a separate timer that will
wakeup the event loop, creating too many of these may adversely effect event
loop performance -- use wisely.

Returns the timer.

[`clearImmediate`]: timers.html#timers_clearimmediate_immediateobject
[`clearInterval`]: timers.html#timers_clearinterval_intervalobject
[`clearTimeout`]: timers.html#timers_cleartimeout_timeoutobject
[`setImmediate`]: timers.html#timers_setimmediate_callback_arg
[`setInterval`]: timers.html#timers_setinterval_callback_delay_arg
[`setTimeout`]: timers.html#timers_settimeout_callback_delay_arg
node-v4.8.2/doc/api/tls.html000644 000766 000024 00000162627 13070706740 016000 0ustar00iojsstaff000000 000000 


  
  TLS (SSL) | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

      

        
TLS (SSL)#


Stability: 2 - Stable
Use require('tls') to access this module.


The tls module uses OpenSSL to provide Transport Layer Security and/or
Secure Socket Layer: encrypted stream communication.


TLS/SSL is a public/private key infrastructure. Each client and each
server must have a private key. A private key is created like this:


openssl genrsa -out ryans-key.pem 2048

All servers and some clients need to have a certificate. Certificates are public
keys signed by a Certificate Authority or self-signed. The first step to
getting a certificate is to create a "Certificate Signing Request" (CSR)
file. This is done with:


openssl req -new -sha256 -key ryans-key.pem -out ryans-csr.pem

To create a self-signed certificate with the CSR, do this:


openssl x509 -req -in ryans-csr.pem -signkey ryans-key.pem -out ryans-cert.pem

Alternatively you can send the CSR to a Certificate Authority for signing.


For Perfect Forward Secrecy, it is required to generate Diffie-Hellman
parameters:


openssl dhparam -outform PEM -out dhparam.pem 2048

To create .pfx or .p12, do this:


openssl pkcs12 -export -in agent5-cert.pem -inkey agent5-key.pem \
      -certfile ca-cert.pem -out agent5.pfx

    

  • in:  certificate
    • 

  • inkey: private key
    • 

  • certfile: all CA certs concatenated in one file like
cat ca1-cert.pem ca2-cert.pem > ca-cert.pem
    • 



Client-initiated renegotiation attack mitigation#



The TLS protocol lets the client renegotiate certain aspects of the TLS session.
Unfortunately, session renegotiation requires a disproportional amount of
server-side resources, which makes it a potential vector for denial-of-service
attacks.


To mitigate this, renegotiations are limited to three times every 10 minutes. An
error is emitted on the tls.TLSSocket instance when the threshold is
exceeded. The limits are configurable:


    

  • tls.CLIENT_RENEG_LIMIT: renegotiation limit, default is 3.
    

    • 

  • tls.CLIENT_RENEG_WINDOW: renegotiation window in seconds, default is
10 minutes.
    

    • 



Don't change the defaults unless you know what you are doing.


To test your server, connect to it with openssl s_client -connect address:port
and tap R<CR> (that's the letter R followed by a carriage return) a few
times.


Modifying the Default TLS Cipher suite#


Node.js is built with a default suite of enabled and disabled TLS ciphers.
Currently, the default cipher suite is:


ECDHE-RSA-AES128-GCM-SHA256:
ECDHE-ECDSA-AES128-GCM-SHA256:
ECDHE-RSA-AES256-GCM-SHA384:
ECDHE-ECDSA-AES256-GCM-SHA384:
DHE-RSA-AES128-GCM-SHA256:
ECDHE-RSA-AES128-SHA256:
DHE-RSA-AES128-SHA256:
ECDHE-RSA-AES256-SHA384:
DHE-RSA-AES256-SHA384:
ECDHE-RSA-AES256-SHA256:
DHE-RSA-AES256-SHA256:
HIGH:
!aNULL:
!eNULL:
!EXPORT:
!DES:
!RC4:
!MD5:
!PSK:
!SRP:
!CAMELLIA

This default can be overriden entirely using the --tls-cipher-list command
line switch. For instance, the following makes
ECDHE-RSA-AES128-GCM-SHA256:!RC4 the default TLS cipher suite:


node --tls-cipher-list="ECDHE-RSA-AES128-GCM-SHA256:!RC4"

Note that the default cipher suite included within Node.js has been carefully
selected to reflect current security best practices and risk mitigation.
Changing the default cipher suite can have a significant impact on the security
of an application. The --tls-cipher-list switch should by used only if
absolutely necessary.


ALPN, NPN and SNI#



ALPN (Application-Layer Protocol Negotiation Extension), NPN (Next
Protocol Negotiation) and SNI (Server Name Indication) are TLS
handshake extensions allowing you:


    

  • ALPN/NPN - to use one TLS server for multiple protocols (HTTP, SPDY, HTTP/2)
    • 

  • SNI - to use one TLS server for multiple hostnames with different SSL
certificates.
    • 



Perfect Forward Secrecy#



The term "Forward Secrecy" or "Perfect Forward Secrecy" describes a feature of
key-agreement (i.e. key-exchange) methods. Practically it means that even if the
private key of a (your) server is compromised, communication can only be
decrypted by eavesdroppers if they manage to obtain the key-pair specifically
generated for each session.


This is achieved by randomly generating a key pair for key-agreement on every
handshake (in contrary to the same key for all sessions). Methods implementing
this technique, thus offering Perfect Forward Secrecy, are called "ephemeral".


Currently two methods are commonly used to achieve Perfect Forward Secrecy (note
the character "E" appended to the traditional abbreviations):


    

  • DHE - An ephemeral version of the Diffie Hellman key-agreement protocol.
    • 

  • ECDHE - An ephemeral version of the Elliptic Curve Diffie Hellman
key-agreement protocol.
    • 



Ephemeral methods may have some performance drawbacks, because key generation
is expensive.


Class: CryptoStream#


Stability: 0 - Deprecated: Use tls.TLSSocket instead.
This is an encrypted stream.


cryptoStream.bytesWritten#


A proxy to the underlying socket's bytesWritten accessor, this will return
the total bytes written to the socket, including the TLS overhead.


Class: SecurePair#


Returned by tls.createSecurePair.


Event: 'secure'#


The event is emitted from the SecurePair once the pair has successfully
established a secure connection.


Similarly to the checking for the server 'secureConnection' event,
pair.cleartext.authorized should be checked to confirm whether the certificate
used properly authorized.


Class: tls.Server#



Added in: v0.3.2

This class is a subclass of net.Server and has the same methods on it.
Instead of accepting just raw TCP connections, this accepts encrypted
connections using TLS or SSL.


Event: 'clientError'#



Added in: v0.11.11

function (exception, tlsSocket) { }


When a client connection emits an 'error' event before a secure connection is
established it will be forwarded here.


tlsSocket is the tls.TLSSocket that the error originated from.


Event: 'newSession'#



Added in: v0.9.2

function (sessionId, sessionData, callback) { }


Emitted on creation of TLS session. May be used to store sessions in external
storage. callback must be invoked eventually, otherwise no data will be
sent or received from secure connection.


NOTE: adding this event listener will have an effect only on connections
established after addition of event listener.


Event: 'OCSPRequest'#



Added in: v0.11.13

function (certificate, issuer, callback) { }


Emitted when the client sends a certificate status request. You could parse
server's current certificate to obtain OCSP url and certificate id, and after
obtaining OCSP response invoke callback(null, resp), where resp is a
Buffer instance. Both certificate and issuer are a Buffer
DER-representations of the primary and issuer's certificates. They could be used
to obtain OCSP certificate id and OCSP endpoint url.


Alternatively, callback(null, null) could be called, meaning that there is no
OCSP response.


Calling callback(err) will result in a socket.destroy(err) call.


Typical flow:


    

  1. Client connects to server and sends 'OCSPRequest' to it (via status info
extension in ClientHello.)
    2. 

  2. Server receives request and invokes 'OCSPRequest' event listener if present
    3. 

  3. Server grabs OCSP url from either certificate or issuer and performs an
OCSP request to the CA
    4. 

  4. Server receives OCSPResponse from CA and sends it back to client via
callback argument
    5. 

  5. Client validates the response and either destroys socket or performs a
handshake.
    6. 



NOTE: issuer could be null, if the certificate is self-signed or if the issuer
is not in the root certificates list. (You could provide an issuer via ca
option.)


NOTE: adding this event listener will have an effect only on connections
established after addition of event listener.


NOTE: you may want to use some npm module like asn1.js to parse the
certificates.


Event: 'resumeSession'#



Added in: v0.9.2

function (sessionId, callback) { }


Emitted when client wants to resume previous TLS session. Event listener may
perform lookup in external storage using given sessionId, and invoke
callback(null, sessionData) once finished. If session can't be resumed
(i.e. doesn't exist in storage) one may call callback(null, null). Calling
callback(err) will terminate incoming connection and destroy socket.


NOTE: adding this event listener will have an effect only on connections
established after addition of event listener.


Here's an example for using TLS session resumption:


var tlsSessionStore = {};
server.on('newSession', (id, data, cb) => {
  tlsSessionStore[id.toString('hex')] = data;
  cb();
});
server.on('resumeSession', (id, cb) => {
  cb(null, tlsSessionStore[id.toString('hex')] || null);
});



Event: 'secureConnection'#



Added in: v0.3.2

function (tlsSocket) {}


This event is emitted after a new connection has been successfully
handshaked. The argument is an instance of tls.TLSSocket. It has all the
common stream methods and events.


socket.authorized is a boolean value which indicates if the
client has verified by one of the supplied certificate authorities for the
server. If socket.authorized is false, then
socket.authorizationError is set to describe how authorization
failed. Implied but worth mentioning: depending on the settings of the TLS
server, you unauthorized connections may be accepted.


socket.npnProtocol is a string containing the selected NPN protocol
and socket.alpnProtocol is a string containing the selected ALPN
protocol, When both NPN and ALPN extensions are received, ALPN takes
precedence over NPN and the next protocol is selected by ALPN. When
ALPN has no selected protocol, this returns false.


socket.servername is a string containing servername requested with
SNI.


server.addContext(hostname, context)#



Added in: v0.5.3

Add secure context that will be used if client request's SNI hostname is
matching passed hostname (wildcards can be used). context can contain
key, cert, ca and/or any other properties from
tls.createSecureContext() options argument.


server.address()#



Added in: v0.6.0

Returns the bound address, the address family name and port of the
server as reported by the operating system.  See net.Server.address() for
more information.


server.close([callback])#



Added in: v0.3.2

Stops the server from accepting new connections. This function is
asynchronous, the server is finally closed when the server emits a 'close'
event.  Optionally, you can pass a callback to listen for the 'close' event.


server.connections#



Added in: v0.3.2

The number of concurrent connections on the server.


server.getTicketKeys()#



Added in: v3.0.0

Returns Buffer instance holding the keys currently used for
encryption/decryption of the TLS Session Tickets


server.listen(port[, hostname][, callback])#



Added in: v0.3.2

Begin accepting connections on the specified port and hostname. If the
hostname is omitted, the server will accept connections on any IPv6 address
(::) when IPv6 is available, or any IPv4 address (0.0.0.0) otherwise. A
port value of zero will assign a random port.


This function is asynchronous. The last parameter callback will be called
when the server has been bound.


See net.Server for more information.


server.maxConnections#



Added in: v0.2.0

Set this property to reject connections when the server's connection count
gets high.


server.setTicketKeys(keys)#



Added in: v3.0.0

Updates the keys for encryption/decryption of the TLS Session Tickets.


NOTE: the buffer should be 48 bytes long. See server ticketKeys option for
more information oh how it is going to be used.


NOTE: the change is effective only for the future server connections. Existing
or currently pending server connections will use previous keys.


Class: tls.TLSSocket#



Added in: v0.11.4

This is a wrapped version of net.Socket that does transparent encryption
of written data and all required TLS negotiation.


This instance implements a duplex Stream interfaces.  It has all the
common stream methods and events.


Methods that return TLS connection meta data (e.g.
tls.TLSSocket.getPeerCertificate() will only return data while the
connection is open.


new tls.TLSSocket(socket[, options])#



Added in: v0.11.4

Construct a new TLSSocket object from existing TCP socket.


socket is an instance of net.Socket


options is an optional object that might contain following properties:


    

  • secureContext: An optional TLS context object from
 tls.createSecureContext()
    

    • 

  • isServer: If true the TLS socket will be instantiated in server-mode.
Default: false
    

    • 

  • server: An optional net.Server instance
    

    • 

  • requestCert: Optional, see tls.createSecurePair()
    

    • 

  • rejectUnauthorized: Optional, see tls.createSecurePair()
    

    • 

  • NPNProtocols: Optional, see tls.createServer()
    

    • 

  • ALPNProtocols: Optional, see [tls.createServer][]
    

    • 

  • SNICallback: Optional, see tls.createServer()
    

    • 

  • session: Optional, a Buffer instance, containing TLS session
    

    • 

  • requestOCSP: Optional, if true the OCSP status request extension will
be added to the client hello, and an 'OCSPResponse' event will be emitted
on the socket before establishing a secure communication
    

    • 



Event: 'OCSPResponse'#



Added in: v0.11.13

function (response) { }


This event will be emitted if requestOCSP option was set. response is a
buffer object, containing server's OCSP response.


Traditionally, the response is a signed object from the server's CA that
contains information about server's certificate revocation status.


Event: 'secureConnect'#



Added in: v0.11.4

This event is emitted after a new connection has been successfully handshaked.
The listener will be called no matter if the server's certificate was
authorized or not. It is up to the user to test tlsSocket.authorized
to see if the server certificate was signed by one of the specified CAs.
If tlsSocket.authorized === false then the error can be found in
tlsSocket.authorizationError. Also if ALPN or NPN was used - you can
check tlsSocket.alpnProtocol or tlsSocket.npnProtocol for the
negotiated protocol.


tlsSocket.address()#



Added in: v0.11.4

Returns the bound address, the address family name and port of the
underlying socket as reported by the operating system. Returns an
object with three properties, e.g.
{ port: 12346, family: 'IPv4', address: '127.0.0.1' }


tlsSocket.authorized#



Added in: v0.11.4

A boolean that is true if the peer certificate was signed by one of the
specified CAs, otherwise false


tlsSocket.authorizationError#



Added in: v0.11.4

The reason why the peer's certificate has not been verified. This property
becomes available only when tlsSocket.authorized === false.


tlsSocket.encrypted#



Added in: v0.11.4

Static boolean value, always true. May be used to distinguish TLS sockets
from regular ones.


tlsSocket.getCipher()#



Added in: v0.11.4

Returns an object representing the cipher name and the SSL/TLS
protocol version of the current connection.


Example:
<name: 'AES256-SHA', version: 'TLSv1/SSLv3'>


See SSL_CIPHER_get_name() and SSL_CIPHER_get_version() in
https://www.openssl.org/docs/ssl/ssl.html#DEALING-WITH-CIPHERS for more
information.


tlsSocket.getPeerCertificate([ detailed ])#



Added in: v0.11.4

Returns an object representing the peer's certificate. The returned object has
some properties corresponding to the field of the certificate. If detailed
argument is true the full chain with issuer property will be returned,
if false only the top certificate without issuer property.


Example:


{ subject:
   { C: 'UK',
     ST: 'Acknack Ltd',
     L: 'Rhys Jones',
     O: 'node.js',
     OU: 'Test TLS Certificate',
     CN: 'localhost' },
  issuerInfo:
   { C: 'UK',
     ST: 'Acknack Ltd',
     L: 'Rhys Jones',
     O: 'node.js',
     OU: 'Test TLS Certificate',
     CN: 'localhost' },
  issuer:
   { ... another certificate ... },
  raw: < RAW DER buffer >,
  valid_from: 'Nov 11 09:52:22 2009 GMT',
  valid_to: 'Nov  6 09:52:22 2029 GMT',
  fingerprint: '2A:7A:C2:DD:E5:F9:CC:53:72:35:99:7A:02:5A:71:38:52:EC:8A:DF',
  serialNumber: 'B9B0D332A1AA5635' }

If the peer does not provide a certificate, it returns null or an empty
object.


tlsSocket.getSession()#



Added in: v0.11.4

Return ASN.1 encoded TLS session or undefined if none was negotiated. Could
be used to speed up handshake establishment when reconnecting to the server.


tlsSocket.getTLSTicket()#



Added in: v0.11.4

NOTE: Works only with client TLS sockets. Useful only for debugging, for
session reuse provide session option to tls.connect().


Return TLS session ticket or undefined if none was negotiated.


tlsSocket.localPort#



Added in: v0.11.4

The numeric representation of the local port.


tlsSocket.localAddress#



Added in: v0.11.4

The string representation of the local IP address.


tlsSocket.remoteAddress#



Added in: v0.11.4

The string representation of the remote IP address. For example,
'74.125.127.100' or '2001:4860:a005::68'.


tlsSocket.remoteFamily#



Added in: v0.11.4

The string representation of the remote IP family. 'IPv4' or 'IPv6'.


tlsSocket.remotePort#



Added in: v0.11.4

The numeric representation of the remote port. For example, 443.


tlsSocket.renegotiate(options, callback)#



Added in: v0.11.8

Initiate TLS renegotiation process. The options may contain the following
fields: rejectUnauthorized, requestCert (See tls.createServer() for
details). callback(err) will be executed with null as err,
once the renegotiation is successfully completed.


NOTE: Can be used to request peer's certificate after the secure connection
has been established.


ANOTHER NOTE: When running as the server, socket will be destroyed
with an error after handshakeTimeout timeout.


tlsSocket.setMaxSendFragment(size)#



Added in: v0.11.11

Set maximum TLS fragment size (default and maximum value is: 16384, minimum
is: 512). Returns true on success, false otherwise.


Smaller fragment size decreases buffering latency on the client: large
fragments are buffered by the TLS layer until the entire fragment is received
and its integrity is verified; large fragments can span multiple roundtrips,
and their processing can be delayed due to packet loss or reordering. However,
smaller fragments add extra TLS framing bytes and CPU overhead, which may
decrease overall server throughput.


tls.connect(options[, callback])#


tls.connect(port[, host][, options][, callback])#



Added in: v0.11.3

Creates a new client connection to the given port and host (old API) or
options.port and options.host. (If host is omitted, it defaults to
localhost.) options should be an object which specifies:


    

  • host: Host the client should connect to
    

    • 

  • port: Port the client should connect to
    

    • 

  • socket: Establish secure connection on a given socket rather than
creating a new socket. If this option is specified, host and port
are ignored.
    

    • 

  • path: Creates unix socket connection to path. If this option is
specified, host and port are ignored.
    

    • 

  • pfx: A string or Buffer containing the private key, certificate and
CA certs of the client in PFX or PKCS12 format.
    

    • 

  • key: A string or Buffer containing the private key of the client in
PEM format. (Could be an array of keys).
    

    • 

  • passphrase: A string of passphrase for the private key or pfx.
    

    • 

  • cert: A string or Buffer containing the certificate key of the client in
PEM format. (Could be an array of certs).
    

    • 

  • ca: A string, Buffer or array of strings or Buffers of trusted
certificates in PEM format. If this is omitted several well known "root"
CAs will be used, like VeriSign. These are used to authorize connections.
    

    • 

  • ciphers: A string describing the ciphers to use or exclude, separated by
:. Uses the same default cipher suite as tls.createServer().
    

    • 

  • rejectUnauthorized: If true, the server certificate is verified against
the list of supplied CAs. An 'error' event is emitted if verification
fails; err.code contains the OpenSSL error code. Default: true.
    

    • 

  • NPNProtocols: An array of strings or Buffers containing supported NPN
protocols. Buffers should have following format: 0x05hello0x05world,
where first byte is next protocol name's length. (Passing array should
usually be much simpler: ['hello', 'world'].)
    

    • 

  • ALPNProtocols: An array of strings or Buffers containing
supported ALPN protocols. Buffers should have following format:
0x05hello0x05world, where the first byte is the next protocol
name's length. (Passing array should usually be much simpler:
['hello', 'world'].)
    

    • 

  • servername: Servername for SNI (Server Name Indication) TLS extension.
    

    • 

  • checkServerIdentity(servername, cert): Provide an override for checking
server's hostname against the certificate. Should return an error if verification
fails. Return undefined if passing.
    

    • 

  • secureProtocol: The SSL method to use, e.g. SSLv3_method to force
SSL version 3. The possible values depend on your installation of
OpenSSL and are defined in the constant SSL_METHODS.
    

    • 

  • secureContext: An optional TLS context object from
 tls.createSecureContext( ... ). Could it be used for caching client
 certificates, key, and CA certificates.
    

    • 

  • session: A Buffer instance, containing TLS session.
    

    • 



The callback parameter will be added as a listener for the
'secureConnect' event.


tls.connect() returns a tls.TLSSocket object.


Here is an example of a client of echo server as described previously:


const tls = require('tls');
const fs = require('fs');

const options = {
  // These are necessary only if using the client certificate authentication
  key: fs.readFileSync('client-key.pem'),
  cert: fs.readFileSync('client-cert.pem'),

  // This is necessary only if the server uses the self-signed certificate
  ca: [ fs.readFileSync('server-cert.pem') ]
};

var socket = tls.connect(8000, options, () => {
  console.log('client connected',
              socket.authorized ? 'authorized' : 'unauthorized');
  process.stdin.pipe(socket);
  process.stdin.resume();
});
socket.setEncoding('utf8');
socket.on('data', (data) => {
  console.log(data);
});
socket.on('end', () => {
  server.close();
});



Or


const tls = require('tls');
const fs = require('fs');

const options = {
  pfx: fs.readFileSync('client.pfx')
};

var socket = tls.connect(8000, options, () => {
  console.log('client connected',
              socket.authorized ? 'authorized' : 'unauthorized');
  process.stdin.pipe(socket);
  process.stdin.resume();
});
socket.setEncoding('utf8');
socket.on('data', (data) => {
  console.log(data);
});
socket.on('end', () => {
  server.close();
});



tls.createSecureContext(details)#



Added in: v0.11.13

Creates a credentials object, with the optional details being a
dictionary with keys:


    

  • pfx : A string or buffer holding the PFX or PKCS12 encoded private
key, certificate and CA certificates
    • 

  • key: A string or Buffer containing the private key of the server in
PEM format. To support multiple keys using different algorithms, an array
can be provided. It can either be a plain array of keys, or an array of
objects in the format {pem: key, passphrase: passphrase}. (Required)
    • 

  • passphrase : A string of passphrase for the private key or pfx
    • 

  • cert : A string holding the PEM encoded certificate
    • 

  • ca: A string, Buffer or array of strings or Buffers of trusted
certificates in PEM format. If this is omitted several well known "root"
CAs will be used, like VeriSign. These are used to authorize connections.
    • 

  • crl : Either a string or list of strings of PEM encoded CRLs
(Certificate Revocation List)
    • 

  • ciphers: A string describing the ciphers to use or exclude.
Consult
https://www.openssl.org/docs/apps/ciphers.html#CIPHER-LIST-FORMAT
for details on the format.
    • 

  • honorCipherOrder : When choosing a cipher, use the server's preferences
instead of the client preferences. For further details see tls module
documentation.
    • 



If no 'ca' details are given, then Node.js will use the default
publicly trusted list of CAs as given in
http://mxr.mozilla.org/mozilla/source/security/nss/lib/ckfw/builtins/certdata.txt.


tls.createSecurePair([context][, isServer][, requestCert][, rejectUnauthorized][, options])#


Creates a new secure pair object with two streams, one of which reads/writes
encrypted data, and one reads/writes cleartext data.
Generally the encrypted one is piped to/from an incoming encrypted data stream,
and the cleartext one is used as a replacement for the initial encrypted stream.


    

  • credentials: A secure context object from tls.createSecureContext( ... )
    

    • 

  • isServer: A boolean indicating whether this tls connection should be
opened as a server or a client.
    

    • 

  • requestCert: A boolean indicating whether a server should request a
certificate from a connecting client. Only applies to server connections.
    

    • 

  • rejectUnauthorized: A boolean indicating whether a server should
automatically reject clients with invalid certificates. Only applies to
servers with requestCert enabled.
    

    • 

  • options: An object with common SSL options. See tls.TLSSocket.
    

    • 



tls.createSecurePair() returns a SecurePair object with cleartext and
encrypted stream properties.


NOTE: cleartext has the same APIs as tls.TLSSocket


tls.createServer(options[, secureConnectionListener])#



Added in: v0.3.2

Creates a new tls.Server.  The connectionListener argument is
automatically set as a listener for the 'secureConnection' event.  The
options object has these possibilities:


    

  • pfx: A string or Buffer containing the private key, certificate and
CA certs of the server in PFX or PKCS12 format. (Mutually exclusive with
the key, cert and ca options.)
    

    • 

  • key: A string or Buffer containing the private key of the server in
PEM format. To support multiple keys using different algorithms, an array
can be provided. It can either be a plain array of keys, or an array of
objects in the format {pem: key, passphrase: passphrase}. (Required)
    

    • 

  • passphrase: A string of passphrase for the private key or pfx.
    

    • 

  • cert: A string or Buffer containing the certificate key of the server in
PEM format. (Could be an array of certs). (Required)
    

    • 

  • ca: A string, Buffer or array of strings or Buffers of trusted
certificates in PEM format. If this is omitted several well known "root"
CAs will be used, like VeriSign. These are used to authorize connections.
    

    • 

  • crl : Either a string or list of strings of PEM encoded CRLs (Certificate
Revocation List)
    

    • 

  • ciphers: A string describing the ciphers to use or exclude, separated by
:. The default cipher suite is:
    

    ECDHE-RSA-AES128-GCM-SHA256:
ECDHE-ECDSA-AES128-GCM-SHA256:
ECDHE-RSA-AES256-GCM-SHA384:
ECDHE-ECDSA-AES256-GCM-SHA384:
DHE-RSA-AES128-GCM-SHA256:
ECDHE-RSA-AES128-SHA256:
DHE-RSA-AES128-SHA256:
ECDHE-RSA-AES256-SHA384:
DHE-RSA-AES256-SHA384:
ECDHE-RSA-AES256-SHA256:
DHE-RSA-AES256-SHA256:
HIGH:
!aNULL:
!eNULL:
!EXPORT:
!DES:
!RC4:
!MD5:
!PSK:
!SRP:
!CAMELLIA

    

    The default cipher suite prefers GCM ciphers for Chrome's 'modern
cryptography' setting and also prefers ECDHE and DHE ciphers for Perfect
Forward secrecy, while offering some backward compatibiltity.
    

    128 bit AES is preferred over 192 and 256 bit AES in light of specific
attacks affecting larger AES key sizes.
    

    Old clients that rely on insecure and deprecated RC4 or DES-based ciphers
(like Internet Explorer 6) aren't able to complete the handshake with the default
configuration. If you absolutely must support these clients, the
TLS recommendations may offer a compatible cipher suite. For more details
on the format, see the OpenSSL cipher list format documentation.
    

    • 

  • ecdhCurve: A string describing a named curve to use for ECDH key agreement
or false to disable ECDH.
    

    Defaults to prime256v1 (NIST P-256). Use crypto.getCurves() to obtain
a list of available curve names. On recent releases,
openssl ecparam -list_curves will also display the name and description of
each available elliptic curve.
    

    • 

  • dhparam: A string or Buffer containing Diffie Hellman parameters,
required for Perfect Forward Secrecy. Use openssl dhparam to create it.
Its key length should be greater than or equal to 1024 bits, otherwise
it throws an error. It is strongly recommended to use 2048 bits or
more for stronger security. If omitted or invalid, it is silently
discarded and DHE ciphers won't be available.
    

    • 

  • handshakeTimeout: Abort the connection if the SSL/TLS handshake does not
finish in this many milliseconds. The default is 120 seconds.
    

    A 'clientError' is emitted on the tls.Server object whenever a handshake
times out.
    

    • 

  • honorCipherOrder : When choosing a cipher, use the server's preferences
instead of the client preferences. Default: true.
    

    • 

  • requestCert: If true the server will request a certificate from
clients that connect and attempt to verify that certificate. Default:
false.
    

    • 

  • rejectUnauthorized: If true the server will reject any connection
which is not authorized with the list of supplied CAs. This option only
has an effect if requestCert is true. Default: false.
    

    • 

  • NPNProtocols: An array or Buffer of possible NPN protocols. (Protocols
should be ordered by their priority).
    

    • 

  • ALPNProtocols: An array or Buffer of possible ALPN
protocols. (Protocols should be ordered by their priority). When
the server receives both NPN and ALPN extensions from the client,
ALPN takes precedence over NPN and the server does not send an NPN
extension to the client.
    

    • 

  • SNICallback(servername, cb): A function that will be called if client
supports SNI TLS extension. Two argument will be passed to it: servername,
and cb. SNICallback should invoke cb(null, ctx), where ctx is a
SecureContext instance.
(You can use tls.createSecureContext(...) to get proper
SecureContext). If SNICallback wasn't provided the default callback with
high-level API will be used (see below).
    

    • 

  • sessionTimeout: An integer specifying the seconds after which TLS
session identifiers and TLS session tickets created by the server are
timed out. See SSL_CTX_set_timeout for more details.
    

    • 

  • ticketKeys: A 48-byte Buffer instance consisting of 16-byte prefix,
16-byte hmac key, 16-byte AES key. You could use it to accept tls session
tickets on multiple instances of tls server.
    

    NOTE: Automatically shared between cluster module workers.
    

    • 

  • sessionIdContext: A string containing an opaque identifier for session
resumption. If requestCert is true, the default is MD5 hash value
generated from command-line. (In FIPS mode a truncated SHA1 hash is
used instead.) Otherwise, the default is not provided.
    

    • 

  • secureProtocol: The SSL method to use, e.g. SSLv3_method to force
SSL version 3. The possible values depend on your installation of
OpenSSL and are defined in the constant SSL_METHODS.
    

    • 



Here is a simple example echo server:


const tls = require('tls');
const fs = require('fs');

const options = {
  key: fs.readFileSync('server-key.pem'),
  cert: fs.readFileSync('server-cert.pem'),

  // This is necessary only if using the client certificate authentication.
  requestCert: true,

  // This is necessary only if the client uses the self-signed certificate.
  ca: [ fs.readFileSync('client-cert.pem') ]
};

var server = tls.createServer(options, (socket) => {
  console.log('server connected',
              socket.authorized ? 'authorized' : 'unauthorized');
  socket.write('welcome!\n');
  socket.setEncoding('utf8');
  socket.pipe(socket);
});
server.listen(8000, () => {
  console.log('server bound');
});



Or


const tls = require('tls');
const fs = require('fs');

const options = {
  pfx: fs.readFileSync('server.pfx'),

  // This is necessary only if using the client certificate authentication.
  requestCert: true,

};

var server = tls.createServer(options, (socket) => {
  console.log('server connected',
              socket.authorized ? 'authorized' : 'unauthorized');
  socket.write('welcome!\n');
  socket.setEncoding('utf8');
  socket.pipe(socket);
});
server.listen(8000, () => {
  console.log('server bound');
});



You can test this server by connecting to it with openssl s_client:


openssl s_client -connect 127.0.0.1:8000

tls.getCiphers()#



Added in: v0.10.2

Returns an array with the names of the supported SSL ciphers.


Example:


var ciphers = tls.getCiphers();
console.log(ciphers); // ['AES128-SHA', 'AES256-SHA', ...]



      

    

  

  
  
  
  



node-v4.8.2/doc/api/tls.json000644 000766 000024 00000175067 13070706740 016007 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/tls.md",
  "modules": [
    {
      "textRaw": "TLS (SSL)",
      "name": "tls_(ssl)",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
Use require('tls') to access this module.
\n
The tls module uses OpenSSL to provide Transport Layer Security and/or\nSecure Socket Layer: encrypted stream communication.
\n
TLS/SSL is a public/private key infrastructure. Each client and each\nserver must have a private key. A private key is created like this:
\n
openssl genrsa -out ryans-key.pem 2048\n
All servers and some clients need to have a certificate. Certificates are public\nkeys signed by a Certificate Authority or self-signed. The first step to\ngetting a certificate is to create a "Certificate Signing Request" (CSR)\nfile. This is done with:
\n
openssl req -new -sha256 -key ryans-key.pem -out ryans-csr.pem\n
To create a self-signed certificate with the CSR, do this:
\n
openssl x509 -req -in ryans-csr.pem -signkey ryans-key.pem -out ryans-cert.pem\n
Alternatively you can send the CSR to a Certificate Authority for signing.
\n
For Perfect Forward Secrecy, it is required to generate Diffie-Hellman\nparameters:
\n
openssl dhparam -outform PEM -out dhparam.pem 2048\n
To create .pfx or .p12, do this:
\n
openssl pkcs12 -export -in agent5-cert.pem -inkey agent5-key.pem \\\n      -certfile ca-cert.pem -out agent5.pfx\n
    \n
  • in:  certificate
    • \n
  • inkey: private key
    • \n
  • certfile: all CA certs concatenated in one file like\ncat ca1-cert.pem ca2-cert.pem > ca-cert.pem
    • \n
\n",
      "miscs": [
        {
          "textRaw": "Client-initiated renegotiation attack mitigation",
          "name": "Client-initiated renegotiation attack mitigation",
          "type": "misc",
          "desc": "
The TLS protocol lets the client renegotiate certain aspects of the TLS session.\nUnfortunately, session renegotiation requires a disproportional amount of\nserver-side resources, which makes it a potential vector for denial-of-service\nattacks.
\n
To mitigate this, renegotiations are limited to three times every 10 minutes. An\nerror is emitted on the tls.TLSSocket instance when the threshold is\nexceeded. The limits are configurable:
\n
    \n
  • tls.CLIENT_RENEG_LIMIT: renegotiation limit, default is 3.
    \n
    • \n
  • tls.CLIENT_RENEG_WINDOW: renegotiation window in seconds, default is\n10 minutes.
    \n
    • \n
\n
Don't change the defaults unless you know what you are doing.
\n
To test your server, connect to it with openssl s_client -connect address:port\nand tap R<CR> (that's the letter R followed by a carriage return) a few\ntimes.
\n"
        },
        {
          "textRaw": "ALPN, NPN and SNI",
          "name": "ALPN, NPN and SNI",
          "type": "misc",
          "desc": "
ALPN (Application-Layer Protocol Negotiation Extension), NPN (Next\nProtocol Negotiation) and SNI (Server Name Indication) are TLS\nhandshake extensions allowing you:
\n
    \n
  • ALPN/NPN - to use one TLS server for multiple protocols (HTTP, SPDY, HTTP/2)
    • \n
  • SNI - to use one TLS server for multiple hostnames with different SSL\ncertificates.
    • \n
\n"
        },
        {
          "textRaw": "Perfect Forward Secrecy",
          "name": "Perfect Forward Secrecy",
          "type": "misc",
          "desc": "
The term "Forward Secrecy" or "Perfect Forward Secrecy" describes a feature of\nkey-agreement (i.e. key-exchange) methods. Practically it means that even if the\nprivate key of a (your) server is compromised, communication can only be\ndecrypted by eavesdroppers if they manage to obtain the key-pair specifically\ngenerated for each session.
\n
This is achieved by randomly generating a key pair for key-agreement on every\nhandshake (in contrary to the same key for all sessions). Methods implementing\nthis technique, thus offering Perfect Forward Secrecy, are called "ephemeral".
\n
Currently two methods are commonly used to achieve Perfect Forward Secrecy (note\nthe character "E" appended to the traditional abbreviations):
\n
    \n
  • DHE - An ephemeral version of the Diffie Hellman key-agreement protocol.
    • \n
  • ECDHE - An ephemeral version of the Elliptic Curve Diffie Hellman\nkey-agreement protocol.
    • \n
\n
Ephemeral methods may have some performance drawbacks, because key generation\nis expensive.
\n"
        }
      ],
      "modules": [
        {
          "textRaw": "Modifying the Default TLS Cipher suite",
          "name": "modifying_the_default_tls_cipher_suite",
          "desc": "
Node.js is built with a default suite of enabled and disabled TLS ciphers.\nCurrently, the default cipher suite is:
\n
ECDHE-RSA-AES128-GCM-SHA256:\nECDHE-ECDSA-AES128-GCM-SHA256:\nECDHE-RSA-AES256-GCM-SHA384:\nECDHE-ECDSA-AES256-GCM-SHA384:\nDHE-RSA-AES128-GCM-SHA256:\nECDHE-RSA-AES128-SHA256:\nDHE-RSA-AES128-SHA256:\nECDHE-RSA-AES256-SHA384:\nDHE-RSA-AES256-SHA384:\nECDHE-RSA-AES256-SHA256:\nDHE-RSA-AES256-SHA256:\nHIGH:\n!aNULL:\n!eNULL:\n!EXPORT:\n!DES:\n!RC4:\n!MD5:\n!PSK:\n!SRP:\n!CAMELLIA\n
This default can be overriden entirely using the --tls-cipher-list command\nline switch. For instance, the following makes\nECDHE-RSA-AES128-GCM-SHA256:!RC4 the default TLS cipher suite:
\n
node --tls-cipher-list="ECDHE-RSA-AES128-GCM-SHA256:!RC4"\n
Note that the default cipher suite included within Node.js has been carefully\nselected to reflect current security best practices and risk mitigation.\nChanging the default cipher suite can have a significant impact on the security\nof an application. The --tls-cipher-list switch should by used only if\nabsolutely necessary.
\n",
          "type": "module",
          "displayName": "Modifying the Default TLS Cipher suite"
        }
      ],
      "classes": [
        {
          "textRaw": "Class: CryptoStream",
          "type": "class",
          "name": "CryptoStream",
          "stability": 0,
          "stabilityText": "Deprecated: Use [`tls.TLSSocket`][] instead.",
          "desc": "
This is an encrypted stream.
\n",
          "properties": [
            {
              "textRaw": "cryptoStream.bytesWritten",
              "name": "bytesWritten",
              "desc": "
A proxy to the underlying socket's bytesWritten accessor, this will return\nthe total bytes written to the socket, including the TLS overhead.
\n"
            }
          ]
        },
        {
          "textRaw": "Class: SecurePair",
          "type": "class",
          "name": "SecurePair",
          "desc": "
Returned by tls.createSecurePair.
\n",
          "events": [
            {
              "textRaw": "Event: 'secure'",
              "type": "event",
              "name": "secure",
              "desc": "
The event is emitted from the SecurePair once the pair has successfully\nestablished a secure connection.
\n
Similarly to the checking for the server 'secureConnection' event,\npair.cleartext.authorized should be checked to confirm whether the certificate\nused properly authorized.
\n",
              "params": []
            }
          ]
        },
        {
          "textRaw": "Class: tls.Server",
          "type": "class",
          "name": "tls.Server",
          "meta": {
            "added": [
              "v0.3.2"
            ]
          },
          "desc": "
This class is a subclass of net.Server and has the same methods on it.\nInstead of accepting just raw TCP connections, this accepts encrypted\nconnections using TLS or SSL.
\n",
          "events": [
            {
              "textRaw": "Event: 'clientError'",
              "type": "event",
              "name": "clientError",
              "meta": {
                "added": [
                  "v0.11.11"
                ]
              },
              "desc": "
function (exception, tlsSocket) { }
\n
When a client connection emits an 'error' event before a secure connection is\nestablished it will be forwarded here.
\n
tlsSocket is the tls.TLSSocket that the error originated from.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'newSession'",
              "type": "event",
              "name": "newSession",
              "meta": {
                "added": [
                  "v0.9.2"
                ]
              },
              "desc": "
function (sessionId, sessionData, callback) { }
\n
Emitted on creation of TLS session. May be used to store sessions in external\nstorage. callback must be invoked eventually, otherwise no data will be\nsent or received from secure connection.
\n
NOTE: adding this event listener will have an effect only on connections\nestablished after addition of event listener.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'OCSPRequest'",
              "type": "event",
              "name": "OCSPRequest",
              "meta": {
                "added": [
                  "v0.11.13"
                ]
              },
              "desc": "
function (certificate, issuer, callback) { }
\n
Emitted when the client sends a certificate status request. You could parse\nserver's current certificate to obtain OCSP url and certificate id, and after\nobtaining OCSP response invoke callback(null, resp), where resp is a\nBuffer instance. Both certificate and issuer are a Buffer\nDER-representations of the primary and issuer's certificates. They could be used\nto obtain OCSP certificate id and OCSP endpoint url.
\n
Alternatively, callback(null, null) could be called, meaning that there is no\nOCSP response.
\n
Calling callback(err) will result in a socket.destroy(err) call.
\n
Typical flow:
\n
    \n
  1. Client connects to server and sends 'OCSPRequest' to it (via status info\nextension in ClientHello.)
    2. \n
  2. Server receives request and invokes 'OCSPRequest' event listener if present
    3. \n
  3. Server grabs OCSP url from either certificate or issuer and performs an\nOCSP request to the CA
    4. \n
  4. Server receives OCSPResponse from CA and sends it back to client via\ncallback argument
    5. \n
  5. Client validates the response and either destroys socket or performs a\nhandshake.
    6. \n
\n
NOTE: issuer could be null, if the certificate is self-signed or if the issuer\nis not in the root certificates list. (You could provide an issuer via ca\noption.)
\n
NOTE: adding this event listener will have an effect only on connections\nestablished after addition of event listener.
\n
NOTE: you may want to use some npm module like asn1.js to parse the\ncertificates.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'resumeSession'",
              "type": "event",
              "name": "resumeSession",
              "meta": {
                "added": [
                  "v0.9.2"
                ]
              },
              "desc": "
function (sessionId, callback) { }
\n
Emitted when client wants to resume previous TLS session. Event listener may\nperform lookup in external storage using given sessionId, and invoke\ncallback(null, sessionData) once finished. If session can't be resumed\n(i.e. doesn't exist in storage) one may call callback(null, null). Calling\ncallback(err) will terminate incoming connection and destroy socket.
\n
NOTE: adding this event listener will have an effect only on connections\nestablished after addition of event listener.
\n
Here's an example for using TLS session resumption:
\n
var tlsSessionStore = {};\nserver.on('newSession', (id, data, cb) => {\n  tlsSessionStore[id.toString('hex')] = data;\n  cb();\n});\nserver.on('resumeSession', (id, cb) => {\n  cb(null, tlsSessionStore[id.toString('hex')] || null);\n});\n
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'secureConnection'",
              "type": "event",
              "name": "secureConnection",
              "meta": {
                "added": [
                  "v0.3.2"
                ]
              },
              "desc": "
function (tlsSocket) {}
\n
This event is emitted after a new connection has been successfully\nhandshaked. The argument is an instance of tls.TLSSocket. It has all the\ncommon stream methods and events.
\n
socket.authorized is a boolean value which indicates if the\nclient has verified by one of the supplied certificate authorities for the\nserver. If socket.authorized is false, then\nsocket.authorizationError is set to describe how authorization\nfailed. Implied but worth mentioning: depending on the settings of the TLS\nserver, you unauthorized connections may be accepted.
\n
socket.npnProtocol is a string containing the selected NPN protocol\nand socket.alpnProtocol is a string containing the selected ALPN\nprotocol, When both NPN and ALPN extensions are received, ALPN takes\nprecedence over NPN and the next protocol is selected by ALPN. When\nALPN has no selected protocol, this returns false.
\n
socket.servername is a string containing servername requested with\nSNI.
\n",
              "params": []
            }
          ],
          "methods": [
            {
              "textRaw": "server.addContext(hostname, context)",
              "type": "method",
              "name": "addContext",
              "meta": {
                "added": [
                  "v0.5.3"
                ]
              },
              "desc": "
Add secure context that will be used if client request's SNI hostname is\nmatching passed hostname (wildcards can be used). context can contain\nkey, cert, ca and/or any other properties from\ntls.createSecureContext() options argument.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "hostname"
                    },
                    {
                      "name": "context"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "server.address()",
              "type": "method",
              "name": "address",
              "meta": {
                "added": [
                  "v0.6.0"
                ]
              },
              "desc": "
Returns the bound address, the address family name and port of the\nserver as reported by the operating system.  See net.Server.address() for\nmore information.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "server.close([callback])",
              "type": "method",
              "name": "close",
              "meta": {
                "added": [
                  "v0.3.2"
                ]
              },
              "desc": "
Stops the server from accepting new connections. This function is\nasynchronous, the server is finally closed when the server emits a 'close'\nevent.  Optionally, you can pass a callback to listen for the 'close' event.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "server.getTicketKeys()",
              "type": "method",
              "name": "getTicketKeys",
              "meta": {
                "added": [
                  "v3.0.0"
                ]
              },
              "desc": "
Returns Buffer instance holding the keys currently used for\nencryption/decryption of the TLS Session Tickets
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "server.listen(port[, hostname][, callback])",
              "type": "method",
              "name": "listen",
              "meta": {
                "added": [
                  "v0.3.2"
                ]
              },
              "desc": "
Begin accepting connections on the specified port and hostname. If the\nhostname is omitted, the server will accept connections on any IPv6 address\n(::) when IPv6 is available, or any IPv4 address (0.0.0.0) otherwise. A\nport value of zero will assign a random port.
\n
This function is asynchronous. The last parameter callback will be called\nwhen the server has been bound.
\n
See net.Server for more information.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "port"
                    },
                    {
                      "name": "hostname",
                      "optional": true
                    },
                    {
                      "name": "callback",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "server.setTicketKeys(keys)",
              "type": "method",
              "name": "setTicketKeys",
              "meta": {
                "added": [
                  "v3.0.0"
                ]
              },
              "desc": "
Updates the keys for encryption/decryption of the TLS Session Tickets.
\n
NOTE: the buffer should be 48 bytes long. See server ticketKeys option for\nmore information oh how it is going to be used.
\n
NOTE: the change is effective only for the future server connections. Existing\nor currently pending server connections will use previous keys.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "keys"
                    }
                  ]
                }
              ]
            }
          ],
          "properties": [
            {
              "textRaw": "server.connections",
              "name": "connections",
              "meta": {
                "added": [
                  "v0.3.2"
                ]
              },
              "desc": "
The number of concurrent connections on the server.
\n"
            },
            {
              "textRaw": "server.maxConnections",
              "name": "maxConnections",
              "meta": {
                "added": [
                  "v0.2.0"
                ]
              },
              "desc": "
Set this property to reject connections when the server's connection count\ngets high.
\n"
            }
          ]
        },
        {
          "textRaw": "Class: tls.TLSSocket",
          "type": "class",
          "name": "tls.TLSSocket",
          "meta": {
            "added": [
              "v0.11.4"
            ]
          },
          "desc": "
This is a wrapped version of net.Socket that does transparent encryption\nof written data and all required TLS negotiation.
\n
This instance implements a duplex Stream interfaces.  It has all the\ncommon stream methods and events.
\n
Methods that return TLS connection meta data (e.g.\ntls.TLSSocket.getPeerCertificate() will only return data while the\nconnection is open.
\n"
        }
      ],
      "methods": [
        {
          "textRaw": "new tls.TLSSocket(socket[, options])",
          "type": "method",
          "name": "TLSSocket",
          "meta": {
            "added": [
              "v0.11.4"
            ]
          },
          "desc": "
Construct a new TLSSocket object from existing TCP socket.
\n
socket is an instance of net.Socket
\n
options is an optional object that might contain following properties:
\n
    \n
  • secureContext: An optional TLS context object from\n tls.createSecureContext()
    \n
    • \n
  • isServer: If true the TLS socket will be instantiated in server-mode.\nDefault: false
    \n
    • \n
  • server: An optional net.Server instance
    \n
    • \n
  • requestCert: Optional, see tls.createSecurePair()
    \n
    • \n
  • rejectUnauthorized: Optional, see tls.createSecurePair()
    \n
    • \n
  • NPNProtocols: Optional, see tls.createServer()
    \n
    • \n
  • ALPNProtocols: Optional, see [tls.createServer][]
    \n
    • \n
  • SNICallback: Optional, see tls.createServer()
    \n
    • \n
  • session: Optional, a Buffer instance, containing TLS session
    \n
    • \n
  • requestOCSP: Optional, if true the OCSP status request extension will\nbe added to the client hello, and an 'OCSPResponse' event will be emitted\non the socket before establishing a secure communication
    \n
    • \n
\n",
          "events": [
            {
              "textRaw": "Event: 'OCSPResponse'",
              "type": "event",
              "name": "OCSPResponse",
              "meta": {
                "added": [
                  "v0.11.13"
                ]
              },
              "desc": "
function (response) { }
\n
This event will be emitted if requestOCSP option was set. response is a\nbuffer object, containing server's OCSP response.
\n
Traditionally, the response is a signed object from the server's CA that\ncontains information about server's certificate revocation status.
\n",
              "params": []
            },
            {
              "textRaw": "Event: 'secureConnect'",
              "type": "event",
              "name": "secureConnect",
              "meta": {
                "added": [
                  "v0.11.4"
                ]
              },
              "desc": "
This event is emitted after a new connection has been successfully handshaked.\nThe listener will be called no matter if the server's certificate was\nauthorized or not. It is up to the user to test tlsSocket.authorized\nto see if the server certificate was signed by one of the specified CAs.\nIf tlsSocket.authorized === false then the error can be found in\ntlsSocket.authorizationError. Also if ALPN or NPN was used - you can\ncheck tlsSocket.alpnProtocol or tlsSocket.npnProtocol for the\nnegotiated protocol.
\n",
              "params": []
            }
          ],
          "methods": [
            {
              "textRaw": "tlsSocket.address()",
              "type": "method",
              "name": "address",
              "meta": {
                "added": [
                  "v0.11.4"
                ]
              },
              "desc": "
Returns the bound address, the address family name and port of the\nunderlying socket as reported by the operating system. Returns an\nobject with three properties, e.g.\n{ port: 12346, family: 'IPv4', address: '127.0.0.1' }
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "tlsSocket.getCipher()",
              "type": "method",
              "name": "getCipher",
              "meta": {
                "added": [
                  "v0.11.4"
                ]
              },
              "desc": "
Returns an object representing the cipher name and the SSL/TLS\nprotocol version of the current connection.
\n
Example:\n{ name: 'AES256-SHA', version: 'TLSv1/SSLv3' }
\n
See SSL_CIPHER_get_name() and SSL_CIPHER_get_version() in\nhttps://www.openssl.org/docs/ssl/ssl.html#DEALING-WITH-CIPHERS for more\ninformation.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "tlsSocket.getPeerCertificate([ detailed ])",
              "type": "method",
              "name": "getPeerCertificate",
              "meta": {
                "added": [
                  "v0.11.4"
                ]
              },
              "desc": "
Returns an object representing the peer's certificate. The returned object has\nsome properties corresponding to the field of the certificate. If detailed\nargument is true the full chain with issuer property will be returned,\nif false only the top certificate without issuer property.
\n
Example:
\n
{ subject:\n   { C: 'UK',\n     ST: 'Acknack Ltd',\n     L: 'Rhys Jones',\n     O: 'node.js',\n     OU: 'Test TLS Certificate',\n     CN: 'localhost' },\n  issuerInfo:\n   { C: 'UK',\n     ST: 'Acknack Ltd',\n     L: 'Rhys Jones',\n     O: 'node.js',\n     OU: 'Test TLS Certificate',\n     CN: 'localhost' },\n  issuer:\n   { ... another certificate ... },\n  raw: < RAW DER buffer >,\n  valid_from: 'Nov 11 09:52:22 2009 GMT',\n  valid_to: 'Nov  6 09:52:22 2029 GMT',\n  fingerprint: '2A:7A:C2:DD:E5:F9:CC:53:72:35:99:7A:02:5A:71:38:52:EC:8A:DF',\n  serialNumber: 'B9B0D332A1AA5635' }\n
If the peer does not provide a certificate, it returns null or an empty\nobject.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "detailed",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "tlsSocket.getSession()",
              "type": "method",
              "name": "getSession",
              "meta": {
                "added": [
                  "v0.11.4"
                ]
              },
              "desc": "
Return ASN.1 encoded TLS session or undefined if none was negotiated. Could\nbe used to speed up handshake establishment when reconnecting to the server.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "tlsSocket.getTLSTicket()",
              "type": "method",
              "name": "getTLSTicket",
              "meta": {
                "added": [
                  "v0.11.4"
                ]
              },
              "desc": "
NOTE: Works only with client TLS sockets. Useful only for debugging, for\nsession reuse provide session option to tls.connect().
\n
Return TLS session ticket or undefined if none was negotiated.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            },
            {
              "textRaw": "tlsSocket.renegotiate(options, callback)",
              "type": "method",
              "name": "renegotiate",
              "meta": {
                "added": [
                  "v0.11.8"
                ]
              },
              "desc": "
Initiate TLS renegotiation process. The options may contain the following\nfields: rejectUnauthorized, requestCert (See tls.createServer() for\ndetails). callback(err) will be executed with null as err,\nonce the renegotiation is successfully completed.
\n
NOTE: Can be used to request peer's certificate after the secure connection\nhas been established.
\n
ANOTHER NOTE: When running as the server, socket will be destroyed\nwith an error after handshakeTimeout timeout.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "options"
                    },
                    {
                      "name": "callback"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "tlsSocket.setMaxSendFragment(size)",
              "type": "method",
              "name": "setMaxSendFragment",
              "meta": {
                "added": [
                  "v0.11.11"
                ]
              },
              "desc": "
Set maximum TLS fragment size (default and maximum value is: 16384, minimum\nis: 512). Returns true on success, false otherwise.
\n
Smaller fragment size decreases buffering latency on the client: large\nfragments are buffered by the TLS layer until the entire fragment is received\nand its integrity is verified; large fragments can span multiple roundtrips,\nand their processing can be delayed due to packet loss or reordering. However,\nsmaller fragments add extra TLS framing bytes and CPU overhead, which may\ndecrease overall server throughput.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "size"
                    }
                  ]
                }
              ]
            }
          ],
          "properties": [
            {
              "textRaw": "tlsSocket.authorized",
              "name": "authorized",
              "meta": {
                "added": [
                  "v0.11.4"
                ]
              },
              "desc": "
A boolean that is true if the peer certificate was signed by one of the\nspecified CAs, otherwise false
\n"
            },
            {
              "textRaw": "tlsSocket.authorizationError",
              "name": "authorizationError",
              "meta": {
                "added": [
                  "v0.11.4"
                ]
              },
              "desc": "
The reason why the peer's certificate has not been verified. This property\nbecomes available only when tlsSocket.authorized === false.
\n"
            },
            {
              "textRaw": "tlsSocket.encrypted",
              "name": "encrypted",
              "meta": {
                "added": [
                  "v0.11.4"
                ]
              },
              "desc": "
Static boolean value, always true. May be used to distinguish TLS sockets\nfrom regular ones.
\n"
            },
            {
              "textRaw": "tlsSocket.localPort",
              "name": "localPort",
              "meta": {
                "added": [
                  "v0.11.4"
                ]
              },
              "desc": "
The numeric representation of the local port.
\n"
            },
            {
              "textRaw": "tlsSocket.localAddress",
              "name": "localAddress",
              "meta": {
                "added": [
                  "v0.11.4"
                ]
              },
              "desc": "
The string representation of the local IP address.
\n"
            },
            {
              "textRaw": "tlsSocket.remoteAddress",
              "name": "remoteAddress",
              "meta": {
                "added": [
                  "v0.11.4"
                ]
              },
              "desc": "
The string representation of the remote IP address. For example,\n'74.125.127.100' or '2001:4860:a005::68'.
\n"
            },
            {
              "textRaw": "tlsSocket.remoteFamily",
              "name": "remoteFamily",
              "meta": {
                "added": [
                  "v0.11.4"
                ]
              },
              "desc": "
The string representation of the remote IP family. 'IPv4' or 'IPv6'.
\n"
            },
            {
              "textRaw": "tlsSocket.remotePort",
              "name": "remotePort",
              "meta": {
                "added": [
                  "v0.11.4"
                ]
              },
              "desc": "
The numeric representation of the remote port. For example, 443.
\n"
            }
          ],
          "signatures": [
            {
              "params": [
                {
                  "name": "socket"
                },
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "tls.connect(options[, callback])",
          "type": "method",
          "name": "connect",
          "meta": {
            "added": [
              "v0.11.3"
            ]
          },
          "desc": "
Creates a new client connection to the given port and host (old API) or\noptions.port and options.host. (If host is omitted, it defaults to\nlocalhost.) options should be an object which specifies:
\n
    \n
  • host: Host the client should connect to
    \n
    • \n
  • port: Port the client should connect to
    \n
    • \n
  • socket: Establish secure connection on a given socket rather than\ncreating a new socket. If this option is specified, host and port\nare ignored.
    \n
    • \n
  • path: Creates unix socket connection to path. If this option is\nspecified, host and port are ignored.
    \n
    • \n
  • pfx: A string or Buffer containing the private key, certificate and\nCA certs of the client in PFX or PKCS12 format.
    \n
    • \n
  • key: A string or Buffer containing the private key of the client in\nPEM format. (Could be an array of keys).
    \n
    • \n
  • passphrase: A string of passphrase for the private key or pfx.
    \n
    • \n
  • cert: A string or Buffer containing the certificate key of the client in\nPEM format. (Could be an array of certs).
    \n
    • \n
  • ca: A string, Buffer or array of strings or Buffers of trusted\ncertificates in PEM format. If this is omitted several well known "root"\nCAs will be used, like VeriSign. These are used to authorize connections.
    \n
    • \n
  • ciphers: A string describing the ciphers to use or exclude, separated by\n:. Uses the same default cipher suite as tls.createServer().
    \n
    • \n
  • rejectUnauthorized: If true, the server certificate is verified against\nthe list of supplied CAs. An 'error' event is emitted if verification\nfails; err.code contains the OpenSSL error code. Default: true.
    \n
    • \n
  • NPNProtocols: An array of strings or Buffers containing supported NPN\nprotocols. Buffers should have following format: 0x05hello0x05world,\nwhere first byte is next protocol name's length. (Passing array should\nusually be much simpler: ['hello', 'world'].)
    \n
    • \n
  • ALPNProtocols: An array of strings or Buffers containing\nsupported ALPN protocols. Buffers should have following format:\n0x05hello0x05world, where the first byte is the next protocol\nname's length. (Passing array should usually be much simpler:\n['hello', 'world'].)
    \n
    • \n
  • servername: Servername for SNI (Server Name Indication) TLS extension.
    \n
    • \n
  • checkServerIdentity(servername, cert): Provide an override for checking\nserver's hostname against the certificate. Should return an error if verification\nfails. Return undefined if passing.
    \n
    • \n
  • secureProtocol: The SSL method to use, e.g. SSLv3_method to force\nSSL version 3. The possible values depend on your installation of\nOpenSSL and are defined in the constant SSL_METHODS.
    \n
    • \n
  • secureContext: An optional TLS context object from\n tls.createSecureContext( ... ). Could it be used for caching client\n certificates, key, and CA certificates.
    \n
    • \n
  • session: A Buffer instance, containing TLS session.
    \n
    • \n
\n
The callback parameter will be added as a listener for the\n'secureConnect' event.
\n
tls.connect() returns a tls.TLSSocket object.
\n
Here is an example of a client of echo server as described previously:
\n
const tls = require('tls');\nconst fs = require('fs');\n\nconst options = {\n  // These are necessary only if using the client certificate authentication\n  key: fs.readFileSync('client-key.pem'),\n  cert: fs.readFileSync('client-cert.pem'),\n\n  // This is necessary only if the server uses the self-signed certificate\n  ca: [ fs.readFileSync('server-cert.pem') ]\n};\n\nvar socket = tls.connect(8000, options, () => {\n  console.log('client connected',\n              socket.authorized ? 'authorized' : 'unauthorized');\n  process.stdin.pipe(socket);\n  process.stdin.resume();\n});\nsocket.setEncoding('utf8');\nsocket.on('data', (data) => {\n  console.log(data);\n});\nsocket.on('end', () => {\n  server.close();\n});\n
\n
Or
\n
const tls = require('tls');\nconst fs = require('fs');\n\nconst options = {\n  pfx: fs.readFileSync('client.pfx')\n};\n\nvar socket = tls.connect(8000, options, () => {\n  console.log('client connected',\n              socket.authorized ? 'authorized' : 'unauthorized');\n  process.stdin.pipe(socket);\n  process.stdin.resume();\n});\nsocket.setEncoding('utf8');\nsocket.on('data', (data) => {\n  console.log(data);\n});\nsocket.on('end', () => {\n  server.close();\n});\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "port"
                },
                {
                  "name": "host",
                  "optional": true
                },
                {
                  "name": "options",
                  "optional": true
                },
                {
                  "name": "callback",
                  "optional": true
                }
              ]
            },
            {
              "params": [
                {
                  "name": "options"
                },
                {
                  "name": "callback",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "tls.connect(port[, host][, options][, callback])",
          "type": "method",
          "name": "connect",
          "meta": {
            "added": [
              "v0.11.3"
            ]
          },
          "desc": "
Creates a new client connection to the given port and host (old API) or\noptions.port and options.host. (If host is omitted, it defaults to\nlocalhost.) options should be an object which specifies:
\n
    \n
  • host: Host the client should connect to
    \n
    • \n
  • port: Port the client should connect to
    \n
    • \n
  • socket: Establish secure connection on a given socket rather than\ncreating a new socket. If this option is specified, host and port\nare ignored.
    \n
    • \n
  • path: Creates unix socket connection to path. If this option is\nspecified, host and port are ignored.
    \n
    • \n
  • pfx: A string or Buffer containing the private key, certificate and\nCA certs of the client in PFX or PKCS12 format.
    \n
    • \n
  • key: A string or Buffer containing the private key of the client in\nPEM format. (Could be an array of keys).
    \n
    • \n
  • passphrase: A string of passphrase for the private key or pfx.
    \n
    • \n
  • cert: A string or Buffer containing the certificate key of the client in\nPEM format. (Could be an array of certs).
    \n
    • \n
  • ca: A string, Buffer or array of strings or Buffers of trusted\ncertificates in PEM format. If this is omitted several well known "root"\nCAs will be used, like VeriSign. These are used to authorize connections.
    \n
    • \n
  • ciphers: A string describing the ciphers to use or exclude, separated by\n:. Uses the same default cipher suite as tls.createServer().
    \n
    • \n
  • rejectUnauthorized: If true, the server certificate is verified against\nthe list of supplied CAs. An 'error' event is emitted if verification\nfails; err.code contains the OpenSSL error code. Default: true.
    \n
    • \n
  • NPNProtocols: An array of strings or Buffers containing supported NPN\nprotocols. Buffers should have following format: 0x05hello0x05world,\nwhere first byte is next protocol name's length. (Passing array should\nusually be much simpler: ['hello', 'world'].)
    \n
    • \n
  • ALPNProtocols: An array of strings or Buffers containing\nsupported ALPN protocols. Buffers should have following format:\n0x05hello0x05world, where the first byte is the next protocol\nname's length. (Passing array should usually be much simpler:\n['hello', 'world'].)
    \n
    • \n
  • servername: Servername for SNI (Server Name Indication) TLS extension.
    \n
    • \n
  • checkServerIdentity(servername, cert): Provide an override for checking\nserver's hostname against the certificate. Should return an error if verification\nfails. Return undefined if passing.
    \n
    • \n
  • secureProtocol: The SSL method to use, e.g. SSLv3_method to force\nSSL version 3. The possible values depend on your installation of\nOpenSSL and are defined in the constant SSL_METHODS.
    \n
    • \n
  • secureContext: An optional TLS context object from\n tls.createSecureContext( ... ). Could it be used for caching client\n certificates, key, and CA certificates.
    \n
    • \n
  • session: A Buffer instance, containing TLS session.
    \n
    • \n
\n
The callback parameter will be added as a listener for the\n'secureConnect' event.
\n
tls.connect() returns a tls.TLSSocket object.
\n
Here is an example of a client of echo server as described previously:
\n
const tls = require('tls');\nconst fs = require('fs');\n\nconst options = {\n  // These are necessary only if using the client certificate authentication\n  key: fs.readFileSync('client-key.pem'),\n  cert: fs.readFileSync('client-cert.pem'),\n\n  // This is necessary only if the server uses the self-signed certificate\n  ca: [ fs.readFileSync('server-cert.pem') ]\n};\n\nvar socket = tls.connect(8000, options, () => {\n  console.log('client connected',\n              socket.authorized ? 'authorized' : 'unauthorized');\n  process.stdin.pipe(socket);\n  process.stdin.resume();\n});\nsocket.setEncoding('utf8');\nsocket.on('data', (data) => {\n  console.log(data);\n});\nsocket.on('end', () => {\n  server.close();\n});\n
\n
Or
\n
const tls = require('tls');\nconst fs = require('fs');\n\nconst options = {\n  pfx: fs.readFileSync('client.pfx')\n};\n\nvar socket = tls.connect(8000, options, () => {\n  console.log('client connected',\n              socket.authorized ? 'authorized' : 'unauthorized');\n  process.stdin.pipe(socket);\n  process.stdin.resume();\n});\nsocket.setEncoding('utf8');\nsocket.on('data', (data) => {\n  console.log(data);\n});\nsocket.on('end', () => {\n  server.close();\n});\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "port"
                },
                {
                  "name": "host",
                  "optional": true
                },
                {
                  "name": "options",
                  "optional": true
                },
                {
                  "name": "callback",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "tls.createSecureContext(details)",
          "type": "method",
          "name": "createSecureContext",
          "meta": {
            "added": [
              "v0.11.13"
            ]
          },
          "desc": "
Creates a credentials object, with the optional details being a\ndictionary with keys:
\n
    \n
  • pfx : A string or buffer holding the PFX or PKCS12 encoded private\nkey, certificate and CA certificates
    • \n
  • key: A string or Buffer containing the private key of the server in\nPEM format. To support multiple keys using different algorithms, an array\ncan be provided. It can either be a plain array of keys, or an array of\nobjects in the format {pem: key, passphrase: passphrase}. (Required)
    • \n
  • passphrase : A string of passphrase for the private key or pfx
    • \n
  • cert : A string holding the PEM encoded certificate
    • \n
  • ca: A string, Buffer or array of strings or Buffers of trusted\ncertificates in PEM format. If this is omitted several well known "root"\nCAs will be used, like VeriSign. These are used to authorize connections.
    • \n
  • crl : Either a string or list of strings of PEM encoded CRLs\n(Certificate Revocation List)
    • \n
  • ciphers: A string describing the ciphers to use or exclude.\nConsult\nhttps://www.openssl.org/docs/apps/ciphers.html#CIPHER-LIST-FORMAT\nfor details on the format.
    • \n
  • honorCipherOrder : When choosing a cipher, use the server's preferences\ninstead of the client preferences. For further details see tls module\ndocumentation.
    • \n
\n
If no 'ca' details are given, then Node.js will use the default\npublicly trusted list of CAs as given in\nhttp://mxr.mozilla.org/mozilla/source/security/nss/lib/ckfw/builtins/certdata.txt.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "details"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "tls.createSecurePair([context][, isServer][, requestCert][, rejectUnauthorized][, options])",
          "type": "method",
          "name": "createSecurePair",
          "desc": "
Creates a new secure pair object with two streams, one of which reads/writes\nencrypted data, and one reads/writes cleartext data.\nGenerally the encrypted one is piped to/from an incoming encrypted data stream,\nand the cleartext one is used as a replacement for the initial encrypted stream.
\n
    \n
  • credentials: A secure context object from tls.createSecureContext( ... )
    \n
    • \n
  • isServer: A boolean indicating whether this tls connection should be\nopened as a server or a client.
    \n
    • \n
  • requestCert: A boolean indicating whether a server should request a\ncertificate from a connecting client. Only applies to server connections.
    \n
    • \n
  • rejectUnauthorized: A boolean indicating whether a server should\nautomatically reject clients with invalid certificates. Only applies to\nservers with requestCert enabled.
    \n
    • \n
  • options: An object with common SSL options. See tls.TLSSocket.
    \n
    • \n
\n
tls.createSecurePair() returns a SecurePair object with cleartext and\nencrypted stream properties.
\n
NOTE: cleartext has the same APIs as tls.TLSSocket
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "context",
                  "optional": true
                },
                {
                  "name": "isServer",
                  "optional": true
                },
                {
                  "name": "requestCert",
                  "optional": true
                },
                {
                  "name": "rejectUnauthorized",
                  "optional": true
                },
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "tls.createServer(options[, secureConnectionListener])",
          "type": "method",
          "name": "createServer",
          "meta": {
            "added": [
              "v0.3.2"
            ]
          },
          "desc": "
Creates a new tls.Server.  The connectionListener argument is\nautomatically set as a listener for the 'secureConnection' event.  The\noptions object has these possibilities:
\n
    \n
  • pfx: A string or Buffer containing the private key, certificate and\nCA certs of the server in PFX or PKCS12 format. (Mutually exclusive with\nthe key, cert and ca options.)
    \n
    • \n
  • key: A string or Buffer containing the private key of the server in\nPEM format. To support multiple keys using different algorithms, an array\ncan be provided. It can either be a plain array of keys, or an array of\nobjects in the format {pem: key, passphrase: passphrase}. (Required)
    \n
    • \n
  • passphrase: A string of passphrase for the private key or pfx.
    \n
    • \n
  • cert: A string or Buffer containing the certificate key of the server in\nPEM format. (Could be an array of certs). (Required)
    \n
    • \n
  • ca: A string, Buffer or array of strings or Buffers of trusted\ncertificates in PEM format. If this is omitted several well known "root"\nCAs will be used, like VeriSign. These are used to authorize connections.
    \n
    • \n
  • crl : Either a string or list of strings of PEM encoded CRLs (Certificate\nRevocation List)
    \n
    • \n
  • ciphers: A string describing the ciphers to use or exclude, separated by\n:. The default cipher suite is:
    \n
    ECDHE-RSA-AES128-GCM-SHA256:\nECDHE-ECDSA-AES128-GCM-SHA256:\nECDHE-RSA-AES256-GCM-SHA384:\nECDHE-ECDSA-AES256-GCM-SHA384:\nDHE-RSA-AES128-GCM-SHA256:\nECDHE-RSA-AES128-SHA256:\nDHE-RSA-AES128-SHA256:\nECDHE-RSA-AES256-SHA384:\nDHE-RSA-AES256-SHA384:\nECDHE-RSA-AES256-SHA256:\nDHE-RSA-AES256-SHA256:\nHIGH:\n!aNULL:\n!eNULL:\n!EXPORT:\n!DES:\n!RC4:\n!MD5:\n!PSK:\n!SRP:\n!CAMELLIA\n
    \n
    The default cipher suite prefers GCM ciphers for Chrome's 'modern\ncryptography' setting and also prefers ECDHE and DHE ciphers for Perfect\nForward secrecy, while offering some backward compatibiltity.
    \n
    128 bit AES is preferred over 192 and 256 bit AES in light of specific\nattacks affecting larger AES key sizes.
    \n
    Old clients that rely on insecure and deprecated RC4 or DES-based ciphers\n(like Internet Explorer 6) aren't able to complete the handshake with the default\nconfiguration. If you absolutely must support these clients, the\nTLS recommendations may offer a compatible cipher suite. For more details\non the format, see the OpenSSL cipher list format documentation.
    \n
    • \n
  • ecdhCurve: A string describing a named curve to use for ECDH key agreement\nor false to disable ECDH.
    \n
    Defaults to prime256v1 (NIST P-256). Use crypto.getCurves() to obtain\na list of available curve names. On recent releases,\nopenssl ecparam -list_curves will also display the name and description of\neach available elliptic curve.
    \n
    • \n
  • dhparam: A string or Buffer containing Diffie Hellman parameters,\nrequired for Perfect Forward Secrecy. Use openssl dhparam to create it.\nIts key length should be greater than or equal to 1024 bits, otherwise\nit throws an error. It is strongly recommended to use 2048 bits or\nmore for stronger security. If omitted or invalid, it is silently\ndiscarded and DHE ciphers won't be available.
    \n
    • \n
  • handshakeTimeout: Abort the connection if the SSL/TLS handshake does not\nfinish in this many milliseconds. The default is 120 seconds.
    \n
    A 'clientError' is emitted on the tls.Server object whenever a handshake\ntimes out.
    \n
    • \n
  • honorCipherOrder : When choosing a cipher, use the server's preferences\ninstead of the client preferences. Default: true.
    \n
    • \n
  • requestCert: If true the server will request a certificate from\nclients that connect and attempt to verify that certificate. Default:\nfalse.
    \n
    • \n
  • rejectUnauthorized: If true the server will reject any connection\nwhich is not authorized with the list of supplied CAs. This option only\nhas an effect if requestCert is true. Default: false.
    \n
    • \n
  • NPNProtocols: An array or Buffer of possible NPN protocols. (Protocols\nshould be ordered by their priority).
    \n
    • \n
  • ALPNProtocols: An array or Buffer of possible ALPN\nprotocols. (Protocols should be ordered by their priority). When\nthe server receives both NPN and ALPN extensions from the client,\nALPN takes precedence over NPN and the server does not send an NPN\nextension to the client.
    \n
    • \n
  • SNICallback(servername, cb): A function that will be called if client\nsupports SNI TLS extension. Two argument will be passed to it: servername,\nand cb. SNICallback should invoke cb(null, ctx), where ctx is a\nSecureContext instance.\n(You can use tls.createSecureContext(...) to get proper\nSecureContext). If SNICallback wasn't provided the default callback with\nhigh-level API will be used (see below).
    \n
    • \n
  • sessionTimeout: An integer specifying the seconds after which TLS\nsession identifiers and TLS session tickets created by the server are\ntimed out. See SSL_CTX_set_timeout for more details.
    \n
    • \n
  • ticketKeys: A 48-byte Buffer instance consisting of 16-byte prefix,\n16-byte hmac key, 16-byte AES key. You could use it to accept tls session\ntickets on multiple instances of tls server.
    \n
    NOTE: Automatically shared between cluster module workers.
    \n
    • \n
  • sessionIdContext: A string containing an opaque identifier for session\nresumption. If requestCert is true, the default is MD5 hash value\ngenerated from command-line. (In FIPS mode a truncated SHA1 hash is\nused instead.) Otherwise, the default is not provided.
    \n
    • \n
  • secureProtocol: The SSL method to use, e.g. SSLv3_method to force\nSSL version 3. The possible values depend on your installation of\nOpenSSL and are defined in the constant SSL_METHODS.
    \n
    • \n
\n
Here is a simple example echo server:
\n
const tls = require('tls');\nconst fs = require('fs');\n\nconst options = {\n  key: fs.readFileSync('server-key.pem'),\n  cert: fs.readFileSync('server-cert.pem'),\n\n  // This is necessary only if using the client certificate authentication.\n  requestCert: true,\n\n  // This is necessary only if the client uses the self-signed certificate.\n  ca: [ fs.readFileSync('client-cert.pem') ]\n};\n\nvar server = tls.createServer(options, (socket) => {\n  console.log('server connected',\n              socket.authorized ? 'authorized' : 'unauthorized');\n  socket.write('welcome!\\n');\n  socket.setEncoding('utf8');\n  socket.pipe(socket);\n});\nserver.listen(8000, () => {\n  console.log('server bound');\n});\n
\n
Or
\n
const tls = require('tls');\nconst fs = require('fs');\n\nconst options = {\n  pfx: fs.readFileSync('server.pfx'),\n\n  // This is necessary only if using the client certificate authentication.\n  requestCert: true,\n\n};\n\nvar server = tls.createServer(options, (socket) => {\n  console.log('server connected',\n              socket.authorized ? 'authorized' : 'unauthorized');\n  socket.write('welcome!\\n');\n  socket.setEncoding('utf8');\n  socket.pipe(socket);\n});\nserver.listen(8000, () => {\n  console.log('server bound');\n});\n
\n
You can test this server by connecting to it with openssl s_client:
\n
openssl s_client -connect 127.0.0.1:8000\n
",
          "signatures": [
            {
              "params": [
                {
                  "name": "options"
                },
                {
                  "name": "secureConnectionListener",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "tls.getCiphers()",
          "type": "method",
          "name": "getCiphers",
          "meta": {
            "added": [
              "v0.10.2"
            ]
          },
          "desc": "
Returns an array with the names of the supported SSL ciphers.
\n
Example:
\n
var ciphers = tls.getCiphers();\nconsole.log(ciphers); // ['AES128-SHA', 'AES256-SHA', ...]\n
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "TLS (SSL)"
    }
  ]
}
node-v4.8.2/doc/api/tls.md000644 000766 000024 00000105672 13070706735 015435 0ustar00iojsstaff000000 000000 # TLS (SSL)

> Stability: 2 - Stable

Use `require('tls')` to access this module.

The `tls` module uses OpenSSL to provide Transport Layer Security and/or
Secure Socket Layer: encrypted stream communication.

TLS/SSL is a public/private key infrastructure. Each client and each
server must have a private key. A private key is created like this:

```
openssl genrsa -out ryans-key.pem 2048
```

All servers and some clients need to have a certificate. Certificates are public
keys signed by a Certificate Authority or self-signed. The first step to
getting a certificate is to create a "Certificate Signing Request" (CSR)
file. This is done with:

```
openssl req -new -sha256 -key ryans-key.pem -out ryans-csr.pem
```

To create a self-signed certificate with the CSR, do this:

```
openssl x509 -req -in ryans-csr.pem -signkey ryans-key.pem -out ryans-cert.pem
```

Alternatively you can send the CSR to a Certificate Authority for signing.

For Perfect Forward Secrecy, it is required to generate Diffie-Hellman
parameters:

```
openssl dhparam -outform PEM -out dhparam.pem 2048
```

To create .pfx or .p12, do this:

```
openssl pkcs12 -export -in agent5-cert.pem -inkey agent5-key.pem \
      -certfile ca-cert.pem -out agent5.pfx
```

  - `in`:  certificate
  - `inkey`: private key
  - `certfile`: all CA certs concatenated in one file like
    `cat ca1-cert.pem ca2-cert.pem > ca-cert.pem`


## Client-initiated renegotiation attack mitigation



The TLS protocol lets the client renegotiate certain aspects of the TLS session.
Unfortunately, session renegotiation requires a disproportional amount of
server-side resources, which makes it a potential vector for denial-of-service
attacks.

To mitigate this, renegotiations are limited to three times every 10 minutes. An
error is emitted on the [`tls.TLSSocket`][] instance when the threshold is
exceeded. The limits are configurable:

  - `tls.CLIENT_RENEG_LIMIT`: renegotiation limit, default is 3.

  - `tls.CLIENT_RENEG_WINDOW`: renegotiation window in seconds, default is
    10 minutes.

Don't change the defaults unless you know what you are doing.

To test your server, connect to it with `openssl s_client -connect address:port`
and tap `R` (that's the letter `R` followed by a carriage return) a few
times.


## Modifying the Default TLS Cipher suite

Node.js is built with a default suite of enabled and disabled TLS ciphers.
Currently, the default cipher suite is:

```
ECDHE-RSA-AES128-GCM-SHA256:
ECDHE-ECDSA-AES128-GCM-SHA256:
ECDHE-RSA-AES256-GCM-SHA384:
ECDHE-ECDSA-AES256-GCM-SHA384:
DHE-RSA-AES128-GCM-SHA256:
ECDHE-RSA-AES128-SHA256:
DHE-RSA-AES128-SHA256:
ECDHE-RSA-AES256-SHA384:
DHE-RSA-AES256-SHA384:
ECDHE-RSA-AES256-SHA256:
DHE-RSA-AES256-SHA256:
HIGH:
!aNULL:
!eNULL:
!EXPORT:
!DES:
!RC4:
!MD5:
!PSK:
!SRP:
!CAMELLIA
```

This default can be overriden entirely using the `--tls-cipher-list` command
line switch. For instance, the following makes
`ECDHE-RSA-AES128-GCM-SHA256:!RC4` the default TLS cipher suite:

```
node --tls-cipher-list="ECDHE-RSA-AES128-GCM-SHA256:!RC4"
```

Note that the default cipher suite included within Node.js has been carefully
selected to reflect current security best practices and risk mitigation.
Changing the default cipher suite can have a significant impact on the security
of an application. The `--tls-cipher-list` switch should by used only if
absolutely necessary.


## ALPN, NPN and SNI



ALPN (Application-Layer Protocol Negotiation Extension), NPN (Next
Protocol Negotiation) and SNI (Server Name Indication) are TLS
handshake extensions allowing you:

  * ALPN/NPN - to use one TLS server for multiple protocols (HTTP, SPDY, HTTP/2)
  * SNI - to use one TLS server for multiple hostnames with different SSL
    certificates.


## Perfect Forward Secrecy



The term "[Forward Secrecy]" or "Perfect Forward Secrecy" describes a feature of
key-agreement (i.e. key-exchange) methods. Practically it means that even if the
private key of a (your) server is compromised, communication can only be
decrypted by eavesdroppers if they manage to obtain the key-pair specifically
generated for each session.

This is achieved by randomly generating a key pair for key-agreement on every
handshake (in contrary to the same key for all sessions). Methods implementing
this technique, thus offering Perfect Forward Secrecy, are called "ephemeral".

Currently two methods are commonly used to achieve Perfect Forward Secrecy (note
the character "E" appended to the traditional abbreviations):

  * [DHE] - An ephemeral version of the Diffie Hellman key-agreement protocol.
  * [ECDHE] - An ephemeral version of the Elliptic Curve Diffie Hellman
    key-agreement protocol.

Ephemeral methods may have some performance drawbacks, because key generation
is expensive.


## Class: CryptoStream

> Stability: 0 - Deprecated: Use [`tls.TLSSocket`][] instead.

This is an encrypted stream.

### cryptoStream.bytesWritten

A proxy to the underlying socket's bytesWritten accessor, this will return
the total bytes written to the socket, *including the TLS overhead*.


## Class: SecurePair

Returned by tls.createSecurePair.

### Event: 'secure'

The event is emitted from the SecurePair once the pair has successfully
established a secure connection.

Similarly to the checking for the server `'secureConnection'` event,
pair.cleartext.authorized should be checked to confirm whether the certificate
used properly authorized.


## Class: tls.Server


This class is a subclass of `net.Server` and has the same methods on it.
Instead of accepting just raw TCP connections, this accepts encrypted
connections using TLS or SSL.

### Event: 'clientError'


`function (exception, tlsSocket) { }`

When a client connection emits an `'error'` event before a secure connection is
established it will be forwarded here.

`tlsSocket` is the [`tls.TLSSocket`][] that the error originated from.

### Event: 'newSession'


`function (sessionId, sessionData, callback) { }`

Emitted on creation of TLS session. May be used to store sessions in external
storage. `callback` must be invoked eventually, otherwise no data will be
sent or received from secure connection.

NOTE: adding this event listener will have an effect only on connections
established after addition of event listener.

### Event: 'OCSPRequest'


`function (certificate, issuer, callback) { }`

Emitted when the client sends a certificate status request. You could parse
server's current certificate to obtain OCSP url and certificate id, and after
obtaining OCSP response invoke `callback(null, resp)`, where `resp` is a
`Buffer` instance. Both `certificate` and `issuer` are a `Buffer`
DER-representations of the primary and issuer's certificates. They could be used
to obtain OCSP certificate id and OCSP endpoint url.

Alternatively, `callback(null, null)` could be called, meaning that there is no
OCSP response.

Calling `callback(err)` will result in a `socket.destroy(err)` call.

Typical flow:

1. Client connects to server and sends `'OCSPRequest'` to it (via status info
   extension in ClientHello.)
2. Server receives request and invokes `'OCSPRequest'` event listener if present
3. Server grabs OCSP url from either `certificate` or `issuer` and performs an
   [OCSP request] to the CA
4. Server receives `OCSPResponse` from CA and sends it back to client via
   `callback` argument
5. Client validates the response and either destroys socket or performs a
   handshake.

NOTE: `issuer` could be null, if the certificate is self-signed or if the issuer
is not in the root certificates list. (You could provide an issuer via `ca`
option.)

NOTE: adding this event listener will have an effect only on connections
established after addition of event listener.

NOTE: you may want to use some npm module like [asn1.js] to parse the
certificates.

### Event: 'resumeSession'


`function (sessionId, callback) { }`

Emitted when client wants to resume previous TLS session. Event listener may
perform lookup in external storage using given `sessionId`, and invoke
`callback(null, sessionData)` once finished. If session can't be resumed
(i.e. doesn't exist in storage) one may call `callback(null, null)`. Calling
`callback(err)` will terminate incoming connection and destroy socket.

NOTE: adding this event listener will have an effect only on connections
established after addition of event listener.

Here's an example for using TLS session resumption:

```js
var tlsSessionStore = {};
server.on('newSession', (id, data, cb) => {
  tlsSessionStore[id.toString('hex')] = data;
  cb();
});
server.on('resumeSession', (id, cb) => {
  cb(null, tlsSessionStore[id.toString('hex')] || null);
});
```

### Event: 'secureConnection'


`function (tlsSocket) {}`

This event is emitted after a new connection has been successfully
handshaked. The argument is an instance of [`tls.TLSSocket`][]. It has all the
common stream methods and events.

`socket.authorized` is a boolean value which indicates if the
client has verified by one of the supplied certificate authorities for the
server. If `socket.authorized` is false, then
`socket.authorizationError` is set to describe how authorization
failed. Implied but worth mentioning: depending on the settings of the TLS
server, you unauthorized connections may be accepted.

`socket.npnProtocol` is a string containing the selected NPN protocol
and `socket.alpnProtocol` is a string containing the selected ALPN
protocol, When both NPN and ALPN extensions are received, ALPN takes
precedence over NPN and the next protocol is selected by ALPN. When
ALPN has no selected protocol, this returns false.

`socket.servername` is a string containing servername requested with
SNI.

### server.addContext(hostname, context)


Add secure context that will be used if client request's SNI hostname is
matching passed `hostname` (wildcards can be used). `context` can contain
`key`, `cert`, `ca` and/or any other properties from
[`tls.createSecureContext()`][] `options` argument.

### server.address()


Returns the bound address, the address family name and port of the
server as reported by the operating system.  See [`net.Server.address()`][] for
more information.

### server.close([callback])


Stops the server from accepting new connections. This function is
asynchronous, the server is finally closed when the server emits a `'close'`
event.  Optionally, you can pass a callback to listen for the `'close'` event.

### server.connections


The number of concurrent connections on the server.

### server.getTicketKeys()


Returns `Buffer` instance holding the keys currently used for
encryption/decryption of the [TLS Session Tickets][]

### server.listen(port[, hostname][, callback])


Begin accepting connections on the specified `port` and `hostname`. If the
`hostname` is omitted, the server will accept connections on any IPv6 address
(`::`) when IPv6 is available, or any IPv4 address (`0.0.0.0`) otherwise. A
port value of zero will assign a random port.

This function is asynchronous. The last parameter `callback` will be called
when the server has been bound.

See [`net.Server`][] for more information.

### server.maxConnections


Set this property to reject connections when the server's connection count
gets high.

### server.setTicketKeys(keys)


Updates the keys for encryption/decryption of the [TLS Session Tickets][].

NOTE: the buffer should be 48 bytes long. See server `ticketKeys` option for
more information oh how it is going to be used.

NOTE: the change is effective only for the future server connections. Existing
or currently pending server connections will use previous keys.


## Class: tls.TLSSocket


This is a wrapped version of [`net.Socket`][] that does transparent encryption
of written data and all required TLS negotiation.

This instance implements a duplex [Stream][] interfaces.  It has all the
common stream methods and events.

Methods that return TLS connection meta data (e.g.
[`tls.TLSSocket.getPeerCertificate()`][] will only return data while the
connection is open.

## new tls.TLSSocket(socket[, options])


Construct a new TLSSocket object from existing TCP socket.

`socket` is an instance of [`net.Socket`][]

`options` is an optional object that might contain following properties:

  - `secureContext`: An optional TLS context object from
     [`tls.createSecureContext()`][]

  - `isServer`: If `true` the TLS socket will be instantiated in server-mode.
    Default: `false`

  - `server`: An optional [`net.Server`][] instance

  - `requestCert`: Optional, see [`tls.createSecurePair()`][]

  - `rejectUnauthorized`: Optional, see [`tls.createSecurePair()`][]

  - `NPNProtocols`: Optional, see [`tls.createServer()`][]

  - `ALPNProtocols`: Optional, see [tls.createServer][]

  - `SNICallback`: Optional, see [`tls.createServer()`][]

  - `session`: Optional, a `Buffer` instance, containing TLS session

  - `requestOCSP`: Optional, if `true` the OCSP status request extension will
    be added to the client hello, and an `'OCSPResponse'` event will be emitted
    on the socket before establishing a secure communication

### Event: 'OCSPResponse'


`function (response) { }`

This event will be emitted if `requestOCSP` option was set. `response` is a
buffer object, containing server's OCSP response.

Traditionally, the `response` is a signed object from the server's CA that
contains information about server's certificate revocation status.

### Event: 'secureConnect'


This event is emitted after a new connection has been successfully handshaked.
The listener will be called no matter if the server's certificate was
authorized or not. It is up to the user to test `tlsSocket.authorized`
to see if the server certificate was signed by one of the specified CAs.
If `tlsSocket.authorized === false` then the error can be found in
`tlsSocket.authorizationError`. Also if ALPN or NPN was used - you can
check `tlsSocket.alpnProtocol` or `tlsSocket.npnProtocol` for the
negotiated protocol.

### tlsSocket.address()


Returns the bound address, the address family name and port of the
underlying socket as reported by the operating system. Returns an
object with three properties, e.g.
`{ port: 12346, family: 'IPv4', address: '127.0.0.1' }`

### tlsSocket.authorized


A boolean that is `true` if the peer certificate was signed by one of the
specified CAs, otherwise `false`

### tlsSocket.authorizationError


The reason why the peer's certificate has not been verified. This property
becomes available only when `tlsSocket.authorized === false`.

### tlsSocket.encrypted


Static boolean value, always `true`. May be used to distinguish TLS sockets
from regular ones.

### tlsSocket.getCipher()


Returns an object representing the cipher name and the SSL/TLS
protocol version of the current connection.

Example:
{ name: 'AES256-SHA', version: 'TLSv1/SSLv3' }

See SSL_CIPHER_get_name() and SSL_CIPHER_get_version() in
https://www.openssl.org/docs/ssl/ssl.html#DEALING-WITH-CIPHERS for more
information.

### tlsSocket.getPeerCertificate([ detailed ])


Returns an object representing the peer's certificate. The returned object has
some properties corresponding to the field of the certificate. If `detailed`
argument is `true` the full chain with `issuer` property will be returned,
if `false` only the top certificate without `issuer` property.

Example:

```
{ subject:
   { C: 'UK',
     ST: 'Acknack Ltd',
     L: 'Rhys Jones',
     O: 'node.js',
     OU: 'Test TLS Certificate',
     CN: 'localhost' },
  issuerInfo:
   { C: 'UK',
     ST: 'Acknack Ltd',
     L: 'Rhys Jones',
     O: 'node.js',
     OU: 'Test TLS Certificate',
     CN: 'localhost' },
  issuer:
   { ... another certificate ... },
  raw: < RAW DER buffer >,
  valid_from: 'Nov 11 09:52:22 2009 GMT',
  valid_to: 'Nov  6 09:52:22 2029 GMT',
  fingerprint: '2A:7A:C2:DD:E5:F9:CC:53:72:35:99:7A:02:5A:71:38:52:EC:8A:DF',
  serialNumber: 'B9B0D332A1AA5635' }
```

If the peer does not provide a certificate, it returns `null` or an empty
object.

### tlsSocket.getSession()


Return ASN.1 encoded TLS session or `undefined` if none was negotiated. Could
be used to speed up handshake establishment when reconnecting to the server.

### tlsSocket.getTLSTicket()


NOTE: Works only with client TLS sockets. Useful only for debugging, for
session reuse provide `session` option to [`tls.connect()`][].

Return TLS session ticket or `undefined` if none was negotiated.

### tlsSocket.localPort


The numeric representation of the local port.

### tlsSocket.localAddress


The string representation of the local IP address.

### tlsSocket.remoteAddress


The string representation of the remote IP address. For example,
`'74.125.127.100'` or `'2001:4860:a005::68'`.

### tlsSocket.remoteFamily


The string representation of the remote IP family. `'IPv4'` or `'IPv6'`.

### tlsSocket.remotePort


The numeric representation of the remote port. For example, `443`.

### tlsSocket.renegotiate(options, callback)


Initiate TLS renegotiation process. The `options` may contain the following
fields: `rejectUnauthorized`, `requestCert` (See [`tls.createServer()`][] for
details). `callback(err)` will be executed with `null` as `err`,
once the renegotiation is successfully completed.

NOTE: Can be used to request peer's certificate after the secure connection
has been established.

ANOTHER NOTE: When running as the server, socket will be destroyed
with an error after `handshakeTimeout` timeout.

### tlsSocket.setMaxSendFragment(size)


Set maximum TLS fragment size (default and maximum value is: `16384`, minimum
is: `512`). Returns `true` on success, `false` otherwise.

Smaller fragment size decreases buffering latency on the client: large
fragments are buffered by the TLS layer until the entire fragment is received
and its integrity is verified; large fragments can span multiple roundtrips,
and their processing can be delayed due to packet loss or reordering. However,
smaller fragments add extra TLS framing bytes and CPU overhead, which may
decrease overall server throughput.

## tls.connect(options[, callback])
## tls.connect(port[, host][, options][, callback])


Creates a new client connection to the given `port` and `host` (old API) or
`options.port` and `options.host`. (If `host` is omitted, it defaults to
`localhost`.) `options` should be an object which specifies:

  - `host`: Host the client should connect to

  - `port`: Port the client should connect to

  - `socket`: Establish secure connection on a given socket rather than
    creating a new socket. If this option is specified, `host` and `port`
    are ignored.

  - `path`: Creates unix socket connection to path. If this option is
    specified, `host` and `port` are ignored.

  - `pfx`: A string or `Buffer` containing the private key, certificate and
    CA certs of the client in PFX or PKCS12 format.

  - `key`: A string or `Buffer` containing the private key of the client in
    PEM format. (Could be an array of keys).

  - `passphrase`: A string of passphrase for the private key or pfx.

  - `cert`: A string or `Buffer` containing the certificate key of the client in
    PEM format. (Could be an array of certs).

  - `ca`: A string, `Buffer` or array of strings or `Buffer`s of trusted
    certificates in PEM format. If this is omitted several well known "root"
    CAs will be used, like VeriSign. These are used to authorize connections.

  - `ciphers`: A string describing the ciphers to use or exclude, separated by
   `:`. Uses the same default cipher suite as [`tls.createServer()`][].

  - `rejectUnauthorized`: If `true`, the server certificate is verified against
    the list of supplied CAs. An `'error'` event is emitted if verification
    fails; `err.code` contains the OpenSSL error code. Default: `true`.

  - `NPNProtocols`: An array of strings or `Buffer`s containing supported NPN
    protocols. `Buffer`s should have following format: `0x05hello0x05world`,
    where first byte is next protocol name's length. (Passing array should
    usually be much simpler: `['hello', 'world']`.)

  - `ALPNProtocols`: An array of strings or `Buffer`s containing
    supported ALPN protocols. `Buffer`s should have following format:
    `0x05hello0x05world`, where the first byte is the next protocol
    name's length. (Passing array should usually be much simpler:
    `['hello', 'world']`.)

  - `servername`: Servername for SNI (Server Name Indication) TLS extension.

  - `checkServerIdentity(servername, cert)`: Provide an override for checking
    server's hostname against the certificate. Should return an error if verification
    fails. Return `undefined` if passing.

  - `secureProtocol`: The SSL method to use, e.g. `SSLv3_method` to force
    SSL version 3. The possible values depend on your installation of
    OpenSSL and are defined in the constant [SSL_METHODS][].

  - `secureContext`: An optional TLS context object from
     `tls.createSecureContext( ... )`. Could it be used for caching client
     certificates, key, and CA certificates.

  - `session`: A `Buffer` instance, containing TLS session.

The `callback` parameter will be added as a listener for the
[`'secureConnect'`][] event.

`tls.connect()` returns a [`tls.TLSSocket`][] object.

Here is an example of a client of echo server as described previously:

```js
const tls = require('tls');
const fs = require('fs');

const options = {
  // These are necessary only if using the client certificate authentication
  key: fs.readFileSync('client-key.pem'),
  cert: fs.readFileSync('client-cert.pem'),

  // This is necessary only if the server uses the self-signed certificate
  ca: [ fs.readFileSync('server-cert.pem') ]
};

var socket = tls.connect(8000, options, () => {
  console.log('client connected',
              socket.authorized ? 'authorized' : 'unauthorized');
  process.stdin.pipe(socket);
  process.stdin.resume();
});
socket.setEncoding('utf8');
socket.on('data', (data) => {
  console.log(data);
});
socket.on('end', () => {
  server.close();
});
```

Or

```js
const tls = require('tls');
const fs = require('fs');

const options = {
  pfx: fs.readFileSync('client.pfx')
};

var socket = tls.connect(8000, options, () => {
  console.log('client connected',
              socket.authorized ? 'authorized' : 'unauthorized');
  process.stdin.pipe(socket);
  process.stdin.resume();
});
socket.setEncoding('utf8');
socket.on('data', (data) => {
  console.log(data);
});
socket.on('end', () => {
  server.close();
});
```

## tls.createSecureContext(details)


Creates a credentials object, with the optional details being a
dictionary with keys:

* `pfx` : A string or buffer holding the PFX or PKCS12 encoded private
  key, certificate and CA certificates
* `key`: A string or `Buffer` containing the private key of the server in
  PEM format. To support multiple keys using different algorithms, an array
  can be provided. It can either be a plain array of keys, or an array of
  objects in the format `{pem: key, passphrase: passphrase}`. (Required)
* `passphrase` : A string of passphrase for the private key or pfx
* `cert` : A string holding the PEM encoded certificate
* `ca`: A string, `Buffer` or array of strings or `Buffer`s of trusted
  certificates in PEM format. If this is omitted several well known "root"
  CAs will be used, like VeriSign. These are used to authorize connections.
* `crl` : Either a string or list of strings of PEM encoded CRLs
  (Certificate Revocation List)
* `ciphers`: A string describing the ciphers to use or exclude.
  Consult
  
  for details on the format.
* `honorCipherOrder` : When choosing a cipher, use the server's preferences
  instead of the client preferences. For further details see `tls` module
  documentation.

If no 'ca' details are given, then Node.js will use the default
publicly trusted list of CAs as given in
.


## tls.createSecurePair([context][, isServer][, requestCert][, rejectUnauthorized][, options])

Creates a new secure pair object with two streams, one of which reads/writes
encrypted data, and one reads/writes cleartext data.
Generally the encrypted one is piped to/from an incoming encrypted data stream,
and the cleartext one is used as a replacement for the initial encrypted stream.

 - `credentials`: A secure context object from tls.createSecureContext( ... )

 - `isServer`: A boolean indicating whether this tls connection should be
   opened as a server or a client.

 - `requestCert`: A boolean indicating whether a server should request a
   certificate from a connecting client. Only applies to server connections.

 - `rejectUnauthorized`: A boolean indicating whether a server should
   automatically reject clients with invalid certificates. Only applies to
   servers with `requestCert` enabled.

 - `options`: An object with common SSL options. See [`tls.TLSSocket`][].

`tls.createSecurePair()` returns a SecurePair object with `cleartext` and
`encrypted` stream properties.

NOTE: `cleartext` has the same APIs as [`tls.TLSSocket`][]

## tls.createServer(options[, secureConnectionListener])


Creates a new [tls.Server][].  The `connectionListener` argument is
automatically set as a listener for the [`'secureConnection'`][] event.  The
`options` object has these possibilities:

  - `pfx`: A string or `Buffer` containing the private key, certificate and
    CA certs of the server in PFX or PKCS12 format. (Mutually exclusive with
    the `key`, `cert` and `ca` options.)

  - `key`: A string or `Buffer` containing the private key of the server in
    PEM format. To support multiple keys using different algorithms, an array
    can be provided. It can either be a plain array of keys, or an array of
    objects in the format `{pem: key, passphrase: passphrase}`. (Required)

  - `passphrase`: A string of passphrase for the private key or pfx.

  - `cert`: A string or `Buffer` containing the certificate key of the server in
    PEM format. (Could be an array of certs). (Required)

  - `ca`: A string, `Buffer` or array of strings or `Buffer`s of trusted
    certificates in PEM format. If this is omitted several well known "root"
    CAs will be used, like VeriSign. These are used to authorize connections.

  - `crl` : Either a string or list of strings of PEM encoded CRLs (Certificate
    Revocation List)

  - `ciphers`: A string describing the ciphers to use or exclude, separated by
    `:`. The default cipher suite is:

    ```js
    ECDHE-RSA-AES128-GCM-SHA256:
    ECDHE-ECDSA-AES128-GCM-SHA256:
    ECDHE-RSA-AES256-GCM-SHA384:
    ECDHE-ECDSA-AES256-GCM-SHA384:
    DHE-RSA-AES128-GCM-SHA256:
    ECDHE-RSA-AES128-SHA256:
    DHE-RSA-AES128-SHA256:
    ECDHE-RSA-AES256-SHA384:
    DHE-RSA-AES256-SHA384:
    ECDHE-RSA-AES256-SHA256:
    DHE-RSA-AES256-SHA256:
    HIGH:
    !aNULL:
    !eNULL:
    !EXPORT:
    !DES:
    !RC4:
    !MD5:
    !PSK:
    !SRP:
    !CAMELLIA
    ```

    The default cipher suite prefers GCM ciphers for [Chrome's 'modern
    cryptography' setting] and also prefers ECDHE and DHE ciphers for Perfect
    Forward secrecy, while offering *some* backward compatibiltity.

    128 bit AES is preferred over 192 and 256 bit AES in light of [specific
    attacks affecting larger AES key sizes].

    Old clients that rely on insecure and deprecated RC4 or DES-based ciphers
    (like Internet Explorer 6) aren't able to complete the handshake with the default
    configuration. If you absolutely must support these clients, the
    [TLS recommendations] may offer a compatible cipher suite. For more details
    on the format, see the [OpenSSL cipher list format documentation].

  - `ecdhCurve`: A string describing a named curve to use for ECDH key agreement
    or false to disable ECDH.

    Defaults to `prime256v1` (NIST P-256). Use [`crypto.getCurves()`][] to obtain
    a list of available curve names. On recent releases,
    `openssl ecparam -list_curves` will also display the name and description of
    each available elliptic curve.

  - `dhparam`: A string or `Buffer` containing Diffie Hellman parameters,
    required for Perfect Forward Secrecy. Use `openssl dhparam` to create it.
    Its key length should be greater than or equal to 1024 bits, otherwise
    it throws an error. It is strongly recommended to use 2048 bits or
    more for stronger security. If omitted or invalid, it is silently
    discarded and DHE ciphers won't be available.

  - `handshakeTimeout`: Abort the connection if the SSL/TLS handshake does not
    finish in this many milliseconds. The default is 120 seconds.

    A `'clientError'` is emitted on the `tls.Server` object whenever a handshake
    times out.

  - `honorCipherOrder` : When choosing a cipher, use the server's preferences
    instead of the client preferences. Default: `true`.

  - `requestCert`: If `true` the server will request a certificate from
    clients that connect and attempt to verify that certificate. Default:
    `false`.

  - `rejectUnauthorized`: If `true` the server will reject any connection
    which is not authorized with the list of supplied CAs. This option only
    has an effect if `requestCert` is `true`. Default: `false`.

  - `NPNProtocols`: An array or `Buffer` of possible NPN protocols. (Protocols
    should be ordered by their priority).

  - `ALPNProtocols`: An array or `Buffer` of possible ALPN
    protocols. (Protocols should be ordered by their priority). When
    the server receives both NPN and ALPN extensions from the client,
    ALPN takes precedence over NPN and the server does not send an NPN
    extension to the client.

  - `SNICallback(servername, cb)`: A function that will be called if client
    supports SNI TLS extension. Two argument will be passed to it: `servername`,
    and `cb`. `SNICallback` should invoke `cb(null, ctx)`, where `ctx` is a
    SecureContext instance.
    (You can use `tls.createSecureContext(...)` to get proper
    SecureContext). If `SNICallback` wasn't provided the default callback with
    high-level API will be used (see below).

  - `sessionTimeout`: An integer specifying the seconds after which TLS
    session identifiers and TLS session tickets created by the server are
    timed out. See [SSL_CTX_set_timeout] for more details.

  - `ticketKeys`: A 48-byte `Buffer` instance consisting of 16-byte prefix,
    16-byte hmac key, 16-byte AES key. You could use it to accept tls session
    tickets on multiple instances of tls server.

    NOTE: Automatically shared between `cluster` module workers.

  - `sessionIdContext`: A string containing an opaque identifier for session
    resumption. If `requestCert` is `true`, the default is MD5 hash value
    generated from command-line. (In FIPS mode a truncated SHA1 hash is
    used instead.) Otherwise, the default is not provided.

  - `secureProtocol`: The SSL method to use, e.g. `SSLv3_method` to force
    SSL version 3. The possible values depend on your installation of
    OpenSSL and are defined in the constant [SSL_METHODS][].

Here is a simple example echo server:

```js
const tls = require('tls');
const fs = require('fs');

const options = {
  key: fs.readFileSync('server-key.pem'),
  cert: fs.readFileSync('server-cert.pem'),

  // This is necessary only if using the client certificate authentication.
  requestCert: true,

  // This is necessary only if the client uses the self-signed certificate.
  ca: [ fs.readFileSync('client-cert.pem') ]
};

var server = tls.createServer(options, (socket) => {
  console.log('server connected',
              socket.authorized ? 'authorized' : 'unauthorized');
  socket.write('welcome!\n');
  socket.setEncoding('utf8');
  socket.pipe(socket);
});
server.listen(8000, () => {
  console.log('server bound');
});
```

Or

```js
const tls = require('tls');
const fs = require('fs');

const options = {
  pfx: fs.readFileSync('server.pfx'),

  // This is necessary only if using the client certificate authentication.
  requestCert: true,

};

var server = tls.createServer(options, (socket) => {
  console.log('server connected',
              socket.authorized ? 'authorized' : 'unauthorized');
  socket.write('welcome!\n');
  socket.setEncoding('utf8');
  socket.pipe(socket);
});
server.listen(8000, () => {
  console.log('server bound');
});
```

You can test this server by connecting to it with `openssl s_client`:

```
openssl s_client -connect 127.0.0.1:8000
```

## tls.getCiphers()


Returns an array with the names of the supported SSL ciphers.

Example:

```js
var ciphers = tls.getCiphers();
console.log(ciphers); // ['AES128-SHA', 'AES256-SHA', ...]
```

[OpenSSL cipher list format documentation]: https://www.openssl.org/docs/apps/ciphers.html#CIPHER-LIST-FORMAT
[Chrome's 'modern cryptography' setting]: https://www.chromium.org/Home/chromium-security/education/tls#TOC-Deprecation-of-TLS-Features-Algorithms-in-Chrome
[specific attacks affecting larger AES key sizes]: https://www.schneier.com/blog/archives/2009/07/another_new_aes.html
[BEAST attacks]: https://blog.ivanristic.com/2011/10/mitigating-the-beast-attack-on-tls.html
[`crypto.getCurves()`]: crypto.html#crypto_crypto_getcurves
[`tls.createServer()`]: #tls_tls_createserver_options_secureconnectionlistener
[`tls.createSecurePair()`]: #tls_tls_createsecurepair_context_isserver_requestcert_rejectunauthorized_options
[`tls.TLSSocket`]: #tls_class_tls_tlssocket
[`net.Server`]: net.html#net_class_net_server
[`net.Socket`]: net.html#net_class_net_socket
[`net.Server.address()`]: net.html#net_server_address
[`'secureConnect'`]: #tls_event_secureconnect
[`'secureConnection'`]: #tls_event_secureconnection
[Stream]: stream.html#stream_stream
[SSL_METHODS]: https://www.openssl.org/docs/ssl/ssl.html#DEALING-WITH-PROTOCOL-METHODS
[tls.Server]: #tls_class_tls_server
[SSL_CTX_set_timeout]: https://www.openssl.org/docs/ssl/SSL_CTX_set_timeout.html
[RFC 4492]: https://www.rfc-editor.org/rfc/rfc4492.txt
[Forward secrecy]: https://en.wikipedia.org/wiki/Perfect_forward_secrecy
[DHE]: https://en.wikipedia.org/wiki/Diffie%E2%80%93Hellman_key_exchange
[ECDHE]: https://en.wikipedia.org/wiki/Elliptic_curve_Diffie%E2%80%93Hellman
[asn1.js]: https://npmjs.org/package/asn1.js
[OCSP request]: https://en.wikipedia.org/wiki/OCSP_stapling
[TLS recommendations]: https://wiki.mozilla.org/Security/Server_Side_TLS
[TLS Session Tickets]: https://www.ietf.org/rfc/rfc5077.txt
[`tls.TLSSocket.getPeerCertificate()`]: #tls_tlssocket_getpeercertificate_detailed
[`tls.createSecureContext()`]: #tls_tls_createsecurecontext_details
[`tls.connect()`]: #tls_tls_connect_options_callback
node-v4.8.2/doc/api/tty.html000644 000766 000024 00000022247 13070706740 016007 0ustar00iojsstaff000000 000000 


  
  TTY | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

      

        
TTY#


Stability: 2 - Stable
The tty module houses the tty.ReadStream and tty.WriteStream classes. In
most cases, you will not need to use this module directly.


When Node.js detects that it is being run inside a TTY context, then process.stdin
will be a tty.ReadStream instance and process.stdout will be
a tty.WriteStream instance. The preferred way to check if Node.js is being run
in a TTY context is to check process.stdout.isTTY:


$ node -p -e "Boolean(process.stdout.isTTY)"
true
$ node -p -e "Boolean(process.stdout.isTTY)" | cat
false

Class: ReadStream#



Added in: v0.5.8

A net.Socket subclass that represents the readable portion of a tty. In normal
circumstances, process.stdin will be the only tty.ReadStream instance in any
Node.js program (only when isatty(0) is true).


rs.isRaw#



Added in: v0.7.7

A Boolean that is initialized to false. It represents the current "raw" state
of the tty.ReadStream instance.


rs.setRawMode(mode)#



Added in: v0.7.7

mode should be true or false. This sets the properties of the
tty.ReadStream to act either as a raw device or default. isRaw will be set
to the resulting mode.


Class: WriteStream#



Added in: v0.5.8

A net.Socket subclass that represents the writable portion of a tty. In normal
circumstances, process.stdout will be the only tty.WriteStream instance
ever created (and only when isatty(1) is true).


Event: 'resize'#



Added in: v0.7.7

function () {}


Emitted by refreshSize() when either of the columns or rows properties
has changed.


process.stdout.on('resize', () => {
  console.log('screen size has changed!');
  console.log(`${process.stdout.columns}x${process.stdout.rows}`);
});



ws.columns#



Added in: v0.7.7

A Number that gives the number of columns the TTY currently has. This property
gets updated on 'resize' events.


ws.rows#



Added in: v0.7.7

A Number that gives the number of rows the TTY currently has. This property
gets updated on 'resize' events.


tty.isatty(fd)#



Added in: v0.5.8

Returns true or false depending on if the fd is associated with a
terminal.


tty.setRawMode(mode)#


Stability: 0 - Deprecated: Use tty.ReadStream#setRawMode (i.e. process.stdin.setRawMode) instead.

      

    

  

  
  
  
  



node-v4.8.2/doc/api/tty.json000644 000766 000024 00000013077 13070706740 016015 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/tty.md",
  "modules": [
    {
      "textRaw": "TTY",
      "name": "tty",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
The tty module houses the tty.ReadStream and tty.WriteStream classes. In\nmost cases, you will not need to use this module directly.
\n
When Node.js detects that it is being run inside a TTY context, then process.stdin\nwill be a tty.ReadStream instance and process.stdout will be\na tty.WriteStream instance. The preferred way to check if Node.js is being run\nin a TTY context is to check process.stdout.isTTY:
\n
$ node -p -e "Boolean(process.stdout.isTTY)"\ntrue\n$ node -p -e "Boolean(process.stdout.isTTY)" | cat\nfalse\n
",
      "classes": [
        {
          "textRaw": "Class: ReadStream",
          "type": "class",
          "name": "ReadStream",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
A net.Socket subclass that represents the readable portion of a tty. In normal\ncircumstances, process.stdin will be the only tty.ReadStream instance in any\nNode.js program (only when isatty(0) is true).
\n",
          "properties": [
            {
              "textRaw": "rs.isRaw",
              "name": "isRaw",
              "meta": {
                "added": [
                  "v0.7.7"
                ]
              },
              "desc": "
A Boolean that is initialized to false. It represents the current "raw" state\nof the tty.ReadStream instance.
\n"
            }
          ],
          "methods": [
            {
              "textRaw": "rs.setRawMode(mode)",
              "type": "method",
              "name": "setRawMode",
              "meta": {
                "added": [
                  "v0.7.7"
                ]
              },
              "desc": "
mode should be true or false. This sets the properties of the\ntty.ReadStream to act either as a raw device or default. isRaw will be set\nto the resulting mode.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "mode"
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "textRaw": "Class: WriteStream",
          "type": "class",
          "name": "WriteStream",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
A net.Socket subclass that represents the writable portion of a tty. In normal\ncircumstances, process.stdout will be the only tty.WriteStream instance\never created (and only when isatty(1) is true).
\n",
          "events": [
            {
              "textRaw": "Event: 'resize'",
              "type": "event",
              "name": "resize",
              "meta": {
                "added": [
                  "v0.7.7"
                ]
              },
              "desc": "
function () {}
\n
Emitted by refreshSize() when either of the columns or rows properties\nhas changed.
\n
process.stdout.on('resize', () => {\n  console.log('screen size has changed!');\n  console.log(`${process.stdout.columns}x${process.stdout.rows}`);\n});\n
\n",
              "params": []
            }
          ],
          "properties": [
            {
              "textRaw": "ws.columns",
              "name": "columns",
              "meta": {
                "added": [
                  "v0.7.7"
                ]
              },
              "desc": "
A Number that gives the number of columns the TTY currently has. This property\ngets updated on 'resize' events.
\n"
            },
            {
              "textRaw": "ws.rows",
              "name": "rows",
              "meta": {
                "added": [
                  "v0.7.7"
                ]
              },
              "desc": "
A Number that gives the number of rows the TTY currently has. This property\ngets updated on 'resize' events.
\n"
            }
          ]
        }
      ],
      "methods": [
        {
          "textRaw": "tty.isatty(fd)",
          "type": "method",
          "name": "isatty",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
Returns true or false depending on if the fd is associated with a\nterminal.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "fd"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "tty.setRawMode(mode)",
          "type": "method",
          "name": "setRawMode",
          "stability": 0,
          "stabilityText": "Deprecated: Use [tty.ReadStream#setRawMode][] (i.e. process.stdin.setRawMode) instead.",
          "signatures": [
            {
              "params": [
                {
                  "name": "mode"
                }
              ]
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "TTY"
    }
  ]
}
node-v4.8.2/doc/api/tty.md000644 000766 000024 00000004570 13070706735 015446 0ustar00iojsstaff000000 000000 # TTY

> Stability: 2 - Stable

The `tty` module houses the `tty.ReadStream` and `tty.WriteStream` classes. In
most cases, you will not need to use this module directly.

When Node.js detects that it is being run inside a TTY context, then `process.stdin`
will be a `tty.ReadStream` instance and `process.stdout` will be
a `tty.WriteStream` instance. The preferred way to check if Node.js is being run
in a TTY context is to check `process.stdout.isTTY`:

```
$ node -p -e "Boolean(process.stdout.isTTY)"
true
$ node -p -e "Boolean(process.stdout.isTTY)" | cat
false
```

## Class: ReadStream


A `net.Socket` subclass that represents the readable portion of a tty. In normal
circumstances, `process.stdin` will be the only `tty.ReadStream` instance in any
Node.js program (only when `isatty(0)` is true).

### rs.isRaw


A `Boolean` that is initialized to `false`. It represents the current "raw" state
of the `tty.ReadStream` instance.

### rs.setRawMode(mode)


`mode` should be `true` or `false`. This sets the properties of the
`tty.ReadStream` to act either as a raw device or default. `isRaw` will be set
to the resulting mode.

## Class: WriteStream


A `net.Socket` subclass that represents the writable portion of a tty. In normal
circumstances, `process.stdout` will be the only `tty.WriteStream` instance
ever created (and only when `isatty(1)` is true).

### Event: 'resize'


`function () {}`

Emitted by `refreshSize()` when either of the `columns` or `rows` properties
has changed.

```js
process.stdout.on('resize', () => {
  console.log('screen size has changed!');
  console.log(`${process.stdout.columns}x${process.stdout.rows}`);
});
```

### ws.columns


A `Number` that gives the number of columns the TTY currently has. This property
gets updated on `'resize'` events.

### ws.rows


A `Number` that gives the number of rows the TTY currently has. This property
gets updated on `'resize'` events.

## tty.isatty(fd)


Returns `true` or `false` depending on if the `fd` is associated with a
terminal.

## tty.setRawMode(mode)

> Stability: 0 - Deprecated: Use [tty.ReadStream#setRawMode][] (i.e. process.stdin.setRawMode) instead.

[tty.ReadStream#setRawMode]: #tty_rs_setrawmode_mode
node-v4.8.2/doc/api/url.html000644 000766 000024 00000026606 13070706740 015774 0ustar00iojsstaff000000 000000 


  
  URL | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

      

        
URL#


Stability: 2 - Stable
This module has utilities for URL resolution and parsing.
Call require('url') to use it.


URL Parsing#


Parsed URL objects have some or all of the following fields, depending on
whether or not they exist in the URL string. Any parts that are not in the URL
string will not be in the parsed object. Examples are shown for the URL


'http://user:pass@host.com:8080/p/a/t/h?query=string#hash'


    

  • href: The full URL that was originally parsed. Both the protocol and host are lowercased.
    

      Example: 'http://user:pass@host.com:8080/p/a/t/h?query=string#hash'
    

    • 

  • protocol: The request protocol, lowercased.
    

      Example: 'http:'
    

    • 

  • slashes: The protocol requires slashes after the colon.
    

      Example: true or false
    

    • 

  • host: The full lowercased host portion of the URL, including port
information.
    

      Example: 'host.com:8080'
    

    • 

  • auth: The authentication information portion of a URL.
    

      Example: 'user:pass'
    

    • 

  • hostname: Just the lowercased hostname portion of the host.
    

      Example: 'host.com'
    

    • 

  • port: The port number portion of the host.
    

      Example: '8080'
    

    • 

  • pathname: The path section of the URL, that comes after the host and
before the query, including the initial slash if present. No decoding is
performed.
    

      Example: '/p/a/t/h'
    

    • 

  • search: The 'query string' portion of the URL, including the leading
question mark.
    

      Example: '?query=string'
    

    • 

  • path: Concatenation of pathname and search. No decoding is performed.
    

      Example: '/p/a/t/h?query=string'
    

    • 

  • query: Either the 'params' portion of the query string, or a
querystring-parsed object.
    

      Example: 'query=string' or {'query':'string'}
    

    • 

  • hash: The 'fragment' portion of the URL including the pound-sign.
    

      Example: '#hash'
    

    • 



Escaped Characters#


Spaces (' ') and the following characters will be automatically escaped in the
properties of URL objects:


< > " ` \r \n \t { } | \ ^ '



The following methods are provided by the URL module:


url.format(urlObj)#



Added in: v0.1.25

Take a parsed URL object, and return a formatted URL string.


Here's how the formatting process works:


    

  • href will be ignored.
    • 

  • path will be ignored.
    • 

  • protocol is treated the same with or without the trailing : (colon).
      

    • The protocols http, https, ftp, gopher, file will be
postfixed with :// (colon-slash-slash) as long as host/hostname are present.
      • 

    • All other protocols mailto, xmpp, aim, sftp, foo, etc will
be postfixed with : (colon).
      • 

    

    • 

  • slashes set to true if the protocol requires :// (colon-slash-slash)
      

    • Only needs to be set for protocols not previously listed as requiring
slashes, such as mongodb://localhost:8000/, or if host/hostname are absent.
      • 

    

    • 

  • auth will be used if present.
    • 

  • hostname will only be used if host is absent.
    • 

  • port will only be used if host is absent.
    • 

  • host will be used in place of hostname and port.
    • 

  • pathname is treated the same with or without the leading / (slash).
    • 

  • query (object; see querystring) will only be used if search is absent.
    • 

  • search will be used in place of query.
      

    • It is treated the same with or without the leading ? (question mark).
      • 

    

    • 

  • hash is treated the same with or without the leading # (pound sign, anchor).
    • 



url.parse(urlStr[, parseQueryString][, slashesDenoteHost])#



Added in: v0.1.25

Take a URL string, and return an object.


Pass true as the second argument to also parse the query string using the
querystring module. If true then the query property will always be
assigned an object, and the search property will always be a (possibly
empty) string. If false then the query property will not be parsed or
decoded. Defaults to false.


Pass true as the third argument to treat //foo/bar as
{ host: 'foo', pathname: '/bar' } rather than
{ pathname: '//foo/bar' }. Defaults to false.


url.resolve(from, to)#



Added in: v0.1.25

Take a base URL, and a href URL, and resolve them as a browser would for
an anchor tag.  Examples:


url.resolve('/one/two/three', 'four')         // '/one/two/four'
url.resolve('http://example.com/', '/one')    // 'http://example.com/one'
url.resolve('http://example.com/one', '/two') // 'http://example.com/two'



      

    

  

  
  
  
  



node-v4.8.2/doc/api/url.json000644 000766 000024 00000017754 13070706740 016005 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/url.md",
  "modules": [
    {
      "textRaw": "URL",
      "name": "url",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
This module has utilities for URL resolution and parsing.\nCall require('url') to use it.
\n",
      "modules": [
        {
          "textRaw": "URL Parsing",
          "name": "url_parsing",
          "desc": "
Parsed URL objects have some or all of the following fields, depending on\nwhether or not they exist in the URL string. Any parts that are not in the URL\nstring will not be in the parsed object. Examples are shown for the URL
\n
'http://user:pass@host.com:8080/p/a/t/h?query=string#hash'
\n
    \n
  • href: The full URL that was originally parsed. Both the protocol and host are lowercased.
    \n
      Example: 'http://user:pass@host.com:8080/p/a/t/h?query=string#hash'
    \n
    • \n
  • protocol: The request protocol, lowercased.
    \n
      Example: 'http:'
    \n
    • \n
  • slashes: The protocol requires slashes after the colon.
    \n
      Example: true or false
    \n
    • \n
  • host: The full lowercased host portion of the URL, including port\ninformation.
    \n
      Example: 'host.com:8080'
    \n
    • \n
  • auth: The authentication information portion of a URL.
    \n
      Example: 'user:pass'
    \n
    • \n
  • hostname: Just the lowercased hostname portion of the host.
    \n
      Example: 'host.com'
    \n
    • \n
  • port: The port number portion of the host.
    \n
      Example: '8080'
    \n
    • \n
  • pathname: The path section of the URL, that comes after the host and\nbefore the query, including the initial slash if present. No decoding is\nperformed.
    \n
      Example: '/p/a/t/h'
    \n
    • \n
  • search: The 'query string' portion of the URL, including the leading\nquestion mark.
    \n
      Example: '?query=string'
    \n
    • \n
  • path: Concatenation of pathname and search. No decoding is performed.
    \n
      Example: '/p/a/t/h?query=string'
    \n
    • \n
  • query: Either the 'params' portion of the query string, or a\nquerystring-parsed object.
    \n
      Example: 'query=string' or {'query':'string'}
    \n
    • \n
  • hash: The 'fragment' portion of the URL including the pound-sign.
    \n
      Example: '#hash'
    \n
    • \n
\n",
          "modules": [
            {
              "textRaw": "Escaped Characters",
              "name": "escaped_characters",
              "desc": "
Spaces (' ') and the following characters will be automatically escaped in the\nproperties of URL objects:
\n
< > " ` \\r \\n \\t { } | \\ ^ '\n
\n
The following methods are provided by the URL module:
\n",
              "type": "module",
              "displayName": "Escaped Characters"
            }
          ],
          "type": "module",
          "displayName": "URL Parsing"
        }
      ],
      "methods": [
        {
          "textRaw": "url.format(urlObj)",
          "type": "method",
          "name": "format",
          "meta": {
            "added": [
              "v0.1.25"
            ]
          },
          "desc": "
Take a parsed URL object, and return a formatted URL string.
\n
Here's how the formatting process works:
\n
    \n
  • href will be ignored.
    • \n
  • path will be ignored.
    • \n
  • protocol is treated the same with or without the trailing : (colon).
      \n
    • The protocols http, https, ftp, gopher, file will be\npostfixed with :// (colon-slash-slash) as long as host/hostname are present.
      • \n
    • All other protocols mailto, xmpp, aim, sftp, foo, etc will\nbe postfixed with : (colon).
      • \n
    \n
    • \n
  • slashes set to true if the protocol requires :// (colon-slash-slash)
      \n
    • Only needs to be set for protocols not previously listed as requiring\nslashes, such as mongodb://localhost:8000/, or if host/hostname are absent.
      • \n
    \n
    • \n
  • auth will be used if present.
    • \n
  • hostname will only be used if host is absent.
    • \n
  • port will only be used if host is absent.
    • \n
  • host will be used in place of hostname and port.
    • \n
  • pathname is treated the same with or without the leading / (slash).
    • \n
  • query (object; see querystring) will only be used if search is absent.
    • \n
  • search will be used in place of query.
      \n
    • It is treated the same with or without the leading ? (question mark).
      • \n
    \n
    • \n
  • hash is treated the same with or without the leading # (pound sign, anchor).
    • \n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "urlObj"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "url.parse(urlStr[, parseQueryString][, slashesDenoteHost])",
          "type": "method",
          "name": "parse",
          "meta": {
            "added": [
              "v0.1.25"
            ]
          },
          "desc": "
Take a URL string, and return an object.
\n
Pass true as the second argument to also parse the query string using the\nquerystring module. If true then the query property will always be\nassigned an object, and the search property will always be a (possibly\nempty) string. If false then the query property will not be parsed or\ndecoded. Defaults to false.
\n
Pass true as the third argument to treat //foo/bar as\n{ host: 'foo', pathname: '/bar' } rather than\n{ pathname: '//foo/bar' }. Defaults to false.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "urlStr"
                },
                {
                  "name": "parseQueryString",
                  "optional": true
                },
                {
                  "name": "slashesDenoteHost",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "url.resolve(from, to)",
          "type": "method",
          "name": "resolve",
          "meta": {
            "added": [
              "v0.1.25"
            ]
          },
          "desc": "
Take a base URL, and a href URL, and resolve them as a browser would for\nan anchor tag.  Examples:
\n
url.resolve('/one/two/three', 'four')         // '/one/two/four'\nurl.resolve('http://example.com/', '/one')    // 'http://example.com/one'\nurl.resolve('http://example.com/one', '/two') // 'http://example.com/two'\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "from"
                },
                {
                  "name": "to"
                }
              ]
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "URL"
    }
  ]
}
node-v4.8.2/doc/api/url.md000644 000766 000024 00000010413 13070706735 015421 0ustar00iojsstaff000000 000000 # URL

> Stability: 2 - Stable

This module has utilities for URL resolution and parsing.
Call `require('url')` to use it.

## URL Parsing

Parsed URL objects have some or all of the following fields, depending on
whether or not they exist in the URL string. Any parts that are not in the URL
string will not be in the parsed object. Examples are shown for the URL

`'http://user:pass@host.com:8080/p/a/t/h?query=string#hash'`

* `href`: The full URL that was originally parsed. Both the protocol and host are lowercased.

    Example: `'http://user:pass@host.com:8080/p/a/t/h?query=string#hash'`

* `protocol`: The request protocol, lowercased.

    Example: `'http:'`

* `slashes`: The protocol requires slashes after the colon.

    Example: true or false

* `host`: The full lowercased host portion of the URL, including port
  information.

    Example: `'host.com:8080'`

* `auth`: The authentication information portion of a URL.

    Example: `'user:pass'`

* `hostname`: Just the lowercased hostname portion of the host.

    Example: `'host.com'`

* `port`: The port number portion of the host.

    Example: `'8080'`

* `pathname`: The path section of the URL, that comes after the host and
  before the query, including the initial slash if present. No decoding is
  performed.

    Example: `'/p/a/t/h'`

* `search`: The 'query string' portion of the URL, including the leading
  question mark.

    Example: `'?query=string'`

* `path`: Concatenation of `pathname` and `search`. No decoding is performed.

    Example: `'/p/a/t/h?query=string'`

* `query`: Either the 'params' portion of the query string, or a
  querystring-parsed object.

    Example: `'query=string'` or `{'query':'string'}`

* `hash`: The 'fragment' portion of the URL including the pound-sign.

    Example: `'#hash'`

### Escaped Characters

Spaces (`' '`) and the following characters will be automatically escaped in the
properties of URL objects:

```
< > " ` \r \n \t { } | \ ^ '
```

---

The following methods are provided by the URL module:

## url.format(urlObj)


Take a parsed URL object, and return a formatted URL string.

Here's how the formatting process works:

* `href` will be ignored.
* `path` will be ignored.
* `protocol` is treated the same with or without the trailing `:` (colon).
  * The protocols `http`, `https`, `ftp`, `gopher`, `file` will be
    postfixed with `://` (colon-slash-slash) as long as `host`/`hostname` are present.
  * All other protocols `mailto`, `xmpp`, `aim`, `sftp`, `foo`, etc will
    be postfixed with `:` (colon).
* `slashes` set to `true` if the protocol requires `://` (colon-slash-slash)
  * Only needs to be set for protocols not previously listed as requiring
    slashes, such as `mongodb://localhost:8000/`, or if `host`/`hostname` are absent.
* `auth` will be used if present.
* `hostname` will only be used if `host` is absent.
* `port` will only be used if `host` is absent.
* `host` will be used in place of `hostname` and `port`.
* `pathname` is treated the same with or without the leading `/` (slash).
* `query` (object; see `querystring`) will only be used if `search` is absent.
* `search` will be used in place of `query`.
  * It is treated the same with or without the leading `?` (question mark).
* `hash` is treated the same with or without the leading `#` (pound sign, anchor).

## url.parse(urlStr[, parseQueryString][, slashesDenoteHost])


Take a URL string, and return an object.

Pass `true` as the second argument to also parse the query string using the
`querystring` module. If `true` then the `query` property will always be
assigned an object, and the `search` property will always be a (possibly
empty) string. If `false` then the `query` property will not be parsed or
decoded. Defaults to `false`.

Pass `true` as the third argument to treat `//foo/bar` as
`{ host: 'foo', pathname: '/bar' }` rather than
`{ pathname: '//foo/bar' }`. Defaults to `false`.

## url.resolve(from, to)


Take a base URL, and a href URL, and resolve them as a browser would for
an anchor tag.  Examples:

```js
url.resolve('/one/two/three', 'four')         // '/one/two/four'
url.resolve('http://example.com/', '/one')    // 'http://example.com/one'
url.resolve('http://example.com/one', '/two') // 'http://example.com/two'
```
node-v4.8.2/doc/api/util.html000644 000766 000024 00000074424 13070706740 016150 0ustar00iojsstaff000000 000000 


  
  Util | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

      

        
Util#


Stability: 2 - Stable
These functions are in the module 'util'. Use require('util') to
access them.


The util module is primarily designed to support the needs of Node.js's
internal APIs.  Many of these utilities are useful for your own
programs.  If you find that these functions are lacking for your
purposes, however, you are encouraged to write your own utilities.  We
are not interested in any future additions to the util module that
are unnecessary for Node.js's internal functionality.


util.debug(string)#


Stability: 0 - Deprecated: Use console.error() instead.
Deprecated predecessor of console.error.


util.debuglog(section)#



Added in: v0.11.3

    

  • section <String> The section of the program to be debugged
    • 

  • Returns: <Function> The logging function
    • 



This is used to create a function which conditionally writes to stderr
based on the existence of a NODE_DEBUG environment variable.  If the
section name appears in that environment variable, then the returned
function will be similar to console.error().  If not, then the
returned function is a no-op.


For example:


var debuglog = util.debuglog('foo');

var bar = 123;
debuglog('hello from foo [%d]', bar);



If this program is run with NODE_DEBUG=foo in the environment, then
it will output something like:


FOO 3245: hello from foo [123]

where 3245 is the process id.  If it is not run with that
environment variable set, then it will not print anything.


You may separate multiple NODE_DEBUG environment variables with a
comma.  For example, NODE_DEBUG=fs,net,tls.


util.deprecate(function, string)#



Added in: v0.8.0

Marks that a method should not be used any more.


const util = require('util');

exports.puts = util.deprecate(function() {
  for (var i = 0, len = arguments.length; i < len; ++i) {
    process.stdout.write(arguments[i] + '\n');
  }
}, 'util.puts: Use console.log instead');



It returns a modified function which warns once by default.


If --no-deprecation is set then this function is a NO-OP.  Configurable
at run-time through the process.noDeprecation boolean (only effective
when set before a module is loaded.)


If --trace-deprecation is set, a warning and a stack trace are logged
to the console the first time the deprecated API is used.  Configurable
at run-time through the process.traceDeprecation boolean.


If --throw-deprecation is set then the application throws an exception
when the deprecated API is used.  Configurable at run-time through the
process.throwDeprecation boolean.


process.throwDeprecation takes precedence over process.traceDeprecation.


util.error([...])#



Added in: v0.3.0
Deprecated since: v0.11.3 

Stability: 0 - Deprecated: Use console.error() instead.
Deprecated predecessor of console.error.


util.format(format[, ...])#



Added in: v0.5.3

Returns a formatted string using the first argument as a printf-like format.


The first argument is a string that contains zero or more placeholders.
Each placeholder is replaced with the converted value from its corresponding
argument. Supported placeholders are:


    

  • %s - String.
    • 

  • %d - Number (both integer and float).
    • 

  • %j - JSON.  Replaced with the string '[Circular]' if the argument
contains circular references.
    • 

  • %% - single percent sign ('%'). This does not consume an argument.
    • 



If the placeholder does not have a corresponding argument, the placeholder is
not replaced.


util.format('%s:%s', 'foo'); // 'foo:%s'



If there are more arguments than placeholders, the extra arguments are
coerced to strings (for objects and symbols, util.inspect() is used)
and then concatenated, delimited by a space.


util.format('%s:%s', 'foo', 'bar', 'baz'); // 'foo:bar baz'



If the first argument is not a format string then util.format() returns
a string that is the concatenation of all its arguments separated by spaces.
Each argument is converted to a string with util.inspect().


util.format(1, 2, 3); // '1 2 3'



util.inherits(constructor, superConstructor)#



Added in: v0.3.0

Inherit the prototype methods from one constructor into another.  The
prototype of constructor will be set to a new object created from
superConstructor.


As an additional convenience, superConstructor will be accessible
through the constructor.super_ property.


const util = require('util');
const EventEmitter = require('events');

function MyStream() {
    EventEmitter.call(this);
}

util.inherits(MyStream, EventEmitter);

MyStream.prototype.write = function(data) {
    this.emit('data', data);
}

var stream = new MyStream();

console.log(stream instanceof EventEmitter); // true
console.log(MyStream.super_ === EventEmitter); // true

stream.on('data', (data) => {
  console.log(`Received data: "${data}"`);
})
stream.write('It works!'); // Received data: "It works!"



util.inspect(object[, options])#



Added in: v0.3.0

Return a string representation of object, which is useful for debugging.


An optional options object may be passed that alters certain aspects of the
formatted string:


    

  • showHidden - if true then the object's non-enumerable and symbol
properties will be shown too. Defaults to false.
    

    • 

  • depth - tells inspect how many times to recurse while formatting the
object. This is useful for inspecting large complicated objects. Defaults to
2. To make it recurse indefinitely pass null.
    

    • 

  • colors - if true, then the output will be styled with ANSI color codes.
Defaults to false. Colors are customizable, see Customizing
util.inspect colors.
    

    • 

  • customInspect - if false, then custom inspect(depth, opts) functions
defined on the objects being inspected won't be called. Defaults to true.
    

    • 



Example of inspecting all properties of the util object:


const util = require('util');

console.log(util.inspect(util, { showHidden: true, depth: null }));



Values may supply their own custom inspect(depth, opts) functions, when
called they receive the current depth in the recursive inspection, as well as
the options object passed to util.inspect().


Customizing util.inspect colors#



Color output (if enabled) of util.inspect is customizable globally
via util.inspect.styles and util.inspect.colors objects.


util.inspect.styles is a map assigning each style a color
from util.inspect.colors.
Highlighted styles and their default values are:


    

  • number (yellow)
    • 

  • boolean (yellow)
    • 

  • string (green)
    • 

  • date (magenta)
    • 

  • regexp (red)
    • 

  • null (bold)
    • 

  • undefined (grey)
    • 

  • special - only function at this time (cyan)
    • 

  • name (intentionally no styling)
    • 



Predefined color codes are: white, grey, black, blue, cyan,
green, magenta, red and yellow.
There are also bold, italic, underline and inverse codes.


Custom inspect() function on Objects#



Objects also may define their own inspect(depth) function which util.inspect()
will invoke and use the result of when inspecting the object:


const util = require('util');

var obj = { name: 'nate' };
obj.inspect = function(depth) {
  return `{${this.name}}`;
};

util.inspect(obj);
  // "{nate}"



You may also return another Object entirely, and the returned String will be
formatted according to the returned Object. This is similar to how
JSON.stringify() works:


var obj = { foo: 'this will not show up in the inspect() output' };
obj.inspect = function(depth) {
  return { bar: 'baz' };
};

util.inspect(obj);
  // "{ bar: 'baz' }"



util.isArray(object)#



Added in: v0.6.0
Deprecated since: v4.0.0 

Stability: 0 - Deprecated
Internal alias for Array.isArray.


Returns true if the given "object" is an Array. Otherwise, returns false.


const util = require('util');

util.isArray([])
  // true
util.isArray(new Array)
  // true
util.isArray({})
  // false



util.isBoolean(object)#



Added in: v0.11.5
Deprecated since: v4.0.0 

Stability: 0 - Deprecated
Returns true if the given "object" is a Boolean. Otherwise, returns false.


const util = require('util');

util.isBoolean(1)
  // false
util.isBoolean(0)
  // false
util.isBoolean(false)
  // true



util.isBuffer(object)#



Added in: v0.11.5
Deprecated since: v4.0.0 

Stability: 0 - Deprecated: Use Buffer.isBuffer() instead.
Returns true if the given "object" is a Buffer. Otherwise, returns false.


const util = require('util');

util.isBuffer({ length: 0 })
  // false
util.isBuffer([])
  // false
util.isBuffer(new Buffer('hello world'))
  // true



util.isDate(object)#



Added in: v0.6.0
Deprecated since: v4.0.0 

Stability: 0 - Deprecated
Returns true if the given "object" is a Date. Otherwise, returns false.


const util = require('util');

util.isDate(new Date())
  // true
util.isDate(Date())
  // false (without 'new' returns a String)
util.isDate({})
  // false



util.isError(object)#



Added in: v0.6.0
Deprecated since: v4.0.0 

Stability: 0 - Deprecated
Returns true if the given "object" is an Error. Otherwise, returns
false.


const util = require('util');

util.isError(new Error())
  // true
util.isError(new TypeError())
  // true
util.isError({ name: 'Error', message: 'an error occurred' })
  // false



util.isFunction(object)#



Added in: v0.11.5
Deprecated since: v4.0.0 

Stability: 0 - Deprecated
Returns true if the given "object" is a Function. Otherwise, returns
false.


const util = require('util');

function Foo() {}
var Bar = function() {};

util.isFunction({})
  // false
util.isFunction(Foo)
  // true
util.isFunction(Bar)
  // true



util.isNull(object)#



Added in: v0.11.5
Deprecated since: v4.0.0 

Stability: 0 - Deprecated
Returns true if the given "object" is strictly null. Otherwise, returns
false.


const util = require('util');

util.isNull(0)
  // false
util.isNull(undefined)
  // false
util.isNull(null)
  // true



util.isNullOrUndefined(object)#



Added in: v0.11.5
Deprecated since: v4.0.0 

Stability: 0 - Deprecated
Returns true if the given "object" is null or undefined. Otherwise,
returns false.


const util = require('util');

util.isNullOrUndefined(0)
  // false
util.isNullOrUndefined(undefined)
  // true
util.isNullOrUndefined(null)
  // true



util.isNumber(object)#



Added in: v0.11.5
Deprecated since: v4.0.0 

Stability: 0 - Deprecated
Returns true if the given "object" is a Number. Otherwise, returns false.


const util = require('util');

util.isNumber(false)
  // false
util.isNumber(Infinity)
  // true
util.isNumber(0)
  // true
util.isNumber(NaN)
  // true



util.isObject(object)#



Added in: v0.11.5
Deprecated since: v4.0.0 

Stability: 0 - Deprecated
Returns true if the given "object" is strictly an Object and not a
Function. Otherwise, returns false.


const util = require('util');

util.isObject(5)
  // false
util.isObject(null)
  // false
util.isObject({})
  // true
util.isObject(function(){})
  // false



util.isPrimitive(object)#



Added in: v0.11.5
Deprecated since: v4.0.0 

Stability: 0 - Deprecated
Returns true if the given "object" is a primitive type. Otherwise, returns
false.


const util = require('util');

util.isPrimitive(5)
  // true
util.isPrimitive('foo')
  // true
util.isPrimitive(false)
  // true
util.isPrimitive(null)
  // true
util.isPrimitive(undefined)
  // true
util.isPrimitive({})
  // false
util.isPrimitive(function() {})
  // false
util.isPrimitive(/^$/)
  // false
util.isPrimitive(new Date())
  // false



util.isRegExp(object)#



Added in: v0.6.0
Deprecated since: v4.0.0 

Stability: 0 - Deprecated
Returns true if the given "object" is a RegExp. Otherwise, returns false.


const util = require('util');

util.isRegExp(/some regexp/)
  // true
util.isRegExp(new RegExp('another regexp'))
  // true
util.isRegExp({})
  // false



util.isString(object)#



Added in: v0.11.5
Deprecated since: v4.0.0 

Stability: 0 - Deprecated
Returns true if the given "object" is a String. Otherwise, returns false.


const util = require('util');

util.isString('')
  // true
util.isString('foo')
  // true
util.isString(String('foo'))
  // true
util.isString(5)
  // false



util.isSymbol(object)#



Added in: v0.11.5
Deprecated since: v4.0.0 

Stability: 0 - Deprecated
Returns true if the given "object" is a Symbol. Otherwise, returns false.


const util = require('util');

util.isSymbol(5)
  // false
util.isSymbol('foo')
  // false
util.isSymbol(Symbol('foo'))
  // true



util.isUndefined(object)#



Added in: v0.11.5
Deprecated since: v4.0.0 

Stability: 0 - Deprecated
Returns true if the given "object" is undefined. Otherwise, returns false.


const util = require('util');

var foo;
util.isUndefined(5)
  // false
util.isUndefined(foo)
  // true
util.isUndefined(null)
  // false



util.log(string)#



Added in: v0.3.0
Deprecated since: v6.0.0 

Output with timestamp on stdout.


require('util').log('Timestamped message.');

util.print([...])#



Added in: v0.3.0
Deprecated since: v0.11.3 

Stability: 0 - Deprecated: Use console.log() instead.
Deprecated predecessor of console.log.


util.pump(readableStream, writableStream[, callback])#



Added in: v0.3.0
Deprecated since: v0.9.1 

Stability: 0 - Deprecated: Use readableStream.pipe(writableStream)
Deprecated predecessor of stream.pipe().


util.puts([...])#



Added in: v0.3.0
Deprecated since: v0.11.3 

Stability: 0 - Deprecated: Use console.log() instead.
Deprecated predecessor of console.log.


      

    

  

  
  
  
  



node-v4.8.2/doc/api/util.json000644 000766 000024 00000074322 13070706740 016152 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/util.md",
  "modules": [
    {
      "textRaw": "Util",
      "name": "util",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
These functions are in the module 'util'. Use require('util') to\naccess them.
\n
The util module is primarily designed to support the needs of Node.js's\ninternal APIs.  Many of these utilities are useful for your own\nprograms.  If you find that these functions are lacking for your\npurposes, however, you are encouraged to write your own utilities.  We\nare not interested in any future additions to the util module that\nare unnecessary for Node.js's internal functionality.
\n",
      "methods": [
        {
          "textRaw": "util.debug(string)",
          "type": "method",
          "name": "debug",
          "stability": 0,
          "stabilityText": "Deprecated: Use [`console.error()`][] instead.",
          "desc": "
Deprecated predecessor of console.error.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "string"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.debuglog(section)",
          "type": "method",
          "name": "debuglog",
          "meta": {
            "added": [
              "v0.11.3"
            ]
          },
          "signatures": [
            {
              "return": {
                "textRaw": "Returns: {Function} The logging function ",
                "name": "return",
                "type": "Function",
                "desc": "The logging function"
              },
              "params": [
                {
                  "textRaw": "`section` {String} The section of the program to be debugged ",
                  "name": "section",
                  "type": "String",
                  "desc": "The section of the program to be debugged"
                }
              ]
            },
            {
              "params": [
                {
                  "name": "section"
                }
              ]
            }
          ],
          "desc": "
This is used to create a function which conditionally writes to stderr\nbased on the existence of a NODE_DEBUG environment variable.  If the\nsection name appears in that environment variable, then the returned\nfunction will be similar to console.error().  If not, then the\nreturned function is a no-op.
\n
For example:
\n
var debuglog = util.debuglog('foo');\n\nvar bar = 123;\ndebuglog('hello from foo [%d]', bar);\n
\n
If this program is run with NODE_DEBUG=foo in the environment, then\nit will output something like:
\n
FOO 3245: hello from foo [123]\n
where 3245 is the process id.  If it is not run with that\nenvironment variable set, then it will not print anything.
\n
You may separate multiple NODE_DEBUG environment variables with a\ncomma.  For example, NODE_DEBUG=fs,net,tls.
\n"
        },
        {
          "textRaw": "util.deprecate(function, string)",
          "type": "method",
          "name": "deprecate",
          "meta": {
            "added": [
              "v0.8.0"
            ]
          },
          "desc": "
Marks that a method should not be used any more.
\n
const util = require('util');\n\nexports.puts = util.deprecate(function() {\n  for (var i = 0, len = arguments.length; i < len; ++i) {\n    process.stdout.write(arguments[i] + '\\n');\n  }\n}, 'util.puts: Use console.log instead');\n
\n
It returns a modified function which warns once by default.
\n
If --no-deprecation is set then this function is a NO-OP.  Configurable\nat run-time through the process.noDeprecation boolean (only effective\nwhen set before a module is loaded.)
\n
If --trace-deprecation is set, a warning and a stack trace are logged\nto the console the first time the deprecated API is used.  Configurable\nat run-time through the process.traceDeprecation boolean.
\n
If --throw-deprecation is set then the application throws an exception\nwhen the deprecated API is used.  Configurable at run-time through the\nprocess.throwDeprecation boolean.
\n
process.throwDeprecation takes precedence over process.traceDeprecation.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "function"
                },
                {
                  "name": "string"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.error([...])",
          "type": "method",
          "name": "error",
          "meta": {
            "added": [
              "v0.3.0"
            ],
            "deprecated": [
              "v0.11.3"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated: Use [`console.error()`][] instead.",
          "desc": "
Deprecated predecessor of console.error.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "...",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.format(format[, ...])",
          "type": "method",
          "name": "format",
          "meta": {
            "added": [
              "v0.5.3"
            ]
          },
          "desc": "
Returns a formatted string using the first argument as a printf-like format.
\n
The first argument is a string that contains zero or more placeholders.\nEach placeholder is replaced with the converted value from its corresponding\nargument. Supported placeholders are:
\n
    \n
  • %s - String.
    • \n
  • %d - Number (both integer and float).
    • \n
  • %j - JSON.  Replaced with the string '[Circular]' if the argument\ncontains circular references.
    • \n
  • %% - single percent sign ('%'). This does not consume an argument.
    • \n
\n
If the placeholder does not have a corresponding argument, the placeholder is\nnot replaced.
\n
util.format('%s:%s', 'foo'); // 'foo:%s'\n
\n
If there are more arguments than placeholders, the extra arguments are\ncoerced to strings (for objects and symbols, util.inspect() is used)\nand then concatenated, delimited by a space.
\n
util.format('%s:%s', 'foo', 'bar', 'baz'); // 'foo:bar baz'\n
\n
If the first argument is not a format string then util.format() returns\na string that is the concatenation of all its arguments separated by spaces.\nEach argument is converted to a string with util.inspect().
\n
util.format(1, 2, 3); // '1 2 3'\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "format"
                },
                {
                  "name": "...",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.inherits(constructor, superConstructor)",
          "type": "method",
          "name": "inherits",
          "meta": {
            "added": [
              "v0.3.0"
            ]
          },
          "desc": "
Inherit the prototype methods from one constructor into another.  The\nprototype of constructor will be set to a new object created from\nsuperConstructor.
\n
As an additional convenience, superConstructor will be accessible\nthrough the constructor.super_ property.
\n
const util = require('util');\nconst EventEmitter = require('events');\n\nfunction MyStream() {\n    EventEmitter.call(this);\n}\n\nutil.inherits(MyStream, EventEmitter);\n\nMyStream.prototype.write = function(data) {\n    this.emit('data', data);\n}\n\nvar stream = new MyStream();\n\nconsole.log(stream instanceof EventEmitter); // true\nconsole.log(MyStream.super_ === EventEmitter); // true\n\nstream.on('data', (data) => {\n  console.log(`Received data: "${data}"`);\n})\nstream.write('It works!'); // Received data: "It works!"\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "constructor"
                },
                {
                  "name": "superConstructor"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.inspect(object[, options])",
          "type": "method",
          "name": "inspect",
          "meta": {
            "added": [
              "v0.3.0"
            ]
          },
          "desc": "
Return a string representation of object, which is useful for debugging.
\n
An optional options object may be passed that alters certain aspects of the\nformatted string:
\n
    \n
  • showHidden - if true then the object's non-enumerable and symbol\nproperties will be shown too. Defaults to false.
    \n
    • \n
  • depth - tells inspect how many times to recurse while formatting the\nobject. This is useful for inspecting large complicated objects. Defaults to\n2. To make it recurse indefinitely pass null.
    \n
    • \n
  • colors - if true, then the output will be styled with ANSI color codes.\nDefaults to false. Colors are customizable, see Customizing\nutil.inspect colors.
    \n
    • \n
  • customInspect - if false, then custom inspect(depth, opts) functions\ndefined on the objects being inspected won't be called. Defaults to true.
    \n
    • \n
\n
Example of inspecting all properties of the util object:
\n
const util = require('util');\n\nconsole.log(util.inspect(util, { showHidden: true, depth: null }));\n
\n
Values may supply their own custom inspect(depth, opts) functions, when\ncalled they receive the current depth in the recursive inspection, as well as\nthe options object passed to util.inspect().
\n",
          "miscs": [
            {
              "textRaw": "Customizing `util.inspect` colors",
              "name": "Customizing `util.inspect` colors",
              "type": "misc",
              "desc": "
Color output (if enabled) of util.inspect is customizable globally\nvia util.inspect.styles and util.inspect.colors objects.
\n
util.inspect.styles is a map assigning each style a color\nfrom util.inspect.colors.\nHighlighted styles and their default values are:
\n
    \n
  • number (yellow)
    • \n
  • boolean (yellow)
    • \n
  • string (green)
    • \n
  • date (magenta)
    • \n
  • regexp (red)
    • \n
  • null (bold)
    • \n
  • undefined (grey)
    • \n
  • special - only function at this time (cyan)
    • \n
  • name (intentionally no styling)
    • \n
\n
Predefined color codes are: white, grey, black, blue, cyan,\ngreen, magenta, red and yellow.\nThere are also bold, italic, underline and inverse codes.
\n"
            },
            {
              "textRaw": "Custom `inspect()` function on Objects",
              "name": "Custom `inspect()` function on Objects",
              "type": "misc",
              "desc": "
Objects also may define their own inspect(depth) function which util.inspect()\nwill invoke and use the result of when inspecting the object:
\n
const util = require('util');\n\nvar obj = { name: 'nate' };\nobj.inspect = function(depth) {\n  return `{${this.name}}`;\n};\n\nutil.inspect(obj);\n  // "{nate}"\n
\n
You may also return another Object entirely, and the returned String will be\nformatted according to the returned Object. This is similar to how\nJSON.stringify() works:
\n
var obj = { foo: 'this will not show up in the inspect() output' };\nobj.inspect = function(depth) {\n  return { bar: 'baz' };\n};\n\nutil.inspect(obj);\n  // "{ bar: 'baz' }"\n
\n"
            }
          ],
          "signatures": [
            {
              "params": [
                {
                  "name": "object"
                },
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.isArray(object)",
          "type": "method",
          "name": "isArray",
          "meta": {
            "added": [
              "v0.6.0"
            ],
            "deprecated": [
              "v4.0.0"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated",
          "desc": "
Internal alias for Array.isArray.
\n
Returns true if the given "object" is an Array. Otherwise, returns false.
\n
const util = require('util');\n\nutil.isArray([])\n  // true\nutil.isArray(new Array)\n  // true\nutil.isArray({})\n  // false\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "object"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.isBoolean(object)",
          "type": "method",
          "name": "isBoolean",
          "meta": {
            "added": [
              "v0.11.5"
            ],
            "deprecated": [
              "v4.0.0"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated",
          "desc": "
Returns true if the given "object" is a Boolean. Otherwise, returns false.
\n
const util = require('util');\n\nutil.isBoolean(1)\n  // false\nutil.isBoolean(0)\n  // false\nutil.isBoolean(false)\n  // true\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "object"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.isBuffer(object)",
          "type": "method",
          "name": "isBuffer",
          "meta": {
            "added": [
              "v0.11.5"
            ],
            "deprecated": [
              "v4.0.0"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated: Use [`Buffer.isBuffer()`][] instead.",
          "desc": "
Returns true if the given "object" is a Buffer. Otherwise, returns false.
\n
const util = require('util');\n\nutil.isBuffer({ length: 0 })\n  // false\nutil.isBuffer([])\n  // false\nutil.isBuffer(new Buffer('hello world'))\n  // true\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "object"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.isDate(object)",
          "type": "method",
          "name": "isDate",
          "meta": {
            "added": [
              "v0.6.0"
            ],
            "deprecated": [
              "v4.0.0"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated",
          "desc": "
Returns true if the given "object" is a Date. Otherwise, returns false.
\n
const util = require('util');\n\nutil.isDate(new Date())\n  // true\nutil.isDate(Date())\n  // false (without 'new' returns a String)\nutil.isDate({})\n  // false\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "object"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.isError(object)",
          "type": "method",
          "name": "isError",
          "meta": {
            "added": [
              "v0.6.0"
            ],
            "deprecated": [
              "v4.0.0"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated",
          "desc": "
Returns true if the given "object" is an Error. Otherwise, returns\nfalse.
\n
const util = require('util');\n\nutil.isError(new Error())\n  // true\nutil.isError(new TypeError())\n  // true\nutil.isError({ name: 'Error', message: 'an error occurred' })\n  // false\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "object"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.isFunction(object)",
          "type": "method",
          "name": "isFunction",
          "meta": {
            "added": [
              "v0.11.5"
            ],
            "deprecated": [
              "v4.0.0"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated",
          "desc": "
Returns true if the given "object" is a Function. Otherwise, returns\nfalse.
\n
const util = require('util');\n\nfunction Foo() {}\nvar Bar = function() {};\n\nutil.isFunction({})\n  // false\nutil.isFunction(Foo)\n  // true\nutil.isFunction(Bar)\n  // true\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "object"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.isNull(object)",
          "type": "method",
          "name": "isNull",
          "meta": {
            "added": [
              "v0.11.5"
            ],
            "deprecated": [
              "v4.0.0"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated",
          "desc": "
Returns true if the given "object" is strictly null. Otherwise, returns\nfalse.
\n
const util = require('util');\n\nutil.isNull(0)\n  // false\nutil.isNull(undefined)\n  // false\nutil.isNull(null)\n  // true\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "object"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.isNullOrUndefined(object)",
          "type": "method",
          "name": "isNullOrUndefined",
          "meta": {
            "added": [
              "v0.11.5"
            ],
            "deprecated": [
              "v4.0.0"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated",
          "desc": "
Returns true if the given "object" is null or undefined. Otherwise,\nreturns false.
\n
const util = require('util');\n\nutil.isNullOrUndefined(0)\n  // false\nutil.isNullOrUndefined(undefined)\n  // true\nutil.isNullOrUndefined(null)\n  // true\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "object"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.isNumber(object)",
          "type": "method",
          "name": "isNumber",
          "meta": {
            "added": [
              "v0.11.5"
            ],
            "deprecated": [
              "v4.0.0"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated",
          "desc": "
Returns true if the given "object" is a Number. Otherwise, returns false.
\n
const util = require('util');\n\nutil.isNumber(false)\n  // false\nutil.isNumber(Infinity)\n  // true\nutil.isNumber(0)\n  // true\nutil.isNumber(NaN)\n  // true\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "object"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.isObject(object)",
          "type": "method",
          "name": "isObject",
          "meta": {
            "added": [
              "v0.11.5"
            ],
            "deprecated": [
              "v4.0.0"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated",
          "desc": "
Returns true if the given "object" is strictly an Object and not a\nFunction. Otherwise, returns false.
\n
const util = require('util');\n\nutil.isObject(5)\n  // false\nutil.isObject(null)\n  // false\nutil.isObject({})\n  // true\nutil.isObject(function(){})\n  // false\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "object"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.isPrimitive(object)",
          "type": "method",
          "name": "isPrimitive",
          "meta": {
            "added": [
              "v0.11.5"
            ],
            "deprecated": [
              "v4.0.0"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated",
          "desc": "
Returns true if the given "object" is a primitive type. Otherwise, returns\nfalse.
\n
const util = require('util');\n\nutil.isPrimitive(5)\n  // true\nutil.isPrimitive('foo')\n  // true\nutil.isPrimitive(false)\n  // true\nutil.isPrimitive(null)\n  // true\nutil.isPrimitive(undefined)\n  // true\nutil.isPrimitive({})\n  // false\nutil.isPrimitive(function() {})\n  // false\nutil.isPrimitive(/^$/)\n  // false\nutil.isPrimitive(new Date())\n  // false\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "object"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.isRegExp(object)",
          "type": "method",
          "name": "isRegExp",
          "meta": {
            "added": [
              "v0.6.0"
            ],
            "deprecated": [
              "v4.0.0"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated",
          "desc": "
Returns true if the given "object" is a RegExp. Otherwise, returns false.
\n
const util = require('util');\n\nutil.isRegExp(/some regexp/)\n  // true\nutil.isRegExp(new RegExp('another regexp'))\n  // true\nutil.isRegExp({})\n  // false\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "object"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.isString(object)",
          "type": "method",
          "name": "isString",
          "meta": {
            "added": [
              "v0.11.5"
            ],
            "deprecated": [
              "v4.0.0"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated",
          "desc": "
Returns true if the given "object" is a String. Otherwise, returns false.
\n
const util = require('util');\n\nutil.isString('')\n  // true\nutil.isString('foo')\n  // true\nutil.isString(String('foo'))\n  // true\nutil.isString(5)\n  // false\n
\n",
          "methods": [
            {
              "textRaw": "util.isSymbol(object)",
              "type": "method",
              "name": "isSymbol",
              "meta": {
                "added": [
                  "v0.11.5"
                ],
                "deprecated": [
                  "v4.0.0"
                ]
              },
              "stability": 0,
              "stabilityText": "Deprecated",
              "desc": "
Returns true if the given "object" is a Symbol. Otherwise, returns false.
\n
const util = require('util');\n\nutil.isSymbol(5)\n  // false\nutil.isSymbol('foo')\n  // false\nutil.isSymbol(Symbol('foo'))\n  // true\n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "object"
                    }
                  ]
                }
              ]
            }
          ],
          "signatures": [
            {
              "params": [
                {
                  "name": "object"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.isUndefined(object)",
          "type": "method",
          "name": "isUndefined",
          "meta": {
            "added": [
              "v0.11.5"
            ],
            "deprecated": [
              "v4.0.0"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated",
          "desc": "
Returns true if the given "object" is undefined. Otherwise, returns false.
\n
const util = require('util');\n\nvar foo;\nutil.isUndefined(5)\n  // false\nutil.isUndefined(foo)\n  // true\nutil.isUndefined(null)\n  // false\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "object"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.log(string)",
          "type": "method",
          "name": "log",
          "meta": {
            "added": [
              "v0.3.0"
            ],
            "deprecated": [
              "v6.0.0"
            ]
          },
          "desc": "
Output with timestamp on stdout.
\n
require('util').log('Timestamped message.');\n
",
          "signatures": [
            {
              "params": [
                {
                  "name": "string"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.print([...])",
          "type": "method",
          "name": "print",
          "meta": {
            "added": [
              "v0.3.0"
            ],
            "deprecated": [
              "v0.11.3"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated: Use [`console.log()`][] instead.",
          "desc": "
Deprecated predecessor of console.log.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "...",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.pump(readableStream, writableStream[, callback])",
          "type": "method",
          "name": "pump",
          "meta": {
            "added": [
              "v0.3.0"
            ],
            "deprecated": [
              "v0.9.1"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated: Use readableStream.pipe(writableStream)",
          "desc": "
Deprecated predecessor of stream.pipe().
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "readableStream"
                },
                {
                  "name": "writableStream"
                },
                {
                  "name": "callback",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "util.puts([...])",
          "type": "method",
          "name": "puts",
          "meta": {
            "added": [
              "v0.3.0"
            ],
            "deprecated": [
              "v0.11.3"
            ]
          },
          "stability": 0,
          "stabilityText": "Deprecated: Use [`console.log()`][] instead.",
          "desc": "
Deprecated predecessor of console.log.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "...",
                  "optional": true
                }
              ]
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "Util"
    }
  ]
}
node-v4.8.2/doc/api/util.md000644 000766 000024 00000034175 13070706735 015607 0ustar00iojsstaff000000 000000 # Util

> Stability: 2 - Stable

These functions are in the module `'util'`. Use `require('util')` to
access them.

The `util` module is primarily designed to support the needs of Node.js's
internal APIs.  Many of these utilities are useful for your own
programs.  If you find that these functions are lacking for your
purposes, however, you are encouraged to write your own utilities.  We
are not interested in any future additions to the `util` module that
are unnecessary for Node.js's internal functionality.

## util.debug(string)

> Stability: 0 - Deprecated: Use [`console.error()`][] instead.

Deprecated predecessor of `console.error`.

## util.debuglog(section)


* `section` {String} The section of the program to be debugged
* Returns: {Function} The logging function

This is used to create a function which conditionally writes to stderr
based on the existence of a `NODE_DEBUG` environment variable.  If the
`section` name appears in that environment variable, then the returned
function will be similar to `console.error()`.  If not, then the
returned function is a no-op.

For example:

```js
var debuglog = util.debuglog('foo');

var bar = 123;
debuglog('hello from foo [%d]', bar);
```

If this program is run with `NODE_DEBUG=foo` in the environment, then
it will output something like:

```
FOO 3245: hello from foo [123]
```

where `3245` is the process id.  If it is not run with that
environment variable set, then it will not print anything.

You may separate multiple `NODE_DEBUG` environment variables with a
comma.  For example, `NODE_DEBUG=fs,net,tls`.

## util.deprecate(function, string)


Marks that a method should not be used any more.

```js
const util = require('util');

exports.puts = util.deprecate(function() {
  for (var i = 0, len = arguments.length; i < len; ++i) {
    process.stdout.write(arguments[i] + '\n');
  }
}, 'util.puts: Use console.log instead');
```

It returns a modified function which warns once by default.

If `--no-deprecation` is set then this function is a NO-OP.  Configurable
at run-time through the `process.noDeprecation` boolean (only effective
when set before a module is loaded.)

If `--trace-deprecation` is set, a warning and a stack trace are logged
to the console the first time the deprecated API is used.  Configurable
at run-time through the `process.traceDeprecation` boolean.

If `--throw-deprecation` is set then the application throws an exception
when the deprecated API is used.  Configurable at run-time through the
`process.throwDeprecation` boolean.

`process.throwDeprecation` takes precedence over `process.traceDeprecation`.

## util.error([...])


> Stability: 0 - Deprecated: Use [`console.error()`][] instead.

Deprecated predecessor of `console.error`.

## util.format(format[, ...])


Returns a formatted string using the first argument as a `printf`-like format.

The first argument is a string that contains zero or more *placeholders*.
Each placeholder is replaced with the converted value from its corresponding
argument. Supported placeholders are:

* `%s` - String.
* `%d` - Number (both integer and float).
* `%j` - JSON.  Replaced with the string `'[Circular]'` if the argument
contains circular references.
* `%%` - single percent sign (`'%'`). This does not consume an argument.

If the placeholder does not have a corresponding argument, the placeholder is
not replaced.

```js
util.format('%s:%s', 'foo'); // 'foo:%s'
```

If there are more arguments than placeholders, the extra arguments are
coerced to strings (for objects and symbols, `util.inspect()` is used)
and then concatenated, delimited by a space.

```js
util.format('%s:%s', 'foo', 'bar', 'baz'); // 'foo:bar baz'
```

If the first argument is not a format string then `util.format()` returns
a string that is the concatenation of all its arguments separated by spaces.
Each argument is converted to a string with `util.inspect()`.

```js
util.format(1, 2, 3); // '1 2 3'
```

## util.inherits(constructor, superConstructor)


Inherit the prototype methods from one [constructor][] into another.  The
prototype of `constructor` will be set to a new object created from
`superConstructor`.

As an additional convenience, `superConstructor` will be accessible
through the `constructor.super_` property.

```js
const util = require('util');
const EventEmitter = require('events');

function MyStream() {
    EventEmitter.call(this);
}

util.inherits(MyStream, EventEmitter);

MyStream.prototype.write = function(data) {
    this.emit('data', data);
}

var stream = new MyStream();

console.log(stream instanceof EventEmitter); // true
console.log(MyStream.super_ === EventEmitter); // true

stream.on('data', (data) => {
  console.log(`Received data: "${data}"`);
})
stream.write('It works!'); // Received data: "It works!"
```

## util.inspect(object[, options])


Return a string representation of `object`, which is useful for debugging.

An optional *options* object may be passed that alters certain aspects of the
formatted string:

 - `showHidden` - if `true` then the object's non-enumerable and symbol
   properties will be shown too. Defaults to `false`.

 - `depth` - tells `inspect` how many times to recurse while formatting the
   object. This is useful for inspecting large complicated objects. Defaults to
   `2`. To make it recurse indefinitely pass `null`.

 - `colors` - if `true`, then the output will be styled with ANSI color codes.
   Defaults to `false`. Colors are customizable, see [Customizing
   `util.inspect` colors][].

 - `customInspect` - if `false`, then custom `inspect(depth, opts)` functions
   defined on the objects being inspected won't be called. Defaults to `true`.

Example of inspecting all properties of the `util` object:

```js
const util = require('util');

console.log(util.inspect(util, { showHidden: true, depth: null }));
```

Values may supply their own custom `inspect(depth, opts)` functions, when
called they receive the current depth in the recursive inspection, as well as
the options object passed to `util.inspect()`.

### Customizing `util.inspect` colors



Color output (if enabled) of `util.inspect` is customizable globally
via `util.inspect.styles` and `util.inspect.colors` objects.

`util.inspect.styles` is a map assigning each style a color
from `util.inspect.colors`.
Highlighted styles and their default values are:
 * `number` (yellow)
 * `boolean` (yellow)
 * `string` (green)
 * `date` (magenta)
 * `regexp` (red)
 * `null` (bold)
 * `undefined` (grey)
 * `special` - only function at this time (cyan)
 * `name` (intentionally no styling)

Predefined color codes are: `white`, `grey`, `black`, `blue`, `cyan`,
`green`, `magenta`, `red` and `yellow`.
There are also `bold`, `italic`, `underline` and `inverse` codes.

### Custom `inspect()` function on Objects



Objects also may define their own `inspect(depth)` function which `util.inspect()`
will invoke and use the result of when inspecting the object:

```js
const util = require('util');

var obj = { name: 'nate' };
obj.inspect = function(depth) {
  return `{${this.name}}`;
};

util.inspect(obj);
  // "{nate}"
```

You may also return another Object entirely, and the returned String will be
formatted according to the returned Object. This is similar to how
`JSON.stringify()` works:

```js
var obj = { foo: 'this will not show up in the inspect() output' };
obj.inspect = function(depth) {
  return { bar: 'baz' };
};

util.inspect(obj);
  // "{ bar: 'baz' }"
```

## util.isArray(object)


> Stability: 0 - Deprecated

Internal alias for [`Array.isArray`][].

Returns `true` if the given "object" is an `Array`. Otherwise, returns `false`.

```js
const util = require('util');

util.isArray([])
  // true
util.isArray(new Array)
  // true
util.isArray({})
  // false
```

## util.isBoolean(object)


> Stability: 0 - Deprecated

Returns `true` if the given "object" is a `Boolean`. Otherwise, returns `false`.

```js
const util = require('util');

util.isBoolean(1)
  // false
util.isBoolean(0)
  // false
util.isBoolean(false)
  // true
```

## util.isBuffer(object)


> Stability: 0 - Deprecated: Use [`Buffer.isBuffer()`][] instead.

Returns `true` if the given "object" is a `Buffer`. Otherwise, returns `false`.

```js
const util = require('util');

util.isBuffer({ length: 0 })
  // false
util.isBuffer([])
  // false
util.isBuffer(new Buffer('hello world'))
  // true
```

## util.isDate(object)


> Stability: 0 - Deprecated

Returns `true` if the given "object" is a `Date`. Otherwise, returns `false`.

```js
const util = require('util');

util.isDate(new Date())
  // true
util.isDate(Date())
  // false (without 'new' returns a String)
util.isDate({})
  // false
```

## util.isError(object)


> Stability: 0 - Deprecated

Returns `true` if the given "object" is an [`Error`][]. Otherwise, returns
`false`.

```js
const util = require('util');

util.isError(new Error())
  // true
util.isError(new TypeError())
  // true
util.isError({ name: 'Error', message: 'an error occurred' })
  // false
```

## util.isFunction(object)


> Stability: 0 - Deprecated

Returns `true` if the given "object" is a `Function`. Otherwise, returns
`false`.

```js
const util = require('util');

function Foo() {}
var Bar = function() {};

util.isFunction({})
  // false
util.isFunction(Foo)
  // true
util.isFunction(Bar)
  // true
```

## util.isNull(object)


> Stability: 0 - Deprecated

Returns `true` if the given "object" is strictly `null`. Otherwise, returns
`false`.

```js
const util = require('util');

util.isNull(0)
  // false
util.isNull(undefined)
  // false
util.isNull(null)
  // true
```

## util.isNullOrUndefined(object)


> Stability: 0 - Deprecated

Returns `true` if the given "object" is `null` or `undefined`. Otherwise,
returns `false`.

```js
const util = require('util');

util.isNullOrUndefined(0)
  // false
util.isNullOrUndefined(undefined)
  // true
util.isNullOrUndefined(null)
  // true
```

## util.isNumber(object)


> Stability: 0 - Deprecated

Returns `true` if the given "object" is a `Number`. Otherwise, returns `false`.

```js
const util = require('util');

util.isNumber(false)
  // false
util.isNumber(Infinity)
  // true
util.isNumber(0)
  // true
util.isNumber(NaN)
  // true
```

## util.isObject(object)


> Stability: 0 - Deprecated

Returns `true` if the given "object" is strictly an `Object` __and__ not a
`Function`. Otherwise, returns `false`.

```js
const util = require('util');

util.isObject(5)
  // false
util.isObject(null)
  // false
util.isObject({})
  // true
util.isObject(function(){})
  // false
```

## util.isPrimitive(object)


> Stability: 0 - Deprecated

Returns `true` if the given "object" is a primitive type. Otherwise, returns
`false`.

```js
const util = require('util');

util.isPrimitive(5)
  // true
util.isPrimitive('foo')
  // true
util.isPrimitive(false)
  // true
util.isPrimitive(null)
  // true
util.isPrimitive(undefined)
  // true
util.isPrimitive({})
  // false
util.isPrimitive(function() {})
  // false
util.isPrimitive(/^$/)
  // false
util.isPrimitive(new Date())
  // false
```

## util.isRegExp(object)


> Stability: 0 - Deprecated

Returns `true` if the given "object" is a `RegExp`. Otherwise, returns `false`.

```js
const util = require('util');

util.isRegExp(/some regexp/)
  // true
util.isRegExp(new RegExp('another regexp'))
  // true
util.isRegExp({})
  // false
```

## util.isString(object)


> Stability: 0 - Deprecated

Returns `true` if the given "object" is a `String`. Otherwise, returns `false`.

```js
const util = require('util');

util.isString('')
  // true
util.isString('foo')
  // true
util.isString(String('foo'))
  // true
util.isString(5)
  // false
```

### util.isSymbol(object)


> Stability: 0 - Deprecated

Returns `true` if the given "object" is a `Symbol`. Otherwise, returns `false`.

```js
const util = require('util');

util.isSymbol(5)
  // false
util.isSymbol('foo')
  // false
util.isSymbol(Symbol('foo'))
  // true
```

## util.isUndefined(object)


> Stability: 0 - Deprecated

Returns `true` if the given "object" is `undefined`. Otherwise, returns `false`.

```js
const util = require('util');

var foo;
util.isUndefined(5)
  // false
util.isUndefined(foo)
  // true
util.isUndefined(null)
  // false
```

## util.log(string)


Output with timestamp on `stdout`.

    require('util').log('Timestamped message.');

## util.print([...])


> Stability: 0 - Deprecated: Use [`console.log()`][] instead.

Deprecated predecessor of `console.log`.

## util.pump(readableStream, writableStream[, callback])


> Stability: 0 - Deprecated: Use readableStream.pipe(writableStream)

Deprecated predecessor of `stream.pipe()`.

## util.puts([...])


> Stability: 0 - Deprecated: Use [`console.log()`][] instead.

Deprecated predecessor of `console.log`.

[`Array.isArray`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/isArray
[constructor]: https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object/constructor
[Customizing `util.inspect` colors]: #util_customizing_util_inspect_colors
[here]: #util_customizing_util_inspect_colors
[`Error`]: errors.html#errors_class_error
[`console.log()`]: console.html#console_console_log_data
[`console.error()`]: console.html#console_console_error_data
[`Buffer.isBuffer()`]: buffer.html#buffer_class_method_buffer_isbuffer_obj
node-v4.8.2/doc/api/v8.html000644 000766 000024 00000017471 13070706740 015527 0ustar00iojsstaff000000 000000 


  
  V8 | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

      

        
V8#


Stability: 2 - Stable
This module exposes events and interfaces specific to the version of V8
built with Node.js.  These interfaces are subject to change by upstream and are
therefore not covered under the stability index.


getHeapStatistics()#



Added in: v1.0.0

Returns an object with the following properties


{
  total_heap_size: 7326976,
  total_heap_size_executable: 4194304,
  total_physical_size: 7326976,
  total_available_size: 1152656,
  used_heap_size: 3476208,
  heap_size_limit: 1535115264
}



getHeapSpaceStatistics()#


Returns statistics about the V8 heap spaces, i.e. the segments which make up
the V8 heap. Order of heap spaces nor availability of a heap space can be
guaranteed as the statistics are provided via the V8 GetHeapSpaceStatistics
function.


Example result:


[
  {
    "space_name": "new_space",
    "space_size": 2063872,
    "space_used_size": 951112,
    "space_available_size": 80824,
    "physical_space_size": 2063872
  },
  {
    "space_name": "old_space",
    "space_size": 3090560,
    "space_used_size": 2493792,
    "space_available_size": 0,
    "physical_space_size": 3090560
  },
  {
    "space_name": "code_space",
    "space_size": 1260160,
    "space_used_size": 644256,
    "space_available_size": 960,
    "physical_space_size": 1260160
  },
  {
    "space_name": "map_space",
    "space_size": 1094160,
    "space_used_size": 201608,
    "space_available_size": 0,
    "physical_space_size": 1094160
  },
  {
    "space_name": "large_object_space",
    "space_size": 0,
    "space_used_size": 0,
    "space_available_size": 1490980608,
    "physical_space_size": 0
  }
]

setFlagsFromString(string)#



Added in: v1.0.0

Set additional V8 command line flags.  Use with care; changing settings
after the VM has started may result in unpredictable behavior, including
crashes and data loss.  Or it may simply do nothing.


The V8 options available for a version of Node.js may be determined by running
node --v8-options.  An unofficial, community-maintained list of options
and their effects is available here.


Usage:


// Print GC events to stdout for one minute.
const v8 = require('v8');
v8.setFlagsFromString('--trace_gc');
setTimeout(function() { v8.setFlagsFromString('--notrace_gc'); }, 60e3);



      

    

  

  
  
  
  



node-v4.8.2/doc/api/v8.json000644 000766 000024 00000007776 13070706740 015543 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/v8.md",
  "modules": [
    {
      "textRaw": "V8",
      "name": "v8",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
This module exposes events and interfaces specific to the version of V8\nbuilt with Node.js.  These interfaces are subject to change by upstream and are\ntherefore not covered under the stability index.
\n",
      "methods": [
        {
          "textRaw": "getHeapStatistics()",
          "type": "method",
          "name": "getHeapStatistics",
          "meta": {
            "added": [
              "v1.0.0"
            ]
          },
          "desc": "
Returns an object with the following properties
\n
{\n  total_heap_size: 7326976,\n  total_heap_size_executable: 4194304,\n  total_physical_size: 7326976,\n  total_available_size: 1152656,\n  used_heap_size: 3476208,\n  heap_size_limit: 1535115264\n}\n
\n",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "getHeapSpaceStatistics()",
          "type": "method",
          "name": "getHeapSpaceStatistics",
          "desc": "
Returns statistics about the V8 heap spaces, i.e. the segments which make up\nthe V8 heap. Order of heap spaces nor availability of a heap space can be\nguaranteed as the statistics are provided via the V8 GetHeapSpaceStatistics\nfunction.
\n
Example result:
\n
[\n  {\n    "space_name": "new_space",\n    "space_size": 2063872,\n    "space_used_size": 951112,\n    "space_available_size": 80824,\n    "physical_space_size": 2063872\n  },\n  {\n    "space_name": "old_space",\n    "space_size": 3090560,\n    "space_used_size": 2493792,\n    "space_available_size": 0,\n    "physical_space_size": 3090560\n  },\n  {\n    "space_name": "code_space",\n    "space_size": 1260160,\n    "space_used_size": 644256,\n    "space_available_size": 960,\n    "physical_space_size": 1260160\n  },\n  {\n    "space_name": "map_space",\n    "space_size": 1094160,\n    "space_used_size": 201608,\n    "space_available_size": 0,\n    "physical_space_size": 1094160\n  },\n  {\n    "space_name": "large_object_space",\n    "space_size": 0,\n    "space_used_size": 0,\n    "space_available_size": 1490980608,\n    "physical_space_size": 0\n  }\n]\n
",
          "signatures": [
            {
              "params": []
            }
          ]
        },
        {
          "textRaw": "setFlagsFromString(string)",
          "type": "method",
          "name": "setFlagsFromString",
          "meta": {
            "added": [
              "v1.0.0"
            ]
          },
          "desc": "
Set additional V8 command line flags.  Use with care; changing settings\nafter the VM has started may result in unpredictable behavior, including\ncrashes and data loss.  Or it may simply do nothing.
\n
The V8 options available for a version of Node.js may be determined by running\nnode --v8-options.  An unofficial, community-maintained list of options\nand their effects is available here.
\n
Usage:
\n
// Print GC events to stdout for one minute.\nconst v8 = require('v8');\nv8.setFlagsFromString('--trace_gc');\nsetTimeout(function() { v8.setFlagsFromString('--notrace_gc'); }, 60e3);\n
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "string"
                }
              ]
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "V8"
    }
  ]
}
node-v4.8.2/doc/api/v8.md000644 000766 000024 00000004601 13070706735 015156 0ustar00iojsstaff000000 000000 # V8

> Stability: 2 - Stable

This module exposes events and interfaces specific to the version of [V8][]
built with Node.js.  These interfaces are subject to change by upstream and are
therefore not covered under the stability index.

## getHeapStatistics()


Returns an object with the following properties

```js
{
  total_heap_size: 7326976,
  total_heap_size_executable: 4194304,
  total_physical_size: 7326976,
  total_available_size: 1152656,
  used_heap_size: 3476208,
  heap_size_limit: 1535115264
}
```

## getHeapSpaceStatistics()

Returns statistics about the V8 heap spaces, i.e. the segments which make up
the V8 heap. Order of heap spaces nor availability of a heap space can be
guaranteed as the statistics are provided via the V8 `GetHeapSpaceStatistics`
function.

Example result:

```
[
  {
    "space_name": "new_space",
    "space_size": 2063872,
    "space_used_size": 951112,
    "space_available_size": 80824,
    "physical_space_size": 2063872
  },
  {
    "space_name": "old_space",
    "space_size": 3090560,
    "space_used_size": 2493792,
    "space_available_size": 0,
    "physical_space_size": 3090560
  },
  {
    "space_name": "code_space",
    "space_size": 1260160,
    "space_used_size": 644256,
    "space_available_size": 960,
    "physical_space_size": 1260160
  },
  {
    "space_name": "map_space",
    "space_size": 1094160,
    "space_used_size": 201608,
    "space_available_size": 0,
    "physical_space_size": 1094160
  },
  {
    "space_name": "large_object_space",
    "space_size": 0,
    "space_used_size": 0,
    "space_available_size": 1490980608,
    "physical_space_size": 0
  }
]
```

## setFlagsFromString(string)


Set additional V8 command line flags.  Use with care; changing settings
after the VM has started may result in unpredictable behavior, including
crashes and data loss.  Or it may simply do nothing.

The V8 options available for a version of Node.js may be determined by running
`node --v8-options`.  An unofficial, community-maintained list of options
and their effects is available [here][].

Usage:

```js
// Print GC events to stdout for one minute.
const v8 = require('v8');
v8.setFlagsFromString('--trace_gc');
setTimeout(function() { v8.setFlagsFromString('--notrace_gc'); }, 60e3);
```

[V8]: https://developers.google.com/v8/
[here]: https://github.com/thlorenz/v8-flags/blob/master/flags-0.11.md
node-v4.8.2/doc/api/vm.html000644 000766 000024 00000054176 13070706740 015617 0ustar00iojsstaff000000 000000 


  
  VM (Executing JavaScript) | Node.js v4.8.2 Manual & Documentation
  
  
  
  


  

    

    

      

        
Node.js v4.8.2 Documentation

        
        

      


      

      

        
VM (Executing JavaScript)#


Stability: 2 - Stable


You can access this module with:


const vm = require('vm');



JavaScript code can be compiled and run immediately or compiled, saved, and run
later.


Class: Script#



Added in: v0.3.1

A class for holding precompiled scripts, and running them in specific sandboxes.


new vm.Script(code, options)#



Added in: v0.3.1

Creating a new Script compiles code but does not run it. Instead, the
created vm.Script object represents this compiled code. This script can be run
later many times using methods below. The returned script is not bound to any
global object. It is bound before each run, just for that run.


The options when creating a script are:


    

  • filename: allows you to control the filename that shows up in any stack
traces produced from this script.
    • 

  • lineOffset: allows you to add an offset to the line number that is
displayed in stack traces
    • 

  • columnOffset: allows you to add an offset to the column number that is
displayed in stack traces
    • 

  • displayErrors: whether or not to print any errors to stderr, with the
line of code that caused them highlighted, before throwing an exception.
Applies only to syntax errors compiling the code; errors while running the
code are controlled by the options to the script's methods.
    • 

  • timeout: a number of milliseconds to execute code before terminating
execution. If execution is terminated, an Error will be thrown.
    • 



script.runInContext(contextifiedSandbox[, options])#



Added in: v0.3.1

Similar to vm.runInContext() but a method of a precompiled Script
object. script.runInContext() runs script's compiled code in
contextifiedSandbox and returns the result. Running code does not have access
to local scope.


script.runInContext() takes the same options as
script.runInThisContext().


Example: compile code that increments a global variable and sets one, then
execute the code multiple times. These globals are contained in the sandbox.


const util = require('util');
const vm = require('vm');

var sandbox = {
  animal: 'cat',
  count: 2
};

var context = new vm.createContext(sandbox);
var script = new vm.Script('count += 1; name = "kitty"');

for (var i = 0; i < 10; ++i) {
  script.runInContext(context);
}

console.log(util.inspect(sandbox));

// { animal: 'cat', count: 12, name: 'kitty' }



Note that running untrusted code is a tricky business requiring great care.
script.runInContext() is quite useful, but safely running untrusted code
requires a separate process.


script.runInNewContext([sandbox][, options])#



Added in: v0.3.1

Similar to vm.runInNewContext() but a method of a precompiled Script
object. script.runInNewContext() contextifies sandbox if passed or creates a
new contextified sandbox if it's omitted, and then runs script's compiled code
with the sandbox as the global object and returns the result. Running code does
not have access to local scope.


script.runInNewContext() takes the same options as
script.runInThisContext().


Example: compile code that sets a global variable, then execute the code
multiple times in different contexts. These globals are set on and contained in
the sandboxes.


const util = require('util');
const vm = require('vm');

const sandboxes = [{}, {}, {}];

const script = new vm.Script('globalVar = "set"');

sandboxes.forEach((sandbox) => {
  script.runInNewContext(sandbox);
});

console.log(util.inspect(sandboxes));

// [{ globalVar: 'set' }, { globalVar: 'set' }, { globalVar: 'set' }]



Note that running untrusted code is a tricky business requiring great care.
script.runInNewContext() is quite useful, but safely running untrusted code
requires a separate process.


script.runInThisContext([options])#



Added in: v0.3.1

Similar to vm.runInThisContext() but a method of a precompiled Script
object. script.runInThisContext() runs script's compiled code and returns
the result. Running code does not have access to local scope, but does have
access to the current global object.


Example of using script.runInThisContext() to compile code once and run it
multiple times:


const vm = require('vm');

global.globalVar = 0;

const script = new vm.Script('globalVar += 1', { filename: 'myfile.vm' });

for (var i = 0; i < 1000; ++i) {
  script.runInThisContext();
}

console.log(globalVar);

// 1000



The options for running a script are:


    

  • filename: allows you to control the filename that shows up in any stack
traces produced.
    • 

  • lineOffset: allows you to add an offset to the line number that is
displayed in stack traces
    • 

  • columnOffset: allows you to add an offset to the column number that is
displayed in stack traces
    • 

  • displayErrors: whether or not to print any errors to stderr, with the
line of code that caused them highlighted, before throwing an exception.
Applies only to runtime errors executing the code; it is impossible to create
a Script instance with syntax errors, as the constructor will throw.
    • 

  • timeout: a number of milliseconds to execute the script before terminating
execution. If execution is terminated, an Error will be thrown.
    • 



vm.createContext([sandbox])#



Added in: v0.3.1

If given a sandbox object, will "contextify" that sandbox so that it can be
used in calls to vm.runInContext() or script.runInContext(). Inside
scripts run as such, sandbox will be the global object, retaining all its
existing properties but also having the built-in objects and functions any
standard global object has. Outside of scripts run by the vm module,
sandbox will be unchanged.


If not given a sandbox object, returns a new, empty contextified sandbox object
you can use.


This function is useful for creating a sandbox that can be used to run multiple
scripts, e.g. if you were emulating a web browser it could be used to create a
single sandbox representing a window's global object, then run all <script>
tags together inside that sandbox.


vm.isContext(sandbox)#



Added in: v0.11.7

Returns whether or not a sandbox object has been contextified by calling
vm.createContext() on it.


vm.runInContext(code, contextifiedSandbox[, options])#


vm.runInContext() compiles code, then runs it in contextifiedSandbox and
returns the result. Running code does not have access to local scope. The
contextifiedSandbox object must have been previously contextified via
vm.createContext(); it will be used as the global object for code.


vm.runInContext() takes the same options as vm.runInThisContext().


Example: compile and execute different scripts in a single existing context.


const util = require('util');
const vm = require('vm');

const sandbox = { globalVar: 1 };
vm.createContext(sandbox);

for (var i = 0; i < 10; ++i) {
    vm.runInContext('globalVar *= 2;', sandbox);
}
console.log(util.inspect(sandbox));

// { globalVar: 1024 }



Note that running untrusted code is a tricky business requiring great care.
vm.runInContext() is quite useful, but safely running untrusted code requires
a separate process.


vm.runInDebugContext(code)#



Added in: v0.11.14

vm.runInDebugContext() compiles and executes code inside the V8 debug
context. The primary use case is to get access to the V8 debug object:


const vm = require('vm');
const Debug = vm.runInDebugContext('Debug');
console.log(Debug.findScript(process.emit).name);  // 'events.js'
console.log(Debug.findScript(process.exit).name);  // 'internal/process.js'



Note that the debug context and object are intrinsically tied to V8's debugger
implementation and may change (or even get removed) without prior warning.


The debug object can also be exposed with the --expose_debug_as= switch.


vm.runInNewContext(code[, sandbox][, options])#



Added in: v0.3.1

vm.runInNewContext() compiles code, contextifies sandbox if passed or
creates a new contextified sandbox if it's omitted, and then runs the code with
the sandbox as the global object and returns the result.


vm.runInNewContext() takes the same options as vm.runInThisContext().


Example: compile and execute code that increments a global variable and sets a
new one. These globals are contained in the sandbox.


const util = require('util');
const vm = require('vm');

const sandbox = {
  animal: 'cat',
  count: 2
};

vm.runInNewContext('count += 1; name = "kitty"', sandbox);
console.log(util.inspect(sandbox));

// { animal: 'cat', count: 3, name: 'kitty' }



Note that running untrusted code is a tricky business requiring great care.
vm.runInNewContext() is quite useful, but safely running untrusted code requires
a separate process.


vm.runInThisContext(code[, options])#



Added in: v0.3.1

vm.runInThisContext() compiles code, runs it and returns the result. Running
code does not have access to local scope, but does have access to the current
global object.


Example of using vm.runInThisContext() and eval() to run the same code:


const vm = require('vm');
var localVar = 'initial value';

const vmResult = vm.runInThisContext('localVar = "vm";');
console.log('vmResult:', vmResult);
console.log('localVar:', localVar);

const evalResult = eval('localVar = "eval";');
console.log('evalResult:', evalResult);
console.log('localVar:', localVar);

// vmResult: 'vm', localVar: 'initial value'
// evalResult: 'eval', localVar: 'eval'



vm.runInThisContext() does not have access to the local scope, so localVar
is unchanged. eval() does have access to the local scope, so localVar is
changed.


In this way vm.runInThisContext() is much like an indirect eval() call,
e.g. (0,eval)('code'). However, it also has the following additional options:


    

  • filename: allows you to control the filename that shows up in any stack
traces produced.
    • 

  • lineOffset: allows you to add an offset to the line number that is
displayed in stack traces
    • 

  • columnOffset: allows you to add an offset to the column number that is
displayed in stack traces
    • 

  • displayErrors: whether or not to print any errors to stderr, with the
line of code that caused them highlighted, before throwing an exception.
Will capture both syntax errors from compiling code and runtime errors
thrown by executing the compiled code. Defaults to true.
    • 

  • timeout: a number of milliseconds to execute code before terminating
execution. If execution is terminated, an Error will be thrown.
    • 



Example: Run a Server within a VM#


The context of .runInThisContext() refers to the V8 context. The code passed
to this VM context will have it's own isolated scope. To run a simple web server
using the http module, for instance, the code passed to the context must either
call require('http') on its own, or have a reference to the http module passed
to it. For instance:


'use strict';
const vm = require('vm');

let code =
`(function(require) {

   const http = require('http');

   http.createServer( (request, response) => {
     response.writeHead(200, {'Content-Type': 'text/plain'});
     response.end('Hello World\\n');
   }).listen(8124);

   console.log('Server running at http://127.0.0.1:8124/');
 })`;

 vm.runInThisContext(code)(require);



Note: require() in the above case shares the state with context it is passed
from. This might introduce risks when unknown code is executed, e.g. altering
objects from the calling thread's context in unwanted ways. It is advisable to
run vm code in a separate process.


      

    

  

  
  
  
  



node-v4.8.2/doc/api/vm.json000644 000766 000024 00000047706 13070706740 015625 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/vm.md",
  "modules": [
    {
      "textRaw": "VM (Executing JavaScript)",
      "name": "vm",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
You can access this module with:
\n
const vm = require('vm');\n
\n
JavaScript code can be compiled and run immediately or compiled, saved, and run\nlater.
\n",
      "classes": [
        {
          "textRaw": "Class: Script",
          "type": "class",
          "name": "Script",
          "meta": {
            "added": [
              "v0.3.1"
            ]
          },
          "desc": "
A class for holding precompiled scripts, and running them in specific sandboxes.
\n",
          "methods": [
            {
              "textRaw": "new vm.Script(code, options)",
              "type": "method",
              "name": "Script",
              "meta": {
                "added": [
                  "v0.3.1"
                ]
              },
              "desc": "
Creating a new Script compiles code but does not run it. Instead, the\ncreated vm.Script object represents this compiled code. This script can be run\nlater many times using methods below. The returned script is not bound to any\nglobal object. It is bound before each run, just for that run.
\n
The options when creating a script are:
\n
    \n
  • filename: allows you to control the filename that shows up in any stack\ntraces produced from this script.
    • \n
  • lineOffset: allows you to add an offset to the line number that is\ndisplayed in stack traces
    • \n
  • columnOffset: allows you to add an offset to the column number that is\ndisplayed in stack traces
    • \n
  • displayErrors: whether or not to print any errors to stderr, with the\nline of code that caused them highlighted, before throwing an exception.\nApplies only to syntax errors compiling the code; errors while running the\ncode are controlled by the options to the script's methods.
    • \n
  • timeout: a number of milliseconds to execute code before terminating\nexecution. If execution is terminated, an Error will be thrown.
    • \n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "code"
                    },
                    {
                      "name": "options"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "script.runInContext(contextifiedSandbox[, options])",
              "type": "method",
              "name": "runInContext",
              "meta": {
                "added": [
                  "v0.3.1"
                ]
              },
              "desc": "
Similar to vm.runInContext() but a method of a precompiled Script\nobject. script.runInContext() runs script's compiled code in\ncontextifiedSandbox and returns the result. Running code does not have access\nto local scope.
\n
script.runInContext() takes the same options as\nscript.runInThisContext().
\n
Example: compile code that increments a global variable and sets one, then\nexecute the code multiple times. These globals are contained in the sandbox.
\n
const util = require('util');\nconst vm = require('vm');\n\nvar sandbox = {\n  animal: 'cat',\n  count: 2\n};\n\nvar context = new vm.createContext(sandbox);\nvar script = new vm.Script('count += 1; name = "kitty"');\n\nfor (var i = 0; i < 10; ++i) {\n  script.runInContext(context);\n}\n\nconsole.log(util.inspect(sandbox));\n\n// { animal: 'cat', count: 12, name: 'kitty' }\n
\n
Note that running untrusted code is a tricky business requiring great care.\nscript.runInContext() is quite useful, but safely running untrusted code\nrequires a separate process.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "contextifiedSandbox"
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "script.runInNewContext([sandbox][, options])",
              "type": "method",
              "name": "runInNewContext",
              "meta": {
                "added": [
                  "v0.3.1"
                ]
              },
              "desc": "
Similar to vm.runInNewContext() but a method of a precompiled Script\nobject. script.runInNewContext() contextifies sandbox if passed or creates a\nnew contextified sandbox if it's omitted, and then runs script's compiled code\nwith the sandbox as the global object and returns the result. Running code does\nnot have access to local scope.
\n
script.runInNewContext() takes the same options as\nscript.runInThisContext().
\n
Example: compile code that sets a global variable, then execute the code\nmultiple times in different contexts. These globals are set on and contained in\nthe sandboxes.
\n
const util = require('util');\nconst vm = require('vm');\n\nconst sandboxes = [{}, {}, {}];\n\nconst script = new vm.Script('globalVar = "set"');\n\nsandboxes.forEach((sandbox) => {\n  script.runInNewContext(sandbox);\n});\n\nconsole.log(util.inspect(sandboxes));\n\n// [{ globalVar: 'set' }, { globalVar: 'set' }, { globalVar: 'set' }]\n
\n
Note that running untrusted code is a tricky business requiring great care.\nscript.runInNewContext() is quite useful, but safely running untrusted code\nrequires a separate process.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "sandbox",
                      "optional": true
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "script.runInThisContext([options])",
              "type": "method",
              "name": "runInThisContext",
              "meta": {
                "added": [
                  "v0.3.1"
                ]
              },
              "desc": "
Similar to vm.runInThisContext() but a method of a precompiled Script\nobject. script.runInThisContext() runs script's compiled code and returns\nthe result. Running code does not have access to local scope, but does have\naccess to the current global object.
\n
Example of using script.runInThisContext() to compile code once and run it\nmultiple times:
\n
const vm = require('vm');\n\nglobal.globalVar = 0;\n\nconst script = new vm.Script('globalVar += 1', { filename: 'myfile.vm' });\n\nfor (var i = 0; i < 1000; ++i) {\n  script.runInThisContext();\n}\n\nconsole.log(globalVar);\n\n// 1000\n
\n
The options for running a script are:
\n
    \n
  • filename: allows you to control the filename that shows up in any stack\ntraces produced.
    • \n
  • lineOffset: allows you to add an offset to the line number that is\ndisplayed in stack traces
    • \n
  • columnOffset: allows you to add an offset to the column number that is\ndisplayed in stack traces
    • \n
  • displayErrors: whether or not to print any errors to stderr, with the\nline of code that caused them highlighted, before throwing an exception.\nApplies only to runtime errors executing the code; it is impossible to create\na Script instance with syntax errors, as the constructor will throw.
    • \n
  • timeout: a number of milliseconds to execute the script before terminating\nexecution. If execution is terminated, an Error will be thrown.
    • \n
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "methods": [
        {
          "textRaw": "vm.createContext([sandbox])",
          "type": "method",
          "name": "createContext",
          "meta": {
            "added": [
              "v0.3.1"
            ]
          },
          "desc": "
If given a sandbox object, will "contextify" that sandbox so that it can be\nused in calls to vm.runInContext() or script.runInContext(). Inside\nscripts run as such, sandbox will be the global object, retaining all its\nexisting properties but also having the built-in objects and functions any\nstandard global object has. Outside of scripts run by the vm module,\nsandbox will be unchanged.
\n
If not given a sandbox object, returns a new, empty contextified sandbox object\nyou can use.
\n
This function is useful for creating a sandbox that can be used to run multiple\nscripts, e.g. if you were emulating a web browser it could be used to create a\nsingle sandbox representing a window's global object, then run all <script>\ntags together inside that sandbox.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "sandbox",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "vm.isContext(sandbox)",
          "type": "method",
          "name": "isContext",
          "meta": {
            "added": [
              "v0.11.7"
            ]
          },
          "desc": "
Returns whether or not a sandbox object has been contextified by calling\nvm.createContext() on it.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "sandbox"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "vm.runInContext(code, contextifiedSandbox[, options])",
          "type": "method",
          "name": "runInContext",
          "desc": "
vm.runInContext() compiles code, then runs it in contextifiedSandbox and\nreturns the result. Running code does not have access to local scope. The\ncontextifiedSandbox object must have been previously contextified via\nvm.createContext(); it will be used as the global object for code.
\n
vm.runInContext() takes the same options as vm.runInThisContext().
\n
Example: compile and execute different scripts in a single existing context.
\n
const util = require('util');\nconst vm = require('vm');\n\nconst sandbox = { globalVar: 1 };\nvm.createContext(sandbox);\n\nfor (var i = 0; i < 10; ++i) {\n    vm.runInContext('globalVar *= 2;', sandbox);\n}\nconsole.log(util.inspect(sandbox));\n\n// { globalVar: 1024 }\n
\n
Note that running untrusted code is a tricky business requiring great care.\nvm.runInContext() is quite useful, but safely running untrusted code requires\na separate process.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "code"
                },
                {
                  "name": "contextifiedSandbox"
                },
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "vm.runInDebugContext(code)",
          "type": "method",
          "name": "runInDebugContext",
          "meta": {
            "added": [
              "v0.11.14"
            ]
          },
          "desc": "
vm.runInDebugContext() compiles and executes code inside the V8 debug\ncontext. The primary use case is to get access to the V8 debug object:
\n
const vm = require('vm');\nconst Debug = vm.runInDebugContext('Debug');\nconsole.log(Debug.findScript(process.emit).name);  // 'events.js'\nconsole.log(Debug.findScript(process.exit).name);  // 'internal/process.js'\n
\n
Note that the debug context and object are intrinsically tied to V8's debugger\nimplementation and may change (or even get removed) without prior warning.
\n
The debug object can also be exposed with the --expose_debug_as= switch.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "code"
                }
              ]
            }
          ]
        },
        {
          "textRaw": "vm.runInNewContext(code[, sandbox][, options])",
          "type": "method",
          "name": "runInNewContext",
          "meta": {
            "added": [
              "v0.3.1"
            ]
          },
          "desc": "
vm.runInNewContext() compiles code, contextifies sandbox if passed or\ncreates a new contextified sandbox if it's omitted, and then runs the code with\nthe sandbox as the global object and returns the result.
\n
vm.runInNewContext() takes the same options as vm.runInThisContext().
\n
Example: compile and execute code that increments a global variable and sets a\nnew one. These globals are contained in the sandbox.
\n
const util = require('util');\nconst vm = require('vm');\n\nconst sandbox = {\n  animal: 'cat',\n  count: 2\n};\n\nvm.runInNewContext('count += 1; name = "kitty"', sandbox);\nconsole.log(util.inspect(sandbox));\n\n// { animal: 'cat', count: 3, name: 'kitty' }\n
\n
Note that running untrusted code is a tricky business requiring great care.\nvm.runInNewContext() is quite useful, but safely running untrusted code requires\na separate process.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "code"
                },
                {
                  "name": "sandbox",
                  "optional": true
                },
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "vm.runInThisContext(code[, options])",
          "type": "method",
          "name": "runInThisContext",
          "meta": {
            "added": [
              "v0.3.1"
            ]
          },
          "desc": "
vm.runInThisContext() compiles code, runs it and returns the result. Running\ncode does not have access to local scope, but does have access to the current\nglobal object.
\n
Example of using vm.runInThisContext() and eval() to run the same code:
\n
const vm = require('vm');\nvar localVar = 'initial value';\n\nconst vmResult = vm.runInThisContext('localVar = "vm";');\nconsole.log('vmResult:', vmResult);\nconsole.log('localVar:', localVar);\n\nconst evalResult = eval('localVar = "eval";');\nconsole.log('evalResult:', evalResult);\nconsole.log('localVar:', localVar);\n\n// vmResult: 'vm', localVar: 'initial value'\n// evalResult: 'eval', localVar: 'eval'\n
\n
vm.runInThisContext() does not have access to the local scope, so localVar\nis unchanged. eval() does have access to the local scope, so localVar is\nchanged.
\n
In this way vm.runInThisContext() is much like an indirect eval() call,\ne.g. (0,eval)('code'). However, it also has the following additional options:
\n
    \n
  • filename: allows you to control the filename that shows up in any stack\ntraces produced.
    • \n
  • lineOffset: allows you to add an offset to the line number that is\ndisplayed in stack traces
    • \n
  • columnOffset: allows you to add an offset to the column number that is\ndisplayed in stack traces
    • \n
  • displayErrors: whether or not to print any errors to stderr, with the\nline of code that caused them highlighted, before throwing an exception.\nWill capture both syntax errors from compiling code and runtime errors\nthrown by executing the compiled code. Defaults to true.
    • \n
  • timeout: a number of milliseconds to execute code before terminating\nexecution. If execution is terminated, an Error will be thrown.
    • \n
\n
Example: Run a Server within a VM
\n
The context of .runInThisContext() refers to the V8 context. The code passed\nto this VM context will have it's own isolated scope. To run a simple web server\nusing the http module, for instance, the code passed to the context must either\ncall require('http') on its own, or have a reference to the http module passed\nto it. For instance:
\n
'use strict';\nconst vm = require('vm');\n\nlet code =\n`(function(require) {\n\n   const http = require('http');\n\n   http.createServer( (request, response) => {\n     response.writeHead(200, {'Content-Type': 'text/plain'});\n     response.end('Hello World\\\\n');\n   }).listen(8124);\n\n   console.log('Server running at http://127.0.0.1:8124/');\n })`;\n\n vm.runInThisContext(code)(require);\n
\n
Note: require() in the above case shares the state with context it is passed\nfrom. This might introduce risks when unknown code is executed, e.g. altering\nobjects from the calling thread's context in unwanted ways. It is advisable to\nrun vm code in a separate process.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "code"
                },
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "vm"
    }
  ]
}
node-v4.8.2/doc/api/vm.md000644 000766 000024 00000030100 13070706735 015234 0ustar00iojsstaff000000 000000 # VM (Executing JavaScript)

> Stability: 2 - Stable



You can access this module with:

```js
const vm = require('vm');
```

JavaScript code can be compiled and run immediately or compiled, saved, and run
later.

## Class: Script


A class for holding precompiled scripts, and running them in specific sandboxes.

### new vm.Script(code, options)


Creating a new `Script` compiles `code` but does not run it. Instead, the
created `vm.Script` object represents this compiled code. This script can be run
later many times using methods below. The returned script is not bound to any
global object. It is bound before each run, just for that run.

The options when creating a script are:

- `filename`: allows you to control the filename that shows up in any stack
  traces produced from this script.
- `lineOffset`: allows you to add an offset to the line number that is
  displayed in stack traces
- `columnOffset`: allows you to add an offset to the column number that is
  displayed in stack traces
- `displayErrors`: whether or not to print any errors to stderr, with the
  line of code that caused them highlighted, before throwing an exception.
  Applies only to syntax errors compiling the code; errors while running the
  code are controlled by the options to the script's methods.
- `timeout`: a number of milliseconds to execute `code` before terminating
  execution. If execution is terminated, an [`Error`][] will be thrown.

### script.runInContext(contextifiedSandbox[, options])


Similar to [`vm.runInContext()`][] but a method of a precompiled `Script`
object. `script.runInContext()` runs `script`'s compiled code in
`contextifiedSandbox` and returns the result. Running code does not have access
to local scope.

`script.runInContext()` takes the same options as
[`script.runInThisContext()`][].

Example: compile code that increments a global variable and sets one, then
execute the code multiple times. These globals are contained in the sandbox.

```js
const util = require('util');
const vm = require('vm');

var sandbox = {
  animal: 'cat',
  count: 2
};

var context = new vm.createContext(sandbox);
var script = new vm.Script('count += 1; name = "kitty"');

for (var i = 0; i < 10; ++i) {
  script.runInContext(context);
}

console.log(util.inspect(sandbox));

// { animal: 'cat', count: 12, name: 'kitty' }
```

Note that running untrusted code is a tricky business requiring great care.
`script.runInContext()` is quite useful, but safely running untrusted code
requires a separate process.

### script.runInNewContext([sandbox][, options])


Similar to [`vm.runInNewContext()`][] but a method of a precompiled `Script`
object. `script.runInNewContext()` contextifies `sandbox` if passed or creates a
new contextified sandbox if it's omitted, and then runs `script`'s compiled code
with the sandbox as the global object and returns the result. Running code does
not have access to local scope.

`script.runInNewContext()` takes the same options as
[`script.runInThisContext()`][].

Example: compile code that sets a global variable, then execute the code
multiple times in different contexts. These globals are set on and contained in
the sandboxes.

```js
const util = require('util');
const vm = require('vm');

const sandboxes = [{}, {}, {}];

const script = new vm.Script('globalVar = "set"');

sandboxes.forEach((sandbox) => {
  script.runInNewContext(sandbox);
});

console.log(util.inspect(sandboxes));

// [{ globalVar: 'set' }, { globalVar: 'set' }, { globalVar: 'set' }]
```

Note that running untrusted code is a tricky business requiring great care.
`script.runInNewContext()` is quite useful, but safely running untrusted code
requires a separate process.

### script.runInThisContext([options])


Similar to [`vm.runInThisContext()`]() but a method of a precompiled `Script`
object. `script.runInThisContext()` runs `script`'s compiled code and returns
the result. Running code does not have access to local scope, but does have
access to the current `global` object.

Example of using `script.runInThisContext()` to compile code once and run it
multiple times:

```js
const vm = require('vm');

global.globalVar = 0;

const script = new vm.Script('globalVar += 1', { filename: 'myfile.vm' });

for (var i = 0; i < 1000; ++i) {
  script.runInThisContext();
}

console.log(globalVar);

// 1000
```

The options for running a script are:

- `filename`: allows you to control the filename that shows up in any stack
  traces produced.
- `lineOffset`: allows you to add an offset to the line number that is
  displayed in stack traces
- `columnOffset`: allows you to add an offset to the column number that is
  displayed in stack traces
- `displayErrors`: whether or not to print any errors to stderr, with the
  line of code that caused them highlighted, before throwing an exception.
  Applies only to runtime errors executing the code; it is impossible to create
  a `Script` instance with syntax errors, as the constructor will throw.
- `timeout`: a number of milliseconds to execute the script before terminating
  execution. If execution is terminated, an [`Error`][] will be thrown.

## vm.createContext([sandbox])


If given a `sandbox` object, will "contextify" that sandbox so that it can be
used in calls to [`vm.runInContext()`][] or [`script.runInContext()`][]. Inside
scripts run as such, `sandbox` will be the global object, retaining all its
existing properties but also having the built-in objects and functions any
standard [global object][] has. Outside of scripts run by the vm module,
`sandbox` will be unchanged.

If not given a sandbox object, returns a new, empty contextified sandbox object
you can use.

This function is useful for creating a sandbox that can be used to run multiple
scripts, e.g. if you were emulating a web browser it could be used to create a
single sandbox representing a window's global object, then run all `
  
  
  



node-v4.8.2/doc/api/zlib.json000644 000766 000024 00000101227 13070706740 016130 0ustar00iojsstaff000000 000000 {
  "source": "doc/api/zlib.md",
  "modules": [
    {
      "textRaw": "Zlib",
      "name": "zlib",
      "stability": 2,
      "stabilityText": "Stable",
      "desc": "
You can access this module with:
\n
const zlib = require('zlib');\n
This provides bindings to Gzip/Gunzip, Deflate/Inflate, and\nDeflateRaw/InflateRaw classes.  Each class takes the same options, and\nis a readable/writable Stream.
\n
Examples
\n
Compressing or decompressing a file can be done by piping an\nfs.ReadStream into a zlib stream, then into an fs.WriteStream.
\n
const gzip = zlib.createGzip();\nconst fs = require('fs');\nconst inp = fs.createReadStream('input.txt');\nconst out = fs.createWriteStream('input.txt.gz');\n\ninp.pipe(gzip).pipe(out);\n
\n
Compressing or decompressing data in one step can be done by using\nthe convenience methods.
\n
const input = '.................................';\nzlib.deflate(input, (err, buffer) => {\n  if (!err) {\n    console.log(buffer.toString('base64'));\n  } else {\n    // handle error\n  }\n});\n\nconst buffer = new Buffer('eJzT0yMAAGTvBe8=', 'base64');\nzlib.unzip(buffer, (err, buffer) => {\n  if (!err) {\n    console.log(buffer.toString());\n  } else {\n    // handle error\n  }\n});\n
\n
To use this module in an HTTP client or server, use the accept-encoding\non requests, and the content-encoding header on responses.
\n
Note: these examples are drastically simplified to show\nthe basic concept.  Zlib encoding can be expensive, and the results\nought to be cached.  See Memory Usage Tuning for more information\non the speed/memory/compression tradeoffs involved in zlib usage.
\n
// client request example\nconst zlib = require('zlib');\nconst http = require('http');\nconst fs = require('fs');\nconst request = http.get({ host: 'izs.me',\n                         path: '/',\n                         port: 80,\n                         headers: { 'accept-encoding': 'gzip,deflate' } });\nrequest.on('response', (response) => {\n  var output = fs.createWriteStream('izs.me_index.html');\n\n  switch (response.headers['content-encoding']) {\n    // or, just use zlib.createUnzip() to handle both cases\n    case 'gzip':\n      response.pipe(zlib.createGunzip()).pipe(output);\n      break;\n    case 'deflate':\n      response.pipe(zlib.createInflate()).pipe(output);\n      break;\n    default:\n      response.pipe(output);\n      break;\n  }\n});\n\n// server example\n// Running a gzip operation on every request is quite expensive.\n// It would be much more efficient to cache the compressed buffer.\nconst zlib = require('zlib');\nconst http = require('http');\nconst fs = require('fs');\nhttp.createServer((request, response) => {\n  var raw = fs.createReadStream('index.html');\n  var acceptEncoding = request.headers['accept-encoding'];\n  if (!acceptEncoding) {\n    acceptEncoding = '';\n  }\n\n  // Note: this is not a conformant accept-encoding parser.\n  // See http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.3\n  if (acceptEncoding.match(/\\bdeflate\\b/)) {\n    response.writeHead(200, { 'content-encoding': 'deflate' });\n    raw.pipe(zlib.createDeflate()).pipe(response);\n  } else if (acceptEncoding.match(/\\bgzip\\b/)) {\n    response.writeHead(200, { 'content-encoding': 'gzip' });\n    raw.pipe(zlib.createGzip()).pipe(response);\n  } else {\n    response.writeHead(200, {});\n    raw.pipe(response);\n  }\n}).listen(1337);\n
\n",
      "miscs": [
        {
          "textRaw": "Memory Usage Tuning",
          "name": "Memory Usage Tuning",
          "type": "misc",
          "desc": "
From zlib/zconf.h, modified to node.js's usage:
\n
The memory requirements for deflate are (in bytes):
\n
(1 << (windowBits+2)) +  (1 << (memLevel+9))\n
that is: 128K for windowBits=15  +  128K for memLevel = 8\n(default values) plus a few kilobytes for small objects.
\n
For example, if you want to reduce\nthe default memory requirements from 256K to 128K, set the options to:
\n
{ windowBits: 14, memLevel: 7 }\n
Of course this will generally degrade compression (there's no free lunch).
\n
The memory requirements for inflate are (in bytes)
\n
1 << windowBits\n
that is, 32K for windowBits=15 (default value) plus a few kilobytes\nfor small objects.
\n
This is in addition to a single internal output slab buffer of size\nchunkSize, which defaults to 16K.
\n
The speed of zlib compression is affected most dramatically by the\nlevel setting.  A higher level will result in better compression, but\nwill take longer to complete.  A lower level will result in less\ncompression, but will be much faster.
\n
In general, greater memory usage options will mean that node.js has to make\nfewer calls to zlib, since it'll be able to process more data in a\nsingle write operation.  So, this is another factor that affects the\nspeed, at the cost of memory usage.
\n"
        },
        {
          "textRaw": "Constants",
          "name": "Constants",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "type": "misc",
          "desc": "
All of the constants defined in zlib.h are also defined on\nrequire('zlib').\nIn the normal course of operations, you will not need to ever set any of\nthese.  They are documented here so that their presence is not\nsurprising.  This section is taken almost directly from the\nzlib documentation.  See http://zlib.net/manual.html#Constants for more\ndetails.
\n
Allowed flush values.
\n
    \n
  • zlib.Z_NO_FLUSH
    • \n
  • zlib.Z_PARTIAL_FLUSH
    • \n
  • zlib.Z_SYNC_FLUSH
    • \n
  • zlib.Z_FULL_FLUSH
    • \n
  • zlib.Z_FINISH
    • \n
  • zlib.Z_BLOCK
    • \n
  • zlib.Z_TREES
    • \n
\n
Return codes for the compression/decompression functions. Negative\nvalues are errors, positive values are used for special but normal\nevents.
\n
    \n
  • zlib.Z_OK
    • \n
  • zlib.Z_STREAM_END
    • \n
  • zlib.Z_NEED_DICT
    • \n
  • zlib.Z_ERRNO
    • \n
  • zlib.Z_STREAM_ERROR
    • \n
  • zlib.Z_DATA_ERROR
    • \n
  • zlib.Z_MEM_ERROR
    • \n
  • zlib.Z_BUF_ERROR
    • \n
  • zlib.Z_VERSION_ERROR
    • \n
\n
Compression levels.
\n
    \n
  • zlib.Z_NO_COMPRESSION
    • \n
  • zlib.Z_BEST_SPEED
    • \n
  • zlib.Z_BEST_COMPRESSION
    • \n
  • zlib.Z_DEFAULT_COMPRESSION
    • \n
\n
Compression strategy.
\n
    \n
  • zlib.Z_FILTERED
    • \n
  • zlib.Z_HUFFMAN_ONLY
    • \n
  • zlib.Z_RLE
    • \n
  • zlib.Z_FIXED
    • \n
  • zlib.Z_DEFAULT_STRATEGY
    • \n
\n
The deflate compression method (the only one supported in this version).
\n
    \n
  • zlib.Z_DEFLATED
    • \n
\n
For initializing zalloc, zfree, opaque.
\n
    \n
  • zlib.Z_NULL
    • \n
\n"
        },
        {
          "textRaw": "Class Options",
          "name": "Class Options",
          "meta": {
            "added": [
              "v0.11.1"
            ]
          },
          "type": "misc",
          "desc": "
Each class takes an options object.  All options are optional.
\n
Note that some options are only relevant when compressing, and are\nignored by the decompression classes.
\n
    \n
  • flush (default: zlib.Z_NO_FLUSH)
    • \n
  • chunkSize (default: 16*1024)
    • \n
  • windowBits
    • \n
  • level (compression only)
    • \n
  • memLevel (compression only)
    • \n
  • strategy (compression only)
    • \n
  • dictionary (deflate/inflate only, empty dictionary by default)
    • \n
\n
See the description of deflateInit2 and inflateInit2 at\nhttp://zlib.net/manual.html#Advanced for more information on these.
\n"
        },
        {
          "textRaw": "Convenience Methods",
          "name": "Convenience Methods",
          "type": "misc",
          "desc": "
All of these take a Buffer or string as the first argument, an optional second\nargument to supply options to the zlib classes and will call the supplied\ncallback with callback(error, result).
\n
Every method has a *Sync counterpart, which accept the same arguments, but\nwithout a callback.
\n",
          "methods": [
            {
              "textRaw": "zlib.deflate(buf[, options], callback)",
              "type": "method",
              "name": "deflate",
              "meta": {
                "added": [
                  "v0.6.0"
                ]
              },
              "desc": "
Compress a Buffer or string with Deflate.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    },
                    {
                      "name": "callback"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "zlib.deflateSync(buf[, options])",
              "type": "method",
              "name": "deflateSync",
              "meta": {
                "added": [
                  "v0.11.12"
                ]
              },
              "desc": "
Compress a Buffer or string with Deflate.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "zlib.deflateRaw(buf[, options], callback)",
              "type": "method",
              "name": "deflateRaw",
              "meta": {
                "added": [
                  "v0.6.0"
                ]
              },
              "desc": "
Compress a Buffer or string with DeflateRaw.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    },
                    {
                      "name": "callback"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "zlib.deflateRawSync(buf[, options])",
              "type": "method",
              "name": "deflateRawSync",
              "meta": {
                "added": [
                  "v0.11.12"
                ]
              },
              "desc": "
Compress a Buffer or string with DeflateRaw.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "zlib.gunzip(buf[, options], callback)",
              "type": "method",
              "name": "gunzip",
              "meta": {
                "added": [
                  "v0.6.0"
                ]
              },
              "desc": "
Decompress a Buffer or string with Gunzip.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    },
                    {
                      "name": "callback"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "zlib.gunzipSync(buf[, options])",
              "type": "method",
              "name": "gunzipSync",
              "meta": {
                "added": [
                  "v0.11.12"
                ]
              },
              "desc": "
Decompress a Buffer or string with Gunzip.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "zlib.gzip(buf[, options], callback)",
              "type": "method",
              "name": "gzip",
              "meta": {
                "added": [
                  "v0.6.0"
                ]
              },
              "desc": "
Compress a Buffer or string with Gzip.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    },
                    {
                      "name": "callback"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "zlib.gzipSync(buf[, options])",
              "type": "method",
              "name": "gzipSync",
              "meta": {
                "added": [
                  "v0.11.12"
                ]
              },
              "desc": "
Compress a Buffer or string with Gzip.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "zlib.inflate(buf[, options], callback)",
              "type": "method",
              "name": "inflate",
              "meta": {
                "added": [
                  "v0.6.0"
                ]
              },
              "desc": "
Decompress a Buffer or string with Inflate.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    },
                    {
                      "name": "callback"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "zlib.inflateSync(buf[, options])",
              "type": "method",
              "name": "inflateSync",
              "meta": {
                "added": [
                  "v0.11.12"
                ]
              },
              "desc": "
Decompress a Buffer or string with Inflate.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "zlib.inflateRaw(buf[, options], callback)",
              "type": "method",
              "name": "inflateRaw",
              "meta": {
                "added": [
                  "v0.6.0"
                ]
              },
              "desc": "
Decompress a Buffer or string with InflateRaw.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    },
                    {
                      "name": "callback"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "zlib.inflateRawSync(buf[, options])",
              "type": "method",
              "name": "inflateRawSync",
              "meta": {
                "added": [
                  "v0.11.12"
                ]
              },
              "desc": "
Decompress a Buffer or string with InflateRaw.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "zlib.unzip(buf[, options], callback)",
              "type": "method",
              "name": "unzip",
              "meta": {
                "added": [
                  "v0.6.0"
                ]
              },
              "desc": "
Decompress a Buffer or string with Unzip.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                },
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    },
                    {
                      "name": "callback"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "zlib.unzipSync(buf[, options])",
              "type": "method",
              "name": "unzipSync",
              "meta": {
                "added": [
                  "v0.11.12"
                ]
              },
              "desc": "
Decompress a Buffer or string with Unzip.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "buf"
                    },
                    {
                      "name": "options",
                      "optional": true
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "modules": [
        {
          "textRaw": "Flushing",
          "name": "flushing",
          "desc": "
Calling .flush() on a compression stream will make zlib return as much\noutput as currently possible. This may come at the cost of degraded compression\nquality, but can be useful when data needs to be available as soon as possible.
\n
In the following example, flush() is used to write a compressed partial\nHTTP response to the client:
\n
const zlib = require('zlib');\nconst http = require('http');\n\nhttp.createServer((request, response) => {\n  // For the sake of simplicity, the Accept-Encoding checks are omitted.\n  response.writeHead(200, { 'content-encoding': 'gzip' });\n  const output = zlib.createGzip();\n  output.pipe(response);\n\n  setInterval(() => {\n    output.write(`The current time is ${Date()}\\n`, () => {\n      // The data has been passed to zlib, but the compression algorithm may\n      // have decided to buffer the data for more efficient compression.\n      // Calling .flush() will make the data available as soon as the client\n      // is ready to receive it.\n      output.flush();\n    });\n  }, 1000);\n}).listen(1337);\n
\n",
          "type": "module",
          "displayName": "Flushing"
        }
      ],
      "meta": {
        "added": [
          "v0.5.8"
        ]
      },
      "classes": [
        {
          "textRaw": "Class: zlib.Deflate",
          "type": "class",
          "name": "zlib.Deflate",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
Compress data using deflate.
\n"
        },
        {
          "textRaw": "Class: zlib.DeflateRaw",
          "type": "class",
          "name": "zlib.DeflateRaw",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
Compress data using deflate, and do not append a zlib header.
\n"
        },
        {
          "textRaw": "Class: zlib.Gunzip",
          "type": "class",
          "name": "zlib.Gunzip",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
Decompress a gzip stream.
\n"
        },
        {
          "textRaw": "Class: zlib.Gzip",
          "type": "class",
          "name": "zlib.Gzip",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
Compress data using gzip.
\n"
        },
        {
          "textRaw": "Class: zlib.Inflate",
          "type": "class",
          "name": "zlib.Inflate",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
Decompress a deflate stream.
\n"
        },
        {
          "textRaw": "Class: zlib.InflateRaw",
          "type": "class",
          "name": "zlib.InflateRaw",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
Decompress a raw deflate stream.
\n"
        },
        {
          "textRaw": "Class: zlib.Unzip",
          "type": "class",
          "name": "zlib.Unzip",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
Decompress either a Gzip- or Deflate-compressed stream by auto-detecting\nthe header.
\n"
        },
        {
          "textRaw": "Class: zlib.Zlib",
          "type": "class",
          "name": "zlib.Zlib",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
Not exported by the zlib module. It is documented here because it is the base\nclass of the compressor/decompressor classes.
\n",
          "methods": [
            {
              "textRaw": "zlib.flush([kind], callback)",
              "type": "method",
              "name": "flush",
              "meta": {
                "added": [
                  "v0.5.8"
                ]
              },
              "desc": "
kind defaults to zlib.Z_FULL_FLUSH.
\n
Flush pending data. Don't call this frivolously, premature flushes negatively\nimpact the effectiveness of the compression algorithm.
\n
Calling this only flushes data from the internal zlib state, and does not\nperform flushing of any kind on the streams level. Rather, it behaves like a\nnormal call to .write(), i.e. it will be queued up behind other pending\nwrites and will only produce output when data is being read from the stream.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "kind",
                      "optional": true
                    },
                    {
                      "name": "callback"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "zlib.params(level, strategy, callback)",
              "type": "method",
              "name": "params",
              "meta": {
                "added": [
                  "v0.11.4"
                ]
              },
              "desc": "
Dynamically update the compression level and compression strategy.\nOnly applicable to deflate algorithm.
\n",
              "signatures": [
                {
                  "params": [
                    {
                      "name": "level"
                    },
                    {
                      "name": "strategy"
                    },
                    {
                      "name": "callback"
                    }
                  ]
                }
              ]
            },
            {
              "textRaw": "zlib.reset()",
              "type": "method",
              "name": "reset",
              "meta": {
                "added": [
                  "v0.7.0"
                ]
              },
              "desc": "
Reset the compressor/decompressor to factory defaults. Only applicable to\nthe inflate and deflate algorithms.
\n",
              "signatures": [
                {
                  "params": []
                }
              ]
            }
          ]
        }
      ],
      "methods": [
        {
          "textRaw": "zlib.createDeflate([options])",
          "type": "method",
          "name": "createDeflate",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
Returns a new Deflate object with an options.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "zlib.createDeflateRaw([options])",
          "type": "method",
          "name": "createDeflateRaw",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
Returns a new DeflateRaw object with an options.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "zlib.createGunzip([options])",
          "type": "method",
          "name": "createGunzip",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
Returns a new Gunzip object with an options.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "zlib.createGzip([options])",
          "type": "method",
          "name": "createGzip",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
Returns a new Gzip object with an options.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "zlib.createInflate([options])",
          "type": "method",
          "name": "createInflate",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
Returns a new Inflate object with an options.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "zlib.createInflateRaw([options])",
          "type": "method",
          "name": "createInflateRaw",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
Returns a new InflateRaw object with an options.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        },
        {
          "textRaw": "zlib.createUnzip([options])",
          "type": "method",
          "name": "createUnzip",
          "meta": {
            "added": [
              "v0.5.8"
            ]
          },
          "desc": "
Returns a new Unzip object with an options.
\n",
          "signatures": [
            {
              "params": [
                {
                  "name": "options",
                  "optional": true
                }
              ]
            }
          ]
        }
      ],
      "type": "module",
      "displayName": "Zlib"
    }
  ]
}
node-v4.8.2/doc/api/zlib.md000644 000766 000024 00000030072 13070706735 015562 0ustar00iojsstaff000000 000000 # Zlib

> Stability: 2 - Stable

You can access this module with:

    const zlib = require('zlib');

This provides bindings to Gzip/Gunzip, Deflate/Inflate, and
DeflateRaw/InflateRaw classes.  Each class takes the same options, and
is a readable/writable Stream.

## Examples

Compressing or decompressing a file can be done by piping an
fs.ReadStream into a zlib stream, then into an fs.WriteStream.

```js
const gzip = zlib.createGzip();
const fs = require('fs');
const inp = fs.createReadStream('input.txt');
const out = fs.createWriteStream('input.txt.gz');

inp.pipe(gzip).pipe(out);
```

Compressing or decompressing data in one step can be done by using
the convenience methods.

```js
const input = '.................................';
zlib.deflate(input, (err, buffer) => {
  if (!err) {
    console.log(buffer.toString('base64'));
  } else {
    // handle error
  }
});

const buffer = new Buffer('eJzT0yMAAGTvBe8=', 'base64');
zlib.unzip(buffer, (err, buffer) => {
  if (!err) {
    console.log(buffer.toString());
  } else {
    // handle error
  }
});
```

To use this module in an HTTP client or server, use the [accept-encoding][]
on requests, and the [content-encoding][] header on responses.

**Note: these examples are drastically simplified to show
the basic concept.**  Zlib encoding can be expensive, and the results
ought to be cached.  See [Memory Usage Tuning][] for more information
on the speed/memory/compression tradeoffs involved in zlib usage.

```js
// client request example
const zlib = require('zlib');
const http = require('http');
const fs = require('fs');
const request = http.get({ host: 'izs.me',
                         path: '/',
                         port: 80,
                         headers: { 'accept-encoding': 'gzip,deflate' } });
request.on('response', (response) => {
  var output = fs.createWriteStream('izs.me_index.html');

  switch (response.headers['content-encoding']) {
    // or, just use zlib.createUnzip() to handle both cases
    case 'gzip':
      response.pipe(zlib.createGunzip()).pipe(output);
      break;
    case 'deflate':
      response.pipe(zlib.createInflate()).pipe(output);
      break;
    default:
      response.pipe(output);
      break;
  }
});

// server example
// Running a gzip operation on every request is quite expensive.
// It would be much more efficient to cache the compressed buffer.
const zlib = require('zlib');
const http = require('http');
const fs = require('fs');
http.createServer((request, response) => {
  var raw = fs.createReadStream('index.html');
  var acceptEncoding = request.headers['accept-encoding'];
  if (!acceptEncoding) {
    acceptEncoding = '';
  }

  // Note: this is not a conformant accept-encoding parser.
  // See http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.3
  if (acceptEncoding.match(/\bdeflate\b/)) {
    response.writeHead(200, { 'content-encoding': 'deflate' });
    raw.pipe(zlib.createDeflate()).pipe(response);
  } else if (acceptEncoding.match(/\bgzip\b/)) {
    response.writeHead(200, { 'content-encoding': 'gzip' });
    raw.pipe(zlib.createGzip()).pipe(response);
  } else {
    response.writeHead(200, {});
    raw.pipe(response);
  }
}).listen(1337);
```

## Memory Usage Tuning



From `zlib/zconf.h`, modified to node.js's usage:

The memory requirements for deflate are (in bytes):

```
(1 << (windowBits+2)) +  (1 << (memLevel+9))
```

that is: 128K for windowBits=15  +  128K for memLevel = 8
(default values) plus a few kilobytes for small objects.

For example, if you want to reduce
the default memory requirements from 256K to 128K, set the options to:

```
{ windowBits: 14, memLevel: 7 }
```

Of course this will generally degrade compression (there's no free lunch).

The memory requirements for inflate are (in bytes)

```
1 << windowBits
```

that is, 32K for windowBits=15 (default value) plus a few kilobytes
for small objects.

This is in addition to a single internal output slab buffer of size
`chunkSize`, which defaults to 16K.

The speed of zlib compression is affected most dramatically by the
`level` setting.  A higher level will result in better compression, but
will take longer to complete.  A lower level will result in less
compression, but will be much faster.

In general, greater memory usage options will mean that node.js has to make
fewer calls to zlib, since it'll be able to process more data in a
single `write` operation.  So, this is another factor that affects the
speed, at the cost of memory usage.

## Flushing

Calling [`.flush()`][] on a compression stream will make zlib return as much
output as currently possible. This may come at the cost of degraded compression
quality, but can be useful when data needs to be available as soon as possible.

In the following example, `flush()` is used to write a compressed partial
HTTP response to the client:
```js
const zlib = require('zlib');
const http = require('http');

http.createServer((request, response) => {
  // For the sake of simplicity, the Accept-Encoding checks are omitted.
  response.writeHead(200, { 'content-encoding': 'gzip' });
  const output = zlib.createGzip();
  output.pipe(response);

  setInterval(() => {
    output.write(`The current time is ${Date()}\n`, () => {
      // The data has been passed to zlib, but the compression algorithm may
      // have decided to buffer the data for more efficient compression.
      // Calling .flush() will make the data available as soon as the client
      // is ready to receive it.
      output.flush();
    });
  }, 1000);
}).listen(1337);
```

## Constants




All of the constants defined in zlib.h are also defined on
`require('zlib')`.
In the normal course of operations, you will not need to ever set any of
these.  They are documented here so that their presence is not
surprising.  This section is taken almost directly from the
[zlib documentation][].  See  for more
details.

Allowed flush values.

* `zlib.Z_NO_FLUSH`
* `zlib.Z_PARTIAL_FLUSH`
* `zlib.Z_SYNC_FLUSH`
* `zlib.Z_FULL_FLUSH`
* `zlib.Z_FINISH`
* `zlib.Z_BLOCK`
* `zlib.Z_TREES`

Return codes for the compression/decompression functions. Negative
values are errors, positive values are used for special but normal
events.

* `zlib.Z_OK`
* `zlib.Z_STREAM_END`
* `zlib.Z_NEED_DICT`
* `zlib.Z_ERRNO`
* `zlib.Z_STREAM_ERROR`
* `zlib.Z_DATA_ERROR`
* `zlib.Z_MEM_ERROR`
* `zlib.Z_BUF_ERROR`
* `zlib.Z_VERSION_ERROR`

Compression levels.

* `zlib.Z_NO_COMPRESSION`
* `zlib.Z_BEST_SPEED`
* `zlib.Z_BEST_COMPRESSION`
* `zlib.Z_DEFAULT_COMPRESSION`

Compression strategy.

* `zlib.Z_FILTERED`
* `zlib.Z_HUFFMAN_ONLY`
* `zlib.Z_RLE`
* `zlib.Z_FIXED`
* `zlib.Z_DEFAULT_STRATEGY`

The deflate compression method (the only one supported in this version).

* `zlib.Z_DEFLATED`

For initializing zalloc, zfree, opaque.

* `zlib.Z_NULL`

## Class Options




Each class takes an options object.  All options are optional.

Note that some options are only relevant when compressing, and are
ignored by the decompression classes.

* flush (default: `zlib.Z_NO_FLUSH`)
* chunkSize (default: 16*1024)
* windowBits
* level (compression only)
* memLevel (compression only)
* strategy (compression only)
* dictionary (deflate/inflate only, empty dictionary by default)

See the description of `deflateInit2` and `inflateInit2` at
 for more information on these.

## Class: zlib.Deflate


Compress data using deflate.

## Class: zlib.DeflateRaw


Compress data using deflate, and do not append a zlib header.

## Class: zlib.Gunzip


Decompress a gzip stream.

## Class: zlib.Gzip


Compress data using gzip.

## Class: zlib.Inflate


Decompress a deflate stream.

## Class: zlib.InflateRaw


Decompress a raw deflate stream.

## Class: zlib.Unzip


Decompress either a Gzip- or Deflate-compressed stream by auto-detecting
the header.

## Class: zlib.Zlib


Not exported by the `zlib` module. It is documented here because it is the base
class of the compressor/decompressor classes.

### zlib.flush([kind], callback)


`kind` defaults to `zlib.Z_FULL_FLUSH`.

Flush pending data. Don't call this frivolously, premature flushes negatively
impact the effectiveness of the compression algorithm.

Calling this only flushes data from the internal zlib state, and does not
perform flushing of any kind on the streams level. Rather, it behaves like a
normal call to `.write()`, i.e. it will be queued up behind other pending
writes and will only produce output when data is being read from the stream.

### zlib.params(level, strategy, callback)


Dynamically update the compression level and compression strategy.
Only applicable to deflate algorithm.

### zlib.reset()


Reset the compressor/decompressor to factory defaults. Only applicable to
the inflate and deflate algorithms.

## zlib.createDeflate([options])


Returns a new [Deflate][] object with an [options][].

## zlib.createDeflateRaw([options])


Returns a new [DeflateRaw][] object with an [options][].

## zlib.createGunzip([options])


Returns a new [Gunzip][] object with an [options][].

## zlib.createGzip([options])


Returns a new [Gzip][] object with an [options][].

## zlib.createInflate([options])


Returns a new [Inflate][] object with an [options][].

## zlib.createInflateRaw([options])


Returns a new [InflateRaw][] object with an [options][].

## zlib.createUnzip([options])


Returns a new [Unzip][] object with an [options][].

## Convenience Methods



All of these take a [Buffer][] or string as the first argument, an optional second
argument to supply options to the zlib classes and will call the supplied
callback with `callback(error, result)`.

Every method has a `*Sync` counterpart, which accept the same arguments, but
without a callback.

### zlib.deflate(buf[, options], callback)

### zlib.deflateSync(buf[, options])


Compress a [Buffer][] or string with [Deflate][].

### zlib.deflateRaw(buf[, options], callback)

### zlib.deflateRawSync(buf[, options])


Compress a [Buffer][] or string with [DeflateRaw][].

### zlib.gunzip(buf[, options], callback)

### zlib.gunzipSync(buf[, options])


Decompress a [Buffer][] or string with [Gunzip][].

### zlib.gzip(buf[, options], callback)

### zlib.gzipSync(buf[, options])


Compress a [Buffer][] or string with [Gzip][].

### zlib.inflate(buf[, options], callback)

### zlib.inflateSync(buf[, options])


Decompress a [Buffer][] or string with [Inflate][].

### zlib.inflateRaw(buf[, options], callback)

### zlib.inflateRawSync(buf[, options])


Decompress a [Buffer][] or string with [InflateRaw][].

### zlib.unzip(buf[, options], callback)

### zlib.unzipSync(buf[, options])


Decompress a [Buffer][] or string with [Unzip][].

[accept-encoding]: https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.3
[content-encoding]: https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11
[Memory Usage Tuning]: #zlib_memory_usage_tuning
[zlib documentation]: http://zlib.net/manual.html#Constants
[options]: #zlib_class_options
[Deflate]: #zlib_class_zlib_deflate
[DeflateRaw]: #zlib_class_zlib_deflateraw
[Gunzip]: #zlib_class_zlib_gunzip
[Gzip]: #zlib_class_zlib_gzip
[Inflate]: #zlib_class_zlib_inflate
[InflateRaw]: #zlib_class_zlib_inflateraw
[Unzip]: #zlib_class_zlib_unzip
[`.flush()`]: #zlib_zlib_flush_kind_callback
[Buffer]: buffer.html
node-v4.8.2/doc/api/assets/dnt_helper.js000644 000766 000024 00000004670 13070706740 020265 0ustar00iojsstaff000000 000000 /**
 * http://schalkneethling.github.io/blog/2015/11/06/respect-user-choice-do-not-track/
 * https://github.com/schalkneethling/dnt-helper/blob/master/js/dnt-helper.js
 *
 * Returns true or false based on whether doNotTack is enabled. It also takes into account the
 * anomalies, such as !bugzilla 887703, which effect versions of Fx 31 and lower. It also handles
 * IE versions on Windows 7, 8 and 8.1, where the DNT implementation does not honor the spec.
 * @see https://bugzilla.mozilla.org/show_bug.cgi?id=1217896 for more details
 * @params {string} [dnt] - An optional mock doNotTrack string to ease unit testing.
 * @params {string} [userAgent] - An optional mock userAgent string to ease unit testing.
 * @returns {boolean} true if enabled else false
 */
function _dntEnabled(dnt, userAgent) {

    'use strict';

    // for old version of IE we need to use the msDoNotTrack property of navigator
    // on newer versions, and newer platforms, this is doNotTrack but, on the window object
    // Safari also exposes the property on the window object.
    var dntStatus = dnt || navigator.doNotTrack || window.doNotTrack || navigator.msDoNotTrack;
    var ua = userAgent || navigator.userAgent;

    // List of Windows versions known to not implement DNT according to the standard.
    var anomalousWinVersions = ['Windows NT 6.1', 'Windows NT 6.2', 'Windows NT 6.3'];

    var fxMatch = ua.match(/Firefox\/(\d+)/);
    var ieRegEx = /MSIE|Trident/i;
    var isIE = ieRegEx.test(ua);
    // Matches from Windows up to the first occurance of ; un-greedily
    // http://www.regexr.com/3c2el
    var platform = ua.match(/Windows.+?(?=;)/g);

    // With old versions of IE, DNT did not exist so we simply return false;
    if (isIE && typeof Array.prototype.indexOf !== 'function') {
        return false;
    } else if (fxMatch && parseInt(fxMatch[1], 10) < 32) {
        // Can't say for sure if it is 1 or 0, due to Fx bug 887703
        dntStatus = 'Unspecified';
    } else if (isIE && platform && anomalousWinVersions.indexOf(platform.toString()) !== -1) {
        // default is on, which does not honor the specification
        dntStatus = 'Unspecified';
    } else {
        // sets dntStatus to Disabled or Enabled based on the value returned by the browser.
        // If dntStatus is undefined, it will be set to Unspecified
        dntStatus = { '0': 'Disabled', '1': 'Enabled' }[dntStatus] || 'Unspecified';
    }

    return dntStatus === 'Enabled' ? true : false;
}
node-v4.8.2/doc/api/assets/sh.css000644 000766 000024 00000000610 13070706740 016715 0ustar00iojsstaff000000 000000 .sh_sourceCode {
  font-weight: normal;
  font-style: normal;
}

.sh_sourceCode .sh_symbol,
.sh_sourceCode .sh_cbracket {
  color: #333;
}

.sh_sourceCode .sh_keyword {
  color: #338;
}

.sh_sourceCode .sh_string,
.sh_sourceCode .sh_regexp,
.sh_sourceCode .sh_number,
.sh_sourceCode .sh_specialchar {
  color: #E54305;
}

.sh_sourceCode .sh_comment {
  color: #666;
  font-weight: lighter;
}
node-v4.8.2/doc/api/assets/sh_main.js000644 000766 000024 00000035702 13070706740 017557 0ustar00iojsstaff000000 000000 /*
SHJS - Syntax Highlighting in JavaScript
Copyright (C) 2007, 2008 gnombat@users.sourceforge.net
License: http://shjs.sourceforge.net/doc/gplv3.html
*/

if (! this.sh_languages) {
  this.sh_languages = {};
}
var sh_requests = {};

function sh_isEmailAddress(url) {
  if (/^mailto:/.test(url)) {
    return false;
  }
  return url.indexOf('@') !== -1;
}

function sh_setHref(tags, numTags, inputString) {
  var url = inputString.substring(tags[numTags - 2].pos, tags[numTags - 1].pos);
  if (url.length >= 2 && url.charAt(0) === '<' && url.charAt(url.length - 1) === '>') {
    url = url.substr(1, url.length - 2);
  }
  if (sh_isEmailAddress(url)) {
    url = 'mailto:' + url;
  }
  tags[numTags - 2].node.href = url;
}

/*
Konqueror has a bug where the regular expression /$/g will not match at the end
of a line more than once:

  var regex = /$/g;
  var match;

  var line = '1234567890';
  regex.lastIndex = 10;
  match = regex.exec(line);

  var line2 = 'abcde';
  regex.lastIndex = 5;
  match = regex.exec(line2);  // fails
*/
function sh_konquerorExec(s) {
  var result = [''];
  result.index = s.length;
  result.input = s;
  return result;
}

/**
Highlights all elements containing source code in a text string.  The return
value is an array of objects, each representing an HTML start or end tag.  Each
object has a property named pos, which is an integer representing the text
offset of the tag. Every start tag also has a property named node, which is the
DOM element started by the tag. End tags do not have this property.
@param  inputString  a text string
@param  language  a language definition object
@return  an array of tag objects
*/
function sh_highlightString(inputString, language) {
  if (/Konqueror/.test(navigator.userAgent)) {
    if (! language.konquered) {
      for (var s = 0; s < language.length; s++) {
        for (var p = 0; p < language[s].length; p++) {
          var r = language[s][p][0];
          if (r.source === '$') {
            r.exec = sh_konquerorExec;
          }
        }
      }
      language.konquered = true;
    }
  }

  var a = document.createElement('a');
  var span = document.createElement('span');

  // the result
  var tags = [];
  var numTags = 0;

  // each element is a pattern object from language
  var patternStack = [];

  // the current position within inputString
  var pos = 0;

  // the name of the current style, or null if there is no current style
  var currentStyle = null;

  var output = function(s, style) {
    var length = s.length;
    // this is more than just an optimization - we don't want to output empty  elements
    if (length === 0) {
      return;
    }
    if (! style) {
      var stackLength = patternStack.length;
      if (stackLength !== 0) {
        var pattern = patternStack[stackLength - 1];
        // check whether this is a state or an environment
        if (! pattern[3]) {
          // it's not a state - it's an environment; use the style for this environment
          style = pattern[1];
        }
      }
    }
    if (currentStyle !== style) {
      if (currentStyle) {
        tags[numTags++] = {pos: pos};
        if (currentStyle === 'sh_url') {
          sh_setHref(tags, numTags, inputString);
        }
      }
      if (style) {
        var clone;
        if (style === 'sh_url') {
          clone = a.cloneNode(false);
        }
        else {
          clone = span.cloneNode(false);
        }
        clone.className = style;
        tags[numTags++] = {node: clone, pos: pos};
      }
    }
    pos += length;
    currentStyle = style;
  };

  var endOfLinePattern = /\r\n|\r|\n/g;
  endOfLinePattern.lastIndex = 0;
  var inputStringLength = inputString.length;
  while (pos < inputStringLength) {
    var start = pos;
    var end;
    var startOfNextLine;
    var endOfLineMatch = endOfLinePattern.exec(inputString);
    if (endOfLineMatch === null) {
      end = inputStringLength;
      startOfNextLine = inputStringLength;
    }
    else {
      end = endOfLineMatch.index;
      startOfNextLine = endOfLinePattern.lastIndex;
    }

    var line = inputString.substring(start, end);

    var matchCache = [];
    for (;;) {
      var posWithinLine = pos - start;

      var stateIndex;
      var stackLength = patternStack.length;
      if (stackLength === 0) {
        stateIndex = 0;
      }
      else {
        // get the next state
        stateIndex = patternStack[stackLength - 1][2];
      }

      var state = language[stateIndex];
      var numPatterns = state.length;
      var mc = matchCache[stateIndex];
      if (! mc) {
        mc = matchCache[stateIndex] = [];
      }
      var bestMatch = null;
      var bestPatternIndex = -1;
      for (var i = 0; i < numPatterns; i++) {
        var match;
        if (i < mc.length && (mc[i] === null || posWithinLine <= mc[i].index)) {
          match = mc[i];
        }
        else {
          var regex = state[i][0];
          regex.lastIndex = posWithinLine;
          match = regex.exec(line);
          mc[i] = match;
        }
        if (match !== null && (bestMatch === null || match.index < bestMatch.index)) {
          bestMatch = match;
          bestPatternIndex = i;
          if (match.index === posWithinLine) {
            break;
          }
        }
      }

      if (bestMatch === null) {
        output(line.substring(posWithinLine), null);
        break;
      }
      else {
        // got a match
        if (bestMatch.index > posWithinLine) {
          output(line.substring(posWithinLine, bestMatch.index), null);
        }

        var pattern = state[bestPatternIndex];

        var newStyle = pattern[1];
        var matchedString;
        if (newStyle instanceof Array) {
          for (var subexpression = 0; subexpression < newStyle.length; subexpression++) {
            matchedString = bestMatch[subexpression + 1];
            output(matchedString, newStyle[subexpression]);
          }
        }
        else {
          matchedString = bestMatch[0];
          output(matchedString, newStyle);
        }

        switch (pattern[2]) {
        case -1:
          // do nothing
          break;
        case -2:
          // exit
          patternStack.pop();
          break;
        case -3:
          // exitall
          patternStack.length = 0;
          break;
        default:
          // this was the start of a delimited pattern or a state/environment
          patternStack.push(pattern);
          break;
        }
      }
    }

    // end of the line
    if (currentStyle) {
      tags[numTags++] = {pos: pos};
      if (currentStyle === 'sh_url') {
        sh_setHref(tags, numTags, inputString);
      }
      currentStyle = null;
    }
    pos = startOfNextLine;
  }

  return tags;
}

////////////////////////////////////////////////////////////////////////////////
// DOM-dependent functions

function sh_getClasses(element) {
  var result = [];
  var htmlClass = element.className;
  if (htmlClass && htmlClass.length > 0) {
    var htmlClasses = htmlClass.split(' ');
    for (var i = 0; i < htmlClasses.length; i++) {
      if (htmlClasses[i].length > 0) {
        result.push(htmlClasses[i]);
      }
    }
  }
  return result;
}

function sh_addClass(element, name) {
  var htmlClasses = sh_getClasses(element);
  for (var i = 0; i < htmlClasses.length; i++) {
    if (name.toLowerCase() === htmlClasses[i].toLowerCase()) {
      return;
    }
  }
  htmlClasses.push(name);
  element.className = htmlClasses.join(' ');
}

/**
Extracts the tags from an HTML DOM NodeList.
@param  nodeList  a DOM NodeList
@param  result  an object with text, tags and pos properties
*/
function sh_extractTagsFromNodeList(nodeList, result) {
  var length = nodeList.length;
  for (var i = 0; i < length; i++) {
    var node = nodeList.item(i);
    switch (node.nodeType) {
    case 1:
      if (node.nodeName.toLowerCase() === 'br') {
        var terminator;
        if (/MSIE/.test(navigator.userAgent)) {
          terminator = '\r';
        }
        else {
          terminator = '\n';
        }
        result.text.push(terminator);
        result.pos++;
      }
      else {
        result.tags.push({node: node.cloneNode(false), pos: result.pos});
        sh_extractTagsFromNodeList(node.childNodes, result);
        result.tags.push({pos: result.pos});
      }
      break;
    case 3:
    case 4:
      result.text.push(node.data);
      result.pos += node.length;
      break;
    }
  }
}

/**
Extracts the tags from the text of an HTML element. The extracted tags will be
returned as an array of tag objects. See sh_highlightString for the format of
the tag objects.
@param  element  a DOM element
@param  tags  an empty array; the extracted tag objects will be returned in it
@return  the text of the element
@see  sh_highlightString
*/
function sh_extractTags(element, tags) {
  var result = {};
  result.text = [];
  result.tags = tags;
  result.pos = 0;
  sh_extractTagsFromNodeList(element.childNodes, result);
  return result.text.join('');
}

/**
Merges the original tags from an element with the tags produced by highlighting.
@param  originalTags  an array containing the original tags
@param  highlightTags  an array containing the highlighting tags - these must not overlap
@result  an array containing the merged tags
*/
function sh_mergeTags(originalTags, highlightTags) {
  var numOriginalTags = originalTags.length;
  if (numOriginalTags === 0) {
    return highlightTags;
  }

  var numHighlightTags = highlightTags.length;
  if (numHighlightTags === 0) {
    return originalTags;
  }

  var result = [];
  var originalIndex = 0;
  var highlightIndex = 0;

  while (originalIndex < numOriginalTags && highlightIndex < numHighlightTags) {
    var originalTag = originalTags[originalIndex];
    var highlightTag = highlightTags[highlightIndex];

    if (originalTag.pos <= highlightTag.pos) {
      result.push(originalTag);
      originalIndex++;
    }
    else {
      result.push(highlightTag);
      if (highlightTags[highlightIndex + 1].pos <= originalTag.pos) {
        highlightIndex++;
        result.push(highlightTags[highlightIndex]);
        highlightIndex++;
      }
      else {
        // new end tag
        result.push({pos: originalTag.pos});

        // new start tag
        highlightTags[highlightIndex] = {node: highlightTag.node.cloneNode(false), pos: originalTag.pos};
      }
    }
  }

  while (originalIndex < numOriginalTags) {
    result.push(originalTags[originalIndex]);
    originalIndex++;
  }

  while (highlightIndex < numHighlightTags) {
    result.push(highlightTags[highlightIndex]);
    highlightIndex++;
  }

  return result;
}

/**
Inserts tags into text.
@param  tags  an array of tag objects
@param  text  a string representing the text
@return  a DOM DocumentFragment representing the resulting HTML
*/
function sh_insertTags(tags, text) {
  var doc = document;

  var result = document.createDocumentFragment();
  var tagIndex = 0;
  var numTags = tags.length;
  var textPos = 0;
  var textLength = text.length;
  var currentNode = result;

  // output one tag or text node every iteration
  while (textPos < textLength || tagIndex < numTags) {
    var tag;
    var tagPos;
    if (tagIndex < numTags) {
      tag = tags[tagIndex];
      tagPos = tag.pos;
    }
    else {
      tagPos = textLength;
    }

    if (tagPos <= textPos) {
      // output the tag
      if (tag.node) {
        // start tag
        var newNode = tag.node;
        currentNode.appendChild(newNode);
        currentNode = newNode;
      }
      else {
        // end tag
        currentNode = currentNode.parentNode;
      }
      tagIndex++;
    }
    else {
      // output text
      currentNode.appendChild(doc.createTextNode(text.substring(textPos, tagPos)));
      textPos = tagPos;
    }
  }

  return result;
}

/**
Highlights an element containing source code.  Upon completion of this function,
the element will have been placed in the "sh_sourceCode" class.
@param  element  a DOM 
 element containing the source code to be highlighted
@param  language  a language definition object
*/
function sh_highlightElement(element, language) {
  sh_addClass(element, 'sh_sourceCode');
  var originalTags = [];
  var inputString = sh_extractTags(element, originalTags);
  var highlightTags = sh_highlightString(inputString, language);
  var tags = sh_mergeTags(originalTags, highlightTags);
  var documentFragment = sh_insertTags(tags, inputString);
  while (element.hasChildNodes()) {
    element.removeChild(element.firstChild);
  }
  element.appendChild(documentFragment);
}

function sh_getXMLHttpRequest() {
  if (window.ActiveXObject) {
    return new ActiveXObject('Msxml2.XMLHTTP');
  }
  else if (window.XMLHttpRequest) {
    return new XMLHttpRequest();
  }
  throw 'No XMLHttpRequest implementation available';
}

function sh_load(language, element, prefix, suffix) {
  if (language in sh_requests) {
    sh_requests[language].push(element);
    return;
  }
  sh_requests[language] = [element];
  var request = sh_getXMLHttpRequest();
  var url = prefix + 'sh_' + language + suffix;
  request.open('GET', url, true);
  request.onreadystatechange = function () {
    if (request.readyState === 4) {
      try {
        if (! request.status || request.status === 200) {
          eval(request.responseText);
          var elements = sh_requests[language];
          for (var i = 0; i < elements.length; i++) {
            sh_highlightElement(elements[i], sh_languages[language]);
          }
        }
        else {
          throw 'HTTP error: status ' + request.status;
        }
      }
      finally {
        request = null;
      }
    }
  };
  request.send(null);
}

/**
Highlights all elements containing source code on the current page. Elements
containing source code must be "pre" elements with a "class" attribute of
"sh_LANGUAGE", where LANGUAGE is a valid language identifier; e.g., "sh_java"
identifies the element as containing "java" language source code.
*/
function highlight(prefix, suffix, tag) {
  var nodeList = document.getElementsByTagName(tag);
  for (var i = 0; i < nodeList.length; i++) {
    var element = nodeList.item(i);
    var htmlClasses = sh_getClasses(element);
    var highlighted = false;
    var donthighlight = false;
    for (var j = 0; j < htmlClasses.length; j++) {
      var htmlClass = htmlClasses[j].toLowerCase();
      if (htmlClass === 'sh_none') {
        donthighlight = true
        continue;
      }
      if (htmlClass.substr(0, 3) === 'sh_') {
        var language = htmlClass.substring(3);
        if (language in sh_languages) {
          sh_highlightElement(element, sh_languages[language]);
          highlighted = true;
        }
        else if (typeof(prefix) === 'string' && typeof(suffix) === 'string') {
          sh_load(language, element, prefix, suffix);
        }
        else {
          throw 'Found <' + tag + '> element with class="' + htmlClass + '", but no such language exists';
        }
        break;
      }
    }
    if (highlighted === false && donthighlight == false) {
      sh_highlightElement(element, sh_languages["javascript"]);
    }
  }
}



function sh_highlightDocument(prefix, suffix) {
  highlight(prefix, suffix, 'tt');
  highlight(prefix, suffix, 'code');
  highlight(prefix, suffix, 'pre');
}
node-v4.8.2/doc/api/assets/style.css000644 000766 000024 00000016103 13070706740 017447 0ustar00iojsstaff000000 000000 /*--------------------- Layout and Typography ----------------------------*/
html {
  -webkit-font-smoothing: antialiased;
  -moz-osx-font-smoothing: grayscale;
  -webkit-font-variant-ligatures: none;
          font-variant-ligatures: none;
}

body {
  font-family: "Lato", "Lucida Grande", "Lucida Sans Unicode", "Lucida Sans", Verdana, Tahoma, sans-serif;
  font-size: 62.5%;
  margin: 0;
  padding: 0;
  color: #333;
  background: #fff;
}

h1, h2, h3, h4 {
  margin: .8em 0 .5em;
  line-height: 1.2;
}

h5, h6 {
  margin: 1em 0 .8em;
  line-height: 1.2;
}

h1 {
  margin-top: 0;
  font-size: 2.441em;
}

h2 {font-size: 1.953em;}

h3 {font-size: 1.563em;}

h4 {font-size: 1.25em;}

h5 {font-size: 1em;}

h6 {font-size: .8em;}

pre, tt, code, .pre, span.type, a.type {
  font-family: Monaco, Consolas, "Lucida Console", monospace;
}

#content {
  font-size: 1.8em;
  position: relative;
}

a, a:link, a:active {
  color: #43853d;
  text-decoration: none;
  border-radius: 2px;
  padding: .1em .2em;
  margin: -.1em;
}

a:hover, a:focus {
  color: #fff;
  background-color: #43853d;
  outline: none;
}

strong {
  font-weight: 700;
}

code a:hover {
  background: none;
}

em code {
  font-style: normal;
}

#changelog #gtoc {
  display: none;
}

#gtoc {
  font-size: .8em;
}

.line {
  width: calc(100% - 1em);
  display: block;
  padding-bottom: 1px;
}

.api_stability {
  color: white !important;
  margin: 0 0 1em 0;
  font-family: "Lato", "Lucida Grande", "Lucida Sans Unicode", "Lucida Sans", Verdana, Tahoma, sans-serif;
  font-weight: 700;
}

.api_stability * {
  color: white !important;
}

.api_stability a {
  text-decoration: underline;
}

.api_stability a:hover, .api_stability a:active, .api_stability a:focus {
  background: rgba(255, 255, 255, .4);
}

.api_stability a code {
  background: none;
}

.api_stability_0 {
  background-color: #D60027;
}

.api_stability_1 {
  background-color: #EC5315;
}

.api_stability_2 {
  background-color: #4EBA0F;
}

.api_stability_3 {
  background-color: #0084B6;
}

.api_metadata {
  font-size: .75em;
  margin-bottom: 1em;
}

.api_metadata span {
  margin-right: 1em;
}

.api_metadata span:last-child {
  margin-right: 0px;
}

ul.plain {
  list-style: none;
}

abbr {
  border-bottom: 1px dotted #454545;
}

p {
  position: relative;
  text-rendering: optimizeLegibility;
  margin: 0 0 1.125em 0;
  line-height: 1.5em;
}

#apicontent > *:last-child {
  margin-bottom: 0;
  padding-bottom: 2em;
}

table {
  border-collapse: collapse;
  margin: 0 0 1.5em 0;
}

th, td {
  border: 1px solid #aaa;
}

th {
  text-align:left;
}

ol, ul, dl {
  margin: 0 0 .6em 0;
  padding: 0;
}

ol ul, ol ol, ol dl, ul ul, ul ol, ul dl, dl ul, dl ol, dl dl {
  margin-bottom: 0;
}

ul, ol {
  margin-left: 2em;
}

dl dt {
  position: relative;
  margin: 1.5em 0 0;
}

dl dd {
  position: relative;
  margin: 0 1em 0;
}

dd + dt.pre {
  margin-top: 1.6em;
}

h1, h2, h3, h4, h5, h6 {
  text-rendering: optimizeLegibility;
  font-weight: 700;
  position: relative;
}

header h1 {
  font-size: 2em;
  line-height: 2em;
  margin: 0;
}

#apicontent {
  padding-top: 1em;
}

#apicontent .line {
  width: calc(50% - 1em);
  margin: 1em 1em .95em;
  background-color: #ccc;
}

h2 + h2 {
  margin: 0 0 .5em;
}

h3 + h3 {
  margin: 0 0 .5em;
}

h2, h3, h4, h5 {
  position: relative;
  padding-right: 40px;
}

h1 span, h2 span, h3 span, h4 span {
  position: absolute;
  display: block;
  top: 0;
  right: 0;
}

h1 span:hover, h2 span:hover, h3 span:hover, h4 span:hover {
  opacity: 1;
}

h1 span a, h2 span a, h3 span a, h4 span a {
  font-size: .8em;
  color: #000;
  text-decoration: none;
  font-weight: bold;
}

pre, tt, code {
  line-height: 1.5em;
  margin: 0; padding: 0;
}

.pre {
  line-height: 1.5em;
  font-size: 1.2em;
}

pre {
  padding: 1em;
  vertical-align: top;
  background: #f2f2f2;
  margin: 1em;
  overflow-x: auto;
}

pre > code {
  font-size: .8em;
  padding: 0;
}

pre + h3 {
  margin-top: 2.225em;
}

code.pre {
  white-space: pre;
}

#intro {
  margin-top: 1.25em;
  margin-left: 1em;
}

#intro a {
  color: #ddd;
  font-size: 1.25em;
  font-weight: bold;
}

hr {
  background: none;
  border: medium none;
  border-bottom: 1px solid #7a7a7a;
  margin: 0 0 1em 0;
}

#toc h2 {
  margin-top: 0;
  font-size: 1em;
  line-height: 0;
  margin: 1.5em 0;
}

#toc ul {
  font-size: .8125em;
}

#toc ul ul {
  font-size: 1em;
}

#toc ul a {
  text-decoration:none;
}

#toc ul li {
  margin-bottom: .666em;
  list-style: square outside;
}

#toc li > ul {
  margin-top: .666em;
}

#toc .stability_0::after {
  background-color: #d50027;
  color: #fff;
}

#toc .stability_0::after {
  content: "deprecated";
  font-size: .8em;
  position: relative;
  top: -.18em;
  left: .5em;
  padding: 0 .3em .2em;
  border-radius: 3px;
}

#apicontent li {
  margin-bottom: .5em;
}

#apicontent li:last-child {
  margin-bottom: 0;
}

tt, code {
  font-size: .9em;
  color: #040404;
  background-color: #f2f2f2;
  border-radius: 2px;
  padding: .1em .3em;
}

a code {
  color: inherit;
  background: inherit;
  padding: 0;
}

.type {
  font-size: .9em;
  line-height: 1.5em;
}

#column1.interior {
  margin-left: 234px;
  padding: 0 2em;
  -webkit-padding-start: 1.5em;
}

#column2.interior {
  width: 234px;
  background: #333;
  position: fixed;
  left: 0;
  top: 0;
  bottom: 0;
  overflow-x: hidden;
  overflow-y: scroll;
}

#column2 ul {
  list-style: none;
  margin: .9em 0 .5em;
  background: #333;
}

#column2 > :first-child {
  margin: 1.25em 1em;
}

#column2 > ul:nth-child(2) {
  margin: 1.25em 0 .5em;
}

#column2 > ul:last-child {
  margin: .9em 0 1.25em;
}

#column2 ul li {
  padding-left: 1.4em;
  margin-bottom: .5em;
  padding-bottom: .5em;
  font-size: .8em;
}

#column2 .line {
  margin: 0 .5em;
  background-color: #707070;
}

#column2 ul li:last-child {
  margin-bottom: 0;
}

#column2 ul li a {
  color: #ccc;
  border-radius: 0;
}

#column2 ul li a.active, #column2 ul li a.active:hover,
#column2 ul li a.active:focus {
  color: #43853d;
  border-radius: 0;
  border-bottom: 1px solid #43853d;
  background: none;
}

#intro a:hover, #intro a:focus,
#column2 ul li a:hover, #column2 ul li a:focus {
  color: #fff;
  background: none;
}

span > .mark, span > .mark:visited {
  font-size: 1em;
  color: #707070;
  position: absolute;
  top: 0px;
  right: 0px;
}

span > .mark:hover, span > .mark:focus, span > .mark:active {
  color: #43853d;
  background: none;
}

th, td {
  padding: .75em 1em .75em 1em;
  vertical-align: top;
}

th > *:last-child, td > *:last-child {
  margin-bottom: 0;
}

/* simpler clearfix */
.clearfix:after {
  content: ".";
  display: block;
  height: 0;
  clear: both;
  visibility: hidden;
}

@media only screen and (max-width: 1024px) {
  #content {
    font-size: 2.5em;
    overflow: visible;
  }
  #column1.interior {
    margin-left: 0;
    padding-left: .5em;
    padding-right: .5em;
    width: auto;
    overflow-y: visible;
  }
  #column2 {
    display: none;
  }
}

@media only screen and (max-width: 1024px) and (orientation: portrait) {
  #content {
    font-size: 3.5em;
  }
}

@media print {
  html {
    height: auto;
  }
  #column2.interior {
    display: none;
  }
  #column1.interior {
    margin-left: auto;
    overflow-y: auto;
  }
}
node-v4.8.2/deps/cares/000755 000766 000024 00000000000 13070706730 015003 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/gtest/000755 000766 000024 00000000000 13070706730 015034 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/http_parser/000755 000766 000024 00000000000 13070706730 016241 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/v8/000755 000766 000024 00000000000 13070706741 014245 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/v8/.clang-format000644 000766 000024 00000000241 13070706732 016615 0ustar00iojsstaff000000 000000 # Defines the Google C++ style for automatic reformatting.
# http://clang.llvm.org/docs/ClangFormatStyleOptions.html
BasedOnStyle: Google
MaxEmptyLinesToKeep: 2
node-v4.8.2/deps/v8/.gitignore000644 000766 000024 00000002525 13070706732 016241 0ustar00iojsstaff000000 000000 *.a
*.exe
*.idb
*.lib
*.log
*.map
*.mk
*.ncb
*.pdb
*.pyc
*.scons*
*.sdf
*.sln
*.so
*.suo
*.user
*.vcproj
*.vcxproj
*.vcxproj.filters
*.xcodeproj
#*#
*~
.cpplint-cache
.cproject
.d8_history
.gclient_entries
.landmines
.project
.pydevproject
.settings
.*.sw?
bsuite
compile_commands.json
d8
d8_g
gccauses
gcsuspects
shell
shell_g
/_*
/build/Debug
/build/gyp
/build/ipch/
/build/Release
/buildtools
/hydrogen.cfg
/obj
/out
/perf.data
/perf.data.old
/test/benchmarks/CHECKED_OUT_*
/test/benchmarks/downloaded_*
/test/benchmarks/kraken
/test/benchmarks/octane
/test/benchmarks/sunspider
/test/mozilla/CHECKED_OUT_VERSION
/test/mozilla/data
/test/mozilla/data.old
/test/mozilla/downloaded_*
/test/promises-aplus/promises-tests
/test/promises-aplus/promises-tests.tar.gz
/test/promises-aplus/sinon
/test/simdjs/ecmascript_simd*
/test/simdjs/data*
/test/test262/data
/test/test262/data.old
/test/test262/tc39-test262-*
/test/test262-es6/data
/test/test262-es6/data.old
/test/test262-es6/tc39-test262-*
/testing/gmock
/testing/gtest
/third_party
/third_party/icu
/third_party/llvm
/third_party/llvm-build
/tools/clang
/tools/jsfunfuzz
/tools/jsfunfuzz.zip
/tools/oom_dump/oom_dump
/tools/oom_dump/oom_dump.o
/tools/visual_studio/Debug
/tools/visual_studio/Release
/v8.log.ll
/xcodebuild
TAGS
*.Makefile
GTAGS
GRTAGS
GSYMS
GPATH
gtags.files
turbo*.cfg
turbo*.dot
turbo*.json
node-v4.8.2/deps/v8/.ycm_extra_conf.py000644 000766 000024 00000013353 13070706732 017702 0ustar00iojsstaff000000 000000 # Copyright 2015 the V8 project authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

# Autocompletion config for YouCompleteMe in V8.
#
# USAGE:
#
#   1. Install YCM [https://github.com/Valloric/YouCompleteMe]
#          (Googlers should check out [go/ycm])
#
#   2. Profit
#
#
# Usage notes:
#
#   * You must use ninja & clang to build V8.
#
#   * You must have run gyp_v8 and built V8 recently.
#
#
# Hacking notes:
#
#   * The purpose of this script is to construct an accurate enough command line
#     for YCM to pass to clang so it can build and extract the symbols.
#
#   * Right now, we only pull the -I and -D flags. That seems to be sufficient
#     for everything I've used it for.
#
#   * That whole ninja & clang thing? We could support other configs if someone
#     were willing to write the correct commands and a parser.
#
#   * This has only been tested on gTrusty.


import os
import os.path
import subprocess
import sys


# Flags from YCM's default config.
flags = [
'-DUSE_CLANG_COMPLETER',
'-std=gnu++0x',
'-x',
'c++',
]


def PathExists(*args):
  return os.path.exists(os.path.join(*args))


def FindV8SrcFromFilename(filename):
  """Searches for the root of the V8 checkout.

  Simply checks parent directories until it finds .gclient and v8/.

  Args:
    filename: (String) Path to source file being edited.

  Returns:
    (String) Path of 'v8/', or None if unable to find.
  """
  curdir = os.path.normpath(os.path.dirname(filename))
  while not (PathExists(curdir, 'v8') and PathExists(curdir, 'v8', 'DEPS')
             and (PathExists(curdir, '.gclient')
                  or PathExists(curdir, 'v8', '.git'))):
    nextdir = os.path.normpath(os.path.join(curdir, '..'))
    if nextdir == curdir:
      return None
    curdir = nextdir
  return os.path.join(curdir, 'v8')


def GetClangCommandFromNinjaForFilename(v8_root, filename):
  """Returns the command line to build |filename|.

  Asks ninja how it would build the source file. If the specified file is a
  header, tries to find its companion source file first.

  Args:
    v8_root: (String) Path to v8/.
    filename: (String) Path to source file being edited.

  Returns:
    (List of Strings) Command line arguments for clang.
  """
  if not v8_root:
    return []

  # Generally, everyone benefits from including V8's root, because all of
  # V8's includes are relative to that.
  v8_flags = ['-I' + os.path.join(v8_root)]

  # Version of Clang used to compile V8 can be newer then version of
  # libclang that YCM uses for completion. So it's possible that YCM's libclang
  # doesn't know about some used warning options, which causes compilation
  # warnings (and errors, because of '-Werror');
  v8_flags.append('-Wno-unknown-warning-option')

  # Header files can't be built. Instead, try to match a header file to its
  # corresponding source file.
  if filename.endswith('.h'):
    alternates = ['.cc', '.cpp']
    for alt_extension in alternates:
      alt_name = filename[:-2] + alt_extension
      if os.path.exists(alt_name):
        filename = alt_name
        break
    else:
      if filename.endswith('-inl.h'):
        for alt_extension in alternates:
          alt_name = filename[:-6] + alt_extension
          if os.path.exists(alt_name):
            filename = alt_name
            break;
        else:
          # If this is a standalone -inl.h file with no source, the best we can
          # do is try to use the default flags.
          return v8_flags
      else:
        # If this is a standalone .h file with no source, the best we can do is
        # try to use the default flags.
        return v8_flags

  sys.path.append(os.path.join(v8_root, 'tools', 'ninja'))
  from ninja_output import GetNinjaOutputDirectory
  out_dir = os.path.realpath(GetNinjaOutputDirectory(v8_root))

  # Ninja needs the path to the source file relative to the output build
  # directory.
  rel_filename = os.path.relpath(os.path.realpath(filename), out_dir)

  # Ask ninja how it would build our source file.
  p = subprocess.Popen(['ninja', '-v', '-C', out_dir, '-t',
                        'commands', rel_filename + '^'],
                       stdout=subprocess.PIPE)
  stdout, stderr = p.communicate()
  if p.returncode:
    return v8_flags

  # Ninja might execute several commands to build something. We want the last
  # clang command.
  clang_line = None
  for line in reversed(stdout.split('\n')):
    if 'clang' in line:
      clang_line = line
      break
  else:
    return v8_flags

  # Parse flags that are important for YCM's purposes.
  for flag in clang_line.split(' '):
    if flag.startswith('-I'):
      # Relative paths need to be resolved, because they're relative to the
      # output dir, not the source.
      if flag[2] == '/':
        v8_flags.append(flag)
      else:
        abs_path = os.path.normpath(os.path.join(out_dir, flag[2:]))
        v8_flags.append('-I' + abs_path)
    elif flag.startswith('-std'):
      v8_flags.append(flag)
    elif flag.startswith('-') and flag[1] in 'DWFfmO':
      if flag == '-Wno-deprecated-register' or flag == '-Wno-header-guard':
        # These flags causes libclang (3.3) to crash. Remove it until things
        # are fixed.
        continue
      v8_flags.append(flag)

  return v8_flags


def FlagsForFile(filename):
  """This is the main entry point for YCM. Its interface is fixed.

  Args:
    filename: (String) Path to source file being edited.

  Returns:
    (Dictionary)
      'flags': (List of Strings) Command line flags.
      'do_cache': (Boolean) True if the result should be cached.
  """
  v8_root = FindV8SrcFromFilename(filename)
  v8_flags = GetClangCommandFromNinjaForFilename(v8_root, filename)
  final_flags = flags + v8_flags
  return {
    'flags': final_flags,
    'do_cache': True
  }
node-v4.8.2/deps/v8/AUTHORS000644 000766 000024 00000007046 13070706732 015324 0ustar00iojsstaff000000 000000 # Below is a list of people and organizations that have contributed
# to the V8 project.  Names should be added to the list like so:
#
#   Name/Organization 

Google Inc. <*@google.com>
The Chromium Authors <*@chromium.org>
Sigma Designs Inc. <*@sdesigns.com>
ARM Ltd. <*@arm.com>
Hewlett-Packard Development Company, LP <*@palm.com>
Igalia, S.L. <*@igalia.com>
Joyent, Inc. <*@joyent.com>
Bloomberg Finance L.P. <*@bloomberg.net>
NVIDIA Corporation <*@nvidia.com>
BlackBerry Limited <*@blackberry.com>
Opera Software ASA <*@opera.com>
Intel Corporation <*@intel.com>
MIPS Technologies, Inc. <*@mips.com>
Imagination Technologies, LLC <*@imgtec.com>
Loongson Technology Corporation Limited <*@loongson.cn>
Code Aurora Forum <*@codeaurora.org>
Home Jinni Inc. <*@homejinni.com>
IBM Inc. <*@*.ibm.com>
Samsung <*@*.samsung.com>
Joyent, Inc <*@joyent.com>
RT-RK Computer Based System <*@rt-rk.com>
Amazon, Inc <*@amazon.com>
ST Microelectronics <*@st.com>
Yandex LLC <*@yandex-team.ru>
StrongLoop, Inc. <*@strongloop.com>

Aaron Bieber 
Abdulla Kamar 
Akinori MUSHA 
Alexander Botero-Lowry 
Alexander Karpinsky 
Alexandre Vassalotti 
Alexis Campailla 
Andreas Anyuru 
Andrew Paprocki 
Andrei Kashcha 
Ben Noordhuis 
Bert Belder 
Burcu Dogan 
Caitlin Potter 
Craig Schlenter 
Christopher A. Taylor 
Daniel Andersson 
Daniel James 
Douglas Crosher 
Erich Ocean 
Fedor Indutny 
Felix Geisendörfer 
Filipe David Manana 
Geoffrey Garside 
Han Choongwoo 
Hirofumi Mako 
Ioseb Dzmanashvili 
Isiah Meadows 
Jan de Mooij 
Jay Freeman 
James Pike 
Jianghua Yang 
Joel Stanley 
Johan Bergström 
Jonathan Liu 
JunHo Seo 
Kang-Hao (Kenny) Lu 
Luis Reis 
Luke Zarko 
Maciej Małecki 
Marcin Cieślak 
Mathias Bynens 
Matt Hanselman 
Matthew Sporleder 
Maxim Mossienko 
Michael Lutz 
Michael Smith 
Mike Gilbert 
Mike Pennisi 
Nicolas Antonius Ernst Leopold Maria Kaiser 
Paolo Giarrusso 
Patrick Gansterer 
Peter Varga 
Paul Lind 
Rafal Krypa 
Refael Ackermann 
Rene Rebe 
Robert Mustacchi 
Robert Nagy 
Ryan Dahl 
Sandro Santilli 
Sanjoy Das 
Seo Sanghyeon 
Tobias Burnus 
Victor Costan 
Vlad Burlik 
Vladimir Shutoff 
Yu Yin 
Zhongping Wang 
柳荣一 
node-v4.8.2/deps/v8/benchmarks/000755 000766 000024 00000000000 13070706732 016362 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/v8/build/000755 000766 000024 00000000000 13070706732 015344 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/v8/BUILD.gn000644 000766 000024 00000141503 13070706732 015436 0ustar00iojsstaff000000 000000 # Copyright 2014 The Chromium Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

import("//build/config/android/config.gni")
import("//build/config/arm.gni")
import("//build/config/mips.gni")

# Because standalone V8 builds are not supported, assume this is part of a
# Chromium build.
import("//build/module_args/v8.gni")

# TODO(jochen): These will need to be user-settable to support standalone V8
# builds.
v8_deprecation_warnings = false
v8_enable_disassembler = false
v8_enable_gdbjit = false
v8_enable_handle_zapping = true
v8_enable_i18n_support = true
v8_enable_verify_heap = false
v8_interpreted_regexp = false
v8_object_print = false
v8_postmortem_support = false
v8_use_snapshot = true
v8_target_arch = target_cpu
v8_random_seed = "314159265"
v8_toolset_for_d8 = "host"

# The snapshot needs to be compiled for the host, but compiled with
# a toolchain that matches the bit-width of the target.
#
# TODO(GYP): For now we only support 32-bit little-endian target builds from an
# x64 Linux host. Eventually we need to support all of the host/target
# configurations v8 runs on.
if (host_cpu == "x64" && host_os == "linux") {
  if (target_cpu == "arm" || target_cpu == "mipsel" || target_cpu == "x86") {
    snapshot_toolchain = "//build/toolchain/linux:clang_x86"
  } else if (target_cpu == "x64") {
    snapshot_toolchain = "//build/toolchain/linux:clang_x64"
  } else {
    assert(false, "Need environment for this arch")
  }
} else {
  snapshot_toolchain = default_toolchain
}

###############################################################################
# Configurations
#
config("internal_config") {
  visibility = [ ":*" ]  # Only targets in this file can depend on this.

  include_dirs = [ "." ]

  if (is_component_build) {
    defines = [
      "V8_SHARED",
      "BUILDING_V8_SHARED",
    ]
  }
}

config("internal_config_base") {
  visibility = [ ":*" ]  # Only targets in this file can depend on this.

  include_dirs = [ "." ]
}

# This config should only be applied to code using V8 and not any V8 code
# itself.
config("external_config") {
  if (is_component_build) {
    defines = [
      "V8_SHARED",
      "USING_V8_SHARED",
    ]
  }
  include_dirs = [ "include" ]
}

config("features") {
  visibility = [ ":*" ]  # Only targets in this file can depend on this.

  defines = []

  if (v8_enable_disassembler == true) {
    defines += [ "ENABLE_DISASSEMBLER" ]
  }
  if (v8_enable_gdbjit == true) {
    defines += [ "ENABLE_GDB_JIT_INTERFACE" ]
  }
  if (v8_object_print == true) {
    defines += [ "OBJECT_PRINT" ]
  }
  if (v8_enable_verify_heap == true) {
    defines += [ "VERIFY_HEAP" ]
  }
  if (v8_interpreted_regexp == true) {
    defines += [ "V8_INTERPRETED_REGEXP" ]
  }
  if (v8_deprecation_warnings == true) {
    defines += [ "V8_DEPRECATION_WARNINGS" ]
  }
  if (v8_enable_i18n_support == true) {
    defines += [ "V8_I18N_SUPPORT" ]
  }
  if (v8_enable_handle_zapping == true) {
    defines += [ "ENABLE_HANDLE_ZAPPING" ]
  }
  if (v8_use_external_startup_data == true) {
    defines += [ "V8_USE_EXTERNAL_STARTUP_DATA" ]
  }
}

config("toolchain") {
  visibility = [ ":*" ]  # Only targets in this file can depend on this.

  defines = []
  cflags = []

  # TODO(jochen): Add support for arm subarchs, mips, mipsel, mips64el.

  if (v8_target_arch == "arm") {
    defines += [ "V8_TARGET_ARCH_ARM" ]
    if (current_cpu == "arm") {
      if (arm_version == 7) {
        defines += [ "CAN_USE_ARMV7_INSTRUCTIONS" ]
      }
      if (arm_fpu == "vfpv3-d16") {
        defines += [ "CAN_USE_VFP3_INSTRUCTIONS" ]
      } else if (arm_fpu == "vfpv3") {
        defines += [
          "CAN_USE_VFP3_INSTRUCTIONS",
          "CAN_USE_VFP32DREGS",
        ]
      } else if (arm_fpu == "neon") {
        defines += [
          "CAN_USE_VFP3_INSTRUCTIONS",
          "CAN_USE_VFP32DREGS",
          "CAN_USE_NEON",
        ]
      }
    } else {
      # These defines ares used for the ARM simulator.
      defines += [
        "CAN_USE_ARMV7_INSTRUCTIONS",
        "CAN_USE_VFP3_INSTRUCTIONS",
        "CAN_USE_VFP32DREGS",
        "USE_EABI_HARDFLOAT=0",
      ]
    }

    # TODO(jochen): Add support for arm_test_noprobe.
  }
  if (v8_target_arch == "arm64") {
    defines += [ "V8_TARGET_ARCH_ARM64" ]
  }
  if (v8_target_arch == "mipsel") {
    defines += [ "V8_TARGET_ARCH_MIPS" ]
  }
  if (v8_target_arch == "mips64el") {
    defines += [ "V8_TARGET_ARCH_MIPS64" ]
  }
  if (v8_target_arch == "x86") {
    defines += [ "V8_TARGET_ARCH_IA32" ]
  }
  if (v8_target_arch == "x64") {
    defines += [ "V8_TARGET_ARCH_X64" ]
  }
  if (is_win) {
    defines += [ "WIN32" ]
    # TODO(jochen): Support v8_enable_prof.
  }

  # TODO(jochen): Add support for compiling with simulators.

  if (is_debug) {
    # TODO(jochen): Add support for different debug optimization levels.
    defines += [
      "ENABLE_DISASSEMBLER",
      "V8_ENABLE_CHECKS",
      "OBJECT_PRINT",
      "VERIFY_HEAP",
      "DEBUG",
      "OPTIMIZED_DEBUG",
    ]
  }
}

###############################################################################
# Actions
#

action("js2c") {
  visibility = [ ":*" ]  # Only targets in this file can depend on this.

  script = "tools/js2c.py"

  # The script depends on this other script, this rule causes a rebuild if it
  # changes.
  inputs = [ "tools/jsmin.py" ]

  sources = [
    "src/macros.py",
    "src/messages.h",
    "src/runtime.js",
    "src/prologue.js",
    "src/v8natives.js",
    "src/symbol.js",
    "src/array.js",
    "src/string.js",
    "src/uri.js",
    "src/math.js",
    "src/third_party/fdlibm/fdlibm.js",
    "src/date.js",
    "src/regexp.js",
    "src/arraybuffer.js",
    "src/typedarray.js",
    "src/iterator-prototype.js",
    "src/generator.js",
    "src/object-observe.js",
    "src/collection.js",
    "src/weak-collection.js",
    "src/collection-iterator.js",
    "src/promise.js",
    "src/messages.js",
    "src/json.js",
    "src/array-iterator.js",
    "src/string-iterator.js",
    "src/debug-debugger.js",
    "src/mirror-debugger.js",
    "src/liveedit-debugger.js",
    "src/templates.js",
    "src/harmony-array.js",
    "src/harmony-typedarray.js",
  ]

  outputs = [
    "$target_gen_dir/libraries.cc",
  ]

  if (v8_enable_i18n_support) {
    sources += [ "src/i18n.js" ]
  }

  args = [
           rebase_path("$target_gen_dir/libraries.cc", root_build_dir),
           "CORE",
         ] + rebase_path(sources, root_build_dir)

  if (v8_use_external_startup_data) {
    outputs += [ "$target_gen_dir/libraries.bin" ]
    args += [
      "--startup_blob",
      rebase_path("$target_gen_dir/libraries.bin", root_build_dir),
    ]
  }
}

action("js2c_experimental") {
  visibility = [ ":*" ]  # Only targets in this file can depend on this.

  script = "tools/js2c.py"

  # The script depends on this other script, this rule causes a rebuild if it
  # changes.
  inputs = [ "tools/jsmin.py" ]

  sources = [
    "src/macros.py",
    "src/messages.h",
    "src/proxy.js",
    "src/generator.js",
    "src/harmony-atomics.js",
    "src/harmony-array-includes.js",
    "src/harmony-concat-spreadable.js",
    "src/harmony-tostring.js",
    "src/harmony-regexp.js",
    "src/harmony-reflect.js",
    "src/harmony-spread.js",
    "src/harmony-object.js",
    "src/harmony-sharedarraybuffer.js"
  ]

  outputs = [
    "$target_gen_dir/experimental-libraries.cc",
  ]

  args = [
           rebase_path("$target_gen_dir/experimental-libraries.cc",
                       root_build_dir),
           "EXPERIMENTAL",
         ] + rebase_path(sources, root_build_dir)

  if (v8_use_external_startup_data) {
    outputs += [ "$target_gen_dir/libraries_experimental.bin" ]
    args += [
      "--startup_blob",
      rebase_path("$target_gen_dir/libraries_experimental.bin", root_build_dir),
    ]
  }
}

action("js2c_extras") {
  visibility = [ ":*" ]  # Only targets in this file can depend on this.

  script = "tools/js2c.py"

  # The script depends on this other script, this rule causes a rebuild if it
  # changes.
  inputs = [ "tools/jsmin.py" ]

  sources = v8_extra_library_files

  outputs = [
    "$target_gen_dir/extras-libraries.cc",
  ]

  args = [
           rebase_path("$target_gen_dir/extras-libraries.cc",
                       root_build_dir),
           "EXTRAS",
         ] + rebase_path(sources, root_build_dir)

  if (v8_use_external_startup_data) {
    outputs += [ "$target_gen_dir/libraries_extras.bin" ]
    args += [
      "--startup_blob",
      rebase_path("$target_gen_dir/libraries_extras.bin", root_build_dir),
    ]
  }
}

action("d8_js2c") {
  visibility = [ ":*" ]  # Only targets in this file can depend on this.

  script = "tools/js2c.py"

  inputs = [
    "src/d8.js",
    "src/macros.py",
  ]

  outputs = [
    "$target_gen_dir/d8-js.cc",
  ]

  args = rebase_path(outputs, root_build_dir) + [ "D8" ] +
         rebase_path(inputs, root_build_dir)
}

if (v8_use_external_startup_data) {
  action("natives_blob") {
    visibility = [ ":*" ]  # Only targets in this file can depend on this.

    deps = [
      ":js2c",
      ":js2c_experimental",
      ":js2c_extras",
    ]

    sources = [
      "$target_gen_dir/libraries.bin",
      "$target_gen_dir/libraries_experimental.bin",
      "$target_gen_dir/libraries_extras.bin",
    ]

    outputs = [
      "$root_out_dir/natives_blob.bin",
    ]

    script = "tools/concatenate-files.py"

    args = rebase_path(sources + outputs, root_build_dir)
  }
}

action("postmortem-metadata") {
  # Only targets in this file and the top-level visibility target can
  # depend on this.
  visibility = [
    ":*",
    "//:gn_visibility",
  ]

  script = "tools/gen-postmortem-metadata.py"

  sources = [
    "src/objects.h",
    "src/objects-inl.h",
  ]

  outputs = [
    "$target_gen_dir/debug-support.cc",
  ]

  args = rebase_path(outputs, root_build_dir) +
         rebase_path(sources, root_build_dir)
}

action("run_mksnapshot") {
  visibility = [ ":*" ]  # Only targets in this file can depend on this.

  deps = [
    ":mksnapshot($snapshot_toolchain)",
  ]

  script = "tools/run.py"

  outputs = [
    "$target_gen_dir/snapshot.cc",
  ]

  args = [
    "./" + rebase_path(get_label_info(":mksnapshot($snapshot_toolchain)",
                                      "root_out_dir") + "/mksnapshot",
                       root_build_dir),
    "--log-snapshot-positions",
    "--logfile",
    rebase_path("$target_gen_dir/snapshot.log", root_build_dir),
    rebase_path("$target_gen_dir/snapshot.cc", root_build_dir),
  ]

  if (v8_random_seed != "0") {
    args += [
      "--random-seed",
      v8_random_seed,
    ]
  }

  if (v8_use_external_startup_data) {
    outputs += [ "$root_out_dir/snapshot_blob.bin" ]
    args += [
      "--startup_blob",
      rebase_path("$root_out_dir/snapshot_blob.bin", root_build_dir),
    ]
  }
}

###############################################################################
# Source Sets (aka static libraries)
#

source_set("v8_nosnapshot") {
  visibility = [ ":*" ]  # Only targets in this file can depend on this.

  deps = [
    ":js2c",
    ":js2c_experimental",
    ":js2c_extras",
    ":v8_base",
  ]

  sources = [
    "$target_gen_dir/libraries.cc",
    "$target_gen_dir/experimental-libraries.cc",
    "$target_gen_dir/extras-libraries.cc",
    "src/snapshot/snapshot-empty.cc",
  ]

  configs -= [ "//build/config/compiler:chromium_code" ]
  configs += [ "//build/config/compiler:no_chromium_code" ]
  configs += [
    ":internal_config",
    ":features",
    ":toolchain",
  ]
}

source_set("v8_snapshot") {
  # Only targets in this file and the top-level visibility target can
  # depend on this.
  visibility = [
    ":*",
    "//:gn_visibility",
  ]

  deps = [
    ":js2c",
    ":js2c_experimental",
    ":js2c_extras",
    ":v8_base",
  ]
  public_deps = [
    # This should be public so downstream targets can declare the snapshot
    # output file as their inputs.
    ":run_mksnapshot",
  ]

  sources = [
    "$target_gen_dir/libraries.cc",
    "$target_gen_dir/experimental-libraries.cc",
    "$target_gen_dir/extras-libraries.cc",
    "$target_gen_dir/snapshot.cc",
  ]

  configs -= [ "//build/config/compiler:chromium_code" ]
  configs += [ "//build/config/compiler:no_chromium_code" ]
  configs += [
    ":internal_config",
    ":features",
    ":toolchain",
  ]
}

if (v8_use_external_startup_data) {
  source_set("v8_external_snapshot") {
    visibility = [ ":*" ]  # Only targets in this file can depend on this.

    deps = [
      ":js2c",
      ":js2c_experimental",
      ":js2c_extras",
      ":v8_base",
    ]
    public_deps = [
      ":natives_blob",
      ":run_mksnapshot",
    ]

    sources = [
      "src/snapshot/natives-external.cc",
      "src/snapshot/snapshot-external.cc",
    ]

    configs -= [ "//build/config/compiler:chromium_code" ]
    configs += [ "//build/config/compiler:no_chromium_code" ]
    configs += [
      ":internal_config",
      ":features",
      ":toolchain",
    ]
  }
}

source_set("v8_base") {
  visibility = [ ":*" ]  # Only targets in this file can depend on this.

  sources = [
    "include/v8-debug.h",
    "include/v8-platform.h",
    "include/v8-profiler.h",
    "include/v8-testing.h",
    "include/v8-util.h",
    "include/v8-version.h",
    "include/v8.h",
    "include/v8config.h",
    "src/accessors.cc",
    "src/accessors.h",
    "src/allocation.cc",
    "src/allocation.h",
    "src/allocation-site-scopes.cc",
    "src/allocation-site-scopes.h",
    "src/allocation-tracker.cc",
    "src/allocation-tracker.h",
    "src/api.cc",
    "src/api.h",
    "src/api-natives.cc",
    "src/api-natives.h",
    "src/arguments.cc",
    "src/arguments.h",
    "src/assembler.cc",
    "src/assembler.h",
    "src/assert-scope.h",
    "src/assert-scope.cc",
    "src/ast-literal-reindexer.cc",
    "src/ast-literal-reindexer.h",
    "src/ast-numbering.cc",
    "src/ast-numbering.h",
    "src/ast-value-factory.cc",
    "src/ast-value-factory.h",
    "src/ast.cc",
    "src/ast.h",
    "src/background-parsing-task.cc",
    "src/background-parsing-task.h",
    "src/bailout-reason.cc",
    "src/bailout-reason.h",
    "src/basic-block-profiler.cc",
    "src/basic-block-profiler.h",
    "src/bignum-dtoa.cc",
    "src/bignum-dtoa.h",
    "src/bignum.cc",
    "src/bignum.h",
    "src/bit-vector.cc",
    "src/bit-vector.h",
    "src/bootstrapper.cc",
    "src/bootstrapper.h",
    "src/builtins.cc",
    "src/builtins.h",
    "src/bytecodes-irregexp.h",
    "src/cached-powers.cc",
    "src/cached-powers.h",
    "src/char-predicates.cc",
    "src/char-predicates-inl.h",
    "src/char-predicates.h",
    "src/checks.cc",
    "src/checks.h",
    "src/circular-queue-inl.h",
    "src/circular-queue.h",
    "src/code-factory.cc",
    "src/code-factory.h",
    "src/code-stubs.cc",
    "src/code-stubs.h",
    "src/code-stubs-hydrogen.cc",
    "src/code.h",
    "src/codegen.cc",
    "src/codegen.h",
    "src/compilation-cache.cc",
    "src/compilation-cache.h",
    "src/compilation-dependencies.cc",
    "src/compilation-dependencies.h",
    "src/compilation-statistics.cc",
    "src/compilation-statistics.h",
    "src/compiler/access-builder.cc",
    "src/compiler/access-builder.h",
    "src/compiler/all-nodes.cc",
    "src/compiler/all-nodes.h",
    "src/compiler/ast-graph-builder.cc",
    "src/compiler/ast-graph-builder.h",
    "src/compiler/ast-loop-assignment-analyzer.cc",
    "src/compiler/ast-loop-assignment-analyzer.h",
    "src/compiler/basic-block-instrumentor.cc",
    "src/compiler/basic-block-instrumentor.h",
    "src/compiler/change-lowering.cc",
    "src/compiler/change-lowering.h",
    "src/compiler/coalesced-live-ranges.cc",
    "src/compiler/coalesced-live-ranges.h",
    "src/compiler/code-generator-impl.h",
    "src/compiler/code-generator.cc",
    "src/compiler/code-generator.h",
    "src/compiler/common-node-cache.cc",
    "src/compiler/common-node-cache.h",
    "src/compiler/common-operator-reducer.cc",
    "src/compiler/common-operator-reducer.h",
    "src/compiler/common-operator.cc",
    "src/compiler/common-operator.h",
    "src/compiler/control-builders.cc",
    "src/compiler/control-builders.h",
    "src/compiler/control-equivalence.cc",
    "src/compiler/control-equivalence.h",
    "src/compiler/control-flow-optimizer.cc",
    "src/compiler/control-flow-optimizer.h",
    "src/compiler/dead-code-elimination.cc",
    "src/compiler/dead-code-elimination.h",
    "src/compiler/diamond.h",
    "src/compiler/frame.h",
    "src/compiler/frame-elider.cc",
    "src/compiler/frame-elider.h",
    "src/compiler/frame-states.cc",
    "src/compiler/frame-states.h",
    "src/compiler/gap-resolver.cc",
    "src/compiler/gap-resolver.h",
    "src/compiler/graph-builder.h",
    "src/compiler/graph-reducer.cc",
    "src/compiler/graph-reducer.h",
    "src/compiler/graph-replay.cc",
    "src/compiler/graph-replay.h",
    "src/compiler/graph-trimmer.cc",
    "src/compiler/graph-trimmer.h",
    "src/compiler/graph-visualizer.cc",
    "src/compiler/graph-visualizer.h",
    "src/compiler/graph.cc",
    "src/compiler/graph.h",
    "src/compiler/greedy-allocator.cc",
    "src/compiler/greedy-allocator.h",
    "src/compiler/instruction-codes.h",
    "src/compiler/instruction-selector-impl.h",
    "src/compiler/instruction-selector.cc",
    "src/compiler/instruction-selector.h",
    "src/compiler/instruction.cc",
    "src/compiler/instruction.h",
    "src/compiler/js-builtin-reducer.cc",
    "src/compiler/js-builtin-reducer.h",
    "src/compiler/js-context-specialization.cc",
    "src/compiler/js-context-specialization.h",
    "src/compiler/js-frame-specialization.cc",
    "src/compiler/js-frame-specialization.h",
    "src/compiler/js-generic-lowering.cc",
    "src/compiler/js-generic-lowering.h",
    "src/compiler/js-graph.cc",
    "src/compiler/js-graph.h",
    "src/compiler/js-inlining.cc",
    "src/compiler/js-inlining.h",
    "src/compiler/js-intrinsic-lowering.cc",
    "src/compiler/js-intrinsic-lowering.h",
    "src/compiler/js-operator.cc",
    "src/compiler/js-operator.h",
    "src/compiler/js-type-feedback.cc",
    "src/compiler/js-type-feedback.h",
    "src/compiler/js-typed-lowering.cc",
    "src/compiler/js-typed-lowering.h",
    "src/compiler/jump-threading.cc",
    "src/compiler/jump-threading.h",
    "src/compiler/linkage-impl.h",
    "src/compiler/linkage.cc",
    "src/compiler/linkage.h",
    "src/compiler/liveness-analyzer.cc",
    "src/compiler/liveness-analyzer.h",
    "src/compiler/load-elimination.cc",
    "src/compiler/load-elimination.h",
    "src/compiler/loop-peeling.cc",
    "src/compiler/loop-analysis.cc",
    "src/compiler/loop-analysis.h",
    "src/compiler/machine-operator-reducer.cc",
    "src/compiler/machine-operator-reducer.h",
    "src/compiler/machine-operator.cc",
    "src/compiler/machine-operator.h",
    "src/compiler/machine-type.cc",
    "src/compiler/machine-type.h",
    "src/compiler/move-optimizer.cc",
    "src/compiler/move-optimizer.h",
    "src/compiler/node-aux-data.h",
    "src/compiler/node-cache.cc",
    "src/compiler/node-cache.h",
    "src/compiler/node-marker.cc",
    "src/compiler/node-marker.h",
    "src/compiler/node-matchers.cc",
    "src/compiler/node-matchers.h",
    "src/compiler/node-properties.cc",
    "src/compiler/node-properties.h",
    "src/compiler/node.cc",
    "src/compiler/node.h",
    "src/compiler/opcodes.cc",
    "src/compiler/opcodes.h",
    "src/compiler/operator-properties.cc",
    "src/compiler/operator-properties.h",
    "src/compiler/operator.cc",
    "src/compiler/operator.h",
    "src/compiler/osr.cc",
    "src/compiler/osr.h",
    "src/compiler/pipeline.cc",
    "src/compiler/pipeline.h",
    "src/compiler/pipeline-statistics.cc",
    "src/compiler/pipeline-statistics.h",
    "src/compiler/raw-machine-assembler.cc",
    "src/compiler/raw-machine-assembler.h",
    "src/compiler/register-allocator.cc",
    "src/compiler/register-allocator.h",
    "src/compiler/register-allocator-verifier.cc",
    "src/compiler/register-allocator-verifier.h",
    "src/compiler/register-configuration.cc",
    "src/compiler/register-configuration.h",
    "src/compiler/representation-change.h",
    "src/compiler/schedule.cc",
    "src/compiler/schedule.h",
    "src/compiler/scheduler.cc",
    "src/compiler/scheduler.h",
    "src/compiler/select-lowering.cc",
    "src/compiler/select-lowering.h",
    "src/compiler/simplified-lowering.cc",
    "src/compiler/simplified-lowering.h",
    "src/compiler/simplified-operator-reducer.cc",
    "src/compiler/simplified-operator-reducer.h",
    "src/compiler/simplified-operator.cc",
    "src/compiler/simplified-operator.h",
    "src/compiler/source-position.cc",
    "src/compiler/source-position.h",
    "src/compiler/state-values-utils.cc",
    "src/compiler/state-values-utils.h",
    "src/compiler/tail-call-optimization.cc",
    "src/compiler/tail-call-optimization.h",
    "src/compiler/typer.cc",
    "src/compiler/typer.h",
    "src/compiler/value-numbering-reducer.cc",
    "src/compiler/value-numbering-reducer.h",
    "src/compiler/verifier.cc",
    "src/compiler/verifier.h",
    "src/compiler/zone-pool.cc",
    "src/compiler/zone-pool.h",
    "src/compiler.cc",
    "src/compiler.h",
    "src/contexts.cc",
    "src/contexts.h",
    "src/conversions-inl.h",
    "src/conversions.cc",
    "src/conversions.h",
    "src/counters.cc",
    "src/counters.h",
    "src/cpu-profiler-inl.h",
    "src/cpu-profiler.cc",
    "src/cpu-profiler.h",
    "src/date.cc",
    "src/date.h",
    "src/dateparser-inl.h",
    "src/dateparser.cc",
    "src/dateparser.h",
    "src/debug.cc",
    "src/debug.h",
    "src/deoptimizer.cc",
    "src/deoptimizer.h",
    "src/disasm.h",
    "src/disassembler.cc",
    "src/disassembler.h",
    "src/diy-fp.cc",
    "src/diy-fp.h",
    "src/double.h",
    "src/dtoa.cc",
    "src/dtoa.h",
    "src/effects.h",
    "src/elements-kind.cc",
    "src/elements-kind.h",
    "src/elements.cc",
    "src/elements.h",
    "src/execution.cc",
    "src/execution.h",
    "src/expression-classifier.h",
    "src/extensions/externalize-string-extension.cc",
    "src/extensions/externalize-string-extension.h",
    "src/extensions/free-buffer-extension.cc",
    "src/extensions/free-buffer-extension.h",
    "src/extensions/gc-extension.cc",
    "src/extensions/gc-extension.h",
    "src/extensions/statistics-extension.cc",
    "src/extensions/statistics-extension.h",
    "src/extensions/trigger-failure-extension.cc",
    "src/extensions/trigger-failure-extension.h",
    "src/factory.cc",
    "src/factory.h",
    "src/fast-dtoa.cc",
    "src/fast-dtoa.h",
    "src/field-index.h",
    "src/field-index-inl.h",
    "src/fixed-dtoa.cc",
    "src/fixed-dtoa.h",
    "src/flag-definitions.h",
    "src/flags.cc",
    "src/flags.h",
    "src/frames-inl.h",
    "src/frames.cc",
    "src/frames.h",
    "src/full-codegen.cc",
    "src/full-codegen.h",
    "src/func-name-inferrer.cc",
    "src/func-name-inferrer.h",
    "src/gdb-jit.cc",
    "src/gdb-jit.h",
    "src/global-handles.cc",
    "src/global-handles.h",
    "src/globals.h",
    "src/handles-inl.h",
    "src/handles.cc",
    "src/handles.h",
    "src/hashmap.h",
    "src/heap-profiler.cc",
    "src/heap-profiler.h",
    "src/heap-snapshot-generator-inl.h",
    "src/heap-snapshot-generator.cc",
    "src/heap-snapshot-generator.h",
    "src/heap/gc-idle-time-handler.cc",
    "src/heap/gc-idle-time-handler.h",
    "src/heap/gc-tracer.cc",
    "src/heap/gc-tracer.h",
    "src/heap/heap-inl.h",
    "src/heap/heap.cc",
    "src/heap/heap.h",
    "src/heap/identity-map.cc",
    "src/heap/identity-map.h",
    "src/heap/incremental-marking.cc",
    "src/heap/incremental-marking.h",
    "src/heap/mark-compact-inl.h",
    "src/heap/mark-compact.cc",
    "src/heap/mark-compact.h",
    "src/heap/memory-reducer.cc",
    "src/heap/memory-reducer.h",
    "src/heap/objects-visiting-inl.h",
    "src/heap/objects-visiting.cc",
    "src/heap/objects-visiting.h",
    "src/heap/spaces-inl.h",
    "src/heap/spaces.cc",
    "src/heap/spaces.h",
    "src/heap/store-buffer-inl.h",
    "src/heap/store-buffer.cc",
    "src/heap/store-buffer.h",
    "src/hydrogen-alias-analysis.h",
    "src/hydrogen-bce.cc",
    "src/hydrogen-bce.h",
    "src/hydrogen-bch.cc",
    "src/hydrogen-bch.h",
    "src/hydrogen-canonicalize.cc",
    "src/hydrogen-canonicalize.h",
    "src/hydrogen-check-elimination.cc",
    "src/hydrogen-check-elimination.h",
    "src/hydrogen-dce.cc",
    "src/hydrogen-dce.h",
    "src/hydrogen-dehoist.cc",
    "src/hydrogen-dehoist.h",
    "src/hydrogen-environment-liveness.cc",
    "src/hydrogen-environment-liveness.h",
    "src/hydrogen-escape-analysis.cc",
    "src/hydrogen-escape-analysis.h",
    "src/hydrogen-flow-engine.h",
    "src/hydrogen-instructions.cc",
    "src/hydrogen-instructions.h",
    "src/hydrogen.cc",
    "src/hydrogen.h",
    "src/hydrogen-gvn.cc",
    "src/hydrogen-gvn.h",
    "src/hydrogen-infer-representation.cc",
    "src/hydrogen-infer-representation.h",
    "src/hydrogen-infer-types.cc",
    "src/hydrogen-infer-types.h",
    "src/hydrogen-load-elimination.cc",
    "src/hydrogen-load-elimination.h",
    "src/hydrogen-mark-deoptimize.cc",
    "src/hydrogen-mark-deoptimize.h",
    "src/hydrogen-mark-unreachable.cc",
    "src/hydrogen-mark-unreachable.h",
    "src/hydrogen-osr.cc",
    "src/hydrogen-osr.h",
    "src/hydrogen-range-analysis.cc",
    "src/hydrogen-range-analysis.h",
    "src/hydrogen-redundant-phi.cc",
    "src/hydrogen-redundant-phi.h",
    "src/hydrogen-removable-simulates.cc",
    "src/hydrogen-removable-simulates.h",
    "src/hydrogen-representation-changes.cc",
    "src/hydrogen-representation-changes.h",
    "src/hydrogen-sce.cc",
    "src/hydrogen-sce.h",
    "src/hydrogen-store-elimination.cc",
    "src/hydrogen-store-elimination.h",
    "src/hydrogen-types.cc",
    "src/hydrogen-types.h",
    "src/hydrogen-uint32-analysis.cc",
    "src/hydrogen-uint32-analysis.h",
    "src/i18n.cc",
    "src/i18n.h",
    "src/icu_util.cc",
    "src/icu_util.h",
    "src/ic/access-compiler.cc",
    "src/ic/access-compiler.h",
    "src/ic/call-optimization.cc",
    "src/ic/call-optimization.h",
    "src/ic/handler-compiler.cc",
    "src/ic/handler-compiler.h",
    "src/ic/ic-inl.h",
    "src/ic/ic-state.cc",
    "src/ic/ic-state.h",
    "src/ic/ic.cc",
    "src/ic/ic.h",
    "src/ic/ic-compiler.cc",
    "src/ic/ic-compiler.h",
    "src/ic/stub-cache.cc",
    "src/ic/stub-cache.h",
    "src/interface-descriptors.cc",
    "src/interface-descriptors.h",
    "src/interpreter-irregexp.cc",
    "src/interpreter-irregexp.h",
    "src/isolate.cc",
    "src/isolate.h",
    "src/json-parser.h",
    "src/json-stringifier.h",
    "src/jsregexp-inl.h",
    "src/jsregexp.cc",
    "src/jsregexp.h",
    "src/layout-descriptor-inl.h",
    "src/layout-descriptor.cc",
    "src/layout-descriptor.h",
    "src/list-inl.h",
    "src/list.h",
    "src/lithium-allocator-inl.h",
    "src/lithium-allocator.cc",
    "src/lithium-allocator.h",
    "src/lithium-codegen.cc",
    "src/lithium-codegen.h",
    "src/lithium.cc",
    "src/lithium.h",
    "src/liveedit.cc",
    "src/liveedit.h",
    "src/log-inl.h",
    "src/log-utils.cc",
    "src/log-utils.h",
    "src/log.cc",
    "src/log.h",
    "src/lookup-inl.h",
    "src/lookup.cc",
    "src/lookup.h",
    "src/macro-assembler.h",
    "src/messages.cc",
    "src/messages.h",
    "src/modules.cc",
    "src/modules.h",
    "src/msan.h",
    "src/objects-debug.cc",
    "src/objects-inl.h",
    "src/objects-printer.cc",
    "src/objects.cc",
    "src/objects.h",
    "src/optimizing-compile-dispatcher.cc",
    "src/optimizing-compile-dispatcher.h",
    "src/ostreams.cc",
    "src/ostreams.h",
    "src/pattern-rewriter.cc",
    "src/parser.cc",
    "src/parser.h",
    "src/pending-compilation-error-handler.cc",
    "src/pending-compilation-error-handler.h",
    "src/preparse-data-format.h",
    "src/preparse-data.cc",
    "src/preparse-data.h",
    "src/preparser.cc",
    "src/preparser.h",
    "src/prettyprinter.cc",
    "src/prettyprinter.h",
    "src/profile-generator-inl.h",
    "src/profile-generator.cc",
    "src/profile-generator.h",
    "src/property-details.h",
    "src/property.cc",
    "src/property.h",
    "src/prototype.h",
    "src/regexp-macro-assembler-irregexp-inl.h",
    "src/regexp-macro-assembler-irregexp.cc",
    "src/regexp-macro-assembler-irregexp.h",
    "src/regexp-macro-assembler-tracer.cc",
    "src/regexp-macro-assembler-tracer.h",
    "src/regexp-macro-assembler.cc",
    "src/regexp-macro-assembler.h",
    "src/regexp-stack.cc",
    "src/regexp-stack.h",
    "src/rewriter.cc",
    "src/rewriter.h",
    "src/runtime-profiler.cc",
    "src/runtime-profiler.h",
    "src/runtime/runtime-array.cc",
    "src/runtime/runtime-atomics.cc",
    "src/runtime/runtime-classes.cc",
    "src/runtime/runtime-collections.cc",
    "src/runtime/runtime-compiler.cc",
    "src/runtime/runtime-date.cc",
    "src/runtime/runtime-debug.cc",
    "src/runtime/runtime-forin.cc",
    "src/runtime/runtime-function.cc",
    "src/runtime/runtime-generator.cc",
    "src/runtime/runtime-i18n.cc",
    "src/runtime/runtime-internal.cc",
    "src/runtime/runtime-json.cc",
    "src/runtime/runtime-literals.cc",
    "src/runtime/runtime-liveedit.cc",
    "src/runtime/runtime-maths.cc",
    "src/runtime/runtime-numbers.cc",
    "src/runtime/runtime-object.cc",
    "src/runtime/runtime-observe.cc",
    "src/runtime/runtime-proxy.cc",
    "src/runtime/runtime-regexp.cc",
    "src/runtime/runtime-scopes.cc",
    "src/runtime/runtime-strings.cc",
    "src/runtime/runtime-symbol.cc",
    "src/runtime/runtime-test.cc",
    "src/runtime/runtime-typedarray.cc",
    "src/runtime/runtime-uri.cc",
    "src/runtime/runtime-utils.h",
    "src/runtime/runtime.cc",
    "src/runtime/runtime.h",
    "src/safepoint-table.cc",
    "src/safepoint-table.h",
    "src/sampler.cc",
    "src/sampler.h",
    "src/scanner-character-streams.cc",
    "src/scanner-character-streams.h",
    "src/scanner.cc",
    "src/scanner.h",
    "src/scopeinfo.cc",
    "src/scopeinfo.h",
    "src/scopes.cc",
    "src/scopes.h",
    "src/signature.h",
    "src/simulator.h",
    "src/small-pointer-list.h",
    "src/smart-pointers.h",
    "src/snapshot/natives.h",
    "src/snapshot/serialize.cc",
    "src/snapshot/serialize.h",
    "src/snapshot/snapshot-common.cc",
    "src/snapshot/snapshot-source-sink.cc",
    "src/snapshot/snapshot-source-sink.h",
    "src/splay-tree.h",
    "src/splay-tree-inl.h",
    "src/snapshot/snapshot.h",
    "src/startup-data-util.h",
    "src/startup-data-util.cc",
    "src/string-builder.cc",
    "src/string-builder.h",
    "src/string-search.cc",
    "src/string-search.h",
    "src/string-stream.cc",
    "src/string-stream.h",
    "src/strings-storage.cc",
    "src/strings-storage.h",
    "src/strtod.cc",
    "src/strtod.h",
    "src/token.cc",
    "src/token.h",
    "src/transitions-inl.h",
    "src/transitions.cc",
    "src/transitions.h",
    "src/type-feedback-vector-inl.h",
    "src/type-feedback-vector.cc",
    "src/type-feedback-vector.h",
    "src/type-info.cc",
    "src/type-info.h",
    "src/types-inl.h",
    "src/types.cc",
    "src/types.h",
    "src/typing.cc",
    "src/typing.h",
    "src/unbound-queue-inl.h",
    "src/unbound-queue.h",
    "src/unicode-inl.h",
    "src/unicode.cc",
    "src/unicode.h",
    "src/unicode-decoder.cc",
    "src/unicode-decoder.h",
    "src/unique.h",
    "src/utils.cc",
    "src/utils.h",
    "src/v8.cc",
    "src/v8.h",
    "src/v8memory.h",
    "src/v8threads.cc",
    "src/v8threads.h",
    "src/variables.cc",
    "src/variables.h",
    "src/version.cc",
    "src/version.h",
    "src/vm-state-inl.h",
    "src/vm-state.h",
    "src/zone.cc",
    "src/zone.h",
    "src/zone-allocator.h",
    "src/zone-containers.h",
    "src/third_party/fdlibm/fdlibm.cc",
    "src/third_party/fdlibm/fdlibm.h",
  ]

  if (v8_target_arch == "x86") {
    sources += [
      "src/ia32/assembler-ia32-inl.h",
      "src/ia32/assembler-ia32.cc",
      "src/ia32/assembler-ia32.h",
      "src/ia32/builtins-ia32.cc",
      "src/ia32/code-stubs-ia32.cc",
      "src/ia32/code-stubs-ia32.h",
      "src/ia32/codegen-ia32.cc",
      "src/ia32/codegen-ia32.h",
      "src/ia32/cpu-ia32.cc",
      "src/ia32/debug-ia32.cc",
      "src/ia32/deoptimizer-ia32.cc",
      "src/ia32/disasm-ia32.cc",
      "src/ia32/frames-ia32.cc",
      "src/ia32/frames-ia32.h",
      "src/ia32/full-codegen-ia32.cc",
      "src/ia32/interface-descriptors-ia32.cc",
      "src/ia32/lithium-codegen-ia32.cc",
      "src/ia32/lithium-codegen-ia32.h",
      "src/ia32/lithium-gap-resolver-ia32.cc",
      "src/ia32/lithium-gap-resolver-ia32.h",
      "src/ia32/lithium-ia32.cc",
      "src/ia32/lithium-ia32.h",
      "src/ia32/macro-assembler-ia32.cc",
      "src/ia32/macro-assembler-ia32.h",
      "src/ia32/regexp-macro-assembler-ia32.cc",
      "src/ia32/regexp-macro-assembler-ia32.h",
      "src/compiler/ia32/code-generator-ia32.cc",
      "src/compiler/ia32/instruction-codes-ia32.h",
      "src/compiler/ia32/instruction-selector-ia32.cc",
      "src/compiler/ia32/linkage-ia32.cc",
      "src/ic/ia32/access-compiler-ia32.cc",
      "src/ic/ia32/handler-compiler-ia32.cc",
      "src/ic/ia32/ic-ia32.cc",
      "src/ic/ia32/ic-compiler-ia32.cc",
      "src/ic/ia32/stub-cache-ia32.cc",
    ]
  } else if (v8_target_arch == "x64") {
    sources += [
      "src/x64/assembler-x64-inl.h",
      "src/x64/assembler-x64.cc",
      "src/x64/assembler-x64.h",
      "src/x64/builtins-x64.cc",
      "src/x64/code-stubs-x64.cc",
      "src/x64/code-stubs-x64.h",
      "src/x64/codegen-x64.cc",
      "src/x64/codegen-x64.h",
      "src/x64/cpu-x64.cc",
      "src/x64/debug-x64.cc",
      "src/x64/deoptimizer-x64.cc",
      "src/x64/disasm-x64.cc",
      "src/x64/frames-x64.cc",
      "src/x64/frames-x64.h",
      "src/x64/full-codegen-x64.cc",
      "src/x64/interface-descriptors-x64.cc",
      "src/x64/lithium-codegen-x64.cc",
      "src/x64/lithium-codegen-x64.h",
      "src/x64/lithium-gap-resolver-x64.cc",
      "src/x64/lithium-gap-resolver-x64.h",
      "src/x64/lithium-x64.cc",
      "src/x64/lithium-x64.h",
      "src/x64/macro-assembler-x64.cc",
      "src/x64/macro-assembler-x64.h",
      "src/x64/regexp-macro-assembler-x64.cc",
      "src/x64/regexp-macro-assembler-x64.h",
      "src/compiler/x64/code-generator-x64.cc",
      "src/compiler/x64/instruction-codes-x64.h",
      "src/compiler/x64/instruction-selector-x64.cc",
      "src/compiler/x64/linkage-x64.cc",
      "src/ic/x64/access-compiler-x64.cc",
      "src/ic/x64/handler-compiler-x64.cc",
      "src/ic/x64/ic-x64.cc",
      "src/ic/x64/ic-compiler-x64.cc",
      "src/ic/x64/stub-cache-x64.cc",
    ]
  } else if (v8_target_arch == "arm") {
    sources += [
      "src/arm/assembler-arm-inl.h",
      "src/arm/assembler-arm.cc",
      "src/arm/assembler-arm.h",
      "src/arm/builtins-arm.cc",
      "src/arm/code-stubs-arm.cc",
      "src/arm/code-stubs-arm.h",
      "src/arm/codegen-arm.cc",
      "src/arm/codegen-arm.h",
      "src/arm/constants-arm.h",
      "src/arm/constants-arm.cc",
      "src/arm/cpu-arm.cc",
      "src/arm/debug-arm.cc",
      "src/arm/deoptimizer-arm.cc",
      "src/arm/disasm-arm.cc",
      "src/arm/frames-arm.cc",
      "src/arm/frames-arm.h",
      "src/arm/full-codegen-arm.cc",
      "src/arm/interface-descriptors-arm.cc",
      "src/arm/interface-descriptors-arm.h",
      "src/arm/lithium-arm.cc",
      "src/arm/lithium-arm.h",
      "src/arm/lithium-codegen-arm.cc",
      "src/arm/lithium-codegen-arm.h",
      "src/arm/lithium-gap-resolver-arm.cc",
      "src/arm/lithium-gap-resolver-arm.h",
      "src/arm/macro-assembler-arm.cc",
      "src/arm/macro-assembler-arm.h",
      "src/arm/regexp-macro-assembler-arm.cc",
      "src/arm/regexp-macro-assembler-arm.h",
      "src/arm/simulator-arm.cc",
      "src/arm/simulator-arm.h",
      "src/compiler/arm/code-generator-arm.cc",
      "src/compiler/arm/instruction-codes-arm.h",
      "src/compiler/arm/instruction-selector-arm.cc",
      "src/compiler/arm/linkage-arm.cc",
      "src/ic/arm/access-compiler-arm.cc",
      "src/ic/arm/handler-compiler-arm.cc",
      "src/ic/arm/ic-arm.cc",
      "src/ic/arm/ic-compiler-arm.cc",
      "src/ic/arm/stub-cache-arm.cc",
    ]
  } else if (v8_target_arch == "arm64") {
    sources += [
      "src/arm64/assembler-arm64.cc",
      "src/arm64/assembler-arm64.h",
      "src/arm64/assembler-arm64-inl.h",
      "src/arm64/builtins-arm64.cc",
      "src/arm64/codegen-arm64.cc",
      "src/arm64/codegen-arm64.h",
      "src/arm64/code-stubs-arm64.cc",
      "src/arm64/code-stubs-arm64.h",
      "src/arm64/constants-arm64.h",
      "src/arm64/cpu-arm64.cc",
      "src/arm64/debug-arm64.cc",
      "src/arm64/decoder-arm64.cc",
      "src/arm64/decoder-arm64.h",
      "src/arm64/decoder-arm64-inl.h",
      "src/arm64/deoptimizer-arm64.cc",
      "src/arm64/disasm-arm64.cc",
      "src/arm64/disasm-arm64.h",
      "src/arm64/frames-arm64.cc",
      "src/arm64/frames-arm64.h",
      "src/arm64/full-codegen-arm64.cc",
      "src/arm64/instructions-arm64.cc",
      "src/arm64/instructions-arm64.h",
      "src/arm64/instrument-arm64.cc",
      "src/arm64/instrument-arm64.h",
      "src/arm64/interface-descriptors-arm64.cc",
      "src/arm64/interface-descriptors-arm64.h",
      "src/arm64/lithium-arm64.cc",
      "src/arm64/lithium-arm64.h",
      "src/arm64/lithium-codegen-arm64.cc",
      "src/arm64/lithium-codegen-arm64.h",
      "src/arm64/lithium-gap-resolver-arm64.cc",
      "src/arm64/lithium-gap-resolver-arm64.h",
      "src/arm64/macro-assembler-arm64.cc",
      "src/arm64/macro-assembler-arm64.h",
      "src/arm64/macro-assembler-arm64-inl.h",
      "src/arm64/regexp-macro-assembler-arm64.cc",
      "src/arm64/regexp-macro-assembler-arm64.h",
      "src/arm64/simulator-arm64.cc",
      "src/arm64/simulator-arm64.h",
      "src/arm64/utils-arm64.cc",
      "src/arm64/utils-arm64.h",
      "src/compiler/arm64/code-generator-arm64.cc",
      "src/compiler/arm64/instruction-codes-arm64.h",
      "src/compiler/arm64/instruction-selector-arm64.cc",
      "src/compiler/arm64/linkage-arm64.cc",
      "src/ic/arm64/access-compiler-arm64.cc",
      "src/ic/arm64/handler-compiler-arm64.cc",
      "src/ic/arm64/ic-arm64.cc",
      "src/ic/arm64/ic-compiler-arm64.cc",
      "src/ic/arm64/stub-cache-arm64.cc",
    ]
  } else if (v8_target_arch == "mipsel") {
    sources += [
      "src/mips/assembler-mips.cc",
      "src/mips/assembler-mips.h",
      "src/mips/assembler-mips-inl.h",
      "src/mips/builtins-mips.cc",
      "src/mips/codegen-mips.cc",
      "src/mips/codegen-mips.h",
      "src/mips/code-stubs-mips.cc",
      "src/mips/code-stubs-mips.h",
      "src/mips/constants-mips.cc",
      "src/mips/constants-mips.h",
      "src/mips/cpu-mips.cc",
      "src/mips/debug-mips.cc",
      "src/mips/deoptimizer-mips.cc",
      "src/mips/disasm-mips.cc",
      "src/mips/frames-mips.cc",
      "src/mips/frames-mips.h",
      "src/mips/full-codegen-mips.cc",
      "src/mips/interface-descriptors-mips.cc",
      "src/mips/lithium-codegen-mips.cc",
      "src/mips/lithium-codegen-mips.h",
      "src/mips/lithium-gap-resolver-mips.cc",
      "src/mips/lithium-gap-resolver-mips.h",
      "src/mips/lithium-mips.cc",
      "src/mips/lithium-mips.h",
      "src/mips/macro-assembler-mips.cc",
      "src/mips/macro-assembler-mips.h",
      "src/mips/regexp-macro-assembler-mips.cc",
      "src/mips/regexp-macro-assembler-mips.h",
      "src/mips/simulator-mips.cc",
      "src/mips/simulator-mips.h",
      "src/compiler/mips/code-generator-mips.cc",
      "src/compiler/mips/instruction-codes-mips.h",
      "src/compiler/mips/instruction-selector-mips.cc",
      "src/compiler/mips/linkage-mips.cc",
      "src/ic/mips/access-compiler-mips.cc",
      "src/ic/mips/handler-compiler-mips.cc",
      "src/ic/mips/ic-mips.cc",
      "src/ic/mips/ic-compiler-mips.cc",
      "src/ic/mips/stub-cache-mips.cc",
    ]
  } else if (v8_target_arch == "mips64el") {
    sources += [
      "src/mips64/assembler-mips64.cc",
      "src/mips64/assembler-mips64.h",
      "src/mips64/assembler-mips64-inl.h",
      "src/mips64/builtins-mips64.cc",
      "src/mips64/codegen-mips64.cc",
      "src/mips64/codegen-mips64.h",
      "src/mips64/code-stubs-mips64.cc",
      "src/mips64/code-stubs-mips64.h",
      "src/mips64/constants-mips64.cc",
      "src/mips64/constants-mips64.h",
      "src/mips64/cpu-mips64.cc",
      "src/mips64/debug-mips64.cc",
      "src/mips64/deoptimizer-mips64.cc",
      "src/mips64/disasm-mips64.cc",
      "src/mips64/frames-mips64.cc",
      "src/mips64/frames-mips64.h",
      "src/mips64/full-codegen-mips64.cc",
      "src/mips64/interface-descriptors-mips64.cc",
      "src/mips64/lithium-codegen-mips64.cc",
      "src/mips64/lithium-codegen-mips64.h",
      "src/mips64/lithium-gap-resolver-mips64.cc",
      "src/mips64/lithium-gap-resolver-mips64.h",
      "src/mips64/lithium-mips64.cc",
      "src/mips64/lithium-mips64.h",
      "src/mips64/macro-assembler-mips64.cc",
      "src/mips64/macro-assembler-mips64.h",
      "src/mips64/regexp-macro-assembler-mips64.cc",
      "src/mips64/regexp-macro-assembler-mips64.h",
      "src/mips64/simulator-mips64.cc",
      "src/mips64/simulator-mips64.h",
      "src/ic/mips64/access-compiler-mips64.cc",
      "src/ic/mips64/handler-compiler-mips64.cc",
      "src/ic/mips64/ic-mips64.cc",
      "src/ic/mips64/ic-compiler-mips64.cc",
      "src/ic/mips64/stub-cache-mips64.cc",
    ]
  }

  configs -= [ "//build/config/compiler:chromium_code" ]
  configs += [ "//build/config/compiler:no_chromium_code" ]
  configs += [
    ":internal_config",
    ":features",
    ":toolchain",
  ]

  if (!is_debug) {
    configs -= [ "//build/config/compiler:optimize" ]
    configs += [ "//build/config/compiler:optimize_max" ]
  }

  defines = []
  deps = [
    ":v8_libbase",
  ]

  if (is_win) {
    # TODO(jschuh): crbug.com/167187 fix size_t to int truncations.
    cflags = [ "/wd4267" ]
  }

  if (v8_enable_i18n_support) {
    deps += [ "//third_party/icu" ]
    if (is_win) {
      deps += [ "//third_party/icu:icudata" ]
    }

    # TODO(jochen): Add support for icu_use_data_file_flag
    defines += [ "ICU_UTIL_DATA_IMPL=ICU_UTIL_DATA_FILE" ]
  } else {
    sources -= [
      "src/i18n.cc",
      "src/i18n.h",
    ]
  }

  if (v8_postmortem_support) {
    sources += [ "$target_gen_dir/debug-support.cc" ]
    deps += [ ":postmortem-metadata" ]
  }
}

source_set("v8_libbase") {
  visibility = [ ":*" ]  # Only targets in this file can depend on this.

  sources = [
    "src/base/adapters.h",
    "src/base/atomicops.h",
    "src/base/atomicops_internals_arm64_gcc.h",
    "src/base/atomicops_internals_arm_gcc.h",
    "src/base/atomicops_internals_atomicword_compat.h",
    "src/base/atomicops_internals_mac.h",
    "src/base/atomicops_internals_mips_gcc.h",
    "src/base/atomicops_internals_mips64_gcc.h",
    "src/base/atomicops_internals_portable.h",
    "src/base/atomicops_internals_tsan.h",
    "src/base/atomicops_internals_x86_gcc.cc",
    "src/base/atomicops_internals_x86_gcc.h",
    "src/base/atomicops_internals_x86_msvc.h",
    "src/base/bits.cc",
    "src/base/bits.h",
    "src/base/build_config.h",
    "src/base/cpu.cc",
    "src/base/cpu.h",
    "src/base/division-by-constant.cc",
    "src/base/division-by-constant.h",
    "src/base/flags.h",
    "src/base/functional.cc",
    "src/base/functional.h",
    "src/base/iterator.h",
    "src/base/lazy-instance.h",
    "src/base/logging.cc",
    "src/base/logging.h",
    "src/base/macros.h",
    "src/base/once.cc",
    "src/base/once.h",
    "src/base/platform/elapsed-timer.h",
    "src/base/platform/time.cc",
    "src/base/platform/time.h",
    "src/base/platform/condition-variable.cc",
    "src/base/platform/condition-variable.h",
    "src/base/platform/mutex.cc",
    "src/base/platform/mutex.h",
    "src/base/platform/platform.h",
    "src/base/platform/semaphore.cc",
    "src/base/platform/semaphore.h",
    "src/base/safe_conversions.h",
    "src/base/safe_conversions_impl.h",
    "src/base/safe_math.h",
    "src/base/safe_math_impl.h",
    "src/base/sys-info.cc",
    "src/base/sys-info.h",
    "src/base/utils/random-number-generator.cc",
    "src/base/utils/random-number-generator.h",
  ]

  configs -= [ "//build/config/compiler:chromium_code" ]
  configs += [ "//build/config/compiler:no_chromium_code" ]
  configs += [
    ":internal_config_base",
    ":features",
    ":toolchain",
  ]

  if (!is_debug) {
    configs -= [ "//build/config/compiler:optimize" ]
    configs += [ "//build/config/compiler:optimize_max" ]
  }

  defines = []

  if (is_posix) {
    sources += [ "src/base/platform/platform-posix.cc" ]
  }

  if (is_linux) {
    sources += [ "src/base/platform/platform-linux.cc" ]

    libs = [ "dl", "rt" ]
  } else if (is_android) {
    defines += [ "CAN_USE_VFP_INSTRUCTIONS" ]

    if (current_toolchain == host_toolchain) {
      libs = [ "dl", "rt" ]
      if (host_os == "mac") {
        sources += [ "src/base/platform/platform-macos.cc" ]
      } else {
        sources += [ "src/base/platform/platform-linux.cc" ]
      }
    } else {
      sources += [ "src/base/platform/platform-linux.cc" ]
    }
  } else if (is_mac) {
    sources += [ "src/base/platform/platform-macos.cc" ]
  } else if (is_win) {
    # TODO(jochen): Add support for cygwin.
    sources += [
      "src/base/platform/platform-win32.cc",
      "src/base/win32-headers.h",
    ]

    defines += [ "_CRT_RAND_S" ]  # for rand_s()

    libs = [
      "winmm.lib",
      "ws2_32.lib",
    ]
  }

  # TODO(jochen): Add support for qnx, freebsd, openbsd, netbsd, and solaris.
}

source_set("v8_libplatform") {
  sources = [
    "include/libplatform/libplatform.h",
    "src/libplatform/default-platform.cc",
    "src/libplatform/default-platform.h",
    "src/libplatform/task-queue.cc",
    "src/libplatform/task-queue.h",
    "src/libplatform/worker-thread.cc",
    "src/libplatform/worker-thread.h",
  ]

  configs -= [ "//build/config/compiler:chromium_code" ]
  configs += [ "//build/config/compiler:no_chromium_code" ]
  configs += [
    ":internal_config_base",
    ":features",
    ":toolchain",
  ]

  if (!is_debug) {
    configs -= [ "//build/config/compiler:optimize" ]
    configs += [ "//build/config/compiler:optimize_max" ]
  }

  deps = [
    ":v8_libbase",
  ]
}

###############################################################################
# Executables
#

if (current_toolchain == snapshot_toolchain) {
  executable("mksnapshot") {
    visibility = [ ":*" ]  # Only targets in this file can depend on this.

    sources = [
      "src/snapshot/mksnapshot.cc",
    ]

    configs -= [ "//build/config/compiler:chromium_code" ]
    configs += [ "//build/config/compiler:no_chromium_code" ]
    configs += [
      ":internal_config",
      ":features",
      ":toolchain",
    ]

    deps = [
      ":v8_base",
      ":v8_libplatform",
      ":v8_nosnapshot",
      "//build/config/sanitizers:deps",
    ]
  }
}

###############################################################################
# Public targets
#

if (is_component_build) {
  component("v8") {
    sources = [
      "src/v8dll-main.cc",
    ]

    if (v8_use_snapshot && v8_use_external_startup_data) {
      deps = [
        ":v8_base",
      ]
      public_deps = [
        ":v8_external_snapshot",
      ]
    } else if (v8_use_snapshot) {
      deps = [
        ":v8_base",
      ]
      # v8_snapshot should be public so downstream targets can declare the
      # snapshot file as their input.
      public_deps = [
        ":v8_snapshot",
      ]
    } else {
      assert(!v8_use_external_startup_data)
      deps = [
        ":v8_base",
        ":v8_nosnapshot",
      ]
    }

    configs -= [ "//build/config/compiler:chromium_code" ]
    configs += [ "//build/config/compiler:no_chromium_code" ]
    configs += [
      ":internal_config",
      ":features",
      ":toolchain",
    ]

    public_configs = [ ":external_config" ]

    libs = []
    if (is_android && current_toolchain != host_toolchain) {
      libs += [ "log" ]
    }
  }
} else {
  group("v8") {
    if (v8_use_snapshot && v8_use_external_startup_data) {
      deps = [
        ":v8_base",
        ":v8_external_snapshot",
      ]
    } else if (v8_use_snapshot) {
      deps = [
        ":v8_base",
      ]
      public_deps = [
        ":v8_snapshot",
      ]
    } else {
      assert(!v8_use_external_startup_data)
      deps = [
        ":v8_base",
        ":v8_nosnapshot",
      ]
    }

    public_configs = [ ":external_config" ]
  }
}

if ((current_toolchain == host_toolchain && v8_toolset_for_d8 == "host") ||
    (current_toolchain != host_toolchain && v8_toolset_for_d8 == "target")) {
  executable("d8") {
    sources = [
      "src/d8.cc",
      "src/d8.h",
    ]

    configs -= [ "//build/config/compiler:chromium_code" ]
    configs += [ "//build/config/compiler:no_chromium_code" ]
    configs += [
      # Note: don't use :internal_config here because this target will get
      # the :external_config applied to it by virtue of depending on :v8, and
      # you can't have both applied to the same target.
      ":internal_config_base",
      ":features",
      ":toolchain",
    ]

    deps = [
      ":d8_js2c",
      ":v8",
      ":v8_libplatform",
      "//build/config/sanitizers:deps",
    ]

    # TODO(jochen): Add support for readline and vtunejit.

    if (is_posix) {
      sources += [ "src/d8-posix.cc" ]
    } else if (is_win) {
      sources += [ "src/d8-windows.cc" ]
    }

    if (!is_component_build) {
      sources += [
        "src/d8-debug.cc",
        "src/d8-debug.h",
        "$target_gen_dir/d8-js.cc",
      ]
    }
    if (v8_enable_i18n_support) {
      deps += [ "//third_party/icu" ]
    }
  }
}
node-v4.8.2/deps/v8/ChangeLog000644 000766 000024 00001113111 13070706732 016016 0ustar00iojsstaff000000 000000 2015-07-08: Version 4.5.103

        Performance and stability improvements on all platforms.


2015-07-08: Version 4.5.102

        Performance and stability improvements on all platforms.


2015-07-07: Version 4.5.101

        Move compatible receiver check from CompileHandler to UpdateCaches
        (Chromium issue 505374).

        Performance and stability improvements on all platforms.


2015-07-07: Version 4.5.100

        Performance and stability improvements on all platforms.


2015-07-07: Version 4.5.99

        unicode-decoder: fix out-of-band write in utf16 (issue 4274).

        Performance and stability improvements on all platforms.


2015-07-06: Version 4.5.98

        Performance and stability improvements on all platforms.


2015-07-04: Version 4.5.97

        Performance and stability improvements on all platforms.


2015-07-03: Version 4.5.96

        Performance and stability improvements on all platforms.


2015-07-03: Version 4.5.95

        Performance and stability improvements on all platforms.


2015-07-02: Version 4.5.94

        Performance and stability improvements on all platforms.


2015-07-02: Version 4.5.93

        Include Harmony Array/TypedArray methods unconditionally (Chromium issue
        504629).

        Performance and stability improvements on all platforms.


2015-07-02: Version 4.5.92

        Performance and stability improvements on all platforms.


2015-07-01: Version 4.5.91

        Performance and stability improvements on all platforms.


2015-07-01: Version 4.5.90

        Performance and stability improvements on all platforms.


2015-07-01: Version 4.5.89

        Performance and stability improvements on all platforms.


2015-06-30: Version 4.5.88

        Performance and stability improvements on all platforms.


2015-06-30: Version 4.5.87

        Performance and stability improvements on all platforms.


2015-06-30: Version 4.5.86

        Ensure mjsunit tests use dashes not underscores in flags directives
        (Chromium issue 505228).

        Performance and stability improvements on all platforms.


2015-06-29: Version 4.5.85

        Fix flag convention in handle count tests and comment (Chromium issue
        505228).

        Performance and stability improvements on all platforms.


2015-06-29: Version 4.5.84

        Performance and stability improvements on all platforms.


2015-06-27: Version 4.5.83

        Performance and stability improvements on all platforms.


2015-06-26: Version 4.5.82

        Performance and stability improvements on all platforms.


2015-06-26: Version 4.5.81

        Remove obsolete options in ScriptCompiler::CompileOptions (Chromium
        issue 399580).

        Performance and stability improvements on all platforms.


2015-06-25: Version 4.5.80

        Performance and stability improvements on all platforms.


2015-06-25: Version 4.5.79

        Performance and stability improvements on all platforms.


2015-06-25: Version 4.5.78

        Serializer: clear next link in weak cells (Chromium issue 503552).

        Performance and stability improvements on all platforms.


2015-06-24: Version 4.5.77

        Performance and stability improvements on all platforms.


2015-06-24: Version 4.5.76

        Performance and stability improvements on all platforms.


2015-06-24: Version 4.5.75

        Date() should not depend on Date.prototype.toString (issue 4225).

        Performance and stability improvements on all platforms.


2015-06-23: Version 4.5.74

        Expose Map/Set methods through the API (issue 3340).

        [turbofan] NaN is never truish (issue 4207).

        Performance and stability improvements on all platforms.


2015-06-23: Version 4.5.73

        Re-ship Harmony Array/TypedArray methods (issue 3578).

        Performance and stability improvements on all platforms.


2015-06-23: Version 4.5.72

        Performance and stability improvements on all platforms.


2015-06-23: Version 4.5.71

        Performance and stability improvements on all platforms.


2015-06-20: Version 4.5.70

        Ship Harmony Array/TypedArray methods (issue 3578).

        Performance and stability improvements on all platforms.


2015-06-20: Version 4.5.69

        Ship arrow functions (issue 2700).

        Performance and stability improvements on all platforms.


2015-06-19: Version 4.5.68

        Performance and stability improvements on all platforms.


2015-06-19: Version 4.5.67

        Performance and stability improvements on all platforms.


2015-06-19: Version 4.5.66

        Ship arrow functions (issue 2700).

        Performance and stability improvements on all platforms.


2015-06-18: Version 4.5.65

        Performance and stability improvements on all platforms.


2015-06-18: Version 4.5.64

        Performance and stability improvements on all platforms.


2015-06-18: Version 4.5.63

        Performance and stability improvements on all platforms.


2015-06-17: Version 4.5.62

        Hydrogen object literals: always initialize in-object properties
        (Chromium issue 500497).

        Performance and stability improvements on all platforms.


2015-06-17: Version 4.5.61

        Add %TypedArray% to proto chain (issue 4085).

        Performance and stability improvements on all platforms.


2015-06-17: Version 4.5.60

        Performance and stability improvements on all platforms.


2015-06-17: Version 4.5.59

        [crankshaft] Fix wrong bailout points in for-in loop body (Chromium
        issue 500435).

        Performance and stability improvements on all platforms.


2015-06-16: Version 4.5.58

        Performance and stability improvements on all platforms.


2015-06-16: Version 4.5.57

        Inline code generation for %_IsTypedArray (issue 4085).

        Allow TypedArrays to be initialized with iterables (issue 4090).

        Performance and stability improvements on all platforms.


2015-06-15: Version 4.5.56

        Performance and stability improvements on all platforms.


2015-06-15: Version 4.5.55

        Performance and stability improvements on all platforms.


2015-06-14: Version 4.5.54

        Performance and stability improvements on all platforms.


2015-06-13: Version 4.5.53

        Performance and stability improvements on all platforms.


2015-06-12: Version 4.5.52

        Map::TryUpdate() must be in sync with Map::Update() (issue 4173).

        Add ToObject call in Array.prototype.sort (issue 4125).

        In Array.of and Array.from, fall back to DefineOwnProperty (issue 4168).

        Performance and stability improvements on all platforms.


2015-06-12: Version 4.5.51

        Performance and stability improvements on all platforms.


2015-06-11: Version 4.5.50

        Performance and stability improvements on all platforms.


2015-06-11: Version 4.5.49

        Performance and stability improvements on all platforms.


2015-06-11: Version 4.5.48

        Support rest parameters in arrow functions (issue 2700).

        Performance and stability improvements on all platforms.


2015-06-10: Version 4.5.47

        Implement %TypedArray%.prototype.slice (issue 3578).

        Performance and stability improvements on all platforms.


2015-06-09: Version 4.5.46

        Stage ES6 arrow functions (issue 2700).

        Performance and stability improvements on all platforms.


2015-06-09: Version 4.5.45

        Performance and stability improvements on all platforms.


2015-06-09: Version 4.5.44

        Performance and stability improvements on all platforms.


2015-06-08: Version 4.5.43

        [for-in] Make ForInNext and ForInFilter deal properly with exceptions
        (Chromium issue 496331).

        Performance and stability improvements on all platforms.


2015-06-08: Version 4.5.42

        Performance and stability improvements on all platforms.


2015-06-06: Version 4.5.41

        Performance and stability improvements on all platforms.


2015-06-05: Version 4.5.40

        Performance and stability improvements on all platforms.


2015-06-05: Version 4.5.39

        Stage ES6 Array and TypedArray methods (issue 3578).

        Performance and stability improvements on all platforms.


2015-06-05: Version 4.5.38

        Implement %TypedArray%.prototype.{reduce,reduceRight} (issue 3578).

        Add support for Embedded Constant Pools for PPC and Arm (Chromium issue
        478811).

        Performance and stability improvements on all platforms.


2015-06-04: Version 4.5.37

        Performance and stability improvements on all platforms.


2015-06-04: Version 4.5.36

        Performance and stability improvements on all platforms.


2015-06-04: Version 4.5.35

        Flatten the Arrays returned and consumed by the v8::Map API (Chromium
        issue 478263).

        Performance and stability improvements on all platforms.


2015-06-03: Version 4.5.34

        Also allocate small typed arrays on heap when initialized from an array-
        like (issue 3996).

        Implement %TypedArray%.prototype.{reduce,reduceRight} (issue 3578).

        Performance and stability improvements on all platforms.


2015-06-03: Version 4.5.33

        Add support for Embedded Constant Pools for PPC and Arm (Chromium issue
        478811).

        Implement %TypedArray%.prototype.{toString,toLocaleString,join} (issue
        3578).

        Performance and stability improvements on all platforms.


2015-06-03: Version 4.5.32

        Performance and stability improvements on all platforms.


2015-06-02: Version 4.5.31

        Performance and stability improvements on all platforms.


2015-06-02: Version 4.5.30

        Performance and stability improvements on all platforms.


2015-06-01: Version 4.5.29

        Reland "Re-enable on-heap typed array allocation" (issue 3996).

        Performance and stability improvements on all platforms.


2015-06-01: Version 4.5.28

        Re-enable on-heap typed array allocation (issue 3996).

        Also expose DefineOwnProperty (Chromium issue 475206).

        Performance and stability improvements on all platforms.


2015-06-01: Version 4.5.27

        Performance and stability improvements on all platforms.


2015-05-31: Version 4.5.26

        Performance and stability improvements on all platforms.


2015-05-30: Version 4.5.25

        Performance and stability improvements on all platforms.


2015-05-29: Version 4.5.24

        Debugger: consider try-finally scopes not catching wrt debug events
        (Chromium issue 492522).

        Performance and stability improvements on all platforms.


2015-05-29: Version 4.5.23

        Performance and stability improvements on all platforms.


2015-05-29: Version 4.5.22

        Do not eagerly convert exception to string when creating a message
        object (Chromium issue 490680).

        Performance and stability improvements on all platforms.


2015-05-28: Version 4.5.21

        Performance and stability improvements on all platforms.


2015-05-28: Version 4.5.20

        Introduce v8::Object::CreateDataProperty (Chromium issue 475206).

        Performance and stability improvements on all platforms.


2015-05-27: Version 4.5.19

        Performance and stability improvements on all platforms.


2015-05-27: Version 4.5.18

        Add {Map,Set}::FromArray to the API (issue 3340).

        Add {Map,Set}::AsArray to the API (issue 3340).

        Add basic API support for Map & Set (issue 3340).

        Performance and stability improvements on all platforms.


2015-05-26: Version 4.5.17

        Correctly hook up materialized receiver into the evaluation context
        chain (Chromium issue 491943).

        Implement bookmarks for ExternalStreamingStream (Chromium issue 470930).

        Performance and stability improvements on all platforms.


2015-05-26: Version 4.5.16

        Performance and stability improvements on all platforms.


2015-05-26: Version 4.5.15

        Performance and stability improvements on all platforms.


2015-05-23: Version 4.5.14

        Performance and stability improvements on all platforms.


2015-05-22: Version 4.5.13

        Remove v8::Private.

        Performance and stability improvements on all platforms.


2015-05-22: Version 4.5.12

        Performance and stability improvements on all platforms.


2015-05-22: Version 4.5.11

        Performance and stability improvements on all platforms.


2015-05-21: Version 4.5.10

        Re-land %TypedArray%.prototype.{map,filter,some} (issue 3578).

        Performance and stability improvements on all platforms.


2015-05-21: Version 4.5.9

        Performance and stability improvements on all platforms.


2015-05-20: Version 4.5.8

        Performance and stability improvements on all platforms.


2015-05-20: Version 4.5.7

        Implement %TypedArray%.{lastI,i}ndexOf (issue 3578).

        Implement %TypedArray%.prototype.sort (issue 3578).

        Implement %TypedArray%.reverse (issue 3578).

        Implement %TypedArray%.prototype.{map,filter,some,reduce,reduceRight}
        (issue 3578).

        Fix has_pending_exception logic in API's Array::CloneElementAt (issue
        4103).

        Adding api to get last gc object statistics for chrome://tracing
        (Chromium issue 476013).

        Fix harmless HGraph verification failure after hoisting inlined bounds
        checks (Chromium issue 487608).

        Performance and stability improvements on all platforms.


2015-05-20: Version 4.5.6

        Add TypedArray.from method (issue 3578).

        Performance and stability improvements on all platforms.


2015-05-19: Version 4.5.5

        ARM64: Propagate notification about aborted compilation from
        RegExpEngine to MacroAssembler (Chromium issue 489290).

        Performance and stability improvements on all platforms.


2015-05-18: Version 4.5.4

        Performance and stability improvements on all platforms.


2015-05-18: Version 4.5.3

        Performance and stability improvements on all platforms.


2015-05-17: Version 4.5.2

        Performance and stability improvements on all platforms.


2015-05-16: Version 4.5.1

        Test that TypedArray methods don't read length (issue 3578).

        Implement %TypedArray%.{fill,find,findIndex} (issue 3578).

        TypedArray.prototype.copyWithin method (issue 3578).

        Provide accessor for object internal properties that doesn't require
        debugger to be active (Chromium issue 481845).

        Don't create debug context if debug listener is not set (Chromium issue
        482290).

        Performance and stability improvements on all platforms.


2015-05-13: Version 4.4.65

        Deprecate Isolate::New.

        Factor out core of Array.forEach and .every, for use in TypedArrays
        (issue 3578).

        Performance and stability improvements on all platforms.


2015-05-12: Version 4.4.64

        Performance and stability improvements on all platforms.


2015-05-11: Version 4.4.63

        Let Runtime_GrowArrayElements accept non-Smi numbers as |key| (Chromium
        issue 485410).

        Make one copy for all TypedArray methods (issue 4085).

        Performance and stability improvements on all platforms.


2015-05-09: Version 4.4.62

        [turbofan] Fix handling of OsrLoopEntry in ControlReducer::ConnectNTL()
        (Chromium issue 485908).

        Performance and stability improvements on all platforms.


2015-05-08: Version 4.4.61

        Performance and stability improvements on all platforms.


2015-05-08: Version 4.4.60

        Performance and stability improvements on all platforms.


2015-05-08: Version 4.4.59

        Performance and stability improvements on all platforms.


2015-05-07: Version 4.4.58

        TypedArray.prototype.every method (issue 3578).

        [V8] Reland https://codereview.chromium.org/1121833003/ (Chromium issue
        480652).

        Performance and stability improvements on all platforms.


2015-05-07: Version 4.4.57

        Performance and stability improvements on all platforms.


2015-05-06: Version 4.4.56

        Shard v8_base.lib on Windows to avoid 2G .lib limit (Chromium issue
        485155).

        Implement a 'trial parse' step, that will abort pre-parsing excessively
        long and trivial functions, so that they can be eagerly compiled after
        all. This essentially allows the parser to renege on its earlier
        decision to lazy-parse, if additional information suggests it was a bad
        decision (Chromium issue 470930).

        Performance and stability improvements on all platforms.


2015-05-06: Version 4.4.55

        Handle the case when derived constructor is [[Call]]ed with 0 args
        (Chromium issue 474783).

        freed_nodes in global-handles should be addititive (Chromium issues
        479796, 484671).

        [V8] Reland https://codereview.chromium.org/1100993003/ (Chromium issue
        480652).

        [es6] When comparing two symbols we may need to throw a TypeError (issue
        4073).

        Performance and stability improvements on all platforms.


2015-05-06: Version 4.4.54

        Performance and stability improvements on all platforms.


2015-05-05: Version 4.4.53

        Performance and stability improvements on all platforms.


2015-05-05: Version 4.4.52

        Performance and stability improvements on all platforms.


2015-05-04: Version 4.4.51

        Performance and stability improvements on all platforms.


2015-05-04: Version 4.4.50

        Performance and stability improvements on all platforms.


2015-05-01: Version 4.4.49

        Performance and stability improvements on all platforms.


2015-05-01: Version 4.4.48

        [V8] Use previous token location as EOS token location (Chromium issue
        480652).

        Implement kToBeExecutedOnceCodeAge (Chromium issue 470930).

        Performance and stability improvements on all platforms.


2015-04-30: Version 4.4.47

        Performance and stability improvements on all platforms.


2015-04-30: Version 4.4.46

        Performance and stability improvements on all platforms.


2015-04-29: Version 4.4.45

        Performance and stability improvements on all platforms.


2015-04-29: Version 4.4.44

        Pass ArrayBuffer::Allocator via Isolate::CreateParams.

        Fix unobservable constructor replacement on prototype maps (Chromium
        issue 478522).

        Performance and stability improvements on all platforms.


2015-04-29: Version 4.4.43

        Performance and stability improvements on all platforms.


2015-04-28: Version 4.4.42

        MIPS: Fix FP load/store with large offsets from base register (Chromium
        issue 481519).

        Extending v8::GetHeapStatistics to return total available size (Chromium
        issue 476013).

        Performance and stability improvements on all platforms.


2015-04-28: Version 4.4.41

        Performance and stability improvements on all platforms.


2015-04-28: Version 4.4.40

        Do more to avoid last-resort stop-the-world GC (Chromium issue 481433).

        Performance and stability improvements on all platforms.


2015-04-27: Version 4.4.39

        Performance and stability improvements on all platforms.


2015-04-27: Version 4.4.38

        Performance and stability improvements on all platforms.


2015-04-25: Version 4.4.37

        Performance and stability improvements on all platforms.


2015-04-24: Version 4.4.36

        Performance and stability improvements on all platforms.


2015-04-24: Version 4.4.35

        Performance and stability improvements on all platforms.


2015-04-24: Version 4.4.34

        Performance and stability improvements on all platforms.


2015-04-23: Version 4.4.33

        Performance and stability improvements on all platforms.


2015-04-23: Version 4.4.32

        Performance and stability improvements on all platforms.


2015-04-23: Version 4.4.31

        Performance and stability improvements on all platforms.


2015-04-22: Version 4.4.30

        Performance and stability improvements on all platforms.


2015-04-22: Version 4.4.29

        Performance and stability improvements on all platforms.


2015-04-21: Version 4.4.28

        Performance and stability improvements on all platforms.


2015-04-21: Version 4.4.27

        Performance and stability improvements on all platforms.


2015-04-20: Version 4.4.26

        Allow for accessing an ArrayBuffer contents without externalizing it.

        Remove support for externally backed elements from the API (issue 3996).

        Deprecate 3-args ResourceConstraints::ConfigureDefaults.

        Indicate that low-memory-notificatin triggered GCs are "forced".

        Adding missing V8_EXPORT flag in SpaceStatistics class in v8.h (Chromium
        issues 466141, 476013).

        Performance and stability improvements on all platforms.


2015-04-20: Version 4.4.25

        Turn off SupportsFlexibleFloorAndRound for Arm64 due to a bug (Chromium
        issue 476477).

        Adding V8 api to get memory statistics of spaces in V8::Heap (Chromium
        issues 466141, 476013).

        Performance and stability improvements on all platforms.


2015-04-17: Version 4.4.24

        Performance and stability improvements on all platforms.


2015-04-17: Version 4.4.23

        Don't crash when reporting an access check failure for a detached global
        proxy (Chromium issue 475884).

        Use smaller heap growing factor in idle notification to start
        incremental marking when there is idle time >16ms (Chromium issue
        477323).

        Performance and stability improvements on all platforms.


2015-04-16: Version 4.4.22

        Reduce regexp compiler stack size when not optimizing regexps (Chromium
        issue 475705).

        Performance and stability improvements on all platforms.


2015-04-15: Version 4.4.21

        Remove support for specifying the number of available threads.

        When converting Maybe and MaybeLocal values with a check, always check.

        Performance and stability improvements on all platforms.


2015-04-15: Version 4.4.20

        Performance and stability improvements on all platforms.


2015-04-15: Version 4.4.19

        Reland "Remove support for thread-based recompilation" (issue 3608).

        Performance and stability improvements on all platforms.


2015-04-14: Version 4.4.18

        Reland "Remove support for thread-based recompilation" (issue 3608).

        Performance and stability improvements on all platforms.


2015-04-14: Version 4.4.17

        Performance and stability improvements on all platforms.


2015-04-13: Version 4.4.16

        Expose ArrayBufferView::HasBuffer (issue 3996).

        Performance and stability improvements on all platforms.


2015-04-13: Version 4.4.15

        Performance and stability improvements on all platforms.


2015-04-12: Version 4.4.14

        Performance and stability improvements on all platforms.


2015-04-12: Version 4.4.13

        Performance and stability improvements on all platforms.


2015-04-10: Version 4.4.12

        Performance and stability improvements on all platforms.


2015-04-10: Version 4.4.11

        Performance and stability improvements on all platforms.


2015-04-10: Version 4.4.10

        Don't #define snprintf in VS2015 - it's illegal and unneeded (Chromium
        issue 440500).

        Performance and stability improvements on all platforms.


2015-04-09: Version 4.4.9

        Performance and stability improvements on all platforms.


2015-04-09: Version 4.4.8

        Performance and stability improvements on all platforms.


2015-04-08: Version 4.4.7

        Make GetDebugContext a bit more robust (Chromium issue 474538).

        Performance and stability improvements on all platforms.


2015-04-08: Version 4.4.6

        Performance and stability improvements on all platforms.


2015-04-08: Version 4.4.5

        More robust when allocation fails during compaction (Chromium issue
        473307).

        MIPS: JSEntryTrampoline: check for stack space before pushing arguments
        (Chromium issue 469768).

        Performance and stability improvements on all platforms.


2015-04-07: Version 4.4.4

        Debugger: remove debug command API.

        Remove support for thread-based recompilation (issue 3608).

        JSEntryTrampoline: check for stack space before pushing arguments
        (Chromium issue 469768).

        Performance and stability improvements on all platforms.


2015-04-07: Version 4.4.3

        Performance and stability improvements on all platforms.


2015-04-06: Version 4.4.2

        Performance and stability improvements on all platforms.


2015-04-06: Version 4.4.1

        Support for typed arrays added to Heap::RightTrimFixedArray() (Chromium
        issue 472513).

        Expose an API on ArrayBufferView to copy out content w/o changing the
        buffer (issue 3996).

        Performance and stability improvements on all platforms.


2015-04-02: Version 4.3.66

        Reland: Fix JSON parser Handle leak (previous CL 1041483004) (issue
        3976, Chromium issue 472504).

        Turn off overapproximation of the weak closure again (issue 3862).

        Performance and stability improvements on all platforms.


2015-04-01: Version 4.3.65

        Performance and stability improvements on all platforms.


2015-04-01: Version 4.3.64

        Performance and stability improvements on all platforms.


2015-04-01: Version 4.3.63

        [V8] Don't ignore sourceURL comment in inline scripts in .stack (issue
        3920).

        Deprecate IdleNotification().

        Remove --harmony-numeric-literal flag.

        Performance and stability improvements on all platforms.


2015-03-31: Version 4.3.62

        Put newspace evacuation in an EvacuationScope (Chromium issue 471554).

        Fix libdl dependency on Android and remove librt hack (Chromium issue
        469973).

        Ensure that GC idle notifications either make progress or stop
        requesting more GCs (Chromium issue 470615).

        Layout descriptor must be trimmed when corresponding descriptors array
        is trimmed to stay in sync (Chromium issue 470804).

        Fix JSON parser Handle leak (issue 3976).

        Performance and stability improvements on all platforms.


2015-03-30: Version 4.3.61

        Performance and stability improvements on all platforms.


2015-03-28: Version 4.3.60

        Reland^2 "Filter invalid slots out from the SlotsBuffer after marking."
        (Chromium issues 454297, 470801).

        This fixes missing incremental write barrier issue when double fields
        unboxing is enabled (Chromium issue 469146).

        Performance and stability improvements on all platforms.


2015-03-27: Version 4.3.59

        Use a slot that is located on a heap page when removing invalid entries
        from the SlotsBuffer (Chromium issue 470801).

        Performance and stability improvements on all platforms.


2015-03-26: Version 4.3.58

        Return timestamp of the last recorded interval to the caller of
        HeapProfiler::GetHeapStats (Chromium issue 467222).

        Performance and stability improvements on all platforms.


2015-03-26: Version 4.3.57

        Reland [V8] Removed SourceLocationRestrict (Chromium issue 468781).

        Performance and stability improvements on all platforms.


2015-03-25: Version 4.3.56

        Remove v8::Isolate::ClearInterrupt.

        Performance and stability improvements on all platforms.


2015-03-25: Version 4.3.55

        Performance and stability improvements on all platforms.


2015-03-24: Version 4.3.54

        Do not assign positions to parser-generated desugarings (Chromium issue
        468661).

        Performance and stability improvements on all platforms.


2015-03-24: Version 4.3.53

        Filter invalid slots out from the SlotsBuffer after marking (Chromium
        issue 454297).

        Fix OOM bug 3976 (issue 3976).

        Performance and stability improvements on all platforms.


2015-03-24: Version 4.3.52

        Remove calls to IdleNotification().

        Save heap object tracking data in heap snapshot (Chromium issue 467222).

        Performance and stability improvements on all platforms.


2015-03-24: Version 4.3.51

        [V8] Removed SourceLocationRestrict (Chromium issue 468781).

        [turbofan] Fix control reducer bug with walking non-control edges during
        ConnectNTL phase (Chromium issue 469605).

        Performance and stability improvements on all platforms.


2015-03-23: Version 4.3.50

        Performance and stability improvements on all platforms.


2015-03-23: Version 4.3.49

        Ensure we don't overflow in BCE (Chromium issue 469148).

        [turbofan] Fix lowering of Math.max for integral inputs (Chromium issue
        468162).

        Use libdl to get symbols for backtraces.

        Performance and stability improvements on all platforms.


2015-03-19: Version 4.3.48

        Clarify what APIs return Maybe and MaybeLocal values (issue 3929).

        Introduce explicit constant for per Context debug data set by embedder
        (Chromium issue 466631).

        Adjust key behaviour for weak collections (issues 3970, 3971, Chromium
        issue 460083).

        Turn on overapproximation of the weak closure (issue 3862).

        Performance and stability improvements on all platforms.


2015-03-18: Version 4.3.47

        Performance and stability improvements on all platforms.


2015-03-17: Version 4.3.46

        Performance and stability improvements on all platforms.


2015-03-17: Version 4.3.45

        Performance and stability improvements on all platforms.


2015-03-17: Version 4.3.44

        Performance and stability improvements on all platforms.


2015-03-16: Version 4.3.43

        Bugfix in hydrogen GVN (Chromium issue 467481).

        Remove obsolete TakeHeapSnapshot method from API (Chromium issue
        465651).

        Beautify syntax error for unterminated argument list (Chromium issue
        339474).

        Performance and stability improvements on all platforms.


2015-03-16: Version 4.3.42

        Performance and stability improvements on all platforms.


2015-03-15: Version 4.3.41

        Performance and stability improvements on all platforms.


2015-03-14: Version 4.3.40

        Performance and stability improvements on all platforms.


2015-03-14: Version 4.3.39

        Performance and stability improvements on all platforms.


2015-03-14: Version 4.3.38

        Remove --harmony-scoping flag.

        Performance and stability improvements on all platforms.


2015-03-13: Version 4.3.37

        Implement TDZ in StoreIC for top-level lexicals (issue 3941).

        Turn on job-based optimizing compiler (issue 3608).

        Performance and stability improvements on all platforms.


2015-03-13: Version 4.3.36

        Performance and stability improvements on all platforms.


2015-03-12: Version 4.3.35

        Add Cast() for Int32 and Uint32 (Chromium issue 462402).

        Incorrect handling of HTransitionElementsKind in hydrogen check
        elimination phase fixed (Chromium issue 460917).

        Performance and stability improvements on all platforms.


2015-03-12: Version 4.3.34

        Performance and stability improvements on all platforms.


2015-03-12: Version 4.3.33

        Fix the toolchain used to build the snapshots in GN (Chromium issues
        395249, 465456).

        Performance and stability improvements on all platforms.


2015-03-11: Version 4.3.32

        Reland of Remove slots that point to unboxed doubles from the
        StoreBuffer/SlotsBuffer (Chromium issues 454297, 465273).

        Performance and stability improvements on all platforms.


2015-03-11: Version 4.3.31

        Performance and stability improvements on all platforms.


2015-03-11: Version 4.3.30

        Remove uid and title from HeapSnapshot (Chromium issue 465651).

        Remove deprecated CpuProfiler methods.

        [turbofan] Fix --turbo-osr for OSRing into inner loop inside for-in
        (Chromium issue 462775).

        Performance and stability improvements on all platforms.


2015-03-10: Version 4.3.29

        Performance and stability improvements on all platforms.


2015-03-10: Version 4.3.28

        Performance and stability improvements on all platforms.


2015-03-10: Version 4.3.27

        Performance and stability improvements on all platforms.


2015-03-07: Version 4.3.26

        Remove slots that point to unboxed doubles from the
        StoreBuffer/SlotsBuffer (Chromium issue 454297).

        Performance and stability improvements on all platforms.


2015-03-06: Version 4.3.25

        Performance and stability improvements on all platforms.


2015-03-06: Version 4.3.24

        convert more things to maybe (issue 3929).

        Performance and stability improvements on all platforms.


2015-03-05: Version 4.3.23

        [V8] Use Function.name for stack frames in v8::StackTrace (Chromium
        issue 17356).

        Allow passing sourceMapUrl when compiling scripts (Chromium issue
        462572).

        convert compile functions to use maybe (issue 3929).

        Performance and stability improvements on all platforms.


2015-03-05: Version 4.3.22

        give UniquePersistent full move semantics (issue 3669).

        Performance and stability improvements on all platforms.


2015-03-05: Version 4.3.21

        Performance and stability improvements on all platforms.


2015-03-04: Version 4.3.20

        convert remaining object functions to maybes (issue 3929).

        Performance and stability improvements on all platforms.


2015-03-04: Version 4.3.19

        ARM assembler: fix undefined behaviour in fits_shifter (Chromium issues
        444089, 463436).

        Implement subclassing Arrays (issue 3930).

        [es6] Fix for-const loops (issue 3983).

        Performance and stability improvements on all platforms.


2015-03-04: Version 4.3.18

        Implement subclassing Arrays (issue 3930).

        Performance and stability improvements on all platforms.


2015-03-04: Version 4.3.17

        Implement subclassing Arrays (issue 3930).

        convert more object functions to return maybes (issue 3929).

        Performance and stability improvements on all platforms.


2015-03-03: Version 4.3.16

        check for null context on execution entry (issue 3929).

        convert object::* to return maybe values (issue 3929).

        Removed funky Maybe constructor and made fields private (issue 3929).

        Polish Maybe API a bit, removing useless creativity and fixing some
        signatures (issue 3929).

        Performance and stability improvements on all platforms.


2015-03-02: Version 4.3.15

        Performance and stability improvements on all platforms.


2015-03-02: Version 4.3.14

        Performance and stability improvements on all platforms.


2015-02-28: Version 4.3.13

        Disallow subclassing Arrays (issue 3930).

        Performance and stability improvements on all platforms.


2015-02-28: Version 4.3.12

        Performance and stability improvements on all platforms.


2015-02-27: Version 4.3.11

        Disallow subclassing Arrays (issue 3930).

        convert Value::*Value() function to return Maybe results (issue 3929).

        Performance and stability improvements on all platforms.


2015-02-27: Version 4.3.10

        Convert v8::Value::To* to use MaybeLocal (issue 3929).

        Performance and stability improvements on all platforms.


2015-02-26: Version 4.3.9

        Add public version macros (issue 3075).

        Performance and stability improvements on all platforms.


2015-02-26: Version 4.3.8

        Performance and stability improvements on all platforms.


2015-02-25: Version 4.3.7

        Performance and stability improvements on all platforms.


2015-02-25: Version 4.3.6

        Performance and stability improvements on all platforms.


2015-02-25: Version 4.3.5

        Turn on job based recompilation (issue 3608).

        Performance and stability improvements on all platforms.


2015-02-24: Version 4.3.4

        Reland "Correctly propagate terminate exception in TryCall." (issue
        3892).

        Performance and stability improvements on all platforms.


2015-02-24: Version 4.3.3

        Performance and stability improvements on all platforms.


2015-02-24: Version 4.3.2

        Update GN build files with the cpu_arch -> current_cpu change.

        Performance and stability improvements on all platforms.


2015-02-23: Version 4.3.1

        Limit size of first page based on serialized data (Chromium issue
        453111).

        Performance and stability improvements on all platforms.


2015-02-19: Version 4.2.77

        Make generator constructors configurable (issue 3902).

        Performance and stability improvements on all platforms.


2015-02-19: Version 4.2.76

        Performance and stability improvements on all platforms.


2015-02-18: Version 4.2.75

        Performance and stability improvements on all platforms.


2015-02-18: Version 4.2.74

        Correctly propagate terminate exception in TryCall (issue 3892).

        Performance and stability improvements on all platforms.


2015-02-17: Version 4.2.73

        Performance and stability improvements on all platforms.


2015-02-17: Version 4.2.72

        [turbofan] Fix control reducer with re-reducing branches (Chromium issue
        458876).

        Performance and stability improvements on all platforms.


2015-02-16: Version 4.2.71

        Implement ES6 rest parameters (issue 2159).

        Performance and stability improvements on all platforms.


2015-02-13: Version 4.2.70

        new classes: no longer experimental (issue 3834).

        Make it possible to define arguments for CompileFunctionInContext.

        Performance and stability improvements on all platforms.


2015-02-12: Version 4.2.69

        Performance and stability improvements on all platforms.


2015-02-11: Version 4.2.68

        Performance and stability improvements on all platforms.


2015-02-11: Version 4.2.67

        Throw on range error when creating a string via API (issue 3853).

        Performance and stability improvements on all platforms.


2015-02-11: Version 4.2.66

        Performance and stability improvements on all platforms.


2015-02-10: Version 4.2.65

        Performance and stability improvements on all platforms.


2015-02-10: Version 4.2.64

        Performance and stability improvements on all platforms.


2015-02-10: Version 4.2.63

        Introduce a compile method that takes context extensions (Chromium issue
        456192).

        Performance and stability improvements on all platforms.


2015-02-09: Version 4.2.62

        Performance and stability improvements on all platforms.


2015-02-09: Version 4.2.61

        Performance and stability improvements on all platforms.


2015-02-07: Version 4.2.60

        Performance and stability improvements on all platforms.


2015-02-07: Version 4.2.59

        Performance and stability improvements on all platforms.


2015-02-07: Version 4.2.58

        Performance and stability improvements on all platforms.


2015-02-06: Version 4.2.57

        Performance and stability improvements on all platforms.


2015-02-06: Version 4.2.56

        Performance and stability improvements on all platforms.


2015-02-06: Version 4.2.55

        Protect against uninitialized lexical variables at top-level (Chromium
        issue 452510).

        Performance and stability improvements on all platforms.


2015-02-05: Version 4.2.54

        Fix HConstant(double, ...) constructor (issue 3865).

        Add NativeWeakMap to v8.h (Chromium issue 437416).

        Performance and stability improvements on all platforms.


2015-02-05: Version 4.2.53

        Fix issue with multiple properties and emit store (issue 3856).

        Class methods should be non enumerable (issue 3330).

        Performance and stability improvements on all platforms.


2015-02-04: Version 4.2.52

        Add WeakKeyMap to v8.h (Chromium issue 437416).

        Performance and stability improvements on all platforms.


2015-02-04: Version 4.2.51

        Performance and stability improvements on all platforms.


2015-02-03: Version 4.2.50

        Reset inlining limits due to overly long compilation times in
        Speedometer, Dart2JS (Chromium issue 454625).

        Add WeakMap to v8.h (Chromium issue 437416).

        [V8] Added line, column and script symbols for SyntaxError (Chromium
        issue 443140).

        Performance and stability improvements on all platforms.


2015-02-03: Version 4.2.49

        Compute the same hash for all NaN values (issue 3859).

        Performance and stability improvements on all platforms.


2015-02-03: Version 4.2.48

        Performance and stability improvements on all platforms.


2015-02-02: Version 4.2.47

        Check global object behind global proxy for extensibility (Chromium
        issue 454091).

        Performance and stability improvements on all platforms.


2015-02-02: Version 4.2.46

        Performance and stability improvements on all platforms.


2015-02-02: Version 4.2.45

        Performance and stability improvements on all platforms.


2015-02-01: Version 4.2.44

        Performance and stability improvements on all platforms.


2015-02-01: Version 4.2.43

        Performance and stability improvements on all platforms.


2015-01-31: Version 4.2.42

        Performance and stability improvements on all platforms.


2015-01-31: Version 4.2.41

        Layout descriptor sharing issue fixed (issue 3832, Chromium issue
        437713).

        Performance and stability improvements on all platforms.


2015-01-30: Version 4.2.40

        Performance and stability improvements on all platforms.


2015-01-30: Version 4.2.38

        Move object literal checking into checker classes (issue 3819).

        [turbofan] Fix OSR compilations of for-in.

        Performance and stability improvements on all platforms.


2015-01-30: Version 4.2.37

        Do not create unresolved variables when parsing arrow functions lazily
        (issue 3501).

        Performance and stability improvements on all platforms.


2015-01-29: Version 4.2.36

        Performance and stability improvements on all platforms.


2015-01-29: Version 4.2.35

        Performance and stability improvements on all platforms.


2015-01-28: Version 4.2.34

        Performance and stability improvements on all platforms.


2015-01-28: Version 4.2.33

        Performance and stability improvements on all platforms.


2015-01-27: Version 4.2.32

        Do not generalize field representations when making elements kind or
        observed transition (Chromium issue 448711).

        Performance and stability improvements on all platforms.


2015-01-27: Version 4.2.31

        [x86] Disable AVX unless the operating system explicitly claims to
        support it (issue 3846, Chromium issue 452033).

        Performance and stability improvements on all platforms.


2015-01-27: Version 4.2.30

        Performance and stability improvements on all platforms.


2015-01-26: Version 4.2.29

        MIPS: Fixed Hydrogen environment handling for mul-i ARM and ARM64 (issue
        451322).

        [turbofan] Simplify reduction if IfTrue and IfFalse and fix bugs
        (Chromium issue 451958).

        Add HeapNumber fast path to v8::Value::{Uint,Int}32Value() (Chromium
        issue 446097).

        Performance and stability improvements on all platforms.


2015-01-26: Version 4.2.28

        Fixed Hydrogen environment handling for mul-i on ARM and ARM64 (issue
        451322).

        Performance and stability improvements on all platforms.


2015-01-25: Version 4.2.27

        Performance and stability improvements on all platforms.


2015-01-24: Version 4.2.26

        ES6 Array.prototype.toString falls back on Object.prototype.toString if
        method "join" is not callable (issue 3793).

        Performance and stability improvements on all platforms.


2015-01-23: Version 4.2.25

        Performance and stability improvements on all platforms.


2015-01-23: Version 4.2.24

        Performance and stability improvements on all platforms.


2015-01-23: Version 4.2.23

        [x86] Blacklist AVX for Windows versions before 6.1 (Windows 7) (issue
        3846).

        Performance and stability improvements on all platforms.


2015-01-23: Version 4.2.22

        Fix run-time ARMv6 detection (issue 3844).

        Support concatenating with zero-size arrays with DICTIONARY_ELEMENTS in
        Runtime_ArrayConcat (Chromium issue 450895).

        Performance and stability improvements on all platforms.


2015-01-22: Version 4.2.21

        Performance and stability improvements on all platforms.


2015-01-22: Version 4.2.20

        Add a pretty printer to improve the error message non-function calls
        (Chromium issue 259443).

        Remove implicit uint8_t to char cast in string replace (Chromium issue
        446196).

        Performance and stability improvements on all platforms.


2015-01-21: Version 4.2.19

        Performance and stability improvements on all platforms.


2015-01-20: Version 4.2.18

        Fix issue with __proto__ when using ES6 object literals (issue 3818).

        Performance and stability improvements on all platforms.


2015-01-20: Version 4.2.17

        Performance and stability improvements on all platforms.


2015-01-20: Version 4.2.16

        Performance and stability improvements on all platforms.


2015-01-19: Version 4.2.15

        Unobscurified OFStream (Chromium issue 448102).

        Performance and stability improvements on all platforms.


2015-01-19: Version 4.2.14

        Performance and stability improvements on all platforms.


2015-01-18: Version 4.2.13

        Performance and stability improvements on all platforms.


2015-01-18: Version 4.2.12

        Performance and stability improvements on all platforms.


2015-01-17: Version 4.2.11

        Performance and stability improvements on all platforms.


2015-01-16: Version 4.2.10

        Performance and stability improvements on all platforms.


2015-01-16: Version 4.2.9

        MIPS: ES6 computed property names (issue 3754).

        ES6 computed property names (issue 3754).

        Performance and stability improvements on all platforms.


2015-01-15: Version 4.2.8

        Performance and stability improvements on all platforms.


2015-01-15: Version 4.2.7

        Performance and stability improvements on all platforms.


2015-01-15: Version 4.2.6

        Performance and stability improvements on all platforms.


2015-01-15: Version 4.2.5

        Performance and stability improvements on all platforms.


2015-01-14: Version 4.2.4

        Auto-generate v8 version based on tags (Chromium issue 446166).

        Remove support for signatures with arguments.

        Add proper support for proxies to HType (Chromium issue 448730).

        [turbofan] Fix truncation/representation sloppiness wrt. bool/bit (issue
        3812).

        Performance and stability improvements on all platforms.


2015-01-14: Version 4.2.3

        Performance and stability improvements on all platforms.


2015-01-14: Version 4.2.2

        Performance and stability improvements on all platforms.


2015-01-14: Version 4.2.1

        Map -0 to integer 0 for typed array constructors (Chromium issue
        447756).

        Introduce a gyp variable to control whether or not slow dchecks are on.

        Correctly setup the freelist of the coderange on Win64 (Chromium issue
        447555).

        Fast forward V8 to version 4.2.

        Remove "extra checks".

        Performance and stability improvements on all platforms.


2015-01-08: Version 3.32.7

        Correctly parse line ends for debugging (issue 2825).

        Fixed printing during DCE (issue 3679).

        Performance and stability improvements on all platforms.


2015-01-08: Version 3.32.6

        Performance and stability improvements on all platforms.


2015-01-08: Version 3.32.5

        Correct handling of exceptions occured during getting of exception stack
        trace (Chromium issue 444805).

        Fix bug in Runtime_CompileOptimized resulting from stack overflow
        (Chromium issue 446774).

        Turn on job-based recompilation (issue 3608).

        Performance and stability improvements on all platforms.


2015-01-07: Version 3.32.4

        Performance and stability improvements on all platforms.


2015-01-07: Version 3.32.3

        Performance and stability improvements on all platforms.


2015-01-07: Version 3.32.2

        Performance and stability improvements on all platforms.


2015-01-07: Version 3.32.1

        [turbofan] Don't crash when typing load from a Uint8ClampedArray
        (Chromium issue 446156).

        [turbofan] Truncation of Bit/Word8/16 to Word32 is a no-op (Chromium
        issue 445859).

        [x64] Rearrange code for OOB integer loads (Chromium issue 445858).

        Fix %NeverOptimizeFunction() intrinsic (Chromium issue 445732).

        [turbofan] Fix invalid bounds check with overflowing offset (Chromium
        issue 445267).

        [turbofan] Raise max virtual registers and call parameter limit (issue
        3786).

        Performance and stability improvements on all platforms.


2014-12-23: Version 3.31.74

        [turbofan] Turn DCHECK for fixed slot index into a CHECK (Chromium issue
        444681).

        Performance and stability improvements on all platforms.


2014-12-23: Version 3.31.73

        [turbofan] Fix missing ChangeUint32ToUint64 in lowering of LoadBuffer
        (Chromium issue 444695).

        Enable the embedder to specify what kind of context was disposed.

        Performance and stability improvements on all platforms.


2014-12-22: Version 3.31.72

        [turbofan] Correctify lowering of Uint8ClampedArray buffer access
        (Chromium issue 444508).

        Performance and stability improvements on all platforms.


2014-12-20: Version 3.31.71

        Performance and stability improvements on all platforms.


2014-12-20: Version 3.31.70

        Performance and stability improvements on all platforms.


2014-12-20: Version 3.31.69

        Performance and stability improvements on all platforms.


2014-12-19: Version 3.31.68

        [turbofan] Fix unsafe out-of-bounds check for checked loads/stores
        (Chromium issue 443744).

        Performance and stability improvements on all platforms.


2014-12-19: Version 3.31.67

        Performance and stability improvements on all platforms.


2014-12-19: Version 3.31.66

        Ship ES6 template literals (issue 3230).

        Performance and stability improvements on all platforms.


2014-12-18: Version 3.31.65

        ES6 template literals should not use legacy octal strings (issue 3736).

        Performance and stability improvements on all platforms.


2014-12-18: Version 3.31.64

        Fixed -fsanitize=float-cast-overflow problems (issue 3773).

        Performance and stability improvements on all platforms.


2014-12-18: Version 3.31.63

        ES6 computed property names (issue 3754).

        Performance and stability improvements on all platforms.


2014-12-17: Version 3.31.62

        Performance and stability improvements on all platforms.


2014-12-17: Version 3.31.61

        ES6: Update unscopables to match spec (issue 3632).

        ES6 computed property names (issue 3754).

        More -fsanitize=vptr fixes (Chromium issue 441099).

        [turbofan] Cache conversions inserted during typed lowering (issue
        3763).

        Performance and stability improvements on all platforms.


2014-12-16: Version 3.31.60

        Performance and stability improvements on all platforms.


2014-12-16: Version 3.31.59

        Performance and stability improvements on all platforms.


2014-12-16: Version 3.31.58

        Ship ES6 classes (issue 3330).

        ES6 computed property names (issue 3754).

        Performance and stability improvements on all platforms.


2014-12-12: Version 3.31.57

        Consistently use only one of virtual/OVERRIDE/FINAL (issue 3753).

        Performance and stability improvements on all platforms.


2014-12-12: Version 3.31.56

        Performance and stability improvements on all platforms.


2014-12-12: Version 3.31.55

        Performance and stability improvements on all platforms.


2014-12-11: Version 3.31.54

        Implement Array.from() (issue 3336).

        move v8_use_external_startup_data to standalone.gypi (Chromium issue
        421063).

        Performance and stability improvements on all platforms.


2014-12-11: Version 3.31.53

        Performance and stability improvements on all platforms.


2014-12-11: Version 3.31.52

        Ship ES6 block scoping (issue 2198).

        Optimize Object.seal and Object.preventExtensions (issue 3662, Chromium
        issue 115960).

        Add Array.prototype.includes (issue 3575).

        Performance and stability improvements on all platforms.


2014-12-10: Version 3.31.51

        [x64] Fix optimization for certain checked load/stores (Chromium issue
        439743).

        Performance and stability improvements on all platforms.


2014-12-09: Version 3.31.50

        Temporarily restore make dependencies.

        Performance and stability improvements on all platforms.


2014-12-09: Version 3.31.49

        Performance and stability improvements on all platforms.


2014-12-09: Version 3.31.48

        Performance and stability improvements on all platforms.


2014-12-09: Version 3.31.47

        Temporarily restore make dependencies.

        Performance and stability improvements on all platforms.


2014-12-08: Version 3.31.46

        Performance and stability improvements on all platforms.


2014-12-08: Version 3.31.45

        Update all DEPS to match chromium's DEPS at edb488e.

        Turn on DCHECKs and other debugging code if dcheck_always_on is 1 (issue
        3731).

        Optimize GetPrototype.

        Performance and stability improvements on all platforms.


2014-12-05: Version 3.31.44

        Performance and stability improvements on all platforms.


2014-12-04: Version 3.31.43

        ES6 template literals: Fix issue with template after rbrace (issue
        3734).

        Stage ES6 template literals (issue 3230).

        Performance and stability improvements on all platforms.


2014-12-04: Version 3.31.42

        Performance and stability improvements on all platforms.


2014-12-04: Version 3.31.41

        Simplify template literal raw string creation (issue 3710).

        Performance and stability improvements on all platforms.


2014-12-03: Version 3.31.40

        Performance and stability improvements on all platforms.


2014-12-03: Version 3.31.39

        Performance and stability improvements on all platforms.


2014-12-03: Version 3.31.38

        Stage ES6 classes and object literal extensions (issue 3330).

        Fixed environment handling for LFlooringDivI on ARM (Chromium issue
        437765).

        Add GetIdentityHash to v8::Name object API (Chromium issue 437416).

        Set V8_CC_GNU or V8_CC_MSVC for clang in gcc / cl mode (Chromium issue
        82385).

        Performance and stability improvements on all platforms.


2014-12-02: Version 3.31.37

        Performance and stability improvements on all platforms.


2014-12-02: Version 3.31.36

        Set V8_CC_GNU or V8_CC_MSVC for clang in gcc / cl mode (Chromium issue
        82385).

        Performance and stability improvements on all platforms.


2014-12-02: Version 3.31.35

        Performance and stability improvements on all platforms.


2014-12-01: Version 3.31.34

        Performance and stability improvements on all platforms.


2014-12-01: Version 3.31.33

        Performance and stability improvements on all platforms.


2014-12-01: Version 3.31.32

        Performance and stability improvements on all platforms.


2014-12-01: Version 3.31.31

        Performance and stability improvements on all platforms.


2014-11-29: Version 3.31.30

        Performance and stability improvements on all platforms.


2014-11-28: Version 3.31.29

        Stage @@toStringTag (--harmony-tostring).

        Performance and stability improvements on all platforms.


2014-11-28: Version 3.31.28

        Performance and stability improvements on all platforms.


2014-11-28: Version 3.31.27

        Ship harmony-strings.

        Performance and stability improvements on all platforms.


2014-11-28: Version 3.31.26

        Abort optimization in corner case (Chromium issue 436893).

        Performance and stability improvements on all platforms.


2014-11-26: Version 3.31.25

        Stage ES6 block scoping (issue 2198).

        Introduce legacy const slots in correct context (Chromium issue 410030).

        Performance and stability improvements on all platforms.


2014-11-26: Version 3.31.24

        Performance and stability improvements on all platforms.


2014-11-25: Version 3.31.23

        Performance and stability improvements on all platforms.


2014-11-25: Version 3.31.22

        Performance and stability improvements on all platforms.


2014-11-24: Version 3.31.21

        Performance and stability improvements on all platforms.


2014-11-24: Version 3.31.20

        Performance and stability improvements on all platforms.


2014-11-22: Version 3.31.19

        Performance and stability improvements on all platforms.


2014-11-21: Version 3.31.18

        Performance and stability improvements on all platforms.


2014-11-21: Version 3.31.17

        Performance and stability improvements on all platforms.


2014-11-21: Version 3.31.16

        Cache template literal callSiteObj (issue 3230).

        Rename String.prototype.contains to 'includes'.

        Reserve code range block for evacuation (Chromium issue 430118).

        Performance and stability improvements on all platforms.


2014-11-20: Version 3.31.15

        Rename String.prototype.contains to 'includes'.

        Performance and stability improvements on all platforms.


2014-11-19: Version 3.31.14

        Remove Weak{Map,Set}.prototype.clear.

        Performance and stability improvements on all platforms.


2014-11-19: Version 3.31.13

        Performance and stability improvements on all platforms.


2014-11-19: Version 3.31.12

        Classes: Expand test to cover strict runtime behavior (issue 3330).

        v8::String::Concat must not throw (Chromium issue 420240).

        Fix disabling all break points from within the debug event callback
        (Chromium issue 432493).

        Performance and stability improvements on all platforms.


2014-11-18: Version 3.31.11

        Performance and stability improvements on all platforms.


2014-11-17: Version 3.31.10

        Performance and stability improvements on all platforms.


2014-11-17: Version 3.31.9

        Expose internal properties of map/set iterators via mirrors.

        Performance and stability improvements on all platforms.


2014-11-17: Version 3.31.8

        Performance and stability improvements on all platforms.


2014-11-15: Version 3.31.7

        Classes: Add support for stepping through default constructors (issue
        3674).

        Performance and stability improvements on all platforms.


2014-11-14: Version 3.31.6

        Fix desugaring of let bindings in for loops to handle continue properly
        (issue 3683).

        Performance and stability improvements on all platforms.


2014-11-14: Version 3.31.5

        Classes: Implement correct name binding (issue 3330).

        Performance and stability improvements on all platforms.


2014-11-14: Version 3.31.4

        Performance and stability improvements on all platforms.


2014-11-14: Version 3.31.3

        Classes: Cleanup default constructor flag.

        Soft fail for invalid cache data.

        Implement .of() on typed arrays (issue 3578).

        Performance and stability improvements on all platforms.


2014-11-13: Version 3.31.2

        MIPS: Leaving a generator via an exception causes it to close (issue
        3096).

        MIPS: ES6: Add support for super in object literals (issue 3571).

        Increase the target new space size to the max new space size (issue
        3626).

        Leaving a generator via an exception causes it to close (issue 3096).

        Correctly compute line numbers in functions from the function
        constructor (Chromium issue 109362).

        Rename v8::Exception::GetMessage to CreateMessage.

        Classes: Add support for arguments in default constructor (issue 3672).

        ES6: Add support for super in object literals (issue 3571).

        Performance and stability improvements on all platforms.


2014-11-12: Version 3.31.1

        Fix has_constant_parameter_count() confusion in LReturn (Chromium issue
        431602).

        Performance and stability improvements on all platforms.


2014-11-05: Version 3.30.33

        `1..isPrototypeOf.call(null)` should return false, not throw TypeError
        (issue 3483).

        Refactor ObjectGetOwnPropertyKeys to accept bitmask rather than boolean
        (issue 3549).

        Add debug mirror support for ES6 Map/Set iterators (Chromium issue
        427868).

        Performance and stability improvements on all platforms.


2014-11-04: Version 3.30.30

        Performance and stability improvements on all platforms.


2014-11-02: Version 3.30.27

        Performance and stability improvements on all platforms.


2014-11-02: Version 3.30.26

        Performance and stability improvements on all platforms.


2014-11-01: Version 3.30.25

        Performance and stability improvements on all platforms.


2014-11-01: Version 3.30.24

        Ensure we don't try to inline raw access to indexed interceptor
        receivers (Chromium issue 419220).

        Performance and stability improvements on all platforms.


2014-10-31: Version 3.30.23

        Introduce v8::Exception::GetMessage to find location of an error object
        (Chromium issue 427954).

        Performance and stability improvements on all platforms.


2014-10-30: Version 3.30.22

        MIPS: Classes: Add super support in methods and accessors (issue 3330).

        Classes: Add super support in methods and accessors (issue 3330).

        Performance and stability improvements on all platforms.


2014-10-29: Version 3.30.21

        MIPS: Classes: Add basic support for properties (issue 3330).

        Classes: Add more tests for prototype edge cases (Chromium issue 3655).

        Classes: Add test for method prototype (issue 3330).

        Get stack trace for uncaught exceptions/promise rejections from the
        simple stack when available.

        Classes: Add basic support for properties (issue 3330).

        Allow duplicate property names in classes (issue 3570).

        Windows: use SystemTimeToTzSpecificLocalTime instead of localtime_s
        (Chromium issue 417640).

        Performance and stability improvements on all platforms.


2014-10-28: Version 3.30.20

        Performance and stability improvements on all platforms.


2014-10-27: Version 3.30.19

        Check string literals with escapes in PreParserTraits::GetSymbol()
        (issue 3606).

        only define ARRAYSIZE_UNSAFE for NaCl builds (Chromium issue 405225).

        Performance and stability improvements on all platforms.


2014-10-24: Version 3.30.18

        Narrow cases where Sparse/Smart versions of Array methods are used
        (issues 2615, 3612, 3621).

        Shrink new space in idle notification (Chromium issue 424423).

        Performance and stability improvements on all platforms.


2014-10-23: Version 3.30.17

        ARM64: Fix stack manipulation (Chromium issue 425585).

        Speed up creation of Objects whose prototype has dictionary elements
        (Chromium issue 422754).

        Enable libstdc++ debug mode in debug builds (issue 3638).

        Performance and stability improvements on all platforms.


2014-10-22: Version 3.30.16

        Remove v8stdint.h, it doesn't serve a purpose anymore.

        Performance and stability improvements on all platforms.


2014-10-21: Version 3.30.15

        Avoid the Marsaglia effect in 3D (Chromium issue 423311).

        Performance and stability improvements on all platforms.


2014-10-20: Version 3.30.14

        Performance and stability improvements on all platforms.


2014-10-17: Version 3.30.13

        Don't expose Array.prototype.values as it breaks webcompat (Chromium
        issue 409858).

        Fix break location calculation (Chromium issue 419663).

        Enable libstdc++ debug mode in debug builds (issue 3638).

        Performance and stability improvements on all platforms.


2014-10-17: Version 3.30.12

        Implement .forEach() on typed arrays (issue 3578).

        Introduce v8::Exception::GetStackTrace API method.

        Remove SmartMove, bringing Array methods further into spec compliance
        (issue 2615).

        Convert argument toObject() in Object.getOwnPropertyNames/Descriptors
        (issue 3443).

        Performance and stability improvements on all platforms.


2014-10-15: Version 3.30.11

        Array.prototype.{every, filter, find, findIndex, forEach, map, some}:
        Use fresh primitive wrapper for calls (issue 3536).

        Correctly expand literal buffer for surrogate pairs (Chromium issue
        423212).

        Performance and stability improvements on all platforms.


2014-10-15: Version 3.30.10

        Squeeze the layout of various AST node types (Chromium issue 417697).

        Performance and stability improvements on all platforms.


2014-10-14: Version 3.30.9

        Performance and stability improvements on all platforms.


2014-10-13: Version 3.30.8

        AST nodes have at most one bailout/typefeedback ID now, saving lots of
        memory (Chromium issue 417697).

        Allow identifier code points from supplementary multilingual planes
        (issue 3617).

        Performance and stability improvements on all platforms.


2014-10-10: Version 3.30.7

        Fix computation of UTC time from local time at DST change points (issue
        3116, Chromium issues 415424, 417640).

        Convert `obj` ToObject in Object.keys() (issue 3587).

        Performance and stability improvements on all platforms.


2014-10-09: Version 3.30.6

        Update unicode to 7.0.0 (issue 2892).

        Classes: Add support for toString (issue 3330).

        Don't enable WPO on Win64 and require Server 2003 / x64 for win64
        (Chromium issue 421363).

        Performance and stability improvements on all platforms.


2014-10-08: Version 3.30.5

        Performance and stability improvements on all platforms.


2014-10-08: Version 3.30.4

        This uses a runtime function to set up the the constructor and its
        prototype (issue 3330).

        Remove PersistentBase::ClearAndLeak.

        Squeeze the layout of variable proxy nodes (Chromium issue 417697).

        Add MonotonicallyIncreasingTime to V8 Platform (Chromium issue 417668).

        Fix representation of HLoadRoot (Chromium issue 419036).

        Performance and stability improvements on all platforms.


2014-10-03: Version 3.30.3

        Removed the Isolate* field from literal nodes (Chromium issue 417697).

        Squeeze the layout of expression nodes a bit (Chromium issue 417697).

        Merged FeedbackSlotInterface into AstNode, removing the need for a 2nd
        vtable (Chromium issue 417697).

        Extend CPU profiler with mapping ticks to source lines.

        Remove support for parallel sweeping.

        Introduce v8::Object::GetIsolate().

        Performance and stability improvements on all platforms.


2014-10-02: Version 3.30.2

        Fix Hydrogen's BuildStore() (Chromium issue 417508).

        Move unit tests to test/unittests (issue 3489).

        Changes to ALLOW_UNUSED to match upcoming changes to the Chromium trunk:
        * Eliminate usage of ALLOW_UNUSED to define COMPILE_ASSERT and just use
        static_assert() in all cases now that all platforms build with C++11. *
        Convert remaining uses of ALLOW_UNUSED to ALLOW_UNUSED_TYPE to match how
        Chromium will be splitting this functionality.  (In Chromium we'll have
        both   ALLOW_UNUSED_TYPE and ALLOW_UNUSED_LOCAL, which have different
        syntax to   enable us to use these with MSVC.) (Chromium issue 81439).

        Performance and stability improvements on all platforms.


2014-10-01: Version 3.30.1

        Introduce PromiseRejectCallback (issue 3093).

        ES6: Implement object literal property shorthand (issue 3584).

        Performance and stability improvements on all platforms.


2014-09-30: Version 3.29.93

        Add a getter for the address and size of the code range to the pulic API
        (issue 3598).

        Convert `obj` ToObject in Object.keys() (issue 3587).

        Performance and stability improvements on all platforms.


2014-09-29: Version 3.29.92

        Performance and stability improvements on all platforms.


2014-09-26: Version 3.29.91

        Performance and stability improvements on all platforms.


2014-09-25: Version 3.29.88

        Performance and stability improvements on all platforms.


2014-09-24: Version 3.29.87

        Preserve message when rethrowing exception (issue 3583).

        Fix escaped index JSON parsing (Chromium issue 416449).

        Performance and stability improvements on all platforms.


2014-09-23: Version 3.29.84

        Performance and stability improvements on all platforms.


2014-09-23: Version 3.29.83

        Performance and stability improvements on all platforms.


2014-09-23: Version 3.29.82

        Fix escaped index JSON parsing (Chromium issue 416449).

        Performance and stability improvements on all platforms.


2014-09-17: Version 3.29.70

        Enable ES6 generators (issue 2355).

        Fixed int vs. uintptr_t confusion (plus some cleanup on the way) (issue
        3556).

        Move configuration of ResourceConstraints to Isolate construction.

        Performance and stability improvements on all platforms.


2014-09-16: Version 3.29.66

        Currently, a new isolate is created in an uninitialized state, and
        several API methods will automatically initialize it. During this
        uninitialized state, code event handlers and function entry handlers can
        be attached to the isolate.

        Performance and stability improvements on all platforms.


2014-09-15: Version 3.29.64

        ES6: String(symbol) should work like symbol.toString (issue 3554).

        Arrow functions: Cleanup handling of the prototype property (issue
        2700).

        Remove V8_HOST_CAN_READ_UNALIGNED and its uses (Chromium issue 412967).

        Fix Smi vs. HeapObject confusion in HConstants (Chromium issue 412215).

        Performance and stability improvements on all platforms.


2014-09-12: Version 3.29.59

        Do not use wide reads in CopyCharsUnsigned (Chromium issue 412967).

        Fix inaccurate type condition in Hydrogen (Chromium issue 412210).

        Fix crash in ScriptDebugServer::wrapCallFrames (Chromium issue 411196).

        Performance and stability improvements on all platforms.


2014-09-11: Version 3.29.57

        ES6: Add support for method shorthand in object literals (issue 3516).

        Unbreak FreeBSD build (hopefully) (issue 3548).

        Performance and stability improvements on all platforms.


2014-09-09: Version 3.29.53

        Performance and stability improvements on all platforms.


2014-09-08: Version 3.29.50

        Allocate a new empty number dictionary when resetting elements (Chromium
        issue 410332).

        Performance and stability improvements on all platforms.


2014-09-05: Version 3.29.43

        Enforce correct number comparisons when inlining Array.indexOf (Chromium
        issue 407946).

        Performance and stability improvements on all platforms.


2014-09-04: Version 3.29.41

        Performance and stability improvements on all platforms.


2014-09-03: Version 3.29.40

        Use correct receiver for DOM accessors on the prototype chain (issue
        3538).

        Performance and stability improvements on all platforms.


2014-09-02: Version 3.29.38

        Do not clear weak monomorphic IC after context disposal (Chromium issue
        404020).

        Turn on job-based sweeping (issue 3104).

        Performance and stability improvements on all platforms.


2014-09-01: Version 3.29.35

        Performance and stability improvements on all platforms.


2014-08-29: Version 3.29.29

        Performance and stability improvements on all platforms.


2014-08-28: Version 3.29.27

        Performance and stability improvements on all platforms.


2014-08-28: Version 3.29.25

        Performance and stability improvements on all platforms.


2014-08-28: Version 3.29.24

        Tweaks to generate XP-compatible .exes (Chromium issue 407517).

        Performance and stability improvements on all platforms.


2014-08-28: Version 3.29.23

        Performance and stability improvements on all platforms.


2014-08-27: Version 3.29.20

        Handle empty allocation list in CodeRange properly (issue 3540, Chromium
        issue 407566).

        Fixed inlining of constant values (issue 3529).

        Performance and stability improvements on all platforms.


2014-08-25: Version 3.29.17

        Performance and stability improvements on all platforms.


2014-08-24: Version 3.29.16

        Fix issue with numeric property names (issue 3507).

        Add back the duplicate property checker (issue 3498).

        Performance and stability improvements on all platforms.


2014-08-22: Version 3.29.14

        Don't inline Array.shift() if receiver map is not extensible (Chromium
        issue 405517).

        Performance and stability improvements on all platforms.


2014-08-21: Version 3.29.11

        Refactor ParseObjectLiteral.

        Support symbol-named properties in API (issue 3394).

        Suppress test262 test that tests duplicate properties.

        ES6: Duplicate properties are no longer an error (issue 3498).

        Expose function CheckDebugBreak in the debugger api.

        Remove RegExp.$input (issue 3486).

        Performance and stability improvements on all platforms.


2014-08-21: Version 3.29.10

        ES6: Make sure we do not store -0 as the key in Map/Set (issue 3515).

        Remove removed flags from tests.

        Expose well-known Symbols to C++ API (Chromium issue 341423).

        Implement ES6 Array.of() (issue 3427).

        Performance and stability improvements on all platforms.


2014-08-20: Version 3.29.9

        Correctly handle holes when concat()ing double arrays (Chromium issue
        403409).

        [turbofan] Refactor the InstructionSelector tests (issue 3489).

        ES6: Make Map/Set constructors support iterable values (issue 3508).

        WeakMap/WeakSet: Add test for non object keys (issue 3399).

        Performance and stability improvements on all platforms.


2014-08-12: Version 3.28.71

        ToNumber(Symbol) should throw TypeError (issue 3499).

        Performance and stability improvements on all platforms.


2014-08-11: Version 3.28.69

        Performance and stability improvements on all platforms.


2014-08-09: Version 3.28.65

        Performance and stability improvements on all platforms.


2014-08-08: Version 3.28.64

        ES6: Implement WeakMap and WeakSet constructor logic (issue 3399).

        Enable ES6 unscopables (issue 3401).

        Turn on harmony_unscopables for es_staging (issue 3401).

        Remove proxies from --harmony switch for M38, because problems.

        Reland "Add initial support for compiler unit tests using GTest/GMock."
        (issue 3489).

        Enable ES6 iteration by default (issue 2214).

        Performance and stability improvements on all platforms.


2014-08-07: Version 3.28.62

        Only escape U+0022 in argument values of `String.prototype` HTML methods
        (issue 2217).

        Update webkit test for expected own properties.

        This implements unscopables (issue 3401).

        Add `CheckObjectCoercible` for the `String.prototype` HTML methods
        (issue 2218).

        Add initial support for compiler unit tests using GTest/GMock (issue
        3489).

        Trigger exception debug events on Promise reject (Chromium issue
        393913).

        Refactor unit tests for the base library to use GTest (issue 3489).

        Performance and stability improvements on all platforms.


2014-08-06: Version 3.28.60

        Enable ES6 Map and Set by default (issue 1622).

        Performance and stability improvements on all platforms.


2014-08-06: Version 3.28.59

        Removed GetConstructor from the API. Instead either get the
        "constructor" property stored in the prototype, or keep a side-table.

        Enable ES6 Symbols by default (issue 2158).

        Performance and stability improvements on all platforms.


2014-08-05: Version 3.28.57

        Add dependencies on gtest and gmock.

        Performance and stability improvements on all platforms.


2014-08-04: Version 3.28.54

        Performance and stability improvements on all platforms.


2014-08-01: Version 3.28.53

        Performance and stability improvements on all platforms.


2014-07-31: Version 3.28.52

        Performance and stability improvements on all platforms.


2014-07-31: Version 3.28.51

        Drop deprecated memory related notification API (Chromium issue 397026).

        Performance and stability improvements on all platforms.


2014-07-31: Version 3.28.50

        Use emergency memory in the case of out of memory during evacuation
        (Chromium issue 395314).

        Performance and stability improvements on all platforms.


2014-07-30: Version 3.28.48

        Fix Object.freeze with field type tracking. Keep the descriptor properly
        intact while update the field type (issue 3458).

        Performance and stability improvements on all platforms.


2014-07-29: Version 3.28.45

        Performance and stability improvements on all platforms.


2014-07-28: Version 3.28.43

        Performance and stability improvements on all platforms.


2014-07-25: Version 3.28.38

        Fix issue with setters and their holders in accessors.cc (Chromium issue
        3462).

        Introduce more debug events for promises (issue 3093).

        Move gc notifications from V8 to Isolate and make idle hint mandatory
        (Chromium issue 397026).

        The accessors should get the value from the holder and not from this
        (issue 3461).

        Performance and stability improvements on all platforms.


2014-07-24: Version 3.28.35

        Rebaseline/update the intl tests with ICU 52 (issue 3454).

        Expose the content of Sets and WeakSets through SetMirror (issue 3093).

        Performance and stability improvements on all platforms.


2014-07-23: Version 3.28.32

        Update ICU to 5.2 (matching chromium) (issue 3452).

        Performance and stability improvements on all platforms.


2014-07-22: Version 3.28.31

        Remove harmony-typeof.

        Implement String.prototype.codePointAt and String.fromCodePoint (issue
        2840).

        Performance and stability improvements on all platforms.


2014-07-21: Version 3.28.30

        Performance and stability improvements on all platforms.


2014-07-21: Version 3.28.29

        Performance and stability improvements on all platforms.


2014-07-18: Version 3.28.28

        Performance and stability improvements on all platforms.


2014-07-17: Version 3.28.26

        Ship ES6 Math functions (issue 2938).

        Make ToPrimitive throw on symbol wrappers (issue 3442).

        Performance and stability improvements on all platforms.


2014-07-16: Version 3.28.25

        Performance and stability improvements on all platforms.


2014-07-16: Version 3.28.24

        Removed some copy-n-paste from StackFrame::Foo API entries (issue 3436).

        Performance and stability improvements on all platforms.


2014-07-15: Version 3.28.23

        Fix error message about read-only symbol properties (issue 3441).

        Include symbol properties in Object.{create,defineProperties} (issue
        3440).

        Performance and stability improvements on all platforms.


2014-07-14: Version 3.28.22

        Performance and stability improvements on all platforms.


2014-07-11: Version 3.28.21

        Make `let` usable as an identifier in ES6 sloppy mode (issue 2198).

        Support ES6 Map and Set in heap profiler (issue 3368).

        Performance and stability improvements on all platforms.


2014-07-10: Version 3.28.20

        Remove deprecate counter/histogram methods.

        Fixed printing of external references (Chromium issue 392068).

        Fix several issues with ES6 redeclaration checks (issue 3426).

        Performance and stability improvements on all platforms.


2014-07-09: Version 3.28.19

        Performance and stability improvements on all platforms.


2014-07-09: Version 3.28.18

        Reland "Postpone termination exceptions in debug scope." (issue 3408).

        Performance and stability improvements on all platforms.


2014-07-08: Version 3.28.17

        MIPS: Fix computed properties on object literals with a double as
        propertyname (Chromium issue 390732).

        Performance and stability improvements on all platforms.


2014-07-08: Version 3.28.16

        Fix computed properties on object literals with a double as propertyname
        (Chromium issue 390732).

        Avoid brittle use of .bind in Promise.all (issue 3420).

        Performance and stability improvements on all platforms.


2014-07-07: Version 3.28.15

        Remove a bunch of Isolate::UncheckedCurrent calls.

        Performance and stability improvements on all platforms.


2014-07-07: Version 3.28.14

        Use the HeapObjectIterator to scan-on-scavenge map pages (Chromium issue
        390732).

        Introduce debug events for Microtask queue (Chromium issue 272416).

        Split out libplatform into a separate libary.

        Add clang-format to presubmit checks.

        Stack traces exposed to Javascript should omit extensions (issue 311).

        Remove deprecated v8::Context::HasOutOfMemoryException.

        Postpone termination exceptions in debug scope (issue 3408).

        Performance and stability improvements on all platforms.


2014-07-04: Version 3.28.13

        Rollback to r22134.


2014-07-04: Version 3.28.12

        Use the HeapObjectIterator to scan-on-scavenge map pages (Chromium issue
        390732).

        Introduce debug events for Microtask queue (Chromium issue 272416).

        Performance and stability improvements on all platforms.


2014-07-03: Version 3.28.11

        Split out libplatform into a separate libary.

        Performance and stability improvements on all platforms.


2014-07-03: Version 3.28.10

        Add clang-format to presubmit checks.

        Stack traces exposed to Javascript should omit extensions (issue 311).

        Remove deprecated v8::Context::HasOutOfMemoryException.

        Postpone termination exceptions in debug scope (issue 3408).

        Performance and stability improvements on all platforms.


2014-07-02: Version 3.28.9

        Make freeze & friends ignore private properties (issue 3419).

        Introduce a builddeps make target (issue 3418).

        Performance and stability improvements on all platforms.


2014-07-01: Version 3.28.8

        Remove static initializer from isolate.

        ES6: Add missing Set.prototype.keys function (issue 3411).

        Introduce debug events for promises (issue 3093).

        Performance and stability improvements on all platforms.


2014-06-30: Version 3.28.7

        Performance and stability improvements on all platforms.


2014-06-30: Version 3.28.6

        Unbreak "os" stuff in shared d8 builds (issue 3407).

        Performance and stability improvements on all platforms.


2014-06-26: Version 3.28.4

        Compile optimized code with active debugger but no break points
        (Chromium issue 386492).

        Optimize Map/Set.prototype.forEach.

        Collect garbage with kReduceMemoryFootprintMask in IdleNotification
        (Chromium issue 350720).

        Performance and stability improvements on all platforms.


2014-06-26: Version 3.28.3

        Grow heap slower if GC freed many global handles (Chromium issue
        263503).

        Performance and stability improvements on all platforms.


2014-06-25: Version 3.28.2

        Remove bogus assertions in HCompareObjectEqAndBranch (Chromium issue
        387636).

        Do not eagerly update allow_osr_at_loop_nesting_level (Chromium issue
        387599).

        Set host_arch to ia32 on machines with a 32bit userland but a 64bit
        kernel (Chromium issue 368384).

        Map/Set: Implement constructor parameter handling (issue 3398).

        Performance and stability improvements on all platforms.


2014-06-24: Version 3.28.1

        Support LiveEdit on Arm64 (Chromium issue 368580).

        Run JS micro tasks in the appropriate context (Chromium issue 385349).

        Add a use counter API.

        Set host_arch to ia32 on machines with a 32bit userland but a 64bit
        kernel.

        Performance and stability improvements on all platforms.


2014-06-23: Version 3.28.0

        MIPS: Support LiveEdit (Chromium issue 368580).

        Array.concat: properly go to dictionary mode when required (Chromium
        issue 387031).

        Support LiveEdit on ARM (Chromium issue 368580).

        Performance and stability improvements on all platforms.


2014-06-18: Version 3.27.34

        Reduce number of writes to DependentCode array when inserting dependent
        IC (Chromium issue 305878).

        Performance and stability improvements on all platforms.


2014-06-17: Version 3.27.33

        Do GC if CodeRange fails to allocate a block (Chromium issue 305878).

        Throw syntax error when a getter/setter has the wrong number of params
        (issue 3371).

        Performance and stability improvements on all platforms.


2014-06-17: Version 3.27.32

        Performance and stability improvements on all platforms.


2014-06-16: Version 3.27.31

        Version fix.


2014-06-16: Version 3.27.30

        Fix representation of Phis for mutable-heapnumber-in-object-literal
        properties (issue 3392).

        Performance and stability improvements on all platforms.


2014-06-16: Version 3.27.29

        Emulate MLS on pre-ARMv6T2. Cleaned up thumbee vs. thumb2 confusion.

        X87: Fixed flooring division by a power of 2, once again.. (issue 3259).

        Fixed undefined behavior in RNG (Chromium issue 377790).

        Performance and stability improvements on all platforms.


2014-06-13: Version 3.27.28

        Add v8::Promise::Then (Chromium issue 371288).

        Performance and stability improvements on all platforms.


2014-06-12: Version 3.27.27

        Fix detection of VFP3D16 on Galaxy Tab 10.1 (issue 3387).

        Performance and stability improvements on all platforms.


2014-06-12: Version 3.27.26

        MIPS: Fixed flooring division by a power of 2, once again.. (issue
        3259).

        Fixed flooring division by a power of 2, once again.. (issue 3259).

        Fix unsigned comparisons (issue 3380).

        Performance and stability improvements on all platforms.


2014-06-11: Version 3.27.25

        Performance and stability improvements on all platforms.


2014-06-11: Version 3.27.24

        Fix invalid attributes when generalizing because of incompatible map
        change (Chromium issue 382143).

        Fix missing smi check in inlined indexOf/lastIndexOf (Chromium issue
        382513).

        Performance and stability improvements on all platforms.


2014-06-06: Version 3.27.23

        Performance and stability improvements on all platforms.


2014-06-06: Version 3.27.22

        Performance and stability improvements on all platforms.


2014-06-06: Version 3.27.21

        Turn on harmony_collections for es_staging (issue 1622).

        Do not make heap iterable eagerly (Chromium issue 379740).

        Performance and stability improvements on all platforms.


2014-06-05: Version 3.27.20

        Fix invalid loop condition for Array.lastIndexOf() (Chromium issue
        380512).

        Add API support for passing a C++ function as a microtask callback.

        Performance and stability improvements on all platforms.


2014-06-04: Version 3.27.19

        Split Put into Put and Remove.

        ES6: Add support for values/keys/entries for Map and Set (issue 1793).

        Performance and stability improvements on all platforms.


2014-06-03: Version 3.27.18

        Remove PROHIBITS_OVERWRITING as it is subsumed by non-configurable
        properties.

        Performance and stability improvements on all platforms.


2014-06-02: Version 3.27.17

        BuildNumberToString: Check for undefined keys in the cache (Chromium
        issue 368114).

        HRor and HSar can deoptimize (issue 3359).

        Simplify, speed-up correct-context ObjectObserve calls.

        Performance and stability improvements on all platforms.


2014-05-29: Version 3.27.16

        Allow microtasks to throw exceptions and handle them gracefully
        (Chromium issue 371566).

        Performance and stability improvements on all platforms.


2014-05-28: Version 3.27.15

        Performance and stability improvements on all platforms.


2014-05-27: Version 3.27.14

        Reland "Customized support for feedback on calls to Array." and follow-
        up fixes (Chromium issues 377198, 377290).

        Performance and stability improvements on all platforms.


2014-05-26: Version 3.27.13

        Performance and stability improvements on all platforms.


2014-05-26: Version 3.27.12

        Check for cached transition to ExternalArray elements kind (issue 3337).

        Support ES6 weak collections in heap profiler (Chromium issue 376196).

        Performance and stability improvements on all platforms.


2014-05-23: Version 3.27.11

        Add support for ES6 Symbol in heap profiler (Chromium issue 376194).

        Performance and stability improvements on all platforms.


2014-05-22: Version 3.27.10

        Implement Mirror object for Symbols (issue 3290).

        Allow debugger to step into Map and Set forEach callbacks (issue 3341).

        Fix ArrayShift hydrogen support (Chromium issue 374838).

        Use SameValueZero for Map and Set (issue 1622).

        Array Iterator next should check for own property.

        Performance and stability improvements on all platforms.


2014-05-21: Version 3.27.9

        Disable ArrayShift hydrogen support (Chromium issue 374838).

        ES6 Map/Set iterators/forEach improvements (issue 1793).

        Performance and stability improvements on all platforms.


2014-05-20: Version 3.27.8

        Move microtask queueing logic from JavaScript to C++.

        Partial revert of "Next bunch of fixes for check elimination" (Chromium
        issue 372173).

        Performance and stability improvements on all platforms.


2014-05-19: Version 3.27.7

        Performance and stability improvements on all platforms.


2014-05-19: Version 3.27.6

        Performance and stability improvements on all platforms.


2014-05-16: Version 3.27.5

        Performance and stability improvements on all platforms.


2014-05-15: Version 3.27.4

        Drop thenable coercion cache (Chromium issue 372788).

        Skip write barriers when updating the weak hash table (Chromium issue
        359401).

        Performance and stability improvements on all platforms.


2014-05-14: Version 3.27.3

        Performance and stability improvements on all platforms.


2014-05-13: Version 3.27.2

        Harden %SetIsObserved with RUNTIME_ASSERTs (Chromium issue 371782).

        Drop unused static microtask API.

        Introduce an api to query the microtask autorun state of an isolate.

        Performance and stability improvements on all platforms.


2014-05-12: Version 3.27.1

        Object.observe: avoid accessing acceptList properties more than once
        (issue 3315).

        Array Iterator prototype should not have a constructor (issue 3293).

        Fix typos in unit test for Array.prototype.fill().

        Shorten autogenerated error message for functions only (issue 3019,
        Chromium issue 331971).

        Reland "Removed default Isolate." (Chromium issue 359977).

        Performance and stability improvements on all platforms.


2014-05-09: Version 3.27.0

        Unbreak samples and tools.

        Performance and stability improvements on all platforms.


2014-05-08: Version 3.26.33

        Removed default Isolate (Chromium issue 359977).

        Performance and stability improvements on all platforms.


2014-05-07: Version 3.26.32

        Performance and stability improvements on all platforms.


2014-05-06: Version 3.26.31

        Add a basic gn file for V8.

        Performance and stability improvements on all platforms.


2014-05-05: Version 3.26.30

        Introduce a microtask suppression scope and move microtask methods to
        isolate (Chromium issue 369503).

        Re-enable Object.observe and add enforcement for security invariants.

        Move cache line size calculation directly into CPU::FlushICache
        (Chromium issue 359977).

        Generation of our home-grown memmove doesn't depend on serializer state
        anymore (Chromium issue 359977).

        Fix |RunMicrotasks()| leaking reference to the last context being run
        on.

        Object.defineProperty shouldn't be a hint that we're constructing a
        dictionary (Chromium issue 362870).

        Performance and stability improvements on all platforms.


2014-05-01: Version 3.26.29

        Added a Isolate* parameter to Serializer::enabled() (Chromium issue
        359977).

        ES6: Add support for Array.prototype.fill() (issue 3273).

        Performance and stability improvements on all platforms.


2014-04-29: Version 3.26.28

        PromiseThen should ignore non-function parameters (Chromium issue
        347455).

        Performance and stability improvements on all platforms.


2014-04-29: Version 3.26.27

        Error stack getter should not overwrite itself with a data property
        (issue 3294).

        Performance and stability improvements on all platforms.


2014-04-28: Version 3.26.26

        Expose promise value through promise mirror (issue 3093).

        Simplified CPU/CpuFeatures a bit (Chromium issue 359977).

        Performance and stability improvements on all platforms.


2014-04-28: Version 3.26.25

        Add timestamps to CPU profile samples (Chromium issue 363976).

        Expose promise status through promise mirror (issue 3093).

        Remove static CallCompletedCallback handlers.

        Added an Isolate* field to NoTrackDoubleFieldsForSerializerScope,
        PlatformFeatureScope and BinaryOpIC::State (Chromium issue 359977).

        Trigger debug event on not yet caught exception in promises (issue
        3093).

        Unbreak vtunejit=on (issue 3288).

        Performance and stability improvements on all platforms.


2014-04-25: Version 3.26.24

        MIPS: CodeStubs contain their corresponding Isolate* now. (part 2)
        (Chromium issue 359977).

        MIPS: CodeStubs contain their corresponding Isolate* now. (part 1)
        (Chromium issue 359977).

        CodeStubs contain their corresponding Isolate* now. (part 2) (Chromium
        issue 359977).

        Make DescriptorArray::IsMoreGeneralThan() and DescriptorArray::Merge()
        compatible again (Chromium issue 365172).

        CodeStubs contain their corresponding Isolate* now. (part 1) (Chromium
        issue 359977).

        Performance and stability improvements on all platforms.


2014-04-24: Version 3.26.23

        Performance and stability improvements on all platforms.


2014-04-23: Version 3.26.22

        Disable field type tracking by default (Chromium issue 365172).

        Performance and stability improvements on all platforms.


2014-04-23: Version 3.26.21

        Context-allocate all parameters in generators (issue 3280).

        Simplify v8/Isolate teardown (Chromium issue 359977).

        Performance and stability improvements on all platforms.


2014-04-21: Version 3.26.20

        ES6: Add support for Map/Set forEach (Chromium issues 1793, 2323).

        Performance and stability improvements on all platforms.


2014-04-18: Version 3.26.19

        ES6: Add support for Map/Set forEach (Chromium issues 1793, 2323).

        Performance and stability improvements on all platforms.


2014-04-17: Version 3.26.18

        Removed Isolate::EnterDefaultIsolate (Chromium issue 359977).

        Performance and stability improvements on all platforms.


2014-04-16: Version 3.26.17

        Clear invalid field maps in PropertyAccessInfo (Chromium issue 363956).

        ES6: Add support for Map/Set forEach (Chromium issues 1793, 2323).

        Performance and stability improvements on all platforms.


2014-04-16: Version 3.26.16

        Removed EnterIsolateIfNeeded and a soon-to-be-useless assertion
        (Chromium issue 359977).

        Removed GetDefaultIsolate{Debugger,ForLocking,StackGuard} (Chromium
        issue 359977).

        Performance and stability improvements on all platforms.


2014-04-15: Version 3.26.15

        Fix result of LCodeGen::DoWrapReceiver for strict functions and builtins
        (Chromium issue 362128).

        Performance and stability improvements on all platforms.


2014-04-15: Version 3.26.14

        Performance and stability improvements on all platforms.


2014-04-14: Version 3.26.13

        Make maps in monomorphic IC stubs weak (issue 2073).

        x64: Make sure that the upper half of a 64bit register contains 0 for
        int32 values (Chromium issue 360611).

        Performance and stability improvements on all platforms.


2014-04-11: Version 3.26.12

        Do not use ranges after range analysis (Chromium issue 361608).

        Performance and stability improvements on all platforms.


2014-04-10: Version 3.26.11

        Performance and stability improvements on all platforms.


2014-04-10: Version 3.26.10

        Allow the embedder to pass the virtual memory limit to v8.

        Performance and stability improvements on all platforms.


2014-04-09: Version 3.26.9

        Fix invalid local property lookup for transitions (Chromium issue
        361025).

        MIPS: Fixed flooring division by -1 (issue 3259).

        Fixed flooring division by -1 on ARM (issue 3259).

        Make `String.prototype.contains` throw when passing a regular expression
        (issue 3261).

        Performance and stability improvements on all platforms.


2014-04-08: Version 3.26.8

        Yet another regression test for range analysis (issue 3204).

        Performance and stability improvements on all platforms.


2014-04-07: Version 3.26.7

        Performance and stability improvements on all platforms.


2014-04-04: Version 3.26.6

        Performance and stability improvements on all platforms.


2014-04-03: Version 3.26.5

        Performance and stability improvements on all platforms.


2014-04-03: Version 3.26.4

        Make stray 'return' an early error.

        Show references from weak containers as weak in heap snapshots (Chromium
        issue 356590).

        Make invalid LHSs that are calls late errors (Chromium issue 358346).

        Performance and stability improvements on all platforms.


2014-04-02: Version 3.26.3

        Support typed arrays in IsMoreGeneralElementsKindTransition (Chromium
        issue 357054).

        Remove debugger_auto_break flag.

        Store i18n meta data in hidden symbols instead of js accessible
        properties (Chromium issue 354967).

        Performance and stability improvements on all platforms.


2014-04-01: Version 3.26.2

        Performance and stability improvements on all platforms.


2014-04-01: Version 3.26.1

        Fix Type::Intersect to skip uninhabited bitsets (Chromium issue 357330).

        Fix PrepareKeyedOperand on arm (Chromium issue 358057).

        Performance and stability improvements on all platforms.


2014-03-31: Version 3.26.0

        Deprecate Start/StopCpuProfiling methods (issue 3213).

        Don't crash if we get a timezone change notification on an uninitialized
        isolate (Chromium issue 357362).

        Performance and stability improvements on all platforms.


2014-03-28: Version 3.25.30

        NativeContext::map_cache reference should be strong in heap snapshots
        (Chromium issue 357060).

        Performance and stability improvements on all platforms.


2014-03-27: Version 3.25.29

        Performance and stability improvements on all platforms.


2014-03-27: Version 3.25.28

        Performance and stability improvements on all platforms.


2014-03-26: Version 3.25.27

        Promise constructor should not be enumerable (Chromium issue 352597).

        Performance and stability improvements on all platforms.


2014-03-26: Version 3.25.26

        Performance and stability improvements on all platforms.


2014-03-25: Version 3.25.25

        Roll ICU 239289:258359 and add support for external ICU data tables
        (issue 3142, Chromium issue 72633).

        Performance and stability improvements on all platforms.


2014-03-25: Version 3.25.24

        Add support for per-isolate private symbols.

        No longer OOM on invalid string length (issue 3060).

        Remove Failure::OutOfMemory propagation and
        V8::IgnoreOutOfMemoryException (issue 3060).

        Tentative Windows dll build fix: Don't V8_EXPORT ScriptCompiler::Source
        (issue 3228).

        Performance and stability improvements on all platforms.


2014-03-24: Version 3.25.23

        Rename A64 port to ARM64 port (Chromium issue 354405).

        Fix missing access check in Runtime_SetPrototype (Chromium issue
        354123).

        Fix polymorphic hydrogen handling of SLOPPY_ARGUMENTS_ELEMENTS (Chromium
        issue 354391).

        Performance and stability improvements on all platforms.


2014-03-20: Version 3.25.22

        Increase the "local variables in a function" limit (issue 3205).

        Implement ES6 symbol registry and predefined symbols.

        Throw exception on invalid string length instead of OOM (Chromium issue
        349329).

        Performance and stability improvements on all platforms.


2014-03-20: Version 3.25.21

        Performance and stability improvements on all platforms.


2014-03-20: Version 3.25.20

        Fix polymorphic keyed loads for SLOPPY_ARGUMENTS_ELEMENTS (Chromium
        issue 350867).

        Performance and stability improvements on all platforms.


2014-03-19: Version 3.25.19

        Performance and stability improvements on all platforms.


2014-03-19: Version 3.25.18

        Performance and stability improvements on all platforms.


2014-03-19: Version 3.25.17

        Performance and stability improvements on all platforms.


2014-03-18: Version 3.25.16

        Apply numeric casts correctly in typed arrays and related code (Chromium
        issue 353004).

        Performance and stability improvements on all platforms.


2014-03-18: Version 3.25.15

        Don't generate keyed store ICs for global proxies (Chromium issue
        352983).

        MIPS: Make invalid LHSs a parse-time (reference) error (Chromium issue
        351658).

        Make invalid LHSs a parse-time (reference) error (Chromium issue
        351658).

        Add Promises/A+ Compliance Test Suite (Chromium issue 347095).

        Split Promise API into Promise/Resolver.

        Performance and stability improvements on all platforms.


2014-03-17: Version 3.25.14

        Performance and stability improvements on all platforms.


2014-03-17: Version 3.25.13

        Move profiler callback interfaces from v8.h to v8-profiler.h.

        Performance and stability improvements on all platforms.


2014-03-14: Version 3.25.12

        PromiseCoerce should deal with an error during accessing "then"
        (Chromium issue 347095).

        Propagate updated offsets in BoundsCheckBbData (Chromium issue 350863).

        Add regression test for range analysis bug (issue 3204).

        Continued fix for 351257. Reusing the feedback vector is too complex
        (Chromium issue 351257).

        StopCpuProfiling should return non-const CpuProfile (issue 3213).

        Allow for compiling with xcode 5.1 (which doesn't have gcc anymore).

        Performance and stability improvements on all platforms.


2014-03-14: Version 3.25.11

        MIPS: Remove uses of CanBeNegative() in HMod (issue 3204).

        MIPS: Remove uses of RangeCanInclude() in flooring division by power of
        2 (issue 3204).

        MIPS: Fix uses of range analysis results in HChange (issue 3204).

        Make translation of modulus operation '--stress-opt'-proof (Chromium
        issue 352059).

        Remove uses of CanBeNegative() in HMod (issue 3204).

        Remove uses of RangeCanInclude() in flooring division by power of 2
        (issue 3204).

        Fix uses of range analysis results in HChange (issue 3204).

        Performance and stability improvements on all platforms.


2014-03-14: Version 3.25.10

        This version was not committed due to script failures.


2014-03-13: Version 3.25.9

        Reland "Enable Object.observe by default" again (issue 2409).

        Use intrinsics for builtin ArrayBuffer property accesses (Chromium issue
        351787).

        Performance and stability improvements on all platforms.


2014-03-12: Version 3.25.8

        Fix HIsSmiAndBranch::KnownSuccessorBlock() by deleting it (Chromium
        issue 351320).

        Fix handling of polymorphic array accesses with constant index (Chromium
        issue 351319).

        Fix lazy deopt after tagged binary ops (Chromium issue 350434).

        MIPS: Cleanup some of the range uses in ModI/DivI (issue 3204).

        Fix issue with getOwnPropertySymbols and hidden properties (Chromium
        issue 350864).

        Cleanup some of the range uses in ModI/DivI (issue 3204).

        PromiseCoerce should ignore primitive values (Chromium issue 347095).

        Use a per-isolate cache for the date object JS bits (Chromium issue
        348856).

        Performance and stability improvements on all platforms.


2014-03-11: Version 3.25.7

        Promise.all and Promise.race should reject non-array parameter (Chromium
        issue 347453).

        Promise.all and Promise race should use "then" rather than "chain"
        (Chromium issue 347427).

        Merge the "Compute Minus Zero Checks" phase into the range analysis
        (issue 3204).

        Performance and stability improvements on all platforms.


2014-03-10: Version 3.25.6

        Replace the recursion in PropagateMinusZeroChecks() with a loop and a
        worklist (issue 3204).

        Reland "Enable Object.observe by default" (issue 2409).

        Enable Object.observe by default (issue 2409).

        AllocationTracker now maintains a map from address range to stack trace
        that allocated the range. When snapshot is generated the map is used to
        find construction stack trace for an object using its address (Chromium
        issue 277984).

        Introduce Runtime_GetAllScopesDetails to get all scopes at once for a
        frame (Chromium issue 340285).

        Reduce heavy runtime calls from debug mirrors (Chromium issue 340285).

        Check and clear date cache in DateCurrentTime, DateLocalTimezone and
        getTimezoneOffset (Chromium issue 142141).

        Performance and stability improvements on all platforms.


2014-03-06: Version 3.25.5

        Fix HConstants with Smi-ranged HeapNumber values (Chromium issue
        349878).

        Fix issues with JSON stringify replacer array (issues 3200, 3201).

        Performance and stability improvements on all platforms.


2014-03-05: Version 3.25.4

        x64: Fix LMathMinMax for constant Smi right-hand operands (Chromium
        issue 349079).

        Performance and stability improvements on all platforms.


2014-03-04: Version 3.25.3

        Clear optimized code cache in shared function info when code gets
        deoptimized (Chromium issue 343609).

        Fixed constant folding for Math.clz32 (Chromium issue 347906).

        Fix JSObject::PrintTransitions (Chromium issue 347912).

        Fix handling of constant global variable assignments (Chromium issue
        347904).

        Removed bogus ASSERT (Chromium issue 347542).

        Mark HCompareMap as having Tagged representation (Chromium issue
        346636).

        Fix crasher in Object.getOwnPropertySymbols (Chromium issue 346141).

        Fix the bit massaging code in CompleteParserRecorder::WriteNumber
        (Chromium issue 346221).

        Don't eliminate loads with incompatible types or representations
        (Chromium issue 346343).

        Check that after a weak callback, the handle is either dead or strong
        (Chromium issue 346061).

        Lazy preparsing vs. lazy parsing fix (Chromium issue 346207).

        Performance and stability improvements on all platforms.


2014-02-25: Version 3.25.2

        Fix the bit massaging code in CompleteParserRecorder::WriteNumber
        (Chromium issue 346221).

        Revert r19455 "Load target types and handlers before IC computation."
        (Chromium issue 346149).

        Don't eliminate loads with incompatible types or representations
        (Chromium issue 346343).

        Fix for a smi stores optimization on x64 with a regression test
        (Chromium issue 345715).

        Check that after a weak callback, the handle is either dead or strong
        (Chromium issue 346061).

        negative bounds checking on realm calls (Chromium issue 344285).

        Lazy preparsing vs. lazy parsing fix (Chromium issue 346207).

        Fix optimistic BCE to back off after deopt (issue 3176).

        Performance and stability improvements on all platforms.


2014-02-21: Version 3.25.1

        Performance and stability improvements on all platforms.


2014-02-19: Version 3.25.0

        ES6: Tighten up Object.prototype.__proto__ (issue 3064).

        Fix Hydrogen bounds check elimination (Chromium issue 344186).

        Performance and stability improvements on all platforms.


2014-02-19: Version 3.24.40

        A64: Let the MacroAssembler resolve branches to distant targets (issue
        3148).

        Fixed and improved code for integral division. Fixed and extended tests
        (issue 3151).

        MIPS: Fix assignment of function name constant (issue 3138).

        Fix assignment of function name constant (issue 3138).

        Performance and stability improvements on all platforms.


2014-02-14: Version 3.24.39

        Introduce --job-based-sweeping flag and use individual jobs for sweeping
        if set (issue 3104).

        Performance and stability improvements on all platforms.


2014-02-13: Version 3.24.38

        Merge experimental/a64 to bleeding_edge (issue 3113).

        Performance and stability improvements on all platforms.


2014-02-12: Version 3.24.37

        Fix spec violations in JSON.stringify wrt replacer array (issue 3135).

        Performance and stability improvements on all platforms.


2014-02-11: Version 3.24.36

        Fix inconsistencies wrt whitespaces (issue 3109).

        Performance and stability improvements on all platforms.


2014-02-10: Version 3.24.35

        Fix inconsistencies wrt whitespaces (issue 3109).

        Performance and stability improvements on all platforms.


2014-02-07: Version 3.24.34

        Performance and stability improvements on all platforms.


2014-02-06: Version 3.24.33

        Allow externalizing strings in old pointer space (Chromium issue
        268686).

        Performance and stability improvements on all platforms.


2014-02-05: Version 3.24.32

        Add Box object to heap profiler.

        Check the offset argument of TypedArray.set for fitting into Smi
        (Chromium issue 340125).

        Performance and stability improvements on all platforms.


2014-02-04: Version 3.24.31

        Fix short-circuiting logical and/or in HOptimizedGraphBuilder (Chromium
        issue 336148).

        Elements field of newly allocated JSArray could be left uninitialized in
        some cases (fast literal case) (Chromium issue 340124).

        Re-enable escape analysis.

        Performance and stability improvements on all platforms.


2014-02-03: Version 3.24.30

        Performance and stability improvements on all platforms.


2014-02-01: Version 3.24.29

        Performance and stability improvements on all platforms.


2014-01-31: Version 3.24.28

        Don't crash in Array.join() if the resulting string exceeds the max
        string length (Chromium issue 336820).

        Implements ES6 String.prototype.normalize method (issue 2943).

        Performance and stability improvements on all platforms.


2014-01-30: Version 3.24.27

        Performance and stability improvements on all platforms.


2014-01-29: Version 3.24.26

        ES6: Map and Set needs to normalize minus zero (issue 3069).

        Make `String.prototype.{starts,ends}With` throw when passing a regular
        expression (issue 3070).

        Performance and stability improvements on all platforms.


2014-01-28: Version 3.24.25

        Performance and stability improvements on all platforms.


2014-01-27: Version 3.24.24

        MIPS: Reduce the stack requirements of GetNoCodeAgeSequence (issue
        3111).

        Delete v8_shell target now that chrome uses d8 (Chromium issue 331585).

        ARM: Reduce the stack requirements of GetNoCodeAgeSequence (issue 3111).

        Performance and stability improvements on all platforms.


2014-01-24: Version 3.24.23

        Performance and stability improvements on all platforms.


2014-01-23: Version 3.24.22

        Fix compilation on x64 architectures (issue 3110).

        Ensure we don't overwrite transitions in SetPropertyIgnoreAttributes
        (Chromium issue 326155).

        ES6: Implement Object.setPrototypeOf (issue 2675).

        Fixed floor-of-div optimization (Chromium issue 334708).

        Performance and stability improvements on all platforms.


2014-01-22: Version 3.24.21

        Performance and stability improvements on all platforms.


2014-01-21: Version 3.24.20

        ES6: Implement Object.setPrototypeOf (issue 2675).

        Performance and stability improvements on all platforms.


2014-01-20: Version 3.24.19

        Introduce a setting to control the toolset for which d8 is compiled
        (issue 1775).

        Performance and stability improvements on all platforms.


2014-01-17: Version 3.24.18

        Performance and stability improvements on all platforms.


2014-01-16: Version 3.24.17

        Make cells pointing to JSObjects weak in optimized code (issue 2073).

        Performance and stability improvements on all platforms.


2014-01-15: Version 3.24.16

        Annotate mapped memory regions for LeakSanitizer (Chromium issue
        328552).

        Turn Runtime_MigrateInstance into Runtime_TryMigrateInstance (Chromium
        issue 315252).

        Performance and stability improvements on all platforms.


2014-01-14: Version 3.24.15

        Introduce an API mirroring the gc extension.

        Performance and stability improvements on all platforms.


2014-01-10: Version 3.24.14

        ES6: Add Object.getOwnPropertySymbols (issue 3049).

        Performance and stability improvements on all platforms.


2014-01-09: Version 3.24.13

        Add Isolate parameter to HandleScope::NumberOfHandles (Chromium issue
        324225).

        Removed v8::AssertNoGCScope.

        Performance and stability improvements on all platforms.


2014-01-08: Version 3.24.12

        Correctly handle instances without elements in polymorphic keyed
        load/store (Chromium issue 331416).

        Fix selection of popular pages in store buffer (Chromium issue 331444).

        Prepare removal of ObjectTemplate::New without Isolate parameter
        (Chromium issue 324225).

        Performance and stability improvements on all platforms.


2014-01-07: Version 3.24.11

        Remove generated makefiles on linux when running gyp_v8
        (Chromium issue 331475)

        Fix building d8 with readline support due to API changes

        Performance and stability improvements on all platforms.


2014-01-03: Version 3.24.10

        Reland r18383: More API cleanup (Chromium issue 324225).

        MIPS: Fix loading of global object in LWrapReceiver (Chromium issue
        318420).

        Performance and stability improvements on all platforms.


2014-01-02: Version 3.24.9

        Performance and stability improvements on all platforms.


2013-12-30: Version 3.24.8

        ARM: fix loading of global object in LWrapReceiver (Chromium issue
        318420).

        Fix a race between concurrent recompilation and OSR (Chromium issue
        330046).

        Turn off concurrent sweeping (issue 3071).

        Performance and stability improvements on all platforms.


2013-12-23: Version 3.24.7

        Fix small spec violation in String.prototype.split (issue 3026).

        Correctly resolve forcibly context allocated parameters in debug-
        evaluate (Chromium issue 325676).

        Introduce Function::GetBoundFunction. 

        Performance and stability improvements on all platforms.


2013-12-20: Version 3.24.6

        Performance and stability improvements on all platforms.


2013-12-19: Version 3.24.5

        Performance and stability improvements on all platforms.


2013-12-18: Version 3.24.4

        Removed all stuff marked as V8_DEPRECATED.

        Performance and stability improvements on all platforms.


2013-12-17: Version 3.24.3

        Performance and stability improvements on all platforms.


2013-12-17: Version 3.24.2

        Flush instruction cache for deserialized code objects.

        Performance and stability improvements on all platforms.


2013-12-13: Version 3.24.1

        Fix polymorphic inlined calls with migrating prototypes.

        Fixed global object leak caused by overwriting the global receiver (the
        global proxy) in the global object with the global object itself
        (Chromium issue 324812).

        Initialize Date parse cache with SMI instead of double to workaround
        sharing mutable heap numbers in snapshot (Chromium issue 280531).

        Switch armv7 setting to arm_version==7 in v8 gyp files (Chromium issue
        234135).

        Performance and stability improvements on all platforms.


2013-12-09: Version 3.24.0

        Performance and stability improvements on all platforms.


2013-12-04: Version 3.23.18

        Performance and stability improvements on all platforms.


2013-12-03: Version 3.23.17

        Performance and stability improvements on all platforms.


2013-12-02: Version 3.23.16

        Array builtins need to be prevented from changing frozen objects, and
        changing structure on sealed objects (Chromium issue 299979).

        Performance and stability improvements on all platforms.


2013-11-29: Version 3.23.15

        Fix context register allocation in LTransitionElementsKind
        (Chromium issue 324306).

        Fix bug in inlining Function.apply (Chromium issue 323942).

        Ensure that length is Smi in TypedArrayFromArrayLike constructor
        (Chromium issue 324028).

        Performance and stability improvements on all platforms.


2013-11-28: Version 3.23.14

        Shorten autogenerated error message (issue 3019).

        Performance and stability improvements on all platforms.


2013-11-27: Version 3.23.13

        Increase precision for base conversion for large integers (issue 3025).

        Flatten cons string for single character substrings (Chromium issue
        323041).

        Performance and stability improvements on all platforms.


2013-11-26: Version 3.23.12

        Performance and stability improvements on all platforms.


2013-11-25: Version 3.23.11

        Deprecate old versions of Isolate::SetData and GetData.

        Performance and stability improvements on all platforms.


2013-11-22: Version 3.23.10

        Remove preemption thread and API.
        (issue 3004)

        Performance and stability improvements on all platforms.


2013-11-21: Version 3.23.9

        API: Change AdjustAmountOfExternalAllocatedMemory calls to use int64_t
        instead of intptr_t.

        Remove deprecated v8::SetResourceConstraints without Isolate parameter.

        Remove deprecated v8-defaults.h and defaults.cc.
        (Chromium issue 312241)

        Make it possible to add more than one piece of embedder data to
        isolates.
        (Chromium issue 317398)

        Performance and stability improvements on all platforms.


2013-11-20: Version 3.23.8

        Fixed crashes exposed though fuzzing.
        (Chromium issue 320948)

        Deprecated v8::External::New without Isolate parameter.

        Made number of available threads isolate-dependent and exposed it to
        ResourceConstraints.
        (issue 2991)

        Performance and stability improvements on all platforms.


2013-11-19: Version 3.23.7

        Bugfix: dependent code field in AllocationSite was keeping code objects
        alive even after context death.
        (Chromium issue 320532)

        Fixed data view accessors to throw execptions on offsets bigger than
        size_t.
        (issue 3013)

        Performance and stability improvements on all platforms.


2013-11-18: Version 3.23.6

        Limit size of dehoistable array indices.
        (Chromium issues 319835, 319860)

        Limit the size for typed arrays to MaxSmi.
        (Chromium issue 319722)

        Performance and stability improvements on all platforms.


2013-11-15: Version 3.23.5

        Fixed missing type feedback check for Generic*String addition.
        (Chromium issue 318671)

        Fixed duplicate check in DependentCode::Insert.
        (Chromium issue 318454)

        Performance and stability improvements on all platforms.


2013-11-14: Version 3.23.4

        Fixed overflow in TypedArray initialization function.
        (Chromium issue 319120)

        Performance and stability improvements on all platforms.


2013-11-13: Version 3.23.3

        Fixed compilation with GCC 4.8.
        (issue 2767, 2149)

        Added explicit Isolate parameter to External::New.
        (Chromium issue 266838)

        Performance and stability improvements on all platforms.


2013-11-12: Version 3.23.2

        Fixed --extra-code flag for snapshot creation.
        (issue 2994)

        Fixed error message wording when instanceof throws.
        (Chromium issue 82797, issue 1593)

        Performance and stability improvements on all platforms.


2013-11-08: Version 3.23.1

        Made HCapturedObjects non-deletable for DCE. (issue 2987)

        Use a fixed random seed per default. (issue 1880, 2885)

        Fixed y-umlaut to uppercase. (issue 2984)

        Performance and stability improvements on all platforms.


2013-11-06: Version 3.23.0

        Fixed loading message from an Error object.  (Chromium issue 306220)

        Made Object.freeze/seal/preventExtensions observable. (issue 2975, 2941)

        Made snapshots reproducible. (issue 2885)

        Added missing negative dictionary lookup to NonexistentHandlerFrontend.
        (issue 2980)

        Performance and stability improvements on all platforms.


2013-10-31: Version 3.22.24

        Fixed uint32-to-smi conversion in Lithium.
        (Chromium issue 309623)

        Performance and stability improvements on all platforms.


2013-10-28: Version 3.22.23

        Renamed deprecated __attribute__((no_address_safety_analysis)) to
        __attribute__((no_sanitize_address)) (Chromium issue 311283)

        Defined DEBUG for v8_optimized_debug=2

        Performance and stability improvements on all platforms.


2013-10-25: Version 3.22.22

        Record allocation stack traces. (Chromium issue 277984,v8:2949)

        Performance and stability improvements on all platforms.


2013-10-24: Version 3.22.21

        Performance and stability improvements on all platforms.


2013-10-24: Version 3.22.20

        Made Array.prototype.pop throw if the last element is not configurable.

        Fixed HObjectAccess for loads from migrating prototypes.
        (Chromium issue 305309)

        Enabled preaging of code objects when --optimize-for-size.
        (Chromium issue 280984)

        Exposed v8::Function::GetDisplayName to public API.
        (Chromium issue 17356)

        Performance and stability improvements on all platforms.


2013-10-23: Version 3.22.19

        Fix materialization of captured objects with field tracking.
        (Chromium issue 298990)

        Performance and stability improvements on all platforms.


2013-10-22: Version 3.22.18

        Add tool to visualize machine code/lithium.

        Handle misaligned loads and stores in load elimination. Do not track
        misaligned loads and be conservative about invalidating misaligned
        stores. (issue 2934)

        Performance and stability improvements on all platforms.


2013-10-21: Version 3.22.17

        Harmony: Implement Math.trunc and Math.sign. (issue 2938)

        Performance and stability improvements on all platforms.


2013-10-21: Version 3.22.16

        Performance and stability improvements on all platforms.


2013-10-18: Version 3.22.15

        Enabled calling the SetReference* & SetObjectGroupId functions with a
        Persistent.

        Performance and stability improvements on all platforms.


2013-10-17: Version 3.22.14

        Performance and stability improvements on all platforms.


2013-10-16: Version 3.22.13

        Do not look up ArrayBuffer on global object in typed array constructor.
        (issue 2931)

        Performance and stability improvements on all platforms.


2013-10-15: Version 3.22.12

        Added histograms to track fraction of heap spaces and percentage of
        generated crankshaft code.

        Moved v8_optimized_debug default value to standalone.gypi.

        Track JS allocations as they arrive with no affection on performance
        when tracking is switched off (Chromium issue 277984).

        Performance and stability improvements on all platforms.


2013-10-14: Version 3.22.11

        Performance and stability improvements on all platforms.


2013-10-11: Version 3.22.10

        Fixed timezone issues with date-time/parse-* tests.
        (Chromium issue 2919)

        Added column getter to CpuProfileNode (Chromium issue 302537)

        Performance and stability improvements on all platforms.


2013-10-10: Version 3.22.9

        Ensure only whitelisted stubs have sse2 versions in the snapshot.
        (fix for chromium 304565)

        Implement ArrayBuffer.isView.

        Performance and stability improvements on all platforms.


2013-10-04: Version 3.22.8

        Performance and stability improvements on all platforms.


2013-10-03: Version 3.22.7

        Debug: Allow stepping into on a given call frame
        (Chromium issue 296963).

        Always use timeGetTime() for TimeTicks::Now() on Windows
        (Chromium issue 288924).

        Performance and stability improvements on all platforms.


2013-10-02: Version 3.22.6

        Performance and stability improvements on all platforms.


2013-10-01: Version 3.22.5

        Disabled externalization of sliced/cons strings in old pointer space
        (Chromium issue 276357).

        Turned on handle zapping for release builds

        Performance and stability improvements on all platforms.


2013-09-30: Version 3.22.4

        Function::Call and Object::CallAsFunction APIs should allow v8::Value as
        a receiver (issue 2915).

        Removed unnecessary mutex (Chromium issue 291236).

        Removed ArrayBufferView::BaseAddress method.

        Performance and stability improvements on all platforms.


2013-09-27: Version 3.22.3

        Added methods to enable configuration of ResourceConstraints based on
        limits derived at runtime.
        (Chromium issue 292928)

        Added -optimize-for-size flag to optimize for memory size (will be used
        by pre-aging CL), and removed the is_memory_constrained
        ResourceConstraint.
        (Chromium issue 292928)

        Performance and stability improvements on all platforms.


2013-09-26: Version 3.22.2

        Performance and stability improvements on all platforms.


2013-09-25: Version 3.22.1

        Sped up creating typed arrays from array-like objects.
        (Chromium issue 270507)

        Performance and stability improvements on all platforms.


2013-09-23: Version 3.22.0

        LiveEdit to mark more closure functions for re-instantiation when scope
        layout changes.
        (issue 2872)

        Made bounds check elimination iterative instead of recursive.
        (Chromium issue 289706)

        Turned on i18n support by default.

        Set the proper instance-type on HAllocate in BuildFastLiteral.
        (Chromium issue 284577)

        Performance and stability improvements on all platforms.


2013-09-18: Version 3.21.17

        Implemented local load/store elimination on basic blocks.

        Added mutex when accessing concurrent recompilation output queue.
        (Chromium issue 291236)

        Don't lookup the cache for the result of Function::New.
        (Chromium issue 272579)

        Tweaked HConstant::EmitAtUses() to eliminate useless constant
        generation.
        (Chromium issue 2881)

        Performance and stability improvements on all platforms.


2013-09-16: Version 3.21.16

        Every place where AllocationMemento is initialized with an
        AllocationSite is now checked to be sure a valid Site goes in. This is
        temporary code to diagnose chromium bug 284577.

        Performance and stability improvements on all platforms.


2013-09-13: Version 3.21.15

        Non-JSObject heap objects are now handled using slow-path IC stub
        guarded by the map.
        (Chromium issue 280632)

        i18n Javascript code added to the snapshot.
        (V8 issue 2745)

        Performance and stability improvements on all platforms.

2013-09-12: Version 3.21.14

        Added access check for observed objects.
        (V8 issue 2778)

        Cleaned up v8::ArrayBuffer::Allocator interface.
        (V8 issue 2823)

        Performance and stability improvements on all platforms.

2013-09-11: Version 3.21.13

        Added a ResourceConstraint for the embedder to specify that V8 is
        running on a memory constrained device.
        (Chromium issue 280984)

        Removed HandleScope default ctor.
        (Chromium issue 236173)

        Enabled escape analysis for Hydrogen.

        Correctly stringified mixed encoding indirect strings.
        (Chromium issue 287476)

        Performance and stability improvements on all platforms.


2013-09-09: Version 3.21.12

        Fixed bitwise negation on x64.
        (Chromium issue 285355)

        Dropped GetCurrentThreadId() and TerminateExecution(int) from 
	the external API.

        Fixed polymorphic INTERCEPTOR StoreICs on ARM/MIPS.
        (Chromium issue 284998)

        Added check if timeout has expired after processing each sample.
        (issue 2814,v8:2871)

        Removed obsolete global V8::has_been_fooed flags.
        (issue 2744)

        Performance and stability improvements on all platforms.


2013-09-05: Version 3.21.11

        Performance and stability improvements on all platforms.


2013-09-04: Version 3.21.10

        Fixed Eternal::IsEmpty logic (issue 2870).

        Performance and stability improvements on all platforms.


2013-09-03: Version 3.21.9

        Deprecated Persistent functions which were marked to be deprecated.

        Allowed uncacheable identifiers to go generic (issue 2867).

        Performance and stability improvements on all platforms.


2013-09-02: Version 3.21.8

        Added scriptId to StackTrace frames (issue 2865).

        Performance and stability improvements on all platforms.


2013-08-30: Version 3.21.7

        Fixed casts of eternal handles.

        Turned on global handle zapping.

        Always visit branches during HGraph building (Chromium issue 280333).

        Profiler changes: removed deprecated API, support higher sampling
        rate on Windows.

        Performance and stability improvements on all platforms.


2013-08-29: Version 3.21.6

        Fixed inlined 'throw' statements interfering with live range
        computation. (issue 2843)

        Performance and stability improvements on all platforms.


2013-08-28: Version 3.21.5

        Fixed compilation with recent MinGW64 versions. (issue 2300)

        Added RemovePrototype to FunctionTemplate. (Chromium issue 272440)

        Performance and stability improvements on all platforms.


2013-08-26: Version 3.21.4

        Lowered kInitialMaxFastElementArray constant to 95K (issue 2790).

        Use signals for cpu profiling on Mac OS X (issue 2814).

        Deprecated CpuProfileNode::GetSelfSamplesCount (Chromium issue 267595).

        Added support for higher CPU profiler sampling rate on posix systems
        (issue 2814).

        Worked around 'inlining failed' build error with older GCC 4.x releases.

        Added source map support to tick processor.

        Stability improvements on all platforms.


2013-08-23: Version 3.21.3

        Temporarily disabled optimization for StringWrappers to use native
        valueOf. (issue 2855)

        Fixed crash on function declarations in eval inside non-trivial local
        scope. (issue 2594)

        Rewrote SamplingCircularQueue. (issue 2814)

        Fixed hidden properties on object with frozen prototype. (issue 2829)

        Fix deoptimization bug. (Chromium issue 274164)

        Stability improvements on all platforms.


2013-08-22: Version 3.21.2

        Stability improvements on all platforms.


2013-08-21: Version 3.21.1

        Promoted ArrayBuffer, DataView and typed arrays to non-experimental.
        (Chromium issue 270527)

        Replaced OS::MemCopy with memcpy in typed array initialization.
        (Chromium issue 270642)

        Moved i18n break iterator C++ code to runtime (issue 2745)

        Fixed invalid out-of-bounds store in MacroAssembler::Allocate.
        (Chromium issue 263515)

        Fixed register misuse in Allocate() on ARM. (issue 2851)

        Fixed empty handle dereference in Runtime_InternalNumberFormat.
        (Chromium issue 275467)

        Performance and stability improvements on all platforms.


2013-08-19: Version 3.21.0

        Fixed GC-related crasher (Chromium issue 274438)

        Reverted making Intl non-enumerable.

        Performance and stability improvements on all platforms.


2013-08-14: Version 3.20.17

        Fixed Math.round/floor that had bogus Smi representation
        (Chromium issue 272564)

        Performance and stability improvements on all platforms.


2013-08-13: Version 3.20.16

        Fixed bug in HPhi::SimplifyConstantInput (Chromium issue 269679)

        Fixed gcmole bugs in i18n code (issue 2745)

        ia32: Calls to the TranscendentalCacheStub must ensure that esi is
        set (issue 2827)

        Made sure polymorphic element access creates non-replaying
        phis. (issue 2815)

        Allowed HPhis to have an invalid merge index. (issue 2815)

        Fixed smi-based math floor. (Chromium issue 270268)

        Deprecated self and total time getters and total sample count
        getter on CpuProfileNode. (Chromium issue 267595)

        Fixed Object.freeze, Object.observe wrt CountOperation and
        CompoundAssignment. (issue 2774,2779)

        Performance and stability improvements on all platforms.


2013-08-07: Version 3.20.15

        Exposed eternal handle api.

        Bugfix to solve issues with enabling V8 typed arrays in Blink.

        Fixed Array index dehoisting.  (Chromium issue 264203)

        Updated Array Iterator to use numeric indexes (issue 2818)

        Return start/end profiling time in microseconds instead of milliseconds
        (issue 2824)

        Performance and stability improvements on all platforms.


2013-08-06: Version 3.20.14

        Added new Harmony methods to Array.prototype object.
        (issue 2776,v8:2777)

        Performance and stability improvements on all platforms.


2013-08-01: Version 3.20.12

        Removed buggy ToNumber truncation (partial fix for issue 2813)

        Calling Map etc without new should throw TypeError (issue 2819)

        Fixed a crash for large code objects on ARM (Chromium issue 2736)

        Fixed stale unhandlified value in JSObject::SetPropertyForResult.
        (Chromium issue 265894)

        Added new Harmony methods to String.prototype object.
        (issue 2796,v8:2797,v8:2798,v8:2799)

        Performance and stability improvements on all platforms.


2013-07-30: Version 3.20.11

        Performance and stability improvements on all platforms.


2013-07-29: Version 3.20.10

        Performance and stability improvements on all platforms.


2013-07-26: Version 3.20.9

        Check that ExternalString objects get aligned resources.

        Fixed JSArray-specific length lookup in polymorphic array handling
        (Chromium issues 263276, 263905).

        Performance and stability improvements on all platforms.


2013-07-24: Version 3.20.8

        Deprecated v8::V8::Pause/ResumeProfiler.

        Fixed Chromium issues 247688, 258519 and 260203.

        Performance and stability improvements on all platforms.


2013-07-22: Version 3.20.7

        Deprecated some debugger methods.

        Fixed wrong bailout id in polymorphic stores (Chromium issue 259787).

        Fixed data race in SamplingCircularQueue (Chromium issue 251218).

        Fixed type feedback in presence of negative lookups
        (Chromium issue 252797).

        Do not materialize context-allocated values for debug-evaluate
        (Chromium issue 259300).

        Synchronized Compare-Literal behavior in FullCodegen and Hydrogen
        (Chromium issue 260345).

        Performance and stability improvements on all platforms.


2013-07-17: Version 3.20.6

        Try to remove invalidated stubs before falling back to checking the
        constant state (Chromium issue 260585).

        Fixed gyp_v8 to work with use_system_icu=1 (issue 2475).

        Fixed sloppy-mode 'const' under Harmony flag (Chromium issue 173361).

        Use internal array as API function cache  (Chromium issue 260106).

        Fixed possible stack overflow in range analysis
        (Chromium issue 259452).

        Performance and stability improvements on all platforms.


2013-07-15: Version 3.20.5

        Ensured that the length of frozen arrays is immutable
        (issue 2711, Chromium issue 259548).

        Performance and stability improvements on all platforms.


2013-07-10: Version 3.20.4

        Fixed garbage-collection issue that causes a crash on ARM
        (Chromium issue 254570)

        Performance and stability improvements on all platforms.


2013-07-08: Version 3.20.3

        Performance and stability improvements on all platforms.


2013-07-05: Version 3.20.2

        Remove deprecated heap profiler methods from V8 public API

        Mark i18n functions as native and set proper names
        (issue 2745)

        Correctly report stack trace when current function is FunctionApply
        builtin (Chromium issue 252097)

        Enable GDBJIT interface for standalone by default.

        Fix debuggersupport=off build. (issue 2754)

        Introduce -m64 flag for making x64 when the default gcc compiler is for
        X32

        Performance and stability improvements on all platforms.


2013-07-02: Version 3.20.1

        Implemented WeakMap.prototype.clear function. (issue 2753)

        Ensure CheckInitialized is present independent of define.
        (Chromium issue 255779)

        Performance and stability improvements on all platforms.


2013-06-28: Version 3.20.0

        Migrated several tests from blink to V8 repository.

        Allowed users of the V8 API to distinguish between unset and undefined
        HiddenValues (issue 2746).

        Deprecated old style callbacks in the V8 API.

        Turned on parallel recompilation.

        Performance and stability improvements on all platforms.


2013-06-18: Version 3.19.18

	Fixed read-only attribute of Function.length in strict mode.
	(issue 2705)

	Fixed Runtime_SetProperty to properly handle OOM failures
	(Chromium issue 249873)

	Emit deprecated check for constant function transitions.
	(Chromium issue 250609)
	
	Made MathFloorOfDiv optimization trigger more often
	(Issue 2205)

	Make more GCs in idle notification handler.
	(Chromium issue 241815)

	Increased default type info threshold.
	(Issue 2730)

        Performance and stability improvements on all platforms.


2013-06-14: Version 3.19.16

        Performance and stability improvements on all platforms.


2013-06-13: Version 3.19.15

        Performance and stability improvements on all platforms.


2013-06-13: Version 3.19.14

        Fixed crashes when calling new Array(a) with a single argument that
        could result in creating a holey array with a packed elements kind.
        (Chromium issue 245480)

        Fixed issues in parallel compilation.
        (Chromium issue 248076)

        Performance and stability improvements on all platforms.


2013-06-11: Version 3.19.13

        Performance and stability improvements on all platforms.


2013-06-10: Version 3.19.12

        Fixed arguments array access. (Chromium issue 247303)

        Fixed bug in LookupForWrite. (Chromium issue 242332)

        Performance and stability improvements on all platforms.


2013-06-07: Version 3.19.11

        Performance and stability improvements on all platforms.


2013-06-06: Version 3.19.10

        Performance and stability improvements on all platforms.


2013-06-05: Version 3.19.9

        Implemented Load IC support for loading properties from primitive
        values to avoid perpetual soft deopts.  (Chromium issue 242512)

        Implemented Freeing of PerThreadAssertData when possible to avoid
        memory leak. (Chromium issue 246567)

        Removed V8_USE_OLD_STYLE_PERSISTENT_HANDLE_VISITORS.

        Performance and stability improvements on all platforms.


2013-06-03: Version 3.19.8

        Fixed bug with inlining 'Array' function. (Chromium issue 244461)

        Fixed initialization of literal objects. (Chromium issue 245424)

        Fixed function name inferred inside closures. (Chromium issue 224884)

        Performance and stability improvements on all platforms.


2013-05-31: Version 3.19.7

        Added support for //# sourceURL similar to deprecated //@ sourceURL one.
        (issue 2702)

        Made sure IfBuilder::Return clears the current block.
        (Chromium issue 243868)

        Fixed two CPU profiler tests on ARM and MIPS simulators
        (issue 2628)

        Fixed idle incremental GC for large objects.
        (Chromium issue 241815)

        Disabled --optimize-constructed-arrays due to crashes
        (Chromium issue 244461)

        Performance and stability improvements on all platforms.


2013-05-28: Version 3.19.6

        Fixed IfBuilder::Deopt to clear the current block
        (Chromium issue 243868).

        Performance and stability improvements on all platforms.


2013-05-27: Version 3.19.5

        Reset regexp parser flag after scanning ahead for capture groups.
        (issue 2690)

        Removed flakiness in test-cpu-profiler/SampleWhenFrameIsNotSetup.
        (issue 2628)

        Performance and stability improvements on all platforms.


2013-05-24: Version 3.19.4

        Fixed edge case in stack trace formatting. (Chromium issue 237617)

        Fixed embedded new-space pointer in LCmpObjectEqAndBranch. (Chromium
	issue 240032)

        Made Object.freeze fast (issue 1858, Chromium issue 115960)

        Fixed bogus deopt in BuildEmitDeepCopy for holey arrays. (Chromium issue
        242924)

        Performance and stability improvements on all platforms.


2013-05-22: Version 3.19.3

        Performance and stability improvements on all platforms.


2013-05-17: Version 3.19.2

        Fill in one-word-fillers for the unused property fields
        (Chromium issue 240056).

        Removed use_system_v8 logic from the mainline gyp file
        (Chromium issue 226860).

        Skip CPU profiler samples where top function's stack frame is not
        set up properly (issue 2628).

        Performance and stability improvements on all platforms.


2013-05-14: Version 3.19.1

        Fixed missing hole check for loads from Smi arrays when all uses are
        changes (Chromium issue 233737)

        Performance and stability improvements on all platforms.


2013-05-10: Version 3.19.0

        Deprecated Context::New which returns Persistent.

        Added Persistent::Reset which disposes the handle and redirects it to
        point to another object.

        Deprecated WriteAscii and MayContainNonAscii.

        Exposed AssertNoAllocation to API.

        Performance and stability improvements on all platforms.


2013-04-30: Version 3.18.5

        Allowed setting debugger breakpoints on CompareNilICs (issue 2660)

        Fixed beyond-heap load on x64 Crankshafted StringCharFromCode
        (Chromium issue 235311)

        Change 'Parse error' to three more informative messages.
        (Chromium issue 2636)

        Performance and stability improvements on all platforms.


2013-04-26: Version 3.18.4

        Added a preliminary API for ES6 ArrayBuffers

        Replaced qsort with std::sort. (Chromium issue 2639)

        Performance and stability improvements on all platforms.


2013-04-24: Version 3.18.3

        Exposed the GC under a name that is less collision prone than window.gc.
        (issue 2641)

        Do not emit double values at their use sites. (Chromium issue 234101)

        Added methods to allow resuming execution after calling
        TerminateExecution(). (issue 2361)

        Performance and stability improvements on all platforms.


2013-04-22: Version 3.18.2

        OS::MemMove/OS::MemCopy: Don't call through to generated code when size
        == 0 to avoid prefetching invalid memory (Chromium issue 233500)

        Removed heap snapshot size limit. (Chromium issue 232305)

        Performance and stability improvements on all platforms.


2013-04-18: Version 3.18.1

        Removed SCons related files and deprecated test suite configurations.

        Improved handling of unary plus (issue 2527).

        Performance and stability improvements on all platforms.


2013-04-17: Version 3.18.0

        Enabled pretenuring of fast literals in high promotion mode.

        Removed preparser library; link preparser executable against full V8.

        Fixed set-up of intrinsic's 'constructor' properties.
        (Chromium issue 229445)

        ES6 symbols: extended V8 API to support symbols (issue 2158).

        Removed ARM support for VFP2.

        Made __proto__ a real JavaScript accessor property.
        (issue 1949 and issue 2606)

        Performance and stability improvements on all platforms.


2013-04-04: Version 3.17.16

        Stack trace API: poison stack frames below the first strict mode frame.
        (issue 2564)

        Made Isolate::GetHeapStatistics robust against half-initialized
        isolates (Chromium issue 2591).

        Finished implementation of ES6 symbols aka. private names (issue 2158).

        Performance and stability improvements on all platforms.


2013-03-21: Version 3.17.15

        Rolled back API changes to maintain compatibility with older
        3.17.x versions of V8.

        Disable zapping of global handles in release mode.

        Always mark the entire valid prefix of the descriptor array.
        (Chromium issue 196331)

        Use internal memcpy for CopyWords and when copying code.
        (Chromium issue 196330)

        Performance and stability improvements on all platforms.


2013-03-20: Version 3.17.14

        Use internal memcpy when initializing code objects.
        (Chromium issue 196330)

        Disabled weak embedded maps because of crashes.
        (Chromium issues 172489, 217858)

        Performance and stability improvements on all platforms.


2013-03-19: Version 3.17.13

        Turned Flags into a uint32_t typedef (Chromium issue 194749).

        Performance and stability improvements on all platforms.


2013-03-18: Version 3.17.12

        Unified kMaxArguments with number of bits used to encode it.
        (Chromium issue 211741)

        Fixed detection of |handle_smi| case in
        HOptimizedGraphBuilder::HandlePolymorphicCallNamed.
        (Chromium issue 196583)

        Performance and stability improvements on all platforms.


2013-03-15: Version 3.17.11

        Added a version of the v8::HandleScope constructor with an v8::Isolate
        parameter and made AdjustAmountOfExternalAllocatedMemory an instance
        method of v8::Isolate.
        (issue 2487)

        Fixed two register allocator bugs (off-by-one error/failure
        propagation). (issue 2576)

        Fixed huge heap snapshot when a heavily shared context has many
        variables. (Chromium issue 145687)

        Performance and stability improvements on all platforms.


2013-03-13: Version 3.17.10

        Fixed heap snapshot creation for Harmony collections. (issue 2535)

        Fixed register allocation corner case. (Chromium issue 177883)

        Performance and stability improvements on all platforms.


2013-03-08: Version 3.17.9

        Restored Function()'s expected string representation. (issue 2470)

        Enabled deprecatations (again). (issue 2487)

        Avoid bool to Oddball conversions by being lazy. (issue 2491)

        Added %p option to --logfile.

        Hardened Function()'s parsing of function literals. (issue 2470)

        ES6 symbols: Refine test for getOwnPropertyNames. (issue 2158)

        Performance and stability improvements on all platforms.


2013-03-07: Version 3.17.8

        Added missing license headers. (Chromium issue 98597)

        Inserted missing type cast in JSON.stringify. (issue 2570)

        Reverted "Send SIGPROF signals on the profiler event processor thread"
        (issue 2571)

        Fixed Array.length, String.length and Function.prototype LoadICs on x64.
        (issue 2568)

        ES6 symbols: filter symbols form for-in loops and Object.keys.
        (issue 2158)

        Properly handle misses for StoreArrayLengthStub on ia32 and x64
        (issue 2566)

        Fixed x32 handling of Atomic64. (Chromium issue chromium-os:36866)

        Removed "library" variable from standalone.gypi. (Chromium issue 111541)

        Fixed HCheckSmiOrInt <-> HBoundsCheck interaction wrt. representations.
        (issue 2556)

        Enabled zapping of disposed global handles in release mode.
        (Chromium issue 176056)

        Added workaround for redefinition of __proto__ property. (issue 2565)

        ES6 symbols: Allow symbols as property names. (issue 2158)

        Performance and stability improvements on all platforms.


2013-03-04: Version 3.17.7

        Limited recursion in regexp compilation by a budget.
        (Chromium issue 178790)

        ES6 symbols: Implemented Symbol intrinsic and basic functionality
        (issue 2158)

        Performance and stability improvements on all platforms.


2013-02-28: Version 3.17.6

        Fixed materialization of arguments objects with unknown values.
        (Chromium issue 163530)

        Set default number of sweeper threads to at most four.

        Performance and stability improvements on all platforms.


2013-02-27: Version 3.17.5

        Made __proto__ a foreign callback on Object.prototype.
        (issue 621, issue 1949 and issue 2441)

        Performance and stability improvements on all platforms.


2013-02-25: Version 3.17.4

        Performance and stability improvements on all platforms.


2013-02-21: Version 3.17.3

        Performance and stability improvements on all platforms.


2013-02-19: Version 3.17.2

        Removed bogus check for TOP register in deoptimizer.
        (Chromium issue 176943)

        Made the Isolate parameter mandatory for internal HandleScopes.
        (issue 2487)

        Fixed f.apply() optimization when declared arguments are mutated.
        (issue 2539)

        Performance and stability improvements on all platforms.


2013-02-14: Version 3.17.1

        Performance and stability improvements on all platforms.


2013-02-13: Version 3.17.0

        Enabled parallel sweeping.

        Don't try to unlink instructions twice during GVN
        (Chromium issue 175141)

        Fixed code flusher disabling while marking incrementally.
        (Chromium issue 173458, 168582)

        Don't use TLS for space iterators.
        (issue 2531)

        Added new GetHeapStatistics API entry and deprecated old one.

        Fixed DoubleStackSlot-to-DoubleStackSlot moves on ia32. Unified
        platform-independent code.
        (Chromium issue 173907)

        Added --trace-array-abuse to help find OOB accesses.

        Performance and stability improvements on all platforms.


2013-02-06: Version 3.16.14

        Performance and stability improvements on all platforms.


2013-02-04: Version 3.16.13

        Tagged stubs that rely on instance types as MEGAMORPHIC.
        (Chromium issue 173974)

        Fixed clearing of dead dependent codes and verifing of weak
        embedded maps on full GC. (Chromium issue 172488,172489)

        Made the arm port build cleanly with Clang.

        Performance and stability improvements on all platforms.


2013-01-31: Version 3.16.12

        Performance and stability improvements on all platforms.


2013-01-30: Version 3.16.11

        Put making embedded maps in optimized code weak behind a flag.
        (Chromium issue 172488,172489)

        Performance and stability improvements on all platforms.


2013-01-25: Version 3.16.10

        Avoid excessive memory usage during redundant phi elimination.
        (issue 2510)

        Fixed additional spec violations wrt RegExp.lastIndex.
        (issue 2437)

        Added Isolate parameter to Persistent class.
        (issue 2487)

        Performance and stability improvements on all platforms.


2013-01-24: Version 3.16.9

        Made embedded maps in optimized code weak.
        (issue 2073)

        Fixed corner case when JSFunction is evicted from flusher.
        (Chromium issue 168801)

        Correctly set kCanBeDivByZero flag for HMathFloorOfDiv.
        (Chromium issue 171641)

        Performance and stability improvements on all platforms.


2013-01-23: Version 3.16.8

        Correctly reset lastIndex in an RegExp object.
        (Chromium issue 170856)

        Added a workaround for Windows compilation problems related to V8EXPORT.
        (issue 2507)

        tools/run-tests.py: shlex.split() the value of --command-prefix
        (Chromium issue 171553)

        Fixed pattern detection for replacing shifts by rotation.
        (Chromium issue 2499)

        Performance and stability improvements on all platforms.


2013-01-21: Version 3.16.7

        Removed <(library) usage from v8.gyp.
        (Chromium issue 111541)

        Fixed out of bounds memory access in TestJSArrayForAllocationSiteInfo.
        (Chromium issue 169928)

        Performance and stability improvements on all platforms.


2013-01-18: Version 3.16.6

        Made the Isolate parameter mandatory in Locker and Unlocker classes.
        (issue 2487)

        Avoid pointer underflow in CopyCharsUnsigned.
        (issue 2493)

        Generate shim headers when using system v8.
        (Chromium issue 165264)

        Fixed arguments materialization for inlined apply().
        (issue 2489)

        Sync'ed laziness between BuildFunctionInfo and MakeFunctionInfo.
        (Chromium issue 147497)

        Added sanity check to CodeFlusher::AddCandidate.
        (Chromium issue 169209)

        Performance and stability improvements on all platforms.


2013-01-15: Version 3.16.5

        Removed deprecated functions from V8's external API.

        Prepared API for WebKit use of Latin-1.

        Fixed V8 issue 2486.

        Fixed Chromium issue 169723.

        Performance and stability improvements on all platforms.


2013-01-11: Version 3.16.4

        Fixed Chromium issues 168545 and 169209.

        Performance and stability improvements on all platforms.


2013-01-09: Version 3.16.3

        Improved GC performance when moving parts of a FixedArray (issue 2452).

        Enabled readline on d8 while building a shared lib (issue 1781).

        Fixed missing exception check in typed array constructor
        (Chromium issue 168545).

        Check for read-only-ness when preparing for array sort (issue 2419).

        Performance and stability improvements on all platforms.


2013-01-04: Version 3.16.2

        Added Makefile options to build for the Raspberry Pi (armv7=0,
        arm_fpu=vfp2).

        Performance and stability improvements on all platforms.


2012-12-27: Version 3.16.1

        Fixed x64 MathMinMax for negative untagged int32 arguments.
        (Chromium issue 164442)

        Fixed FloatingPointHelper::CheckSSE2OperandIsInt32.
        (issue 2458)

        Performance and stability improvements on all platforms.


2012-12-21: Version 3.16.0

        V8_Fatal now prints C++ stack trace in debug mode.

        Added HTML-based tick processor.

        Continued implementation of Object.observe (V8 issue 2409).

        Fixed V8 issues 2243, 2340, 2393, 2399, 2457.

        Fixed Chromium issues 125308, 165637, 166379, 166553.

        Performance and stability improvements on all platforms.


2012-12-10: Version 3.15.11

        Define CAN_USE_VFP2/3_INSTRUCTIONS based on arm_neon and arm_fpu GYP
        flags.

        Performance and stability improvements on all platforms.


2012-12-07: Version 3.15.10

        Enabled optimisation of functions inside eval. (issue 2315)

        Fixed spec violations in methods of Number.prototype. (issue 2443)

        Added GCTracer metrics for a scavenger GC for DOM wrappers.

        Performance and stability improvements on all platforms.


2012-12-06: Version 3.15.9

        Fixed candidate eviction in code flusher.
        (Chromium issue 159140)

        Iterate through all arguments for side effects in Math.min/max.
        (issue 2444)

        Fixed spec violations related to regexp.lastIndex
        (issue 2437, issue 2438)

        Performance and stability improvements on all platforms.


2012-12-04: Version 3.15.8

        Enforced stack allocation of TryCatch blocks.
        (issue 2166,chromium:152389)

        Fixed external exceptions in external try-catch handlers.
        (issue 2166)

        Activated incremental code flushing by default.

        Performance and stability improvements on all platforms.


2012-11-30: Version 3.15.7

        Activated code aging by default.

        Included more information in --prof log.

        Removed eager sweeping for lazy swept spaces. Try to find in
        SlowAllocateRaw a bounded number of times a big enough memory slot.
        (issue 2194)

        Performance and stability improvements on all platforms.


2012-11-26: Version 3.15.6

        Ensure double arrays are filled with holes when extended from
        variations of empty arrays. (Chromium issue 162085)

        Performance and stability improvements on all platforms.


2012-11-23: Version 3.15.5

        Fixed JSON.stringify for objects with interceptor handlers.
        (Chromium issue 161028)

        Fixed corner case in x64 compare stubs. (issue 2416)

        Performance and stability improvements on all platforms.


2012-11-16: Version 3.15.4

        Fixed Array.prototype.join evaluation order. (issue 2263)

        Perform CPU sampling by CPU sampling thread only iff processing thread
        is not running. (issue 2364)

        When using an Object as a set in Object.getOwnPropertyNames, null out
        the proto. (issue 2410)

        Disabled EXTRA_CHECKS in Release build.

        Heap explorer: Show representation of strings.

        Removed 'type' and 'arguments' properties from Error object.
        (issue 2397)

        Added atomics implementation for ThreadSanitizer v2.
        (Chromium issue 128314)

        Fixed LiveEdit crashes when object/array literal is added. (issue 2368)

        Performance and stability improvements on all platforms.


2012-11-13: Version 3.15.3

        Changed sample shell to send non-JS output (e.g. errors) to stderr
        instead of stdout.

        Correctly check for stack overflow even when interrupt is pending.
        (issue 214)

        Collect stack trace on stack overflow. (issue 2394)

        Performance and stability improvements on all platforms.


2012-11-12: Version 3.15.2

        Function::GetScriptOrigin supplies sourceURL when script name is
        not available.  (Chromium issue 159413)

        Made formatting error message side-effect-free.  (issue 2398)

        Fixed length check in JSON.stringify.  (Chromium issue 160010)

        ES6: Added support for Set and Map clear method (issue 2400)

        Fixed slack tracking when instance prototype changes.
        (Chromium issue 157019)

        Fixed disabling of code flusher while marking.  (Chromium issue 159140)

        Added a test case for object grouping in a scavenger GC (issue 2077)

        Support shared library build of Android for v8.
        (Chromium issue 158821)

        ES6: Added support for size to Set and Map (issue 2395)

        Performance and stability improvements on all platforms.


2012-11-06: Version 3.15.1

        Put incremental code flushing behind a flag. (Chromium issue 159140)

        Performance and stability improvements on all platforms.


2012-10-31: Version 3.15.0

        Loosened aligned code target requirement on ARM (issue 2380)

        Fixed JSON.parse to treat leading zeros correctly.
        (Chromium issue 158185)

        Performance and stability improvements on all platforms.


2012-10-22: Version 3.14.5

        Killed off the SCons based build.

        Added a faster API for creating v8::Integer objects.

        Speeded up function deoptimization by avoiding quadratic pass over
        optimized function list. (Chromium issue 155270)

        Always invoke the default Array.sort functions from builtin functions.
        (issue 2372)

        Reverted recent CPU profiler changes because they broke --prof.
        (issue 2364)

        Switched code flushing to use different JSFunction field.
        (issue 1609)

        Performance and stability improvements on all platforms.


2012-10-15: Version 3.14.4

        Allow evals for debugger even if they are prohibited in the debugee
        context. (Chromium issue 154733)

        Enabled --verify-heap in release mode (issue 2120)

        Performance and stability improvements on all platforms.


2012-10-11: Version 3.14.3

        Use native context to retrieve ErrorMessageForCodeGenerationFromStrings
        (Chromium issue 155076).

        Bumped variable limit further to 2^17 (Chromium issue 151625).

        Performance and stability improvements on all platforms.


2012-10-10: Version 3.14.2

        ARM: allowed VFP3 instructions when hardfloat is enabled.
        (Chromium issue 152506)

        Fixed instance_descriptors() and PushStackTraceAndDie regressions.
        (Chromium issue 151749)

        Made GDBJIT interface compile again. (issue 1804)

        Fixed Accessors::FunctionGetPrototype's proto chain traversal.
        (Chromium issue 143967)

        Made sure that names of temporaries do not clash with real variables.
        (issue 2322)

        Rejected local module declarations. (Chromium issue 150628)

        Rejected uses of lexical for-loop variable on the RHS. (issue 2322)

        Fixed slot recording of code target patches.
        (Chromium issue 152615,chromium:144230)

        Changed the Android makefile to use GCC 4.6 instead of GCC 4.4.3.

        Performance and stability improvements on all platforms.


2012-10-01: Version 3.14.1

        Don't set -m32 flag when compiling with Android ARM compiler.
        (Chromium issue 143889)

        Restore the descriptor array before returning allocation failure.
        (Chromium issue 151750)

        Lowered kMaxVirtualRegisters (v8 issue 2139, Chromium issues 123822 and
        128252).

        Pull more recent gyp in 'make dependencies'.

        Made sure that the generic KeyedStoreIC changes length and element_kind
        atomically (issue 2346).

        Bumped number of allowed variables per scope to 65535, to address GWT.
        (Chromium issue 151625)

        Support sourceURL for dynamically inserted scripts (issue 2342).

        Performance and stability improvements on all platforms.


2012-09-20: Version 3.14.0

        Fixed missing slot recording during clearing of CallICs.
        (Chromium issue 144230)

        Fixed LBoundsCheck on x64 to handle (stack slot + constant) correctly.
        (Chromium issue 150729)

        Fixed minus zero test. (Issue 2133)

        Fixed setting array length to zero for slow elements.
        (Chromium issue 146910)

        Fixed lost arguments dropping in HLeaveInlined.
        (Chromium issue 150545)

        Fixed casting error for receiver of interceptors.
        (Chromium issue 149912)

        Throw a more descriptive exception when blocking 'eval' via CSP.
        (Chromium issue 140191)

        Fixed debugger's eval when close to stack overflow. (issue 2318)

        Added checks to live edit. (issue 2297)

        Switched on code compaction on incremental GCs.

        Fixed caching of optimized code for OSR. (issue 2326)

        Not mask exception thrown by toString in String::UtfValue etc.
        (issue 2317)

        Fixed API check for length of external arrays. (Chromium issue 148896)

        Ensure correct enumeration indices in the dict (Chromium issue 148376)

        Correctly initialize regexp global cache. (Chromium issue 148378)

        Fixed arguments object materialization during deopt. (issue 2261)

        Introduced new API to expose external string resource regardless of
        encoding.

        Fixed CHECK failure in LCodeGen::DoWrapReceiver when
        --deopt-every-n-times flag is present
        (Chromium issue 148389)

        Fixed edge case of extension with NULL as source string.
        (Chromium issue 144649)

        Fixed array index dehoisting. (Chromium issue 141395)

        Performance and stability improvements on all platforms.


2012-09-11: Version 3.13.7

        Enable/disable LiveEdit using the (C++) debug API.

        Performance and stability improvements on all platforms.


2012-09-06: Version 3.13.6

        Added validity checking to API functions and calls.

        Disabled accessor inlining (Chromium issue 134609).

        Fixed bug in Math.min/max in optimized code (Chromium issue 145961).

        Directly use %ObjectKeys in json stringify (Chromium issue 2312).

        Fixed VS2005 build (issue 2313).

        Activated fixed ES5 readonly semantics by default.

        Added hardfp flag to the Makefile.

        Performance and stability improvements on all platforms.


2012-08-29: Version 3.13.5

        Release stack trace data after firing Error.stack accessor.
        (issue 2308)

        Added a new API V8::SetJitCodeEventHandler to push code name and
        location to users such as profilers.

        Allocate block-scoped global bindings to global context.

        Performance and stability improvements on all platforms.


2012-08-28: Version 3.13.4

        Print reason for disabling optimization. Kill --trace-bailout flag.

        Provided option to disable full DEBUG build on Android.

        Introduced global contexts to represent lexical global scope(s).

        Fixed rounding in Uint8ClampedArray setter. (issue 2294)

        Performance and stability improvements on all platforms.


2012-08-21: Version 3.13.3

        Performance and stability improvements on all platforms.


2012-08-20: Version 3.13.2

        Performance and stability improvements on all platforms.


2012-08-16: Version 3.13.1

        Performance and stability improvements on all platforms.


2012-08-10: Version 3.13.0

        Added histograms for total allocated/live heap size, as well as
        allocated size and percentage of total for map and cell space.

        Fixed parseInt's octal parsing behavior (ECMA-262 Annex E 15.1.2.2).
        (issue 1645)

        Added checks for interceptors to negative lookup code in Crankshaft.
        (Chromium issue 140473)

        Made incremental marking clear ICs and type feedback cells.

        Performance and stability improvements on all platforms.


2012-08-01: Version 3.12.19

        Performance and stability improvements on all platforms.


2012-07-30: Version 3.12.18

        Forced using bit-pattern for signed zero double. (issue 2239)

        Made sure double to int conversion is correct. (issue 2260)

        Performance and stability improvements on all platforms.


2012-07-27: Version 3.12.17

        Always set the callee's context when calling a function from optimized
        code.
        (Chromium issue 138887)

        Fixed building with GCC 3.x
        (issue 2016, 2017)

        Improved API calls that return empty handles.
        (issue 2245)

        Performance and stability improvements on all platforms.


2012-07-25: Version 3.12.16

        Performance and stability improvements on all platforms.


2012-07-24: Version 3.12.15

        Added PRESERVE_ASCII_NULL option to String::WriteAscii.
        (issue 2252)

        Added dependency to HLoadKeyed* instructions to prevent invalid
        hoisting. (Chromium issue 137768)

        Enabled building d8 for Android on Mac.

        Interpret negative hexadecimal literals as NaN.
        (issue 2240)

        Expose counters in javascript when using --track-gc-object-stats.

        Enabled building and testing V8 on Android IA.

        Added --trace-parse flag to parser.

        Performance and stability improvements on all platforms.


2012-07-18: Version 3.12.14

        Deactivated optimization of packed arrays.
        (Chromium issue 137768)

        Fixed broken accessor transition.
        (Chromium issue 137689)

        Performance and stability improvements on all platforms.


2012-07-17: Version 3.12.13

        Fixed missing tagging of stack value in finally block.
        (Chromium issue 137496)

        Added more support for heap analysis.

        Performance and stability improvements on all platforms.


2012-07-16: Version 3.12.12

        Added an option to the tickprocessor to specify the directory for lib
        lookup.

        Fixed ICs for slow objects with native accessor (Chromium issue 137002).

        Fixed transcendental cache on ARM in optimized code (issue 2234).

        New heap inspection tools: counters for object sizes and counts,
        histograms for external fragmentation.

        Incorporated constness into inferred interfaces (in preparation for
        handling imports) (issue 1569).

        Performance and stability improvements on all platforms.


2012-07-12: Version 3.12.11

        Renamed "mips" arch to "mipsel" in the GYP build.

        Fixed computation of call targets on prototypes in Crankshaft.
        (Chromium issue 125148)

        Removed use of __lookupGetter__ when generating stack trace.
        (issue 1591)

        Turned on ES 5.2 globals semantics by default.
        (issue 1991, Chromium issue 80591)

        Synced preparser and parser wrt syntax error in switch..case.
        (issue 2210)

        Fixed reporting of octal literals in strict mode when preparsing.
        (issue 2220)

        Fixed inline constructors for Harmony Proxy prototypes.
        (issue 2225)

        Performance and stability improvements on all platforms.


2012-07-10: Version 3.12.10

        Re-enabled and fixed issue with array bounds check elimination
        (Chromium issue 132114).

        Fixed Debug::Break crash. (Chromium issue 131642)

        Added optimizing compiler support for JavaScript getters.

        Performance and stability improvements on all platforms.


2012-07-06: Version 3.12.9

        Correctly advance the scanner when scanning unicode regexp flag.
        (Chromium issue 136084)

        Fixed unhandlified code calling Harmony Proxy traps.
        (issue 2219)

        Performance and stability improvements on all platforms.


2012-07-05: Version 3.12.8

        Implemented TypedArray.set and ArrayBuffer.slice in d8.

        Performance and stability improvements on all platforms.


2012-07-03: Version 3.12.7

        Fixed lazy compilation for strict eval scopes.
        (Chromium issue 135066)

        Made MACOSX_DEPLOYMENT_TARGET configurable in GYP.
        (issue 2151)

        Report "hidden properties" in heap profiler for properties case.
        (issue 2212)

        Activated optimization of packed arrays by default.

        Performance and stability improvements on all platforms.


2012-06-29: Version 3.12.6

        Cleaned up hardfp ABI detection for ARM (V8 issue 2140).

        Extended TypedArray support in d8.


2012-06-28: Version 3.12.5

        Fixed lazy parsing heuristics to respect outer scope.
        (Chromium issue 135008)

        Allow using test-wrapper-gypbuild.py on Windows when no python
        interpreter is registered.

        Performance and stability improvements on all platforms.


2012-06-27: Version 3.12.4

        Removed -fomit-frame-pointer flag from Release builds to make
        the stack walkable by TCMalloc (Chromium issue 133723).

        Ported r7868 (constant masking) to x64 (issue 1374).

        Expose more detailed memory statistics (issue 2201).

        Fixed Harmony Maps and WeakMaps for undefined values
        (Chromium issue 132744).

        Correctly throw reference error in strict mode with ICs disabled
        (issue 2119).

        Performance and stability improvements on all platforms.


2012-06-25: Version 3.12.3

        Reverted r11835 'Unify promotion and allocation limit computation' due
        to V8 Splay performance regression on Mac.  (Chromium issue 134183)

        Fixed sharing of literal boilerplates for optimized code.  (issue 2193)

        Performance and stability improvements on all platforms.


2012-06-22: Version 3.12.2

        Made near-jump check more strict in LoadNamedFieldPolymorphic on
        ia32/x64. (Chromium issue 134055)

        Fixed lazy sweeping heuristics to prevent old-space expansion.
        (issue 2194)

        Performance and stability improvements on all platforms.


2012-06-21: Version 3.12.1

        Performance and stability improvements on all platforms.


2012-06-20: Version 3.12.0

        Fixed Chromium issues:
        115100, 129628, 131994, 132727, 132741, 132742, 133211

        Fixed V8 issues:
        915, 1914, 2034, 2087, 2094, 2134, 2156, 2166, 2172, 2177, 2179, 2185

        Added --extra-code flag to mksnapshot to load JS code into the VM
        before creating the snapshot.

        Support 'restart call frame' command in the debugger.

        Performance and stability improvements on all platforms.


2012-06-13: Version 3.11.10

        Implemented heap profiler memory usage reporting.

        Preserved error message during finally block in try..finally.
        (Chromium issue 129171)

        Fixed EnsureCanContainElements to properly handle double values.
        (issue 2170)

        Improved heuristics to keep objects in fast mode with inherited
        constructors.

        Performance and stability improvements on all platforms.


2012-06-06: Version 3.11.9

        Implemented ES5-conformant semantics for inherited setters and read-only
        properties. Currently behind --es5_readonly flag, because it breaks
        WebKit bindings.

        Exposed last seen heap object id via v8 public api.

        Performance and stability improvements on all platforms.


2012-05-31: Version 3.11.8

        Avoid overdeep recursion in regexp where a guarded expression with a
        minimum repetition count is inside another quantifier.
        (Chromium issue 129926)

        Fixed missing write barrier in store field stub.
        (issues 2143, 1465, Chromium issue 129355)

        Proxies: Fixed receiver for setters inherited from proxies.
        Proxies: Fixed ToStringArray function so that it does not reject some
        keys.
        (issue 1543)

        Performance and stability improvements on all platforms.


2012-05-29: Version 3.11.7

        Get better function names in stack traces.

        Performance and stability improvements on all platforms.


2012-05-24: Version 3.11.6

        Fixed RegExp.prototype.toString for incompatible receivers
        (issue 1981).

        Performance and stability improvements on all platforms.


2012-05-23: Version 3.11.5

        Performance and stability improvements on all platforms.


2012-05-22: Version 3.11.4

        Some cleanup to common.gypi. This fixes some host/target combinations
        that weren't working in the Make build on Mac.

        Handle EINTR in socket functions and continue incomplete sends.
        (issue 2098)

        Fixed python deprecations.  (issue 1391)

        Made socket send and receive more robust and return 0 on failure.
        (Chromium issue 15719)

        Fixed GCC 4.7 (C++11) compilation.  (issue 2136)

        Set '-m32' option for host and target platforms

        Performance and stability improvements on all platforms.


2012-05-18: Version 3.11.3

        Disable optimization for functions that have scopes that cannot be
        reconstructed from the context chain. (issue 2071)

        Define V8_EXPORT to nothing for clients of v8. (Chromium issue 90078)

        Correctly check for native error objects.  (Chromium issue 2138)

        Performance and stability improvements on all platforms.


2012-05-16: Version 3.11.2

        Revert r11496. (Chromium issue 128146)

        Implement map collection for incremental marking. (issue 1465)

        Add toString method to CallSite (which describes a frame of the
        stack trace).


2012-05-15: Version 3.11.1

        Added a readbuffer function to d8 that reads a file into an ArrayBuffer.

        Fix freebsd build. (V8 issue 2126)

        Performance and stability improvements on all platforms.


2012-05-11: Version 3.11.0

        Fixed compose-discard crasher from r11524 (issue 2123).

        Activated new global semantics by default. Global variables can
        now shadow properties of the global object (ES5.1 erratum).

        Properly set ElementsKind of empty FAST_DOUBLE_ELEMENTS arrays when
        transitioning (Chromium issue 117409).

        Made Error.prototype.name writable again, as required by the spec and
        the web (Chromium issue 69187).

        Implemented map collection with incremental marking (issue 1465).

        Regexp: Fixed overflow in min-match-length calculation
        (Chromium issue 126412).

        MIPS: Fixed illegal instruction use on Loongson in code for
        Math.random() (issue 2115).

        Fixed crash bug in VisitChoice (Chromium issue 126272).

        Fixed unsigned-Smi check in MappedArgumentsLookup
        (Chromium issue 126414).

        Fixed LiveEdit for function with no locals (issue 825).

        Fixed register clobbering in LoadIC for interceptors
        (Chromium issue 125988).

        Implemented clearing of CompareICs (issue 2102).

        Performance and stability improvements on all platforms.


2012-05-03: Version 3.10.8

        Enabled MIPS cross-compilation.

        Ensured reload of elements pointer in StoreFastDoubleElement stub.
        (Chromium issue 125515)

        Fixed corner cases in truncation behavior when storing to
        TypedArrays. (issue 2110)

        Fixed failure to properly recognize and report out-of-memory
        conditions when allocating code space pages. (Chromium issue
        118625)

        Fixed idle notifications to perform a round of incremental GCs
        after context disposal. (issue 2107)

        Fixed preparser for try statement. (issue 2109)

        Performance and stability improvements on all platforms.


2012-04-30: Version 3.10.7

        Performance and stability improvements on all platforms.


2012-04-26: Version 3.10.6

        Fixed some bugs in accessing details of the last regexp match.

        Fixed source property of empty RegExp objects. (issue 1982)

        Enabled inlining some V8 API functions.

        Performance and stability improvements on all platforms.


2012-04-23: Version 3.10.5

        Put new global var semantics behind a flag until WebKit tests are
        cleaned up.

        Enabled stepping into callback passed to builtins.
        (Chromium issue 109564)

        Performance and stability improvements on all platforms.


2012-04-19: Version 3.10.4

        Fixed issues when stressing compaction with WeakMaps.

        Fixed missing GVN flag for new-space promotion. (Chromium issue 123919)

        Simplify invocation sequence at monomorphic function invocation sites.
        (issue 2079)

        Performance and stability improvements on all platforms.


2012-04-17: Version 3.10.3

        Fixed several bugs in heap profiles (including issue 2078).

        Throw syntax errors on illegal escape sequences.

        Implemented rudimentary module linking (behind --harmony flag)

        Implemented ES5 erratum: Global declarations should shadow
        inherited properties.

        Made handling of const more consistent when combined with 'eval'
        and 'with'.

        Fixed V8 on MinGW-x64 (issue 2026).

        Performance and stability improvements on all platforms.


2012-04-13: Version 3.10.2

        Fixed native ARM build (issues 1744, 539)

        Return LOOKUP variable instead of CONTEXT for non-context allocated
        outer scope parameters (Chromium issue 119609).

        Fixed regular and ElementsKind transitions interfering with each other
        (Chromium issue 122271).

        Improved performance of keyed loads/stores which have a HeapNumber
        index (issues 1388, 1295).

        Fixed WeakMap processing for evacuation candidates (issue 2060).

        Bailout on possible direct eval calls (Chromium issue 122681).

        Do not assume that names of function expressions are context-allocated
        (issue 2051).

        Performance and stability improvements on all platforms.


2012-04-10: Version 3.10.1

        Fixed bug with arguments object in inlined functions (issue 2045).

        Fixed performance bug with lazy initialization (Chromium issue
        118686).

        Added suppport for Mac OS X 64bit builds with GYP.
        (Patch contributed by Filipe David Manana )

        Fixed bug with hidden properties (issue 2034).

        Fixed a performance bug when reloading pages (Chromium issue 117767,
        V8 issue 1902).

        Fixed bug when optimizing throw in top-level code (issue 2054).

        Fixed two bugs with array literals (issue 2055, Chromium issue 121407).

        Fixed bug with Math.min/Math.max with NaN inputs (issue 2056).

        Fixed a bug with the new runtime profiler (Chromium issue 121147).

        Fixed compilation of V8 using uClibc.

        Optimized boot-up memory use.

        Optimized regular expressions.


2012-03-30: Version 3.10.0

        Fixed store IC writability check in strict mode
        (Chromium issue 120099).

        Resynchronize timers if the Windows system time was changed.
        (Chromium issue 119815)

        Removed "-mfloat-abi=hard" from host compiler cflags when building for
        hardfp ARM
        (https://code.google.com/p/chrome-os-partner/issues/detail?id=8539)

        Fixed edge case for case independent regexp character classes
        (issue 2032).

        Reset function info counters after context disposal.
        (Chromium issue 117767, V8 issue 1902)

        Fixed missing write barrier in CopyObjectToObjectElements.
        (Chromium issue 119926)

        Fixed missing bounds check in HasElementImpl.
        (Chromium issue 119925)

        Performance and stability improvements on all platforms.


2012-03-23: Version 3.9.24

        Activated count-based profiler for ARM.

        Fixed use of proxies as f.prototype properties. (issue 2021)

        Enabled snapshots on MIPS.

        Performance and stability improvements on all platforms.


2012-03-21: Version 3.9.23

        Use correct arguments adaptation environment when inlining function
        containing arguments. (Issue 2014)

        Performance and stability improvements on all platforms.


2012-03-20: Version 3.9.22

        Enabled count-based profiler by default.

        Implemented a hash based look-up to speed up address checks
        in large object space (issue 853).

        Performance and stability improvements on all platforms.


2012-03-19: Version 3.9.21

        Fixed push-to-trunk script (and re-push).

        Added API call that identifies strings that are guaranteed only to
        contain ASCII characters.


2012-03-19: Version 3.9.20

        Fixed declarations escaping global strict eval. (Issue 1624)

        Fixed wrapping of receiver for non-strict callbacks. (Issue 1973)

        Fixed function declarations overwriting read-only global properties.
        (Chromium issue 115452)

        Fixed --use-strict flag in combination with --harmony[-scoping].

        Debugger: naive implementation of "step into Function.prototype.bind".

        Debugger: added ability to set script source from within OnBeforeCompile

        Added flag to always call DebugBreak on abort.

        Re-enabled constructor inlining and inline === comparison with boolean
        constants. (Issue 2009)

        Don't use an explicit s0 in ClampDoubleToUint8. (Issue 2004)

        Performance and stability improvements on all platforms.


2012-03-14: Version 3.9.19

        Ensure there is a smi check of the receiver for global load and call
        ICs (Chromium issue 117794).

        Performance and stability improvements on all platforms.


2012-03-13: Version 3.9.18

        Ensure consistency of Math.sqrt on Intel platforms.

        Remove static initializers in v8. (issue 1859)

        Add explicit dependency on v8_base in the GYP-based build.

        Performance and stability improvements on all platforms.


2012-03-12: Version 3.9.17

        Fixed VFP detection through compiler defines. (issue 1996)

        Add Code-related fields to postmortem metadata.

        Performance and stability improvements on all platforms.


2012-03-09: Version 3.9.16

        Added basic interface inference for modules (behind the --harmony flag).

        Added Object.is, Number.isFinite, Number.isNaN.

        Updated the Unicode tables to Unicode version 6.1.0.

        Performance and stability improvements on all platforms.


2012-03-06: Version 3.9.15

        Fix the heap profiler crash caused by memory layout changes between
        passes.

        Fix Error.prototype.toString to throw TypeError. (issue 1980)

        Fix double-rounding in strtod for MinGW. (issue 1062)

        Fix corrupted snapshot serializaton on ia32. (Chromium issue v8/1985)

        Performance and stability improvements on all platforms.


2012-03-01: Version 3.9.14

        Performance and stability improvements on all platforms.


2012-02-29: Version 3.9.13

        Added code kind check before preparing for OSR. (issue 1900, 115073)

        Fixed issue 1802: Pass zone explicitly to zone-allocation on x64 and
        ARM.

        Ported string construct stub to x64. (issue 849)

        Performance and stability improvements on all platforms.


2012-02-28: Version 3.9.12

        Fixed the negative lookup stub to handle deleted entries in a
        dictionary. (issue 1964)

        Added a new API where the host can supply a callback function. The
        callback function can resolve the location of a return address on stack
        to the location where a return-address rewriting profiler stashed the
        original return address.

        Fixed Chromium issue http://crbug.com/115646: When compiling for-in
        pass correct context value to the increment instruction.

        Fixed issue 1853: Update breakpoints set with partial file name after
        compile.


2012-02-27: Version 3.9.11

        Made 'module' a context-sensitive keyword (V8 issue 1957).


2012-02-24: Version 3.9.10

        Fixed V8 issues 1322, 1772 and 1969.

        Conformance improvements.

        Performance and stability improvements on all platforms.


2012-02-23: Version 3.9.9

        Supported fast case for-in in Crankshaft.

        Sped up heap snapshot serialization and dominators construction.

        Randomized allocation addresses on windows. (Chromium issue 115151)

        Fixed compilation with MinGW-w64. (issue 1943)

        Fixed incorrect value of assignments to non-extensible properties.

        Fixed a crash bug in generated code on ia32.

        Performance and stability improvements on all platforms.


2012-02-21: Version 3.9.8

        Fixed memory leak and missing #include in StartupDataDecompressor
        (issue 1960).

        Renamed static methods to avoid shadowing virtual methods and fix Clang
        C++11 compile error.

        Fixed sequence of element access in array builtins (issue 1790).

        Performance and stability improvements on all platforms.


2012-02-16: Version 3.9.7

        Fixed V8 issues 1322, 1878, 1942, 1945 and Chromium issue 113924.

        Fixed GCC-4.7 warnings.

        Added Navier-Stokes benchmark.

        Performance and stability improvements on all platforms.


2012-02-14: Version 3.9.6

        Fixed template-related linker error. (issue 1936)

        Allowed inlining of functions containing object literals.  (issue 1322)

        Added --call-graph-size option to tickprocessor.  (issue 1937)

        Heap Snapshot maximum size limit is too low for really big apps. At the
        moment the limit is 256MB.  (Chromium issue 113015)

        Performance and stability improvements on all platforms.


2012-02-09: Version 3.9.5

        Removed unused command line flags.

        Performance and stability improvements on all platforms.


2012-02-08: Version 3.9.4

        Properly initialize element-transitioning array literals on ARM.
        (issue 1930)

        Bug fixes on all platforms.


2012-02-07: Version 3.9.3

        When rethrowing an exception, print the stack trace of its original
        site instead of rethrow site (Chromium issue 60240).

        Increased size of small stacks from 32k to 64k to avoid hitting limits
        in Chromium (Chromium issue 112843).


2012-02-06: Version 3.9.2

        Added timestamp to --trace-gc output. (issue 1932)

        Heap profiler reports implicit references.

        Optionally export metadata with libv8 to enable debuggers to inspect V8
        state.


2012-02-02: Version 3.9.1

        Fixed memory leak in NativeObjectsExplorer::FindOrAddGroupInfo
        (Chromium issue 112315).

        Fixed a crash in dev tools (Chromium issue 107996).

        Added 'dependencies_traverse': 1 to v8 GYP target.

        Performance and stability improvements on all platforms.


2012-02-01: Version 3.9.0

        Reduced memory use immediately after starting V8.

        Stability fixes and performance improvements on all platforms.


2012-01-26: Version 3.8.9

        Flush number string cache on GC (issue 1605).

        Provide access to function inferred name with
	v8::Function::GetInferredName in V8 public API.

        Fix building with Clang (issue 1912).

        Reduce the space used by the stack for the profiling thread.

        Fix misleading documentation of v8::Locker (issue 542).

        Introduce readbinary function in d8 to read binary files.

        Performance and stability improvements on all platforms.


2012-01-23: Version 3.8.8

        Limited number of loop iterations in Heap::ReserveSpace
        (Chromium issue 99027).

        Fixed solaris build (VirtualMemory) (issue 1761).

        Fixed strict vs. non-strict handling of function proxies in
        higher-order array and string methods.

        Enabled asynchronous remote debugging with d8 (issue 1691).

        Stability and performance improvements on all platforms.


2012-01-19: Version 3.8.7

        Ensure that LRandom restores rsi after call to the C function on x64.
        (Chromium issue http://crbug.com/110509)

        Fixing include issues on *bsd when building with scons.
        (issue 1897)

        Provide a switch to specify -fno-strict-aliasing
        (issue 1887)

        Move WIN32 define from standalone.gypi to common.gypi
        (issue 1760)

        Fix corner-case in heap size estimation.
        (issue 1893)

        Fix and enable NEW_NON_STRICT_FAST ArgumentsAccess stub on x64.
        (issue 1903)

        Performance improvements and bug fixes.


2012-01-16: Version 3.8.6

        Add primitive WebGL array support to d8.

        Improve heap size estimation (issue 1893).

        Hash collision DOS workaround extended from string keys
        to numeric keys.

        Provide an API for iterating through all external strings referenced
        from the JS heap.

        Adjust position recorded for call expressions. http://crbug.com/109195

        Fix GC crash related to instanceof. http://crbug.com/109448

        Performance improvements and bug fixes.


2012-01-05: Version 3.8.5

        Fix broken test that assumes that no GC can clear the regexp cache (GC
        can happen at any time due to Crankshaft).

        Fix handling of bogus receivers for Harmony collections. (issue 1884)

        Add netbsd support to gyp build.

        Determine page size at runtime on posix platforms.

        Ensure that store buffer filtering hash sets are cleared after
        StoreBuffer::Filter.

        Randomize the seed used for string hashing.  This helps guard against
        CPU-eating DOS attacks against node.js servers.  Based on code from
        Bert Belder.  This version only solves the issue for those that compile
        V8 themselves or those that do not use snapshots.  A snapshot-based
        precompiled V8 will still have predictable string hash codes.

        Implement callback when script finishes running in V8 API.

        Improve performance of Math.min and Math.max for the case of two
        arguments. (issue 1325)


2012-01-02: Version 3.8.4

        Performance improvements for large Smi-only arrays.

        Fixed InternalArrays construction. (issue 1878)


2011-12-27: Version 3.8.3

        Avoid embedding new space objects into code objects in the lithium gap
        resolver. (chromium:108296)

        Bug fixes and performance optimizations on all platforms.


2011-12-21: Version 3.8.2

        Add max optimization flag to v8 gyp build to ensure V8 is always built 
        fully optimized in Chrome.

        MIPS: Bring MIPS to parity with other platforms.

        Optimizations and stability improvements on all platforms.


2011-12-19: Version 3.8.1

        Fixed GCC 4.7 warnings. Patch from Tobias Burnus.

        Stability improvements on all platforms.


2011-12-13: Version 3.8.0

        Fixed handling of arrays in DefineOwnProperty. (issue 1756)

        Sync parser and preparser on do-while and return statements. 
        (issue 1856)

        Fixed another corner case for DefineOwnProperty on arrays (issue 1756).

        Stability and performance improvements on all platforms.


2011-12-01: Version 3.7.12

        Increase tick interval for the android platform.

        Fix a bug in the register allocator. (chromium:105112)

        Fix handling of recompiling code. (chromium:105375, v8:1782)

        Start incremental marking on idle notification. (v8:1458)

        Build fixes for various platforms.

        Various performance improvements.


2011-11-29: Version 3.7.11

        Fixed bug when generating padding to ensure space for lazy
        deoptimization.
        (issue 1846)

        Further reduced pause times due to GC.

        Stability and performance improvements on all platforms.


2011-11-23: Version 3.7.10

        Set maximum length of FixedArray in terms of elements instead an
        absolute number of bytes.
        (Chromium issue 103103)

        Stability and performance improvements on all platforms.


2011-11-21: Version 3.7.9

        Removed exit-time destructors.

        Stability and performance improvements on all platforms.


2011-11-17: Version 3.7.8

        Removed hidden prototype from builtins, i.e., deleting an overridden
        function on builtins will not make the original function reappear.

        Added NetBSD support for scons build.

        Performance improvements on all platforms.


2011-11-14: Version 3.7.7

        Fix missing fast property accessors in heap snapshots.
        (issue 1818)


2011-11-11: Version 3.7.6

        Fixed filtering of store buffer for large object pages.
        (issue 1817)

        Fixed generated hash function on all platforms.
        (issue 1808)

        Fixed Heap::Shrink to ensure that it does not free pages that are
        still in use.
        (Chromium issue 100414)

        Stability and performance improvements on all platforms.


2011-11-10: Version 3.7.5

        Added initial gyp infrastructure for MIPS.

        Implemented performance improvements to the incremental garbage
        collector.

        Added optimizations and stability improvements on all platforms.


2011-11-07: Version 3.7.4

        Proper "libv8.so.3.7.4" SONAME for Linux shared library (issue 1786).

        Fix Harmony sets and maps to allow null and undefined as keys
        (still hidden behind --harmony flag) (issue 1622).

        Implement VirtualMemory on FreeBSD to fix build (issue 1807).

        Enable VFP instructions for Android.

        Fix error handling in Date.prototype.toISOString (issue 1792).

        Bug fixes and performance improvements for all platforms.

        Not officially supported but noteworthy: Crankshaft for MIPS :-)


2011-10-28: Version 3.7.3

        Slight deoptimization as a workaround for issue with jslint: Issue
        1789.


2011-10-27: Version 3.7.2

        Fix bug in deoptimization.  Known issue with jslint: Issue 1789.


2011-10-26: Version 3.7.1

        Achieved 33% speedup in debug-mode tests.

        Removed special casing of calls to RegExp test and exec methods with no
        argument.  Now matches new JSC behaviour.  crbug.com/75740.

        Return the empty string on cyclic references in toString (ES5
        conformance).

        Fixed bug triggered by JSBeautifier.  crbug.com/100409.

        Made Math.random state per-context instead of per-process (issue 864).

        Fixed stack traces to skip native functions.

        Make snapshots (new contexts) smaller and faster.

        Fixed handling of Function.apply for non-array arguments.

        Fixed evaluation order in defineProperties to match FireFox.

        Fixed handling of non-object receivers for array builtins,
        crbug.com/100702.

        Multiple fixes to improve compliance with test262.

        Fixed compatibility with older Android releases.

        Fixed compilation with gcc-4.5.3.

        Improved performance of WriteUtf8, issue 1665.

        Made native syntax an early error in the preparser.

        Fixed issues 793 and 893 relating to Function.prototype.bind.

        Improved let, const, Set and Map support and other Harmony features
        (behind the --harmony flag).

        Changed evaluation order for > and <= to match ES5 instead of ES3.

        Bug fixes and performance improvements on all platforms.


2011-10-13: Version 3.7.0

        Fixed array handling for Object.defineOwnProperty (ES5 conformance).

        Fixed issue 1757 (string slices of external strings).

        Fixed issue 1759 (ARM).

        Added flag --noclever-optimizations to disable some things that
        caused trouble in the past.

        Added flag --stress-compaction for testing.

        Added flag --harmony to activate all experimental Harmony features.


2011-10-10: Version 3.6.6

        Added a GC pause visualization tool.

        Added presubmit=no and werror=no flags to Makefile.

        ES5/Test262 conformance improvements.

        Fixed compilation issues with GCC 4.5.x (issue 1743).

        Bug fixes and performance improvements on all platforms.


2011-10-05: Version 3.6.5

        New incremental garbage collector.

        Removed the hard heap size limit (soft heap size limit is still
        700/1400Mbytes by default).

        Implemented ES5 generic Array.prototype.toString (Issue 1361).

        V8 now allows surrogate pair codes in decodeURIComponent (Issue 1415).

        Fixed x64 RegExp start-of-string bug (Issues 1746, 1748).

        Fixed propertyIsEnumerable for numeric properties (Issue 1692).

        Fixed the MinGW and Windows 2000 builds.

        Fixed "Prototype chain is not searched if named property handler does
        not set a property" (Issue 1636).

        Made the RegExp.prototype object be a RegExp object (Issue 1217).

        Disallowed future reserved words as labels in strict mode.

        Fixed string split to correctly coerce the separator to a string
        (Issue 1711).

        API: Added an optional source length field to the Extension
        constructor.

        API: Added Debug::DisableAgent to match existing Debug::EnableAgent
        (Issue 1573).

        Added "native" target to Makefile for the benefit of Linux distros.

        Fixed: debugger stops stepping outside evaluate (Issue 1639).

        More work on ES-Harmony proxies.  Still hidden behind a flag.

        Bug fixes and performance improvements on all platforms.


2011-09-15: Version 3.6.4

        Fixed d8's broken readline history.

        Removed the need for code delete events in CPU profiler (Issue 1466).

        Fixed debugger stepping next with trycatch recursion (Issue 1639).

        Fixing parallel execution in d8 (with -p) and some memory leaks.

        Support for precise stepping in functions compiled before debugging was
        started (step 1).


2011-09-13: Version 3.6.3

        Implemented better support of typed arrays in the d8 shell.

        Bug fixes and performance improvements on all platforms.


2011-09-08: Version 3.6.2

        Added "dependencies" target to top-level Makefile.

        Added ability to turn profiler on/off in d8.

        Added "soname_version" parameter to common.gypi, v8.gyp, and Makefile.

        Fixed several crash bugs.


2011-09-07: Version 3.6.1

        Fixed a bug in abrupt exit from with or catch inside finally.

        Fixed possible crash in FixedDoubleArray::Initialize() (Chromium
        issue 95113).

        Fixed a bug in Page::GetRegionMaskForSpan (Chromium issue 94425).

        Fixed a few clang warnings (which -Werror treated as errors).

        Performance improvements on all platforms.


2011-09-05: Version 3.6.0

        Fixed a bug when optimizing named function expression (issue 1647).

        Fixed a bug when optimizing f.call.apply (issue 1650).

        Made arguments and caller always be null on native functions
        (issues 1548 and 1643).

        Fixed issue 1648 (cross-compiling x64 targeting ia32).

        Fixed issue 371 (d8 printing of strings containing \0).

        Fixed order of evaluation in arguments to parseInt (issue 1649).

        Fixed a problem with large heap snapshots in Chrome DevTools
        (issue 1658, chromium issue 89268).

        Upped default maximum heap size from 512M to 700M.


2011-08-31: Version 3.5.10

        Added dependency of v8_base on WinSocket2 Windows library in
        the GYP-build.

        Various bugfixes.


2011-08-29: Version 3.5.9

        Made FromPropertyDescriptor not trigger inherited setters.

        Fixed .gyp files to work on the ARM simulator.

        Fixed shared library build warnings for MSVS.


2011-08-24: Version 3.5.8

        Added V8EXPORT attributes for v8::Array::CheckCast and
        v8::Number::CheckCast.

        Made a slight API change enabling opting out from null termination
        in String::Write*().

        Fixed arm build for gcc-4.6.


2011-08-22: Version 3.5.7

        Make scanner handle invalid unicode escapes in identifiers correctly.

        Make regexp flag parsing stricter.

        Fix several memory leaks.


2011-08-17: Version 3.5.6

        Fixed issue that could cause crashes when running with --heap-stats.

        Fixed compilation on Linux 2.6.9 and older.

        Fixed live-object-list to work with isolates.

        Fixed memory leaks in zones and isolates.

        Fixed a performance regression for TypedArrays on x64.

        Stability improvements on all platforms.


2011-08-15: Version 3.5.5

        Fixed bugs involving negative zero and the optimizing compiler.

        Fixed optimized version of Function.apply(x, arguments). (issue 1592)

        Eliminated uses of deprecated ARM instructions.

        Sped up Math.floor by using SSE 4.1 roundsd instruction on ia32.

        Removed restriction on the size of disassembled code that is printed.


2011-08-10: Version 3.5.4

        Added a preliminary implementation of ES Harmony weak maps.  Weak
        maps can be enabled by the flag --harmony-weakmaps.

        Introduced a toplevel Makefile to support GYP-based building.  GYP
        can be obtained from http://gyp.googlecode.com.

        Fixed a bug in the length property of functions created by
        Function.prototype.bind.

        Reduced malloc heap allocation on process startup.

        Several important code generation bug fixes.

        Performance improvements on all platforms.


2011-08-03: Version 3.5.3

        MIPS: Port of fix to ClassOf check from ARM.
        Patch from Paul Lind .

        Stopped using mprotect on Cygwin.
        Avoided uninitialized member warning on gcc 4.3.4
        Both patches by Bert Belder.

        Bug fixes and performance improvements on all platforms.


2011-08-01: Version 3.5.2

        Performance improvements on all platforms.


2011-07-28: Version 3.5.1

        Fixed setting the readonly flag on the prototype property using the
        API call FunctionTemplate::SetPrototypeAttributes (issue 1539).

        Changed the tools/test.py script to use d8 instead of shell for
        testing.

        Fixed crash in ToBooleanStub when GC happens during invocation.

        Enabled automatic unboxing of double arrays.

        Performance improvements on all platforms.


2011-07-25: Version 3.5.0

        Implemented Object.prototype.{hasOwnProperty, propertyIsEnumerable} for
        proxies.

        Removed logging to memory support.

        Bugfixes and performance work.


2011-07-20: Version 3.4.14

        Fix the debugger for strict-mode functions. (Chromium issue 89236)

        Add GetPropertyAttribute method for Object in the API. (Patch by
        Peter Varga)

        Fix -Wunused-but-set-variable for gcc-4.6 on x64. (Issue 1291)


2011-07-18: Version 3.4.13

        Improved debugger support to allow inspection of optimized frames (issue
        1140).

        Fixed a bug in prototype transitions cache clearing introduced by r8165.

        Fixed shortcutting bug in HInferRepresentation. Patch by Andy Wingo.

        Fixed a memory leak in sample/shell.cc (dispose semaphores).

        Simplified HClampToUint8. Patch by Andy Wingo.

        Exposed APIs for detecting boxed primitives, native errors. Patch by
        Luke Zarko.

        Added map check for COW elements to crankshaft array handling code
        (issue 1560).

        Sample shell and (a light version of) D8 links against a shared library
        now.

        Fixed bug in array filter and reduce functions (issue 1559).

        Avoid TLS load in AstNode constructor.

        Introduced a random entropy source which can optionally be provided at
        initialization. (Chromium issue 89462).


2011-07-13: Version 3.4.12

        Added --prof profiling option to d8 shell.

        Fixed a bug where reading a directory in d8 shell hangs (issue 1533).

        Fixed a potential assertion failure in const declarations.

        Fixed an assertion failure in descriptor arrays (issue 1526).

        Enabled fast thread-local storage by default on supported platforms.

        Improved reporting of source position for global variable loads
        (issue 1527).


2011-07-11: Version 3.4.11

        Fixed MinGW32 build.

        Fixed a GC bug with RegExp code flushing.

        Implemented Object.defineProperty for proxies.

        Fixed a bug in for/in iteration of arguments objects (issue 1531).

        Added debugger support for inspecting optimized frames (issue 1140).

        Allowed JSObject::PreventExtensions to work for arguments objects.

        Bugfixes and performance work.


2011-07-06: Version 3.4.10

        Fixed debugger not breaking on certain "if" statements (issue 1523).

        Fixed assertion failure in runtime profiler when running on IA32
        without snapshot (issue 1522).

        Fixed ABI for API calls on IA32 (for clang compatibility).

        Introduced code flushing of RegExp code to free memory used by
        RegExps sooner.

        Fixed linux-tick-processor built wrong version of v8 (issue 1532).

        Fixed assertion failure in v8::TryCache::StackTrace (issue 1529).

        Performance improvements on all platforms.


2011-07-04: Version 3.4.9

        Added support for debugger inspection of locals in optimized frames
        (issue 1140).

        Fixed SConstruct to pass correct defines to samples/preparser when
        building with library=shared.

        Made date parser handle ES5 Date Time Strings correctly (issue 1498).

        Fixed a bug in Object.defineProperty on the arguments object.

        Performance improvements on all platforms.


2011-06-29: Version 3.4.8

        Ensure 16-byte stack alignment on Solaris (issue 1505).

        Fix "illegal access" when calling parseInt with a radix
        that is not a smi. (issue 1246).


2011-06-27: Version 3.4.7

        Fixed 64-bit build on FreeBSD.

        Added API to set the property attributes for the prototype
        property on functions created from FunctionTemplates.

        Bugfixes and performance work.


2011-06-22: Version 3.4.6

        Lowered limit on code space for systems with low memory supply.

        Allowed compiling v8_shell with the 'host' toolset (issue 82437).

        Extended setBreakpoint API to accept partial script name (issue 1418).

        Made multi-line comments not count when deciding whether the '-->'
        comment starter is first on a line. This matches Safari.

        Made handling of non-array recievers in Array length setter correct
        (issue 1491).

        Added ability to heap profiler to iterate over snapshot's node
        (issue 1481).


2011-06-20: Version 3.4.5

        Fixed issues 794, 1097, 1215(partial), 1417, 1435, 1472, 1473,
        1476, and 1477.

        Improved code generation for !0 and !1.

        Reduced memory usage for regular expressions with nested qualifiers.
        (issue 1472)

        Fixed V8 to count line terminators in multi-line comments.
        (Chromium issue 86431)

        Fixed disassembler=on option for release-mode builds. (issue 1473)

        Performance improvements on all platforms.


2011-06-15: Version 3.4.4

        Added snapshot compression support and --stress-opt flag to d8.

        Improved performance of try/catch.

        Several GYP-related changes: Added support for building Xcode project
        files. Make the ARM simulator build with GYP again. Generate Makefiles
        for all architectures on Linux.

        Fixed Array.prototype.{reduce,reduceRight} to pass undefined as the
        receiver for strict mode callbacks. (issue 1436)

        Fixed a bug where an array load was incorrectly hoisted by GVN.

        Handle 'undefined' correctly when === has been specialized for doubles.
        (issue 1434)

        Corrected the limit of local variables in an optimized function from 64
        to 63.

        Correctly set ReadOnly flag on indexed properties when using the API Set
        method. (issue 1470)

        Give the correct error message when Object.isExtensible is called on a
        non-object. (issue 1452)

        Added GetOwnPropertyNames method for Object in the API. Patch by Peter
        Varga.

        Do not redefine properties unneccesarily in seal and freeze. (issue
        1447)

        IsExecutionTerminating has an Isolate parameter now.

        Distinguish keyed loads with a symbol key from fast elements loads,
        avoiding some useless deoptimizations. (issue 1471)


2011-06-08: Version 3.4.3

        Clear the global thread table when an isolate is disposed
        (issue 1433).

        Converted time zone name to UTF8 on Windows (issue 1290).

        Limited the number of arguments in a function call to 32766
        (issue 1413).

        Compress sources of JS libraries in addition to the snapshot.

        Fixed a bug in Lithium environment iteration.

        Performance improvements on all platforms.


2011-06-06: Version 3.4.2

        More work on ES-Harmony proxies.  Still hidden behind a flag.

        Fixed some crash bugs and improved performance.

        Fixed building with gdb debugging support.

        Do not install SIGPROF handler until it is needed.

        Added DateTimeFormat to i18n API.

        Fixed compilation on OpenBSD.

        Take the ulimit into account when sizing the heap.  OpenBSD users
        may still have to increase the default ulimit to run heavy pages in
        the browser.


2011-06-01: Version 3.4.1

        Fixed JSON stringify issue with arrays.

        Changed calls to JS builtins to be passed undefined when called with
        implicit receiver.

        Implemented the set trap for Harmony proxies. Proxies still need to
        be enabled with the --harmony-proxies flag.


2011-05-30: Version 3.4.0

        Changed calls to undefined property setters to not throw (issue 1355).

        Made RegExp objects not callable.

        Fixed issues on special case large JSON strings in new json parser
        (issues http://crbug.com/83877 and http://crbug.com/84186).

        Performance improvements on all platforms.


2011-05-25: Version 3.3.10

        Fixed calls of strict mode function with an implicit receiver.

        Fixed fast handling of arrays to properly deal with changes to the
        Object prototype (issue 1403).

        Changed strict mode poison pill to be the same type error function
        (issue 1387).

        Fixed a debug crash in arguments object handling (issue 1227).

        Fixed a bug in deoptimization on x64 (issue 1404).

        Performance improvements and bug fixes on all platforms.


2011-05-23: Version 3.3.9

        Added DateTimeFormat class to experimental i18n API.

        Extended preparser to give early errors for some strict mode
        restrictions.

        Removed legacy execScript function from V8.

        Extended isolate API with the ability to add embedder-specific
        data to an isolate.

        Added basic support for polymorphic loads from JS and external
        arrays.

        Fixed bug in handling of switch statements in the optimizing
        compiler.


2011-05-18: Version 3.3.8

        Added MarkIndependent to the persistent handle API.  Independent
        handles are independent of all other persistent handles and can be
        garbage collected more frequently.

        Implemented the get trap for Harmony proxies.  Proxies are enabled
        with the --harmony-proxies flag.

        Performance improvements and bug fixes on all platforms.


2011-05-16: Version 3.3.7

        Updated MIPS infrastructure files.

        Performance improvements and bug fixes on all platforms.


2011-05-11: Version 3.3.6

        Updated MIPS infrastructure files.

        Added method IsCallable for Object to the API.
        Patch by Peter Varga.


2011-05-09: Version 3.3.5

        Fixed build on FreeBSD. Patch by Akinori MUSHA.

        Added check that receiver is JSObject on API calls.

        Implemented CallAsConstructor method for Object in the API (Issue 1348).
        Patch by Peter Varga.

        Added CallAsFunction method to the Object class in the API (Issue 1336).
        Patch by Peter Varga.

        Added per-isolate locking and unlocking.

        Fixed bug in x64 >>> operator (Issue 1359).


2011-05-04: Version 3.3.4

        Implemented API to disallow code generation from strings for a context
        (issue 1258).

        Fixed bug with whitespaces in parseInt (issue 955).

        Fixed bug with == comparison of Date objects (issue 1356).

        Added GYP variables for ARM code generation:
        v8_can_use_vfp_instructions, v8_can_use_unaligned_accesses
        and v8_use_arm_eabi_hardfloat.


2011-05-02: Version 3.3.3

        Added support for generating Visual Studio solution and project files
        using GYP.

        Implemented support for ARM EABI calling convention variation where
        floating-point arguments are passed in registers (hardfloat).

        Added Object::HasOwnProperty() to the API.

        Added support for compressing startup data to reduce binary size. This
        includes build time support and an API for the embedder to decompress
        the startup data before initializing V8.

        Reduced the profiling hooks overhead from >400% to 25% when using
        ll_prof.

        Performance improvements and bug fixes on all platforms.


2011-04-27: Version 3.3.2

        Fixed crash bug on ARM with no VFP3 hardware.

        Fixed compilation of V8 without debugger support.

        Improved performance on JSLint.

        Added support Float64 WebGL arrays.

        Fixed crash bug in regexp replace.


2011-04-20: Version 3.3.1

        Reduced V8 binary size by removing virtual functions from hydrogen.

        Fixed crash bug on x64.

        Performance improvements on ARM and IA32.


2011-04-18: Version 3.3.0

        Fixed bug in floating point rounding in Crankshaft on ARM
        (issue 958)

        Fixed a number of issues with running without VFPv3 support on ARM
        (issue 1315)

        Introduced v8Locale.Collator, a partial implementation of Collator
        per last ECMAScript meeting + mailing list.

        Minor performance improvements and bug fixes.


2011-04-13: Version 3.2.10

        Fixed bug in external float arrays on ARM (issue 1323).

        Minor performance improvements and bug fixes.


2011-04-11: Version 3.2.9

        Removed support for ABI prior to EABI on ARM.

        Fixed multiple crash bugs.

        Added GCMole to the repository, a simple static analysis tool that
        searches for GC-unsafe evaluation order dependent callsites.

        Made preparser API be exported in shared libraries.

        Fixed multiple issues in EcmaScript 5 strict mode implementation.

        Fixed mutable __proto__ property if object is not extensible
        (Issue 1309).

        Fixed auto suspension of the sampler thread.


2011-04-06: Version 3.2.8

        Exposed WebGL typed array constructors in the shell sample.

        Performance improvements on all platforms.


2011-04-04: Version 3.2.7

        Disabled the original 'classic' V8 code generator.  Crankshaft is
        now the default on all platforms.

        Changed the heap profiler to use more descriptive names.

        Performance and stability improvements to isolates on all platforms.


2011-03-30: Version 3.2.6

        Fixed xcode build warning in shell.cc (out of order initialization).

        Fixed null-pointer dereference in the compiler when running without
        SSE3 support (Chromium issue 77654).

        Fixed x64 compilation error due to some dead code. (Issue 1286)

        Introduced scons target to build the preparser stand-alone example.

        Made FreeBSD build and pass all tests.


2011-03-28: Version 3.2.5

        Fixed build with Irregexp interpreter (issue 1266).

        Added Crankshaft support for external arrays.

        Fixed two potential crash bugs.


2011-03-23: Version 3.2.4

        Added isolates which allows several V8 instances in the same process.
        This is controlled through the new Isolate class in the API.

        Implemented more of EcmaScript 5 strict mode.

        Reduced the time it takes to make detailed heap snapshot.

        Added a number of commands to the ARM simulator and enhanced the ARM
        disassembler.


2011-03-17: Version 3.2.3

        Fixed a number of crash bugs.

        Fixed Array::New(length) to return an array with a length (issue 1256).

        Fixed FreeBSD build.

        Changed __defineGetter__ to not throw (matching the behavior of Safari).

        Implemented more of EcmaScript 5 strict mode.

        Improved Crankshaft performance on all platforms.


2011-03-14: Version 3.2.2

        Fixed a number of crash and correctness bugs.

        Improved Crankshaft performance on all platforms.

        Fixed Crankshaft on Solaris/Illumos.


2011-03-10: Version 3.2.1

        Fixed a number of crash bugs.

        Improved Crankshaft for x64 and ARM.

        Implemented more of EcmaScript 5 strict mode.


2011-03-07: Version 3.2.0

        Fixed a number of crash bugs.

        Turned on Crankshaft by default on x64 and ARM.

        Improved Crankshaft for x64 and ARM.

        Implemented more of EcmaScript 5 strict mode.


2011-03-02: Version 3.1.8

        Fixed a number of crash bugs.

        Improved Crankshaft for x64 and ARM.

        Implemented more of EcmaScript 5 strict mode.

        Fixed issue with unaligned reads and writes on ARM.

        Improved heap profiler support.


2011-02-28: Version 3.1.7

        Fixed a number of crash bugs.

        Improved Crankshaft for x64 and ARM.

        Fixed implementation of indexOf/lastIndexOf for sparse
        arrays (http://crbug.com/73940).

        Fixed bug in map space compaction (http://crbug.com/59688).

        Added support for direct getter accessors calls on ARM.


2011-02-24: Version 3.1.6

        Fixed a number of crash bugs.

        Added support for Cygwin (issue 64).

        Improved Crankshaft for x64 and ARM.

        Added Crankshaft support for stores to pixel arrays.

        Fixed issue in CPU profiler with Crankshaft.


2011-02-16: Version 3.1.5

        Change RegExp parsing to disallow /(*)/.

        Added GDB JIT support for ARM.

        Fixed several crash bugs.

        Performance improvements on the IA32 platform.


2011-02-14: Version 3.1.4

        Fixed incorrect compare of prototypes of the global object (issue
        1082).

        Fixed a bug in optimizing calls to global functions (issue 1106).

        Made optimized Function.prototype.apply safe for non-JSObject first
        arguments (issue 1128).

        Fixed an error related to element accessors on Object.prototype and
        parser errors (issue 1130).

        Fixed a bug in sorting an array with large array indices (issue 1131).

        Properly treat exceptions thrown while compiling (issue 1132).

        Fixed bug in register requirements for function.apply (issue 1133).

        Fixed a representation change bug in the Hydrogen graph construction
        (issue 1134).

        Fixed the semantics of delete on parameters (issue 1136).

        Fixed a optimizer bug related to moving instructions with side effects
        (issue 1138).

        Added support for the global object in Object.keys (issue 1150).

        Fixed incorrect value for Math.LOG10E
        (issue http://code.google.com/p/chromium/issues/detail?id=72555)

        Performance improvements on the IA32 platform.

        Implement assignment to undefined reference in ES5 Strict Mode.


2011-02-09: Version 3.1.3

        Fixed a bug triggered by functions with huge numbers of declared
        arguments.

        Fixed zap value aliasing a real object - debug mode only (issue 866).

        Fixed issue where Array.prototype.__proto__ had been set to null
        (issue 1121).

        Fixed stability bugs in Crankshaft for x86.


2011-02-07: Version 3.1.2

        Added better security checks when accessing properties via
        Object.getOwnPropertyDescriptor.

        Fixed bug in Object.defineProperty and related access bugs (issues
        992, 1083 and 1092).

        Added LICENSE.v8, LICENSE.strongtalk and LICENSE.valgrind to ease
        copyright notice generation for embedders.


2011-02-02: Version 3.1.1

        Perform security checks before fetching the value in
        Object.getOwnPropertyDescriptor.

        Fixed a bug in Array.prototype.splice triggered by passing no
        arguments.

        Fixed bugs in -0 in arithmetic and in Math.pow.

        Fixed bugs in the register allocator and in switching from optimized
        to unoptimized code.


2011-01-31: Version 3.1.0

        Performance improvements on all platforms.


2011-01-28: Version 3.0.12

        Added support for strict mode parameter and object property
        validation.

        Fixed a couple of crash bugs.


2011-01-25: Version 3.0.11

        Fixed a bug in deletion of lookup slots that could cause global
        variables to be accidentally deleted (http://crbug.com/70066).

        Added support for strict mode octal literal verification.

        Fixed a couple of crash bugs (issues 1070 and 1071).


2011-01-24: Version 3.0.10

        Fixed External::Wrap for 64-bit addresses (issue 1037).

        Fixed incorrect .arguments variable proxy handling in the full
        code generator (issue 1060).

        Introduced partial strict mode support.

        Changed formatting of recursive error messages to match Firefox and
        Safari (issue http://crbug.com/70334).

        Fixed incorrect rounding for float-to-integer conversions for external
        array types, which implement the Typed Array spec
        (issue http://crbug.com/50972).

        Performance improvements on the IA32 platform.


2011-01-19: Version 3.0.9

        Added basic GDB JIT Interface integration.

        Make invalid break/continue statements a syntax error instead of a
        runtime error.


2011-01-17: Version 3.0.8

        Exposed heap size limit to the heap statistics gathered by
        the GetHeapStatistics API.

        Wrapped external pointers more carefully (issue 1037).

        Hardened the implementation of error objects to avoid setters
        intercepting the properties set then throwing an error.

        Avoided trashing the FPSCR when calculating Math.floor on ARM.

        Performance improvements on the IA32 platform.


2011-01-10: Version 3.0.7

        Stopped calling inherited setters when creating object literals
        (issue 1015).

        Changed interpretation of malformed \c? escapes in RegExp to match
        JSC.

        Enhanced the command-line debugger interface and fixed some minor
        bugs in the debugger.

        Performance improvements on the IA32 platform.


2011-01-05: Version 3.0.6

        Allowed getters and setters on JSArray elements (issue 900).

        Stopped JSON objects from hitting inherited setters (part of
        issue 1015).

        Allowed numbers and strings as names of getters/setters in object
        initializer (issue 820).

        Added use_system_v8 option to gyp (off by default), to make it easier
        for Linux distributions to ship with system-provided V8 library.

        Exported external array data accessors (issue 1016).

        Added labelled thread names to help with debugging (on Linux).


2011-01-03: Version 3.0.5

        Fixed a couple of cast errors for gcc-3.4.3.

        Performance improvements in GC and IA32 code generator.


2010-12-21: Version 3.0.4

        Added Date::ResetCache() to the API so that the cached values in the
        Date object can be reset to allow live DST / timezone changes.

        Extended existing support for printing (while debugging) the contents
        of objects.  Added support for printing objects from release builds.

        Fixed V8 issues 989, 1006, and 1007.


2010-12-17: Version 3.0.3

        Reapplied all changes for version 3.0.1.

        Improved debugger protocol for remote debugging.

        Added experimental support for using gyp to generate build files
        for V8.

        Fixed implementation of String::Write in the API (issue 975).


2010-12-15: Version 3.0.2

        Revert version 3.0.1 and patch 3.0.1.1.


2010-12-13: Version 3.0.1

        Added support for an experimental internationalization API as an
        extension.  This extension is disabled by default but can be enabled
        when building V8.  The ECMAScript internationalization strawman is
        at http://wiki.ecmascript.org/doku.php?id=strawman:i18n_api.

        Made RegExp character class parsing stricter.  This mirrors a change
        to RegExp parsing in WebKit.

        Fixed a bug in Object.defineProperty when used to change attributes
        of an existing property.  It incorrectly set the property value to
        undefined (issue 965).

        Fixed several different compilation failures on various platforms
        caused by the 3.0.0 release.

        Optimized Math.pow so it can work on unboxed doubles.

        Sped up quoting of JSON strings by removing one traversal of the
        string.


2010-12-07: Version 3.0.0

        Improved performance by (partially) addressing issue 957 on
        IA-32. Still needs more work for the other architectures.


2010-11-29: Version 2.5.9

        Fixed crashes during GC caused by partially initialize heap
        objects.

        Fixed bug in process sample that caused memory leaks.

        Improved performance on ARM by implementing missing stubs and
        inlining.

        Improved heap profiler support.

        Added separate seeding on Windows of the random number generator
        used internally by the compiler (issue 936).

        Exposed API for getting the name of the function used to construct
        an object.

        Fixed date parser to handle one and two digit millisecond
        values (issue 944).

        Fixed number parsing to disallow space between sign and
        digits (issue 946).


2010-11-23: Version 2.5.8

        Removed dependency on Gay's dtoa.

        Improved heap profiler precision and speed.

        Reduced overhead of callback invocations on ARM.


2010-11-18: Version 2.5.7

        Fixed obscure evaluation order bug (issue 931).

        Split the random number state between JavaScript and the private API.

        Fixed performance bug causing GCs when generating stack traces on
        code from very large scripts.

        Fixed bug in parser that allowed (foo):42 as a labelled statement
        (issue 918).

        Provide more accurate results about used heap size via
        GetHeapStatistics.

        Allow build-time customization of the max semispace size.

        Made String.prototype.split honor limit when separator is empty
        (issue 929).

        Added missing failure check after expecting an identifier in
        preparser (Chromium issue 62639).


2010-11-10: Version 2.5.6

        Added support for VFP rounding modes to the ARM simulator.

        Fixed multiplication overflow bug (issue 927).

        Added a limit for the amount of executable memory (issue 925).


2010-11-08: Version 2.5.5

        Added more aggressive GC of external objects in near out-of-memory
        situations.

        Fixed a bug that gave the incorrect result for String.split called
        on the empty string (issue 924).


2010-11-03: Version 2.5.4

        Improved V8 VFPv3 runtime detection to address issue 914.


2010-11-01: Version 2.5.3

        Fixed a bug that prevents constants from overwriting function values
        in object literals (issue 907).

        Fixed a bug with reporting of impossible nested calls of DOM functions
        (issue http://crbug.com/60753).


2010-10-27: Version 2.5.2

        Improved sampler resolution on Linux.

        Allowed forcing the use of a simulator from the build script
        independently of the host architecture.

        Fixed FreeBSD port (issue 912).

        Made windows-tick-processor respect D8_PATH.

        Implemented --noinline-new flag fully on IA32, X64 and ARM platforms.


2010-10-20: Version 2.5.1

        Fixed bug causing spurious out of memory exceptions
        (issue http://crbug.com/54580).

        Fixed compilation error on Solaris platform (issue 901).

        Fixed error in strtod (string to floating point number conversion)
        due to glibc's use of 80-bit floats in the FPU on 32-bit linux.

        Adjusted randomized allocations of executable memory to have 64k
        granularity (issue http://crbug.com/56036).

        Supported profiling using kernel perf_events on linux.  Added ll_prof
        script to tools and --ll-prof flag to V8.


2010-10-18: Version 2.5.0

        Fixed bug in cache handling of lastIndex on global regexps
        (issue http://crbug.com/58740).

        Added USE_SIMULATOR macro that explicitly indicates that we wish to use
        the simulator as the execution engine (by Mark Lam 
        from Hewlett-Packard Development Company, LP).

        Fixed compilation error on ARM with gcc 4.4 (issue 894).


2010-10-13: Version 2.4.9

        Fixed a bug in the handling of conditional expressions in test
        contexts in compiler for top-level code.

        Added "//@ sourceURL" information to the StackTrace API.

        Exposed RegExp construction through the API.


2010-10-04: Version 2.4.8

        Fixed a bug in ResumeProfilerEx causing it to not always write out the
        whole snapshot (issue 868).

        Performance improvements on all platforms.


2010-09-30: Version 2.4.7

        Changed the command-line flag --max-new-space-size to be in kB and the
        flag --max-old-space-size to be in MB (previously they were in bytes).

        Added Debug::CancelDebugBreak to the debugger API.

        Fixed a bug in getters for negative numeric property names
        (https://bugs.webkit.org/show_bug.cgi?id=46689).

        Performance improvements on all platforms.


2010-09-27: Version 2.4.6

        Fixed assertion failure related to copy-on-write arrays (issue 876).

        Fixed build failure of 64-bit V8 on Windows.

        Fixed a bug in RegExp (issue http://crbug.com/52801).

        Improved the profiler's coverage to cover more functions (issue 858).

        Fixed error in shift operators on 64-bit V8
        (issue http://crbug.com/54521).


2010-09-22: Version 2.4.5

        Changed the RegExp benchmark to exercise the regexp engine on different
        inputs by scrambling the input strings.

        Fixed a bug in keyed loads on strings.

        Fixed a bug with loading global function prototypes.

        Fixed a bug with profiling RegExp calls (issue http://crbug.com/55999).

        Performance improvements on all platforms.


2010-09-15: Version 2.4.4

        Fixed bug with hangs on very large sparse arrays.

        Now tries harder to free up memory when running out of space.

        Added heap snapshots to JSON format to API.

        Recalibrated benchmarks.


2010-09-13: Version 2.4.3

        Made Date.parse properly handle TZ offsets (issue 857).

        Performance improvements on all platforms.


2010-09-08: Version 2.4.2

        Fixed GC crash bug.

        Fixed stack corruption bug.

        Fixed compilation for newer C++ compilers that found Operand(0)
        ambiguous.


2010-09-06: Version 2.4.1

        Added the ability for an embedding application to receive a callback
        when V8 allocates (V8::AddMemoryAllocationCallback) or deallocates
        (V8::RemoveMemoryAllocationCallback) from the OS.

        Fixed several JSON bugs (including issue 855).

        Fixed memory overrun crash bug triggered during V8's tick-based
        profiling.

        Performance improvements on all platforms.


2010-09-01: Version 2.4.0

        Fixed bug in Object.freeze and Object.seal when Array.prototype or
        Object.prototype are changed (issue 842).

        Updated Array.splice to follow Safari and Firefox when called
        with zero arguments.

        Fixed a missing live register when breaking at keyed loads on ARM.

        Performance improvements on all platforms.


2010-08-25: Version 2.3.11

        Fixed bug in RegExp related to copy-on-write arrays.

        Refactored tools/test.py script, including the introduction of
        VARIANT_FLAGS that allows specification of sets of flags with which
        all tests should be run.

        Fixed a bug in the handling of debug breaks in CallIC.

        Performance improvements on all platforms.


2010-08-23: Version 2.3.10

        Fixed bug in bitops on ARM.

        Build fixes for unusual compilers.

        Track high water mark for RWX memory.

        Performance improvements on all platforms.


2010-08-18: Version 2.3.9

        Fixed compilation for ARMv4 on OpenBSD/FreeBSD.

        Removed specialized handling of GCC 4.4 (issue 830).

        Fixed DST cache to take into account the suspension of DST in
        Egypt during the 2010 Ramadan (issue http://crbug.com/51855).

        Performance improvements on all platforms.


2010-08-16: Version 2.3.8

        Fixed build with strict aliasing on GCC 4.4 (issue 463).

        Fixed issue with incorrect handling of custom valueOf methods on
        string wrappers (issue 760).

        Fixed compilation for ARMv4 (issue 590).

        Improved performance.


2010-08-11: Version 2.3.7

        Reduced size of heap snapshots produced by heap profiler (issue 783).

        Introduced v8::Value::IsRegExp method.

        Fixed CPU profiler crash in start / stop sequence when non-existent
        name is passed (issue http://crbug.com/51594).

        Introduced new indexed property query callbacks API (issue 816). This
        API is guarded by USE_NEW_QUERY_CALLBACK define and is disabled
        by default.

        Removed support for object literal get/set with number/string
        property name.

        Fixed handling of JSObject::elements in CalculateNetworkSize
        (issue 822).

        Allowed compiling with strict aliasing enabled on GCC 4.4 (issue 463).


2010-08-09: Version 2.3.6

        RegExp literals create a new object every time they are evaluated
        (issue 704).

        Object.seal and Object.freeze return the modified object (issue 809).

        Fixed building using GCC 4.4.4.


2010-08-04: Version 2.3.5

        Added support for ES5 property names. Object initialisers and
        dot-notation property access now allows keywords. Also allowed
        non-identifiers after "get" or "set" in an object initialiser.

        Randomized the addresses of allocated executable memory on Windows.


2010-08-02: Version 2.3.4

        Fixed problems in implementation of ES5 function.prototype.bind.

        Fixed error when using apply with arguments object on ARM (issue 784).

        Added setting of global flags to debugger protocol.

        Fixed an error affecting cached results of sin and cos (issue 792).

        Removed memory leak from a boundary case where V8 is not initialized.

        Fixed issue where debugger could set breakpoints outside the body
        of a function.

        Fixed issue in debugger when using both live edit and step in features.

        Added Number-letter (Nl) category to Unicode tables.  These characters
        can now be used in identifiers.

        Fixed an assert failure on X64 (issue 806).

        Performance improvements on all platforms.


2010-07-26: Version 2.3.3

        Fixed error when building the d8 shell in a fresh checkout.

        Implemented Function.prototype.bind (ES5 15.3.4.5).

        Fixed an error in inlined stores on ia32.

        Fixed an error when setting a breakpoint at the end of a function
        that does not end with a newline character.

        Performance improvements on all platforms.


2010-07-21: Version 2.3.2

        Fixed compiler warnings when building with LLVM.

        Fixed a bug with for-in applied to strings (issue 785).

        Performance improvements on all platforms.


2010-07-19: Version 2.3.1

        Fixed compilation and linking with V8_INTERPRETED_REGEXP flag.

        Fixed bug related to code flushing while compiling a lazy
        compilable function (issue http://crbug.com/49099).

        Performance improvements on all platforms.


2010-07-15: Version 2.3.0

        Added ES5 Object.seal and Object.isSealed.

        Added debugger API for scheduling debugger commands from a
        separate thread.


2010-07-14: Version 2.2.24

        Added API for capturing stack traces for uncaught exceptions.

        Fixed crash bug when preparsing from a non-external V8 string
        (issue 775).

        Fixed JSON.parse bug causing input not to be converted to string
        (issue 764).

        Added ES5 Object.freeze and Object.isFrozen.

        Performance improvements on all platforms.


2010-07-07: Version 2.2.23

        API change: Convert Unicode code points outside the basic multilingual
        plane to the replacement character.  Previous behavior was to silently
        truncate the value to 16 bits.

        Fixed crash: handle all flat string types in regexp replace.

        Prevent invalid pre-parsing data passed in through the API from
        crashing V8.

        Performance improvements on all platforms.


2010-07-05: Version 2.2.22

        Added ES5 Object.isExtensible and Object.preventExtensions.

        Enabled building V8 as a DLL.

        Fixed a bug in date code where -0 was not interpreted as 0
        (issue 736).

        Performance improvements on all platforms.


2010-06-30: Version 2.2.21

        Fixed bug in externalizing some ASCII strings (Chromium issue 47824).

        Updated JSON.stringify to floor the space parameter (issue 753).

        Updated the Mozilla test expectations to the newest version.

        Updated the ES5 Conformance Test expectations to the latest version.

        Updated the V8 benchmark suite.

        Provide actual breakpoints locations in response to setBreakpoint
        and listBreakpoints requests.


2010-06-28: Version 2.2.20

        Fixed bug with for-in on x64 platform (issue 748).

        Fixed crash bug on x64 platform (issue 756).

        Fixed bug in Object.getOwnPropertyNames. (chromium issue 41243).

        Fixed a bug on ARM that caused the result of 1 << x to be
        miscalculated for some inputs.

        Performance improvements on all platforms.


2010-06-23: Version 2.2.19

        Fixed bug that causes the build to break when profillingsupport=off
        (issue 738).

        Added expose-externalize-string flag for testing extensions.

        Resolve linker issues with using V8 as a DLL causing a number of
        problems with unresolved symbols.

        Fixed build failure for cctests when ENABLE_DEBUGGER_SUPPORT is not
        defined.

        Performance improvements on all platforms.


2010-06-16: Version 2.2.18

        Added API functions to retrieve information on indexed properties
        managed by the embedding layer.  Fixes bug 737.

        Made ES5 Object.defineProperty support array elements.  Fixes bug 619.

        Added heap profiling to the API.

        Removed old named property query from the API.

        Incremental performance improvements.


2010-06-14: Version 2.2.17

        Improved debugger support for stepping out of functions.

        Incremental performance improvements.


2010-06-09: Version 2.2.16

        Removed the SetExternalStringDiposeCallback API. Changed the
        disposal of external string resources to call a virtual Dispose
        method on the resource.

        Added support for more precise break points when debugging and
        stepping.

        Memory usage improvements on all platforms.


2010-06-07: Version 2.2.15

        Added an API to control the disposal of external string resources.

        Added missing initialization of a couple of variables which makes
        some compilers complaint when compiling with -Werror.

        Improved performance on all platforms.


2010-06-02: Version 2.2.14

        Fixed a crash in code generated for String.charCodeAt.

        Fixed a compilation issue with some GCC versions (issue 727).

        Performance optimizations on x64 and ARM platforms.


2010-05-31: Version 2.2.13

        Implemented Object.getOwnPropertyDescriptor for element indices and
        strings (issue 599).

        Fixed bug for windows 64 bit C calls from generated code.

        Added new scons flag unalignedaccesses for arm builds.

        Performance improvements on all platforms.


2010-05-26: Version 2.2.12

        Allowed accessors to be defined on objects rather than just object
        templates.

        Changed the ScriptData API.


2010-05-21: Version 2.2.11

        Fixed crash bug in liveedit on 64 bit.

        Use 'full compiler' when debugging is active.  This should increase
        the density of possible break points, making single step more fine
        grained.  This will only take effect for functions compiled after
        debugging has been started, so recompilation of all functions is
        required to get the full effect.  IA32 and x64 only for now.

        Misc. fixes to the Solaris build.

        Added new flags --print-cumulative-gc-stat and --trace-gc-nvp.

        Added filtering of CPU profiles by security context.

        Fixed crash bug on ARM when running without VFP2 or VFP3.

        Incremental performance improvements in all backends.


2010-05-17: Version 2.2.10

        Performance improvements in the x64 and ARM backends.


2010-05-10: Version 2.2.9

        Allowed Object.create to be called with a function (issue 697).

        Fixed bug with Date.parse returning a non-NaN value when called on a
        non date string (issue 696).

        Allowed unaligned memory accesses on ARM targets that support it (by
        Subrato K De of CodeAurora ).

        C++ API for retrieving JavaScript stack trace information.


2010-05-05: Version 2.2.8

        Performance improvements in the x64 and ARM backends.


2010-05-03: Version 2.2.7

        Added support for ES5 date time string format to Date.parse.

        Performance improvements in the x64 backend.


2010-04-28: Version 2.2.6

        Added "amd64" as recognized architecture in scons build script
        (by Ryan Dahl ).

        Fixed bug in String search and replace with very simple RegExps.

        Fixed bug in RegExp containing "\b^".

        Performance improvements on all platforms.


2010-04-26: Version 2.2.5

        Various performance improvements (especially for ARM and x64)

        Fixed bug in CPU profiling (http://crbug.com/42137)

        Fixed a bug with the natives cache.

        Fixed two bugs in the ARM code generator that can cause
        wrong calculations.

        Fixed a bug that may cause a wrong result for shift operations.


2010-04-21: Version 2.2.4

        Fixed warnings on arm on newer GCC versions.

        Fixed a number of minor bugs.

        Performance improvements on all platforms.


2010-04-14: Version 2.2.3

        Added stack command and mem command to ARM simulator debugger.

        Fixed scons snapshot and ARM build, and Windows X64 build issues.

        Performance improvements on all platforms.


2010-04-12: Version 2.2.2

        Introduced new profiler API.

        Fixed random number generator to produce full 32 random bits.


2010-04-06: Version 2.2.1

        Debugger improvements.

        Fixed minor bugs.


2010-03-29: Version 2.2.0

        Fixed a few minor bugs.

        Performance improvements for string operations.


2010-03-26: Version 2.1.10

        Fixed scons build issues.

        Fixed a couple of minor bugs.


2010-03-25: Version 2.1.9

        Added API support for reattaching a global object to a context.

        Extended debugger API with access to the internal debugger context.

        Fixed Chromium crashes (issues http://crbug.com/39128 and
        http://crbug.com/39160)


2010-03-24: Version 2.1.8

        Added fine-grained garbage collection callbacks to the API.

        Performance improvements on all platforms.


2010-03-22: Version 2.1.7

        Fixed issue 650.

        Fixed a bug where __proto__ was sometimes enumerated (issue 646).

        Performance improvements for arithmetic operations.

        Performance improvements for string operations.

        Print script name and line number information in stack trace.


2010-03-17: Version 2.1.6

        Performance improvements for arithmetic operations.

        Performance improvements for string operations.


2010-03-10: Version 2.1.4

        Fixed code cache lookup for keyed IC's (issue http://crbug.com/37853).

        Performance improvements on all platforms.


2010-03-10: Version 2.1.3

        Added API method for context-disposal notifications.

        Added API method for accessing elements by integer index.

        Added missing implementation of Uint32::Value and Value::IsUint32
        API methods.

        Added IsExecutionTerminating API method.

        Disabled strict aliasing for GCC 4.4.

        Fixed string-concatenation bug (issue 636).

        Performance improvements on all platforms.


2010-02-23: Version 2.1.2

        Fixed a crash bug caused by wrong assert.

        Fixed a bug with register names on 64-bit V8 (issue 615).

        Performance improvements on all platforms.


2010-02-19: Version 2.1.1

        [ES5] Implemented Object.defineProperty.

        Improved profiler support.

        Added SetPrototype method in the public V8 API.

        Added GetScriptOrigin and GetScriptLineNumber methods to Function
        objects in the API.

        Performance improvements on all platforms.


2010-02-03: Version 2.1.0

        Values are now always wrapped in objects when used as a receiver.
        (issue 223).

        [ES5] Implemented Object.getOwnPropertyNames.

        [ES5] Restrict JSON.parse to only accept strings that conforms to the
        JSON grammar.

        Improvement of debugger agent (issue 549 and 554).

        Fixed problem with skipped stack frame in profiles (issue 553).

        Solaris support by Erich Ocean  and Ryan Dahl
        .

        Fixed a bug that Math.round() returns incorrect results for huge
        integers.

        Fixed enumeration order for objects created from some constructor
        functions (isue http://crbug.com/3867).

        Fixed arithmetic on some integer constants (issue 580).

        Numerous performance improvements including porting of previous IA-32
        optimizations to x64 and ARM architectures.


2010-01-14: Version 2.0.6

        Added ES5 Object.getPrototypeOf, GetOwnPropertyDescriptor,
        GetOwnProperty, FromPropertyDescriptor.

        Fixed Mac x64 build errors.

        Improved performance of some math and string operations.

        Improved performance of some regexp operations.

        Improved performance of context creation.

        Improved performance of hash tables.


2009-12-18: Version 2.0.5

        Extended to upper limit of map space to allow for 7 times as many map
        to be allocated (issue 524).

        Improved performance of code using closures.

        Improved performance of some binary operations involving doubles.


2009-12-16: Version 2.0.4

        Added ECMAScript 5 Object.create.

        Improved performance of Math.max and Math.min.

        Optimized adding of strings on 64-bit platforms.

        Improved handling of external strings by using a separate table
        instead of weak handles.  This improves garbage collection
        performance and uses less memory.

        Changed code generation for object and array literals in toplevel
        code to be more compact by doing more work in the runtime.

        Fixed a crash bug triggered when garbage collection happened during
        generation of a callback load inline cache stub.

        Fixed crash bug sometimes triggered when local variables shadowed
        parameters in functions that used the arguments object.


2009-12-03: Version 2.0.3

        Optimized handling and adding of strings, for-in and Array.join.

        Heap serialization is now non-destructive.

        Improved profiler support with information on time spend in C++
        callbacks registered through the API.

        Added commands to the debugger protocol for starting/stopping
        profiling.

        Enabled the non-optimizing compiler for top-level code.

        Changed the API to only allow strings to be set as data objects on
        Contexts and scripts to avoid potentially keeping global objects
        around for too long (issue 528).

        OpenBSD support patch by Peter Valchev .

        Fixed bugs.


2009-11-24: Version 2.0.2

        Improved profiler support.

        Fixed bug that broke compilation of d8 with readline support.


2009-11-20: Version 2.0.1

        Fixed crash bug in String.prototype.replace.

        Reverted a change which caused Chromium interactive ui test
        failures.


2009-11-18: Version 2.0.0

        Added support for VFP on ARM.

        Added TryCatch::ReThrow method to the API.

        Reduced the size of snapshots and improved the snapshot load time.

        Improved heap profiler support.

        64-bit version now supported on Windows.

        Fixed a number of debugger issues.

        Fixed bugs.


2009-10-29: Version 1.3.18

        Reverted a change which caused crashes in RegExp replace.

        Reverted a change which caused Chromium ui_tests failure.


2009-10-28: Version 1.3.17

        Added API method to get simple heap statistics.

        Improved heap profiler support.

        Fixed the implementation of the resource constraint API so it
        works when using snapshots.

        Fixed a number of issues in the Windows 64-bit version.

        Optimized calls to API getters.

        Added valgrind notification on code modification to the 64-bit version.

        Fixed issue where we logged shared library addresses on Windows at
        startup and never used them.


2009-10-16: Version 1.3.16

        X64: Convert smis to holding 32 bits of payload.

        Introduced v8::Integer::NewFromUnsigned method.

        Added missing null check in Context::GetCurrent.

        Added trim, trimLeft and trimRight methods to String
        Patch by Jan de Mooij 

        Implement ES5 Array.isArray
        Patch by Jan de Mooij 

        Skip access checks for hidden properties.

        Added String::Concat(Handle left, Handle right) to the
        V8 API.

        Fixed GYP-based builds of V8.


2009-10-07: Version 1.3.15

        Expanded the maximum size of the code space to 512MB for 64-bit mode.

        Fixed a crash bug happening when starting profiling (issue
        http://crbug.com/23768).


2009-10-07: Version 1.3.14

        Added GetRealNamedProperty to the API to lookup real properties
        located on the object or in the prototype chain skipping any
        interceptors.

        Fixed the stack limits setting API to work correctly with threads. The
        stack limit now needs to be set to each thread thich is used with V8.

        Removed the high-priority flag from IdleNotification()

        Ensure V8 is initialized before locking and unlocking threads.

        Implemented a new JavaScript minifier for compressing the source of
        the built-in JavaScript. This removes non-Open Source code from Douglas
        Crockford from the project.

        Added a missing optimization in StringCharAt.

        Fixed some flaky socket tests.

        Change by Alexander Botero-Lowry to fix profiler sampling on FreeBSD
        in 64-bit mode.

        Fixed memory leaks in the thread management code.

        Fixed the result of assignment to a pixel array. The assigned value
        is now the result.

        Error reporting for invalid left-hand sides in for-in statements, pre-
        and postfix count expressions, and assignments now matches the JSC
        behavior in Safari 4.

        Follow the spec in disallowing function declarations without a name.

        Always allocate code objects within a 2 GB range. On x64 architecture
        this is used to use near calls (32-bit displacement) in Code objects.

        Optimized array construction ported to x64 and ARM architectures.

        [ES5] Changed Object.keys to return strings for element indices.


2009-09-23: Version 1.3.13

        Fixed uninitialized memory problem.

        Improved heap profiler support.


2009-09-22: Version 1.3.12

        Changed behavior of |function|.toString() on built-in functions to
        be compatible with other implementations.  Patch by Jan de Mooij.

        Added Object::IsDirty in the API.

        Optimized array construction; it is now handled purely in native
        code.

        [ES5] Made properties of the arguments array enumerable.

        [ES5] Added test suite adapter for the es5conform test suite.

        [ES5] Added Object.keys function.


2009-09-15: Version 1.3.11

        Fixed crash in error reporting during bootstrapping.

        Optimized generated IA32 math code by using SSE2 instructions when
        available.

        Implemented missing pieces of debugger infrastructure on ARM.  The
        debugger is now fully functional on ARM.

        Made 'hidden' the default visibility for gcc.


2009-09-09: Version 1.3.10

        Fixed profiler on Mac in 64-bit mode.

        Optimized creation of objects from simple constructor functions on
        ARM.

        Fixed a number of debugger issues.

        Reduced the amount of memory consumed by V8.


2009-09-02: Version 1.3.9

        Optimized stack guard checks on ARM.

        Optimized API operations by inlining more in the API.

        Optimized creation of objects from simple constructor functions.

        Enabled a number of missing optimizations in the 64-bit port.

        Implemented native-code support for regular expressions on ARM.

        Stopped using the 'sahf' instruction on 64-bit machines that do
        not support it.

        Fixed a bug in the support for forceful termination of JavaScript
        execution.


2009-08-26: Version 1.3.8

        Changed the handling of idle notifications to allow idle
        notifications when V8 has not yet been initialized.

        Fixed ARM simulator compilation problem on Windows.


2009-08-25: Version 1.3.7

        Reduced the size of generated code on ARM platforms by reducing
        the size of constant pools.

        Changed build files to not include the 'ENV' user environment
        variable in the build environment.

        Changed the handling of idle notifications.


2009-08-21: Version 1.3.6

        Added support for forceful termination of JavaScript execution.

        Added low memory notification to the API. The embedding host can signal
        a low memory situation to V8.

        Changed the handling of global handles (persistent handles in the API
        sense) to avoid issues regarding allocation of new global handles
        during weak handle callbacks.

        Changed the growth policy of the young space.

        Fixed a GC issue introduced in version 1.3.5.


2009-08-19: Version 1.3.5

        Optimized initialization of some arrays in the builtins.

        Fixed mac-nm script to support filenames with spaces.

        Support for using the V8 profiler when V8 is embedded in a Windows DLL.

        Changed typeof RegExp from 'object' to 'function' for compatibility.
        Fixed bug where regexps were not callable across contexts.

        Added context independent script compilation to the API.

        Added API call to get the stack trace for an exception.

        Added API for getting object mirrors.

        Made sure that SSE3 instructions are used whenever possible even when
        running off a snapshot generated without using SSE3 instructions.

        Tweaked the handling of the initial size and growth policy of the heap.

        Added native code generation for RegExp to 64-bit version.

        Added JavaScript debugger support to 64-bit version.


2009-08-13: Version 1.3.4

        Added a readline() command to the d8 shell.

        Fixed bug in json parsing.

        Added idle notification to the API and reduced memory on idle
        notifications.


2009-08-12: Version 1.3.3

        Fixed issue 417: incorrect %t placeholder expansion.

        Added .gitignore file similar to Chromium's one.

        Fixed SConstruct file to build with new logging code for Android.

        API: added function to find instance of template in prototype
        chain.  Inlined Object::IsInstanceOf.

        Land change to notify valgrind when we modify code on x86.

        Added api call to determine whether a string can be externalized.

        Added a write() command to d8.


2009-08-05: Version 1.3.2

        Started new compiler infrastructure for two-pass compilation using a
        control flow graph constructed from the AST.

        Profiler stack sampling for X64.

        Safe handling of NaN to Posix platform-dependent time functions.

        Added a new profiler control API to unify controlling various aspects
        of profiling.

        Fixed issue 392.


2009-07-30: Version 1.3.1

        Speed improvements to accessors and interceptors.

        Added support for capturing stack information on custom errors.

        Added support for morphing an object into a pixel array where its
        indexed properties are stored in an external byte array. Values written
        are always clamped to the 0..255 interval.

        Profiler on x64 now handles C/C++ functions from shared libraries.

        Changed the debugger to avoid stepping into function.call/apply if the
        function is a built-in.

        Initial implementation of constructor heap profile for JS objects.

        More fine grained control of profiling aspects through the API.

        Optimized the called as constructor check for API calls.


2009-07-27: Version 1.3.0

        Allowed RegExp objects to be called as functions (issue 132).

        Fixed issue where global property cells would escape after
        detaching the global object; see http://crbug.com/16276.

        Added support for stepping into setters and getters in the
        debugger.

        Changed the debugger to avoid stopping in its own JavaScript code
        and in the code of built-in functions.

        Fixed issue 345 by avoiding duplicate escaping labels.

        Fixed ARM code generator crash in short-circuited boolean
        expressions and added regression tests.

        Added an external allocation limit to avoid issues where small V8
        objects would hold on to large amounts of external memory without
        causing garbage collections.

        Finished more of the inline caching stubs for x64 targets.


2009-07-13: Version 1.2.14

        Added separate paged heap space for global property cells and
        avoid updating the write barrier when storing into them.

        Improved peep-hole optimization on ARM platforms by not emitting
        unnecessary debug information.

        Re-enabled ICs for loads and calls that skip a global object
        during lookup through the prototype chain.

        Allowed access through global proxies to use ICs.

        Fixed issue 401.


2009-07-09: Version 1.2.13

        Fixed issue 397, issue 398, and issue 399.

        Added support for breakpoint groups.

        Fixed bugs introduced with the new global object representation.

        Fixed a few bugs in the ARM code generator.


2009-07-06: Version 1.2.12

        Added stack traces collection to Error objects accessible through
        the e.stack property.

        Changed RegExp parser to use a recursive data structure instead of
        stack-based recursion.

        Optimized Date object construction and string concatenation.

        Improved performance of div, mod, and mul on ARM platforms.


2009-07-02: Version 1.2.11

        Improved performance on IA-32 and ARM.

        Fixed profiler sampler implementation on Mac OS X.

        Changed the representation of global objects to improve
        performance of adding a lot of new properties.


2009-06-29: Version 1.2.10

        Improved debugger support.

        Fixed bug in exception message reporting (issue 390).

        Improved overall performance.


2009-06-23: Version 1.2.9

        Improved math performance on ARM.

        Fixed profiler name-inference bug.

        Fixed handling of shared libraries in the profiler tick processor
        scripts.

        Fixed handling of tests that time out in the test scripts.

        Fixed compilation on MacOS X version 10.4.

        Fixed two bugs in the regular expression engine.

        Fixed a bug in the string type inference.

        Fixed a bug in the handling of 'constant function' properties.

        Improved overall performance.


2009-06-16: Version 1.2.8

        Optimized math on ARM platforms.

        Fixed two crash bugs in the handling of getters and setters.

        Improved the debugger support by adding scope chain information.

        Improved the profiler support by compressing log data transmitted
        to clients.

        Improved overall performance.


2009-06-08: Version 1.2.7

        Improved debugger and profiler support.

        Reduced compilation time by improving the handling of deferred
        code.

        Optimized interceptor accesses where the property is on the object
        on which the interceptors is attached.

        Fixed compilation problem on GCC 4.4 by changing the stack
        alignment to 16 bytes.

        Fixed handle creation to follow stric aliasing rules.

        Fixed compilation on FreeBSD.

        Introduced API for forcing the deletion of a property ignoring
        interceptors and attributes.


2009-05-29: Version 1.2.6

        Added a histogram recording hit rates at different levels of the
        compilation cache.

        Added stack overflow check for the RegExp analysis phase. Previously a
        very long regexp graph could overflow the stack with recursive calls.

        Use a dynamic buffer when collecting log events in memory.

        Added start/stop events to the profiler log.

        Fixed infinite loop which could happen when setting a debug break while
        executing a RegExp compiled to native code.

        Fixed handling of lastIndexOf called with negative index (issue 351).

        Fixed irregular crash in profiler test (issue 358).

        Fixed compilation issues with some versions of gcc.


2009-05-26: Version 1.2.5

        Fixed bug in initial boundary check for Boyer-Moore text
        search (issue 349).

        Fixed compilation issues with MinGW and gcc 4.3+ and added support
        for armv7 and cortex-a8 architectures.  Patches by Lei Zhang and
        Craig Schlenter.

        Added a script cache to the debugger.

        Optimized compilation performance by improving internal data
        structures and avoiding expensive property load optimizations for
        code that's infrequently executed.

        Exposed the calling JavaScript context through the static API
        function Context::GetCalling().


2009-05-18: Version 1.2.4

        Improved performance of floating point number allocation for ARM
        platforms.

        Fixed crash when using the instanceof operator on functions with
        number values in their prototype chain (issue 341).

        Optimized virtual frame operations in the code generator to speed
        up compilation time and allocated the frames in the zone.

        Made the representation of virtual frames and jump targets in the
        code generator much more compact.

        Avoided linear search for non-locals in scope code when resolving
        variables inside with and eval scopes.

        Optimized lexical scanner by dealing with whitespace as part of
        the token scanning instead of as a separate step before it.

        Changed the scavenging collector so that promoted objects do not
        reside in the old generation while their remembered set is being
        swept for pointers into the young generation.

        Fixed numeric overflow handling when compiling count operations.


2009-05-11: Version 1.2.3

        Fixed bug in reporting of out-of-memory situations.

        Introduced hidden prototypes on certain builtin prototype objects
        such as String.prototype to emulate JSC's behavior of restoring
        the original function when deleting functions from those prototype
        objects.

        Fixed crash bug in the register allocator.


2009-05-04: Version 1.2.2

        Fixed bug in array sorting for sparse arrays (issue 326).

        Added support for adding a soname when building a shared library
        on Linux (issue 151).

        Fixed bug caused by morphing internal ASCII strings to external
        two-byte strings.  Slices over ASCII strings have to forward ASCII
        checks to the underlying buffer string.

        Allowed API call-as-function handlers to be called as
        constructors.

        Fixed a crash bug where an external string was disposed but a
        slice of the external string survived as a symbol.


2009-04-27: Version 1.2.1

        Added EcmaScript 5 JSON object.

        Fixed bug in preemption support on ARM.


2009-04-23: Version 1.2.0

        Optimized floating-point operations on ARM.

        Added a number of extensions to the debugger API.

        Changed the enumeration order for unsigned integer keys to always
        be numerical order.

        Added a "read" extension to the shell sample.

        Added support for Array.prototype.reduce and
        Array.prototype.reduceRight.

        Added an option to the SCons build to control Microsoft Visual C++
        link-time code generation.

        Fixed a number of bugs (in particular issue 315, issue 316,
        issue 317 and issue 318).


2009-04-15: Version 1.1.10

        Fixed crash bug that occurred when loading a const variable in the
        presence of eval.

        Allowed using with and eval in registered extensions in debug mode
        by fixing bogus assert.

        Fixed the source position for function returns to enable the
        debugger to break there.


2009-04-14: Version 1.1.9

        Made the stack traversal code in the profiler robust by avoiding
        to look into the heap.

        Added name inferencing for anonymous functions to facilitate
        debugging and profiling.

        Re-enabled stats timers in the developer shell (d8).

        Fixed issue 303 by avoiding to shortcut cons-symbols.


2009-04-11: Version 1.1.8

        Changed test-debug/ThreadedDebugging to be non-flaky (issue 96).

        Fixed step-in handling for Function.prototype.apply and call in
        the debugger (issue 269).

        Fixed v8::Object::DeleteHiddenValue to not bail out when there
        are no hidden properties.

        Added workaround for crash bug, where external symbol table
        entries with deleted resources would lead to NPEs when looking
        up in the symbol table.


2009-04-07: Version 1.1.7

        Added support for easily importing additional environment
        variables into the SCons build.

        Optimized strict equality checks.

        Fixed crash in indexed setters on objects without a corresponding
        getter (issue 298).

        Re-enabled script compilation cache.


2009-04-01: Version 1.1.6

        Reverted an unsafe code generator change.


2009-04-01: Version 1.1.5

        Fixed bug that caused function literals to not be optimized as
        much as other functions.

        Improved profiler support.

        Fixed a crash bug in connection with debugger unloading.

        Fixed a crash bug in the code generator caused by losing the
        information that a frame element was copied.

        Fixed an exception propagation bug that could cause non-null
        return values when exceptions were thrown.


2009-03-30: Version 1.1.4

        Optimized String.prototype.match.

        Improved the stack information in profiles.

        Fixed bug in ARM port making it possible to compile the runtime
        system for thumb mode again.

        Implemented a number of optimizations in the code generator.

        Fixed a number of memory leaks in tests.

        Fixed crash bug in connection with script source code and external
        strings.


2009-03-24: Version 1.1.3

        Fixed assertion failures in compilation of loop conditions.

        Removed STL dependency from developer shell (d8).

        Added infrastructure for protecting the V8 heap from corruption
        caused by memory modifications from the outside.


2009-03-24: Version 1.1.2

        Improved frame merge code generated by the code generator.

        Optimized String.prototype.replace.

        Implemented __defineGetter__ and __defineSetter__ for properties
        with integer keys on non-array objects.

        Improved debugger and profiler support.

        Fixed a number of portability issues to allow compilation for
        smaller ARM devices.

        Exposed object cloning through the API.

        Implemented hidden properties.  This is used to expose an identity
        hash for objects through the API.

        Implemented restarting of regular expressions if their input
        string changes representation during preemption.

        Fixed a code generator bug that could cause assignments in loops
        to be ignored if using continue to break out of the loop (issue
        284).


2009-03-12: Version 1.1.1

        Fixed an assertion in the new compiler to take stack overflow
        exceptions into account.

        Removed exception propagation code that could cause crashes.

        Fixed minor bug in debugger line number computations.

        8-byte align the C stack on Linux and Windows to speed up floating
        point computations.


2009-03-12: Version 1.1.0

        Improved code generation infrastructure by doing simple register
        allocation and constant folding and propagation.

        Optimized regular expression matching by avoiding to create
        intermediate string arrays and by flattening nested array
        representations of RegExp data.

        Traverse a few stack frames when recording profiler samples to
        include partial call graphs in the profiling output.

        Added support for using OProfile to profile generated code.

        Added remote debugging support to the D8 developer shell.

        Optimized creation of nested literals like JSON objects.

        Fixed a bug in garbage collecting unused maps and turned it on by
        default (--collect-maps).

        Added support for running tests under Valgrind.


2009-02-27: Version 1.0.3

        Optimized double-to-integer conversions in bit operations by using
        SSE3 instructions if available.

        Optimized initialization sequences that store to multiple
        properties of the same object.

        Changed the D8 debugger frontend to use JSON messages.

        Force garbage collections when disposing contexts.

        Align code objects at 32-byte boundaries.


2009-02-25: Version 1.0.2

        Improved profiling support by performing simple call stack
        sampling for ticks and by fixing a bug in the logging of code
        addresses.

        Fixed a number of debugger issues.

        Optimized code that uses eval.

        Fixed a couple of bugs in the regular expression engine.

        Reduced the size of generated code for certain regular expressions.

        Removed JSCRE completely.

        Fixed issue where test could not be run if there was a dot in the
        checkout path.


2009-02-13: Version 1.0.1

        Fixed two crash-bugs in irregexp (issue 231 and 233).

        Fixed a number of minor bugs (issue 87, 227 and 228).

        Added support for morphing strings to external strings on demand
        to avoid having to create copies in the embedding code.

        Removed experimental support for external symbol callbacks.


2009-02-09: Version 1.0.0

        Fixed crash-bug in the code generation for case independent 16 bit
        backreferences.

        Made shells more robust in the presence of string conversion
        failures (issue 224).

        Fixed a potential infinite loop when attempting to resolve
        eval (issue 221).

        Miscellaneous fixes to the new regular expression engine.

        Reduced binary by stripping unneeded text from JavaScript library and
        minifying some JavaScript files.


2009-01-27: Version 0.4.9

        Enabled new regular expression engine.

        Made a number of changes to the debugger protocol.

        Fixed a number of bugs in the preemption support.

        Added -p option to the developer shell to run files in parallel
        using preemption.

        Fixed a number of minor bugs (including issues 176, 187, 189, 192,
        193, 198 and 201).

        Fixed a number of bugs in the serialization/deserialization
        support for the ARM platform.


2009-01-19: Version 0.4.8.1

        Minor patch to debugger support.


2009-01-16: Version 0.4.8

        Fixed string length bug on ARM (issue 171).

        Made most methods in the API const.

        Optimized object literals by improving data locality.

        Fixed bug that caused incomplete functions to be cached in case of
        stack overflow exceptions.

        Fixed bugs that caused catch variables and variables introduced by
        eval to behave incorrectly when using accessors (issues 186, 190
        and 191).


2009-01-06: Version 0.4.7

        Minor bugfixes and optimizations.

        Added command line debugger to D8 shell.

        Fixed subtle bug that caused the wrong 'this' to be used when
        calling a caught function in a catch clause.

        Inline array loads within loops directly in the code instead of
        always calling a stub.


2008-12-11: Version 0.4.6

        Fixed exception reporting bug where certain exceptions were
        incorrectly reported as uncaught.

        Improved the memory allocation strategy used during compilation to
        make running out of memory when compiling huge scripts less
        likely.

        Optimized String.replace by avoiding the construction of certain
        sub strings.

        Fixed bug in code generation for large switch statements on ARM.

        Fixed bug that caused V8 to change the global object template
        passed in by the user.

        Changed the API for creating object groups used during garbage
        collection.  Entire object groups are now passed to V8 instead of
        individual members of the groups.


2008-12-03: Version 0.4.5

        Added experimental API support for allocating V8 symbols as
        external strings.

        Fixed bugs in debugging support on ARM.

        Changed eval implementation to correctly detect whether or not a
        call to eval is aliased.

        Fixed bug caused by a combination of the compilation cache and
        dictionary probing in native code.  The bug caused us to sometimes
        call functions that had not yet been compiled.

        Added platform support for FreeBSD.

        Added support for building V8 on Windows with either the shared or
        static version of MSVCRT

        Added the v8::jscre namespace around the jscre functions to avoid
        link errors (duplicate symbols) when building Google Chrome.

        Added support for calling a JavaScript function with the current
        debugger execution context as its argument to the debugger
        interface.

        Changed the type of names of counters from wchar_t to char.

        Changed the Windows system call used to compute daylight savings
        time.  The system call that we used to use became four times
        slower on WinXP SP3.

        Added support in the d8 developer shell for memory-mapped counters
        and added a stats-viewer tool.

        Fixed bug in upper/lower case mappings (issue 149).


2008-11-17: Version 0.4.4

        Reduced code size by using shorter instruction encoding when
        possible.

        Added a --help option to the shell sample and to the d8 shell.

        Added visual studio project files for building the ARM simulator.

        Fixed a number of ARM simulator issues.

        Fixed bug in out-of-memory handling on ARM.

        Implemented shell support for passing arguments to a script from
        the command line.

        Fixed bug in date code that made certain date functions return -0
        instead of 0 for dates before the epoch.

        Restricted applications of eval so it can only be used in the
        context of the associated global object.

        Treat byte-order marks as whitespace characters.


2008-11-04: Version 0.4.3

        Added support for API accessors that prohibit overwriting by
        accessors defined in JavaScript code by using __defineGetter__ and
        __defineSetter__.

        Improved handling of conditionals in test status files.

        Introduced access control in propertyIsEnumerable.

        Improved performance of some string operations by caching
        information about the type of the string between operations.

        Fixed bug in fast-case code for switch statements that only have
        integer labels.


2008-10-30: Version 0.4.2

        Improved performance of Array.prototype.concat by moving the
        implementation to C++ (issue 123).

        Fixed heap growth policy to avoid growing old space to its maximum
        capacity before doing a garbage collection and fixed issue that
        would lead to artificial out of memory situations (issue 129).

        Fixed Date.prototype.toLocaleDateString to return the date in the
        same format as WebKit.

        Added missing initialization checks to debugger API.

        Added removing of unused maps during GC.


2008-10-28: Version 0.4.1

        Added caching of RegExp data in compilation cache.

        Added Visual Studio project file for d8 shell.

        Fixed function call performance regression introduced in version
        0.4.0 when splitting the global object in two parts (issue 120).

        Fixed issue 131 by checking for empty handles before throwing and
        reporting exceptions.


2008-10-23: Version 0.4.0

        Split the global object into two parts: The state holding global
        object and the global object proxy.

        Fixed bug that affected the value of an assignment to an element
        in certain cases (issue 116).

        Added GetPropertyNames functionality (issue 33) and extra Date
        functions (issue 77) to the API.

        Changed WeakReferenceCallback to take a Persistent instead
        of a Persistent (issue 101).

        Fixed issues with message reporting for exceptions in try-finally
        blocks (issues 73 and 75).

        Optimized flattening of strings and string equality checking.

        Improved Boyer-Moore implementation for faster indexOf operations.

        Added development shell (d8) which includes counters and
        completion support.

        Fixed problem with the receiver passed to functions called from
        eval (issue 124).


2008-10-16: Version 0.3.5

        Improved string hash-code distribution by excluding bit-field bits
        from the hash-code.

        Changed string search algorithm used in indexOf from KMP to
        Boyer-Moore.

        Improved the generated code for the instanceof operator.

        Improved performance of slow-case string equality checks by
        specializing the code based on the string representation.

        Improve the handling of out-of-memory situations (issue 70).

        Improved performance of strict equality checks.

        Improved profiler output to make it easier to see anonymous
        functions.

        Improved performance of slow-case keyed loads.

        Improved property access performance by allocating a number of
        properties in the front object.

        Changed the toString behavior on the built-in object constructors
        to print [native code] instead of the actual source.  Some web
        applications do not like constructors with complex toString
        results.


2008-10-06: Version 0.3.4

        Changed Array.prototype.sort to use quick sort.

        Fixed code generation issue where leaving a finally block with
        break or continue would accumulate elements on the expression
        stack (issue 86).

        Made sure that the name accessor on functions returns the expected
        names for builtin JavaScript functions and C++ callback functions.

        Added fast case code for extending the property storage array of
        JavaScript objects.

        Ported switch statement optimizations introduced in version 0.3.3
        to the ARM code generator.

        Allowed GCC to use strict-aliasing rules when compiling.

        Improved performance of arguments object allocation by taking care
        of arguments adaptor frames in the generated code.

        Updated the V8 benchmark suite to version 2.


2008-09-25: Version 0.3.3

        Improved handling of relocation information to enable more
        peep-hole optimizations.

        Optimized switch statements where all labels are constant small
        integers.

        Optimized String.prototype.indexOf for common cases.

        Fixed more build issues (issue 80).

        Fixed a couple of profiler issues.

        Fixed bug where the body of a function created using the Function
        constructor was not allowed to end with a single-line comment
        (issue 85).

        Improved handling of object literals by canonicalizing object
        literal maps.  This will allow JSON objects with the same set of
        properties to share the same map making inline caching work better
        for JSON objects.


2008-09-17: Version 0.3.2

        Generalized the EvalCache into a CompilationCache and enabled it
        for scripts too.  The current strategy is to retire all entries
        whenever a mark-sweep collection is started.

        Fixed bug where switch statements containing only a default case
        would lead to an unbalanced stack (issue 69).

        Fixed bug that made access to the function in a named function
        expression impossible in certain situations (issue 24).

        Fixed even more build issues.

        Optimized calling conventions on ARM.  The conventions on ARM and
        IA-32 now match.

        Removed static initializers for flags and counters.

        Improved inline caching behavior for uncommon cases where lazily
        loading Date and RegExp code could force certain code paths go
        megamorphic.

        Removed arguments adaption for builtins written in C++.  This
        makes Array.prototype.push and Array.prototype.pop slightly
        faster.


2008-09-11: Version 0.3.1

        Fixed a number of build issues.

        Fixed problem with missing I-cache flusing on ARM.

        Changed space layout in memory management by splitting up
        code space into old data space and code space.

        Added utf-8 conversion support to the API (issue 57).

        Optimized repeated calls to eval with the same strings.  These
        repeated calls are common in web applications.

        Added Xcode project file.

        Optimized a couple of Array operation.

        Fixed parser bug by checking for end-of-string when parsing break
        and continue (issue 35).

        Fixed problem where asian characters were not categorized as
        letters.

        Fixed bug that disallowed calling functions fetched from an array
        using a string as an array index (issue 32).

        Fixed bug where the internal field count on object templates were
        sometimes ignored (issue 54).

        Added -f option to the shell sample for compatibility with other
        engines (issue 18).

        Added source info to TryCatches in the API.

        Fixed problem where the seed for the random number generator was
        clipped in a double to unsigned int conversion.

        Fixed bug where cons string symbols were sometimes converted to
        non-symbol flat strings during GC.

        Fixed bug in error reporting when attempting to convert null to an
        object.


2008-09-04: Version 0.3.0

        Added support for running tests on the ARM simulator.

        Fixed bug in the 'in' operator where negative indices were not
        treated correctly.

        Fixed build issues on gcc-4.3.1.

        Changed Date.prototype.toLocaleTimeString to not print the
        timezone part of the time.

        Renamed debug.h to v8-debug.h to reduce the risk of name conflicts
        with user code.


2008-09-02: Version 0.2.5

        Renamed the top level directory 'public' to 'include'.

        Added 'env' option to the SCons build scripts to support
        overriding the ENV part of the build environment.  This is mostly
        to support Windows builds in cases where SCons cannot find the
        correct paths to the Windows SDK, as these paths cannot be passed
        through shell environment variables.

        Enabled "Buffer Security Check" on for the Windows SCons build and
        added the linker option /OPT:ICF as an optimization.

        Added the V8 benchmark suite to the repository.


2008-09-01: Version 0.2.4

        Included mjsunit JavaScript test suite and C++ unit tests.

        Changed the shell sample to not print the result of executing a
        script provided on the command line.

        Fixed issue when building samples on Windows using a shared V8
        library.  Added visibility option on Linux build which makes the
        generated library 18% smaller.

        Changed build system to accept multiple build modes in one build
        and generate separate objects, libraries and executables for each
        mode.

        Removed deferred negation optimization (a * -b => -(a * b)) since
        this visibly changes operand conversion order.

        Improved parsing performance by introducing stack guard in
        preparsing.  Without a stack guard preparsing always bails out
        with stack overflow.

        Changed shell sample to take flags directly from the command-line.
        Added API call that implements this.

        Added load, quit and version functions to the shell sample so it's
        easier to run benchmarks and tests.

        Fixed issue with building samples and cctests on 64-bit machines.

        Fixed bug in the runtime system where the prototype chain was not
        always searched for a setter when setting a property that does not
        exist locally.


2008-08-14: Version 0.2.3

        Improved performance of garbage collection by moving the
        function that updates pointers during compacting collection
        into the updating visitor.  This gives the compiler a better
        chance to inline and avoid a function call per (potential)
        pointer.

        Extended the shell sample with a --runtime-flags option.

        Added Visual Studio project files for the shell.cc and
        process.cc samples.


2008-08-13: Version 0.2.2

        Improved performance of garbage collection by changing the way
        we use the marking stack in the event of stack overflow during
        full garbage collection and by changing the way we mark roots.

        Cleaned up ARM version by removing top of stack caching and by
        introducing push/pop elimination.

        Cleaned up the way runtime functions are called to allow
        runtime calls with no arguments.

        Changed Windows build options to make sure that exceptions are
        disabled and that optimization flags are enabled.

        Added first version of Visual Studio project files.


2008-08-06: Version 0.2.1

        Improved performance of unary addition by avoiding runtime calls.

        Fixed the handling of '>' and '<=' to use right-to-left conversion
        and left-to-right evaluation as specified by ECMA-262.

        Fixed a branch elimination bug on the ARM platform where incorrect
        code was generated because of overly aggressive branch
        elimination.

        Improved performance of code that repeatedly assigns the same
        function to the same property of different objects with the same
        map.

        Untangled DEBUG and ENABLE_DISASSEMBLER defines.  The disassembler
        no longer expects DEBUG to be defined.

        Added platform-nullos.cc to serve as the basis for new platform
        implementations.


2008-07-30: Version 0.2.0

        Changed all text files to have native svn:eol-style.

        Added a few samples and support for building them. The samples
        include a simple shell that can be used to benchmark and test V8.

        Changed V8::GetVersion to return the version as a string.

        Added source for lazily loaded scripts to snapshots and made
        serialization non-destructive.

        Improved ARM support by fixing the write barrier code to use
        aligned loads and stores and by removing premature locals
        optimization that relied on broken support for callee-saved
        registers (removed).

        Refactored the code for marking live objects during garbage
        collection and the code for allocating objects in paged
        spaces. Introduced an abstraction for the map word of a heap-
        allocated object and changed the memory allocator to allocate
        executable memory only for spaces that may contain code objects.

        Moved StringBuilder to utils.h and ScopedLock to platform.h, where
        they can be used by debugging and logging modules. Added
        thread-safe message queues for dealing with debugger events.

        Fixed the source code reported by toString for certain builtin
        empty functions and made sure that the prototype property of a
        function is enumerable.

        Improved performance of converting values to condition flags in
        generated code.

        Merged disassembler-{arch} files.


2008-07-28: Version 0.1.4

        Added support for storing JavaScript stack traces in a stack
        allocated buffer to make it visible in shallow core dumps.
        Controlled by the --preallocate-message-memory flag which is
        disabled by default.


2008-07-25: Version 0.1.3

        Fixed bug in JSObject::GetPropertyAttributePostInterceptor where
        map transitions would count as properties.

        Allowed aliased eval invocations by treating them as evals in the
        global context. This may change in the future.

        Added support for accessing the last entered context through the
        API and renamed Context::Current to Context::GetCurrent and
        Context::GetSecurityContext to Context::GetCurrentSecurityContext.

        Fixed bug in the debugger that would cause the debugger scripts to
        be recursively loaded and changed all disabling of interrupts to
        be block-structured.

        Made snapshot data read-only to allow it to be more easily shared
        across multiple users of V8 when linked as a shared library.


2008-07-16: Version 0.1.2

        Fixed building on Mac OS X by recognizing i386 and friends as
        IA-32 platforms.

        Added propagation of stack overflow exceptions that occur while
        compiling nested functions.

        Improved debugger with support for recursive break points and
        handling of exceptions that occur in the debugger JavaScript code.

        Renamed GetInternal to GetInternalField and SetInternal to
        SetInternalField in the API and moved InternalFieldCount and
        SetInternalFieldCount from FunctionTemplate to ObjectTemplate.


2008-07-09: Version 0.1.1

        Fixed bug in stack overflow check code for IA-32 targets where a
        non-tagged value in register eax was pushed to the stack.

        Fixed potential quadratic behavior when converting strings to
        numbers.

        Fixed bug where the return value from Object::SetProperty could
        end up being the property holder instead of the written value.

        Improved debugger support by allowing nested break points and by
        dealing with stack-overflows when compiling functions before
        setting break points in them.


2008-07-03: Version 0.1.0

        Initial export.

# Local Variables:
# mode:text
# End:
node-v4.8.2/deps/v8/codereview.settings000644 000766 000024 00000000464 13070706732 020167 0ustar00iojsstaff000000 000000 CODE_REVIEW_SERVER: https://codereview.chromium.org
CC_LIST: v8-reviews@googlegroups.com
VIEW_VC: https://chromium.googlesource.com/v8/v8/+/
STATUS: http://v8-status.appspot.com/status
TRY_ON_UPLOAD: False
TRYSERVER_SVN_URL: svn://svn.chromium.org/chrome-try-v8
PROJECT: v8
PENDING_REF_PREFIX: refs/pending/
node-v4.8.2/deps/v8/DEPS000644 000766 000024 00000007164 13070706732 014733 0ustar00iojsstaff000000 000000 # Note: The buildbots evaluate this file with CWD set to the parent
# directory and assume that the root of the checkout is in ./v8/, so
# all paths in here must match this assumption.

vars = {
  "git_url": "https://chromium.googlesource.com",
}

deps = {
  "v8/build/gyp":
    Var("git_url") + "/external/gyp.git" + "@" + "5122240c5e5c4d8da12c543d82b03d6089eb77c5",
  "v8/third_party/icu":
    Var("git_url") + "/chromium/deps/icu.git" + "@" + "c81a1a3989c3b66fa323e9a6ee7418d7c08297af",
  "v8/buildtools":
    Var("git_url") + "/chromium/buildtools.git" + "@" + "ecc8e253abac3b6186a97573871a084f4c0ca3ae",
  "v8/testing/gtest":
    Var("git_url") + "/external/googletest.git" + "@" + "23574bf2333f834ff665f894c97bef8a5b33a0a9",
  "v8/testing/gmock":
    Var("git_url") + "/external/googlemock.git" + "@" + "29763965ab52f24565299976b936d1265cb6a271",  # from svn revision 501
  "v8/tools/clang":
    Var("git_url") + "/chromium/src/tools/clang.git" + "@" + "73ec8804ed395b0886d6edf82a9f33583f4a7902",
}

deps_os = {
  "android": {
    "v8/third_party/android_tools":
      Var("git_url") + "/android_tools.git" + "@" + "21f4bcbd6cd927e4b4227cfde7d5f13486be1236",
  },
  "win": {
    "v8/third_party/cygwin":
      Var("git_url") + "/chromium/deps/cygwin.git" + "@" + "c89e446b273697fadf3a10ff1007a97c0b7de6df",
  }
}

include_rules = [
  # Everybody can use some things.
  "+include",
  "+unicode",
  "+third_party/fdlibm",
]

# checkdeps.py shouldn't check for includes in these directories:
skip_child_includes = [
  "build",
  "third_party",
]

hooks = [
  {
    # This clobbers when necessary (based on get_landmines.py). It must be the
    # first hook so that other things that get/generate into the output
    # directory will not subsequently be clobbered.
    'name': 'landmines',
    'pattern': '.',
    'action': [
        'python',
        'v8/build/landmines.py',
    ],
  },
  # Pull clang-format binaries using checked-in hashes.
  {
    "name": "clang_format_win",
    "pattern": ".",
    "action": [ "download_from_google_storage",
                "--no_resume",
                "--platform=win32",
                "--no_auth",
                "--bucket", "chromium-clang-format",
                "-s", "v8/buildtools/win/clang-format.exe.sha1",
    ],
  },
  {
    "name": "clang_format_mac",
    "pattern": ".",
    "action": [ "download_from_google_storage",
                "--no_resume",
                "--platform=darwin",
                "--no_auth",
                "--bucket", "chromium-clang-format",
                "-s", "v8/buildtools/mac/clang-format.sha1",
    ],
  },
  {
    "name": "clang_format_linux",
    "pattern": ".",
    "action": [ "download_from_google_storage",
                "--no_resume",
                "--platform=linux*",
                "--no_auth",
                "--bucket", "chromium-clang-format",
                "-s", "v8/buildtools/linux64/clang-format.sha1",
    ],
  },
  # Pull binutils for linux, enabled debug fission for faster linking /
  # debugging when used with clang on Ubuntu Precise.
  # https://code.google.com/p/chromium/issues/detail?id=352046
  {
    'name': 'binutils',
    'pattern': 'v8/third_party/binutils',
    'action': [
        'python',
        'v8/third_party/binutils/download.py',
    ],
  },
  {
    # Pull clang if needed or requested via GYP_DEFINES.
    # Note: On Win, this should run after win_toolchain, as it may use it.
    'name': 'clang',
    'pattern': '.',
    'action': ['python', 'v8/tools/clang/scripts/update.py', '--if-needed'],
  },
  {
    # A change to a .gyp, .gypi, or to GYP itself should run the generator.
    "pattern": ".",
    "action": ["python", "v8/build/gyp_v8"],
  },
]
node-v4.8.2/deps/v8/include/000755 000766 000024 00000000000 13070706732 015670 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/v8/infra/000755 000766 000024 00000000000 13070706732 015344 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/v8/LICENSE000644 000766 000024 00000005541 13070706732 015257 0ustar00iojsstaff000000 000000 This license applies to all parts of V8 that are not externally
maintained libraries.  The externally maintained libraries used by V8
are:

  - PCRE test suite, located in
    test/mjsunit/third_party/regexp-pcre/regexp-pcre.js.  This is based on the
    test suite from PCRE-7.3, which is copyrighted by the University
    of Cambridge and Google, Inc.  The copyright notice and license
    are embedded in regexp-pcre.js.

  - Layout tests, located in test/mjsunit/third_party/object-keys.  These are
    based on layout tests from webkit.org which are copyrighted by
    Apple Computer, Inc. and released under a 3-clause BSD license.

  - Strongtalk assembler, the basis of the files assembler-arm-inl.h,
    assembler-arm.cc, assembler-arm.h, assembler-ia32-inl.h,
    assembler-ia32.cc, assembler-ia32.h, assembler-x64-inl.h,
    assembler-x64.cc, assembler-x64.h, assembler-mips-inl.h,
    assembler-mips.cc, assembler-mips.h, assembler.cc and assembler.h.
    This code is copyrighted by Sun Microsystems Inc. and released
    under a 3-clause BSD license.

  - Valgrind client API header, located at third_party/valgrind/valgrind.h
    This is release under the BSD license.

These libraries have their own licenses; we recommend you read them,
as their terms may differ from the terms below.

Further license information can be found in LICENSE files located in 
sub-directories.

Copyright 2014, the V8 project authors. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above
      copyright notice, this list of conditions and the following
      disclaimer in the documentation and/or other materials provided
      with the distribution.
    * Neither the name of Google Inc. nor the names of its
      contributors may be used to endorse or promote products derived
      from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
node-v4.8.2/deps/v8/LICENSE.strongtalk000644 000766 000024 00000002712 13070706732 017443 0ustar00iojsstaff000000 000000 Copyright (c) 1994-2006 Sun Microsystems Inc.
All Rights Reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

- Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.

- Redistribution in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.

- Neither the name of Sun Microsystems or the names of contributors may
be used to endorse or promote products derived from this software without
specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
node-v4.8.2/deps/v8/LICENSE.v8000644 000766 000024 00000002767 13070706732 015622 0ustar00iojsstaff000000 000000 Copyright 2006-2011, the V8 project authors. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above
      copyright notice, this list of conditions and the following
      disclaimer in the documentation and/or other materials provided
      with the distribution.
    * Neither the name of Google Inc. nor the names of its
      contributors may be used to endorse or promote products derived
      from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
node-v4.8.2/deps/v8/LICENSE.valgrind000644 000766 000024 00000004016 13070706732 017060 0ustar00iojsstaff000000 000000 ----------------------------------------------------------------

Notice that the following BSD-style license applies to this one
file (valgrind.h) only.  The rest of Valgrind is licensed under the
terms of the GNU General Public License, version 2, unless
otherwise indicated.  See the COPYING file in the source
distribution for details.

----------------------------------------------------------------

This file is part of Valgrind, a dynamic binary instrumentation
framework.

Copyright (C) 2000-2007 Julian Seward.  All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.

2. The origin of this software must not be misrepresented; you must 
   not claim that you wrote the original software.  If you use this 
   software in a product, an acknowledgment in the product 
   documentation would be appreciated but is not required.

3. Altered source versions must be plainly marked as such, and must
   not be misrepresented as being the original software.

4. The name of the author may not be used to endorse or promote 
   products derived from this software without specific prior written 
   permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
node-v4.8.2/deps/v8/Makefile000644 000766 000024 00000042344 13070706732 015714 0ustar00iojsstaff000000 000000 # Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


# Variable default definitions. Override them by exporting them in your shell.
OUTDIR ?= out
TESTJOBS ?=
GYPFLAGS ?=
TESTFLAGS ?=
ANDROID_NDK_HOST_ARCH ?=
ANDROID_V8 ?= /data/local/tmp/v8
NACL_SDK_ROOT ?=

# Special build flags. Use them like this: "make library=shared"

# library=shared || component=shared_library
ifeq ($(library), shared)
  GYPFLAGS += -Dcomponent=shared_library
endif
ifdef component
  GYPFLAGS += -Dcomponent=$(component)
endif
# console=readline
ifdef console
  GYPFLAGS += -Dconsole=$(console)
endif
# disassembler=on
ifeq ($(disassembler), on)
  GYPFLAGS += -Dv8_enable_disassembler=1
endif
# objectprint=on
ifeq ($(objectprint), on)
  GYPFLAGS += -Dv8_object_print=1
endif
# verifyheap=on
ifeq ($(verifyheap), on)
  GYPFLAGS += -Dv8_enable_verify_heap=1
endif
# tracemaps=on
ifeq ($(tracemaps), on)
  GYPFLAGS += -Dv8_trace_maps=1
endif
# backtrace=off
ifeq ($(backtrace), off)
  GYPFLAGS += -Dv8_enable_backtrace=0
else
  GYPFLAGS += -Dv8_enable_backtrace=1
endif
# verifypredictable=on
ifeq ($(verifypredictable), on)
  GYPFLAGS += -Dv8_enable_verify_predictable=1
endif
# snapshot=off
ifeq ($(snapshot), off)
  GYPFLAGS += -Dv8_use_snapshot='false'
endif
ifeq ($(snapshot), external)
  GYPFLAGS += -Dv8_use_external_startup_data=1
endif
# extrachecks=on/off
ifeq ($(extrachecks), on)
  GYPFLAGS += -Ddcheck_always_on=1 -Dv8_enable_handle_zapping=1
endif
ifeq ($(extrachecks), off)
  GYPFLAGS += -Ddcheck_always_on=0 -Dv8_enable_handle_zapping=0
endif
# slowdchecks=on/off
ifeq ($(slowdchecks), on)
  GYPFLAGS += -Dv8_enable_slow_dchecks=1
endif
ifeq ($(slowdchecks), off)
  GYPFLAGS += -Dv8_enable_slow_dchecks=0
endif
# debugsymbols=on
ifeq ($(debugsymbols), on)
  GYPFLAGS += -Drelease_extra_cflags=-ggdb3
endif
# gdbjit=on/off
ifeq ($(gdbjit), on)
  GYPFLAGS += -Dv8_enable_gdbjit=1
endif
ifeq ($(gdbjit), off)
  GYPFLAGS += -Dv8_enable_gdbjit=0
endif
# vtunejit=on
ifeq ($(vtunejit), on)
  GYPFLAGS += -Dv8_enable_vtunejit=1
endif
# unalignedaccess=on
ifeq ($(unalignedaccess), on)
  GYPFLAGS += -Dv8_can_use_unaligned_accesses=true
endif
# randomseed=12345, disable random seed via randomseed=0
ifdef randomseed
  GYPFLAGS += -Dv8_random_seed=$(randomseed)
endif
# soname_version=1.2.3
ifdef soname_version
  GYPFLAGS += -Dsoname_version=$(soname_version)
endif
# werror=no
ifeq ($(werror), no)
  GYPFLAGS += -Dwerror=''
endif
# presubmit=no
ifeq ($(presubmit), no)
  TESTFLAGS += --no-presubmit
endif
# strictaliasing=off (workaround for GCC-4.5)
ifeq ($(strictaliasing), off)
  GYPFLAGS += -Dv8_no_strict_aliasing=1
endif
# regexp=interpreted
ifeq ($(regexp), interpreted)
  GYPFLAGS += -Dv8_interpreted_regexp=1
endif
# i18nsupport=off
ifeq ($(i18nsupport), off)
  GYPFLAGS += -Dv8_enable_i18n_support=0
  TESTFLAGS += --noi18n
endif
# deprecationwarnings=on
ifeq ($(deprecationwarnings), on)
  GYPFLAGS += -Dv8_deprecation_warnings=1
endif
# imminentdeprecationwarnings=on
ifeq ($(imminentdeprecationwarnings), on)
  GYPFLAGS += -Dv8_imminent_deprecation_warnings=1
endif
# asan=on
ifeq ($(asan), on)
  GYPFLAGS += -Dasan=1 -Dclang=1
  TESTFLAGS += --asan
  ifeq ($(lsan), on)
    GYPFLAGS += -Dlsan=1
  endif
endif
ifdef embedscript
  GYPFLAGS += -Dembed_script=$(embedscript)
endif

# arm specific flags.
# arm_version=
ifneq ($(strip $(arm_version)),)
  GYPFLAGS += -Darm_version=$(arm_version)
else
# Deprecated (use arm_version instead): armv7=false/true
ifeq ($(armv7), false)
  GYPFLAGS += -Darm_version=6
else
ifeq ($(armv7), true)
  GYPFLAGS += -Darm_version=7
endif
endif
endif
# hardfp=on/off. Deprecated, use armfloatabi
ifeq ($(hardfp),on)
  GYPFLAGS += -Darm_float_abi=hard
else
ifeq ($(hardfp),off)
  GYPFLAGS += -Darm_float_abi=softfp
endif
endif
# fpu: armfpu=xxx
# xxx: vfp, vfpv3-d16, vfpv3, neon.
ifeq ($(armfpu),)
  GYPFLAGS += -Darm_fpu=default
else
  GYPFLAGS += -Darm_fpu=$(armfpu)
endif
# float abi: armfloatabi=softfp/hard
ifeq ($(armfloatabi),)
ifeq ($(hardfp),)
  GYPFLAGS += -Darm_float_abi=default
endif
else
  GYPFLAGS += -Darm_float_abi=$(armfloatabi)
endif
# armthumb=on/off
ifeq ($(armthumb), off)
  GYPFLAGS += -Darm_thumb=0
else
ifeq ($(armthumb), on)
  GYPFLAGS += -Darm_thumb=1
endif
endif
# arm_test_noprobe=on
# With this flag set, by default v8 will only use features implied
# by the compiler (no probe). This is done by modifying the default
# values of enable_armv7, enable_vfp3, enable_32dregs and enable_neon.
# Modifying these flags when launching v8 will enable the probing for
# the specified values.
ifeq ($(arm_test_noprobe), on)
  GYPFLAGS += -Darm_test_noprobe=on
endif

# ----------------- available targets: --------------------
# - "grokdump": rebuilds heap constants lists used by grokdump
# - any arch listed in ARCHES (see below)
# - any mode listed in MODES
# - every combination ., e.g. "ia32.release"
# - "native": current host's architecture, release mode
# - any of the above with .check appended, e.g. "ia32.release.check"
# - "android": cross-compile for Android/ARM
# - "nacl" : cross-compile for Native Client (ia32 and x64)
# - default (no target specified): build all DEFAULT_ARCHES and MODES
# - "check": build all targets and run all tests
# - ".clean" for any  in ARCHES
# - "clean": clean all ARCHES

# ----------------- internal stuff ------------------------

# Architectures and modes to be compiled. Consider these to be internal
# variables, don't override them (use the targets instead).
ARCHES = ia32 x64 x32 arm arm64 mips mipsel mips64el x87 ppc ppc64
DEFAULT_ARCHES = ia32 x64 arm
MODES = release debug optdebug
DEFAULT_MODES = release debug
ANDROID_ARCHES = android_ia32 android_x64 android_arm android_arm64 \
		 android_mipsel android_x87
NACL_ARCHES = nacl_ia32 nacl_x64

# List of files that trigger Makefile regeneration:
GYPFILES = third_party/icu/icu.gypi third_party/icu/icu.gyp \
	   build/shim_headers.gypi build/features.gypi build/standalone.gypi \
	   build/toolchain.gypi build/all.gyp build/mac/asan.gyp \
	   test/cctest/cctest.gyp \
	   test/unittests/unittests.gyp tools/gyp/v8.gyp \
	   tools/parser-shell.gyp testing/gmock.gyp testing/gtest.gyp \
	   buildtools/third_party/libc++abi/libc++abi.gyp \
	   buildtools/third_party/libc++/libc++.gyp samples/samples.gyp \
	   src/third_party/vtune/v8vtune.gyp src/d8.gyp

# If vtunejit=on, the v8vtune.gyp will be appended.
ifeq ($(vtunejit), on)
  GYPFILES += src/third_party/vtune/v8vtune.gyp
endif
# Generates all combinations of ARCHES and MODES, e.g. "ia32.release".
BUILDS = $(foreach mode,$(MODES),$(addsuffix .$(mode),$(ARCHES)))
ANDROID_BUILDS = $(foreach mode,$(MODES), \
                   $(addsuffix .$(mode),$(ANDROID_ARCHES)))
NACL_BUILDS = $(foreach mode,$(MODES), \
                   $(addsuffix .$(mode),$(NACL_ARCHES)))
# Generates corresponding test targets, e.g. "ia32.release.check".
CHECKS = $(addsuffix .check,$(BUILDS))
QUICKCHECKS = $(addsuffix .quickcheck,$(BUILDS))
ANDROID_CHECKS = $(addsuffix .check,$(ANDROID_BUILDS))
NACL_CHECKS = $(addsuffix .check,$(NACL_BUILDS))
# File where previously used GYPFLAGS are stored.
ENVFILE = $(OUTDIR)/environment

.PHONY: all check clean builddeps dependencies $(ENVFILE).new native \
        qc quickcheck $(QUICKCHECKS) turbocheck \
        $(addsuffix .quickcheck,$(MODES)) $(addsuffix .quickcheck,$(ARCHES)) \
        $(ARCHES) $(MODES) $(BUILDS) $(CHECKS) $(addsuffix .clean,$(ARCHES)) \
        $(addsuffix .check,$(MODES)) $(addsuffix .check,$(ARCHES)) \
        $(ANDROID_ARCHES) $(ANDROID_BUILDS) $(ANDROID_CHECKS) \
        $(NACL_ARCHES) $(NACL_BUILDS) $(NACL_CHECKS) \
        must-set-NACL_SDK_ROOT

# Target definitions. "all" is the default.
all: $(DEFAULT_MODES)

# Special target for the buildbots to use. Depends on $(OUTDIR)/Makefile
# having been created before.
buildbot:
	$(MAKE) -C "$(OUTDIR)" BUILDTYPE=$(BUILDTYPE) \
	        builddir="$(abspath $(OUTDIR))/$(BUILDTYPE)"

# Compile targets. MODES and ARCHES are convenience targets.
.SECONDEXPANSION:
$(MODES): $(addsuffix .$$@,$(DEFAULT_ARCHES))

$(ARCHES): $(addprefix $$@.,$(DEFAULT_MODES))

# Defines how to build a particular target (e.g. ia32.release).
$(BUILDS): $(OUTDIR)/Makefile.$$@
	@$(MAKE) -C "$(OUTDIR)" -f Makefile.$@ \
	         BUILDTYPE=$(shell echo $(subst .,,$(suffix $@)) | \
	                     python -c "print \
	                     raw_input().replace('opt', '').capitalize()") \
	         builddir="$(shell pwd)/$(OUTDIR)/$@"

native: $(OUTDIR)/Makefile.native
	@$(MAKE) -C "$(OUTDIR)" -f Makefile.native \
	         BUILDTYPE=Release \
	         builddir="$(shell pwd)/$(OUTDIR)/$@"

$(ANDROID_ARCHES): $(addprefix $$@.,$(MODES))

$(ANDROID_BUILDS): $(GYPFILES) $(ENVFILE) Makefile.android
	@$(MAKE) -f Makefile.android $@ \
	        ARCH="$(basename $@)" \
	        MODE="$(subst .,,$(suffix $@))" \
	        OUTDIR="$(OUTDIR)" \
	        GYPFLAGS="$(GYPFLAGS)"

$(NACL_ARCHES): $(addprefix $$@.,$(MODES))

$(NACL_BUILDS): $(GYPFILES) $(ENVFILE) \
		   Makefile.nacl must-set-NACL_SDK_ROOT
	@$(MAKE) -f Makefile.nacl $@ \
	        ARCH="$(basename $@)" \
	        MODE="$(subst .,,$(suffix $@))" \
	        OUTDIR="$(OUTDIR)" \
	        GYPFLAGS="$(GYPFLAGS)"

# Test targets.
check: all
	@tools/run-tests.py $(TESTJOBS) --outdir=$(OUTDIR) \
	    --arch=$(shell echo $(DEFAULT_ARCHES) | sed -e 's/ /,/g') \
	    $(TESTFLAGS)

$(addsuffix .check,$(MODES)): $$(basename $$@)
	@tools/run-tests.py $(TESTJOBS) --outdir=$(OUTDIR) \
	    --mode=$(basename $@) $(TESTFLAGS)

$(addsuffix .check,$(ARCHES)): $$(basename $$@)
	@tools/run-tests.py $(TESTJOBS) --outdir=$(OUTDIR) \
	    --arch=$(basename $@) $(TESTFLAGS)

$(CHECKS): $$(basename $$@)
	@tools/run-tests.py $(TESTJOBS) --outdir=$(OUTDIR) \
	    --arch-and-mode=$(basename $@) $(TESTFLAGS)

$(addsuffix .quickcheck,$(MODES)): $$(basename $$@)
	@tools/run-tests.py $(TESTJOBS) --outdir=$(OUTDIR) \
	    --mode=$(basename $@) $(TESTFLAGS) --quickcheck

$(addsuffix .quickcheck,$(ARCHES)): $$(basename $$@)
	@tools/run-tests.py $(TESTJOBS) --outdir=$(OUTDIR) \
	    --arch=$(basename $@) $(TESTFLAGS) --quickcheck

$(QUICKCHECKS): $$(basename $$@)
	@tools/run-tests.py $(TESTJOBS) --outdir=$(OUTDIR) \
	    --arch-and-mode=$(basename $@) $(TESTFLAGS) --quickcheck

$(addsuffix .sync, $(ANDROID_BUILDS)): $$(basename $$@)
	@tools/android-sync.sh $(basename $@) $(OUTDIR) \
	                       $(shell pwd) $(ANDROID_V8)

$(addsuffix .check, $(ANDROID_BUILDS)): $$(basename $$@).sync
	@tools/run-tests.py $(TESTJOBS) --outdir=$(OUTDIR) \
	     --arch-and-mode=$(basename $@) \
	     --timeout=600 \
	     --command-prefix="tools/android-run.py" $(TESTFLAGS)

$(addsuffix .check, $(ANDROID_ARCHES)): \
                $(addprefix $$(basename $$@).,$(MODES)).check

$(addsuffix .check, $(NACL_BUILDS)): $$(basename $$@)
	@tools/run-tests.py $(TESTJOBS) --outdir=$(OUTDIR) \
	     --arch-and-mode=$(basename $@) \
	     --timeout=600 --nopresubmit --noi18n \
	     --command-prefix="tools/nacl-run.py"

$(addsuffix .check, $(NACL_ARCHES)): \
                $(addprefix $$(basename $$@).,$(MODES)).check

native.check: native
	@tools/run-tests.py $(TESTJOBS) --outdir=$(OUTDIR)/native \
	    --arch-and-mode=. $(TESTFLAGS)

SUPERFASTTESTMODES = ia32.release
FASTTESTMODES = $(SUPERFASTTESTMODES),x64.release,ia32.optdebug,x64.optdebug,arm.optdebug,arm64.release
FASTCOMPILEMODES = $(FASTTESTMODES),arm64.optdebug

COMMA = ,
EMPTY =
SPACE = $(EMPTY) $(EMPTY)
quickcheck: $(subst $(COMMA),$(SPACE),$(FASTCOMPILEMODES))
	tools/run-tests.py $(TESTJOBS) --outdir=$(OUTDIR) \
	    --arch-and-mode=$(SUPERFASTTESTMODES) $(TESTFLAGS) --quickcheck \
	    --download-data mozilla webkit
	tools/run-tests.py $(TESTJOBS) --outdir=$(OUTDIR) \
	    --arch-and-mode=$(FASTTESTMODES) $(TESTFLAGS) --quickcheck
qc: quickcheck

turbocheck: $(subst $(COMMA),$(SPACE),$(FASTCOMPILEMODES))
	tools/run-tests.py $(TESTJOBS) --outdir=$(OUTDIR) \
	    --arch-and-mode=$(SUPERFASTTESTMODES) $(TESTFLAGS) \
	    --quickcheck --variants=turbofan --download-data mozilla webkit
	tools/run-tests.py $(TESTJOBS) --outdir=$(OUTDIR) \
	    --arch-and-mode=$(FASTTESTMODES) $(TESTFLAGS) \
	    --quickcheck --variants=turbofan
tc: turbocheck

# Clean targets. You can clean each architecture individually, or everything.
$(addsuffix .clean, $(ARCHES) $(ANDROID_ARCHES) $(NACL_ARCHES)):
	rm -f $(OUTDIR)/Makefile.$(basename $@)*
	rm -rf $(OUTDIR)/$(basename $@).release
	rm -rf $(OUTDIR)/$(basename $@).debug
	rm -rf $(OUTDIR)/$(basename $@).optdebug
	find $(OUTDIR) -regex '.*\(host\|target\)\.$(basename $@).*\.mk' -delete

native.clean:
	rm -f $(OUTDIR)/Makefile.native
	rm -rf $(OUTDIR)/native
	find $(OUTDIR) -regex '.*\(host\|target\)\.native\.mk' -delete

clean: $(addsuffix .clean, $(ARCHES) $(ANDROID_ARCHES) $(NACL_ARCHES)) native.clean gtags.clean

# GYP file generation targets.
OUT_MAKEFILES = $(addprefix $(OUTDIR)/Makefile.,$(BUILDS))
$(OUT_MAKEFILES): $(GYPFILES) $(ENVFILE)
	$(eval CXX_TARGET_ARCH:=$(shell $(CXX) -v 2>&1 | grep ^Target: | \
	        cut -f 2 -d " " | cut -f 1 -d "-" ))
	$(eval CXX_TARGET_ARCH:=$(subst aarch64,arm64,$(CXX_TARGET_ARCH)))
	$(eval CXX_TARGET_ARCH:=$(subst x86_64,x64,$(CXX_TARGET_ARCH)))
	$(eval V8_TARGET_ARCH:=$(subst .,,$(suffix $(basename $@))))
	PYTHONPATH="$(shell pwd)/tools/generate_shim_headers:$(shell pwd)/build:$(PYTHONPATH):$(shell pwd)/build/gyp/pylib:$(PYTHONPATH)" \
	GYP_GENERATORS=make \
	build/gyp/gyp --generator-output="$(OUTDIR)" build/all.gyp \
	              -Ibuild/standalone.gypi --depth=. \
	              -Dv8_target_arch=$(V8_TARGET_ARCH) \
	              $(if $(findstring $(CXX_TARGET_ARCH),$(V8_TARGET_ARCH)), \
	              -Dtarget_arch=$(V8_TARGET_ARCH),) \
	              $(if $(findstring optdebug,$@),-Dv8_optimized_debug=1,) \
	              -S$(suffix $(basename $@))$(suffix $@) $(GYPFLAGS)

$(OUTDIR)/Makefile.native: $(GYPFILES) $(ENVFILE)
	PYTHONPATH="$(shell pwd)/tools/generate_shim_headers:$(shell pwd)/build:$(PYTHONPATH):$(shell pwd)/build/gyp/pylib:$(PYTHONPATH)" \
	GYP_GENERATORS=make \
	build/gyp/gyp --generator-output="$(OUTDIR)" build/all.gyp \
	              -Ibuild/standalone.gypi --depth=. -S.native $(GYPFLAGS)

# Note that NACL_SDK_ROOT must be set to point to an appropriate
# Native Client SDK before using this makefile. You can download
# an SDK here:
#   https://developers.google.com/native-client/sdk/download
# The path indicated by NACL_SDK_ROOT will typically end with
# a folder for a pepper version such as "pepper_25" that should
# have "tools" and "toolchain" subdirectories.
must-set-NACL_SDK_ROOT:
ifndef NACL_SDK_ROOT
	  $(error NACL_SDK_ROOT must be set)
endif

# Replaces the old with the new environment file if they're different, which
# will trigger GYP to regenerate Makefiles.
$(ENVFILE): $(ENVFILE).new
	@if test -r $(ENVFILE) && cmp $(ENVFILE).new $(ENVFILE) > /dev/null; \
	    then rm $(ENVFILE).new; \
	    else mv $(ENVFILE).new $(ENVFILE); fi

# Stores current GYPFLAGS in a file.
$(ENVFILE).new:
	$(eval CXX_TARGET_ARCH:=$(shell $(CXX) -v 2>&1 | grep ^Target: | \
	        cut -f 2 -d " " | cut -f 1 -d "-" ))
	$(eval CXX_TARGET_ARCH:=$(subst aarch64,arm64,$(CXX_TARGET_ARCH)))
	$(eval CXX_TARGET_ARCH:=$(subst x86_64,x64,$(CXX_TARGET_ARCH)))
	@mkdir -p $(OUTDIR); echo "GYPFLAGS=$(GYPFLAGS) -Dtarget_arch=$(CXX_TARGET_ARCH)" > $(ENVFILE).new;

# Heap constants for grokdump.
DUMP_FILE = tools/v8heapconst.py
grokdump: ia32.release
	@cat $(DUMP_FILE).tmpl > $(DUMP_FILE)
	@$(OUTDIR)/ia32.release/d8 --dump-heap-constants >> $(DUMP_FILE)

# Support for the GNU GLOBAL Source Code Tag System.
gtags.files: $(GYPFILES) $(ENVFILE)
	@find include src test -name '*.h' -o -name '*.cc' -o -name '*.c' > $@

# We need to manually set the stack limit here, to work around bugs in
# gmake-3.81 and global-5.7.1 on recent 64-bit Linux systems.
GPATH GRTAGS GSYMS GTAGS: gtags.files $(shell cat gtags.files 2> /dev/null)
	@bash -c 'ulimit -s 10240 && GTAGSFORCECPP=yes gtags -i -q -f $<'

gtags.clean:
	rm -f gtags.files GPATH GRTAGS GSYMS GTAGS

dependencies builddeps:
	$(error Use 'gclient sync' instead)
node-v4.8.2/deps/v8/Makefile.android000644 000766 000024 00000006376 13070706732 017340 0ustar00iojsstaff000000 000000 # Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

# Those definitions should be consistent with the main Makefile
ANDROID_ARCHES = android_ia32 android_x64 android_arm android_arm64 \
		 android_mipsel android_x87
MODES = release debug

# Generates all combinations of ANDROID ARCHES and MODES,
# e.g. "android_ia32.release" or "android_arm.release"
ANDROID_BUILDS = $(foreach mode,$(MODES), \
                   $(addsuffix .$(mode),$(ANDROID_ARCHES)))

ifeq ($(ARCH), android_arm)
  DEFINES  = target_arch=arm v8_target_arch=arm
else ifeq ($(ARCH), android_arm64)
  DEFINES  = target_arch=arm64 v8_target_arch=arm64
else ifeq ($(ARCH), android_mipsel)
  DEFINES  = target_arch=mipsel v8_target_arch=mipsel
else ifeq ($(ARCH), android_ia32)
  DEFINES = target_arch=ia32 v8_target_arch=ia32
else ifeq ($(ARCH), android_x64)
  DEFINES = target_arch=x64 v8_target_arch=x64
else ifeq ($(ARCH), android_x87)
  DEFINES = target_arch=ia32 v8_target_arch=x87
else
  $(error Target architecture "${ARCH}" is not supported)
endif

# Common flags.
DEFINES += OS=android

.SECONDEXPANSION:
$(ANDROID_BUILDS): $(OUTDIR)/Makefile.$$@
	@$(MAKE) -C "$(OUTDIR)" -f Makefile.$@ \
	          BUILDTYPE=$(shell echo $(subst .,,$(suffix $@)) | \
	                      python -c "print raw_input().capitalize()") \
	          builddir="$(shell pwd)/$(OUTDIR)/$@"

# Android GYP file generation targets.
ANDROID_MAKEFILES = $(addprefix $(OUTDIR)/Makefile.,$(ANDROID_BUILDS))
$(ANDROID_MAKEFILES):
	GYP_GENERATORS=make-android \
	GYP_DEFINES="${DEFINES}" \
	PYTHONPATH="$(shell pwd)/tools/generate_shim_headers:$(shell pwd)/build:$(PYTHONPATH)" \
	build/gyp/gyp --generator-output="${OUTDIR}" build/all.gyp \
	              -Ibuild/standalone.gypi --depth=. \
	              -S$(suffix $(basename $@))$(suffix $@) ${GYPFLAGS}
node-v4.8.2/deps/v8/Makefile.nacl000644 000766 000024 00000010237 13070706732 016624 0ustar00iojsstaff000000 000000 #
# Copyright 2013 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

# Those definitions should be consistent with the main Makefile
NACL_ARCHES = nacl_ia32 nacl_x64
MODES = release debug

# Generates all combinations of NACL ARCHES and MODES,
# e.g. "nacl_ia32.release" or "nacl_x64.release"
NACL_BUILDS = $(foreach mode,$(MODES), \
                   $(addsuffix .$(mode),$(NACL_ARCHES)))

HOST_OS = $(shell uname -s | sed -e 's/Linux/linux/;s/Darwin/mac/')
TOOLCHAIN_PATH = $(realpath ${NACL_SDK_ROOT}/toolchain)
NACL_TOOLCHAIN ?= ${TOOLCHAIN_PATH}/linux_pnacl

ifeq ($(wildcard $(NACL_TOOLCHAIN)),)
  $(error Cannot find Native Client toolchain in "${NACL_TOOLCHAIN}")
endif

ifeq ($(ARCH), nacl_ia32)
  GYPENV = nacl_target_arch=nacl_ia32 v8_target_arch=arm v8_host_arch=ia32
  NACL_CC = "$(NACL_TOOLCHAIN)/bin/pnacl-clang"
  NACL_CXX = "$(NACL_TOOLCHAIN)/bin/pnacl-clang++"
  NACL_LINK = "$(NACL_TOOLCHAIN)/bin/pnacl-clang++ --pnacl-allow-native -arch x86-32"
else
  ifeq ($(ARCH), nacl_x64)
    GYPENV = nacl_target_arch=nacl_x64 v8_target_arch=arm v8_host_arch=ia32
    NACL_CC = "$(NACL_TOOLCHAIN)/bin/pnacl-clang"
    NACL_CXX = "$(NACL_TOOLCHAIN)/bin/pnacl-clang++"
    NACL_LINK = "$(NACL_TOOLCHAIN)/bin/pnacl-clang++ --pnacl-allow-native -arch x86-64"
  else
    $(error Target architecture "${ARCH}" is not supported)
  endif
endif

# For mksnapshot host generation.
GYPENV += host_os=${HOST_OS}

# ICU doesn't support NaCl.
GYPENV += v8_enable_i18n_support=0

# Disable strict aliasing - v8 code often relies on undefined behavior of C++.
GYPENV += v8_no_strict_aliasing=1

NACL_MAKEFILES = $(addprefix $(OUTDIR)/Makefile.,$(NACL_BUILDS))
.SECONDEXPANSION:
# For some reason the $$(basename $$@) expansion didn't work here...
$(NACL_BUILDS): $(NACL_MAKEFILES)
	@$(MAKE) -C "$(OUTDIR)" -f Makefile.$@ \
	            CC=${NACL_CC} \
	            CXX=${NACL_CXX} \
	            AR="$(NACL_TOOLCHAIN)/bin/pnacl-ar" \
	            RANLIB="$(NACL_TOOLCHAIN)/bin/pnacl-ranlib" \
	            LD="$(NACL_TOOLCHAIN)/bin/pnacl-ld" \
	            LINK=${NACL_LINK} \
	            BUILDTYPE=$(shell echo $(subst .,,$(suffix $@)) | \
	                        python -c "print raw_input().capitalize()") \
	            builddir="$(shell pwd)/$(OUTDIR)/$@"

# NACL GYP file generation targets.
$(NACL_MAKEFILES):
	GYP_GENERATORS=make \
	GYP_DEFINES="${GYPENV}" \
	CC=${NACL_CC} \
	CXX=${NACL_CXX} \
	LINK=${NACL_LINK} \
	PYTHONPATH="$(shell pwd)/tools/generate_shim_headers:$(shell pwd)/build:$(PYTHONPATH)" \
	build/gyp/gyp --generator-output="${OUTDIR}" build/all.gyp \
	              -Ibuild/standalone.gypi --depth=. \
	              -S$(suffix $(basename $@))$(suffix $@) $(GYPFLAGS) \
                      -Dwno_array_bounds=-Wno-array-bounds
node-v4.8.2/deps/v8/OWNERS000644 000766 000024 00000000742 13070706732 015210 0ustar00iojsstaff000000 000000 adamk@chromium.org
arv@chromium.org
bmeurer@chromium.org
danno@chromium.org
dcarney@chromium.org
dslomov@chromium.org
hpayer@chromium.org
ishell@chromium.org
jarin@chromium.org
jkummerow@chromium.org
jochen@chromium.org
machenbach@chromium.org
marja@chromium.org
mstarzinger@chromium.org
mvstanton@chromium.org
rmcilroy@chromium.org
rossberg@chromium.org
svenpanne@chromium.org
titzer@chromium.org
ulan@chromium.org
verwaest@chromium.org
vogelheim@chromium.org
yangguo@chromium.org
node-v4.8.2/deps/v8/PRESUBMIT.py000644 000766 000024 00000024543 13070706732 016201 0ustar00iojsstaff000000 000000 # Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

"""Top-level presubmit script for V8.

See http://dev.chromium.org/developers/how-tos/depottools/presubmit-scripts
for more details about the presubmit API built into gcl.
"""

import sys


_EXCLUDED_PATHS = (
    r"^test[\\\/].*",
    r"^testing[\\\/].*",
    r"^third_party[\\\/].*",
    r"^tools[\\\/].*",
)


# Regular expression that matches code only used for test binaries
# (best effort).
_TEST_CODE_EXCLUDED_PATHS = (
    r'.+-unittest\.cc',
    # Has a method VisitForTest().
    r'src[\\\/]compiler[\\\/]ast-graph-builder\.cc',
    # Test extension.
    r'src[\\\/]extensions[\\\/]gc-extension\.cc',
)


_TEST_ONLY_WARNING = (
    'You might be calling functions intended only for testing from\n'
    'production code.  It is OK to ignore this warning if you know what\n'
    'you are doing, as the heuristics used to detect the situation are\n'
    'not perfect.  The commit queue will not block on this warning.')


def _V8PresubmitChecks(input_api, output_api):
  """Runs the V8 presubmit checks."""
  import sys
  sys.path.append(input_api.os_path.join(
        input_api.PresubmitLocalPath(), 'tools'))
  from presubmit import CppLintProcessor
  from presubmit import SourceProcessor
  from presubmit import CheckRuntimeVsNativesNameClashes
  from presubmit import CheckExternalReferenceRegistration
  from presubmit import CheckAuthorizedAuthor

  results = []
  if not CppLintProcessor().Run(input_api.PresubmitLocalPath()):
    results.append(output_api.PresubmitError("C++ lint check failed"))
  if not SourceProcessor().Run(input_api.PresubmitLocalPath()):
    results.append(output_api.PresubmitError(
        "Copyright header, trailing whitespaces and two empty lines " \
        "between declarations check failed"))
  if not CheckRuntimeVsNativesNameClashes(input_api.PresubmitLocalPath()):
    results.append(output_api.PresubmitError(
        "Runtime/natives name clash check failed"))
  if not CheckExternalReferenceRegistration(input_api.PresubmitLocalPath()):
    results.append(output_api.PresubmitError(
        "External references registration check failed"))
  results.extend(CheckAuthorizedAuthor(input_api, output_api))
  return results


def _CheckUnwantedDependencies(input_api, output_api):
  """Runs checkdeps on #include statements added in this
  change. Breaking - rules is an error, breaking ! rules is a
  warning.
  """
  # We need to wait until we have an input_api object and use this
  # roundabout construct to import checkdeps because this file is
  # eval-ed and thus doesn't have __file__.
  original_sys_path = sys.path
  try:
    sys.path = sys.path + [input_api.os_path.join(
        input_api.PresubmitLocalPath(), 'buildtools', 'checkdeps')]
    import checkdeps
    from cpp_checker import CppChecker
    from rules import Rule
  finally:
    # Restore sys.path to what it was before.
    sys.path = original_sys_path

  added_includes = []
  for f in input_api.AffectedFiles():
    if not CppChecker.IsCppFile(f.LocalPath()):
      continue

    changed_lines = [line for line_num, line in f.ChangedContents()]
    added_includes.append([f.LocalPath(), changed_lines])

  deps_checker = checkdeps.DepsChecker(input_api.PresubmitLocalPath())

  error_descriptions = []
  warning_descriptions = []
  for path, rule_type, rule_description in deps_checker.CheckAddedCppIncludes(
      added_includes):
    description_with_path = '%s\n    %s' % (path, rule_description)
    if rule_type == Rule.DISALLOW:
      error_descriptions.append(description_with_path)
    else:
      warning_descriptions.append(description_with_path)

  results = []
  if error_descriptions:
    results.append(output_api.PresubmitError(
        'You added one or more #includes that violate checkdeps rules.',
        error_descriptions))
  if warning_descriptions:
    results.append(output_api.PresubmitPromptOrNotify(
        'You added one or more #includes of files that are temporarily\n'
        'allowed but being removed. Can you avoid introducing the\n'
        '#include? See relevant DEPS file(s) for details and contacts.',
        warning_descriptions))
  return results


def _CheckNoProductionCodeUsingTestOnlyFunctions(input_api, output_api):
  """Attempts to prevent use of functions intended only for testing in
  non-testing code. For now this is just a best-effort implementation
  that ignores header files and may have some false positives. A
  better implementation would probably need a proper C++ parser.
  """
  # We only scan .cc files, as the declaration of for-testing functions in
  # header files are hard to distinguish from calls to such functions without a
  # proper C++ parser.
  file_inclusion_pattern = r'.+\.cc'

  base_function_pattern = r'[ :]test::[^\s]+|ForTest(ing)?|for_test(ing)?'
  inclusion_pattern = input_api.re.compile(r'(%s)\s*\(' % base_function_pattern)
  comment_pattern = input_api.re.compile(r'//.*(%s)' % base_function_pattern)
  exclusion_pattern = input_api.re.compile(
    r'::[A-Za-z0-9_]+(%s)|(%s)[^;]+\{' % (
      base_function_pattern, base_function_pattern))

  def FilterFile(affected_file):
    black_list = (_EXCLUDED_PATHS +
                  _TEST_CODE_EXCLUDED_PATHS +
                  input_api.DEFAULT_BLACK_LIST)
    return input_api.FilterSourceFile(
      affected_file,
      white_list=(file_inclusion_pattern, ),
      black_list=black_list)

  problems = []
  for f in input_api.AffectedSourceFiles(FilterFile):
    local_path = f.LocalPath()
    for line_number, line in f.ChangedContents():
      if (inclusion_pattern.search(line) and
          not comment_pattern.search(line) and
          not exclusion_pattern.search(line)):
        problems.append(
          '%s:%d\n    %s' % (local_path, line_number, line.strip()))

  if problems:
    return [output_api.PresubmitPromptOrNotify(_TEST_ONLY_WARNING, problems)]
  else:
    return []


def _CommonChecks(input_api, output_api):
  """Checks common to both upload and commit."""
  results = []
  results.extend(input_api.canned_checks.CheckOwners(
      input_api, output_api, source_file_filter=None))
  results.extend(input_api.canned_checks.CheckPatchFormatted(
      input_api, output_api))
  results.extend(_V8PresubmitChecks(input_api, output_api))
  results.extend(_CheckUnwantedDependencies(input_api, output_api))
  results.extend(
      _CheckNoProductionCodeUsingTestOnlyFunctions(input_api, output_api))
  return results


def _SkipTreeCheck(input_api, output_api):
  """Check the env var whether we want to skip tree check.
     Only skip if include/v8-version.h has been updated."""
  src_version = 'include/v8-version.h'
  FilterFile = lambda file: file.LocalPath() == src_version
  if not input_api.AffectedSourceFiles(
      lambda file: file.LocalPath() == src_version):
    return False
  return input_api.environ.get('PRESUBMIT_TREE_CHECK') == 'skip'


def _CheckChangeLogFlag(input_api, output_api):
  """Checks usage of LOG= flag in the commit message."""
  results = []
  if input_api.change.BUG and not 'LOG' in input_api.change.tags:
    results.append(output_api.PresubmitError(
        'An issue reference (BUG=) requires a change log flag (LOG=). '
        'Use LOG=Y for including this commit message in the change log. '
        'Use LOG=N or leave blank otherwise.'))
  return results


def CheckChangeOnUpload(input_api, output_api):
  results = []
  results.extend(_CommonChecks(input_api, output_api))
  results.extend(_CheckChangeLogFlag(input_api, output_api))
  return results


def CheckChangeOnCommit(input_api, output_api):
  results = []
  results.extend(_CommonChecks(input_api, output_api))
  results.extend(_CheckChangeLogFlag(input_api, output_api))
  results.extend(input_api.canned_checks.CheckChangeHasDescription(
      input_api, output_api))
  if not _SkipTreeCheck(input_api, output_api):
    results.extend(input_api.canned_checks.CheckTreeIsOpen(
        input_api, output_api,
        json_url='http://v8-status.appspot.com/current?format=json'))
  return results


def GetPreferredTryMasters(project, change):
  return {
    'tryserver.v8': {
      'v8_linux_rel': set(['defaulttests']),
      'v8_linux_dbg': set(['defaulttests']),
      'v8_linux_nodcheck_rel': set(['defaulttests']),
      'v8_linux_gcc_compile_rel': set(['defaulttests']),
      'v8_linux64_rel': set(['defaulttests']),
      'v8_linux64_asan_rel': set(['defaulttests']),
      'v8_linux64_avx2_rel': set(['defaulttests']),
      'v8_win_rel': set(['defaulttests']),
      'v8_win_compile_dbg': set(['defaulttests']),
      'v8_win_nosnap_shared_compile_rel': set(['defaulttests']),
      'v8_win64_rel': set(['defaulttests']),
      'v8_mac_rel': set(['defaulttests']),
      'v8_linux_arm_rel': set(['defaulttests']),
      'v8_linux_arm64_rel': set(['defaulttests']),
      'v8_linux_mipsel_compile_rel': set(['defaulttests']),
      'v8_linux_mips64el_compile_rel': set(['defaulttests']),
      'v8_android_arm_compile_rel': set(['defaulttests']),
      'v8_linux_chromium_gn_rel': set(['defaulttests']),
    },
  }
node-v4.8.2/deps/v8/README.md000644 000766 000024 00000001512 13070706732 015523 0ustar00iojsstaff000000 000000 V8 JavaScript Engine
=============

V8 is Google's open source JavaScript engine.

V8 implements ECMAScript as specified in ECMA-262.

V8 is written in C++ and is used in Google Chrome, the open source
browser from Google.

V8 can run standalone, or can be embedded into any C++ application.

V8 Project page: https://code.google.com/p/v8/


Getting the Code
=============

Checkout [depot tools](http://www.chromium.org/developers/how-tos/install-depot-tools), and run

        fetch v8

This will checkout V8 into the directory `v8` and fetch all of its dependencies.
To stay up to date, run

        git pull origin
        gclient sync

For fetching all branches, add the following into your remote
configuration in `.git/config`:

        fetch = +refs/branch-heads/*:refs/remotes/branch-heads/*
        fetch = +refs/tags/*:refs/tags/*
node-v4.8.2/deps/v8/src/000755 000766 000024 00000000000 13070706734 015036 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/v8/testing/000755 000766 000024 00000000000 13070706735 015725 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/v8/tools/000755 000766 000024 00000000000 13070706741 015405 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/v8/WATCHLISTS000644 000766 000024 00000004326 13070706732 015662 0ustar00iojsstaff000000 000000 # Copyright 2013 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

# Watchlist Rules
# Refer: http://dev.chromium.org/developers/contributing-code/watchlists

# IMPORTANT: The regular expression filepath is tested against each path using
# re.search, so it is not usually necessary to add .*.

{
  'WATCHLIST_DEFINITIONS': {
    'public_api': {
      'filepath': 'include/',
    },
    'snapshot': {
      'filepath': 'src/snapshot/',
    },
    'debugger': {
      'filepath': 'src/debug\.(cc|h)|src/.*-debugger\.js|src/runtime/runtime-debug\.cc',
    },
  },

  'WATCHLISTS': {
    'public_api': [
      'phajdan.jr@chromium.org',
    ],
    'snapshot': [
      'yangguo@chromium.org',
    ],
    'debugger': [
      'yangguo@chromium.org',
    ],
  },
}
node-v4.8.2/deps/v8/tools/android-build.sh000755 000766 000024 00000000000 13070706735 020452 0ustar00iojsstaff000000 000000 node-v4.8.2/deps/v8/tools/android-ll-prof.sh000755 000766 000024 00000005663 13070706735 020752 0ustar00iojsstaff000000 000000 #!/bin/bash
# Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

# Runs d8 with the given arguments on the device under 'perf' and
# processes the profiler trace and v8 logs using ll_prof.py.
# 
# Usage:
# > ./tools/android-ll-prof.sh (debug|release) "args to d8" "args to ll_prof.py"
#
# The script creates deploy directory deploy/data/local/tmp/v8, copies there
# the d8 binary either from out/android_arm.release or out/android_arm.debug,
# and then sync the deploy directory with /data/local/tmp/v8 on the device.
# You can put JS files in the deploy directory before running the script.
# Note: $ANDROID_NDK_ROOT must be set.

MODE=$1
RUN_ARGS=$2
LL_PROF_ARGS=$3

BASE=`cd $(dirname "$0")/..; pwd`
DEPLOY="$BASE/deploy"

set +e
mkdir -p "$DEPLOY/data/local/tmp/v8"

cp "$BASE/out/android_arm.$MODE/d8" "$DEPLOY/data/local/tmp/v8/d8"

adb -p "$DEPLOY" sync data

adb shell "cd /data/local/tmp/v8;\
           perf record -R -e cycles -c 10000 -f -i \
           ./d8 --ll_prof --gc-fake-mmap=/data/local/tmp/__v8_gc__ $RUN_ARGS"

adb pull /data/local/tmp/v8/v8.log .
adb pull /data/local/tmp/v8/v8.log.ll .
adb pull /data/perf.data .

ARCH=arm-linux-androideabi-4.6
TOOLCHAIN="${ANDROID_NDK_ROOT}/toolchains/$ARCH/prebuilt/linux-x86/bin"

$BASE/tools/ll_prof.py --host-root="$BASE/deploy" \
                       --gc-fake-mmap=/data/local/tmp/__v8_gc__ \
                       --objdump="$TOOLCHAIN/arm-linux-androideabi-objdump" \
                       $LL_PROF_ARGS
node-v4.8.2/deps/v8/tools/android-run.py000755 000766 000024 00000010073 13070706735 020210 0ustar00iojsstaff000000 000000 #!/usr/bin/env python
#
# Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

# This script executes the passed command line on Android device
# using 'adb shell' command. Unfortunately, 'adb shell' always
# returns exit code 0, ignoring the exit code of executed command.
# Since we need to return non-zero exit code if the command failed,
# we augment the passed command line with exit code checking statement
# and output special error string in case of non-zero exit code.
# Then we parse the output of 'adb shell' and look for that error string.

import os
from os.path import join, dirname, abspath
import subprocess
import sys
import tempfile

def Check(output, errors):
  failed = any([s.startswith('/system/bin/sh:') or s.startswith('ANDROID')
                for s in output.split('\n')])
  return 1 if failed else 0

def Execute(cmdline):
  (fd_out, outname) = tempfile.mkstemp()
  (fd_err, errname) = tempfile.mkstemp()
  process = subprocess.Popen(
    args=cmdline,
    shell=True,
    stdout=fd_out,
    stderr=fd_err,
  )
  exit_code = process.wait()
  os.close(fd_out)
  os.close(fd_err)
  output = file(outname).read()
  errors = file(errname).read()
  os.unlink(outname)
  os.unlink(errname)
  sys.stdout.write(output)
  sys.stderr.write(errors)
  return exit_code or Check(output, errors)

def Escape(arg):
  def ShouldEscape():
    for x in arg:
      if not x.isalnum() and x != '-' and x != '_':
        return True
    return False

  return arg if not ShouldEscape() else '"%s"' % (arg.replace('"', '\\"'))

def WriteToTemporaryFile(data):
  (fd, fname) = tempfile.mkstemp()
  os.close(fd)
  tmp_file = open(fname, "w")
  tmp_file.write(data)
  tmp_file.close()
  return fname

def Main():
  if (len(sys.argv) == 1):
    print("Usage: %s " % sys.argv[0])
    return 1
  workspace = abspath(join(dirname(sys.argv[0]), '..'))
  android_workspace = os.getenv("ANDROID_V8", "/data/local/tmp/v8")
  args = [Escape(arg) for arg in sys.argv[1:]]
  script = (" ".join(args) + "\n"
            "case $? in\n"
            "  0) ;;\n"
            "  *) echo \"ANDROID: Error returned by test\";;\n"
            "esac\n")
  script = script.replace(workspace, android_workspace)
  script_file = WriteToTemporaryFile(script)
  android_script_file = android_workspace + "/" + script_file
  command =  ("adb push '%s' %s;" % (script_file, android_script_file) +
              "adb shell 'sh %s';" % android_script_file +
              "adb shell 'rm %s'" % android_script_file)
  error_code = Execute(command)
  os.unlink(script_file)
  return error_code

if __name__ == '__main__':
  sys.exit(Main())
node-v4.8.2/deps/v8/tools/android-sync.sh000755 000766 000024 00000006706 13070706735 020352 0ustar00iojsstaff000000 000000 #!/bin/bash
# Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

# This script pushes android binaries and test data to the device.
# The first argument can be either "android.release" or "android.debug".
# The second argument is a relative path to the output directory with binaries.
# The third argument is the absolute path to the V8 directory on the host.
# The fourth argument is the absolute path to the V8 directory on the device.

if [ ${#@} -lt 4 ] ; then
  echo "$0: Error: need 4 arguments"
  exit 1
fi

ARCH_MODE=$1
OUTDIR=$2
HOST_V8=$3
ANDROID_V8=$4

function LINUX_MD5 {
  local HASH=$(md5sum $1)
  echo ${HASH%% *}
}

function DARWIN_MD5 {
  local HASH=$(md5 $1)
  echo ${HASH} | cut -f2 -d "=" | cut -f2 -d " "
}

host_os=$(uname -s)
case "${host_os}" in
  "Linux")
    MD5=LINUX_MD5
    ;;
  "Darwin")
    MD5=DARWIN_MD5
    ;;
  *)
    echo "$0: Host platform ${host_os} is not supported" >& 2
    exit 1
esac

function sync_file {
  local FILE=$1
  local ANDROID_HASH=$(adb shell "md5 \"$ANDROID_V8/$FILE\"")
  local HOST_HASH=$($MD5 "$HOST_V8/$FILE")
  if [ "${ANDROID_HASH%% *}" != "${HOST_HASH}" ]; then
    adb push "$HOST_V8/$FILE" "$ANDROID_V8/$FILE" &> /dev/null
  fi
  echo -n "."
}

function sync_dir {
  local DIR=$1
  echo -n "sync to $ANDROID_V8/$DIR"
  for FILE in $(find "$HOST_V8/$DIR" -not -path "*.svn*" -type f); do
    local RELATIVE_FILE=${FILE:${#HOST_V8}}
    sync_file "$RELATIVE_FILE"
  done
  echo ""
}

echo -n "sync to $ANDROID_V8/$OUTDIR/$ARCH_MODE"
sync_file "$OUTDIR/$ARCH_MODE/cctest"
sync_file "$OUTDIR/$ARCH_MODE/d8"
sync_file "$OUTDIR/$ARCH_MODE/unittests"
echo ""
echo -n "sync to $ANDROID_V8/tools"
sync_file tools/consarray.js
sync_file tools/codemap.js
sync_file tools/csvparser.js
sync_file tools/profile.js
sync_file tools/splaytree.js
sync_file tools/profile_view.js
sync_file tools/logreader.js
sync_file tools/tickprocessor.js
echo ""
sync_dir tools/profviz
sync_dir test/intl
sync_dir test/message
sync_dir test/mjsunit
sync_dir test/preparser
node-v4.8.2/deps/v8/tools/bash-completion.sh000755 000766 000024 00000004536 13070706735 021043 0ustar00iojsstaff000000 000000 #!/bin/bash
# Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

# Inspired by and based on:
# http://src.chromium.org/viewvc/chrome/trunk/src/tools/bash-completion

# Flag completion rule for bash.
# To load in your shell, "source path/to/this/file".

v8_source=$(readlink -f $(dirname $BASH_SOURCE)/..)

_v8_flag() {
  local cur defines targets
  cur="${COMP_WORDS[COMP_CWORD]}"
  defines=$(cat $v8_source/src/flag-definitions.h \
    | grep "^DEFINE" \
    | grep -v "DEFINE_implication" \
    | sed -e 's/_/-/g')
  targets=$(echo "$defines" \
    | sed -ne 's/^DEFINE-[^(]*(\([^,]*\).*/--\1/p'; \
    echo "$defines" \
    | sed -ne 's/^DEFINE-bool(\([^,]*\).*/--no\1/p'; \
    cat $v8_source/src/d8.cc \
    | grep "strcmp(argv\[i\]" \
    | sed -ne 's/^[^"]*"--\([^"]*\)".*/--\1/p')
  COMPREPLY=($(compgen -W "$targets" -- "$cur"))
  return 0
}

complete -F _v8_flag -f d8
node-v4.8.2/deps/v8/tools/blink_tests/000755 000766 000024 00000000000 13070706735 017731 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/v8/tools/check-name-clashes.py000755 000766 000024 00000005532 13070706735 021405 0ustar00iojsstaff000000 000000 #!/usr/bin/env python
# Copyright 2014 the V8 project authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

import js2c
import os
import re
import sys

FILENAME = "src/runtime/runtime.h"
LISTHEAD = re.compile(r"#define\s+(FOR_EACH_\w+)\((\w+)\)")
LISTBODY = re.compile(r".*\\$")


class Function(object):
  def __init__(self, match):
    self.name = match.group(1).strip()

def ListMacroRe(list):
  macro = LISTHEAD.match(list[0]).group(2)
  re_string = "\s*%s\((\w+)" % macro
  return re.compile(re_string)


def FindLists(filename):
  lists = []
  current_list = []
  mode = "SEARCHING"
  with open(filename, "r") as f:
    for line in f:
      if mode == "SEARCHING":
        match = LISTHEAD.match(line)
        if match:
          mode = "APPENDING"
          current_list.append(line)
      else:
        current_list.append(line)
        match = LISTBODY.match(line)
        if not match:
          mode = "SEARCHING"
          lists.append(current_list)
          current_list = []
  return lists


# Detects runtime functions by parsing FILENAME.
def FindRuntimeFunctions():
  functions = []
  lists = FindLists(FILENAME)
  for list in lists:
    function_re = ListMacroRe(list)
    for line in list:
      match = function_re.match(line)
      if match:
        functions.append(Function(match))
  return functions


class Builtin(object):
  def __init__(self, match):
    self.name = match.group(1)


def FindJSNatives():
  PATH = "src"
  fileslist = []
  for (root, dirs, files) in os.walk(PATH):
    for f in files:
      if f.endswith(".js"):
        fileslist.append(os.path.join(root, f))
  natives = []
  regexp = re.compile("^function (\w+)\s*\((.*?)\) {")
  matches = 0
  for filename in fileslist:
    with open(filename, "r") as f:
      file_contents = f.read()
    file_contents = js2c.ExpandInlineMacros(file_contents)
    lines = file_contents.split("\n")
    partial_line = ""
    for line in lines:
      if line.startswith("function") and not '{' in line:
        partial_line += line.rstrip()
        continue
      if partial_line:
        partial_line += " " + line.strip()
        if '{' in line:
          line = partial_line
          partial_line = ""
        else:
          continue
      match = regexp.match(line)
      if match:
        natives.append(Builtin(match))
  return natives


def Main():
  functions = FindRuntimeFunctions()
  natives = FindJSNatives()
  errors = 0
  runtime_map = {}
  for f in functions:
    runtime_map[f.name] = 1
  for b in natives:
    if b.name in runtime_map:
      print("JS_Native/Runtime_Function name clash: %s" % b.name)
      errors += 1

  if errors > 0:
    return 1
  print("Runtime/Natives name clashes: checked %d/%d functions, all good." %
        (len(functions), len(natives)))
  return 0


if __name__ == "__main__":
  sys.exit(Main())
node-v4.8.2/deps/v8/tools/check-static-initializers.sh000755 000766 000024 00000004551 13070706735 023022 0ustar00iojsstaff000000 000000 #!/bin/bash
# Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

# Checks that the number of compilation units having at least one static
# initializer in d8 matches the one defined below.

# Allow:
#  - _GLOBAL__I__ZN2v810LineEditor6first_E
#  - _GLOBAL__I__ZN2v88internal32AtomicOps_Internalx86CPUFeaturesE
expected_static_init_count=2

v8_root=$(readlink -f $(dirname $BASH_SOURCE)/../)

if [ -n "$1" ] ; then
  d8="${v8_root}/$1"
else
  d8="${v8_root}/d8"
fi

if [ ! -f "$d8" ]; then
  echo "d8 binary not found: $d8"
  exit 1
fi

static_inits=$(nm "$d8" | grep _GLOBAL_ | grep _I_ | awk '{ print $NF; }')

static_init_count=$(echo "$static_inits" | wc -l)

if [ $static_init_count -gt $expected_static_init_count ]; then
  echo "Too many static initializers."
  echo "$static_inits"
  exit 1
else
  echo "Static initializer check passed ($static_init_count initializers)."
  exit 0
fi
node-v4.8.2/deps/v8/tools/codemap.js000644 000766 000024 00000017463 13070706735 017371 0ustar00iojsstaff000000 000000 // Copyright 2009 the V8 project authors. All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
//       copyright notice, this list of conditions and the following
//       disclaimer in the documentation and/or other materials provided
//       with the distribution.
//     * Neither the name of Google Inc. nor the names of its
//       contributors may be used to endorse or promote products derived
//       from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


/**
 * Constructs a mapper that maps addresses into code entries.
 *
 * @constructor
 */
function CodeMap() {
  /**
   * Dynamic code entries. Used for JIT compiled code.
   */
  this.dynamics_ = new SplayTree();

  /**
   * Name generator for entries having duplicate names.
   */
  this.dynamicsNameGen_ = new CodeMap.NameGenerator();

  /**
   * Static code entries. Used for statically compiled code.
   */
  this.statics_ = new SplayTree();

  /**
   * Libraries entries. Used for the whole static code libraries.
   */
  this.libraries_ = new SplayTree();

  /**
   * Map of memory pages occupied with static code.
   */
  this.pages_ = [];
};


/**
 * The number of alignment bits in a page address.
 */
CodeMap.PAGE_ALIGNMENT = 12;


/**
 * Page size in bytes.
 */
CodeMap.PAGE_SIZE =
    1 << CodeMap.PAGE_ALIGNMENT;


/**
 * Adds a dynamic (i.e. moveable and discardable) code entry.
 *
 * @param {number} start The starting address.
 * @param {CodeMap.CodeEntry} codeEntry Code entry object.
 */
CodeMap.prototype.addCode = function(start, codeEntry) {
  this.deleteAllCoveredNodes_(this.dynamics_, start, start + codeEntry.size);
  this.dynamics_.insert(start, codeEntry);
};


/**
 * Moves a dynamic code entry. Throws an exception if there is no dynamic
 * code entry with the specified starting address.
 *
 * @param {number} from The starting address of the entry being moved.
 * @param {number} to The destination address.
 */
CodeMap.prototype.moveCode = function(from, to) {
  var removedNode = this.dynamics_.remove(from);
  this.deleteAllCoveredNodes_(this.dynamics_, to, to + removedNode.value.size);
  this.dynamics_.insert(to, removedNode.value);
};


/**
 * Discards a dynamic code entry. Throws an exception if there is no dynamic
 * code entry with the specified starting address.
 *
 * @param {number} start The starting address of the entry being deleted.
 */
CodeMap.prototype.deleteCode = function(start) {
  var removedNode = this.dynamics_.remove(start);
};


/**
 * Adds a library entry.
 *
 * @param {number} start The starting address.
 * @param {CodeMap.CodeEntry} codeEntry Code entry object.
 */
CodeMap.prototype.addLibrary = function(
    start, codeEntry) {
  this.markPages_(start, start + codeEntry.size);
  this.libraries_.insert(start, codeEntry);
};


/**
 * Adds a static code entry.
 *
 * @param {number} start The starting address.
 * @param {CodeMap.CodeEntry} codeEntry Code entry object.
 */
CodeMap.prototype.addStaticCode = function(
    start, codeEntry) {
  this.statics_.insert(start, codeEntry);
};


/**
 * @private
 */
CodeMap.prototype.markPages_ = function(start, end) {
  for (var addr = start; addr <= end;
       addr += CodeMap.PAGE_SIZE) {
    this.pages_[addr >>> CodeMap.PAGE_ALIGNMENT] = 1;
  }
};


/**
 * @private
 */
CodeMap.prototype.deleteAllCoveredNodes_ = function(tree, start, end) {
  var to_delete = [];
  var addr = end - 1;
  while (addr >= start) {
    var node = tree.findGreatestLessThan(addr);
    if (!node) break;
    var start2 = node.key, end2 = start2 + node.value.size;
    if (start2 < end && start < end2) to_delete.push(start2);
    addr = start2 - 1;
  }
  for (var i = 0, l = to_delete.length; i < l; ++i) tree.remove(to_delete[i]);
};


/**
 * @private
 */
CodeMap.prototype.isAddressBelongsTo_ = function(addr, node) {
  return addr >= node.key && addr < (node.key + node.value.size);
};


/**
 * @private
 */
CodeMap.prototype.findInTree_ = function(tree, addr) {
  var node = tree.findGreatestLessThan(addr);
  return node && this.isAddressBelongsTo_(addr, node) ? node.value : null;
};


/**
 * Finds a code entry that contains the specified address. Both static and
 * dynamic code entries are considered.
 *
 * @param {number} addr Address.
 */
CodeMap.prototype.findEntry = function(addr) {
  var pageAddr = addr >>> CodeMap.PAGE_ALIGNMENT;
  if (pageAddr in this.pages_) {
    // Static code entries can contain "holes" of unnamed code.
    // In this case, the whole library is assigned to this address.
    return this.findInTree_(this.statics_, addr) ||
        this.findInTree_(this.libraries_, addr);
  }
  var min = this.dynamics_.findMin();
  var max = this.dynamics_.findMax();
  if (max != null && addr < (max.key + max.value.size) && addr >= min.key) {
    var dynaEntry = this.findInTree_(this.dynamics_, addr);
    if (dynaEntry == null) return null;
    // Dedupe entry name.
    if (!dynaEntry.nameUpdated_) {
      dynaEntry.name = this.dynamicsNameGen_.getName(dynaEntry.name);
      dynaEntry.nameUpdated_ = true;
    }
    return dynaEntry;
  }
  return null;
};


/**
 * Returns a dynamic code entry using its starting address.
 *
 * @param {number} addr Address.
 */
CodeMap.prototype.findDynamicEntryByStartAddress =
    function(addr) {
  var node = this.dynamics_.find(addr);
  return node ? node.value : null;
};


/**
 * Returns an array of all dynamic code entries.
 */
CodeMap.prototype.getAllDynamicEntries = function() {
  return this.dynamics_.exportValues();
};


/**
 * Returns an array of pairs of all dynamic code entries and their addresses.
 */
CodeMap.prototype.getAllDynamicEntriesWithAddresses = function() {
  return this.dynamics_.exportKeysAndValues();
};


/**
 * Returns an array of all static code entries.
 */
CodeMap.prototype.getAllStaticEntries = function() {
  return this.statics_.exportValues();
};


/**
 * Returns an array of all libraries entries.
 */
CodeMap.prototype.getAllLibrariesEntries = function() {
  return this.libraries_.exportValues();
};


/**
 * Creates a code entry object.
 *
 * @param {number} size Code entry size in bytes.
 * @param {string} opt_name Code entry name.
 * @param {string} opt_type Code entry type, e.g. SHARED_LIB, CPP.
 * @constructor
 */
CodeMap.CodeEntry = function(size, opt_name, opt_type) {
  this.size = size;
  this.name = opt_name || '';
  this.type = opt_type || '';
  this.nameUpdated_ = false;
};


CodeMap.CodeEntry.prototype.getName = function() {
  return this.name;
};


CodeMap.CodeEntry.prototype.toString = function() {
  return this.name + ': ' + this.size.toString(16);
};


CodeMap.NameGenerator = function() {
  this.knownNames_ = {};
};


CodeMap.NameGenerator.prototype.getName = function(name) {
  if (!(name in this.knownNames_)) {
    this.knownNames_[name] = 0;
    return name;
  }
  var count = ++this.knownNames_[name];
  return name + ' {' + count + '}';
};
node-v4.8.2/deps/v8/tools/compare-table-gen.js000644 000766 000024 00000007053 13070706735 021235 0ustar00iojsstaff000000 000000 // Copyright 2015 the V8 project authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

// Generates a comparison table test case.
// Usage: d8 compare-table-gen.js -- lt|lteq|gt|gteq|eq|ne|eq|sne|min|max

var strings = ["true", "false", "null", "void 0", "0", "0.0", "-0", "\"\"", "-1", "-1.25", "1", "1.25", "-2147483648", "2147483648", "Infinity", "-Infinity", "NaN"];
var values = new Array(strings.length);
for (var i = 0; i < strings.length; i++) {
  values[i] = eval(strings[i]);
}

function test() {
  for (var i = 0; i < values.length; i++) {
    for (var j = 0; j < values.length; j++) {
      var a = values[i];
      var b = values[j];
      var x = expected[i][j];
      assertEquals(x, func(a,b));
      assertEquals(x, left_funcs[i](b));
      assertEquals(x, right_funcs[j](a));
    }
  }

  var result = matrix();
  for (var i = 0; i < values.length; i++) {
    for (var j = 0; j < values.length; j++) {
      assertEquals(expected[i][j], result[i][j]);
    }
  }
}

function expr(infix, a, cmp, b) {
  return infix ? a + " " + cmp + " " + b : cmp + "(" + a + ", " + b + ")";
}

function SpecialToString(x) {
  if ((1 / x) == -Infinity) return "-0";
  return "" + x;
}

function gen(name, cmp, infix) {

  print("// Copyright 2015 the V8 project authors. All rights reserved.");
  print("// Use of this source code is governed by a BSD-style license that can be");
  print("// found in the LICENSE file.");
  print();
  print("var values = [" + strings + "];");

  var body = "(function " + name + "(a,b) { return " + expr(infix, "a", cmp, "b") + "; })";
  var func = eval(body);

  print("var expected = [");

  for (var i = 0; i < values.length; i++) {
    var line = "  [";
    for (var j = 0; j < values.length; j++) {
      if (j > 0) line += ",";
      line += SpecialToString(func(values[i], values[j]));
    }
    line += "]";
    if (i < (values.length - 1)) line += ",";
    print(line);
  }
  print("];");

  print("var func = " + body + ";");
  print("var left_funcs = [");

  for (var i = 0; i < values.length; i++) {
    var value = strings[i];
    var body = "(function " + name + "_L" + i + "(b) { return " + expr(infix, value, cmp, "b") + "; })";
    var end = i < (values.length - 1) ? "," : "";
    print("  " + body + end);
  }
  print("];");

  print("var right_funcs = [");
  for (var i = 0; i < values.length; i++) {
    var value = strings[i];
    var body = "(function " + name + "_R" + i + "(a) { return " + expr(infix, "a", cmp, value) + "; })";
    var end = i < (values.length - 1) ? "," : "";
    print("  " + body + end);
  }
  print("];");

  print("function matrix() {");
  print("  return [");
  for (var i = 0; i < values.length; i++) {
    var line = "    [";
    for (var j = 0; j < values.length; j++) {
      if (j > 0) line += ",";
      line += expr(infix, strings[i], cmp, strings[j]);
    }
    line += "]";
    if (i < (values.length - 1)) line += ",";
    print(line);
  }
  print("  ];");
  print("}");


  print(test.toString());
  print("test();");
  print("test();");
}

switch (arguments[0]) {
  case "lt":   gen("lt",   "<", true); break;
  case "lteq": gen("lteq", "<=", true); break;
  case "gt":   gen("gt",   ">", true); break;
  case "gteq": gen("gteq", ">=", true); break;
  case "eq":   gen("eq",   "==", true); break;
  case "ne":   gen("ne",   "!=", true); break;
  case "seq":  gen("seq",  "===", true); break;
  case "sne":  gen("sne",  "!==", true); break;
  case "min":  gen("min",  "Math.min", false); break;
  case "max":  gen("max",  "Math.max", false); break;
}
node-v4.8.2/deps/v8/tools/concatenate-files.py000644 000766 000024 00000005516 13070706735 021355 0ustar00iojsstaff000000 000000 #!/usr/bin/env python
#
# Copyright 2014 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

# This utility concatenates several files into one. On Unix-like systems
# it is equivalent to:
#   cat file1 file2 file3 ...files... > target
#
# The reason for writing a seperate utility is that 'cat' is not available
# on all supported build platforms, but Python is, and hence this provides
# us with an easy and uniform way of doing this on all platforms.

import optparse


def Concatenate(filenames):
  """Concatenate files.

  Args:
    files: Array of file names.
           The last name is the target; all earlier ones are sources.

  Returns:
    True, if the operation was successful.
  """
  if len(filenames) < 2:
    print "An error occured generating %s:\nNothing to do." % filenames[-1]
    return False

  try:
    with open(filenames[-1], "wb") as target:
      for filename in filenames[:-1]:
        with open(filename, "rb") as current:
          target.write(current.read())
    return True
  except IOError as e:
    print "An error occured when writing %s:\n%s" % (filenames[-1], e)
    return False


def main():
  parser = optparse.OptionParser()
  parser.set_usage("""Concatenate several files into one.
      Equivalent to: cat file1 ... > target.""")
  (options, args) = parser.parse_args()
  exit(0 if Concatenate(args) else 1)


if __name__ == "__main__":
  main()
node-v4.8.2/deps/v8/tools/consarray.js000644 000766 000024 00000006227 13070706735 017756 0ustar00iojsstaff000000 000000 // Copyright 2009 the V8 project authors. All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
//       copyright notice, this list of conditions and the following
//       disclaimer in the documentation and/or other materials provided
//       with the distribution.
//     * Neither the name of Google Inc. nor the names of its
//       contributors may be used to endorse or promote products derived
//       from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


/**
 * Constructs a ConsArray object. It is used mainly for tree traversal.
 * In this use case we have lots of arrays that we need to iterate
 * sequentally. The internal Array implementation is horribly slow
 * when concatenating on large (10K items) arrays due to memory copying.
 * That's why we avoid copying memory and insead build a linked list
 * of arrays to iterate through.
 *
 * @constructor
 */
function ConsArray() {
  this.tail_ = new ConsArray.Cell(null, null);
  this.currCell_ = this.tail_;
  this.currCellPos_ = 0;
};


/**
 * Concatenates another array for iterating. Empty arrays are ignored.
 * This operation can be safely performed during ongoing ConsArray
 * iteration.
 *
 * @param {Array} arr Array to concatenate.
 */
ConsArray.prototype.concat = function(arr) {
  if (arr.length > 0) {
    this.tail_.data = arr;
    this.tail_ = this.tail_.next = new ConsArray.Cell(null, null);
  }
};


/**
 * Whether the end of iteration is reached.
 */
ConsArray.prototype.atEnd = function() {
  return this.currCell_ === null ||
      this.currCell_.data === null ||
      this.currCellPos_ >= this.currCell_.data.length;
};


/**
 * Returns the current item, moves to the next one.
 */
ConsArray.prototype.next = function() {
  var result = this.currCell_.data[this.currCellPos_++];
  if (this.currCellPos_ >= this.currCell_.data.length) {
    this.currCell_ = this.currCell_.next;
    this.currCellPos_ = 0;
  }
  return result;
};


/**
 * A cell object used for constructing a list in ConsArray.
 *
 * @constructor
 */
ConsArray.Cell = function(data, next) {
  this.data = data;
  this.next = next;
};
node-v4.8.2/deps/v8/tools/cpu.sh000755 000766 000024 00000002325 13070706735 016540 0ustar00iojsstaff000000 000000 #!/bin/bash
# Copyright 2014 the V8 project authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

CPUPATH=/sys/devices/system/cpu

MAXID=$(cat $CPUPATH/present | awk -F- '{print $NF}')

set_governor() {
  echo "Setting CPU frequency governor to \"$1\""
  for (( i=0; i<=$MAXID; i++ )); do
    echo "$1" > $CPUPATH/cpu$i/cpufreq/scaling_governor
  done
}

dual_core() {
  echo "Switching to dual-core mode"
  for (( i=2; i<=$MAXID; i++ )); do
    echo 0 > $CPUPATH/cpu$i/online
  done
}

single_core() {
  echo "Switching to single-core mode"
  for (( i=1; i<=$MAXID; i++ )); do
    echo 0 > $CPUPATH/cpu$i/online
  done
}


all_cores() {
  echo "Reactivating all CPU cores"
  for (( i=1; i<=$MAXID; i++ )); do
    echo 1 > $CPUPATH/cpu$i/online
  done
}

case "$1" in
  fast | performance)
    set_governor "performance"
    ;;
  slow | powersave)
    set_governor "powersave"
    ;;
  default | ondemand)
    set_governor "ondemand"
    ;;
  dualcore | dual)
    dual_core
    ;;
  singlecore | single)
    single_core
    ;;
  allcores | all)
    all_cores
    ;;
  *)
    echo "Usage: $0 fast|slow|default|singlecore|dualcore|all"
    exit 1
    ;;
esac 
node-v4.8.2/deps/v8/tools/cross_build_gcc.sh000755 000766 000024 00000004576 13070706735 021107 0ustar00iojsstaff000000 000000 #!/bin/sh
#
# Copyright 2013 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

if [ "$#" -lt 1 ]; then
  echo "Usage: tools/cross_build_gcc.sh  [make arguments ...]"
  exit 1
fi

export CXX=$1g++
export AR=$1ar
export RANLIB=$1ranlib
export CC=$1gcc
export LD=$1g++
export LINK=$1g++

OK=1
if [ ! -x "$CXX" ]; then
  echo "Error: $CXX does not exist or is not executable."
  OK=0
fi
if [ ! -x "$AR" ]; then
  echo "Error: $AR does not exist or is not executable."
  OK=0
fi
if [ ! -x "$RANLIB" ]; then
  echo "Error: $RANLIB does not exist or is not executable."
  OK=0
fi
if [ ! -x "$CC" ]; then
  echo "Error: $CC does not exist or is not executable."
  OK=0
fi
if [ ! -x "$LD" ]; then
  echo "Error: $LD does not exist or is not executable."
  OK=0
fi
if [ ! -x "$LINK" ]; then
  echo "Error: $LINK does not exist or is not executable."
  OK=0
fi
if [ $OK -ne 1 ]; then
  exit 1
fi

shift
make snapshot=off $@
node-v4.8.2/deps/v8/tools/csvparser.js000644 000766 000024 00000005347 13070706735 017767 0ustar00iojsstaff000000 000000 // Copyright 2009 the V8 project authors. All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
//       copyright notice, this list of conditions and the following
//       disclaimer in the documentation and/or other materials provided
//       with the distribution.
//     * Neither the name of Google Inc. nor the names of its
//       contributors may be used to endorse or promote products derived
//       from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


/**
 * Creates a CSV lines parser.
 */
function CsvParser() {
};


/**
 * A regex for matching a CSV field.
 * @private
 */
CsvParser.CSV_FIELD_RE_ = /^"((?:[^"]|"")*)"|([^,]*)/;


/**
 * A regex for matching a double quote.
 * @private
 */
CsvParser.DOUBLE_QUOTE_RE_ = /""/g;


/**
 * Parses a line of CSV-encoded values. Returns an array of fields.
 *
 * @param {string} line Input line.
 */
CsvParser.prototype.parseLine = function(line) {
  var fieldRe = CsvParser.CSV_FIELD_RE_;
  var doubleQuoteRe = CsvParser.DOUBLE_QUOTE_RE_;
  var pos = 0;
  var endPos = line.length;
  var fields = [];
  if (endPos > 0) {
    do {
      var fieldMatch = fieldRe.exec(line.substr(pos));
      if (typeof fieldMatch[1] === "string") {
        var field = fieldMatch[1];
        pos += field.length + 3;  // Skip comma and quotes.
        fields.push(field.replace(doubleQuoteRe, '"'));
      } else {
        // The second field pattern will match anything, thus
        // in the worst case the match will be an empty string.
        var field = fieldMatch[2];
        pos += field.length + 1;  // Skip comma.
        fields.push(field);
      }
    } while (pos <= endPos);
  }
  return fields;
};
node-v4.8.2/deps/v8/tools/DEPS000644 000766 000024 00000000207 13070706735 016065 0ustar00iojsstaff000000 000000 include_rules = [
  "+src",
]

# checkdeps.py shouldn't check for includes in these directories:
skip_child_includes = [
  "gcmole",
]
node-v4.8.2/deps/v8/tools/detect-builtins.js000644 000766 000024 00000003026 13070706735 021046 0ustar00iojsstaff000000 000000 // Copyright 2014 the V8 project authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

(function(global) {

  var GetProperties = function(this_name, object) {
    var result = {};
    try {
      var names = Object.getOwnPropertyNames(object);
    } catch(e) {
      return;
    }
    for (var i = 0; i < names.length; ++i) {
      var name = names[i];
      if (typeof object === "function") {
        if (name === "length" ||
            name === "name" ||
            name === "arguments" ||
            name === "caller" ||
            name === "prototype") {
          continue;
        }
      }
      // Avoid endless recursion.
      if (this_name === "prototype" && name === "constructor") continue;
      // Could get this from the parent, but having it locally is easier.
      var property = { "name": name };
      try {
        var value = object[name];
      } catch(e) {
        property.type = "getter";
        result[name] = property;
        continue;
      }
      var type = typeof value;
      property.type = type;
      if (type === "function") {
        property.length = value.length;
        property.prototype = GetProperties("prototype", value.prototype);
      }
      property.properties = GetProperties(name, value);
      result[name] = property;
    }
    return result;
  };

  var g = GetProperties("", global, "");
  print(JSON.stringify(g, undefined, 2));

})(this);  // Must wrap in anonymous closure or it'll detect itself as builtin.
node-v4.8.2/deps/v8/tools/disasm.py000644 000766 000024 00000007102 13070706735 017242 0ustar00iojsstaff000000 000000 #!/usr/bin/env python
#
# Copyright 2011 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

import os
import re
import subprocess
import tempfile


# Avoid using the slow (google-specific) wrapper around objdump.
OBJDUMP_BIN = "/usr/bin/objdump"
if not os.path.exists(OBJDUMP_BIN):
  OBJDUMP_BIN = "objdump"


_COMMON_DISASM_OPTIONS = ["-M", "intel-mnemonic", "-C"]

_DISASM_HEADER_RE = re.compile(r"[a-f0-9]+\s+<.*:$")
_DISASM_LINE_RE = re.compile(r"\s*([a-f0-9]+):\s*(\S.*)")

# Keys must match constants in Logger::LogCodeInfo.
_ARCH_MAP = {
  "ia32": "-m i386",
  "x64": "-m i386 -M x86-64",
  "arm": "-m arm",  # Not supported by our objdump build.
  "mips": "-m mips",  # Not supported by our objdump build.
  "arm64": "-m aarch64"
}


def GetDisasmLines(filename, offset, size, arch, inplace, arch_flags=""):
  tmp_name = None
  if not inplace:
    # Create a temporary file containing a copy of the code.
    assert arch in _ARCH_MAP, "Unsupported architecture '%s'" % arch
    arch_flags = arch_flags + " " +  _ARCH_MAP[arch]
    tmp_name = tempfile.mktemp(".v8code")
    command = "dd if=%s of=%s bs=1 count=%d skip=%d && " \
              "%s %s -D -b binary %s %s" % (
      filename, tmp_name, size, offset,
      OBJDUMP_BIN, ' '.join(_COMMON_DISASM_OPTIONS), arch_flags,
      tmp_name)
  else:
    command = "%s %s %s --start-address=%d --stop-address=%d -d %s " % (
      OBJDUMP_BIN, ' '.join(_COMMON_DISASM_OPTIONS), arch_flags,
      offset,
      offset + size,
      filename)
  process = subprocess.Popen(command,
                             shell=True,
                             stdout=subprocess.PIPE,
                             stderr=subprocess.STDOUT)
  out, err = process.communicate()
  lines = out.split("\n")
  header_line = 0
  for i, line in enumerate(lines):
    if _DISASM_HEADER_RE.match(line):
      header_line = i
      break
  if tmp_name:
    os.unlink(tmp_name)
  split_lines = []
  for line in lines[header_line + 1:]:
    match = _DISASM_LINE_RE.match(line)
    if match:
      line_address = int(match.group(1), 16)
      split_lines.append((line_address, match.group(2)))
  return split_lines
node-v4.8.2/deps/v8/tools/draw_instruction_graph.sh000755 000766 000024 00000010451 13070706735 022527 0ustar00iojsstaff000000 000000 #!/bin/bash
#
# Copyright 2013 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

# This script reads in CSV formatted instruction data, and draws a stacked
# graph in png format.

defaultfile=arm64_inst.csv
defaultout=arm64_inst.png
gnuplot=/usr/bin/gnuplot


# File containing CSV instruction data from simulator.
file=${1:-$defaultfile}

# Output graph png file.
out=${2:-$defaultout}

# Check input file exists.
if [ ! -e $file ]; then
  echo "Input file not found: $file."
  echo "Usage: draw_instruction_graph.sh  "
  exit 1
fi

# Search for an error message, and if found, exit.
error=`grep -m1 '# Error:' $file`
if [ -n "$error" ]; then
  echo "Error message in input file:"
  echo " $error"
  exit 2
fi

# Sample period - period over which numbers for each category of instructions is
# counted.
sp=`grep -m1 '# sample_period=' $file | cut -d= -f2`

# Get number of counters in the CSV file.
nc=`grep -m1 '# counters=' $file | cut -d= -f2`

# Find the annotation arrows. They appear as comments in the CSV file, in the
# format:
#   # xx @ yyyyy
# Where xx is a two character annotation identifier, and yyyyy is the
# position in the executed instruction stream that generated the annotation.
# Turn these locations into labelled arrows.
arrows=`sed '/^[^#]/ d' $file | \
        perl -pe "s/^# .. @ (\d+)/set arrow from \1, graph 0.9 to \1, $sp/"`;
labels=`sed '/^[^#]/d' $file | \
        sed -r 's/^# (..) @ (.+)/set label at \2, graph 0.9 "\1" \
                center offset 0,0.5 font "FreeSans, 8"/'`;

# Check for gnuplot, and warn if not available.
if [ ! -e $gnuplot ]; then
  echo "Can't find gnuplot at $gnuplot."
  echo "Gnuplot version 4.6.3 or later required."
  exit 3
fi

# Initialise gnuplot, and give it the data to draw.
echo | $gnuplot < 0

if __name__ == "__main__":
  sys.exit(Main())
node-v4.8.2/deps/v8/tools/find-commit-for-patch.py000755 000766 000024 00000006377 13070706735 022071 0ustar00iojsstaff000000 000000 #!/usr/bin/env python
# Copyright 2014 the V8 project authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

import argparse
import subprocess
import sys


def GetArgs():
  parser = argparse.ArgumentParser(
      description="Finds a commit that a given patch can be applied to. "
                  "Does not actually apply the patch or modify your checkout "
                  "in any way.")
  parser.add_argument("patch_file", help="Patch file to match")
  parser.add_argument(
      "--branch", "-b", default="origin/master", type=str,
      help="Git tree-ish where to start searching for commits, "
           "default: %(default)s")
  parser.add_argument(
      "--limit", "-l", default=500, type=int,
      help="Maximum number of commits to search, default: %(default)s")
  parser.add_argument(
      "--verbose", "-v", default=False, action="store_true",
      help="Print verbose output for your entertainment")
  return parser.parse_args()


def FindFilesInPatch(patch_file):
  files = {}
  next_file = ""
  with open(patch_file) as patch:
    for line in patch:
      if line.startswith("diff --git "):
        # diff --git a/src/objects.cc b/src/objects.cc
        words = line.split()
        assert words[2].startswith("a/") and len(words[2]) > 2
        next_file = words[2][2:]
      elif line.startswith("index "):
        # index add3e61..d1bbf6a 100644
        hashes = line.split()[1]
        old_hash = hashes.split("..")[0]
        if old_hash.startswith("0000000"): continue  # Ignore new files.
        files[next_file] = old_hash
  return files


def GetGitCommitHash(treeish):
  cmd = ["git", "log", "-1", "--format=%H", treeish]
  return subprocess.check_output(cmd).strip()


def CountMatchingFiles(commit, files):
  matched_files = 0
  # Calling out to git once and parsing the result Python-side is faster
  # than calling 'git ls-tree' for every file.
  cmd = ["git", "ls-tree", "-r", commit] + [f for f in files]
  output = subprocess.check_output(cmd)
  for line in output.splitlines():
    # 100644 blob c6d5daaa7d42e49a653f9861224aad0a0244b944      src/objects.cc
    _, _, actual_hash, filename = line.split()
    expected_hash = files[filename]
    if actual_hash.startswith(expected_hash): matched_files += 1
  return matched_files


def FindFirstMatchingCommit(start, files, limit, verbose):
  commit = GetGitCommitHash(start)
  num_files = len(files)
  if verbose: print(">>> Found %d files modified by patch." % num_files)
  for _ in range(limit):
    matched_files = CountMatchingFiles(commit, files)
    if verbose: print("Commit %s matched %d files" % (commit, matched_files))
    if matched_files == num_files:
      return commit
    commit = GetGitCommitHash("%s^" % commit)
  print("Sorry, no matching commit found. "
        "Try running 'git fetch', specifying the correct --branch, "
        "and/or setting a higher --limit.")
  sys.exit(1)


if __name__ == "__main__":
  args = GetArgs()
  files = FindFilesInPatch(args.patch_file)
  commit = FindFirstMatchingCommit(args.branch, files, args.limit, args.verbose)
  if args.verbose:
    print(">>> Matching commit: %s" % commit)
    print(subprocess.check_output(["git", "log", "-1", commit]))
    print(">>> Kthxbai.")
  else:
    print(commit)
node-v4.8.2/deps/v8/tools/find_depot_tools.py000644 000766 000024 00000002625 13070706735 021322 0ustar00iojsstaff000000 000000 # Copyright 2014 the V8 project authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""Small utility function to find depot_tools and add it to the python path.
"""

import os
import sys


def directory_really_is_depot_tools(directory):
  return os.path.isfile(os.path.join(directory, 'gclient.py'))


def add_depot_tools_to_path():
  """Search for depot_tools and add it to sys.path."""
  # First look if depot_tools is already in PYTHONPATH.
  for i in sys.path:
    if i.rstrip(os.sep).endswith('depot_tools'):
      if directory_really_is_depot_tools(i):
        return i

  # Then look if depot_tools is in PATH, common case.
  for i in os.environ['PATH'].split(os.pathsep):
    if i.rstrip(os.sep).endswith('depot_tools'):
      if directory_really_is_depot_tools(i):
        sys.path.insert(0, i.rstrip(os.sep))
        return i
  # Rare case, it's not even in PATH, look upward up to root.
  root_dir = os.path.dirname(os.path.abspath(__file__))
  previous_dir = os.path.abspath(__file__)
  while root_dir and root_dir != previous_dir:
    if directory_really_is_depot_tools(os.path.join(root_dir, 'depot_tools')):
      i = os.path.join(root_dir, 'depot_tools')
      sys.path.insert(0, i)
      return i
    previous_dir = root_dir
    root_dir = os.path.dirname(root_dir)
  print >> sys.stderr, 'Failed to find depot_tools'
  return None
node-v4.8.2/deps/v8/tools/freebsd-tick-processor000755 000766 000024 00000000400 13070706735 021707 0ustar00iojsstaff000000 000000 #!/bin/sh

# A wrapper script to call 'linux-tick-processor'.

# Known issues on FreeBSD:
#  No ticks from C++ code.
#  You must have d8 built and in your path before calling this.

tools_path=`cd $(dirname "$0");pwd`
$tools_path/linux-tick-processor "$@"
node-v4.8.2/deps/v8/tools/fuzz-harness.sh000755 000766 000024 00000006624 13070706735 020416 0ustar00iojsstaff000000 000000 #!/bin/bash
# Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

# A simple harness that downloads and runs 'jsfunfuzz' against d8. This
# takes a long time because it runs many iterations and is intended for
# automated usage. The package containing 'jsfunfuzz' can be found as an
# attachment to this bug:
# https://bugzilla.mozilla.org/show_bug.cgi?id=jsfunfuzz

JSFUNFUZZ_URL="https://bugzilla.mozilla.org/attachment.cgi?id=310631"
JSFUNFUZZ_MD5="d0e497201c5cd7bffbb1cdc1574f4e32"

v8_root=$(readlink -f $(dirname $BASH_SOURCE)/../)

if [ -n "$1" ]; then
  d8="${v8_root}/$1"
else
  d8="${v8_root}/d8"
fi

if [ ! -f "$d8" ]; then
  echo "Failed to find d8 binary: $d8"
  exit 1
fi

jsfunfuzz_file="$v8_root/tools/jsfunfuzz.zip"
if [ ! -f "$jsfunfuzz_file" ]; then
  echo "Downloading $jsfunfuzz_file ..."
  wget -q -O "$jsfunfuzz_file" $JSFUNFUZZ_URL || exit 1
fi

jsfunfuzz_sum=$(md5sum "$jsfunfuzz_file" | awk '{ print $1 }')
if [ $jsfunfuzz_sum != $JSFUNFUZZ_MD5 ]; then
  echo "Failed to verify checksum!"
  exit 1
fi

jsfunfuzz_dir="$v8_root/tools/jsfunfuzz"
if [ ! -d "$jsfunfuzz_dir" ]; then
  echo "Unpacking into $jsfunfuzz_dir ..."
  unzip "$jsfunfuzz_file" -d "$jsfunfuzz_dir" || exit 1
  echo "Patching runner ..."
  cat << EOF | patch -s -p0 -d "$v8_root"
--- tools/jsfunfuzz/jsfunfuzz/multi_timed_run.py~
+++ tools/jsfunfuzz/jsfunfuzz/multi_timed_run.py
@@ -125,7 +125,7 @@
 
 def many_timed_runs():
     iteration = 0
-    while True:
+    while iteration < 100:
         iteration += 1
         logfilename = "w%d" % iteration
         one_timed_run(logfilename)
EOF
fi

flags='--debug-code --expose-gc --verify-gc'
python -u "$jsfunfuzz_dir/jsfunfuzz/multi_timed_run.py" 300 \
    "$d8" $flags "$jsfunfuzz_dir/jsfunfuzz/jsfunfuzz.js"
exit_code=$(cat w* | grep " looking good" -c)
exit_code=$((100-exit_code))
tar -cjf fuzz-results-$(date +%Y%m%d%H%M%S).tar.bz2 err-* w*
rm -f err-* w*

echo "Total failures: $exit_code"
exit $exit_code
node-v4.8.2/deps/v8/tools/gc-nvp-to-csv.py000755 000766 000024 00000001367 13070706735 020377 0ustar00iojsstaff000000 000000 #!/usr/bin/env python
#
# Copyright 2015 the V8 project authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

#
# This is an utility for generating csv files based on GC traces produced by
# V8 when run with flags --trace-gc --trace-gc-nvp.
#
# Usage: gc-nvp-to-csv.py 
#

import sys
import gc_nvp_common

def process_trace(filename):
  trace = gc_nvp_common.parse_gc_trace(filename)
  if len(trace):
    keys = trace[0].keys()
    print ', '.join(keys)
    for entry in trace:
      print ', '.join(map(lambda key: str(entry[key]), keys))


if len(sys.argv) != 2:
  print "Usage: %s " % sys.argv[0]
  sys.exit(1)

process_trace(sys.argv[1])
node-v4.8.2/deps/v8/tools/gc-nvp-trace-processor.py000755 000766 000024 00000025577 13070706735 022310 0ustar00iojsstaff000000 000000 #!/usr/bin/env python
#
# Copyright 2010 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#

#
# This is an utility for plotting charts based on GC traces produced by V8 when
# run with flags --trace-gc --trace-gc-nvp. Relies on gnuplot for actual
# plotting.
#
# Usage: gc-nvp-trace-processor.py 
#


from __future__ import with_statement
import sys, types, subprocess, math
import gc_nvp_common

def flatten(l):
  flat = []
  for i in l: flat.extend(i)
  return flat

def gnuplot(script):
  gnuplot = subprocess.Popen(["gnuplot"], stdin=subprocess.PIPE)
  gnuplot.stdin.write(script)
  gnuplot.stdin.close()
  gnuplot.wait()

x1y1 = 'x1y1'
x1y2 = 'x1y2'
x2y1 = 'x2y1'
x2y2 = 'x2y2'

class Item(object):
  def __init__(self, title, field, axis = x1y1, **keywords):
    self.title = title
    self.axis = axis
    self.props = keywords
    if type(field) is types.ListType:
      self.field = field
    else:
      self.field = [field]

  def fieldrefs(self):
    return self.field

  def to_gnuplot(self, context):
    args = ['"%s"' % context.datafile,
            'using %s' % context.format_fieldref(self.field),
            'title "%s"' % self.title,
            'axis %s' % self.axis]
    if 'style' in self.props:
      args.append('with %s' % self.props['style'])
    if 'lc' in self.props:
      args.append('lc rgb "%s"' % self.props['lc'])
    if 'fs' in self.props:
      args.append('fs %s' % self.props['fs'])
    return ' '.join(args)

class Plot(object):
  def __init__(self, *items):
    self.items = items

  def fieldrefs(self):
    return flatten([item.fieldrefs() for item in self.items])

  def to_gnuplot(self, ctx):
    return 'plot ' + ', '.join([item.to_gnuplot(ctx) for item in self.items])

class Set(object):
  def __init__(self, value):
    self.value = value

  def to_gnuplot(self, ctx):
    return 'set ' + self.value

  def fieldrefs(self):
    return []

class Context(object):
  def __init__(self, datafile, field_to_index):
    self.datafile = datafile
    self.field_to_index = field_to_index

  def format_fieldref(self, fieldref):
    return ':'.join([str(self.field_to_index[field]) for field in fieldref])

def collect_fields(plot):
  field_to_index = {}
  fields = []

  def add_field(field):
    if field not in field_to_index:
      fields.append(field)
      field_to_index[field] = len(fields)

  for field in flatten([item.fieldrefs() for item in plot]):
    add_field(field)

  return (fields, field_to_index)

def is_y2_used(plot):
  for subplot in plot:
    if isinstance(subplot, Plot):
      for item in subplot.items:
        if item.axis == x1y2 or item.axis == x2y2:
          return True
  return False

def get_field(trace_line, field):
  t = type(field)
  if t is types.StringType:
    return trace_line[field]
  elif t is types.FunctionType:
    return field(trace_line)

def generate_datafile(datafile_name, trace, fields):
  with open(datafile_name, 'w') as datafile:
    for line in trace:
      data_line = [str(get_field(line, field)) for field in fields]
      datafile.write('\t'.join(data_line))
      datafile.write('\n')

def generate_script_and_datafile(plot, trace, datafile, output):
  (fields, field_to_index) = collect_fields(plot)
  generate_datafile(datafile, trace, fields)
  script = [
      'set terminal png',
      'set output "%s"' % output,
      'set autoscale',
      'set ytics nomirror',
      'set xtics nomirror',
      'set key below'
  ]

  if is_y2_used(plot):
    script.append('set autoscale y2')
    script.append('set y2tics')

  context = Context(datafile, field_to_index)

  for item in plot:
    script.append(item.to_gnuplot(context))

  return '\n'.join(script)

def plot_all(plots, trace, prefix):
  charts = []

  for plot in plots:
    outfilename = "%s_%d.png" % (prefix, len(charts))
    charts.append(outfilename)
    script = generate_script_and_datafile(plot, trace, '~datafile', outfilename)
    print 'Plotting %s...' % outfilename
    gnuplot(script)

  return charts

def reclaimed_bytes(row):
  return row['total_size_before'] - row['total_size_after']

def other_scope(r):
  if r['gc'] == 's':
    # there is no 'other' scope for scavenging collections.
    return 0
  return r['pause'] - r['mark'] - r['sweep'] - r['external']

def scavenge_scope(r):
  if r['gc'] == 's':
    return r['pause'] - r['external']
  return 0


def real_mutator(r):
  return r['mutator'] - r['steps_took']

plots = [
  [
    Set('style fill solid 0.5 noborder'),
    Set('style histogram rowstacked'),
    Set('style data histograms'),
    Plot(Item('Scavenge', scavenge_scope, lc = 'green'),
         Item('Marking', 'mark', lc = 'purple'),
         Item('Sweep', 'sweep', lc = 'blue'),
         Item('External', 'external', lc = '#489D43'),
         Item('Other', other_scope, lc = 'grey'),
         Item('IGC Steps', 'steps_took', lc = '#FF6347'))
  ],
  [
    Set('style fill solid 0.5 noborder'),
    Set('style histogram rowstacked'),
    Set('style data histograms'),
    Plot(Item('Scavenge', scavenge_scope, lc = 'green'),
         Item('Marking', 'mark', lc = 'purple'),
         Item('Sweep', 'sweep', lc = 'blue'),
         Item('External', 'external', lc = '#489D43'),
         Item('Other', other_scope, lc = '#ADD8E6'),
         Item('External', 'external', lc = '#D3D3D3'))
  ],

  [
    Plot(Item('Mutator', real_mutator, lc = 'black', style = 'lines'))
  ],
  [
    Set('style histogram rowstacked'),
    Set('style data histograms'),
    Plot(Item('Heap Size (before GC)', 'total_size_before', x1y2,
              fs = 'solid 0.4 noborder',
              lc = 'green'),
         Item('Total holes (after GC)', 'holes_size_before', x1y2,
              fs = 'solid 0.4 noborder',
              lc = 'red'),
         Item('GC Time', ['i', 'pause'], style = 'lines', lc = 'red'))
  ],
  [
    Set('style histogram rowstacked'),
    Set('style data histograms'),
    Plot(Item('Heap Size (after GC)', 'total_size_after', x1y2,
              fs = 'solid 0.4 noborder',
              lc = 'green'),
         Item('Total holes (after GC)', 'holes_size_after', x1y2,
              fs = 'solid 0.4 noborder',
              lc = 'red'),
         Item('GC Time', ['i', 'pause'],
              style = 'lines',
              lc = 'red'))
  ],
  [
    Set('style fill solid 0.5 noborder'),
    Set('style data histograms'),
    Plot(Item('Allocated', 'allocated'),
         Item('Reclaimed', reclaimed_bytes),
         Item('Promoted', 'promoted', style = 'lines', lc = 'black'))
  ],
]

def freduce(f, field, trace, init):
  return reduce(lambda t,r: f(t, r[field]), trace, init)

def calc_total(trace, field):
  return freduce(lambda t,v: t + long(v), field, trace, long(0))

def calc_max(trace, field):
  return freduce(lambda t,r: max(t, r), field, trace, 0)

def count_nonzero(trace, field):
  return freduce(lambda t,r: t if r == 0 else t + 1, field, trace, 0)


def process_trace(filename):
  trace = gc_nvp_common.parse_gc_trace(filename)

  marksweeps = filter(lambda r: r['gc'] == 'ms', trace)
  scavenges = filter(lambda r: r['gc'] == 's', trace)
  globalgcs = filter(lambda r: r['gc'] != 's', trace)


  charts = plot_all(plots, trace, filename)

  def stats(out, prefix, trace, field):
    n = len(trace)
    total = calc_total(trace, field)
    max = calc_max(trace, field)
    if n > 0:
      avg = total / n
    else:
      avg = 0
    if n > 1:
      dev = math.sqrt(freduce(lambda t,r: t + (r - avg) ** 2, field, trace, 0) /
                      (n - 1))
    else:
      dev = 0

    out.write('%s%d%d'
              '%d%d [dev %f]' %
              (prefix, n, total, max, avg, dev))

  def HumanReadable(size):
    suffixes = ['bytes', 'kB', 'MB', 'GB']
    power = 1
    for i in range(len(suffixes)):
      if size < power*1024:
        return "%.1f" % (float(size) / power) + " " + suffixes[i]
      power *= 1024

  def throughput(name, trace):
    total_live_after = calc_total(trace, 'total_size_after')
    total_live_before = calc_total(trace, 'total_size_before')
    total_gc = calc_total(trace, 'pause')
    if total_gc == 0:
      return
    out.write('GC %s Throughput (after): %s / %s ms = %s/ms
' %
              (name,
               HumanReadable(total_live_after),
               total_gc,
               HumanReadable(total_live_after / total_gc)))
    out.write('GC %s Throughput (before): %s / %s ms = %s/ms
' %
              (name,
               HumanReadable(total_live_before),
               total_gc,
               HumanReadable(total_live_before / total_gc)))


  with open(filename + '.html', 'w') as out:
    out.write('')
    out.write('')
    out.write('')
    out.write('')
    stats(out, 'Total in GC', trace, 'pause')
    stats(out, 'Scavenge', scavenges, 'pause')
    stats(out, 'MarkSweep', marksweeps, 'pause')
    stats(out, 'Mark', filter(lambda r: r['mark'] != 0, trace), 'mark')
    stats(out, 'Sweep', filter(lambda r: r['sweep'] != 0, trace), 'sweep')
    stats(out,
          'External',
          filter(lambda r: r['external'] != 0, trace),
          'external')
    out.write('
PhaseCountTime (ms)MaxAvg
')
    throughput('TOTAL', trace)
    throughput('MS', marksweeps)
    throughput('OLDSPACE', globalgcs)
    out.write('
')
    for chart in charts:
      out.write('' % chart)
      out.write('')

  print "%s generated." % (filename + '.html')

if len(sys.argv) != 2:
  print "Usage: %s " % sys.argv[0]
  sys.exit(1)

process_trace(sys.argv[1])
node-v4.8.2/deps/v8/tools/gc_nvp_common.py000644 000766 000024 00000001265 13070706735 020612 0ustar00iojsstaff000000 000000 # Copyright 2015 the V8 project authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

#
# Common code for parsing --trace-gc-nvp output.
#


from __future__ import with_statement
import re

def split_nvp(s):
  t = {}
  for (name, value) in re.findall(r"(\w+)=([-\w]+)", s):
    try:
      t[name] = float(value)
    except ValueError:
      t[name] = value

  return t


def parse_gc_trace(input):
  trace = []
  with open(input) as f:
    for line in f:
      info = split_nvp(line)
      if info and 'pause' in info and info['pause'] > 0:
        info['i'] = len(trace)
        trace.append(info)
  return trace
node-v4.8.2/deps/v8/tools/gcmole/000755 000766 000024 00000000000 13070706735 016656 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/v8/tools/gdb-v8-support.py000644 000766 000024 00000012321 13070706735 020562 0ustar00iojsstaff000000 000000 # Copyright 2011 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


kSmiTag = 0
kSmiTagSize = 1
kSmiTagMask = (1 << kSmiTagSize) - 1


kHeapObjectTag = 1
kHeapObjectTagSize = 2
kHeapObjectTagMask = (1 << kHeapObjectTagSize) - 1


kFailureTag = 3
kFailureTagSize = 2
kFailureTagMask = (1 << kFailureTagSize) - 1


kSmiShiftSize32 = 0
kSmiValueSize32 = 31
kSmiShiftBits32 = kSmiTagSize + kSmiShiftSize32


kSmiShiftSize64 = 31
kSmiValueSize64 = 32
kSmiShiftBits64 = kSmiTagSize + kSmiShiftSize64


kAllBits = 0xFFFFFFFF
kTopBit32 = 0x80000000
kTopBit64 = 0x8000000000000000


t_u32 = gdb.lookup_type('unsigned int')
t_u64 = gdb.lookup_type('unsigned long long')


def has_smi_tag(v):
  return v & kSmiTagMask == kSmiTag


def has_failure_tag(v):
  return v & kFailureTagMask == kFailureTag


def has_heap_object_tag(v):
  return v & kHeapObjectTagMask == kHeapObjectTag


def raw_heap_object(v):
  return v - kHeapObjectTag


def smi_to_int_32(v):
  v = v & kAllBits
  if (v & kTopBit32) == kTopBit32:
    return ((v & kAllBits) >> kSmiShiftBits32) - 2147483648
  else:
    return (v & kAllBits) >> kSmiShiftBits32


def smi_to_int_64(v):
  return (v >> kSmiShiftBits64)


def decode_v8_value(v, bitness):
  base_str = 'v8[%x]' % v
  if has_smi_tag(v):
    if bitness == 32:
      return base_str + (" SMI(%d)" % smi_to_int_32(v))
    else:
      return base_str + (" SMI(%d)" % smi_to_int_64(v))
  elif has_failure_tag(v):
    return base_str + " (failure)"
  elif has_heap_object_tag(v):
    return base_str + (" H(0x%x)" % raw_heap_object(v))
  else:
    return base_str


class V8ValuePrinter(object):
  "Print a v8value."
  def __init__(self, val):
    self.val = val
  def to_string(self):
    if self.val.type.sizeof == 4:
      v_u32 = self.val.cast(t_u32)
      return decode_v8_value(int(v_u32), 32)
    elif self.val.type.sizeof == 8:
      v_u64 = self.val.cast(t_u64)
      return decode_v8_value(int(v_u64), 64)
    else:
      return 'v8value?'
  def display_hint(self):
    return 'v8value'


def v8_pretty_printers(val):
  lookup_tag = val.type.tag
  if lookup_tag == None:
    return None
  elif lookup_tag == 'v8value':
    return V8ValuePrinter(val)
  return None
gdb.pretty_printers.append(v8_pretty_printers)


def v8_to_int(v):
  if v.type.sizeof == 4:
    return int(v.cast(t_u32))
  elif v.type.sizeof == 8:
    return int(v.cast(t_u64))
  else:
    return '?'


def v8_get_value(vstring):
  v = gdb.parse_and_eval(vstring)
  return v8_to_int(v)


class V8PrintObject (gdb.Command):
  """Prints a v8 object."""
  def __init__ (self):
    super (V8PrintObject, self).__init__ ("v8print", gdb.COMMAND_DATA)
  def invoke (self, arg, from_tty):
    v = v8_get_value(arg)
    gdb.execute('call __gdb_print_v8_object(%d)' % v)
V8PrintObject()


class FindAnywhere (gdb.Command):
  """Search memory for the given pattern."""
  MAPPING_RE = re.compile(r"^\s*\[\d+\]\s+0x([0-9A-Fa-f]+)->0x([0-9A-Fa-f]+)")
  LIVE_MAPPING_RE = re.compile(r"^\s+0x([0-9A-Fa-f]+)\s+0x([0-9A-Fa-f]+)")
  def __init__ (self):
    super (FindAnywhere, self).__init__ ("find-anywhere", gdb.COMMAND_DATA)
  def find (self, startAddr, endAddr, value):
    try:
      result = gdb.execute(
          "find 0x%s, 0x%s, %s" % (startAddr, endAddr, value),
          to_string = True)
      if result.find("not found") == -1:
        print result
    except:
      pass

  def invoke (self, value, from_tty):
    for l in gdb.execute("maint info sections", to_string = True).split('\n'):
      m = FindAnywhere.MAPPING_RE.match(l)
      if m is None:
        continue
      self.find(m.group(1), m.group(2), value)
    for l in gdb.execute("info proc mappings", to_string = True).split('\n'):
      m = FindAnywhere.LIVE_MAPPING_RE.match(l)
      if m is None:
        continue
      self.find(m.group(1), m.group(2), value)

FindAnywhere()
node-v4.8.2/deps/v8/tools/gdbinit000644 000766 000024 00000002161 13070706735 016753 0ustar00iojsstaff000000 000000 # Copyright 2014 the V8 project authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

# Print HeapObjects.
define job
print ((v8::internal::HeapObject*)($arg0))->Print()
end
document job
Print a v8 JavaScript object
Usage: job tagged_ptr
end

# Print Code objects containing given PC.
define jco
job (v8::internal::Isolate::Current()->FindCodeObject((v8::internal::Address)$arg0))
end
document jco
Print a v8 Code object from an internal code address
Usage: jco pc
end

# Print DescriptorArray.
define jda
print ((v8::internal::DescriptorArray*)($arg0))->Print()
end
document jda
Print a v8 DescriptorArray object
Usage: jda tagged_ptr
end

# Print TransitionArray.
define jta
print ((v8::internal::TransitionArray*)($arg0))->Print()
end
document jta
Print a v8 TransitionArray object
Usage: jta tagged_ptr
end

# Print JavaScript stack trace.
define jst
print v8::internal::Isolate::Current()->PrintStack((FILE*) stdout, 1)
end
document jst
Print the current JavaScript stack trace
Usage: jst
end

set disassembly-flavor intel
set disable-randomization off
node-v4.8.2/deps/v8/tools/gen-postmortem-metadata.py000644 000766 000024 00000056212 13070706735 022526 0ustar00iojsstaff000000 000000 #!/usr/bin/env python

#
# Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#

#
# Emits a C++ file to be compiled and linked into libv8 to support postmortem
# debugging tools.  Most importantly, this tool emits constants describing V8
# internals:
#
#    v8dbg_type_CLASS__TYPE = VALUE             Describes class type values
#    v8dbg_class_CLASS__FIELD__TYPE = OFFSET    Describes class fields
#    v8dbg_parent_CLASS__PARENT                 Describes class hierarchy
#    v8dbg_frametype_NAME = VALUE               Describes stack frame values
#    v8dbg_off_fp_NAME = OFFSET                 Frame pointer offsets
#    v8dbg_prop_NAME = OFFSET                   Object property offsets
#    v8dbg_NAME = VALUE                         Miscellaneous values
#
# These constants are declared as global integers so that they'll be present in
# the generated libv8 binary.
#

import re
import sys

#
# Miscellaneous constants, tags, and masks used for object identification.
#
consts_misc = [
    { 'name': 'FirstNonstringType',     'value': 'FIRST_NONSTRING_TYPE' },

    { 'name': 'IsNotStringMask',        'value': 'kIsNotStringMask' },
    { 'name': 'StringTag',              'value': 'kStringTag' },
    { 'name': 'NotStringTag',           'value': 'kNotStringTag' },

    { 'name': 'StringEncodingMask',     'value': 'kStringEncodingMask' },
    { 'name': 'TwoByteStringTag',       'value': 'kTwoByteStringTag' },
    { 'name': 'OneByteStringTag',       'value': 'kOneByteStringTag' },

    { 'name': 'StringRepresentationMask',
        'value': 'kStringRepresentationMask' },
    { 'name': 'SeqStringTag',           'value': 'kSeqStringTag' },
    { 'name': 'ConsStringTag',          'value': 'kConsStringTag' },
    { 'name': 'ExternalStringTag',      'value': 'kExternalStringTag' },
    { 'name': 'SlicedStringTag',        'value': 'kSlicedStringTag' },

    { 'name': 'HeapObjectTag',          'value': 'kHeapObjectTag' },
    { 'name': 'HeapObjectTagMask',      'value': 'kHeapObjectTagMask' },
    { 'name': 'SmiTag',                 'value': 'kSmiTag' },
    { 'name': 'SmiTagMask',             'value': 'kSmiTagMask' },
    { 'name': 'SmiValueShift',          'value': 'kSmiTagSize' },
    { 'name': 'SmiShiftSize',           'value': 'kSmiShiftSize' },
    { 'name': 'PointerSizeLog2',        'value': 'kPointerSizeLog2' },

    { 'name': 'OddballFalse',           'value': 'Oddball::kFalse' },
    { 'name': 'OddballTrue',            'value': 'Oddball::kTrue' },
    { 'name': 'OddballTheHole',         'value': 'Oddball::kTheHole' },
    { 'name': 'OddballNull',            'value': 'Oddball::kNull' },
    { 'name': 'OddballArgumentMarker',  'value': 'Oddball::kArgumentMarker' },
    { 'name': 'OddballUndefined',       'value': 'Oddball::kUndefined' },
    { 'name': 'OddballUninitialized',   'value': 'Oddball::kUninitialized' },
    { 'name': 'OddballOther',           'value': 'Oddball::kOther' },
    { 'name': 'OddballException',       'value': 'Oddball::kException' },

    { 'name': 'prop_idx_first',
        'value': 'DescriptorArray::kFirstIndex' },
    { 'name': 'prop_type_field',
        'value': 'DATA' },
    { 'name': 'prop_type_mask',
        'value': 'PropertyDetails::TypeField::kMask' },
    { 'name': 'prop_index_mask',
        'value': 'PropertyDetails::FieldIndexField::kMask' },
    { 'name': 'prop_index_shift',
        'value': 'PropertyDetails::FieldIndexField::kShift' },
    { 'name': 'prop_representation_mask',
        'value': 'PropertyDetails::RepresentationField::kMask' },
    { 'name': 'prop_representation_shift',
        'value': 'PropertyDetails::RepresentationField::kShift' },
    { 'name': 'prop_representation_integer8',
        'value': 'Representation::Kind::kInteger8' },
    { 'name': 'prop_representation_uinteger8',
        'value': 'Representation::Kind::kUInteger8' },
    { 'name': 'prop_representation_integer16',
        'value': 'Representation::Kind::kInteger16' },
    { 'name': 'prop_representation_uinteger16',
        'value': 'Representation::Kind::kUInteger16' },
    { 'name': 'prop_representation_smi',
        'value': 'Representation::Kind::kSmi' },
    { 'name': 'prop_representation_integer32',
        'value': 'Representation::Kind::kInteger32' },
    { 'name': 'prop_representation_double',
        'value': 'Representation::Kind::kDouble' },
    { 'name': 'prop_representation_heapobject',
        'value': 'Representation::Kind::kHeapObject' },
    { 'name': 'prop_representation_tagged',
        'value': 'Representation::Kind::kTagged' },
    { 'name': 'prop_representation_external',
        'value': 'Representation::Kind::kExternal' },

    { 'name': 'prop_desc_key',
        'value': 'DescriptorArray::kDescriptorKey' },
    { 'name': 'prop_desc_details',
        'value': 'DescriptorArray::kDescriptorDetails' },
    { 'name': 'prop_desc_value',
        'value': 'DescriptorArray::kDescriptorValue' },
    { 'name': 'prop_desc_size',
        'value': 'DescriptorArray::kDescriptorSize' },

    { 'name': 'elements_fast_holey_elements',
        'value': 'FAST_HOLEY_ELEMENTS' },
    { 'name': 'elements_fast_elements',
        'value': 'FAST_ELEMENTS' },
    { 'name': 'elements_dictionary_elements',
        'value': 'DICTIONARY_ELEMENTS' },

    { 'name': 'bit_field2_elements_kind_mask',
        'value': 'Map::ElementsKindBits::kMask' },
    { 'name': 'bit_field2_elements_kind_shift',
        'value': 'Map::ElementsKindBits::kShift' },
    { 'name': 'bit_field3_dictionary_map_shift',
        'value': 'Map::DictionaryMap::kShift' },
    { 'name': 'bit_field3_number_of_own_descriptors_mask',
        'value': 'Map::NumberOfOwnDescriptorsBits::kMask' },
    { 'name': 'bit_field3_number_of_own_descriptors_shift',
        'value': 'Map::NumberOfOwnDescriptorsBits::kShift' },

    { 'name': 'off_fp_context',
        'value': 'StandardFrameConstants::kContextOffset' },
    { 'name': 'off_fp_constant_pool',
        'value': 'StandardFrameConstants::kConstantPoolOffset' },
    { 'name': 'off_fp_marker',
        'value': 'StandardFrameConstants::kMarkerOffset' },
    { 'name': 'off_fp_function',
        'value': 'JavaScriptFrameConstants::kFunctionOffset' },
    { 'name': 'off_fp_args',
        'value': 'JavaScriptFrameConstants::kLastParameterOffset' },

    { 'name': 'scopeinfo_idx_nparams',
        'value': 'ScopeInfo::kParameterCount' },
    { 'name': 'scopeinfo_idx_nstacklocals',
        'value': 'ScopeInfo::kStackLocalCount' },
    { 'name': 'scopeinfo_idx_ncontextlocals',
        'value': 'ScopeInfo::kContextLocalCount' },
    { 'name': 'scopeinfo_idx_ncontextglobals',
        'value': 'ScopeInfo::kContextGlobalCount' },
    { 'name': 'scopeinfo_idx_first_vars',
        'value': 'ScopeInfo::kVariablePartIndex' },

    { 'name': 'sharedfunctioninfo_start_position_mask',
        'value': 'SharedFunctionInfo::kStartPositionMask' },
    { 'name': 'sharedfunctioninfo_start_position_shift',
        'value': 'SharedFunctionInfo::kStartPositionShift' },

    { 'name': 'jsarray_buffer_was_neutered_mask',
        'value': 'JSArrayBuffer::WasNeutered::kMask' },
    { 'name': 'jsarray_buffer_was_neutered_shift',
        'value': 'JSArrayBuffer::WasNeutered::kShift' },
];

#
# The following useful fields are missing accessors, so we define fake ones.
#
extras_accessors = [
    'JSFunction, context, Context, kContextOffset',
    'Context, closure_index, int, CLOSURE_INDEX',
    'Context, global_object_index, int, GLOBAL_OBJECT_INDEX',
    'Context, previous_index, int, PREVIOUS_INDEX',
    'Context, min_context_slots, int, MIN_CONTEXT_SLOTS',
    'HeapObject, map, Map, kMapOffset',
    'JSObject, elements, Object, kElementsOffset',
    'FixedArray, data, uintptr_t, kHeaderSize',
    'JSTypedArray, length, Object, kLengthOffset',
    'Map, instance_attributes, int, kInstanceAttributesOffset',
    'Map, inobject_properties, int, kInObjectPropertiesOffset',
    'Map, instance_size, int, kInstanceSizeOffset',
    'Map, bit_field, char, kBitFieldOffset',
    'Map, bit_field2, char, kBitField2Offset',
    'Map, bit_field3, int, kBitField3Offset',
    'Map, prototype, Object, kPrototypeOffset',
    'NameDictionaryShape, prefix_size, int, kPrefixSize',
    'NameDictionaryShape, entry_size, int, kEntrySize',
    'NameDictionary, prefix_start_index, int, kPrefixStartIndex',
    'SeededNumberDictionaryShape, prefix_size, int, kPrefixSize',
    'UnseededNumberDictionaryShape, prefix_size, int, kPrefixSize',
    'NumberDictionaryShape, entry_size, int, kEntrySize',
    'Oddball, kind_offset, int, kKindOffset',
    'HeapNumber, value, double, kValueOffset',
    'ConsString, first, String, kFirstOffset',
    'ConsString, second, String, kSecondOffset',
    'ExternalString, resource, Object, kResourceOffset',
    'SeqOneByteString, chars, char, kHeaderSize',
    'SeqTwoByteString, chars, char, kHeaderSize',
    'SharedFunctionInfo, code, Code, kCodeOffset',
    'SharedFunctionInfo, scope_info, ScopeInfo, kScopeInfoOffset',
    'SlicedString, parent, String, kParentOffset',
    'Code, instruction_start, uintptr_t, kHeaderSize',
    'Code, instruction_size, int, kInstructionSizeOffset',
];

#
# The following is a whitelist of classes we expect to find when scanning the
# source code. This list is not exhaustive, but it's still useful to identify
# when this script gets out of sync with the source. See load_objects().
#
expected_classes = [
    'ConsString', 'FixedArray', 'HeapNumber', 'JSArray', 'JSFunction',
    'JSObject', 'JSRegExp', 'JSValue', 'Map', 'Oddball', 'Script',
    'SeqOneByteString', 'SharedFunctionInfo'
];


#
# The following structures store high-level representations of the structures
# for which we're going to emit descriptive constants.
#
types = {};             # set of all type names
typeclasses = {};       # maps type names to corresponding class names
klasses = {};           # known classes, including parents
fields = [];            # field declarations

header = '''
/*
 * This file is generated by %s.  Do not edit directly.
 */

#include "src/v8.h"
#include "src/frames.h"
#include "src/frames-inl.h" /* for architecture-specific frame constants */

using namespace v8::internal;

extern "C" {

/* stack frame constants */
#define FRAME_CONST(value, klass)       \
    int v8dbg_frametype_##klass = StackFrame::value;

STACK_FRAME_TYPE_LIST(FRAME_CONST)

#undef FRAME_CONST

''' % sys.argv[0];

footer = '''
}
'''

#
# Get the base class
#
def get_base_class(klass):
        if (klass == 'Object'):
                return klass;

        if (not (klass in klasses)):
                return None;

        k = klasses[klass];

        return get_base_class(k['parent']);

#
# Loads class hierarchy and type information from "objects.h".
#
def load_objects():
        objfilename = sys.argv[2];
        objfile = open(objfilename, 'r');
        in_insttype = False;

        typestr = '';

        #
        # Construct a dictionary for the classes we're sure should be present.
        #
        checktypes = {};
        for klass in expected_classes:
                checktypes[klass] = True;

        #
        # Iterate objects.h line-by-line to collect type and class information.
        # For types, we accumulate a string representing the entire InstanceType
        # enum definition and parse it later because it's easier to do so
        # without the embedded newlines.
        #
        for line in objfile:
                if (line.startswith('enum InstanceType {')):
                        in_insttype = True;
                        continue;

                if (in_insttype and line.startswith('};')):
                        in_insttype = False;
                        continue;

                line = re.sub('//.*', '', line.rstrip().lstrip());

                if (in_insttype):
                        typestr += line;
                        continue;

                match = re.match('class (\w[^:]*)(: public (\w[^{]*))?\s*{\s*',
                    line);

                if (match):
                        klass = match.group(1).rstrip().lstrip();
                        pklass = match.group(3);
                        if (pklass):
                                pklass = pklass.rstrip().lstrip();
                        klasses[klass] = { 'parent': pklass };

        #
        # Process the instance type declaration.
        #
        entries = typestr.split(',');
        for entry in entries:
                types[re.sub('\s*=.*', '', entry).lstrip()] = True;

        #
        # Infer class names for each type based on a systematic transformation.
        # For example, "JS_FUNCTION_TYPE" becomes "JSFunction".  We find the
        # class for each type rather than the other way around because there are
        # fewer cases where one type maps to more than one class than the other
        # way around.
        #
        for type in types:
                #
                # Symbols and Strings are implemented using the same classes.
                #
                usetype = re.sub('SYMBOL_', 'STRING_', type);

                #
                # REGEXP behaves like REG_EXP, as in JS_REGEXP_TYPE => JSRegExp.
                #
                usetype = re.sub('_REGEXP_', '_REG_EXP_', usetype);

                #
                # Remove the "_TYPE" suffix and then convert to camel case,
                # except that a "JS" prefix remains uppercase (as in
                # "JS_FUNCTION_TYPE" => "JSFunction").
                #
                if (not usetype.endswith('_TYPE')):
                        continue;

                usetype = usetype[0:len(usetype) - len('_TYPE')];
                parts = usetype.split('_');
                cctype = '';

                if (parts[0] == 'JS'):
                        cctype = 'JS';
                        start = 1;
                else:
                        cctype = '';
                        start = 0;

                for ii in range(start, len(parts)):
                        part = parts[ii];
                        cctype += part[0].upper() + part[1:].lower();

                #
                # Mapping string types is more complicated.  Both types and
                # class names for Strings specify a representation (e.g., Seq,
                # Cons, External, or Sliced) and an encoding (TwoByte/OneByte),
                # In the simplest case, both of these are explicit in both
                # names, as in:
                #
                #       EXTERNAL_ONE_BYTE_STRING_TYPE => ExternalOneByteString
                #
                # However, either the representation or encoding can be omitted
                # from the type name, in which case "Seq" and "TwoByte" are
                # assumed, as in:
                #
                #       STRING_TYPE => SeqTwoByteString
                #
                # Additionally, sometimes the type name has more information
                # than the class, as in:
                #
                #       CONS_ONE_BYTE_STRING_TYPE => ConsString
                #
                # To figure this out dynamically, we first check for a
                # representation and encoding and add them if they're not
                # present.  If that doesn't yield a valid class name, then we
                # strip out the representation.
                #
                if (cctype.endswith('String')):
                        if (cctype.find('Cons') == -1 and
                            cctype.find('External') == -1 and
                            cctype.find('Sliced') == -1):
                                if (cctype.find('OneByte') != -1):
                                        cctype = re.sub('OneByteString$',
                                            'SeqOneByteString', cctype);
                                else:
                                        cctype = re.sub('String$',
                                            'SeqString', cctype);

                        if (cctype.find('OneByte') == -1):
                                cctype = re.sub('String$', 'TwoByteString',
                                    cctype);

                        if (not (cctype in klasses)):
                                cctype = re.sub('OneByte', '', cctype);
                                cctype = re.sub('TwoByte', '', cctype);

                #
                # Despite all that, some types have no corresponding class.
                #
                if (cctype in klasses):
                        typeclasses[type] = cctype;
                        if (cctype in checktypes):
                                del checktypes[cctype];

        if (len(checktypes) > 0):
                for klass in checktypes:
                        print('error: expected class \"%s\" not found' % klass);

                sys.exit(1);


#
# For a given macro call, pick apart the arguments and return an object
# describing the corresponding output constant.  See load_fields().
#
def parse_field(call):
        # Replace newlines with spaces.
        for ii in range(0, len(call)):
                if (call[ii] == '\n'):
                        call[ii] == ' ';

        idx = call.find('(');
        kind = call[0:idx];
        rest = call[idx + 1: len(call) - 1];
        args = re.split('\s*,\s*', rest);

        consts = [];

        if (kind == 'ACCESSORS' or kind == 'ACCESSORS_GCSAFE'):
                klass = args[0];
                field = args[1];
                dtype = args[2];
                offset = args[3];

                return ({
                    'name': 'class_%s__%s__%s' % (klass, field, dtype),
                    'value': '%s::%s' % (klass, offset)
                });

        assert(kind == 'SMI_ACCESSORS' or kind == 'ACCESSORS_TO_SMI');
        klass = args[0];
        field = args[1];
        offset = args[2];

        return ({
            'name': 'class_%s__%s__%s' % (klass, field, 'SMI'),
            'value': '%s::%s' % (klass, offset)
        });

#
# Load field offset information from objects-inl.h.
#
def load_fields():
        inlfilename = sys.argv[3];
        inlfile = open(inlfilename, 'r');

        #
        # Each class's fields and the corresponding offsets are described in the
        # source by calls to macros like "ACCESSORS" (and friends).  All we do
        # here is extract these macro invocations, taking into account that they
        # may span multiple lines and may contain nested parentheses.  We also
        # call parse_field() to pick apart the invocation.
        #
        prefixes = [ 'ACCESSORS', 'ACCESSORS_GCSAFE',
                     'SMI_ACCESSORS', 'ACCESSORS_TO_SMI' ];
        current = '';
        opens = 0;

        for line in inlfile:
                if (opens > 0):
                        # Continuation line
                        for ii in range(0, len(line)):
                                if (line[ii] == '('):
                                        opens += 1;
                                elif (line[ii] == ')'):
                                        opens -= 1;

                                if (opens == 0):
                                        break;

                        current += line[0:ii + 1];
                        continue;

                for prefix in prefixes:
                        if (not line.startswith(prefix + '(')):
                                continue;

                        if (len(current) > 0):
                                fields.append(parse_field(current));
                                current = '';

                        for ii in range(len(prefix), len(line)):
                                if (line[ii] == '('):
                                        opens += 1;
                                elif (line[ii] == ')'):
                                        opens -= 1;

                                if (opens == 0):
                                        break;

                        current += line[0:ii + 1];

        if (len(current) > 0):
                fields.append(parse_field(current));
                current = '';

        for body in extras_accessors:
                fields.append(parse_field('ACCESSORS(%s)' % body));

#
# Emit a block of constants.
#
def emit_set(out, consts):
        # Fix up overzealous parses.  This could be done inside the
        # parsers but as there are several, it's easiest to do it here.
        ws = re.compile('\s+')
        for const in consts:
                name = ws.sub('', const['name'])
                value = ws.sub('', str(const['value']))  # Can be a number.
                out.write('int v8dbg_%s = %s;\n' % (name, value))
        out.write('\n');

#
# Emit the whole output file.
#
def emit_config():
        out = file(sys.argv[1], 'w');

        out.write(header);

        out.write('/* miscellaneous constants */\n');
        emit_set(out, consts_misc);

        out.write('/* class type information */\n');
        consts = [];
        keys = typeclasses.keys();
        keys.sort();
        for typename in keys:
                klass = typeclasses[typename];
                consts.append({
                    'name': 'type_%s__%s' % (klass, typename),
                    'value': typename
                });

        emit_set(out, consts);

        out.write('/* class hierarchy information */\n');
        consts = [];
        keys = klasses.keys();
        keys.sort();
        for klassname in keys:
                pklass = klasses[klassname]['parent'];
                bklass = get_base_class(klassname);
                if (bklass != 'Object'):
                        continue;
                if (pklass == None):
                        continue;

                consts.append({
                    'name': 'parent_%s__%s' % (klassname, pklass),
                    'value': 0
                });

        emit_set(out, consts);

        out.write('/* field information */\n');
        emit_set(out, fields);

        out.write(footer);

if (len(sys.argv) < 4):
        print('usage: %s output.cc objects.h objects-inl.h' % sys.argv[0]);
        sys.exit(2);

load_objects();
load_fields();
emit_config();
node-v4.8.2/deps/v8/tools/generate-builtins-tests.py000755 000766 000024 00000010731 13070706735 022550 0ustar00iojsstaff000000 000000 #!/usr/bin/env python
# Copyright 2014 the V8 project authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

import json
import optparse
import os
import random
import shutil
import subprocess
import sys


BLACKLIST = [
  # Skip special d8 functions.
  "load", "os", "print", "read", "readline", "quit"
]


def GetRandomObject():
  return random.choice([
    "0", "1", "2.5", "0x1000", "\"string\"", "{foo: \"bar\"}", "[1, 2, 3]",
    "function() { return 0; }"
  ])


g_var_index = 0


def GetVars(result, num, first = []):
  global g_var_index
  variables = []
  for i in range(num):
    variables.append("__v_%d" % g_var_index)
    g_var_index += 1
  for var in variables:
    result.append("var %s = %s;" % (var, GetRandomObject()))
  return ", ".join(first + variables)


# Wraps |string| in try..catch.
def TryCatch(result, string, exception_behavior = ""):
  result.append("try { %s } catch(e) { %s }" % (string, exception_behavior))


def BuildTests(function, full_name, options):
  assert function["type"] == "function"
  global g_var_index
  g_var_index = 0
  result = ["// AUTO-GENERATED BY tools/generate-builtins-tests.py.\n"]
  result.append("// Function call test:")
  length = function["length"]
  TryCatch(result, "%s(%s);" % (full_name, GetVars(result, length)))

  if "prototype" in function:
    proto = function["prototype"]
    result.append("\n// Constructor test:")
    TryCatch(result,
             "var recv = new %s(%s);" % (full_name, GetVars(result, length)),
             "var recv = new Object();")

    getters = []
    methods = []
    for prop in proto:
      proto_property = proto[prop]
      proto_property_type = proto_property["type"]
      if proto_property_type == "getter":
        getters.append(proto_property)
        result.append("recv.__defineGetter__(\"%s\", "
                      "function() { return %s; });" %
                      (proto_property["name"], GetVars(result, 1)))
      if proto_property_type == "number":
        result.append("recv.__defineGetter__(\"%s\", "
                      "function() { return %s; });" %
                      (proto_property["name"], GetVars(result, 1)))
      if proto_property_type == "function":
        methods.append(proto_property)
    if getters:
      result.append("\n// Getter tests:")
      for getter in getters:
        result.append("print(recv.%s);" % getter["name"])
    if methods:
      result.append("\n// Method tests:")
      for method in methods:
        args = GetVars(result, method["length"], ["recv"])
        call = "%s.prototype.%s.call(%s)" % (full_name, method["name"], args)
        TryCatch(result, call)

  filename = os.path.join(options.outdir, "%s.js" % (full_name))
  with open(filename, "w") as f:
    f.write("\n".join(result))
    f.write("\n")


def VisitObject(obj, path, options):
  obj_type = obj["type"]
  obj_name = "%s%s" % (path, obj["name"])
  if obj_type == "function":
    BuildTests(obj, obj_name, options)
  if "properties" in obj:
    for prop_name in obj["properties"]:
      prop = obj["properties"][prop_name]
      VisitObject(prop, "%s." % (obj_name), options)


def ClearGeneratedFiles(options):
  if os.path.exists(options.outdir):
    shutil.rmtree(options.outdir)


def GenerateTests(options):
  ClearGeneratedFiles(options)  # Re-generate everything.
  output = subprocess.check_output(
      "%s %s" % (options.d8, options.script), shell=True).strip()
  objects = json.loads(output)

  os.makedirs(options.outdir)
  for obj_name in objects:
    if obj_name in BLACKLIST: continue
    obj = objects[obj_name]
    VisitObject(obj, "", options)


def BuildOptions():
  result = optparse.OptionParser()
  result.add_option("--d8", help="d8 binary to use",
                    default="out/ia32.release/d8")
  result.add_option("--outdir", help="directory where to place generated tests",
                    default="test/mjsunit/builtins-gen")
  result.add_option("--script", help="builtins detector script to run in d8",
                    default="tools/detect-builtins.js")
  return result


def Main():
  parser = BuildOptions()
  (options, args) = parser.parse_args()
  if len(args) != 1 or args[0] == "help":
    parser.print_help()
    return 1
  action = args[0]

  if action == "generate":
    GenerateTests(options)
    return 0

  if action == "clear":
    ClearGeneratedFiles(options)
    return 0

  print("Unknown action: %s" % action)
  parser.print_help()
  return 1


if __name__ == "__main__":
  sys.exit(Main())
node-v4.8.2/deps/v8/tools/generate-ten-powers.scm000644 000766 000024 00000024554 13070706735 022021 0ustar00iojsstaff000000 000000 ;; Copyright 2010 the V8 project authors. All rights reserved.
;; Redistribution and use in source and binary forms, with or without
;; modification, are permitted provided that the following conditions are
;; met:
;;
;;     * Redistributions of source code must retain the above copyright
;;       notice, this list of conditions and the following disclaimer.
;;     * Redistributions in binary form must reproduce the above
;;       copyright notice, this list of conditions and the following
;;       disclaimer in the documentation and/or other materials provided
;;       with the distribution.
;;     * Neither the name of Google Inc. nor the names of its
;;       contributors may be used to endorse or promote products derived
;;       from this software without specific prior written permission.
;;
;; THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
;; "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
;; LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
;; A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
;; OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
;; SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
;; LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
;; DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
;; THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
;; (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
;; OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

;; This is a Scheme script for the Bigloo compiler. Bigloo must be compiled with
;; support for bignums. The compilation of the script can be done as follows:
;;   bigloo -static-bigloo -o generate-ten-powers generate-ten-powers.scm
;;  
;; Generate approximations of 10^k.

(module gen-ten-powers
   (static (class Cached-Fast
	      v::bignum
	      e::bint
	      exact?::bool))
   (main my-main))


;;----------------bignum shifts -----------------------------------------------
(define (bit-lshbx::bignum x::bignum by::bint)
   (if (bignum by)))))

(define (bit-rshbx::bignum x::bignum by::bint)
   (if (bignum by)))))

;;----------------the actual power generation -------------------------------

;; e should be an indication. it might be too small.
(define (round-n-cut n e nb-bits)
   (define max-container (- (bit-lshbx #z1 nb-bits) 1))
   (define (round n)
      (case *round*
	 ((down) n)
	 ((up)
	  (+bx n
	       ;; with the -1 it will only round up if the cut off part is
	       ;; non-zero
	       (-bx (bit-lshbx #z1
			       (-fx (+fx e nb-bits) 1))
		    #z1)))
	 ((round)
	  (+bx n
	       (bit-lshbx #z1
			  (-fx (+fx e nb-bits) 2))))))
   (let* ((shift (-fx (+fx e nb-bits) 1))
	  (cut (bit-rshbx (round n) shift))
	  (exact? (=bx n (bit-lshbx cut shift))))
      (if (<=bx cut max-container)
	  (values cut e exact?)
	  (round-n-cut n (+fx e 1) nb-bits))))

(define (rounded-/bx x y)
   (case *round*
      ((down)  (/bx x y))
      ((up)    (+bx (/bx x y) #z1))
      ((round) (let ((tmp (/bx (*bx #z2 x) y)))
		  (if (zerobx? (remainderbx tmp #z2))
		      (/bx tmp #z2)
		      (+bx (/bx tmp #z2) #z1))))))

(define (generate-powers from to mantissa-size)
   (let* ((nb-bits mantissa-size)
	  (offset (- from))
	  (nb-elements (+ (- from) to 1))
	  (vec (make-vector nb-elements))
	  (max-container (- (bit-lshbx #z1 nb-bits) 1)))
      ;; the negative ones. 10^-1, 10^-2, etc.
      ;; We already know, that we can't be exact, so exact? will always be #f.
      ;; Basically we will have a ten^i that we will *10 at each iteration. We
      ;; want to create the matissa of 1/ten^i. However the mantissa must be
      ;; normalized (start with a 1). -> we have to shift the number.
      ;; We shift by multiplying with two^e. -> We encode two^e*(1/ten^i) ==
      ;;  two^e/ten^i.
      (let loop ((i 1)
		 (ten^i #z10)
		 (two^e #z1)
		 (e 0))
	 (unless (< (- i) from)
	    (if (>bx (/bx (*bx #z2 two^e) ten^i) max-container)
		;; another shift would make the number too big. We are
		;; hence normalized now.
		(begin
		   (vector-set! vec (-fx offset i)
				(instantiate::Cached-Fast
				   (v (rounded-/bx two^e ten^i))
				   (e (negfx e))
				   (exact? #f)))
		   (loop (+fx i 1) (*bx ten^i #z10) two^e e))
		(loop i ten^i (bit-lshbx two^e 1) (+fx e 1)))))
      ;; the positive ones 10^0, 10^1, etc.
      ;; start with 1.0. mantissa: 10...0 (1 followed by nb-bits-1 bits)
      ;;      -> e = -(nb-bits-1)
      ;; exact? is true when the container can still hold the complete 10^i
      (let loop ((i 0)
		 (n (bit-lshbx #z1 (-fx nb-bits 1)))
		 (e (-fx 1 nb-bits)))
	 (when (<= i to)
	    (receive (cut e exact?)
	       (round-n-cut n e nb-bits)
	       (vector-set! vec (+fx i offset)
			    (instantiate::Cached-Fast
			       (v cut)
			       (e e)
			       (exact? exact?)))
	       (loop (+fx i 1) (*bx n #z10) e))))
      vec))

(define (print-c powers from to struct-type
		 cache-name max-distance-name offset-name macro64)
   (define (display-power power k)
      (with-access::Cached-Fast power (v e exact?)
	 (let ((tmp-p (open-output-string)))
	    ;; really hackish way of getting the digits
	    (display (format "~x" v) tmp-p)
	    (let ((str (close-output-port tmp-p)))
	       (printf "  {~a(0x~a, ~a), ~a, ~a},\n"
		       macro64
		       (substring str 0 8)
		       (substring str 8 16)
		       e
		       k)))))
   (define (print-powers-reduced n)
      (print "static const " struct-type " " cache-name
	     "(" n ")"
	     "[] = {")
      (let loop ((i 0)
		 (nb-elements 0)
		 (last-e 0)
		 (max-distance 0))
	 (cond
	    ((>= i (vector-length powers))
	     (print "  };")
	     (print "static const int " max-distance-name "(" n ") = "
		 max-distance ";")
	     (print "// nb elements (" n "): " nb-elements))
	    (else
	     (let* ((power (vector-ref powers i))
		    (e (Cached-Fast-e power)))
	     (display-power power (+ i from))
	     (loop (+ i n)
		   (+ nb-elements 1)
		   e
		   (cond
		      ((=fx i 0) max-distance)
		      ((> (- e last-e) max-distance) (- e last-e))
		      (else max-distance))))))))
   (print "// Copyright 2010 the V8 project authors. All rights reserved.")
   (print "// ------------ GENERATED FILE ----------------")
   (print "// command used:")
   (print "// "
	  (apply string-append (map (lambda (str)
				       (string-append " " str))
				    *main-args*))
	  "  // NOLINT")
   (print)
   (print
    "// This file is intended to be included inside another .h or .cc files\n"
    "// with the following defines set:\n"
    "//  GRISU_CACHE_STRUCT: should expand to the name of a struct that will\n"
    "//   hold the cached powers of ten. Each entry will hold a 64-bit\n"
    "//   significand, a 16-bit signed binary exponent, and a 16-bit\n"
    "//   signed decimal exponent. Each entry will be constructed as follows:\n"
    "//      { significand, binary_exponent, decimal_exponent }.\n"
    "//  GRISU_CACHE_NAME(i): generates the name for the different caches.\n"
    "//   The parameter i will be a number in the range 1-20. A cache will\n"
    "//   hold every i'th element of a full cache. GRISU_CACHE_NAME(1) will\n"
    "//   thus hold all elements. The higher i the fewer elements it has.\n"
    "//   Ideally the user should only reference one cache and let the\n"
    "//   compiler remove the unused ones.\n"
    "//  GRISU_CACHE_MAX_DISTANCE(i): generates the name for the maximum\n"
    "//   binary exponent distance between all elements of a given cache.\n"
    "//  GRISU_CACHE_OFFSET: is used as variable name for the decimal\n"
    "//   exponent offset. It is equal to -cache[0].decimal_exponent.\n"
    "//  GRISU_UINT64_C: used to construct 64-bit values in a platform\n"
    "//   independent way. In order to encode 0x123456789ABCDEF0 the macro\n"
    "//   will be invoked as follows: GRISU_UINT64_C(0x12345678,9ABCDEF0).\n")
   (print)
   (print-powers-reduced 1)
   (print-powers-reduced 2)
   (print-powers-reduced 3)
   (print-powers-reduced 4)
   (print-powers-reduced 5)
   (print-powers-reduced 6)
   (print-powers-reduced 7)
   (print-powers-reduced 8)
   (print-powers-reduced 9)
   (print-powers-reduced 10)
   (print-powers-reduced 11)
   (print-powers-reduced 12)
   (print-powers-reduced 13)
   (print-powers-reduced 14)
   (print-powers-reduced 15)
   (print-powers-reduced 16)
   (print-powers-reduced 17)
   (print-powers-reduced 18)
   (print-powers-reduced 19)
   (print-powers-reduced 20)
   (print "static const int GRISU_CACHE_OFFSET = " (- from) ";"))

;;----------------main --------------------------------------------------------
(define *main-args* #f)
(define *mantissa-size* #f)
(define *dest* #f)
(define *round* #f)
(define *from* #f)
(define *to* #f)

(define (my-main args)
   (set! *main-args* args)
   (args-parse (cdr args)
      (section "Help")
      (("?") (args-parse-usage #f))
      ((("-h" "--help") (help "?, -h, --help" "This help message"))
       (args-parse-usage #f))
      (section "Misc")
      (("-o" ?file (help "The output file"))
       (set! *dest* file))
      (("--mantissa-size" ?size (help "Container-size in bits"))
       (set! *mantissa-size* (string->number size)))
      (("--round" ?direction (help "Round bignums (down, round or up)"))
       (set! *round* (string->symbol direction)))
      (("--from" ?from (help "start at 10^from"))
       (set! *from* (string->number from)))
      (("--to" ?to (help "go up to 10^to"))
       (set! *to* (string->number to)))
      (else
       (print "Illegal argument `" else "'. Usage:")
       (args-parse-usage #f)))
   (when (not *from*)
      (error "generate-ten-powers"
	     "Missing from"
	     #f))
   (when (not *to*)
      (error "generate-ten-powers"
	     "Missing to"
	     #f))
   (when (not *mantissa-size*)
      (error "generate-ten-powers"
	     "Missing mantissa size"
	     #f))
   (when (not (memv *round* '(up down round)))
      (error "generate-ten-powers"
	     "Missing round-method"
	     *round*))

   (let ((dividers (generate-powers *from* *to* *mantissa-size*))
	 (p (if (not *dest*)
		(current-output-port)
		(open-output-file *dest*))))
      (unwind-protect
	 (with-output-to-port p
	    (lambda ()
	       (print-c dividers *from* *to*
			"GRISU_CACHE_STRUCT" "GRISU_CACHE_NAME"
			"GRISU_CACHE_MAX_DISTANCE" "GRISU_CACHE_OFFSET"
			"GRISU_UINT64_C"
			)))
	 (if *dest*
	     (close-output-port p)))))
node-v4.8.2/deps/v8/tools/generate_shim_headers/000755 000766 000024 00000000000 13070706735 021715 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/v8/tools/grokdump.py000755 000766 000024 00000335511 13070706735 017625 0ustar00iojsstaff000000 000000 #!/usr/bin/env python
#
# Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

import BaseHTTPServer
import bisect
import cgi
import cmd
import codecs
import ctypes
import datetime
import disasm
import mmap
import optparse
import os
import re
import sys
import types
import urllib
import urlparse
import v8heapconst
import webbrowser

PORT_NUMBER = 8081


USAGE="""usage: %prog [OPTIONS] [DUMP-FILE]

Minidump analyzer.

Shows the processor state at the point of exception including the
stack of the active thread and the referenced objects in the V8
heap. Code objects are disassembled and the addresses linked from the
stack (e.g. pushed return addresses) are marked with "=>".

Examples:
  $ %prog 12345678-1234-1234-1234-123456789abcd-full.dmp"""


DEBUG=False


def DebugPrint(s):
  if not DEBUG: return
  print s


class Descriptor(object):
  """Descriptor of a structure in a memory."""

  def __init__(self, fields):
    self.fields = fields
    self.is_flexible = False
    for _, type_or_func in fields:
      if isinstance(type_or_func, types.FunctionType):
        self.is_flexible = True
        break
    if not self.is_flexible:
      self.ctype = Descriptor._GetCtype(fields)
      self.size = ctypes.sizeof(self.ctype)

  def Read(self, memory, offset):
    if self.is_flexible:
      fields_copy = self.fields[:]
      last = 0
      for name, type_or_func in fields_copy:
        if isinstance(type_or_func, types.FunctionType):
          partial_ctype = Descriptor._GetCtype(fields_copy[:last])
          partial_object = partial_ctype.from_buffer(memory, offset)
          type = type_or_func(partial_object)
          if type is not None:
            fields_copy[last] = (name, type)
            last += 1
        else:
          last += 1
      complete_ctype = Descriptor._GetCtype(fields_copy[:last])
    else:
      complete_ctype = self.ctype
    return complete_ctype.from_buffer(memory, offset)

  @staticmethod
  def _GetCtype(fields):
    class Raw(ctypes.Structure):
      _fields_ = fields
      _pack_ = 1

      def __str__(self):
        return "{" + ", ".join("%s: %s" % (field, self.__getattribute__(field))
                               for field, _ in Raw._fields_) + "}"
    return Raw


def FullDump(reader, heap):
  """Dump all available memory regions."""
  def dump_region(reader, start, size, location):
    print
    while start & 3 != 0:
      start += 1
      size -= 1
      location += 1
    is_executable = reader.IsProbableExecutableRegion(location, size)
    is_ascii = reader.IsProbableASCIIRegion(location, size)

    if is_executable is not False:
      lines = reader.GetDisasmLines(start, size)
      for line in lines:
        print FormatDisasmLine(start, heap, line)
      print

    if is_ascii is not False:
      # Output in the same format as the Unix hd command
      addr = start
      for i in xrange(0, size, 16):
        slot = i + location
        hex_line = ""
        asc_line = ""
        for i in xrange(16):
          if slot + i < location + size:
            byte = ctypes.c_uint8.from_buffer(reader.minidump, slot + i).value
            if byte >= 0x20 and byte < 0x7f:
              asc_line += chr(byte)
            else:
              asc_line += "."
            hex_line += " %02x" % (byte)
          else:
            hex_line += "   "
          if i == 7:
            hex_line += " "
        print "%s  %s |%s|" % (reader.FormatIntPtr(addr),
                               hex_line,
                               asc_line)
        addr += 16

    if is_executable is not True and is_ascii is not True:
      print "%s - %s" % (reader.FormatIntPtr(start),
                         reader.FormatIntPtr(start + size))
      print start + size + 1;
      for i in xrange(0, size, reader.PointerSize()):
        slot = start + i
        maybe_address = reader.ReadUIntPtr(slot)
        heap_object = heap.FindObject(maybe_address)
        print "%s: %s" % (reader.FormatIntPtr(slot),
                          reader.FormatIntPtr(maybe_address))
        if heap_object:
          heap_object.Print(Printer())
          print

  reader.ForEachMemoryRegion(dump_region)

# Heap constants generated by 'make grokdump' in v8heapconst module.
INSTANCE_TYPES = v8heapconst.INSTANCE_TYPES
KNOWN_MAPS = v8heapconst.KNOWN_MAPS
KNOWN_OBJECTS = v8heapconst.KNOWN_OBJECTS

# Set of structures and constants that describe the layout of minidump
# files. Based on MSDN and Google Breakpad.

MINIDUMP_HEADER = Descriptor([
  ("signature", ctypes.c_uint32),
  ("version", ctypes.c_uint32),
  ("stream_count", ctypes.c_uint32),
  ("stream_directories_rva", ctypes.c_uint32),
  ("checksum", ctypes.c_uint32),
  ("time_date_stampt", ctypes.c_uint32),
  ("flags", ctypes.c_uint64)
])

MINIDUMP_LOCATION_DESCRIPTOR = Descriptor([
  ("data_size", ctypes.c_uint32),
  ("rva", ctypes.c_uint32)
])

MINIDUMP_STRING = Descriptor([
  ("length", ctypes.c_uint32),
  ("buffer", lambda t: ctypes.c_uint8 * (t.length + 2))
])

MINIDUMP_DIRECTORY = Descriptor([
  ("stream_type", ctypes.c_uint32),
  ("location", MINIDUMP_LOCATION_DESCRIPTOR.ctype)
])

MD_EXCEPTION_MAXIMUM_PARAMETERS = 15

MINIDUMP_EXCEPTION = Descriptor([
  ("code", ctypes.c_uint32),
  ("flags", ctypes.c_uint32),
  ("record", ctypes.c_uint64),
  ("address", ctypes.c_uint64),
  ("parameter_count", ctypes.c_uint32),
  ("unused_alignment", ctypes.c_uint32),
  ("information", ctypes.c_uint64 * MD_EXCEPTION_MAXIMUM_PARAMETERS)
])

MINIDUMP_EXCEPTION_STREAM = Descriptor([
  ("thread_id", ctypes.c_uint32),
  ("unused_alignment", ctypes.c_uint32),
  ("exception", MINIDUMP_EXCEPTION.ctype),
  ("thread_context", MINIDUMP_LOCATION_DESCRIPTOR.ctype)
])

# Stream types.
MD_UNUSED_STREAM = 0
MD_RESERVED_STREAM_0 = 1
MD_RESERVED_STREAM_1 = 2
MD_THREAD_LIST_STREAM = 3
MD_MODULE_LIST_STREAM = 4
MD_MEMORY_LIST_STREAM = 5
MD_EXCEPTION_STREAM = 6
MD_SYSTEM_INFO_STREAM = 7
MD_THREAD_EX_LIST_STREAM = 8
MD_MEMORY_64_LIST_STREAM = 9
MD_COMMENT_STREAM_A = 10
MD_COMMENT_STREAM_W = 11
MD_HANDLE_DATA_STREAM = 12
MD_FUNCTION_TABLE_STREAM = 13
MD_UNLOADED_MODULE_LIST_STREAM = 14
MD_MISC_INFO_STREAM = 15
MD_MEMORY_INFO_LIST_STREAM = 16
MD_THREAD_INFO_LIST_STREAM = 17
MD_HANDLE_OPERATION_LIST_STREAM = 18

MD_FLOATINGSAVEAREA_X86_REGISTERAREA_SIZE = 80

MINIDUMP_FLOATING_SAVE_AREA_X86 = Descriptor([
  ("control_word", ctypes.c_uint32),
  ("status_word", ctypes.c_uint32),
  ("tag_word", ctypes.c_uint32),
  ("error_offset", ctypes.c_uint32),
  ("error_selector", ctypes.c_uint32),
  ("data_offset", ctypes.c_uint32),
  ("data_selector", ctypes.c_uint32),
  ("register_area", ctypes.c_uint8 * MD_FLOATINGSAVEAREA_X86_REGISTERAREA_SIZE),
  ("cr0_npx_state", ctypes.c_uint32)
])

MD_CONTEXT_X86_EXTENDED_REGISTERS_SIZE = 512

# Context flags.
MD_CONTEXT_X86 = 0x00010000
MD_CONTEXT_X86_CONTROL = (MD_CONTEXT_X86 | 0x00000001)
MD_CONTEXT_X86_INTEGER = (MD_CONTEXT_X86 | 0x00000002)
MD_CONTEXT_X86_SEGMENTS = (MD_CONTEXT_X86 | 0x00000004)
MD_CONTEXT_X86_FLOATING_POINT = (MD_CONTEXT_X86 | 0x00000008)
MD_CONTEXT_X86_DEBUG_REGISTERS = (MD_CONTEXT_X86 | 0x00000010)
MD_CONTEXT_X86_EXTENDED_REGISTERS = (MD_CONTEXT_X86 | 0x00000020)

def EnableOnFlag(type, flag):
  return lambda o: [None, type][int((o.context_flags & flag) != 0)]

MINIDUMP_CONTEXT_X86 = Descriptor([
  ("context_flags", ctypes.c_uint32),
  # MD_CONTEXT_X86_DEBUG_REGISTERS.
  ("dr0", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_X86_DEBUG_REGISTERS)),
  ("dr1", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_X86_DEBUG_REGISTERS)),
  ("dr2", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_X86_DEBUG_REGISTERS)),
  ("dr3", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_X86_DEBUG_REGISTERS)),
  ("dr6", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_X86_DEBUG_REGISTERS)),
  ("dr7", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_X86_DEBUG_REGISTERS)),
  # MD_CONTEXT_X86_FLOATING_POINT.
  ("float_save", EnableOnFlag(MINIDUMP_FLOATING_SAVE_AREA_X86.ctype,
                              MD_CONTEXT_X86_FLOATING_POINT)),
  # MD_CONTEXT_X86_SEGMENTS.
  ("gs", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_X86_SEGMENTS)),
  ("fs", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_X86_SEGMENTS)),
  ("es", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_X86_SEGMENTS)),
  ("ds", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_X86_SEGMENTS)),
  # MD_CONTEXT_X86_INTEGER.
  ("edi", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_X86_INTEGER)),
  ("esi", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_X86_INTEGER)),
  ("ebx", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_X86_INTEGER)),
  ("edx", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_X86_INTEGER)),
  ("ecx", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_X86_INTEGER)),
  ("eax", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_X86_INTEGER)),
  # MD_CONTEXT_X86_CONTROL.
  ("ebp", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_X86_CONTROL)),
  ("eip", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_X86_CONTROL)),
  ("cs", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_X86_CONTROL)),
  ("eflags", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_X86_CONTROL)),
  ("esp", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_X86_CONTROL)),
  ("ss", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_X86_CONTROL)),
  # MD_CONTEXT_X86_EXTENDED_REGISTERS.
  ("extended_registers",
   EnableOnFlag(ctypes.c_uint8 * MD_CONTEXT_X86_EXTENDED_REGISTERS_SIZE,
                MD_CONTEXT_X86_EXTENDED_REGISTERS))
])

MD_CONTEXT_ARM = 0x40000000
MD_CONTEXT_ARM_INTEGER = (MD_CONTEXT_ARM | 0x00000002)
MD_CONTEXT_ARM_FLOATING_POINT = (MD_CONTEXT_ARM | 0x00000004)
MD_FLOATINGSAVEAREA_ARM_FPR_COUNT = 32
MD_FLOATINGSAVEAREA_ARM_FPEXTRA_COUNT = 8

MINIDUMP_FLOATING_SAVE_AREA_ARM = Descriptor([
  ("fpscr", ctypes.c_uint64),
  ("regs", ctypes.c_uint64 * MD_FLOATINGSAVEAREA_ARM_FPR_COUNT),
  ("extra", ctypes.c_uint64 * MD_FLOATINGSAVEAREA_ARM_FPEXTRA_COUNT)
])

MINIDUMP_CONTEXT_ARM = Descriptor([
  ("context_flags", ctypes.c_uint32),
  # MD_CONTEXT_ARM_INTEGER.
  ("r0", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_ARM_INTEGER)),
  ("r1", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_ARM_INTEGER)),
  ("r2", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_ARM_INTEGER)),
  ("r3", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_ARM_INTEGER)),
  ("r4", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_ARM_INTEGER)),
  ("r5", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_ARM_INTEGER)),
  ("r6", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_ARM_INTEGER)),
  ("r7", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_ARM_INTEGER)),
  ("r8", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_ARM_INTEGER)),
  ("r9", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_ARM_INTEGER)),
  ("r10", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_ARM_INTEGER)),
  ("r11", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_ARM_INTEGER)),
  ("r12", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_ARM_INTEGER)),
  ("sp", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_ARM_INTEGER)),
  ("lr", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_ARM_INTEGER)),
  ("pc", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_ARM_INTEGER)),
  ("cpsr", ctypes.c_uint32),
  ("float_save", EnableOnFlag(MINIDUMP_FLOATING_SAVE_AREA_ARM.ctype,
                              MD_CONTEXT_ARM_FLOATING_POINT))
])


MD_CONTEXT_ARM64 =  0x80000000
MD_CONTEXT_ARM64_INTEGER = (MD_CONTEXT_ARM64 | 0x00000002)
MD_CONTEXT_ARM64_FLOATING_POINT = (MD_CONTEXT_ARM64 | 0x00000004)
MD_FLOATINGSAVEAREA_ARM64_FPR_COUNT = 64

MINIDUMP_FLOATING_SAVE_AREA_ARM = Descriptor([
  ("fpscr", ctypes.c_uint64),
  ("regs", ctypes.c_uint64 * MD_FLOATINGSAVEAREA_ARM64_FPR_COUNT),
])

MINIDUMP_CONTEXT_ARM64 = Descriptor([
  ("context_flags", ctypes.c_uint64),
  # MD_CONTEXT_ARM64_INTEGER.
  ("r0", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_ARM64_INTEGER)),
  ("r1", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_ARM64_INTEGER)),
  ("r2", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_ARM64_INTEGER)),
  ("r3", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_ARM64_INTEGER)),
  ("r4", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_ARM64_INTEGER)),
  ("r5", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_ARM64_INTEGER)),
  ("r6", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_ARM64_INTEGER)),
  ("r7", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_ARM64_INTEGER)),
  ("r8", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_ARM64_INTEGER)),
  ("r9", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_ARM64_INTEGER)),
  ("r10", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_ARM64_INTEGER)),
  ("r11", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_ARM64_INTEGER)),
  ("r12", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_ARM64_INTEGER)),
  ("r13", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_ARM64_INTEGER)),
  ("r14", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_ARM64_INTEGER)),
  ("r15", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_ARM64_INTEGER)),
  ("r16", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_ARM64_INTEGER)),
  ("r17", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_ARM64_INTEGER)),
  ("r18", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_ARM64_INTEGER)),
  ("r19", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_ARM64_INTEGER)),
  ("r20", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_ARM64_INTEGER)),
  ("r21", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_ARM64_INTEGER)),
  ("r22", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_ARM64_INTEGER)),
  ("r23", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_ARM64_INTEGER)),
  ("r24", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_ARM64_INTEGER)),
  ("r25", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_ARM64_INTEGER)),
  ("r26", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_ARM64_INTEGER)),
  ("r27", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_ARM64_INTEGER)),
  ("r28", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_ARM64_INTEGER)),
  ("fp", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_ARM64_INTEGER)),
  ("lr", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_ARM64_INTEGER)),
  ("sp", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_ARM64_INTEGER)),
  ("pc", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_ARM64_INTEGER)),
  ("cpsr", ctypes.c_uint32),
  ("float_save", EnableOnFlag(MINIDUMP_FLOATING_SAVE_AREA_ARM.ctype,
                              MD_CONTEXT_ARM64_FLOATING_POINT))
])


MD_CONTEXT_AMD64 = 0x00100000
MD_CONTEXT_AMD64_CONTROL = (MD_CONTEXT_AMD64 | 0x00000001)
MD_CONTEXT_AMD64_INTEGER = (MD_CONTEXT_AMD64 | 0x00000002)
MD_CONTEXT_AMD64_SEGMENTS = (MD_CONTEXT_AMD64 | 0x00000004)
MD_CONTEXT_AMD64_FLOATING_POINT = (MD_CONTEXT_AMD64 | 0x00000008)
MD_CONTEXT_AMD64_DEBUG_REGISTERS = (MD_CONTEXT_AMD64 | 0x00000010)

MINIDUMP_CONTEXT_AMD64 = Descriptor([
  ("p1_home", ctypes.c_uint64),
  ("p2_home", ctypes.c_uint64),
  ("p3_home", ctypes.c_uint64),
  ("p4_home", ctypes.c_uint64),
  ("p5_home", ctypes.c_uint64),
  ("p6_home", ctypes.c_uint64),
  ("context_flags", ctypes.c_uint32),
  ("mx_csr", ctypes.c_uint32),
  # MD_CONTEXT_AMD64_CONTROL.
  ("cs", EnableOnFlag(ctypes.c_uint16, MD_CONTEXT_AMD64_CONTROL)),
  # MD_CONTEXT_AMD64_SEGMENTS
  ("ds", EnableOnFlag(ctypes.c_uint16, MD_CONTEXT_AMD64_SEGMENTS)),
  ("es", EnableOnFlag(ctypes.c_uint16, MD_CONTEXT_AMD64_SEGMENTS)),
  ("fs", EnableOnFlag(ctypes.c_uint16, MD_CONTEXT_AMD64_SEGMENTS)),
  ("gs", EnableOnFlag(ctypes.c_uint16, MD_CONTEXT_AMD64_SEGMENTS)),
  # MD_CONTEXT_AMD64_CONTROL.
  ("ss", EnableOnFlag(ctypes.c_uint16, MD_CONTEXT_AMD64_CONTROL)),
  ("eflags", EnableOnFlag(ctypes.c_uint32, MD_CONTEXT_AMD64_CONTROL)),
  # MD_CONTEXT_AMD64_DEBUG_REGISTERS.
  ("dr0", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_AMD64_DEBUG_REGISTERS)),
  ("dr1", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_AMD64_DEBUG_REGISTERS)),
  ("dr2", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_AMD64_DEBUG_REGISTERS)),
  ("dr3", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_AMD64_DEBUG_REGISTERS)),
  ("dr6", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_AMD64_DEBUG_REGISTERS)),
  ("dr7", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_AMD64_DEBUG_REGISTERS)),
  # MD_CONTEXT_AMD64_INTEGER.
  ("rax", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_AMD64_INTEGER)),
  ("rcx", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_AMD64_INTEGER)),
  ("rdx", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_AMD64_INTEGER)),
  ("rbx", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_AMD64_INTEGER)),
  # MD_CONTEXT_AMD64_CONTROL.
  ("rsp", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_AMD64_CONTROL)),
  # MD_CONTEXT_AMD64_INTEGER.
  ("rbp", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_AMD64_INTEGER)),
  ("rsi", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_AMD64_INTEGER)),
  ("rdi", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_AMD64_INTEGER)),
  ("r8", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_AMD64_INTEGER)),
  ("r9", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_AMD64_INTEGER)),
  ("r10", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_AMD64_INTEGER)),
  ("r11", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_AMD64_INTEGER)),
  ("r12", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_AMD64_INTEGER)),
  ("r13", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_AMD64_INTEGER)),
  ("r14", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_AMD64_INTEGER)),
  ("r15", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_AMD64_INTEGER)),
  # MD_CONTEXT_AMD64_CONTROL.
  ("rip", EnableOnFlag(ctypes.c_uint64, MD_CONTEXT_AMD64_CONTROL)),
  # MD_CONTEXT_AMD64_FLOATING_POINT
  ("sse_registers", EnableOnFlag(ctypes.c_uint8 * (16 * 26),
                                 MD_CONTEXT_AMD64_FLOATING_POINT)),
  ("vector_registers", EnableOnFlag(ctypes.c_uint8 * (16 * 26),
                                    MD_CONTEXT_AMD64_FLOATING_POINT)),
  ("vector_control", EnableOnFlag(ctypes.c_uint64,
                                  MD_CONTEXT_AMD64_FLOATING_POINT)),
  # MD_CONTEXT_AMD64_DEBUG_REGISTERS.
  ("debug_control", EnableOnFlag(ctypes.c_uint64,
                                 MD_CONTEXT_AMD64_DEBUG_REGISTERS)),
  ("last_branch_to_rip", EnableOnFlag(ctypes.c_uint64,
                                      MD_CONTEXT_AMD64_DEBUG_REGISTERS)),
  ("last_branch_from_rip", EnableOnFlag(ctypes.c_uint64,
                                        MD_CONTEXT_AMD64_DEBUG_REGISTERS)),
  ("last_exception_to_rip", EnableOnFlag(ctypes.c_uint64,
                                         MD_CONTEXT_AMD64_DEBUG_REGISTERS)),
  ("last_exception_from_rip", EnableOnFlag(ctypes.c_uint64,
                                           MD_CONTEXT_AMD64_DEBUG_REGISTERS))
])

MINIDUMP_MEMORY_DESCRIPTOR = Descriptor([
  ("start", ctypes.c_uint64),
  ("memory", MINIDUMP_LOCATION_DESCRIPTOR.ctype)
])

MINIDUMP_MEMORY_DESCRIPTOR64 = Descriptor([
  ("start", ctypes.c_uint64),
  ("size", ctypes.c_uint64)
])

MINIDUMP_MEMORY_LIST = Descriptor([
  ("range_count", ctypes.c_uint32),
  ("ranges", lambda m: MINIDUMP_MEMORY_DESCRIPTOR.ctype * m.range_count)
])

MINIDUMP_MEMORY_LIST_Mac = Descriptor([
  ("range_count", ctypes.c_uint32),
  ("junk", ctypes.c_uint32),
  ("ranges", lambda m: MINIDUMP_MEMORY_DESCRIPTOR.ctype * m.range_count)
])

MINIDUMP_MEMORY_LIST64 = Descriptor([
  ("range_count", ctypes.c_uint64),
  ("base_rva", ctypes.c_uint64),
  ("ranges", lambda m: MINIDUMP_MEMORY_DESCRIPTOR64.ctype * m.range_count)
])

MINIDUMP_THREAD = Descriptor([
  ("id", ctypes.c_uint32),
  ("suspend_count", ctypes.c_uint32),
  ("priority_class", ctypes.c_uint32),
  ("priority", ctypes.c_uint32),
  ("ted", ctypes.c_uint64),
  ("stack", MINIDUMP_MEMORY_DESCRIPTOR.ctype),
  ("context", MINIDUMP_LOCATION_DESCRIPTOR.ctype)
])

MINIDUMP_THREAD_LIST = Descriptor([
  ("thread_count", ctypes.c_uint32),
  ("threads", lambda t: MINIDUMP_THREAD.ctype * t.thread_count)
])

MINIDUMP_THREAD_LIST_Mac = Descriptor([
  ("thread_count", ctypes.c_uint32),
  ("junk", ctypes.c_uint32),
  ("threads", lambda t: MINIDUMP_THREAD.ctype * t.thread_count)
])

MINIDUMP_VS_FIXEDFILEINFO = Descriptor([
  ("dwSignature", ctypes.c_uint32),
  ("dwStrucVersion", ctypes.c_uint32),
  ("dwFileVersionMS", ctypes.c_uint32),
  ("dwFileVersionLS", ctypes.c_uint32),
  ("dwProductVersionMS", ctypes.c_uint32),
  ("dwProductVersionLS", ctypes.c_uint32),
  ("dwFileFlagsMask", ctypes.c_uint32),
  ("dwFileFlags", ctypes.c_uint32),
  ("dwFileOS", ctypes.c_uint32),
  ("dwFileType", ctypes.c_uint32),
  ("dwFileSubtype", ctypes.c_uint32),
  ("dwFileDateMS", ctypes.c_uint32),
  ("dwFileDateLS", ctypes.c_uint32)
])

MINIDUMP_RAW_MODULE = Descriptor([
  ("base_of_image", ctypes.c_uint64),
  ("size_of_image", ctypes.c_uint32),
  ("checksum", ctypes.c_uint32),
  ("time_date_stamp", ctypes.c_uint32),
  ("module_name_rva", ctypes.c_uint32),
  ("version_info", MINIDUMP_VS_FIXEDFILEINFO.ctype),
  ("cv_record", MINIDUMP_LOCATION_DESCRIPTOR.ctype),
  ("misc_record", MINIDUMP_LOCATION_DESCRIPTOR.ctype),
  ("reserved0", ctypes.c_uint32 * 2),
  ("reserved1", ctypes.c_uint32 * 2)
])

MINIDUMP_MODULE_LIST = Descriptor([
  ("number_of_modules", ctypes.c_uint32),
  ("modules", lambda t: MINIDUMP_RAW_MODULE.ctype * t.number_of_modules)
])

MINIDUMP_MODULE_LIST_Mac = Descriptor([
  ("number_of_modules", ctypes.c_uint32),
  ("junk", ctypes.c_uint32),
  ("modules", lambda t: MINIDUMP_RAW_MODULE.ctype * t.number_of_modules)
])

MINIDUMP_RAW_SYSTEM_INFO = Descriptor([
  ("processor_architecture", ctypes.c_uint16)
])

MD_CPU_ARCHITECTURE_X86 = 0
MD_CPU_ARCHITECTURE_ARM = 5
MD_CPU_ARCHITECTURE_ARM64 = 0x8003
MD_CPU_ARCHITECTURE_AMD64 = 9

class FuncSymbol:
  def __init__(self, start, size, name):
    self.start = start
    self.end = self.start + size
    self.name = name

  def __cmp__(self, other):
    if isinstance(other, FuncSymbol):
      return self.start - other.start
    return self.start - other

  def Covers(self, addr):
    return (self.start <= addr) and (addr < self.end)

class MinidumpReader(object):
  """Minidump (.dmp) reader."""

  _HEADER_MAGIC = 0x504d444d

  def __init__(self, options, minidump_name):
    self.minidump_name = minidump_name
    self.minidump_file = open(minidump_name, "r")
    self.minidump = mmap.mmap(self.minidump_file.fileno(), 0, mmap.MAP_PRIVATE)
    self.header = MINIDUMP_HEADER.Read(self.minidump, 0)
    if self.header.signature != MinidumpReader._HEADER_MAGIC:
      print >>sys.stderr, "Warning: Unsupported minidump header magic!"
    DebugPrint(self.header)
    directories = []
    offset = self.header.stream_directories_rva
    for _ in xrange(self.header.stream_count):
      directories.append(MINIDUMP_DIRECTORY.Read(self.minidump, offset))
      offset += MINIDUMP_DIRECTORY.size
    self.arch = None
    self.exception = None
    self.exception_context = None
    self.memory_list = None
    self.memory_list64 = None
    self.module_list = None
    self.thread_map = {}

    self.symdir = options.symdir
    self.modules_with_symbols = []
    self.symbols = []

    # Find MDRawSystemInfo stream and determine arch.
    for d in directories:
      if d.stream_type == MD_SYSTEM_INFO_STREAM:
        system_info = MINIDUMP_RAW_SYSTEM_INFO.Read(
            self.minidump, d.location.rva)
        self.arch = system_info.processor_architecture
        assert self.arch in [MD_CPU_ARCHITECTURE_AMD64,
                             MD_CPU_ARCHITECTURE_ARM,
                             MD_CPU_ARCHITECTURE_ARM64,
                             MD_CPU_ARCHITECTURE_X86]
    assert not self.arch is None

    for d in directories:
      DebugPrint(d)
      if d.stream_type == MD_EXCEPTION_STREAM:
        self.exception = MINIDUMP_EXCEPTION_STREAM.Read(
          self.minidump, d.location.rva)
        DebugPrint(self.exception)
        if self.arch == MD_CPU_ARCHITECTURE_X86:
          self.exception_context = MINIDUMP_CONTEXT_X86.Read(
              self.minidump, self.exception.thread_context.rva)
        elif self.arch == MD_CPU_ARCHITECTURE_AMD64:
          self.exception_context = MINIDUMP_CONTEXT_AMD64.Read(
              self.minidump, self.exception.thread_context.rva)
        elif self.arch == MD_CPU_ARCHITECTURE_ARM:
          self.exception_context = MINIDUMP_CONTEXT_ARM.Read(
              self.minidump, self.exception.thread_context.rva)
        elif self.arch == MD_CPU_ARCHITECTURE_ARM64:
          self.exception_context = MINIDUMP_CONTEXT_ARM64.Read(
              self.minidump, self.exception.thread_context.rva)
        DebugPrint(self.exception_context)
      elif d.stream_type == MD_THREAD_LIST_STREAM:
        thread_list = MINIDUMP_THREAD_LIST.Read(self.minidump, d.location.rva)
        if ctypes.sizeof(thread_list) + 4 == d.location.data_size:
          thread_list = MINIDUMP_THREAD_LIST_Mac.Read(
              self.minidump, d.location.rva)
        assert ctypes.sizeof(thread_list) == d.location.data_size
        DebugPrint(thread_list)
        for thread in thread_list.threads:
          DebugPrint(thread)
          self.thread_map[thread.id] = thread
      elif d.stream_type == MD_MODULE_LIST_STREAM:
        assert self.module_list is None
        self.module_list = MINIDUMP_MODULE_LIST.Read(
          self.minidump, d.location.rva)
        if ctypes.sizeof(self.module_list) + 4 == d.location.data_size:
          self.module_list = MINIDUMP_MODULE_LIST_Mac.Read(
              self.minidump, d.location.rva)
        assert ctypes.sizeof(self.module_list) == d.location.data_size
        DebugPrint(self.module_list)
      elif d.stream_type == MD_MEMORY_LIST_STREAM:
        print >>sys.stderr, "Warning: This is not a full minidump!"
        assert self.memory_list is None
        self.memory_list = MINIDUMP_MEMORY_LIST.Read(
          self.minidump, d.location.rva)
        if ctypes.sizeof(self.memory_list) + 4 == d.location.data_size:
          self.memory_list = MINIDUMP_MEMORY_LIST_Mac.Read(
              self.minidump, d.location.rva)
        assert ctypes.sizeof(self.memory_list) == d.location.data_size
        DebugPrint(self.memory_list)
      elif d.stream_type == MD_MEMORY_64_LIST_STREAM:
        assert self.memory_list64 is None
        self.memory_list64 = MINIDUMP_MEMORY_LIST64.Read(
          self.minidump, d.location.rva)
        assert ctypes.sizeof(self.memory_list64) == d.location.data_size
        DebugPrint(self.memory_list64)

  def IsValidAddress(self, address):
    return self.FindLocation(address) is not None

  def ReadU8(self, address):
    location = self.FindLocation(address)
    return ctypes.c_uint8.from_buffer(self.minidump, location).value

  def ReadU32(self, address):
    location = self.FindLocation(address)
    return ctypes.c_uint32.from_buffer(self.minidump, location).value

  def ReadU64(self, address):
    location = self.FindLocation(address)
    return ctypes.c_uint64.from_buffer(self.minidump, location).value

  def ReadUIntPtr(self, address):
    if self.arch == MD_CPU_ARCHITECTURE_AMD64:
      return self.ReadU64(address)
    elif self.arch == MD_CPU_ARCHITECTURE_ARM:
      return self.ReadU32(address)
    elif self.arch == MD_CPU_ARCHITECTURE_ARM64:
      return self.ReadU64(address)
    elif self.arch == MD_CPU_ARCHITECTURE_X86:
      return self.ReadU32(address)

  def ReadBytes(self, address, size):
    location = self.FindLocation(address)
    return self.minidump[location:location + size]

  def _ReadWord(self, location):
    if self.arch == MD_CPU_ARCHITECTURE_AMD64:
      return ctypes.c_uint64.from_buffer(self.minidump, location).value
    elif self.arch == MD_CPU_ARCHITECTURE_ARM:
      return ctypes.c_uint32.from_buffer(self.minidump, location).value
    elif self.arch == MD_CPU_ARCHITECTURE_ARM64:
      return ctypes.c_uint64.from_buffer(self.minidump, location).value
    elif self.arch == MD_CPU_ARCHITECTURE_X86:
      return ctypes.c_uint32.from_buffer(self.minidump, location).value

  def IsProbableASCIIRegion(self, location, length):
    ascii_bytes = 0
    non_ascii_bytes = 0
    for i in xrange(length):
      loc = location + i
      byte = ctypes.c_uint8.from_buffer(self.minidump, loc).value
      if byte >= 0x7f:
        non_ascii_bytes += 1
      if byte < 0x20 and byte != 0:
        non_ascii_bytes += 1
      if byte < 0x7f and byte >= 0x20:
        ascii_bytes += 1
      if byte == 0xa:  # newline
        ascii_bytes += 1
    if ascii_bytes * 10 <= length:
      return False
    if length > 0 and ascii_bytes > non_ascii_bytes * 7:
      return True
    if ascii_bytes > non_ascii_bytes * 3:
      return None  # Maybe
    return False

  def IsProbableExecutableRegion(self, location, length):
    opcode_bytes = 0
    sixty_four = self.arch == MD_CPU_ARCHITECTURE_AMD64
    for i in xrange(length):
      loc = location + i
      byte = ctypes.c_uint8.from_buffer(self.minidump, loc).value
      if (byte == 0x8b or           # mov
          byte == 0x89 or           # mov reg-reg
          (byte & 0xf0) == 0x50 or  # push/pop
          (sixty_four and (byte & 0xf0) == 0x40) or  # rex prefix
          byte == 0xc3 or           # return
          byte == 0x74 or           # jeq
          byte == 0x84 or           # jeq far
          byte == 0x75 or           # jne
          byte == 0x85 or           # jne far
          byte == 0xe8 or           # call
          byte == 0xe9 or           # jmp far
          byte == 0xeb):            # jmp near
        opcode_bytes += 1
    opcode_percent = (opcode_bytes * 100) / length
    threshold = 20
    if opcode_percent > threshold + 2:
      return True
    if opcode_percent > threshold - 2:
      return None  # Maybe
    return False

  def FindRegion(self, addr):
    answer = [-1, -1]
    def is_in(reader, start, size, location):
      if addr >= start and addr < start + size:
        answer[0] = start
        answer[1] = size
    self.ForEachMemoryRegion(is_in)
    if answer[0] == -1:
      return None
    return answer

  def ForEachMemoryRegion(self, cb):
    if self.memory_list64 is not None:
      for r in self.memory_list64.ranges:
        location = self.memory_list64.base_rva + offset
        cb(self, r.start, r.size, location)
        offset += r.size

    if self.memory_list is not None:
      for r in self.memory_list.ranges:
        cb(self, r.start, r.memory.data_size, r.memory.rva)

  def FindWord(self, word, alignment=0):
    def search_inside_region(reader, start, size, location):
      location = (location + alignment) & ~alignment
      for i in xrange(size - self.PointerSize()):
        loc = location + i
        if reader._ReadWord(loc) == word:
          slot = start + (loc - location)
          print "%s: %s" % (reader.FormatIntPtr(slot),
                            reader.FormatIntPtr(word))
    self.ForEachMemoryRegion(search_inside_region)

  def FindWordList(self, word):
    aligned_res = []
    unaligned_res = []
    def search_inside_region(reader, start, size, location):
      for i in xrange(size - self.PointerSize()):
        loc = location + i
        if reader._ReadWord(loc) == word:
          slot = start + (loc - location)
          if slot % self.PointerSize() == 0:
            aligned_res.append(slot)
          else:
            unaligned_res.append(slot)
    self.ForEachMemoryRegion(search_inside_region)
    return (aligned_res, unaligned_res)

  def FindLocation(self, address):
    offset = 0
    if self.memory_list64 is not None:
      for r in self.memory_list64.ranges:
        if r.start <= address < r.start + r.size:
          return self.memory_list64.base_rva + offset + address - r.start
        offset += r.size
    if self.memory_list is not None:
      for r in self.memory_list.ranges:
        if r.start <= address < r.start + r.memory.data_size:
          return r.memory.rva + address - r.start
    return None

  def GetDisasmLines(self, address, size):
    def CountUndefinedInstructions(lines):
      pattern = ""
      return sum([line.count(pattern) for (ignore, line) in lines])

    location = self.FindLocation(address)
    if location is None: return []
    arch = None
    possible_objdump_flags = [""]
    if self.arch == MD_CPU_ARCHITECTURE_X86:
      arch = "ia32"
    elif self.arch == MD_CPU_ARCHITECTURE_ARM:
      arch = "arm"
      possible_objdump_flags = ["", "--disassembler-options=force-thumb"]
    elif self.arch == MD_CPU_ARCHITECTURE_ARM64:
      arch = "arm64"
      possible_objdump_flags = ["", "--disassembler-options=force-thumb"]
    elif self.arch == MD_CPU_ARCHITECTURE_AMD64:
      arch = "x64"
    results = [ disasm.GetDisasmLines(self.minidump_name,
                                     location,
                                     size,
                                     arch,
                                     False,
                                     objdump_flags)
                for objdump_flags in possible_objdump_flags ]
    return min(results, key=CountUndefinedInstructions)


  def Dispose(self):
    self.minidump.close()
    self.minidump_file.close()

  def ExceptionIP(self):
    if self.arch == MD_CPU_ARCHITECTURE_AMD64:
      return self.exception_context.rip
    elif self.arch == MD_CPU_ARCHITECTURE_ARM:
      return self.exception_context.pc
    elif self.arch == MD_CPU_ARCHITECTURE_ARM64:
      return self.exception_context.pc
    elif self.arch == MD_CPU_ARCHITECTURE_X86:
      return self.exception_context.eip

  def ExceptionSP(self):
    if self.arch == MD_CPU_ARCHITECTURE_AMD64:
      return self.exception_context.rsp
    elif self.arch == MD_CPU_ARCHITECTURE_ARM:
      return self.exception_context.sp
    elif self.arch == MD_CPU_ARCHITECTURE_ARM64:
      return self.exception_context.sp
    elif self.arch == MD_CPU_ARCHITECTURE_X86:
      return self.exception_context.esp

  def ExceptionFP(self):
    if self.arch == MD_CPU_ARCHITECTURE_AMD64:
      return self.exception_context.rbp
    elif self.arch == MD_CPU_ARCHITECTURE_ARM:
      return None
    elif self.arch == MD_CPU_ARCHITECTURE_ARM64:
      return self.exception_context.fp
    elif self.arch == MD_CPU_ARCHITECTURE_X86:
      return self.exception_context.ebp

  def FormatIntPtr(self, value):
    if self.arch == MD_CPU_ARCHITECTURE_AMD64:
      return "%016x" % value
    elif self.arch == MD_CPU_ARCHITECTURE_ARM:
      return "%08x" % value
    elif self.arch == MD_CPU_ARCHITECTURE_ARM64:
      return "%016x" % value
    elif self.arch == MD_CPU_ARCHITECTURE_X86:
      return "%08x" % value

  def PointerSize(self):
    if self.arch == MD_CPU_ARCHITECTURE_AMD64:
      return 8
    elif self.arch == MD_CPU_ARCHITECTURE_ARM:
      return 4
    elif self.arch == MD_CPU_ARCHITECTURE_ARM64:
      return 8
    elif self.arch == MD_CPU_ARCHITECTURE_X86:
      return 4

  def Register(self, name):
    return self.exception_context.__getattribute__(name)

  def ReadMinidumpString(self, rva):
    string = bytearray(MINIDUMP_STRING.Read(self.minidump, rva).buffer)
    string = string.decode("utf16")
    return string[0:len(string) - 1]

  # Load FUNC records from a BreakPad symbol file
  #
  #    http://code.google.com/p/google-breakpad/wiki/SymbolFiles
  #
  def _LoadSymbolsFrom(self, symfile, baseaddr):
    print "Loading symbols from %s" % (symfile)
    funcs = []
    with open(symfile) as f:
      for line in f:
        result = re.match(
            r"^FUNC ([a-f0-9]+) ([a-f0-9]+) ([a-f0-9]+) (.*)$", line)
        if result is not None:
          start = int(result.group(1), 16)
          size = int(result.group(2), 16)
          name = result.group(4).rstrip()
          bisect.insort_left(self.symbols,
                             FuncSymbol(baseaddr + start, size, name))
    print " ... done"

  def TryLoadSymbolsFor(self, modulename, module):
    try:
      symfile = os.path.join(self.symdir,
                             modulename.replace('.', '_') + ".pdb.sym")
      if os.path.isfile(symfile):
        self._LoadSymbolsFrom(symfile, module.base_of_image)
        self.modules_with_symbols.append(module)
    except Exception as e:
      print "  ... failure (%s)" % (e)

  # Returns true if address is covered by some module that has loaded symbols.
  def _IsInModuleWithSymbols(self, addr):
    for module in self.modules_with_symbols:
      start = module.base_of_image
      end = start + module.size_of_image
      if (start <= addr) and (addr < end):
        return True
    return False

  # Find symbol covering the given address and return its name in format
  #     +
  def FindSymbol(self, addr):
    if not self._IsInModuleWithSymbols(addr):
      return None

    i = bisect.bisect_left(self.symbols, addr)
    symbol = None
    if (0 < i) and self.symbols[i - 1].Covers(addr):
      symbol = self.symbols[i - 1]
    elif (i < len(self.symbols)) and self.symbols[i].Covers(addr):
      symbol = self.symbols[i]
    else:
      return None
    diff = addr - symbol.start
    return "%s+0x%x" % (symbol.name, diff)


class Printer(object):
  """Printer with indentation support."""

  def __init__(self):
    self.indent = 0

  def Indent(self):
    self.indent += 2

  def Dedent(self):
    self.indent -= 2

  def Print(self, string):
    print "%s%s" % (self._IndentString(), string)

  def PrintLines(self, lines):
    indent = self._IndentString()
    print "\n".join("%s%s" % (indent, line) for line in lines)

  def _IndentString(self):
    return self.indent * " "


ADDRESS_RE = re.compile(r"0x[0-9a-fA-F]+")


def FormatDisasmLine(start, heap, line):
  line_address = start + line[0]
  stack_slot = heap.stack_map.get(line_address)
  marker = "  "
  if stack_slot:
    marker = "=>"
  code = AnnotateAddresses(heap, line[1])

  # Compute the actual call target which the disassembler is too stupid
  # to figure out (it adds the call offset to the disassembly offset rather
  # than the absolute instruction address).
  if heap.reader.arch == MD_CPU_ARCHITECTURE_X86:
    if code.startswith("e8"):
      words = code.split()
      if len(words) > 6 and words[5] == "call":
        offset = int(words[4] + words[3] + words[2] + words[1], 16)
        target = (line_address + offset + 5) & 0xFFFFFFFF
        code = code.replace(words[6], "0x%08x" % target)
  # TODO(jkummerow): port this hack to ARM and x64.

  return "%s%08x %08x: %s" % (marker, line_address, line[0], code)


def AnnotateAddresses(heap, line):
  extra = []
  for m in ADDRESS_RE.finditer(line):
    maybe_address = int(m.group(0), 16)
    object = heap.FindObject(maybe_address)
    if not object: continue
    extra.append(str(object))
  if len(extra) == 0: return line
  return "%s  ;; %s" % (line, ", ".join(extra))


class HeapObject(object):
  def __init__(self, heap, map, address):
    self.heap = heap
    self.map = map
    self.address = address

  def Is(self, cls):
    return isinstance(self, cls)

  def Print(self, p):
    p.Print(str(self))

  def __str__(self):
    instance_type = "???"
    if self.map is not None:
      instance_type = INSTANCE_TYPES[self.map.instance_type]
    return "HeapObject(%s, %s)" % (self.heap.reader.FormatIntPtr(self.address),
                                   instance_type)

  def ObjectField(self, offset):
    field_value = self.heap.reader.ReadUIntPtr(self.address + offset)
    return self.heap.FindObjectOrSmi(field_value)

  def SmiField(self, offset):
    field_value = self.heap.reader.ReadUIntPtr(self.address + offset)
    if (field_value & 1) == 0:
      return field_value / 2
    return None


class Map(HeapObject):
  def Decode(self, offset, size, value):
    return (value >> offset) & ((1 << size) - 1)

  # Instance Sizes
  def InstanceSizesOffset(self):
    return self.heap.PointerSize()

  def InstanceSizeOffset(self):
    return self.InstanceSizesOffset()

  def InObjectProperties(self):
    return self.InstanceSizeOffset() + 1

  def PreAllocatedPropertyFields(self):
    return self.InObjectProperties() + 1

  def VisitorId(self):
    return self.PreAllocatedPropertyFields() + 1

  # Instance Attributes
  def InstanceAttributesOffset(self):
    return self.InstanceSizesOffset() + self.heap.IntSize()

  def InstanceTypeOffset(self):
    return self.InstanceAttributesOffset()

  def UnusedPropertyFieldsOffset(self):
    return self.InstanceTypeOffset() + 1

  def BitFieldOffset(self):
    return self.UnusedPropertyFieldsOffset() + 1

  def BitField2Offset(self):
    return self.BitFieldOffset() + 1

  # Other fields
  def PrototypeOffset(self):
    return self.InstanceAttributesOffset() + self.heap.IntSize()

  def ConstructorOffset(self):
    return self.PrototypeOffset() + self.heap.PointerSize()

  def TransitionsOrBackPointerOffset(self):
    return self.ConstructorOffset() + self.heap.PointerSize()

  def DescriptorsOffset(self):
    return self.TransitionsOrBackPointerOffset() + self.heap.PointerSize()

  def CodeCacheOffset(self):
    return self.DescriptorsOffset() + self.heap.PointerSize()

  def DependentCodeOffset(self):
    return self.CodeCacheOffset() + self.heap.PointerSize()

  def BitField3Offset(self):
    return self.DependentCodeOffset() + self.heap.PointerSize()

  def ReadByte(self, offset):
    return self.heap.reader.ReadU8(self.address + offset)

  def Print(self, p):
    p.Print("Map(%08x)" % (self.address))
    p.Print("- size: %d, inobject: %d, preallocated: %d, visitor: %d" % (
        self.ReadByte(self.InstanceSizeOffset()),
        self.ReadByte(self.InObjectProperties()),
        self.ReadByte(self.PreAllocatedPropertyFields()),
        self.VisitorId()))

    bitfield = self.ReadByte(self.BitFieldOffset())
    bitfield2 = self.ReadByte(self.BitField2Offset())
    p.Print("- %s, unused: %d, bf: %d, bf2: %d" % (
        INSTANCE_TYPES[self.ReadByte(self.InstanceTypeOffset())],
        self.ReadByte(self.UnusedPropertyFieldsOffset()),
        bitfield, bitfield2))

    p.Print("- kind: %s" % (self.Decode(3, 5, bitfield2)))

    bitfield3 = self.ObjectField(self.BitField3Offset())
    p.Print(
        "- EnumLength: %d NumberOfOwnDescriptors: %d OwnsDescriptors: %s" % (
            self.Decode(0, 11, bitfield3),
            self.Decode(11, 11, bitfield3),
            self.Decode(25, 1, bitfield3)))
    p.Print("- IsShared: %s" % (self.Decode(22, 1, bitfield3)))
    p.Print("- FunctionWithPrototype: %s" % (self.Decode(23, 1, bitfield3)))
    p.Print("- DictionaryMap: %s" % (self.Decode(24, 1, bitfield3)))

    descriptors = self.ObjectField(self.DescriptorsOffset())
    if descriptors.__class__ == FixedArray:
      DescriptorArray(descriptors).Print(p)
    else:
      p.Print("Descriptors: %s" % (descriptors))

    transitions = self.ObjectField(self.TransitionsOrBackPointerOffset())
    if transitions.__class__ == FixedArray:
      TransitionArray(transitions).Print(p)
    else:
      p.Print("TransitionsOrBackPointer: %s" % (transitions))

  def __init__(self, heap, map, address):
    HeapObject.__init__(self, heap, map, address)
    self.instance_type = \
        heap.reader.ReadU8(self.address + self.InstanceTypeOffset())


class String(HeapObject):
  def LengthOffset(self):
    # First word after the map is the hash, the second is the length.
    return self.heap.PointerSize() * 2

  def __init__(self, heap, map, address):
    HeapObject.__init__(self, heap, map, address)
    self.length = self.SmiField(self.LengthOffset())

  def GetChars(self):
    return "?string?"

  def Print(self, p):
    p.Print(str(self))

  def __str__(self):
    return "\"%s\"" % self.GetChars()


class SeqString(String):
  def CharsOffset(self):
    return self.heap.PointerSize() * 3

  def __init__(self, heap, map, address):
    String.__init__(self, heap, map, address)
    self.chars = heap.reader.ReadBytes(self.address + self.CharsOffset(),
                                       self.length)

  def GetChars(self):
    return self.chars


class ExternalString(String):
  # TODO(vegorov) fix ExternalString for X64 architecture
  RESOURCE_OFFSET = 12

  WEBKIT_RESOUCE_STRING_IMPL_OFFSET = 4
  WEBKIT_STRING_IMPL_CHARS_OFFSET = 8

  def __init__(self, heap, map, address):
    String.__init__(self, heap, map, address)
    reader = heap.reader
    self.resource = \
        reader.ReadU32(self.address + ExternalString.RESOURCE_OFFSET)
    self.chars = "?external string?"
    if not reader.IsValidAddress(self.resource): return
    string_impl_address = self.resource + \
        ExternalString.WEBKIT_RESOUCE_STRING_IMPL_OFFSET
    if not reader.IsValidAddress(string_impl_address): return
    string_impl = reader.ReadU32(string_impl_address)
    chars_ptr_address = string_impl + \
        ExternalString.WEBKIT_STRING_IMPL_CHARS_OFFSET
    if not reader.IsValidAddress(chars_ptr_address): return
    chars_ptr = reader.ReadU32(chars_ptr_address)
    if not reader.IsValidAddress(chars_ptr): return
    raw_chars = reader.ReadBytes(chars_ptr, 2 * self.length)
    self.chars = codecs.getdecoder("utf16")(raw_chars)[0]

  def GetChars(self):
    return self.chars


class ConsString(String):
  def LeftOffset(self):
    return self.heap.PointerSize() * 3

  def RightOffset(self):
    return self.heap.PointerSize() * 4

  def __init__(self, heap, map, address):
    String.__init__(self, heap, map, address)
    self.left = self.ObjectField(self.LeftOffset())
    self.right = self.ObjectField(self.RightOffset())

  def GetChars(self):
    try:
      return self.left.GetChars() + self.right.GetChars()
    except:
      return "***CAUGHT EXCEPTION IN GROKDUMP***"


class Oddball(HeapObject):
  # Should match declarations in objects.h
  KINDS = [
    "False",
    "True",
    "TheHole",
    "Null",
    "ArgumentMarker",
    "Undefined",
    "Other"
  ]

  def ToStringOffset(self):
    return self.heap.PointerSize()

  def ToNumberOffset(self):
    return self.ToStringOffset() + self.heap.PointerSize()

  def KindOffset(self):
    return self.ToNumberOffset() + self.heap.PointerSize()

  def __init__(self, heap, map, address):
    HeapObject.__init__(self, heap, map, address)
    self.to_string = self.ObjectField(self.ToStringOffset())
    self.kind = self.SmiField(self.KindOffset())

  def Print(self, p):
    p.Print(str(self))

  def __str__(self):
    if self.to_string:
      return "Oddball(%08x, <%s>)" % (self.address, str(self.to_string))
    else:
      kind = "???"
      if 0 <= self.kind < len(Oddball.KINDS):
        kind = Oddball.KINDS[self.kind]
      return "Oddball(%08x, kind=%s)" % (self.address, kind)


class FixedArray(HeapObject):
  def LengthOffset(self):
    return self.heap.PointerSize()

  def ElementsOffset(self):
    return self.heap.PointerSize() * 2

  def MemberOffset(self, i):
    return self.ElementsOffset() + self.heap.PointerSize() * i

  def Get(self, i):
    return self.ObjectField(self.MemberOffset(i))

  def __init__(self, heap, map, address):
    HeapObject.__init__(self, heap, map, address)
    self.length = self.SmiField(self.LengthOffset())

  def Print(self, p):
    p.Print("FixedArray(%s) {" % self.heap.reader.FormatIntPtr(self.address))
    p.Indent()
    p.Print("length: %d" % self.length)
    base_offset = self.ElementsOffset()
    for i in xrange(self.length):
      offset = base_offset + 4 * i
      try:
        p.Print("[%08d] = %s" % (i, self.ObjectField(offset)))
      except TypeError:
        p.Dedent()
        p.Print("...")
        p.Print("}")
        return
    p.Dedent()
    p.Print("}")

  def __str__(self):
    return "FixedArray(%08x, length=%d)" % (self.address, self.length)


class DescriptorArray(object):
  def __init__(self, array):
    self.array = array

  def Length(self):
    return self.array.Get(0)

  def Decode(self, offset, size, value):
    return (value >> offset) & ((1 << size) - 1)

  TYPES = [
      "normal",
      "field",
      "function",
      "callbacks"
  ]

  def Type(self, value):
    return DescriptorArray.TYPES[self.Decode(0, 3, value)]

  def Attributes(self, value):
    attributes = self.Decode(3, 3, value)
    result = []
    if (attributes & 0): result += ["ReadOnly"]
    if (attributes & 1): result += ["DontEnum"]
    if (attributes & 2): result += ["DontDelete"]
    return "[" + (",".join(result)) + "]"

  def Deleted(self, value):
    return self.Decode(6, 1, value) == 1

  def FieldIndex(self, value):
    return self.Decode(20, 11, value)

  def Pointer(self, value):
    return self.Decode(6, 11, value)

  def Details(self, di, value):
    return (
        di,
        self.Type(value),
        self.Attributes(value),
        self.FieldIndex(value),
        self.Pointer(value)
    )


  def Print(self, p):
    length = self.Length()
    array = self.array

    p.Print("Descriptors(%08x, length=%d)" % (array.address, length))
    p.Print("[et] %s" % (array.Get(1)))

    for di in xrange(length):
      i = 2 + di * 3
      p.Print("0x%x" % (array.address + array.MemberOffset(i)))
      p.Print("[%i] name:    %s" % (di, array.Get(i + 0)))
      p.Print("[%i] details: %s %s field-index %i pointer %i" % \
              self.Details(di, array.Get(i + 1)))
      p.Print("[%i] value:   %s" % (di, array.Get(i + 2)))

    end = self.array.length // 3
    if length != end:
      p.Print("[%i-%i] slack descriptors" % (length, end))


class TransitionArray(object):
  def __init__(self, array):
    self.array = array

  def IsSimpleTransition(self):
    return self.array.length <= 2

  def Length(self):
    # SimpleTransition cases
    if self.IsSimpleTransition():
      return self.array.length - 1
    return (self.array.length - 3) // 2

  def Print(self, p):
    length = self.Length()
    array = self.array

    p.Print("Transitions(%08x, length=%d)" % (array.address, length))
    p.Print("[backpointer] %s" % (array.Get(0)))
    if self.IsSimpleTransition():
      if length == 1:
        p.Print("[simple target] %s" % (array.Get(1)))
      return

    elements = array.Get(1)
    if elements is not None:
      p.Print("[elements   ] %s" % (elements))

    prototype = array.Get(2)
    if prototype is not None:
      p.Print("[prototype  ] %s" % (prototype))

    for di in xrange(length):
      i = 3 + di * 2
      p.Print("[%i] symbol: %s" % (di, array.Get(i + 0)))
      p.Print("[%i] target: %s" % (di, array.Get(i + 1)))


class JSFunction(HeapObject):
  def CodeEntryOffset(self):
    return 3 * self.heap.PointerSize()

  def SharedOffset(self):
    return 5 * self.heap.PointerSize()

  def __init__(self, heap, map, address):
    HeapObject.__init__(self, heap, map, address)
    code_entry = \
        heap.reader.ReadU32(self.address + self.CodeEntryOffset())
    self.code = heap.FindObject(code_entry - Code.HeaderSize(heap) + 1)
    self.shared = self.ObjectField(self.SharedOffset())

  def Print(self, p):
    source = "\n".join("  %s" % line for line in self._GetSource().split("\n"))
    p.Print("JSFunction(%s) {" % self.heap.reader.FormatIntPtr(self.address))
    p.Indent()
    p.Print("inferred name: %s" % self.shared.inferred_name)
    if self.shared.script.Is(Script) and self.shared.script.name.Is(String):
      p.Print("script name: %s" % self.shared.script.name)
    p.Print("source:")
    p.PrintLines(self._GetSource().split("\n"))
    p.Print("code:")
    self.code.Print(p)
    if self.code != self.shared.code:
      p.Print("unoptimized code:")
      self.shared.code.Print(p)
    p.Dedent()
    p.Print("}")

  def __str__(self):
    inferred_name = ""
    if self.shared is not None and self.shared.Is(SharedFunctionInfo):
      inferred_name = self.shared.inferred_name
    return "JSFunction(%s, %s) " % \
          (self.heap.reader.FormatIntPtr(self.address), inferred_name)

  def _GetSource(self):
    source = "?source?"
    start = self.shared.start_position
    end = self.shared.end_position
    if not self.shared.script.Is(Script): return source
    script_source = self.shared.script.source
    if not script_source.Is(String): return source
    if start and end:
      source = script_source.GetChars()[start:end]
    return source


class SharedFunctionInfo(HeapObject):
  def CodeOffset(self):
    return 2 * self.heap.PointerSize()

  def ScriptOffset(self):
    return 7 * self.heap.PointerSize()

  def InferredNameOffset(self):
    return 9 * self.heap.PointerSize()

  def EndPositionOffset(self):
    return 12 * self.heap.PointerSize() + 4 * self.heap.IntSize()

  def StartPositionAndTypeOffset(self):
    return 12 * self.heap.PointerSize() + 5 * self.heap.IntSize()

  def __init__(self, heap, map, address):
    HeapObject.__init__(self, heap, map, address)
    self.code = self.ObjectField(self.CodeOffset())
    self.script = self.ObjectField(self.ScriptOffset())
    self.inferred_name = self.ObjectField(self.InferredNameOffset())
    if heap.PointerSize() == 8:
      start_position_and_type = \
          heap.reader.ReadU32(self.StartPositionAndTypeOffset())
      self.start_position = start_position_and_type >> 2
      pseudo_smi_end_position = \
          heap.reader.ReadU32(self.EndPositionOffset())
      self.end_position = pseudo_smi_end_position >> 2
    else:
      start_position_and_type = \
          self.SmiField(self.StartPositionAndTypeOffset())
      if start_position_and_type:
        self.start_position = start_position_and_type >> 2
      else:
        self.start_position = None
      self.end_position = \
          self.SmiField(self.EndPositionOffset())


class Script(HeapObject):
  def SourceOffset(self):
    return self.heap.PointerSize()

  def NameOffset(self):
    return self.SourceOffset() + self.heap.PointerSize()

  def __init__(self, heap, map, address):
    HeapObject.__init__(self, heap, map, address)
    self.source = self.ObjectField(self.SourceOffset())
    self.name = self.ObjectField(self.NameOffset())


class CodeCache(HeapObject):
  def DefaultCacheOffset(self):
    return self.heap.PointerSize()

  def NormalTypeCacheOffset(self):
    return self.DefaultCacheOffset() + self.heap.PointerSize()

  def __init__(self, heap, map, address):
    HeapObject.__init__(self, heap, map, address)
    self.default_cache = self.ObjectField(self.DefaultCacheOffset())
    self.normal_type_cache = self.ObjectField(self.NormalTypeCacheOffset())

  def Print(self, p):
    p.Print("CodeCache(%s) {" % self.heap.reader.FormatIntPtr(self.address))
    p.Indent()
    p.Print("default cache: %s" % self.default_cache)
    p.Print("normal type cache: %s" % self.normal_type_cache)
    p.Dedent()
    p.Print("}")


class Code(HeapObject):
  CODE_ALIGNMENT_MASK = (1 << 5) - 1

  def InstructionSizeOffset(self):
    return self.heap.PointerSize()

  @staticmethod
  def HeaderSize(heap):
    return (heap.PointerSize() + heap.IntSize() + \
        4 * heap.PointerSize() + 3 * heap.IntSize() + \
        Code.CODE_ALIGNMENT_MASK) & ~Code.CODE_ALIGNMENT_MASK

  def __init__(self, heap, map, address):
    HeapObject.__init__(self, heap, map, address)
    self.entry = self.address + Code.HeaderSize(heap)
    self.instruction_size = \
        heap.reader.ReadU32(self.address + self.InstructionSizeOffset())

  def Print(self, p):
    lines = self.heap.reader.GetDisasmLines(self.entry, self.instruction_size)
    p.Print("Code(%s) {" % self.heap.reader.FormatIntPtr(self.address))
    p.Indent()
    p.Print("instruction_size: %d" % self.instruction_size)
    p.PrintLines(self._FormatLine(line) for line in lines)
    p.Dedent()
    p.Print("}")

  def _FormatLine(self, line):
    return FormatDisasmLine(self.entry, self.heap, line)


class V8Heap(object):
  CLASS_MAP = {
    "SYMBOL_TYPE": SeqString,
    "ONE_BYTE_SYMBOL_TYPE": SeqString,
    "CONS_SYMBOL_TYPE": ConsString,
    "CONS_ONE_BYTE_SYMBOL_TYPE": ConsString,
    "EXTERNAL_SYMBOL_TYPE": ExternalString,
    "EXTERNAL_SYMBOL_WITH_ONE_BYTE_DATA_TYPE": ExternalString,
    "EXTERNAL_ONE_BYTE_SYMBOL_TYPE": ExternalString,
    "SHORT_EXTERNAL_SYMBOL_TYPE": ExternalString,
    "SHORT_EXTERNAL_SYMBOL_WITH_ONE_BYTE_DATA_TYPE": ExternalString,
    "SHORT_EXTERNAL_ONE_BYTE_SYMBOL_TYPE": ExternalString,
    "STRING_TYPE": SeqString,
    "ONE_BYTE_STRING_TYPE": SeqString,
    "CONS_STRING_TYPE": ConsString,
    "CONS_ONE_BYTE_STRING_TYPE": ConsString,
    "EXTERNAL_STRING_TYPE": ExternalString,
    "EXTERNAL_STRING_WITH_ONE_BYTE_DATA_TYPE": ExternalString,
    "EXTERNAL_ONE_BYTE_STRING_TYPE": ExternalString,
    "MAP_TYPE": Map,
    "ODDBALL_TYPE": Oddball,
    "FIXED_ARRAY_TYPE": FixedArray,
    "JS_FUNCTION_TYPE": JSFunction,
    "SHARED_FUNCTION_INFO_TYPE": SharedFunctionInfo,
    "SCRIPT_TYPE": Script,
    "CODE_CACHE_TYPE": CodeCache,
    "CODE_TYPE": Code,
  }

  def __init__(self, reader, stack_map):
    self.reader = reader
    self.stack_map = stack_map
    self.objects = {}

  def FindObjectOrSmi(self, tagged_address):
    if (tagged_address & 1) == 0: return tagged_address / 2
    return self.FindObject(tagged_address)

  def FindObject(self, tagged_address):
    if tagged_address in self.objects:
      return self.objects[tagged_address]
    if (tagged_address & self.ObjectAlignmentMask()) != 1: return None
    address = tagged_address - 1
    if not self.reader.IsValidAddress(address): return None
    map_tagged_address = self.reader.ReadUIntPtr(address)
    if tagged_address == map_tagged_address:
      # Meta map?
      meta_map = Map(self, None, address)
      instance_type_name = INSTANCE_TYPES.get(meta_map.instance_type)
      if instance_type_name != "MAP_TYPE": return None
      meta_map.map = meta_map
      object = meta_map
    else:
      map = self.FindMap(map_tagged_address)
      if map is None: return None
      instance_type_name = INSTANCE_TYPES.get(map.instance_type)
      if instance_type_name is None: return None
      cls = V8Heap.CLASS_MAP.get(instance_type_name, HeapObject)
      object = cls(self, map, address)
    self.objects[tagged_address] = object
    return object

  def FindMap(self, tagged_address):
    if (tagged_address & self.MapAlignmentMask()) != 1: return None
    address = tagged_address - 1
    if not self.reader.IsValidAddress(address): return None
    object = Map(self, None, address)
    return object

  def IntSize(self):
    return 4

  def PointerSize(self):
    return self.reader.PointerSize()

  def ObjectAlignmentMask(self):
    return self.PointerSize() - 1

  def MapAlignmentMask(self):
    if self.reader.arch == MD_CPU_ARCHITECTURE_AMD64:
      return (1 << 4) - 1
    elif self.reader.arch == MD_CPU_ARCHITECTURE_ARM:
      return (1 << 4) - 1
    elif self.reader.arch == MD_CPU_ARCHITECTURE_ARM64:
      return (1 << 4) - 1
    elif self.reader.arch == MD_CPU_ARCHITECTURE_X86:
      return (1 << 5) - 1

  def PageAlignmentMask(self):
    return (1 << 20) - 1


class KnownObject(HeapObject):
  def __init__(self, heap, known_name):
    HeapObject.__init__(self, heap, None, None)
    self.known_name = known_name

  def __str__(self):
    return "<%s>" % self.known_name


class KnownMap(HeapObject):
  def __init__(self, heap, known_name, instance_type):
    HeapObject.__init__(self, heap, None, None)
    self.instance_type = instance_type
    self.known_name = known_name

  def __str__(self):
    return "<%s>" % self.known_name


COMMENT_RE = re.compile(r"^C (0x[0-9a-fA-F]+) (.*)$")
PAGEADDRESS_RE = re.compile(
    r"^P (mappage|oldpage) (0x[0-9a-fA-F]+)$")


class InspectionInfo(object):
  def __init__(self, minidump_name, reader):
    self.comment_file = minidump_name + ".comments"
    self.address_comments = {}
    self.page_address = {}
    if os.path.exists(self.comment_file):
      with open(self.comment_file, "r") as f:
        lines = f.readlines()
        f.close()

        for l in lines:
          m = COMMENT_RE.match(l)
          if m:
            self.address_comments[int(m.group(1), 0)] = m.group(2)
          m = PAGEADDRESS_RE.match(l)
          if m:
            self.page_address[m.group(1)] = int(m.group(2), 0)
    self.reader = reader
    self.styles = {}
    self.color_addresses()
    return

  def get_page_address(self, page_kind):
    return self.page_address.get(page_kind, 0)

  def save_page_address(self, page_kind, address):
    with open(self.comment_file, "a") as f:
      f.write("P %s 0x%x\n" % (page_kind, address))
      f.close()

  def color_addresses(self):
    # Color all stack addresses.
    exception_thread = self.reader.thread_map[self.reader.exception.thread_id]
    stack_top = self.reader.ExceptionSP()
    stack_bottom = exception_thread.stack.start + \
        exception_thread.stack.memory.data_size
    frame_pointer = self.reader.ExceptionFP()
    self.styles[frame_pointer] = "frame"
    for slot in xrange(stack_top, stack_bottom, self.reader.PointerSize()):
      self.styles[slot] = "stackaddress"
    for slot in xrange(stack_top, stack_bottom, self.reader.PointerSize()):
      maybe_address = self.reader.ReadUIntPtr(slot)
      self.styles[maybe_address] = "stackval"
      if slot == frame_pointer:
        self.styles[slot] = "frame"
        frame_pointer = maybe_address
    self.styles[self.reader.ExceptionIP()] = "pc"

  def get_style_class(self, address):
    return self.styles.get(address, None)

  def get_style_class_string(self, address):
    style = self.get_style_class(address)
    if style != None:
      return " class=\"%s\" " % style
    else:
      return ""

  def set_comment(self, address, comment):
    self.address_comments[address] = comment
    with open(self.comment_file, "a") as f:
      f.write("C 0x%x %s\n" % (address, comment))
      f.close()

  def get_comment(self, address):
    return self.address_comments.get(address, "")


class InspectionPadawan(object):
  """The padawan can improve annotations by sensing well-known objects."""
  def __init__(self, reader, heap):
    self.reader = reader
    self.heap = heap
    self.known_first_map_page = 0
    self.known_first_old_page = 0

  def __getattr__(self, name):
    """An InspectionPadawan can be used instead of V8Heap, even though
       it does not inherit from V8Heap (aka. mixin)."""
    return getattr(self.heap, name)

  def GetPageOffset(self, tagged_address):
    return tagged_address & self.heap.PageAlignmentMask()

  def IsInKnownMapSpace(self, tagged_address):
    page_address = tagged_address & ~self.heap.PageAlignmentMask()
    return page_address == self.known_first_map_page

  def IsInKnownOldSpace(self, tagged_address):
    page_address = tagged_address & ~self.heap.PageAlignmentMask()
    return page_address == self.known_first_old_page

  def ContainingKnownOldSpaceName(self, tagged_address):
    page_address = tagged_address & ~self.heap.PageAlignmentMask()
    if page_address == self.known_first_old_page: return "OLD_SPACE"
    return None

  def SenseObject(self, tagged_address):
    if self.IsInKnownOldSpace(tagged_address):
      offset = self.GetPageOffset(tagged_address)
      lookup_key = (self.ContainingKnownOldSpaceName(tagged_address), offset)
      known_obj_name = KNOWN_OBJECTS.get(lookup_key)
      if known_obj_name:
        return KnownObject(self, known_obj_name)
    if self.IsInKnownMapSpace(tagged_address):
      known_map = self.SenseMap(tagged_address)
      if known_map:
        return known_map
    found_obj = self.heap.FindObject(tagged_address)
    if found_obj: return found_obj
    address = tagged_address - 1
    if self.reader.IsValidAddress(address):
      map_tagged_address = self.reader.ReadUIntPtr(address)
      map = self.SenseMap(map_tagged_address)
      if map is None: return None
      instance_type_name = INSTANCE_TYPES.get(map.instance_type)
      if instance_type_name is None: return None
      cls = V8Heap.CLASS_MAP.get(instance_type_name, HeapObject)
      return cls(self, map, address)
    return None

  def SenseMap(self, tagged_address):
    if self.IsInKnownMapSpace(tagged_address):
      offset = self.GetPageOffset(tagged_address)
      known_map_info = KNOWN_MAPS.get(offset)
      if known_map_info:
        known_map_type, known_map_name = known_map_info
        return KnownMap(self, known_map_name, known_map_type)
    found_map = self.heap.FindMap(tagged_address)
    if found_map: return found_map
    return None

  def FindObjectOrSmi(self, tagged_address):
    """When used as a mixin in place of V8Heap."""
    found_obj = self.SenseObject(tagged_address)
    if found_obj: return found_obj
    if (tagged_address & 1) == 0:
      return "Smi(%d)" % (tagged_address / 2)
    else:
      return "Unknown(%s)" % self.reader.FormatIntPtr(tagged_address)

  def FindObject(self, tagged_address):
    """When used as a mixin in place of V8Heap."""
    raise NotImplementedError

  def FindMap(self, tagged_address):
    """When used as a mixin in place of V8Heap."""
    raise NotImplementedError

  def PrintKnowledge(self):
    print "  known_first_map_page = %s\n"\
          "  known_first_old_page = %s" % (
          self.reader.FormatIntPtr(self.known_first_map_page),
          self.reader.FormatIntPtr(self.known_first_old_page))

WEB_HEADER = """








Dump %(dump_name)s



  

    

      Context info   
      Dump info   
      Modules   
       
      
      
      
    

    

       
       
       
      
      
       
       
       
      Dumps...
    

  

  

  

"""


WEB_FOOTER = """


"""


class WebParameterError(Exception):
  def __init__(self, message):
    Exception.__init__(self, message)


class InspectionWebHandler(BaseHTTPServer.BaseHTTPRequestHandler):
  def formatter(self, query_components):
    name = query_components.get("dump", [None])[0]
    return self.server.get_dump_formatter(name)

  def send_success_html_headers(self):
    self.send_response(200)
    self.send_header("Cache-Control", "no-cache, no-store, must-revalidate")
    self.send_header("Pragma", "no-cache")
    self.send_header("Expires", "0")
    self.send_header('Content-type','text/html')
    self.end_headers()
    return

  def do_GET(self):
    try:
      parsedurl = urlparse.urlparse(self.path)
      query_components = urlparse.parse_qs(parsedurl.query)
      if parsedurl.path == "/dumps.html":
        self.send_success_html_headers()
        self.server.output_dumps(self.wfile)
      elif parsedurl.path == "/summary.html":
        self.send_success_html_headers()
        self.formatter(query_components).output_summary(self.wfile)
      elif parsedurl.path == "/info.html":
        self.send_success_html_headers()
        self.formatter(query_components).output_info(self.wfile)
      elif parsedurl.path == "/modules.html":
        self.send_success_html_headers()
        self.formatter(query_components).output_modules(self.wfile)
      elif parsedurl.path == "/search.html":
        address = query_components.get("val", [])
        if len(address) != 1:
          self.send_error(404, "Invalid params")
          return
        self.send_success_html_headers()
        self.formatter(query_components).output_search_res(
            self.wfile, address[0])
      elif parsedurl.path == "/disasm.html":
        address = query_components.get("val", [])
        exact = query_components.get("exact", ["on"])
        if len(address) != 1:
          self.send_error(404, "Invalid params")
          return
        self.send_success_html_headers()
        self.formatter(query_components).output_disasm(
            self.wfile, address[0], exact[0])
      elif parsedurl.path == "/data.html":
        address = query_components.get("val", [])
        datakind = query_components.get("type", ["address"])
        if len(address) == 1 and len(datakind) == 1:
          self.send_success_html_headers()
          self.formatter(query_components).output_data(
              self.wfile, address[0], datakind[0])
        else:
          self.send_error(404,'Invalid params')
      elif parsedurl.path == "/setdumpdesc":
        name = query_components.get("dump", [""])
        description = query_components.get("description", [""])
        if len(name) == 1 and len(description) == 1:
          name = name[0]
          description = description[0]
          if self.server.set_dump_desc(name, description):
            self.send_success_html_headers()
            self.wfile.write("OK")
            return
        self.send_error(404,'Invalid params')
      elif parsedurl.path == "/setcomment":
        address = query_components.get("address", [])
        comment = query_components.get("comment", [""])
        if len(address) == 1 and len(comment) == 1:
          address = address[0]
          comment = comment[0]
          self.formatter(query_components).set_comment(address, comment)
          self.send_success_html_headers()
          self.wfile.write("OK")
        else:
          self.send_error(404,'Invalid params')
      elif parsedurl.path == "/setpageaddress":
        kind = query_components.get("kind", [])
        address = query_components.get("address", [""])
        if len(kind) == 1 and len(address) == 1:
          kind = kind[0]
          address = address[0]
          self.formatter(query_components).set_page_address(kind, address)
          self.send_success_html_headers()
          self.wfile.write("OK")
        else:
          self.send_error(404,'Invalid params')
      else:
        self.send_error(404,'File Not Found: %s' % self.path)

    except IOError:
      self.send_error(404,'File Not Found: %s' % self.path)

    except WebParameterError as e:
      self.send_error(404, 'Web parameter error: %s' % e.message)


HTML_REG_FORMAT = "%s: %s
\n"


class InspectionWebFormatter(object):
  CONTEXT_FULL = 0
  CONTEXT_SHORT = 1

  def __init__(self, switches, minidump_name, http_server):
    self.dumpfilename = os.path.split(minidump_name)[1]
    self.encfilename = urllib.urlencode({ 'dump' : self.dumpfilename })
    self.reader = MinidumpReader(switches, minidump_name)
    self.server = http_server

    # Set up the heap
    exception_thread = self.reader.thread_map[self.reader.exception.thread_id]
    stack_top = self.reader.ExceptionSP()
    stack_bottom = exception_thread.stack.start + \
        exception_thread.stack.memory.data_size
    stack_map = {self.reader.ExceptionIP(): -1}
    for slot in xrange(stack_top, stack_bottom, self.reader.PointerSize()):
      maybe_address = self.reader.ReadUIntPtr(slot)
      if not maybe_address in stack_map:
        stack_map[maybe_address] = slot
    self.heap = V8Heap(self.reader, stack_map)

    self.padawan = InspectionPadawan(self.reader, self.heap)
    self.comments = InspectionInfo(minidump_name, self.reader)
    self.padawan.known_first_old_page = (
        self.comments.get_page_address("oldpage"))
    self.padawan.known_first_map_page = (
        self.comments.get_page_address("mappage"))

  def set_comment(self, straddress, comment):
    try:
      address = int(straddress, 0)
      self.comments.set_comment(address, comment)
    except ValueError:
      print "Invalid address"

  def set_page_address(self, kind, straddress):
    try:
      address = int(straddress, 0)
      if kind == "oldpage":
        self.padawan.known_first_old_page = address
      elif kind == "mappage":
        self.padawan.known_first_map_page = address
      self.comments.save_page_address(kind, address)
    except ValueError:
      print "Invalid address"

  def td_from_address(self, f, address):
    f.write("" % self.comments.get_style_class_string(address))

  def format_address(self, maybeaddress, straddress = None):
    if maybeaddress is None:
      return "not in dump"
    else:
      if straddress is None:
        straddress = "0x" + self.reader.FormatIntPtr(maybeaddress)
      style_class = ""
      if not self.reader.IsValidAddress(maybeaddress):
        style_class = " class=\"nodump\""
      return ("%s" %
              (style_class, self.encfilename, straddress, straddress))

  def output_header(self, f):
    f.write(WEB_HEADER %
        { "query_dump" : self.encfilename,
          "dump_name"  : cgi.escape(self.dumpfilename) })

  def output_footer(self, f):
    f.write(WEB_FOOTER)

  MAX_CONTEXT_STACK = 4096

  def output_summary(self, f):
    self.output_header(f)
    f.write('
')
    self.output_context(f, InspectionWebFormatter.CONTEXT_SHORT)
    self.output_disasm_pc(f)

    # Output stack
    exception_thread = self.reader.thread_map[self.reader.exception.thread_id]
    stack_bottom = exception_thread.stack.start + \
        min(exception_thread.stack.memory.data_size, self.MAX_CONTEXT_STACK)
    stack_top = self.reader.ExceptionSP()
    self.output_words(f, stack_top - 16, stack_bottom, stack_top, "Stack")

    f.write('
')
    self.output_footer(f)
    return

  def output_info(self, f):
    self.output_header(f)
    f.write("
Dump info
\n")
    f.write("Description: ")
    self.server.output_dump_desc_field(f, self.dumpfilename)
    f.write("
\n")
    f.write("Filename: ")
    f.write("%s
\n" % (self.dumpfilename))
    dt = datetime.datetime.fromtimestamp(self.reader.header.time_date_stampt)
    f.write("Timestamp: %s
\n" % dt.strftime('%Y-%m-%d %H:%M:%S'))
    self.output_context(f, InspectionWebFormatter.CONTEXT_FULL)
    self.output_address_ranges(f)
    self.output_footer(f)
    return

  def output_address_ranges(self, f):
    regions = {}
    def print_region(_reader, start, size, _location):
      regions[start] = size
    self.reader.ForEachMemoryRegion(print_region)
    f.write("
Available memory regions
\n")
    f.write('
')
    f.write("\n")
    f.write("")
    f.write("")
    f.write("")
    f.write("")
    f.write("\n")
    for start in sorted(regions):
      size = regions[start]
      f.write("")
      f.write("" % self.format_address(start))
      f.write("" % self.format_address(start + size))
      f.write("" % size)
      f.write("\n")
    f.write("
Start addressEnd addressNumber of bytes
%s %s %d
\n")
    f.write('
')
    return

  def output_module_details(self, f, module):
    f.write("%s" % GetModuleName(self.reader, module))
    file_version = GetVersionString(module.version_info.dwFileVersionMS,
                                    module.version_info.dwFileVersionLS)
    product_version = GetVersionString(module.version_info.dwProductVersionMS,
                                       module.version_info.dwProductVersionLS)
    f.write("
  \n")
    f.write("base: %s" % self.reader.FormatIntPtr(module.base_of_image))
    f.write("
  \n")
    f.write("  end: %s" % self.reader.FormatIntPtr(module.base_of_image +
                                            module.size_of_image))
    f.write("
  \n")
    f.write("  file version: %s" % file_version)
    f.write("
  \n")
    f.write("  product version: %s" % product_version)
    f.write("
  \n")
    time_date_stamp = datetime.datetime.fromtimestamp(module.time_date_stamp)
    f.write("  timestamp: %s" % time_date_stamp)
    f.write("
\n");

  def output_modules(self, f):
    self.output_header(f)
    f.write('
')
    for module in self.reader.module_list.modules:
      self.output_module_details(f, module)
    f.write("
")
    self.output_footer(f)
    return

  def output_context(self, f, details):
    exception_thread = self.reader.thread_map[self.reader.exception.thread_id]
    f.write("
Exception context
")
    f.write('
\n')
    f.write("Thread id: %d" % exception_thread.id)
    f.write("   Exception code: %08X
\n" %
            self.reader.exception.exception.code)
    if details == InspectionWebFormatter.CONTEXT_FULL:
      if self.reader.exception.exception.parameter_count > 0:
        f.write("   Exception parameters: \n")
        for i in xrange(0, self.reader.exception.exception.parameter_count):
          f.write("%08x" % self.reader.exception.exception.information[i])
        f.write("

\n")

    for r in CONTEXT_FOR_ARCH[self.reader.arch]:
      f.write(HTML_REG_FORMAT %
              (r, self.format_address(self.reader.Register(r))))
    # TODO(vitalyr): decode eflags.
    if self.reader.arch in [MD_CPU_ARCHITECTURE_ARM, MD_CPU_ARCHITECTURE_ARM64]:
      f.write("cpsr: %s" % bin(self.reader.exception_context.cpsr)[2:])
    else:
      f.write("eflags: %s" %
              bin(self.reader.exception_context.eflags)[2:])
    f.write('
\n')
    return

  def align_down(self, a, size):
    alignment_correction = a % size
    return a - alignment_correction

  def align_up(self, a, size):
    alignment_correction = (size - 1) - ((a + size - 1) % size)
    return a + alignment_correction

  def format_object(self, address):
    heap_object = self.padawan.SenseObject(address)
    return cgi.escape(str(heap_object or ""))

  def output_data(self, f, straddress, datakind):
    try:
      self.output_header(f)
      address = int(straddress, 0)
      if not self.reader.IsValidAddress(address):
        f.write("
Address 0x%x not found in the dump.
" % address)
        return
      region = self.reader.FindRegion(address)
      if datakind == "address":
        self.output_words(f, region[0], region[0] + region[1], address, "Dump")
      elif datakind == "ascii":
        self.output_ascii(f, region[0], region[0] + region[1], address)
      self.output_footer(f)

    except ValueError:
      f.write("
Unrecognized address format \"%s\".
" % straddress)
    return

  def output_words(self, f, start_address, end_address,
                   highlight_address, desc):
    region = self.reader.FindRegion(highlight_address)
    if region is None:
      f.write("
Address 0x%x not found in the dump.
\n" %
              (highlight_address))
      return
    size = self.heap.PointerSize()
    start_address = self.align_down(start_address, size)
    low = self.align_down(region[0], size)
    high = self.align_up(region[0] + region[1], size)
    if start_address < low:
      start_address = low
    end_address = self.align_up(end_address, size)
    if end_address > high:
      end_address = high

    expand = ""
    if start_address != low or end_address != high:
      expand = ("("
                " more..."
                " )" %
                (self.encfilename, highlight_address))

    f.write("
%s 0x%x - 0x%x, "
            "highlighting 0x%x %s
\n" %
            (desc, start_address, end_address, highlight_address, expand))
    f.write('
')
    f.write("\n")

    for j in xrange(0, end_address - start_address, size):
      slot = start_address + j
      heap_object = ""
      maybe_address = None
      end_region = region[0] + region[1]
      if slot < region[0] or slot + size > end_region:
        straddress = "0x"
        for i in xrange(end_region, slot + size):
          straddress += "??"
        for i in reversed(
            xrange(max(slot, region[0]), min(slot + size, end_region))):
          straddress += "%02x" % self.reader.ReadU8(i)
        for i in xrange(slot, region[0]):
          straddress += "??"
      else:
        maybe_address = self.reader.ReadUIntPtr(slot)
        straddress = self.format_address(maybe_address)
        if maybe_address:
          heap_object = self.format_object(maybe_address)

      address_fmt = "%s \n"
      if slot == highlight_address:
        f.write("\n")
        address_fmt = "%s \n"
      elif slot < highlight_address and highlight_address < slot + size:
        f.write("\n")
        address_fmt = "%s \n"
      else:
        f.write("\n")

      f.write("  \n")
      f.write("  ")
      self.td_from_address(f, slot)
      f.write(address_fmt % self.format_address(slot))
      f.write("  ")
      self.td_from_address(f, maybe_address)
      f.write(": %s \n" % straddress)
      f.write("  \n")
      f.write("  \n" % (heap_object or ''))
      f.write("\n")
    f.write("
")
      self.output_comment_box(f, "da-", slot)
      f.write("")
      if maybe_address != None:
        self.output_comment_box(
            f, "sv-" + self.reader.FormatIntPtr(slot), maybe_address)
      f.write("  %s
\n")
    f.write("
")
    return

  def output_ascii(self, f, start_address, end_address, highlight_address):
    region = self.reader.FindRegion(highlight_address)
    if region is None:
      f.write("
Address %x not found in the dump.
" %
          highlight_address)
      return
    if start_address < region[0]:
      start_address = region[0]
    if end_address > region[0] + region[1]:
      end_address = region[0] + region[1]

    expand = ""
    if start_address != region[0] or end_address != region[0] + region[1]:
      link = ("data.html?%s&val=0x%x&type=ascii#highlight" %
              (self.encfilename, highlight_address))
      expand = "(more...)" % link

    f.write("
ASCII dump 0x%x - 0x%x, highlighting 0x%x %s
" %
            (start_address, end_address, highlight_address, expand))

    line_width = 64

    f.write('
')

    start = self.align_down(start_address, line_width)

    for i in xrange(end_address - start):
      address = start + i
      if address % 64 == 0:
        if address != start:
          f.write("
")
        f.write("0x%08x: " % address)
      if address < start_address:
        f.write(" ")
      else:
        if address == highlight_address:
          f.write("")
        code = self.reader.ReadU8(address)
        if code < 127 and code >= 32:
          f.write("&#")
          f.write(str(code))
          f.write(";")
        else:
          f.write("·")
        if address == highlight_address:
          f.write("")
    f.write("
")
    return

  def output_disasm(self, f, straddress, strexact):
    try:
      self.output_header(f)
      address = int(straddress, 0)
      if not self.reader.IsValidAddress(address):
        f.write("
Address 0x%x not found in the dump.
" % address)
        return
      region = self.reader.FindRegion(address)
      self.output_disasm_range(
          f, region[0], region[0] + region[1], address, strexact == "on")
      self.output_footer(f)
    except ValueError:
      f.write("
Unrecognized address format \"%s\".
" % straddress)
    return

  def output_disasm_range(
      self, f, start_address, end_address, highlight_address, exact):
    region = self.reader.FindRegion(highlight_address)
    if start_address < region[0]:
      start_address = region[0]
    if end_address > region[0] + region[1]:
      end_address = region[0] + region[1]
    count = end_address - start_address
    lines = self.reader.GetDisasmLines(start_address, count)
    found = False
    if exact:
      for line in lines:
        if line[0] + start_address == highlight_address:
          found = True
          break
      if not found:
        start_address = highlight_address
        count = end_address - start_address
        lines = self.reader.GetDisasmLines(highlight_address, count)
    expand = ""
    if start_address != region[0] or end_address != region[0] + region[1]:
      exactness = ""
      if exact and not found and end_address == region[0] + region[1]:
        exactness = "&exact=off"
      expand = ("(more...)" %
                (self.encfilename, exactness, highlight_address))

    f.write("
Disassembling 0x%x - 0x%x, highlighting 0x%x %s
" %
            (start_address, end_address, highlight_address, expand))
    f.write('
')
    f.write("\n");
    for i in xrange(len(lines)):
      line = lines[i]
      next_address = count
      if i + 1 < len(lines):
        next_line = lines[i + 1]
        next_address = next_line[0]
      self.format_disasm_line(
          f, start_address, line, next_address, highlight_address)
    f.write("
\n")
    f.write("
")
    return

  def annotate_disasm_addresses(self, line):
    extra = []
    for m in ADDRESS_RE.finditer(line):
      maybe_address = int(m.group(0), 16)
      formatted_address = self.format_address(maybe_address, m.group(0))
      line = line.replace(m.group(0), formatted_address)
      object_info = self.padawan.SenseObject(maybe_address)
      if not object_info:
        continue
      extra.append(cgi.escape(str(object_info)))
    if len(extra) == 0:
      return line
    return ("%s ;; %s" %
            (line, ", ".join(extra)))

  def format_disasm_line(
      self, f, start, line, next_address, highlight_address):
    line_address = start + line[0]
    address_fmt = "  %s\n"
    if line_address == highlight_address:
      f.write("\n")
      address_fmt = "  %s\n"
    elif (line_address < highlight_address and
          highlight_address < next_address + start):
      f.write("\n")
      address_fmt = "  %s\n"
    else:
      f.write("\n")
    num_bytes = next_address - line[0]
    stack_slot = self.heap.stack_map.get(line_address)
    marker = ""
    if stack_slot:
      marker = "=>"
    op_offset = 3 * num_bytes - 1

    code = line[1]
    # Compute the actual call target which the disassembler is too stupid
    # to figure out (it adds the call offset to the disassembly offset rather
    # than the absolute instruction address).
    if self.heap.reader.arch == MD_CPU_ARCHITECTURE_X86:
      if code.startswith("e8"):
        words = code.split()
        if len(words) > 6 and words[5] == "call":
          offset = int(words[4] + words[3] + words[2] + words[1], 16)
          target = (line_address + offset + 5) & 0xFFFFFFFF
          code = code.replace(words[6], "0x%08x" % target)
    # TODO(jkummerow): port this hack to ARM and x64.

    opcodes = code[:op_offset]
    code = self.annotate_disasm_addresses(code[op_offset:])
    f.write("  ")
    self.output_comment_box(f, "codel-", line_address)
    f.write("\n")
    f.write(address_fmt % marker)
    f.write("  ")
    self.td_from_address(f, line_address)
    f.write("%s (+0x%x)\n" %
            (self.format_address(line_address), line[0]))
    f.write("  : %s \n" % opcodes)
    f.write("  %s\n" % code)
    f.write("\n")

  def output_comment_box(self, f, prefix, address):
    f.write("" %
            (prefix,
             self.reader.FormatIntPtr(address),
             cgi.escape(self.comments.get_comment(address)) or ""))

  MAX_FOUND_RESULTS = 100

  def output_find_results(self, f, results):
    f.write("Addresses")
    toomany = len(results) > self.MAX_FOUND_RESULTS
    if toomany:
      f.write("(found %i results, displaying only first %i)" %
              (len(results), self.MAX_FOUND_RESULTS))
    f.write(": \n")
    results = sorted(results)
    results = results[:min(len(results), self.MAX_FOUND_RESULTS)]
    for address in results:
      f.write("%s\n" %
              (self.comments.get_style_class_string(address),
               self.format_address(address)))
    if toomany:
      f.write("...\n")


  def output_page_info(self, f, page_kind, page_address, my_page_address):
    if my_page_address == page_address and page_address != 0:
      f.write("Marked first %s page.\n" % page_kind)
    else:
      f.write("" % page_kind)
      f.write("Marked first %s page." % page_kind)
      f.write("\n")
      f.write("\n" % page_kind)
    return

  def output_search_res(self, f, straddress):
    try:
      self.output_header(f)
      f.write("
Search results for %s
" % straddress)

      address = int(straddress, 0)

      f.write("Comment: ")
      self.output_comment_box(f, "search-", address)
      f.write("
\n")

      page_address = address & ~self.heap.PageAlignmentMask()

      f.write("Page info: \n")
      self.output_page_info(f, "old", self.padawan.known_first_old_page, \
                            page_address)
      self.output_page_info(f, "map", self.padawan.known_first_map_page, \
                            page_address)

      if not self.reader.IsValidAddress(address):
        f.write("
The contents at address %s not found in the dump.
" % \
                straddress)
      else:
        # Print as words
        self.output_words(f, address - 8, address + 32, address, "Dump")

        # Print as ASCII
        f.write("
\n")
        self.output_ascii(f, address, address + 256, address)

        # Print as code
        f.write("
\n")
        self.output_disasm_range(f, address - 16, address + 16, address, True)

      aligned_res, unaligned_res = self.reader.FindWordList(address)

      if len(aligned_res) > 0:
        f.write("
Occurrences of 0x%x at aligned addresses
\n" %
                address)
        self.output_find_results(f, aligned_res)

      if len(unaligned_res) > 0:
        f.write("
Occurrences of 0x%x at unaligned addresses
\n" % \
                address)
        self.output_find_results(f, unaligned_res)

      if len(aligned_res) + len(unaligned_res) == 0:
        f.write("
No occurences of 0x%x found in the dump
\n" % address)

      self.output_footer(f)

    except ValueError:
      f.write("
Unrecognized address format \"%s\".
" % straddress)
    return

  def output_disasm_pc(self, f):
    address = self.reader.ExceptionIP()
    if not self.reader.IsValidAddress(address):
      return
    self.output_disasm_range(f, address - 16, address + 16, address, True)


WEB_DUMPS_HEADER = """








Dump list



"""

WEB_DUMPS_FOOTER = """


"""

DUMP_FILE_RE = re.compile(r"[-_0-9a-zA-Z][-\._0-9a-zA-Z]*\.dmp$")


class InspectionWebServer(BaseHTTPServer.HTTPServer):
  def __init__(self, port_number, switches, minidump_name):
    BaseHTTPServer.HTTPServer.__init__(
        self, ('', port_number), InspectionWebHandler)
    splitpath = os.path.split(minidump_name)
    self.dumppath = splitpath[0]
    self.dumpfilename = splitpath[1]
    self.default_formatter = InspectionWebFormatter(
        switches, minidump_name, self)
    self.formatters = { self.dumpfilename : self.default_formatter }
    self.switches = switches

  def output_dump_desc_field(self, f, name):
    try:
      descfile = open(os.path.join(self.dumppath, name + ".desc"), "r")
      desc = descfile.readline()
      descfile.close()
    except IOError:
      desc = ""
    f.write("\n" %
            (cgi.escape(name), desc))

  def set_dump_desc(self, name, description):
    if not DUMP_FILE_RE.match(name):
      return False
    fname = os.path.join(self.dumppath, name)
    if not os.path.isfile(fname):
      return False
    fname = fname + ".desc"
    descfile = open(fname, "w")
    descfile.write(description)
    descfile.close()
    return True

  def get_dump_formatter(self, name):
    if name is None:
      return self.default_formatter
    else:
      if not DUMP_FILE_RE.match(name):
        raise WebParameterError("Invalid name '%s'" % name)
      formatter = self.formatters.get(name, None)
      if formatter is None:
        try:
          formatter = InspectionWebFormatter(
              self.switches, os.path.join(self.dumppath, name), self)
          self.formatters[name] = formatter
        except IOError:
          raise WebParameterError("Could not open dump '%s'" % name)
      return formatter

  def output_dumps(self, f):
    f.write(WEB_DUMPS_HEADER)
    f.write("
List of available dumps
")
    f.write("\n")
    f.write("")
    f.write("")
    f.write("")
    f.write("")
    f.write("")
    dumps_by_time = {}
    for fname in os.listdir(self.dumppath):
      if DUMP_FILE_RE.match(fname):
        mtime = os.stat(os.path.join(self.dumppath, fname)).st_mtime
        fnames = dumps_by_time.get(mtime, [])
        fnames.append(fname)
        dumps_by_time[mtime] = fnames

    for mtime in sorted(dumps_by_time, reverse=True):
      fnames = dumps_by_time[mtime]
      for fname in fnames:
        f.write("\n")
        f.write("\n" % (
            (urllib.urlencode({ 'dump' : fname }), fname)))
        f.write("")
        f.write("")
        f.write("\n")
    f.write("
NameFile timeComment
%s   ")
        f.write(datetime.datetime.fromtimestamp(mtime))
        f.write("   ")
        self.output_dump_desc_field(f, fname)
        f.write("
\n")
    f.write(WEB_DUMPS_FOOTER)
    return

class InspectionShell(cmd.Cmd):
  def __init__(self, reader, heap):
    cmd.Cmd.__init__(self)
    self.reader = reader
    self.heap = heap
    self.padawan = InspectionPadawan(reader, heap)
    self.prompt = "(grok) "

  def do_da(self, address):
    """
     Print ASCII string starting at specified address.
    """
    address = int(address, 16)
    string = ""
    while self.reader.IsValidAddress(address):
      code = self.reader.ReadU8(address)
      if code < 128:
        string += chr(code)
      else:
        break
      address += 1
    if string == "":
      print "Not an ASCII string at %s" % self.reader.FormatIntPtr(address)
    else:
      print "%s\n" % string

  def do_dd(self, args):
    """
     Interpret memory in the given region [address, address + num * word_size)
     (if available) as a sequence of words. Automatic alignment is not performed.
     If the num is not specified, a default value of 16 words is used.
     Synopsis: dd 0x
 0x
    """
    args = args.split(' ')
    start = int(args[0], 16)
    num = int(args[1], 16) if len(args) > 1 else 0x10
    if (start & self.heap.ObjectAlignmentMask()) != 0:
      print "Warning: Dumping un-aligned memory, is this what you had in mind?"
    for i in xrange(0,
                    self.reader.PointerSize() * num,
                    self.reader.PointerSize()):
      slot = start + i
      if not self.reader.IsValidAddress(slot):
        print "Address is not contained within the minidump!"
        return
      maybe_address = self.reader.ReadUIntPtr(slot)
      heap_object = self.padawan.SenseObject(maybe_address)
      print "%s: %s %s" % (self.reader.FormatIntPtr(slot),
                           self.reader.FormatIntPtr(maybe_address),
                           heap_object or '')

  def do_do(self, address):
    """
     Interpret memory at the given address as a V8 object. Automatic
     alignment makes sure that you can pass tagged as well as un-tagged
     addresses.
    """
    address = int(address, 16)
    if (address & self.heap.ObjectAlignmentMask()) == 0:
      address = address + 1
    elif (address & self.heap.ObjectAlignmentMask()) != 1:
      print "Address doesn't look like a valid pointer!"
      return
    heap_object = self.padawan.SenseObject(address)
    if heap_object:
      heap_object.Print(Printer())
    else:
      print "Address cannot be interpreted as object!"

  def do_do_desc(self, address):
    """
      Print a descriptor array in a readable format.
    """
    start = int(address, 16)
    if ((start & 1) == 1): start = start - 1
    DescriptorArray(FixedArray(self.heap, None, start)).Print(Printer())

  def do_do_map(self, address):
    """
      Print a descriptor array in a readable format.
    """
    start = int(address, 16)
    if ((start & 1) == 1): start = start - 1
    Map(self.heap, None, start).Print(Printer())

  def do_do_trans(self, address):
    """
      Print a transition array in a readable format.
    """
    start = int(address, 16)
    if ((start & 1) == 1): start = start - 1
    TransitionArray(FixedArray(self.heap, None, start)).Print(Printer())

  def do_dp(self, address):
    """
     Interpret memory at the given address as being on a V8 heap page
     and print information about the page header (if available).
    """
    address = int(address, 16)
    page_address = address & ~self.heap.PageAlignmentMask()
    if self.reader.IsValidAddress(page_address):
      raise NotImplementedError
    else:
      print "Page header is not available!"

  def do_k(self, arguments):
    """
     Teach V8 heap layout information to the inspector. This increases
     the amount of annotations the inspector can produce while dumping
     data. The first page of each heap space is of particular interest
     because it contains known objects that do not move.
    """
    self.padawan.PrintKnowledge()

  def do_ko(self, address):
    """
     Teach V8 heap layout information to the inspector. Set the first
     old space page by passing any pointer into that page.
    """
    address = int(address, 16)
    page_address = address & ~self.heap.PageAlignmentMask()
    self.padawan.known_first_old_page = page_address

  def do_km(self, address):
    """
     Teach V8 heap layout information to the inspector. Set the first
     map-space page by passing any pointer into that page.
    """
    address = int(address, 16)
    page_address = address & ~self.heap.PageAlignmentMask()
    self.padawan.known_first_map_page = page_address

  def do_list(self, smth):
    """
     List all available memory regions.
    """
    def print_region(reader, start, size, location):
      print "  %s - %s (%d bytes)" % (reader.FormatIntPtr(start),
                                      reader.FormatIntPtr(start + size),
                                      size)
    print "Available memory regions:"
    self.reader.ForEachMemoryRegion(print_region)

  def do_lm(self, arg):
    """
     List details for all loaded modules in the minidump. An argument can
     be passed to limit the output to only those modules that contain the
     argument as a substring (case insensitive match).
    """
    for module in self.reader.module_list.modules:
      if arg:
        name = GetModuleName(self.reader, module).lower()
        if name.find(arg.lower()) >= 0:
          PrintModuleDetails(self.reader, module)
      else:
        PrintModuleDetails(self.reader, module)
    print

  def do_s(self, word):
    """
     Search for a given word in available memory regions. The given word
     is expanded to full pointer size and searched at aligned as well as
     un-aligned memory locations. Use 'sa' to search aligned locations
     only.
    """
    try:
      word = int(word, 0)
    except ValueError:
      print "Malformed word, prefix with '0x' to use hexadecimal format."
      return
    print "Searching for word %d/0x%s:" % (word, self.reader.FormatIntPtr(word))
    self.reader.FindWord(word)

  def do_sh(self, none):
    """
     Search for the V8 Heap object in all available memory regions. You
     might get lucky and find this rare treasure full of invaluable
     information.
    """
    raise NotImplementedError

  def do_u(self, args):
    """
     Unassemble memory in the region [address, address + size). If the
     size is not specified, a default value of 32 bytes is used.
     Synopsis: u 0x
 0x
    """
    args = args.split(' ')
    start = int(args[0], 16)
    size = int(args[1], 16) if len(args) > 1 else 0x20
    if not self.reader.IsValidAddress(start):
      print "Address is not contained within the minidump!"
      return
    lines = self.reader.GetDisasmLines(start, size)
    for line in lines:
      print FormatDisasmLine(start, self.heap, line)
    print

  def do_EOF(self, none):
    raise KeyboardInterrupt

EIP_PROXIMITY = 64

CONTEXT_FOR_ARCH = {
    MD_CPU_ARCHITECTURE_AMD64:
      ['rax', 'rbx', 'rcx', 'rdx', 'rdi', 'rsi', 'rbp', 'rsp', 'rip',
       'r8', 'r9', 'r10', 'r11', 'r12', 'r13', 'r14', 'r15'],
    MD_CPU_ARCHITECTURE_ARM:
      ['r0', 'r1', 'r2', 'r3', 'r4', 'r5', 'r6', 'r7', 'r8', 'r9',
       'r10', 'r11', 'r12', 'sp', 'lr', 'pc'],
    MD_CPU_ARCHITECTURE_ARM64:
      ['r0', 'r1', 'r2', 'r3', 'r4', 'r5', 'r6', 'r7', 'r8', 'r9',
       'r10', 'r11', 'r12', 'r13', 'r14', 'r15', 'r16', 'r17', 'r18', 'r19',
       'r20', 'r21', 'r22', 'r23', 'r24', 'r25', 'r26', 'r27', 'r28',
       'fp', 'lr', 'sp', 'pc'],
    MD_CPU_ARCHITECTURE_X86:
      ['eax', 'ebx', 'ecx', 'edx', 'edi', 'esi', 'ebp', 'esp', 'eip']
}

KNOWN_MODULES = {'chrome.exe', 'chrome.dll'}

def GetVersionString(ms, ls):
  return "%d.%d.%d.%d" % (ms >> 16, ms & 0xffff, ls >> 16, ls & 0xffff)


def GetModuleName(reader, module):
  name = reader.ReadMinidumpString(module.module_name_rva)
  # simplify for path manipulation
  name = name.encode('utf-8')
  return str(os.path.basename(str(name).replace("\\", "/")))


def PrintModuleDetails(reader, module):
  print "%s" % GetModuleName(reader, module)
  file_version = GetVersionString(module.version_info.dwFileVersionMS,
                                  module.version_info.dwFileVersionLS)
  product_version = GetVersionString(module.version_info.dwProductVersionMS,
                                     module.version_info.dwProductVersionLS)
  print "  base: %s" % reader.FormatIntPtr(module.base_of_image)
  print "  end: %s" % reader.FormatIntPtr(module.base_of_image +
                                          module.size_of_image)
  print "  file version: %s" % file_version
  print "  product version: %s" % product_version
  time_date_stamp = datetime.datetime.fromtimestamp(module.time_date_stamp)
  print "  timestamp: %s" % time_date_stamp


def AnalyzeMinidump(options, minidump_name):
  reader = MinidumpReader(options, minidump_name)
  heap = None
  DebugPrint("========================================")
  if reader.exception is None:
    print "Minidump has no exception info"
  else:
    print "Exception info:"
    exception_thread = reader.thread_map[reader.exception.thread_id]
    print "  thread id: %d" % exception_thread.id
    print "  code: %08X" % reader.exception.exception.code
    print "  context:"
    for r in CONTEXT_FOR_ARCH[reader.arch]:
      print "    %s: %s" % (r, reader.FormatIntPtr(reader.Register(r)))
    # TODO(vitalyr): decode eflags.
    if reader.arch in [MD_CPU_ARCHITECTURE_ARM, MD_CPU_ARCHITECTURE_ARM64]:
      print "    cpsr: %s" % bin(reader.exception_context.cpsr)[2:]
    else:
      print "    eflags: %s" % bin(reader.exception_context.eflags)[2:]

    print
    print "  modules:"
    for module in reader.module_list.modules:
      name = GetModuleName(reader, module)
      if name in KNOWN_MODULES:
        print "    %s at %08X" % (name, module.base_of_image)
        reader.TryLoadSymbolsFor(name, module)
    print

    stack_top = reader.ExceptionSP()
    stack_bottom = exception_thread.stack.start + \
        exception_thread.stack.memory.data_size
    stack_map = {reader.ExceptionIP(): -1}
    for slot in xrange(stack_top, stack_bottom, reader.PointerSize()):
      maybe_address = reader.ReadUIntPtr(slot)
      if not maybe_address in stack_map:
        stack_map[maybe_address] = slot
    heap = V8Heap(reader, stack_map)

    print "Disassembly around exception.eip:"
    eip_symbol = reader.FindSymbol(reader.ExceptionIP())
    if eip_symbol is not None:
      print eip_symbol
    disasm_start = reader.ExceptionIP() - EIP_PROXIMITY
    disasm_bytes = 2 * EIP_PROXIMITY
    if (options.full):
      full_range = reader.FindRegion(reader.ExceptionIP())
      if full_range is not None:
        disasm_start = full_range[0]
        disasm_bytes = full_range[1]

    lines = reader.GetDisasmLines(disasm_start, disasm_bytes)

    if not lines:
      print "Could not disassemble using %s." % OBJDUMP_BIN
      print "Pass path to architecture specific objdump via --objdump?"

    for line in lines:
      print FormatDisasmLine(disasm_start, heap, line)
    print

  if heap is None:
    heap = V8Heap(reader, None)

  if options.full:
    FullDump(reader, heap)

  if options.command:
    InspectionShell(reader, heap).onecmd(options.command)

  if options.shell:
    try:
      InspectionShell(reader, heap).cmdloop("type help to get help")
    except KeyboardInterrupt:
      print "Kthxbye."
  elif not options.command:
    if reader.exception is not None:
      frame_pointer = reader.ExceptionFP()
      in_oom_dump_area = False
      print "Annotated stack (from exception.esp to bottom):"
      for slot in xrange(stack_top, stack_bottom, reader.PointerSize()):
        ascii_content = [c if c >= '\x20' and c <  '\x7f' else '.'
                         for c in reader.ReadBytes(slot, reader.PointerSize())]
        maybe_address = reader.ReadUIntPtr(slot)
        maybe_address_contents = None
        if maybe_address >= stack_top and maybe_address <= stack_bottom:
          maybe_address_contents = reader.ReadUIntPtr(maybe_address)
          if maybe_address_contents == 0xdecade00:
            in_oom_dump_area = True
        heap_object = heap.FindObject(maybe_address)
        maybe_symbol = reader.FindSymbol(maybe_address)
        oom_comment = ""
        if in_oom_dump_area:
          if maybe_address_contents == 0xdecade00:
            oom_comment = " <----- HeapStats start marker"
          elif maybe_address_contents == 0xdecade01:
            oom_comment = " <----- HeapStats end marker"
          elif maybe_address_contents is not None:
            oom_comment = " %d (%d Mbytes)" % (maybe_address_contents,
                                            maybe_address_contents >> 20)
        if slot == frame_pointer:
          maybe_symbol = "<---- frame pointer"
          frame_pointer = maybe_address
        print "%s: %s %s %s%s" % (reader.FormatIntPtr(slot),
                                  reader.FormatIntPtr(maybe_address),
                                   "".join(ascii_content),
                                   maybe_symbol or "",
                                   oom_comment)
        if maybe_address_contents == 0xdecade01:
          in_oom_dump_area = False
        if heap_object:
          heap_object.Print(Printer())
          print

  reader.Dispose()


if __name__ == "__main__":
  parser = optparse.OptionParser(USAGE)
  parser.add_option("-s", "--shell", dest="shell", action="store_true",
                    help="start an interactive inspector shell")
  parser.add_option("-w", "--web", dest="web", action="store_true",
                    help="start a web server on localhost:%i" % PORT_NUMBER)
  parser.add_option("-c", "--command", dest="command", default="",
                    help="run an interactive inspector shell command and exit")
  parser.add_option("-f", "--full", dest="full", action="store_true",
                    help="dump all information contained in the minidump")
  parser.add_option("--symdir", dest="symdir", default=".",
                    help="directory containing *.pdb.sym file with symbols")
  parser.add_option("--objdump",
                    default="/usr/bin/objdump",
                    help="objdump tool to use [default: %default]")
  options, args = parser.parse_args()
  if os.path.exists(options.objdump):
    disasm.OBJDUMP_BIN = options.objdump
    OBJDUMP_BIN = options.objdump
  else:
    print "Cannot find %s, falling back to default objdump" % options.objdump
  if len(args) != 1:
    parser.print_help()
    sys.exit(1)
  if options.web:
    try:
      server = InspectionWebServer(PORT_NUMBER, options, args[0])
      print 'Started httpserver on port ' , PORT_NUMBER
      webbrowser.open('http://localhost:%i/summary.html' % PORT_NUMBER)
      server.serve_forever()
    except KeyboardInterrupt:
      print '^C received, shutting down the web server'
      server.socket.close()
  else:
    AnalyzeMinidump(options, args[0])
node-v4.8.2/deps/v8/tools/gyp/000755 000766 000024 00000000000 13070706735 016207 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/v8/tools/js2c.py000755 000766 000024 00000044533 13070706735 016637 0ustar00iojsstaff000000 000000 #!/usr/bin/env python
#
# Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

# This is a utility for converting JavaScript source code into C-style
# char arrays. It is used for embedded JavaScript code in the V8
# library.

import os, re, sys, string
import optparse
import jsmin
import bz2
import textwrap


class Error(Exception):
  def __init__(self, msg):
    Exception.__init__(self, msg)


def ToCArray(byte_sequence):
  result = []
  for chr in byte_sequence:
    result.append(str(ord(chr)))
  joined = ", ".join(result)
  return textwrap.fill(joined, 80)


def RemoveCommentsAndTrailingWhitespace(lines):
  lines = re.sub(r'//.*\n', '\n', lines) # end-of-line comments
  lines = re.sub(re.compile(r'/\*.*?\*/', re.DOTALL), '', lines) # comments.
  lines = re.sub(r'\s+\n+', '\n', lines) # trailing whitespace
  return lines


def ReadFile(filename):
  file = open(filename, "rt")
  try:
    lines = file.read()
  finally:
    file.close()
  return lines


EVAL_PATTERN = re.compile(r'\beval\s*\(')
WITH_PATTERN = re.compile(r'\bwith\s*\(')
INVALID_ERROR_MESSAGE_PATTERN = re.compile(
    r'Make(?!Generic)\w*Error\(([kA-Z]\w+)')
NEW_ERROR_PATTERN = re.compile(r'new \$\w*Error\((?!\))')

def Validate(lines):
  # Because of simplified context setup, eval and with is not
  # allowed in the natives files.
  if EVAL_PATTERN.search(lines):
    raise Error("Eval disallowed in natives.")
  if WITH_PATTERN.search(lines):
    raise Error("With statements disallowed in natives.")
  invalid_error = INVALID_ERROR_MESSAGE_PATTERN.search(lines)
  if invalid_error:
    raise Error("Unknown error message template '%s'" % invalid_error.group(1))
  if NEW_ERROR_PATTERN.search(lines):
    raise Error("Error constructed without message template.")
  # Pass lines through unchanged.
  return lines


def ExpandConstants(lines, constants):
  for key, value in constants:
    lines = key.sub(str(value), lines)
  return lines


def ExpandMacroDefinition(lines, pos, name_pattern, macro, expander):
  pattern_match = name_pattern.search(lines, pos)
  while pattern_match is not None:
    # Scan over the arguments
    height = 1
    start = pattern_match.start()
    end = pattern_match.end()
    assert lines[end - 1] == '('
    last_match = end
    arg_index = [0]  # Wrap state into array, to work around Python "scoping"
    mapping = { }
    def add_arg(str):
      # Remember to expand recursively in the arguments
      replacement = expander(str.strip())
      mapping[macro.args[arg_index[0]]] = replacement
      arg_index[0] += 1
    while end < len(lines) and height > 0:
      # We don't count commas at higher nesting levels.
      if lines[end] == ',' and height == 1:
        add_arg(lines[last_match:end])
        last_match = end + 1
      elif lines[end] in ['(', '{', '[']:
        height = height + 1
      elif lines[end] in [')', '}', ']']:
        height = height - 1
      end = end + 1
    # Remember to add the last match.
    add_arg(lines[last_match:end-1])
    result = macro.expand(mapping)
    # Replace the occurrence of the macro with the expansion
    lines = lines[:start] + result + lines[end:]
    pattern_match = name_pattern.search(lines, start + len(result))
  return lines

def ExpandMacros(lines, macros):
  # We allow macros to depend on the previously declared macros, but
  # we don't allow self-dependecies or recursion.
  for name_pattern, macro in reversed(macros):
    def expander(s):
      return ExpandMacros(s, macros)
    lines = ExpandMacroDefinition(lines, 0, name_pattern, macro, expander)
  return lines

class TextMacro:
  def __init__(self, args, body):
    self.args = args
    self.body = body
  def expand(self, mapping):
    result = self.body
    for key, value in mapping.items():
        result = result.replace(key, value)
    return result

class PythonMacro:
  def __init__(self, args, fun):
    self.args = args
    self.fun = fun
  def expand(self, mapping):
    args = []
    for arg in self.args:
      args.append(mapping[arg])
    return str(self.fun(*args))

CONST_PATTERN = re.compile(r'^define\s+([a-zA-Z0-9_]+)\s*=\s*([^;]*);$')
MACRO_PATTERN = re.compile(r'^macro\s+([a-zA-Z0-9_]+)\s*\(([^)]*)\)\s*=\s*([^;]*);$')
PYTHON_MACRO_PATTERN = re.compile(r'^python\s+macro\s+([a-zA-Z0-9_]+)\s*\(([^)]*)\)\s*=\s*([^;]*);$')


def ReadMacros(lines):
  constants = []
  macros = []
  for line in lines.split('\n'):
    hash = line.find('#')
    if hash != -1: line = line[:hash]
    line = line.strip()
    if len(line) is 0: continue
    const_match = CONST_PATTERN.match(line)
    if const_match:
      name = const_match.group(1)
      value = const_match.group(2).strip()
      constants.append((re.compile("\\b%s\\b" % name), value))
    else:
      macro_match = MACRO_PATTERN.match(line)
      if macro_match:
        name = macro_match.group(1)
        args = [match.strip() for match in macro_match.group(2).split(',')]
        body = macro_match.group(3).strip()
        macros.append((re.compile("\\b%s\\(" % name), TextMacro(args, body)))
      else:
        python_match = PYTHON_MACRO_PATTERN.match(line)
        if python_match:
          name = python_match.group(1)
          args = [match.strip() for match in python_match.group(2).split(',')]
          body = python_match.group(3).strip()
          fun = eval("lambda " + ",".join(args) + ': ' + body)
          macros.append((re.compile("\\b%s\\(" % name), PythonMacro(args, fun)))
        else:
          raise Error("Illegal line: " + line)
  return (constants, macros)


TEMPLATE_PATTERN = re.compile(r'^\s+T\(([A-Z][a-zA-Z]*),')

def ReadMessageTemplates(lines):
  templates = []
  index = 0
  for line in lines.split('\n'):
    template_match = TEMPLATE_PATTERN.match(line)
    if template_match:
      name = "k%s" % template_match.group(1)
      value = index
      index = index + 1
      templates.append((re.compile("\\b%s\\b" % name), value))
  return templates

INLINE_MACRO_PATTERN = re.compile(r'macro\s+([a-zA-Z0-9_]+)\s*\(([^)]*)\)\s*\n')
INLINE_MACRO_END_PATTERN = re.compile(r'endmacro\s*\n')

def ExpandInlineMacros(lines):
  pos = 0
  while True:
    macro_match = INLINE_MACRO_PATTERN.search(lines, pos)
    if macro_match is None:
      # no more macros
      return lines
    name = macro_match.group(1)
    args = [match.strip() for match in macro_match.group(2).split(',')]
    end_macro_match = INLINE_MACRO_END_PATTERN.search(lines, macro_match.end());
    if end_macro_match is None:
      raise Error("Macro %s unclosed" % name)
    body = lines[macro_match.end():end_macro_match.start()]

    # remove macro definition
    lines = lines[:macro_match.start()] + lines[end_macro_match.end():]
    name_pattern = re.compile("\\b%s\\(" % name)
    macro = TextMacro(args, body)

    # advance position to where the macro defintion was
    pos = macro_match.start()

    def non_expander(s):
      return s
    lines = ExpandMacroDefinition(lines, pos, name_pattern, macro, non_expander)


INLINE_CONSTANT_PATTERN = re.compile(r'define\s+([a-zA-Z0-9_]+)\s*=\s*([^;\n]+)[;\n]')

def ExpandInlineConstants(lines):
  pos = 0
  while True:
    const_match = INLINE_CONSTANT_PATTERN.search(lines, pos)
    if const_match is None:
      # no more constants
      return lines
    name = const_match.group(1)
    replacement = const_match.group(2)
    name_pattern = re.compile("\\b%s\\b" % name)

    # remove constant definition and replace
    lines = (lines[:const_match.start()] +
             re.sub(name_pattern, replacement, lines[const_match.end():]))

    # advance position to where the constant defintion was
    pos = const_match.start()


HEADER_TEMPLATE = """\
// Copyright 2011 Google Inc. All Rights Reserved.

// This file was generated from .js source files by GYP.  If you
// want to make changes to this file you should either change the
// javascript source files or the GYP script.

#include "src/v8.h"
#include "src/snapshot/natives.h"
#include "src/utils.h"

namespace v8 {
namespace internal {

%(sources_declaration)s\

  template <>
  int NativesCollection<%(type)s>::GetBuiltinsCount() {
    return %(builtin_count)i;
  }

  template <>
  int NativesCollection<%(type)s>::GetDebuggerCount() {
    return %(debugger_count)i;
  }

  template <>
  int NativesCollection<%(type)s>::GetIndex(const char* name) {
%(get_index_cases)s\
    return -1;
  }

  template <>
  Vector NativesCollection<%(type)s>::GetScriptSource(int index) {
%(get_script_source_cases)s\
    return Vector("", 0);
  }

  template <>
  Vector NativesCollection<%(type)s>::GetScriptName(int index) {
%(get_script_name_cases)s\
    return Vector("", 0);
  }

  template <>
  Vector NativesCollection<%(type)s>::GetScriptsSource() {
    return Vector(sources, %(total_length)i);
  }
}  // internal
}  // v8
"""

SOURCES_DECLARATION = """\
  static const char sources[] = { %s };
"""


GET_INDEX_CASE = """\
    if (strcmp(name, "%(id)s") == 0) return %(i)i;
"""


GET_SCRIPT_SOURCE_CASE = """\
    if (index == %(i)i) return Vector(sources + %(offset)i, %(source_length)i);
"""


GET_SCRIPT_NAME_CASE = """\
    if (index == %(i)i) return Vector("%(name)s", %(length)i);
"""


def BuildFilterChain(macro_filename, message_template_file):
  """Build the chain of filter functions to be applied to the sources.

  Args:
    macro_filename: Name of the macro file, if any.

  Returns:
    A function (string -> string) that processes a source file.
  """
  filter_chain = []

  if macro_filename:
    (consts, macros) = ReadMacros(ReadFile(macro_filename))
    filter_chain.append(lambda l: ExpandConstants(l, consts))
    filter_chain.append(lambda l: ExpandMacros(l, macros))

  if message_template_file:
    message_templates = ReadMessageTemplates(ReadFile(message_template_file))
    filter_chain.append(lambda l: ExpandConstants(l, message_templates))

  filter_chain.extend([
    RemoveCommentsAndTrailingWhitespace,
    ExpandInlineMacros,
    ExpandInlineConstants,
    Validate,
    jsmin.JavaScriptMinifier().JSMinify
  ])

  def chain(f1, f2):
    return lambda x: f2(f1(x))

  return reduce(chain, filter_chain)

def BuildExtraFilterChain():
  return lambda x: RemoveCommentsAndTrailingWhitespace(Validate(x))

class Sources:
  def __init__(self):
    self.names = []
    self.modules = []
    self.is_debugger_id = []


def IsDebuggerFile(filename):
  return filename.endswith("-debugger.js")

def IsMacroFile(filename):
  return filename.endswith("macros.py")

def IsMessageTemplateFile(filename):
  return filename.endswith("messages.h")


def PrepareSources(source_files, native_type, emit_js):
  """Read, prepare and assemble the list of source files.

  Args:
    source_files: List of JavaScript-ish source files. A file named macros.py
        will be treated as a list of macros.
    native_type: String corresponding to a NativeType enum value, allowing us
        to treat different types of sources differently.
    emit_js: True if we should skip the byte conversion and just leave the
        sources as JS strings.

  Returns:
    An instance of Sources.
  """
  macro_file = None
  macro_files = filter(IsMacroFile, source_files)
  assert len(macro_files) in [0, 1]
  if macro_files:
    source_files.remove(macro_files[0])
    macro_file = macro_files[0]

  message_template_file = None
  message_template_files = filter(IsMessageTemplateFile, source_files)
  assert len(message_template_files) in [0, 1]
  if message_template_files:
    source_files.remove(message_template_files[0])
    message_template_file = message_template_files[0]

  filters = None
  if native_type == "EXTRAS":
    filters = BuildExtraFilterChain()
  else:
    filters = BuildFilterChain(macro_file, message_template_file)

  # Sort 'debugger' sources first.
  source_files = sorted(source_files,
                        lambda l,r: IsDebuggerFile(r) - IsDebuggerFile(l))

  source_files_and_contents = [(f, ReadFile(f)) for f in source_files]

  # Have a single not-quite-empty source file if there are none present;
  # otherwise you get errors trying to compile an empty C++ array.
  # It cannot be empty (or whitespace, which gets trimmed to empty), as
  # the deserialization code assumes each file is nonempty.
  if not source_files_and_contents:
    source_files_and_contents = [("dummy.js", "(function() {})")]

  result = Sources()

  for (source, contents) in source_files_and_contents:
    try:
      lines = filters(contents)
    except Error as e:
      raise Error("In file %s:\n%s" % (source, str(e)))

    result.modules.append(lines)

    is_debugger = IsDebuggerFile(source)
    result.is_debugger_id.append(is_debugger)

    name = os.path.basename(source)[:-3]
    result.names.append(name if not is_debugger else name[:-9])

  return result


def BuildMetadata(sources, source_bytes, native_type):
  """Build the meta data required to generate a libaries file.

  Args:
    sources: A Sources instance with the prepared sources.
    source_bytes: A list of source bytes.
        (The concatenation of all sources; might be compressed.)
    native_type: The parameter for the NativesCollection template.

  Returns:
    A dictionary for use with HEADER_TEMPLATE.
  """
  total_length = len(source_bytes)
  raw_sources = "".join(sources.modules)

  # The sources are expected to be ASCII-only.
  assert not filter(lambda value: ord(value) >= 128, raw_sources)

  # Loop over modules and build up indices into the source blob:
  get_index_cases = []
  get_script_name_cases = []
  get_script_source_cases = []
  offset = 0
  for i in xrange(len(sources.modules)):
    native_name = "native %s.js" % sources.names[i]
    d = {
        "i": i,
        "id": sources.names[i],
        "name": native_name,
        "length": len(native_name),
        "offset": offset,
        "source_length": len(sources.modules[i]),
    }
    get_index_cases.append(GET_INDEX_CASE % d)
    get_script_name_cases.append(GET_SCRIPT_NAME_CASE % d)
    get_script_source_cases.append(GET_SCRIPT_SOURCE_CASE % d)
    offset += len(sources.modules[i])
  assert offset == len(raw_sources)

  metadata = {
    "builtin_count": len(sources.modules),
    "debugger_count": sum(sources.is_debugger_id),
    "sources_declaration": SOURCES_DECLARATION % ToCArray(source_bytes),
    "total_length": total_length,
    "get_index_cases": "".join(get_index_cases),
    "get_script_source_cases": "".join(get_script_source_cases),
    "get_script_name_cases": "".join(get_script_name_cases),
    "type": native_type,
  }
  return metadata


def PutInt(blob_file, value):
  assert(value >= 0 and value < (1 << 28))
  if (value < 1 << 6):
    size = 1
  elif (value < 1 << 14):
    size = 2
  elif (value < 1 << 22):
    size = 3
  else:
    size = 4
  value_with_length = (value << 2) | (size - 1)

  byte_sequence = bytearray()
  for i in xrange(size):
    byte_sequence.append(value_with_length & 255)
    value_with_length >>= 8;
  blob_file.write(byte_sequence)


def PutStr(blob_file, value):
  PutInt(blob_file, len(value));
  blob_file.write(value);


def WriteStartupBlob(sources, startup_blob):
  """Write a startup blob, as expected by V8 Initialize ...
    TODO(vogelheim): Add proper method name.

  Args:
    sources: A Sources instance with the prepared sources.
    startup_blob_file: Name of file to write the blob to.
  """
  output = open(startup_blob, "wb")

  debug_sources = sum(sources.is_debugger_id);
  PutInt(output, debug_sources)
  for i in xrange(debug_sources):
    PutStr(output, sources.names[i]);
    PutStr(output, sources.modules[i]);

  PutInt(output, len(sources.names) - debug_sources)
  for i in xrange(debug_sources, len(sources.names)):
    PutStr(output, sources.names[i]);
    PutStr(output, sources.modules[i]);

  output.close()


def JS2C(sources, target, native_type, raw_file, startup_blob, emit_js):
  prepared_sources = PrepareSources(sources, native_type, emit_js)
  sources_output = "".join(prepared_sources.modules)
  metadata = BuildMetadata(prepared_sources, sources_output, native_type)

  # Optionally emit raw file.
  if raw_file:
    output = open(raw_file, "w")
    output.write(sources_output)
    output.close()

  if startup_blob:
    WriteStartupBlob(prepared_sources, startup_blob)

  # Emit resulting source file.
  output = open(target, "w")
  if emit_js:
    output.write(sources_output)
  else:
    output.write(HEADER_TEMPLATE % metadata)
  output.close()


def main():
  parser = optparse.OptionParser()
  parser.add_option("--raw",
                    help="file to write the processed sources array to.")
  parser.add_option("--startup_blob",
                    help="file to write the startup blob to.")
  parser.add_option("--js",
                    help="writes a JS file output instead of a C file",
                    action="store_true")
  parser.set_usage("""js2c out.cc type sources.js ...
        out.cc: C code to be generated.
        type: type parameter for NativesCollection template.
        sources.js: JS internal sources or macros.py.""")
  (options, args) = parser.parse_args()
  JS2C(args[2:],
       args[0],
       args[1],
       options.raw,
       options.startup_blob,
       options.js)


if __name__ == "__main__":
  main()
node-v4.8.2/deps/v8/tools/jsmin.py000644 000766 000024 00000026167 13070706735 017116 0ustar00iojsstaff000000 000000 #!/usr/bin/python2.4

# Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

"""A JavaScript minifier.

It is far from being a complete JS parser, so there are many valid
JavaScript programs that will be ruined by it.  Another strangeness is that
it accepts $ and % as parts of identifiers.  It doesn't merge lines or strip
out blank lines in order to ease debugging.  Variables at the top scope are
properties of the global object so we can't rename them.  It is assumed that
you introduce variables with var as if JavaScript followed C++ scope rules
around curly braces, so the declaration must be above the first use.

Use as:
import jsmin
minifier = JavaScriptMinifier()
program1 = minifier.JSMinify(program1)
program2 = minifier.JSMinify(program2)
"""

import re


class JavaScriptMinifier(object):
  """An object that you can feed code snippets to to get them minified."""

  def __init__(self):
    # We prepopulate the list of identifiers that shouldn't be used.  These
    # short language keywords could otherwise be used by the script as variable
    # names.
    self.seen_identifiers = {"do": True, "in": True}
    self.identifier_counter = 0
    self.in_comment = False
    self.map = {}
    self.nesting = 0

  def LookAtIdentifier(self, m):
    """Records identifiers or keywords that we see in use.

    (So we can avoid renaming variables to these strings.)
    Args:
      m: The match object returned by re.search.

    Returns:
      Nothing.
    """
    identifier = m.group(1)
    self.seen_identifiers[identifier] = True

  def Push(self):
    """Called when we encounter a '{'."""
    self.nesting += 1

  def Pop(self):
    """Called when we encounter a '}'."""
    self.nesting -= 1
    # We treat each top-level opening brace as a single scope that can span
    # several sets of nested braces.
    if self.nesting == 0:
      self.map = {}
      self.identifier_counter = 0

  def Declaration(self, m):
    """Rewrites bits of the program selected by a regexp.

    These can be curly braces, literal strings, function declarations and var
    declarations.  (These last two must be on one line including the opening
    curly brace of the function for their variables to be renamed).

    Args:
      m: The match object returned by re.search.

    Returns:
      The string that should replace the match in the rewritten program.
    """
    matched_text = m.group(0)

    if matched_text.startswith("`") and matched_text.endswith("`"):
      return re.sub(r"\$\{([\w$%]+)\}",
                    lambda m: '${' + self.FindNewName(m.group(1)) + '}',
                    matched_text)

    if matched_text == "{":
      self.Push()
      return matched_text
    if matched_text == "}":
      self.Pop()
      return matched_text
    if re.match("[\"'/]", matched_text):
      return matched_text
    m = re.match(r"var ", matched_text)
    if m:
      var_names = matched_text[m.end():]
      var_names = re.split(r",", var_names)
      return "var " + ",".join(map(self.FindNewName, var_names))
    m = re.match(r"(function\b[^(]*)\((.*)\)\{$", matched_text)
    if m:
      up_to_args = m.group(1)
      args = m.group(2)
      args = re.split(r",", args)
      self.Push()
      return up_to_args + "(" + ",".join(map(self.FindNewName, args)) + "){"

    if matched_text in self.map:
      return self.map[matched_text]

    return matched_text

  def CharFromNumber(self, number):
    """A single-digit base-52 encoding using a-zA-Z."""
    if number < 26:
      return chr(number + 97)
    number -= 26
    return chr(number + 65)

  def FindNewName(self, var_name):
    """Finds a new 1-character or 2-character name for a variable.

    Enters it into the mapping table for this scope.

    Args:
      var_name: The name of the variable before renaming.

    Returns:
      The new name of the variable.
    """
    new_identifier = ""
    # Variable names that end in _ are member variables of the global object,
    # so they can be visible from code in a different scope.  We leave them
    # alone.
    if var_name in self.map:
      return self.map[var_name]
    if self.nesting == 0:
      return var_name
    # Do not rename arguments object.
    if var_name == 'arguments':
      return 'arguments'
    while True:
      identifier_first_char = self.identifier_counter % 52
      identifier_second_char = self.identifier_counter // 52
      new_identifier = self.CharFromNumber(identifier_first_char)
      if identifier_second_char != 0:
        new_identifier = (
            self.CharFromNumber(identifier_second_char - 1) + new_identifier)
      self.identifier_counter += 1
      if not new_identifier in self.seen_identifiers:
        break

    self.map[var_name] = new_identifier
    return new_identifier

  def RemoveSpaces(self, m):
    """Returns literal strings unchanged, replaces other inputs with group 2.

    Other inputs are replaced with the contents of capture 1.  This is either
    a single space or an empty string.

    Args:
      m: The match object returned by re.search.

    Returns:
      The string that should be inserted instead of the matched text.
    """
    entire_match = m.group(0)
    replacement = m.group(1)
    if re.match(r"'.*'$", entire_match):
      return entire_match
    if re.match(r'".*"$', entire_match):
      return entire_match
    if re.match(r"`.*`$", entire_match):
      return entire_match
    if re.match(r"/.+/$", entire_match):
      return entire_match
    return replacement

  def JSMinify(self, text):
    """The main entry point.  Takes a text and returns a compressed version.

    The compressed version hopefully does the same thing.  Line breaks are
    preserved.

    Args:
      text: The text of the code snippet as a multiline string.

    Returns:
      The compressed text of the code snippet as a multiline string.
    """
    new_lines = []
    for line in re.split(r"\n", text):
      line = line.replace("\t", " ")
      if self.in_comment:
        m = re.search(r"\*/", line)
        if m:
          line = line[m.end():]
          self.in_comment = False
        else:
          new_lines.append("")
          continue

      if not self.in_comment:
        line = re.sub(r"/\*.*?\*/", " ", line)
        line = re.sub(r"//.*", "", line)
        m = re.search(r"/\*", line)
        if m:
          line = line[:m.start()]
          self.in_comment = True

      # Strip leading and trailing spaces.
      line = re.sub(r"^ +", "", line)
      line = re.sub(r" +$", "", line)
      # A regexp that matches a literal string surrounded by "double quotes".
      # This regexp can handle embedded backslash-escaped characters including
      # embedded backslash-escaped double quotes.
      double_quoted_string = r'"(?:[^"\\]|\\.)*"'
      # A regexp that matches a literal string surrounded by 'single quotes'.
      single_quoted_string = r"'(?:[^'\\]|\\.)*'"
      # A regexp that matches a template string
      template_string = r"`(?:[^`\\]|\\.)*`"
      # A regexp that matches a regexp literal surrounded by /slashes/.
      # Don't allow a regexp to have a ) before the first ( since that's a
      # syntax error and it's probably just two unrelated slashes.
      # Also don't allow it to come after anything that can only be the
      # end of a primary expression.
      slash_quoted_regexp = r"(? /dev/null; then
    log_file=${arg}
  fi
done

tools_path=`cd $(dirname "$0");pwd`
if [ ! "$D8_PATH" ]; then
  d8_public=`which d8`
  if [ -x "$d8_public" ]; then D8_PATH=$(dirname "$d8_public"); fi
fi
[ -n "$D8_PATH" ] || D8_PATH=$tools_path/..
d8_exec=$D8_PATH/d8

if [ ! -x "$d8_exec" ]; then
  D8_PATH=`pwd`/out/native
  d8_exec=$D8_PATH/d8
fi

if [ ! -x "$d8_exec" ]; then
  d8_exec=`grep -m 1 -o '".*/d8"' $log_file | sed 's/"//g'`
fi

if [ ! -x "$d8_exec" ]; then
  echo "d8 shell not found in $D8_PATH"
  echo "To build, execute 'make native' from the V8 directory"
  exit 1
fi

# nm spits out 'no symbols found' messages to stderr.
cat $log_file | $d8_exec $tools_path/splaytree.js $tools_path/codemap.js \
  $tools_path/csvparser.js $tools_path/consarray.js \
  $tools_path/profile.js $tools_path/profile_view.js \
  $tools_path/logreader.js $tools_path/tickprocessor.js \
  $tools_path/SourceMap.js \
  $tools_path/tickprocessor-driver.js -- $@ 2>/dev/null
node-v4.8.2/deps/v8/tools/ll_prof.py000755 000766 000024 00000103475 13070706735 017434 0ustar00iojsstaff000000 000000 #!/usr/bin/env python
#
# Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

import bisect
import collections
import ctypes
import disasm
import mmap
import optparse
import os
import re
import subprocess
import sys
import time


USAGE="""usage: %prog [OPTION]...

Analyses V8 and perf logs to produce profiles.

Perf logs can be collected using a command like:
  $ perf record -R -e cycles -c 10000 -f -i ./d8 bench.js --ll-prof
  # -R: collect all data
  # -e cycles: use cpu-cycles event (run "perf list" for details)
  # -c 10000: write a sample after each 10000 events
  # -f: force output file overwrite
  # -i: limit profiling to our process and the kernel
  # --ll-prof shell flag enables the right V8 logs
This will produce a binary trace file (perf.data) that %prog can analyse.

IMPORTANT:
  The kernel has an internal maximum for events per second, it is 100K by
  default. That's not enough for "-c 10000". Set it to some higher value:
  $ echo 10000000 | sudo tee /proc/sys/kernel/perf_event_max_sample_rate
  You can also make the warning about kernel address maps go away:
  $ echo 0 | sudo tee /proc/sys/kernel/kptr_restrict

We have a convenience script that handles all of the above for you:
  $ tools/run-llprof.sh ./d8 bench.js

Examples:
  # Print flat profile with annotated disassembly for the 10 top
  # symbols. Use default log names and include the snapshot log.
  $ %prog --snapshot --disasm-top=10

  # Print flat profile with annotated disassembly for all used symbols.
  # Use default log names and include kernel symbols into analysis.
  $ %prog --disasm-all --kernel

  # Print flat profile. Use custom log names.
  $ %prog --log=foo.log --snapshot-log=snap-foo.log --trace=foo.data --snapshot
"""


JS_ORIGIN = "js"
JS_SNAPSHOT_ORIGIN = "js-snapshot"

class Code(object):
  """Code object."""

  _id = 0
  UNKNOWN = 0
  V8INTERNAL = 1
  FULL_CODEGEN = 2
  OPTIMIZED = 3

  def __init__(self, name, start_address, end_address, origin, origin_offset):
    self.id = Code._id
    Code._id += 1
    self.name = name
    self.other_names = None
    self.start_address = start_address
    self.end_address = end_address
    self.origin = origin
    self.origin_offset = origin_offset
    self.self_ticks = 0
    self.self_ticks_map = None
    self.callee_ticks = None
    if name.startswith("LazyCompile:*"):
      self.codetype = Code.OPTIMIZED
    elif name.startswith("LazyCompile:"):
      self.codetype = Code.FULL_CODEGEN
    elif name.startswith("v8::internal::"):
      self.codetype = Code.V8INTERNAL
    else:
      self.codetype = Code.UNKNOWN

  def AddName(self, name):
    assert self.name != name
    if self.other_names is None:
      self.other_names = [name]
      return
    if not name in self.other_names:
      self.other_names.append(name)

  def FullName(self):
    if self.other_names is None:
      return self.name
    self.other_names.sort()
    return "%s (aka %s)" % (self.name, ", ".join(self.other_names))

  def IsUsed(self):
    return self.self_ticks > 0 or self.callee_ticks is not None

  def Tick(self, pc):
    self.self_ticks += 1
    if self.self_ticks_map is None:
      self.self_ticks_map = collections.defaultdict(lambda: 0)
    offset = pc - self.start_address
    self.self_ticks_map[offset] += 1

  def CalleeTick(self, callee):
    if self.callee_ticks is None:
      self.callee_ticks = collections.defaultdict(lambda: 0)
    self.callee_ticks[callee] += 1

  def PrintAnnotated(self, arch, options):
    if self.self_ticks_map is None:
      ticks_map = []
    else:
      ticks_map = self.self_ticks_map.items()
    # Convert the ticks map to offsets and counts arrays so that later
    # we can do binary search in the offsets array.
    ticks_map.sort(key=lambda t: t[0])
    ticks_offsets = [t[0] for t in ticks_map]
    ticks_counts = [t[1] for t in ticks_map]
    # Get a list of disassembled lines and their addresses.
    lines = self._GetDisasmLines(arch, options)
    if len(lines) == 0:
      return
    # Print annotated lines.
    address = lines[0][0]
    total_count = 0
    for i in xrange(len(lines)):
      start_offset = lines[i][0] - address
      if i == len(lines) - 1:
        end_offset = self.end_address - self.start_address
      else:
        end_offset = lines[i + 1][0] - address
      # Ticks (reported pc values) are not always precise, i.e. not
      # necessarily point at instruction starts. So we have to search
      # for ticks that touch the current instruction line.
      j = bisect.bisect_left(ticks_offsets, end_offset)
      count = 0
      for offset, cnt in reversed(zip(ticks_offsets[:j], ticks_counts[:j])):
        if offset < start_offset:
          break
        count += cnt
      total_count += count
      count = 100.0 * count / self.self_ticks
      if count >= 0.01:
        print "%15.2f %x: %s" % (count, lines[i][0], lines[i][1])
      else:
        print "%s %x: %s" % (" " * 15, lines[i][0], lines[i][1])
    print
    assert total_count == self.self_ticks, \
        "Lost ticks (%d != %d) in %s" % (total_count, self.self_ticks, self)

  def __str__(self):
    return "%s [0x%x, 0x%x) size: %d origin: %s" % (
      self.name,
      self.start_address,
      self.end_address,
      self.end_address - self.start_address,
      self.origin)

  def _GetDisasmLines(self, arch, options):
    if self.origin == JS_ORIGIN or self.origin == JS_SNAPSHOT_ORIGIN:
      inplace = False
      filename = options.log + ".ll"
    else:
      inplace = True
      filename = self.origin
    return disasm.GetDisasmLines(filename,
                                 self.origin_offset,
                                 self.end_address - self.start_address,
                                 arch,
                                 inplace)


class CodePage(object):
  """Group of adjacent code objects."""

  SHIFT = 20  # 1M pages
  SIZE = (1 << SHIFT)
  MASK = ~(SIZE - 1)

  @staticmethod
  def PageAddress(address):
    return address & CodePage.MASK

  @staticmethod
  def PageId(address):
    return address >> CodePage.SHIFT

  @staticmethod
  def PageAddressFromId(id):
    return id << CodePage.SHIFT

  def __init__(self, address):
    self.address = address
    self.code_objects = []

  def Add(self, code):
    self.code_objects.append(code)

  def Remove(self, code):
    self.code_objects.remove(code)

  def Find(self, pc):
    code_objects = self.code_objects
    for i, code in enumerate(code_objects):
      if code.start_address <= pc < code.end_address:
        code_objects[0], code_objects[i] = code, code_objects[0]
        return code
    return None

  def __iter__(self):
    return self.code_objects.__iter__()


class CodeMap(object):
  """Code object map."""

  def __init__(self):
    self.pages = {}
    self.min_address = 1 << 64
    self.max_address = -1

  def Add(self, code, max_pages=-1):
    page_id = CodePage.PageId(code.start_address)
    limit_id = CodePage.PageId(code.end_address + CodePage.SIZE - 1)
    pages = 0
    while page_id < limit_id:
      if max_pages >= 0 and pages > max_pages:
        print >>sys.stderr, \
            "Warning: page limit (%d) reached for %s [%s]" % (
            max_pages, code.name, code.origin)
        break
      if page_id in self.pages:
        page = self.pages[page_id]
      else:
        page = CodePage(CodePage.PageAddressFromId(page_id))
        self.pages[page_id] = page
      page.Add(code)
      page_id += 1
      pages += 1
    self.min_address = min(self.min_address, code.start_address)
    self.max_address = max(self.max_address, code.end_address)

  def Remove(self, code):
    page_id = CodePage.PageId(code.start_address)
    limit_id = CodePage.PageId(code.end_address + CodePage.SIZE - 1)
    removed = False
    while page_id < limit_id:
      if page_id not in self.pages:
        page_id += 1
        continue
      page = self.pages[page_id]
      page.Remove(code)
      removed = True
      page_id += 1
    return removed

  def AllCode(self):
    for page in self.pages.itervalues():
      for code in page:
        if CodePage.PageAddress(code.start_address) == page.address:
          yield code

  def UsedCode(self):
    for code in self.AllCode():
      if code.IsUsed():
        yield code

  def Print(self):
    for code in self.AllCode():
      print code

  def Find(self, pc):
    if pc < self.min_address or pc >= self.max_address:
      return None
    page_id = CodePage.PageId(pc)
    if page_id not in self.pages:
      return None
    return self.pages[page_id].Find(pc)


class CodeInfo(object):
  """Generic info about generated code objects."""

  def __init__(self, arch, header_size):
    self.arch = arch
    self.header_size = header_size


class SnapshotLogReader(object):
  """V8 snapshot log reader."""

  _SNAPSHOT_CODE_NAME_RE = re.compile(
    r"snapshot-code-name,(\d+),\"(.*)\"")

  def __init__(self, log_name):
    self.log_name = log_name

  def ReadNameMap(self):
    log = open(self.log_name, "r")
    try:
      snapshot_pos_to_name = {}
      for line in log:
        match = SnapshotLogReader._SNAPSHOT_CODE_NAME_RE.match(line)
        if match:
          pos = int(match.group(1))
          name = match.group(2)
          snapshot_pos_to_name[pos] = name
    finally:
      log.close()
    return snapshot_pos_to_name


class LogReader(object):
  """V8 low-level (binary) log reader."""

  _ARCH_TO_POINTER_TYPE_MAP = {
    "ia32": ctypes.c_uint32,
    "arm": ctypes.c_uint32,
    "mips": ctypes.c_uint32,
    "x64": ctypes.c_uint64,
    "arm64": ctypes.c_uint64
  }

  _CODE_CREATE_TAG = "C"
  _CODE_MOVE_TAG = "M"
  _CODE_DELETE_TAG = "D"
  _SNAPSHOT_POSITION_TAG = "P"
  _CODE_MOVING_GC_TAG = "G"

  def __init__(self, log_name, code_map, snapshot_pos_to_name):
    self.log_file = open(log_name, "r")
    self.log = mmap.mmap(self.log_file.fileno(), 0, mmap.MAP_PRIVATE)
    self.log_pos = 0
    self.code_map = code_map
    self.snapshot_pos_to_name = snapshot_pos_to_name
    self.address_to_snapshot_name = {}

    self.arch = self.log[:self.log.find("\0")]
    self.log_pos += len(self.arch) + 1
    assert self.arch in LogReader._ARCH_TO_POINTER_TYPE_MAP, \
        "Unsupported architecture %s" % self.arch
    pointer_type = LogReader._ARCH_TO_POINTER_TYPE_MAP[self.arch]

    self.code_create_struct = LogReader._DefineStruct([
        ("name_size", ctypes.c_int32),
        ("code_address", pointer_type),
        ("code_size", ctypes.c_int32)])

    self.code_move_struct = LogReader._DefineStruct([
        ("from_address", pointer_type),
        ("to_address", pointer_type)])

    self.code_delete_struct = LogReader._DefineStruct([
        ("address", pointer_type)])

    self.snapshot_position_struct = LogReader._DefineStruct([
        ("address", pointer_type),
        ("position", ctypes.c_int32)])

  def ReadUpToGC(self):
    while self.log_pos < self.log.size():
      tag = self.log[self.log_pos]
      self.log_pos += 1

      if tag == LogReader._CODE_MOVING_GC_TAG:
        self.address_to_snapshot_name.clear()
        return

      if tag == LogReader._CODE_CREATE_TAG:
        event = self.code_create_struct.from_buffer(self.log, self.log_pos)
        self.log_pos += ctypes.sizeof(event)
        start_address = event.code_address
        end_address = start_address + event.code_size
        if start_address in self.address_to_snapshot_name:
          name = self.address_to_snapshot_name[start_address]
          origin = JS_SNAPSHOT_ORIGIN
        else:
          name = self.log[self.log_pos:self.log_pos + event.name_size]
          origin = JS_ORIGIN
        self.log_pos += event.name_size
        origin_offset = self.log_pos
        self.log_pos += event.code_size
        code = Code(name, start_address, end_address, origin, origin_offset)
        conficting_code = self.code_map.Find(start_address)
        if conficting_code:
          if not (conficting_code.start_address == code.start_address and
            conficting_code.end_address == code.end_address):
            self.code_map.Remove(conficting_code)
          else:
            LogReader._HandleCodeConflict(conficting_code, code)
            # TODO(vitalyr): this warning is too noisy because of our
            # attempts to reconstruct code log from the snapshot.
            # print >>sys.stderr, \
            #     "Warning: Skipping duplicate code log entry %s" % code
            continue
        self.code_map.Add(code)
        continue

      if tag == LogReader._CODE_MOVE_TAG:
        event = self.code_move_struct.from_buffer(self.log, self.log_pos)
        self.log_pos += ctypes.sizeof(event)
        old_start_address = event.from_address
        new_start_address = event.to_address
        if old_start_address == new_start_address:
          # Skip useless code move entries.
          continue
        code = self.code_map.Find(old_start_address)
        if not code:
          print >>sys.stderr, "Warning: Not found %x" % old_start_address
          continue
        assert code.start_address == old_start_address, \
            "Inexact move address %x for %s" % (old_start_address, code)
        self.code_map.Remove(code)
        size = code.end_address - code.start_address
        code.start_address = new_start_address
        code.end_address = new_start_address + size
        self.code_map.Add(code)
        continue

      if tag == LogReader._CODE_DELETE_TAG:
        event = self.code_delete_struct.from_buffer(self.log, self.log_pos)
        self.log_pos += ctypes.sizeof(event)
        old_start_address = event.address
        code = self.code_map.Find(old_start_address)
        if not code:
          print >>sys.stderr, "Warning: Not found %x" % old_start_address
          continue
        assert code.start_address == old_start_address, \
            "Inexact delete address %x for %s" % (old_start_address, code)
        self.code_map.Remove(code)
        continue

      if tag == LogReader._SNAPSHOT_POSITION_TAG:
        event = self.snapshot_position_struct.from_buffer(self.log,
                                                          self.log_pos)
        self.log_pos += ctypes.sizeof(event)
        start_address = event.address
        snapshot_pos = event.position
        if snapshot_pos in self.snapshot_pos_to_name:
          self.address_to_snapshot_name[start_address] = \
              self.snapshot_pos_to_name[snapshot_pos]
        continue

      assert False, "Unknown tag %s" % tag

  def Dispose(self):
    self.log.close()
    self.log_file.close()

  @staticmethod
  def _DefineStruct(fields):
    class Struct(ctypes.Structure):
      _fields_ = fields
    return Struct

  @staticmethod
  def _HandleCodeConflict(old_code, new_code):
    assert (old_code.start_address == new_code.start_address and
            old_code.end_address == new_code.end_address), \
        "Conficting code log entries %s and %s" % (old_code, new_code)
    if old_code.name == new_code.name:
      return
    # Code object may be shared by a few functions. Collect the full
    # set of names.
    old_code.AddName(new_code.name)


class Descriptor(object):
  """Descriptor of a structure in the binary trace log."""

  CTYPE_MAP = {
    "u16": ctypes.c_uint16,
    "u32": ctypes.c_uint32,
    "u64": ctypes.c_uint64
  }

  def __init__(self, fields):
    class TraceItem(ctypes.Structure):
      _fields_ = Descriptor.CtypesFields(fields)

      def __str__(self):
        return ", ".join("%s: %s" % (field, self.__getattribute__(field))
                         for field, _ in TraceItem._fields_)

    self.ctype = TraceItem

  def Read(self, trace, offset):
    return self.ctype.from_buffer(trace, offset)

  @staticmethod
  def CtypesFields(fields):
    return [(field, Descriptor.CTYPE_MAP[format]) for (field, format) in fields]


# Please see http://git.kernel.org/?p=linux/kernel/git/torvalds/linux-2.6.git;a=tree;f=tools/perf
# for the gory details.


# Reference: struct perf_file_header in kernel/tools/perf/util/header.h
TRACE_HEADER_DESC = Descriptor([
  ("magic", "u64"),
  ("size", "u64"),
  ("attr_size", "u64"),
  ("attrs_offset", "u64"),
  ("attrs_size", "u64"),
  ("data_offset", "u64"),
  ("data_size", "u64"),
  ("event_types_offset", "u64"),
  ("event_types_size", "u64")
])


# Reference: /usr/include/linux/perf_event.h
PERF_EVENT_ATTR_DESC = Descriptor([
  ("type", "u32"),
  ("size", "u32"),
  ("config", "u64"),
  ("sample_period_or_freq", "u64"),
  ("sample_type", "u64"),
  ("read_format", "u64"),
  ("flags", "u64"),
  ("wakeup_events_or_watermark", "u32"),
  ("bp_type", "u32"),
  ("bp_addr", "u64"),
  ("bp_len", "u64")
])


# Reference: /usr/include/linux/perf_event.h
PERF_EVENT_HEADER_DESC = Descriptor([
  ("type", "u32"),
  ("misc", "u16"),
  ("size", "u16")
])


# Reference: kernel/events/core.c
PERF_MMAP_EVENT_BODY_DESC = Descriptor([
  ("pid", "u32"),
  ("tid", "u32"),
  ("addr", "u64"),
  ("len", "u64"),
  ("pgoff", "u64")
])


# perf_event_attr.sample_type bits control the set of
# perf_sample_event fields.
PERF_SAMPLE_IP = 1 << 0
PERF_SAMPLE_TID = 1 << 1
PERF_SAMPLE_TIME = 1 << 2
PERF_SAMPLE_ADDR = 1 << 3
PERF_SAMPLE_READ = 1 << 4
PERF_SAMPLE_CALLCHAIN = 1 << 5
PERF_SAMPLE_ID = 1 << 6
PERF_SAMPLE_CPU = 1 << 7
PERF_SAMPLE_PERIOD = 1 << 8
PERF_SAMPLE_STREAM_ID = 1 << 9
PERF_SAMPLE_RAW = 1 << 10


# Reference: /usr/include/perf_event.h, the comment for PERF_RECORD_SAMPLE.
PERF_SAMPLE_EVENT_BODY_FIELDS = [
  ("ip", "u64", PERF_SAMPLE_IP),
  ("pid", "u32", PERF_SAMPLE_TID),
  ("tid", "u32", PERF_SAMPLE_TID),
  ("time", "u64", PERF_SAMPLE_TIME),
  ("addr", "u64", PERF_SAMPLE_ADDR),
  ("id", "u64", PERF_SAMPLE_ID),
  ("stream_id", "u64", PERF_SAMPLE_STREAM_ID),
  ("cpu", "u32", PERF_SAMPLE_CPU),
  ("res", "u32", PERF_SAMPLE_CPU),
  ("period", "u64", PERF_SAMPLE_PERIOD),
  # Don't want to handle read format that comes after the period and
  # before the callchain and has variable size.
  ("nr", "u64", PERF_SAMPLE_CALLCHAIN)
  # Raw data follows the callchain and is ignored.
]


PERF_SAMPLE_EVENT_IP_FORMAT = "u64"


PERF_RECORD_MMAP = 1
PERF_RECORD_SAMPLE = 9


class TraceReader(object):
  """Perf (linux-2.6/tools/perf) trace file reader."""

  _TRACE_HEADER_MAGIC = 4993446653023372624

  def __init__(self, trace_name):
    self.trace_file = open(trace_name, "r")
    self.trace = mmap.mmap(self.trace_file.fileno(), 0, mmap.MAP_PRIVATE)
    self.trace_header = TRACE_HEADER_DESC.Read(self.trace, 0)
    if self.trace_header.magic != TraceReader._TRACE_HEADER_MAGIC:
      print >>sys.stderr, "Warning: unsupported trace header magic"
    self.offset = self.trace_header.data_offset
    self.limit = self.trace_header.data_offset + self.trace_header.data_size
    assert self.limit <= self.trace.size(), \
        "Trace data limit exceeds trace file size"
    self.header_size = ctypes.sizeof(PERF_EVENT_HEADER_DESC.ctype)
    assert self.trace_header.attrs_size != 0, \
        "No perf event attributes found in the trace"
    perf_event_attr = PERF_EVENT_ATTR_DESC.Read(self.trace,
                                                self.trace_header.attrs_offset)
    self.sample_event_body_desc = self._SampleEventBodyDesc(
        perf_event_attr.sample_type)
    self.callchain_supported = \
        (perf_event_attr.sample_type & PERF_SAMPLE_CALLCHAIN) != 0
    if self.callchain_supported:
      self.ip_struct = Descriptor.CTYPE_MAP[PERF_SAMPLE_EVENT_IP_FORMAT]
      self.ip_size = ctypes.sizeof(self.ip_struct)

  def ReadEventHeader(self):
    if self.offset >= self.limit:
      return None, 0
    offset = self.offset
    header = PERF_EVENT_HEADER_DESC.Read(self.trace, self.offset)
    self.offset += header.size
    return header, offset

  def ReadMmap(self, header, offset):
    mmap_info = PERF_MMAP_EVENT_BODY_DESC.Read(self.trace,
                                               offset + self.header_size)
    # Read null-terminated filename.
    filename = self.trace[offset + self.header_size + ctypes.sizeof(mmap_info):
                          offset + header.size]
    mmap_info.filename = HOST_ROOT + filename[:filename.find(chr(0))]
    return mmap_info

  def ReadSample(self, header, offset):
    sample = self.sample_event_body_desc.Read(self.trace,
                                              offset + self.header_size)
    if not self.callchain_supported:
      return sample
    sample.ips = []
    offset += self.header_size + ctypes.sizeof(sample)
    for _ in xrange(sample.nr):
      sample.ips.append(
        self.ip_struct.from_buffer(self.trace, offset).value)
      offset += self.ip_size
    return sample

  def Dispose(self):
    self.trace.close()
    self.trace_file.close()

  def _SampleEventBodyDesc(self, sample_type):
    assert (sample_type & PERF_SAMPLE_READ) == 0, \
           "Can't hande read format in samples"
    fields = [(field, format)
              for (field, format, bit) in PERF_SAMPLE_EVENT_BODY_FIELDS
              if (bit & sample_type) != 0]
    return Descriptor(fields)


OBJDUMP_SECTION_HEADER_RE = re.compile(
  r"^\s*\d+\s(\.\S+)\s+[a-f0-9]")
OBJDUMP_SYMBOL_LINE_RE = re.compile(
  r"^([a-f0-9]+)\s(.{7})\s(\S+)\s+([a-f0-9]+)\s+(?:\.hidden\s+)?(.*)$")
OBJDUMP_DYNAMIC_SYMBOLS_START_RE = re.compile(
  r"^DYNAMIC SYMBOL TABLE")
OBJDUMP_SKIP_RE = re.compile(
  r"^.*ld\.so\.cache$")
KERNEL_ALLSYMS_FILE = "/proc/kallsyms"
PERF_KERNEL_ALLSYMS_RE = re.compile(
  r".*kallsyms.*")
KERNEL_ALLSYMS_LINE_RE = re.compile(
  r"^([a-f0-9]+)\s(?:t|T)\s(\S+)$")


class LibraryRepo(object):
  def __init__(self):
    self.infos = []
    self.names = set()
    self.ticks = {}


  def HasDynamicSymbols(self, filename):
    if filename.endswith(".ko"): return False
    process = subprocess.Popen(
      "%s -h %s" % (OBJDUMP_BIN, filename),
      shell=True, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
    pipe = process.stdout
    try:
      for line in pipe:
        match = OBJDUMP_SECTION_HEADER_RE.match(line)
        if match and match.group(1) == 'dynsym': return True
    finally:
      pipe.close()
    assert process.wait() == 0, "Failed to objdump -h %s" % filename
    return False


  def Load(self, mmap_info, code_map, options):
    # Skip kernel mmaps when requested using the fact that their tid
    # is 0.
    if mmap_info.tid == 0 and not options.kernel:
      return True
    if OBJDUMP_SKIP_RE.match(mmap_info.filename):
      return True
    if PERF_KERNEL_ALLSYMS_RE.match(mmap_info.filename):
      return self._LoadKernelSymbols(code_map)
    self.infos.append(mmap_info)
    mmap_info.ticks = 0
    mmap_info.unique_name = self._UniqueMmapName(mmap_info)
    if not os.path.exists(mmap_info.filename):
      return True
    # Request section headers (-h), symbols (-t), and dynamic symbols
    # (-T) from objdump.
    # Unfortunately, section headers span two lines, so we have to
    # keep the just seen section name (from the first line in each
    # section header) in the after_section variable.
    if self.HasDynamicSymbols(mmap_info.filename):
      dynamic_symbols = "-T"
    else:
      dynamic_symbols = ""
    process = subprocess.Popen(
      "%s -h -t %s -C %s" % (OBJDUMP_BIN, dynamic_symbols, mmap_info.filename),
      shell=True, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
    pipe = process.stdout
    after_section = None
    code_sections = set()
    reloc_sections = set()
    dynamic = False
    try:
      for line in pipe:
        if after_section:
          if line.find("CODE") != -1:
            code_sections.add(after_section)
          if line.find("RELOC") != -1:
            reloc_sections.add(after_section)
          after_section = None
          continue

        match = OBJDUMP_SECTION_HEADER_RE.match(line)
        if match:
          after_section = match.group(1)
          continue

        if OBJDUMP_DYNAMIC_SYMBOLS_START_RE.match(line):
          dynamic = True
          continue

        match = OBJDUMP_SYMBOL_LINE_RE.match(line)
        if match:
          start_address = int(match.group(1), 16)
          origin_offset = start_address
          flags = match.group(2)
          section = match.group(3)
          if section in code_sections:
            if dynamic or section in reloc_sections:
              start_address += mmap_info.addr
            size = int(match.group(4), 16)
            name = match.group(5)
            origin = mmap_info.filename
            code_map.Add(Code(name, start_address, start_address + size,
                              origin, origin_offset))
    finally:
      pipe.close()
    assert process.wait() == 0, "Failed to objdump %s" % mmap_info.filename

  def Tick(self, pc):
    for i, mmap_info in enumerate(self.infos):
      if mmap_info.addr <= pc < (mmap_info.addr + mmap_info.len):
        mmap_info.ticks += 1
        self.infos[0], self.infos[i] = mmap_info, self.infos[0]
        return True
    return False

  def _UniqueMmapName(self, mmap_info):
    name = mmap_info.filename
    index = 1
    while name in self.names:
      name = "%s-%d" % (mmap_info.filename, index)
      index += 1
    self.names.add(name)
    return name

  def _LoadKernelSymbols(self, code_map):
    if not os.path.exists(KERNEL_ALLSYMS_FILE):
      print >>sys.stderr, "Warning: %s not found" % KERNEL_ALLSYMS_FILE
      return False
    kallsyms = open(KERNEL_ALLSYMS_FILE, "r")
    code = None
    for line in kallsyms:
      match = KERNEL_ALLSYMS_LINE_RE.match(line)
      if match:
        start_address = int(match.group(1), 16)
        end_address = start_address
        name = match.group(2)
        if code:
          code.end_address = start_address
          code_map.Add(code, 16)
        code = Code(name, start_address, end_address, "kernel", 0)
    return True


def PrintReport(code_map, library_repo, arch, ticks, options):
  print "Ticks per symbol:"
  used_code = [code for code in code_map.UsedCode()]
  used_code.sort(key=lambda x: x.self_ticks, reverse=True)
  for i, code in enumerate(used_code):
    code_ticks = code.self_ticks
    print "%10d %5.1f%% %s [%s]" % (code_ticks, 100. * code_ticks / ticks,
                                    code.FullName(), code.origin)
    if options.disasm_all or i < options.disasm_top:
      code.PrintAnnotated(arch, options)
  print
  print "Ticks per library:"
  mmap_infos = [m for m in library_repo.infos if m.ticks > 0]
  mmap_infos.sort(key=lambda m: m.ticks, reverse=True)
  for mmap_info in mmap_infos:
    mmap_ticks = mmap_info.ticks
    print "%10d %5.1f%% %s" % (mmap_ticks, 100. * mmap_ticks / ticks,
                               mmap_info.unique_name)


def PrintDot(code_map, options):
  print "digraph G {"
  for code in code_map.UsedCode():
    if code.self_ticks < 10:
      continue
    print "n%d [shape=box,label=\"%s\"];" % (code.id, code.name)
    if code.callee_ticks:
      for callee, ticks in code.callee_ticks.iteritems():
        print "n%d -> n%d [label=\"%d\"];" % (code.id, callee.id, ticks)
  print "}"


if __name__ == "__main__":
  parser = optparse.OptionParser(USAGE)
  parser.add_option("--snapshot-log",
                    default="obj/release/snapshot.log",
                    help="V8 snapshot log file name [default: %default]")
  parser.add_option("--log",
                    default="v8.log",
                    help="V8 log file name [default: %default]")
  parser.add_option("--snapshot",
                    default=False,
                    action="store_true",
                    help="process V8 snapshot log [default: %default]")
  parser.add_option("--trace",
                    default="perf.data",
                    help="perf trace file name [default: %default]")
  parser.add_option("--kernel",
                    default=False,
                    action="store_true",
                    help="process kernel entries [default: %default]")
  parser.add_option("--disasm-top",
                    default=0,
                    type="int",
                    help=("number of top symbols to disassemble and annotate "
                          "[default: %default]"))
  parser.add_option("--disasm-all",
                    default=False,
                    action="store_true",
                    help=("disassemble and annotate all used symbols "
                          "[default: %default]"))
  parser.add_option("--dot",
                    default=False,
                    action="store_true",
                    help="produce dot output (WIP) [default: %default]")
  parser.add_option("--quiet", "-q",
                    default=False,
                    action="store_true",
                    help="no auxiliary messages [default: %default]")
  parser.add_option("--gc-fake-mmap",
                    default="/tmp/__v8_gc__",
                    help="gc fake mmap file [default: %default]")
  parser.add_option("--objdump",
                    default="/usr/bin/objdump",
                    help="objdump tool to use [default: %default]")
  parser.add_option("--host-root",
                    default="",
                    help="Path to the host root [default: %default]")
  options, args = parser.parse_args()

  if not options.quiet:
    if options.snapshot:
      print "V8 logs: %s, %s, %s.ll" % (options.snapshot_log,
                                        options.log,
                                        options.log)
    else:
      print "V8 log: %s, %s.ll (no snapshot)" % (options.log, options.log)
    print "Perf trace file: %s" % options.trace

  V8_GC_FAKE_MMAP = options.gc_fake_mmap
  HOST_ROOT = options.host_root
  if os.path.exists(options.objdump):
    disasm.OBJDUMP_BIN = options.objdump
    OBJDUMP_BIN = options.objdump
  else:
    print "Cannot find %s, falling back to default objdump" % options.objdump

  # Stats.
  events = 0
  ticks = 0
  missed_ticks = 0
  really_missed_ticks = 0
  optimized_ticks = 0
  generated_ticks = 0
  v8_internal_ticks = 0
  mmap_time = 0
  sample_time = 0

  # Process the snapshot log to fill the snapshot name map.
  snapshot_name_map = {}
  if options.snapshot:
    snapshot_log_reader = SnapshotLogReader(log_name=options.snapshot_log)
    snapshot_name_map = snapshot_log_reader.ReadNameMap()

  # Initialize the log reader.
  code_map = CodeMap()
  log_reader = LogReader(log_name=options.log + ".ll",
                         code_map=code_map,
                         snapshot_pos_to_name=snapshot_name_map)
  if not options.quiet:
    print "Generated code architecture: %s" % log_reader.arch
    print
    sys.stdout.flush()

  # Process the code and trace logs.
  library_repo = LibraryRepo()
  log_reader.ReadUpToGC()
  trace_reader = TraceReader(options.trace)
  while True:
    header, offset = trace_reader.ReadEventHeader()
    if not header:
      break
    events += 1
    if header.type == PERF_RECORD_MMAP:
      start = time.time()
      mmap_info = trace_reader.ReadMmap(header, offset)
      if mmap_info.filename == HOST_ROOT + V8_GC_FAKE_MMAP:
        log_reader.ReadUpToGC()
      else:
        library_repo.Load(mmap_info, code_map, options)
      mmap_time += time.time() - start
    elif header.type == PERF_RECORD_SAMPLE:
      ticks += 1
      start = time.time()
      sample = trace_reader.ReadSample(header, offset)
      code = code_map.Find(sample.ip)
      if code:
        code.Tick(sample.ip)
        if code.codetype == Code.OPTIMIZED:
          optimized_ticks += 1
        elif code.codetype == Code.FULL_CODEGEN:
          generated_ticks += 1
        elif code.codetype == Code.V8INTERNAL:
          v8_internal_ticks += 1
      else:
        missed_ticks += 1
      if not library_repo.Tick(sample.ip) and not code:
        really_missed_ticks += 1
      if trace_reader.callchain_supported:
        for ip in sample.ips:
          caller_code = code_map.Find(ip)
          if caller_code:
            if code:
              caller_code.CalleeTick(code)
            code = caller_code
      sample_time += time.time() - start

  if options.dot:
    PrintDot(code_map, options)
  else:
    PrintReport(code_map, library_repo, log_reader.arch, ticks, options)

    if not options.quiet:
      def PrintTicks(number, total, description):
        print("%10d %5.1f%% ticks in %s" %
              (number, 100.0*number/total, description))
      print
      print "Stats:"
      print "%10d total trace events" % events
      print "%10d total ticks" % ticks
      print "%10d ticks not in symbols" % missed_ticks
      unaccounted = "unaccounted ticks"
      if really_missed_ticks > 0:
        unaccounted += " (probably in the kernel, try --kernel)"
      PrintTicks(really_missed_ticks, ticks, unaccounted)
      PrintTicks(optimized_ticks, ticks, "ticks in optimized code")
      PrintTicks(generated_ticks, ticks, "ticks in other lazily compiled code")
      PrintTicks(v8_internal_ticks, ticks, "ticks in v8::internal::*")
      print "%10d total symbols" % len([c for c in code_map.AllCode()])
      print "%10d used symbols" % len([c for c in code_map.UsedCode()])
      print "%9.2fs library processing time" % mmap_time
      print "%9.2fs tick processing time" % sample_time

  log_reader.Dispose()
  trace_reader.Dispose()
node-v4.8.2/deps/v8/tools/logreader.js000644 000766 000024 00000014427 13070706735 017722 0ustar00iojsstaff000000 000000 // Copyright 2011 the V8 project authors. All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
//       copyright notice, this list of conditions and the following
//       disclaimer in the documentation and/or other materials provided
//       with the distribution.
//     * Neither the name of Google Inc. nor the names of its
//       contributors may be used to endorse or promote products derived
//       from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

/**
 * @fileoverview Log Reader is used to process log file produced by V8.
 */


/**
 * Base class for processing log files.
 *
 * @param {Array.} dispatchTable A table used for parsing and processing
 *     log records.
 * @param {boolean} timedRange Ignore ticks outside timed range.
 * @param {boolean} pairwiseTimedRange Ignore ticks outside pairs of timer
 *     markers.
 * @constructor
 */
function LogReader(dispatchTable, timedRange, pairwiseTimedRange) {
  /**
   * @type {Array.}
   */
  this.dispatchTable_ = dispatchTable;

  /**
   * @type {boolean}
   */
  this.timedRange_ = timedRange;

  /**
   * @type {boolean}
   */
  this.pairwiseTimedRange_ = pairwiseTimedRange;
  if (pairwiseTimedRange) {
    this.timedRange_ = true;
  }

  /**
   * Current line.
   * @type {number}
   */
  this.lineNum_ = 0;

  /**
   * CSV lines parser.
   * @type {CsvParser}
   */
  this.csvParser_ = new CsvParser();

  /**
   * Keeps track of whether we've seen a "current-time" tick yet.
   * @type {boolean}
   */
  this.hasSeenTimerMarker_ = false;

  /**
   * List of log lines seen since last "current-time" tick.
   * @type {Array.}
   */
  this.logLinesSinceLastTimerMarker_ = [];
};


/**
 * Used for printing error messages.
 *
 * @param {string} str Error message.
 */
LogReader.prototype.printError = function(str) {
  // Do nothing.
};


/**
 * Processes a portion of V8 profiler event log.
 *
 * @param {string} chunk A portion of log.
 */
LogReader.prototype.processLogChunk = function(chunk) {
  this.processLog_(chunk.split('\n'));
};


/**
 * Processes a line of V8 profiler event log.
 *
 * @param {string} line A line of log.
 */
LogReader.prototype.processLogLine = function(line) {
  if (!this.timedRange_) {
    this.processLog_([line]);
    return;
  }
  if (line.startsWith("current-time")) {
    if (this.hasSeenTimerMarker_) {
      this.processLog_(this.logLinesSinceLastTimerMarker_);
      this.logLinesSinceLastTimerMarker_ = [];
      // In pairwise mode, a "current-time" line ends the timed range.
      if (this.pairwiseTimedRange_) {
        this.hasSeenTimerMarker_ = false;
      }
    } else {
      this.hasSeenTimerMarker_ = true;
    }
  } else {
    if (this.hasSeenTimerMarker_) {
      this.logLinesSinceLastTimerMarker_.push(line);
    } else if (!line.startsWith("tick")) {
      this.processLog_([line]);
    }
  }
};


/**
 * Processes stack record.
 *
 * @param {number} pc Program counter.
 * @param {number} func JS Function.
 * @param {Array.} stack String representation of a stack.
 * @return {Array.} Processed stack.
 */
LogReader.prototype.processStack = function(pc, func, stack) {
  var fullStack = func ? [pc, func] : [pc];
  var prevFrame = pc;
  for (var i = 0, n = stack.length; i < n; ++i) {
    var frame = stack[i];
    var firstChar = frame.charAt(0);
    if (firstChar == '+' || firstChar == '-') {
      // An offset from the previous frame.
      prevFrame += parseInt(frame, 16);
      fullStack.push(prevFrame);
    // Filter out possible 'overflow' string.
    } else if (firstChar != 'o') {
      fullStack.push(parseInt(frame, 16));
    } else {
      print("dropping: " + frame);
    }
  }
  return fullStack;
};


/**
 * Returns whether a particular dispatch must be skipped.
 *
 * @param {!Object} dispatch Dispatch record.
 * @return {boolean} True if dispatch must be skipped.
 */
LogReader.prototype.skipDispatch = function(dispatch) {
  return false;
};


/**
 * Does a dispatch of a log record.
 *
 * @param {Array.} fields Log record.
 * @private
 */
LogReader.prototype.dispatchLogRow_ = function(fields) {
  // Obtain the dispatch.
  var command = fields[0];
  if (!(command in this.dispatchTable_)) return;

  var dispatch = this.dispatchTable_[command];

  if (dispatch === null || this.skipDispatch(dispatch)) {
    return;
  }

  // Parse fields.
  var parsedFields = [];
  for (var i = 0; i < dispatch.parsers.length; ++i) {
    var parser = dispatch.parsers[i];
    if (parser === null) {
      parsedFields.push(fields[1 + i]);
    } else if (typeof parser == 'function') {
      parsedFields.push(parser(fields[1 + i]));
    } else {
      // var-args
      parsedFields.push(fields.slice(1 + i));
      break;
    }
  }

  // Run the processor.
  dispatch.processor.apply(this, parsedFields);
};


/**
 * Processes log lines.
 *
 * @param {Array.} lines Log lines.
 * @private
 */
LogReader.prototype.processLog_ = function(lines) {
  for (var i = 0, n = lines.length; i < n; ++i, ++this.lineNum_) {
    var line = lines[i];
    if (!line) {
      continue;
    }
    try {
      var fields = this.csvParser_.parseLine(line);
      this.dispatchLogRow_(fields);
    } catch (e) {
      this.printError('line ' + (this.lineNum_ + 1) + ': ' + (e.message || e));
    }
  }
};
node-v4.8.2/deps/v8/tools/mac-nm000755 000766 000024 00000001352 13070706735 016507 0ustar00iojsstaff000000 000000 #!/bin/sh

# This script is a wrapper for OS X nm(1) tool. nm(1) perform C++ function
# names demangling, so we're piping its output to c++filt(1) tool which does it.
# But c++filt(1) comes with XCode (as a part of GNU binutils), so it doesn't
# guaranteed to exist on a system.
#
# An alternative approach is to perform demangling in tick processor, but
# for GNU C++ ABI this is a complex process (see cp-demangle.c sources), and
# can't be done partially, because term boundaries are plain text symbols, such
# as 'N', 'E', so one can't just do a search through a function name, it really
# needs to be parsed, which requires a lot of knowledge to be coded in.

if [ "`which c++filt`" == "" ]; then
  nm "$@"
else
  nm "$@" | c++filt -p -i
fi
node-v4.8.2/deps/v8/tools/mac-tick-processor000755 000766 000024 00000000300 13070706735 021034 0ustar00iojsstaff000000 000000 #!/bin/sh

# A wrapper script to call 'linux-tick-processor' with Mac-specific settings.

tools_path=`cd $(dirname "$0");pwd`
$tools_path/linux-tick-processor --mac --nm=$tools_path/mac-nm $@
node-v4.8.2/deps/v8/tools/mingw-generate-makefiles.sh000755 000766 000024 00000007525 13070706735 022627 0ustar00iojsstaff000000 000000 #!/bin/sh
# Copyright 2013 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

# Monkey-patch GYP.
cat > build/gyp/gyp.mingw << EOF
#!/usr/bin/env python

# Copyright (c) 2009 Google Inc. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

import sys

# TODO(mark): sys.path manipulation is some temporary testing stuff.
try:
  import gyp
except ImportError, e:
  import os.path
  sys.path.append(os.path.join(os.path.dirname(sys.argv[0]), 'pylib'))
  import gyp
  
def MonkeyBuildFileTargets(target_list, build_file):
  """From a target_list, returns the subset from the specified build_file.
  """
  build_file = build_file.replace('/', '\\\\')
  return [p for p in target_list if gyp.common.BuildFile(p) == build_file]
gyp.common.BuildFileTargets = MonkeyBuildFileTargets

import gyp.generator.make
import os
def Monkey_ITIP(self):
  """Returns the location of the final output for an installable target."""
  sep = os.path.sep
  # Xcode puts shared_library results into PRODUCT_DIR, and some gyp files
  # rely on this. Emulate this behavior for mac.
  if (self.type == 'shared_library' and
      (self.flavor != 'mac' or self.toolset != 'target')):
    # Install all shared libs into a common directory (per toolset) for
    # convenient access with LD_LIBRARY_PATH.
    return '\$(builddir)%slib.%s%s%s' % (sep, self.toolset, sep, self.alias)
  return '\$(builddir)' + sep + self.alias
gyp.generator.make.MakefileWriter._InstallableTargetInstallPath = Monkey_ITIP

if __name__ == '__main__':
  sys.exit(gyp.main(sys.argv[1:]))
EOF

# Delete old generated Makefiles.
find out -name '*.mk' -or -name 'Makefile*' -exec rm {} \;

# Generate fresh Makefiles.
mv build/gyp/gyp build/gyp/gyp.original
mv build/gyp/gyp.mingw build/gyp/gyp
make out/Makefile.ia32
mv build/gyp/gyp build/gyp/gyp.mingw
mv build/gyp/gyp.original build/gyp/gyp

# Patch generated Makefiles: replace most backslashes with forward slashes,
# fix library names in linker flags.
FILES=$(find out -name '*.mk' -or -name 'Makefile*')
for F in $FILES ; do
  echo "Patching $F..."
  cp $F $F.orig
  cat $F.orig \
    | sed -e 's|\([)a-zA-Z0-9]\)\\\([a-zA-Z]\)|\1/\2|g' \
          -e 's|\([)a-zA-Z0-9]\)\\\\\([a-zA-Z]\)|\1/\2|g' \
          -e 's|'%s/n'|'%s\\\\n'|g' \
          -e 's|-lwinmm\.lib|-lwinmm|g' \
          -e 's|-lws2_32\.lib|-lws2_32|g' \
    > $F
  rm $F.orig
done
node-v4.8.2/deps/v8/tools/nacl-run.py000755 000766 000024 00000011423 13070706735 017505 0ustar00iojsstaff000000 000000 #!/usr/bin/env python
#
# Copyright 2013 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

# This script executes the passed command line using the Native Client
# 'sel_ldr' container. It is derived from android-run.py.

import os
from os.path import join, dirname, abspath
import re
import subprocess
import sys
import tempfile

def Check(output, errors):
  failed = any([s.startswith('/system/bin/sh:') or s.startswith('ANDROID')
                for s in output.split('\n')])
  return 1 if failed else 0

def Execute(cmdline):
  (fd_out, outname) = tempfile.mkstemp()
  (fd_err, errname) = tempfile.mkstemp()
  process = subprocess.Popen(
    args=cmdline,
    shell=True,
    stdout=fd_out,
    stderr=fd_err,
  )
  exit_code = process.wait()
  os.close(fd_out)
  os.close(fd_err)
  output = file(outname).read()
  errors = file(errname).read()
  os.unlink(outname)
  os.unlink(errname)
  sys.stdout.write(output)
  sys.stderr.write(errors)
  return exit_code or Check(output, errors)

def Escape(arg):
  def ShouldEscape():
    for x in arg:
      if not x.isalnum() and x != '-' and x != '_':
        return True
    return False

  return arg if not ShouldEscape() else '"%s"' % (arg.replace('"', '\\"'))

def WriteToTemporaryFile(data):
  (fd, fname) = tempfile.mkstemp()
  os.close(fd)
  tmp_file = open(fname, "w")
  tmp_file.write(data)
  tmp_file.close()
  return fname

def GetNaClArchFromNexe(nexe):
  try:
    p = subprocess.Popen(['file', nexe], stdout=subprocess.PIPE)
    out, err = p.communicate()
    lines = [re.sub("\s+", " " , line) for line in out.split('\n')]
    if lines[0].find(": ELF 32-bit LSB executable, Intel 80386") > 0:
      return "x86_32"
    if lines[0].find(": ELF 64-bit LSB executable, x86-64") > 0:
      return "x86_64"
  except:
    print 'file ' + sys.argv[1] + ' failed'
  return None

def GetNaClResources(nexe):
  nacl_sdk_dir = os.environ["NACL_SDK_ROOT"]
  nacl_arch = GetNaClArchFromNexe(nexe)
  if sys.platform.startswith("linux"):
    platform = "linux"
  elif sys.platform == "darwin":
    platform = "mac"
  else:
    print("NaCl V8 testing is supported on Linux and MacOS only.")
    sys.exit(1)

  if nacl_arch is "x86_64":
    toolchain = platform + "_x86_glibc"
    sel_ldr = "sel_ldr_x86_64"
    irt = "irt_core_x86_64.nexe"
    libdir = "lib64"
  elif nacl_arch is "x86_32":
    toolchain = platform + "_x86_glibc"
    sel_ldr = "sel_ldr_x86_32"
    irt = "irt_core_x86_32.nexe"
    libdir = "lib32"
  elif nacl_arch is "arm":
    print("NaCl V8 ARM support is not ready yet.")
    sys.exit(1)
  else:
    print("Invalid nexe %s with NaCl arch %s" % (nexe, nacl_arch))
    sys.exit(1)

  nacl_sel_ldr = os.path.join(nacl_sdk_dir, "tools", sel_ldr)
  nacl_irt = os.path.join(nacl_sdk_dir, "tools", irt)

  return (nacl_sdk_dir, nacl_sel_ldr, nacl_irt)

def Main():
  if (len(sys.argv) == 1):
    print("Usage: %s " % sys.argv[0])
    return 1

  args = [Escape(arg) for arg in sys.argv[1:]]

  (nacl_sdk_dir, nacl_sel_ldr, nacl_irt) = GetNaClResources(sys.argv[1])

  # sel_ldr Options:
  # -c -c: disable validation (for performance)
  # -a: allow file access
  # -B : load the IRT
  command = ' '.join([nacl_sel_ldr, '-c', '-c', '-a', '-B', nacl_irt, '--'] +
                     args)
  error_code = Execute(command)
  return error_code

if __name__ == '__main__':
  sys.exit(Main())
node-v4.8.2/deps/v8/tools/ninja/000755 000766 000024 00000000000 13070706735 016507 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/v8/tools/oom_dump/000755 000766 000024 00000000000 13070706735 017227 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/v8/tools/OWNERS000644 000766 000024 00000000030 13070706735 016341 0ustar00iojsstaff000000 000000 machenbach@chromium.org
node-v4.8.2/deps/v8/tools/parser-shell.cc000644 000766 000024 00000017053 13070706735 020326 0ustar00iojsstaff000000 000000 // Copyright 2014 the V8 project authors. All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
//       copyright notice, this list of conditions and the following
//       disclaimer in the documentation and/or other materials provided
//       with the distribution.
//     * Neither the name of Google Inc. nor the names of its
//       contributors may be used to endorse or promote products derived
//       from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#include 
#include 
#include 
#include 
#include 
#include 
#include "src/v8.h"

#include "include/libplatform/libplatform.h"
#include "src/api.h"
#include "src/compiler.h"
#include "src/scanner-character-streams.h"
#include "tools/shell-utils.h"
#include "src/parser.h"
#include "src/preparse-data-format.h"
#include "src/preparse-data.h"
#include "src/preparser.h"

using namespace v8::internal;

class ArrayBufferAllocator : public v8::ArrayBuffer::Allocator {
 public:
  virtual void* Allocate(size_t length) {
    void* data = AllocateUninitialized(length);
    return data == NULL ? data : memset(data, 0, length);
  }
  virtual void* AllocateUninitialized(size_t length) { return malloc(length); }
  virtual void Free(void* data, size_t) { free(data); }
};

class StringResource8 : public v8::String::ExternalOneByteStringResource {
 public:
  StringResource8(const char* data, int length)
      : data_(data), length_(length) { }
  virtual size_t length() const { return length_; }
  virtual const char* data() const { return data_; }

 private:
  const char* data_;
  int length_;
};

std::pair RunBaselineParser(
    const char* fname, Encoding encoding, int repeat, v8::Isolate* isolate,
    v8::Local context) {
  int length = 0;
  const byte* source = ReadFileAndRepeat(fname, &length, repeat);
  v8::Local source_handle;
  switch (encoding) {
    case UTF8: {
      source_handle = v8::String::NewFromUtf8(
                          isolate, reinterpret_cast(source),
                          v8::NewStringType::kNormal).ToLocalChecked();
      break;
    }
    case UTF16: {
      source_handle =
          v8::String::NewFromTwoByte(
              isolate, reinterpret_cast(source),
              v8::NewStringType::kNormal, length / 2).ToLocalChecked();
      break;
    }
    case LATIN1: {
      StringResource8* string_resource =
          new StringResource8(reinterpret_cast(source), length);
      source_handle = v8::String::NewExternalOneByte(isolate, string_resource)
                          .ToLocalChecked();
      break;
    }
  }
  v8::base::TimeDelta parse_time1, parse_time2;
  Handle
  
  
  
  
  
  
  

  





  Chrome V8 profiling log processor




Process V8's profiling information log (sampling profiler tick information)
in your browser. Particularly useful if you don't have the V8 shell (d8)
at hand on your system. You still have to run Chrome with the appropriate

  command line flags
to produce the profiling log.



Usage:



Click on the button and browse to the profiling log file (usually, v8.log).
Process will start automatically and the output will be visible in the below
text area.



Limitations and disclaimer:



This page offers a subset of the functionalities of the command-line tick
processor utility in the V8 repository. In particular, this page cannot
access the command-line utility that provides library symbol information,
hence the [C++] section of the output stays empty. Also consider that this
web-based tool is provided only for convenience and quick reference, you
should refer to the

  command-line
version for full output.














Copyright the V8 Authors - Last change to this page: 12/12/2012






node-v4.8.2/deps/v8/tools/tickprocessor-driver.js000644 000766 000024 00000006044 13070706735 022135 0ustar00iojsstaff000000 000000 // Copyright 2012 the V8 project authors. All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
//       copyright notice, this list of conditions and the following
//       disclaimer in the documentation and/or other materials provided
//       with the distribution.
//     * Neither the name of Google Inc. nor the names of its
//       contributors may be used to endorse or promote products derived
//       from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


// Tick Processor's code flow.

function processArguments(args) {
  var processor = new ArgumentsProcessor(args);
  if (processor.parse()) {
    return processor.result();
  } else {
    processor.printUsageAndExit();
  }
}

function initSourceMapSupport() {
  // Pull dev tools source maps  into our name space.
  SourceMap = WebInspector.SourceMap;

  // Overwrite the load function to load scripts synchronously.
  SourceMap.load = function(sourceMapURL) {
    var content = readFile(sourceMapURL);
    var sourceMapObject = (JSON.parse(content));
    return new SourceMap(sourceMapURL, sourceMapObject);
  };
}

var entriesProviders = {
  'unix': UnixCppEntriesProvider,
  'windows': WindowsCppEntriesProvider,
  'mac': MacCppEntriesProvider
};

var params = processArguments(arguments);
var sourceMap = null;
if (params.sourceMap) {
  initSourceMapSupport();
  sourceMap = SourceMap.load(params.sourceMap);
}
var snapshotLogProcessor;
if (params.snapshotLogFileName) {
  snapshotLogProcessor = new SnapshotLogProcessor();
  snapshotLogProcessor.processLogFile(params.snapshotLogFileName);
}
var tickProcessor = new TickProcessor(
  new (entriesProviders[params.platform])(params.nm, params.targetRootFS),
  params.separateIc,
  params.callGraphSize,
  params.ignoreUnknown,
  params.stateFilter,
  snapshotLogProcessor,
  params.distortion,
  params.range,
  sourceMap,
  params.timedRange,
  params.pairwiseTimedRange);
tickProcessor.processLogFile(params.logFileName);
tickProcessor.printStatistics();
node-v4.8.2/deps/v8/tools/tickprocessor.js000644 000766 000024 00000073640 13070706735 020652 0ustar00iojsstaff000000 000000 // Copyright 2012 the V8 project authors. All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
//       copyright notice, this list of conditions and the following
//       disclaimer in the documentation and/or other materials provided
//       with the distribution.
//     * Neither the name of Google Inc. nor the names of its
//       contributors may be used to endorse or promote products derived
//       from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


function inherits(childCtor, parentCtor) {
  childCtor.prototype.__proto__ = parentCtor.prototype;
};


function V8Profile(separateIc) {
  Profile.call(this);
  if (!separateIc) {
    this.skipThisFunction = function(name) { return V8Profile.IC_RE.test(name); };
  }
};
inherits(V8Profile, Profile);


V8Profile.IC_RE =
    /^(?:CallIC|LoadIC|StoreIC)|(?:Builtin: (?:Keyed)?(?:Call|Load|Store)IC_)/;


/**
 * A thin wrapper around shell's 'read' function showing a file name on error.
 */
function readFile(fileName) {
  try {
    return read(fileName);
  } catch (e) {
    print(fileName + ': ' + (e.message || e));
    throw e;
  }
}


/**
 * Parser for dynamic code optimization state.
 */
function parseState(s) {
  switch (s) {
  case "": return Profile.CodeState.COMPILED;
  case "~": return Profile.CodeState.OPTIMIZABLE;
  case "*": return Profile.CodeState.OPTIMIZED;
  }
  throw new Error("unknown code state: " + s);
}


function SnapshotLogProcessor() {
  LogReader.call(this, {
      'code-creation': {
          parsers: [null, parseInt, parseInt, parseInt, null, 'var-args'],
          processor: this.processCodeCreation },
      'code-move': { parsers: [parseInt, parseInt],
          processor: this.processCodeMove },
      'code-delete': { parsers: [parseInt],
          processor: this.processCodeDelete },
      'function-creation': null,
      'function-move': null,
      'function-delete': null,
      'sfi-move': null,
      'snapshot-pos': { parsers: [parseInt, parseInt],
          processor: this.processSnapshotPosition }});

  V8Profile.prototype.handleUnknownCode = function(operation, addr) {
    var op = Profile.Operation;
    switch (operation) {
      case op.MOVE:
        print('Snapshot: Code move event for unknown code: 0x' +
              addr.toString(16));
        break;
      case op.DELETE:
        print('Snapshot: Code delete event for unknown code: 0x' +
              addr.toString(16));
        break;
    }
  };

  this.profile_ = new V8Profile();
  this.serializedEntries_ = [];
}
inherits(SnapshotLogProcessor, LogReader);


SnapshotLogProcessor.prototype.processCodeCreation = function(
    type, kind, start, size, name, maybe_func) {
  if (maybe_func.length) {
    var funcAddr = parseInt(maybe_func[0]);
    var state = parseState(maybe_func[1]);
    this.profile_.addFuncCode(type, name, start, size, funcAddr, state);
  } else {
    this.profile_.addCode(type, name, start, size);
  }
};


SnapshotLogProcessor.prototype.processCodeMove = function(from, to) {
  this.profile_.moveCode(from, to);
};


SnapshotLogProcessor.prototype.processCodeDelete = function(start) {
  this.profile_.deleteCode(start);
};


SnapshotLogProcessor.prototype.processSnapshotPosition = function(addr, pos) {
  this.serializedEntries_[pos] = this.profile_.findEntry(addr);
};


SnapshotLogProcessor.prototype.processLogFile = function(fileName) {
  var contents = readFile(fileName);
  this.processLogChunk(contents);
};


SnapshotLogProcessor.prototype.getSerializedEntryName = function(pos) {
  var entry = this.serializedEntries_[pos];
  return entry ? entry.getRawName() : null;
};


function TickProcessor(
    cppEntriesProvider,
    separateIc,
    callGraphSize,
    ignoreUnknown,
    stateFilter,
    snapshotLogProcessor,
    distortion,
    range,
    sourceMap,
    timedRange,
    pairwiseTimedRange) {
  LogReader.call(this, {
      'shared-library': { parsers: [null, parseInt, parseInt],
          processor: this.processSharedLibrary },
      'code-creation': {
          parsers: [null, parseInt, parseInt, parseInt, null, 'var-args'],
          processor: this.processCodeCreation },
      'code-move': { parsers: [parseInt, parseInt],
          processor: this.processCodeMove },
      'code-delete': { parsers: [parseInt],
          processor: this.processCodeDelete },
      'sfi-move': { parsers: [parseInt, parseInt],
          processor: this.processFunctionMove },
      'snapshot-pos': { parsers: [parseInt, parseInt],
          processor: this.processSnapshotPosition },
      'tick': {
          parsers: [parseInt, parseInt, parseInt,
                    parseInt, parseInt, 'var-args'],
          processor: this.processTick },
      'heap-sample-begin': { parsers: [null, null, parseInt],
          processor: this.processHeapSampleBegin },
      'heap-sample-end': { parsers: [null, null],
          processor: this.processHeapSampleEnd },
      'timer-event-start' : { parsers: [null, null, null],
                              processor: this.advanceDistortion },
      'timer-event-end' : { parsers: [null, null, null],
                            processor: this.advanceDistortion },
      // Ignored events.
      'profiler': null,
      'function-creation': null,
      'function-move': null,
      'function-delete': null,
      'heap-sample-item': null,
      'current-time': null,  // Handled specially, not parsed.
      // Obsolete row types.
      'code-allocate': null,
      'begin-code-region': null,
      'end-code-region': null },
      timedRange,
      pairwiseTimedRange);

  this.cppEntriesProvider_ = cppEntriesProvider;
  this.callGraphSize_ = callGraphSize;
  this.ignoreUnknown_ = ignoreUnknown;
  this.stateFilter_ = stateFilter;
  this.snapshotLogProcessor_ = snapshotLogProcessor;
  this.sourceMap = sourceMap;
  this.deserializedEntriesNames_ = [];
  var ticks = this.ticks_ =
    { total: 0, unaccounted: 0, excluded: 0, gc: 0 };

  distortion = parseInt(distortion);
  // Convert picoseconds to nanoseconds.
  this.distortion_per_entry = isNaN(distortion) ? 0 : (distortion / 1000);
  this.distortion = 0;
  var rangelimits = range ? range.split(",") : [];
  var range_start = parseInt(rangelimits[0]);
  var range_end = parseInt(rangelimits[1]);
  // Convert milliseconds to nanoseconds.
  this.range_start = isNaN(range_start) ? -Infinity : (range_start * 1000);
  this.range_end = isNaN(range_end) ? Infinity : (range_end * 1000)

  V8Profile.prototype.handleUnknownCode = function(
      operation, addr, opt_stackPos) {
    var op = Profile.Operation;
    switch (operation) {
      case op.MOVE:
        print('Code move event for unknown code: 0x' + addr.toString(16));
        break;
      case op.DELETE:
        print('Code delete event for unknown code: 0x' + addr.toString(16));
        break;
      case op.TICK:
        // Only unknown PCs (the first frame) are reported as unaccounted,
        // otherwise tick balance will be corrupted (this behavior is compatible
        // with the original tickprocessor.py script.)
        if (opt_stackPos == 0) {
          ticks.unaccounted++;
        }
        break;
    }
  };

  this.profile_ = new V8Profile(separateIc);
  this.codeTypes_ = {};
  // Count each tick as a time unit.
  this.viewBuilder_ = new ViewBuilder(1);
  this.lastLogFileName_ = null;

  this.generation_ = 1;
  this.currentProducerProfile_ = null;
};
inherits(TickProcessor, LogReader);


TickProcessor.VmStates = {
  JS: 0,
  GC: 1,
  COMPILER: 2,
  OTHER: 3,
  EXTERNAL: 4,
  IDLE: 5
};


TickProcessor.CodeTypes = {
  CPP: 0,
  SHARED_LIB: 1
};
// Otherwise, this is JS-related code. We are not adding it to
// codeTypes_ map because there can be zillions of them.


TickProcessor.CALL_PROFILE_CUTOFF_PCT = 2.0;

TickProcessor.CALL_GRAPH_SIZE = 5;

/**
 * @override
 */
TickProcessor.prototype.printError = function(str) {
  print(str);
};


TickProcessor.prototype.setCodeType = function(name, type) {
  this.codeTypes_[name] = TickProcessor.CodeTypes[type];
};


TickProcessor.prototype.isSharedLibrary = function(name) {
  return this.codeTypes_[name] == TickProcessor.CodeTypes.SHARED_LIB;
};


TickProcessor.prototype.isCppCode = function(name) {
  return this.codeTypes_[name] == TickProcessor.CodeTypes.CPP;
};


TickProcessor.prototype.isJsCode = function(name) {
  return name !== "UNKNOWN" && !(name in this.codeTypes_);
};


TickProcessor.prototype.processLogFile = function(fileName) {
  this.lastLogFileName_ = fileName;
  var line;
  while (line = readline()) {
    this.processLogLine(line);
  }
};


TickProcessor.prototype.processLogFileInTest = function(fileName) {
   // Hack file name to avoid dealing with platform specifics.
  this.lastLogFileName_ = 'v8.log';
  var contents = readFile(fileName);
  this.processLogChunk(contents);
};


TickProcessor.prototype.processSharedLibrary = function(
    name, startAddr, endAddr) {
  var entry = this.profile_.addLibrary(name, startAddr, endAddr);
  this.setCodeType(entry.getName(), 'SHARED_LIB');

  var self = this;
  var libFuncs = this.cppEntriesProvider_.parseVmSymbols(
      name, startAddr, endAddr, function(fName, fStart, fEnd) {
    self.profile_.addStaticCode(fName, fStart, fEnd);
    self.setCodeType(fName, 'CPP');
  });
};


TickProcessor.prototype.processCodeCreation = function(
    type, kind, start, size, name, maybe_func) {
  name = this.deserializedEntriesNames_[start] || name;
  if (maybe_func.length) {
    var funcAddr = parseInt(maybe_func[0]);
    var state = parseState(maybe_func[1]);
    this.profile_.addFuncCode(type, name, start, size, funcAddr, state);
  } else {
    this.profile_.addCode(type, name, start, size);
  }
};


TickProcessor.prototype.processCodeMove = function(from, to) {
  this.profile_.moveCode(from, to);
};


TickProcessor.prototype.processCodeDelete = function(start) {
  this.profile_.deleteCode(start);
};


TickProcessor.prototype.processFunctionMove = function(from, to) {
  this.profile_.moveFunc(from, to);
};


TickProcessor.prototype.processSnapshotPosition = function(addr, pos) {
  if (this.snapshotLogProcessor_) {
    this.deserializedEntriesNames_[addr] =
      this.snapshotLogProcessor_.getSerializedEntryName(pos);
  }
};


TickProcessor.prototype.includeTick = function(vmState) {
  return this.stateFilter_ == null || this.stateFilter_ == vmState;
};

TickProcessor.prototype.processTick = function(pc,
                                               ns_since_start,
                                               is_external_callback,
                                               tos_or_external_callback,
                                               vmState,
                                               stack) {
  this.distortion += this.distortion_per_entry;
  ns_since_start -= this.distortion;
  if (ns_since_start < this.range_start || ns_since_start > this.range_end) {
    return;
  }
  this.ticks_.total++;
  if (vmState == TickProcessor.VmStates.GC) this.ticks_.gc++;
  if (!this.includeTick(vmState)) {
    this.ticks_.excluded++;
    return;
  }
  if (is_external_callback) {
    // Don't use PC when in external callback code, as it can point
    // inside callback's code, and we will erroneously report
    // that a callback calls itself. Instead we use tos_or_external_callback,
    // as simply resetting PC will produce unaccounted ticks.
    pc = tos_or_external_callback;
    tos_or_external_callback = 0;
  } else if (tos_or_external_callback) {
    // Find out, if top of stack was pointing inside a JS function
    // meaning that we have encountered a frameless invocation.
    var funcEntry = this.profile_.findEntry(tos_or_external_callback);
    if (!funcEntry || !funcEntry.isJSFunction || !funcEntry.isJSFunction()) {
      tos_or_external_callback = 0;
    }
  }

  this.profile_.recordTick(this.processStack(pc, tos_or_external_callback, stack));
};


TickProcessor.prototype.advanceDistortion = function() {
  this.distortion += this.distortion_per_entry;
}


TickProcessor.prototype.processHeapSampleBegin = function(space, state, ticks) {
  if (space != 'Heap') return;
  this.currentProducerProfile_ = new CallTree();
};


TickProcessor.prototype.processHeapSampleEnd = function(space, state) {
  if (space != 'Heap' || !this.currentProducerProfile_) return;

  print('Generation ' + this.generation_ + ':');
  var tree = this.currentProducerProfile_;
  tree.computeTotalWeights();
  var producersView = this.viewBuilder_.buildView(tree);
  // Sort by total time, desc, then by name, desc.
  producersView.sort(function(rec1, rec2) {
      return rec2.totalTime - rec1.totalTime ||
          (rec2.internalFuncName < rec1.internalFuncName ? -1 : 1); });
  this.printHeavyProfile(producersView.head.children);

  this.currentProducerProfile_ = null;
  this.generation_++;
};


TickProcessor.prototype.printStatistics = function() {
  print('Statistical profiling result from ' + this.lastLogFileName_ +
        ', (' + this.ticks_.total +
        ' ticks, ' + this.ticks_.unaccounted + ' unaccounted, ' +
        this.ticks_.excluded + ' excluded).');

  if (this.ticks_.total == 0) return;

  var flatProfile = this.profile_.getFlatProfile();
  var flatView = this.viewBuilder_.buildView(flatProfile);
  // Sort by self time, desc, then by name, desc.
  flatView.sort(function(rec1, rec2) {
      return rec2.selfTime - rec1.selfTime ||
          (rec2.internalFuncName < rec1.internalFuncName ? -1 : 1); });
  var totalTicks = this.ticks_.total;
  if (this.ignoreUnknown_) {
    totalTicks -= this.ticks_.unaccounted;
  }

  // Count library ticks
  var flatViewNodes = flatView.head.children;
  var self = this;

  var libraryTicks = 0;
  this.printHeader('Shared libraries');
  this.printEntries(flatViewNodes, totalTicks, null,
      function(name) { return self.isSharedLibrary(name); },
      function(rec) { libraryTicks += rec.selfTime; });
  var nonLibraryTicks = totalTicks - libraryTicks;

  var jsTicks = 0;
  this.printHeader('JavaScript');
  this.printEntries(flatViewNodes, totalTicks, nonLibraryTicks,
      function(name) { return self.isJsCode(name); },
      function(rec) { jsTicks += rec.selfTime; });

  var cppTicks = 0;
  this.printHeader('C++');
  this.printEntries(flatViewNodes, totalTicks, nonLibraryTicks,
      function(name) { return self.isCppCode(name); },
      function(rec) { cppTicks += rec.selfTime; });

  this.printHeader('Summary');
  this.printLine('JavaScript', jsTicks, totalTicks, nonLibraryTicks);
  this.printLine('C++', cppTicks, totalTicks, nonLibraryTicks);
  this.printLine('GC', this.ticks_.gc, totalTicks, nonLibraryTicks);
  this.printLine('Shared libraries', libraryTicks, totalTicks, null);
  if (!this.ignoreUnknown_ && this.ticks_.unaccounted > 0) {
    this.printLine('Unaccounted', this.ticks_.unaccounted,
                   this.ticks_.total, null);
  }

  print('\n [C++ entry points]:');
  print('   ticks    cpp   total   name');
  var c_entry_functions = this.profile_.getCEntryProfile();
  var total_c_entry = c_entry_functions[0].ticks;
  for (var i = 1; i < c_entry_functions.length; i++) {
    c = c_entry_functions[i];
    this.printLine(c.name, c.ticks, total_c_entry, totalTicks);
  }

  this.printHeavyProfHeader();
  var heavyProfile = this.profile_.getBottomUpProfile();
  var heavyView = this.viewBuilder_.buildView(heavyProfile);
  // To show the same percentages as in the flat profile.
  heavyView.head.totalTime = totalTicks;
  // Sort by total time, desc, then by name, desc.
  heavyView.sort(function(rec1, rec2) {
      return rec2.totalTime - rec1.totalTime ||
          (rec2.internalFuncName < rec1.internalFuncName ? -1 : 1); });
  this.printHeavyProfile(heavyView.head.children);
};


function padLeft(s, len) {
  s = s.toString();
  if (s.length < len) {
    var padLength = len - s.length;
    if (!(padLength in padLeft)) {
      padLeft[padLength] = new Array(padLength + 1).join(' ');
    }
    s = padLeft[padLength] + s;
  }
  return s;
};


TickProcessor.prototype.printHeader = function(headerTitle) {
  print('\n [' + headerTitle + ']:');
  print('   ticks  total  nonlib   name');
};


TickProcessor.prototype.printLine = function(
    entry, ticks, totalTicks, nonLibTicks) {
  var pct = ticks * 100 / totalTicks;
  var nonLibPct = nonLibTicks != null
      ? padLeft((ticks * 100 / nonLibTicks).toFixed(1), 5) + '%  '
      : '        ';
  print('  ' + padLeft(ticks, 5) + '  ' +
        padLeft(pct.toFixed(1), 5) + '%  ' +
        nonLibPct +
        entry);
}

TickProcessor.prototype.printHeavyProfHeader = function() {
  print('\n [Bottom up (heavy) profile]:');
  print('  Note: percentage shows a share of a particular caller in the ' +
        'total\n' +
        '  amount of its parent calls.');
  print('  Callers occupying less than ' +
        TickProcessor.CALL_PROFILE_CUTOFF_PCT.toFixed(1) +
        '% are not shown.\n');
  print('   ticks parent  name');
};


TickProcessor.prototype.processProfile = function(
    profile, filterP, func) {
  for (var i = 0, n = profile.length; i < n; ++i) {
    var rec = profile[i];
    if (!filterP(rec.internalFuncName)) {
      continue;
    }
    func(rec);
  }
};

TickProcessor.prototype.getLineAndColumn = function(name) {
  var re = /:([0-9]+):([0-9]+)$/;
  var array = re.exec(name);
  if (!array) {
    return null;
  }
  return {line: array[1], column: array[2]};
}

TickProcessor.prototype.hasSourceMap = function() {
  return this.sourceMap != null;
};


TickProcessor.prototype.formatFunctionName = function(funcName) {
  if (!this.hasSourceMap()) {
    return funcName;
  }
  var lc = this.getLineAndColumn(funcName);
  if (lc == null) {
    return funcName;
  }
  // in source maps lines and columns are zero based
  var lineNumber = lc.line - 1;
  var column = lc.column - 1;
  var entry = this.sourceMap.findEntry(lineNumber, column);
  var sourceFile = entry[2];
  var sourceLine = entry[3] + 1;
  var sourceColumn = entry[4] + 1;

  return sourceFile + ':' + sourceLine + ':' + sourceColumn + ' -> ' + funcName;
};

TickProcessor.prototype.printEntries = function(
    profile, totalTicks, nonLibTicks, filterP, callback) {
  var that = this;
  this.processProfile(profile, filterP, function (rec) {
    if (rec.selfTime == 0) return;
    callback(rec);
    var funcName = that.formatFunctionName(rec.internalFuncName);
    that.printLine(funcName, rec.selfTime, totalTicks, nonLibTicks);
  });
};


TickProcessor.prototype.printHeavyProfile = function(profile, opt_indent) {
  var self = this;
  var indent = opt_indent || 0;
  var indentStr = padLeft('', indent);
  this.processProfile(profile, function() { return true; }, function (rec) {
    // Cut off too infrequent callers.
    if (rec.parentTotalPercent < TickProcessor.CALL_PROFILE_CUTOFF_PCT) return;
    var funcName = self.formatFunctionName(rec.internalFuncName);
    print('  ' + padLeft(rec.totalTime, 5) + '  ' +
          padLeft(rec.parentTotalPercent.toFixed(1), 5) + '%  ' +
          indentStr + funcName);
    // Limit backtrace depth.
    if (indent < 2 * self.callGraphSize_) {
      self.printHeavyProfile(rec.children, indent + 2);
    }
    // Delimit top-level functions.
    if (indent == 0) {
      print('');
    }
  });
};


function CppEntriesProvider() {
};


CppEntriesProvider.prototype.parseVmSymbols = function(
    libName, libStart, libEnd, processorFunc) {
  this.loadSymbols(libName);

  var prevEntry;

  function addEntry(funcInfo) {
    // Several functions can be mapped onto the same address. To avoid
    // creating zero-sized entries, skip such duplicates.
    // Also double-check that function belongs to the library address space.
    if (prevEntry && !prevEntry.end &&
        prevEntry.start < funcInfo.start &&
        prevEntry.start >= libStart && funcInfo.start <= libEnd) {
      processorFunc(prevEntry.name, prevEntry.start, funcInfo.start);
    }
    if (funcInfo.end &&
        (!prevEntry || prevEntry.start != funcInfo.start) &&
        funcInfo.start >= libStart && funcInfo.end <= libEnd) {
      processorFunc(funcInfo.name, funcInfo.start, funcInfo.end);
    }
    prevEntry = funcInfo;
  }

  while (true) {
    var funcInfo = this.parseNextLine();
    if (funcInfo === null) {
      continue;
    } else if (funcInfo === false) {
      break;
    }
    if (funcInfo.start < libStart && funcInfo.start < libEnd - libStart) {
      funcInfo.start += libStart;
    }
    if (funcInfo.size) {
      funcInfo.end = funcInfo.start + funcInfo.size;
    }
    addEntry(funcInfo);
  }
  addEntry({name: '', start: libEnd});
};


CppEntriesProvider.prototype.loadSymbols = function(libName) {
};


CppEntriesProvider.prototype.parseNextLine = function() {
  return false;
};


function UnixCppEntriesProvider(nmExec, targetRootFS) {
  this.symbols = [];
  this.parsePos = 0;
  this.nmExec = nmExec;
  this.targetRootFS = targetRootFS;
  this.FUNC_RE = /^([0-9a-fA-F]{8,16}) ([0-9a-fA-F]{8,16} )?[tTwW] (.*)$/;
};
inherits(UnixCppEntriesProvider, CppEntriesProvider);


UnixCppEntriesProvider.prototype.loadSymbols = function(libName) {
  this.parsePos = 0;
  libName = this.targetRootFS + libName;
  try {
    this.symbols = [
      os.system(this.nmExec, ['-C', '-n', '-S', libName], -1, -1),
      os.system(this.nmExec, ['-C', '-n', '-S', '-D', libName], -1, -1)
    ];
  } catch (e) {
    // If the library cannot be found on this system let's not panic.
    this.symbols = ['', ''];
  }
};


UnixCppEntriesProvider.prototype.parseNextLine = function() {
  if (this.symbols.length == 0) {
    return false;
  }
  var lineEndPos = this.symbols[0].indexOf('\n', this.parsePos);
  if (lineEndPos == -1) {
    this.symbols.shift();
    this.parsePos = 0;
    return this.parseNextLine();
  }

  var line = this.symbols[0].substring(this.parsePos, lineEndPos);
  this.parsePos = lineEndPos + 1;
  var fields = line.match(this.FUNC_RE);
  var funcInfo = null;
  if (fields) {
    funcInfo = { name: fields[3], start: parseInt(fields[1], 16) };
    if (fields[2]) {
      funcInfo.size = parseInt(fields[2], 16);
    }
  }
  return funcInfo;
};


function MacCppEntriesProvider(nmExec, targetRootFS) {
  UnixCppEntriesProvider.call(this, nmExec, targetRootFS);
  // Note an empty group. It is required, as UnixCppEntriesProvider expects 3 groups.
  this.FUNC_RE = /^([0-9a-fA-F]{8,16}) ()[iItT] (.*)$/;
};
inherits(MacCppEntriesProvider, UnixCppEntriesProvider);


MacCppEntriesProvider.prototype.loadSymbols = function(libName) {
  this.parsePos = 0;
  libName = this.targetRootFS + libName;

  // It seems that in OS X `nm` thinks that `-f` is a format option, not a
  // "flat" display option flag.
  try {
    this.symbols = [os.system(this.nmExec, ['-n', libName], -1, -1), ''];
  } catch (e) {
    // If the library cannot be found on this system let's not panic.
    this.symbols = '';
  }
};


function WindowsCppEntriesProvider(_ignored_nmExec, targetRootFS) {
  this.targetRootFS = targetRootFS;
  this.symbols = '';
  this.parsePos = 0;
};
inherits(WindowsCppEntriesProvider, CppEntriesProvider);


WindowsCppEntriesProvider.FILENAME_RE = /^(.*)\.([^.]+)$/;


WindowsCppEntriesProvider.FUNC_RE =
    /^\s+0001:[0-9a-fA-F]{8}\s+([_\?@$0-9a-zA-Z]+)\s+([0-9a-fA-F]{8}).*$/;


WindowsCppEntriesProvider.IMAGE_BASE_RE =
    /^\s+0000:00000000\s+___ImageBase\s+([0-9a-fA-F]{8}).*$/;


// This is almost a constant on Windows.
WindowsCppEntriesProvider.EXE_IMAGE_BASE = 0x00400000;


WindowsCppEntriesProvider.prototype.loadSymbols = function(libName) {
  libName = this.targetRootFS + libName;
  var fileNameFields = libName.match(WindowsCppEntriesProvider.FILENAME_RE);
  if (!fileNameFields) return;
  var mapFileName = fileNameFields[1] + '.map';
  this.moduleType_ = fileNameFields[2].toLowerCase();
  try {
    this.symbols = read(mapFileName);
  } catch (e) {
    // If .map file cannot be found let's not panic.
    this.symbols = '';
  }
};


WindowsCppEntriesProvider.prototype.parseNextLine = function() {
  var lineEndPos = this.symbols.indexOf('\r\n', this.parsePos);
  if (lineEndPos == -1) {
    return false;
  }

  var line = this.symbols.substring(this.parsePos, lineEndPos);
  this.parsePos = lineEndPos + 2;

  // Image base entry is above all other symbols, so we can just
  // terminate parsing.
  var imageBaseFields = line.match(WindowsCppEntriesProvider.IMAGE_BASE_RE);
  if (imageBaseFields) {
    var imageBase = parseInt(imageBaseFields[1], 16);
    if ((this.moduleType_ == 'exe') !=
        (imageBase == WindowsCppEntriesProvider.EXE_IMAGE_BASE)) {
      return false;
    }
  }

  var fields = line.match(WindowsCppEntriesProvider.FUNC_RE);
  return fields ?
      { name: this.unmangleName(fields[1]), start: parseInt(fields[2], 16) } :
      null;
};


/**
 * Performs very simple unmangling of C++ names.
 *
 * Does not handle arguments and template arguments. The mangled names have
 * the form:
 *
 *   ?LookupInDescriptor@JSObject@internal@v8@@...arguments info...
 */
WindowsCppEntriesProvider.prototype.unmangleName = function(name) {
  // Empty or non-mangled name.
  if (name.length < 1 || name.charAt(0) != '?') return name;
  var nameEndPos = name.indexOf('@@');
  var components = name.substring(1, nameEndPos).split('@');
  components.reverse();
  return components.join('::');
};


function ArgumentsProcessor(args) {
  this.args_ = args;
  this.result_ = ArgumentsProcessor.DEFAULTS;

  this.argsDispatch_ = {
    '-j': ['stateFilter', TickProcessor.VmStates.JS,
        'Show only ticks from JS VM state'],
    '-g': ['stateFilter', TickProcessor.VmStates.GC,
        'Show only ticks from GC VM state'],
    '-c': ['stateFilter', TickProcessor.VmStates.COMPILER,
        'Show only ticks from COMPILER VM state'],
    '-o': ['stateFilter', TickProcessor.VmStates.OTHER,
        'Show only ticks from OTHER VM state'],
    '-e': ['stateFilter', TickProcessor.VmStates.EXTERNAL,
        'Show only ticks from EXTERNAL VM state'],
    '--call-graph-size': ['callGraphSize', TickProcessor.CALL_GRAPH_SIZE,
        'Set the call graph size'],
    '--ignore-unknown': ['ignoreUnknown', true,
        'Exclude ticks of unknown code entries from processing'],
    '--separate-ic': ['separateIc', true,
        'Separate IC entries'],
    '--unix': ['platform', 'unix',
        'Specify that we are running on *nix platform'],
    '--windows': ['platform', 'windows',
        'Specify that we are running on Windows platform'],
    '--mac': ['platform', 'mac',
        'Specify that we are running on Mac OS X platform'],
    '--nm': ['nm', 'nm',
        'Specify the \'nm\' executable to use (e.g. --nm=/my_dir/nm)'],
    '--target': ['targetRootFS', '',
        'Specify the target root directory for cross environment'],
    '--snapshot-log': ['snapshotLogFileName', 'snapshot.log',
        'Specify snapshot log file to use (e.g. --snapshot-log=snapshot.log)'],
    '--range': ['range', 'auto,auto',
        'Specify the range limit as [start],[end]'],
    '--distortion': ['distortion', 0,
        'Specify the logging overhead in picoseconds'],
    '--source-map': ['sourceMap', null,
        'Specify the source map that should be used for output'],
    '--timed-range': ['timedRange', true,
        'Ignore ticks before first and after last Date.now() call'],
    '--pairwise-timed-range': ['pairwiseTimedRange', true,
        'Ignore ticks outside pairs of Date.now() calls']
  };
  this.argsDispatch_['--js'] = this.argsDispatch_['-j'];
  this.argsDispatch_['--gc'] = this.argsDispatch_['-g'];
  this.argsDispatch_['--compiler'] = this.argsDispatch_['-c'];
  this.argsDispatch_['--other'] = this.argsDispatch_['-o'];
  this.argsDispatch_['--external'] = this.argsDispatch_['-e'];
  this.argsDispatch_['--ptr'] = this.argsDispatch_['--pairwise-timed-range'];
};


ArgumentsProcessor.DEFAULTS = {
  logFileName: 'v8.log',
  snapshotLogFileName: null,
  platform: 'unix',
  stateFilter: null,
  callGraphSize: 5,
  ignoreUnknown: false,
  separateIc: false,
  targetRootFS: '',
  nm: 'nm',
  range: 'auto,auto',
  distortion: 0,
  timedRange: false,
  pairwiseTimedRange: false
};


ArgumentsProcessor.prototype.parse = function() {
  while (this.args_.length) {
    var arg = this.args_.shift();
    if (arg.charAt(0) != '-') {
      this.result_.logFileName = arg;
      continue;
    }
    var userValue = null;
    var eqPos = arg.indexOf('=');
    if (eqPos != -1) {
      userValue = arg.substr(eqPos + 1);
      arg = arg.substr(0, eqPos);
    }
    if (arg in this.argsDispatch_) {
      var dispatch = this.argsDispatch_[arg];
      this.result_[dispatch[0]] = userValue == null ? dispatch[1] : userValue;
    } else {
      return false;
    }
  }
  return true;
};


ArgumentsProcessor.prototype.result = function() {
  return this.result_;
};


ArgumentsProcessor.prototype.printUsageAndExit = function() {

  function padRight(s, len) {
    s = s.toString();
    if (s.length < len) {
      s = s + (new Array(len - s.length + 1).join(' '));
    }
    return s;
  }

  print('Cmdline args: [options] [log-file-name]\n' +
        'Default log file name is "' +
        ArgumentsProcessor.DEFAULTS.logFileName + '".\n');
  print('Options:');
  for (var arg in this.argsDispatch_) {
    var synonyms = [arg];
    var dispatch = this.argsDispatch_[arg];
    for (var synArg in this.argsDispatch_) {
      if (arg !== synArg && dispatch === this.argsDispatch_[synArg]) {
        synonyms.push(synArg);
        delete this.argsDispatch_[synArg];
      }
    }
    print('  ' + padRight(synonyms.join(', '), 20) + " " + dispatch[2]);
  }
  quit(2);
};
node-v4.8.2/deps/v8/tools/trace-maps-processor.py000755 000766 000024 00000011310 13070706735 022032 0ustar00iojsstaff000000 000000 #!/usr/bin/env python
# Copyright 2014 the V8 project authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

import sys


action = sys.argv[1]

if action in ["help", "-h", "--help"] or len(sys.argv) != 3:
  print("Usage: %s  , where action can be: \n"
        "help    Print this message\n"
        "plain   Print ASCII tree to stdout\n"
        "dot     Print dot file to stdout\n"
        "count   Count most frequent transition reasons\n" % sys.argv[0])
  sys.exit(0)


filename = sys.argv[2]
maps = {}
root_maps = []
transitions = {}
annotations = {}


class Map(object):

  def __init__(self, pointer, origin):
    self.pointer = pointer
    self.origin = origin

  def __str__(self):
    return "%s (%s)" % (self.pointer, self.origin)


class Transition(object):

  def __init__(self, from_map, to_map, reason):
    self.from_map = from_map
    self.to_map = to_map
    self.reason = reason


def RegisterNewMap(raw_map):
  if raw_map in annotations:
    annotations[raw_map] += 1
  else:
    annotations[raw_map] = 0
  return AnnotateExistingMap(raw_map)


def AnnotateExistingMap(raw_map):
  return "%s_%d" % (raw_map, annotations[raw_map])


def AddMap(pointer, origin):
  pointer = RegisterNewMap(pointer)
  maps[pointer] = Map(pointer, origin)
  return pointer


def AddTransition(from_map, to_map, reason):
  from_map = AnnotateExistingMap(from_map)
  to_map = AnnotateExistingMap(to_map)
  if from_map not in transitions:
    transitions[from_map] = {}
  targets = transitions[from_map]
  if to_map in targets:
    # Some events get printed twice, that's OK. In some cases, ignore the
    # second output...
    old_reason = targets[to_map].reason
    if old_reason.startswith("ReplaceDescriptors"):
      return
    # ...and in others use it for additional detail.
    if reason in []:
      targets[to_map].reason = reason
      return
    # Unexpected duplicate events? Warn.
    print("// warning: already have a transition from %s to %s, reason: %s" %
            (from_map, to_map, targets[to_map].reason))
    return
  targets[to_map] = Transition(from_map, to_map, reason)


with open(filename, "r") as f:
  last_to_map = ""
  for line in f:
    if not line.startswith("[TraceMaps: "): continue
    words = line.split(" ")
    event = words[1]
    if event == "InitialMap":
      assert words[2] == "map="
      assert words[4] == "SFI="
      new_map = AddMap(words[3], "SFI#%s" % words[5])
      root_maps.append(new_map)
      continue
    if words[2] == "from=" and words[4] == "to=":
      from_map = words[3]
      to_map = words[5]
      if from_map not in annotations:
        print("// warning: unknown from_map %s" % from_map)
        new_map = AddMap(from_map, "")
        root_maps.append(new_map)
      if to_map != last_to_map:
        AddMap(to_map, " (%s)" % event)
      last_to_map = to_map
      if event in ["Transition", "NoTransition"]:
        assert words[6] == "name=", line
        reason = "%s: %s" % (event, words[7])
      elif event in ["Normalize", "ReplaceDescriptors", "SlowToFast"]:
        assert words[6] == "reason=", line
        reason = "%s: %s" % (event, words[7])
        if words[8].strip() != "]":
          reason = "%s_%s" % (reason, words[8])
      else:
        reason = event
      AddTransition(from_map, to_map, reason)
      continue


def PlainPrint(m, indent, label):
  print("%s%s (%s)" % (indent, m, label))
  if m in transitions:
    for t in transitions[m]:
      PlainPrint(t, indent + "  ", transitions[m][t].reason)


def CountTransitions(m):
  if m not in transitions: return 0
  return len(transitions[m])


def DotPrint(m, label):
  print("m%s [label=\"%s\"]" % (m[2:], label))
  if m in transitions:
    for t in transitions[m]:
      # GraphViz doesn't like node labels looking like numbers, so use
      # "m..." instead of "0x...".
      print("m%s -> m%s" % (m[2:], t[2:]))
      reason = transitions[m][t].reason
      reason = reason.replace("\\", "BACKSLASH")
      reason = reason.replace("\"", "\\\"")
      DotPrint(t, reason)


if action == "plain":
  root_maps = sorted(root_maps, key=CountTransitions, reverse=True)
  for m in root_maps:
    PlainPrint(m, "", maps[m].origin)

elif action == "dot":
  print("digraph g {")
  for m in root_maps:
    DotPrint(m, maps[m].origin)
  print("}")

elif action == "count":
  reasons = {}
  for s in transitions:
    for t in transitions[s]:
      reason = transitions[s][t].reason
      if reason not in reasons:
        reasons[reason] = 1
      else:
        reasons[reason] += 1
  reasons_list = []
  for r in reasons:
    reasons_list.append("%8d %s" % (reasons[r], r))
  reasons_list.sort(reverse=True)
  for r in reasons_list[:20]:
    print r
node-v4.8.2/deps/v8/tools/try_perf.py000755 000766 000024 00000003576 13070706735 017632 0ustar00iojsstaff000000 000000 #!/usr/bin/env python
# Copyright 2014 the V8 project authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

import argparse
import find_depot_tools
import sys

find_depot_tools.add_depot_tools_to_path()

from git_cl import Changelist

BOTS = {
  '--arm32': 'v8_arm32_perf_try',
  '--linux32': 'v8_linux32_perf_try',
  '--linux64': 'v8_linux64_perf_try',
  '--linux64_haswell': 'v8_linux64_haswell_perf_try',
  '--nexus5': 'v8_nexus5_perf_try',
  '--nexus7': 'v8_nexus7_perf_try',
  '--nexus9': 'v8_nexus9_perf_try',
  '--nexus10': 'v8_nexus10_perf_try',
}

DEFAULT_BOTS = [
  'v8_linux32_perf_try',
  'v8_linux64_haswell_perf_try',
]

def main():
  parser = argparse.ArgumentParser(description='')
  parser.add_argument("benchmarks", nargs="+", help="The benchmarks to run.")
  for option in sorted(BOTS):
    parser.add_argument(
        option, dest='bots', action='append_const', const=BOTS[option],
        help='Add %s trybot.' % BOTS[option])
  options = parser.parse_args()
  if not options.bots:
    print 'No trybots specified. Using default %s.' % ','.join(DEFAULT_BOTS)
    options.bots = DEFAULT_BOTS

  cl = Changelist()
  if not cl.GetIssue():
    print 'Need to upload first'
    return 1

  props = cl.GetIssueProperties()
  if props.get('closed'):
    print 'Cannot send tryjobs for a closed CL'
    return 1

  if props.get('private'):
    print 'Cannot use trybots with private issue'
    return 1

  if not options.benchmarks:
    print 'Please specify the benchmarks to run as arguments.'
    return 1

  masters = {
    'internal.client.v8': dict((b, options.benchmarks) for b in options.bots),
  }
  cl.RpcServer().trigger_distributed_try_jobs(
      cl.GetIssue(), cl.GetMostRecentPatchset(), cl.GetBranch(),
      False, None, masters)
  return 0

if __name__ == "__main__":  # pragma: no cover
  sys.exit(main())
node-v4.8.2/deps/v8/tools/unittests/000755 000766 000024 00000000000 13070706735 017452 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/v8/tools/v8-info.sh000755 000766 000024 00000010676 13070706735 017247 0ustar00iojsstaff000000 000000 #!/bin/bash
# Copyright 2013 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


########## Global variable definitions

BASE_URL="https://code.google.com/p/v8/source/list"
VERSION="include/v8-version.h"
MAJOR="V8_MAJOR_VERSION"
MINOR="V8_MINOR_VERSION"
BUILD="V8_BUILD_NUMBER"
PATCH="V8_PATCH_LEVEL"

V8="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"

########## Function definitions

cd $V8

usage() {
cat << EOF
usage: $0 OPTIONS

Fetches V8 revision information from a git-svn checkout.

OPTIONS:
  -h    Show this message.

  -i    Print revision info for all branches matching the V8 version.
          Example usage: $0 -i 3.19.10$
          Output format: [Git hash] [SVN revision] [V8 version]

  -v    Print the V8 version tag for a trunk SVN revision.
          Example usage: $0 -v 14981
          Output format: [V8 version]

  -m    Print all patches that were merged to the specified V8 branch.
          Example usage: $0 -m 3.18
          Output format: [V8 version] [SVN revision] [SVN patch merged]*.

  -p    Print all patches merged to a specific V8 point-release.
          Example usage: $0 -p 3.19.12.1
          Output format: [SVN patch merged]*

  -u    Print a link to all SVN revisions between two V8 revision tags.
          Example usage: $0 -u 3.19.10:3.19.11
EOF
}

tags() {
  git for-each-ref --format="%(objectname) %(refname:short)" refs/remotes/svn
}

tag_revision() {
  cut -d" " -f1
}

tag_log() {
  git log --format="%h %ci %ce %s" -1 $1
}

v8_hash() {
  tags | grep "svn/tags/$1$" | tag_revision
}

point_merges() {
  echo $1 | grep -o "r[0-9]\+"
}

hash_to_svn() {
  git svn log -1 --oneline $1 | cut -d" " -f1
}

tag_version() {
  tags | grep svn/tags/$1 | while read tag; do
    id=$(echo $tag | grep -o "[^/]*$")
    rev=$(echo $tag | tag_revision)
    svn=$(hash_to_svn $rev)
    echo $rev $svn $id
  done
}

svn_rev() {
  git svn find-rev $2 svn/$1
}

v8_rev() {
  cd $(git rev-parse --show-toplevel)
  rev=$(git show $1:$VERSION \
      | grep "#define" \
      | grep "$MAJOR\|$MINOR\|$BUILD\|$PATCH" \
      | grep -o "[0-9]\+$" \
      | tr "\\n" ".")
  echo ${rev%?}
}

merges_to_branch() {
  git cherry -v svn/trunk svn/$1 | while read merge; do
    h=$(echo $merge | cut -d" " -f2)
    svn=$(svn_rev $1 $h)
    merges=$(echo $merge | grep -o "r[0-9]\+")
    rev=$(v8_rev $h)
    echo $rev r$svn $merges
  done
}

url_for() {
  first=$(svn_rev trunk $(v8_hash $(echo $1 | cut -d":" -f1)))
  last=$(svn_rev trunk $(v8_hash $(echo $1 | cut -d":" -f2)))
  num=$[ $last - $first]
  echo "$BASE_URL?num=$num&start=$last"
}

########## Option parsing

while getopts ":hi:v:m:p:u:" OPTION ; do
  case $OPTION in
    h)  usage
        exit 0
        ;;
    i)  tag_version $OPTARG
        ;;
    v)  v8_rev $(svn_rev trunk r$OPTARG)
        ;;
    m)  merges_to_branch $OPTARG
        ;;
    p)  echo $(point_merges "$(tag_log $(v8_hash $OPTARG)^1)")
        ;;
    u)  url_for $OPTARG
        ;;
    ?)  echo "Illegal option: -$OPTARG"
        usage
        exit 1
        ;;
  esac
done
node-v4.8.2/deps/v8/tools/v8-rolls.sh000755 000766 000024 00000006160 13070706735 017440 0ustar00iojsstaff000000 000000 #!/bin/bash
# Copyright 2013 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


########## Global variable definitions

DEPS_STRING='"v8_revision":'
INFO=tools/v8-info.sh

V8="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"

########## Function definitions

usage() {
cat << EOF
usage: $0 OPTIONS

Run in chromium/src to get information about V8 rolls.

OPTIONS:
  -h    Show this message.
  -n    Number of rolls to print information about.
  -s    Chromium git hash to start printing V8 information about.
EOF
}

v8_line() {
  git show $1:DEPS | grep -n $DEPS_STRING | cut -d":" -f1
}

v8_info() {
  git blame -L$(v8_line $1),+1 $1 DEPS | grep $DEPS_STRING
}

v8_svn() {
  sed -e 's/^.*"\([0-9]\+\)",$/\1/'
}

v8_roll() {
  cut -d" " -f1
}

find_rev() {
  git svn find-rev $1
}

msg() {
  msg=$(git log --format="%h %ci %ce" -1 $1)
  h=$(echo $msg | cut -d" " -f1)
  d=$(echo $msg | cut -d" " -f2)
  t=$(echo $msg | cut -d" " -f3)
  a=$(echo $msg | cut -d" " -f5)
  a1=$(echo $a | cut -d"@" -f1)
  a2=$(echo $a | cut -d"@" -f2)
  echo $h $d $t $a1@$a2
}

v8_revision() {
  cd $V8
  $INFO -v $1
}

rolls() {
  roll=$2
  for i in $(seq 1 $1); do
    info=$(v8_info $roll)
    roll=$(echo $info | v8_roll $roll)
    trunk=$(echo $info | v8_svn $roll)
    echo "$(v8_revision $trunk) $trunk $(find_rev $roll) $(msg $roll)"
    roll=$roll^1
  done
}

########## Option parsing

REVISIONS=1
START=HEAD

while getopts ":hn:s:" OPTION ; do
  case $OPTION in
    h)  usage
        exit 0
        ;;
    n) REVISIONS=$OPTARG
        ;;
    s) START=$OPTARG
        ;;
    ?)  echo "Illegal option: -$OPTARG"
        usage
        exit 1
        ;;
  esac
done

rolls $REVISIONS $START
node-v4.8.2/deps/v8/tools/v8heapconst.py000644 000766 000024 00000027523 13070706735 020235 0ustar00iojsstaff000000 000000 # Copyright 2013 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

# This file is automatically generated from the V8 source and should not
# be modified manually, run 'make grokdump' instead to update this file.

# List of known V8 instance types.
INSTANCE_TYPES = {
  64: "STRING_TYPE",
  68: "ONE_BYTE_STRING_TYPE",
  65: "CONS_STRING_TYPE",
  69: "CONS_ONE_BYTE_STRING_TYPE",
  67: "SLICED_STRING_TYPE",
  71: "SLICED_ONE_BYTE_STRING_TYPE",
  66: "EXTERNAL_STRING_TYPE",
  70: "EXTERNAL_ONE_BYTE_STRING_TYPE",
  74: "EXTERNAL_STRING_WITH_ONE_BYTE_DATA_TYPE",
  82: "SHORT_EXTERNAL_STRING_TYPE",
  86: "SHORT_EXTERNAL_ONE_BYTE_STRING_TYPE",
  90: "SHORT_EXTERNAL_STRING_WITH_ONE_BYTE_DATA_TYPE",
  0: "INTERNALIZED_STRING_TYPE",
  4: "ONE_BYTE_INTERNALIZED_STRING_TYPE",
  2: "EXTERNAL_INTERNALIZED_STRING_TYPE",
  6: "EXTERNAL_ONE_BYTE_INTERNALIZED_STRING_TYPE",
  10: "EXTERNAL_INTERNALIZED_STRING_WITH_ONE_BYTE_DATA_TYPE",
  18: "SHORT_EXTERNAL_INTERNALIZED_STRING_TYPE",
  22: "SHORT_EXTERNAL_ONE_BYTE_INTERNALIZED_STRING_TYPE",
  26: "SHORT_EXTERNAL_INTERNALIZED_STRING_WITH_ONE_BYTE_DATA_TYPE",
  128: "SYMBOL_TYPE",
  129: "MAP_TYPE",
  130: "CODE_TYPE",
  131: "ODDBALL_TYPE",
  181: "CELL_TYPE",
  183: "PROPERTY_CELL_TYPE",
  132: "HEAP_NUMBER_TYPE",
  133: "MUTABLE_HEAP_NUMBER_TYPE",
  134: "FLOAT32X4_TYPE",
  135: "FOREIGN_TYPE",
  136: "BYTE_ARRAY_TYPE",
  137: "FREE_SPACE_TYPE",
  138: "EXTERNAL_INT8_ARRAY_TYPE",
  139: "EXTERNAL_UINT8_ARRAY_TYPE",
  140: "EXTERNAL_INT16_ARRAY_TYPE",
  141: "EXTERNAL_UINT16_ARRAY_TYPE",
  142: "EXTERNAL_INT32_ARRAY_TYPE",
  143: "EXTERNAL_UINT32_ARRAY_TYPE",
  144: "EXTERNAL_FLOAT32_ARRAY_TYPE",
  145: "EXTERNAL_FLOAT64_ARRAY_TYPE",
  146: "EXTERNAL_UINT8_CLAMPED_ARRAY_TYPE",
  147: "FIXED_INT8_ARRAY_TYPE",
  148: "FIXED_UINT8_ARRAY_TYPE",
  149: "FIXED_INT16_ARRAY_TYPE",
  150: "FIXED_UINT16_ARRAY_TYPE",
  151: "FIXED_INT32_ARRAY_TYPE",
  152: "FIXED_UINT32_ARRAY_TYPE",
  153: "FIXED_FLOAT32_ARRAY_TYPE",
  154: "FIXED_FLOAT64_ARRAY_TYPE",
  155: "FIXED_UINT8_CLAMPED_ARRAY_TYPE",
  157: "FILLER_TYPE",
  158: "DECLARED_ACCESSOR_DESCRIPTOR_TYPE",
  159: "DECLARED_ACCESSOR_INFO_TYPE",
  160: "EXECUTABLE_ACCESSOR_INFO_TYPE",
  161: "ACCESSOR_PAIR_TYPE",
  162: "ACCESS_CHECK_INFO_TYPE",
  163: "INTERCEPTOR_INFO_TYPE",
  164: "CALL_HANDLER_INFO_TYPE",
  165: "FUNCTION_TEMPLATE_INFO_TYPE",
  166: "OBJECT_TEMPLATE_INFO_TYPE",
  167: "SIGNATURE_INFO_TYPE",
  168: "TYPE_SWITCH_INFO_TYPE",
  170: "ALLOCATION_MEMENTO_TYPE",
  169: "ALLOCATION_SITE_TYPE",
  171: "SCRIPT_TYPE",
  172: "CODE_CACHE_TYPE",
  173: "POLYMORPHIC_CODE_CACHE_TYPE",
  174: "TYPE_FEEDBACK_INFO_TYPE",
  175: "ALIASED_ARGUMENTS_ENTRY_TYPE",
  176: "BOX_TYPE",
  184: "PROTOTYPE_INFO_TYPE",
  179: "FIXED_ARRAY_TYPE",
  156: "FIXED_DOUBLE_ARRAY_TYPE",
  180: "SHARED_FUNCTION_INFO_TYPE",
  182: "WEAK_CELL_TYPE",
  188: "JS_MESSAGE_OBJECT_TYPE",
  187: "JS_VALUE_TYPE",
  189: "JS_DATE_TYPE",
  190: "JS_OBJECT_TYPE",
  191: "JS_CONTEXT_EXTENSION_OBJECT_TYPE",
  192: "JS_GENERATOR_OBJECT_TYPE",
  193: "JS_MODULE_TYPE",
  194: "JS_GLOBAL_OBJECT_TYPE",
  195: "JS_BUILTINS_OBJECT_TYPE",
  196: "JS_GLOBAL_PROXY_TYPE",
  197: "JS_ARRAY_TYPE",
  198: "JS_ARRAY_BUFFER_TYPE",
  199: "JS_TYPED_ARRAY_TYPE",
  200: "JS_DATA_VIEW_TYPE",
  186: "JS_PROXY_TYPE",
  201: "JS_SET_TYPE",
  202: "JS_MAP_TYPE",
  203: "JS_SET_ITERATOR_TYPE",
  204: "JS_MAP_ITERATOR_TYPE",
  205: "JS_WEAK_MAP_TYPE",
  206: "JS_WEAK_SET_TYPE",
  207: "JS_REGEXP_TYPE",
  208: "JS_FUNCTION_TYPE",
  185: "JS_FUNCTION_PROXY_TYPE",
  177: "DEBUG_INFO_TYPE",
  178: "BREAK_POINT_INFO_TYPE",
}

# List of known V8 maps.
KNOWN_MAPS = {
  0x08081: (136, "ByteArrayMap"),
  0x080ad: (129, "MetaMap"),
  0x080d9: (131, "NullMap"),
  0x08105: (179, "FixedArrayMap"),
  0x08131: (4, "OneByteInternalizedStringMap"),
  0x0815d: (182, "WeakCellMap"),
  0x08189: (131, "UndefinedMap"),
  0x081b5: (132, "HeapNumberMap"),
  0x081e1: (137, "FreeSpaceMap"),
  0x0820d: (157, "OnePointerFillerMap"),
  0x08239: (157, "TwoPointerFillerMap"),
  0x08265: (131, "TheHoleMap"),
  0x08291: (131, "BooleanMap"),
  0x082bd: (131, "UninitializedMap"),
  0x082e9: (181, "CellMap"),
  0x08315: (183, "GlobalPropertyCellMap"),
  0x08341: (180, "SharedFunctionInfoMap"),
  0x0836d: (133, "MutableHeapNumberMap"),
  0x08399: (134, "Float32x4Map"),
  0x083c5: (179, "NativeContextMap"),
  0x083f1: (130, "CodeMap"),
  0x0841d: (179, "ScopeInfoMap"),
  0x08449: (179, "FixedCOWArrayMap"),
  0x08475: (156, "FixedDoubleArrayMap"),
  0x084a1: (68, "OneByteStringMap"),
  0x084cd: (179, "FunctionContextMap"),
  0x084f9: (131, "NoInterceptorResultSentinelMap"),
  0x08525: (131, "ArgumentsMarkerMap"),
  0x08551: (131, "ExceptionMap"),
  0x0857d: (131, "TerminationExceptionMap"),
  0x085a9: (179, "HashTableMap"),
  0x085d5: (179, "OrderedHashTableMap"),
  0x08601: (128, "SymbolMap"),
  0x0862d: (64, "StringMap"),
  0x08659: (69, "ConsOneByteStringMap"),
  0x08685: (65, "ConsStringMap"),
  0x086b1: (67, "SlicedStringMap"),
  0x086dd: (71, "SlicedOneByteStringMap"),
  0x08709: (66, "ExternalStringMap"),
  0x08735: (74, "ExternalStringWithOneByteDataMap"),
  0x08761: (70, "ExternalOneByteStringMap"),
  0x0878d: (70, "NativeSourceStringMap"),
  0x087b9: (82, "ShortExternalStringMap"),
  0x087e5: (90, "ShortExternalStringWithOneByteDataMap"),
  0x08811: (0, "InternalizedStringMap"),
  0x0883d: (2, "ExternalInternalizedStringMap"),
  0x08869: (10, "ExternalInternalizedStringWithOneByteDataMap"),
  0x08895: (6, "ExternalOneByteInternalizedStringMap"),
  0x088c1: (18, "ShortExternalInternalizedStringMap"),
  0x088ed: (26, "ShortExternalInternalizedStringWithOneByteDataMap"),
  0x08919: (22, "ShortExternalOneByteInternalizedStringMap"),
  0x08945: (86, "ShortExternalOneByteStringMap"),
  0x08971: (138, "ExternalInt8ArrayMap"),
  0x0899d: (139, "ExternalUint8ArrayMap"),
  0x089c9: (140, "ExternalInt16ArrayMap"),
  0x089f5: (141, "ExternalUint16ArrayMap"),
  0x08a21: (142, "ExternalInt32ArrayMap"),
  0x08a4d: (143, "ExternalUint32ArrayMap"),
  0x08a79: (144, "ExternalFloat32ArrayMap"),
  0x08aa5: (145, "ExternalFloat64ArrayMap"),
  0x08ad1: (146, "ExternalUint8ClampedArrayMap"),
  0x08afd: (148, "FixedUint8ArrayMap"),
  0x08b29: (147, "FixedInt8ArrayMap"),
  0x08b55: (150, "FixedUint16ArrayMap"),
  0x08b81: (149, "FixedInt16ArrayMap"),
  0x08bad: (152, "FixedUint32ArrayMap"),
  0x08bd9: (151, "FixedInt32ArrayMap"),
  0x08c05: (153, "FixedFloat32ArrayMap"),
  0x08c31: (154, "FixedFloat64ArrayMap"),
  0x08c5d: (155, "FixedUint8ClampedArrayMap"),
  0x08c89: (179, "SloppyArgumentsElementsMap"),
  0x08cb5: (179, "CatchContextMap"),
  0x08ce1: (179, "WithContextMap"),
  0x08d0d: (179, "BlockContextMap"),
  0x08d39: (179, "ModuleContextMap"),
  0x08d65: (179, "ScriptContextMap"),
  0x08d91: (179, "ScriptContextTableMap"),
  0x08dbd: (188, "JSMessageObjectMap"),
  0x08de9: (135, "ForeignMap"),
  0x08e15: (190, "NeanderMap"),
  0x08e41: (190, "ExternalMap"),
  0x08e6d: (170, "AllocationMementoMap"),
  0x08e99: (169, "AllocationSiteMap"),
  0x08ec5: (173, "PolymorphicCodeCacheMap"),
  0x08ef1: (171, "ScriptMap"),
  0x0907d: (176, "BoxMap"),
  0x090a9: (160, "ExecutableAccessorInfoMap"),
  0x090d5: (161, "AccessorPairMap"),
  0x09101: (162, "AccessCheckInfoMap"),
  0x0912d: (163, "InterceptorInfoMap"),
  0x09159: (164, "CallHandlerInfoMap"),
  0x09185: (165, "FunctionTemplateInfoMap"),
  0x091b1: (166, "ObjectTemplateInfoMap"),
  0x091dd: (168, "TypeSwitchInfoMap"),
  0x09209: (172, "CodeCacheMap"),
  0x09235: (174, "TypeFeedbackInfoMap"),
  0x09261: (175, "AliasedArgumentsEntryMap"),
  0x0928d: (177, "DebugInfoMap"),
  0x092b9: (178, "BreakPointInfoMap"),
  0x092e5: (184, "PrototypeInfoMap"),
}

# List of known V8 objects.
KNOWN_OBJECTS = {
  ("OLD_SPACE", 0x08081): "NullValue",
  ("OLD_SPACE", 0x08091): "EmptyDescriptorArray",
  ("OLD_SPACE", 0x08099): "EmptyFixedArray",
  ("OLD_SPACE", 0x080bd): "UndefinedValue",
  ("OLD_SPACE", 0x080e5): "NanValue",
  ("OLD_SPACE", 0x080f1): "TheHoleValue",
  ("OLD_SPACE", 0x08111): "TrueValue",
  ("OLD_SPACE", 0x08131): "FalseValue",
  ("OLD_SPACE", 0x08155): "empty_string",
  ("OLD_SPACE", 0x08161): "UninitializedValue",
  ("OLD_SPACE", 0x0818d): "EmptyByteArray",
  ("OLD_SPACE", 0x08195): "NoInterceptorResultSentinel",
  ("OLD_SPACE", 0x081d1): "ArgumentsMarker",
  ("OLD_SPACE", 0x081fd): "Exception",
  ("OLD_SPACE", 0x08225): "TerminationException",
  ("OLD_SPACE", 0x08259): "NumberStringCache",
  ("OLD_SPACE", 0x08a61): "SingleCharacterStringCache",
  ("OLD_SPACE", 0x08ef9): "StringSplitCache",
  ("OLD_SPACE", 0x09301): "RegExpMultipleCache",
  ("OLD_SPACE", 0x09709): "EmptyExternalInt8Array",
  ("OLD_SPACE", 0x09715): "EmptyExternalUint8Array",
  ("OLD_SPACE", 0x09721): "EmptyExternalInt16Array",
  ("OLD_SPACE", 0x0972d): "EmptyExternalUint16Array",
  ("OLD_SPACE", 0x09739): "EmptyExternalInt32Array",
  ("OLD_SPACE", 0x09745): "EmptyExternalUint32Array",
  ("OLD_SPACE", 0x09751): "EmptyExternalFloat32Array",
  ("OLD_SPACE", 0x0975d): "EmptyExternalFloat64Array",
  ("OLD_SPACE", 0x09769): "EmptyExternalUint8ClampedArray",
  ("OLD_SPACE", 0x09775): "EmptyFixedUint8Array",
  ("OLD_SPACE", 0x0977d): "EmptyFixedInt8Array",
  ("OLD_SPACE", 0x09785): "EmptyFixedUint16Array",
  ("OLD_SPACE", 0x0978d): "EmptyFixedInt16Array",
  ("OLD_SPACE", 0x09795): "EmptyFixedUint32Array",
  ("OLD_SPACE", 0x0979d): "EmptyFixedInt32Array",
  ("OLD_SPACE", 0x097a5): "EmptyFixedFloat32Array",
  ("OLD_SPACE", 0x097ad): "EmptyFixedFloat64Array",
  ("OLD_SPACE", 0x097b5): "EmptyFixedUint8ClampedArray",
  ("OLD_SPACE", 0x097bd): "InfinityValue",
  ("OLD_SPACE", 0x097c9): "MinusZeroValue",
  ("OLD_SPACE", 0x097d5): "MessageListeners",
  ("OLD_SPACE", 0x097f1): "CodeStubs",
  ("OLD_SPACE", 0x12439): "ArrayProtector",
  ("OLD_SPACE", 0x12dfd): "KeyedLoadDummyVector",
  ("OLD_SPACE", 0x13cc5): "NonMonomorphicCache",
  ("OLD_SPACE", 0x14009): "PolymorphicCodeCache",
  ("OLD_SPACE", 0x14011): "NativesSourceCache",
  ("OLD_SPACE", 0x142d1): "ExperimentalNativesSourceCache",
  ("OLD_SPACE", 0x14309): "ExtraNativesSourceCache",
  ("OLD_SPACE", 0x14315): "EmptyScript",
  ("OLD_SPACE", 0x14351): "IntrinsicFunctionNames",
  ("OLD_SPACE", 0x233d5): "UndefinedCell",
  ("OLD_SPACE", 0x233dd): "ObservationState",
  ("OLD_SPACE", 0x233e9): "SymbolRegistry",
  ("OLD_SPACE", 0x2429d): "EmptySlowElementDictionary",
  ("OLD_SPACE", 0x242c5): "AllocationSitesScratchpad",
  ("OLD_SPACE", 0x246cd): "WeakObjectToCodeTable",
  ("OLD_SPACE", 0x4a5c1): "StringTable",
  ("CODE_SPACE", 0x180c1): "JsEntryCode",
  ("CODE_SPACE", 0x25c41): "JsConstructEntryCode",
}
node-v4.8.2/deps/v8/tools/v8heapconst.py.tmpl000644 000766 000024 00000003267 13070706735 021207 0ustar00iojsstaff000000 000000 # Copyright 2013 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

# This file is automatically generated from the V8 source and should not
# be modified manually, run 'make grokdump' instead to update this file.

node-v4.8.2/deps/v8/tools/verify_source_deps.py000755 000766 000024 00000006037 13070706735 021672 0ustar00iojsstaff000000 000000 #!/usr/bin/env python
# Copyright 2015 the V8 project authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

"""
Script to print potentially missing source dependencies based on the actual
.h and .cc files in the source tree and which files are included in the gyp
and gn files. The latter inclusion is overapproximated.

TODO(machenbach): Gyp files in src will point to source files in src without a
src/ prefix. For simplicity, all paths relative to src are stripped. But this
tool won't be accurate for other sources in other directories (e.g. cctest).
"""

import itertools
import re
import os


V8_BASE = os.path.dirname(os.path.dirname(os.path.realpath(__file__)))
V8_SRC_BASE = os.path.join(V8_BASE, 'src')
V8_INCLUDE_BASE = os.path.join(V8_BASE, 'include')

GYP_FILES = [
  os.path.join(V8_BASE, 'src', 'd8.gyp'),
  os.path.join(V8_BASE, 'src', 'third_party', 'vtune', 'v8vtune.gyp'),
  os.path.join(V8_BASE, 'test', 'cctest', 'cctest.gyp'),
  os.path.join(V8_BASE, 'test', 'unittests', 'unittests.gyp'),
  os.path.join(V8_BASE, 'tools', 'gyp', 'v8.gyp'),
  os.path.join(V8_BASE, 'tools', 'parser-shell.gyp'),
]


def path_no_prefix(path):
  if path.startswith('../'):
    return path_no_prefix(path[3:])
  elif path.startswith('src/'):
    return path_no_prefix(path[4:])
  else:
    return path


def isources(directory):
  for root, dirs, files in os.walk(directory):
    for f in files:
      if not (f.endswith('.h') or f.endswith('.cc')):
        continue
      yield path_no_prefix(os.path.relpath(os.path.join(root, f), V8_BASE))


def iflatten(obj):
  if isinstance(obj, dict):
    for value in obj.values():
      for i in iflatten(value):
        yield i
  elif isinstance(obj, list):
    for value in obj:
      for i in iflatten(value):
        yield i
  elif isinstance(obj, basestring):
    yield path_no_prefix(obj)


def iflatten_gyp_file(gyp_file):
  """Overaproximates all values in the gyp file.

  Iterates over all string values recursively. Removes '../' path prefixes.
  """
  with open(gyp_file) as f:
    return iflatten(eval(f.read()))


def iflatten_gn_file(gn_file):
  """Overaproximates all values in the gn file.

  Iterates over all double quoted strings.
  """
  with open(gn_file) as f:
    for line in f.read().splitlines():
      match = re.match(r'.*"([^"]*)".*', line)
      if match:
        yield path_no_prefix(match.group(1))


def icheck_values(values, *source_dirs):
  for source_file in itertools.chain(
      *[isources(source_dir) for source_dir in source_dirs]
    ):
    if source_file not in values:
      yield source_file


gyp_values = set(itertools.chain(
  *[iflatten_gyp_file(gyp_file) for gyp_file in GYP_FILES]
  ))

print "----------- Files not in gyp: ------------"
for i in sorted(icheck_values(gyp_values, V8_SRC_BASE, V8_INCLUDE_BASE)):
  print i

gn_values = set(iflatten_gn_file(os.path.join(V8_BASE, 'BUILD.gn')))

print "\n----------- Files not in gn: -------------"
for i in sorted(icheck_values(gn_values, V8_SRC_BASE, V8_INCLUDE_BASE)):
  print i
node-v4.8.2/deps/v8/tools/vim/000755 000766 000024 00000000000 13070706735 016203 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/v8/tools/visual_studio/000755 000766 000024 00000000000 13070706735 020302 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/v8/tools/whitespace.txt000644 000766 000024 00000000463 13070706735 020310 0ustar00iojsstaff000000 000000 You can modify this file to create no-op changelists.

Try to write something funny. And please don't add trailing whitespace.

A Smi balks into a war and says:
"I'm so deoptimized today!"
The doubles heard this and started to unbox.
The Smi looked at them when a crazy v8-autoroll account showed up.......
node-v4.8.2/deps/v8/tools/windows-tick-processor.bat000755 000766 000024 00000002433 13070706735 022544 0ustar00iojsstaff000000 000000 @echo off

SET tools_dir=%~dp0
IF 1%D8_PATH% == 1 (SET D8_PATH=%tools_dir%..)

SET log_file=v8.log

rem find the name of the log file to process, it must not start with a dash.
rem we prepend cmdline args with a number (in fact, any letter or number)
rem to cope with empty arguments.
SET arg1=1%1
IF NOT %arg1:~0,2% == 1 (IF NOT %arg1:~0,2% == 1- SET log_file=%1)
SET arg2=2%2
IF NOT %arg2:~0,2% == 2 (IF NOT %arg2:~0,2% == 2- SET log_file=%2)
SET arg3=3%3
IF NOT %arg3:~0,2% == 3 (IF NOT %arg3:~0,2% == 3- SET log_file=%3)
SET arg4=4%4
IF NOT %arg4:~0,2% == 4 (IF NOT %arg4:~0,2% == 4- SET log_file=%4)
SET arg5=5%5
IF NOT %arg5:~0,2% == 5 (IF NOT %arg5:~0,2% == 5- SET log_file=%5)
SET arg6=6%6
IF NOT %arg6:~0,2% == 6 (IF NOT %arg6:~0,2% == 6- SET log_file=%6)
SET arg7=7%7
IF NOT %arg7:~0,2% == 7 (IF NOT %arg7:~0,2% == 7- SET log_file=%7)
SET arg8=8%8
IF NOT %arg8:~0,2% == 8 (IF NOT %arg8:~0,2% == 8- SET log_file=%8)
SET arg9=9%9
IF NOT %arg9:~0,2% == 9 (IF NOT %arg9:~0,2% == 9- SET log_file=%9)

type %log_file% | %D8_PATH%\d8 %tools_dir%splaytree.js %tools_dir%codemap.js %tools_dir%csvparser.js %tools_dir%consarray.js %tools_dir%profile.js %tools_dir%profile_view.js %tools_dir%logreader.js %tools_dir%SourceMap.js %tools_dir%tickprocessor.js %tools_dir%tickprocessor-driver.js -- --windows %*
node-v4.8.2/deps/v8/tools/visual_studio/README.txt000644 000766 000024 00000001157 13070706735 022004 0ustar00iojsstaff000000 000000 The Microsoft Visual Studio project files for including V8 in a Visual
Studio/Visual C++ Express solution has been retired. If a Visual
Studio project/solution is needed there is the option of using GYP to
generate these. Please look in the build directory in the root of the
V8 project. It contains the required infrastructure and a README.txt
file explaining how to get started.

Generating Visual Studio projects using GYP is how the Chromium
project integrated V8 into the Windows build.

The main build system for V8 is still SCons, see the V8 wiki page
http://code.google.com/p/v8/wiki/BuildingOnWindows for details.
node-v4.8.2/deps/v8/tools/vim/ninja-build.vim000644 000766 000024 00000007753 13070706735 021130 0ustar00iojsstaff000000 000000 " Copyright (c) 2015 the V8 project authors. All rights reserved.
" Use of this source code is governed by a BSD-style license that can be
" found in the LICENSE file.
"
" Adds a "Compile this file" function, using ninja. On Mac, binds Cmd-k to
" this command. On Windows, Ctrl-F7 (which is the same as the VS default).
" On Linux, o, which is \o by default ("o"=creates .o files)
"
" Adds a "Build this target" function, using ninja. This is not bound
" to any key by default, but can be used via the :CrBuild command.
" It builds 'd8' by default, but :CrBuild target1 target2 etc works as well,
" i.e. :CrBuild all or :CrBuild d8 cctest unittests.
"
" Requires that gyp has already generated build.ninja files, and that ninja is
" in your path (which it is automatically if depot_tools is in your path).
" Bumps the number of parallel jobs in ninja automatically if goma is
" detected.
"
" Add the following to your .vimrc file:
"     so /path/to/src/tools/vim/ninja-build.vim

python << endpython
import os
import vim


def path_to_current_buffer():
  """Returns the absolute path of the current buffer."""
  return vim.current.buffer.name


def path_to_source_root():
  """Returns the absolute path to the V8 source root."""
  candidate = os.path.dirname(path_to_current_buffer())
  # This is a list of files that need to identify the src directory. The shorter
  # it is, the more likely it's wrong. The longer it is, the more likely it is to
  # break when we rename directories.
  fingerprints = ['.git', 'build', 'include', 'samples', 'src', 'testing',
                  'third_party', 'tools']
  while candidate and not all(
      [os.path.isdir(os.path.join(candidate, fp)) for fp in fingerprints]):
    candidate = os.path.dirname(candidate)
  return candidate


def path_to_build_dir(configuration):
  """Returns //(Release|Debug)."""

  v8_root = path_to_source_root()
  sys.path.append(os.path.join(v8_root, 'tools', 'ninja'))
  from ninja_output import GetNinjaOutputDirectory
  return GetNinjaOutputDirectory(v8_root, configuration)


def compute_ninja_command_for_targets(targets='', configuration=None):
  flags = []
  if "use_goma=1" in os.getenv('GYP_DEFINES', '').split(' '):
    flags = ['-j', '512']
  build_dir = path_to_build_dir(configuration);
  build_cmd = ' '.join(['ninja'] + flags + ['-C', build_dir, targets])
  vim.command('return "%s"' % build_cmd)


def compute_ninja_command_for_current_buffer(configuration=None):
  """Returns the shell command to compile the file in the current buffer."""
  build_dir = path_to_build_dir(configuration)

  # ninja needs filepaths for the ^ syntax to be relative to the
  # build directory.
  file_to_build = path_to_current_buffer()
  file_to_build = os.path.relpath(file_to_build, build_dir) + '^'
  if sys.platform == 'win32':
    # Escape \ for Vim, and ^ for both Vim and shell.
    file_to_build = file_to_build.replace('\\', '\\\\').replace('^', '^^^^')
  compute_ninja_command_for_targets(file_to_build, configuration)
endpython

fun! s:MakeWithCustomCommand(build_cmd)
  let l:oldmakepgr = &makeprg
  let &makeprg=a:build_cmd
  silent make | cwindow
  if !has('gui_running')
    redraw!
  endif
  let &makeprg = l:oldmakepgr
endfun

fun! s:NinjaCommandForCurrentBuffer()
  python compute_ninja_command_for_current_buffer()
endfun

fun! s:NinjaCommandForTargets(targets)
  python compute_ninja_command_for_targets(vim.eval('a:targets'))
endfun

fun! CrCompileFile()
  call s:MakeWithCustomCommand(s:NinjaCommandForCurrentBuffer())
endfun

fun! CrBuild(...)
  let l:targets = a:0 > 0 ? join(a:000, ' ') : ''
  if (l:targets !~ '\i')
    let l:targets = 'd8'
  endif
  call s:MakeWithCustomCommand(s:NinjaCommandForTargets(l:targets))
endfun

command! CrCompileFile call CrCompileFile()
command! -nargs=* CrBuild call CrBuild()

if has('mac')
  map  :CrCompileFile
  imap  :CrCompileFile
elseif has('win32')
  map  :CrCompileFile
  imap  :CrCompileFile
elseif has('unix')
  map o :CrCompileFile
endif
node-v4.8.2/deps/v8/tools/unittests/run_perf_test.py000644 000766 000024 00000035667 13070706735 022724 0ustar00iojsstaff000000 000000 #!/usr/bin/env python
# Copyright 2014 the V8 project authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

from collections import namedtuple
import coverage
import json
from mock import DEFAULT
from mock import MagicMock
import os
from os import path, sys
import shutil
import tempfile
import unittest

# Requires python-coverage and python-mock. Native python coverage
# version >= 3.7.1 should be installed to get the best speed.

TEST_WORKSPACE = path.join(tempfile.gettempdir(), "test-v8-run-perf")

V8_JSON = {
  "path": ["."],
  "binary": "d7",
  "flags": ["--flag"],
  "main": "run.js",
  "run_count": 1,
  "results_regexp": "^%s: (.+)$",
  "tests": [
    {"name": "Richards"},
    {"name": "DeltaBlue"},
  ]
}

V8_NESTED_SUITES_JSON = {
  "path": ["."],
  "flags": ["--flag"],
  "run_count": 1,
  "units": "score",
  "tests": [
    {"name": "Richards",
     "path": ["richards"],
     "binary": "d7",
     "main": "run.js",
     "resources": ["file1.js", "file2.js"],
     "run_count": 2,
     "results_regexp": "^Richards: (.+)$"},
    {"name": "Sub",
     "path": ["sub"],
     "tests": [
       {"name": "Leaf",
        "path": ["leaf"],
        "run_count_x64": 3,
        "units": "ms",
        "main": "run.js",
        "results_regexp": "^Simple: (.+) ms.$"},
     ]
    },
    {"name": "DeltaBlue",
     "path": ["delta_blue"],
     "main": "run.js",
     "flags": ["--flag2"],
     "results_regexp": "^DeltaBlue: (.+)$"},
    {"name": "ShouldntRun",
     "path": ["."],
     "archs": ["arm"],
     "main": "run.js"},
  ]
}

V8_GENERIC_JSON = {
  "path": ["."],
  "binary": "cc",
  "flags": ["--flag"],
  "generic": True,
  "run_count": 1,
  "units": "ms",
}

Output = namedtuple("Output", "stdout, stderr, timed_out")

class PerfTest(unittest.TestCase):
  @classmethod
  def setUpClass(cls):
    cls.base = path.dirname(path.dirname(path.abspath(__file__)))
    sys.path.append(cls.base)
    cls._cov = coverage.coverage(
        include=([os.path.join(cls.base, "run_perf.py")]))
    cls._cov.start()
    import run_perf
    from testrunner.local import commands
    global commands
    global run_perf

  @classmethod
  def tearDownClass(cls):
    cls._cov.stop()
    print ""
    print cls._cov.report()

  def setUp(self):
    self.maxDiff = None
    if path.exists(TEST_WORKSPACE):
      shutil.rmtree(TEST_WORKSPACE)
    os.makedirs(TEST_WORKSPACE)

  def tearDown(self):
    if path.exists(TEST_WORKSPACE):
      shutil.rmtree(TEST_WORKSPACE)

  def _WriteTestInput(self, json_content):
    self._test_input = path.join(TEST_WORKSPACE, "test.json")
    with open(self._test_input, "w") as f:
      f.write(json.dumps(json_content))

  def _MockCommand(self, *args, **kwargs):
    # Fake output for each test run.
    test_outputs = [Output(stdout=arg,
                           stderr=None,
                           timed_out=kwargs.get("timed_out", False))
                    for arg in args[1]]
    def execute(*args, **kwargs):
      return test_outputs.pop()
    commands.Execute = MagicMock(side_effect=execute)

    # Check that d8 is called from the correct cwd for each test run.
    dirs = [path.join(TEST_WORKSPACE, arg) for arg in args[0]]
    def chdir(*args, **kwargs):
      self.assertEquals(dirs.pop(), args[0])
    os.chdir = MagicMock(side_effect=chdir)

  def _CallMain(self, *args):
    self._test_output = path.join(TEST_WORKSPACE, "results.json")
    all_args=[
      "--json-test-results",
      self._test_output,
      self._test_input,
    ]
    all_args += args
    return run_perf.Main(all_args)

  def _LoadResults(self):
    with open(self._test_output) as f:
      return json.load(f)

  def _VerifyResults(self, suite, units, traces):
    self.assertEquals([
      {"units": units,
       "graphs": [suite, trace["name"]],
       "results": trace["results"],
       "stddev": trace["stddev"]} for trace in traces],
      self._LoadResults()["traces"])

  def _VerifyErrors(self, errors):
    self.assertEquals(errors, self._LoadResults()["errors"])

  def _VerifyMock(self, binary, *args, **kwargs):
    arg = [path.join(path.dirname(self.base), binary)]
    arg += args
    commands.Execute.assert_called_with(
        arg, timeout=kwargs.get("timeout", 60))

  def _VerifyMockMultiple(self, *args, **kwargs):
    expected = []
    for arg in args:
      a = [path.join(path.dirname(self.base), arg[0])]
      a += arg[1:]
      expected.append(((a,), {"timeout": kwargs.get("timeout", 60)}))
    self.assertEquals(expected, commands.Execute.call_args_list)

  def testOneRun(self):
    self._WriteTestInput(V8_JSON)
    self._MockCommand(["."], ["x\nRichards: 1.234\nDeltaBlue: 10657567\ny\n"])
    self.assertEquals(0, self._CallMain())
    self._VerifyResults("test", "score", [
      {"name": "Richards", "results": ["1.234"], "stddev": ""},
      {"name": "DeltaBlue", "results": ["10657567.0"], "stddev": ""},
    ])
    self._VerifyErrors([])
    self._VerifyMock(path.join("out", "x64.release", "d7"), "--flag", "run.js")

  def testOneRunWithTestFlags(self):
    test_input = dict(V8_JSON)
    test_input["test_flags"] = ["2", "test_name"]
    self._WriteTestInput(test_input)
    self._MockCommand(["."], ["Richards: 1.234\nDeltaBlue: 10657567"])
    self.assertEquals(0, self._CallMain())
    self._VerifyResults("test", "score", [
      {"name": "Richards", "results": ["1.234"], "stddev": ""},
      {"name": "DeltaBlue", "results": ["10657567.0"], "stddev": ""},
    ])
    self._VerifyErrors([])
    self._VerifyMock(path.join("out", "x64.release", "d7"), "--flag", "run.js",
                     "--", "2", "test_name")

  def testTwoRuns_Units_SuiteName(self):
    test_input = dict(V8_JSON)
    test_input["run_count"] = 2
    test_input["name"] = "v8"
    test_input["units"] = "ms"
    self._WriteTestInput(test_input)
    self._MockCommand([".", "."],
                      ["Richards: 100\nDeltaBlue: 200\n",
                       "Richards: 50\nDeltaBlue: 300\n"])
    self.assertEquals(0, self._CallMain())
    self._VerifyResults("v8", "ms", [
      {"name": "Richards", "results": ["50.0", "100.0"], "stddev": ""},
      {"name": "DeltaBlue", "results": ["300.0", "200.0"], "stddev": ""},
    ])
    self._VerifyErrors([])
    self._VerifyMock(path.join("out", "x64.release", "d7"), "--flag", "run.js")

  def testTwoRuns_SubRegexp(self):
    test_input = dict(V8_JSON)
    test_input["run_count"] = 2
    del test_input["results_regexp"]
    test_input["tests"][0]["results_regexp"] = "^Richards: (.+)$"
    test_input["tests"][1]["results_regexp"] = "^DeltaBlue: (.+)$"
    self._WriteTestInput(test_input)
    self._MockCommand([".", "."],
                      ["Richards: 100\nDeltaBlue: 200\n",
                       "Richards: 50\nDeltaBlue: 300\n"])
    self.assertEquals(0, self._CallMain())
    self._VerifyResults("test", "score", [
      {"name": "Richards", "results": ["50.0", "100.0"], "stddev": ""},
      {"name": "DeltaBlue", "results": ["300.0", "200.0"], "stddev": ""},
    ])
    self._VerifyErrors([])
    self._VerifyMock(path.join("out", "x64.release", "d7"), "--flag", "run.js")

  def testNestedSuite(self):
    self._WriteTestInput(V8_NESTED_SUITES_JSON)
    self._MockCommand(["delta_blue", "sub/leaf", "richards"],
                      ["DeltaBlue: 200\n",
                       "Simple: 1 ms.\n",
                       "Simple: 2 ms.\n",
                       "Simple: 3 ms.\n",
                       "Richards: 100\n",
                       "Richards: 50\n"])
    self.assertEquals(0, self._CallMain())
    self.assertEquals([
      {"units": "score",
       "graphs": ["test", "Richards"],
       "results": ["50.0", "100.0"],
       "stddev": ""},
      {"units": "ms",
       "graphs": ["test", "Sub", "Leaf"],
       "results": ["3.0", "2.0", "1.0"],
       "stddev": ""},
      {"units": "score",
       "graphs": ["test", "DeltaBlue"],
       "results": ["200.0"],
       "stddev": ""},
      ], self._LoadResults()["traces"])
    self._VerifyErrors([])
    self._VerifyMockMultiple(
        (path.join("out", "x64.release", "d7"), "--flag", "run.js"),
        (path.join("out", "x64.release", "d7"), "--flag", "run.js"),
        (path.join("out", "x64.release", "d8"), "--flag", "run.js"),
        (path.join("out", "x64.release", "d8"), "--flag", "run.js"),
        (path.join("out", "x64.release", "d8"), "--flag", "run.js"),
        (path.join("out", "x64.release", "d8"), "--flag", "--flag2", "run.js"))

  def testOneRunStdDevRegExp(self):
    test_input = dict(V8_JSON)
    test_input["stddev_regexp"] = "^%s\-stddev: (.+)$"
    self._WriteTestInput(test_input)
    self._MockCommand(["."], ["Richards: 1.234\nRichards-stddev: 0.23\n"
                              "DeltaBlue: 10657567\nDeltaBlue-stddev: 106\n"])
    self.assertEquals(0, self._CallMain())
    self._VerifyResults("test", "score", [
      {"name": "Richards", "results": ["1.234"], "stddev": "0.23"},
      {"name": "DeltaBlue", "results": ["10657567.0"], "stddev": "106"},
    ])
    self._VerifyErrors([])
    self._VerifyMock(path.join("out", "x64.release", "d7"), "--flag", "run.js")

  def testTwoRunsStdDevRegExp(self):
    test_input = dict(V8_JSON)
    test_input["stddev_regexp"] = "^%s\-stddev: (.+)$"
    test_input["run_count"] = 2
    self._WriteTestInput(test_input)
    self._MockCommand(["."], ["Richards: 3\nRichards-stddev: 0.7\n"
                              "DeltaBlue: 6\nDeltaBlue-boom: 0.9\n",
                              "Richards: 2\nRichards-stddev: 0.5\n"
                              "DeltaBlue: 5\nDeltaBlue-stddev: 0.8\n"])
    self.assertEquals(1, self._CallMain())
    self._VerifyResults("test", "score", [
      {"name": "Richards", "results": ["2.0", "3.0"], "stddev": "0.7"},
      {"name": "DeltaBlue", "results": ["5.0", "6.0"], "stddev": "0.8"},
    ])
    self._VerifyErrors(
        ["Test Richards should only run once since a stddev is provided "
         "by the test.",
         "Test DeltaBlue should only run once since a stddev is provided "
         "by the test.",
         "Regexp \"^DeltaBlue\-stddev: (.+)$\" didn't match for test "
         "DeltaBlue."])
    self._VerifyMock(path.join("out", "x64.release", "d7"), "--flag", "run.js")

  def testBuildbot(self):
    self._WriteTestInput(V8_JSON)
    self._MockCommand(["."], ["Richards: 1.234\nDeltaBlue: 10657567\n"])
    self.assertEquals(0, self._CallMain("--buildbot"))
    self._VerifyResults("test", "score", [
      {"name": "Richards", "results": ["1.234"], "stddev": ""},
      {"name": "DeltaBlue", "results": ["10657567.0"], "stddev": ""},
    ])
    self._VerifyErrors([])
    self._VerifyMock(path.join("out", "Release", "d7"), "--flag", "run.js")

  def testBuildbotWithTotal(self):
    test_input = dict(V8_JSON)
    test_input["total"] = True
    self._WriteTestInput(test_input)
    self._MockCommand(["."], ["Richards: 1.234\nDeltaBlue: 10657567\n"])
    self.assertEquals(0, self._CallMain("--buildbot"))
    self._VerifyResults("test", "score", [
      {"name": "Richards", "results": ["1.234"], "stddev": ""},
      {"name": "DeltaBlue", "results": ["10657567.0"], "stddev": ""},
      {"name": "Total", "results": ["3626.49109719"], "stddev": ""},
    ])
    self._VerifyErrors([])
    self._VerifyMock(path.join("out", "Release", "d7"), "--flag", "run.js")

  def testBuildbotWithTotalAndErrors(self):
    test_input = dict(V8_JSON)
    test_input["total"] = True
    self._WriteTestInput(test_input)
    self._MockCommand(["."], ["x\nRichards: bla\nDeltaBlue: 10657567\ny\n"])
    self.assertEquals(1, self._CallMain("--buildbot"))
    self._VerifyResults("test", "score", [
      {"name": "Richards", "results": [], "stddev": ""},
      {"name": "DeltaBlue", "results": ["10657567.0"], "stddev": ""},
    ])
    self._VerifyErrors(
        ["Regexp \"^Richards: (.+)$\" "
         "returned a non-numeric for test Richards.",
         "Not all traces have the same number of results."])
    self._VerifyMock(path.join("out", "Release", "d7"), "--flag", "run.js")

  def testRegexpNoMatch(self):
    self._WriteTestInput(V8_JSON)
    self._MockCommand(["."], ["x\nRichaards: 1.234\nDeltaBlue: 10657567\ny\n"])
    self.assertEquals(1, self._CallMain())
    self._VerifyResults("test", "score", [
      {"name": "Richards", "results": [], "stddev": ""},
      {"name": "DeltaBlue", "results": ["10657567.0"], "stddev": ""},
    ])
    self._VerifyErrors(
        ["Regexp \"^Richards: (.+)$\" didn't match for test Richards."])
    self._VerifyMock(path.join("out", "x64.release", "d7"), "--flag", "run.js")

  def testOneRunGeneric(self):
    test_input = dict(V8_GENERIC_JSON)
    self._WriteTestInput(test_input)
    self._MockCommand(["."], [
      "RESULT Infra: Constant1= 11 count\n"
      "RESULT Infra: Constant2= [10,5,10,15] count\n"
      "RESULT Infra: Constant3= {12,1.2} count\n"
      "RESULT Infra: Constant4= [10,5,error,15] count\n"])
    self.assertEquals(1, self._CallMain())
    self.assertEquals([
      {"units": "count",
       "graphs": ["test", "Infra", "Constant1"],
       "results": ["11.0"],
       "stddev": ""},
      {"units": "count",
       "graphs": ["test", "Infra", "Constant2"],
       "results": ["10.0", "5.0", "10.0", "15.0"],
       "stddev": ""},
      {"units": "count",
       "graphs": ["test", "Infra", "Constant3"],
       "results": ["12.0"],
       "stddev": "1.2"},
      {"units": "count",
       "graphs": ["test", "Infra", "Constant4"],
       "results": [],
       "stddev": ""},
      ], self._LoadResults()["traces"])
    self._VerifyErrors(["Found non-numeric in test/Infra/Constant4"])
    self._VerifyMock(path.join("out", "x64.release", "cc"), "--flag", "")

  def testOneRunTimingOut(self):
    test_input = dict(V8_JSON)
    test_input["timeout"] = 70
    self._WriteTestInput(test_input)
    self._MockCommand(["."], [""], timed_out=True)
    self.assertEquals(1, self._CallMain())
    self._VerifyResults("test", "score", [
      {"name": "Richards", "results": [], "stddev": ""},
      {"name": "DeltaBlue", "results": [], "stddev": ""},
    ])
    self._VerifyErrors([
      "Regexp \"^Richards: (.+)$\" didn't match for test Richards.",
      "Regexp \"^DeltaBlue: (.+)$\" didn't match for test DeltaBlue.",
    ])
    self._VerifyMock(
        path.join("out", "x64.release", "d7"), "--flag", "run.js", timeout=70)

  # Simple test that mocks out the android platform. Testing the platform would
  # require lots of complicated mocks for the android tools.
  def testAndroid(self):
    self._WriteTestInput(V8_JSON)
    platform = run_perf.Platform
    platform.PreExecution = MagicMock(return_value=None)
    platform.PostExecution = MagicMock(return_value=None)
    platform.PreTests = MagicMock(return_value=None)
    platform.Run = MagicMock(
        return_value="Richards: 1.234\nDeltaBlue: 10657567\n")
    run_perf.AndroidPlatform = MagicMock(return_value=platform)
    self.assertEquals(
        0, self._CallMain("--android-build-tools", "/some/dir",
                          "--arch", "android_arm"))
    self._VerifyResults("test", "score", [
      {"name": "Richards", "results": ["1.234"], "stddev": ""},
      {"name": "DeltaBlue", "results": ["10657567.0"], "stddev": ""},
    ])
node-v4.8.2/deps/v8/tools/testrunner/__init__.py000644 000766 000024 00000003043 13070706735 021732 0ustar00iojsstaff000000 000000 # Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
node-v4.8.2/deps/v8/tools/testrunner/local/000755 000766 000024 00000000000 13070706735 020713 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/v8/tools/testrunner/network/000755 000766 000024 00000000000 13070706735 021312 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/v8/tools/testrunner/objects/000755 000766 000024 00000000000 13070706735 021252 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/v8/tools/testrunner/README000644 000766 000024 00000014640 13070706735 020506 0ustar00iojsstaff000000 000000 Test suite runner for V8, including support for distributed running.
====================================================================


Local usage instructions:
=========================

Run the main script with --help to get detailed usage instructions:

$ tools/run-tests.py --help

The interface is mostly the same as it was for the old test runner.
You'll likely want something like this:

$ tools/run-tests.py --nonetwork --arch ia32 --mode release

--nonetwork is the default on Mac and Windows. If you don't specify --arch
and/or --mode, all available values will be used and run in turn (e.g.,
omitting --mode from the above example will run ia32 in both Release and Debug
modes).


Networked usage instructions:
=============================

Networked running is only supported on Linux currently. Make sure that all
machines participating in the cluster are binary-compatible (e.g. mixing
Ubuntu Lucid and Precise doesn't work).

Setup:
------

1.) Copy tools/test-server.py to a new empty directory anywhere on your hard
    drive (preferably not inside your V8 checkout just to keep things clean).
    Please do create a copy, not just a symlink.

2.) Navigate to the new directory and let the server setup itself:

$ ./test-server.py setup

    This will install PIP and UltraJSON, create a V8 working directory, and
    generate a keypair.

3.) Swap public keys with someone who's already part of the networked cluster.

$ cp trusted/`cat data/mypubkey`.pem /where/peers/can/see/it/myname.pem
$ ./test-server.py approve /wherever/they/put/it/yourname.pem


Usage:
------

1.) Start your server:

$ ./test-server.py start

2.) (Optionally) inspect the server's status:

$ ./test-server.py status

3.) From your regular V8 working directory, run tests:

$ tool/run-tests.py --arch ia32 --mode debug

4.) (Optionally) enjoy the speeeeeeeeeeeeeeeed


Architecture overview:
======================

Code organization:
------------------

This section is written from the point of view of the tools/ directory.

./run-tests.py:
  Main script. Parses command-line options and drives the test execution
  procedure from a high level. Imports the actual implementation of all
  steps from the testrunner/ directory.

./test-server.py:
  Interface to interact with the server. Contains code to setup the server's
  working environment and can start and stop server daemon processes.
  Imports some stuff from the testrunner/server/ directory.

./testrunner/local/*:
  Implementation needed to run tests locally. Used by run-tests.py. Inspired by
  (and partly copied verbatim from) the original test.py script.

./testrunner/objects/*:
  A bunch of data container classes, used by the scripts in the various other
  directories; serializable for transmission over the network.

./testrunner/network/*:
  Equivalents and extensions of some of the functionality in ./testrunner/local/
  as required when dispatching tests to peers on the network.

./testrunner/network/network_execution.py:
  Drop-in replacement for ./testrunner/local/execution that distributes
  test jobs to network peers instead of running them locally.

./testrunner/network/endpoint.py:
  Receiving end of a network distributed job, uses the implementation
  in ./testrunner/local/execution.py for actually running the tests.

./testrunner/server/*:
  Implementation of the daemon that accepts and runs test execution jobs from
  peers on the network. Should ideally have no dependencies on any of the other
  directories, but that turned out to be impractical, so there are a few
  exceptions.

./testrunner/server/compression.py:
  Defines a wrapper around Python TCP sockets that provides JSON based
  serialization, gzip based compression, and ensures message completeness.


Networking architecture:
------------------------

The distribution stuff is designed to be a layer between deciding which tests
to run on the one side, and actually running them on the other. The frontend
that the user interacts with is the same for local and networked execution,
and the actual test execution and result gathering code is the same too.

The server daemon starts four separate servers, each listening on another port:
- "Local": Communication with a run-tests.py script running on the same host.
  The test driving script e.g. needs to ask for available peers. It then talks
  to those peers directly (one of them will be the locally running server).
- "Work": Listens for test job requests from run-tests.py scripts on the network
  (including localhost). Accepts an arbitrary number of connections at the
  same time, but only works on them in a serialized fashion.
- "Status": Used for communication with other servers on the network, e.g. for
  exchanging trusted public keys to create the transitive trust closure.
- "Discovery": Used to detect presence of other peers on the network.
  In contrast to the other three, this uses UDP (as opposed to TCP).


Give us a diagram! We love diagrams!
------------------------------------
                                     .
                         Machine A   .  Machine B
                                     .
+------------------------------+     .
|        run-tests.py          |     .
|         with flag:           |     .
|--nonetwork   --network       |     .
|   |          /    |          |     .
|   |         /     |          |     .
|   v        /      v          |     .
|BACKEND    /   distribution   |     .
+--------- / --------| \ ------+     .
          /          |  \_____________________
         /           |               .        \
        /            |               .         \
+----- v ----------- v --------+     .    +---- v -----------------------+
| LocalHandler | WorkHandler   |     .    | WorkHandler   | LocalHandler |
|              |     |         |     .    |     |         |              |
|              |     v         |     .    |     v         |              |
|              |  BACKEND      |     .    |  BACKEND      |              |
|------------- +---------------|     .    |---------------+--------------|
| Discovery    | StatusHandler <----------> StatusHandler | Discovery    |
+---- ^ -----------------------+     .    +-------------------- ^ -------+
      |                              .                          |
      +---------------------------------------------------------+

Note that the three occurrences of "BACKEND" are the same code
(testrunner/local/execution.py and its imports), but running from three
distinct directories (and on two different machines).
node-v4.8.2/deps/v8/tools/testrunner/server/000755 000766 000024 00000000000 13070706735 021127 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/v8/tools/testrunner/server/__init__.py000644 000766 000024 00000003043 13070706735 023240 0ustar00iojsstaff000000 000000 # Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
node-v4.8.2/deps/v8/tools/testrunner/server/compression.py000644 000766 000024 00000006763 13070706735 024056 0ustar00iojsstaff000000 000000 # Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


import cStringIO as StringIO
try:
  import ujson as json
except ImportError:
  import json
import os
import struct
import zlib

from . import constants

def Send(obj, sock):
  """
  Sends a JSON encodable object over the specified socket (zlib-compressed).
  """
  obj = json.dumps(obj)
  compression_level = 2  # 1 = fastest, 9 = best compression
  compressed = zlib.compress(obj, compression_level)
  payload = struct.pack('>i', len(compressed)) + compressed
  sock.sendall(payload)


class Receiver(object):
  def __init__(self, sock):
    self.sock = sock
    self.data = StringIO.StringIO()
    self.datalength = 0
    self._next = self._GetNext()

  def IsDone(self):
    return self._next == None

  def Current(self):
    return self._next

  def Advance(self):
    try:
      self._next = self._GetNext()
    except:
      raise

  def _GetNext(self):
    try:
      while self.datalength < constants.SIZE_T:
        try:
          chunk = self.sock.recv(8192)
        except:
          raise
        if not chunk: return None
        self._AppendData(chunk)
      size = self._PopData(constants.SIZE_T)
      size = struct.unpack(">i", size)[0]
      while self.datalength < size:
        try:
          chunk = self.sock.recv(8192)
        except:
          raise
        if not chunk: return None
        self._AppendData(chunk)
      result = self._PopData(size)
      result = zlib.decompress(result)
      result = json.loads(result)
      if result == constants.END_OF_STREAM:
        return None
      return result
    except:
      raise

  def _AppendData(self, new):
    self.data.seek(0, os.SEEK_END)
    self.data.write(new)
    self.datalength += len(new)

  def _PopData(self, length):
    self.data.seek(0)
    chunk = self.data.read(length)
    remaining = self.data.read()
    self.data.close()
    self.data = StringIO.StringIO()
    self.data.write(remaining)
    assert self.datalength - length == len(remaining)
    self.datalength = len(remaining)
    return chunk
node-v4.8.2/deps/v8/tools/testrunner/server/constants.py000644 000766 000024 00000004741 13070706735 023523 0ustar00iojsstaff000000 000000 # Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


CLIENT_PORT = 9991  # Port for the local client to connect to.
PEER_PORT = 9992  # Port for peers on the network to connect to.
PRESENCE_PORT = 9993  # Port for presence daemon.
STATUS_PORT = 9994  # Port for network requests not related to workpackets.

END_OF_STREAM = "end of dtest stream"  # Marker for end of network requests.
SIZE_T = 4  # Number of bytes used for network request size header.

# Messages understood by the local request handler.
ADD_TRUSTED = "add trusted"
INFORM_DURATION = "inform about duration"
REQUEST_PEERS = "get peers"
UNRESPONSIVE_PEER = "unresponsive peer"
REQUEST_PUBKEY_FINGERPRINT = "get pubkey fingerprint"
REQUEST_STATUS = "get status"
UPDATE_PERF = "update performance"

# Messages understood by the status request handler.
LIST_TRUSTED_PUBKEYS = "list trusted pubkeys"
GET_SIGNED_PUBKEY = "pass on signed pubkey"
NOTIFY_NEW_TRUSTED = "new trusted peer"
TRUST_YOU_NOW = "trust you now"
DO_YOU_TRUST = "do you trust"
node-v4.8.2/deps/v8/tools/testrunner/server/daemon.py000644 000766 000024 00000007251 13070706735 022751 0ustar00iojsstaff000000 000000 #!/usr/bin/env python

# This code has been written by Sander Marechal and published at:
# http://www.jejik.com/articles/2007/02/a_simple_unix_linux_daemon_in_python/
# where the author has placed it in the public domain (see comment #6 at
# http://www.jejik.com/articles/2007/02/a_simple_unix_linux_daemon_in_python/#c6
# ).
# Some minor modifications have been made by the V8 authors. The work remains
# in the public domain.

import atexit
import os
from signal import SIGTERM
from signal import SIGINT
import sys
import time


class Daemon(object):
  """
  A generic daemon class.

  Usage: subclass the Daemon class and override the run() method
  """
  def __init__(self, pidfile, stdin='/dev/null',
               stdout='/dev/null', stderr='/dev/null'):
    self.stdin = stdin
    self.stdout = stdout
    self.stderr = stderr
    self.pidfile = pidfile

  def daemonize(self):
    """
    do the UNIX double-fork magic, see Stevens' "Advanced
    Programming in the UNIX Environment" for details (ISBN 0201563177)
    http://www.erlenstar.demon.co.uk/unix/faq_2.html#SEC16
    """
    try:
      pid = os.fork()
      if pid > 0:
        # exit first parent
        sys.exit(0)
    except OSError, e:
      sys.stderr.write("fork #1 failed: %d (%s)\n" % (e.errno, e.strerror))
      sys.exit(1)

    # decouple from parent environment
    os.chdir("/")
    os.setsid()
    os.umask(0)

    # do second fork
    try:
      pid = os.fork()
      if pid > 0:
        # exit from second parent
        sys.exit(0)
    except OSError, e:
      sys.stderr.write("fork #2 failed: %d (%s)\n" % (e.errno, e.strerror))
      sys.exit(1)

    # redirect standard file descriptors
    sys.stdout.flush()
    sys.stderr.flush()
    si = file(self.stdin, 'r')
    so = file(self.stdout, 'a+')
    se = file(self.stderr, 'a+', 0)
    # TODO: (debug) re-enable this!
    #os.dup2(si.fileno(), sys.stdin.fileno())
    #os.dup2(so.fileno(), sys.stdout.fileno())
    #os.dup2(se.fileno(), sys.stderr.fileno())

    # write pidfile
    atexit.register(self.delpid)
    pid = str(os.getpid())
    file(self.pidfile, 'w+').write("%s\n" % pid)

  def delpid(self):
    os.remove(self.pidfile)

  def start(self):
    """
    Start the daemon
    """
    # Check for a pidfile to see if the daemon already runs
    try:
      pf = file(self.pidfile, 'r')
      pid = int(pf.read().strip())
      pf.close()
    except IOError:
      pid = None

    if pid:
      message = "pidfile %s already exist. Daemon already running?\n"
      sys.stderr.write(message % self.pidfile)
      sys.exit(1)

    # Start the daemon
    self.daemonize()
    self.run()

  def stop(self):
    """
    Stop the daemon
    """
    # Get the pid from the pidfile
    try:
      pf = file(self.pidfile, 'r')
      pid = int(pf.read().strip())
      pf.close()
    except IOError:
      pid = None

    if not pid:
      message = "pidfile %s does not exist. Daemon not running?\n"
      sys.stderr.write(message % self.pidfile)
      return # not an error in a restart

    # Try killing the daemon process
    try:
      # Give the process a one-second chance to exit gracefully.
      os.kill(pid, SIGINT)
      time.sleep(1)
      while 1:
        os.kill(pid, SIGTERM)
        time.sleep(0.1)
    except OSError, err:
      err = str(err)
      if err.find("No such process") > 0:
        if os.path.exists(self.pidfile):
          os.remove(self.pidfile)
      else:
        print str(err)
        sys.exit(1)

  def restart(self):
    """
    Restart the daemon
    """
    self.stop()
    self.start()

  def run(self):
    """
    You should override this method when you subclass Daemon. It will be
    called after the process has been daemonized by start() or restart().
    """
node-v4.8.2/deps/v8/tools/testrunner/server/local_handler.py000644 000766 000024 00000010707 13070706735 024275 0ustar00iojsstaff000000 000000 # Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


import socket
import SocketServer
import StringIO

from . import compression
from . import constants


def LocalQuery(query):
  sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
  code = sock.connect_ex(("localhost", constants.CLIENT_PORT))
  if code != 0: return None
  compression.Send(query, sock)
  compression.Send(constants.END_OF_STREAM, sock)
  rec = compression.Receiver(sock)
  data = None
  while not rec.IsDone():
    data = rec.Current()
    assert data[0] == query[0]
    data = data[1]
    rec.Advance()
  sock.close()
  return data


class LocalHandler(SocketServer.BaseRequestHandler):
  def handle(self):
    rec = compression.Receiver(self.request)
    while not rec.IsDone():
      data = rec.Current()
      action = data[0]

      if action == constants.REQUEST_PEERS:
        with self.server.daemon.peer_list_lock:
          response = [ p.Pack() for p in self.server.daemon.peers
                       if p.trusting_me ]
        compression.Send([action, response], self.request)

      elif action == constants.UNRESPONSIVE_PEER:
        self.server.daemon.DeletePeer(data[1])

      elif action == constants.REQUEST_PUBKEY_FINGERPRINT:
        compression.Send([action, self.server.daemon.pubkey_fingerprint],
                         self.request)

      elif action == constants.REQUEST_STATUS:
        compression.Send([action, self._GetStatusMessage()], self.request)

      elif action == constants.ADD_TRUSTED:
        fingerprint = self.server.daemon.CopyToTrusted(data[1])
        compression.Send([action, fingerprint], self.request)

      elif action == constants.INFORM_DURATION:
        test_key = data[1]
        test_duration = data[2]
        arch = data[3]
        mode = data[4]
        self.server.daemon.AddPerfData(test_key, test_duration, arch, mode)

      elif action == constants.UPDATE_PERF:
        address = data[1]
        perf = data[2]
        self.server.daemon.UpdatePeerPerformance(data[1], data[2])

      rec.Advance()
    compression.Send(constants.END_OF_STREAM, self.request)

  def _GetStatusMessage(self):
    sio = StringIO.StringIO()
    sio.write("Peers:\n")
    with self.server.daemon.peer_list_lock:
      for p in self.server.daemon.peers:
        sio.write("%s\n" % p)
    sio.write("My own jobs: %d, relative performance: %.2f\n" %
              (self.server.daemon.jobs, self.server.daemon.relative_perf))
    # Low-priority TODO: Return more information. Ideas:
    #   - currently running anything,
    #   - time since last job,
    #   - time since last repository fetch
    #   - number of workpackets/testcases handled since startup
    #   - slowest test(s)
    result = sio.getvalue()
    sio.close()
    return result


class LocalSocketServer(SocketServer.ThreadingMixIn, SocketServer.TCPServer):
  def __init__(self, daemon):
    SocketServer.TCPServer.__init__(self, ("localhost", constants.CLIENT_PORT),
                                    LocalHandler)
    self.daemon = daemon
node-v4.8.2/deps/v8/tools/testrunner/server/main.py000644 000766 000024 00000021400 13070706735 022422 0ustar00iojsstaff000000 000000 # Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


import multiprocessing
import os
import shutil
import subprocess
import threading
import time

from . import daemon
from . import local_handler
from . import presence_handler
from . import signatures
from . import status_handler
from . import work_handler
from ..network import perfdata


class Server(daemon.Daemon):

  def __init__(self, pidfile, root, stdin="/dev/null",
               stdout="/dev/null", stderr="/dev/null"):
    super(Server, self).__init__(pidfile, stdin, stdout, stderr)
    self.root = root
    self.local_handler = None
    self.local_handler_thread = None
    self.work_handler = None
    self.work_handler_thread = None
    self.status_handler = None
    self.status_handler_thread = None
    self.presence_daemon = None
    self.presence_daemon_thread = None
    self.peers = []
    self.jobs = multiprocessing.cpu_count()
    self.peer_list_lock = threading.Lock()
    self.perf_data_lock = None
    self.presence_daemon_lock = None
    self.datadir = os.path.join(self.root, "data")
    pubkey_fingerprint_filename = os.path.join(self.datadir, "mypubkey")
    with open(pubkey_fingerprint_filename) as f:
      self.pubkey_fingerprint = f.read().strip()
    self.relative_perf_filename = os.path.join(self.datadir, "myperf")
    if os.path.exists(self.relative_perf_filename):
      with open(self.relative_perf_filename) as f:
        try:
          self.relative_perf = float(f.read())
        except:
          self.relative_perf = 1.0
    else:
      self.relative_perf = 1.0

  def run(self):
    os.nice(20)
    self.ip = presence_handler.GetOwnIP()
    self.perf_data_manager = perfdata.PerfDataManager(self.datadir)
    self.perf_data_lock = threading.Lock()

    self.local_handler = local_handler.LocalSocketServer(self)
    self.local_handler_thread = threading.Thread(
        target=self.local_handler.serve_forever)
    self.local_handler_thread.start()

    self.work_handler = work_handler.WorkSocketServer(self)
    self.work_handler_thread = threading.Thread(
        target=self.work_handler.serve_forever)
    self.work_handler_thread.start()

    self.status_handler = status_handler.StatusSocketServer(self)
    self.status_handler_thread = threading.Thread(
        target=self.status_handler.serve_forever)
    self.status_handler_thread.start()

    self.presence_daemon = presence_handler.PresenceDaemon(self)
    self.presence_daemon_thread = threading.Thread(
        target=self.presence_daemon.serve_forever)
    self.presence_daemon_thread.start()

    self.presence_daemon.FindPeers()
    time.sleep(0.5)  # Give those peers some time to reply.

    with self.peer_list_lock:
      for p in self.peers:
        if p.address == self.ip: continue
        status_handler.RequestTrustedPubkeys(p, self)

    while True:
      try:
        self.PeriodicTasks()
        time.sleep(60)
      except Exception, e:
        print("MAIN LOOP EXCEPTION: %s" % e)
        self.Shutdown()
        break
      except KeyboardInterrupt:
        self.Shutdown()
        break

  def Shutdown(self):
    with open(self.relative_perf_filename, "w") as f:
      f.write("%s" % self.relative_perf)
    self.presence_daemon.shutdown()
    self.presence_daemon.server_close()
    self.local_handler.shutdown()
    self.local_handler.server_close()
    self.work_handler.shutdown()
    self.work_handler.server_close()
    self.status_handler.shutdown()
    self.status_handler.server_close()

  def PeriodicTasks(self):
    # If we know peers we don't trust, see if someone else trusts them.
    with self.peer_list_lock:
      for p in self.peers:
        if p.trusted: continue
        if self.IsTrusted(p.pubkey):
          p.trusted = True
          status_handler.ITrustYouNow(p)
          continue
        for p2 in self.peers:
          if not p2.trusted: continue
          status_handler.TryTransitiveTrust(p2, p.pubkey, self)
    # TODO: Ping for more peers waiting to be discovered.
    # TODO: Update the checkout (if currently idle).

  def AddPeer(self, peer):
    with self.peer_list_lock:
      for p in self.peers:
        if p.address == peer.address:
          return
      self.peers.append(peer)
    if peer.trusted:
      status_handler.ITrustYouNow(peer)

  def DeletePeer(self, peer_address):
    with self.peer_list_lock:
      for i in xrange(len(self.peers)):
        if self.peers[i].address == peer_address:
          del self.peers[i]
          return

  def MarkPeerAsTrusting(self, peer_address):
    with self.peer_list_lock:
      for p in self.peers:
        if p.address == peer_address:
          p.trusting_me = True
          break

  def UpdatePeerPerformance(self, peer_address, performance):
    with self.peer_list_lock:
      for p in self.peers:
        if p.address == peer_address:
          p.relative_performance = performance

  def CopyToTrusted(self, pubkey_filename):
    with open(pubkey_filename, "r") as f:
      lines = f.readlines()
      fingerprint = lines[-1].strip()
    target_filename = self._PubkeyFilename(fingerprint)
    shutil.copy(pubkey_filename, target_filename)
    with self.peer_list_lock:
      for peer in self.peers:
        if peer.address == self.ip: continue
        if peer.pubkey == fingerprint:
          status_handler.ITrustYouNow(peer)
        else:
          result = self.SignTrusted(fingerprint)
          status_handler.NotifyNewTrusted(peer, result)
    return fingerprint

  def _PubkeyFilename(self, pubkey_fingerprint):
    return os.path.join(self.root, "trusted", "%s.pem" % pubkey_fingerprint)

  def IsTrusted(self, pubkey_fingerprint):
    return os.path.exists(self._PubkeyFilename(pubkey_fingerprint))

  def ListTrusted(self):
    path = os.path.join(self.root, "trusted")
    if not os.path.exists(path): return []
    return [ f[:-4] for f in os.listdir(path) if f.endswith(".pem") ]

  def SignTrusted(self, pubkey_fingerprint):
    if not self.IsTrusted(pubkey_fingerprint):
      return []
    filename = self._PubkeyFilename(pubkey_fingerprint)
    result = signatures.ReadFileAndSignature(filename)  # Format: [key, sig].
    return [pubkey_fingerprint, result[0], result[1], self.pubkey_fingerprint]

  def AcceptNewTrusted(self, data):
    # The format of |data| matches the return value of |SignTrusted()|.
    if not data: return
    fingerprint = data[0]
    pubkey = data[1]
    signature = data[2]
    signer = data[3]
    if not self.IsTrusted(signer):
      return
    if self.IsTrusted(fingerprint):
      return  # Already trust this guy.
    filename = self._PubkeyFilename(fingerprint)
    signer_pubkeyfile = self._PubkeyFilename(signer)
    if not signatures.VerifySignature(filename, pubkey, signature,
                                      signer_pubkeyfile):
      return
    return  # Nothing more to do.

  def AddPerfData(self, test_key, duration, arch, mode):
    data_store = self.perf_data_manager.GetStore(arch, mode)
    data_store.RawUpdatePerfData(str(test_key), duration)

  def CompareOwnPerf(self, test, arch, mode):
    data_store = self.perf_data_manager.GetStore(arch, mode)
    observed = data_store.FetchPerfData(test)
    if not observed: return
    own_perf_estimate = observed / test.duration
    with self.perf_data_lock:
      kLearnRateLimiter = 9999
      self.relative_perf *= kLearnRateLimiter
      self.relative_perf += own_perf_estimate
      self.relative_perf /= (kLearnRateLimiter + 1)
node-v4.8.2/deps/v8/tools/testrunner/server/presence_handler.py000644 000766 000024 00000010533 13070706735 025004 0ustar00iojsstaff000000 000000 # Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


import socket
import SocketServer
import threading
try:
  import ujson as json
except:
  import json

from . import constants
from ..objects import peer


STARTUP_REQUEST = "V8 test peer starting up"
STARTUP_RESPONSE = "Let's rock some tests!"
EXIT_REQUEST = "V8 testing peer going down"


def GetOwnIP():
  s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
  s.connect(("8.8.8.8", 80))
  ip = s.getsockname()[0]
  s.close()
  return ip


class PresenceHandler(SocketServer.BaseRequestHandler):

  def handle(self):
    data = json.loads(self.request[0].strip())

    if data[0] == STARTUP_REQUEST:
      jobs = data[1]
      relative_perf = data[2]
      pubkey_fingerprint = data[3]
      trusted = self.server.daemon.IsTrusted(pubkey_fingerprint)
      response = [STARTUP_RESPONSE, self.server.daemon.jobs,
                  self.server.daemon.relative_perf,
                  self.server.daemon.pubkey_fingerprint, trusted]
      response = json.dumps(response)
      self.server.SendTo(self.client_address[0], response)
      p = peer.Peer(self.client_address[0], jobs, relative_perf,
                    pubkey_fingerprint)
      p.trusted = trusted
      self.server.daemon.AddPeer(p)

    elif data[0] == STARTUP_RESPONSE:
      jobs = data[1]
      perf = data[2]
      pubkey_fingerprint = data[3]
      p = peer.Peer(self.client_address[0], jobs, perf, pubkey_fingerprint)
      p.trusted = self.server.daemon.IsTrusted(pubkey_fingerprint)
      p.trusting_me = data[4]
      self.server.daemon.AddPeer(p)

    elif data[0] == EXIT_REQUEST:
      self.server.daemon.DeletePeer(self.client_address[0])
      if self.client_address[0] == self.server.daemon.ip:
        self.server.shutdown_lock.release()


class PresenceDaemon(SocketServer.ThreadingMixIn, SocketServer.UDPServer):
  def __init__(self, daemon):
    self.daemon = daemon
    address = (daemon.ip, constants.PRESENCE_PORT)
    SocketServer.UDPServer.__init__(self, address, PresenceHandler)
    self.shutdown_lock = threading.Lock()

  def shutdown(self):
    self.shutdown_lock.acquire()
    self.SendToAll(json.dumps([EXIT_REQUEST]))
    self.shutdown_lock.acquire()
    self.shutdown_lock.release()
    SocketServer.UDPServer.shutdown(self)

  def SendTo(self, target, message):
    sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
    sock.sendto(message, (target, constants.PRESENCE_PORT))
    sock.close()

  def SendToAll(self, message):
    sock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
    ip = self.daemon.ip.split(".")
    for i in range(1, 254):
      ip[-1] = str(i)
      sock.sendto(message, (".".join(ip), constants.PRESENCE_PORT))
    sock.close()

  def FindPeers(self):
    request = [STARTUP_REQUEST, self.daemon.jobs, self.daemon.relative_perf,
               self.daemon.pubkey_fingerprint]
    request = json.dumps(request)
    self.SendToAll(request)
node-v4.8.2/deps/v8/tools/testrunner/server/signatures.py000644 000766 000024 00000005400 13070706735 023664 0ustar00iojsstaff000000 000000 # Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


import base64
import os
import subprocess


def ReadFileAndSignature(filename):
  with open(filename, "rb") as f:
    file_contents = base64.b64encode(f.read())
  signature_file = filename + ".signature"
  if (not os.path.exists(signature_file) or
      os.path.getmtime(signature_file) < os.path.getmtime(filename)):
    private_key = "~/.ssh/v8_dtest"
    code = subprocess.call("openssl dgst -out %s -sign %s %s" %
                           (signature_file, private_key, filename),
                           shell=True)
    if code != 0: return [None, code]
  with open(signature_file) as f:
    signature = base64.b64encode(f.read())
  return [file_contents, signature]


def VerifySignature(filename, file_contents, signature, pubkeyfile):
  with open(filename, "wb") as f:
    f.write(base64.b64decode(file_contents))
  signature_file = filename + ".foreign_signature"
  with open(signature_file, "wb") as f:
    f.write(base64.b64decode(signature))
  code = subprocess.call("openssl dgst -verify %s -signature %s %s" %
                         (pubkeyfile, signature_file, filename),
                         shell=True)
  matched = (code == 0)
  if not matched:
    os.remove(signature_file)
    os.remove(filename)
  return matched
node-v4.8.2/deps/v8/tools/testrunner/server/status_handler.py000644 000766 000024 00000010072 13070706735 024521 0ustar00iojsstaff000000 000000 # Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


import socket
import SocketServer

from . import compression
from . import constants


def _StatusQuery(peer, query):
  sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
  code = sock.connect_ex((peer.address, constants.STATUS_PORT))
  if code != 0:
    # TODO(jkummerow): disconnect (after 3 failures?)
    return
  compression.Send(query, sock)
  compression.Send(constants.END_OF_STREAM, sock)
  rec = compression.Receiver(sock)
  data = None
  while not rec.IsDone():
    data = rec.Current()
    assert data[0] == query[0]
    data = data[1]
    rec.Advance()
  sock.close()
  return data


def RequestTrustedPubkeys(peer, server):
  pubkey_list = _StatusQuery(peer, [constants.LIST_TRUSTED_PUBKEYS])
  for pubkey in pubkey_list:
    if server.IsTrusted(pubkey): continue
    result = _StatusQuery(peer, [constants.GET_SIGNED_PUBKEY, pubkey])
    server.AcceptNewTrusted(result)


def NotifyNewTrusted(peer, data):
  _StatusQuery(peer, [constants.NOTIFY_NEW_TRUSTED] + data)


def ITrustYouNow(peer):
  _StatusQuery(peer, [constants.TRUST_YOU_NOW])


def TryTransitiveTrust(peer, pubkey, server):
  if _StatusQuery(peer, [constants.DO_YOU_TRUST, pubkey]):
    result = _StatusQuery(peer, [constants.GET_SIGNED_PUBKEY, pubkey])
    server.AcceptNewTrusted(result)


class StatusHandler(SocketServer.BaseRequestHandler):
  def handle(self):
    rec = compression.Receiver(self.request)
    while not rec.IsDone():
      data = rec.Current()
      action = data[0]

      if action == constants.LIST_TRUSTED_PUBKEYS:
        response = self.server.daemon.ListTrusted()
        compression.Send([action, response], self.request)

      elif action == constants.GET_SIGNED_PUBKEY:
        response = self.server.daemon.SignTrusted(data[1])
        compression.Send([action, response], self.request)

      elif action == constants.NOTIFY_NEW_TRUSTED:
        self.server.daemon.AcceptNewTrusted(data[1:])
        pass  # No response.

      elif action == constants.TRUST_YOU_NOW:
        self.server.daemon.MarkPeerAsTrusting(self.client_address[0])
        pass  # No response.

      elif action == constants.DO_YOU_TRUST:
        response = self.server.daemon.IsTrusted(data[1])
        compression.Send([action, response], self.request)

      rec.Advance()
    compression.Send(constants.END_OF_STREAM, self.request)


class StatusSocketServer(SocketServer.ThreadingMixIn, SocketServer.TCPServer):
  def __init__(self, daemon):
    address = (daemon.ip, constants.STATUS_PORT)
    SocketServer.TCPServer.__init__(self, address, StatusHandler)
    self.daemon = daemon
node-v4.8.2/deps/v8/tools/testrunner/server/work_handler.py000644 000766 000024 00000012701 13070706735 024161 0ustar00iojsstaff000000 000000 # Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


import os
import SocketServer
import stat
import subprocess
import threading

from . import compression
from . import constants
from . import signatures
from ..network import endpoint
from ..objects import workpacket


class WorkHandler(SocketServer.BaseRequestHandler):

  def handle(self):
    rec = compression.Receiver(self.request)
    while not rec.IsDone():
      data = rec.Current()
      with self.server.job_lock:
        self._WorkOnWorkPacket(data)
      rec.Advance()

  def _WorkOnWorkPacket(self, data):
    server_root = self.server.daemon.root
    v8_root = os.path.join(server_root, "v8")
    os.chdir(v8_root)
    packet = workpacket.WorkPacket.Unpack(data)
    self.ctx = packet.context
    self.ctx.shell_dir = os.path.join("out",
                                      "%s.%s" % (self.ctx.arch, self.ctx.mode))
    if not os.path.isdir(self.ctx.shell_dir):
      os.makedirs(self.ctx.shell_dir)
    for binary in packet.binaries:
      if not self._UnpackBinary(binary, packet.pubkey_fingerprint):
        return

    if not self._CheckoutRevision(packet.base_revision):
      return

    if not self._ApplyPatch(packet.patch):
      return

    tests = packet.tests
    endpoint.Execute(v8_root, self.ctx, tests, self.request, self.server.daemon)
    self._SendResponse()

  def _SendResponse(self, error_message=None):
    try:
      if error_message:
        compression.Send([[-1, error_message]], self.request)
      compression.Send(constants.END_OF_STREAM, self.request)
      return
    except Exception, e:
      pass  # Peer is gone. There's nothing we can do.
    # Clean up.
    self._Call("git checkout -f")
    self._Call("git clean -f -d")
    self._Call("rm -rf %s" % self.ctx.shell_dir)

  def _UnpackBinary(self, binary, pubkey_fingerprint):
    binary_name = binary["name"]
    if binary_name == "libv8.so":
      libdir = os.path.join(self.ctx.shell_dir, "lib.target")
      if not os.path.exists(libdir): os.makedirs(libdir)
      target = os.path.join(libdir, binary_name)
    else:
      target = os.path.join(self.ctx.shell_dir, binary_name)
    pubkeyfile = "../trusted/%s.pem" % pubkey_fingerprint
    if not signatures.VerifySignature(target, binary["blob"],
                                      binary["sign"], pubkeyfile):
      self._SendResponse("Signature verification failed")
      return False
    os.chmod(target, stat.S_IRWXU)
    return True

  def _CheckoutRevision(self, base_svn_revision):
    get_hash_cmd = (
        "git log -1 --format=%%H --remotes --grep='^git-svn-id:.*@%s'" %
        base_svn_revision)
    try:
      base_revision = subprocess.check_output(get_hash_cmd, shell=True)
      if not base_revision: raise ValueError
    except:
      self._Call("git fetch")
      try:
        base_revision = subprocess.check_output(get_hash_cmd, shell=True)
        if not base_revision: raise ValueError
      except:
        self._SendResponse("Base revision not found.")
        return False
    code = self._Call("git checkout -f %s" % base_revision)
    if code != 0:
      self._SendResponse("Error trying to check out base revision.")
      return False
    code = self._Call("git clean -f -d")
    if code != 0:
      self._SendResponse("Failed to reset checkout")
      return False
    return True

  def _ApplyPatch(self, patch):
    if not patch: return True  # Just skip if the patch is empty.
    patchfilename = "_dtest_incoming_patch.patch"
    with open(patchfilename, "w") as f:
      f.write(patch)
    code = self._Call("git apply %s" % patchfilename)
    if code != 0:
      self._SendResponse("Error applying patch.")
      return False
    return True

  def _Call(self, cmd):
    return subprocess.call(cmd, shell=True)


class WorkSocketServer(SocketServer.ThreadingMixIn, SocketServer.TCPServer):
  def __init__(self, daemon):
    address = (daemon.ip, constants.PEER_PORT)
    SocketServer.TCPServer.__init__(self, address, WorkHandler)
    self.job_lock = threading.Lock()
    self.daemon = daemon
node-v4.8.2/deps/v8/tools/testrunner/objects/__init__.py000644 000766 000024 00000003043 13070706735 023363 0ustar00iojsstaff000000 000000 # Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
node-v4.8.2/deps/v8/tools/testrunner/objects/context.py000644 000766 000024 00000005726 13070706735 023322 0ustar00iojsstaff000000 000000 # Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


class Context():
  def __init__(self, arch, mode, shell_dir, mode_flags, verbose, timeout,
               isolates, command_prefix, extra_flags, noi18n, random_seed,
               no_sorting, rerun_failures_count, rerun_failures_max,
               predictable, no_harness):
    self.arch = arch
    self.mode = mode
    self.shell_dir = shell_dir
    self.mode_flags = mode_flags
    self.verbose = verbose
    self.timeout = timeout
    self.isolates = isolates
    self.command_prefix = command_prefix
    self.extra_flags = extra_flags
    self.noi18n = noi18n
    self.random_seed = random_seed
    self.no_sorting = no_sorting
    self.rerun_failures_count = rerun_failures_count
    self.rerun_failures_max = rerun_failures_max
    self.predictable = predictable
    self.no_harness = no_harness

  def Pack(self):
    return [self.arch, self.mode, self.mode_flags, self.timeout, self.isolates,
            self.command_prefix, self.extra_flags, self.noi18n,
            self.random_seed, self.no_sorting, self.rerun_failures_count,
            self.rerun_failures_max, self.predictable, self.no_harness]

  @staticmethod
  def Unpack(packed):
    # For the order of the fields, refer to Pack() above.
    return Context(packed[0], packed[1], None, packed[2], False,
                   packed[3], packed[4], packed[5], packed[6], packed[7],
                   packed[8], packed[9], packed[10], packed[11], packed[12],
                   packed[13])
node-v4.8.2/deps/v8/tools/testrunner/objects/output.py000644 000766 000024 00000004613 13070706735 023170 0ustar00iojsstaff000000 000000 # Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


import signal

from ..local import utils

class Output(object):

  def __init__(self, exit_code, timed_out, stdout, stderr):
    self.exit_code = exit_code
    self.timed_out = timed_out
    self.stdout = stdout
    self.stderr = stderr

  def HasCrashed(self):
    if utils.IsWindows():
      return 0x80000000 & self.exit_code and not (0x3FFFFF00 & self.exit_code)
    else:
      # Timed out tests will have exit_code -signal.SIGTERM.
      if self.timed_out:
        return False
      return (self.exit_code < 0 and
              self.exit_code != -signal.SIGABRT)

  def HasTimedOut(self):
    return self.timed_out

  def Pack(self):
    return [self.exit_code, self.timed_out, self.stdout, self.stderr]

  @staticmethod
  def Unpack(packed):
    # For the order of the fields, refer to Pack() above.
    return Output(packed[0], packed[1], packed[2], packed[3])
node-v4.8.2/deps/v8/tools/testrunner/objects/peer.py000644 000766 000024 00000006751 13070706735 022570 0ustar00iojsstaff000000 000000 # Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


class Peer(object):
  def __init__(self, address, jobs, rel_perf, pubkey):
    self.address = address  # string: IP address
    self.jobs = jobs  # integer: number of CPUs
    self.relative_performance = rel_perf
    self.pubkey = pubkey # string: pubkey's fingerprint
    self.shells = set()  # set of strings
    self.needed_work = 0
    self.assigned_work = 0
    self.tests = []  # list of TestCase objects
    self.trusting_me = False  # This peer trusts my public key.
    self.trusted = False  # I trust this peer's public key.

  def __str__(self):
    return ("Peer at %s, jobs: %d, performance: %.2f, trust I/O: %s/%s" %
            (self.address, self.jobs, self.relative_performance,
             self.trusting_me, self.trusted))

  def AddTests(self, shell):
    """Adds tests from |shell| to this peer.

    Stops when self.needed_work reaches zero, or when all of shell's tests
    are assigned."""
    assert self.needed_work > 0
    if shell.shell not in self.shells:
      self.shells.add(shell.shell)
    while len(shell.tests) > 0 and self.needed_work > 0:
      t = shell.tests.pop()
      self.needed_work -= t.duration
      self.assigned_work += t.duration
      shell.total_duration -= t.duration
      self.tests.append(t)

  def ForceAddOneTest(self, test, shell):
    """Forcibly adds another test to this peer, disregarding needed_work."""
    if shell.shell not in self.shells:
      self.shells.add(shell.shell)
    self.needed_work -= test.duration
    self.assigned_work += test.duration
    shell.total_duration -= test.duration
    self.tests.append(test)


  def Pack(self):
    """Creates a JSON serializable representation of this Peer."""
    return [self.address, self.jobs, self.relative_performance]

  @staticmethod
  def Unpack(packed):
    """Creates a Peer object built from a packed representation."""
    pubkey_dummy = ""  # Callers of this don't care (only the server does).
    return Peer(packed[0], packed[1], packed[2], pubkey_dummy)
node-v4.8.2/deps/v8/tools/testrunner/objects/testcase.py000644 000766 000024 00000007023 13070706735 023441 0ustar00iojsstaff000000 000000 # Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


from . import output

class TestCase(object):
  def __init__(self, suite, path, flags=None, dependency=None):
    self.suite = suite        # TestSuite object
    self.path = path          # string, e.g. 'div-mod', 'test-api/foo'
    self.flags = flags or []  # list of strings, flags specific to this test
    self.dependency = dependency  # |path| for testcase that must be run first
    self.outcomes = set([])
    self.output = None
    self.id = None  # int, used to map result back to TestCase instance
    self.duration = None  # assigned during execution
    self.run = 1  # The nth time this test is executed.

  def CopyAddingFlags(self, flags):
    copy = TestCase(self.suite, self.path, self.flags + flags, self.dependency)
    copy.outcomes = self.outcomes
    return copy

  def PackTask(self):
    """
    Extracts those parts of this object that are required to run the test
    and returns them as a JSON serializable object.
    """
    assert self.id is not None
    return [self.suitename(), self.path, self.flags,
            self.dependency, list(self.outcomes or []), self.id]

  @staticmethod
  def UnpackTask(task):
    """Creates a new TestCase object based on packed task data."""
    # For the order of the fields, refer to PackTask() above.
    test = TestCase(str(task[0]), task[1], task[2], task[3])
    test.outcomes = set(task[4])
    test.id = task[5]
    test.run = 1
    return test

  def SetSuiteObject(self, suites):
    self.suite = suites[self.suite]

  def PackResult(self):
    """Serializes the output of the TestCase after it has run."""
    self.suite.StripOutputForTransmit(self)
    return [self.id, self.output.Pack(), self.duration]

  def MergeResult(self, result):
    """Applies the contents of a Result to this object."""
    assert result[0] == self.id
    self.output = output.Output.Unpack(result[1])
    self.duration = result[2]

  def suitename(self):
    return self.suite.name

  def GetLabel(self):
    return self.suitename() + "/" + self.suite.CommonTestName(self)
node-v4.8.2/deps/v8/tools/testrunner/objects/workpacket.py000644 000766 000024 00000006760 13070706735 024007 0ustar00iojsstaff000000 000000 # Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


from . import context
from . import testcase

class WorkPacket(object):
  def __init__(self, peer=None, context=None, tests=None, binaries=None,
               base_revision=None, patch=None, pubkey=None):
    self.peer = peer
    self.context = context
    self.tests = tests
    self.binaries = binaries
    self.base_revision = base_revision
    self.patch = patch
    self.pubkey_fingerprint = pubkey

  def Pack(self, binaries_dict):
    """
    Creates a JSON serializable object containing the data of this
    work packet.
    """
    need_libv8 = False
    binaries = []
    for shell in self.peer.shells:
      prefetched_binary = binaries_dict[shell]
      binaries.append({"name": shell,
                       "blob": prefetched_binary[0],
                       "sign": prefetched_binary[1]})
      if prefetched_binary[2]:
        need_libv8 = True
    if need_libv8:
      libv8 = binaries_dict["libv8.so"]
      binaries.append({"name": "libv8.so",
                       "blob": libv8[0],
                       "sign": libv8[1]})
    tests = []
    test_map = {}
    for t in self.peer.tests:
      test_map[t.id] = t
      tests.append(t.PackTask())
    result = {
      "binaries": binaries,
      "pubkey": self.pubkey_fingerprint,
      "context": self.context.Pack(),
      "base_revision": self.base_revision,
      "patch": self.patch,
      "tests": tests
    }
    return result, test_map

  @staticmethod
  def Unpack(packed):
    """
    Creates a WorkPacket object from the given packed representation.
    """
    binaries = packed["binaries"]
    pubkey_fingerprint = packed["pubkey"]
    ctx = context.Context.Unpack(packed["context"])
    base_revision = packed["base_revision"]
    patch = packed["patch"]
    tests = [ testcase.TestCase.UnpackTask(t) for t in packed["tests"] ]
    return WorkPacket(context=ctx, tests=tests, binaries=binaries,
                      base_revision=base_revision, patch=patch,
                      pubkey=pubkey_fingerprint)
node-v4.8.2/deps/v8/tools/testrunner/network/__init__.py000644 000766 000024 00000003043 13070706735 023423 0ustar00iojsstaff000000 000000 # Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
node-v4.8.2/deps/v8/tools/testrunner/network/distro.py000644 000766 000024 00000007313 13070706735 023174 0ustar00iojsstaff000000 000000 # Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


class Shell(object):
  def __init__(self, shell):
    self.shell = shell
    self.tests = []
    self.total_duration = 0.0

  def AddSuite(self, suite):
    self.tests += suite.tests
    self.total_duration += suite.total_duration

  def SortTests(self):
    self.tests.sort(cmp=lambda x, y: cmp(x.duration, y.duration))


def Assign(suites, peers):
  total_work = 0.0
  for s in suites:
    total_work += s.CalculateTotalDuration()

  total_power = 0.0
  for p in peers:
    p.assigned_work = 0.0
    total_power += p.jobs * p.relative_performance
  for p in peers:
    p.needed_work = total_work * p.jobs * p.relative_performance / total_power

  shells = {}
  for s in suites:
    shell = s.shell()
    if not shell in shells:
      shells[shell] = Shell(shell)
    shells[shell].AddSuite(s)
  # Convert |shells| to list and sort it, shortest total_duration first.
  shells = [ shells[s] for s in shells ]
  shells.sort(cmp=lambda x, y: cmp(x.total_duration, y.total_duration))
  # Sort tests within each shell, longest duration last (so it's
  # pop()'ed first).
  for s in shells: s.SortTests()
  # Sort peers, least needed_work first.
  peers.sort(cmp=lambda x, y: cmp(x.needed_work, y.needed_work))
  index = 0
  for shell in shells:
    while len(shell.tests) > 0:
      while peers[index].needed_work <= 0:
        index += 1
        if index == len(peers):
          print("BIG FAT WARNING: Assigning tests to peers failed. "
                "Remaining tests: %d. Going to slow mode." % len(shell.tests))
          # Pick the least-busy peer. Sorting the list for each test
          # is terribly slow, but this is just an emergency fallback anyway.
          peers.sort(cmp=lambda x, y: cmp(x.needed_work, y.needed_work))
          peers[0].ForceAddOneTest(shell.tests.pop(), shell)
      # If the peer already has a shell assigned and would need this one
      # and then yet another, try to avoid it.
      peer = peers[index]
      if (shell.total_duration < peer.needed_work and
          len(peer.shells) > 0 and
          index < len(peers) - 1 and
          shell.total_duration <= peers[index + 1].needed_work):
        peers[index + 1].AddTests(shell)
      else:
        peer.AddTests(shell)
node-v4.8.2/deps/v8/tools/testrunner/network/endpoint.py000644 000766 000024 00000010624 13070706735 023507 0ustar00iojsstaff000000 000000 # Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


import multiprocessing
import os
import Queue
import threading
import time

from ..local import execution
from ..local import progress
from ..local import testsuite
from ..local import utils
from ..server import compression


class EndpointProgress(progress.ProgressIndicator):
  def __init__(self, sock, server, ctx):
    super(EndpointProgress, self).__init__()
    self.sock = sock
    self.server = server
    self.context = ctx
    self.results_queue = []  # Accessors must synchronize themselves.
    self.sender_lock = threading.Lock()
    self.senderthread = threading.Thread(target=self._SenderThread)
    self.senderthread.start()

  def HasRun(self, test, has_unexpected_output):
    # The runners that call this have a lock anyway, so this is safe.
    self.results_queue.append(test)

  def _SenderThread(self):
    keep_running = True
    tests = []
    self.sender_lock.acquire()
    while keep_running:
      time.sleep(0.1)
      # This should be "atomic enough" without locking :-)
      # (We don't care which list any new elements get appended to, as long
      # as we don't lose any and the last one comes last.)
      current = self.results_queue
      self.results_queue = []
      for c in current:
        if c is None:
          keep_running = False
        else:
          tests.append(c)
      if keep_running and len(tests) < 1:
        continue  # Wait for more results.
      if len(tests) < 1: break  # We're done here.
      result = []
      for t in tests:
        result.append(t.PackResult())
      try:
        compression.Send(result, self.sock)
      except:
        self.runner.terminate = True
      for t in tests:
        self.server.CompareOwnPerf(t, self.context.arch, self.context.mode)
      tests = []
    self.sender_lock.release()


def Execute(workspace, ctx, tests, sock, server):
  suite_paths = utils.GetSuitePaths(os.path.join(workspace, "test"))
  suites = []
  for root in suite_paths:
    suite = testsuite.TestSuite.LoadTestSuite(
        os.path.join(workspace, "test", root))
    if suite:
      suites.append(suite)

  suites_dict = {}
  for s in suites:
    suites_dict[s.name] = s
    s.tests = []
  for t in tests:
    suite = suites_dict[t.suite]
    t.suite = suite
    suite.tests.append(t)

  suites = [ s for s in suites if len(s.tests) > 0 ]
  for s in suites:
    s.DownloadData()

  progress_indicator = EndpointProgress(sock, server, ctx)
  runner = execution.Runner(suites, progress_indicator, ctx)
  try:
    runner.Run(server.jobs)
  except IOError, e:
    if e.errno == 2:
      message = ("File not found: %s, maybe you forgot to 'git add' it?" %
                 e.filename)
    else:
      message = "%s" % e
    compression.Send([[-1, message]], sock)
  progress_indicator.HasRun(None, None)  # Sentinel to signal the end.
  progress_indicator.sender_lock.acquire()  # Released when sending is done.
  progress_indicator.sender_lock.release()
node-v4.8.2/deps/v8/tools/testrunner/network/network_execution.py000644 000766 000024 00000024207 13070706735 025445 0ustar00iojsstaff000000 000000 # Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


import os
import socket
import subprocess
import threading
import time

from . import distro
from ..local import execution
from ..local import perfdata
from ..objects import peer
from ..objects import workpacket
from ..server import compression
from ..server import constants
from ..server import local_handler
from ..server import signatures


def GetPeers():
  data = local_handler.LocalQuery([constants.REQUEST_PEERS])
  if not data: return []
  return [ peer.Peer.Unpack(p) for p in data ]


class NetworkedRunner(execution.Runner):
  def __init__(self, suites, progress_indicator, context, peers, workspace):
    self.suites = suites
    datapath = os.path.join("out", "testrunner_data")
    # TODO(machenbach): These fields should exist now in the superclass.
    # But there is no super constructor call. Check if this is a problem.
    self.perf_data_manager = perfdata.PerfDataManager(datapath)
    self.perfdata = self.perf_data_manager.GetStore(context.arch, context.mode)
    for s in suites:
      for t in s.tests:
        t.duration = self.perfdata.FetchPerfData(t) or 1.0
    self._CommonInit(suites, progress_indicator, context)
    self.tests = []  # Only used if we need to fall back to local execution.
    self.tests_lock = threading.Lock()
    self.peers = peers
    self.pubkey_fingerprint = None  # Fetched later.
    self.base_rev = subprocess.check_output(
        "cd %s; git log -1 --format=%%H --grep=git-svn-id" % workspace,
        shell=True).strip()
    self.base_svn_rev = subprocess.check_output(
        "cd %s; git log -1 %s"          # Get commit description.
        " | grep -e '^\s*git-svn-id:'"  # Extract "git-svn-id" line.
        " | awk '{print $2}'"           # Extract "repository@revision" part.
        " | sed -e 's/.*@//'" %         # Strip away "repository@".
        (workspace, self.base_rev), shell=True).strip()
    self.patch = subprocess.check_output(
        "cd %s; git diff %s" % (workspace, self.base_rev), shell=True)
    self.binaries = {}
    self.initialization_lock = threading.Lock()
    self.initialization_lock.acquire()  # Released when init is done.
    self._OpenLocalConnection()
    self.local_receiver_thread = threading.Thread(
        target=self._ListenLocalConnection)
    self.local_receiver_thread.daemon = True
    self.local_receiver_thread.start()
    self.initialization_lock.acquire()
    self.initialization_lock.release()

  def _OpenLocalConnection(self):
    self.local_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
    code = self.local_socket.connect_ex(("localhost", constants.CLIENT_PORT))
    if code != 0:
      raise RuntimeError("Failed to connect to local server")
    compression.Send([constants.REQUEST_PUBKEY_FINGERPRINT], self.local_socket)

  def _ListenLocalConnection(self):
    release_lock_countdown = 1  # Pubkey.
    self.local_receiver = compression.Receiver(self.local_socket)
    while not self.local_receiver.IsDone():
      data = self.local_receiver.Current()
      if data[0] == constants.REQUEST_PUBKEY_FINGERPRINT:
        pubkey = data[1]
        if not pubkey: raise RuntimeError("Received empty public key")
        self.pubkey_fingerprint = pubkey
        release_lock_countdown -= 1
      if release_lock_countdown == 0:
        self.initialization_lock.release()
        release_lock_countdown -= 1  # Prevent repeated triggering.
      self.local_receiver.Advance()

  def Run(self, jobs):
    self.indicator.Starting()
    need_libv8 = False
    for s in self.suites:
      shell = s.shell()
      if shell not in self.binaries:
        path = os.path.join(self.context.shell_dir, shell)
        # Check if this is a shared library build.
        try:
          ldd = subprocess.check_output("ldd %s | grep libv8\\.so" % (path),
                                        shell=True)
          ldd = ldd.strip().split(" ")
          assert ldd[0] == "libv8.so"
          assert ldd[1] == "=>"
          need_libv8 = True
          binary_needs_libv8 = True
          libv8 = signatures.ReadFileAndSignature(ldd[2])
        except:
          binary_needs_libv8 = False
        binary = signatures.ReadFileAndSignature(path)
        if binary[0] is None:
          print("Error: Failed to create signature.")
          assert binary[1] != 0
          return binary[1]
        binary.append(binary_needs_libv8)
        self.binaries[shell] = binary
    if need_libv8:
      self.binaries["libv8.so"] = libv8
    distro.Assign(self.suites, self.peers)
    # Spawn one thread for each peer.
    threads = []
    for p in self.peers:
      thread = threading.Thread(target=self._TalkToPeer, args=[p])
      threads.append(thread)
      thread.start()
    try:
      for thread in threads:
        # Use a timeout so that signals (Ctrl+C) will be processed.
        thread.join(timeout=10000000)
      self._AnalyzePeerRuntimes()
    except KeyboardInterrupt:
      self.terminate = True
      raise
    except Exception, _e:
      # If there's an exception we schedule an interruption for any
      # remaining threads...
      self.terminate = True
      # ...and then reraise the exception to bail out.
      raise
    compression.Send(constants.END_OF_STREAM, self.local_socket)
    self.local_socket.close()
    if self.tests:
      self._RunInternal(jobs)
    self.indicator.Done()
    return not self.failed

  def _TalkToPeer(self, peer):
    sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
    sock.settimeout(self.context.timeout + 10)
    code = sock.connect_ex((peer.address, constants.PEER_PORT))
    if code == 0:
      try:
        peer.runtime = None
        start_time = time.time()
        packet = workpacket.WorkPacket(peer=peer, context=self.context,
                                       base_revision=self.base_svn_rev,
                                       patch=self.patch,
                                       pubkey=self.pubkey_fingerprint)
        data, test_map = packet.Pack(self.binaries)
        compression.Send(data, sock)
        compression.Send(constants.END_OF_STREAM, sock)
        rec = compression.Receiver(sock)
        while not rec.IsDone() and not self.terminate:
          data_list = rec.Current()
          for data in data_list:
            test_id = data[0]
            if test_id < 0:
              # The peer is reporting an error.
              with self.lock:
                print("\nPeer %s reports error: %s" % (peer.address, data[1]))
              continue
            test = test_map.pop(test_id)
            test.MergeResult(data)
            try:
              self.perfdata.UpdatePerfData(test)
            except Exception, e:
              print("UpdatePerfData exception: %s" % e)
              pass  # Just keep working.
            with self.lock:
              perf_key = self.perfdata.GetKey(test)
              compression.Send(
                  [constants.INFORM_DURATION, perf_key, test.duration,
                   self.context.arch, self.context.mode],
                  self.local_socket)
              self.indicator.AboutToRun(test)
              has_unexpected_output = test.suite.HasUnexpectedOutput(test)
              if has_unexpected_output:
                self.failed.append(test)
                if test.output.HasCrashed():
                  self.crashed += 1
              else:
                self.succeeded += 1
              self.remaining -= 1
              self.indicator.HasRun(test, has_unexpected_output)
          rec.Advance()
        peer.runtime = time.time() - start_time
      except KeyboardInterrupt:
        sock.close()
        raise
      except Exception, e:
        print("Got exception: %s" % e)
        pass  # Fall back to local execution.
    else:
      compression.Send([constants.UNRESPONSIVE_PEER, peer.address],
                       self.local_socket)
    sock.close()
    if len(test_map) > 0:
      # Some tests have not received any results. Run them locally.
      print("\nNo results for %d tests, running them locally." % len(test_map))
      self._EnqueueLocally(test_map)

  def _EnqueueLocally(self, test_map):
    with self.tests_lock:
      for test in test_map:
        self.tests.append(test_map[test])

  def _AnalyzePeerRuntimes(self):
    total_runtime = 0.0
    total_work = 0.0
    for p in self.peers:
      if p.runtime is None:
        return
      total_runtime += p.runtime
      total_work += p.assigned_work
    for p in self.peers:
      p.assigned_work /= total_work
      p.runtime /= total_runtime
      perf_correction = p.assigned_work / p.runtime
      old_perf = p.relative_performance
      p.relative_performance = (old_perf + perf_correction) / 2.0
      compression.Send([constants.UPDATE_PERF, p.address,
                        p.relative_performance],
                       self.local_socket)
node-v4.8.2/deps/v8/tools/testrunner/local/__init__.py000644 000766 000024 00000003043 13070706735 023024 0ustar00iojsstaff000000 000000 # Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
node-v4.8.2/deps/v8/tools/testrunner/local/commands.py000644 000766 000024 00000010050 13070706735 023062 0ustar00iojsstaff000000 000000 # Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


import subprocess
import sys
from threading import Timer

from ..local import utils
from ..objects import output


SEM_INVALID_VALUE = -1
SEM_NOGPFAULTERRORBOX = 0x0002  # Microsoft Platform SDK WinBase.h


def Win32SetErrorMode(mode):
  prev_error_mode = SEM_INVALID_VALUE
  try:
    import ctypes
    prev_error_mode = \
        ctypes.windll.kernel32.SetErrorMode(mode)  #@UndefinedVariable
  except ImportError:
    pass
  return prev_error_mode


def RunProcess(verbose, timeout, args, **rest):
  if verbose: print "#", " ".join(args)
  popen_args = args
  prev_error_mode = SEM_INVALID_VALUE
  if utils.IsWindows():
    popen_args = subprocess.list2cmdline(args)
    # Try to change the error mode to avoid dialogs on fatal errors. Don't
    # touch any existing error mode flags by merging the existing error mode.
    # See http://blogs.msdn.com/oldnewthing/archive/2004/07/27/198410.aspx.
    error_mode = SEM_NOGPFAULTERRORBOX
    prev_error_mode = Win32SetErrorMode(error_mode)
    Win32SetErrorMode(error_mode | prev_error_mode)
  process = subprocess.Popen(
    args=popen_args,
    stdout=subprocess.PIPE,
    stderr=subprocess.PIPE,
    **rest
  )
  if (utils.IsWindows() and prev_error_mode != SEM_INVALID_VALUE):
    Win32SetErrorMode(prev_error_mode)

  def kill_process(process, timeout_result):
    timeout_result[0] = True
    try:
      if utils.IsWindows():
        if verbose:
          print "Attempting to kill process %d" % process.pid
          sys.stdout.flush()
        tk = subprocess.Popen(
            'taskkill /T /F /PID %d' % process.pid,
            stdout=subprocess.PIPE,
            stderr=subprocess.PIPE,
        )
        stdout, stderr = tk.communicate()
        if verbose:
          print "Taskkill results for %d" % process.pid
          print stdout
          print stderr
          print "Return code: %d" % tk.returncode
          sys.stdout.flush()
      else:
        process.kill()
    except OSError:
      sys.stderr.write('Error: Process %s already ended.\n' % process.pid)

  # Pseudo object to communicate with timer thread.
  timeout_result = [False]

  timer = Timer(timeout, kill_process, [process, timeout_result])
  timer.start()
  stdout, stderr = process.communicate()
  timer.cancel()
  return process.returncode, timeout_result[0], stdout, stderr


def Execute(args, verbose=False, timeout=None):
  args = [ c for c in args if c != "" ]
  exit_code, timed_out, stdout, stderr = RunProcess(
    verbose,
    timeout,
    args=args,
  )
  return output.Output(exit_code, timed_out, stdout, stderr)
node-v4.8.2/deps/v8/tools/testrunner/local/execution.py000644 000766 000024 00000025122 13070706735 023272 0ustar00iojsstaff000000 000000 # Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


import os
import shutil
import sys
import time

from pool import Pool
from . import commands
from . import perfdata
from . import statusfile
from . import utils


class Job(object):
  def __init__(self, command, dep_command, test_id, timeout, verbose):
    self.command = command
    self.dep_command = dep_command
    self.id = test_id
    self.timeout = timeout
    self.verbose = verbose


def RunTest(job):
  start_time = time.time()
  if job.dep_command is not None:
    dep_output = commands.Execute(job.dep_command, job.verbose, job.timeout)
    # TODO(jkummerow): We approximate the test suite specific function
    # IsFailureOutput() by just checking the exit code here. Currently
    # only cctests define dependencies, for which this simplification is
    # correct.
    if dep_output.exit_code != 0:
      return (job.id, dep_output, time.time() - start_time)
  output = commands.Execute(job.command, job.verbose, job.timeout)
  return (job.id, output, time.time() - start_time)

class Runner(object):

  def __init__(self, suites, progress_indicator, context):
    self.datapath = os.path.join("out", "testrunner_data")
    self.perf_data_manager = perfdata.PerfDataManager(self.datapath)
    self.perfdata = self.perf_data_manager.GetStore(context.arch, context.mode)
    self.perf_failures = False
    self.printed_allocations = False
    self.tests = [ t for s in suites for t in s.tests ]
    if not context.no_sorting:
      for t in self.tests:
        t.duration = self.perfdata.FetchPerfData(t) or 1.0
      self.tests.sort(key=lambda t: t.duration, reverse=True)
    self._CommonInit(suites, progress_indicator, context)

  def _CommonInit(self, suites, progress_indicator, context):
    self.total = 0
    for s in suites:
      for t in s.tests:
        t.id = self.total
        self.total += 1
    self.indicator = progress_indicator
    progress_indicator.SetRunner(self)
    self.context = context
    self.succeeded = 0
    self.remaining = self.total
    self.failed = []
    self.crashed = 0
    self.reran_tests = 0

  def _RunPerfSafe(self, fun):
    try:
      fun()
    except Exception, e:
      print("PerfData exception: %s" % e)
      self.perf_failures = True

  def _GetJob(self, test):
    command = self.GetCommand(test)
    timeout = self.context.timeout
    if ("--stress-opt" in test.flags or
        "--stress-opt" in self.context.mode_flags or
        "--stress-opt" in self.context.extra_flags):
      timeout *= 4
    # FIXME(machenbach): Make this more OO. Don't expose default outcomes or
    # the like.
    if statusfile.IsSlow(test.outcomes or [statusfile.PASS]):
      timeout *= 2
    if test.dependency is not None:
      dep_command = [ c.replace(test.path, test.dependency) for c in command ]
    else:
      dep_command = None
    return Job(command, dep_command, test.id, timeout, self.context.verbose)

  def _MaybeRerun(self, pool, test):
    if test.run <= self.context.rerun_failures_count:
      # Possibly rerun this test if its run count is below the maximum per
      # test. <= as the flag controls reruns not including the first run.
      if test.run == 1:
        # Count the overall number of reran tests on the first rerun.
        if self.reran_tests < self.context.rerun_failures_max:
          self.reran_tests += 1
        else:
          # Don't rerun this if the overall number of rerun tests has been
          # reached.
          return
      if test.run >= 2 and test.duration > self.context.timeout / 20.0:
        # Rerun slow tests at most once.
        return

      # Rerun this test.
      test.duration = None
      test.output = None
      test.run += 1
      pool.add([self._GetJob(test)])
      self.remaining += 1
      self.total += 1

  def _ProcessTestNormal(self, test, result, pool):
    self.indicator.AboutToRun(test)
    test.output = result[1]
    test.duration = result[2]
    has_unexpected_output = test.suite.HasUnexpectedOutput(test)
    if has_unexpected_output:
      self.failed.append(test)
      if test.output.HasCrashed():
        self.crashed += 1
    else:
      self.succeeded += 1
    self.remaining -= 1
    # For the indicator, everything that happens after the first run is treated
    # as unexpected even if it flakily passes in order to include it in the
    # output.
    self.indicator.HasRun(test, has_unexpected_output or test.run > 1)
    if has_unexpected_output:
      # Rerun test failures after the indicator has processed the results.
      self._VerbosePrint("Attempting to rerun test after failure.")
      self._MaybeRerun(pool, test)
    # Update the perf database if the test succeeded.
    return not has_unexpected_output

  def _ProcessTestPredictable(self, test, result, pool):
    def HasDifferentAllocations(output1, output2):
      def AllocationStr(stdout):
        for line in reversed((stdout or "").splitlines()):
          if line.startswith("### Allocations = "):
            self.printed_allocations = True
            return line
        return ""
      return (AllocationStr(output1.stdout) != AllocationStr(output2.stdout))

    # Always pass the test duration for the database update.
    test.duration = result[2]
    if test.run == 1 and result[1].HasTimedOut():
      # If we get a timeout in the first run, we are already in an
      # unpredictable state. Just report it as a failure and don't rerun.
      self.indicator.AboutToRun(test)
      test.output = result[1]
      self.remaining -= 1
      self.failed.append(test)
      self.indicator.HasRun(test, True)
    if test.run > 1 and HasDifferentAllocations(test.output, result[1]):
      # From the second run on, check for different allocations. If a
      # difference is found, call the indicator twice to report both tests.
      # All runs of each test are counted as one for the statistic.
      self.indicator.AboutToRun(test)
      self.remaining -= 1
      self.failed.append(test)
      self.indicator.HasRun(test, True)
      self.indicator.AboutToRun(test)
      test.output = result[1]
      self.indicator.HasRun(test, True)
    elif test.run >= 3:
      # No difference on the third run -> report a success.
      self.indicator.AboutToRun(test)
      self.remaining -= 1
      self.succeeded += 1
      test.output = result[1]
      self.indicator.HasRun(test, False)
    else:
      # No difference yet and less than three runs -> add another run and
      # remember the output for comparison.
      test.run += 1
      test.output = result[1]
      pool.add([self._GetJob(test)])
    # Always update the perf database.
    return True

  def Run(self, jobs):
    self.indicator.Starting()
    self._RunInternal(jobs)
    self.indicator.Done()
    if self.failed or self.remaining:
      return 1
    return 0

  def _RunInternal(self, jobs):
    pool = Pool(jobs)
    test_map = {}
    queued_exception = [None]
    def gen_tests():
      for test in self.tests:
        assert test.id >= 0
        test_map[test.id] = test
        try:
          yield [self._GetJob(test)]
        except Exception, e:
          # If this failed, save the exception and re-raise it later (after
          # all other tests have had a chance to run).
          queued_exception[0] = e
          continue
    try:
      it = pool.imap_unordered(RunTest, gen_tests())
      for result in it:
        if result.heartbeat:
          self.indicator.Heartbeat()
          continue
        test = test_map[result.value[0]]
        if self.context.predictable:
          update_perf = self._ProcessTestPredictable(test, result.value, pool)
        else:
          update_perf = self._ProcessTestNormal(test, result.value, pool)
        if update_perf:
          self._RunPerfSafe(lambda: self.perfdata.UpdatePerfData(test))
    finally:
      self._VerbosePrint("Closing process pool.")
      pool.terminate()
      self._VerbosePrint("Closing database connection.")
      self._RunPerfSafe(lambda: self.perf_data_manager.close())
      if self.perf_failures:
        # Nuke perf data in case of failures. This might not work on windows as
        # some files might still be open.
        print "Deleting perf test data due to db corruption."
        shutil.rmtree(self.datapath)
    if queued_exception[0]:
      raise queued_exception[0]

    # Make sure that any allocations were printed in predictable mode (if we
    # ran any tests).
    assert (
        not self.total or
        not self.context.predictable or
        self.printed_allocations
    )

  def _VerbosePrint(self, text):
    if self.context.verbose:
      print text
      sys.stdout.flush()

  def GetCommand(self, test):
    d8testflag = []
    shell = test.suite.shell()
    if shell == "d8":
      d8testflag = ["--test"]
    if utils.IsWindows():
      shell += ".exe"
    if self.context.random_seed:
      d8testflag += ["--random-seed=%s" % self.context.random_seed]
    cmd = (self.context.command_prefix +
           [os.path.abspath(os.path.join(self.context.shell_dir, shell))] +
           d8testflag +
           test.suite.GetFlagsForTestCase(test, self.context) +
           self.context.extra_flags)
    return cmd


class BreakNowException(Exception):
  def __init__(self, value):
    self.value = value
  def __str__(self):
    return repr(self.value)
node-v4.8.2/deps/v8/tools/testrunner/local/junit_output.py000644 000766 000024 00000004346 13070706735 024045 0ustar00iojsstaff000000 000000 # Copyright 2013 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


import xml.etree.ElementTree as xml


class JUnitTestOutput:
  def __init__(self, test_suite_name):
    self.root = xml.Element("testsuite")
    self.root.attrib["name"] = test_suite_name

  def HasRunTest(self, test_name, test_duration, test_failure):
    testCaseElement = xml.Element("testcase")
    testCaseElement.attrib["name"] = " ".join(test_name)
    testCaseElement.attrib["time"] = str(round(test_duration, 3))
    if len(test_failure):
      failureElement = xml.Element("failure")
      failureElement.text = test_failure
      testCaseElement.append(failureElement)
    self.root.append(testCaseElement)

  def FinishAndWrite(self, file):
    xml.ElementTree(self.root).write(file, "UTF-8")
node-v4.8.2/deps/v8/tools/testrunner/local/perfdata.py000644 000766 000024 00000010164 13070706735 023055 0ustar00iojsstaff000000 000000 # Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


import os
import shelve
import threading


class PerfDataEntry(object):
  def __init__(self):
    self.avg = 0.0
    self.count = 0

  def AddResult(self, result):
    kLearnRateLimiter = 99  # Greater value means slower learning.
    # We use an approximation of the average of the last 100 results here:
    # The existing average is weighted with kLearnRateLimiter (or less
    # if there are fewer data points).
    effective_count = min(self.count, kLearnRateLimiter)
    self.avg = self.avg * effective_count + result
    self.count = effective_count + 1
    self.avg /= self.count


class PerfDataStore(object):
  def __init__(self, datadir, arch, mode):
    filename = os.path.join(datadir, "%s.%s.perfdata" % (arch, mode))
    self.database = shelve.open(filename, protocol=2)
    self.closed = False
    self.lock = threading.Lock()

  def __del__(self):
    self.close()

  def close(self):
    if self.closed: return
    self.database.close()
    self.closed = True

  def GetKey(self, test):
    """Computes the key used to access data for the given testcase."""
    flags = "".join(test.flags)
    return str("%s.%s.%s" % (test.suitename(), test.path, flags))

  def FetchPerfData(self, test):
    """Returns the observed duration for |test| as read from the store."""
    key = self.GetKey(test)
    if key in self.database:
      return self.database[key].avg
    return None

  def UpdatePerfData(self, test):
    """Updates the persisted value in the store with test.duration."""
    testkey = self.GetKey(test)
    self.RawUpdatePerfData(testkey, test.duration)

  def RawUpdatePerfData(self, testkey, duration):
    with self.lock:
      if testkey in self.database:
        entry = self.database[testkey]
      else:
        entry = PerfDataEntry()
      entry.AddResult(duration)
      self.database[testkey] = entry


class PerfDataManager(object):
  def __init__(self, datadir):
    self.datadir = os.path.abspath(datadir)
    if not os.path.exists(self.datadir):
      os.makedirs(self.datadir)
    self.stores = {}  # Keyed by arch, then mode.
    self.closed = False
    self.lock = threading.Lock()

  def __del__(self):
    self.close()

  def close(self):
    if self.closed: return
    for arch in self.stores:
      modes = self.stores[arch]
      for mode in modes:
        store = modes[mode]
        store.close()
    self.closed = True

  def GetStore(self, arch, mode):
    with self.lock:
      if not arch in self.stores:
        self.stores[arch] = {}
      modes = self.stores[arch]
      if not mode in modes:
        modes[mode] = PerfDataStore(self.datadir, arch, mode)
      return modes[mode]
node-v4.8.2/deps/v8/tools/testrunner/local/pool.py000644 000766 000024 00000012355 13070706735 022244 0ustar00iojsstaff000000 000000 #!/usr/bin/env python
# Copyright 2014 the V8 project authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

from Queue import Empty
from multiprocessing import Event, Process, Queue

class NormalResult():
  def __init__(self, result):
    self.result = result
    self.exception = False
    self.break_now = False


class ExceptionResult():
  def __init__(self):
    self.exception = True
    self.break_now = False


class BreakResult():
  def __init__(self):
    self.exception = False
    self.break_now = True


class MaybeResult():
  def __init__(self, heartbeat, value):
    self.heartbeat = heartbeat
    self.value = value

  @staticmethod
  def create_heartbeat():
    return MaybeResult(True, None)

  @staticmethod
  def create_result(value):
    return MaybeResult(False, value)


def Worker(fn, work_queue, done_queue, done):
  """Worker to be run in a child process.
  The worker stops on two conditions. 1. When the poison pill "STOP" is
  reached or 2. when the event "done" is set."""
  try:
    for args in iter(work_queue.get, "STOP"):
      if done.is_set():
        break
      try:
        done_queue.put(NormalResult(fn(*args)))
      except Exception, e:
        print(">>> EXCEPTION: %s" % e)
        done_queue.put(ExceptionResult())
  except KeyboardInterrupt:
    done_queue.put(BreakResult())


class Pool():
  """Distributes tasks to a number of worker processes.
  New tasks can be added dynamically even after the workers have been started.
  Requirement: Tasks can only be added from the parent process, e.g. while
  consuming the results generator."""

  # Factor to calculate the maximum number of items in the work/done queue.
  # Necessary to not overflow the queue's pipe if a keyboard interrupt happens.
  BUFFER_FACTOR = 4

  def __init__(self, num_workers, heartbeat_timeout=30):
    self.num_workers = num_workers
    self.processes = []
    self.terminated = False

    # Invariant: count >= #work_queue + #done_queue. It is greater when a
    # worker takes an item from the work_queue and before the result is
    # submitted to the done_queue. It is equal when no worker is working,
    # e.g. when all workers have finished, and when no results are processed.
    # Count is only accessed by the parent process. Only the parent process is
    # allowed to remove items from the done_queue and to add items to the
    # work_queue.
    self.count = 0
    self.work_queue = Queue()
    self.done_queue = Queue()
    self.done = Event()
    self.heartbeat_timeout = heartbeat_timeout

  def imap_unordered(self, fn, gen):
    """Maps function "fn" to items in generator "gen" on the worker processes
    in an arbitrary order. The items are expected to be lists of arguments to
    the function. Returns a results iterator. A result value of type
    MaybeResult either indicates a heartbeat of the runner, i.e. indicating
    that the runner is still waiting for the result to be computed, or it wraps
    the real result."""
    try:
      gen = iter(gen)
      self.advance = self._advance_more

      for w in xrange(self.num_workers):
        p = Process(target=Worker, args=(fn,
                                         self.work_queue,
                                         self.done_queue,
                                         self.done))
        self.processes.append(p)
        p.start()

      self.advance(gen)
      while self.count > 0:
        while True:
          try:
            result = self.done_queue.get(timeout=self.heartbeat_timeout)
            break
          except Empty:
            # Indicate a heartbeat. The iterator will continue fetching the
            # next result.
            yield MaybeResult.create_heartbeat()
        self.count -= 1
        if result.exception:
          # Ignore items with unexpected exceptions.
          continue
        elif result.break_now:
          # A keyboard interrupt happened in one of the worker processes.
          raise KeyboardInterrupt
        else:
          yield MaybeResult.create_result(result.result)
        self.advance(gen)
    finally:
      self.terminate()

  def _advance_more(self, gen):
    while self.count < self.num_workers * self.BUFFER_FACTOR:
      try:
        self.work_queue.put(gen.next())
        self.count += 1
      except StopIteration:
        self.advance = self._advance_empty
        break

  def _advance_empty(self, gen):
    pass

  def add(self, args):
    """Adds an item to the work queue. Can be called dynamically while
    processing the results from imap_unordered."""
    self.work_queue.put(args)
    self.count += 1

  def terminate(self):
    if self.terminated:
      return
    self.terminated = True

    # For exceptional tear down set the "done" event to stop the workers before
    # they empty the queue buffer.
    self.done.set()

    for p in self.processes:
      # During normal tear down the workers block on get(). Feed a poison pill
      # per worker to make them stop.
      self.work_queue.put("STOP")

    for p in self.processes:
      p.join()

    # Drain the queues to prevent failures when queues are garbage collected.
    try:
      while True: self.work_queue.get(False)
    except:
      pass
    try:
      while True: self.done_queue.get(False)
    except:
      pass
node-v4.8.2/deps/v8/tools/testrunner/local/pool_unittest.py000644 000766 000024 00000002344 13070706735 024200 0ustar00iojsstaff000000 000000 #!/usr/bin/env python
# Copyright 2014 the V8 project authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

import unittest

from pool import Pool

def Run(x):
  if x == 10:
    raise Exception("Expected exception triggered by test.")
  return x

class PoolTest(unittest.TestCase):
  def testNormal(self):
    results = set()
    pool = Pool(3)
    for result in pool.imap_unordered(Run, [[x] for x in range(0, 10)]):
      results.add(result.value)
    self.assertEquals(set(range(0, 10)), results)

  def testException(self):
    results = set()
    pool = Pool(3)
    for result in pool.imap_unordered(Run, [[x] for x in range(0, 12)]):
      # Item 10 will not appear in results due to an internal exception.
      results.add(result.value)
    expect = set(range(0, 12))
    expect.remove(10)
    self.assertEquals(expect, results)

  def testAdd(self):
    results = set()
    pool = Pool(3)
    for result in pool.imap_unordered(Run, [[x] for x in range(0, 10)]):
      results.add(result.value)
      if result.value < 30:
        pool.add([result.value + 20])
    self.assertEquals(set(range(0, 10) + range(20, 30) + range(40, 50)),
                      results)
node-v4.8.2/deps/v8/tools/testrunner/local/progress.py000644 000766 000024 00000026753 13070706735 023146 0ustar00iojsstaff000000 000000 # Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


from functools import wraps
import json
import os
import sys
import time

from . import junit_output


ABS_PATH_PREFIX = os.getcwd() + os.sep


def EscapeCommand(command):
  parts = []
  for part in command:
    if ' ' in part:
      # Escape spaces.  We may need to escape more characters for this
      # to work properly.
      parts.append('"%s"' % part)
    else:
      parts.append(part)
  return " ".join(parts)


class ProgressIndicator(object):

  def __init__(self):
    self.runner = None

  def SetRunner(self, runner):
    self.runner = runner

  def Starting(self):
    pass

  def Done(self):
    pass

  def AboutToRun(self, test):
    pass

  def HasRun(self, test, has_unexpected_output):
    pass

  def Heartbeat(self):
    pass

  def PrintFailureHeader(self, test):
    if test.suite.IsNegativeTest(test):
      negative_marker = '[negative] '
    else:
      negative_marker = ''
    print "=== %(label)s %(negative)s===" % {
      'label': test.GetLabel(),
      'negative': negative_marker
    }


class IndicatorNotifier(object):
  """Holds a list of progress indicators and notifies them all on events."""
  def __init__(self):
    self.indicators = []

  def Register(self, indicator):
    self.indicators.append(indicator)


# Forge all generic event-dispatching methods in IndicatorNotifier, which are
# part of the ProgressIndicator interface.
for func_name in ProgressIndicator.__dict__:
  func = getattr(ProgressIndicator, func_name)
  if callable(func) and not func.__name__.startswith('_'):
    def wrap_functor(f):
      @wraps(f)
      def functor(self, *args, **kwargs):
        """Generic event dispatcher."""
        for indicator in self.indicators:
          getattr(indicator, f.__name__)(*args, **kwargs)
      return functor
    setattr(IndicatorNotifier, func_name, wrap_functor(func))


class SimpleProgressIndicator(ProgressIndicator):
  """Abstract base class for {Verbose,Dots}ProgressIndicator"""

  def Starting(self):
    print 'Running %i tests' % self.runner.total

  def Done(self):
    print
    for failed in self.runner.failed:
      self.PrintFailureHeader(failed)
      if failed.output.stderr:
        print "--- stderr ---"
        print failed.output.stderr.strip()
      if failed.output.stdout:
        print "--- stdout ---"
        print failed.output.stdout.strip()
      print "Command: %s" % EscapeCommand(self.runner.GetCommand(failed))
      if failed.output.HasCrashed():
        print "exit code: %d" % failed.output.exit_code
        print "--- CRASHED ---"
      if failed.output.HasTimedOut():
        print "--- TIMEOUT ---"
    if len(self.runner.failed) == 0:
      print "==="
      print "=== All tests succeeded"
      print "==="
    else:
      print
      print "==="
      print "=== %i tests failed" % len(self.runner.failed)
      if self.runner.crashed > 0:
        print "=== %i tests CRASHED" % self.runner.crashed
      print "==="


class VerboseProgressIndicator(SimpleProgressIndicator):

  def AboutToRun(self, test):
    print 'Starting %s...' % test.GetLabel()
    sys.stdout.flush()

  def HasRun(self, test, has_unexpected_output):
    if has_unexpected_output:
      if test.output.HasCrashed():
        outcome = 'CRASH'
      else:
        outcome = 'FAIL'
    else:
      outcome = 'pass'
    print 'Done running %s: %s' % (test.GetLabel(), outcome)
    sys.stdout.flush()

  def Heartbeat(self):
    print 'Still working...'
    sys.stdout.flush()


class DotsProgressIndicator(SimpleProgressIndicator):

  def HasRun(self, test, has_unexpected_output):
    total = self.runner.succeeded + len(self.runner.failed)
    if (total > 1) and (total % 50 == 1):
      sys.stdout.write('\n')
    if has_unexpected_output:
      if test.output.HasCrashed():
        sys.stdout.write('C')
        sys.stdout.flush()
      elif test.output.HasTimedOut():
        sys.stdout.write('T')
        sys.stdout.flush()
      else:
        sys.stdout.write('F')
        sys.stdout.flush()
    else:
      sys.stdout.write('.')
      sys.stdout.flush()


class CompactProgressIndicator(ProgressIndicator):
  """Abstract base class for {Color,Monochrome}ProgressIndicator"""

  def __init__(self, templates):
    super(CompactProgressIndicator, self).__init__()
    self.templates = templates
    self.last_status_length = 0
    self.start_time = time.time()

  def Done(self):
    self.PrintProgress('Done')
    print ""  # Line break.

  def AboutToRun(self, test):
    self.PrintProgress(test.GetLabel())

  def HasRun(self, test, has_unexpected_output):
    if has_unexpected_output:
      self.ClearLine(self.last_status_length)
      self.PrintFailureHeader(test)
      stdout = test.output.stdout.strip()
      if len(stdout):
        print self.templates['stdout'] % stdout
      stderr = test.output.stderr.strip()
      if len(stderr):
        print self.templates['stderr'] % stderr
      print "Command: %s" % EscapeCommand(self.runner.GetCommand(test))
      if test.output.HasCrashed():
        print "exit code: %d" % test.output.exit_code
        print "--- CRASHED ---"
      if test.output.HasTimedOut():
        print "--- TIMEOUT ---"

  def Truncate(self, string, length):
    if length and (len(string) > (length - 3)):
      return string[:(length - 3)] + "..."
    else:
      return string

  def PrintProgress(self, name):
    self.ClearLine(self.last_status_length)
    elapsed = time.time() - self.start_time
    progress = 0 if not self.runner.total else (
        ((self.runner.total - self.runner.remaining) * 100) //
          self.runner.total)
    status = self.templates['status_line'] % {
      'passed': self.runner.succeeded,
      'progress': progress,
      'failed': len(self.runner.failed),
      'test': name,
      'mins': int(elapsed) / 60,
      'secs': int(elapsed) % 60
    }
    status = self.Truncate(status, 78)
    self.last_status_length = len(status)
    print status,
    sys.stdout.flush()


class ColorProgressIndicator(CompactProgressIndicator):

  def __init__(self):
    templates = {
      'status_line': ("[%(mins)02i:%(secs)02i|"
                      "\033[34m%%%(progress) 4d\033[0m|"
                      "\033[32m+%(passed) 4d\033[0m|"
                      "\033[31m-%(failed) 4d\033[0m]: %(test)s"),
      'stdout': "\033[1m%s\033[0m",
      'stderr': "\033[31m%s\033[0m",
    }
    super(ColorProgressIndicator, self).__init__(templates)

  def ClearLine(self, last_line_length):
    print "\033[1K\r",


class MonochromeProgressIndicator(CompactProgressIndicator):

  def __init__(self):
    templates = {
      'status_line': ("[%(mins)02i:%(secs)02i|%%%(progress) 4d|"
                      "+%(passed) 4d|-%(failed) 4d]: %(test)s"),
      'stdout': '%s',
      'stderr': '%s',
    }
    super(MonochromeProgressIndicator, self).__init__(templates)

  def ClearLine(self, last_line_length):
    print ("\r" + (" " * last_line_length) + "\r"),


class JUnitTestProgressIndicator(ProgressIndicator):

  def __init__(self, junitout, junittestsuite):
    self.outputter = junit_output.JUnitTestOutput(junittestsuite)
    if junitout:
      self.outfile = open(junitout, "w")
    else:
      self.outfile = sys.stdout

  def Done(self):
    self.outputter.FinishAndWrite(self.outfile)
    if self.outfile != sys.stdout:
      self.outfile.close()

  def HasRun(self, test, has_unexpected_output):
    fail_text = ""
    if has_unexpected_output:
      stdout = test.output.stdout.strip()
      if len(stdout):
        fail_text += "stdout:\n%s\n" % stdout
      stderr = test.output.stderr.strip()
      if len(stderr):
        fail_text += "stderr:\n%s\n" % stderr
      fail_text += "Command: %s" % EscapeCommand(self.runner.GetCommand(test))
      if test.output.HasCrashed():
        fail_text += "exit code: %d\n--- CRASHED ---" % test.output.exit_code
      if test.output.HasTimedOut():
        fail_text += "--- TIMEOUT ---"
    self.outputter.HasRunTest(
        [test.GetLabel()] + self.runner.context.mode_flags + test.flags,
        test.duration,
        fail_text)


class JsonTestProgressIndicator(ProgressIndicator):

  def __init__(self, json_test_results, arch, mode):
    self.json_test_results = json_test_results
    self.arch = arch
    self.mode = mode
    self.results = []
    self.tests = []

  def Done(self):
    complete_results = []
    if os.path.exists(self.json_test_results):
      with open(self.json_test_results, "r") as f:
        # Buildbot might start out with an empty file.
        complete_results = json.loads(f.read() or "[]")

    # Sort tests by duration.
    timed_tests = [t for t in self.tests if t.duration is not None]
    timed_tests.sort(lambda a, b: cmp(b.duration, a.duration))
    slowest_tests = [
      {
        "name": test.GetLabel(),
        "flags": test.flags,
        "command": EscapeCommand(self.runner.GetCommand(test)).replace(
            ABS_PATH_PREFIX, ""),
        "duration": test.duration,
      } for test in timed_tests[:20]
    ]

    complete_results.append({
      "arch": self.arch,
      "mode": self.mode,
      "results": self.results,
      "slowest_tests": slowest_tests,
    })

    with open(self.json_test_results, "w") as f:
      f.write(json.dumps(complete_results))

  def HasRun(self, test, has_unexpected_output):
    # Buffer all tests for sorting the durations in the end.
    self.tests.append(test)
    if not has_unexpected_output:
      # Omit tests that run as expected. Passing tests of reruns after failures
      # will have unexpected_output to be reported here has well.
      return

    self.results.append({
      "name": test.GetLabel(),
      "flags": test.flags,
      "command": EscapeCommand(self.runner.GetCommand(test)).replace(
          ABS_PATH_PREFIX, ""),
      "run": test.run,
      "stdout": test.output.stdout,
      "stderr": test.output.stderr,
      "exit_code": test.output.exit_code,
      "result": test.suite.GetOutcome(test),
      "expected": list(test.outcomes or ["PASS"]),
      "duration": test.duration,
    })


PROGRESS_INDICATORS = {
  'verbose': VerboseProgressIndicator,
  'dots': DotsProgressIndicator,
  'color': ColorProgressIndicator,
  'mono': MonochromeProgressIndicator
}
node-v4.8.2/deps/v8/tools/testrunner/local/statusfile.py000644 000766 000024 00000011046 13070706735 023452 0ustar00iojsstaff000000 000000 # Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


# These outcomes can occur in a TestCase's outcomes list:
SKIP = "SKIP"
FAIL = "FAIL"
PASS = "PASS"
OKAY = "OKAY"
TIMEOUT = "TIMEOUT"
CRASH = "CRASH"
SLOW = "SLOW"
FLAKY = "FLAKY"
FAST_VARIANTS = "FAST_VARIANTS"
NO_VARIANTS = "NO_VARIANTS"
# These are just for the status files and are mapped below in DEFS:
FAIL_OK = "FAIL_OK"
PASS_OR_FAIL = "PASS_OR_FAIL"
FAIL_SLOPPY = "FAIL_SLOPPY"

ALWAYS = "ALWAYS"

KEYWORDS = {}
for key in [SKIP, FAIL, PASS, OKAY, TIMEOUT, CRASH, SLOW, FLAKY, FAIL_OK,
            FAST_VARIANTS, NO_VARIANTS, PASS_OR_FAIL, FAIL_SLOPPY, ALWAYS]:
  KEYWORDS[key] = key

DEFS = {FAIL_OK: [FAIL, OKAY],
        PASS_OR_FAIL: [PASS, FAIL]}

# Support arches, modes to be written as keywords instead of strings.
VARIABLES = {ALWAYS: True}
for var in ["debug", "release", "big", "little",
            "android_arm", "android_arm64", "android_ia32", "android_x87",
            "android_x64", "arm", "arm64", "ia32", "mips", "mipsel",
            "mips64el", "x64", "x87", "nacl_ia32", "nacl_x64", "ppc", "ppc64",
            "macos", "windows", "linux", "aix"]:
  VARIABLES[var] = var


def DoSkip(outcomes):
  return SKIP in outcomes


def IsSlow(outcomes):
  return SLOW in outcomes


def OnlyStandardVariant(outcomes):
  return NO_VARIANTS in outcomes


def OnlyFastVariants(outcomes):
  return FAST_VARIANTS in outcomes


def IsFlaky(outcomes):
  return FLAKY in outcomes


def IsPassOrFail(outcomes):
  return ((PASS in outcomes) and (FAIL in outcomes) and
          (not CRASH in outcomes) and (not OKAY in outcomes))


def IsFailOk(outcomes):
    return (FAIL in outcomes) and (OKAY in outcomes)


def _AddOutcome(result, new):
  global DEFS
  if new in DEFS:
    mapped = DEFS[new]
    if type(mapped) == list:
      for m in mapped:
        _AddOutcome(result, m)
    elif type(mapped) == str:
      _AddOutcome(result, mapped)
  else:
    result.add(new)


def _ParseOutcomeList(rule, outcomes, target_dict, variables):
  result = set([])
  if type(outcomes) == str:
    outcomes = [outcomes]
  for item in outcomes:
    if type(item) == str:
      _AddOutcome(result, item)
    elif type(item) == list:
      if not eval(item[0], variables): continue
      for outcome in item[1:]:
        assert type(outcome) == str
        _AddOutcome(result, outcome)
    else:
      assert False
  if len(result) == 0: return
  if rule in target_dict:
    target_dict[rule] |= result
  else:
    target_dict[rule] = result


def ReadStatusFile(path, variables):
  with open(path) as f:
    global KEYWORDS
    contents = eval(f.read(), KEYWORDS)

  rules = {}
  wildcards = {}
  variables.update(VARIABLES)
  for section in contents:
    assert type(section) == list
    assert len(section) == 2
    if not eval(section[0], variables): continue
    section = section[1]
    assert type(section) == dict
    for rule in section:
      assert type(rule) == str
      if rule[-1] == '*':
        _ParseOutcomeList(rule, section[rule], wildcards, variables)
      else:
        _ParseOutcomeList(rule, section[rule], rules, variables)
  return rules, wildcards
node-v4.8.2/deps/v8/tools/testrunner/local/testsuite.py000644 000766 000024 00000022631 13070706735 023322 0ustar00iojsstaff000000 000000 # Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


import imp
import os

from . import commands
from . import statusfile
from . import utils
from ..objects import testcase

# Use this to run several variants of the tests.
VARIANT_FLAGS = {
    "default": [],
    "stress": ["--stress-opt", "--always-opt"],
    "turbofan": ["--turbo", "--always-opt"],
    "nocrankshaft": ["--nocrankshaft"]}

FAST_VARIANT_FLAGS = [
    f for v, f in VARIANT_FLAGS.iteritems() if v in ["default", "turbofan"]
]

class TestSuite(object):

  @staticmethod
  def LoadTestSuite(root):
    name = root.split(os.path.sep)[-1]
    f = None
    try:
      (f, pathname, description) = imp.find_module("testcfg", [root])
      module = imp.load_module("testcfg", f, pathname, description)
      return module.GetSuite(name, root)
    except:
      # Use default if no testcfg is present.
      return GoogleTestSuite(name, root)
    finally:
      if f:
        f.close()

  def __init__(self, name, root):
    self.name = name  # string
    self.root = root  # string containing path
    self.tests = None  # list of TestCase objects
    self.rules = None  # dictionary mapping test path to list of outcomes
    self.wildcards = None  # dictionary mapping test paths to list of outcomes
    self.total_duration = None  # float, assigned on demand

  def shell(self):
    return "d8"

  def suffix(self):
    return ".js"

  def status_file(self):
    return "%s/%s.status" % (self.root, self.name)

  # Used in the status file and for stdout printing.
  def CommonTestName(self, testcase):
    if utils.IsWindows():
      return testcase.path.replace("\\", "/")
    else:
      return testcase.path

  def ListTests(self, context):
    raise NotImplementedError

  def VariantFlags(self, testcase, default_flags):
    if testcase.outcomes and statusfile.OnlyStandardVariant(testcase.outcomes):
      return [[]]
    if testcase.outcomes and statusfile.OnlyFastVariants(testcase.outcomes):
      # FAST_VARIANTS implies no --always-opt.
      return [ filter(lambda flag: flag != "--always-opt", f)
               for f in filter(lambda flags: flags in FAST_VARIANT_FLAGS,
                               default_flags) ]
    return default_flags

  def DownloadData(self):
    pass

  def ReadStatusFile(self, variables):
    (self.rules, self.wildcards) = \
        statusfile.ReadStatusFile(self.status_file(), variables)

  def ReadTestCases(self, context):
    self.tests = self.ListTests(context)

  @staticmethod
  def _FilterFlaky(flaky, mode):
    return (mode == "run" and not flaky) or (mode == "skip" and flaky)

  @staticmethod
  def _FilterSlow(slow, mode):
    return (mode == "run" and not slow) or (mode == "skip" and slow)

  @staticmethod
  def _FilterPassFail(pass_fail, mode):
    return (mode == "run" and not pass_fail) or (mode == "skip" and pass_fail)

  def FilterTestCasesByStatus(self, warn_unused_rules,
                              flaky_tests="dontcare",
                              slow_tests="dontcare",
                              pass_fail_tests="dontcare"):
    filtered = []
    used_rules = set()
    for t in self.tests:
      flaky = False
      slow = False
      pass_fail = False
      testname = self.CommonTestName(t)
      if testname in self.rules:
        used_rules.add(testname)
        # Even for skipped tests, as the TestCase object stays around and
        # PrintReport() uses it.
        t.outcomes = self.rules[testname]
        if statusfile.DoSkip(t.outcomes):
          continue  # Don't add skipped tests to |filtered|.
        for outcome in t.outcomes:
          if outcome.startswith('Flags: '):
            t.flags += outcome[7:].split()
        flaky = statusfile.IsFlaky(t.outcomes)
        slow = statusfile.IsSlow(t.outcomes)
        pass_fail = statusfile.IsPassOrFail(t.outcomes)
      skip = False
      for rule in self.wildcards:
        assert rule[-1] == '*'
        if testname.startswith(rule[:-1]):
          used_rules.add(rule)
          t.outcomes |= self.wildcards[rule]
          if statusfile.DoSkip(t.outcomes):
            skip = True
            break  # "for rule in self.wildcards"
          flaky = flaky or statusfile.IsFlaky(t.outcomes)
          slow = slow or statusfile.IsSlow(t.outcomes)
          pass_fail = pass_fail or statusfile.IsPassOrFail(t.outcomes)
      if (skip or self._FilterFlaky(flaky, flaky_tests)
          or self._FilterSlow(slow, slow_tests)
          or self._FilterPassFail(pass_fail, pass_fail_tests)):
        continue  # "for t in self.tests"
      filtered.append(t)
    self.tests = filtered

    if not warn_unused_rules:
      return

    for rule in self.rules:
      if rule not in used_rules:
        print("Unused rule: %s -> %s" % (rule, self.rules[rule]))
    for rule in self.wildcards:
      if rule not in used_rules:
        print("Unused rule: %s -> %s" % (rule, self.wildcards[rule]))

  def FilterTestCasesByArgs(self, args):
    filtered = []
    filtered_args = []
    for a in args:
      argpath = a.split(os.path.sep)
      if argpath[0] != self.name:
        continue
      if len(argpath) == 1 or (len(argpath) == 2 and argpath[1] == '*'):
        return  # Don't filter, run all tests in this suite.
      path = os.path.sep.join(argpath[1:])
      if path[-1] == '*':
        path = path[:-1]
      filtered_args.append(path)
    for t in self.tests:
      for a in filtered_args:
        if t.path.startswith(a):
          filtered.append(t)
          break
    self.tests = filtered

  def GetFlagsForTestCase(self, testcase, context):
    raise NotImplementedError

  def GetSourceForTest(self, testcase):
    return "(no source available)"

  def IsFailureOutput(self, output, testpath):
    return output.exit_code != 0

  def IsNegativeTest(self, testcase):
    return False

  def HasFailed(self, testcase):
    execution_failed = self.IsFailureOutput(testcase.output, testcase.path)
    if self.IsNegativeTest(testcase):
      return not execution_failed
    else:
      return execution_failed

  def GetOutcome(self, testcase):
    if testcase.output.HasCrashed():
      return statusfile.CRASH
    elif testcase.output.HasTimedOut():
      return statusfile.TIMEOUT
    elif self.HasFailed(testcase):
      return statusfile.FAIL
    else:
      return statusfile.PASS

  def HasUnexpectedOutput(self, testcase):
    outcome = self.GetOutcome(testcase)
    return not outcome in (testcase.outcomes or [statusfile.PASS])

  def StripOutputForTransmit(self, testcase):
    if not self.HasUnexpectedOutput(testcase):
      testcase.output.stdout = ""
      testcase.output.stderr = ""

  def CalculateTotalDuration(self):
    self.total_duration = 0.0
    for t in self.tests:
      self.total_duration += t.duration
    return self.total_duration


class GoogleTestSuite(TestSuite):
  def __init__(self, name, root):
    super(GoogleTestSuite, self).__init__(name, root)

  def ListTests(self, context):
    shell = os.path.abspath(os.path.join(context.shell_dir, self.shell()))
    if utils.IsWindows():
      shell += ".exe"
    output = commands.Execute(context.command_prefix +
                              [shell, "--gtest_list_tests"] +
                              context.extra_flags)
    if output.exit_code != 0:
      print output.stdout
      print output.stderr
      raise Exception("Test executable failed to list the tests.")
    tests = []
    test_case = ''
    for line in output.stdout.splitlines():
      test_desc = line.strip().split()[0]
      if test_desc.endswith('.'):
        test_case = test_desc
      elif test_case and test_desc:
        test = testcase.TestCase(self, test_case + test_desc, dependency=None)
        tests.append(test)
    tests.sort()
    return tests

  def GetFlagsForTestCase(self, testcase, context):
    return (testcase.flags + ["--gtest_filter=" + testcase.path] +
            ["--gtest_random_seed=%s" % context.random_seed] +
            ["--gtest_print_time=0"] +
            context.mode_flags)

  def VariantFlags(self, testcase, default_flags):
    return [[]]

  def shell(self):
    return self.name
node-v4.8.2/deps/v8/tools/testrunner/local/utils.py000644 000766 000024 00000010334 13070706735 022426 0ustar00iojsstaff000000 000000 # Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


import os
from os.path import exists
from os.path import isdir
from os.path import join
import platform
import re
import subprocess
import urllib2


def GetSuitePaths(test_root):
  return [ f for f in os.listdir(test_root) if isdir(join(test_root, f)) ]


# Reads a file into an array of strings
def ReadLinesFrom(name):
  lines = []
  with open(name) as f:
    for line in f:
      if line.startswith('#'): continue
      if '#' in line:
        line = line[:line.find('#')]
      line = line.strip()
      if not line: continue
      lines.append(line)
  return lines


def GuessOS():
  system = platform.system()
  if system == 'Linux':
    return 'linux'
  elif system == 'Darwin':
    return 'macos'
  elif system.find('CYGWIN') >= 0:
    return 'cygwin'
  elif system == 'Windows' or system == 'Microsoft':
    # On Windows Vista platform.system() can return 'Microsoft' with some
    # versions of Python, see http://bugs.python.org/issue1082
    return 'windows'
  elif system == 'FreeBSD':
    return 'freebsd'
  elif system == 'OpenBSD':
    return 'openbsd'
  elif system == 'SunOS':
    return 'solaris'
  elif system == 'NetBSD':
    return 'netbsd'
  elif system == 'AIX':
    return 'aix'
  else:
    return None


def UseSimulator(arch):
  machine = platform.machine()
  return (machine and
      (arch == "mipsel" or arch == "arm" or arch == "arm64") and
      not arch.startswith(machine))


# This will default to building the 32 bit VM even on machines that are
# capable of running the 64 bit VM.
def DefaultArch():
  machine = platform.machine()
  machine = machine.lower()  # Windows 7 capitalizes 'AMD64'.
  if machine.startswith('arm'):
    return 'arm'
  elif (not machine) or (not re.match('(x|i[3-6])86$', machine) is None):
    return 'ia32'
  elif machine == 'i86pc':
    return 'ia32'
  elif machine == 'x86_64':
    return 'ia32'
  elif machine == 'amd64':
    return 'ia32'
  elif machine == 'ppc64':
    return 'ppc'
  else:
    return None


def GuessWordsize():
  if '64' in platform.machine():
    return '64'
  else:
    return '32'


def IsWindows():
  return GuessOS() == 'windows'


def URLRetrieve(source, destination):
  """urllib is broken for SSL connections via a proxy therefore we
  can't use urllib.urlretrieve()."""
  if IsWindows():
    try:
      # In python 2.7.6 on windows, urlopen has a problem with redirects.
      # Try using curl instead. Note, this is fixed in 2.7.8.
      subprocess.check_call(["curl", source, '-k', '-L', '-o', destination])
      return
    except:
      # If there's no curl, fall back to urlopen.
      print "Curl is currently not installed. Falling back to python."
      pass
  with open(destination, 'w') as f:
    f.write(urllib2.urlopen(source).read())
node-v4.8.2/deps/v8/tools/testrunner/local/verbose.py000644 000766 000024 00000007145 13070706735 022741 0ustar00iojsstaff000000 000000 # Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


import sys
import time

from . import statusfile


REPORT_TEMPLATE = (
"""Total: %(total)i tests
 * %(skipped)4d tests will be skipped
 * %(timeout)4d tests are expected to timeout sometimes
 * %(nocrash)4d tests are expected to be flaky but not crash
 * %(pass)4d tests are expected to pass
 * %(fail_ok)4d tests are expected to fail that we won't fix
 * %(fail)4d tests are expected to fail that we should fix""")


def PrintReport(tests):
  total = len(tests)
  skipped = timeout = nocrash = passes = fail_ok = fail = 0
  for t in tests:
    if "outcomes" not in dir(t) or not t.outcomes:
      passes += 1
      continue
    o = t.outcomes
    if statusfile.DoSkip(o):
      skipped += 1
      continue
    if statusfile.TIMEOUT in o: timeout += 1
    if statusfile.IsPassOrFail(o): nocrash += 1
    if list(o) == [statusfile.PASS]: passes += 1
    if statusfile.IsFailOk(o): fail_ok += 1
    if list(o) == [statusfile.FAIL]: fail += 1
  print REPORT_TEMPLATE % {
    "total": total,
    "skipped": skipped,
    "timeout": timeout,
    "nocrash": nocrash,
    "pass": passes,
    "fail_ok": fail_ok,
    "fail": fail
  }


def PrintTestSource(tests):
  for test in tests:
    suite = test.suite
    source = suite.GetSourceForTest(test).strip()
    if len(source) > 0:
      print "--- begin source: %s/%s ---" % (suite.name, test.path)
      print source
      print "--- end source: %s/%s ---" % (suite.name, test.path)


def FormatTime(d):
  millis = round(d * 1000) % 1000
  return time.strftime("%M:%S.", time.gmtime(d)) + ("%03i" % millis)


def PrintTestDurations(suites, overall_time):
    # Write the times to stderr to make it easy to separate from the
    # test output.
    print
    sys.stderr.write("--- Total time: %s ---\n" % FormatTime(overall_time))
    timed_tests = [ t for s in suites for t in s.tests
                    if t.duration is not None ]
    timed_tests.sort(lambda a, b: cmp(b.duration, a.duration))
    index = 1
    for entry in timed_tests[:20]:
      t = FormatTime(entry.duration)
      sys.stderr.write("%4i (%s) %s\n" % (index, t, entry.GetLabel()))
      index += 1
node-v4.8.2/deps/v8/tools/sodium/index.html000644 000766 000024 00000002273 13070706735 020711 0ustar00iojsstaff000000 000000 

  
    Sodium
    
    
  
  
  
  
  
    

      

          
          

          
      

      

      

      

        
          

        		
        
          

        		
      

      

      
    
    
  

node-v4.8.2/deps/v8/tools/sodium/sodium.js000644 000766 000024 00000033510 13070706735 020550 0ustar00iojsstaff000000 000000 // Copyright 2013 the V8 project authors. All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
//       copyright notice, this list of conditions and the following
//       disclaimer in the documentation and/or other materials provided
//       with the distribution.
//     * Neither the name of Google Inc. nor the names of its
//       contributors may be used to endorse or promote products derived
//       from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

var Sodium = (function() {
  "use strict";

  var kinds = ["FUNCTION", "OPTIMIZED_FUNCTION", "STUB", "BUILTIN",
               "LOAD_IC", "KEYED_LOAD_IC", "CALL_IC", "KEYED_CALL_IC",
               "STORE_IC", "KEYED_STORE_IC", "BINARY_OP_IC", "COMPARE_IC",
               "COMPARE_NIL_IC", "TO_BOOLEAN_IC"];
  var kindsWithSource = {
    'FUNCTION': true,
    'OPTIMIZED_FUNCTION': true
  };

  var addressRegEx = "0x[0-9a-f]{8,16}";
  var nameFinder = new RegExp("^name = (.+)$");
  var kindFinder = new RegExp("^kind = (.+)$");
  var firstPositionFinder = new RegExp("^source_position = (\\d+)$");
  var separatorFilter = new RegExp("^--- (.)+ ---$");
  var rawSourceFilter = new RegExp("^--- Raw source ---$");
  var codeEndFinder = new RegExp("^--- End code ---$");
  var whiteSpaceLineFinder = new RegExp("^\\W*$");
  var instructionBeginFinder =
    new RegExp("^Instructions\\W+\\(size = \\d+\\)");
  var instructionFinder =
    new RegExp("^\(" + addressRegEx + "\)\(\\W+\\d+\\W+.+\)");
  var positionFinder =
    new RegExp("^(" + addressRegEx + ")\\W+position\\W+\\((\\d+)\\)");
  var addressFinder = new RegExp("\(" + addressRegEx + "\)");
  var addressReplacer = new RegExp("\(" + addressRegEx + "\)", "gi");

  var fileContent = "";
  var selectedFunctionKind = "";
  var currentFunctionKind = "";

  var currentFunctionName = "";
  var firstSourcePosition = 0;
  var startAddress = "";
  var readingSource = false;
  var readingAsm = false;
  var sourceBegin = -1;
  var sourceEnd = -1;
  var asmBegin = -1;
  var asmEnd = -1;
  var codeObjects = [];
  var selectedAsm = null;
  var selectedSource = null;
  var selectedSourceClass = "";

  function Code(name, kind, sourceBegin, sourceEnd, asmBegin, asmEnd,
                firstSourcePosition, startAddress) {
    this.name = name;
    this.kind = kind;
    this.sourceBegin = sourceBegin;
    this.sourceEnd = sourceEnd;
    this.asmBegin = asmBegin;
    this.asmEnd = asmEnd;
    this.firstSourcePosition = firstSourcePosition;
    this.startAddress = startAddress;
  }

  function getCurrentCodeObject() {
    var functionSelect = document.getElementById('function-selector-id');
    return functionSelect.options[functionSelect.selectedIndex].codeObject;
  }

  function getCurrentSourceText() {
    var code = getCurrentCodeObject();
    if (code.sourceBegin == -1 || code.sourceEnd == -1) return "";
    return fileContent.substring(code.sourceBegin, code.sourceEnd);
  }

  function getCurrentAsmText() {
    var code = getCurrentCodeObject();
    if (code.asmBegin == -1 || code.asmEnd == -1) return "";
    return fileContent.substring(code.asmBegin, code.asmEnd);
  }

  function setKindByIndex(index) {
    selectedFunctionKind = kinds[index];
  }

  function processLine(text, begin, end) {
    var line = text.substring(begin, end);
    if (readingSource) {
      if (separatorFilter.exec(line) != null) {
        readingSource = false;
      } else {
        if (sourceBegin == -1) {
          sourceBegin = begin;
        }
        sourceEnd = end;
      }
    } else {
      if (readingAsm) {
        if (codeEndFinder.exec(line) != null) {
          readingAsm = false;
          asmEnd = begin;
          var newCode =
            new Code(currentFunctionName, currentFunctionKind,
                     sourceBegin, sourceEnd, asmBegin, asmEnd,
                     firstSourcePosition, startAddress);
          codeObjects.push(newCode);
          currentFunctionKind = null;
        } else {
          if (asmBegin == -1) {
            matches = instructionBeginFinder.exec(line);
            if (matches != null) {
              asmBegin = begin;
            }
          }
          if (startAddress == "") {
            matches = instructionFinder.exec(line);
            if (matches != null) {
              startAddress = matches[1];
            }
          }
        }
      } else {
        var matches = kindFinder.exec(line);
        if (matches != null) {
          currentFunctionKind = matches[1];
          if (!kindsWithSource[currentFunctionKind]) {
            sourceBegin = -1;
            sourceEnd = -1;
          }
        } else if (currentFunctionKind != null) {
          matches = nameFinder.exec(line);
          if (matches != null) {
            readingAsm = true;
            asmBegin = -1;
            currentFunctionName = matches[1];
          }
        } else if (rawSourceFilter.exec(line) != null) {
          readingSource = true;
          sourceBegin = -1;
        } else {
          var matches = firstPositionFinder.exec(line);
          if (matches != null) {
            firstSourcePosition = parseInt(matches[1]);
          }
        }
      }
    }
  }

  function processLines(source, size, processLine) {
    var firstChar = 0;
    for (var x = 0; x < size; x++) {
      var curChar = source[x];
      if (curChar == '\n' || curChar == '\r') {
        processLine(source, firstChar, x);
        firstChar = x + 1;
      }
    }
    if (firstChar != size - 1) {
      processLine(source, firstChar, size - 1);
    }
  }

  function processFileContent() {
    document.getElementById('source-text-pre').innerHTML = '';
    sourceBegin = -1;
    codeObjects = [];
    processLines(fileContent, fileContent.length, processLine);
    var functionSelectElement = document.getElementById('function-selector-id');
    functionSelectElement.innerHTML = '';
    var length = codeObjects.length;
    for (var i = 0; i < codeObjects.length; ++i) {
      var code = codeObjects[i];
      if (code.kind == selectedFunctionKind) {
        var optionElement = document.createElement("option");
        optionElement.codeObject = code;
        optionElement.text = code.name;
        functionSelectElement.add(optionElement, null);
      }
    }
  }

  function asmClick(element) {
    if (element == selectedAsm) return;
    if (selectedAsm != null) {
      selectedAsm.classList.remove('highlight-yellow');
    }
    selectedAsm = element;
    selectedAsm.classList.add('highlight-yellow');

    var pc = element.firstChild.innerText;
    var sourceLine = null;
    if (addressFinder.exec(pc) != null) {
      var position = findSourcePosition(pc);
      var line = findSourceLine(position);
      sourceLine = document.getElementById('source-line-' + line);
      var sourceLineTop = sourceLine.offsetTop;
      makeSourcePosVisible(sourceLineTop);
    }
    if (selectedSource == sourceLine) return;
    if (selectedSource != null) {
      selectedSource.classList.remove('highlight-yellow');
      selectedSource.classList.add(selectedSourceClass);
    }
    if (sourceLine != null) {
      selectedSourceClass = sourceLine.classList[0];
      sourceLine.classList.remove(selectedSourceClass);
      sourceLine.classList.add('highlight-yellow');
    }
    selectedSource = sourceLine;
  }

  function makeContainerPosVisible(container, newTop) {
    var height = container.offsetHeight;
    var margin = Math.floor(height / 4);
    if (newTop < container.scrollTop + margin) {
      newTop -= margin;
      if (newTop < 0) newTop = 0;
      container.scrollTop = newTop;
      return;
    }
    if (newTop > (container.scrollTop + 3 * margin)) {
      newTop = newTop - 3 * margin;
      container.scrollTop = newTop;
    }
  }

  function makeAsmPosVisible(newTop) {
    var asmContainer = document.getElementById('asm-container');
    makeContainerPosVisible(asmContainer, newTop);
  }

  function makeSourcePosVisible(newTop) {
    var sourceContainer = document.getElementById('source-container');
    makeContainerPosVisible(sourceContainer, newTop);
  }

  function addressClick(element, event) {
    event.stopPropagation();
    var asmLineId = 'address-' + element.innerText;
    var asmLineElement = document.getElementById(asmLineId);
    if (asmLineElement != null) {
      var asmLineTop = asmLineElement.parentNode.offsetTop;
      makeAsmPosVisible(asmLineTop);
      asmLineElement.classList.add('highlight-flash-blue');
      window.setTimeout(function() {
        asmLineElement.classList.remove('highlight-flash-blue');
      }, 1500);
    }
  }

  function prepareAsm(originalSource) {
    var newSource = "";
    var lineNumber = 1;
    var functionProcessLine = function(text, begin, end) {
      var currentLine = text.substring(begin, end);
      var matches = instructionFinder.exec(currentLine);
      var clickHandler = "";
      if (matches != null) {
        var restOfLine = matches[2];
        restOfLine = restOfLine.replace(
          addressReplacer,
          '\$1');
        currentLine = '' +
          matches[1] + '' + restOfLine;
        clickHandler = 'onclick=\'Sodium.asmClick(this)\' ';
      } else if (whiteSpaceLineFinder.exec(currentLine)) {
        currentLine = "
";
      }
      newSource += '
' +
        currentLine + '
';
      lineNumber++;
    }
    processLines(originalSource, originalSource.length, functionProcessLine);
    return newSource;
  }

  function findSourcePosition(pcToSearch) {
    var position = 0;
    var distance = 0x7FFFFFFF;
    var pcToSearchOffset = parseInt(pcToSearch);
    var processOneLine = function(text, begin, end) {
      var currentLine = text.substring(begin, end);
      var matches = positionFinder.exec(currentLine);
      if (matches != null) {
        var pcOffset = parseInt(matches[1]);
        if (pcOffset <= pcToSearchOffset) {
          var dist =  pcToSearchOffset - pcOffset;
          var pos = parseInt(matches[2]);
          if ((dist < distance) || (dist == distance && pos > position)) {
            position = pos;
            distance = dist;
          }
        }
      }
    }
    var asmText = getCurrentAsmText();
    processLines(asmText, asmText.length, processOneLine);
    var code = getCurrentCodeObject();
    if (position == 0) return 0;
    return position - code.firstSourcePosition;
  }

  function findSourceLine(position) {
    if (position == 0) return 1;
    var line = 0;
    var processOneLine = function(text, begin, end) {
      if (begin < position) {
        line++;
      }
    }
    var sourceText = getCurrentSourceText();
    processLines(sourceText, sourceText.length, processOneLine);
    return line;
  }

  function functionChangedHandler() {
    var functionSelect = document.getElementById('function-selector-id');
    var source = getCurrentSourceText();
    var sourceDivElement = document.getElementById('source-text');
    var code = getCurrentCodeObject();
    var newHtml = "
"
      + 'function ' + code.name + source + "
";
    sourceDivElement.innerHTML = newHtml;
    try {
      // Wrap in try to work when offline.
      PR.prettyPrint();
    } catch (e) {
    }
    var sourceLineContainer = sourceDivElement.firstChild.firstChild;
    var lineCount = sourceLineContainer.childElementCount;
    var current = sourceLineContainer.firstChild;
    for (var i = 1; i < lineCount; ++i) {
      current.id = "source-line-" + i;
      current = current.nextElementSibling;
    }

    var asm = getCurrentAsmText();
    document.getElementById('asm-text').innerHTML = prepareAsm(asm);
  }

  function kindChangedHandler(element) {
    setKindByIndex(element.selectedIndex);
    processFileContent();
    functionChangedHandler();
  }

  function readLog(evt) {
    //Retrieve the first (and only!) File from the FileList object
    var f = evt.target.files[0];
    if (f) {
      var r = new FileReader();
      r.onload = function(e) {
        var file = evt.target.files[0];
        currentFunctionKind = "";
        fileContent = e.target.result;
        processFileContent();
        functionChangedHandler();
      }
      r.readAsText(f);
    } else {
      alert("Failed to load file");
    }
  }

  function buildFunctionKindSelector(kindSelectElement) {
    for (var x = 0; x < kinds.length; ++x) {
      var optionElement = document.createElement("option");
      optionElement.value = x;
      optionElement.text = kinds[x];
      kindSelectElement.add(optionElement, null);
    }
    kindSelectElement.selectedIndex = 1;
    setKindByIndex(1);
  }

  return {
    buildFunctionKindSelector: buildFunctionKindSelector,
    kindChangedHandler: kindChangedHandler,
    functionChangedHandler: functionChangedHandler,
    asmClick: asmClick,
    addressClick: addressClick,
    readLog: readLog
  };

})();
node-v4.8.2/deps/v8/tools/sodium/styles.css000755 000766 000024 00000002560 13070706735 020753 0ustar00iojsstaff000000 000000 #table-header {
	background-color: rgba(150, 150, 255, 0.4);
}

#asm-container {
	background-color: rgba(200, 200, 255, 0.4);
    position:absolute;
    overflow:auto;
    cursor:default;
    width:50%;
    height:92%;
}

#source-container {
    position:absolute;
    overflow:auto;
    width:48%;
    left:51%;
    height:92%;
}

table {
    border-collapse: collapse;
}

.hover-underline:hover {
    text-decoration: underline;
}

.highlight-flash-blue {
    -webkit-transition: all 1s ease;
    background-color: rgba(50, 50, 245, 0.4);
    border-radius: 10px;
    -o-border-radius: 10px;
    -moz-border-radius: 10px;
    -webkit-border-radius: 10px;
}


.highlight-green {
    background-color: rgba(0, 255, 0, 0.4);
    border-radius: 10px;
    -o-border-radius: 10px;
    -moz-border-radius: 10px;
    -webkit-border-radius: 10px;
}

.highlight-yellow {
    background-color: rgba(255, 255, 0, 0.4);
    border-radius: 10px;
    -o-border-radius: 10px;
    -moz-border-radius: 10px;
    -webkit-border-radius: 10px;
}

.highlight-gray {
    background-color: rgba(128, 128, 128, 0.4);
    border-radius: 10px;
    -o-border-radius: 10px;
    -moz-border-radius: 10px;
    -webkit-border-radius: 10px;
}

.highlight-red {
    background-color: rgba(255, 0, 0, 0.4);
    border-radius: 10px;
    -o-border-radius: 10px;
    -moz-border-radius: 10px;
    -webkit-border-radius: 10px;
}
node-v4.8.2/deps/v8/tools/sanitizers/tsan_suppressions.txt000644 000766 000024 00000000402 13070706735 024142 0ustar00iojsstaff000000 000000 # Suppressions for TSan v2
# https://code.google.com/p/thread-sanitizer/wiki/Suppressions

# Incorrectly detected lock cycles in test-lockers
# https://code.google.com/p/thread-sanitizer/issues/detail?id=81
deadlock:LockAndUnlockDifferentIsolatesThread::Run
node-v4.8.2/deps/v8/tools/release/auto_push.py000755 000766 000024 00000007320 13070706735 021416 0ustar00iojsstaff000000 000000 #!/usr/bin/env python
# Copyright 2013 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

import argparse
import json
import os
import re
import sys
import urllib

from common_includes import *
import create_release


class Preparation(Step):
  MESSAGE = "Preparation."

  def RunStep(self):
    # Fetch unfetched revisions.
    self.vc.Fetch()


class FetchCandidate(Step):
  MESSAGE = "Fetching V8 roll ref."

  def RunStep(self):
    # The roll ref points to the candidate to be rolled.
    self.Git("fetch origin +refs/heads/roll:refs/heads/roll")
    self["candidate"] = self.Git("show-ref -s refs/heads/roll").strip()


class LastReleaseBailout(Step):
  MESSAGE = "Checking last V8 release base."

  def RunStep(self):
    last_release = self.GetLatestReleaseBase()
    commits = self.GitLog(
        format="%H", git_hash="%s..%s" % (last_release, self["candidate"]))

    if not commits:
      print "Already pushed current candidate %s" % self["candidate"]
      return True


class CreateRelease(Step):
  MESSAGE = "Creating release if specified."

  def RunStep(self):
    print "Creating release for %s." % self["candidate"]

    args = [
      "--author", self._options.author,
      "--reviewer", self._options.reviewer,
      "--revision", self["candidate"],
      "--force",
    ]

    if self._options.work_dir:
      args.extend(["--work-dir", self._options.work_dir])

    if self._options.push:
      self._side_effect_handler.Call(
          create_release.CreateRelease().Run, args)


class AutoPush(ScriptsBase):
  def _PrepareOptions(self, parser):
    parser.add_argument("-p", "--push",
                        help="Create release. Dry run if unspecified.",
                        default=False, action="store_true")

  def _ProcessOptions(self, options):
    if not options.author or not options.reviewer:  # pragma: no cover
      print "You need to specify author and reviewer."
      return False
    options.requires_editor = False
    return True

  def _Config(self):
    return {
      "PERSISTFILE_BASENAME": "/tmp/v8-auto-push-tempfile",
    }

  def _Steps(self):
    return [
      Preparation,
      FetchCandidate,
      LastReleaseBailout,
      CreateRelease,
    ]


if __name__ == "__main__":  # pragma: no cover
  sys.exit(AutoPush().Run())
node-v4.8.2/deps/v8/tools/release/auto_roll.py000755 000766 000024 00000010272 13070706735 021407 0ustar00iojsstaff000000 000000 #!/usr/bin/env python
# Copyright 2014 the V8 project authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

import argparse
import json
import os
import sys
import urllib

from common_includes import *
import chromium_roll


class CheckActiveRoll(Step):
  MESSAGE = "Check active roll."

  @staticmethod
  def ContainsChromiumRoll(changes):
    for change in changes:
      if change["subject"].startswith("Update V8 to"):
        return True
    return False

  def RunStep(self):
    params = {
      "closed": 3,
      "owner": self._options.author,
      "limit": 30,
      "format": "json",
    }
    params = urllib.urlencode(params)
    search_url = "https://codereview.chromium.org/search"
    result = self.ReadURL(search_url, params, wait_plan=[5, 20])
    if self.ContainsChromiumRoll(json.loads(result)["results"]):
      print "Stop due to existing Chromium roll."
      return True


class DetectLastRoll(Step):
  MESSAGE = "Detect commit ID of the last Chromium roll."

  def RunStep(self):
    # The revision that should be rolled. Check for the latest of the most
    # recent releases based on commit timestamp.
    revisions = self.GetRecentReleases(
        max_age=self._options.max_age * DAY_IN_SECONDS)
    assert revisions, "Didn't find any recent release."

    # Interpret the DEPS file to retrieve the v8 revision.
    # TODO(machenbach): This should be part or the roll-deps api of
    # depot_tools.
    Var = lambda var: '%s'
    exec(FileToText(os.path.join(self._options.chromium, "DEPS")))

    # The revision rolled last.
    self["last_roll"] = vars['v8_revision']
    last_version = self.GetVersionTag(self["last_roll"])
    assert last_version, "The last rolled v8 revision is not tagged."

    # There must be some progress between the last roll and the new candidate
    # revision (i.e. we don't go backwards). The revisions are ordered newest
    # to oldest. It is possible that the newest timestamp has no progress
    # compared to the last roll, i.e. if the newest release is a cherry-pick
    # on a release branch. Then we look further.
    for revision in revisions:
      version = self.GetVersionTag(revision)
      assert version, "Internal error. All recent releases should have a tag"

      if SortingKey(last_version) < SortingKey(version):
        self["roll"] = revision
        break
    else:
      print("There is no newer v8 revision than the one in Chromium (%s)."
            % self["last_roll"])
      return True


class RollChromium(Step):
  MESSAGE = "Roll V8 into Chromium."

  def RunStep(self):
    if self._options.roll:
      args = [
        "--author", self._options.author,
        "--reviewer", self._options.reviewer,
        "--chromium", self._options.chromium,
        "--last-roll", self["last_roll"],
        "--use-commit-queue",
        self["roll"],
      ]
      if self._options.sheriff:
        args.append("--sheriff")
      if self._options.dry_run:
        args.append("--dry-run")
      if self._options.work_dir:
        args.extend(["--work-dir", self._options.work_dir])
      self._side_effect_handler.Call(chromium_roll.ChromiumRoll().Run, args)


class AutoRoll(ScriptsBase):
  def _PrepareOptions(self, parser):
    parser.add_argument("-c", "--chromium", required=True,
                        help=("The path to your Chromium src/ "
                              "directory to automate the V8 roll."))
    parser.add_argument("--max-age", default=3, type=int,
                        help="Maximum age in days of the latest release.")
    parser.add_argument("--roll", help="Call Chromium roll script.",
                        default=False, action="store_true")

  def _ProcessOptions(self, options):  # pragma: no cover
    if not options.reviewer:
      print "A reviewer (-r) is required."
      return False
    if not options.author:
      print "An author (-a) is required."
      return False
    return True

  def _Config(self):
    return {
      "PERSISTFILE_BASENAME": "/tmp/v8-auto-roll-tempfile",
    }

  def _Steps(self):
    return [
      CheckActiveRoll,
      DetectLastRoll,
      RollChromium,
    ]


if __name__ == "__main__":  # pragma: no cover
  sys.exit(AutoRoll().Run())
node-v4.8.2/deps/v8/tools/release/auto_tag.py000755 000766 000024 00000013347 13070706735 021220 0ustar00iojsstaff000000 000000 #!/usr/bin/env python
# Copyright 2014 the V8 project authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

import argparse
import sys

from common_includes import *


class Preparation(Step):
  MESSAGE = "Preparation."

  def RunStep(self):
    # TODO(machenbach): Remove after the git switch.
    if self.Config("PERSISTFILE_BASENAME") == "/tmp/v8-auto-tag-tempfile":
      print "This script is disabled until after the v8 git migration."
      return True

    self.CommonPrepare()
    self.PrepareBranch()
    self.GitCheckout("master")
    self.vc.Pull()


class GetTags(Step):
  MESSAGE = "Get all V8 tags."

  def RunStep(self):
    self.GitCreateBranch(self._config["BRANCHNAME"])
    self["tags"] = self.vc.GetTags()


class GetOldestUntaggedVersion(Step):
  MESSAGE = "Check if there's a version on bleeding edge without a tag."

  def RunStep(self):
    tags = set(self["tags"])
    self["candidate"] = None
    self["candidate_version"] = None
    self["next"] = None
    self["next_version"] = None

    # Iterate backwards through all automatic version updates.
    for git_hash in self.GitLog(
        format="%H", grep="\\[Auto\\-roll\\] Bump up version to").splitlines():

      # Get the version.
      if not self.GitCheckoutFileSafe(VERSION_FILE, git_hash):
        continue

      self.ReadAndPersistVersion()
      version = self.ArrayToVersion("")

      # Strip off trailing patch level (tags don't include tag level 0).
      if version.endswith(".0"):
        version = version[:-2]

      # Clean up checked-out version file.
      self.GitCheckoutFileSafe(VERSION_FILE, "HEAD")

      if version in tags:
        if self["candidate"]:
          # Revision "git_hash" is tagged already and "candidate" was the next
          # newer revision without a tag.
          break
        else:
          print("Stop as %s is the latest version and it has been tagged." %
                version)
          self.CommonCleanup()
          return True
      else:
        # This is the second oldest version without a tag.
        self["next"] = self["candidate"]
        self["next_version"] = self["candidate_version"]

        # This is the oldest version without a tag.
        self["candidate"] = git_hash
        self["candidate_version"] = version

    if not self["candidate"] or not self["candidate_version"]:
      print "Nothing found to tag."
      self.CommonCleanup()
      return True

    print("Candidate for tagging is %s with version %s" %
          (self["candidate"], self["candidate_version"]))


class GetLKGRs(Step):
  MESSAGE = "Get the last lkgrs."

  def RunStep(self):
    revision_url = "https://v8-status.appspot.com/revisions?format=json"
    status_json = self.ReadURL(revision_url, wait_plan=[5, 20])
    self["lkgrs"] = [entry["revision"]
                     for entry in json.loads(status_json) if entry["status"]]


class CalculateTagRevision(Step):
  MESSAGE = "Calculate the revision to tag."

  def LastLKGR(self, min_rev, max_rev):
    """Finds the newest lkgr between min_rev (inclusive) and max_rev
    (exclusive).
    """
    for lkgr in self["lkgrs"]:
      # LKGRs are reverse sorted.
      if int(min_rev) <= int(lkgr) and int(lkgr) < int(max_rev):
        return lkgr
    return None

  def RunStep(self):
    # Get the lkgr after the tag candidate and before the next tag candidate.
    candidate_svn = self.vc.GitSvn(self["candidate"])
    if self["next"]:
      next_svn = self.vc.GitSvn(self["next"])
    else:
      # Don't include the version change commit itself if there is no upper
      # limit yet.
      candidate_svn =  str(int(candidate_svn) + 1)
      next_svn = sys.maxint
    lkgr_svn = self.LastLKGR(candidate_svn, next_svn)

    if not lkgr_svn:
      print "There is no lkgr since the candidate version yet."
      self.CommonCleanup()
      return True

    # Let's check if the lkgr is at least three hours old.
    self["lkgr"] = self.vc.SvnGit(lkgr_svn)
    if not self["lkgr"]:
      print "Couldn't find git hash for lkgr %s" % lkgr_svn
      self.CommonCleanup()
      return True

    lkgr_utc_time = int(self.GitLog(n=1, format="%at", git_hash=self["lkgr"]))
    current_utc_time = self._side_effect_handler.GetUTCStamp()

    if current_utc_time < lkgr_utc_time + 10800:
      print "Candidate lkgr %s is too recent for tagging." % lkgr_svn
      self.CommonCleanup()
      return True

    print "Tagging revision %s with %s" % (lkgr_svn, self["candidate_version"])


class MakeTag(Step):
  MESSAGE = "Tag the version."

  def RunStep(self):
    if not self._options.dry_run:
      self.GitReset(self["lkgr"])
      # FIXME(machenbach): Make this work with the git repo.
      self.vc.Tag(self["candidate_version"],
                  "svn/bleeding_edge",
                  "This won't work!")


class CleanUp(Step):
  MESSAGE = "Clean up."

  def RunStep(self):
    self.CommonCleanup()


class AutoTag(ScriptsBase):
  def _PrepareOptions(self, parser):
    parser.add_argument("--dry_run", help="Don't tag the new version.",
                        default=False, action="store_true")

  def _ProcessOptions(self, options):  # pragma: no cover
    if not options.dry_run and not options.author:
      print "Specify your chromium.org email with -a"
      return False
    options.wait_for_lgtm = False
    options.force_readline_defaults = True
    options.force_upload = True
    return True

  def _Config(self):
    return {
      "BRANCHNAME": "auto-tag-v8",
      "PERSISTFILE_BASENAME": "/tmp/v8-auto-tag-tempfile",
    }

  def _Steps(self):
    return [
      Preparation,
      GetTags,
      GetOldestUntaggedVersion,
      GetLKGRs,
      CalculateTagRevision,
      MakeTag,
      CleanUp,
    ]


if __name__ == "__main__":  # pragma: no cover
  sys.exit(AutoTag().Run())
node-v4.8.2/deps/v8/tools/release/check_clusterfuzz.py000755 000766 000024 00000012002 13070706735 023135 0ustar00iojsstaff000000 000000 #!/usr/bin/env python
# Copyright 2014 the V8 project authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

"""
Script to check for new clusterfuzz issues since the last rolled v8 revision.

Returns a json list with test case IDs if any.

Security considerations: The security key and request data must never be
written to public logs. Public automated callers of this script should
suppress stdout and stderr and only process contents of the results_file.
"""


import argparse
import httplib
import json
import os
import re
import sys
import urllib
import urllib2


# Constants to git repos.
BASE_URL = "https://chromium.googlesource.com"
DEPS_LOG = BASE_URL + "/chromium/src/+log/master/DEPS?format=JSON"

# Constants for retrieving v8 rolls.
CRREV = "https://cr-rev.appspot.com/_ah/api/crrev/v1/commit/%s"
V8_COMMIT_RE = re.compile(
    r"^Update V8 to version \d+\.\d+\.\d+ \(based on ([a-fA-F0-9]+)\)\..*")

# Constants for the clusterfuzz backend.
HOSTNAME = "backend-dot-cluster-fuzz.appspot.com"

# Crash patterns.
V8_INTERNAL_RE = re.compile(r"^v8::internal.*")
ANY_RE = re.compile(r".*")

# List of all api requests.
BUG_SPECS = [
  {
    "args": {
      "job_type": "linux_asan_chrome_v8",
      "reproducible": "True",
      "open": "True",
      "bug_information": "",
    },
    "crash_state": V8_INTERNAL_RE,
  },
  {
    "args": {
      "job_type": "linux_asan_d8",
      "reproducible": "True",
      "open": "True",
      "bug_information": "",
    },
    "crash_state": ANY_RE,
  },
  {
    "args": {
      "job_type": "linux_asan_d8_dbg",
      "reproducible": "True",
      "open": "True",
      "bug_information": "",
    },
    "crash_state": ANY_RE,
  },
  {
    "args": {
      "job_type": "linux_asan_d8_v8_arm_dbg",
      "reproducible": "True",
      "open": "True",
      "bug_information": "",
    },
    "crash_state": ANY_RE,
  },
  {
    "args": {
      "job_type": "linux_asan_d8_v8_arm64_dbg",
      "reproducible": "True",
      "open": "True",
      "bug_information": "",
    },
    "crash_state": ANY_RE,
  },
  {
    "args": {
      "job_type": "linux_asan_d8_v8_mipsel_dbg",
      "reproducible": "True",
      "open": "True",
      "bug_information": "",
    },
    "crash_state": ANY_RE,
  },
]


def GetRequest(url):
  url_fh = urllib2.urlopen(url, None, 60)
  try:
    return url_fh.read()
  finally:
    url_fh.close()


def GetLatestV8InChromium():
  """Returns the commit position number of the latest v8 roll in chromium."""

  # Check currently rolled v8 revision.
  result = GetRequest(DEPS_LOG)
  if not result:
    return None

  # Strip security header and load json.
  commits = json.loads(result[5:])

  git_revision = None
  for commit in commits["log"]:
    # Get latest commit that matches the v8 roll pattern. Ignore cherry-picks.
    match = re.match(V8_COMMIT_RE, commit["message"])
    if match:
      git_revision = match.group(1)
      break
  else:
    return None

  # Get commit position number for v8 revision.
  result = GetRequest(CRREV % git_revision)
  if not result:
    return None

  commit = json.loads(result)
  assert commit["repo"] == "v8/v8"
  return commit["number"]


def APIRequest(key, **params):
  """Send a request to the clusterfuzz api.

  Returns a json dict of the response.
  """

  params["api_key"] = key
  params = urllib.urlencode(params)

  headers = {"Content-type": "application/x-www-form-urlencoded"}

  try:
    conn = httplib.HTTPSConnection(HOSTNAME)
    conn.request("POST", "/_api/", params, headers)

    response = conn.getresponse()

    # Never leak "data" into public logs.
    data = response.read()
  except:
    raise Exception("ERROR: Connection problem.")

  try:
    return json.loads(data)
  except:
    raise Exception("ERROR: Could not read response. Is your key valid?")

  return None


def Main():
  parser = argparse.ArgumentParser()
  parser.add_argument("-k", "--key-file", required=True,
                      help="A file with the clusterfuzz api key.")
  parser.add_argument("-r", "--results-file",
                      help="A file to write the results to.")
  options = parser.parse_args()

  # Get api key. The key's content must never be logged.
  assert options.key_file
  with open(options.key_file) as f:
    key = f.read().strip()
  assert key

  revision_number = GetLatestV8InChromium()

  results = []
  for spec in BUG_SPECS:
    args = dict(spec["args"])
    # Use incremented revision as we're interested in all revision greater than
    # what's currently rolled into chromium.
    if revision_number:
      args["revision_greater_or_equal"] = str(int(revision_number) + 1)

    # Never print issue details in public logs.
    issues = APIRequest(key, **args)
    assert issues is not None
    for issue in issues:
      if re.match(spec["crash_state"], issue["crash_state"]):
        results.append(issue["id"])

  if options.results_file:
    with open(options.results_file, "w") as f:
      f.write(json.dumps(results))
  else:
    print results


if __name__ == "__main__":
  sys.exit(Main())
node-v4.8.2/deps/v8/tools/release/chromium_roll.py000755 000766 000024 00000011462 13070706735 022264 0ustar00iojsstaff000000 000000 #!/usr/bin/env python
# Copyright 2014 the V8 project authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

import argparse
import os
import sys

from common_includes import *

ROLL_SUMMARY = ("Summary of changes available at:\n"
                "https://chromium.googlesource.com/v8/v8/+log/%s..%s")

ISSUE_MSG = (
"""Please follow these instructions for assigning/CC'ing issues:
https://code.google.com/p/v8-wiki/wiki/TriagingIssues

Please close rolling in case of a roll revert:
https://v8-roll.appspot.com/""")

class Preparation(Step):
  MESSAGE = "Preparation."

  def RunStep(self):
    # Update v8 remote tracking branches.
    self.GitFetchOrigin()
    self.Git("fetch origin +refs/tags/*:refs/tags/*")


class PrepareRollCandidate(Step):
  MESSAGE = "Robustness checks of the roll candidate."

  def RunStep(self):
    self["roll_title"] = self.GitLog(n=1, format="%s",
                                     git_hash=self._options.roll)

    # Make sure the last roll and the roll candidate are releases.
    version = self.GetVersionTag(self._options.roll)
    assert version, "The revision to roll is not tagged."
    version = self.GetVersionTag(self._options.last_roll)
    assert version, "The revision used as last roll is not tagged."


class SwitchChromium(Step):
  MESSAGE = "Switch to Chromium checkout."

  def RunStep(self):
    cwd = self._options.chromium
    self.InitialEnvironmentChecks(cwd)
    # Check for a clean workdir.
    if not self.GitIsWorkdirClean(cwd=cwd):  # pragma: no cover
      self.Die("Workspace is not clean. Please commit or undo your changes.")
    # Assert that the DEPS file is there.
    if not os.path.exists(os.path.join(cwd, "DEPS")):  # pragma: no cover
      self.Die("DEPS file not present.")


class UpdateChromiumCheckout(Step):
  MESSAGE = "Update the checkout and create a new branch."

  def RunStep(self):
    cwd = self._options.chromium
    self.GitCheckout("master", cwd=cwd)
    self.DeleteBranch("work-branch", cwd=cwd)
    self.Command("gclient", "sync --nohooks", cwd=cwd)
    self.GitPull(cwd=cwd)

    # Update v8 remotes.
    self.GitFetchOrigin()

    self.GitCreateBranch("work-branch", cwd=cwd)


class UploadCL(Step):
  MESSAGE = "Create and upload CL."

  def RunStep(self):
    cwd = self._options.chromium
    # Patch DEPS file.
    if self.Command("roll-dep-svn", "v8 %s" %
                    self._options.roll, cwd=cwd) is None:
      self.Die("Failed to create deps for %s" % self._options.roll)

    message = []
    message.append("Update V8 to %s." % self["roll_title"].lower())

    message.append(
        ROLL_SUMMARY % (self._options.last_roll[:8], self._options.roll[:8]))

    message.append(ISSUE_MSG)

    message.append("TBR=%s" % self._options.reviewer)
    self.GitCommit("\n\n".join(message),  author=self._options.author, cwd=cwd)
    if not self._options.dry_run:
      self.GitUpload(author=self._options.author,
                     force=True,
                     cq=self._options.use_commit_queue,
                     cwd=cwd)
      print "CL uploaded."
    else:
      print "Dry run - don't upload."

    self.GitCheckout("master", cwd=cwd)
    self.GitDeleteBranch("work-branch", cwd=cwd)

class CleanUp(Step):
  MESSAGE = "Done!"

  def RunStep(self):
    print("Congratulations, you have successfully rolled %s into "
          "Chromium."
          % self._options.roll)

    # Clean up all temporary files.
    Command("rm", "-f %s*" % self._config["PERSISTFILE_BASENAME"])


class ChromiumRoll(ScriptsBase):
  def _PrepareOptions(self, parser):
    parser.add_argument("-c", "--chromium", required=True,
                        help=("The path to your Chromium src/ "
                              "directory to automate the V8 roll."))
    parser.add_argument("--last-roll", required=True,
                        help="The git commit ID of the last rolled version.")
    parser.add_argument("roll", nargs=1, help="Revision to roll."),
    parser.add_argument("--use-commit-queue",
                        help="Check the CQ bit on upload.",
                        default=False, action="store_true")

  def _ProcessOptions(self, options):  # pragma: no cover
    if not options.author or not options.reviewer:
      print "A reviewer (-r) and an author (-a) are required."
      return False

    options.requires_editor = False
    options.force = True
    options.manual = False
    options.roll = options.roll[0]
    return True

  def _Config(self):
    return {
      "PERSISTFILE_BASENAME": "/tmp/v8-chromium-roll-tempfile",
    }

  def _Steps(self):
    return [
      Preparation,
      PrepareRollCandidate,
      DetermineV8Sheriff,
      SwitchChromium,
      UpdateChromiumCheckout,
      UploadCL,
      CleanUp,
    ]


if __name__ == "__main__":  # pragma: no cover
  sys.exit(ChromiumRoll().Run())
node-v4.8.2/deps/v8/tools/release/common_includes.py000644 000766 000024 00000071056 13070706735 022571 0ustar00iojsstaff000000 000000 #!/usr/bin/env python
# Copyright 2013 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

import argparse
import datetime
import httplib
import glob
import imp
import json
import os
import re
import shutil
import subprocess
import sys
import textwrap
import time
import urllib
import urllib2

from git_recipes import GitRecipesMixin
from git_recipes import GitFailedException

CHANGELOG_FILE = "ChangeLog"
DAY_IN_SECONDS = 24 * 60 * 60
PUSH_MSG_GIT_RE = re.compile(r".* \(based on (?P[a-fA-F0-9]+)\)$")
PUSH_MSG_NEW_RE = re.compile(r"^Version \d+\.\d+\.\d+$")
VERSION_FILE = os.path.join("include", "v8-version.h")
VERSION_RE = re.compile(r"^\d+\.\d+\.\d+(?:\.\d+)?$")

# V8 base directory.
V8_BASE = os.path.dirname(
    os.path.dirname(os.path.dirname(os.path.abspath(__file__))))


def TextToFile(text, file_name):
  with open(file_name, "w") as f:
    f.write(text)


def AppendToFile(text, file_name):
  with open(file_name, "a") as f:
    f.write(text)


def LinesInFile(file_name):
  with open(file_name) as f:
    for line in f:
      yield line


def FileToText(file_name):
  with open(file_name) as f:
    return f.read()


def MSub(rexp, replacement, text):
  return re.sub(rexp, replacement, text, flags=re.MULTILINE)


def Fill80(line):
  # Replace tabs and remove surrounding space.
  line = re.sub(r"\t", r"        ", line.strip())

  # Format with 8 characters indentation and line width 80.
  return textwrap.fill(line, width=80, initial_indent="        ",
                       subsequent_indent="        ")


def MakeComment(text):
  return MSub(r"^( ?)", "#", text)


def StripComments(text):
  # Use split not splitlines to keep terminal newlines.
  return "\n".join(filter(lambda x: not x.startswith("#"), text.split("\n")))


def MakeChangeLogBody(commit_messages, auto_format=False):
  result = ""
  added_titles = set()
  for (title, body, author) in commit_messages:
    # TODO(machenbach): Better check for reverts. A revert should remove the
    # original CL from the actual log entry.
    title = title.strip()
    if auto_format:
      # Only add commits that set the LOG flag correctly.
      log_exp = r"^[ \t]*LOG[ \t]*=[ \t]*(?:(?:Y(?:ES)?)|TRUE)"
      if not re.search(log_exp, body, flags=re.I | re.M):
        continue
      # Never include reverts.
      if title.startswith("Revert "):
        continue
      # Don't include duplicates.
      if title in added_titles:
        continue

    # Add and format the commit's title and bug reference. Move dot to the end.
    added_titles.add(title)
    raw_title = re.sub(r"(\.|\?|!)$", "", title)
    bug_reference = MakeChangeLogBugReference(body)
    space = " " if bug_reference else ""
    result += "%s\n" % Fill80("%s%s%s." % (raw_title, space, bug_reference))

    # Append the commit's author for reference if not in auto-format mode.
    if not auto_format:
      result += "%s\n" % Fill80("(%s)" % author.strip())

    result += "\n"
  return result


def MakeChangeLogBugReference(body):
  """Grep for "BUG=xxxx" lines in the commit message and convert them to
  "(issue xxxx)".
  """
  crbugs = []
  v8bugs = []

  def AddIssues(text):
    ref = re.match(r"^BUG[ \t]*=[ \t]*(.+)$", text.strip())
    if not ref:
      return
    for bug in ref.group(1).split(","):
      bug = bug.strip()
      match = re.match(r"^v8:(\d+)$", bug)
      if match: v8bugs.append(int(match.group(1)))
      else:
        match = re.match(r"^(?:chromium:)?(\d+)$", bug)
        if match: crbugs.append(int(match.group(1)))

  # Add issues to crbugs and v8bugs.
  map(AddIssues, body.splitlines())

  # Filter duplicates, sort, stringify.
  crbugs = map(str, sorted(set(crbugs)))
  v8bugs = map(str, sorted(set(v8bugs)))

  bug_groups = []
  def FormatIssues(prefix, bugs):
    if len(bugs) > 0:
      plural = "s" if len(bugs) > 1 else ""
      bug_groups.append("%sissue%s %s" % (prefix, plural, ", ".join(bugs)))

  FormatIssues("", v8bugs)
  FormatIssues("Chromium ", crbugs)

  if len(bug_groups) > 0:
    return "(%s)" % ", ".join(bug_groups)
  else:
    return ""


def SortingKey(version):
  """Key for sorting version number strings: '3.11' > '3.2.1.1'"""
  version_keys = map(int, version.split("."))
  # Fill up to full version numbers to normalize comparison.
  while len(version_keys) < 4:  # pragma: no cover
    version_keys.append(0)
  # Fill digits.
  return ".".join(map("{0:04d}".format, version_keys))


# Some commands don't like the pipe, e.g. calling vi from within the script or
# from subscripts like git cl upload.
def Command(cmd, args="", prefix="", pipe=True, cwd=None):
  cwd = cwd or os.getcwd()
  # TODO(machenbach): Use timeout.
  cmd_line = "%s %s %s" % (prefix, cmd, args)
  print "Command: %s" % cmd_line
  print "in %s" % cwd
  sys.stdout.flush()
  try:
    if pipe:
      return subprocess.check_output(cmd_line, shell=True, cwd=cwd)
    else:
      return subprocess.check_call(cmd_line, shell=True, cwd=cwd)
  except subprocess.CalledProcessError:
    return None
  finally:
    sys.stdout.flush()
    sys.stderr.flush()


# Wrapper for side effects.
class SideEffectHandler(object):  # pragma: no cover
  def Call(self, fun, *args, **kwargs):
    return fun(*args, **kwargs)

  def Command(self, cmd, args="", prefix="", pipe=True, cwd=None):
    return Command(cmd, args, prefix, pipe, cwd=cwd)

  def ReadLine(self):
    return sys.stdin.readline().strip()

  def ReadURL(self, url, params=None):
    # pylint: disable=E1121
    url_fh = urllib2.urlopen(url, params, 60)
    try:
      return url_fh.read()
    finally:
      url_fh.close()

  def ReadClusterFuzzAPI(self, api_key, **params):
    params["api_key"] = api_key.strip()
    params = urllib.urlencode(params)

    headers = {"Content-type": "application/x-www-form-urlencoded"}

    conn = httplib.HTTPSConnection("backend-dot-cluster-fuzz.appspot.com")
    conn.request("POST", "/_api/", params, headers)

    response = conn.getresponse()
    data = response.read()

    try:
      return json.loads(data)
    except:
      print data
      print "ERROR: Could not read response. Is your key valid?"
      raise

  def Sleep(self, seconds):
    time.sleep(seconds)

  def GetDate(self):
    return datetime.date.today().strftime("%Y-%m-%d")

  def GetUTCStamp(self):
    return time.mktime(datetime.datetime.utcnow().timetuple())

DEFAULT_SIDE_EFFECT_HANDLER = SideEffectHandler()


class NoRetryException(Exception):
  pass


class VCInterface(object):
  def InjectStep(self, step):
    self.step=step

  def Pull(self):
    raise NotImplementedError()

  def Fetch(self):
    raise NotImplementedError()

  def GetTags(self):
    raise NotImplementedError()

  def GetBranches(self):
    raise NotImplementedError()

  def MasterBranch(self):
    raise NotImplementedError()

  def CandidateBranch(self):
    raise NotImplementedError()

  def RemoteMasterBranch(self):
    raise NotImplementedError()

  def RemoteCandidateBranch(self):
    raise NotImplementedError()

  def RemoteBranch(self, name):
    raise NotImplementedError()

  def CLLand(self):
    raise NotImplementedError()

  def Tag(self, tag, remote, message):
    """Sets a tag for the current commit.

    Assumptions: The commit already landed and the commit message is unique.
    """
    raise NotImplementedError()


class GitInterface(VCInterface):
  def Pull(self):
    self.step.GitPull()

  def Fetch(self):
    self.step.Git("fetch")

  def GetTags(self):
     return self.step.Git("tag").strip().splitlines()

  def GetBranches(self):
    # Get relevant remote branches, e.g. "branch-heads/3.25".
    branches = filter(
        lambda s: re.match(r"^branch\-heads/\d+\.\d+$", s),
        self.step.GitRemotes())
    # Remove 'branch-heads/' prefix.
    return map(lambda s: s[13:], branches)

  def MasterBranch(self):
    return "master"

  def CandidateBranch(self):
    return "candidates"

  def RemoteMasterBranch(self):
    return "origin/master"

  def RemoteCandidateBranch(self):
    return "origin/candidates"

  def RemoteBranch(self, name):
    # Assume that if someone "fully qualified" the ref, they know what they
    # want.
    if name.startswith('refs/'):
      return name
    if name in ["candidates", "master"]:
      return "refs/remotes/origin/%s" % name
    try:
      # Check if branch is in heads.
      if self.step.Git("show-ref refs/remotes/origin/%s" % name).strip():
        return "refs/remotes/origin/%s" % name
    except GitFailedException:
      pass
    try:
      # Check if branch is in branch-heads.
      if self.step.Git("show-ref refs/remotes/branch-heads/%s" % name).strip():
        return "refs/remotes/branch-heads/%s" % name
    except GitFailedException:
      pass
    self.Die("Can't find remote of %s" % name)

  def Tag(self, tag, remote, message):
    # Wait for the commit to appear. Assumes unique commit message titles (this
    # is the case for all automated merge and push commits - also no title is
    # the prefix of another title).
    commit = None
    for wait_interval in [3, 7, 15, 35, 45, 60]:
      self.step.Git("fetch")
      commit = self.step.GitLog(n=1, format="%H", grep=message, branch=remote)
      if commit:
        break
      print("The commit has not replicated to git. Waiting for %s seconds." %
            wait_interval)
      self.step._side_effect_handler.Sleep(wait_interval)
    else:
      self.step.Die("Couldn't determine commit for setting the tag. Maybe the "
                    "git updater is lagging behind?")

    self.step.Git("tag %s %s" % (tag, commit))
    self.step.Git("push origin %s" % tag)

  def CLLand(self):
    self.step.GitCLLand()


class Step(GitRecipesMixin):
  def __init__(self, text, number, config, state, options, handler):
    self._text = text
    self._number = number
    self._config = config
    self._state = state
    self._options = options
    self._side_effect_handler = handler
    self.vc = GitInterface()
    self.vc.InjectStep(self)

    # The testing configuration might set a different default cwd.
    self.default_cwd = (self._config.get("DEFAULT_CWD") or
                        os.path.join(self._options.work_dir, "v8"))

    assert self._number >= 0
    assert self._config is not None
    assert self._state is not None
    assert self._side_effect_handler is not None

  def __getitem__(self, key):
    # Convenience method to allow direct [] access on step classes for
    # manipulating the backed state dict.
    return self._state.get(key)

  def __setitem__(self, key, value):
    # Convenience method to allow direct [] access on step classes for
    # manipulating the backed state dict.
    self._state[key] = value

  def Config(self, key):
    return self._config[key]

  def Run(self):
    # Restore state.
    state_file = "%s-state.json" % self._config["PERSISTFILE_BASENAME"]
    if not self._state and os.path.exists(state_file):
      self._state.update(json.loads(FileToText(state_file)))

    print ">>> Step %d: %s" % (self._number, self._text)
    try:
      return self.RunStep()
    finally:
      # Persist state.
      TextToFile(json.dumps(self._state), state_file)

  def RunStep(self):  # pragma: no cover
    raise NotImplementedError

  def Retry(self, cb, retry_on=None, wait_plan=None):
    """ Retry a function.
    Params:
      cb: The function to retry.
      retry_on: A callback that takes the result of the function and returns
                True if the function should be retried. A function throwing an
                exception is always retried.
      wait_plan: A list of waiting delays between retries in seconds. The
                 maximum number of retries is len(wait_plan).
    """
    retry_on = retry_on or (lambda x: False)
    wait_plan = list(wait_plan or [])
    wait_plan.reverse()
    while True:
      got_exception = False
      try:
        result = cb()
      except NoRetryException as e:
        raise e
      except Exception as e:
        got_exception = e
      if got_exception or retry_on(result):
        if not wait_plan:  # pragma: no cover
          raise Exception("Retried too often. Giving up. Reason: %s" %
                          str(got_exception))
        wait_time = wait_plan.pop()
        print "Waiting for %f seconds." % wait_time
        self._side_effect_handler.Sleep(wait_time)
        print "Retrying..."
      else:
        return result

  def ReadLine(self, default=None):
    # Don't prompt in forced mode.
    if self._options.force_readline_defaults and default is not None:
      print "%s (forced)" % default
      return default
    else:
      return self._side_effect_handler.ReadLine()

  def Command(self, name, args, cwd=None):
    cmd = lambda: self._side_effect_handler.Command(
        name, args, "", True, cwd=cwd or self.default_cwd)
    return self.Retry(cmd, None, [5])

  def Git(self, args="", prefix="", pipe=True, retry_on=None, cwd=None):
    cmd = lambda: self._side_effect_handler.Command(
        "git", args, prefix, pipe, cwd=cwd or self.default_cwd)
    result = self.Retry(cmd, retry_on, [5, 30])
    if result is None:
      raise GitFailedException("'git %s' failed." % args)
    return result

  def Editor(self, args):
    if self._options.requires_editor:
      return self._side_effect_handler.Command(
          os.environ["EDITOR"],
          args,
          pipe=False,
          cwd=self.default_cwd)

  def ReadURL(self, url, params=None, retry_on=None, wait_plan=None):
    wait_plan = wait_plan or [3, 60, 600]
    cmd = lambda: self._side_effect_handler.ReadURL(url, params)
    return self.Retry(cmd, retry_on, wait_plan)

  def GetDate(self):
    return self._side_effect_handler.GetDate()

  def Die(self, msg=""):
    if msg != "":
      print "Error: %s" % msg
    print "Exiting"
    raise Exception(msg)

  def DieNoManualMode(self, msg=""):
    if not self._options.manual:  # pragma: no cover
      msg = msg or "Only available in manual mode."
      self.Die(msg)

  def Confirm(self, msg):
    print "%s [Y/n] " % msg,
    answer = self.ReadLine(default="Y")
    return answer == "" or answer == "Y" or answer == "y"

  def DeleteBranch(self, name, cwd=None):
    for line in self.GitBranch(cwd=cwd).splitlines():
      if re.match(r"\*?\s*%s$" % re.escape(name), line):
        msg = "Branch %s exists, do you want to delete it?" % name
        if self.Confirm(msg):
          self.GitDeleteBranch(name, cwd=cwd)
          print "Branch %s deleted." % name
        else:
          msg = "Can't continue. Please delete branch %s and try again." % name
          self.Die(msg)

  def InitialEnvironmentChecks(self, cwd):
    # Cancel if this is not a git checkout.
    if not os.path.exists(os.path.join(cwd, ".git")):  # pragma: no cover
      self.Die("This is not a git checkout, this script won't work for you.")

    # Cancel if EDITOR is unset or not executable.
    if (self._options.requires_editor and (not os.environ.get("EDITOR") or
        self.Command(
            "which", os.environ["EDITOR"]) is None)):  # pragma: no cover
      self.Die("Please set your EDITOR environment variable, you'll need it.")

  def CommonPrepare(self):
    # Check for a clean workdir.
    if not self.GitIsWorkdirClean():  # pragma: no cover
      self.Die("Workspace is not clean. Please commit or undo your changes.")

    # Checkout master in case the script was left on a work branch.
    self.GitCheckout('origin/master')

    # Fetch unfetched revisions.
    self.vc.Fetch()

  def PrepareBranch(self):
    # Delete the branch that will be created later if it exists already.
    self.DeleteBranch(self._config["BRANCHNAME"])

  def CommonCleanup(self):
    self.GitCheckout('origin/master')
    self.GitDeleteBranch(self._config["BRANCHNAME"])

    # Clean up all temporary files.
    for f in glob.iglob("%s*" % self._config["PERSISTFILE_BASENAME"]):
      if os.path.isfile(f):
        os.remove(f)
      if os.path.isdir(f):
        shutil.rmtree(f)

  def ReadAndPersistVersion(self, prefix=""):
    def ReadAndPersist(var_name, def_name):
      match = re.match(r"^#define %s\s+(\d*)" % def_name, line)
      if match:
        value = match.group(1)
        self["%s%s" % (prefix, var_name)] = value
    for line in LinesInFile(os.path.join(self.default_cwd, VERSION_FILE)):
      for (var_name, def_name) in [("major", "V8_MAJOR_VERSION"),
                                   ("minor", "V8_MINOR_VERSION"),
                                   ("build", "V8_BUILD_NUMBER"),
                                   ("patch", "V8_PATCH_LEVEL")]:
        ReadAndPersist(var_name, def_name)

  def WaitForLGTM(self):
    print ("Please wait for an LGTM, then type \"LGTM\" to commit "
           "your change. (If you need to iterate on the patch or double check "
           "that it's sane, do so in another shell, but remember to not "
           "change the headline of the uploaded CL.")
    answer = ""
    while answer != "LGTM":
      print "> ",
      answer = self.ReadLine(None if self._options.wait_for_lgtm else "LGTM")
      if answer != "LGTM":
        print "That was not 'LGTM'."

  def WaitForResolvingConflicts(self, patch_file):
    print("Applying the patch \"%s\" failed. Either type \"ABORT\", "
          "or resolve the conflicts, stage *all* touched files with "
          "'git add', and type \"RESOLVED\"")
    self.DieNoManualMode()
    answer = ""
    while answer != "RESOLVED":
      if answer == "ABORT":
        self.Die("Applying the patch failed.")
      if answer != "":
        print "That was not 'RESOLVED' or 'ABORT'."
      print "> ",
      answer = self.ReadLine()

  # Takes a file containing the patch to apply as first argument.
  def ApplyPatch(self, patch_file, revert=False):
    try:
      self.GitApplyPatch(patch_file, revert)
    except GitFailedException:
      self.WaitForResolvingConflicts(patch_file)

  def GetVersionTag(self, revision):
    tag = self.Git("describe --tags %s" % revision).strip()
    if VERSION_RE.match(tag):
      return tag
    else:
      return None

  def GetRecentReleases(self, max_age):
    # Make sure tags are fetched.
    self.Git("fetch origin +refs/tags/*:refs/tags/*")

    # Current timestamp.
    time_now = int(self._side_effect_handler.GetUTCStamp())

    # List every tag from a given period.
    revisions = self.Git("rev-list --max-age=%d --tags" %
                         int(time_now - max_age)).strip()

    # Filter out revisions who's tag is off by one or more commits.
    return filter(lambda r: self.GetVersionTag(r), revisions.splitlines())

  def GetLatestVersion(self):
    # Use cached version if available.
    if self["latest_version"]:
      return self["latest_version"]

    # Make sure tags are fetched.
    self.Git("fetch origin +refs/tags/*:refs/tags/*")
    version = sorted(filter(VERSION_RE.match, self.vc.GetTags()),
                     key=SortingKey, reverse=True)[0]
    self["latest_version"] = version
    return version

  def GetLatestRelease(self):
    """The latest release is the git hash of the latest tagged version.

    This revision should be rolled into chromium.
    """
    latest_version = self.GetLatestVersion()

    # The latest release.
    latest_hash = self.GitLog(n=1, format="%H", branch=latest_version)
    assert latest_hash
    return latest_hash

  def GetLatestReleaseBase(self, version=None):
    """The latest release base is the latest revision that is covered in the
    last change log file. It doesn't include cherry-picked patches.
    """
    latest_version = version or self.GetLatestVersion()

    # Strip patch level if it exists.
    latest_version = ".".join(latest_version.split(".")[:3])

    # The latest release base.
    latest_hash = self.GitLog(n=1, format="%H", branch=latest_version)
    assert latest_hash

    title = self.GitLog(n=1, format="%s", git_hash=latest_hash)
    match = PUSH_MSG_GIT_RE.match(title)
    if match:
      # Legacy: In the old process there's one level of indirection. The
      # version is on the candidates branch and points to the real release
      # base on master through the commit message.
      return match.group("git_rev")
    match = PUSH_MSG_NEW_RE.match(title)
    if match:
      # This is a new-style v8 version branched from master. The commit
      # "latest_hash" is the version-file change. Its parent is the release
      # base on master.
      return self.GitLog(n=1, format="%H", git_hash="%s^" % latest_hash)

    self.Die("Unknown latest release: %s" % latest_hash)

  def ArrayToVersion(self, prefix):
    return ".".join([self[prefix + "major"],
                     self[prefix + "minor"],
                     self[prefix + "build"],
                     self[prefix + "patch"]])

  def StoreVersion(self, version, prefix):
    version_parts = version.split(".")
    if len(version_parts) == 3:
      version_parts.append("0")
    major, minor, build, patch = version_parts
    self[prefix + "major"] = major
    self[prefix + "minor"] = minor
    self[prefix + "build"] = build
    self[prefix + "patch"] = patch

  def SetVersion(self, version_file, prefix):
    output = ""
    for line in FileToText(version_file).splitlines():
      if line.startswith("#define V8_MAJOR_VERSION"):
        line = re.sub("\d+$", self[prefix + "major"], line)
      elif line.startswith("#define V8_MINOR_VERSION"):
        line = re.sub("\d+$", self[prefix + "minor"], line)
      elif line.startswith("#define V8_BUILD_NUMBER"):
        line = re.sub("\d+$", self[prefix + "build"], line)
      elif line.startswith("#define V8_PATCH_LEVEL"):
        line = re.sub("\d+$", self[prefix + "patch"], line)
      elif (self[prefix + "candidate"] and
            line.startswith("#define V8_IS_CANDIDATE_VERSION")):
        line = re.sub("\d+$", self[prefix + "candidate"], line)
      output += "%s\n" % line
    TextToFile(output, version_file)


class BootstrapStep(Step):
  MESSAGE = "Bootstapping v8 checkout."

  def RunStep(self):
    if os.path.realpath(self.default_cwd) == os.path.realpath(V8_BASE):
      self.Die("Can't use v8 checkout with calling script as work checkout.")
    # Directory containing the working v8 checkout.
    if not os.path.exists(self._options.work_dir):
      os.makedirs(self._options.work_dir)
    if not os.path.exists(self.default_cwd):
      self.Command("fetch", "v8", cwd=self._options.work_dir)


class UploadStep(Step):
  MESSAGE = "Upload for code review."

  def RunStep(self):
    if self._options.reviewer:
      print "Using account %s for review." % self._options.reviewer
      reviewer = self._options.reviewer
    else:
      print "Please enter the email address of a V8 reviewer for your patch: ",
      self.DieNoManualMode("A reviewer must be specified in forced mode.")
      reviewer = self.ReadLine()
    self.GitUpload(reviewer, self._options.author, self._options.force_upload,
                   bypass_hooks=self._options.bypass_upload_hooks,
                   cc=self._options.cc)


class DetermineV8Sheriff(Step):
  MESSAGE = "Determine the V8 sheriff for code review."

  def RunStep(self):
    self["sheriff"] = None
    if not self._options.sheriff:  # pragma: no cover
      return

    # The sheriff determined by the rotation on the waterfall has a
    # @google.com account.
    url = "https://chromium-build.appspot.com/p/chromium/sheriff_v8.js"
    match = re.match(r"document\.write\('(\w+)'\)", self.ReadURL(url))

    # If "channel is sheriff", we can't match an account.
    if match:
      g_name = match.group(1)
      # Optimistically assume that google and chromium account name are the
      # same.
      self["sheriff"] = g_name + "@chromium.org"
      self._options.reviewer = ("%s,%s" %
                                (self["sheriff"], self._options.reviewer))
      print "Found active sheriff: %s" % self["sheriff"]
    else:
      print "No active sheriff found."


def MakeStep(step_class=Step, number=0, state=None, config=None,
             options=None, side_effect_handler=DEFAULT_SIDE_EFFECT_HANDLER):
    # Allow to pass in empty dictionaries.
    state = state if state is not None else {}
    config = config if config is not None else {}

    try:
      message = step_class.MESSAGE
    except AttributeError:
      message = step_class.__name__

    return step_class(message, number=number, config=config,
                      state=state, options=options,
                      handler=side_effect_handler)


class ScriptsBase(object):
  def __init__(self,
               config=None,
               side_effect_handler=DEFAULT_SIDE_EFFECT_HANDLER,
               state=None):
    self._config = config or self._Config()
    self._side_effect_handler = side_effect_handler
    self._state = state if state is not None else {}

  def _Description(self):
    return None

  def _PrepareOptions(self, parser):
    pass

  def _ProcessOptions(self, options):
    return True

  def _Steps(self):  # pragma: no cover
    raise Exception("Not implemented.")

  def _Config(self):
    return {}

  def MakeOptions(self, args=None):
    parser = argparse.ArgumentParser(description=self._Description())
    parser.add_argument("-a", "--author", default="",
                        help="The author email used for rietveld.")
    parser.add_argument("--dry-run", default=False, action="store_true",
                        help="Perform only read-only actions.")
    parser.add_argument("-r", "--reviewer", default="",
                        help="The account name to be used for reviews.")
    parser.add_argument("--sheriff", default=False, action="store_true",
                        help=("Determine current sheriff to review CLs. On "
                              "success, this will overwrite the reviewer "
                              "option."))
    parser.add_argument("-s", "--step",
        help="Specify the step where to start work. Default: 0.",
        default=0, type=int)
    parser.add_argument("--work-dir",
                        help=("Location where to bootstrap a working v8 "
                              "checkout."))
    self._PrepareOptions(parser)

    if args is None:  # pragma: no cover
      options = parser.parse_args()
    else:
      options = parser.parse_args(args)

    # Process common options.
    if options.step < 0:  # pragma: no cover
      print "Bad step number %d" % options.step
      parser.print_help()
      return None

    # Defaults for options, common to all scripts.
    options.manual = getattr(options, "manual", True)
    options.force = getattr(options, "force", False)
    options.bypass_upload_hooks = False

    # Derived options.
    options.requires_editor = not options.force
    options.wait_for_lgtm = not options.force
    options.force_readline_defaults = not options.manual
    options.force_upload = not options.manual

    # Process script specific options.
    if not self._ProcessOptions(options):
      parser.print_help()
      return None

    if not options.work_dir:
      options.work_dir = "/tmp/v8-release-scripts-work-dir"
    return options

  def RunSteps(self, step_classes, args=None):
    options = self.MakeOptions(args)
    if not options:
      return 1

    state_file = "%s-state.json" % self._config["PERSISTFILE_BASENAME"]
    if options.step == 0 and os.path.exists(state_file):
      os.remove(state_file)

    steps = []
    for (number, step_class) in enumerate([BootstrapStep] + step_classes):
      steps.append(MakeStep(step_class, number, self._state, self._config,
                            options, self._side_effect_handler))
    for step in steps[options.step:]:
      if step.Run():
        return 0
    return 0

  def Run(self, args=None):
    return self.RunSteps(self._Steps(), args)
node-v4.8.2/deps/v8/tools/release/create_release.py000755 000766 000024 00000023271 13070706735 022355 0ustar00iojsstaff000000 000000 #!/usr/bin/env python
# Copyright 2015 the V8 project authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

import argparse
import os
import sys
import tempfile
import urllib2

from common_includes import *


class Preparation(Step):
  MESSAGE = "Preparation."

  def RunStep(self):
    fetchspecs = [
      "+refs/heads/*:refs/heads/*",
      "+refs/pending/*:refs/pending/*",
      "+refs/pending-tags/*:refs/pending-tags/*",
    ]
    self.Git("fetch origin %s" % " ".join(fetchspecs))
    self.GitCheckout("origin/master")
    self.DeleteBranch("work-branch")


class PrepareBranchRevision(Step):
  MESSAGE = "Check from which revision to branch off."

  def RunStep(self):
    self["push_hash"] = (self._options.revision or
                         self.GitLog(n=1, format="%H", branch="origin/master"))
    assert self["push_hash"]
    print "Release revision %s" % self["push_hash"]


class IncrementVersion(Step):
  MESSAGE = "Increment version number."

  def RunStep(self):
    latest_version = self.GetLatestVersion()

    # The version file on master can be used to bump up major/minor at
    # branch time.
    self.GitCheckoutFile(VERSION_FILE, self.vc.RemoteMasterBranch())
    self.ReadAndPersistVersion("master_")
    master_version = self.ArrayToVersion("master_")

    # Use the highest version from master or from tags to determine the new
    # version.
    authoritative_version = sorted(
        [master_version, latest_version], key=SortingKey)[1]
    self.StoreVersion(authoritative_version, "authoritative_")

    # Variables prefixed with 'new_' contain the new version numbers for the
    # ongoing candidates push.
    self["new_major"] = self["authoritative_major"]
    self["new_minor"] = self["authoritative_minor"]
    self["new_build"] = str(int(self["authoritative_build"]) + 1)

    # Make sure patch level is 0 in a new push.
    self["new_patch"] = "0"

    # The new version is not a candidate.
    self["new_candidate"] = "0"

    self["version"] = "%s.%s.%s" % (self["new_major"],
                                    self["new_minor"],
                                    self["new_build"])

    print ("Incremented version to %s" % self["version"])


class DetectLastRelease(Step):
  MESSAGE = "Detect commit ID of last release base."

  def RunStep(self):
    self["last_push_master"] = self.GetLatestReleaseBase()


class PrepareChangeLog(Step):
  MESSAGE = "Prepare raw ChangeLog entry."

  def Reload(self, body):
    """Attempts to reload the commit message from rietveld in order to allow
    late changes to the LOG flag. Note: This is brittle to future changes of
    the web page name or structure.
    """
    match = re.search(r"^Review URL: https://codereview\.chromium\.org/(\d+)$",
                      body, flags=re.M)
    if match:
      cl_url = ("https://codereview.chromium.org/%s/description"
                % match.group(1))
      try:
        # Fetch from Rietveld but only retry once with one second delay since
        # there might be many revisions.
        body = self.ReadURL(cl_url, wait_plan=[1])
      except urllib2.URLError:  # pragma: no cover
        pass
    return body

  def RunStep(self):
    self["date"] = self.GetDate()
    output = "%s: Version %s\n\n" % (self["date"], self["version"])
    TextToFile(output, self.Config("CHANGELOG_ENTRY_FILE"))
    commits = self.GitLog(format="%H",
        git_hash="%s..%s" % (self["last_push_master"],
                             self["push_hash"]))

    # Cache raw commit messages.
    commit_messages = [
      [
        self.GitLog(n=1, format="%s", git_hash=commit),
        self.Reload(self.GitLog(n=1, format="%B", git_hash=commit)),
        self.GitLog(n=1, format="%an", git_hash=commit),
      ] for commit in commits.splitlines()
    ]

    # Auto-format commit messages.
    body = MakeChangeLogBody(commit_messages, auto_format=True)
    AppendToFile(body, self.Config("CHANGELOG_ENTRY_FILE"))

    msg = ("        Performance and stability improvements on all platforms."
           "\n#\n# The change log above is auto-generated. Please review if "
           "all relevant\n# commit messages from the list below are included."
           "\n# All lines starting with # will be stripped.\n#\n")
    AppendToFile(msg, self.Config("CHANGELOG_ENTRY_FILE"))

    # Include unformatted commit messages as a reference in a comment.
    comment_body = MakeComment(MakeChangeLogBody(commit_messages))
    AppendToFile(comment_body, self.Config("CHANGELOG_ENTRY_FILE"))


class EditChangeLog(Step):
  MESSAGE = "Edit ChangeLog entry."

  def RunStep(self):
    print ("Please press  to have your EDITOR open the ChangeLog "
           "entry, then edit its contents to your liking. When you're done, "
           "save the file and exit your EDITOR. ")
    self.ReadLine(default="")
    self.Editor(self.Config("CHANGELOG_ENTRY_FILE"))

    # Strip comments and reformat with correct indentation.
    changelog_entry = FileToText(self.Config("CHANGELOG_ENTRY_FILE")).rstrip()
    changelog_entry = StripComments(changelog_entry)
    changelog_entry = "\n".join(map(Fill80, changelog_entry.splitlines()))
    changelog_entry = changelog_entry.lstrip()

    if changelog_entry == "":  # pragma: no cover
      self.Die("Empty ChangeLog entry.")

    # Safe new change log for adding it later to the candidates patch.
    TextToFile(changelog_entry, self.Config("CHANGELOG_ENTRY_FILE"))


class MakeBranch(Step):
  MESSAGE = "Create the branch."

  def RunStep(self):
    self.Git("reset --hard origin/master")
    self.Git("checkout -b work-branch %s" % self["push_hash"])
    self.GitCheckoutFile(CHANGELOG_FILE, self["latest_version"])
    self.GitCheckoutFile(VERSION_FILE, self["latest_version"])


class AddChangeLog(Step):
  MESSAGE = "Add ChangeLog changes to release branch."

  def RunStep(self):
    changelog_entry = FileToText(self.Config("CHANGELOG_ENTRY_FILE"))
    old_change_log = FileToText(os.path.join(self.default_cwd, CHANGELOG_FILE))
    new_change_log = "%s\n\n\n%s" % (changelog_entry, old_change_log)
    TextToFile(new_change_log, os.path.join(self.default_cwd, CHANGELOG_FILE))


class SetVersion(Step):
  MESSAGE = "Set correct version for candidates."

  def RunStep(self):
    self.SetVersion(os.path.join(self.default_cwd, VERSION_FILE), "new_")


class CommitBranch(Step):
  MESSAGE = "Commit version and changelog to new branch."

  def RunStep(self):
    # Convert the ChangeLog entry to commit message format.
    text = FileToText(self.Config("CHANGELOG_ENTRY_FILE"))

    # Remove date and trailing white space.
    text = re.sub(r"^%s: " % self["date"], "", text.rstrip())

    # Remove indentation and merge paragraphs into single long lines, keeping
    # empty lines between them.
    def SplitMapJoin(split_text, fun, join_text):
      return lambda text: join_text.join(map(fun, text.split(split_text)))
    text = SplitMapJoin(
        "\n\n", SplitMapJoin("\n", str.strip, " "), "\n\n")(text)

    if not text:  # pragma: no cover
      self.Die("Commit message editing failed.")
    self["commit_title"] = text.splitlines()[0]
    TextToFile(text, self.Config("COMMITMSG_FILE"))

    self.GitCommit(file_name = self.Config("COMMITMSG_FILE"))
    os.remove(self.Config("COMMITMSG_FILE"))
    os.remove(self.Config("CHANGELOG_ENTRY_FILE"))


class PushBranch(Step):
  MESSAGE = "Push changes."

  def RunStep(self):
    pushspecs = [
      "refs/heads/work-branch:refs/pending/heads/%s" % self["version"],
      "%s:refs/pending-tags/heads/%s" % (self["push_hash"], self["version"]),
      "%s:refs/heads/%s" % (self["push_hash"], self["version"]),
    ]
    cmd = "push origin %s" % " ".join(pushspecs)
    if self._options.dry_run:
      print "Dry run. Command:\ngit %s" % cmd
    else:
      self.Git(cmd)


class TagRevision(Step):
  MESSAGE = "Tag the new revision."

  def RunStep(self):
    if self._options.dry_run:
      print ("Dry run. Tagging \"%s\" with %s" %
             (self["commit_title"], self["version"]))
    else:
      self.vc.Tag(self["version"],
                  "origin/%s" % self["version"],
                  self["commit_title"])


class CleanUp(Step):
  MESSAGE = "Done!"

  def RunStep(self):
    print("Congratulations, you have successfully created version %s."
          % self["version"])

    self.GitCheckout("origin/master")
    self.DeleteBranch("work-branch")
    self.Git("gc")


class CreateRelease(ScriptsBase):
  def _PrepareOptions(self, parser):
    group = parser.add_mutually_exclusive_group()
    group.add_argument("-f", "--force",
                      help="Don't prompt the user.",
                      default=True, action="store_true")
    group.add_argument("-m", "--manual",
                      help="Prompt the user at every important step.",
                      default=False, action="store_true")
    parser.add_argument("-R", "--revision",
                        help="The git commit ID to push (defaults to HEAD).")

  def _ProcessOptions(self, options):  # pragma: no cover
    if not options.author or not options.reviewer:
      print "Reviewer (-r) and author (-a) are required."
      return False
    return True

  def _Config(self):
    return {
      "PERSISTFILE_BASENAME": "/tmp/create-releases-tempfile",
      "CHANGELOG_ENTRY_FILE":
          "/tmp/v8-create-releases-tempfile-changelog-entry",
      "COMMITMSG_FILE": "/tmp/v8-create-releases-tempfile-commitmsg",
    }

  def _Steps(self):
    return [
      Preparation,
      PrepareBranchRevision,
      IncrementVersion,
      DetectLastRelease,
      PrepareChangeLog,
      EditChangeLog,
      MakeBranch,
      AddChangeLog,
      SetVersion,
      CommitBranch,
      PushBranch,
      TagRevision,
      CleanUp,
    ]


if __name__ == "__main__":  # pragma: no cover
  sys.exit(CreateRelease().Run())
node-v4.8.2/deps/v8/tools/release/git_recipes.py000644 000766 000024 00000022410 13070706735 021676 0ustar00iojsstaff000000 000000 #!/usr/bin/env python
# Copyright 2014 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

import re

SHA1_RE = re.compile('^[a-fA-F0-9]{40}$')
ROLL_DEPS_GIT_SVN_ID_RE = re.compile('^git-svn-id: .*@([0-9]+) .*$')

# Regular expression that matches a single commit footer line.
COMMIT_FOOTER_ENTRY_RE = re.compile(r'([^:]+):\s+(.+)')

# Footer metadata key for commit position.
COMMIT_POSITION_FOOTER_KEY = 'Cr-Commit-Position'

# Regular expression to parse a commit position
COMMIT_POSITION_RE = re.compile(r'(.+)@\{#(\d+)\}')

# Key for the 'git-svn' ID metadata commit footer entry.
GIT_SVN_ID_FOOTER_KEY = 'git-svn-id'

# e.g., git-svn-id: https://v8.googlecode.com/svn/trunk@23117
#     ce2b1a6d-e550-0410-aec6-3dcde31c8c00
GIT_SVN_ID_RE = re.compile(r'[^@]+@(\d+)\s+(?:[a-zA-Z0-9\-]+)')


# Copied from bot_update.py.
def GetCommitMessageFooterMap(message):
  """Returns: (dict) A dictionary of commit message footer entries.
  """
  footers = {}

  # Extract the lines in the footer block.
  lines = []
  for line in message.strip().splitlines():
    line = line.strip()
    if len(line) == 0:
      del(lines[:])
      continue
    lines.append(line)

  # Parse the footer
  for line in lines:
    m = COMMIT_FOOTER_ENTRY_RE.match(line)
    if not m:
      # If any single line isn't valid, the entire footer is invalid.
      footers.clear()
      return footers
    footers[m.group(1)] = m.group(2).strip()
  return footers


class GitFailedException(Exception):
  pass


def Strip(f):
  def new_f(*args, **kwargs):
    result = f(*args, **kwargs)
    if result is None:
      return result
    else:
      return result.strip()
  return new_f


def MakeArgs(l):
  """['-a', '', 'abc', ''] -> '-a abc'"""
  return " ".join(filter(None, l))


def Quoted(s):
  return "\"%s\"" % s


class GitRecipesMixin(object):
  def GitIsWorkdirClean(self, **kwargs):
    return self.Git("status -s -uno", **kwargs).strip() == ""

  @Strip
  def GitBranch(self, **kwargs):
    return self.Git("branch", **kwargs)

  def GitCreateBranch(self, name, remote="", **kwargs):
    assert name
    remote_args = ["--upstream", remote] if remote else []
    self.Git(MakeArgs(["new-branch", name] + remote_args), **kwargs)

  def GitDeleteBranch(self, name, **kwargs):
    assert name
    self.Git(MakeArgs(["branch -D", name]), **kwargs)

  def GitReset(self, name, **kwargs):
    assert name
    self.Git(MakeArgs(["reset --hard", name]), **kwargs)

  def GitStash(self, **kwargs):
    self.Git(MakeArgs(["stash"]), **kwargs)

  def GitRemotes(self, **kwargs):
    return map(str.strip,
               self.Git(MakeArgs(["branch -r"]), **kwargs).splitlines())

  def GitCheckout(self, name, **kwargs):
    assert name
    self.Git(MakeArgs(["checkout -f", name]), **kwargs)

  def GitCheckoutFile(self, name, branch_or_hash, **kwargs):
    assert name
    assert branch_or_hash
    self.Git(MakeArgs(["checkout -f", branch_or_hash, "--", name]), **kwargs)

  def GitCheckoutFileSafe(self, name, branch_or_hash, **kwargs):
    try:
      self.GitCheckoutFile(name, branch_or_hash, **kwargs)
    except GitFailedException:  # pragma: no cover
      # The file doesn't exist in that revision.
      return False
    return True

  def GitChangedFiles(self, git_hash, **kwargs):
    assert git_hash
    try:
      files = self.Git(MakeArgs(["diff --name-only",
                                 git_hash,
                                 "%s^" % git_hash]), **kwargs)
      return map(str.strip, files.splitlines())
    except GitFailedException:  # pragma: no cover
      # Git fails using "^" at branch roots.
      return []


  @Strip
  def GitCurrentBranch(self, **kwargs):
    for line in self.Git("status -s -b -uno", **kwargs).strip().splitlines():
      match = re.match(r"^## (.+)", line)
      if match: return match.group(1)
    raise Exception("Couldn't find curent branch.")  # pragma: no cover

  @Strip
  def GitLog(self, n=0, format="", grep="", git_hash="", parent_hash="",
             branch="", path=None, reverse=False, **kwargs):
    assert not (git_hash and parent_hash)
    args = ["log"]
    if n > 0:
      args.append("-%d" % n)
    if format:
      args.append("--format=%s" % format)
    if grep:
      args.append("--grep=\"%s\"" % grep.replace("\"", "\\\""))
    if reverse:
      args.append("--reverse")
    if git_hash:
      args.append(git_hash)
    if parent_hash:
      args.append("%s^" % parent_hash)
    args.append(branch)
    if path:
      args.extend(["--", path])
    return self.Git(MakeArgs(args), **kwargs)

  def GitShowFile(self, refspec, path, **kwargs):
    assert refspec
    assert path
    return self.Git(MakeArgs(["show", "%s:%s" % (refspec, path)]), **kwargs)

  def GitGetPatch(self, git_hash, **kwargs):
    assert git_hash
    return self.Git(MakeArgs(["log", "-1", "-p", git_hash]), **kwargs)

  # TODO(machenbach): Unused? Remove.
  def GitAdd(self, name, **kwargs):
    assert name
    self.Git(MakeArgs(["add", Quoted(name)]), **kwargs)

  def GitApplyPatch(self, patch_file, reverse=False, **kwargs):
    assert patch_file
    args = ["apply --index --reject"]
    if reverse:
      args.append("--reverse")
    args.append(Quoted(patch_file))
    self.Git(MakeArgs(args), **kwargs)

  def GitUpload(self, reviewer="", author="", force=False, cq=False,
                bypass_hooks=False, cc="", **kwargs):
    args = ["cl upload --send-mail"]
    if author:
      args += ["--email", Quoted(author)]
    if reviewer:
      args += ["-r", Quoted(reviewer)]
    if force:
      args.append("-f")
    if cq:
      args.append("--use-commit-queue")
    if bypass_hooks:
      args.append("--bypass-hooks")
    if cc:
      args += ["--cc", Quoted(cc)]
    # TODO(machenbach): Check output in forced mode. Verify that all required
    # base files were uploaded, if not retry.
    self.Git(MakeArgs(args), pipe=False, **kwargs)

  def GitCommit(self, message="", file_name="", author=None, **kwargs):
    assert message or file_name
    args = ["commit"]
    if file_name:
      args += ["-aF", Quoted(file_name)]
    if message:
      args += ["-am", Quoted(message)]
    if author:
      args += ["--author", "\"%s <%s>\"" % (author, author)]
    self.Git(MakeArgs(args), **kwargs)

  def GitPresubmit(self, **kwargs):
    self.Git("cl presubmit", "PRESUBMIT_TREE_CHECK=\"skip\"", **kwargs)

  def GitCLLand(self, **kwargs):
    self.Git(
        "cl land -f --bypass-hooks", retry_on=lambda x: x is None, **kwargs)

  def GitDiff(self, loc1, loc2, **kwargs):
    return self.Git(MakeArgs(["diff", loc1, loc2]), **kwargs)

  def GitPull(self, **kwargs):
    self.Git("pull", **kwargs)

  def GitFetchOrigin(self, *refspecs, **kwargs):
    self.Git(MakeArgs(["fetch", "origin"] + list(refspecs)), **kwargs)

  @Strip
  # Copied from bot_update.py and modified for svn-like numbers only.
  def GetCommitPositionNumber(self, git_hash, **kwargs):
    """Dumps the 'git' log for a specific revision and parses out the commit
    position number.

    If a commit position metadata key is found, its number will be returned.

    Otherwise, we will search for a 'git-svn' metadata entry. If one is found,
    its SVN revision value is returned.
    """
    git_log = self.GitLog(format='%B', n=1, git_hash=git_hash, **kwargs)
    footer_map = GetCommitMessageFooterMap(git_log)

    # Search for commit position metadata
    value = footer_map.get(COMMIT_POSITION_FOOTER_KEY)
    if value:
      match = COMMIT_POSITION_RE.match(value)
      if match:
        return match.group(2)

    # Extract the svn revision from 'git-svn' metadata
    value = footer_map.get(GIT_SVN_ID_FOOTER_KEY)
    if value:
      match = GIT_SVN_ID_RE.match(value)
      if match:
        return match.group(1)
    raise GitFailedException("Couldn't determine commit position for %s" %
                             git_hash)

  def GitGetHashOfTag(self, tag_name, **kwargs):
    return self.Git("rev-list -1 " + tag_name).strip().encode("ascii", "ignore")
node-v4.8.2/deps/v8/tools/release/merge_to_branch.py000755 000766 000024 00000026701 13070706735 022531 0ustar00iojsstaff000000 000000 #!/usr/bin/env python
# Copyright 2014 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

import argparse
from collections import OrderedDict
import sys

from common_includes import *

def IsSvnNumber(rev):
  return rev.isdigit() and len(rev) < 8

class Preparation(Step):
  MESSAGE = "Preparation."

  def RunStep(self):
    if os.path.exists(self.Config("ALREADY_MERGING_SENTINEL_FILE")):
      if self._options.force:
        os.remove(self.Config("ALREADY_MERGING_SENTINEL_FILE"))
      elif self._options.step == 0:  # pragma: no cover
        self.Die("A merge is already in progress")
    open(self.Config("ALREADY_MERGING_SENTINEL_FILE"), "a").close()

    self.InitialEnvironmentChecks(self.default_cwd)
    if self._options.revert_master:
      # FIXME(machenbach): Make revert master obsolete?
      self["merge_to_branch"] = "master"
    elif self._options.branch:
      self["merge_to_branch"] = self._options.branch
    else:  # pragma: no cover
      self.Die("Please specify a branch to merge to")

    self.CommonPrepare()
    self.PrepareBranch()


class CreateBranch(Step):
  MESSAGE = "Create a fresh branch for the patch."

  def RunStep(self):
    self.GitCreateBranch(self.Config("BRANCHNAME"),
                         self.vc.RemoteBranch(self["merge_to_branch"]))


class SearchArchitecturePorts(Step):
  MESSAGE = "Search for corresponding architecture ports."

  def RunStep(self):
    self["full_revision_list"] = list(OrderedDict.fromkeys(
        self._options.revisions))
    port_revision_list = []
    for revision in self["full_revision_list"]:
      # Search for commits which matches the "Port XXX" pattern.
      git_hashes = self.GitLog(reverse=True, format="%H",
                               grep="Port %s" % revision,
                               branch=self.vc.RemoteMasterBranch())
      for git_hash in git_hashes.splitlines():
        revision_title = self.GitLog(n=1, format="%s", git_hash=git_hash)

        # Is this revision included in the original revision list?
        if git_hash in self["full_revision_list"]:
          print("Found port of %s -> %s (already included): %s"
                % (revision, git_hash, revision_title))
        else:
          print("Found port of %s -> %s: %s"
                % (revision, git_hash, revision_title))
          port_revision_list.append(git_hash)

    # Do we find any port?
    if len(port_revision_list) > 0:
      if self.Confirm("Automatically add corresponding ports (%s)?"
                      % ", ".join(port_revision_list)):
        #: 'y': Add ports to revision list.
        self["full_revision_list"].extend(port_revision_list)


class CreateCommitMessage(Step):
  MESSAGE = "Create commit message."

  def RunStep(self):

    # Stringify: [123, 234] -> "r123, r234"
    self["revision_list"] = ", ".join(map(lambda s: "r%s" % s,
                                      self["full_revision_list"]))

    if not self["revision_list"]:  # pragma: no cover
      self.Die("Revision list is empty.")

    if self._options.revert and not self._options.revert_master:
      action_text = "Rollback of %s"
    else:
      action_text = "Merged %s"

    # The commit message title is added below after the version is specified.
    msg_pieces = [
      "\n".join(action_text % s for s in self["full_revision_list"]),
    ]
    msg_pieces.append("\n\n")

    for commit_hash in self["full_revision_list"]:
      patch_merge_desc = self.GitLog(n=1, format="%s", git_hash=commit_hash)
      msg_pieces.append("%s\n\n" % patch_merge_desc)

    bugs = []
    for commit_hash in self["full_revision_list"]:
      msg = self.GitLog(n=1, git_hash=commit_hash)
      for bug in re.findall(r"^[ \t]*BUG[ \t]*=[ \t]*(.*?)[ \t]*$", msg, re.M):
        bugs.extend(s.strip() for s in bug.split(","))
    bug_aggregate = ",".join(sorted(filter(lambda s: s and s != "none", bugs)))
    if bug_aggregate:
      msg_pieces.append("BUG=%s\nLOG=N\n" % bug_aggregate)

    self["new_commit_msg"] = "".join(msg_pieces)


class ApplyPatches(Step):
  MESSAGE = "Apply patches for selected revisions."

  def RunStep(self):
    for commit_hash in self["full_revision_list"]:
      print("Applying patch for %s to %s..."
            % (commit_hash, self["merge_to_branch"]))
      patch = self.GitGetPatch(commit_hash)
      TextToFile(patch, self.Config("TEMPORARY_PATCH_FILE"))
      self.ApplyPatch(self.Config("TEMPORARY_PATCH_FILE"), self._options.revert)
    if self._options.patch:
      self.ApplyPatch(self._options.patch, self._options.revert)


class PrepareVersion(Step):
  MESSAGE = "Prepare version file."

  def RunStep(self):
    if self._options.revert_master:
      return
    # This is used to calculate the patch level increment.
    self.ReadAndPersistVersion()


class IncrementVersion(Step):
  MESSAGE = "Increment version number."

  def RunStep(self):
    if self._options.revert_master:
      return
    new_patch = str(int(self["patch"]) + 1)
    if self.Confirm("Automatically increment V8_PATCH_LEVEL? (Saying 'n' will "
                    "fire up your EDITOR on %s so you can make arbitrary "
                    "changes. When you're done, save the file and exit your "
                    "EDITOR.)" % VERSION_FILE):
      text = FileToText(os.path.join(self.default_cwd, VERSION_FILE))
      text = MSub(r"(?<=#define V8_PATCH_LEVEL)(?P\s+)\d*$",
                  r"\g%s" % new_patch,
                  text)
      TextToFile(text, os.path.join(self.default_cwd, VERSION_FILE))
    else:
      self.Editor(os.path.join(self.default_cwd, VERSION_FILE))
    self.ReadAndPersistVersion("new_")
    self["version"] = "%s.%s.%s.%s" % (self["new_major"],
                                       self["new_minor"],
                                       self["new_build"],
                                       self["new_patch"])


class CommitLocal(Step):
  MESSAGE = "Commit to local branch."

  def RunStep(self):
    # Add a commit message title.
    if self._options.revert and self._options.revert_master:
      # TODO(machenbach): Find a better convention if multiple patches are
      # reverted in one CL.
      self["commit_title"] = "Revert on master"
    else:
      self["commit_title"] = "Version %s (cherry-pick)" % self["version"]
    self["new_commit_msg"] = "%s\n\n%s" % (self["commit_title"],
                                           self["new_commit_msg"])
    TextToFile(self["new_commit_msg"], self.Config("COMMITMSG_FILE"))
    self.GitCommit(file_name=self.Config("COMMITMSG_FILE"))


class CommitRepository(Step):
  MESSAGE = "Commit to the repository."

  def RunStep(self):
    self.GitCheckout(self.Config("BRANCHNAME"))
    self.WaitForLGTM()
    self.GitPresubmit()
    self.vc.CLLand()


class TagRevision(Step):
  MESSAGE = "Create the tag."

  def RunStep(self):
    if self._options.revert_master:
      return
    print "Creating tag %s" % self["version"]
    self.vc.Tag(self["version"],
                self.vc.RemoteBranch(self["merge_to_branch"]),
                self["commit_title"])


class CleanUp(Step):
  MESSAGE = "Cleanup."

  def RunStep(self):
    self.CommonCleanup()
    if not self._options.revert_master:
      print "*** SUMMARY ***"
      print "version: %s" % self["version"]
      print "branch: %s" % self["merge_to_branch"]
      if self["revision_list"]:
        print "patches: %s" % self["revision_list"]


class MergeToBranch(ScriptsBase):
  def _Description(self):
    return ("Performs the necessary steps to merge revisions from "
            "master to other branches, including candidates.")

  def _PrepareOptions(self, parser):
    group = parser.add_mutually_exclusive_group(required=True)
    group.add_argument("--branch", help="The branch to merge to.")
    group.add_argument("-R", "--revert-master",
                       help="Revert specified patches from master.",
                       default=False, action="store_true")
    parser.add_argument("revisions", nargs="*",
                        help="The revisions to merge.")
    parser.add_argument("-f", "--force",
                        help="Delete sentinel file.",
                        default=False, action="store_true")
    parser.add_argument("-m", "--message",
                        help="A commit message for the patch.")
    parser.add_argument("--revert",
                        help="Revert specified patches.",
                        default=False, action="store_true")
    parser.add_argument("-p", "--patch",
                        help="A patch file to apply as part of the merge.")

  def _ProcessOptions(self, options):
    # TODO(machenbach): Add a test that covers revert from master
    if len(options.revisions) < 1:
      if not options.patch:
        print "Either a patch file or revision numbers must be specified"
        return False
      if not options.message:
        print "You must specify a merge comment if no patches are specified"
        return False
    options.bypass_upload_hooks = True
    # CC ulan to make sure that fixes are merged to Google3.
    options.cc = "ulan@chromium.org"

    # Make sure to use git hashes in the new workflows.
    for revision in options.revisions:
      if (IsSvnNumber(revision) or
          (revision[0:1] == "r" and IsSvnNumber(revision[1:]))):
        print "Please provide full git hashes of the patches to merge."
        print "Got: %s" % revision
        return False
    return True

  def _Config(self):
    return {
      "BRANCHNAME": "prepare-merge",
      "PERSISTFILE_BASENAME": "/tmp/v8-merge-to-branch-tempfile",
      "ALREADY_MERGING_SENTINEL_FILE":
          "/tmp/v8-merge-to-branch-tempfile-already-merging",
      "TEMPORARY_PATCH_FILE": "/tmp/v8-prepare-merge-tempfile-temporary-patch",
      "COMMITMSG_FILE": "/tmp/v8-prepare-merge-tempfile-commitmsg",
    }

  def _Steps(self):
    return [
      Preparation,
      CreateBranch,
      SearchArchitecturePorts,
      CreateCommitMessage,
      ApplyPatches,
      PrepareVersion,
      IncrementVersion,
      CommitLocal,
      UploadStep,
      CommitRepository,
      TagRevision,
      CleanUp,
    ]


if __name__ == "__main__":  # pragma: no cover
  sys.exit(MergeToBranch().Run())
node-v4.8.2/deps/v8/tools/release/mergeinfo.py000755 000766 000024 00000002661 13070706735 021365 0ustar00iojsstaff000000 000000 #!/usr/bin/env python
# Copyright 2015 the V8 project authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

import argparse
import os
import sys

from subprocess import call

def print_analysis(gitWorkingDir, hashToSearch):
  print '1.) Info'
  git_execute(gitWorkingDir, ['status'])
  print '2.) Searching for "' + hashToSearch + '"'
  print '=====================ORIGINAL COMMIT START====================='
  git_execute(gitWorkingDir, ['show', hashToSearch])
  print '=====================ORIGINAL COMMIT END====================='
  print '#####################FOUND MERGES & REVERTS START#####################'
  git_execute(gitWorkingDir, ["log",'--all', '--grep='+hashToSearch])
  print '#####################FOUND MERGES & REVERTS END#####################'
  print 'Finished successfully'

def git_execute(workingDir, commands):
  return call(["git", '-C', workingDir] + commands)

if __name__ == "__main__":  # pragma: no cover
  parser = argparse.ArgumentParser('Tool to check where a git commit was merged and reverted.')
  parser.add_argument("-g", "--git-dir", required=False, default='.',
                        help="The path to your git working directory.")

  parser.add_argument('hash', nargs=1, help="Hash of the commit to be searched.")

  args = sys.argv[1:]
  options = parser.parse_args(args)

  sys.exit(print_analysis(options.git_dir, options.hash[0]))
node-v4.8.2/deps/v8/tools/release/push_to_candidates.py000755 000766 000024 00000034516 13070706735 023256 0ustar00iojsstaff000000 000000 #!/usr/bin/env python
# Copyright 2013 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

import argparse
import os
import sys
import tempfile
import urllib2

from common_includes import *

PUSH_MSG_GIT_SUFFIX = " (based on %s)"


class Preparation(Step):
  MESSAGE = "Preparation."

  def RunStep(self):
    self.InitialEnvironmentChecks(self.default_cwd)
    self.CommonPrepare()

    if(self["current_branch"] == self.Config("CANDIDATESBRANCH")
       or self["current_branch"] == self.Config("BRANCHNAME")):
      print "Warning: Script started on branch %s" % self["current_branch"]

    self.PrepareBranch()
    self.DeleteBranch(self.Config("CANDIDATESBRANCH"))


class FreshBranch(Step):
  MESSAGE = "Create a fresh branch."

  def RunStep(self):
    self.GitCreateBranch(self.Config("BRANCHNAME"),
                         self.vc.RemoteMasterBranch())


class PreparePushRevision(Step):
  MESSAGE = "Check which revision to push."

  def RunStep(self):
    if self._options.revision:
      self["push_hash"] = self._options.revision
    else:
      self["push_hash"] = self.GitLog(n=1, format="%H", git_hash="HEAD")
    if not self["push_hash"]:  # pragma: no cover
      self.Die("Could not determine the git hash for the push.")


class IncrementVersion(Step):
  MESSAGE = "Increment version number."

  def RunStep(self):
    latest_version = self.GetLatestVersion()

    # The version file on master can be used to bump up major/minor at
    # branch time.
    self.GitCheckoutFile(VERSION_FILE, self.vc.RemoteMasterBranch())
    self.ReadAndPersistVersion("master_")
    master_version = self.ArrayToVersion("master_")

    # Use the highest version from master or from tags to determine the new
    # version.
    authoritative_version = sorted(
        [master_version, latest_version], key=SortingKey)[1]
    self.StoreVersion(authoritative_version, "authoritative_")

    # Variables prefixed with 'new_' contain the new version numbers for the
    # ongoing candidates push.
    self["new_major"] = self["authoritative_major"]
    self["new_minor"] = self["authoritative_minor"]
    self["new_build"] = str(int(self["authoritative_build"]) + 1)

    # Make sure patch level is 0 in a new push.
    self["new_patch"] = "0"

    self["version"] = "%s.%s.%s" % (self["new_major"],
                                    self["new_minor"],
                                    self["new_build"])

    print ("Incremented version to %s" % self["version"])


class DetectLastRelease(Step):
  MESSAGE = "Detect commit ID of last release base."

  def RunStep(self):
    if self._options.last_master:
      self["last_push_master"] = self._options.last_master
    else:
      self["last_push_master"] = self.GetLatestReleaseBase()


class PrepareChangeLog(Step):
  MESSAGE = "Prepare raw ChangeLog entry."

  def Reload(self, body):
    """Attempts to reload the commit message from rietveld in order to allow
    late changes to the LOG flag. Note: This is brittle to future changes of
    the web page name or structure.
    """
    match = re.search(r"^Review URL: https://codereview\.chromium\.org/(\d+)$",
                      body, flags=re.M)
    if match:
      cl_url = ("https://codereview.chromium.org/%s/description"
                % match.group(1))
      try:
        # Fetch from Rietveld but only retry once with one second delay since
        # there might be many revisions.
        body = self.ReadURL(cl_url, wait_plan=[1])
      except urllib2.URLError:  # pragma: no cover
        pass
    return body

  def RunStep(self):
    self["date"] = self.GetDate()
    output = "%s: Version %s\n\n" % (self["date"], self["version"])
    TextToFile(output, self.Config("CHANGELOG_ENTRY_FILE"))
    commits = self.GitLog(format="%H",
        git_hash="%s..%s" % (self["last_push_master"],
                             self["push_hash"]))

    # Cache raw commit messages.
    commit_messages = [
      [
        self.GitLog(n=1, format="%s", git_hash=commit),
        self.Reload(self.GitLog(n=1, format="%B", git_hash=commit)),
        self.GitLog(n=1, format="%an", git_hash=commit),
      ] for commit in commits.splitlines()
    ]

    # Auto-format commit messages.
    body = MakeChangeLogBody(commit_messages, auto_format=True)
    AppendToFile(body, self.Config("CHANGELOG_ENTRY_FILE"))

    msg = ("        Performance and stability improvements on all platforms."
           "\n#\n# The change log above is auto-generated. Please review if "
           "all relevant\n# commit messages from the list below are included."
           "\n# All lines starting with # will be stripped.\n#\n")
    AppendToFile(msg, self.Config("CHANGELOG_ENTRY_FILE"))

    # Include unformatted commit messages as a reference in a comment.
    comment_body = MakeComment(MakeChangeLogBody(commit_messages))
    AppendToFile(comment_body, self.Config("CHANGELOG_ENTRY_FILE"))


class EditChangeLog(Step):
  MESSAGE = "Edit ChangeLog entry."

  def RunStep(self):
    print ("Please press  to have your EDITOR open the ChangeLog "
           "entry, then edit its contents to your liking. When you're done, "
           "save the file and exit your EDITOR. ")
    self.ReadLine(default="")
    self.Editor(self.Config("CHANGELOG_ENTRY_FILE"))

    # Strip comments and reformat with correct indentation.
    changelog_entry = FileToText(self.Config("CHANGELOG_ENTRY_FILE")).rstrip()
    changelog_entry = StripComments(changelog_entry)
    changelog_entry = "\n".join(map(Fill80, changelog_entry.splitlines()))
    changelog_entry = changelog_entry.lstrip()

    if changelog_entry == "":  # pragma: no cover
      self.Die("Empty ChangeLog entry.")

    # Safe new change log for adding it later to the candidates patch.
    TextToFile(changelog_entry, self.Config("CHANGELOG_ENTRY_FILE"))


class StragglerCommits(Step):
  MESSAGE = ("Fetch straggler commits that sneaked in since this script was "
             "started.")

  def RunStep(self):
    self.vc.Fetch()
    self.GitCheckout(self.vc.RemoteMasterBranch())


class SquashCommits(Step):
  MESSAGE = "Squash commits into one."

  def RunStep(self):
    # Instead of relying on "git rebase -i", we'll just create a diff, because
    # that's easier to automate.
    TextToFile(self.GitDiff(self.vc.RemoteCandidateBranch(),
                            self["push_hash"]),
               self.Config("PATCH_FILE"))

    # Convert the ChangeLog entry to commit message format.
    text = FileToText(self.Config("CHANGELOG_ENTRY_FILE"))

    # Remove date and trailing white space.
    text = re.sub(r"^%s: " % self["date"], "", text.rstrip())

    # Show the used master hash in the commit message.
    suffix = PUSH_MSG_GIT_SUFFIX % self["push_hash"]
    text = MSub(r"^(Version \d+\.\d+\.\d+)$", "\\1%s" % suffix, text)

    # Remove indentation and merge paragraphs into single long lines, keeping
    # empty lines between them.
    def SplitMapJoin(split_text, fun, join_text):
      return lambda text: join_text.join(map(fun, text.split(split_text)))
    strip = lambda line: line.strip()
    text = SplitMapJoin("\n\n", SplitMapJoin("\n", strip, " "), "\n\n")(text)

    if not text:  # pragma: no cover
      self.Die("Commit message editing failed.")
    self["commit_title"] = text.splitlines()[0]
    TextToFile(text, self.Config("COMMITMSG_FILE"))


class NewBranch(Step):
  MESSAGE = "Create a new branch from candidates."

  def RunStep(self):
    self.GitCreateBranch(self.Config("CANDIDATESBRANCH"),
                         self.vc.RemoteCandidateBranch())


class ApplyChanges(Step):
  MESSAGE = "Apply squashed changes."

  def RunStep(self):
    self.ApplyPatch(self.Config("PATCH_FILE"))
    os.remove(self.Config("PATCH_FILE"))
    # The change log has been modified by the patch. Reset it to the version
    # on candidates and apply the exact changes determined by this
    # PrepareChangeLog step above.
    self.GitCheckoutFile(CHANGELOG_FILE, self.vc.RemoteCandidateBranch())
    # The version file has been modified by the patch. Reset it to the version
    # on candidates.
    self.GitCheckoutFile(VERSION_FILE, self.vc.RemoteCandidateBranch())


class CommitSquash(Step):
  MESSAGE = "Commit to local candidates branch."

  def RunStep(self):
    # Make a first commit with a slightly different title to not confuse
    # the tagging.
    msg = FileToText(self.Config("COMMITMSG_FILE")).splitlines()
    msg[0] = msg[0].replace("(based on", "(squashed - based on")
    self.GitCommit(message = "\n".join(msg))


class PrepareVersionBranch(Step):
  MESSAGE = "Prepare new branch to commit version and changelog file."

  def RunStep(self):
    self.GitCheckout("master")
    self.Git("fetch")
    self.GitDeleteBranch(self.Config("CANDIDATESBRANCH"))
    self.GitCreateBranch(self.Config("CANDIDATESBRANCH"),
                         self.vc.RemoteCandidateBranch())


class AddChangeLog(Step):
  MESSAGE = "Add ChangeLog changes to candidates branch."

  def RunStep(self):
    changelog_entry = FileToText(self.Config("CHANGELOG_ENTRY_FILE"))
    old_change_log = FileToText(os.path.join(self.default_cwd, CHANGELOG_FILE))
    new_change_log = "%s\n\n\n%s" % (changelog_entry, old_change_log)
    TextToFile(new_change_log, os.path.join(self.default_cwd, CHANGELOG_FILE))
    os.remove(self.Config("CHANGELOG_ENTRY_FILE"))


class SetVersion(Step):
  MESSAGE = "Set correct version for candidates."

  def RunStep(self):
    self.SetVersion(os.path.join(self.default_cwd, VERSION_FILE), "new_")


class CommitCandidate(Step):
  MESSAGE = "Commit version and changelog to local candidates branch."

  def RunStep(self):
    self.GitCommit(file_name = self.Config("COMMITMSG_FILE"))
    os.remove(self.Config("COMMITMSG_FILE"))


class SanityCheck(Step):
  MESSAGE = "Sanity check."

  def RunStep(self):
    # TODO(machenbach): Run presubmit script here as it is now missing in the
    # prepare push process.
    if not self.Confirm("Please check if your local checkout is sane: Inspect "
        "%s, compile, run tests. Do you want to commit this new candidates "
        "revision to the repository?" % VERSION_FILE):
      self.Die("Execution canceled.")  # pragma: no cover


class Land(Step):
  MESSAGE = "Land the patch."

  def RunStep(self):
    self.vc.CLLand()


class TagRevision(Step):
  MESSAGE = "Tag the new revision."

  def RunStep(self):
    self.vc.Tag(
        self["version"], self.vc.RemoteCandidateBranch(), self["commit_title"])


class CleanUp(Step):
  MESSAGE = "Done!"

  def RunStep(self):
    print("Congratulations, you have successfully created the candidates "
          "revision %s."
          % self["version"])

    self.CommonCleanup()
    if self.Config("CANDIDATESBRANCH") != self["current_branch"]:
      self.GitDeleteBranch(self.Config("CANDIDATESBRANCH"))


class PushToCandidates(ScriptsBase):
  def _PrepareOptions(self, parser):
    group = parser.add_mutually_exclusive_group()
    group.add_argument("-f", "--force",
                      help="Don't prompt the user.",
                      default=False, action="store_true")
    group.add_argument("-m", "--manual",
                      help="Prompt the user at every important step.",
                      default=False, action="store_true")
    parser.add_argument("-b", "--last-master",
                        help=("The git commit ID of the last master "
                              "revision that was pushed to candidates. This is"
                              " used for the auto-generated ChangeLog entry."))
    parser.add_argument("-l", "--last-push",
                        help="The git commit ID of the last candidates push.")
    parser.add_argument("-R", "--revision",
                        help="The git commit ID to push (defaults to HEAD).")

  def _ProcessOptions(self, options):  # pragma: no cover
    if not options.manual and not options.reviewer:
      print "A reviewer (-r) is required in (semi-)automatic mode."
      return False
    if not options.manual and not options.author:
      print "Specify your chromium.org email with -a in (semi-)automatic mode."
      return False

    options.tbr_commit = not options.manual
    return True

  def _Config(self):
    return {
      "BRANCHNAME": "prepare-push",
      "CANDIDATESBRANCH": "candidates-push",
      "PERSISTFILE_BASENAME": "/tmp/v8-push-to-candidates-tempfile",
      "CHANGELOG_ENTRY_FILE":
          "/tmp/v8-push-to-candidates-tempfile-changelog-entry",
      "PATCH_FILE": "/tmp/v8-push-to-candidates-tempfile-patch-file",
      "COMMITMSG_FILE": "/tmp/v8-push-to-candidates-tempfile-commitmsg",
    }

  def _Steps(self):
    return [
      Preparation,
      FreshBranch,
      PreparePushRevision,
      IncrementVersion,
      DetectLastRelease,
      PrepareChangeLog,
      EditChangeLog,
      StragglerCommits,
      SquashCommits,
      NewBranch,
      ApplyChanges,
      CommitSquash,
      SanityCheck,
      Land,
      PrepareVersionBranch,
      AddChangeLog,
      SetVersion,
      CommitCandidate,
      Land,
      TagRevision,
      CleanUp,
    ]


if __name__ == "__main__":  # pragma: no cover
  sys.exit(PushToCandidates().Run())
node-v4.8.2/deps/v8/tools/release/releases.py000755 000766 000024 00000046057 13070706735 021224 0ustar00iojsstaff000000 000000 #!/usr/bin/env python
# Copyright 2014 the V8 project authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

# This script retrieves the history of all V8 branches and
# their corresponding Chromium revisions.

# Requires a chromium checkout with branch heads:
# gclient sync --with_branch_heads
# gclient fetch

import argparse
import csv
import itertools
import json
import os
import re
import sys

from common_includes import *

CONFIG = {
  "BRANCHNAME": "retrieve-v8-releases",
  "PERSISTFILE_BASENAME": "/tmp/v8-releases-tempfile",
}

# Expression for retrieving the bleeding edge revision from a commit message.
PUSH_MSG_SVN_RE = re.compile(r".* \(based on bleeding_edge revision r(\d+)\)$")
PUSH_MSG_GIT_RE = re.compile(r".* \(based on ([a-fA-F0-9]+)\)$")

# Expression for retrieving the merged patches from a merge commit message
# (old and new format).
MERGE_MESSAGE_RE = re.compile(r"^.*[M|m]erged (.+)(\)| into).*$", re.M)

CHERRY_PICK_TITLE_GIT_RE = re.compile(r"^.* \(cherry\-pick\)\.?$")

# New git message for cherry-picked CLs. One message per line.
MERGE_MESSAGE_GIT_RE = re.compile(r"^Merged ([a-fA-F0-9]+)\.?$")

# Expression for retrieving reverted patches from a commit message (old and
# new format).
ROLLBACK_MESSAGE_RE = re.compile(r"^.*[R|r]ollback of (.+)(\)| in).*$", re.M)

# New git message for reverted CLs. One message per line.
ROLLBACK_MESSAGE_GIT_RE = re.compile(r"^Rollback of ([a-fA-F0-9]+)\.?$")

# Expression for retrieving the code review link.
REVIEW_LINK_RE = re.compile(r"^Review URL: (.+)$", re.M)

# Expression with three versions (historical) for extracting the v8 revision
# from the chromium DEPS file.
DEPS_RE = re.compile(r"""^\s*(?:["']v8_revision["']: ["']"""
                     """|\(Var\("googlecode_url"\) % "v8"\) \+ "\/trunk@"""
                     """|"http\:\/\/v8\.googlecode\.com\/svn\/trunk@)"""
                     """([^"']+)["'].*$""", re.M)

# Expression to pick tag and revision for bleeding edge tags. To be used with
# output of 'svn log'.
BLEEDING_EDGE_TAGS_RE = re.compile(
    r"A \/tags\/([^\s]+) \(from \/branches\/bleeding_edge\:(\d+)\)")

OMAHA_PROXY_URL = "http://omahaproxy.appspot.com/"

def SortBranches(branches):
  """Sort branches with version number names."""
  return sorted(branches, key=SortingKey, reverse=True)


def FilterDuplicatesAndReverse(cr_releases):
  """Returns the chromium releases in reverse order filtered by v8 revision
  duplicates.

  cr_releases is a list of [cr_rev, v8_hsh] reverse-sorted by cr_rev.
  """
  last = ""
  result = []
  for release in reversed(cr_releases):
    if last == release[1]:
      continue
    last = release[1]
    result.append(release)
  return result


def BuildRevisionRanges(cr_releases):
  """Returns a mapping of v8 revision -> chromium ranges.
  The ranges are comma-separated, each range has the form R1:R2. The newest
  entry is the only one of the form R1, as there is no end range.

  cr_releases is a list of [cr_rev, v8_hsh] reverse-sorted by cr_rev.
  cr_rev either refers to a chromium commit position or a chromium branch
  number.
  """
  range_lists = {}
  cr_releases = FilterDuplicatesAndReverse(cr_releases)

  # Visit pairs of cr releases from oldest to newest.
  for cr_from, cr_to in itertools.izip(
      cr_releases, itertools.islice(cr_releases, 1, None)):

    # Assume the chromium revisions are all different.
    assert cr_from[0] != cr_to[0]

    ran = "%s:%d" % (cr_from[0], int(cr_to[0]) - 1)

    # Collect the ranges in lists per revision.
    range_lists.setdefault(cr_from[1], []).append(ran)

  # Add the newest revision.
  if cr_releases:
    range_lists.setdefault(cr_releases[-1][1], []).append(cr_releases[-1][0])

  # Stringify and comma-separate the range lists.
  return dict((hsh, ", ".join(ran)) for hsh, ran in range_lists.iteritems())


def MatchSafe(match):
  if match:
    return match.group(1)
  else:
    return ""


class Preparation(Step):
  MESSAGE = "Preparation."

  def RunStep(self):
    self.CommonPrepare()
    self.PrepareBranch()


class RetrieveV8Releases(Step):
  MESSAGE = "Retrieve all V8 releases."

  def ExceedsMax(self, releases):
    return (self._options.max_releases > 0
            and len(releases) > self._options.max_releases)

  def GetMasterHashFromPush(self, title):
    return MatchSafe(PUSH_MSG_GIT_RE.match(title))

  def GetMergedPatches(self, body):
    patches = MatchSafe(MERGE_MESSAGE_RE.search(body))
    if not patches:
      patches = MatchSafe(ROLLBACK_MESSAGE_RE.search(body))
      if patches:
        # Indicate reverted patches with a "-".
        patches = "-%s" % patches
    return patches

  def GetMergedPatchesGit(self, body):
    patches = []
    for line in body.splitlines():
      patch = MatchSafe(MERGE_MESSAGE_GIT_RE.match(line))
      if patch:
        patches.append(patch)
      patch = MatchSafe(ROLLBACK_MESSAGE_GIT_RE.match(line))
      if patch:
        patches.append("-%s" % patch)
    return ", ".join(patches)


  def GetReleaseDict(
      self, git_hash, master_position, master_hash, branch, version,
      patches, cl_body):
    revision = self.GetCommitPositionNumber(git_hash)
    return {
      # The cr commit position number on the branch.
      "revision": revision,
      # The git revision on the branch.
      "revision_git": git_hash,
      # The cr commit position number on master.
      "master_position": master_position,
      # The same for git.
      "master_hash": master_hash,
      # The branch name.
      "branch": branch,
      # The version for displaying in the form 3.26.3 or 3.26.3.12.
      "version": version,
      # The date of the commit.
      "date": self.GitLog(n=1, format="%ci", git_hash=git_hash),
      # Merged patches if available in the form 'r1234, r2345'.
      "patches_merged": patches,
      # Default for easier output formatting.
      "chromium_revision": "",
      # Default for easier output formatting.
      "chromium_branch": "",
      # Link to the CL on code review. Candiates pushes are not uploaded,
      # so this field will be populated below with the recent roll CL link.
      "review_link": MatchSafe(REVIEW_LINK_RE.search(cl_body)),
      # Link to the commit message on google code.
      "revision_link": ("https://code.google.com/p/v8/source/detail?r=%s"
                        % revision),
    }

  def GetRelease(self, git_hash, branch):
    self.ReadAndPersistVersion()
    base_version = [self["major"], self["minor"], self["build"]]
    version = ".".join(base_version)
    body = self.GitLog(n=1, format="%B", git_hash=git_hash)

    patches = ""
    if self["patch"] != "0":
      version += ".%s" % self["patch"]
      if CHERRY_PICK_TITLE_GIT_RE.match(body.splitlines()[0]):
        patches = self.GetMergedPatchesGit(body)
      else:
        patches = self.GetMergedPatches(body)

    if SortingKey("4.2.69") <= SortingKey(version):
      master_hash = self.GetLatestReleaseBase(version=version)
    else:
      # Legacy: Before version 4.2.69, the master revision was determined
      # by commit message.
      title = self.GitLog(n=1, format="%s", git_hash=git_hash)
      master_hash = self.GetMasterHashFromPush(title)
    master_position = ""
    if master_hash:
      master_position = self.GetCommitPositionNumber(master_hash)
    return self.GetReleaseDict(
        git_hash, master_position, master_hash, branch, version,
        patches, body), self["patch"]

  def GetReleasesFromBranch(self, branch):
    self.GitReset(self.vc.RemoteBranch(branch))
    if branch == self.vc.MasterBranch():
      return self.GetReleasesFromMaster()

    releases = []
    try:
      for git_hash in self.GitLog(format="%H").splitlines():
        if VERSION_FILE not in self.GitChangedFiles(git_hash):
          continue
        if self.ExceedsMax(releases):
          break  # pragma: no cover
        if not self.GitCheckoutFileSafe(VERSION_FILE, git_hash):
          break  # pragma: no cover

        release, patch_level = self.GetRelease(git_hash, branch)
        releases.append(release)

        # Follow branches only until their creation point.
        # TODO(machenbach): This omits patches if the version file wasn't
        # manipulated correctly. Find a better way to detect the point where
        # the parent of the branch head leads to the trunk branch.
        if branch != self.vc.CandidateBranch() and patch_level == "0":
          break

    # Allow Ctrl-C interrupt.
    except (KeyboardInterrupt, SystemExit):  # pragma: no cover
      pass

    # Clean up checked-out version file.
    self.GitCheckoutFileSafe(VERSION_FILE, "HEAD")
    return releases

  def GetReleaseFromRevision(self, revision):
    releases = []
    try:
      if (VERSION_FILE not in self.GitChangedFiles(revision) or
          not self.GitCheckoutFileSafe(VERSION_FILE, revision)):
        print "Skipping revision %s" % revision
        return []  # pragma: no cover

      branches = map(
          str.strip,
          self.Git("branch -r --contains %s" % revision).strip().splitlines(),
      )
      branch = ""
      for b in branches:
        if b.startswith("origin/"):
          branch = b.split("origin/")[1]
          break
        if b.startswith("branch-heads/"):
          branch = b.split("branch-heads/")[1]
          break
      else:
        print "Could not determine branch for %s" % revision

      release, _ = self.GetRelease(revision, branch)
      releases.append(release)

    # Allow Ctrl-C interrupt.
    except (KeyboardInterrupt, SystemExit):  # pragma: no cover
      pass

    # Clean up checked-out version file.
    self.GitCheckoutFileSafe(VERSION_FILE, "HEAD")
    return releases


  def RunStep(self):
    self.GitCreateBranch(self._config["BRANCHNAME"])
    releases = []
    if self._options.branch == 'recent':
      # List every release from the last 7 days.
      revisions = self.GetRecentReleases(max_age=7 * DAY_IN_SECONDS)
      for revision in revisions:
        releases += self.GetReleaseFromRevision(revision)
    elif self._options.branch == 'all':  # pragma: no cover
      # Retrieve the full release history.
      for branch in self.vc.GetBranches():
        releases += self.GetReleasesFromBranch(branch)
      releases += self.GetReleasesFromBranch(self.vc.CandidateBranch())
      releases += self.GetReleasesFromBranch(self.vc.MasterBranch())
    else:  # pragma: no cover
      # Retrieve history for a specified branch.
      assert self._options.branch in (self.vc.GetBranches() +
          [self.vc.CandidateBranch(), self.vc.MasterBranch()])
      releases += self.GetReleasesFromBranch(self._options.branch)

    self["releases"] = sorted(releases,
                              key=lambda r: SortingKey(r["version"]),
                              reverse=True)


class UpdateChromiumCheckout(Step):
  MESSAGE = "Update the chromium checkout."

  def RunStep(self):
    cwd = self._options.chromium
    self.GitFetchOrigin("+refs/heads/*:refs/remotes/origin/*",
                        "+refs/branch-heads/*:refs/remotes/branch-heads/*",
                        cwd=cwd)
    # Update v8 checkout in chromium.
    self.GitFetchOrigin(cwd=os.path.join(cwd, "v8"))


def ConvertToCommitNumber(step, revision):
  # Simple check for git hashes.
  if revision.isdigit() and len(revision) < 8:
    return revision
  return step.GetCommitPositionNumber(
      revision, cwd=os.path.join(step._options.chromium, "v8"))


class RetrieveChromiumV8Releases(Step):
  MESSAGE = "Retrieve V8 releases from Chromium DEPS."

  def RunStep(self):
    cwd = self._options.chromium

    # All v8 revisions we are interested in.
    releases_dict = dict((r["revision_git"], r) for r in self["releases"])

    cr_releases = []
    count_past_last_v8 = 0
    try:
      for git_hash in self.GitLog(
          format="%H", grep="V8", branch="origin/master",
          path="DEPS", cwd=cwd).splitlines():
        deps = self.GitShowFile(git_hash, "DEPS", cwd=cwd)
        match = DEPS_RE.search(deps)
        if match:
          cr_rev = self.GetCommitPositionNumber(git_hash, cwd=cwd)
          if cr_rev:
            v8_hsh = match.group(1)
            cr_releases.append([cr_rev, v8_hsh])

          if count_past_last_v8:
            count_past_last_v8 += 1  # pragma: no cover

          if count_past_last_v8 > 20:
            break  # pragma: no cover

          # Stop as soon as we find a v8 revision that we didn't fetch in the
          # v8-revision-retrieval part above (i.e. a revision that's too old).
          # Just iterate a few more times in case there were reverts.
          if v8_hsh not in releases_dict:
            count_past_last_v8 += 1  # pragma: no cover

    # Allow Ctrl-C interrupt.
    except (KeyboardInterrupt, SystemExit):  # pragma: no cover
      pass

    # Add the chromium ranges to the v8 candidates and master releases.
    all_ranges = BuildRevisionRanges(cr_releases)

    for hsh, ranges in all_ranges.iteritems():
      releases_dict.get(hsh, {})["chromium_revision"] = ranges


# TODO(machenbach): Unify common code with method above.
class RetrieveChromiumBranches(Step):
  MESSAGE = "Retrieve Chromium branch information."

  def RunStep(self):
    cwd = self._options.chromium

    # All v8 revisions we are interested in.
    releases_dict = dict((r["revision_git"], r) for r in self["releases"])

    # Filter out irrelevant branches.
    branches = filter(lambda r: re.match(r"branch-heads/\d+", r),
                      self.GitRemotes(cwd=cwd))

    # Transform into pure branch numbers.
    branches = map(lambda r: int(re.match(r"branch-heads/(\d+)", r).group(1)),
                   branches)

    branches = sorted(branches, reverse=True)

    cr_branches = []
    count_past_last_v8 = 0
    try:
      for branch in branches:
        deps = self.GitShowFile(
            "refs/branch-heads/%d" % branch, "DEPS", cwd=cwd)
        match = DEPS_RE.search(deps)
        if match:
          v8_hsh = match.group(1)
          cr_branches.append([str(branch), v8_hsh])

          if count_past_last_v8:
            count_past_last_v8 += 1  # pragma: no cover

          if count_past_last_v8 > 20:
            break  # pragma: no cover

          # Stop as soon as we find a v8 revision that we didn't fetch in the
          # v8-revision-retrieval part above (i.e. a revision that's too old).
          # Just iterate a few more times in case there were reverts.
          if v8_hsh not in releases_dict:
            count_past_last_v8 += 1  # pragma: no cover

    # Allow Ctrl-C interrupt.
    except (KeyboardInterrupt, SystemExit):  # pragma: no cover
      pass

    # Add the chromium branches to the v8 candidate releases.
    all_ranges = BuildRevisionRanges(cr_branches)
    for revision, ranges in all_ranges.iteritems():
      releases_dict.get(revision, {})["chromium_branch"] = ranges


class RetrieveInformationOnChromeReleases(Step):
  MESSAGE = 'Retrieves relevant information on the latest Chrome releases'

  def Run(self):

    params = None
    result_raw = self.ReadURL(
                             OMAHA_PROXY_URL + "all.json",
                             params,
                             wait_plan=[5, 20]
                             )
    recent_releases = json.loads(result_raw)

    canaries = []

    for current_os in recent_releases:
      for current_version in current_os["versions"]:
        if current_version["channel"] != "canary":
          continue

        current_candidate = self._CreateCandidate(current_version)
        canaries.append(current_candidate)

    chrome_releases = {"canaries": canaries}
    self["chrome_releases"] = chrome_releases

  def _GetGitHashForV8Version(self, v8_version):
    if v8_version == "N/A":
      return ""
    if v8_version.split(".")[3]== "0":
      return self.GitGetHashOfTag(v8_version[:-2])

    return self.GitGetHashOfTag(v8_version)

  def _CreateCandidate(self, current_version):
    params = None
    url_to_call = (OMAHA_PROXY_URL + "v8.json?version="
                   + current_version["previous_version"])
    result_raw = self.ReadURL(
                         url_to_call,
                         params,
                         wait_plan=[5, 20]
                         )
    previous_v8_version = json.loads(result_raw)["v8_version"]
    v8_previous_version_hash = self._GetGitHashForV8Version(previous_v8_version)

    current_v8_version = current_version["v8_version"]
    v8_version_hash = self._GetGitHashForV8Version(current_v8_version)

    current_candidate = {
                        "chrome_version": current_version["version"],
                        "os": current_version["os"],
                        "release_date": current_version["current_reldate"],
                        "v8_version": current_v8_version,
                        "v8_version_hash": v8_version_hash,
                        "v8_previous_version": previous_v8_version,
                        "v8_previous_version_hash": v8_previous_version_hash,
                       }
    return current_candidate


class CleanUp(Step):
  MESSAGE = "Clean up."

  def RunStep(self):
    self.CommonCleanup()


class WriteOutput(Step):
  MESSAGE = "Print output."

  def Run(self):

    output = {
              "releases": self["releases"],
              "chrome_releases": self["chrome_releases"],
              }

    if self._options.csv:
      with open(self._options.csv, "w") as f:
        writer = csv.DictWriter(f,
                                ["version", "branch", "revision",
                                 "chromium_revision", "patches_merged"],
                                restval="",
                                extrasaction="ignore")
        for release in self["releases"]:
          writer.writerow(release)
    if self._options.json:
      with open(self._options.json, "w") as f:
        f.write(json.dumps(output))
    if not self._options.csv and not self._options.json:
      print output  # pragma: no cover


class Releases(ScriptsBase):
  def _PrepareOptions(self, parser):
    parser.add_argument("-b", "--branch", default="recent",
                        help=("The branch to analyze. If 'all' is specified, "
                              "analyze all branches. If 'recent' (default) "
                              "is specified, track beta, stable and "
                              "candidates."))
    parser.add_argument("-c", "--chromium",
                        help=("The path to your Chromium src/ "
                              "directory to automate the V8 roll."))
    parser.add_argument("--csv", help="Path to a CSV file for export.")
    parser.add_argument("-m", "--max-releases", type=int, default=0,
                        help="The maximum number of releases to track.")
    parser.add_argument("--json", help="Path to a JSON file for export.")

  def _ProcessOptions(self, options):  # pragma: no cover
    options.force_readline_defaults = True
    return True

  def _Config(self):
    return {
      "BRANCHNAME": "retrieve-v8-releases",
      "PERSISTFILE_BASENAME": "/tmp/v8-releases-tempfile",
    }

  def _Steps(self):

    return [
      Preparation,
      RetrieveV8Releases,
      UpdateChromiumCheckout,
      RetrieveChromiumV8Releases,
      RetrieveChromiumBranches,
      RetrieveInformationOnChromeReleases,
      CleanUp,
      WriteOutput,
    ]


if __name__ == "__main__":  # pragma: no cover
  sys.exit(Releases().Run())
node-v4.8.2/deps/v8/tools/release/script_test.py000755 000766 000024 00000004366 13070706735 021761 0ustar00iojsstaff000000 000000 #!/usr/bin/env python
# Copyright 2014 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

# Wraps test execution with a coverage analysis. To get the best speed, the
# native python coverage version >= 3.7.1 should be installed.

import coverage
import os
import unittest
import sys


def Main(argv):
  script_path = os.path.dirname(os.path.abspath(__file__))
  cov = coverage.coverage(include=([os.path.join(script_path, '*.py')]))
  cov.start()
  import test_scripts
  alltests = map(unittest.TestLoader().loadTestsFromTestCase, [
    test_scripts.ToplevelTest,
    test_scripts.ScriptTest,
    test_scripts.SystemTest,
  ])
  unittest.TextTestRunner(verbosity=2).run(unittest.TestSuite(alltests))
  cov.stop()
  print cov.report()


if __name__ == '__main__':
  sys.exit(Main(sys.argv))
node-v4.8.2/deps/v8/tools/release/search_related_commits.py000755 000766 000024 00000014536 13070706735 024116 0ustar00iojsstaff000000 000000 #!/usr/bin/env python
# Copyright 2015 the V8 project authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

import argparse
import operator
import os
import re
from sets import Set
from subprocess import Popen, PIPE
import sys

def search_all_related_commits(
    git_working_dir, start_hash, until, separator, verbose=False):

  all_commits_raw = _find_commits_inbetween(
      start_hash, until, git_working_dir, verbose)
  if verbose:
    print "All commits between  and : " + all_commits_raw

  # Adding start hash too
  all_commits = [start_hash]
  all_commits.extend(all_commits_raw.splitlines())
  all_related_commits = {}
  already_treated_commits = Set([])
  for commit in all_commits:
    if commit in already_treated_commits:
      continue

    related_commits = _search_related_commits(
        git_working_dir, commit, until, separator, verbose)
    if len(related_commits) > 0:
      all_related_commits[commit] = related_commits
      already_treated_commits.update(related_commits)

    already_treated_commits.update(commit)

  return all_related_commits

def _search_related_commits(
    git_working_dir, start_hash, until, separator, verbose=False):

  if separator:
    commits_between = _find_commits_inbetween(
        start_hash, separator, git_working_dir, verbose)
    if commits_between == "":
      return []

  # Extract commit position
  original_message = _git_execute(
      git_working_dir,
      ["show", "-s", "--format=%B", start_hash],
      verbose)
  title = original_message.splitlines()[0]

  matches = re.search("(\{#)([0-9]*)(\})", original_message)

  if not matches:
    return []

  commit_position = matches.group(2)
  if verbose:
    print "1.) Commit position to look for: " + commit_position

  search_range = start_hash + ".." + until

  def git_args(grep_pattern):
    return [
      "log",
      "--reverse",
      "--grep=" + grep_pattern,
      "--format=%H",
      search_range,
    ]

  found_by_hash = _git_execute(
      git_working_dir, git_args(start_hash), verbose).strip()

  if verbose:
    print "2.) Found by hash: " + found_by_hash

  found_by_commit_pos = _git_execute(
      git_working_dir, git_args(commit_position), verbose).strip()

  if verbose:
    print "3.) Found by commit position: " + found_by_commit_pos

  # Replace brackets or else they are wrongly interpreted by --grep
  title = title.replace("[", "\\[")
  title = title.replace("]", "\\]")

  found_by_title = _git_execute(
      git_working_dir, git_args(title), verbose).strip()

  if verbose:
    print "4.) Found by title: " + found_by_title

  hits = (
      _convert_to_array(found_by_hash) +
      _convert_to_array(found_by_commit_pos) +
      _convert_to_array(found_by_title))
  hits = _remove_duplicates(hits)

  if separator:
    for current_hit in hits:
      commits_between = _find_commits_inbetween(
          separator, current_hit, git_working_dir, verbose)
      if commits_between != "":
        return hits
    return []

  return hits

def _find_commits_inbetween(start_hash, end_hash, git_working_dir, verbose):
  commits_between = _git_execute(
        git_working_dir,
        ["rev-list", "--reverse", start_hash + ".." + end_hash],
        verbose)
  return commits_between.strip()

def _convert_to_array(string_of_hashes):
  return string_of_hashes.splitlines()

def _remove_duplicates(array):
   no_duplicates = []
   for current in array:
    if not current in no_duplicates:
      no_duplicates.append(current)
   return no_duplicates

def _git_execute(working_dir, args, verbose=False):
  command = ["git", "-C", working_dir] + args
  if verbose:
    print "Git working dir: " + working_dir
    print "Executing git command:" + str(command)
  p = Popen(args=command, stdin=PIPE,
            stdout=PIPE, stderr=PIPE)
  output, err = p.communicate()
  rc = p.returncode
  if rc != 0:
    raise Exception(err)
  if verbose:
    print "Git return value: " + output
  return output

def _pretty_print_entry(hash, git_dir, pre_text, verbose):
  text_to_print = _git_execute(
      git_dir,
      ["show",
       "--quiet",
       "--date=iso",
       hash,
       "--format=%ad # %H # %s"],
      verbose)
  return pre_text + text_to_print.strip()

def main(options):
    all_related_commits = search_all_related_commits(
        options.git_dir,
        options.of[0],
        options.until[0],
        options.separator,
        options.verbose)

    sort_key = lambda x: (
        _git_execute(
            options.git_dir,
            ["show", "--quiet", "--date=iso", x, "--format=%ad"],
            options.verbose)).strip()

    high_level_commits = sorted(all_related_commits.keys(), key=sort_key)

    for current_key in high_level_commits:
      if options.prettyprint:
        yield _pretty_print_entry(
            current_key,
            options.git_dir,
            "+",
            options.verbose)
      else:
        yield "+" + current_key

      found_commits = all_related_commits[current_key]
      for current_commit in found_commits:
        if options.prettyprint:
          yield _pretty_print_entry(
              current_commit,
              options.git_dir,
              "| ",
              options.verbose)
        else:
          yield "| " + current_commit

if __name__ == "__main__":  # pragma: no cover
  parser = argparse.ArgumentParser(
      "This tool analyzes the commit range between  and . "
      "It finds commits which belong together e.g. Implement/Revert pairs and "
      "Implement/Port/Revert triples. All supplied hashes need to be "
      "from the same branch e.g. master.")
  parser.add_argument("-g", "--git-dir", required=False, default=".",
                        help="The path to your git working directory.")
  parser.add_argument("--verbose", action="store_true",
      help="Enables a very verbose output")
  parser.add_argument("of", nargs=1,
      help="Hash of the commit to be searched.")
  parser.add_argument("until", nargs=1,
      help="Commit when searching should stop")
  parser.add_argument("--separator", required=False,
      help="The script will only list related commits "
            "which are separated by hash <--separator>.")
  parser.add_argument("--prettyprint", action="store_true",
      help="Pretty prints the output")

  args = sys.argv[1:]
  options = parser.parse_args(args)
  for current_line in main(options):
    print current_line
node-v4.8.2/deps/v8/tools/release/test_scripts.py000644 000766 000024 00000164715 13070706735 022146 0ustar00iojsstaff000000 000000 #!/usr/bin/env python
# Copyright 2013 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

import os
import shutil
import tempfile
import traceback
import unittest

import auto_push
from auto_push import LastReleaseBailout
import auto_roll
import common_includes
from common_includes import *
import create_release
from create_release import CreateRelease
import merge_to_branch
from merge_to_branch import *
import push_to_candidates
from push_to_candidates import *
import chromium_roll
from chromium_roll import ChromiumRoll
import releases
from releases import Releases
from auto_tag import AutoTag


TEST_CONFIG = {
  "DEFAULT_CWD": None,
  "BRANCHNAME": "test-prepare-push",
  "CANDIDATESBRANCH": "test-candidates-push",
  "PERSISTFILE_BASENAME": "/tmp/test-v8-push-to-candidates-tempfile",
  "CHANGELOG_ENTRY_FILE":
      "/tmp/test-v8-push-to-candidates-tempfile-changelog-entry",
  "PATCH_FILE": "/tmp/test-v8-push-to-candidates-tempfile-patch",
  "COMMITMSG_FILE": "/tmp/test-v8-push-to-candidates-tempfile-commitmsg",
  "CHROMIUM": "/tmp/test-v8-push-to-candidates-tempfile-chromium",
  "SETTINGS_LOCATION": None,
  "ALREADY_MERGING_SENTINEL_FILE":
      "/tmp/test-merge-to-branch-tempfile-already-merging",
  "TEMPORARY_PATCH_FILE": "/tmp/test-merge-to-branch-tempfile-temporary-patch",
}


AUTO_PUSH_ARGS = [
  "-a", "author@chromium.org",
  "-r", "reviewer@chromium.org",
]


class ToplevelTest(unittest.TestCase):
  def testSortBranches(self):
    S = releases.SortBranches
    self.assertEquals(["3.1", "2.25"], S(["2.25", "3.1"])[0:2])
    self.assertEquals(["3.0", "2.25"], S(["2.25", "3.0", "2.24"])[0:2])
    self.assertEquals(["3.11", "3.2"], S(["3.11", "3.2", "2.24"])[0:2])

  def testFilterDuplicatesAndReverse(self):
    F = releases.FilterDuplicatesAndReverse
    self.assertEquals([], F([]))
    self.assertEquals([["100", "10"]], F([["100", "10"]]))
    self.assertEquals([["99", "9"], ["100", "10"]],
                      F([["100", "10"], ["99", "9"]]))
    self.assertEquals([["98", "9"], ["100", "10"]],
                      F([["100", "10"], ["99", "9"], ["98", "9"]]))
    self.assertEquals([["98", "9"], ["99", "10"]],
                      F([["100", "10"], ["99", "10"], ["98", "9"]]))

  def testBuildRevisionRanges(self):
    B = releases.BuildRevisionRanges
    self.assertEquals({}, B([]))
    self.assertEquals({"10": "100"}, B([["100", "10"]]))
    self.assertEquals({"10": "100", "9": "99:99"},
                      B([["100", "10"], ["99", "9"]]))
    self.assertEquals({"10": "100", "9": "97:99"},
                      B([["100", "10"], ["98", "9"], ["97", "9"]]))
    self.assertEquals({"10": "100", "9": "99:99", "3": "91:98"},
                      B([["100", "10"], ["99", "9"], ["91", "3"]]))
    self.assertEquals({"13": "101", "12": "100:100", "9": "94:97",
                       "3": "91:93, 98:99"},
                      B([["101", "13"], ["100", "12"], ["98", "3"],
                         ["94", "9"], ["91", "3"]]))

  def testMakeComment(self):
    self.assertEquals("#   Line 1\n#   Line 2\n#",
                      MakeComment("    Line 1\n    Line 2\n"))
    self.assertEquals("#Line 1\n#Line 2",
                      MakeComment("Line 1\n Line 2"))

  def testStripComments(self):
    self.assertEquals("    Line 1\n    Line 3\n",
        StripComments("    Line 1\n#   Line 2\n    Line 3\n#\n"))
    self.assertEquals("\nLine 2 ### Test\n #",
        StripComments("###\n# \n\n#  Line 1\nLine 2 ### Test\n #"))

  def testMakeChangeLogBodySimple(self):
    commits = [
          ["Title text 1",
           "Title text 1\n\nBUG=\n",
           "author1@chromium.org"],
          ["Title text 2.",
           "Title text 2\n\nBUG=1234\n",
           "author2@chromium.org"],
        ]
    self.assertEquals("        Title text 1.\n"
                      "        (author1@chromium.org)\n\n"
                      "        Title text 2 (Chromium issue 1234).\n"
                      "        (author2@chromium.org)\n\n",
                      MakeChangeLogBody(commits))

  def testMakeChangeLogBodyEmpty(self):
    self.assertEquals("", MakeChangeLogBody([]))

  def testMakeChangeLogBodyAutoFormat(self):
    commits = [
          ["Title text 1!",
           "Title text 1\nLOG=y\nBUG=\n",
           "author1@chromium.org"],
          ["Title text 2",
           "Title text 2\n\nBUG=1234\n",
           "author2@chromium.org"],
          ["Title text 3",
           "Title text 3\n\nBUG=1234\nLOG = Yes\n",
           "author3@chromium.org"],
          ["Title text 3",
           "Title text 4\n\nBUG=1234\nLOG=\n",
           "author4@chromium.org"],
        ]
    self.assertEquals("        Title text 1.\n\n"
                      "        Title text 3 (Chromium issue 1234).\n\n",
                      MakeChangeLogBody(commits, True))

  def testRegressWrongLogEntryOnTrue(self):
    body = """
Check elimination: Learn from if(CompareMap(x)) on true branch.

BUG=
R=verwaest@chromium.org

Committed: https://code.google.com/p/v8/source/detail?r=18210
"""
    self.assertEquals("", MakeChangeLogBody([["title", body, "author"]], True))

  def testMakeChangeLogBugReferenceEmpty(self):
    self.assertEquals("", MakeChangeLogBugReference(""))
    self.assertEquals("", MakeChangeLogBugReference("LOG="))
    self.assertEquals("", MakeChangeLogBugReference(" BUG ="))
    self.assertEquals("", MakeChangeLogBugReference("BUG=none\t"))

  def testMakeChangeLogBugReferenceSimple(self):
    self.assertEquals("(issue 987654)",
                      MakeChangeLogBugReference("BUG = v8:987654"))
    self.assertEquals("(Chromium issue 987654)",
                      MakeChangeLogBugReference("BUG=987654 "))

  def testMakeChangeLogBugReferenceFromBody(self):
    self.assertEquals("(Chromium issue 1234567)",
                      MakeChangeLogBugReference("Title\n\nTBR=\nBUG=\n"
                                                " BUG=\tchromium:1234567\t\n"
                                                "R=somebody\n"))

  def testMakeChangeLogBugReferenceMultiple(self):
    # All issues should be sorted and grouped. Multiple references to the same
    # issue should be filtered.
    self.assertEquals("(issues 123, 234, Chromium issue 345)",
                      MakeChangeLogBugReference("Title\n\n"
                                                "BUG=v8:234\n"
                                                "  BUG\t= 345, \tv8:234,\n"
                                                "BUG=v8:123\n"
                                                "R=somebody\n"))
    self.assertEquals("(Chromium issues 123, 234)",
                      MakeChangeLogBugReference("Title\n\n"
                                                "BUG=234,,chromium:123 \n"
                                                "R=somebody\n"))
    self.assertEquals("(Chromium issues 123, 234)",
                      MakeChangeLogBugReference("Title\n\n"
                                                "BUG=chromium:234, , 123\n"
                                                "R=somebody\n"))
    self.assertEquals("(issues 345, 456)",
                      MakeChangeLogBugReference("Title\n\n"
                                                "\t\tBUG=v8:345,v8:456\n"
                                                "R=somebody\n"))
    self.assertEquals("(issue 123, Chromium issues 345, 456)",
                      MakeChangeLogBugReference("Title\n\n"
                                                "BUG=chromium:456\n"
                                                "BUG = none\n"
                                                "R=somebody\n"
                                                "BUG=456,v8:123, 345"))

  # TODO(machenbach): These test don't make much sense when the formatting is
  # done later.
  def testMakeChangeLogBugReferenceLong(self):
    # -----------------00--------10--------20--------30--------
    self.assertEquals("(issues 234, 1234567890, 1234567"
                      "8901234567890, Chromium issues 12345678,"
                      " 123456789)",
                      MakeChangeLogBugReference("BUG=v8:234\n"
                                                "BUG=v8:1234567890\n"
                                                "BUG=v8:12345678901234567890\n"
                                                "BUG=123456789\n"
                                                "BUG=12345678\n"))
    # -----------------00--------10--------20--------30--------
    self.assertEquals("(issues 234, 1234567890, 1234567"
                      "8901234567890, Chromium issues"
                      " 123456789, 1234567890)",
                      MakeChangeLogBugReference("BUG=v8:234\n"
                                                "BUG=v8:12345678901234567890\n"
                                                "BUG=v8:1234567890\n"
                                                "BUG=123456789\n"
                                                "BUG=1234567890\n"))
    # -----------------00--------10--------20--------30--------
    self.assertEquals("(Chromium issues 234, 1234567890"
                      ", 12345678901234567, "
                      "1234567890123456789)",
                      MakeChangeLogBugReference("BUG=234\n"
                                                "BUG=12345678901234567\n"
                                                "BUG=1234567890123456789\n"
                                                "BUG=1234567890\n"))


def Cmd(*args, **kwargs):
  """Convenience function returning a shell command test expectation."""
  return {
    "name": "command",
    "args": args,
    "ret": args[-1],
    "cb": kwargs.get("cb"),
    "cwd": kwargs.get("cwd", TEST_CONFIG["DEFAULT_CWD"]),
  }


def RL(text, cb=None):
  """Convenience function returning a readline test expectation."""
  return {
    "name": "readline",
    "args": [],
    "ret": text,
    "cb": cb,
    "cwd": None,
  }


def URL(*args, **kwargs):
  """Convenience function returning a readurl test expectation."""
  return {
    "name": "readurl",
    "args": args[:-1],
    "ret": args[-1],
    "cb": kwargs.get("cb"),
    "cwd": None,
  }


class SimpleMock(object):
  def __init__(self):
    self._recipe = []
    self._index = -1

  def Expect(self, recipe):
    self._recipe = recipe

  def Call(self, name, *args, **kwargs):  # pragma: no cover
    self._index += 1
    try:
      expected_call = self._recipe[self._index]
    except IndexError:
      raise NoRetryException("Calling %s %s" % (name, " ".join(args)))

    if not isinstance(expected_call, dict):
      raise NoRetryException("Found wrong expectation type for %s %s" %
                             (name, " ".join(args)))

    if expected_call["name"] != name:
      raise NoRetryException("Expected action: %s %s - Actual: %s" %
          (expected_call["name"], expected_call["args"], name))

    # Check if the given working directory matches the expected one.
    if expected_call["cwd"] != kwargs.get("cwd"):
      raise NoRetryException("Expected cwd: %s in %s %s - Actual: %s" %
          (expected_call["cwd"],
           expected_call["name"],
           expected_call["args"],
           kwargs.get("cwd")))

    # The number of arguments in the expectation must match the actual
    # arguments.
    if len(args) > len(expected_call['args']):
      raise NoRetryException("When calling %s with arguments, the "
          "expectations must consist of at least as many arguments." %
          name)

    # Compare expected and actual arguments.
    for (expected_arg, actual_arg) in zip(expected_call['args'], args):
      if expected_arg != actual_arg:
        raise NoRetryException("Expected: %s - Actual: %s" %
                               (expected_arg, actual_arg))

    # The expected call contains an optional callback for checking the context
    # at the time of the call.
    if expected_call['cb']:
      try:
        expected_call['cb']()
      except:
        tb = traceback.format_exc()
        raise NoRetryException("Caught exception from callback: %s" % tb)

    # If the return value is an exception, raise it instead of returning.
    if isinstance(expected_call['ret'], Exception):
      raise expected_call['ret']
    return expected_call['ret']

  def AssertFinished(self):  # pragma: no cover
    if self._index < len(self._recipe) -1:
      raise NoRetryException("Called mock too seldom: %d vs. %d" %
                             (self._index, len(self._recipe)))


class ScriptTest(unittest.TestCase):
  def MakeEmptyTempFile(self):
    handle, name = tempfile.mkstemp()
    os.close(handle)
    self._tmp_files.append(name)
    return name

  def MakeEmptyTempDirectory(self):
    name = tempfile.mkdtemp()
    self._tmp_files.append(name)
    return name


  def WriteFakeVersionFile(self, major=3, minor=22, build=4, patch=0):
    version_file = os.path.join(TEST_CONFIG["DEFAULT_CWD"], VERSION_FILE)
    if not os.path.exists(os.path.dirname(version_file)):
      os.makedirs(os.path.dirname(version_file))
    with open(version_file, "w") as f:
      f.write("  // Some line...\n")
      f.write("\n")
      f.write("#define V8_MAJOR_VERSION    %s\n" % major)
      f.write("#define V8_MINOR_VERSION    %s\n" % minor)
      f.write("#define V8_BUILD_NUMBER     %s\n" % build)
      f.write("#define V8_PATCH_LEVEL      %s\n" % patch)
      f.write("  // Some line...\n")
      f.write("#define V8_IS_CANDIDATE_VERSION 0\n")

  def MakeStep(self):
    """Convenience wrapper."""
    options = ScriptsBase(TEST_CONFIG, self, self._state).MakeOptions([])
    return MakeStep(step_class=Step, state=self._state,
                    config=TEST_CONFIG, side_effect_handler=self,
                    options=options)

  def RunStep(self, script=PushToCandidates, step_class=Step, args=None):
    """Convenience wrapper."""
    args = args if args is not None else ["-m"]
    return script(TEST_CONFIG, self, self._state).RunSteps([step_class], args)

  def Call(self, fun, *args, **kwargs):
    print "Calling %s with %s and %s" % (str(fun), str(args), str(kwargs))

  def Command(self, cmd, args="", prefix="", pipe=True, cwd=None):
    print "%s %s" % (cmd, args)
    print "in %s" % cwd
    return self._mock.Call("command", cmd + " " + args, cwd=cwd)

  def ReadLine(self):
    return self._mock.Call("readline")

  def ReadURL(self, url, params):
    if params is not None:
      return self._mock.Call("readurl", url, params)
    else:
      return self._mock.Call("readurl", url)

  def Sleep(self, seconds):
    pass

  def GetDate(self):
    return "1999-07-31"

  def GetUTCStamp(self):
    return "1000000"

  def Expect(self, *args):
    """Convenience wrapper."""
    self._mock.Expect(*args)

  def setUp(self):
    self._mock = SimpleMock()
    self._tmp_files = []
    self._state = {}
    TEST_CONFIG["DEFAULT_CWD"] = self.MakeEmptyTempDirectory()

  def tearDown(self):
    if os.path.exists(TEST_CONFIG["PERSISTFILE_BASENAME"]):
      shutil.rmtree(TEST_CONFIG["PERSISTFILE_BASENAME"])

    # Clean up temps. Doesn't work automatically.
    for name in self._tmp_files:
      if os.path.isfile(name):
        os.remove(name)
      if os.path.isdir(name):
        shutil.rmtree(name)

    self._mock.AssertFinished()

  def testGitMock(self):
    self.Expect([Cmd("git --version", "git version 1.2.3"),
                 Cmd("git dummy", "")])
    self.assertEquals("git version 1.2.3", self.MakeStep().Git("--version"))
    self.assertEquals("", self.MakeStep().Git("dummy"))

  def testCommonPrepareDefault(self):
    self.Expect([
      Cmd("git status -s -uno", ""),
      Cmd("git checkout -f origin/master", ""),
      Cmd("git fetch", ""),
      Cmd("git branch", "  branch1\n* %s" % TEST_CONFIG["BRANCHNAME"]),
      RL("Y"),
      Cmd("git branch -D %s" % TEST_CONFIG["BRANCHNAME"], ""),
    ])
    self.MakeStep().CommonPrepare()
    self.MakeStep().PrepareBranch()

  def testCommonPrepareNoConfirm(self):
    self.Expect([
      Cmd("git status -s -uno", ""),
      Cmd("git checkout -f origin/master", ""),
      Cmd("git fetch", ""),
      Cmd("git branch", "  branch1\n* %s" % TEST_CONFIG["BRANCHNAME"]),
      RL("n"),
    ])
    self.MakeStep().CommonPrepare()
    self.assertRaises(Exception, self.MakeStep().PrepareBranch)

  def testCommonPrepareDeleteBranchFailure(self):
    self.Expect([
      Cmd("git status -s -uno", ""),
      Cmd("git checkout -f origin/master", ""),
      Cmd("git fetch", ""),
      Cmd("git branch", "  branch1\n* %s" % TEST_CONFIG["BRANCHNAME"]),
      RL("Y"),
      Cmd("git branch -D %s" % TEST_CONFIG["BRANCHNAME"], None),
    ])
    self.MakeStep().CommonPrepare()
    self.assertRaises(Exception, self.MakeStep().PrepareBranch)

  def testInitialEnvironmentChecks(self):
    TextToFile("", os.path.join(TEST_CONFIG["DEFAULT_CWD"], ".git"))
    os.environ["EDITOR"] = "vi"
    self.Expect([
      Cmd("which vi", "/usr/bin/vi"),
    ])
    self.MakeStep().InitialEnvironmentChecks(TEST_CONFIG["DEFAULT_CWD"])

  def testTagTimeout(self):
    self.Expect([
      Cmd("git fetch", ""),
      Cmd("git log -1 --format=%H --grep=\"Title\" origin/candidates", ""),
      Cmd("git fetch", ""),
      Cmd("git log -1 --format=%H --grep=\"Title\" origin/candidates", ""),
      Cmd("git fetch", ""),
      Cmd("git log -1 --format=%H --grep=\"Title\" origin/candidates", ""),
      Cmd("git fetch", ""),
      Cmd("git log -1 --format=%H --grep=\"Title\" origin/candidates", ""),
    ])
    args = ["--branch", "candidates", "ab12345"]
    self._state["version"] = "tag_name"
    self._state["commit_title"] = "Title"
    self.assertRaises(Exception,
        lambda: self.RunStep(MergeToBranch, TagRevision, args))

  def testReadAndPersistVersion(self):
    self.WriteFakeVersionFile(build=5)
    step = self.MakeStep()
    step.ReadAndPersistVersion()
    self.assertEquals("3", step["major"])
    self.assertEquals("22", step["minor"])
    self.assertEquals("5", step["build"])
    self.assertEquals("0", step["patch"])

  def testRegex(self):
    self.assertEqual("(issue 321)",
                     re.sub(r"BUG=v8:(.*)$", r"(issue \1)", "BUG=v8:321"))
    self.assertEqual("(Chromium issue 321)",
                     re.sub(r"BUG=(.*)$", r"(Chromium issue \1)", "BUG=321"))

    cl = "  too little\n\ttab\ttab\n         too much\n        trailing  "
    cl = MSub(r"\t", r"        ", cl)
    cl = MSub(r"^ {1,7}([^ ])", r"        \1", cl)
    cl = MSub(r"^ {9,80}([^ ])", r"        \1", cl)
    cl = MSub(r" +$", r"", cl)
    self.assertEqual("        too little\n"
                     "        tab        tab\n"
                     "        too much\n"
                     "        trailing", cl)

    self.assertEqual("//\n#define V8_BUILD_NUMBER  3\n",
                     MSub(r"(?<=#define V8_BUILD_NUMBER)(?P\s+)\d*$",
                          r"\g3",
                          "//\n#define V8_BUILD_NUMBER  321\n"))

  def testPreparePushRevision(self):
    # Tests the default push hash used when the --revision option is not set.
    self.Expect([
      Cmd("git log -1 --format=%H HEAD", "push_hash")
    ])

    self.RunStep(PushToCandidates, PreparePushRevision)
    self.assertEquals("push_hash", self._state["push_hash"])

  def testPrepareChangeLog(self):
    self.WriteFakeVersionFile()
    TEST_CONFIG["CHANGELOG_ENTRY_FILE"] = self.MakeEmptyTempFile()

    self.Expect([
      Cmd("git log --format=%H 1234..push_hash", "rev1\nrev2\nrev3\nrev4"),
      Cmd("git log -1 --format=%s rev1", "Title text 1"),
      Cmd("git log -1 --format=%B rev1", "Title\n\nBUG=\nLOG=y\n"),
      Cmd("git log -1 --format=%an rev1", "author1@chromium.org"),
      Cmd("git log -1 --format=%s rev2", "Title text 2."),
      Cmd("git log -1 --format=%B rev2", "Title\n\nBUG=123\nLOG= \n"),
      Cmd("git log -1 --format=%an rev2", "author2@chromium.org"),
      Cmd("git log -1 --format=%s rev3", "Title text 3"),
      Cmd("git log -1 --format=%B rev3", "Title\n\nBUG=321\nLOG=true\n"),
      Cmd("git log -1 --format=%an rev3", "author3@chromium.org"),
      Cmd("git log -1 --format=%s rev4", "Title text 4"),
      Cmd("git log -1 --format=%B rev4",
       ("Title\n\nBUG=456\nLOG=Y\n\n"
        "Review URL: https://codereview.chromium.org/9876543210\n")),
      URL("https://codereview.chromium.org/9876543210/description",
          "Title\n\nBUG=456\nLOG=N\n\n"),
      Cmd("git log -1 --format=%an rev4", "author4@chromium.org"),
    ])

    self._state["last_push_master"] = "1234"
    self._state["push_hash"] = "push_hash"
    self._state["version"] = "3.22.5"
    self.RunStep(PushToCandidates, PrepareChangeLog)

    actual_cl = FileToText(TEST_CONFIG["CHANGELOG_ENTRY_FILE"])

    expected_cl = """1999-07-31: Version 3.22.5

        Title text 1.

        Title text 3 (Chromium issue 321).

        Performance and stability improvements on all platforms.
#
# The change log above is auto-generated. Please review if all relevant
# commit messages from the list below are included.
# All lines starting with # will be stripped.
#
#       Title text 1.
#       (author1@chromium.org)
#
#       Title text 2 (Chromium issue 123).
#       (author2@chromium.org)
#
#       Title text 3 (Chromium issue 321).
#       (author3@chromium.org)
#
#       Title text 4 (Chromium issue 456).
#       (author4@chromium.org)
#
#"""

    self.assertEquals(expected_cl, actual_cl)

  def testEditChangeLog(self):
    TEST_CONFIG["CHANGELOG_ENTRY_FILE"] = self.MakeEmptyTempFile()
    TextToFile("  New  \n\tLines  \n", TEST_CONFIG["CHANGELOG_ENTRY_FILE"])
    os.environ["EDITOR"] = "vi"
    self.Expect([
      RL(""),  # Open editor.
      Cmd("vi %s" % TEST_CONFIG["CHANGELOG_ENTRY_FILE"], ""),
    ])

    self.RunStep(PushToCandidates, EditChangeLog)

    self.assertEquals("New\n        Lines",
                      FileToText(TEST_CONFIG["CHANGELOG_ENTRY_FILE"]))

  TAGS = """
4425.0
0.0.0.0
3.9.6
3.22.4
test_tag
"""

  # Version as tag: 3.22.4.0. Version on master: 3.22.6.
  # Make sure that the latest version is 3.22.6.0.
  def testIncrementVersion(self):
    self.Expect([
      Cmd("git fetch origin +refs/tags/*:refs/tags/*", ""),
      Cmd("git tag", self.TAGS),
      Cmd("git checkout -f origin/master -- include/v8-version.h",
          "", cb=lambda: self.WriteFakeVersionFile(3, 22, 6)),
    ])

    self.RunStep(PushToCandidates, IncrementVersion)

    self.assertEquals("3", self._state["new_major"])
    self.assertEquals("22", self._state["new_minor"])
    self.assertEquals("7", self._state["new_build"])
    self.assertEquals("0", self._state["new_patch"])

  def _TestSquashCommits(self, change_log, expected_msg):
    TEST_CONFIG["CHANGELOG_ENTRY_FILE"] = self.MakeEmptyTempFile()
    with open(TEST_CONFIG["CHANGELOG_ENTRY_FILE"], "w") as f:
      f.write(change_log)

    self.Expect([
      Cmd("git diff origin/candidates hash1", "patch content"),
    ])

    self._state["push_hash"] = "hash1"
    self._state["date"] = "1999-11-11"

    self.RunStep(PushToCandidates, SquashCommits)
    self.assertEquals(FileToText(TEST_CONFIG["COMMITMSG_FILE"]), expected_msg)

    patch = FileToText(TEST_CONFIG["PATCH_FILE"])
    self.assertTrue(re.search(r"patch content", patch))

  def testSquashCommitsUnformatted(self):
    change_log = """1999-11-11: Version 3.22.5

        Log text 1.
        Chromium issue 12345

        Performance and stability improvements on all platforms.\n"""
    commit_msg = """Version 3.22.5 (based on hash1)

Log text 1. Chromium issue 12345

Performance and stability improvements on all platforms."""
    self._TestSquashCommits(change_log, commit_msg)

  def testSquashCommitsFormatted(self):
    change_log = """1999-11-11: Version 3.22.5

        Long commit message that fills more than 80 characters (Chromium issue
        12345).

        Performance and stability improvements on all platforms.\n"""
    commit_msg = """Version 3.22.5 (based on hash1)

Long commit message that fills more than 80 characters (Chromium issue 12345).

Performance and stability improvements on all platforms."""
    self._TestSquashCommits(change_log, commit_msg)

  def testSquashCommitsQuotationMarks(self):
    change_log = """Line with "quotation marks".\n"""
    commit_msg = """Line with "quotation marks"."""
    self._TestSquashCommits(change_log, commit_msg)

  def testBootstrapper(self):
    work_dir = self.MakeEmptyTempDirectory()
    class FakeScript(ScriptsBase):
      def _Steps(self):
        return []

    # Use the test configuration without the fake testing default work dir.
    fake_config = dict(TEST_CONFIG)
    del(fake_config["DEFAULT_CWD"])

    self.Expect([
      Cmd("fetch v8", "", cwd=work_dir),
    ])
    FakeScript(fake_config, self).Run(["--work-dir", work_dir])

  def _PushToCandidates(self, force=False, manual=False):
    TextToFile("", os.path.join(TEST_CONFIG["DEFAULT_CWD"], ".git"))

    # The version file on master has build level 5, while the version
    # file from candidates has build level 4.
    self.WriteFakeVersionFile(build=5)

    TEST_CONFIG["CHANGELOG_ENTRY_FILE"] = self.MakeEmptyTempFile()
    master_change_log = "2014-03-17: Sentinel\n"
    TextToFile(master_change_log,
               os.path.join(TEST_CONFIG["DEFAULT_CWD"], CHANGELOG_FILE))
    os.environ["EDITOR"] = "vi"

    commit_msg_squashed = """Version 3.22.5 (squashed - based on push_hash)

Log text 1 (issue 321).

Performance and stability improvements on all platforms."""

    commit_msg = """Version 3.22.5 (based on push_hash)

Log text 1 (issue 321).

Performance and stability improvements on all platforms."""

    def ResetChangeLog():
      """On 'git co -b new_branch origin/candidates',
      and 'git checkout -- ChangeLog',
      the ChangLog will be reset to its content on candidates."""
      candidates_change_log = """1999-04-05: Version 3.22.4

        Performance and stability improvements on all platforms.\n"""
      TextToFile(candidates_change_log,
                 os.path.join(TEST_CONFIG["DEFAULT_CWD"], CHANGELOG_FILE))

    def ResetToCandidates():
      ResetChangeLog()
      self.WriteFakeVersionFile()

    def CheckVersionCommit():
      commit = FileToText(TEST_CONFIG["COMMITMSG_FILE"])
      self.assertEquals(commit_msg, commit)
      version = FileToText(
          os.path.join(TEST_CONFIG["DEFAULT_CWD"], VERSION_FILE))
      self.assertTrue(re.search(r"#define V8_MINOR_VERSION\s+22", version))
      self.assertTrue(re.search(r"#define V8_BUILD_NUMBER\s+5", version))
      self.assertFalse(re.search(r"#define V8_BUILD_NUMBER\s+6", version))
      self.assertTrue(re.search(r"#define V8_PATCH_LEVEL\s+0", version))
      self.assertTrue(
          re.search(r"#define V8_IS_CANDIDATE_VERSION\s+0", version))

      # Check that the change log on the candidates branch got correctly
      # modified.
      change_log = FileToText(
          os.path.join(TEST_CONFIG["DEFAULT_CWD"], CHANGELOG_FILE))
      self.assertEquals(
"""1999-07-31: Version 3.22.5

        Log text 1 (issue 321).

        Performance and stability improvements on all platforms.


1999-04-05: Version 3.22.4

        Performance and stability improvements on all platforms.\n""",
          change_log)

    force_flag = " -f" if not manual else ""
    expectations = []
    if not force:
      expectations.append(Cmd("which vi", "/usr/bin/vi"))
    expectations += [
      Cmd("git status -s -uno", ""),
      Cmd("git checkout -f origin/master", ""),
      Cmd("git fetch", ""),
      Cmd("git branch", "  branch1\n* branch2\n"),
      Cmd("git branch", "  branch1\n* branch2\n"),
      Cmd(("git new-branch %s --upstream origin/master" %
           TEST_CONFIG["BRANCHNAME"]), ""),
      Cmd("git fetch origin +refs/tags/*:refs/tags/*", ""),
      Cmd("git tag", self.TAGS),
      Cmd("git checkout -f origin/master -- include/v8-version.h",
          "", cb=self.WriteFakeVersionFile),
      Cmd("git log -1 --format=%H 3.22.4", "release_hash\n"),
      Cmd("git log -1 --format=%s release_hash",
          "Version 3.22.4 (based on abc3)\n"),
      Cmd("git log --format=%H abc3..push_hash", "rev1\n"),
      Cmd("git log -1 --format=%s rev1", "Log text 1.\n"),
      Cmd("git log -1 --format=%B rev1", "Text\nLOG=YES\nBUG=v8:321\nText\n"),
      Cmd("git log -1 --format=%an rev1", "author1@chromium.org\n"),
    ]
    if manual:
      expectations.append(RL(""))  # Open editor.
    if not force:
      expectations.append(
          Cmd("vi %s" % TEST_CONFIG["CHANGELOG_ENTRY_FILE"], ""))
    expectations += [
      Cmd("git fetch", ""),
      Cmd("git checkout -f origin/master", ""),
      Cmd("git diff origin/candidates push_hash", "patch content\n"),
      Cmd(("git new-branch %s --upstream origin/candidates" %
           TEST_CONFIG["CANDIDATESBRANCH"]), "", cb=ResetToCandidates),
      Cmd("git apply --index --reject \"%s\"" % TEST_CONFIG["PATCH_FILE"], ""),
      Cmd("git checkout -f origin/candidates -- ChangeLog", "",
          cb=ResetChangeLog),
      Cmd("git checkout -f origin/candidates -- include/v8-version.h", "",
          cb=self.WriteFakeVersionFile),
      Cmd("git commit -am \"%s\"" % commit_msg_squashed, ""),
    ]
    if manual:
      expectations.append(RL("Y"))  # Sanity check.
    expectations += [
      Cmd("git cl land -f --bypass-hooks", ""),
      Cmd("git checkout -f master", ""),
      Cmd("git fetch", ""),
      Cmd("git branch -D %s" % TEST_CONFIG["CANDIDATESBRANCH"], ""),
      Cmd(("git new-branch %s --upstream origin/candidates" %
           TEST_CONFIG["CANDIDATESBRANCH"]), "", cb=ResetToCandidates),
      Cmd("git commit -aF \"%s\"" % TEST_CONFIG["COMMITMSG_FILE"], "",
          cb=CheckVersionCommit),
      Cmd("git cl land -f --bypass-hooks", ""),
      Cmd("git fetch", ""),
      Cmd("git log -1 --format=%H --grep="
          "\"Version 3.22.5 (based on push_hash)\""
          " origin/candidates", "hsh_to_tag"),
      Cmd("git tag 3.22.5 hsh_to_tag", ""),
      Cmd("git push origin 3.22.5", ""),
      Cmd("git checkout -f origin/master", ""),
      Cmd("git branch -D %s" % TEST_CONFIG["BRANCHNAME"], ""),
      Cmd("git branch -D %s" % TEST_CONFIG["CANDIDATESBRANCH"], ""),
    ]
    self.Expect(expectations)

    args = ["-a", "author@chromium.org", "--revision", "push_hash"]
    if force: args.append("-f")
    if manual: args.append("-m")
    else: args += ["-r", "reviewer@chromium.org"]
    PushToCandidates(TEST_CONFIG, self).Run(args)

    cl = FileToText(os.path.join(TEST_CONFIG["DEFAULT_CWD"], CHANGELOG_FILE))
    self.assertTrue(re.search(r"^\d\d\d\d\-\d+\-\d+: Version 3\.22\.5", cl))
    self.assertTrue(re.search(r"        Log text 1 \(issue 321\).", cl))
    self.assertTrue(re.search(r"1999\-04\-05: Version 3\.22\.4", cl))

    # Note: The version file is on build number 5 again in the end of this test
    # since the git command that merges to master is mocked out.

  def testPushToCandidatesManual(self):
    self._PushToCandidates(manual=True)

  def testPushToCandidatesSemiAutomatic(self):
    self._PushToCandidates()

  def testPushToCandidatesForced(self):
    self._PushToCandidates(force=True)

  def testCreateRelease(self):
    TextToFile("", os.path.join(TEST_CONFIG["DEFAULT_CWD"], ".git"))

    # The version file on master has build level 5.
    self.WriteFakeVersionFile(build=5)

    master_change_log = "2014-03-17: Sentinel\n"
    TextToFile(master_change_log,
               os.path.join(TEST_CONFIG["DEFAULT_CWD"], CHANGELOG_FILE))

    commit_msg = """Version 3.22.5

Log text 1 (issue 321).

Performance and stability improvements on all platforms."""

    def ResetChangeLog():
      last_change_log = """1999-04-05: Version 3.22.4

        Performance and stability improvements on all platforms.\n"""
      TextToFile(last_change_log,
                 os.path.join(TEST_CONFIG["DEFAULT_CWD"], CHANGELOG_FILE))


    def CheckVersionCommit():
      commit = FileToText(TEST_CONFIG["COMMITMSG_FILE"])
      self.assertEquals(commit_msg, commit)
      version = FileToText(
          os.path.join(TEST_CONFIG["DEFAULT_CWD"], VERSION_FILE))
      self.assertTrue(re.search(r"#define V8_MINOR_VERSION\s+22", version))
      self.assertTrue(re.search(r"#define V8_BUILD_NUMBER\s+5", version))
      self.assertFalse(re.search(r"#define V8_BUILD_NUMBER\s+6", version))
      self.assertTrue(re.search(r"#define V8_PATCH_LEVEL\s+0", version))
      self.assertTrue(
          re.search(r"#define V8_IS_CANDIDATE_VERSION\s+0", version))

      # Check that the change log on the candidates branch got correctly
      # modified.
      change_log = FileToText(
          os.path.join(TEST_CONFIG["DEFAULT_CWD"], CHANGELOG_FILE))
      self.assertEquals(
"""1999-07-31: Version 3.22.5

        Log text 1 (issue 321).

        Performance and stability improvements on all platforms.


1999-04-05: Version 3.22.4

        Performance and stability improvements on all platforms.\n""",
          change_log)

    expectations = [
      Cmd("git fetch origin "
          "+refs/heads/*:refs/heads/* "
          "+refs/pending/*:refs/pending/* "
          "+refs/pending-tags/*:refs/pending-tags/*", ""),
      Cmd("git checkout -f origin/master", ""),
      Cmd("git branch", ""),
      Cmd("git fetch origin +refs/tags/*:refs/tags/*", ""),
      Cmd("git tag", self.TAGS),
      Cmd("git checkout -f origin/master -- include/v8-version.h",
          "", cb=self.WriteFakeVersionFile),
      Cmd("git log -1 --format=%H 3.22.4", "release_hash\n"),
      Cmd("git log -1 --format=%s release_hash", "Version 3.22.4\n"),
      Cmd("git log -1 --format=%H release_hash^", "abc3\n"),
      Cmd("git log --format=%H abc3..push_hash", "rev1\n"),
      Cmd("git log -1 --format=%s rev1", "Log text 1.\n"),
      Cmd("git log -1 --format=%B rev1", "Text\nLOG=YES\nBUG=v8:321\nText\n"),
      Cmd("git log -1 --format=%an rev1", "author1@chromium.org\n"),
      Cmd("git reset --hard origin/master", ""),
      Cmd("git checkout -b work-branch push_hash", ""),
      Cmd("git checkout -f 3.22.4 -- ChangeLog", "", cb=ResetChangeLog),
      Cmd("git checkout -f 3.22.4 -- include/v8-version.h", "",
          cb=self.WriteFakeVersionFile),
      Cmd("git commit -aF \"%s\"" % TEST_CONFIG["COMMITMSG_FILE"], "",
          cb=CheckVersionCommit),
      Cmd("git push origin "
          "refs/heads/work-branch:refs/pending/heads/3.22.5 "
          "push_hash:refs/pending-tags/heads/3.22.5 "
          "push_hash:refs/heads/3.22.5", ""),
      Cmd("git fetch", ""),
      Cmd("git log -1 --format=%H --grep="
          "\"Version 3.22.5\" origin/3.22.5", "hsh_to_tag"),
      Cmd("git tag 3.22.5 hsh_to_tag", ""),
      Cmd("git push origin 3.22.5", ""),
      Cmd("git checkout -f origin/master", ""),
      Cmd("git branch", "* master\n  work-branch\n"),
      Cmd("git branch -D work-branch", ""),
      Cmd("git gc", ""),
    ]
    self.Expect(expectations)

    args = ["-a", "author@chromium.org",
            "-r", "reviewer@chromium.org",
            "--revision", "push_hash"]
    CreateRelease(TEST_CONFIG, self).Run(args)

    cl = FileToText(os.path.join(TEST_CONFIG["DEFAULT_CWD"], CHANGELOG_FILE))
    self.assertTrue(re.search(r"^\d\d\d\d\-\d+\-\d+: Version 3\.22\.5", cl))
    self.assertTrue(re.search(r"        Log text 1 \(issue 321\).", cl))
    self.assertTrue(re.search(r"1999\-04\-05: Version 3\.22\.4", cl))

    # Note: The version file is on build number 5 again in the end of this test
    # since the git command that merges to master is mocked out.

  C_V8_22624_LOG = """V8 CL.

git-svn-id: https://v8.googlecode.com/svn/branches/bleeding_edge@22624 123

"""

  C_V8_123455_LOG = """V8 CL.

git-svn-id: https://v8.googlecode.com/svn/branches/bleeding_edge@123455 123

"""

  C_V8_123456_LOG = """V8 CL.

git-svn-id: https://v8.googlecode.com/svn/branches/bleeding_edge@123456 123

"""

  ROLL_COMMIT_MSG = """Update V8 to version 3.22.4 (based on abc).

Summary of changes available at:
https://chromium.googlesource.com/v8/v8/+log/last_rol..roll_hsh

Please follow these instructions for assigning/CC'ing issues:
https://code.google.com/p/v8-wiki/wiki/TriagingIssues

TBR=g_name@chromium.org,reviewer@chromium.org"""

  def testChromiumRoll(self):
    # Setup fake directory structures.
    TEST_CONFIG["CHROMIUM"] = self.MakeEmptyTempDirectory()
    TextToFile("", os.path.join(TEST_CONFIG["CHROMIUM"], ".git"))
    chrome_dir = TEST_CONFIG["CHROMIUM"]
    os.makedirs(os.path.join(chrome_dir, "v8"))

    # Write fake deps file.
    TextToFile("Some line\n   \"v8_revision\": \"123444\",\n  some line",
               os.path.join(chrome_dir, "DEPS"))
    def WriteDeps():
      TextToFile("Some line\n   \"v8_revision\": \"22624\",\n  some line",
                 os.path.join(chrome_dir, "DEPS"))

    expectations = [
      Cmd("git fetch origin", ""),
      Cmd("git fetch origin +refs/tags/*:refs/tags/*", ""),
      Cmd("git log -1 --format=%s roll_hsh",
          "Version 3.22.4 (based on abc)\n"),
      Cmd("git describe --tags roll_hsh", "3.22.4"),
      Cmd("git describe --tags last_roll_hsh", "3.22.2.1"),
      URL("https://chromium-build.appspot.com/p/chromium/sheriff_v8.js",
          "document.write('g_name')"),
      Cmd("git status -s -uno", "", cwd=chrome_dir),
      Cmd("git checkout -f master", "", cwd=chrome_dir),
      Cmd("git branch", "", cwd=chrome_dir),
      Cmd("gclient sync --nohooks", "syncing...", cwd=chrome_dir),
      Cmd("git pull", "", cwd=chrome_dir),
      Cmd("git fetch origin", ""),
      Cmd("git new-branch work-branch", "", cwd=chrome_dir),
      Cmd("roll-dep-svn v8 roll_hsh", "rolled", cb=WriteDeps, cwd=chrome_dir),
      Cmd(("git commit -am \"%s\" "
           "--author \"author@chromium.org \"" %
           self.ROLL_COMMIT_MSG),
          "", cwd=chrome_dir),
      Cmd("git cl upload --send-mail --email \"author@chromium.org\" -f", "",
          cwd=chrome_dir),
      Cmd("git checkout -f master", "", cwd=chrome_dir),
      Cmd("git branch -D work-branch", "", cwd=chrome_dir),
    ]
    self.Expect(expectations)

    args = ["-a", "author@chromium.org", "-c", chrome_dir,
            "--sheriff",
            "-r", "reviewer@chromium.org",
            "--last-roll", "last_roll_hsh",
            "roll_hsh"]
    ChromiumRoll(TEST_CONFIG, self).Run(args)

    deps = FileToText(os.path.join(chrome_dir, "DEPS"))
    self.assertTrue(re.search("\"v8_revision\": \"22624\"", deps))

  def testCheckLastPushRecently(self):
    self.Expect([
      Cmd("git fetch origin +refs/tags/*:refs/tags/*", ""),
      Cmd("git tag", self.TAGS),
      Cmd("git log -1 --format=%H 3.22.4", "release_hash\n"),
      Cmd("git log -1 --format=%s release_hash",
          "Version 3.22.4 (based on abc3)\n"),
      Cmd("git log --format=%H abc3..abc123", "\n"),
    ])

    self._state["candidate"] = "abc123"
    self.assertEquals(0, self.RunStep(
        auto_push.AutoPush, LastReleaseBailout, AUTO_PUSH_ARGS))

  def testAutoPush(self):
    self.Expect([
      Cmd("git fetch", ""),
      Cmd("git fetch origin +refs/heads/roll:refs/heads/roll", ""),
      Cmd("git show-ref -s refs/heads/roll", "abc123\n"),
      Cmd("git fetch origin +refs/tags/*:refs/tags/*", ""),
      Cmd("git tag", self.TAGS),
      Cmd("git log -1 --format=%H 3.22.4", "release_hash\n"),
      Cmd("git log -1 --format=%s release_hash",
          "Version 3.22.4 (based on abc3)\n"),
      Cmd("git log --format=%H abc3..abc123", "some_stuff\n"),
    ])

    auto_push.AutoPush(TEST_CONFIG, self).Run(AUTO_PUSH_ARGS + ["--push"])

    state = json.loads(FileToText("%s-state.json"
                                  % TEST_CONFIG["PERSISTFILE_BASENAME"]))

    self.assertEquals("abc123", state["candidate"])

  def testAutoRollExistingRoll(self):
    self.Expect([
      URL("https://codereview.chromium.org/search",
          "owner=author%40chromium.org&limit=30&closed=3&format=json",
          ("{\"results\": [{\"subject\": \"different\"},"
           "{\"subject\": \"Update V8 to Version...\"}]}")),
    ])

    result = auto_roll.AutoRoll(TEST_CONFIG, self).Run(
        AUTO_PUSH_ARGS + ["-c", TEST_CONFIG["CHROMIUM"]])
    self.assertEquals(0, result)

  # Snippet from the original DEPS file.
  FAKE_DEPS = """
vars = {
  "v8_revision": "abcd123455",
}
deps = {
  "src/v8":
    (Var("googlecode_url") % "v8") + "/" + Var("v8_branch") + "@" +
    Var("v8_revision"),
}
"""

  def testAutoRollUpToDate(self):
    TEST_CONFIG["CHROMIUM"] = self.MakeEmptyTempDirectory()
    TextToFile(self.FAKE_DEPS, os.path.join(TEST_CONFIG["CHROMIUM"], "DEPS"))
    self.Expect([
      URL("https://codereview.chromium.org/search",
          "owner=author%40chromium.org&limit=30&closed=3&format=json",
          ("{\"results\": [{\"subject\": \"different\"}]}")),
      Cmd("git fetch origin +refs/tags/*:refs/tags/*", ""),
      Cmd("git rev-list --max-age=740800 --tags",
          "bad_tag\nhash_234\nhash_123"),
      Cmd("git describe --tags bad_tag", ""),
      Cmd("git describe --tags hash_234", "3.22.4"),
      Cmd("git describe --tags hash_123", "3.22.3"),
      Cmd("git describe --tags abcd123455", "3.22.4"),
      Cmd("git describe --tags hash_234", "3.22.4"),
      Cmd("git describe --tags hash_123", "3.22.3"),
    ])

    result = auto_roll.AutoRoll(TEST_CONFIG, self).Run(
        AUTO_PUSH_ARGS + ["-c", TEST_CONFIG["CHROMIUM"]])
    self.assertEquals(0, result)

  def testAutoRoll(self):
    TEST_CONFIG["CHROMIUM"] = self.MakeEmptyTempDirectory()
    TextToFile(self.FAKE_DEPS, os.path.join(TEST_CONFIG["CHROMIUM"], "DEPS"))

    self.Expect([
      URL("https://codereview.chromium.org/search",
          "owner=author%40chromium.org&limit=30&closed=3&format=json",
          ("{\"results\": [{\"subject\": \"different\"}]}")),
      Cmd("git fetch origin +refs/tags/*:refs/tags/*", ""),
      Cmd("git rev-list --max-age=740800 --tags",
          "bad_tag\nhash_234\nhash_123"),
      Cmd("git describe --tags bad_tag", ""),
      Cmd("git describe --tags hash_234", "3.22.4"),
      Cmd("git describe --tags hash_123", "3.22.3"),
      Cmd("git describe --tags abcd123455", "3.22.3.1"),
      Cmd("git describe --tags hash_234", "3.22.4"),
    ])

    result = auto_roll.AutoRoll(TEST_CONFIG, self).Run(
        AUTO_PUSH_ARGS + ["-c", TEST_CONFIG["CHROMIUM"], "--roll"])
    self.assertEquals(0, result)

  def testMergeToBranch(self):
    TEST_CONFIG["ALREADY_MERGING_SENTINEL_FILE"] = self.MakeEmptyTempFile()
    TextToFile("", os.path.join(TEST_CONFIG["DEFAULT_CWD"], ".git"))
    self.WriteFakeVersionFile(build=5)
    os.environ["EDITOR"] = "vi"
    extra_patch = self.MakeEmptyTempFile()

    def VerifyPatch(patch):
      return lambda: self.assertEquals(patch,
          FileToText(TEST_CONFIG["TEMPORARY_PATCH_FILE"]))

    msg = """Version 3.22.5.1 (cherry-pick)

Merged ab12345
Merged ab23456
Merged ab34567
Merged ab45678
Merged ab56789

Title4

Title2

Title3

Title1

Revert "Something"

BUG=123,234,345,456,567,v8:123
LOG=N
"""

    def VerifyLand():
      commit = FileToText(TEST_CONFIG["COMMITMSG_FILE"])
      self.assertEquals(msg, commit)
      version = FileToText(
          os.path.join(TEST_CONFIG["DEFAULT_CWD"], VERSION_FILE))
      self.assertTrue(re.search(r"#define V8_MINOR_VERSION\s+22", version))
      self.assertTrue(re.search(r"#define V8_BUILD_NUMBER\s+5", version))
      self.assertTrue(re.search(r"#define V8_PATCH_LEVEL\s+1", version))
      self.assertTrue(
          re.search(r"#define V8_IS_CANDIDATE_VERSION\s+0", version))

    self.Expect([
      Cmd("git status -s -uno", ""),
      Cmd("git checkout -f origin/master", ""),
      Cmd("git fetch", ""),
      Cmd("git branch", "  branch1\n* branch2\n"),
      Cmd("git new-branch %s --upstream refs/remotes/origin/candidates" %
          TEST_CONFIG["BRANCHNAME"], ""),
      Cmd(("git log --format=%H --grep=\"Port ab12345\" "
           "--reverse origin/master"),
          "ab45678\nab23456"),
      Cmd("git log -1 --format=%s ab45678", "Title1"),
      Cmd("git log -1 --format=%s ab23456", "Title2"),
      Cmd(("git log --format=%H --grep=\"Port ab23456\" "
           "--reverse origin/master"),
          ""),
      Cmd(("git log --format=%H --grep=\"Port ab34567\" "
           "--reverse origin/master"),
          "ab56789"),
      Cmd("git log -1 --format=%s ab56789", "Title3"),
      RL("Y"),  # Automatically add corresponding ports (ab34567, ab56789)?
      # Simulate git being down which stops the script.
      Cmd("git log -1 --format=%s ab12345", None),
      # Restart script in the failing step.
      Cmd("git log -1 --format=%s ab12345", "Title4"),
      Cmd("git log -1 --format=%s ab23456", "Title2"),
      Cmd("git log -1 --format=%s ab34567", "Title3"),
      Cmd("git log -1 --format=%s ab45678", "Title1"),
      Cmd("git log -1 --format=%s ab56789", "Revert \"Something\""),
      Cmd("git log -1 ab12345", "Title4\nBUG=123\nBUG=234"),
      Cmd("git log -1 ab23456", "Title2\n BUG = v8:123,345"),
      Cmd("git log -1 ab34567", "Title3\nLOG=n\nBUG=567, 456"),
      Cmd("git log -1 ab45678", "Title1\nBUG="),
      Cmd("git log -1 ab56789", "Revert \"Something\"\nBUG=none"),
      Cmd("git log -1 -p ab12345", "patch4"),
      Cmd(("git apply --index --reject \"%s\"" %
           TEST_CONFIG["TEMPORARY_PATCH_FILE"]),
          "", cb=VerifyPatch("patch4")),
      Cmd("git log -1 -p ab23456", "patch2"),
      Cmd(("git apply --index --reject \"%s\"" %
           TEST_CONFIG["TEMPORARY_PATCH_FILE"]),
          "", cb=VerifyPatch("patch2")),
      Cmd("git log -1 -p ab34567", "patch3"),
      Cmd(("git apply --index --reject \"%s\"" %
           TEST_CONFIG["TEMPORARY_PATCH_FILE"]),
          "", cb=VerifyPatch("patch3")),
      Cmd("git log -1 -p ab45678", "patch1"),
      Cmd(("git apply --index --reject \"%s\"" %
           TEST_CONFIG["TEMPORARY_PATCH_FILE"]),
          "", cb=VerifyPatch("patch1")),
      Cmd("git log -1 -p ab56789", "patch5\n"),
      Cmd(("git apply --index --reject \"%s\"" %
           TEST_CONFIG["TEMPORARY_PATCH_FILE"]),
          "", cb=VerifyPatch("patch5\n")),
      Cmd("git apply --index --reject \"%s\"" % extra_patch, ""),
      RL("Y"),  # Automatically increment patch level?
      Cmd("git commit -aF \"%s\"" % TEST_CONFIG["COMMITMSG_FILE"], ""),
      RL("reviewer@chromium.org"),  # V8 reviewer.
      Cmd("git cl upload --send-mail -r \"reviewer@chromium.org\" "
          "--bypass-hooks --cc \"ulan@chromium.org\"", ""),
      Cmd("git checkout -f %s" % TEST_CONFIG["BRANCHNAME"], ""),
      RL("LGTM"),  # Enter LGTM for V8 CL.
      Cmd("git cl presubmit", "Presubmit successfull\n"),
      Cmd("git cl land -f --bypass-hooks", "Closing issue\n",
          cb=VerifyLand),
      Cmd("git fetch", ""),
      Cmd("git log -1 --format=%H --grep=\""
          "Version 3.22.5.1 (cherry-pick)"
          "\" refs/remotes/origin/candidates",
          ""),
      Cmd("git fetch", ""),
      Cmd("git log -1 --format=%H --grep=\""
          "Version 3.22.5.1 (cherry-pick)"
          "\" refs/remotes/origin/candidates",
          "hsh_to_tag"),
      Cmd("git tag 3.22.5.1 hsh_to_tag", ""),
      Cmd("git push origin 3.22.5.1", ""),
      Cmd("git checkout -f origin/master", ""),
      Cmd("git branch -D %s" % TEST_CONFIG["BRANCHNAME"], ""),
    ])

    # ab12345 and ab34567 are patches. ab23456 (included) and ab45678 are the
    # MIPS ports of ab12345. ab56789 is the MIPS port of ab34567.
    args = ["-f", "-p", extra_patch, "--branch", "candidates",
            "ab12345", "ab23456", "ab34567"]

    # The first run of the script stops because of git being down.
    self.assertRaises(GitFailedException,
        lambda: MergeToBranch(TEST_CONFIG, self).Run(args))

    # Test that state recovery after restarting the script works.
    args += ["-s", "4"]
    MergeToBranch(TEST_CONFIG, self).Run(args)

  def testReleases(self):
    c_hash1_commit_log = """Update V8 to Version 4.2.71.

Cr-Commit-Position: refs/heads/master@{#5678}
"""
    c_hash2_commit_log = """Revert something.

BUG=12345

Reason:
> Some reason.
> Cr-Commit-Position: refs/heads/master@{#12345}
> git-svn-id: svn://svn.chromium.org/chrome/trunk/src@12345 003-1c4

Review URL: https://codereview.chromium.org/12345

Cr-Commit-Position: refs/heads/master@{#4567}
git-svn-id: svn://svn.chromium.org/chrome/trunk/src@4567 0039-1c4b

"""
    c_hash3_commit_log = """Simple.

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@3456 0039-1c4b

"""
    c_hash_234_commit_log = """Version 3.3.1.1 (cherry-pick).

Merged abc12.

Review URL: fake.com

Cr-Commit-Position: refs/heads/candidates@{#234}
"""
    c_hash_123_commit_log = """Version 3.3.1.0

git-svn-id: googlecode@123 0039-1c4b
"""
    c_hash_345_commit_log = """Version 3.4.0.

Cr-Commit-Position: refs/heads/candidates@{#345}
"""
    c_hash_456_commit_log = """Version 4.2.71.

Cr-Commit-Position: refs/heads/4.2.71@{#1}
"""
    c_deps = "Line\n   \"v8_revision\": \"%s\",\n  line\n"

    json_output = self.MakeEmptyTempFile()
    csv_output = self.MakeEmptyTempFile()
    self.WriteFakeVersionFile()

    TEST_CONFIG["CHROMIUM"] = self.MakeEmptyTempDirectory()
    chrome_dir = TEST_CONFIG["CHROMIUM"]
    chrome_v8_dir = os.path.join(chrome_dir, "v8")
    os.makedirs(chrome_v8_dir)

    def ResetVersion(major, minor, build, patch=0):
      return lambda: self.WriteFakeVersionFile(major=major,
                                               minor=minor,
                                               build=build,
                                               patch=patch)

    self.Expect([
      Cmd("git status -s -uno", ""),
      Cmd("git checkout -f origin/master", ""),
      Cmd("git fetch", ""),
      Cmd("git branch", "  branch1\n* branch2\n"),
      Cmd("git new-branch %s" % TEST_CONFIG["BRANCHNAME"], ""),
      Cmd("git fetch origin +refs/tags/*:refs/tags/*", ""),
      Cmd("git rev-list --max-age=395200 --tags",
          "bad_tag\nhash_234\nhash_123\nhash_345\nhash_456\n"),
      Cmd("git describe --tags bad_tag", "3.23.42-1-deadbeef"),
      Cmd("git describe --tags hash_234", "3.3.1.1"),
      Cmd("git describe --tags hash_123", "3.21.2"),
      Cmd("git describe --tags hash_345", "3.22.3"),
      Cmd("git describe --tags hash_456", "4.2.71"),
      Cmd("git diff --name-only hash_234 hash_234^", VERSION_FILE),
      Cmd("git checkout -f hash_234 -- %s" % VERSION_FILE, "",
          cb=ResetVersion(3, 3, 1, 1)),
      Cmd("git branch -r --contains hash_234", "  branch-heads/3.3\n"),
      Cmd("git log -1 --format=%B hash_234", c_hash_234_commit_log),
      Cmd("git log -1 --format=%s hash_234", ""),
      Cmd("git log -1 --format=%B hash_234", c_hash_234_commit_log),
      Cmd("git log -1 --format=%ci hash_234", "18:15"),
      Cmd("git checkout -f HEAD -- %s" % VERSION_FILE, "",
          cb=ResetVersion(3, 22, 5)),
      Cmd("git diff --name-only hash_123 hash_123^", VERSION_FILE),
      Cmd("git checkout -f hash_123 -- %s" % VERSION_FILE, "",
          cb=ResetVersion(3, 21, 2)),
      Cmd("git branch -r --contains hash_123", "  branch-heads/3.21\n"),
      Cmd("git log -1 --format=%B hash_123", c_hash_123_commit_log),
      Cmd("git log -1 --format=%s hash_123", ""),
      Cmd("git log -1 --format=%B hash_123", c_hash_123_commit_log),
      Cmd("git log -1 --format=%ci hash_123", "03:15"),
      Cmd("git checkout -f HEAD -- %s" % VERSION_FILE, "",
          cb=ResetVersion(3, 22, 5)),
      Cmd("git diff --name-only hash_345 hash_345^", VERSION_FILE),
      Cmd("git checkout -f hash_345 -- %s" % VERSION_FILE, "",
          cb=ResetVersion(3, 22, 3)),
      Cmd("git branch -r --contains hash_345", "  origin/candidates\n"),
      Cmd("git log -1 --format=%B hash_345", c_hash_345_commit_log),
      Cmd("git log -1 --format=%s hash_345", ""),
      Cmd("git log -1 --format=%B hash_345", c_hash_345_commit_log),
      Cmd("git log -1 --format=%ci hash_345", ""),
      Cmd("git checkout -f HEAD -- %s" % VERSION_FILE, "",
          cb=ResetVersion(3, 22, 5)),
      Cmd("git diff --name-only hash_456 hash_456^", VERSION_FILE),
      Cmd("git checkout -f hash_456 -- %s" % VERSION_FILE, "",
          cb=ResetVersion(4, 2, 71)),
      Cmd("git branch -r --contains hash_456", "  origin/4.2.71\n"),
      Cmd("git log -1 --format=%B hash_456", c_hash_456_commit_log),
      Cmd("git log -1 --format=%H 4.2.71", "hash_456"),
      Cmd("git log -1 --format=%s hash_456", "Version 4.2.71"),
      Cmd("git log -1 --format=%H hash_456^", "master_456"),
      Cmd("git log -1 --format=%B master_456",
          "Cr-Commit-Position: refs/heads/master@{#456}"),
      Cmd("git log -1 --format=%B hash_456", c_hash_456_commit_log),
      Cmd("git log -1 --format=%ci hash_456", "02:15"),
      Cmd("git checkout -f HEAD -- %s" % VERSION_FILE, "",
          cb=ResetVersion(3, 22, 5)),
      Cmd("git fetch origin +refs/heads/*:refs/remotes/origin/* "
          "+refs/branch-heads/*:refs/remotes/branch-heads/*", "",
          cwd=chrome_dir),
      Cmd("git fetch origin", "", cwd=chrome_v8_dir),
      Cmd("git log --format=%H --grep=\"V8\" origin/master -- DEPS",
          "c_hash1\nc_hash2\nc_hash3\n",
          cwd=chrome_dir),
      Cmd("git show c_hash1:DEPS", c_deps % "hash_456", cwd=chrome_dir),
      Cmd("git log -1 --format=%B c_hash1", c_hash1_commit_log,
          cwd=chrome_dir),
      Cmd("git show c_hash2:DEPS", c_deps % "hash_345", cwd=chrome_dir),
      Cmd("git log -1 --format=%B c_hash2", c_hash2_commit_log,
          cwd=chrome_dir),
      Cmd("git show c_hash3:DEPS", c_deps % "deadbeef", cwd=chrome_dir),
      Cmd("git log -1 --format=%B c_hash3", c_hash3_commit_log,
          cwd=chrome_dir),
      Cmd("git branch -r", " weird/123\n  branch-heads/7\n", cwd=chrome_dir),
      Cmd("git show refs/branch-heads/7:DEPS", c_deps % "hash_345",
          cwd=chrome_dir),
      URL("http://omahaproxy.appspot.com/all.json", """[{
        "os": "win",
        "versions": [{
          "version": "2.2.2.2",
          "v8_version": "22.2.2.2",
          "current_reldate": "04/09/15",
          "os": "win",
          "channel": "canary",
          "previous_version": "1.1.1.0"
          }]
        }]"""),
      URL("http://omahaproxy.appspot.com/v8.json?version=1.1.1.0", """{
        "chromium_version": "1.1.1.0",
        "v8_version": "11.1.1.0"
        }"""),
      Cmd("git rev-list -1 11.1.1", "v8_previous_version_hash"),
      Cmd("git rev-list -1 22.2.2.2", "v8_version_hash"),
      Cmd("git checkout -f origin/master", ""),
      Cmd("git branch -D %s" % TEST_CONFIG["BRANCHNAME"], "")
    ])

    args = ["-c", TEST_CONFIG["CHROMIUM"],
            "--json", json_output,
            "--csv", csv_output,
            "--max-releases", "1"]
    Releases(TEST_CONFIG, self).Run(args)

    # Check expected output.
    csv = ("4.2.71,4.2.71,1,5678,\r\n"
           "3.22.3,candidates,345,4567:5677,\r\n"
           "3.21.2,3.21,123,,\r\n"
           "3.3.1.1,3.3,234,,abc12\r\n")
    self.assertEquals(csv, FileToText(csv_output))

    expected_json = {"chrome_releases":{
                                        "canaries": [
                                                     {
                           "chrome_version": "2.2.2.2",
                           "os": "win",
                           "release_date": "04/09/15",
                           "v8_version": "22.2.2.2",
                           "v8_version_hash": "v8_version_hash",
                           "v8_previous_version": "11.1.1.0",
                           "v8_previous_version_hash": "v8_previous_version_hash"
                           }]},
                     "releases":[
      {
        "revision": "1",
        "revision_git": "hash_456",
        "master_position": "456",
        "master_hash": "master_456",
        "patches_merged": "",
        "version": "4.2.71",
        "chromium_revision": "5678",
        "branch": "4.2.71",
        "review_link": "",
        "date": "02:15",
        "chromium_branch": "",
        # FIXME(machenbach): Fix revisions link for git.
        "revision_link": "https://code.google.com/p/v8/source/detail?r=1",
      },
      {
        "revision": "345",
        "revision_git": "hash_345",
        "master_position": "",
        "master_hash": "",
        "patches_merged": "",
        "version": "3.22.3",
        "chromium_revision": "4567:5677",
        "branch": "candidates",
        "review_link": "",
        "date": "",
        "chromium_branch": "7",
        "revision_link": "https://code.google.com/p/v8/source/detail?r=345",
      },
      {
        "revision": "123",
        "revision_git": "hash_123",
        "patches_merged": "",
        "master_position": "",
        "master_hash": "",
        "version": "3.21.2",
        "chromium_revision": "",
        "branch": "3.21",
        "review_link": "",
        "date": "03:15",
        "chromium_branch": "",
        "revision_link": "https://code.google.com/p/v8/source/detail?r=123",
      },
      {
        "revision": "234",
        "revision_git": "hash_234",
        "patches_merged": "abc12",
        "master_position": "",
        "master_hash": "",
        "version": "3.3.1.1",
        "chromium_revision": "",
        "branch": "3.3",
        "review_link": "fake.com",
        "date": "18:15",
        "chromium_branch": "",
        "revision_link": "https://code.google.com/p/v8/source/detail?r=234",
      },],
    }
    self.assertEquals(expected_json, json.loads(FileToText(json_output)))


class SystemTest(unittest.TestCase):
  def testReload(self):
    options = ScriptsBase(
        TEST_CONFIG, DEFAULT_SIDE_EFFECT_HANDLER, {}).MakeOptions([])
    step = MakeStep(step_class=PrepareChangeLog, number=0, state={}, config={},
                    options=options,
                    side_effect_handler=DEFAULT_SIDE_EFFECT_HANDLER)
    body = step.Reload(
"""------------------------------------------------------------------------
r17997 | machenbach@chromium.org | 2013-11-22 11:04:04 +0100 (...) | 6 lines

Prepare push to trunk.  Now working on version 3.23.11.

R=danno@chromium.org

Review URL: https://codereview.chromium.org/83173002

------------------------------------------------------------------------""")
    self.assertEquals(
"""Prepare push to trunk.  Now working on version 3.23.11.

R=danno@chromium.org

Committed: https://code.google.com/p/v8/source/detail?r=17997""", body)
node-v4.8.2/deps/v8/tools/release/test_search_related_commits.py000755 000766 000024 00000020116 13070706735 025144 0ustar00iojsstaff000000 000000 #!/usr/bin/env python
# Copyright 2015 the V8 project authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

from collections import namedtuple
from os import path
import search_related_commits
import shutil
from subprocess import Popen, PIPE, check_call
import unittest


TEST_CONFIG = {
  "GIT_REPO": "/tmp/test-v8-search-related-commits",
}

class TestSearchRelatedCommits(unittest.TestCase):

  base_dir = TEST_CONFIG["GIT_REPO"]

  def _execute_git(self, git_args):

    fullCommand = ["git", "-C", self.base_dir] + git_args
    p = Popen(args=fullCommand, stdin=PIPE,
        stdout=PIPE, stderr=PIPE)
    output, err = p.communicate()
    rc = p.returncode
    if rc != 0:
      raise Exception(err)
    return output

  def setUp(self):
    if path.exists(self.base_dir):
      shutil.rmtree(self.base_dir)

    check_call(["git", "init", self.base_dir])

    # Initial commit
    message = """[turbofan] Sanitize language mode for javascript operators.

    R=mstarzinger@chromium.org

    Review URL: https://codereview.chromium.org/1084243005

    Cr-Commit-Position: refs/heads/master@{#28059}"""
    self._make_empty_commit(message)

    message = """[crankshaft] Do some stuff

    R=hablich@chromium.org

    Review URL: https://codereview.chromium.org/1084243007

    Cr-Commit-Position: refs/heads/master@{#28030}"""

    self._make_empty_commit(message)

  def tearDown(self):
    if path.exists(self.base_dir):
      shutil.rmtree(self.base_dir)

  def _assert_correct_standard_result(
      self, result, all_commits, hash_of_first_commit):
    self.assertEqual(len(result), 1, "Master commit not found")
    self.assertTrue(
        result.get(hash_of_first_commit),
        "Master commit is wrong")

    self.assertEqual(
        len(result[hash_of_first_commit]),
        1,
        "Child commit not found")
    self.assertEqual(
        all_commits[2],
        result[hash_of_first_commit][0],
        "Child commit wrong")

  def _get_commits(self):
    commits = self._execute_git(
        ["log", "--format=%H", "--reverse"]).splitlines()
    return commits

  def _make_empty_commit(self, message):
    self._execute_git(["commit", "--allow-empty", "-m", message])

  def testSearchByCommitPosition(self):
    message = """Revert of some stuff.
    > Cr-Commit-Position: refs/heads/master@{#28059}
    R=mstarzinger@chromium.org

    Review URL: https://codereview.chromium.org/1084243005

    Cr-Commit-Position: refs/heads/master@{#28088}"""

    self._make_empty_commit(message)

    commits = self._get_commits()
    hash_of_first_commit = commits[0]

    result = search_related_commits.search_all_related_commits(
        self.base_dir, hash_of_first_commit, "HEAD", None)

    self._assert_correct_standard_result(result, commits, hash_of_first_commit)

  def testSearchByTitle(self):
    message = """Revert of some stuff.
    > [turbofan] Sanitize language mode for javascript operators.
    > Cr-Commit-Position: refs/heads/master@{#289}
    R=mstarzinger@chromium.org

    Review URL: https://codereview.chromium.org/1084243005

    Cr-Commit-Position: refs/heads/master@{#28088}"""

    self._make_empty_commit(message)

    commits = self._get_commits()
    hash_of_first_commit = commits[0]

    result = search_related_commits.search_all_related_commits(
        self.base_dir, hash_of_first_commit, "HEAD", None)

    self._assert_correct_standard_result(result, commits, hash_of_first_commit)

  def testSearchByHash(self):
    commits = self._get_commits()
    hash_of_first_commit = commits[0]

    message = """Revert of some stuff.
    > [turbofan] Sanitize language mode for javascript operators.
    > Reverting """ + hash_of_first_commit + """
    > R=mstarzinger@chromium.org

    Review URL: https://codereview.chromium.org/1084243005

    Cr-Commit-Position: refs/heads/master@{#28088}"""

    self._make_empty_commit(message)

    #Fetch again for an update
    commits = self._get_commits()
    hash_of_first_commit = commits[0]

    result = search_related_commits.search_all_related_commits(
        self.base_dir,
        hash_of_first_commit,
        "HEAD",
        None)

    self._assert_correct_standard_result(result, commits, hash_of_first_commit)

  def testConsiderSeparator(self):
    commits = self._get_commits()
    hash_of_first_commit = commits[0]

    # Related commits happen before separator so it is not a hit
    message = """Revert of some stuff: Not a hit
    > [turbofan] Sanitize language mode for javascript operators.
    > Reverting """ + hash_of_first_commit + """
    > R=mstarzinger@chromium.org

    Review URL: https://codereview.chromium.org/1084243005

    Cr-Commit-Position: refs/heads/master@{#28088}"""
    self._make_empty_commit(message)

    # Related commits happen before and after separator so it is a hit
    commit_pos_of_master = "27088"
    message = """Implement awesome feature: Master commit

    Review URL: https://codereview.chromium.org/1084243235

    Cr-Commit-Position: refs/heads/master@{#""" + commit_pos_of_master + "}"
    self._make_empty_commit(message)

    # Separator commit
    message = """Commit which is the origin of the branch

    Review URL: https://codereview.chromium.org/1084243456

    Cr-Commit-Position: refs/heads/master@{#28173}"""
    self._make_empty_commit(message)

    # Filler commit
    message = "Some unrelated commit: Not a hit"
    self._make_empty_commit(message)

    # Related commit after separator: a hit
    message = "Patch r" + commit_pos_of_master +""" done

    Review URL: https://codereview.chromium.org/1084243235

    Cr-Commit-Position: refs/heads/master@{#29567}"""
    self._make_empty_commit(message)

    #Fetch again for an update
    commits = self._get_commits()
    hash_of_first_commit = commits[0]
    hash_of_hit = commits[3]
    hash_of_separator = commits[4]
    hash_of_child_hit = commits[6]

    result = search_related_commits.search_all_related_commits(
        self.base_dir,
        hash_of_first_commit,
        "HEAD",
        hash_of_separator)

    self.assertTrue(result.get(hash_of_hit), "Hit not found")
    self.assertEqual(len(result), 1, "More than one hit found")
    self.assertEqual(
        len(result.get(hash_of_hit)),
        1,
        "More than one child hit found")
    self.assertEqual(
        result.get(hash_of_hit)[0],
        hash_of_child_hit,
        "Wrong commit found")

  def testPrettyPrint(self):
    message = """Revert of some stuff.
    > [turbofan] Sanitize language mode for javascript operators.
    > Cr-Commit-Position: refs/heads/master@{#289}
    R=mstarzinger@chromium.org

    Review URL: https://codereview.chromium.org/1084243005

    Cr-Commit-Position: refs/heads/master@{#28088}"""

    self._make_empty_commit(message)

    commits = self._get_commits()
    hash_of_first_commit = commits[0]
    OptionsStruct = namedtuple(
        "OptionsStruct",
        "git_dir of until all prettyprint separator verbose")
    options = OptionsStruct(
        git_dir= self.base_dir,
        of= [hash_of_first_commit],
        until= [commits[2]],
        all= True,
        prettyprint= True,
        separator = None,
        verbose=False)
    output = []
    for current_line in search_related_commits.main(options):
      output.append(current_line)

    self.assertIs(len(output), 2, "Not exactly two entries written")
    self.assertTrue(output[0].startswith("+"), "Master entry not marked with +")
    self.assertTrue(output[1].startswith("| "), "Child entry not marked with |")

  def testNothingFound(self):
    commits = self._get_commits()

    self._execute_git(["commit", "--allow-empty", "-m", "A"])
    self._execute_git(["commit", "--allow-empty", "-m", "B"])
    self._execute_git(["commit", "--allow-empty", "-m", "C"])
    self._execute_git(["commit", "--allow-empty", "-m", "D"])

    hash_of_first_commit = commits[0]
    result = search_related_commits.search_all_related_commits(
        self.base_dir,
        hash_of_first_commit,
        "HEAD",
        None)

    self.assertEqual(len(result), 0, "Results found where none should be.")


if __name__ == "__main__":
  #import sys;sys.argv = ['', 'Test.testName']
   unittest.main()
node-v4.8.2/deps/v8/tools/perf_tests/chromium_revision000644 000766 000024 00000000007 13070706735 023247 0ustar00iojsstaff000000 000000 210122
node-v4.8.2/deps/v8/tools/oom_dump/oom_dump.cc000644 000766 000024 00000022132 13070706735 021355 0ustar00iojsstaff000000 000000 // Copyright 2010 the V8 project authors. All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
//       copyright notice, this list of conditions and the following
//       disclaimer in the documentation and/or other materials provided
//       with the distribution.
//     * Neither the name of Google Inc. nor the names of its
//       contributors may be used to endorse or promote products derived
//       from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#include 
#include 

#include 

#include 

#include 

namespace {

using google_breakpad::Minidump;
using google_breakpad::MinidumpContext;
using google_breakpad::MinidumpThread;
using google_breakpad::MinidumpThreadList;
using google_breakpad::MinidumpException;
using google_breakpad::MinidumpMemoryRegion;

const char* InstanceTypeToString(int type) {
  static char const* names[v8::internal::LAST_TYPE] = {0};
  if (names[v8::internal::STRING_TYPE] == NULL) {
    using namespace v8::internal;
#define SET(type) names[type] = #type;
    INSTANCE_TYPE_LIST(SET)
#undef SET
  }
  return names[type];
}


u_int32_t ReadPointedValue(MinidumpMemoryRegion* region,
                           u_int64_t base,
                           int offset) {
  u_int32_t ptr = 0;
  CHECK(region->GetMemoryAtAddress(base + 4 * offset, &ptr));
  u_int32_t value = 0;
  CHECK(region->GetMemoryAtAddress(ptr, &value));
  return value;
}


void ReadArray(MinidumpMemoryRegion* region,
               u_int64_t array_ptr,
               int size,
               int* output) {
  for (int i = 0; i < size; i++) {
    u_int32_t value;
    CHECK(region->GetMemoryAtAddress(array_ptr + 4 * i, &value));
    output[i] = value;
  }
}


u_int32_t ReadArrayFrom(MinidumpMemoryRegion* region,
                        u_int64_t base,
                        int offset,
                        int size,
                        int* output) {
  u_int32_t ptr = 0;
  CHECK(region->GetMemoryAtAddress(base + 4 * offset, &ptr));
  ReadArray(region, ptr, size, output);
}


double toM(int size) {
  return size / (1024. * 1024.);
}


class IndirectSorter {
 public:
  explicit IndirectSorter(int* a) : a_(a) { }

  bool operator() (int i0, int i1) {
    return a_[i0] > a_[i1];
  }

 private:
  int* a_;
};


void DumpHeapStats(const char *minidump_file) {
  Minidump minidump(minidump_file);
  CHECK(minidump.Read());

  MinidumpException *exception = minidump.GetException();
  CHECK(exception);

  MinidumpContext* crash_context = exception->GetContext();
  CHECK(crash_context);

  u_int32_t exception_thread_id = 0;
  CHECK(exception->GetThreadID(&exception_thread_id));

  MinidumpThreadList* thread_list = minidump.GetThreadList();
  CHECK(thread_list);

  MinidumpThread* exception_thread =
      thread_list->GetThreadByID(exception_thread_id);
  CHECK(exception_thread);

  // Currently only 32-bit Windows minidumps are supported.
  CHECK_EQ(MD_CONTEXT_X86, crash_context->GetContextCPU());

  const MDRawContextX86* contextX86 = crash_context->GetContextX86();
  CHECK(contextX86);

  const u_int32_t esp = contextX86->esp;

  MinidumpMemoryRegion* memory_region = exception_thread->GetMemory();
  CHECK(memory_region);

  const u_int64_t last = memory_region->GetBase() + memory_region->GetSize();

  u_int64_t heap_stats_addr = 0;
  for (u_int64_t addr = esp; addr < last; addr += 4) {
    u_int32_t value = 0;
    CHECK(memory_region->GetMemoryAtAddress(addr, &value));
    if (value >= esp && value < last) {
      u_int32_t value2 = 0;
      CHECK(memory_region->GetMemoryAtAddress(value, &value2));
      if (value2 == v8::internal::HeapStats::kStartMarker) {
        heap_stats_addr = addr;
        break;
      }
    }
  }
  CHECK(heap_stats_addr);

  // Read heap stats.

#define READ_FIELD(offset) \
  ReadPointedValue(memory_region, heap_stats_addr, offset)

  CHECK(READ_FIELD(0) == v8::internal::HeapStats::kStartMarker);
  CHECK(READ_FIELD(24) == v8::internal::HeapStats::kEndMarker);

  const int new_space_size = READ_FIELD(1);
  const int new_space_capacity = READ_FIELD(2);
  const int old_space_size = READ_FIELD(3);
  const int old_space_capacity = READ_FIELD(4);
  const int code_space_size = READ_FIELD(5);
  const int code_space_capacity = READ_FIELD(6);
  const int map_space_size = READ_FIELD(7);
  const int map_space_capacity = READ_FIELD(8);
  const int cell_space_size = READ_FIELD(9);
  const int cell_space_capacity = READ_FIELD(10);
  const int lo_space_size = READ_FIELD(11);
  const int global_handle_count = READ_FIELD(12);
  const int weak_global_handle_count = READ_FIELD(13);
  const int pending_global_handle_count = READ_FIELD(14);
  const int near_death_global_handle_count = READ_FIELD(15);
  const int destroyed_global_handle_count = READ_FIELD(16);
  const int memory_allocator_size = READ_FIELD(17);
  const int memory_allocator_capacity = READ_FIELD(18);
  const int os_error = READ_FIELD(19);
#undef READ_FIELD

  int objects_per_type[v8::internal::LAST_TYPE + 1] = {0};
  ReadArrayFrom(memory_region, heap_stats_addr, 21,
                v8::internal::LAST_TYPE + 1, objects_per_type);

  int size_per_type[v8::internal::LAST_TYPE + 1] = {0};
  ReadArrayFrom(memory_region, heap_stats_addr, 22, v8::internal::LAST_TYPE + 1,
                size_per_type);

  int js_global_objects =
      objects_per_type[v8::internal::JS_GLOBAL_OBJECT_TYPE];
  int js_builtins_objects =
      objects_per_type[v8::internal::JS_BUILTINS_OBJECT_TYPE];
  int js_global_proxies =
      objects_per_type[v8::internal::JS_GLOBAL_PROXY_TYPE];

  int indices[v8::internal::LAST_TYPE + 1];
  for (int i = 0; i <= v8::internal::LAST_TYPE; i++) {
    indices[i] = i;
  }

  std::stable_sort(indices, indices + sizeof(indices)/sizeof(indices[0]),
                  IndirectSorter(size_per_type));

  int total_size = 0;
  for (int i = 0; i <= v8::internal::LAST_TYPE; i++) {
    total_size += size_per_type[i];
  }

  // Print heap stats.

  printf("exception thread ID: %" PRIu32 " (%#" PRIx32 ")\n",
         exception_thread_id, exception_thread_id);
  printf("heap stats address: %#" PRIx64 "\n", heap_stats_addr);
#define PRINT_INT_STAT(stat) \
    printf("\t%-25s\t% 10d\n", #stat ":", stat);
#define PRINT_MB_STAT(stat) \
    printf("\t%-25s\t% 10.3f MB\n", #stat ":", toM(stat));
  PRINT_MB_STAT(new_space_size);
  PRINT_MB_STAT(new_space_capacity);
  PRINT_MB_STAT(old_space_size);
  PRINT_MB_STAT(old_space_capacity);
  PRINT_MB_STAT(code_space_size);
  PRINT_MB_STAT(code_space_capacity);
  PRINT_MB_STAT(map_space_size);
  PRINT_MB_STAT(map_space_capacity);
  PRINT_MB_STAT(cell_space_size);
  PRINT_MB_STAT(cell_space_capacity);
  PRINT_MB_STAT(lo_space_size);
  PRINT_INT_STAT(global_handle_count);
  PRINT_INT_STAT(weak_global_handle_count);
  PRINT_INT_STAT(pending_global_handle_count);
  PRINT_INT_STAT(near_death_global_handle_count);
  PRINT_INT_STAT(destroyed_global_handle_count);
  PRINT_MB_STAT(memory_allocator_size);
  PRINT_MB_STAT(memory_allocator_capacity);
  PRINT_INT_STAT(os_error);
#undef PRINT_STAT

  printf("\n");

  printf(
      "\tJS_GLOBAL_OBJECT_TYPE/JS_BUILTINS_OBJECT_TYPE/JS_GLOBAL_PROXY_TYPE: "
      "%d/%d/%d\n\n",
      js_global_objects, js_builtins_objects, js_global_proxies);

  int running_size = 0;
  for (int i = 0; i <= v8::internal::LAST_TYPE; i++) {
    int type = indices[i];
    const char* name = InstanceTypeToString(type);
    if (name == NULL) {
      // Unknown instance type.  Check that there is no objects of that type.
      CHECK_EQ(0, objects_per_type[type]);
      CHECK_EQ(0, size_per_type[type]);
      continue;
    }
    int size = size_per_type[type];
    running_size += size;
    printf("\t%-37s% 9d% 11.3f MB% 10.3f%%% 10.3f%%\n",
           name, objects_per_type[type], toM(size),
           100. * size / total_size, 100. * running_size / total_size);
  }
  printf("\t%-37s% 9d% 11.3f MB% 10.3f%%% 10.3f%%\n",
         "total", 0, toM(total_size), 100., 100.);
}

}  // namespace

int main(int argc, char **argv) {
  if (argc != 2) {
    fprintf(stderr, "usage: %s \n", argv[0]);
    return 1;
  }

  DumpHeapStats(argv[1]);

  return 0;
}
node-v4.8.2/deps/v8/tools/oom_dump/README000644 000766 000024 00000002376 13070706735 020117 0ustar00iojsstaff000000 000000 oom_dump extracts useful information from Google Chrome OOM minidumps.

To build one needs a google-breakpad checkout
(http://code.google.com/p/google-breakpad/).

First, one needs to build and install breakpad itself. For instructions
check google-breakpad, but currently it's as easy as:

  ./configure
  make
  sudo make install

(the catch: breakpad installs .so into /usr/local/lib, so you might
need some additional tweaking to make it discoverable, for example,
put a soft link into /usr/lib directory).

Next step is to build v8.  Note: you should build x64 version of v8,
if you're on 64-bit platform, otherwise you would get a link error when
building oom_dump.  Also, if you are testing against an older version of chrome
you should build the corresponding version of V8 to make sure that the type-id 
enum have the correct values.

The last step is to build oom_dump itself.  The following command should work:

  cd /tools/oom_dump
  scons BREAKPAD_DIR=

(Additionally you can control v8 working copy dir, but the default should work.)

If everything goes fine, oom_dump  should print
some useful information about the OOM crash.

Note: currently only 32-bit Windows minidumps are supported.
node-v4.8.2/deps/v8/tools/oom_dump/SConstruct000644 000766 000024 00000004227 13070706735 021266 0ustar00iojsstaff000000 000000 # Copyright 2010 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

vars = Variables('custom.py')
vars.Add(PathVariable('BREAKPAD_DIR',
                      'Path to checkout of google-breakpad project',
                      '~/google-breakpad',
                      PathVariable.PathIsDir))
vars.Add(PathVariable('V8_DIR',
                      'Path to checkout of v8 project',
                      '../..',
                      PathVariable.PathIsDir))

env = Environment(variables = vars,
                  CPPPATH = ['${BREAKPAD_DIR}/src', '${V8_DIR}/src'],
                  LIBPATH = ['/usr/local/lib', '${V8_DIR}'])

env.Program('oom_dump.cc', LIBS = ['breakpad', 'v8', 'pthread'])
node-v4.8.2/deps/v8/tools/ninja/ninja_output.py000644 000766 000024 00000002557 13070706735 021611 0ustar00iojsstaff000000 000000 # Copyright 2015 the V8 project authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.


import os
import os.path


def GetNinjaOutputDirectory(v8_root, configuration=None):
  """Returns //(Release|Debug).

  The configuration chosen is the one most recently generated/built, but can be
  overriden via the  parameter. Detects a custom output_dir
  specified by GYP_GENERATOR_FLAGS."""

  output_dir = 'out'
  generator_flags = os.getenv('GYP_GENERATOR_FLAGS', '').split(' ')
  for flag in generator_flags:
    name_value = flag.split('=', 1)
    if len(name_value) == 2 and name_value[0] == 'output_dir':
      output_dir = name_value[1]

  root = os.path.join(v8_root, output_dir)
  if configuration:
    return os.path.join(root, configuration)

  debug_path = os.path.join(root, 'Debug')
  release_path = os.path.join(root, 'Release')

  def is_release_newer(test_path):
    try:
      debug_mtime = os.path.getmtime(os.path.join(debug_path, test_path))
    except os.error:
      debug_mtime = 0
    try:
      rel_mtime = os.path.getmtime(os.path.join(release_path, test_path))
    except os.error:
      rel_mtime = 0
    return rel_mtime >= debug_mtime

  if is_release_newer('.ninja_log') or is_release_newer('.ninja_deps'):
    return release_path
  return debug_path
node-v4.8.2/deps/v8/tools/gyp/v8.gyp000644 000766 000024 00000220701 13070706735 017267 0ustar00iojsstaff000000 000000 # Copyright 2012 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

{
  'variables': {
    'icu_use_data_file_flag%': 0,
    'v8_code': 1,
    'v8_random_seed%': 314159265,
    'embed_script%': "",
    'v8_extra_library_files%': [],
    'mksnapshot_exec': '<(PRODUCT_DIR)/<(EXECUTABLE_PREFIX)mksnapshot<(EXECUTABLE_SUFFIX)',
  },
  'includes': ['../../build/toolchain.gypi', '../../build/features.gypi'],
  'targets': [
    {
      'target_name': 'v8',
      'dependencies_traverse': 1,
      'dependencies': ['v8_maybe_snapshot'],
      'conditions': [
        ['want_separate_host_toolset==1', {
          'toolsets': ['host', 'target'],
        }, {
          'toolsets': ['target'],
        }],
        ['component=="shared_library"', {
          'type': '<(component)',
          'sources': [
            # Note: on non-Windows we still build this file so that gyp
            # has some sources to link into the component.
            '../../src/v8dll-main.cc',
          ],
          'include_dirs': [
            '../..',
          ],
          'defines': [
            'V8_SHARED',
            'BUILDING_V8_SHARED',
          ],
          'direct_dependent_settings': {
            'defines': [
              'V8_SHARED',
              'USING_V8_SHARED',
            ],
          },
          'target_conditions': [
            ['OS=="android" and _toolset=="target"', {
              'libraries': [
                '-llog',
              ],
              'include_dirs': [
                'src/common/android/include',
              ],
            }],
          ],
          'conditions': [
            ['OS=="mac"', {
              'xcode_settings': {
                'OTHER_LDFLAGS': ['-dynamiclib', '-all_load']
              },
            }],
            ['soname_version!=""', {
              'product_extension': 'so.<(soname_version)',
            }],
          ],
        },
        {
          'type': 'none',
        }],
      ],
      'direct_dependent_settings': {
        'include_dirs': [
          '../../include',
        ],
      },
    },
    {
      # This rule delegates to either v8_snapshot, v8_nosnapshot, or
      # v8_external_snapshot, depending on the current variables.
      # The intention is to make the 'calling' rules a bit simpler.
      'target_name': 'v8_maybe_snapshot',
      'type': 'none',
      'conditions': [
        ['v8_use_snapshot!="true"', {
          # The dependency on v8_base should come from a transitive
          # dependency however the Android toolchain requires libv8_base.a
          # to appear before libv8_snapshot.a so it's listed explicitly.
          'dependencies': ['v8_base', 'v8_nosnapshot'],
        }],
        ['v8_use_snapshot=="true" and v8_use_external_startup_data==0', {
          # The dependency on v8_base should come from a transitive
          # dependency however the Android toolchain requires libv8_base.a
          # to appear before libv8_snapshot.a so it's listed explicitly.
          'dependencies': ['v8_base', 'v8_snapshot'],
        }],
        ['v8_use_snapshot=="true" and v8_use_external_startup_data==1 and want_separate_host_toolset==0', {
          'dependencies': ['v8_base', 'v8_external_snapshot'],
          'inputs': [ '<(PRODUCT_DIR)/snapshot_blob.bin', ],
        }],
        ['v8_use_snapshot=="true" and v8_use_external_startup_data==1 and want_separate_host_toolset==1', {
          'dependencies': ['v8_base', 'v8_external_snapshot'],
          'target_conditions': [
            ['_toolset=="host"', {
              'inputs': [
                '<(PRODUCT_DIR)/snapshot_blob_host.bin',
              ],
            }, {
              'inputs': [
                '<(PRODUCT_DIR)/snapshot_blob.bin',
              ],
            }],
          ],
        }],
        ['want_separate_host_toolset==1', {
          'toolsets': ['host', 'target'],
        }, {
          'toolsets': ['target'],
        }],
      ]
    },
    {
      'target_name': 'v8_snapshot',
      'type': 'static_library',
      'conditions': [
        ['want_separate_host_toolset==1', {
          'toolsets': ['host', 'target'],
          'dependencies': [
            'mksnapshot#host',
            'js2c#host',
          ],
        }, {
          'toolsets': ['target'],
          'dependencies': [
            'mksnapshot',
            'js2c',
          ],
        }],
        ['component=="shared_library"', {
          'defines': [
            'V8_SHARED',
            'BUILDING_V8_SHARED',
          ],
          'direct_dependent_settings': {
            'defines': [
              'V8_SHARED',
              'USING_V8_SHARED',
            ],
          },
        }],
      ],
      'dependencies': [
        'v8_base',
      ],
      'include_dirs+': [
        '../..',
      ],
      'sources': [
        '<(SHARED_INTERMEDIATE_DIR)/libraries.cc',
        '<(SHARED_INTERMEDIATE_DIR)/experimental-libraries.cc',
        '<(SHARED_INTERMEDIATE_DIR)/extras-libraries.cc',
        '<(INTERMEDIATE_DIR)/snapshot.cc',
      ],
      'actions': [
        {
          'action_name': 'run_mksnapshot',
          'inputs': [
            '<(mksnapshot_exec)',
            '<(embed_script)',
          ],
          'outputs': [
            '<(INTERMEDIATE_DIR)/snapshot.cc',
          ],
          'variables': {
            'mksnapshot_flags': [
              '--log-snapshot-positions',
              '--logfile', '<(INTERMEDIATE_DIR)/snapshot.log',
            ],
            'conditions': [
              ['v8_random_seed!=0', {
                'mksnapshot_flags': ['--random-seed', '<(v8_random_seed)'],
              }],
            ],
          },
          'action': [
            '<(mksnapshot_exec)',
            '<@(mksnapshot_flags)',
            '<@(INTERMEDIATE_DIR)/snapshot.cc',
            '<(embed_script)',
          ],
        },
      ],
    },
    {
      'target_name': 'v8_nosnapshot',
      'type': 'static_library',
      'dependencies': [
        'v8_base',
      ],
      'include_dirs+': [
        '../..',
      ],
      'sources': [
        '<(SHARED_INTERMEDIATE_DIR)/libraries.cc',
        '<(SHARED_INTERMEDIATE_DIR)/experimental-libraries.cc',
        '<(SHARED_INTERMEDIATE_DIR)/extras-libraries.cc',
        '../../src/snapshot/snapshot-empty.cc',
      ],
      'conditions': [
        ['want_separate_host_toolset==1', {
          'toolsets': ['host', 'target'],
          'dependencies': ['js2c#host'],
        }, {
          'toolsets': ['target'],
          'dependencies': ['js2c'],
        }],
        ['component=="shared_library"', {
          'defines': [
            'BUILDING_V8_SHARED',
            'V8_SHARED',
          ],
        }],
      ]
    },
    {
      'target_name': 'v8_external_snapshot',
      'type': 'static_library',
      'conditions': [
        [ 'v8_use_external_startup_data==1', {
          'conditions': [
            ['want_separate_host_toolset==1', {
              'toolsets': ['host', 'target'],
              'dependencies': [
                'mksnapshot#host',
                'js2c#host',
                'natives_blob',
            ]}, {
              'toolsets': ['target'],
              'dependencies': [
                'mksnapshot',
                'js2c',
                'natives_blob',
              ],
            }],
            ['component=="shared_library"', {
              'defines': [
                'V8_SHARED',
                'BUILDING_V8_SHARED',
              ],
              'direct_dependent_settings': {
                'defines': [
                  'V8_SHARED',
                  'USING_V8_SHARED',
                ],
              },
            }],
          ],
          'dependencies': [
            'v8_base',
          ],
          'include_dirs+': [
            '../..',
          ],
          'sources': [
            '../../src/snapshot/natives-external.cc',
            '../../src/snapshot/snapshot-external.cc',
          ],
          'actions': [
            {
              'action_name': 'run_mksnapshot (external)',
              'inputs': [
                '<(mksnapshot_exec)',
              ],
              'variables': {
                'mksnapshot_flags': [
                  '--log-snapshot-positions',
                  '--logfile', '<(INTERMEDIATE_DIR)/snapshot.log',
                ],
                'conditions': [
                  ['v8_random_seed!=0', {
                    'mksnapshot_flags': ['--random-seed', '<(v8_random_seed)'],
                  }],
                ],
              },
              'conditions': [
                ['want_separate_host_toolset==1', {
                  'target_conditions': [
                    ['_toolset=="host"', {
                      'outputs': [
                        '<(INTERMEDIATE_DIR)/snapshot.cc',
                        '<(PRODUCT_DIR)/snapshot_blob_host.bin',
                      ],
                      'action': [
                        '<(mksnapshot_exec)',
                        '<@(mksnapshot_flags)',
                        '<@(INTERMEDIATE_DIR)/snapshot.cc',
                        '--startup_blob', '<(PRODUCT_DIR)/snapshot_blob_host.bin',
                        '<(embed_script)',
                      ],
                    }, {
                      'outputs': [
                        '<(INTERMEDIATE_DIR)/snapshot.cc',
                        '<(PRODUCT_DIR)/snapshot_blob.bin',
                      ],
                      'action': [
                        '<(mksnapshot_exec)',
                        '<@(mksnapshot_flags)',
                        '<@(INTERMEDIATE_DIR)/snapshot.cc',
                        '--startup_blob', '<(PRODUCT_DIR)/snapshot_blob.bin',
                        '<(embed_script)',
                      ],
                    }],
                  ],
                }, {
                  'outputs': [
                    '<(INTERMEDIATE_DIR)/snapshot.cc',
                    '<(PRODUCT_DIR)/snapshot_blob.bin',
                  ],
                  'action': [
                    '<(mksnapshot_exec)',
                    '<@(mksnapshot_flags)',
                    '<@(INTERMEDIATE_DIR)/snapshot.cc',
                    '--startup_blob', '<(PRODUCT_DIR)/snapshot_blob.bin',
                    '<(embed_script)',
                  ],
                }],
              ],
            },
          ],
        }],
      ],
    },
    {
      'target_name': 'v8_base',
      'type': 'static_library',
      'dependencies': [
        'v8_libbase',
      ],
      'variables': {
        'optimize': 'max',
      },
      'include_dirs+': [
        '../..',
      ],
      'defines': [
        # TODO(jochen): Remove again after this is globally turned on.
        'V8_IMMINENT_DEPRECATION_WARNINGS',
      ],
      'sources': [  ### gcmole(all) ###
        '../../include/v8-debug.h',
        '../../include/v8-platform.h',
        '../../include/v8-profiler.h',
        '../../include/v8-testing.h',
        '../../include/v8-util.h',
        '../../include/v8-version.h',
        '../../include/v8.h',
        '../../include/v8config.h',
        '../../src/accessors.cc',
        '../../src/accessors.h',
        '../../src/allocation.cc',
        '../../src/allocation.h',
        '../../src/allocation-site-scopes.cc',
        '../../src/allocation-site-scopes.h',
        '../../src/allocation-tracker.cc',
        '../../src/allocation-tracker.h',
        '../../src/api.cc',
        '../../src/api.h',
        '../../src/api-natives.cc',
        '../../src/api-natives.h',
        '../../src/arguments.cc',
        '../../src/arguments.h',
        '../../src/assembler.cc',
        '../../src/assembler.h',
        '../../src/assert-scope.h',
        '../../src/assert-scope.cc',
        '../../src/ast-value-factory.cc',
        '../../src/ast-value-factory.h',
        '../../src/ast-literal-reindexer.cc',
        '../../src/ast-literal-reindexer.h',
        '../../src/ast-numbering.cc',
        '../../src/ast-numbering.h',
        '../../src/ast.cc',
        '../../src/ast.h',
        '../../src/background-parsing-task.cc',
        '../../src/background-parsing-task.h',
        '../../src/bailout-reason.cc',
        '../../src/bailout-reason.h',
        '../../src/basic-block-profiler.cc',
        '../../src/basic-block-profiler.h',
        '../../src/bignum-dtoa.cc',
        '../../src/bignum-dtoa.h',
        '../../src/bignum.cc',
        '../../src/bignum.h',
        '../../src/bit-vector.cc',
        '../../src/bit-vector.h',
        '../../src/bootstrapper.cc',
        '../../src/bootstrapper.h',
        '../../src/builtins.cc',
        '../../src/builtins.h',
        '../../src/bytecodes-irregexp.h',
        '../../src/cached-powers.cc',
        '../../src/cached-powers.h',
        '../../src/char-predicates.cc',
        '../../src/char-predicates-inl.h',
        '../../src/char-predicates.h',
        '../../src/checks.cc',
        '../../src/checks.h',
        '../../src/circular-queue-inl.h',
        '../../src/circular-queue.h',
        '../../src/code-factory.cc',
        '../../src/code-factory.h',
        '../../src/code-stubs.cc',
        '../../src/code-stubs.h',
        '../../src/code-stubs-hydrogen.cc',
        '../../src/code.h',
        '../../src/codegen.cc',
        '../../src/codegen.h',
        '../../src/compilation-cache.cc',
        '../../src/compilation-cache.h',
        '../../src/compilation-dependencies.cc',
        '../../src/compilation-dependencies.h',
        '../../src/compilation-statistics.cc',
        '../../src/compilation-statistics.h',
        '../../src/compiler/access-builder.cc',
        '../../src/compiler/access-builder.h',
        '../../src/compiler/all-nodes.cc',
        '../../src/compiler/all-nodes.h',
        '../../src/compiler/ast-graph-builder.cc',
        '../../src/compiler/ast-graph-builder.h',
        '../../src/compiler/ast-loop-assignment-analyzer.cc',
        '../../src/compiler/ast-loop-assignment-analyzer.h',
        '../../src/compiler/basic-block-instrumentor.cc',
        '../../src/compiler/basic-block-instrumentor.h',
        '../../src/compiler/change-lowering.cc',
        '../../src/compiler/change-lowering.h',
        '../../src/compiler/coalesced-live-ranges.cc',
        '../../src/compiler/coalesced-live-ranges.h',
        '../../src/compiler/code-generator-impl.h',
        '../../src/compiler/code-generator.cc',
        '../../src/compiler/code-generator.h',
        '../../src/compiler/common-node-cache.cc',
        '../../src/compiler/common-node-cache.h',
        '../../src/compiler/common-operator-reducer.cc',
        '../../src/compiler/common-operator-reducer.h',
        '../../src/compiler/common-operator.cc',
        '../../src/compiler/common-operator.h',
        '../../src/compiler/control-builders.cc',
        '../../src/compiler/control-builders.h',
        '../../src/compiler/control-equivalence.cc',
        '../../src/compiler/control-equivalence.h',
        '../../src/compiler/control-flow-optimizer.cc',
        '../../src/compiler/control-flow-optimizer.h',
        '../../src/compiler/dead-code-elimination.cc',
        '../../src/compiler/dead-code-elimination.h',
        '../../src/compiler/diamond.h',
        '../../src/compiler/frame.h',
        '../../src/compiler/frame-elider.cc',
        '../../src/compiler/frame-elider.h',
        "../../src/compiler/frame-states.cc",
        "../../src/compiler/frame-states.h",
        '../../src/compiler/gap-resolver.cc',
        '../../src/compiler/gap-resolver.h',
        '../../src/compiler/graph-builder.h',
        '../../src/compiler/graph-reducer.cc',
        '../../src/compiler/graph-reducer.h',
        '../../src/compiler/graph-replay.cc',
        '../../src/compiler/graph-replay.h',
        '../../src/compiler/graph-trimmer.cc',
        '../../src/compiler/graph-trimmer.h',
        '../../src/compiler/graph-visualizer.cc',
        '../../src/compiler/graph-visualizer.h',
        '../../src/compiler/graph.cc',
        '../../src/compiler/graph.h',
        '../../src/compiler/greedy-allocator.cc',
        '../../src/compiler/greedy-allocator.h',
        '../../src/compiler/instruction-codes.h',
        '../../src/compiler/instruction-selector-impl.h',
        '../../src/compiler/instruction-selector.cc',
        '../../src/compiler/instruction-selector.h',
        '../../src/compiler/instruction.cc',
        '../../src/compiler/instruction.h',
        '../../src/compiler/js-builtin-reducer.cc',
        '../../src/compiler/js-builtin-reducer.h',
        '../../src/compiler/js-context-specialization.cc',
        '../../src/compiler/js-context-specialization.h',
        '../../src/compiler/js-frame-specialization.cc',
        '../../src/compiler/js-frame-specialization.h',
        '../../src/compiler/js-generic-lowering.cc',
        '../../src/compiler/js-generic-lowering.h',
        '../../src/compiler/js-graph.cc',
        '../../src/compiler/js-graph.h',
        '../../src/compiler/js-inlining.cc',
        '../../src/compiler/js-inlining.h',
        '../../src/compiler/js-intrinsic-lowering.cc',
        '../../src/compiler/js-intrinsic-lowering.h',
        '../../src/compiler/js-operator.cc',
        '../../src/compiler/js-operator.h',
        '../../src/compiler/js-type-feedback.cc',
        '../../src/compiler/js-type-feedback.h',
        '../../src/compiler/js-typed-lowering.cc',
        '../../src/compiler/js-typed-lowering.h',
        '../../src/compiler/jump-threading.cc',
        '../../src/compiler/jump-threading.h',
        '../../src/compiler/linkage-impl.h',
        '../../src/compiler/linkage.cc',
        '../../src/compiler/linkage.h',
        '../../src/compiler/liveness-analyzer.cc',
        '../../src/compiler/liveness-analyzer.h',
        '../../src/compiler/load-elimination.cc',
        '../../src/compiler/load-elimination.h',
        '../../src/compiler/loop-analysis.cc',
        '../../src/compiler/loop-analysis.h',
        '../../src/compiler/loop-peeling.cc',
        '../../src/compiler/loop-peeling.h',
        '../../src/compiler/machine-operator-reducer.cc',
        '../../src/compiler/machine-operator-reducer.h',
        '../../src/compiler/machine-operator.cc',
        '../../src/compiler/machine-operator.h',
        '../../src/compiler/machine-type.cc',
        '../../src/compiler/machine-type.h',
        '../../src/compiler/move-optimizer.cc',
        '../../src/compiler/move-optimizer.h',
        '../../src/compiler/node-aux-data.h',
        '../../src/compiler/node-cache.cc',
        '../../src/compiler/node-cache.h',
        '../../src/compiler/node-marker.cc',
        '../../src/compiler/node-marker.h',
        '../../src/compiler/node-matchers.cc',
        '../../src/compiler/node-matchers.h',
        '../../src/compiler/node-properties.cc',
        '../../src/compiler/node-properties.h',
        '../../src/compiler/node.cc',
        '../../src/compiler/node.h',
        '../../src/compiler/opcodes.cc',
        '../../src/compiler/opcodes.h',
        '../../src/compiler/operator-properties.cc',
        '../../src/compiler/operator-properties.h',
        '../../src/compiler/operator.cc',
        '../../src/compiler/operator.h',
        '../../src/compiler/osr.cc',
        '../../src/compiler/osr.h',
        '../../src/compiler/pipeline.cc',
        '../../src/compiler/pipeline.h',
        '../../src/compiler/pipeline-statistics.cc',
        '../../src/compiler/pipeline-statistics.h',
        '../../src/compiler/raw-machine-assembler.cc',
        '../../src/compiler/raw-machine-assembler.h',
        '../../src/compiler/register-allocator.cc',
        '../../src/compiler/register-allocator.h',
        '../../src/compiler/register-allocator-verifier.cc',
        '../../src/compiler/register-allocator-verifier.h',
        '../../src/compiler/register-configuration.cc',
        '../../src/compiler/register-configuration.h',
        '../../src/compiler/representation-change.h',
        '../../src/compiler/schedule.cc',
        '../../src/compiler/schedule.h',
        '../../src/compiler/scheduler.cc',
        '../../src/compiler/scheduler.h',
        '../../src/compiler/select-lowering.cc',
        '../../src/compiler/select-lowering.h',
        '../../src/compiler/simplified-lowering.cc',
        '../../src/compiler/simplified-lowering.h',
        '../../src/compiler/simplified-operator-reducer.cc',
        '../../src/compiler/simplified-operator-reducer.h',
        '../../src/compiler/simplified-operator.cc',
        '../../src/compiler/simplified-operator.h',
        '../../src/compiler/source-position.cc',
        '../../src/compiler/source-position.h',
        '../../src/compiler/state-values-utils.cc',
        '../../src/compiler/state-values-utils.h',
        '../../src/compiler/tail-call-optimization.cc',
        '../../src/compiler/tail-call-optimization.h',
        '../../src/compiler/typer.cc',
        '../../src/compiler/typer.h',
        '../../src/compiler/value-numbering-reducer.cc',
        '../../src/compiler/value-numbering-reducer.h',
        '../../src/compiler/verifier.cc',
        '../../src/compiler/verifier.h',
        '../../src/compiler/zone-pool.cc',
        '../../src/compiler/zone-pool.h',
        '../../src/compiler.cc',
        '../../src/compiler.h',
        '../../src/contexts.cc',
        '../../src/contexts.h',
        '../../src/conversions-inl.h',
        '../../src/conversions.cc',
        '../../src/conversions.h',
        '../../src/counters.cc',
        '../../src/counters.h',
        '../../src/cpu-profiler-inl.h',
        '../../src/cpu-profiler.cc',
        '../../src/cpu-profiler.h',
        '../../src/date.cc',
        '../../src/date.h',
        '../../src/dateparser-inl.h',
        '../../src/dateparser.cc',
        '../../src/dateparser.h',
        '../../src/debug.cc',
        '../../src/debug.h',
        '../../src/deoptimizer.cc',
        '../../src/deoptimizer.h',
        '../../src/disasm.h',
        '../../src/disassembler.cc',
        '../../src/disassembler.h',
        '../../src/diy-fp.cc',
        '../../src/diy-fp.h',
        '../../src/double.h',
        '../../src/dtoa.cc',
        '../../src/dtoa.h',
        '../../src/effects.h',
        '../../src/elements-kind.cc',
        '../../src/elements-kind.h',
        '../../src/elements.cc',
        '../../src/elements.h',
        '../../src/execution.cc',
        '../../src/execution.h',
        '../../src/expression-classifier.h',
        '../../src/extensions/externalize-string-extension.cc',
        '../../src/extensions/externalize-string-extension.h',
        '../../src/extensions/free-buffer-extension.cc',
        '../../src/extensions/free-buffer-extension.h',
        '../../src/extensions/gc-extension.cc',
        '../../src/extensions/gc-extension.h',
        '../../src/extensions/statistics-extension.cc',
        '../../src/extensions/statistics-extension.h',
        '../../src/extensions/trigger-failure-extension.cc',
        '../../src/extensions/trigger-failure-extension.h',
        '../../src/factory.cc',
        '../../src/factory.h',
        '../../src/fast-dtoa.cc',
        '../../src/fast-dtoa.h',
        '../../src/field-index.h',
        '../../src/field-index-inl.h',
        '../../src/fixed-dtoa.cc',
        '../../src/fixed-dtoa.h',
        '../../src/flag-definitions.h',
        '../../src/flags.cc',
        '../../src/flags.h',
        '../../src/frames-inl.h',
        '../../src/frames.cc',
        '../../src/frames.h',
        '../../src/full-codegen.cc',
        '../../src/full-codegen.h',
        '../../src/func-name-inferrer.cc',
        '../../src/func-name-inferrer.h',
        '../../src/gdb-jit.cc',
        '../../src/gdb-jit.h',
        '../../src/global-handles.cc',
        '../../src/global-handles.h',
        '../../src/globals.h',
        '../../src/handles-inl.h',
        '../../src/handles.cc',
        '../../src/handles.h',
        '../../src/hashmap.h',
        '../../src/heap-profiler.cc',
        '../../src/heap-profiler.h',
        '../../src/heap-snapshot-generator-inl.h',
        '../../src/heap-snapshot-generator.cc',
        '../../src/heap-snapshot-generator.h',
        '../../src/heap/memory-reducer.cc',
        '../../src/heap/memory-reducer.h',
        '../../src/heap/gc-idle-time-handler.cc',
        '../../src/heap/gc-idle-time-handler.h',
        '../../src/heap/gc-tracer.cc',
        '../../src/heap/gc-tracer.h',
        '../../src/heap/heap-inl.h',
        '../../src/heap/heap.cc',
        '../../src/heap/heap.h',
        '../../src/heap/identity-map.cc',
        '../../src/heap/identity-map.h',
        '../../src/heap/incremental-marking-inl.h',
        '../../src/heap/incremental-marking.cc',
        '../../src/heap/incremental-marking.h',
        '../../src/heap/mark-compact-inl.h',
        '../../src/heap/mark-compact.cc',
        '../../src/heap/mark-compact.h',
        '../../src/heap/objects-visiting-inl.h',
        '../../src/heap/objects-visiting.cc',
        '../../src/heap/objects-visiting.h',
        '../../src/heap/spaces-inl.h',
        '../../src/heap/spaces.cc',
        '../../src/heap/spaces.h',
        '../../src/heap/store-buffer-inl.h',
        '../../src/heap/store-buffer.cc',
        '../../src/heap/store-buffer.h',
        '../../src/hydrogen-alias-analysis.h',
        '../../src/hydrogen-bce.cc',
        '../../src/hydrogen-bce.h',
        '../../src/hydrogen-bch.cc',
        '../../src/hydrogen-bch.h',
        '../../src/hydrogen-canonicalize.cc',
        '../../src/hydrogen-canonicalize.h',
        '../../src/hydrogen-check-elimination.cc',
        '../../src/hydrogen-check-elimination.h',
        '../../src/hydrogen-dce.cc',
        '../../src/hydrogen-dce.h',
        '../../src/hydrogen-dehoist.cc',
        '../../src/hydrogen-dehoist.h',
        '../../src/hydrogen-environment-liveness.cc',
        '../../src/hydrogen-environment-liveness.h',
        '../../src/hydrogen-escape-analysis.cc',
        '../../src/hydrogen-escape-analysis.h',
        '../../src/hydrogen-flow-engine.h',
        '../../src/hydrogen-instructions.cc',
        '../../src/hydrogen-instructions.h',
        '../../src/hydrogen.cc',
        '../../src/hydrogen.h',
        '../../src/hydrogen-gvn.cc',
        '../../src/hydrogen-gvn.h',
        '../../src/hydrogen-infer-representation.cc',
        '../../src/hydrogen-infer-representation.h',
        '../../src/hydrogen-infer-types.cc',
        '../../src/hydrogen-infer-types.h',
        '../../src/hydrogen-load-elimination.cc',
        '../../src/hydrogen-load-elimination.h',
        '../../src/hydrogen-mark-deoptimize.cc',
        '../../src/hydrogen-mark-deoptimize.h',
        '../../src/hydrogen-mark-unreachable.cc',
        '../../src/hydrogen-mark-unreachable.h',
        '../../src/hydrogen-osr.cc',
        '../../src/hydrogen-osr.h',
        '../../src/hydrogen-range-analysis.cc',
        '../../src/hydrogen-range-analysis.h',
        '../../src/hydrogen-redundant-phi.cc',
        '../../src/hydrogen-redundant-phi.h',
        '../../src/hydrogen-removable-simulates.cc',
        '../../src/hydrogen-removable-simulates.h',
        '../../src/hydrogen-representation-changes.cc',
        '../../src/hydrogen-representation-changes.h',
        '../../src/hydrogen-sce.cc',
        '../../src/hydrogen-sce.h',
        '../../src/hydrogen-store-elimination.cc',
        '../../src/hydrogen-store-elimination.h',
        '../../src/hydrogen-types.cc',
        '../../src/hydrogen-types.h',
        '../../src/hydrogen-uint32-analysis.cc',
        '../../src/hydrogen-uint32-analysis.h',
        '../../src/i18n.cc',
        '../../src/i18n.h',
        '../../src/icu_util.cc',
        '../../src/icu_util.h',
        '../../src/ic/access-compiler.cc',
        '../../src/ic/access-compiler.h',
        '../../src/ic/call-optimization.cc',
        '../../src/ic/call-optimization.h',
        '../../src/ic/handler-compiler.cc',
        '../../src/ic/handler-compiler.h',
        '../../src/ic/ic-inl.h',
        '../../src/ic/ic-state.cc',
        '../../src/ic/ic-state.h',
        '../../src/ic/ic.cc',
        '../../src/ic/ic.h',
        '../../src/ic/ic-compiler.cc',
        '../../src/ic/ic-compiler.h',
        '../../src/interface-descriptors.cc',
        '../../src/interface-descriptors.h',
        '../../src/interpreter-irregexp.cc',
        '../../src/interpreter-irregexp.h',
        '../../src/isolate.cc',
        '../../src/isolate.h',
        '../../src/json-parser.h',
        '../../src/json-stringifier.h',
        '../../src/jsregexp-inl.h',
        '../../src/jsregexp.cc',
        '../../src/jsregexp.h',
        '../../src/layout-descriptor-inl.h',
        '../../src/layout-descriptor.cc',
        '../../src/layout-descriptor.h',
        '../../src/list-inl.h',
        '../../src/list.h',
        '../../src/lithium-allocator-inl.h',
        '../../src/lithium-allocator.cc',
        '../../src/lithium-allocator.h',
        '../../src/lithium-codegen.cc',
        '../../src/lithium-codegen.h',
        '../../src/lithium.cc',
        '../../src/lithium.h',
        '../../src/lithium-inl.h',
        '../../src/liveedit.cc',
        '../../src/liveedit.h',
        '../../src/log-inl.h',
        '../../src/log-utils.cc',
        '../../src/log-utils.h',
        '../../src/log.cc',
        '../../src/log.h',
        '../../src/lookup-inl.h',
        '../../src/lookup.cc',
        '../../src/lookup.h',
        '../../src/macro-assembler.h',
        '../../src/messages.cc',
        '../../src/messages.h',
        '../../src/modules.cc',
        '../../src/modules.h',
        '../../src/msan.h',
        '../../src/objects-debug.cc',
        '../../src/objects-inl.h',
        '../../src/objects-printer.cc',
        '../../src/objects.cc',
        '../../src/objects.h',
        '../../src/optimizing-compile-dispatcher.cc',
        '../../src/optimizing-compile-dispatcher.h',
        '../../src/ostreams.cc',
        '../../src/ostreams.h',
        '../../src/pattern-rewriter.cc',
        '../../src/parser.cc',
        '../../src/parser.h',
        '../../src/pending-compilation-error-handler.cc',
        '../../src/pending-compilation-error-handler.h',
        '../../src/preparse-data-format.h',
        '../../src/preparse-data.cc',
        '../../src/preparse-data.h',
        '../../src/preparser.cc',
        '../../src/preparser.h',
        '../../src/prettyprinter.cc',
        '../../src/prettyprinter.h',
        '../../src/profile-generator-inl.h',
        '../../src/profile-generator.cc',
        '../../src/profile-generator.h',
        '../../src/property-details.h',
        '../../src/property.cc',
        '../../src/property.h',
        '../../src/prototype.h',
        '../../src/regexp-macro-assembler-irregexp-inl.h',
        '../../src/regexp-macro-assembler-irregexp.cc',
        '../../src/regexp-macro-assembler-irregexp.h',
        '../../src/regexp-macro-assembler-tracer.cc',
        '../../src/regexp-macro-assembler-tracer.h',
        '../../src/regexp-macro-assembler.cc',
        '../../src/regexp-macro-assembler.h',
        '../../src/regexp-stack.cc',
        '../../src/regexp-stack.h',
        '../../src/rewriter.cc',
        '../../src/rewriter.h',
        '../../src/runtime-profiler.cc',
        '../../src/runtime-profiler.h',
        '../../src/runtime/runtime-array.cc',
        '../../src/runtime/runtime-atomics.cc',
        '../../src/runtime/runtime-classes.cc',
        '../../src/runtime/runtime-collections.cc',
        '../../src/runtime/runtime-compiler.cc',
        '../../src/runtime/runtime-date.cc',
        '../../src/runtime/runtime-debug.cc',
        '../../src/runtime/runtime-forin.cc',
        '../../src/runtime/runtime-function.cc',
        '../../src/runtime/runtime-generator.cc',
        '../../src/runtime/runtime-i18n.cc',
        '../../src/runtime/runtime-internal.cc',
        '../../src/runtime/runtime-json.cc',
        '../../src/runtime/runtime-literals.cc',
        '../../src/runtime/runtime-liveedit.cc',
        '../../src/runtime/runtime-maths.cc',
        '../../src/runtime/runtime-numbers.cc',
        '../../src/runtime/runtime-object.cc',
        '../../src/runtime/runtime-observe.cc',
        '../../src/runtime/runtime-proxy.cc',
        '../../src/runtime/runtime-regexp.cc',
        '../../src/runtime/runtime-scopes.cc',
        '../../src/runtime/runtime-strings.cc',
        '../../src/runtime/runtime-symbol.cc',
        '../../src/runtime/runtime-test.cc',
        '../../src/runtime/runtime-typedarray.cc',
        '../../src/runtime/runtime-uri.cc',
        '../../src/runtime/runtime-utils.h',
        '../../src/runtime/runtime.cc',
        '../../src/runtime/runtime.h',
        '../../src/safepoint-table.cc',
        '../../src/safepoint-table.h',
        '../../src/sampler.cc',
        '../../src/sampler.h',
        '../../src/scanner-character-streams.cc',
        '../../src/scanner-character-streams.h',
        '../../src/scanner.cc',
        '../../src/scanner.h',
        '../../src/scopeinfo.cc',
        '../../src/scopeinfo.h',
        '../../src/scopes.cc',
        '../../src/scopes.h',
        '../../src/signature.h',
        '../../src/simulator.h',
        '../../src/small-pointer-list.h',
        '../../src/smart-pointers.h',
        '../../src/snapshot/natives.h',
        '../../src/snapshot/serialize.cc',
        '../../src/snapshot/serialize.h',
        '../../src/snapshot/snapshot.h',
        '../../src/snapshot/snapshot-common.cc',
        '../../src/snapshot/snapshot-source-sink.cc',
        '../../src/snapshot/snapshot-source-sink.h',
        '../../src/splay-tree.h',
        '../../src/splay-tree-inl.h',
        '../../src/startup-data-util.cc',
        '../../src/startup-data-util.h',
        '../../src/string-builder.cc',
        '../../src/string-builder.h',
        '../../src/string-search.cc',
        '../../src/string-search.h',
        '../../src/string-stream.cc',
        '../../src/string-stream.h',
        '../../src/strings-storage.cc',
        '../../src/strings-storage.h',
        '../../src/strtod.cc',
        '../../src/strtod.h',
        '../../src/ic/stub-cache.cc',
        '../../src/ic/stub-cache.h',
        '../../src/token.cc',
        '../../src/token.h',
        '../../src/transitions-inl.h',
        '../../src/transitions.cc',
        '../../src/transitions.h',
        '../../src/type-feedback-vector-inl.h',
        '../../src/type-feedback-vector.cc',
        '../../src/type-feedback-vector.h',
        '../../src/type-info.cc',
        '../../src/type-info.h',
        '../../src/types-inl.h',
        '../../src/types.cc',
        '../../src/types.h',
        '../../src/typing.cc',
        '../../src/typing.h',
        '../../src/unbound-queue-inl.h',
        '../../src/unbound-queue.h',
        '../../src/unicode-inl.h',
        '../../src/unicode.cc',
        '../../src/unicode.h',
        '../../src/unicode-decoder.cc',
        '../../src/unicode-decoder.h',
        '../../src/unique.h',
        '../../src/utils.cc',
        '../../src/utils.h',
        '../../src/v8.cc',
        '../../src/v8.h',
        '../../src/v8memory.h',
        '../../src/v8threads.cc',
        '../../src/v8threads.h',
        '../../src/variables.cc',
        '../../src/variables.h',
        '../../src/vector.h',
        '../../src/version.cc',
        '../../src/version.h',
        '../../src/vm-state-inl.h',
        '../../src/vm-state.h',
        '../../src/zone.cc',
        '../../src/zone.h',
        '../../src/zone-allocator.h',
        '../../src/zone-containers.h',
        '../../src/third_party/fdlibm/fdlibm.cc',
        '../../src/third_party/fdlibm/fdlibm.h',
      ],
      'conditions': [
        ['want_separate_host_toolset==1', {
          'toolsets': ['host', 'target'],
        }, {
          'toolsets': ['target'],
        }],
        ['v8_target_arch=="arm"', {
          'sources': [  ### gcmole(arch:arm) ###
            '../../src/arm/assembler-arm-inl.h',
            '../../src/arm/assembler-arm.cc',
            '../../src/arm/assembler-arm.h',
            '../../src/arm/builtins-arm.cc',
            '../../src/arm/code-stubs-arm.cc',
            '../../src/arm/code-stubs-arm.h',
            '../../src/arm/codegen-arm.cc',
            '../../src/arm/codegen-arm.h',
            '../../src/arm/constants-arm.h',
            '../../src/arm/constants-arm.cc',
            '../../src/arm/cpu-arm.cc',
            '../../src/arm/debug-arm.cc',
            '../../src/arm/deoptimizer-arm.cc',
            '../../src/arm/disasm-arm.cc',
            '../../src/arm/frames-arm.cc',
            '../../src/arm/frames-arm.h',
            '../../src/arm/full-codegen-arm.cc',
            '../../src/arm/interface-descriptors-arm.cc',
            '../../src/arm/interface-descriptors-arm.h',
            '../../src/arm/lithium-arm.cc',
            '../../src/arm/lithium-arm.h',
            '../../src/arm/lithium-codegen-arm.cc',
            '../../src/arm/lithium-codegen-arm.h',
            '../../src/arm/lithium-gap-resolver-arm.cc',
            '../../src/arm/lithium-gap-resolver-arm.h',
            '../../src/arm/macro-assembler-arm.cc',
            '../../src/arm/macro-assembler-arm.h',
            '../../src/arm/regexp-macro-assembler-arm.cc',
            '../../src/arm/regexp-macro-assembler-arm.h',
            '../../src/arm/simulator-arm.cc',
            '../../src/arm/simulator-arm.h',
            '../../src/compiler/arm/code-generator-arm.cc',
            '../../src/compiler/arm/instruction-codes-arm.h',
            '../../src/compiler/arm/instruction-selector-arm.cc',
            '../../src/compiler/arm/linkage-arm.cc',
            '../../src/ic/arm/access-compiler-arm.cc',
            '../../src/ic/arm/handler-compiler-arm.cc',
            '../../src/ic/arm/ic-arm.cc',
            '../../src/ic/arm/ic-compiler-arm.cc',
            '../../src/ic/arm/stub-cache-arm.cc',
          ],
        }],
        ['v8_target_arch=="arm64"', {
          'sources': [  ### gcmole(arch:arm64) ###
            '../../src/arm64/assembler-arm64.cc',
            '../../src/arm64/assembler-arm64.h',
            '../../src/arm64/assembler-arm64-inl.h',
            '../../src/arm64/builtins-arm64.cc',
            '../../src/arm64/codegen-arm64.cc',
            '../../src/arm64/codegen-arm64.h',
            '../../src/arm64/code-stubs-arm64.cc',
            '../../src/arm64/code-stubs-arm64.h',
            '../../src/arm64/constants-arm64.h',
            '../../src/arm64/cpu-arm64.cc',
            '../../src/arm64/debug-arm64.cc',
            '../../src/arm64/decoder-arm64.cc',
            '../../src/arm64/decoder-arm64.h',
            '../../src/arm64/decoder-arm64-inl.h',
            '../../src/arm64/delayed-masm-arm64.cc',
            '../../src/arm64/delayed-masm-arm64.h',
            '../../src/arm64/delayed-masm-arm64-inl.h',
            '../../src/arm64/deoptimizer-arm64.cc',
            '../../src/arm64/disasm-arm64.cc',
            '../../src/arm64/disasm-arm64.h',
            '../../src/arm64/frames-arm64.cc',
            '../../src/arm64/frames-arm64.h',
            '../../src/arm64/full-codegen-arm64.cc',
            '../../src/arm64/instructions-arm64.cc',
            '../../src/arm64/instructions-arm64.h',
            '../../src/arm64/instrument-arm64.cc',
            '../../src/arm64/instrument-arm64.h',
            '../../src/arm64/interface-descriptors-arm64.cc',
            '../../src/arm64/interface-descriptors-arm64.h',
            '../../src/arm64/lithium-arm64.cc',
            '../../src/arm64/lithium-arm64.h',
            '../../src/arm64/lithium-codegen-arm64.cc',
            '../../src/arm64/lithium-codegen-arm64.h',
            '../../src/arm64/lithium-gap-resolver-arm64.cc',
            '../../src/arm64/lithium-gap-resolver-arm64.h',
            '../../src/arm64/macro-assembler-arm64.cc',
            '../../src/arm64/macro-assembler-arm64.h',
            '../../src/arm64/macro-assembler-arm64-inl.h',
            '../../src/arm64/regexp-macro-assembler-arm64.cc',
            '../../src/arm64/regexp-macro-assembler-arm64.h',
            '../../src/arm64/simulator-arm64.cc',
            '../../src/arm64/simulator-arm64.h',
            '../../src/arm64/utils-arm64.cc',
            '../../src/arm64/utils-arm64.h',
            '../../src/compiler/arm64/code-generator-arm64.cc',
            '../../src/compiler/arm64/instruction-codes-arm64.h',
            '../../src/compiler/arm64/instruction-selector-arm64.cc',
            '../../src/compiler/arm64/linkage-arm64.cc',
            '../../src/ic/arm64/access-compiler-arm64.cc',
            '../../src/ic/arm64/handler-compiler-arm64.cc',
            '../../src/ic/arm64/ic-arm64.cc',
            '../../src/ic/arm64/ic-compiler-arm64.cc',
            '../../src/ic/arm64/stub-cache-arm64.cc',
          ],
        }],
        ['v8_target_arch=="ia32"', {
          'sources': [  ### gcmole(arch:ia32) ###
            '../../src/ia32/assembler-ia32-inl.h',
            '../../src/ia32/assembler-ia32.cc',
            '../../src/ia32/assembler-ia32.h',
            '../../src/ia32/builtins-ia32.cc',
            '../../src/ia32/code-stubs-ia32.cc',
            '../../src/ia32/code-stubs-ia32.h',
            '../../src/ia32/codegen-ia32.cc',
            '../../src/ia32/codegen-ia32.h',
            '../../src/ia32/cpu-ia32.cc',
            '../../src/ia32/debug-ia32.cc',
            '../../src/ia32/deoptimizer-ia32.cc',
            '../../src/ia32/disasm-ia32.cc',
            '../../src/ia32/frames-ia32.cc',
            '../../src/ia32/frames-ia32.h',
            '../../src/ia32/full-codegen-ia32.cc',
            '../../src/ia32/interface-descriptors-ia32.cc',
            '../../src/ia32/lithium-codegen-ia32.cc',
            '../../src/ia32/lithium-codegen-ia32.h',
            '../../src/ia32/lithium-gap-resolver-ia32.cc',
            '../../src/ia32/lithium-gap-resolver-ia32.h',
            '../../src/ia32/lithium-ia32.cc',
            '../../src/ia32/lithium-ia32.h',
            '../../src/ia32/macro-assembler-ia32.cc',
            '../../src/ia32/macro-assembler-ia32.h',
            '../../src/ia32/regexp-macro-assembler-ia32.cc',
            '../../src/ia32/regexp-macro-assembler-ia32.h',
            '../../src/compiler/ia32/code-generator-ia32.cc',
            '../../src/compiler/ia32/instruction-codes-ia32.h',
            '../../src/compiler/ia32/instruction-selector-ia32.cc',
            '../../src/compiler/ia32/linkage-ia32.cc',
            '../../src/ic/ia32/access-compiler-ia32.cc',
            '../../src/ic/ia32/handler-compiler-ia32.cc',
            '../../src/ic/ia32/ic-ia32.cc',
            '../../src/ic/ia32/ic-compiler-ia32.cc',
            '../../src/ic/ia32/stub-cache-ia32.cc',
          ],
        }],
        ['v8_target_arch=="x87"', {
          'sources': [  ### gcmole(arch:x87) ###
            '../../src/x87/assembler-x87-inl.h',
            '../../src/x87/assembler-x87.cc',
            '../../src/x87/assembler-x87.h',
            '../../src/x87/builtins-x87.cc',
            '../../src/x87/code-stubs-x87.cc',
            '../../src/x87/code-stubs-x87.h',
            '../../src/x87/codegen-x87.cc',
            '../../src/x87/codegen-x87.h',
            '../../src/x87/cpu-x87.cc',
            '../../src/x87/debug-x87.cc',
            '../../src/x87/deoptimizer-x87.cc',
            '../../src/x87/disasm-x87.cc',
            '../../src/x87/frames-x87.cc',
            '../../src/x87/frames-x87.h',
            '../../src/x87/full-codegen-x87.cc',
            '../../src/x87/interface-descriptors-x87.cc',
            '../../src/x87/lithium-codegen-x87.cc',
            '../../src/x87/lithium-codegen-x87.h',
            '../../src/x87/lithium-gap-resolver-x87.cc',
            '../../src/x87/lithium-gap-resolver-x87.h',
            '../../src/x87/lithium-x87.cc',
            '../../src/x87/lithium-x87.h',
            '../../src/x87/macro-assembler-x87.cc',
            '../../src/x87/macro-assembler-x87.h',
            '../../src/x87/regexp-macro-assembler-x87.cc',
            '../../src/x87/regexp-macro-assembler-x87.h',
            '../../src/compiler/x87/code-generator-x87.cc',
            '../../src/compiler/x87/instruction-codes-x87.h',
            '../../src/compiler/x87/instruction-selector-x87.cc',
            '../../src/compiler/x87/linkage-x87.cc',
            '../../src/ic/x87/access-compiler-x87.cc',
            '../../src/ic/x87/handler-compiler-x87.cc',
            '../../src/ic/x87/ic-x87.cc',
            '../../src/ic/x87/ic-compiler-x87.cc',
            '../../src/ic/x87/stub-cache-x87.cc',
          ],
        }],
        ['v8_target_arch=="mips" or v8_target_arch=="mipsel"', {
          'sources': [  ### gcmole(arch:mipsel) ###
            '../../src/mips/assembler-mips.cc',
            '../../src/mips/assembler-mips.h',
            '../../src/mips/assembler-mips-inl.h',
            '../../src/mips/builtins-mips.cc',
            '../../src/mips/codegen-mips.cc',
            '../../src/mips/codegen-mips.h',
            '../../src/mips/code-stubs-mips.cc',
            '../../src/mips/code-stubs-mips.h',
            '../../src/mips/constants-mips.cc',
            '../../src/mips/constants-mips.h',
            '../../src/mips/cpu-mips.cc',
            '../../src/mips/debug-mips.cc',
            '../../src/mips/deoptimizer-mips.cc',
            '../../src/mips/disasm-mips.cc',
            '../../src/mips/frames-mips.cc',
            '../../src/mips/frames-mips.h',
            '../../src/mips/full-codegen-mips.cc',
            '../../src/mips/interface-descriptors-mips.cc',
            '../../src/mips/lithium-codegen-mips.cc',
            '../../src/mips/lithium-codegen-mips.h',
            '../../src/mips/lithium-gap-resolver-mips.cc',
            '../../src/mips/lithium-gap-resolver-mips.h',
            '../../src/mips/lithium-mips.cc',
            '../../src/mips/lithium-mips.h',
            '../../src/mips/macro-assembler-mips.cc',
            '../../src/mips/macro-assembler-mips.h',
            '../../src/mips/regexp-macro-assembler-mips.cc',
            '../../src/mips/regexp-macro-assembler-mips.h',
            '../../src/mips/simulator-mips.cc',
            '../../src/mips/simulator-mips.h',
            '../../src/compiler/mips/code-generator-mips.cc',
            '../../src/compiler/mips/instruction-codes-mips.h',
            '../../src/compiler/mips/instruction-selector-mips.cc',
            '../../src/compiler/mips/linkage-mips.cc',
            '../../src/ic/mips/access-compiler-mips.cc',
            '../../src/ic/mips/handler-compiler-mips.cc',
            '../../src/ic/mips/ic-mips.cc',
            '../../src/ic/mips/ic-compiler-mips.cc',
            '../../src/ic/mips/stub-cache-mips.cc',
          ],
        }],
        ['v8_target_arch=="mips64el"', {
          'sources': [  ### gcmole(arch:mips64el) ###
            '../../src/mips64/assembler-mips64.cc',
            '../../src/mips64/assembler-mips64.h',
            '../../src/mips64/assembler-mips64-inl.h',
            '../../src/mips64/builtins-mips64.cc',
            '../../src/mips64/codegen-mips64.cc',
            '../../src/mips64/codegen-mips64.h',
            '../../src/mips64/code-stubs-mips64.cc',
            '../../src/mips64/code-stubs-mips64.h',
            '../../src/mips64/constants-mips64.cc',
            '../../src/mips64/constants-mips64.h',
            '../../src/mips64/cpu-mips64.cc',
            '../../src/mips64/debug-mips64.cc',
            '../../src/mips64/deoptimizer-mips64.cc',
            '../../src/mips64/disasm-mips64.cc',
            '../../src/mips64/frames-mips64.cc',
            '../../src/mips64/frames-mips64.h',
            '../../src/mips64/full-codegen-mips64.cc',
            '../../src/mips64/interface-descriptors-mips64.cc',
            '../../src/mips64/lithium-codegen-mips64.cc',
            '../../src/mips64/lithium-codegen-mips64.h',
            '../../src/mips64/lithium-gap-resolver-mips64.cc',
            '../../src/mips64/lithium-gap-resolver-mips64.h',
            '../../src/mips64/lithium-mips64.cc',
            '../../src/mips64/lithium-mips64.h',
            '../../src/mips64/macro-assembler-mips64.cc',
            '../../src/mips64/macro-assembler-mips64.h',
            '../../src/mips64/regexp-macro-assembler-mips64.cc',
            '../../src/mips64/regexp-macro-assembler-mips64.h',
            '../../src/mips64/simulator-mips64.cc',
            '../../src/mips64/simulator-mips64.h',
            '../../src/compiler/mips64/code-generator-mips64.cc',
            '../../src/compiler/mips64/instruction-codes-mips64.h',
            '../../src/compiler/mips64/instruction-selector-mips64.cc',
            '../../src/compiler/mips64/linkage-mips64.cc',
            '../../src/ic/mips64/access-compiler-mips64.cc',
            '../../src/ic/mips64/handler-compiler-mips64.cc',
            '../../src/ic/mips64/ic-mips64.cc',
            '../../src/ic/mips64/ic-compiler-mips64.cc',
            '../../src/ic/mips64/stub-cache-mips64.cc',
          ],
        }],
        ['v8_target_arch=="x64" or v8_target_arch=="x32"', {
          'sources': [  ### gcmole(arch:x64) ###
            '../../src/x64/assembler-x64-inl.h',
            '../../src/x64/assembler-x64.cc',
            '../../src/x64/assembler-x64.h',
            '../../src/x64/builtins-x64.cc',
            '../../src/x64/code-stubs-x64.cc',
            '../../src/x64/code-stubs-x64.h',
            '../../src/x64/codegen-x64.cc',
            '../../src/x64/codegen-x64.h',
            '../../src/x64/cpu-x64.cc',
            '../../src/x64/debug-x64.cc',
            '../../src/x64/deoptimizer-x64.cc',
            '../../src/x64/disasm-x64.cc',
            '../../src/x64/frames-x64.cc',
            '../../src/x64/frames-x64.h',
            '../../src/x64/full-codegen-x64.cc',
            '../../src/x64/interface-descriptors-x64.cc',
            '../../src/x64/lithium-codegen-x64.cc',
            '../../src/x64/lithium-codegen-x64.h',
            '../../src/x64/lithium-gap-resolver-x64.cc',
            '../../src/x64/lithium-gap-resolver-x64.h',
            '../../src/x64/lithium-x64.cc',
            '../../src/x64/lithium-x64.h',
            '../../src/x64/macro-assembler-x64.cc',
            '../../src/x64/macro-assembler-x64.h',
            '../../src/x64/regexp-macro-assembler-x64.cc',
            '../../src/x64/regexp-macro-assembler-x64.h',
            '../../src/ic/x64/access-compiler-x64.cc',
            '../../src/ic/x64/handler-compiler-x64.cc',
            '../../src/ic/x64/ic-x64.cc',
            '../../src/ic/x64/ic-compiler-x64.cc',
            '../../src/ic/x64/stub-cache-x64.cc',
          ],
        }],
        ['v8_target_arch=="x64"', {
          'sources': [
            '../../src/compiler/x64/code-generator-x64.cc',
            '../../src/compiler/x64/instruction-codes-x64.h',
            '../../src/compiler/x64/instruction-selector-x64.cc',
            '../../src/compiler/x64/linkage-x64.cc',
          ],
        }],
        ['v8_target_arch=="ppc" or v8_target_arch=="ppc64"', {
          'sources': [  ### gcmole(arch:ppc) ###
            '../../src/ppc/assembler-ppc-inl.h',
            '../../src/ppc/assembler-ppc.cc',
            '../../src/ppc/assembler-ppc.h',
            '../../src/ppc/builtins-ppc.cc',
            '../../src/ppc/code-stubs-ppc.cc',
            '../../src/ppc/code-stubs-ppc.h',
            '../../src/ppc/codegen-ppc.cc',
            '../../src/ppc/codegen-ppc.h',
            '../../src/ppc/constants-ppc.h',
            '../../src/ppc/constants-ppc.cc',
            '../../src/ppc/cpu-ppc.cc',
            '../../src/ppc/debug-ppc.cc',
            '../../src/ppc/deoptimizer-ppc.cc',
            '../../src/ppc/disasm-ppc.cc',
            '../../src/ppc/frames-ppc.cc',
            '../../src/ppc/frames-ppc.h',
            '../../src/ppc/full-codegen-ppc.cc',
            '../../src/ppc/interface-descriptors-ppc.cc',
            '../../src/ppc/interface-descriptors-ppc.h',
            '../../src/ppc/lithium-ppc.cc',
            '../../src/ppc/lithium-ppc.h',
            '../../src/ppc/lithium-codegen-ppc.cc',
            '../../src/ppc/lithium-codegen-ppc.h',
            '../../src/ppc/lithium-gap-resolver-ppc.cc',
            '../../src/ppc/lithium-gap-resolver-ppc.h',
            '../../src/ppc/macro-assembler-ppc.cc',
            '../../src/ppc/macro-assembler-ppc.h',
            '../../src/ppc/regexp-macro-assembler-ppc.cc',
            '../../src/ppc/regexp-macro-assembler-ppc.h',
            '../../src/ppc/simulator-ppc.cc',
            '../../src/ppc/simulator-ppc.h',
            '../../src/compiler/ppc/code-generator-ppc.cc',
            '../../src/compiler/ppc/instruction-codes-ppc.h',
            '../../src/compiler/ppc/instruction-selector-ppc.cc',
            '../../src/compiler/ppc/linkage-ppc.cc',
            '../../src/ic/ppc/access-compiler-ppc.cc',
            '../../src/ic/ppc/handler-compiler-ppc.cc',
            '../../src/ic/ppc/ic-ppc.cc',
            '../../src/ic/ppc/ic-compiler-ppc.cc',
            '../../src/ic/ppc/stub-cache-ppc.cc',
          ],
        }],
        ['OS=="win"', {
          'variables': {
            'gyp_generators': '\n' % include_target)
          else:
            f.write('#include <%s>\n' % include_target)

          if include_after:
            for header in include_after.split(':'):
              f.write('#include %s\n' % header)

          if options.define:
            for define in options.define:
              key, value = define.split('=', 1)
              # This non-standard pop_macro extension is supported
              # by compilers we support (GCC, clang).
              f.write('#pragma pop_macro("%s")\n' % key)


def DoMain(argv):
  return '\n'.join(GeneratorMain(argv))


if __name__ == '__main__':
  DoMain(sys.argv[1:])
node-v4.8.2/deps/v8/tools/gcmole/bootstrap.sh000755 000766 000024 00000010470 13070706735 021234 0ustar00iojsstaff000000 000000 #!/usr/bin/env bash

# Copyright 2013 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

# This script will build libgcmole.so. Building a recent clang needs a
# recent GCC, so if you explicitly want to use GCC 4.8, use:
#
#    CC=gcc-4.8 CPP=cpp-4.8 CXX=g++-4.8 CXXFLAGS=-static-libstdc++ CXXCPP=cpp-4.8 ./bootstrap.sh

CLANG_RELEASE=3.5

THIS_DIR="$(dirname "${0}")"
LLVM_DIR="${THIS_DIR}/../../third_party/llvm"
CLANG_DIR="${LLVM_DIR}/tools/clang"

LLVM_REPO_URL=${LLVM_URL:-https://llvm.org/svn/llvm-project}

# Die if any command dies.
set -e

OS="$(uname -s)"

# Xcode and clang don't get along when predictive compilation is enabled.
# http://crbug.com/96315
if [[ "${OS}" = "Darwin" ]] && xcodebuild -version | grep -q 'Xcode 3.2' ; then
  XCONF=com.apple.Xcode
  if [[ "${GYP_GENERATORS}" != "make" ]] && \
     [ "$(defaults read "${XCONF}" EnablePredictiveCompilation)" != "0" ]; then
    echo
    echo "          HEARKEN!"
    echo "You're using Xcode3 and you have 'Predictive Compilation' enabled."
    echo "This does not work well with clang (http://crbug.com/96315)."
    echo "Disable it in Preferences->Building (lower right), or run"
    echo "    defaults write ${XCONF} EnablePredictiveCompilation -boolean NO"
    echo "while Xcode is not running."
    echo
  fi

  SUB_VERSION=$(xcodebuild -version | sed -Ene 's/Xcode 3\.2\.([0-9]+)/\1/p')
  if [[ "${SUB_VERSION}" < 6 ]]; then
    echo
    echo "          YOUR LD IS BUGGY!"
    echo "Please upgrade Xcode to at least 3.2.6."
    echo
  fi
fi

echo Getting LLVM r"${CLANG_RELEASE}" in "${LLVM_DIR}"
if ! svn co --force \
    "${LLVM_REPO_URL}/llvm/branches/release_${CLANG_RELEASE/./}" \
    "${LLVM_DIR}"; then
  echo Checkout failed, retrying
  rm -rf "${LLVM_DIR}"
  svn co --force \
      "${LLVM_REPO_URL}/llvm/branches/release_${CLANG_RELEASE/./}" \
      "${LLVM_DIR}"
fi

echo Getting clang r"${CLANG_RELEASE}" in "${CLANG_DIR}"
svn co --force \
    "${LLVM_REPO_URL}/cfe/branches/release_${CLANG_RELEASE/./}" \
    "${CLANG_DIR}"

# Echo all commands
set -x

NUM_JOBS=3
if [[ "${OS}" = "Linux" ]]; then
  NUM_JOBS="$(grep -c "^processor" /proc/cpuinfo)"
elif [ "${OS}" = "Darwin" ]; then
  NUM_JOBS="$(sysctl -n hw.ncpu)"
fi

# Build clang.
cd "${LLVM_DIR}"
if [[ ! -f ./config.status ]]; then
  ../llvm/configure \
      --enable-optimized \
      --disable-threads \
      --disable-pthreads \
      --without-llvmgcc \
      --without-llvmgxx
fi

MACOSX_DEPLOYMENT_TARGET=10.5 make -j"${NUM_JOBS}"
STRIP_FLAGS=
if [ "${OS}" = "Darwin" ]; then
  # See http://crbug.com/256342
  STRIP_FLAGS=-x
fi
strip ${STRIP_FLAGS} Release+Asserts/bin/clang
cd -

# Build libgcmole.so
make -C "${THIS_DIR}" clean
make -C "${THIS_DIR}" LLVM_SRC_ROOT="${LLVM_DIR}" libgcmole.so

set +x

echo
echo You can now run gcmole using this command:
echo
echo CLANG_BIN=\"third_party/llvm/Release+Asserts/bin\" lua tools/gcmole/gcmole.lua
echo
node-v4.8.2/deps/v8/tools/gcmole/gccause.lua000644 000766 000024 00000004411 13070706735 020773 0ustar00iojsstaff000000 000000 -- Copyright 2011 the V8 project authors. All rights reserved.
-- Redistribution and use in source and binary forms, with or without
-- modification, are permitted provided that the following conditions are
-- met:
--
--     * Redistributions of source code must retain the above copyright
--       notice, this list of conditions and the following disclaimer.
--     * Redistributions in binary form must reproduce the above
--       copyright notice, this list of conditions and the following
--       disclaimer in the documentation and/or other materials provided
--       with the distribution.
--     * Neither the name of Google Inc. nor the names of its
--       contributors may be used to endorse or promote products derived
--       from this software without specific prior written permission.
--
-- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-- A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-- OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-- SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-- LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-- DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-- THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-- (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-- OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

-- This is an auxiliary tool that reads gccauses file generated by
-- gcmole.lua and prints tree of the calls that can potentially cause a GC
-- inside a given function.
--
-- Usage: lua tools/gcmole/gccause.lua 
--

assert(loadfile "gccauses")()

local P = ...

local T = {}

local function TrackCause(name, lvl)
   io.write(("  "):rep(lvl or 0), name, "\n")
   if GC[name] then
      local causes = GC[name]
      for i = 1, #causes do
	 local f = causes[i]
	 if not T[f] then
	    T[f] = true
	    TrackCause(f, (lvl or 0) + 1)
	 end

	 if f == '' then break end
      end
   end
end

for name, _ in pairs(GC) do
   if name:match(P) then
      T = {}
      TrackCause(name)
   end
end
node-v4.8.2/deps/v8/tools/gcmole/gcmole.cc000644 000766 000024 00000105554 13070706735 020445 0ustar00iojsstaff000000 000000 // Copyright 2011 the V8 project authors. All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
//       copyright notice, this list of conditions and the following
//       disclaimer in the documentation and/or other materials provided
//       with the distribution.
//     * Neither the name of Google Inc. nor the names of its
//       contributors may be used to endorse or promote products derived
//       from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

// This is clang plugin used by gcmole tool. See README for more details.

#include "clang/AST/AST.h"
#include "clang/AST/ASTConsumer.h"
#include "clang/AST/Mangle.h"
#include "clang/AST/RecursiveASTVisitor.h"
#include "clang/AST/StmtVisitor.h"
#include "clang/Frontend/FrontendPluginRegistry.h"
#include "clang/Frontend/CompilerInstance.h"
#include "llvm/Support/raw_ostream.h"

#include 
#include 
#include 
#include 
#include 
#include 

namespace {

typedef std::string MangledName;
typedef std::set CalleesSet;

static bool GetMangledName(clang::MangleContext* ctx,
                           const clang::NamedDecl* decl,
                           MangledName* result) {
  if (!llvm::isa(decl) &&
      !llvm::isa(decl)) {
    llvm::SmallVector output;
    llvm::raw_svector_ostream out(output);
    ctx->mangleName(decl, out);
    *result = out.str().str();
    return true;
  }

  return false;
}


static bool InV8Namespace(const clang::NamedDecl* decl) {
  return decl->getQualifiedNameAsString().compare(0, 4, "v8::") == 0;
}


static std::string EXTERNAL("EXTERNAL");
static std::string STATE_TAG("enum v8::internal::StateTag");

static bool IsExternalVMState(const clang::ValueDecl* var) {
  const clang::EnumConstantDecl* enum_constant =
      llvm::dyn_cast(var);
  if (enum_constant != NULL && enum_constant->getNameAsString() == EXTERNAL) {
    clang::QualType type = enum_constant->getType();
    return (type.getAsString() == STATE_TAG);
  }

  return false;
}


struct Resolver {
  explicit Resolver(clang::ASTContext& ctx)
      : ctx_(ctx), decl_ctx_(ctx.getTranslationUnitDecl()) {
  }

  Resolver(clang::ASTContext& ctx, clang::DeclContext* decl_ctx)
      : ctx_(ctx), decl_ctx_(decl_ctx) {
  }

  clang::DeclarationName ResolveName(const char* n) {
    clang::IdentifierInfo* ident = &ctx_.Idents.get(n);
    return ctx_.DeclarationNames.getIdentifier(ident);
  }

  Resolver ResolveNamespace(const char* n) {
    return Resolver(ctx_, Resolve(n));
  }

  template
  T* Resolve(const char* n) {
    if (decl_ctx_ == NULL) return NULL;

    clang::DeclContext::lookup_result result =
        decl_ctx_->lookup(ResolveName(n));

    clang::DeclContext::lookup_iterator end = result.end();
    for (clang::DeclContext::lookup_iterator i = result.begin(); i != end;
         i++) {
      if (llvm::isa(*i)) return llvm::cast(*i);
    }

    return NULL;
  }

 private:
  clang::ASTContext& ctx_;
  clang::DeclContext* decl_ctx_;
};


class CalleesPrinter : public clang::RecursiveASTVisitor {
 public:
  explicit CalleesPrinter(clang::MangleContext* ctx) : ctx_(ctx) {
  }

  virtual bool VisitCallExpr(clang::CallExpr* expr) {
    const clang::FunctionDecl* callee = expr->getDirectCallee();
    if (callee != NULL) AnalyzeFunction(callee);
    return true;
  }

  virtual bool VisitDeclRefExpr(clang::DeclRefExpr* expr) {
    // If function mentions EXTERNAL VMState add artificial garbage collection
    // mark.
    if (IsExternalVMState(expr->getDecl())) AddCallee("CollectGarbage");
    return true;
  }

  void AnalyzeFunction(const clang::FunctionDecl* f) {
    MangledName name;
    if (InV8Namespace(f) && GetMangledName(ctx_, f, &name)) {
      AddCallee(name);

      const clang::FunctionDecl* body = NULL;
      if (f->hasBody(body) && !Analyzed(name)) {
        EnterScope(name);
        TraverseStmt(body->getBody());
        LeaveScope();
      }
    }
  }

  typedef std::map Callgraph;

  bool Analyzed(const MangledName& name) {
    return callgraph_[name] != NULL;
  }

  void EnterScope(const MangledName& name) {
    CalleesSet* callees = callgraph_[name];

    if (callees == NULL) {
      callgraph_[name] = callees = new CalleesSet();
    }

    scopes_.push(callees);
  }

  void LeaveScope() {
    scopes_.pop();
  }

  void AddCallee(const MangledName& name) {
    if (!scopes_.empty()) scopes_.top()->insert(name);
  }

  void PrintCallGraph() {
    for (Callgraph::const_iterator i = callgraph_.begin(), e = callgraph_.end();
         i != e;
         ++i) {
      std::cout << i->first << "\n";

      CalleesSet* callees = i->second;
      for (CalleesSet::const_iterator j = callees->begin(), e = callees->end();
           j != e;
           ++j) {
        std::cout << "\t" << *j << "\n";
      }
    }
  }

 private:
  clang::MangleContext* ctx_;

  std::stack scopes_;
  Callgraph callgraph_;
};


class FunctionDeclarationFinder
    : public clang::ASTConsumer,
      public clang::RecursiveASTVisitor {
 public:
  explicit FunctionDeclarationFinder(clang::DiagnosticsEngine& d,
                                     clang::SourceManager& sm,
                                     const std::vector& args)
      : d_(d), sm_(sm) {}

  virtual void HandleTranslationUnit(clang::ASTContext &ctx) {
    mangle_context_ = clang::ItaniumMangleContext::create(ctx, d_);
    callees_printer_ = new CalleesPrinter(mangle_context_);

    TraverseDecl(ctx.getTranslationUnitDecl());

    callees_printer_->PrintCallGraph();
  }

  virtual bool VisitFunctionDecl(clang::FunctionDecl* decl) {
    callees_printer_->AnalyzeFunction(decl);
    return true;
  }

 private:
  clang::DiagnosticsEngine& d_;
  clang::SourceManager& sm_;
  clang::MangleContext* mangle_context_;

  CalleesPrinter* callees_printer_;
};


static bool loaded = false;
static CalleesSet gc_suspects;


static void LoadGCSuspects() {
  if (loaded) return;

  std::ifstream fin("gcsuspects");
  std::string s;

  while (fin >> s) gc_suspects.insert(s);

  loaded = true;
}


static bool KnownToCauseGC(clang::MangleContext* ctx,
                           const clang::FunctionDecl* decl) {
  LoadGCSuspects();

  if (!InV8Namespace(decl)) return false;

  MangledName name;
  if (GetMangledName(ctx, decl, &name)) {
    return gc_suspects.find(name) != gc_suspects.end();
  }

  return false;
}


static const int kNoEffect = 0;
static const int kCausesGC = 1;
static const int kRawDef = 2;
static const int kRawUse = 4;
static const int kAllEffects = kCausesGC | kRawDef | kRawUse;

class Environment;

class ExprEffect {
 public:
  bool hasGC() { return (effect_ & kCausesGC) != 0; }
  void setGC() { effect_ |= kCausesGC; }

  bool hasRawDef() { return (effect_ & kRawDef) != 0; }
  void setRawDef() { effect_ |= kRawDef; }

  bool hasRawUse() { return (effect_ & kRawUse) != 0; }
  void setRawUse() { effect_ |= kRawUse; }

  static ExprEffect None() { return ExprEffect(kNoEffect, NULL); }
  static ExprEffect NoneWithEnv(Environment* env) {
    return ExprEffect(kNoEffect, env);
  }
  static ExprEffect RawUse() { return ExprEffect(kRawUse, NULL); }

  static ExprEffect Merge(ExprEffect a, ExprEffect b);
  static ExprEffect MergeSeq(ExprEffect a, ExprEffect b);
  ExprEffect Define(const std::string& name);

  Environment* env() {
    return reinterpret_cast(effect_ & ~kAllEffects);
  }

  static ExprEffect GC() {
    return ExprEffect(kCausesGC, NULL);
  }

 private:
  ExprEffect(int effect, Environment* env)
      : effect_((effect & kAllEffects) |
                reinterpret_cast(env)) { }

  intptr_t effect_;
};


const std::string BAD_EXPR_MSG("Possible problem with evaluation order.");
const std::string DEAD_VAR_MSG("Possibly dead variable.");


class Environment {
 public:
  Environment() { }

  static Environment Unreachable() {
    Environment env;
    env.live_.set();
    return env;
  }

  static Environment Merge(const Environment& l,
                           const Environment& r) {
    return Environment(l, r);
  }

  Environment ApplyEffect(ExprEffect effect) const {
    Environment out = effect.hasGC() ? Environment() : Environment(*this);
    if (effect.env() != NULL) out.live_ |= effect.env()->live_;
    return out;
  }

  typedef std::map SymbolTable;

  bool IsAlive(const std::string& name) const {
    SymbolTable::iterator code = symbol_table_.find(name);
    if (code == symbol_table_.end()) return false;
    return live_[code->second];
  }

  bool Equal(const Environment& env) {
    return live_ == env.live_;
  }

  Environment Define(const std::string& name) const {
    return Environment(*this, SymbolToCode(name));
  }

  void MDefine(const std::string& name) {
    live_.set(SymbolToCode(name));
  }

  static int SymbolToCode(const std::string& name) {
    SymbolTable::iterator code = symbol_table_.find(name);

    if (code == symbol_table_.end()) {
      int new_code = symbol_table_.size();
      symbol_table_.insert(std::make_pair(name, new_code));
      return new_code;
    }

    return code->second;
  }

  static void ClearSymbolTable() {
    std::vector::iterator end = envs_.end();
    for (std::vector::iterator i = envs_.begin();
         i != end;
         ++i) {
      delete *i;
    }
    envs_.clear();
    symbol_table_.clear();
  }

  void Print() const {
    bool comma = false;
    std::cout << "{";
    SymbolTable::iterator end = symbol_table_.end();
    for (SymbolTable::iterator i = symbol_table_.begin();
         i != end;
         ++i) {
      if (live_[i->second]) {
        if (comma) std::cout << ", ";
        std::cout << i->first;
        comma = true;
      }
    }
    std::cout << "}";
  }

  static Environment* Allocate(const Environment& env) {
    Environment* allocated_env = new Environment(env);
    envs_.push_back(allocated_env);
    return allocated_env;
  }

 private:
  Environment(const Environment& l, const Environment& r)
      : live_(l.live_ & r.live_) {
  }

  Environment(const Environment& l, int code)
      : live_(l.live_) {
    live_.set(code);
  }

  static SymbolTable symbol_table_;
  static std::vector envs_;

  static const int kMaxNumberOfLocals = 256;
  std::bitset live_;

  friend class ExprEffect;
  friend class CallProps;
};


class CallProps {
 public:
  CallProps() : env_(NULL) { }

  void SetEffect(int arg, ExprEffect in) {
    if (in.hasGC()) gc_.set(arg);
    if (in.hasRawDef()) raw_def_.set(arg);
    if (in.hasRawUse()) raw_use_.set(arg);
    if (in.env() != NULL) {
      if (env_ == NULL) env_ = in.env();
      env_->live_ |= in.env()->live_;
    }
  }

  ExprEffect ComputeCumulativeEffect(bool result_is_raw) {
    ExprEffect out = ExprEffect::NoneWithEnv(env_);
    if (gc_.any()) out.setGC();
    if (raw_use_.any()) out.setRawUse();
    if (result_is_raw) out.setRawDef();
    return out;
  }

  bool IsSafe() {
    if (!gc_.any()) return true;
    std::bitset raw = (raw_def_ | raw_use_);
    if (!raw.any()) return true;
    return gc_.count() == 1 && !((raw ^ gc_).any());
  }

 private:
  static const int kMaxNumberOfArguments = 64;
  std::bitset raw_def_;
  std::bitset raw_use_;
  std::bitset gc_;
  Environment* env_;
};


Environment::SymbolTable Environment::symbol_table_;
std::vector Environment::envs_;


ExprEffect ExprEffect::Merge(ExprEffect a, ExprEffect b) {
  Environment* a_env = a.env();
  Environment* b_env = b.env();
  Environment* out = NULL;
  if (a_env != NULL && b_env != NULL) {
    out = Environment::Allocate(*a_env);
    out->live_ &= b_env->live_;
  }
  return ExprEffect(a.effect_ | b.effect_, out);
}


ExprEffect ExprEffect::MergeSeq(ExprEffect a, ExprEffect b) {
  Environment* a_env = b.hasGC() ? NULL : a.env();
  Environment* b_env = b.env();
  Environment* out = (b_env == NULL) ? a_env : b_env;
  if (a_env != NULL && b_env != NULL) {
    out = Environment::Allocate(*b_env);
    out->live_ |= a_env->live_;
  }
  return ExprEffect(a.effect_ | b.effect_, out);
}


ExprEffect ExprEffect::Define(const std::string& name) {
  Environment* e = env();
  if (e == NULL) {
    e = Environment::Allocate(Environment());
  }
  e->MDefine(name);
  return ExprEffect(effect_, e);
}


static std::string THIS ("this");


class FunctionAnalyzer {
 public:
  FunctionAnalyzer(clang::MangleContext* ctx,
                   clang::DeclarationName handle_decl_name,
                   clang::CXXRecordDecl* object_decl,
                   clang::CXXRecordDecl* smi_decl, clang::DiagnosticsEngine& d,
                   clang::SourceManager& sm, bool dead_vars_analysis)
      : ctx_(ctx),
        handle_decl_name_(handle_decl_name),
        object_decl_(object_decl),
        smi_decl_(smi_decl),
        d_(d),
        sm_(sm),
        block_(NULL),
        dead_vars_analysis_(dead_vars_analysis) {}


  // --------------------------------------------------------------------------
  // Expressions
  // --------------------------------------------------------------------------

  ExprEffect VisitExpr(clang::Expr* expr, const Environment& env) {
#define VISIT(type)                                                         \
  do {                                                                      \
    clang::type* concrete_expr = llvm::dyn_cast_or_null(expr); \
    if (concrete_expr != NULL) {                                            \
      return Visit##type(concrete_expr, env);                               \
    }                                                                       \
  } while (0);

    VISIT(AbstractConditionalOperator);
    VISIT(AddrLabelExpr);
    VISIT(ArraySubscriptExpr);
    VISIT(BinaryOperator);
    VISIT(BlockExpr);
    VISIT(CallExpr);
    VISIT(CastExpr);
    VISIT(CharacterLiteral);
    VISIT(ChooseExpr);
    VISIT(CompoundLiteralExpr);
    VISIT(CXXBindTemporaryExpr);
    VISIT(CXXBoolLiteralExpr);
    VISIT(CXXConstructExpr);
    VISIT(CXXDefaultArgExpr);
    VISIT(CXXDeleteExpr);
    VISIT(CXXDependentScopeMemberExpr);
    VISIT(CXXNewExpr);
    VISIT(CXXNoexceptExpr);
    VISIT(CXXNullPtrLiteralExpr);
    VISIT(CXXPseudoDestructorExpr);
    VISIT(CXXScalarValueInitExpr);
    VISIT(CXXThisExpr);
    VISIT(CXXThrowExpr);
    VISIT(CXXTypeidExpr);
    VISIT(CXXUnresolvedConstructExpr);
    VISIT(CXXUuidofExpr);
    VISIT(DeclRefExpr);
    VISIT(DependentScopeDeclRefExpr);
    VISIT(DesignatedInitExpr);
    VISIT(ExprWithCleanups);
    VISIT(ExtVectorElementExpr);
    VISIT(FloatingLiteral);
    VISIT(GNUNullExpr);
    VISIT(ImaginaryLiteral);
    VISIT(ImplicitValueInitExpr);
    VISIT(InitListExpr);
    VISIT(IntegerLiteral);
    VISIT(MemberExpr);
    VISIT(OffsetOfExpr);
    VISIT(OpaqueValueExpr);
    VISIT(OverloadExpr);
    VISIT(PackExpansionExpr);
    VISIT(ParenExpr);
    VISIT(ParenListExpr);
    VISIT(PredefinedExpr);
    VISIT(ShuffleVectorExpr);
    VISIT(SizeOfPackExpr);
    VISIT(StmtExpr);
    VISIT(StringLiteral);
    VISIT(SubstNonTypeTemplateParmPackExpr);
    VISIT(TypeTraitExpr);
    VISIT(UnaryOperator);
    VISIT(VAArgExpr);
#undef VISIT

    return ExprEffect::None();
  }

#define DECL_VISIT_EXPR(type)                                           \
  ExprEffect Visit##type (clang::type* expr, const Environment& env)

#define IGNORE_EXPR(type)                                               \
  ExprEffect Visit##type (clang::type* expr, const Environment& env) {  \
    return ExprEffect::None();                                          \
  }

  IGNORE_EXPR(AddrLabelExpr);
  IGNORE_EXPR(BlockExpr);
  IGNORE_EXPR(CharacterLiteral);
  IGNORE_EXPR(ChooseExpr);
  IGNORE_EXPR(CompoundLiteralExpr);
  IGNORE_EXPR(CXXBoolLiteralExpr);
  IGNORE_EXPR(CXXDependentScopeMemberExpr);
  IGNORE_EXPR(CXXNullPtrLiteralExpr);
  IGNORE_EXPR(CXXPseudoDestructorExpr);
  IGNORE_EXPR(CXXScalarValueInitExpr);
  IGNORE_EXPR(CXXNoexceptExpr);
  IGNORE_EXPR(CXXTypeidExpr);
  IGNORE_EXPR(CXXUnresolvedConstructExpr);
  IGNORE_EXPR(CXXUuidofExpr);
  IGNORE_EXPR(DependentScopeDeclRefExpr);
  IGNORE_EXPR(DesignatedInitExpr);
  IGNORE_EXPR(ExtVectorElementExpr);
  IGNORE_EXPR(FloatingLiteral);
  IGNORE_EXPR(ImaginaryLiteral);
  IGNORE_EXPR(IntegerLiteral);
  IGNORE_EXPR(OffsetOfExpr);
  IGNORE_EXPR(ImplicitValueInitExpr);
  IGNORE_EXPR(PackExpansionExpr);
  IGNORE_EXPR(PredefinedExpr);
  IGNORE_EXPR(ShuffleVectorExpr);
  IGNORE_EXPR(SizeOfPackExpr);
  IGNORE_EXPR(StmtExpr);
  IGNORE_EXPR(StringLiteral);
  IGNORE_EXPR(SubstNonTypeTemplateParmPackExpr);
  IGNORE_EXPR(TypeTraitExpr);
  IGNORE_EXPR(VAArgExpr);
  IGNORE_EXPR(GNUNullExpr);
  IGNORE_EXPR(OverloadExpr);

  DECL_VISIT_EXPR(CXXThisExpr) {
    return Use(expr, expr->getType(), THIS, env);
  }

  DECL_VISIT_EXPR(AbstractConditionalOperator) {
    Environment after_cond = env.ApplyEffect(VisitExpr(expr->getCond(), env));
    return ExprEffect::Merge(VisitExpr(expr->getTrueExpr(), after_cond),
                             VisitExpr(expr->getFalseExpr(), after_cond));
  }

  DECL_VISIT_EXPR(ArraySubscriptExpr) {
    clang::Expr* exprs[2] = {expr->getBase(), expr->getIdx()};
    return Par(expr, 2, exprs, env);
  }

  bool IsRawPointerVar(clang::Expr* expr, std::string* var_name) {
    if (llvm::isa(expr)) {
      *var_name =
          llvm::cast(expr)->getDecl()->getNameAsString();
      return true;
    }
    return false;
  }

  DECL_VISIT_EXPR(BinaryOperator) {
    clang::Expr* lhs = expr->getLHS();
    clang::Expr* rhs = expr->getRHS();
    clang::Expr* exprs[2] = {lhs, rhs};

    switch (expr->getOpcode()) {
      case clang::BO_Comma:
        return Seq(expr, 2, exprs, env);

      case clang::BO_LAnd:
      case clang::BO_LOr:
        return ExprEffect::Merge(VisitExpr(lhs, env), VisitExpr(rhs, env));

      case clang::BO_Assign: {
        std::string var_name;
        if (IsRawPointerVar(lhs, &var_name)) {
          return VisitExpr(rhs, env).Define(var_name);
        }
        return Par(expr, 2, exprs, env);
      }

      default:
        return Par(expr, 2, exprs, env);
    }
  }

  DECL_VISIT_EXPR(CXXBindTemporaryExpr) {
    return VisitExpr(expr->getSubExpr(), env);
  }

  DECL_VISIT_EXPR(CXXConstructExpr) {
    return VisitArguments<>(expr, env);
  }

  DECL_VISIT_EXPR(CXXDefaultArgExpr) {
    return VisitExpr(expr->getExpr(), env);
  }

  DECL_VISIT_EXPR(CXXDeleteExpr) {
    return VisitExpr(expr->getArgument(), env);
  }

  DECL_VISIT_EXPR(CXXNewExpr) { return VisitExpr(expr->getInitializer(), env); }

  DECL_VISIT_EXPR(ExprWithCleanups) {
    return VisitExpr(expr->getSubExpr(), env);
  }

  DECL_VISIT_EXPR(CXXThrowExpr) {
    return VisitExpr(expr->getSubExpr(), env);
  }

  DECL_VISIT_EXPR(InitListExpr) {
    return Seq(expr, expr->getNumInits(), expr->getInits(), env);
  }

  DECL_VISIT_EXPR(MemberExpr) {
    return VisitExpr(expr->getBase(), env);
  }

  DECL_VISIT_EXPR(OpaqueValueExpr) {
    return VisitExpr(expr->getSourceExpr(), env);
  }

  DECL_VISIT_EXPR(ParenExpr) {
    return VisitExpr(expr->getSubExpr(), env);
  }

  DECL_VISIT_EXPR(ParenListExpr) {
    return Par(expr, expr->getNumExprs(), expr->getExprs(), env);
  }

  DECL_VISIT_EXPR(UnaryOperator) {
    // TODO We are treating all expressions that look like &raw_pointer_var
    //      as definitions of raw_pointer_var. This should be changed to
    //      recognize less generic pattern:
    //
    //         if (maybe_object->ToObject(&obj)) return maybe_object;
    //
    if (expr->getOpcode() == clang::UO_AddrOf) {
      std::string var_name;
      if (IsRawPointerVar(expr->getSubExpr(), &var_name)) {
        return ExprEffect::None().Define(var_name);
      }
    }
    return VisitExpr(expr->getSubExpr(), env);
  }

  DECL_VISIT_EXPR(CastExpr) {
    return VisitExpr(expr->getSubExpr(), env);
  }

  DECL_VISIT_EXPR(DeclRefExpr) {
    return Use(expr, expr->getDecl(), env);
  }

  ExprEffect Par(clang::Expr* parent,
                 int n,
                 clang::Expr** exprs,
                 const Environment& env) {
    CallProps props;

    for (int i = 0; i < n; ++i) {
      props.SetEffect(i, VisitExpr(exprs[i], env));
    }

    if (!props.IsSafe()) ReportUnsafe(parent, BAD_EXPR_MSG);

    return props.ComputeCumulativeEffect(IsRawPointerType(parent->getType()));
  }

  ExprEffect Seq(clang::Stmt* parent,
                 int n,
                 clang::Expr** exprs,
                 const Environment& env) {
    ExprEffect out = ExprEffect::None();
    Environment out_env = env;
    for (int i = 0; i < n; ++i) {
      out = ExprEffect::MergeSeq(out, VisitExpr(exprs[i], out_env));
      out_env = out_env.ApplyEffect(out);
    }
    return out;
  }

  ExprEffect Use(const clang::Expr* parent,
                 const clang::QualType& var_type,
                 const std::string& var_name,
                 const Environment& env) {
    if (IsRawPointerType(var_type)) {
      if (!env.IsAlive(var_name) && dead_vars_analysis_) {
        ReportUnsafe(parent, DEAD_VAR_MSG);
      }
      return ExprEffect::RawUse();
    }
    return ExprEffect::None();
  }

  ExprEffect Use(const clang::Expr* parent,
                 const clang::ValueDecl* var,
                 const Environment& env) {
    if (IsExternalVMState(var)) {
      return ExprEffect::GC();
    }
    return Use(parent, var->getType(), var->getNameAsString(), env);
  }


  template
  ExprEffect VisitArguments(ExprType* call, const Environment& env) {
    CallProps props;
    VisitArguments<>(call, &props, env);
    if (!props.IsSafe()) ReportUnsafe(call, BAD_EXPR_MSG);
    return props.ComputeCumulativeEffect(IsRawPointerType(call->getType()));
  }

  template
  void VisitArguments(ExprType* call,
                      CallProps* props,
                      const Environment& env) {
    for (unsigned arg = 0; arg < call->getNumArgs(); arg++) {
      props->SetEffect(arg + 1, VisitExpr(call->getArg(arg), env));
    }
  }


  ExprEffect VisitCallExpr(clang::CallExpr* call,
                           const Environment& env) {
    CallProps props;

    clang::CXXMemberCallExpr* memcall =
        llvm::dyn_cast_or_null(call);
    if (memcall != NULL) {
      clang::Expr* receiver = memcall->getImplicitObjectArgument();
      props.SetEffect(0, VisitExpr(receiver, env));
    }

    VisitArguments<>(call, &props, env);

    if (!props.IsSafe()) ReportUnsafe(call, BAD_EXPR_MSG);

    ExprEffect out =
        props.ComputeCumulativeEffect(IsRawPointerType(call->getType()));

    clang::FunctionDecl* callee = call->getDirectCallee();
    if ((callee != NULL) && KnownToCauseGC(ctx_, callee)) {
      out.setGC();
    }

    return out;
  }

  // --------------------------------------------------------------------------
  // Statements
  // --------------------------------------------------------------------------

  Environment VisitStmt(clang::Stmt* stmt, const Environment& env) {
#define VISIT(type)                                                         \
  do {                                                                      \
    clang::type* concrete_stmt = llvm::dyn_cast_or_null(stmt); \
    if (concrete_stmt != NULL) {                                            \
      return Visit##type(concrete_stmt, env);                               \
    }                                                                       \
  } while (0);

    if (clang::Expr* expr = llvm::dyn_cast_or_null(stmt)) {
      return env.ApplyEffect(VisitExpr(expr, env));
    }

    VISIT(AsmStmt);
    VISIT(BreakStmt);
    VISIT(CompoundStmt);
    VISIT(ContinueStmt);
    VISIT(CXXCatchStmt);
    VISIT(CXXTryStmt);
    VISIT(DeclStmt);
    VISIT(DoStmt);
    VISIT(ForStmt);
    VISIT(GotoStmt);
    VISIT(IfStmt);
    VISIT(IndirectGotoStmt);
    VISIT(LabelStmt);
    VISIT(NullStmt);
    VISIT(ReturnStmt);
    VISIT(CaseStmt);
    VISIT(DefaultStmt);
    VISIT(SwitchStmt);
    VISIT(WhileStmt);
#undef VISIT

    return env;
  }

#define DECL_VISIT_STMT(type)                                           \
  Environment Visit##type (clang::type* stmt, const Environment& env)

#define IGNORE_STMT(type)                                               \
  Environment Visit##type (clang::type* stmt, const Environment& env) { \
    return env;                                                         \
  }

  IGNORE_STMT(IndirectGotoStmt);
  IGNORE_STMT(NullStmt);
  IGNORE_STMT(AsmStmt);

  // We are ignoring control flow for simplicity.
  IGNORE_STMT(GotoStmt);
  IGNORE_STMT(LabelStmt);

  // We are ignoring try/catch because V8 does not use them.
  IGNORE_STMT(CXXCatchStmt);
  IGNORE_STMT(CXXTryStmt);

  class Block {
   public:
    Block(const Environment& in,
          FunctionAnalyzer* owner)
        : in_(in),
          out_(Environment::Unreachable()),
          changed_(false),
          owner_(owner) {
      parent_ = owner_->EnterBlock(this);
    }

    ~Block() {
      owner_->LeaveBlock(parent_);
    }

    void MergeIn(const Environment& env) {
      Environment old_in = in_;
      in_ = Environment::Merge(in_, env);
      changed_ = !old_in.Equal(in_);
    }

    bool changed() {
      if (changed_) {
        changed_ = false;
        return true;
      }
      return false;
    }

    const Environment& in() {
      return in_;
    }

    const Environment& out() {
      return out_;
    }

    void MergeOut(const Environment& env) {
      out_ = Environment::Merge(out_, env);
    }

    void Seq(clang::Stmt* a, clang::Stmt* b, clang::Stmt* c) {
      Environment a_out = owner_->VisitStmt(a, in());
      Environment b_out = owner_->VisitStmt(b, a_out);
      Environment c_out = owner_->VisitStmt(c, b_out);
      MergeOut(c_out);
    }

    void Seq(clang::Stmt* a, clang::Stmt* b) {
      Environment a_out = owner_->VisitStmt(a, in());
      Environment b_out = owner_->VisitStmt(b, a_out);
      MergeOut(b_out);
    }

    void Loop(clang::Stmt* a, clang::Stmt* b, clang::Stmt* c) {
      Seq(a, b, c);
      MergeIn(out());
    }

    void Loop(clang::Stmt* a, clang::Stmt* b) {
      Seq(a, b);
      MergeIn(out());
    }


   private:
    Environment in_;
    Environment out_;
    bool changed_;
    FunctionAnalyzer* owner_;
    Block* parent_;
  };


  DECL_VISIT_STMT(BreakStmt) {
    block_->MergeOut(env);
    return Environment::Unreachable();
  }

  DECL_VISIT_STMT(ContinueStmt) {
    block_->MergeIn(env);
    return Environment::Unreachable();
  }

  DECL_VISIT_STMT(CompoundStmt) {
    Environment out = env;
    clang::CompoundStmt::body_iterator end = stmt->body_end();
    for (clang::CompoundStmt::body_iterator s = stmt->body_begin();
         s != end;
         ++s) {
      out = VisitStmt(*s, out);
    }
    return out;
  }

  DECL_VISIT_STMT(WhileStmt) {
    Block block (env, this);
    do {
      block.Loop(stmt->getCond(), stmt->getBody());
    } while (block.changed());
    return block.out();
  }

  DECL_VISIT_STMT(DoStmt) {
    Block block (env, this);
    do {
      block.Loop(stmt->getBody(), stmt->getCond());
    } while (block.changed());
    return block.out();
  }

  DECL_VISIT_STMT(ForStmt) {
    Block block (VisitStmt(stmt->getInit(), env), this);
    do {
      block.Loop(stmt->getCond(),
                 stmt->getBody(),
                 stmt->getInc());
    } while (block.changed());
    return block.out();
  }

  DECL_VISIT_STMT(IfStmt) {
    Environment cond_out = VisitStmt(stmt->getCond(), env);
    Environment then_out = VisitStmt(stmt->getThen(), cond_out);
    Environment else_out = VisitStmt(stmt->getElse(), cond_out);
    return Environment::Merge(then_out, else_out);
  }

  DECL_VISIT_STMT(SwitchStmt) {
    Block block (env, this);
    block.Seq(stmt->getCond(), stmt->getBody());
    return block.out();
  }

  DECL_VISIT_STMT(CaseStmt) {
    Environment in = Environment::Merge(env, block_->in());
    Environment after_lhs = VisitStmt(stmt->getLHS(), in);
    return VisitStmt(stmt->getSubStmt(), after_lhs);
  }

  DECL_VISIT_STMT(DefaultStmt) {
    Environment in = Environment::Merge(env, block_->in());
    return VisitStmt(stmt->getSubStmt(), in);
  }

  DECL_VISIT_STMT(ReturnStmt) {
    VisitExpr(stmt->getRetValue(), env);
    return Environment::Unreachable();
  }

  const clang::TagType* ToTagType(const clang::Type* t) {
    if (t == NULL) {
      return NULL;
    } else if (llvm::isa(t)) {
      return llvm::cast(t);
    } else if (llvm::isa(t)) {
      return ToTagType(llvm::cast(t)
                           ->getReplacementType()
                           .getTypePtr());
    } else {
      return NULL;
    }
  }

  bool IsDerivedFrom(clang::CXXRecordDecl* record,
                     clang::CXXRecordDecl* base) {
    return (record == base) || record->isDerivedFrom(base);
  }

  bool IsRawPointerType(clang::QualType qtype) {
    const clang::PointerType* type =
        llvm::dyn_cast_or_null(qtype.getTypePtrOrNull());
    if (type == NULL) return false;

    const clang::TagType* pointee =
        ToTagType(type->getPointeeType().getTypePtr());
    if (pointee == NULL) return false;

    clang::CXXRecordDecl* record =
        llvm::dyn_cast_or_null(pointee->getDecl());
    if (record == NULL) return false;

    if (!InV8Namespace(record)) return false;

    if (!record->hasDefinition()) return false;

    record = record->getDefinition();

    return IsDerivedFrom(record, object_decl_) &&
        !IsDerivedFrom(record, smi_decl_);
  }

  Environment VisitDecl(clang::Decl* decl, const Environment& env) {
    if (clang::VarDecl* var = llvm::dyn_cast(decl)) {
      Environment out = var->hasInit() ? VisitStmt(var->getInit(), env) : env;

      if (IsRawPointerType(var->getType())) {
        out = out.Define(var->getNameAsString());
      }

      return out;
    }
    // TODO: handle other declarations?
    return env;
  }

  DECL_VISIT_STMT(DeclStmt) {
    Environment out = env;
    clang::DeclStmt::decl_iterator end = stmt->decl_end();
    for (clang::DeclStmt::decl_iterator decl = stmt->decl_begin();
         decl != end;
         ++decl) {
      out = VisitDecl(*decl, out);
    }
    return out;
  }


  void DefineParameters(const clang::FunctionDecl* f,
                        Environment* env) {
    env->MDefine(THIS);
    clang::FunctionDecl::param_const_iterator end = f->param_end();
    for (clang::FunctionDecl::param_const_iterator p = f->param_begin();
         p != end;
         ++p) {
      env->MDefine((*p)->getNameAsString());
    }
  }


  void AnalyzeFunction(const clang::FunctionDecl* f) {
    const clang::FunctionDecl* body = NULL;
    if (f->hasBody(body)) {
      Environment env;
      DefineParameters(body, &env);
      VisitStmt(body->getBody(), env);
      Environment::ClearSymbolTable();
    }
  }

  Block* EnterBlock(Block* block) {
    Block* parent = block_;
    block_ = block;
    return parent;
  }

  void LeaveBlock(Block* block) {
    block_ = block;
  }

 private:
  void ReportUnsafe(const clang::Expr* expr, const std::string& msg) {
    d_.Report(clang::FullSourceLoc(expr->getExprLoc(), sm_),
              d_.getCustomDiagID(clang::DiagnosticsEngine::Warning, "%0"))
        << msg;
  }


  clang::MangleContext* ctx_;
  clang::DeclarationName handle_decl_name_;
  clang::CXXRecordDecl* object_decl_;
  clang::CXXRecordDecl* smi_decl_;

  clang::DiagnosticsEngine& d_;
  clang::SourceManager& sm_;

  Block* block_;
  bool dead_vars_analysis_;
};


class ProblemsFinder : public clang::ASTConsumer,
                       public clang::RecursiveASTVisitor {
 public:
  ProblemsFinder(clang::DiagnosticsEngine& d, clang::SourceManager& sm,
                 const std::vector& args)
      : d_(d), sm_(sm), dead_vars_analysis_(false) {
    for (unsigned i = 0; i < args.size(); ++i) {
      if (args[i] == "--dead-vars") {
        dead_vars_analysis_ = true;
      }
    }
  }

  virtual void HandleTranslationUnit(clang::ASTContext &ctx) {
    Resolver r(ctx);

    clang::CXXRecordDecl* object_decl =
        r.ResolveNamespace("v8").ResolveNamespace("internal").
            Resolve("Object");

    clang::CXXRecordDecl* smi_decl =
        r.ResolveNamespace("v8").ResolveNamespace("internal").
            Resolve("Smi");

    if (object_decl != NULL) object_decl = object_decl->getDefinition();

    if (smi_decl != NULL) smi_decl = smi_decl->getDefinition();

    if (object_decl != NULL && smi_decl != NULL) {
      function_analyzer_ = new FunctionAnalyzer(
          clang::ItaniumMangleContext::create(ctx, d_), r.ResolveName("Handle"),
          object_decl, smi_decl, d_, sm_, dead_vars_analysis_);
      TraverseDecl(ctx.getTranslationUnitDecl());
    } else {
      if (object_decl == NULL) {
        llvm::errs() << "Failed to resolve v8::internal::Object\n";
      }
      if (smi_decl == NULL) {
        llvm::errs() << "Failed to resolve v8::internal::Smi\n";
      }
    }
  }

  virtual bool VisitFunctionDecl(clang::FunctionDecl* decl) {
    function_analyzer_->AnalyzeFunction(decl);
    return true;
  }

 private:
  clang::DiagnosticsEngine& d_;
  clang::SourceManager& sm_;
  bool dead_vars_analysis_;

  FunctionAnalyzer* function_analyzer_;
};


template
class Action : public clang::PluginASTAction {
 protected:
  clang::ASTConsumer *CreateASTConsumer(clang::CompilerInstance &CI,
                                        llvm::StringRef InFile) {
    return new ConsumerType(CI.getDiagnostics(), CI.getSourceManager(), args_);
  }

  bool ParseArgs(const clang::CompilerInstance &CI,
                 const std::vector& args) {
    args_ = args;
    return true;
  }

  void PrintHelp(llvm::raw_ostream& ros) {
  }
 private:
  std::vector args_;
};


}

static clang::FrontendPluginRegistry::Add >
FindProblems("find-problems", "Find GC-unsafe places.");

static clang::FrontendPluginRegistry::Add<
  Action >
DumpCallees("dump-callees", "Dump callees for each function.");
node-v4.8.2/deps/v8/tools/gcmole/gcmole.lua000644 000766 000024 00000033064 13070706735 020635 0ustar00iojsstaff000000 000000 -- Copyright 2011 the V8 project authors. All rights reserved.
-- Redistribution and use in source and binary forms, with or without
-- modification, are permitted provided that the following conditions are
-- met:
--
--     * Redistributions of source code must retain the above copyright
--       notice, this list of conditions and the following disclaimer.
--     * Redistributions in binary form must reproduce the above
--       copyright notice, this list of conditions and the following
--       disclaimer in the documentation and/or other materials provided
--       with the distribution.
--     * Neither the name of Google Inc. nor the names of its
--       contributors may be used to endorse or promote products derived
--       from this software without specific prior written permission.
--
-- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-- A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-- OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-- SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-- LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-- DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-- THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-- (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-- OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

-- This is main driver for gcmole tool. See README for more details.
-- Usage: CLANG_BIN=clang-bin-dir lua tools/gcmole/gcmole.lua [arm|ia32|x64]

local DIR = arg[0]:match("^(.+)/[^/]+$")

local FLAGS = {
   -- Do not build gcsuspects file and reuse previously generated one.
   reuse_gcsuspects = false;

   -- Don't use parallel python runner.
   sequential = false;

   -- Print commands to console before executing them.
   verbose = false;

   -- Perform dead variable analysis (generates many false positives).
   -- TODO add some sort of whiteliste to filter out false positives.
   dead_vars = false;

   -- When building gcsuspects whitelist certain functions as if they
   -- can be causing GC. Currently used to reduce number of false
   -- positives in dead variables analysis. See TODO for WHITELIST
   -- below.
   whitelist = true;
}
local ARGS = {}

for i = 1, #arg do
   local flag = arg[i]:match "^%-%-([%w_-]+)$"
   if flag then
      local no, real_flag = flag:match "^(no)([%w_-]+)$"
      if real_flag then flag = real_flag end

      flag = flag:gsub("%-", "_")
      if FLAGS[flag] ~= nil then
         FLAGS[flag] = (no ~= "no")
      else
         error("Unknown flag: " .. flag)
      end
   else
      table.insert(ARGS, arg[i])
   end
end

local ARCHS = ARGS[1] and { ARGS[1] } or { 'ia32', 'arm', 'x64', 'arm64' }

local io = require "io"
local os = require "os"

function log(...)
   io.stderr:write(string.format(...))
   io.stderr:write "\n"
end

-------------------------------------------------------------------------------
-- Clang invocation

local CLANG_BIN = os.getenv "CLANG_BIN"
local CLANG_PLUGINS = os.getenv "CLANG_PLUGINS"

if not CLANG_BIN or CLANG_BIN == "" then
   error "CLANG_BIN not set"
end

if not CLANG_PLUGINS or CLANG_PLUGINS == "" then
   CLANG_PLUGINS = DIR
end

local function MakeClangCommandLine(
      plugin, plugin_args, triple, arch_define, arch_options)
   if plugin_args then
     for i = 1, #plugin_args do
        plugin_args[i] = "-Xclang -plugin-arg-" .. plugin
           .. " -Xclang " .. plugin_args[i]
     end
     plugin_args = " " .. table.concat(plugin_args, " ")
   end
   return CLANG_BIN .. "/clang++ -std=c++11 -c "
      .. " -Xclang -load -Xclang " .. CLANG_PLUGINS .. "/libgcmole.so"
      .. " -Xclang -plugin -Xclang "  .. plugin
      .. (plugin_args or "")
      .. " -Xclang -triple -Xclang " .. triple
      .. " -D" .. arch_define
      .. " -DENABLE_DEBUGGER_SUPPORT"
      .. " -DV8_I18N_SUPPORT"
      .. " -I./"
      .. " -Ithird_party/icu/source/common"
      .. " -Ithird_party/icu/source/i18n"
      .. " " .. arch_options
end

local function IterTable(t)
  return coroutine.wrap(function ()
    for i, v in ipairs(t) do
      coroutine.yield(v)
    end
  end)
end

local function SplitResults(lines, func)
   -- Splits the output of parallel.py and calls func on each result.
   -- Bails out in case of an error in one of the executions.
   local current = {}
   local filename = ""
   for line in lines do
      local new_file = line:match "^______________ (.*)$"
      local code = line:match "^______________ finish (%d+) ______________$"
      if code then
         if tonumber(code) > 0 then
            log(table.concat(current, "\n"))
            log("Failed to examine " .. filename)
            return false
         end
         log("-- %s", filename)
         func(filename, IterTable(current))
      elseif new_file then
         filename = new_file
         current = {}
      else
         table.insert(current, line)
      end
   end
   return true
end

function InvokeClangPluginForEachFile(filenames, cfg, func)
   local cmd_line = MakeClangCommandLine(cfg.plugin,
                                         cfg.plugin_args,
                                         cfg.triple,
                                         cfg.arch_define,
                                         cfg.arch_options)
   if FLAGS.sequential then
      log("** Sequential execution.")
      for _, filename in ipairs(filenames) do
         log("-- %s", filename)
         local action = cmd_line .. " " .. filename .. " 2>&1"
         if FLAGS.verbose then print('popen ', action) end
         local pipe = io.popen(action)
         func(filename, pipe:lines())
         local success = pipe:close()
         if not success then error("Failed to run: " .. action) end
      end
   else
      log("** Parallel execution.")
      local action = "python tools/gcmole/parallel.py \""
         .. cmd_line .. "\" " .. table.concat(filenames, " ")
      if FLAGS.verbose then print('popen ', action) end
      local pipe = io.popen(action)
      local success = SplitResults(pipe:lines(), func)
      local closed = pipe:close()
      if not (success and closed) then error("Failed to run: " .. action) end
   end
end

-------------------------------------------------------------------------------
-- GYP file parsing

local function ParseGYPFile()
   local gyp = ""
   local gyp_files = { "tools/gyp/v8.gyp", "test/cctest/cctest.gyp" }
   for i = 1, #gyp_files do
      local f = assert(io.open(gyp_files[i]), "failed to open GYP file")
      local t = f:read('*a')
      gyp = gyp .. t
      f:close()
   end

   local result = {}

   for condition, sources in
      gyp:gmatch "'sources': %[.-### gcmole%((.-)%) ###(.-)%]" do
      if result[condition] == nil then result[condition] = {} end
      for file in sources:gmatch "'%.%./%.%./src/([^']-%.cc)'" do
         table.insert(result[condition], "src/" .. file)
      end
      for file in sources:gmatch "'(test-[^']-%.cc)'" do
         table.insert(result[condition], "test/cctest/" .. file)
      end
   end

   return result
end

local function EvaluateCondition(cond, props)
   if cond == 'all' then return true end

   local p, v = cond:match "(%w+):(%w+)"

   assert(p and v, "failed to parse condition: " .. cond)
   assert(props[p] ~= nil, "undefined configuration property: " .. p)

   return props[p] == v
end

local function BuildFileList(sources, props)
   local list = {}
   for condition, files in pairs(sources) do
      if EvaluateCondition(condition, props) then
         for i = 1, #files do table.insert(list, files[i]) end
      end
   end
   return list
end

local sources = ParseGYPFile()

local function FilesForArch(arch)
   return BuildFileList(sources, { os = 'linux',
                                   arch = arch,
                                   mode = 'debug',
                                   simulator = ''})
end

local mtConfig = {}

mtConfig.__index = mtConfig

local function config (t) return setmetatable(t, mtConfig) end

function mtConfig:extend(t)
   local e = {}
   for k, v in pairs(self) do e[k] = v end
   for k, v in pairs(t) do e[k] = v end
   return config(e)
end

local ARCHITECTURES = {
   ia32 = config { triple = "i586-unknown-linux",
                   arch_define = "V8_TARGET_ARCH_IA32",
                   arch_options = "-m32" },
   arm = config { triple = "i586-unknown-linux",
                  arch_define = "V8_TARGET_ARCH_ARM",
                  arch_options = "-m32" },
   x64 = config { triple = "x86_64-unknown-linux",
                  arch_define = "V8_TARGET_ARCH_X64",
                  arch_options = "" },
   arm64 = config { triple = "x86_64-unknown-linux",
                    arch_define = "V8_TARGET_ARCH_ARM64",
                    arch_options = "" },
}

-------------------------------------------------------------------------------
-- GCSuspects Generation

local gc, gc_caused, funcs

local WHITELIST = {
   -- The following functions call CEntryStub which is always present.
   "MacroAssembler.*CallExternalReference",
   "MacroAssembler.*CallRuntime",
   "CompileCallLoadPropertyWithInterceptor",
   "CallIC.*GenerateMiss",

   -- DirectCEntryStub is a special stub used on ARM. 
   -- It is pinned and always present.
   "DirectCEntryStub.*GenerateCall",  

   -- TODO GCMole currently is sensitive enough to understand that certain 
   --      functions only cause GC and return Failure simulataneously. 
   --      Callsites of such functions are safe as long as they are properly 
   --      check return value and propagate the Failure to the caller.
   --      It should be possible to extend GCMole to understand this.
   "Heap.*AllocateFunctionPrototype",

   -- Ignore all StateTag methods.
   "StateTag",

   -- Ignore printing of elements transition.
   "PrintElementsTransition"
};

local function AddCause(name, cause)
   local t = gc_caused[name]
   if not t then
      t = {}
      gc_caused[name] = t
   end
   table.insert(t, cause)
end

local function resolve(name)
   local f = funcs[name]

   if not f then
      f = {}
      funcs[name] = f

      if name:match "Collect.*Garbage" then
         gc[name] = true
         AddCause(name, "")
      end

      if FLAGS.whitelist then
         for i = 1, #WHITELIST do
            if name:match(WHITELIST[i]) then
               gc[name] = false
            end
         end
      end
   end

    return f
end

local function parse (filename, lines)
   local scope

   for funcname in lines do
      if funcname:sub(1, 1) ~= '\t' then
         resolve(funcname)
         scope = funcname
      else
         local name = funcname:sub(2)
         resolve(name)[scope] = true
      end
   end
end

local function propagate ()
   log "** Propagating GC information"

   local function mark(from, callers)
      for caller, _ in pairs(callers) do
         if gc[caller] == nil then
            gc[caller] = true
            mark(caller, funcs[caller])
         end
         AddCause(caller, from)
      end
   end

   for funcname, callers in pairs(funcs) do
      if gc[funcname] then mark(funcname, callers) end
   end
end

local function GenerateGCSuspects(arch, files, cfg)
   -- Reset the global state.
   gc, gc_caused, funcs = {}, {}, {}

   log ("** Building GC Suspects for %s", arch)
   InvokeClangPluginForEachFile (files,
                                 cfg:extend { plugin = "dump-callees" },
                                 parse)

   propagate()

   local out = assert(io.open("gcsuspects", "w"))
   for name, value in pairs(gc) do if value then out:write (name, '\n') end end
   out:close()

   local out = assert(io.open("gccauses", "w"))
   out:write "GC = {"
   for name, causes in pairs(gc_caused) do
      out:write("['", name, "'] = {")
      for i = 1, #causes do out:write ("'", causes[i], "';") end
      out:write("};\n")
   end
   out:write "}"
   out:close()

   log ("** GCSuspects generated for %s", arch)
end

--------------------------------------------------------------------------------
-- Analysis

local function CheckCorrectnessForArch(arch)
   local files = FilesForArch(arch)
   local cfg = ARCHITECTURES[arch]

   if not FLAGS.reuse_gcsuspects then
      GenerateGCSuspects(arch, files, cfg)
   end

   local processed_files = 0
   local errors_found = false
   local function SearchForErrors(filename, lines)
      processed_files = processed_files + 1
      for l in lines do
         errors_found = errors_found or
            l:match "^[^:]+:%d+:%d+:" or
            l:match "error" or
            l:match "warning"
         print(l)
      end
   end

   log("** Searching for evaluation order problems%s for %s",
       FLAGS.dead_vars and " and dead variables" or "",
       arch)
   local plugin_args
   if FLAGS.dead_vars then plugin_args = { "--dead-vars" } end
   InvokeClangPluginForEachFile(files,
                                cfg:extend { plugin = "find-problems",
                                             plugin_args = plugin_args },
                                SearchForErrors)
   log("** Done processing %d files. %s",
       processed_files,
       errors_found and "Errors found" or "No errors found")

   return errors_found
end

local function SafeCheckCorrectnessForArch(arch)
   local status, errors = pcall(CheckCorrectnessForArch, arch)
   if not status then
      print(string.format("There was an error: %s", errors))
      errors = true
   end
   return errors
end

local errors = false

for _, arch in ipairs(ARCHS) do
   if not ARCHITECTURES[arch] then
      error ("Unknown arch: " .. arch)
   end

   errors = SafeCheckCorrectnessForArch(arch, report) or errors
end

os.exit(errors and 1 or 0)
node-v4.8.2/deps/v8/tools/gcmole/Makefile000644 000766 000024 00000004245 13070706735 020323 0ustar00iojsstaff000000 000000 # Copyright 2011 the V8 project authors. All rights reserved.
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
#       notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
#       copyright notice, this list of conditions and the following
#       disclaimer in the documentation and/or other materials provided
#       with the distribution.
#     * Neither the name of Google Inc. nor the names of its
#       contributors may be used to endorse or promote products derived
#       from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

# This is Makefile for clang plugin part of gcmole tool. See README.

LLVM_INCLUDE:=$(LLVM_SRC_ROOT)/include
CLANG_INCLUDE:=$(LLVM_SRC_ROOT)/tools/clang/include

libgcmole.so: gcmole.cc
	$(CXX) -I$(LLVM_INCLUDE) -I$(CLANG_INCLUDE) -I. -D_DEBUG              \
	-D_GNU_SOURCE -D__STDC_CONSTANT_MACROS -D__STDC_FORMAT_MACROS         \
	-D__STDC_LIMIT_MACROS -O3 -fomit-frame-pointer -fno-exceptions        \
	-fno-rtti -fPIC -Woverloaded-virtual -Wcast-qual -fno-strict-aliasing \
	-pedantic -Wno-long-long -Wall -W -Wno-unused-parameter               \
	-Wwrite-strings -std=c++0x -shared -o libgcmole.so gcmole.cc

clean:
	$(RM) libgcmole.so
node-v4.8.2/deps/v8/tools/gcmole/parallel.py000755 000766 000024 00000002571 13070706735 021034 0ustar00iojsstaff000000 000000 #!/usr/bin/env python
# Copyright 2015 the V8 project authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

"""
This script calls the first argument for each of the following arguments in
parallel. E.g.
parallel.py "clang --opt" file1 file2
calls
clang --opt file1
clang --opt file2

The output (stdout and stderr) is concatenated sequentially in the form:
______________ file1

______________ finish  ______________
______________ file2

______________ finish  ______________
"""

import itertools
import multiprocessing
import subprocess
import sys

def invoke(cmdline):
  try:
    return (subprocess.check_output(
        cmdline, shell=True, stderr=subprocess.STDOUT), 0)
  except subprocess.CalledProcessError as e:
    return (e.output, e.returncode)

if __name__ == '__main__':
  assert len(sys.argv) > 2
  processes = multiprocessing.cpu_count()
  pool = multiprocessing.Pool(processes=processes)
  cmdlines = ["%s %s" % (sys.argv[1], filename) for filename in sys.argv[2:]]
  for filename, result in itertools.izip(
      sys.argv[2:], pool.imap(invoke, cmdlines)):
    print "______________ %s" % filename
    print result[0]
    print "______________ finish %d ______________" % result[1]
node-v4.8.2/deps/v8/tools/gcmole/README000644 000766 000024 00000004316 13070706735 017542 0ustar00iojsstaff000000 000000 DESCRIPTION -------------------------------------------------------------------

gcmole is a simple static analysis tool used to find possible evaluation order 
dependent GC-unsafe places in the V8 codebase.

For example the following code is GC-unsafe:

Handle Foo();  // Assume Foo can trigger a GC.
void Bar(Object*, Object*);

Handle baz;
baz->Qux(*Foo());  // (a)  
Bar(*Foo(), *baz);  // (b)

Both in cases (a) and (b) compiler is free to evaluate call arguments (that 
includes receiver) in any order. That means it can dereference baz before 
calling to Foo and save a raw pointer to a heap object in the register or 
on the stack.  

PREREQUISITES -----------------------------------------------------------------

1) Install Lua 5.1

2) Get LLVM 2.9 and Clang 2.9 sources and build them.

Follow the instructions on http://clang.llvm.org/get_started.html.

Make sure to pass --enable-optimized to configure to get Release build 
instead of a Debug one.

3) Build gcmole Clang plugin (libgcmole.so)

In the tools/gcmole execute the following command:

LLVM_SRC_ROOT= make

USING GCMOLE ------------------------------------------------------------------

gcmole consists of driver script written in Lua and Clang plugin that does
C++ AST processing. Plugin (libgcmole.so) is expected to be in the same
folder as driver (gcmole.lua).

To start analysis cd into the root of v8 checkout and execute the following
command:

CLANG_BIN= lua tools/gcmole/gcmole.lua []

where arch should be one of architectures supported by V8 (arm, ia32, x64).

Analysis will be performed in 2 stages: 

- on the first stage driver will parse all files and build a global callgraph 
approximation to find all functions that might potentially cause GC, list
of this functions will be written into gcsuspects file.

- on the second stage driver will parse all files again and will locate all 
callsites that might be GC-unsafe based on the list of functions causing GC. 
Such places are marked with a "Possible problem with evaluation order." 
warning. Messages "Failed to resolve v8::internal::Object" are benign and 
can be ignored.

If any errors were found driver exits with non-zero status.
node-v4.8.2/deps/v8/tools/blink_tests/TestExpectations000644 000766 000024 00000000260 13070706735 023160 0ustar00iojsstaff000000 000000 [ Linux ] virtual/pointerevent/fast/events/mouse-cursor-style-change-iframe.html [ Skip ]

# Turn off Slimming Paint tests on linux.
[ Linux ] virtual/slimmingpaint/ [ Skip ]

node-v4.8.2/deps/v8/testing/gmock-support.h000644 000766 000024 00000004501 13070706735 020710 0ustar00iojsstaff000000 000000 // Copyright 2014 the V8 project authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef V8_TESTING_GMOCK_SUPPORT_H_
#define V8_TESTING_GMOCK_SUPPORT_H_

#include 
#include 
#include 

#include "testing/gmock/include/gmock/gmock.h"

namespace testing {

template 
class Capture {
 public:
  Capture() : value_(), has_value_(false) {}

  const T& value() const { return value_; }
  bool has_value() const { return has_value_; }

  void SetValue(const T& value) {
    DCHECK(!has_value());
    value_ = value;
    has_value_ = true;
  }

 private:
  T value_;
  bool has_value_;
};


namespace internal {

template 
class CaptureEqMatcher : public MatcherInterface {
 public:
  explicit CaptureEqMatcher(Capture* capture) : capture_(capture) {}

  virtual void DescribeTo(std::ostream* os) const {
    *os << "captured by " << static_cast(capture_);
    if (capture_->has_value()) *os << " which has value " << capture_->value();
  }

  virtual bool MatchAndExplain(T value, MatchResultListener* listener) const {
    if (!capture_->has_value()) {
      capture_->SetValue(value);
      return true;
    }
    if (value != capture_->value()) {
      *listener << "which is not equal to " << capture_->value();
      return false;
    }
    return true;
  }

 private:
  Capture* capture_;
};

}  // namespace internal


// Creates a polymorphic matcher that matches anything whose bit representation
// is equal to that of {x}.
MATCHER_P(BitEq, x, std::string(negation ? "isn't" : "is") +
                        " bitwise equal to " + PrintToString(x)) {
  static_assert(sizeof(x) == sizeof(arg), "Size mismatch");
  return std::memcmp(&arg, &x, sizeof(x)) == 0;
}


// CaptureEq(capture) captures the value passed in during matching as long as it
// is unset, and once set, compares the value for equality with the argument.
template 
inline Matcher CaptureEq(Capture* capture) {
  return MakeMatcher(new internal::CaptureEqMatcher(capture));
}


// Creates a polymorphic matcher that matches any floating point NaN value.
MATCHER(IsNaN, std::string(negation ? "isn't" : "is") + " not a number") {
  return std::isnan(arg);
}

}  // namespace testing

#endif  // V8_TESTING_GMOCK_SUPPORT_H_
node-v4.8.2/deps/v8/testing/gmock.gyp000644 000766 000024 00000004106 13070706735 017547 0ustar00iojsstaff000000 000000 # Copyright 2014 the V8 project authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

{
  'targets': [
    {
      'target_name': 'gmock',
      'type': 'static_library',
      'dependencies': [
        'gtest.gyp:gtest',
      ],
      'sources': [
        # Sources based on files in r173 of gmock.
        'gmock/include/gmock/gmock-actions.h',
        'gmock/include/gmock/gmock-cardinalities.h',
        'gmock/include/gmock/gmock-generated-actions.h',
        'gmock/include/gmock/gmock-generated-function-mockers.h',
        'gmock/include/gmock/gmock-generated-matchers.h',
        'gmock/include/gmock/gmock-generated-nice-strict.h',
        'gmock/include/gmock/gmock-matchers.h',
        'gmock/include/gmock/gmock-spec-builders.h',
        'gmock/include/gmock/gmock.h',
        'gmock/include/gmock/internal/gmock-generated-internal-utils.h',
        'gmock/include/gmock/internal/gmock-internal-utils.h',
        'gmock/include/gmock/internal/gmock-port.h',
        'gmock/src/gmock-all.cc',
        'gmock/src/gmock-cardinalities.cc',
        'gmock/src/gmock-internal-utils.cc',
        'gmock/src/gmock-matchers.cc',
        'gmock/src/gmock-spec-builders.cc',
        'gmock/src/gmock.cc',
        'gmock-support.h',  # gMock helpers
      ],
      'sources!': [
        'gmock/src/gmock-all.cc',  # Not needed by our build.
      ],
      'include_dirs': [
        'gmock',
        'gmock/include',
      ],
      'direct_dependent_settings': {
        'include_dirs': [
          'gmock/include',  # So that gmock headers can find themselves.
        ],
      },
      'export_dependent_settings': [
        'gtest.gyp:gtest',
      ],
      'conditions': [
        ['want_separate_host_toolset==1', {
          'toolsets': ['host', 'target'],
        }, {
          'toolsets': ['target'],
        }],
      ],
    },
    {
      'target_name': 'gmock_main',
      'type': 'static_library',
      'dependencies': [
        'gmock',
      ],
      'sources': [
        'gmock/src/gmock_main.cc',
      ],
    },
  ],
}
node-v4.8.2/deps/v8/testing/gtest-support.h000644 000766 000024 00000004163 13070706735 020742 0ustar00iojsstaff000000 000000 // Copyright 2014 the V8 project authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef V8_TESTING_GTEST_SUPPORT_H_
#define V8_TESTING_GTEST_SUPPORT_H_

#include "testing/gtest/include/gtest/gtest.h"

namespace testing {
namespace internal {

#define GET_TYPE_NAME(type)                \
  template <>                              \
  inline std::string GetTypeName() { \
    return #type;                          \
  }
GET_TYPE_NAME(bool)
GET_TYPE_NAME(signed char)
GET_TYPE_NAME(unsigned char)
GET_TYPE_NAME(short)
GET_TYPE_NAME(unsigned short)
GET_TYPE_NAME(int)
GET_TYPE_NAME(unsigned int)
GET_TYPE_NAME(long)
GET_TYPE_NAME(unsigned long)
GET_TYPE_NAME(long long)
GET_TYPE_NAME(unsigned long long)
GET_TYPE_NAME(float)
GET_TYPE_NAME(double)
#undef GET_TYPE_NAME


// TRACED_FOREACH(type, var, container) expands to a loop that assigns |var|
// every item in the |container| and adds a SCOPED_TRACE() message for the
// |var| while inside the loop body.
#define TRACED_FOREACH(_type, _var, _container)                          \
  for (_type const _var : _container)                                    \
    for (bool _done = false; !_done;)                                    \
      for (SCOPED_TRACE(::testing::Message() << #_var << " = " << _var); \
           !_done; _done = true)


// TRACED_FORRANGE(type, var, low, high) expands to a loop that assigns |var|
// every value in the range |low| to (including) |high| and adds a
// SCOPED_TRACE() message for the |var| while inside the loop body.
// TODO(bmeurer): Migrate to C++11 once we're ready.
#define TRACED_FORRANGE(_type, _var, _low, _high)                          \
  for (_type _i = _low; _i <= _high; ++_i)                                 \
    for (bool _done = false; !_done;)                                      \
      for (_type const _var = _i; !_done;)                                 \
        for (SCOPED_TRACE(::testing::Message() << #_var << " = " << _var); \
             !_done; _done = true)

}  // namespace internal
}  // namespace testing

#endif  // V8_TESTING_GTEST_SUPPORT_H_
node-v4.8.2/deps/v8/testing/gtest.gyp000644 000766 000024 00000012354 13070706735 017601 0ustar00iojsstaff000000 000000 # Copyright 2014 the V8 project authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

{
  'targets': [
    {
      'target_name': 'gtest',
      'toolsets': ['host', 'target'],
      'type': 'static_library',
      'sources': [
        'gtest/include/gtest/gtest-death-test.h',
        'gtest/include/gtest/gtest-message.h',
        'gtest/include/gtest/gtest-param-test.h',
        'gtest/include/gtest/gtest-printers.h',
        'gtest/include/gtest/gtest-spi.h',
        'gtest/include/gtest/gtest-test-part.h',
        'gtest/include/gtest/gtest-typed-test.h',
        'gtest/include/gtest/gtest.h',
        'gtest/include/gtest/gtest_pred_impl.h',
        'gtest/include/gtest/internal/gtest-death-test-internal.h',
        'gtest/include/gtest/internal/gtest-filepath.h',
        'gtest/include/gtest/internal/gtest-internal.h',
        'gtest/include/gtest/internal/gtest-linked_ptr.h',
        'gtest/include/gtest/internal/gtest-param-util-generated.h',
        'gtest/include/gtest/internal/gtest-param-util.h',
        'gtest/include/gtest/internal/gtest-port.h',
        'gtest/include/gtest/internal/gtest-string.h',
        'gtest/include/gtest/internal/gtest-tuple.h',
        'gtest/include/gtest/internal/gtest-type-util.h',
        'gtest/src/gtest-all.cc',
        'gtest/src/gtest-death-test.cc',
        'gtest/src/gtest-filepath.cc',
        'gtest/src/gtest-internal-inl.h',
        'gtest/src/gtest-port.cc',
        'gtest/src/gtest-printers.cc',
        'gtest/src/gtest-test-part.cc',
        'gtest/src/gtest-typed-test.cc',
        'gtest/src/gtest.cc',
        'gtest-support.h',
      ],
      'sources!': [
        'gtest/src/gtest-all.cc',  # Not needed by our build.
      ],
      'include_dirs': [
        'gtest',
        'gtest/include',
      ],
      'dependencies': [
        'gtest_prod',
      ],
      'defines': [
        # In order to allow regex matches in gtest to be shared between Windows
        # and other systems, we tell gtest to always use it's internal engine.
        'GTEST_HAS_POSIX_RE=0',
        # Chrome doesn't support / require C++11, yet.
        'GTEST_LANG_CXX11=0',
      ],
      'all_dependent_settings': {
        'defines': [
          'GTEST_HAS_POSIX_RE=0',
          'GTEST_LANG_CXX11=0',
        ],
      },
      'conditions': [
        ['os_posix == 1', {
          'defines': [
            # gtest isn't able to figure out when RTTI is disabled for gcc
            # versions older than 4.3.2, and assumes it's enabled.  Our Mac
            # and Linux builds disable RTTI, and cannot guarantee that the
            # compiler will be 4.3.2. or newer.  The Mac, for example, uses
            # 4.2.1 as that is the latest available on that platform.  gtest
            # must be instructed that RTTI is disabled here, and for any
            # direct dependents that might include gtest headers.
            'GTEST_HAS_RTTI=0',
          ],
          'direct_dependent_settings': {
            'defines': [
              'GTEST_HAS_RTTI=0',
            ],
          },
        }],
        ['OS=="android"', {
          'defines': [
            'GTEST_HAS_CLONE=0',
          ],
          'direct_dependent_settings': {
            'defines': [
              'GTEST_HAS_CLONE=0',
            ],
          },
        }],
        ['OS=="android"', {
          # We want gtest features that use tr1::tuple, but we currently
          # don't support the variadic templates used by libstdc++'s
          # implementation. gtest supports this scenario by providing its
          # own implementation but we must opt in to it.
          'defines': [
            'GTEST_USE_OWN_TR1_TUPLE=1',
            # GTEST_USE_OWN_TR1_TUPLE only works if GTEST_HAS_TR1_TUPLE is set.
            # gtest r625 made it so that GTEST_HAS_TR1_TUPLE is set to 0
            # automatically on android, so it has to be set explicitly here.
            'GTEST_HAS_TR1_TUPLE=1',
          ],
          'direct_dependent_settings': {
            'defines': [
              'GTEST_USE_OWN_TR1_TUPLE=1',
              'GTEST_HAS_TR1_TUPLE=1',
            ],
          },
        }],
      ],
      'direct_dependent_settings': {
        'defines': [
          'UNIT_TEST',
        ],
        'include_dirs': [
          'gtest/include',  # So that gtest headers can find themselves.
        ],
        'target_conditions': [
          ['_type=="executable"', {
            'test': 1,
            'conditions': [
              ['OS=="mac"', {
                'run_as': {
                  'action????': ['${BUILT_PRODUCTS_DIR}/${PRODUCT_NAME}'],
                },
              }],
              ['OS=="win"', {
                'run_as': {
                  'action????': ['$(TargetPath)', '--gtest_print_time'],
                },
              }],
            ],
          }],
        ],
        'msvs_disabled_warnings': [4800],
      },
    },
    {
      'target_name': 'gtest_main',
      'type': 'static_library',
      'dependencies': [
        'gtest',
      ],
      'sources': [
        'gtest/src/gtest_main.cc',
      ],
    },
    {
      'target_name': 'gtest_prod',
      'toolsets': ['host', 'target'],
      'type': 'none',
      'sources': [
        'gtest/include/gtest/gtest_prod.h',
      ],
    },
  ],
}
node-v4.8.2/deps/v8/src/accessors.cc000644 000766 000024 00000137704 13070706732 017344 0ustar00iojsstaff000000 000000 // Copyright 2012 the V8 project authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "src/v8.h"

#include "src/accessors.h"
#include "src/api.h"
#include "src/contexts.h"
#include "src/deoptimizer.h"
#include "src/execution.h"
#include "src/factory.h"
#include "src/frames-inl.h"
#include "src/isolate.h"
#include "src/list-inl.h"
#include "src/messages.h"
#include "src/property-details.h"
#include "src/prototype.h"

namespace v8 {
namespace internal {


Handle Accessors::MakeAccessor(
    Isolate* isolate,
    Handle name,
    AccessorNameGetterCallback getter,
    AccessorNameSetterCallback setter,
    PropertyAttributes attributes) {
  Factory* factory = isolate->factory();
  Handle info = factory->NewExecutableAccessorInfo();
  info->set_property_attributes(attributes);
  info->set_all_can_read(false);
  info->set_all_can_write(false);
  info->set_is_special_data_property(true);
  info->set_name(*name);
  Handle get = v8::FromCData(isolate, getter);
  Handle set = v8::FromCData(isolate, setter);
  info->set_getter(*get);
  info->set_setter(*set);
  return info;
}


Handle Accessors::CloneAccessor(
    Isolate* isolate,
    Handle accessor) {
  Factory* factory = isolate->factory();
  Handle info = factory->NewExecutableAccessorInfo();
  info->set_name(accessor->name());
  info->set_flag(accessor->flag());
  info->set_expected_receiver_type(accessor->expected_receiver_type());
  info->set_getter(accessor->getter());
  info->set_setter(accessor->setter());
  info->set_data(accessor->data());
  return info;
}


static V8_INLINE bool CheckForName(Handle name,
                                   Handle property_name,
                                   int offset,
                                   int* object_offset) {
  if (Name::Equals(name, property_name)) {
    *object_offset = offset;
    return true;
  }
  return false;
}


// Returns true for properties that are accessors to object fields.
// If true, *object_offset contains offset of object field.
bool Accessors::IsJSObjectFieldAccessor(Handle map, Handle name,
                                        int* object_offset) {
  Isolate* isolate = name->GetIsolate();

  switch (map->instance_type()) {
    case JS_ARRAY_TYPE:
      return
        CheckForName(name, isolate->factory()->length_string(),
                     JSArray::kLengthOffset, object_offset);
    case JS_ARRAY_BUFFER_TYPE:
      return CheckForName(name, isolate->factory()->byte_length_string(),
                          JSArrayBuffer::kByteLengthOffset, object_offset);
    default:
      if (map->instance_type() < FIRST_NONSTRING_TYPE) {
        return CheckForName(name, isolate->factory()->length_string(),
                            String::kLengthOffset, object_offset);
      }

      return false;
  }
}


bool Accessors::IsJSArrayBufferViewFieldAccessor(Handle map,
                                                 Handle name,
                                                 int* object_offset) {
  Isolate* isolate = name->GetIsolate();

  switch (map->instance_type()) {
    case JS_TYPED_ARRAY_TYPE: {
      if (!CheckForName(name, isolate->factory()->length_string(),
                        JSTypedArray::kLengthOffset, object_offset) &&
          !CheckForName(name, isolate->factory()->byte_length_string(),
                        JSTypedArray::kByteLengthOffset, object_offset) &&
          !CheckForName(name, isolate->factory()->byte_offset_string(),
                        JSTypedArray::kByteOffsetOffset, object_offset)) {
        return false;
      }

      if (map->is_dictionary_map()) return false;

      // Check if the property is overridden on the instance.
      DescriptorArray* descriptors = map->instance_descriptors();
      int descriptor = descriptors->SearchWithCache(*name, *map);
      if (descriptor != DescriptorArray::kNotFound) return false;

      Handle proto = Handle(map->prototype(), isolate);
      if (!proto->IsJSReceiver()) return false;

      // Check if the property is defined in the prototype chain.
      LookupIterator it(proto, name);
      if (!it.IsFound()) return false;

      Object* original_proto =
          JSFunction::cast(map->GetConstructor())->prototype();

      // Property is not configurable. It is enough to verify that
      // the holder is the same.
      return *it.GetHolder() == original_proto;
    }
    case JS_DATA_VIEW_TYPE:
      return CheckForName(name, isolate->factory()->byte_length_string(),
                          JSDataView::kByteLengthOffset, object_offset) ||
             CheckForName(name, isolate->factory()->byte_offset_string(),
                          JSDataView::kByteOffsetOffset, object_offset);
    default:
      return false;
  }
}


//
// Accessors::ArgumentsIterator
//


void Accessors::ArgumentsIteratorGetter(
    v8::Local name, const v8::PropertyCallbackInfo& info) {
  i::Isolate* isolate = reinterpret_cast(info.GetIsolate());
  DisallowHeapAllocation no_allocation;
  HandleScope scope(isolate);
  Object* result = isolate->native_context()->array_values_iterator();
  info.GetReturnValue().Set(Utils::ToLocal(Handle(result, isolate)));
}


void Accessors::ArgumentsIteratorSetter(
    v8::Local name, v8::Local val,
    const v8::PropertyCallbackInfo& info) {
  i::Isolate* isolate = reinterpret_cast(info.GetIsolate());
  HandleScope scope(isolate);
  Handle object = Utils::OpenHandle(*info.This());
  Handle value = Utils::OpenHandle(*val);

  LookupIterator it(object, Utils::OpenHandle(*name));
  CHECK_EQ(LookupIterator::ACCESSOR, it.state());
  DCHECK(it.HolderIsReceiverOrHiddenPrototype());

  if (Object::SetDataProperty(&it, value).is_null()) {
    isolate->OptionalRescheduleException(false);
  }
}


Handle Accessors::ArgumentsIteratorInfo(
    Isolate* isolate, PropertyAttributes attributes) {
  Handle name = isolate->factory()->iterator_symbol();
  return MakeAccessor(isolate, name, &ArgumentsIteratorGetter,
                      &ArgumentsIteratorSetter, attributes);
}


//
// Accessors::ArrayLength
//


void Accessors::ArrayLengthGetter(
    v8::Local name,
    const v8::PropertyCallbackInfo& info) {
  i::Isolate* isolate = reinterpret_cast(info.GetIsolate());
  DisallowHeapAllocation no_allocation;
  HandleScope scope(isolate);
  JSArray* holder = JSArray::cast(*Utils::OpenHandle(*info.Holder()));
  Object* result = holder->length();
  info.GetReturnValue().Set(Utils::ToLocal(Handle(result, isolate)));
}


// Tries to non-observably convert |value| to a valid array length.
// Returns false if it fails.
static bool FastAsArrayLength(Isolate* isolate, Handle value,
                              uint32_t* length) {
  if (value->ToArrayLength(length)) return true;
  // We don't support AsArrayLength, so use AsArrayIndex for now. This just
  // misses out on kMaxUInt32.
  if (value->IsString()) return String::cast(*value)->AsArrayIndex(length);
  return false;
}


void Accessors::ArrayLengthSetter(
    v8::Local name,
    v8::Local val,
    const v8::PropertyCallbackInfo& info) {
  i::Isolate* isolate = reinterpret_cast(info.GetIsolate());
  HandleScope scope(isolate);

  Handle object = Utils::OpenHandle(*info.This());
  Handle array = Handle::cast(object);
  Handle length_obj = Utils::OpenHandle(*val);

  uint32_t length = 0;
  if (!FastAsArrayLength(isolate, length_obj, &length)) {
    Handle uint32_v;
    if (!Execution::ToUint32(isolate, length_obj).ToHandle(&uint32_v)) {
      isolate->OptionalRescheduleException(false);
      return;
    }

    Handle number_v;
    if (!Execution::ToNumber(isolate, length_obj).ToHandle(&number_v)) {
      isolate->OptionalRescheduleException(false);
      return;
    }

    if (uint32_v->Number() != number_v->Number()) {
      Handle exception = isolate->factory()->NewRangeError(
          MessageTemplate::kInvalidArrayLength);
      return isolate->ScheduleThrow(*exception);
    }

    CHECK(uint32_v->ToArrayLength(&length));
  }

  if (JSArray::ObservableSetLength(array, length).is_null()) {
    isolate->OptionalRescheduleException(false);
  }
}


Handle Accessors::ArrayLengthInfo(
      Isolate* isolate, PropertyAttributes attributes) {
  return MakeAccessor(isolate,
                      isolate->factory()->length_string(),
                      &ArrayLengthGetter,
                      &ArrayLengthSetter,
                      attributes);
}



//
// Accessors::StringLength
//

void Accessors::StringLengthGetter(
    v8::Local name,
    const v8::PropertyCallbackInfo& info) {
  i::Isolate* isolate = reinterpret_cast(info.GetIsolate());
  DisallowHeapAllocation no_allocation;
  HandleScope scope(isolate);

  // We have a slight impedance mismatch between the external API and the way we
  // use callbacks internally: Externally, callbacks can only be used with
  // v8::Object, but internally we have callbacks on entities which are higher
  // in the hierarchy, in this case for String values.

  Object* value = *Utils::OpenHandle(*v8::Local(info.This()));
  if (!value->IsString()) {
    // Not a string value. That means that we either got a String wrapper or
    // a Value with a String wrapper in its prototype chain.
    value = JSValue::cast(*Utils::OpenHandle(*info.Holder()))->value();
  }
  Object* result = Smi::FromInt(String::cast(value)->length());
  info.GetReturnValue().Set(Utils::ToLocal(Handle(result, isolate)));
}


void Accessors::StringLengthSetter(
    v8::Local name,
    v8::Local value,
    const v8::PropertyCallbackInfo& info) {
  UNREACHABLE();
}


Handle Accessors::StringLengthInfo(
      Isolate* isolate, PropertyAttributes attributes) {
  return MakeAccessor(isolate,
                      isolate->factory()->length_string(),
                      &StringLengthGetter,
                      &StringLengthSetter,
                      attributes);
}


//
// Accessors::ScriptColumnOffset
//


void Accessors::ScriptColumnOffsetGetter(
    v8::Local name,
    const v8::PropertyCallbackInfo& info) {
  i::Isolate* isolate = reinterpret_cast(info.GetIsolate());
  DisallowHeapAllocation no_allocation;
  HandleScope scope(isolate);
  Object* object = *Utils::OpenHandle(*info.This());
  Object* res = Script::cast(JSValue::cast(object)->value())->column_offset();
  info.GetReturnValue().Set(Utils::ToLocal(Handle(res, isolate)));
}


void Accessors::ScriptColumnOffsetSetter(
    v8::Local name,
    v8::Local value,
    const v8::PropertyCallbackInfo& info) {
  UNREACHABLE();
}


Handle Accessors::ScriptColumnOffsetInfo(
      Isolate* isolate, PropertyAttributes attributes) {
  Handle name(isolate->factory()->InternalizeOneByteString(
      STATIC_CHAR_VECTOR("column_offset")));
  return MakeAccessor(isolate,
                      name,
                      &ScriptColumnOffsetGetter,
                      &ScriptColumnOffsetSetter,
                      attributes);
}


//
// Accessors::ScriptId
//


void Accessors::ScriptIdGetter(
    v8::Local name,
    const v8::PropertyCallbackInfo& info) {
  i::Isolate* isolate = reinterpret_cast(info.GetIsolate());
  DisallowHeapAllocation no_allocation;
  HandleScope scope(isolate);
  Object* object = *Utils::OpenHandle(*info.This());
  Object* id = Script::cast(JSValue::cast(object)->value())->id();
  info.GetReturnValue().Set(Utils::ToLocal(Handle(id, isolate)));
}


void Accessors::ScriptIdSetter(
    v8::Local name,
    v8::Local value,
    const v8::PropertyCallbackInfo& info) {
  UNREACHABLE();
}


Handle Accessors::ScriptIdInfo(
      Isolate* isolate, PropertyAttributes attributes) {
  Handle name(
      isolate->factory()->InternalizeOneByteString(STATIC_CHAR_VECTOR("id")));
  return MakeAccessor(isolate,
                      name,
                      &ScriptIdGetter,
                      &ScriptIdSetter,
                      attributes);
}


//
// Accessors::ScriptName
//


void Accessors::ScriptNameGetter(
    v8::Local name,
    const v8::PropertyCallbackInfo& info) {
  i::Isolate* isolate = reinterpret_cast(info.GetIsolate());
  DisallowHeapAllocation no_allocation;
  HandleScope scope(isolate);
  Object* object = *Utils::OpenHandle(*info.This());
  Object* source = Script::cast(JSValue::cast(object)->value())->name();
  info.GetReturnValue().Set(Utils::ToLocal(Handle(source, isolate)));
}


void Accessors::ScriptNameSetter(
    v8::Local name,
    v8::Local value,
    const v8::PropertyCallbackInfo& info) {
  UNREACHABLE();
}


Handle Accessors::ScriptNameInfo(
      Isolate* isolate, PropertyAttributes attributes) {
  return MakeAccessor(isolate,
                      isolate->factory()->name_string(),
                      &ScriptNameGetter,
                      &ScriptNameSetter,
                      attributes);
}


//
// Accessors::ScriptSource
//


void Accessors::ScriptSourceGetter(
    v8::Local name,
    const v8::PropertyCallbackInfo& info) {
  i::Isolate* isolate = reinterpret_cast(info.GetIsolate());
  DisallowHeapAllocation no_allocation;
  HandleScope scope(isolate);
  Object* object = *Utils::OpenHandle(*info.This());
  Object* source = Script::cast(JSValue::cast(object)->value())->source();
  info.GetReturnValue().Set(Utils::ToLocal(Handle(source, isolate)));
}


void Accessors::ScriptSourceSetter(
    v8::Local name,
    v8::Local value,
    const v8::PropertyCallbackInfo& info) {
  UNREACHABLE();
}


Handle Accessors::ScriptSourceInfo(
      Isolate* isolate, PropertyAttributes attributes) {
  return MakeAccessor(isolate,
                      isolate->factory()->source_string(),
                      &ScriptSourceGetter,
                      &ScriptSourceSetter,
                      attributes);
}


//
// Accessors::ScriptLineOffset
//


void Accessors::ScriptLineOffsetGetter(
    v8::Local name,
    const v8::PropertyCallbackInfo& info) {
  i::Isolate* isolate = reinterpret_cast(info.GetIsolate());
  DisallowHeapAllocation no_allocation;
  HandleScope scope(isolate);
  Object* object = *Utils::OpenHandle(*info.This());
  Object* res = Script::cast(JSValue::cast(object)->value())->line_offset();
  info.GetReturnValue().Set(Utils::ToLocal(Handle(res, isolate)));
}


void Accessors::ScriptLineOffsetSetter(
    v8::Local name,
    v8::Local value,
    const v8::PropertyCallbackInfo& info) {
  UNREACHABLE();
}


Handle Accessors::ScriptLineOffsetInfo(
      Isolate* isolate, PropertyAttributes attributes) {
  Handle name(isolate->factory()->InternalizeOneByteString(
      STATIC_CHAR_VECTOR("line_offset")));
  return MakeAccessor(isolate,
                      name,
                      &ScriptLineOffsetGetter,
                      &ScriptLineOffsetSetter,
                      attributes);
}


//
// Accessors::ScriptType
//


void Accessors::ScriptTypeGetter(
    v8::Local name,
    const v8::PropertyCallbackInfo& info) {
  i::Isolate* isolate = reinterpret_cast(info.GetIsolate());
  DisallowHeapAllocation no_allocation;
  HandleScope scope(isolate);
  Object* object = *Utils::OpenHandle(*info.This());
  Object* res = Script::cast(JSValue::cast(object)->value())->type();
  info.GetReturnValue().Set(Utils::ToLocal(Handle(res, isolate)));
}


void Accessors::ScriptTypeSetter(
    v8::Local name,
    v8::Local value,
    const v8::PropertyCallbackInfo& info) {
  UNREACHABLE();
}


Handle Accessors::ScriptTypeInfo(
      Isolate* isolate, PropertyAttributes attributes) {
  Handle name(
      isolate->factory()->InternalizeOneByteString(STATIC_CHAR_VECTOR("type")));
  return MakeAccessor(isolate,
                      name,
                      &ScriptTypeGetter,
                      &ScriptTypeSetter,
                      attributes);
}


//
// Accessors::ScriptCompilationType
//


void Accessors::ScriptCompilationTypeGetter(
    v8::Local name,
    const v8::PropertyCallbackInfo& info) {
  i::Isolate* isolate = reinterpret_cast(info.GetIsolate());
  DisallowHeapAllocation no_allocation;
  HandleScope scope(isolate);
  Object* object = *Utils::OpenHandle(*info.This());
  Object* res = Smi::FromInt(
      Script::cast(JSValue::cast(object)->value())->compilation_type());
  info.GetReturnValue().Set(Utils::ToLocal(Handle(res, isolate)));
}


void Accessors::ScriptCompilationTypeSetter(
    v8::Local name,
    v8::Local value,
    const v8::PropertyCallbackInfo& info) {
  UNREACHABLE();
}


Handle Accessors::ScriptCompilationTypeInfo(
      Isolate* isolate, PropertyAttributes attributes) {
  Handle name(isolate->factory()->InternalizeOneByteString(
      STATIC_CHAR_VECTOR("compilation_type")));
  return MakeAccessor(isolate,
                      name,
                      &ScriptCompilationTypeGetter,
                      &ScriptCompilationTypeSetter,
                      attributes);
}


//
// Accessors::ScriptGetLineEnds
//


void Accessors::ScriptLineEndsGetter(
    v8::Local name,
    const v8::PropertyCallbackInfo& info) {
  i::Isolate* isolate = reinterpret_cast(info.GetIsolate());
  HandleScope scope(isolate);
  Handle object = Utils::OpenHandle(*info.This());
  Handle














  
V8 Benchmark Suite - version ?

  

Warning! This is not the latest version of the V8 benchmark
suite. Consider running the

latest version.
  

  

    

      
This page contains a suite of pure JavaScript benchmarks that we have
used to tune V8. The final score is computed as the geometric mean of
the individual results to make it independent of the running times of
the individual benchmarks and of a reference system (score
100). Scores are not comparable across benchmark suite versions and
higher scores means better performance: Bigger is better!


    

  • Richards
    OS kernel simulation benchmark, originally written in BCPL by Martin Richards (539 lines).
    • 

  • DeltaBlue
    One-way constraint solver, originally written in Smalltalk by John Maloney and Mario Wolczko (880 lines).
    • 

  • Crypto
    Encryption and decryption benchmark based on code by Tom Wu (1698 lines).
    • 

  • RayTrace
    Ray tracer benchmark based on code by Adam Burmister (904 lines).
    • 

  • EarleyBoyer
    Classic Scheme benchmarks, translated to JavaScript by Florian Loitsch's Scheme2Js compiler (4684 lines).
    • 

  • RegExp
    Regular expression benchmark generated by extracting regular expression operations from 50 of the most popular web pages
(1761 lines).

    • 

  • Splay
    Data manipulation benchmark that deals with splay trees and exercises the automatic memory management subsystem (394 lines).
    • 

  • NavierStokes
    Solves NavierStokes equations in 2D, heavily manipulating double precision arrays. Based on Oliver Hunt's code (387 lines).
    • 





Note that benchmark results are not comparable unless both results are
run with the same revision of the benchmark suite.  We will be making
revisions from time to time in order to fix bugs or expand the scope
of the benchmark suite.  For previous revisions and the change log see
the revisions page.






  
Starting...

  

  











node-v4.8.2/deps/v8/benchmarks/run.js000644 000766 000024 00000004340 13070706732 017525 0ustar00iojsstaff000000 000000 // Copyright 2008 the V8 project authors. All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
//       copyright notice, this list of conditions and the following
//       disclaimer in the documentation and/or other materials provided
//       with the distribution.
//     * Neither the name of Google Inc. nor the names of its
//       contributors may be used to endorse or promote products derived
//       from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


load('base.js');
load('richards.js');
load('deltablue.js');
load('crypto.js');
load('raytrace.js');
load('earley-boyer.js');
load('regexp.js');
load('splay.js');
load('navier-stokes.js');

var success = true;

function PrintResult(name, result) {
  print(name + ': ' + result);
}


function PrintError(name, error) {
  PrintResult(name, error);
  success = false;
}


function PrintScore(score) {
  if (success) {
    print('----');
    print('Score (version ' + BenchmarkSuite.version + '): ' + score);
  }
}


BenchmarkSuite.RunSuites({ NotifyResult: PrintResult,
                           NotifyError: PrintError,
                           NotifyScore: PrintScore });
node-v4.8.2/deps/v8/benchmarks/spinning-balls/000755 000766 000024 00000000000 13070706732 021302 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/v8/benchmarks/splay.js000644 000766 000024 00000024772 13070706732 020064 0ustar00iojsstaff000000 000000 // Copyright 2009 the V8 project authors. All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
//       copyright notice, this list of conditions and the following
//       disclaimer in the documentation and/or other materials provided
//       with the distribution.
//     * Neither the name of Google Inc. nor the names of its
//       contributors may be used to endorse or promote products derived
//       from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

// This benchmark is based on a JavaScript log processing module used
// by the V8 profiler to generate execution time profiles for runs of
// JavaScript applications, and it effectively measures how fast the
// JavaScript engine is at allocating nodes and reclaiming the memory
// used for old nodes. Because of the way splay trees work, the engine
// also has to deal with a lot of changes to the large tree object
// graph.

var Splay = new BenchmarkSuite('Splay', 81491, [
  new Benchmark("Splay", SplayRun, SplaySetup, SplayTearDown)
]);


// Configuration.
var kSplayTreeSize = 8000;
var kSplayTreeModifications = 80;
var kSplayTreePayloadDepth = 5;

var splayTree = null;


function GeneratePayloadTree(depth, tag) {
  if (depth == 0) {
    return {
      array  : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ],
      string : 'String for key ' + tag + ' in leaf node'
    };
  } else {
    return {
      left:  GeneratePayloadTree(depth - 1, tag),
      right: GeneratePayloadTree(depth - 1, tag)
    };
  }
}


function GenerateKey() {
  // The benchmark framework guarantees that Math.random is
  // deterministic; see base.js.
  return Math.random();
}


function InsertNewNode() {
  // Insert new node with a unique key.
  var key;
  do {
    key = GenerateKey();
  } while (splayTree.find(key) != null);
  var payload = GeneratePayloadTree(kSplayTreePayloadDepth, String(key));
  splayTree.insert(key, payload);
  return key;
}



function SplaySetup() {
  splayTree = new SplayTree();
  for (var i = 0; i < kSplayTreeSize; i++) InsertNewNode();
}


function SplayTearDown() {
  // Allow the garbage collector to reclaim the memory
  // used by the splay tree no matter how we exit the
  // tear down function.
  var keys = splayTree.exportKeys();
  splayTree = null;

  // Verify that the splay tree has the right size.
  var length = keys.length;
  if (length != kSplayTreeSize) {
    throw new Error("Splay tree has wrong size");
  }

  // Verify that the splay tree has sorted, unique keys.
  for (var i = 0; i < length - 1; i++) {
    if (keys[i] >= keys[i + 1]) {
      throw new Error("Splay tree not sorted");
    }
  }
}


function SplayRun() {
  // Replace a few nodes in the splay tree.
  for (var i = 0; i < kSplayTreeModifications; i++) {
    var key = InsertNewNode();
    var greatest = splayTree.findGreatestLessThan(key);
    if (greatest == null) splayTree.remove(key);
    else splayTree.remove(greatest.key);
  }
}


/**
 * Constructs a Splay tree.  A splay tree is a self-balancing binary
 * search tree with the additional property that recently accessed
 * elements are quick to access again. It performs basic operations
 * such as insertion, look-up and removal in O(log(n)) amortized time.
 *
 * @constructor
 */
function SplayTree() {
};


/**
 * Pointer to the root node of the tree.
 *
 * @type {SplayTree.Node}
 * @private
 */
SplayTree.prototype.root_ = null;


/**
 * @return {boolean} Whether the tree is empty.
 */
SplayTree.prototype.isEmpty = function() {
  return !this.root_;
};


/**
 * Inserts a node into the tree with the specified key and value if
 * the tree does not already contain a node with the specified key. If
 * the value is inserted, it becomes the root of the tree.
 *
 * @param {number} key Key to insert into the tree.
 * @param {*} value Value to insert into the tree.
 */
SplayTree.prototype.insert = function(key, value) {
  if (this.isEmpty()) {
    this.root_ = new SplayTree.Node(key, value);
    return;
  }
  // Splay on the key to move the last node on the search path for
  // the key to the root of the tree.
  this.splay_(key);
  if (this.root_.key == key) {
    return;
  }
  var node = new SplayTree.Node(key, value);
  if (key > this.root_.key) {
    node.left = this.root_;
    node.right = this.root_.right;
    this.root_.right = null;
  } else {
    node.right = this.root_;
    node.left = this.root_.left;
    this.root_.left = null;
  }
  this.root_ = node;
};


/**
 * Removes a node with the specified key from the tree if the tree
 * contains a node with this key. The removed node is returned. If the
 * key is not found, an exception is thrown.
 *
 * @param {number} key Key to find and remove from the tree.
 * @return {SplayTree.Node} The removed node.
 */
SplayTree.prototype.remove = function(key) {
  if (this.isEmpty()) {
    throw Error('Key not found: ' + key);
  }
  this.splay_(key);
  if (this.root_.key != key) {
    throw Error('Key not found: ' + key);
  }
  var removed = this.root_;
  if (!this.root_.left) {
    this.root_ = this.root_.right;
  } else {
    var right = this.root_.right;
    this.root_ = this.root_.left;
    // Splay to make sure that the new root has an empty right child.
    this.splay_(key);
    // Insert the original right child as the right child of the new
    // root.
    this.root_.right = right;
  }
  return removed;
};


/**
 * Returns the node having the specified key or null if the tree doesn't contain
 * a node with the specified key.
 *
 * @param {number} key Key to find in the tree.
 * @return {SplayTree.Node} Node having the specified key.
 */
SplayTree.prototype.find = function(key) {
  if (this.isEmpty()) {
    return null;
  }
  this.splay_(key);
  return this.root_.key == key ? this.root_ : null;
};


/**
 * @return {SplayTree.Node} Node having the maximum key value.
 */
SplayTree.prototype.findMax = function(opt_startNode) {
  if (this.isEmpty()) {
    return null;
  }
  var current = opt_startNode || this.root_;
  while (current.right) {
    current = current.right;
  }
  return current;
};


/**
 * @return {SplayTree.Node} Node having the maximum key value that
 *     is less than the specified key value.
 */
SplayTree.prototype.findGreatestLessThan = function(key) {
  if (this.isEmpty()) {
    return null;
  }
  // Splay on the key to move the node with the given key or the last
  // node on the search path to the top of the tree.
  this.splay_(key);
  // Now the result is either the root node or the greatest node in
  // the left subtree.
  if (this.root_.key < key) {
    return this.root_;
  } else if (this.root_.left) {
    return this.findMax(this.root_.left);
  } else {
    return null;
  }
};


/**
 * @return {Array<*>} An array containing all the keys of tree's nodes.
 */
SplayTree.prototype.exportKeys = function() {
  var result = [];
  if (!this.isEmpty()) {
    this.root_.traverse_(function(node) { result.push(node.key); });
  }
  return result;
};


/**
 * Perform the splay operation for the given key. Moves the node with
 * the given key to the top of the tree.  If no node has the given
 * key, the last node on the search path is moved to the top of the
 * tree. This is the simplified top-down splaying algorithm from:
 * "Self-adjusting Binary Search Trees" by Sleator and Tarjan
 *
 * @param {number} key Key to splay the tree on.
 * @private
 */
SplayTree.prototype.splay_ = function(key) {
  if (this.isEmpty()) {
    return;
  }
  // Create a dummy node.  The use of the dummy node is a bit
  // counter-intuitive: The right child of the dummy node will hold
  // the L tree of the algorithm.  The left child of the dummy node
  // will hold the R tree of the algorithm.  Using a dummy node, left
  // and right will always be nodes and we avoid special cases.
  var dummy, left, right;
  dummy = left = right = new SplayTree.Node(null, null);
  var current = this.root_;
  while (true) {
    if (key < current.key) {
      if (!current.left) {
        break;
      }
      if (key < current.left.key) {
        // Rotate right.
        var tmp = current.left;
        current.left = tmp.right;
        tmp.right = current;
        current = tmp;
        if (!current.left) {
          break;
        }
      }
      // Link right.
      right.left = current;
      right = current;
      current = current.left;
    } else if (key > current.key) {
      if (!current.right) {
        break;
      }
      if (key > current.right.key) {
        // Rotate left.
        var tmp = current.right;
        current.right = tmp.left;
        tmp.left = current;
        current = tmp;
        if (!current.right) {
          break;
        }
      }
      // Link left.
      left.right = current;
      left = current;
      current = current.right;
    } else {
      break;
    }
  }
  // Assemble.
  left.right = current.left;
  right.left = current.right;
  current.left = dummy.right;
  current.right = dummy.left;
  this.root_ = current;
};


/**
 * Constructs a Splay tree node.
 *
 * @param {number} key Key.
 * @param {*} value Value.
 */
SplayTree.Node = function(key, value) {
  this.key = key;
  this.value = value;
};


/**
 * @type {SplayTree.Node}
 */
SplayTree.Node.prototype.left = null;


/**
 * @type {SplayTree.Node}
 */
SplayTree.Node.prototype.right = null;


/**
 * Performs an ordered traversal of the subtree starting at
 * this SplayTree.Node.
 *
 * @param {function(SplayTree.Node)} f Visitor function.
 * @private
 */
SplayTree.Node.prototype.traverse_ = function(f) {
  var current = this;
  while (current) {
    var left = current.left;
    if (left) left.traverse_(f);
    f(current);
    current = current.right;
  }
};
node-v4.8.2/deps/v8/benchmarks/style.css000644 000766 000024 00000002217 13070706732 020236 0ustar00iojsstaff000000 000000 hr {
  border: 1px solid;
  border-color: #36C;
  margin: 1em 0;
}

h1, h2, h3, h4 {
  margin: 0;
  margin-bottom: 0;
}

h1 {
  font-size: 154%;
  height: 1.2em;
}


li {
  margin: .3em 0 1em 0;
}

body {
  font-family: Helvetica,Arial,sans-serif;
  color: #000;
  background-color: #fff;
}

div.title {
  background-color: rgb(229, 236, 249);
  border-top: 1px solid rgb(51, 102, 204);
  text-align: center;
  padding-top: 0.2em;
  padding-bottom: 0.2em;
  margin-bottom: 20px;
}

div.subtitle {
  border-bottom: 1px solid rgb(51, 102, 204);
  margin-top: 2em;
}

td.contents {
  text-align: left;
}

div.run {
  margin: 20px;
  width: 300px;
  height: 300px;
  float: right;
  background-color: rgb(229, 236, 249);
  background-image: url(v8-logo.png);
  background-position: center center;
  background-repeat: no-repeat;
  border: 1px solid rgb(51, 102, 204);
}

div.warning { 
  background: #ffffd9;
  border: 1px solid #d2d26a;
  display: none;
  margin: 1em 0 2em;
  padding: 8px;
  text-align: center; 
}

#status {
  text-align: center;
  margin-top: 50px;
  font-size: 120%;
  font-weight: bold;
}

#results {
  text-align: left;
  margin: 30px 0 0 90px;
}
node-v4.8.2/deps/v8/benchmarks/v8-logo.png000644 000766 000024 00000057345 13070706732 020401 0ustar00iojsstaff000000 000000 PNG


IHDR7vubKGD	pHYstIME	% IDATxvʮ,
f&;><]xiʖlIkYU2y?w-weYhYjfӸ0o4+C~Ӹ13圩i9Ӳ,d!czzĘe**m&Z?q?rΔRi(HKDMC,S$g]GZJ)/BZ1Q۶Q?y=D݌h1DMC3Q,WQ<7
TRS3d}q?{G3hQ֖ȝ"|x1j׶zƬizR{ާ#4u۽ a-g0K
>6{üѡmu]'
+iBm[97:C&-Xu3ƍQ3YG1<-9G91~֚Nu*O0x/tW+|#ӴRzF
~?pzbԶ-:G)r?g :'?Z:9c. c:E3MӐgJ9QtZ]y}{1FOڙCNJEii396nNb1 m8%%Y4C	@)Qʉi*i96rkURNPCgmL(VD3T~0H1/>?#Fvd*->3[mp0oKG
r֭BɐSWMБqT?ϪTji:HkRnR^'72,M}B,Cܓ3u]/?c[/u]/Nj@Q'
ia֚:H>DZ h\
NJc%ߡ.-sK]ׯZbq:׮Rˇl=Yr4lNۯmوQx~W>Xu5MHee&=m44"8}?>,!ZeXB˲ȁ)9Xk>X>1sy_-g2r"Z$%yCI׫S^ctQ]3gWז\Xxe8G#ZV_822BT[ǶUD4{ylۖ2\_ࡌmDiѵ1(Ad8$=&wÐ#i7|6xlLl(«ϳ|GÑk;2Uz{D9@FPӀCd#iqܽےmLNt][׾iEiVٗe_%h!j3%ߚ1cV6-&l%gY܋yYАA%ըm.8g^25t42\Tա7MC3ĠLba۩H瀺yE82!J2nlbMPp-o`=1,:@J	n1?~}Z>;0XD[HBqUHGl2_P^_b)BFQ݁U(%X^*y2Q;SـԙiV0%?β,DL~nY?ʸeyŨd#ߩWE1IDhғdH5:,h7m;}PYp4
y_"sCWXf[Ssuī\VvAmʎD[]t8e8Sks@v
SGp*CCA+3]wyR
)ǥ1Fa>ZCF?Lzk>lMSE`Qéh˓j2itؾx
#3JVj1
Ժv|vɎ4vӲ̤0|s׭I=:m]tc,֔"l4NAn9oWF]}wx#UΊ}Q:ե=>MЁZZ"t@60X#jТ%jpJʥEmHj"'ｈe,tD͇~XS%;P(
3#䐄/𼯊}!L!O)F5L̢=j/XRbs0h'iftHH+pHu3V&u{ܺ3Q5
RAe}
!dbTP#W:/|Q{NܳR,b&6#ϸԤ:ќo+x  H==W}+~U-PCԬmvFOX Z:eC:9M7䙦iȲYo0UV_y`BHh){$䞈3XNUPLs:Il@Þs
|ٸ(c
H_nZMurkFQ!,t8Rx+
ml9j[e#zZ
sw+
HeÈofPǞ.Y3[^¡>?}.\^\YJydlZczi"z}+f]e0\rf~y9xeR1._j3jq!eYr̺#Z*HRJeI}AJ-;(QVx$;l+raW#O0Aa*{޺t½)9*E9Q2薬eg%>H8Ji㤁:G}4X̧[SpMvgBU|sqCAȐ^)z0J9pTDD,tLZג%Nـ5V!""6QC)hQ:)Pd0~]F395)rpLz3a܀,{/#@χqdP!}&*臌Z+KjzI"غaPF	QN㒶/j.ubW:?ߗ{Nk:?ZĠ'~ϮUdX9qv!,Ŗ]m9G
Bi]sEZ\OFPYg{MVH:"J#֠jc$!1W|(,@Ÿϭ侲QO!D
?ce*R%gj0b8Y]30A~V0dQx^omi:hV%;,L7ƍ+f>ci,(4P;+m&Nz_06ܪm'BʨS[g8kl]孉+9
\{6'S,YS"j]*bR>r4÷p#z{&dڵ
@m
yɫts{Z	fW QE[f[V(,]W1PCz3&RsjVO󊏐cqkzyϜyﭰ1^nbf笗LF:=۸ݏHu^
6
|!8pڙvؑڃoZنA#t=xL5Y5O߿hfຖGO1/3ϋNbDua<䡍3~f:>T:OSiQϬ׶
P)N
~{M2g-Pl3}FZ6cC:㹺Sʧ7Li῜Vz)-j]uouM'δ;J/R/1`z5PsTq֑ϞˢI}
Y?_Xrg^\}TBAkc-TYk
[OVꍘߞRS7SGXs
HRHɀs`w1k\_{o*]|mܨKS$s+VRi:9L8X*,Rxo\P+ooC~-+"-yͲ,t8%j6emܗ8VQґEtQh%4B9zkfH#[&o
UZ,!W{>b7n-AҪzrZn\dE;kۧa|pE
!/ D\\F}Tci1CmFl, oxߵdžr*ep^s!"ԑ'"aW #@ٖ懱cZCzLmiBWҋdRaEOcp̘4]təjQ>˞ݚ%1ncp^2-8tjWƭm>( в%V"ڶVT?a-6W־%}+{@5|J<jyxj:vnJD+͞z
0
	+֒Q5Zq44){k%Zw;Y6$ oϬ8ֵzbV{_ZU۶L-2	Adt$YKD%
IO4iԷ-C)TDm˸<_}@.d2w6~[4
M$;N4z&㫓Zsv%!Nm!޷iJ_O3oyX<4RjEu)::ۣ5;|!JF!6xfCJ,Kjp(a)~lM6%|/.LC(%
.y"QͥMR^`%:{9ƝF0knpum~謧-Rj8[.e9 4O=_Z졡b,k`Ba^択=5a/K0Y6 j+ȩ{kt:©ck~r*7GsbZK)x;g^c4
QϞ Y2S+r|SLD$2="FEocE^,
2,hxv`=GI|]Owgc|306U[QNƭaogwь#sr@6wYSI/,g{{d@A'n.·VgSHH=(۶=Xnj,o"pyyg(c(_^HtH`VLRnQCEɉFm^ݍi:q|y4;1=mXk,^^)E+87S͆HYK)Ѹ{yXᰧ%,B+xOgHks!bEIؓXrY4i#rЃlYrzqAiڎBG=ySD1G2)6Eﵹtu\YG!QyT8qw>bwHTM#9
BWӸ =Ƒbt8"*hmж	,jyiG}w_cm/tzsH4M4vΜќˈ3w֭HZ2깦jǣ]*Xt	F6.9瑎D=?ς)ȖWD~4pHkx*B.-B[T֣?<]C~@M7<4|iCr0:.S06JDrpVἙS-A6'*=!#}^a?0C;R\G9Q{~R[ɷDzia0N`ə
R4}h.	"ڶ4M9P)F
]tK"	y!j^`cж4s1ݎ"{,eبE[?l4eF/՜{Vm{_g98ޤ+Y]DzrL
HC?Y~^[C2n!(Vh1Tz}]ɐ:䘈x=/}_+k-hU(oDκx%{~.X,Lc(.QZJ]T--"fU8aY@Sgh(>@\DmbQ-=ύ5xE-!]ĵ4sxEQ$ԇ8z0EF*]{/i1AF3xACo[6ڜ`'p@SJ+[(Ot֪(m1nV1f`Vy
$*T;
SeC*=.">]yPg]4ǭ$
zN9ruG8E;ſpkRo]![g3f.H\EXi9Qu]O-JH{awzė^XCdǵ-um!,)ukEk{1t8%u3OLAgYK)Bպ·57iVE!0YGs:	15p*9eY$~Jx0^?+A™0=V9$JXVgmj[/]qrVl/!$}%	!3"fM9#}4l-7Zp?zYc(AxԐW8SrFcƍ{i9jFk0hQMZ4P}nm
(mB(xWvL;6F]Xq-u궢oq[݌~A\6JMܛYyYZө8Pݤ+.0Fiݼ귞A#-=O.dE9:6a4"bzpC;傑4lzkf۶'yߵ6ȍ?LA5ѿNlm-zJUr?%j--2>{55es~Op1CrδMHʨav>{m`پ{^L^<82#<}S^T\
i2ǎB=YjLt7!FHl^^HrMC2g.@C+ӚR3.uvԧH\vsmg[8K+pO]IFݰX7}T'"K8bd5{sfZ\qB?G 04:զC)^ъ8ϫR";Sĕ&[YtGc1r^A$:aUG.g!ܗ^:xFH,fv/40mT߹~Ns$"-tT՚`A߈#3=Ը[׾Iemp!}ʞ 194Xo"dKhVAњ]jڞ܉m7ҕM=9^Ͳ\[آLj"rgtnۖ)%|X|~`f5bE=96#VXW,RoiY_cO@JqQc[72h5,x[|/tPmXmmt~A(aZ[-y5l4ʮ9zy#PkG
MtfzUn9[=
c}OڣW泇	But
S=i 	1|tzk!A<$(B}H74\N!cت-#5Ptvd|ȭŢ~֥&m}uqiV41u
;/!mW=a- ^mwv8^7^,MC݋(\rjj9*uxf~9SB,w]9dV lY>03@z[]*1nG"P^P`"-(3mZK	R8JqMON)\ӱ]yu@^;x/ulʉLBKypmϔR/Ē̏8F8`@ɒ̈́g\5~Mu)?4d(6]>^Zl]l[-"62܆a\aHɵ^`"b	j6ure5neE C`RRLP<+"0VZ}뛟Oz:$=CJj,#[J;,
0We룵)hl,|(WҸ۝mXZ_Z+Q1fࢨ(ip][Q10OS)
M'|"akcΙeiuQHH'k~
OTXYJtBv]l־[j~Oy@5>κȿSc卐bX%[tLc(7Y9,]۰u/8gZHӸ)89*\u]Mo-EgPMWhYrLA2٩c_"uR,ђm^ҟY>[Z=d
b__D)c:Z8ԛ?!\daNm˸vSP* h]Lm8`=u R4:qы]3`	6Z^Jծi˭&_ȨMȊ%osN桡v/oWH+A
zə|b}9Ui&hY=
C_)tYQe`)c7?殽-&汵aj@*5n➴DQk^c[jAJmBA~%2;Բxl!@(J4Qc]׋kVmy7Vy$G;'•[^ʣզpsD?Űᐵ{>ȭjC,{ɡִT-oh#TZnnXqfVy QvuMi``ާgy4#zV9<
*eRdM0o,PPIE$vz;.-Zq'ŔEIqz:=1l5xBJ|AO!i%?ϲYD3Rgueo?#+hޞܰkL%U
Pk%7ja\iA,`gs5w_&uuԾlTэVS,X.r-R\{P6e,;z)*T(	uoJsu%
#+aԇKd͎=W(z;Skֿ(HƦt|TND7e5joX)Qv}>}ڻ/
+
1<d%gJes}gM!OAj+)+sRwN!dZJKµ.@36fU%+b na]≺6>Q~`əP`I+Dْ*H-~vqky=ضEި1t}/ת)vיQI%xUKh@PtXoxDƳi>>dͭJ](FiQϼW,:$91u蒳a
XiEOѢ떵gB4MD4ޣvÊ-F6hYH5-L໣{N`90
P#*fx=m6TDd--~Y/2"pՈ-R)8-<
R^ڲs·k?lR!`?)Hs3ZP(J-gK;i[p*tưΆm@+&
0R€^S\QSzc4g0BZ0bxeBY,Ĕ=u}U2;h*j-2(cx-L
g=9%"Ln7MgreGrb&iw>D`X:0qf׶2Z}L1+t	W=eg?baK)|DVՋ%a%oZE犭"T&wZEO0oax(q|7C``ean{yh:-Gi0hX=Ycep}p=T(e
pRk+4R,Rb!H*1غUG,rn	\@o
]EWZ_3
	nBgE@0Oqɦv\3]_e\SM
-XcтINzina-'kWS[FwXu}/8luE9U]NMpTa;z??
s-@b\6Y΅{:z5wF]2rĕd/iO,=J2#Յh
2d/:OY]9%zv]u]g_Mia,ԶtyVf5f[+֞RuU½um{;0jH> )g'.Z$z;CpAeӒ]:ɋ7yZ9S|aVحս[Zw{hw佧U2ֵRw䥇_6np
Î1Z#9NŦe=Xv,!Ib׿+ySaQ42#{ (RI!d\Ddr6KΑ_<1v]i3B2l47VJ
-{A\ozCf6l4_\Co322 AEeYȶ\Ni/}!aI=oؔF}Z<@4I]2T/H8вضV#eM)QZ٨L9/}Lׁ!LCqXcyvвqNqHt'D;A&@ѓ,|(uqj9X#fC{#]"h"l?btM1JaF3ʋaړG4R5
f6&G;x@4Z+%7lH"UbRB~/T׊زKQW%"ѯI5IL3!TԢDK<`=HҨés4SڑuY\Ga捲%jԮd7~NXGNe
[Wrsj
Bsu5³gZwBN=iG@ozj& -5r/FhIM<,['h`A.=+b,$,u[r.-uhӔAm}ݨIsjsqf_/ɤ^/NUϜӺ(e;o	5_TF-["S[W*nj܈"j9r$ )3{ju8Zl(b6pBMŶ	adH636wH5-t\Hq/j9LQs{{2G{Iޣa?mW1SgjAџ}HIaLj(K8'ZN
g]>ԇ;_h*Kh{s֭3FiqTlZySYki@:!W`QXMA:j࣡F"~]שG-YOE%_/B_9բ+F!Pݸ۽ƁT[Q3pDikm@U~9xC5΢>z6B^{ԀO -"~ZpՌ۽obܦ:rK>9G%ޣE#0H	u;4SNe)O
Qsr:9_^`Ȃ#3u߬]v=vы.ś^9P޼x"0Eӈ<k9k;׏kfw4"IZ\zIjúc~9*}+*6L)q=ƠEc=^νKD溞M4|?U_'-۠! gPw#]SٿԿq
)EyC?;cVq+9$B\?x]fD6@]8cpvO@Ԫ6ny^q!sC:&4V*xGn+
jƭJ'HE1y;ѳՑPω/_+yڎ:~.iq\
4fQtF[+i%5kU^䥾Ѹ5[0#Tgs&W!c@۽иP|' bQ hXC-kbL
;'ˌ)b֕_d0"Doi/{Κ-WA޶ SO/oK4F
n?4qG?BJU^1Ԧ0g~nagYxLSDć!2NVZ2^1eQ=d-ty
;WIi伴"t)%*k3CXL~qkhjWZHo
k~X0;׳ ϕV!%BYӜmdsHkkVyF::yLa%$Ҹ[x!ecR~qiK1R^"̒5zVFMcO}:H>m
^6e1c9k`*WgEb.ۨ5\mٙ(+/}ܽПqIn|zz
ZɊ%$&X4M _-8CXy-GBߠޡq^;(0nɌ6P\5{;BGg91d{+GD+aȮ~-
-MTV@1y/R{\TtvQ|Q`6-y,>01q%Q`WO<bwxڕ?phD<[8Rp21mTZcE8/yѸޚٌ@Yv{c
/hs5
g>>LL㸻@fh;jmp^xkH05t+){g۶{Usˋ6k8s4*
{!XS"9ZgIG㽁rkZlP,TޔΜ3ֶ2EFq
`ع2ltsGv5O>X\x7ܖ
Y<I;Š-Bn%v4ʯ
a bQqRd}j]H$un~NlVuEk-Zp8ⱴbCI	)QsyT;D8JSGs5y2Q_ڮC?aձkdQWB
z*[DDmy)YSD5u/`h]%?D^&r@7^\s֊XӲ=8pE9G݋w~l<"	9g~5.NDqji6}F闫kFE 34RYidܚP	ѴIJ
YU{ZEcj,؂?J(|=3֖}0>nN5m1y$μY'N6
\Z:'N#>kRA]eUE%`]S?
IyH{ҧ_j6NGKDeNQ>TVryL@[D1/Y5! c0D*7P-)$Do"9h&桯qa%!rN^i:wx?˖q_\뇡Om1MkOE
Flێ :&"~\z7-u%+L4FjRpjWh)`"E}MtFy3Lʹ>7mR5XM}e\-#~^m4PD#'T!HROa7ӢGLQ#;@$(jӴZz3QC
=n>[kdXԂH1QF}Q{_2R{N\ڮQ0U-DsHc:j^O)MGSDklAvnjDVV9Ca .nXp-V>o4n=ޠ;Oӗܚz2e2q]s[RT@w\`눧	[kz/׊41Ei&q 2	IS1mF{0{S!gBjw} DI"n!{J qH"$lsY3($iEldSrk_Z}}+=7ZA4út;Ц{/8$kŸ5cWk]?U@].%3cPkGz
!3,_R\&dy҉
v8&sqm[72Q3j0{\;b<2,)5&adӰqy盝oe8d=BYVƬ	-"}Y@:'ŸDĀp6Ȇ-{Vw9bsqyj#7]`	sAZ(X(R~/,1GAlxSiC4(Xu2b\ᰗ{51Pg&pQJᵳmsJ^oclZ`Ւ={^O>
0
E@\$up^ox|ƘҼ1< gᤧTR¹ˆ/]_<_"B&	yX;v>\%sޫP({BQa|G2ea*pb[?fq|(MZwW'g1~P`Q-nKrb2jϡgve{x^O>y2-4vD1kxс6"]Q.[kEGѿ.QJIXڶ{3YddFPYW?WS@!
eYp˟##FIy;bXDG"Mӡ|vc[{)%gWYYCѰ[0"g
4yu&ʼ"A
iқ4S2׆du:uI1R^2s"XTgvRpQsj)aO~XKSFi7=X냗nL%"b˶Gp ʏycZ"9(pV+r?m]RCYGkCtaqIky=.Cp֎BOmip

  


  
  


node-v4.8.2/deps/v8/benchmarks/spinning-balls/splay-tree.js000644 000766 000024 00000021303 13070706732 023724 0ustar00iojsstaff000000 000000 // Copyright 2011 the V8 project authors. All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
//       copyright notice, this list of conditions and the following
//       disclaimer in the documentation and/or other materials provided
//       with the distribution.
//     * Neither the name of Google Inc. nor the names of its
//       contributors may be used to endorse or promote products derived
//       from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

/**
 * Constructs a Splay tree.  A splay tree is a self-balancing binary
 * search tree with the additional property that recently accessed
 * elements are quick to access again. It performs basic operations
 * such as insertion, look-up and removal in O(log(n)) amortized time.
 *
 * @constructor
 */
function SplayTree() {
};


/**
 * Pointer to the root node of the tree.
 *
 * @type {SplayTree.Node}
 * @private
 */
SplayTree.prototype.root_ = null;


/**
 * @return {boolean} Whether the tree is empty.
 */
SplayTree.prototype.isEmpty = function() {
  return !this.root_;
};


/**
 * Inserts a node into the tree with the specified key and value if
 * the tree does not already contain a node with the specified key. If
 * the value is inserted, it becomes the root of the tree.
 *
 * @param {number} key Key to insert into the tree.
 * @param {*} value Value to insert into the tree.
 */
SplayTree.prototype.insert = function(key, value) {
  if (this.isEmpty()) {
    this.root_ = new SplayTree.Node(key, value);
    return;
  }
  // Splay on the key to move the last node on the search path for
  // the key to the root of the tree.
  this.splay_(key);
  if (this.root_.key == key) {
    return;
  }
  var node = new SplayTree.Node(key, value);
  if (key > this.root_.key) {
    node.left = this.root_;
    node.right = this.root_.right;
    this.root_.right = null;
  } else {
    node.right = this.root_;
    node.left = this.root_.left;
    this.root_.left = null;
  }
  this.root_ = node;
};


/**
 * Removes a node with the specified key from the tree if the tree
 * contains a node with this key. The removed node is returned. If the
 * key is not found, an exception is thrown.
 *
 * @param {number} key Key to find and remove from the tree.
 * @return {SplayTree.Node} The removed node.
 */
SplayTree.prototype.remove = function(key) {
  if (this.isEmpty()) {
    throw Error('Key not found: ' + key);
  }
  this.splay_(key);
  if (this.root_.key != key) {
    throw Error('Key not found: ' + key);
  }
  var removed = this.root_;
  if (!this.root_.left) {
    this.root_ = this.root_.right;
  } else {
    var right = this.root_.right;
    this.root_ = this.root_.left;
    // Splay to make sure that the new root has an empty right child.
    this.splay_(key);
    // Insert the original right child as the right child of the new
    // root.
    this.root_.right = right;
  }
  return removed;
};


/**
 * Returns the node having the specified key or null if the tree doesn't contain
 * a node with the specified key.
 *
 * @param {number} key Key to find in the tree.
 * @return {SplayTree.Node} Node having the specified key.
 */
SplayTree.prototype.find = function(key) {
  if (this.isEmpty()) {
    return null;
  }
  this.splay_(key);
  return this.root_.key == key ? this.root_ : null;
};


/**
 * @return {SplayTree.Node} Node having the maximum key value.
 */
SplayTree.prototype.findMax = function(opt_startNode) {
  if (this.isEmpty()) {
    return null;
  }
  var current = opt_startNode || this.root_;
  while (current.right) {
    current = current.right;
  }
  return current;
};


/**
 * @return {SplayTree.Node} Node having the maximum key value that
 *     is less than the specified key value.
 */
SplayTree.prototype.findGreatestLessThan = function(key) {
  if (this.isEmpty()) {
    return null;
  }
  // Splay on the key to move the node with the given key or the last
  // node on the search path to the top of the tree.
  this.splay_(key);
  // Now the result is either the root node or the greatest node in
  // the left subtree.
  if (this.root_.key < key) {
    return this.root_;
  } else if (this.root_.left) {
    return this.findMax(this.root_.left);
  } else {
    return null;
  }
};


/**
 * @return {Array<*>} An array containing all the keys of tree's nodes.
 */
SplayTree.prototype.exportKeys = function() {
  var result = [];
  if (!this.isEmpty()) {
    this.root_.traverse_(function(node) { result.push(node.key); });
  }
  return result;
};


/**
 * Perform the splay operation for the given key. Moves the node with
 * the given key to the top of the tree.  If no node has the given
 * key, the last node on the search path is moved to the top of the
 * tree. This is the simplified top-down splaying algorithm from:
 * "Self-adjusting Binary Search Trees" by Sleator and Tarjan
 *
 * @param {number} key Key to splay the tree on.
 * @private
 */
SplayTree.prototype.splay_ = function(key) {
  if (this.isEmpty()) {
    return;
  }
  // Create a dummy node.  The use of the dummy node is a bit
  // counter-intuitive: The right child of the dummy node will hold
  // the L tree of the algorithm.  The left child of the dummy node
  // will hold the R tree of the algorithm.  Using a dummy node, left
  // and right will always be nodes and we avoid special cases.
  var dummy, left, right;
  dummy = left = right = new SplayTree.Node(null, null);
  var current = this.root_;
  while (true) {
    if (key < current.key) {
      if (!current.left) {
        break;
      }
      if (key < current.left.key) {
        // Rotate right.
        var tmp = current.left;
        current.left = tmp.right;
        tmp.right = current;
        current = tmp;
        if (!current.left) {
          break;
        }
      }
      // Link right.
      right.left = current;
      right = current;
      current = current.left;
    } else if (key > current.key) {
      if (!current.right) {
        break;
      }
      if (key > current.right.key) {
        // Rotate left.
        var tmp = current.right;
        current.right = tmp.left;
        tmp.left = current;
        current = tmp;
        if (!current.right) {
          break;
        }
      }
      // Link left.
      left.right = current;
      left = current;
      current = current.right;
    } else {
      break;
    }
  }
  // Assemble.
  left.right = current.left;
  right.left = current.right;
  current.left = dummy.right;
  current.right = dummy.left;
  this.root_ = current;
};


/**
 * Constructs a Splay tree node.
 *
 * @param {number} key Key.
 * @param {*} value Value.
 */
SplayTree.Node = function(key, value) {
  this.key = key;
  this.value = value;
};


/**
 * @type {SplayTree.Node}
 */
SplayTree.Node.prototype.left = null;


/**
 * @type {SplayTree.Node}
 */
SplayTree.Node.prototype.right = null;


/**
 * Performs an ordered traversal of the subtree starting at
 * this SplayTree.Node.
 *
 * @param {function(SplayTree.Node)} f Visitor function.
 * @private
 */
SplayTree.Node.prototype.traverse_ = function(f) {
  var current = this;
  while (current) {
    var left = current.left;
    if (left) left.traverse_(f);
    f(current);
    current = current.right;
  }
};

SplayTree.prototype.traverseBreadthFirst = function (f) {
  if (f(this.root_.value)) return;

  var stack = [this.root_];
  var length = 1;

  while (length > 0) {
    var new_stack = new Array(stack.length * 2);
    var new_length = 0;
    for (var i = 0; i < length; i++) {
      var n = stack[i];
      var l = n.left;
      var r = n.right;
      if (l) {
        if (f(l.value)) return;
        new_stack[new_length++] = l;
      }
      if (r) {
        if (f(r.value)) return;
        new_stack[new_length++] = r;
      }
    }
    stack = new_stack;
    length = new_length;
  }
};
node-v4.8.2/deps/v8/benchmarks/spinning-balls/v.js000644 000766 000024 00000031151 13070706732 022106 0ustar00iojsstaff000000 000000 // Copyright 2011 the V8 project authors. All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
//       copyright notice, this list of conditions and the following
//       disclaimer in the documentation and/or other materials provided
//       with the distribution.
//     * Neither the name of Google Inc. nor the names of its
//       contributors may be used to endorse or promote products derived
//       from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


/**
 * This function provides requestAnimationFrame in a cross browser way.
 * http://paulirish.com/2011/requestanimationframe-for-smart-animating/
 */
if ( !window.requestAnimationFrame ) {
  window.requestAnimationFrame = ( function() {
    return window.webkitRequestAnimationFrame ||
        window.mozRequestAnimationFrame ||
        window.oRequestAnimationFrame ||
        window.msRequestAnimationFrame ||
        function(callback, element) {
          window.setTimeout( callback, 1000 / 60 );
        };
  } )();
}

var kNPoints = 8000;
var kNModifications = 20;
var kNVisiblePoints = 200;
var kDecaySpeed = 20;

var kPointRadius = 4;
var kInitialLifeForce = 100;

var livePoints = void 0;
var dyingPoints = void 0;
var scene = void 0;
var renderingStartTime = void 0;
var scene = void 0;
var pausePlot = void 0;
var splayTree = void 0;
var numberOfFrames = 0;
var sumOfSquaredPauses = 0;
var benchmarkStartTime = void 0;
var benchmarkTimeLimit = void 0;
var autoScale = void 0;
var pauseDistribution = [];


function Point(x, y, z, payload) {
  this.x = x;
  this.y = y;
  this.z = z;

  this.next = null;
  this.prev = null;
  this.payload = payload;
  this.lifeForce = kInitialLifeForce;
}


Point.prototype.color = function () {
  return "rgba(0, 0, 0, " + (this.lifeForce / kInitialLifeForce) + ")";
};


Point.prototype.decay = function () {
  this.lifeForce -= kDecaySpeed;
  return this.lifeForce <= 0;
};


function PointsList() {
  this.head = null;
  this.count = 0;
}


PointsList.prototype.add = function (point) {
  if (this.head !== null) this.head.prev = point;
  point.next = this.head;
  this.head = point;
  this.count++;
}


PointsList.prototype.remove = function (point) {
  if (point.next !== null) {
    point.next.prev = point.prev;
  }
  if (point.prev !== null) {
    point.prev.next = point.next;
  } else {
    this.head = point.next;
  }
  this.count--;
}


function GeneratePayloadTree(depth, tag) {
  if (depth == 0) {
    return {
      array  : [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ],
      string : 'String for key ' + tag + ' in leaf node'
    };
  } else {
    return {
      left:  GeneratePayloadTree(depth - 1, tag),
      right: GeneratePayloadTree(depth - 1, tag)
    };
  }
}


// To make the benchmark results predictable, we replace Math.random
// with a 100% deterministic alternative.
Math.random = (function() {
  var seed = 49734321;
  return function() {
    // Robert Jenkins' 32 bit integer hash function.
    seed = ((seed + 0x7ed55d16) + (seed << 12))  & 0xffffffff;
    seed = ((seed ^ 0xc761c23c) ^ (seed >>> 19)) & 0xffffffff;
    seed = ((seed + 0x165667b1) + (seed << 5))   & 0xffffffff;
    seed = ((seed + 0xd3a2646c) ^ (seed << 9))   & 0xffffffff;
    seed = ((seed + 0xfd7046c5) + (seed << 3))   & 0xffffffff;
    seed = ((seed ^ 0xb55a4f09) ^ (seed >>> 16)) & 0xffffffff;
    return (seed & 0xfffffff) / 0x10000000;
  };
})();


function GenerateKey() {
  // The benchmark framework guarantees that Math.random is
  // deterministic; see base.js.
  return Math.random();
}

function CreateNewPoint() {
  // Insert new node with a unique key.
  var key;
  do { key = GenerateKey(); } while (splayTree.find(key) != null);

  var point = new Point(Math.random() * 40 - 20,
                        Math.random() * 40 - 20,
                        Math.random() * 40 - 20,
                        GeneratePayloadTree(5, "" + key));

  livePoints.add(point);

  splayTree.insert(key, point);
  return key;
}

function ModifyPointsSet() {
  if (livePoints.count < kNPoints) {
    for (var i = 0; i < kNModifications; i++) {
      CreateNewPoint();
    }
  } else if (kNModifications === 20) {
    kNModifications = 80;
    kDecay = 30;
  }

  for (var i = 0; i < kNModifications; i++) {
    var key = CreateNewPoint();
    var greatest = splayTree.findGreatestLessThan(key);
    if (greatest == null) {
      var point = splayTree.remove(key).value;
    } else {
      var point = splayTree.remove(greatest.key).value;
    }
    livePoints.remove(point);
    point.payload = null;
    dyingPoints.add(point);
  }
}


function PausePlot(width, height, size, scale) {
  var canvas = document.createElement("canvas");
  canvas.width = this.width = width;
  canvas.height = this.height = height;
  document.body.appendChild(canvas);

  this.ctx = canvas.getContext('2d');

  if (typeof scale !== "number") {
    this.autoScale = true;
    this.maxPause = 0;
  } else {
    this.autoScale = false;
    this.maxPause = scale;
  }

  this.size = size;

  // Initialize cyclic buffer for pauses.
  this.pauses = new Array(this.size);
  this.start = this.size;
  this.idx = 0;
}


PausePlot.prototype.addPause = function (p) {
  if (this.idx === this.size) {
    this.idx = 0;
  }

  if (this.idx === this.start) {
    this.start++;
  }

  if (this.start === this.size) {
    this.start = 0;
  }

  this.pauses[this.idx++] = p;
};


PausePlot.prototype.iteratePauses = function (f) {
  if (this.start < this.idx) {
    for (var i = this.start; i < this.idx; i++) {
      f.call(this, i - this.start, this.pauses[i]);
    }
  } else {
    for (var i = this.start; i < this.size; i++) {
      f.call(this, i - this.start, this.pauses[i]);
    }

    var offs = this.size - this.start;
    for (var i = 0; i < this.idx; i++) {
      f.call(this, i + offs, this.pauses[i]);
    }
  }
};


PausePlot.prototype.draw = function () {
  var first = null;

  if (this.autoScale) {
    this.iteratePauses(function (i, v) {
      if (first === null) {
        first = v;
      }
      this.maxPause = Math.max(v, this.maxPause);
    });
  }

  var dx = this.width / this.size;
  var dy = this.height / this.maxPause;

  this.ctx.save();
  this.ctx.clearRect(0, 0, this.width, this.height);
  this.ctx.beginPath();
  this.ctx.moveTo(1, dy * this.pauses[this.start]);
  var p = first;
  this.iteratePauses(function (i, v) {
    var delta = v - p;
    var x = 1 + dx * i;
    var y = dy * v;
    this.ctx.lineTo(x, y);
    if (delta > 2 * (p / 3)) {
      this.ctx.font = "bold 12px sans-serif";
      this.ctx.textBaseline = "bottom";
      this.ctx.fillText(v + "ms", x + 2, y);
    }
    p = v;
  });
  this.ctx.strokeStyle = "black";
  this.ctx.stroke();
  this.ctx.restore();
}


function Scene(width, height) {
  var canvas = document.createElement("canvas");
  canvas.width = width;
  canvas.height = height;
  document.body.appendChild(canvas);

  this.ctx = canvas.getContext('2d');
  this.width = canvas.width;
  this.height = canvas.height;

  // Projection configuration.
  this.x0 = canvas.width / 2;
  this.y0 = canvas.height / 2;
  this.z0 = 100;
  this.f  = 1000;  // Focal length.

  // Camera is rotating around y-axis.
  this.angle = 0;
}


Scene.prototype.drawPoint = function (x, y, z, color) {
  // Rotate the camera around y-axis.
  var rx = x * Math.cos(this.angle) - z * Math.sin(this.angle);
  var ry = y;
  var rz = x * Math.sin(this.angle) + z * Math.cos(this.angle);

  // Perform perspective projection.
  var px = (this.f * rx) / (rz - this.z0) + this.x0;
  var py = (this.f * ry) / (rz - this.z0) + this.y0;

  this.ctx.save();
  this.ctx.fillStyle = color
  this.ctx.beginPath();
  this.ctx.arc(px, py, kPointRadius, 0, 2 * Math.PI, true);
  this.ctx.fill();
  this.ctx.restore();
};


Scene.prototype.drawDyingPoints = function () {
  var point_next = null;
  for (var point = dyingPoints.head; point !== null; point = point_next) {
    // Rotate the scene around y-axis.
    scene.drawPoint(point.x, point.y, point.z, point.color());

    point_next = point.next;

    // Decay the current point and remove it from the list
    // if it's life-force ran out.
    if (point.decay()) {
      dyingPoints.remove(point);
    }
  }
};


Scene.prototype.draw = function () {
  this.ctx.save();
  this.ctx.clearRect(0, 0, this.width, this.height);
  this.drawDyingPoints();
  this.ctx.restore();

  this.angle += Math.PI / 90.0;
};


function updateStats(pause) {
  numberOfFrames++;
  if (pause > 20) {
    sumOfSquaredPauses += (pause - 20) * (pause - 20);
  }
  pauseDistribution[Math.floor(pause / 10)] |= 0;
  pauseDistribution[Math.floor(pause / 10)]++;
}


function renderStats() {
  var msg = document.createElement("p");
  msg.innerHTML = "Score " +
    Math.round(numberOfFrames * 1000 / sumOfSquaredPauses);
  var table = document.createElement("table");
  table.align = "center";
  for (var i = 0; i < pauseDistribution.length; i++) {
    if (pauseDistribution[i] > 0) {
      var row = document.createElement("tr");
      var time = document.createElement("td");
      var count = document.createElement("td");
      time.innerHTML = i*10 + "-" + (i+1)*10 + "ms";
      count.innerHTML = " => " + pauseDistribution[i];
      row.appendChild(time);
      row.appendChild(count);
      table.appendChild(row);
    }
  }
  div.appendChild(msg);
  div.appendChild(table);
}


function render() {
  if (typeof renderingStartTime === 'undefined') {
    renderingStartTime = Date.now();
    benchmarkStartTime = renderingStartTime;
  }

  ModifyPointsSet();

  scene.draw();

  var renderingEndTime = Date.now();
  var pause = renderingEndTime - renderingStartTime;
  pausePlot.addPause(pause);
  renderingStartTime = renderingEndTime;

  pausePlot.draw();

  updateStats(pause);

  div.innerHTML =
      livePoints.count + "/" + dyingPoints.count + " " +
      pause + "(max = " + pausePlot.maxPause + ") ms " +
      numberOfFrames + " frames";

  if (renderingEndTime < benchmarkStartTime + benchmarkTimeLimit) {
    // Schedule next frame.
    requestAnimationFrame(render);
  } else {
    renderStats();
  }
}


function Form() {
  function create(tag) { return document.createElement(tag); }
  function text(value) { return document.createTextNode(value); }

  this.form = create("form");
  this.form.setAttribute("action", "javascript:start()");

  var table = create("table");
  table.setAttribute("style", "margin-left: auto; margin-right: auto;");

  function col(a) {
    var td = create("td");
    td.appendChild(a);
    return td;
  }

  function row(a, b) {
    var tr = create("tr");
    tr.appendChild(col(a));
    tr.appendChild(col(b));
    return tr;
  }

  this.timelimit = create("input");
  this.timelimit.setAttribute("value", "60");

  table.appendChild(row(text("Time limit in seconds"), this.timelimit));

  this.autoscale = create("input");
  this.autoscale.setAttribute("type", "checkbox");
  this.autoscale.setAttribute("checked", "true");
  table.appendChild(row(text("Autoscale pauses plot"), this.autoscale));

  var button = create("input");
  button.setAttribute("type", "submit");
  button.setAttribute("value", "Start");
  this.form.appendChild(table);
  this.form.appendChild(button);

  document.body.appendChild(this.form);
}


Form.prototype.remove = function () {
  document.body.removeChild(this.form);
};


function init() {
  livePoints = new PointsList;
  dyingPoints = new PointsList;

  splayTree = new SplayTree();

  scene = new Scene(640, 480);

  div = document.createElement("div");
  document.body.appendChild(div);

  pausePlot = new PausePlot(480, autoScale ? 240 : 500, 160, autoScale ? void 0 : 500);
}

function start() {
  benchmarkTimeLimit = form.timelimit.value * 1000;
  autoScale = form.autoscale.checked;
  form.remove();
  init();
  render();
}

var form = new Form();
node-v4.8.2/deps/http_parser/.gitignore000644 000766 000024 00000000361 13070706730 020231 0ustar00iojsstaff000000 000000 /out/
core
tags
*.o
test
test_g
test_fast
bench
url_parser
parsertrace
parsertrace_g
*.mk
*.Makefile
*.so.*
*.a


# Visual Studio uglies
*.suo
*.sln
*.vcxproj
*.vcxproj.filters
*.vcxproj.user
*.opensdf
*.ncrunchsolution*
*.sdf
*.vsp
*.psess
node-v4.8.2/deps/http_parser/.mailmap000644 000766 000024 00000000740 13070706730 017663 0ustar00iojsstaff000000 000000 # update AUTHORS with:
#   git log --all --reverse --format='%aN <%aE>' | perl -ne 'BEGIN{print "# Authors ordered by first contribution.\n"} print unless $h{$_}; $h{$_} = 1' > AUTHORS
Ryan Dahl 
Salman Haq 
Simon Zimmermann 
Thomas LE ROUX  LE ROUX Thomas 
Thomas LE ROUX  Thomas LE ROUX 
Fedor Indutny 
node-v4.8.2/deps/http_parser/.travis.yml000644 000766 000024 00000000204 13070706730 020346 0ustar00iojsstaff000000 000000 language: c

compiler:
  - clang
  - gcc

script:
  - "make"

notifications:
  email: false
  irc:
    - "irc.freenode.net#node-ci"
node-v4.8.2/deps/http_parser/AUTHORS000644 000766 000024 00000004706 13070706730 017320 0ustar00iojsstaff000000 000000 # Authors ordered by first contribution.
Ryan Dahl 
Jeremy Hinegardner 
Sergey Shepelev 
Joe Damato 
tomika 
Phoenix Sol 
Cliff Frey 
Ewen Cheslack-Postava 
Santiago Gala 
Tim Becker 
Jeff Terrace 
Ben Noordhuis 
Nathan Rajlich 
Mark Nottingham 
Aman Gupta 
Tim Becker 
Sean Cunningham 
Peter Griess 
Salman Haq 
Cliff Frey 
Jon Kolb 
Fouad Mardini 
Paul Querna 
Felix Geisendörfer 
koichik 
Andre Caron 
Ivo Raisr 
James McLaughlin 
David Gwynne 
Thomas LE ROUX 
Randy Rizun 
Andre Louis Caron 
Simon Zimmermann 
Erik Dubbelboer 
Martell Malone 
Bertrand Paquet 
BogDan Vatra 
Peter Faiman 
Corey Richardson 
Tóth Tamás 
Cam Swords 
Chris Dickinson 
Uli Köhler 
Charlie Somerville 
Patrik Stutz 
Fedor Indutny 
runner 
Alexis Campailla 
David Wragg 
Vinnie Falco 
Alex Butum 
Rex Feng 
Alex Kocharin 
Mark Koopman 
Helge Heß 
Alexis La Goutte 
George Miroshnykov 
Maciej Małecki 
Marc O'Morain 
Jeff Pinner 
Timothy J Fontaine 
Akagi201 
Romain Giraud 
Jay Satiro 
Arne Steen 
Kjell Schubert 
Olivier Mengué 
node-v4.8.2/deps/http_parser/bench.c000644 000766 000024 00000006510 13070706730 017466 0ustar00iojsstaff000000 000000 /* Copyright Fedor Indutny. All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */
#include "http_parser.h"
#include 
#include 
#include 
#include 

static const char data[] =
    "POST /joyent/http-parser HTTP/1.1\r\n"
    "Host: github.com\r\n"
    "DNT: 1\r\n"
    "Accept-Encoding: gzip, deflate, sdch\r\n"
    "Accept-Language: ru-RU,ru;q=0.8,en-US;q=0.6,en;q=0.4\r\n"
    "User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1) "
        "AppleWebKit/537.36 (KHTML, like Gecko) "
        "Chrome/39.0.2171.65 Safari/537.36\r\n"
    "Accept: text/html,application/xhtml+xml,application/xml;q=0.9,"
        "image/webp,*/*;q=0.8\r\n"
    "Referer: https://github.com/joyent/http-parser\r\n"
    "Connection: keep-alive\r\n"
    "Transfer-Encoding: chunked\r\n"
    "Cache-Control: max-age=0\r\n\r\nb\r\nhello world\r\n0\r\n\r\n";
static const size_t data_len = sizeof(data) - 1;

static int on_info(http_parser* p) {
  return 0;
}


static int on_data(http_parser* p, const char *at, size_t length) {
  return 0;
}

static http_parser_settings settings = {
  .on_message_begin = on_info,
  .on_headers_complete = on_info,
  .on_message_complete = on_info,
  .on_header_field = on_data,
  .on_header_value = on_data,
  .on_url = on_data,
  .on_status = on_data,
  .on_body = on_data
};

int bench(int iter_count, int silent) {
  struct http_parser parser;
  int i;
  int err;
  struct timeval start;
  struct timeval end;
  float rps;

  if (!silent) {
    err = gettimeofday(&start, NULL);
    assert(err == 0);
  }

  for (i = 0; i < iter_count; i++) {
    size_t parsed;
    http_parser_init(&parser, HTTP_REQUEST);

    parsed = http_parser_execute(&parser, &settings, data, data_len);
    assert(parsed == data_len);
  }

  if (!silent) {
    err = gettimeofday(&end, NULL);
    assert(err == 0);

    fprintf(stdout, "Benchmark result:\n");

    rps = (float) (end.tv_sec - start.tv_sec) +
          (end.tv_usec - start.tv_usec) * 1e-6f;
    fprintf(stdout, "Took %f seconds to run\n", rps);

    rps = (float) iter_count / rps;
    fprintf(stdout, "%f req/sec\n", rps);
    fflush(stdout);
  }

  return 0;
}

int main(int argc, char** argv) {
  if (argc == 2 && strcmp(argv[1], "infinite") == 0) {
    for (;;)
      bench(5000000, 1);
    return 0;
  } else {
    return bench(5000000, 0);
  }
}
node-v4.8.2/deps/http_parser/contrib/000755 000766 000024 00000000000 13070706730 017701 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/http_parser/http_parser.c000644 000766 000024 00000213175 13070706730 020751 0ustar00iojsstaff000000 000000 /* Based on src/http/ngx_http_parse.c from NGINX copyright Igor Sysoev
 *
 * Additional changes are licensed under the same terms as NGINX and
 * copyright Joyent, Inc. and other Node contributors. All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */
#include "http_parser.h"
#include 
#include 
#include 
#include 
#include 
#include 

#ifndef ULLONG_MAX
# define ULLONG_MAX ((uint64_t) -1) /* 2^64-1 */
#endif

#ifndef MIN
# define MIN(a,b) ((a) < (b) ? (a) : (b))
#endif

#ifndef ARRAY_SIZE
# define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
#endif

#ifndef BIT_AT
# define BIT_AT(a, i)                                                \
  (!!((unsigned int) (a)[(unsigned int) (i) >> 3] &                  \
   (1 << ((unsigned int) (i) & 7))))
#endif

#ifndef ELEM_AT
# define ELEM_AT(a, i, v) ((unsigned int) (i) < ARRAY_SIZE(a) ? (a)[(i)] : (v))
#endif

#define SET_ERRNO(e)                                                 \
do {                                                                 \
  parser->http_errno = (e);                                          \
} while(0)

#define CURRENT_STATE() p_state
#define UPDATE_STATE(V) p_state = (enum state) (V);
#define RETURN(V)                                                    \
do {                                                                 \
  parser->state = CURRENT_STATE();                                   \
  return (V);                                                        \
} while (0);
#define REEXECUTE()                                                  \
  goto reexecute;                                                    \


#ifdef __GNUC__
# define LIKELY(X) __builtin_expect(!!(X), 1)
# define UNLIKELY(X) __builtin_expect(!!(X), 0)
#else
# define LIKELY(X) (X)
# define UNLIKELY(X) (X)
#endif


/* Run the notify callback FOR, returning ER if it fails */
#define CALLBACK_NOTIFY_(FOR, ER)                                    \
do {                                                                 \
  assert(HTTP_PARSER_ERRNO(parser) == HPE_OK);                       \
                                                                     \
  if (LIKELY(settings->on_##FOR)) {                                  \
    parser->state = CURRENT_STATE();                                 \
    if (UNLIKELY(0 != settings->on_##FOR(parser))) {                 \
      SET_ERRNO(HPE_CB_##FOR);                                       \
    }                                                                \
    UPDATE_STATE(parser->state);                                     \
                                                                     \
    /* We either errored above or got paused; get out */             \
    if (UNLIKELY(HTTP_PARSER_ERRNO(parser) != HPE_OK)) {             \
      return (ER);                                                   \
    }                                                                \
  }                                                                  \
} while (0)

/* Run the notify callback FOR and consume the current byte */
#define CALLBACK_NOTIFY(FOR)            CALLBACK_NOTIFY_(FOR, p - data + 1)

/* Run the notify callback FOR and don't consume the current byte */
#define CALLBACK_NOTIFY_NOADVANCE(FOR)  CALLBACK_NOTIFY_(FOR, p - data)

/* Run data callback FOR with LEN bytes, returning ER if it fails */
#define CALLBACK_DATA_(FOR, LEN, ER)                                 \
do {                                                                 \
  assert(HTTP_PARSER_ERRNO(parser) == HPE_OK);                       \
                                                                     \
  if (FOR##_mark) {                                                  \
    if (LIKELY(settings->on_##FOR)) {                                \
      parser->state = CURRENT_STATE();                               \
      if (UNLIKELY(0 !=                                              \
                   settings->on_##FOR(parser, FOR##_mark, (LEN)))) { \
        SET_ERRNO(HPE_CB_##FOR);                                     \
      }                                                              \
      UPDATE_STATE(parser->state);                                   \
                                                                     \
      /* We either errored above or got paused; get out */           \
      if (UNLIKELY(HTTP_PARSER_ERRNO(parser) != HPE_OK)) {           \
        return (ER);                                                 \
      }                                                              \
    }                                                                \
    FOR##_mark = NULL;                                               \
  }                                                                  \
} while (0)

/* Run the data callback FOR and consume the current byte */
#define CALLBACK_DATA(FOR)                                           \
    CALLBACK_DATA_(FOR, p - FOR##_mark, p - data + 1)

/* Run the data callback FOR and don't consume the current byte */
#define CALLBACK_DATA_NOADVANCE(FOR)                                 \
    CALLBACK_DATA_(FOR, p - FOR##_mark, p - data)

/* Set the mark FOR; non-destructive if mark is already set */
#define MARK(FOR)                                                    \
do {                                                                 \
  if (!FOR##_mark) {                                                 \
    FOR##_mark = p;                                                  \
  }                                                                  \
} while (0)

/* Don't allow the total size of the HTTP headers (including the status
 * line) to exceed HTTP_MAX_HEADER_SIZE.  This check is here to protect
 * embedders against denial-of-service attacks where the attacker feeds
 * us a never-ending header that the embedder keeps buffering.
 *
 * This check is arguably the responsibility of embedders but we're doing
 * it on the embedder's behalf because most won't bother and this way we
 * make the web a little safer.  HTTP_MAX_HEADER_SIZE is still far bigger
 * than any reasonable request or response so this should never affect
 * day-to-day operation.
 */
#define COUNT_HEADER_SIZE(V)                                         \
do {                                                                 \
  parser->nread += (V);                                              \
  if (UNLIKELY(parser->nread > (HTTP_MAX_HEADER_SIZE))) {            \
    SET_ERRNO(HPE_HEADER_OVERFLOW);                                  \
    goto error;                                                      \
  }                                                                  \
} while (0)


#define PROXY_CONNECTION "proxy-connection"
#define CONNECTION "connection"
#define CONTENT_LENGTH "content-length"
#define TRANSFER_ENCODING "transfer-encoding"
#define UPGRADE "upgrade"
#define CHUNKED "chunked"
#define KEEP_ALIVE "keep-alive"
#define CLOSE "close"


static const char *method_strings[] =
  {
#define XX(num, name, string) #string,
  HTTP_METHOD_MAP(XX)
#undef XX
  };


/* Tokens as defined by rfc 2616. Also lowercases them.
 *        token       = 1*
 *     separators     = "(" | ")" | "<" | ">" | "@"
 *                    | "," | ";" | ":" | "\" | <">
 *                    | "/" | "[" | "]" | "?" | "="
 *                    | "{" | "}" | SP | HT
 */
static const char tokens[256] = {
/*   0 nul    1 soh    2 stx    3 etx    4 eot    5 enq    6 ack    7 bel  */
        0,       0,       0,       0,       0,       0,       0,       0,
/*   8 bs     9 ht    10 nl    11 vt    12 np    13 cr    14 so    15 si   */
        0,       0,       0,       0,       0,       0,       0,       0,
/*  16 dle   17 dc1   18 dc2   19 dc3   20 dc4   21 nak   22 syn   23 etb */
        0,       0,       0,       0,       0,       0,       0,       0,
/*  24 can   25 em    26 sub   27 esc   28 fs    29 gs    30 rs    31 us  */
        0,       0,       0,       0,       0,       0,       0,       0,
/*  32 sp    33  !    34  "    35  #    36  $    37  %    38  &    39  '  */
        0,      '!',      0,      '#',     '$',     '%',     '&',    '\'',
/*  40  (    41  )    42  *    43  +    44  ,    45  -    46  .    47  /  */
        0,       0,      '*',     '+',      0,      '-',     '.',      0,
/*  48  0    49  1    50  2    51  3    52  4    53  5    54  6    55  7  */
       '0',     '1',     '2',     '3',     '4',     '5',     '6',     '7',
/*  56  8    57  9    58  :    59  ;    60  <    61  =    62  >    63  ?  */
       '8',     '9',      0,       0,       0,       0,       0,       0,
/*  64  @    65  A    66  B    67  C    68  D    69  E    70  F    71  G  */
        0,      'a',     'b',     'c',     'd',     'e',     'f',     'g',
/*  72  H    73  I    74  J    75  K    76  L    77  M    78  N    79  O  */
       'h',     'i',     'j',     'k',     'l',     'm',     'n',     'o',
/*  80  P    81  Q    82  R    83  S    84  T    85  U    86  V    87  W  */
       'p',     'q',     'r',     's',     't',     'u',     'v',     'w',
/*  88  X    89  Y    90  Z    91  [    92  \    93  ]    94  ^    95  _  */
       'x',     'y',     'z',      0,       0,       0,      '^',     '_',
/*  96  `    97  a    98  b    99  c   100  d   101  e   102  f   103  g  */
       '`',     'a',     'b',     'c',     'd',     'e',     'f',     'g',
/* 104  h   105  i   106  j   107  k   108  l   109  m   110  n   111  o  */
       'h',     'i',     'j',     'k',     'l',     'm',     'n',     'o',
/* 112  p   113  q   114  r   115  s   116  t   117  u   118  v   119  w  */
       'p',     'q',     'r',     's',     't',     'u',     'v',     'w',
/* 120  x   121  y   122  z   123  {   124  |   125  }   126  ~   127 del */
       'x',     'y',     'z',      0,      '|',      0,      '~',       0 };


static const int8_t unhex[256] =
  {-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1
  ,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1
  ,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1
  , 0, 1, 2, 3, 4, 5, 6, 7, 8, 9,-1,-1,-1,-1,-1,-1
  ,-1,10,11,12,13,14,15,-1,-1,-1,-1,-1,-1,-1,-1,-1
  ,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1
  ,-1,10,11,12,13,14,15,-1,-1,-1,-1,-1,-1,-1,-1,-1
  ,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1,-1
  };


#if HTTP_PARSER_STRICT
# define T(v) 0
#else
# define T(v) v
#endif


static const uint8_t normal_url_char[32] = {
/*   0 nul    1 soh    2 stx    3 etx    4 eot    5 enq    6 ack    7 bel  */
        0    |   0    |   0    |   0    |   0    |   0    |   0    |   0,
/*   8 bs     9 ht    10 nl    11 vt    12 np    13 cr    14 so    15 si   */
        0    | T(2)   |   0    |   0    | T(16)  |   0    |   0    |   0,
/*  16 dle   17 dc1   18 dc2   19 dc3   20 dc4   21 nak   22 syn   23 etb */
        0    |   0    |   0    |   0    |   0    |   0    |   0    |   0,
/*  24 can   25 em    26 sub   27 esc   28 fs    29 gs    30 rs    31 us  */
        0    |   0    |   0    |   0    |   0    |   0    |   0    |   0,
/*  32 sp    33  !    34  "    35  #    36  $    37  %    38  &    39  '  */
        0    |   2    |   4    |   0    |   16   |   32   |   64   |  128,
/*  40  (    41  )    42  *    43  +    44  ,    45  -    46  .    47  /  */
        1    |   2    |   4    |   8    |   16   |   32   |   64   |  128,
/*  48  0    49  1    50  2    51  3    52  4    53  5    54  6    55  7  */
        1    |   2    |   4    |   8    |   16   |   32   |   64   |  128,
/*  56  8    57  9    58  :    59  ;    60  <    61  =    62  >    63  ?  */
        1    |   2    |   4    |   8    |   16   |   32   |   64   |   0,
/*  64  @    65  A    66  B    67  C    68  D    69  E    70  F    71  G  */
        1    |   2    |   4    |   8    |   16   |   32   |   64   |  128,
/*  72  H    73  I    74  J    75  K    76  L    77  M    78  N    79  O  */
        1    |   2    |   4    |   8    |   16   |   32   |   64   |  128,
/*  80  P    81  Q    82  R    83  S    84  T    85  U    86  V    87  W  */
        1    |   2    |   4    |   8    |   16   |   32   |   64   |  128,
/*  88  X    89  Y    90  Z    91  [    92  \    93  ]    94  ^    95  _  */
        1    |   2    |   4    |   8    |   16   |   32   |   64   |  128,
/*  96  `    97  a    98  b    99  c   100  d   101  e   102  f   103  g  */
        1    |   2    |   4    |   8    |   16   |   32   |   64   |  128,
/* 104  h   105  i   106  j   107  k   108  l   109  m   110  n   111  o  */
        1    |   2    |   4    |   8    |   16   |   32   |   64   |  128,
/* 112  p   113  q   114  r   115  s   116  t   117  u   118  v   119  w  */
        1    |   2    |   4    |   8    |   16   |   32   |   64   |  128,
/* 120  x   121  y   122  z   123  {   124  |   125  }   126  ~   127 del */
        1    |   2    |   4    |   8    |   16   |   32   |   64   |   0, };

#undef T

enum state
  { s_dead = 1 /* important that this is > 0 */

  , s_start_req_or_res
  , s_res_or_resp_H
  , s_start_res
  , s_res_H
  , s_res_HT
  , s_res_HTT
  , s_res_HTTP
  , s_res_first_http_major
  , s_res_http_major
  , s_res_first_http_minor
  , s_res_http_minor
  , s_res_first_status_code
  , s_res_status_code
  , s_res_status_start
  , s_res_status
  , s_res_line_almost_done

  , s_start_req

  , s_req_method
  , s_req_spaces_before_url
  , s_req_schema
  , s_req_schema_slash
  , s_req_schema_slash_slash
  , s_req_server_start
  , s_req_server
  , s_req_server_with_at
  , s_req_path
  , s_req_query_string_start
  , s_req_query_string
  , s_req_fragment_start
  , s_req_fragment
  , s_req_http_start
  , s_req_http_H
  , s_req_http_HT
  , s_req_http_HTT
  , s_req_http_HTTP
  , s_req_first_http_major
  , s_req_http_major
  , s_req_first_http_minor
  , s_req_http_minor
  , s_req_line_almost_done

  , s_header_field_start
  , s_header_field
  , s_header_value_discard_ws
  , s_header_value_discard_ws_almost_done
  , s_header_value_discard_lws
  , s_header_value_start
  , s_header_value
  , s_header_value_lws

  , s_header_almost_done

  , s_chunk_size_start
  , s_chunk_size
  , s_chunk_parameters
  , s_chunk_size_almost_done

  , s_headers_almost_done
  , s_headers_done

  /* Important: 's_headers_done' must be the last 'header' state. All
   * states beyond this must be 'body' states. It is used for overflow
   * checking. See the PARSING_HEADER() macro.
   */

  , s_chunk_data
  , s_chunk_data_almost_done
  , s_chunk_data_done

  , s_body_identity
  , s_body_identity_eof

  , s_message_done
  };


#define PARSING_HEADER(state) (state <= s_headers_done)


enum header_states
  { h_general = 0
  , h_C
  , h_CO
  , h_CON

  , h_matching_connection
  , h_matching_proxy_connection
  , h_matching_content_length
  , h_matching_transfer_encoding
  , h_matching_upgrade

  , h_connection
  , h_content_length
  , h_transfer_encoding
  , h_upgrade

  , h_matching_transfer_encoding_chunked
  , h_matching_connection_token_start
  , h_matching_connection_keep_alive
  , h_matching_connection_close
  , h_matching_connection_upgrade
  , h_matching_connection_token

  , h_transfer_encoding_chunked
  , h_connection_keep_alive
  , h_connection_close
  , h_connection_upgrade
  };

enum http_host_state
  {
    s_http_host_dead = 1
  , s_http_userinfo_start
  , s_http_userinfo
  , s_http_host_start
  , s_http_host_v6_start
  , s_http_host
  , s_http_host_v6
  , s_http_host_v6_end
  , s_http_host_v6_zone_start
  , s_http_host_v6_zone
  , s_http_host_port_start
  , s_http_host_port
};

/* Macros for character classes; depends on strict-mode  */
#define CR                  '\r'
#define LF                  '\n'
#define LOWER(c)            (unsigned char)(c | 0x20)
#define IS_ALPHA(c)         (LOWER(c) >= 'a' && LOWER(c) <= 'z')
#define IS_NUM(c)           ((c) >= '0' && (c) <= '9')
#define IS_ALPHANUM(c)      (IS_ALPHA(c) || IS_NUM(c))
#define IS_HEX(c)           (IS_NUM(c) || (LOWER(c) >= 'a' && LOWER(c) <= 'f'))
#define IS_MARK(c)          ((c) == '-' || (c) == '_' || (c) == '.' || \
  (c) == '!' || (c) == '~' || (c) == '*' || (c) == '\'' || (c) == '(' || \
  (c) == ')')
#define IS_USERINFO_CHAR(c) (IS_ALPHANUM(c) || IS_MARK(c) || (c) == '%' || \
  (c) == ';' || (c) == ':' || (c) == '&' || (c) == '=' || (c) == '+' || \
  (c) == '$' || (c) == ',')

#define STRICT_TOKEN(c)     (tokens[(unsigned char)c])

#if HTTP_PARSER_STRICT
#define TOKEN(c)            (tokens[(unsigned char)c])
#define IS_URL_CHAR(c)      (BIT_AT(normal_url_char, (unsigned char)c))
#define IS_HOST_CHAR(c)     (IS_ALPHANUM(c) || (c) == '.' || (c) == '-')
#else
#define TOKEN(c)            ((c == ' ') ? ' ' : tokens[(unsigned char)c])
#define IS_URL_CHAR(c)                                                         \
  (BIT_AT(normal_url_char, (unsigned char)c) || ((c) & 0x80))
#define IS_HOST_CHAR(c)                                                        \
  (IS_ALPHANUM(c) || (c) == '.' || (c) == '-' || (c) == '_')
#endif

/**
 * Verify that a char is a valid visible (printable) US-ASCII
 * character or %x80-FF
 **/
#define IS_HEADER_CHAR(ch)                                                     \
  (ch == CR || ch == LF || ch == 9 || ((unsigned char)ch > 31 && ch != 127))

#define start_state (parser->type == HTTP_REQUEST ? s_start_req : s_start_res)


#if HTTP_PARSER_STRICT
# define STRICT_CHECK(cond)                                          \
do {                                                                 \
  if (cond) {                                                        \
    SET_ERRNO(HPE_STRICT);                                           \
    goto error;                                                      \
  }                                                                  \
} while (0)
# define NEW_MESSAGE() (http_should_keep_alive(parser) ? start_state : s_dead)
#else
# define STRICT_CHECK(cond)
# define NEW_MESSAGE() start_state
#endif


/* Map errno values to strings for human-readable output */
#define HTTP_STRERROR_GEN(n, s) { "HPE_" #n, s },
static struct {
  const char *name;
  const char *description;
} http_strerror_tab[] = {
  HTTP_ERRNO_MAP(HTTP_STRERROR_GEN)
};
#undef HTTP_STRERROR_GEN

int http_message_needs_eof(const http_parser *parser);

/* Our URL parser.
 *
 * This is designed to be shared by http_parser_execute() for URL validation,
 * hence it has a state transition + byte-for-byte interface. In addition, it
 * is meant to be embedded in http_parser_parse_url(), which does the dirty
 * work of turning state transitions URL components for its API.
 *
 * This function should only be invoked with non-space characters. It is
 * assumed that the caller cares about (and can detect) the transition between
 * URL and non-URL states by looking for these.
 */
static enum state
parse_url_char(enum state s, const char ch)
{
  if (ch == ' ' || ch == '\r' || ch == '\n') {
    return s_dead;
  }

#if HTTP_PARSER_STRICT
  if (ch == '\t' || ch == '\f') {
    return s_dead;
  }
#endif

  switch (s) {
    case s_req_spaces_before_url:
      /* Proxied requests are followed by scheme of an absolute URI (alpha).
       * All methods except CONNECT are followed by '/' or '*'.
       */

      if (ch == '/' || ch == '*') {
        return s_req_path;
      }

      if (IS_ALPHA(ch)) {
        return s_req_schema;
      }

      break;

    case s_req_schema:
      if (IS_ALPHA(ch)) {
        return s;
      }

      if (ch == ':') {
        return s_req_schema_slash;
      }

      break;

    case s_req_schema_slash:
      if (ch == '/') {
        return s_req_schema_slash_slash;
      }

      break;

    case s_req_schema_slash_slash:
      if (ch == '/') {
        return s_req_server_start;
      }

      break;

    case s_req_server_with_at:
      if (ch == '@') {
        return s_dead;
      }

    /* FALLTHROUGH */
    case s_req_server_start:
    case s_req_server:
      if (ch == '/') {
        return s_req_path;
      }

      if (ch == '?') {
        return s_req_query_string_start;
      }

      if (ch == '@') {
        return s_req_server_with_at;
      }

      if (IS_USERINFO_CHAR(ch) || ch == '[' || ch == ']') {
        return s_req_server;
      }

      break;

    case s_req_path:
      if (IS_URL_CHAR(ch)) {
        return s;
      }

      switch (ch) {
        case '?':
          return s_req_query_string_start;

        case '#':
          return s_req_fragment_start;
      }

      break;

    case s_req_query_string_start:
    case s_req_query_string:
      if (IS_URL_CHAR(ch)) {
        return s_req_query_string;
      }

      switch (ch) {
        case '?':
          /* allow extra '?' in query string */
          return s_req_query_string;

        case '#':
          return s_req_fragment_start;
      }

      break;

    case s_req_fragment_start:
      if (IS_URL_CHAR(ch)) {
        return s_req_fragment;
      }

      switch (ch) {
        case '?':
          return s_req_fragment;

        case '#':
          return s;
      }

      break;

    case s_req_fragment:
      if (IS_URL_CHAR(ch)) {
        return s;
      }

      switch (ch) {
        case '?':
        case '#':
          return s;
      }

      break;

    default:
      break;
  }

  /* We should never fall out of the switch above unless there's an error */
  return s_dead;
}

size_t http_parser_execute (http_parser *parser,
                            const http_parser_settings *settings,
                            const char *data,
                            size_t len)
{
  char c, ch;
  int8_t unhex_val;
  const char *p = data;
  const char *header_field_mark = 0;
  const char *header_value_mark = 0;
  const char *url_mark = 0;
  const char *body_mark = 0;
  const char *status_mark = 0;
  enum state p_state = (enum state) parser->state;
  const unsigned int lenient = parser->lenient_http_headers;

  /* We're in an error state. Don't bother doing anything. */
  if (HTTP_PARSER_ERRNO(parser) != HPE_OK) {
    return 0;
  }

  if (len == 0) {
    switch (CURRENT_STATE()) {
      case s_body_identity_eof:
        /* Use of CALLBACK_NOTIFY() here would erroneously return 1 byte read if
         * we got paused.
         */
        CALLBACK_NOTIFY_NOADVANCE(message_complete);
        return 0;

      case s_dead:
      case s_start_req_or_res:
      case s_start_res:
      case s_start_req:
        return 0;

      default:
        SET_ERRNO(HPE_INVALID_EOF_STATE);
        return 1;
    }
  }


  if (CURRENT_STATE() == s_header_field)
    header_field_mark = data;
  if (CURRENT_STATE() == s_header_value)
    header_value_mark = data;
  switch (CURRENT_STATE()) {
  case s_req_path:
  case s_req_schema:
  case s_req_schema_slash:
  case s_req_schema_slash_slash:
  case s_req_server_start:
  case s_req_server:
  case s_req_server_with_at:
  case s_req_query_string_start:
  case s_req_query_string:
  case s_req_fragment_start:
  case s_req_fragment:
    url_mark = data;
    break;
  case s_res_status:
    status_mark = data;
    break;
  default:
    break;
  }

  for (p=data; p != data + len; p++) {
    ch = *p;

    if (PARSING_HEADER(CURRENT_STATE()))
      COUNT_HEADER_SIZE(1);

reexecute:
    switch (CURRENT_STATE()) {

      case s_dead:
        /* this state is used after a 'Connection: close' message
         * the parser will error out if it reads another message
         */
        if (LIKELY(ch == CR || ch == LF))
          break;

        SET_ERRNO(HPE_CLOSED_CONNECTION);
        goto error;

      case s_start_req_or_res:
      {
        if (ch == CR || ch == LF)
          break;
        parser->flags = 0;
        parser->content_length = ULLONG_MAX;

        if (ch == 'H') {
          UPDATE_STATE(s_res_or_resp_H);

          CALLBACK_NOTIFY(message_begin);
        } else {
          parser->type = HTTP_REQUEST;
          UPDATE_STATE(s_start_req);
          REEXECUTE();
        }

        break;
      }

      case s_res_or_resp_H:
        if (ch == 'T') {
          parser->type = HTTP_RESPONSE;
          UPDATE_STATE(s_res_HT);
        } else {
          if (UNLIKELY(ch != 'E')) {
            SET_ERRNO(HPE_INVALID_CONSTANT);
            goto error;
          }

          parser->type = HTTP_REQUEST;
          parser->method = HTTP_HEAD;
          parser->index = 2;
          UPDATE_STATE(s_req_method);
        }
        break;

      case s_start_res:
      {
        parser->flags = 0;
        parser->content_length = ULLONG_MAX;

        switch (ch) {
          case 'H':
            UPDATE_STATE(s_res_H);
            break;

          case CR:
          case LF:
            break;

          default:
            SET_ERRNO(HPE_INVALID_CONSTANT);
            goto error;
        }

        CALLBACK_NOTIFY(message_begin);
        break;
      }

      case s_res_H:
        STRICT_CHECK(ch != 'T');
        UPDATE_STATE(s_res_HT);
        break;

      case s_res_HT:
        STRICT_CHECK(ch != 'T');
        UPDATE_STATE(s_res_HTT);
        break;

      case s_res_HTT:
        STRICT_CHECK(ch != 'P');
        UPDATE_STATE(s_res_HTTP);
        break;

      case s_res_HTTP:
        STRICT_CHECK(ch != '/');
        UPDATE_STATE(s_res_first_http_major);
        break;

      case s_res_first_http_major:
        if (UNLIKELY(ch < '0' || ch > '9')) {
          SET_ERRNO(HPE_INVALID_VERSION);
          goto error;
        }

        parser->http_major = ch - '0';
        UPDATE_STATE(s_res_http_major);
        break;

      /* major HTTP version or dot */
      case s_res_http_major:
      {
        if (ch == '.') {
          UPDATE_STATE(s_res_first_http_minor);
          break;
        }

        if (!IS_NUM(ch)) {
          SET_ERRNO(HPE_INVALID_VERSION);
          goto error;
        }

        parser->http_major *= 10;
        parser->http_major += ch - '0';

        if (UNLIKELY(parser->http_major > 999)) {
          SET_ERRNO(HPE_INVALID_VERSION);
          goto error;
        }

        break;
      }

      /* first digit of minor HTTP version */
      case s_res_first_http_minor:
        if (UNLIKELY(!IS_NUM(ch))) {
          SET_ERRNO(HPE_INVALID_VERSION);
          goto error;
        }

        parser->http_minor = ch - '0';
        UPDATE_STATE(s_res_http_minor);
        break;

      /* minor HTTP version or end of request line */
      case s_res_http_minor:
      {
        if (ch == ' ') {
          UPDATE_STATE(s_res_first_status_code);
          break;
        }

        if (UNLIKELY(!IS_NUM(ch))) {
          SET_ERRNO(HPE_INVALID_VERSION);
          goto error;
        }

        parser->http_minor *= 10;
        parser->http_minor += ch - '0';

        if (UNLIKELY(parser->http_minor > 999)) {
          SET_ERRNO(HPE_INVALID_VERSION);
          goto error;
        }

        break;
      }

      case s_res_first_status_code:
      {
        if (!IS_NUM(ch)) {
          if (ch == ' ') {
            break;
          }

          SET_ERRNO(HPE_INVALID_STATUS);
          goto error;
        }
        parser->status_code = ch - '0';
        UPDATE_STATE(s_res_status_code);
        break;
      }

      case s_res_status_code:
      {
        if (!IS_NUM(ch)) {
          switch (ch) {
            case ' ':
              UPDATE_STATE(s_res_status_start);
              break;
            case CR:
              UPDATE_STATE(s_res_line_almost_done);
              break;
            case LF:
              UPDATE_STATE(s_header_field_start);
              break;
            default:
              SET_ERRNO(HPE_INVALID_STATUS);
              goto error;
          }
          break;
        }

        parser->status_code *= 10;
        parser->status_code += ch - '0';

        if (UNLIKELY(parser->status_code > 999)) {
          SET_ERRNO(HPE_INVALID_STATUS);
          goto error;
        }

        break;
      }

      case s_res_status_start:
      {
        if (ch == CR) {
          UPDATE_STATE(s_res_line_almost_done);
          break;
        }

        if (ch == LF) {
          UPDATE_STATE(s_header_field_start);
          break;
        }

        MARK(status);
        UPDATE_STATE(s_res_status);
        parser->index = 0;
        break;
      }

      case s_res_status:
        if (ch == CR) {
          UPDATE_STATE(s_res_line_almost_done);
          CALLBACK_DATA(status);
          break;
        }

        if (ch == LF) {
          UPDATE_STATE(s_header_field_start);
          CALLBACK_DATA(status);
          break;
        }

        break;

      case s_res_line_almost_done:
        STRICT_CHECK(ch != LF);
        UPDATE_STATE(s_header_field_start);
        break;

      case s_start_req:
      {
        if (ch == CR || ch == LF)
          break;
        parser->flags = 0;
        parser->content_length = ULLONG_MAX;

        if (UNLIKELY(!IS_ALPHA(ch))) {
          SET_ERRNO(HPE_INVALID_METHOD);
          goto error;
        }

        parser->method = (enum http_method) 0;
        parser->index = 1;
        switch (ch) {
          case 'A': parser->method = HTTP_ACL; break;
          case 'B': parser->method = HTTP_BIND; break;
          case 'C': parser->method = HTTP_CONNECT; /* or COPY, CHECKOUT */ break;
          case 'D': parser->method = HTTP_DELETE; break;
          case 'G': parser->method = HTTP_GET; break;
          case 'H': parser->method = HTTP_HEAD; break;
          case 'L': parser->method = HTTP_LOCK; /* or LINK */ break;
          case 'M': parser->method = HTTP_MKCOL; /* or MOVE, MKACTIVITY, MERGE, M-SEARCH, MKCALENDAR */ break;
          case 'N': parser->method = HTTP_NOTIFY; break;
          case 'O': parser->method = HTTP_OPTIONS; break;
          case 'P': parser->method = HTTP_POST;
            /* or PROPFIND|PROPPATCH|PUT|PATCH|PURGE */
            break;
          case 'R': parser->method = HTTP_REPORT; /* or REBIND */ break;
          case 'S': parser->method = HTTP_SUBSCRIBE; /* or SEARCH */ break;
          case 'T': parser->method = HTTP_TRACE; break;
          case 'U': parser->method = HTTP_UNLOCK; /* or UNSUBSCRIBE, UNBIND, UNLINK */ break;
          default:
            SET_ERRNO(HPE_INVALID_METHOD);
            goto error;
        }
        UPDATE_STATE(s_req_method);

        CALLBACK_NOTIFY(message_begin);

        break;
      }

      case s_req_method:
      {
        const char *matcher;
        if (UNLIKELY(ch == '\0')) {
          SET_ERRNO(HPE_INVALID_METHOD);
          goto error;
        }

        matcher = method_strings[parser->method];
        if (ch == ' ' && matcher[parser->index] == '\0') {
          UPDATE_STATE(s_req_spaces_before_url);
        } else if (ch == matcher[parser->index]) {
          ; /* nada */
        } else if (IS_ALPHA(ch)) {

          switch (parser->method << 16 | parser->index << 8 | ch) {
#define XX(meth, pos, ch, new_meth) \
            case (HTTP_##meth << 16 | pos << 8 | ch): \
              parser->method = HTTP_##new_meth; break;

            XX(POST,      1, 'U', PUT)
            XX(POST,      1, 'A', PATCH)
            XX(CONNECT,   1, 'H', CHECKOUT)
            XX(CONNECT,   2, 'P', COPY)
            XX(MKCOL,     1, 'O', MOVE)
            XX(MKCOL,     1, 'E', MERGE)
            XX(MKCOL,     2, 'A', MKACTIVITY)
            XX(MKCOL,     3, 'A', MKCALENDAR)
            XX(SUBSCRIBE, 1, 'E', SEARCH)
            XX(REPORT,    2, 'B', REBIND)
            XX(POST,      1, 'R', PROPFIND)
            XX(PROPFIND,  4, 'P', PROPPATCH)
            XX(PUT,       2, 'R', PURGE)
            XX(LOCK,      1, 'I', LINK)
            XX(UNLOCK,    2, 'S', UNSUBSCRIBE)
            XX(UNLOCK,    2, 'B', UNBIND)
            XX(UNLOCK,    3, 'I', UNLINK)
#undef XX

            default:
              SET_ERRNO(HPE_INVALID_METHOD);
              goto error;
          }
        } else if (ch == '-' &&
                   parser->index == 1 &&
                   parser->method == HTTP_MKCOL) {
          parser->method = HTTP_MSEARCH;
        } else {
          SET_ERRNO(HPE_INVALID_METHOD);
          goto error;
        }

        ++parser->index;
        break;
      }

      case s_req_spaces_before_url:
      {
        if (ch == ' ') break;

        MARK(url);
        if (parser->method == HTTP_CONNECT) {
          UPDATE_STATE(s_req_server_start);
        }

        UPDATE_STATE(parse_url_char(CURRENT_STATE(), ch));
        if (UNLIKELY(CURRENT_STATE() == s_dead)) {
          SET_ERRNO(HPE_INVALID_URL);
          goto error;
        }

        break;
      }

      case s_req_schema:
      case s_req_schema_slash:
      case s_req_schema_slash_slash:
      case s_req_server_start:
      {
        switch (ch) {
          /* No whitespace allowed here */
          case ' ':
          case CR:
          case LF:
            SET_ERRNO(HPE_INVALID_URL);
            goto error;
          default:
            UPDATE_STATE(parse_url_char(CURRENT_STATE(), ch));
            if (UNLIKELY(CURRENT_STATE() == s_dead)) {
              SET_ERRNO(HPE_INVALID_URL);
              goto error;
            }
        }

        break;
      }

      case s_req_server:
      case s_req_server_with_at:
      case s_req_path:
      case s_req_query_string_start:
      case s_req_query_string:
      case s_req_fragment_start:
      case s_req_fragment:
      {
        switch (ch) {
          case ' ':
            UPDATE_STATE(s_req_http_start);
            CALLBACK_DATA(url);
            break;
          case CR:
          case LF:
            parser->http_major = 0;
            parser->http_minor = 9;
            UPDATE_STATE((ch == CR) ?
              s_req_line_almost_done :
              s_header_field_start);
            CALLBACK_DATA(url);
            break;
          default:
            UPDATE_STATE(parse_url_char(CURRENT_STATE(), ch));
            if (UNLIKELY(CURRENT_STATE() == s_dead)) {
              SET_ERRNO(HPE_INVALID_URL);
              goto error;
            }
        }
        break;
      }

      case s_req_http_start:
        switch (ch) {
          case 'H':
            UPDATE_STATE(s_req_http_H);
            break;
          case ' ':
            break;
          default:
            SET_ERRNO(HPE_INVALID_CONSTANT);
            goto error;
        }
        break;

      case s_req_http_H:
        STRICT_CHECK(ch != 'T');
        UPDATE_STATE(s_req_http_HT);
        break;

      case s_req_http_HT:
        STRICT_CHECK(ch != 'T');
        UPDATE_STATE(s_req_http_HTT);
        break;

      case s_req_http_HTT:
        STRICT_CHECK(ch != 'P');
        UPDATE_STATE(s_req_http_HTTP);
        break;

      case s_req_http_HTTP:
        STRICT_CHECK(ch != '/');
        UPDATE_STATE(s_req_first_http_major);
        break;

      /* first digit of major HTTP version */
      case s_req_first_http_major:
        if (UNLIKELY(ch < '1' || ch > '9')) {
          SET_ERRNO(HPE_INVALID_VERSION);
          goto error;
        }

        parser->http_major = ch - '0';
        UPDATE_STATE(s_req_http_major);
        break;

      /* major HTTP version or dot */
      case s_req_http_major:
      {
        if (ch == '.') {
          UPDATE_STATE(s_req_first_http_minor);
          break;
        }

        if (UNLIKELY(!IS_NUM(ch))) {
          SET_ERRNO(HPE_INVALID_VERSION);
          goto error;
        }

        parser->http_major *= 10;
        parser->http_major += ch - '0';

        if (UNLIKELY(parser->http_major > 999)) {
          SET_ERRNO(HPE_INVALID_VERSION);
          goto error;
        }

        break;
      }

      /* first digit of minor HTTP version */
      case s_req_first_http_minor:
        if (UNLIKELY(!IS_NUM(ch))) {
          SET_ERRNO(HPE_INVALID_VERSION);
          goto error;
        }

        parser->http_minor = ch - '0';
        UPDATE_STATE(s_req_http_minor);
        break;

      /* minor HTTP version or end of request line */
      case s_req_http_minor:
      {
        if (ch == CR) {
          UPDATE_STATE(s_req_line_almost_done);
          break;
        }

        if (ch == LF) {
          UPDATE_STATE(s_header_field_start);
          break;
        }

        /* XXX allow spaces after digit? */

        if (UNLIKELY(!IS_NUM(ch))) {
          SET_ERRNO(HPE_INVALID_VERSION);
          goto error;
        }

        parser->http_minor *= 10;
        parser->http_minor += ch - '0';

        if (UNLIKELY(parser->http_minor > 999)) {
          SET_ERRNO(HPE_INVALID_VERSION);
          goto error;
        }

        break;
      }

      /* end of request line */
      case s_req_line_almost_done:
      {
        if (UNLIKELY(ch != LF)) {
          SET_ERRNO(HPE_LF_EXPECTED);
          goto error;
        }

        UPDATE_STATE(s_header_field_start);
        break;
      }

      case s_header_field_start:
      {
        if (ch == CR) {
          UPDATE_STATE(s_headers_almost_done);
          break;
        }

        if (ch == LF) {
          /* they might be just sending \n instead of \r\n so this would be
           * the second \n to denote the end of headers*/
          UPDATE_STATE(s_headers_almost_done);
          REEXECUTE();
        }

        c = TOKEN(ch);

        if (UNLIKELY(!c)) {
          SET_ERRNO(HPE_INVALID_HEADER_TOKEN);
          goto error;
        }

        MARK(header_field);

        parser->index = 0;
        UPDATE_STATE(s_header_field);

        switch (c) {
          case 'c':
            parser->header_state = h_C;
            break;

          case 'p':
            parser->header_state = h_matching_proxy_connection;
            break;

          case 't':
            parser->header_state = h_matching_transfer_encoding;
            break;

          case 'u':
            parser->header_state = h_matching_upgrade;
            break;

          default:
            parser->header_state = h_general;
            break;
        }
        break;
      }

      case s_header_field:
      {
        const char* start = p;
        for (; p != data + len; p++) {
          ch = *p;
          c = TOKEN(ch);

          if (!c)
            break;

          switch (parser->header_state) {
            case h_general:
              break;

            case h_C:
              parser->index++;
              parser->header_state = (c == 'o' ? h_CO : h_general);
              break;

            case h_CO:
              parser->index++;
              parser->header_state = (c == 'n' ? h_CON : h_general);
              break;

            case h_CON:
              parser->index++;
              switch (c) {
                case 'n':
                  parser->header_state = h_matching_connection;
                  break;
                case 't':
                  parser->header_state = h_matching_content_length;
                  break;
                default:
                  parser->header_state = h_general;
                  break;
              }
              break;

            /* connection */

            case h_matching_connection:
              parser->index++;
              if (parser->index > sizeof(CONNECTION)-1
                  || c != CONNECTION[parser->index]) {
                parser->header_state = h_general;
              } else if (parser->index == sizeof(CONNECTION)-2) {
                parser->header_state = h_connection;
              }
              break;

            /* proxy-connection */

            case h_matching_proxy_connection:
              parser->index++;
              if (parser->index > sizeof(PROXY_CONNECTION)-1
                  || c != PROXY_CONNECTION[parser->index]) {
                parser->header_state = h_general;
              } else if (parser->index == sizeof(PROXY_CONNECTION)-2) {
                parser->header_state = h_connection;
              }
              break;

            /* content-length */

            case h_matching_content_length:
              parser->index++;
              if (parser->index > sizeof(CONTENT_LENGTH)-1
                  || c != CONTENT_LENGTH[parser->index]) {
                parser->header_state = h_general;
              } else if (parser->index == sizeof(CONTENT_LENGTH)-2) {
                if (parser->flags & F_CONTENTLENGTH) {
                  SET_ERRNO(HPE_UNEXPECTED_CONTENT_LENGTH);
                  goto error;
                }
                parser->header_state = h_content_length;
                parser->flags |= F_CONTENTLENGTH;
              }
              break;

            /* transfer-encoding */

            case h_matching_transfer_encoding:
              parser->index++;
              if (parser->index > sizeof(TRANSFER_ENCODING)-1
                  || c != TRANSFER_ENCODING[parser->index]) {
                parser->header_state = h_general;
              } else if (parser->index == sizeof(TRANSFER_ENCODING)-2) {
                parser->header_state = h_transfer_encoding;
              }
              break;

            /* upgrade */

            case h_matching_upgrade:
              parser->index++;
              if (parser->index > sizeof(UPGRADE)-1
                  || c != UPGRADE[parser->index]) {
                parser->header_state = h_general;
              } else if (parser->index == sizeof(UPGRADE)-2) {
                parser->header_state = h_upgrade;
              }
              break;

            case h_connection:
            case h_content_length:
            case h_transfer_encoding:
            case h_upgrade:
              if (ch != ' ') parser->header_state = h_general;
              break;

            default:
              assert(0 && "Unknown header_state");
              break;
          }
        }

        COUNT_HEADER_SIZE(p - start);

        if (p == data + len) {
          --p;
          break;
        }

        if (ch == ':') {
          UPDATE_STATE(s_header_value_discard_ws);
          CALLBACK_DATA(header_field);
          break;
        }

        SET_ERRNO(HPE_INVALID_HEADER_TOKEN);
        goto error;
      }

      case s_header_value_discard_ws:
        if (ch == ' ' || ch == '\t') break;

        if (ch == CR) {
          UPDATE_STATE(s_header_value_discard_ws_almost_done);
          break;
        }

        if (ch == LF) {
          UPDATE_STATE(s_header_value_discard_lws);
          break;
        }

        /* FALLTHROUGH */

      case s_header_value_start:
      {
        MARK(header_value);

        UPDATE_STATE(s_header_value);
        parser->index = 0;

        c = LOWER(ch);

        switch (parser->header_state) {
          case h_upgrade:
            parser->flags |= F_UPGRADE;
            parser->header_state = h_general;
            break;

          case h_transfer_encoding:
            /* looking for 'Transfer-Encoding: chunked' */
            if ('c' == c) {
              parser->header_state = h_matching_transfer_encoding_chunked;
            } else {
              parser->header_state = h_general;
            }
            break;

          case h_content_length:
            if (UNLIKELY(!IS_NUM(ch))) {
              SET_ERRNO(HPE_INVALID_CONTENT_LENGTH);
              goto error;
            }

            parser->content_length = ch - '0';
            break;

          case h_connection:
            /* looking for 'Connection: keep-alive' */
            if (c == 'k') {
              parser->header_state = h_matching_connection_keep_alive;
            /* looking for 'Connection: close' */
            } else if (c == 'c') {
              parser->header_state = h_matching_connection_close;
            } else if (c == 'u') {
              parser->header_state = h_matching_connection_upgrade;
            } else {
              parser->header_state = h_matching_connection_token;
            }
            break;

          /* Multi-value `Connection` header */
          case h_matching_connection_token_start:
            break;

          default:
            parser->header_state = h_general;
            break;
        }
        break;
      }

      case s_header_value:
      {
        const char* start = p;
        enum header_states h_state = (enum header_states) parser->header_state;
        for (; p != data + len; p++) {
          ch = *p;
          if (ch == CR) {
            UPDATE_STATE(s_header_almost_done);
            parser->header_state = h_state;
            CALLBACK_DATA(header_value);
            break;
          }

          if (ch == LF) {
            UPDATE_STATE(s_header_almost_done);
            COUNT_HEADER_SIZE(p - start);
            parser->header_state = h_state;
            CALLBACK_DATA_NOADVANCE(header_value);
            REEXECUTE();
          }

          if (!lenient && !IS_HEADER_CHAR(ch)) {
            SET_ERRNO(HPE_INVALID_HEADER_TOKEN);
            goto error;
          }

          c = LOWER(ch);

          switch (h_state) {
            case h_general:
            {
              const char* p_cr;
              const char* p_lf;
              size_t limit = data + len - p;

              limit = MIN(limit, HTTP_MAX_HEADER_SIZE);

              p_cr = (const char*) memchr(p, CR, limit);
              p_lf = (const char*) memchr(p, LF, limit);
              if (p_cr != NULL) {
                if (p_lf != NULL && p_cr >= p_lf)
                  p = p_lf;
                else
                  p = p_cr;
              } else if (UNLIKELY(p_lf != NULL)) {
                p = p_lf;
              } else {
                p = data + len;
              }
              --p;

              break;
            }

            case h_connection:
            case h_transfer_encoding:
              assert(0 && "Shouldn't get here.");
              break;

            case h_content_length:
            {
              uint64_t t;

              if (ch == ' ') break;

              if (UNLIKELY(!IS_NUM(ch))) {
                SET_ERRNO(HPE_INVALID_CONTENT_LENGTH);
                parser->header_state = h_state;
                goto error;
              }

              t = parser->content_length;
              t *= 10;
              t += ch - '0';

              /* Overflow? Test against a conservative limit for simplicity. */
              if (UNLIKELY((ULLONG_MAX - 10) / 10 < parser->content_length)) {
                SET_ERRNO(HPE_INVALID_CONTENT_LENGTH);
                parser->header_state = h_state;
                goto error;
              }

              parser->content_length = t;
              break;
            }

            /* Transfer-Encoding: chunked */
            case h_matching_transfer_encoding_chunked:
              parser->index++;
              if (parser->index > sizeof(CHUNKED)-1
                  || c != CHUNKED[parser->index]) {
                h_state = h_general;
              } else if (parser->index == sizeof(CHUNKED)-2) {
                h_state = h_transfer_encoding_chunked;
              }
              break;

            case h_matching_connection_token_start:
              /* looking for 'Connection: keep-alive' */
              if (c == 'k') {
                h_state = h_matching_connection_keep_alive;
              /* looking for 'Connection: close' */
              } else if (c == 'c') {
                h_state = h_matching_connection_close;
              } else if (c == 'u') {
                h_state = h_matching_connection_upgrade;
              } else if (STRICT_TOKEN(c)) {
                h_state = h_matching_connection_token;
              } else if (c == ' ' || c == '\t') {
                /* Skip lws */
              } else {
                h_state = h_general;
              }
              break;

            /* looking for 'Connection: keep-alive' */
            case h_matching_connection_keep_alive:
              parser->index++;
              if (parser->index > sizeof(KEEP_ALIVE)-1
                  || c != KEEP_ALIVE[parser->index]) {
                h_state = h_matching_connection_token;
              } else if (parser->index == sizeof(KEEP_ALIVE)-2) {
                h_state = h_connection_keep_alive;
              }
              break;

            /* looking for 'Connection: close' */
            case h_matching_connection_close:
              parser->index++;
              if (parser->index > sizeof(CLOSE)-1 || c != CLOSE[parser->index]) {
                h_state = h_matching_connection_token;
              } else if (parser->index == sizeof(CLOSE)-2) {
                h_state = h_connection_close;
              }
              break;

            /* looking for 'Connection: upgrade' */
            case h_matching_connection_upgrade:
              parser->index++;
              if (parser->index > sizeof(UPGRADE) - 1 ||
                  c != UPGRADE[parser->index]) {
                h_state = h_matching_connection_token;
              } else if (parser->index == sizeof(UPGRADE)-2) {
                h_state = h_connection_upgrade;
              }
              break;

            case h_matching_connection_token:
              if (ch == ',') {
                h_state = h_matching_connection_token_start;
                parser->index = 0;
              }
              break;

            case h_transfer_encoding_chunked:
              if (ch != ' ') h_state = h_general;
              break;

            case h_connection_keep_alive:
            case h_connection_close:
            case h_connection_upgrade:
              if (ch == ',') {
                if (h_state == h_connection_keep_alive) {
                  parser->flags |= F_CONNECTION_KEEP_ALIVE;
                } else if (h_state == h_connection_close) {
                  parser->flags |= F_CONNECTION_CLOSE;
                } else if (h_state == h_connection_upgrade) {
                  parser->flags |= F_CONNECTION_UPGRADE;
                }
                h_state = h_matching_connection_token_start;
                parser->index = 0;
              } else if (ch != ' ') {
                h_state = h_matching_connection_token;
              }
              break;

            default:
              UPDATE_STATE(s_header_value);
              h_state = h_general;
              break;
          }
        }
        parser->header_state = h_state;

        COUNT_HEADER_SIZE(p - start);

        if (p == data + len)
          --p;
        break;
      }

      case s_header_almost_done:
      {
        if (UNLIKELY(ch != LF)) {
          SET_ERRNO(HPE_LF_EXPECTED);
          goto error;
        }

        UPDATE_STATE(s_header_value_lws);
        break;
      }

      case s_header_value_lws:
      {
        if (ch == ' ' || ch == '\t') {
          UPDATE_STATE(s_header_value_start);
          REEXECUTE();
        }

        /* finished the header */
        switch (parser->header_state) {
          case h_connection_keep_alive:
            parser->flags |= F_CONNECTION_KEEP_ALIVE;
            break;
          case h_connection_close:
            parser->flags |= F_CONNECTION_CLOSE;
            break;
          case h_transfer_encoding_chunked:
            parser->flags |= F_CHUNKED;
            break;
          case h_connection_upgrade:
            parser->flags |= F_CONNECTION_UPGRADE;
            break;
          default:
            break;
        }

        UPDATE_STATE(s_header_field_start);
        REEXECUTE();
      }

      case s_header_value_discard_ws_almost_done:
      {
        STRICT_CHECK(ch != LF);
        UPDATE_STATE(s_header_value_discard_lws);
        break;
      }

      case s_header_value_discard_lws:
      {
        if (ch == ' ' || ch == '\t') {
          UPDATE_STATE(s_header_value_discard_ws);
          break;
        } else {
          switch (parser->header_state) {
            case h_connection_keep_alive:
              parser->flags |= F_CONNECTION_KEEP_ALIVE;
              break;
            case h_connection_close:
              parser->flags |= F_CONNECTION_CLOSE;
              break;
            case h_connection_upgrade:
              parser->flags |= F_CONNECTION_UPGRADE;
              break;
            case h_transfer_encoding_chunked:
              parser->flags |= F_CHUNKED;
              break;
            default:
              break;
          }

          /* header value was empty */
          MARK(header_value);
          UPDATE_STATE(s_header_field_start);
          CALLBACK_DATA_NOADVANCE(header_value);
          REEXECUTE();
        }
      }

      case s_headers_almost_done:
      {
        STRICT_CHECK(ch != LF);

        if (parser->flags & F_TRAILING) {
          /* End of a chunked request */
          UPDATE_STATE(s_message_done);
          CALLBACK_NOTIFY_NOADVANCE(chunk_complete);
          REEXECUTE();
        }

        /* Cannot use chunked encoding and a content-length header together
           per the HTTP specification. */
        if ((parser->flags & F_CHUNKED) &&
            (parser->flags & F_CONTENTLENGTH)) {
          SET_ERRNO(HPE_UNEXPECTED_CONTENT_LENGTH);
          goto error;
        }

        UPDATE_STATE(s_headers_done);

        /* Set this here so that on_headers_complete() callbacks can see it */
        parser->upgrade =
          ((parser->flags & (F_UPGRADE | F_CONNECTION_UPGRADE)) ==
           (F_UPGRADE | F_CONNECTION_UPGRADE) ||
           parser->method == HTTP_CONNECT);

        /* Here we call the headers_complete callback. This is somewhat
         * different than other callbacks because if the user returns 1, we
         * will interpret that as saying that this message has no body. This
         * is needed for the annoying case of recieving a response to a HEAD
         * request.
         *
         * We'd like to use CALLBACK_NOTIFY_NOADVANCE() here but we cannot, so
         * we have to simulate it by handling a change in errno below.
         */
        if (settings->on_headers_complete) {
          switch (settings->on_headers_complete(parser)) {
            case 0:
              break;

            case 2:
              parser->upgrade = 1;

            case 1:
              parser->flags |= F_SKIPBODY;
              break;

            default:
              SET_ERRNO(HPE_CB_headers_complete);
              RETURN(p - data); /* Error */
          }
        }

        if (HTTP_PARSER_ERRNO(parser) != HPE_OK) {
          RETURN(p - data);
        }

        REEXECUTE();
      }

      case s_headers_done:
      {
        int hasBody;
        STRICT_CHECK(ch != LF);

        parser->nread = 0;

        hasBody = parser->flags & F_CHUNKED ||
          (parser->content_length > 0 && parser->content_length != ULLONG_MAX);
        if (parser->upgrade && (parser->method == HTTP_CONNECT ||
                                (parser->flags & F_SKIPBODY) || !hasBody)) {
          /* Exit, the rest of the message is in a different protocol. */
          UPDATE_STATE(NEW_MESSAGE());
          CALLBACK_NOTIFY(message_complete);
          RETURN((p - data) + 1);
        }

        if (parser->flags & F_SKIPBODY) {
          UPDATE_STATE(NEW_MESSAGE());
          CALLBACK_NOTIFY(message_complete);
        } else if (parser->flags & F_CHUNKED) {
          /* chunked encoding - ignore Content-Length header */
          UPDATE_STATE(s_chunk_size_start);
        } else {
          if (parser->content_length == 0) {
            /* Content-Length header given but zero: Content-Length: 0\r\n */
            UPDATE_STATE(NEW_MESSAGE());
            CALLBACK_NOTIFY(message_complete);
          } else if (parser->content_length != ULLONG_MAX) {
            /* Content-Length header given and non-zero */
            UPDATE_STATE(s_body_identity);
          } else {
            if (!http_message_needs_eof(parser)) {
              /* Assume content-length 0 - read the next */
              UPDATE_STATE(NEW_MESSAGE());
              CALLBACK_NOTIFY(message_complete);
            } else {
              /* Read body until EOF */
              UPDATE_STATE(s_body_identity_eof);
            }
          }
        }

        break;
      }

      case s_body_identity:
      {
        uint64_t to_read = MIN(parser->content_length,
                               (uint64_t) ((data + len) - p));

        assert(parser->content_length != 0
            && parser->content_length != ULLONG_MAX);

        /* The difference between advancing content_length and p is because
         * the latter will automaticaly advance on the next loop iteration.
         * Further, if content_length ends up at 0, we want to see the last
         * byte again for our message complete callback.
         */
        MARK(body);
        parser->content_length -= to_read;
        p += to_read - 1;

        if (parser->content_length == 0) {
          UPDATE_STATE(s_message_done);

          /* Mimic CALLBACK_DATA_NOADVANCE() but with one extra byte.
           *
           * The alternative to doing this is to wait for the next byte to
           * trigger the data callback, just as in every other case. The
           * problem with this is that this makes it difficult for the test
           * harness to distinguish between complete-on-EOF and
           * complete-on-length. It's not clear that this distinction is
           * important for applications, but let's keep it for now.
           */
          CALLBACK_DATA_(body, p - body_mark + 1, p - data);
          REEXECUTE();
        }

        break;
      }

      /* read until EOF */
      case s_body_identity_eof:
        MARK(body);
        p = data + len - 1;

        break;

      case s_message_done:
        UPDATE_STATE(NEW_MESSAGE());
        CALLBACK_NOTIFY(message_complete);
        if (parser->upgrade) {
          /* Exit, the rest of the message is in a different protocol. */
          RETURN((p - data) + 1);
        }
        break;

      case s_chunk_size_start:
      {
        assert(parser->nread == 1);
        assert(parser->flags & F_CHUNKED);

        unhex_val = unhex[(unsigned char)ch];
        if (UNLIKELY(unhex_val == -1)) {
          SET_ERRNO(HPE_INVALID_CHUNK_SIZE);
          goto error;
        }

        parser->content_length = unhex_val;
        UPDATE_STATE(s_chunk_size);
        break;
      }

      case s_chunk_size:
      {
        uint64_t t;

        assert(parser->flags & F_CHUNKED);

        if (ch == CR) {
          UPDATE_STATE(s_chunk_size_almost_done);
          break;
        }

        unhex_val = unhex[(unsigned char)ch];

        if (unhex_val == -1) {
          if (ch == ';' || ch == ' ') {
            UPDATE_STATE(s_chunk_parameters);
            break;
          }

          SET_ERRNO(HPE_INVALID_CHUNK_SIZE);
          goto error;
        }

        t = parser->content_length;
        t *= 16;
        t += unhex_val;

        /* Overflow? Test against a conservative limit for simplicity. */
        if (UNLIKELY((ULLONG_MAX - 16) / 16 < parser->content_length)) {
          SET_ERRNO(HPE_INVALID_CONTENT_LENGTH);
          goto error;
        }

        parser->content_length = t;
        break;
      }

      case s_chunk_parameters:
      {
        assert(parser->flags & F_CHUNKED);
        /* just ignore this shit. TODO check for overflow */
        if (ch == CR) {
          UPDATE_STATE(s_chunk_size_almost_done);
          break;
        }
        break;
      }

      case s_chunk_size_almost_done:
      {
        assert(parser->flags & F_CHUNKED);
        STRICT_CHECK(ch != LF);

        parser->nread = 0;

        if (parser->content_length == 0) {
          parser->flags |= F_TRAILING;
          UPDATE_STATE(s_header_field_start);
        } else {
          UPDATE_STATE(s_chunk_data);
        }
        CALLBACK_NOTIFY(chunk_header);
        break;
      }

      case s_chunk_data:
      {
        uint64_t to_read = MIN(parser->content_length,
                               (uint64_t) ((data + len) - p));

        assert(parser->flags & F_CHUNKED);
        assert(parser->content_length != 0
            && parser->content_length != ULLONG_MAX);

        /* See the explanation in s_body_identity for why the content
         * length and data pointers are managed this way.
         */
        MARK(body);
        parser->content_length -= to_read;
        p += to_read - 1;

        if (parser->content_length == 0) {
          UPDATE_STATE(s_chunk_data_almost_done);
        }

        break;
      }

      case s_chunk_data_almost_done:
        assert(parser->flags & F_CHUNKED);
        assert(parser->content_length == 0);
        STRICT_CHECK(ch != CR);
        UPDATE_STATE(s_chunk_data_done);
        CALLBACK_DATA(body);
        break;

      case s_chunk_data_done:
        assert(parser->flags & F_CHUNKED);
        STRICT_CHECK(ch != LF);
        parser->nread = 0;
        UPDATE_STATE(s_chunk_size_start);
        CALLBACK_NOTIFY(chunk_complete);
        break;

      default:
        assert(0 && "unhandled state");
        SET_ERRNO(HPE_INVALID_INTERNAL_STATE);
        goto error;
    }
  }

  /* Run callbacks for any marks that we have leftover after we ran our of
   * bytes. There should be at most one of these set, so it's OK to invoke
   * them in series (unset marks will not result in callbacks).
   *
   * We use the NOADVANCE() variety of callbacks here because 'p' has already
   * overflowed 'data' and this allows us to correct for the off-by-one that
   * we'd otherwise have (since CALLBACK_DATA() is meant to be run with a 'p'
   * value that's in-bounds).
   */

  assert(((header_field_mark ? 1 : 0) +
          (header_value_mark ? 1 : 0) +
          (url_mark ? 1 : 0)  +
          (body_mark ? 1 : 0) +
          (status_mark ? 1 : 0)) <= 1);

  CALLBACK_DATA_NOADVANCE(header_field);
  CALLBACK_DATA_NOADVANCE(header_value);
  CALLBACK_DATA_NOADVANCE(url);
  CALLBACK_DATA_NOADVANCE(body);
  CALLBACK_DATA_NOADVANCE(status);

  RETURN(len);

error:
  if (HTTP_PARSER_ERRNO(parser) == HPE_OK) {
    SET_ERRNO(HPE_UNKNOWN);
  }

  RETURN(p - data);
}


/* Does the parser need to see an EOF to find the end of the message? */
int
http_message_needs_eof (const http_parser *parser)
{
  if (parser->type == HTTP_REQUEST) {
    return 0;
  }

  /* See RFC 2616 section 4.4 */
  if (parser->status_code / 100 == 1 || /* 1xx e.g. Continue */
      parser->status_code == 204 ||     /* No Content */
      parser->status_code == 304 ||     /* Not Modified */
      parser->flags & F_SKIPBODY) {     /* response to a HEAD request */
    return 0;
  }

  if ((parser->flags & F_CHUNKED) || parser->content_length != ULLONG_MAX) {
    return 0;
  }

  return 1;
}


int
http_should_keep_alive (const http_parser *parser)
{
  if (parser->http_major > 0 && parser->http_minor > 0) {
    /* HTTP/1.1 */
    if (parser->flags & F_CONNECTION_CLOSE) {
      return 0;
    }
  } else {
    /* HTTP/1.0 or earlier */
    if (!(parser->flags & F_CONNECTION_KEEP_ALIVE)) {
      return 0;
    }
  }

  return !http_message_needs_eof(parser);
}


const char *
http_method_str (enum http_method m)
{
  return ELEM_AT(method_strings, m, "");
}


void
http_parser_init (http_parser *parser, enum http_parser_type t)
{
  void *data = parser->data; /* preserve application data */
  memset(parser, 0, sizeof(*parser));
  parser->data = data;
  parser->type = t;
  parser->state = (t == HTTP_REQUEST ? s_start_req : (t == HTTP_RESPONSE ? s_start_res : s_start_req_or_res));
  parser->http_errno = HPE_OK;
}

void
http_parser_settings_init(http_parser_settings *settings)
{
  memset(settings, 0, sizeof(*settings));
}

const char *
http_errno_name(enum http_errno err) {
  assert(((size_t) err) < ARRAY_SIZE(http_strerror_tab));
  return http_strerror_tab[err].name;
}

const char *
http_errno_description(enum http_errno err) {
  assert(((size_t) err) < ARRAY_SIZE(http_strerror_tab));
  return http_strerror_tab[err].description;
}

static enum http_host_state
http_parse_host_char(enum http_host_state s, const char ch) {
  switch(s) {
    case s_http_userinfo:
    case s_http_userinfo_start:
      if (ch == '@') {
        return s_http_host_start;
      }

      if (IS_USERINFO_CHAR(ch)) {
        return s_http_userinfo;
      }
      break;

    case s_http_host_start:
      if (ch == '[') {
        return s_http_host_v6_start;
      }

      if (IS_HOST_CHAR(ch)) {
        return s_http_host;
      }

      break;

    case s_http_host:
      if (IS_HOST_CHAR(ch)) {
        return s_http_host;
      }

    /* FALLTHROUGH */
    case s_http_host_v6_end:
      if (ch == ':') {
        return s_http_host_port_start;
      }

      break;

    case s_http_host_v6:
      if (ch == ']') {
        return s_http_host_v6_end;
      }

    /* FALLTHROUGH */
    case s_http_host_v6_start:
      if (IS_HEX(ch) || ch == ':' || ch == '.') {
        return s_http_host_v6;
      }

      if (s == s_http_host_v6 && ch == '%') {
        return s_http_host_v6_zone_start;
      }
      break;

    case s_http_host_v6_zone:
      if (ch == ']') {
        return s_http_host_v6_end;
      }

    /* FALLTHROUGH */
    case s_http_host_v6_zone_start:
      /* RFC 6874 Zone ID consists of 1*( unreserved / pct-encoded) */
      if (IS_ALPHANUM(ch) || ch == '%' || ch == '.' || ch == '-' || ch == '_' ||
          ch == '~') {
        return s_http_host_v6_zone;
      }
      break;

    case s_http_host_port:
    case s_http_host_port_start:
      if (IS_NUM(ch)) {
        return s_http_host_port;
      }

      break;

    default:
      break;
  }
  return s_http_host_dead;
}

static int
http_parse_host(const char * buf, struct http_parser_url *u, int found_at) {
  enum http_host_state s;

  const char *p;
  size_t buflen = u->field_data[UF_HOST].off + u->field_data[UF_HOST].len;

  assert(u->field_set & (1 << UF_HOST));

  u->field_data[UF_HOST].len = 0;

  s = found_at ? s_http_userinfo_start : s_http_host_start;

  for (p = buf + u->field_data[UF_HOST].off; p < buf + buflen; p++) {
    enum http_host_state new_s = http_parse_host_char(s, *p);

    if (new_s == s_http_host_dead) {
      return 1;
    }

    switch(new_s) {
      case s_http_host:
        if (s != s_http_host) {
          u->field_data[UF_HOST].off = p - buf;
        }
        u->field_data[UF_HOST].len++;
        break;

      case s_http_host_v6:
        if (s != s_http_host_v6) {
          u->field_data[UF_HOST].off = p - buf;
        }
        u->field_data[UF_HOST].len++;
        break;

      case s_http_host_v6_zone_start:
      case s_http_host_v6_zone:
        u->field_data[UF_HOST].len++;
        break;

      case s_http_host_port:
        if (s != s_http_host_port) {
          u->field_data[UF_PORT].off = p - buf;
          u->field_data[UF_PORT].len = 0;
          u->field_set |= (1 << UF_PORT);
        }
        u->field_data[UF_PORT].len++;
        break;

      case s_http_userinfo:
        if (s != s_http_userinfo) {
          u->field_data[UF_USERINFO].off = p - buf ;
          u->field_data[UF_USERINFO].len = 0;
          u->field_set |= (1 << UF_USERINFO);
        }
        u->field_data[UF_USERINFO].len++;
        break;

      default:
        break;
    }
    s = new_s;
  }

  /* Make sure we don't end somewhere unexpected */
  switch (s) {
    case s_http_host_start:
    case s_http_host_v6_start:
    case s_http_host_v6:
    case s_http_host_v6_zone_start:
    case s_http_host_v6_zone:
    case s_http_host_port_start:
    case s_http_userinfo:
    case s_http_userinfo_start:
      return 1;
    default:
      break;
  }

  return 0;
}

void
http_parser_url_init(struct http_parser_url *u) {
  memset(u, 0, sizeof(*u));
}

int
http_parser_parse_url(const char *buf, size_t buflen, int is_connect,
                      struct http_parser_url *u)
{
  enum state s;
  const char *p;
  enum http_parser_url_fields uf, old_uf;
  int found_at = 0;

  u->port = u->field_set = 0;
  s = is_connect ? s_req_server_start : s_req_spaces_before_url;
  old_uf = UF_MAX;

  for (p = buf; p < buf + buflen; p++) {
    s = parse_url_char(s, *p);

    /* Figure out the next field that we're operating on */
    switch (s) {
      case s_dead:
        return 1;

      /* Skip delimeters */
      case s_req_schema_slash:
      case s_req_schema_slash_slash:
      case s_req_server_start:
      case s_req_query_string_start:
      case s_req_fragment_start:
        continue;

      case s_req_schema:
        uf = UF_SCHEMA;
        break;

      case s_req_server_with_at:
        found_at = 1;

      /* FALLTROUGH */
      case s_req_server:
        uf = UF_HOST;
        break;

      case s_req_path:
        uf = UF_PATH;
        break;

      case s_req_query_string:
        uf = UF_QUERY;
        break;

      case s_req_fragment:
        uf = UF_FRAGMENT;
        break;

      default:
        assert(!"Unexpected state");
        return 1;
    }

    /* Nothing's changed; soldier on */
    if (uf == old_uf) {
      u->field_data[uf].len++;
      continue;
    }

    u->field_data[uf].off = p - buf;
    u->field_data[uf].len = 1;

    u->field_set |= (1 << uf);
    old_uf = uf;
  }

  /* host must be present if there is a schema */
  /* parsing http:///toto will fail */
  if ((u->field_set & (1 << UF_SCHEMA)) &&
      (u->field_set & (1 << UF_HOST)) == 0) {
    return 1;
  }

  if (u->field_set & (1 << UF_HOST)) {
    if (http_parse_host(buf, u, found_at) != 0) {
      return 1;
    }
  }

  /* CONNECT requests can only contain "hostname:port" */
  if (is_connect && u->field_set != ((1 << UF_HOST)|(1 << UF_PORT))) {
    return 1;
  }

  if (u->field_set & (1 << UF_PORT)) {
    /* Don't bother with endp; we've already validated the string */
    unsigned long v = strtoul(buf + u->field_data[UF_PORT].off, NULL, 10);

    /* Ports have a max value of 2^16 */
    if (v > 0xffff) {
      return 1;
    }

    u->port = (uint16_t) v;
  }

  return 0;
}

void
http_parser_pause(http_parser *parser, int paused) {
  /* Users should only be pausing/unpausing a parser that is not in an error
   * state. In non-debug builds, there's not much that we can do about this
   * other than ignore it.
   */
  if (HTTP_PARSER_ERRNO(parser) == HPE_OK ||
      HTTP_PARSER_ERRNO(parser) == HPE_PAUSED) {
    SET_ERRNO((paused) ? HPE_PAUSED : HPE_OK);
  } else {
    assert(0 && "Attempting to pause parser in error state");
  }
}

int
http_body_is_final(const struct http_parser *parser) {
    return parser->state == s_message_done;
}

unsigned long
http_parser_version(void) {
  return HTTP_PARSER_VERSION_MAJOR * 0x10000 |
         HTTP_PARSER_VERSION_MINOR * 0x00100 |
         HTTP_PARSER_VERSION_PATCH * 0x00001;
}
node-v4.8.2/deps/http_parser/http_parser.gyp000644 000766 000024 00000005447 13070706730 021327 0ustar00iojsstaff000000 000000 # This file is used with the GYP meta build system.
# http://code.google.com/p/gyp/
# To build try this:
#   svn co http://gyp.googlecode.com/svn/trunk gyp
#   ./gyp/gyp -f make --depth=`pwd` http_parser.gyp 
#   ./out/Debug/test 
{
  'target_defaults': {
    'default_configuration': 'Debug',
    'configurations': {
      # TODO: hoist these out and put them somewhere common, because
      #       RuntimeLibrary MUST MATCH across the entire project
      'Debug': {
        'defines': [ 'DEBUG', '_DEBUG' ],
        'cflags': [ '-Wall', '-Wextra', '-O0', '-g', '-ftrapv' ],
        'msvs_settings': {
          'VCCLCompilerTool': {
            'RuntimeLibrary': 1, # static debug
          },
        },
      },
      'Release': {
        'defines': [ 'NDEBUG' ],
        'cflags': [ '-Wall', '-Wextra', '-O3' ],
        'msvs_settings': {
          'VCCLCompilerTool': {
            'RuntimeLibrary': 0, # static release
          },
        },
      }
    },
    'msvs_settings': {
      'VCCLCompilerTool': {
      },
      'VCLibrarianTool': {
      },
      'VCLinkerTool': {
        'GenerateDebugInformation': 'true',
      },
    },
    'conditions': [
      ['OS == "win"', {
        'defines': [
          'WIN32'
        ],
      }]
    ],
  },

  'targets': [
    {
      'target_name': 'http_parser',
      'type': 'static_library',
      'include_dirs': [ '.' ],
      'direct_dependent_settings': {
        'defines': [ 'HTTP_PARSER_STRICT=0' ],
        'include_dirs': [ '.' ],
      },
      'defines': [ 'HTTP_PARSER_STRICT=0' ],
      'sources': [ './http_parser.c', ],
      'conditions': [
        ['OS=="win"', {
          'msvs_settings': {
            'VCCLCompilerTool': {
              # Compile as C++. http_parser.c is actually C99, but C++ is
              # close enough in this case.
              'CompileAs': 2,
            },
          },
        }]
      ],
    },

    {
      'target_name': 'http_parser_strict',
      'type': 'static_library',
      'include_dirs': [ '.' ],
      'direct_dependent_settings': {
        'defines': [ 'HTTP_PARSER_STRICT=1' ],
        'include_dirs': [ '.' ],
      },
      'defines': [ 'HTTP_PARSER_STRICT=1' ],
      'sources': [ './http_parser.c', ],
      'conditions': [
        ['OS=="win"', {
          'msvs_settings': {
            'VCCLCompilerTool': {
              # Compile as C++. http_parser.c is actually C99, but C++ is
              # close enough in this case.
              'CompileAs': 2,
            },
          },
        }]
      ],
    },

    {
      'target_name': 'test-nonstrict',
      'type': 'executable',
      'dependencies': [ 'http_parser' ],
      'sources': [ 'test.c' ]
    },

    {
      'target_name': 'test-strict',
      'type': 'executable',
      'dependencies': [ 'http_parser_strict' ],
      'sources': [ 'test.c' ]
    }
  ]
}
node-v4.8.2/deps/http_parser/http_parser.h000644 000766 000024 00000033101 13070706730 020743 0ustar00iojsstaff000000 000000 /* Copyright Joyent, Inc. and other Node contributors. All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */
#ifndef http_parser_h
#define http_parser_h
#ifdef __cplusplus
extern "C" {
#endif

/* Also update SONAME in the Makefile whenever you change these. */
#define HTTP_PARSER_VERSION_MAJOR 2
#define HTTP_PARSER_VERSION_MINOR 7
#define HTTP_PARSER_VERSION_PATCH 0

#include 
#if defined(_WIN32) && !defined(__MINGW32__) && \
  (!defined(_MSC_VER) || _MSC_VER<1600) && !defined(__WINE__)
#include 
#include 
typedef __int8 int8_t;
typedef unsigned __int8 uint8_t;
typedef __int16 int16_t;
typedef unsigned __int16 uint16_t;
typedef __int32 int32_t;
typedef unsigned __int32 uint32_t;
typedef __int64 int64_t;
typedef unsigned __int64 uint64_t;
#else
#include 
#endif

/* Compile with -DHTTP_PARSER_STRICT=0 to make less checks, but run
 * faster
 */
#ifndef HTTP_PARSER_STRICT
# define HTTP_PARSER_STRICT 1
#endif

/* Maximium header size allowed. If the macro is not defined
 * before including this header then the default is used. To
 * change the maximum header size, define the macro in the build
 * environment (e.g. -DHTTP_MAX_HEADER_SIZE=). To remove
 * the effective limit on the size of the header, define the macro
 * to a very large number (e.g. -DHTTP_MAX_HEADER_SIZE=0x7fffffff)
 */
#ifndef HTTP_MAX_HEADER_SIZE
# define HTTP_MAX_HEADER_SIZE (80*1024)
#endif

typedef struct http_parser http_parser;
typedef struct http_parser_settings http_parser_settings;


/* Callbacks should return non-zero to indicate an error. The parser will
 * then halt execution.
 *
 * The one exception is on_headers_complete. In a HTTP_RESPONSE parser
 * returning '1' from on_headers_complete will tell the parser that it
 * should not expect a body. This is used when receiving a response to a
 * HEAD request which may contain 'Content-Length' or 'Transfer-Encoding:
 * chunked' headers that indicate the presence of a body.
 *
 * Returning `2` from on_headers_complete will tell parser that it should not
 * expect neither a body nor any futher responses on this connection. This is
 * useful for handling responses to a CONNECT request which may not contain
 * `Upgrade` or `Connection: upgrade` headers.
 *
 * http_data_cb does not return data chunks. It will be called arbitrarily
 * many times for each string. E.G. you might get 10 callbacks for "on_url"
 * each providing just a few characters more data.
 */
typedef int (*http_data_cb) (http_parser*, const char *at, size_t length);
typedef int (*http_cb) (http_parser*);


/* Request Methods */
#define HTTP_METHOD_MAP(XX)         \
  XX(0,  DELETE,      DELETE)       \
  XX(1,  GET,         GET)          \
  XX(2,  HEAD,        HEAD)         \
  XX(3,  POST,        POST)         \
  XX(4,  PUT,         PUT)          \
  /* pathological */                \
  XX(5,  CONNECT,     CONNECT)      \
  XX(6,  OPTIONS,     OPTIONS)      \
  XX(7,  TRACE,       TRACE)        \
  /* WebDAV */                      \
  XX(8,  COPY,        COPY)         \
  XX(9,  LOCK,        LOCK)         \
  XX(10, MKCOL,       MKCOL)        \
  XX(11, MOVE,        MOVE)         \
  XX(12, PROPFIND,    PROPFIND)     \
  XX(13, PROPPATCH,   PROPPATCH)    \
  XX(14, SEARCH,      SEARCH)       \
  XX(15, UNLOCK,      UNLOCK)       \
  XX(16, BIND,        BIND)         \
  XX(17, REBIND,      REBIND)       \
  XX(18, UNBIND,      UNBIND)       \
  XX(19, ACL,         ACL)          \
  /* subversion */                  \
  XX(20, REPORT,      REPORT)       \
  XX(21, MKACTIVITY,  MKACTIVITY)   \
  XX(22, CHECKOUT,    CHECKOUT)     \
  XX(23, MERGE,       MERGE)        \
  /* upnp */                        \
  XX(24, MSEARCH,     M-SEARCH)     \
  XX(25, NOTIFY,      NOTIFY)       \
  XX(26, SUBSCRIBE,   SUBSCRIBE)    \
  XX(27, UNSUBSCRIBE, UNSUBSCRIBE)  \
  /* RFC-5789 */                    \
  XX(28, PATCH,       PATCH)        \
  XX(29, PURGE,       PURGE)        \
  /* CalDAV */                      \
  XX(30, MKCALENDAR,  MKCALENDAR)   \
  /* RFC-2068, section 19.6.1.2 */  \
  XX(31, LINK,        LINK)         \
  XX(32, UNLINK,      UNLINK)       \

enum http_method
  {
#define XX(num, name, string) HTTP_##name = num,
  HTTP_METHOD_MAP(XX)
#undef XX
  };


enum http_parser_type { HTTP_REQUEST, HTTP_RESPONSE, HTTP_BOTH };


/* Flag values for http_parser.flags field */
enum flags
  { F_CHUNKED               = 1 << 0
  , F_CONNECTION_KEEP_ALIVE = 1 << 1
  , F_CONNECTION_CLOSE      = 1 << 2
  , F_CONNECTION_UPGRADE    = 1 << 3
  , F_TRAILING              = 1 << 4
  , F_UPGRADE               = 1 << 5
  , F_SKIPBODY              = 1 << 6
  , F_CONTENTLENGTH         = 1 << 7
  };


/* Map for errno-related constants
 *
 * The provided argument should be a macro that takes 2 arguments.
 */
#define HTTP_ERRNO_MAP(XX)                                           \
  /* No error */                                                     \
  XX(OK, "success")                                                  \
                                                                     \
  /* Callback-related errors */                                      \
  XX(CB_message_begin, "the on_message_begin callback failed")       \
  XX(CB_url, "the on_url callback failed")                           \
  XX(CB_header_field, "the on_header_field callback failed")         \
  XX(CB_header_value, "the on_header_value callback failed")         \
  XX(CB_headers_complete, "the on_headers_complete callback failed") \
  XX(CB_body, "the on_body callback failed")                         \
  XX(CB_message_complete, "the on_message_complete callback failed") \
  XX(CB_status, "the on_status callback failed")                     \
  XX(CB_chunk_header, "the on_chunk_header callback failed")         \
  XX(CB_chunk_complete, "the on_chunk_complete callback failed")     \
                                                                     \
  /* Parsing-related errors */                                       \
  XX(INVALID_EOF_STATE, "stream ended at an unexpected time")        \
  XX(HEADER_OVERFLOW,                                                \
     "too many header bytes seen; overflow detected")                \
  XX(CLOSED_CONNECTION,                                              \
     "data received after completed connection: close message")      \
  XX(INVALID_VERSION, "invalid HTTP version")                        \
  XX(INVALID_STATUS, "invalid HTTP status code")                     \
  XX(INVALID_METHOD, "invalid HTTP method")                          \
  XX(INVALID_URL, "invalid URL")                                     \
  XX(INVALID_HOST, "invalid host")                                   \
  XX(INVALID_PORT, "invalid port")                                   \
  XX(INVALID_PATH, "invalid path")                                   \
  XX(INVALID_QUERY_STRING, "invalid query string")                   \
  XX(INVALID_FRAGMENT, "invalid fragment")                           \
  XX(LF_EXPECTED, "LF character expected")                           \
  XX(INVALID_HEADER_TOKEN, "invalid character in header")            \
  XX(INVALID_CONTENT_LENGTH,                                         \
     "invalid character in content-length header")                   \
  XX(UNEXPECTED_CONTENT_LENGTH,                                      \
     "unexpected content-length header")                             \
  XX(INVALID_CHUNK_SIZE,                                             \
     "invalid character in chunk size header")                       \
  XX(INVALID_CONSTANT, "invalid constant string")                    \
  XX(INVALID_INTERNAL_STATE, "encountered unexpected internal state")\
  XX(STRICT, "strict mode assertion failed")                         \
  XX(PAUSED, "parser is paused")                                     \
  XX(UNKNOWN, "an unknown error occurred")


/* Define HPE_* values for each errno value above */
#define HTTP_ERRNO_GEN(n, s) HPE_##n,
enum http_errno {
  HTTP_ERRNO_MAP(HTTP_ERRNO_GEN)
};
#undef HTTP_ERRNO_GEN


/* Get an http_errno value from an http_parser */
#define HTTP_PARSER_ERRNO(p)            ((enum http_errno) (p)->http_errno)


struct http_parser {
  /** PRIVATE **/
  unsigned int type : 2;         /* enum http_parser_type */
  unsigned int flags : 8;        /* F_* values from 'flags' enum; semi-public */
  unsigned int state : 7;        /* enum state from http_parser.c */
  unsigned int header_state : 7; /* enum header_state from http_parser.c */
  unsigned int index : 7;        /* index into current matcher */
  unsigned int lenient_http_headers : 1;

  uint32_t nread;          /* # bytes read in various scenarios */
  uint64_t content_length; /* # bytes in body (0 if no Content-Length header) */

  /** READ-ONLY **/
  unsigned short http_major;
  unsigned short http_minor;
  unsigned int status_code : 16; /* responses only */
  unsigned int method : 8;       /* requests only */
  unsigned int http_errno : 7;

  /* 1 = Upgrade header was present and the parser has exited because of that.
   * 0 = No upgrade header present.
   * Should be checked when http_parser_execute() returns in addition to
   * error checking.
   */
  unsigned int upgrade : 1;

  /** PUBLIC **/
  void *data; /* A pointer to get hook to the "connection" or "socket" object */
};


struct http_parser_settings {
  http_cb      on_message_begin;
  http_data_cb on_url;
  http_data_cb on_status;
  http_data_cb on_header_field;
  http_data_cb on_header_value;
  http_cb      on_headers_complete;
  http_data_cb on_body;
  http_cb      on_message_complete;
  /* When on_chunk_header is called, the current chunk length is stored
   * in parser->content_length.
   */
  http_cb      on_chunk_header;
  http_cb      on_chunk_complete;
};


enum http_parser_url_fields
  { UF_SCHEMA           = 0
  , UF_HOST             = 1
  , UF_PORT             = 2
  , UF_PATH             = 3
  , UF_QUERY            = 4
  , UF_FRAGMENT         = 5
  , UF_USERINFO         = 6
  , UF_MAX              = 7
  };


/* Result structure for http_parser_parse_url().
 *
 * Callers should index into field_data[] with UF_* values iff field_set
 * has the relevant (1 << UF_*) bit set. As a courtesy to clients (and
 * because we probably have padding left over), we convert any port to
 * a uint16_t.
 */
struct http_parser_url {
  uint16_t field_set;           /* Bitmask of (1 << UF_*) values */
  uint16_t port;                /* Converted UF_PORT string */

  struct {
    uint16_t off;               /* Offset into buffer in which field starts */
    uint16_t len;               /* Length of run in buffer */
  } field_data[UF_MAX];
};


/* Returns the library version. Bits 16-23 contain the major version number,
 * bits 8-15 the minor version number and bits 0-7 the patch level.
 * Usage example:
 *
 *   unsigned long version = http_parser_version();
 *   unsigned major = (version >> 16) & 255;
 *   unsigned minor = (version >> 8) & 255;
 *   unsigned patch = version & 255;
 *   printf("http_parser v%u.%u.%u\n", major, minor, patch);
 */
unsigned long http_parser_version(void);

void http_parser_init(http_parser *parser, enum http_parser_type type);


/* Initialize http_parser_settings members to 0
 */
void http_parser_settings_init(http_parser_settings *settings);


/* Executes the parser. Returns number of parsed bytes. Sets
 * `parser->http_errno` on error. */
size_t http_parser_execute(http_parser *parser,
                           const http_parser_settings *settings,
                           const char *data,
                           size_t len);


/* If http_should_keep_alive() in the on_headers_complete or
 * on_message_complete callback returns 0, then this should be
 * the last message on the connection.
 * If you are the server, respond with the "Connection: close" header.
 * If you are the client, close the connection.
 */
int http_should_keep_alive(const http_parser *parser);

/* Returns a string version of the HTTP method. */
const char *http_method_str(enum http_method m);

/* Return a string name of the given error */
const char *http_errno_name(enum http_errno err);

/* Return a string description of the given error */
const char *http_errno_description(enum http_errno err);

/* Initialize all http_parser_url members to 0 */
void http_parser_url_init(struct http_parser_url *u);

/* Parse a URL; return nonzero on failure */
int http_parser_parse_url(const char *buf, size_t buflen,
                          int is_connect,
                          struct http_parser_url *u);

/* Pause or un-pause the parser; a nonzero value pauses */
void http_parser_pause(http_parser *parser, int paused);

/* Checks if this is the final chunk of the body. */
int http_body_is_final(const http_parser *parser);

#ifdef __cplusplus
}
#endif
#endif
node-v4.8.2/deps/http_parser/LICENSE-MIT000644 000766 000024 00000002343 13070706730 017677 0ustar00iojsstaff000000 000000 http_parser.c is based on src/http/ngx_http_parse.c from NGINX copyright
Igor Sysoev.

Additional changes are licensed under the same terms as NGINX and
copyright Joyent, Inc. and other Node contributors. All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to
deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
IN THE SOFTWARE. 
node-v4.8.2/deps/http_parser/Makefile000644 000766 000024 00000011301 13070706730 017675 0ustar00iojsstaff000000 000000 # Copyright Joyent, Inc. and other Node contributors. All rights reserved.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.

PLATFORM ?= $(shell sh -c 'uname -s | tr "[A-Z]" "[a-z]"')
HELPER ?=
BINEXT ?=
ifeq (darwin,$(PLATFORM))
SONAME ?= libhttp_parser.2.7.0.dylib
SOEXT ?= dylib
else ifeq (wine,$(PLATFORM))
CC = winegcc
BINEXT = .exe.so
HELPER = wine
else
SONAME ?= libhttp_parser.so.2.7.0
SOEXT ?= so
endif

CC?=gcc
AR?=ar

CPPFLAGS ?=
LDFLAGS ?=

CPPFLAGS += -I.
CPPFLAGS_DEBUG = $(CPPFLAGS) -DHTTP_PARSER_STRICT=1
CPPFLAGS_DEBUG += $(CPPFLAGS_DEBUG_EXTRA)
CPPFLAGS_FAST = $(CPPFLAGS) -DHTTP_PARSER_STRICT=0
CPPFLAGS_FAST += $(CPPFLAGS_FAST_EXTRA)
CPPFLAGS_BENCH = $(CPPFLAGS_FAST)

CFLAGS += -Wall -Wextra -Werror
CFLAGS_DEBUG = $(CFLAGS) -O0 -g $(CFLAGS_DEBUG_EXTRA)
CFLAGS_FAST = $(CFLAGS) -O3 $(CFLAGS_FAST_EXTRA)
CFLAGS_BENCH = $(CFLAGS_FAST) -Wno-unused-parameter
CFLAGS_LIB = $(CFLAGS_FAST) -fPIC

LDFLAGS_LIB = $(LDFLAGS) -shared

INSTALL ?= install
PREFIX ?= $(DESTDIR)/usr/local
LIBDIR = $(PREFIX)/lib
INCLUDEDIR = $(PREFIX)/include

ifneq (darwin,$(PLATFORM))
# TODO(bnoordhuis) The native SunOS linker expects -h rather than -soname...
LDFLAGS_LIB += -Wl,-soname=$(SONAME)
endif

test: test_g test_fast
	$(HELPER) ./test_g$(BINEXT)
	$(HELPER) ./test_fast$(BINEXT)

test_g: http_parser_g.o test_g.o
	$(CC) $(CFLAGS_DEBUG) $(LDFLAGS) http_parser_g.o test_g.o -o $@

test_g.o: test.c http_parser.h Makefile
	$(CC) $(CPPFLAGS_DEBUG) $(CFLAGS_DEBUG) -c test.c -o $@

http_parser_g.o: http_parser.c http_parser.h Makefile
	$(CC) $(CPPFLAGS_DEBUG) $(CFLAGS_DEBUG) -c http_parser.c -o $@

test_fast: http_parser.o test.o http_parser.h
	$(CC) $(CFLAGS_FAST) $(LDFLAGS) http_parser.o test.o -o $@

test.o: test.c http_parser.h Makefile
	$(CC) $(CPPFLAGS_FAST) $(CFLAGS_FAST) -c test.c -o $@

bench: http_parser.o bench.o
	$(CC) $(CFLAGS_BENCH) $(LDFLAGS) http_parser.o bench.o -o $@

bench.o: bench.c http_parser.h Makefile
	$(CC) $(CPPFLAGS_BENCH) $(CFLAGS_BENCH) -c bench.c -o $@

http_parser.o: http_parser.c http_parser.h Makefile
	$(CC) $(CPPFLAGS_FAST) $(CFLAGS_FAST) -c http_parser.c

test-run-timed: test_fast
	while(true) do time $(HELPER) ./test_fast$(BINEXT) > /dev/null; done

test-valgrind: test_g
	valgrind ./test_g

libhttp_parser.o: http_parser.c http_parser.h Makefile
	$(CC) $(CPPFLAGS_FAST) $(CFLAGS_LIB) -c http_parser.c -o libhttp_parser.o

library: libhttp_parser.o
	$(CC) $(LDFLAGS_LIB) -o $(SONAME) $<

package: http_parser.o
	$(AR) rcs libhttp_parser.a http_parser.o

url_parser: http_parser.o contrib/url_parser.c
	$(CC) $(CPPFLAGS_FAST) $(CFLAGS_FAST) $^ -o $@

url_parser_g: http_parser_g.o contrib/url_parser.c
	$(CC) $(CPPFLAGS_DEBUG) $(CFLAGS_DEBUG) $^ -o $@

parsertrace: http_parser.o contrib/parsertrace.c
	$(CC) $(CPPFLAGS_FAST) $(CFLAGS_FAST) $^ -o parsertrace$(BINEXT)

parsertrace_g: http_parser_g.o contrib/parsertrace.c
	$(CC) $(CPPFLAGS_DEBUG) $(CFLAGS_DEBUG) $^ -o parsertrace_g$(BINEXT)

tags: http_parser.c http_parser.h test.c
	ctags $^

install: library
	$(INSTALL) -D  http_parser.h $(INCLUDEDIR)/http_parser.h
	$(INSTALL) -D $(SONAME) $(LIBDIR)/$(SONAME)
	ln -s $(LIBDIR)/$(SONAME) $(LIBDIR)/libhttp_parser.$(SOEXT)

install-strip: library
	$(INSTALL) -D  http_parser.h $(INCLUDEDIR)/http_parser.h
	$(INSTALL) -D -s $(SONAME) $(LIBDIR)/$(SONAME)
	ln -s $(LIBDIR)/$(SONAME) $(LIBDIR)/libhttp_parser.$(SOEXT)

uninstall:
	rm $(INCLUDEDIR)/http_parser.h
	rm $(LIBDIR)/$(SONAME)
	rm $(LIBDIR)/libhttp_parser.so

clean:
	rm -f *.o *.a tags test test_fast test_g \
		http_parser.tar libhttp_parser.so.* \
		url_parser url_parser_g parsertrace parsertrace_g \
		*.exe *.exe.so

contrib/url_parser.c:	http_parser.h
contrib/parsertrace.c:	http_parser.h

.PHONY: clean package test-run test-run-timed test-valgrind install install-strip uninstall
node-v4.8.2/deps/http_parser/README.md000644 000766 000024 00000022147 13070706730 017526 0ustar00iojsstaff000000 000000 HTTP Parser
===========

[![Build Status](https://api.travis-ci.org/nodejs/http-parser.svg?branch=master)](https://travis-ci.org/nodejs/http-parser)

This is a parser for HTTP messages written in C. It parses both requests and
responses. The parser is designed to be used in performance HTTP
applications. It does not make any syscalls nor allocations, it does not
buffer data, it can be interrupted at anytime. Depending on your
architecture, it only requires about 40 bytes of data per message
stream (in a web server that is per connection).

Features:

  * No dependencies
  * Handles persistent streams (keep-alive).
  * Decodes chunked encoding.
  * Upgrade support
  * Defends against buffer overflow attacks.

The parser extracts the following information from HTTP messages:

  * Header fields and values
  * Content-Length
  * Request method
  * Response status code
  * Transfer-Encoding
  * HTTP version
  * Request URL
  * Message body


Usage
-----

One `http_parser` object is used per TCP connection. Initialize the struct
using `http_parser_init()` and set the callbacks. That might look something
like this for a request parser:
```c
http_parser_settings settings;
settings.on_url = my_url_callback;
settings.on_header_field = my_header_field_callback;
/* ... */

http_parser *parser = malloc(sizeof(http_parser));
http_parser_init(parser, HTTP_REQUEST);
parser->data = my_socket;
```

When data is received on the socket execute the parser and check for errors.

```c
size_t len = 80*1024, nparsed;
char buf[len];
ssize_t recved;

recved = recv(fd, buf, len, 0);

if (recved < 0) {
  /* Handle error. */
}

/* Start up / continue the parser.
 * Note we pass recved==0 to signal that EOF has been received.
 */
nparsed = http_parser_execute(parser, &settings, buf, recved);

if (parser->upgrade) {
  /* handle new protocol */
} else if (nparsed != recved) {
  /* Handle error. Usually just close the connection. */
}
```

HTTP needs to know where the end of the stream is. For example, sometimes
servers send responses without Content-Length and expect the client to
consume input (for the body) until EOF. To tell http_parser about EOF, give
`0` as the fourth parameter to `http_parser_execute()`. Callbacks and errors
can still be encountered during an EOF, so one must still be prepared
to receive them.

Scalar valued message information such as `status_code`, `method`, and the
HTTP version are stored in the parser structure. This data is only
temporally stored in `http_parser` and gets reset on each new message. If
this information is needed later, copy it out of the structure during the
`headers_complete` callback.

The parser decodes the transfer-encoding for both requests and responses
transparently. That is, a chunked encoding is decoded before being sent to
the on_body callback.


The Special Problem of Upgrade
------------------------------

HTTP supports upgrading the connection to a different protocol. An
increasingly common example of this is the WebSocket protocol which sends
a request like

        GET /demo HTTP/1.1
        Upgrade: WebSocket
        Connection: Upgrade
        Host: example.com
        Origin: http://example.com
        WebSocket-Protocol: sample

followed by non-HTTP data.

(See [RFC6455](https://tools.ietf.org/html/rfc6455) for more information the
WebSocket protocol.)

To support this, the parser will treat this as a normal HTTP message without a
body, issuing both on_headers_complete and on_message_complete callbacks. However
http_parser_execute() will stop parsing at the end of the headers and return.

The user is expected to check if `parser->upgrade` has been set to 1 after
`http_parser_execute()` returns. Non-HTTP data begins at the buffer supplied
offset by the return value of `http_parser_execute()`.


Callbacks
---------

During the `http_parser_execute()` call, the callbacks set in
`http_parser_settings` will be executed. The parser maintains state and
never looks behind, so buffering the data is not necessary. If you need to
save certain data for later usage, you can do that from the callbacks.

There are two types of callbacks:

* notification `typedef int (*http_cb) (http_parser*);`
    Callbacks: on_message_begin, on_headers_complete, on_message_complete.
* data `typedef int (*http_data_cb) (http_parser*, const char *at, size_t length);`
    Callbacks: (requests only) on_url,
               (common) on_header_field, on_header_value, on_body;

Callbacks must return 0 on success. Returning a non-zero value indicates
error to the parser, making it exit immediately.

For cases where it is necessary to pass local information to/from a callback,
the `http_parser` object's `data` field can be used.
An example of such a case is when using threads to handle a socket connection,
parse a request, and then give a response over that socket. By instantiation
of a thread-local struct containing relevant data (e.g. accepted socket,
allocated memory for callbacks to write into, etc), a parser's callbacks are
able to communicate data between the scope of the thread and the scope of the
callback in a threadsafe manner. This allows http-parser to be used in
multi-threaded contexts.

Example:
```c
 typedef struct {
  socket_t sock;
  void* buffer;
  int buf_len;
 } custom_data_t;


int my_url_callback(http_parser* parser, const char *at, size_t length) {
  /* access to thread local custom_data_t struct.
  Use this access save parsed data for later use into thread local
  buffer, or communicate over socket
  */
  parser->data;
  ...
  return 0;
}

...

void http_parser_thread(socket_t sock) {
 int nparsed = 0;
 /* allocate memory for user data */
 custom_data_t *my_data = malloc(sizeof(custom_data_t));

 /* some information for use by callbacks.
 * achieves thread -> callback information flow */
 my_data->sock = sock;

 /* instantiate a thread-local parser */
 http_parser *parser = malloc(sizeof(http_parser));
 http_parser_init(parser, HTTP_REQUEST); /* initialise parser */
 /* this custom data reference is accessible through the reference to the
 parser supplied to callback functions */
 parser->data = my_data;

 http_parser_settings settings; /* set up callbacks */
 settings.on_url = my_url_callback;

 /* execute parser */
 nparsed = http_parser_execute(parser, &settings, buf, recved);

 ...
 /* parsed information copied from callback.
 can now perform action on data copied into thread-local memory from callbacks.
 achieves callback -> thread information flow */
 my_data->buffer;
 ...
}

```

In case you parse HTTP message in chunks (i.e. `read()` request line
from socket, parse, read half headers, parse, etc) your data callbacks
may be called more than once. Http-parser guarantees that data pointer is only
valid for the lifetime of callback. You can also `read()` into a heap allocated
buffer to avoid copying memory around if this fits your application.

Reading headers may be a tricky task if you read/parse headers partially.
Basically, you need to remember whether last header callback was field or value
and apply the following logic:

    (on_header_field and on_header_value shortened to on_h_*)
     ------------------------ ------------ --------------------------------------------
    | State (prev. callback) | Callback   | Description/action                         |
     ------------------------ ------------ --------------------------------------------
    | nothing (first call)   | on_h_field | Allocate new buffer and copy callback data |
    |                        |            | into it                                    |
     ------------------------ ------------ --------------------------------------------
    | value                  | on_h_field | New header started.                        |
    |                        |            | Copy current name,value buffers to headers |
    |                        |            | list and allocate new buffer for new name  |
     ------------------------ ------------ --------------------------------------------
    | field                  | on_h_field | Previous name continues. Reallocate name   |
    |                        |            | buffer and append callback data to it      |
     ------------------------ ------------ --------------------------------------------
    | field                  | on_h_value | Value for current header started. Allocate |
    |                        |            | new buffer and copy callback data to it    |
     ------------------------ ------------ --------------------------------------------
    | value                  | on_h_value | Value continues. Reallocate value buffer   |
    |                        |            | and append callback data to it             |
     ------------------------ ------------ --------------------------------------------


Parsing URLs
------------

A simplistic zero-copy URL parser is provided as `http_parser_parse_url()`.
Users of this library may wish to use it to parse URLs constructed from
consecutive `on_url` callbacks.

See examples of reading in headers:

* [partial example](http://gist.github.com/155877) in C
* [from http-parser tests](http://github.com/joyent/http-parser/blob/37a0ff8/test.c#L403) in C
* [from Node library](http://github.com/joyent/node/blob/842eaf4/src/http.js#L284) in Javascript
node-v4.8.2/deps/http_parser/test.c000644 000766 000024 00000333262 13070706730 017375 0ustar00iojsstaff000000 000000 /* Copyright Joyent, Inc. and other Node contributors. All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */
#include "http_parser.h"
#include 
#include 
#include 
#include  /* rand */
#include 
#include 

#if defined(__APPLE__)
# undef strlcat
# undef strlncpy
# undef strlcpy
#endif  /* defined(__APPLE__) */

#undef TRUE
#define TRUE 1
#undef FALSE
#define FALSE 0

#define MAX_HEADERS 13
#define MAX_ELEMENT_SIZE 2048
#define MAX_CHUNKS 16

#define MIN(a,b) ((a) < (b) ? (a) : (b))

static http_parser *parser;

struct message {
  const char *name; // for debugging purposes
  const char *raw;
  enum http_parser_type type;
  enum http_method method;
  int status_code;
  char response_status[MAX_ELEMENT_SIZE];
  char request_path[MAX_ELEMENT_SIZE];
  char request_url[MAX_ELEMENT_SIZE];
  char fragment[MAX_ELEMENT_SIZE];
  char query_string[MAX_ELEMENT_SIZE];
  char body[MAX_ELEMENT_SIZE];
  size_t body_size;
  const char *host;
  const char *userinfo;
  uint16_t port;
  int num_headers;
  enum { NONE=0, FIELD, VALUE } last_header_element;
  char headers [MAX_HEADERS][2][MAX_ELEMENT_SIZE];
  int should_keep_alive;

  int num_chunks;
  int num_chunks_complete;
  int chunk_lengths[MAX_CHUNKS];

  const char *upgrade; // upgraded body

  unsigned short http_major;
  unsigned short http_minor;

  int message_begin_cb_called;
  int headers_complete_cb_called;
  int message_complete_cb_called;
  int message_complete_on_eof;
  int body_is_final;
};

static int currently_parsing_eof;

static struct message messages[5];
static int num_messages;
static http_parser_settings *current_pause_parser;

/* * R E Q U E S T S * */
const struct message requests[] =
#define CURL_GET 0
{ {.name= "curl get"
  ,.type= HTTP_REQUEST
  ,.raw= "GET /test HTTP/1.1\r\n"
         "User-Agent: curl/7.18.0 (i486-pc-linux-gnu) libcurl/7.18.0 OpenSSL/0.9.8g zlib/1.2.3.3 libidn/1.1\r\n"
         "Host: 0.0.0.0=5000\r\n"
         "Accept: */*\r\n"
         "\r\n"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.method= HTTP_GET
  ,.query_string= ""
  ,.fragment= ""
  ,.request_path= "/test"
  ,.request_url= "/test"
  ,.num_headers= 3
  ,.headers=
    { { "User-Agent", "curl/7.18.0 (i486-pc-linux-gnu) libcurl/7.18.0 OpenSSL/0.9.8g zlib/1.2.3.3 libidn/1.1" }
    , { "Host", "0.0.0.0=5000" }
    , { "Accept", "*/*" }
    }
  ,.body= ""
  }

#define FIREFOX_GET 1
, {.name= "firefox get"
  ,.type= HTTP_REQUEST
  ,.raw= "GET /favicon.ico HTTP/1.1\r\n"
         "Host: 0.0.0.0=5000\r\n"
         "User-Agent: Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008061015 Firefox/3.0\r\n"
         "Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8\r\n"
         "Accept-Language: en-us,en;q=0.5\r\n"
         "Accept-Encoding: gzip,deflate\r\n"
         "Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7\r\n"
         "Keep-Alive: 300\r\n"
         "Connection: keep-alive\r\n"
         "\r\n"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.method= HTTP_GET
  ,.query_string= ""
  ,.fragment= ""
  ,.request_path= "/favicon.ico"
  ,.request_url= "/favicon.ico"
  ,.num_headers= 8
  ,.headers=
    { { "Host", "0.0.0.0=5000" }
    , { "User-Agent", "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.9) Gecko/2008061015 Firefox/3.0" }
    , { "Accept", "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8" }
    , { "Accept-Language", "en-us,en;q=0.5" }
    , { "Accept-Encoding", "gzip,deflate" }
    , { "Accept-Charset", "ISO-8859-1,utf-8;q=0.7,*;q=0.7" }
    , { "Keep-Alive", "300" }
    , { "Connection", "keep-alive" }
    }
  ,.body= ""
  }

#define DUMBFUCK 2
, {.name= "dumbfuck"
  ,.type= HTTP_REQUEST
  ,.raw= "GET /dumbfuck HTTP/1.1\r\n"
         "aaaaaaaaaaaaa:++++++++++\r\n"
         "\r\n"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.method= HTTP_GET
  ,.query_string= ""
  ,.fragment= ""
  ,.request_path= "/dumbfuck"
  ,.request_url= "/dumbfuck"
  ,.num_headers= 1
  ,.headers=
    { { "aaaaaaaaaaaaa",  "++++++++++" }
    }
  ,.body= ""
  }

#define FRAGMENT_IN_URI 3
, {.name= "fragment in url"
  ,.type= HTTP_REQUEST
  ,.raw= "GET /forums/1/topics/2375?page=1#posts-17408 HTTP/1.1\r\n"
         "\r\n"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.method= HTTP_GET
  ,.query_string= "page=1"
  ,.fragment= "posts-17408"
  ,.request_path= "/forums/1/topics/2375"
  /* XXX request url does include fragment? */
  ,.request_url= "/forums/1/topics/2375?page=1#posts-17408"
  ,.num_headers= 0
  ,.body= ""
  }

#define GET_NO_HEADERS_NO_BODY 4
, {.name= "get no headers no body"
  ,.type= HTTP_REQUEST
  ,.raw= "GET /get_no_headers_no_body/world HTTP/1.1\r\n"
         "\r\n"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE /* would need Connection: close */
  ,.http_major= 1
  ,.http_minor= 1
  ,.method= HTTP_GET
  ,.query_string= ""
  ,.fragment= ""
  ,.request_path= "/get_no_headers_no_body/world"
  ,.request_url= "/get_no_headers_no_body/world"
  ,.num_headers= 0
  ,.body= ""
  }

#define GET_ONE_HEADER_NO_BODY 5
, {.name= "get one header no body"
  ,.type= HTTP_REQUEST
  ,.raw= "GET /get_one_header_no_body HTTP/1.1\r\n"
         "Accept: */*\r\n"
         "\r\n"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE /* would need Connection: close */
  ,.http_major= 1
  ,.http_minor= 1
  ,.method= HTTP_GET
  ,.query_string= ""
  ,.fragment= ""
  ,.request_path= "/get_one_header_no_body"
  ,.request_url= "/get_one_header_no_body"
  ,.num_headers= 1
  ,.headers=
    { { "Accept" , "*/*" }
    }
  ,.body= ""
  }

#define GET_FUNKY_CONTENT_LENGTH 6
, {.name= "get funky content length body hello"
  ,.type= HTTP_REQUEST
  ,.raw= "GET /get_funky_content_length_body_hello HTTP/1.0\r\n"
         "conTENT-Length: 5\r\n"
         "\r\n"
         "HELLO"
  ,.should_keep_alive= FALSE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 0
  ,.method= HTTP_GET
  ,.query_string= ""
  ,.fragment= ""
  ,.request_path= "/get_funky_content_length_body_hello"
  ,.request_url= "/get_funky_content_length_body_hello"
  ,.num_headers= 1
  ,.headers=
    { { "conTENT-Length" , "5" }
    }
  ,.body= "HELLO"
  }

#define POST_IDENTITY_BODY_WORLD 7
, {.name= "post identity body world"
  ,.type= HTTP_REQUEST
  ,.raw= "POST /post_identity_body_world?q=search#hey HTTP/1.1\r\n"
         "Accept: */*\r\n"
         "Transfer-Encoding: identity\r\n"
         "Content-Length: 5\r\n"
         "\r\n"
         "World"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.method= HTTP_POST
  ,.query_string= "q=search"
  ,.fragment= "hey"
  ,.request_path= "/post_identity_body_world"
  ,.request_url= "/post_identity_body_world?q=search#hey"
  ,.num_headers= 3
  ,.headers=
    { { "Accept", "*/*" }
    , { "Transfer-Encoding", "identity" }
    , { "Content-Length", "5" }
    }
  ,.body= "World"
  }

#define POST_CHUNKED_ALL_YOUR_BASE 8
, {.name= "post - chunked body: all your base are belong to us"
  ,.type= HTTP_REQUEST
  ,.raw= "POST /post_chunked_all_your_base HTTP/1.1\r\n"
         "Transfer-Encoding: chunked\r\n"
         "\r\n"
         "1e\r\nall your base are belong to us\r\n"
         "0\r\n"
         "\r\n"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.method= HTTP_POST
  ,.query_string= ""
  ,.fragment= ""
  ,.request_path= "/post_chunked_all_your_base"
  ,.request_url= "/post_chunked_all_your_base"
  ,.num_headers= 1
  ,.headers=
    { { "Transfer-Encoding" , "chunked" }
    }
  ,.body= "all your base are belong to us"
  ,.num_chunks_complete= 2
  ,.chunk_lengths= { 0x1e }
  }

#define TWO_CHUNKS_MULT_ZERO_END 9
, {.name= "two chunks ; triple zero ending"
  ,.type= HTTP_REQUEST
  ,.raw= "POST /two_chunks_mult_zero_end HTTP/1.1\r\n"
         "Transfer-Encoding: chunked\r\n"
         "\r\n"
         "5\r\nhello\r\n"
         "6\r\n world\r\n"
         "000\r\n"
         "\r\n"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.method= HTTP_POST
  ,.query_string= ""
  ,.fragment= ""
  ,.request_path= "/two_chunks_mult_zero_end"
  ,.request_url= "/two_chunks_mult_zero_end"
  ,.num_headers= 1
  ,.headers=
    { { "Transfer-Encoding", "chunked" }
    }
  ,.body= "hello world"
  ,.num_chunks_complete= 3
  ,.chunk_lengths= { 5, 6 }
  }

#define CHUNKED_W_TRAILING_HEADERS 10
, {.name= "chunked with trailing headers. blech."
  ,.type= HTTP_REQUEST
  ,.raw= "POST /chunked_w_trailing_headers HTTP/1.1\r\n"
         "Transfer-Encoding: chunked\r\n"
         "\r\n"
         "5\r\nhello\r\n"
         "6\r\n world\r\n"
         "0\r\n"
         "Vary: *\r\n"
         "Content-Type: text/plain\r\n"
         "\r\n"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.method= HTTP_POST
  ,.query_string= ""
  ,.fragment= ""
  ,.request_path= "/chunked_w_trailing_headers"
  ,.request_url= "/chunked_w_trailing_headers"
  ,.num_headers= 3
  ,.headers=
    { { "Transfer-Encoding",  "chunked" }
    , { "Vary", "*" }
    , { "Content-Type", "text/plain" }
    }
  ,.body= "hello world"
  ,.num_chunks_complete= 3
  ,.chunk_lengths= { 5, 6 }
  }

#define CHUNKED_W_BULLSHIT_AFTER_LENGTH 11
, {.name= "with bullshit after the length"
  ,.type= HTTP_REQUEST
  ,.raw= "POST /chunked_w_bullshit_after_length HTTP/1.1\r\n"
         "Transfer-Encoding: chunked\r\n"
         "\r\n"
         "5; ihatew3;whatthefuck=aretheseparametersfor\r\nhello\r\n"
         "6; blahblah; blah\r\n world\r\n"
         "0\r\n"
         "\r\n"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.method= HTTP_POST
  ,.query_string= ""
  ,.fragment= ""
  ,.request_path= "/chunked_w_bullshit_after_length"
  ,.request_url= "/chunked_w_bullshit_after_length"
  ,.num_headers= 1
  ,.headers=
    { { "Transfer-Encoding", "chunked" }
    }
  ,.body= "hello world"
  ,.num_chunks_complete= 3
  ,.chunk_lengths= { 5, 6 }
  }

#define WITH_QUOTES 12
, {.name= "with quotes"
  ,.type= HTTP_REQUEST
  ,.raw= "GET /with_\"stupid\"_quotes?foo=\"bar\" HTTP/1.1\r\n\r\n"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.method= HTTP_GET
  ,.query_string= "foo=\"bar\""
  ,.fragment= ""
  ,.request_path= "/with_\"stupid\"_quotes"
  ,.request_url= "/with_\"stupid\"_quotes?foo=\"bar\""
  ,.num_headers= 0
  ,.headers= { }
  ,.body= ""
  }

#define APACHEBENCH_GET 13
/* The server receiving this request SHOULD NOT wait for EOF
 * to know that content-length == 0.
 * How to represent this in a unit test? message_complete_on_eof
 * Compare with NO_CONTENT_LENGTH_RESPONSE.
 */
, {.name = "apachebench get"
  ,.type= HTTP_REQUEST
  ,.raw= "GET /test HTTP/1.0\r\n"
         "Host: 0.0.0.0:5000\r\n"
         "User-Agent: ApacheBench/2.3\r\n"
         "Accept: */*\r\n\r\n"
  ,.should_keep_alive= FALSE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 0
  ,.method= HTTP_GET
  ,.query_string= ""
  ,.fragment= ""
  ,.request_path= "/test"
  ,.request_url= "/test"
  ,.num_headers= 3
  ,.headers= { { "Host", "0.0.0.0:5000" }
             , { "User-Agent", "ApacheBench/2.3" }
             , { "Accept", "*/*" }
             }
  ,.body= ""
  }

#define QUERY_URL_WITH_QUESTION_MARK_GET 14
/* Some clients include '?' characters in query strings.
 */
, {.name = "query url with question mark"
  ,.type= HTTP_REQUEST
  ,.raw= "GET /test.cgi?foo=bar?baz HTTP/1.1\r\n\r\n"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.method= HTTP_GET
  ,.query_string= "foo=bar?baz"
  ,.fragment= ""
  ,.request_path= "/test.cgi"
  ,.request_url= "/test.cgi?foo=bar?baz"
  ,.num_headers= 0
  ,.headers= {}
  ,.body= ""
  }

#define PREFIX_NEWLINE_GET 15
/* Some clients, especially after a POST in a keep-alive connection,
 * will send an extra CRLF before the next request
 */
, {.name = "newline prefix get"
  ,.type= HTTP_REQUEST
  ,.raw= "\r\nGET /test HTTP/1.1\r\n\r\n"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.method= HTTP_GET
  ,.query_string= ""
  ,.fragment= ""
  ,.request_path= "/test"
  ,.request_url= "/test"
  ,.num_headers= 0
  ,.headers= { }
  ,.body= ""
  }

#define UPGRADE_REQUEST 16
, {.name = "upgrade request"
  ,.type= HTTP_REQUEST
  ,.raw= "GET /demo HTTP/1.1\r\n"
         "Host: example.com\r\n"
         "Connection: Upgrade\r\n"
         "Sec-WebSocket-Key2: 12998 5 Y3 1  .P00\r\n"
         "Sec-WebSocket-Protocol: sample\r\n"
         "Upgrade: WebSocket\r\n"
         "Sec-WebSocket-Key1: 4 @1  46546xW%0l 1 5\r\n"
         "Origin: http://example.com\r\n"
         "\r\n"
         "Hot diggity dogg"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.method= HTTP_GET
  ,.query_string= ""
  ,.fragment= ""
  ,.request_path= "/demo"
  ,.request_url= "/demo"
  ,.num_headers= 7
  ,.upgrade="Hot diggity dogg"
  ,.headers= { { "Host", "example.com" }
             , { "Connection", "Upgrade" }
             , { "Sec-WebSocket-Key2", "12998 5 Y3 1  .P00" }
             , { "Sec-WebSocket-Protocol", "sample" }
             , { "Upgrade", "WebSocket" }
             , { "Sec-WebSocket-Key1", "4 @1  46546xW%0l 1 5" }
             , { "Origin", "http://example.com" }
             }
  ,.body= ""
  }

#define CONNECT_REQUEST 17
, {.name = "connect request"
  ,.type= HTTP_REQUEST
  ,.raw= "CONNECT 0-home0.netscape.com:443 HTTP/1.0\r\n"
         "User-agent: Mozilla/1.1N\r\n"
         "Proxy-authorization: basic aGVsbG86d29ybGQ=\r\n"
         "\r\n"
         "some data\r\n"
         "and yet even more data"
  ,.should_keep_alive= FALSE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 0
  ,.method= HTTP_CONNECT
  ,.query_string= ""
  ,.fragment= ""
  ,.request_path= ""
  ,.request_url= "0-home0.netscape.com:443"
  ,.num_headers= 2
  ,.upgrade="some data\r\nand yet even more data"
  ,.headers= { { "User-agent", "Mozilla/1.1N" }
             , { "Proxy-authorization", "basic aGVsbG86d29ybGQ=" }
             }
  ,.body= ""
  }

#define REPORT_REQ 18
, {.name= "report request"
  ,.type= HTTP_REQUEST
  ,.raw= "REPORT /test HTTP/1.1\r\n"
         "\r\n"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.method= HTTP_REPORT
  ,.query_string= ""
  ,.fragment= ""
  ,.request_path= "/test"
  ,.request_url= "/test"
  ,.num_headers= 0
  ,.headers= {}
  ,.body= ""
  }

#define NO_HTTP_VERSION 19
, {.name= "request with no http version"
  ,.type= HTTP_REQUEST
  ,.raw= "GET /\r\n"
         "\r\n"
  ,.should_keep_alive= FALSE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 0
  ,.http_minor= 9
  ,.method= HTTP_GET
  ,.query_string= ""
  ,.fragment= ""
  ,.request_path= "/"
  ,.request_url= "/"
  ,.num_headers= 0
  ,.headers= {}
  ,.body= ""
  }

#define MSEARCH_REQ 20
, {.name= "m-search request"
  ,.type= HTTP_REQUEST
  ,.raw= "M-SEARCH * HTTP/1.1\r\n"
         "HOST: 239.255.255.250:1900\r\n"
         "MAN: \"ssdp:discover\"\r\n"
         "ST: \"ssdp:all\"\r\n"
         "\r\n"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.method= HTTP_MSEARCH
  ,.query_string= ""
  ,.fragment= ""
  ,.request_path= "*"
  ,.request_url= "*"
  ,.num_headers= 3
  ,.headers= { { "HOST", "239.255.255.250:1900" }
             , { "MAN", "\"ssdp:discover\"" }
             , { "ST", "\"ssdp:all\"" }
             }
  ,.body= ""
  }

#define LINE_FOLDING_IN_HEADER 21
, {.name= "line folding in header value"
  ,.type= HTTP_REQUEST
  ,.raw= "GET / HTTP/1.1\r\n"
         "Line1:   abc\r\n"
         "\tdef\r\n"
         " ghi\r\n"
         "\t\tjkl\r\n"
         "  mno \r\n"
         "\t \tqrs\r\n"
         "Line2: \t line2\t\r\n"
         "Line3:\r\n"
         " line3\r\n"
         "Line4: \r\n"
         " \r\n"
         "Connection:\r\n"
         " close\r\n"
         "\r\n"
  ,.should_keep_alive= FALSE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.method= HTTP_GET
  ,.query_string= ""
  ,.fragment= ""
  ,.request_path= "/"
  ,.request_url= "/"
  ,.num_headers= 5
  ,.headers= { { "Line1", "abc\tdef ghi\t\tjkl  mno \t \tqrs" }
             , { "Line2", "line2\t" }
             , { "Line3", "line3" }
             , { "Line4", "" }
             , { "Connection", "close" },
             }
  ,.body= ""
  }


#define QUERY_TERMINATED_HOST 22
, {.name= "host terminated by a query string"
  ,.type= HTTP_REQUEST
  ,.raw= "GET http://hypnotoad.org?hail=all HTTP/1.1\r\n"
         "\r\n"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.method= HTTP_GET
  ,.query_string= "hail=all"
  ,.fragment= ""
  ,.request_path= ""
  ,.request_url= "http://hypnotoad.org?hail=all"
  ,.host= "hypnotoad.org"
  ,.num_headers= 0
  ,.headers= { }
  ,.body= ""
  }

#define QUERY_TERMINATED_HOSTPORT 23
, {.name= "host:port terminated by a query string"
  ,.type= HTTP_REQUEST
  ,.raw= "GET http://hypnotoad.org:1234?hail=all HTTP/1.1\r\n"
         "\r\n"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.method= HTTP_GET
  ,.query_string= "hail=all"
  ,.fragment= ""
  ,.request_path= ""
  ,.request_url= "http://hypnotoad.org:1234?hail=all"
  ,.host= "hypnotoad.org"
  ,.port= 1234
  ,.num_headers= 0
  ,.headers= { }
  ,.body= ""
  }

#define SPACE_TERMINATED_HOSTPORT 24
, {.name= "host:port terminated by a space"
  ,.type= HTTP_REQUEST
  ,.raw= "GET http://hypnotoad.org:1234 HTTP/1.1\r\n"
         "\r\n"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.method= HTTP_GET
  ,.query_string= ""
  ,.fragment= ""
  ,.request_path= ""
  ,.request_url= "http://hypnotoad.org:1234"
  ,.host= "hypnotoad.org"
  ,.port= 1234
  ,.num_headers= 0
  ,.headers= { }
  ,.body= ""
  }

#define PATCH_REQ 25
, {.name = "PATCH request"
  ,.type= HTTP_REQUEST
  ,.raw= "PATCH /file.txt HTTP/1.1\r\n"
         "Host: www.example.com\r\n"
         "Content-Type: application/example\r\n"
         "If-Match: \"e0023aa4e\"\r\n"
         "Content-Length: 10\r\n"
         "\r\n"
         "cccccccccc"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.method= HTTP_PATCH
  ,.query_string= ""
  ,.fragment= ""
  ,.request_path= "/file.txt"
  ,.request_url= "/file.txt"
  ,.num_headers= 4
  ,.headers= { { "Host", "www.example.com" }
             , { "Content-Type", "application/example" }
             , { "If-Match", "\"e0023aa4e\"" }
             , { "Content-Length", "10" }
             }
  ,.body= "cccccccccc"
  }

#define CONNECT_CAPS_REQUEST 26
, {.name = "connect caps request"
  ,.type= HTTP_REQUEST
  ,.raw= "CONNECT HOME0.NETSCAPE.COM:443 HTTP/1.0\r\n"
         "User-agent: Mozilla/1.1N\r\n"
         "Proxy-authorization: basic aGVsbG86d29ybGQ=\r\n"
         "\r\n"
  ,.should_keep_alive= FALSE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 0
  ,.method= HTTP_CONNECT
  ,.query_string= ""
  ,.fragment= ""
  ,.request_path= ""
  ,.request_url= "HOME0.NETSCAPE.COM:443"
  ,.num_headers= 2
  ,.upgrade=""
  ,.headers= { { "User-agent", "Mozilla/1.1N" }
             , { "Proxy-authorization", "basic aGVsbG86d29ybGQ=" }
             }
  ,.body= ""
  }

#if !HTTP_PARSER_STRICT
#define UTF8_PATH_REQ 27
, {.name= "utf-8 path request"
  ,.type= HTTP_REQUEST
  ,.raw= "GET /δ¶/δt/pope?q=1#narf HTTP/1.1\r\n"
         "Host: github.com\r\n"
         "\r\n"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.method= HTTP_GET
  ,.query_string= "q=1"
  ,.fragment= "narf"
  ,.request_path= "/δ¶/δt/pope"
  ,.request_url= "/δ¶/δt/pope?q=1#narf"
  ,.num_headers= 1
  ,.headers= { {"Host", "github.com" }
             }
  ,.body= ""
  }

#define HOSTNAME_UNDERSCORE 28
, {.name = "hostname underscore"
  ,.type= HTTP_REQUEST
  ,.raw= "CONNECT home_0.netscape.com:443 HTTP/1.0\r\n"
         "User-agent: Mozilla/1.1N\r\n"
         "Proxy-authorization: basic aGVsbG86d29ybGQ=\r\n"
         "\r\n"
  ,.should_keep_alive= FALSE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 0
  ,.method= HTTP_CONNECT
  ,.query_string= ""
  ,.fragment= ""
  ,.request_path= ""
  ,.request_url= "home_0.netscape.com:443"
  ,.num_headers= 2
  ,.upgrade=""
  ,.headers= { { "User-agent", "Mozilla/1.1N" }
             , { "Proxy-authorization", "basic aGVsbG86d29ybGQ=" }
             }
  ,.body= ""
  }
#endif  /* !HTTP_PARSER_STRICT */

/* see https://github.com/ry/http-parser/issues/47 */
#define EAT_TRAILING_CRLF_NO_CONNECTION_CLOSE 29
, {.name = "eat CRLF between requests, no \"Connection: close\" header"
  ,.raw= "POST / HTTP/1.1\r\n"
         "Host: www.example.com\r\n"
         "Content-Type: application/x-www-form-urlencoded\r\n"
         "Content-Length: 4\r\n"
         "\r\n"
         "q=42\r\n" /* note the trailing CRLF */
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.method= HTTP_POST
  ,.query_string= ""
  ,.fragment= ""
  ,.request_path= "/"
  ,.request_url= "/"
  ,.num_headers= 3
  ,.upgrade= 0
  ,.headers= { { "Host", "www.example.com" }
             , { "Content-Type", "application/x-www-form-urlencoded" }
             , { "Content-Length", "4" }
             }
  ,.body= "q=42"
  }

/* see https://github.com/ry/http-parser/issues/47 */
#define EAT_TRAILING_CRLF_WITH_CONNECTION_CLOSE 30
, {.name = "eat CRLF between requests even if \"Connection: close\" is set"
  ,.raw= "POST / HTTP/1.1\r\n"
         "Host: www.example.com\r\n"
         "Content-Type: application/x-www-form-urlencoded\r\n"
         "Content-Length: 4\r\n"
         "Connection: close\r\n"
         "\r\n"
         "q=42\r\n" /* note the trailing CRLF */
  ,.should_keep_alive= FALSE
  ,.message_complete_on_eof= FALSE /* input buffer isn't empty when on_message_complete is called */
  ,.http_major= 1
  ,.http_minor= 1
  ,.method= HTTP_POST
  ,.query_string= ""
  ,.fragment= ""
  ,.request_path= "/"
  ,.request_url= "/"
  ,.num_headers= 4
  ,.upgrade= 0
  ,.headers= { { "Host", "www.example.com" }
             , { "Content-Type", "application/x-www-form-urlencoded" }
             , { "Content-Length", "4" }
             , { "Connection", "close" }
             }
  ,.body= "q=42"
  }

#define PURGE_REQ 31
, {.name = "PURGE request"
  ,.type= HTTP_REQUEST
  ,.raw= "PURGE /file.txt HTTP/1.1\r\n"
         "Host: www.example.com\r\n"
         "\r\n"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.method= HTTP_PURGE
  ,.query_string= ""
  ,.fragment= ""
  ,.request_path= "/file.txt"
  ,.request_url= "/file.txt"
  ,.num_headers= 1
  ,.headers= { { "Host", "www.example.com" } }
  ,.body= ""
  }

#define SEARCH_REQ 32
, {.name = "SEARCH request"
  ,.type= HTTP_REQUEST
  ,.raw= "SEARCH / HTTP/1.1\r\n"
         "Host: www.example.com\r\n"
         "\r\n"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.method= HTTP_SEARCH
  ,.query_string= ""
  ,.fragment= ""
  ,.request_path= "/"
  ,.request_url= "/"
  ,.num_headers= 1
  ,.headers= { { "Host", "www.example.com" } }
  ,.body= ""
  }

#define PROXY_WITH_BASIC_AUTH 33
, {.name= "host:port and basic_auth"
  ,.type= HTTP_REQUEST
  ,.raw= "GET http://a%12:b!&*$@hypnotoad.org:1234/toto HTTP/1.1\r\n"
         "\r\n"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.method= HTTP_GET
  ,.fragment= ""
  ,.request_path= "/toto"
  ,.request_url= "http://a%12:b!&*$@hypnotoad.org:1234/toto"
  ,.host= "hypnotoad.org"
  ,.userinfo= "a%12:b!&*$"
  ,.port= 1234
  ,.num_headers= 0
  ,.headers= { }
  ,.body= ""
  }

#define LINE_FOLDING_IN_HEADER_WITH_LF 34
, {.name= "line folding in header value"
  ,.type= HTTP_REQUEST
  ,.raw= "GET / HTTP/1.1\n"
         "Line1:   abc\n"
         "\tdef\n"
         " ghi\n"
         "\t\tjkl\n"
         "  mno \n"
         "\t \tqrs\n"
         "Line2: \t line2\t\n"
         "Line3:\n"
         " line3\n"
         "Line4: \n"
         " \n"
         "Connection:\n"
         " close\n"
         "\n"
  ,.should_keep_alive= FALSE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.method= HTTP_GET
  ,.query_string= ""
  ,.fragment= ""
  ,.request_path= "/"
  ,.request_url= "/"
  ,.num_headers= 5
  ,.headers= { { "Line1", "abc\tdef ghi\t\tjkl  mno \t \tqrs" }
             , { "Line2", "line2\t" }
             , { "Line3", "line3" }
             , { "Line4", "" }
             , { "Connection", "close" },
             }
  ,.body= ""
  }

#define CONNECTION_MULTI 35
, {.name = "multiple connection header values with folding"
  ,.type= HTTP_REQUEST
  ,.raw= "GET /demo HTTP/1.1\r\n"
         "Host: example.com\r\n"
         "Connection: Something,\r\n"
         " Upgrade, ,Keep-Alive\r\n"
         "Sec-WebSocket-Key2: 12998 5 Y3 1  .P00\r\n"
         "Sec-WebSocket-Protocol: sample\r\n"
         "Upgrade: WebSocket\r\n"
         "Sec-WebSocket-Key1: 4 @1  46546xW%0l 1 5\r\n"
         "Origin: http://example.com\r\n"
         "\r\n"
         "Hot diggity dogg"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.method= HTTP_GET
  ,.query_string= ""
  ,.fragment= ""
  ,.request_path= "/demo"
  ,.request_url= "/demo"
  ,.num_headers= 7
  ,.upgrade="Hot diggity dogg"
  ,.headers= { { "Host", "example.com" }
             , { "Connection", "Something, Upgrade, ,Keep-Alive" }
             , { "Sec-WebSocket-Key2", "12998 5 Y3 1  .P00" }
             , { "Sec-WebSocket-Protocol", "sample" }
             , { "Upgrade", "WebSocket" }
             , { "Sec-WebSocket-Key1", "4 @1  46546xW%0l 1 5" }
             , { "Origin", "http://example.com" }
             }
  ,.body= ""
  }

#define CONNECTION_MULTI_LWS 36
, {.name = "multiple connection header values with folding and lws"
  ,.type= HTTP_REQUEST
  ,.raw= "GET /demo HTTP/1.1\r\n"
         "Connection: keep-alive, upgrade\r\n"
         "Upgrade: WebSocket\r\n"
         "\r\n"
         "Hot diggity dogg"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.method= HTTP_GET
  ,.query_string= ""
  ,.fragment= ""
  ,.request_path= "/demo"
  ,.request_url= "/demo"
  ,.num_headers= 2
  ,.upgrade="Hot diggity dogg"
  ,.headers= { { "Connection", "keep-alive, upgrade" }
             , { "Upgrade", "WebSocket" }
             }
  ,.body= ""
  }

#define CONNECTION_MULTI_LWS_CRLF 37
, {.name = "multiple connection header values with folding and lws"
  ,.type= HTTP_REQUEST
  ,.raw= "GET /demo HTTP/1.1\r\n"
         "Connection: keep-alive, \r\n upgrade\r\n"
         "Upgrade: WebSocket\r\n"
         "\r\n"
         "Hot diggity dogg"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.method= HTTP_GET
  ,.query_string= ""
  ,.fragment= ""
  ,.request_path= "/demo"
  ,.request_url= "/demo"
  ,.num_headers= 2
  ,.upgrade="Hot diggity dogg"
  ,.headers= { { "Connection", "keep-alive,  upgrade" }
             , { "Upgrade", "WebSocket" }
             }
  ,.body= ""
  }

#define UPGRADE_POST_REQUEST 38
, {.name = "upgrade post request"
  ,.type= HTTP_REQUEST
  ,.raw= "POST /demo HTTP/1.1\r\n"
         "Host: example.com\r\n"
         "Connection: Upgrade\r\n"
         "Upgrade: HTTP/2.0\r\n"
         "Content-Length: 15\r\n"
         "\r\n"
         "sweet post body"
         "Hot diggity dogg"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.method= HTTP_POST
  ,.request_path= "/demo"
  ,.request_url= "/demo"
  ,.num_headers= 4
  ,.upgrade="Hot diggity dogg"
  ,.headers= { { "Host", "example.com" }
             , { "Connection", "Upgrade" }
             , { "Upgrade", "HTTP/2.0" }
             , { "Content-Length", "15" }
             }
  ,.body= "sweet post body"
  }

#define CONNECT_WITH_BODY_REQUEST 39
, {.name = "connect with body request"
  ,.type= HTTP_REQUEST
  ,.raw= "CONNECT foo.bar.com:443 HTTP/1.0\r\n"
         "User-agent: Mozilla/1.1N\r\n"
         "Proxy-authorization: basic aGVsbG86d29ybGQ=\r\n"
         "Content-Length: 10\r\n"
         "\r\n"
         "blarfcicle"
  ,.should_keep_alive= FALSE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 0
  ,.method= HTTP_CONNECT
  ,.request_url= "foo.bar.com:443"
  ,.num_headers= 3
  ,.upgrade="blarfcicle"
  ,.headers= { { "User-agent", "Mozilla/1.1N" }
             , { "Proxy-authorization", "basic aGVsbG86d29ybGQ=" }
             , { "Content-Length", "10" }
             }
  ,.body= ""
  }

/* Examples from the Internet draft for LINK/UNLINK methods:
 * https://tools.ietf.org/id/draft-snell-link-method-01.html#rfc.section.5
 */

#define LINK_REQUEST 40
, {.name = "link request"
  ,.type= HTTP_REQUEST
  ,.raw= "LINK /images/my_dog.jpg HTTP/1.1\r\n"
         "Host: example.com\r\n"
         "Link: ; rel=\"tag\"\r\n"
         "Link: ; rel=\"tag\"\r\n"
         "\r\n"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.method= HTTP_LINK
  ,.request_path= "/images/my_dog.jpg"
  ,.request_url= "/images/my_dog.jpg"
  ,.query_string= ""
  ,.fragment= ""
  ,.num_headers= 3
  ,.headers= { { "Host", "example.com" }
             , { "Link", "; rel=\"tag\"" }
	     , { "Link", "; rel=\"tag\"" }
             }
  ,.body= ""
  }

#define UNLINK_REQUEST 41
, {.name = "link request"
  ,.type= HTTP_REQUEST
  ,.raw= "UNLINK /images/my_dog.jpg HTTP/1.1\r\n"
         "Host: example.com\r\n"
         "Link: ; rel=\"tag\"\r\n"
         "\r\n"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.method= HTTP_UNLINK
  ,.request_path= "/images/my_dog.jpg"
  ,.request_url= "/images/my_dog.jpg"
  ,.query_string= ""
  ,.fragment= ""
  ,.num_headers= 2
  ,.headers= { { "Host", "example.com" }
	     , { "Link", "; rel=\"tag\"" }
             }
  ,.body= ""
  }

, {.name= NULL } /* sentinel */
};

/* * R E S P O N S E S * */
const struct message responses[] =
#define GOOGLE_301 0
{ {.name= "google 301"
  ,.type= HTTP_RESPONSE
  ,.raw= "HTTP/1.1 301 Moved Permanently\r\n"
         "Location: http://www.google.com/\r\n"
         "Content-Type: text/html; charset=UTF-8\r\n"
         "Date: Sun, 26 Apr 2009 11:11:49 GMT\r\n"
         "Expires: Tue, 26 May 2009 11:11:49 GMT\r\n"
         "X-$PrototypeBI-Version: 1.6.0.3\r\n" /* $ char in header field */
         "Cache-Control: public, max-age=2592000\r\n"
         "Server: gws\r\n"
         "Content-Length:  219  \r\n"
         "\r\n"
         "\n"
         "301 Moved\n"
         "
301 Moved
\n"
         "The document has moved\n"
         "here.\r\n"
         "\r\n"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.status_code= 301
  ,.response_status= "Moved Permanently"
  ,.num_headers= 8
  ,.headers=
    { { "Location", "http://www.google.com/" }
    , { "Content-Type", "text/html; charset=UTF-8" }
    , { "Date", "Sun, 26 Apr 2009 11:11:49 GMT" }
    , { "Expires", "Tue, 26 May 2009 11:11:49 GMT" }
    , { "X-$PrototypeBI-Version", "1.6.0.3" }
    , { "Cache-Control", "public, max-age=2592000" }
    , { "Server", "gws" }
    , { "Content-Length", "219  " }
    }
  ,.body= "\n"
          "301 Moved\n"
          "
301 Moved
\n"
          "The document has moved\n"
          "here.\r\n"
          "\r\n"
  }

#define NO_CONTENT_LENGTH_RESPONSE 1
/* The client should wait for the server's EOF. That is, when content-length
 * is not specified, and "Connection: close", the end of body is specified
 * by the EOF.
 * Compare with APACHEBENCH_GET
 */
, {.name= "no content-length response"
  ,.type= HTTP_RESPONSE
  ,.raw= "HTTP/1.1 200 OK\r\n"
         "Date: Tue, 04 Aug 2009 07:59:32 GMT\r\n"
         "Server: Apache\r\n"
         "X-Powered-By: Servlet/2.5 JSP/2.1\r\n"
         "Content-Type: text/xml; charset=utf-8\r\n"
         "Connection: close\r\n"
         "\r\n"
         "\n"
         "\n"
         "  \n"
         "    \n"
         "       SOAP-ENV:Client\n"
         "       Client Error\n"
         "    \n"
         "  \n"
         ""
  ,.should_keep_alive= FALSE
  ,.message_complete_on_eof= TRUE
  ,.http_major= 1
  ,.http_minor= 1
  ,.status_code= 200
  ,.response_status= "OK"
  ,.num_headers= 5
  ,.headers=
    { { "Date", "Tue, 04 Aug 2009 07:59:32 GMT" }
    , { "Server", "Apache" }
    , { "X-Powered-By", "Servlet/2.5 JSP/2.1" }
    , { "Content-Type", "text/xml; charset=utf-8" }
    , { "Connection", "close" }
    }
  ,.body= "\n"
          "\n"
          "  \n"
          "    \n"
          "       SOAP-ENV:Client\n"
          "       Client Error\n"
          "    \n"
          "  \n"
          ""
  }

#define NO_HEADERS_NO_BODY_404 2
, {.name= "404 no headers no body"
  ,.type= HTTP_RESPONSE
  ,.raw= "HTTP/1.1 404 Not Found\r\n\r\n"
  ,.should_keep_alive= FALSE
  ,.message_complete_on_eof= TRUE
  ,.http_major= 1
  ,.http_minor= 1
  ,.status_code= 404
  ,.response_status= "Not Found"
  ,.num_headers= 0
  ,.headers= {}
  ,.body_size= 0
  ,.body= ""
  }

#define NO_REASON_PHRASE 3
, {.name= "301 no response phrase"
  ,.type= HTTP_RESPONSE
  ,.raw= "HTTP/1.1 301\r\n\r\n"
  ,.should_keep_alive = FALSE
  ,.message_complete_on_eof= TRUE
  ,.http_major= 1
  ,.http_minor= 1
  ,.status_code= 301
  ,.response_status= ""
  ,.num_headers= 0
  ,.headers= {}
  ,.body= ""
  }

#define TRAILING_SPACE_ON_CHUNKED_BODY 4
, {.name="200 trailing space on chunked body"
  ,.type= HTTP_RESPONSE
  ,.raw= "HTTP/1.1 200 OK\r\n"
         "Content-Type: text/plain\r\n"
         "Transfer-Encoding: chunked\r\n"
         "\r\n"
         "25  \r\n"
         "This is the data in the first chunk\r\n"
         "\r\n"
         "1C\r\n"
         "and this is the second one\r\n"
         "\r\n"
         "0  \r\n"
         "\r\n"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.status_code= 200
  ,.response_status= "OK"
  ,.num_headers= 2
  ,.headers=
    { {"Content-Type", "text/plain" }
    , {"Transfer-Encoding", "chunked" }
    }
  ,.body_size = 37+28
  ,.body =
         "This is the data in the first chunk\r\n"
         "and this is the second one\r\n"
  ,.num_chunks_complete= 3
  ,.chunk_lengths= { 0x25, 0x1c }
  }

#define NO_CARRIAGE_RET 5
, {.name="no carriage ret"
  ,.type= HTTP_RESPONSE
  ,.raw= "HTTP/1.1 200 OK\n"
         "Content-Type: text/html; charset=utf-8\n"
         "Connection: close\n"
         "\n"
         "these headers are from http://news.ycombinator.com/"
  ,.should_keep_alive= FALSE
  ,.message_complete_on_eof= TRUE
  ,.http_major= 1
  ,.http_minor= 1
  ,.status_code= 200
  ,.response_status= "OK"
  ,.num_headers= 2
  ,.headers=
    { {"Content-Type", "text/html; charset=utf-8" }
    , {"Connection", "close" }
    }
  ,.body= "these headers are from http://news.ycombinator.com/"
  }

#define PROXY_CONNECTION 6
, {.name="proxy connection"
  ,.type= HTTP_RESPONSE
  ,.raw= "HTTP/1.1 200 OK\r\n"
         "Content-Type: text/html; charset=UTF-8\r\n"
         "Content-Length: 11\r\n"
         "Proxy-Connection: close\r\n"
         "Date: Thu, 31 Dec 2009 20:55:48 +0000\r\n"
         "\r\n"
         "hello world"
  ,.should_keep_alive= FALSE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.status_code= 200
  ,.response_status= "OK"
  ,.num_headers= 4
  ,.headers=
    { {"Content-Type", "text/html; charset=UTF-8" }
    , {"Content-Length", "11" }
    , {"Proxy-Connection", "close" }
    , {"Date", "Thu, 31 Dec 2009 20:55:48 +0000"}
    }
  ,.body= "hello world"
  }

#define UNDERSTORE_HEADER_KEY 7
  // shown by
  // curl -o /dev/null -v "http://ad.doubleclick.net/pfadx/DARTSHELLCONFIGXML;dcmt=text/xml;"
, {.name="underscore header key"
  ,.type= HTTP_RESPONSE
  ,.raw= "HTTP/1.1 200 OK\r\n"
         "Server: DCLK-AdSvr\r\n"
         "Content-Type: text/xml\r\n"
         "Content-Length: 0\r\n"
         "DCLK_imp: v7;x;114750856;0-0;0;17820020;0/0;21603567/21621457/1;;~okv=;dcmt=text/xml;;~cs=o\r\n\r\n"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.status_code= 200
  ,.response_status= "OK"
  ,.num_headers= 4
  ,.headers=
    { {"Server", "DCLK-AdSvr" }
    , {"Content-Type", "text/xml" }
    , {"Content-Length", "0" }
    , {"DCLK_imp", "v7;x;114750856;0-0;0;17820020;0/0;21603567/21621457/1;;~okv=;dcmt=text/xml;;~cs=o" }
    }
  ,.body= ""
  }

#define BONJOUR_MADAME_FR 8
/* The client should not merge two headers fields when the first one doesn't
 * have a value.
 */
, {.name= "bonjourmadame.fr"
  ,.type= HTTP_RESPONSE
  ,.raw= "HTTP/1.0 301 Moved Permanently\r\n"
         "Date: Thu, 03 Jun 2010 09:56:32 GMT\r\n"
         "Server: Apache/2.2.3 (Red Hat)\r\n"
         "Cache-Control: public\r\n"
         "Pragma: \r\n"
         "Location: http://www.bonjourmadame.fr/\r\n"
         "Vary: Accept-Encoding\r\n"
         "Content-Length: 0\r\n"
         "Content-Type: text/html; charset=UTF-8\r\n"
         "Connection: keep-alive\r\n"
         "\r\n"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 0
  ,.status_code= 301
  ,.response_status= "Moved Permanently"
  ,.num_headers= 9
  ,.headers=
    { { "Date", "Thu, 03 Jun 2010 09:56:32 GMT" }
    , { "Server", "Apache/2.2.3 (Red Hat)" }
    , { "Cache-Control", "public" }
    , { "Pragma", "" }
    , { "Location", "http://www.bonjourmadame.fr/" }
    , { "Vary",  "Accept-Encoding" }
    , { "Content-Length", "0" }
    , { "Content-Type", "text/html; charset=UTF-8" }
    , { "Connection", "keep-alive" }
    }
  ,.body= ""
  }

#define RES_FIELD_UNDERSCORE 9
/* Should handle spaces in header fields */
, {.name= "field underscore"
  ,.type= HTTP_RESPONSE
  ,.raw= "HTTP/1.1 200 OK\r\n"
         "Date: Tue, 28 Sep 2010 01:14:13 GMT\r\n"
         "Server: Apache\r\n"
         "Cache-Control: no-cache, must-revalidate\r\n"
         "Expires: Mon, 26 Jul 1997 05:00:00 GMT\r\n"
         ".et-Cookie: PlaxoCS=1274804622353690521; path=/; domain=.plaxo.com\r\n"
         "Vary: Accept-Encoding\r\n"
         "_eep-Alive: timeout=45\r\n" /* semantic value ignored */
         "_onnection: Keep-Alive\r\n" /* semantic value ignored */
         "Transfer-Encoding: chunked\r\n"
         "Content-Type: text/html\r\n"
         "Connection: close\r\n"
         "\r\n"
         "0\r\n\r\n"
  ,.should_keep_alive= FALSE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.status_code= 200
  ,.response_status= "OK"
  ,.num_headers= 11
  ,.headers=
    { { "Date", "Tue, 28 Sep 2010 01:14:13 GMT" }
    , { "Server", "Apache" }
    , { "Cache-Control", "no-cache, must-revalidate" }
    , { "Expires", "Mon, 26 Jul 1997 05:00:00 GMT" }
    , { ".et-Cookie", "PlaxoCS=1274804622353690521; path=/; domain=.plaxo.com" }
    , { "Vary", "Accept-Encoding" }
    , { "_eep-Alive", "timeout=45" }
    , { "_onnection", "Keep-Alive" }
    , { "Transfer-Encoding", "chunked" }
    , { "Content-Type", "text/html" }
    , { "Connection", "close" }
    }
  ,.body= ""
  ,.num_chunks_complete= 1
  ,.chunk_lengths= {}
  }

#define NON_ASCII_IN_STATUS_LINE 10
/* Should handle non-ASCII in status line */
, {.name= "non-ASCII in status line"
  ,.type= HTTP_RESPONSE
  ,.raw= "HTTP/1.1 500 Oriëntatieprobleem\r\n"
         "Date: Fri, 5 Nov 2010 23:07:12 GMT+2\r\n"
         "Content-Length: 0\r\n"
         "Connection: close\r\n"
         "\r\n"
  ,.should_keep_alive= FALSE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.status_code= 500
  ,.response_status= "Oriëntatieprobleem"
  ,.num_headers= 3
  ,.headers=
    { { "Date", "Fri, 5 Nov 2010 23:07:12 GMT+2" }
    , { "Content-Length", "0" }
    , { "Connection", "close" }
    }
  ,.body= ""
  }

#define HTTP_VERSION_0_9 11
/* Should handle HTTP/0.9 */
, {.name= "http version 0.9"
  ,.type= HTTP_RESPONSE
  ,.raw= "HTTP/0.9 200 OK\r\n"
         "\r\n"
  ,.should_keep_alive= FALSE
  ,.message_complete_on_eof= TRUE
  ,.http_major= 0
  ,.http_minor= 9
  ,.status_code= 200
  ,.response_status= "OK"
  ,.num_headers= 0
  ,.headers=
    {}
  ,.body= ""
  }

#define NO_CONTENT_LENGTH_NO_TRANSFER_ENCODING_RESPONSE 12
/* The client should wait for the server's EOF. That is, when neither
 * content-length nor transfer-encoding is specified, the end of body
 * is specified by the EOF.
 */
, {.name= "neither content-length nor transfer-encoding response"
  ,.type= HTTP_RESPONSE
  ,.raw= "HTTP/1.1 200 OK\r\n"
         "Content-Type: text/plain\r\n"
         "\r\n"
         "hello world"
  ,.should_keep_alive= FALSE
  ,.message_complete_on_eof= TRUE
  ,.http_major= 1
  ,.http_minor= 1
  ,.status_code= 200
  ,.response_status= "OK"
  ,.num_headers= 1
  ,.headers=
    { { "Content-Type", "text/plain" }
    }
  ,.body= "hello world"
  }

#define NO_BODY_HTTP10_KA_200 13
, {.name= "HTTP/1.0 with keep-alive and EOF-terminated 200 status"
  ,.type= HTTP_RESPONSE
  ,.raw= "HTTP/1.0 200 OK\r\n"
         "Connection: keep-alive\r\n"
         "\r\n"
  ,.should_keep_alive= FALSE
  ,.message_complete_on_eof= TRUE
  ,.http_major= 1
  ,.http_minor= 0
  ,.status_code= 200
  ,.response_status= "OK"
  ,.num_headers= 1
  ,.headers=
    { { "Connection", "keep-alive" }
    }
  ,.body_size= 0
  ,.body= ""
  }

#define NO_BODY_HTTP10_KA_204 14
, {.name= "HTTP/1.0 with keep-alive and a 204 status"
  ,.type= HTTP_RESPONSE
  ,.raw= "HTTP/1.0 204 No content\r\n"
         "Connection: keep-alive\r\n"
         "\r\n"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 0
  ,.status_code= 204
  ,.response_status= "No content"
  ,.num_headers= 1
  ,.headers=
    { { "Connection", "keep-alive" }
    }
  ,.body_size= 0
  ,.body= ""
  }

#define NO_BODY_HTTP11_KA_200 15
, {.name= "HTTP/1.1 with an EOF-terminated 200 status"
  ,.type= HTTP_RESPONSE
  ,.raw= "HTTP/1.1 200 OK\r\n"
         "\r\n"
  ,.should_keep_alive= FALSE
  ,.message_complete_on_eof= TRUE
  ,.http_major= 1
  ,.http_minor= 1
  ,.status_code= 200
  ,.response_status= "OK"
  ,.num_headers= 0
  ,.headers={}
  ,.body_size= 0
  ,.body= ""
  }

#define NO_BODY_HTTP11_KA_204 16
, {.name= "HTTP/1.1 with a 204 status"
  ,.type= HTTP_RESPONSE
  ,.raw= "HTTP/1.1 204 No content\r\n"
         "\r\n"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.status_code= 204
  ,.response_status= "No content"
  ,.num_headers= 0
  ,.headers={}
  ,.body_size= 0
  ,.body= ""
  }

#define NO_BODY_HTTP11_NOKA_204 17
, {.name= "HTTP/1.1 with a 204 status and keep-alive disabled"
  ,.type= HTTP_RESPONSE
  ,.raw= "HTTP/1.1 204 No content\r\n"
         "Connection: close\r\n"
         "\r\n"
  ,.should_keep_alive= FALSE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.status_code= 204
  ,.response_status= "No content"
  ,.num_headers= 1
  ,.headers=
    { { "Connection", "close" }
    }
  ,.body_size= 0
  ,.body= ""
  }

#define NO_BODY_HTTP11_KA_CHUNKED_200 18
, {.name= "HTTP/1.1 with chunked endocing and a 200 response"
  ,.type= HTTP_RESPONSE
  ,.raw= "HTTP/1.1 200 OK\r\n"
         "Transfer-Encoding: chunked\r\n"
         "\r\n"
         "0\r\n"
         "\r\n"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.status_code= 200
  ,.response_status= "OK"
  ,.num_headers= 1
  ,.headers=
    { { "Transfer-Encoding", "chunked" }
    }
  ,.body_size= 0
  ,.body= ""
  ,.num_chunks_complete= 1
  }

#if !HTTP_PARSER_STRICT
#define SPACE_IN_FIELD_RES 19
/* Should handle spaces in header fields */
, {.name= "field space"
  ,.type= HTTP_RESPONSE
  ,.raw= "HTTP/1.1 200 OK\r\n"
         "Server: Microsoft-IIS/6.0\r\n"
         "X-Powered-By: ASP.NET\r\n"
         "en-US Content-Type: text/xml\r\n" /* this is the problem */
         "Content-Type: text/xml\r\n"
         "Content-Length: 16\r\n"
         "Date: Fri, 23 Jul 2010 18:45:38 GMT\r\n"
         "Connection: keep-alive\r\n"
         "\r\n"
         "hello" /* fake body */
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.status_code= 200
  ,.response_status= "OK"
  ,.num_headers= 7
  ,.headers=
    { { "Server",  "Microsoft-IIS/6.0" }
    , { "X-Powered-By", "ASP.NET" }
    , { "en-US Content-Type", "text/xml" }
    , { "Content-Type", "text/xml" }
    , { "Content-Length", "16" }
    , { "Date", "Fri, 23 Jul 2010 18:45:38 GMT" }
    , { "Connection", "keep-alive" }
    }
  ,.body= "hello"
  }
#endif /* !HTTP_PARSER_STRICT */

#define AMAZON_COM 20
, {.name= "amazon.com"
  ,.type= HTTP_RESPONSE
  ,.raw= "HTTP/1.1 301 MovedPermanently\r\n"
         "Date: Wed, 15 May 2013 17:06:33 GMT\r\n"
         "Server: Server\r\n"
         "x-amz-id-1: 0GPHKXSJQ826RK7GZEB2\r\n"
         "p3p: policyref=\"http://www.amazon.com/w3c/p3p.xml\",CP=\"CAO DSP LAW CUR ADM IVAo IVDo CONo OTPo OUR DELi PUBi OTRi BUS PHY ONL UNI PUR FIN COM NAV INT DEM CNT STA HEA PRE LOC GOV OTC \"\r\n"
         "x-amz-id-2: STN69VZxIFSz9YJLbz1GDbxpbjG6Qjmmq5E3DxRhOUw+Et0p4hr7c/Q8qNcx4oAD\r\n"
         "Location: http://www.amazon.com/Dan-Brown/e/B000AP9DSU/ref=s9_pop_gw_al1?_encoding=UTF8&refinementId=618073011&pf_rd_m=ATVPDKIKX0DER&pf_rd_s=center-2&pf_rd_r=0SHYY5BZXN3KR20BNFAY&pf_rd_t=101&pf_rd_p=1263340922&pf_rd_i=507846\r\n"
         "Vary: Accept-Encoding,User-Agent\r\n"
         "Content-Type: text/html; charset=ISO-8859-1\r\n"
         "Transfer-Encoding: chunked\r\n"
         "\r\n"
         "1\r\n"
         "\n\r\n"
         "0\r\n"
         "\r\n"
  ,.should_keep_alive= TRUE
  ,.message_complete_on_eof= FALSE
  ,.http_major= 1
  ,.http_minor= 1
  ,.status_code= 301
  ,.response_status= "MovedPermanently"
  ,.num_headers= 9
  ,.headers= { { "Date", "Wed, 15 May 2013 17:06:33 GMT" }
             , { "Server", "Server" }
             , { "x-amz-id-1", "0GPHKXSJQ826RK7GZEB2" }
             , { "p3p", "policyref=\"http://www.amazon.com/w3c/p3p.xml\",CP=\"CAO DSP LAW CUR ADM IVAo IVDo CONo OTPo OUR DELi PUBi OTRi BUS PHY ONL UNI PUR FIN COM NAV INT DEM CNT STA HEA PRE LOC GOV OTC \"" }
             , { "x-amz-id-2", "STN69VZxIFSz9YJLbz1GDbxpbjG6Qjmmq5E3DxRhOUw+Et0p4hr7c/Q8qNcx4oAD" }
             , { "Location", "http://www.amazon.com/Dan-Brown/e/B000AP9DSU/ref=s9_pop_gw_al1?_encoding=UTF8&refinementId=618073011&pf_rd_m=ATVPDKIKX0DER&pf_rd_s=center-2&pf_rd_r=0SHYY5BZXN3KR20BNFAY&pf_rd_t=101&pf_rd_p=1263340922&pf_rd_i=507846" }
             , { "Vary", "Accept-Encoding,User-Agent" }
             , { "Content-Type", "text/html; charset=ISO-8859-1" }
             , { "Transfer-Encoding", "chunked" }
             }
  ,.body= "\n"
  ,.num_chunks_complete= 2
  ,.chunk_lengths= { 1 }
  }

#define EMPTY_REASON_PHRASE_AFTER_SPACE 20
, {.name= "empty reason phrase after space"
  ,.type= HTTP_RESPONSE
  ,.raw= "HTTP/1.1 200 \r\n"
         "\r\n"
  ,.should_keep_alive= FALSE
  ,.message_complete_on_eof= TRUE
  ,.http_major= 1
  ,.http_minor= 1
  ,.status_code= 200
  ,.response_status= ""
  ,.num_headers= 0
  ,.headers= {}
  ,.body= ""
  }

, {.name= NULL } /* sentinel */
};

/* strnlen() is a POSIX.2008 addition. Can't rely on it being available so
 * define it ourselves.
 */
size_t
strnlen(const char *s, size_t maxlen)
{
  const char *p;

  p = memchr(s, '\0', maxlen);
  if (p == NULL)
    return maxlen;

  return p - s;
}

size_t
strlncat(char *dst, size_t len, const char *src, size_t n)
{
  size_t slen;
  size_t dlen;
  size_t rlen;
  size_t ncpy;

  slen = strnlen(src, n);
  dlen = strnlen(dst, len);

  if (dlen < len) {
    rlen = len - dlen;
    ncpy = slen < rlen ? slen : (rlen - 1);
    memcpy(dst + dlen, src, ncpy);
    dst[dlen + ncpy] = '\0';
  }

  assert(len > slen + dlen);
  return slen + dlen;
}

size_t
strlcat(char *dst, const char *src, size_t len)
{
  return strlncat(dst, len, src, (size_t) -1);
}

size_t
strlncpy(char *dst, size_t len, const char *src, size_t n)
{
  size_t slen;
  size_t ncpy;

  slen = strnlen(src, n);

  if (len > 0) {
    ncpy = slen < len ? slen : (len - 1);
    memcpy(dst, src, ncpy);
    dst[ncpy] = '\0';
  }

  assert(len > slen);
  return slen;
}

size_t
strlcpy(char *dst, const char *src, size_t len)
{
  return strlncpy(dst, len, src, (size_t) -1);
}

int
request_url_cb (http_parser *p, const char *buf, size_t len)
{
  assert(p == parser);
  strlncat(messages[num_messages].request_url,
           sizeof(messages[num_messages].request_url),
           buf,
           len);
  return 0;
}

int
header_field_cb (http_parser *p, const char *buf, size_t len)
{
  assert(p == parser);
  struct message *m = &messages[num_messages];

  if (m->last_header_element != FIELD)
    m->num_headers++;

  strlncat(m->headers[m->num_headers-1][0],
           sizeof(m->headers[m->num_headers-1][0]),
           buf,
           len);

  m->last_header_element = FIELD;

  return 0;
}

int
header_value_cb (http_parser *p, const char *buf, size_t len)
{
  assert(p == parser);
  struct message *m = &messages[num_messages];

  strlncat(m->headers[m->num_headers-1][1],
           sizeof(m->headers[m->num_headers-1][1]),
           buf,
           len);

  m->last_header_element = VALUE;

  return 0;
}

void
check_body_is_final (const http_parser *p)
{
  if (messages[num_messages].body_is_final) {
    fprintf(stderr, "\n\n *** Error http_body_is_final() should return 1 "
                    "on last on_body callback call "
                    "but it doesn't! ***\n\n");
    assert(0);
    abort();
  }
  messages[num_messages].body_is_final = http_body_is_final(p);
}

int
body_cb (http_parser *p, const char *buf, size_t len)
{
  assert(p == parser);
  strlncat(messages[num_messages].body,
           sizeof(messages[num_messages].body),
           buf,
           len);
  messages[num_messages].body_size += len;
  check_body_is_final(p);
 // printf("body_cb: '%s'\n", requests[num_messages].body);
  return 0;
}

int
count_body_cb (http_parser *p, const char *buf, size_t len)
{
  assert(p == parser);
  assert(buf);
  messages[num_messages].body_size += len;
  check_body_is_final(p);
  return 0;
}

int
message_begin_cb (http_parser *p)
{
  assert(p == parser);
  messages[num_messages].message_begin_cb_called = TRUE;
  return 0;
}

int
headers_complete_cb (http_parser *p)
{
  assert(p == parser);
  messages[num_messages].method = parser->method;
  messages[num_messages].status_code = parser->status_code;
  messages[num_messages].http_major = parser->http_major;
  messages[num_messages].http_minor = parser->http_minor;
  messages[num_messages].headers_complete_cb_called = TRUE;
  messages[num_messages].should_keep_alive = http_should_keep_alive(parser);
  return 0;
}

int
message_complete_cb (http_parser *p)
{
  assert(p == parser);
  if (messages[num_messages].should_keep_alive != http_should_keep_alive(parser))
  {
    fprintf(stderr, "\n\n *** Error http_should_keep_alive() should have same "
                    "value in both on_message_complete and on_headers_complete "
                    "but it doesn't! ***\n\n");
    assert(0);
    abort();
  }

  if (messages[num_messages].body_size &&
      http_body_is_final(p) &&
      !messages[num_messages].body_is_final)
  {
    fprintf(stderr, "\n\n *** Error http_body_is_final() should return 1 "
                    "on last on_body callback call "
                    "but it doesn't! ***\n\n");
    assert(0);
    abort();
  }

  messages[num_messages].message_complete_cb_called = TRUE;

  messages[num_messages].message_complete_on_eof = currently_parsing_eof;

  num_messages++;
  return 0;
}

int
response_status_cb (http_parser *p, const char *buf, size_t len)
{
  assert(p == parser);
  strlncat(messages[num_messages].response_status,
           sizeof(messages[num_messages].response_status),
           buf,
           len);
  return 0;
}

int
chunk_header_cb (http_parser *p)
{
  assert(p == parser);
  int chunk_idx = messages[num_messages].num_chunks;
  messages[num_messages].num_chunks++;
  if (chunk_idx < MAX_CHUNKS) {
    messages[num_messages].chunk_lengths[chunk_idx] = p->content_length;
  }

  return 0;
}

int
chunk_complete_cb (http_parser *p)
{
  assert(p == parser);

  /* Here we want to verify that each chunk_header_cb is matched by a
   * chunk_complete_cb, so not only should the total number of calls to
   * both callbacks be the same, but they also should be interleaved
   * properly */
  assert(messages[num_messages].num_chunks ==
         messages[num_messages].num_chunks_complete + 1);

  messages[num_messages].num_chunks_complete++;
  return 0;
}

/* These dontcall_* callbacks exist so that we can verify that when we're
 * paused, no additional callbacks are invoked */
int
dontcall_message_begin_cb (http_parser *p)
{
  if (p) { } // gcc
  fprintf(stderr, "\n\n*** on_message_begin() called on paused parser ***\n\n");
  abort();
}

int
dontcall_header_field_cb (http_parser *p, const char *buf, size_t len)
{
  if (p || buf || len) { } // gcc
  fprintf(stderr, "\n\n*** on_header_field() called on paused parser ***\n\n");
  abort();
}

int
dontcall_header_value_cb (http_parser *p, const char *buf, size_t len)
{
  if (p || buf || len) { } // gcc
  fprintf(stderr, "\n\n*** on_header_value() called on paused parser ***\n\n");
  abort();
}

int
dontcall_request_url_cb (http_parser *p, const char *buf, size_t len)
{
  if (p || buf || len) { } // gcc
  fprintf(stderr, "\n\n*** on_request_url() called on paused parser ***\n\n");
  abort();
}

int
dontcall_body_cb (http_parser *p, const char *buf, size_t len)
{
  if (p || buf || len) { } // gcc
  fprintf(stderr, "\n\n*** on_body_cb() called on paused parser ***\n\n");
  abort();
}

int
dontcall_headers_complete_cb (http_parser *p)
{
  if (p) { } // gcc
  fprintf(stderr, "\n\n*** on_headers_complete() called on paused "
                  "parser ***\n\n");
  abort();
}

int
dontcall_message_complete_cb (http_parser *p)
{
  if (p) { } // gcc
  fprintf(stderr, "\n\n*** on_message_complete() called on paused "
                  "parser ***\n\n");
  abort();
}

int
dontcall_response_status_cb (http_parser *p, const char *buf, size_t len)
{
  if (p || buf || len) { } // gcc
  fprintf(stderr, "\n\n*** on_status() called on paused parser ***\n\n");
  abort();
}

int
dontcall_chunk_header_cb (http_parser *p)
{
  if (p) { } // gcc
  fprintf(stderr, "\n\n*** on_chunk_header() called on paused parser ***\n\n");
  exit(1);
}

int
dontcall_chunk_complete_cb (http_parser *p)
{
  if (p) { } // gcc
  fprintf(stderr, "\n\n*** on_chunk_complete() "
          "called on paused parser ***\n\n");
  exit(1);
}

static http_parser_settings settings_dontcall =
  {.on_message_begin = dontcall_message_begin_cb
  ,.on_header_field = dontcall_header_field_cb
  ,.on_header_value = dontcall_header_value_cb
  ,.on_url = dontcall_request_url_cb
  ,.on_status = dontcall_response_status_cb
  ,.on_body = dontcall_body_cb
  ,.on_headers_complete = dontcall_headers_complete_cb
  ,.on_message_complete = dontcall_message_complete_cb
  ,.on_chunk_header = dontcall_chunk_header_cb
  ,.on_chunk_complete = dontcall_chunk_complete_cb
  };

/* These pause_* callbacks always pause the parser and just invoke the regular
 * callback that tracks content. Before returning, we overwrite the parser
 * settings to point to the _dontcall variety so that we can verify that
 * the pause actually did, you know, pause. */
int
pause_message_begin_cb (http_parser *p)
{
  http_parser_pause(p, 1);
  *current_pause_parser = settings_dontcall;
  return message_begin_cb(p);
}

int
pause_header_field_cb (http_parser *p, const char *buf, size_t len)
{
  http_parser_pause(p, 1);
  *current_pause_parser = settings_dontcall;
  return header_field_cb(p, buf, len);
}

int
pause_header_value_cb (http_parser *p, const char *buf, size_t len)
{
  http_parser_pause(p, 1);
  *current_pause_parser = settings_dontcall;
  return header_value_cb(p, buf, len);
}

int
pause_request_url_cb (http_parser *p, const char *buf, size_t len)
{
  http_parser_pause(p, 1);
  *current_pause_parser = settings_dontcall;
  return request_url_cb(p, buf, len);
}

int
pause_body_cb (http_parser *p, const char *buf, size_t len)
{
  http_parser_pause(p, 1);
  *current_pause_parser = settings_dontcall;
  return body_cb(p, buf, len);
}

int
pause_headers_complete_cb (http_parser *p)
{
  http_parser_pause(p, 1);
  *current_pause_parser = settings_dontcall;
  return headers_complete_cb(p);
}

int
pause_message_complete_cb (http_parser *p)
{
  http_parser_pause(p, 1);
  *current_pause_parser = settings_dontcall;
  return message_complete_cb(p);
}

int
pause_response_status_cb (http_parser *p, const char *buf, size_t len)
{
  http_parser_pause(p, 1);
  *current_pause_parser = settings_dontcall;
  return response_status_cb(p, buf, len);
}

int
pause_chunk_header_cb (http_parser *p)
{
  http_parser_pause(p, 1);
  *current_pause_parser = settings_dontcall;
  return chunk_header_cb(p);
}

int
pause_chunk_complete_cb (http_parser *p)
{
  http_parser_pause(p, 1);
  *current_pause_parser = settings_dontcall;
  return chunk_complete_cb(p);
}

int
connect_headers_complete_cb (http_parser *p)
{
  headers_complete_cb(p);
  return 1;
}

int
connect_message_complete_cb (http_parser *p)
{
  messages[num_messages].should_keep_alive = http_should_keep_alive(parser);
  return message_complete_cb(p);
}

static http_parser_settings settings_pause =
  {.on_message_begin = pause_message_begin_cb
  ,.on_header_field = pause_header_field_cb
  ,.on_header_value = pause_header_value_cb
  ,.on_url = pause_request_url_cb
  ,.on_status = pause_response_status_cb
  ,.on_body = pause_body_cb
  ,.on_headers_complete = pause_headers_complete_cb
  ,.on_message_complete = pause_message_complete_cb
  ,.on_chunk_header = pause_chunk_header_cb
  ,.on_chunk_complete = pause_chunk_complete_cb
  };

static http_parser_settings settings =
  {.on_message_begin = message_begin_cb
  ,.on_header_field = header_field_cb
  ,.on_header_value = header_value_cb
  ,.on_url = request_url_cb
  ,.on_status = response_status_cb
  ,.on_body = body_cb
  ,.on_headers_complete = headers_complete_cb
  ,.on_message_complete = message_complete_cb
  ,.on_chunk_header = chunk_header_cb
  ,.on_chunk_complete = chunk_complete_cb
  };

static http_parser_settings settings_count_body =
  {.on_message_begin = message_begin_cb
  ,.on_header_field = header_field_cb
  ,.on_header_value = header_value_cb
  ,.on_url = request_url_cb
  ,.on_status = response_status_cb
  ,.on_body = count_body_cb
  ,.on_headers_complete = headers_complete_cb
  ,.on_message_complete = message_complete_cb
  ,.on_chunk_header = chunk_header_cb
  ,.on_chunk_complete = chunk_complete_cb
  };

static http_parser_settings settings_connect =
  {.on_message_begin = message_begin_cb
  ,.on_header_field = header_field_cb
  ,.on_header_value = header_value_cb
  ,.on_url = request_url_cb
  ,.on_status = response_status_cb
  ,.on_body = dontcall_body_cb
  ,.on_headers_complete = connect_headers_complete_cb
  ,.on_message_complete = connect_message_complete_cb
  ,.on_chunk_header = chunk_header_cb
  ,.on_chunk_complete = chunk_complete_cb
  };

static http_parser_settings settings_null =
  {.on_message_begin = 0
  ,.on_header_field = 0
  ,.on_header_value = 0
  ,.on_url = 0
  ,.on_status = 0
  ,.on_body = 0
  ,.on_headers_complete = 0
  ,.on_message_complete = 0
  ,.on_chunk_header = 0
  ,.on_chunk_complete = 0
  };

void
parser_init (enum http_parser_type type)
{
  num_messages = 0;

  assert(parser == NULL);

  parser = malloc(sizeof(http_parser));

  http_parser_init(parser, type);

  memset(&messages, 0, sizeof messages);

}

void
parser_free ()
{
  assert(parser);
  free(parser);
  parser = NULL;
}

size_t parse (const char *buf, size_t len)
{
  size_t nparsed;
  currently_parsing_eof = (len == 0);
  nparsed = http_parser_execute(parser, &settings, buf, len);
  return nparsed;
}

size_t parse_count_body (const char *buf, size_t len)
{
  size_t nparsed;
  currently_parsing_eof = (len == 0);
  nparsed = http_parser_execute(parser, &settings_count_body, buf, len);
  return nparsed;
}

size_t parse_pause (const char *buf, size_t len)
{
  size_t nparsed;
  http_parser_settings s = settings_pause;

  currently_parsing_eof = (len == 0);
  current_pause_parser = &s;
  nparsed = http_parser_execute(parser, current_pause_parser, buf, len);
  return nparsed;
}

size_t parse_connect (const char *buf, size_t len)
{
  size_t nparsed;
  currently_parsing_eof = (len == 0);
  nparsed = http_parser_execute(parser, &settings_connect, buf, len);
  return nparsed;
}

static inline int
check_str_eq (const struct message *m,
              const char *prop,
              const char *expected,
              const char *found) {
  if ((expected == NULL) != (found == NULL)) {
    printf("\n*** Error: %s in '%s' ***\n\n", prop, m->name);
    printf("expected %s\n", (expected == NULL) ? "NULL" : expected);
    printf("   found %s\n", (found == NULL) ? "NULL" : found);
    return 0;
  }
  if (expected != NULL && 0 != strcmp(expected, found)) {
    printf("\n*** Error: %s in '%s' ***\n\n", prop, m->name);
    printf("expected '%s'\n", expected);
    printf("   found '%s'\n", found);
    return 0;
  }
  return 1;
}

static inline int
check_num_eq (const struct message *m,
              const char *prop,
              int expected,
              int found) {
  if (expected != found) {
    printf("\n*** Error: %s in '%s' ***\n\n", prop, m->name);
    printf("expected %d\n", expected);
    printf("   found %d\n", found);
    return 0;
  }
  return 1;
}

#define MESSAGE_CHECK_STR_EQ(expected, found, prop) \
  if (!check_str_eq(expected, #prop, expected->prop, found->prop)) return 0

#define MESSAGE_CHECK_NUM_EQ(expected, found, prop) \
  if (!check_num_eq(expected, #prop, expected->prop, found->prop)) return 0

#define MESSAGE_CHECK_URL_EQ(u, expected, found, prop, fn)           \
do {                                                                 \
  char ubuf[256];                                                    \
                                                                     \
  if ((u)->field_set & (1 << (fn))) {                                \
    memcpy(ubuf, (found)->request_url + (u)->field_data[(fn)].off,   \
      (u)->field_data[(fn)].len);                                    \
    ubuf[(u)->field_data[(fn)].len] = '\0';                          \
  } else {                                                           \
    ubuf[0] = '\0';                                                  \
  }                                                                  \
                                                                     \
  check_str_eq(expected, #prop, expected->prop, ubuf);               \
} while(0)

int
message_eq (int index, int connect, const struct message *expected)
{
  int i;
  struct message *m = &messages[index];

  MESSAGE_CHECK_NUM_EQ(expected, m, http_major);
  MESSAGE_CHECK_NUM_EQ(expected, m, http_minor);

  if (expected->type == HTTP_REQUEST) {
    MESSAGE_CHECK_NUM_EQ(expected, m, method);
  } else {
    MESSAGE_CHECK_NUM_EQ(expected, m, status_code);
    MESSAGE_CHECK_STR_EQ(expected, m, response_status);
  }

  if (!connect) {
    MESSAGE_CHECK_NUM_EQ(expected, m, should_keep_alive);
    MESSAGE_CHECK_NUM_EQ(expected, m, message_complete_on_eof);
  }

  assert(m->message_begin_cb_called);
  assert(m->headers_complete_cb_called);
  assert(m->message_complete_cb_called);


  MESSAGE_CHECK_STR_EQ(expected, m, request_url);

  /* Check URL components; we can't do this w/ CONNECT since it doesn't
   * send us a well-formed URL.
   */
  if (*m->request_url && m->method != HTTP_CONNECT) {
    struct http_parser_url u;

    if (http_parser_parse_url(m->request_url, strlen(m->request_url), 0, &u)) {
      fprintf(stderr, "\n\n*** failed to parse URL %s ***\n\n",
        m->request_url);
      abort();
    }

    if (expected->host) {
      MESSAGE_CHECK_URL_EQ(&u, expected, m, host, UF_HOST);
    }

    if (expected->userinfo) {
      MESSAGE_CHECK_URL_EQ(&u, expected, m, userinfo, UF_USERINFO);
    }

    m->port = (u.field_set & (1 << UF_PORT)) ?
      u.port : 0;

    MESSAGE_CHECK_URL_EQ(&u, expected, m, query_string, UF_QUERY);
    MESSAGE_CHECK_URL_EQ(&u, expected, m, fragment, UF_FRAGMENT);
    MESSAGE_CHECK_URL_EQ(&u, expected, m, request_path, UF_PATH);
    MESSAGE_CHECK_NUM_EQ(expected, m, port);
  }

  if (connect) {
    check_num_eq(m, "body_size", 0, m->body_size);
  } else if (expected->body_size) {
    MESSAGE_CHECK_NUM_EQ(expected, m, body_size);
  } else {
    MESSAGE_CHECK_STR_EQ(expected, m, body);
  }

  if (connect) {
    check_num_eq(m, "num_chunks_complete", 0, m->num_chunks_complete);
  } else {
    assert(m->num_chunks == m->num_chunks_complete);
    MESSAGE_CHECK_NUM_EQ(expected, m, num_chunks_complete);
    for (i = 0; i < m->num_chunks && i < MAX_CHUNKS; i++) {
      MESSAGE_CHECK_NUM_EQ(expected, m, chunk_lengths[i]);
    }
  }

  MESSAGE_CHECK_NUM_EQ(expected, m, num_headers);

  int r;
  for (i = 0; i < m->num_headers; i++) {
    r = check_str_eq(expected, "header field", expected->headers[i][0], m->headers[i][0]);
    if (!r) return 0;
    r = check_str_eq(expected, "header value", expected->headers[i][1], m->headers[i][1]);
    if (!r) return 0;
  }

  MESSAGE_CHECK_STR_EQ(expected, m, upgrade);

  return 1;
}

/* Given a sequence of varargs messages, return the number of them that the
 * parser should successfully parse, taking into account that upgraded
 * messages prevent all subsequent messages from being parsed.
 */
size_t
count_parsed_messages(const size_t nmsgs, ...) {
  size_t i;
  va_list ap;

  va_start(ap, nmsgs);

  for (i = 0; i < nmsgs; i++) {
    struct message *m = va_arg(ap, struct message *);

    if (m->upgrade) {
      va_end(ap);
      return i + 1;
    }
  }

  va_end(ap);
  return nmsgs;
}

/* Given a sequence of bytes and the number of these that we were able to
 * parse, verify that upgrade bodies are correct.
 */
void
upgrade_message_fix(char *body, const size_t nread, const size_t nmsgs, ...) {
  va_list ap;
  size_t i;
  size_t off = 0;

  va_start(ap, nmsgs);

  for (i = 0; i < nmsgs; i++) {
    struct message *m = va_arg(ap, struct message *);

    off += strlen(m->raw);

    if (m->upgrade) {
      off -= strlen(m->upgrade);

      /* Check the portion of the response after its specified upgrade */
      if (!check_str_eq(m, "upgrade", body + off, body + nread)) {
        abort();
      }

      /* Fix up the response so that message_eq() will verify the beginning
       * of the upgrade */
      *(body + nread + strlen(m->upgrade)) = '\0';
      messages[num_messages -1 ].upgrade = body + nread;

      va_end(ap);
      return;
    }
  }

  va_end(ap);
  printf("\n\n*** Error: expected a message with upgrade ***\n");

  abort();
}

static void
print_error (const char *raw, size_t error_location)
{
  fprintf(stderr, "\n*** %s ***\n\n",
          http_errno_description(HTTP_PARSER_ERRNO(parser)));

  int this_line = 0, char_len = 0;
  size_t i, j, len = strlen(raw), error_location_line = 0;
  for (i = 0; i < len; i++) {
    if (i == error_location) this_line = 1;
    switch (raw[i]) {
      case '\r':
        char_len = 2;
        fprintf(stderr, "\\r");
        break;

      case '\n':
        fprintf(stderr, "\\n\n");

        if (this_line) goto print;

        error_location_line = 0;
        continue;

      default:
        char_len = 1;
        fputc(raw[i], stderr);
        break;
    }
    if (!this_line) error_location_line += char_len;
  }

  fprintf(stderr, "[eof]\n");

 print:
  for (j = 0; j < error_location_line; j++) {
    fputc(' ', stderr);
  }
  fprintf(stderr, "^\n\nerror location: %u\n", (unsigned int)error_location);
}

void
test_preserve_data (void)
{
  char my_data[] = "application-specific data";
  http_parser parser;
  parser.data = my_data;
  http_parser_init(&parser, HTTP_REQUEST);
  if (parser.data != my_data) {
    printf("\n*** parser.data not preserved accross http_parser_init ***\n\n");
    abort();
  }
}

struct url_test {
  const char *name;
  const char *url;
  int is_connect;
  struct http_parser_url u;
  int rv;
};

const struct url_test url_tests[] =
{ {.name="proxy request"
  ,.url="http://hostname/"
  ,.is_connect=0
  ,.u=
    {.field_set=(1 << UF_SCHEMA) | (1 << UF_HOST) | (1 << UF_PATH)
    ,.port=0
    ,.field_data=
      {{  0,  4 } /* UF_SCHEMA */
      ,{  7,  8 } /* UF_HOST */
      ,{  0,  0 } /* UF_PORT */
      ,{ 15,  1 } /* UF_PATH */
      ,{  0,  0 } /* UF_QUERY */
      ,{  0,  0 } /* UF_FRAGMENT */
      ,{  0,  0 } /* UF_USERINFO */
      }
    }
  ,.rv=0
  }

, {.name="proxy request with port"
  ,.url="http://hostname:444/"
  ,.is_connect=0
  ,.u=
    {.field_set=(1 << UF_SCHEMA) | (1 << UF_HOST) | (1 << UF_PORT) | (1 << UF_PATH)
    ,.port=444
    ,.field_data=
      {{  0,  4 } /* UF_SCHEMA */
      ,{  7,  8 } /* UF_HOST */
      ,{ 16,  3 } /* UF_PORT */
      ,{ 19,  1 } /* UF_PATH */
      ,{  0,  0 } /* UF_QUERY */
      ,{  0,  0 } /* UF_FRAGMENT */
      ,{  0,  0 } /* UF_USERINFO */
      }
    }
  ,.rv=0
  }

, {.name="CONNECT request"
  ,.url="hostname:443"
  ,.is_connect=1
  ,.u=
    {.field_set=(1 << UF_HOST) | (1 << UF_PORT)
    ,.port=443
    ,.field_data=
      {{  0,  0 } /* UF_SCHEMA */
      ,{  0,  8 } /* UF_HOST */
      ,{  9,  3 } /* UF_PORT */
      ,{  0,  0 } /* UF_PATH */
      ,{  0,  0 } /* UF_QUERY */
      ,{  0,  0 } /* UF_FRAGMENT */
      ,{  0,  0 } /* UF_USERINFO */
      }
    }
  ,.rv=0
  }

, {.name="CONNECT request but not connect"
  ,.url="hostname:443"
  ,.is_connect=0
  ,.rv=1
  }

, {.name="proxy ipv6 request"
  ,.url="http://[1:2::3:4]/"
  ,.is_connect=0
  ,.u=
    {.field_set=(1 << UF_SCHEMA) | (1 << UF_HOST) | (1 << UF_PATH)
    ,.port=0
    ,.field_data=
      {{  0,  4 } /* UF_SCHEMA */
      ,{  8,  8 } /* UF_HOST */
      ,{  0,  0 } /* UF_PORT */
      ,{ 17,  1 } /* UF_PATH */
      ,{  0,  0 } /* UF_QUERY */
      ,{  0,  0 } /* UF_FRAGMENT */
      ,{  0,  0 } /* UF_USERINFO */
      }
    }
  ,.rv=0
  }

, {.name="proxy ipv6 request with port"
  ,.url="http://[1:2::3:4]:67/"
  ,.is_connect=0
  ,.u=
    {.field_set=(1 << UF_SCHEMA) | (1 << UF_HOST) | (1 << UF_PORT) | (1 << UF_PATH)
    ,.port=67
    ,.field_data=
      {{  0,  4 } /* UF_SCHEMA */
      ,{  8,  8 } /* UF_HOST */
      ,{ 18,  2 } /* UF_PORT */
      ,{ 20,  1 } /* UF_PATH */
      ,{  0,  0 } /* UF_QUERY */
      ,{  0,  0 } /* UF_FRAGMENT */
      ,{  0,  0 } /* UF_USERINFO */
      }
    }
  ,.rv=0
  }

, {.name="CONNECT ipv6 address"
  ,.url="[1:2::3:4]:443"
  ,.is_connect=1
  ,.u=
    {.field_set=(1 << UF_HOST) | (1 << UF_PORT)
    ,.port=443
    ,.field_data=
      {{  0,  0 } /* UF_SCHEMA */
      ,{  1,  8 } /* UF_HOST */
      ,{ 11,  3 } /* UF_PORT */
      ,{  0,  0 } /* UF_PATH */
      ,{  0,  0 } /* UF_QUERY */
      ,{  0,  0 } /* UF_FRAGMENT */
      ,{  0,  0 } /* UF_USERINFO */
      }
    }
  ,.rv=0
  }

, {.name="ipv4 in ipv6 address"
  ,.url="http://[2001:0000:0000:0000:0000:0000:1.9.1.1]/"
  ,.is_connect=0
  ,.u=
    {.field_set=(1 << UF_SCHEMA) | (1 << UF_HOST) | (1 << UF_PATH)
    ,.port=0
    ,.field_data=
      {{  0,  4 } /* UF_SCHEMA */
      ,{  8, 37 } /* UF_HOST */
      ,{  0,  0 } /* UF_PORT */
      ,{ 46,  1 } /* UF_PATH */
      ,{  0,  0 } /* UF_QUERY */
      ,{  0,  0 } /* UF_FRAGMENT */
      ,{  0,  0 } /* UF_USERINFO */
      }
    }
  ,.rv=0
  }

, {.name="extra ? in query string"
  ,.url="http://a.tbcdn.cn/p/fp/2010c/??fp-header-min.css,fp-base-min.css,"
  "fp-channel-min.css,fp-product-min.css,fp-mall-min.css,fp-category-min.css,"
  "fp-sub-min.css,fp-gdp4p-min.css,fp-css3-min.css,fp-misc-min.css?t=20101022.css"
  ,.is_connect=0
  ,.u=
    {.field_set=(1<field_set, u->port);
  for (i = 0; i < UF_MAX; i++) {
    if ((u->field_set & (1 << i)) == 0) {
      printf("\tfield_data[%u]: unset\n", i);
      continue;
    }

    printf("\tfield_data[%u]: off: %u len: %u part: \"%.*s\n\"",
           i,
           u->field_data[i].off,
           u->field_data[i].len,
           u->field_data[i].len,
           url + u->field_data[i].off);
  }
}

void
test_parse_url (void)
{
  struct http_parser_url u;
  const struct url_test *test;
  unsigned int i;
  int rv;

  for (i = 0; i < (sizeof(url_tests) / sizeof(url_tests[0])); i++) {
    test = &url_tests[i];
    memset(&u, 0, sizeof(u));

    rv = http_parser_parse_url(test->url,
                               strlen(test->url),
                               test->is_connect,
                               &u);

    if (test->rv == 0) {
      if (rv != 0) {
        printf("\n*** http_parser_parse_url(\"%s\") \"%s\" test failed, "
               "unexpected rv %d ***\n\n", test->url, test->name, rv);
        abort();
      }

      if (memcmp(&u, &test->u, sizeof(u)) != 0) {
        printf("\n*** http_parser_parse_url(\"%s\") \"%s\" failed ***\n",
               test->url, test->name);

        printf("target http_parser_url:\n");
        dump_url(test->url, &test->u);
        printf("result http_parser_url:\n");
        dump_url(test->url, &u);

        abort();
      }
    } else {
      /* test->rv != 0 */
      if (rv == 0) {
        printf("\n*** http_parser_parse_url(\"%s\") \"%s\" test failed, "
               "unexpected rv %d ***\n\n", test->url, test->name, rv);
        abort();
      }
    }
  }
}

void
test_method_str (void)
{
  assert(0 == strcmp("GET", http_method_str(HTTP_GET)));
  assert(0 == strcmp("", http_method_str(1337)));
}

void
test_message (const struct message *message)
{
  size_t raw_len = strlen(message->raw);
  size_t msg1len;
  for (msg1len = 0; msg1len < raw_len; msg1len++) {
    parser_init(message->type);

    size_t read;
    const char *msg1 = message->raw;
    const char *msg2 = msg1 + msg1len;
    size_t msg2len = raw_len - msg1len;

    if (msg1len) {
      read = parse(msg1, msg1len);

      if (message->upgrade && parser->upgrade && num_messages > 0) {
        messages[num_messages - 1].upgrade = msg1 + read;
        goto test;
      }

      if (read != msg1len) {
        print_error(msg1, read);
        abort();
      }
    }


    read = parse(msg2, msg2len);

    if (message->upgrade && parser->upgrade) {
      messages[num_messages - 1].upgrade = msg2 + read;
      goto test;
    }

    if (read != msg2len) {
      print_error(msg2, read);
      abort();
    }

    read = parse(NULL, 0);

    if (read != 0) {
      print_error(message->raw, read);
      abort();
    }

  test:

    if (num_messages != 1) {
      printf("\n*** num_messages != 1 after testing '%s' ***\n\n", message->name);
      abort();
    }

    if(!message_eq(0, 0, message)) abort();

    parser_free();
  }
}

void
test_message_count_body (const struct message *message)
{
  parser_init(message->type);

  size_t read;
  size_t l = strlen(message->raw);
  size_t i, toread;
  size_t chunk = 4024;

  for (i = 0; i < l; i+= chunk) {
    toread = MIN(l-i, chunk);
    read = parse_count_body(message->raw + i, toread);
    if (read != toread) {
      print_error(message->raw, read);
      abort();
    }
  }


  read = parse_count_body(NULL, 0);
  if (read != 0) {
    print_error(message->raw, read);
    abort();
  }

  if (num_messages != 1) {
    printf("\n*** num_messages != 1 after testing '%s' ***\n\n", message->name);
    abort();
  }

  if(!message_eq(0, 0, message)) abort();

  parser_free();
}

void
test_simple (const char *buf, enum http_errno err_expected)
{
  parser_init(HTTP_REQUEST);

  enum http_errno err;

  parse(buf, strlen(buf));
  err = HTTP_PARSER_ERRNO(parser);
  parse(NULL, 0);

  parser_free();

  /* In strict mode, allow us to pass with an unexpected HPE_STRICT as
   * long as the caller isn't expecting success.
   */
#if HTTP_PARSER_STRICT
  if (err_expected != err && err_expected != HPE_OK && err != HPE_STRICT) {
#else
  if (err_expected != err) {
#endif
    fprintf(stderr, "\n*** test_simple expected %s, but saw %s ***\n\n%s\n",
        http_errno_name(err_expected), http_errno_name(err), buf);
    abort();
  }
}

void
test_invalid_header_content (int req, const char* str)
{
  http_parser parser;
  http_parser_init(&parser, req ? HTTP_REQUEST : HTTP_RESPONSE);
  size_t parsed;
  const char *buf;
  buf = req ?
    "GET / HTTP/1.1\r\n" :
    "HTTP/1.1 200 OK\r\n";
  parsed = http_parser_execute(&parser, &settings_null, buf, strlen(buf));
  assert(parsed == strlen(buf));

  buf = str;
  size_t buflen = strlen(buf);

  parsed = http_parser_execute(&parser, &settings_null, buf, buflen);
  if (parsed != buflen) {
    assert(HTTP_PARSER_ERRNO(&parser) == HPE_INVALID_HEADER_TOKEN);
    return;
  }

  fprintf(stderr,
          "\n*** Error expected but none in invalid header content test ***\n");
  abort();
}

void
test_invalid_header_field_content_error (int req)
{
  test_invalid_header_content(req, "Foo: F\01ailure");
  test_invalid_header_content(req, "Foo: B\02ar");
}

void
test_invalid_header_field (int req, const char* str)
{
  http_parser parser;
  http_parser_init(&parser, req ? HTTP_REQUEST : HTTP_RESPONSE);
  size_t parsed;
  const char *buf;
  buf = req ?
    "GET / HTTP/1.1\r\n" :
    "HTTP/1.1 200 OK\r\n";
  parsed = http_parser_execute(&parser, &settings_null, buf, strlen(buf));
  assert(parsed == strlen(buf));

  buf = str;
  size_t buflen = strlen(buf);

  parsed = http_parser_execute(&parser, &settings_null, buf, buflen);
  if (parsed != buflen) {
    assert(HTTP_PARSER_ERRNO(&parser) == HPE_INVALID_HEADER_TOKEN);
    return;
  }

  fprintf(stderr,
          "\n*** Error expected but none in invalid header token test ***\n");
  abort();
}

void
test_invalid_header_field_token_error (int req)
{
  test_invalid_header_field(req, "Fo@: Failure");
  test_invalid_header_field(req, "Foo\01\test: Bar");
}

void
test_double_content_length_error (int req)
{
  http_parser parser;
  http_parser_init(&parser, req ? HTTP_REQUEST : HTTP_RESPONSE);
  size_t parsed;
  const char *buf;
  buf = req ?
    "GET / HTTP/1.1\r\n" :
    "HTTP/1.1 200 OK\r\n";
  parsed = http_parser_execute(&parser, &settings_null, buf, strlen(buf));
  assert(parsed == strlen(buf));

  buf = "Content-Length: 0\r\nContent-Length: 1\r\n\r\n";
  size_t buflen = strlen(buf);

  parsed = http_parser_execute(&parser, &settings_null, buf, buflen);
  if (parsed != buflen) {
    assert(HTTP_PARSER_ERRNO(&parser) == HPE_UNEXPECTED_CONTENT_LENGTH);
    return;
  }

  fprintf(stderr,
          "\n*** Error expected but none in double content-length test ***\n");
  abort();
}

void
test_chunked_content_length_error (int req)
{
  http_parser parser;
  http_parser_init(&parser, req ? HTTP_REQUEST : HTTP_RESPONSE);
  size_t parsed;
  const char *buf;
  buf = req ?
    "GET / HTTP/1.1\r\n" :
    "HTTP/1.1 200 OK\r\n";
  parsed = http_parser_execute(&parser, &settings_null, buf, strlen(buf));
  assert(parsed == strlen(buf));

  buf = "Transfer-Encoding: chunked\r\nContent-Length: 1\r\n\r\n";
  size_t buflen = strlen(buf);

  parsed = http_parser_execute(&parser, &settings_null, buf, buflen);
  if (parsed != buflen) {
    assert(HTTP_PARSER_ERRNO(&parser) == HPE_UNEXPECTED_CONTENT_LENGTH);
    return;
  }

  fprintf(stderr,
          "\n*** Error expected but none in chunked content-length test ***\n");
  abort();
}

void
test_header_cr_no_lf_error (int req)
{
  http_parser parser;
  http_parser_init(&parser, req ? HTTP_REQUEST : HTTP_RESPONSE);
  size_t parsed;
  const char *buf;
  buf = req ?
    "GET / HTTP/1.1\r\n" :
    "HTTP/1.1 200 OK\r\n";
  parsed = http_parser_execute(&parser, &settings_null, buf, strlen(buf));
  assert(parsed == strlen(buf));

  buf = "Foo: 1\rBar: 1\r\n\r\n";
  size_t buflen = strlen(buf);

  parsed = http_parser_execute(&parser, &settings_null, buf, buflen);
  if (parsed != buflen) {
    assert(HTTP_PARSER_ERRNO(&parser) == HPE_LF_EXPECTED);
    return;
  }

  fprintf(stderr,
          "\n*** Error expected but none in header whitespace test ***\n");
  abort();
}

void
test_header_overflow_error (int req)
{
  http_parser parser;
  http_parser_init(&parser, req ? HTTP_REQUEST : HTTP_RESPONSE);
  size_t parsed;
  const char *buf;
  buf = req ? "GET / HTTP/1.1\r\n" : "HTTP/1.0 200 OK\r\n";
  parsed = http_parser_execute(&parser, &settings_null, buf, strlen(buf));
  assert(parsed == strlen(buf));

  buf = "header-key: header-value\r\n";
  size_t buflen = strlen(buf);

  int i;
  for (i = 0; i < 10000; i++) {
    parsed = http_parser_execute(&parser, &settings_null, buf, buflen);
    if (parsed != buflen) {
      //fprintf(stderr, "error found on iter %d\n", i);
      assert(HTTP_PARSER_ERRNO(&parser) == HPE_HEADER_OVERFLOW);
      return;
    }
  }

  fprintf(stderr, "\n*** Error expected but none in header overflow test ***\n");
  abort();
}


void
test_header_nread_value ()
{
  http_parser parser;
  http_parser_init(&parser, HTTP_REQUEST);
  size_t parsed;
  const char *buf;
  buf = "GET / HTTP/1.1\r\nheader: value\nhdr: value\r\n";
  parsed = http_parser_execute(&parser, &settings_null, buf, strlen(buf));
  assert(parsed == strlen(buf));

  assert(parser.nread == strlen(buf));
}


static void
test_content_length_overflow (const char *buf, size_t buflen, int expect_ok)
{
  http_parser parser;
  http_parser_init(&parser, HTTP_RESPONSE);
  http_parser_execute(&parser, &settings_null, buf, buflen);

  if (expect_ok)
    assert(HTTP_PARSER_ERRNO(&parser) == HPE_OK);
  else
    assert(HTTP_PARSER_ERRNO(&parser) == HPE_INVALID_CONTENT_LENGTH);
}

void
test_header_content_length_overflow_error (void)
{
#define X(size)                                                               \
  "HTTP/1.1 200 OK\r\n"                                                       \
  "Content-Length: " #size "\r\n"                                             \
  "\r\n"
  const char a[] = X(1844674407370955160);  /* 2^64 / 10 - 1 */
  const char b[] = X(18446744073709551615); /* 2^64-1 */
  const char c[] = X(18446744073709551616); /* 2^64   */
#undef X
  test_content_length_overflow(a, sizeof(a) - 1, 1); /* expect ok      */
  test_content_length_overflow(b, sizeof(b) - 1, 0); /* expect failure */
  test_content_length_overflow(c, sizeof(c) - 1, 0); /* expect failure */
}

void
test_chunk_content_length_overflow_error (void)
{
#define X(size)                                                               \
    "HTTP/1.1 200 OK\r\n"                                                     \
    "Transfer-Encoding: chunked\r\n"                                          \
    "\r\n"                                                                    \
    #size "\r\n"                                                              \
    "..."
  const char a[] = X(FFFFFFFFFFFFFFE);   /* 2^64 / 16 - 1 */
  const char b[] = X(FFFFFFFFFFFFFFFF);  /* 2^64-1 */
  const char c[] = X(10000000000000000); /* 2^64   */
#undef X
  test_content_length_overflow(a, sizeof(a) - 1, 1); /* expect ok      */
  test_content_length_overflow(b, sizeof(b) - 1, 0); /* expect failure */
  test_content_length_overflow(c, sizeof(c) - 1, 0); /* expect failure */
}

void
test_no_overflow_long_body (int req, size_t length)
{
  http_parser parser;
  http_parser_init(&parser, req ? HTTP_REQUEST : HTTP_RESPONSE);
  size_t parsed;
  size_t i;
  char buf1[3000];
  size_t buf1len = sprintf(buf1, "%s\r\nConnection: Keep-Alive\r\nContent-Length: %lu\r\n\r\n",
      req ? "POST / HTTP/1.0" : "HTTP/1.0 200 OK", (unsigned long)length);
  parsed = http_parser_execute(&parser, &settings_null, buf1, buf1len);
  if (parsed != buf1len)
    goto err;

  for (i = 0; i < length; i++) {
    char foo = 'a';
    parsed = http_parser_execute(&parser, &settings_null, &foo, 1);
    if (parsed != 1)
      goto err;
  }

  parsed = http_parser_execute(&parser, &settings_null, buf1, buf1len);
  if (parsed != buf1len) goto err;
  return;

 err:
  fprintf(stderr,
          "\n*** error in test_no_overflow_long_body %s of length %lu ***\n",
          req ? "REQUEST" : "RESPONSE",
          (unsigned long)length);
  abort();
}

void
test_multiple3 (const struct message *r1, const struct message *r2, const struct message *r3)
{
  int message_count = count_parsed_messages(3, r1, r2, r3);

  char total[ strlen(r1->raw)
            + strlen(r2->raw)
            + strlen(r3->raw)
            + 1
            ];
  total[0] = '\0';

  strcat(total, r1->raw);
  strcat(total, r2->raw);
  strcat(total, r3->raw);

  parser_init(r1->type);

  size_t read;

  read = parse(total, strlen(total));

  if (parser->upgrade) {
    upgrade_message_fix(total, read, 3, r1, r2, r3);
    goto test;
  }

  if (read != strlen(total)) {
    print_error(total, read);
    abort();
  }

  read = parse(NULL, 0);

  if (read != 0) {
    print_error(total, read);
    abort();
  }

test:

  if (message_count != num_messages) {
    fprintf(stderr, "\n\n*** Parser didn't see 3 messages only %d *** \n", num_messages);
    abort();
  }

  if (!message_eq(0, 0, r1)) abort();
  if (message_count > 1 && !message_eq(1, 0, r2)) abort();
  if (message_count > 2 && !message_eq(2, 0, r3)) abort();

  parser_free();
}

/* SCAN through every possible breaking to make sure the
 * parser can handle getting the content in any chunks that
 * might come from the socket
 */
void
test_scan (const struct message *r1, const struct message *r2, const struct message *r3)
{
  char total[80*1024] = "\0";
  char buf1[80*1024] = "\0";
  char buf2[80*1024] = "\0";
  char buf3[80*1024] = "\0";

  strcat(total, r1->raw);
  strcat(total, r2->raw);
  strcat(total, r3->raw);

  size_t read;

  int total_len = strlen(total);

  int total_ops = 2 * (total_len - 1) * (total_len - 2) / 2;
  int ops = 0 ;

  size_t buf1_len, buf2_len, buf3_len;
  int message_count = count_parsed_messages(3, r1, r2, r3);

  int i,j,type_both;
  for (type_both = 0; type_both < 2; type_both ++ ) {
    for (j = 2; j < total_len; j ++ ) {
      for (i = 1; i < j; i ++ ) {

        if (ops % 1000 == 0)  {
          printf("\b\b\b\b%3.0f%%", 100 * (float)ops /(float)total_ops);
          fflush(stdout);
        }
        ops += 1;

        parser_init(type_both ? HTTP_BOTH : r1->type);

        buf1_len = i;
        strlncpy(buf1, sizeof(buf1), total, buf1_len);
        buf1[buf1_len] = 0;

        buf2_len = j - i;
        strlncpy(buf2, sizeof(buf1), total+i, buf2_len);
        buf2[buf2_len] = 0;

        buf3_len = total_len - j;
        strlncpy(buf3, sizeof(buf1), total+j, buf3_len);
        buf3[buf3_len] = 0;

        read = parse(buf1, buf1_len);

        if (parser->upgrade) goto test;

        if (read != buf1_len) {
          print_error(buf1, read);
          goto error;
        }

        read += parse(buf2, buf2_len);

        if (parser->upgrade) goto test;

        if (read != buf1_len + buf2_len) {
          print_error(buf2, read);
          goto error;
        }

        read += parse(buf3, buf3_len);

        if (parser->upgrade) goto test;

        if (read != buf1_len + buf2_len + buf3_len) {
          print_error(buf3, read);
          goto error;
        }

        parse(NULL, 0);

test:
        if (parser->upgrade) {
          upgrade_message_fix(total, read, 3, r1, r2, r3);
        }

        if (message_count != num_messages) {
          fprintf(stderr, "\n\nParser didn't see %d messages only %d\n",
            message_count, num_messages);
          goto error;
        }

        if (!message_eq(0, 0, r1)) {
          fprintf(stderr, "\n\nError matching messages[0] in test_scan.\n");
          goto error;
        }

        if (message_count > 1 && !message_eq(1, 0, r2)) {
          fprintf(stderr, "\n\nError matching messages[1] in test_scan.\n");
          goto error;
        }

        if (message_count > 2 && !message_eq(2, 0, r3)) {
          fprintf(stderr, "\n\nError matching messages[2] in test_scan.\n");
          goto error;
        }

        parser_free();
      }
    }
  }
  puts("\b\b\b\b100%");
  return;

 error:
  fprintf(stderr, "i=%d  j=%d\n", i, j);
  fprintf(stderr, "buf1 (%u) %s\n\n", (unsigned int)buf1_len, buf1);
  fprintf(stderr, "buf2 (%u) %s\n\n", (unsigned int)buf2_len , buf2);
  fprintf(stderr, "buf3 (%u) %s\n", (unsigned int)buf3_len, buf3);
  abort();
}

// user required to free the result
// string terminated by \0
char *
create_large_chunked_message (int body_size_in_kb, const char* headers)
{
  int i;
  size_t wrote = 0;
  size_t headers_len = strlen(headers);
  size_t bufsize = headers_len + (5+1024+2)*body_size_in_kb + 6;
  char * buf = malloc(bufsize);

  memcpy(buf, headers, headers_len);
  wrote += headers_len;

  for (i = 0; i < body_size_in_kb; i++) {
    // write 1kb chunk into the body.
    memcpy(buf + wrote, "400\r\n", 5);
    wrote += 5;
    memset(buf + wrote, 'C', 1024);
    wrote += 1024;
    strcpy(buf + wrote, "\r\n");
    wrote += 2;
  }

  memcpy(buf + wrote, "0\r\n\r\n", 6);
  wrote += 6;
  assert(wrote == bufsize);

  return buf;
}

/* Verify that we can pause parsing at any of the bytes in the
 * message and still get the result that we're expecting. */
void
test_message_pause (const struct message *msg)
{
  char *buf = (char*) msg->raw;
  size_t buflen = strlen(msg->raw);
  size_t nread;

  parser_init(msg->type);

  do {
    nread = parse_pause(buf, buflen);

    // We can only set the upgrade buffer once we've gotten our message
    // completion callback.
    if (messages[0].message_complete_cb_called &&
        msg->upgrade &&
        parser->upgrade) {
      messages[0].upgrade = buf + nread;
      goto test;
    }

    if (nread < buflen) {

      // Not much do to if we failed a strict-mode check
      if (HTTP_PARSER_ERRNO(parser) == HPE_STRICT) {
        parser_free();
        return;
      }

      assert (HTTP_PARSER_ERRNO(parser) == HPE_PAUSED);
    }

    buf += nread;
    buflen -= nread;
    http_parser_pause(parser, 0);
  } while (buflen > 0);

  nread = parse_pause(NULL, 0);
  assert (nread == 0);

test:
  if (num_messages != 1) {
    printf("\n*** num_messages != 1 after testing '%s' ***\n\n", msg->name);
    abort();
  }

  if(!message_eq(0, 0, msg)) abort();

  parser_free();
}

/* Verify that body and next message won't be parsed in responses to CONNECT */
void
test_message_connect (const struct message *msg)
{
  char *buf = (char*) msg->raw;
  size_t buflen = strlen(msg->raw);
  size_t nread;

  parser_init(msg->type);

  nread = parse_connect(buf, buflen);

  if (num_messages != 1) {
    printf("\n*** num_messages != 1 after testing '%s' ***\n\n", msg->name);
    abort();
  }

  if(!message_eq(0, 1, msg)) abort();

  parser_free();
}

int
main (void)
{
  parser = NULL;
  int i, j, k;
  int request_count;
  int response_count;
  unsigned long version;
  unsigned major;
  unsigned minor;
  unsigned patch;

  version = http_parser_version();
  major = (version >> 16) & 255;
  minor = (version >> 8) & 255;
  patch = version & 255;
  printf("http_parser v%u.%u.%u (0x%06lx)\n", major, minor, patch, version);

  printf("sizeof(http_parser) = %u\n", (unsigned int)sizeof(http_parser));

  for (request_count = 0; requests[request_count].name; request_count++);
  for (response_count = 0; responses[response_count].name; response_count++);

  //// API
  test_preserve_data();
  test_parse_url();
  test_method_str();

  //// NREAD
  test_header_nread_value();

  //// OVERFLOW CONDITIONS

  test_header_overflow_error(HTTP_REQUEST);
  test_no_overflow_long_body(HTTP_REQUEST, 1000);
  test_no_overflow_long_body(HTTP_REQUEST, 100000);

  test_header_overflow_error(HTTP_RESPONSE);
  test_no_overflow_long_body(HTTP_RESPONSE, 1000);
  test_no_overflow_long_body(HTTP_RESPONSE, 100000);

  test_header_content_length_overflow_error();
  test_chunk_content_length_overflow_error();

  //// HEADER FIELD CONDITIONS
  test_double_content_length_error(HTTP_REQUEST);
  test_chunked_content_length_error(HTTP_REQUEST);
  test_header_cr_no_lf_error(HTTP_REQUEST);
  test_invalid_header_field_token_error(HTTP_REQUEST);
  test_invalid_header_field_content_error(HTTP_REQUEST);
  test_double_content_length_error(HTTP_RESPONSE);
  test_chunked_content_length_error(HTTP_RESPONSE);
  test_header_cr_no_lf_error(HTTP_RESPONSE);
  test_invalid_header_field_token_error(HTTP_RESPONSE);
  test_invalid_header_field_content_error(HTTP_RESPONSE);

  //// RESPONSES

  for (i = 0; i < response_count; i++) {
    test_message(&responses[i]);
  }

  for (i = 0; i < response_count; i++) {
    test_message_pause(&responses[i]);
  }

  for (i = 0; i < response_count; i++) {
    test_message_connect(&responses[i]);
  }

  for (i = 0; i < response_count; i++) {
    if (!responses[i].should_keep_alive) continue;
    for (j = 0; j < response_count; j++) {
      if (!responses[j].should_keep_alive) continue;
      for (k = 0; k < response_count; k++) {
        test_multiple3(&responses[i], &responses[j], &responses[k]);
      }
    }
  }

  test_message_count_body(&responses[NO_HEADERS_NO_BODY_404]);
  test_message_count_body(&responses[TRAILING_SPACE_ON_CHUNKED_BODY]);

  // test very large chunked response
  {
    char * msg = create_large_chunked_message(31337,
      "HTTP/1.0 200 OK\r\n"
      "Transfer-Encoding: chunked\r\n"
      "Content-Type: text/plain\r\n"
      "\r\n");
    struct message large_chunked =
      {.name= "large chunked"
      ,.type= HTTP_RESPONSE
      ,.raw= msg
      ,.should_keep_alive= FALSE
      ,.message_complete_on_eof= FALSE
      ,.http_major= 1
      ,.http_minor= 0
      ,.status_code= 200
      ,.response_status= "OK"
      ,.num_headers= 2
      ,.headers=
        { { "Transfer-Encoding", "chunked" }
        , { "Content-Type", "text/plain" }
        }
      ,.body_size= 31337*1024
      ,.num_chunks_complete= 31338
      };
    for (i = 0; i < MAX_CHUNKS; i++) {
      large_chunked.chunk_lengths[i] = 1024;
    }
    test_message_count_body(&large_chunked);
    free(msg);
  }



  printf("response scan 1/2      ");
  test_scan( &responses[TRAILING_SPACE_ON_CHUNKED_BODY]
           , &responses[NO_BODY_HTTP10_KA_204]
           , &responses[NO_REASON_PHRASE]
           );

  printf("response scan 2/2      ");
  test_scan( &responses[BONJOUR_MADAME_FR]
           , &responses[UNDERSTORE_HEADER_KEY]
           , &responses[NO_CARRIAGE_RET]
           );

  puts("responses okay");


  /// REQUESTS

  test_simple("GET / HTP/1.1\r\n\r\n", HPE_INVALID_VERSION);

  // Extended characters - see nodejs/test/parallel/test-http-headers-obstext.js
  test_simple("GET / HTTP/1.1\r\n"
              "Test: Düsseldorf\r\n",
              HPE_OK);

  // Well-formed but incomplete
  test_simple("GET / HTTP/1.1\r\n"
              "Content-Type: text/plain\r\n"
              "Content-Length: 6\r\n"
              "\r\n"
              "fooba",
              HPE_OK);

  static const char *all_methods[] = {
    "DELETE",
    "GET",
    "HEAD",
    "POST",
    "PUT",
    //"CONNECT", //CONNECT can't be tested like other methods, it's a tunnel
    "OPTIONS",
    "TRACE",
    "COPY",
    "LOCK",
    "MKCOL",
    "MOVE",
    "PROPFIND",
    "PROPPATCH",
    "SEARCH",
    "UNLOCK",
    "BIND",
    "REBIND",
    "UNBIND",
    "ACL",
    "REPORT",
    "MKACTIVITY",
    "CHECKOUT",
    "MERGE",
    "M-SEARCH",
    "NOTIFY",
    "SUBSCRIBE",
    "UNSUBSCRIBE",
    "PATCH",
    "PURGE",
    "MKCALENDAR",
    "LINK",
    "UNLINK",
    0 };
  const char **this_method;
  for (this_method = all_methods; *this_method; this_method++) {
    char buf[200];
    sprintf(buf, "%s / HTTP/1.1\r\n\r\n", *this_method);
    test_simple(buf, HPE_OK);
  }

  static const char *bad_methods[] = {
      "ASDF",
      "C******",
      "COLA",
      "GEM",
      "GETA",
      "M****",
      "MKCOLA",
      "PROPPATCHA",
      "PUN",
      "PX",
      "SA",
      "hello world",
      0 };
  for (this_method = bad_methods; *this_method; this_method++) {
    char buf[200];
    sprintf(buf, "%s / HTTP/1.1\r\n\r\n", *this_method);
    test_simple(buf, HPE_INVALID_METHOD);
  }

  // illegal header field name line folding
  test_simple("GET / HTTP/1.1\r\n"
              "name\r\n"
              " : value\r\n"
              "\r\n",
              HPE_INVALID_HEADER_TOKEN);

  const char *dumbfuck2 =
    "GET / HTTP/1.1\r\n"
    "X-SSL-Bullshit:   -----BEGIN CERTIFICATE-----\r\n"
    "\tMIIFbTCCBFWgAwIBAgICH4cwDQYJKoZIhvcNAQEFBQAwcDELMAkGA1UEBhMCVUsx\r\n"
    "\tETAPBgNVBAoTCGVTY2llbmNlMRIwEAYDVQQLEwlBdXRob3JpdHkxCzAJBgNVBAMT\r\n"
    "\tAkNBMS0wKwYJKoZIhvcNAQkBFh5jYS1vcGVyYXRvckBncmlkLXN1cHBvcnQuYWMu\r\n"
    "\tdWswHhcNMDYwNzI3MTQxMzI4WhcNMDcwNzI3MTQxMzI4WjBbMQswCQYDVQQGEwJV\r\n"
    "\tSzERMA8GA1UEChMIZVNjaWVuY2UxEzARBgNVBAsTCk1hbmNoZXN0ZXIxCzAJBgNV\r\n"
    "\tBAcTmrsogriqMWLAk1DMRcwFQYDVQQDEw5taWNoYWVsIHBhcmQYJKoZIhvcNAQEB\r\n"
    "\tBQADggEPADCCAQoCggEBANPEQBgl1IaKdSS1TbhF3hEXSl72G9J+WC/1R64fAcEF\r\n"
    "\tW51rEyFYiIeZGx/BVzwXbeBoNUK41OK65sxGuflMo5gLflbwJtHBRIEKAfVVp3YR\r\n"
    "\tgW7cMA/s/XKgL1GEC7rQw8lIZT8RApukCGqOVHSi/F1SiFlPDxuDfmdiNzL31+sL\r\n"
    "\t0iwHDdNkGjy5pyBSB8Y79dsSJtCW/iaLB0/n8Sj7HgvvZJ7x0fr+RQjYOUUfrePP\r\n"
    "\tu2MSpFyf+9BbC/aXgaZuiCvSR+8Snv3xApQY+fULK/xY8h8Ua51iXoQ5jrgu2SqR\r\n"
    "\twgA7BUi3G8LFzMBl8FRCDYGUDy7M6QaHXx1ZWIPWNKsCAwEAAaOCAiQwggIgMAwG\r\n"
    "\tA1UdEwEB/wQCMAAwEQYJYIZIAYb4QgHTTPAQDAgWgMA4GA1UdDwEB/wQEAwID6DAs\r\n"
    "\tBglghkgBhvhCAQ0EHxYdVUsgZS1TY2llbmNlIFVzZXIgQ2VydGlmaWNhdGUwHQYD\r\n"
    "\tVR0OBBYEFDTt/sf9PeMaZDHkUIldrDYMNTBZMIGaBgNVHSMEgZIwgY+AFAI4qxGj\r\n"
    "\tloCLDdMVKwiljjDastqooXSkcjBwMQswCQYDVQQGEwJVSzERMA8GA1UEChMIZVNj\r\n"
    "\taWVuY2UxEjAQBgNVBAsTCUF1dGhvcml0eTELMAkGA1UEAxMCQ0ExLTArBgkqhkiG\r\n"
    "\t9w0BCQEWHmNhLW9wZXJhdG9yQGdyaWQtc3VwcG9ydC5hYy51a4IBADApBgNVHRIE\r\n"
    "\tIjAggR5jYS1vcGVyYXRvckBncmlkLXN1cHBvcnQuYWMudWswGQYDVR0gBBIwEDAO\r\n"
    "\tBgwrBgEEAdkvAQEBAQYwPQYJYIZIAYb4QgEEBDAWLmh0dHA6Ly9jYS5ncmlkLXN1\r\n"
    "\tcHBvcnQuYWMudmT4sopwqlBWsvcHViL2NybC9jYWNybC5jcmwwPQYJYIZIAYb4QgEDBDAWLmh0\r\n"
    "\tdHA6Ly9jYS5ncmlkLXN1cHBvcnQuYWMudWsvcHViL2NybC9jYWNybC5jcmwwPwYD\r\n"
    "\tVR0fBDgwNjA0oDKgMIYuaHR0cDovL2NhLmdyaWQt5hYy51ay9wdWIv\r\n"
    "\tY3JsL2NhY3JsLmNybDANBgkqhkiG9w0BAQUFAAOCAQEAS/U4iiooBENGW/Hwmmd3\r\n"
    "\tXCy6Zrt08YjKCzGNjorT98g8uGsqYjSxv/hmi0qlnlHs+k/3Iobc3LjS5AMYr5L8\r\n"
    "\tUO7OSkgFFlLHQyC9JzPfmLCAugvzEbyv4Olnsr8hbxF1MbKZoQxUZtMVu29wjfXk\r\n"
    "\thTeApBv7eaKCWpSp7MCbvgzm74izKhu3vlDk9w6qVrxePfGgpKPqfHiOoGhFnbTK\r\n"
    "\twTC6o2xq5y0qZ03JonF7OJspEd3I5zKY3E+ov7/ZhW6DqT8UFvsAdjvQbXyhV8Eu\r\n"
    "\tYhixw1aKEPzNjNowuIseVogKOLXxWI5vAi5HgXdS0/ES5gDGsABo4fqovUKlgop3\r\n"
    "\tRA==\r\n"
    "\t-----END CERTIFICATE-----\r\n"
    "\r\n";
  test_simple(dumbfuck2, HPE_OK);

  const char *corrupted_connection =
    "GET / HTTP/1.1\r\n"
    "Host: www.example.com\r\n"
    "Connection\r\033\065\325eep-Alive\r\n"
    "Accept-Encoding: gzip\r\n"
    "\r\n";
  test_simple(corrupted_connection, HPE_INVALID_HEADER_TOKEN);

  const char *corrupted_header_name =
    "GET / HTTP/1.1\r\n"
    "Host: www.example.com\r\n"
    "X-Some-Header\r\033\065\325eep-Alive\r\n"
    "Accept-Encoding: gzip\r\n"
    "\r\n";
  test_simple(corrupted_header_name, HPE_INVALID_HEADER_TOKEN);

#if 0
  // NOTE(Wed Nov 18 11:57:27 CET 2009) this seems okay. we just read body
  // until EOF.
  //
  // no content-length
  // error if there is a body without content length
  const char *bad_get_no_headers_no_body = "GET /bad_get_no_headers_no_body/world HTTP/1.1\r\n"
                                           "Accept: */*\r\n"
                                           "\r\n"
                                           "HELLO";
  test_simple(bad_get_no_headers_no_body, 0);
#endif
  /* TODO sending junk and large headers gets rejected */


  /* check to make sure our predefined requests are okay */
  for (i = 0; requests[i].name; i++) {
    test_message(&requests[i]);
  }

  for (i = 0; i < request_count; i++) {
    test_message_pause(&requests[i]);
  }

  for (i = 0; i < request_count; i++) {
    if (!requests[i].should_keep_alive) continue;
    for (j = 0; j < request_count; j++) {
      if (!requests[j].should_keep_alive) continue;
      for (k = 0; k < request_count; k++) {
        test_multiple3(&requests[i], &requests[j], &requests[k]);
      }
    }
  }

  printf("request scan 1/4      ");
  test_scan( &requests[GET_NO_HEADERS_NO_BODY]
           , &requests[GET_ONE_HEADER_NO_BODY]
           , &requests[GET_NO_HEADERS_NO_BODY]
           );

  printf("request scan 2/4      ");
  test_scan( &requests[POST_CHUNKED_ALL_YOUR_BASE]
           , &requests[POST_IDENTITY_BODY_WORLD]
           , &requests[GET_FUNKY_CONTENT_LENGTH]
           );

  printf("request scan 3/4      ");
  test_scan( &requests[TWO_CHUNKS_MULT_ZERO_END]
           , &requests[CHUNKED_W_TRAILING_HEADERS]
           , &requests[CHUNKED_W_BULLSHIT_AFTER_LENGTH]
           );

  printf("request scan 4/4      ");
  test_scan( &requests[QUERY_URL_WITH_QUESTION_MARK_GET]
           , &requests[PREFIX_NEWLINE_GET ]
           , &requests[CONNECT_REQUEST]
           );

  puts("requests okay");

  return 0;
}
node-v4.8.2/deps/http_parser/contrib/parsertrace.c000644 000766 000024 00000010400 13070706730 022353 0ustar00iojsstaff000000 000000 /* Based on src/http/ngx_http_parse.c from NGINX copyright Igor Sysoev
 *
 * Additional changes are licensed under the same terms as NGINX and
 * copyright Joyent, Inc. and other Node contributors. All rights reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */

/* Dump what the parser finds to stdout as it happen */

#include "http_parser.h"
#include 
#include 
#include 

int on_message_begin(http_parser* _) {
  (void)_;
  printf("\n***MESSAGE BEGIN***\n\n");
  return 0;
}

int on_headers_complete(http_parser* _) {
  (void)_;
  printf("\n***HEADERS COMPLETE***\n\n");
  return 0;
}

int on_message_complete(http_parser* _) {
  (void)_;
  printf("\n***MESSAGE COMPLETE***\n\n");
  return 0;
}

int on_url(http_parser* _, const char* at, size_t length) {
  (void)_;
  printf("Url: %.*s\n", (int)length, at);
  return 0;
}

int on_header_field(http_parser* _, const char* at, size_t length) {
  (void)_;
  printf("Header field: %.*s\n", (int)length, at);
  return 0;
}

int on_header_value(http_parser* _, const char* at, size_t length) {
  (void)_;
  printf("Header value: %.*s\n", (int)length, at);
  return 0;
}

int on_body(http_parser* _, const char* at, size_t length) {
  (void)_;
  printf("Body: %.*s\n", (int)length, at);
  return 0;
}

void usage(const char* name) {
  fprintf(stderr,
          "Usage: %s $type $filename\n"
          "  type: -x, where x is one of {r,b,q}\n"
          "  parses file as a Response, reQuest, or Both\n",
          name);
  exit(EXIT_FAILURE);
}

int main(int argc, char* argv[]) {
  enum http_parser_type file_type;

  if (argc != 3) {
    usage(argv[0]);
  }

  char* type = argv[1];
  if (type[0] != '-') {
    usage(argv[0]);
  }

  switch (type[1]) {
    /* in the case of "-", type[1] will be NUL */
    case 'r':
      file_type = HTTP_RESPONSE;
      break;
    case 'q':
      file_type = HTTP_REQUEST;
      break;
    case 'b':
      file_type = HTTP_BOTH;
      break;
    default:
      usage(argv[0]);
  }

  char* filename = argv[2];
  FILE* file = fopen(filename, "r");
  if (file == NULL) {
    perror("fopen");
    goto fail;
  }

  fseek(file, 0, SEEK_END);
  long file_length = ftell(file);
  if (file_length == -1) {
    perror("ftell");
    goto fail;
  }
  fseek(file, 0, SEEK_SET);

  char* data = malloc(file_length);
  if (fread(data, 1, file_length, file) != (size_t)file_length) {
    fprintf(stderr, "couldn't read entire file\n");
    free(data);
    goto fail;
  }

  http_parser_settings settings;
  memset(&settings, 0, sizeof(settings));
  settings.on_message_begin = on_message_begin;
  settings.on_url = on_url;
  settings.on_header_field = on_header_field;
  settings.on_header_value = on_header_value;
  settings.on_headers_complete = on_headers_complete;
  settings.on_body = on_body;
  settings.on_message_complete = on_message_complete;

  http_parser parser;
  http_parser_init(&parser, file_type);
  size_t nparsed = http_parser_execute(&parser, &settings, data, file_length);
  free(data);

  if (nparsed != (size_t)file_length) {
    fprintf(stderr,
            "Error: %s (%s)\n",
            http_errno_description(HTTP_PARSER_ERRNO(&parser)),
            http_errno_name(HTTP_PARSER_ERRNO(&parser)));
    goto fail;
  }

  return EXIT_SUCCESS;

fail:
  fclose(file);
  return EXIT_FAILURE;
}
node-v4.8.2/deps/http_parser/contrib/url_parser.c000644 000766 000024 00000002177 13070706730 022232 0ustar00iojsstaff000000 000000 #include "http_parser.h"
#include 
#include 

void
dump_url (const char *url, const struct http_parser_url *u)
{
  unsigned int i;

  printf("\tfield_set: 0x%x, port: %u\n", u->field_set, u->port);
  for (i = 0; i < UF_MAX; i++) {
    if ((u->field_set & (1 << i)) == 0) {
      printf("\tfield_data[%u]: unset\n", i);
      continue;
    }

    printf("\tfield_data[%u]: off: %u, len: %u, part: %.*s\n",
           i,
           u->field_data[i].off,
           u->field_data[i].len,
           u->field_data[i].len,
           url + u->field_data[i].off);
  }
}

int main(int argc, char ** argv) {
  struct http_parser_url u;
  int len, connect, result;

  if (argc != 3) {
    printf("Syntax : %s connect|get url\n", argv[0]);
    return 1;
  }
  len = strlen(argv[2]);
  connect = strcmp("connect", argv[1]) == 0 ? 1 : 0;
  printf("Parsing %s, connect %d\n", argv[2], connect);

  http_parser_url_init(&u);
  result = http_parser_parse_url(argv[2], len, connect, &u);
  if (result != 0) {
    printf("Parse error : %d\n", result);
    return result;
  }
  printf("Parse ok, result : \n");
  dump_url(argv[2], &u);
  return 0;
}
node-v4.8.2/deps/gtest/gtest.gyp000644 000766 000024 00000001116 13070706730 016702 0ustar00iojsstaff000000 000000 {
  'targets': [
    {
      'target_name': 'gtest',
      'type': 'static_library',
      'cflags': ['-Wno-missing-field-initializers'],
      'direct_dependent_settings': {
        'include_dirs': ['include'],
      },
      'include_dirs': ['.', 'include'],
      'sources': [
        'src/gtest-death-test.cc',
        'src/gtest-filepath.cc',
        'src/gtest-internal-inl.h',
        'src/gtest-port.cc',
        'src/gtest-printers.cc',
        'src/gtest-test-part.cc',
        'src/gtest-typed-test.cc',
        'src/gtest.cc',
        'src/gtest_main.cc',
      ],
    }
  ],
}
node-v4.8.2/deps/gtest/include/000755 000766 000024 00000000000 13070706730 016457 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/gtest/LICENSE000644 000766 000024 00000002703 13070706730 016043 0ustar00iojsstaff000000 000000 Copyright 2008, Google Inc.
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

    * Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the
distribution.
    * Neither the name of Google Inc. nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
node-v4.8.2/deps/gtest/src/000755 000766 000024 00000000000 13070706730 015623 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/gtest/src/gtest-death-test.cc000644 000766 000024 00000143561 13070706730 021332 0ustar00iojsstaff000000 000000 // Copyright 2005, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Author: wan@google.com (Zhanyong Wan), vladl@google.com (Vlad Losev)
//
// This file implements death tests.

#include "gtest/gtest-death-test.h"
#include "gtest/internal/gtest-port.h"

#if GTEST_HAS_DEATH_TEST

# if GTEST_OS_MAC
#  include 
# endif  // GTEST_OS_MAC

# include 
# include 
# include 

# if GTEST_OS_LINUX
#  include 
# endif  // GTEST_OS_LINUX

# include 

# if GTEST_OS_WINDOWS
#  include 
# else
#  include 
#  include 
# endif  // GTEST_OS_WINDOWS

# if GTEST_OS_QNX
#  include 
# endif  // GTEST_OS_QNX

#endif  // GTEST_HAS_DEATH_TEST

#include "gtest/gtest-message.h"
#include "gtest/internal/gtest-string.h"

// Indicates that this translation unit is part of Google Test's
// implementation.  It must come before gtest-internal-inl.h is
// included, or there will be a compiler error.  This trick exists to
// prevent the accidental inclusion of gtest-internal-inl.h in the
// user's code.
#define GTEST_IMPLEMENTATION_ 1
#include "src/gtest-internal-inl.h"
#undef GTEST_IMPLEMENTATION_

namespace testing {

// Constants.

// The default death test style.
static const char kDefaultDeathTestStyle[] = "fast";

GTEST_DEFINE_string_(
    death_test_style,
    internal::StringFromGTestEnv("death_test_style", kDefaultDeathTestStyle),
    "Indicates how to run a death test in a forked child process: "
    "\"threadsafe\" (child process re-executes the test binary "
    "from the beginning, running only the specific death test) or "
    "\"fast\" (child process runs the death test immediately "
    "after forking).");

GTEST_DEFINE_bool_(
    death_test_use_fork,
    internal::BoolFromGTestEnv("death_test_use_fork", false),
    "Instructs to use fork()/_exit() instead of clone() in death tests. "
    "Ignored and always uses fork() on POSIX systems where clone() is not "
    "implemented. Useful when running under valgrind or similar tools if "
    "those do not support clone(). Valgrind 3.3.1 will just fail if "
    "it sees an unsupported combination of clone() flags. "
    "It is not recommended to use this flag w/o valgrind though it will "
    "work in 99% of the cases. Once valgrind is fixed, this flag will "
    "most likely be removed.");

namespace internal {
GTEST_DEFINE_string_(
    internal_run_death_test, "",
    "Indicates the file, line number, temporal index of "
    "the single death test to run, and a file descriptor to "
    "which a success code may be sent, all separated by "
    "the '|' characters.  This flag is specified if and only if the current "
    "process is a sub-process launched for running a thread-safe "
    "death test.  FOR INTERNAL USE ONLY.");
}  // namespace internal

#if GTEST_HAS_DEATH_TEST

namespace internal {

// Valid only for fast death tests. Indicates the code is running in the
// child process of a fast style death test.
static bool g_in_fast_death_test_child = false;

// Returns a Boolean value indicating whether the caller is currently
// executing in the context of the death test child process.  Tools such as
// Valgrind heap checkers may need this to modify their behavior in death
// tests.  IMPORTANT: This is an internal utility.  Using it may break the
// implementation of death tests.  User code MUST NOT use it.
bool InDeathTestChild() {
# if GTEST_OS_WINDOWS

  // On Windows, death tests are thread-safe regardless of the value of the
  // death_test_style flag.
  return !GTEST_FLAG(internal_run_death_test).empty();

# else

  if (GTEST_FLAG(death_test_style) == "threadsafe")
    return !GTEST_FLAG(internal_run_death_test).empty();
  else
    return g_in_fast_death_test_child;
#endif
}

}  // namespace internal

// ExitedWithCode constructor.
ExitedWithCode::ExitedWithCode(int exit_code) : exit_code_(exit_code) {
}

// ExitedWithCode function-call operator.
bool ExitedWithCode::operator()(int exit_status) const {
# if GTEST_OS_WINDOWS

  return exit_status == exit_code_;

# else

  return WIFEXITED(exit_status) && WEXITSTATUS(exit_status) == exit_code_;

# endif  // GTEST_OS_WINDOWS
}

# if !GTEST_OS_WINDOWS
// KilledBySignal constructor.
KilledBySignal::KilledBySignal(int signum) : signum_(signum) {
}

// KilledBySignal function-call operator.
bool KilledBySignal::operator()(int exit_status) const {
  return WIFSIGNALED(exit_status) && WTERMSIG(exit_status) == signum_;
}
# endif  // !GTEST_OS_WINDOWS

namespace internal {

// Utilities needed for death tests.

// Generates a textual description of a given exit code, in the format
// specified by wait(2).
static std::string ExitSummary(int exit_code) {
  Message m;

# if GTEST_OS_WINDOWS

  m << "Exited with exit status " << exit_code;

# else

  if (WIFEXITED(exit_code)) {
    m << "Exited with exit status " << WEXITSTATUS(exit_code);
  } else if (WIFSIGNALED(exit_code)) {
    m << "Terminated by signal " << WTERMSIG(exit_code);
  }
#  ifdef WCOREDUMP
  if (WCOREDUMP(exit_code)) {
    m << " (core dumped)";
  }
#  endif
# endif  // GTEST_OS_WINDOWS

  return m.GetString();
}

// Returns true if exit_status describes a process that was terminated
// by a signal, or exited normally with a nonzero exit code.
bool ExitedUnsuccessfully(int exit_status) {
  return !ExitedWithCode(0)(exit_status);
}

# if !GTEST_OS_WINDOWS
// Generates a textual failure message when a death test finds more than
// one thread running, or cannot determine the number of threads, prior
// to executing the given statement.  It is the responsibility of the
// caller not to pass a thread_count of 1.
static std::string DeathTestThreadWarning(size_t thread_count) {
  Message msg;
  msg << "Death tests use fork(), which is unsafe particularly"
      << " in a threaded context. For this test, " << GTEST_NAME_ << " ";
  if (thread_count == 0)
    msg << "couldn't detect the number of threads.";
  else
    msg << "detected " << thread_count << " threads.";
  return msg.GetString();
}
# endif  // !GTEST_OS_WINDOWS

// Flag characters for reporting a death test that did not die.
static const char kDeathTestLived = 'L';
static const char kDeathTestReturned = 'R';
static const char kDeathTestThrew = 'T';
static const char kDeathTestInternalError = 'I';

// An enumeration describing all of the possible ways that a death test can
// conclude.  DIED means that the process died while executing the test
// code; LIVED means that process lived beyond the end of the test code;
// RETURNED means that the test statement attempted to execute a return
// statement, which is not allowed; THREW means that the test statement
// returned control by throwing an exception.  IN_PROGRESS means the test
// has not yet concluded.
// TODO(vladl@google.com): Unify names and possibly values for
// AbortReason, DeathTestOutcome, and flag characters above.
enum DeathTestOutcome { IN_PROGRESS, DIED, LIVED, RETURNED, THREW };

// Routine for aborting the program which is safe to call from an
// exec-style death test child process, in which case the error
// message is propagated back to the parent process.  Otherwise, the
// message is simply printed to stderr.  In either case, the program
// then exits with status 1.
void DeathTestAbort(const std::string& message) {
  // On a POSIX system, this function may be called from a threadsafe-style
  // death test child process, which operates on a very small stack.  Use
  // the heap for any additional non-minuscule memory requirements.
  const InternalRunDeathTestFlag* const flag =
      GetUnitTestImpl()->internal_run_death_test_flag();
  if (flag != NULL) {
    FILE* parent = posix::FDOpen(flag->write_fd(), "w");
    fputc(kDeathTestInternalError, parent);
    fprintf(parent, "%s", message.c_str());
    fflush(parent);
    _exit(1);
  } else {
    fprintf(stderr, "%s", message.c_str());
    fflush(stderr);
    posix::Abort();
  }
}

// A replacement for CHECK that calls DeathTestAbort if the assertion
// fails.
# define GTEST_DEATH_TEST_CHECK_(expression) \
  do { \
    if (!::testing::internal::IsTrue(expression)) { \
      DeathTestAbort( \
          ::std::string("CHECK failed: File ") + __FILE__ +  ", line " \
          + ::testing::internal::StreamableToString(__LINE__) + ": " \
          + #expression); \
    } \
  } while (::testing::internal::AlwaysFalse())

// This macro is similar to GTEST_DEATH_TEST_CHECK_, but it is meant for
// evaluating any system call that fulfills two conditions: it must return
// -1 on failure, and set errno to EINTR when it is interrupted and
// should be tried again.  The macro expands to a loop that repeatedly
// evaluates the expression as long as it evaluates to -1 and sets
// errno to EINTR.  If the expression evaluates to -1 but errno is
// something other than EINTR, DeathTestAbort is called.
# define GTEST_DEATH_TEST_CHECK_SYSCALL_(expression) \
  do { \
    int gtest_retval; \
    do { \
      gtest_retval = (expression); \
    } while (gtest_retval == -1 && errno == EINTR); \
    if (gtest_retval == -1) { \
      DeathTestAbort( \
          ::std::string("CHECK failed: File ") + __FILE__ + ", line " \
          + ::testing::internal::StreamableToString(__LINE__) + ": " \
          + #expression + " != -1"); \
    } \
  } while (::testing::internal::AlwaysFalse())

// Returns the message describing the last system error in errno.
std::string GetLastErrnoDescription() {
    return errno == 0 ? "" : posix::StrError(errno);
}

// This is called from a death test parent process to read a failure
// message from the death test child process and log it with the FATAL
// severity. On Windows, the message is read from a pipe handle. On other
// platforms, it is read from a file descriptor.
static void FailFromInternalError(int fd) {
  Message error;
  char buffer[256];
  int num_read;

  do {
    while ((num_read = posix::Read(fd, buffer, 255)) > 0) {
      buffer[num_read] = '\0';
      error << buffer;
    }
  } while (num_read == -1 && errno == EINTR);

  if (num_read == 0) {
    GTEST_LOG_(FATAL) << error.GetString();
  } else {
    const int last_error = errno;
    GTEST_LOG_(FATAL) << "Error while reading death test internal: "
                      << GetLastErrnoDescription() << " [" << last_error << "]";
  }
}

// Death test constructor.  Increments the running death test count
// for the current test.
DeathTest::DeathTest() {
  TestInfo* const info = GetUnitTestImpl()->current_test_info();
  if (info == NULL) {
    DeathTestAbort("Cannot run a death test outside of a TEST or "
                   "TEST_F construct");
  }
}

// Creates and returns a death test by dispatching to the current
// death test factory.
bool DeathTest::Create(const char* statement, const RE* regex,
                       const char* file, int line, DeathTest** test) {
  return GetUnitTestImpl()->death_test_factory()->Create(
      statement, regex, file, line, test);
}

const char* DeathTest::LastMessage() {
  return last_death_test_message_.c_str();
}

void DeathTest::set_last_death_test_message(const std::string& message) {
  last_death_test_message_ = message;
}

std::string DeathTest::last_death_test_message_;

// Provides cross platform implementation for some death functionality.
class DeathTestImpl : public DeathTest {
 protected:
  DeathTestImpl(const char* a_statement, const RE* a_regex)
      : statement_(a_statement),
        regex_(a_regex),
        spawned_(false),
        status_(-1),
        outcome_(IN_PROGRESS),
        read_fd_(-1),
        write_fd_(-1) {}

  // read_fd_ is expected to be closed and cleared by a derived class.
  ~DeathTestImpl() { GTEST_DEATH_TEST_CHECK_(read_fd_ == -1); }

  void Abort(AbortReason reason);
  virtual bool Passed(bool status_ok);

  const char* statement() const { return statement_; }
  const RE* regex() const { return regex_; }
  bool spawned() const { return spawned_; }
  void set_spawned(bool is_spawned) { spawned_ = is_spawned; }
  int status() const { return status_; }
  void set_status(int a_status) { status_ = a_status; }
  DeathTestOutcome outcome() const { return outcome_; }
  void set_outcome(DeathTestOutcome an_outcome) { outcome_ = an_outcome; }
  int read_fd() const { return read_fd_; }
  void set_read_fd(int fd) { read_fd_ = fd; }
  int write_fd() const { return write_fd_; }
  void set_write_fd(int fd) { write_fd_ = fd; }

  // Called in the parent process only. Reads the result code of the death
  // test child process via a pipe, interprets it to set the outcome_
  // member, and closes read_fd_.  Outputs diagnostics and terminates in
  // case of unexpected codes.
  void ReadAndInterpretStatusByte();

 private:
  // The textual content of the code this object is testing.  This class
  // doesn't own this string and should not attempt to delete it.
  const char* const statement_;
  // The regular expression which test output must match.  DeathTestImpl
  // doesn't own this object and should not attempt to delete it.
  const RE* const regex_;
  // True if the death test child process has been successfully spawned.
  bool spawned_;
  // The exit status of the child process.
  int status_;
  // How the death test concluded.
  DeathTestOutcome outcome_;
  // Descriptor to the read end of the pipe to the child process.  It is
  // always -1 in the child process.  The child keeps its write end of the
  // pipe in write_fd_.
  int read_fd_;
  // Descriptor to the child's write end of the pipe to the parent process.
  // It is always -1 in the parent process.  The parent keeps its end of the
  // pipe in read_fd_.
  int write_fd_;
};

// Called in the parent process only. Reads the result code of the death
// test child process via a pipe, interprets it to set the outcome_
// member, and closes read_fd_.  Outputs diagnostics and terminates in
// case of unexpected codes.
void DeathTestImpl::ReadAndInterpretStatusByte() {
  char flag;
  int bytes_read;

  // The read() here blocks until data is available (signifying the
  // failure of the death test) or until the pipe is closed (signifying
  // its success), so it's okay to call this in the parent before
  // the child process has exited.
  do {
    bytes_read = posix::Read(read_fd(), &flag, 1);
  } while (bytes_read == -1 && errno == EINTR);

  if (bytes_read == 0) {
    set_outcome(DIED);
  } else if (bytes_read == 1) {
    switch (flag) {
      case kDeathTestReturned:
        set_outcome(RETURNED);
        break;
      case kDeathTestThrew:
        set_outcome(THREW);
        break;
      case kDeathTestLived:
        set_outcome(LIVED);
        break;
      case kDeathTestInternalError:
        FailFromInternalError(read_fd());  // Does not return.
        break;
      default:
        GTEST_LOG_(FATAL) << "Death test child process reported "
                          << "unexpected status byte ("
                          << static_cast(flag) << ")";
    }
  } else {
    GTEST_LOG_(FATAL) << "Read from death test child process failed: "
                      << GetLastErrnoDescription();
  }
  GTEST_DEATH_TEST_CHECK_SYSCALL_(posix::Close(read_fd()));
  set_read_fd(-1);
}

// Signals that the death test code which should have exited, didn't.
// Should be called only in a death test child process.
// Writes a status byte to the child's status file descriptor, then
// calls _exit(1).
void DeathTestImpl::Abort(AbortReason reason) {
  // The parent process considers the death test to be a failure if
  // it finds any data in our pipe.  So, here we write a single flag byte
  // to the pipe, then exit.
  const char status_ch =
      reason == TEST_DID_NOT_DIE ? kDeathTestLived :
      reason == TEST_THREW_EXCEPTION ? kDeathTestThrew : kDeathTestReturned;

  GTEST_DEATH_TEST_CHECK_SYSCALL_(posix::Write(write_fd(), &status_ch, 1));
  // We are leaking the descriptor here because on some platforms (i.e.,
  // when built as Windows DLL), destructors of global objects will still
  // run after calling _exit(). On such systems, write_fd_ will be
  // indirectly closed from the destructor of UnitTestImpl, causing double
  // close if it is also closed here. On debug configurations, double close
  // may assert. As there are no in-process buffers to flush here, we are
  // relying on the OS to close the descriptor after the process terminates
  // when the destructors are not run.
  _exit(1);  // Exits w/o any normal exit hooks (we were supposed to crash)
}

// Returns an indented copy of stderr output for a death test.
// This makes distinguishing death test output lines from regular log lines
// much easier.
static ::std::string FormatDeathTestOutput(const ::std::string& output) {
  ::std::string ret;
  for (size_t at = 0; ; ) {
    const size_t line_end = output.find('\n', at);
    ret += "[  DEATH   ] ";
    if (line_end == ::std::string::npos) {
      ret += output.substr(at);
      break;
    }
    ret += output.substr(at, line_end + 1 - at);
    at = line_end + 1;
  }
  return ret;
}

// Assesses the success or failure of a death test, using both private
// members which have previously been set, and one argument:
//
// Private data members:
//   outcome:  An enumeration describing how the death test
//             concluded: DIED, LIVED, THREW, or RETURNED.  The death test
//             fails in the latter three cases.
//   status:   The exit status of the child process. On *nix, it is in the
//             in the format specified by wait(2). On Windows, this is the
//             value supplied to the ExitProcess() API or a numeric code
//             of the exception that terminated the program.
//   regex:    A regular expression object to be applied to
//             the test's captured standard error output; the death test
//             fails if it does not match.
//
// Argument:
//   status_ok: true if exit_status is acceptable in the context of
//              this particular death test, which fails if it is false
//
// Returns true iff all of the above conditions are met.  Otherwise, the
// first failing condition, in the order given above, is the one that is
// reported. Also sets the last death test message string.
bool DeathTestImpl::Passed(bool status_ok) {
  if (!spawned())
    return false;

  const std::string error_message = GetCapturedStderr();

  bool success = false;
  Message buffer;

  buffer << "Death test: " << statement() << "\n";
  switch (outcome()) {
    case LIVED:
      buffer << "    Result: failed to die.\n"
             << " Error msg:\n" << FormatDeathTestOutput(error_message);
      break;
    case THREW:
      buffer << "    Result: threw an exception.\n"
             << " Error msg:\n" << FormatDeathTestOutput(error_message);
      break;
    case RETURNED:
      buffer << "    Result: illegal return in test statement.\n"
             << " Error msg:\n" << FormatDeathTestOutput(error_message);
      break;
    case DIED:
      if (status_ok) {
        const bool matched = RE::PartialMatch(error_message.c_str(), *regex());
        if (matched) {
          success = true;
        } else {
          buffer << "    Result: died but not with expected error.\n"
                 << "  Expected: " << regex()->pattern() << "\n"
                 << "Actual msg:\n" << FormatDeathTestOutput(error_message);
        }
      } else {
        buffer << "    Result: died but not with expected exit code:\n"
               << "            " << ExitSummary(status()) << "\n"
               << "Actual msg:\n" << FormatDeathTestOutput(error_message);
      }
      break;
    case IN_PROGRESS:
    default:
      GTEST_LOG_(FATAL)
          << "DeathTest::Passed somehow called before conclusion of test";
  }

  DeathTest::set_last_death_test_message(buffer.GetString());
  return success;
}

# if GTEST_OS_WINDOWS
// WindowsDeathTest implements death tests on Windows. Due to the
// specifics of starting new processes on Windows, death tests there are
// always threadsafe, and Google Test considers the
// --gtest_death_test_style=fast setting to be equivalent to
// --gtest_death_test_style=threadsafe there.
//
// A few implementation notes:  Like the Linux version, the Windows
// implementation uses pipes for child-to-parent communication. But due to
// the specifics of pipes on Windows, some extra steps are required:
//
// 1. The parent creates a communication pipe and stores handles to both
//    ends of it.
// 2. The parent starts the child and provides it with the information
//    necessary to acquire the handle to the write end of the pipe.
// 3. The child acquires the write end of the pipe and signals the parent
//    using a Windows event.
// 4. Now the parent can release the write end of the pipe on its side. If
//    this is done before step 3, the object's reference count goes down to
//    0 and it is destroyed, preventing the child from acquiring it. The
//    parent now has to release it, or read operations on the read end of
//    the pipe will not return when the child terminates.
// 5. The parent reads child's output through the pipe (outcome code and
//    any possible error messages) from the pipe, and its stderr and then
//    determines whether to fail the test.
//
// Note: to distinguish Win32 API calls from the local method and function
// calls, the former are explicitly resolved in the global namespace.
//
class WindowsDeathTest : public DeathTestImpl {
 public:
  WindowsDeathTest(const char* a_statement,
                   const RE* a_regex,
                   const char* file,
                   int line)
      : DeathTestImpl(a_statement, a_regex), file_(file), line_(line) {}

  // All of these virtual functions are inherited from DeathTest.
  virtual int Wait();
  virtual TestRole AssumeRole();

 private:
  // The name of the file in which the death test is located.
  const char* const file_;
  // The line number on which the death test is located.
  const int line_;
  // Handle to the write end of the pipe to the child process.
  AutoHandle write_handle_;
  // Child process handle.
  AutoHandle child_handle_;
  // Event the child process uses to signal the parent that it has
  // acquired the handle to the write end of the pipe. After seeing this
  // event the parent can release its own handles to make sure its
  // ReadFile() calls return when the child terminates.
  AutoHandle event_handle_;
};

// Waits for the child in a death test to exit, returning its exit
// status, or 0 if no child process exists.  As a side effect, sets the
// outcome data member.
int WindowsDeathTest::Wait() {
  if (!spawned())
    return 0;

  // Wait until the child either signals that it has acquired the write end
  // of the pipe or it dies.
  const HANDLE wait_handles[2] = { child_handle_.Get(), event_handle_.Get() };
  switch (::WaitForMultipleObjects(2,
                                   wait_handles,
                                   FALSE,  // Waits for any of the handles.
                                   INFINITE)) {
    case WAIT_OBJECT_0:
    case WAIT_OBJECT_0 + 1:
      break;
    default:
      GTEST_DEATH_TEST_CHECK_(false);  // Should not get here.
  }

  // The child has acquired the write end of the pipe or exited.
  // We release the handle on our side and continue.
  write_handle_.Reset();
  event_handle_.Reset();

  ReadAndInterpretStatusByte();

  // Waits for the child process to exit if it haven't already. This
  // returns immediately if the child has already exited, regardless of
  // whether previous calls to WaitForMultipleObjects synchronized on this
  // handle or not.
  GTEST_DEATH_TEST_CHECK_(
      WAIT_OBJECT_0 == ::WaitForSingleObject(child_handle_.Get(),
                                             INFINITE));
  DWORD status_code;
  GTEST_DEATH_TEST_CHECK_(
      ::GetExitCodeProcess(child_handle_.Get(), &status_code) != FALSE);
  child_handle_.Reset();
  set_status(static_cast(status_code));
  return status();
}

// The AssumeRole process for a Windows death test.  It creates a child
// process with the same executable as the current process to run the
// death test.  The child process is given the --gtest_filter and
// --gtest_internal_run_death_test flags such that it knows to run the
// current death test only.
DeathTest::TestRole WindowsDeathTest::AssumeRole() {
  const UnitTestImpl* const impl = GetUnitTestImpl();
  const InternalRunDeathTestFlag* const flag =
      impl->internal_run_death_test_flag();
  const TestInfo* const info = impl->current_test_info();
  const int death_test_index = info->result()->death_test_count();

  if (flag != NULL) {
    // ParseInternalRunDeathTestFlag() has performed all the necessary
    // processing.
    set_write_fd(flag->write_fd());
    return EXECUTE_TEST;
  }

  // WindowsDeathTest uses an anonymous pipe to communicate results of
  // a death test.
  SECURITY_ATTRIBUTES handles_are_inheritable = {
    sizeof(SECURITY_ATTRIBUTES), NULL, TRUE };
  HANDLE read_handle, write_handle;
  GTEST_DEATH_TEST_CHECK_(
      ::CreatePipe(&read_handle, &write_handle, &handles_are_inheritable,
                   0)  // Default buffer size.
      != FALSE);
  set_read_fd(::_open_osfhandle(reinterpret_cast(read_handle),
                                O_RDONLY));
  write_handle_.Reset(write_handle);
  event_handle_.Reset(::CreateEvent(
      &handles_are_inheritable,
      TRUE,    // The event will automatically reset to non-signaled state.
      FALSE,   // The initial state is non-signalled.
      NULL));  // The even is unnamed.
  GTEST_DEATH_TEST_CHECK_(event_handle_.Get() != NULL);
  const std::string filter_flag =
      std::string("--") + GTEST_FLAG_PREFIX_ + kFilterFlag + "=" +
      info->test_case_name() + "." + info->name();
  const std::string internal_flag =
      std::string("--") + GTEST_FLAG_PREFIX_ + kInternalRunDeathTestFlag +
      "=" + file_ + "|" + StreamableToString(line_) + "|" +
      StreamableToString(death_test_index) + "|" +
      StreamableToString(static_cast(::GetCurrentProcessId())) +
      // size_t has the same width as pointers on both 32-bit and 64-bit
      // Windows platforms.
      // See http://msdn.microsoft.com/en-us/library/tcxf1dw6.aspx.
      "|" + StreamableToString(reinterpret_cast(write_handle)) +
      "|" + StreamableToString(reinterpret_cast(event_handle_.Get()));

  char executable_path[_MAX_PATH + 1];  // NOLINT
  GTEST_DEATH_TEST_CHECK_(
      _MAX_PATH + 1 != ::GetModuleFileNameA(NULL,
                                            executable_path,
                                            _MAX_PATH));

  std::string command_line =
      std::string(::GetCommandLineA()) + " " + filter_flag + " \"" +
      internal_flag + "\"";

  DeathTest::set_last_death_test_message("");

  CaptureStderr();
  // Flush the log buffers since the log streams are shared with the child.
  FlushInfoLog();

  // The child process will share the standard handles with the parent.
  STARTUPINFOA startup_info;
  memset(&startup_info, 0, sizeof(STARTUPINFO));
  startup_info.dwFlags = STARTF_USESTDHANDLES;
  startup_info.hStdInput = ::GetStdHandle(STD_INPUT_HANDLE);
  startup_info.hStdOutput = ::GetStdHandle(STD_OUTPUT_HANDLE);
  startup_info.hStdError = ::GetStdHandle(STD_ERROR_HANDLE);

  PROCESS_INFORMATION process_info;
  GTEST_DEATH_TEST_CHECK_(::CreateProcessA(
      executable_path,
      const_cast(command_line.c_str()),
      NULL,   // Retuned process handle is not inheritable.
      NULL,   // Retuned thread handle is not inheritable.
      TRUE,   // Child inherits all inheritable handles (for write_handle_).
      0x0,    // Default creation flags.
      NULL,   // Inherit the parent's environment.
      UnitTest::GetInstance()->original_working_dir(),
      &startup_info,
      &process_info) != FALSE);
  child_handle_.Reset(process_info.hProcess);
  ::CloseHandle(process_info.hThread);
  set_spawned(true);
  return OVERSEE_TEST;
}
# else  // We are not on Windows.

// ForkingDeathTest provides implementations for most of the abstract
// methods of the DeathTest interface.  Only the AssumeRole method is
// left undefined.
class ForkingDeathTest : public DeathTestImpl {
 public:
  ForkingDeathTest(const char* statement, const RE* regex);

  // All of these virtual functions are inherited from DeathTest.
  virtual int Wait();

 protected:
  void set_child_pid(pid_t child_pid) { child_pid_ = child_pid; }

 private:
  // PID of child process during death test; 0 in the child process itself.
  pid_t child_pid_;
};

// Constructs a ForkingDeathTest.
ForkingDeathTest::ForkingDeathTest(const char* a_statement, const RE* a_regex)
    : DeathTestImpl(a_statement, a_regex),
      child_pid_(-1) {}

// Waits for the child in a death test to exit, returning its exit
// status, or 0 if no child process exists.  As a side effect, sets the
// outcome data member.
int ForkingDeathTest::Wait() {
  if (!spawned())
    return 0;

  ReadAndInterpretStatusByte();

  int status_value;
  GTEST_DEATH_TEST_CHECK_SYSCALL_(waitpid(child_pid_, &status_value, 0));
  set_status(status_value);
  return status_value;
}

// A concrete death test class that forks, then immediately runs the test
// in the child process.
class NoExecDeathTest : public ForkingDeathTest {
 public:
  NoExecDeathTest(const char* a_statement, const RE* a_regex) :
      ForkingDeathTest(a_statement, a_regex) { }
  virtual TestRole AssumeRole();
};

// The AssumeRole process for a fork-and-run death test.  It implements a
// straightforward fork, with a simple pipe to transmit the status byte.
DeathTest::TestRole NoExecDeathTest::AssumeRole() {
  const size_t thread_count = GetThreadCount();
  if (thread_count != 1) {
    GTEST_LOG_(WARNING) << DeathTestThreadWarning(thread_count);
  }

  int pipe_fd[2];
  GTEST_DEATH_TEST_CHECK_(pipe(pipe_fd) != -1);

  DeathTest::set_last_death_test_message("");
  CaptureStderr();
  // When we fork the process below, the log file buffers are copied, but the
  // file descriptors are shared.  We flush all log files here so that closing
  // the file descriptors in the child process doesn't throw off the
  // synchronization between descriptors and buffers in the parent process.
  // This is as close to the fork as possible to avoid a race condition in case
  // there are multiple threads running before the death test, and another
  // thread writes to the log file.
  FlushInfoLog();

  const pid_t child_pid = fork();
  GTEST_DEATH_TEST_CHECK_(child_pid != -1);
  set_child_pid(child_pid);
  if (child_pid == 0) {
    GTEST_DEATH_TEST_CHECK_SYSCALL_(close(pipe_fd[0]));
    set_write_fd(pipe_fd[1]);
    // Redirects all logging to stderr in the child process to prevent
    // concurrent writes to the log files.  We capture stderr in the parent
    // process and append the child process' output to a log.
    LogToStderr();
    // Event forwarding to the listeners of event listener API mush be shut
    // down in death test subprocesses.
    GetUnitTestImpl()->listeners()->SuppressEventForwarding();
    g_in_fast_death_test_child = true;
    return EXECUTE_TEST;
  } else {
    GTEST_DEATH_TEST_CHECK_SYSCALL_(close(pipe_fd[1]));
    set_read_fd(pipe_fd[0]);
    set_spawned(true);
    return OVERSEE_TEST;
  }
}

// A concrete death test class that forks and re-executes the main
// program from the beginning, with command-line flags set that cause
// only this specific death test to be run.
class ExecDeathTest : public ForkingDeathTest {
 public:
  ExecDeathTest(const char* a_statement, const RE* a_regex,
                const char* file, int line) :
      ForkingDeathTest(a_statement, a_regex), file_(file), line_(line) { }
  virtual TestRole AssumeRole();
 private:
  static ::std::vector
  GetArgvsForDeathTestChildProcess() {
    ::std::vector args = GetInjectableArgvs();
    return args;
  }
  // The name of the file in which the death test is located.
  const char* const file_;
  // The line number on which the death test is located.
  const int line_;
};

// Utility class for accumulating command-line arguments.
class Arguments {
 public:
  Arguments() {
    args_.push_back(NULL);
  }

  ~Arguments() {
    for (std::vector::iterator i = args_.begin(); i != args_.end();
         ++i) {
      free(*i);
    }
  }
  void AddArgument(const char* argument) {
    args_.insert(args_.end() - 1, posix::StrDup(argument));
  }

  template 
  void AddArguments(const ::std::vector& arguments) {
    for (typename ::std::vector::const_iterator i = arguments.begin();
         i != arguments.end();
         ++i) {
      args_.insert(args_.end() - 1, posix::StrDup(i->c_str()));
    }
  }
  char* const* Argv() {
    return &args_[0];
  }

 private:
  std::vector args_;
};

// A struct that encompasses the arguments to the child process of a
// threadsafe-style death test process.
struct ExecDeathTestArgs {
  char* const* argv;  // Command-line arguments for the child's call to exec
  int close_fd;       // File descriptor to close; the read end of a pipe
};

#  if GTEST_OS_MAC
inline char** GetEnviron() {
  // When Google Test is built as a framework on MacOS X, the environ variable
  // is unavailable. Apple's documentation (man environ) recommends using
  // _NSGetEnviron() instead.
  return *_NSGetEnviron();
}
#  else
// Some POSIX platforms expect you to declare environ. extern "C" makes
// it reside in the global namespace.
extern "C" char** environ;
inline char** GetEnviron() { return environ; }
#  endif  // GTEST_OS_MAC

#  if !GTEST_OS_QNX
// The main function for a threadsafe-style death test child process.
// This function is called in a clone()-ed process and thus must avoid
// any potentially unsafe operations like malloc or libc functions.
static int ExecDeathTestChildMain(void* child_arg) {
  ExecDeathTestArgs* const args = static_cast(child_arg);
  GTEST_DEATH_TEST_CHECK_SYSCALL_(close(args->close_fd));

  // We need to execute the test program in the same environment where
  // it was originally invoked.  Therefore we change to the original
  // working directory first.
  const char* const original_dir =
      UnitTest::GetInstance()->original_working_dir();
  // We can safely call chdir() as it's a direct system call.
  if (chdir(original_dir) != 0) {
    DeathTestAbort(std::string("chdir(\"") + original_dir + "\") failed: " +
                   GetLastErrnoDescription());
    return EXIT_FAILURE;
  }

  // We can safely call execve() as it's a direct system call.  We
  // cannot use execvp() as it's a libc function and thus potentially
  // unsafe.  Since execve() doesn't search the PATH, the user must
  // invoke the test program via a valid path that contains at least
  // one path separator.
  execve(args->argv[0], args->argv, GetEnviron());
  DeathTestAbort(std::string("execve(") + args->argv[0] + ", ...) in " +
                 original_dir + " failed: " +
                 GetLastErrnoDescription());
  return EXIT_FAILURE;
}
#  endif  // !GTEST_OS_QNX

// Two utility routines that together determine the direction the stack
// grows.
// This could be accomplished more elegantly by a single recursive
// function, but we want to guard against the unlikely possibility of
// a smart compiler optimizing the recursion away.
//
// GTEST_NO_INLINE_ is required to prevent GCC 4.6 from inlining
// StackLowerThanAddress into StackGrowsDown, which then doesn't give
// correct answer.
void StackLowerThanAddress(const void* ptr, bool* result) GTEST_NO_INLINE_;
void StackLowerThanAddress(const void* ptr, bool* result) {
  int dummy;
  *result = (&dummy < ptr);
}

// Make sure AddressSanitizer does not tamper with the stack here.
GTEST_ATTRIBUTE_NO_SANITIZE_ADDRESS_
bool StackGrowsDown() {
  int dummy;
  bool result;
  StackLowerThanAddress(&dummy, &result);
  return result;
}

// Spawns a child process with the same executable as the current process in
// a thread-safe manner and instructs it to run the death test.  The
// implementation uses fork(2) + exec.  On systems where clone(2) is
// available, it is used instead, being slightly more thread-safe.  On QNX,
// fork supports only single-threaded environments, so this function uses
// spawn(2) there instead.  The function dies with an error message if
// anything goes wrong.
static pid_t ExecDeathTestSpawnChild(char* const* argv, int close_fd) {
  ExecDeathTestArgs args = { argv, close_fd };
  pid_t child_pid = -1;

#  if GTEST_OS_QNX
  // Obtains the current directory and sets it to be closed in the child
  // process.
  const int cwd_fd = open(".", O_RDONLY);
  GTEST_DEATH_TEST_CHECK_(cwd_fd != -1);
  GTEST_DEATH_TEST_CHECK_SYSCALL_(fcntl(cwd_fd, F_SETFD, FD_CLOEXEC));
  // We need to execute the test program in the same environment where
  // it was originally invoked.  Therefore we change to the original
  // working directory first.
  const char* const original_dir =
      UnitTest::GetInstance()->original_working_dir();
  // We can safely call chdir() as it's a direct system call.
  if (chdir(original_dir) != 0) {
    DeathTestAbort(std::string("chdir(\"") + original_dir + "\") failed: " +
                   GetLastErrnoDescription());
    return EXIT_FAILURE;
  }

  int fd_flags;
  // Set close_fd to be closed after spawn.
  GTEST_DEATH_TEST_CHECK_SYSCALL_(fd_flags = fcntl(close_fd, F_GETFD));
  GTEST_DEATH_TEST_CHECK_SYSCALL_(fcntl(close_fd, F_SETFD,
                                        fd_flags | FD_CLOEXEC));
  struct inheritance inherit = {0};
  // spawn is a system call.
  child_pid = spawn(args.argv[0], 0, NULL, &inherit, args.argv, GetEnviron());
  // Restores the current working directory.
  GTEST_DEATH_TEST_CHECK_(fchdir(cwd_fd) != -1);
  GTEST_DEATH_TEST_CHECK_SYSCALL_(close(cwd_fd));

#  else   // GTEST_OS_QNX
#   if GTEST_OS_LINUX
  // When a SIGPROF signal is received while fork() or clone() are executing,
  // the process may hang. To avoid this, we ignore SIGPROF here and re-enable
  // it after the call to fork()/clone() is complete.
  struct sigaction saved_sigprof_action;
  struct sigaction ignore_sigprof_action;
  memset(&ignore_sigprof_action, 0, sizeof(ignore_sigprof_action));
  sigemptyset(&ignore_sigprof_action.sa_mask);
  ignore_sigprof_action.sa_handler = SIG_IGN;
  GTEST_DEATH_TEST_CHECK_SYSCALL_(sigaction(
      SIGPROF, &ignore_sigprof_action, &saved_sigprof_action));
#   endif  // GTEST_OS_LINUX

#   if GTEST_HAS_CLONE
  const bool use_fork = GTEST_FLAG(death_test_use_fork);

  if (!use_fork) {
    static const bool stack_grows_down = StackGrowsDown();
    const size_t stack_size = getpagesize();
    // MMAP_ANONYMOUS is not defined on Mac, so we use MAP_ANON instead.
    void* const stack = mmap(NULL, stack_size, PROT_READ | PROT_WRITE,
                             MAP_ANON | MAP_PRIVATE, -1, 0);
    GTEST_DEATH_TEST_CHECK_(stack != MAP_FAILED);

    // Maximum stack alignment in bytes:  For a downward-growing stack, this
    // amount is subtracted from size of the stack space to get an address
    // that is within the stack space and is aligned on all systems we care
    // about.  As far as I know there is no ABI with stack alignment greater
    // than 64.  We assume stack and stack_size already have alignment of
    // kMaxStackAlignment.
    const size_t kMaxStackAlignment = 64;
    void* const stack_top =
        static_cast(stack) +
            (stack_grows_down ? stack_size - kMaxStackAlignment : 0);
    GTEST_DEATH_TEST_CHECK_(stack_size > kMaxStackAlignment &&
        reinterpret_cast(stack_top) % kMaxStackAlignment == 0);

    child_pid = clone(&ExecDeathTestChildMain, stack_top, SIGCHLD, &args);

    GTEST_DEATH_TEST_CHECK_(munmap(stack, stack_size) != -1);
  }
#   else
  const bool use_fork = true;
#   endif  // GTEST_HAS_CLONE

  if (use_fork && (child_pid = fork()) == 0) {
      ExecDeathTestChildMain(&args);
      _exit(0);
  }
#  endif  // GTEST_OS_QNX
#  if GTEST_OS_LINUX
  GTEST_DEATH_TEST_CHECK_SYSCALL_(
      sigaction(SIGPROF, &saved_sigprof_action, NULL));
#  endif  // GTEST_OS_LINUX

  GTEST_DEATH_TEST_CHECK_(child_pid != -1);
  return child_pid;
}

// The AssumeRole process for a fork-and-exec death test.  It re-executes the
// main program from the beginning, setting the --gtest_filter
// and --gtest_internal_run_death_test flags to cause only the current
// death test to be re-run.
DeathTest::TestRole ExecDeathTest::AssumeRole() {
  const UnitTestImpl* const impl = GetUnitTestImpl();
  const InternalRunDeathTestFlag* const flag =
      impl->internal_run_death_test_flag();
  const TestInfo* const info = impl->current_test_info();
  const int death_test_index = info->result()->death_test_count();

  if (flag != NULL) {
    set_write_fd(flag->write_fd());
    return EXECUTE_TEST;
  }

  int pipe_fd[2];
  GTEST_DEATH_TEST_CHECK_(pipe(pipe_fd) != -1);
  // Clear the close-on-exec flag on the write end of the pipe, lest
  // it be closed when the child process does an exec:
  GTEST_DEATH_TEST_CHECK_(fcntl(pipe_fd[1], F_SETFD, 0) != -1);

  const std::string filter_flag =
      std::string("--") + GTEST_FLAG_PREFIX_ + kFilterFlag + "="
      + info->test_case_name() + "." + info->name();
  const std::string internal_flag =
      std::string("--") + GTEST_FLAG_PREFIX_ + kInternalRunDeathTestFlag + "="
      + file_ + "|" + StreamableToString(line_) + "|"
      + StreamableToString(death_test_index) + "|"
      + StreamableToString(pipe_fd[1]);
  Arguments args;
  args.AddArguments(GetArgvsForDeathTestChildProcess());
  args.AddArgument(filter_flag.c_str());
  args.AddArgument(internal_flag.c_str());

  DeathTest::set_last_death_test_message("");

  CaptureStderr();
  // See the comment in NoExecDeathTest::AssumeRole for why the next line
  // is necessary.
  FlushInfoLog();

  const pid_t child_pid = ExecDeathTestSpawnChild(args.Argv(), pipe_fd[0]);
  GTEST_DEATH_TEST_CHECK_SYSCALL_(close(pipe_fd[1]));
  set_child_pid(child_pid);
  set_read_fd(pipe_fd[0]);
  set_spawned(true);
  return OVERSEE_TEST;
}

# endif  // !GTEST_OS_WINDOWS

// Creates a concrete DeathTest-derived class that depends on the
// --gtest_death_test_style flag, and sets the pointer pointed to
// by the "test" argument to its address.  If the test should be
// skipped, sets that pointer to NULL.  Returns true, unless the
// flag is set to an invalid value.
bool DefaultDeathTestFactory::Create(const char* statement, const RE* regex,
                                     const char* file, int line,
                                     DeathTest** test) {
  UnitTestImpl* const impl = GetUnitTestImpl();
  const InternalRunDeathTestFlag* const flag =
      impl->internal_run_death_test_flag();
  const int death_test_index = impl->current_test_info()
      ->increment_death_test_count();

  if (flag != NULL) {
    if (death_test_index > flag->index()) {
      DeathTest::set_last_death_test_message(
          "Death test count (" + StreamableToString(death_test_index)
          + ") somehow exceeded expected maximum ("
          + StreamableToString(flag->index()) + ")");
      return false;
    }

    if (!(flag->file() == file && flag->line() == line &&
          flag->index() == death_test_index)) {
      *test = NULL;
      return true;
    }
  }

# if GTEST_OS_WINDOWS

  if (GTEST_FLAG(death_test_style) == "threadsafe" ||
      GTEST_FLAG(death_test_style) == "fast") {
    *test = new WindowsDeathTest(statement, regex, file, line);
  }

# else

  if (GTEST_FLAG(death_test_style) == "threadsafe") {
    *test = new ExecDeathTest(statement, regex, file, line);
  } else if (GTEST_FLAG(death_test_style) == "fast") {
    *test = new NoExecDeathTest(statement, regex);
  }

# endif  // GTEST_OS_WINDOWS

  else {  // NOLINT - this is more readable than unbalanced brackets inside #if.
    DeathTest::set_last_death_test_message(
        "Unknown death test style \"" + GTEST_FLAG(death_test_style)
        + "\" encountered");
    return false;
  }

  return true;
}

// Splits a given string on a given delimiter, populating a given
// vector with the fields.  GTEST_HAS_DEATH_TEST implies that we have
// ::std::string, so we can use it here.
static void SplitString(const ::std::string& str, char delimiter,
                        ::std::vector< ::std::string>* dest) {
  ::std::vector< ::std::string> parsed;
  ::std::string::size_type pos = 0;
  while (::testing::internal::AlwaysTrue()) {
    const ::std::string::size_type colon = str.find(delimiter, pos);
    if (colon == ::std::string::npos) {
      parsed.push_back(str.substr(pos));
      break;
    } else {
      parsed.push_back(str.substr(pos, colon - pos));
      pos = colon + 1;
    }
  }
  dest->swap(parsed);
}

# if GTEST_OS_WINDOWS
// Recreates the pipe and event handles from the provided parameters,
// signals the event, and returns a file descriptor wrapped around the pipe
// handle. This function is called in the child process only.
int GetStatusFileDescriptor(unsigned int parent_process_id,
                            size_t write_handle_as_size_t,
                            size_t event_handle_as_size_t) {
  AutoHandle parent_process_handle(::OpenProcess(PROCESS_DUP_HANDLE,
                                                   FALSE,  // Non-inheritable.
                                                   parent_process_id));
  if (parent_process_handle.Get() == INVALID_HANDLE_VALUE) {
    DeathTestAbort("Unable to open parent process " +
                   StreamableToString(parent_process_id));
  }

  // TODO(vladl@google.com): Replace the following check with a
  // compile-time assertion when available.
  GTEST_CHECK_(sizeof(HANDLE) <= sizeof(size_t));

  const HANDLE write_handle =
      reinterpret_cast(write_handle_as_size_t);
  HANDLE dup_write_handle;

  // The newly initialized handle is accessible only in in the parent
  // process. To obtain one accessible within the child, we need to use
  // DuplicateHandle.
  if (!::DuplicateHandle(parent_process_handle.Get(), write_handle,
                         ::GetCurrentProcess(), &dup_write_handle,
                         0x0,    // Requested privileges ignored since
                                 // DUPLICATE_SAME_ACCESS is used.
                         FALSE,  // Request non-inheritable handler.
                         DUPLICATE_SAME_ACCESS)) {
    DeathTestAbort("Unable to duplicate the pipe handle " +
                   StreamableToString(write_handle_as_size_t) +
                   " from the parent process " +
                   StreamableToString(parent_process_id));
  }

  const HANDLE event_handle = reinterpret_cast(event_handle_as_size_t);
  HANDLE dup_event_handle;

  if (!::DuplicateHandle(parent_process_handle.Get(), event_handle,
                         ::GetCurrentProcess(), &dup_event_handle,
                         0x0,
                         FALSE,
                         DUPLICATE_SAME_ACCESS)) {
    DeathTestAbort("Unable to duplicate the event handle " +
                   StreamableToString(event_handle_as_size_t) +
                   " from the parent process " +
                   StreamableToString(parent_process_id));
  }

  const int write_fd =
      ::_open_osfhandle(reinterpret_cast(dup_write_handle), O_APPEND);
  if (write_fd == -1) {
    DeathTestAbort("Unable to convert pipe handle " +
                   StreamableToString(write_handle_as_size_t) +
                   " to a file descriptor");
  }

  // Signals the parent that the write end of the pipe has been acquired
  // so the parent can release its own write end.
  ::SetEvent(dup_event_handle);

  return write_fd;
}
# endif  // GTEST_OS_WINDOWS

// Returns a newly created InternalRunDeathTestFlag object with fields
// initialized from the GTEST_FLAG(internal_run_death_test) flag if
// the flag is specified; otherwise returns NULL.
InternalRunDeathTestFlag* ParseInternalRunDeathTestFlag() {
  if (GTEST_FLAG(internal_run_death_test) == "") return NULL;

  // GTEST_HAS_DEATH_TEST implies that we have ::std::string, so we
  // can use it here.
  int line = -1;
  int index = -1;
  ::std::vector< ::std::string> fields;
  SplitString(GTEST_FLAG(internal_run_death_test).c_str(), '|', &fields);
  int write_fd = -1;

# if GTEST_OS_WINDOWS

  unsigned int parent_process_id = 0;
  size_t write_handle_as_size_t = 0;
  size_t event_handle_as_size_t = 0;

  if (fields.size() != 6
      || !ParseNaturalNumber(fields[1], &line)
      || !ParseNaturalNumber(fields[2], &index)
      || !ParseNaturalNumber(fields[3], &parent_process_id)
      || !ParseNaturalNumber(fields[4], &write_handle_as_size_t)
      || !ParseNaturalNumber(fields[5], &event_handle_as_size_t)) {
    DeathTestAbort("Bad --gtest_internal_run_death_test flag: " +
                   GTEST_FLAG(internal_run_death_test));
  }
  write_fd = GetStatusFileDescriptor(parent_process_id,
                                     write_handle_as_size_t,
                                     event_handle_as_size_t);
# else

  if (fields.size() != 4
      || !ParseNaturalNumber(fields[1], &line)
      || !ParseNaturalNumber(fields[2], &index)
      || !ParseNaturalNumber(fields[3], &write_fd)) {
    DeathTestAbort("Bad --gtest_internal_run_death_test flag: "
        + GTEST_FLAG(internal_run_death_test));
  }

# endif  // GTEST_OS_WINDOWS

  return new InternalRunDeathTestFlag(fields[0], line, index, write_fd);
}

}  // namespace internal

#endif  // GTEST_HAS_DEATH_TEST

}  // namespace testing
node-v4.8.2/deps/gtest/src/gtest-filepath.cc000644 000766 000024 00000034331 13070706730 021056 0ustar00iojsstaff000000 000000 // Copyright 2008, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Authors: keith.ray@gmail.com (Keith Ray)

#include "gtest/gtest-message.h"
#include "gtest/internal/gtest-filepath.h"
#include "gtest/internal/gtest-port.h"

#include 

#if GTEST_OS_WINDOWS_MOBILE
# include 
#elif GTEST_OS_WINDOWS
# include 
# include 
#elif GTEST_OS_SYMBIAN
// Symbian OpenC has PATH_MAX in sys/syslimits.h
# include 
#else
# include 
# include   // Some Linux distributions define PATH_MAX here.
#endif  // GTEST_OS_WINDOWS_MOBILE

#if GTEST_OS_WINDOWS
# define GTEST_PATH_MAX_ _MAX_PATH
#elif defined(PATH_MAX)
# define GTEST_PATH_MAX_ PATH_MAX
#elif defined(_XOPEN_PATH_MAX)
# define GTEST_PATH_MAX_ _XOPEN_PATH_MAX
#else
# define GTEST_PATH_MAX_ _POSIX_PATH_MAX
#endif  // GTEST_OS_WINDOWS

#include "gtest/internal/gtest-string.h"

namespace testing {
namespace internal {

#if GTEST_OS_WINDOWS
// On Windows, '\\' is the standard path separator, but many tools and the
// Windows API also accept '/' as an alternate path separator. Unless otherwise
// noted, a file path can contain either kind of path separators, or a mixture
// of them.
const char kPathSeparator = '\\';
const char kAlternatePathSeparator = '/';
const char kAlternatePathSeparatorString[] = "/";
# if GTEST_OS_WINDOWS_MOBILE
// Windows CE doesn't have a current directory. You should not use
// the current directory in tests on Windows CE, but this at least
// provides a reasonable fallback.
const char kCurrentDirectoryString[] = "\\";
// Windows CE doesn't define INVALID_FILE_ATTRIBUTES
const DWORD kInvalidFileAttributes = 0xffffffff;
# else
const char kCurrentDirectoryString[] = ".\\";
# endif  // GTEST_OS_WINDOWS_MOBILE
#else
const char kPathSeparator = '/';
const char kCurrentDirectoryString[] = "./";
#endif  // GTEST_OS_WINDOWS

// Returns whether the given character is a valid path separator.
static bool IsPathSeparator(char c) {
#if GTEST_HAS_ALT_PATH_SEP_
  return (c == kPathSeparator) || (c == kAlternatePathSeparator);
#else
  return c == kPathSeparator;
#endif
}

// Returns the current working directory, or "" if unsuccessful.
FilePath FilePath::GetCurrentDir() {
#if GTEST_OS_WINDOWS_MOBILE || GTEST_OS_WINDOWS_PHONE || GTEST_OS_WINDOWS_RT
  // Windows CE doesn't have a current directory, so we just return
  // something reasonable.
  return FilePath(kCurrentDirectoryString);
#elif GTEST_OS_WINDOWS
  char cwd[GTEST_PATH_MAX_ + 1] = { '\0' };
  return FilePath(_getcwd(cwd, sizeof(cwd)) == NULL ? "" : cwd);
#else
  char cwd[GTEST_PATH_MAX_ + 1] = { '\0' };
  char* result = getcwd(cwd, sizeof(cwd));
# if GTEST_OS_NACL
  // getcwd will likely fail in NaCl due to the sandbox, so return something
  // reasonable. The user may have provided a shim implementation for getcwd,
  // however, so fallback only when failure is detected.
  return FilePath(result == NULL ? kCurrentDirectoryString : cwd);
# endif  // GTEST_OS_NACL
  return FilePath(result == NULL ? "" : cwd);
#endif  // GTEST_OS_WINDOWS_MOBILE
}

// Returns a copy of the FilePath with the case-insensitive extension removed.
// Example: FilePath("dir/file.exe").RemoveExtension("EXE") returns
// FilePath("dir/file"). If a case-insensitive extension is not
// found, returns a copy of the original FilePath.
FilePath FilePath::RemoveExtension(const char* extension) const {
  const std::string dot_extension = std::string(".") + extension;
  if (String::EndsWithCaseInsensitive(pathname_, dot_extension)) {
    return FilePath(pathname_.substr(
        0, pathname_.length() - dot_extension.length()));
  }
  return *this;
}

// Returns a pointer to the last occurence of a valid path separator in
// the FilePath. On Windows, for example, both '/' and '\' are valid path
// separators. Returns NULL if no path separator was found.
const char* FilePath::FindLastPathSeparator() const {
  const char* const last_sep = strrchr(c_str(), kPathSeparator);
#if GTEST_HAS_ALT_PATH_SEP_
  const char* const last_alt_sep = strrchr(c_str(), kAlternatePathSeparator);
  // Comparing two pointers of which only one is NULL is undefined.
  if (last_alt_sep != NULL &&
      (last_sep == NULL || last_alt_sep > last_sep)) {
    return last_alt_sep;
  }
#endif
  return last_sep;
}

// Returns a copy of the FilePath with the directory part removed.
// Example: FilePath("path/to/file").RemoveDirectoryName() returns
// FilePath("file"). If there is no directory part ("just_a_file"), it returns
// the FilePath unmodified. If there is no file part ("just_a_dir/") it
// returns an empty FilePath ("").
// On Windows platform, '\' is the path separator, otherwise it is '/'.
FilePath FilePath::RemoveDirectoryName() const {
  const char* const last_sep = FindLastPathSeparator();
  return last_sep ? FilePath(last_sep + 1) : *this;
}

// RemoveFileName returns the directory path with the filename removed.
// Example: FilePath("path/to/file").RemoveFileName() returns "path/to/".
// If the FilePath is "a_file" or "/a_file", RemoveFileName returns
// FilePath("./") or, on Windows, FilePath(".\\"). If the filepath does
// not have a file, like "just/a/dir/", it returns the FilePath unmodified.
// On Windows platform, '\' is the path separator, otherwise it is '/'.
FilePath FilePath::RemoveFileName() const {
  const char* const last_sep = FindLastPathSeparator();
  std::string dir;
  if (last_sep) {
    dir = std::string(c_str(), last_sep + 1 - c_str());
  } else {
    dir = kCurrentDirectoryString;
  }
  return FilePath(dir);
}

// Helper functions for naming files in a directory for xml output.

// Given directory = "dir", base_name = "test", number = 0,
// extension = "xml", returns "dir/test.xml". If number is greater
// than zero (e.g., 12), returns "dir/test_12.xml".
// On Windows platform, uses \ as the separator rather than /.
FilePath FilePath::MakeFileName(const FilePath& directory,
                                const FilePath& base_name,
                                int number,
                                const char* extension) {
  std::string file;
  if (number == 0) {
    file = base_name.string() + "." + extension;
  } else {
    file = base_name.string() + "_" + StreamableToString(number)
        + "." + extension;
  }
  return ConcatPaths(directory, FilePath(file));
}

// Given directory = "dir", relative_path = "test.xml", returns "dir/test.xml".
// On Windows, uses \ as the separator rather than /.
FilePath FilePath::ConcatPaths(const FilePath& directory,
                               const FilePath& relative_path) {
  if (directory.IsEmpty())
    return relative_path;
  const FilePath dir(directory.RemoveTrailingPathSeparator());
  return FilePath(dir.string() + kPathSeparator + relative_path.string());
}

// Returns true if pathname describes something findable in the file-system,
// either a file, directory, or whatever.
bool FilePath::FileOrDirectoryExists() const {
#if GTEST_OS_WINDOWS_MOBILE
  LPCWSTR unicode = String::AnsiToUtf16(pathname_.c_str());
  const DWORD attributes = GetFileAttributes(unicode);
  delete [] unicode;
  return attributes != kInvalidFileAttributes;
#else
  posix::StatStruct file_stat;
  return posix::Stat(pathname_.c_str(), &file_stat) == 0;
#endif  // GTEST_OS_WINDOWS_MOBILE
}

// Returns true if pathname describes a directory in the file-system
// that exists.
bool FilePath::DirectoryExists() const {
  bool result = false;
#if GTEST_OS_WINDOWS
  // Don't strip off trailing separator if path is a root directory on
  // Windows (like "C:\\").
  const FilePath& path(IsRootDirectory() ? *this :
                                           RemoveTrailingPathSeparator());
#else
  const FilePath& path(*this);
#endif

#if GTEST_OS_WINDOWS_MOBILE
  LPCWSTR unicode = String::AnsiToUtf16(path.c_str());
  const DWORD attributes = GetFileAttributes(unicode);
  delete [] unicode;
  if ((attributes != kInvalidFileAttributes) &&
      (attributes & FILE_ATTRIBUTE_DIRECTORY)) {
    result = true;
  }
#else
  posix::StatStruct file_stat;
  result = posix::Stat(path.c_str(), &file_stat) == 0 &&
      posix::IsDir(file_stat);
#endif  // GTEST_OS_WINDOWS_MOBILE

  return result;
}

// Returns true if pathname describes a root directory. (Windows has one
// root directory per disk drive.)
bool FilePath::IsRootDirectory() const {
#if GTEST_OS_WINDOWS
  // TODO(wan@google.com): on Windows a network share like
  // \\server\share can be a root directory, although it cannot be the
  // current directory.  Handle this properly.
  return pathname_.length() == 3 && IsAbsolutePath();
#else
  return pathname_.length() == 1 && IsPathSeparator(pathname_.c_str()[0]);
#endif
}

// Returns true if pathname describes an absolute path.
bool FilePath::IsAbsolutePath() const {
  const char* const name = pathname_.c_str();
#if GTEST_OS_WINDOWS
  return pathname_.length() >= 3 &&
     ((name[0] >= 'a' && name[0] <= 'z') ||
      (name[0] >= 'A' && name[0] <= 'Z')) &&
     name[1] == ':' &&
     IsPathSeparator(name[2]);
#else
  return IsPathSeparator(name[0]);
#endif
}

// Returns a pathname for a file that does not currently exist. The pathname
// will be directory/base_name.extension or
// directory/base_name_.extension if directory/base_name.extension
// already exists. The number will be incremented until a pathname is found
// that does not already exist.
// Examples: 'dir/foo_test.xml' or 'dir/foo_test_1.xml'.
// There could be a race condition if two or more processes are calling this
// function at the same time -- they could both pick the same filename.
FilePath FilePath::GenerateUniqueFileName(const FilePath& directory,
                                          const FilePath& base_name,
                                          const char* extension) {
  FilePath full_pathname;
  int number = 0;
  do {
    full_pathname.Set(MakeFileName(directory, base_name, number++, extension));
  } while (full_pathname.FileOrDirectoryExists());
  return full_pathname;
}

// Returns true if FilePath ends with a path separator, which indicates that
// it is intended to represent a directory. Returns false otherwise.
// This does NOT check that a directory (or file) actually exists.
bool FilePath::IsDirectory() const {
  return !pathname_.empty() &&
         IsPathSeparator(pathname_.c_str()[pathname_.length() - 1]);
}

// Create directories so that path exists. Returns true if successful or if
// the directories already exist; returns false if unable to create directories
// for any reason.
bool FilePath::CreateDirectoriesRecursively() const {
  if (!this->IsDirectory()) {
    return false;
  }

  if (pathname_.length() == 0 || this->DirectoryExists()) {
    return true;
  }

  const FilePath parent(this->RemoveTrailingPathSeparator().RemoveFileName());
  return parent.CreateDirectoriesRecursively() && this->CreateFolder();
}

// Create the directory so that path exists. Returns true if successful or
// if the directory already exists; returns false if unable to create the
// directory for any reason, including if the parent directory does not
// exist. Not named "CreateDirectory" because that's a macro on Windows.
bool FilePath::CreateFolder() const {
#if GTEST_OS_WINDOWS_MOBILE
  FilePath removed_sep(this->RemoveTrailingPathSeparator());
  LPCWSTR unicode = String::AnsiToUtf16(removed_sep.c_str());
  int result = CreateDirectory(unicode, NULL) ? 0 : -1;
  delete [] unicode;
#elif GTEST_OS_WINDOWS
  int result = _mkdir(pathname_.c_str());
#else
  int result = mkdir(pathname_.c_str(), 0777);
#endif  // GTEST_OS_WINDOWS_MOBILE

  if (result == -1) {
    return this->DirectoryExists();  // An error is OK if the directory exists.
  }
  return true;  // No error.
}

// If input name has a trailing separator character, remove it and return the
// name, otherwise return the name string unmodified.
// On Windows platform, uses \ as the separator, other platforms use /.
FilePath FilePath::RemoveTrailingPathSeparator() const {
  return IsDirectory()
      ? FilePath(pathname_.substr(0, pathname_.length() - 1))
      : *this;
}

// Removes any redundant separators that might be in the pathname.
// For example, "bar///foo" becomes "bar/foo". Does not eliminate other
// redundancies that might be in a pathname involving "." or "..".
// TODO(wan@google.com): handle Windows network shares (e.g. \\server\share).
void FilePath::Normalize() {
  if (pathname_.c_str() == NULL) {
    pathname_ = "";
    return;
  }
  const char* src = pathname_.c_str();
  char* const dest = new char[pathname_.length() + 1];
  char* dest_ptr = dest;
  memset(dest_ptr, 0, pathname_.length() + 1);

  while (*src != '\0') {
    *dest_ptr = *src;
    if (!IsPathSeparator(*src)) {
      src++;
    } else {
#if GTEST_HAS_ALT_PATH_SEP_
      if (*dest_ptr == kAlternatePathSeparator) {
        *dest_ptr = kPathSeparator;
      }
#endif
      while (IsPathSeparator(*src))
        src++;
    }
    dest_ptr++;
  }
  *dest_ptr = '\0';
  pathname_ = dest;
  delete[] dest;
}

}  // namespace internal
}  // namespace testing
node-v4.8.2/deps/gtest/src/gtest-internal-inl.h000644 000766 000024 00000131434 13070706730 021522 0ustar00iojsstaff000000 000000 // Copyright 2005, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

// Utility functions and classes used by the Google C++ testing framework.
//
// Author: wan@google.com (Zhanyong Wan)
//
// This file contains purely Google Test's internal implementation.  Please
// DO NOT #INCLUDE IT IN A USER PROGRAM.

#ifndef GTEST_SRC_GTEST_INTERNAL_INL_H_
#define GTEST_SRC_GTEST_INTERNAL_INL_H_

// GTEST_IMPLEMENTATION_ is defined to 1 iff the current translation unit is
// part of Google Test's implementation; otherwise it's undefined.
#if !GTEST_IMPLEMENTATION_
// If this file is included from the user's code, just say no.
# error "gtest-internal-inl.h is part of Google Test's internal implementation."
# error "It must not be included except by Google Test itself."
#endif  // GTEST_IMPLEMENTATION_

#ifndef _WIN32_WCE
# include 
#endif  // !_WIN32_WCE
#include 
#include   // For strtoll/_strtoul64/malloc/free.
#include   // For memmove.

#include 
#include 
#include 

#include "gtest/internal/gtest-port.h"

#if GTEST_CAN_STREAM_RESULTS_
# include   // NOLINT
# include   // NOLINT
#endif

#if GTEST_OS_WINDOWS
# include   // NOLINT
#endif  // GTEST_OS_WINDOWS

#include "gtest/gtest.h"  // NOLINT
#include "gtest/gtest-spi.h"

namespace testing {

// Declares the flags.
//
// We don't want the users to modify this flag in the code, but want
// Google Test's own unit tests to be able to access it. Therefore we
// declare it here as opposed to in gtest.h.
GTEST_DECLARE_bool_(death_test_use_fork);

namespace internal {

// The value of GetTestTypeId() as seen from within the Google Test
// library.  This is solely for testing GetTestTypeId().
GTEST_API_ extern const TypeId kTestTypeIdInGoogleTest;

// Names of the flags (needed for parsing Google Test flags).
const char kAlsoRunDisabledTestsFlag[] = "also_run_disabled_tests";
const char kBreakOnFailureFlag[] = "break_on_failure";
const char kCatchExceptionsFlag[] = "catch_exceptions";
const char kColorFlag[] = "color";
const char kFilterFlag[] = "filter";
const char kListTestsFlag[] = "list_tests";
const char kOutputFlag[] = "output";
const char kPrintTimeFlag[] = "print_time";
const char kRandomSeedFlag[] = "random_seed";
const char kRepeatFlag[] = "repeat";
const char kShuffleFlag[] = "shuffle";
const char kStackTraceDepthFlag[] = "stack_trace_depth";
const char kStreamResultToFlag[] = "stream_result_to";
const char kThrowOnFailureFlag[] = "throw_on_failure";

// A valid random seed must be in [1, kMaxRandomSeed].
const int kMaxRandomSeed = 99999;

// g_help_flag is true iff the --help flag or an equivalent form is
// specified on the command line.
GTEST_API_ extern bool g_help_flag;

// Returns the current time in milliseconds.
GTEST_API_ TimeInMillis GetTimeInMillis();

// Returns true iff Google Test should use colors in the output.
GTEST_API_ bool ShouldUseColor(bool stdout_is_tty);

// Formats the given time in milliseconds as seconds.
GTEST_API_ std::string FormatTimeInMillisAsSeconds(TimeInMillis ms);

// Converts the given time in milliseconds to a date string in the ISO 8601
// format, without the timezone information.  N.B.: due to the use the
// non-reentrant localtime() function, this function is not thread safe.  Do
// not use it in any code that can be called from multiple threads.
GTEST_API_ std::string FormatEpochTimeInMillisAsIso8601(TimeInMillis ms);

// Parses a string for an Int32 flag, in the form of "--flag=value".
//
// On success, stores the value of the flag in *value, and returns
// true.  On failure, returns false without changing *value.
GTEST_API_ bool ParseInt32Flag(
    const char* str, const char* flag, Int32* value);

// Returns a random seed in range [1, kMaxRandomSeed] based on the
// given --gtest_random_seed flag value.
inline int GetRandomSeedFromFlag(Int32 random_seed_flag) {
  const unsigned int raw_seed = (random_seed_flag == 0) ?
      static_cast(GetTimeInMillis()) :
      static_cast(random_seed_flag);

  // Normalizes the actual seed to range [1, kMaxRandomSeed] such that
  // it's easy to type.
  const int normalized_seed =
      static_cast((raw_seed - 1U) %
                       static_cast(kMaxRandomSeed)) + 1;
  return normalized_seed;
}

// Returns the first valid random seed after 'seed'.  The behavior is
// undefined if 'seed' is invalid.  The seed after kMaxRandomSeed is
// considered to be 1.
inline int GetNextRandomSeed(int seed) {
  GTEST_CHECK_(1 <= seed && seed <= kMaxRandomSeed)
      << "Invalid random seed " << seed << " - must be in [1, "
      << kMaxRandomSeed << "].";
  const int next_seed = seed + 1;
  return (next_seed > kMaxRandomSeed) ? 1 : next_seed;
}

// This class saves the values of all Google Test flags in its c'tor, and
// restores them in its d'tor.
class GTestFlagSaver {
 public:
  // The c'tor.
  GTestFlagSaver() {
    also_run_disabled_tests_ = GTEST_FLAG(also_run_disabled_tests);
    break_on_failure_ = GTEST_FLAG(break_on_failure);
    catch_exceptions_ = GTEST_FLAG(catch_exceptions);
    color_ = GTEST_FLAG(color);
    death_test_style_ = GTEST_FLAG(death_test_style);
    death_test_use_fork_ = GTEST_FLAG(death_test_use_fork);
    filter_ = GTEST_FLAG(filter);
    internal_run_death_test_ = GTEST_FLAG(internal_run_death_test);
    list_tests_ = GTEST_FLAG(list_tests);
    output_ = GTEST_FLAG(output);
    print_time_ = GTEST_FLAG(print_time);
    random_seed_ = GTEST_FLAG(random_seed);
    repeat_ = GTEST_FLAG(repeat);
    shuffle_ = GTEST_FLAG(shuffle);
    stack_trace_depth_ = GTEST_FLAG(stack_trace_depth);
    stream_result_to_ = GTEST_FLAG(stream_result_to);
    throw_on_failure_ = GTEST_FLAG(throw_on_failure);
  }

  // The d'tor is not virtual.  DO NOT INHERIT FROM THIS CLASS.
  ~GTestFlagSaver() {
    GTEST_FLAG(also_run_disabled_tests) = also_run_disabled_tests_;
    GTEST_FLAG(break_on_failure) = break_on_failure_;
    GTEST_FLAG(catch_exceptions) = catch_exceptions_;
    GTEST_FLAG(color) = color_;
    GTEST_FLAG(death_test_style) = death_test_style_;
    GTEST_FLAG(death_test_use_fork) = death_test_use_fork_;
    GTEST_FLAG(filter) = filter_;
    GTEST_FLAG(internal_run_death_test) = internal_run_death_test_;
    GTEST_FLAG(list_tests) = list_tests_;
    GTEST_FLAG(output) = output_;
    GTEST_FLAG(print_time) = print_time_;
    GTEST_FLAG(random_seed) = random_seed_;
    GTEST_FLAG(repeat) = repeat_;
    GTEST_FLAG(shuffle) = shuffle_;
    GTEST_FLAG(stack_trace_depth) = stack_trace_depth_;
    GTEST_FLAG(stream_result_to) = stream_result_to_;
    GTEST_FLAG(throw_on_failure) = throw_on_failure_;
  }

 private:
  // Fields for saving the original values of flags.
  bool also_run_disabled_tests_;
  bool break_on_failure_;
  bool catch_exceptions_;
  std::string color_;
  std::string death_test_style_;
  bool death_test_use_fork_;
  std::string filter_;
  std::string internal_run_death_test_;
  bool list_tests_;
  std::string output_;
  bool print_time_;
  internal::Int32 random_seed_;
  internal::Int32 repeat_;
  bool shuffle_;
  internal::Int32 stack_trace_depth_;
  std::string stream_result_to_;
  bool throw_on_failure_;
} GTEST_ATTRIBUTE_UNUSED_;

// Converts a Unicode code point to a narrow string in UTF-8 encoding.
// code_point parameter is of type UInt32 because wchar_t may not be
// wide enough to contain a code point.
// If the code_point is not a valid Unicode code point
// (i.e. outside of Unicode range U+0 to U+10FFFF) it will be converted
// to "(Invalid Unicode 0xXXXXXXXX)".
GTEST_API_ std::string CodePointToUtf8(UInt32 code_point);

// Converts a wide string to a narrow string in UTF-8 encoding.
// The wide string is assumed to have the following encoding:
//   UTF-16 if sizeof(wchar_t) == 2 (on Windows, Cygwin, Symbian OS)
//   UTF-32 if sizeof(wchar_t) == 4 (on Linux)
// Parameter str points to a null-terminated wide string.
// Parameter num_chars may additionally limit the number
// of wchar_t characters processed. -1 is used when the entire string
// should be processed.
// If the string contains code points that are not valid Unicode code points
// (i.e. outside of Unicode range U+0 to U+10FFFF) they will be output
// as '(Invalid Unicode 0xXXXXXXXX)'. If the string is in UTF16 encoding
// and contains invalid UTF-16 surrogate pairs, values in those pairs
// will be encoded as individual Unicode characters from Basic Normal Plane.
GTEST_API_ std::string WideStringToUtf8(const wchar_t* str, int num_chars);

// Reads the GTEST_SHARD_STATUS_FILE environment variable, and creates the file
// if the variable is present. If a file already exists at this location, this
// function will write over it. If the variable is present, but the file cannot
// be created, prints an error and exits.
void WriteToShardStatusFileIfNeeded();

// Checks whether sharding is enabled by examining the relevant
// environment variable values. If the variables are present,
// but inconsistent (e.g., shard_index >= total_shards), prints
// an error and exits. If in_subprocess_for_death_test, sharding is
// disabled because it must only be applied to the original test
// process. Otherwise, we could filter out death tests we intended to execute.
GTEST_API_ bool ShouldShard(const char* total_shards_str,
                            const char* shard_index_str,
                            bool in_subprocess_for_death_test);

// Parses the environment variable var as an Int32. If it is unset,
// returns default_val. If it is not an Int32, prints an error and
// and aborts.
GTEST_API_ Int32 Int32FromEnvOrDie(const char* env_var, Int32 default_val);

// Given the total number of shards, the shard index, and the test id,
// returns true iff the test should be run on this shard. The test id is
// some arbitrary but unique non-negative integer assigned to each test
// method. Assumes that 0 <= shard_index < total_shards.
GTEST_API_ bool ShouldRunTestOnShard(
    int total_shards, int shard_index, int test_id);

// STL container utilities.

// Returns the number of elements in the given container that satisfy
// the given predicate.
template 
inline int CountIf(const Container& c, Predicate predicate) {
  // Implemented as an explicit loop since std::count_if() in libCstd on
  // Solaris has a non-standard signature.
  int count = 0;
  for (typename Container::const_iterator it = c.begin(); it != c.end(); ++it) {
    if (predicate(*it))
      ++count;
  }
  return count;
}

// Applies a function/functor to each element in the container.
template 
void ForEach(const Container& c, Functor functor) {
  std::for_each(c.begin(), c.end(), functor);
}

// Returns the i-th element of the vector, or default_value if i is not
// in range [0, v.size()).
template 
inline E GetElementOr(const std::vector& v, int i, E default_value) {
  return (i < 0 || i >= static_cast(v.size())) ? default_value : v[i];
}

// Performs an in-place shuffle of a range of the vector's elements.
// 'begin' and 'end' are element indices as an STL-style range;
// i.e. [begin, end) are shuffled, where 'end' == size() means to
// shuffle to the end of the vector.
template 
void ShuffleRange(internal::Random* random, int begin, int end,
                  std::vector* v) {
  const int size = static_cast(v->size());
  GTEST_CHECK_(0 <= begin && begin <= size)
      << "Invalid shuffle range start " << begin << ": must be in range [0, "
      << size << "].";
  GTEST_CHECK_(begin <= end && end <= size)
      << "Invalid shuffle range finish " << end << ": must be in range ["
      << begin << ", " << size << "].";

  // Fisher-Yates shuffle, from
  // http://en.wikipedia.org/wiki/Fisher-Yates_shuffle
  for (int range_width = end - begin; range_width >= 2; range_width--) {
    const int last_in_range = begin + range_width - 1;
    const int selected = begin + random->Generate(range_width);
    std::swap((*v)[selected], (*v)[last_in_range]);
  }
}

// Performs an in-place shuffle of the vector's elements.
template 
inline void Shuffle(internal::Random* random, std::vector* v) {
  ShuffleRange(random, 0, static_cast(v->size()), v);
}

// A function for deleting an object.  Handy for being used as a
// functor.
template 
static void Delete(T* x) {
  delete x;
}

// A predicate that checks the key of a TestProperty against a known key.
//
// TestPropertyKeyIs is copyable.
class TestPropertyKeyIs {
 public:
  // Constructor.
  //
  // TestPropertyKeyIs has NO default constructor.
  explicit TestPropertyKeyIs(const std::string& key) : key_(key) {}

  // Returns true iff the test name of test property matches on key_.
  bool operator()(const TestProperty& test_property) const {
    return test_property.key() == key_;
  }

 private:
  std::string key_;
};

// Class UnitTestOptions.
//
// This class contains functions for processing options the user
// specifies when running the tests.  It has only static members.
//
// In most cases, the user can specify an option using either an
// environment variable or a command line flag.  E.g. you can set the
// test filter using either GTEST_FILTER or --gtest_filter.  If both
// the variable and the flag are present, the latter overrides the
// former.
class GTEST_API_ UnitTestOptions {
 public:
  // Functions for processing the gtest_output flag.

  // Returns the output format, or "" for normal printed output.
  static std::string GetOutputFormat();

  // Returns the absolute path of the requested output file, or the
  // default (test_detail.xml in the original working directory) if
  // none was explicitly specified.
  static std::string GetAbsolutePathToOutputFile();

  // Functions for processing the gtest_filter flag.

  // Returns true iff the wildcard pattern matches the string.  The
  // first ':' or '\0' character in pattern marks the end of it.
  //
  // This recursive algorithm isn't very efficient, but is clear and
  // works well enough for matching test names, which are short.
  static bool PatternMatchesString(const char *pattern, const char *str);

  // Returns true iff the user-specified filter matches the test case
  // name and the test name.
  static bool FilterMatchesTest(const std::string &test_case_name,
                                const std::string &test_name);

#if GTEST_OS_WINDOWS
  // Function for supporting the gtest_catch_exception flag.

  // Returns EXCEPTION_EXECUTE_HANDLER if Google Test should handle the
  // given SEH exception, or EXCEPTION_CONTINUE_SEARCH otherwise.
  // This function is useful as an __except condition.
  static int GTestShouldProcessSEH(DWORD exception_code);
#endif  // GTEST_OS_WINDOWS

  // Returns true if "name" matches the ':' separated list of glob-style
  // filters in "filter".
  static bool MatchesFilter(const std::string& name, const char* filter);
};

// Returns the current application's name, removing directory path if that
// is present.  Used by UnitTestOptions::GetOutputFile.
GTEST_API_ FilePath GetCurrentExecutableName();

// The role interface for getting the OS stack trace as a string.
class OsStackTraceGetterInterface {
 public:
  OsStackTraceGetterInterface() {}
  virtual ~OsStackTraceGetterInterface() {}

  // Returns the current OS stack trace as an std::string.  Parameters:
  //
  //   max_depth  - the maximum number of stack frames to be included
  //                in the trace.
  //   skip_count - the number of top frames to be skipped; doesn't count
  //                against max_depth.
  virtual string CurrentStackTrace(int max_depth, int skip_count) = 0;

  // UponLeavingGTest() should be called immediately before Google Test calls
  // user code. It saves some information about the current stack that
  // CurrentStackTrace() will use to find and hide Google Test stack frames.
  virtual void UponLeavingGTest() = 0;

 private:
  GTEST_DISALLOW_COPY_AND_ASSIGN_(OsStackTraceGetterInterface);
};

// A working implementation of the OsStackTraceGetterInterface interface.
class OsStackTraceGetter : public OsStackTraceGetterInterface {
 public:
  OsStackTraceGetter() : caller_frame_(NULL) {}

  virtual string CurrentStackTrace(int max_depth, int skip_count)
      GTEST_LOCK_EXCLUDED_(mutex_);

  virtual void UponLeavingGTest() GTEST_LOCK_EXCLUDED_(mutex_);

  // This string is inserted in place of stack frames that are part of
  // Google Test's implementation.
  static const char* const kElidedFramesMarker;

 private:
  Mutex mutex_;  // protects all internal state

  // We save the stack frame below the frame that calls user code.
  // We do this because the address of the frame immediately below
  // the user code changes between the call to UponLeavingGTest()
  // and any calls to CurrentStackTrace() from within the user code.
  void* caller_frame_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(OsStackTraceGetter);
};

// Information about a Google Test trace point.
struct TraceInfo {
  const char* file;
  int line;
  std::string message;
};

// This is the default global test part result reporter used in UnitTestImpl.
// This class should only be used by UnitTestImpl.
class DefaultGlobalTestPartResultReporter
  : public TestPartResultReporterInterface {
 public:
  explicit DefaultGlobalTestPartResultReporter(UnitTestImpl* unit_test);
  // Implements the TestPartResultReporterInterface. Reports the test part
  // result in the current test.
  virtual void ReportTestPartResult(const TestPartResult& result);

 private:
  UnitTestImpl* const unit_test_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(DefaultGlobalTestPartResultReporter);
};

// This is the default per thread test part result reporter used in
// UnitTestImpl. This class should only be used by UnitTestImpl.
class DefaultPerThreadTestPartResultReporter
    : public TestPartResultReporterInterface {
 public:
  explicit DefaultPerThreadTestPartResultReporter(UnitTestImpl* unit_test);
  // Implements the TestPartResultReporterInterface. The implementation just
  // delegates to the current global test part result reporter of *unit_test_.
  virtual void ReportTestPartResult(const TestPartResult& result);

 private:
  UnitTestImpl* const unit_test_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(DefaultPerThreadTestPartResultReporter);
};

// The private implementation of the UnitTest class.  We don't protect
// the methods under a mutex, as this class is not accessible by a
// user and the UnitTest class that delegates work to this class does
// proper locking.
class GTEST_API_ UnitTestImpl {
 public:
  explicit UnitTestImpl(UnitTest* parent);
  virtual ~UnitTestImpl();

  // There are two different ways to register your own TestPartResultReporter.
  // You can register your own repoter to listen either only for test results
  // from the current thread or for results from all threads.
  // By default, each per-thread test result repoter just passes a new
  // TestPartResult to the global test result reporter, which registers the
  // test part result for the currently running test.

  // Returns the global test part result reporter.
  TestPartResultReporterInterface* GetGlobalTestPartResultReporter();

  // Sets the global test part result reporter.
  void SetGlobalTestPartResultReporter(
      TestPartResultReporterInterface* reporter);

  // Returns the test part result reporter for the current thread.
  TestPartResultReporterInterface* GetTestPartResultReporterForCurrentThread();

  // Sets the test part result reporter for the current thread.
  void SetTestPartResultReporterForCurrentThread(
      TestPartResultReporterInterface* reporter);

  // Gets the number of successful test cases.
  int successful_test_case_count() const;

  // Gets the number of failed test cases.
  int failed_test_case_count() const;

  // Gets the number of all test cases.
  int total_test_case_count() const;

  // Gets the number of all test cases that contain at least one test
  // that should run.
  int test_case_to_run_count() const;

  // Gets the number of successful tests.
  int successful_test_count() const;

  // Gets the number of failed tests.
  int failed_test_count() const;

  // Gets the number of disabled tests that will be reported in the XML report.
  int reportable_disabled_test_count() const;

  // Gets the number of disabled tests.
  int disabled_test_count() const;

  // Gets the number of tests to be printed in the XML report.
  int reportable_test_count() const;

  // Gets the number of all tests.
  int total_test_count() const;

  // Gets the number of tests that should run.
  int test_to_run_count() const;

  // Gets the time of the test program start, in ms from the start of the
  // UNIX epoch.
  TimeInMillis start_timestamp() const { return start_timestamp_; }

  // Gets the elapsed time, in milliseconds.
  TimeInMillis elapsed_time() const { return elapsed_time_; }

  // Returns true iff the unit test passed (i.e. all test cases passed).
  bool Passed() const { return !Failed(); }

  // Returns true iff the unit test failed (i.e. some test case failed
  // or something outside of all tests failed).
  bool Failed() const {
    return failed_test_case_count() > 0 || ad_hoc_test_result()->Failed();
  }

  // Gets the i-th test case among all the test cases. i can range from 0 to
  // total_test_case_count() - 1. If i is not in that range, returns NULL.
  const TestCase* GetTestCase(int i) const {
    const int index = GetElementOr(test_case_indices_, i, -1);
    return index < 0 ? NULL : test_cases_[i];
  }

  // Gets the i-th test case among all the test cases. i can range from 0 to
  // total_test_case_count() - 1. If i is not in that range, returns NULL.
  TestCase* GetMutableTestCase(int i) {
    const int index = GetElementOr(test_case_indices_, i, -1);
    return index < 0 ? NULL : test_cases_[index];
  }

  // Provides access to the event listener list.
  TestEventListeners* listeners() { return &listeners_; }

  // Returns the TestResult for the test that's currently running, or
  // the TestResult for the ad hoc test if no test is running.
  TestResult* current_test_result();

  // Returns the TestResult for the ad hoc test.
  const TestResult* ad_hoc_test_result() const { return &ad_hoc_test_result_; }

  // Sets the OS stack trace getter.
  //
  // Does nothing if the input and the current OS stack trace getter
  // are the same; otherwise, deletes the old getter and makes the
  // input the current getter.
  void set_os_stack_trace_getter(OsStackTraceGetterInterface* getter);

  // Returns the current OS stack trace getter if it is not NULL;
  // otherwise, creates an OsStackTraceGetter, makes it the current
  // getter, and returns it.
  OsStackTraceGetterInterface* os_stack_trace_getter();

  // Returns the current OS stack trace as an std::string.
  //
  // The maximum number of stack frames to be included is specified by
  // the gtest_stack_trace_depth flag.  The skip_count parameter
  // specifies the number of top frames to be skipped, which doesn't
  // count against the number of frames to be included.
  //
  // For example, if Foo() calls Bar(), which in turn calls
  // CurrentOsStackTraceExceptTop(1), Foo() will be included in the
  // trace but Bar() and CurrentOsStackTraceExceptTop() won't.
  std::string CurrentOsStackTraceExceptTop(int skip_count) GTEST_NO_INLINE_;

  // Finds and returns a TestCase with the given name.  If one doesn't
  // exist, creates one and returns it.
  //
  // Arguments:
  //
  //   test_case_name: name of the test case
  //   type_param:     the name of the test's type parameter, or NULL if
  //                   this is not a typed or a type-parameterized test.
  //   set_up_tc:      pointer to the function that sets up the test case
  //   tear_down_tc:   pointer to the function that tears down the test case
  TestCase* GetTestCase(const char* test_case_name,
                        const char* type_param,
                        Test::SetUpTestCaseFunc set_up_tc,
                        Test::TearDownTestCaseFunc tear_down_tc);

  // Adds a TestInfo to the unit test.
  //
  // Arguments:
  //
  //   set_up_tc:    pointer to the function that sets up the test case
  //   tear_down_tc: pointer to the function that tears down the test case
  //   test_info:    the TestInfo object
  void AddTestInfo(Test::SetUpTestCaseFunc set_up_tc,
                   Test::TearDownTestCaseFunc tear_down_tc,
                   TestInfo* test_info) {
    // In order to support thread-safe death tests, we need to
    // remember the original working directory when the test program
    // was first invoked.  We cannot do this in RUN_ALL_TESTS(), as
    // the user may have changed the current directory before calling
    // RUN_ALL_TESTS().  Therefore we capture the current directory in
    // AddTestInfo(), which is called to register a TEST or TEST_F
    // before main() is reached.
    if (original_working_dir_.IsEmpty()) {
      original_working_dir_.Set(FilePath::GetCurrentDir());
      GTEST_CHECK_(!original_working_dir_.IsEmpty())
          << "Failed to get the current working directory.";
    }

    GetTestCase(test_info->test_case_name(),
                test_info->type_param(),
                set_up_tc,
                tear_down_tc)->AddTestInfo(test_info);
  }

#if GTEST_HAS_PARAM_TEST
  // Returns ParameterizedTestCaseRegistry object used to keep track of
  // value-parameterized tests and instantiate and register them.
  internal::ParameterizedTestCaseRegistry& parameterized_test_registry() {
    return parameterized_test_registry_;
  }
#endif  // GTEST_HAS_PARAM_TEST

  // Sets the TestCase object for the test that's currently running.
  void set_current_test_case(TestCase* a_current_test_case) {
    current_test_case_ = a_current_test_case;
  }

  // Sets the TestInfo object for the test that's currently running.  If
  // current_test_info is NULL, the assertion results will be stored in
  // ad_hoc_test_result_.
  void set_current_test_info(TestInfo* a_current_test_info) {
    current_test_info_ = a_current_test_info;
  }

  // Registers all parameterized tests defined using TEST_P and
  // INSTANTIATE_TEST_CASE_P, creating regular tests for each test/parameter
  // combination. This method can be called more then once; it has guards
  // protecting from registering the tests more then once.  If
  // value-parameterized tests are disabled, RegisterParameterizedTests is
  // present but does nothing.
  void RegisterParameterizedTests();

  // Runs all tests in this UnitTest object, prints the result, and
  // returns true if all tests are successful.  If any exception is
  // thrown during a test, this test is considered to be failed, but
  // the rest of the tests will still be run.
  bool RunAllTests();

  // Clears the results of all tests, except the ad hoc tests.
  void ClearNonAdHocTestResult() {
    ForEach(test_cases_, TestCase::ClearTestCaseResult);
  }

  // Clears the results of ad-hoc test assertions.
  void ClearAdHocTestResult() {
    ad_hoc_test_result_.Clear();
  }

  // Adds a TestProperty to the current TestResult object when invoked in a
  // context of a test or a test case, or to the global property set. If the
  // result already contains a property with the same key, the value will be
  // updated.
  void RecordProperty(const TestProperty& test_property);

  enum ReactionToSharding {
    HONOR_SHARDING_PROTOCOL,
    IGNORE_SHARDING_PROTOCOL
  };

  // Matches the full name of each test against the user-specified
  // filter to decide whether the test should run, then records the
  // result in each TestCase and TestInfo object.
  // If shard_tests == HONOR_SHARDING_PROTOCOL, further filters tests
  // based on sharding variables in the environment.
  // Returns the number of tests that should run.
  int FilterTests(ReactionToSharding shard_tests);

  // Prints the names of the tests matching the user-specified filter flag.
  void ListTestsMatchingFilter();

  const TestCase* current_test_case() const { return current_test_case_; }
  TestInfo* current_test_info() { return current_test_info_; }
  const TestInfo* current_test_info() const { return current_test_info_; }

  // Returns the vector of environments that need to be set-up/torn-down
  // before/after the tests are run.
  std::vector& environments() { return environments_; }

  // Getters for the per-thread Google Test trace stack.
  std::vector& gtest_trace_stack() {
    return *(gtest_trace_stack_.pointer());
  }
  const std::vector& gtest_trace_stack() const {
    return gtest_trace_stack_.get();
  }

#if GTEST_HAS_DEATH_TEST
  void InitDeathTestSubprocessControlInfo() {
    internal_run_death_test_flag_.reset(ParseInternalRunDeathTestFlag());
  }
  // Returns a pointer to the parsed --gtest_internal_run_death_test
  // flag, or NULL if that flag was not specified.
  // This information is useful only in a death test child process.
  // Must not be called before a call to InitGoogleTest.
  const InternalRunDeathTestFlag* internal_run_death_test_flag() const {
    return internal_run_death_test_flag_.get();
  }

  // Returns a pointer to the current death test factory.
  internal::DeathTestFactory* death_test_factory() {
    return death_test_factory_.get();
  }

  void SuppressTestEventsIfInSubprocess();

  friend class ReplaceDeathTestFactory;
#endif  // GTEST_HAS_DEATH_TEST

  // Initializes the event listener performing XML output as specified by
  // UnitTestOptions. Must not be called before InitGoogleTest.
  void ConfigureXmlOutput();

#if GTEST_CAN_STREAM_RESULTS_
  // Initializes the event listener for streaming test results to a socket.
  // Must not be called before InitGoogleTest.
  void ConfigureStreamingOutput();
#endif

  // Performs initialization dependent upon flag values obtained in
  // ParseGoogleTestFlagsOnly.  Is called from InitGoogleTest after the call to
  // ParseGoogleTestFlagsOnly.  In case a user neglects to call InitGoogleTest
  // this function is also called from RunAllTests.  Since this function can be
  // called more than once, it has to be idempotent.
  void PostFlagParsingInit();

  // Gets the random seed used at the start of the current test iteration.
  int random_seed() const { return random_seed_; }

  // Gets the random number generator.
  internal::Random* random() { return &random_; }

  // Shuffles all test cases, and the tests within each test case,
  // making sure that death tests are still run first.
  void ShuffleTests();

  // Restores the test cases and tests to their order before the first shuffle.
  void UnshuffleTests();

  // Returns the value of GTEST_FLAG(catch_exceptions) at the moment
  // UnitTest::Run() starts.
  bool catch_exceptions() const { return catch_exceptions_; }

 private:
  friend class ::testing::UnitTest;

  // Used by UnitTest::Run() to capture the state of
  // GTEST_FLAG(catch_exceptions) at the moment it starts.
  void set_catch_exceptions(bool value) { catch_exceptions_ = value; }

  // The UnitTest object that owns this implementation object.
  UnitTest* const parent_;

  // The working directory when the first TEST() or TEST_F() was
  // executed.
  internal::FilePath original_working_dir_;

  // The default test part result reporters.
  DefaultGlobalTestPartResultReporter default_global_test_part_result_reporter_;
  DefaultPerThreadTestPartResultReporter
      default_per_thread_test_part_result_reporter_;

  // Points to (but doesn't own) the global test part result reporter.
  TestPartResultReporterInterface* global_test_part_result_repoter_;

  // Protects read and write access to global_test_part_result_reporter_.
  internal::Mutex global_test_part_result_reporter_mutex_;

  // Points to (but doesn't own) the per-thread test part result reporter.
  internal::ThreadLocal
      per_thread_test_part_result_reporter_;

  // The vector of environments that need to be set-up/torn-down
  // before/after the tests are run.
  std::vector environments_;

  // The vector of TestCases in their original order.  It owns the
  // elements in the vector.
  std::vector test_cases_;

  // Provides a level of indirection for the test case list to allow
  // easy shuffling and restoring the test case order.  The i-th
  // element of this vector is the index of the i-th test case in the
  // shuffled order.
  std::vector test_case_indices_;

#if GTEST_HAS_PARAM_TEST
  // ParameterizedTestRegistry object used to register value-parameterized
  // tests.
  internal::ParameterizedTestCaseRegistry parameterized_test_registry_;

  // Indicates whether RegisterParameterizedTests() has been called already.
  bool parameterized_tests_registered_;
#endif  // GTEST_HAS_PARAM_TEST

  // Index of the last death test case registered.  Initially -1.
  int last_death_test_case_;

  // This points to the TestCase for the currently running test.  It
  // changes as Google Test goes through one test case after another.
  // When no test is running, this is set to NULL and Google Test
  // stores assertion results in ad_hoc_test_result_.  Initially NULL.
  TestCase* current_test_case_;

  // This points to the TestInfo for the currently running test.  It
  // changes as Google Test goes through one test after another.  When
  // no test is running, this is set to NULL and Google Test stores
  // assertion results in ad_hoc_test_result_.  Initially NULL.
  TestInfo* current_test_info_;

  // Normally, a user only writes assertions inside a TEST or TEST_F,
  // or inside a function called by a TEST or TEST_F.  Since Google
  // Test keeps track of which test is current running, it can
  // associate such an assertion with the test it belongs to.
  //
  // If an assertion is encountered when no TEST or TEST_F is running,
  // Google Test attributes the assertion result to an imaginary "ad hoc"
  // test, and records the result in ad_hoc_test_result_.
  TestResult ad_hoc_test_result_;

  // The list of event listeners that can be used to track events inside
  // Google Test.
  TestEventListeners listeners_;

  // The OS stack trace getter.  Will be deleted when the UnitTest
  // object is destructed.  By default, an OsStackTraceGetter is used,
  // but the user can set this field to use a custom getter if that is
  // desired.
  OsStackTraceGetterInterface* os_stack_trace_getter_;

  // True iff PostFlagParsingInit() has been called.
  bool post_flag_parse_init_performed_;

  // The random number seed used at the beginning of the test run.
  int random_seed_;

  // Our random number generator.
  internal::Random random_;

  // The time of the test program start, in ms from the start of the
  // UNIX epoch.
  TimeInMillis start_timestamp_;

  // How long the test took to run, in milliseconds.
  TimeInMillis elapsed_time_;

#if GTEST_HAS_DEATH_TEST
  // The decomposed components of the gtest_internal_run_death_test flag,
  // parsed when RUN_ALL_TESTS is called.
  internal::scoped_ptr internal_run_death_test_flag_;
  internal::scoped_ptr death_test_factory_;
#endif  // GTEST_HAS_DEATH_TEST

  // A per-thread stack of traces created by the SCOPED_TRACE() macro.
  internal::ThreadLocal > gtest_trace_stack_;

  // The value of GTEST_FLAG(catch_exceptions) at the moment RunAllTests()
  // starts.
  bool catch_exceptions_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(UnitTestImpl);
};  // class UnitTestImpl

// Convenience function for accessing the global UnitTest
// implementation object.
inline UnitTestImpl* GetUnitTestImpl() {
  return UnitTest::GetInstance()->impl();
}

#if GTEST_USES_SIMPLE_RE

// Internal helper functions for implementing the simple regular
// expression matcher.
GTEST_API_ bool IsInSet(char ch, const char* str);
GTEST_API_ bool IsAsciiDigit(char ch);
GTEST_API_ bool IsAsciiPunct(char ch);
GTEST_API_ bool IsRepeat(char ch);
GTEST_API_ bool IsAsciiWhiteSpace(char ch);
GTEST_API_ bool IsAsciiWordChar(char ch);
GTEST_API_ bool IsValidEscape(char ch);
GTEST_API_ bool AtomMatchesChar(bool escaped, char pattern, char ch);
GTEST_API_ bool ValidateRegex(const char* regex);
GTEST_API_ bool MatchRegexAtHead(const char* regex, const char* str);
GTEST_API_ bool MatchRepetitionAndRegexAtHead(
    bool escaped, char ch, char repeat, const char* regex, const char* str);
GTEST_API_ bool MatchRegexAnywhere(const char* regex, const char* str);

#endif  // GTEST_USES_SIMPLE_RE

// Parses the command line for Google Test flags, without initializing
// other parts of Google Test.
GTEST_API_ void ParseGoogleTestFlagsOnly(int* argc, char** argv);
GTEST_API_ void ParseGoogleTestFlagsOnly(int* argc, wchar_t** argv);

#if GTEST_HAS_DEATH_TEST

// Returns the message describing the last system error, regardless of the
// platform.
GTEST_API_ std::string GetLastErrnoDescription();

// Attempts to parse a string into a positive integer pointed to by the
// number parameter.  Returns true if that is possible.
// GTEST_HAS_DEATH_TEST implies that we have ::std::string, so we can use
// it here.
template 
bool ParseNaturalNumber(const ::std::string& str, Integer* number) {
  // Fail fast if the given string does not begin with a digit;
  // this bypasses strtoXXX's "optional leading whitespace and plus
  // or minus sign" semantics, which are undesirable here.
  if (str.empty() || !IsDigit(str[0])) {
    return false;
  }
  errno = 0;

  char* end;
  // BiggestConvertible is the largest integer type that system-provided
  // string-to-number conversion routines can return.

# if GTEST_OS_WINDOWS && !defined(__GNUC__)

  // MSVC and C++ Builder define __int64 instead of the standard long long.
  typedef unsigned __int64 BiggestConvertible;
  const BiggestConvertible parsed = _strtoui64(str.c_str(), &end, 10);

# else

  typedef unsigned long long BiggestConvertible;  // NOLINT
  const BiggestConvertible parsed = strtoull(str.c_str(), &end, 10);

# endif  // GTEST_OS_WINDOWS && !defined(__GNUC__)

  const bool parse_success = *end == '\0' && errno == 0;

  // TODO(vladl@google.com): Convert this to compile time assertion when it is
  // available.
  GTEST_CHECK_(sizeof(Integer) <= sizeof(parsed));

  const Integer result = static_cast(parsed);
  if (parse_success && static_cast(result) == parsed) {
    *number = result;
    return true;
  }
  return false;
}
#endif  // GTEST_HAS_DEATH_TEST

// TestResult contains some private methods that should be hidden from
// Google Test user but are required for testing. This class allow our tests
// to access them.
//
// This class is supplied only for the purpose of testing Google Test's own
// constructs. Do not use it in user tests, either directly or indirectly.
class TestResultAccessor {
 public:
  static void RecordProperty(TestResult* test_result,
                             const std::string& xml_element,
                             const TestProperty& property) {
    test_result->RecordProperty(xml_element, property);
  }

  static void ClearTestPartResults(TestResult* test_result) {
    test_result->ClearTestPartResults();
  }

  static const std::vector& test_part_results(
      const TestResult& test_result) {
    return test_result.test_part_results();
  }
};

#if GTEST_CAN_STREAM_RESULTS_

// Streams test results to the given port on the given host machine.
class StreamingListener : public EmptyTestEventListener {
 public:
  // Abstract base class for writing strings to a socket.
  class AbstractSocketWriter {
   public:
    virtual ~AbstractSocketWriter() {}

    // Sends a string to the socket.
    virtual void Send(const string& message) = 0;

    // Closes the socket.
    virtual void CloseConnection() {}

    // Sends a string and a newline to the socket.
    void SendLn(const string& message) {
      Send(message + "\n");
    }
  };

  // Concrete class for actually writing strings to a socket.
  class SocketWriter : public AbstractSocketWriter {
   public:
    SocketWriter(const string& host, const string& port)
        : sockfd_(-1), host_name_(host), port_num_(port) {
      MakeConnection();
    }

    virtual ~SocketWriter() {
      if (sockfd_ != -1)
        CloseConnection();
    }

    // Sends a string to the socket.
    virtual void Send(const string& message) {
      GTEST_CHECK_(sockfd_ != -1)
          << "Send() can be called only when there is a connection.";

      const int len = static_cast(message.length());
      if (write(sockfd_, message.c_str(), len) != len) {
        GTEST_LOG_(WARNING)
            << "stream_result_to: failed to stream to "
            << host_name_ << ":" << port_num_;
      }
    }

   private:
    // Creates a client socket and connects to the server.
    void MakeConnection();

    // Closes the socket.
    void CloseConnection() {
      GTEST_CHECK_(sockfd_ != -1)
          << "CloseConnection() can be called only when there is a connection.";

      close(sockfd_);
      sockfd_ = -1;
    }

    int sockfd_;  // socket file descriptor
    const string host_name_;
    const string port_num_;

    GTEST_DISALLOW_COPY_AND_ASSIGN_(SocketWriter);
  };  // class SocketWriter

  // Escapes '=', '&', '%', and '\n' characters in str as "%xx".
  static string UrlEncode(const char* str);

  StreamingListener(const string& host, const string& port)
      : socket_writer_(new SocketWriter(host, port)) { Start(); }

  explicit StreamingListener(AbstractSocketWriter* socket_writer)
      : socket_writer_(socket_writer) { Start(); }

  void OnTestProgramStart(const UnitTest& /* unit_test */) {
    SendLn("event=TestProgramStart");
  }

  void OnTestProgramEnd(const UnitTest& unit_test) {
    // Note that Google Test current only report elapsed time for each
    // test iteration, not for the entire test program.
    SendLn("event=TestProgramEnd&passed=" + FormatBool(unit_test.Passed()));

    // Notify the streaming server to stop.
    socket_writer_->CloseConnection();
  }

  void OnTestIterationStart(const UnitTest& /* unit_test */, int iteration) {
    SendLn("event=TestIterationStart&iteration=" +
           StreamableToString(iteration));
  }

  void OnTestIterationEnd(const UnitTest& unit_test, int /* iteration */) {
    SendLn("event=TestIterationEnd&passed=" +
           FormatBool(unit_test.Passed()) + "&elapsed_time=" +
           StreamableToString(unit_test.elapsed_time()) + "ms");
  }

  void OnTestCaseStart(const TestCase& test_case) {
    SendLn(std::string("event=TestCaseStart&name=") + test_case.name());
  }

  void OnTestCaseEnd(const TestCase& test_case) {
    SendLn("event=TestCaseEnd&passed=" + FormatBool(test_case.Passed())
           + "&elapsed_time=" + StreamableToString(test_case.elapsed_time())
           + "ms");
  }

  void OnTestStart(const TestInfo& test_info) {
    SendLn(std::string("event=TestStart&name=") + test_info.name());
  }

  void OnTestEnd(const TestInfo& test_info) {
    SendLn("event=TestEnd&passed=" +
           FormatBool((test_info.result())->Passed()) +
           "&elapsed_time=" +
           StreamableToString((test_info.result())->elapsed_time()) + "ms");
  }

  void OnTestPartResult(const TestPartResult& test_part_result) {
    const char* file_name = test_part_result.file_name();
    if (file_name == NULL)
      file_name = "";
    SendLn("event=TestPartResult&file=" + UrlEncode(file_name) +
           "&line=" + StreamableToString(test_part_result.line_number()) +
           "&message=" + UrlEncode(test_part_result.message()));
  }

 private:
  // Sends the given message and a newline to the socket.
  void SendLn(const string& message) { socket_writer_->SendLn(message); }

  // Called at the start of streaming to notify the receiver what
  // protocol we are using.
  void Start() { SendLn("gtest_streaming_protocol_version=1.0"); }

  string FormatBool(bool value) { return value ? "1" : "0"; }

  const scoped_ptr socket_writer_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(StreamingListener);
};  // class StreamingListener

#endif  // GTEST_CAN_STREAM_RESULTS_

}  // namespace internal
}  // namespace testing

#endif  // GTEST_SRC_GTEST_INTERNAL_INL_H_
node-v4.8.2/deps/gtest/src/gtest-port.cc000644 000766 000024 00000120254 13070706730 020246 0ustar00iojsstaff000000 000000 // Copyright 2008, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Author: wan@google.com (Zhanyong Wan)

#include "gtest/internal/gtest-port.h"

#include 
#include 
#include 
#include 

#if GTEST_OS_WINDOWS
# include 
# include 
# include 
# include   // Used in ThreadLocal.
#else
# include 
#endif  // GTEST_OS_WINDOWS

#if GTEST_OS_MAC
# include 
# include 
# include 
#endif  // GTEST_OS_MAC

#if GTEST_OS_QNX
# include 
# include 
# include 
#endif  // GTEST_OS_QNX

#include "gtest/gtest-spi.h"
#include "gtest/gtest-message.h"
#include "gtest/internal/gtest-internal.h"
#include "gtest/internal/gtest-string.h"

// Indicates that this translation unit is part of Google Test's
// implementation.  It must come before gtest-internal-inl.h is
// included, or there will be a compiler error.  This trick exists to
// prevent the accidental inclusion of gtest-internal-inl.h in the
// user's code.
#define GTEST_IMPLEMENTATION_ 1
#include "src/gtest-internal-inl.h"
#undef GTEST_IMPLEMENTATION_

namespace testing {
namespace internal {

#if defined(_MSC_VER) || defined(__BORLANDC__)
// MSVC and C++Builder do not provide a definition of STDERR_FILENO.
const int kStdOutFileno = 1;
const int kStdErrFileno = 2;
#else
const int kStdOutFileno = STDOUT_FILENO;
const int kStdErrFileno = STDERR_FILENO;
#endif  // _MSC_VER

#if GTEST_OS_MAC

// Returns the number of threads running in the process, or 0 to indicate that
// we cannot detect it.
size_t GetThreadCount() {
  const task_t task = mach_task_self();
  mach_msg_type_number_t thread_count;
  thread_act_array_t thread_list;
  const kern_return_t status = task_threads(task, &thread_list, &thread_count);
  if (status == KERN_SUCCESS) {
    // task_threads allocates resources in thread_list and we need to free them
    // to avoid leaks.
    vm_deallocate(task,
                  reinterpret_cast(thread_list),
                  sizeof(thread_t) * thread_count);
    return static_cast(thread_count);
  } else {
    return 0;
  }
}

#elif GTEST_OS_QNX

// Returns the number of threads running in the process, or 0 to indicate that
// we cannot detect it.
size_t GetThreadCount() {
  const int fd = open("/proc/self/as", O_RDONLY);
  if (fd < 0) {
    return 0;
  }
  procfs_info process_info;
  const int status =
      devctl(fd, DCMD_PROC_INFO, &process_info, sizeof(process_info), NULL);
  close(fd);
  if (status == EOK) {
    return static_cast(process_info.num_threads);
  } else {
    return 0;
  }
}

#else

size_t GetThreadCount() {
  // There's no portable way to detect the number of threads, so we just
  // return 0 to indicate that we cannot detect it.
  return 0;
}

#endif  // GTEST_OS_MAC

#if GTEST_IS_THREADSAFE && GTEST_OS_WINDOWS

void SleepMilliseconds(int n) {
  ::Sleep(n);
}

AutoHandle::AutoHandle()
    : handle_(INVALID_HANDLE_VALUE) {}

AutoHandle::AutoHandle(Handle handle)
    : handle_(handle) {}

AutoHandle::~AutoHandle() {
  Reset();
}

AutoHandle::Handle AutoHandle::Get() const {
  return handle_;
}

void AutoHandle::Reset() {
  Reset(INVALID_HANDLE_VALUE);
}

void AutoHandle::Reset(HANDLE handle) {
  // Resetting with the same handle we already own is invalid.
  if (handle_ != handle) {
    if (IsCloseable()) {
      ::CloseHandle(handle_);
    }
    handle_ = handle;
  } else {
    GTEST_CHECK_(!IsCloseable())
        << "Resetting a valid handle to itself is likely a programmer error "
            "and thus not allowed.";
  }
}

bool AutoHandle::IsCloseable() const {
  // Different Windows APIs may use either of these values to represent an
  // invalid handle.
  return handle_ != NULL && handle_ != INVALID_HANDLE_VALUE;
}

Notification::Notification()
    : event_(::CreateEvent(NULL,   // Default security attributes.
                           TRUE,   // Do not reset automatically.
                           FALSE,  // Initially unset.
                           NULL)) {  // Anonymous event.
  GTEST_CHECK_(event_.Get() != NULL);
}

void Notification::Notify() {
  GTEST_CHECK_(::SetEvent(event_.Get()) != FALSE);
}

void Notification::WaitForNotification() {
  GTEST_CHECK_(
      ::WaitForSingleObject(event_.Get(), INFINITE) == WAIT_OBJECT_0);
}

Mutex::Mutex()
    : type_(kDynamic),
      owner_thread_id_(0),
      critical_section_init_phase_(0),
      critical_section_(new CRITICAL_SECTION) {
  ::InitializeCriticalSection(critical_section_);
}

Mutex::~Mutex() {
  // Static mutexes are leaked intentionally. It is not thread-safe to try
  // to clean them up.
  // TODO(yukawa): Switch to Slim Reader/Writer (SRW) Locks, which requires
  // nothing to clean it up but is available only on Vista and later.
  // http://msdn.microsoft.com/en-us/library/windows/desktop/aa904937.aspx
  if (type_ == kDynamic) {
    ::DeleteCriticalSection(critical_section_);
    delete critical_section_;
    critical_section_ = NULL;
  }
}

void Mutex::Lock() {
  ThreadSafeLazyInit();
  ::EnterCriticalSection(critical_section_);
  owner_thread_id_ = ::GetCurrentThreadId();
}

void Mutex::Unlock() {
  ThreadSafeLazyInit();
  // We don't protect writing to owner_thread_id_ here, as it's the
  // caller's responsibility to ensure that the current thread holds the
  // mutex when this is called.
  owner_thread_id_ = 0;
  ::LeaveCriticalSection(critical_section_);
}

// Does nothing if the current thread holds the mutex. Otherwise, crashes
// with high probability.
void Mutex::AssertHeld() {
  ThreadSafeLazyInit();
  GTEST_CHECK_(owner_thread_id_ == ::GetCurrentThreadId())
      << "The current thread is not holding the mutex @" << this;
}

// Initializes owner_thread_id_ and critical_section_ in static mutexes.
void Mutex::ThreadSafeLazyInit() {
  // Dynamic mutexes are initialized in the constructor.
  if (type_ == kStatic) {
    switch (
        ::InterlockedCompareExchange(&critical_section_init_phase_, 1L, 0L)) {
      case 0:
        // If critical_section_init_phase_ was 0 before the exchange, we
        // are the first to test it and need to perform the initialization.
        owner_thread_id_ = 0;
        critical_section_ = new CRITICAL_SECTION;
        ::InitializeCriticalSection(critical_section_);
        // Updates the critical_section_init_phase_ to 2 to signal
        // initialization complete.
        GTEST_CHECK_(::InterlockedCompareExchange(
                          &critical_section_init_phase_, 2L, 1L) ==
                      1L);
        break;
      case 1:
        // Somebody else is already initializing the mutex; spin until they
        // are done.
        while (::InterlockedCompareExchange(&critical_section_init_phase_,
                                            2L,
                                            2L) != 2L) {
          // Possibly yields the rest of the thread's time slice to other
          // threads.
          ::Sleep(0);
        }
        break;

      case 2:
        break;  // The mutex is already initialized and ready for use.

      default:
        GTEST_CHECK_(false)
            << "Unexpected value of critical_section_init_phase_ "
            << "while initializing a static mutex.";
    }
  }
}

namespace {

class ThreadWithParamSupport : public ThreadWithParamBase {
 public:
  static HANDLE CreateThread(Runnable* runnable,
                             Notification* thread_can_start) {
    ThreadMainParam* param = new ThreadMainParam(runnable, thread_can_start);
    DWORD thread_id;
    // TODO(yukawa): Consider to use _beginthreadex instead.
    HANDLE thread_handle = ::CreateThread(
        NULL,    // Default security.
        0,       // Default stack size.
        &ThreadWithParamSupport::ThreadMain,
        param,   // Parameter to ThreadMainStatic
        0x0,     // Default creation flags.
        &thread_id);  // Need a valid pointer for the call to work under Win98.
    GTEST_CHECK_(thread_handle != NULL) << "CreateThread failed with error "
                                        << ::GetLastError() << ".";
    if (thread_handle == NULL) {
      delete param;
    }
    return thread_handle;
  }

 private:
  struct ThreadMainParam {
    ThreadMainParam(Runnable* runnable, Notification* thread_can_start)
        : runnable_(runnable),
          thread_can_start_(thread_can_start) {
    }
    scoped_ptr runnable_;
    // Does not own.
    Notification* thread_can_start_;
  };

  static DWORD WINAPI ThreadMain(void* ptr) {
    // Transfers ownership.
    scoped_ptr param(static_cast(ptr));
    if (param->thread_can_start_ != NULL)
      param->thread_can_start_->WaitForNotification();
    param->runnable_->Run();
    return 0;
  }

  // Prohibit instantiation.
  ThreadWithParamSupport();

  GTEST_DISALLOW_COPY_AND_ASSIGN_(ThreadWithParamSupport);
};

}  // namespace

ThreadWithParamBase::ThreadWithParamBase(Runnable *runnable,
                                         Notification* thread_can_start)
      : thread_(ThreadWithParamSupport::CreateThread(runnable,
                                                     thread_can_start)) {
}

ThreadWithParamBase::~ThreadWithParamBase() {
  Join();
}

void ThreadWithParamBase::Join() {
  GTEST_CHECK_(::WaitForSingleObject(thread_.Get(), INFINITE) == WAIT_OBJECT_0)
      << "Failed to join the thread with error " << ::GetLastError() << ".";
}

// Maps a thread to a set of ThreadIdToThreadLocals that have values
// instantiated on that thread and notifies them when the thread exits.  A
// ThreadLocal instance is expected to persist until all threads it has
// values on have terminated.
class ThreadLocalRegistryImpl {
 public:
  // Registers thread_local_instance as having value on the current thread.
  // Returns a value that can be used to identify the thread from other threads.
  static ThreadLocalValueHolderBase* GetValueOnCurrentThread(
      const ThreadLocalBase* thread_local_instance) {
    DWORD current_thread = ::GetCurrentThreadId();
    MutexLock lock(&mutex_);
    ThreadIdToThreadLocals* const thread_to_thread_locals =
        GetThreadLocalsMapLocked();
    ThreadIdToThreadLocals::iterator thread_local_pos =
        thread_to_thread_locals->find(current_thread);
    if (thread_local_pos == thread_to_thread_locals->end()) {
      thread_local_pos = thread_to_thread_locals->insert(
          std::make_pair(current_thread, ThreadLocalValues())).first;
      StartWatcherThreadFor(current_thread);
    }
    ThreadLocalValues& thread_local_values = thread_local_pos->second;
    ThreadLocalValues::iterator value_pos =
        thread_local_values.find(thread_local_instance);
    if (value_pos == thread_local_values.end()) {
      value_pos =
          thread_local_values
              .insert(std::make_pair(
                  thread_local_instance,
                  linked_ptr(
                      thread_local_instance->NewValueForCurrentThread())))
              .first;
    }
    return value_pos->second.get();
  }

  static void OnThreadLocalDestroyed(
      const ThreadLocalBase* thread_local_instance) {
    std::vector > value_holders;
    // Clean up the ThreadLocalValues data structure while holding the lock, but
    // defer the destruction of the ThreadLocalValueHolderBases.
    {
      MutexLock lock(&mutex_);
      ThreadIdToThreadLocals* const thread_to_thread_locals =
          GetThreadLocalsMapLocked();
      for (ThreadIdToThreadLocals::iterator it =
          thread_to_thread_locals->begin();
          it != thread_to_thread_locals->end();
          ++it) {
        ThreadLocalValues& thread_local_values = it->second;
        ThreadLocalValues::iterator value_pos =
            thread_local_values.find(thread_local_instance);
        if (value_pos != thread_local_values.end()) {
          value_holders.push_back(value_pos->second);
          thread_local_values.erase(value_pos);
          // This 'if' can only be successful at most once, so theoretically we
          // could break out of the loop here, but we don't bother doing so.
        }
      }
    }
    // Outside the lock, let the destructor for 'value_holders' deallocate the
    // ThreadLocalValueHolderBases.
  }

  static void OnThreadExit(DWORD thread_id) {
    GTEST_CHECK_(thread_id != 0) << ::GetLastError();
    std::vector > value_holders;
    // Clean up the ThreadIdToThreadLocals data structure while holding the
    // lock, but defer the destruction of the ThreadLocalValueHolderBases.
    {
      MutexLock lock(&mutex_);
      ThreadIdToThreadLocals* const thread_to_thread_locals =
          GetThreadLocalsMapLocked();
      ThreadIdToThreadLocals::iterator thread_local_pos =
          thread_to_thread_locals->find(thread_id);
      if (thread_local_pos != thread_to_thread_locals->end()) {
        ThreadLocalValues& thread_local_values = thread_local_pos->second;
        for (ThreadLocalValues::iterator value_pos =
            thread_local_values.begin();
            value_pos != thread_local_values.end();
            ++value_pos) {
          value_holders.push_back(value_pos->second);
        }
        thread_to_thread_locals->erase(thread_local_pos);
      }
    }
    // Outside the lock, let the destructor for 'value_holders' deallocate the
    // ThreadLocalValueHolderBases.
  }

 private:
  // In a particular thread, maps a ThreadLocal object to its value.
  typedef std::map > ThreadLocalValues;
  // Stores all ThreadIdToThreadLocals having values in a thread, indexed by
  // thread's ID.
  typedef std::map ThreadIdToThreadLocals;

  // Holds the thread id and thread handle that we pass from
  // StartWatcherThreadFor to WatcherThreadFunc.
  typedef std::pair ThreadIdAndHandle;

  static void StartWatcherThreadFor(DWORD thread_id) {
    // The returned handle will be kept in thread_map and closed by
    // watcher_thread in WatcherThreadFunc.
    HANDLE thread = ::OpenThread(SYNCHRONIZE | THREAD_QUERY_INFORMATION,
                                 FALSE,
                                 thread_id);
    GTEST_CHECK_(thread != NULL);
    // We need to to pass a valid thread ID pointer into CreateThread for it
    // to work correctly under Win98.
    DWORD watcher_thread_id;
    HANDLE watcher_thread = ::CreateThread(
        NULL,   // Default security.
        0,      // Default stack size
        &ThreadLocalRegistryImpl::WatcherThreadFunc,
        reinterpret_cast(new ThreadIdAndHandle(thread_id, thread)),
        CREATE_SUSPENDED,
        &watcher_thread_id);
    GTEST_CHECK_(watcher_thread != NULL);
    // Give the watcher thread the same priority as ours to avoid being
    // blocked by it.
    ::SetThreadPriority(watcher_thread,
                        ::GetThreadPriority(::GetCurrentThread()));
    ::ResumeThread(watcher_thread);
    ::CloseHandle(watcher_thread);
  }

  // Monitors exit from a given thread and notifies those
  // ThreadIdToThreadLocals about thread termination.
  static DWORD WINAPI WatcherThreadFunc(LPVOID param) {
    const ThreadIdAndHandle* tah =
        reinterpret_cast(param);
    GTEST_CHECK_(
        ::WaitForSingleObject(tah->second, INFINITE) == WAIT_OBJECT_0);
    OnThreadExit(tah->first);
    ::CloseHandle(tah->second);
    delete tah;
    return 0;
  }

  // Returns map of thread local instances.
  static ThreadIdToThreadLocals* GetThreadLocalsMapLocked() {
    mutex_.AssertHeld();
    static ThreadIdToThreadLocals* map = new ThreadIdToThreadLocals;
    return map;
  }

  // Protects access to GetThreadLocalsMapLocked() and its return value.
  static Mutex mutex_;
  // Protects access to GetThreadMapLocked() and its return value.
  static Mutex thread_map_mutex_;
};

Mutex ThreadLocalRegistryImpl::mutex_(Mutex::kStaticMutex);
Mutex ThreadLocalRegistryImpl::thread_map_mutex_(Mutex::kStaticMutex);

ThreadLocalValueHolderBase* ThreadLocalRegistry::GetValueOnCurrentThread(
      const ThreadLocalBase* thread_local_instance) {
  return ThreadLocalRegistryImpl::GetValueOnCurrentThread(
      thread_local_instance);
}

void ThreadLocalRegistry::OnThreadLocalDestroyed(
      const ThreadLocalBase* thread_local_instance) {
  ThreadLocalRegistryImpl::OnThreadLocalDestroyed(thread_local_instance);
}

#endif  // GTEST_IS_THREADSAFE && GTEST_OS_WINDOWS

#if GTEST_USES_POSIX_RE

// Implements RE.  Currently only needed for death tests.

RE::~RE() {
  if (is_valid_) {
    // regfree'ing an invalid regex might crash because the content
    // of the regex is undefined. Since the regex's are essentially
    // the same, one cannot be valid (or invalid) without the other
    // being so too.
    regfree(&partial_regex_);
    regfree(&full_regex_);
  }
  free(const_cast(pattern_));
}

// Returns true iff regular expression re matches the entire str.
bool RE::FullMatch(const char* str, const RE& re) {
  if (!re.is_valid_) return false;

  regmatch_t match;
  return regexec(&re.full_regex_, str, 1, &match, 0) == 0;
}

// Returns true iff regular expression re matches a substring of str
// (including str itself).
bool RE::PartialMatch(const char* str, const RE& re) {
  if (!re.is_valid_) return false;

  regmatch_t match;
  return regexec(&re.partial_regex_, str, 1, &match, 0) == 0;
}

// Initializes an RE from its string representation.
void RE::Init(const char* regex) {
  pattern_ = posix::StrDup(regex);

  // Reserves enough bytes to hold the regular expression used for a
  // full match.
  const size_t full_regex_len = strlen(regex) + 10;
  char* const full_pattern = new char[full_regex_len];

  snprintf(full_pattern, full_regex_len, "^(%s)$", regex);
  is_valid_ = regcomp(&full_regex_, full_pattern, REG_EXTENDED) == 0;
  // We want to call regcomp(&partial_regex_, ...) even if the
  // previous expression returns false.  Otherwise partial_regex_ may
  // not be properly initialized can may cause trouble when it's
  // freed.
  //
  // Some implementation of POSIX regex (e.g. on at least some
  // versions of Cygwin) doesn't accept the empty string as a valid
  // regex.  We change it to an equivalent form "()" to be safe.
  if (is_valid_) {
    const char* const partial_regex = (*regex == '\0') ? "()" : regex;
    is_valid_ = regcomp(&partial_regex_, partial_regex, REG_EXTENDED) == 0;
  }
  EXPECT_TRUE(is_valid_)
      << "Regular expression \"" << regex
      << "\" is not a valid POSIX Extended regular expression.";

  delete[] full_pattern;
}

#elif GTEST_USES_SIMPLE_RE

// Returns true iff ch appears anywhere in str (excluding the
// terminating '\0' character).
bool IsInSet(char ch, const char* str) {
  return ch != '\0' && strchr(str, ch) != NULL;
}

// Returns true iff ch belongs to the given classification.  Unlike
// similar functions in , these aren't affected by the
// current locale.
bool IsAsciiDigit(char ch) { return '0' <= ch && ch <= '9'; }
bool IsAsciiPunct(char ch) {
  return IsInSet(ch, "^-!\"#$%&'()*+,./:;<=>?@[\\]_`{|}~");
}
bool IsRepeat(char ch) { return IsInSet(ch, "?*+"); }
bool IsAsciiWhiteSpace(char ch) { return IsInSet(ch, " \f\n\r\t\v"); }
bool IsAsciiWordChar(char ch) {
  return ('a' <= ch && ch <= 'z') || ('A' <= ch && ch <= 'Z') ||
      ('0' <= ch && ch <= '9') || ch == '_';
}

// Returns true iff "\\c" is a supported escape sequence.
bool IsValidEscape(char c) {
  return (IsAsciiPunct(c) || IsInSet(c, "dDfnrsStvwW"));
}

// Returns true iff the given atom (specified by escaped and pattern)
// matches ch.  The result is undefined if the atom is invalid.
bool AtomMatchesChar(bool escaped, char pattern_char, char ch) {
  if (escaped) {  // "\\p" where p is pattern_char.
    switch (pattern_char) {
      case 'd': return IsAsciiDigit(ch);
      case 'D': return !IsAsciiDigit(ch);
      case 'f': return ch == '\f';
      case 'n': return ch == '\n';
      case 'r': return ch == '\r';
      case 's': return IsAsciiWhiteSpace(ch);
      case 'S': return !IsAsciiWhiteSpace(ch);
      case 't': return ch == '\t';
      case 'v': return ch == '\v';
      case 'w': return IsAsciiWordChar(ch);
      case 'W': return !IsAsciiWordChar(ch);
    }
    return IsAsciiPunct(pattern_char) && pattern_char == ch;
  }

  return (pattern_char == '.' && ch != '\n') || pattern_char == ch;
}

// Helper function used by ValidateRegex() to format error messages.
std::string FormatRegexSyntaxError(const char* regex, int index) {
  return (Message() << "Syntax error at index " << index
          << " in simple regular expression \"" << regex << "\": ").GetString();
}

// Generates non-fatal failures and returns false if regex is invalid;
// otherwise returns true.
bool ValidateRegex(const char* regex) {
  if (regex == NULL) {
    // TODO(wan@google.com): fix the source file location in the
    // assertion failures to match where the regex is used in user
    // code.
    ADD_FAILURE() << "NULL is not a valid simple regular expression.";
    return false;
  }

  bool is_valid = true;

  // True iff ?, *, or + can follow the previous atom.
  bool prev_repeatable = false;
  for (int i = 0; regex[i]; i++) {
    if (regex[i] == '\\') {  // An escape sequence
      i++;
      if (regex[i] == '\0') {
        ADD_FAILURE() << FormatRegexSyntaxError(regex, i - 1)
                      << "'\\' cannot appear at the end.";
        return false;
      }

      if (!IsValidEscape(regex[i])) {
        ADD_FAILURE() << FormatRegexSyntaxError(regex, i - 1)
                      << "invalid escape sequence \"\\" << regex[i] << "\".";
        is_valid = false;
      }
      prev_repeatable = true;
    } else {  // Not an escape sequence.
      const char ch = regex[i];

      if (ch == '^' && i > 0) {
        ADD_FAILURE() << FormatRegexSyntaxError(regex, i)
                      << "'^' can only appear at the beginning.";
        is_valid = false;
      } else if (ch == '$' && regex[i + 1] != '\0') {
        ADD_FAILURE() << FormatRegexSyntaxError(regex, i)
                      << "'$' can only appear at the end.";
        is_valid = false;
      } else if (IsInSet(ch, "()[]{}|")) {
        ADD_FAILURE() << FormatRegexSyntaxError(regex, i)
                      << "'" << ch << "' is unsupported.";
        is_valid = false;
      } else if (IsRepeat(ch) && !prev_repeatable) {
        ADD_FAILURE() << FormatRegexSyntaxError(regex, i)
                      << "'" << ch << "' can only follow a repeatable token.";
        is_valid = false;
      }

      prev_repeatable = !IsInSet(ch, "^$?*+");
    }
  }

  return is_valid;
}

// Matches a repeated regex atom followed by a valid simple regular
// expression.  The regex atom is defined as c if escaped is false,
// or \c otherwise.  repeat is the repetition meta character (?, *,
// or +).  The behavior is undefined if str contains too many
// characters to be indexable by size_t, in which case the test will
// probably time out anyway.  We are fine with this limitation as
// std::string has it too.
bool MatchRepetitionAndRegexAtHead(
    bool escaped, char c, char repeat, const char* regex,
    const char* str) {
  const size_t min_count = (repeat == '+') ? 1 : 0;
  const size_t max_count = (repeat == '?') ? 1 :
      static_cast(-1) - 1;
  // We cannot call numeric_limits::max() as it conflicts with the
  // max() macro on Windows.

  for (size_t i = 0; i <= max_count; ++i) {
    // We know that the atom matches each of the first i characters in str.
    if (i >= min_count && MatchRegexAtHead(regex, str + i)) {
      // We have enough matches at the head, and the tail matches too.
      // Since we only care about *whether* the pattern matches str
      // (as opposed to *how* it matches), there is no need to find a
      // greedy match.
      return true;
    }
    if (str[i] == '\0' || !AtomMatchesChar(escaped, c, str[i]))
      return false;
  }
  return false;
}

// Returns true iff regex matches a prefix of str.  regex must be a
// valid simple regular expression and not start with "^", or the
// result is undefined.
bool MatchRegexAtHead(const char* regex, const char* str) {
  if (*regex == '\0')  // An empty regex matches a prefix of anything.
    return true;

  // "$" only matches the end of a string.  Note that regex being
  // valid guarantees that there's nothing after "$" in it.
  if (*regex == '$')
    return *str == '\0';

  // Is the first thing in regex an escape sequence?
  const bool escaped = *regex == '\\';
  if (escaped)
    ++regex;
  if (IsRepeat(regex[1])) {
    // MatchRepetitionAndRegexAtHead() calls MatchRegexAtHead(), so
    // here's an indirect recursion.  It terminates as the regex gets
    // shorter in each recursion.
    return MatchRepetitionAndRegexAtHead(
        escaped, regex[0], regex[1], regex + 2, str);
  } else {
    // regex isn't empty, isn't "$", and doesn't start with a
    // repetition.  We match the first atom of regex with the first
    // character of str and recurse.
    return (*str != '\0') && AtomMatchesChar(escaped, *regex, *str) &&
        MatchRegexAtHead(regex + 1, str + 1);
  }
}

// Returns true iff regex matches any substring of str.  regex must be
// a valid simple regular expression, or the result is undefined.
//
// The algorithm is recursive, but the recursion depth doesn't exceed
// the regex length, so we won't need to worry about running out of
// stack space normally.  In rare cases the time complexity can be
// exponential with respect to the regex length + the string length,
// but usually it's must faster (often close to linear).
bool MatchRegexAnywhere(const char* regex, const char* str) {
  if (regex == NULL || str == NULL)
    return false;

  if (*regex == '^')
    return MatchRegexAtHead(regex + 1, str);

  // A successful match can be anywhere in str.
  do {
    if (MatchRegexAtHead(regex, str))
      return true;
  } while (*str++ != '\0');
  return false;
}

// Implements the RE class.

RE::~RE() {
  free(const_cast(pattern_));
  free(const_cast(full_pattern_));
}

// Returns true iff regular expression re matches the entire str.
bool RE::FullMatch(const char* str, const RE& re) {
  return re.is_valid_ && MatchRegexAnywhere(re.full_pattern_, str);
}

// Returns true iff regular expression re matches a substring of str
// (including str itself).
bool RE::PartialMatch(const char* str, const RE& re) {
  return re.is_valid_ && MatchRegexAnywhere(re.pattern_, str);
}

// Initializes an RE from its string representation.
void RE::Init(const char* regex) {
  pattern_ = full_pattern_ = NULL;
  if (regex != NULL) {
    pattern_ = posix::StrDup(regex);
  }

  is_valid_ = ValidateRegex(regex);
  if (!is_valid_) {
    // No need to calculate the full pattern when the regex is invalid.
    return;
  }

  const size_t len = strlen(regex);
  // Reserves enough bytes to hold the regular expression used for a
  // full match: we need space to prepend a '^', append a '$', and
  // terminate the string with '\0'.
  char* buffer = static_cast(malloc(len + 3));
  full_pattern_ = buffer;

  if (*regex != '^')
    *buffer++ = '^';  // Makes sure full_pattern_ starts with '^'.

  // We don't use snprintf or strncpy, as they trigger a warning when
  // compiled with VC++ 8.0.
  memcpy(buffer, regex, len);
  buffer += len;

  if (len == 0 || regex[len - 1] != '$')
    *buffer++ = '$';  // Makes sure full_pattern_ ends with '$'.

  *buffer = '\0';
}

#endif  // GTEST_USES_POSIX_RE

const char kUnknownFile[] = "unknown file";

// Formats a source file path and a line number as they would appear
// in an error message from the compiler used to compile this code.
GTEST_API_ ::std::string FormatFileLocation(const char* file, int line) {
  const std::string file_name(file == NULL ? kUnknownFile : file);

  if (line < 0) {
    return file_name + ":";
  }
#ifdef _MSC_VER
  return file_name + "(" + StreamableToString(line) + "):";
#else
  return file_name + ":" + StreamableToString(line) + ":";
#endif  // _MSC_VER
}

// Formats a file location for compiler-independent XML output.
// Although this function is not platform dependent, we put it next to
// FormatFileLocation in order to contrast the two functions.
// Note that FormatCompilerIndependentFileLocation() does NOT append colon
// to the file location it produces, unlike FormatFileLocation().
GTEST_API_ ::std::string FormatCompilerIndependentFileLocation(
    const char* file, int line) {
  const std::string file_name(file == NULL ? kUnknownFile : file);

  if (line < 0)
    return file_name;
  else
    return file_name + ":" + StreamableToString(line);
}


GTestLog::GTestLog(GTestLogSeverity severity, const char* file, int line)
    : severity_(severity) {
  const char* const marker =
      severity == GTEST_INFO ?    "[  INFO ]" :
      severity == GTEST_WARNING ? "[WARNING]" :
      severity == GTEST_ERROR ?   "[ ERROR ]" : "[ FATAL ]";
  GetStream() << ::std::endl << marker << " "
              << FormatFileLocation(file, line).c_str() << ": ";
}

// Flushes the buffers and, if severity is GTEST_FATAL, aborts the program.
GTestLog::~GTestLog() {
  GetStream() << ::std::endl;
  if (severity_ == GTEST_FATAL) {
    fflush(stderr);
    posix::Abort();
  }
}
// Disable Microsoft deprecation warnings for POSIX functions called from
// this class (creat, dup, dup2, and close)
GTEST_DISABLE_MSC_WARNINGS_PUSH_(4996)

#if GTEST_HAS_STREAM_REDIRECTION

// Object that captures an output stream (stdout/stderr).
class CapturedStream {
 public:
  // The ctor redirects the stream to a temporary file.
  explicit CapturedStream(int fd) : fd_(fd), uncaptured_fd_(dup(fd)) {
# if GTEST_OS_WINDOWS
    char temp_dir_path[MAX_PATH + 1] = { '\0' };  // NOLINT
    char temp_file_path[MAX_PATH + 1] = { '\0' };  // NOLINT

    ::GetTempPathA(sizeof(temp_dir_path), temp_dir_path);
    const UINT success = ::GetTempFileNameA(temp_dir_path,
                                            "gtest_redir",
                                            0,  // Generate unique file name.
                                            temp_file_path);
    GTEST_CHECK_(success != 0)
        << "Unable to create a temporary file in " << temp_dir_path;
    const int captured_fd = creat(temp_file_path, _S_IREAD | _S_IWRITE);
    GTEST_CHECK_(captured_fd != -1) << "Unable to open temporary file "
                                    << temp_file_path;
    filename_ = temp_file_path;
# else
    // There's no guarantee that a test has write access to the current
    // directory, so we create the temporary file in the /tmp directory
    // instead. We use /tmp on most systems, and /sdcard on Android.
    // That's because Android doesn't have /tmp.
#  if GTEST_OS_LINUX_ANDROID
    // Note: Android applications are expected to call the framework's
    // Context.getExternalStorageDirectory() method through JNI to get
    // the location of the world-writable SD Card directory. However,
    // this requires a Context handle, which cannot be retrieved
    // globally from native code. Doing so also precludes running the
    // code as part of a regular standalone executable, which doesn't
    // run in a Dalvik process (e.g. when running it through 'adb shell').
    //
    // The location /sdcard is directly accessible from native code
    // and is the only location (unofficially) supported by the Android
    // team. It's generally a symlink to the real SD Card mount point
    // which can be /mnt/sdcard, /mnt/sdcard0, /system/media/sdcard, or
    // other OEM-customized locations. Never rely on these, and always
    // use /sdcard.
    char name_template[] = "/sdcard/gtest_captured_stream.XXXXXX";
#  else
    char name_template[] = "/tmp/captured_stream.XXXXXX";
#  endif  // GTEST_OS_LINUX_ANDROID
    const int captured_fd = mkstemp(name_template);
    filename_ = name_template;
# endif  // GTEST_OS_WINDOWS
    fflush(NULL);
    dup2(captured_fd, fd_);
    close(captured_fd);
  }

  ~CapturedStream() {
    remove(filename_.c_str());
  }

  std::string GetCapturedString() {
    if (uncaptured_fd_ != -1) {
      // Restores the original stream.
      fflush(NULL);
      dup2(uncaptured_fd_, fd_);
      close(uncaptured_fd_);
      uncaptured_fd_ = -1;
    }

    FILE* const file = posix::FOpen(filename_.c_str(), "r");
    const std::string content = ReadEntireFile(file);
    posix::FClose(file);
    return content;
  }

 private:
  // Reads the entire content of a file as an std::string.
  static std::string ReadEntireFile(FILE* file);

  // Returns the size (in bytes) of a file.
  static size_t GetFileSize(FILE* file);

  const int fd_;  // A stream to capture.
  int uncaptured_fd_;
  // Name of the temporary file holding the stderr output.
  ::std::string filename_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(CapturedStream);
};

// Returns the size (in bytes) of a file.
size_t CapturedStream::GetFileSize(FILE* file) {
  fseek(file, 0, SEEK_END);
  return static_cast(ftell(file));
}

// Reads the entire content of a file as a string.
std::string CapturedStream::ReadEntireFile(FILE* file) {
  const size_t file_size = GetFileSize(file);
  char* const buffer = new char[file_size];

  size_t bytes_last_read = 0;  // # of bytes read in the last fread()
  size_t bytes_read = 0;       // # of bytes read so far

  fseek(file, 0, SEEK_SET);

  // Keeps reading the file until we cannot read further or the
  // pre-determined file size is reached.
  do {
    bytes_last_read = fread(buffer+bytes_read, 1, file_size-bytes_read, file);
    bytes_read += bytes_last_read;
  } while (bytes_last_read > 0 && bytes_read < file_size);

  const std::string content(buffer, bytes_read);
  delete[] buffer;

  return content;
}

GTEST_DISABLE_MSC_WARNINGS_POP_()

static CapturedStream* g_captured_stderr = NULL;
static CapturedStream* g_captured_stdout = NULL;

// Starts capturing an output stream (stdout/stderr).
void CaptureStream(int fd, const char* stream_name, CapturedStream** stream) {
  if (*stream != NULL) {
    GTEST_LOG_(FATAL) << "Only one " << stream_name
                      << " capturer can exist at a time.";
  }
  *stream = new CapturedStream(fd);
}

// Stops capturing the output stream and returns the captured string.
std::string GetCapturedStream(CapturedStream** captured_stream) {
  const std::string content = (*captured_stream)->GetCapturedString();

  delete *captured_stream;
  *captured_stream = NULL;

  return content;
}

// Starts capturing stdout.
void CaptureStdout() {
  CaptureStream(kStdOutFileno, "stdout", &g_captured_stdout);
}

// Starts capturing stderr.
void CaptureStderr() {
  CaptureStream(kStdErrFileno, "stderr", &g_captured_stderr);
}

// Stops capturing stdout and returns the captured string.
std::string GetCapturedStdout() {
  return GetCapturedStream(&g_captured_stdout);
}

// Stops capturing stderr and returns the captured string.
std::string GetCapturedStderr() {
  return GetCapturedStream(&g_captured_stderr);
}

#endif  // GTEST_HAS_STREAM_REDIRECTION

#if GTEST_HAS_DEATH_TEST

// A copy of all command line arguments.  Set by InitGoogleTest().
::std::vector g_argvs;

static const ::std::vector* g_injected_test_argvs =
                                        NULL;  // Owned.

void SetInjectableArgvs(const ::std::vector* argvs) {
  if (g_injected_test_argvs != argvs)
    delete g_injected_test_argvs;
  g_injected_test_argvs = argvs;
}

const ::std::vector& GetInjectableArgvs() {
  if (g_injected_test_argvs != NULL) {
    return *g_injected_test_argvs;
  }
  return g_argvs;
}
#endif  // GTEST_HAS_DEATH_TEST

#if GTEST_OS_WINDOWS_MOBILE
namespace posix {
void Abort() {
  DebugBreak();
  TerminateProcess(GetCurrentProcess(), 1);
}
}  // namespace posix
#endif  // GTEST_OS_WINDOWS_MOBILE

// Returns the name of the environment variable corresponding to the
// given flag.  For example, FlagToEnvVar("foo") will return
// "GTEST_FOO" in the open-source version.
static std::string FlagToEnvVar(const char* flag) {
  const std::string full_flag =
      (Message() << GTEST_FLAG_PREFIX_ << flag).GetString();

  Message env_var;
  for (size_t i = 0; i != full_flag.length(); i++) {
    env_var << ToUpper(full_flag.c_str()[i]);
  }

  return env_var.GetString();
}

// Parses 'str' for a 32-bit signed integer.  If successful, writes
// the result to *value and returns true; otherwise leaves *value
// unchanged and returns false.
bool ParseInt32(const Message& src_text, const char* str, Int32* value) {
  // Parses the environment variable as a decimal integer.
  char* end = NULL;
  const long long_value = strtol(str, &end, 10);  // NOLINT

  // Has strtol() consumed all characters in the string?
  if (*end != '\0') {
    // No - an invalid character was encountered.
    Message msg;
    msg << "WARNING: " << src_text
        << " is expected to be a 32-bit integer, but actually"
        << " has value \"" << str << "\".\n";
    printf("%s", msg.GetString().c_str());
    fflush(stdout);
    return false;
  }

  // Is the parsed value in the range of an Int32?
  const Int32 result = static_cast(long_value);
  if (long_value == LONG_MAX || long_value == LONG_MIN ||
      // The parsed value overflows as a long.  (strtol() returns
      // LONG_MAX or LONG_MIN when the input overflows.)
      result != long_value
      // The parsed value overflows as an Int32.
      ) {
    Message msg;
    msg << "WARNING: " << src_text
        << " is expected to be a 32-bit integer, but actually"
        << " has value " << str << ", which overflows.\n";
    printf("%s", msg.GetString().c_str());
    fflush(stdout);
    return false;
  }

  *value = result;
  return true;
}

// Reads and returns the Boolean environment variable corresponding to
// the given flag; if it's not set, returns default_value.
//
// The value is considered true iff it's not "0".
bool BoolFromGTestEnv(const char* flag, bool default_value) {
  const std::string env_var = FlagToEnvVar(flag);
  const char* const string_value = posix::GetEnv(env_var.c_str());
  return string_value == NULL ?
      default_value : strcmp(string_value, "0") != 0;
}

// Reads and returns a 32-bit integer stored in the environment
// variable corresponding to the given flag; if it isn't set or
// doesn't represent a valid 32-bit integer, returns default_value.
Int32 Int32FromGTestEnv(const char* flag, Int32 default_value) {
  const std::string env_var = FlagToEnvVar(flag);
  const char* const string_value = posix::GetEnv(env_var.c_str());
  if (string_value == NULL) {
    // The environment variable is not set.
    return default_value;
  }

  Int32 result = default_value;
  if (!ParseInt32(Message() << "Environment variable " << env_var,
                  string_value, &result)) {
    printf("The default value %s is used.\n",
           (Message() << default_value).GetString().c_str());
    fflush(stdout);
    return default_value;
  }

  return result;
}

// Reads and returns the string environment variable corresponding to
// the given flag; if it's not set, returns default_value.
const char* StringFromGTestEnv(const char* flag, const char* default_value) {
  const std::string env_var = FlagToEnvVar(flag);
  const char* const value = posix::GetEnv(env_var.c_str());
  return value == NULL ? default_value : value;
}

}  // namespace internal
}  // namespace testing
node-v4.8.2/deps/gtest/src/gtest-printers.cc000644 000766 000024 00000030521 13070706730 021125 0ustar00iojsstaff000000 000000 // Copyright 2007, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Author: wan@google.com (Zhanyong Wan)

// Google Test - The Google C++ Testing Framework
//
// This file implements a universal value printer that can print a
// value of any type T:
//
//   void ::testing::internal::UniversalPrinter::Print(value, ostream_ptr);
//
// It uses the << operator when possible, and prints the bytes in the
// object otherwise.  A user can override its behavior for a class
// type Foo by defining either operator<<(::std::ostream&, const Foo&)
// or void PrintTo(const Foo&, ::std::ostream*) in the namespace that
// defines Foo.

#include "gtest/gtest-printers.h"
#include 
#include 
#include 
#include   // NOLINT
#include 
#include "gtest/internal/gtest-port.h"

namespace testing {

namespace {

using ::std::ostream;

// Prints a segment of bytes in the given object.
GTEST_ATTRIBUTE_NO_SANITIZE_MEMORY_
GTEST_ATTRIBUTE_NO_SANITIZE_ADDRESS_
GTEST_ATTRIBUTE_NO_SANITIZE_THREAD_
void PrintByteSegmentInObjectTo(const unsigned char* obj_bytes, size_t start,
                                size_t count, ostream* os) {
  char text[5] = "";
  for (size_t i = 0; i != count; i++) {
    const size_t j = start + i;
    if (i != 0) {
      // Organizes the bytes into groups of 2 for easy parsing by
      // human.
      if ((j % 2) == 0)
        *os << ' ';
      else
        *os << '-';
    }
    GTEST_SNPRINTF_(text, sizeof(text), "%02X", obj_bytes[j]);
    *os << text;
  }
}

// Prints the bytes in the given value to the given ostream.
void PrintBytesInObjectToImpl(const unsigned char* obj_bytes, size_t count,
                              ostream* os) {
  // Tells the user how big the object is.
  *os << count << "-byte object <";

  const size_t kThreshold = 132;
  const size_t kChunkSize = 64;
  // If the object size is bigger than kThreshold, we'll have to omit
  // some details by printing only the first and the last kChunkSize
  // bytes.
  // TODO(wan): let the user control the threshold using a flag.
  if (count < kThreshold) {
    PrintByteSegmentInObjectTo(obj_bytes, 0, count, os);
  } else {
    PrintByteSegmentInObjectTo(obj_bytes, 0, kChunkSize, os);
    *os << " ... ";
    // Rounds up to 2-byte boundary.
    const size_t resume_pos = (count - kChunkSize + 1)/2*2;
    PrintByteSegmentInObjectTo(obj_bytes, resume_pos, count - resume_pos, os);
  }
  *os << ">";
}

}  // namespace

namespace internal2 {

// Delegates to PrintBytesInObjectToImpl() to print the bytes in the
// given object.  The delegation simplifies the implementation, which
// uses the << operator and thus is easier done outside of the
// ::testing::internal namespace, which contains a << operator that
// sometimes conflicts with the one in STL.
void PrintBytesInObjectTo(const unsigned char* obj_bytes, size_t count,
                          ostream* os) {
  PrintBytesInObjectToImpl(obj_bytes, count, os);
}

}  // namespace internal2

namespace internal {

// Depending on the value of a char (or wchar_t), we print it in one
// of three formats:
//   - as is if it's a printable ASCII (e.g. 'a', '2', ' '),
//   - as a hexidecimal escape sequence (e.g. '\x7F'), or
//   - as a special escape sequence (e.g. '\r', '\n').
enum CharFormat {
  kAsIs,
  kHexEscape,
  kSpecialEscape
};

// Returns true if c is a printable ASCII character.  We test the
// value of c directly instead of calling isprint(), which is buggy on
// Windows Mobile.
inline bool IsPrintableAscii(wchar_t c) {
  return 0x20 <= c && c <= 0x7E;
}

// Prints a wide or narrow char c as a character literal without the
// quotes, escaping it when necessary; returns how c was formatted.
// The template argument UnsignedChar is the unsigned version of Char,
// which is the type of c.
template 
static CharFormat PrintAsCharLiteralTo(Char c, ostream* os) {
  switch (static_cast(c)) {
    case L'\0':
      *os << "\\0";
      break;
    case L'\'':
      *os << "\\'";
      break;
    case L'\\':
      *os << "\\\\";
      break;
    case L'\a':
      *os << "\\a";
      break;
    case L'\b':
      *os << "\\b";
      break;
    case L'\f':
      *os << "\\f";
      break;
    case L'\n':
      *os << "\\n";
      break;
    case L'\r':
      *os << "\\r";
      break;
    case L'\t':
      *os << "\\t";
      break;
    case L'\v':
      *os << "\\v";
      break;
    default:
      if (IsPrintableAscii(c)) {
        *os << static_cast(c);
        return kAsIs;
      } else {
        *os << "\\x" + String::FormatHexInt(static_cast(c));
        return kHexEscape;
      }
  }
  return kSpecialEscape;
}

// Prints a wchar_t c as if it's part of a string literal, escaping it when
// necessary; returns how c was formatted.
static CharFormat PrintAsStringLiteralTo(wchar_t c, ostream* os) {
  switch (c) {
    case L'\'':
      *os << "'";
      return kAsIs;
    case L'"':
      *os << "\\\"";
      return kSpecialEscape;
    default:
      return PrintAsCharLiteralTo(c, os);
  }
}

// Prints a char c as if it's part of a string literal, escaping it when
// necessary; returns how c was formatted.
static CharFormat PrintAsStringLiteralTo(char c, ostream* os) {
  return PrintAsStringLiteralTo(
      static_cast(static_cast(c)), os);
}

// Prints a wide or narrow character c and its code.  '\0' is printed
// as "'\\0'", other unprintable characters are also properly escaped
// using the standard C++ escape sequence.  The template argument
// UnsignedChar is the unsigned version of Char, which is the type of c.
template 
void PrintCharAndCodeTo(Char c, ostream* os) {
  // First, print c as a literal in the most readable form we can find.
  *os << ((sizeof(c) > 1) ? "L'" : "'");
  const CharFormat format = PrintAsCharLiteralTo(c, os);
  *os << "'";

  // To aid user debugging, we also print c's code in decimal, unless
  // it's 0 (in which case c was printed as '\\0', making the code
  // obvious).
  if (c == 0)
    return;
  *os << " (" << static_cast(c);

  // For more convenience, we print c's code again in hexidecimal,
  // unless c was already printed in the form '\x##' or the code is in
  // [1, 9].
  if (format == kHexEscape || (1 <= c && c <= 9)) {
    // Do nothing.
  } else {
    *os << ", 0x" << String::FormatHexInt(static_cast(c));
  }
  *os << ")";
}

void PrintTo(unsigned char c, ::std::ostream* os) {
  PrintCharAndCodeTo(c, os);
}
void PrintTo(signed char c, ::std::ostream* os) {
  PrintCharAndCodeTo(c, os);
}

// Prints a wchar_t as a symbol if it is printable or as its internal
// code otherwise and also as its code.  L'\0' is printed as "L'\\0'".
void PrintTo(wchar_t wc, ostream* os) {
  PrintCharAndCodeTo(wc, os);
}

// Prints the given array of characters to the ostream.  CharType must be either
// char or wchar_t.
// The array starts at begin, the length is len, it may include '\0' characters
// and may not be NUL-terminated.
template 
GTEST_ATTRIBUTE_NO_SANITIZE_MEMORY_
GTEST_ATTRIBUTE_NO_SANITIZE_ADDRESS_
GTEST_ATTRIBUTE_NO_SANITIZE_THREAD_
static void PrintCharsAsStringTo(
    const CharType* begin, size_t len, ostream* os) {
  const char* const kQuoteBegin = sizeof(CharType) == 1 ? "\"" : "L\"";
  *os << kQuoteBegin;
  bool is_previous_hex = false;
  for (size_t index = 0; index < len; ++index) {
    const CharType cur = begin[index];
    if (is_previous_hex && IsXDigit(cur)) {
      // Previous character is of '\x..' form and this character can be
      // interpreted as another hexadecimal digit in its number. Break string to
      // disambiguate.
      *os << "\" " << kQuoteBegin;
    }
    is_previous_hex = PrintAsStringLiteralTo(cur, os) == kHexEscape;
  }
  *os << "\"";
}

// Prints a (const) char/wchar_t array of 'len' elements, starting at address
// 'begin'.  CharType must be either char or wchar_t.
template 
GTEST_ATTRIBUTE_NO_SANITIZE_MEMORY_
GTEST_ATTRIBUTE_NO_SANITIZE_ADDRESS_
GTEST_ATTRIBUTE_NO_SANITIZE_THREAD_
static void UniversalPrintCharArray(
    const CharType* begin, size_t len, ostream* os) {
  // The code
  //   const char kFoo[] = "foo";
  // generates an array of 4, not 3, elements, with the last one being '\0'.
  //
  // Therefore when printing a char array, we don't print the last element if
  // it's '\0', such that the output matches the string literal as it's
  // written in the source code.
  if (len > 0 && begin[len - 1] == '\0') {
    PrintCharsAsStringTo(begin, len - 1, os);
    return;
  }

  // If, however, the last element in the array is not '\0', e.g.
  //    const char kFoo[] = { 'f', 'o', 'o' };
  // we must print the entire array.  We also print a message to indicate
  // that the array is not NUL-terminated.
  PrintCharsAsStringTo(begin, len, os);
  *os << " (no terminating NUL)";
}

// Prints a (const) char array of 'len' elements, starting at address 'begin'.
void UniversalPrintArray(const char* begin, size_t len, ostream* os) {
  UniversalPrintCharArray(begin, len, os);
}

// Prints a (const) wchar_t array of 'len' elements, starting at address
// 'begin'.
void UniversalPrintArray(const wchar_t* begin, size_t len, ostream* os) {
  UniversalPrintCharArray(begin, len, os);
}

// Prints the given C string to the ostream.
void PrintTo(const char* s, ostream* os) {
  if (s == NULL) {
    *os << "NULL";
  } else {
    *os << ImplicitCast_(s) << " pointing to ";
    PrintCharsAsStringTo(s, strlen(s), os);
  }
}

// MSVC compiler can be configured to define whar_t as a typedef
// of unsigned short. Defining an overload for const wchar_t* in that case
// would cause pointers to unsigned shorts be printed as wide strings,
// possibly accessing more memory than intended and causing invalid
// memory accesses. MSVC defines _NATIVE_WCHAR_T_DEFINED symbol when
// wchar_t is implemented as a native type.
#if !defined(_MSC_VER) || defined(_NATIVE_WCHAR_T_DEFINED)
// Prints the given wide C string to the ostream.
void PrintTo(const wchar_t* s, ostream* os) {
  if (s == NULL) {
    *os << "NULL";
  } else {
    *os << ImplicitCast_(s) << " pointing to ";
    PrintCharsAsStringTo(s, std::wcslen(s), os);
  }
}
#endif  // wchar_t is native

// Prints a ::string object.
#if GTEST_HAS_GLOBAL_STRING
void PrintStringTo(const ::string& s, ostream* os) {
  PrintCharsAsStringTo(s.data(), s.size(), os);
}
#endif  // GTEST_HAS_GLOBAL_STRING

void PrintStringTo(const ::std::string& s, ostream* os) {
  PrintCharsAsStringTo(s.data(), s.size(), os);
}

// Prints a ::wstring object.
#if GTEST_HAS_GLOBAL_WSTRING
void PrintWideStringTo(const ::wstring& s, ostream* os) {
  PrintCharsAsStringTo(s.data(), s.size(), os);
}
#endif  // GTEST_HAS_GLOBAL_WSTRING

#if GTEST_HAS_STD_WSTRING
void PrintWideStringTo(const ::std::wstring& s, ostream* os) {
  PrintCharsAsStringTo(s.data(), s.size(), os);
}
#endif  // GTEST_HAS_STD_WSTRING

}  // namespace internal

}  // namespace testing
node-v4.8.2/deps/gtest/src/gtest-test-part.cc000644 000766 000024 00000010103 13070706730 021174 0ustar00iojsstaff000000 000000 // Copyright 2008, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Author: mheule@google.com (Markus Heule)
//
// The Google C++ Testing Framework (Google Test)

#include "gtest/gtest-test-part.h"

// Indicates that this translation unit is part of Google Test's
// implementation.  It must come before gtest-internal-inl.h is
// included, or there will be a compiler error.  This trick exists to
// prevent the accidental inclusion of gtest-internal-inl.h in the
// user's code.
#define GTEST_IMPLEMENTATION_ 1
#include "src/gtest-internal-inl.h"
#undef GTEST_IMPLEMENTATION_

namespace testing {

using internal::GetUnitTestImpl;

// Gets the summary of the failure message by omitting the stack trace
// in it.
std::string TestPartResult::ExtractSummary(const char* message) {
  const char* const stack_trace = strstr(message, internal::kStackTraceMarker);
  return stack_trace == NULL ? message :
      std::string(message, stack_trace);
}

// Prints a TestPartResult object.
std::ostream& operator<<(std::ostream& os, const TestPartResult& result) {
  return os
      << result.file_name() << ":" << result.line_number() << ": "
      << (result.type() == TestPartResult::kSuccess ? "Success" :
          result.type() == TestPartResult::kFatalFailure ? "Fatal failure" :
          "Non-fatal failure") << ":\n"
      << result.message() << std::endl;
}

// Appends a TestPartResult to the array.
void TestPartResultArray::Append(const TestPartResult& result) {
  array_.push_back(result);
}

// Returns the TestPartResult at the given index (0-based).
const TestPartResult& TestPartResultArray::GetTestPartResult(int index) const {
  if (index < 0 || index >= size()) {
    printf("\nInvalid index (%d) into TestPartResultArray.\n", index);
    internal::posix::Abort();
  }

  return array_[index];
}

// Returns the number of TestPartResult objects in the array.
int TestPartResultArray::size() const {
  return static_cast(array_.size());
}

namespace internal {

HasNewFatalFailureHelper::HasNewFatalFailureHelper()
    : has_new_fatal_failure_(false),
      original_reporter_(GetUnitTestImpl()->
                         GetTestPartResultReporterForCurrentThread()) {
  GetUnitTestImpl()->SetTestPartResultReporterForCurrentThread(this);
}

HasNewFatalFailureHelper::~HasNewFatalFailureHelper() {
  GetUnitTestImpl()->SetTestPartResultReporterForCurrentThread(
      original_reporter_);
}

void HasNewFatalFailureHelper::ReportTestPartResult(
    const TestPartResult& result) {
  if (result.fatally_failed())
    has_new_fatal_failure_ = true;
  original_reporter_->ReportTestPartResult(result);
}

}  // namespace internal

}  // namespace testing
node-v4.8.2/deps/gtest/src/gtest-typed-test.cc000644 000766 000024 00000007554 13070706730 021373 0ustar00iojsstaff000000 000000 // Copyright 2008 Google Inc.
// All Rights Reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Author: wan@google.com (Zhanyong Wan)

#include "gtest/gtest-typed-test.h"
#include "gtest/gtest.h"

namespace testing {
namespace internal {

#if GTEST_HAS_TYPED_TEST_P

// Skips to the first non-space char in str. Returns an empty string if str
// contains only whitespace characters.
static const char* SkipSpaces(const char* str) {
  while (IsSpace(*str))
    str++;
  return str;
}

static std::vector SplitIntoTestNames(const char* src) {
  std::vector name_vec;
  src = SkipSpaces(src);
  for (; src != NULL; src = SkipComma(src)) {
    name_vec.push_back(StripTrailingSpaces(GetPrefixUntilComma(src)));
  }
  return name_vec;
}

// Verifies that registered_tests match the test names in
// defined_test_names_; returns registered_tests if successful, or
// aborts the program otherwise.
const char* TypedTestCasePState::VerifyRegisteredTestNames(
    const char* file, int line, const char* registered_tests) {
  typedef ::std::set::const_iterator DefinedTestIter;
  registered_ = true;

  std::vector name_vec = SplitIntoTestNames(registered_tests);

  Message errors;

  std::set tests;
  for (std::vector::const_iterator name_it = name_vec.begin();
       name_it != name_vec.end(); ++name_it) {
    const std::string& name = *name_it;
    if (tests.count(name) != 0) {
      errors << "Test " << name << " is listed more than once.\n";
      continue;
    }

    bool found = false;
    for (DefinedTestIter it = defined_test_names_.begin();
         it != defined_test_names_.end();
         ++it) {
      if (name == *it) {
        found = true;
        break;
      }
    }

    if (found) {
      tests.insert(name);
    } else {
      errors << "No test named " << name
             << " can be found in this test case.\n";
    }
  }

  for (DefinedTestIter it = defined_test_names_.begin();
       it != defined_test_names_.end();
       ++it) {
    if (tests.count(*it) == 0) {
      errors << "You forgot to list test " << *it << ".\n";
    }
  }

  const std::string& errors_str = errors.GetString();
  if (errors_str != "") {
    fprintf(stderr, "%s %s", FormatFileLocation(file, line).c_str(),
            errors_str.c_str());
    fflush(stderr);
    posix::Abort();
  }

  return registered_tests;
}

#endif  // GTEST_HAS_TYPED_TEST_P

}  // namespace internal
}  // namespace testing
node-v4.8.2/deps/gtest/src/gtest.cc000644 000766 000024 00000601227 13070706730 017270 0ustar00iojsstaff000000 000000 // Copyright 2005, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Author: wan@google.com (Zhanyong Wan)
//
// The Google C++ Testing Framework (Google Test)

#include "gtest/gtest.h"
#include "gtest/gtest-spi.h"

#include 
#include 
#include 
#include 
#include 
#include 
#include 
#include 

#include 
#include 
#include 
#include 
#include 
#include   // NOLINT
#include 
#include 

#if GTEST_OS_LINUX

// TODO(kenton@google.com): Use autoconf to detect availability of
// gettimeofday().
# define GTEST_HAS_GETTIMEOFDAY_ 1

# include   // NOLINT
# include   // NOLINT
# include   // NOLINT
// Declares vsnprintf().  This header is not available on Windows.
# include   // NOLINT
# include   // NOLINT
# include   // NOLINT
# include   // NOLINT
# include 

#elif GTEST_OS_SYMBIAN
# define GTEST_HAS_GETTIMEOFDAY_ 1
# include   // NOLINT

#elif GTEST_OS_ZOS
# define GTEST_HAS_GETTIMEOFDAY_ 1
# include   // NOLINT

// On z/OS we additionally need strings.h for strcasecmp.
# include   // NOLINT

#elif GTEST_OS_WINDOWS_MOBILE  // We are on Windows CE.

# include   // NOLINT
# undef min

#elif GTEST_OS_WINDOWS  // We are on Windows proper.

# include   // NOLINT
# include   // NOLINT
# include   // NOLINT
# include   // NOLINT

# if GTEST_OS_WINDOWS_MINGW
// MinGW has gettimeofday() but not _ftime64().
// TODO(kenton@google.com): Use autoconf to detect availability of
//   gettimeofday().
// TODO(kenton@google.com): There are other ways to get the time on
//   Windows, like GetTickCount() or GetSystemTimeAsFileTime().  MinGW
//   supports these.  consider using them instead.
#  define GTEST_HAS_GETTIMEOFDAY_ 1
#  include   // NOLINT
# endif  // GTEST_OS_WINDOWS_MINGW

// cpplint thinks that the header is already included, so we want to
// silence it.
# include   // NOLINT
# undef min

#else

// Assume other platforms have gettimeofday().
// TODO(kenton@google.com): Use autoconf to detect availability of
//   gettimeofday().
# define GTEST_HAS_GETTIMEOFDAY_ 1

// cpplint thinks that the header is already included, so we want to
// silence it.
# include   // NOLINT
# include   // NOLINT

#endif  // GTEST_OS_LINUX

#if GTEST_HAS_EXCEPTIONS
# include 
#endif

#if GTEST_CAN_STREAM_RESULTS_
# include   // NOLINT
# include   // NOLINT
# include   // NOLINT
# include   // NOLINT
#endif

// Indicates that this translation unit is part of Google Test's
// implementation.  It must come before gtest-internal-inl.h is
// included, or there will be a compiler error.  This trick is to
// prevent a user from accidentally including gtest-internal-inl.h in
// his code.
#define GTEST_IMPLEMENTATION_ 1
#include "src/gtest-internal-inl.h"
#undef GTEST_IMPLEMENTATION_

#if GTEST_OS_WINDOWS
# define vsnprintf _vsnprintf
#endif  // GTEST_OS_WINDOWS

namespace testing {

using internal::CountIf;
using internal::ForEach;
using internal::GetElementOr;
using internal::Shuffle;

// Constants.

// A test whose test case name or test name matches this filter is
// disabled and not run.
static const char kDisableTestFilter[] = "DISABLED_*:*/DISABLED_*";

// A test case whose name matches this filter is considered a death
// test case and will be run before test cases whose name doesn't
// match this filter.
static const char kDeathTestCaseFilter[] = "*DeathTest:*DeathTest/*";

// A test filter that matches everything.
static const char kUniversalFilter[] = "*";

// The default output file for XML output.
static const char kDefaultOutputFile[] = "test_detail.xml";

// The environment variable name for the test shard index.
static const char kTestShardIndex[] = "GTEST_SHARD_INDEX";
// The environment variable name for the total number of test shards.
static const char kTestTotalShards[] = "GTEST_TOTAL_SHARDS";
// The environment variable name for the test shard status file.
static const char kTestShardStatusFile[] = "GTEST_SHARD_STATUS_FILE";

namespace internal {

// The text used in failure messages to indicate the start of the
// stack trace.
const char kStackTraceMarker[] = "\nStack trace:\n";

// g_help_flag is true iff the --help flag or an equivalent form is
// specified on the command line.
bool g_help_flag = false;

}  // namespace internal

static const char* GetDefaultFilter() {
  return kUniversalFilter;
}

GTEST_DEFINE_bool_(
    also_run_disabled_tests,
    internal::BoolFromGTestEnv("also_run_disabled_tests", false),
    "Run disabled tests too, in addition to the tests normally being run.");

GTEST_DEFINE_bool_(
    break_on_failure,
    internal::BoolFromGTestEnv("break_on_failure", false),
    "True iff a failed assertion should be a debugger break-point.");

GTEST_DEFINE_bool_(
    catch_exceptions,
    internal::BoolFromGTestEnv("catch_exceptions", true),
    "True iff " GTEST_NAME_
    " should catch exceptions and treat them as test failures.");

GTEST_DEFINE_string_(
    color,
    internal::StringFromGTestEnv("color", "auto"),
    "Whether to use colors in the output.  Valid values: yes, no, "
    "and auto.  'auto' means to use colors if the output is "
    "being sent to a terminal and the TERM environment variable "
    "is set to a terminal type that supports colors.");

GTEST_DEFINE_string_(
    filter,
    internal::StringFromGTestEnv("filter", GetDefaultFilter()),
    "A colon-separated list of glob (not regex) patterns "
    "for filtering the tests to run, optionally followed by a "
    "'-' and a : separated list of negative patterns (tests to "
    "exclude).  A test is run if it matches one of the positive "
    "patterns and does not match any of the negative patterns.");

GTEST_DEFINE_bool_(list_tests, false,
                   "List all tests without running them.");

GTEST_DEFINE_string_(
    output,
    internal::StringFromGTestEnv("output", ""),
    "A format (currently must be \"xml\"), optionally followed "
    "by a colon and an output file name or directory. A directory "
    "is indicated by a trailing pathname separator. "
    "Examples: \"xml:filename.xml\", \"xml::directoryname/\". "
    "If a directory is specified, output files will be created "
    "within that directory, with file-names based on the test "
    "executable's name and, if necessary, made unique by adding "
    "digits.");

GTEST_DEFINE_bool_(
    print_time,
    internal::BoolFromGTestEnv("print_time", true),
    "True iff " GTEST_NAME_
    " should display elapsed time in text output.");

GTEST_DEFINE_int32_(
    random_seed,
    internal::Int32FromGTestEnv("random_seed", 0),
    "Random number seed to use when shuffling test orders.  Must be in range "
    "[1, 99999], or 0 to use a seed based on the current time.");

GTEST_DEFINE_int32_(
    repeat,
    internal::Int32FromGTestEnv("repeat", 1),
    "How many times to repeat each test.  Specify a negative number "
    "for repeating forever.  Useful for shaking out flaky tests.");

GTEST_DEFINE_bool_(
    show_internal_stack_frames, false,
    "True iff " GTEST_NAME_ " should include internal stack frames when "
    "printing test failure stack traces.");

GTEST_DEFINE_bool_(
    shuffle,
    internal::BoolFromGTestEnv("shuffle", false),
    "True iff " GTEST_NAME_
    " should randomize tests' order on every run.");

GTEST_DEFINE_int32_(
    stack_trace_depth,
    internal::Int32FromGTestEnv("stack_trace_depth", kMaxStackTraceDepth),
    "The maximum number of stack frames to print when an "
    "assertion fails.  The valid range is 0 through 100, inclusive.");

GTEST_DEFINE_string_(
    stream_result_to,
    internal::StringFromGTestEnv("stream_result_to", ""),
    "This flag specifies the host name and the port number on which to stream "
    "test results. Example: \"localhost:555\". The flag is effective only on "
    "Linux.");

GTEST_DEFINE_bool_(
    throw_on_failure,
    internal::BoolFromGTestEnv("throw_on_failure", false),
    "When this flag is specified, a failed assertion will throw an exception "
    "if exceptions are enabled or exit the program with a non-zero code "
    "otherwise.");

namespace internal {

// Generates a random number from [0, range), using a Linear
// Congruential Generator (LCG).  Crashes if 'range' is 0 or greater
// than kMaxRange.
UInt32 Random::Generate(UInt32 range) {
  // These constants are the same as are used in glibc's rand(3).
  state_ = (1103515245U*state_ + 12345U) % kMaxRange;

  GTEST_CHECK_(range > 0)
      << "Cannot generate a number in the range [0, 0).";
  GTEST_CHECK_(range <= kMaxRange)
      << "Generation of a number in [0, " << range << ") was requested, "
      << "but this can only generate numbers in [0, " << kMaxRange << ").";

  // Converting via modulus introduces a bit of downward bias, but
  // it's simple, and a linear congruential generator isn't too good
  // to begin with.
  return state_ % range;
}

// GTestIsInitialized() returns true iff the user has initialized
// Google Test.  Useful for catching the user mistake of not initializing
// Google Test before calling RUN_ALL_TESTS().
//
// A user must call testing::InitGoogleTest() to initialize Google
// Test.  g_init_gtest_count is set to the number of times
// InitGoogleTest() has been called.  We don't protect this variable
// under a mutex as it is only accessed in the main thread.
GTEST_API_ int g_init_gtest_count = 0;
static bool GTestIsInitialized() { return g_init_gtest_count != 0; }

// Iterates over a vector of TestCases, keeping a running sum of the
// results of calling a given int-returning method on each.
// Returns the sum.
static int SumOverTestCaseList(const std::vector& case_list,
                               int (TestCase::*method)() const) {
  int sum = 0;
  for (size_t i = 0; i < case_list.size(); i++) {
    sum += (case_list[i]->*method)();
  }
  return sum;
}

// Returns true iff the test case passed.
static bool TestCasePassed(const TestCase* test_case) {
  return test_case->should_run() && test_case->Passed();
}

// Returns true iff the test case failed.
static bool TestCaseFailed(const TestCase* test_case) {
  return test_case->should_run() && test_case->Failed();
}

// Returns true iff test_case contains at least one test that should
// run.
static bool ShouldRunTestCase(const TestCase* test_case) {
  return test_case->should_run();
}

// AssertHelper constructor.
AssertHelper::AssertHelper(TestPartResult::Type type,
                           const char* file,
                           int line,
                           const char* message)
    : data_(new AssertHelperData(type, file, line, message)) {
}

AssertHelper::~AssertHelper() {
  delete data_;
}

// Message assignment, for assertion streaming support.
void AssertHelper::operator=(const Message& message) const {
  UnitTest::GetInstance()->
    AddTestPartResult(data_->type, data_->file, data_->line,
                      AppendUserMessage(data_->message, message),
                      UnitTest::GetInstance()->impl()
                      ->CurrentOsStackTraceExceptTop(1)
                      // Skips the stack frame for this function itself.
                      );  // NOLINT
}

// Mutex for linked pointers.
GTEST_API_ GTEST_DEFINE_STATIC_MUTEX_(g_linked_ptr_mutex);

// Application pathname gotten in InitGoogleTest.
std::string g_executable_path;

// Returns the current application's name, removing directory path if that
// is present.
FilePath GetCurrentExecutableName() {
  FilePath result;

#if GTEST_OS_WINDOWS
  result.Set(FilePath(g_executable_path).RemoveExtension("exe"));
#else
  result.Set(FilePath(g_executable_path));
#endif  // GTEST_OS_WINDOWS

  return result.RemoveDirectoryName();
}

// Functions for processing the gtest_output flag.

// Returns the output format, or "" for normal printed output.
std::string UnitTestOptions::GetOutputFormat() {
  const char* const gtest_output_flag = GTEST_FLAG(output).c_str();
  if (gtest_output_flag == NULL) return std::string("");

  const char* const colon = strchr(gtest_output_flag, ':');
  return (colon == NULL) ?
      std::string(gtest_output_flag) :
      std::string(gtest_output_flag, colon - gtest_output_flag);
}

// Returns the name of the requested output file, or the default if none
// was explicitly specified.
std::string UnitTestOptions::GetAbsolutePathToOutputFile() {
  const char* const gtest_output_flag = GTEST_FLAG(output).c_str();
  if (gtest_output_flag == NULL)
    return "";

  const char* const colon = strchr(gtest_output_flag, ':');
  if (colon == NULL)
    return internal::FilePath::ConcatPaths(
        internal::FilePath(
            UnitTest::GetInstance()->original_working_dir()),
        internal::FilePath(kDefaultOutputFile)).string();

  internal::FilePath output_name(colon + 1);
  if (!output_name.IsAbsolutePath())
    // TODO(wan@google.com): on Windows \some\path is not an absolute
    // path (as its meaning depends on the current drive), yet the
    // following logic for turning it into an absolute path is wrong.
    // Fix it.
    output_name = internal::FilePath::ConcatPaths(
        internal::FilePath(UnitTest::GetInstance()->original_working_dir()),
        internal::FilePath(colon + 1));

  if (!output_name.IsDirectory())
    return output_name.string();

  internal::FilePath result(internal::FilePath::GenerateUniqueFileName(
      output_name, internal::GetCurrentExecutableName(),
      GetOutputFormat().c_str()));
  return result.string();
}

// Returns true iff the wildcard pattern matches the string.  The
// first ':' or '\0' character in pattern marks the end of it.
//
// This recursive algorithm isn't very efficient, but is clear and
// works well enough for matching test names, which are short.
bool UnitTestOptions::PatternMatchesString(const char *pattern,
                                           const char *str) {
  switch (*pattern) {
    case '\0':
    case ':':  // Either ':' or '\0' marks the end of the pattern.
      return *str == '\0';
    case '?':  // Matches any single character.
      return *str != '\0' && PatternMatchesString(pattern + 1, str + 1);
    case '*':  // Matches any string (possibly empty) of characters.
      return (*str != '\0' && PatternMatchesString(pattern, str + 1)) ||
          PatternMatchesString(pattern + 1, str);
    default:  // Non-special character.  Matches itself.
      return *pattern == *str &&
          PatternMatchesString(pattern + 1, str + 1);
  }
}

bool UnitTestOptions::MatchesFilter(
    const std::string& name, const char* filter) {
  const char *cur_pattern = filter;
  for (;;) {
    if (PatternMatchesString(cur_pattern, name.c_str())) {
      return true;
    }

    // Finds the next pattern in the filter.
    cur_pattern = strchr(cur_pattern, ':');

    // Returns if no more pattern can be found.
    if (cur_pattern == NULL) {
      return false;
    }

    // Skips the pattern separater (the ':' character).
    cur_pattern++;
  }
}

// Returns true iff the user-specified filter matches the test case
// name and the test name.
bool UnitTestOptions::FilterMatchesTest(const std::string &test_case_name,
                                        const std::string &test_name) {
  const std::string& full_name = test_case_name + "." + test_name.c_str();

  // Split --gtest_filter at '-', if there is one, to separate into
  // positive filter and negative filter portions
  const char* const p = GTEST_FLAG(filter).c_str();
  const char* const dash = strchr(p, '-');
  std::string positive;
  std::string negative;
  if (dash == NULL) {
    positive = GTEST_FLAG(filter).c_str();  // Whole string is a positive filter
    negative = "";
  } else {
    positive = std::string(p, dash);   // Everything up to the dash
    negative = std::string(dash + 1);  // Everything after the dash
    if (positive.empty()) {
      // Treat '-test1' as the same as '*-test1'
      positive = kUniversalFilter;
    }
  }

  // A filter is a colon-separated list of patterns.  It matches a
  // test if any pattern in it matches the test.
  return (MatchesFilter(full_name, positive.c_str()) &&
          !MatchesFilter(full_name, negative.c_str()));
}

#if GTEST_HAS_SEH
// Returns EXCEPTION_EXECUTE_HANDLER if Google Test should handle the
// given SEH exception, or EXCEPTION_CONTINUE_SEARCH otherwise.
// This function is useful as an __except condition.
int UnitTestOptions::GTestShouldProcessSEH(DWORD exception_code) {
  // Google Test should handle a SEH exception if:
  //   1. the user wants it to, AND
  //   2. this is not a breakpoint exception, AND
  //   3. this is not a C++ exception (VC++ implements them via SEH,
  //      apparently).
  //
  // SEH exception code for C++ exceptions.
  // (see http://support.microsoft.com/kb/185294 for more information).
  const DWORD kCxxExceptionCode = 0xe06d7363;

  bool should_handle = true;

  if (!GTEST_FLAG(catch_exceptions))
    should_handle = false;
  else if (exception_code == EXCEPTION_BREAKPOINT)
    should_handle = false;
  else if (exception_code == kCxxExceptionCode)
    should_handle = false;

  return should_handle ? EXCEPTION_EXECUTE_HANDLER : EXCEPTION_CONTINUE_SEARCH;
}
#endif  // GTEST_HAS_SEH

}  // namespace internal

// The c'tor sets this object as the test part result reporter used by
// Google Test.  The 'result' parameter specifies where to report the
// results. Intercepts only failures from the current thread.
ScopedFakeTestPartResultReporter::ScopedFakeTestPartResultReporter(
    TestPartResultArray* result)
    : intercept_mode_(INTERCEPT_ONLY_CURRENT_THREAD),
      result_(result) {
  Init();
}

// The c'tor sets this object as the test part result reporter used by
// Google Test.  The 'result' parameter specifies where to report the
// results.
ScopedFakeTestPartResultReporter::ScopedFakeTestPartResultReporter(
    InterceptMode intercept_mode, TestPartResultArray* result)
    : intercept_mode_(intercept_mode),
      result_(result) {
  Init();
}

void ScopedFakeTestPartResultReporter::Init() {
  internal::UnitTestImpl* const impl = internal::GetUnitTestImpl();
  if (intercept_mode_ == INTERCEPT_ALL_THREADS) {
    old_reporter_ = impl->GetGlobalTestPartResultReporter();
    impl->SetGlobalTestPartResultReporter(this);
  } else {
    old_reporter_ = impl->GetTestPartResultReporterForCurrentThread();
    impl->SetTestPartResultReporterForCurrentThread(this);
  }
}

// The d'tor restores the test part result reporter used by Google Test
// before.
ScopedFakeTestPartResultReporter::~ScopedFakeTestPartResultReporter() {
  internal::UnitTestImpl* const impl = internal::GetUnitTestImpl();
  if (intercept_mode_ == INTERCEPT_ALL_THREADS) {
    impl->SetGlobalTestPartResultReporter(old_reporter_);
  } else {
    impl->SetTestPartResultReporterForCurrentThread(old_reporter_);
  }
}

// Increments the test part result count and remembers the result.
// This method is from the TestPartResultReporterInterface interface.
void ScopedFakeTestPartResultReporter::ReportTestPartResult(
    const TestPartResult& result) {
  result_->Append(result);
}

namespace internal {

// Returns the type ID of ::testing::Test.  We should always call this
// instead of GetTypeId< ::testing::Test>() to get the type ID of
// testing::Test.  This is to work around a suspected linker bug when
// using Google Test as a framework on Mac OS X.  The bug causes
// GetTypeId< ::testing::Test>() to return different values depending
// on whether the call is from the Google Test framework itself or
// from user test code.  GetTestTypeId() is guaranteed to always
// return the same value, as it always calls GetTypeId<>() from the
// gtest.cc, which is within the Google Test framework.
TypeId GetTestTypeId() {
  return GetTypeId();
}

// The value of GetTestTypeId() as seen from within the Google Test
// library.  This is solely for testing GetTestTypeId().
extern const TypeId kTestTypeIdInGoogleTest = GetTestTypeId();

// This predicate-formatter checks that 'results' contains a test part
// failure of the given type and that the failure message contains the
// given substring.
AssertionResult HasOneFailure(const char* /* results_expr */,
                              const char* /* type_expr */,
                              const char* /* substr_expr */,
                              const TestPartResultArray& results,
                              TestPartResult::Type type,
                              const string& substr) {
  const std::string expected(type == TestPartResult::kFatalFailure ?
                        "1 fatal failure" :
                        "1 non-fatal failure");
  Message msg;
  if (results.size() != 1) {
    msg << "Expected: " << expected << "\n"
        << "  Actual: " << results.size() << " failures";
    for (int i = 0; i < results.size(); i++) {
      msg << "\n" << results.GetTestPartResult(i);
    }
    return AssertionFailure() << msg;
  }

  const TestPartResult& r = results.GetTestPartResult(0);
  if (r.type() != type) {
    return AssertionFailure() << "Expected: " << expected << "\n"
                              << "  Actual:\n"
                              << r;
  }

  if (strstr(r.message(), substr.c_str()) == NULL) {
    return AssertionFailure() << "Expected: " << expected << " containing \""
                              << substr << "\"\n"
                              << "  Actual:\n"
                              << r;
  }

  return AssertionSuccess();
}

// The constructor of SingleFailureChecker remembers where to look up
// test part results, what type of failure we expect, and what
// substring the failure message should contain.
SingleFailureChecker:: SingleFailureChecker(
    const TestPartResultArray* results,
    TestPartResult::Type type,
    const string& substr)
    : results_(results),
      type_(type),
      substr_(substr) {}

// The destructor of SingleFailureChecker verifies that the given
// TestPartResultArray contains exactly one failure that has the given
// type and contains the given substring.  If that's not the case, a
// non-fatal failure will be generated.
SingleFailureChecker::~SingleFailureChecker() {
  EXPECT_PRED_FORMAT3(HasOneFailure, *results_, type_, substr_);
}

DefaultGlobalTestPartResultReporter::DefaultGlobalTestPartResultReporter(
    UnitTestImpl* unit_test) : unit_test_(unit_test) {}

void DefaultGlobalTestPartResultReporter::ReportTestPartResult(
    const TestPartResult& result) {
  unit_test_->current_test_result()->AddTestPartResult(result);
  unit_test_->listeners()->repeater()->OnTestPartResult(result);
}

DefaultPerThreadTestPartResultReporter::DefaultPerThreadTestPartResultReporter(
    UnitTestImpl* unit_test) : unit_test_(unit_test) {}

void DefaultPerThreadTestPartResultReporter::ReportTestPartResult(
    const TestPartResult& result) {
  unit_test_->GetGlobalTestPartResultReporter()->ReportTestPartResult(result);
}

// Returns the global test part result reporter.
TestPartResultReporterInterface*
UnitTestImpl::GetGlobalTestPartResultReporter() {
  internal::MutexLock lock(&global_test_part_result_reporter_mutex_);
  return global_test_part_result_repoter_;
}

// Sets the global test part result reporter.
void UnitTestImpl::SetGlobalTestPartResultReporter(
    TestPartResultReporterInterface* reporter) {
  internal::MutexLock lock(&global_test_part_result_reporter_mutex_);
  global_test_part_result_repoter_ = reporter;
}

// Returns the test part result reporter for the current thread.
TestPartResultReporterInterface*
UnitTestImpl::GetTestPartResultReporterForCurrentThread() {
  return per_thread_test_part_result_reporter_.get();
}

// Sets the test part result reporter for the current thread.
void UnitTestImpl::SetTestPartResultReporterForCurrentThread(
    TestPartResultReporterInterface* reporter) {
  per_thread_test_part_result_reporter_.set(reporter);
}

// Gets the number of successful test cases.
int UnitTestImpl::successful_test_case_count() const {
  return CountIf(test_cases_, TestCasePassed);
}

// Gets the number of failed test cases.
int UnitTestImpl::failed_test_case_count() const {
  return CountIf(test_cases_, TestCaseFailed);
}

// Gets the number of all test cases.
int UnitTestImpl::total_test_case_count() const {
  return static_cast(test_cases_.size());
}

// Gets the number of all test cases that contain at least one test
// that should run.
int UnitTestImpl::test_case_to_run_count() const {
  return CountIf(test_cases_, ShouldRunTestCase);
}

// Gets the number of successful tests.
int UnitTestImpl::successful_test_count() const {
  return SumOverTestCaseList(test_cases_, &TestCase::successful_test_count);
}

// Gets the number of failed tests.
int UnitTestImpl::failed_test_count() const {
  return SumOverTestCaseList(test_cases_, &TestCase::failed_test_count);
}

// Gets the number of disabled tests that will be reported in the XML report.
int UnitTestImpl::reportable_disabled_test_count() const {
  return SumOverTestCaseList(test_cases_,
                             &TestCase::reportable_disabled_test_count);
}

// Gets the number of disabled tests.
int UnitTestImpl::disabled_test_count() const {
  return SumOverTestCaseList(test_cases_, &TestCase::disabled_test_count);
}

// Gets the number of tests to be printed in the XML report.
int UnitTestImpl::reportable_test_count() const {
  return SumOverTestCaseList(test_cases_, &TestCase::reportable_test_count);
}

// Gets the number of all tests.
int UnitTestImpl::total_test_count() const {
  return SumOverTestCaseList(test_cases_, &TestCase::total_test_count);
}

// Gets the number of tests that should run.
int UnitTestImpl::test_to_run_count() const {
  return SumOverTestCaseList(test_cases_, &TestCase::test_to_run_count);
}

// Returns the current OS stack trace as an std::string.
//
// The maximum number of stack frames to be included is specified by
// the gtest_stack_trace_depth flag.  The skip_count parameter
// specifies the number of top frames to be skipped, which doesn't
// count against the number of frames to be included.
//
// For example, if Foo() calls Bar(), which in turn calls
// CurrentOsStackTraceExceptTop(1), Foo() will be included in the
// trace but Bar() and CurrentOsStackTraceExceptTop() won't.
std::string UnitTestImpl::CurrentOsStackTraceExceptTop(int skip_count) {
  (void)skip_count;
  return "";
}

// Returns the current time in milliseconds.
TimeInMillis GetTimeInMillis() {
#if GTEST_OS_WINDOWS_MOBILE || defined(__BORLANDC__)
  // Difference between 1970-01-01 and 1601-01-01 in milliseconds.
  // http://analogous.blogspot.com/2005/04/epoch.html
  const TimeInMillis kJavaEpochToWinFileTimeDelta =
    static_cast(116444736UL) * 100000UL;
  const DWORD kTenthMicrosInMilliSecond = 10000;

  SYSTEMTIME now_systime;
  FILETIME now_filetime;
  ULARGE_INTEGER now_int64;
  // TODO(kenton@google.com): Shouldn't this just use
  //   GetSystemTimeAsFileTime()?
  GetSystemTime(&now_systime);
  if (SystemTimeToFileTime(&now_systime, &now_filetime)) {
    now_int64.LowPart = now_filetime.dwLowDateTime;
    now_int64.HighPart = now_filetime.dwHighDateTime;
    now_int64.QuadPart = (now_int64.QuadPart / kTenthMicrosInMilliSecond) -
      kJavaEpochToWinFileTimeDelta;
    return now_int64.QuadPart;
  }
  return 0;
#elif GTEST_OS_WINDOWS && !GTEST_HAS_GETTIMEOFDAY_
  __timeb64 now;

  // MSVC 8 deprecates _ftime64(), so we want to suppress warning 4996
  // (deprecated function) there.
  // TODO(kenton@google.com): Use GetTickCount()?  Or use
  //   SystemTimeToFileTime()
  GTEST_DISABLE_MSC_WARNINGS_PUSH_(4996)
  _ftime64(&now);
  GTEST_DISABLE_MSC_WARNINGS_POP_()

  return static_cast(now.time) * 1000 + now.millitm;
#elif GTEST_HAS_GETTIMEOFDAY_
  struct timeval now;
  gettimeofday(&now, NULL);
  return static_cast(now.tv_sec) * 1000 + now.tv_usec / 1000;
#else
# error "Don't know how to get the current time on your system."
#endif
}

// Utilities

// class String.

#if GTEST_OS_WINDOWS_MOBILE
// Creates a UTF-16 wide string from the given ANSI string, allocating
// memory using new. The caller is responsible for deleting the return
// value using delete[]. Returns the wide string, or NULL if the
// input is NULL.
LPCWSTR String::AnsiToUtf16(const char* ansi) {
  if (!ansi) return NULL;
  const int length = strlen(ansi);
  const int unicode_length =
      MultiByteToWideChar(CP_ACP, 0, ansi, length,
                          NULL, 0);
  WCHAR* unicode = new WCHAR[unicode_length + 1];
  MultiByteToWideChar(CP_ACP, 0, ansi, length,
                      unicode, unicode_length);
  unicode[unicode_length] = 0;
  return unicode;
}

// Creates an ANSI string from the given wide string, allocating
// memory using new. The caller is responsible for deleting the return
// value using delete[]. Returns the ANSI string, or NULL if the
// input is NULL.
const char* String::Utf16ToAnsi(LPCWSTR utf16_str)  {
  if (!utf16_str) return NULL;
  const int ansi_length =
      WideCharToMultiByte(CP_ACP, 0, utf16_str, -1,
                          NULL, 0, NULL, NULL);
  char* ansi = new char[ansi_length + 1];
  WideCharToMultiByte(CP_ACP, 0, utf16_str, -1,
                      ansi, ansi_length, NULL, NULL);
  ansi[ansi_length] = 0;
  return ansi;
}

#endif  // GTEST_OS_WINDOWS_MOBILE

// Compares two C strings.  Returns true iff they have the same content.
//
// Unlike strcmp(), this function can handle NULL argument(s).  A NULL
// C string is considered different to any non-NULL C string,
// including the empty string.
bool String::CStringEquals(const char * lhs, const char * rhs) {
  if ( lhs == NULL ) return rhs == NULL;

  if ( rhs == NULL ) return false;

  return strcmp(lhs, rhs) == 0;
}

#if GTEST_HAS_STD_WSTRING || GTEST_HAS_GLOBAL_WSTRING

// Converts an array of wide chars to a narrow string using the UTF-8
// encoding, and streams the result to the given Message object.
static void StreamWideCharsToMessage(const wchar_t* wstr, size_t length,
                                     Message* msg) {
  for (size_t i = 0; i != length; ) {  // NOLINT
    if (wstr[i] != L'\0') {
      *msg << WideStringToUtf8(wstr + i, static_cast(length - i));
      while (i != length && wstr[i] != L'\0')
        i++;
    } else {
      *msg << '\0';
      i++;
    }
  }
}

#endif  // GTEST_HAS_STD_WSTRING || GTEST_HAS_GLOBAL_WSTRING

}  // namespace internal

// Constructs an empty Message.
// We allocate the stringstream separately because otherwise each use of
// ASSERT/EXPECT in a procedure adds over 200 bytes to the procedure's
// stack frame leading to huge stack frames in some cases; gcc does not reuse
// the stack space.
Message::Message() : ss_(new ::std::stringstream) {
  // By default, we want there to be enough precision when printing
  // a double to a Message.
  *ss_ << std::setprecision(std::numeric_limits::digits10 + 2);
}

// These two overloads allow streaming a wide C string to a Message
// using the UTF-8 encoding.
Message& Message::operator <<(const wchar_t* wide_c_str) {
  return *this << internal::String::ShowWideCString(wide_c_str);
}
Message& Message::operator <<(wchar_t* wide_c_str) {
  return *this << internal::String::ShowWideCString(wide_c_str);
}

#if GTEST_HAS_STD_WSTRING
// Converts the given wide string to a narrow string using the UTF-8
// encoding, and streams the result to this Message object.
Message& Message::operator <<(const ::std::wstring& wstr) {
  internal::StreamWideCharsToMessage(wstr.c_str(), wstr.length(), this);
  return *this;
}
#endif  // GTEST_HAS_STD_WSTRING

#if GTEST_HAS_GLOBAL_WSTRING
// Converts the given wide string to a narrow string using the UTF-8
// encoding, and streams the result to this Message object.
Message& Message::operator <<(const ::wstring& wstr) {
  internal::StreamWideCharsToMessage(wstr.c_str(), wstr.length(), this);
  return *this;
}
#endif  // GTEST_HAS_GLOBAL_WSTRING

// Gets the text streamed to this object so far as an std::string.
// Each '\0' character in the buffer is replaced with "\\0".
std::string Message::GetString() const {
  return internal::StringStreamToString(ss_.get());
}

// AssertionResult constructors.
// Used in EXPECT_TRUE/FALSE(assertion_result).
AssertionResult::AssertionResult(const AssertionResult& other)
    : success_(other.success_),
      message_(other.message_.get() != NULL ?
               new ::std::string(*other.message_) :
               static_cast< ::std::string*>(NULL)) {
}

// Swaps two AssertionResults.
void AssertionResult::swap(AssertionResult& other) {
  using std::swap;
  swap(success_, other.success_);
  swap(message_, other.message_);
}

// Returns the assertion's negation. Used with EXPECT/ASSERT_FALSE.
AssertionResult AssertionResult::operator!() const {
  AssertionResult negation(!success_);
  if (message_.get() != NULL)
    negation << *message_;
  return negation;
}

// Makes a successful assertion result.
AssertionResult AssertionSuccess() {
  return AssertionResult(true);
}

// Makes a failed assertion result.
AssertionResult AssertionFailure() {
  return AssertionResult(false);
}

// Makes a failed assertion result with the given failure message.
// Deprecated; use AssertionFailure() << message.
AssertionResult AssertionFailure(const Message& message) {
  return AssertionFailure() << message;
}

namespace internal {

namespace edit_distance {
std::vector CalculateOptimalEdits(const std::vector& left,
                                            const std::vector& right) {
  std::vector > costs(
      left.size() + 1, std::vector(right.size() + 1));
  std::vector > best_move(
      left.size() + 1, std::vector(right.size() + 1));

  // Populate for empty right.
  for (size_t l_i = 0; l_i < costs.size(); ++l_i) {
    costs[l_i][0] = static_cast(l_i);
    best_move[l_i][0] = kRemove;
  }
  // Populate for empty left.
  for (size_t r_i = 1; r_i < costs[0].size(); ++r_i) {
    costs[0][r_i] = static_cast(r_i);
    best_move[0][r_i] = kAdd;
  }

  for (size_t l_i = 0; l_i < left.size(); ++l_i) {
    for (size_t r_i = 0; r_i < right.size(); ++r_i) {
      if (left[l_i] == right[r_i]) {
        // Found a match. Consume it.
        costs[l_i + 1][r_i + 1] = costs[l_i][r_i];
        best_move[l_i + 1][r_i + 1] = kMatch;
        continue;
      }

      const double add = costs[l_i + 1][r_i];
      const double remove = costs[l_i][r_i + 1];
      const double replace = costs[l_i][r_i];
      if (add < remove && add < replace) {
        costs[l_i + 1][r_i + 1] = add + 1;
        best_move[l_i + 1][r_i + 1] = kAdd;
      } else if (remove < add && remove < replace) {
        costs[l_i + 1][r_i + 1] = remove + 1;
        best_move[l_i + 1][r_i + 1] = kRemove;
      } else {
        // We make replace a little more expensive than add/remove to lower
        // their priority.
        costs[l_i + 1][r_i + 1] = replace + 1.00001;
        best_move[l_i + 1][r_i + 1] = kReplace;
      }
    }
  }

  // Reconstruct the best path. We do it in reverse order.
  std::vector best_path;
  for (size_t l_i = left.size(), r_i = right.size(); l_i > 0 || r_i > 0;) {
    EditType move = best_move[l_i][r_i];
    best_path.push_back(move);
    l_i -= move != kAdd;
    r_i -= move != kRemove;
  }
  std::reverse(best_path.begin(), best_path.end());
  return best_path;
}

namespace {

// Helper class to convert string into ids with deduplication.
class InternalStrings {
 public:
  size_t GetId(const std::string& str) {
    IdMap::iterator it = ids_.find(str);
    if (it != ids_.end()) return it->second;
    size_t id = ids_.size();
    return ids_[str] = id;
  }

 private:
  typedef std::map IdMap;
  IdMap ids_;
};

}  // namespace

std::vector CalculateOptimalEdits(
    const std::vector& left,
    const std::vector& right) {
  std::vector left_ids, right_ids;
  {
    InternalStrings intern_table;
    for (size_t i = 0; i < left.size(); ++i) {
      left_ids.push_back(intern_table.GetId(left[i]));
    }
    for (size_t i = 0; i < right.size(); ++i) {
      right_ids.push_back(intern_table.GetId(right[i]));
    }
  }
  return CalculateOptimalEdits(left_ids, right_ids);
}

namespace {

// Helper class that holds the state for one hunk and prints it out to the
// stream.
// It reorders adds/removes when possible to group all removes before all
// adds. It also adds the hunk header before printint into the stream.
class Hunk {
 public:
  Hunk(size_t left_start, size_t right_start)
      : left_start_(left_start),
        right_start_(right_start),
        adds_(),
        removes_(),
        common_() {}

  void PushLine(char edit, const char* line) {
    switch (edit) {
      case ' ':
        ++common_;
        FlushEdits();
        hunk_.push_back(std::make_pair(' ', line));
        break;
      case '-':
        ++removes_;
        hunk_removes_.push_back(std::make_pair('-', line));
        break;
      case '+':
        ++adds_;
        hunk_adds_.push_back(std::make_pair('+', line));
        break;
    }
  }

  void PrintTo(std::ostream* os) {
    PrintHeader(os);
    FlushEdits();
    for (std::list >::const_iterator it =
             hunk_.begin();
         it != hunk_.end(); ++it) {
      *os << it->first << it->second << "\n";
    }
  }

  bool has_edits() const { return adds_ || removes_; }

 private:
  void FlushEdits() {
    hunk_.splice(hunk_.end(), hunk_removes_);
    hunk_.splice(hunk_.end(), hunk_adds_);
  }

  // Print a unified diff header for one hunk.
  // The format is
  //   "@@ -, +, @@"
  // where the left/right parts are ommitted if unnecessary.
  void PrintHeader(std::ostream* ss) const {
    *ss << "@@ ";
    if (removes_) {
      *ss << "-" << left_start_ << "," << (removes_ + common_);
    }
    if (removes_ && adds_) {
      *ss << " ";
    }
    if (adds_) {
      *ss << "+" << right_start_ << "," << (adds_ + common_);
    }
    *ss << " @@\n";
  }

  size_t left_start_, right_start_;
  size_t adds_, removes_, common_;
  std::list > hunk_, hunk_adds_, hunk_removes_;
};

}  // namespace

// Create a list of diff hunks in Unified diff format.
// Each hunk has a header generated by PrintHeader above plus a body with
// lines prefixed with ' ' for no change, '-' for deletion and '+' for
// addition.
// 'context' represents the desired unchanged prefix/suffix around the diff.
// If two hunks are close enough that their contexts overlap, then they are
// joined into one hunk.
std::string CreateUnifiedDiff(const std::vector& left,
                              const std::vector& right,
                              size_t context) {
  const std::vector edits = CalculateOptimalEdits(left, right);

  size_t l_i = 0, r_i = 0, edit_i = 0;
  std::stringstream ss;
  while (edit_i < edits.size()) {
    // Find first edit.
    while (edit_i < edits.size() && edits[edit_i] == kMatch) {
      ++l_i;
      ++r_i;
      ++edit_i;
    }

    // Find the first line to include in the hunk.
    const size_t prefix_context = std::min(l_i, context);
    Hunk hunk(l_i - prefix_context + 1, r_i - prefix_context + 1);
    for (size_t i = prefix_context; i > 0; --i) {
      hunk.PushLine(' ', left[l_i - i].c_str());
    }

    // Iterate the edits until we found enough suffix for the hunk or the input
    // is over.
    size_t n_suffix = 0;
    for (; edit_i < edits.size(); ++edit_i) {
      if (n_suffix >= context) {
        // Continue only if the next hunk is very close.
        std::vector::const_iterator it = edits.begin() + edit_i;
        while (it != edits.end() && *it == kMatch) ++it;
        if (it == edits.end() || (it - edits.begin()) - edit_i >= context) {
          // There is no next edit or it is too far away.
          break;
        }
      }

      EditType edit = edits[edit_i];
      // Reset count when a non match is found.
      n_suffix = edit == kMatch ? n_suffix + 1 : 0;

      if (edit == kMatch || edit == kRemove || edit == kReplace) {
        hunk.PushLine(edit == kMatch ? ' ' : '-', left[l_i].c_str());
      }
      if (edit == kAdd || edit == kReplace) {
        hunk.PushLine('+', right[r_i].c_str());
      }

      // Advance indices, depending on edit type.
      l_i += edit != kAdd;
      r_i += edit != kRemove;
    }

    if (!hunk.has_edits()) {
      // We are done. We don't want this hunk.
      break;
    }

    hunk.PrintTo(&ss);
  }
  return ss.str();
}

}  // namespace edit_distance

namespace {

// The string representation of the values received in EqFailure() are already
// escaped. Split them on escaped '\n' boundaries. Leave all other escaped
// characters the same.
std::vector SplitEscapedString(const std::string& str) {
  std::vector lines;
  size_t start = 0, end = str.size();
  if (end > 2 && str[0] == '"' && str[end - 1] == '"') {
    ++start;
    --end;
  }
  bool escaped = false;
  for (size_t i = start; i + 1 < end; ++i) {
    if (escaped) {
      escaped = false;
      if (str[i] == 'n') {
        lines.push_back(str.substr(start, i - start - 1));
        start = i + 1;
      }
    } else {
      escaped = str[i] == '\\';
    }
  }
  lines.push_back(str.substr(start, end - start));
  return lines;
}

}  // namespace

// Constructs and returns the message for an equality assertion
// (e.g. ASSERT_EQ, EXPECT_STREQ, etc) failure.
//
// The first four parameters are the expressions used in the assertion
// and their values, as strings.  For example, for ASSERT_EQ(foo, bar)
// where foo is 5 and bar is 6, we have:
//
//   expected_expression: "foo"
//   actual_expression:   "bar"
//   expected_value:      "5"
//   actual_value:        "6"
//
// The ignoring_case parameter is true iff the assertion is a
// *_STRCASEEQ*.  When it's true, the string " (ignoring case)" will
// be inserted into the message.
AssertionResult EqFailure(const char* expected_expression,
                          const char* actual_expression,
                          const std::string& expected_value,
                          const std::string& actual_value,
                          bool ignoring_case) {
  Message msg;
  msg << "Value of: " << actual_expression;
  if (actual_value != actual_expression) {
    msg << "\n  Actual: " << actual_value;
  }

  msg << "\nExpected: " << expected_expression;
  if (ignoring_case) {
    msg << " (ignoring case)";
  }
  if (expected_value != expected_expression) {
    msg << "\nWhich is: " << expected_value;
  }

  if (!expected_value.empty() && !actual_value.empty()) {
    const std::vector expected_lines =
        SplitEscapedString(expected_value);
    const std::vector actual_lines =
        SplitEscapedString(actual_value);
    if (expected_lines.size() > 1 || actual_lines.size() > 1) {
      msg << "\nWith diff:\n"
          << edit_distance::CreateUnifiedDiff(expected_lines, actual_lines);
    }
  }

  return AssertionFailure() << msg;
}

// Constructs a failure message for Boolean assertions such as EXPECT_TRUE.
std::string GetBoolAssertionFailureMessage(
    const AssertionResult& assertion_result,
    const char* expression_text,
    const char* actual_predicate_value,
    const char* expected_predicate_value) {
  const char* actual_message = assertion_result.message();
  Message msg;
  msg << "Value of: " << expression_text
      << "\n  Actual: " << actual_predicate_value;
  if (actual_message[0] != '\0')
    msg << " (" << actual_message << ")";
  msg << "\nExpected: " << expected_predicate_value;
  return msg.GetString();
}

// Helper function for implementing ASSERT_NEAR.
AssertionResult DoubleNearPredFormat(const char* expr1,
                                     const char* expr2,
                                     const char* abs_error_expr,
                                     double val1,
                                     double val2,
                                     double abs_error) {
  const double diff = fabs(val1 - val2);
  if (diff <= abs_error) return AssertionSuccess();

  // TODO(wan): do not print the value of an expression if it's
  // already a literal.
  return AssertionFailure()
      << "The difference between " << expr1 << " and " << expr2
      << " is " << diff << ", which exceeds " << abs_error_expr << ", where\n"
      << expr1 << " evaluates to " << val1 << ",\n"
      << expr2 << " evaluates to " << val2 << ", and\n"
      << abs_error_expr << " evaluates to " << abs_error << ".";
}


// Helper template for implementing FloatLE() and DoubleLE().
template 
AssertionResult FloatingPointLE(const char* expr1,
                                const char* expr2,
                                RawType val1,
                                RawType val2) {
  // Returns success if val1 is less than val2,
  if (val1 < val2) {
    return AssertionSuccess();
  }

  // or if val1 is almost equal to val2.
  const FloatingPoint lhs(val1), rhs(val2);
  if (lhs.AlmostEquals(rhs)) {
    return AssertionSuccess();
  }

  // Note that the above two checks will both fail if either val1 or
  // val2 is NaN, as the IEEE floating-point standard requires that
  // any predicate involving a NaN must return false.

  ::std::stringstream val1_ss;
  val1_ss << std::setprecision(std::numeric_limits::digits10 + 2)
          << val1;

  ::std::stringstream val2_ss;
  val2_ss << std::setprecision(std::numeric_limits::digits10 + 2)
          << val2;

  return AssertionFailure()
      << "Expected: (" << expr1 << ") <= (" << expr2 << ")\n"
      << "  Actual: " << StringStreamToString(&val1_ss) << " vs "
      << StringStreamToString(&val2_ss);
}

}  // namespace internal

// Asserts that val1 is less than, or almost equal to, val2.  Fails
// otherwise.  In particular, it fails if either val1 or val2 is NaN.
AssertionResult FloatLE(const char* expr1, const char* expr2,
                        float val1, float val2) {
  return internal::FloatingPointLE(expr1, expr2, val1, val2);
}

// Asserts that val1 is less than, or almost equal to, val2.  Fails
// otherwise.  In particular, it fails if either val1 or val2 is NaN.
AssertionResult DoubleLE(const char* expr1, const char* expr2,
                         double val1, double val2) {
  return internal::FloatingPointLE(expr1, expr2, val1, val2);
}

namespace internal {

// The helper function for {ASSERT|EXPECT}_EQ with int or enum
// arguments.
AssertionResult CmpHelperEQ(const char* expected_expression,
                            const char* actual_expression,
                            BiggestInt expected,
                            BiggestInt actual) {
  if (expected == actual) {
    return AssertionSuccess();
  }

  return EqFailure(expected_expression,
                   actual_expression,
                   FormatForComparisonFailureMessage(expected, actual),
                   FormatForComparisonFailureMessage(actual, expected),
                   false);
}

// A macro for implementing the helper functions needed to implement
// ASSERT_?? and EXPECT_?? with integer or enum arguments.  It is here
// just to avoid copy-and-paste of similar code.
#define GTEST_IMPL_CMP_HELPER_(op_name, op)\
AssertionResult CmpHelper##op_name(const char* expr1, const char* expr2, \
                                   BiggestInt val1, BiggestInt val2) {\
  if (val1 op val2) {\
    return AssertionSuccess();\
  } else {\
    return AssertionFailure() \
        << "Expected: (" << expr1 << ") " #op " (" << expr2\
        << "), actual: " << FormatForComparisonFailureMessage(val1, val2)\
        << " vs " << FormatForComparisonFailureMessage(val2, val1);\
  }\
}

// Implements the helper function for {ASSERT|EXPECT}_NE with int or
// enum arguments.
GTEST_IMPL_CMP_HELPER_(NE, !=)
// Implements the helper function for {ASSERT|EXPECT}_LE with int or
// enum arguments.
GTEST_IMPL_CMP_HELPER_(LE, <=)
// Implements the helper function for {ASSERT|EXPECT}_LT with int or
// enum arguments.
GTEST_IMPL_CMP_HELPER_(LT, < )
// Implements the helper function for {ASSERT|EXPECT}_GE with int or
// enum arguments.
GTEST_IMPL_CMP_HELPER_(GE, >=)
// Implements the helper function for {ASSERT|EXPECT}_GT with int or
// enum arguments.
GTEST_IMPL_CMP_HELPER_(GT, > )

#undef GTEST_IMPL_CMP_HELPER_

// The helper function for {ASSERT|EXPECT}_STREQ.
AssertionResult CmpHelperSTREQ(const char* expected_expression,
                               const char* actual_expression,
                               const char* expected,
                               const char* actual) {
  if (String::CStringEquals(expected, actual)) {
    return AssertionSuccess();
  }

  return EqFailure(expected_expression,
                   actual_expression,
                   PrintToString(expected),
                   PrintToString(actual),
                   false);
}

// The helper function for {ASSERT|EXPECT}_STRCASEEQ.
AssertionResult CmpHelperSTRCASEEQ(const char* expected_expression,
                                   const char* actual_expression,
                                   const char* expected,
                                   const char* actual) {
  if (String::CaseInsensitiveCStringEquals(expected, actual)) {
    return AssertionSuccess();
  }

  return EqFailure(expected_expression,
                   actual_expression,
                   PrintToString(expected),
                   PrintToString(actual),
                   true);
}

// The helper function for {ASSERT|EXPECT}_STRNE.
AssertionResult CmpHelperSTRNE(const char* s1_expression,
                               const char* s2_expression,
                               const char* s1,
                               const char* s2) {
  if (!String::CStringEquals(s1, s2)) {
    return AssertionSuccess();
  } else {
    return AssertionFailure() << "Expected: (" << s1_expression << ") != ("
                              << s2_expression << "), actual: \""
                              << s1 << "\" vs \"" << s2 << "\"";
  }
}

// The helper function for {ASSERT|EXPECT}_STRCASENE.
AssertionResult CmpHelperSTRCASENE(const char* s1_expression,
                                   const char* s2_expression,
                                   const char* s1,
                                   const char* s2) {
  if (!String::CaseInsensitiveCStringEquals(s1, s2)) {
    return AssertionSuccess();
  } else {
    return AssertionFailure()
        << "Expected: (" << s1_expression << ") != ("
        << s2_expression << ") (ignoring case), actual: \""
        << s1 << "\" vs \"" << s2 << "\"";
  }
}

}  // namespace internal

namespace {

// Helper functions for implementing IsSubString() and IsNotSubstring().

// This group of overloaded functions return true iff needle is a
// substring of haystack.  NULL is considered a substring of itself
// only.

bool IsSubstringPred(const char* needle, const char* haystack) {
  if (needle == NULL || haystack == NULL)
    return needle == haystack;

  return strstr(haystack, needle) != NULL;
}

bool IsSubstringPred(const wchar_t* needle, const wchar_t* haystack) {
  if (needle == NULL || haystack == NULL)
    return needle == haystack;

  return wcsstr(haystack, needle) != NULL;
}

// StringType here can be either ::std::string or ::std::wstring.
template 
bool IsSubstringPred(const StringType& needle,
                     const StringType& haystack) {
  return haystack.find(needle) != StringType::npos;
}

// This function implements either IsSubstring() or IsNotSubstring(),
// depending on the value of the expected_to_be_substring parameter.
// StringType here can be const char*, const wchar_t*, ::std::string,
// or ::std::wstring.
template 
AssertionResult IsSubstringImpl(
    bool expected_to_be_substring,
    const char* needle_expr, const char* haystack_expr,
    const StringType& needle, const StringType& haystack) {
  if (IsSubstringPred(needle, haystack) == expected_to_be_substring)
    return AssertionSuccess();

  const bool is_wide_string = sizeof(needle[0]) > 1;
  const char* const begin_string_quote = is_wide_string ? "L\"" : "\"";
  return AssertionFailure()
      << "Value of: " << needle_expr << "\n"
      << "  Actual: " << begin_string_quote << needle << "\"\n"
      << "Expected: " << (expected_to_be_substring ? "" : "not ")
      << "a substring of " << haystack_expr << "\n"
      << "Which is: " << begin_string_quote << haystack << "\"";
}

}  // namespace

// IsSubstring() and IsNotSubstring() check whether needle is a
// substring of haystack (NULL is considered a substring of itself
// only), and return an appropriate error message when they fail.

AssertionResult IsSubstring(
    const char* needle_expr, const char* haystack_expr,
    const char* needle, const char* haystack) {
  return IsSubstringImpl(true, needle_expr, haystack_expr, needle, haystack);
}

AssertionResult IsSubstring(
    const char* needle_expr, const char* haystack_expr,
    const wchar_t* needle, const wchar_t* haystack) {
  return IsSubstringImpl(true, needle_expr, haystack_expr, needle, haystack);
}

AssertionResult IsNotSubstring(
    const char* needle_expr, const char* haystack_expr,
    const char* needle, const char* haystack) {
  return IsSubstringImpl(false, needle_expr, haystack_expr, needle, haystack);
}

AssertionResult IsNotSubstring(
    const char* needle_expr, const char* haystack_expr,
    const wchar_t* needle, const wchar_t* haystack) {
  return IsSubstringImpl(false, needle_expr, haystack_expr, needle, haystack);
}

AssertionResult IsSubstring(
    const char* needle_expr, const char* haystack_expr,
    const ::std::string& needle, const ::std::string& haystack) {
  return IsSubstringImpl(true, needle_expr, haystack_expr, needle, haystack);
}

AssertionResult IsNotSubstring(
    const char* needle_expr, const char* haystack_expr,
    const ::std::string& needle, const ::std::string& haystack) {
  return IsSubstringImpl(false, needle_expr, haystack_expr, needle, haystack);
}

#if GTEST_HAS_STD_WSTRING
AssertionResult IsSubstring(
    const char* needle_expr, const char* haystack_expr,
    const ::std::wstring& needle, const ::std::wstring& haystack) {
  return IsSubstringImpl(true, needle_expr, haystack_expr, needle, haystack);
}

AssertionResult IsNotSubstring(
    const char* needle_expr, const char* haystack_expr,
    const ::std::wstring& needle, const ::std::wstring& haystack) {
  return IsSubstringImpl(false, needle_expr, haystack_expr, needle, haystack);
}
#endif  // GTEST_HAS_STD_WSTRING

namespace internal {

#if GTEST_OS_WINDOWS

namespace {

// Helper function for IsHRESULT{SuccessFailure} predicates
AssertionResult HRESULTFailureHelper(const char* expr,
                                     const char* expected,
                                     long hr) {  // NOLINT
# if GTEST_OS_WINDOWS_MOBILE

  // Windows CE doesn't support FormatMessage.
  const char error_text[] = "";

# else

  // Looks up the human-readable system message for the HRESULT code
  // and since we're not passing any params to FormatMessage, we don't
  // want inserts expanded.
  const DWORD kFlags = FORMAT_MESSAGE_FROM_SYSTEM |
                       FORMAT_MESSAGE_IGNORE_INSERTS;
  const DWORD kBufSize = 4096;
  // Gets the system's human readable message string for this HRESULT.
  char error_text[kBufSize] = { '\0' };
  DWORD message_length = ::FormatMessageA(kFlags,
                                          0,  // no source, we're asking system
                                          hr,  // the error
                                          0,  // no line width restrictions
                                          error_text,  // output buffer
                                          kBufSize,  // buf size
                                          NULL);  // no arguments for inserts
  // Trims tailing white space (FormatMessage leaves a trailing CR-LF)
  for (; message_length && IsSpace(error_text[message_length - 1]);
          --message_length) {
    error_text[message_length - 1] = '\0';
  }

# endif  // GTEST_OS_WINDOWS_MOBILE

  const std::string error_hex("0x" + String::FormatHexInt(hr));
  return ::testing::AssertionFailure()
      << "Expected: " << expr << " " << expected << ".\n"
      << "  Actual: " << error_hex << " " << error_text << "\n";
}

}  // namespace

AssertionResult IsHRESULTSuccess(const char* expr, long hr) {  // NOLINT
  if (SUCCEEDED(hr)) {
    return AssertionSuccess();
  }
  return HRESULTFailureHelper(expr, "succeeds", hr);
}

AssertionResult IsHRESULTFailure(const char* expr, long hr) {  // NOLINT
  if (FAILED(hr)) {
    return AssertionSuccess();
  }
  return HRESULTFailureHelper(expr, "fails", hr);
}

#endif  // GTEST_OS_WINDOWS

// Utility functions for encoding Unicode text (wide strings) in
// UTF-8.

// A Unicode code-point can have upto 21 bits, and is encoded in UTF-8
// like this:
//
// Code-point length   Encoding
//   0 -  7 bits       0xxxxxxx
//   8 - 11 bits       110xxxxx 10xxxxxx
//  12 - 16 bits       1110xxxx 10xxxxxx 10xxxxxx
//  17 - 21 bits       11110xxx 10xxxxxx 10xxxxxx 10xxxxxx

// The maximum code-point a one-byte UTF-8 sequence can represent.
const UInt32 kMaxCodePoint1 = (static_cast(1) <<  7) - 1;

// The maximum code-point a two-byte UTF-8 sequence can represent.
const UInt32 kMaxCodePoint2 = (static_cast(1) << (5 + 6)) - 1;

// The maximum code-point a three-byte UTF-8 sequence can represent.
const UInt32 kMaxCodePoint3 = (static_cast(1) << (4 + 2*6)) - 1;

// The maximum code-point a four-byte UTF-8 sequence can represent.
const UInt32 kMaxCodePoint4 = (static_cast(1) << (3 + 3*6)) - 1;

// Chops off the n lowest bits from a bit pattern.  Returns the n
// lowest bits.  As a side effect, the original bit pattern will be
// shifted to the right by n bits.
inline UInt32 ChopLowBits(UInt32* bits, int n) {
  const UInt32 low_bits = *bits & ((static_cast(1) << n) - 1);
  *bits >>= n;
  return low_bits;
}

// Converts a Unicode code point to a narrow string in UTF-8 encoding.
// code_point parameter is of type UInt32 because wchar_t may not be
// wide enough to contain a code point.
// If the code_point is not a valid Unicode code point
// (i.e. outside of Unicode range U+0 to U+10FFFF) it will be converted
// to "(Invalid Unicode 0xXXXXXXXX)".
std::string CodePointToUtf8(UInt32 code_point) {
  if (code_point > kMaxCodePoint4) {
    return "(Invalid Unicode 0x" + String::FormatHexInt(code_point) + ")";
  }

  char str[5];  // Big enough for the largest valid code point.
  if (code_point <= kMaxCodePoint1) {
    str[1] = '\0';
    str[0] = static_cast(code_point);                          // 0xxxxxxx
  } else if (code_point <= kMaxCodePoint2) {
    str[2] = '\0';
    str[1] = static_cast(0x80 | ChopLowBits(&code_point, 6));  // 10xxxxxx
    str[0] = static_cast(0xC0 | code_point);                   // 110xxxxx
  } else if (code_point <= kMaxCodePoint3) {
    str[3] = '\0';
    str[2] = static_cast(0x80 | ChopLowBits(&code_point, 6));  // 10xxxxxx
    str[1] = static_cast(0x80 | ChopLowBits(&code_point, 6));  // 10xxxxxx
    str[0] = static_cast(0xE0 | code_point);                   // 1110xxxx
  } else {  // code_point <= kMaxCodePoint4
    str[4] = '\0';
    str[3] = static_cast(0x80 | ChopLowBits(&code_point, 6));  // 10xxxxxx
    str[2] = static_cast(0x80 | ChopLowBits(&code_point, 6));  // 10xxxxxx
    str[1] = static_cast(0x80 | ChopLowBits(&code_point, 6));  // 10xxxxxx
    str[0] = static_cast(0xF0 | code_point);                   // 11110xxx
  }
  return str;
}

// The following two functions only make sense if the the system
// uses UTF-16 for wide string encoding. All supported systems
// with 16 bit wchar_t (Windows, Cygwin, Symbian OS) do use UTF-16.

// Determines if the arguments constitute UTF-16 surrogate pair
// and thus should be combined into a single Unicode code point
// using CreateCodePointFromUtf16SurrogatePair.
inline bool IsUtf16SurrogatePair(wchar_t first, wchar_t second) {
  return sizeof(wchar_t) == 2 &&
      (first & 0xFC00) == 0xD800 && (second & 0xFC00) == 0xDC00;
}

// Creates a Unicode code point from UTF16 surrogate pair.
inline UInt32 CreateCodePointFromUtf16SurrogatePair(wchar_t first,
                                                    wchar_t second) {
  const UInt32 mask = (1 << 10) - 1;
  return (sizeof(wchar_t) == 2) ?
      (((first & mask) << 10) | (second & mask)) + 0x10000 :
      // This function should not be called when the condition is
      // false, but we provide a sensible default in case it is.
      static_cast(first);
}

// Converts a wide string to a narrow string in UTF-8 encoding.
// The wide string is assumed to have the following encoding:
//   UTF-16 if sizeof(wchar_t) == 2 (on Windows, Cygwin, Symbian OS)
//   UTF-32 if sizeof(wchar_t) == 4 (on Linux)
// Parameter str points to a null-terminated wide string.
// Parameter num_chars may additionally limit the number
// of wchar_t characters processed. -1 is used when the entire string
// should be processed.
// If the string contains code points that are not valid Unicode code points
// (i.e. outside of Unicode range U+0 to U+10FFFF) they will be output
// as '(Invalid Unicode 0xXXXXXXXX)'. If the string is in UTF16 encoding
// and contains invalid UTF-16 surrogate pairs, values in those pairs
// will be encoded as individual Unicode characters from Basic Normal Plane.
std::string WideStringToUtf8(const wchar_t* str, int num_chars) {
  if (num_chars == -1)
    num_chars = static_cast(wcslen(str));

  ::std::stringstream stream;
  for (int i = 0; i < num_chars; ++i) {
    UInt32 unicode_code_point;

    if (str[i] == L'\0') {
      break;
    } else if (i + 1 < num_chars && IsUtf16SurrogatePair(str[i], str[i + 1])) {
      unicode_code_point = CreateCodePointFromUtf16SurrogatePair(str[i],
                                                                 str[i + 1]);
      i++;
    } else {
      unicode_code_point = static_cast(str[i]);
    }

    stream << CodePointToUtf8(unicode_code_point);
  }
  return StringStreamToString(&stream);
}

// Converts a wide C string to an std::string using the UTF-8 encoding.
// NULL will be converted to "(null)".
std::string String::ShowWideCString(const wchar_t * wide_c_str) {
  if (wide_c_str == NULL)  return "(null)";

  return internal::WideStringToUtf8(wide_c_str, -1);
}

// Compares two wide C strings.  Returns true iff they have the same
// content.
//
// Unlike wcscmp(), this function can handle NULL argument(s).  A NULL
// C string is considered different to any non-NULL C string,
// including the empty string.
bool String::WideCStringEquals(const wchar_t * lhs, const wchar_t * rhs) {
  if (lhs == NULL) return rhs == NULL;

  if (rhs == NULL) return false;

  return wcscmp(lhs, rhs) == 0;
}

// Helper function for *_STREQ on wide strings.
AssertionResult CmpHelperSTREQ(const char* expected_expression,
                               const char* actual_expression,
                               const wchar_t* expected,
                               const wchar_t* actual) {
  if (String::WideCStringEquals(expected, actual)) {
    return AssertionSuccess();
  }

  return EqFailure(expected_expression,
                   actual_expression,
                   PrintToString(expected),
                   PrintToString(actual),
                   false);
}

// Helper function for *_STRNE on wide strings.
AssertionResult CmpHelperSTRNE(const char* s1_expression,
                               const char* s2_expression,
                               const wchar_t* s1,
                               const wchar_t* s2) {
  if (!String::WideCStringEquals(s1, s2)) {
    return AssertionSuccess();
  }

  return AssertionFailure() << "Expected: (" << s1_expression << ") != ("
                            << s2_expression << "), actual: "
                            << PrintToString(s1)
                            << " vs " << PrintToString(s2);
}

// Compares two C strings, ignoring case.  Returns true iff they have
// the same content.
//
// Unlike strcasecmp(), this function can handle NULL argument(s).  A
// NULL C string is considered different to any non-NULL C string,
// including the empty string.
bool String::CaseInsensitiveCStringEquals(const char * lhs, const char * rhs) {
  if (lhs == NULL)
    return rhs == NULL;
  if (rhs == NULL)
    return false;
  return posix::StrCaseCmp(lhs, rhs) == 0;
}

  // Compares two wide C strings, ignoring case.  Returns true iff they
  // have the same content.
  //
  // Unlike wcscasecmp(), this function can handle NULL argument(s).
  // A NULL C string is considered different to any non-NULL wide C string,
  // including the empty string.
  // NB: The implementations on different platforms slightly differ.
  // On windows, this method uses _wcsicmp which compares according to LC_CTYPE
  // environment variable. On GNU platform this method uses wcscasecmp
  // which compares according to LC_CTYPE category of the current locale.
  // On MacOS X, it uses towlower, which also uses LC_CTYPE category of the
  // current locale.
bool String::CaseInsensitiveWideCStringEquals(const wchar_t* lhs,
                                              const wchar_t* rhs) {
  if (lhs == NULL) return rhs == NULL;

  if (rhs == NULL) return false;

#if GTEST_OS_WINDOWS
  return _wcsicmp(lhs, rhs) == 0;
#elif GTEST_OS_LINUX && !GTEST_OS_LINUX_ANDROID
  return wcscasecmp(lhs, rhs) == 0;
#else
  // Android, Mac OS X and Cygwin don't define wcscasecmp.
  // Other unknown OSes may not define it either.
  wint_t left, right;
  do {
    left = towlower(*lhs++);
    right = towlower(*rhs++);
  } while (left && left == right);
  return left == right;
#endif  // OS selector
}

// Returns true iff str ends with the given suffix, ignoring case.
// Any string is considered to end with an empty suffix.
bool String::EndsWithCaseInsensitive(
    const std::string& str, const std::string& suffix) {
  const size_t str_len = str.length();
  const size_t suffix_len = suffix.length();
  return (str_len >= suffix_len) &&
         CaseInsensitiveCStringEquals(str.c_str() + str_len - suffix_len,
                                      suffix.c_str());
}

// Formats an int value as "%02d".
std::string String::FormatIntWidth2(int value) {
  std::stringstream ss;
  ss << std::setfill('0') << std::setw(2) << value;
  return ss.str();
}

// Formats an int value as "%X".
std::string String::FormatHexInt(int value) {
  std::stringstream ss;
  ss << std::hex << std::uppercase << value;
  return ss.str();
}

// Formats a byte as "%02X".
std::string String::FormatByte(unsigned char value) {
  std::stringstream ss;
  ss << std::setfill('0') << std::setw(2) << std::hex << std::uppercase
     << static_cast(value);
  return ss.str();
}

// Converts the buffer in a stringstream to an std::string, converting NUL
// bytes to "\\0" along the way.
std::string StringStreamToString(::std::stringstream* ss) {
  const ::std::string& str = ss->str();
  const char* const start = str.c_str();
  const char* const end = start + str.length();

  std::string result;
  result.reserve(2 * (end - start));
  for (const char* ch = start; ch != end; ++ch) {
    if (*ch == '\0') {
      result += "\\0";  // Replaces NUL with "\\0";
    } else {
      result += *ch;
    }
  }

  return result;
}

// Appends the user-supplied message to the Google-Test-generated message.
std::string AppendUserMessage(const std::string& gtest_msg,
                              const Message& user_msg) {
  // Appends the user message if it's non-empty.
  const std::string user_msg_string = user_msg.GetString();
  if (user_msg_string.empty()) {
    return gtest_msg;
  }

  return gtest_msg + "\n" + user_msg_string;
}

}  // namespace internal

// class TestResult

// Creates an empty TestResult.
TestResult::TestResult()
    : death_test_count_(0),
      elapsed_time_(0) {
}

// D'tor.
TestResult::~TestResult() {
}

// Returns the i-th test part result among all the results. i can
// range from 0 to total_part_count() - 1. If i is not in that range,
// aborts the program.
const TestPartResult& TestResult::GetTestPartResult(int i) const {
  if (i < 0 || i >= total_part_count())
    internal::posix::Abort();
  return test_part_results_.at(i);
}

// Returns the i-th test property. i can range from 0 to
// test_property_count() - 1. If i is not in that range, aborts the
// program.
const TestProperty& TestResult::GetTestProperty(int i) const {
  if (i < 0 || i >= test_property_count())
    internal::posix::Abort();
  return test_properties_.at(i);
}

// Clears the test part results.
void TestResult::ClearTestPartResults() {
  test_part_results_.clear();
}

// Adds a test part result to the list.
void TestResult::AddTestPartResult(const TestPartResult& test_part_result) {
  test_part_results_.push_back(test_part_result);
}

// Adds a test property to the list. If a property with the same key as the
// supplied property is already represented, the value of this test_property
// replaces the old value for that key.
void TestResult::RecordProperty(const std::string& xml_element,
                                const TestProperty& test_property) {
  if (!ValidateTestProperty(xml_element, test_property)) {
    return;
  }
  internal::MutexLock lock(&test_properites_mutex_);
  const std::vector::iterator property_with_matching_key =
      std::find_if(test_properties_.begin(), test_properties_.end(),
                   internal::TestPropertyKeyIs(test_property.key()));
  if (property_with_matching_key == test_properties_.end()) {
    test_properties_.push_back(test_property);
    return;
  }
  property_with_matching_key->SetValue(test_property.value());
}

// The list of reserved attributes used in the  element of XML
// output.
static const char* const kReservedTestSuitesAttributes[] = {
  "disabled",
  "errors",
  "failures",
  "name",
  "random_seed",
  "tests",
  "time",
  "timestamp"
};

// The list of reserved attributes used in the  element of XML
// output.
static const char* const kReservedTestSuiteAttributes[] = {
  "disabled",
  "errors",
  "failures",
  "name",
  "tests",
  "time"
};

// The list of reserved attributes used in the  element of XML output.
static const char* const kReservedTestCaseAttributes[] = {
  "classname",
  "name",
  "status",
  "time",
  "type_param",
  "value_param"
};

template 
std::vector ArrayAsVector(const char* const (&array)[kSize]) {
  return std::vector(array, array + kSize);
}

static std::vector GetReservedAttributesForElement(
    const std::string& xml_element) {
  if (xml_element == "testsuites") {
    return ArrayAsVector(kReservedTestSuitesAttributes);
  } else if (xml_element == "testsuite") {
    return ArrayAsVector(kReservedTestSuiteAttributes);
  } else if (xml_element == "testcase") {
    return ArrayAsVector(kReservedTestCaseAttributes);
  } else {
    GTEST_CHECK_(false) << "Unrecognized xml_element provided: " << xml_element;
  }
  // This code is unreachable but some compilers may not realizes that.
  return std::vector();
}

static std::string FormatWordList(const std::vector& words) {
  Message word_list;
  for (size_t i = 0; i < words.size(); ++i) {
    if (i > 0 && words.size() > 2) {
      word_list << ", ";
    }
    if (i == words.size() - 1) {
      word_list << "and ";
    }
    word_list << "'" << words[i] << "'";
  }
  return word_list.GetString();
}

bool ValidateTestPropertyName(const std::string& property_name,
                              const std::vector& reserved_names) {
  if (std::find(reserved_names.begin(), reserved_names.end(), property_name) !=
          reserved_names.end()) {
    ADD_FAILURE() << "Reserved key used in RecordProperty(): " << property_name
                  << " (" << FormatWordList(reserved_names)
                  << " are reserved by " << GTEST_NAME_ << ")";
    return false;
  }
  return true;
}

// Adds a failure if the key is a reserved attribute of the element named
// xml_element.  Returns true if the property is valid.
bool TestResult::ValidateTestProperty(const std::string& xml_element,
                                      const TestProperty& test_property) {
  return ValidateTestPropertyName(test_property.key(),
                                  GetReservedAttributesForElement(xml_element));
}

// Clears the object.
void TestResult::Clear() {
  test_part_results_.clear();
  test_properties_.clear();
  death_test_count_ = 0;
  elapsed_time_ = 0;
}

// Returns true iff the test failed.
bool TestResult::Failed() const {
  for (int i = 0; i < total_part_count(); ++i) {
    if (GetTestPartResult(i).failed())
      return true;
  }
  return false;
}

// Returns true iff the test part fatally failed.
static bool TestPartFatallyFailed(const TestPartResult& result) {
  return result.fatally_failed();
}

// Returns true iff the test fatally failed.
bool TestResult::HasFatalFailure() const {
  return CountIf(test_part_results_, TestPartFatallyFailed) > 0;
}

// Returns true iff the test part non-fatally failed.
static bool TestPartNonfatallyFailed(const TestPartResult& result) {
  return result.nonfatally_failed();
}

// Returns true iff the test has a non-fatal failure.
bool TestResult::HasNonfatalFailure() const {
  return CountIf(test_part_results_, TestPartNonfatallyFailed) > 0;
}

// Gets the number of all test parts.  This is the sum of the number
// of successful test parts and the number of failed test parts.
int TestResult::total_part_count() const {
  return static_cast(test_part_results_.size());
}

// Returns the number of the test properties.
int TestResult::test_property_count() const {
  return static_cast(test_properties_.size());
}

// class Test

// Creates a Test object.

// The c'tor saves the values of all Google Test flags.
Test::Test()
    : gtest_flag_saver_(new internal::GTestFlagSaver) {
}

// The d'tor restores the values of all Google Test flags.
Test::~Test() {
  delete gtest_flag_saver_;
}

// Sets up the test fixture.
//
// A sub-class may override this.
void Test::SetUp() {
}

// Tears down the test fixture.
//
// A sub-class may override this.
void Test::TearDown() {
}

// Allows user supplied key value pairs to be recorded for later output.
void Test::RecordProperty(const std::string& key, const std::string& value) {
  UnitTest::GetInstance()->RecordProperty(key, value);
}

// Allows user supplied key value pairs to be recorded for later output.
void Test::RecordProperty(const std::string& key, int value) {
  Message value_message;
  value_message << value;
  RecordProperty(key, value_message.GetString().c_str());
}

namespace internal {

void ReportFailureInUnknownLocation(TestPartResult::Type result_type,
                                    const std::string& message) {
  // This function is a friend of UnitTest and as such has access to
  // AddTestPartResult.
  UnitTest::GetInstance()->AddTestPartResult(
      result_type,
      NULL,  // No info about the source file where the exception occurred.
      -1,    // We have no info on which line caused the exception.
      message,
      "");   // No stack trace, either.
}

}  // namespace internal

// Google Test requires all tests in the same test case to use the same test
// fixture class.  This function checks if the current test has the
// same fixture class as the first test in the current test case.  If
// yes, it returns true; otherwise it generates a Google Test failure and
// returns false.
bool Test::HasSameFixtureClass() {
  internal::UnitTestImpl* const impl = internal::GetUnitTestImpl();
  const TestCase* const test_case = impl->current_test_case();

  // Info about the first test in the current test case.
  const TestInfo* const first_test_info = test_case->test_info_list()[0];
  const internal::TypeId first_fixture_id = first_test_info->fixture_class_id_;
  const char* const first_test_name = first_test_info->name();

  // Info about the current test.
  const TestInfo* const this_test_info = impl->current_test_info();
  const internal::TypeId this_fixture_id = this_test_info->fixture_class_id_;
  const char* const this_test_name = this_test_info->name();

  if (this_fixture_id != first_fixture_id) {
    // Is the first test defined using TEST?
    const bool first_is_TEST = first_fixture_id == internal::GetTestTypeId();
    // Is this test defined using TEST?
    const bool this_is_TEST = this_fixture_id == internal::GetTestTypeId();

    if (first_is_TEST || this_is_TEST) {
      // Both TEST and TEST_F appear in same test case, which is incorrect.
      // Tell the user how to fix this.

      // Gets the name of the TEST and the name of the TEST_F.  Note
      // that first_is_TEST and this_is_TEST cannot both be true, as
      // the fixture IDs are different for the two tests.
      const char* const TEST_name =
          first_is_TEST ? first_test_name : this_test_name;
      const char* const TEST_F_name =
          first_is_TEST ? this_test_name : first_test_name;

      ADD_FAILURE()
          << "All tests in the same test case must use the same test fixture\n"
          << "class, so mixing TEST_F and TEST in the same test case is\n"
          << "illegal.  In test case " << this_test_info->test_case_name()
          << ",\n"
          << "test " << TEST_F_name << " is defined using TEST_F but\n"
          << "test " << TEST_name << " is defined using TEST.  You probably\n"
          << "want to change the TEST to TEST_F or move it to another test\n"
          << "case.";
    } else {
      // Two fixture classes with the same name appear in two different
      // namespaces, which is not allowed. Tell the user how to fix this.
      ADD_FAILURE()
          << "All tests in the same test case must use the same test fixture\n"
          << "class.  However, in test case "
          << this_test_info->test_case_name() << ",\n"
          << "you defined test " << first_test_name
          << " and test " << this_test_name << "\n"
          << "using two different test fixture classes.  This can happen if\n"
          << "the two classes are from different namespaces or translation\n"
          << "units and have the same name.  You should probably rename one\n"
          << "of the classes to put the tests into different test cases.";
    }
    return false;
  }

  return true;
}

#if GTEST_HAS_SEH

// Adds an "exception thrown" fatal failure to the current test.  This
// function returns its result via an output parameter pointer because VC++
// prohibits creation of objects with destructors on stack in functions
// using __try (see error C2712).
static std::string* FormatSehExceptionMessage(DWORD exception_code,
                                              const char* location) {
  Message message;
  message << "SEH exception with code 0x" << std::setbase(16) <<
    exception_code << std::setbase(10) << " thrown in " << location << ".";

  return new std::string(message.GetString());
}

#endif  // GTEST_HAS_SEH

namespace internal {

#if GTEST_HAS_EXCEPTIONS

// Adds an "exception thrown" fatal failure to the current test.
static std::string FormatCxxExceptionMessage(const char* description,
                                             const char* location) {
  Message message;
  if (description != NULL) {
    message << "C++ exception with description \"" << description << "\"";
  } else {
    message << "Unknown C++ exception";
  }
  message << " thrown in " << location << ".";

  return message.GetString();
}

static std::string PrintTestPartResultToString(
    const TestPartResult& test_part_result);

GoogleTestFailureException::GoogleTestFailureException(
    const TestPartResult& failure)
    : ::std::runtime_error(PrintTestPartResultToString(failure).c_str()) {}

#endif  // GTEST_HAS_EXCEPTIONS

// We put these helper functions in the internal namespace as IBM's xlC
// compiler rejects the code if they were declared static.

// Runs the given method and handles SEH exceptions it throws, when
// SEH is supported; returns the 0-value for type Result in case of an
// SEH exception.  (Microsoft compilers cannot handle SEH and C++
// exceptions in the same function.  Therefore, we provide a separate
// wrapper function for handling SEH exceptions.)
template 
Result HandleSehExceptionsInMethodIfSupported(
    T* object, Result (T::*method)(), const char* location) {
#if GTEST_HAS_SEH
  __try {
    return (object->*method)();
  } __except (internal::UnitTestOptions::GTestShouldProcessSEH(  // NOLINT
      GetExceptionCode())) {
    // We create the exception message on the heap because VC++ prohibits
    // creation of objects with destructors on stack in functions using __try
    // (see error C2712).
    std::string* exception_message = FormatSehExceptionMessage(
        GetExceptionCode(), location);
    internal::ReportFailureInUnknownLocation(TestPartResult::kFatalFailure,
                                             *exception_message);
    delete exception_message;
    return static_cast(0);
  }
#else
  (void)location;
  return (object->*method)();
#endif  // GTEST_HAS_SEH
}

// Runs the given method and catches and reports C++ and/or SEH-style
// exceptions, if they are supported; returns the 0-value for type
// Result in case of an SEH exception.
template 
Result HandleExceptionsInMethodIfSupported(
    T* object, Result (T::*method)(), const char* location) {
  // NOTE: The user code can affect the way in which Google Test handles
  // exceptions by setting GTEST_FLAG(catch_exceptions), but only before
  // RUN_ALL_TESTS() starts. It is technically possible to check the flag
  // after the exception is caught and either report or re-throw the
  // exception based on the flag's value:
  //
  // try {
  //   // Perform the test method.
  // } catch (...) {
  //   if (GTEST_FLAG(catch_exceptions))
  //     // Report the exception as failure.
  //   else
  //     throw;  // Re-throws the original exception.
  // }
  //
  // However, the purpose of this flag is to allow the program to drop into
  // the debugger when the exception is thrown. On most platforms, once the
  // control enters the catch block, the exception origin information is
  // lost and the debugger will stop the program at the point of the
  // re-throw in this function -- instead of at the point of the original
  // throw statement in the code under test.  For this reason, we perform
  // the check early, sacrificing the ability to affect Google Test's
  // exception handling in the method where the exception is thrown.
  if (internal::GetUnitTestImpl()->catch_exceptions()) {
#if GTEST_HAS_EXCEPTIONS
    try {
      return HandleSehExceptionsInMethodIfSupported(object, method, location);
    } catch (const internal::GoogleTestFailureException&) {  // NOLINT
      // This exception type can only be thrown by a failed Google
      // Test assertion with the intention of letting another testing
      // framework catch it.  Therefore we just re-throw it.
      throw;
    } catch (const std::exception& e) {  // NOLINT
      internal::ReportFailureInUnknownLocation(
          TestPartResult::kFatalFailure,
          FormatCxxExceptionMessage(e.what(), location));
    } catch (...) {  // NOLINT
      internal::ReportFailureInUnknownLocation(
          TestPartResult::kFatalFailure,
          FormatCxxExceptionMessage(NULL, location));
    }
    return static_cast(0);
#else
    return HandleSehExceptionsInMethodIfSupported(object, method, location);
#endif  // GTEST_HAS_EXCEPTIONS
  } else {
    return (object->*method)();
  }
}

}  // namespace internal

// Runs the test and updates the test result.
void Test::Run() {
  if (!HasSameFixtureClass()) return;

  internal::UnitTestImpl* const impl = internal::GetUnitTestImpl();
  impl->os_stack_trace_getter()->UponLeavingGTest();
  internal::HandleExceptionsInMethodIfSupported(this, &Test::SetUp, "SetUp()");
  // We will run the test only if SetUp() was successful.
  if (!HasFatalFailure()) {
    impl->os_stack_trace_getter()->UponLeavingGTest();
    internal::HandleExceptionsInMethodIfSupported(
        this, &Test::TestBody, "the test body");
  }

  // However, we want to clean up as much as possible.  Hence we will
  // always call TearDown(), even if SetUp() or the test body has
  // failed.
  impl->os_stack_trace_getter()->UponLeavingGTest();
  internal::HandleExceptionsInMethodIfSupported(
      this, &Test::TearDown, "TearDown()");
}

// Returns true iff the current test has a fatal failure.
bool Test::HasFatalFailure() {
  return internal::GetUnitTestImpl()->current_test_result()->HasFatalFailure();
}

// Returns true iff the current test has a non-fatal failure.
bool Test::HasNonfatalFailure() {
  return internal::GetUnitTestImpl()->current_test_result()->
      HasNonfatalFailure();
}

// class TestInfo

// Constructs a TestInfo object. It assumes ownership of the test factory
// object.
TestInfo::TestInfo(const std::string& a_test_case_name,
                   const std::string& a_name,
                   const char* a_type_param,
                   const char* a_value_param,
                   internal::TypeId fixture_class_id,
                   internal::TestFactoryBase* factory)
    : test_case_name_(a_test_case_name),
      name_(a_name),
      type_param_(a_type_param ? new std::string(a_type_param) : NULL),
      value_param_(a_value_param ? new std::string(a_value_param) : NULL),
      fixture_class_id_(fixture_class_id),
      should_run_(false),
      is_disabled_(false),
      matches_filter_(false),
      factory_(factory),
      result_() {}

// Destructs a TestInfo object.
TestInfo::~TestInfo() { delete factory_; }

namespace internal {

// Creates a new TestInfo object and registers it with Google Test;
// returns the created object.
//
// Arguments:
//
//   test_case_name:   name of the test case
//   name:             name of the test
//   type_param:       the name of the test's type parameter, or NULL if
//                     this is not a typed or a type-parameterized test.
//   value_param:      text representation of the test's value parameter,
//                     or NULL if this is not a value-parameterized test.
//   fixture_class_id: ID of the test fixture class
//   set_up_tc:        pointer to the function that sets up the test case
//   tear_down_tc:     pointer to the function that tears down the test case
//   factory:          pointer to the factory that creates a test object.
//                     The newly created TestInfo instance will assume
//                     ownership of the factory object.
TestInfo* MakeAndRegisterTestInfo(
    const char* test_case_name,
    const char* name,
    const char* type_param,
    const char* value_param,
    TypeId fixture_class_id,
    SetUpTestCaseFunc set_up_tc,
    TearDownTestCaseFunc tear_down_tc,
    TestFactoryBase* factory) {
  TestInfo* const test_info =
      new TestInfo(test_case_name, name, type_param, value_param,
                   fixture_class_id, factory);
  GetUnitTestImpl()->AddTestInfo(set_up_tc, tear_down_tc, test_info);
  return test_info;
}

#if GTEST_HAS_PARAM_TEST
void ReportInvalidTestCaseType(const char* test_case_name,
                               const char* file, int line) {
  Message errors;
  errors
      << "Attempted redefinition of test case " << test_case_name << ".\n"
      << "All tests in the same test case must use the same test fixture\n"
      << "class.  However, in test case " << test_case_name << ", you tried\n"
      << "to define a test using a fixture class different from the one\n"
      << "used earlier. This can happen if the two fixture classes are\n"
      << "from different namespaces and have the same name. You should\n"
      << "probably rename one of the classes to put the tests into different\n"
      << "test cases.";

  fprintf(stderr, "%s %s", FormatFileLocation(file, line).c_str(),
          errors.GetString().c_str());
}
#endif  // GTEST_HAS_PARAM_TEST

}  // namespace internal

namespace {

// A predicate that checks the test name of a TestInfo against a known
// value.
//
// This is used for implementation of the TestCase class only.  We put
// it in the anonymous namespace to prevent polluting the outer
// namespace.
//
// TestNameIs is copyable.
class TestNameIs {
 public:
  // Constructor.
  //
  // TestNameIs has NO default constructor.
  explicit TestNameIs(const char* name)
      : name_(name) {}

  // Returns true iff the test name of test_info matches name_.
  bool operator()(const TestInfo * test_info) const {
    return test_info && test_info->name() == name_;
  }

 private:
  std::string name_;
};

}  // namespace

namespace internal {

// This method expands all parameterized tests registered with macros TEST_P
// and INSTANTIATE_TEST_CASE_P into regular tests and registers those.
// This will be done just once during the program runtime.
void UnitTestImpl::RegisterParameterizedTests() {
#if GTEST_HAS_PARAM_TEST
  if (!parameterized_tests_registered_) {
    parameterized_test_registry_.RegisterTests();
    parameterized_tests_registered_ = true;
  }
#endif
}

}  // namespace internal

// Creates the test object, runs it, records its result, and then
// deletes it.
void TestInfo::Run() {
  if (!should_run_) return;

  // Tells UnitTest where to store test result.
  internal::UnitTestImpl* const impl = internal::GetUnitTestImpl();
  impl->set_current_test_info(this);

  TestEventListener* repeater = UnitTest::GetInstance()->listeners().repeater();

  // Notifies the unit test event listeners that a test is about to start.
  repeater->OnTestStart(*this);

  const TimeInMillis start = internal::GetTimeInMillis();

  impl->os_stack_trace_getter()->UponLeavingGTest();

  // Creates the test object.
  Test* const test = internal::HandleExceptionsInMethodIfSupported(
      factory_, &internal::TestFactoryBase::CreateTest,
      "the test fixture's constructor");

  // Runs the test only if the test object was created and its
  // constructor didn't generate a fatal failure.
  if ((test != NULL) && !Test::HasFatalFailure()) {
    // This doesn't throw as all user code that can throw are wrapped into
    // exception handling code.
    test->Run();
  }

  // Deletes the test object.
  impl->os_stack_trace_getter()->UponLeavingGTest();
  internal::HandleExceptionsInMethodIfSupported(
      test, &Test::DeleteSelf_, "the test fixture's destructor");

  result_.set_elapsed_time(internal::GetTimeInMillis() - start);

  // Notifies the unit test event listener that a test has just finished.
  repeater->OnTestEnd(*this);

  // Tells UnitTest to stop associating assertion results to this
  // test.
  impl->set_current_test_info(NULL);
}

// class TestCase

// Gets the number of successful tests in this test case.
int TestCase::successful_test_count() const {
  return CountIf(test_info_list_, TestPassed);
}

// Gets the number of failed tests in this test case.
int TestCase::failed_test_count() const {
  return CountIf(test_info_list_, TestFailed);
}

// Gets the number of disabled tests that will be reported in the XML report.
int TestCase::reportable_disabled_test_count() const {
  return CountIf(test_info_list_, TestReportableDisabled);
}

// Gets the number of disabled tests in this test case.
int TestCase::disabled_test_count() const {
  return CountIf(test_info_list_, TestDisabled);
}

// Gets the number of tests to be printed in the XML report.
int TestCase::reportable_test_count() const {
  return CountIf(test_info_list_, TestReportable);
}

// Get the number of tests in this test case that should run.
int TestCase::test_to_run_count() const {
  return CountIf(test_info_list_, ShouldRunTest);
}

// Gets the number of all tests.
int TestCase::total_test_count() const {
  return static_cast(test_info_list_.size());
}

// Creates a TestCase with the given name.
//
// Arguments:
//
//   name:         name of the test case
//   a_type_param: the name of the test case's type parameter, or NULL if
//                 this is not a typed or a type-parameterized test case.
//   set_up_tc:    pointer to the function that sets up the test case
//   tear_down_tc: pointer to the function that tears down the test case
TestCase::TestCase(const char* a_name, const char* a_type_param,
                   Test::SetUpTestCaseFunc set_up_tc,
                   Test::TearDownTestCaseFunc tear_down_tc)
    : name_(a_name),
      type_param_(a_type_param ? new std::string(a_type_param) : NULL),
      set_up_tc_(set_up_tc),
      tear_down_tc_(tear_down_tc),
      should_run_(false),
      elapsed_time_(0) {
}

// Destructor of TestCase.
TestCase::~TestCase() {
  // Deletes every Test in the collection.
  ForEach(test_info_list_, internal::Delete);
}

// Returns the i-th test among all the tests. i can range from 0 to
// total_test_count() - 1. If i is not in that range, returns NULL.
const TestInfo* TestCase::GetTestInfo(int i) const {
  const int index = GetElementOr(test_indices_, i, -1);
  return index < 0 ? NULL : test_info_list_[index];
}

// Returns the i-th test among all the tests. i can range from 0 to
// total_test_count() - 1. If i is not in that range, returns NULL.
TestInfo* TestCase::GetMutableTestInfo(int i) {
  const int index = GetElementOr(test_indices_, i, -1);
  return index < 0 ? NULL : test_info_list_[index];
}

// Adds a test to this test case.  Will delete the test upon
// destruction of the TestCase object.
void TestCase::AddTestInfo(TestInfo * test_info) {
  test_info_list_.push_back(test_info);
  test_indices_.push_back(static_cast(test_indices_.size()));
}

// Runs every test in this TestCase.
void TestCase::Run() {
  if (!should_run_) return;

  internal::UnitTestImpl* const impl = internal::GetUnitTestImpl();
  impl->set_current_test_case(this);

  TestEventListener* repeater = UnitTest::GetInstance()->listeners().repeater();

  repeater->OnTestCaseStart(*this);
  impl->os_stack_trace_getter()->UponLeavingGTest();
  internal::HandleExceptionsInMethodIfSupported(
      this, &TestCase::RunSetUpTestCase, "SetUpTestCase()");

  const internal::TimeInMillis start = internal::GetTimeInMillis();
  for (int i = 0; i < total_test_count(); i++) {
    GetMutableTestInfo(i)->Run();
  }
  elapsed_time_ = internal::GetTimeInMillis() - start;

  impl->os_stack_trace_getter()->UponLeavingGTest();
  internal::HandleExceptionsInMethodIfSupported(
      this, &TestCase::RunTearDownTestCase, "TearDownTestCase()");

  repeater->OnTestCaseEnd(*this);
  impl->set_current_test_case(NULL);
}

// Clears the results of all tests in this test case.
void TestCase::ClearResult() {
  ad_hoc_test_result_.Clear();
  ForEach(test_info_list_, TestInfo::ClearTestResult);
}

// Shuffles the tests in this test case.
void TestCase::ShuffleTests(internal::Random* random) {
  Shuffle(random, &test_indices_);
}

// Restores the test order to before the first shuffle.
void TestCase::UnshuffleTests() {
  for (size_t i = 0; i < test_indices_.size(); i++) {
    test_indices_[i] = static_cast(i);
  }
}

// Formats a countable noun.  Depending on its quantity, either the
// singular form or the plural form is used. e.g.
//
// FormatCountableNoun(1, "formula", "formuli") returns "1 formula".
// FormatCountableNoun(5, "book", "books") returns "5 books".
static std::string FormatCountableNoun(int count,
                                       const char * singular_form,
                                       const char * plural_form) {
  return internal::StreamableToString(count) + " " +
      (count == 1 ? singular_form : plural_form);
}

// Formats the count of tests.
static std::string FormatTestCount(int test_count) {
  return FormatCountableNoun(test_count, "test", "tests");
}

// Formats the count of test cases.
static std::string FormatTestCaseCount(int test_case_count) {
  return FormatCountableNoun(test_case_count, "test case", "test cases");
}

// Converts a TestPartResult::Type enum to human-friendly string
// representation.  Both kNonFatalFailure and kFatalFailure are translated
// to "Failure", as the user usually doesn't care about the difference
// between the two when viewing the test result.
static const char * TestPartResultTypeToString(TestPartResult::Type type) {
  switch (type) {
    case TestPartResult::kSuccess:
      return "Success";

    case TestPartResult::kNonFatalFailure:
    case TestPartResult::kFatalFailure:
#ifdef _MSC_VER
      return "error: ";
#else
      return "Failure\n";
#endif
    default:
      return "Unknown result type";
  }
}

namespace internal {

// Prints a TestPartResult to an std::string.
static std::string PrintTestPartResultToString(
    const TestPartResult& test_part_result) {
  return (Message()
          << internal::FormatFileLocation(test_part_result.file_name(),
                                          test_part_result.line_number())
          << " " << TestPartResultTypeToString(test_part_result.type())
          << test_part_result.message()).GetString();
}

// Prints a TestPartResult.
static void PrintTestPartResult(const TestPartResult& test_part_result) {
  const std::string& result =
      PrintTestPartResultToString(test_part_result);
  printf("%s\n", result.c_str());
  fflush(stdout);
  // If the test program runs in Visual Studio or a debugger, the
  // following statements add the test part result message to the Output
  // window such that the user can double-click on it to jump to the
  // corresponding source code location; otherwise they do nothing.
#if GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE
  // We don't call OutputDebugString*() on Windows Mobile, as printing
  // to stdout is done by OutputDebugString() there already - we don't
  // want the same message printed twice.
  ::OutputDebugStringA(result.c_str());
  ::OutputDebugStringA("\n");
#endif
}

// class PrettyUnitTestResultPrinter

enum GTestColor {
  COLOR_DEFAULT,
  COLOR_RED,
  COLOR_GREEN,
  COLOR_YELLOW
};

#if GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE && \
    !GTEST_OS_WINDOWS_PHONE && !GTEST_OS_WINDOWS_RT

// Returns the character attribute for the given color.
WORD GetColorAttribute(GTestColor color) {
  switch (color) {
    case COLOR_RED:    return FOREGROUND_RED;
    case COLOR_GREEN:  return FOREGROUND_GREEN;
    case COLOR_YELLOW: return FOREGROUND_RED | FOREGROUND_GREEN;
    default:           return 0;
  }
}

#else

// Returns the ANSI color code for the given color.  COLOR_DEFAULT is
// an invalid input.
const char* GetAnsiColorCode(GTestColor color) {
  switch (color) {
    case COLOR_RED:     return "1";
    case COLOR_GREEN:   return "2";
    case COLOR_YELLOW:  return "3";
    default:            return NULL;
  };
}

#endif  // GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE

// Returns true iff Google Test should use colors in the output.
bool ShouldUseColor(bool stdout_is_tty) {
  const char* const gtest_color = GTEST_FLAG(color).c_str();

  if (String::CaseInsensitiveCStringEquals(gtest_color, "auto")) {
#if GTEST_OS_WINDOWS
    // On Windows the TERM variable is usually not set, but the
    // console there does support colors.
    return stdout_is_tty;
#else
    // On non-Windows platforms, we rely on the TERM variable.
    const char* const term = posix::GetEnv("TERM");
    const bool term_supports_color =
        String::CStringEquals(term, "xterm") ||
        String::CStringEquals(term, "xterm-color") ||
        String::CStringEquals(term, "xterm-256color") ||
        String::CStringEquals(term, "screen") ||
        String::CStringEquals(term, "screen-256color") ||
        String::CStringEquals(term, "linux") ||
        String::CStringEquals(term, "cygwin");
    return stdout_is_tty && term_supports_color;
#endif  // GTEST_OS_WINDOWS
  }

  return String::CaseInsensitiveCStringEquals(gtest_color, "yes") ||
      String::CaseInsensitiveCStringEquals(gtest_color, "true") ||
      String::CaseInsensitiveCStringEquals(gtest_color, "t") ||
      String::CStringEquals(gtest_color, "1");
  // We take "yes", "true", "t", and "1" as meaning "yes".  If the
  // value is neither one of these nor "auto", we treat it as "no" to
  // be conservative.
}

// Helpers for printing colored strings to stdout. Note that on Windows, we
// cannot simply emit special characters and have the terminal change colors.
// This routine must actually emit the characters rather than return a string
// that would be colored when printed, as can be done on Linux.
void ColoredPrintf(GTestColor color, const char* fmt, ...) {
  va_list args;
  va_start(args, fmt);

#if GTEST_OS_WINDOWS_MOBILE || GTEST_OS_SYMBIAN || GTEST_OS_ZOS || \
    GTEST_OS_IOS || GTEST_OS_WINDOWS_PHONE || GTEST_OS_WINDOWS_RT
  const bool use_color = AlwaysFalse();
#else
  static const bool in_color_mode =
      ShouldUseColor(posix::IsATTY(posix::FileNo(stdout)) != 0);
  const bool use_color = in_color_mode && (color != COLOR_DEFAULT);
#endif  // GTEST_OS_WINDOWS_MOBILE || GTEST_OS_SYMBIAN || GTEST_OS_ZOS
  // The '!= 0' comparison is necessary to satisfy MSVC 7.1.

  if (!use_color) {
    vprintf(fmt, args);
    va_end(args);
    return;
  }

#if GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE && \
    !GTEST_OS_WINDOWS_PHONE && !GTEST_OS_WINDOWS_RT
  const HANDLE stdout_handle = GetStdHandle(STD_OUTPUT_HANDLE);

  // Gets the current text color.
  CONSOLE_SCREEN_BUFFER_INFO buffer_info;
  GetConsoleScreenBufferInfo(stdout_handle, &buffer_info);
  const WORD old_color_attrs = buffer_info.wAttributes;

  // We need to flush the stream buffers into the console before each
  // SetConsoleTextAttribute call lest it affect the text that is already
  // printed but has not yet reached the console.
  fflush(stdout);
  SetConsoleTextAttribute(stdout_handle,
                          GetColorAttribute(color) | FOREGROUND_INTENSITY);
  vprintf(fmt, args);

  fflush(stdout);
  // Restores the text color.
  SetConsoleTextAttribute(stdout_handle, old_color_attrs);
#else
  printf("\033[0;3%sm", GetAnsiColorCode(color));
  vprintf(fmt, args);
  printf("\033[m");  // Resets the terminal to default.
#endif  // GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_MOBILE
  va_end(args);
}

// Text printed in Google Test's text output and --gunit_list_tests
// output to label the type parameter and value parameter for a test.
static const char kTypeParamLabel[] = "TypeParam";
static const char kValueParamLabel[] = "GetParam()";

void PrintFullTestCommentIfPresent(const TestInfo& test_info) {
  const char* const type_param = test_info.type_param();
  const char* const value_param = test_info.value_param();

  if (type_param != NULL || value_param != NULL) {
    printf(", where ");
    if (type_param != NULL) {
      printf("%s = %s", kTypeParamLabel, type_param);
      if (value_param != NULL)
        printf(" and ");
    }
    if (value_param != NULL) {
      printf("%s = %s", kValueParamLabel, value_param);
    }
  }
}

// This class implements the TestEventListener interface.
//
// Class PrettyUnitTestResultPrinter is copyable.
class PrettyUnitTestResultPrinter : public TestEventListener {
 public:
  PrettyUnitTestResultPrinter() {}
  static void PrintTestName(const char * test_case, const char * test) {
    printf("%s.%s", test_case, test);
  }

  // The following methods override what's in the TestEventListener class.
  virtual void OnTestProgramStart(const UnitTest& /*unit_test*/) {}
  virtual void OnTestIterationStart(const UnitTest& unit_test, int iteration);
  virtual void OnEnvironmentsSetUpStart(const UnitTest& unit_test);
  virtual void OnEnvironmentsSetUpEnd(const UnitTest& /*unit_test*/) {}
  virtual void OnTestCaseStart(const TestCase& test_case);
  virtual void OnTestStart(const TestInfo& test_info);
  virtual void OnTestPartResult(const TestPartResult& result);
  virtual void OnTestEnd(const TestInfo& test_info);
  virtual void OnTestCaseEnd(const TestCase& test_case);
  virtual void OnEnvironmentsTearDownStart(const UnitTest& unit_test);
  virtual void OnEnvironmentsTearDownEnd(const UnitTest& /*unit_test*/) {}
  virtual void OnTestIterationEnd(const UnitTest& unit_test, int iteration);
  virtual void OnTestProgramEnd(const UnitTest& /*unit_test*/) {}

 private:
  static void PrintFailedTests(const UnitTest& unit_test);
};

  // Fired before each iteration of tests starts.
void PrettyUnitTestResultPrinter::OnTestIterationStart(
    const UnitTest& unit_test, int iteration) {
  if (GTEST_FLAG(repeat) != 1)
    printf("\nRepeating all tests (iteration %d) . . .\n\n", iteration + 1);

  const char* const filter = GTEST_FLAG(filter).c_str();

  // Prints the filter if it's not *.  This reminds the user that some
  // tests may be skipped.
  if (!String::CStringEquals(filter, kUniversalFilter)) {
    ColoredPrintf(COLOR_YELLOW,
                  "Note: %s filter = %s\n", GTEST_NAME_, filter);
  }

  if (internal::ShouldShard(kTestTotalShards, kTestShardIndex, false)) {
    const Int32 shard_index = Int32FromEnvOrDie(kTestShardIndex, -1);
    ColoredPrintf(COLOR_YELLOW,
                  "Note: This is test shard %d of %s.\n",
                  static_cast(shard_index) + 1,
                  internal::posix::GetEnv(kTestTotalShards));
  }

  if (GTEST_FLAG(shuffle)) {
    ColoredPrintf(COLOR_YELLOW,
                  "Note: Randomizing tests' orders with a seed of %d .\n",
                  unit_test.random_seed());
  }

  ColoredPrintf(COLOR_GREEN,  "[==========] ");
  printf("Running %s from %s.\n",
         FormatTestCount(unit_test.test_to_run_count()).c_str(),
         FormatTestCaseCount(unit_test.test_case_to_run_count()).c_str());
  fflush(stdout);
}

void PrettyUnitTestResultPrinter::OnEnvironmentsSetUpStart(
    const UnitTest& /*unit_test*/) {
  ColoredPrintf(COLOR_GREEN,  "[----------] ");
  printf("Global test environment set-up.\n");
  fflush(stdout);
}

void PrettyUnitTestResultPrinter::OnTestCaseStart(const TestCase& test_case) {
  const std::string counts =
      FormatCountableNoun(test_case.test_to_run_count(), "test", "tests");
  ColoredPrintf(COLOR_GREEN, "[----------] ");
  printf("%s from %s", counts.c_str(), test_case.name());
  if (test_case.type_param() == NULL) {
    printf("\n");
  } else {
    printf(", where %s = %s\n", kTypeParamLabel, test_case.type_param());
  }
  fflush(stdout);
}

void PrettyUnitTestResultPrinter::OnTestStart(const TestInfo& test_info) {
  ColoredPrintf(COLOR_GREEN,  "[ RUN      ] ");
  PrintTestName(test_info.test_case_name(), test_info.name());
  printf("\n");
  fflush(stdout);
}

// Called after an assertion failure.
void PrettyUnitTestResultPrinter::OnTestPartResult(
    const TestPartResult& result) {
  // If the test part succeeded, we don't need to do anything.
  if (result.type() == TestPartResult::kSuccess)
    return;

  // Print failure message from the assertion (e.g. expected this and got that).
  PrintTestPartResult(result);
  fflush(stdout);
}

void PrettyUnitTestResultPrinter::OnTestEnd(const TestInfo& test_info) {
  if (test_info.result()->Passed()) {
    ColoredPrintf(COLOR_GREEN, "[       OK ] ");
  } else {
    ColoredPrintf(COLOR_RED, "[  FAILED  ] ");
  }
  PrintTestName(test_info.test_case_name(), test_info.name());
  if (test_info.result()->Failed())
    PrintFullTestCommentIfPresent(test_info);

  if (GTEST_FLAG(print_time)) {
    printf(" (%s ms)\n", internal::StreamableToString(
           test_info.result()->elapsed_time()).c_str());
  } else {
    printf("\n");
  }
  fflush(stdout);
}

void PrettyUnitTestResultPrinter::OnTestCaseEnd(const TestCase& test_case) {
  if (!GTEST_FLAG(print_time)) return;

  const std::string counts =
      FormatCountableNoun(test_case.test_to_run_count(), "test", "tests");
  ColoredPrintf(COLOR_GREEN, "[----------] ");
  printf("%s from %s (%s ms total)\n\n",
         counts.c_str(), test_case.name(),
         internal::StreamableToString(test_case.elapsed_time()).c_str());
  fflush(stdout);
}

void PrettyUnitTestResultPrinter::OnEnvironmentsTearDownStart(
    const UnitTest& /*unit_test*/) {
  ColoredPrintf(COLOR_GREEN,  "[----------] ");
  printf("Global test environment tear-down\n");
  fflush(stdout);
}

// Internal helper for printing the list of failed tests.
void PrettyUnitTestResultPrinter::PrintFailedTests(const UnitTest& unit_test) {
  const int failed_test_count = unit_test.failed_test_count();
  if (failed_test_count == 0) {
    return;
  }

  for (int i = 0; i < unit_test.total_test_case_count(); ++i) {
    const TestCase& test_case = *unit_test.GetTestCase(i);
    if (!test_case.should_run() || (test_case.failed_test_count() == 0)) {
      continue;
    }
    for (int j = 0; j < test_case.total_test_count(); ++j) {
      const TestInfo& test_info = *test_case.GetTestInfo(j);
      if (!test_info.should_run() || test_info.result()->Passed()) {
        continue;
      }
      ColoredPrintf(COLOR_RED, "[  FAILED  ] ");
      printf("%s.%s", test_case.name(), test_info.name());
      PrintFullTestCommentIfPresent(test_info);
      printf("\n");
    }
  }
}

void PrettyUnitTestResultPrinter::OnTestIterationEnd(const UnitTest& unit_test,
                                                     int /*iteration*/) {
  ColoredPrintf(COLOR_GREEN,  "[==========] ");
  printf("%s from %s ran.",
         FormatTestCount(unit_test.test_to_run_count()).c_str(),
         FormatTestCaseCount(unit_test.test_case_to_run_count()).c_str());
  if (GTEST_FLAG(print_time)) {
    printf(" (%s ms total)",
           internal::StreamableToString(unit_test.elapsed_time()).c_str());
  }
  printf("\n");
  ColoredPrintf(COLOR_GREEN,  "[  PASSED  ] ");
  printf("%s.\n", FormatTestCount(unit_test.successful_test_count()).c_str());

  int num_failures = unit_test.failed_test_count();
  if (!unit_test.Passed()) {
    const int failed_test_count = unit_test.failed_test_count();
    ColoredPrintf(COLOR_RED,  "[  FAILED  ] ");
    printf("%s, listed below:\n", FormatTestCount(failed_test_count).c_str());
    PrintFailedTests(unit_test);
    printf("\n%2d FAILED %s\n", num_failures,
                        num_failures == 1 ? "TEST" : "TESTS");
  }

  int num_disabled = unit_test.reportable_disabled_test_count();
  if (num_disabled && !GTEST_FLAG(also_run_disabled_tests)) {
    if (!num_failures) {
      printf("\n");  // Add a spacer if no FAILURE banner is displayed.
    }
    ColoredPrintf(COLOR_YELLOW,
                  "  YOU HAVE %d DISABLED %s\n\n",
                  num_disabled,
                  num_disabled == 1 ? "TEST" : "TESTS");
  }
  // Ensure that Google Test output is printed before, e.g., heapchecker output.
  fflush(stdout);
}

// End PrettyUnitTestResultPrinter

// class TestEventRepeater
//
// This class forwards events to other event listeners.
class TestEventRepeater : public TestEventListener {
 public:
  TestEventRepeater() : forwarding_enabled_(true) {}
  virtual ~TestEventRepeater();
  void Append(TestEventListener *listener);
  TestEventListener* Release(TestEventListener* listener);

  // Controls whether events will be forwarded to listeners_. Set to false
  // in death test child processes.
  bool forwarding_enabled() const { return forwarding_enabled_; }
  void set_forwarding_enabled(bool enable) { forwarding_enabled_ = enable; }

  virtual void OnTestProgramStart(const UnitTest& unit_test);
  virtual void OnTestIterationStart(const UnitTest& unit_test, int iteration);
  virtual void OnEnvironmentsSetUpStart(const UnitTest& unit_test);
  virtual void OnEnvironmentsSetUpEnd(const UnitTest& unit_test);
  virtual void OnTestCaseStart(const TestCase& test_case);
  virtual void OnTestStart(const TestInfo& test_info);
  virtual void OnTestPartResult(const TestPartResult& result);
  virtual void OnTestEnd(const TestInfo& test_info);
  virtual void OnTestCaseEnd(const TestCase& test_case);
  virtual void OnEnvironmentsTearDownStart(const UnitTest& unit_test);
  virtual void OnEnvironmentsTearDownEnd(const UnitTest& unit_test);
  virtual void OnTestIterationEnd(const UnitTest& unit_test, int iteration);
  virtual void OnTestProgramEnd(const UnitTest& unit_test);

 private:
  // Controls whether events will be forwarded to listeners_. Set to false
  // in death test child processes.
  bool forwarding_enabled_;
  // The list of listeners that receive events.
  std::vector listeners_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(TestEventRepeater);
};

TestEventRepeater::~TestEventRepeater() {
  ForEach(listeners_, Delete);
}

void TestEventRepeater::Append(TestEventListener *listener) {
  listeners_.push_back(listener);
}

// TODO(vladl@google.com): Factor the search functionality into Vector::Find.
TestEventListener* TestEventRepeater::Release(TestEventListener *listener) {
  for (size_t i = 0; i < listeners_.size(); ++i) {
    if (listeners_[i] == listener) {
      listeners_.erase(listeners_.begin() + i);
      return listener;
    }
  }

  return NULL;
}

// Since most methods are very similar, use macros to reduce boilerplate.
// This defines a member that forwards the call to all listeners.
#define GTEST_REPEATER_METHOD_(Name, Type) \
void TestEventRepeater::Name(const Type& parameter) { \
  if (forwarding_enabled_) { \
    for (size_t i = 0; i < listeners_.size(); i++) { \
      listeners_[i]->Name(parameter); \
    } \
  } \
}
// This defines a member that forwards the call to all listeners in reverse
// order.
#define GTEST_REVERSE_REPEATER_METHOD_(Name, Type) \
void TestEventRepeater::Name(const Type& parameter) { \
  if (forwarding_enabled_) { \
    for (int i = static_cast(listeners_.size()) - 1; i >= 0; i--) { \
      listeners_[i]->Name(parameter); \
    } \
  } \
}

GTEST_REPEATER_METHOD_(OnTestProgramStart, UnitTest)
GTEST_REPEATER_METHOD_(OnEnvironmentsSetUpStart, UnitTest)
GTEST_REPEATER_METHOD_(OnTestCaseStart, TestCase)
GTEST_REPEATER_METHOD_(OnTestStart, TestInfo)
GTEST_REPEATER_METHOD_(OnTestPartResult, TestPartResult)
GTEST_REPEATER_METHOD_(OnEnvironmentsTearDownStart, UnitTest)
GTEST_REVERSE_REPEATER_METHOD_(OnEnvironmentsSetUpEnd, UnitTest)
GTEST_REVERSE_REPEATER_METHOD_(OnEnvironmentsTearDownEnd, UnitTest)
GTEST_REVERSE_REPEATER_METHOD_(OnTestEnd, TestInfo)
GTEST_REVERSE_REPEATER_METHOD_(OnTestCaseEnd, TestCase)
GTEST_REVERSE_REPEATER_METHOD_(OnTestProgramEnd, UnitTest)

#undef GTEST_REPEATER_METHOD_
#undef GTEST_REVERSE_REPEATER_METHOD_

void TestEventRepeater::OnTestIterationStart(const UnitTest& unit_test,
                                             int iteration) {
  if (forwarding_enabled_) {
    for (size_t i = 0; i < listeners_.size(); i++) {
      listeners_[i]->OnTestIterationStart(unit_test, iteration);
    }
  }
}

void TestEventRepeater::OnTestIterationEnd(const UnitTest& unit_test,
                                           int iteration) {
  if (forwarding_enabled_) {
    for (int i = static_cast(listeners_.size()) - 1; i >= 0; i--) {
      listeners_[i]->OnTestIterationEnd(unit_test, iteration);
    }
  }
}

// End TestEventRepeater

// This class generates an XML output file.
class XmlUnitTestResultPrinter : public EmptyTestEventListener {
 public:
  explicit XmlUnitTestResultPrinter(const char* output_file);

  virtual void OnTestIterationEnd(const UnitTest& unit_test, int iteration);

 private:
  // Is c a whitespace character that is normalized to a space character
  // when it appears in an XML attribute value?
  static bool IsNormalizableWhitespace(char c) {
    return c == 0x9 || c == 0xA || c == 0xD;
  }

  // May c appear in a well-formed XML document?
  static bool IsValidXmlCharacter(char c) {
    return IsNormalizableWhitespace(c) || c >= 0x20;
  }

  // Returns an XML-escaped copy of the input string str.  If
  // is_attribute is true, the text is meant to appear as an attribute
  // value, and normalizable whitespace is preserved by replacing it
  // with character references.
  static std::string EscapeXml(const std::string& str, bool is_attribute);

  // Returns the given string with all characters invalid in XML removed.
  static std::string RemoveInvalidXmlCharacters(const std::string& str);

  // Convenience wrapper around EscapeXml when str is an attribute value.
  static std::string EscapeXmlAttribute(const std::string& str) {
    return EscapeXml(str, true);
  }

  // Convenience wrapper around EscapeXml when str is not an attribute value.
  static std::string EscapeXmlText(const char* str) {
    return EscapeXml(str, false);
  }

  // Verifies that the given attribute belongs to the given element and
  // streams the attribute as XML.
  static void OutputXmlAttribute(std::ostream* stream,
                                 const std::string& element_name,
                                 const std::string& name,
                                 const std::string& value);

  // Streams an XML CDATA section, escaping invalid CDATA sequences as needed.
  static void OutputXmlCDataSection(::std::ostream* stream, const char* data);

  // Streams an XML representation of a TestInfo object.
  static void OutputXmlTestInfo(::std::ostream* stream,
                                const char* test_case_name,
                                const TestInfo& test_info);

  // Prints an XML representation of a TestCase object
  static void PrintXmlTestCase(::std::ostream* stream,
                               const TestCase& test_case);

  // Prints an XML summary of unit_test to output stream out.
  static void PrintXmlUnitTest(::std::ostream* stream,
                               const UnitTest& unit_test);

  // Produces a string representing the test properties in a result as space
  // delimited XML attributes based on the property key="value" pairs.
  // When the std::string is not empty, it includes a space at the beginning,
  // to delimit this attribute from prior attributes.
  static std::string TestPropertiesAsXmlAttributes(const TestResult& result);

  // The output file.
  const std::string output_file_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(XmlUnitTestResultPrinter);
};

// Creates a new XmlUnitTestResultPrinter.
XmlUnitTestResultPrinter::XmlUnitTestResultPrinter(const char* output_file)
    : output_file_(output_file) {
  if (output_file_.c_str() == NULL || output_file_.empty()) {
    fprintf(stderr, "XML output file may not be null\n");
    fflush(stderr);
    exit(EXIT_FAILURE);
  }
}

// Called after the unit test ends.
void XmlUnitTestResultPrinter::OnTestIterationEnd(const UnitTest& unit_test,
                                                  int /*iteration*/) {
  FILE* xmlout = NULL;
  FilePath output_file(output_file_);
  FilePath output_dir(output_file.RemoveFileName());

  if (output_dir.CreateDirectoriesRecursively()) {
    xmlout = posix::FOpen(output_file_.c_str(), "w");
  }
  if (xmlout == NULL) {
    // TODO(wan): report the reason of the failure.
    //
    // We don't do it for now as:
    //
    //   1. There is no urgent need for it.
    //   2. It's a bit involved to make the errno variable thread-safe on
    //      all three operating systems (Linux, Windows, and Mac OS).
    //   3. To interpret the meaning of errno in a thread-safe way,
    //      we need the strerror_r() function, which is not available on
    //      Windows.
    fprintf(stderr,
            "Unable to open file \"%s\"\n",
            output_file_.c_str());
    fflush(stderr);
    exit(EXIT_FAILURE);
  }
  std::stringstream stream;
  PrintXmlUnitTest(&stream, unit_test);
  fprintf(xmlout, "%s", StringStreamToString(&stream).c_str());
  fclose(xmlout);
}

// Returns an XML-escaped copy of the input string str.  If is_attribute
// is true, the text is meant to appear as an attribute value, and
// normalizable whitespace is preserved by replacing it with character
// references.
//
// Invalid XML characters in str, if any, are stripped from the output.
// It is expected that most, if not all, of the text processed by this
// module will consist of ordinary English text.
// If this module is ever modified to produce version 1.1 XML output,
// most invalid characters can be retained using character references.
// TODO(wan): It might be nice to have a minimally invasive, human-readable
// escaping scheme for invalid characters, rather than dropping them.
std::string XmlUnitTestResultPrinter::EscapeXml(
    const std::string& str, bool is_attribute) {
  Message m;

  for (size_t i = 0; i < str.size(); ++i) {
    const char ch = str[i];
    switch (ch) {
      case '<':
        m << "<";
        break;
      case '>':
        m << ">";
        break;
      case '&':
        m << "&";
        break;
      case '\'':
        if (is_attribute)
          m << "'";
        else
          m << '\'';
        break;
      case '"':
        if (is_attribute)
          m << """;
        else
          m << '"';
        break;
      default:
        if (IsValidXmlCharacter(ch)) {
          if (is_attribute && IsNormalizableWhitespace(ch))
            m << "&#x" << String::FormatByte(static_cast(ch))
              << ";";
          else
            m << ch;
        }
        break;
    }
  }

  return m.GetString();
}

// Returns the given string with all characters invalid in XML removed.
// Currently invalid characters are dropped from the string. An
// alternative is to replace them with certain characters such as . or ?.
std::string XmlUnitTestResultPrinter::RemoveInvalidXmlCharacters(
    const std::string& str) {
  std::string output;
  output.reserve(str.size());
  for (std::string::const_iterator it = str.begin(); it != str.end(); ++it)
    if (IsValidXmlCharacter(*it))
      output.push_back(*it);

  return output;
}

// The following routines generate an XML representation of a UnitTest
// object.
//
// This is how Google Test concepts map to the DTD:
//
//         <-- corresponds to a UnitTest object
//     <-- corresponds to a TestCase object
//          <-- corresponds to a TestInfo object
//       ...
//       ...
//       ...
//                                     <-- individual assertion failures
//     
//   
// 

class TapUnitTestResultPrinter : public EmptyTestEventListener {
 public:
  TapUnitTestResultPrinter();
  explicit TapUnitTestResultPrinter(const char* output_file);
  virtual void OnTestIterationEnd(const UnitTest& unit_test, int iteration);

 private:
  static void PrintTapUnitTest(::std::ostream* stream,
                               const UnitTest& unit_test);
  static void PrintTapTestCase(int* count,
                               ::std::ostream* stream,
                               const TestCase& test_case);
  static void OutputTapTestInfo(int* count,
                                ::std::ostream* stream,
                                const char* test_case_name,
                                const TestInfo& test_info);
  static void OutputTapComment(::std::ostream* stream, const char* comment);

  const std::string output_file_;
  GTEST_DISALLOW_COPY_AND_ASSIGN_(TapUnitTestResultPrinter);
};

TapUnitTestResultPrinter::TapUnitTestResultPrinter() {}

TapUnitTestResultPrinter::TapUnitTestResultPrinter(const char* output_file)
    : output_file_(output_file) {
  if (output_file_.c_str() == NULL || output_file_.empty()) {
    fprintf(stderr, "TAP output file may not be null\n");
    fflush(stderr);
    exit(EXIT_FAILURE);
  }
}

void TapUnitTestResultPrinter::OnTestIterationEnd(const UnitTest& unit_test,
                                                  int /*iteration*/) {
  FILE* tapout = stdout;

  if (!output_file_.empty()) {
    FilePath output_file(output_file_);
    FilePath output_dir(output_file.RemoveFileName());

    tapout = NULL;
    if (output_dir.CreateDirectoriesRecursively())
      tapout = posix::FOpen(output_file_.c_str(), "w");

    if (tapout == NULL) {
      fprintf(stderr, "Unable to open file \"%s\"\n", output_file_.c_str());
      fflush(stderr);
      exit(EXIT_FAILURE);
    }
  }

  std::stringstream stream;
  PrintTapUnitTest(&stream, unit_test);
  fprintf(tapout, "%s", StringStreamToString(&stream).c_str());
  fflush(tapout);

  if (tapout != stdout)
    fclose(tapout);
}

void TapUnitTestResultPrinter::PrintTapUnitTest(std::ostream* stream,
                                                const UnitTest& unit_test) {
  *stream << "TAP version 13\n";
  *stream << "1.." << unit_test.reportable_test_count() << "\n";

  int count = 1;
  for (int i = 0; i < unit_test.total_test_case_count(); ++i) {
    const TestCase& test_case = *unit_test.GetTestCase(i);
    if (test_case.reportable_test_count() > 0)
      PrintTapTestCase(&count, stream, test_case);
  }

  *stream << "# failures: " << unit_test.failed_test_count() << "\n";
}

void TapUnitTestResultPrinter::PrintTapTestCase(int* count,
                                                std::ostream* stream,
                                                const TestCase& test_case) {
  for (int i = 0; i < test_case.total_test_count(); ++i) {
    const TestInfo& test_info = *test_case.GetTestInfo(i);
    if (test_info.is_reportable())
      OutputTapTestInfo(count, stream, test_case.name(), test_info);
  }
}

void TapUnitTestResultPrinter::OutputTapTestInfo(int* count,
                                                 ::std::ostream* stream,
                                                 const char* test_case_name,
                                                 const TestInfo& test_info) {
  const TestResult& result = *test_info.result();
  const char* status = result.Passed() ? "ok" : "not ok";

  *stream << status << " " << *count << " - " <<
             test_case_name << "." << test_info.name() << "\n";
  *stream << "  ---\n";
  *stream << "  duration_ms: " <<
             FormatTimeInMillisAsSeconds(result.elapsed_time()) << "\n";

  if (result.total_part_count() > 0) {
    *stream << "  stack: |-\n";
    for (int i = 0; i < result.total_part_count(); ++i) {
      const TestPartResult& part = result.GetTestPartResult(i);
      OutputTapComment(stream, part.message());
    }
  }
  *stream << "  ...\n";
  *count += 1;
}

void TapUnitTestResultPrinter::OutputTapComment(::std::ostream* stream,
                                                const char* comment) {
  const char* start = comment;
  while (const char* end = strchr(start, '\n')) {
    *stream << "    " << std::string(start, end) << "\n";
    start = end + 1;
  }
  if (*start)
    *stream << "    " << start << "\n";
}

// Formats the given time in milliseconds as seconds.
std::string FormatTimeInMillisAsSeconds(TimeInMillis ms) {
  ::std::stringstream ss;
  ss << ms/1000.0;
  return ss.str();
}

static bool PortableLocaltime(time_t seconds, struct tm* out) {
#if defined(_MSC_VER)
  return localtime_s(out, &seconds) == 0;
#elif defined(__MINGW32__) || defined(__MINGW64__)
  // MINGW  provides neither localtime_r nor localtime_s, but uses
  // Windows' localtime(), which has a thread-local tm buffer.
  struct tm* tm_ptr = localtime(&seconds);  // NOLINT
  if (tm_ptr == NULL)
    return false;
  *out = *tm_ptr;
  return true;
#else
  return localtime_r(&seconds, out) != NULL;
#endif
}

// Converts the given epoch time in milliseconds to a date string in the ISO
// 8601 format, without the timezone information.
std::string FormatEpochTimeInMillisAsIso8601(TimeInMillis ms) {
  struct tm time_struct;
  if (!PortableLocaltime(static_cast(ms / 1000), &time_struct))
    return "";
  // YYYY-MM-DDThh:mm:ss
  return StreamableToString(time_struct.tm_year + 1900) + "-" +
      String::FormatIntWidth2(time_struct.tm_mon + 1) + "-" +
      String::FormatIntWidth2(time_struct.tm_mday) + "T" +
      String::FormatIntWidth2(time_struct.tm_hour) + ":" +
      String::FormatIntWidth2(time_struct.tm_min) + ":" +
      String::FormatIntWidth2(time_struct.tm_sec);
}

// Streams an XML CDATA section, escaping invalid CDATA sequences as needed.
void XmlUnitTestResultPrinter::OutputXmlCDataSection(::std::ostream* stream,
                                                     const char* data) {
  const char* segment = data;
  *stream << "");
    if (next_segment != NULL) {
      stream->write(
          segment, static_cast(next_segment - segment));
      *stream << "]]>]]>");
    } else {
      *stream << segment;
      break;
    }
  }
  *stream << "]]>";
}

void XmlUnitTestResultPrinter::OutputXmlAttribute(
    std::ostream* stream,
    const std::string& element_name,
    const std::string& name,
    const std::string& value) {
  const std::vector& allowed_names =
      GetReservedAttributesForElement(element_name);

  GTEST_CHECK_(std::find(allowed_names.begin(), allowed_names.end(), name) !=
                   allowed_names.end())
      << "Attribute " << name << " is not allowed for element <" << element_name
      << ">.";

  *stream << " " << name << "=\"" << EscapeXmlAttribute(value) << "\"";
}

// Prints an XML representation of a TestInfo object.
// TODO(wan): There is also value in printing properties with the plain printer.
void XmlUnitTestResultPrinter::OutputXmlTestInfo(::std::ostream* stream,
                                                 const char* test_case_name,
                                                 const TestInfo& test_info) {
  const TestResult& result = *test_info.result();
  const std::string kTestcase = "testcase";

  *stream << "    \n";
      }
      const string location = internal::FormatCompilerIndependentFileLocation(
          part.file_name(), part.line_number());
      const string summary = location + "\n" + part.summary();
      *stream << "      ";
      const string detail = location + "\n" + part.message();
      OutputXmlCDataSection(stream, RemoveInvalidXmlCharacters(detail).c_str());
      *stream << "\n";
    }
  }

  if (failures == 0)
    *stream << " />\n";
  else
    *stream << "    \n";
}

// Prints an XML representation of a TestCase object
void XmlUnitTestResultPrinter::PrintXmlTestCase(std::ostream* stream,
                                                const TestCase& test_case) {
  const std::string kTestsuite = "testsuite";
  *stream << "  <" << kTestsuite;
  OutputXmlAttribute(stream, kTestsuite, "name", test_case.name());
  OutputXmlAttribute(stream, kTestsuite, "tests",
                     StreamableToString(test_case.reportable_test_count()));
  OutputXmlAttribute(stream, kTestsuite, "failures",
                     StreamableToString(test_case.failed_test_count()));
  OutputXmlAttribute(
      stream, kTestsuite, "disabled",
      StreamableToString(test_case.reportable_disabled_test_count()));
  OutputXmlAttribute(stream, kTestsuite, "errors", "0");
  OutputXmlAttribute(stream, kTestsuite, "time",
                     FormatTimeInMillisAsSeconds(test_case.elapsed_time()));
  *stream << TestPropertiesAsXmlAttributes(test_case.ad_hoc_test_result())
          << ">\n";

  for (int i = 0; i < test_case.total_test_count(); ++i) {
    if (test_case.GetTestInfo(i)->is_reportable())
      OutputXmlTestInfo(stream, test_case.name(), *test_case.GetTestInfo(i));
  }
  *stream << "  \n";
}

// Prints an XML summary of unit_test to output stream out.
void XmlUnitTestResultPrinter::PrintXmlUnitTest(std::ostream* stream,
                                                const UnitTest& unit_test) {
  const std::string kTestsuites = "testsuites";

  *stream << "\n";
  *stream << "<" << kTestsuites;

  OutputXmlAttribute(stream, kTestsuites, "tests",
                     StreamableToString(unit_test.reportable_test_count()));
  OutputXmlAttribute(stream, kTestsuites, "failures",
                     StreamableToString(unit_test.failed_test_count()));
  OutputXmlAttribute(
      stream, kTestsuites, "disabled",
      StreamableToString(unit_test.reportable_disabled_test_count()));
  OutputXmlAttribute(stream, kTestsuites, "errors", "0");
  OutputXmlAttribute(
      stream, kTestsuites, "timestamp",
      FormatEpochTimeInMillisAsIso8601(unit_test.start_timestamp()));
  OutputXmlAttribute(stream, kTestsuites, "time",
                     FormatTimeInMillisAsSeconds(unit_test.elapsed_time()));

  if (GTEST_FLAG(shuffle)) {
    OutputXmlAttribute(stream, kTestsuites, "random_seed",
                       StreamableToString(unit_test.random_seed()));
  }

  *stream << TestPropertiesAsXmlAttributes(unit_test.ad_hoc_test_result());

  OutputXmlAttribute(stream, kTestsuites, "name", "AllTests");
  *stream << ">\n";

  for (int i = 0; i < unit_test.total_test_case_count(); ++i) {
    if (unit_test.GetTestCase(i)->reportable_test_count() > 0)
      PrintXmlTestCase(stream, *unit_test.GetTestCase(i));
  }
  *stream << "\n";
}

// Produces a string representing the test properties in a result as space
// delimited XML attributes based on the property key="value" pairs.
std::string XmlUnitTestResultPrinter::TestPropertiesAsXmlAttributes(
    const TestResult& result) {
  Message attributes;
  for (int i = 0; i < result.test_property_count(); ++i) {
    const TestProperty& property = result.GetTestProperty(i);
    attributes << " " << property.key() << "="
        << "\"" << EscapeXmlAttribute(property.value()) << "\"";
  }
  return attributes.GetString();
}

// End XmlUnitTestResultPrinter

#if GTEST_CAN_STREAM_RESULTS_

// Checks if str contains '=', '&', '%' or '\n' characters. If yes,
// replaces them by "%xx" where xx is their hexadecimal value. For
// example, replaces "=" with "%3D".  This algorithm is O(strlen(str))
// in both time and space -- important as the input str may contain an
// arbitrarily long test failure message and stack trace.
string StreamingListener::UrlEncode(const char* str) {
  string result;
  result.reserve(strlen(str) + 1);
  for (char ch = *str; ch != '\0'; ch = *++str) {
    switch (ch) {
      case '%':
      case '=':
      case '&':
      case '\n':
        result.append("%" + String::FormatByte(static_cast(ch)));
        break;
      default:
        result.push_back(ch);
        break;
    }
  }
  return result;
}

void StreamingListener::SocketWriter::MakeConnection() {
  GTEST_CHECK_(sockfd_ == -1)
      << "MakeConnection() can't be called when there is already a connection.";

  addrinfo hints;
  memset(&hints, 0, sizeof(hints));
  hints.ai_family = AF_UNSPEC;    // To allow both IPv4 and IPv6 addresses.
  hints.ai_socktype = SOCK_STREAM;
  addrinfo* servinfo = NULL;

  // Use the getaddrinfo() to get a linked list of IP addresses for
  // the given host name.
  const int error_num = getaddrinfo(
      host_name_.c_str(), port_num_.c_str(), &hints, &servinfo);
  if (error_num != 0) {
    GTEST_LOG_(WARNING) << "stream_result_to: getaddrinfo() failed: "
                        << gai_strerror(error_num);
  }

  // Loop through all the results and connect to the first we can.
  for (addrinfo* cur_addr = servinfo; sockfd_ == -1 && cur_addr != NULL;
       cur_addr = cur_addr->ai_next) {
    sockfd_ = socket(
        cur_addr->ai_family, cur_addr->ai_socktype, cur_addr->ai_protocol);
    if (sockfd_ != -1) {
      // Connect the client socket to the server socket.
      if (connect(sockfd_, cur_addr->ai_addr, cur_addr->ai_addrlen) == -1) {
        close(sockfd_);
        sockfd_ = -1;
      }
    }
  }

  freeaddrinfo(servinfo);  // all done with this structure

  if (sockfd_ == -1) {
    GTEST_LOG_(WARNING) << "stream_result_to: failed to connect to "
                        << host_name_ << ":" << port_num_;
  }
}

// End of class Streaming Listener
#endif  // GTEST_CAN_STREAM_RESULTS__

// Class ScopedTrace

// Pushes the given source file location and message onto a per-thread
// trace stack maintained by Google Test.
ScopedTrace::ScopedTrace(const char* file, int line, const Message& message)
    GTEST_LOCK_EXCLUDED_(&UnitTest::mutex_) {
  TraceInfo trace;
  trace.file = file;
  trace.line = line;
  trace.message = message.GetString();

  UnitTest::GetInstance()->PushGTestTrace(trace);
}

// Pops the info pushed by the c'tor.
ScopedTrace::~ScopedTrace()
    GTEST_LOCK_EXCLUDED_(&UnitTest::mutex_) {
  UnitTest::GetInstance()->PopGTestTrace();
}


// class OsStackTraceGetter

// Returns the current OS stack trace as an std::string.  Parameters:
//
//   max_depth  - the maximum number of stack frames to be included
//                in the trace.
//   skip_count - the number of top frames to be skipped; doesn't count
//                against max_depth.
//
string OsStackTraceGetter::CurrentStackTrace(int /* max_depth */,
                                             int /* skip_count */)
    GTEST_LOCK_EXCLUDED_(mutex_) {
  return "";
}

void OsStackTraceGetter::UponLeavingGTest()
    GTEST_LOCK_EXCLUDED_(mutex_) {
}

const char* const
OsStackTraceGetter::kElidedFramesMarker =
    "... " GTEST_NAME_ " internal frames ...";

// A helper class that creates the premature-exit file in its
// constructor and deletes the file in its destructor.
class ScopedPrematureExitFile {
 public:
  explicit ScopedPrematureExitFile(const char* premature_exit_filepath)
      : premature_exit_filepath_(premature_exit_filepath) {
    // If a path to the premature-exit file is specified...
    if (premature_exit_filepath != NULL && *premature_exit_filepath != '\0') {
      // create the file with a single "0" character in it.  I/O
      // errors are ignored as there's nothing better we can do and we
      // don't want to fail the test because of this.
      FILE* pfile = posix::FOpen(premature_exit_filepath, "w");
      fwrite("0", 1, 1, pfile);
      fclose(pfile);
    }
  }

  ~ScopedPrematureExitFile() {
    if (premature_exit_filepath_ != NULL && *premature_exit_filepath_ != '\0') {
      remove(premature_exit_filepath_);
    }
  }

 private:
  const char* const premature_exit_filepath_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(ScopedPrematureExitFile);
};

}  // namespace internal

// class TestEventListeners

TestEventListeners::TestEventListeners()
    : repeater_(new internal::TestEventRepeater()),
      default_result_printer_(NULL),
      default_xml_generator_(NULL) {
}

TestEventListeners::~TestEventListeners() { delete repeater_; }

// Returns the standard listener responsible for the default console
// output.  Can be removed from the listeners list to shut down default
// console output.  Note that removing this object from the listener list
// with Release transfers its ownership to the user.
void TestEventListeners::Append(TestEventListener* listener) {
  repeater_->Append(listener);
}

// Removes the given event listener from the list and returns it.  It then
// becomes the caller's responsibility to delete the listener. Returns
// NULL if the listener is not found in the list.
TestEventListener* TestEventListeners::Release(TestEventListener* listener) {
  if (listener == default_result_printer_)
    default_result_printer_ = NULL;
  else if (listener == default_xml_generator_)
    default_xml_generator_ = NULL;
  return repeater_->Release(listener);
}

// Returns repeater that broadcasts the TestEventListener events to all
// subscribers.
TestEventListener* TestEventListeners::repeater() { return repeater_; }

// Sets the default_result_printer attribute to the provided listener.
// The listener is also added to the listener list and previous
// default_result_printer is removed from it and deleted. The listener can
// also be NULL in which case it will not be added to the list. Does
// nothing if the previous and the current listener objects are the same.
void TestEventListeners::SetDefaultResultPrinter(TestEventListener* listener) {
  if (default_result_printer_ != listener) {
    // It is an error to pass this method a listener that is already in the
    // list.
    delete Release(default_result_printer_);
    default_result_printer_ = listener;
    if (listener != NULL)
      Append(listener);
  }
}

// Sets the default_xml_generator attribute to the provided listener.  The
// listener is also added to the listener list and previous
// default_xml_generator is removed from it and deleted. The listener can
// also be NULL in which case it will not be added to the list. Does
// nothing if the previous and the current listener objects are the same.
void TestEventListeners::SetDefaultXmlGenerator(TestEventListener* listener) {
  if (default_xml_generator_ != listener) {
    // It is an error to pass this method a listener that is already in the
    // list.
    delete Release(default_xml_generator_);
    default_xml_generator_ = listener;
    if (listener != NULL)
      Append(listener);
  }
}

// Controls whether events will be forwarded by the repeater to the
// listeners in the list.
bool TestEventListeners::EventForwardingEnabled() const {
  return repeater_->forwarding_enabled();
}

void TestEventListeners::SuppressEventForwarding() {
  repeater_->set_forwarding_enabled(false);
}

// class UnitTest

// Gets the singleton UnitTest object.  The first time this method is
// called, a UnitTest object is constructed and returned.  Consecutive
// calls will return the same object.
//
// We don't protect this under mutex_ as a user is not supposed to
// call this before main() starts, from which point on the return
// value will never change.
UnitTest* UnitTest::GetInstance() {
  // When compiled with MSVC 7.1 in optimized mode, destroying the
  // UnitTest object upon exiting the program messes up the exit code,
  // causing successful tests to appear failed.  We have to use a
  // different implementation in this case to bypass the compiler bug.
  // This implementation makes the compiler happy, at the cost of
  // leaking the UnitTest object.

  // CodeGear C++Builder insists on a public destructor for the
  // default implementation.  Use this implementation to keep good OO
  // design with private destructor.

#if (_MSC_VER == 1310 && !defined(_DEBUG)) || defined(__BORLANDC__)
  static UnitTest* const instance = new UnitTest;
  return instance;
#else
  static UnitTest instance;
  return &instance;
#endif  // (_MSC_VER == 1310 && !defined(_DEBUG)) || defined(__BORLANDC__)
}

// Gets the number of successful test cases.
int UnitTest::successful_test_case_count() const {
  return impl()->successful_test_case_count();
}

// Gets the number of failed test cases.
int UnitTest::failed_test_case_count() const {
  return impl()->failed_test_case_count();
}

// Gets the number of all test cases.
int UnitTest::total_test_case_count() const {
  return impl()->total_test_case_count();
}

// Gets the number of all test cases that contain at least one test
// that should run.
int UnitTest::test_case_to_run_count() const {
  return impl()->test_case_to_run_count();
}

// Gets the number of successful tests.
int UnitTest::successful_test_count() const {
  return impl()->successful_test_count();
}

// Gets the number of failed tests.
int UnitTest::failed_test_count() const { return impl()->failed_test_count(); }

// Gets the number of disabled tests that will be reported in the XML report.
int UnitTest::reportable_disabled_test_count() const {
  return impl()->reportable_disabled_test_count();
}

// Gets the number of disabled tests.
int UnitTest::disabled_test_count() const {
  return impl()->disabled_test_count();
}

// Gets the number of tests to be printed in the XML report.
int UnitTest::reportable_test_count() const {
  return impl()->reportable_test_count();
}

// Gets the number of all tests.
int UnitTest::total_test_count() const { return impl()->total_test_count(); }

// Gets the number of tests that should run.
int UnitTest::test_to_run_count() const { return impl()->test_to_run_count(); }

// Gets the time of the test program start, in ms from the start of the
// UNIX epoch.
internal::TimeInMillis UnitTest::start_timestamp() const {
    return impl()->start_timestamp();
}

// Gets the elapsed time, in milliseconds.
internal::TimeInMillis UnitTest::elapsed_time() const {
  return impl()->elapsed_time();
}

// Returns true iff the unit test passed (i.e. all test cases passed).
bool UnitTest::Passed() const { return impl()->Passed(); }

// Returns true iff the unit test failed (i.e. some test case failed
// or something outside of all tests failed).
bool UnitTest::Failed() const { return impl()->Failed(); }

// Gets the i-th test case among all the test cases. i can range from 0 to
// total_test_case_count() - 1. If i is not in that range, returns NULL.
const TestCase* UnitTest::GetTestCase(int i) const {
  return impl()->GetTestCase(i);
}

// Returns the TestResult containing information on test failures and
// properties logged outside of individual test cases.
const TestResult& UnitTest::ad_hoc_test_result() const {
  return *impl()->ad_hoc_test_result();
}

// Gets the i-th test case among all the test cases. i can range from 0 to
// total_test_case_count() - 1. If i is not in that range, returns NULL.
TestCase* UnitTest::GetMutableTestCase(int i) {
  return impl()->GetMutableTestCase(i);
}

// Returns the list of event listeners that can be used to track events
// inside Google Test.
TestEventListeners& UnitTest::listeners() {
  return *impl()->listeners();
}

// Registers and returns a global test environment.  When a test
// program is run, all global test environments will be set-up in the
// order they were registered.  After all tests in the program have
// finished, all global test environments will be torn-down in the
// *reverse* order they were registered.
//
// The UnitTest object takes ownership of the given environment.
//
// We don't protect this under mutex_, as we only support calling it
// from the main thread.
Environment* UnitTest::AddEnvironment(Environment* env) {
  if (env == NULL) {
    return NULL;
  }

  impl_->environments().push_back(env);
  return env;
}

// Adds a TestPartResult to the current TestResult object.  All Google Test
// assertion macros (e.g. ASSERT_TRUE, EXPECT_EQ, etc) eventually call
// this to report their results.  The user code should use the
// assertion macros instead of calling this directly.
void UnitTest::AddTestPartResult(
    TestPartResult::Type result_type,
    const char* file_name,
    int line_number,
    const std::string& message,
    const std::string& os_stack_trace) GTEST_LOCK_EXCLUDED_(mutex_) {
  Message msg;
  msg << message;

  internal::MutexLock lock(&mutex_);
  if (impl_->gtest_trace_stack().size() > 0) {
    msg << "\n" << GTEST_NAME_ << " trace:";

    for (int i = static_cast(impl_->gtest_trace_stack().size());
         i > 0; --i) {
      const internal::TraceInfo& trace = impl_->gtest_trace_stack()[i - 1];
      msg << "\n" << internal::FormatFileLocation(trace.file, trace.line)
          << " " << trace.message;
    }
  }

  if (os_stack_trace.c_str() != NULL && !os_stack_trace.empty()) {
    msg << internal::kStackTraceMarker << os_stack_trace;
  }

  const TestPartResult result =
    TestPartResult(result_type, file_name, line_number,
                   msg.GetString().c_str());
  impl_->GetTestPartResultReporterForCurrentThread()->
      ReportTestPartResult(result);

  if (result_type != TestPartResult::kSuccess) {
    // gtest_break_on_failure takes precedence over
    // gtest_throw_on_failure.  This allows a user to set the latter
    // in the code (perhaps in order to use Google Test assertions
    // with another testing framework) and specify the former on the
    // command line for debugging.
    if (GTEST_FLAG(break_on_failure)) {
#if GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_PHONE && !GTEST_OS_WINDOWS_RT
      // Using DebugBreak on Windows allows gtest to still break into a debugger
      // when a failure happens and both the --gtest_break_on_failure and
      // the --gtest_catch_exceptions flags are specified.
      DebugBreak();
#else
      // Dereference NULL through a volatile pointer to prevent the compiler
      // from removing. We use this rather than abort() or __builtin_trap() for
      // portability: Symbian doesn't implement abort() well, and some debuggers
      // don't correctly trap abort().
      *static_cast(NULL) = 1;
#endif  // GTEST_OS_WINDOWS
    } else if (GTEST_FLAG(throw_on_failure)) {
#if GTEST_HAS_EXCEPTIONS
      throw internal::GoogleTestFailureException(result);
#else
      // We cannot call abort() as it generates a pop-up in debug mode
      // that cannot be suppressed in VC 7.1 or below.
      exit(1);
#endif
    }
  }
}

// Adds a TestProperty to the current TestResult object when invoked from
// inside a test, to current TestCase's ad_hoc_test_result_ when invoked
// from SetUpTestCase or TearDownTestCase, or to the global property set
// when invoked elsewhere.  If the result already contains a property with
// the same key, the value will be updated.
void UnitTest::RecordProperty(const std::string& key,
                              const std::string& value) {
  impl_->RecordProperty(TestProperty(key, value));
}

// Runs all tests in this UnitTest object and prints the result.
// Returns 0 if successful, or 1 otherwise.
//
// We don't protect this under mutex_, as we only support calling it
// from the main thread.
int UnitTest::Run() {
  const bool in_death_test_child_process =
      internal::GTEST_FLAG(internal_run_death_test).length() > 0;

  // Google Test implements this protocol for catching that a test
  // program exits before returning control to Google Test:
  //
  //   1. Upon start, Google Test creates a file whose absolute path
  //      is specified by the environment variable
  //      TEST_PREMATURE_EXIT_FILE.
  //   2. When Google Test has finished its work, it deletes the file.
  //
  // This allows a test runner to set TEST_PREMATURE_EXIT_FILE before
  // running a Google-Test-based test program and check the existence
  // of the file at the end of the test execution to see if it has
  // exited prematurely.

  // If we are in the child process of a death test, don't
  // create/delete the premature exit file, as doing so is unnecessary
  // and will confuse the parent process.  Otherwise, create/delete
  // the file upon entering/leaving this function.  If the program
  // somehow exits before this function has a chance to return, the
  // premature-exit file will be left undeleted, causing a test runner
  // that understands the premature-exit-file protocol to report the
  // test as having failed.
  const internal::ScopedPrematureExitFile premature_exit_file(
      in_death_test_child_process ?
      NULL : internal::posix::GetEnv("TEST_PREMATURE_EXIT_FILE"));

  // Captures the value of GTEST_FLAG(catch_exceptions).  This value will be
  // used for the duration of the program.
  impl()->set_catch_exceptions(GTEST_FLAG(catch_exceptions));

#if GTEST_HAS_SEH
  // Either the user wants Google Test to catch exceptions thrown by the
  // tests or this is executing in the context of death test child
  // process. In either case the user does not want to see pop-up dialogs
  // about crashes - they are expected.
  if (impl()->catch_exceptions() || in_death_test_child_process) {
# if !GTEST_OS_WINDOWS_MOBILE && !GTEST_OS_WINDOWS_PHONE && !GTEST_OS_WINDOWS_RT
    // SetErrorMode doesn't exist on CE.
    SetErrorMode(SEM_FAILCRITICALERRORS | SEM_NOALIGNMENTFAULTEXCEPT |
                 SEM_NOGPFAULTERRORBOX | SEM_NOOPENFILEERRORBOX);
# endif  // !GTEST_OS_WINDOWS_MOBILE

# if (defined(_MSC_VER) || GTEST_OS_WINDOWS_MINGW) && !GTEST_OS_WINDOWS_MOBILE
    // Death test children can be terminated with _abort().  On Windows,
    // _abort() can show a dialog with a warning message.  This forces the
    // abort message to go to stderr instead.
    _set_error_mode(_OUT_TO_STDERR);
# endif

# if _MSC_VER >= 1400 && !GTEST_OS_WINDOWS_MOBILE
    // In the debug version, Visual Studio pops up a separate dialog
    // offering a choice to debug the aborted program. We need to suppress
    // this dialog or it will pop up for every EXPECT/ASSERT_DEATH statement
    // executed. Google Test will notify the user of any unexpected
    // failure via stderr.
    //
    // VC++ doesn't define _set_abort_behavior() prior to the version 8.0.
    // Users of prior VC versions shall suffer the agony and pain of
    // clicking through the countless debug dialogs.
    // TODO(vladl@google.com): find a way to suppress the abort dialog() in the
    // debug mode when compiled with VC 7.1 or lower.
    if (!GTEST_FLAG(break_on_failure))
      _set_abort_behavior(
          0x0,                                    // Clear the following flags:
          _WRITE_ABORT_MSG | _CALL_REPORTFAULT);  // pop-up window, core dump.
# endif
  }
#endif  // GTEST_HAS_SEH

  return internal::HandleExceptionsInMethodIfSupported(
      impl(),
      &internal::UnitTestImpl::RunAllTests,
      "auxiliary test code (environments or event listeners)") ? 0 : 1;
}

// Returns the working directory when the first TEST() or TEST_F() was
// executed.
const char* UnitTest::original_working_dir() const {
  return impl_->original_working_dir_.c_str();
}

// Returns the TestCase object for the test that's currently running,
// or NULL if no test is running.
const TestCase* UnitTest::current_test_case() const
    GTEST_LOCK_EXCLUDED_(mutex_) {
  internal::MutexLock lock(&mutex_);
  return impl_->current_test_case();
}

// Returns the TestInfo object for the test that's currently running,
// or NULL if no test is running.
const TestInfo* UnitTest::current_test_info() const
    GTEST_LOCK_EXCLUDED_(mutex_) {
  internal::MutexLock lock(&mutex_);
  return impl_->current_test_info();
}

// Returns the random seed used at the start of the current test run.
int UnitTest::random_seed() const { return impl_->random_seed(); }

#if GTEST_HAS_PARAM_TEST
// Returns ParameterizedTestCaseRegistry object used to keep track of
// value-parameterized tests and instantiate and register them.
internal::ParameterizedTestCaseRegistry&
    UnitTest::parameterized_test_registry()
        GTEST_LOCK_EXCLUDED_(mutex_) {
  return impl_->parameterized_test_registry();
}
#endif  // GTEST_HAS_PARAM_TEST

// Creates an empty UnitTest.
UnitTest::UnitTest() {
  impl_ = new internal::UnitTestImpl(this);
}

// Destructor of UnitTest.
UnitTest::~UnitTest() {
  delete impl_;
}

// Pushes a trace defined by SCOPED_TRACE() on to the per-thread
// Google Test trace stack.
void UnitTest::PushGTestTrace(const internal::TraceInfo& trace)
    GTEST_LOCK_EXCLUDED_(mutex_) {
  internal::MutexLock lock(&mutex_);
  impl_->gtest_trace_stack().push_back(trace);
}

// Pops a trace from the per-thread Google Test trace stack.
void UnitTest::PopGTestTrace()
    GTEST_LOCK_EXCLUDED_(mutex_) {
  internal::MutexLock lock(&mutex_);
  impl_->gtest_trace_stack().pop_back();
}

namespace internal {

UnitTestImpl::UnitTestImpl(UnitTest* parent)
    : parent_(parent),
      GTEST_DISABLE_MSC_WARNINGS_PUSH_(4355 /* using this in initializer */)
      default_global_test_part_result_reporter_(this),
      default_per_thread_test_part_result_reporter_(this),
      GTEST_DISABLE_MSC_WARNINGS_POP_()
      global_test_part_result_repoter_(
          &default_global_test_part_result_reporter_),
      per_thread_test_part_result_reporter_(
          &default_per_thread_test_part_result_reporter_),
#if GTEST_HAS_PARAM_TEST
      parameterized_test_registry_(),
      parameterized_tests_registered_(false),
#endif  // GTEST_HAS_PARAM_TEST
      last_death_test_case_(-1),
      current_test_case_(NULL),
      current_test_info_(NULL),
      ad_hoc_test_result_(),
      os_stack_trace_getter_(NULL),
      post_flag_parse_init_performed_(false),
      random_seed_(0),  // Will be overridden by the flag before first use.
      random_(0),  // Will be reseeded before first use.
      start_timestamp_(0),
      elapsed_time_(0),
#if GTEST_HAS_DEATH_TEST
      death_test_factory_(new DefaultDeathTestFactory),
#endif
      // Will be overridden by the flag before first use.
      catch_exceptions_(false) {
  listeners()->SetDefaultResultPrinter(new PrettyUnitTestResultPrinter);
}

UnitTestImpl::~UnitTestImpl() {
  // Deletes every TestCase.
  ForEach(test_cases_, internal::Delete);

  // Deletes every Environment.
  ForEach(environments_, internal::Delete);

  delete os_stack_trace_getter_;
}

// Adds a TestProperty to the current TestResult object when invoked in a
// context of a test, to current test case's ad_hoc_test_result when invoke
// from SetUpTestCase/TearDownTestCase, or to the global property set
// otherwise.  If the result already contains a property with the same key,
// the value will be updated.
void UnitTestImpl::RecordProperty(const TestProperty& test_property) {
  std::string xml_element;
  TestResult* test_result;  // TestResult appropriate for property recording.

  if (current_test_info_ != NULL) {
    xml_element = "testcase";
    test_result = &(current_test_info_->result_);
  } else if (current_test_case_ != NULL) {
    xml_element = "testsuite";
    test_result = &(current_test_case_->ad_hoc_test_result_);
  } else {
    xml_element = "testsuites";
    test_result = &ad_hoc_test_result_;
  }
  test_result->RecordProperty(xml_element, test_property);
}

#if GTEST_HAS_DEATH_TEST
// Disables event forwarding if the control is currently in a death test
// subprocess. Must not be called before InitGoogleTest.
void UnitTestImpl::SuppressTestEventsIfInSubprocess() {
  if (internal_run_death_test_flag_.get() != NULL)
    listeners()->SuppressEventForwarding();
}
#endif  // GTEST_HAS_DEATH_TEST

// Initializes event listeners performing XML output as specified by
// UnitTestOptions. Must not be called before InitGoogleTest.
void UnitTestImpl::ConfigureXmlOutput() {
  const std::string& output_format = UnitTestOptions::GetOutputFormat();
  if (output_format == "xml") {
    listeners()->SetDefaultXmlGenerator(new XmlUnitTestResultPrinter(
        UnitTestOptions::GetAbsolutePathToOutputFile().c_str()));
  } else if (output_format == "tap") {
    listeners()->SetDefaultXmlGenerator(new TapUnitTestResultPrinter(
        UnitTestOptions::GetAbsolutePathToOutputFile().c_str()));
  } else if (output_format != "") {
    printf("WARNING: unrecognized output format \"%s\" ignored.\n",
           output_format.c_str());
    fflush(stdout);
  }
}

#if GTEST_CAN_STREAM_RESULTS_
// Initializes event listeners for streaming test results in string form.
// Must not be called before InitGoogleTest.
void UnitTestImpl::ConfigureStreamingOutput() {
  const std::string& target = GTEST_FLAG(stream_result_to);
  if (!target.empty()) {
    const size_t pos = target.find(':');
    if (pos != std::string::npos) {
      listeners()->Append(new StreamingListener(target.substr(0, pos),
                                                target.substr(pos+1)));
    } else {
      printf("WARNING: unrecognized streaming target \"%s\" ignored.\n",
             target.c_str());
      fflush(stdout);
    }
  }
}
#endif  // GTEST_CAN_STREAM_RESULTS_

// Performs initialization dependent upon flag values obtained in
// ParseGoogleTestFlagsOnly.  Is called from InitGoogleTest after the call to
// ParseGoogleTestFlagsOnly.  In case a user neglects to call InitGoogleTest
// this function is also called from RunAllTests.  Since this function can be
// called more than once, it has to be idempotent.
void UnitTestImpl::PostFlagParsingInit() {
  // Ensures that this function does not execute more than once.
  if (!post_flag_parse_init_performed_) {
    post_flag_parse_init_performed_ = true;

#if GTEST_HAS_DEATH_TEST
    InitDeathTestSubprocessControlInfo();
    SuppressTestEventsIfInSubprocess();
#endif  // GTEST_HAS_DEATH_TEST

    // Registers parameterized tests. This makes parameterized tests
    // available to the UnitTest reflection API without running
    // RUN_ALL_TESTS.
    RegisterParameterizedTests();

    // Configures listeners for XML output. This makes it possible for users
    // to shut down the default XML output before invoking RUN_ALL_TESTS.
    ConfigureXmlOutput();

#if GTEST_CAN_STREAM_RESULTS_
    // Configures listeners for streaming test results to the specified server.
    ConfigureStreamingOutput();
#endif  // GTEST_CAN_STREAM_RESULTS_
  }
}

// A predicate that checks the name of a TestCase against a known
// value.
//
// This is used for implementation of the UnitTest class only.  We put
// it in the anonymous namespace to prevent polluting the outer
// namespace.
//
// TestCaseNameIs is copyable.
class TestCaseNameIs {
 public:
  // Constructor.
  explicit TestCaseNameIs(const std::string& name)
      : name_(name) {}

  // Returns true iff the name of test_case matches name_.
  bool operator()(const TestCase* test_case) const {
    return test_case != NULL && strcmp(test_case->name(), name_.c_str()) == 0;
  }

 private:
  std::string name_;
};

// Finds and returns a TestCase with the given name.  If one doesn't
// exist, creates one and returns it.  It's the CALLER'S
// RESPONSIBILITY to ensure that this function is only called WHEN THE
// TESTS ARE NOT SHUFFLED.
//
// Arguments:
//
//   test_case_name: name of the test case
//   type_param:     the name of the test case's type parameter, or NULL if
//                   this is not a typed or a type-parameterized test case.
//   set_up_tc:      pointer to the function that sets up the test case
//   tear_down_tc:   pointer to the function that tears down the test case
TestCase* UnitTestImpl::GetTestCase(const char* test_case_name,
                                    const char* type_param,
                                    Test::SetUpTestCaseFunc set_up_tc,
                                    Test::TearDownTestCaseFunc tear_down_tc) {
  // Can we find a TestCase with the given name?
  const std::vector::const_iterator test_case =
      std::find_if(test_cases_.begin(), test_cases_.end(),
                   TestCaseNameIs(test_case_name));

  if (test_case != test_cases_.end())
    return *test_case;

  // No.  Let's create one.
  TestCase* const new_test_case =
      new TestCase(test_case_name, type_param, set_up_tc, tear_down_tc);

  // Is this a death test case?
  if (internal::UnitTestOptions::MatchesFilter(test_case_name,
                                               kDeathTestCaseFilter)) {
    // Yes.  Inserts the test case after the last death test case
    // defined so far.  This only works when the test cases haven't
    // been shuffled.  Otherwise we may end up running a death test
    // after a non-death test.
    ++last_death_test_case_;
    test_cases_.insert(test_cases_.begin() + last_death_test_case_,
                       new_test_case);
  } else {
    // No.  Appends to the end of the list.
    test_cases_.push_back(new_test_case);
  }

  test_case_indices_.push_back(static_cast(test_case_indices_.size()));
  return new_test_case;
}

// Helpers for setting up / tearing down the given environment.  They
// are for use in the ForEach() function.
static void SetUpEnvironment(Environment* env) { env->SetUp(); }
static void TearDownEnvironment(Environment* env) { env->TearDown(); }

// Runs all tests in this UnitTest object, prints the result, and
// returns true if all tests are successful.  If any exception is
// thrown during a test, the test is considered to be failed, but the
// rest of the tests will still be run.
//
// When parameterized tests are enabled, it expands and registers
// parameterized tests first in RegisterParameterizedTests().
// All other functions called from RunAllTests() may safely assume that
// parameterized tests are ready to be counted and run.
bool UnitTestImpl::RunAllTests() {
  // Makes sure InitGoogleTest() was called.
  if (!GTestIsInitialized()) {
    printf("%s",
           "\nThis test program did NOT call ::testing::InitGoogleTest "
           "before calling RUN_ALL_TESTS().  Please fix it.\n");
    return false;
  }

  // Do not run any test if the --help flag was specified.
  if (g_help_flag)
    return true;

  // Repeats the call to the post-flag parsing initialization in case the
  // user didn't call InitGoogleTest.
  PostFlagParsingInit();

  // Even if sharding is not on, test runners may want to use the
  // GTEST_SHARD_STATUS_FILE to query whether the test supports the sharding
  // protocol.
  internal::WriteToShardStatusFileIfNeeded();

  // True iff we are in a subprocess for running a thread-safe-style
  // death test.
  bool in_subprocess_for_death_test = false;

#if GTEST_HAS_DEATH_TEST
  in_subprocess_for_death_test = (internal_run_death_test_flag_.get() != NULL);
#endif  // GTEST_HAS_DEATH_TEST

  const bool should_shard = ShouldShard(kTestTotalShards, kTestShardIndex,
                                        in_subprocess_for_death_test);

  // Compares the full test names with the filter to decide which
  // tests to run.
  const bool has_tests_to_run = FilterTests(should_shard
                                              ? HONOR_SHARDING_PROTOCOL
                                              : IGNORE_SHARDING_PROTOCOL) > 0;

  // Lists the tests and exits if the --gtest_list_tests flag was specified.
  if (GTEST_FLAG(list_tests)) {
    // This must be called *after* FilterTests() has been called.
    ListTestsMatchingFilter();
    return true;
  }

  random_seed_ = GTEST_FLAG(shuffle) ?
      GetRandomSeedFromFlag(GTEST_FLAG(random_seed)) : 0;

  // True iff at least one test has failed.
  bool failed = false;

  TestEventListener* repeater = listeners()->repeater();

  start_timestamp_ = GetTimeInMillis();
  repeater->OnTestProgramStart(*parent_);

  // How many times to repeat the tests?  We don't want to repeat them
  // when we are inside the subprocess of a death test.
  const int repeat = in_subprocess_for_death_test ? 1 : GTEST_FLAG(repeat);
  // Repeats forever if the repeat count is negative.
  const bool forever = repeat < 0;
  for (int i = 0; forever || i != repeat; i++) {
    // We want to preserve failures generated by ad-hoc test
    // assertions executed before RUN_ALL_TESTS().
    ClearNonAdHocTestResult();

    const TimeInMillis start = GetTimeInMillis();

    // Shuffles test cases and tests if requested.
    if (has_tests_to_run && GTEST_FLAG(shuffle)) {
      random()->Reseed(random_seed_);
      // This should be done before calling OnTestIterationStart(),
      // such that a test event listener can see the actual test order
      // in the event.
      ShuffleTests();
    }

    // Tells the unit test event listeners that the tests are about to start.
    repeater->OnTestIterationStart(*parent_, i);

    // Runs each test case if there is at least one test to run.
    if (has_tests_to_run) {
      // Sets up all environments beforehand.
      repeater->OnEnvironmentsSetUpStart(*parent_);
      ForEach(environments_, SetUpEnvironment);
      repeater->OnEnvironmentsSetUpEnd(*parent_);

      // Runs the tests only if there was no fatal failure during global
      // set-up.
      if (!Test::HasFatalFailure()) {
        for (int test_index = 0; test_index < total_test_case_count();
             test_index++) {
          GetMutableTestCase(test_index)->Run();
        }
      }

      // Tears down all environments in reverse order afterwards.
      repeater->OnEnvironmentsTearDownStart(*parent_);
      std::for_each(environments_.rbegin(), environments_.rend(),
                    TearDownEnvironment);
      repeater->OnEnvironmentsTearDownEnd(*parent_);
    }

    elapsed_time_ = GetTimeInMillis() - start;

    // Tells the unit test event listener that the tests have just finished.
    repeater->OnTestIterationEnd(*parent_, i);

    // Gets the result and clears it.
    if (!Passed()) {
      failed = true;
    }

    // Restores the original test order after the iteration.  This
    // allows the user to quickly repro a failure that happens in the
    // N-th iteration without repeating the first (N - 1) iterations.
    // This is not enclosed in "if (GTEST_FLAG(shuffle)) { ... }", in
    // case the user somehow changes the value of the flag somewhere
    // (it's always safe to unshuffle the tests).
    UnshuffleTests();

    if (GTEST_FLAG(shuffle)) {
      // Picks a new random seed for each iteration.
      random_seed_ = GetNextRandomSeed(random_seed_);
    }
  }

  repeater->OnTestProgramEnd(*parent_);

  return !failed;
}

// Reads the GTEST_SHARD_STATUS_FILE environment variable, and creates the file
// if the variable is present. If a file already exists at this location, this
// function will write over it. If the variable is present, but the file cannot
// be created, prints an error and exits.
void WriteToShardStatusFileIfNeeded() {
  const char* const test_shard_file = posix::GetEnv(kTestShardStatusFile);
  if (test_shard_file != NULL) {
    FILE* const file = posix::FOpen(test_shard_file, "w");
    if (file == NULL) {
      ColoredPrintf(COLOR_RED,
                    "Could not write to the test shard status file \"%s\" "
                    "specified by the %s environment variable.\n",
                    test_shard_file, kTestShardStatusFile);
      fflush(stdout);
      exit(EXIT_FAILURE);
    }
    fclose(file);
  }
}

// Checks whether sharding is enabled by examining the relevant
// environment variable values. If the variables are present,
// but inconsistent (i.e., shard_index >= total_shards), prints
// an error and exits. If in_subprocess_for_death_test, sharding is
// disabled because it must only be applied to the original test
// process. Otherwise, we could filter out death tests we intended to execute.
bool ShouldShard(const char* total_shards_env,
                 const char* shard_index_env,
                 bool in_subprocess_for_death_test) {
  if (in_subprocess_for_death_test) {
    return false;
  }

  const Int32 total_shards = Int32FromEnvOrDie(total_shards_env, -1);
  const Int32 shard_index = Int32FromEnvOrDie(shard_index_env, -1);

  if (total_shards == -1 && shard_index == -1) {
    return false;
  } else if (total_shards == -1 && shard_index != -1) {
    const Message msg = Message()
      << "Invalid environment variables: you have "
      << kTestShardIndex << " = " << shard_index
      << ", but have left " << kTestTotalShards << " unset.\n";
    ColoredPrintf(COLOR_RED, msg.GetString().c_str());
    fflush(stdout);
    exit(EXIT_FAILURE);
  } else if (total_shards != -1 && shard_index == -1) {
    const Message msg = Message()
      << "Invalid environment variables: you have "
      << kTestTotalShards << " = " << total_shards
      << ", but have left " << kTestShardIndex << " unset.\n";
    ColoredPrintf(COLOR_RED, msg.GetString().c_str());
    fflush(stdout);
    exit(EXIT_FAILURE);
  } else if (shard_index < 0 || shard_index >= total_shards) {
    const Message msg = Message()
      << "Invalid environment variables: we require 0 <= "
      << kTestShardIndex << " < " << kTestTotalShards
      << ", but you have " << kTestShardIndex << "=" << shard_index
      << ", " << kTestTotalShards << "=" << total_shards << ".\n";
    ColoredPrintf(COLOR_RED, msg.GetString().c_str());
    fflush(stdout);
    exit(EXIT_FAILURE);
  }

  return total_shards > 1;
}

// Parses the environment variable var as an Int32. If it is unset,
// returns default_val. If it is not an Int32, prints an error
// and aborts.
Int32 Int32FromEnvOrDie(const char* var, Int32 default_val) {
  const char* str_val = posix::GetEnv(var);
  if (str_val == NULL) {
    return default_val;
  }

  Int32 result;
  if (!ParseInt32(Message() << "The value of environment variable " << var,
                  str_val, &result)) {
    exit(EXIT_FAILURE);
  }
  return result;
}

// Given the total number of shards, the shard index, and the test id,
// returns true iff the test should be run on this shard. The test id is
// some arbitrary but unique non-negative integer assigned to each test
// method. Assumes that 0 <= shard_index < total_shards.
bool ShouldRunTestOnShard(int total_shards, int shard_index, int test_id) {
  return (test_id % total_shards) == shard_index;
}

// Compares the name of each test with the user-specified filter to
// decide whether the test should be run, then records the result in
// each TestCase and TestInfo object.
// If shard_tests == true, further filters tests based on sharding
// variables in the environment - see
// http://code.google.com/p/googletest/wiki/GoogleTestAdvancedGuide.
// Returns the number of tests that should run.
int UnitTestImpl::FilterTests(ReactionToSharding shard_tests) {
  const Int32 total_shards = shard_tests == HONOR_SHARDING_PROTOCOL ?
      Int32FromEnvOrDie(kTestTotalShards, -1) : -1;
  const Int32 shard_index = shard_tests == HONOR_SHARDING_PROTOCOL ?
      Int32FromEnvOrDie(kTestShardIndex, -1) : -1;

  // num_runnable_tests are the number of tests that will
  // run across all shards (i.e., match filter and are not disabled).
  // num_selected_tests are the number of tests to be run on
  // this shard.
  int num_runnable_tests = 0;
  int num_selected_tests = 0;
  for (size_t i = 0; i < test_cases_.size(); i++) {
    TestCase* const test_case = test_cases_[i];
    const std::string &test_case_name = test_case->name();
    test_case->set_should_run(false);

    for (size_t j = 0; j < test_case->test_info_list().size(); j++) {
      TestInfo* const test_info = test_case->test_info_list()[j];
      const std::string test_name(test_info->name());
      // A test is disabled if test case name or test name matches
      // kDisableTestFilter.
      const bool is_disabled =
          internal::UnitTestOptions::MatchesFilter(test_case_name,
                                                   kDisableTestFilter) ||
          internal::UnitTestOptions::MatchesFilter(test_name,
                                                   kDisableTestFilter);
      test_info->is_disabled_ = is_disabled;

      const bool matches_filter =
          internal::UnitTestOptions::FilterMatchesTest(test_case_name,
                                                       test_name);
      test_info->matches_filter_ = matches_filter;

      const bool is_runnable =
          (GTEST_FLAG(also_run_disabled_tests) || !is_disabled) &&
          matches_filter;

      const bool is_selected = is_runnable &&
          (shard_tests == IGNORE_SHARDING_PROTOCOL ||
           ShouldRunTestOnShard(total_shards, shard_index,
                                num_runnable_tests));

      num_runnable_tests += is_runnable;
      num_selected_tests += is_selected;

      test_info->should_run_ = is_selected;
      test_case->set_should_run(test_case->should_run() || is_selected);
    }
  }
  return num_selected_tests;
}

// Prints the given C-string on a single line by replacing all '\n'
// characters with string "\\n".  If the output takes more than
// max_length characters, only prints the first max_length characters
// and "...".
static void PrintOnOneLine(const char* str, int max_length) {
  if (str != NULL) {
    for (int i = 0; *str != '\0'; ++str) {
      if (i >= max_length) {
        printf("...");
        break;
      }
      if (*str == '\n') {
        printf("\\n");
        i += 2;
      } else {
        printf("%c", *str);
        ++i;
      }
    }
  }
}

// Prints the names of the tests matching the user-specified filter flag.
void UnitTestImpl::ListTestsMatchingFilter() {
  // Print at most this many characters for each type/value parameter.
  const int kMaxParamLength = 250;

  for (size_t i = 0; i < test_cases_.size(); i++) {
    const TestCase* const test_case = test_cases_[i];
    bool printed_test_case_name = false;

    for (size_t j = 0; j < test_case->test_info_list().size(); j++) {
      const TestInfo* const test_info =
          test_case->test_info_list()[j];
      if (test_info->matches_filter_) {
        if (!printed_test_case_name) {
          printed_test_case_name = true;
          printf("%s.", test_case->name());
          if (test_case->type_param() != NULL) {
            printf("  # %s = ", kTypeParamLabel);
            // We print the type parameter on a single line to make
            // the output easy to parse by a program.
            PrintOnOneLine(test_case->type_param(), kMaxParamLength);
          }
          printf("\n");
        }
        printf("  %s", test_info->name());
        if (test_info->value_param() != NULL) {
          printf("  # %s = ", kValueParamLabel);
          // We print the value parameter on a single line to make the
          // output easy to parse by a program.
          PrintOnOneLine(test_info->value_param(), kMaxParamLength);
        }
        printf("\n");
      }
    }
  }
  fflush(stdout);
}

// Sets the OS stack trace getter.
//
// Does nothing if the input and the current OS stack trace getter are
// the same; otherwise, deletes the old getter and makes the input the
// current getter.
void UnitTestImpl::set_os_stack_trace_getter(
    OsStackTraceGetterInterface* getter) {
  if (os_stack_trace_getter_ != getter) {
    delete os_stack_trace_getter_;
    os_stack_trace_getter_ = getter;
  }
}

// Returns the current OS stack trace getter if it is not NULL;
// otherwise, creates an OsStackTraceGetter, makes it the current
// getter, and returns it.
OsStackTraceGetterInterface* UnitTestImpl::os_stack_trace_getter() {
  if (os_stack_trace_getter_ == NULL) {
    os_stack_trace_getter_ = new OsStackTraceGetter;
  }

  return os_stack_trace_getter_;
}

// Returns the TestResult for the test that's currently running, or
// the TestResult for the ad hoc test if no test is running.
TestResult* UnitTestImpl::current_test_result() {
  return current_test_info_ ?
      &(current_test_info_->result_) : &ad_hoc_test_result_;
}

// Shuffles all test cases, and the tests within each test case,
// making sure that death tests are still run first.
void UnitTestImpl::ShuffleTests() {
  // Shuffles the death test cases.
  ShuffleRange(random(), 0, last_death_test_case_ + 1, &test_case_indices_);

  // Shuffles the non-death test cases.
  ShuffleRange(random(), last_death_test_case_ + 1,
               static_cast(test_cases_.size()), &test_case_indices_);

  // Shuffles the tests inside each test case.
  for (size_t i = 0; i < test_cases_.size(); i++) {
    test_cases_[i]->ShuffleTests(random());
  }
}

// Restores the test cases and tests to their order before the first shuffle.
void UnitTestImpl::UnshuffleTests() {
  for (size_t i = 0; i < test_cases_.size(); i++) {
    // Unshuffles the tests in each test case.
    test_cases_[i]->UnshuffleTests();
    // Resets the index of each test case.
    test_case_indices_[i] = static_cast(i);
  }
}

// Returns the current OS stack trace as an std::string.
//
// The maximum number of stack frames to be included is specified by
// the gtest_stack_trace_depth flag.  The skip_count parameter
// specifies the number of top frames to be skipped, which doesn't
// count against the number of frames to be included.
//
// For example, if Foo() calls Bar(), which in turn calls
// GetCurrentOsStackTraceExceptTop(..., 1), Foo() will be included in
// the trace but Bar() and GetCurrentOsStackTraceExceptTop() won't.
std::string GetCurrentOsStackTraceExceptTop(UnitTest* /*unit_test*/,
                                            int skip_count) {
  // We pass skip_count + 1 to skip this wrapper function in addition
  // to what the user really wants to skip.
  return GetUnitTestImpl()->CurrentOsStackTraceExceptTop(skip_count + 1);
}

// Used by the GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_ macro to
// suppress unreachable code warnings.
namespace {
class ClassUniqueToAlwaysTrue {};
}

bool IsTrue(bool condition) { return condition; }

bool AlwaysTrue() {
#if GTEST_HAS_EXCEPTIONS
  // This condition is always false so AlwaysTrue() never actually throws,
  // but it makes the compiler think that it may throw.
  if (IsTrue(false))
    throw ClassUniqueToAlwaysTrue();
#endif  // GTEST_HAS_EXCEPTIONS
  return true;
}

// If *pstr starts with the given prefix, modifies *pstr to be right
// past the prefix and returns true; otherwise leaves *pstr unchanged
// and returns false.  None of pstr, *pstr, and prefix can be NULL.
bool SkipPrefix(const char* prefix, const char** pstr) {
  const size_t prefix_len = strlen(prefix);
  if (strncmp(*pstr, prefix, prefix_len) == 0) {
    *pstr += prefix_len;
    return true;
  }
  return false;
}

// Parses a string as a command line flag.  The string should have
// the format "--flag=value".  When def_optional is true, the "=value"
// part can be omitted.
//
// Returns the value of the flag, or NULL if the parsing failed.
const char* ParseFlagValue(const char* str,
                           const char* flag,
                           bool def_optional) {
  // str and flag must not be NULL.
  if (str == NULL || flag == NULL) return NULL;

  // The flag must start with "--" followed by GTEST_FLAG_PREFIX_.
  const std::string flag_str = std::string("--") + GTEST_FLAG_PREFIX_ + flag;
  const size_t flag_len = flag_str.length();
  if (strncmp(str, flag_str.c_str(), flag_len) != 0) return NULL;

  // Skips the flag name.
  const char* flag_end = str + flag_len;

  // When def_optional is true, it's OK to not have a "=value" part.
  if (def_optional && (flag_end[0] == '\0')) {
    return flag_end;
  }

  // If def_optional is true and there are more characters after the
  // flag name, or if def_optional is false, there must be a '=' after
  // the flag name.
  if (flag_end[0] != '=') return NULL;

  // Returns the string after "=".
  return flag_end + 1;
}

// Parses a string for a bool flag, in the form of either
// "--flag=value" or "--flag".
//
// In the former case, the value is taken as true as long as it does
// not start with '0', 'f', or 'F'.
//
// In the latter case, the value is taken as true.
//
// On success, stores the value of the flag in *value, and returns
// true.  On failure, returns false without changing *value.
bool ParseBoolFlag(const char* str, const char* flag, bool* value) {
  // Gets the value of the flag as a string.
  const char* const value_str = ParseFlagValue(str, flag, true);

  // Aborts if the parsing failed.
  if (value_str == NULL) return false;

  // Converts the string value to a bool.
  *value = !(*value_str == '0' || *value_str == 'f' || *value_str == 'F');
  return true;
}

// Parses a string for an Int32 flag, in the form of
// "--flag=value".
//
// On success, stores the value of the flag in *value, and returns
// true.  On failure, returns false without changing *value.
bool ParseInt32Flag(const char* str, const char* flag, Int32* value) {
  // Gets the value of the flag as a string.
  const char* const value_str = ParseFlagValue(str, flag, false);

  // Aborts if the parsing failed.
  if (value_str == NULL) return false;

  // Sets *value to the value of the flag.
  return ParseInt32(Message() << "The value of flag --" << flag,
                    value_str, value);
}

// Parses a string for a string flag, in the form of
// "--flag=value".
//
// On success, stores the value of the flag in *value, and returns
// true.  On failure, returns false without changing *value.
bool ParseStringFlag(const char* str, const char* flag, std::string* value) {
  // Gets the value of the flag as a string.
  const char* const value_str = ParseFlagValue(str, flag, false);

  // Aborts if the parsing failed.
  if (value_str == NULL) return false;

  // Sets *value to the value of the flag.
  *value = value_str;
  return true;
}

// Determines whether a string has a prefix that Google Test uses for its
// flags, i.e., starts with GTEST_FLAG_PREFIX_ or GTEST_FLAG_PREFIX_DASH_.
// If Google Test detects that a command line flag has its prefix but is not
// recognized, it will print its help message. Flags starting with
// GTEST_INTERNAL_PREFIX_ followed by "internal_" are considered Google Test
// internal flags and do not trigger the help message.
static bool HasGoogleTestFlagPrefix(const char* str) {
  return (SkipPrefix("--", &str) ||
          SkipPrefix("-", &str) ||
          SkipPrefix("/", &str)) &&
         !SkipPrefix(GTEST_FLAG_PREFIX_ "internal_", &str) &&
         (SkipPrefix(GTEST_FLAG_PREFIX_, &str) ||
          SkipPrefix(GTEST_FLAG_PREFIX_DASH_, &str));
}

// Prints a string containing code-encoded text.  The following escape
// sequences can be used in the string to control the text color:
//
//   @@    prints a single '@' character.
//   @R    changes the color to red.
//   @G    changes the color to green.
//   @Y    changes the color to yellow.
//   @D    changes to the default terminal text color.
//
// TODO(wan@google.com): Write tests for this once we add stdout
// capturing to Google Test.
static void PrintColorEncoded(const char* str) {
  GTestColor color = COLOR_DEFAULT;  // The current color.

  // Conceptually, we split the string into segments divided by escape
  // sequences.  Then we print one segment at a time.  At the end of
  // each iteration, the str pointer advances to the beginning of the
  // next segment.
  for (;;) {
    const char* p = strchr(str, '@');
    if (p == NULL) {
      ColoredPrintf(color, "%s", str);
      return;
    }

    ColoredPrintf(color, "%s", std::string(str, p).c_str());

    const char ch = p[1];
    str = p + 2;
    if (ch == '@') {
      ColoredPrintf(color, "@");
    } else if (ch == 'D') {
      color = COLOR_DEFAULT;
    } else if (ch == 'R') {
      color = COLOR_RED;
    } else if (ch == 'G') {
      color = COLOR_GREEN;
    } else if (ch == 'Y') {
      color = COLOR_YELLOW;
    } else {
      --str;
    }
  }
}

static const char kColorEncodedHelpMessage[] =
"This program contains tests written using " GTEST_NAME_ ". You can use the\n"
"following command line flags to control its behavior:\n"
"\n"
"Test Selection:\n"
"  @G--" GTEST_FLAG_PREFIX_ "list_tests@D\n"
"      List the names of all tests instead of running them. The name of\n"
"      TEST(Foo, Bar) is \"Foo.Bar\".\n"
"  @G--" GTEST_FLAG_PREFIX_ "filter=@YPOSTIVE_PATTERNS"
    "[@G-@YNEGATIVE_PATTERNS]@D\n"
"      Run only the tests whose name matches one of the positive patterns but\n"
"      none of the negative patterns. '?' matches any single character; '*'\n"
"      matches any substring; ':' separates two patterns.\n"
"  @G--" GTEST_FLAG_PREFIX_ "also_run_disabled_tests@D\n"
"      Run all disabled tests too.\n"
"\n"
"Test Execution:\n"
"  @G--" GTEST_FLAG_PREFIX_ "repeat=@Y[COUNT]@D\n"
"      Run the tests repeatedly; use a negative count to repeat forever.\n"
"  @G--" GTEST_FLAG_PREFIX_ "shuffle@D\n"
"      Randomize tests' orders on every iteration.\n"
"  @G--" GTEST_FLAG_PREFIX_ "random_seed=@Y[NUMBER]@D\n"
"      Random number seed to use for shuffling test orders (between 1 and\n"
"      99999, or 0 to use a seed based on the current time).\n"
"\n"
"Test Output:\n"
"  @G--" GTEST_FLAG_PREFIX_ "color=@Y(@Gyes@Y|@Gno@Y|@Gauto@Y)@D\n"
"      Enable/disable colored output. The default is @Gauto@D.\n"
"  -@G-" GTEST_FLAG_PREFIX_ "print_time=0@D\n"
"      Don't print the elapsed time of each test.\n"
"  @G--" GTEST_FLAG_PREFIX_ "output=xml@Y[@G:@YDIRECTORY_PATH@G"
    GTEST_PATH_SEP_ "@Y|@G:@YFILE_PATH]@D\n"
"      Generate an XML report in the given directory or with the given file\n"
"      name. @YFILE_PATH@D defaults to @Gtest_details.xml@D.\n"
#if GTEST_CAN_STREAM_RESULTS_
"  @G--" GTEST_FLAG_PREFIX_ "stream_result_to=@YHOST@G:@YPORT@D\n"
"      Stream test results to the given server.\n"
#endif  // GTEST_CAN_STREAM_RESULTS_
"\n"
"Assertion Behavior:\n"
#if GTEST_HAS_DEATH_TEST && !GTEST_OS_WINDOWS
"  @G--" GTEST_FLAG_PREFIX_ "death_test_style=@Y(@Gfast@Y|@Gthreadsafe@Y)@D\n"
"      Set the default death test style.\n"
#endif  // GTEST_HAS_DEATH_TEST && !GTEST_OS_WINDOWS
"  @G--" GTEST_FLAG_PREFIX_ "break_on_failure@D\n"
"      Turn assertion failures into debugger break-points.\n"
"  @G--" GTEST_FLAG_PREFIX_ "throw_on_failure@D\n"
"      Turn assertion failures into C++ exceptions.\n"
"  @G--" GTEST_FLAG_PREFIX_ "catch_exceptions=0@D\n"
"      Do not report exceptions as test failures. Instead, allow them\n"
"      to crash the program or throw a pop-up (on Windows).\n"
"\n"
"Except for @G--" GTEST_FLAG_PREFIX_ "list_tests@D, you can alternatively set "
    "the corresponding\n"
"environment variable of a flag (all letters in upper-case). For example, to\n"
"disable colored text output, you can either specify @G--" GTEST_FLAG_PREFIX_
    "color=no@D or set\n"
"the @G" GTEST_FLAG_PREFIX_UPPER_ "COLOR@D environment variable to @Gno@D.\n"
"\n"
"For more information, please read the " GTEST_NAME_ " documentation at\n"
"@G" GTEST_PROJECT_URL_ "@D. If you find a bug in " GTEST_NAME_ "\n"
"(not one in your own code or tests), please report it to\n"
"@G<" GTEST_DEV_EMAIL_ ">@D.\n";

// Parses the command line for Google Test flags, without initializing
// other parts of Google Test.  The type parameter CharType can be
// instantiated to either char or wchar_t.
template 
void ParseGoogleTestFlagsOnlyImpl(int* argc, CharType** argv) {
  for (int i = 1; i < *argc; i++) {
    const std::string arg_string = StreamableToString(argv[i]);
    const char* const arg = arg_string.c_str();

    using internal::ParseBoolFlag;
    using internal::ParseInt32Flag;
    using internal::ParseStringFlag;

    // Do we see a Google Test flag?
    if (ParseBoolFlag(arg, kAlsoRunDisabledTestsFlag,
                      >EST_FLAG(also_run_disabled_tests)) ||
        ParseBoolFlag(arg, kBreakOnFailureFlag,
                      >EST_FLAG(break_on_failure)) ||
        ParseBoolFlag(arg, kCatchExceptionsFlag,
                      >EST_FLAG(catch_exceptions)) ||
        ParseStringFlag(arg, kColorFlag, >EST_FLAG(color)) ||
        ParseStringFlag(arg, kDeathTestStyleFlag,
                        >EST_FLAG(death_test_style)) ||
        ParseBoolFlag(arg, kDeathTestUseFork,
                      >EST_FLAG(death_test_use_fork)) ||
        ParseStringFlag(arg, kFilterFlag, >EST_FLAG(filter)) ||
        ParseStringFlag(arg, kInternalRunDeathTestFlag,
                        >EST_FLAG(internal_run_death_test)) ||
        ParseBoolFlag(arg, kListTestsFlag, >EST_FLAG(list_tests)) ||
        ParseStringFlag(arg, kOutputFlag, >EST_FLAG(output)) ||
        ParseBoolFlag(arg, kPrintTimeFlag, >EST_FLAG(print_time)) ||
        ParseInt32Flag(arg, kRandomSeedFlag, >EST_FLAG(random_seed)) ||
        ParseInt32Flag(arg, kRepeatFlag, >EST_FLAG(repeat)) ||
        ParseBoolFlag(arg, kShuffleFlag, >EST_FLAG(shuffle)) ||
        ParseInt32Flag(arg, kStackTraceDepthFlag,
                       >EST_FLAG(stack_trace_depth)) ||
        ParseStringFlag(arg, kStreamResultToFlag,
                        >EST_FLAG(stream_result_to)) ||
        ParseBoolFlag(arg, kThrowOnFailureFlag,
                      >EST_FLAG(throw_on_failure))
        ) {
      // Yes.  Shift the remainder of the argv list left by one.  Note
      // that argv has (*argc + 1) elements, the last one always being
      // NULL.  The following loop moves the trailing NULL element as
      // well.
      for (int j = i; j != *argc; j++) {
        argv[j] = argv[j + 1];
      }

      // Decrements the argument count.
      (*argc)--;

      // We also need to decrement the iterator as we just removed
      // an element.
      i--;
    } else if (arg_string == "--help" || arg_string == "-h" ||
               arg_string == "-?" || arg_string == "/?" ||
               HasGoogleTestFlagPrefix(arg)) {
      // Both help flag and unrecognized Google Test flags (excluding
      // internal ones) trigger help display.
      g_help_flag = true;
    }
  }

  if (g_help_flag) {
    // We print the help here instead of in RUN_ALL_TESTS(), as the
    // latter may not be called at all if the user is using Google
    // Test with another testing framework.
    PrintColorEncoded(kColorEncodedHelpMessage);
  }
}

// Parses the command line for Google Test flags, without initializing
// other parts of Google Test.
void ParseGoogleTestFlagsOnly(int* argc, char** argv) {
  ParseGoogleTestFlagsOnlyImpl(argc, argv);
}
void ParseGoogleTestFlagsOnly(int* argc, wchar_t** argv) {
  ParseGoogleTestFlagsOnlyImpl(argc, argv);
}

// The internal implementation of InitGoogleTest().
//
// The type parameter CharType can be instantiated to either char or
// wchar_t.
template 
void InitGoogleTestImpl(int* argc, CharType** argv) {
  g_init_gtest_count++;

  // We don't want to run the initialization code twice.
  if (g_init_gtest_count != 1) return;

  if (*argc <= 0) return;

  internal::g_executable_path = internal::StreamableToString(argv[0]);

#if GTEST_HAS_DEATH_TEST

  g_argvs.clear();
  for (int i = 0; i != *argc; i++) {
    g_argvs.push_back(StreamableToString(argv[i]));
  }

#endif  // GTEST_HAS_DEATH_TEST

  ParseGoogleTestFlagsOnly(argc, argv);
  GetUnitTestImpl()->PostFlagParsingInit();
}

}  // namespace internal

// Initializes Google Test.  This must be called before calling
// RUN_ALL_TESTS().  In particular, it parses a command line for the
// flags that Google Test recognizes.  Whenever a Google Test flag is
// seen, it is removed from argv, and *argc is decremented.
//
// No value is returned.  Instead, the Google Test flag variables are
// updated.
//
// Calling the function for the second time has no user-visible effect.
void InitGoogleTest(int* argc, char** argv) {
  internal::InitGoogleTestImpl(argc, argv);
}

// This overloaded version can be used in Windows programs compiled in
// UNICODE mode.
void InitGoogleTest(int* argc, wchar_t** argv) {
  internal::InitGoogleTestImpl(argc, argv);
}

}  // namespace testing
node-v4.8.2/deps/gtest/src/gtest_main.cc000644 000766 000024 00000003264 13070706730 020271 0ustar00iojsstaff000000 000000 // Copyright 2006, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#include 

#include "gtest/gtest.h"

GTEST_API_ int main(int argc, char **argv) {
  testing::InitGoogleTest(&argc, argv);
  return RUN_ALL_TESTS();
}
node-v4.8.2/deps/gtest/include/gtest/000755 000766 000024 00000000000 13070706730 017605 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/gtest/include/gtest/gtest-death-test.h000644 000766 000024 00000026403 13070706730 023151 0ustar00iojsstaff000000 000000 // Copyright 2005, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Author: wan@google.com (Zhanyong Wan)
//
// The Google C++ Testing Framework (Google Test)
//
// This header file defines the public API for death tests.  It is
// #included by gtest.h so a user doesn't need to include this
// directly.

#ifndef GTEST_INCLUDE_GTEST_GTEST_DEATH_TEST_H_
#define GTEST_INCLUDE_GTEST_GTEST_DEATH_TEST_H_

#include "gtest/internal/gtest-death-test-internal.h"

namespace testing {

// This flag controls the style of death tests.  Valid values are "threadsafe",
// meaning that the death test child process will re-execute the test binary
// from the start, running only a single death test, or "fast",
// meaning that the child process will execute the test logic immediately
// after forking.
GTEST_DECLARE_string_(death_test_style);

#if GTEST_HAS_DEATH_TEST

namespace internal {

// Returns a Boolean value indicating whether the caller is currently
// executing in the context of the death test child process.  Tools such as
// Valgrind heap checkers may need this to modify their behavior in death
// tests.  IMPORTANT: This is an internal utility.  Using it may break the
// implementation of death tests.  User code MUST NOT use it.
GTEST_API_ bool InDeathTestChild();

}  // namespace internal

// The following macros are useful for writing death tests.

// Here's what happens when an ASSERT_DEATH* or EXPECT_DEATH* is
// executed:
//
//   1. It generates a warning if there is more than one active
//   thread.  This is because it's safe to fork() or clone() only
//   when there is a single thread.
//
//   2. The parent process clone()s a sub-process and runs the death
//   test in it; the sub-process exits with code 0 at the end of the
//   death test, if it hasn't exited already.
//
//   3. The parent process waits for the sub-process to terminate.
//
//   4. The parent process checks the exit code and error message of
//   the sub-process.
//
// Examples:
//
//   ASSERT_DEATH(server.SendMessage(56, "Hello"), "Invalid port number");
//   for (int i = 0; i < 5; i++) {
//     EXPECT_DEATH(server.ProcessRequest(i),
//                  "Invalid request .* in ProcessRequest()")
//                  << "Failed to die on request " << i;
//   }
//
//   ASSERT_EXIT(server.ExitNow(), ::testing::ExitedWithCode(0), "Exiting");
//
//   bool KilledBySIGHUP(int exit_code) {
//     return WIFSIGNALED(exit_code) && WTERMSIG(exit_code) == SIGHUP;
//   }
//
//   ASSERT_EXIT(client.HangUpServer(), KilledBySIGHUP, "Hanging up!");
//
// On the regular expressions used in death tests:
//
//   On POSIX-compliant systems (*nix), we use the  library,
//   which uses the POSIX extended regex syntax.
//
//   On other platforms (e.g. Windows), we only support a simple regex
//   syntax implemented as part of Google Test.  This limited
//   implementation should be enough most of the time when writing
//   death tests; though it lacks many features you can find in PCRE
//   or POSIX extended regex syntax.  For example, we don't support
//   union ("x|y"), grouping ("(xy)"), brackets ("[xy]"), and
//   repetition count ("x{5,7}"), among others.
//
//   Below is the syntax that we do support.  We chose it to be a
//   subset of both PCRE and POSIX extended regex, so it's easy to
//   learn wherever you come from.  In the following: 'A' denotes a
//   literal character, period (.), or a single \\ escape sequence;
//   'x' and 'y' denote regular expressions; 'm' and 'n' are for
//   natural numbers.
//
//     c     matches any literal character c
//     \\d   matches any decimal digit
//     \\D   matches any character that's not a decimal digit
//     \\f   matches \f
//     \\n   matches \n
//     \\r   matches \r
//     \\s   matches any ASCII whitespace, including \n
//     \\S   matches any character that's not a whitespace
//     \\t   matches \t
//     \\v   matches \v
//     \\w   matches any letter, _, or decimal digit
//     \\W   matches any character that \\w doesn't match
//     \\c   matches any literal character c, which must be a punctuation
//     .     matches any single character except \n
//     A?    matches 0 or 1 occurrences of A
//     A*    matches 0 or many occurrences of A
//     A+    matches 1 or many occurrences of A
//     ^     matches the beginning of a string (not that of each line)
//     $     matches the end of a string (not that of each line)
//     xy    matches x followed by y
//
//   If you accidentally use PCRE or POSIX extended regex features
//   not implemented by us, you will get a run-time failure.  In that
//   case, please try to rewrite your regular expression within the
//   above syntax.
//
//   This implementation is *not* meant to be as highly tuned or robust
//   as a compiled regex library, but should perform well enough for a
//   death test, which already incurs significant overhead by launching
//   a child process.
//
// Known caveats:
//
//   A "threadsafe" style death test obtains the path to the test
//   program from argv[0] and re-executes it in the sub-process.  For
//   simplicity, the current implementation doesn't search the PATH
//   when launching the sub-process.  This means that the user must
//   invoke the test program via a path that contains at least one
//   path separator (e.g. path/to/foo_test and
//   /absolute/path/to/bar_test are fine, but foo_test is not).  This
//   is rarely a problem as people usually don't put the test binary
//   directory in PATH.
//
// TODO(wan@google.com): make thread-safe death tests search the PATH.

// Asserts that a given statement causes the program to exit, with an
// integer exit status that satisfies predicate, and emitting error output
// that matches regex.
# define ASSERT_EXIT(statement, predicate, regex) \
    GTEST_DEATH_TEST_(statement, predicate, regex, GTEST_FATAL_FAILURE_)

// Like ASSERT_EXIT, but continues on to successive tests in the
// test case, if any:
# define EXPECT_EXIT(statement, predicate, regex) \
    GTEST_DEATH_TEST_(statement, predicate, regex, GTEST_NONFATAL_FAILURE_)

// Asserts that a given statement causes the program to exit, either by
// explicitly exiting with a nonzero exit code or being killed by a
// signal, and emitting error output that matches regex.
# define ASSERT_DEATH(statement, regex) \
    ASSERT_EXIT(statement, ::testing::internal::ExitedUnsuccessfully, regex)

// Like ASSERT_DEATH, but continues on to successive tests in the
// test case, if any:
# define EXPECT_DEATH(statement, regex) \
    EXPECT_EXIT(statement, ::testing::internal::ExitedUnsuccessfully, regex)

// Two predicate classes that can be used in {ASSERT,EXPECT}_EXIT*:

// Tests that an exit code describes a normal exit with a given exit code.
class GTEST_API_ ExitedWithCode {
 public:
  explicit ExitedWithCode(int exit_code);
  bool operator()(int exit_status) const;
 private:
  // No implementation - assignment is unsupported.
  void operator=(const ExitedWithCode& other);

  const int exit_code_;
};

# if !GTEST_OS_WINDOWS
// Tests that an exit code describes an exit due to termination by a
// given signal.
class GTEST_API_ KilledBySignal {
 public:
  explicit KilledBySignal(int signum);
  bool operator()(int exit_status) const;
 private:
  const int signum_;
};
# endif  // !GTEST_OS_WINDOWS

// EXPECT_DEBUG_DEATH asserts that the given statements die in debug mode.
// The death testing framework causes this to have interesting semantics,
// since the sideeffects of the call are only visible in opt mode, and not
// in debug mode.
//
// In practice, this can be used to test functions that utilize the
// LOG(DFATAL) macro using the following style:
//
// int DieInDebugOr12(int* sideeffect) {
//   if (sideeffect) {
//     *sideeffect = 12;
//   }
//   LOG(DFATAL) << "death";
//   return 12;
// }
//
// TEST(TestCase, TestDieOr12WorksInDgbAndOpt) {
//   int sideeffect = 0;
//   // Only asserts in dbg.
//   EXPECT_DEBUG_DEATH(DieInDebugOr12(&sideeffect), "death");
//
// #ifdef NDEBUG
//   // opt-mode has sideeffect visible.
//   EXPECT_EQ(12, sideeffect);
// #else
//   // dbg-mode no visible sideeffect.
//   EXPECT_EQ(0, sideeffect);
// #endif
// }
//
// This will assert that DieInDebugReturn12InOpt() crashes in debug
// mode, usually due to a DCHECK or LOG(DFATAL), but returns the
// appropriate fallback value (12 in this case) in opt mode. If you
// need to test that a function has appropriate side-effects in opt
// mode, include assertions against the side-effects.  A general
// pattern for this is:
//
// EXPECT_DEBUG_DEATH({
//   // Side-effects here will have an effect after this statement in
//   // opt mode, but none in debug mode.
//   EXPECT_EQ(12, DieInDebugOr12(&sideeffect));
// }, "death");
//
# ifdef NDEBUG

#  define EXPECT_DEBUG_DEATH(statement, regex) \
  GTEST_EXECUTE_STATEMENT_(statement, regex)

#  define ASSERT_DEBUG_DEATH(statement, regex) \
  GTEST_EXECUTE_STATEMENT_(statement, regex)

# else

#  define EXPECT_DEBUG_DEATH(statement, regex) \
  EXPECT_DEATH(statement, regex)

#  define ASSERT_DEBUG_DEATH(statement, regex) \
  ASSERT_DEATH(statement, regex)

# endif  // NDEBUG for EXPECT_DEBUG_DEATH
#endif  // GTEST_HAS_DEATH_TEST

// EXPECT_DEATH_IF_SUPPORTED(statement, regex) and
// ASSERT_DEATH_IF_SUPPORTED(statement, regex) expand to real death tests if
// death tests are supported; otherwise they just issue a warning.  This is
// useful when you are combining death test assertions with normal test
// assertions in one test.
#if GTEST_HAS_DEATH_TEST
# define EXPECT_DEATH_IF_SUPPORTED(statement, regex) \
    EXPECT_DEATH(statement, regex)
# define ASSERT_DEATH_IF_SUPPORTED(statement, regex) \
    ASSERT_DEATH(statement, regex)
#else
# define EXPECT_DEATH_IF_SUPPORTED(statement, regex) \
    GTEST_UNSUPPORTED_DEATH_TEST_(statement, regex, )
# define ASSERT_DEATH_IF_SUPPORTED(statement, regex) \
    GTEST_UNSUPPORTED_DEATH_TEST_(statement, regex, return)
#endif

}  // namespace testing

#endif  // GTEST_INCLUDE_GTEST_GTEST_DEATH_TEST_H_
node-v4.8.2/deps/gtest/include/gtest/gtest-message.h000644 000766 000024 00000021742 13070706730 022534 0ustar00iojsstaff000000 000000 // Copyright 2005, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Author: wan@google.com (Zhanyong Wan)
//
// The Google C++ Testing Framework (Google Test)
//
// This header file defines the Message class.
//
// IMPORTANT NOTE: Due to limitation of the C++ language, we have to
// leave some internal implementation details in this header file.
// They are clearly marked by comments like this:
//
//   // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
//
// Such code is NOT meant to be used by a user directly, and is subject
// to CHANGE WITHOUT NOTICE.  Therefore DO NOT DEPEND ON IT in a user
// program!

#ifndef GTEST_INCLUDE_GTEST_GTEST_MESSAGE_H_
#define GTEST_INCLUDE_GTEST_GTEST_MESSAGE_H_

#include 

#include "gtest/internal/gtest-port.h"

// Ensures that there is at least one operator<< in the global namespace.
// See Message& operator<<(...) below for why.
void operator<<(const testing::internal::Secret&, int);

namespace testing {

// The Message class works like an ostream repeater.
//
// Typical usage:
//
//   1. You stream a bunch of values to a Message object.
//      It will remember the text in a stringstream.
//   2. Then you stream the Message object to an ostream.
//      This causes the text in the Message to be streamed
//      to the ostream.
//
// For example;
//
//   testing::Message foo;
//   foo << 1 << " != " << 2;
//   std::cout << foo;
//
// will print "1 != 2".
//
// Message is not intended to be inherited from.  In particular, its
// destructor is not virtual.
//
// Note that stringstream behaves differently in gcc and in MSVC.  You
// can stream a NULL char pointer to it in the former, but not in the
// latter (it causes an access violation if you do).  The Message
// class hides this difference by treating a NULL char pointer as
// "(null)".
class GTEST_API_ Message {
 private:
  // The type of basic IO manipulators (endl, ends, and flush) for
  // narrow streams.
  typedef std::ostream& (*BasicNarrowIoManip)(std::ostream&);

 public:
  // Constructs an empty Message.
  Message();

  // Copy constructor.
  Message(const Message& msg) : ss_(new ::std::stringstream) {  // NOLINT
    *ss_ << msg.GetString();
  }

  // Constructs a Message from a C-string.
  explicit Message(const char* str) : ss_(new ::std::stringstream) {
    *ss_ << str;
  }

#if GTEST_OS_SYMBIAN
  // Streams a value (either a pointer or not) to this object.
  template 
  inline Message& operator <<(const T& value) {
    StreamHelper(typename internal::is_pointer::type(), value);
    return *this;
  }
#else
  // Streams a non-pointer value to this object.
  template 
  inline Message& operator <<(const T& val) {
    // Some libraries overload << for STL containers.  These
    // overloads are defined in the global namespace instead of ::std.
    //
    // C++'s symbol lookup rule (i.e. Koenig lookup) says that these
    // overloads are visible in either the std namespace or the global
    // namespace, but not other namespaces, including the testing
    // namespace which Google Test's Message class is in.
    //
    // To allow STL containers (and other types that has a << operator
    // defined in the global namespace) to be used in Google Test
    // assertions, testing::Message must access the custom << operator
    // from the global namespace.  With this using declaration,
    // overloads of << defined in the global namespace and those
    // visible via Koenig lookup are both exposed in this function.
    using ::operator <<;
    *ss_ << val;
    return *this;
  }

  // Streams a pointer value to this object.
  //
  // This function is an overload of the previous one.  When you
  // stream a pointer to a Message, this definition will be used as it
  // is more specialized.  (The C++ Standard, section
  // [temp.func.order].)  If you stream a non-pointer, then the
  // previous definition will be used.
  //
  // The reason for this overload is that streaming a NULL pointer to
  // ostream is undefined behavior.  Depending on the compiler, you
  // may get "0", "(nil)", "(null)", or an access violation.  To
  // ensure consistent result across compilers, we always treat NULL
  // as "(null)".
  template 
  inline Message& operator <<(T* const& pointer) {  // NOLINT
    if (pointer == NULL) {
      *ss_ << "(null)";
    } else {
      *ss_ << pointer;
    }
    return *this;
  }
#endif  // GTEST_OS_SYMBIAN

  // Since the basic IO manipulators are overloaded for both narrow
  // and wide streams, we have to provide this specialized definition
  // of operator <<, even though its body is the same as the
  // templatized version above.  Without this definition, streaming
  // endl or other basic IO manipulators to Message will confuse the
  // compiler.
  Message& operator <<(BasicNarrowIoManip val) {
    *ss_ << val;
    return *this;
  }

  // Instead of 1/0, we want to see true/false for bool values.
  Message& operator <<(bool b) {
    return *this << (b ? "true" : "false");
  }

  // These two overloads allow streaming a wide C string to a Message
  // using the UTF-8 encoding.
  Message& operator <<(const wchar_t* wide_c_str);
  Message& operator <<(wchar_t* wide_c_str);

#if GTEST_HAS_STD_WSTRING
  // Converts the given wide string to a narrow string using the UTF-8
  // encoding, and streams the result to this Message object.
  Message& operator <<(const ::std::wstring& wstr);
#endif  // GTEST_HAS_STD_WSTRING

#if GTEST_HAS_GLOBAL_WSTRING
  // Converts the given wide string to a narrow string using the UTF-8
  // encoding, and streams the result to this Message object.
  Message& operator <<(const ::wstring& wstr);
#endif  // GTEST_HAS_GLOBAL_WSTRING

  // Gets the text streamed to this object so far as an std::string.
  // Each '\0' character in the buffer is replaced with "\\0".
  //
  // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
  std::string GetString() const;

 private:

#if GTEST_OS_SYMBIAN
  // These are needed as the Nokia Symbian Compiler cannot decide between
  // const T& and const T* in a function template. The Nokia compiler _can_
  // decide between class template specializations for T and T*, so a
  // tr1::type_traits-like is_pointer works, and we can overload on that.
  template 
  inline void StreamHelper(internal::true_type /*is_pointer*/, T* pointer) {
    if (pointer == NULL) {
      *ss_ << "(null)";
    } else {
      *ss_ << pointer;
    }
  }
  template 
  inline void StreamHelper(internal::false_type /*is_pointer*/,
                           const T& value) {
    // See the comments in Message& operator <<(const T&) above for why
    // we need this using statement.
    using ::operator <<;
    *ss_ << value;
  }
#endif  // GTEST_OS_SYMBIAN

  // We'll hold the text streamed to this object here.
  const internal::scoped_ptr< ::std::stringstream> ss_;

  // We declare (but don't implement) this to prevent the compiler
  // from implementing the assignment operator.
  void operator=(const Message&);
};

// Streams a Message to an ostream.
inline std::ostream& operator <<(std::ostream& os, const Message& sb) {
  return os << sb.GetString();
}

namespace internal {

// Converts a streamable value to an std::string.  A NULL pointer is
// converted to "(null)".  When the input value is a ::string,
// ::std::string, ::wstring, or ::std::wstring object, each NUL
// character in it is replaced with "\\0".
template 
std::string StreamableToString(const T& streamable) {
  return (Message() << streamable).GetString();
}

}  // namespace internal
}  // namespace testing

#endif  // GTEST_INCLUDE_GTEST_GTEST_MESSAGE_H_
node-v4.8.2/deps/gtest/include/gtest/gtest-param-test.h000644 000766 000024 00000224130 13070706730 023161 0ustar00iojsstaff000000 000000 // This file was GENERATED by command:
//     pump.py gtest-param-test.h.pump
// DO NOT EDIT BY HAND!!!

// Copyright 2008, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Authors: vladl@google.com (Vlad Losev)
//
// Macros and functions for implementing parameterized tests
// in Google C++ Testing Framework (Google Test)
//
// This file is generated by a SCRIPT.  DO NOT EDIT BY HAND!
//
#ifndef GTEST_INCLUDE_GTEST_GTEST_PARAM_TEST_H_
#define GTEST_INCLUDE_GTEST_GTEST_PARAM_TEST_H_


// Value-parameterized tests allow you to test your code with different
// parameters without writing multiple copies of the same test.
//
// Here is how you use value-parameterized tests:

#if 0

// To write value-parameterized tests, first you should define a fixture
// class. It is usually derived from testing::TestWithParam (see below for
// another inheritance scheme that's sometimes useful in more complicated
// class hierarchies), where the type of your parameter values.
// TestWithParam is itself derived from testing::Test. T can be any
// copyable type. If it's a raw pointer, you are responsible for managing the
// lifespan of the pointed values.

class FooTest : public ::testing::TestWithParam {
  // You can implement all the usual class fixture members here.
};

// Then, use the TEST_P macro to define as many parameterized tests
// for this fixture as you want. The _P suffix is for "parameterized"
// or "pattern", whichever you prefer to think.

TEST_P(FooTest, DoesBlah) {
  // Inside a test, access the test parameter with the GetParam() method
  // of the TestWithParam class:
  EXPECT_TRUE(foo.Blah(GetParam()));
  ...
}

TEST_P(FooTest, HasBlahBlah) {
  ...
}

// Finally, you can use INSTANTIATE_TEST_CASE_P to instantiate the test
// case with any set of parameters you want. Google Test defines a number
// of functions for generating test parameters. They return what we call
// (surprise!) parameter generators. Here is a  summary of them, which
// are all in the testing namespace:
//
//
//  Range(begin, end [, step]) - Yields values {begin, begin+step,
//                               begin+step+step, ...}. The values do not
//                               include end. step defaults to 1.
//  Values(v1, v2, ..., vN)    - Yields values {v1, v2, ..., vN}.
//  ValuesIn(container)        - Yields values from a C-style array, an STL
//  ValuesIn(begin,end)          container, or an iterator range [begin, end).
//  Bool()                     - Yields sequence {false, true}.
//  Combine(g1, g2, ..., gN)   - Yields all combinations (the Cartesian product
//                               for the math savvy) of the values generated
//                               by the N generators.
//
// For more details, see comments at the definitions of these functions below
// in this file.
//
// The following statement will instantiate tests from the FooTest test case
// each with parameter values "meeny", "miny", and "moe".

INSTANTIATE_TEST_CASE_P(InstantiationName,
                        FooTest,
                        Values("meeny", "miny", "moe"));

// To distinguish different instances of the pattern, (yes, you
// can instantiate it more then once) the first argument to the
// INSTANTIATE_TEST_CASE_P macro is a prefix that will be added to the
// actual test case name. Remember to pick unique prefixes for different
// instantiations. The tests from the instantiation above will have
// these names:
//
//    * InstantiationName/FooTest.DoesBlah/0 for "meeny"
//    * InstantiationName/FooTest.DoesBlah/1 for "miny"
//    * InstantiationName/FooTest.DoesBlah/2 for "moe"
//    * InstantiationName/FooTest.HasBlahBlah/0 for "meeny"
//    * InstantiationName/FooTest.HasBlahBlah/1 for "miny"
//    * InstantiationName/FooTest.HasBlahBlah/2 for "moe"
//
// You can use these names in --gtest_filter.
//
// This statement will instantiate all tests from FooTest again, each
// with parameter values "cat" and "dog":

const char* pets[] = {"cat", "dog"};
INSTANTIATE_TEST_CASE_P(AnotherInstantiationName, FooTest, ValuesIn(pets));

// The tests from the instantiation above will have these names:
//
//    * AnotherInstantiationName/FooTest.DoesBlah/0 for "cat"
//    * AnotherInstantiationName/FooTest.DoesBlah/1 for "dog"
//    * AnotherInstantiationName/FooTest.HasBlahBlah/0 for "cat"
//    * AnotherInstantiationName/FooTest.HasBlahBlah/1 for "dog"
//
// Please note that INSTANTIATE_TEST_CASE_P will instantiate all tests
// in the given test case, whether their definitions come before or
// AFTER the INSTANTIATE_TEST_CASE_P statement.
//
// Please also note that generator expressions (including parameters to the
// generators) are evaluated in InitGoogleTest(), after main() has started.
// This allows the user on one hand, to adjust generator parameters in order
// to dynamically determine a set of tests to run and on the other hand,
// give the user a chance to inspect the generated tests with Google Test
// reflection API before RUN_ALL_TESTS() is executed.
//
// You can see samples/sample7_unittest.cc and samples/sample8_unittest.cc
// for more examples.
//
// In the future, we plan to publish the API for defining new parameter
// generators. But for now this interface remains part of the internal
// implementation and is subject to change.
//
//
// A parameterized test fixture must be derived from testing::Test and from
// testing::WithParamInterface, where T is the type of the parameter
// values. Inheriting from TestWithParam satisfies that requirement because
// TestWithParam inherits from both Test and WithParamInterface. In more
// complicated hierarchies, however, it is occasionally useful to inherit
// separately from Test and WithParamInterface. For example:

class BaseTest : public ::testing::Test {
  // You can inherit all the usual members for a non-parameterized test
  // fixture here.
};

class DerivedTest : public BaseTest, public ::testing::WithParamInterface {
  // The usual test fixture members go here too.
};

TEST_F(BaseTest, HasFoo) {
  // This is an ordinary non-parameterized test.
}

TEST_P(DerivedTest, DoesBlah) {
  // GetParam works just the same here as if you inherit from TestWithParam.
  EXPECT_TRUE(foo.Blah(GetParam()));
}

#endif  // 0

#include "gtest/internal/gtest-port.h"

#if !GTEST_OS_SYMBIAN
# include 
#endif

// scripts/fuse_gtest.py depends on gtest's own header being #included
// *unconditionally*.  Therefore these #includes cannot be moved
// inside #if GTEST_HAS_PARAM_TEST.
#include "gtest/internal/gtest-internal.h"
#include "gtest/internal/gtest-param-util.h"
#include "gtest/internal/gtest-param-util-generated.h"

#if GTEST_HAS_PARAM_TEST

namespace testing {

// Functions producing parameter generators.
//
// Google Test uses these generators to produce parameters for value-
// parameterized tests. When a parameterized test case is instantiated
// with a particular generator, Google Test creates and runs tests
// for each element in the sequence produced by the generator.
//
// In the following sample, tests from test case FooTest are instantiated
// each three times with parameter values 3, 5, and 8:
//
// class FooTest : public TestWithParam { ... };
//
// TEST_P(FooTest, TestThis) {
// }
// TEST_P(FooTest, TestThat) {
// }
// INSTANTIATE_TEST_CASE_P(TestSequence, FooTest, Values(3, 5, 8));
//

// Range() returns generators providing sequences of values in a range.
//
// Synopsis:
// Range(start, end)
//   - returns a generator producing a sequence of values {start, start+1,
//     start+2, ..., }.
// Range(start, end, step)
//   - returns a generator producing a sequence of values {start, start+step,
//     start+step+step, ..., }.
// Notes:
//   * The generated sequences never include end. For example, Range(1, 5)
//     returns a generator producing a sequence {1, 2, 3, 4}. Range(1, 9, 2)
//     returns a generator producing {1, 3, 5, 7}.
//   * start and end must have the same type. That type may be any integral or
//     floating-point type or a user defined type satisfying these conditions:
//     * It must be assignable (have operator=() defined).
//     * It must have operator+() (operator+(int-compatible type) for
//       two-operand version).
//     * It must have operator<() defined.
//     Elements in the resulting sequences will also have that type.
//   * Condition start < end must be satisfied in order for resulting sequences
//     to contain any elements.
//
template 
internal::ParamGenerator Range(T start, T end, IncrementT step) {
  return internal::ParamGenerator(
      new internal::RangeGenerator(start, end, step));
}

template 
internal::ParamGenerator Range(T start, T end) {
  return Range(start, end, 1);
}

// ValuesIn() function allows generation of tests with parameters coming from
// a container.
//
// Synopsis:
// ValuesIn(const T (&array)[N])
//   - returns a generator producing sequences with elements from
//     a C-style array.
// ValuesIn(const Container& container)
//   - returns a generator producing sequences with elements from
//     an STL-style container.
// ValuesIn(Iterator begin, Iterator end)
//   - returns a generator producing sequences with elements from
//     a range [begin, end) defined by a pair of STL-style iterators. These
//     iterators can also be plain C pointers.
//
// Please note that ValuesIn copies the values from the containers
// passed in and keeps them to generate tests in RUN_ALL_TESTS().
//
// Examples:
//
// This instantiates tests from test case StringTest
// each with C-string values of "foo", "bar", and "baz":
//
// const char* strings[] = {"foo", "bar", "baz"};
// INSTANTIATE_TEST_CASE_P(StringSequence, SrtingTest, ValuesIn(strings));
//
// This instantiates tests from test case StlStringTest
// each with STL strings with values "a" and "b":
//
// ::std::vector< ::std::string> GetParameterStrings() {
//   ::std::vector< ::std::string> v;
//   v.push_back("a");
//   v.push_back("b");
//   return v;
// }
//
// INSTANTIATE_TEST_CASE_P(CharSequence,
//                         StlStringTest,
//                         ValuesIn(GetParameterStrings()));
//
//
// This will also instantiate tests from CharTest
// each with parameter values 'a' and 'b':
//
// ::std::list GetParameterChars() {
//   ::std::list list;
//   list.push_back('a');
//   list.push_back('b');
//   return list;
// }
// ::std::list l = GetParameterChars();
// INSTANTIATE_TEST_CASE_P(CharSequence2,
//                         CharTest,
//                         ValuesIn(l.begin(), l.end()));
//
template 
internal::ParamGenerator<
  typename ::testing::internal::IteratorTraits::value_type>
ValuesIn(ForwardIterator begin, ForwardIterator end) {
  typedef typename ::testing::internal::IteratorTraits
      ::value_type ParamType;
  return internal::ParamGenerator(
      new internal::ValuesInIteratorRangeGenerator(begin, end));
}

template 
internal::ParamGenerator ValuesIn(const T (&array)[N]) {
  return ValuesIn(array, array + N);
}

template 
internal::ParamGenerator ValuesIn(
    const Container& container) {
  return ValuesIn(container.begin(), container.end());
}

// Values() allows generating tests from explicitly specified list of
// parameters.
//
// Synopsis:
// Values(T v1, T v2, ..., T vN)
//   - returns a generator producing sequences with elements v1, v2, ..., vN.
//
// For example, this instantiates tests from test case BarTest each
// with values "one", "two", and "three":
//
// INSTANTIATE_TEST_CASE_P(NumSequence, BarTest, Values("one", "two", "three"));
//
// This instantiates tests from test case BazTest each with values 1, 2, 3.5.
// The exact type of values will depend on the type of parameter in BazTest.
//
// INSTANTIATE_TEST_CASE_P(FloatingNumbers, BazTest, Values(1, 2, 3.5));
//
// Currently, Values() supports from 1 to 50 parameters.
//
template 
internal::ValueArray1 Values(T1 v1) {
  return internal::ValueArray1(v1);
}

template 
internal::ValueArray2 Values(T1 v1, T2 v2) {
  return internal::ValueArray2(v1, v2);
}

template 
internal::ValueArray3 Values(T1 v1, T2 v2, T3 v3) {
  return internal::ValueArray3(v1, v2, v3);
}

template 
internal::ValueArray4 Values(T1 v1, T2 v2, T3 v3, T4 v4) {
  return internal::ValueArray4(v1, v2, v3, v4);
}

template 
internal::ValueArray5 Values(T1 v1, T2 v2, T3 v3, T4 v4,
    T5 v5) {
  return internal::ValueArray5(v1, v2, v3, v4, v5);
}

template 
internal::ValueArray6 Values(T1 v1, T2 v2, T3 v3,
    T4 v4, T5 v5, T6 v6) {
  return internal::ValueArray6(v1, v2, v3, v4, v5, v6);
}

template 
internal::ValueArray7 Values(T1 v1, T2 v2, T3 v3,
    T4 v4, T5 v5, T6 v6, T7 v7) {
  return internal::ValueArray7(v1, v2, v3, v4, v5,
      v6, v7);
}

template 
internal::ValueArray8 Values(T1 v1, T2 v2,
    T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8) {
  return internal::ValueArray8(v1, v2, v3, v4,
      v5, v6, v7, v8);
}

template 
internal::ValueArray9 Values(T1 v1, T2 v2,
    T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9) {
  return internal::ValueArray9(v1, v2, v3,
      v4, v5, v6, v7, v8, v9);
}

template 
internal::ValueArray10 Values(T1 v1,
    T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, T10 v10) {
  return internal::ValueArray10(v1,
      v2, v3, v4, v5, v6, v7, v8, v9, v10);
}

template 
internal::ValueArray11 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
    T10 v10, T11 v11) {
  return internal::ValueArray11(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11);
}

template 
internal::ValueArray12 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
    T10 v10, T11 v11, T12 v12) {
  return internal::ValueArray12(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12);
}

template 
internal::ValueArray13 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
    T10 v10, T11 v11, T12 v12, T13 v13) {
  return internal::ValueArray13(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13);
}

template 
internal::ValueArray14 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
    T10 v10, T11 v11, T12 v12, T13 v13, T14 v14) {
  return internal::ValueArray14(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13,
      v14);
}

template 
internal::ValueArray15 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8,
    T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15) {
  return internal::ValueArray15(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12,
      v13, v14, v15);
}

template 
internal::ValueArray16 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7,
    T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15,
    T16 v16) {
  return internal::ValueArray16(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11,
      v12, v13, v14, v15, v16);
}

template 
internal::ValueArray17 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7,
    T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15,
    T16 v16, T17 v17) {
  return internal::ValueArray17(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10,
      v11, v12, v13, v14, v15, v16, v17);
}

template 
internal::ValueArray18 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6,
    T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15,
    T16 v16, T17 v17, T18 v18) {
  return internal::ValueArray18(v1, v2, v3, v4, v5, v6, v7, v8, v9,
      v10, v11, v12, v13, v14, v15, v16, v17, v18);
}

template 
internal::ValueArray19 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5,
    T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, T14 v14,
    T15 v15, T16 v16, T17 v17, T18 v18, T19 v19) {
  return internal::ValueArray19(v1, v2, v3, v4, v5, v6, v7, v8,
      v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19);
}

template 
internal::ValueArray20 Values(T1 v1, T2 v2, T3 v3, T4 v4,
    T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13,
    T14 v14, T15 v15, T16 v16, T17 v17, T18 v18, T19 v19, T20 v20) {
  return internal::ValueArray20(v1, v2, v3, v4, v5, v6, v7,
      v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20);
}

template 
internal::ValueArray21 Values(T1 v1, T2 v2, T3 v3, T4 v4,
    T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13,
    T14 v14, T15 v15, T16 v16, T17 v17, T18 v18, T19 v19, T20 v20, T21 v21) {
  return internal::ValueArray21(v1, v2, v3, v4, v5, v6,
      v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21);
}

template 
internal::ValueArray22 Values(T1 v1, T2 v2, T3 v3,
    T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12,
    T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, T18 v18, T19 v19, T20 v20,
    T21 v21, T22 v22) {
  return internal::ValueArray22(v1, v2, v3, v4,
      v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19,
      v20, v21, v22);
}

template 
internal::ValueArray23 Values(T1 v1, T2 v2,
    T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12,
    T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, T18 v18, T19 v19, T20 v20,
    T21 v21, T22 v22, T23 v23) {
  return internal::ValueArray23(v1, v2, v3,
      v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19,
      v20, v21, v22, v23);
}

template 
internal::ValueArray24 Values(T1 v1, T2 v2,
    T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12,
    T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, T18 v18, T19 v19, T20 v20,
    T21 v21, T22 v22, T23 v23, T24 v24) {
  return internal::ValueArray24(v1, v2,
      v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18,
      v19, v20, v21, v22, v23, v24);
}

template 
internal::ValueArray25 Values(T1 v1,
    T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11,
    T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, T18 v18, T19 v19,
    T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25) {
  return internal::ValueArray25(v1,
      v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17,
      v18, v19, v20, v21, v22, v23, v24, v25);
}

template 
internal::ValueArray26 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
    T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
    T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25,
    T26 v26) {
  return internal::ValueArray26(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15,
      v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26);
}

template 
internal::ValueArray27 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
    T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
    T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25,
    T26 v26, T27 v27) {
  return internal::ValueArray27(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14,
      v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27);
}

template 
internal::ValueArray28 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
    T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
    T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25,
    T26 v26, T27 v27, T28 v28) {
  return internal::ValueArray28(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13,
      v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27,
      v28);
}

template 
internal::ValueArray29 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
    T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
    T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25,
    T26 v26, T27 v27, T28 v28, T29 v29) {
  return internal::ValueArray29(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12,
      v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26,
      v27, v28, v29);
}

template 
internal::ValueArray30 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8,
    T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16,
    T17 v17, T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24,
    T25 v25, T26 v26, T27 v27, T28 v28, T29 v29, T30 v30) {
  return internal::ValueArray30(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11,
      v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25,
      v26, v27, v28, v29, v30);
}

template 
internal::ValueArray31 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7,
    T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15,
    T16 v16, T17 v17, T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23,
    T24 v24, T25 v25, T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31) {
  return internal::ValueArray31(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10,
      v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24,
      v25, v26, v27, v28, v29, v30, v31);
}

template 
internal::ValueArray32 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7,
    T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15,
    T16 v16, T17 v17, T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23,
    T24 v24, T25 v25, T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31,
    T32 v32) {
  return internal::ValueArray32(v1, v2, v3, v4, v5, v6, v7, v8, v9,
      v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23,
      v24, v25, v26, v27, v28, v29, v30, v31, v32);
}

template 
internal::ValueArray33 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6,
    T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15,
    T16 v16, T17 v17, T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23,
    T24 v24, T25 v25, T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31,
    T32 v32, T33 v33) {
  return internal::ValueArray33(v1, v2, v3, v4, v5, v6, v7, v8,
      v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23,
      v24, v25, v26, v27, v28, v29, v30, v31, v32, v33);
}

template 
internal::ValueArray34 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5,
    T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, T14 v14,
    T15 v15, T16 v16, T17 v17, T18 v18, T19 v19, T20 v20, T21 v21, T22 v22,
    T23 v23, T24 v24, T25 v25, T26 v26, T27 v27, T28 v28, T29 v29, T30 v30,
    T31 v31, T32 v32, T33 v33, T34 v34) {
  return internal::ValueArray34(v1, v2, v3, v4, v5, v6, v7,
      v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22,
      v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34);
}

template 
internal::ValueArray35 Values(T1 v1, T2 v2, T3 v3, T4 v4,
    T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13,
    T14 v14, T15 v15, T16 v16, T17 v17, T18 v18, T19 v19, T20 v20, T21 v21,
    T22 v22, T23 v23, T24 v24, T25 v25, T26 v26, T27 v27, T28 v28, T29 v29,
    T30 v30, T31 v31, T32 v32, T33 v33, T34 v34, T35 v35) {
  return internal::ValueArray35(v1, v2, v3, v4, v5, v6,
      v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21,
      v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35);
}

template 
internal::ValueArray36 Values(T1 v1, T2 v2, T3 v3, T4 v4,
    T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13,
    T14 v14, T15 v15, T16 v16, T17 v17, T18 v18, T19 v19, T20 v20, T21 v21,
    T22 v22, T23 v23, T24 v24, T25 v25, T26 v26, T27 v27, T28 v28, T29 v29,
    T30 v30, T31 v31, T32 v32, T33 v33, T34 v34, T35 v35, T36 v36) {
  return internal::ValueArray36(v1, v2, v3, v4,
      v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19,
      v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33,
      v34, v35, v36);
}

template 
internal::ValueArray37 Values(T1 v1, T2 v2, T3 v3,
    T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12,
    T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, T18 v18, T19 v19, T20 v20,
    T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, T26 v26, T27 v27, T28 v28,
    T29 v29, T30 v30, T31 v31, T32 v32, T33 v33, T34 v34, T35 v35, T36 v36,
    T37 v37) {
  return internal::ValueArray37(v1, v2, v3,
      v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19,
      v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33,
      v34, v35, v36, v37);
}

template 
internal::ValueArray38 Values(T1 v1, T2 v2,
    T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12,
    T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, T18 v18, T19 v19, T20 v20,
    T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, T26 v26, T27 v27, T28 v28,
    T29 v29, T30 v30, T31 v31, T32 v32, T33 v33, T34 v34, T35 v35, T36 v36,
    T37 v37, T38 v38) {
  return internal::ValueArray38(v1, v2,
      v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18,
      v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32,
      v33, v34, v35, v36, v37, v38);
}

template 
internal::ValueArray39 Values(T1 v1, T2 v2,
    T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12,
    T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, T18 v18, T19 v19, T20 v20,
    T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, T26 v26, T27 v27, T28 v28,
    T29 v29, T30 v30, T31 v31, T32 v32, T33 v33, T34 v34, T35 v35, T36 v36,
    T37 v37, T38 v38, T39 v39) {
  return internal::ValueArray39(v1,
      v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17,
      v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31,
      v32, v33, v34, v35, v36, v37, v38, v39);
}

template 
internal::ValueArray40 Values(T1 v1,
    T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11,
    T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17, T18 v18, T19 v19,
    T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25, T26 v26, T27 v27,
    T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33, T34 v34, T35 v35,
    T36 v36, T37 v37, T38 v38, T39 v39, T40 v40) {
  return internal::ValueArray40(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15,
      v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29,
      v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40);
}

template 
internal::ValueArray41 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
    T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
    T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25,
    T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33,
    T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39, T40 v40, T41 v41) {
  return internal::ValueArray41(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14,
      v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28,
      v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41);
}

template 
internal::ValueArray42 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
    T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
    T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25,
    T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33,
    T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39, T40 v40, T41 v41,
    T42 v42) {
  return internal::ValueArray42(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13,
      v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27,
      v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41,
      v42);
}

template 
internal::ValueArray43 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
    T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
    T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25,
    T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33,
    T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39, T40 v40, T41 v41,
    T42 v42, T43 v43) {
  return internal::ValueArray43(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12,
      v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26,
      v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40,
      v41, v42, v43);
}

template 
internal::ValueArray44 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
    T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
    T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25,
    T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33,
    T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39, T40 v40, T41 v41,
    T42 v42, T43 v43, T44 v44) {
  return internal::ValueArray44(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11,
      v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25,
      v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39,
      v40, v41, v42, v43, v44);
}

template 
internal::ValueArray45 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8,
    T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16,
    T17 v17, T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24,
    T25 v25, T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32,
    T33 v33, T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39, T40 v40,
    T41 v41, T42 v42, T43 v43, T44 v44, T45 v45) {
  return internal::ValueArray45(v1, v2, v3, v4, v5, v6, v7, v8, v9, v10,
      v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24,
      v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38,
      v39, v40, v41, v42, v43, v44, v45);
}

template 
internal::ValueArray46 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7,
    T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15,
    T16 v16, T17 v17, T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23,
    T24 v24, T25 v25, T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31,
    T32 v32, T33 v33, T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39,
    T40 v40, T41 v41, T42 v42, T43 v43, T44 v44, T45 v45, T46 v46) {
  return internal::ValueArray46(v1, v2, v3, v4, v5, v6, v7, v8, v9,
      v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23,
      v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37,
      v38, v39, v40, v41, v42, v43, v44, v45, v46);
}

template 
internal::ValueArray47 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7,
    T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15,
    T16 v16, T17 v17, T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23,
    T24 v24, T25 v25, T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31,
    T32 v32, T33 v33, T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39,
    T40 v40, T41 v41, T42 v42, T43 v43, T44 v44, T45 v45, T46 v46, T47 v47) {
  return internal::ValueArray47(v1, v2, v3, v4, v5, v6, v7, v8,
      v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23,
      v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37,
      v38, v39, v40, v41, v42, v43, v44, v45, v46, v47);
}

template 
internal::ValueArray48 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6,
    T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15,
    T16 v16, T17 v17, T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23,
    T24 v24, T25 v25, T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31,
    T32 v32, T33 v33, T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39,
    T40 v40, T41 v41, T42 v42, T43 v43, T44 v44, T45 v45, T46 v46, T47 v47,
    T48 v48) {
  return internal::ValueArray48(v1, v2, v3, v4, v5, v6, v7,
      v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22,
      v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36,
      v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48);
}

template 
internal::ValueArray49 Values(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5,
    T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13, T14 v14,
    T15 v15, T16 v16, T17 v17, T18 v18, T19 v19, T20 v20, T21 v21, T22 v22,
    T23 v23, T24 v24, T25 v25, T26 v26, T27 v27, T28 v28, T29 v29, T30 v30,
    T31 v31, T32 v32, T33 v33, T34 v34, T35 v35, T36 v36, T37 v37, T38 v38,
    T39 v39, T40 v40, T41 v41, T42 v42, T43 v43, T44 v44, T45 v45, T46 v46,
    T47 v47, T48 v48, T49 v49) {
  return internal::ValueArray49(v1, v2, v3, v4, v5, v6,
      v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21,
      v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35,
      v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49);
}

template 
internal::ValueArray50 Values(T1 v1, T2 v2, T3 v3, T4 v4,
    T5 v5, T6 v6, T7 v7, T8 v8, T9 v9, T10 v10, T11 v11, T12 v12, T13 v13,
    T14 v14, T15 v15, T16 v16, T17 v17, T18 v18, T19 v19, T20 v20, T21 v21,
    T22 v22, T23 v23, T24 v24, T25 v25, T26 v26, T27 v27, T28 v28, T29 v29,
    T30 v30, T31 v31, T32 v32, T33 v33, T34 v34, T35 v35, T36 v36, T37 v37,
    T38 v38, T39 v39, T40 v40, T41 v41, T42 v42, T43 v43, T44 v44, T45 v45,
    T46 v46, T47 v47, T48 v48, T49 v49, T50 v50) {
  return internal::ValueArray50(v1, v2, v3, v4,
      v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19,
      v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33,
      v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47,
      v48, v49, v50);
}

// Bool() allows generating tests with parameters in a set of (false, true).
//
// Synopsis:
// Bool()
//   - returns a generator producing sequences with elements {false, true}.
//
// It is useful when testing code that depends on Boolean flags. Combinations
// of multiple flags can be tested when several Bool()'s are combined using
// Combine() function.
//
// In the following example all tests in the test case FlagDependentTest
// will be instantiated twice with parameters false and true.
//
// class FlagDependentTest : public testing::TestWithParam {
//   virtual void SetUp() {
//     external_flag = GetParam();
//   }
// }
// INSTANTIATE_TEST_CASE_P(BoolSequence, FlagDependentTest, Bool());
//
inline internal::ParamGenerator Bool() {
  return Values(false, true);
}

# if GTEST_HAS_COMBINE
// Combine() allows the user to combine two or more sequences to produce
// values of a Cartesian product of those sequences' elements.
//
// Synopsis:
// Combine(gen1, gen2, ..., genN)
//   - returns a generator producing sequences with elements coming from
//     the Cartesian product of elements from the sequences generated by
//     gen1, gen2, ..., genN. The sequence elements will have a type of
//     tuple where T1, T2, ..., TN are the types
//     of elements from sequences produces by gen1, gen2, ..., genN.
//
// Combine can have up to 10 arguments. This number is currently limited
// by the maximum number of elements in the tuple implementation used by Google
// Test.
//
// Example:
//
// This will instantiate tests in test case AnimalTest each one with
// the parameter values tuple("cat", BLACK), tuple("cat", WHITE),
// tuple("dog", BLACK), and tuple("dog", WHITE):
//
// enum Color { BLACK, GRAY, WHITE };
// class AnimalTest
//     : public testing::TestWithParam > {...};
//
// TEST_P(AnimalTest, AnimalLooksNice) {...}
//
// INSTANTIATE_TEST_CASE_P(AnimalVariations, AnimalTest,
//                         Combine(Values("cat", "dog"),
//                                 Values(BLACK, WHITE)));
//
// This will instantiate tests in FlagDependentTest with all variations of two
// Boolean flags:
//
// class FlagDependentTest
//     : public testing::TestWithParam > {
//   virtual void SetUp() {
//     // Assigns external_flag_1 and external_flag_2 values from the tuple.
//     tie(external_flag_1, external_flag_2) = GetParam();
//   }
// };
//
// TEST_P(FlagDependentTest, TestFeature1) {
//   // Test your code using external_flag_1 and external_flag_2 here.
// }
// INSTANTIATE_TEST_CASE_P(TwoBoolSequence, FlagDependentTest,
//                         Combine(Bool(), Bool()));
//
template 
internal::CartesianProductHolder2 Combine(
    const Generator1& g1, const Generator2& g2) {
  return internal::CartesianProductHolder2(
      g1, g2);
}

template 
internal::CartesianProductHolder3 Combine(
    const Generator1& g1, const Generator2& g2, const Generator3& g3) {
  return internal::CartesianProductHolder3(
      g1, g2, g3);
}

template 
internal::CartesianProductHolder4 Combine(
    const Generator1& g1, const Generator2& g2, const Generator3& g3,
        const Generator4& g4) {
  return internal::CartesianProductHolder4(
      g1, g2, g3, g4);
}

template 
internal::CartesianProductHolder5 Combine(
    const Generator1& g1, const Generator2& g2, const Generator3& g3,
        const Generator4& g4, const Generator5& g5) {
  return internal::CartesianProductHolder5(
      g1, g2, g3, g4, g5);
}

template 
internal::CartesianProductHolder6 Combine(
    const Generator1& g1, const Generator2& g2, const Generator3& g3,
        const Generator4& g4, const Generator5& g5, const Generator6& g6) {
  return internal::CartesianProductHolder6(
      g1, g2, g3, g4, g5, g6);
}

template 
internal::CartesianProductHolder7 Combine(
    const Generator1& g1, const Generator2& g2, const Generator3& g3,
        const Generator4& g4, const Generator5& g5, const Generator6& g6,
        const Generator7& g7) {
  return internal::CartesianProductHolder7(
      g1, g2, g3, g4, g5, g6, g7);
}

template 
internal::CartesianProductHolder8 Combine(
    const Generator1& g1, const Generator2& g2, const Generator3& g3,
        const Generator4& g4, const Generator5& g5, const Generator6& g6,
        const Generator7& g7, const Generator8& g8) {
  return internal::CartesianProductHolder8(
      g1, g2, g3, g4, g5, g6, g7, g8);
}

template 
internal::CartesianProductHolder9 Combine(
    const Generator1& g1, const Generator2& g2, const Generator3& g3,
        const Generator4& g4, const Generator5& g5, const Generator6& g6,
        const Generator7& g7, const Generator8& g8, const Generator9& g9) {
  return internal::CartesianProductHolder9(
      g1, g2, g3, g4, g5, g6, g7, g8, g9);
}

template 
internal::CartesianProductHolder10 Combine(
    const Generator1& g1, const Generator2& g2, const Generator3& g3,
        const Generator4& g4, const Generator5& g5, const Generator6& g6,
        const Generator7& g7, const Generator8& g8, const Generator9& g9,
        const Generator10& g10) {
  return internal::CartesianProductHolder10(
      g1, g2, g3, g4, g5, g6, g7, g8, g9, g10);
}
# endif  // GTEST_HAS_COMBINE



# define TEST_P(test_case_name, test_name) \
  class GTEST_TEST_CLASS_NAME_(test_case_name, test_name) \
      : public test_case_name { \
   public: \
    GTEST_TEST_CLASS_NAME_(test_case_name, test_name)() {} \
    virtual void TestBody(); \
   private: \
    static int AddToRegistry() { \
      ::testing::UnitTest::GetInstance()->parameterized_test_registry(). \
          GetTestCasePatternHolder(\
              #test_case_name, __FILE__, __LINE__)->AddTestPattern(\
                  #test_case_name, \
                  #test_name, \
                  new ::testing::internal::TestMetaFactory< \
                      GTEST_TEST_CLASS_NAME_(test_case_name, test_name)>()); \
      return 0; \
    } \
    static int gtest_registering_dummy_; \
    GTEST_DISALLOW_COPY_AND_ASSIGN_(\
        GTEST_TEST_CLASS_NAME_(test_case_name, test_name)); \
  }; \
  int GTEST_TEST_CLASS_NAME_(test_case_name, \
                             test_name)::gtest_registering_dummy_ = \
      GTEST_TEST_CLASS_NAME_(test_case_name, test_name)::AddToRegistry(); \
  void GTEST_TEST_CLASS_NAME_(test_case_name, test_name)::TestBody()

# define INSTANTIATE_TEST_CASE_P(prefix, test_case_name, generator) \
  ::testing::internal::ParamGenerator \
      gtest_##prefix##test_case_name##_EvalGenerator_() { return generator; } \
  int gtest_##prefix##test_case_name##_dummy_ = \
      ::testing::UnitTest::GetInstance()->parameterized_test_registry(). \
          GetTestCasePatternHolder(\
              #test_case_name, __FILE__, __LINE__)->AddTestCaseInstantiation(\
                  #prefix, \
                  >est_##prefix##test_case_name##_EvalGenerator_, \
                  __FILE__, __LINE__)

}  // namespace testing

#endif  // GTEST_HAS_PARAM_TEST

#endif  // GTEST_INCLUDE_GTEST_GTEST_PARAM_TEST_H_
node-v4.8.2/deps/gtest/include/gtest/gtest-printers.h000644 000766 000024 00000077237 13070706730 022770 0ustar00iojsstaff000000 000000 // Copyright 2007, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Author: wan@google.com (Zhanyong Wan)

// Google Test - The Google C++ Testing Framework
//
// This file implements a universal value printer that can print a
// value of any type T:
//
//   void ::testing::internal::UniversalPrinter::Print(value, ostream_ptr);
//
// A user can teach this function how to print a class type T by
// defining either operator<<() or PrintTo() in the namespace that
// defines T.  More specifically, the FIRST defined function in the
// following list will be used (assuming T is defined in namespace
// foo):
//
//   1. foo::PrintTo(const T&, ostream*)
//   2. operator<<(ostream&, const T&) defined in either foo or the
//      global namespace.
//
// If none of the above is defined, it will print the debug string of
// the value if it is a protocol buffer, or print the raw bytes in the
// value otherwise.
//
// To aid debugging: when T is a reference type, the address of the
// value is also printed; when T is a (const) char pointer, both the
// pointer value and the NUL-terminated string it points to are
// printed.
//
// We also provide some convenient wrappers:
//
//   // Prints a value to a string.  For a (const or not) char
//   // pointer, the NUL-terminated string (but not the pointer) is
//   // printed.
//   std::string ::testing::PrintToString(const T& value);
//
//   // Prints a value tersely: for a reference type, the referenced
//   // value (but not the address) is printed; for a (const or not) char
//   // pointer, the NUL-terminated string (but not the pointer) is
//   // printed.
//   void ::testing::internal::UniversalTersePrint(const T& value, ostream*);
//
//   // Prints value using the type inferred by the compiler.  The difference
//   // from UniversalTersePrint() is that this function prints both the
//   // pointer and the NUL-terminated string for a (const or not) char pointer.
//   void ::testing::internal::UniversalPrint(const T& value, ostream*);
//
//   // Prints the fields of a tuple tersely to a string vector, one
//   // element for each field. Tuple support must be enabled in
//   // gtest-port.h.
//   std::vector UniversalTersePrintTupleFieldsToStrings(
//       const Tuple& value);
//
// Known limitation:
//
// The print primitives print the elements of an STL-style container
// using the compiler-inferred type of *iter where iter is a
// const_iterator of the container.  When const_iterator is an input
// iterator but not a forward iterator, this inferred type may not
// match value_type, and the print output may be incorrect.  In
// practice, this is rarely a problem as for most containers
// const_iterator is a forward iterator.  We'll fix this if there's an
// actual need for it.  Note that this fix cannot rely on value_type
// being defined as many user-defined container types don't have
// value_type.

#ifndef GTEST_INCLUDE_GTEST_GTEST_PRINTERS_H_
#define GTEST_INCLUDE_GTEST_GTEST_PRINTERS_H_

#include   // NOLINT
#include 
#include 
#include 
#include 
#include "gtest/internal/gtest-port.h"
#include "gtest/internal/gtest-internal.h"

#if GTEST_HAS_STD_TUPLE_
# include 
#endif

namespace testing {

// Definitions in the 'internal' and 'internal2' name spaces are
// subject to change without notice.  DO NOT USE THEM IN USER CODE!
namespace internal2 {

// Prints the given number of bytes in the given object to the given
// ostream.
GTEST_API_ void PrintBytesInObjectTo(const unsigned char* obj_bytes,
                                     size_t count,
                                     ::std::ostream* os);

// For selecting which printer to use when a given type has neither <<
// nor PrintTo().
enum TypeKind {
  kProtobuf,              // a protobuf type
  kConvertibleToInteger,  // a type implicitly convertible to BiggestInt
                          // (e.g. a named or unnamed enum type)
  kOtherType              // anything else
};

// TypeWithoutFormatter::PrintValue(value, os) is called
// by the universal printer to print a value of type T when neither
// operator<< nor PrintTo() is defined for T, where kTypeKind is the
// "kind" of T as defined by enum TypeKind.
template 
class TypeWithoutFormatter {
 public:
  // This default version is called when kTypeKind is kOtherType.
  static void PrintValue(const T& value, ::std::ostream* os) {
    PrintBytesInObjectTo(reinterpret_cast(&value),
                         sizeof(value), os);
  }
};

// We print a protobuf using its ShortDebugString() when the string
// doesn't exceed this many characters; otherwise we print it using
// DebugString() for better readability.
const size_t kProtobufOneLinerMaxLength = 50;

template 
class TypeWithoutFormatter {
 public:
  static void PrintValue(const T& value, ::std::ostream* os) {
    const ::testing::internal::string short_str = value.ShortDebugString();
    const ::testing::internal::string pretty_str =
        short_str.length() <= kProtobufOneLinerMaxLength ?
        short_str : ("\n" + value.DebugString());
    *os << ("<" + pretty_str + ">");
  }
};

template 
class TypeWithoutFormatter {
 public:
  // Since T has no << operator or PrintTo() but can be implicitly
  // converted to BiggestInt, we print it as a BiggestInt.
  //
  // Most likely T is an enum type (either named or unnamed), in which
  // case printing it as an integer is the desired behavior.  In case
  // T is not an enum, printing it as an integer is the best we can do
  // given that it has no user-defined printer.
  static void PrintValue(const T& value, ::std::ostream* os) {
    const internal::BiggestInt kBigInt = value;
    *os << kBigInt;
  }
};

// Prints the given value to the given ostream.  If the value is a
// protocol message, its debug string is printed; if it's an enum or
// of a type implicitly convertible to BiggestInt, it's printed as an
// integer; otherwise the bytes in the value are printed.  This is
// what UniversalPrinter::Print() does when it knows nothing about
// type T and T has neither << operator nor PrintTo().
//
// A user can override this behavior for a class type Foo by defining
// a << operator in the namespace where Foo is defined.
//
// We put this operator in namespace 'internal2' instead of 'internal'
// to simplify the implementation, as much code in 'internal' needs to
// use << in STL, which would conflict with our own << were it defined
// in 'internal'.
//
// Note that this operator<< takes a generic std::basic_ostream type instead of the more restricted std::ostream.  If
// we define it to take an std::ostream instead, we'll get an
// "ambiguous overloads" compiler error when trying to print a type
// Foo that supports streaming to std::basic_ostream, as the compiler cannot tell whether
// operator<<(std::ostream&, const T&) or
// operator<<(std::basic_stream, const Foo&) is more
// specific.
template 
::std::basic_ostream& operator<<(
    ::std::basic_ostream& os, const T& x) {
  TypeWithoutFormatter::value ? kProtobuf :
       internal::ImplicitlyConvertible::value ?
       kConvertibleToInteger : kOtherType)>::PrintValue(x, &os);
  return os;
}

}  // namespace internal2
}  // namespace testing

// This namespace MUST NOT BE NESTED IN ::testing, or the name look-up
// magic needed for implementing UniversalPrinter won't work.
namespace testing_internal {

// Used to print a value that is not an STL-style container when the
// user doesn't define PrintTo() for it.
template 
void DefaultPrintNonContainerTo(const T& value, ::std::ostream* os) {
  // With the following statement, during unqualified name lookup,
  // testing::internal2::operator<< appears as if it was declared in
  // the nearest enclosing namespace that contains both
  // ::testing_internal and ::testing::internal2, i.e. the global
  // namespace.  For more details, refer to the C++ Standard section
  // 7.3.4-1 [namespace.udir].  This allows us to fall back onto
  // testing::internal2::operator<< in case T doesn't come with a <<
  // operator.
  //
  // We cannot write 'using ::testing::internal2::operator<<;', which
  // gcc 3.3 fails to compile due to a compiler bug.
  using namespace ::testing::internal2;  // NOLINT

  // Assuming T is defined in namespace foo, in the next statement,
  // the compiler will consider all of:
  //
  //   1. foo::operator<< (thanks to Koenig look-up),
  //   2. ::operator<< (as the current namespace is enclosed in ::),
  //   3. testing::internal2::operator<< (thanks to the using statement above).
  //
  // The operator<< whose type matches T best will be picked.
  //
  // We deliberately allow #2 to be a candidate, as sometimes it's
  // impossible to define #1 (e.g. when foo is ::std, defining
  // anything in it is undefined behavior unless you are a compiler
  // vendor.).
  *os << value;
}

}  // namespace testing_internal

namespace testing {
namespace internal {

// UniversalPrinter::Print(value, ostream_ptr) prints the given
// value to the given ostream.  The caller must ensure that
// 'ostream_ptr' is not NULL, or the behavior is undefined.
//
// We define UniversalPrinter as a class template (as opposed to a
// function template), as we need to partially specialize it for
// reference types, which cannot be done with function templates.
template 
class UniversalPrinter;

template 
void UniversalPrint(const T& value, ::std::ostream* os);

// Used to print an STL-style container when the user doesn't define
// a PrintTo() for it.
template 
void DefaultPrintTo(IsContainer /* dummy */,
                    false_type /* is not a pointer */,
                    const C& container, ::std::ostream* os) {
  const size_t kMaxCount = 32;  // The maximum number of elements to print.
  *os << '{';
  size_t count = 0;
  for (typename C::const_iterator it = container.begin();
       it != container.end(); ++it, ++count) {
    if (count > 0) {
      *os << ',';
      if (count == kMaxCount) {  // Enough has been printed.
        *os << " ...";
        break;
      }
    }
    *os << ' ';
    // We cannot call PrintTo(*it, os) here as PrintTo() doesn't
    // handle *it being a native array.
    internal::UniversalPrint(*it, os);
  }

  if (count > 0) {
    *os << ' ';
  }
  *os << '}';
}

// Used to print a pointer that is neither a char pointer nor a member
// pointer, when the user doesn't define PrintTo() for it.  (A member
// variable pointer or member function pointer doesn't really point to
// a location in the address space.  Their representation is
// implementation-defined.  Therefore they will be printed as raw
// bytes.)
template 
void DefaultPrintTo(IsNotContainer /* dummy */,
                    true_type /* is a pointer */,
                    T* p, ::std::ostream* os) {
  if (p == NULL) {
    *os << "NULL";
  } else {
    // C++ doesn't allow casting from a function pointer to any object
    // pointer.
    //
    // IsTrue() silences warnings: "Condition is always true",
    // "unreachable code".
    if (IsTrue(ImplicitlyConvertible::value)) {
      // T is not a function type.  We just call << to print p,
      // relying on ADL to pick up user-defined << for their pointer
      // types, if any.
      *os << p;
    } else {
      // T is a function type, so '*os << p' doesn't do what we want
      // (it just prints p as bool).  We want to print p as a const
      // void*.  However, we cannot cast it to const void* directly,
      // even using reinterpret_cast, as earlier versions of gcc
      // (e.g. 3.4.5) cannot compile the cast when p is a function
      // pointer.  Casting to UInt64 first solves the problem.
      *os << reinterpret_cast(
          reinterpret_cast(p));
    }
  }
}

// Used to print a non-container, non-pointer value when the user
// doesn't define PrintTo() for it.
template 
void DefaultPrintTo(IsNotContainer /* dummy */,
                    false_type /* is not a pointer */,
                    const T& value, ::std::ostream* os) {
  ::testing_internal::DefaultPrintNonContainerTo(value, os);
}

// Prints the given value using the << operator if it has one;
// otherwise prints the bytes in it.  This is what
// UniversalPrinter::Print() does when PrintTo() is not specialized
// or overloaded for type T.
//
// A user can override this behavior for a class type Foo by defining
// an overload of PrintTo() in the namespace where Foo is defined.  We
// give the user this option as sometimes defining a << operator for
// Foo is not desirable (e.g. the coding style may prevent doing it,
// or there is already a << operator but it doesn't do what the user
// wants).
template 
void PrintTo(const T& value, ::std::ostream* os) {
  // DefaultPrintTo() is overloaded.  The type of its first two
  // arguments determine which version will be picked.  If T is an
  // STL-style container, the version for container will be called; if
  // T is a pointer, the pointer version will be called; otherwise the
  // generic version will be called.
  //
  // Note that we check for container types here, prior to we check
  // for protocol message types in our operator<<.  The rationale is:
  //
  // For protocol messages, we want to give people a chance to
  // override Google Mock's format by defining a PrintTo() or
  // operator<<.  For STL containers, other formats can be
  // incompatible with Google Mock's format for the container
  // elements; therefore we check for container types here to ensure
  // that our format is used.
  //
  // The second argument of DefaultPrintTo() is needed to bypass a bug
  // in Symbian's C++ compiler that prevents it from picking the right
  // overload between:
  //
  //   PrintTo(const T& x, ...);
  //   PrintTo(T* x, ...);
  DefaultPrintTo(IsContainerTest(0), is_pointer(), value, os);
}

// The following list of PrintTo() overloads tells
// UniversalPrinter::Print() how to print standard types (built-in
// types, strings, plain arrays, and pointers).

// Overloads for various char types.
GTEST_API_ void PrintTo(unsigned char c, ::std::ostream* os);
GTEST_API_ void PrintTo(signed char c, ::std::ostream* os);
inline void PrintTo(char c, ::std::ostream* os) {
  // When printing a plain char, we always treat it as unsigned.  This
  // way, the output won't be affected by whether the compiler thinks
  // char is signed or not.
  PrintTo(static_cast(c), os);
}

// Overloads for other simple built-in types.
inline void PrintTo(bool x, ::std::ostream* os) {
  *os << (x ? "true" : "false");
}

// Overload for wchar_t type.
// Prints a wchar_t as a symbol if it is printable or as its internal
// code otherwise and also as its decimal code (except for L'\0').
// The L'\0' char is printed as "L'\\0'". The decimal code is printed
// as signed integer when wchar_t is implemented by the compiler
// as a signed type and is printed as an unsigned integer when wchar_t
// is implemented as an unsigned type.
GTEST_API_ void PrintTo(wchar_t wc, ::std::ostream* os);

// Overloads for C strings.
GTEST_API_ void PrintTo(const char* s, ::std::ostream* os);
inline void PrintTo(char* s, ::std::ostream* os) {
  PrintTo(ImplicitCast_(s), os);
}

// signed/unsigned char is often used for representing binary data, so
// we print pointers to it as void* to be safe.
inline void PrintTo(const signed char* s, ::std::ostream* os) {
  PrintTo(ImplicitCast_(s), os);
}
inline void PrintTo(signed char* s, ::std::ostream* os) {
  PrintTo(ImplicitCast_(s), os);
}
inline void PrintTo(const unsigned char* s, ::std::ostream* os) {
  PrintTo(ImplicitCast_(s), os);
}
inline void PrintTo(unsigned char* s, ::std::ostream* os) {
  PrintTo(ImplicitCast_(s), os);
}

// MSVC can be configured to define wchar_t as a typedef of unsigned
// short.  It defines _NATIVE_WCHAR_T_DEFINED when wchar_t is a native
// type.  When wchar_t is a typedef, defining an overload for const
// wchar_t* would cause unsigned short* be printed as a wide string,
// possibly causing invalid memory accesses.
#if !defined(_MSC_VER) || defined(_NATIVE_WCHAR_T_DEFINED)
// Overloads for wide C strings
GTEST_API_ void PrintTo(const wchar_t* s, ::std::ostream* os);
inline void PrintTo(wchar_t* s, ::std::ostream* os) {
  PrintTo(ImplicitCast_(s), os);
}
#endif

// Overload for C arrays.  Multi-dimensional arrays are printed
// properly.

// Prints the given number of elements in an array, without printing
// the curly braces.
template 
void PrintRawArrayTo(const T a[], size_t count, ::std::ostream* os) {
  UniversalPrint(a[0], os);
  for (size_t i = 1; i != count; i++) {
    *os << ", ";
    UniversalPrint(a[i], os);
  }
}

// Overloads for ::string and ::std::string.
#if GTEST_HAS_GLOBAL_STRING
GTEST_API_ void PrintStringTo(const ::string&s, ::std::ostream* os);
inline void PrintTo(const ::string& s, ::std::ostream* os) {
  PrintStringTo(s, os);
}
#endif  // GTEST_HAS_GLOBAL_STRING

GTEST_API_ void PrintStringTo(const ::std::string&s, ::std::ostream* os);
inline void PrintTo(const ::std::string& s, ::std::ostream* os) {
  PrintStringTo(s, os);
}

// Overloads for ::wstring and ::std::wstring.
#if GTEST_HAS_GLOBAL_WSTRING
GTEST_API_ void PrintWideStringTo(const ::wstring&s, ::std::ostream* os);
inline void PrintTo(const ::wstring& s, ::std::ostream* os) {
  PrintWideStringTo(s, os);
}
#endif  // GTEST_HAS_GLOBAL_WSTRING

#if GTEST_HAS_STD_WSTRING
GTEST_API_ void PrintWideStringTo(const ::std::wstring&s, ::std::ostream* os);
inline void PrintTo(const ::std::wstring& s, ::std::ostream* os) {
  PrintWideStringTo(s, os);
}
#endif  // GTEST_HAS_STD_WSTRING

#if GTEST_HAS_TR1_TUPLE || GTEST_HAS_STD_TUPLE_
// Helper function for printing a tuple.  T must be instantiated with
// a tuple type.
template 
void PrintTupleTo(const T& t, ::std::ostream* os);
#endif  // GTEST_HAS_TR1_TUPLE || GTEST_HAS_STD_TUPLE_

#if GTEST_HAS_TR1_TUPLE
// Overload for ::std::tr1::tuple.  Needed for printing function arguments,
// which are packed as tuples.

// Overloaded PrintTo() for tuples of various arities.  We support
// tuples of up-to 10 fields.  The following implementation works
// regardless of whether tr1::tuple is implemented using the
// non-standard variadic template feature or not.

inline void PrintTo(const ::std::tr1::tuple<>& t, ::std::ostream* os) {
  PrintTupleTo(t, os);
}

template 
void PrintTo(const ::std::tr1::tuple& t, ::std::ostream* os) {
  PrintTupleTo(t, os);
}

template 
void PrintTo(const ::std::tr1::tuple& t, ::std::ostream* os) {
  PrintTupleTo(t, os);
}

template 
void PrintTo(const ::std::tr1::tuple& t, ::std::ostream* os) {
  PrintTupleTo(t, os);
}

template 
void PrintTo(const ::std::tr1::tuple& t, ::std::ostream* os) {
  PrintTupleTo(t, os);
}

template 
void PrintTo(const ::std::tr1::tuple& t,
             ::std::ostream* os) {
  PrintTupleTo(t, os);
}

template 
void PrintTo(const ::std::tr1::tuple& t,
             ::std::ostream* os) {
  PrintTupleTo(t, os);
}

template 
void PrintTo(const ::std::tr1::tuple& t,
             ::std::ostream* os) {
  PrintTupleTo(t, os);
}

template 
void PrintTo(const ::std::tr1::tuple& t,
             ::std::ostream* os) {
  PrintTupleTo(t, os);
}

template 
void PrintTo(const ::std::tr1::tuple& t,
             ::std::ostream* os) {
  PrintTupleTo(t, os);
}

template 
void PrintTo(
    const ::std::tr1::tuple& t,
    ::std::ostream* os) {
  PrintTupleTo(t, os);
}
#endif  // GTEST_HAS_TR1_TUPLE

#if GTEST_HAS_STD_TUPLE_
template 
void PrintTo(const ::std::tuple& t, ::std::ostream* os) {
  PrintTupleTo(t, os);
}
#endif  // GTEST_HAS_STD_TUPLE_

// Overload for std::pair.
template 
void PrintTo(const ::std::pair& value, ::std::ostream* os) {
  *os << '(';
  // We cannot use UniversalPrint(value.first, os) here, as T1 may be
  // a reference type.  The same for printing value.second.
  UniversalPrinter::Print(value.first, os);
  *os << ", ";
  UniversalPrinter::Print(value.second, os);
  *os << ')';
}

// Implements printing a non-reference type T by letting the compiler
// pick the right overload of PrintTo() for T.
template 
class UniversalPrinter {
 public:
  // MSVC warns about adding const to a function type, so we want to
  // disable the warning.
  GTEST_DISABLE_MSC_WARNINGS_PUSH_(4180)

  // Note: we deliberately don't call this PrintTo(), as that name
  // conflicts with ::testing::internal::PrintTo in the body of the
  // function.
  static void Print(const T& value, ::std::ostream* os) {
    // By default, ::testing::internal::PrintTo() is used for printing
    // the value.
    //
    // Thanks to Koenig look-up, if T is a class and has its own
    // PrintTo() function defined in its namespace, that function will
    // be visible here.  Since it is more specific than the generic ones
    // in ::testing::internal, it will be picked by the compiler in the
    // following statement - exactly what we want.
    PrintTo(value, os);
  }

  GTEST_DISABLE_MSC_WARNINGS_POP_()
};

// UniversalPrintArray(begin, len, os) prints an array of 'len'
// elements, starting at address 'begin'.
template 
void UniversalPrintArray(const T* begin, size_t len, ::std::ostream* os) {
  if (len == 0) {
    *os << "{}";
  } else {
    *os << "{ ";
    const size_t kThreshold = 18;
    const size_t kChunkSize = 8;
    // If the array has more than kThreshold elements, we'll have to
    // omit some details by printing only the first and the last
    // kChunkSize elements.
    // TODO(wan@google.com): let the user control the threshold using a flag.
    if (len <= kThreshold) {
      PrintRawArrayTo(begin, len, os);
    } else {
      PrintRawArrayTo(begin, kChunkSize, os);
      *os << ", ..., ";
      PrintRawArrayTo(begin + len - kChunkSize, kChunkSize, os);
    }
    *os << " }";
  }
}
// This overload prints a (const) char array compactly.
GTEST_API_ void UniversalPrintArray(
    const char* begin, size_t len, ::std::ostream* os);

// This overload prints a (const) wchar_t array compactly.
GTEST_API_ void UniversalPrintArray(
    const wchar_t* begin, size_t len, ::std::ostream* os);

// Implements printing an array type T[N].
template 
class UniversalPrinter {
 public:
  // Prints the given array, omitting some elements when there are too
  // many.
  static void Print(const T (&a)[N], ::std::ostream* os) {
    UniversalPrintArray(a, N, os);
  }
};

// Implements printing a reference type T&.
template 
class UniversalPrinter {
 public:
  // MSVC warns about adding const to a function type, so we want to
  // disable the warning.
  GTEST_DISABLE_MSC_WARNINGS_PUSH_(4180)

  static void Print(const T& value, ::std::ostream* os) {
    // Prints the address of the value.  We use reinterpret_cast here
    // as static_cast doesn't compile when T is a function type.
    *os << "@" << reinterpret_cast(&value) << " ";

    // Then prints the value itself.
    UniversalPrint(value, os);
  }

  GTEST_DISABLE_MSC_WARNINGS_POP_()
};

// Prints a value tersely: for a reference type, the referenced value
// (but not the address) is printed; for a (const) char pointer, the
// NUL-terminated string (but not the pointer) is printed.

template 
class UniversalTersePrinter {
 public:
  static void Print(const T& value, ::std::ostream* os) {
    UniversalPrint(value, os);
  }
};
template 
class UniversalTersePrinter {
 public:
  static void Print(const T& value, ::std::ostream* os) {
    UniversalPrint(value, os);
  }
};
template 
class UniversalTersePrinter {
 public:
  static void Print(const T (&value)[N], ::std::ostream* os) {
    UniversalPrinter::Print(value, os);
  }
};
template <>
class UniversalTersePrinter {
 public:
  static void Print(const char* str, ::std::ostream* os) {
    if (str == NULL) {
      *os << "NULL";
    } else {
      UniversalPrint(string(str), os);
    }
  }
};
template <>
class UniversalTersePrinter {
 public:
  static void Print(char* str, ::std::ostream* os) {
    UniversalTersePrinter::Print(str, os);
  }
};

#if GTEST_HAS_STD_WSTRING
template <>
class UniversalTersePrinter {
 public:
  static void Print(const wchar_t* str, ::std::ostream* os) {
    if (str == NULL) {
      *os << "NULL";
    } else {
      UniversalPrint(::std::wstring(str), os);
    }
  }
};
#endif

template <>
class UniversalTersePrinter {
 public:
  static void Print(wchar_t* str, ::std::ostream* os) {
    UniversalTersePrinter::Print(str, os);
  }
};

template 
void UniversalTersePrint(const T& value, ::std::ostream* os) {
  UniversalTersePrinter::Print(value, os);
}

// Prints a value using the type inferred by the compiler.  The
// difference between this and UniversalTersePrint() is that for a
// (const) char pointer, this prints both the pointer and the
// NUL-terminated string.
template 
void UniversalPrint(const T& value, ::std::ostream* os) {
  // A workarond for the bug in VC++ 7.1 that prevents us from instantiating
  // UniversalPrinter with T directly.
  typedef T T1;
  UniversalPrinter::Print(value, os);
}

typedef ::std::vector Strings;

// TuplePolicy must provide:
// - tuple_size
//     size of tuple TupleT.
// - get(const TupleT& t)
//     static function extracting element I of tuple TupleT.
// - tuple_element::type
//     type of element I of tuple TupleT.
template 
struct TuplePolicy;

#if GTEST_HAS_TR1_TUPLE
template 
struct TuplePolicy {
  typedef TupleT Tuple;
  static const size_t tuple_size = ::std::tr1::tuple_size::value;

  template 
  struct tuple_element : ::std::tr1::tuple_element {};

  template 
  static typename AddReference<
      const typename ::std::tr1::tuple_element::type>::type get(
      const Tuple& tuple) {
    return ::std::tr1::get(tuple);
  }
};
template 
const size_t TuplePolicy::tuple_size;
#endif  // GTEST_HAS_TR1_TUPLE

#if GTEST_HAS_STD_TUPLE_
template 
struct TuplePolicy< ::std::tuple > {
  typedef ::std::tuple Tuple;
  static const size_t tuple_size = ::std::tuple_size::value;

  template 
  struct tuple_element : ::std::tuple_element {};

  template 
  static const typename ::std::tuple_element::type& get(
      const Tuple& tuple) {
    return ::std::get(tuple);
  }
};
template 
const size_t TuplePolicy< ::std::tuple >::tuple_size;
#endif  // GTEST_HAS_STD_TUPLE_

#if GTEST_HAS_TR1_TUPLE || GTEST_HAS_STD_TUPLE_
// This helper template allows PrintTo() for tuples and
// UniversalTersePrintTupleFieldsToStrings() to be defined by
// induction on the number of tuple fields.  The idea is that
// TuplePrefixPrinter::PrintPrefixTo(t, os) prints the first N
// fields in tuple t, and can be defined in terms of
// TuplePrefixPrinter.
//
// The inductive case.
template 
struct TuplePrefixPrinter {
  // Prints the first N fields of a tuple.
  template 
  static void PrintPrefixTo(const Tuple& t, ::std::ostream* os) {
    TuplePrefixPrinter::PrintPrefixTo(t, os);
    GTEST_INTENTIONAL_CONST_COND_PUSH_()
    if (N > 1) {
    GTEST_INTENTIONAL_CONST_COND_POP_()
      *os << ", ";
    }
    UniversalPrinter<
        typename TuplePolicy::template tuple_element::type>
        ::Print(TuplePolicy::template get(t), os);
  }

  // Tersely prints the first N fields of a tuple to a string vector,
  // one element for each field.
  template 
  static void TersePrintPrefixToStrings(const Tuple& t, Strings* strings) {
    TuplePrefixPrinter::TersePrintPrefixToStrings(t, strings);
    ::std::stringstream ss;
    UniversalTersePrint(TuplePolicy::template get(t), &ss);
    strings->push_back(ss.str());
  }
};

// Base case.
template <>
struct TuplePrefixPrinter<0> {
  template 
  static void PrintPrefixTo(const Tuple&, ::std::ostream*) {}

  template 
  static void TersePrintPrefixToStrings(const Tuple&, Strings*) {}
};

// Helper function for printing a tuple.
// Tuple must be either std::tr1::tuple or std::tuple type.
template 
void PrintTupleTo(const Tuple& t, ::std::ostream* os) {
  *os << "(";
  TuplePrefixPrinter::tuple_size>::PrintPrefixTo(t, os);
  *os << ")";
}

// Prints the fields of a tuple tersely to a string vector, one
// element for each field.  See the comment before
// UniversalTersePrint() for how we define "tersely".
template 
Strings UniversalTersePrintTupleFieldsToStrings(const Tuple& value) {
  Strings result;
  TuplePrefixPrinter::tuple_size>::
      TersePrintPrefixToStrings(value, &result);
  return result;
}
#endif  // GTEST_HAS_TR1_TUPLE || GTEST_HAS_STD_TUPLE_

}  // namespace internal

template 
::std::string PrintToString(const T& value) {
  ::std::stringstream ss;
  internal::UniversalTersePrinter::Print(value, &ss);
  return ss.str();
}

}  // namespace testing

#endif  // GTEST_INCLUDE_GTEST_GTEST_PRINTERS_H_
node-v4.8.2/deps/gtest/include/gtest/gtest-spi.h000644 000766 000024 00000023340 13070706730 021677 0ustar00iojsstaff000000 000000 // Copyright 2007, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Author: wan@google.com (Zhanyong Wan)
//
// Utilities for testing Google Test itself and code that uses Google Test
// (e.g. frameworks built on top of Google Test).

#ifndef GTEST_INCLUDE_GTEST_GTEST_SPI_H_
#define GTEST_INCLUDE_GTEST_GTEST_SPI_H_

#include "gtest/gtest.h"

namespace testing {

// This helper class can be used to mock out Google Test failure reporting
// so that we can test Google Test or code that builds on Google Test.
//
// An object of this class appends a TestPartResult object to the
// TestPartResultArray object given in the constructor whenever a Google Test
// failure is reported. It can either intercept only failures that are
// generated in the same thread that created this object or it can intercept
// all generated failures. The scope of this mock object can be controlled with
// the second argument to the two arguments constructor.
class GTEST_API_ ScopedFakeTestPartResultReporter
    : public TestPartResultReporterInterface {
 public:
  // The two possible mocking modes of this object.
  enum InterceptMode {
    INTERCEPT_ONLY_CURRENT_THREAD,  // Intercepts only thread local failures.
    INTERCEPT_ALL_THREADS           // Intercepts all failures.
  };

  // The c'tor sets this object as the test part result reporter used
  // by Google Test.  The 'result' parameter specifies where to report the
  // results. This reporter will only catch failures generated in the current
  // thread. DEPRECATED
  explicit ScopedFakeTestPartResultReporter(TestPartResultArray* result);

  // Same as above, but you can choose the interception scope of this object.
  ScopedFakeTestPartResultReporter(InterceptMode intercept_mode,
                                   TestPartResultArray* result);

  // The d'tor restores the previous test part result reporter.
  virtual ~ScopedFakeTestPartResultReporter();

  // Appends the TestPartResult object to the TestPartResultArray
  // received in the constructor.
  //
  // This method is from the TestPartResultReporterInterface
  // interface.
  virtual void ReportTestPartResult(const TestPartResult& result);
 private:
  void Init();

  const InterceptMode intercept_mode_;
  TestPartResultReporterInterface* old_reporter_;
  TestPartResultArray* const result_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(ScopedFakeTestPartResultReporter);
};

namespace internal {

// A helper class for implementing EXPECT_FATAL_FAILURE() and
// EXPECT_NONFATAL_FAILURE().  Its destructor verifies that the given
// TestPartResultArray contains exactly one failure that has the given
// type and contains the given substring.  If that's not the case, a
// non-fatal failure will be generated.
class GTEST_API_ SingleFailureChecker {
 public:
  // The constructor remembers the arguments.
  SingleFailureChecker(const TestPartResultArray* results,
                       TestPartResult::Type type,
                       const string& substr);
  ~SingleFailureChecker();
 private:
  const TestPartResultArray* const results_;
  const TestPartResult::Type type_;
  const string substr_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(SingleFailureChecker);
};

}  // namespace internal

}  // namespace testing

// A set of macros for testing Google Test assertions or code that's expected
// to generate Google Test fatal failures.  It verifies that the given
// statement will cause exactly one fatal Google Test failure with 'substr'
// being part of the failure message.
//
// There are two different versions of this macro. EXPECT_FATAL_FAILURE only
// affects and considers failures generated in the current thread and
// EXPECT_FATAL_FAILURE_ON_ALL_THREADS does the same but for all threads.
//
// The verification of the assertion is done correctly even when the statement
// throws an exception or aborts the current function.
//
// Known restrictions:
//   - 'statement' cannot reference local non-static variables or
//     non-static members of the current object.
//   - 'statement' cannot return a value.
//   - You cannot stream a failure message to this macro.
//
// Note that even though the implementations of the following two
// macros are much alike, we cannot refactor them to use a common
// helper macro, due to some peculiarity in how the preprocessor
// works.  The AcceptsMacroThatExpandsToUnprotectedComma test in
// gtest_unittest.cc will fail to compile if we do that.
#define EXPECT_FATAL_FAILURE(statement, substr) \
  do { \
    class GTestExpectFatalFailureHelper {\
     public:\
      static void Execute() { statement; }\
    };\
    ::testing::TestPartResultArray gtest_failures;\
    ::testing::internal::SingleFailureChecker gtest_checker(\
        >est_failures, ::testing::TestPartResult::kFatalFailure, (substr));\
    {\
      ::testing::ScopedFakeTestPartResultReporter gtest_reporter(\
          ::testing::ScopedFakeTestPartResultReporter:: \
          INTERCEPT_ONLY_CURRENT_THREAD, >est_failures);\
      GTestExpectFatalFailureHelper::Execute();\
    }\
  } while (::testing::internal::AlwaysFalse())

#define EXPECT_FATAL_FAILURE_ON_ALL_THREADS(statement, substr) \
  do { \
    class GTestExpectFatalFailureHelper {\
     public:\
      static void Execute() { statement; }\
    };\
    ::testing::TestPartResultArray gtest_failures;\
    ::testing::internal::SingleFailureChecker gtest_checker(\
        >est_failures, ::testing::TestPartResult::kFatalFailure, (substr));\
    {\
      ::testing::ScopedFakeTestPartResultReporter gtest_reporter(\
          ::testing::ScopedFakeTestPartResultReporter:: \
          INTERCEPT_ALL_THREADS, >est_failures);\
      GTestExpectFatalFailureHelper::Execute();\
    }\
  } while (::testing::internal::AlwaysFalse())

// A macro for testing Google Test assertions or code that's expected to
// generate Google Test non-fatal failures.  It asserts that the given
// statement will cause exactly one non-fatal Google Test failure with 'substr'
// being part of the failure message.
//
// There are two different versions of this macro. EXPECT_NONFATAL_FAILURE only
// affects and considers failures generated in the current thread and
// EXPECT_NONFATAL_FAILURE_ON_ALL_THREADS does the same but for all threads.
//
// 'statement' is allowed to reference local variables and members of
// the current object.
//
// The verification of the assertion is done correctly even when the statement
// throws an exception or aborts the current function.
//
// Known restrictions:
//   - You cannot stream a failure message to this macro.
//
// Note that even though the implementations of the following two
// macros are much alike, we cannot refactor them to use a common
// helper macro, due to some peculiarity in how the preprocessor
// works.  If we do that, the code won't compile when the user gives
// EXPECT_NONFATAL_FAILURE() a statement that contains a macro that
// expands to code containing an unprotected comma.  The
// AcceptsMacroThatExpandsToUnprotectedComma test in gtest_unittest.cc
// catches that.
//
// For the same reason, we have to write
//   if (::testing::internal::AlwaysTrue()) { statement; }
// instead of
//   GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(statement)
// to avoid an MSVC warning on unreachable code.
#define EXPECT_NONFATAL_FAILURE(statement, substr) \
  do {\
    ::testing::TestPartResultArray gtest_failures;\
    ::testing::internal::SingleFailureChecker gtest_checker(\
        >est_failures, ::testing::TestPartResult::kNonFatalFailure, \
        (substr));\
    {\
      ::testing::ScopedFakeTestPartResultReporter gtest_reporter(\
          ::testing::ScopedFakeTestPartResultReporter:: \
          INTERCEPT_ONLY_CURRENT_THREAD, >est_failures);\
      if (::testing::internal::AlwaysTrue()) { statement; }\
    }\
  } while (::testing::internal::AlwaysFalse())

#define EXPECT_NONFATAL_FAILURE_ON_ALL_THREADS(statement, substr) \
  do {\
    ::testing::TestPartResultArray gtest_failures;\
    ::testing::internal::SingleFailureChecker gtest_checker(\
        >est_failures, ::testing::TestPartResult::kNonFatalFailure, \
        (substr));\
    {\
      ::testing::ScopedFakeTestPartResultReporter gtest_reporter(\
          ::testing::ScopedFakeTestPartResultReporter::INTERCEPT_ALL_THREADS, \
          >est_failures);\
      if (::testing::internal::AlwaysTrue()) { statement; }\
    }\
  } while (::testing::internal::AlwaysFalse())

#endif  // GTEST_INCLUDE_GTEST_GTEST_SPI_H_
node-v4.8.2/deps/gtest/include/gtest/gtest-test-part.h000644 000766 000024 00000014555 13070706730 023037 0ustar00iojsstaff000000 000000 // Copyright 2008, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Author: mheule@google.com (Markus Heule)
//

#ifndef GTEST_INCLUDE_GTEST_GTEST_TEST_PART_H_
#define GTEST_INCLUDE_GTEST_GTEST_TEST_PART_H_

#include 
#include 
#include "gtest/internal/gtest-internal.h"
#include "gtest/internal/gtest-string.h"

namespace testing {

// A copyable object representing the result of a test part (i.e. an
// assertion or an explicit FAIL(), ADD_FAILURE(), or SUCCESS()).
//
// Don't inherit from TestPartResult as its destructor is not virtual.
class GTEST_API_ TestPartResult {
 public:
  // The possible outcomes of a test part (i.e. an assertion or an
  // explicit SUCCEED(), FAIL(), or ADD_FAILURE()).
  enum Type {
    kSuccess,          // Succeeded.
    kNonFatalFailure,  // Failed but the test can continue.
    kFatalFailure      // Failed and the test should be terminated.
  };

  // C'tor.  TestPartResult does NOT have a default constructor.
  // Always use this constructor (with parameters) to create a
  // TestPartResult object.
  TestPartResult(Type a_type,
                 const char* a_file_name,
                 int a_line_number,
                 const char* a_message)
      : type_(a_type),
        file_name_(a_file_name == NULL ? "" : a_file_name),
        line_number_(a_line_number),
        summary_(ExtractSummary(a_message)),
        message_(a_message) {
  }

  // Gets the outcome of the test part.
  Type type() const { return type_; }

  // Gets the name of the source file where the test part took place, or
  // NULL if it's unknown.
  const char* file_name() const {
    return file_name_.empty() ? NULL : file_name_.c_str();
  }

  // Gets the line in the source file where the test part took place,
  // or -1 if it's unknown.
  int line_number() const { return line_number_; }

  // Gets the summary of the failure message.
  const char* summary() const { return summary_.c_str(); }

  // Gets the message associated with the test part.
  const char* message() const { return message_.c_str(); }

  // Returns true iff the test part passed.
  bool passed() const { return type_ == kSuccess; }

  // Returns true iff the test part failed.
  bool failed() const { return type_ != kSuccess; }

  // Returns true iff the test part non-fatally failed.
  bool nonfatally_failed() const { return type_ == kNonFatalFailure; }

  // Returns true iff the test part fatally failed.
  bool fatally_failed() const { return type_ == kFatalFailure; }

 private:
  Type type_;

  // Gets the summary of the failure message by omitting the stack
  // trace in it.
  static std::string ExtractSummary(const char* message);

  // The name of the source file where the test part took place, or
  // "" if the source file is unknown.
  std::string file_name_;
  // The line in the source file where the test part took place, or -1
  // if the line number is unknown.
  int line_number_;
  std::string summary_;  // The test failure summary.
  std::string message_;  // The test failure message.
};

// Prints a TestPartResult object.
std::ostream& operator<<(std::ostream& os, const TestPartResult& result);

// An array of TestPartResult objects.
//
// Don't inherit from TestPartResultArray as its destructor is not
// virtual.
class GTEST_API_ TestPartResultArray {
 public:
  TestPartResultArray() {}

  // Appends the given TestPartResult to the array.
  void Append(const TestPartResult& result);

  // Returns the TestPartResult at the given index (0-based).
  const TestPartResult& GetTestPartResult(int index) const;

  // Returns the number of TestPartResult objects in the array.
  int size() const;

 private:
  std::vector array_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(TestPartResultArray);
};

// This interface knows how to report a test part result.
class TestPartResultReporterInterface {
 public:
  virtual ~TestPartResultReporterInterface() {}

  virtual void ReportTestPartResult(const TestPartResult& result) = 0;
};

namespace internal {

// This helper class is used by {ASSERT|EXPECT}_NO_FATAL_FAILURE to check if a
// statement generates new fatal failures. To do so it registers itself as the
// current test part result reporter. Besides checking if fatal failures were
// reported, it only delegates the reporting to the former result reporter.
// The original result reporter is restored in the destructor.
// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
class GTEST_API_ HasNewFatalFailureHelper
    : public TestPartResultReporterInterface {
 public:
  HasNewFatalFailureHelper();
  virtual ~HasNewFatalFailureHelper();
  virtual void ReportTestPartResult(const TestPartResult& result);
  bool has_new_fatal_failure() const { return has_new_fatal_failure_; }
 private:
  bool has_new_fatal_failure_;
  TestPartResultReporterInterface* original_reporter_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(HasNewFatalFailureHelper);
};

}  // namespace internal

}  // namespace testing

#endif  // GTEST_INCLUDE_GTEST_GTEST_TEST_PART_H_
node-v4.8.2/deps/gtest/include/gtest/gtest-typed-test.h000644 000766 000024 00000024002 13070706730 023202 0ustar00iojsstaff000000 000000 // Copyright 2008 Google Inc.
// All Rights Reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Author: wan@google.com (Zhanyong Wan)

#ifndef GTEST_INCLUDE_GTEST_GTEST_TYPED_TEST_H_
#define GTEST_INCLUDE_GTEST_GTEST_TYPED_TEST_H_

// This header implements typed tests and type-parameterized tests.

// Typed (aka type-driven) tests repeat the same test for types in a
// list.  You must know which types you want to test with when writing
// typed tests. Here's how you do it:

#if 0

// First, define a fixture class template.  It should be parameterized
// by a type.  Remember to derive it from testing::Test.
template 
class FooTest : public testing::Test {
 public:
  ...
  typedef std::list List;
  static T shared_;
  T value_;
};

// Next, associate a list of types with the test case, which will be
// repeated for each type in the list.  The typedef is necessary for
// the macro to parse correctly.
typedef testing::Types MyTypes;
TYPED_TEST_CASE(FooTest, MyTypes);

// If the type list contains only one type, you can write that type
// directly without Types<...>:
//   TYPED_TEST_CASE(FooTest, int);

// Then, use TYPED_TEST() instead of TEST_F() to define as many typed
// tests for this test case as you want.
TYPED_TEST(FooTest, DoesBlah) {
  // Inside a test, refer to TypeParam to get the type parameter.
  // Since we are inside a derived class template, C++ requires use to
  // visit the members of FooTest via 'this'.
  TypeParam n = this->value_;

  // To visit static members of the fixture, add the TestFixture::
  // prefix.
  n += TestFixture::shared_;

  // To refer to typedefs in the fixture, add the "typename
  // TestFixture::" prefix.
  typename TestFixture::List values;
  values.push_back(n);
  ...
}

TYPED_TEST(FooTest, HasPropertyA) { ... }

#endif  // 0

// Type-parameterized tests are abstract test patterns parameterized
// by a type.  Compared with typed tests, type-parameterized tests
// allow you to define the test pattern without knowing what the type
// parameters are.  The defined pattern can be instantiated with
// different types any number of times, in any number of translation
// units.
//
// If you are designing an interface or concept, you can define a
// suite of type-parameterized tests to verify properties that any
// valid implementation of the interface/concept should have.  Then,
// each implementation can easily instantiate the test suite to verify
// that it conforms to the requirements, without having to write
// similar tests repeatedly.  Here's an example:

#if 0

// First, define a fixture class template.  It should be parameterized
// by a type.  Remember to derive it from testing::Test.
template 
class FooTest : public testing::Test {
  ...
};

// Next, declare that you will define a type-parameterized test case
// (the _P suffix is for "parameterized" or "pattern", whichever you
// prefer):
TYPED_TEST_CASE_P(FooTest);

// Then, use TYPED_TEST_P() to define as many type-parameterized tests
// for this type-parameterized test case as you want.
TYPED_TEST_P(FooTest, DoesBlah) {
  // Inside a test, refer to TypeParam to get the type parameter.
  TypeParam n = 0;
  ...
}

TYPED_TEST_P(FooTest, HasPropertyA) { ... }

// Now the tricky part: you need to register all test patterns before
// you can instantiate them.  The first argument of the macro is the
// test case name; the rest are the names of the tests in this test
// case.
REGISTER_TYPED_TEST_CASE_P(FooTest,
                           DoesBlah, HasPropertyA);

// Finally, you are free to instantiate the pattern with the types you
// want.  If you put the above code in a header file, you can #include
// it in multiple C++ source files and instantiate it multiple times.
//
// To distinguish different instances of the pattern, the first
// argument to the INSTANTIATE_* macro is a prefix that will be added
// to the actual test case name.  Remember to pick unique prefixes for
// different instances.
typedef testing::Types MyTypes;
INSTANTIATE_TYPED_TEST_CASE_P(My, FooTest, MyTypes);

// If the type list contains only one type, you can write that type
// directly without Types<...>:
//   INSTANTIATE_TYPED_TEST_CASE_P(My, FooTest, int);

#endif  // 0

#include "gtest/internal/gtest-port.h"
#include "gtest/internal/gtest-type-util.h"

// Implements typed tests.

#if GTEST_HAS_TYPED_TEST

// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE.
//
// Expands to the name of the typedef for the type parameters of the
// given test case.
# define GTEST_TYPE_PARAMS_(TestCaseName) gtest_type_params_##TestCaseName##_

// The 'Types' template argument below must have spaces around it
// since some compilers may choke on '>>' when passing a template
// instance (e.g. Types)
# define TYPED_TEST_CASE(CaseName, Types) \
  typedef ::testing::internal::TypeList< Types >::type \
      GTEST_TYPE_PARAMS_(CaseName)

# define TYPED_TEST(CaseName, TestName) \
  template  \
  class GTEST_TEST_CLASS_NAME_(CaseName, TestName) \
      : public CaseName { \
   private: \
    typedef CaseName TestFixture; \
    typedef gtest_TypeParam_ TypeParam; \
    virtual void TestBody(); \
  }; \
  bool gtest_##CaseName##_##TestName##_registered_ GTEST_ATTRIBUTE_UNUSED_ = \
      ::testing::internal::TypeParameterizedTest< \
          CaseName, \
          ::testing::internal::TemplateSel< \
              GTEST_TEST_CLASS_NAME_(CaseName, TestName)>, \
          GTEST_TYPE_PARAMS_(CaseName)>::Register(\
              "", #CaseName, #TestName, 0); \
  template  \
  void GTEST_TEST_CLASS_NAME_(CaseName, TestName)::TestBody()

#endif  // GTEST_HAS_TYPED_TEST

// Implements type-parameterized tests.

#if GTEST_HAS_TYPED_TEST_P

// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE.
//
// Expands to the namespace name that the type-parameterized tests for
// the given type-parameterized test case are defined in.  The exact
// name of the namespace is subject to change without notice.
# define GTEST_CASE_NAMESPACE_(TestCaseName) \
  gtest_case_##TestCaseName##_

// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE.
//
// Expands to the name of the variable used to remember the names of
// the defined tests in the given test case.
# define GTEST_TYPED_TEST_CASE_P_STATE_(TestCaseName) \
  gtest_typed_test_case_p_state_##TestCaseName##_

// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE DIRECTLY.
//
// Expands to the name of the variable used to remember the names of
// the registered tests in the given test case.
# define GTEST_REGISTERED_TEST_NAMES_(TestCaseName) \
  gtest_registered_test_names_##TestCaseName##_

// The variables defined in the type-parameterized test macros are
// static as typically these macros are used in a .h file that can be
// #included in multiple translation units linked together.
# define TYPED_TEST_CASE_P(CaseName) \
  static ::testing::internal::TypedTestCasePState \
      GTEST_TYPED_TEST_CASE_P_STATE_(CaseName)

# define TYPED_TEST_P(CaseName, TestName) \
  namespace GTEST_CASE_NAMESPACE_(CaseName) { \
  template  \
  class TestName : public CaseName { \
   private: \
    typedef CaseName TestFixture; \
    typedef gtest_TypeParam_ TypeParam; \
    virtual void TestBody(); \
  }; \
  static bool gtest_##TestName##_defined_ GTEST_ATTRIBUTE_UNUSED_ = \
      GTEST_TYPED_TEST_CASE_P_STATE_(CaseName).AddTestName(\
          __FILE__, __LINE__, #CaseName, #TestName); \
  } \
  template  \
  void GTEST_CASE_NAMESPACE_(CaseName)::TestName::TestBody()

# define REGISTER_TYPED_TEST_CASE_P(CaseName, ...) \
  namespace GTEST_CASE_NAMESPACE_(CaseName) { \
  typedef ::testing::internal::Templates<__VA_ARGS__>::type gtest_AllTests_; \
  } \
  static const char* const GTEST_REGISTERED_TEST_NAMES_(CaseName) = \
      GTEST_TYPED_TEST_CASE_P_STATE_(CaseName).VerifyRegisteredTestNames(\
          __FILE__, __LINE__, #__VA_ARGS__)

// The 'Types' template argument below must have spaces around it
// since some compilers may choke on '>>' when passing a template
// instance (e.g. Types)
# define INSTANTIATE_TYPED_TEST_CASE_P(Prefix, CaseName, Types) \
  bool gtest_##Prefix##_##CaseName GTEST_ATTRIBUTE_UNUSED_ = \
      ::testing::internal::TypeParameterizedTestCase::type>::Register(\
              #Prefix, #CaseName, GTEST_REGISTERED_TEST_NAMES_(CaseName))

#endif  // GTEST_HAS_TYPED_TEST_P

#endif  // GTEST_INCLUDE_GTEST_GTEST_TYPED_TEST_H_
node-v4.8.2/deps/gtest/include/gtest/gtest.h000644 000766 000024 00000257663 13070706730 021127 0ustar00iojsstaff000000 000000 // Copyright 2005, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Author: wan@google.com (Zhanyong Wan)
//
// The Google C++ Testing Framework (Google Test)
//
// This header file defines the public API for Google Test.  It should be
// included by any test program that uses Google Test.
//
// IMPORTANT NOTE: Due to limitation of the C++ language, we have to
// leave some internal implementation details in this header file.
// They are clearly marked by comments like this:
//
//   // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
//
// Such code is NOT meant to be used by a user directly, and is subject
// to CHANGE WITHOUT NOTICE.  Therefore DO NOT DEPEND ON IT in a user
// program!
//
// Acknowledgment: Google Test borrowed the idea of automatic test
// registration from Barthelemy Dagenais' (barthelemy@prologique.com)
// easyUnit framework.

#ifndef GTEST_INCLUDE_GTEST_GTEST_H_
#define GTEST_INCLUDE_GTEST_GTEST_H_

#include 
#include 
#include 

#include "gtest/internal/gtest-internal.h"
#include "gtest/internal/gtest-string.h"
#include "gtest/gtest-death-test.h"
#include "gtest/gtest-message.h"
#include "gtest/gtest-param-test.h"
#include "gtest/gtest-printers.h"
#include "gtest/gtest_prod.h"
#include "gtest/gtest-test-part.h"
#include "gtest/gtest-typed-test.h"

// Depending on the platform, different string classes are available.
// On Linux, in addition to ::std::string, Google also makes use of
// class ::string, which has the same interface as ::std::string, but
// has a different implementation.
//
// You can define GTEST_HAS_GLOBAL_STRING to 1 to indicate that
// ::string is available AND is a distinct type to ::std::string, or
// define it to 0 to indicate otherwise.
//
// If ::std::string and ::string are the same class on your platform
// due to aliasing, you should define GTEST_HAS_GLOBAL_STRING to 0.
//
// If you do not define GTEST_HAS_GLOBAL_STRING, it is defined
// heuristically.

namespace testing {

// Declares the flags.

// This flag temporary enables the disabled tests.
GTEST_DECLARE_bool_(also_run_disabled_tests);

// This flag brings the debugger on an assertion failure.
GTEST_DECLARE_bool_(break_on_failure);

// This flag controls whether Google Test catches all test-thrown exceptions
// and logs them as failures.
GTEST_DECLARE_bool_(catch_exceptions);

// This flag enables using colors in terminal output. Available values are
// "yes" to enable colors, "no" (disable colors), or "auto" (the default)
// to let Google Test decide.
GTEST_DECLARE_string_(color);

// This flag sets up the filter to select by name using a glob pattern
// the tests to run. If the filter is not given all tests are executed.
GTEST_DECLARE_string_(filter);

// This flag causes the Google Test to list tests. None of the tests listed
// are actually run if the flag is provided.
GTEST_DECLARE_bool_(list_tests);

// This flag controls whether Google Test emits a detailed XML report to a file
// in addition to its normal textual output.
GTEST_DECLARE_string_(output);

// This flags control whether Google Test prints the elapsed time for each
// test.
GTEST_DECLARE_bool_(print_time);

// This flag specifies the random number seed.
GTEST_DECLARE_int32_(random_seed);

// This flag sets how many times the tests are repeated. The default value
// is 1. If the value is -1 the tests are repeating forever.
GTEST_DECLARE_int32_(repeat);

// This flag controls whether Google Test includes Google Test internal
// stack frames in failure stack traces.
GTEST_DECLARE_bool_(show_internal_stack_frames);

// When this flag is specified, tests' order is randomized on every iteration.
GTEST_DECLARE_bool_(shuffle);

// This flag specifies the maximum number of stack frames to be
// printed in a failure message.
GTEST_DECLARE_int32_(stack_trace_depth);

// When this flag is specified, a failed assertion will throw an
// exception if exceptions are enabled, or exit the program with a
// non-zero code otherwise.
GTEST_DECLARE_bool_(throw_on_failure);

// When this flag is set with a "host:port" string, on supported
// platforms test results are streamed to the specified port on
// the specified host machine.
GTEST_DECLARE_string_(stream_result_to);

// The upper limit for valid stack trace depths.
const int kMaxStackTraceDepth = 100;

namespace internal {

class AssertHelper;
class DefaultGlobalTestPartResultReporter;
class ExecDeathTest;
class NoExecDeathTest;
class FinalSuccessChecker;
class GTestFlagSaver;
class StreamingListenerTest;
class TestResultAccessor;
class TestEventListenersAccessor;
class TestEventRepeater;
class UnitTestRecordPropertyTestHelper;
class WindowsDeathTest;
class UnitTestImpl* GetUnitTestImpl();
void ReportFailureInUnknownLocation(TestPartResult::Type result_type,
                                    const std::string& message);

}  // namespace internal

// The friend relationship of some of these classes is cyclic.
// If we don't forward declare them the compiler might confuse the classes
// in friendship clauses with same named classes on the scope.
class Test;
class TestCase;
class TestInfo;
class UnitTest;

// A class for indicating whether an assertion was successful.  When
// the assertion wasn't successful, the AssertionResult object
// remembers a non-empty message that describes how it failed.
//
// To create an instance of this class, use one of the factory functions
// (AssertionSuccess() and AssertionFailure()).
//
// This class is useful for two purposes:
//   1. Defining predicate functions to be used with Boolean test assertions
//      EXPECT_TRUE/EXPECT_FALSE and their ASSERT_ counterparts
//   2. Defining predicate-format functions to be
//      used with predicate assertions (ASSERT_PRED_FORMAT*, etc).
//
// For example, if you define IsEven predicate:
//
//   testing::AssertionResult IsEven(int n) {
//     if ((n % 2) == 0)
//       return testing::AssertionSuccess();
//     else
//       return testing::AssertionFailure() << n << " is odd";
//   }
//
// Then the failed expectation EXPECT_TRUE(IsEven(Fib(5)))
// will print the message
//
//   Value of: IsEven(Fib(5))
//     Actual: false (5 is odd)
//   Expected: true
//
// instead of a more opaque
//
//   Value of: IsEven(Fib(5))
//     Actual: false
//   Expected: true
//
// in case IsEven is a simple Boolean predicate.
//
// If you expect your predicate to be reused and want to support informative
// messages in EXPECT_FALSE and ASSERT_FALSE (negative assertions show up
// about half as often as positive ones in our tests), supply messages for
// both success and failure cases:
//
//   testing::AssertionResult IsEven(int n) {
//     if ((n % 2) == 0)
//       return testing::AssertionSuccess() << n << " is even";
//     else
//       return testing::AssertionFailure() << n << " is odd";
//   }
//
// Then a statement EXPECT_FALSE(IsEven(Fib(6))) will print
//
//   Value of: IsEven(Fib(6))
//     Actual: true (8 is even)
//   Expected: false
//
// NB: Predicates that support negative Boolean assertions have reduced
// performance in positive ones so be careful not to use them in tests
// that have lots (tens of thousands) of positive Boolean assertions.
//
// To use this class with EXPECT_PRED_FORMAT assertions such as:
//
//   // Verifies that Foo() returns an even number.
//   EXPECT_PRED_FORMAT1(IsEven, Foo());
//
// you need to define:
//
//   testing::AssertionResult IsEven(const char* expr, int n) {
//     if ((n % 2) == 0)
//       return testing::AssertionSuccess();
//     else
//       return testing::AssertionFailure()
//         << "Expected: " << expr << " is even\n  Actual: it's " << n;
//   }
//
// If Foo() returns 5, you will see the following message:
//
//   Expected: Foo() is even
//     Actual: it's 5
//
class GTEST_API_ AssertionResult {
 public:
  // Copy constructor.
  // Used in EXPECT_TRUE/FALSE(assertion_result).
  AssertionResult(const AssertionResult& other);

  GTEST_DISABLE_MSC_WARNINGS_PUSH_(4800 /* forcing value to bool */)

  // Used in the EXPECT_TRUE/FALSE(bool_expression).
  //
  // T must be contextually convertible to bool.
  //
  // The second parameter prevents this overload from being considered if
  // the argument is implicitly convertible to AssertionResult. In that case
  // we want AssertionResult's copy constructor to be used.
  template 
  explicit AssertionResult(
      const T& success,
      typename internal::EnableIf<
          !internal::ImplicitlyConvertible::value>::type*
          /*enabler*/ = NULL)
      : success_(success) {}

  GTEST_DISABLE_MSC_WARNINGS_POP_()

  // Assignment operator.
  AssertionResult& operator=(AssertionResult other) {
    swap(other);
    return *this;
  }

  // Returns true iff the assertion succeeded.
  operator bool() const { return success_; }  // NOLINT

  // Returns the assertion's negation. Used with EXPECT/ASSERT_FALSE.
  AssertionResult operator!() const;

  // Returns the text streamed into this AssertionResult. Test assertions
  // use it when they fail (i.e., the predicate's outcome doesn't match the
  // assertion's expectation). When nothing has been streamed into the
  // object, returns an empty string.
  const char* message() const {
    return message_.get() != NULL ?  message_->c_str() : "";
  }
  // TODO(vladl@google.com): Remove this after making sure no clients use it.
  // Deprecated; please use message() instead.
  const char* failure_message() const { return message(); }

  // Streams a custom failure message into this object.
  template  AssertionResult& operator<<(const T& value) {
    AppendMessage(Message() << value);
    return *this;
  }

  // Allows streaming basic output manipulators such as endl or flush into
  // this object.
  AssertionResult& operator<<(
      ::std::ostream& (*basic_manipulator)(::std::ostream& stream)) {
    AppendMessage(Message() << basic_manipulator);
    return *this;
  }

 private:
  // Appends the contents of message to message_.
  void AppendMessage(const Message& a_message) {
    if (message_.get() == NULL)
      message_.reset(new ::std::string);
    message_->append(a_message.GetString().c_str());
  }

  // Swap the contents of this AssertionResult with other.
  void swap(AssertionResult& other);

  // Stores result of the assertion predicate.
  bool success_;
  // Stores the message describing the condition in case the expectation
  // construct is not satisfied with the predicate's outcome.
  // Referenced via a pointer to avoid taking too much stack frame space
  // with test assertions.
  internal::scoped_ptr< ::std::string> message_;
};

// Makes a successful assertion result.
GTEST_API_ AssertionResult AssertionSuccess();

// Makes a failed assertion result.
GTEST_API_ AssertionResult AssertionFailure();

// Makes a failed assertion result with the given failure message.
// Deprecated; use AssertionFailure() << msg.
GTEST_API_ AssertionResult AssertionFailure(const Message& msg);

// The abstract class that all tests inherit from.
//
// In Google Test, a unit test program contains one or many TestCases, and
// each TestCase contains one or many Tests.
//
// When you define a test using the TEST macro, you don't need to
// explicitly derive from Test - the TEST macro automatically does
// this for you.
//
// The only time you derive from Test is when defining a test fixture
// to be used a TEST_F.  For example:
//
//   class FooTest : public testing::Test {
//    protected:
//     void SetUp() override { ... }
//     void TearDown() override { ... }
//     ...
//   };
//
//   TEST_F(FooTest, Bar) { ... }
//   TEST_F(FooTest, Baz) { ... }
//
// Test is not copyable.
class GTEST_API_ Test {
 public:
  friend class TestInfo;

  // Defines types for pointers to functions that set up and tear down
  // a test case.
  typedef internal::SetUpTestCaseFunc SetUpTestCaseFunc;
  typedef internal::TearDownTestCaseFunc TearDownTestCaseFunc;

  // The d'tor is virtual as we intend to inherit from Test.
  virtual ~Test();

  // Sets up the stuff shared by all tests in this test case.
  //
  // Google Test will call Foo::SetUpTestCase() before running the first
  // test in test case Foo.  Hence a sub-class can define its own
  // SetUpTestCase() method to shadow the one defined in the super
  // class.
  static void SetUpTestCase() {}

  // Tears down the stuff shared by all tests in this test case.
  //
  // Google Test will call Foo::TearDownTestCase() after running the last
  // test in test case Foo.  Hence a sub-class can define its own
  // TearDownTestCase() method to shadow the one defined in the super
  // class.
  static void TearDownTestCase() {}

  // Returns true iff the current test has a fatal failure.
  static bool HasFatalFailure();

  // Returns true iff the current test has a non-fatal failure.
  static bool HasNonfatalFailure();

  // Returns true iff the current test has a (either fatal or
  // non-fatal) failure.
  static bool HasFailure() { return HasFatalFailure() || HasNonfatalFailure(); }

  // Logs a property for the current test, test case, or for the entire
  // invocation of the test program when used outside of the context of a
  // test case.  Only the last value for a given key is remembered.  These
  // are public static so they can be called from utility functions that are
  // not members of the test fixture.  Calls to RecordProperty made during
  // lifespan of the test (from the moment its constructor starts to the
  // moment its destructor finishes) will be output in XML as attributes of
  // the  element.  Properties recorded from fixture's
  // SetUpTestCase or TearDownTestCase are logged as attributes of the
  // corresponding  element.  Calls to RecordProperty made in the
  // global context (before or after invocation of RUN_ALL_TESTS and from
  // SetUp/TearDown method of Environment objects registered with Google
  // Test) will be output as attributes of the  element.
  static void RecordProperty(const std::string& key, const std::string& value);
  static void RecordProperty(const std::string& key, int value);

 protected:
  // Creates a Test object.
  Test();

  // Sets up the test fixture.
  virtual void SetUp();

  // Tears down the test fixture.
  virtual void TearDown();

 private:
  // Returns true iff the current test has the same fixture class as
  // the first test in the current test case.
  static bool HasSameFixtureClass();

  // Runs the test after the test fixture has been set up.
  //
  // A sub-class must implement this to define the test logic.
  //
  // DO NOT OVERRIDE THIS FUNCTION DIRECTLY IN A USER PROGRAM.
  // Instead, use the TEST or TEST_F macro.
  virtual void TestBody() = 0;

  // Sets up, executes, and tears down the test.
  void Run();

  // Deletes self.  We deliberately pick an unusual name for this
  // internal method to avoid clashing with names used in user TESTs.
  void DeleteSelf_() { delete this; }

  // Uses a GTestFlagSaver to save and restore all Google Test flags.
  const internal::GTestFlagSaver* const gtest_flag_saver_;

  // Often a user misspells SetUp() as Setup() and spends a long time
  // wondering why it is never called by Google Test.  The declaration of
  // the following method is solely for catching such an error at
  // compile time:
  //
  //   - The return type is deliberately chosen to be not void, so it
  //   will be a conflict if void Setup() is declared in the user's
  //   test fixture.
  //
  //   - This method is private, so it will be another compiler error
  //   if the method is called from the user's test fixture.
  //
  // DO NOT OVERRIDE THIS FUNCTION.
  //
  // If you see an error about overriding the following function or
  // about it being private, you have mis-spelled SetUp() as Setup().
  struct Setup_should_be_spelled_SetUp {};
  virtual Setup_should_be_spelled_SetUp* Setup() { return NULL; }

  // We disallow copying Tests.
  GTEST_DISALLOW_COPY_AND_ASSIGN_(Test);
};

typedef internal::TimeInMillis TimeInMillis;

// A copyable object representing a user specified test property which can be
// output as a key/value string pair.
//
// Don't inherit from TestProperty as its destructor is not virtual.
class TestProperty {
 public:
  // C'tor.  TestProperty does NOT have a default constructor.
  // Always use this constructor (with parameters) to create a
  // TestProperty object.
  TestProperty(const std::string& a_key, const std::string& a_value) :
    key_(a_key), value_(a_value) {
  }

  // Gets the user supplied key.
  const char* key() const {
    return key_.c_str();
  }

  // Gets the user supplied value.
  const char* value() const {
    return value_.c_str();
  }

  // Sets a new value, overriding the one supplied in the constructor.
  void SetValue(const std::string& new_value) {
    value_ = new_value;
  }

 private:
  // The key supplied by the user.
  std::string key_;
  // The value supplied by the user.
  std::string value_;
};

// The result of a single Test.  This includes a list of
// TestPartResults, a list of TestProperties, a count of how many
// death tests there are in the Test, and how much time it took to run
// the Test.
//
// TestResult is not copyable.
class GTEST_API_ TestResult {
 public:
  // Creates an empty TestResult.
  TestResult();

  // D'tor.  Do not inherit from TestResult.
  ~TestResult();

  // Gets the number of all test parts.  This is the sum of the number
  // of successful test parts and the number of failed test parts.
  int total_part_count() const;

  // Returns the number of the test properties.
  int test_property_count() const;

  // Returns true iff the test passed (i.e. no test part failed).
  bool Passed() const { return !Failed(); }

  // Returns true iff the test failed.
  bool Failed() const;

  // Returns true iff the test fatally failed.
  bool HasFatalFailure() const;

  // Returns true iff the test has a non-fatal failure.
  bool HasNonfatalFailure() const;

  // Returns the elapsed time, in milliseconds.
  TimeInMillis elapsed_time() const { return elapsed_time_; }

  // Returns the i-th test part result among all the results. i can range
  // from 0 to test_property_count() - 1. If i is not in that range, aborts
  // the program.
  const TestPartResult& GetTestPartResult(int i) const;

  // Returns the i-th test property. i can range from 0 to
  // test_property_count() - 1. If i is not in that range, aborts the
  // program.
  const TestProperty& GetTestProperty(int i) const;

 private:
  friend class TestInfo;
  friend class TestCase;
  friend class UnitTest;
  friend class internal::DefaultGlobalTestPartResultReporter;
  friend class internal::ExecDeathTest;
  friend class internal::TestResultAccessor;
  friend class internal::UnitTestImpl;
  friend class internal::WindowsDeathTest;

  // Gets the vector of TestPartResults.
  const std::vector& test_part_results() const {
    return test_part_results_;
  }

  // Gets the vector of TestProperties.
  const std::vector& test_properties() const {
    return test_properties_;
  }

  // Sets the elapsed time.
  void set_elapsed_time(TimeInMillis elapsed) { elapsed_time_ = elapsed; }

  // Adds a test property to the list. The property is validated and may add
  // a non-fatal failure if invalid (e.g., if it conflicts with reserved
  // key names). If a property is already recorded for the same key, the
  // value will be updated, rather than storing multiple values for the same
  // key.  xml_element specifies the element for which the property is being
  // recorded and is used for validation.
  void RecordProperty(const std::string& xml_element,
                      const TestProperty& test_property);

  // Adds a failure if the key is a reserved attribute of Google Test
  // testcase tags.  Returns true if the property is valid.
  // TODO(russr): Validate attribute names are legal and human readable.
  static bool ValidateTestProperty(const std::string& xml_element,
                                   const TestProperty& test_property);

  // Adds a test part result to the list.
  void AddTestPartResult(const TestPartResult& test_part_result);

  // Returns the death test count.
  int death_test_count() const { return death_test_count_; }

  // Increments the death test count, returning the new count.
  int increment_death_test_count() { return ++death_test_count_; }

  // Clears the test part results.
  void ClearTestPartResults();

  // Clears the object.
  void Clear();

  // Protects mutable state of the property vector and of owned
  // properties, whose values may be updated.
  internal::Mutex test_properites_mutex_;

  // The vector of TestPartResults
  std::vector test_part_results_;
  // The vector of TestProperties
  std::vector test_properties_;
  // Running count of death tests.
  int death_test_count_;
  // The elapsed time, in milliseconds.
  TimeInMillis elapsed_time_;

  // We disallow copying TestResult.
  GTEST_DISALLOW_COPY_AND_ASSIGN_(TestResult);
};  // class TestResult

// A TestInfo object stores the following information about a test:
//
//   Test case name
//   Test name
//   Whether the test should be run
//   A function pointer that creates the test object when invoked
//   Test result
//
// The constructor of TestInfo registers itself with the UnitTest
// singleton such that the RUN_ALL_TESTS() macro knows which tests to
// run.
class GTEST_API_ TestInfo {
 public:
  // Destructs a TestInfo object.  This function is not virtual, so
  // don't inherit from TestInfo.
  ~TestInfo();

  // Returns the test case name.
  const char* test_case_name() const { return test_case_name_.c_str(); }

  // Returns the test name.
  const char* name() const { return name_.c_str(); }

  // Returns the name of the parameter type, or NULL if this is not a typed
  // or a type-parameterized test.
  const char* type_param() const {
    if (type_param_.get() != NULL)
      return type_param_->c_str();
    return NULL;
  }

  // Returns the text representation of the value parameter, or NULL if this
  // is not a value-parameterized test.
  const char* value_param() const {
    if (value_param_.get() != NULL)
      return value_param_->c_str();
    return NULL;
  }

  // Returns true if this test should run, that is if the test is not
  // disabled (or it is disabled but the also_run_disabled_tests flag has
  // been specified) and its full name matches the user-specified filter.
  //
  // Google Test allows the user to filter the tests by their full names.
  // The full name of a test Bar in test case Foo is defined as
  // "Foo.Bar".  Only the tests that match the filter will run.
  //
  // A filter is a colon-separated list of glob (not regex) patterns,
  // optionally followed by a '-' and a colon-separated list of
  // negative patterns (tests to exclude).  A test is run if it
  // matches one of the positive patterns and does not match any of
  // the negative patterns.
  //
  // For example, *A*:Foo.* is a filter that matches any string that
  // contains the character 'A' or starts with "Foo.".
  bool should_run() const { return should_run_; }

  // Returns true iff this test will appear in the XML report.
  bool is_reportable() const {
    // For now, the XML report includes all tests matching the filter.
    // In the future, we may trim tests that are excluded because of
    // sharding.
    return matches_filter_;
  }

  // Returns the result of the test.
  const TestResult* result() const { return &result_; }

 private:
#if GTEST_HAS_DEATH_TEST
  friend class internal::DefaultDeathTestFactory;
#endif  // GTEST_HAS_DEATH_TEST
  friend class Test;
  friend class TestCase;
  friend class internal::UnitTestImpl;
  friend class internal::StreamingListenerTest;
  friend TestInfo* internal::MakeAndRegisterTestInfo(
      const char* test_case_name,
      const char* name,
      const char* type_param,
      const char* value_param,
      internal::TypeId fixture_class_id,
      Test::SetUpTestCaseFunc set_up_tc,
      Test::TearDownTestCaseFunc tear_down_tc,
      internal::TestFactoryBase* factory);

  // Constructs a TestInfo object. The newly constructed instance assumes
  // ownership of the factory object.
  TestInfo(const std::string& test_case_name,
           const std::string& name,
           const char* a_type_param,   // NULL if not a type-parameterized test
           const char* a_value_param,  // NULL if not a value-parameterized test
           internal::TypeId fixture_class_id,
           internal::TestFactoryBase* factory);

  // Increments the number of death tests encountered in this test so
  // far.
  int increment_death_test_count() {
    return result_.increment_death_test_count();
  }

  // Creates the test object, runs it, records its result, and then
  // deletes it.
  void Run();

  static void ClearTestResult(TestInfo* test_info) {
    test_info->result_.Clear();
  }

  // These fields are immutable properties of the test.
  const std::string test_case_name_;     // Test case name
  const std::string name_;               // Test name
  // Name of the parameter type, or NULL if this is not a typed or a
  // type-parameterized test.
  const internal::scoped_ptr type_param_;
  // Text representation of the value parameter, or NULL if this is not a
  // value-parameterized test.
  const internal::scoped_ptr value_param_;
  const internal::TypeId fixture_class_id_;   // ID of the test fixture class
  bool should_run_;                 // True iff this test should run
  bool is_disabled_;                // True iff this test is disabled
  bool matches_filter_;             // True if this test matches the
                                    // user-specified filter.
  internal::TestFactoryBase* const factory_;  // The factory that creates
                                              // the test object

  // This field is mutable and needs to be reset before running the
  // test for the second time.
  TestResult result_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(TestInfo);
};

// A test case, which consists of a vector of TestInfos.
//
// TestCase is not copyable.
class GTEST_API_ TestCase {
 public:
  // Creates a TestCase with the given name.
  //
  // TestCase does NOT have a default constructor.  Always use this
  // constructor to create a TestCase object.
  //
  // Arguments:
  //
  //   name:         name of the test case
  //   a_type_param: the name of the test's type parameter, or NULL if
  //                 this is not a type-parameterized test.
  //   set_up_tc:    pointer to the function that sets up the test case
  //   tear_down_tc: pointer to the function that tears down the test case
  TestCase(const char* name, const char* a_type_param,
           Test::SetUpTestCaseFunc set_up_tc,
           Test::TearDownTestCaseFunc tear_down_tc);

  // Destructor of TestCase.
  virtual ~TestCase();

  // Gets the name of the TestCase.
  const char* name() const { return name_.c_str(); }

  // Returns the name of the parameter type, or NULL if this is not a
  // type-parameterized test case.
  const char* type_param() const {
    if (type_param_.get() != NULL)
      return type_param_->c_str();
    return NULL;
  }

  // Returns true if any test in this test case should run.
  bool should_run() const { return should_run_; }

  // Gets the number of successful tests in this test case.
  int successful_test_count() const;

  // Gets the number of failed tests in this test case.
  int failed_test_count() const;

  // Gets the number of disabled tests that will be reported in the XML report.
  int reportable_disabled_test_count() const;

  // Gets the number of disabled tests in this test case.
  int disabled_test_count() const;

  // Gets the number of tests to be printed in the XML report.
  int reportable_test_count() const;

  // Get the number of tests in this test case that should run.
  int test_to_run_count() const;

  // Gets the number of all tests in this test case.
  int total_test_count() const;

  // Returns true iff the test case passed.
  bool Passed() const { return !Failed(); }

  // Returns true iff the test case failed.
  bool Failed() const { return failed_test_count() > 0; }

  // Returns the elapsed time, in milliseconds.
  TimeInMillis elapsed_time() const { return elapsed_time_; }

  // Returns the i-th test among all the tests. i can range from 0 to
  // total_test_count() - 1. If i is not in that range, returns NULL.
  const TestInfo* GetTestInfo(int i) const;

  // Returns the TestResult that holds test properties recorded during
  // execution of SetUpTestCase and TearDownTestCase.
  const TestResult& ad_hoc_test_result() const { return ad_hoc_test_result_; }

 private:
  friend class Test;
  friend class internal::UnitTestImpl;

  // Gets the (mutable) vector of TestInfos in this TestCase.
  std::vector& test_info_list() { return test_info_list_; }

  // Gets the (immutable) vector of TestInfos in this TestCase.
  const std::vector& test_info_list() const {
    return test_info_list_;
  }

  // Returns the i-th test among all the tests. i can range from 0 to
  // total_test_count() - 1. If i is not in that range, returns NULL.
  TestInfo* GetMutableTestInfo(int i);

  // Sets the should_run member.
  void set_should_run(bool should) { should_run_ = should; }

  // Adds a TestInfo to this test case.  Will delete the TestInfo upon
  // destruction of the TestCase object.
  void AddTestInfo(TestInfo * test_info);

  // Clears the results of all tests in this test case.
  void ClearResult();

  // Clears the results of all tests in the given test case.
  static void ClearTestCaseResult(TestCase* test_case) {
    test_case->ClearResult();
  }

  // Runs every test in this TestCase.
  void Run();

  // Runs SetUpTestCase() for this TestCase.  This wrapper is needed
  // for catching exceptions thrown from SetUpTestCase().
  void RunSetUpTestCase() { (*set_up_tc_)(); }

  // Runs TearDownTestCase() for this TestCase.  This wrapper is
  // needed for catching exceptions thrown from TearDownTestCase().
  void RunTearDownTestCase() { (*tear_down_tc_)(); }

  // Returns true iff test passed.
  static bool TestPassed(const TestInfo* test_info) {
    return test_info->should_run() && test_info->result()->Passed();
  }

  // Returns true iff test failed.
  static bool TestFailed(const TestInfo* test_info) {
    return test_info->should_run() && test_info->result()->Failed();
  }

  // Returns true iff the test is disabled and will be reported in the XML
  // report.
  static bool TestReportableDisabled(const TestInfo* test_info) {
    return test_info->is_reportable() && test_info->is_disabled_;
  }

  // Returns true iff test is disabled.
  static bool TestDisabled(const TestInfo* test_info) {
    return test_info->is_disabled_;
  }

  // Returns true iff this test will appear in the XML report.
  static bool TestReportable(const TestInfo* test_info) {
    return test_info->is_reportable();
  }

  // Returns true if the given test should run.
  static bool ShouldRunTest(const TestInfo* test_info) {
    return test_info->should_run();
  }

  // Shuffles the tests in this test case.
  void ShuffleTests(internal::Random* random);

  // Restores the test order to before the first shuffle.
  void UnshuffleTests();

  // Name of the test case.
  std::string name_;
  // Name of the parameter type, or NULL if this is not a typed or a
  // type-parameterized test.
  const internal::scoped_ptr type_param_;
  // The vector of TestInfos in their original order.  It owns the
  // elements in the vector.
  std::vector test_info_list_;
  // Provides a level of indirection for the test list to allow easy
  // shuffling and restoring the test order.  The i-th element in this
  // vector is the index of the i-th test in the shuffled test list.
  std::vector test_indices_;
  // Pointer to the function that sets up the test case.
  Test::SetUpTestCaseFunc set_up_tc_;
  // Pointer to the function that tears down the test case.
  Test::TearDownTestCaseFunc tear_down_tc_;
  // True iff any test in this test case should run.
  bool should_run_;
  // Elapsed time, in milliseconds.
  TimeInMillis elapsed_time_;
  // Holds test properties recorded during execution of SetUpTestCase and
  // TearDownTestCase.
  TestResult ad_hoc_test_result_;

  // We disallow copying TestCases.
  GTEST_DISALLOW_COPY_AND_ASSIGN_(TestCase);
};

// An Environment object is capable of setting up and tearing down an
// environment.  You should subclass this to define your own
// environment(s).
//
// An Environment object does the set-up and tear-down in virtual
// methods SetUp() and TearDown() instead of the constructor and the
// destructor, as:
//
//   1. You cannot safely throw from a destructor.  This is a problem
//      as in some cases Google Test is used where exceptions are enabled, and
//      we may want to implement ASSERT_* using exceptions where they are
//      available.
//   2. You cannot use ASSERT_* directly in a constructor or
//      destructor.
class Environment {
 public:
  // The d'tor is virtual as we need to subclass Environment.
  virtual ~Environment() {}

  // Override this to define how to set up the environment.
  virtual void SetUp() {}

  // Override this to define how to tear down the environment.
  virtual void TearDown() {}
 private:
  // If you see an error about overriding the following function or
  // about it being private, you have mis-spelled SetUp() as Setup().
  struct Setup_should_be_spelled_SetUp {};
  virtual Setup_should_be_spelled_SetUp* Setup() { return NULL; }
};

// The interface for tracing execution of tests. The methods are organized in
// the order the corresponding events are fired.
class TestEventListener {
 public:
  virtual ~TestEventListener() {}

  // Fired before any test activity starts.
  virtual void OnTestProgramStart(const UnitTest& unit_test) = 0;

  // Fired before each iteration of tests starts.  There may be more than
  // one iteration if GTEST_FLAG(repeat) is set. iteration is the iteration
  // index, starting from 0.
  virtual void OnTestIterationStart(const UnitTest& unit_test,
                                    int iteration) = 0;

  // Fired before environment set-up for each iteration of tests starts.
  virtual void OnEnvironmentsSetUpStart(const UnitTest& unit_test) = 0;

  // Fired after environment set-up for each iteration of tests ends.
  virtual void OnEnvironmentsSetUpEnd(const UnitTest& unit_test) = 0;

  // Fired before the test case starts.
  virtual void OnTestCaseStart(const TestCase& test_case) = 0;

  // Fired before the test starts.
  virtual void OnTestStart(const TestInfo& test_info) = 0;

  // Fired after a failed assertion or a SUCCEED() invocation.
  virtual void OnTestPartResult(const TestPartResult& test_part_result) = 0;

  // Fired after the test ends.
  virtual void OnTestEnd(const TestInfo& test_info) = 0;

  // Fired after the test case ends.
  virtual void OnTestCaseEnd(const TestCase& test_case) = 0;

  // Fired before environment tear-down for each iteration of tests starts.
  virtual void OnEnvironmentsTearDownStart(const UnitTest& unit_test) = 0;

  // Fired after environment tear-down for each iteration of tests ends.
  virtual void OnEnvironmentsTearDownEnd(const UnitTest& unit_test) = 0;

  // Fired after each iteration of tests finishes.
  virtual void OnTestIterationEnd(const UnitTest& unit_test,
                                  int iteration) = 0;

  // Fired after all test activities have ended.
  virtual void OnTestProgramEnd(const UnitTest& unit_test) = 0;
};

// The convenience class for users who need to override just one or two
// methods and are not concerned that a possible change to a signature of
// the methods they override will not be caught during the build.  For
// comments about each method please see the definition of TestEventListener
// above.
class EmptyTestEventListener : public TestEventListener {
 public:
  virtual void OnTestProgramStart(const UnitTest& /*unit_test*/) {}
  virtual void OnTestIterationStart(const UnitTest& /*unit_test*/,
                                    int /*iteration*/) {}
  virtual void OnEnvironmentsSetUpStart(const UnitTest& /*unit_test*/) {}
  virtual void OnEnvironmentsSetUpEnd(const UnitTest& /*unit_test*/) {}
  virtual void OnTestCaseStart(const TestCase& /*test_case*/) {}
  virtual void OnTestStart(const TestInfo& /*test_info*/) {}
  virtual void OnTestPartResult(const TestPartResult& /*test_part_result*/) {}
  virtual void OnTestEnd(const TestInfo& /*test_info*/) {}
  virtual void OnTestCaseEnd(const TestCase& /*test_case*/) {}
  virtual void OnEnvironmentsTearDownStart(const UnitTest& /*unit_test*/) {}
  virtual void OnEnvironmentsTearDownEnd(const UnitTest& /*unit_test*/) {}
  virtual void OnTestIterationEnd(const UnitTest& /*unit_test*/,
                                  int /*iteration*/) {}
  virtual void OnTestProgramEnd(const UnitTest& /*unit_test*/) {}
};

// TestEventListeners lets users add listeners to track events in Google Test.
class GTEST_API_ TestEventListeners {
 public:
  TestEventListeners();
  ~TestEventListeners();

  // Appends an event listener to the end of the list. Google Test assumes
  // the ownership of the listener (i.e. it will delete the listener when
  // the test program finishes).
  void Append(TestEventListener* listener);

  // Removes the given event listener from the list and returns it.  It then
  // becomes the caller's responsibility to delete the listener. Returns
  // NULL if the listener is not found in the list.
  TestEventListener* Release(TestEventListener* listener);

  // Returns the standard listener responsible for the default console
  // output.  Can be removed from the listeners list to shut down default
  // console output.  Note that removing this object from the listener list
  // with Release transfers its ownership to the caller and makes this
  // function return NULL the next time.
  TestEventListener* default_result_printer() const {
    return default_result_printer_;
  }

  // Returns the standard listener responsible for the default XML output
  // controlled by the --gtest_output=xml flag.  Can be removed from the
  // listeners list by users who want to shut down the default XML output
  // controlled by this flag and substitute it with custom one.  Note that
  // removing this object from the listener list with Release transfers its
  // ownership to the caller and makes this function return NULL the next
  // time.
  TestEventListener* default_xml_generator() const {
    return default_xml_generator_;
  }

 private:
  friend class TestCase;
  friend class TestInfo;
  friend class internal::DefaultGlobalTestPartResultReporter;
  friend class internal::NoExecDeathTest;
  friend class internal::TestEventListenersAccessor;
  friend class internal::UnitTestImpl;

  // Returns repeater that broadcasts the TestEventListener events to all
  // subscribers.
  TestEventListener* repeater();

  // Sets the default_result_printer attribute to the provided listener.
  // The listener is also added to the listener list and previous
  // default_result_printer is removed from it and deleted. The listener can
  // also be NULL in which case it will not be added to the list. Does
  // nothing if the previous and the current listener objects are the same.
  void SetDefaultResultPrinter(TestEventListener* listener);

  // Sets the default_xml_generator attribute to the provided listener.  The
  // listener is also added to the listener list and previous
  // default_xml_generator is removed from it and deleted. The listener can
  // also be NULL in which case it will not be added to the list. Does
  // nothing if the previous and the current listener objects are the same.
  void SetDefaultXmlGenerator(TestEventListener* listener);

  // Controls whether events will be forwarded by the repeater to the
  // listeners in the list.
  bool EventForwardingEnabled() const;
  void SuppressEventForwarding();

  // The actual list of listeners.
  internal::TestEventRepeater* repeater_;
  // Listener responsible for the standard result output.
  TestEventListener* default_result_printer_;
  // Listener responsible for the creation of the XML output file.
  TestEventListener* default_xml_generator_;

  // We disallow copying TestEventListeners.
  GTEST_DISALLOW_COPY_AND_ASSIGN_(TestEventListeners);
};

// A UnitTest consists of a vector of TestCases.
//
// This is a singleton class.  The only instance of UnitTest is
// created when UnitTest::GetInstance() is first called.  This
// instance is never deleted.
//
// UnitTest is not copyable.
//
// This class is thread-safe as long as the methods are called
// according to their specification.
class GTEST_API_ UnitTest {
 public:
  // Gets the singleton UnitTest object.  The first time this method
  // is called, a UnitTest object is constructed and returned.
  // Consecutive calls will return the same object.
  static UnitTest* GetInstance();

  // Runs all tests in this UnitTest object and prints the result.
  // Returns 0 if successful, or 1 otherwise.
  //
  // This method can only be called from the main thread.
  //
  // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
  int Run() GTEST_MUST_USE_RESULT_;

  // Returns the working directory when the first TEST() or TEST_F()
  // was executed.  The UnitTest object owns the string.
  const char* original_working_dir() const;

  // Returns the TestCase object for the test that's currently running,
  // or NULL if no test is running.
  const TestCase* current_test_case() const
      GTEST_LOCK_EXCLUDED_(mutex_);

  // Returns the TestInfo object for the test that's currently running,
  // or NULL if no test is running.
  const TestInfo* current_test_info() const
      GTEST_LOCK_EXCLUDED_(mutex_);

  // Returns the random seed used at the start of the current test run.
  int random_seed() const;

#if GTEST_HAS_PARAM_TEST
  // Returns the ParameterizedTestCaseRegistry object used to keep track of
  // value-parameterized tests and instantiate and register them.
  //
  // INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
  internal::ParameterizedTestCaseRegistry& parameterized_test_registry()
      GTEST_LOCK_EXCLUDED_(mutex_);
#endif  // GTEST_HAS_PARAM_TEST

  // Gets the number of successful test cases.
  int successful_test_case_count() const;

  // Gets the number of failed test cases.
  int failed_test_case_count() const;

  // Gets the number of all test cases.
  int total_test_case_count() const;

  // Gets the number of all test cases that contain at least one test
  // that should run.
  int test_case_to_run_count() const;

  // Gets the number of successful tests.
  int successful_test_count() const;

  // Gets the number of failed tests.
  int failed_test_count() const;

  // Gets the number of disabled tests that will be reported in the XML report.
  int reportable_disabled_test_count() const;

  // Gets the number of disabled tests.
  int disabled_test_count() const;

  // Gets the number of tests to be printed in the XML report.
  int reportable_test_count() const;

  // Gets the number of all tests.
  int total_test_count() const;

  // Gets the number of tests that should run.
  int test_to_run_count() const;

  // Gets the time of the test program start, in ms from the start of the
  // UNIX epoch.
  TimeInMillis start_timestamp() const;

  // Gets the elapsed time, in milliseconds.
  TimeInMillis elapsed_time() const;

  // Returns true iff the unit test passed (i.e. all test cases passed).
  bool Passed() const;

  // Returns true iff the unit test failed (i.e. some test case failed
  // or something outside of all tests failed).
  bool Failed() const;

  // Gets the i-th test case among all the test cases. i can range from 0 to
  // total_test_case_count() - 1. If i is not in that range, returns NULL.
  const TestCase* GetTestCase(int i) const;

  // Returns the TestResult containing information on test failures and
  // properties logged outside of individual test cases.
  const TestResult& ad_hoc_test_result() const;

  // Returns the list of event listeners that can be used to track events
  // inside Google Test.
  TestEventListeners& listeners();

 private:
  // Registers and returns a global test environment.  When a test
  // program is run, all global test environments will be set-up in
  // the order they were registered.  After all tests in the program
  // have finished, all global test environments will be torn-down in
  // the *reverse* order they were registered.
  //
  // The UnitTest object takes ownership of the given environment.
  //
  // This method can only be called from the main thread.
  Environment* AddEnvironment(Environment* env);

  // Adds a TestPartResult to the current TestResult object.  All
  // Google Test assertion macros (e.g. ASSERT_TRUE, EXPECT_EQ, etc)
  // eventually call this to report their results.  The user code
  // should use the assertion macros instead of calling this directly.
  void AddTestPartResult(TestPartResult::Type result_type,
                         const char* file_name,
                         int line_number,
                         const std::string& message,
                         const std::string& os_stack_trace)
      GTEST_LOCK_EXCLUDED_(mutex_);

  // Adds a TestProperty to the current TestResult object when invoked from
  // inside a test, to current TestCase's ad_hoc_test_result_ when invoked
  // from SetUpTestCase or TearDownTestCase, or to the global property set
  // when invoked elsewhere.  If the result already contains a property with
  // the same key, the value will be updated.
  void RecordProperty(const std::string& key, const std::string& value);

  // Gets the i-th test case among all the test cases. i can range from 0 to
  // total_test_case_count() - 1. If i is not in that range, returns NULL.
  TestCase* GetMutableTestCase(int i);

  // Accessors for the implementation object.
  internal::UnitTestImpl* impl() { return impl_; }
  const internal::UnitTestImpl* impl() const { return impl_; }

  // These classes and funcions are friends as they need to access private
  // members of UnitTest.
  friend class Test;
  friend class internal::AssertHelper;
  friend class internal::ScopedTrace;
  friend class internal::StreamingListenerTest;
  friend class internal::UnitTestRecordPropertyTestHelper;
  friend Environment* AddGlobalTestEnvironment(Environment* env);
  friend internal::UnitTestImpl* internal::GetUnitTestImpl();
  friend void internal::ReportFailureInUnknownLocation(
      TestPartResult::Type result_type,
      const std::string& message);

  // Creates an empty UnitTest.
  UnitTest();

  // D'tor
  virtual ~UnitTest();

  // Pushes a trace defined by SCOPED_TRACE() on to the per-thread
  // Google Test trace stack.
  void PushGTestTrace(const internal::TraceInfo& trace)
      GTEST_LOCK_EXCLUDED_(mutex_);

  // Pops a trace from the per-thread Google Test trace stack.
  void PopGTestTrace()
      GTEST_LOCK_EXCLUDED_(mutex_);

  // Protects mutable state in *impl_.  This is mutable as some const
  // methods need to lock it too.
  mutable internal::Mutex mutex_;

  // Opaque implementation object.  This field is never changed once
  // the object is constructed.  We don't mark it as const here, as
  // doing so will cause a warning in the constructor of UnitTest.
  // Mutable state in *impl_ is protected by mutex_.
  internal::UnitTestImpl* impl_;

  // We disallow copying UnitTest.
  GTEST_DISALLOW_COPY_AND_ASSIGN_(UnitTest);
};

// A convenient wrapper for adding an environment for the test
// program.
//
// You should call this before RUN_ALL_TESTS() is called, probably in
// main().  If you use gtest_main, you need to call this before main()
// starts for it to take effect.  For example, you can define a global
// variable like this:
//
//   testing::Environment* const foo_env =
//       testing::AddGlobalTestEnvironment(new FooEnvironment);
//
// However, we strongly recommend you to write your own main() and
// call AddGlobalTestEnvironment() there, as relying on initialization
// of global variables makes the code harder to read and may cause
// problems when you register multiple environments from different
// translation units and the environments have dependencies among them
// (remember that the compiler doesn't guarantee the order in which
// global variables from different translation units are initialized).
inline Environment* AddGlobalTestEnvironment(Environment* env) {
  return UnitTest::GetInstance()->AddEnvironment(env);
}

// Initializes Google Test.  This must be called before calling
// RUN_ALL_TESTS().  In particular, it parses a command line for the
// flags that Google Test recognizes.  Whenever a Google Test flag is
// seen, it is removed from argv, and *argc is decremented.
//
// No value is returned.  Instead, the Google Test flag variables are
// updated.
//
// Calling the function for the second time has no user-visible effect.
GTEST_API_ void InitGoogleTest(int* argc, char** argv);

// This overloaded version can be used in Windows programs compiled in
// UNICODE mode.
GTEST_API_ void InitGoogleTest(int* argc, wchar_t** argv);

namespace internal {

// FormatForComparison::Format(value) formats a
// value of type ToPrint that is an operand of a comparison assertion
// (e.g. ASSERT_EQ).  OtherOperand is the type of the other operand in
// the comparison, and is used to help determine the best way to
// format the value.  In particular, when the value is a C string
// (char pointer) and the other operand is an STL string object, we
// want to format the C string as a string, since we know it is
// compared by value with the string object.  If the value is a char
// pointer but the other operand is not an STL string object, we don't
// know whether the pointer is supposed to point to a NUL-terminated
// string, and thus want to print it as a pointer to be safe.
//
// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.

// The default case.
template 
class FormatForComparison {
 public:
  static ::std::string Format(const ToPrint& value) {
    return ::testing::PrintToString(value);
  }
};

// Array.
template 
class FormatForComparison {
 public:
  static ::std::string Format(const ToPrint* value) {
    return FormatForComparison::Format(value);
  }
};

// By default, print C string as pointers to be safe, as we don't know
// whether they actually point to a NUL-terminated string.

#define GTEST_IMPL_FORMAT_C_STRING_AS_POINTER_(CharType)                \
  template                                       \
  class FormatForComparison {                  \
   public:                                                              \
    static ::std::string Format(CharType* value) {                      \
      return ::testing::PrintToString(static_cast(value)); \
    }                                                                   \
  }

GTEST_IMPL_FORMAT_C_STRING_AS_POINTER_(char);
GTEST_IMPL_FORMAT_C_STRING_AS_POINTER_(const char);
GTEST_IMPL_FORMAT_C_STRING_AS_POINTER_(wchar_t);
GTEST_IMPL_FORMAT_C_STRING_AS_POINTER_(const wchar_t);

#undef GTEST_IMPL_FORMAT_C_STRING_AS_POINTER_

// If a C string is compared with an STL string object, we know it's meant
// to point to a NUL-terminated string, and thus can print it as a string.

#define GTEST_IMPL_FORMAT_C_STRING_AS_STRING_(CharType, OtherStringType) \
  template <>                                                           \
  class FormatForComparison {               \
   public:                                                              \
    static ::std::string Format(CharType* value) {                      \
      return ::testing::PrintToString(value);                           \
    }                                                                   \
  }

GTEST_IMPL_FORMAT_C_STRING_AS_STRING_(char, ::std::string);
GTEST_IMPL_FORMAT_C_STRING_AS_STRING_(const char, ::std::string);

#if GTEST_HAS_GLOBAL_STRING
GTEST_IMPL_FORMAT_C_STRING_AS_STRING_(char, ::string);
GTEST_IMPL_FORMAT_C_STRING_AS_STRING_(const char, ::string);
#endif

#if GTEST_HAS_GLOBAL_WSTRING
GTEST_IMPL_FORMAT_C_STRING_AS_STRING_(wchar_t, ::wstring);
GTEST_IMPL_FORMAT_C_STRING_AS_STRING_(const wchar_t, ::wstring);
#endif

#if GTEST_HAS_STD_WSTRING
GTEST_IMPL_FORMAT_C_STRING_AS_STRING_(wchar_t, ::std::wstring);
GTEST_IMPL_FORMAT_C_STRING_AS_STRING_(const wchar_t, ::std::wstring);
#endif

#undef GTEST_IMPL_FORMAT_C_STRING_AS_STRING_

// Formats a comparison assertion (e.g. ASSERT_EQ, EXPECT_LT, and etc)
// operand to be used in a failure message.  The type (but not value)
// of the other operand may affect the format.  This allows us to
// print a char* as a raw pointer when it is compared against another
// char* or void*, and print it as a C string when it is compared
// against an std::string object, for example.
//
// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
template 
std::string FormatForComparisonFailureMessage(
    const T1& value, const T2& /* other_operand */) {
  return FormatForComparison::Format(value);
}

// Separate the error generating code from the code path to reduce the stack
// frame size of CmpHelperEQ. This helps reduce the overhead of some sanitizers
// when calling EXPECT_* in a tight loop.
template 
AssertionResult CmpHelperEQFailure(const char* expected_expression,
                                   const char* actual_expression,
                                   const T1& expected, const T2& actual) {
  return EqFailure(expected_expression,
                   actual_expression,
                   FormatForComparisonFailureMessage(expected, actual),
                   FormatForComparisonFailureMessage(actual, expected),
                   false);
}

// The helper function for {ASSERT|EXPECT}_EQ.
template 
AssertionResult CmpHelperEQ(const char* expected_expression,
                            const char* actual_expression,
                            const T1& expected,
                            const T2& actual) {
GTEST_DISABLE_MSC_WARNINGS_PUSH_(4389 /* signed/unsigned mismatch */)
  if (expected == actual) {
    return AssertionSuccess();
  }
GTEST_DISABLE_MSC_WARNINGS_POP_()

  return CmpHelperEQFailure(expected_expression, actual_expression, expected,
                            actual);
}

// With this overloaded version, we allow anonymous enums to be used
// in {ASSERT|EXPECT}_EQ when compiled with gcc 4, as anonymous enums
// can be implicitly cast to BiggestInt.
GTEST_API_ AssertionResult CmpHelperEQ(const char* expected_expression,
                                       const char* actual_expression,
                                       BiggestInt expected,
                                       BiggestInt actual);

// The helper class for {ASSERT|EXPECT}_EQ.  The template argument
// lhs_is_null_literal is true iff the first argument to ASSERT_EQ()
// is a null pointer literal.  The following default implementation is
// for lhs_is_null_literal being false.
template 
class EqHelper {
 public:
  // This templatized version is for the general case.
  template 
  static AssertionResult Compare(const char* expected_expression,
                                 const char* actual_expression,
                                 const T1& expected,
                                 const T2& actual) {
    return CmpHelperEQ(expected_expression, actual_expression, expected,
                       actual);
  }

  // With this overloaded version, we allow anonymous enums to be used
  // in {ASSERT|EXPECT}_EQ when compiled with gcc 4, as anonymous
  // enums can be implicitly cast to BiggestInt.
  //
  // Even though its body looks the same as the above version, we
  // cannot merge the two, as it will make anonymous enums unhappy.
  static AssertionResult Compare(const char* expected_expression,
                                 const char* actual_expression,
                                 BiggestInt expected,
                                 BiggestInt actual) {
    return CmpHelperEQ(expected_expression, actual_expression, expected,
                       actual);
  }
};

// This specialization is used when the first argument to ASSERT_EQ()
// is a null pointer literal, like NULL, false, or 0.
template <>
class EqHelper {
 public:
  // We define two overloaded versions of Compare().  The first
  // version will be picked when the second argument to ASSERT_EQ() is
  // NOT a pointer, e.g. ASSERT_EQ(0, AnIntFunction()) or
  // EXPECT_EQ(false, a_bool).
  template 
  static AssertionResult Compare(
      const char* expected_expression,
      const char* actual_expression,
      const T1& expected,
      const T2& actual,
      // The following line prevents this overload from being considered if T2
      // is not a pointer type.  We need this because ASSERT_EQ(NULL, my_ptr)
      // expands to Compare("", "", NULL, my_ptr), which requires a conversion
      // to match the Secret* in the other overload, which would otherwise make
      // this template match better.
      typename EnableIf::value>::type* = 0) {
    return CmpHelperEQ(expected_expression, actual_expression, expected,
                       actual);
  }

  // This version will be picked when the second argument to ASSERT_EQ() is a
  // pointer, e.g. ASSERT_EQ(NULL, a_pointer).
  template 
  static AssertionResult Compare(
      const char* expected_expression,
      const char* actual_expression,
      // We used to have a second template parameter instead of Secret*.  That
      // template parameter would deduce to 'long', making this a better match
      // than the first overload even without the first overload's EnableIf.
      // Unfortunately, gcc with -Wconversion-null warns when "passing NULL to
      // non-pointer argument" (even a deduced integral argument), so the old
      // implementation caused warnings in user code.
      Secret* /* expected (NULL) */,
      T* actual) {
    // We already know that 'expected' is a null pointer.
    return CmpHelperEQ(expected_expression, actual_expression,
                       static_cast(NULL), actual);
  }
};

// Separate the error generating code from the code path to reduce the stack
// frame size of CmpHelperOP. This helps reduce the overhead of some sanitizers
// when calling EXPECT_OP in a tight loop.
template 
AssertionResult CmpHelperOpFailure(const char* expr1, const char* expr2,
                                   const T1& val1, const T2& val2,
                                   const char* op) {
  return AssertionFailure()
         << "Expected: (" << expr1 << ") " << op << " (" << expr2
         << "), actual: " << FormatForComparisonFailureMessage(val1, val2)
         << " vs " << FormatForComparisonFailureMessage(val2, val1);
}

// A macro for implementing the helper functions needed to implement
// ASSERT_?? and EXPECT_??.  It is here just to avoid copy-and-paste
// of similar code.
//
// For each templatized helper function, we also define an overloaded
// version for BiggestInt in order to reduce code bloat and allow
// anonymous enums to be used with {ASSERT|EXPECT}_?? when compiled
// with gcc 4.
//
// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.

#define GTEST_IMPL_CMP_HELPER_(op_name, op)\
template \
AssertionResult CmpHelper##op_name(const char* expr1, const char* expr2, \
                                   const T1& val1, const T2& val2) {\
  if (val1 op val2) {\
    return AssertionSuccess();\
  } else {\
    return CmpHelperOpFailure(expr1, expr2, val1, val2, #op);\
  }\
}\
GTEST_API_ AssertionResult CmpHelper##op_name(\
    const char* expr1, const char* expr2, BiggestInt val1, BiggestInt val2)

// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.

// Implements the helper function for {ASSERT|EXPECT}_NE
GTEST_IMPL_CMP_HELPER_(NE, !=);
// Implements the helper function for {ASSERT|EXPECT}_LE
GTEST_IMPL_CMP_HELPER_(LE, <=);
// Implements the helper function for {ASSERT|EXPECT}_LT
GTEST_IMPL_CMP_HELPER_(LT, <);
// Implements the helper function for {ASSERT|EXPECT}_GE
GTEST_IMPL_CMP_HELPER_(GE, >=);
// Implements the helper function for {ASSERT|EXPECT}_GT
GTEST_IMPL_CMP_HELPER_(GT, >);

#undef GTEST_IMPL_CMP_HELPER_

// The helper function for {ASSERT|EXPECT}_STREQ.
//
// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
GTEST_API_ AssertionResult CmpHelperSTREQ(const char* expected_expression,
                                          const char* actual_expression,
                                          const char* expected,
                                          const char* actual);

// The helper function for {ASSERT|EXPECT}_STRCASEEQ.
//
// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
GTEST_API_ AssertionResult CmpHelperSTRCASEEQ(const char* expected_expression,
                                              const char* actual_expression,
                                              const char* expected,
                                              const char* actual);

// The helper function for {ASSERT|EXPECT}_STRNE.
//
// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
GTEST_API_ AssertionResult CmpHelperSTRNE(const char* s1_expression,
                                          const char* s2_expression,
                                          const char* s1,
                                          const char* s2);

// The helper function for {ASSERT|EXPECT}_STRCASENE.
//
// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
GTEST_API_ AssertionResult CmpHelperSTRCASENE(const char* s1_expression,
                                              const char* s2_expression,
                                              const char* s1,
                                              const char* s2);


// Helper function for *_STREQ on wide strings.
//
// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
GTEST_API_ AssertionResult CmpHelperSTREQ(const char* expected_expression,
                                          const char* actual_expression,
                                          const wchar_t* expected,
                                          const wchar_t* actual);

// Helper function for *_STRNE on wide strings.
//
// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
GTEST_API_ AssertionResult CmpHelperSTRNE(const char* s1_expression,
                                          const char* s2_expression,
                                          const wchar_t* s1,
                                          const wchar_t* s2);

}  // namespace internal

// IsSubstring() and IsNotSubstring() are intended to be used as the
// first argument to {EXPECT,ASSERT}_PRED_FORMAT2(), not by
// themselves.  They check whether needle is a substring of haystack
// (NULL is considered a substring of itself only), and return an
// appropriate error message when they fail.
//
// The {needle,haystack}_expr arguments are the stringified
// expressions that generated the two real arguments.
GTEST_API_ AssertionResult IsSubstring(
    const char* needle_expr, const char* haystack_expr,
    const char* needle, const char* haystack);
GTEST_API_ AssertionResult IsSubstring(
    const char* needle_expr, const char* haystack_expr,
    const wchar_t* needle, const wchar_t* haystack);
GTEST_API_ AssertionResult IsNotSubstring(
    const char* needle_expr, const char* haystack_expr,
    const char* needle, const char* haystack);
GTEST_API_ AssertionResult IsNotSubstring(
    const char* needle_expr, const char* haystack_expr,
    const wchar_t* needle, const wchar_t* haystack);
GTEST_API_ AssertionResult IsSubstring(
    const char* needle_expr, const char* haystack_expr,
    const ::std::string& needle, const ::std::string& haystack);
GTEST_API_ AssertionResult IsNotSubstring(
    const char* needle_expr, const char* haystack_expr,
    const ::std::string& needle, const ::std::string& haystack);

#if GTEST_HAS_STD_WSTRING
GTEST_API_ AssertionResult IsSubstring(
    const char* needle_expr, const char* haystack_expr,
    const ::std::wstring& needle, const ::std::wstring& haystack);
GTEST_API_ AssertionResult IsNotSubstring(
    const char* needle_expr, const char* haystack_expr,
    const ::std::wstring& needle, const ::std::wstring& haystack);
#endif  // GTEST_HAS_STD_WSTRING

namespace internal {

// Helper template function for comparing floating-points.
//
// Template parameter:
//
//   RawType: the raw floating-point type (either float or double)
//
// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
template 
AssertionResult CmpHelperFloatingPointEQ(const char* expected_expression,
                                         const char* actual_expression,
                                         RawType expected,
                                         RawType actual) {
  const FloatingPoint lhs(expected), rhs(actual);

  if (lhs.AlmostEquals(rhs)) {
    return AssertionSuccess();
  }

  ::std::stringstream expected_ss;
  expected_ss << std::setprecision(std::numeric_limits::digits10 + 2)
              << expected;

  ::std::stringstream actual_ss;
  actual_ss << std::setprecision(std::numeric_limits::digits10 + 2)
            << actual;

  return EqFailure(expected_expression,
                   actual_expression,
                   StringStreamToString(&expected_ss),
                   StringStreamToString(&actual_ss),
                   false);
}

// Helper function for implementing ASSERT_NEAR.
//
// INTERNAL IMPLEMENTATION - DO NOT USE IN A USER PROGRAM.
GTEST_API_ AssertionResult DoubleNearPredFormat(const char* expr1,
                                                const char* expr2,
                                                const char* abs_error_expr,
                                                double val1,
                                                double val2,
                                                double abs_error);

// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE.
// A class that enables one to stream messages to assertion macros
class GTEST_API_ AssertHelper {
 public:
  // Constructor.
  AssertHelper(TestPartResult::Type type,
               const char* file,
               int line,
               const char* message);
  ~AssertHelper();

  // Message assignment is a semantic trick to enable assertion
  // streaming; see the GTEST_MESSAGE_ macro below.
  void operator=(const Message& message) const;

 private:
  // We put our data in a struct so that the size of the AssertHelper class can
  // be as small as possible.  This is important because gcc is incapable of
  // re-using stack space even for temporary variables, so every EXPECT_EQ
  // reserves stack space for another AssertHelper.
  struct AssertHelperData {
    AssertHelperData(TestPartResult::Type t,
                     const char* srcfile,
                     int line_num,
                     const char* msg)
        : type(t), file(srcfile), line(line_num), message(msg) { }

    TestPartResult::Type const type;
    const char* const file;
    int const line;
    std::string const message;

   private:
    GTEST_DISALLOW_COPY_AND_ASSIGN_(AssertHelperData);
  };

  AssertHelperData* const data_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(AssertHelper);
};

}  // namespace internal

#if GTEST_HAS_PARAM_TEST
// The pure interface class that all value-parameterized tests inherit from.
// A value-parameterized class must inherit from both ::testing::Test and
// ::testing::WithParamInterface. In most cases that just means inheriting
// from ::testing::TestWithParam, but more complicated test hierarchies
// may need to inherit from Test and WithParamInterface at different levels.
//
// This interface has support for accessing the test parameter value via
// the GetParam() method.
//
// Use it with one of the parameter generator defining functions, like Range(),
// Values(), ValuesIn(), Bool(), and Combine().
//
// class FooTest : public ::testing::TestWithParam {
//  protected:
//   FooTest() {
//     // Can use GetParam() here.
//   }
//   virtual ~FooTest() {
//     // Can use GetParam() here.
//   }
//   virtual void SetUp() {
//     // Can use GetParam() here.
//   }
//   virtual void TearDown {
//     // Can use GetParam() here.
//   }
// };
// TEST_P(FooTest, DoesBar) {
//   // Can use GetParam() method here.
//   Foo foo;
//   ASSERT_TRUE(foo.DoesBar(GetParam()));
// }
// INSTANTIATE_TEST_CASE_P(OneToTenRange, FooTest, ::testing::Range(1, 10));

template 
class WithParamInterface {
 public:
  typedef T ParamType;
  virtual ~WithParamInterface() {}

  // The current parameter value. Is also available in the test fixture's
  // constructor. This member function is non-static, even though it only
  // references static data, to reduce the opportunity for incorrect uses
  // like writing 'WithParamInterface::GetParam()' for a test that
  // uses a fixture whose parameter type is int.
  const ParamType& GetParam() const {
    GTEST_CHECK_(parameter_ != NULL)
        << "GetParam() can only be called inside a value-parameterized test "
        << "-- did you intend to write TEST_P instead of TEST_F?";
    return *parameter_;
  }

 private:
  // Sets parameter value. The caller is responsible for making sure the value
  // remains alive and unchanged throughout the current test.
  static void SetParam(const ParamType* parameter) {
    parameter_ = parameter;
  }

  // Static value used for accessing parameter during a test lifetime.
  static const ParamType* parameter_;

  // TestClass must be a subclass of WithParamInterface and Test.
  template  friend class internal::ParameterizedTestFactory;
};

template 
const T* WithParamInterface::parameter_ = NULL;

// Most value-parameterized classes can ignore the existence of
// WithParamInterface, and can just inherit from ::testing::TestWithParam.

template 
class TestWithParam : public Test, public WithParamInterface {
};

#endif  // GTEST_HAS_PARAM_TEST

// Macros for indicating success/failure in test code.

// ADD_FAILURE unconditionally adds a failure to the current test.
// SUCCEED generates a success - it doesn't automatically make the
// current test successful, as a test is only successful when it has
// no failure.
//
// EXPECT_* verifies that a certain condition is satisfied.  If not,
// it behaves like ADD_FAILURE.  In particular:
//
//   EXPECT_TRUE  verifies that a Boolean condition is true.
//   EXPECT_FALSE verifies that a Boolean condition is false.
//
// FAIL and ASSERT_* are similar to ADD_FAILURE and EXPECT_*, except
// that they will also abort the current function on failure.  People
// usually want the fail-fast behavior of FAIL and ASSERT_*, but those
// writing data-driven tests often find themselves using ADD_FAILURE
// and EXPECT_* more.

// Generates a nonfatal failure with a generic message.
#define ADD_FAILURE() GTEST_NONFATAL_FAILURE_("Failed")

// Generates a nonfatal failure at the given source file location with
// a generic message.
#define ADD_FAILURE_AT(file, line) \
  GTEST_MESSAGE_AT_(file, line, "Failed", \
                    ::testing::TestPartResult::kNonFatalFailure)

// Generates a fatal failure with a generic message.
#define GTEST_FAIL() GTEST_FATAL_FAILURE_("Failed")

// Define this macro to 1 to omit the definition of FAIL(), which is a
// generic name and clashes with some other libraries.
#if !GTEST_DONT_DEFINE_FAIL
# define FAIL() GTEST_FAIL()
#endif

// Generates a success with a generic message.
#define GTEST_SUCCEED() GTEST_SUCCESS_("Succeeded")

// Define this macro to 1 to omit the definition of SUCCEED(), which
// is a generic name and clashes with some other libraries.
#if !GTEST_DONT_DEFINE_SUCCEED
# define SUCCEED() GTEST_SUCCEED()
#endif

// Macros for testing exceptions.
//
//    * {ASSERT|EXPECT}_THROW(statement, expected_exception):
//         Tests that the statement throws the expected exception.
//    * {ASSERT|EXPECT}_NO_THROW(statement):
//         Tests that the statement doesn't throw any exception.
//    * {ASSERT|EXPECT}_ANY_THROW(statement):
//         Tests that the statement throws an exception.

#define EXPECT_THROW(statement, expected_exception) \
  GTEST_TEST_THROW_(statement, expected_exception, GTEST_NONFATAL_FAILURE_)
#define EXPECT_NO_THROW(statement) \
  GTEST_TEST_NO_THROW_(statement, GTEST_NONFATAL_FAILURE_)
#define EXPECT_ANY_THROW(statement) \
  GTEST_TEST_ANY_THROW_(statement, GTEST_NONFATAL_FAILURE_)
#define ASSERT_THROW(statement, expected_exception) \
  GTEST_TEST_THROW_(statement, expected_exception, GTEST_FATAL_FAILURE_)
#define ASSERT_NO_THROW(statement) \
  GTEST_TEST_NO_THROW_(statement, GTEST_FATAL_FAILURE_)
#define ASSERT_ANY_THROW(statement) \
  GTEST_TEST_ANY_THROW_(statement, GTEST_FATAL_FAILURE_)

// Boolean assertions. Condition can be either a Boolean expression or an
// AssertionResult. For more information on how to use AssertionResult with
// these macros see comments on that class.
#define EXPECT_TRUE(condition) \
  GTEST_TEST_BOOLEAN_(condition, #condition, false, true, \
                      GTEST_NONFATAL_FAILURE_)
#define EXPECT_FALSE(condition) \
  GTEST_TEST_BOOLEAN_(!(condition), #condition, true, false, \
                      GTEST_NONFATAL_FAILURE_)
#define ASSERT_TRUE(condition) \
  GTEST_TEST_BOOLEAN_(condition, #condition, false, true, \
                      GTEST_FATAL_FAILURE_)
#define ASSERT_FALSE(condition) \
  GTEST_TEST_BOOLEAN_(!(condition), #condition, true, false, \
                      GTEST_FATAL_FAILURE_)

// Includes the auto-generated header that implements a family of
// generic predicate assertion macros.
#include "gtest/gtest_pred_impl.h"

// Macros for testing equalities and inequalities.
//
//    * {ASSERT|EXPECT}_EQ(expected, actual): Tests that expected == actual
//    * {ASSERT|EXPECT}_NE(v1, v2):           Tests that v1 != v2
//    * {ASSERT|EXPECT}_LT(v1, v2):           Tests that v1 < v2
//    * {ASSERT|EXPECT}_LE(v1, v2):           Tests that v1 <= v2
//    * {ASSERT|EXPECT}_GT(v1, v2):           Tests that v1 > v2
//    * {ASSERT|EXPECT}_GE(v1, v2):           Tests that v1 >= v2
//
// When they are not, Google Test prints both the tested expressions and
// their actual values.  The values must be compatible built-in types,
// or you will get a compiler error.  By "compatible" we mean that the
// values can be compared by the respective operator.
//
// Note:
//
//   1. It is possible to make a user-defined type work with
//   {ASSERT|EXPECT}_??(), but that requires overloading the
//   comparison operators and is thus discouraged by the Google C++
//   Usage Guide.  Therefore, you are advised to use the
//   {ASSERT|EXPECT}_TRUE() macro to assert that two objects are
//   equal.
//
//   2. The {ASSERT|EXPECT}_??() macros do pointer comparisons on
//   pointers (in particular, C strings).  Therefore, if you use it
//   with two C strings, you are testing how their locations in memory
//   are related, not how their content is related.  To compare two C
//   strings by content, use {ASSERT|EXPECT}_STR*().
//
//   3. {ASSERT|EXPECT}_EQ(expected, actual) is preferred to
//   {ASSERT|EXPECT}_TRUE(expected == actual), as the former tells you
//   what the actual value is when it fails, and similarly for the
//   other comparisons.
//
//   4. Do not depend on the order in which {ASSERT|EXPECT}_??()
//   evaluate their arguments, which is undefined.
//
//   5. These macros evaluate their arguments exactly once.
//
// Examples:
//
//   EXPECT_NE(5, Foo());
//   EXPECT_EQ(NULL, a_pointer);
//   ASSERT_LT(i, array_size);
//   ASSERT_GT(records.size(), 0) << "There is no record left.";

#define EXPECT_EQ(expected, actual) \
  EXPECT_PRED_FORMAT2(::testing::internal:: \
                      EqHelper::Compare, \
                      expected, actual)
#define EXPECT_NE(expected, actual) \
  EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperNE, expected, actual)
#define EXPECT_LE(val1, val2) \
  EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperLE, val1, val2)
#define EXPECT_LT(val1, val2) \
  EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperLT, val1, val2)
#define EXPECT_GE(val1, val2) \
  EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperGE, val1, val2)
#define EXPECT_GT(val1, val2) \
  EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperGT, val1, val2)

#define GTEST_ASSERT_EQ(expected, actual) \
  ASSERT_PRED_FORMAT2(::testing::internal:: \
                      EqHelper::Compare, \
                      expected, actual)
#define GTEST_ASSERT_NE(val1, val2) \
  ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperNE, val1, val2)
#define GTEST_ASSERT_LE(val1, val2) \
  ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperLE, val1, val2)
#define GTEST_ASSERT_LT(val1, val2) \
  ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperLT, val1, val2)
#define GTEST_ASSERT_GE(val1, val2) \
  ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperGE, val1, val2)
#define GTEST_ASSERT_GT(val1, val2) \
  ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperGT, val1, val2)

// Define macro GTEST_DONT_DEFINE_ASSERT_XY to 1 to omit the definition of
// ASSERT_XY(), which clashes with some users' own code.

#if !GTEST_DONT_DEFINE_ASSERT_EQ
# define ASSERT_EQ(val1, val2) GTEST_ASSERT_EQ(val1, val2)
#endif

#if !GTEST_DONT_DEFINE_ASSERT_NE
# define ASSERT_NE(val1, val2) GTEST_ASSERT_NE(val1, val2)
#endif

#if !GTEST_DONT_DEFINE_ASSERT_LE
# define ASSERT_LE(val1, val2) GTEST_ASSERT_LE(val1, val2)
#endif

#if !GTEST_DONT_DEFINE_ASSERT_LT
# define ASSERT_LT(val1, val2) GTEST_ASSERT_LT(val1, val2)
#endif

#if !GTEST_DONT_DEFINE_ASSERT_GE
# define ASSERT_GE(val1, val2) GTEST_ASSERT_GE(val1, val2)
#endif

#if !GTEST_DONT_DEFINE_ASSERT_GT
# define ASSERT_GT(val1, val2) GTEST_ASSERT_GT(val1, val2)
#endif

// C-string Comparisons.  All tests treat NULL and any non-NULL string
// as different.  Two NULLs are equal.
//
//    * {ASSERT|EXPECT}_STREQ(s1, s2):     Tests that s1 == s2
//    * {ASSERT|EXPECT}_STRNE(s1, s2):     Tests that s1 != s2
//    * {ASSERT|EXPECT}_STRCASEEQ(s1, s2): Tests that s1 == s2, ignoring case
//    * {ASSERT|EXPECT}_STRCASENE(s1, s2): Tests that s1 != s2, ignoring case
//
// For wide or narrow string objects, you can use the
// {ASSERT|EXPECT}_??() macros.
//
// Don't depend on the order in which the arguments are evaluated,
// which is undefined.
//
// These macros evaluate their arguments exactly once.

#define EXPECT_STREQ(expected, actual) \
  EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperSTREQ, expected, actual)
#define EXPECT_STRNE(s1, s2) \
  EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperSTRNE, s1, s2)
#define EXPECT_STRCASEEQ(expected, actual) \
  EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperSTRCASEEQ, expected, actual)
#define EXPECT_STRCASENE(s1, s2)\
  EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperSTRCASENE, s1, s2)

#define ASSERT_STREQ(expected, actual) \
  ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperSTREQ, expected, actual)
#define ASSERT_STRNE(s1, s2) \
  ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperSTRNE, s1, s2)
#define ASSERT_STRCASEEQ(expected, actual) \
  ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperSTRCASEEQ, expected, actual)
#define ASSERT_STRCASENE(s1, s2)\
  ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperSTRCASENE, s1, s2)

// Macros for comparing floating-point numbers.
//
//    * {ASSERT|EXPECT}_FLOAT_EQ(expected, actual):
//         Tests that two float values are almost equal.
//    * {ASSERT|EXPECT}_DOUBLE_EQ(expected, actual):
//         Tests that two double values are almost equal.
//    * {ASSERT|EXPECT}_NEAR(v1, v2, abs_error):
//         Tests that v1 and v2 are within the given distance to each other.
//
// Google Test uses ULP-based comparison to automatically pick a default
// error bound that is appropriate for the operands.  See the
// FloatingPoint template class in gtest-internal.h if you are
// interested in the implementation details.

#define EXPECT_FLOAT_EQ(expected, actual)\
  EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperFloatingPointEQ, \
                      expected, actual)

#define EXPECT_DOUBLE_EQ(expected, actual)\
  EXPECT_PRED_FORMAT2(::testing::internal::CmpHelperFloatingPointEQ, \
                      expected, actual)

#define ASSERT_FLOAT_EQ(expected, actual)\
  ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperFloatingPointEQ, \
                      expected, actual)

#define ASSERT_DOUBLE_EQ(expected, actual)\
  ASSERT_PRED_FORMAT2(::testing::internal::CmpHelperFloatingPointEQ, \
                      expected, actual)

#define EXPECT_NEAR(val1, val2, abs_error)\
  EXPECT_PRED_FORMAT3(::testing::internal::DoubleNearPredFormat, \
                      val1, val2, abs_error)

#define ASSERT_NEAR(val1, val2, abs_error)\
  ASSERT_PRED_FORMAT3(::testing::internal::DoubleNearPredFormat, \
                      val1, val2, abs_error)

// These predicate format functions work on floating-point values, and
// can be used in {ASSERT|EXPECT}_PRED_FORMAT2*(), e.g.
//
//   EXPECT_PRED_FORMAT2(testing::DoubleLE, Foo(), 5.0);

// Asserts that val1 is less than, or almost equal to, val2.  Fails
// otherwise.  In particular, it fails if either val1 or val2 is NaN.
GTEST_API_ AssertionResult FloatLE(const char* expr1, const char* expr2,
                                   float val1, float val2);
GTEST_API_ AssertionResult DoubleLE(const char* expr1, const char* expr2,
                                    double val1, double val2);


#if GTEST_OS_WINDOWS

// Macros that test for HRESULT failure and success, these are only useful
// on Windows, and rely on Windows SDK macros and APIs to compile.
//
//    * {ASSERT|EXPECT}_HRESULT_{SUCCEEDED|FAILED}(expr)
//
// When expr unexpectedly fails or succeeds, Google Test prints the
// expected result and the actual result with both a human-readable
// string representation of the error, if available, as well as the
// hex result code.
# define EXPECT_HRESULT_SUCCEEDED(expr) \
    EXPECT_PRED_FORMAT1(::testing::internal::IsHRESULTSuccess, (expr))

# define ASSERT_HRESULT_SUCCEEDED(expr) \
    ASSERT_PRED_FORMAT1(::testing::internal::IsHRESULTSuccess, (expr))

# define EXPECT_HRESULT_FAILED(expr) \
    EXPECT_PRED_FORMAT1(::testing::internal::IsHRESULTFailure, (expr))

# define ASSERT_HRESULT_FAILED(expr) \
    ASSERT_PRED_FORMAT1(::testing::internal::IsHRESULTFailure, (expr))

#endif  // GTEST_OS_WINDOWS

// Macros that execute statement and check that it doesn't generate new fatal
// failures in the current thread.
//
//   * {ASSERT|EXPECT}_NO_FATAL_FAILURE(statement);
//
// Examples:
//
//   EXPECT_NO_FATAL_FAILURE(Process());
//   ASSERT_NO_FATAL_FAILURE(Process()) << "Process() failed";
//
#define ASSERT_NO_FATAL_FAILURE(statement) \
    GTEST_TEST_NO_FATAL_FAILURE_(statement, GTEST_FATAL_FAILURE_)
#define EXPECT_NO_FATAL_FAILURE(statement) \
    GTEST_TEST_NO_FATAL_FAILURE_(statement, GTEST_NONFATAL_FAILURE_)

// Causes a trace (including the source file path, the current line
// number, and the given message) to be included in every test failure
// message generated by code in the current scope.  The effect is
// undone when the control leaves the current scope.
//
// The message argument can be anything streamable to std::ostream.
//
// In the implementation, we include the current line number as part
// of the dummy variable name, thus allowing multiple SCOPED_TRACE()s
// to appear in the same block - as long as they are on different
// lines.
#define SCOPED_TRACE(message) \
  ::testing::internal::ScopedTrace GTEST_CONCAT_TOKEN_(gtest_trace_, __LINE__)(\
    __FILE__, __LINE__, ::testing::Message() << (message))

// Compile-time assertion for type equality.
// StaticAssertTypeEq() compiles iff type1 and type2 are
// the same type.  The value it returns is not interesting.
//
// Instead of making StaticAssertTypeEq a class template, we make it a
// function template that invokes a helper class template.  This
// prevents a user from misusing StaticAssertTypeEq by
// defining objects of that type.
//
// CAVEAT:
//
// When used inside a method of a class template,
// StaticAssertTypeEq() is effective ONLY IF the method is
// instantiated.  For example, given:
//
//   template  class Foo {
//    public:
//     void Bar() { testing::StaticAssertTypeEq(); }
//   };
//
// the code:
//
//   void Test1() { Foo foo; }
//
// will NOT generate a compiler error, as Foo::Bar() is never
// actually instantiated.  Instead, you need:
//
//   void Test2() { Foo foo; foo.Bar(); }
//
// to cause a compiler error.
template 
bool StaticAssertTypeEq() {
  (void)internal::StaticAssertTypeEqHelper();
  return true;
}

// Defines a test.
//
// The first parameter is the name of the test case, and the second
// parameter is the name of the test within the test case.
//
// The convention is to end the test case name with "Test".  For
// example, a test case for the Foo class can be named FooTest.
//
// Test code should appear between braces after an invocation of
// this macro.  Example:
//
//   TEST(FooTest, InitializesCorrectly) {
//     Foo foo;
//     EXPECT_TRUE(foo.StatusIsOK());
//   }

// Note that we call GetTestTypeId() instead of GetTypeId<
// ::testing::Test>() here to get the type ID of testing::Test.  This
// is to work around a suspected linker bug when using Google Test as
// a framework on Mac OS X.  The bug causes GetTypeId<
// ::testing::Test>() to return different values depending on whether
// the call is from the Google Test framework itself or from user test
// code.  GetTestTypeId() is guaranteed to always return the same
// value, as it always calls GetTypeId<>() from the Google Test
// framework.
#define GTEST_TEST(test_case_name, test_name)\
  GTEST_TEST_(test_case_name, test_name, \
              ::testing::Test, ::testing::internal::GetTestTypeId())

// Define this macro to 1 to omit the definition of TEST(), which
// is a generic name and clashes with some other libraries.
#if !GTEST_DONT_DEFINE_TEST
# define TEST(test_case_name, test_name) GTEST_TEST(test_case_name, test_name)
#endif

// Defines a test that uses a test fixture.
//
// The first parameter is the name of the test fixture class, which
// also doubles as the test case name.  The second parameter is the
// name of the test within the test case.
//
// A test fixture class must be declared earlier.  The user should put
// his test code between braces after using this macro.  Example:
//
//   class FooTest : public testing::Test {
//    protected:
//     virtual void SetUp() { b_.AddElement(3); }
//
//     Foo a_;
//     Foo b_;
//   };
//
//   TEST_F(FooTest, InitializesCorrectly) {
//     EXPECT_TRUE(a_.StatusIsOK());
//   }
//
//   TEST_F(FooTest, ReturnsElementCountCorrectly) {
//     EXPECT_EQ(0, a_.size());
//     EXPECT_EQ(1, b_.size());
//   }

#define TEST_F(test_fixture, test_name)\
  GTEST_TEST_(test_fixture, test_name, test_fixture, \
              ::testing::internal::GetTypeId())

}  // namespace testing

// Use this function in main() to run all tests.  It returns 0 if all
// tests are successful, or 1 otherwise.
//
// RUN_ALL_TESTS() should be invoked after the command line has been
// parsed by InitGoogleTest().
//
// This function was formerly a macro; thus, it is in the global
// namespace and has an all-caps name.
int RUN_ALL_TESTS() GTEST_MUST_USE_RESULT_;

inline int RUN_ALL_TESTS() {
  return ::testing::UnitTest::GetInstance()->Run();
}

#endif  // GTEST_INCLUDE_GTEST_GTEST_H_
node-v4.8.2/deps/gtest/include/gtest/gtest_pred_impl.h000644 000766 000024 00000035451 13070706730 023147 0ustar00iojsstaff000000 000000 // Copyright 2006, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

// This file is AUTOMATICALLY GENERATED on 10/31/2011 by command
// 'gen_gtest_pred_impl.py 5'.  DO NOT EDIT BY HAND!
//
// Implements a family of generic predicate assertion macros.

#ifndef GTEST_INCLUDE_GTEST_GTEST_PRED_IMPL_H_
#define GTEST_INCLUDE_GTEST_GTEST_PRED_IMPL_H_

// Makes sure this header is not included before gtest.h.
#ifndef GTEST_INCLUDE_GTEST_GTEST_H_
# error Do not include gtest_pred_impl.h directly.  Include gtest.h instead.
#endif  // GTEST_INCLUDE_GTEST_GTEST_H_

// This header implements a family of generic predicate assertion
// macros:
//
//   ASSERT_PRED_FORMAT1(pred_format, v1)
//   ASSERT_PRED_FORMAT2(pred_format, v1, v2)
//   ...
//
// where pred_format is a function or functor that takes n (in the
// case of ASSERT_PRED_FORMATn) values and their source expression
// text, and returns a testing::AssertionResult.  See the definition
// of ASSERT_EQ in gtest.h for an example.
//
// If you don't care about formatting, you can use the more
// restrictive version:
//
//   ASSERT_PRED1(pred, v1)
//   ASSERT_PRED2(pred, v1, v2)
//   ...
//
// where pred is an n-ary function or functor that returns bool,
// and the values v1, v2, ..., must support the << operator for
// streaming to std::ostream.
//
// We also define the EXPECT_* variations.
//
// For now we only support predicates whose arity is at most 5.
// Please email googletestframework@googlegroups.com if you need
// support for higher arities.

// GTEST_ASSERT_ is the basic statement to which all of the assertions
// in this file reduce.  Don't use this in your code.

#define GTEST_ASSERT_(expression, on_failure) \
  GTEST_AMBIGUOUS_ELSE_BLOCKER_ \
  if (const ::testing::AssertionResult gtest_ar = (expression)) \
    ; \
  else \
    on_failure(gtest_ar.failure_message())


// Helper function for implementing {EXPECT|ASSERT}_PRED1.  Don't use
// this in your code.
template 
AssertionResult AssertPred1Helper(const char* pred_text,
                                  const char* e1,
                                  Pred pred,
                                  const T1& v1) {
  if (pred(v1)) return AssertionSuccess();

  return AssertionFailure() << pred_text << "("
                            << e1 << ") evaluates to false, where"
                            << "\n" << e1 << " evaluates to " << v1;
}

// Internal macro for implementing {EXPECT|ASSERT}_PRED_FORMAT1.
// Don't use this in your code.
#define GTEST_PRED_FORMAT1_(pred_format, v1, on_failure)\
  GTEST_ASSERT_(pred_format(#v1, v1), \
                on_failure)

// Internal macro for implementing {EXPECT|ASSERT}_PRED1.  Don't use
// this in your code.
#define GTEST_PRED1_(pred, v1, on_failure)\
  GTEST_ASSERT_(::testing::AssertPred1Helper(#pred, \
                                             #v1, \
                                             pred, \
                                             v1), on_failure)

// Unary predicate assertion macros.
#define EXPECT_PRED_FORMAT1(pred_format, v1) \
  GTEST_PRED_FORMAT1_(pred_format, v1, GTEST_NONFATAL_FAILURE_)
#define EXPECT_PRED1(pred, v1) \
  GTEST_PRED1_(pred, v1, GTEST_NONFATAL_FAILURE_)
#define ASSERT_PRED_FORMAT1(pred_format, v1) \
  GTEST_PRED_FORMAT1_(pred_format, v1, GTEST_FATAL_FAILURE_)
#define ASSERT_PRED1(pred, v1) \
  GTEST_PRED1_(pred, v1, GTEST_FATAL_FAILURE_)



// Helper function for implementing {EXPECT|ASSERT}_PRED2.  Don't use
// this in your code.
template 
AssertionResult AssertPred2Helper(const char* pred_text,
                                  const char* e1,
                                  const char* e2,
                                  Pred pred,
                                  const T1& v1,
                                  const T2& v2) {
  if (pred(v1, v2)) return AssertionSuccess();

  return AssertionFailure() << pred_text << "("
                            << e1 << ", "
                            << e2 << ") evaluates to false, where"
                            << "\n" << e1 << " evaluates to " << v1
                            << "\n" << e2 << " evaluates to " << v2;
}

// Internal macro for implementing {EXPECT|ASSERT}_PRED_FORMAT2.
// Don't use this in your code.
#define GTEST_PRED_FORMAT2_(pred_format, v1, v2, on_failure)\
  GTEST_ASSERT_(pred_format(#v1, #v2, v1, v2), \
                on_failure)

// Internal macro for implementing {EXPECT|ASSERT}_PRED2.  Don't use
// this in your code.
#define GTEST_PRED2_(pred, v1, v2, on_failure)\
  GTEST_ASSERT_(::testing::AssertPred2Helper(#pred, \
                                             #v1, \
                                             #v2, \
                                             pred, \
                                             v1, \
                                             v2), on_failure)

// Binary predicate assertion macros.
#define EXPECT_PRED_FORMAT2(pred_format, v1, v2) \
  GTEST_PRED_FORMAT2_(pred_format, v1, v2, GTEST_NONFATAL_FAILURE_)
#define EXPECT_PRED2(pred, v1, v2) \
  GTEST_PRED2_(pred, v1, v2, GTEST_NONFATAL_FAILURE_)
#define ASSERT_PRED_FORMAT2(pred_format, v1, v2) \
  GTEST_PRED_FORMAT2_(pred_format, v1, v2, GTEST_FATAL_FAILURE_)
#define ASSERT_PRED2(pred, v1, v2) \
  GTEST_PRED2_(pred, v1, v2, GTEST_FATAL_FAILURE_)



// Helper function for implementing {EXPECT|ASSERT}_PRED3.  Don't use
// this in your code.
template 
AssertionResult AssertPred3Helper(const char* pred_text,
                                  const char* e1,
                                  const char* e2,
                                  const char* e3,
                                  Pred pred,
                                  const T1& v1,
                                  const T2& v2,
                                  const T3& v3) {
  if (pred(v1, v2, v3)) return AssertionSuccess();

  return AssertionFailure() << pred_text << "("
                            << e1 << ", "
                            << e2 << ", "
                            << e3 << ") evaluates to false, where"
                            << "\n" << e1 << " evaluates to " << v1
                            << "\n" << e2 << " evaluates to " << v2
                            << "\n" << e3 << " evaluates to " << v3;
}

// Internal macro for implementing {EXPECT|ASSERT}_PRED_FORMAT3.
// Don't use this in your code.
#define GTEST_PRED_FORMAT3_(pred_format, v1, v2, v3, on_failure)\
  GTEST_ASSERT_(pred_format(#v1, #v2, #v3, v1, v2, v3), \
                on_failure)

// Internal macro for implementing {EXPECT|ASSERT}_PRED3.  Don't use
// this in your code.
#define GTEST_PRED3_(pred, v1, v2, v3, on_failure)\
  GTEST_ASSERT_(::testing::AssertPred3Helper(#pred, \
                                             #v1, \
                                             #v2, \
                                             #v3, \
                                             pred, \
                                             v1, \
                                             v2, \
                                             v3), on_failure)

// Ternary predicate assertion macros.
#define EXPECT_PRED_FORMAT3(pred_format, v1, v2, v3) \
  GTEST_PRED_FORMAT3_(pred_format, v1, v2, v3, GTEST_NONFATAL_FAILURE_)
#define EXPECT_PRED3(pred, v1, v2, v3) \
  GTEST_PRED3_(pred, v1, v2, v3, GTEST_NONFATAL_FAILURE_)
#define ASSERT_PRED_FORMAT3(pred_format, v1, v2, v3) \
  GTEST_PRED_FORMAT3_(pred_format, v1, v2, v3, GTEST_FATAL_FAILURE_)
#define ASSERT_PRED3(pred, v1, v2, v3) \
  GTEST_PRED3_(pred, v1, v2, v3, GTEST_FATAL_FAILURE_)



// Helper function for implementing {EXPECT|ASSERT}_PRED4.  Don't use
// this in your code.
template 
AssertionResult AssertPred4Helper(const char* pred_text,
                                  const char* e1,
                                  const char* e2,
                                  const char* e3,
                                  const char* e4,
                                  Pred pred,
                                  const T1& v1,
                                  const T2& v2,
                                  const T3& v3,
                                  const T4& v4) {
  if (pred(v1, v2, v3, v4)) return AssertionSuccess();

  return AssertionFailure() << pred_text << "("
                            << e1 << ", "
                            << e2 << ", "
                            << e3 << ", "
                            << e4 << ") evaluates to false, where"
                            << "\n" << e1 << " evaluates to " << v1
                            << "\n" << e2 << " evaluates to " << v2
                            << "\n" << e3 << " evaluates to " << v3
                            << "\n" << e4 << " evaluates to " << v4;
}

// Internal macro for implementing {EXPECT|ASSERT}_PRED_FORMAT4.
// Don't use this in your code.
#define GTEST_PRED_FORMAT4_(pred_format, v1, v2, v3, v4, on_failure)\
  GTEST_ASSERT_(pred_format(#v1, #v2, #v3, #v4, v1, v2, v3, v4), \
                on_failure)

// Internal macro for implementing {EXPECT|ASSERT}_PRED4.  Don't use
// this in your code.
#define GTEST_PRED4_(pred, v1, v2, v3, v4, on_failure)\
  GTEST_ASSERT_(::testing::AssertPred4Helper(#pred, \
                                             #v1, \
                                             #v2, \
                                             #v3, \
                                             #v4, \
                                             pred, \
                                             v1, \
                                             v2, \
                                             v3, \
                                             v4), on_failure)

// 4-ary predicate assertion macros.
#define EXPECT_PRED_FORMAT4(pred_format, v1, v2, v3, v4) \
  GTEST_PRED_FORMAT4_(pred_format, v1, v2, v3, v4, GTEST_NONFATAL_FAILURE_)
#define EXPECT_PRED4(pred, v1, v2, v3, v4) \
  GTEST_PRED4_(pred, v1, v2, v3, v4, GTEST_NONFATAL_FAILURE_)
#define ASSERT_PRED_FORMAT4(pred_format, v1, v2, v3, v4) \
  GTEST_PRED_FORMAT4_(pred_format, v1, v2, v3, v4, GTEST_FATAL_FAILURE_)
#define ASSERT_PRED4(pred, v1, v2, v3, v4) \
  GTEST_PRED4_(pred, v1, v2, v3, v4, GTEST_FATAL_FAILURE_)



// Helper function for implementing {EXPECT|ASSERT}_PRED5.  Don't use
// this in your code.
template 
AssertionResult AssertPred5Helper(const char* pred_text,
                                  const char* e1,
                                  const char* e2,
                                  const char* e3,
                                  const char* e4,
                                  const char* e5,
                                  Pred pred,
                                  const T1& v1,
                                  const T2& v2,
                                  const T3& v3,
                                  const T4& v4,
                                  const T5& v5) {
  if (pred(v1, v2, v3, v4, v5)) return AssertionSuccess();

  return AssertionFailure() << pred_text << "("
                            << e1 << ", "
                            << e2 << ", "
                            << e3 << ", "
                            << e4 << ", "
                            << e5 << ") evaluates to false, where"
                            << "\n" << e1 << " evaluates to " << v1
                            << "\n" << e2 << " evaluates to " << v2
                            << "\n" << e3 << " evaluates to " << v3
                            << "\n" << e4 << " evaluates to " << v4
                            << "\n" << e5 << " evaluates to " << v5;
}

// Internal macro for implementing {EXPECT|ASSERT}_PRED_FORMAT5.
// Don't use this in your code.
#define GTEST_PRED_FORMAT5_(pred_format, v1, v2, v3, v4, v5, on_failure)\
  GTEST_ASSERT_(pred_format(#v1, #v2, #v3, #v4, #v5, v1, v2, v3, v4, v5), \
                on_failure)

// Internal macro for implementing {EXPECT|ASSERT}_PRED5.  Don't use
// this in your code.
#define GTEST_PRED5_(pred, v1, v2, v3, v4, v5, on_failure)\
  GTEST_ASSERT_(::testing::AssertPred5Helper(#pred, \
                                             #v1, \
                                             #v2, \
                                             #v3, \
                                             #v4, \
                                             #v5, \
                                             pred, \
                                             v1, \
                                             v2, \
                                             v3, \
                                             v4, \
                                             v5), on_failure)

// 5-ary predicate assertion macros.
#define EXPECT_PRED_FORMAT5(pred_format, v1, v2, v3, v4, v5) \
  GTEST_PRED_FORMAT5_(pred_format, v1, v2, v3, v4, v5, GTEST_NONFATAL_FAILURE_)
#define EXPECT_PRED5(pred, v1, v2, v3, v4, v5) \
  GTEST_PRED5_(pred, v1, v2, v3, v4, v5, GTEST_NONFATAL_FAILURE_)
#define ASSERT_PRED_FORMAT5(pred_format, v1, v2, v3, v4, v5) \
  GTEST_PRED_FORMAT5_(pred_format, v1, v2, v3, v4, v5, GTEST_FATAL_FAILURE_)
#define ASSERT_PRED5(pred, v1, v2, v3, v4, v5) \
  GTEST_PRED5_(pred, v1, v2, v3, v4, v5, GTEST_FATAL_FAILURE_)



#endif  // GTEST_INCLUDE_GTEST_GTEST_PRED_IMPL_H_
node-v4.8.2/deps/gtest/include/gtest/gtest_prod.h000644 000766 000024 00000004424 13070706730 022134 0ustar00iojsstaff000000 000000 // Copyright 2006, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Author: wan@google.com (Zhanyong Wan)
//
// Google C++ Testing Framework definitions useful in production code.

#ifndef GTEST_INCLUDE_GTEST_GTEST_PROD_H_
#define GTEST_INCLUDE_GTEST_GTEST_PROD_H_

// When you need to test the private or protected members of a class,
// use the FRIEND_TEST macro to declare your tests as friends of the
// class.  For example:
//
// class MyClass {
//  private:
//   void MyMethod();
//   FRIEND_TEST(MyClassTest, MyMethod);
// };
//
// class MyClassTest : public testing::Test {
//   // ...
// };
//
// TEST_F(MyClassTest, MyMethod) {
//   // Can call MyClass::MyMethod() here.
// }

#define FRIEND_TEST(test_case_name, test_name)\
friend class test_case_name##_##test_name##_Test

#endif  // GTEST_INCLUDE_GTEST_GTEST_PROD_H_
node-v4.8.2/deps/gtest/include/gtest/internal/000755 000766 000024 00000000000 13070706730 021421 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/gtest/include/gtest/internal/gtest-death-test-internal.h000644 000766 000024 00000032165 13070706730 026601 0ustar00iojsstaff000000 000000 // Copyright 2005, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Authors: wan@google.com (Zhanyong Wan), eefacm@gmail.com (Sean Mcafee)
//
// The Google C++ Testing Framework (Google Test)
//
// This header file defines internal utilities needed for implementing
// death tests.  They are subject to change without notice.

#ifndef GTEST_INCLUDE_GTEST_INTERNAL_GTEST_DEATH_TEST_INTERNAL_H_
#define GTEST_INCLUDE_GTEST_INTERNAL_GTEST_DEATH_TEST_INTERNAL_H_

#include "gtest/internal/gtest-internal.h"

#include 

namespace testing {
namespace internal {

GTEST_DECLARE_string_(internal_run_death_test);

// Names of the flags (needed for parsing Google Test flags).
const char kDeathTestStyleFlag[] = "death_test_style";
const char kDeathTestUseFork[] = "death_test_use_fork";
const char kInternalRunDeathTestFlag[] = "internal_run_death_test";

#if GTEST_HAS_DEATH_TEST

// DeathTest is a class that hides much of the complexity of the
// GTEST_DEATH_TEST_ macro.  It is abstract; its static Create method
// returns a concrete class that depends on the prevailing death test
// style, as defined by the --gtest_death_test_style and/or
// --gtest_internal_run_death_test flags.

// In describing the results of death tests, these terms are used with
// the corresponding definitions:
//
// exit status:  The integer exit information in the format specified
//               by wait(2)
// exit code:    The integer code passed to exit(3), _exit(2), or
//               returned from main()
class GTEST_API_ DeathTest {
 public:
  // Create returns false if there was an error determining the
  // appropriate action to take for the current death test; for example,
  // if the gtest_death_test_style flag is set to an invalid value.
  // The LastMessage method will return a more detailed message in that
  // case.  Otherwise, the DeathTest pointer pointed to by the "test"
  // argument is set.  If the death test should be skipped, the pointer
  // is set to NULL; otherwise, it is set to the address of a new concrete
  // DeathTest object that controls the execution of the current test.
  static bool Create(const char* statement, const RE* regex,
                     const char* file, int line, DeathTest** test);
  DeathTest();
  virtual ~DeathTest() { }

  // A helper class that aborts a death test when it's deleted.
  class ReturnSentinel {
   public:
    explicit ReturnSentinel(DeathTest* test) : test_(test) { }
    ~ReturnSentinel() { test_->Abort(TEST_ENCOUNTERED_RETURN_STATEMENT); }
   private:
    DeathTest* const test_;
    GTEST_DISALLOW_COPY_AND_ASSIGN_(ReturnSentinel);
  } GTEST_ATTRIBUTE_UNUSED_;

  // An enumeration of possible roles that may be taken when a death
  // test is encountered.  EXECUTE means that the death test logic should
  // be executed immediately.  OVERSEE means that the program should prepare
  // the appropriate environment for a child process to execute the death
  // test, then wait for it to complete.
  enum TestRole { OVERSEE_TEST, EXECUTE_TEST };

  // An enumeration of the three reasons that a test might be aborted.
  enum AbortReason {
    TEST_ENCOUNTERED_RETURN_STATEMENT,
    TEST_THREW_EXCEPTION,
    TEST_DID_NOT_DIE
  };

  // Assumes one of the above roles.
  virtual TestRole AssumeRole() = 0;

  // Waits for the death test to finish and returns its status.
  virtual int Wait() = 0;

  // Returns true if the death test passed; that is, the test process
  // exited during the test, its exit status matches a user-supplied
  // predicate, and its stderr output matches a user-supplied regular
  // expression.
  // The user-supplied predicate may be a macro expression rather
  // than a function pointer or functor, or else Wait and Passed could
  // be combined.
  virtual bool Passed(bool exit_status_ok) = 0;

  // Signals that the death test did not die as expected.
  virtual void Abort(AbortReason reason) = 0;

  // Returns a human-readable outcome message regarding the outcome of
  // the last death test.
  static const char* LastMessage();

  static void set_last_death_test_message(const std::string& message);

 private:
  // A string containing a description of the outcome of the last death test.
  static std::string last_death_test_message_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(DeathTest);
};

// Factory interface for death tests.  May be mocked out for testing.
class DeathTestFactory {
 public:
  virtual ~DeathTestFactory() { }
  virtual bool Create(const char* statement, const RE* regex,
                      const char* file, int line, DeathTest** test) = 0;
};

// A concrete DeathTestFactory implementation for normal use.
class DefaultDeathTestFactory : public DeathTestFactory {
 public:
  virtual bool Create(const char* statement, const RE* regex,
                      const char* file, int line, DeathTest** test);
};

// Returns true if exit_status describes a process that was terminated
// by a signal, or exited normally with a nonzero exit code.
GTEST_API_ bool ExitedUnsuccessfully(int exit_status);

// Traps C++ exceptions escaping statement and reports them as test
// failures. Note that trapping SEH exceptions is not implemented here.
# if GTEST_HAS_EXCEPTIONS
#  define GTEST_EXECUTE_DEATH_TEST_STATEMENT_(statement, death_test) \
  try { \
    GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(statement); \
  } catch (const ::std::exception& gtest_exception) { \
    fprintf(\
        stderr, \
        "\n%s: Caught std::exception-derived exception escaping the " \
        "death test statement. Exception message: %s\n", \
        ::testing::internal::FormatFileLocation(__FILE__, __LINE__).c_str(), \
        gtest_exception.what()); \
    fflush(stderr); \
    death_test->Abort(::testing::internal::DeathTest::TEST_THREW_EXCEPTION); \
  } catch (...) { \
    death_test->Abort(::testing::internal::DeathTest::TEST_THREW_EXCEPTION); \
  }

# else
#  define GTEST_EXECUTE_DEATH_TEST_STATEMENT_(statement, death_test) \
  GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(statement)

# endif

// This macro is for implementing ASSERT_DEATH*, EXPECT_DEATH*,
// ASSERT_EXIT*, and EXPECT_EXIT*.
# define GTEST_DEATH_TEST_(statement, predicate, regex, fail) \
  GTEST_AMBIGUOUS_ELSE_BLOCKER_ \
  if (::testing::internal::AlwaysTrue()) { \
    const ::testing::internal::RE& gtest_regex = (regex); \
    ::testing::internal::DeathTest* gtest_dt; \
    if (!::testing::internal::DeathTest::Create(#statement, >est_regex, \
        __FILE__, __LINE__, >est_dt)) { \
      goto GTEST_CONCAT_TOKEN_(gtest_label_, __LINE__); \
    } \
    if (gtest_dt != NULL) { \
      ::testing::internal::scoped_ptr< ::testing::internal::DeathTest> \
          gtest_dt_ptr(gtest_dt); \
      switch (gtest_dt->AssumeRole()) { \
        case ::testing::internal::DeathTest::OVERSEE_TEST: \
          if (!gtest_dt->Passed(predicate(gtest_dt->Wait()))) { \
            goto GTEST_CONCAT_TOKEN_(gtest_label_, __LINE__); \
          } \
          break; \
        case ::testing::internal::DeathTest::EXECUTE_TEST: { \
          ::testing::internal::DeathTest::ReturnSentinel \
              gtest_sentinel(gtest_dt); \
          GTEST_EXECUTE_DEATH_TEST_STATEMENT_(statement, gtest_dt); \
          gtest_dt->Abort(::testing::internal::DeathTest::TEST_DID_NOT_DIE); \
          break; \
        } \
        default: \
          break; \
      } \
    } \
  } else \
    GTEST_CONCAT_TOKEN_(gtest_label_, __LINE__): \
      fail(::testing::internal::DeathTest::LastMessage())
// The symbol "fail" here expands to something into which a message
// can be streamed.

// This macro is for implementing ASSERT/EXPECT_DEBUG_DEATH when compiled in
// NDEBUG mode. In this case we need the statements to be executed, the regex is
// ignored, and the macro must accept a streamed message even though the message
// is never printed.
# define GTEST_EXECUTE_STATEMENT_(statement, regex) \
  GTEST_AMBIGUOUS_ELSE_BLOCKER_ \
  if (::testing::internal::AlwaysTrue()) { \
     GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(statement); \
  } else \
    ::testing::Message()

// A class representing the parsed contents of the
// --gtest_internal_run_death_test flag, as it existed when
// RUN_ALL_TESTS was called.
class InternalRunDeathTestFlag {
 public:
  InternalRunDeathTestFlag(const std::string& a_file,
                           int a_line,
                           int an_index,
                           int a_write_fd)
      : file_(a_file), line_(a_line), index_(an_index),
        write_fd_(a_write_fd) {}

  ~InternalRunDeathTestFlag() {
    if (write_fd_ >= 0)
      posix::Close(write_fd_);
  }

  const std::string& file() const { return file_; }
  int line() const { return line_; }
  int index() const { return index_; }
  int write_fd() const { return write_fd_; }

 private:
  std::string file_;
  int line_;
  int index_;
  int write_fd_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(InternalRunDeathTestFlag);
};

// Returns a newly created InternalRunDeathTestFlag object with fields
// initialized from the GTEST_FLAG(internal_run_death_test) flag if
// the flag is specified; otherwise returns NULL.
InternalRunDeathTestFlag* ParseInternalRunDeathTestFlag();

#else  // GTEST_HAS_DEATH_TEST

// This macro is used for implementing macros such as
// EXPECT_DEATH_IF_SUPPORTED and ASSERT_DEATH_IF_SUPPORTED on systems where
// death tests are not supported. Those macros must compile on such systems
// iff EXPECT_DEATH and ASSERT_DEATH compile with the same parameters on
// systems that support death tests. This allows one to write such a macro
// on a system that does not support death tests and be sure that it will
// compile on a death-test supporting system.
//
// Parameters:
//   statement -  A statement that a macro such as EXPECT_DEATH would test
//                for program termination. This macro has to make sure this
//                statement is compiled but not executed, to ensure that
//                EXPECT_DEATH_IF_SUPPORTED compiles with a certain
//                parameter iff EXPECT_DEATH compiles with it.
//   regex     -  A regex that a macro such as EXPECT_DEATH would use to test
//                the output of statement.  This parameter has to be
//                compiled but not evaluated by this macro, to ensure that
//                this macro only accepts expressions that a macro such as
//                EXPECT_DEATH would accept.
//   terminator - Must be an empty statement for EXPECT_DEATH_IF_SUPPORTED
//                and a return statement for ASSERT_DEATH_IF_SUPPORTED.
//                This ensures that ASSERT_DEATH_IF_SUPPORTED will not
//                compile inside functions where ASSERT_DEATH doesn't
//                compile.
//
//  The branch that has an always false condition is used to ensure that
//  statement and regex are compiled (and thus syntactically correct) but
//  never executed. The unreachable code macro protects the terminator
//  statement from generating an 'unreachable code' warning in case
//  statement unconditionally returns or throws. The Message constructor at
//  the end allows the syntax of streaming additional messages into the
//  macro, for compilational compatibility with EXPECT_DEATH/ASSERT_DEATH.
# define GTEST_UNSUPPORTED_DEATH_TEST_(statement, regex, terminator) \
    GTEST_AMBIGUOUS_ELSE_BLOCKER_ \
    if (::testing::internal::AlwaysTrue()) { \
      GTEST_LOG_(WARNING) \
          << "Death tests are not supported on this platform.\n" \
          << "Statement '" #statement "' cannot be verified."; \
    } else if (::testing::internal::AlwaysFalse()) { \
      ::testing::internal::RE::PartialMatch(".*", (regex)); \
      GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(statement); \
      terminator; \
    } else \
      ::testing::Message()

#endif  // GTEST_HAS_DEATH_TEST

}  // namespace internal
}  // namespace testing

#endif  // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_DEATH_TEST_INTERNAL_H_
node-v4.8.2/deps/gtest/include/gtest/internal/gtest-filepath.h000644 000766 000024 00000022603 13070706730 024515 0ustar00iojsstaff000000 000000 // Copyright 2008, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Author: keith.ray@gmail.com (Keith Ray)
//
// Google Test filepath utilities
//
// This header file declares classes and functions used internally by
// Google Test.  They are subject to change without notice.
//
// This file is #included in .
// Do not include this header file separately!

#ifndef GTEST_INCLUDE_GTEST_INTERNAL_GTEST_FILEPATH_H_
#define GTEST_INCLUDE_GTEST_INTERNAL_GTEST_FILEPATH_H_

#include "gtest/internal/gtest-string.h"

namespace testing {
namespace internal {

// FilePath - a class for file and directory pathname manipulation which
// handles platform-specific conventions (like the pathname separator).
// Used for helper functions for naming files in a directory for xml output.
// Except for Set methods, all methods are const or static, which provides an
// "immutable value object" -- useful for peace of mind.
// A FilePath with a value ending in a path separator ("like/this/") represents
// a directory, otherwise it is assumed to represent a file. In either case,
// it may or may not represent an actual file or directory in the file system.
// Names are NOT checked for syntax correctness -- no checking for illegal
// characters, malformed paths, etc.

class GTEST_API_ FilePath {
 public:
  FilePath() : pathname_("") { }
  FilePath(const FilePath& rhs) : pathname_(rhs.pathname_) { }

  explicit FilePath(const std::string& pathname) : pathname_(pathname) {
    Normalize();
  }

  FilePath& operator=(const FilePath& rhs) {
    Set(rhs);
    return *this;
  }

  void Set(const FilePath& rhs) {
    pathname_ = rhs.pathname_;
  }

  const std::string& string() const { return pathname_; }
  const char* c_str() const { return pathname_.c_str(); }

  // Returns the current working directory, or "" if unsuccessful.
  static FilePath GetCurrentDir();

  // Given directory = "dir", base_name = "test", number = 0,
  // extension = "xml", returns "dir/test.xml". If number is greater
  // than zero (e.g., 12), returns "dir/test_12.xml".
  // On Windows platform, uses \ as the separator rather than /.
  static FilePath MakeFileName(const FilePath& directory,
                               const FilePath& base_name,
                               int number,
                               const char* extension);

  // Given directory = "dir", relative_path = "test.xml",
  // returns "dir/test.xml".
  // On Windows, uses \ as the separator rather than /.
  static FilePath ConcatPaths(const FilePath& directory,
                              const FilePath& relative_path);

  // Returns a pathname for a file that does not currently exist. The pathname
  // will be directory/base_name.extension or
  // directory/base_name_.extension if directory/base_name.extension
  // already exists. The number will be incremented until a pathname is found
  // that does not already exist.
  // Examples: 'dir/foo_test.xml' or 'dir/foo_test_1.xml'.
  // There could be a race condition if two or more processes are calling this
  // function at the same time -- they could both pick the same filename.
  static FilePath GenerateUniqueFileName(const FilePath& directory,
                                         const FilePath& base_name,
                                         const char* extension);

  // Returns true iff the path is "".
  bool IsEmpty() const { return pathname_.empty(); }

  // If input name has a trailing separator character, removes it and returns
  // the name, otherwise return the name string unmodified.
  // On Windows platform, uses \ as the separator, other platforms use /.
  FilePath RemoveTrailingPathSeparator() const;

  // Returns a copy of the FilePath with the directory part removed.
  // Example: FilePath("path/to/file").RemoveDirectoryName() returns
  // FilePath("file"). If there is no directory part ("just_a_file"), it returns
  // the FilePath unmodified. If there is no file part ("just_a_dir/") it
  // returns an empty FilePath ("").
  // On Windows platform, '\' is the path separator, otherwise it is '/'.
  FilePath RemoveDirectoryName() const;

  // RemoveFileName returns the directory path with the filename removed.
  // Example: FilePath("path/to/file").RemoveFileName() returns "path/to/".
  // If the FilePath is "a_file" or "/a_file", RemoveFileName returns
  // FilePath("./") or, on Windows, FilePath(".\\"). If the filepath does
  // not have a file, like "just/a/dir/", it returns the FilePath unmodified.
  // On Windows platform, '\' is the path separator, otherwise it is '/'.
  FilePath RemoveFileName() const;

  // Returns a copy of the FilePath with the case-insensitive extension removed.
  // Example: FilePath("dir/file.exe").RemoveExtension("EXE") returns
  // FilePath("dir/file"). If a case-insensitive extension is not
  // found, returns a copy of the original FilePath.
  FilePath RemoveExtension(const char* extension) const;

  // Creates directories so that path exists. Returns true if successful or if
  // the directories already exist; returns false if unable to create
  // directories for any reason. Will also return false if the FilePath does
  // not represent a directory (that is, it doesn't end with a path separator).
  bool CreateDirectoriesRecursively() const;

  // Create the directory so that path exists. Returns true if successful or
  // if the directory already exists; returns false if unable to create the
  // directory for any reason, including if the parent directory does not
  // exist. Not named "CreateDirectory" because that's a macro on Windows.
  bool CreateFolder() const;

  // Returns true if FilePath describes something in the file-system,
  // either a file, directory, or whatever, and that something exists.
  bool FileOrDirectoryExists() const;

  // Returns true if pathname describes a directory in the file-system
  // that exists.
  bool DirectoryExists() const;

  // Returns true if FilePath ends with a path separator, which indicates that
  // it is intended to represent a directory. Returns false otherwise.
  // This does NOT check that a directory (or file) actually exists.
  bool IsDirectory() const;

  // Returns true if pathname describes a root directory. (Windows has one
  // root directory per disk drive.)
  bool IsRootDirectory() const;

  // Returns true if pathname describes an absolute path.
  bool IsAbsolutePath() const;

 private:
  // Replaces multiple consecutive separators with a single separator.
  // For example, "bar///foo" becomes "bar/foo". Does not eliminate other
  // redundancies that might be in a pathname involving "." or "..".
  //
  // A pathname with multiple consecutive separators may occur either through
  // user error or as a result of some scripts or APIs that generate a pathname
  // with a trailing separator. On other platforms the same API or script
  // may NOT generate a pathname with a trailing "/". Then elsewhere that
  // pathname may have another "/" and pathname components added to it,
  // without checking for the separator already being there.
  // The script language and operating system may allow paths like "foo//bar"
  // but some of the functions in FilePath will not handle that correctly. In
  // particular, RemoveTrailingPathSeparator() only removes one separator, and
  // it is called in CreateDirectoriesRecursively() assuming that it will change
  // a pathname from directory syntax (trailing separator) to filename syntax.
  //
  // On Windows this method also replaces the alternate path separator '/' with
  // the primary path separator '\\', so that for example "bar\\/\\foo" becomes
  // "bar\\foo".

  void Normalize();

  // Returns a pointer to the last occurence of a valid path separator in
  // the FilePath. On Windows, for example, both '/' and '\' are valid path
  // separators. Returns NULL if no path separator was found.
  const char* FindLastPathSeparator() const;

  std::string pathname_;
};  // class FilePath

}  // namespace internal
}  // namespace testing

#endif  // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_FILEPATH_H_
node-v4.8.2/deps/gtest/include/gtest/internal/gtest-internal.h000644 000766 000024 00000130742 13070706730 024541 0ustar00iojsstaff000000 000000 // Copyright 2005, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Authors: wan@google.com (Zhanyong Wan), eefacm@gmail.com (Sean Mcafee)
//
// The Google C++ Testing Framework (Google Test)
//
// This header file declares functions and macros used internally by
// Google Test.  They are subject to change without notice.

#ifndef GTEST_INCLUDE_GTEST_INTERNAL_GTEST_INTERNAL_H_
#define GTEST_INCLUDE_GTEST_INTERNAL_GTEST_INTERNAL_H_

#include "gtest/internal/gtest-port.h"

#if GTEST_OS_LINUX
# include 
# include 
# include 
# include 
#endif  // GTEST_OS_LINUX

#if GTEST_HAS_EXCEPTIONS
# include 
#endif

#include 
#include 
#include 
#include 
#include 
#include 
#include 
#include 

#include "gtest/gtest-message.h"
#include "gtest/internal/gtest-string.h"
#include "gtest/internal/gtest-filepath.h"
#include "gtest/internal/gtest-type-util.h"

// Due to C++ preprocessor weirdness, we need double indirection to
// concatenate two tokens when one of them is __LINE__.  Writing
//
//   foo ## __LINE__
//
// will result in the token foo__LINE__, instead of foo followed by
// the current line number.  For more details, see
// http://www.parashift.com/c++-faq-lite/misc-technical-issues.html#faq-39.6
#define GTEST_CONCAT_TOKEN_(foo, bar) GTEST_CONCAT_TOKEN_IMPL_(foo, bar)
#define GTEST_CONCAT_TOKEN_IMPL_(foo, bar) foo ## bar

class ProtocolMessage;
namespace proto2 { class Message; }

namespace testing {

// Forward declarations.

class AssertionResult;                 // Result of an assertion.
class Message;                         // Represents a failure message.
class Test;                            // Represents a test.
class TestInfo;                        // Information about a test.
class TestPartResult;                  // Result of a test part.
class UnitTest;                        // A collection of test cases.

template 
::std::string PrintToString(const T& value);

namespace internal {

struct TraceInfo;                      // Information about a trace point.
class ScopedTrace;                     // Implements scoped trace.
class TestInfoImpl;                    // Opaque implementation of TestInfo
class UnitTestImpl;                    // Opaque implementation of UnitTest

// How many times InitGoogleTest() has been called.
GTEST_API_ extern int g_init_gtest_count;

// The text used in failure messages to indicate the start of the
// stack trace.
GTEST_API_ extern const char kStackTraceMarker[];

// Two overloaded helpers for checking at compile time whether an
// expression is a null pointer literal (i.e. NULL or any 0-valued
// compile-time integral constant).  Their return values have
// different sizes, so we can use sizeof() to test which version is
// picked by the compiler.  These helpers have no implementations, as
// we only need their signatures.
//
// Given IsNullLiteralHelper(x), the compiler will pick the first
// version if x can be implicitly converted to Secret*, and pick the
// second version otherwise.  Since Secret is a secret and incomplete
// type, the only expression a user can write that has type Secret* is
// a null pointer literal.  Therefore, we know that x is a null
// pointer literal if and only if the first version is picked by the
// compiler.
char IsNullLiteralHelper(Secret* p);
char (&IsNullLiteralHelper(...))[2];  // NOLINT

// A compile-time bool constant that is true if and only if x is a
// null pointer literal (i.e. NULL or any 0-valued compile-time
// integral constant).
#ifdef GTEST_ELLIPSIS_NEEDS_POD_
// We lose support for NULL detection where the compiler doesn't like
// passing non-POD classes through ellipsis (...).
# define GTEST_IS_NULL_LITERAL_(x) false
#else
# define GTEST_IS_NULL_LITERAL_(x) \
    (sizeof(::testing::internal::IsNullLiteralHelper(x)) == 1)
#endif  // GTEST_ELLIPSIS_NEEDS_POD_

// Appends the user-supplied message to the Google-Test-generated message.
GTEST_API_ std::string AppendUserMessage(
    const std::string& gtest_msg, const Message& user_msg);

#if GTEST_HAS_EXCEPTIONS

// This exception is thrown by (and only by) a failed Google Test
// assertion when GTEST_FLAG(throw_on_failure) is true (if exceptions
// are enabled).  We derive it from std::runtime_error, which is for
// errors presumably detectable only at run time.  Since
// std::runtime_error inherits from std::exception, many testing
// frameworks know how to extract and print the message inside it.
class GTEST_API_ GoogleTestFailureException : public ::std::runtime_error {
 public:
  explicit GoogleTestFailureException(const TestPartResult& failure);
};

#endif  // GTEST_HAS_EXCEPTIONS

// A helper class for creating scoped traces in user programs.
class GTEST_API_ ScopedTrace {
 public:
  // The c'tor pushes the given source file location and message onto
  // a trace stack maintained by Google Test.
  ScopedTrace(const char* file, int line, const Message& message);

  // The d'tor pops the info pushed by the c'tor.
  //
  // Note that the d'tor is not virtual in order to be efficient.
  // Don't inherit from ScopedTrace!
  ~ScopedTrace();

 private:
  GTEST_DISALLOW_COPY_AND_ASSIGN_(ScopedTrace);
} GTEST_ATTRIBUTE_UNUSED_;  // A ScopedTrace object does its job in its
                            // c'tor and d'tor.  Therefore it doesn't
                            // need to be used otherwise.

namespace edit_distance {
// Returns the optimal edits to go from 'left' to 'right'.
// All edits cost the same, with replace having lower priority than
// add/remove.
// Simple implementation of the Wagner–Fischer algorithm.
// See http://en.wikipedia.org/wiki/Wagner-Fischer_algorithm
enum EditType { kMatch, kAdd, kRemove, kReplace };
GTEST_API_ std::vector CalculateOptimalEdits(
    const std::vector& left, const std::vector& right);

// Same as above, but the input is represented as strings.
GTEST_API_ std::vector CalculateOptimalEdits(
    const std::vector& left,
    const std::vector& right);

// Create a diff of the input strings in Unified diff format.
GTEST_API_ std::string CreateUnifiedDiff(const std::vector& left,
                                         const std::vector& right,
                                         size_t context = 2);

}  // namespace edit_distance

// Calculate the diff between 'left' and 'right' and return it in unified diff
// format.
// If not null, stores in 'total_line_count' the total number of lines found
// in left + right.
GTEST_API_ std::string DiffStrings(const std::string& left,
                                   const std::string& right,
                                   size_t* total_line_count);

// Constructs and returns the message for an equality assertion
// (e.g. ASSERT_EQ, EXPECT_STREQ, etc) failure.
//
// The first four parameters are the expressions used in the assertion
// and their values, as strings.  For example, for ASSERT_EQ(foo, bar)
// where foo is 5 and bar is 6, we have:
//
//   expected_expression: "foo"
//   actual_expression:   "bar"
//   expected_value:      "5"
//   actual_value:        "6"
//
// The ignoring_case parameter is true iff the assertion is a
// *_STRCASEEQ*.  When it's true, the string " (ignoring case)" will
// be inserted into the message.
GTEST_API_ AssertionResult EqFailure(const char* expected_expression,
                                     const char* actual_expression,
                                     const std::string& expected_value,
                                     const std::string& actual_value,
                                     bool ignoring_case);

// Constructs a failure message for Boolean assertions such as EXPECT_TRUE.
GTEST_API_ std::string GetBoolAssertionFailureMessage(
    const AssertionResult& assertion_result,
    const char* expression_text,
    const char* actual_predicate_value,
    const char* expected_predicate_value);

// This template class represents an IEEE floating-point number
// (either single-precision or double-precision, depending on the
// template parameters).
//
// The purpose of this class is to do more sophisticated number
// comparison.  (Due to round-off error, etc, it's very unlikely that
// two floating-points will be equal exactly.  Hence a naive
// comparison by the == operation often doesn't work.)
//
// Format of IEEE floating-point:
//
//   The most-significant bit being the leftmost, an IEEE
//   floating-point looks like
//
//     sign_bit exponent_bits fraction_bits
//
//   Here, sign_bit is a single bit that designates the sign of the
//   number.
//
//   For float, there are 8 exponent bits and 23 fraction bits.
//
//   For double, there are 11 exponent bits and 52 fraction bits.
//
//   More details can be found at
//   http://en.wikipedia.org/wiki/IEEE_floating-point_standard.
//
// Template parameter:
//
//   RawType: the raw floating-point type (either float or double)
template 
class FloatingPoint {
 public:
  // Defines the unsigned integer type that has the same size as the
  // floating point number.
  typedef typename TypeWithSize::UInt Bits;

  // Constants.

  // # of bits in a number.
  static const size_t kBitCount = 8*sizeof(RawType);

  // # of fraction bits in a number.
  static const size_t kFractionBitCount =
    std::numeric_limits::digits - 1;

  // # of exponent bits in a number.
  static const size_t kExponentBitCount = kBitCount - 1 - kFractionBitCount;

  // The mask for the sign bit.
  static const Bits kSignBitMask = static_cast(1) << (kBitCount - 1);

  // The mask for the fraction bits.
  static const Bits kFractionBitMask =
    ~static_cast(0) >> (kExponentBitCount + 1);

  // The mask for the exponent bits.
  static const Bits kExponentBitMask = ~(kSignBitMask | kFractionBitMask);

  // How many ULP's (Units in the Last Place) we want to tolerate when
  // comparing two numbers.  The larger the value, the more error we
  // allow.  A 0 value means that two numbers must be exactly the same
  // to be considered equal.
  //
  // The maximum error of a single floating-point operation is 0.5
  // units in the last place.  On Intel CPU's, all floating-point
  // calculations are done with 80-bit precision, while double has 64
  // bits.  Therefore, 4 should be enough for ordinary use.
  //
  // See the following article for more details on ULP:
  // http://randomascii.wordpress.com/2012/02/25/comparing-floating-point-numbers-2012-edition/
  static const size_t kMaxUlps = 4;

  // Constructs a FloatingPoint from a raw floating-point number.
  //
  // On an Intel CPU, passing a non-normalized NAN (Not a Number)
  // around may change its bits, although the new value is guaranteed
  // to be also a NAN.  Therefore, don't expect this constructor to
  // preserve the bits in x when x is a NAN.
  explicit FloatingPoint(const RawType& x) { u_.value_ = x; }

  // Static methods

  // Reinterprets a bit pattern as a floating-point number.
  //
  // This function is needed to test the AlmostEquals() method.
  static RawType ReinterpretBits(const Bits bits) {
    FloatingPoint fp(0);
    fp.u_.bits_ = bits;
    return fp.u_.value_;
  }

  // Returns the floating-point number that represent positive infinity.
  static RawType Infinity() {
    return ReinterpretBits(kExponentBitMask);
  }

  // Returns the maximum representable finite floating-point number.
  static RawType Max();

  // Non-static methods

  // Returns the bits that represents this number.
  const Bits &bits() const { return u_.bits_; }

  // Returns the exponent bits of this number.
  Bits exponent_bits() const { return kExponentBitMask & u_.bits_; }

  // Returns the fraction bits of this number.
  Bits fraction_bits() const { return kFractionBitMask & u_.bits_; }

  // Returns the sign bit of this number.
  Bits sign_bit() const { return kSignBitMask & u_.bits_; }

  // Returns true iff this is NAN (not a number).
  bool is_nan() const {
    // It's a NAN if the exponent bits are all ones and the fraction
    // bits are not entirely zeros.
    return (exponent_bits() == kExponentBitMask) && (fraction_bits() != 0);
  }

  // Returns true iff this number is at most kMaxUlps ULP's away from
  // rhs.  In particular, this function:
  //
  //   - returns false if either number is (or both are) NAN.
  //   - treats really large numbers as almost equal to infinity.
  //   - thinks +0.0 and -0.0 are 0 DLP's apart.
  bool AlmostEquals(const FloatingPoint& rhs) const {
    // The IEEE standard says that any comparison operation involving
    // a NAN must return false.
    if (is_nan() || rhs.is_nan()) return false;

    return DistanceBetweenSignAndMagnitudeNumbers(u_.bits_, rhs.u_.bits_)
        <= kMaxUlps;
  }

 private:
  // The data type used to store the actual floating-point number.
  union FloatingPointUnion {
    RawType value_;  // The raw floating-point number.
    Bits bits_;      // The bits that represent the number.
  };

  // Converts an integer from the sign-and-magnitude representation to
  // the biased representation.  More precisely, let N be 2 to the
  // power of (kBitCount - 1), an integer x is represented by the
  // unsigned number x + N.
  //
  // For instance,
  //
  //   -N + 1 (the most negative number representable using
  //          sign-and-magnitude) is represented by 1;
  //   0      is represented by N; and
  //   N - 1  (the biggest number representable using
  //          sign-and-magnitude) is represented by 2N - 1.
  //
  // Read http://en.wikipedia.org/wiki/Signed_number_representations
  // for more details on signed number representations.
  static Bits SignAndMagnitudeToBiased(const Bits &sam) {
    if (kSignBitMask & sam) {
      // sam represents a negative number.
      return ~sam + 1;
    } else {
      // sam represents a positive number.
      return kSignBitMask | sam;
    }
  }

  // Given two numbers in the sign-and-magnitude representation,
  // returns the distance between them as an unsigned number.
  static Bits DistanceBetweenSignAndMagnitudeNumbers(const Bits &sam1,
                                                     const Bits &sam2) {
    const Bits biased1 = SignAndMagnitudeToBiased(sam1);
    const Bits biased2 = SignAndMagnitudeToBiased(sam2);
    return (biased1 >= biased2) ? (biased1 - biased2) : (biased2 - biased1);
  }

  FloatingPointUnion u_;
};

// We cannot use std::numeric_limits::max() as it clashes with the max()
// macro defined by .
template <>
inline float FloatingPoint::Max() { return FLT_MAX; }
template <>
inline double FloatingPoint::Max() { return DBL_MAX; }

// Typedefs the instances of the FloatingPoint template class that we
// care to use.
typedef FloatingPoint Float;
typedef FloatingPoint Double;

// In order to catch the mistake of putting tests that use different
// test fixture classes in the same test case, we need to assign
// unique IDs to fixture classes and compare them.  The TypeId type is
// used to hold such IDs.  The user should treat TypeId as an opaque
// type: the only operation allowed on TypeId values is to compare
// them for equality using the == operator.
typedef const void* TypeId;

template 
class TypeIdHelper {
 public:
  // dummy_ must not have a const type.  Otherwise an overly eager
  // compiler (e.g. MSVC 7.1 & 8.0) may try to merge
  // TypeIdHelper::dummy_ for different Ts as an "optimization".
  static bool dummy_;
};

template 
bool TypeIdHelper::dummy_ = false;

// GetTypeId() returns the ID of type T.  Different values will be
// returned for different types.  Calling the function twice with the
// same type argument is guaranteed to return the same ID.
template 
TypeId GetTypeId() {
  // The compiler is required to allocate a different
  // TypeIdHelper::dummy_ variable for each T used to instantiate
  // the template.  Therefore, the address of dummy_ is guaranteed to
  // be unique.
  return &(TypeIdHelper::dummy_);
}

// Returns the type ID of ::testing::Test.  Always call this instead
// of GetTypeId< ::testing::Test>() to get the type ID of
// ::testing::Test, as the latter may give the wrong result due to a
// suspected linker bug when compiling Google Test as a Mac OS X
// framework.
GTEST_API_ TypeId GetTestTypeId();

// Defines the abstract factory interface that creates instances
// of a Test object.
class TestFactoryBase {
 public:
  virtual ~TestFactoryBase() {}

  // Creates a test instance to run. The instance is both created and destroyed
  // within TestInfoImpl::Run()
  virtual Test* CreateTest() = 0;

 protected:
  TestFactoryBase() {}

 private:
  GTEST_DISALLOW_COPY_AND_ASSIGN_(TestFactoryBase);
};

// This class provides implementation of TeastFactoryBase interface.
// It is used in TEST and TEST_F macros.
template 
class TestFactoryImpl : public TestFactoryBase {
 public:
  virtual Test* CreateTest() { return new TestClass; }
};

#if GTEST_OS_WINDOWS

// Predicate-formatters for implementing the HRESULT checking macros
// {ASSERT|EXPECT}_HRESULT_{SUCCEEDED|FAILED}
// We pass a long instead of HRESULT to avoid causing an
// include dependency for the HRESULT type.
GTEST_API_ AssertionResult IsHRESULTSuccess(const char* expr,
                                            long hr);  // NOLINT
GTEST_API_ AssertionResult IsHRESULTFailure(const char* expr,
                                            long hr);  // NOLINT

#endif  // GTEST_OS_WINDOWS

// Types of SetUpTestCase() and TearDownTestCase() functions.
typedef void (*SetUpTestCaseFunc)();
typedef void (*TearDownTestCaseFunc)();

// Creates a new TestInfo object and registers it with Google Test;
// returns the created object.
//
// Arguments:
//
//   test_case_name:   name of the test case
//   name:             name of the test
//   type_param        the name of the test's type parameter, or NULL if
//                     this is not a typed or a type-parameterized test.
//   value_param       text representation of the test's value parameter,
//                     or NULL if this is not a type-parameterized test.
//   fixture_class_id: ID of the test fixture class
//   set_up_tc:        pointer to the function that sets up the test case
//   tear_down_tc:     pointer to the function that tears down the test case
//   factory:          pointer to the factory that creates a test object.
//                     The newly created TestInfo instance will assume
//                     ownership of the factory object.
GTEST_API_ TestInfo* MakeAndRegisterTestInfo(
    const char* test_case_name,
    const char* name,
    const char* type_param,
    const char* value_param,
    TypeId fixture_class_id,
    SetUpTestCaseFunc set_up_tc,
    TearDownTestCaseFunc tear_down_tc,
    TestFactoryBase* factory);

// If *pstr starts with the given prefix, modifies *pstr to be right
// past the prefix and returns true; otherwise leaves *pstr unchanged
// and returns false.  None of pstr, *pstr, and prefix can be NULL.
GTEST_API_ bool SkipPrefix(const char* prefix, const char** pstr);

#if GTEST_HAS_TYPED_TEST || GTEST_HAS_TYPED_TEST_P

// State of the definition of a type-parameterized test case.
class GTEST_API_ TypedTestCasePState {
 public:
  TypedTestCasePState() : registered_(false) {}

  // Adds the given test name to defined_test_names_ and return true
  // if the test case hasn't been registered; otherwise aborts the
  // program.
  bool AddTestName(const char* file, int line, const char* case_name,
                   const char* test_name) {
    if (registered_) {
      fprintf(stderr, "%s Test %s must be defined before "
              "REGISTER_TYPED_TEST_CASE_P(%s, ...).\n",
              FormatFileLocation(file, line).c_str(), test_name, case_name);
      fflush(stderr);
      posix::Abort();
    }
    defined_test_names_.insert(test_name);
    return true;
  }

  // Verifies that registered_tests match the test names in
  // defined_test_names_; returns registered_tests if successful, or
  // aborts the program otherwise.
  const char* VerifyRegisteredTestNames(
      const char* file, int line, const char* registered_tests);

 private:
  bool registered_;
  ::std::set defined_test_names_;
};

// Skips to the first non-space char after the first comma in 'str';
// returns NULL if no comma is found in 'str'.
inline const char* SkipComma(const char* str) {
  const char* comma = strchr(str, ',');
  if (comma == NULL) {
    return NULL;
  }
  while (IsSpace(*(++comma))) {}
  return comma;
}

// Returns the prefix of 'str' before the first comma in it; returns
// the entire string if it contains no comma.
inline std::string GetPrefixUntilComma(const char* str) {
  const char* comma = strchr(str, ',');
  return comma == NULL ? str : std::string(str, comma);
}

// TypeParameterizedTest::Register()
// registers a list of type-parameterized tests with Google Test.  The
// return value is insignificant - we just need to return something
// such that we can call this function in a namespace scope.
//
// Implementation note: The GTEST_TEMPLATE_ macro declares a template
// template parameter.  It's defined in gtest-type-util.h.
template 
class TypeParameterizedTest {
 public:
  // 'index' is the index of the test in the type list 'Types'
  // specified in INSTANTIATE_TYPED_TEST_CASE_P(Prefix, TestCase,
  // Types).  Valid values for 'index' are [0, N - 1] where N is the
  // length of Types.
  static bool Register(const char* prefix, const char* case_name,
                       const char* test_names, int index) {
    typedef typename Types::Head Type;
    typedef Fixture FixtureClass;
    typedef typename GTEST_BIND_(TestSel, Type) TestClass;

    // First, registers the first type-parameterized test in the type
    // list.
    MakeAndRegisterTestInfo(
        (std::string(prefix) + (prefix[0] == '\0' ? "" : "/") + case_name + "/"
         + StreamableToString(index)).c_str(),
        StripTrailingSpaces(GetPrefixUntilComma(test_names)).c_str(),
        GetTypeName().c_str(),
        NULL,  // No value parameter.
        GetTypeId(),
        TestClass::SetUpTestCase,
        TestClass::TearDownTestCase,
        new TestFactoryImpl);

    // Next, recurses (at compile time) with the tail of the type list.
    return TypeParameterizedTest
        ::Register(prefix, case_name, test_names, index + 1);
  }
};

// The base case for the compile time recursion.
template 
class TypeParameterizedTest {
 public:
  static bool Register(const char* /*prefix*/, const char* /*case_name*/,
                       const char* /*test_names*/, int /*index*/) {
    return true;
  }
};

// TypeParameterizedTestCase::Register()
// registers *all combinations* of 'Tests' and 'Types' with Google
// Test.  The return value is insignificant - we just need to return
// something such that we can call this function in a namespace scope.
template 
class TypeParameterizedTestCase {
 public:
  static bool Register(const char* prefix, const char* case_name,
                       const char* test_names) {
    typedef typename Tests::Head Head;

    // First, register the first test in 'Test' for each type in 'Types'.
    TypeParameterizedTest::Register(
        prefix, case_name, test_names, 0);

    // Next, recurses (at compile time) with the tail of the test list.
    return TypeParameterizedTestCase
        ::Register(prefix, case_name, SkipComma(test_names));
  }
};

// The base case for the compile time recursion.
template 
class TypeParameterizedTestCase {
 public:
  static bool Register(const char* /*prefix*/, const char* /*case_name*/,
                       const char* /*test_names*/) {
    return true;
  }
};

#endif  // GTEST_HAS_TYPED_TEST || GTEST_HAS_TYPED_TEST_P

// Returns the current OS stack trace as an std::string.
//
// The maximum number of stack frames to be included is specified by
// the gtest_stack_trace_depth flag.  The skip_count parameter
// specifies the number of top frames to be skipped, which doesn't
// count against the number of frames to be included.
//
// For example, if Foo() calls Bar(), which in turn calls
// GetCurrentOsStackTraceExceptTop(..., 1), Foo() will be included in
// the trace but Bar() and GetCurrentOsStackTraceExceptTop() won't.
GTEST_API_ std::string GetCurrentOsStackTraceExceptTop(
    UnitTest* unit_test, int skip_count);

// Helpers for suppressing warnings on unreachable code or constant
// condition.

// Always returns true.
GTEST_API_ bool AlwaysTrue();

// Always returns false.
inline bool AlwaysFalse() { return !AlwaysTrue(); }

// Helper for suppressing false warning from Clang on a const char*
// variable declared in a conditional expression always being NULL in
// the else branch.
struct GTEST_API_ ConstCharPtr {
  ConstCharPtr(const char* str) : value(str) {}
  operator bool() const { return true; }
  const char* value;
};

// A simple Linear Congruential Generator for generating random
// numbers with a uniform distribution.  Unlike rand() and srand(), it
// doesn't use global state (and therefore can't interfere with user
// code).  Unlike rand_r(), it's portable.  An LCG isn't very random,
// but it's good enough for our purposes.
class GTEST_API_ Random {
 public:
  static const UInt32 kMaxRange = 1u << 31;

  explicit Random(UInt32 seed) : state_(seed) {}

  void Reseed(UInt32 seed) { state_ = seed; }

  // Generates a random number from [0, range).  Crashes if 'range' is
  // 0 or greater than kMaxRange.
  UInt32 Generate(UInt32 range);

 private:
  UInt32 state_;
  GTEST_DISALLOW_COPY_AND_ASSIGN_(Random);
};

// Defining a variable of type CompileAssertTypesEqual will cause a
// compiler error iff T1 and T2 are different types.
template 
struct CompileAssertTypesEqual;

template 
struct CompileAssertTypesEqual {
};

// Removes the reference from a type if it is a reference type,
// otherwise leaves it unchanged.  This is the same as
// tr1::remove_reference, which is not widely available yet.
template 
struct RemoveReference { typedef T type; };  // NOLINT
template 
struct RemoveReference { typedef T type; };  // NOLINT

// A handy wrapper around RemoveReference that works when the argument
// T depends on template parameters.
#define GTEST_REMOVE_REFERENCE_(T) \
    typename ::testing::internal::RemoveReference::type

// Removes const from a type if it is a const type, otherwise leaves
// it unchanged.  This is the same as tr1::remove_const, which is not
// widely available yet.
template 
struct RemoveConst { typedef T type; };  // NOLINT
template 
struct RemoveConst { typedef T type; };  // NOLINT

// MSVC 8.0, Sun C++, and IBM XL C++ have a bug which causes the above
// definition to fail to remove the const in 'const int[3]' and 'const
// char[3][4]'.  The following specialization works around the bug.
template 
struct RemoveConst {
  typedef typename RemoveConst::type type[N];
};

#if defined(_MSC_VER) && _MSC_VER < 1400
// This is the only specialization that allows VC++ 7.1 to remove const in
// 'const int[3] and 'const int[3][4]'.  However, it causes trouble with GCC
// and thus needs to be conditionally compiled.
template 
struct RemoveConst {
  typedef typename RemoveConst::type type[N];
};
#endif

// A handy wrapper around RemoveConst that works when the argument
// T depends on template parameters.
#define GTEST_REMOVE_CONST_(T) \
    typename ::testing::internal::RemoveConst::type

// Turns const U&, U&, const U, and U all into U.
#define GTEST_REMOVE_REFERENCE_AND_CONST_(T) \
    GTEST_REMOVE_CONST_(GTEST_REMOVE_REFERENCE_(T))

// Adds reference to a type if it is not a reference type,
// otherwise leaves it unchanged.  This is the same as
// tr1::add_reference, which is not widely available yet.
template 
struct AddReference { typedef T& type; };  // NOLINT
template 
struct AddReference { typedef T& type; };  // NOLINT

// A handy wrapper around AddReference that works when the argument T
// depends on template parameters.
#define GTEST_ADD_REFERENCE_(T) \
    typename ::testing::internal::AddReference::type

// Adds a reference to const on top of T as necessary.  For example,
// it transforms
//
//   char         ==> const char&
//   const char   ==> const char&
//   char&        ==> const char&
//   const char&  ==> const char&
//
// The argument T must depend on some template parameters.
#define GTEST_REFERENCE_TO_CONST_(T) \
    GTEST_ADD_REFERENCE_(const GTEST_REMOVE_REFERENCE_(T))

// ImplicitlyConvertible::value is a compile-time bool
// constant that's true iff type From can be implicitly converted to
// type To.
template 
class ImplicitlyConvertible {
 private:
  // We need the following helper functions only for their types.
  // They have no implementations.

  // MakeFrom() is an expression whose type is From.  We cannot simply
  // use From(), as the type From may not have a public default
  // constructor.
  static typename AddReference::type MakeFrom();

  // These two functions are overloaded.  Given an expression
  // Helper(x), the compiler will pick the first version if x can be
  // implicitly converted to type To; otherwise it will pick the
  // second version.
  //
  // The first version returns a value of size 1, and the second
  // version returns a value of size 2.  Therefore, by checking the
  // size of Helper(x), which can be done at compile time, we can tell
  // which version of Helper() is used, and hence whether x can be
  // implicitly converted to type To.
  static char Helper(To);
  static char (&Helper(...))[2];  // NOLINT

  // We have to put the 'public' section after the 'private' section,
  // or MSVC refuses to compile the code.
 public:
#if defined(__BORLANDC__)
  // C++Builder cannot use member overload resolution during template
  // instantiation.  The simplest workaround is to use its C++0x type traits
  // functions (C++Builder 2009 and above only).
  static const bool value = __is_convertible(From, To);
#else
  // MSVC warns about implicitly converting from double to int for
  // possible loss of data, so we need to temporarily disable the
  // warning.
  GTEST_DISABLE_MSC_WARNINGS_PUSH_(4244)
  static const bool value =
      sizeof(Helper(ImplicitlyConvertible::MakeFrom())) == 1;
  GTEST_DISABLE_MSC_WARNINGS_POP_()
#endif  // __BORLANDC__
};
template 
const bool ImplicitlyConvertible::value;

// IsAProtocolMessage::value is a compile-time bool constant that's
// true iff T is type ProtocolMessage, proto2::Message, or a subclass
// of those.
template 
struct IsAProtocolMessage
    : public bool_constant<
  ImplicitlyConvertible::value ||
  ImplicitlyConvertible::value> {
};

// When the compiler sees expression IsContainerTest(0), if C is an
// STL-style container class, the first overload of IsContainerTest
// will be viable (since both C::iterator* and C::const_iterator* are
// valid types and NULL can be implicitly converted to them).  It will
// be picked over the second overload as 'int' is a perfect match for
// the type of argument 0.  If C::iterator or C::const_iterator is not
// a valid type, the first overload is not viable, and the second
// overload will be picked.  Therefore, we can determine whether C is
// a container class by checking the type of IsContainerTest(0).
// The value of the expression is insignificant.
//
// Note that we look for both C::iterator and C::const_iterator.  The
// reason is that C++ injects the name of a class as a member of the
// class itself (e.g. you can refer to class iterator as either
// 'iterator' or 'iterator::iterator').  If we look for C::iterator
// only, for example, we would mistakenly think that a class named
// iterator is an STL container.
//
// Also note that the simpler approach of overloading
// IsContainerTest(typename C::const_iterator*) and
// IsContainerTest(...) doesn't work with Visual Age C++ and Sun C++.
typedef int IsContainer;
template 
IsContainer IsContainerTest(int /* dummy */,
                            typename C::iterator* /* it */ = NULL,
                            typename C::const_iterator* /* const_it */ = NULL) {
  return 0;
}

typedef char IsNotContainer;
template 
IsNotContainer IsContainerTest(long /* dummy */) { return '\0'; }

// EnableIf::type is void when 'Cond' is true, and
// undefined when 'Cond' is false.  To use SFINAE to make a function
// overload only apply when a particular expression is true, add
// "typename EnableIf::type* = 0" as the last parameter.
template struct EnableIf;
template<> struct EnableIf { typedef void type; };  // NOLINT

// Utilities for native arrays.

// ArrayEq() compares two k-dimensional native arrays using the
// elements' operator==, where k can be any integer >= 0.  When k is
// 0, ArrayEq() degenerates into comparing a single pair of values.

template 
bool ArrayEq(const T* lhs, size_t size, const U* rhs);

// This generic version is used when k is 0.
template 
inline bool ArrayEq(const T& lhs, const U& rhs) { return lhs == rhs; }

// This overload is used when k >= 1.
template 
inline bool ArrayEq(const T(&lhs)[N], const U(&rhs)[N]) {
  return internal::ArrayEq(lhs, N, rhs);
}

// This helper reduces code bloat.  If we instead put its logic inside
// the previous ArrayEq() function, arrays with different sizes would
// lead to different copies of the template code.
template 
bool ArrayEq(const T* lhs, size_t size, const U* rhs) {
  for (size_t i = 0; i != size; i++) {
    if (!internal::ArrayEq(lhs[i], rhs[i]))
      return false;
  }
  return true;
}

// Finds the first element in the iterator range [begin, end) that
// equals elem.  Element may be a native array type itself.
template 
Iter ArrayAwareFind(Iter begin, Iter end, const Element& elem) {
  for (Iter it = begin; it != end; ++it) {
    if (internal::ArrayEq(*it, elem))
      return it;
  }
  return end;
}

// CopyArray() copies a k-dimensional native array using the elements'
// operator=, where k can be any integer >= 0.  When k is 0,
// CopyArray() degenerates into copying a single value.

template 
void CopyArray(const T* from, size_t size, U* to);

// This generic version is used when k is 0.
template 
inline void CopyArray(const T& from, U* to) { *to = from; }

// This overload is used when k >= 1.
template 
inline void CopyArray(const T(&from)[N], U(*to)[N]) {
  internal::CopyArray(from, N, *to);
}

// This helper reduces code bloat.  If we instead put its logic inside
// the previous CopyArray() function, arrays with different sizes
// would lead to different copies of the template code.
template 
void CopyArray(const T* from, size_t size, U* to) {
  for (size_t i = 0; i != size; i++) {
    internal::CopyArray(from[i], to + i);
  }
}

// The relation between an NativeArray object (see below) and the
// native array it represents.
// We use 2 different structs to allow non-copyable types to be used, as long
// as RelationToSourceReference() is passed.
struct RelationToSourceReference {};
struct RelationToSourceCopy {};

// Adapts a native array to a read-only STL-style container.  Instead
// of the complete STL container concept, this adaptor only implements
// members useful for Google Mock's container matchers.  New members
// should be added as needed.  To simplify the implementation, we only
// support Element being a raw type (i.e. having no top-level const or
// reference modifier).  It's the client's responsibility to satisfy
// this requirement.  Element can be an array type itself (hence
// multi-dimensional arrays are supported).
template 
class NativeArray {
 public:
  // STL-style container typedefs.
  typedef Element value_type;
  typedef Element* iterator;
  typedef const Element* const_iterator;

  // Constructs from a native array. References the source.
  NativeArray(const Element* array, size_t count, RelationToSourceReference) {
    InitRef(array, count);
  }

  // Constructs from a native array. Copies the source.
  NativeArray(const Element* array, size_t count, RelationToSourceCopy) {
    InitCopy(array, count);
  }

  // Copy constructor.
  NativeArray(const NativeArray& rhs) {
    (this->*rhs.clone_)(rhs.array_, rhs.size_);
  }

  ~NativeArray() {
    if (clone_ != &NativeArray::InitRef)
      delete[] array_;
  }

  // STL-style container methods.
  size_t size() const { return size_; }
  const_iterator begin() const { return array_; }
  const_iterator end() const { return array_ + size_; }
  bool operator==(const NativeArray& rhs) const {
    return size() == rhs.size() &&
        ArrayEq(begin(), size(), rhs.begin());
  }

 private:
  enum {
    kCheckTypeIsNotConstOrAReference = StaticAssertTypeEqHelper<
        Element, GTEST_REMOVE_REFERENCE_AND_CONST_(Element)>::value,
  };

  // Initializes this object with a copy of the input.
  void InitCopy(const Element* array, size_t a_size) {
    Element* const copy = new Element[a_size];
    CopyArray(array, a_size, copy);
    array_ = copy;
    size_ = a_size;
    clone_ = &NativeArray::InitCopy;
  }

  // Initializes this object with a reference of the input.
  void InitRef(const Element* array, size_t a_size) {
    array_ = array;
    size_ = a_size;
    clone_ = &NativeArray::InitRef;
  }

  const Element* array_;
  size_t size_;
  void (NativeArray::*clone_)(const Element*, size_t);

  GTEST_DISALLOW_ASSIGN_(NativeArray);
};

}  // namespace internal
}  // namespace testing

#define GTEST_MESSAGE_AT_(file, line, message, result_type) \
  ::testing::internal::AssertHelper(result_type, file, line, message) \
    = ::testing::Message()

#define GTEST_MESSAGE_(message, result_type) \
  GTEST_MESSAGE_AT_(__FILE__, __LINE__, message, result_type)

#define GTEST_FATAL_FAILURE_(message) \
  return GTEST_MESSAGE_(message, ::testing::TestPartResult::kFatalFailure)

#define GTEST_NONFATAL_FAILURE_(message) \
  GTEST_MESSAGE_(message, ::testing::TestPartResult::kNonFatalFailure)

#define GTEST_SUCCESS_(message) \
  GTEST_MESSAGE_(message, ::testing::TestPartResult::kSuccess)

// Suppresses MSVC warnings 4072 (unreachable code) for the code following
// statement if it returns or throws (or doesn't return or throw in some
// situations).
#define GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(statement) \
  if (::testing::internal::AlwaysTrue()) { statement; }

#define GTEST_TEST_THROW_(statement, expected_exception, fail) \
  GTEST_AMBIGUOUS_ELSE_BLOCKER_ \
  if (::testing::internal::ConstCharPtr gtest_msg = "") { \
    bool gtest_caught_expected = false; \
    try { \
      GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(statement); \
    } \
    catch (expected_exception const&) { \
      gtest_caught_expected = true; \
    } \
    catch (...) { \
      gtest_msg.value = \
          "Expected: " #statement " throws an exception of type " \
          #expected_exception ".\n  Actual: it throws a different type."; \
      goto GTEST_CONCAT_TOKEN_(gtest_label_testthrow_, __LINE__); \
    } \
    if (!gtest_caught_expected) { \
      gtest_msg.value = \
          "Expected: " #statement " throws an exception of type " \
          #expected_exception ".\n  Actual: it throws nothing."; \
      goto GTEST_CONCAT_TOKEN_(gtest_label_testthrow_, __LINE__); \
    } \
  } else \
    GTEST_CONCAT_TOKEN_(gtest_label_testthrow_, __LINE__): \
      fail(gtest_msg.value)

#define GTEST_TEST_NO_THROW_(statement, fail) \
  GTEST_AMBIGUOUS_ELSE_BLOCKER_ \
  if (::testing::internal::AlwaysTrue()) { \
    try { \
      GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(statement); \
    } \
    catch (...) { \
      goto GTEST_CONCAT_TOKEN_(gtest_label_testnothrow_, __LINE__); \
    } \
  } else \
    GTEST_CONCAT_TOKEN_(gtest_label_testnothrow_, __LINE__): \
      fail("Expected: " #statement " doesn't throw an exception.\n" \
           "  Actual: it throws.")

#define GTEST_TEST_ANY_THROW_(statement, fail) \
  GTEST_AMBIGUOUS_ELSE_BLOCKER_ \
  if (::testing::internal::AlwaysTrue()) { \
    bool gtest_caught_any = false; \
    try { \
      GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(statement); \
    } \
    catch (...) { \
      gtest_caught_any = true; \
    } \
    if (!gtest_caught_any) { \
      goto GTEST_CONCAT_TOKEN_(gtest_label_testanythrow_, __LINE__); \
    } \
  } else \
    GTEST_CONCAT_TOKEN_(gtest_label_testanythrow_, __LINE__): \
      fail("Expected: " #statement " throws an exception.\n" \
           "  Actual: it doesn't.")


// Implements Boolean test assertions such as EXPECT_TRUE. expression can be
// either a boolean expression or an AssertionResult. text is a textual
// represenation of expression as it was passed into the EXPECT_TRUE.
#define GTEST_TEST_BOOLEAN_(expression, text, actual, expected, fail) \
  GTEST_AMBIGUOUS_ELSE_BLOCKER_ \
  if (const ::testing::AssertionResult gtest_ar_ = \
      ::testing::AssertionResult(expression)) \
    ; \
  else \
    fail(::testing::internal::GetBoolAssertionFailureMessage(\
        gtest_ar_, text, #actual, #expected).c_str())

#define GTEST_TEST_NO_FATAL_FAILURE_(statement, fail) \
  GTEST_AMBIGUOUS_ELSE_BLOCKER_ \
  if (::testing::internal::AlwaysTrue()) { \
    ::testing::internal::HasNewFatalFailureHelper gtest_fatal_failure_checker; \
    GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(statement); \
    if (gtest_fatal_failure_checker.has_new_fatal_failure()) { \
      goto GTEST_CONCAT_TOKEN_(gtest_label_testnofatal_, __LINE__); \
    } \
  } else \
    GTEST_CONCAT_TOKEN_(gtest_label_testnofatal_, __LINE__): \
      fail("Expected: " #statement " doesn't generate new fatal " \
           "failures in the current thread.\n" \
           "  Actual: it does.")

// Expands to the name of the class that implements the given test.
#define GTEST_TEST_CLASS_NAME_(test_case_name, test_name) \
  test_case_name##_##test_name##_Test

// Helper macro for defining tests.
#define GTEST_TEST_(test_case_name, test_name, parent_class, parent_id)\
class GTEST_TEST_CLASS_NAME_(test_case_name, test_name) : public parent_class {\
 public:\
  GTEST_TEST_CLASS_NAME_(test_case_name, test_name)() {}\
 private:\
  virtual void TestBody();\
  static ::testing::TestInfo* const test_info_ GTEST_ATTRIBUTE_UNUSED_;\
  GTEST_DISALLOW_COPY_AND_ASSIGN_(\
      GTEST_TEST_CLASS_NAME_(test_case_name, test_name));\
};\
\
::testing::TestInfo* const GTEST_TEST_CLASS_NAME_(test_case_name, test_name)\
  ::test_info_ =\
    ::testing::internal::MakeAndRegisterTestInfo(\
        #test_case_name, #test_name, NULL, NULL, \
        (parent_id), \
        parent_class::SetUpTestCase, \
        parent_class::TearDownTestCase, \
        new ::testing::internal::TestFactoryImpl<\
            GTEST_TEST_CLASS_NAME_(test_case_name, test_name)>);\
void GTEST_TEST_CLASS_NAME_(test_case_name, test_name)::TestBody()

#endif  // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_INTERNAL_H_

node-v4.8.2/deps/gtest/include/gtest/internal/gtest-linked_ptr.h000644 000766 000024 00000020350 13070706730 025051 0ustar00iojsstaff000000 000000 // Copyright 2003 Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Authors: Dan Egnor (egnor@google.com)
//
// A "smart" pointer type with reference tracking.  Every pointer to a
// particular object is kept on a circular linked list.  When the last pointer
// to an object is destroyed or reassigned, the object is deleted.
//
// Used properly, this deletes the object when the last reference goes away.
// There are several caveats:
// - Like all reference counting schemes, cycles lead to leaks.
// - Each smart pointer is actually two pointers (8 bytes instead of 4).
// - Every time a pointer is assigned, the entire list of pointers to that
//   object is traversed.  This class is therefore NOT SUITABLE when there
//   will often be more than two or three pointers to a particular object.
// - References are only tracked as long as linked_ptr<> objects are copied.
//   If a linked_ptr<> is converted to a raw pointer and back, BAD THINGS
//   will happen (double deletion).
//
// A good use of this class is storing object references in STL containers.
// You can safely put linked_ptr<> in a vector<>.
// Other uses may not be as good.
//
// Note: If you use an incomplete type with linked_ptr<>, the class
// *containing* linked_ptr<> must have a constructor and destructor (even
// if they do nothing!).
//
// Bill Gibbons suggested we use something like this.
//
// Thread Safety:
//   Unlike other linked_ptr implementations, in this implementation
//   a linked_ptr object is thread-safe in the sense that:
//     - it's safe to copy linked_ptr objects concurrently,
//     - it's safe to copy *from* a linked_ptr and read its underlying
//       raw pointer (e.g. via get()) concurrently, and
//     - it's safe to write to two linked_ptrs that point to the same
//       shared object concurrently.
// TODO(wan@google.com): rename this to safe_linked_ptr to avoid
// confusion with normal linked_ptr.

#ifndef GTEST_INCLUDE_GTEST_INTERNAL_GTEST_LINKED_PTR_H_
#define GTEST_INCLUDE_GTEST_INTERNAL_GTEST_LINKED_PTR_H_

#include 
#include 

#include "gtest/internal/gtest-port.h"

namespace testing {
namespace internal {

// Protects copying of all linked_ptr objects.
GTEST_API_ GTEST_DECLARE_STATIC_MUTEX_(g_linked_ptr_mutex);

// This is used internally by all instances of linked_ptr<>.  It needs to be
// a non-template class because different types of linked_ptr<> can refer to
// the same object (linked_ptr(obj) vs linked_ptr(obj)).
// So, it needs to be possible for different types of linked_ptr to participate
// in the same circular linked list, so we need a single class type here.
//
// DO NOT USE THIS CLASS DIRECTLY YOURSELF.  Use linked_ptr.
class linked_ptr_internal {
 public:
  // Create a new circle that includes only this instance.
  void join_new() {
    next_ = this;
  }

  // Many linked_ptr operations may change p.link_ for some linked_ptr
  // variable p in the same circle as this object.  Therefore we need
  // to prevent two such operations from occurring concurrently.
  //
  // Note that different types of linked_ptr objects can coexist in a
  // circle (e.g. linked_ptr, linked_ptr, and
  // linked_ptr).  Therefore we must use a single mutex to
  // protect all linked_ptr objects.  This can create serious
  // contention in production code, but is acceptable in a testing
  // framework.

  // Join an existing circle.
  void join(linked_ptr_internal const* ptr)
      GTEST_LOCK_EXCLUDED_(g_linked_ptr_mutex) {
    MutexLock lock(&g_linked_ptr_mutex);

    linked_ptr_internal const* p = ptr;
    while (p->next_ != ptr) {
      assert(p->next_ != this &&
             "Trying to join() a linked ring we are already in. "
             "Is GMock thread safety enabled?");
      p = p->next_;
    }
    p->next_ = this;
    next_ = ptr;
  }

  // Leave whatever circle we're part of.  Returns true if we were the
  // last member of the circle.  Once this is done, you can join() another.
  bool depart()
      GTEST_LOCK_EXCLUDED_(g_linked_ptr_mutex) {
    MutexLock lock(&g_linked_ptr_mutex);

    if (next_ == this) return true;
    linked_ptr_internal const* p = next_;
    while (p->next_ != this) {
      assert(p->next_ != next_ &&
             "Trying to depart() a linked ring we are not in. "
             "Is GMock thread safety enabled?");
      p = p->next_;
    }
    p->next_ = next_;
    return false;
  }

 private:
  mutable linked_ptr_internal const* next_;
};

template 
class linked_ptr {
 public:
  typedef T element_type;

  // Take over ownership of a raw pointer.  This should happen as soon as
  // possible after the object is created.
  explicit linked_ptr(T* ptr = NULL) { capture(ptr); }
  ~linked_ptr() { depart(); }

  // Copy an existing linked_ptr<>, adding ourselves to the list of references.
  template  linked_ptr(linked_ptr const& ptr) { copy(&ptr); }
  linked_ptr(linked_ptr const& ptr) {  // NOLINT
    assert(&ptr != this);
    copy(&ptr);
  }

  // Assignment releases the old value and acquires the new.
  template  linked_ptr& operator=(linked_ptr const& ptr) {
    depart();
    copy(&ptr);
    return *this;
  }

  linked_ptr& operator=(linked_ptr const& ptr) {
    if (&ptr != this) {
      depart();
      copy(&ptr);
    }
    return *this;
  }

  // Smart pointer members.
  void reset(T* ptr = NULL) {
    depart();
    capture(ptr);
  }
  T* get() const { return value_; }
  T* operator->() const { return value_; }
  T& operator*() const { return *value_; }

  bool operator==(T* p) const { return value_ == p; }
  bool operator!=(T* p) const { return value_ != p; }
  template 
  bool operator==(linked_ptr const& ptr) const {
    return value_ == ptr.get();
  }
  template 
  bool operator!=(linked_ptr const& ptr) const {
    return value_ != ptr.get();
  }

 private:
  template 
  friend class linked_ptr;

  T* value_;
  linked_ptr_internal link_;

  void depart() {
    if (link_.depart()) delete value_;
  }

  void capture(T* ptr) {
    value_ = ptr;
    link_.join_new();
  }

  template  void copy(linked_ptr const* ptr) {
    value_ = ptr->get();
    if (value_)
      link_.join(&ptr->link_);
    else
      link_.join_new();
  }
};

template inline
bool operator==(T* ptr, const linked_ptr& x) {
  return ptr == x.get();
}

template inline
bool operator!=(T* ptr, const linked_ptr& x) {
  return ptr != x.get();
}

// A function to convert T* into linked_ptr
// Doing e.g. make_linked_ptr(new FooBarBaz(arg)) is a shorter notation
// for linked_ptr >(new FooBarBaz(arg))
template 
linked_ptr make_linked_ptr(T* ptr) {
  return linked_ptr(ptr);
}

}  // namespace internal
}  // namespace testing

#endif  // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_LINKED_PTR_H_
node-v4.8.2/deps/gtest/include/gtest/internal/gtest-param-util-generated.h000644 000766 000024 00000567207 13070706730 026746 0ustar00iojsstaff000000 000000 // This file was GENERATED by command:
//     pump.py gtest-param-util-generated.h.pump
// DO NOT EDIT BY HAND!!!

// Copyright 2008 Google Inc.
// All Rights Reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Author: vladl@google.com (Vlad Losev)

// Type and function utilities for implementing parameterized tests.
// This file is generated by a SCRIPT.  DO NOT EDIT BY HAND!
//
// Currently Google Test supports at most 50 arguments in Values,
// and at most 10 arguments in Combine. Please contact
// googletestframework@googlegroups.com if you need more.
// Please note that the number of arguments to Combine is limited
// by the maximum arity of the implementation of tuple which is
// currently set at 10.

#ifndef GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PARAM_UTIL_GENERATED_H_
#define GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PARAM_UTIL_GENERATED_H_

// scripts/fuse_gtest.py depends on gtest's own header being #included
// *unconditionally*.  Therefore these #includes cannot be moved
// inside #if GTEST_HAS_PARAM_TEST.
#include "gtest/internal/gtest-param-util.h"
#include "gtest/internal/gtest-port.h"

#if GTEST_HAS_PARAM_TEST

namespace testing {

// Forward declarations of ValuesIn(), which is implemented in
// include/gtest/gtest-param-test.h.
template 
internal::ParamGenerator<
  typename ::testing::internal::IteratorTraits::value_type>
ValuesIn(ForwardIterator begin, ForwardIterator end);

template 
internal::ParamGenerator ValuesIn(const T (&array)[N]);

template 
internal::ParamGenerator ValuesIn(
    const Container& container);

namespace internal {

// Used in the Values() function to provide polymorphic capabilities.
template 
class ValueArray1 {
 public:
  explicit ValueArray1(T1 v1) : v1_(v1) {}

  template 
  operator ParamGenerator() const { return ValuesIn(&v1_, &v1_ + 1); }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray1& other);

  const T1 v1_;
};

template 
class ValueArray2 {
 public:
  ValueArray2(T1 v1, T2 v2) : v1_(v1), v2_(v2) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray2& other);

  const T1 v1_;
  const T2 v2_;
};

template 
class ValueArray3 {
 public:
  ValueArray3(T1 v1, T2 v2, T3 v3) : v1_(v1), v2_(v2), v3_(v3) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray3& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
};

template 
class ValueArray4 {
 public:
  ValueArray4(T1 v1, T2 v2, T3 v3, T4 v4) : v1_(v1), v2_(v2), v3_(v3),
      v4_(v4) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray4& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
};

template 
class ValueArray5 {
 public:
  ValueArray5(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5) : v1_(v1), v2_(v2), v3_(v3),
      v4_(v4), v5_(v5) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray5& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
};

template 
class ValueArray6 {
 public:
  ValueArray6(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6) : v1_(v1), v2_(v2),
      v3_(v3), v4_(v4), v5_(v5), v6_(v6) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray6& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
};

template 
class ValueArray7 {
 public:
  ValueArray7(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7) : v1_(v1),
      v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray7& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
};

template 
class ValueArray8 {
 public:
  ValueArray8(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7,
      T8 v8) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7),
      v8_(v8) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray8& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
};

template 
class ValueArray9 {
 public:
  ValueArray9(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8,
      T9 v9) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7),
      v8_(v8), v9_(v9) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray9& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
};

template 
class ValueArray10 {
 public:
  ValueArray10(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7),
      v8_(v8), v9_(v9), v10_(v10) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray10& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
};

template 
class ValueArray11 {
 public:
  ValueArray11(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6),
      v7_(v7), v8_(v8), v9_(v9), v10_(v10), v11_(v11) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray11& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
};

template 
class ValueArray12 {
 public:
  ValueArray12(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5),
      v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray12& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
};

template 
class ValueArray13 {
 public:
  ValueArray13(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13) : v1_(v1), v2_(v2), v3_(v3), v4_(v4),
      v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10), v11_(v11),
      v12_(v12), v13_(v13) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray13& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
};

template 
class ValueArray14 {
 public:
  ValueArray14(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13, T14 v14) : v1_(v1), v2_(v2), v3_(v3),
      v4_(v4), v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10),
      v11_(v11), v12_(v12), v13_(v13), v14_(v14) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_), static_cast(v14_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray14& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
  const T14 v14_;
};

template 
class ValueArray15 {
 public:
  ValueArray15(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15) : v1_(v1), v2_(v2),
      v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10),
      v11_(v11), v12_(v12), v13_(v13), v14_(v14), v15_(v15) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_), static_cast(v14_),
        static_cast(v15_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray15& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
  const T14 v14_;
  const T15 v15_;
};

template 
class ValueArray16 {
 public:
  ValueArray16(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16) : v1_(v1),
      v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9),
      v10_(v10), v11_(v11), v12_(v12), v13_(v13), v14_(v14), v15_(v15),
      v16_(v16) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_), static_cast(v14_),
        static_cast(v15_), static_cast(v16_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray16& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
  const T14 v14_;
  const T15 v15_;
  const T16 v16_;
};

template 
class ValueArray17 {
 public:
  ValueArray17(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16,
      T17 v17) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7),
      v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12), v13_(v13), v14_(v14),
      v15_(v15), v16_(v16), v17_(v17) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_), static_cast(v14_),
        static_cast(v15_), static_cast(v16_), static_cast(v17_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray17& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
  const T14 v14_;
  const T15 v15_;
  const T16 v16_;
  const T17 v17_;
};

template 
class ValueArray18 {
 public:
  ValueArray18(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
      T18 v18) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7),
      v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12), v13_(v13), v14_(v14),
      v15_(v15), v16_(v16), v17_(v17), v18_(v18) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_), static_cast(v14_),
        static_cast(v15_), static_cast(v16_), static_cast(v17_),
        static_cast(v18_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray18& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
  const T14 v14_;
  const T15 v15_;
  const T16 v16_;
  const T17 v17_;
  const T18 v18_;
};

template 
class ValueArray19 {
 public:
  ValueArray19(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
      T18 v18, T19 v19) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6),
      v7_(v7), v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12), v13_(v13),
      v14_(v14), v15_(v15), v16_(v16), v17_(v17), v18_(v18), v19_(v19) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_), static_cast(v14_),
        static_cast(v15_), static_cast(v16_), static_cast(v17_),
        static_cast(v18_), static_cast(v19_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray19& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
  const T14 v14_;
  const T15 v15_;
  const T16 v16_;
  const T17 v17_;
  const T18 v18_;
  const T19 v19_;
};

template 
class ValueArray20 {
 public:
  ValueArray20(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
      T18 v18, T19 v19, T20 v20) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5),
      v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12),
      v13_(v13), v14_(v14), v15_(v15), v16_(v16), v17_(v17), v18_(v18),
      v19_(v19), v20_(v20) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_), static_cast(v14_),
        static_cast(v15_), static_cast(v16_), static_cast(v17_),
        static_cast(v18_), static_cast(v19_), static_cast(v20_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray20& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
  const T14 v14_;
  const T15 v15_;
  const T16 v16_;
  const T17 v17_;
  const T18 v18_;
  const T19 v19_;
  const T20 v20_;
};

template 
class ValueArray21 {
 public:
  ValueArray21(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
      T18 v18, T19 v19, T20 v20, T21 v21) : v1_(v1), v2_(v2), v3_(v3), v4_(v4),
      v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10), v11_(v11),
      v12_(v12), v13_(v13), v14_(v14), v15_(v15), v16_(v16), v17_(v17),
      v18_(v18), v19_(v19), v20_(v20), v21_(v21) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_), static_cast(v14_),
        static_cast(v15_), static_cast(v16_), static_cast(v17_),
        static_cast(v18_), static_cast(v19_), static_cast(v20_),
        static_cast(v21_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray21& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
  const T14 v14_;
  const T15 v15_;
  const T16 v16_;
  const T17 v17_;
  const T18 v18_;
  const T19 v19_;
  const T20 v20_;
  const T21 v21_;
};

template 
class ValueArray22 {
 public:
  ValueArray22(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
      T18 v18, T19 v19, T20 v20, T21 v21, T22 v22) : v1_(v1), v2_(v2), v3_(v3),
      v4_(v4), v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10),
      v11_(v11), v12_(v12), v13_(v13), v14_(v14), v15_(v15), v16_(v16),
      v17_(v17), v18_(v18), v19_(v19), v20_(v20), v21_(v21), v22_(v22) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_), static_cast(v14_),
        static_cast(v15_), static_cast(v16_), static_cast(v17_),
        static_cast(v18_), static_cast(v19_), static_cast(v20_),
        static_cast(v21_), static_cast(v22_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray22& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
  const T14 v14_;
  const T15 v15_;
  const T16 v16_;
  const T17 v17_;
  const T18 v18_;
  const T19 v19_;
  const T20 v20_;
  const T21 v21_;
  const T22 v22_;
};

template 
class ValueArray23 {
 public:
  ValueArray23(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
      T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23) : v1_(v1), v2_(v2),
      v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10),
      v11_(v11), v12_(v12), v13_(v13), v14_(v14), v15_(v15), v16_(v16),
      v17_(v17), v18_(v18), v19_(v19), v20_(v20), v21_(v21), v22_(v22),
      v23_(v23) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_), static_cast(v14_),
        static_cast(v15_), static_cast(v16_), static_cast(v17_),
        static_cast(v18_), static_cast(v19_), static_cast(v20_),
        static_cast(v21_), static_cast(v22_), static_cast(v23_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray23& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
  const T14 v14_;
  const T15 v15_;
  const T16 v16_;
  const T17 v17_;
  const T18 v18_;
  const T19 v19_;
  const T20 v20_;
  const T21 v21_;
  const T22 v22_;
  const T23 v23_;
};

template 
class ValueArray24 {
 public:
  ValueArray24(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
      T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24) : v1_(v1),
      v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9),
      v10_(v10), v11_(v11), v12_(v12), v13_(v13), v14_(v14), v15_(v15),
      v16_(v16), v17_(v17), v18_(v18), v19_(v19), v20_(v20), v21_(v21),
      v22_(v22), v23_(v23), v24_(v24) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_), static_cast(v14_),
        static_cast(v15_), static_cast(v16_), static_cast(v17_),
        static_cast(v18_), static_cast(v19_), static_cast(v20_),
        static_cast(v21_), static_cast(v22_), static_cast(v23_),
        static_cast(v24_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray24& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
  const T14 v14_;
  const T15 v15_;
  const T16 v16_;
  const T17 v17_;
  const T18 v18_;
  const T19 v19_;
  const T20 v20_;
  const T21 v21_;
  const T22 v22_;
  const T23 v23_;
  const T24 v24_;
};

template 
class ValueArray25 {
 public:
  ValueArray25(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
      T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24,
      T25 v25) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7),
      v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12), v13_(v13), v14_(v14),
      v15_(v15), v16_(v16), v17_(v17), v18_(v18), v19_(v19), v20_(v20),
      v21_(v21), v22_(v22), v23_(v23), v24_(v24), v25_(v25) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_), static_cast(v14_),
        static_cast(v15_), static_cast(v16_), static_cast(v17_),
        static_cast(v18_), static_cast(v19_), static_cast(v20_),
        static_cast(v21_), static_cast(v22_), static_cast(v23_),
        static_cast(v24_), static_cast(v25_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray25& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
  const T14 v14_;
  const T15 v15_;
  const T16 v16_;
  const T17 v17_;
  const T18 v18_;
  const T19 v19_;
  const T20 v20_;
  const T21 v21_;
  const T22 v22_;
  const T23 v23_;
  const T24 v24_;
  const T25 v25_;
};

template 
class ValueArray26 {
 public:
  ValueArray26(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
      T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25,
      T26 v26) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7),
      v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12), v13_(v13), v14_(v14),
      v15_(v15), v16_(v16), v17_(v17), v18_(v18), v19_(v19), v20_(v20),
      v21_(v21), v22_(v22), v23_(v23), v24_(v24), v25_(v25), v26_(v26) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_), static_cast(v14_),
        static_cast(v15_), static_cast(v16_), static_cast(v17_),
        static_cast(v18_), static_cast(v19_), static_cast(v20_),
        static_cast(v21_), static_cast(v22_), static_cast(v23_),
        static_cast(v24_), static_cast(v25_), static_cast(v26_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray26& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
  const T14 v14_;
  const T15 v15_;
  const T16 v16_;
  const T17 v17_;
  const T18 v18_;
  const T19 v19_;
  const T20 v20_;
  const T21 v21_;
  const T22 v22_;
  const T23 v23_;
  const T24 v24_;
  const T25 v25_;
  const T26 v26_;
};

template 
class ValueArray27 {
 public:
  ValueArray27(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
      T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25,
      T26 v26, T27 v27) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6),
      v7_(v7), v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12), v13_(v13),
      v14_(v14), v15_(v15), v16_(v16), v17_(v17), v18_(v18), v19_(v19),
      v20_(v20), v21_(v21), v22_(v22), v23_(v23), v24_(v24), v25_(v25),
      v26_(v26), v27_(v27) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_), static_cast(v14_),
        static_cast(v15_), static_cast(v16_), static_cast(v17_),
        static_cast(v18_), static_cast(v19_), static_cast(v20_),
        static_cast(v21_), static_cast(v22_), static_cast(v23_),
        static_cast(v24_), static_cast(v25_), static_cast(v26_),
        static_cast(v27_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray27& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
  const T14 v14_;
  const T15 v15_;
  const T16 v16_;
  const T17 v17_;
  const T18 v18_;
  const T19 v19_;
  const T20 v20_;
  const T21 v21_;
  const T22 v22_;
  const T23 v23_;
  const T24 v24_;
  const T25 v25_;
  const T26 v26_;
  const T27 v27_;
};

template 
class ValueArray28 {
 public:
  ValueArray28(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
      T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25,
      T26 v26, T27 v27, T28 v28) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5),
      v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12),
      v13_(v13), v14_(v14), v15_(v15), v16_(v16), v17_(v17), v18_(v18),
      v19_(v19), v20_(v20), v21_(v21), v22_(v22), v23_(v23), v24_(v24),
      v25_(v25), v26_(v26), v27_(v27), v28_(v28) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_), static_cast(v14_),
        static_cast(v15_), static_cast(v16_), static_cast(v17_),
        static_cast(v18_), static_cast(v19_), static_cast(v20_),
        static_cast(v21_), static_cast(v22_), static_cast(v23_),
        static_cast(v24_), static_cast(v25_), static_cast(v26_),
        static_cast(v27_), static_cast(v28_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray28& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
  const T14 v14_;
  const T15 v15_;
  const T16 v16_;
  const T17 v17_;
  const T18 v18_;
  const T19 v19_;
  const T20 v20_;
  const T21 v21_;
  const T22 v22_;
  const T23 v23_;
  const T24 v24_;
  const T25 v25_;
  const T26 v26_;
  const T27 v27_;
  const T28 v28_;
};

template 
class ValueArray29 {
 public:
  ValueArray29(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
      T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25,
      T26 v26, T27 v27, T28 v28, T29 v29) : v1_(v1), v2_(v2), v3_(v3), v4_(v4),
      v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10), v11_(v11),
      v12_(v12), v13_(v13), v14_(v14), v15_(v15), v16_(v16), v17_(v17),
      v18_(v18), v19_(v19), v20_(v20), v21_(v21), v22_(v22), v23_(v23),
      v24_(v24), v25_(v25), v26_(v26), v27_(v27), v28_(v28), v29_(v29) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_), static_cast(v14_),
        static_cast(v15_), static_cast(v16_), static_cast(v17_),
        static_cast(v18_), static_cast(v19_), static_cast(v20_),
        static_cast(v21_), static_cast(v22_), static_cast(v23_),
        static_cast(v24_), static_cast(v25_), static_cast(v26_),
        static_cast(v27_), static_cast(v28_), static_cast(v29_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray29& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
  const T14 v14_;
  const T15 v15_;
  const T16 v16_;
  const T17 v17_;
  const T18 v18_;
  const T19 v19_;
  const T20 v20_;
  const T21 v21_;
  const T22 v22_;
  const T23 v23_;
  const T24 v24_;
  const T25 v25_;
  const T26 v26_;
  const T27 v27_;
  const T28 v28_;
  const T29 v29_;
};

template 
class ValueArray30 {
 public:
  ValueArray30(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
      T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25,
      T26 v26, T27 v27, T28 v28, T29 v29, T30 v30) : v1_(v1), v2_(v2), v3_(v3),
      v4_(v4), v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10),
      v11_(v11), v12_(v12), v13_(v13), v14_(v14), v15_(v15), v16_(v16),
      v17_(v17), v18_(v18), v19_(v19), v20_(v20), v21_(v21), v22_(v22),
      v23_(v23), v24_(v24), v25_(v25), v26_(v26), v27_(v27), v28_(v28),
      v29_(v29), v30_(v30) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_), static_cast(v14_),
        static_cast(v15_), static_cast(v16_), static_cast(v17_),
        static_cast(v18_), static_cast(v19_), static_cast(v20_),
        static_cast(v21_), static_cast(v22_), static_cast(v23_),
        static_cast(v24_), static_cast(v25_), static_cast(v26_),
        static_cast(v27_), static_cast(v28_), static_cast(v29_),
        static_cast(v30_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray30& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
  const T14 v14_;
  const T15 v15_;
  const T16 v16_;
  const T17 v17_;
  const T18 v18_;
  const T19 v19_;
  const T20 v20_;
  const T21 v21_;
  const T22 v22_;
  const T23 v23_;
  const T24 v24_;
  const T25 v25_;
  const T26 v26_;
  const T27 v27_;
  const T28 v28_;
  const T29 v29_;
  const T30 v30_;
};

template 
class ValueArray31 {
 public:
  ValueArray31(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
      T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25,
      T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31) : v1_(v1), v2_(v2),
      v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10),
      v11_(v11), v12_(v12), v13_(v13), v14_(v14), v15_(v15), v16_(v16),
      v17_(v17), v18_(v18), v19_(v19), v20_(v20), v21_(v21), v22_(v22),
      v23_(v23), v24_(v24), v25_(v25), v26_(v26), v27_(v27), v28_(v28),
      v29_(v29), v30_(v30), v31_(v31) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_), static_cast(v14_),
        static_cast(v15_), static_cast(v16_), static_cast(v17_),
        static_cast(v18_), static_cast(v19_), static_cast(v20_),
        static_cast(v21_), static_cast(v22_), static_cast(v23_),
        static_cast(v24_), static_cast(v25_), static_cast(v26_),
        static_cast(v27_), static_cast(v28_), static_cast(v29_),
        static_cast(v30_), static_cast(v31_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray31& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
  const T14 v14_;
  const T15 v15_;
  const T16 v16_;
  const T17 v17_;
  const T18 v18_;
  const T19 v19_;
  const T20 v20_;
  const T21 v21_;
  const T22 v22_;
  const T23 v23_;
  const T24 v24_;
  const T25 v25_;
  const T26 v26_;
  const T27 v27_;
  const T28 v28_;
  const T29 v29_;
  const T30 v30_;
  const T31 v31_;
};

template 
class ValueArray32 {
 public:
  ValueArray32(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
      T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25,
      T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32) : v1_(v1),
      v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9),
      v10_(v10), v11_(v11), v12_(v12), v13_(v13), v14_(v14), v15_(v15),
      v16_(v16), v17_(v17), v18_(v18), v19_(v19), v20_(v20), v21_(v21),
      v22_(v22), v23_(v23), v24_(v24), v25_(v25), v26_(v26), v27_(v27),
      v28_(v28), v29_(v29), v30_(v30), v31_(v31), v32_(v32) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_), static_cast(v14_),
        static_cast(v15_), static_cast(v16_), static_cast(v17_),
        static_cast(v18_), static_cast(v19_), static_cast(v20_),
        static_cast(v21_), static_cast(v22_), static_cast(v23_),
        static_cast(v24_), static_cast(v25_), static_cast(v26_),
        static_cast(v27_), static_cast(v28_), static_cast(v29_),
        static_cast(v30_), static_cast(v31_), static_cast(v32_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray32& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
  const T14 v14_;
  const T15 v15_;
  const T16 v16_;
  const T17 v17_;
  const T18 v18_;
  const T19 v19_;
  const T20 v20_;
  const T21 v21_;
  const T22 v22_;
  const T23 v23_;
  const T24 v24_;
  const T25 v25_;
  const T26 v26_;
  const T27 v27_;
  const T28 v28_;
  const T29 v29_;
  const T30 v30_;
  const T31 v31_;
  const T32 v32_;
};

template 
class ValueArray33 {
 public:
  ValueArray33(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
      T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25,
      T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32,
      T33 v33) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7),
      v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12), v13_(v13), v14_(v14),
      v15_(v15), v16_(v16), v17_(v17), v18_(v18), v19_(v19), v20_(v20),
      v21_(v21), v22_(v22), v23_(v23), v24_(v24), v25_(v25), v26_(v26),
      v27_(v27), v28_(v28), v29_(v29), v30_(v30), v31_(v31), v32_(v32),
      v33_(v33) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_), static_cast(v14_),
        static_cast(v15_), static_cast(v16_), static_cast(v17_),
        static_cast(v18_), static_cast(v19_), static_cast(v20_),
        static_cast(v21_), static_cast(v22_), static_cast(v23_),
        static_cast(v24_), static_cast(v25_), static_cast(v26_),
        static_cast(v27_), static_cast(v28_), static_cast(v29_),
        static_cast(v30_), static_cast(v31_), static_cast(v32_),
        static_cast(v33_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray33& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
  const T14 v14_;
  const T15 v15_;
  const T16 v16_;
  const T17 v17_;
  const T18 v18_;
  const T19 v19_;
  const T20 v20_;
  const T21 v21_;
  const T22 v22_;
  const T23 v23_;
  const T24 v24_;
  const T25 v25_;
  const T26 v26_;
  const T27 v27_;
  const T28 v28_;
  const T29 v29_;
  const T30 v30_;
  const T31 v31_;
  const T32 v32_;
  const T33 v33_;
};

template 
class ValueArray34 {
 public:
  ValueArray34(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
      T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25,
      T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33,
      T34 v34) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7),
      v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12), v13_(v13), v14_(v14),
      v15_(v15), v16_(v16), v17_(v17), v18_(v18), v19_(v19), v20_(v20),
      v21_(v21), v22_(v22), v23_(v23), v24_(v24), v25_(v25), v26_(v26),
      v27_(v27), v28_(v28), v29_(v29), v30_(v30), v31_(v31), v32_(v32),
      v33_(v33), v34_(v34) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_), static_cast(v14_),
        static_cast(v15_), static_cast(v16_), static_cast(v17_),
        static_cast(v18_), static_cast(v19_), static_cast(v20_),
        static_cast(v21_), static_cast(v22_), static_cast(v23_),
        static_cast(v24_), static_cast(v25_), static_cast(v26_),
        static_cast(v27_), static_cast(v28_), static_cast(v29_),
        static_cast(v30_), static_cast(v31_), static_cast(v32_),
        static_cast(v33_), static_cast(v34_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray34& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
  const T14 v14_;
  const T15 v15_;
  const T16 v16_;
  const T17 v17_;
  const T18 v18_;
  const T19 v19_;
  const T20 v20_;
  const T21 v21_;
  const T22 v22_;
  const T23 v23_;
  const T24 v24_;
  const T25 v25_;
  const T26 v26_;
  const T27 v27_;
  const T28 v28_;
  const T29 v29_;
  const T30 v30_;
  const T31 v31_;
  const T32 v32_;
  const T33 v33_;
  const T34 v34_;
};

template 
class ValueArray35 {
 public:
  ValueArray35(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
      T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25,
      T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33,
      T34 v34, T35 v35) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6),
      v7_(v7), v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12), v13_(v13),
      v14_(v14), v15_(v15), v16_(v16), v17_(v17), v18_(v18), v19_(v19),
      v20_(v20), v21_(v21), v22_(v22), v23_(v23), v24_(v24), v25_(v25),
      v26_(v26), v27_(v27), v28_(v28), v29_(v29), v30_(v30), v31_(v31),
      v32_(v32), v33_(v33), v34_(v34), v35_(v35) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_), static_cast(v14_),
        static_cast(v15_), static_cast(v16_), static_cast(v17_),
        static_cast(v18_), static_cast(v19_), static_cast(v20_),
        static_cast(v21_), static_cast(v22_), static_cast(v23_),
        static_cast(v24_), static_cast(v25_), static_cast(v26_),
        static_cast(v27_), static_cast(v28_), static_cast(v29_),
        static_cast(v30_), static_cast(v31_), static_cast(v32_),
        static_cast(v33_), static_cast(v34_), static_cast(v35_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray35& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
  const T14 v14_;
  const T15 v15_;
  const T16 v16_;
  const T17 v17_;
  const T18 v18_;
  const T19 v19_;
  const T20 v20_;
  const T21 v21_;
  const T22 v22_;
  const T23 v23_;
  const T24 v24_;
  const T25 v25_;
  const T26 v26_;
  const T27 v27_;
  const T28 v28_;
  const T29 v29_;
  const T30 v30_;
  const T31 v31_;
  const T32 v32_;
  const T33 v33_;
  const T34 v34_;
  const T35 v35_;
};

template 
class ValueArray36 {
 public:
  ValueArray36(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
      T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25,
      T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33,
      T34 v34, T35 v35, T36 v36) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5),
      v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12),
      v13_(v13), v14_(v14), v15_(v15), v16_(v16), v17_(v17), v18_(v18),
      v19_(v19), v20_(v20), v21_(v21), v22_(v22), v23_(v23), v24_(v24),
      v25_(v25), v26_(v26), v27_(v27), v28_(v28), v29_(v29), v30_(v30),
      v31_(v31), v32_(v32), v33_(v33), v34_(v34), v35_(v35), v36_(v36) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_), static_cast(v14_),
        static_cast(v15_), static_cast(v16_), static_cast(v17_),
        static_cast(v18_), static_cast(v19_), static_cast(v20_),
        static_cast(v21_), static_cast(v22_), static_cast(v23_),
        static_cast(v24_), static_cast(v25_), static_cast(v26_),
        static_cast(v27_), static_cast(v28_), static_cast(v29_),
        static_cast(v30_), static_cast(v31_), static_cast(v32_),
        static_cast(v33_), static_cast(v34_), static_cast(v35_),
        static_cast(v36_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray36& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
  const T14 v14_;
  const T15 v15_;
  const T16 v16_;
  const T17 v17_;
  const T18 v18_;
  const T19 v19_;
  const T20 v20_;
  const T21 v21_;
  const T22 v22_;
  const T23 v23_;
  const T24 v24_;
  const T25 v25_;
  const T26 v26_;
  const T27 v27_;
  const T28 v28_;
  const T29 v29_;
  const T30 v30_;
  const T31 v31_;
  const T32 v32_;
  const T33 v33_;
  const T34 v34_;
  const T35 v35_;
  const T36 v36_;
};

template 
class ValueArray37 {
 public:
  ValueArray37(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
      T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25,
      T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33,
      T34 v34, T35 v35, T36 v36, T37 v37) : v1_(v1), v2_(v2), v3_(v3), v4_(v4),
      v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10), v11_(v11),
      v12_(v12), v13_(v13), v14_(v14), v15_(v15), v16_(v16), v17_(v17),
      v18_(v18), v19_(v19), v20_(v20), v21_(v21), v22_(v22), v23_(v23),
      v24_(v24), v25_(v25), v26_(v26), v27_(v27), v28_(v28), v29_(v29),
      v30_(v30), v31_(v31), v32_(v32), v33_(v33), v34_(v34), v35_(v35),
      v36_(v36), v37_(v37) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_), static_cast(v14_),
        static_cast(v15_), static_cast(v16_), static_cast(v17_),
        static_cast(v18_), static_cast(v19_), static_cast(v20_),
        static_cast(v21_), static_cast(v22_), static_cast(v23_),
        static_cast(v24_), static_cast(v25_), static_cast(v26_),
        static_cast(v27_), static_cast(v28_), static_cast(v29_),
        static_cast(v30_), static_cast(v31_), static_cast(v32_),
        static_cast(v33_), static_cast(v34_), static_cast(v35_),
        static_cast(v36_), static_cast(v37_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray37& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
  const T14 v14_;
  const T15 v15_;
  const T16 v16_;
  const T17 v17_;
  const T18 v18_;
  const T19 v19_;
  const T20 v20_;
  const T21 v21_;
  const T22 v22_;
  const T23 v23_;
  const T24 v24_;
  const T25 v25_;
  const T26 v26_;
  const T27 v27_;
  const T28 v28_;
  const T29 v29_;
  const T30 v30_;
  const T31 v31_;
  const T32 v32_;
  const T33 v33_;
  const T34 v34_;
  const T35 v35_;
  const T36 v36_;
  const T37 v37_;
};

template 
class ValueArray38 {
 public:
  ValueArray38(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
      T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25,
      T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33,
      T34 v34, T35 v35, T36 v36, T37 v37, T38 v38) : v1_(v1), v2_(v2), v3_(v3),
      v4_(v4), v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10),
      v11_(v11), v12_(v12), v13_(v13), v14_(v14), v15_(v15), v16_(v16),
      v17_(v17), v18_(v18), v19_(v19), v20_(v20), v21_(v21), v22_(v22),
      v23_(v23), v24_(v24), v25_(v25), v26_(v26), v27_(v27), v28_(v28),
      v29_(v29), v30_(v30), v31_(v31), v32_(v32), v33_(v33), v34_(v34),
      v35_(v35), v36_(v36), v37_(v37), v38_(v38) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_), static_cast(v14_),
        static_cast(v15_), static_cast(v16_), static_cast(v17_),
        static_cast(v18_), static_cast(v19_), static_cast(v20_),
        static_cast(v21_), static_cast(v22_), static_cast(v23_),
        static_cast(v24_), static_cast(v25_), static_cast(v26_),
        static_cast(v27_), static_cast(v28_), static_cast(v29_),
        static_cast(v30_), static_cast(v31_), static_cast(v32_),
        static_cast(v33_), static_cast(v34_), static_cast(v35_),
        static_cast(v36_), static_cast(v37_), static_cast(v38_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray38& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
  const T14 v14_;
  const T15 v15_;
  const T16 v16_;
  const T17 v17_;
  const T18 v18_;
  const T19 v19_;
  const T20 v20_;
  const T21 v21_;
  const T22 v22_;
  const T23 v23_;
  const T24 v24_;
  const T25 v25_;
  const T26 v26_;
  const T27 v27_;
  const T28 v28_;
  const T29 v29_;
  const T30 v30_;
  const T31 v31_;
  const T32 v32_;
  const T33 v33_;
  const T34 v34_;
  const T35 v35_;
  const T36 v36_;
  const T37 v37_;
  const T38 v38_;
};

template 
class ValueArray39 {
 public:
  ValueArray39(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
      T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25,
      T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33,
      T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39) : v1_(v1), v2_(v2),
      v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10),
      v11_(v11), v12_(v12), v13_(v13), v14_(v14), v15_(v15), v16_(v16),
      v17_(v17), v18_(v18), v19_(v19), v20_(v20), v21_(v21), v22_(v22),
      v23_(v23), v24_(v24), v25_(v25), v26_(v26), v27_(v27), v28_(v28),
      v29_(v29), v30_(v30), v31_(v31), v32_(v32), v33_(v33), v34_(v34),
      v35_(v35), v36_(v36), v37_(v37), v38_(v38), v39_(v39) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_), static_cast(v14_),
        static_cast(v15_), static_cast(v16_), static_cast(v17_),
        static_cast(v18_), static_cast(v19_), static_cast(v20_),
        static_cast(v21_), static_cast(v22_), static_cast(v23_),
        static_cast(v24_), static_cast(v25_), static_cast(v26_),
        static_cast(v27_), static_cast(v28_), static_cast(v29_),
        static_cast(v30_), static_cast(v31_), static_cast(v32_),
        static_cast(v33_), static_cast(v34_), static_cast(v35_),
        static_cast(v36_), static_cast(v37_), static_cast(v38_),
        static_cast(v39_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray39& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
  const T14 v14_;
  const T15 v15_;
  const T16 v16_;
  const T17 v17_;
  const T18 v18_;
  const T19 v19_;
  const T20 v20_;
  const T21 v21_;
  const T22 v22_;
  const T23 v23_;
  const T24 v24_;
  const T25 v25_;
  const T26 v26_;
  const T27 v27_;
  const T28 v28_;
  const T29 v29_;
  const T30 v30_;
  const T31 v31_;
  const T32 v32_;
  const T33 v33_;
  const T34 v34_;
  const T35 v35_;
  const T36 v36_;
  const T37 v37_;
  const T38 v38_;
  const T39 v39_;
};

template 
class ValueArray40 {
 public:
  ValueArray40(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
      T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25,
      T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33,
      T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39, T40 v40) : v1_(v1),
      v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9),
      v10_(v10), v11_(v11), v12_(v12), v13_(v13), v14_(v14), v15_(v15),
      v16_(v16), v17_(v17), v18_(v18), v19_(v19), v20_(v20), v21_(v21),
      v22_(v22), v23_(v23), v24_(v24), v25_(v25), v26_(v26), v27_(v27),
      v28_(v28), v29_(v29), v30_(v30), v31_(v31), v32_(v32), v33_(v33),
      v34_(v34), v35_(v35), v36_(v36), v37_(v37), v38_(v38), v39_(v39),
      v40_(v40) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_), static_cast(v14_),
        static_cast(v15_), static_cast(v16_), static_cast(v17_),
        static_cast(v18_), static_cast(v19_), static_cast(v20_),
        static_cast(v21_), static_cast(v22_), static_cast(v23_),
        static_cast(v24_), static_cast(v25_), static_cast(v26_),
        static_cast(v27_), static_cast(v28_), static_cast(v29_),
        static_cast(v30_), static_cast(v31_), static_cast(v32_),
        static_cast(v33_), static_cast(v34_), static_cast(v35_),
        static_cast(v36_), static_cast(v37_), static_cast(v38_),
        static_cast(v39_), static_cast(v40_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray40& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
  const T14 v14_;
  const T15 v15_;
  const T16 v16_;
  const T17 v17_;
  const T18 v18_;
  const T19 v19_;
  const T20 v20_;
  const T21 v21_;
  const T22 v22_;
  const T23 v23_;
  const T24 v24_;
  const T25 v25_;
  const T26 v26_;
  const T27 v27_;
  const T28 v28_;
  const T29 v29_;
  const T30 v30_;
  const T31 v31_;
  const T32 v32_;
  const T33 v33_;
  const T34 v34_;
  const T35 v35_;
  const T36 v36_;
  const T37 v37_;
  const T38 v38_;
  const T39 v39_;
  const T40 v40_;
};

template 
class ValueArray41 {
 public:
  ValueArray41(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
      T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25,
      T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33,
      T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39, T40 v40,
      T41 v41) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7),
      v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12), v13_(v13), v14_(v14),
      v15_(v15), v16_(v16), v17_(v17), v18_(v18), v19_(v19), v20_(v20),
      v21_(v21), v22_(v22), v23_(v23), v24_(v24), v25_(v25), v26_(v26),
      v27_(v27), v28_(v28), v29_(v29), v30_(v30), v31_(v31), v32_(v32),
      v33_(v33), v34_(v34), v35_(v35), v36_(v36), v37_(v37), v38_(v38),
      v39_(v39), v40_(v40), v41_(v41) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_), static_cast(v14_),
        static_cast(v15_), static_cast(v16_), static_cast(v17_),
        static_cast(v18_), static_cast(v19_), static_cast(v20_),
        static_cast(v21_), static_cast(v22_), static_cast(v23_),
        static_cast(v24_), static_cast(v25_), static_cast(v26_),
        static_cast(v27_), static_cast(v28_), static_cast(v29_),
        static_cast(v30_), static_cast(v31_), static_cast(v32_),
        static_cast(v33_), static_cast(v34_), static_cast(v35_),
        static_cast(v36_), static_cast(v37_), static_cast(v38_),
        static_cast(v39_), static_cast(v40_), static_cast(v41_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray41& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
  const T14 v14_;
  const T15 v15_;
  const T16 v16_;
  const T17 v17_;
  const T18 v18_;
  const T19 v19_;
  const T20 v20_;
  const T21 v21_;
  const T22 v22_;
  const T23 v23_;
  const T24 v24_;
  const T25 v25_;
  const T26 v26_;
  const T27 v27_;
  const T28 v28_;
  const T29 v29_;
  const T30 v30_;
  const T31 v31_;
  const T32 v32_;
  const T33 v33_;
  const T34 v34_;
  const T35 v35_;
  const T36 v36_;
  const T37 v37_;
  const T38 v38_;
  const T39 v39_;
  const T40 v40_;
  const T41 v41_;
};

template 
class ValueArray42 {
 public:
  ValueArray42(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
      T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25,
      T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33,
      T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39, T40 v40, T41 v41,
      T42 v42) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7),
      v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12), v13_(v13), v14_(v14),
      v15_(v15), v16_(v16), v17_(v17), v18_(v18), v19_(v19), v20_(v20),
      v21_(v21), v22_(v22), v23_(v23), v24_(v24), v25_(v25), v26_(v26),
      v27_(v27), v28_(v28), v29_(v29), v30_(v30), v31_(v31), v32_(v32),
      v33_(v33), v34_(v34), v35_(v35), v36_(v36), v37_(v37), v38_(v38),
      v39_(v39), v40_(v40), v41_(v41), v42_(v42) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_), static_cast(v14_),
        static_cast(v15_), static_cast(v16_), static_cast(v17_),
        static_cast(v18_), static_cast(v19_), static_cast(v20_),
        static_cast(v21_), static_cast(v22_), static_cast(v23_),
        static_cast(v24_), static_cast(v25_), static_cast(v26_),
        static_cast(v27_), static_cast(v28_), static_cast(v29_),
        static_cast(v30_), static_cast(v31_), static_cast(v32_),
        static_cast(v33_), static_cast(v34_), static_cast(v35_),
        static_cast(v36_), static_cast(v37_), static_cast(v38_),
        static_cast(v39_), static_cast(v40_), static_cast(v41_),
        static_cast(v42_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray42& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
  const T14 v14_;
  const T15 v15_;
  const T16 v16_;
  const T17 v17_;
  const T18 v18_;
  const T19 v19_;
  const T20 v20_;
  const T21 v21_;
  const T22 v22_;
  const T23 v23_;
  const T24 v24_;
  const T25 v25_;
  const T26 v26_;
  const T27 v27_;
  const T28 v28_;
  const T29 v29_;
  const T30 v30_;
  const T31 v31_;
  const T32 v32_;
  const T33 v33_;
  const T34 v34_;
  const T35 v35_;
  const T36 v36_;
  const T37 v37_;
  const T38 v38_;
  const T39 v39_;
  const T40 v40_;
  const T41 v41_;
  const T42 v42_;
};

template 
class ValueArray43 {
 public:
  ValueArray43(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
      T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25,
      T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33,
      T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39, T40 v40, T41 v41,
      T42 v42, T43 v43) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6),
      v7_(v7), v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12), v13_(v13),
      v14_(v14), v15_(v15), v16_(v16), v17_(v17), v18_(v18), v19_(v19),
      v20_(v20), v21_(v21), v22_(v22), v23_(v23), v24_(v24), v25_(v25),
      v26_(v26), v27_(v27), v28_(v28), v29_(v29), v30_(v30), v31_(v31),
      v32_(v32), v33_(v33), v34_(v34), v35_(v35), v36_(v36), v37_(v37),
      v38_(v38), v39_(v39), v40_(v40), v41_(v41), v42_(v42), v43_(v43) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_), static_cast(v14_),
        static_cast(v15_), static_cast(v16_), static_cast(v17_),
        static_cast(v18_), static_cast(v19_), static_cast(v20_),
        static_cast(v21_), static_cast(v22_), static_cast(v23_),
        static_cast(v24_), static_cast(v25_), static_cast(v26_),
        static_cast(v27_), static_cast(v28_), static_cast(v29_),
        static_cast(v30_), static_cast(v31_), static_cast(v32_),
        static_cast(v33_), static_cast(v34_), static_cast(v35_),
        static_cast(v36_), static_cast(v37_), static_cast(v38_),
        static_cast(v39_), static_cast(v40_), static_cast(v41_),
        static_cast(v42_), static_cast(v43_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray43& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
  const T14 v14_;
  const T15 v15_;
  const T16 v16_;
  const T17 v17_;
  const T18 v18_;
  const T19 v19_;
  const T20 v20_;
  const T21 v21_;
  const T22 v22_;
  const T23 v23_;
  const T24 v24_;
  const T25 v25_;
  const T26 v26_;
  const T27 v27_;
  const T28 v28_;
  const T29 v29_;
  const T30 v30_;
  const T31 v31_;
  const T32 v32_;
  const T33 v33_;
  const T34 v34_;
  const T35 v35_;
  const T36 v36_;
  const T37 v37_;
  const T38 v38_;
  const T39 v39_;
  const T40 v40_;
  const T41 v41_;
  const T42 v42_;
  const T43 v43_;
};

template 
class ValueArray44 {
 public:
  ValueArray44(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
      T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25,
      T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33,
      T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39, T40 v40, T41 v41,
      T42 v42, T43 v43, T44 v44) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5),
      v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12),
      v13_(v13), v14_(v14), v15_(v15), v16_(v16), v17_(v17), v18_(v18),
      v19_(v19), v20_(v20), v21_(v21), v22_(v22), v23_(v23), v24_(v24),
      v25_(v25), v26_(v26), v27_(v27), v28_(v28), v29_(v29), v30_(v30),
      v31_(v31), v32_(v32), v33_(v33), v34_(v34), v35_(v35), v36_(v36),
      v37_(v37), v38_(v38), v39_(v39), v40_(v40), v41_(v41), v42_(v42),
      v43_(v43), v44_(v44) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_), static_cast(v14_),
        static_cast(v15_), static_cast(v16_), static_cast(v17_),
        static_cast(v18_), static_cast(v19_), static_cast(v20_),
        static_cast(v21_), static_cast(v22_), static_cast(v23_),
        static_cast(v24_), static_cast(v25_), static_cast(v26_),
        static_cast(v27_), static_cast(v28_), static_cast(v29_),
        static_cast(v30_), static_cast(v31_), static_cast(v32_),
        static_cast(v33_), static_cast(v34_), static_cast(v35_),
        static_cast(v36_), static_cast(v37_), static_cast(v38_),
        static_cast(v39_), static_cast(v40_), static_cast(v41_),
        static_cast(v42_), static_cast(v43_), static_cast(v44_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray44& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
  const T14 v14_;
  const T15 v15_;
  const T16 v16_;
  const T17 v17_;
  const T18 v18_;
  const T19 v19_;
  const T20 v20_;
  const T21 v21_;
  const T22 v22_;
  const T23 v23_;
  const T24 v24_;
  const T25 v25_;
  const T26 v26_;
  const T27 v27_;
  const T28 v28_;
  const T29 v29_;
  const T30 v30_;
  const T31 v31_;
  const T32 v32_;
  const T33 v33_;
  const T34 v34_;
  const T35 v35_;
  const T36 v36_;
  const T37 v37_;
  const T38 v38_;
  const T39 v39_;
  const T40 v40_;
  const T41 v41_;
  const T42 v42_;
  const T43 v43_;
  const T44 v44_;
};

template 
class ValueArray45 {
 public:
  ValueArray45(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
      T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25,
      T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33,
      T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39, T40 v40, T41 v41,
      T42 v42, T43 v43, T44 v44, T45 v45) : v1_(v1), v2_(v2), v3_(v3), v4_(v4),
      v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10), v11_(v11),
      v12_(v12), v13_(v13), v14_(v14), v15_(v15), v16_(v16), v17_(v17),
      v18_(v18), v19_(v19), v20_(v20), v21_(v21), v22_(v22), v23_(v23),
      v24_(v24), v25_(v25), v26_(v26), v27_(v27), v28_(v28), v29_(v29),
      v30_(v30), v31_(v31), v32_(v32), v33_(v33), v34_(v34), v35_(v35),
      v36_(v36), v37_(v37), v38_(v38), v39_(v39), v40_(v40), v41_(v41),
      v42_(v42), v43_(v43), v44_(v44), v45_(v45) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_), static_cast(v14_),
        static_cast(v15_), static_cast(v16_), static_cast(v17_),
        static_cast(v18_), static_cast(v19_), static_cast(v20_),
        static_cast(v21_), static_cast(v22_), static_cast(v23_),
        static_cast(v24_), static_cast(v25_), static_cast(v26_),
        static_cast(v27_), static_cast(v28_), static_cast(v29_),
        static_cast(v30_), static_cast(v31_), static_cast(v32_),
        static_cast(v33_), static_cast(v34_), static_cast(v35_),
        static_cast(v36_), static_cast(v37_), static_cast(v38_),
        static_cast(v39_), static_cast(v40_), static_cast(v41_),
        static_cast(v42_), static_cast(v43_), static_cast(v44_),
        static_cast(v45_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray45& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
  const T14 v14_;
  const T15 v15_;
  const T16 v16_;
  const T17 v17_;
  const T18 v18_;
  const T19 v19_;
  const T20 v20_;
  const T21 v21_;
  const T22 v22_;
  const T23 v23_;
  const T24 v24_;
  const T25 v25_;
  const T26 v26_;
  const T27 v27_;
  const T28 v28_;
  const T29 v29_;
  const T30 v30_;
  const T31 v31_;
  const T32 v32_;
  const T33 v33_;
  const T34 v34_;
  const T35 v35_;
  const T36 v36_;
  const T37 v37_;
  const T38 v38_;
  const T39 v39_;
  const T40 v40_;
  const T41 v41_;
  const T42 v42_;
  const T43 v43_;
  const T44 v44_;
  const T45 v45_;
};

template 
class ValueArray46 {
 public:
  ValueArray46(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
      T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25,
      T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33,
      T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39, T40 v40, T41 v41,
      T42 v42, T43 v43, T44 v44, T45 v45, T46 v46) : v1_(v1), v2_(v2), v3_(v3),
      v4_(v4), v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10),
      v11_(v11), v12_(v12), v13_(v13), v14_(v14), v15_(v15), v16_(v16),
      v17_(v17), v18_(v18), v19_(v19), v20_(v20), v21_(v21), v22_(v22),
      v23_(v23), v24_(v24), v25_(v25), v26_(v26), v27_(v27), v28_(v28),
      v29_(v29), v30_(v30), v31_(v31), v32_(v32), v33_(v33), v34_(v34),
      v35_(v35), v36_(v36), v37_(v37), v38_(v38), v39_(v39), v40_(v40),
      v41_(v41), v42_(v42), v43_(v43), v44_(v44), v45_(v45), v46_(v46) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_), static_cast(v14_),
        static_cast(v15_), static_cast(v16_), static_cast(v17_),
        static_cast(v18_), static_cast(v19_), static_cast(v20_),
        static_cast(v21_), static_cast(v22_), static_cast(v23_),
        static_cast(v24_), static_cast(v25_), static_cast(v26_),
        static_cast(v27_), static_cast(v28_), static_cast(v29_),
        static_cast(v30_), static_cast(v31_), static_cast(v32_),
        static_cast(v33_), static_cast(v34_), static_cast(v35_),
        static_cast(v36_), static_cast(v37_), static_cast(v38_),
        static_cast(v39_), static_cast(v40_), static_cast(v41_),
        static_cast(v42_), static_cast(v43_), static_cast(v44_),
        static_cast(v45_), static_cast(v46_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray46& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
  const T14 v14_;
  const T15 v15_;
  const T16 v16_;
  const T17 v17_;
  const T18 v18_;
  const T19 v19_;
  const T20 v20_;
  const T21 v21_;
  const T22 v22_;
  const T23 v23_;
  const T24 v24_;
  const T25 v25_;
  const T26 v26_;
  const T27 v27_;
  const T28 v28_;
  const T29 v29_;
  const T30 v30_;
  const T31 v31_;
  const T32 v32_;
  const T33 v33_;
  const T34 v34_;
  const T35 v35_;
  const T36 v36_;
  const T37 v37_;
  const T38 v38_;
  const T39 v39_;
  const T40 v40_;
  const T41 v41_;
  const T42 v42_;
  const T43 v43_;
  const T44 v44_;
  const T45 v45_;
  const T46 v46_;
};

template 
class ValueArray47 {
 public:
  ValueArray47(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
      T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25,
      T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33,
      T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39, T40 v40, T41 v41,
      T42 v42, T43 v43, T44 v44, T45 v45, T46 v46, T47 v47) : v1_(v1), v2_(v2),
      v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9), v10_(v10),
      v11_(v11), v12_(v12), v13_(v13), v14_(v14), v15_(v15), v16_(v16),
      v17_(v17), v18_(v18), v19_(v19), v20_(v20), v21_(v21), v22_(v22),
      v23_(v23), v24_(v24), v25_(v25), v26_(v26), v27_(v27), v28_(v28),
      v29_(v29), v30_(v30), v31_(v31), v32_(v32), v33_(v33), v34_(v34),
      v35_(v35), v36_(v36), v37_(v37), v38_(v38), v39_(v39), v40_(v40),
      v41_(v41), v42_(v42), v43_(v43), v44_(v44), v45_(v45), v46_(v46),
      v47_(v47) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_), static_cast(v14_),
        static_cast(v15_), static_cast(v16_), static_cast(v17_),
        static_cast(v18_), static_cast(v19_), static_cast(v20_),
        static_cast(v21_), static_cast(v22_), static_cast(v23_),
        static_cast(v24_), static_cast(v25_), static_cast(v26_),
        static_cast(v27_), static_cast(v28_), static_cast(v29_),
        static_cast(v30_), static_cast(v31_), static_cast(v32_),
        static_cast(v33_), static_cast(v34_), static_cast(v35_),
        static_cast(v36_), static_cast(v37_), static_cast(v38_),
        static_cast(v39_), static_cast(v40_), static_cast(v41_),
        static_cast(v42_), static_cast(v43_), static_cast(v44_),
        static_cast(v45_), static_cast(v46_), static_cast(v47_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray47& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
  const T14 v14_;
  const T15 v15_;
  const T16 v16_;
  const T17 v17_;
  const T18 v18_;
  const T19 v19_;
  const T20 v20_;
  const T21 v21_;
  const T22 v22_;
  const T23 v23_;
  const T24 v24_;
  const T25 v25_;
  const T26 v26_;
  const T27 v27_;
  const T28 v28_;
  const T29 v29_;
  const T30 v30_;
  const T31 v31_;
  const T32 v32_;
  const T33 v33_;
  const T34 v34_;
  const T35 v35_;
  const T36 v36_;
  const T37 v37_;
  const T38 v38_;
  const T39 v39_;
  const T40 v40_;
  const T41 v41_;
  const T42 v42_;
  const T43 v43_;
  const T44 v44_;
  const T45 v45_;
  const T46 v46_;
  const T47 v47_;
};

template 
class ValueArray48 {
 public:
  ValueArray48(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
      T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25,
      T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33,
      T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39, T40 v40, T41 v41,
      T42 v42, T43 v43, T44 v44, T45 v45, T46 v46, T47 v47, T48 v48) : v1_(v1),
      v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7), v8_(v8), v9_(v9),
      v10_(v10), v11_(v11), v12_(v12), v13_(v13), v14_(v14), v15_(v15),
      v16_(v16), v17_(v17), v18_(v18), v19_(v19), v20_(v20), v21_(v21),
      v22_(v22), v23_(v23), v24_(v24), v25_(v25), v26_(v26), v27_(v27),
      v28_(v28), v29_(v29), v30_(v30), v31_(v31), v32_(v32), v33_(v33),
      v34_(v34), v35_(v35), v36_(v36), v37_(v37), v38_(v38), v39_(v39),
      v40_(v40), v41_(v41), v42_(v42), v43_(v43), v44_(v44), v45_(v45),
      v46_(v46), v47_(v47), v48_(v48) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_), static_cast(v14_),
        static_cast(v15_), static_cast(v16_), static_cast(v17_),
        static_cast(v18_), static_cast(v19_), static_cast(v20_),
        static_cast(v21_), static_cast(v22_), static_cast(v23_),
        static_cast(v24_), static_cast(v25_), static_cast(v26_),
        static_cast(v27_), static_cast(v28_), static_cast(v29_),
        static_cast(v30_), static_cast(v31_), static_cast(v32_),
        static_cast(v33_), static_cast(v34_), static_cast(v35_),
        static_cast(v36_), static_cast(v37_), static_cast(v38_),
        static_cast(v39_), static_cast(v40_), static_cast(v41_),
        static_cast(v42_), static_cast(v43_), static_cast(v44_),
        static_cast(v45_), static_cast(v46_), static_cast(v47_),
        static_cast(v48_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray48& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
  const T14 v14_;
  const T15 v15_;
  const T16 v16_;
  const T17 v17_;
  const T18 v18_;
  const T19 v19_;
  const T20 v20_;
  const T21 v21_;
  const T22 v22_;
  const T23 v23_;
  const T24 v24_;
  const T25 v25_;
  const T26 v26_;
  const T27 v27_;
  const T28 v28_;
  const T29 v29_;
  const T30 v30_;
  const T31 v31_;
  const T32 v32_;
  const T33 v33_;
  const T34 v34_;
  const T35 v35_;
  const T36 v36_;
  const T37 v37_;
  const T38 v38_;
  const T39 v39_;
  const T40 v40_;
  const T41 v41_;
  const T42 v42_;
  const T43 v43_;
  const T44 v44_;
  const T45 v45_;
  const T46 v46_;
  const T47 v47_;
  const T48 v48_;
};

template 
class ValueArray49 {
 public:
  ValueArray49(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
      T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25,
      T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33,
      T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39, T40 v40, T41 v41,
      T42 v42, T43 v43, T44 v44, T45 v45, T46 v46, T47 v47, T48 v48,
      T49 v49) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7),
      v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12), v13_(v13), v14_(v14),
      v15_(v15), v16_(v16), v17_(v17), v18_(v18), v19_(v19), v20_(v20),
      v21_(v21), v22_(v22), v23_(v23), v24_(v24), v25_(v25), v26_(v26),
      v27_(v27), v28_(v28), v29_(v29), v30_(v30), v31_(v31), v32_(v32),
      v33_(v33), v34_(v34), v35_(v35), v36_(v36), v37_(v37), v38_(v38),
      v39_(v39), v40_(v40), v41_(v41), v42_(v42), v43_(v43), v44_(v44),
      v45_(v45), v46_(v46), v47_(v47), v48_(v48), v49_(v49) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_), static_cast(v14_),
        static_cast(v15_), static_cast(v16_), static_cast(v17_),
        static_cast(v18_), static_cast(v19_), static_cast(v20_),
        static_cast(v21_), static_cast(v22_), static_cast(v23_),
        static_cast(v24_), static_cast(v25_), static_cast(v26_),
        static_cast(v27_), static_cast(v28_), static_cast(v29_),
        static_cast(v30_), static_cast(v31_), static_cast(v32_),
        static_cast(v33_), static_cast(v34_), static_cast(v35_),
        static_cast(v36_), static_cast(v37_), static_cast(v38_),
        static_cast(v39_), static_cast(v40_), static_cast(v41_),
        static_cast(v42_), static_cast(v43_), static_cast(v44_),
        static_cast(v45_), static_cast(v46_), static_cast(v47_),
        static_cast(v48_), static_cast(v49_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray49& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
  const T14 v14_;
  const T15 v15_;
  const T16 v16_;
  const T17 v17_;
  const T18 v18_;
  const T19 v19_;
  const T20 v20_;
  const T21 v21_;
  const T22 v22_;
  const T23 v23_;
  const T24 v24_;
  const T25 v25_;
  const T26 v26_;
  const T27 v27_;
  const T28 v28_;
  const T29 v29_;
  const T30 v30_;
  const T31 v31_;
  const T32 v32_;
  const T33 v33_;
  const T34 v34_;
  const T35 v35_;
  const T36 v36_;
  const T37 v37_;
  const T38 v38_;
  const T39 v39_;
  const T40 v40_;
  const T41 v41_;
  const T42 v42_;
  const T43 v43_;
  const T44 v44_;
  const T45 v45_;
  const T46 v46_;
  const T47 v47_;
  const T48 v48_;
  const T49 v49_;
};

template 
class ValueArray50 {
 public:
  ValueArray50(T1 v1, T2 v2, T3 v3, T4 v4, T5 v5, T6 v6, T7 v7, T8 v8, T9 v9,
      T10 v10, T11 v11, T12 v12, T13 v13, T14 v14, T15 v15, T16 v16, T17 v17,
      T18 v18, T19 v19, T20 v20, T21 v21, T22 v22, T23 v23, T24 v24, T25 v25,
      T26 v26, T27 v27, T28 v28, T29 v29, T30 v30, T31 v31, T32 v32, T33 v33,
      T34 v34, T35 v35, T36 v36, T37 v37, T38 v38, T39 v39, T40 v40, T41 v41,
      T42 v42, T43 v43, T44 v44, T45 v45, T46 v46, T47 v47, T48 v48, T49 v49,
      T50 v50) : v1_(v1), v2_(v2), v3_(v3), v4_(v4), v5_(v5), v6_(v6), v7_(v7),
      v8_(v8), v9_(v9), v10_(v10), v11_(v11), v12_(v12), v13_(v13), v14_(v14),
      v15_(v15), v16_(v16), v17_(v17), v18_(v18), v19_(v19), v20_(v20),
      v21_(v21), v22_(v22), v23_(v23), v24_(v24), v25_(v25), v26_(v26),
      v27_(v27), v28_(v28), v29_(v29), v30_(v30), v31_(v31), v32_(v32),
      v33_(v33), v34_(v34), v35_(v35), v36_(v36), v37_(v37), v38_(v38),
      v39_(v39), v40_(v40), v41_(v41), v42_(v42), v43_(v43), v44_(v44),
      v45_(v45), v46_(v46), v47_(v47), v48_(v48), v49_(v49), v50_(v50) {}

  template 
  operator ParamGenerator() const {
    const T array[] = {static_cast(v1_), static_cast(v2_),
        static_cast(v3_), static_cast(v4_), static_cast(v5_),
        static_cast(v6_), static_cast(v7_), static_cast(v8_),
        static_cast(v9_), static_cast(v10_), static_cast(v11_),
        static_cast(v12_), static_cast(v13_), static_cast(v14_),
        static_cast(v15_), static_cast(v16_), static_cast(v17_),
        static_cast(v18_), static_cast(v19_), static_cast(v20_),
        static_cast(v21_), static_cast(v22_), static_cast(v23_),
        static_cast(v24_), static_cast(v25_), static_cast(v26_),
        static_cast(v27_), static_cast(v28_), static_cast(v29_),
        static_cast(v30_), static_cast(v31_), static_cast(v32_),
        static_cast(v33_), static_cast(v34_), static_cast(v35_),
        static_cast(v36_), static_cast(v37_), static_cast(v38_),
        static_cast(v39_), static_cast(v40_), static_cast(v41_),
        static_cast(v42_), static_cast(v43_), static_cast(v44_),
        static_cast(v45_), static_cast(v46_), static_cast(v47_),
        static_cast(v48_), static_cast(v49_), static_cast(v50_)};
    return ValuesIn(array);
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const ValueArray50& other);

  const T1 v1_;
  const T2 v2_;
  const T3 v3_;
  const T4 v4_;
  const T5 v5_;
  const T6 v6_;
  const T7 v7_;
  const T8 v8_;
  const T9 v9_;
  const T10 v10_;
  const T11 v11_;
  const T12 v12_;
  const T13 v13_;
  const T14 v14_;
  const T15 v15_;
  const T16 v16_;
  const T17 v17_;
  const T18 v18_;
  const T19 v19_;
  const T20 v20_;
  const T21 v21_;
  const T22 v22_;
  const T23 v23_;
  const T24 v24_;
  const T25 v25_;
  const T26 v26_;
  const T27 v27_;
  const T28 v28_;
  const T29 v29_;
  const T30 v30_;
  const T31 v31_;
  const T32 v32_;
  const T33 v33_;
  const T34 v34_;
  const T35 v35_;
  const T36 v36_;
  const T37 v37_;
  const T38 v38_;
  const T39 v39_;
  const T40 v40_;
  const T41 v41_;
  const T42 v42_;
  const T43 v43_;
  const T44 v44_;
  const T45 v45_;
  const T46 v46_;
  const T47 v47_;
  const T48 v48_;
  const T49 v49_;
  const T50 v50_;
};

# if GTEST_HAS_COMBINE
// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE.
//
// Generates values from the Cartesian product of values produced
// by the argument generators.
//
template 
class CartesianProductGenerator2
    : public ParamGeneratorInterface< ::testing::tuple > {
 public:
  typedef ::testing::tuple ParamType;

  CartesianProductGenerator2(const ParamGenerator& g1,
      const ParamGenerator& g2)
      : g1_(g1), g2_(g2) {}
  virtual ~CartesianProductGenerator2() {}

  virtual ParamIteratorInterface* Begin() const {
    return new Iterator(this, g1_, g1_.begin(), g2_, g2_.begin());
  }
  virtual ParamIteratorInterface* End() const {
    return new Iterator(this, g1_, g1_.end(), g2_, g2_.end());
  }

 private:
  class Iterator : public ParamIteratorInterface {
   public:
    Iterator(const ParamGeneratorInterface* base,
      const ParamGenerator& g1,
      const typename ParamGenerator::iterator& current1,
      const ParamGenerator& g2,
      const typename ParamGenerator::iterator& current2)
        : base_(base),
          begin1_(g1.begin()), end1_(g1.end()), current1_(current1),
          begin2_(g2.begin()), end2_(g2.end()), current2_(current2)    {
      ComputeCurrentValue();
    }
    virtual ~Iterator() {}

    virtual const ParamGeneratorInterface* BaseGenerator() const {
      return base_;
    }
    // Advance should not be called on beyond-of-range iterators
    // so no component iterators must be beyond end of range, either.
    virtual void Advance() {
      assert(!AtEnd());
      ++current2_;
      if (current2_ == end2_) {
        current2_ = begin2_;
        ++current1_;
      }
      ComputeCurrentValue();
    }
    virtual ParamIteratorInterface* Clone() const {
      return new Iterator(*this);
    }
    virtual const ParamType* Current() const { return ¤t_value_; }
    virtual bool Equals(const ParamIteratorInterface& other) const {
      // Having the same base generator guarantees that the other
      // iterator is of the same type and we can downcast.
      GTEST_CHECK_(BaseGenerator() == other.BaseGenerator())
          << "The program attempted to compare iterators "
          << "from different generators." << std::endl;
      const Iterator* typed_other =
          CheckedDowncastToActualType(&other);
      // We must report iterators equal if they both point beyond their
      // respective ranges. That can happen in a variety of fashions,
      // so we have to consult AtEnd().
      return (AtEnd() && typed_other->AtEnd()) ||
         (
          current1_ == typed_other->current1_ &&
          current2_ == typed_other->current2_);
    }

   private:
    Iterator(const Iterator& other)
        : base_(other.base_),
        begin1_(other.begin1_),
        end1_(other.end1_),
        current1_(other.current1_),
        begin2_(other.begin2_),
        end2_(other.end2_),
        current2_(other.current2_) {
      ComputeCurrentValue();
    }

    void ComputeCurrentValue() {
      if (!AtEnd())
        current_value_ = ParamType(*current1_, *current2_);
    }
    bool AtEnd() const {
      // We must report iterator past the end of the range when either of the
      // component iterators has reached the end of its range.
      return
          current1_ == end1_ ||
          current2_ == end2_;
    }

    // No implementation - assignment is unsupported.
    void operator=(const Iterator& other);

    const ParamGeneratorInterface* const base_;
    // begin[i]_ and end[i]_ define the i-th range that Iterator traverses.
    // current[i]_ is the actual traversing iterator.
    const typename ParamGenerator::iterator begin1_;
    const typename ParamGenerator::iterator end1_;
    typename ParamGenerator::iterator current1_;
    const typename ParamGenerator::iterator begin2_;
    const typename ParamGenerator::iterator end2_;
    typename ParamGenerator::iterator current2_;
    ParamType current_value_;
  };  // class CartesianProductGenerator2::Iterator

  // No implementation - assignment is unsupported.
  void operator=(const CartesianProductGenerator2& other);

  const ParamGenerator g1_;
  const ParamGenerator g2_;
};  // class CartesianProductGenerator2


template 
class CartesianProductGenerator3
    : public ParamGeneratorInterface< ::testing::tuple > {
 public:
  typedef ::testing::tuple ParamType;

  CartesianProductGenerator3(const ParamGenerator& g1,
      const ParamGenerator& g2, const ParamGenerator& g3)
      : g1_(g1), g2_(g2), g3_(g3) {}
  virtual ~CartesianProductGenerator3() {}

  virtual ParamIteratorInterface* Begin() const {
    return new Iterator(this, g1_, g1_.begin(), g2_, g2_.begin(), g3_,
        g3_.begin());
  }
  virtual ParamIteratorInterface* End() const {
    return new Iterator(this, g1_, g1_.end(), g2_, g2_.end(), g3_, g3_.end());
  }

 private:
  class Iterator : public ParamIteratorInterface {
   public:
    Iterator(const ParamGeneratorInterface* base,
      const ParamGenerator& g1,
      const typename ParamGenerator::iterator& current1,
      const ParamGenerator& g2,
      const typename ParamGenerator::iterator& current2,
      const ParamGenerator& g3,
      const typename ParamGenerator::iterator& current3)
        : base_(base),
          begin1_(g1.begin()), end1_(g1.end()), current1_(current1),
          begin2_(g2.begin()), end2_(g2.end()), current2_(current2),
          begin3_(g3.begin()), end3_(g3.end()), current3_(current3)    {
      ComputeCurrentValue();
    }
    virtual ~Iterator() {}

    virtual const ParamGeneratorInterface* BaseGenerator() const {
      return base_;
    }
    // Advance should not be called on beyond-of-range iterators
    // so no component iterators must be beyond end of range, either.
    virtual void Advance() {
      assert(!AtEnd());
      ++current3_;
      if (current3_ == end3_) {
        current3_ = begin3_;
        ++current2_;
      }
      if (current2_ == end2_) {
        current2_ = begin2_;
        ++current1_;
      }
      ComputeCurrentValue();
    }
    virtual ParamIteratorInterface* Clone() const {
      return new Iterator(*this);
    }
    virtual const ParamType* Current() const { return ¤t_value_; }
    virtual bool Equals(const ParamIteratorInterface& other) const {
      // Having the same base generator guarantees that the other
      // iterator is of the same type and we can downcast.
      GTEST_CHECK_(BaseGenerator() == other.BaseGenerator())
          << "The program attempted to compare iterators "
          << "from different generators." << std::endl;
      const Iterator* typed_other =
          CheckedDowncastToActualType(&other);
      // We must report iterators equal if they both point beyond their
      // respective ranges. That can happen in a variety of fashions,
      // so we have to consult AtEnd().
      return (AtEnd() && typed_other->AtEnd()) ||
         (
          current1_ == typed_other->current1_ &&
          current2_ == typed_other->current2_ &&
          current3_ == typed_other->current3_);
    }

   private:
    Iterator(const Iterator& other)
        : base_(other.base_),
        begin1_(other.begin1_),
        end1_(other.end1_),
        current1_(other.current1_),
        begin2_(other.begin2_),
        end2_(other.end2_),
        current2_(other.current2_),
        begin3_(other.begin3_),
        end3_(other.end3_),
        current3_(other.current3_) {
      ComputeCurrentValue();
    }

    void ComputeCurrentValue() {
      if (!AtEnd())
        current_value_ = ParamType(*current1_, *current2_, *current3_);
    }
    bool AtEnd() const {
      // We must report iterator past the end of the range when either of the
      // component iterators has reached the end of its range.
      return
          current1_ == end1_ ||
          current2_ == end2_ ||
          current3_ == end3_;
    }

    // No implementation - assignment is unsupported.
    void operator=(const Iterator& other);

    const ParamGeneratorInterface* const base_;
    // begin[i]_ and end[i]_ define the i-th range that Iterator traverses.
    // current[i]_ is the actual traversing iterator.
    const typename ParamGenerator::iterator begin1_;
    const typename ParamGenerator::iterator end1_;
    typename ParamGenerator::iterator current1_;
    const typename ParamGenerator::iterator begin2_;
    const typename ParamGenerator::iterator end2_;
    typename ParamGenerator::iterator current2_;
    const typename ParamGenerator::iterator begin3_;
    const typename ParamGenerator::iterator end3_;
    typename ParamGenerator::iterator current3_;
    ParamType current_value_;
  };  // class CartesianProductGenerator3::Iterator

  // No implementation - assignment is unsupported.
  void operator=(const CartesianProductGenerator3& other);

  const ParamGenerator g1_;
  const ParamGenerator g2_;
  const ParamGenerator g3_;
};  // class CartesianProductGenerator3


template 
class CartesianProductGenerator4
    : public ParamGeneratorInterface< ::testing::tuple > {
 public:
  typedef ::testing::tuple ParamType;

  CartesianProductGenerator4(const ParamGenerator& g1,
      const ParamGenerator& g2, const ParamGenerator& g3,
      const ParamGenerator& g4)
      : g1_(g1), g2_(g2), g3_(g3), g4_(g4) {}
  virtual ~CartesianProductGenerator4() {}

  virtual ParamIteratorInterface* Begin() const {
    return new Iterator(this, g1_, g1_.begin(), g2_, g2_.begin(), g3_,
        g3_.begin(), g4_, g4_.begin());
  }
  virtual ParamIteratorInterface* End() const {
    return new Iterator(this, g1_, g1_.end(), g2_, g2_.end(), g3_, g3_.end(),
        g4_, g4_.end());
  }

 private:
  class Iterator : public ParamIteratorInterface {
   public:
    Iterator(const ParamGeneratorInterface* base,
      const ParamGenerator& g1,
      const typename ParamGenerator::iterator& current1,
      const ParamGenerator& g2,
      const typename ParamGenerator::iterator& current2,
      const ParamGenerator& g3,
      const typename ParamGenerator::iterator& current3,
      const ParamGenerator& g4,
      const typename ParamGenerator::iterator& current4)
        : base_(base),
          begin1_(g1.begin()), end1_(g1.end()), current1_(current1),
          begin2_(g2.begin()), end2_(g2.end()), current2_(current2),
          begin3_(g3.begin()), end3_(g3.end()), current3_(current3),
          begin4_(g4.begin()), end4_(g4.end()), current4_(current4)    {
      ComputeCurrentValue();
    }
    virtual ~Iterator() {}

    virtual const ParamGeneratorInterface* BaseGenerator() const {
      return base_;
    }
    // Advance should not be called on beyond-of-range iterators
    // so no component iterators must be beyond end of range, either.
    virtual void Advance() {
      assert(!AtEnd());
      ++current4_;
      if (current4_ == end4_) {
        current4_ = begin4_;
        ++current3_;
      }
      if (current3_ == end3_) {
        current3_ = begin3_;
        ++current2_;
      }
      if (current2_ == end2_) {
        current2_ = begin2_;
        ++current1_;
      }
      ComputeCurrentValue();
    }
    virtual ParamIteratorInterface* Clone() const {
      return new Iterator(*this);
    }
    virtual const ParamType* Current() const { return ¤t_value_; }
    virtual bool Equals(const ParamIteratorInterface& other) const {
      // Having the same base generator guarantees that the other
      // iterator is of the same type and we can downcast.
      GTEST_CHECK_(BaseGenerator() == other.BaseGenerator())
          << "The program attempted to compare iterators "
          << "from different generators." << std::endl;
      const Iterator* typed_other =
          CheckedDowncastToActualType(&other);
      // We must report iterators equal if they both point beyond their
      // respective ranges. That can happen in a variety of fashions,
      // so we have to consult AtEnd().
      return (AtEnd() && typed_other->AtEnd()) ||
         (
          current1_ == typed_other->current1_ &&
          current2_ == typed_other->current2_ &&
          current3_ == typed_other->current3_ &&
          current4_ == typed_other->current4_);
    }

   private:
    Iterator(const Iterator& other)
        : base_(other.base_),
        begin1_(other.begin1_),
        end1_(other.end1_),
        current1_(other.current1_),
        begin2_(other.begin2_),
        end2_(other.end2_),
        current2_(other.current2_),
        begin3_(other.begin3_),
        end3_(other.end3_),
        current3_(other.current3_),
        begin4_(other.begin4_),
        end4_(other.end4_),
        current4_(other.current4_) {
      ComputeCurrentValue();
    }

    void ComputeCurrentValue() {
      if (!AtEnd())
        current_value_ = ParamType(*current1_, *current2_, *current3_,
            *current4_);
    }
    bool AtEnd() const {
      // We must report iterator past the end of the range when either of the
      // component iterators has reached the end of its range.
      return
          current1_ == end1_ ||
          current2_ == end2_ ||
          current3_ == end3_ ||
          current4_ == end4_;
    }

    // No implementation - assignment is unsupported.
    void operator=(const Iterator& other);

    const ParamGeneratorInterface* const base_;
    // begin[i]_ and end[i]_ define the i-th range that Iterator traverses.
    // current[i]_ is the actual traversing iterator.
    const typename ParamGenerator::iterator begin1_;
    const typename ParamGenerator::iterator end1_;
    typename ParamGenerator::iterator current1_;
    const typename ParamGenerator::iterator begin2_;
    const typename ParamGenerator::iterator end2_;
    typename ParamGenerator::iterator current2_;
    const typename ParamGenerator::iterator begin3_;
    const typename ParamGenerator::iterator end3_;
    typename ParamGenerator::iterator current3_;
    const typename ParamGenerator::iterator begin4_;
    const typename ParamGenerator::iterator end4_;
    typename ParamGenerator::iterator current4_;
    ParamType current_value_;
  };  // class CartesianProductGenerator4::Iterator

  // No implementation - assignment is unsupported.
  void operator=(const CartesianProductGenerator4& other);

  const ParamGenerator g1_;
  const ParamGenerator g2_;
  const ParamGenerator g3_;
  const ParamGenerator g4_;
};  // class CartesianProductGenerator4


template 
class CartesianProductGenerator5
    : public ParamGeneratorInterface< ::testing::tuple > {
 public:
  typedef ::testing::tuple ParamType;

  CartesianProductGenerator5(const ParamGenerator& g1,
      const ParamGenerator& g2, const ParamGenerator& g3,
      const ParamGenerator& g4, const ParamGenerator& g5)
      : g1_(g1), g2_(g2), g3_(g3), g4_(g4), g5_(g5) {}
  virtual ~CartesianProductGenerator5() {}

  virtual ParamIteratorInterface* Begin() const {
    return new Iterator(this, g1_, g1_.begin(), g2_, g2_.begin(), g3_,
        g3_.begin(), g4_, g4_.begin(), g5_, g5_.begin());
  }
  virtual ParamIteratorInterface* End() const {
    return new Iterator(this, g1_, g1_.end(), g2_, g2_.end(), g3_, g3_.end(),
        g4_, g4_.end(), g5_, g5_.end());
  }

 private:
  class Iterator : public ParamIteratorInterface {
   public:
    Iterator(const ParamGeneratorInterface* base,
      const ParamGenerator& g1,
      const typename ParamGenerator::iterator& current1,
      const ParamGenerator& g2,
      const typename ParamGenerator::iterator& current2,
      const ParamGenerator& g3,
      const typename ParamGenerator::iterator& current3,
      const ParamGenerator& g4,
      const typename ParamGenerator::iterator& current4,
      const ParamGenerator& g5,
      const typename ParamGenerator::iterator& current5)
        : base_(base),
          begin1_(g1.begin()), end1_(g1.end()), current1_(current1),
          begin2_(g2.begin()), end2_(g2.end()), current2_(current2),
          begin3_(g3.begin()), end3_(g3.end()), current3_(current3),
          begin4_(g4.begin()), end4_(g4.end()), current4_(current4),
          begin5_(g5.begin()), end5_(g5.end()), current5_(current5)    {
      ComputeCurrentValue();
    }
    virtual ~Iterator() {}

    virtual const ParamGeneratorInterface* BaseGenerator() const {
      return base_;
    }
    // Advance should not be called on beyond-of-range iterators
    // so no component iterators must be beyond end of range, either.
    virtual void Advance() {
      assert(!AtEnd());
      ++current5_;
      if (current5_ == end5_) {
        current5_ = begin5_;
        ++current4_;
      }
      if (current4_ == end4_) {
        current4_ = begin4_;
        ++current3_;
      }
      if (current3_ == end3_) {
        current3_ = begin3_;
        ++current2_;
      }
      if (current2_ == end2_) {
        current2_ = begin2_;
        ++current1_;
      }
      ComputeCurrentValue();
    }
    virtual ParamIteratorInterface* Clone() const {
      return new Iterator(*this);
    }
    virtual const ParamType* Current() const { return ¤t_value_; }
    virtual bool Equals(const ParamIteratorInterface& other) const {
      // Having the same base generator guarantees that the other
      // iterator is of the same type and we can downcast.
      GTEST_CHECK_(BaseGenerator() == other.BaseGenerator())
          << "The program attempted to compare iterators "
          << "from different generators." << std::endl;
      const Iterator* typed_other =
          CheckedDowncastToActualType(&other);
      // We must report iterators equal if they both point beyond their
      // respective ranges. That can happen in a variety of fashions,
      // so we have to consult AtEnd().
      return (AtEnd() && typed_other->AtEnd()) ||
         (
          current1_ == typed_other->current1_ &&
          current2_ == typed_other->current2_ &&
          current3_ == typed_other->current3_ &&
          current4_ == typed_other->current4_ &&
          current5_ == typed_other->current5_);
    }

   private:
    Iterator(const Iterator& other)
        : base_(other.base_),
        begin1_(other.begin1_),
        end1_(other.end1_),
        current1_(other.current1_),
        begin2_(other.begin2_),
        end2_(other.end2_),
        current2_(other.current2_),
        begin3_(other.begin3_),
        end3_(other.end3_),
        current3_(other.current3_),
        begin4_(other.begin4_),
        end4_(other.end4_),
        current4_(other.current4_),
        begin5_(other.begin5_),
        end5_(other.end5_),
        current5_(other.current5_) {
      ComputeCurrentValue();
    }

    void ComputeCurrentValue() {
      if (!AtEnd())
        current_value_ = ParamType(*current1_, *current2_, *current3_,
            *current4_, *current5_);
    }
    bool AtEnd() const {
      // We must report iterator past the end of the range when either of the
      // component iterators has reached the end of its range.
      return
          current1_ == end1_ ||
          current2_ == end2_ ||
          current3_ == end3_ ||
          current4_ == end4_ ||
          current5_ == end5_;
    }

    // No implementation - assignment is unsupported.
    void operator=(const Iterator& other);

    const ParamGeneratorInterface* const base_;
    // begin[i]_ and end[i]_ define the i-th range that Iterator traverses.
    // current[i]_ is the actual traversing iterator.
    const typename ParamGenerator::iterator begin1_;
    const typename ParamGenerator::iterator end1_;
    typename ParamGenerator::iterator current1_;
    const typename ParamGenerator::iterator begin2_;
    const typename ParamGenerator::iterator end2_;
    typename ParamGenerator::iterator current2_;
    const typename ParamGenerator::iterator begin3_;
    const typename ParamGenerator::iterator end3_;
    typename ParamGenerator::iterator current3_;
    const typename ParamGenerator::iterator begin4_;
    const typename ParamGenerator::iterator end4_;
    typename ParamGenerator::iterator current4_;
    const typename ParamGenerator::iterator begin5_;
    const typename ParamGenerator::iterator end5_;
    typename ParamGenerator::iterator current5_;
    ParamType current_value_;
  };  // class CartesianProductGenerator5::Iterator

  // No implementation - assignment is unsupported.
  void operator=(const CartesianProductGenerator5& other);

  const ParamGenerator g1_;
  const ParamGenerator g2_;
  const ParamGenerator g3_;
  const ParamGenerator g4_;
  const ParamGenerator g5_;
};  // class CartesianProductGenerator5


template 
class CartesianProductGenerator6
    : public ParamGeneratorInterface< ::testing::tuple > {
 public:
  typedef ::testing::tuple ParamType;

  CartesianProductGenerator6(const ParamGenerator& g1,
      const ParamGenerator& g2, const ParamGenerator& g3,
      const ParamGenerator& g4, const ParamGenerator& g5,
      const ParamGenerator& g6)
      : g1_(g1), g2_(g2), g3_(g3), g4_(g4), g5_(g5), g6_(g6) {}
  virtual ~CartesianProductGenerator6() {}

  virtual ParamIteratorInterface* Begin() const {
    return new Iterator(this, g1_, g1_.begin(), g2_, g2_.begin(), g3_,
        g3_.begin(), g4_, g4_.begin(), g5_, g5_.begin(), g6_, g6_.begin());
  }
  virtual ParamIteratorInterface* End() const {
    return new Iterator(this, g1_, g1_.end(), g2_, g2_.end(), g3_, g3_.end(),
        g4_, g4_.end(), g5_, g5_.end(), g6_, g6_.end());
  }

 private:
  class Iterator : public ParamIteratorInterface {
   public:
    Iterator(const ParamGeneratorInterface* base,
      const ParamGenerator& g1,
      const typename ParamGenerator::iterator& current1,
      const ParamGenerator& g2,
      const typename ParamGenerator::iterator& current2,
      const ParamGenerator& g3,
      const typename ParamGenerator::iterator& current3,
      const ParamGenerator& g4,
      const typename ParamGenerator::iterator& current4,
      const ParamGenerator& g5,
      const typename ParamGenerator::iterator& current5,
      const ParamGenerator& g6,
      const typename ParamGenerator::iterator& current6)
        : base_(base),
          begin1_(g1.begin()), end1_(g1.end()), current1_(current1),
          begin2_(g2.begin()), end2_(g2.end()), current2_(current2),
          begin3_(g3.begin()), end3_(g3.end()), current3_(current3),
          begin4_(g4.begin()), end4_(g4.end()), current4_(current4),
          begin5_(g5.begin()), end5_(g5.end()), current5_(current5),
          begin6_(g6.begin()), end6_(g6.end()), current6_(current6)    {
      ComputeCurrentValue();
    }
    virtual ~Iterator() {}

    virtual const ParamGeneratorInterface* BaseGenerator() const {
      return base_;
    }
    // Advance should not be called on beyond-of-range iterators
    // so no component iterators must be beyond end of range, either.
    virtual void Advance() {
      assert(!AtEnd());
      ++current6_;
      if (current6_ == end6_) {
        current6_ = begin6_;
        ++current5_;
      }
      if (current5_ == end5_) {
        current5_ = begin5_;
        ++current4_;
      }
      if (current4_ == end4_) {
        current4_ = begin4_;
        ++current3_;
      }
      if (current3_ == end3_) {
        current3_ = begin3_;
        ++current2_;
      }
      if (current2_ == end2_) {
        current2_ = begin2_;
        ++current1_;
      }
      ComputeCurrentValue();
    }
    virtual ParamIteratorInterface* Clone() const {
      return new Iterator(*this);
    }
    virtual const ParamType* Current() const { return ¤t_value_; }
    virtual bool Equals(const ParamIteratorInterface& other) const {
      // Having the same base generator guarantees that the other
      // iterator is of the same type and we can downcast.
      GTEST_CHECK_(BaseGenerator() == other.BaseGenerator())
          << "The program attempted to compare iterators "
          << "from different generators." << std::endl;
      const Iterator* typed_other =
          CheckedDowncastToActualType(&other);
      // We must report iterators equal if they both point beyond their
      // respective ranges. That can happen in a variety of fashions,
      // so we have to consult AtEnd().
      return (AtEnd() && typed_other->AtEnd()) ||
         (
          current1_ == typed_other->current1_ &&
          current2_ == typed_other->current2_ &&
          current3_ == typed_other->current3_ &&
          current4_ == typed_other->current4_ &&
          current5_ == typed_other->current5_ &&
          current6_ == typed_other->current6_);
    }

   private:
    Iterator(const Iterator& other)
        : base_(other.base_),
        begin1_(other.begin1_),
        end1_(other.end1_),
        current1_(other.current1_),
        begin2_(other.begin2_),
        end2_(other.end2_),
        current2_(other.current2_),
        begin3_(other.begin3_),
        end3_(other.end3_),
        current3_(other.current3_),
        begin4_(other.begin4_),
        end4_(other.end4_),
        current4_(other.current4_),
        begin5_(other.begin5_),
        end5_(other.end5_),
        current5_(other.current5_),
        begin6_(other.begin6_),
        end6_(other.end6_),
        current6_(other.current6_) {
      ComputeCurrentValue();
    }

    void ComputeCurrentValue() {
      if (!AtEnd())
        current_value_ = ParamType(*current1_, *current2_, *current3_,
            *current4_, *current5_, *current6_);
    }
    bool AtEnd() const {
      // We must report iterator past the end of the range when either of the
      // component iterators has reached the end of its range.
      return
          current1_ == end1_ ||
          current2_ == end2_ ||
          current3_ == end3_ ||
          current4_ == end4_ ||
          current5_ == end5_ ||
          current6_ == end6_;
    }

    // No implementation - assignment is unsupported.
    void operator=(const Iterator& other);

    const ParamGeneratorInterface* const base_;
    // begin[i]_ and end[i]_ define the i-th range that Iterator traverses.
    // current[i]_ is the actual traversing iterator.
    const typename ParamGenerator::iterator begin1_;
    const typename ParamGenerator::iterator end1_;
    typename ParamGenerator::iterator current1_;
    const typename ParamGenerator::iterator begin2_;
    const typename ParamGenerator::iterator end2_;
    typename ParamGenerator::iterator current2_;
    const typename ParamGenerator::iterator begin3_;
    const typename ParamGenerator::iterator end3_;
    typename ParamGenerator::iterator current3_;
    const typename ParamGenerator::iterator begin4_;
    const typename ParamGenerator::iterator end4_;
    typename ParamGenerator::iterator current4_;
    const typename ParamGenerator::iterator begin5_;
    const typename ParamGenerator::iterator end5_;
    typename ParamGenerator::iterator current5_;
    const typename ParamGenerator::iterator begin6_;
    const typename ParamGenerator::iterator end6_;
    typename ParamGenerator::iterator current6_;
    ParamType current_value_;
  };  // class CartesianProductGenerator6::Iterator

  // No implementation - assignment is unsupported.
  void operator=(const CartesianProductGenerator6& other);

  const ParamGenerator g1_;
  const ParamGenerator g2_;
  const ParamGenerator g3_;
  const ParamGenerator g4_;
  const ParamGenerator g5_;
  const ParamGenerator g6_;
};  // class CartesianProductGenerator6


template 
class CartesianProductGenerator7
    : public ParamGeneratorInterface< ::testing::tuple > {
 public:
  typedef ::testing::tuple ParamType;

  CartesianProductGenerator7(const ParamGenerator& g1,
      const ParamGenerator& g2, const ParamGenerator& g3,
      const ParamGenerator& g4, const ParamGenerator& g5,
      const ParamGenerator& g6, const ParamGenerator& g7)
      : g1_(g1), g2_(g2), g3_(g3), g4_(g4), g5_(g5), g6_(g6), g7_(g7) {}
  virtual ~CartesianProductGenerator7() {}

  virtual ParamIteratorInterface* Begin() const {
    return new Iterator(this, g1_, g1_.begin(), g2_, g2_.begin(), g3_,
        g3_.begin(), g4_, g4_.begin(), g5_, g5_.begin(), g6_, g6_.begin(), g7_,
        g7_.begin());
  }
  virtual ParamIteratorInterface* End() const {
    return new Iterator(this, g1_, g1_.end(), g2_, g2_.end(), g3_, g3_.end(),
        g4_, g4_.end(), g5_, g5_.end(), g6_, g6_.end(), g7_, g7_.end());
  }

 private:
  class Iterator : public ParamIteratorInterface {
   public:
    Iterator(const ParamGeneratorInterface* base,
      const ParamGenerator& g1,
      const typename ParamGenerator::iterator& current1,
      const ParamGenerator& g2,
      const typename ParamGenerator::iterator& current2,
      const ParamGenerator& g3,
      const typename ParamGenerator::iterator& current3,
      const ParamGenerator& g4,
      const typename ParamGenerator::iterator& current4,
      const ParamGenerator& g5,
      const typename ParamGenerator::iterator& current5,
      const ParamGenerator& g6,
      const typename ParamGenerator::iterator& current6,
      const ParamGenerator& g7,
      const typename ParamGenerator::iterator& current7)
        : base_(base),
          begin1_(g1.begin()), end1_(g1.end()), current1_(current1),
          begin2_(g2.begin()), end2_(g2.end()), current2_(current2),
          begin3_(g3.begin()), end3_(g3.end()), current3_(current3),
          begin4_(g4.begin()), end4_(g4.end()), current4_(current4),
          begin5_(g5.begin()), end5_(g5.end()), current5_(current5),
          begin6_(g6.begin()), end6_(g6.end()), current6_(current6),
          begin7_(g7.begin()), end7_(g7.end()), current7_(current7)    {
      ComputeCurrentValue();
    }
    virtual ~Iterator() {}

    virtual const ParamGeneratorInterface* BaseGenerator() const {
      return base_;
    }
    // Advance should not be called on beyond-of-range iterators
    // so no component iterators must be beyond end of range, either.
    virtual void Advance() {
      assert(!AtEnd());
      ++current7_;
      if (current7_ == end7_) {
        current7_ = begin7_;
        ++current6_;
      }
      if (current6_ == end6_) {
        current6_ = begin6_;
        ++current5_;
      }
      if (current5_ == end5_) {
        current5_ = begin5_;
        ++current4_;
      }
      if (current4_ == end4_) {
        current4_ = begin4_;
        ++current3_;
      }
      if (current3_ == end3_) {
        current3_ = begin3_;
        ++current2_;
      }
      if (current2_ == end2_) {
        current2_ = begin2_;
        ++current1_;
      }
      ComputeCurrentValue();
    }
    virtual ParamIteratorInterface* Clone() const {
      return new Iterator(*this);
    }
    virtual const ParamType* Current() const { return ¤t_value_; }
    virtual bool Equals(const ParamIteratorInterface& other) const {
      // Having the same base generator guarantees that the other
      // iterator is of the same type and we can downcast.
      GTEST_CHECK_(BaseGenerator() == other.BaseGenerator())
          << "The program attempted to compare iterators "
          << "from different generators." << std::endl;
      const Iterator* typed_other =
          CheckedDowncastToActualType(&other);
      // We must report iterators equal if they both point beyond their
      // respective ranges. That can happen in a variety of fashions,
      // so we have to consult AtEnd().
      return (AtEnd() && typed_other->AtEnd()) ||
         (
          current1_ == typed_other->current1_ &&
          current2_ == typed_other->current2_ &&
          current3_ == typed_other->current3_ &&
          current4_ == typed_other->current4_ &&
          current5_ == typed_other->current5_ &&
          current6_ == typed_other->current6_ &&
          current7_ == typed_other->current7_);
    }

   private:
    Iterator(const Iterator& other)
        : base_(other.base_),
        begin1_(other.begin1_),
        end1_(other.end1_),
        current1_(other.current1_),
        begin2_(other.begin2_),
        end2_(other.end2_),
        current2_(other.current2_),
        begin3_(other.begin3_),
        end3_(other.end3_),
        current3_(other.current3_),
        begin4_(other.begin4_),
        end4_(other.end4_),
        current4_(other.current4_),
        begin5_(other.begin5_),
        end5_(other.end5_),
        current5_(other.current5_),
        begin6_(other.begin6_),
        end6_(other.end6_),
        current6_(other.current6_),
        begin7_(other.begin7_),
        end7_(other.end7_),
        current7_(other.current7_) {
      ComputeCurrentValue();
    }

    void ComputeCurrentValue() {
      if (!AtEnd())
        current_value_ = ParamType(*current1_, *current2_, *current3_,
            *current4_, *current5_, *current6_, *current7_);
    }
    bool AtEnd() const {
      // We must report iterator past the end of the range when either of the
      // component iterators has reached the end of its range.
      return
          current1_ == end1_ ||
          current2_ == end2_ ||
          current3_ == end3_ ||
          current4_ == end4_ ||
          current5_ == end5_ ||
          current6_ == end6_ ||
          current7_ == end7_;
    }

    // No implementation - assignment is unsupported.
    void operator=(const Iterator& other);

    const ParamGeneratorInterface* const base_;
    // begin[i]_ and end[i]_ define the i-th range that Iterator traverses.
    // current[i]_ is the actual traversing iterator.
    const typename ParamGenerator::iterator begin1_;
    const typename ParamGenerator::iterator end1_;
    typename ParamGenerator::iterator current1_;
    const typename ParamGenerator::iterator begin2_;
    const typename ParamGenerator::iterator end2_;
    typename ParamGenerator::iterator current2_;
    const typename ParamGenerator::iterator begin3_;
    const typename ParamGenerator::iterator end3_;
    typename ParamGenerator::iterator current3_;
    const typename ParamGenerator::iterator begin4_;
    const typename ParamGenerator::iterator end4_;
    typename ParamGenerator::iterator current4_;
    const typename ParamGenerator::iterator begin5_;
    const typename ParamGenerator::iterator end5_;
    typename ParamGenerator::iterator current5_;
    const typename ParamGenerator::iterator begin6_;
    const typename ParamGenerator::iterator end6_;
    typename ParamGenerator::iterator current6_;
    const typename ParamGenerator::iterator begin7_;
    const typename ParamGenerator::iterator end7_;
    typename ParamGenerator::iterator current7_;
    ParamType current_value_;
  };  // class CartesianProductGenerator7::Iterator

  // No implementation - assignment is unsupported.
  void operator=(const CartesianProductGenerator7& other);

  const ParamGenerator g1_;
  const ParamGenerator g2_;
  const ParamGenerator g3_;
  const ParamGenerator g4_;
  const ParamGenerator g5_;
  const ParamGenerator g6_;
  const ParamGenerator g7_;
};  // class CartesianProductGenerator7


template 
class CartesianProductGenerator8
    : public ParamGeneratorInterface< ::testing::tuple > {
 public:
  typedef ::testing::tuple ParamType;

  CartesianProductGenerator8(const ParamGenerator& g1,
      const ParamGenerator& g2, const ParamGenerator& g3,
      const ParamGenerator& g4, const ParamGenerator& g5,
      const ParamGenerator& g6, const ParamGenerator& g7,
      const ParamGenerator& g8)
      : g1_(g1), g2_(g2), g3_(g3), g4_(g4), g5_(g5), g6_(g6), g7_(g7),
          g8_(g8) {}
  virtual ~CartesianProductGenerator8() {}

  virtual ParamIteratorInterface* Begin() const {
    return new Iterator(this, g1_, g1_.begin(), g2_, g2_.begin(), g3_,
        g3_.begin(), g4_, g4_.begin(), g5_, g5_.begin(), g6_, g6_.begin(), g7_,
        g7_.begin(), g8_, g8_.begin());
  }
  virtual ParamIteratorInterface* End() const {
    return new Iterator(this, g1_, g1_.end(), g2_, g2_.end(), g3_, g3_.end(),
        g4_, g4_.end(), g5_, g5_.end(), g6_, g6_.end(), g7_, g7_.end(), g8_,
        g8_.end());
  }

 private:
  class Iterator : public ParamIteratorInterface {
   public:
    Iterator(const ParamGeneratorInterface* base,
      const ParamGenerator& g1,
      const typename ParamGenerator::iterator& current1,
      const ParamGenerator& g2,
      const typename ParamGenerator::iterator& current2,
      const ParamGenerator& g3,
      const typename ParamGenerator::iterator& current3,
      const ParamGenerator& g4,
      const typename ParamGenerator::iterator& current4,
      const ParamGenerator& g5,
      const typename ParamGenerator::iterator& current5,
      const ParamGenerator& g6,
      const typename ParamGenerator::iterator& current6,
      const ParamGenerator& g7,
      const typename ParamGenerator::iterator& current7,
      const ParamGenerator& g8,
      const typename ParamGenerator::iterator& current8)
        : base_(base),
          begin1_(g1.begin()), end1_(g1.end()), current1_(current1),
          begin2_(g2.begin()), end2_(g2.end()), current2_(current2),
          begin3_(g3.begin()), end3_(g3.end()), current3_(current3),
          begin4_(g4.begin()), end4_(g4.end()), current4_(current4),
          begin5_(g5.begin()), end5_(g5.end()), current5_(current5),
          begin6_(g6.begin()), end6_(g6.end()), current6_(current6),
          begin7_(g7.begin()), end7_(g7.end()), current7_(current7),
          begin8_(g8.begin()), end8_(g8.end()), current8_(current8)    {
      ComputeCurrentValue();
    }
    virtual ~Iterator() {}

    virtual const ParamGeneratorInterface* BaseGenerator() const {
      return base_;
    }
    // Advance should not be called on beyond-of-range iterators
    // so no component iterators must be beyond end of range, either.
    virtual void Advance() {
      assert(!AtEnd());
      ++current8_;
      if (current8_ == end8_) {
        current8_ = begin8_;
        ++current7_;
      }
      if (current7_ == end7_) {
        current7_ = begin7_;
        ++current6_;
      }
      if (current6_ == end6_) {
        current6_ = begin6_;
        ++current5_;
      }
      if (current5_ == end5_) {
        current5_ = begin5_;
        ++current4_;
      }
      if (current4_ == end4_) {
        current4_ = begin4_;
        ++current3_;
      }
      if (current3_ == end3_) {
        current3_ = begin3_;
        ++current2_;
      }
      if (current2_ == end2_) {
        current2_ = begin2_;
        ++current1_;
      }
      ComputeCurrentValue();
    }
    virtual ParamIteratorInterface* Clone() const {
      return new Iterator(*this);
    }
    virtual const ParamType* Current() const { return ¤t_value_; }
    virtual bool Equals(const ParamIteratorInterface& other) const {
      // Having the same base generator guarantees that the other
      // iterator is of the same type and we can downcast.
      GTEST_CHECK_(BaseGenerator() == other.BaseGenerator())
          << "The program attempted to compare iterators "
          << "from different generators." << std::endl;
      const Iterator* typed_other =
          CheckedDowncastToActualType(&other);
      // We must report iterators equal if they both point beyond their
      // respective ranges. That can happen in a variety of fashions,
      // so we have to consult AtEnd().
      return (AtEnd() && typed_other->AtEnd()) ||
         (
          current1_ == typed_other->current1_ &&
          current2_ == typed_other->current2_ &&
          current3_ == typed_other->current3_ &&
          current4_ == typed_other->current4_ &&
          current5_ == typed_other->current5_ &&
          current6_ == typed_other->current6_ &&
          current7_ == typed_other->current7_ &&
          current8_ == typed_other->current8_);
    }

   private:
    Iterator(const Iterator& other)
        : base_(other.base_),
        begin1_(other.begin1_),
        end1_(other.end1_),
        current1_(other.current1_),
        begin2_(other.begin2_),
        end2_(other.end2_),
        current2_(other.current2_),
        begin3_(other.begin3_),
        end3_(other.end3_),
        current3_(other.current3_),
        begin4_(other.begin4_),
        end4_(other.end4_),
        current4_(other.current4_),
        begin5_(other.begin5_),
        end5_(other.end5_),
        current5_(other.current5_),
        begin6_(other.begin6_),
        end6_(other.end6_),
        current6_(other.current6_),
        begin7_(other.begin7_),
        end7_(other.end7_),
        current7_(other.current7_),
        begin8_(other.begin8_),
        end8_(other.end8_),
        current8_(other.current8_) {
      ComputeCurrentValue();
    }

    void ComputeCurrentValue() {
      if (!AtEnd())
        current_value_ = ParamType(*current1_, *current2_, *current3_,
            *current4_, *current5_, *current6_, *current7_, *current8_);
    }
    bool AtEnd() const {
      // We must report iterator past the end of the range when either of the
      // component iterators has reached the end of its range.
      return
          current1_ == end1_ ||
          current2_ == end2_ ||
          current3_ == end3_ ||
          current4_ == end4_ ||
          current5_ == end5_ ||
          current6_ == end6_ ||
          current7_ == end7_ ||
          current8_ == end8_;
    }

    // No implementation - assignment is unsupported.
    void operator=(const Iterator& other);

    const ParamGeneratorInterface* const base_;
    // begin[i]_ and end[i]_ define the i-th range that Iterator traverses.
    // current[i]_ is the actual traversing iterator.
    const typename ParamGenerator::iterator begin1_;
    const typename ParamGenerator::iterator end1_;
    typename ParamGenerator::iterator current1_;
    const typename ParamGenerator::iterator begin2_;
    const typename ParamGenerator::iterator end2_;
    typename ParamGenerator::iterator current2_;
    const typename ParamGenerator::iterator begin3_;
    const typename ParamGenerator::iterator end3_;
    typename ParamGenerator::iterator current3_;
    const typename ParamGenerator::iterator begin4_;
    const typename ParamGenerator::iterator end4_;
    typename ParamGenerator::iterator current4_;
    const typename ParamGenerator::iterator begin5_;
    const typename ParamGenerator::iterator end5_;
    typename ParamGenerator::iterator current5_;
    const typename ParamGenerator::iterator begin6_;
    const typename ParamGenerator::iterator end6_;
    typename ParamGenerator::iterator current6_;
    const typename ParamGenerator::iterator begin7_;
    const typename ParamGenerator::iterator end7_;
    typename ParamGenerator::iterator current7_;
    const typename ParamGenerator::iterator begin8_;
    const typename ParamGenerator::iterator end8_;
    typename ParamGenerator::iterator current8_;
    ParamType current_value_;
  };  // class CartesianProductGenerator8::Iterator

  // No implementation - assignment is unsupported.
  void operator=(const CartesianProductGenerator8& other);

  const ParamGenerator g1_;
  const ParamGenerator g2_;
  const ParamGenerator g3_;
  const ParamGenerator g4_;
  const ParamGenerator g5_;
  const ParamGenerator g6_;
  const ParamGenerator g7_;
  const ParamGenerator g8_;
};  // class CartesianProductGenerator8


template 
class CartesianProductGenerator9
    : public ParamGeneratorInterface< ::testing::tuple > {
 public:
  typedef ::testing::tuple ParamType;

  CartesianProductGenerator9(const ParamGenerator& g1,
      const ParamGenerator& g2, const ParamGenerator& g3,
      const ParamGenerator& g4, const ParamGenerator& g5,
      const ParamGenerator& g6, const ParamGenerator& g7,
      const ParamGenerator& g8, const ParamGenerator& g9)
      : g1_(g1), g2_(g2), g3_(g3), g4_(g4), g5_(g5), g6_(g6), g7_(g7), g8_(g8),
          g9_(g9) {}
  virtual ~CartesianProductGenerator9() {}

  virtual ParamIteratorInterface* Begin() const {
    return new Iterator(this, g1_, g1_.begin(), g2_, g2_.begin(), g3_,
        g3_.begin(), g4_, g4_.begin(), g5_, g5_.begin(), g6_, g6_.begin(), g7_,
        g7_.begin(), g8_, g8_.begin(), g9_, g9_.begin());
  }
  virtual ParamIteratorInterface* End() const {
    return new Iterator(this, g1_, g1_.end(), g2_, g2_.end(), g3_, g3_.end(),
        g4_, g4_.end(), g5_, g5_.end(), g6_, g6_.end(), g7_, g7_.end(), g8_,
        g8_.end(), g9_, g9_.end());
  }

 private:
  class Iterator : public ParamIteratorInterface {
   public:
    Iterator(const ParamGeneratorInterface* base,
      const ParamGenerator& g1,
      const typename ParamGenerator::iterator& current1,
      const ParamGenerator& g2,
      const typename ParamGenerator::iterator& current2,
      const ParamGenerator& g3,
      const typename ParamGenerator::iterator& current3,
      const ParamGenerator& g4,
      const typename ParamGenerator::iterator& current4,
      const ParamGenerator& g5,
      const typename ParamGenerator::iterator& current5,
      const ParamGenerator& g6,
      const typename ParamGenerator::iterator& current6,
      const ParamGenerator& g7,
      const typename ParamGenerator::iterator& current7,
      const ParamGenerator& g8,
      const typename ParamGenerator::iterator& current8,
      const ParamGenerator& g9,
      const typename ParamGenerator::iterator& current9)
        : base_(base),
          begin1_(g1.begin()), end1_(g1.end()), current1_(current1),
          begin2_(g2.begin()), end2_(g2.end()), current2_(current2),
          begin3_(g3.begin()), end3_(g3.end()), current3_(current3),
          begin4_(g4.begin()), end4_(g4.end()), current4_(current4),
          begin5_(g5.begin()), end5_(g5.end()), current5_(current5),
          begin6_(g6.begin()), end6_(g6.end()), current6_(current6),
          begin7_(g7.begin()), end7_(g7.end()), current7_(current7),
          begin8_(g8.begin()), end8_(g8.end()), current8_(current8),
          begin9_(g9.begin()), end9_(g9.end()), current9_(current9)    {
      ComputeCurrentValue();
    }
    virtual ~Iterator() {}

    virtual const ParamGeneratorInterface* BaseGenerator() const {
      return base_;
    }
    // Advance should not be called on beyond-of-range iterators
    // so no component iterators must be beyond end of range, either.
    virtual void Advance() {
      assert(!AtEnd());
      ++current9_;
      if (current9_ == end9_) {
        current9_ = begin9_;
        ++current8_;
      }
      if (current8_ == end8_) {
        current8_ = begin8_;
        ++current7_;
      }
      if (current7_ == end7_) {
        current7_ = begin7_;
        ++current6_;
      }
      if (current6_ == end6_) {
        current6_ = begin6_;
        ++current5_;
      }
      if (current5_ == end5_) {
        current5_ = begin5_;
        ++current4_;
      }
      if (current4_ == end4_) {
        current4_ = begin4_;
        ++current3_;
      }
      if (current3_ == end3_) {
        current3_ = begin3_;
        ++current2_;
      }
      if (current2_ == end2_) {
        current2_ = begin2_;
        ++current1_;
      }
      ComputeCurrentValue();
    }
    virtual ParamIteratorInterface* Clone() const {
      return new Iterator(*this);
    }
    virtual const ParamType* Current() const { return ¤t_value_; }
    virtual bool Equals(const ParamIteratorInterface& other) const {
      // Having the same base generator guarantees that the other
      // iterator is of the same type and we can downcast.
      GTEST_CHECK_(BaseGenerator() == other.BaseGenerator())
          << "The program attempted to compare iterators "
          << "from different generators." << std::endl;
      const Iterator* typed_other =
          CheckedDowncastToActualType(&other);
      // We must report iterators equal if they both point beyond their
      // respective ranges. That can happen in a variety of fashions,
      // so we have to consult AtEnd().
      return (AtEnd() && typed_other->AtEnd()) ||
         (
          current1_ == typed_other->current1_ &&
          current2_ == typed_other->current2_ &&
          current3_ == typed_other->current3_ &&
          current4_ == typed_other->current4_ &&
          current5_ == typed_other->current5_ &&
          current6_ == typed_other->current6_ &&
          current7_ == typed_other->current7_ &&
          current8_ == typed_other->current8_ &&
          current9_ == typed_other->current9_);
    }

   private:
    Iterator(const Iterator& other)
        : base_(other.base_),
        begin1_(other.begin1_),
        end1_(other.end1_),
        current1_(other.current1_),
        begin2_(other.begin2_),
        end2_(other.end2_),
        current2_(other.current2_),
        begin3_(other.begin3_),
        end3_(other.end3_),
        current3_(other.current3_),
        begin4_(other.begin4_),
        end4_(other.end4_),
        current4_(other.current4_),
        begin5_(other.begin5_),
        end5_(other.end5_),
        current5_(other.current5_),
        begin6_(other.begin6_),
        end6_(other.end6_),
        current6_(other.current6_),
        begin7_(other.begin7_),
        end7_(other.end7_),
        current7_(other.current7_),
        begin8_(other.begin8_),
        end8_(other.end8_),
        current8_(other.current8_),
        begin9_(other.begin9_),
        end9_(other.end9_),
        current9_(other.current9_) {
      ComputeCurrentValue();
    }

    void ComputeCurrentValue() {
      if (!AtEnd())
        current_value_ = ParamType(*current1_, *current2_, *current3_,
            *current4_, *current5_, *current6_, *current7_, *current8_,
            *current9_);
    }
    bool AtEnd() const {
      // We must report iterator past the end of the range when either of the
      // component iterators has reached the end of its range.
      return
          current1_ == end1_ ||
          current2_ == end2_ ||
          current3_ == end3_ ||
          current4_ == end4_ ||
          current5_ == end5_ ||
          current6_ == end6_ ||
          current7_ == end7_ ||
          current8_ == end8_ ||
          current9_ == end9_;
    }

    // No implementation - assignment is unsupported.
    void operator=(const Iterator& other);

    const ParamGeneratorInterface* const base_;
    // begin[i]_ and end[i]_ define the i-th range that Iterator traverses.
    // current[i]_ is the actual traversing iterator.
    const typename ParamGenerator::iterator begin1_;
    const typename ParamGenerator::iterator end1_;
    typename ParamGenerator::iterator current1_;
    const typename ParamGenerator::iterator begin2_;
    const typename ParamGenerator::iterator end2_;
    typename ParamGenerator::iterator current2_;
    const typename ParamGenerator::iterator begin3_;
    const typename ParamGenerator::iterator end3_;
    typename ParamGenerator::iterator current3_;
    const typename ParamGenerator::iterator begin4_;
    const typename ParamGenerator::iterator end4_;
    typename ParamGenerator::iterator current4_;
    const typename ParamGenerator::iterator begin5_;
    const typename ParamGenerator::iterator end5_;
    typename ParamGenerator::iterator current5_;
    const typename ParamGenerator::iterator begin6_;
    const typename ParamGenerator::iterator end6_;
    typename ParamGenerator::iterator current6_;
    const typename ParamGenerator::iterator begin7_;
    const typename ParamGenerator::iterator end7_;
    typename ParamGenerator::iterator current7_;
    const typename ParamGenerator::iterator begin8_;
    const typename ParamGenerator::iterator end8_;
    typename ParamGenerator::iterator current8_;
    const typename ParamGenerator::iterator begin9_;
    const typename ParamGenerator::iterator end9_;
    typename ParamGenerator::iterator current9_;
    ParamType current_value_;
  };  // class CartesianProductGenerator9::Iterator

  // No implementation - assignment is unsupported.
  void operator=(const CartesianProductGenerator9& other);

  const ParamGenerator g1_;
  const ParamGenerator g2_;
  const ParamGenerator g3_;
  const ParamGenerator g4_;
  const ParamGenerator g5_;
  const ParamGenerator g6_;
  const ParamGenerator g7_;
  const ParamGenerator g8_;
  const ParamGenerator g9_;
};  // class CartesianProductGenerator9


template 
class CartesianProductGenerator10
    : public ParamGeneratorInterface< ::testing::tuple > {
 public:
  typedef ::testing::tuple ParamType;

  CartesianProductGenerator10(const ParamGenerator& g1,
      const ParamGenerator& g2, const ParamGenerator& g3,
      const ParamGenerator& g4, const ParamGenerator& g5,
      const ParamGenerator& g6, const ParamGenerator& g7,
      const ParamGenerator& g8, const ParamGenerator& g9,
      const ParamGenerator& g10)
      : g1_(g1), g2_(g2), g3_(g3), g4_(g4), g5_(g5), g6_(g6), g7_(g7), g8_(g8),
          g9_(g9), g10_(g10) {}
  virtual ~CartesianProductGenerator10() {}

  virtual ParamIteratorInterface* Begin() const {
    return new Iterator(this, g1_, g1_.begin(), g2_, g2_.begin(), g3_,
        g3_.begin(), g4_, g4_.begin(), g5_, g5_.begin(), g6_, g6_.begin(), g7_,
        g7_.begin(), g8_, g8_.begin(), g9_, g9_.begin(), g10_, g10_.begin());
  }
  virtual ParamIteratorInterface* End() const {
    return new Iterator(this, g1_, g1_.end(), g2_, g2_.end(), g3_, g3_.end(),
        g4_, g4_.end(), g5_, g5_.end(), g6_, g6_.end(), g7_, g7_.end(), g8_,
        g8_.end(), g9_, g9_.end(), g10_, g10_.end());
  }

 private:
  class Iterator : public ParamIteratorInterface {
   public:
    Iterator(const ParamGeneratorInterface* base,
      const ParamGenerator& g1,
      const typename ParamGenerator::iterator& current1,
      const ParamGenerator& g2,
      const typename ParamGenerator::iterator& current2,
      const ParamGenerator& g3,
      const typename ParamGenerator::iterator& current3,
      const ParamGenerator& g4,
      const typename ParamGenerator::iterator& current4,
      const ParamGenerator& g5,
      const typename ParamGenerator::iterator& current5,
      const ParamGenerator& g6,
      const typename ParamGenerator::iterator& current6,
      const ParamGenerator& g7,
      const typename ParamGenerator::iterator& current7,
      const ParamGenerator& g8,
      const typename ParamGenerator::iterator& current8,
      const ParamGenerator& g9,
      const typename ParamGenerator::iterator& current9,
      const ParamGenerator& g10,
      const typename ParamGenerator::iterator& current10)
        : base_(base),
          begin1_(g1.begin()), end1_(g1.end()), current1_(current1),
          begin2_(g2.begin()), end2_(g2.end()), current2_(current2),
          begin3_(g3.begin()), end3_(g3.end()), current3_(current3),
          begin4_(g4.begin()), end4_(g4.end()), current4_(current4),
          begin5_(g5.begin()), end5_(g5.end()), current5_(current5),
          begin6_(g6.begin()), end6_(g6.end()), current6_(current6),
          begin7_(g7.begin()), end7_(g7.end()), current7_(current7),
          begin8_(g8.begin()), end8_(g8.end()), current8_(current8),
          begin9_(g9.begin()), end9_(g9.end()), current9_(current9),
          begin10_(g10.begin()), end10_(g10.end()), current10_(current10)    {
      ComputeCurrentValue();
    }
    virtual ~Iterator() {}

    virtual const ParamGeneratorInterface* BaseGenerator() const {
      return base_;
    }
    // Advance should not be called on beyond-of-range iterators
    // so no component iterators must be beyond end of range, either.
    virtual void Advance() {
      assert(!AtEnd());
      ++current10_;
      if (current10_ == end10_) {
        current10_ = begin10_;
        ++current9_;
      }
      if (current9_ == end9_) {
        current9_ = begin9_;
        ++current8_;
      }
      if (current8_ == end8_) {
        current8_ = begin8_;
        ++current7_;
      }
      if (current7_ == end7_) {
        current7_ = begin7_;
        ++current6_;
      }
      if (current6_ == end6_) {
        current6_ = begin6_;
        ++current5_;
      }
      if (current5_ == end5_) {
        current5_ = begin5_;
        ++current4_;
      }
      if (current4_ == end4_) {
        current4_ = begin4_;
        ++current3_;
      }
      if (current3_ == end3_) {
        current3_ = begin3_;
        ++current2_;
      }
      if (current2_ == end2_) {
        current2_ = begin2_;
        ++current1_;
      }
      ComputeCurrentValue();
    }
    virtual ParamIteratorInterface* Clone() const {
      return new Iterator(*this);
    }
    virtual const ParamType* Current() const { return ¤t_value_; }
    virtual bool Equals(const ParamIteratorInterface& other) const {
      // Having the same base generator guarantees that the other
      // iterator is of the same type and we can downcast.
      GTEST_CHECK_(BaseGenerator() == other.BaseGenerator())
          << "The program attempted to compare iterators "
          << "from different generators." << std::endl;
      const Iterator* typed_other =
          CheckedDowncastToActualType(&other);
      // We must report iterators equal if they both point beyond their
      // respective ranges. That can happen in a variety of fashions,
      // so we have to consult AtEnd().
      return (AtEnd() && typed_other->AtEnd()) ||
         (
          current1_ == typed_other->current1_ &&
          current2_ == typed_other->current2_ &&
          current3_ == typed_other->current3_ &&
          current4_ == typed_other->current4_ &&
          current5_ == typed_other->current5_ &&
          current6_ == typed_other->current6_ &&
          current7_ == typed_other->current7_ &&
          current8_ == typed_other->current8_ &&
          current9_ == typed_other->current9_ &&
          current10_ == typed_other->current10_);
    }

   private:
    Iterator(const Iterator& other)
        : base_(other.base_),
        begin1_(other.begin1_),
        end1_(other.end1_),
        current1_(other.current1_),
        begin2_(other.begin2_),
        end2_(other.end2_),
        current2_(other.current2_),
        begin3_(other.begin3_),
        end3_(other.end3_),
        current3_(other.current3_),
        begin4_(other.begin4_),
        end4_(other.end4_),
        current4_(other.current4_),
        begin5_(other.begin5_),
        end5_(other.end5_),
        current5_(other.current5_),
        begin6_(other.begin6_),
        end6_(other.end6_),
        current6_(other.current6_),
        begin7_(other.begin7_),
        end7_(other.end7_),
        current7_(other.current7_),
        begin8_(other.begin8_),
        end8_(other.end8_),
        current8_(other.current8_),
        begin9_(other.begin9_),
        end9_(other.end9_),
        current9_(other.current9_),
        begin10_(other.begin10_),
        end10_(other.end10_),
        current10_(other.current10_) {
      ComputeCurrentValue();
    }

    void ComputeCurrentValue() {
      if (!AtEnd())
        current_value_ = ParamType(*current1_, *current2_, *current3_,
            *current4_, *current5_, *current6_, *current7_, *current8_,
            *current9_, *current10_);
    }
    bool AtEnd() const {
      // We must report iterator past the end of the range when either of the
      // component iterators has reached the end of its range.
      return
          current1_ == end1_ ||
          current2_ == end2_ ||
          current3_ == end3_ ||
          current4_ == end4_ ||
          current5_ == end5_ ||
          current6_ == end6_ ||
          current7_ == end7_ ||
          current8_ == end8_ ||
          current9_ == end9_ ||
          current10_ == end10_;
    }

    // No implementation - assignment is unsupported.
    void operator=(const Iterator& other);

    const ParamGeneratorInterface* const base_;
    // begin[i]_ and end[i]_ define the i-th range that Iterator traverses.
    // current[i]_ is the actual traversing iterator.
    const typename ParamGenerator::iterator begin1_;
    const typename ParamGenerator::iterator end1_;
    typename ParamGenerator::iterator current1_;
    const typename ParamGenerator::iterator begin2_;
    const typename ParamGenerator::iterator end2_;
    typename ParamGenerator::iterator current2_;
    const typename ParamGenerator::iterator begin3_;
    const typename ParamGenerator::iterator end3_;
    typename ParamGenerator::iterator current3_;
    const typename ParamGenerator::iterator begin4_;
    const typename ParamGenerator::iterator end4_;
    typename ParamGenerator::iterator current4_;
    const typename ParamGenerator::iterator begin5_;
    const typename ParamGenerator::iterator end5_;
    typename ParamGenerator::iterator current5_;
    const typename ParamGenerator::iterator begin6_;
    const typename ParamGenerator::iterator end6_;
    typename ParamGenerator::iterator current6_;
    const typename ParamGenerator::iterator begin7_;
    const typename ParamGenerator::iterator end7_;
    typename ParamGenerator::iterator current7_;
    const typename ParamGenerator::iterator begin8_;
    const typename ParamGenerator::iterator end8_;
    typename ParamGenerator::iterator current8_;
    const typename ParamGenerator::iterator begin9_;
    const typename ParamGenerator::iterator end9_;
    typename ParamGenerator::iterator current9_;
    const typename ParamGenerator::iterator begin10_;
    const typename ParamGenerator::iterator end10_;
    typename ParamGenerator::iterator current10_;
    ParamType current_value_;
  };  // class CartesianProductGenerator10::Iterator

  // No implementation - assignment is unsupported.
  void operator=(const CartesianProductGenerator10& other);

  const ParamGenerator g1_;
  const ParamGenerator g2_;
  const ParamGenerator g3_;
  const ParamGenerator g4_;
  const ParamGenerator g5_;
  const ParamGenerator g6_;
  const ParamGenerator g7_;
  const ParamGenerator g8_;
  const ParamGenerator g9_;
  const ParamGenerator g10_;
};  // class CartesianProductGenerator10


// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE.
//
// Helper classes providing Combine() with polymorphic features. They allow
// casting CartesianProductGeneratorN to ParamGenerator if T is
// convertible to U.
//
template 
class CartesianProductHolder2 {
 public:
CartesianProductHolder2(const Generator1& g1, const Generator2& g2)
      : g1_(g1), g2_(g2) {}
  template 
  operator ParamGenerator< ::testing::tuple >() const {
    return ParamGenerator< ::testing::tuple >(
        new CartesianProductGenerator2(
        static_cast >(g1_),
        static_cast >(g2_)));
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const CartesianProductHolder2& other);

  const Generator1 g1_;
  const Generator2 g2_;
};  // class CartesianProductHolder2

template 
class CartesianProductHolder3 {
 public:
CartesianProductHolder3(const Generator1& g1, const Generator2& g2,
    const Generator3& g3)
      : g1_(g1), g2_(g2), g3_(g3) {}
  template 
  operator ParamGenerator< ::testing::tuple >() const {
    return ParamGenerator< ::testing::tuple >(
        new CartesianProductGenerator3(
        static_cast >(g1_),
        static_cast >(g2_),
        static_cast >(g3_)));
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const CartesianProductHolder3& other);

  const Generator1 g1_;
  const Generator2 g2_;
  const Generator3 g3_;
};  // class CartesianProductHolder3

template 
class CartesianProductHolder4 {
 public:
CartesianProductHolder4(const Generator1& g1, const Generator2& g2,
    const Generator3& g3, const Generator4& g4)
      : g1_(g1), g2_(g2), g3_(g3), g4_(g4) {}
  template 
  operator ParamGenerator< ::testing::tuple >() const {
    return ParamGenerator< ::testing::tuple >(
        new CartesianProductGenerator4(
        static_cast >(g1_),
        static_cast >(g2_),
        static_cast >(g3_),
        static_cast >(g4_)));
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const CartesianProductHolder4& other);

  const Generator1 g1_;
  const Generator2 g2_;
  const Generator3 g3_;
  const Generator4 g4_;
};  // class CartesianProductHolder4

template 
class CartesianProductHolder5 {
 public:
CartesianProductHolder5(const Generator1& g1, const Generator2& g2,
    const Generator3& g3, const Generator4& g4, const Generator5& g5)
      : g1_(g1), g2_(g2), g3_(g3), g4_(g4), g5_(g5) {}
  template 
  operator ParamGenerator< ::testing::tuple >() const {
    return ParamGenerator< ::testing::tuple >(
        new CartesianProductGenerator5(
        static_cast >(g1_),
        static_cast >(g2_),
        static_cast >(g3_),
        static_cast >(g4_),
        static_cast >(g5_)));
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const CartesianProductHolder5& other);

  const Generator1 g1_;
  const Generator2 g2_;
  const Generator3 g3_;
  const Generator4 g4_;
  const Generator5 g5_;
};  // class CartesianProductHolder5

template 
class CartesianProductHolder6 {
 public:
CartesianProductHolder6(const Generator1& g1, const Generator2& g2,
    const Generator3& g3, const Generator4& g4, const Generator5& g5,
    const Generator6& g6)
      : g1_(g1), g2_(g2), g3_(g3), g4_(g4), g5_(g5), g6_(g6) {}
  template 
  operator ParamGenerator< ::testing::tuple >() const {
    return ParamGenerator< ::testing::tuple >(
        new CartesianProductGenerator6(
        static_cast >(g1_),
        static_cast >(g2_),
        static_cast >(g3_),
        static_cast >(g4_),
        static_cast >(g5_),
        static_cast >(g6_)));
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const CartesianProductHolder6& other);

  const Generator1 g1_;
  const Generator2 g2_;
  const Generator3 g3_;
  const Generator4 g4_;
  const Generator5 g5_;
  const Generator6 g6_;
};  // class CartesianProductHolder6

template 
class CartesianProductHolder7 {
 public:
CartesianProductHolder7(const Generator1& g1, const Generator2& g2,
    const Generator3& g3, const Generator4& g4, const Generator5& g5,
    const Generator6& g6, const Generator7& g7)
      : g1_(g1), g2_(g2), g3_(g3), g4_(g4), g5_(g5), g6_(g6), g7_(g7) {}
  template 
  operator ParamGenerator< ::testing::tuple >() const {
    return ParamGenerator< ::testing::tuple >(
        new CartesianProductGenerator7(
        static_cast >(g1_),
        static_cast >(g2_),
        static_cast >(g3_),
        static_cast >(g4_),
        static_cast >(g5_),
        static_cast >(g6_),
        static_cast >(g7_)));
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const CartesianProductHolder7& other);

  const Generator1 g1_;
  const Generator2 g2_;
  const Generator3 g3_;
  const Generator4 g4_;
  const Generator5 g5_;
  const Generator6 g6_;
  const Generator7 g7_;
};  // class CartesianProductHolder7

template 
class CartesianProductHolder8 {
 public:
CartesianProductHolder8(const Generator1& g1, const Generator2& g2,
    const Generator3& g3, const Generator4& g4, const Generator5& g5,
    const Generator6& g6, const Generator7& g7, const Generator8& g8)
      : g1_(g1), g2_(g2), g3_(g3), g4_(g4), g5_(g5), g6_(g6), g7_(g7),
          g8_(g8) {}
  template 
  operator ParamGenerator< ::testing::tuple >() const {
    return ParamGenerator< ::testing::tuple >(
        new CartesianProductGenerator8(
        static_cast >(g1_),
        static_cast >(g2_),
        static_cast >(g3_),
        static_cast >(g4_),
        static_cast >(g5_),
        static_cast >(g6_),
        static_cast >(g7_),
        static_cast >(g8_)));
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const CartesianProductHolder8& other);

  const Generator1 g1_;
  const Generator2 g2_;
  const Generator3 g3_;
  const Generator4 g4_;
  const Generator5 g5_;
  const Generator6 g6_;
  const Generator7 g7_;
  const Generator8 g8_;
};  // class CartesianProductHolder8

template 
class CartesianProductHolder9 {
 public:
CartesianProductHolder9(const Generator1& g1, const Generator2& g2,
    const Generator3& g3, const Generator4& g4, const Generator5& g5,
    const Generator6& g6, const Generator7& g7, const Generator8& g8,
    const Generator9& g9)
      : g1_(g1), g2_(g2), g3_(g3), g4_(g4), g5_(g5), g6_(g6), g7_(g7), g8_(g8),
          g9_(g9) {}
  template 
  operator ParamGenerator< ::testing::tuple >() const {
    return ParamGenerator< ::testing::tuple >(
        new CartesianProductGenerator9(
        static_cast >(g1_),
        static_cast >(g2_),
        static_cast >(g3_),
        static_cast >(g4_),
        static_cast >(g5_),
        static_cast >(g6_),
        static_cast >(g7_),
        static_cast >(g8_),
        static_cast >(g9_)));
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const CartesianProductHolder9& other);

  const Generator1 g1_;
  const Generator2 g2_;
  const Generator3 g3_;
  const Generator4 g4_;
  const Generator5 g5_;
  const Generator6 g6_;
  const Generator7 g7_;
  const Generator8 g8_;
  const Generator9 g9_;
};  // class CartesianProductHolder9

template 
class CartesianProductHolder10 {
 public:
CartesianProductHolder10(const Generator1& g1, const Generator2& g2,
    const Generator3& g3, const Generator4& g4, const Generator5& g5,
    const Generator6& g6, const Generator7& g7, const Generator8& g8,
    const Generator9& g9, const Generator10& g10)
      : g1_(g1), g2_(g2), g3_(g3), g4_(g4), g5_(g5), g6_(g6), g7_(g7), g8_(g8),
          g9_(g9), g10_(g10) {}
  template 
  operator ParamGenerator< ::testing::tuple >() const {
    return ParamGenerator< ::testing::tuple >(
        new CartesianProductGenerator10(
        static_cast >(g1_),
        static_cast >(g2_),
        static_cast >(g3_),
        static_cast >(g4_),
        static_cast >(g5_),
        static_cast >(g6_),
        static_cast >(g7_),
        static_cast >(g8_),
        static_cast >(g9_),
        static_cast >(g10_)));
  }

 private:
  // No implementation - assignment is unsupported.
  void operator=(const CartesianProductHolder10& other);

  const Generator1 g1_;
  const Generator2 g2_;
  const Generator3 g3_;
  const Generator4 g4_;
  const Generator5 g5_;
  const Generator6 g6_;
  const Generator7 g7_;
  const Generator8 g8_;
  const Generator9 g9_;
  const Generator10 g10_;
};  // class CartesianProductHolder10

# endif  // GTEST_HAS_COMBINE

}  // namespace internal
}  // namespace testing

#endif  //  GTEST_HAS_PARAM_TEST

#endif  // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PARAM_UTIL_GENERATED_H_
node-v4.8.2/deps/gtest/include/gtest/internal/gtest-param-util.h000644 000766 000024 00000057177 13070706730 025012 0ustar00iojsstaff000000 000000 // Copyright 2008 Google Inc.
// All Rights Reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Author: vladl@google.com (Vlad Losev)

// Type and function utilities for implementing parameterized tests.

#ifndef GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PARAM_UTIL_H_
#define GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PARAM_UTIL_H_

#include 
#include 
#include 

// scripts/fuse_gtest.py depends on gtest's own header being #included
// *unconditionally*.  Therefore these #includes cannot be moved
// inside #if GTEST_HAS_PARAM_TEST.
#include "gtest/internal/gtest-internal.h"
#include "gtest/internal/gtest-linked_ptr.h"
#include "gtest/internal/gtest-port.h"
#include "gtest/gtest-printers.h"

#if GTEST_HAS_PARAM_TEST

namespace testing {
namespace internal {

// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE.
//
// Outputs a message explaining invalid registration of different
// fixture class for the same test case. This may happen when
// TEST_P macro is used to define two tests with the same name
// but in different namespaces.
GTEST_API_ void ReportInvalidTestCaseType(const char* test_case_name,
                                          const char* file, int line);

template  class ParamGeneratorInterface;
template  class ParamGenerator;

// Interface for iterating over elements provided by an implementation
// of ParamGeneratorInterface.
template 
class ParamIteratorInterface {
 public:
  virtual ~ParamIteratorInterface() {}
  // A pointer to the base generator instance.
  // Used only for the purposes of iterator comparison
  // to make sure that two iterators belong to the same generator.
  virtual const ParamGeneratorInterface* BaseGenerator() const = 0;
  // Advances iterator to point to the next element
  // provided by the generator. The caller is responsible
  // for not calling Advance() on an iterator equal to
  // BaseGenerator()->End().
  virtual void Advance() = 0;
  // Clones the iterator object. Used for implementing copy semantics
  // of ParamIterator.
  virtual ParamIteratorInterface* Clone() const = 0;
  // Dereferences the current iterator and provides (read-only) access
  // to the pointed value. It is the caller's responsibility not to call
  // Current() on an iterator equal to BaseGenerator()->End().
  // Used for implementing ParamGenerator::operator*().
  virtual const T* Current() const = 0;
  // Determines whether the given iterator and other point to the same
  // element in the sequence generated by the generator.
  // Used for implementing ParamGenerator::operator==().
  virtual bool Equals(const ParamIteratorInterface& other) const = 0;
};

// Class iterating over elements provided by an implementation of
// ParamGeneratorInterface. It wraps ParamIteratorInterface
// and implements the const forward iterator concept.
template 
class ParamIterator {
 public:
  typedef T value_type;
  typedef const T& reference;
  typedef ptrdiff_t difference_type;

  // ParamIterator assumes ownership of the impl_ pointer.
  ParamIterator(const ParamIterator& other) : impl_(other.impl_->Clone()) {}
  ParamIterator& operator=(const ParamIterator& other) {
    if (this != &other)
      impl_.reset(other.impl_->Clone());
    return *this;
  }

  const T& operator*() const { return *impl_->Current(); }
  const T* operator->() const { return impl_->Current(); }
  // Prefix version of operator++.
  ParamIterator& operator++() {
    impl_->Advance();
    return *this;
  }
  // Postfix version of operator++.
  ParamIterator operator++(int /*unused*/) {
    ParamIteratorInterface* clone = impl_->Clone();
    impl_->Advance();
    return ParamIterator(clone);
  }
  bool operator==(const ParamIterator& other) const {
    return impl_.get() == other.impl_.get() || impl_->Equals(*other.impl_);
  }
  bool operator!=(const ParamIterator& other) const {
    return !(*this == other);
  }

 private:
  friend class ParamGenerator;
  explicit ParamIterator(ParamIteratorInterface* impl) : impl_(impl) {}
  scoped_ptr > impl_;
};

// ParamGeneratorInterface is the binary interface to access generators
// defined in other translation units.
template 
class ParamGeneratorInterface {
 public:
  typedef T ParamType;

  virtual ~ParamGeneratorInterface() {}

  // Generator interface definition
  virtual ParamIteratorInterface* Begin() const = 0;
  virtual ParamIteratorInterface* End() const = 0;
};

// Wraps ParamGeneratorInterface and provides general generator syntax
// compatible with the STL Container concept.
// This class implements copy initialization semantics and the contained
// ParamGeneratorInterface instance is shared among all copies
// of the original object. This is possible because that instance is immutable.
template
class ParamGenerator {
 public:
  typedef ParamIterator iterator;

  explicit ParamGenerator(ParamGeneratorInterface* impl) : impl_(impl) {}
  ParamGenerator(const ParamGenerator& other) : impl_(other.impl_) {}

  ParamGenerator& operator=(const ParamGenerator& other) {
    impl_ = other.impl_;
    return *this;
  }

  iterator begin() const { return iterator(impl_->Begin()); }
  iterator end() const { return iterator(impl_->End()); }

 private:
  linked_ptr > impl_;
};

// Generates values from a range of two comparable values. Can be used to
// generate sequences of user-defined types that implement operator+() and
// operator<().
// This class is used in the Range() function.
template 
class RangeGenerator : public ParamGeneratorInterface {
 public:
  RangeGenerator(T begin, T end, IncrementT step)
      : begin_(begin), end_(end),
        step_(step), end_index_(CalculateEndIndex(begin, end, step)) {}
  virtual ~RangeGenerator() {}

  virtual ParamIteratorInterface* Begin() const {
    return new Iterator(this, begin_, 0, step_);
  }
  virtual ParamIteratorInterface* End() const {
    return new Iterator(this, end_, end_index_, step_);
  }

 private:
  class Iterator : public ParamIteratorInterface {
   public:
    Iterator(const ParamGeneratorInterface* base, T value, int index,
             IncrementT step)
        : base_(base), value_(value), index_(index), step_(step) {}
    virtual ~Iterator() {}

    virtual const ParamGeneratorInterface* BaseGenerator() const {
      return base_;
    }
    virtual void Advance() {
      value_ = value_ + step_;
      index_++;
    }
    virtual ParamIteratorInterface* Clone() const {
      return new Iterator(*this);
    }
    virtual const T* Current() const { return &value_; }
    virtual bool Equals(const ParamIteratorInterface& other) const {
      // Having the same base generator guarantees that the other
      // iterator is of the same type and we can downcast.
      GTEST_CHECK_(BaseGenerator() == other.BaseGenerator())
          << "The program attempted to compare iterators "
          << "from different generators." << std::endl;
      const int other_index =
          CheckedDowncastToActualType(&other)->index_;
      return index_ == other_index;
    }

   private:
    Iterator(const Iterator& other)
        : ParamIteratorInterface(),
          base_(other.base_), value_(other.value_), index_(other.index_),
          step_(other.step_) {}

    // No implementation - assignment is unsupported.
    void operator=(const Iterator& other);

    const ParamGeneratorInterface* const base_;
    T value_;
    int index_;
    const IncrementT step_;
  };  // class RangeGenerator::Iterator

  static int CalculateEndIndex(const T& begin,
                               const T& end,
                               const IncrementT& step) {
    int end_index = 0;
    for (T i = begin; i < end; i = i + step)
      end_index++;
    return end_index;
  }

  // No implementation - assignment is unsupported.
  void operator=(const RangeGenerator& other);

  const T begin_;
  const T end_;
  const IncrementT step_;
  // The index for the end() iterator. All the elements in the generated
  // sequence are indexed (0-based) to aid iterator comparison.
  const int end_index_;
};  // class RangeGenerator


// Generates values from a pair of STL-style iterators. Used in the
// ValuesIn() function. The elements are copied from the source range
// since the source can be located on the stack, and the generator
// is likely to persist beyond that stack frame.
template 
class ValuesInIteratorRangeGenerator : public ParamGeneratorInterface {
 public:
  template 
  ValuesInIteratorRangeGenerator(ForwardIterator begin, ForwardIterator end)
      : container_(begin, end) {}
  virtual ~ValuesInIteratorRangeGenerator() {}

  virtual ParamIteratorInterface* Begin() const {
    return new Iterator(this, container_.begin());
  }
  virtual ParamIteratorInterface* End() const {
    return new Iterator(this, container_.end());
  }

 private:
  typedef typename ::std::vector ContainerType;

  class Iterator : public ParamIteratorInterface {
   public:
    Iterator(const ParamGeneratorInterface* base,
             typename ContainerType::const_iterator iterator)
        : base_(base), iterator_(iterator) {}
    virtual ~Iterator() {}

    virtual const ParamGeneratorInterface* BaseGenerator() const {
      return base_;
    }
    virtual void Advance() {
      ++iterator_;
      value_.reset();
    }
    virtual ParamIteratorInterface* Clone() const {
      return new Iterator(*this);
    }
    // We need to use cached value referenced by iterator_ because *iterator_
    // can return a temporary object (and of type other then T), so just
    // having "return &*iterator_;" doesn't work.
    // value_ is updated here and not in Advance() because Advance()
    // can advance iterator_ beyond the end of the range, and we cannot
    // detect that fact. The client code, on the other hand, is
    // responsible for not calling Current() on an out-of-range iterator.
    virtual const T* Current() const {
      if (value_.get() == NULL)
        value_.reset(new T(*iterator_));
      return value_.get();
    }
    virtual bool Equals(const ParamIteratorInterface& other) const {
      // Having the same base generator guarantees that the other
      // iterator is of the same type and we can downcast.
      GTEST_CHECK_(BaseGenerator() == other.BaseGenerator())
          << "The program attempted to compare iterators "
          << "from different generators." << std::endl;
      return iterator_ ==
          CheckedDowncastToActualType(&other)->iterator_;
    }

   private:
    Iterator(const Iterator& other)
          // The explicit constructor call suppresses a false warning
          // emitted by gcc when supplied with the -Wextra option.
        : ParamIteratorInterface(),
          base_(other.base_),
          iterator_(other.iterator_) {}

    const ParamGeneratorInterface* const base_;
    typename ContainerType::const_iterator iterator_;
    // A cached value of *iterator_. We keep it here to allow access by
    // pointer in the wrapping iterator's operator->().
    // value_ needs to be mutable to be accessed in Current().
    // Use of scoped_ptr helps manage cached value's lifetime,
    // which is bound by the lifespan of the iterator itself.
    mutable scoped_ptr value_;
  };  // class ValuesInIteratorRangeGenerator::Iterator

  // No implementation - assignment is unsupported.
  void operator=(const ValuesInIteratorRangeGenerator& other);

  const ContainerType container_;
};  // class ValuesInIteratorRangeGenerator

// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE.
//
// Stores a parameter value and later creates tests parameterized with that
// value.
template 
class ParameterizedTestFactory : public TestFactoryBase {
 public:
  typedef typename TestClass::ParamType ParamType;
  explicit ParameterizedTestFactory(ParamType parameter) :
      parameter_(parameter) {}
  virtual Test* CreateTest() {
    TestClass::SetParam(¶meter_);
    return new TestClass();
  }

 private:
  const ParamType parameter_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(ParameterizedTestFactory);
};

// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE.
//
// TestMetaFactoryBase is a base class for meta-factories that create
// test factories for passing into MakeAndRegisterTestInfo function.
template 
class TestMetaFactoryBase {
 public:
  virtual ~TestMetaFactoryBase() {}

  virtual TestFactoryBase* CreateTestFactory(ParamType parameter) = 0;
};

// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE.
//
// TestMetaFactory creates test factories for passing into
// MakeAndRegisterTestInfo function. Since MakeAndRegisterTestInfo receives
// ownership of test factory pointer, same factory object cannot be passed
// into that method twice. But ParameterizedTestCaseInfo is going to call
// it for each Test/Parameter value combination. Thus it needs meta factory
// creator class.
template 
class TestMetaFactory
    : public TestMetaFactoryBase {
 public:
  typedef typename TestCase::ParamType ParamType;

  TestMetaFactory() {}

  virtual TestFactoryBase* CreateTestFactory(ParamType parameter) {
    return new ParameterizedTestFactory(parameter);
  }

 private:
  GTEST_DISALLOW_COPY_AND_ASSIGN_(TestMetaFactory);
};

// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE.
//
// ParameterizedTestCaseInfoBase is a generic interface
// to ParameterizedTestCaseInfo classes. ParameterizedTestCaseInfoBase
// accumulates test information provided by TEST_P macro invocations
// and generators provided by INSTANTIATE_TEST_CASE_P macro invocations
// and uses that information to register all resulting test instances
// in RegisterTests method. The ParameterizeTestCaseRegistry class holds
// a collection of pointers to the ParameterizedTestCaseInfo objects
// and calls RegisterTests() on each of them when asked.
class ParameterizedTestCaseInfoBase {
 public:
  virtual ~ParameterizedTestCaseInfoBase() {}

  // Base part of test case name for display purposes.
  virtual const string& GetTestCaseName() const = 0;
  // Test case id to verify identity.
  virtual TypeId GetTestCaseTypeId() const = 0;
  // UnitTest class invokes this method to register tests in this
  // test case right before running them in RUN_ALL_TESTS macro.
  // This method should not be called more then once on any single
  // instance of a ParameterizedTestCaseInfoBase derived class.
  virtual void RegisterTests() = 0;

 protected:
  ParameterizedTestCaseInfoBase() {}

 private:
  GTEST_DISALLOW_COPY_AND_ASSIGN_(ParameterizedTestCaseInfoBase);
};

// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE.
//
// ParameterizedTestCaseInfo accumulates tests obtained from TEST_P
// macro invocations for a particular test case and generators
// obtained from INSTANTIATE_TEST_CASE_P macro invocations for that
// test case. It registers tests with all values generated by all
// generators when asked.
template 
class ParameterizedTestCaseInfo : public ParameterizedTestCaseInfoBase {
 public:
  // ParamType and GeneratorCreationFunc are private types but are required
  // for declarations of public methods AddTestPattern() and
  // AddTestCaseInstantiation().
  typedef typename TestCase::ParamType ParamType;
  // A function that returns an instance of appropriate generator type.
  typedef ParamGenerator(GeneratorCreationFunc)();

  explicit ParameterizedTestCaseInfo(const char* name)
      : test_case_name_(name) {}

  // Test case base name for display purposes.
  virtual const string& GetTestCaseName() const { return test_case_name_; }
  // Test case id to verify identity.
  virtual TypeId GetTestCaseTypeId() const { return GetTypeId(); }
  // TEST_P macro uses AddTestPattern() to record information
  // about a single test in a LocalTestInfo structure.
  // test_case_name is the base name of the test case (without invocation
  // prefix). test_base_name is the name of an individual test without
  // parameter index. For the test SequenceA/FooTest.DoBar/1 FooTest is
  // test case base name and DoBar is test base name.
  void AddTestPattern(const char* test_case_name,
                      const char* test_base_name,
                      TestMetaFactoryBase* meta_factory) {
    tests_.push_back(linked_ptr(new TestInfo(test_case_name,
                                                       test_base_name,
                                                       meta_factory)));
  }
  // INSTANTIATE_TEST_CASE_P macro uses AddGenerator() to record information
  // about a generator.
  int AddTestCaseInstantiation(const string& instantiation_name,
                               GeneratorCreationFunc* func,
                               const char* /* file */,
                               int /* line */) {
    instantiations_.push_back(::std::make_pair(instantiation_name, func));
    return 0;  // Return value used only to run this method in namespace scope.
  }
  // UnitTest class invokes this method to register tests in this test case
  // test cases right before running tests in RUN_ALL_TESTS macro.
  // This method should not be called more then once on any single
  // instance of a ParameterizedTestCaseInfoBase derived class.
  // UnitTest has a guard to prevent from calling this method more then once.
  virtual void RegisterTests() {
    for (typename TestInfoContainer::iterator test_it = tests_.begin();
         test_it != tests_.end(); ++test_it) {
      linked_ptr test_info = *test_it;
      for (typename InstantiationContainer::iterator gen_it =
               instantiations_.begin(); gen_it != instantiations_.end();
               ++gen_it) {
        const string& instantiation_name = gen_it->first;
        ParamGenerator generator((*gen_it->second)());

        string test_case_name;
        if ( !instantiation_name.empty() )
          test_case_name = instantiation_name + "/";
        test_case_name += test_info->test_case_base_name;

        int i = 0;
        for (typename ParamGenerator::iterator param_it =
                 generator.begin();
             param_it != generator.end(); ++param_it, ++i) {
          Message test_name_stream;
          test_name_stream << test_info->test_base_name << "/" << i;
          MakeAndRegisterTestInfo(
              test_case_name.c_str(),
              test_name_stream.GetString().c_str(),
              NULL,  // No type parameter.
              PrintToString(*param_it).c_str(),
              GetTestCaseTypeId(),
              TestCase::SetUpTestCase,
              TestCase::TearDownTestCase,
              test_info->test_meta_factory->CreateTestFactory(*param_it));
        }  // for param_it
      }  // for gen_it
    }  // for test_it
  }  // RegisterTests

 private:
  // LocalTestInfo structure keeps information about a single test registered
  // with TEST_P macro.
  struct TestInfo {
    TestInfo(const char* a_test_case_base_name,
             const char* a_test_base_name,
             TestMetaFactoryBase* a_test_meta_factory) :
        test_case_base_name(a_test_case_base_name),
        test_base_name(a_test_base_name),
        test_meta_factory(a_test_meta_factory) {}

    const string test_case_base_name;
    const string test_base_name;
    const scoped_ptr > test_meta_factory;
  };
  typedef ::std::vector > TestInfoContainer;
  // Keeps pairs of 
  // received from INSTANTIATE_TEST_CASE_P macros.
  typedef ::std::vector >
      InstantiationContainer;

  const string test_case_name_;
  TestInfoContainer tests_;
  InstantiationContainer instantiations_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(ParameterizedTestCaseInfo);
};  // class ParameterizedTestCaseInfo

// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE.
//
// ParameterizedTestCaseRegistry contains a map of ParameterizedTestCaseInfoBase
// classes accessed by test case names. TEST_P and INSTANTIATE_TEST_CASE_P
// macros use it to locate their corresponding ParameterizedTestCaseInfo
// descriptors.
class ParameterizedTestCaseRegistry {
 public:
  ParameterizedTestCaseRegistry() {}
  ~ParameterizedTestCaseRegistry() {
    for (TestCaseInfoContainer::iterator it = test_case_infos_.begin();
         it != test_case_infos_.end(); ++it) {
      delete *it;
    }
  }

  // Looks up or creates and returns a structure containing information about
  // tests and instantiations of a particular test case.
  template 
  ParameterizedTestCaseInfo* GetTestCasePatternHolder(
      const char* test_case_name,
      const char* file,
      int line) {
    ParameterizedTestCaseInfo* typed_test_info = NULL;
    for (TestCaseInfoContainer::iterator it = test_case_infos_.begin();
         it != test_case_infos_.end(); ++it) {
      if ((*it)->GetTestCaseName() == test_case_name) {
        if ((*it)->GetTestCaseTypeId() != GetTypeId()) {
          // Complain about incorrect usage of Google Test facilities
          // and terminate the program since we cannot guaranty correct
          // test case setup and tear-down in this case.
          ReportInvalidTestCaseType(test_case_name,  file, line);
          posix::Abort();
        } else {
          // At this point we are sure that the object we found is of the same
          // type we are looking for, so we downcast it to that type
          // without further checks.
          typed_test_info = CheckedDowncastToActualType<
              ParameterizedTestCaseInfo >(*it);
        }
        break;
      }
    }
    if (typed_test_info == NULL) {
      typed_test_info = new ParameterizedTestCaseInfo(test_case_name);
      test_case_infos_.push_back(typed_test_info);
    }
    return typed_test_info;
  }
  void RegisterTests() {
    for (TestCaseInfoContainer::iterator it = test_case_infos_.begin();
         it != test_case_infos_.end(); ++it) {
      (*it)->RegisterTests();
    }
  }

 private:
  typedef ::std::vector TestCaseInfoContainer;

  TestCaseInfoContainer test_case_infos_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(ParameterizedTestCaseRegistry);
};

}  // namespace internal
}  // namespace testing

#endif  //  GTEST_HAS_PARAM_TEST

#endif  // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PARAM_UTIL_H_
node-v4.8.2/deps/gtest/include/gtest/internal/gtest-port.h000644 000766 000024 00000253130 13070706730 023706 0ustar00iojsstaff000000 000000 // Copyright 2005, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Authors: wan@google.com (Zhanyong Wan)
//
// Low-level types and utilities for porting Google Test to various
// platforms.  All macros ending with _ and symbols defined in an
// internal namespace are subject to change without notice.  Code
// outside Google Test MUST NOT USE THEM DIRECTLY.  Macros that don't
// end with _ are part of Google Test's public API and can be used by
// code outside Google Test.
//
// This file is fundamental to Google Test.  All other Google Test source
// files are expected to #include this.  Therefore, it cannot #include
// any other Google Test header.

#ifndef GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PORT_H_
#define GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PORT_H_

// Environment-describing macros
// -----------------------------
//
// Google Test can be used in many different environments.  Macros in
// this section tell Google Test what kind of environment it is being
// used in, such that Google Test can provide environment-specific
// features and implementations.
//
// Google Test tries to automatically detect the properties of its
// environment, so users usually don't need to worry about these
// macros.  However, the automatic detection is not perfect.
// Sometimes it's necessary for a user to define some of the following
// macros in the build script to override Google Test's decisions.
//
// If the user doesn't define a macro in the list, Google Test will
// provide a default definition.  After this header is #included, all
// macros in this list will be defined to either 1 or 0.
//
// Notes to maintainers:
//   - Each macro here is a user-tweakable knob; do not grow the list
//     lightly.
//   - Use #if to key off these macros.  Don't use #ifdef or "#if
//     defined(...)", which will not work as these macros are ALWAYS
//     defined.
//
//   GTEST_HAS_CLONE          - Define it to 1/0 to indicate that clone(2)
//                              is/isn't available.
//   GTEST_HAS_EXCEPTIONS     - Define it to 1/0 to indicate that exceptions
//                              are enabled.
//   GTEST_HAS_GLOBAL_STRING  - Define it to 1/0 to indicate that ::string
//                              is/isn't available (some systems define
//                              ::string, which is different to std::string).
//   GTEST_HAS_GLOBAL_WSTRING - Define it to 1/0 to indicate that ::string
//                              is/isn't available (some systems define
//                              ::wstring, which is different to std::wstring).
//   GTEST_HAS_POSIX_RE       - Define it to 1/0 to indicate that POSIX regular
//                              expressions are/aren't available.
//   GTEST_HAS_PTHREAD        - Define it to 1/0 to indicate that 
//                              is/isn't available.
//   GTEST_HAS_RTTI           - Define it to 1/0 to indicate that RTTI is/isn't
//                              enabled.
//   GTEST_HAS_STD_WSTRING    - Define it to 1/0 to indicate that
//                              std::wstring does/doesn't work (Google Test can
//                              be used where std::wstring is unavailable).
//   GTEST_HAS_TR1_TUPLE      - Define it to 1/0 to indicate tr1::tuple
//                              is/isn't available.
//   GTEST_HAS_SEH            - Define it to 1/0 to indicate whether the
//                              compiler supports Microsoft's "Structured
//                              Exception Handling".
//   GTEST_HAS_STREAM_REDIRECTION
//                            - Define it to 1/0 to indicate whether the
//                              platform supports I/O stream redirection using
//                              dup() and dup2().
//   GTEST_USE_OWN_TR1_TUPLE  - Define it to 1/0 to indicate whether Google
//                              Test's own tr1 tuple implementation should be
//                              used.  Unused when the user sets
//                              GTEST_HAS_TR1_TUPLE to 0.
//   GTEST_LANG_CXX11         - Define it to 1/0 to indicate that Google Test
//                              is building in C++11/C++98 mode.
//   GTEST_LINKED_AS_SHARED_LIBRARY
//                            - Define to 1 when compiling tests that use
//                              Google Test as a shared library (known as
//                              DLL on Windows).
//   GTEST_CREATE_SHARED_LIBRARY
//                            - Define to 1 when compiling Google Test itself
//                              as a shared library.

// Platform-indicating macros
// --------------------------
//
// Macros indicating the platform on which Google Test is being used
// (a macro is defined to 1 if compiled on the given platform;
// otherwise UNDEFINED -- it's never defined to 0.).  Google Test
// defines these macros automatically.  Code outside Google Test MUST
// NOT define them.
//
//   GTEST_OS_AIX      - IBM AIX
//   GTEST_OS_CYGWIN   - Cygwin
//   GTEST_OS_FREEBSD  - FreeBSD
//   GTEST_OS_HPUX     - HP-UX
//   GTEST_OS_LINUX    - Linux
//     GTEST_OS_LINUX_ANDROID - Google Android
//   GTEST_OS_MAC      - Mac OS X
//     GTEST_OS_IOS    - iOS
//   GTEST_OS_NACL     - Google Native Client (NaCl)
//   GTEST_OS_OPENBSD  - OpenBSD
//   GTEST_OS_QNX      - QNX
//   GTEST_OS_SOLARIS  - Sun Solaris
//   GTEST_OS_SYMBIAN  - Symbian
//   GTEST_OS_WINDOWS  - Windows (Desktop, MinGW, or Mobile)
//     GTEST_OS_WINDOWS_DESKTOP  - Windows Desktop
//     GTEST_OS_WINDOWS_MINGW    - MinGW
//     GTEST_OS_WINDOWS_MOBILE   - Windows Mobile
//     GTEST_OS_WINDOWS_PHONE    - Windows Phone
//     GTEST_OS_WINDOWS_RT       - Windows Store App/WinRT
//   GTEST_OS_ZOS      - z/OS
//
// Among the platforms, Cygwin, Linux, Max OS X, and Windows have the
// most stable support.  Since core members of the Google Test project
// don't have access to other platforms, support for them may be less
// stable.  If you notice any problems on your platform, please notify
// googletestframework@googlegroups.com (patches for fixing them are
// even more welcome!).
//
// It is possible that none of the GTEST_OS_* macros are defined.

// Feature-indicating macros
// -------------------------
//
// Macros indicating which Google Test features are available (a macro
// is defined to 1 if the corresponding feature is supported;
// otherwise UNDEFINED -- it's never defined to 0.).  Google Test
// defines these macros automatically.  Code outside Google Test MUST
// NOT define them.
//
// These macros are public so that portable tests can be written.
// Such tests typically surround code using a feature with an #if
// which controls that code.  For example:
//
// #if GTEST_HAS_DEATH_TEST
//   EXPECT_DEATH(DoSomethingDeadly());
// #endif
//
//   GTEST_HAS_COMBINE      - the Combine() function (for value-parameterized
//                            tests)
//   GTEST_HAS_DEATH_TEST   - death tests
//   GTEST_HAS_PARAM_TEST   - value-parameterized tests
//   GTEST_HAS_TYPED_TEST   - typed tests
//   GTEST_HAS_TYPED_TEST_P - type-parameterized tests
//   GTEST_IS_THREADSAFE    - Google Test is thread-safe.
//   GTEST_USES_POSIX_RE    - enhanced POSIX regex is used. Do not confuse with
//                            GTEST_HAS_POSIX_RE (see above) which users can
//                            define themselves.
//   GTEST_USES_SIMPLE_RE   - our own simple regex is used;
//                            the above two are mutually exclusive.
//   GTEST_CAN_COMPARE_NULL - accepts untyped NULL in EXPECT_EQ().

// Misc public macros
// ------------------
//
//   GTEST_FLAG(flag_name)  - references the variable corresponding to
//                            the given Google Test flag.

// Internal utilities
// ------------------
//
// The following macros and utilities are for Google Test's INTERNAL
// use only.  Code outside Google Test MUST NOT USE THEM DIRECTLY.
//
// Macros for basic C++ coding:
//   GTEST_AMBIGUOUS_ELSE_BLOCKER_ - for disabling a gcc warning.
//   GTEST_ATTRIBUTE_UNUSED_  - declares that a class' instances or a
//                              variable don't have to be used.
//   GTEST_DISALLOW_ASSIGN_   - disables operator=.
//   GTEST_DISALLOW_COPY_AND_ASSIGN_ - disables copy ctor and operator=.
//   GTEST_MUST_USE_RESULT_   - declares that a function's result must be used.
//   GTEST_INTENTIONAL_CONST_COND_PUSH_ - start code section where MSVC C4127 is
//                                        suppressed (constant conditional).
//   GTEST_INTENTIONAL_CONST_COND_POP_  - finish code section where MSVC C4127
//                                        is suppressed.
//
// C++11 feature wrappers:
//
//   testing::internal::move  - portability wrapper for std::move.
//
// Synchronization:
//   Mutex, MutexLock, ThreadLocal, GetThreadCount()
//                            - synchronization primitives.
//
// Template meta programming:
//   is_pointer     - as in TR1; needed on Symbian and IBM XL C/C++ only.
//   IteratorTraits - partial implementation of std::iterator_traits, which
//                    is not available in libCstd when compiled with Sun C++.
//
// Smart pointers:
//   scoped_ptr     - as in TR2.
//
// Regular expressions:
//   RE             - a simple regular expression class using the POSIX
//                    Extended Regular Expression syntax on UNIX-like
//                    platforms, or a reduced regular exception syntax on
//                    other platforms, including Windows.
//
// Logging:
//   GTEST_LOG_()   - logs messages at the specified severity level.
//   LogToStderr()  - directs all log messages to stderr.
//   FlushInfoLog() - flushes informational log messages.
//
// Stdout and stderr capturing:
//   CaptureStdout()     - starts capturing stdout.
//   GetCapturedStdout() - stops capturing stdout and returns the captured
//                         string.
//   CaptureStderr()     - starts capturing stderr.
//   GetCapturedStderr() - stops capturing stderr and returns the captured
//                         string.
//
// Integer types:
//   TypeWithSize   - maps an integer to a int type.
//   Int32, UInt32, Int64, UInt64, TimeInMillis
//                  - integers of known sizes.
//   BiggestInt     - the biggest signed integer type.
//
// Command-line utilities:
//   GTEST_DECLARE_*()  - declares a flag.
//   GTEST_DEFINE_*()   - defines a flag.
//   GetInjectableArgvs() - returns the command line as a vector of strings.
//
// Environment variable utilities:
//   GetEnv()             - gets the value of an environment variable.
//   BoolFromGTestEnv()   - parses a bool environment variable.
//   Int32FromGTestEnv()  - parses an Int32 environment variable.
//   StringFromGTestEnv() - parses a string environment variable.

#include    // for isspace, etc
#include   // for ptrdiff_t
#include 
#include 
#include 
#ifndef _WIN32_WCE
# include 
# include 
#endif  // !_WIN32_WCE

#if defined __APPLE__
# include 
# include 
#endif

#include   // NOLINT
#include   // NOLINT
#include   // NOLINT
#include   // NOLINT
#include 

#define GTEST_DEV_EMAIL_ "googletestframework@@googlegroups.com"
#define GTEST_FLAG_PREFIX_ "gtest_"
#define GTEST_FLAG_PREFIX_DASH_ "gtest-"
#define GTEST_FLAG_PREFIX_UPPER_ "GTEST_"
#define GTEST_NAME_ "Google Test"
#define GTEST_PROJECT_URL_ "http://code.google.com/p/googletest/"

// Determines the version of gcc that is used to compile this.
#ifdef __GNUC__
// 40302 means version 4.3.2.
# define GTEST_GCC_VER_ \
    (__GNUC__*10000 + __GNUC_MINOR__*100 + __GNUC_PATCHLEVEL__)
#endif  // __GNUC__

// Determines the platform on which Google Test is compiled.
#ifdef __CYGWIN__
# define GTEST_OS_CYGWIN 1
#elif defined __SYMBIAN32__
# define GTEST_OS_SYMBIAN 1
#elif defined _WIN32
# define GTEST_OS_WINDOWS 1
# ifdef _WIN32_WCE
#  define GTEST_OS_WINDOWS_MOBILE 1
# elif defined(__MINGW__) || defined(__MINGW32__)
#  define GTEST_OS_WINDOWS_MINGW 1
# elif defined(WINAPI_FAMILY)
#  include 
#  if WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP)
#   define GTEST_OS_WINDOWS_DESKTOP 1
#  elif WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_PHONE_APP)
#   define GTEST_OS_WINDOWS_PHONE 1
#  elif WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP)
#   define GTEST_OS_WINDOWS_RT 1
#  else
    // WINAPI_FAMILY defined but no known partition matched.
    // Default to desktop.
#   define GTEST_OS_WINDOWS_DESKTOP 1
#  endif
# else
#  define GTEST_OS_WINDOWS_DESKTOP 1
# endif  // _WIN32_WCE
#elif defined __APPLE__
# define GTEST_OS_MAC 1
# if TARGET_OS_IPHONE
#  define GTEST_OS_IOS 1
# endif
#elif defined __FreeBSD__
# define GTEST_OS_FREEBSD 1
#elif defined __linux__
# define GTEST_OS_LINUX 1
# if defined __ANDROID__
#  define GTEST_OS_LINUX_ANDROID 1
# endif
#elif defined __MVS__
# define GTEST_OS_ZOS 1
#elif defined(__sun) && defined(__SVR4)
# define GTEST_OS_SOLARIS 1
#elif defined(_AIX)
# define GTEST_OS_AIX 1
#elif defined(__hpux)
# define GTEST_OS_HPUX 1
#elif defined __native_client__
# define GTEST_OS_NACL 1
#elif defined __OpenBSD__
# define GTEST_OS_OPENBSD 1
#elif defined __QNX__
# define GTEST_OS_QNX 1
#endif  // __CYGWIN__

// Macros for disabling Microsoft Visual C++ warnings.
//
//   GTEST_DISABLE_MSC_WARNINGS_PUSH_(4800 4385)
//   /* code that triggers warnings C4800 and C4385 */
//   GTEST_DISABLE_MSC_WARNINGS_POP_()
#if _MSC_VER >= 1500
# define GTEST_DISABLE_MSC_WARNINGS_PUSH_(warnings) \
    __pragma(warning(push))                        \
    __pragma(warning(disable: warnings))
# define GTEST_DISABLE_MSC_WARNINGS_POP_()          \
    __pragma(warning(pop))
#else
// Older versions of MSVC don't have __pragma.
# define GTEST_DISABLE_MSC_WARNINGS_PUSH_(warnings)
# define GTEST_DISABLE_MSC_WARNINGS_POP_()
#endif

#ifndef GTEST_LANG_CXX11
// gcc and clang define __GXX_EXPERIMENTAL_CXX0X__ when
// -std={c,gnu}++{0x,11} is passed.  The C++11 standard specifies a
// value for __cplusplus, and recent versions of clang, gcc, and
// probably other compilers set that too in C++11 mode.
# if __GXX_EXPERIMENTAL_CXX0X__ || __cplusplus >= 201103L
// Compiling in at least C++11 mode.
#  define GTEST_LANG_CXX11 1
# else
#  define GTEST_LANG_CXX11 0
# endif
#endif

// Distinct from C++11 language support, some environments don't provide
// proper C++11 library support. Notably, it's possible to build in
// C++11 mode when targeting Mac OS X 10.6, which has an old libstdc++
// with no C++11 support.
//
// libstdc++ has sufficient C++11 support as of GCC 4.6.0, __GLIBCXX__
// 20110325, but maintenance releases in the 4.4 and 4.5 series followed
// this date, so check for those versions by their date stamps.
// https://gcc.gnu.org/onlinedocs/libstdc++/manual/abi.html#abi.versioning
#if GTEST_LANG_CXX11 && \
    (!defined(__GLIBCXX__) || ( \
        __GLIBCXX__ >= 20110325ul &&  /* GCC >= 4.6.0 */ \
        /* Blacklist of patch releases of older branches: */ \
        __GLIBCXX__ != 20110416ul &&  /* GCC 4.4.6 */ \
        __GLIBCXX__ != 20120313ul &&  /* GCC 4.4.7 */ \
        __GLIBCXX__ != 20110428ul &&  /* GCC 4.5.3 */ \
        __GLIBCXX__ != 20120702ul))   /* GCC 4.5.4 */
# define GTEST_STDLIB_CXX11 1
#endif

// Only use C++11 library features if the library provides them.
#if GTEST_STDLIB_CXX11
# define GTEST_HAS_STD_BEGIN_AND_END_ 1
# define GTEST_HAS_STD_FORWARD_LIST_ 1
# define GTEST_HAS_STD_FUNCTION_ 1
# define GTEST_HAS_STD_INITIALIZER_LIST_ 1
# define GTEST_HAS_STD_MOVE_ 1
# define GTEST_HAS_STD_UNIQUE_PTR_ 1
#endif

// C++11 specifies that  provides std::tuple.
// Some platforms still might not have it, however.
#if GTEST_LANG_CXX11
# define GTEST_HAS_STD_TUPLE_ 1
# if defined(__clang__)
// Inspired by http://clang.llvm.org/docs/LanguageExtensions.html#__has_include
#  if defined(__has_include) && !__has_include()
#   undef GTEST_HAS_STD_TUPLE_
#  endif
# elif defined(_MSC_VER)
// Inspired by boost/config/stdlib/dinkumware.hpp
#  if defined(_CPPLIB_VER) && _CPPLIB_VER < 520
#   undef GTEST_HAS_STD_TUPLE_
#  endif
# elif defined(__GLIBCXX__)
// Inspired by boost/config/stdlib/libstdcpp3.hpp,
// http://gcc.gnu.org/gcc-4.2/changes.html and
// http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt01ch01.html#manual.intro.status.standard.200x
#  if __GNUC__ < 4 || (__GNUC__ == 4 && __GNUC_MINOR__ < 2)
#   undef GTEST_HAS_STD_TUPLE_
#  endif
# endif
#endif

// Brings in definitions for functions used in the testing::internal::posix
// namespace (read, write, close, chdir, isatty, stat). We do not currently
// use them on Windows Mobile.
#if GTEST_OS_WINDOWS
# if !GTEST_OS_WINDOWS_MOBILE
#  include 
#  include 
# endif
// In order to avoid having to include , use forward declaration
// assuming CRITICAL_SECTION is a typedef of _RTL_CRITICAL_SECTION.
// This assumption is verified by
// WindowsTypesTest.CRITICAL_SECTIONIs_RTL_CRITICAL_SECTION.
struct _RTL_CRITICAL_SECTION;
#else
// This assumes that non-Windows OSes provide unistd.h. For OSes where this
// is not the case, we need to include headers that provide the functions
// mentioned above.
# include 
# include 
#endif  // GTEST_OS_WINDOWS

#if GTEST_OS_LINUX_ANDROID
// Used to define __ANDROID_API__ matching the target NDK API level.
#  include   // NOLINT
#endif

// Defines this to true iff Google Test can use POSIX regular expressions.
#ifndef GTEST_HAS_POSIX_RE
# if GTEST_OS_LINUX_ANDROID
// On Android,  is only available starting with Gingerbread.
#  define GTEST_HAS_POSIX_RE (__ANDROID_API__ >= 9)
# else
#  define GTEST_HAS_POSIX_RE (!GTEST_OS_WINDOWS)
# endif
#endif

#if GTEST_HAS_POSIX_RE

// On some platforms,  needs someone to define size_t, and
// won't compile otherwise.  We can #include it here as we already
// included , which is guaranteed to define size_t through
// .
# include   // NOLINT

# define GTEST_USES_POSIX_RE 1

#elif GTEST_OS_WINDOWS

//  is not available on Windows.  Use our own simple regex
// implementation instead.
# define GTEST_USES_SIMPLE_RE 1

#else

//  may not be available on this platform.  Use our own
// simple regex implementation instead.
# define GTEST_USES_SIMPLE_RE 1

#endif  // GTEST_HAS_POSIX_RE

#ifndef GTEST_HAS_EXCEPTIONS
// The user didn't tell us whether exceptions are enabled, so we need
// to figure it out.
# if defined(_MSC_VER) || defined(__BORLANDC__)
// MSVC's and C++Builder's implementations of the STL use the _HAS_EXCEPTIONS
// macro to enable exceptions, so we'll do the same.
// Assumes that exceptions are enabled by default.
#  ifndef _HAS_EXCEPTIONS
#   define _HAS_EXCEPTIONS 1
#  endif  // _HAS_EXCEPTIONS
#  define GTEST_HAS_EXCEPTIONS _HAS_EXCEPTIONS
# elif defined(__clang__)
// clang defines __EXCEPTIONS iff exceptions are enabled before clang 220714,
// but iff cleanups are enabled after that. In Obj-C++ files, there can be
// cleanups for ObjC exceptions which also need cleanups, even if C++ exceptions
// are disabled. clang has __has_feature(cxx_exceptions) which checks for C++
// exceptions starting at clang r206352, but which checked for cleanups prior to
// that. To reliably check for C++ exception availability with clang, check for
// __EXCEPTIONS && __has_feature(cxx_exceptions).
#  define GTEST_HAS_EXCEPTIONS (__EXCEPTIONS && __has_feature(cxx_exceptions))
# elif defined(__GNUC__) && __EXCEPTIONS
// gcc defines __EXCEPTIONS to 1 iff exceptions are enabled.
#  define GTEST_HAS_EXCEPTIONS 1
# elif defined(__SUNPRO_CC)
// Sun Pro CC supports exceptions.  However, there is no compile-time way of
// detecting whether they are enabled or not.  Therefore, we assume that
// they are enabled unless the user tells us otherwise.
#  define GTEST_HAS_EXCEPTIONS 1
# elif defined(__IBMCPP__) && __EXCEPTIONS
// xlC defines __EXCEPTIONS to 1 iff exceptions are enabled.
#  define GTEST_HAS_EXCEPTIONS 1
# elif defined(__HP_aCC)
// Exception handling is in effect by default in HP aCC compiler. It has to
// be turned of by +noeh compiler option if desired.
#  define GTEST_HAS_EXCEPTIONS 1
# else
// For other compilers, we assume exceptions are disabled to be
// conservative.
#  define GTEST_HAS_EXCEPTIONS 0
# endif  // defined(_MSC_VER) || defined(__BORLANDC__)
#endif  // GTEST_HAS_EXCEPTIONS

#if !defined(GTEST_HAS_STD_STRING)
// Even though we don't use this macro any longer, we keep it in case
// some clients still depend on it.
# define GTEST_HAS_STD_STRING 1
#elif !GTEST_HAS_STD_STRING
// The user told us that ::std::string isn't available.
# error "Google Test cannot be used where ::std::string isn't available."
#endif  // !defined(GTEST_HAS_STD_STRING)

#ifndef GTEST_HAS_GLOBAL_STRING
// The user didn't tell us whether ::string is available, so we need
// to figure it out.

# define GTEST_HAS_GLOBAL_STRING 0

#endif  // GTEST_HAS_GLOBAL_STRING

#ifndef GTEST_HAS_STD_WSTRING
// The user didn't tell us whether ::std::wstring is available, so we need
// to figure it out.
// TODO(wan@google.com): uses autoconf to detect whether ::std::wstring
//   is available.

// Cygwin 1.7 and below doesn't support ::std::wstring.
// Solaris' libc++ doesn't support it either.  Android has
// no support for it at least as recent as Froyo (2.2).
# define GTEST_HAS_STD_WSTRING \
    (!(GTEST_OS_LINUX_ANDROID || GTEST_OS_CYGWIN || GTEST_OS_SOLARIS))

#endif  // GTEST_HAS_STD_WSTRING

#ifndef GTEST_HAS_GLOBAL_WSTRING
// The user didn't tell us whether ::wstring is available, so we need
// to figure it out.
# define GTEST_HAS_GLOBAL_WSTRING \
    (GTEST_HAS_STD_WSTRING && GTEST_HAS_GLOBAL_STRING)
#endif  // GTEST_HAS_GLOBAL_WSTRING

// Determines whether RTTI is available.
#ifndef GTEST_HAS_RTTI
// The user didn't tell us whether RTTI is enabled, so we need to
// figure it out.

# ifdef _MSC_VER

#  ifdef _CPPRTTI  // MSVC defines this macro iff RTTI is enabled.
#   define GTEST_HAS_RTTI 1
#  else
#   define GTEST_HAS_RTTI 0
#  endif

// Starting with version 4.3.2, gcc defines __GXX_RTTI iff RTTI is enabled.
# elif defined(__GNUC__) && (GTEST_GCC_VER_ >= 40302)

#  ifdef __GXX_RTTI
// When building against STLport with the Android NDK and with
// -frtti -fno-exceptions, the build fails at link time with undefined
// references to __cxa_bad_typeid. Note sure if STL or toolchain bug,
// so disable RTTI when detected.
#   if GTEST_OS_LINUX_ANDROID && defined(_STLPORT_MAJOR) && \
       !defined(__EXCEPTIONS)
#    define GTEST_HAS_RTTI 0
#   else
#    define GTEST_HAS_RTTI 1
#   endif  // GTEST_OS_LINUX_ANDROID && __STLPORT_MAJOR && !__EXCEPTIONS
#  else
#   define GTEST_HAS_RTTI 0
#  endif  // __GXX_RTTI

// Clang defines __GXX_RTTI starting with version 3.0, but its manual recommends
// using has_feature instead. has_feature(cxx_rtti) is supported since 2.7, the
// first version with C++ support.
# elif defined(__clang__)

#  define GTEST_HAS_RTTI __has_feature(cxx_rtti)

// Starting with version 9.0 IBM Visual Age defines __RTTI_ALL__ to 1 if
// both the typeid and dynamic_cast features are present.
# elif defined(__IBMCPP__) && (__IBMCPP__ >= 900)

#  ifdef __RTTI_ALL__
#   define GTEST_HAS_RTTI 1
#  else
#   define GTEST_HAS_RTTI 0
#  endif

# else

// For all other compilers, we assume RTTI is enabled.
#  define GTEST_HAS_RTTI 1

# endif  // _MSC_VER

#endif  // GTEST_HAS_RTTI

// It's this header's responsibility to #include  when RTTI
// is enabled.
#if GTEST_HAS_RTTI
# include 
#endif

// Determines whether Google Test can use the pthreads library.
#ifndef GTEST_HAS_PTHREAD
// The user didn't tell us explicitly, so we make reasonable assumptions about
// which platforms have pthreads support.
//
// To disable threading support in Google Test, add -DGTEST_HAS_PTHREAD=0
// to your compiler flags.
# define GTEST_HAS_PTHREAD (GTEST_OS_LINUX || GTEST_OS_MAC || GTEST_OS_HPUX \
    || GTEST_OS_QNX || GTEST_OS_FREEBSD || GTEST_OS_NACL)
#endif  // GTEST_HAS_PTHREAD

#if GTEST_HAS_PTHREAD
// gtest-port.h guarantees to #include  when GTEST_HAS_PTHREAD is
// true.
# include   // NOLINT

// For timespec and nanosleep, used below.
# include   // NOLINT
#endif

// Determines whether Google Test can use tr1/tuple.  You can define
// this macro to 0 to prevent Google Test from using tuple (any
// feature depending on tuple with be disabled in this mode).
#ifndef GTEST_HAS_TR1_TUPLE
# if GTEST_OS_LINUX_ANDROID && defined(_STLPORT_MAJOR)
// STLport, provided with the Android NDK, has neither  or .
#  define GTEST_HAS_TR1_TUPLE 0
# else
// The user didn't tell us not to do it, so we assume it's OK.
#  define GTEST_HAS_TR1_TUPLE 1
# endif
#endif  // GTEST_HAS_TR1_TUPLE

// Determines whether Google Test's own tr1 tuple implementation
// should be used.
#ifndef GTEST_USE_OWN_TR1_TUPLE
// The user didn't tell us, so we need to figure it out.

// We use our own TR1 tuple if we aren't sure the user has an
// implementation of it already.  At this time, libstdc++ 4.0.0+ and
// MSVC 2010 are the only mainstream standard libraries that come
// with a TR1 tuple implementation.  NVIDIA's CUDA NVCC compiler
// pretends to be GCC by defining __GNUC__ and friends, but cannot
// compile GCC's tuple implementation.  MSVC 2008 (9.0) provides TR1
// tuple in a 323 MB Feature Pack download, which we cannot assume the
// user has.  QNX's QCC compiler is a modified GCC but it doesn't
// support TR1 tuple.  libc++ only provides std::tuple, in C++11 mode,
// and it can be used with some compilers that define __GNUC__.
# if (defined(__GNUC__) && !defined(__CUDACC__) && (GTEST_GCC_VER_ >= 40000) \
      && !GTEST_OS_QNX && !defined(_LIBCPP_VERSION)) || _MSC_VER >= 1600
#  define GTEST_ENV_HAS_TR1_TUPLE_ 1
# endif

// C++11 specifies that  provides std::tuple. Use that if gtest is used
// in C++11 mode and libstdc++ isn't very old (binaries targeting OS X 10.6
// can build with clang but need to use gcc4.2's libstdc++).
# if GTEST_LANG_CXX11 && (!defined(__GLIBCXX__) || __GLIBCXX__ > 20110325)
#  define GTEST_ENV_HAS_STD_TUPLE_ 1
# endif

# if GTEST_ENV_HAS_TR1_TUPLE_ || GTEST_ENV_HAS_STD_TUPLE_
#  define GTEST_USE_OWN_TR1_TUPLE 0
# else
#  define GTEST_USE_OWN_TR1_TUPLE 1
# endif

#endif  // GTEST_USE_OWN_TR1_TUPLE

// To avoid conditional compilation everywhere, we make it
// gtest-port.h's responsibility to #include the header implementing
// tuple.
#if GTEST_HAS_STD_TUPLE_
# include   // IWYU pragma: export
# define GTEST_TUPLE_NAMESPACE_ ::std
#endif  // GTEST_HAS_STD_TUPLE_

// We include tr1::tuple even if std::tuple is available to define printers for
// them.
#if GTEST_HAS_TR1_TUPLE
# ifndef GTEST_TUPLE_NAMESPACE_
#  define GTEST_TUPLE_NAMESPACE_ ::std::tr1
# endif  // GTEST_TUPLE_NAMESPACE_

# if GTEST_USE_OWN_TR1_TUPLE
#  include "gtest/internal/gtest-tuple.h"  // IWYU pragma: export  // NOLINT
# elif GTEST_ENV_HAS_STD_TUPLE_
#  include 
// C++11 puts its tuple into the ::std namespace rather than
// ::std::tr1.  gtest expects tuple to live in ::std::tr1, so put it there.
// This causes undefined behavior, but supported compilers react in
// the way we intend.
namespace std {
namespace tr1 {
using ::std::get;
using ::std::make_tuple;
using ::std::tuple;
using ::std::tuple_element;
using ::std::tuple_size;
}
}

# elif GTEST_OS_SYMBIAN

// On Symbian, BOOST_HAS_TR1_TUPLE causes Boost's TR1 tuple library to
// use STLport's tuple implementation, which unfortunately doesn't
// work as the copy of STLport distributed with Symbian is incomplete.
// By making sure BOOST_HAS_TR1_TUPLE is undefined, we force Boost to
// use its own tuple implementation.
#  ifdef BOOST_HAS_TR1_TUPLE
#   undef BOOST_HAS_TR1_TUPLE
#  endif  // BOOST_HAS_TR1_TUPLE

// This prevents , which defines
// BOOST_HAS_TR1_TUPLE, from being #included by Boost's .
#  define BOOST_TR1_DETAIL_CONFIG_HPP_INCLUDED
#  include   // IWYU pragma: export  // NOLINT

# elif defined(__GNUC__) && (GTEST_GCC_VER_ >= 40000)
// GCC 4.0+ implements tr1/tuple in the  header.  This does
// not conform to the TR1 spec, which requires the header to be .

#  if !GTEST_HAS_RTTI && GTEST_GCC_VER_ < 40302
// Until version 4.3.2, gcc has a bug that causes ,
// which is #included by , to not compile when RTTI is
// disabled.  _TR1_FUNCTIONAL is the header guard for
// .  Hence the following #define is a hack to prevent
//  from being included.
#   define _TR1_FUNCTIONAL 1
#   include 
#   undef _TR1_FUNCTIONAL  // Allows the user to #include
                        //  if he chooses to.
#  else
#   include   // NOLINT
#  endif  // !GTEST_HAS_RTTI && GTEST_GCC_VER_ < 40302

# else
// If the compiler is not GCC 4.0+, we assume the user is using a
// spec-conforming TR1 implementation.
#  include   // IWYU pragma: export  // NOLINT
# endif  // GTEST_USE_OWN_TR1_TUPLE

#endif  // GTEST_HAS_TR1_TUPLE

// Determines whether clone(2) is supported.
// Usually it will only be available on Linux, excluding
// Linux on the Itanium architecture.
// Also see http://linux.die.net/man/2/clone.
#ifndef GTEST_HAS_CLONE
// The user didn't tell us, so we need to figure it out.

# if GTEST_OS_LINUX && !defined(__ia64__)
#  if GTEST_OS_LINUX_ANDROID
// On Android, clone() is only available on ARM starting with Gingerbread.
#    if defined(__arm__) && __ANDROID_API__ >= 9
#     define GTEST_HAS_CLONE 1
#    else
#     define GTEST_HAS_CLONE 0
#    endif
#  else
#   define GTEST_HAS_CLONE 1
#  endif
# else
#  define GTEST_HAS_CLONE 0
# endif  // GTEST_OS_LINUX && !defined(__ia64__)

#endif  // GTEST_HAS_CLONE

// Determines whether to support stream redirection. This is used to test
// output correctness and to implement death tests.
#ifndef GTEST_HAS_STREAM_REDIRECTION
// By default, we assume that stream redirection is supported on all
// platforms except known mobile ones.
# if GTEST_OS_WINDOWS_MOBILE || GTEST_OS_SYMBIAN || \
    GTEST_OS_WINDOWS_PHONE || GTEST_OS_WINDOWS_RT
#  define GTEST_HAS_STREAM_REDIRECTION 0
# else
#  define GTEST_HAS_STREAM_REDIRECTION 1
# endif  // !GTEST_OS_WINDOWS_MOBILE && !GTEST_OS_SYMBIAN
#endif  // GTEST_HAS_STREAM_REDIRECTION

// Determines whether to support death tests.
// Google Test does not support death tests for VC 7.1 and earlier as
// abort() in a VC 7.1 application compiled as GUI in debug config
// pops up a dialog window that cannot be suppressed programmatically.
#if (GTEST_OS_LINUX || GTEST_OS_CYGWIN || GTEST_OS_SOLARIS || \
     (GTEST_OS_MAC && !GTEST_OS_IOS) || \
     (GTEST_OS_WINDOWS_DESKTOP && _MSC_VER >= 1400) || \
     GTEST_OS_WINDOWS_MINGW || GTEST_OS_AIX || GTEST_OS_HPUX || \
     GTEST_OS_OPENBSD || GTEST_OS_QNX || GTEST_OS_FREEBSD)
# define GTEST_HAS_DEATH_TEST 1
# include   // NOLINT
#endif

// We don't support MSVC 7.1 with exceptions disabled now.  Therefore
// all the compilers we care about are adequate for supporting
// value-parameterized tests.
#define GTEST_HAS_PARAM_TEST 1

// Determines whether to support type-driven tests.

// Typed tests need  and variadic macros, which GCC, VC++ 8.0,
// Sun Pro CC, IBM Visual Age, and HP aCC support.
#if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__SUNPRO_CC) || \
    defined(__IBMCPP__) || defined(__HP_aCC)
# define GTEST_HAS_TYPED_TEST 1
# define GTEST_HAS_TYPED_TEST_P 1
#endif

// Determines whether to support Combine(). This only makes sense when
// value-parameterized tests are enabled.  The implementation doesn't
// work on Sun Studio since it doesn't understand templated conversion
// operators.
#if GTEST_HAS_PARAM_TEST && GTEST_HAS_TR1_TUPLE && !defined(__SUNPRO_CC)
# define GTEST_HAS_COMBINE 1
#endif

// Determines whether the system compiler uses UTF-16 for encoding wide strings.
#define GTEST_WIDE_STRING_USES_UTF16_ \
    (GTEST_OS_WINDOWS || GTEST_OS_CYGWIN || GTEST_OS_SYMBIAN || GTEST_OS_AIX)

// Determines whether test results can be streamed to a socket.
#if GTEST_OS_LINUX
# define GTEST_CAN_STREAM_RESULTS_ 1
#endif

// Defines some utility macros.

// The GNU compiler emits a warning if nested "if" statements are followed by
// an "else" statement and braces are not used to explicitly disambiguate the
// "else" binding.  This leads to problems with code like:
//
//   if (gate)
//     ASSERT_*(condition) << "Some message";
//
// The "switch (0) case 0:" idiom is used to suppress this.
#ifdef __INTEL_COMPILER
# define GTEST_AMBIGUOUS_ELSE_BLOCKER_
#else
# define GTEST_AMBIGUOUS_ELSE_BLOCKER_ switch (0) case 0: default:  // NOLINT
#endif

// Use this annotation at the end of a struct/class definition to
// prevent the compiler from optimizing away instances that are never
// used.  This is useful when all interesting logic happens inside the
// c'tor and / or d'tor.  Example:
//
//   struct Foo {
//     Foo() { ... }
//   } GTEST_ATTRIBUTE_UNUSED_;
//
// Also use it after a variable or parameter declaration to tell the
// compiler the variable/parameter does not have to be used.
#if defined(__GNUC__) && !defined(COMPILER_ICC)
# define GTEST_ATTRIBUTE_UNUSED_ __attribute__ ((unused))
#elif defined(__clang__)
# if __has_attribute(unused)
#  define GTEST_ATTRIBUTE_UNUSED_ __attribute__ ((unused))
# endif
#endif
#ifndef GTEST_ATTRIBUTE_UNUSED_
# define GTEST_ATTRIBUTE_UNUSED_
#endif

// A macro to disallow operator=
// This should be used in the private: declarations for a class.
#define GTEST_DISALLOW_ASSIGN_(type)\
  void operator=(type const &)

// A macro to disallow copy constructor and operator=
// This should be used in the private: declarations for a class.
#define GTEST_DISALLOW_COPY_AND_ASSIGN_(type)\
  type(type const &);\
  GTEST_DISALLOW_ASSIGN_(type)

// Tell the compiler to warn about unused return values for functions declared
// with this macro.  The macro should be used on function declarations
// following the argument list:
//
//   Sprocket* AllocateSprocket() GTEST_MUST_USE_RESULT_;
#if defined(__GNUC__) && (GTEST_GCC_VER_ >= 30400) && !defined(COMPILER_ICC)
# define GTEST_MUST_USE_RESULT_ __attribute__ ((warn_unused_result))
#else
# define GTEST_MUST_USE_RESULT_
#endif  // __GNUC__ && (GTEST_GCC_VER_ >= 30400) && !COMPILER_ICC

// MS C++ compiler emits warning when a conditional expression is compile time
// constant. In some contexts this warning is false positive and needs to be
// suppressed. Use the following two macros in such cases:
//
// GTEST_INTENTIONAL_CONST_COND_PUSH_()
// while (true) {
// GTEST_INTENTIONAL_CONST_COND_POP_()
// }
# define GTEST_INTENTIONAL_CONST_COND_PUSH_() \
    GTEST_DISABLE_MSC_WARNINGS_PUSH_(4127)
# define GTEST_INTENTIONAL_CONST_COND_POP_() \
    GTEST_DISABLE_MSC_WARNINGS_POP_()

// Determine whether the compiler supports Microsoft's Structured Exception
// Handling.  This is supported by several Windows compilers but generally
// does not exist on any other system.
#ifndef GTEST_HAS_SEH
// The user didn't tell us, so we need to figure it out.

# if defined(_MSC_VER) || defined(__BORLANDC__)
// These two compilers are known to support SEH.
#  define GTEST_HAS_SEH 1
# else
// Assume no SEH.
#  define GTEST_HAS_SEH 0
# endif

#define GTEST_IS_THREADSAFE \
    (0 \
     || (GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_PHONE && !GTEST_OS_WINDOWS_RT) \
     || GTEST_HAS_PTHREAD)

#endif  // GTEST_HAS_SEH

#ifdef _MSC_VER

# if GTEST_LINKED_AS_SHARED_LIBRARY
#  define GTEST_API_ __declspec(dllimport)
# elif GTEST_CREATE_SHARED_LIBRARY
#  define GTEST_API_ __declspec(dllexport)
# endif

#endif  // _MSC_VER

#ifndef GTEST_API_
# define GTEST_API_
#endif

#ifdef __GNUC__
// Ask the compiler to never inline a given function.
# define GTEST_NO_INLINE_ __attribute__((noinline))
#else
# define GTEST_NO_INLINE_
#endif

// _LIBCPP_VERSION is defined by the libc++ library from the LLVM project.
#if defined(__GLIBCXX__) || defined(_LIBCPP_VERSION)
# define GTEST_HAS_CXXABI_H_ 1
#else
# define GTEST_HAS_CXXABI_H_ 0
#endif

// A function level attribute to disable checking for use of uninitialized
// memory when built with MemorySanitizer.
#if defined(__clang__)
# if __has_feature(memory_sanitizer)
#  define GTEST_ATTRIBUTE_NO_SANITIZE_MEMORY_ \
       __attribute__((no_sanitize_memory))
# else
#  define GTEST_ATTRIBUTE_NO_SANITIZE_MEMORY_
# endif  // __has_feature(memory_sanitizer)
#else
# define GTEST_ATTRIBUTE_NO_SANITIZE_MEMORY_
#endif  // __clang__

// A function level attribute to disable AddressSanitizer instrumentation.
#if defined(__clang__)
# if __has_feature(address_sanitizer)
#  define GTEST_ATTRIBUTE_NO_SANITIZE_ADDRESS_ \
       __attribute__((no_sanitize_address))
# else
#  define GTEST_ATTRIBUTE_NO_SANITIZE_ADDRESS_
# endif  // __has_feature(address_sanitizer)
#else
# define GTEST_ATTRIBUTE_NO_SANITIZE_ADDRESS_
#endif  // __clang__

// A function level attribute to disable ThreadSanitizer instrumentation.
#if defined(__clang__)
# if __has_feature(thread_sanitizer)
#  define GTEST_ATTRIBUTE_NO_SANITIZE_THREAD_ \
       __attribute__((no_sanitize_thread))
# else
#  define GTEST_ATTRIBUTE_NO_SANITIZE_THREAD_
# endif  // __has_feature(thread_sanitizer)
#else
# define GTEST_ATTRIBUTE_NO_SANITIZE_THREAD_
#endif  // __clang__

namespace testing {

class Message;

#if defined(GTEST_TUPLE_NAMESPACE_)
// Import tuple and friends into the ::testing namespace.
// It is part of our interface, having them in ::testing allows us to change
// their types as needed.
using GTEST_TUPLE_NAMESPACE_::get;
using GTEST_TUPLE_NAMESPACE_::make_tuple;
using GTEST_TUPLE_NAMESPACE_::tuple;
using GTEST_TUPLE_NAMESPACE_::tuple_size;
using GTEST_TUPLE_NAMESPACE_::tuple_element;
#endif  // defined(GTEST_TUPLE_NAMESPACE_)

namespace internal {

// A secret type that Google Test users don't know about.  It has no
// definition on purpose.  Therefore it's impossible to create a
// Secret object, which is what we want.
class Secret;

// The GTEST_COMPILE_ASSERT_ macro can be used to verify that a compile time
// expression is true. For example, you could use it to verify the
// size of a static array:
//
//   GTEST_COMPILE_ASSERT_(GTEST_ARRAY_SIZE_(names) == NUM_NAMES,
//                         names_incorrect_size);
//
// or to make sure a struct is smaller than a certain size:
//
//   GTEST_COMPILE_ASSERT_(sizeof(foo) < 128, foo_too_large);
//
// The second argument to the macro is the name of the variable. If
// the expression is false, most compilers will issue a warning/error
// containing the name of the variable.

#if GTEST_LANG_CXX11
# define GTEST_COMPILE_ASSERT_(expr, msg) static_assert(expr, #msg)
#else  // !GTEST_LANG_CXX11
template 
  struct CompileAssert {
};

# define GTEST_COMPILE_ASSERT_(expr, msg) \
  typedef ::testing::internal::CompileAssert<(static_cast(expr))> \
      msg[static_cast(expr) ? 1 : -1] GTEST_ATTRIBUTE_UNUSED_
#endif  // !GTEST_LANG_CXX11

// Implementation details of GTEST_COMPILE_ASSERT_:
//
// (In C++11, we simply use static_assert instead of the following)
//
// - GTEST_COMPILE_ASSERT_ works by defining an array type that has -1
//   elements (and thus is invalid) when the expression is false.
//
// - The simpler definition
//
//    #define GTEST_COMPILE_ASSERT_(expr, msg) typedef char msg[(expr) ? 1 : -1]
//
//   does not work, as gcc supports variable-length arrays whose sizes
//   are determined at run-time (this is gcc's extension and not part
//   of the C++ standard).  As a result, gcc fails to reject the
//   following code with the simple definition:
//
//     int foo;
//     GTEST_COMPILE_ASSERT_(foo, msg); // not supposed to compile as foo is
//                                      // not a compile-time constant.
//
// - By using the type CompileAssert<(bool(expr))>, we ensures that
//   expr is a compile-time constant.  (Template arguments must be
//   determined at compile-time.)
//
// - The outter parentheses in CompileAssert<(bool(expr))> are necessary
//   to work around a bug in gcc 3.4.4 and 4.0.1.  If we had written
//
//     CompileAssert
//
//   instead, these compilers will refuse to compile
//
//     GTEST_COMPILE_ASSERT_(5 > 0, some_message);
//
//   (They seem to think the ">" in "5 > 0" marks the end of the
//   template argument list.)
//
// - The array size is (bool(expr) ? 1 : -1), instead of simply
//
//     ((expr) ? 1 : -1).
//
//   This is to avoid running into a bug in MS VC 7.1, which
//   causes ((0.0) ? 1 : -1) to incorrectly evaluate to 1.

// StaticAssertTypeEqHelper is used by StaticAssertTypeEq defined in gtest.h.
//
// This template is declared, but intentionally undefined.
template 
struct StaticAssertTypeEqHelper;

template 
struct StaticAssertTypeEqHelper {
  enum { value = true };
};

// Evaluates to the number of elements in 'array'.
#define GTEST_ARRAY_SIZE_(array) (sizeof(array) / sizeof(array[0]))

#if GTEST_HAS_GLOBAL_STRING
typedef ::string string;
#else
typedef ::std::string string;
#endif  // GTEST_HAS_GLOBAL_STRING

#if GTEST_HAS_GLOBAL_WSTRING
typedef ::wstring wstring;
#elif GTEST_HAS_STD_WSTRING
typedef ::std::wstring wstring;
#endif  // GTEST_HAS_GLOBAL_WSTRING

// A helper for suppressing warnings on constant condition.  It just
// returns 'condition'.
GTEST_API_ bool IsTrue(bool condition);

// Defines scoped_ptr.

// This implementation of scoped_ptr is PARTIAL - it only contains
// enough stuff to satisfy Google Test's need.
template 
class scoped_ptr {
 public:
  typedef T element_type;

  explicit scoped_ptr(T* p = NULL) : ptr_(p) {}
  ~scoped_ptr() { reset(); }

  T& operator*() const { return *ptr_; }
  T* operator->() const { return ptr_; }
  T* get() const { return ptr_; }

  T* release() {
    T* const ptr = ptr_;
    ptr_ = NULL;
    return ptr;
  }

  void reset(T* p = NULL) {
    if (p != ptr_) {
      if (IsTrue(sizeof(T) > 0)) {  // Makes sure T is a complete type.
        delete ptr_;
      }
      ptr_ = p;
    }
  }

  friend void swap(scoped_ptr& a, scoped_ptr& b) {
    using std::swap;
    swap(a.ptr_, b.ptr_);
  }

 private:
  T* ptr_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(scoped_ptr);
};

// Defines RE.

// A simple C++ wrapper for .  It uses the POSIX Extended
// Regular Expression syntax.
class GTEST_API_ RE {
 public:
  // A copy constructor is required by the Standard to initialize object
  // references from r-values.
  RE(const RE& other) { Init(other.pattern()); }

  // Constructs an RE from a string.
  RE(const ::std::string& regex) { Init(regex.c_str()); }  // NOLINT

#if GTEST_HAS_GLOBAL_STRING

  RE(const ::string& regex) { Init(regex.c_str()); }  // NOLINT

#endif  // GTEST_HAS_GLOBAL_STRING

  RE(const char* regex) { Init(regex); }  // NOLINT
  ~RE();

  // Returns the string representation of the regex.
  const char* pattern() const { return pattern_; }

  // FullMatch(str, re) returns true iff regular expression re matches
  // the entire str.
  // PartialMatch(str, re) returns true iff regular expression re
  // matches a substring of str (including str itself).
  //
  // TODO(wan@google.com): make FullMatch() and PartialMatch() work
  // when str contains NUL characters.
  static bool FullMatch(const ::std::string& str, const RE& re) {
    return FullMatch(str.c_str(), re);
  }
  static bool PartialMatch(const ::std::string& str, const RE& re) {
    return PartialMatch(str.c_str(), re);
  }

#if GTEST_HAS_GLOBAL_STRING

  static bool FullMatch(const ::string& str, const RE& re) {
    return FullMatch(str.c_str(), re);
  }
  static bool PartialMatch(const ::string& str, const RE& re) {
    return PartialMatch(str.c_str(), re);
  }

#endif  // GTEST_HAS_GLOBAL_STRING

  static bool FullMatch(const char* str, const RE& re);
  static bool PartialMatch(const char* str, const RE& re);

 private:
  void Init(const char* regex);

  // We use a const char* instead of an std::string, as Google Test used to be
  // used where std::string is not available.  TODO(wan@google.com): change to
  // std::string.
  const char* pattern_;
  bool is_valid_;

#if GTEST_USES_POSIX_RE

  regex_t full_regex_;     // For FullMatch().
  regex_t partial_regex_;  // For PartialMatch().

#else  // GTEST_USES_SIMPLE_RE

  const char* full_pattern_;  // For FullMatch();

#endif

  GTEST_DISALLOW_ASSIGN_(RE);
};

// Formats a source file path and a line number as they would appear
// in an error message from the compiler used to compile this code.
GTEST_API_ ::std::string FormatFileLocation(const char* file, int line);

// Formats a file location for compiler-independent XML output.
// Although this function is not platform dependent, we put it next to
// FormatFileLocation in order to contrast the two functions.
GTEST_API_ ::std::string FormatCompilerIndependentFileLocation(const char* file,
                                                               int line);

// Defines logging utilities:
//   GTEST_LOG_(severity) - logs messages at the specified severity level. The
//                          message itself is streamed into the macro.
//   LogToStderr()  - directs all log messages to stderr.
//   FlushInfoLog() - flushes informational log messages.

enum GTestLogSeverity {
  GTEST_INFO,
  GTEST_WARNING,
  GTEST_ERROR,
  GTEST_FATAL
};

// Formats log entry severity, provides a stream object for streaming the
// log message, and terminates the message with a newline when going out of
// scope.
class GTEST_API_ GTestLog {
 public:
  GTestLog(GTestLogSeverity severity, const char* file, int line);

  // Flushes the buffers and, if severity is GTEST_FATAL, aborts the program.
  ~GTestLog();

  ::std::ostream& GetStream() { return ::std::cerr; }

 private:
  const GTestLogSeverity severity_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(GTestLog);
};

#define GTEST_LOG_(severity) \
    ::testing::internal::GTestLog(::testing::internal::GTEST_##severity, \
                                  __FILE__, __LINE__).GetStream()

inline void LogToStderr() {}
inline void FlushInfoLog() { fflush(NULL); }

// INTERNAL IMPLEMENTATION - DO NOT USE.
//
// GTEST_CHECK_ is an all-mode assert. It aborts the program if the condition
// is not satisfied.
//  Synopsys:
//    GTEST_CHECK_(boolean_condition);
//     or
//    GTEST_CHECK_(boolean_condition) << "Additional message";
//
//    This checks the condition and if the condition is not satisfied
//    it prints message about the condition violation, including the
//    condition itself, plus additional message streamed into it, if any,
//    and then it aborts the program. It aborts the program irrespective of
//    whether it is built in the debug mode or not.
#define GTEST_CHECK_(condition) \
    GTEST_AMBIGUOUS_ELSE_BLOCKER_ \
    if (::testing::internal::IsTrue(condition)) \
      ; \
    else \
      GTEST_LOG_(FATAL) << "Condition " #condition " failed. "

// An all-mode assert to verify that the given POSIX-style function
// call returns 0 (indicating success).  Known limitation: this
// doesn't expand to a balanced 'if' statement, so enclose the macro
// in {} if you need to use it as the only statement in an 'if'
// branch.
#define GTEST_CHECK_POSIX_SUCCESS_(posix_call) \
  if (const int gtest_error = (posix_call)) \
    GTEST_LOG_(FATAL) << #posix_call << "failed with error " \
                      << gtest_error

#if GTEST_HAS_STD_MOVE_
using std::move;
#else  // GTEST_HAS_STD_MOVE_
template 
const T& move(const T& t) {
  return t;
}
#endif  // GTEST_HAS_STD_MOVE_

// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE.
//
// Use ImplicitCast_ as a safe version of static_cast for upcasting in
// the type hierarchy (e.g. casting a Foo* to a SuperclassOfFoo* or a
// const Foo*).  When you use ImplicitCast_, the compiler checks that
// the cast is safe.  Such explicit ImplicitCast_s are necessary in
// surprisingly many situations where C++ demands an exact type match
// instead of an argument type convertable to a target type.
//
// The syntax for using ImplicitCast_ is the same as for static_cast:
//
//   ImplicitCast_(expr)
//
// ImplicitCast_ would have been part of the C++ standard library,
// but the proposal was submitted too late.  It will probably make
// its way into the language in the future.
//
// This relatively ugly name is intentional. It prevents clashes with
// similar functions users may have (e.g., implicit_cast). The internal
// namespace alone is not enough because the function can be found by ADL.
template
inline To ImplicitCast_(To x) { return ::testing::internal::move(x); }

// When you upcast (that is, cast a pointer from type Foo to type
// SuperclassOfFoo), it's fine to use ImplicitCast_<>, since upcasts
// always succeed.  When you downcast (that is, cast a pointer from
// type Foo to type SubclassOfFoo), static_cast<> isn't safe, because
// how do you know the pointer is really of type SubclassOfFoo?  It
// could be a bare Foo, or of type DifferentSubclassOfFoo.  Thus,
// when you downcast, you should use this macro.  In debug mode, we
// use dynamic_cast<> to double-check the downcast is legal (we die
// if it's not).  In normal mode, we do the efficient static_cast<>
// instead.  Thus, it's important to test in debug mode to make sure
// the cast is legal!
//    This is the only place in the code we should use dynamic_cast<>.
// In particular, you SHOULDN'T be using dynamic_cast<> in order to
// do RTTI (eg code like this:
//    if (dynamic_cast(foo)) HandleASubclass1Object(foo);
//    if (dynamic_cast(foo)) HandleASubclass2Object(foo);
// You should design the code some other way not to need this.
//
// This relatively ugly name is intentional. It prevents clashes with
// similar functions users may have (e.g., down_cast). The internal
// namespace alone is not enough because the function can be found by ADL.
template  // use like this: DownCast_(foo);
inline To DownCast_(From* f) {  // so we only accept pointers
  // Ensures that To is a sub-type of From *.  This test is here only
  // for compile-time type checking, and has no overhead in an
  // optimized build at run-time, as it will be optimized away
  // completely.
  GTEST_INTENTIONAL_CONST_COND_PUSH_()
  if (false) {
  GTEST_INTENTIONAL_CONST_COND_POP_()
    const To to = NULL;
    ::testing::internal::ImplicitCast_(to);
  }

#if GTEST_HAS_RTTI
  // RTTI: debug mode only!
  GTEST_CHECK_(f == NULL || dynamic_cast(f) != NULL);
#endif
  return static_cast(f);
}

// Downcasts the pointer of type Base to Derived.
// Derived must be a subclass of Base. The parameter MUST
// point to a class of type Derived, not any subclass of it.
// When RTTI is available, the function performs a runtime
// check to enforce this.
template 
Derived* CheckedDowncastToActualType(Base* base) {
#if GTEST_HAS_RTTI
  GTEST_CHECK_(typeid(*base) == typeid(Derived));
  return dynamic_cast(base);  // NOLINT
#else
  return static_cast(base);  // Poor man's downcast.
#endif
}

#if GTEST_HAS_STREAM_REDIRECTION

// Defines the stderr capturer:
//   CaptureStdout     - starts capturing stdout.
//   GetCapturedStdout - stops capturing stdout and returns the captured string.
//   CaptureStderr     - starts capturing stderr.
//   GetCapturedStderr - stops capturing stderr and returns the captured string.
//
GTEST_API_ void CaptureStdout();
GTEST_API_ std::string GetCapturedStdout();
GTEST_API_ void CaptureStderr();
GTEST_API_ std::string GetCapturedStderr();

#endif  // GTEST_HAS_STREAM_REDIRECTION


#if GTEST_HAS_DEATH_TEST

const ::std::vector& GetInjectableArgvs();
void SetInjectableArgvs(const ::std::vector*
                             new_argvs);

// A copy of all command line arguments.  Set by InitGoogleTest().
extern ::std::vector g_argvs;

#endif  // GTEST_HAS_DEATH_TEST

// Defines synchronization primitives.
#if GTEST_IS_THREADSAFE
# if GTEST_HAS_PTHREAD
// Sleeps for (roughly) n milliseconds.  This function is only for testing
// Google Test's own constructs.  Don't use it in user tests, either
// directly or indirectly.
inline void SleepMilliseconds(int n) {
  const timespec time = {
    0,                  // 0 seconds.
    n * 1000L * 1000L,  // And n ms.
  };
  nanosleep(&time, NULL);
}
# endif  // GTEST_HAS_PTHREAD

# if 0  // OS detection
# elif GTEST_HAS_PTHREAD
// Allows a controller thread to pause execution of newly created
// threads until notified.  Instances of this class must be created
// and destroyed in the controller thread.
//
// This class is only for testing Google Test's own constructs. Do not
// use it in user tests, either directly or indirectly.
class Notification {
 public:
  Notification() : notified_(false) {
    GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_init(&mutex_, NULL));
  }
  ~Notification() {
    pthread_mutex_destroy(&mutex_);
  }

  // Notifies all threads created with this notification to start. Must
  // be called from the controller thread.
  void Notify() {
    pthread_mutex_lock(&mutex_);
    notified_ = true;
    pthread_mutex_unlock(&mutex_);
  }

  // Blocks until the controller thread notifies. Must be called from a test
  // thread.
  void WaitForNotification() {
    for (;;) {
      pthread_mutex_lock(&mutex_);
      const bool notified = notified_;
      pthread_mutex_unlock(&mutex_);
      if (notified)
        break;
      SleepMilliseconds(10);
    }
  }

 private:
  pthread_mutex_t mutex_;
  bool notified_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(Notification);
};

# elif GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_PHONE && !GTEST_OS_WINDOWS_RT

GTEST_API_ void SleepMilliseconds(int n);

// Provides leak-safe Windows kernel handle ownership.
// Used in death tests and in threading support.
class GTEST_API_ AutoHandle {
 public:
  // Assume that Win32 HANDLE type is equivalent to void*. Doing so allows us to
  // avoid including  in this header file. Including  is
  // undesirable because it defines a lot of symbols and macros that tend to
  // conflict with client code. This assumption is verified by
  // WindowsTypesTest.HANDLEIsVoidStar.
  typedef void* Handle;
  AutoHandle();
  explicit AutoHandle(Handle handle);

  ~AutoHandle();

  Handle Get() const;
  void Reset();
  void Reset(Handle handle);

 private:
  // Returns true iff the handle is a valid handle object that can be closed.
  bool IsCloseable() const;

  Handle handle_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(AutoHandle);
};

// Allows a controller thread to pause execution of newly created
// threads until notified.  Instances of this class must be created
// and destroyed in the controller thread.
//
// This class is only for testing Google Test's own constructs. Do not
// use it in user tests, either directly or indirectly.
class GTEST_API_ Notification {
 public:
  Notification();
  void Notify();
  void WaitForNotification();

 private:
  AutoHandle event_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(Notification);
};
# endif  // OS detection

// On MinGW, we can have both GTEST_OS_WINDOWS and GTEST_HAS_PTHREAD
// defined, but we don't want to use MinGW's pthreads implementation, which
// has conformance problems with some versions of the POSIX standard.
# if GTEST_HAS_PTHREAD && !GTEST_OS_WINDOWS_MINGW

// As a C-function, ThreadFuncWithCLinkage cannot be templated itself.
// Consequently, it cannot select a correct instantiation of ThreadWithParam
// in order to call its Run(). Introducing ThreadWithParamBase as a
// non-templated base class for ThreadWithParam allows us to bypass this
// problem.
class ThreadWithParamBase {
 public:
  virtual ~ThreadWithParamBase() {}
  virtual void Run() = 0;
};

// pthread_create() accepts a pointer to a function type with the C linkage.
// According to the Standard (7.5/1), function types with different linkages
// are different even if they are otherwise identical.  Some compilers (for
// example, SunStudio) treat them as different types.  Since class methods
// cannot be defined with C-linkage we need to define a free C-function to
// pass into pthread_create().
extern "C" inline void* ThreadFuncWithCLinkage(void* thread) {
  static_cast(thread)->Run();
  return NULL;
}

// Helper class for testing Google Test's multi-threading constructs.
// To use it, write:
//
//   void ThreadFunc(int param) { /* Do things with param */ }
//   Notification thread_can_start;
//   ...
//   // The thread_can_start parameter is optional; you can supply NULL.
//   ThreadWithParam thread(&ThreadFunc, 5, &thread_can_start);
//   thread_can_start.Notify();
//
// These classes are only for testing Google Test's own constructs. Do
// not use them in user tests, either directly or indirectly.
template 
class ThreadWithParam : public ThreadWithParamBase {
 public:
  typedef void UserThreadFunc(T);

  ThreadWithParam(UserThreadFunc* func, T param, Notification* thread_can_start)
      : func_(func),
        param_(param),
        thread_can_start_(thread_can_start),
        finished_(false) {
    ThreadWithParamBase* const base = this;
    // The thread can be created only after all fields except thread_
    // have been initialized.
    GTEST_CHECK_POSIX_SUCCESS_(
        pthread_create(&thread_, 0, &ThreadFuncWithCLinkage, base));
  }
  ~ThreadWithParam() { Join(); }

  void Join() {
    if (!finished_) {
      GTEST_CHECK_POSIX_SUCCESS_(pthread_join(thread_, 0));
      finished_ = true;
    }
  }

  virtual void Run() {
    if (thread_can_start_ != NULL)
      thread_can_start_->WaitForNotification();
    func_(param_);
  }

 private:
  UserThreadFunc* const func_;  // User-supplied thread function.
  const T param_;  // User-supplied parameter to the thread function.
  // When non-NULL, used to block execution until the controller thread
  // notifies.
  Notification* const thread_can_start_;
  bool finished_;  // true iff we know that the thread function has finished.
  pthread_t thread_;  // The native thread object.

  GTEST_DISALLOW_COPY_AND_ASSIGN_(ThreadWithParam);
};
# endif  // GTEST_HAS_PTHREAD && !GTEST_OS_WINDOWS_MINGW

# if 0  // OS detection
# elif GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_PHONE && !GTEST_OS_WINDOWS_RT

// Mutex implements mutex on Windows platforms.  It is used in conjunction
// with class MutexLock:
//
//   Mutex mutex;
//   ...
//   MutexLock lock(&mutex);  // Acquires the mutex and releases it at the
//                            // end of the current scope.
//
// A static Mutex *must* be defined or declared using one of the following
// macros:
//   GTEST_DEFINE_STATIC_MUTEX_(g_some_mutex);
//   GTEST_DECLARE_STATIC_MUTEX_(g_some_mutex);
//
// (A non-static Mutex is defined/declared in the usual way).
class GTEST_API_ Mutex {
 public:
  enum MutexType { kStatic = 0, kDynamic = 1 };
  // We rely on kStaticMutex being 0 as it is to what the linker initializes
  // type_ in static mutexes.  critical_section_ will be initialized lazily
  // in ThreadSafeLazyInit().
  enum StaticConstructorSelector { kStaticMutex = 0 };

  // This constructor intentionally does nothing.  It relies on type_ being
  // statically initialized to 0 (effectively setting it to kStatic) and on
  // ThreadSafeLazyInit() to lazily initialize the rest of the members.
  explicit Mutex(StaticConstructorSelector /*dummy*/) {}

  Mutex();
  ~Mutex();

  void Lock();

  void Unlock();

  // Does nothing if the current thread holds the mutex. Otherwise, crashes
  // with high probability.
  void AssertHeld();

 private:
  // Initializes owner_thread_id_ and critical_section_ in static mutexes.
  void ThreadSafeLazyInit();

  // Per http://blogs.msdn.com/b/oldnewthing/archive/2004/02/23/78395.aspx,
  // we assume that 0 is an invalid value for thread IDs.
  unsigned int owner_thread_id_;

  // For static mutexes, we rely on these members being initialized to zeros
  // by the linker.
  MutexType type_;
  long critical_section_init_phase_;  // NOLINT
  _RTL_CRITICAL_SECTION* critical_section_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(Mutex);
};

# define GTEST_DECLARE_STATIC_MUTEX_(mutex) \
    extern ::testing::internal::Mutex mutex

# define GTEST_DEFINE_STATIC_MUTEX_(mutex) \
    ::testing::internal::Mutex mutex(::testing::internal::Mutex::kStaticMutex)

// We cannot name this class MutexLock because the ctor declaration would
// conflict with a macro named MutexLock, which is defined on some
// platforms. That macro is used as a defensive measure to prevent against
// inadvertent misuses of MutexLock like "MutexLock(&mu)" rather than
// "MutexLock l(&mu)".  Hence the typedef trick below.
class GTestMutexLock {
 public:
  explicit GTestMutexLock(Mutex* mutex)
      : mutex_(mutex) { mutex_->Lock(); }

  ~GTestMutexLock() { mutex_->Unlock(); }

 private:
  Mutex* const mutex_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(GTestMutexLock);
};

typedef GTestMutexLock MutexLock;

// Base class for ValueHolder.  Allows a caller to hold and delete a value
// without knowing its type.
class ThreadLocalValueHolderBase {
 public:
  virtual ~ThreadLocalValueHolderBase() {}
};

// Provides a way for a thread to send notifications to a ThreadLocal
// regardless of its parameter type.
class ThreadLocalBase {
 public:
  // Creates a new ValueHolder object holding a default value passed to
  // this ThreadLocal's constructor and returns it.  It is the caller's
  // responsibility not to call this when the ThreadLocal instance already
  // has a value on the current thread.
  virtual ThreadLocalValueHolderBase* NewValueForCurrentThread() const = 0;

 protected:
  ThreadLocalBase() {}
  virtual ~ThreadLocalBase() {}

 private:
  GTEST_DISALLOW_COPY_AND_ASSIGN_(ThreadLocalBase);
};

// Maps a thread to a set of ThreadLocals that have values instantiated on that
// thread and notifies them when the thread exits.  A ThreadLocal instance is
// expected to persist until all threads it has values on have terminated.
class GTEST_API_ ThreadLocalRegistry {
 public:
  // Registers thread_local_instance as having value on the current thread.
  // Returns a value that can be used to identify the thread from other threads.
  static ThreadLocalValueHolderBase* GetValueOnCurrentThread(
      const ThreadLocalBase* thread_local_instance);

  // Invoked when a ThreadLocal instance is destroyed.
  static void OnThreadLocalDestroyed(
      const ThreadLocalBase* thread_local_instance);
};

class GTEST_API_ ThreadWithParamBase {
 public:
  void Join();

 protected:
  class Runnable {
   public:
    virtual ~Runnable() {}
    virtual void Run() = 0;
  };

  ThreadWithParamBase(Runnable *runnable, Notification* thread_can_start);
  virtual ~ThreadWithParamBase();

 private:
  AutoHandle thread_;
};

// Helper class for testing Google Test's multi-threading constructs.
template 
class ThreadWithParam : public ThreadWithParamBase {
 public:
  typedef void UserThreadFunc(T);

  ThreadWithParam(UserThreadFunc* func, T param, Notification* thread_can_start)
      : ThreadWithParamBase(new RunnableImpl(func, param), thread_can_start) {
  }
  virtual ~ThreadWithParam() {}

 private:
  class RunnableImpl : public Runnable {
   public:
    RunnableImpl(UserThreadFunc* func, T param)
        : func_(func),
          param_(param) {
    }
    virtual ~RunnableImpl() {}
    virtual void Run() {
      func_(param_);
    }

   private:
    UserThreadFunc* const func_;
    const T param_;

    GTEST_DISALLOW_COPY_AND_ASSIGN_(RunnableImpl);
  };

  GTEST_DISALLOW_COPY_AND_ASSIGN_(ThreadWithParam);
};

// Implements thread-local storage on Windows systems.
//
//   // Thread 1
//   ThreadLocal tl(100);  // 100 is the default value for each thread.
//
//   // Thread 2
//   tl.set(150);  // Changes the value for thread 2 only.
//   EXPECT_EQ(150, tl.get());
//
//   // Thread 1
//   EXPECT_EQ(100, tl.get());  // In thread 1, tl has the original value.
//   tl.set(200);
//   EXPECT_EQ(200, tl.get());
//
// The template type argument T must have a public copy constructor.
// In addition, the default ThreadLocal constructor requires T to have
// a public default constructor.
//
// The users of a TheadLocal instance have to make sure that all but one
// threads (including the main one) using that instance have exited before
// destroying it. Otherwise, the per-thread objects managed for them by the
// ThreadLocal instance are not guaranteed to be destroyed on all platforms.
//
// Google Test only uses global ThreadLocal objects.  That means they
// will die after main() has returned.  Therefore, no per-thread
// object managed by Google Test will be leaked as long as all threads
// using Google Test have exited when main() returns.
template 
class ThreadLocal : public ThreadLocalBase {
 public:
  ThreadLocal() : default_() {}
  explicit ThreadLocal(const T& value) : default_(value) {}

  ~ThreadLocal() { ThreadLocalRegistry::OnThreadLocalDestroyed(this); }

  T* pointer() { return GetOrCreateValue(); }
  const T* pointer() const { return GetOrCreateValue(); }
  const T& get() const { return *pointer(); }
  void set(const T& value) { *pointer() = value; }

 private:
  // Holds a value of T.  Can be deleted via its base class without the caller
  // knowing the type of T.
  class ValueHolder : public ThreadLocalValueHolderBase {
   public:
    explicit ValueHolder(const T& value) : value_(value) {}

    T* pointer() { return &value_; }

   private:
    T value_;
    GTEST_DISALLOW_COPY_AND_ASSIGN_(ValueHolder);
  };


  T* GetOrCreateValue() const {
    return static_cast(
        ThreadLocalRegistry::GetValueOnCurrentThread(this))->pointer();
  }

  virtual ThreadLocalValueHolderBase* NewValueForCurrentThread() const {
    return new ValueHolder(default_);
  }

  const T default_;  // The default value for each thread.

  GTEST_DISALLOW_COPY_AND_ASSIGN_(ThreadLocal);
};

# elif GTEST_HAS_PTHREAD

// MutexBase and Mutex implement mutex on pthreads-based platforms.
class MutexBase {
 public:
  // Acquires this mutex.
  void Lock() {
    GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_lock(&mutex_));
    owner_ = pthread_self();
    has_owner_ = true;
  }

  // Releases this mutex.
  void Unlock() {
    // Since the lock is being released the owner_ field should no longer be
    // considered valid. We don't protect writing to has_owner_ here, as it's
    // the caller's responsibility to ensure that the current thread holds the
    // mutex when this is called.
    has_owner_ = false;
    GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_unlock(&mutex_));
  }

  // Does nothing if the current thread holds the mutex. Otherwise, crashes
  // with high probability.
  void AssertHeld() const {
    GTEST_CHECK_(has_owner_ && pthread_equal(owner_, pthread_self()))
        << "The current thread is not holding the mutex @" << this;
  }

  // A static mutex may be used before main() is entered.  It may even
  // be used before the dynamic initialization stage.  Therefore we
  // must be able to initialize a static mutex object at link time.
  // This means MutexBase has to be a POD and its member variables
  // have to be public.
 public:
  pthread_mutex_t mutex_;  // The underlying pthread mutex.
  // has_owner_ indicates whether the owner_ field below contains a valid thread
  // ID and is therefore safe to inspect (e.g., to use in pthread_equal()). All
  // accesses to the owner_ field should be protected by a check of this field.
  // An alternative might be to memset() owner_ to all zeros, but there's no
  // guarantee that a zero'd pthread_t is necessarily invalid or even different
  // from pthread_self().
  bool has_owner_;
  pthread_t owner_;  // The thread holding the mutex.
};

// Forward-declares a static mutex.
#  define GTEST_DECLARE_STATIC_MUTEX_(mutex) \
     extern ::testing::internal::MutexBase mutex

// Defines and statically (i.e. at link time) initializes a static mutex.
// The initialization list here does not explicitly initialize each field,
// instead relying on default initialization for the unspecified fields. In
// particular, the owner_ field (a pthread_t) is not explicitly initialized.
// This allows initialization to work whether pthread_t is a scalar or struct.
// The flag -Wmissing-field-initializers must not be specified for this to work.
#  define GTEST_DEFINE_STATIC_MUTEX_(mutex) \
     ::testing::internal::MutexBase mutex = { PTHREAD_MUTEX_INITIALIZER, false }

// The Mutex class can only be used for mutexes created at runtime. It
// shares its API with MutexBase otherwise.
class Mutex : public MutexBase {
 public:
  Mutex() {
    GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_init(&mutex_, NULL));
    has_owner_ = false;
  }
  ~Mutex() {
    GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_destroy(&mutex_));
  }

 private:
  GTEST_DISALLOW_COPY_AND_ASSIGN_(Mutex);
};

// We cannot name this class MutexLock because the ctor declaration would
// conflict with a macro named MutexLock, which is defined on some
// platforms. That macro is used as a defensive measure to prevent against
// inadvertent misuses of MutexLock like "MutexLock(&mu)" rather than
// "MutexLock l(&mu)".  Hence the typedef trick below.
class GTestMutexLock {
 public:
  explicit GTestMutexLock(MutexBase* mutex)
      : mutex_(mutex) { mutex_->Lock(); }

  ~GTestMutexLock() { mutex_->Unlock(); }

 private:
  MutexBase* const mutex_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(GTestMutexLock);
};

typedef GTestMutexLock MutexLock;

// Helpers for ThreadLocal.

// pthread_key_create() requires DeleteThreadLocalValue() to have
// C-linkage.  Therefore it cannot be templatized to access
// ThreadLocal.  Hence the need for class
// ThreadLocalValueHolderBase.
class ThreadLocalValueHolderBase {
 public:
  virtual ~ThreadLocalValueHolderBase() {}
};

// Called by pthread to delete thread-local data stored by
// pthread_setspecific().
extern "C" inline void DeleteThreadLocalValue(void* value_holder) {
  delete static_cast(value_holder);
}

// Implements thread-local storage on pthreads-based systems.
template 
class ThreadLocal {
 public:
  ThreadLocal() : key_(CreateKey()),
                  default_() {}
  explicit ThreadLocal(const T& value) : key_(CreateKey()),
                                         default_(value) {}

  ~ThreadLocal() {
    // Destroys the managed object for the current thread, if any.
    DeleteThreadLocalValue(pthread_getspecific(key_));

    // Releases resources associated with the key.  This will *not*
    // delete managed objects for other threads.
    GTEST_CHECK_POSIX_SUCCESS_(pthread_key_delete(key_));
  }

  T* pointer() { return GetOrCreateValue(); }
  const T* pointer() const { return GetOrCreateValue(); }
  const T& get() const { return *pointer(); }
  void set(const T& value) { *pointer() = value; }

 private:
  // Holds a value of type T.
  class ValueHolder : public ThreadLocalValueHolderBase {
   public:
    explicit ValueHolder(const T& value) : value_(value) {}

    T* pointer() { return &value_; }

   private:
    T value_;
    GTEST_DISALLOW_COPY_AND_ASSIGN_(ValueHolder);
  };

  static pthread_key_t CreateKey() {
    pthread_key_t key;
    // When a thread exits, DeleteThreadLocalValue() will be called on
    // the object managed for that thread.
    GTEST_CHECK_POSIX_SUCCESS_(
        pthread_key_create(&key, &DeleteThreadLocalValue));
    return key;
  }

  T* GetOrCreateValue() const {
    ThreadLocalValueHolderBase* const holder =
        static_cast(pthread_getspecific(key_));
    if (holder != NULL) {
      return CheckedDowncastToActualType(holder)->pointer();
    }

    ValueHolder* const new_holder = new ValueHolder(default_);
    ThreadLocalValueHolderBase* const holder_base = new_holder;
    GTEST_CHECK_POSIX_SUCCESS_(pthread_setspecific(key_, holder_base));
    return new_holder->pointer();
  }

  // A key pthreads uses for looking up per-thread values.
  const pthread_key_t key_;
  const T default_;  // The default value for each thread.

  GTEST_DISALLOW_COPY_AND_ASSIGN_(ThreadLocal);
};

# endif  // OS detection

#else  // GTEST_IS_THREADSAFE

// A dummy implementation of synchronization primitives (mutex, lock,
// and thread-local variable).  Necessary for compiling Google Test where
// mutex is not supported - using Google Test in multiple threads is not
// supported on such platforms.

class Mutex {
 public:
  Mutex() {}
  void Lock() {}
  void Unlock() {}
  void AssertHeld() const {}
};

# define GTEST_DECLARE_STATIC_MUTEX_(mutex) \
  extern ::testing::internal::Mutex mutex

# define GTEST_DEFINE_STATIC_MUTEX_(mutex) ::testing::internal::Mutex mutex

// We cannot name this class MutexLock because the ctor declaration would
// conflict with a macro named MutexLock, which is defined on some
// platforms. That macro is used as a defensive measure to prevent against
// inadvertent misuses of MutexLock like "MutexLock(&mu)" rather than
// "MutexLock l(&mu)".  Hence the typedef trick below.
class GTestMutexLock {
 public:
  explicit GTestMutexLock(Mutex*) {}  // NOLINT
};

typedef GTestMutexLock MutexLock;

template 
class ThreadLocal {
 public:
  ThreadLocal() : value_() {}
  explicit ThreadLocal(const T& value) : value_(value) {}
  T* pointer() { return &value_; }
  const T* pointer() const { return &value_; }
  const T& get() const { return value_; }
  void set(const T& value) { value_ = value; }
 private:
  T value_;
};

#endif  // GTEST_IS_THREADSAFE

// Returns the number of threads running in the process, or 0 to indicate that
// we cannot detect it.
GTEST_API_ size_t GetThreadCount();

// Passing non-POD classes through ellipsis (...) crashes the ARM
// compiler and generates a warning in Sun Studio.  The Nokia Symbian
// and the IBM XL C/C++ compiler try to instantiate a copy constructor
// for objects passed through ellipsis (...), failing for uncopyable
// objects.  We define this to ensure that only POD is passed through
// ellipsis on these systems.
#if defined(__SYMBIAN32__) || defined(__IBMCPP__) || defined(__SUNPRO_CC)
// We lose support for NULL detection where the compiler doesn't like
// passing non-POD classes through ellipsis (...).
# define GTEST_ELLIPSIS_NEEDS_POD_ 1
#else
# define GTEST_CAN_COMPARE_NULL 1
#endif

// The Nokia Symbian and IBM XL C/C++ compilers cannot decide between
// const T& and const T* in a function template.  These compilers
// _can_ decide between class template specializations for T and T*,
// so a tr1::type_traits-like is_pointer works.
#if defined(__SYMBIAN32__) || defined(__IBMCPP__)
# define GTEST_NEEDS_IS_POINTER_ 1
#endif

template 
struct bool_constant {
  typedef bool_constant type;
  static const bool value = bool_value;
};
template  const bool bool_constant::value;

typedef bool_constant false_type;
typedef bool_constant true_type;

template 
struct is_pointer : public false_type {};

template 
struct is_pointer : public true_type {};

template 
struct IteratorTraits {
  typedef typename Iterator::value_type value_type;
};

template 
struct IteratorTraits {
  typedef T value_type;
};

template 
struct IteratorTraits {
  typedef T value_type;
};

#if GTEST_OS_WINDOWS
# define GTEST_PATH_SEP_ "\\"
# define GTEST_HAS_ALT_PATH_SEP_ 1
// The biggest signed integer type the compiler supports.
typedef __int64 BiggestInt;
#else
# define GTEST_PATH_SEP_ "/"
# define GTEST_HAS_ALT_PATH_SEP_ 0
typedef long long BiggestInt;  // NOLINT
#endif  // GTEST_OS_WINDOWS

// Utilities for char.

// isspace(int ch) and friends accept an unsigned char or EOF.  char
// may be signed, depending on the compiler (or compiler flags).
// Therefore we need to cast a char to unsigned char before calling
// isspace(), etc.

inline bool IsAlpha(char ch) {
  return isalpha(static_cast(ch)) != 0;
}
inline bool IsAlNum(char ch) {
  return isalnum(static_cast(ch)) != 0;
}
inline bool IsDigit(char ch) {
  return isdigit(static_cast(ch)) != 0;
}
inline bool IsLower(char ch) {
  return islower(static_cast(ch)) != 0;
}
inline bool IsSpace(char ch) {
  return isspace(static_cast(ch)) != 0;
}
inline bool IsUpper(char ch) {
  return isupper(static_cast(ch)) != 0;
}
inline bool IsXDigit(char ch) {
  return isxdigit(static_cast(ch)) != 0;
}
inline bool IsXDigit(wchar_t ch) {
  const unsigned char low_byte = static_cast(ch);
  return ch == low_byte && isxdigit(low_byte) != 0;
}

inline char ToLower(char ch) {
  return static_cast(tolower(static_cast(ch)));
}
inline char ToUpper(char ch) {
  return static_cast(toupper(static_cast(ch)));
}

inline std::string StripTrailingSpaces(std::string str) {
  std::string::iterator it = str.end();
  while (it != str.begin() && IsSpace(*--it))
    it = str.erase(it);
  return str;
}

// The testing::internal::posix namespace holds wrappers for common
// POSIX functions.  These wrappers hide the differences between
// Windows/MSVC and POSIX systems.  Since some compilers define these
// standard functions as macros, the wrapper cannot have the same name
// as the wrapped function.

namespace posix {

// Functions with a different name on Windows.

#if GTEST_OS_WINDOWS

typedef struct _stat StatStruct;

# ifdef __BORLANDC__
inline int IsATTY(int fd) { return isatty(fd); }
inline int StrCaseCmp(const char* s1, const char* s2) {
  return stricmp(s1, s2);
}
inline char* StrDup(const char* src) { return strdup(src); }
# else  // !__BORLANDC__
#  if GTEST_OS_WINDOWS_MOBILE
inline int IsATTY(int /* fd */) { return 0; }
#  else
inline int IsATTY(int fd) { return _isatty(fd); }
#  endif  // GTEST_OS_WINDOWS_MOBILE
inline int StrCaseCmp(const char* s1, const char* s2) {
  return _stricmp(s1, s2);
}
inline char* StrDup(const char* src) { return _strdup(src); }
# endif  // __BORLANDC__

# if GTEST_OS_WINDOWS_MOBILE
inline int FileNo(FILE* file) { return reinterpret_cast(_fileno(file)); }
// Stat(), RmDir(), and IsDir() are not needed on Windows CE at this
// time and thus not defined there.
# else
inline int FileNo(FILE* file) { return _fileno(file); }
inline int Stat(const char* path, StatStruct* buf) { return _stat(path, buf); }
inline int RmDir(const char* dir) { return _rmdir(dir); }
inline bool IsDir(const StatStruct& st) {
  return (_S_IFDIR & st.st_mode) != 0;
}
# endif  // GTEST_OS_WINDOWS_MOBILE

#else

typedef struct stat StatStruct;

inline int FileNo(FILE* file) { return fileno(file); }
inline int IsATTY(int fd) { return isatty(fd); }
inline int Stat(const char* path, StatStruct* buf) { return stat(path, buf); }
inline int StrCaseCmp(const char* s1, const char* s2) {
  return strcasecmp(s1, s2);
}
inline char* StrDup(const char* src) { return strdup(src); }
inline int RmDir(const char* dir) { return rmdir(dir); }
inline bool IsDir(const StatStruct& st) { return S_ISDIR(st.st_mode); }

#endif  // GTEST_OS_WINDOWS

// Functions deprecated by MSVC 8.0.

GTEST_DISABLE_MSC_WARNINGS_PUSH_(4996 /* deprecated function */)

inline const char* StrNCpy(char* dest, const char* src, size_t n) {
  return strncpy(dest, src, n);
}

// ChDir(), FReopen(), FDOpen(), Read(), Write(), Close(), and
// StrError() aren't needed on Windows CE at this time and thus not
// defined there.

#if !GTEST_OS_WINDOWS_MOBILE && !GTEST_OS_WINDOWS_PHONE && !GTEST_OS_WINDOWS_RT
inline int ChDir(const char* dir) { return chdir(dir); }
#endif
inline FILE* FOpen(const char* path, const char* mode) {
  return fopen(path, mode);
}
#if !GTEST_OS_WINDOWS_MOBILE
inline FILE *FReopen(const char* path, const char* mode, FILE* stream) {
  return freopen(path, mode, stream);
}
inline FILE* FDOpen(int fd, const char* mode) { return fdopen(fd, mode); }
#endif
inline int FClose(FILE* fp) { return fclose(fp); }
#if !GTEST_OS_WINDOWS_MOBILE
inline int Read(int fd, void* buf, unsigned int count) {
  return static_cast(read(fd, buf, count));
}
inline int Write(int fd, const void* buf, unsigned int count) {
  return static_cast(write(fd, buf, count));
}
inline int Close(int fd) { return close(fd); }
inline const char* StrError(int errnum) { return strerror(errnum); }
#endif
inline const char* GetEnv(const char* name) {
#if GTEST_OS_WINDOWS_MOBILE || GTEST_OS_WINDOWS_PHONE | GTEST_OS_WINDOWS_RT
  // We are on Windows CE, which has no environment variables.
  static_cast(name);  // To prevent 'unused argument' warning.
  return NULL;
#elif defined(__BORLANDC__) || defined(__SunOS_5_8) || defined(__SunOS_5_9)
  // Environment variables which we programmatically clear will be set to the
  // empty string rather than unset (NULL).  Handle that case.
  const char* const env = getenv(name);
  return (env != NULL && env[0] != '\0') ? env : NULL;
#else
  return getenv(name);
#endif
}

GTEST_DISABLE_MSC_WARNINGS_POP_()

#if GTEST_OS_WINDOWS_MOBILE
// Windows CE has no C library. The abort() function is used in
// several places in Google Test. This implementation provides a reasonable
// imitation of standard behaviour.
void Abort();
#else
inline void Abort() { abort(); }
#endif  // GTEST_OS_WINDOWS_MOBILE

}  // namespace posix

// MSVC "deprecates" snprintf and issues warnings wherever it is used.  In
// order to avoid these warnings, we need to use _snprintf or _snprintf_s on
// MSVC-based platforms.  We map the GTEST_SNPRINTF_ macro to the appropriate
// function in order to achieve that.  We use macro definition here because
// snprintf is a variadic function.
#if _MSC_VER >= 1400 && !GTEST_OS_WINDOWS_MOBILE
// MSVC 2005 and above support variadic macros.
# define GTEST_SNPRINTF_(buffer, size, format, ...) \
     _snprintf_s(buffer, size, size, format, __VA_ARGS__)
#elif defined(_MSC_VER)
// Windows CE does not define _snprintf_s and MSVC prior to 2005 doesn't
// complain about _snprintf.
# define GTEST_SNPRINTF_ _snprintf
#else
# define GTEST_SNPRINTF_ snprintf
#endif

// The maximum number a BiggestInt can represent.  This definition
// works no matter BiggestInt is represented in one's complement or
// two's complement.
//
// We cannot rely on numeric_limits in STL, as __int64 and long long
// are not part of standard C++ and numeric_limits doesn't need to be
// defined for them.
const BiggestInt kMaxBiggestInt =
    ~(static_cast(1) << (8*sizeof(BiggestInt) - 1));

// This template class serves as a compile-time function from size to
// type.  It maps a size in bytes to a primitive type with that
// size. e.g.
//
//   TypeWithSize<4>::UInt
//
// is typedef-ed to be unsigned int (unsigned integer made up of 4
// bytes).
//
// Such functionality should belong to STL, but I cannot find it
// there.
//
// Google Test uses this class in the implementation of floating-point
// comparison.
//
// For now it only handles UInt (unsigned int) as that's all Google Test
// needs.  Other types can be easily added in the future if need
// arises.
template 
class TypeWithSize {
 public:
  // This prevents the user from using TypeWithSize with incorrect
  // values of N.
  typedef void UInt;
};

// The specialization for size 4.
template <>
class TypeWithSize<4> {
 public:
  // unsigned int has size 4 in both gcc and MSVC.
  //
  // As base/basictypes.h doesn't compile on Windows, we cannot use
  // uint32, uint64, and etc here.
  typedef int Int;
  typedef unsigned int UInt;
};

// The specialization for size 8.
template <>
class TypeWithSize<8> {
 public:
#if GTEST_OS_WINDOWS
  typedef __int64 Int;
  typedef unsigned __int64 UInt;
#else
  typedef long long Int;  // NOLINT
  typedef unsigned long long UInt;  // NOLINT
#endif  // GTEST_OS_WINDOWS
};

// Integer types of known sizes.
typedef TypeWithSize<4>::Int Int32;
typedef TypeWithSize<4>::UInt UInt32;
typedef TypeWithSize<8>::Int Int64;
typedef TypeWithSize<8>::UInt UInt64;
typedef TypeWithSize<8>::Int TimeInMillis;  // Represents time in milliseconds.

// Utilities for command line flags and environment variables.

// Macro for referencing flags.
#define GTEST_FLAG(name) FLAGS_gtest_##name

// Macros for declaring flags.
#define GTEST_DECLARE_bool_(name) GTEST_API_ extern bool GTEST_FLAG(name)
#define GTEST_DECLARE_int32_(name) \
    GTEST_API_ extern ::testing::internal::Int32 GTEST_FLAG(name)
#define GTEST_DECLARE_string_(name) \
    GTEST_API_ extern ::std::string GTEST_FLAG(name)

// Macros for defining flags.
#define GTEST_DEFINE_bool_(name, default_val, doc) \
    GTEST_API_ bool GTEST_FLAG(name) = (default_val)
#define GTEST_DEFINE_int32_(name, default_val, doc) \
    GTEST_API_ ::testing::internal::Int32 GTEST_FLAG(name) = (default_val)
#define GTEST_DEFINE_string_(name, default_val, doc) \
    GTEST_API_ ::std::string GTEST_FLAG(name) = (default_val)

// Thread annotations
#define GTEST_EXCLUSIVE_LOCK_REQUIRED_(locks)
#define GTEST_LOCK_EXCLUDED_(locks)

// Parses 'str' for a 32-bit signed integer.  If successful, writes the result
// to *value and returns true; otherwise leaves *value unchanged and returns
// false.
// TODO(chandlerc): Find a better way to refactor flag and environment parsing
// out of both gtest-port.cc and gtest.cc to avoid exporting this utility
// function.
bool ParseInt32(const Message& src_text, const char* str, Int32* value);

// Parses a bool/Int32/string from the environment variable
// corresponding to the given Google Test flag.
bool BoolFromGTestEnv(const char* flag, bool default_val);
GTEST_API_ Int32 Int32FromGTestEnv(const char* flag, Int32 default_val);
const char* StringFromGTestEnv(const char* flag, const char* default_val);

}  // namespace internal
}  // namespace testing

#endif  // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PORT_H_

node-v4.8.2/deps/gtest/include/gtest/internal/gtest-string.h000644 000766 000024 00000015470 13070706730 024233 0ustar00iojsstaff000000 000000 // Copyright 2005, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Authors: wan@google.com (Zhanyong Wan), eefacm@gmail.com (Sean Mcafee)
//
// The Google C++ Testing Framework (Google Test)
//
// This header file declares the String class and functions used internally by
// Google Test.  They are subject to change without notice. They should not used
// by code external to Google Test.
//
// This header file is #included by .
// It should not be #included by other files.

#ifndef GTEST_INCLUDE_GTEST_INTERNAL_GTEST_STRING_H_
#define GTEST_INCLUDE_GTEST_INTERNAL_GTEST_STRING_H_

#ifdef __BORLANDC__
// string.h is not guaranteed to provide strcpy on C++ Builder.
# include 
#endif

#include 
#include 

#include "gtest/internal/gtest-port.h"

namespace testing {
namespace internal {

// String - an abstract class holding static string utilities.
class GTEST_API_ String {
 public:
  // Static utility methods

  // Clones a 0-terminated C string, allocating memory using new.  The
  // caller is responsible for deleting the return value using
  // delete[].  Returns the cloned string, or NULL if the input is
  // NULL.
  //
  // This is different from strdup() in string.h, which allocates
  // memory using malloc().
  static const char* CloneCString(const char* c_str);

#if GTEST_OS_WINDOWS_MOBILE
  // Windows CE does not have the 'ANSI' versions of Win32 APIs. To be
  // able to pass strings to Win32 APIs on CE we need to convert them
  // to 'Unicode', UTF-16.

  // Creates a UTF-16 wide string from the given ANSI string, allocating
  // memory using new. The caller is responsible for deleting the return
  // value using delete[]. Returns the wide string, or NULL if the
  // input is NULL.
  //
  // The wide string is created using the ANSI codepage (CP_ACP) to
  // match the behaviour of the ANSI versions of Win32 calls and the
  // C runtime.
  static LPCWSTR AnsiToUtf16(const char* c_str);

  // Creates an ANSI string from the given wide string, allocating
  // memory using new. The caller is responsible for deleting the return
  // value using delete[]. Returns the ANSI string, or NULL if the
  // input is NULL.
  //
  // The returned string is created using the ANSI codepage (CP_ACP) to
  // match the behaviour of the ANSI versions of Win32 calls and the
  // C runtime.
  static const char* Utf16ToAnsi(LPCWSTR utf16_str);
#endif

  // Compares two C strings.  Returns true iff they have the same content.
  //
  // Unlike strcmp(), this function can handle NULL argument(s).  A
  // NULL C string is considered different to any non-NULL C string,
  // including the empty string.
  static bool CStringEquals(const char* lhs, const char* rhs);

  // Converts a wide C string to a String using the UTF-8 encoding.
  // NULL will be converted to "(null)".  If an error occurred during
  // the conversion, "(failed to convert from wide string)" is
  // returned.
  static std::string ShowWideCString(const wchar_t* wide_c_str);

  // Compares two wide C strings.  Returns true iff they have the same
  // content.
  //
  // Unlike wcscmp(), this function can handle NULL argument(s).  A
  // NULL C string is considered different to any non-NULL C string,
  // including the empty string.
  static bool WideCStringEquals(const wchar_t* lhs, const wchar_t* rhs);

  // Compares two C strings, ignoring case.  Returns true iff they
  // have the same content.
  //
  // Unlike strcasecmp(), this function can handle NULL argument(s).
  // A NULL C string is considered different to any non-NULL C string,
  // including the empty string.
  static bool CaseInsensitiveCStringEquals(const char* lhs,
                                           const char* rhs);

  // Compares two wide C strings, ignoring case.  Returns true iff they
  // have the same content.
  //
  // Unlike wcscasecmp(), this function can handle NULL argument(s).
  // A NULL C string is considered different to any non-NULL wide C string,
  // including the empty string.
  // NB: The implementations on different platforms slightly differ.
  // On windows, this method uses _wcsicmp which compares according to LC_CTYPE
  // environment variable. On GNU platform this method uses wcscasecmp
  // which compares according to LC_CTYPE category of the current locale.
  // On MacOS X, it uses towlower, which also uses LC_CTYPE category of the
  // current locale.
  static bool CaseInsensitiveWideCStringEquals(const wchar_t* lhs,
                                               const wchar_t* rhs);

  // Returns true iff the given string ends with the given suffix, ignoring
  // case. Any string is considered to end with an empty suffix.
  static bool EndsWithCaseInsensitive(
      const std::string& str, const std::string& suffix);

  // Formats an int value as "%02d".
  static std::string FormatIntWidth2(int value);  // "%02d" for width == 2

  // Formats an int value as "%X".
  static std::string FormatHexInt(int value);

  // Formats a byte as "%02X".
  static std::string FormatByte(unsigned char value);

 private:
  String();  // Not meant to be instantiated.
};  // class String

// Gets the content of the stringstream's buffer as an std::string.  Each '\0'
// character in the buffer is replaced with "\\0".
GTEST_API_ std::string StringStreamToString(::std::stringstream* stream);

}  // namespace internal
}  // namespace testing

#endif  // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_STRING_H_
node-v4.8.2/deps/gtest/include/gtest/internal/gtest-tuple.h000644 000766 000024 00000067711 13070706730 024063 0ustar00iojsstaff000000 000000 // This file was GENERATED by command:
//     pump.py gtest-tuple.h.pump
// DO NOT EDIT BY HAND!!!

// Copyright 2009 Google Inc.
// All Rights Reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Author: wan@google.com (Zhanyong Wan)

// Implements a subset of TR1 tuple needed by Google Test and Google Mock.

#ifndef GTEST_INCLUDE_GTEST_INTERNAL_GTEST_TUPLE_H_
#define GTEST_INCLUDE_GTEST_INTERNAL_GTEST_TUPLE_H_

#include   // For ::std::pair.

// The compiler used in Symbian has a bug that prevents us from declaring the
// tuple template as a friend (it complains that tuple is redefined).  This
// hack bypasses the bug by declaring the members that should otherwise be
// private as public.
// Sun Studio versions < 12 also have the above bug.
#if defined(__SYMBIAN32__) || (defined(__SUNPRO_CC) && __SUNPRO_CC < 0x590)
# define GTEST_DECLARE_TUPLE_AS_FRIEND_ public:
#else
# define GTEST_DECLARE_TUPLE_AS_FRIEND_ \
    template  friend class tuple; \
   private:
#endif

// Visual Studio 2010, 2012, and 2013 define symbols in std::tr1 that conflict
// with our own definitions. Therefore using our own tuple does not work on
// those compilers.
#if defined(_MSC_VER) && _MSC_VER >= 1600  /* 1600 is Visual Studio 2010 */
# error "gtest's tuple doesn't compile on Visual Studio 2010 or later. \
GTEST_USE_OWN_TR1_TUPLE must be set to 0 on those compilers."
#endif

// GTEST_n_TUPLE_(T) is the type of an n-tuple.
#define GTEST_0_TUPLE_(T) tuple<>
#define GTEST_1_TUPLE_(T) tuple
#define GTEST_2_TUPLE_(T) tuple
#define GTEST_3_TUPLE_(T) tuple
#define GTEST_4_TUPLE_(T) tuple
#define GTEST_5_TUPLE_(T) tuple
#define GTEST_6_TUPLE_(T) tuple
#define GTEST_7_TUPLE_(T) tuple
#define GTEST_8_TUPLE_(T) tuple
#define GTEST_9_TUPLE_(T) tuple
#define GTEST_10_TUPLE_(T) tuple

// GTEST_n_TYPENAMES_(T) declares a list of n typenames.
#define GTEST_0_TYPENAMES_(T)
#define GTEST_1_TYPENAMES_(T) typename T##0
#define GTEST_2_TYPENAMES_(T) typename T##0, typename T##1
#define GTEST_3_TYPENAMES_(T) typename T##0, typename T##1, typename T##2
#define GTEST_4_TYPENAMES_(T) typename T##0, typename T##1, typename T##2, \
    typename T##3
#define GTEST_5_TYPENAMES_(T) typename T##0, typename T##1, typename T##2, \
    typename T##3, typename T##4
#define GTEST_6_TYPENAMES_(T) typename T##0, typename T##1, typename T##2, \
    typename T##3, typename T##4, typename T##5
#define GTEST_7_TYPENAMES_(T) typename T##0, typename T##1, typename T##2, \
    typename T##3, typename T##4, typename T##5, typename T##6
#define GTEST_8_TYPENAMES_(T) typename T##0, typename T##1, typename T##2, \
    typename T##3, typename T##4, typename T##5, typename T##6, typename T##7
#define GTEST_9_TYPENAMES_(T) typename T##0, typename T##1, typename T##2, \
    typename T##3, typename T##4, typename T##5, typename T##6, \
    typename T##7, typename T##8
#define GTEST_10_TYPENAMES_(T) typename T##0, typename T##1, typename T##2, \
    typename T##3, typename T##4, typename T##5, typename T##6, \
    typename T##7, typename T##8, typename T##9

// In theory, defining stuff in the ::std namespace is undefined
// behavior.  We can do this as we are playing the role of a standard
// library vendor.
namespace std {
namespace tr1 {

template 
class tuple;

// Anything in namespace gtest_internal is Google Test's INTERNAL
// IMPLEMENTATION DETAIL and MUST NOT BE USED DIRECTLY in user code.
namespace gtest_internal {

// ByRef::type is T if T is a reference; otherwise it's const T&.
template 
struct ByRef { typedef const T& type; };  // NOLINT
template 
struct ByRef { typedef T& type; };  // NOLINT

// A handy wrapper for ByRef.
#define GTEST_BY_REF_(T) typename ::std::tr1::gtest_internal::ByRef::type

// AddRef::type is T if T is a reference; otherwise it's T&.  This
// is the same as tr1::add_reference::type.
template 
struct AddRef { typedef T& type; };  // NOLINT
template 
struct AddRef { typedef T& type; };  // NOLINT

// A handy wrapper for AddRef.
#define GTEST_ADD_REF_(T) typename ::std::tr1::gtest_internal::AddRef::type

// A helper for implementing get().
template  class Get;

// A helper for implementing tuple_element.  kIndexValid is true
// iff k < the number of fields in tuple type T.
template 
struct TupleElement;

template 
struct TupleElement {
  typedef T0 type;
};

template 
struct TupleElement {
  typedef T1 type;
};

template 
struct TupleElement {
  typedef T2 type;
};

template 
struct TupleElement {
  typedef T3 type;
};

template 
struct TupleElement {
  typedef T4 type;
};

template 
struct TupleElement {
  typedef T5 type;
};

template 
struct TupleElement {
  typedef T6 type;
};

template 
struct TupleElement {
  typedef T7 type;
};

template 
struct TupleElement {
  typedef T8 type;
};

template 
struct TupleElement {
  typedef T9 type;
};

}  // namespace gtest_internal

template <>
class tuple<> {
 public:
  tuple() {}
  tuple(const tuple& /* t */)  {}
  tuple& operator=(const tuple& /* t */) { return *this; }
};

template 
class GTEST_1_TUPLE_(T) {
 public:
  template  friend class gtest_internal::Get;

  tuple() : f0_() {}

  explicit tuple(GTEST_BY_REF_(T0) f0) : f0_(f0) {}

  tuple(const tuple& t) : f0_(t.f0_) {}

  template 
  tuple(const GTEST_1_TUPLE_(U)& t) : f0_(t.f0_) {}

  tuple& operator=(const tuple& t) { return CopyFrom(t); }

  template 
  tuple& operator=(const GTEST_1_TUPLE_(U)& t) {
    return CopyFrom(t);
  }

  GTEST_DECLARE_TUPLE_AS_FRIEND_

  template 
  tuple& CopyFrom(const GTEST_1_TUPLE_(U)& t) {
    f0_ = t.f0_;
    return *this;
  }

  T0 f0_;
};

template 
class GTEST_2_TUPLE_(T) {
 public:
  template  friend class gtest_internal::Get;

  tuple() : f0_(), f1_() {}

  explicit tuple(GTEST_BY_REF_(T0) f0, GTEST_BY_REF_(T1) f1) : f0_(f0),
      f1_(f1) {}

  tuple(const tuple& t) : f0_(t.f0_), f1_(t.f1_) {}

  template 
  tuple(const GTEST_2_TUPLE_(U)& t) : f0_(t.f0_), f1_(t.f1_) {}
  template 
  tuple(const ::std::pair& p) : f0_(p.first), f1_(p.second) {}

  tuple& operator=(const tuple& t) { return CopyFrom(t); }

  template 
  tuple& operator=(const GTEST_2_TUPLE_(U)& t) {
    return CopyFrom(t);
  }
  template 
  tuple& operator=(const ::std::pair& p) {
    f0_ = p.first;
    f1_ = p.second;
    return *this;
  }

  GTEST_DECLARE_TUPLE_AS_FRIEND_

  template 
  tuple& CopyFrom(const GTEST_2_TUPLE_(U)& t) {
    f0_ = t.f0_;
    f1_ = t.f1_;
    return *this;
  }

  T0 f0_;
  T1 f1_;
};

template 
class GTEST_3_TUPLE_(T) {
 public:
  template  friend class gtest_internal::Get;

  tuple() : f0_(), f1_(), f2_() {}

  explicit tuple(GTEST_BY_REF_(T0) f0, GTEST_BY_REF_(T1) f1,
      GTEST_BY_REF_(T2) f2) : f0_(f0), f1_(f1), f2_(f2) {}

  tuple(const tuple& t) : f0_(t.f0_), f1_(t.f1_), f2_(t.f2_) {}

  template 
  tuple(const GTEST_3_TUPLE_(U)& t) : f0_(t.f0_), f1_(t.f1_), f2_(t.f2_) {}

  tuple& operator=(const tuple& t) { return CopyFrom(t); }

  template 
  tuple& operator=(const GTEST_3_TUPLE_(U)& t) {
    return CopyFrom(t);
  }

  GTEST_DECLARE_TUPLE_AS_FRIEND_

  template 
  tuple& CopyFrom(const GTEST_3_TUPLE_(U)& t) {
    f0_ = t.f0_;
    f1_ = t.f1_;
    f2_ = t.f2_;
    return *this;
  }

  T0 f0_;
  T1 f1_;
  T2 f2_;
};

template 
class GTEST_4_TUPLE_(T) {
 public:
  template  friend class gtest_internal::Get;

  tuple() : f0_(), f1_(), f2_(), f3_() {}

  explicit tuple(GTEST_BY_REF_(T0) f0, GTEST_BY_REF_(T1) f1,
      GTEST_BY_REF_(T2) f2, GTEST_BY_REF_(T3) f3) : f0_(f0), f1_(f1), f2_(f2),
      f3_(f3) {}

  tuple(const tuple& t) : f0_(t.f0_), f1_(t.f1_), f2_(t.f2_), f3_(t.f3_) {}

  template 
  tuple(const GTEST_4_TUPLE_(U)& t) : f0_(t.f0_), f1_(t.f1_), f2_(t.f2_),
      f3_(t.f3_) {}

  tuple& operator=(const tuple& t) { return CopyFrom(t); }

  template 
  tuple& operator=(const GTEST_4_TUPLE_(U)& t) {
    return CopyFrom(t);
  }

  GTEST_DECLARE_TUPLE_AS_FRIEND_

  template 
  tuple& CopyFrom(const GTEST_4_TUPLE_(U)& t) {
    f0_ = t.f0_;
    f1_ = t.f1_;
    f2_ = t.f2_;
    f3_ = t.f3_;
    return *this;
  }

  T0 f0_;
  T1 f1_;
  T2 f2_;
  T3 f3_;
};

template 
class GTEST_5_TUPLE_(T) {
 public:
  template  friend class gtest_internal::Get;

  tuple() : f0_(), f1_(), f2_(), f3_(), f4_() {}

  explicit tuple(GTEST_BY_REF_(T0) f0, GTEST_BY_REF_(T1) f1,
      GTEST_BY_REF_(T2) f2, GTEST_BY_REF_(T3) f3,
      GTEST_BY_REF_(T4) f4) : f0_(f0), f1_(f1), f2_(f2), f3_(f3), f4_(f4) {}

  tuple(const tuple& t) : f0_(t.f0_), f1_(t.f1_), f2_(t.f2_), f3_(t.f3_),
      f4_(t.f4_) {}

  template 
  tuple(const GTEST_5_TUPLE_(U)& t) : f0_(t.f0_), f1_(t.f1_), f2_(t.f2_),
      f3_(t.f3_), f4_(t.f4_) {}

  tuple& operator=(const tuple& t) { return CopyFrom(t); }

  template 
  tuple& operator=(const GTEST_5_TUPLE_(U)& t) {
    return CopyFrom(t);
  }

  GTEST_DECLARE_TUPLE_AS_FRIEND_

  template 
  tuple& CopyFrom(const GTEST_5_TUPLE_(U)& t) {
    f0_ = t.f0_;
    f1_ = t.f1_;
    f2_ = t.f2_;
    f3_ = t.f3_;
    f4_ = t.f4_;
    return *this;
  }

  T0 f0_;
  T1 f1_;
  T2 f2_;
  T3 f3_;
  T4 f4_;
};

template 
class GTEST_6_TUPLE_(T) {
 public:
  template  friend class gtest_internal::Get;

  tuple() : f0_(), f1_(), f2_(), f3_(), f4_(), f5_() {}

  explicit tuple(GTEST_BY_REF_(T0) f0, GTEST_BY_REF_(T1) f1,
      GTEST_BY_REF_(T2) f2, GTEST_BY_REF_(T3) f3, GTEST_BY_REF_(T4) f4,
      GTEST_BY_REF_(T5) f5) : f0_(f0), f1_(f1), f2_(f2), f3_(f3), f4_(f4),
      f5_(f5) {}

  tuple(const tuple& t) : f0_(t.f0_), f1_(t.f1_), f2_(t.f2_), f3_(t.f3_),
      f4_(t.f4_), f5_(t.f5_) {}

  template 
  tuple(const GTEST_6_TUPLE_(U)& t) : f0_(t.f0_), f1_(t.f1_), f2_(t.f2_),
      f3_(t.f3_), f4_(t.f4_), f5_(t.f5_) {}

  tuple& operator=(const tuple& t) { return CopyFrom(t); }

  template 
  tuple& operator=(const GTEST_6_TUPLE_(U)& t) {
    return CopyFrom(t);
  }

  GTEST_DECLARE_TUPLE_AS_FRIEND_

  template 
  tuple& CopyFrom(const GTEST_6_TUPLE_(U)& t) {
    f0_ = t.f0_;
    f1_ = t.f1_;
    f2_ = t.f2_;
    f3_ = t.f3_;
    f4_ = t.f4_;
    f5_ = t.f5_;
    return *this;
  }

  T0 f0_;
  T1 f1_;
  T2 f2_;
  T3 f3_;
  T4 f4_;
  T5 f5_;
};

template 
class GTEST_7_TUPLE_(T) {
 public:
  template  friend class gtest_internal::Get;

  tuple() : f0_(), f1_(), f2_(), f3_(), f4_(), f5_(), f6_() {}

  explicit tuple(GTEST_BY_REF_(T0) f0, GTEST_BY_REF_(T1) f1,
      GTEST_BY_REF_(T2) f2, GTEST_BY_REF_(T3) f3, GTEST_BY_REF_(T4) f4,
      GTEST_BY_REF_(T5) f5, GTEST_BY_REF_(T6) f6) : f0_(f0), f1_(f1), f2_(f2),
      f3_(f3), f4_(f4), f5_(f5), f6_(f6) {}

  tuple(const tuple& t) : f0_(t.f0_), f1_(t.f1_), f2_(t.f2_), f3_(t.f3_),
      f4_(t.f4_), f5_(t.f5_), f6_(t.f6_) {}

  template 
  tuple(const GTEST_7_TUPLE_(U)& t) : f0_(t.f0_), f1_(t.f1_), f2_(t.f2_),
      f3_(t.f3_), f4_(t.f4_), f5_(t.f5_), f6_(t.f6_) {}

  tuple& operator=(const tuple& t) { return CopyFrom(t); }

  template 
  tuple& operator=(const GTEST_7_TUPLE_(U)& t) {
    return CopyFrom(t);
  }

  GTEST_DECLARE_TUPLE_AS_FRIEND_

  template 
  tuple& CopyFrom(const GTEST_7_TUPLE_(U)& t) {
    f0_ = t.f0_;
    f1_ = t.f1_;
    f2_ = t.f2_;
    f3_ = t.f3_;
    f4_ = t.f4_;
    f5_ = t.f5_;
    f6_ = t.f6_;
    return *this;
  }

  T0 f0_;
  T1 f1_;
  T2 f2_;
  T3 f3_;
  T4 f4_;
  T5 f5_;
  T6 f6_;
};

template 
class GTEST_8_TUPLE_(T) {
 public:
  template  friend class gtest_internal::Get;

  tuple() : f0_(), f1_(), f2_(), f3_(), f4_(), f5_(), f6_(), f7_() {}

  explicit tuple(GTEST_BY_REF_(T0) f0, GTEST_BY_REF_(T1) f1,
      GTEST_BY_REF_(T2) f2, GTEST_BY_REF_(T3) f3, GTEST_BY_REF_(T4) f4,
      GTEST_BY_REF_(T5) f5, GTEST_BY_REF_(T6) f6,
      GTEST_BY_REF_(T7) f7) : f0_(f0), f1_(f1), f2_(f2), f3_(f3), f4_(f4),
      f5_(f5), f6_(f6), f7_(f7) {}

  tuple(const tuple& t) : f0_(t.f0_), f1_(t.f1_), f2_(t.f2_), f3_(t.f3_),
      f4_(t.f4_), f5_(t.f5_), f6_(t.f6_), f7_(t.f7_) {}

  template 
  tuple(const GTEST_8_TUPLE_(U)& t) : f0_(t.f0_), f1_(t.f1_), f2_(t.f2_),
      f3_(t.f3_), f4_(t.f4_), f5_(t.f5_), f6_(t.f6_), f7_(t.f7_) {}

  tuple& operator=(const tuple& t) { return CopyFrom(t); }

  template 
  tuple& operator=(const GTEST_8_TUPLE_(U)& t) {
    return CopyFrom(t);
  }

  GTEST_DECLARE_TUPLE_AS_FRIEND_

  template 
  tuple& CopyFrom(const GTEST_8_TUPLE_(U)& t) {
    f0_ = t.f0_;
    f1_ = t.f1_;
    f2_ = t.f2_;
    f3_ = t.f3_;
    f4_ = t.f4_;
    f5_ = t.f5_;
    f6_ = t.f6_;
    f7_ = t.f7_;
    return *this;
  }

  T0 f0_;
  T1 f1_;
  T2 f2_;
  T3 f3_;
  T4 f4_;
  T5 f5_;
  T6 f6_;
  T7 f7_;
};

template 
class GTEST_9_TUPLE_(T) {
 public:
  template  friend class gtest_internal::Get;

  tuple() : f0_(), f1_(), f2_(), f3_(), f4_(), f5_(), f6_(), f7_(), f8_() {}

  explicit tuple(GTEST_BY_REF_(T0) f0, GTEST_BY_REF_(T1) f1,
      GTEST_BY_REF_(T2) f2, GTEST_BY_REF_(T3) f3, GTEST_BY_REF_(T4) f4,
      GTEST_BY_REF_(T5) f5, GTEST_BY_REF_(T6) f6, GTEST_BY_REF_(T7) f7,
      GTEST_BY_REF_(T8) f8) : f0_(f0), f1_(f1), f2_(f2), f3_(f3), f4_(f4),
      f5_(f5), f6_(f6), f7_(f7), f8_(f8) {}

  tuple(const tuple& t) : f0_(t.f0_), f1_(t.f1_), f2_(t.f2_), f3_(t.f3_),
      f4_(t.f4_), f5_(t.f5_), f6_(t.f6_), f7_(t.f7_), f8_(t.f8_) {}

  template 
  tuple(const GTEST_9_TUPLE_(U)& t) : f0_(t.f0_), f1_(t.f1_), f2_(t.f2_),
      f3_(t.f3_), f4_(t.f4_), f5_(t.f5_), f6_(t.f6_), f7_(t.f7_), f8_(t.f8_) {}

  tuple& operator=(const tuple& t) { return CopyFrom(t); }

  template 
  tuple& operator=(const GTEST_9_TUPLE_(U)& t) {
    return CopyFrom(t);
  }

  GTEST_DECLARE_TUPLE_AS_FRIEND_

  template 
  tuple& CopyFrom(const GTEST_9_TUPLE_(U)& t) {
    f0_ = t.f0_;
    f1_ = t.f1_;
    f2_ = t.f2_;
    f3_ = t.f3_;
    f4_ = t.f4_;
    f5_ = t.f5_;
    f6_ = t.f6_;
    f7_ = t.f7_;
    f8_ = t.f8_;
    return *this;
  }

  T0 f0_;
  T1 f1_;
  T2 f2_;
  T3 f3_;
  T4 f4_;
  T5 f5_;
  T6 f6_;
  T7 f7_;
  T8 f8_;
};

template 
class tuple {
 public:
  template  friend class gtest_internal::Get;

  tuple() : f0_(), f1_(), f2_(), f3_(), f4_(), f5_(), f6_(), f7_(), f8_(),
      f9_() {}

  explicit tuple(GTEST_BY_REF_(T0) f0, GTEST_BY_REF_(T1) f1,
      GTEST_BY_REF_(T2) f2, GTEST_BY_REF_(T3) f3, GTEST_BY_REF_(T4) f4,
      GTEST_BY_REF_(T5) f5, GTEST_BY_REF_(T6) f6, GTEST_BY_REF_(T7) f7,
      GTEST_BY_REF_(T8) f8, GTEST_BY_REF_(T9) f9) : f0_(f0), f1_(f1), f2_(f2),
      f3_(f3), f4_(f4), f5_(f5), f6_(f6), f7_(f7), f8_(f8), f9_(f9) {}

  tuple(const tuple& t) : f0_(t.f0_), f1_(t.f1_), f2_(t.f2_), f3_(t.f3_),
      f4_(t.f4_), f5_(t.f5_), f6_(t.f6_), f7_(t.f7_), f8_(t.f8_), f9_(t.f9_) {}

  template 
  tuple(const GTEST_10_TUPLE_(U)& t) : f0_(t.f0_), f1_(t.f1_), f2_(t.f2_),
      f3_(t.f3_), f4_(t.f4_), f5_(t.f5_), f6_(t.f6_), f7_(t.f7_), f8_(t.f8_),
      f9_(t.f9_) {}

  tuple& operator=(const tuple& t) { return CopyFrom(t); }

  template 
  tuple& operator=(const GTEST_10_TUPLE_(U)& t) {
    return CopyFrom(t);
  }

  GTEST_DECLARE_TUPLE_AS_FRIEND_

  template 
  tuple& CopyFrom(const GTEST_10_TUPLE_(U)& t) {
    f0_ = t.f0_;
    f1_ = t.f1_;
    f2_ = t.f2_;
    f3_ = t.f3_;
    f4_ = t.f4_;
    f5_ = t.f5_;
    f6_ = t.f6_;
    f7_ = t.f7_;
    f8_ = t.f8_;
    f9_ = t.f9_;
    return *this;
  }

  T0 f0_;
  T1 f1_;
  T2 f2_;
  T3 f3_;
  T4 f4_;
  T5 f5_;
  T6 f6_;
  T7 f7_;
  T8 f8_;
  T9 f9_;
};

// 6.1.3.2 Tuple creation functions.

// Known limitations: we don't support passing an
// std::tr1::reference_wrapper to make_tuple().  And we don't
// implement tie().

inline tuple<> make_tuple() { return tuple<>(); }

template 
inline GTEST_1_TUPLE_(T) make_tuple(const T0& f0) {
  return GTEST_1_TUPLE_(T)(f0);
}

template 
inline GTEST_2_TUPLE_(T) make_tuple(const T0& f0, const T1& f1) {
  return GTEST_2_TUPLE_(T)(f0, f1);
}

template 
inline GTEST_3_TUPLE_(T) make_tuple(const T0& f0, const T1& f1, const T2& f2) {
  return GTEST_3_TUPLE_(T)(f0, f1, f2);
}

template 
inline GTEST_4_TUPLE_(T) make_tuple(const T0& f0, const T1& f1, const T2& f2,
    const T3& f3) {
  return GTEST_4_TUPLE_(T)(f0, f1, f2, f3);
}

template 
inline GTEST_5_TUPLE_(T) make_tuple(const T0& f0, const T1& f1, const T2& f2,
    const T3& f3, const T4& f4) {
  return GTEST_5_TUPLE_(T)(f0, f1, f2, f3, f4);
}

template 
inline GTEST_6_TUPLE_(T) make_tuple(const T0& f0, const T1& f1, const T2& f2,
    const T3& f3, const T4& f4, const T5& f5) {
  return GTEST_6_TUPLE_(T)(f0, f1, f2, f3, f4, f5);
}

template 
inline GTEST_7_TUPLE_(T) make_tuple(const T0& f0, const T1& f1, const T2& f2,
    const T3& f3, const T4& f4, const T5& f5, const T6& f6) {
  return GTEST_7_TUPLE_(T)(f0, f1, f2, f3, f4, f5, f6);
}

template 
inline GTEST_8_TUPLE_(T) make_tuple(const T0& f0, const T1& f1, const T2& f2,
    const T3& f3, const T4& f4, const T5& f5, const T6& f6, const T7& f7) {
  return GTEST_8_TUPLE_(T)(f0, f1, f2, f3, f4, f5, f6, f7);
}

template 
inline GTEST_9_TUPLE_(T) make_tuple(const T0& f0, const T1& f1, const T2& f2,
    const T3& f3, const T4& f4, const T5& f5, const T6& f6, const T7& f7,
    const T8& f8) {
  return GTEST_9_TUPLE_(T)(f0, f1, f2, f3, f4, f5, f6, f7, f8);
}

template 
inline GTEST_10_TUPLE_(T) make_tuple(const T0& f0, const T1& f1, const T2& f2,
    const T3& f3, const T4& f4, const T5& f5, const T6& f6, const T7& f7,
    const T8& f8, const T9& f9) {
  return GTEST_10_TUPLE_(T)(f0, f1, f2, f3, f4, f5, f6, f7, f8, f9);
}

// 6.1.3.3 Tuple helper classes.

template  struct tuple_size;

template 
struct tuple_size {
  static const int value = 0;
};

template 
struct tuple_size {
  static const int value = 1;
};

template 
struct tuple_size {
  static const int value = 2;
};

template 
struct tuple_size {
  static const int value = 3;
};

template 
struct tuple_size {
  static const int value = 4;
};

template 
struct tuple_size {
  static const int value = 5;
};

template 
struct tuple_size {
  static const int value = 6;
};

template 
struct tuple_size {
  static const int value = 7;
};

template 
struct tuple_size {
  static const int value = 8;
};

template 
struct tuple_size {
  static const int value = 9;
};

template 
struct tuple_size {
  static const int value = 10;
};

template 
struct tuple_element {
  typedef typename gtest_internal::TupleElement<
      k < (tuple_size::value), k, Tuple>::type type;
};

#define GTEST_TUPLE_ELEMENT_(k, Tuple) typename tuple_element::type

// 6.1.3.4 Element access.

namespace gtest_internal {

template <>
class Get<0> {
 public:
  template 
  static GTEST_ADD_REF_(GTEST_TUPLE_ELEMENT_(0, Tuple))
  Field(Tuple& t) { return t.f0_; }  // NOLINT

  template 
  static GTEST_BY_REF_(GTEST_TUPLE_ELEMENT_(0, Tuple))
  ConstField(const Tuple& t) { return t.f0_; }
};

template <>
class Get<1> {
 public:
  template 
  static GTEST_ADD_REF_(GTEST_TUPLE_ELEMENT_(1, Tuple))
  Field(Tuple& t) { return t.f1_; }  // NOLINT

  template 
  static GTEST_BY_REF_(GTEST_TUPLE_ELEMENT_(1, Tuple))
  ConstField(const Tuple& t) { return t.f1_; }
};

template <>
class Get<2> {
 public:
  template 
  static GTEST_ADD_REF_(GTEST_TUPLE_ELEMENT_(2, Tuple))
  Field(Tuple& t) { return t.f2_; }  // NOLINT

  template 
  static GTEST_BY_REF_(GTEST_TUPLE_ELEMENT_(2, Tuple))
  ConstField(const Tuple& t) { return t.f2_; }
};

template <>
class Get<3> {
 public:
  template 
  static GTEST_ADD_REF_(GTEST_TUPLE_ELEMENT_(3, Tuple))
  Field(Tuple& t) { return t.f3_; }  // NOLINT

  template 
  static GTEST_BY_REF_(GTEST_TUPLE_ELEMENT_(3, Tuple))
  ConstField(const Tuple& t) { return t.f3_; }
};

template <>
class Get<4> {
 public:
  template 
  static GTEST_ADD_REF_(GTEST_TUPLE_ELEMENT_(4, Tuple))
  Field(Tuple& t) { return t.f4_; }  // NOLINT

  template 
  static GTEST_BY_REF_(GTEST_TUPLE_ELEMENT_(4, Tuple))
  ConstField(const Tuple& t) { return t.f4_; }
};

template <>
class Get<5> {
 public:
  template 
  static GTEST_ADD_REF_(GTEST_TUPLE_ELEMENT_(5, Tuple))
  Field(Tuple& t) { return t.f5_; }  // NOLINT

  template 
  static GTEST_BY_REF_(GTEST_TUPLE_ELEMENT_(5, Tuple))
  ConstField(const Tuple& t) { return t.f5_; }
};

template <>
class Get<6> {
 public:
  template 
  static GTEST_ADD_REF_(GTEST_TUPLE_ELEMENT_(6, Tuple))
  Field(Tuple& t) { return t.f6_; }  // NOLINT

  template 
  static GTEST_BY_REF_(GTEST_TUPLE_ELEMENT_(6, Tuple))
  ConstField(const Tuple& t) { return t.f6_; }
};

template <>
class Get<7> {
 public:
  template 
  static GTEST_ADD_REF_(GTEST_TUPLE_ELEMENT_(7, Tuple))
  Field(Tuple& t) { return t.f7_; }  // NOLINT

  template 
  static GTEST_BY_REF_(GTEST_TUPLE_ELEMENT_(7, Tuple))
  ConstField(const Tuple& t) { return t.f7_; }
};

template <>
class Get<8> {
 public:
  template 
  static GTEST_ADD_REF_(GTEST_TUPLE_ELEMENT_(8, Tuple))
  Field(Tuple& t) { return t.f8_; }  // NOLINT

  template 
  static GTEST_BY_REF_(GTEST_TUPLE_ELEMENT_(8, Tuple))
  ConstField(const Tuple& t) { return t.f8_; }
};

template <>
class Get<9> {
 public:
  template 
  static GTEST_ADD_REF_(GTEST_TUPLE_ELEMENT_(9, Tuple))
  Field(Tuple& t) { return t.f9_; }  // NOLINT

  template 
  static GTEST_BY_REF_(GTEST_TUPLE_ELEMENT_(9, Tuple))
  ConstField(const Tuple& t) { return t.f9_; }
};

}  // namespace gtest_internal

template 
GTEST_ADD_REF_(GTEST_TUPLE_ELEMENT_(k, GTEST_10_TUPLE_(T)))
get(GTEST_10_TUPLE_(T)& t) {
  return gtest_internal::Get::Field(t);
}

template 
GTEST_BY_REF_(GTEST_TUPLE_ELEMENT_(k,  GTEST_10_TUPLE_(T)))
get(const GTEST_10_TUPLE_(T)& t) {
  return gtest_internal::Get::ConstField(t);
}

// 6.1.3.5 Relational operators

// We only implement == and !=, as we don't have a need for the rest yet.

namespace gtest_internal {

// SameSizeTuplePrefixComparator::Eq(t1, t2) returns true if the
// first k fields of t1 equals the first k fields of t2.
// SameSizeTuplePrefixComparator(k1, k2) would be a compiler error if
// k1 != k2.
template 
struct SameSizeTuplePrefixComparator;

template <>
struct SameSizeTuplePrefixComparator<0, 0> {
  template 
  static bool Eq(const Tuple1& /* t1 */, const Tuple2& /* t2 */) {
    return true;
  }
};

template 
struct SameSizeTuplePrefixComparator {
  template 
  static bool Eq(const Tuple1& t1, const Tuple2& t2) {
    return SameSizeTuplePrefixComparator::Eq(t1, t2) &&
        ::std::tr1::get(t1) == ::std::tr1::get(t2);
  }
};

}  // namespace gtest_internal

template 
inline bool operator==(const GTEST_10_TUPLE_(T)& t,
                       const GTEST_10_TUPLE_(U)& u) {
  return gtest_internal::SameSizeTuplePrefixComparator<
      tuple_size::value,
      tuple_size::value>::Eq(t, u);
}

template 
inline bool operator!=(const GTEST_10_TUPLE_(T)& t,
                       const GTEST_10_TUPLE_(U)& u) { return !(t == u); }

// 6.1.4 Pairs.
// Unimplemented.

}  // namespace tr1
}  // namespace std

#undef GTEST_0_TUPLE_
#undef GTEST_1_TUPLE_
#undef GTEST_2_TUPLE_
#undef GTEST_3_TUPLE_
#undef GTEST_4_TUPLE_
#undef GTEST_5_TUPLE_
#undef GTEST_6_TUPLE_
#undef GTEST_7_TUPLE_
#undef GTEST_8_TUPLE_
#undef GTEST_9_TUPLE_
#undef GTEST_10_TUPLE_

#undef GTEST_0_TYPENAMES_
#undef GTEST_1_TYPENAMES_
#undef GTEST_2_TYPENAMES_
#undef GTEST_3_TYPENAMES_
#undef GTEST_4_TYPENAMES_
#undef GTEST_5_TYPENAMES_
#undef GTEST_6_TYPENAMES_
#undef GTEST_7_TYPENAMES_
#undef GTEST_8_TYPENAMES_
#undef GTEST_9_TYPENAMES_
#undef GTEST_10_TYPENAMES_

#undef GTEST_DECLARE_TUPLE_AS_FRIEND_
#undef GTEST_BY_REF_
#undef GTEST_ADD_REF_
#undef GTEST_TUPLE_ELEMENT_

#endif  // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_TUPLE_H_
node-v4.8.2/deps/gtest/include/gtest/internal/gtest-type-util.h000644 000766 000024 00000552502 13070706730 024663 0ustar00iojsstaff000000 000000 // This file was GENERATED by command:
//     pump.py gtest-type-util.h.pump
// DO NOT EDIT BY HAND!!!

// Copyright 2008 Google Inc.
// All Rights Reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Author: wan@google.com (Zhanyong Wan)

// Type utilities needed for implementing typed and type-parameterized
// tests.  This file is generated by a SCRIPT.  DO NOT EDIT BY HAND!
//
// Currently we support at most 50 types in a list, and at most 50
// type-parameterized tests in one type-parameterized test case.
// Please contact googletestframework@googlegroups.com if you need
// more.

#ifndef GTEST_INCLUDE_GTEST_INTERNAL_GTEST_TYPE_UTIL_H_
#define GTEST_INCLUDE_GTEST_INTERNAL_GTEST_TYPE_UTIL_H_

#include "gtest/internal/gtest-port.h"

// #ifdef __GNUC__ is too general here.  It is possible to use gcc without using
// libstdc++ (which is where cxxabi.h comes from).
# if GTEST_HAS_CXXABI_H_
#  include 
# elif defined(__HP_aCC)
#  include 
# endif  // GTEST_HASH_CXXABI_H_

namespace testing {
namespace internal {

// GetTypeName() returns a human-readable name of type T.
// NB: This function is also used in Google Mock, so don't move it inside of
// the typed-test-only section below.
template 
std::string GetTypeName() {
# if GTEST_HAS_RTTI

  const char* const name = typeid(T).name();
#  if GTEST_HAS_CXXABI_H_ || defined(__HP_aCC)
  int status = 0;
  // gcc's implementation of typeid(T).name() mangles the type name,
  // so we have to demangle it.
#   if GTEST_HAS_CXXABI_H_
  using abi::__cxa_demangle;
#   endif  // GTEST_HAS_CXXABI_H_
  char* const readable_name = __cxa_demangle(name, 0, 0, &status);
  const std::string name_str(status == 0 ? readable_name : name);
  free(readable_name);
  return name_str;
#  else
  return name;
#  endif  // GTEST_HAS_CXXABI_H_ || __HP_aCC

# else

  return "";

# endif  // GTEST_HAS_RTTI
}

#if GTEST_HAS_TYPED_TEST || GTEST_HAS_TYPED_TEST_P

// AssertyTypeEq::type is defined iff T1 and T2 are the same
// type.  This can be used as a compile-time assertion to ensure that
// two types are equal.

template 
struct AssertTypeEq;

template 
struct AssertTypeEq {
  typedef bool type;
};

// A unique type used as the default value for the arguments of class
// template Types.  This allows us to simulate variadic templates
// (e.g. Types, Type, and etc), which C++ doesn't
// support directly.
struct None {};

// The following family of struct and struct templates are used to
// represent type lists.  In particular, TypesN
// represents a type list with N types (T1, T2, ..., and TN) in it.
// Except for Types0, every struct in the family has two member types:
// Head for the first type in the list, and Tail for the rest of the
// list.

// The empty type list.
struct Types0 {};

// Type lists of length 1, 2, 3, and so on.

template 
struct Types1 {
  typedef T1 Head;
  typedef Types0 Tail;
};
template 
struct Types2 {
  typedef T1 Head;
  typedef Types1 Tail;
};

template 
struct Types3 {
  typedef T1 Head;
  typedef Types2 Tail;
};

template 
struct Types4 {
  typedef T1 Head;
  typedef Types3 Tail;
};

template 
struct Types5 {
  typedef T1 Head;
  typedef Types4 Tail;
};

template 
struct Types6 {
  typedef T1 Head;
  typedef Types5 Tail;
};

template 
struct Types7 {
  typedef T1 Head;
  typedef Types6 Tail;
};

template 
struct Types8 {
  typedef T1 Head;
  typedef Types7 Tail;
};

template 
struct Types9 {
  typedef T1 Head;
  typedef Types8 Tail;
};

template 
struct Types10 {
  typedef T1 Head;
  typedef Types9 Tail;
};

template 
struct Types11 {
  typedef T1 Head;
  typedef Types10 Tail;
};

template 
struct Types12 {
  typedef T1 Head;
  typedef Types11 Tail;
};

template 
struct Types13 {
  typedef T1 Head;
  typedef Types12 Tail;
};

template 
struct Types14 {
  typedef T1 Head;
  typedef Types13 Tail;
};

template 
struct Types15 {
  typedef T1 Head;
  typedef Types14 Tail;
};

template 
struct Types16 {
  typedef T1 Head;
  typedef Types15 Tail;
};

template 
struct Types17 {
  typedef T1 Head;
  typedef Types16 Tail;
};

template 
struct Types18 {
  typedef T1 Head;
  typedef Types17 Tail;
};

template 
struct Types19 {
  typedef T1 Head;
  typedef Types18 Tail;
};

template 
struct Types20 {
  typedef T1 Head;
  typedef Types19 Tail;
};

template 
struct Types21 {
  typedef T1 Head;
  typedef Types20 Tail;
};

template 
struct Types22 {
  typedef T1 Head;
  typedef Types21 Tail;
};

template 
struct Types23 {
  typedef T1 Head;
  typedef Types22 Tail;
};

template 
struct Types24 {
  typedef T1 Head;
  typedef Types23 Tail;
};

template 
struct Types25 {
  typedef T1 Head;
  typedef Types24 Tail;
};

template 
struct Types26 {
  typedef T1 Head;
  typedef Types25 Tail;
};

template 
struct Types27 {
  typedef T1 Head;
  typedef Types26 Tail;
};

template 
struct Types28 {
  typedef T1 Head;
  typedef Types27 Tail;
};

template 
struct Types29 {
  typedef T1 Head;
  typedef Types28 Tail;
};

template 
struct Types30 {
  typedef T1 Head;
  typedef Types29 Tail;
};

template 
struct Types31 {
  typedef T1 Head;
  typedef Types30 Tail;
};

template 
struct Types32 {
  typedef T1 Head;
  typedef Types31 Tail;
};

template 
struct Types33 {
  typedef T1 Head;
  typedef Types32 Tail;
};

template 
struct Types34 {
  typedef T1 Head;
  typedef Types33 Tail;
};

template 
struct Types35 {
  typedef T1 Head;
  typedef Types34 Tail;
};

template 
struct Types36 {
  typedef T1 Head;
  typedef Types35 Tail;
};

template 
struct Types37 {
  typedef T1 Head;
  typedef Types36 Tail;
};

template 
struct Types38 {
  typedef T1 Head;
  typedef Types37 Tail;
};

template 
struct Types39 {
  typedef T1 Head;
  typedef Types38 Tail;
};

template 
struct Types40 {
  typedef T1 Head;
  typedef Types39 Tail;
};

template 
struct Types41 {
  typedef T1 Head;
  typedef Types40 Tail;
};

template 
struct Types42 {
  typedef T1 Head;
  typedef Types41 Tail;
};

template 
struct Types43 {
  typedef T1 Head;
  typedef Types42 Tail;
};

template 
struct Types44 {
  typedef T1 Head;
  typedef Types43 Tail;
};

template 
struct Types45 {
  typedef T1 Head;
  typedef Types44 Tail;
};

template 
struct Types46 {
  typedef T1 Head;
  typedef Types45 Tail;
};

template 
struct Types47 {
  typedef T1 Head;
  typedef Types46 Tail;
};

template 
struct Types48 {
  typedef T1 Head;
  typedef Types47 Tail;
};

template 
struct Types49 {
  typedef T1 Head;
  typedef Types48 Tail;
};

template 
struct Types50 {
  typedef T1 Head;
  typedef Types49 Tail;
};


}  // namespace internal

// We don't want to require the users to write TypesN<...> directly,
// as that would require them to count the length.  Types<...> is much
// easier to write, but generates horrible messages when there is a
// compiler error, as gcc insists on printing out each template
// argument, even if it has the default value (this means Types
// will appear as Types in the compiler
// errors).
//
// Our solution is to combine the best part of the two approaches: a
// user would write Types, and Google Test will translate
// that to TypesN internally to make error messages
// readable.  The translation is done by the 'type' member of the
// Types template.
template 
struct Types {
  typedef internal::Types50 type;
};

template <>
struct Types {
  typedef internal::Types0 type;
};
template 
struct Types {
  typedef internal::Types1 type;
};
template 
struct Types {
  typedef internal::Types2 type;
};
template 
struct Types {
  typedef internal::Types3 type;
};
template 
struct Types {
  typedef internal::Types4 type;
};
template 
struct Types {
  typedef internal::Types5 type;
};
template 
struct Types {
  typedef internal::Types6 type;
};
template 
struct Types {
  typedef internal::Types7 type;
};
template 
struct Types {
  typedef internal::Types8 type;
};
template 
struct Types {
  typedef internal::Types9 type;
};
template 
struct Types {
  typedef internal::Types10 type;
};
template 
struct Types {
  typedef internal::Types11 type;
};
template 
struct Types {
  typedef internal::Types12 type;
};
template 
struct Types {
  typedef internal::Types13 type;
};
template 
struct Types {
  typedef internal::Types14 type;
};
template 
struct Types {
  typedef internal::Types15 type;
};
template 
struct Types {
  typedef internal::Types16 type;
};
template 
struct Types {
  typedef internal::Types17 type;
};
template 
struct Types {
  typedef internal::Types18 type;
};
template 
struct Types {
  typedef internal::Types19 type;
};
template 
struct Types {
  typedef internal::Types20 type;
};
template 
struct Types {
  typedef internal::Types21 type;
};
template 
struct Types {
  typedef internal::Types22 type;
};
template 
struct Types {
  typedef internal::Types23 type;
};
template 
struct Types {
  typedef internal::Types24 type;
};
template 
struct Types {
  typedef internal::Types25 type;
};
template 
struct Types {
  typedef internal::Types26 type;
};
template 
struct Types {
  typedef internal::Types27 type;
};
template 
struct Types {
  typedef internal::Types28 type;
};
template 
struct Types {
  typedef internal::Types29 type;
};
template 
struct Types {
  typedef internal::Types30 type;
};
template 
struct Types {
  typedef internal::Types31 type;
};
template 
struct Types {
  typedef internal::Types32 type;
};
template 
struct Types {
  typedef internal::Types33 type;
};
template 
struct Types {
  typedef internal::Types34 type;
};
template 
struct Types {
  typedef internal::Types35 type;
};
template 
struct Types {
  typedef internal::Types36 type;
};
template 
struct Types {
  typedef internal::Types37 type;
};
template 
struct Types {
  typedef internal::Types38 type;
};
template 
struct Types {
  typedef internal::Types39 type;
};
template 
struct Types {
  typedef internal::Types40 type;
};
template 
struct Types {
  typedef internal::Types41 type;
};
template 
struct Types {
  typedef internal::Types42 type;
};
template 
struct Types {
  typedef internal::Types43 type;
};
template 
struct Types {
  typedef internal::Types44 type;
};
template 
struct Types {
  typedef internal::Types45 type;
};
template 
struct Types {
  typedef internal::Types46 type;
};
template 
struct Types {
  typedef internal::Types47 type;
};
template 
struct Types {
  typedef internal::Types48 type;
};
template 
struct Types {
  typedef internal::Types49 type;
};

namespace internal {

# define GTEST_TEMPLATE_ template  class

// The template "selector" struct TemplateSel is used to
// represent Tmpl, which must be a class template with one type
// parameter, as a type.  TemplateSel::Bind::type is defined
// as the type Tmpl.  This allows us to actually instantiate the
// template "selected" by TemplateSel.
//
// This trick is necessary for simulating typedef for class templates,
// which C++ doesn't support directly.
template 
struct TemplateSel {
  template 
  struct Bind {
    typedef Tmpl type;
  };
};

# define GTEST_BIND_(TmplSel, T) \
  TmplSel::template Bind::type

// A unique struct template used as the default value for the
// arguments of class template Templates.  This allows us to simulate
// variadic templates (e.g. Templates, Templates,
// and etc), which C++ doesn't support directly.
template 
struct NoneT {};

// The following family of struct and struct templates are used to
// represent template lists.  In particular, TemplatesN represents a list of N templates (T1, T2, ..., and TN).  Except
// for Templates0, every struct in the family has two member types:
// Head for the selector of the first template in the list, and Tail
// for the rest of the list.

// The empty template list.
struct Templates0 {};

// Template lists of length 1, 2, 3, and so on.

template 
struct Templates1 {
  typedef TemplateSel Head;
  typedef Templates0 Tail;
};
template 
struct Templates2 {
  typedef TemplateSel Head;
  typedef Templates1 Tail;
};

template 
struct Templates3 {
  typedef TemplateSel Head;
  typedef Templates2 Tail;
};

template 
struct Templates4 {
  typedef TemplateSel Head;
  typedef Templates3 Tail;
};

template 
struct Templates5 {
  typedef TemplateSel Head;
  typedef Templates4 Tail;
};

template 
struct Templates6 {
  typedef TemplateSel Head;
  typedef Templates5 Tail;
};

template 
struct Templates7 {
  typedef TemplateSel Head;
  typedef Templates6 Tail;
};

template 
struct Templates8 {
  typedef TemplateSel Head;
  typedef Templates7 Tail;
};

template 
struct Templates9 {
  typedef TemplateSel Head;
  typedef Templates8 Tail;
};

template 
struct Templates10 {
  typedef TemplateSel Head;
  typedef Templates9 Tail;
};

template 
struct Templates11 {
  typedef TemplateSel Head;
  typedef Templates10 Tail;
};

template 
struct Templates12 {
  typedef TemplateSel Head;
  typedef Templates11 Tail;
};

template 
struct Templates13 {
  typedef TemplateSel Head;
  typedef Templates12 Tail;
};

template 
struct Templates14 {
  typedef TemplateSel Head;
  typedef Templates13 Tail;
};

template 
struct Templates15 {
  typedef TemplateSel Head;
  typedef Templates14 Tail;
};

template 
struct Templates16 {
  typedef TemplateSel Head;
  typedef Templates15 Tail;
};

template 
struct Templates17 {
  typedef TemplateSel Head;
  typedef Templates16 Tail;
};

template 
struct Templates18 {
  typedef TemplateSel Head;
  typedef Templates17 Tail;
};

template 
struct Templates19 {
  typedef TemplateSel Head;
  typedef Templates18 Tail;
};

template 
struct Templates20 {
  typedef TemplateSel Head;
  typedef Templates19 Tail;
};

template 
struct Templates21 {
  typedef TemplateSel Head;
  typedef Templates20 Tail;
};

template 
struct Templates22 {
  typedef TemplateSel Head;
  typedef Templates21 Tail;
};

template 
struct Templates23 {
  typedef TemplateSel Head;
  typedef Templates22 Tail;
};

template 
struct Templates24 {
  typedef TemplateSel Head;
  typedef Templates23 Tail;
};

template 
struct Templates25 {
  typedef TemplateSel Head;
  typedef Templates24 Tail;
};

template 
struct Templates26 {
  typedef TemplateSel Head;
  typedef Templates25 Tail;
};

template 
struct Templates27 {
  typedef TemplateSel Head;
  typedef Templates26 Tail;
};

template 
struct Templates28 {
  typedef TemplateSel Head;
  typedef Templates27 Tail;
};

template 
struct Templates29 {
  typedef TemplateSel Head;
  typedef Templates28 Tail;
};

template 
struct Templates30 {
  typedef TemplateSel Head;
  typedef Templates29 Tail;
};

template 
struct Templates31 {
  typedef TemplateSel Head;
  typedef Templates30 Tail;
};

template 
struct Templates32 {
  typedef TemplateSel Head;
  typedef Templates31 Tail;
};

template 
struct Templates33 {
  typedef TemplateSel Head;
  typedef Templates32 Tail;
};

template 
struct Templates34 {
  typedef TemplateSel Head;
  typedef Templates33 Tail;
};

template 
struct Templates35 {
  typedef TemplateSel Head;
  typedef Templates34 Tail;
};

template 
struct Templates36 {
  typedef TemplateSel Head;
  typedef Templates35 Tail;
};

template 
struct Templates37 {
  typedef TemplateSel Head;
  typedef Templates36 Tail;
};

template 
struct Templates38 {
  typedef TemplateSel Head;
  typedef Templates37 Tail;
};

template 
struct Templates39 {
  typedef TemplateSel Head;
  typedef Templates38 Tail;
};

template 
struct Templates40 {
  typedef TemplateSel Head;
  typedef Templates39 Tail;
};

template 
struct Templates41 {
  typedef TemplateSel Head;
  typedef Templates40 Tail;
};

template 
struct Templates42 {
  typedef TemplateSel Head;
  typedef Templates41 Tail;
};

template 
struct Templates43 {
  typedef TemplateSel Head;
  typedef Templates42 Tail;
};

template 
struct Templates44 {
  typedef TemplateSel Head;
  typedef Templates43 Tail;
};

template 
struct Templates45 {
  typedef TemplateSel Head;
  typedef Templates44 Tail;
};

template 
struct Templates46 {
  typedef TemplateSel Head;
  typedef Templates45 Tail;
};

template 
struct Templates47 {
  typedef TemplateSel Head;
  typedef Templates46 Tail;
};

template 
struct Templates48 {
  typedef TemplateSel Head;
  typedef Templates47 Tail;
};

template 
struct Templates49 {
  typedef TemplateSel Head;
  typedef Templates48 Tail;
};

template 
struct Templates50 {
  typedef TemplateSel Head;
  typedef Templates49 Tail;
};


// We don't want to require the users to write TemplatesN<...> directly,
// as that would require them to count the length.  Templates<...> is much
// easier to write, but generates horrible messages when there is a
// compiler error, as gcc insists on printing out each template
// argument, even if it has the default value (this means Templates
// will appear as Templates in the compiler
// errors).
//
// Our solution is to combine the best part of the two approaches: a
// user would write Templates, and Google Test will translate
// that to TemplatesN internally to make error messages
// readable.  The translation is done by the 'type' member of the
// Templates template.
template 
struct Templates {
  typedef Templates50 type;
};

template <>
struct Templates {
  typedef Templates0 type;
};
template 
struct Templates {
  typedef Templates1 type;
};
template 
struct Templates {
  typedef Templates2 type;
};
template 
struct Templates {
  typedef Templates3 type;
};
template 
struct Templates {
  typedef Templates4 type;
};
template 
struct Templates {
  typedef Templates5 type;
};
template 
struct Templates {
  typedef Templates6 type;
};
template 
struct Templates {
  typedef Templates7 type;
};
template 
struct Templates {
  typedef Templates8 type;
};
template 
struct Templates {
  typedef Templates9 type;
};
template 
struct Templates {
  typedef Templates10 type;
};
template 
struct Templates {
  typedef Templates11 type;
};
template 
struct Templates {
  typedef Templates12 type;
};
template 
struct Templates {
  typedef Templates13 type;
};
template 
struct Templates {
  typedef Templates14 type;
};
template 
struct Templates {
  typedef Templates15 type;
};
template 
struct Templates {
  typedef Templates16 type;
};
template 
struct Templates {
  typedef Templates17 type;
};
template 
struct Templates {
  typedef Templates18 type;
};
template 
struct Templates {
  typedef Templates19 type;
};
template 
struct Templates {
  typedef Templates20 type;
};
template 
struct Templates {
  typedef Templates21 type;
};
template 
struct Templates {
  typedef Templates22 type;
};
template 
struct Templates {
  typedef Templates23 type;
};
template 
struct Templates {
  typedef Templates24 type;
};
template 
struct Templates {
  typedef Templates25 type;
};
template 
struct Templates {
  typedef Templates26 type;
};
template 
struct Templates {
  typedef Templates27 type;
};
template 
struct Templates {
  typedef Templates28 type;
};
template 
struct Templates {
  typedef Templates29 type;
};
template 
struct Templates {
  typedef Templates30 type;
};
template 
struct Templates {
  typedef Templates31 type;
};
template 
struct Templates {
  typedef Templates32 type;
};
template 
struct Templates {
  typedef Templates33 type;
};
template 
struct Templates {
  typedef Templates34 type;
};
template 
struct Templates {
  typedef Templates35 type;
};
template 
struct Templates {
  typedef Templates36 type;
};
template 
struct Templates {
  typedef Templates37 type;
};
template 
struct Templates {
  typedef Templates38 type;
};
template 
struct Templates {
  typedef Templates39 type;
};
template 
struct Templates {
  typedef Templates40 type;
};
template 
struct Templates {
  typedef Templates41 type;
};
template 
struct Templates {
  typedef Templates42 type;
};
template 
struct Templates {
  typedef Templates43 type;
};
template 
struct Templates {
  typedef Templates44 type;
};
template 
struct Templates {
  typedef Templates45 type;
};
template 
struct Templates {
  typedef Templates46 type;
};
template 
struct Templates {
  typedef Templates47 type;
};
template 
struct Templates {
  typedef Templates48 type;
};
template 
struct Templates {
  typedef Templates49 type;
};

// The TypeList template makes it possible to use either a single type
// or a Types<...> list in TYPED_TEST_CASE() and
// INSTANTIATE_TYPED_TEST_CASE_P().

template 
struct TypeList {
  typedef Types1 type;
};

template 
struct TypeList > {
  typedef typename Types::type type;
};

#endif  // GTEST_HAS_TYPED_TEST || GTEST_HAS_TYPED_TEST_P

}  // namespace internal
}  // namespace testing

#endif  // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_TYPE_UTIL_H_
node-v4.8.2/deps/cares/.gitignore000644 000766 000024 00000000255 13070706730 016775 0ustar00iojsstaff000000 000000 /Debug/
/build/gyp
/out/
/Release/

/cares.Makefile
/cares.target.mk

/*.opensdf
/*.sdf
/*.sln
/*.suo
/*.vcxproj
/*.vcxproj.filters
/*.vcxproj.user

*.so
*.[oa]
.buildstamp
node-v4.8.2/deps/cares/android-configure000755 000766 000024 00000001034 13070706730 020326 0ustar00iojsstaff000000 000000 #!/bin/bash

export TOOLCHAIN=$PWD/android-toolchain
mkdir -p $TOOLCHAIN
$1/build/tools/make-standalone-toolchain.sh \
    --toolchain=arm-linux-androideabi-4.7 \
    --arch=arm \
    --install-dir=$TOOLCHAIN \
    --platform=android-9
export PATH=$TOOLCHAIN/bin:$PATH
export AR=arm-linux-androideabi-ar
export CC=arm-linux-androideabi-gcc
export CXX=arm-linux-androideabi-g++
export LINK=arm-linux-androideabi-g++
export PLATFORM=android
export OS=android

if [ $2 -a $2 == 'gyp' ]
  then
    ./gyp_cares -DOS=android -Dtarget_arch=arm
fi
node-v4.8.2/deps/cares/build/000755 000766 000024 00000000000 13070706730 016102 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/cares/build.mk000644 000766 000024 00000007621 13070706730 016441 0ustar00iojsstaff000000 000000 # Copyright Joyent, Inc. and other Node contributors. All rights reserved.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.

OS ?= $(shell sh -c 'uname -s | tr "[A-Z]" "[a-z]"')

OBJS= \
		src/ares_cancel.o \
		src/ares__close_sockets.o \
		src/ares_create_query.o \
		src/ares_data.o \
		src/ares_destroy.o \
		src/ares_expand_name.o \
		src/ares_expand_string.o \
		src/ares_fds.o \
		src/ares_free_hostent.o \
		src/ares_free_string.o \
		src/ares_gethostbyaddr.o \
		src/ares_gethostbyname.o \
		src/ares__get_hostent.o \
		src/ares_getnameinfo.o \
		src/ares_getopt.o \
		src/ares_getsock.o \
		src/ares_init.o \
		src/ares_library_init.o \
		src/ares_llist.o \
		src/ares_mkquery.o \
		src/ares_nowarn.o \
		src/ares_options.o \
		src/ares_parse_aaaa_reply.o \
		src/ares_parse_a_reply.o \
		src/ares_parse_mx_reply.o \
		src/ares_parse_naptr_reply.o \
		src/ares_parse_ns_reply.o \
		src/ares_parse_ptr_reply.o \
		src/ares_parse_soa_reply.o \
		src/ares_parse_srv_reply.o \
		src/ares_parse_txt_reply.o \
		src/ares_process.o \
		src/ares_query.o \
		src/ares__read_line.o \
		src/ares_search.o \
		src/ares_send.o \
		src/ares_strcasecmp.o \
		src/ares_strdup.o \
		src/ares_strerror.o \
		src/ares_timeout.o \
		src/ares__timeval.o \
		src/ares_version.o \
		src/ares_writev.o \
		src/bitncmp.o \
		src/inet_net_pton.o \
		src/inet_ntop.o \

CFLAGS += -I. -I$(SRCDIR)/include -DHAVE_CONFIG_H

ARES_CONFIG_OS = $(OS)
SOEXT = so

# if on windows
ifneq (,$(findstring mingw,$(OS)))
ARES_CONFIG_OS = win32
OBJS += src/windows_port.o
OBJS += src/ares_getenv.o
OBJS += src/ares_platform.o

LDFLAGS += -lws2_32.lib -liphlpapi.lib
else # else a posix system
CFLAGS += -g --std=gnu89 -pedantic
CFLAGS += -Wall -Wextra -Wno-unused-parameter
CFLAGS += -D_LARGEFILE_SOURCE
CFLAGS += -D_FILE_OFFSET_BITS=64
endif

ifneq (,$(findstring cygwin,$(OS)))
ARES_CONFIG_OS = cygwin
CFLAGS += -D_GNU_SOURCE
endif

ifeq (dragonflybsd,$(OS))
ARES_CONFIG_OS = freebsd
endif

ifeq (darwin,$(OS))
CFLAGS += -D_DARWIN_USE_64_BIT_INODE=1
LDFLAGS += -dynamiclib -install_name "@rpath/libcares.dylib"
SOEXT = dylib
endif

ifeq (linux,$(OS))
CFLAGS += -D_GNU_SOURCE
endif

ifeq (android,$(OS))
CFLAGS += -D_GNU_SOURCE
endif

ifeq (sunos,$(OS))
LDFLAGS += -lsocket -lnsl
CFLAGS += -D__EXTENSIONS__ -D_XOPEN_SOURCE=500
endif

CFLAGS += -I$(SRCDIR)/config/$(ARES_CONFIG_OS)

ifneq (,$(findstring libcares.$(SOEXT),$(MAKECMDGOALS)))
CFLAGS += -DCARES_BUILDING_LIBRARY
else
CFLAGS += -DCARES_STATICLIB
endif

all: libcares.a

src/.buildstamp:
	mkdir -p $(dir $@)
	touch $@

libcares.a: $(OBJS)
	$(AR) rcs $@ $^

libcares.$(SOEXT): override CFLAGS += -fPIC
libcares.$(SOEXT): $(OBJS:%.o=%.pic.o)
	$(CC) -shared -o $@ $^ $(LDFLAGS)

src/%.o src/%.pic.o:  src/%.c include/ares.h include/ares_version.h \
		include/nameser.h src/.buildstamp \
		$(SRCDIR)/config/$(ARES_CONFIG_OS)/ares_config.h
	$(CC) $(CFLAGS) -c $< -o $@

.PHONY: clean
clean:
	$(RM) -f libcares.a libcares.$(SOEXT) src/*.o src/.buildstamp
node-v4.8.2/deps/cares/cares.gyp000644 000766 000024 00000011516 13070706730 016625 0ustar00iojsstaff000000 000000 {
  'target_defaults': {
    'conditions': [
      ['OS!="win"', {
        'defines': [
          '_DARWIN_USE_64_BIT_INODE=1',
          '_LARGEFILE_SOURCE',
          '_FILE_OFFSET_BITS=64',
          '_GNU_SOURCE'
        ]
      }],
      [ 'OS=="aix"', {
        'include_dirs': [ 'config/aix' ],
        'sources': [ 'config/aix/ares_config.h' ],
        'defines': [
          # Support for malloc(0)
          '_LINUX_SOURCE_COMPAT=1',
          '_ALL_SOURCE=1'],
      }],
      ['OS=="solaris"', {
        'defines': [
          '__EXTENSIONS__',
          '_XOPEN_SOURCE=500'
        ]
      }]
    ]
  },

  'targets': [
    {
      'target_name': 'cares',
      'type': '<(library)',
      'include_dirs': [ 'include', 'src' ],
      'direct_dependent_settings': {
        'include_dirs': [ 'include' ]
      },
      'sources': [
        'common.gypi',
        'include/ares.h',
        'include/ares_version.h',
        'include/nameser.h',
        'src/ares_cancel.c',
        'src/ares__close_sockets.c',
        'src/ares_create_query.c',
        'src/ares_data.c',
        'src/ares_data.h',
        'src/ares_destroy.c',
        'src/ares_dns.h',
        'src/ares_expand_name.c',
        'src/ares_expand_string.c',
        'src/ares_fds.c',
        'src/ares_free_hostent.c',
        'src/ares_free_string.c',
        'src/ares_getenv.h',
        'src/ares_gethostbyaddr.c',
        'src/ares_gethostbyname.c',
        'src/ares__get_hostent.c',
        'src/ares_getnameinfo.c',
        'src/ares_getopt.c',
        'src/ares_getopt.h',
        'src/ares_getsock.c',
        'src/ares_init.c',
        'src/ares_ipv6.h',
        'src/ares_library_init.c',
        'src/ares_library_init.h',
        'src/ares_llist.c',
        'src/ares_llist.h',
        'src/ares_mkquery.c',
        'src/ares_nowarn.c',
        'src/ares_nowarn.h',
        'src/ares_options.c',
        'src/ares_parse_aaaa_reply.c',
        'src/ares_parse_a_reply.c',
        'src/ares_parse_mx_reply.c',
        'src/ares_parse_naptr_reply.c',
        'src/ares_parse_ns_reply.c',
        'src/ares_parse_ptr_reply.c',
        'src/ares_parse_soa_reply.c',
        'src/ares_parse_srv_reply.c',
        'src/ares_parse_txt_reply.c',
        'src/ares_platform.h',
        'src/ares_private.h',
        'src/ares_process.c',
        'src/ares_query.c',
        'src/ares__read_line.c',
        'src/ares_rules.h',
        'src/ares_search.c',
        'src/ares_send.c',
        'src/ares_setup.h',
        'src/ares_strcasecmp.c',
        'src/ares_strcasecmp.h',
        'src/ares_strdup.c',
        'src/ares_strdup.h',
        'src/ares_strerror.c',
        'src/ares_timeout.c',
        'src/ares__timeval.c',
        'src/ares_version.c',
        'src/ares_writev.c',
        'src/ares_writev.h',
        'src/bitncmp.c',
        'src/bitncmp.h',
        'src/inet_net_pton.c',
        'src/inet_ntop.c',
        'src/ares_inet_net_pton.h',
        'src/setup_once.h',
      ],
      'conditions': [
        [ 'library=="static_library"', {
          'defines': [ 'CARES_STATICLIB' ]
        }, {
          'defines': [ 'CARES_BUILDING_LIBRARY' ]
        }],
        [ 'OS=="win"', {
          'include_dirs': [ 'config/win32' ],
          'sources': [
            'src/config-win32.h',
            'src/windows_port.c',
            'src/ares_getenv.c',
            'src/ares_iphlpapi.h',
            'src/ares_platform.c'
          ],
          'libraries': [
            '-lws2_32.lib',
            '-liphlpapi.lib'
          ],
        }, {
          # Not Windows i.e. POSIX
          'cflags': [
            '-g',
            '-pedantic',
            '-Wall',
            '-Wextra',
            '-Wno-unused-parameter'
          ],
          'defines': [ 'HAVE_CONFIG_H' ],
        }],
        [ 'OS not in "win android"', {
          'cflags': [
            '--std=gnu89'
          ],
        }],
        [ 'OS=="linux"', {
          'include_dirs': [ 'config/linux' ],
          'sources': [ 'config/linux/ares_config.h' ]
        }],
        [ 'OS=="mac"', {
          'include_dirs': [ 'config/darwin' ],
          'sources': [ 'config/darwin/ares_config.h' ]
        }],
        [ 'OS=="freebsd" or OS=="dragonflybsd"', {
          'include_dirs': [ 'config/freebsd' ],
          'sources': [ 'config/freebsd/ares_config.h' ]
        }],
        [ 'OS=="openbsd"', {
          'include_dirs': [ 'config/openbsd' ],
          'sources': [ 'config/openbsd/ares_config.h' ]
        }],
        [ 'OS=="android"', {
          'include_dirs': [ 'config/android' ],
          'sources': [ 'config/android/ares_config.h' ],
        }],
        [ 'OS=="solaris"', {
          'include_dirs': [ 'config/sunos' ],
          'sources': [ 'config/sunos/ares_config.h' ],
          'direct_dependent_settings': {
            'libraries': [
              '-lsocket',
              '-lnsl'
            ]
          }
        }]
      ]
    }
  ]
}
node-v4.8.2/deps/cares/common.gypi000644 000766 000024 00000012715 13070706730 017173 0ustar00iojsstaff000000 000000 {
  'variables': {
    'visibility%': 'hidden',
    'library%': 'static_library', # allow override to 'shared_library' for DLL/.so builds
    'component%': 'static_library',
    'host_arch%': '',
    'target_arch%': ''
   },

  'target_defaults': {
    'default_configuration': 'Debug',
    'configurations': {

      'Debug': {
        'defines': [ 'DEBUG', '_DEBUG' ],
        'cflags': [ '-g', '-O0' ],
        'msvs_settings': {
          'VCCLCompilerTool': {
            'target_conditions': [
              ['library=="static_library"', {
                'RuntimeLibrary': 1 # static debug
              }, {
                'RuntimeLibrary': 3 # DLL debug
              }]
            ],
            'Optimization': 0, # /Od, no optimization
            'MinimalRebuild': 'false',
            'OmitFramePointers': 'false',
            'BasicRuntimeChecks': 3 # /RTC1
          },
          'VCLinkerTool': {
            'LinkIncremental': 2 # enable incremental linking
          }
        },
        'xcode_settings': {
          'GCC_OPTIMIZATION_LEVEL': '0'
        }
      },

      'Release': {
        'defines': [ 'NDEBUG' ],
        'cflags': [
          '-O3',
          '-fomit-frame-pointer',
          '-fdata-sections',
          '-ffunction-sections'
        ],
        'msvs_settings': {
          'VCCLCompilerTool': {
            'target_conditions': [
              ['library=="static_library"', {
                'RuntimeLibrary': 0, # static release
              }, {
                'RuntimeLibrary': 2, # debug release
              }],
            ],
            'Optimization': 3, # /Ox, full optimization
            'FavorSizeOrSpeed': 1, # /Ot, favour speed over size
            'InlineFunctionExpansion': 2, # /Ob2, inline anything eligible
            'WholeProgramOptimization': 'true', # /GL, whole program optimization, needed for LTCG
            'OmitFramePointers': 'true',
            'EnableFunctionLevelLinking': 'true',
            'EnableIntrinsicFunctions': 'true'
          },
          'VCLibrarianTool': {
            'AdditionalOptions': [
              '/LTCG' # link time code generation
            ]
          },
          'VCLinkerTool': {
            'LinkTimeCodeGeneration': 1, # link-time code generation
            'OptimizeReferences': 2, # /OPT:REF
            'EnableCOMDATFolding': 2, # /OPT:ICF
            'LinkIncremental': 1 # disable incremental linking
          },
        },
      }
    },

    'msvs_settings': {
      'VCCLCompilerTool': {
        'StringPooling': 'true', # pool string literals
        'DebugInformationFormat': 3, # Generate a PDB
        'WarningLevel': 3,
        'BufferSecurityCheck': 'true',
        'ExceptionHandling': 1, # /EHsc
        'SuppressStartupBanner': 'true',
        'WarnAsError': 'false',
        'AdditionalOptions': [
           '/MP', # compile across multiple CPUs
         ],
      },
      'VCLinkerTool': {
        'GenerateDebugInformation': 'true',
        'RandomizedBaseAddress': 2, # enable ASLR
        'DataExecutionPrevention': 2, # enable DEP
        'AllowIsolation': 'true',
        'SuppressStartupBanner': 'true',
        'target_conditions': [
          ['_type=="executable"', {
            'SubSystem': 1, # console executable
          }],
        ],
      },
    },

    'xcode_settings': {
      'ALWAYS_SEARCH_USER_PATHS': 'NO',
      'GCC_CW_ASM_SYNTAX': 'NO',                # No -fasm-blocks
      'GCC_ENABLE_CPP_EXCEPTIONS': 'NO',        # -fno-exceptions
      'GCC_ENABLE_CPP_RTTI': 'NO',              # -fno-rtti
      'GCC_ENABLE_PASCAL_STRINGS': 'NO',        # No -mpascal-strings
      # GCC_INLINES_ARE_PRIVATE_EXTERN maps to -fvisibility-inlines-hidden
      'GCC_INLINES_ARE_PRIVATE_EXTERN': 'YES',
      'GCC_SYMBOLS_PRIVATE_EXTERN': 'YES',      # -fvisibility=hidden
      'GCC_THREADSAFE_STATICS': 'NO',           # -fno-threadsafe-statics
      'GCC_WARN_ABOUT_MISSING_NEWLINE': 'YES',  # -Wnewline-eof
      'PREBINDING': 'NO',                       # No -Wl,-prebind
      'USE_HEADERMAP': 'NO',
      'WARNING_CFLAGS': [
        '-Wall',
        '-Wendif-labels',
        '-W',
        '-Wno-unused-parameter'
      ]
    },

    'conditions': [
      ['OS == "win"', {
        'msvs_cygwin_shell': 0, # prevent actions from trying to use cygwin
        'defines': [
          'WIN32',
          # we don't want VC++ warning us about how dangerous C functions are.
          '_CRT_SECURE_NO_DEPRECATE',
          # ... or that C implementations shouldn't use POSIX names
          '_CRT_NONSTDC_NO_DEPRECATE'
        ],
      }],

      [ 'OS in "linux freebsd openbsd solaris android aix"', {
        'variables': {
          'gcc_version%': ')'
        },
        'cflags': [ '-Wall' ],
        'cflags_cc': [ '-fno-rtti', '-fno-exceptions' ],
        'conditions': [
          [ 'host_arch != target_arch and target_arch=="ia32"', {
            'cflags': [ '-m32' ],
            'ldflags': [ '-m32' ]
          }],
          [ 'OS=="linux"', {
            'cflags': [ '-ansi' ]
          }],
          [ 'visibility=="hidden" and gcc_version >= "4.0.0"', {
            'cflags': [ '-fvisibility=hidden' ]
          }],
        ]
      }]
    ],

    'target_conditions': [
      ['_type!="static_library"', {
        'cflags': [ '-fPIC' ],
        'xcode_settings': {
          'GCC_DYNAMIC_NO_PIC': 'NO', # No -mdynamic-no-pic
                                      # (Equivalent to -fPIC)
          'OTHER_LDFLAGS': [ '-Wl,-search_paths_first' ]
        }
      }]
    ]
  }
}
node-v4.8.2/deps/cares/config/000755 000766 000024 00000000000 13070706730 016250 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/cares/gyp_cares000755 000766 000024 00000005775 13070706730 016723 0ustar00iojsstaff000000 000000 #!/usr/bin/env python

import glob
import platform
import os
import subprocess
import sys

CC = os.environ.get('CC', 'cc')
script_dir = os.path.dirname(__file__)
cares_root = os.path.normpath(script_dir)
output_dir = os.path.join(os.path.abspath(cares_root), 'out')

sys.path.insert(0, os.path.join(cares_root, 'build', 'gyp', 'pylib'))
try:
  import gyp
except ImportError:
  print('You need to install gyp in build/gyp first. See the README.')
  sys.exit(42)


def host_arch():
  machine = platform.machine()
  if machine == 'i386': return 'ia32'
  if machine == 'x86_64': return 'x64'
  if machine.startswith('arm'): return 'arm'
  return machine  # Return as-is and hope for the best.


def compiler_version():
  proc = subprocess.Popen(CC.split() + ['--version'], stdout=subprocess.PIPE)
  is_clang = 'clang' in proc.communicate()[0].split('\n')[0]
  proc = subprocess.Popen(CC.split() + ['-dumpversion'], stdout=subprocess.PIPE)
  version = proc.communicate()[0].split('.')
  version = map(int, version[:2])
  version = tuple(version)
  return (version, is_clang)


def run_gyp(args):
  rc = gyp.main(args)
  if rc != 0:
    print 'Error running GYP'
    sys.exit(rc)


if __name__ == '__main__':
  args = sys.argv[1:]

  # GYP bug.
  # On msvs it will crash if it gets an absolute path.
  # On Mac/make it will crash if it doesn't get an absolute path.
  if sys.platform == 'win32':
    args.append(os.path.join(cares_root, 'cares.gyp'))
    common_fn  = os.path.join(cares_root, 'common.gypi')
    options_fn = os.path.join(cares_root, 'options.gypi')
    # we force vs 2010 over 2008 which would otherwise be the default for gyp
    if not os.environ.get('GYP_MSVS_VERSION'):
      os.environ['GYP_MSVS_VERSION'] = '2010'
  else:
    args.append(os.path.join(os.path.abspath(cares_root), 'cares.gyp'))
    common_fn  = os.path.join(os.path.abspath(cares_root), 'common.gypi')
    options_fn = os.path.join(os.path.abspath(cares_root), 'options.gypi')

  if os.path.exists(common_fn):
    args.extend(['-I', common_fn])

  if os.path.exists(options_fn):
    args.extend(['-I', options_fn])

  args.append('--depth=' + cares_root)

  # There's a bug with windows which doesn't allow this feature.
  if sys.platform != 'win32':
    if '-f' not in args:
      args.extend('-f make'.split())
    if 'ninja' not in args:
      args.extend(['-Goutput_dir=' + output_dir])
      args.extend(['--generator-output', output_dir])
    (major, minor), is_clang = compiler_version()
    args.append('-Dgcc_version=%d' % (10 * major + minor))
    args.append('-Dclang=%d' % int(is_clang))

  if not any(a.startswith('-Dhost_arch=') for a in args):
    args.append('-Dhost_arch=%s' % host_arch())

  if not any(a.startswith('-Dtarget_arch=') for a in args):
    args.append('-Dtarget_arch=%s' % host_arch())

  if not any(a.startswith('-Dlibrary=') for a in args):
    args.append('-Dlibrary=static_library')

  if not any(a.startswith('-Dcomponent=') for a in args):
    args.append('-Dcomponent=static_library')

  gyp_args = list(args)
  print gyp_args
  run_gyp(gyp_args)
node-v4.8.2/deps/cares/include/000755 000766 000024 00000000000 13070706730 016426 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/cares/Makefile000644 000766 000024 00000003354 13070706730 016450 0ustar00iojsstaff000000 000000 # Copyright Joyent, Inc. and other Node contributors. All rights reserved.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to
# deal in the Software without restriction, including without limitation the
# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
# sell copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
# IN THE SOFTWARE.

SRCDIR ?= $(CURDIR)

ifeq (,$(builddir_name))

VPATH := $(SRCDIR)
include $(SRCDIR)/build.mk

else  # Out of tree build.

# Drop all built-in rules.
.SUFFIXES:

.PHONY:	$(builddir_name)
$(builddir_name): $(builddir_name)/.buildstamp
	$(MAKE) -C $@ -f $(CURDIR)/Makefile $(MAKECMDGOALS) \
		SRCDIR=$(CURDIR) builddir_name=

$(builddir_name)/.buildstamp:
	mkdir -p $(dir $@)
	touch $@

# Add no-op rules for Makefiles to stop make from trying to rebuild them.
Makefile:: ;
%.mk:: ;

# Turn everything else into a no-op rule that depends on the build directory.
%:: $(builddir_name) ;

.PHONY: clean
clean:
	$(RM) -fr $(builddir_name)

endif
node-v4.8.2/deps/cares/src/000755 000766 000024 00000000000 13070706730 015572 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/cares/src/ares__close_sockets.c000644 000766 000024 00000003623 13070706730 021753 0ustar00iojsstaff000000 000000 
/* Copyright 1998 by the Massachusetts Institute of Technology.
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"

#include "ares.h"
#include "ares_private.h"

void ares__close_sockets(ares_channel channel, struct server_state *server)
{
  struct send_request *sendreq;

  /* Free all pending output buffers. */
  while (server->qhead)
    {
      /* Advance server->qhead; pull out query as we go. */
      sendreq = server->qhead;
      server->qhead = sendreq->next;
      if (sendreq->data_storage != NULL)
        free(sendreq->data_storage);
      free(sendreq);
    }
  server->qtail = NULL;

  /* Reset any existing input buffer. */
  if (server->tcp_buffer)
    free(server->tcp_buffer);
  server->tcp_buffer = NULL;
  server->tcp_lenbuf_pos = 0;

  /* Reset brokenness */
  server->is_broken = 0;

  /* Close the TCP and UDP sockets. */
  if (server->tcp_socket != ARES_SOCKET_BAD)
    {
      SOCK_STATE_CALLBACK(channel, server->tcp_socket, 0, 0);
      sclose(server->tcp_socket);
      server->tcp_socket = ARES_SOCKET_BAD;
      server->tcp_connection_generation = ++channel->tcp_connection_generation;
    }
  if (server->udp_socket != ARES_SOCKET_BAD)
    {
      SOCK_STATE_CALLBACK(channel, server->udp_socket, 0, 0);
      sclose(server->udp_socket);
      server->udp_socket = ARES_SOCKET_BAD;
    }
}
node-v4.8.2/deps/cares/src/ares__get_hostent.c000644 000766 000024 00000015253 13070706730 021440 0ustar00iojsstaff000000 000000 
/* Copyright 1998, 2011 by the Massachusetts Institute of Technology.
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"

#ifdef HAVE_NETINET_IN_H
#  include 
#endif
#ifdef HAVE_NETDB_H
#  include 
#endif
#ifdef HAVE_ARPA_INET_H
#  include 
#endif

#include "ares.h"
#include "ares_inet_net_pton.h"
#include "ares_nowarn.h"
#include "ares_private.h"

int ares__get_hostent(FILE *fp, int family, struct hostent **host)
{
  char *line = NULL, *p, *q, **alias;
  char *txtaddr, *txthost, *txtalias;
  int status;
  size_t addrlen, linesize, naliases;
  struct ares_addr addr;
  struct hostent *hostent = NULL;

  *host = NULL; /* Assume failure */

  /* Validate family */
  switch (family) {
    case AF_INET:
    case AF_INET6:
    case AF_UNSPEC:
      break;
    default:
      return ARES_EBADFAMILY;
  }

  while ((status = ares__read_line(fp, &line, &linesize)) == ARES_SUCCESS)
    {

      /* Trim line comment. */
      p = line;
      while (*p && (*p != '#'))
        p++;
      *p = '\0';

      /* Trim trailing whitespace. */
      q = p - 1;
      while ((q >= line) && ISSPACE(*q))
        q--;
      *++q = '\0';

      /* Skip leading whitespace. */
      p = line;
      while (*p && ISSPACE(*p))
        p++;
      if (!*p)
        /* Ignore line if empty. */
        continue;

      /* Pointer to start of IPv4 or IPv6 address part. */
      txtaddr = p;

      /* Advance past address part. */
      while (*p && !ISSPACE(*p))
        p++;
      if (!*p)
        /* Ignore line if reached end of line. */
        continue;

      /* Null terminate address part. */
      *p = '\0';

      /* Advance to host name */
      p++;
      while (*p && ISSPACE(*p))
        p++;
      if (!*p)
        /* Ignore line if reached end of line. */
        continue;

      /* Pointer to start of host name. */
      txthost = p;

      /* Advance past host name. */
      while (*p && !ISSPACE(*p))
        p++;

      /* Pointer to start of first alias. */
      txtalias = NULL;
      if (*p)
        {
          q = p + 1;
          while (*q && ISSPACE(*q))
            q++;
          if (*q)
            txtalias = q;
        }

      /* Null terminate host name. */
      *p = '\0';

      /* find out number of aliases. */
      naliases = 0;
      if (txtalias)
        {
          p = txtalias;
          while (*p)
            {
              while (*p && !ISSPACE(*p))
                p++;
              while (*p && ISSPACE(*p))
                p++;
              naliases++;
            }
        }

      /* Convert address string to network address for the requested family. */
      addrlen = 0;
      addr.family = AF_UNSPEC;
      addr.addrV4.s_addr = INADDR_NONE;
      if ((family == AF_INET) || (family == AF_UNSPEC))
        {
          addr.addrV4.s_addr = inet_addr(txtaddr);
          if (addr.addrV4.s_addr != INADDR_NONE)
            {
              /* Actual network address family and length. */
              addr.family = AF_INET;
              addrlen = sizeof(addr.addrV4);
            }
        }
      if ((family == AF_INET6) || ((family == AF_UNSPEC) && (!addrlen)))
        {
          if (ares_inet_pton(AF_INET6, txtaddr, &addr.addrV6) > 0)
            {
              /* Actual network address family and length. */
              addr.family = AF_INET6;
              addrlen = sizeof(addr.addrV6);
            }
        }
      if (!addrlen)
        /* Ignore line if invalid address string for the requested family. */
        continue;

      /*
      ** Actual address family possible values are AF_INET and AF_INET6 only.
      */

      /* Allocate memory for the hostent structure. */
      hostent = malloc(sizeof(struct hostent));
      if (!hostent)
        break;

      /* Initialize fields for out of memory condition. */
      hostent->h_aliases = NULL;
      hostent->h_addr_list = NULL;

      /* Copy official host name. */
      hostent->h_name = strdup(txthost);
      if (!hostent->h_name)
        break;

      /* Copy network address. */
      hostent->h_addr_list = malloc(2 * sizeof(char *));
      if (!hostent->h_addr_list)
        break;
      hostent->h_addr_list[1] = NULL;
      hostent->h_addr_list[0] = malloc(addrlen);
      if (!hostent->h_addr_list[0])
        break;
      if (addr.family == AF_INET)
        memcpy(hostent->h_addr_list[0], &addr.addrV4, sizeof(addr.addrV4));
      else
        memcpy(hostent->h_addr_list[0], &addr.addrV6, sizeof(addr.addrV6));

      /* Copy aliases. */
      hostent->h_aliases = malloc((naliases + 1) * sizeof(char *));
      if (!hostent->h_aliases)
        break;
      alias = hostent->h_aliases;
      while (naliases)
        *(alias + naliases--) = NULL;
      *alias = NULL;
      while (txtalias)
        {
          p = txtalias;
          while (*p && !ISSPACE(*p))
            p++;
          q = p;
          while (*q && ISSPACE(*q))
            q++;
          *p = '\0';
          if ((*alias = strdup(txtalias)) == NULL)
            break;
          alias++;
          txtalias = *q ? q : NULL;
        }
      if (txtalias)
        /* Alias memory allocation failure. */
        break;

      /* Copy actual network address family and length. */
      hostent->h_addrtype = aresx_sitoss(addr.family);
      hostent->h_length = aresx_uztoss(addrlen);

      /* Free line buffer. */
      free(line);

      /* Return hostent successfully */
      *host = hostent;
      return ARES_SUCCESS;

    }

  /* If allocated, free line buffer. */
  if (line)
    free(line);

  if (status == ARES_SUCCESS)
    {
      /* Memory allocation failure; clean up. */
      if (hostent)
        {
          if (hostent->h_name)
            free((char *) hostent->h_name);
          if (hostent->h_aliases)
            {
              for (alias = hostent->h_aliases; *alias; alias++)
                free(*alias);
              free(hostent->h_aliases);
            }
          if (hostent->h_addr_list)
            {
              if (hostent->h_addr_list[0])
                free(hostent->h_addr_list[0]);
              free(hostent->h_addr_list);
            }
          free(hostent);
        }
      return ARES_ENOMEM;
    }

  return status;
}
node-v4.8.2/deps/cares/src/ares__read_line.c000644 000766 000024 00000004152 13070706730 021033 0ustar00iojsstaff000000 000000 
/* Copyright 1998 by the Massachusetts Institute of Technology.
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"

#include "ares.h"
#include "ares_nowarn.h"
#include "ares_private.h"

/* This is an internal function.  Its contract is to read a line from
 * a file into a dynamically allocated buffer, zeroing the trailing
 * newline if there is one.  The calling routine may call
 * ares__read_line multiple times with the same buf and bufsize
 * pointers; *buf will be reallocated and *bufsize adjusted as
 * appropriate.  The initial value of *buf should be NULL.  After the
 * calling routine is done reading lines, it should free *buf.
 */
int ares__read_line(FILE *fp, char **buf, size_t *bufsize)
{
  char *newbuf;
  size_t offset = 0;
  size_t len;

  if (*buf == NULL)
    {
      *buf = malloc(128);
      if (!*buf)
        return ARES_ENOMEM;
      *bufsize = 128;
    }

  for (;;)
    {
      int bytestoread = aresx_uztosi(*bufsize - offset);

      if (!fgets(*buf + offset, bytestoread, fp))
        return (offset != 0) ? 0 : (ferror(fp)) ? ARES_EFILE : ARES_EOF;
      len = offset + strlen(*buf + offset);
      if ((*buf)[len - 1] == '\n')
        {
          (*buf)[len - 1] = 0;
          break;
        }
      offset = len;
      if(len < *bufsize - 1)
        continue;

      /* Allocate more space. */
      newbuf = realloc(*buf, *bufsize * 2);
      if (!newbuf)
        {
          free(*buf);
          return ARES_ENOMEM;
        }
      *buf = newbuf;
      *bufsize *= 2;
    }
  return ARES_SUCCESS;
}
node-v4.8.2/deps/cares/src/ares__timeval.c000644 000766 000024 00000006025 13070706730 020553 0ustar00iojsstaff000000 000000 
/* Copyright (C) 2008 by Daniel Stenberg et al
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation for any purpose and without fee is hereby granted, provided
 * that the above copyright notice appear in all copies and that both that
 * copyright notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in advertising or
 * publicity pertaining to distribution of the software without specific,
 * written prior permission.  M.I.T. makes no representations about the
 * suitability of this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"
#include "ares.h"
#include "ares_private.h"

#if defined(WIN32) && !defined(MSDOS)

struct timeval ares__tvnow(void)
{
  /*
  ** GetTickCount() is available on _all_ Windows versions from W95 up
  ** to nowadays. Returns milliseconds elapsed since last system boot,
  ** increases monotonically and wraps once 49.7 days have elapsed.
  */
  struct timeval now;
  DWORD milliseconds = GetTickCount();
  now.tv_sec = milliseconds / 1000;
  now.tv_usec = (milliseconds % 1000) * 1000;
  return now;
}

#elif defined(HAVE_CLOCK_GETTIME_MONOTONIC)

struct timeval ares__tvnow(void)
{
  /*
  ** clock_gettime() is granted to be increased monotonically when the
  ** monotonic clock is queried. Time starting point is unspecified, it
  ** could be the system start-up time, the Epoch, or something else,
  ** in any case the time starting point does not change once that the
  ** system has started up.
  */
  struct timeval now;
  struct timespec tsnow;
  if(0 == clock_gettime(CLOCK_MONOTONIC, &tsnow)) {
    now.tv_sec = tsnow.tv_sec;
    now.tv_usec = tsnow.tv_nsec / 1000;
  }
  /*
  ** Even when the configure process has truly detected monotonic clock
  ** availability, it might happen that it is not actually available at
  ** run-time. When this occurs simply fallback to other time source.
  */
#ifdef HAVE_GETTIMEOFDAY
  else
    (void)gettimeofday(&now, NULL);
#else
  else {
    now.tv_sec = (long)time(NULL);
    now.tv_usec = 0;
  }
#endif
  return now;
}

#elif defined(HAVE_GETTIMEOFDAY)

struct timeval ares__tvnow(void)
{
  /*
  ** gettimeofday() is not granted to be increased monotonically, due to
  ** clock drifting and external source time synchronization it can jump
  ** forward or backward in time.
  */
  struct timeval now;
  (void)gettimeofday(&now, NULL);
  return now;
}

#else

struct timeval ares__tvnow(void)
{
  /*
  ** time() returns the value of time in seconds since the Epoch.
  */
  struct timeval now;
  now.tv_sec = (long)time(NULL);
  now.tv_usec = 0;
  return now;
}

#endif

#if 0 /* Not used */
/*
 * Make sure that the first argument is the more recent time, as otherwise
 * we'll get a weird negative time-diff back...
 *
 * Returns: the time difference in number of milliseconds.
 */
long ares__tvdiff(struct timeval newer, struct timeval older)
{
  return (newer.tv_sec-older.tv_sec)*1000+
    (newer.tv_usec-older.tv_usec)/1000;
}
#endif

node-v4.8.2/deps/cares/src/ares_cancel.c000644 000766 000024 00000004265 13070706730 020204 0ustar00iojsstaff000000 000000 
/* Copyright (C) 2004 by Daniel Stenberg et al
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation for any purpose and without fee is hereby granted, provided
 * that the above copyright notice appear in all copies and that both that
 * copyright notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in advertising or
 * publicity pertaining to distribution of the software without specific,
 * written prior permission.  M.I.T. makes no representations about the
 * suitability of this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"
#include 

#include "ares.h"
#include "ares_private.h"

/*
 * ares_cancel() cancels all ongoing requests/resolves that might be going on
 * on the given channel. It does NOT kill the channel, use ares_destroy() for
 * that.
 */
void ares_cancel(ares_channel channel)
{
  struct query *query;
  struct list_node list_head_copy;
  struct list_node* list_head;
  struct list_node* list_node;
  int i;

  if (!ares__is_list_empty(&(channel->all_queries)))
  {
    /* Swap list heads, so that only those queries which were present on entry
     * into this function are cancelled. New queries added by callbacks of
     * queries being cancelled will not be cancelled themselves.
     */
    list_head = &(channel->all_queries);
    list_head_copy.prev = list_head->prev;
    list_head_copy.next = list_head->next;
    list_head_copy.prev->next = &list_head_copy;
    list_head_copy.next->prev = &list_head_copy;
    list_head->prev = list_head;
    list_head->next = list_head;
    for (list_node = list_head_copy.next; list_node != &list_head_copy; )
    {
      query = list_node->data;
      list_node = list_node->next;  /* since we're deleting the query */
      query->callback(query->arg, ARES_ECANCELLED, 0, NULL, 0);
      ares__free_query(query);
    }
  }
  if (!(channel->flags & ARES_FLAG_STAYOPEN) && ares__is_list_empty(&(channel->all_queries)))
  {
    if (channel->servers)
    {
      for (i = 0; i < channel->nservers; i++)
        ares__close_sockets(channel, &channel->servers[i]);
    }
  }
}
node-v4.8.2/deps/cares/src/ares_create_query.c000644 000766 000024 00000014040 13070706730 021437 0ustar00iojsstaff000000 000000 
/* Copyright 1998 by the Massachusetts Institute of Technology.
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"

#ifdef HAVE_NETINET_IN_H
#  include 
#endif
#ifdef HAVE_ARPA_NAMESER_H
#  include 
#else
#  include "nameser.h"
#endif
#ifdef HAVE_ARPA_NAMESER_COMPAT_H
#  include 
#endif

#include "ares.h"
#include "ares_dns.h"
#include "ares_private.h"

#ifndef T_OPT
#  define T_OPT  41 /* EDNS0 option (meta-RR) */
#endif

/* Header format, from RFC 1035:
 *                                  1  1  1  1  1  1
 *    0  1  2  3  4  5  6  7  8  9  0  1  2  3  4  5
 *  +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+
 *  |                      ID                       |
 *  +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+
 *  |QR|   Opcode  |AA|TC|RD|RA|   Z    |   RCODE   |
 *  +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+
 *  |                    QDCOUNT                    |
 *  +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+
 *  |                    ANCOUNT                    |
 *  +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+
 *  |                    NSCOUNT                    |
 *  +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+
 *  |                    ARCOUNT                    |
 *  +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+
 *
 * AA, TC, RA, and RCODE are only set in responses.  Brief description
 * of the remaining fields:
 *      ID      Identifier to match responses with queries
 *      QR      Query (0) or response (1)
 *      Opcode  For our purposes, always QUERY
 *      RD      Recursion desired
 *      Z       Reserved (zero)
 *      QDCOUNT Number of queries
 *      ANCOUNT Number of answers
 *      NSCOUNT Number of name server records
 *      ARCOUNT Number of additional records
 *
 * Question format, from RFC 1035:
 *                                  1  1  1  1  1  1
 *    0  1  2  3  4  5  6  7  8  9  0  1  2  3  4  5
 *  +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+
 *  |                                               |
 *  /                     QNAME                     /
 *  /                                               /
 *  +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+
 *  |                     QTYPE                     |
 *  +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+
 *  |                     QCLASS                    |
 *  +--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+--+
 *
 * The query name is encoded as a series of labels, each represented
 * as a one-byte length (maximum 63) followed by the text of the
 * label.  The list is terminated by a label of length zero (which can
 * be thought of as the root domain).
 */

int ares_create_query(const char *name, int dnsclass, int type,
                      unsigned short id, int rd, unsigned char **bufp,
                      int *buflenp, int max_udp_size)
{
  size_t len;
  unsigned char *q;
  const char *p;
  size_t buflen;
  unsigned char *buf;

  /* Set our results early, in case we bail out early with an error. */
  *buflenp = 0;
  *bufp = NULL;

  /* Allocate a memory area for the maximum size this packet might need. +2
   * is for the length byte and zero termination if no dots or ecscaping is
   * used.
   */
  len = strlen(name) + 2 + HFIXEDSZ + QFIXEDSZ +
    (max_udp_size ? EDNSFIXEDSZ : 0);
  buf = malloc(len);
  if (!buf)
    return ARES_ENOMEM;

  /* Set up the header. */
  q = buf;
  memset(q, 0, HFIXEDSZ);
  DNS_HEADER_SET_QID(q, id);
  DNS_HEADER_SET_OPCODE(q, QUERY);
  if (rd) {
    DNS_HEADER_SET_RD(q, 1);
  }
  else {
    DNS_HEADER_SET_RD(q, 0);
  }
  DNS_HEADER_SET_QDCOUNT(q, 1);

  if (max_udp_size) {
      DNS_HEADER_SET_ARCOUNT(q, 1);
  }

  /* A name of "." is a screw case for the loop below, so adjust it. */
  if (strcmp(name, ".") == 0)
    name++;

  /* Start writing out the name after the header. */
  q += HFIXEDSZ;
  while (*name)
    {
      if (*name == '.') {
        free (buf);
        return ARES_EBADNAME;
      }

      /* Count the number of bytes in this label. */
      len = 0;
      for (p = name; *p && *p != '.'; p++)
        {
          if (*p == '\\' && *(p + 1) != 0)
            p++;
          len++;
        }
      if (len > MAXLABEL) {
        free (buf);
        return ARES_EBADNAME;
      }

      /* Encode the length and copy the data. */
      *q++ = (unsigned char)len;
      for (p = name; *p && *p != '.'; p++)
        {
          if (*p == '\\' && *(p + 1) != 0)
            p++;
          *q++ = *p;
        }

      /* Go to the next label and repeat, unless we hit the end. */
      if (!*p)
        break;
      name = p + 1;
    }

  /* Add the zero-length label at the end. */
  *q++ = 0;

  /* Finish off the question with the type and class. */
  DNS_QUESTION_SET_TYPE(q, type);
  DNS_QUESTION_SET_CLASS(q, dnsclass);

  q += QFIXEDSZ;
  if (max_udp_size)
  {
      memset(q, 0, EDNSFIXEDSZ);
      q++;
      DNS_RR_SET_TYPE(q, T_OPT);
      DNS_RR_SET_CLASS(q, max_udp_size);
      q += (EDNSFIXEDSZ-1);
  }
  buflen = (q - buf);

  /* Reject names that are longer than the maximum of 255 bytes that's
   * specified in RFC 1035 ("To simplify implementations, the total length of
   * a domain name (i.e., label octets and label length octets) is restricted
   * to 255 octets or less."). */
  if (buflen > (MAXCDNAME + HFIXEDSZ + QFIXEDSZ +
                (max_udp_size ? EDNSFIXEDSZ : 0))) {
    free (buf);
    return ARES_EBADNAME;
  }

  /* we know this fits in an int at this point */
  *buflenp = (int) buflen;
  *bufp = buf;

  return ARES_SUCCESS;
}
node-v4.8.2/deps/cares/src/ares_data.c000644 000766 000024 00000012760 13070706730 017667 0ustar00iojsstaff000000 000000 
/* Copyright (C) 2009-2013 by Daniel Stenberg
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */


#include "ares_setup.h"

#include 

#include "ares.h"
#include "ares_data.h"
#include "ares_private.h"


/*
** ares_free_data() - c-ares external API function.
**
** This function must be used by the application to free data memory that
** has been internally allocated by some c-ares function and for which a
** pointer has already been returned to the calling application. The list
** of c-ares functions returning pointers that must be free'ed using this
** function is:
**
**   ares_get_servers()
**   ares_parse_srv_reply()
**   ares_parse_txt_reply()
*/

void ares_free_data(void *dataptr)
{
  struct ares_data *ptr;

  if (!dataptr)
    return;

#ifdef __INTEL_COMPILER
#  pragma warning(push)
#  pragma warning(disable:1684)
   /* 1684: conversion from pointer to same-sized integral type */
#endif

  ptr = (void *)((char *)dataptr - offsetof(struct ares_data, data));

#ifdef __INTEL_COMPILER
#  pragma warning(pop)
#endif

  if (ptr->mark != ARES_DATATYPE_MARK)
    return;

  switch (ptr->type)
    {
      case ARES_DATATYPE_MX_REPLY:

        if (ptr->data.mx_reply.next)
          ares_free_data(ptr->data.mx_reply.next);
        if (ptr->data.mx_reply.host)
          free(ptr->data.mx_reply.host);
        break;

      case ARES_DATATYPE_SRV_REPLY:

        if (ptr->data.srv_reply.next)
          ares_free_data(ptr->data.srv_reply.next);
        if (ptr->data.srv_reply.host)
          free(ptr->data.srv_reply.host);
        break;

      case ARES_DATATYPE_TXT_REPLY:

        if (ptr->data.txt_reply.next)
          ares_free_data(ptr->data.txt_reply.next);
        if (ptr->data.txt_reply.txt)
          free(ptr->data.txt_reply.txt);
        break;

      case ARES_DATATYPE_ADDR_NODE:

        if (ptr->data.addr_node.next)
          ares_free_data(ptr->data.addr_node.next);
        break;

      case ARES_DATATYPE_NAPTR_REPLY:

        if (ptr->data.naptr_reply.next)
          ares_free_data(ptr->data.naptr_reply.next);
        if (ptr->data.naptr_reply.flags)
          free(ptr->data.naptr_reply.flags);
        if (ptr->data.naptr_reply.service)
          free(ptr->data.naptr_reply.service);
        if (ptr->data.naptr_reply.regexp)
          free(ptr->data.naptr_reply.regexp);
        if (ptr->data.naptr_reply.replacement)
          free(ptr->data.naptr_reply.replacement);
        break;

      case ARES_DATATYPE_SOA_REPLY:
        if (ptr->data.soa_reply.nsname)
          free(ptr->data.soa_reply.nsname);
        if (ptr->data.soa_reply.hostmaster)
          free(ptr->data.soa_reply.hostmaster);
	break;

      default:
        return;
    }

  free(ptr);
}


/*
** ares_malloc_data() - c-ares internal helper function.
**
** This function allocates memory for a c-ares private ares_data struct
** for the specified ares_datatype, initializes c-ares private fields
** and zero initializes those which later might be used from the public
** API. It returns an interior pointer which can be passed by c-ares
** functions to the calling application, and that must be free'ed using
** c-ares external API function ares_free_data().
*/

void *ares_malloc_data(ares_datatype type)
{
  struct ares_data *ptr;

  ptr = malloc(sizeof(struct ares_data));
  if (!ptr)
    return NULL;

  switch (type)
    {
      case ARES_DATATYPE_MX_REPLY:
        ptr->data.mx_reply.next = NULL;
        ptr->data.mx_reply.host = NULL;
        ptr->data.mx_reply.priority = 0;
        break;

      case ARES_DATATYPE_SRV_REPLY:
        ptr->data.srv_reply.next = NULL;
        ptr->data.srv_reply.host = NULL;
        ptr->data.srv_reply.priority = 0;
        ptr->data.srv_reply.weight = 0;
        ptr->data.srv_reply.port = 0;
        break;

      case ARES_DATATYPE_TXT_REPLY:
        ptr->data.txt_reply.next = NULL;
        ptr->data.txt_reply.txt = NULL;
        ptr->data.txt_reply.length = 0;
        break;

      case ARES_DATATYPE_ADDR_NODE:
        ptr->data.addr_node.next = NULL;
        ptr->data.addr_node.family = 0;
        memset(&ptr->data.addr_node.addrV6, 0,
               sizeof(ptr->data.addr_node.addrV6));
        break;

      case ARES_DATATYPE_NAPTR_REPLY:
        ptr->data.naptr_reply.next = NULL;
        ptr->data.naptr_reply.flags = NULL;
        ptr->data.naptr_reply.service = NULL;
        ptr->data.naptr_reply.regexp = NULL;
        ptr->data.naptr_reply.replacement = NULL;
        ptr->data.naptr_reply.order = 0;
        ptr->data.naptr_reply.preference = 0;
        break;

      case ARES_DATATYPE_SOA_REPLY:
        ptr->data.soa_reply.nsname = NULL;
        ptr->data.soa_reply.hostmaster = NULL;
        ptr->data.soa_reply.serial = 0;
        ptr->data.soa_reply.refresh = 0;
        ptr->data.soa_reply.retry = 0;
        ptr->data.soa_reply.expire = 0;
        ptr->data.soa_reply.minttl = 0;
	break;

      default:
        free(ptr);
        return NULL;
    }

  ptr->mark = ARES_DATATYPE_MARK;
  ptr->type = type;

  return &ptr->data;
}
node-v4.8.2/deps/cares/src/ares_data.h000644 000766 000024 00000005454 13070706730 017676 0ustar00iojsstaff000000 000000 
/* Copyright (C) 2009-2013 by Daniel Stenberg
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

typedef enum {
  ARES_DATATYPE_UNKNOWN = 1,  /* unknown data type     - introduced in 1.7.0 */
  ARES_DATATYPE_SRV_REPLY,    /* struct ares_srv_reply - introduced in 1.7.0 */
  ARES_DATATYPE_TXT_REPLY,    /* struct ares_txt_reply - introduced in 1.7.0 */
  ARES_DATATYPE_ADDR_NODE,    /* struct ares_addr_node - introduced in 1.7.1 */
  ARES_DATATYPE_MX_REPLY,    /* struct ares_mx_reply   - introduced in 1.7.2 */
  ARES_DATATYPE_NAPTR_REPLY,/* struct ares_naptr_reply - introduced in 1.7.6 */
  ARES_DATATYPE_SOA_REPLY,    /* struct ares_soa_reply - introduced in 1.9.0 */
#if 0
  ARES_DATATYPE_ADDR6TTL,     /* struct ares_addrttl   */
  ARES_DATATYPE_ADDRTTL,      /* struct ares_addr6ttl  */
  ARES_DATATYPE_HOSTENT,      /* struct hostent        */
  ARES_DATATYPE_OPTIONS,      /* struct ares_options   */
#endif
  ARES_DATATYPE_LAST          /* not used              - introduced in 1.7.0 */
} ares_datatype;

#define ARES_DATATYPE_MARK 0xbead

/*
 * ares_data struct definition is internal to c-ares and shall not
 * be exposed by the public API in order to allow future changes
 * and extensions to it without breaking ABI.  This will be used
 * internally by c-ares as the container of multiple types of data
 * dynamically allocated for which a reference will be returned
 * to the calling application.
 *
 * c-ares API functions returning a pointer to c-ares internally
 * allocated data will actually be returning an interior pointer
 * into this ares_data struct.
 *
 * All this is 'invisible' to the calling application, the only
 * requirement is that this kind of data must be free'ed by the
 * calling application using ares_free_data() with the pointer
 * it has received from a previous c-ares function call.
 */

struct ares_data {
  ares_datatype type;  /* Actual data type identifier. */
  unsigned int  mark;  /* Private ares_data signature. */
  union {
    struct ares_txt_reply   txt_reply;
    struct ares_srv_reply   srv_reply;
    struct ares_addr_node   addr_node;
    struct ares_mx_reply    mx_reply;
    struct ares_naptr_reply naptr_reply;
    struct ares_soa_reply soa_reply;
  } data;
};

void *ares_malloc_data(ares_datatype type);

node-v4.8.2/deps/cares/src/ares_destroy.c000644 000766 000024 00000005503 13070706730 020444 0ustar00iojsstaff000000 000000 
/* Copyright 1998 by the Massachusetts Institute of Technology.
 * Copyright (C) 2004-2011 by Daniel Stenberg
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"

#include 

#include "ares.h"
#include "ares_private.h"

void ares_destroy_options(struct ares_options *options)
{
  int i;

  if(options->servers)
    free(options->servers);
  for (i = 0; i < options->ndomains; i++)
    free(options->domains[i]);
  if(options->domains)
    free(options->domains);
  if(options->sortlist)
    free(options->sortlist);
  if(options->lookups)
    free(options->lookups);
}

void ares_destroy(ares_channel channel)
{
  int i;
  struct query *query;
  struct list_node* list_head;
  struct list_node* list_node;
  
  if (!channel)
    return;

  list_head = &(channel->all_queries);
  for (list_node = list_head->next; list_node != list_head; )
    {
      query = list_node->data;
      list_node = list_node->next;  /* since we're deleting the query */
      query->callback(query->arg, ARES_EDESTRUCTION, 0, NULL, 0);
      ares__free_query(query);
    }
#ifndef NDEBUG
  /* Freeing the query should remove it from all the lists in which it sits,
   * so all query lists should be empty now.
   */
  assert(ares__is_list_empty(&(channel->all_queries)));
  for (i = 0; i < ARES_QID_TABLE_SIZE; i++)
    {
      assert(ares__is_list_empty(&(channel->queries_by_qid[i])));
    }
  for (i = 0; i < ARES_TIMEOUT_TABLE_SIZE; i++)
    {
      assert(ares__is_list_empty(&(channel->queries_by_timeout[i])));
    }
#endif

  ares__destroy_servers_state(channel);

  if (channel->domains) {
    for (i = 0; i < channel->ndomains; i++)
      free(channel->domains[i]);
    free(channel->domains);
  }

  if(channel->sortlist)
    free(channel->sortlist);

  if (channel->lookups)
    free(channel->lookups);

  free(channel);
}

void ares__destroy_servers_state(ares_channel channel)
{
  struct server_state *server;
  int i;

  if (channel->servers)
    {
      for (i = 0; i < channel->nservers; i++)
        {
          server = &channel->servers[i];
          ares__close_sockets(channel, server);
          assert(ares__is_list_empty(&server->queries_to_server));
        }
      free(channel->servers);
      channel->servers = NULL;
    }
  channel->nservers = -1;
}
node-v4.8.2/deps/cares/src/ares_dns.h000644 000766 000024 00000012272 13070706730 017545 0ustar00iojsstaff000000 000000 #ifndef HEADER_CARES_DNS_H
#define HEADER_CARES_DNS_H

/* Copyright 1998, 2011 by the Massachusetts Institute of Technology.
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

/*
 * Macro DNS__16BIT reads a network short (16 bit) given in network
 * byte order, and returns its value as an unsigned short.
 */
#define DNS__16BIT(p)  ((unsigned short)((unsigned int) 0xffff & \
                         (((unsigned int)((unsigned char)(p)[0]) << 8U) | \
                          ((unsigned int)((unsigned char)(p)[1])))))

/*
 * Macro DNS__32BIT reads a network long (32 bit) given in network
 * byte order, and returns its value as an unsigned int.
 */
#define DNS__32BIT(p)  ((unsigned int) \
                         (((unsigned int)((unsigned char)(p)[0]) << 24U) | \
                          ((unsigned int)((unsigned char)(p)[1]) << 16U) | \
                          ((unsigned int)((unsigned char)(p)[2]) <<  8U) | \
                          ((unsigned int)((unsigned char)(p)[3]))))

#define DNS__SET16BIT(p, v)  (((p)[0] = (unsigned char)(((v) >> 8) & 0xff)), \
                              ((p)[1] = (unsigned char)((v) & 0xff)))
#define DNS__SET32BIT(p, v)  (((p)[0] = (unsigned char)(((v) >> 24) & 0xff)), \
                              ((p)[1] = (unsigned char)(((v) >> 16) & 0xff)), \
                              ((p)[2] = (unsigned char)(((v) >> 8) & 0xff)), \
                              ((p)[3] = (unsigned char)((v) & 0xff)))

#if 0
/* we cannot use this approach on systems where we can't access 16/32 bit
   data on un-aligned addresses */
#define DNS__16BIT(p)                   ntohs(*(unsigned short*)(p))
#define DNS__32BIT(p)                   ntohl(*(unsigned long*)(p))
#define DNS__SET16BIT(p, v)             *(unsigned short*)(p) = htons(v)
#define DNS__SET32BIT(p, v)             *(unsigned long*)(p) = htonl(v)
#endif

/* Macros for parsing a DNS header */
#define DNS_HEADER_QID(h)               DNS__16BIT(h)
#define DNS_HEADER_QR(h)                (((h)[2] >> 7) & 0x1)
#define DNS_HEADER_OPCODE(h)            (((h)[2] >> 3) & 0xf)
#define DNS_HEADER_AA(h)                (((h)[2] >> 2) & 0x1)
#define DNS_HEADER_TC(h)                (((h)[2] >> 1) & 0x1)
#define DNS_HEADER_RD(h)                ((h)[2] & 0x1)
#define DNS_HEADER_RA(h)                (((h)[3] >> 7) & 0x1)
#define DNS_HEADER_Z(h)                 (((h)[3] >> 4) & 0x7)
#define DNS_HEADER_RCODE(h)             ((h)[3] & 0xf)
#define DNS_HEADER_QDCOUNT(h)           DNS__16BIT((h) + 4)
#define DNS_HEADER_ANCOUNT(h)           DNS__16BIT((h) + 6)
#define DNS_HEADER_NSCOUNT(h)           DNS__16BIT((h) + 8)
#define DNS_HEADER_ARCOUNT(h)           DNS__16BIT((h) + 10)

/* Macros for constructing a DNS header */
#define DNS_HEADER_SET_QID(h, v)      DNS__SET16BIT(h, v)
#define DNS_HEADER_SET_QR(h, v)       ((h)[2] |= (unsigned char)(((v) & 0x1) << 7))
#define DNS_HEADER_SET_OPCODE(h, v)   ((h)[2] |= (unsigned char)(((v) & 0xf) << 3))
#define DNS_HEADER_SET_AA(h, v)       ((h)[2] |= (unsigned char)(((v) & 0x1) << 2))
#define DNS_HEADER_SET_TC(h, v)       ((h)[2] |= (unsigned char)(((v) & 0x1) << 1))
#define DNS_HEADER_SET_RD(h, v)       ((h)[2] |= (unsigned char)((v) & 0x1))
#define DNS_HEADER_SET_RA(h, v)       ((h)[3] |= (unsigned char)(((v) & 0x1) << 7))
#define DNS_HEADER_SET_Z(h, v)        ((h)[3] |= (unsigned char)(((v) & 0x7) << 4))
#define DNS_HEADER_SET_RCODE(h, v)    ((h)[3] |= (unsigned char)((v) & 0xf))
#define DNS_HEADER_SET_QDCOUNT(h, v)  DNS__SET16BIT((h) + 4, v)
#define DNS_HEADER_SET_ANCOUNT(h, v)  DNS__SET16BIT((h) + 6, v)
#define DNS_HEADER_SET_NSCOUNT(h, v)  DNS__SET16BIT((h) + 8, v)
#define DNS_HEADER_SET_ARCOUNT(h, v)  DNS__SET16BIT((h) + 10, v)

/* Macros for parsing the fixed part of a DNS question */
#define DNS_QUESTION_TYPE(q)            DNS__16BIT(q)
#define DNS_QUESTION_CLASS(q)           DNS__16BIT((q) + 2)

/* Macros for constructing the fixed part of a DNS question */
#define DNS_QUESTION_SET_TYPE(q, v)     DNS__SET16BIT(q, v)
#define DNS_QUESTION_SET_CLASS(q, v)    DNS__SET16BIT((q) + 2, v)

/* Macros for parsing the fixed part of a DNS resource record */
#define DNS_RR_TYPE(r)                  DNS__16BIT(r)
#define DNS_RR_CLASS(r)                 DNS__16BIT((r) + 2)
#define DNS_RR_TTL(r)                   DNS__32BIT((r) + 4)
#define DNS_RR_LEN(r)                   DNS__16BIT((r) + 8)

/* Macros for constructing the fixed part of a DNS resource record */
#define DNS_RR_SET_TYPE(r, v)           DNS__SET16BIT(r, v)
#define DNS_RR_SET_CLASS(r, v)          DNS__SET16BIT((r) + 2, v)
#define DNS_RR_SET_TTL(r, v)            DNS__SET32BIT((r) + 4, v)
#define DNS_RR_SET_LEN(r, v)            DNS__SET16BIT((r) + 8, v)

#endif /* HEADER_CARES_DNS_H */
node-v4.8.2/deps/cares/src/ares_expand_name.c000644 000766 000024 00000013412 13070706730 021230 0ustar00iojsstaff000000 000000 
/* Copyright 1998, 2011 by the Massachusetts Institute of Technology.
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"

#ifdef HAVE_NETINET_IN_H
#  include 
#endif
#ifdef HAVE_ARPA_NAMESER_H
#  include 
#else
#  include "nameser.h"
#endif
#ifdef HAVE_ARPA_NAMESER_COMPAT_H
#  include 
#endif

#include "ares.h"
#include "ares_nowarn.h"
#include "ares_private.h" /* for the memdebug */

static int name_length(const unsigned char *encoded, const unsigned char *abuf,
                       int alen);

/* Expand an RFC1035-encoded domain name given by encoded.  The
 * containing message is given by abuf and alen.  The result given by
 * *s, which is set to a NUL-terminated allocated buffer.  *enclen is
 * set to the length of the encoded name (not the length of the
 * expanded name; the goal is to tell the caller how many bytes to
 * move forward to get past the encoded name).
 *
 * In the simple case, an encoded name is a series of labels, each
 * composed of a one-byte length (limited to values between 0 and 63
 * inclusive) followed by the label contents.  The name is terminated
 * by a zero-length label.
 *
 * In the more complicated case, a label may be terminated by an
 * indirection pointer, specified by two bytes with the high bits of
 * the first byte (corresponding to INDIR_MASK) set to 11.  With the
 * two high bits of the first byte stripped off, the indirection
 * pointer gives an offset from the beginning of the containing
 * message with more labels to decode.  Indirection can happen an
 * arbitrary number of times, so we have to detect loops.
 *
 * Since the expanded name uses '.' as a label separator, we use
 * backslashes to escape periods or backslashes in the expanded name.
 */

int ares_expand_name(const unsigned char *encoded, const unsigned char *abuf,
                     int alen, char **s, long *enclen)
{
  int len, indir = 0;
  char *q;
  const unsigned char *p;
  union {
    ssize_t sig;
     size_t uns;
  } nlen;

  nlen.sig = name_length(encoded, abuf, alen);
  if (nlen.sig < 0)
    return ARES_EBADNAME;

  *s = malloc(nlen.uns + 1);
  if (!*s)
    return ARES_ENOMEM;
  q = *s;

  if (nlen.uns == 0) {
    /* RFC2181 says this should be ".": the root of the DNS tree.
     * Since this function strips trailing dots though, it becomes ""
     */
    q[0] = '\0';

    /* indirect root label (like 0xc0 0x0c) is 2 bytes long (stupid, but
       valid) */
    if ((*encoded & INDIR_MASK) == INDIR_MASK)
      *enclen = 2L;
    else
      *enclen = 1L;  /* the caller should move one byte to get past this */

    return ARES_SUCCESS;
  }

  /* No error-checking necessary; it was all done by name_length(). */
  p = encoded;
  while (*p)
    {
      if ((*p & INDIR_MASK) == INDIR_MASK)
        {
          if (!indir)
            {
              *enclen = aresx_uztosl(p + 2U - encoded);
              indir = 1;
            }
          p = abuf + ((*p & ~INDIR_MASK) << 8 | *(p + 1));
        }
      else
        {
          len = *p;
          p++;
          while (len--)
            {
              if (*p == '.' || *p == '\\')
                *q++ = '\\';
              *q++ = *p;
              p++;
            }
          *q++ = '.';
        }
    }
  if (!indir)
    *enclen = aresx_uztosl(p + 1U - encoded);

  /* Nuke the trailing period if we wrote one. */
  if (q > *s)
    *(q - 1) = 0;
  else
    *q = 0; /* zero terminate */

  return ARES_SUCCESS;
}

/* Return the length of the expansion of an encoded domain name, or
 * -1 if the encoding is invalid.
 */
static int name_length(const unsigned char *encoded, const unsigned char *abuf,
                       int alen)
{
  int n = 0, offset, indir = 0;

  /* Allow the caller to pass us abuf + alen and have us check for it. */
  if (encoded >= abuf + alen)
    return -1;

  while (*encoded)
    {
      if ((*encoded & INDIR_MASK) == INDIR_MASK)
        {
          /* Check the offset and go there. */
          if (encoded + 1 >= abuf + alen)
            return -1;
          offset = (*encoded & ~INDIR_MASK) << 8 | *(encoded + 1);
          if (offset >= alen)
            return -1;
          encoded = abuf + offset;

          /* If we've seen more indirects than the message length,
           * then there's a loop.
           */
          if (++indir > alen)
            return -1;
        }
      else
        {
          offset = *encoded;
          if (encoded + offset + 1 >= abuf + alen)
            return -1;
          encoded++;
          while (offset--)
            {
              n += (*encoded == '.' || *encoded == '\\') ? 2 : 1;
              encoded++;
            }
          n++;
        }
    }

  /* If there were any labels at all, then the number of dots is one
   * less than the number of labels, so subtract one.
   */
  return (n) ? n - 1 : n;
}

/* Like ares_expand_name but returns EBADRESP in case of invalid input. */
int ares__expand_name_for_response(const unsigned char *encoded,
                                   const unsigned char *abuf, int alen,
                                   char **s, long *enclen)
{
  int status = ares_expand_name(encoded, abuf, alen, s, enclen);
  if (status == ARES_EBADNAME)
    status = ARES_EBADRESP;
  return status;
}
node-v4.8.2/deps/cares/src/ares_expand_string.c000644 000766 000024 00000003502 13070706730 021615 0ustar00iojsstaff000000 000000 
/* Copyright 1998 by the Massachusetts Institute of Technology.
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"

#ifdef HAVE_NETINET_IN_H
#  include 
#endif
#ifdef HAVE_ARPA_NAMESER_H
#  include 
#else
#  include "nameser.h"
#endif

#include "ares.h"
#include "ares_private.h" /* for the memdebug */

/* Simply decodes a length-encoded character string. The first byte of the
 * input is the length of the string to be returned and the bytes thereafter
 * are the characters of the string. The returned result will be NULL
 * terminated.
 */
int ares_expand_string(const unsigned char *encoded,
                       const unsigned char *abuf,
                       int alen,
                       unsigned char **s,
                       long *enclen)
{
  unsigned char *q;
  union {
    ssize_t sig;
     size_t uns;
  } elen;

  if (encoded == abuf+alen)
    return ARES_EBADSTR;

  elen.uns = *encoded;
  if (encoded+elen.sig+1 > abuf+alen)
    return ARES_EBADSTR;

  encoded++;

  *s = malloc(elen.uns+1);
  if (*s == NULL)
    return ARES_ENOMEM;
  q = *s;
  strncpy((char *)q, (char *)encoded, elen.uns);
  q[elen.uns] = '\0';

  *s = q;

  *enclen = (long)(elen.sig+1);

  return ARES_SUCCESS;
}

node-v4.8.2/deps/cares/src/ares_fds.c000644 000766 000024 00000003657 13070706730 017537 0ustar00iojsstaff000000 000000 
/* Copyright 1998 by the Massachusetts Institute of Technology.
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"

#include "ares.h"
#include "ares_nowarn.h"
#include "ares_private.h"

int ares_fds(ares_channel channel, fd_set *read_fds, fd_set *write_fds)
{
  struct server_state *server;
  ares_socket_t nfds;
  int i;

  /* Are there any active queries? */
  int active_queries = !ares__is_list_empty(&(channel->all_queries));

  nfds = 0;
  for (i = 0; i < channel->nservers; i++)
    {
      server = &channel->servers[i];
      /* We only need to register interest in UDP sockets if we have
       * outstanding queries.
       */
      if (active_queries && server->udp_socket != ARES_SOCKET_BAD)
        {
          FD_SET(server->udp_socket, read_fds);
          if (server->udp_socket >= nfds)
            nfds = server->udp_socket + 1;
        }
      /* We always register for TCP events, because we want to know
       * when the other side closes the connection, so we don't waste
       * time trying to use a broken connection.
       */
      if (server->tcp_socket != ARES_SOCKET_BAD)
       {
         FD_SET(server->tcp_socket, read_fds);
         if (server->qhead)
           FD_SET(server->tcp_socket, write_fds);
         if (server->tcp_socket >= nfds)
           nfds = server->tcp_socket + 1;
	}
    }
  return (int)nfds;
}
node-v4.8.2/deps/cares/src/ares_free_hostent.c000644 000766 000024 00000002320 13070706730 021432 0ustar00iojsstaff000000 000000 
/* Copyright 1998 by the Massachusetts Institute of Technology.
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"

#ifdef HAVE_NETDB_H
#include 
#endif

#include "ares.h"
#include "ares_private.h" /* for memdebug */

void ares_free_hostent(struct hostent *host)
{
  char **p;

  if (!host)
    return;

  free((char *)(host->h_name));
  for (p = host->h_aliases; *p; p++)
    free(*p);
  free(host->h_aliases);
  free(host->h_addr_list[0]); /* no matter if there is one or many entries,
                                 there is only one malloc for all of them */
  free(host->h_addr_list);
  free(host);
}
node-v4.8.2/deps/cares/src/ares_free_string.c000644 000766 000024 00000001472 13070706730 021263 0ustar00iojsstaff000000 000000 
/* Copyright 2000 by the Massachusetts Institute of Technology.
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"

#include "ares.h"
#include "ares_private.h"

void ares_free_string(void *str)
{
  free(str);
}
node-v4.8.2/deps/cares/src/ares_getenv.c000644 000766 000024 00000001542 13070706730 020242 0ustar00iojsstaff000000 000000 

/* Copyright 1998 by the Massachusetts Institute of Technology.
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"
#include "ares_getenv.h"

#ifndef HAVE_GETENV

char *ares_getenv(const char *name)
{
#ifdef _WIN32_WCE
  return NULL;
#endif
}

#endif
node-v4.8.2/deps/cares/src/ares_getenv.h000644 000766 000024 00000001603 13070706730 020245 0ustar00iojsstaff000000 000000 #ifndef HEADER_CARES_GETENV_H
#define HEADER_CARES_GETENV_H


/* Copyright 1998 by the Massachusetts Institute of Technology.
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"

#ifndef HAVE_GETENV
extern char *ares_getenv(const char *name);
#endif

#endif /* HEADER_CARES_GETENV_H */
node-v4.8.2/deps/cares/src/ares_gethostbyaddr.c000644 000766 000024 00000020675 13070706730 021625 0ustar00iojsstaff000000 000000 
/* Copyright 1998 by the Massachusetts Institute of Technology.
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */
#include "ares_setup.h"

#ifdef HAVE_NETINET_IN_H
#  include 
#endif
#ifdef HAVE_NETDB_H
#  include 
#endif
#ifdef HAVE_ARPA_INET_H
#  include 
#endif
#ifdef HAVE_ARPA_NAMESER_H
#  include 
#else
#  include "nameser.h"
#endif
#ifdef HAVE_ARPA_NAMESER_COMPAT_H
#  include 
#endif

#include "ares.h"
#include "ares_inet_net_pton.h"
#include "ares_platform.h"
#include "ares_private.h"

#ifdef WATT32
#undef WIN32
#endif

struct addr_query {
  /* Arguments passed to ares_gethostbyaddr() */
  ares_channel channel;
  struct ares_addr addr;
  ares_host_callback callback;
  void *arg;

  const char *remaining_lookups;
  int timeouts;
};

static void next_lookup(struct addr_query *aquery);
static void addr_callback(void *arg, int status, int timeouts,
                          unsigned char *abuf, int alen);
static void end_aquery(struct addr_query *aquery, int status,
                       struct hostent *host);
static int file_lookup(struct ares_addr *addr, struct hostent **host);
static void ptr_rr_name(char *name, const struct ares_addr *addr);

void ares_gethostbyaddr(ares_channel channel, const void *addr, int addrlen,
                        int family, ares_host_callback callback, void *arg)
{
  struct addr_query *aquery;

  if (family != AF_INET && family != AF_INET6)
    {
      callback(arg, ARES_ENOTIMP, 0, NULL);
      return;
    }

  if ((family == AF_INET && addrlen != sizeof(aquery->addr.addrV4)) ||
      (family == AF_INET6 && addrlen != sizeof(aquery->addr.addrV6)))
    {
      callback(arg, ARES_ENOTIMP, 0, NULL);
      return;
    }

  aquery = malloc(sizeof(struct addr_query));
  if (!aquery)
    {
      callback(arg, ARES_ENOMEM, 0, NULL);
      return;
    }
  aquery->channel = channel;
  if (family == AF_INET)
    memcpy(&aquery->addr.addrV4, addr, sizeof(aquery->addr.addrV4));
  else
    memcpy(&aquery->addr.addrV6, addr, sizeof(aquery->addr.addrV6));
  aquery->addr.family = family;
  aquery->callback = callback;
  aquery->arg = arg;
  aquery->remaining_lookups = channel->lookups;
  aquery->timeouts = 0;

  next_lookup(aquery);
}

static void next_lookup(struct addr_query *aquery)
{
  const char *p;
  char name[128];
  int status;
  struct hostent *host;

  for (p = aquery->remaining_lookups; *p; p++)
    {
      switch (*p)
        {
        case 'b':
          ptr_rr_name(name, &aquery->addr);
          aquery->remaining_lookups = p + 1;
          ares_query(aquery->channel, name, C_IN, T_PTR, addr_callback,
                     aquery);
          return;
        case 'f':
          status = file_lookup(&aquery->addr, &host);

          /* this status check below previously checked for !ARES_ENOTFOUND,
             but we should not assume that this single error code is the one
             that can occur, as that is in fact no longer the case */
          if (status == ARES_SUCCESS)
            {
              end_aquery(aquery, status, host);
              return;
            }
          break;
        }
    }
  end_aquery(aquery, ARES_ENOTFOUND, NULL);
}

static void addr_callback(void *arg, int status, int timeouts,
                          unsigned char *abuf, int alen)
{
  struct addr_query *aquery = (struct addr_query *) arg;
  struct hostent *host;
  size_t addrlen;

  aquery->timeouts += timeouts;
  if (status == ARES_SUCCESS)
    {
      if (aquery->addr.family == AF_INET)
        {
          addrlen = sizeof(aquery->addr.addrV4);
          status = ares_parse_ptr_reply(abuf, alen, &aquery->addr.addrV4,
                                        (int)addrlen, AF_INET, &host);
        }
      else
        {
          addrlen = sizeof(aquery->addr.addrV6);
          status = ares_parse_ptr_reply(abuf, alen, &aquery->addr.addrV6,
                                        (int)addrlen, AF_INET6, &host);
        }
      end_aquery(aquery, status, host);
    }
  else if (status == ARES_EDESTRUCTION)
    end_aquery(aquery, status, NULL);
  else
    next_lookup(aquery);
}

static void end_aquery(struct addr_query *aquery, int status,
                       struct hostent *host)
{
  aquery->callback(aquery->arg, status, aquery->timeouts, host);
  if (host)
    ares_free_hostent(host);
  free(aquery);
}

static int file_lookup(struct ares_addr *addr, struct hostent **host)
{
  FILE *fp;
  int status;
  int error;

#ifdef WIN32
  char PATH_HOSTS[MAX_PATH];
  win_platform platform;

  PATH_HOSTS[0] = '\0';

  platform = ares__getplatform();

  if (platform == WIN_NT) {
    char tmp[MAX_PATH];
    HKEY hkeyHosts;

    if (RegOpenKeyEx(HKEY_LOCAL_MACHINE, WIN_NS_NT_KEY, 0, KEY_READ,
                     &hkeyHosts) == ERROR_SUCCESS)
    {
      DWORD dwLength = MAX_PATH;
      RegQueryValueEx(hkeyHosts, DATABASEPATH, NULL, NULL, (LPBYTE)tmp,
                      &dwLength);
      ExpandEnvironmentStrings(tmp, PATH_HOSTS, MAX_PATH);
      RegCloseKey(hkeyHosts);
    }
  }
  else if (platform == WIN_9X)
    GetWindowsDirectory(PATH_HOSTS, MAX_PATH);
  else
    return ARES_ENOTFOUND;

  strcat(PATH_HOSTS, WIN_PATH_HOSTS);

#elif defined(WATT32)
  extern const char *_w32_GetHostsFile (void);
  const char *PATH_HOSTS = _w32_GetHostsFile();

  if (!PATH_HOSTS)
    return ARES_ENOTFOUND;
#endif

  fp = fopen(PATH_HOSTS, "r");
  if (!fp)
    {
      error = ERRNO;
      switch(error)
        {
        case ENOENT:
        case ESRCH:
          return ARES_ENOTFOUND;
        default:
          DEBUGF(fprintf(stderr, "fopen() failed with error: %d %s\n",
                         error, strerror(error)));
          DEBUGF(fprintf(stderr, "Error opening file: %s\n",
                         PATH_HOSTS));
          *host = NULL;
          return ARES_EFILE;
        }
    }
  while ((status = ares__get_hostent(fp, addr->family, host)) == ARES_SUCCESS)
    {
      if (addr->family != (*host)->h_addrtype)
        {
          ares_free_hostent(*host);
          continue;
        }
      if (addr->family == AF_INET)
        {
          if (memcmp((*host)->h_addr, &addr->addrV4,
                     sizeof(addr->addrV4)) == 0)
            break;
        }
      else if (addr->family == AF_INET6)
        {
          if (memcmp((*host)->h_addr, &addr->addrV6,
                     sizeof(addr->addrV6)) == 0)
            break;
        }
      ares_free_hostent(*host);
    }
  fclose(fp);
  if (status == ARES_EOF)
    status = ARES_ENOTFOUND;
  if (status != ARES_SUCCESS)
    *host = NULL;
  return status;
}

static void ptr_rr_name(char *name, const struct ares_addr *addr)
{
  if (addr->family == AF_INET)
    {
       unsigned long laddr = ntohl(addr->addrV4.s_addr);
       unsigned long a1 = (laddr >> 24UL) & 0xFFUL;
       unsigned long a2 = (laddr >> 16UL) & 0xFFUL;
       unsigned long a3 = (laddr >>  8UL) & 0xFFUL;
       unsigned long a4 = laddr & 0xFFUL;
       sprintf(name, "%lu.%lu.%lu.%lu.in-addr.arpa", a4, a3, a2, a1);
    }
  else
    {
       unsigned char *bytes = (unsigned char *)&addr->addrV6;
       /* There are too many arguments to do this in one line using
        * minimally C89-compliant compilers */
       sprintf(name,
                "%x.%x.%x.%x.%x.%x.%x.%x.%x.%x.%x.%x.%x.%x.%x.%x.",
                bytes[15]&0xf, bytes[15] >> 4, bytes[14]&0xf, bytes[14] >> 4,
                bytes[13]&0xf, bytes[13] >> 4, bytes[12]&0xf, bytes[12] >> 4,
                bytes[11]&0xf, bytes[11] >> 4, bytes[10]&0xf, bytes[10] >> 4,
                bytes[9]&0xf, bytes[9] >> 4, bytes[8]&0xf, bytes[8] >> 4);
       sprintf(name+strlen(name),
                "%x.%x.%x.%x.%x.%x.%x.%x.%x.%x.%x.%x.%x.%x.%x.%x.ip6.arpa",
                bytes[7]&0xf, bytes[7] >> 4, bytes[6]&0xf, bytes[6] >> 4,
                bytes[5]&0xf, bytes[5] >> 4, bytes[4]&0xf, bytes[4] >> 4,
                bytes[3]&0xf, bytes[3] >> 4, bytes[2]&0xf, bytes[2] >> 4,
                bytes[1]&0xf, bytes[1] >> 4, bytes[0]&0xf, bytes[0] >> 4);
    }
}
node-v4.8.2/deps/cares/src/ares_gethostbyname.c000644 000766 000024 00000036227 13070706730 021633 0ustar00iojsstaff000000 000000 
/* Copyright 1998, 2011, 2013 by the Massachusetts Institute of Technology.
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"

#ifdef HAVE_NETINET_IN_H
#  include 
#endif
#ifdef HAVE_NETDB_H
#  include 
#endif
#ifdef HAVE_ARPA_INET_H
#  include 
#endif
#ifdef HAVE_ARPA_NAMESER_H
#  include 
#else
#  include "nameser.h"
#endif
#ifdef HAVE_ARPA_NAMESER_COMPAT_H
#  include 
#endif

#ifdef HAVE_STRINGS_H
#include 
#endif

#include "ares.h"
#include "ares_inet_net_pton.h"
#include "bitncmp.h"
#include "ares_platform.h"
#include "ares_nowarn.h"
#include "ares_private.h"

#ifdef WATT32
#undef WIN32
#endif

struct host_query {
  /* Arguments passed to ares_gethostbyname() */
  ares_channel channel;
  char *name;
  ares_host_callback callback;
  void *arg;
  int sent_family; /* this family is what was is being used */
  int want_family; /* this family is what is asked for in the API */
  const char *remaining_lookups;
  int timeouts;
};

static void next_lookup(struct host_query *hquery, int status_code);
static void host_callback(void *arg, int status, int timeouts,
                          unsigned char *abuf, int alen);
static void end_hquery(struct host_query *hquery, int status,
                       struct hostent *host);
static int fake_hostent(const char *name, int family,
                        ares_host_callback callback, void *arg);
static int file_lookup(const char *name, int family, struct hostent **host);
static void sort_addresses(struct hostent *host,
                           const struct apattern *sortlist, int nsort);
static void sort6_addresses(struct hostent *host,
                            const struct apattern *sortlist, int nsort);
static int get_address_index(const struct in_addr *addr,
                             const struct apattern *sortlist, int nsort);
static int get6_address_index(const struct ares_in6_addr *addr,
                              const struct apattern *sortlist, int nsort);

void ares_gethostbyname(ares_channel channel, const char *name, int family,
                        ares_host_callback callback, void *arg)
{
  struct host_query *hquery;

  /* Right now we only know how to look up Internet addresses - and unspec
     means try both basically. */
  switch (family) {
  case AF_INET:
  case AF_INET6:
  case AF_UNSPEC:
    break;
  default:
    callback(arg, ARES_ENOTIMP, 0, NULL);
    return;
  }

  if (fake_hostent(name, family, callback, arg))
    return;

  /* Allocate and fill in the host query structure. */
  hquery = malloc(sizeof(struct host_query));
  if (!hquery)
    {
      callback(arg, ARES_ENOMEM, 0, NULL);
      return;
    }
  hquery->channel = channel;
  hquery->name = strdup(name);
  hquery->want_family = family;
  hquery->sent_family = -1; /* nothing is sent yet */
  if (!hquery->name) {
    free(hquery);
    callback(arg, ARES_ENOMEM, 0, NULL);
    return;
  }
  hquery->callback = callback;
  hquery->arg = arg;
  hquery->remaining_lookups = channel->lookups;
  hquery->timeouts = 0;

  /* Start performing lookups according to channel->lookups. */
  next_lookup(hquery, ARES_ECONNREFUSED /* initial error code */);
}

static void next_lookup(struct host_query *hquery, int status_code)
{
  const char *p;
  struct hostent *host;
  int status = status_code;

  for (p = hquery->remaining_lookups; *p; p++)
    {
      switch (*p)
        {
        case 'b':
          /* DNS lookup */
          hquery->remaining_lookups = p + 1;
          if ((hquery->want_family == AF_INET6) ||
              (hquery->want_family == AF_UNSPEC)) {
            /* if inet6 or unspec, start out with AAAA */
            hquery->sent_family = AF_INET6;
            ares_search(hquery->channel, hquery->name, C_IN, T_AAAA,
                        host_callback, hquery);
          }
          else {
            hquery->sent_family = AF_INET;
            ares_search(hquery->channel, hquery->name, C_IN, T_A,
                        host_callback, hquery);
          }
          return;

        case 'f':
          /* Host file lookup */
          status = file_lookup(hquery->name, hquery->want_family, &host);

          /* this status check below previously checked for !ARES_ENOTFOUND,
             but we should not assume that this single error code is the one
             that can occur, as that is in fact no longer the case */
          if (status == ARES_SUCCESS)
            {
              end_hquery(hquery, status, host);
              return;
            }
          status = status_code;   /* Use original status code */
          break;
        }
    }
  end_hquery(hquery, status, NULL);
}

static void host_callback(void *arg, int status, int timeouts,
                          unsigned char *abuf, int alen)
{
  struct host_query *hquery = (struct host_query *) arg;
  ares_channel channel = hquery->channel;
  struct hostent *host = NULL;

  hquery->timeouts += timeouts;
  if (status == ARES_SUCCESS)
    {
      if (hquery->sent_family == AF_INET)
        {
          status = ares_parse_a_reply(abuf, alen, &host, NULL, NULL);
          if (host && channel->nsort)
            sort_addresses(host, channel->sortlist, channel->nsort);
        }
      else if (hquery->sent_family == AF_INET6)
        {
          status = ares_parse_aaaa_reply(abuf, alen, &host, NULL, NULL);
          if ((status == ARES_ENODATA || status == ARES_EBADRESP ||
               (status == ARES_SUCCESS && host && host->h_addr_list[0] == NULL)) &&
                hquery->want_family == AF_UNSPEC) {
            /* The query returned something but either there were no AAAA
               records (e.g. just CNAME) or the response was malformed.  Try
               looking up A instead. */
            hquery->sent_family = AF_INET;
            ares_search(hquery->channel, hquery->name, C_IN, T_A,
                        host_callback, hquery);
            return;
          }
          if (host && channel->nsort)
            sort6_addresses(host, channel->sortlist, channel->nsort);
        }
      end_hquery(hquery, status, host);
    }
  else if ((status == ARES_ENODATA || status == ARES_EBADRESP ||
            status == ARES_ETIMEOUT) && (hquery->sent_family == AF_INET6 &&
            hquery->want_family == AF_UNSPEC))
    {
      /* The AAAA query yielded no useful result.  Now look up an A instead. */
      hquery->sent_family = AF_INET;
      ares_search(hquery->channel, hquery->name, C_IN, T_A, host_callback,
                  hquery);
    }
  else if (status == ARES_EDESTRUCTION)
    end_hquery(hquery, status, NULL);
  else
    next_lookup(hquery, status);
}

static void end_hquery(struct host_query *hquery, int status,
                       struct hostent *host)
{
  hquery->callback(hquery->arg, status, hquery->timeouts, host);
  if (host)
    ares_free_hostent(host);
  free(hquery->name);
  free(hquery);
}

/* If the name looks like an IP address, fake up a host entry, end the
 * query immediately, and return true.  Otherwise return false.
 */
static int fake_hostent(const char *name, int family,
                        ares_host_callback callback, void *arg)
{
  struct hostent hostent;
  char *aliases[1] = { NULL };
  char *addrs[2];
  int result = 0;
  struct in_addr in;
  struct ares_in6_addr in6;

  if (family == AF_INET || family == AF_INET6)
    {
      /* It only looks like an IP address if it's all numbers and dots. */
      int numdots = 0, valid = 1;
      const char *p;
      for (p = name; *p; p++)
        {
          if (!ISDIGIT(*p) && *p != '.') {
            valid = 0;
            break;
          } else if (*p == '.') {
            numdots++;
          }
        }

      /* if we don't have 3 dots, it is illegal
       * (although inet_addr doesn't think so).
       */
      if (numdots != 3 || !valid)
        result = 0;
      else
        result = ((in.s_addr = inet_addr(name)) == INADDR_NONE ? 0 : 1);

      if (result)
        family = AF_INET;
    }
  if (family == AF_INET6)
    result = (ares_inet_pton(AF_INET6, name, &in6) < 1 ? 0 : 1);

  if (!result)
    return 0;

  if (family == AF_INET)
    {
      hostent.h_length = (int)sizeof(struct in_addr);
      addrs[0] = (char *)∈
    }
  else if (family == AF_INET6)
    {
      hostent.h_length = (int)sizeof(struct ares_in6_addr);
      addrs[0] = (char *)&in6;
    }
  /* Duplicate the name, to avoid a constness violation. */
  hostent.h_name = strdup(name);
  if (!hostent.h_name)
    {
      callback(arg, ARES_ENOMEM, 0, NULL);
      return 1;
    }

  /* Fill in the rest of the host structure and terminate the query. */
  addrs[1] = NULL;
  hostent.h_aliases = aliases;
  hostent.h_addrtype = aresx_sitoss(family);
  hostent.h_addr_list = addrs;
  callback(arg, ARES_SUCCESS, 0, &hostent);

  free((char *)(hostent.h_name));
  return 1;
}

/* This is an API method */
int ares_gethostbyname_file(ares_channel channel, const char *name,
                            int family, struct hostent **host)
{
  int result;

  /* We only take the channel to ensure that ares_init() been called. */
  if(channel == NULL)
    {
      /* Anything will do, really.  This seems fine, and is consistent with
         other error cases. */
      *host = NULL;
      return ARES_ENOTFOUND;
    }

  /* Just chain to the internal implementation we use here; it's exactly
   * what we want.
   */
  result = file_lookup(name, family, host);
  if(result != ARES_SUCCESS)
    {
      /* We guarantee a NULL hostent on failure. */
      *host = NULL;
    }
  return result;
}

static int file_lookup(const char *name, int family, struct hostent **host)
{
  FILE *fp;
  char **alias;
  int status;
  int error;

#ifdef WIN32
  char PATH_HOSTS[MAX_PATH];
  win_platform platform;

  PATH_HOSTS[0] = '\0';

  platform = ares__getplatform();

  if (platform == WIN_NT) {
    char tmp[MAX_PATH];
    HKEY hkeyHosts;

    if (RegOpenKeyEx(HKEY_LOCAL_MACHINE, WIN_NS_NT_KEY, 0, KEY_READ,
                     &hkeyHosts) == ERROR_SUCCESS)
    {
      DWORD dwLength = MAX_PATH;
      RegQueryValueEx(hkeyHosts, DATABASEPATH, NULL, NULL, (LPBYTE)tmp,
                      &dwLength);
      ExpandEnvironmentStrings(tmp, PATH_HOSTS, MAX_PATH);
      RegCloseKey(hkeyHosts);
    }
  }
  else if (platform == WIN_9X)
    GetWindowsDirectory(PATH_HOSTS, MAX_PATH);
  else
    return ARES_ENOTFOUND;

  strcat(PATH_HOSTS, WIN_PATH_HOSTS);

#elif defined(WATT32)
  extern const char *_w32_GetHostsFile (void);
  const char *PATH_HOSTS = _w32_GetHostsFile();

  if (!PATH_HOSTS)
    return ARES_ENOTFOUND;
#endif

  fp = fopen(PATH_HOSTS, "r");
  if (!fp)
    {
      error = ERRNO;
      switch(error)
        {
        case ENOENT:
        case ESRCH:
          return ARES_ENOTFOUND;
        default:
          DEBUGF(fprintf(stderr, "fopen() failed with error: %d %s\n",
                         error, strerror(error)));
          DEBUGF(fprintf(stderr, "Error opening file: %s\n",
                         PATH_HOSTS));
          *host = NULL;
          return ARES_EFILE;
        }
    }
  while ((status = ares__get_hostent(fp, family, host)) == ARES_SUCCESS)
    {
      if (strcasecmp((*host)->h_name, name) == 0)
        break;
      for (alias = (*host)->h_aliases; *alias; alias++)
        {
          if (strcasecmp(*alias, name) == 0)
            break;
        }
      if (*alias)
        break;
      ares_free_hostent(*host);
    }
  fclose(fp);
  if (status == ARES_EOF)
    status = ARES_ENOTFOUND;
  if (status != ARES_SUCCESS)
    *host = NULL;
  return status;
}

static void sort_addresses(struct hostent *host,
                           const struct apattern *sortlist, int nsort)
{
  struct in_addr a1, a2;
  int i1, i2, ind1, ind2;

  /* This is a simple insertion sort, not optimized at all.  i1 walks
   * through the address list, with the loop invariant that everything
   * to the left of i1 is sorted.  In the loop body, the value at i1 is moved
   * back through the list (via i2) until it is in sorted order.
   */
  for (i1 = 0; host->h_addr_list[i1]; i1++)
    {
      memcpy(&a1, host->h_addr_list[i1], sizeof(struct in_addr));
      ind1 = get_address_index(&a1, sortlist, nsort);
      for (i2 = i1 - 1; i2 >= 0; i2--)
        {
          memcpy(&a2, host->h_addr_list[i2], sizeof(struct in_addr));
          ind2 = get_address_index(&a2, sortlist, nsort);
          if (ind2 <= ind1)
            break;
          memcpy(host->h_addr_list[i2 + 1], &a2, sizeof(struct in_addr));
        }
      memcpy(host->h_addr_list[i2 + 1], &a1, sizeof(struct in_addr));
    }
}

/* Find the first entry in sortlist which matches addr.  Return nsort
 * if none of them match.
 */
static int get_address_index(const struct in_addr *addr,
                             const struct apattern *sortlist,
                             int nsort)
{
  int i;

  for (i = 0; i < nsort; i++)
    {
      if (sortlist[i].family != AF_INET)
        continue;
      if (sortlist[i].type == PATTERN_MASK)
        {
          if ((addr->s_addr & sortlist[i].mask.addr4.s_addr)
              == sortlist[i].addrV4.s_addr)
            break;
        }
      else
        {
          if (!ares__bitncmp(&addr->s_addr, &sortlist[i].addrV4.s_addr,
                             sortlist[i].mask.bits))
            break;
        }
    }
  return i;
}

static void sort6_addresses(struct hostent *host,
                            const struct apattern *sortlist, int nsort)
{
  struct ares_in6_addr a1, a2;
  int i1, i2, ind1, ind2;

  /* This is a simple insertion sort, not optimized at all.  i1 walks
   * through the address list, with the loop invariant that everything
   * to the left of i1 is sorted.  In the loop body, the value at i1 is moved
   * back through the list (via i2) until it is in sorted order.
   */
  for (i1 = 0; host->h_addr_list[i1]; i1++)
    {
      memcpy(&a1, host->h_addr_list[i1], sizeof(struct ares_in6_addr));
      ind1 = get6_address_index(&a1, sortlist, nsort);
      for (i2 = i1 - 1; i2 >= 0; i2--)
        {
          memcpy(&a2, host->h_addr_list[i2], sizeof(struct ares_in6_addr));
          ind2 = get6_address_index(&a2, sortlist, nsort);
          if (ind2 <= ind1)
            break;
          memcpy(host->h_addr_list[i2 + 1], &a2, sizeof(struct ares_in6_addr));
        }
      memcpy(host->h_addr_list[i2 + 1], &a1, sizeof(struct ares_in6_addr));
    }
}

/* Find the first entry in sortlist which matches addr.  Return nsort
 * if none of them match.
 */
static int get6_address_index(const struct ares_in6_addr *addr,
                              const struct apattern *sortlist,
                              int nsort)
{
  int i;

  for (i = 0; i < nsort; i++)
    {
      if (sortlist[i].family != AF_INET6)
        continue;
      if (!ares__bitncmp(addr, &sortlist[i].addrV6, sortlist[i].mask.bits))
        break;
    }
  return i;
}
node-v4.8.2/deps/cares/src/ares_getnameinfo.c000644 000766 000024 00000030746 13070706730 021256 0ustar00iojsstaff000000 000000 
/* Copyright 2005 by Dominick Meglio
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */
#include "ares_setup.h"

#ifdef HAVE_GETSERVBYPORT_R
#  if !defined(GETSERVBYPORT_R_ARGS) || \
     (GETSERVBYPORT_R_ARGS < 4) || (GETSERVBYPORT_R_ARGS > 6)
#    error "you MUST specifiy a valid number of arguments for getservbyport_r"
#  endif
#endif

#ifdef HAVE_NETINET_IN_H
#  include 
#endif
#ifdef HAVE_NETDB_H
#  include 
#endif
#ifdef HAVE_ARPA_INET_H
#  include 
#endif
#ifdef HAVE_ARPA_NAMESER_H
#  include 
#else
#  include "nameser.h"
#endif
#ifdef HAVE_ARPA_NAMESER_COMPAT_H
#  include 
#endif

#ifdef HAVE_NET_IF_H
#include 
#endif

#include "ares.h"
#include "ares_ipv6.h"
#include "ares_nowarn.h"
#include "ares_private.h"

struct nameinfo_query {
  ares_nameinfo_callback callback;
  void *arg;
  union {
    struct sockaddr_in addr4;
    struct sockaddr_in6 addr6;
  } addr;
  int family;
  int flags;
  int timeouts;
};

#ifdef HAVE_SOCKADDR_IN6_SIN6_SCOPE_ID
#define IPBUFSIZ \
        (sizeof("ffff:ffff:ffff:ffff:ffff:ffff:255.255.255.255") + IF_NAMESIZE)
#else
#define IPBUFSIZ \
        (sizeof("ffff:ffff:ffff:ffff:ffff:ffff:255.255.255.255"))
#endif

static void nameinfo_callback(void *arg, int status, int timeouts,
                              struct hostent *host);
static char *lookup_service(unsigned short port, int flags,
                            char *buf, size_t buflen);
#ifdef HAVE_SOCKADDR_IN6_SIN6_SCOPE_ID
static void append_scopeid(struct sockaddr_in6 *addr6, unsigned int scopeid,
                           char *buf, size_t buflen);
#endif
static char *ares_striendstr(const char *s1, const char *s2);

void ares_getnameinfo(ares_channel channel, const struct sockaddr *sa,
                      ares_socklen_t salen,
                      int flags, ares_nameinfo_callback callback, void *arg)
{
  struct sockaddr_in *addr = NULL;
  struct sockaddr_in6 *addr6 = NULL;
  struct nameinfo_query *niquery;
  unsigned int port = 0;

  /* Validate socket address family and length */
  if ((sa->sa_family == AF_INET) &&
      (salen == sizeof(struct sockaddr_in)))
    {
      addr = (struct sockaddr_in *)sa;
      port = addr->sin_port;
    }
  else if ((sa->sa_family == AF_INET6) &&
           (salen == sizeof(struct sockaddr_in6)))
    {
      addr6 = (struct sockaddr_in6 *)sa;
      port = addr6->sin6_port;
    }
  else
    {
      callback(arg, ARES_ENOTIMP, 0, NULL, NULL);
      return;
    }

  /* If neither, assume they want a host */
  if (!(flags & ARES_NI_LOOKUPSERVICE) && !(flags & ARES_NI_LOOKUPHOST))
    flags |= ARES_NI_LOOKUPHOST;

  /* All they want is a service, no need for DNS */
  if ((flags & ARES_NI_LOOKUPSERVICE) && !(flags & ARES_NI_LOOKUPHOST))
    {
      char buf[33], *service;

      service = lookup_service((unsigned short)(port & 0xffff),
                               flags, buf, sizeof(buf));
      callback(arg, ARES_SUCCESS, 0, NULL, service);
      return;
    }

  /* They want a host lookup */
  if ((flags & ARES_NI_LOOKUPHOST))
    {
     /* A numeric host can be handled without DNS */
     if ((flags & ARES_NI_NUMERICHOST))
      {
        char ipbuf[IPBUFSIZ];
        char srvbuf[33];
        char *service = NULL;
        ipbuf[0] = 0;

        /* Specifying not to lookup a host, but then saying a host
         * is required has to be illegal.
         */
        if (flags & ARES_NI_NAMEREQD)
          {
            callback(arg, ARES_EBADFLAGS, 0, NULL, NULL);
            return;
          }
        if (salen == sizeof(struct sockaddr_in6))
          {
            ares_inet_ntop(AF_INET6, &addr6->sin6_addr, ipbuf, IPBUFSIZ);
            /* If the system supports scope IDs, use it */
#ifdef HAVE_SOCKADDR_IN6_SIN6_SCOPE_ID
            append_scopeid(addr6, flags, ipbuf, sizeof(ipbuf));
#endif
          }
        else
          {
            ares_inet_ntop(AF_INET, &addr->sin_addr, ipbuf, IPBUFSIZ);
          }
        /* They also want a service */
        if (flags & ARES_NI_LOOKUPSERVICE)
          service = lookup_service((unsigned short)(port & 0xffff),
                                   flags, srvbuf, sizeof(srvbuf));
        callback(arg, ARES_SUCCESS, 0, ipbuf, service);
        return;
      }
    /* This is where a DNS lookup becomes necessary */
    else
      {
        niquery = malloc(sizeof(struct nameinfo_query));
        if (!niquery)
          {
            callback(arg, ARES_ENOMEM, 0, NULL, NULL);
            return;
          }
        niquery->callback = callback;
        niquery->arg = arg;
        niquery->flags = flags;
        niquery->timeouts = 0;
        if (sa->sa_family == AF_INET)
          {
            niquery->family = AF_INET;
            memcpy(&niquery->addr.addr4, addr, sizeof(niquery->addr.addr4));
            ares_gethostbyaddr(channel, &addr->sin_addr,
                               sizeof(struct in_addr), AF_INET,
                               nameinfo_callback, niquery);
          }
        else
          {
            niquery->family = AF_INET6;
            memcpy(&niquery->addr.addr6, addr6, sizeof(niquery->addr.addr6));
            ares_gethostbyaddr(channel, &addr6->sin6_addr,
                               sizeof(struct ares_in6_addr), AF_INET6,
                               nameinfo_callback, niquery);
          }
      }
    }
}

static void nameinfo_callback(void *arg, int status, int timeouts,
                              struct hostent *host)
{
  struct nameinfo_query *niquery = (struct nameinfo_query *) arg;
  char srvbuf[33];
  char *service = NULL;

  niquery->timeouts += timeouts;
  if (status == ARES_SUCCESS)
    {
      /* They want a service too */
      if (niquery->flags & ARES_NI_LOOKUPSERVICE)
        {
          if (niquery->family == AF_INET)
            service = lookup_service(niquery->addr.addr4.sin_port,
                                     niquery->flags, srvbuf, sizeof(srvbuf));
          else
            service = lookup_service(niquery->addr.addr6.sin6_port,
                                     niquery->flags, srvbuf, sizeof(srvbuf));
        }
      /* NOFQDN means we have to strip off the domain name portion.  We do
         this by determining our own domain name, then searching the string
         for this domain name and removing it.
       */
#ifdef HAVE_GETHOSTNAME
      if (niquery->flags & ARES_NI_NOFQDN)
        {
           char buf[255];
           char *domain;
           gethostname(buf, 255);
           if ((domain = strchr(buf, '.')) != NULL)
             {
               char *end = ares_striendstr(host->h_name, domain);
               if (end)
                 *end = 0;
             }
        }
#endif
      niquery->callback(niquery->arg, ARES_SUCCESS, niquery->timeouts,
                        (char *)(host->h_name),
                        service);
      free(niquery);
      return;
    }
  /* We couldn't find the host, but it's OK, we can use the IP */
  else if (status == ARES_ENOTFOUND && !(niquery->flags & ARES_NI_NAMEREQD))
    {
      char ipbuf[IPBUFSIZ];
      if (niquery->family == AF_INET)
        ares_inet_ntop(AF_INET, &niquery->addr.addr4.sin_addr, ipbuf,
                       IPBUFSIZ);
      else
        {
          ares_inet_ntop(AF_INET6, &niquery->addr.addr6.sin6_addr, ipbuf,
                         IPBUFSIZ);
#ifdef HAVE_SOCKADDR_IN6_SIN6_SCOPE_ID
          append_scopeid(&niquery->addr.addr6, niquery->flags, ipbuf,
                         sizeof(ipbuf));
#endif
        }
      /* They want a service too */
      if (niquery->flags & ARES_NI_LOOKUPSERVICE)
        {
          if (niquery->family == AF_INET)
            service = lookup_service(niquery->addr.addr4.sin_port,
                                     niquery->flags, srvbuf, sizeof(srvbuf));
          else
            service = lookup_service(niquery->addr.addr6.sin6_port,
                                     niquery->flags, srvbuf, sizeof(srvbuf));
        }
      niquery->callback(niquery->arg, ARES_SUCCESS, niquery->timeouts, ipbuf,
                        service);
      free(niquery);
      return;
    }
  niquery->callback(niquery->arg, status, niquery->timeouts, NULL, NULL);
  free(niquery);
}

static char *lookup_service(unsigned short port, int flags,
                            char *buf, size_t buflen)
{
  const char *proto;
  struct servent *sep;
#ifdef HAVE_GETSERVBYPORT_R
  struct servent se;
#endif
  char tmpbuf[4096];
  char *name;
  size_t name_len;

  if (port)
    {
      if (flags & ARES_NI_NUMERICSERV)
        sep = NULL;
      else
        {
          if (flags & ARES_NI_UDP)
            proto = "udp";
          else if (flags & ARES_NI_SCTP)
            proto = "sctp";
          else if (flags & ARES_NI_DCCP)
            proto = "dccp";
          else
            proto = "tcp";
#ifdef HAVE_GETSERVBYPORT_R
          sep = &se;
          memset(tmpbuf, 0, sizeof(tmpbuf));
#if GETSERVBYPORT_R_ARGS == 6
          if (getservbyport_r(port, proto, &se, (void *)tmpbuf,
                              sizeof(tmpbuf), &sep) != 0)
            sep = NULL;
#elif GETSERVBYPORT_R_ARGS == 5
          sep = getservbyport_r(port, proto, &se, (void *)tmpbuf,
                                sizeof(tmpbuf));
#elif GETSERVBYPORT_R_ARGS == 4
          if (getservbyport_r(port, proto, &se, (void *)tmpbuf) != 0)
            sep = NULL;
#else
          /* Lets just hope the OS uses TLS! */
          sep = getservbyport(port, proto);
#endif
#else
          /* Lets just hope the OS uses TLS! */
#if (defined(NETWARE) && !defined(__NOVELL_LIBC__))
          sep = getservbyport(port, (char*)proto);
#else
          sep = getservbyport(port, proto);
#endif
#endif
        }
      if (sep && sep->s_name)
        {
          /* get service name */
          name = sep->s_name;
        }
      else
        {
          /* get port as a string */
          sprintf(tmpbuf, "%u", (unsigned int)ntohs(port));
          name = tmpbuf;
        }
      name_len = strlen(name);
      if (name_len < buflen)
        /* return it if buffer big enough */
        memcpy(buf, name, name_len + 1);
      else
        /* avoid reusing previous one */
        buf[0] = '\0';
      return buf;
    }
  buf[0] = '\0';
  return NULL;
}

#ifdef HAVE_SOCKADDR_IN6_SIN6_SCOPE_ID
static void append_scopeid(struct sockaddr_in6 *addr6, unsigned int flags,
                           char *buf, size_t buflen)
{
#ifdef HAVE_IF_INDEXTONAME
  int is_ll, is_mcll;
#endif
  static const char fmt_u[] = "%u";
  static const char fmt_lu[] = "%lu";
  char tmpbuf[IF_NAMESIZE + 2];
  size_t bufl;
  const char *fmt = (sizeof(addr6->sin6_scope_id) > sizeof(unsigned int))?
    fmt_lu:fmt_u;

  tmpbuf[0] = '%';

#ifdef HAVE_IF_INDEXTONAME
  is_ll = IN6_IS_ADDR_LINKLOCAL(&addr6->sin6_addr);
  is_mcll = IN6_IS_ADDR_MC_LINKLOCAL(&addr6->sin6_addr);
  if ((flags & ARES_NI_NUMERICSCOPE) ||
      (!is_ll && !is_mcll))
    {
       sprintf(&tmpbuf[1], fmt, addr6->sin6_scope_id);
    }
  else
    {
      if (if_indextoname(addr6->sin6_scope_id, &tmpbuf[1]) == NULL)
        sprintf(&tmpbuf[1], fmt, addr6->sin6_scope_id);
    }
#else
  sprintf(&tmpbuf[1], fmt, addr6->sin6_scope_id);
  (void) flags;
#endif
  tmpbuf[IF_NAMESIZE + 1] = '\0';
  bufl = strlen(buf);

  if(bufl + strlen(tmpbuf) < buflen)
    /* only append the scopeid string if it fits in the target buffer */
    strcpy(&buf[bufl], tmpbuf);
}
#endif

/* Determines if s1 ends with the string in s2 (case-insensitive) */
static char *ares_striendstr(const char *s1, const char *s2)
{
  const char *c1, *c2, *c1_begin;
  int lo1, lo2;
  size_t s1_len = strlen(s1), s2_len = strlen(s2);

  /* If the substr is longer than the full str, it can't match */
  if (s2_len > s1_len)
    return NULL;

  /* Jump to the end of s1 minus the length of s2 */
  c1_begin = s1+s1_len-s2_len;
  c1 = (const char *)c1_begin;
  c2 = s2;
  while (c2 < s2+s2_len)
    {
      lo1 = TOLOWER(*c1);
      lo2 = TOLOWER(*c2);
      if (lo1 != lo2)
        return NULL;
      else
        {
          c1++;
          c2++;
        }
    }
  if (c2 == c1 && c2 == NULL)
    return (char *)c1_begin;
  return NULL;
}
node-v4.8.2/deps/cares/src/ares_getopt.c000644 000766 000024 00000010721 13070706730 020253 0ustar00iojsstaff000000 000000 /*
 * Original file name getopt.c  Initial import into the c-ares source tree
 * on 2007-04-11.  Lifted from version 5.2 of the 'Open Mash' project with
 * the modified BSD license, BSD license without the advertising clause.
 *
 */

/*
 * getopt.c --
 *
 *      Standard UNIX getopt function.  Code is from BSD.
 *
 * Copyright (c) 1987-2001 The Regents of the University of California.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * A. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * B. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * C. Neither the names of the copyright holders nor the names of its
 *    contributors may be used to endorse or promote products derived from this
 *    software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS
 * IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

/* #if !defined(lint)
 * static char sccsid[] = "@(#)getopt.c 8.2 (Berkeley) 4/2/94";
 * #endif
 */

#include 
#include 
#include 
#include "ares_getopt.h"

int   opterr = 1,     /* if error message should be printed */
      optind = 1;     /* index into parent argv vector */
int   optopt = 0;     /* character checked for validity */
static int optreset;  /* reset getopt */
char  *optarg;        /* argument associated with option */

#define  BADCH   (int)'?'
#define  BADARG  (int)':'
#define  EMSG    (char *)""

/*
 * ares_getopt --
 *    Parse argc/argv argument vector.
 */
int
ares_getopt(int nargc, char * const nargv[], const char *ostr)
{
    static char *place = EMSG;                /* option letter processing */
    char *oli;                                /* option letter list index */

    if (optreset || !*place) {                /* update scanning pointer */
        optreset = 0;
        if (optind >= nargc || *(place = nargv[optind]) != '-') {
            place = EMSG;
            return (EOF);
        }
        if (place[1] && *++place == '-') {    /* found "--" */
            ++optind;
            place = EMSG;
            return (EOF);
        }
    }                                         /* option letter okay? */
    if ((optopt = (int)*place++) == (int)':' ||
        (oli = strchr(ostr, optopt)) == NULL) {
        /*
         * if the user didn't specify '-' as an option,
         * assume it means EOF.
         */
        if (optopt == (int)'-')
            return (EOF);
        if (!*place)
            ++optind;
        if (opterr && *ostr != ':')
            (void)fprintf(stderr,
                "%s: illegal option -- %c\n", __FILE__, optopt);
        return (BADCH);
    }
    if (*++oli != ':') {                      /* don't need argument */
        optarg = NULL;
        if (!*place)
            ++optind;
    }
    else {                                    /* need an argument */
        if (*place)                           /* no white space */
            optarg = place;
        else if (nargc <= ++optind) {         /* no arg */
            place = EMSG;
            if (*ostr == ':')
                return (BADARG);
            if (opterr)
                (void)fprintf(stderr,
                    "%s: option requires an argument -- %c\n",
                    __FILE__, optopt);
            return (BADCH);
        }
         else                                 /* white space */
            optarg = nargv[optind];
        place = EMSG;
        ++optind;
    }
    return (optopt);                          /* dump back option letter */
}
node-v4.8.2/deps/cares/src/ares_getopt.h000644 000766 000024 00000004005 13070706730 020256 0ustar00iojsstaff000000 000000 #ifndef ARES_GETOPT_H
#define ARES_GETOPT_H

/*
 * Copyright (c) 1987-2001 The Regents of the University of California.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * A. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * B. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * C. Neither the names of the copyright holders nor the names of its
 *    contributors may be used to endorse or promote products derived from this
 *    software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS
 * IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */


int ares_getopt(int nargc, char * const nargv[], const char *ostr);

#undef optarg
#undef optind
#undef opterr
#undef optopt
#undef optreset

#define optarg   ares_optarg
#define optind   ares_optind
#define opterr   ares_opterr
#define optopt   ares_optopt
#define optreset ares_optreset

extern char *optarg;
extern int optind;
extern int opterr;
extern int optopt;

#endif /* ARES_GETOPT_H */
node-v4.8.2/deps/cares/src/ares_getsock.c000644 000766 000024 00000004400 13070706730 020405 0ustar00iojsstaff000000 000000 
/* Copyright (C) 2005 - 2010, Daniel Stenberg
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation for any purpose and without fee is hereby granted, provided
 * that the above copyright notice appear in all copies and that both that
 * copyright notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in advertising or
 * publicity pertaining to distribution of the software without specific,
 * written prior permission.  M.I.T. makes no representations about the
 * suitability of this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"

#include "ares.h"
#include "ares_private.h"

int ares_getsock(ares_channel channel,
                 ares_socket_t *socks,
                 int numsocks) /* size of the 'socks' array */
{
  struct server_state *server;
  int i;
  int sockindex=0;
  int bitmap = 0;
  unsigned int setbits = 0xffffffff;

  /* Are there any active queries? */
  int active_queries = !ares__is_list_empty(&(channel->all_queries));

  for (i = 0; i < channel->nservers; i++)
    {
      server = &channel->servers[i];
      /* We only need to register interest in UDP sockets if we have
       * outstanding queries.
       */
      if (active_queries && server->udp_socket != ARES_SOCKET_BAD)
        {
          if(sockindex >= numsocks || sockindex >= ARES_GETSOCK_MAXNUM)
            break;
          socks[sockindex] = server->udp_socket;
          bitmap |= ARES_GETSOCK_READABLE(setbits, sockindex);
          sockindex++;
        }
      /* We always register for TCP events, because we want to know
       * when the other side closes the connection, so we don't waste
       * time trying to use a broken connection.
       */
      if (server->tcp_socket != ARES_SOCKET_BAD)
       {
         if(sockindex >= numsocks || sockindex >= ARES_GETSOCK_MAXNUM)
           break;
         socks[sockindex] = server->tcp_socket;
         bitmap |= ARES_GETSOCK_READABLE(setbits, sockindex);

         if (server->qhead && active_queries)
           /* then the tcp socket is also writable! */
           bitmap |= ARES_GETSOCK_WRITABLE(setbits, sockindex);

         sockindex++;
       }
    }
  return bitmap;
}
node-v4.8.2/deps/cares/src/ares_inet_net_pton.h000644 000766 000024 00000001726 13070706730 021630 0ustar00iojsstaff000000 000000 #ifndef HEADER_CARES_INET_NET_PTON_H
#define HEADER_CARES_INET_NET_PTON_H

/* Copyright (C) 2005-2013 by Daniel Stenberg et al
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#ifdef HAVE_INET_NET_PTON
#define ares_inet_net_pton(w,x,y,z) inet_net_pton(w,x,y,z)
#else
int ares_inet_net_pton(int af, const char *src, void *dst, size_t size);
#endif

#endif /* HEADER_CARES_INET_NET_PTON_H */
node-v4.8.2/deps/cares/src/ares_init.c000644 000766 000024 00000152567 13070706730 017733 0ustar00iojsstaff000000 000000 
/* Copyright 1998 by the Massachusetts Institute of Technology.
 * Copyright (C) 2007-2013 by Daniel Stenberg
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"

#ifdef HAVE_SYS_PARAM_H
#include 
#endif

#ifdef HAVE_NETINET_IN_H
#include 
#endif

#ifdef HAVE_NETDB_H
#include 
#endif

#ifdef HAVE_ARPA_INET_H
#include 
#endif

#ifdef HAVE_ARPA_NAMESER_H
#  include 
#else
#  include "nameser.h"
#endif
#ifdef HAVE_ARPA_NAMESER_COMPAT_H
#  include 
#endif

#if defined(ANDROID) || defined(__ANDROID__)
#include 
/* From the Bionic sources */
#define DNS_PROP_NAME_PREFIX  "net.dns"
#define MAX_DNS_PROPERTIES    8
#endif

#include "ares.h"
#include "ares_inet_net_pton.h"
#include "ares_library_init.h"
#include "ares_nowarn.h"
#include "ares_platform.h"
#include "ares_private.h"

#ifdef WATT32
#undef WIN32  /* Redefined in MingW/MSVC headers */
#endif

static int init_by_options(ares_channel channel,
                           const struct ares_options *options,
                           int optmask);
static int init_by_environment(ares_channel channel);
static int init_by_resolv_conf(ares_channel channel);
static int init_by_defaults(ares_channel channel);

#ifndef WATT32
static int config_nameserver(struct server_state **servers, int *nservers,
                             char *str);
#endif
static int set_search(ares_channel channel, const char *str);
static int set_options(ares_channel channel, const char *str);
static const char *try_option(const char *p, const char *q, const char *opt);
static int init_id_key(rc4_key* key,int key_data_len);

#if !defined(WIN32) && !defined(WATT32) && \
    !defined(ANDROID) && !defined(__ANDROID__)
static int sortlist_alloc(struct apattern **sortlist, int *nsort,
                          struct apattern *pat);
static int ip_addr(const char *s, ssize_t len, struct in_addr *addr);
static void natural_mask(struct apattern *pat);
static int config_domain(ares_channel channel, char *str);
static int config_lookup(ares_channel channel, const char *str,
                         const char *bindch, const char *filech);
static int config_sortlist(struct apattern **sortlist, int *nsort,
                           const char *str);
static char *try_config(char *s, const char *opt, char scc);
#endif

#define ARES_CONFIG_CHECK(x) (x->lookups && x->nsort > -1 && \
                             x->nservers > -1 && \
                             x->ndomains > -1 && \
                             x->ndots > -1 && x->timeout > -1 && \
                             x->tries > -1)

int ares_init(ares_channel *channelptr)
{
  return ares_init_options(channelptr, NULL, 0);
}

int ares_init_options(ares_channel *channelptr, struct ares_options *options,
                      int optmask)
{
  ares_channel channel;
  int i;
  int status = ARES_SUCCESS;
  struct timeval now;

#ifdef CURLDEBUG
  const char *env = getenv("CARES_MEMDEBUG");

  if (env)
    curl_memdebug(env);
  env = getenv("CARES_MEMLIMIT");
  if (env) {
    char *endptr;
    long num = strtol(env, &endptr, 10);
    if((endptr != env) && (endptr == env + strlen(env)) && (num > 0))
      curl_memlimit(num);
  }
#endif

  if (ares_library_initialized() != ARES_SUCCESS)
    return ARES_ENOTINITIALIZED;

  channel = malloc(sizeof(struct ares_channeldata));
  if (!channel) {
    *channelptr = NULL;
    return ARES_ENOMEM;
  }

  now = ares__tvnow();

  /* Set everything to distinguished values so we know they haven't
   * been set yet.
   */
  channel->flags = -1;
  channel->timeout = -1;
  channel->tries = -1;
  channel->ndots = -1;
  channel->rotate = -1;
  channel->udp_port = -1;
  channel->tcp_port = -1;
  channel->ednspsz = -1;
  channel->socket_send_buffer_size = -1;
  channel->socket_receive_buffer_size = -1;
  channel->nservers = -1;
  channel->ndomains = -1;
  channel->nsort = -1;
  channel->tcp_connection_generation = 0;
  channel->lookups = NULL;
  channel->domains = NULL;
  channel->sortlist = NULL;
  channel->servers = NULL;
  channel->sock_state_cb = NULL;
  channel->sock_state_cb_data = NULL;
  channel->sock_create_cb = NULL;
  channel->sock_create_cb_data = NULL;

  channel->last_server = 0;
  channel->last_timeout_processed = (time_t)now.tv_sec;

  memset(&channel->local_dev_name, 0, sizeof(channel->local_dev_name));
  channel->local_ip4 = 0;
  memset(&channel->local_ip6, 0, sizeof(channel->local_ip6));

  /* Initialize our lists of queries */
  ares__init_list_head(&(channel->all_queries));
  for (i = 0; i < ARES_QID_TABLE_SIZE; i++)
    {
      ares__init_list_head(&(channel->queries_by_qid[i]));
    }
  for (i = 0; i < ARES_TIMEOUT_TABLE_SIZE; i++)
    {
      ares__init_list_head(&(channel->queries_by_timeout[i]));
    }

  /* Initialize configuration by each of the four sources, from highest
   * precedence to lowest.
   */

  if (status == ARES_SUCCESS) {
    status = init_by_options(channel, options, optmask);
    if (status != ARES_SUCCESS)
      DEBUGF(fprintf(stderr, "Error: init_by_options failed: %s\n",
                     ares_strerror(status)));
  }
  if (status == ARES_SUCCESS) {
    status = init_by_environment(channel);
    if (status != ARES_SUCCESS)
      DEBUGF(fprintf(stderr, "Error: init_by_environment failed: %s\n",
                     ares_strerror(status)));
  }
  if (status == ARES_SUCCESS) {
    status = init_by_resolv_conf(channel);
    if (status != ARES_SUCCESS)
      DEBUGF(fprintf(stderr, "Error: init_by_resolv_conf failed: %s\n",
                     ares_strerror(status)));
  }

  /*
   * No matter what failed or succeeded, seed defaults to provide
   * useful behavior for things that we missed.
   */
  status = init_by_defaults(channel);
  if (status != ARES_SUCCESS)
    DEBUGF(fprintf(stderr, "Error: init_by_defaults failed: %s\n",
                   ares_strerror(status)));

  /* Generate random key */

  if (status == ARES_SUCCESS) {
    status = init_id_key(&channel->id_key, ARES_ID_KEY_LEN);
    if (status == ARES_SUCCESS)
      channel->next_id = ares__generate_new_id(&channel->id_key);
    else
      DEBUGF(fprintf(stderr, "Error: init_id_key failed: %s\n",
                     ares_strerror(status)));
  }

  if (status != ARES_SUCCESS)
    {
      /* Something failed; clean up memory we may have allocated. */
      if (channel->servers)
        free(channel->servers);
      if (channel->domains)
        {
          for (i = 0; i < channel->ndomains; i++)
            free(channel->domains[i]);
          free(channel->domains);
        }
      if (channel->sortlist)
        free(channel->sortlist);
      if(channel->lookups)
        free(channel->lookups);
      free(channel);
      return status;
    }

  /* Trim to one server if ARES_FLAG_PRIMARY is set. */
  if ((channel->flags & ARES_FLAG_PRIMARY) && channel->nservers > 1)
    channel->nservers = 1;

  ares__init_servers_state(channel);

  *channelptr = channel;
  return ARES_SUCCESS;
}

/* ares_dup() duplicates a channel handle with all its options and returns a
   new channel handle */
int ares_dup(ares_channel *dest, ares_channel src)
{
  struct ares_options opts;
  struct ares_addr_node *servers;
  int ipv6_nservers = 0;
  int i, rc;
  int optmask;

  *dest = NULL; /* in case of failure return NULL explicitly */

  /* First get the options supported by the old ares_save_options() function,
     which is most of them */
  rc = ares_save_options(src, &opts, &optmask);
  if(rc)
  {
    ares_destroy_options(&opts);
    return rc;
  }

  /* Then create the new channel with those options */
  rc = ares_init_options(dest, &opts, optmask);

  /* destroy the options copy to not leak any memory */
  ares_destroy_options(&opts);

  if(rc)
    return rc;

  /* Now clone the options that ares_save_options() doesn't support. */
  (*dest)->sock_create_cb      = src->sock_create_cb;
  (*dest)->sock_create_cb_data = src->sock_create_cb_data;

  strncpy((*dest)->local_dev_name, src->local_dev_name,
          sizeof(src->local_dev_name));
  (*dest)->local_ip4 = src->local_ip4;
  memcpy((*dest)->local_ip6, src->local_ip6, sizeof(src->local_ip6));

  /* Full name server cloning required when not all are IPv4 */
  for (i = 0; i < src->nservers; i++)
    {
      if (src->servers[i].addr.family != AF_INET) {
        ipv6_nservers++;
        break;
      }
    }
  if (ipv6_nservers) {
    rc = ares_get_servers(src, &servers);
    if (rc != ARES_SUCCESS)
      return rc;
    rc = ares_set_servers(*dest, servers);
    ares_free_data(servers);
    if (rc != ARES_SUCCESS)
      return rc;
  }

  return ARES_SUCCESS; /* everything went fine */
}

/* Save options from initialized channel */
int ares_save_options(ares_channel channel, struct ares_options *options,
                      int *optmask)
{
  int i, j;
  int ipv4_nservers = 0;

  /* Zero everything out */
  memset(options, 0, sizeof(struct ares_options));

  if (!ARES_CONFIG_CHECK(channel))
    return ARES_ENODATA;

  /* Traditionally the optmask wasn't saved in the channel struct so it was
     recreated here. ROTATE is the first option that has no struct field of
     its own in the public config struct */
  (*optmask) = (ARES_OPT_FLAGS|ARES_OPT_TRIES|ARES_OPT_NDOTS|
                ARES_OPT_UDP_PORT|ARES_OPT_TCP_PORT|ARES_OPT_SOCK_STATE_CB|
                ARES_OPT_SERVERS|ARES_OPT_DOMAINS|ARES_OPT_LOOKUPS|
                ARES_OPT_SORTLIST|ARES_OPT_TIMEOUTMS) |
    (channel->optmask & ARES_OPT_ROTATE);

  /* Copy easy stuff */
  options->flags   = channel->flags;

  /* We return full millisecond resolution but that's only because we don't
     set the ARES_OPT_TIMEOUT anymore, only the new ARES_OPT_TIMEOUTMS */
  options->timeout = channel->timeout;
  options->tries   = channel->tries;
  options->ndots   = channel->ndots;
  options->udp_port = ntohs(aresx_sitous(channel->udp_port));
  options->tcp_port = ntohs(aresx_sitous(channel->tcp_port));
  options->sock_state_cb     = channel->sock_state_cb;
  options->sock_state_cb_data = channel->sock_state_cb_data;

  /* Copy IPv4 servers */
  if (channel->nservers) {
    for (i = 0; i < channel->nservers; i++)
    {
      if (channel->servers[i].addr.family == AF_INET)
        ipv4_nservers++;
    }
    if (ipv4_nservers) {
      options->servers = malloc(ipv4_nservers * sizeof(struct in_addr));
      if (!options->servers)
        return ARES_ENOMEM;
      for (i = j = 0; i < channel->nservers; i++)
      {
        if (channel->servers[i].addr.family == AF_INET)
          memcpy(&options->servers[j++],
                 &channel->servers[i].addr.addrV4,
                 sizeof(channel->servers[i].addr.addrV4));
      }
    }
  }
  options->nservers = ipv4_nservers;

  /* copy domains */
  if (channel->ndomains) {
    options->domains = malloc(channel->ndomains * sizeof(char *));
    if (!options->domains)
      return ARES_ENOMEM;

    for (i = 0; i < channel->ndomains; i++)
    {
      options->ndomains = i;
      options->domains[i] = strdup(channel->domains[i]);
      if (!options->domains[i])
        return ARES_ENOMEM;
    }
  }
  options->ndomains = channel->ndomains;

  /* copy lookups */
  if (channel->lookups) {
    options->lookups = strdup(channel->lookups);
    if (!options->lookups && channel->lookups)
      return ARES_ENOMEM;
  }

  /* copy sortlist */
  if (channel->nsort) {
    options->sortlist = malloc(channel->nsort * sizeof(struct apattern));
    if (!options->sortlist)
      return ARES_ENOMEM;
    for (i = 0; i < channel->nsort; i++)
      options->sortlist[i] = channel->sortlist[i];
  }
  options->nsort = channel->nsort;

  return ARES_SUCCESS;
}

static int init_by_options(ares_channel channel,
                           const struct ares_options *options,
                           int optmask)
{
  int i;

  /* Easy stuff. */
  if ((optmask & ARES_OPT_FLAGS) && channel->flags == -1)
    channel->flags = options->flags;
  if ((optmask & ARES_OPT_TIMEOUTMS) && channel->timeout == -1)
    channel->timeout = options->timeout;
  else if ((optmask & ARES_OPT_TIMEOUT) && channel->timeout == -1)
    channel->timeout = options->timeout * 1000;
  if ((optmask & ARES_OPT_TRIES) && channel->tries == -1)
    channel->tries = options->tries;
  if ((optmask & ARES_OPT_NDOTS) && channel->ndots == -1)
    channel->ndots = options->ndots;
  if ((optmask & ARES_OPT_ROTATE) && channel->rotate == -1)
    channel->rotate = 1;
  if ((optmask & ARES_OPT_UDP_PORT) && channel->udp_port == -1)
    channel->udp_port = htons(options->udp_port);
  if ((optmask & ARES_OPT_TCP_PORT) && channel->tcp_port == -1)
    channel->tcp_port = htons(options->tcp_port);
  if ((optmask & ARES_OPT_SOCK_STATE_CB) && channel->sock_state_cb == NULL)
    {
      channel->sock_state_cb = options->sock_state_cb;
      channel->sock_state_cb_data = options->sock_state_cb_data;
    }
  if ((optmask & ARES_OPT_SOCK_SNDBUF)
      && channel->socket_send_buffer_size == -1)
    channel->socket_send_buffer_size = options->socket_send_buffer_size;
  if ((optmask & ARES_OPT_SOCK_RCVBUF)
      && channel->socket_receive_buffer_size == -1)
    channel->socket_receive_buffer_size = options->socket_receive_buffer_size;

  if ((optmask & ARES_OPT_EDNSPSZ) && channel->ednspsz == -1)
    channel->ednspsz = options->ednspsz;

  /* Copy the IPv4 servers, if given. */
  if ((optmask & ARES_OPT_SERVERS) && channel->nservers == -1)
    {
      /* Avoid zero size allocations at any cost */
      if (options->nservers > 0)
        {
          channel->servers =
            malloc(options->nservers * sizeof(struct server_state));
          if (!channel->servers)
            return ARES_ENOMEM;
          for (i = 0; i < options->nservers; i++)
            {
              channel->servers[i].addr.family = AF_INET;
              memcpy(&channel->servers[i].addr.addrV4,
                     &options->servers[i],
                     sizeof(channel->servers[i].addr.addrV4));
            }
        }
      channel->nservers = options->nservers;
    }

  /* Copy the domains, if given.  Keep channel->ndomains consistent so
   * we can clean up in case of error.
   */
  if ((optmask & ARES_OPT_DOMAINS) && channel->ndomains == -1)
    {
      /* Avoid zero size allocations at any cost */
      if (options->ndomains > 0)
      {
        channel->domains = malloc(options->ndomains * sizeof(char *));
        if (!channel->domains)
          return ARES_ENOMEM;
        for (i = 0; i < options->ndomains; i++)
          {
            channel->ndomains = i;
            channel->domains[i] = strdup(options->domains[i]);
            if (!channel->domains[i])
              return ARES_ENOMEM;
          }
      }
      channel->ndomains = options->ndomains;
    }

  /* Set lookups, if given. */
  if ((optmask & ARES_OPT_LOOKUPS) && !channel->lookups)
    {
      channel->lookups = strdup(options->lookups);
      if (!channel->lookups)
        return ARES_ENOMEM;
    }

  /* copy sortlist */
  if ((optmask & ARES_OPT_SORTLIST) && (channel->nsort == -1) &&
      (options->nsort>0)) {
    channel->sortlist = malloc(options->nsort * sizeof(struct apattern));
    if (!channel->sortlist)
      return ARES_ENOMEM;
    for (i = 0; i < options->nsort; i++)
      channel->sortlist[i] = options->sortlist[i];
    channel->nsort = options->nsort;
  }

  channel->optmask = optmask;

  return ARES_SUCCESS;
}

static int init_by_environment(ares_channel channel)
{
  const char *localdomain, *res_options;
  int status;

  localdomain = getenv("LOCALDOMAIN");
  if (localdomain && channel->ndomains == -1)
    {
      status = set_search(channel, localdomain);
      if (status != ARES_SUCCESS)
        return status;
    }

  res_options = getenv("RES_OPTIONS");
  if (res_options)
    {
      status = set_options(channel, res_options);
      if (status != ARES_SUCCESS)
        return status;
    }

  return ARES_SUCCESS;
}

#ifdef WIN32
/*
 * get_REG_SZ()
 *
 * Given a 'hKey' handle to an open registry key and a 'leafKeyName' pointer
 * to the name of the registry leaf key to be queried, fetch it's string
 * value and return a pointer in *outptr to a newly allocated memory area
 * holding it as a null-terminated string.
 *
 * Returns 0 and nullifies *outptr upon inability to return a string value.
 *
 * Returns 1 and sets *outptr when returning a dynamically allocated string.
 *
 * Supported on Windows NT 3.5 and newer.
 */
static int get_REG_SZ(HKEY hKey, const char *leafKeyName, char **outptr)
{
  DWORD size = 0;
  int   res;

  *outptr = NULL;

  /* Find out size of string stored in registry */
  res = RegQueryValueEx(hKey, leafKeyName, 0, NULL, NULL, &size);
  if ((res != ERROR_SUCCESS && res != ERROR_MORE_DATA) || !size)
    return 0;

  /* Allocate buffer of indicated size plus one given that string
     might have been stored without null termination */
  *outptr = malloc(size+1);
  if (!*outptr)
    return 0;

  /* Get the value for real */
  res = RegQueryValueEx(hKey, leafKeyName, 0, NULL,
                        (unsigned char *)*outptr, &size);
  if ((res != ERROR_SUCCESS) || (size == 1))
  {
    free(*outptr);
    *outptr = NULL;
    return 0;
  }

  /* Null terminate buffer allways */
  *(*outptr + size) = '\0';

  return 1;
}

/*
 * get_REG_SZ_9X()
 *
 * Functionally identical to get_REG_SZ()
 *
 * Supported on Windows 95, 98 and ME.
 */
static int get_REG_SZ_9X(HKEY hKey, const char *leafKeyName, char **outptr)
{
  DWORD dataType = 0;
  DWORD size = 0;
  int   res;

  *outptr = NULL;

  /* Find out size of string stored in registry */
  res = RegQueryValueEx(hKey, leafKeyName, 0, &dataType, NULL, &size);
  if ((res != ERROR_SUCCESS && res != ERROR_MORE_DATA) || !size)
    return 0;

  /* Allocate buffer of indicated size plus one given that string
     might have been stored without null termination */
  *outptr = malloc(size+1);
  if (!*outptr)
    return 0;

  /* Get the value for real */
  res = RegQueryValueEx(hKey, leafKeyName, 0, &dataType,
                        (unsigned char *)*outptr, &size);
  if ((res != ERROR_SUCCESS) || (size == 1))
  {
    free(*outptr);
    *outptr = NULL;
    return 0;
  }

  /* Null terminate buffer allways */
  *(*outptr + size) = '\0';

  return 1;
}

/*
 * get_enum_REG_SZ()
 *
 * Given a 'hKeyParent' handle to an open registry key and a 'leafKeyName'
 * pointer to the name of the registry leaf key to be queried, parent key
 * is enumerated searching in child keys for given leaf key name and its
 * associated string value. When located, this returns a pointer in *outptr
 * to a newly allocated memory area holding it as a null-terminated string.
 *
 * Returns 0 and nullifies *outptr upon inability to return a string value.
 *
 * Returns 1 and sets *outptr when returning a dynamically allocated string.
 *
 * Supported on Windows NT 3.5 and newer.
 */
static int get_enum_REG_SZ(HKEY hKeyParent, const char *leafKeyName,
                           char **outptr)
{
  char  enumKeyName[256];
  DWORD enumKeyNameBuffSize;
  DWORD enumKeyIdx = 0;
  HKEY  hKeyEnum;
  int   gotString;
  int   res;

  *outptr = NULL;

  for(;;)
  {
    enumKeyNameBuffSize = sizeof(enumKeyName);
    res = RegEnumKeyEx(hKeyParent, enumKeyIdx++, enumKeyName,
                       &enumKeyNameBuffSize, 0, NULL, NULL, NULL);
    if (res != ERROR_SUCCESS)
      break;
    res = RegOpenKeyEx(hKeyParent, enumKeyName, 0, KEY_QUERY_VALUE,
                       &hKeyEnum);
    if (res != ERROR_SUCCESS)
      continue;
    gotString = get_REG_SZ(hKeyEnum, leafKeyName, outptr);
    RegCloseKey(hKeyEnum);
    if (gotString)
      break;
  }

  if (!*outptr)
    return 0;

  return 1;
}

/*
 * get_DNS_Registry_9X()
 *
 * Functionally identical to get_DNS_Registry()
 *
 * Implementation supports Windows 95, 98 and ME.
 */
static int get_DNS_Registry_9X(char **outptr)
{
  HKEY hKey_VxD_MStcp;
  int  gotString;
  int  res;

  *outptr = NULL;

  res = RegOpenKeyEx(HKEY_LOCAL_MACHINE, WIN_NS_9X, 0, KEY_READ,
                     &hKey_VxD_MStcp);
  if (res != ERROR_SUCCESS)
    return 0;

  gotString = get_REG_SZ_9X(hKey_VxD_MStcp, NAMESERVER, outptr);
  RegCloseKey(hKey_VxD_MStcp);

  if (!gotString || !*outptr)
    return 0;

  return 1;
}

/*
 * get_DNS_Registry_NT()
 *
 * Functionally identical to get_DNS_Registry()
 *
 * Refs: Microsoft Knowledge Base articles KB120642 and KB314053.
 *
 * Implementation supports Windows NT 3.5 and newer.
 */
static int get_DNS_Registry_NT(char **outptr)
{
  HKEY hKey_Interfaces = NULL;
  HKEY hKey_Tcpip_Parameters;
  int  gotString;
  int  res;

  *outptr = NULL;

  res = RegOpenKeyEx(HKEY_LOCAL_MACHINE, WIN_NS_NT_KEY, 0, KEY_READ,
                     &hKey_Tcpip_Parameters);
  if (res != ERROR_SUCCESS)
    return 0;

  /*
  ** Global DNS settings override adapter specific parameters when both
  ** are set. Additionally static DNS settings override DHCP-configured
  ** parameters when both are set.
  */

  /* Global DNS static parameters */
  gotString = get_REG_SZ(hKey_Tcpip_Parameters, NAMESERVER, outptr);
  if (gotString)
    goto done;

  /* Global DNS DHCP-configured parameters */
  gotString = get_REG_SZ(hKey_Tcpip_Parameters, DHCPNAMESERVER, outptr);
  if (gotString)
    goto done;

  /* Try adapter specific parameters */
  res = RegOpenKeyEx(hKey_Tcpip_Parameters, "Interfaces", 0,
                     KEY_QUERY_VALUE | KEY_ENUMERATE_SUB_KEYS,
                     &hKey_Interfaces);
  if (res != ERROR_SUCCESS)
  {
    hKey_Interfaces = NULL;
    goto done;
  }

  /* Adapter specific DNS static parameters */
  gotString = get_enum_REG_SZ(hKey_Interfaces, NAMESERVER, outptr);
  if (gotString)
    goto done;

  /* Adapter specific DNS DHCP-configured parameters */
  gotString = get_enum_REG_SZ(hKey_Interfaces, DHCPNAMESERVER, outptr);

done:
  if (hKey_Interfaces)
    RegCloseKey(hKey_Interfaces);

  RegCloseKey(hKey_Tcpip_Parameters);

  if (!gotString || !*outptr)
    return 0;

  return 1;
}

/*
 * get_DNS_Registry()
 *
 * Locates DNS info in the registry. When located, this returns a pointer
 * in *outptr to a newly allocated memory area holding a null-terminated
 * string with a space or comma seperated list of DNS IP addresses.
 *
 * Returns 0 and nullifies *outptr upon inability to return DNSes string.
 *
 * Returns 1 and sets *outptr when returning a dynamically allocated string.
 */
static int get_DNS_Registry(char **outptr)
{
  win_platform platform;
  int gotString = 0;

  *outptr = NULL;

  platform = ares__getplatform();

  if (platform == WIN_NT)
    gotString = get_DNS_Registry_NT(outptr);
  else if (platform == WIN_9X)
    gotString = get_DNS_Registry_9X(outptr);

  if (!gotString)
    return 0;

  return 1;
}

/*
 * commajoin()
 *
 * RTF code.
 */
static void commajoin(char **dst, const char *src)
{
  char *tmp;

  if (*dst)
  {
    tmp = malloc(strlen(*dst) + strlen(src) + 2);
    if (!tmp)
      return;
    sprintf(tmp, "%s,%s", *dst, src);
    free(*dst);
    *dst = tmp;
  }
  else
  {
    *dst = malloc(strlen(src) + 1);
    if (!*dst)
      return;
    strcpy(*dst, src);
  }
}

/*
 * get_DNS_NetworkParams()
 *
 * Locates DNS info using GetNetworkParams() function from the Internet
 * Protocol Helper (IP Helper) API. When located, this returns a pointer
 * in *outptr to a newly allocated memory area holding a null-terminated
 * string with a space or comma seperated list of DNS IP addresses.
 *
 * Returns 0 and nullifies *outptr upon inability to return DNSes string.
 *
 * Returns 1 and sets *outptr when returning a dynamically allocated string.
 *
 * Implementation supports Windows 98 and newer.
 *
 * Note: Ancient PSDK required in order to build a W98 target.
 */
static int get_DNS_NetworkParams(char **outptr)
{
  FIXED_INFO       *fi, *newfi;
  struct ares_addr namesrvr;
  char             *txtaddr;
  IP_ADDR_STRING   *ipAddr;
  int              res;
  DWORD            size = sizeof (*fi);

  *outptr = NULL;

  /* Verify run-time availability of GetNetworkParams() */
  if (ares_fpGetNetworkParams == ZERO_NULL)
    return 0;

  fi = malloc(size);
  if (!fi)
    return 0;

  res = (*ares_fpGetNetworkParams) (fi, &size);
  if ((res != ERROR_BUFFER_OVERFLOW) && (res != ERROR_SUCCESS))
    goto done;

  newfi = realloc(fi, size);
  if (!newfi)
    goto done;

  fi = newfi;
  res = (*ares_fpGetNetworkParams) (fi, &size);
  if (res != ERROR_SUCCESS)
    goto done;

  for (ipAddr = &fi->DnsServerList; ipAddr; ipAddr = ipAddr->Next)
  {
    txtaddr = &ipAddr->IpAddress.String[0];

    /* Validate converting textual address to binary format. */
    if (ares_inet_pton(AF_INET, txtaddr, &namesrvr.addrV4) == 1)
    {
      if ((namesrvr.addrV4.S_un.S_addr == INADDR_ANY) ||
          (namesrvr.addrV4.S_un.S_addr == INADDR_NONE))
        continue;
    }
    else if (ares_inet_pton(AF_INET6, txtaddr, &namesrvr.addrV6) == 1)
    {
      if (memcmp(&namesrvr.addrV6, &ares_in6addr_any,
                 sizeof(namesrvr.addrV6)) == 0)
        continue;
    }
    else
      continue;

    commajoin(outptr, txtaddr);

    if (!*outptr)
      break;
  }

done:
  if (fi)
    free(fi);

  if (!*outptr)
    return 0;

  return 1;
}

/*
 * get_DNS_AdaptersAddresses()
 *
 * Locates DNS info using GetAdaptersAddresses() function from the Internet
 * Protocol Helper (IP Helper) API. When located, this returns a pointer
 * in *outptr to a newly allocated memory area holding a null-terminated
 * string with a space or comma seperated list of DNS IP addresses.
 *
 * Returns 0 and nullifies *outptr upon inability to return DNSes string.
 *
 * Returns 1 and sets *outptr when returning a dynamically allocated string.
 *
 * Implementation supports Windows XP and newer.
 */
#define IPAA_INITIAL_BUF_SZ 15 * 1024
#define IPAA_MAX_TRIES 3
static int get_DNS_AdaptersAddresses(char **outptr)
{
  IP_ADAPTER_DNS_SERVER_ADDRESS *ipaDNSAddr;
  IP_ADAPTER_ADDRESSES *ipaa, *newipaa, *ipaaEntry;
  ULONG ReqBufsz = IPAA_INITIAL_BUF_SZ;
  ULONG Bufsz = IPAA_INITIAL_BUF_SZ;
  ULONG AddrFlags = 0;
  int trying = IPAA_MAX_TRIES;
  int res;

  union {
    struct sockaddr     *sa;
    struct sockaddr_in  *sa4;
    struct sockaddr_in6 *sa6;
  } namesrvr;

  char txtaddr[sizeof("ffff:ffff:ffff:ffff:ffff:ffff:255.255.255.255")];

  *outptr = NULL;

  /* Verify run-time availability of GetAdaptersAddresses() */
  if (ares_fpGetAdaptersAddresses == ZERO_NULL)
    return 0;

  ipaa = malloc(Bufsz);
  if (!ipaa)
    return 0;

  /* Usually this call suceeds with initial buffer size */
  res = (*ares_fpGetAdaptersAddresses) (AF_UNSPEC, AddrFlags, NULL,
                                        ipaa, &ReqBufsz);
  if ((res != ERROR_BUFFER_OVERFLOW) && (res != ERROR_SUCCESS))
    goto done;

  while ((res == ERROR_BUFFER_OVERFLOW) && (--trying))
  {
    if (Bufsz < ReqBufsz)
    {
      newipaa = realloc(ipaa, ReqBufsz);
      if (!newipaa)
        goto done;
      Bufsz = ReqBufsz;
      ipaa = newipaa;
    }
    res = (*ares_fpGetAdaptersAddresses) (AF_UNSPEC, AddrFlags, NULL,
                                          ipaa, &ReqBufsz);
    if (res == ERROR_SUCCESS)
      break;
  }
  if (res != ERROR_SUCCESS)
    goto done;

  for (ipaaEntry = ipaa; ipaaEntry; ipaaEntry = ipaaEntry->Next)
  {
    for (ipaDNSAddr = ipaaEntry->FirstDnsServerAddress;
         ipaDNSAddr;
         ipaDNSAddr = ipaDNSAddr->Next)
    {
      namesrvr.sa = ipaDNSAddr->Address.lpSockaddr;

      if (namesrvr.sa->sa_family == AF_INET)
      {
        if ((namesrvr.sa4->sin_addr.S_un.S_addr == INADDR_ANY) ||
            (namesrvr.sa4->sin_addr.S_un.S_addr == INADDR_NONE))
          continue;
        if (! ares_inet_ntop(AF_INET, &namesrvr.sa4->sin_addr,
                             txtaddr, sizeof(txtaddr)))
          continue;
      }
      else if (namesrvr.sa->sa_family == AF_INET6)
      {
        /* Windows apparently always reports some IPv6 DNS servers that
         * prefixed with fec0:0:0:ffff. These ususally do not point to
         * working DNS servers, so we ignore them. */
        if (strncmp(txtaddr, "fec0:0:0:ffff:", 14) == 0)
          continue;
        if (memcmp(&namesrvr.sa6->sin6_addr, &ares_in6addr_any,
                   sizeof(namesrvr.sa6->sin6_addr)) == 0)
          continue;
        if (! ares_inet_ntop(AF_INET6, &namesrvr.sa6->sin6_addr,
                             txtaddr, sizeof(txtaddr)))
          continue;
      }
      else
        continue;

      commajoin(outptr, txtaddr);

      if (!*outptr)
        goto done;
    }
  }

done:
  if (ipaa)
    free(ipaa);

  if (!*outptr)
    return 0;

  return 1;
}

/*
 * get_DNS_Windows()
 *
 * Locates DNS info from Windows employing most suitable methods available at
 * run-time no matter which Windows version it is. When located, this returns
 * a pointer in *outptr to a newly allocated memory area holding a string with
 * a space or comma seperated list of DNS IP addresses, null-terminated.
 *
 * Returns 0 and nullifies *outptr upon inability to return DNSes string.
 *
 * Returns 1 and sets *outptr when returning a dynamically allocated string.
 *
 * Implementation supports Windows 95 and newer.
 */
static int get_DNS_Windows(char **outptr)
{
  /* Try using IP helper API GetAdaptersAddresses() */
  if (get_DNS_AdaptersAddresses(outptr))
    return 1;

  /* Try using IP helper API GetNetworkParams() */
  if (get_DNS_NetworkParams(outptr))
    return 1;

  /* Fall-back to registry information */
  return get_DNS_Registry(outptr);
}
#endif

static int init_by_resolv_conf(ares_channel channel)
{
#if !defined(ANDROID) && !defined(__ANDROID__) && !defined(WATT32)
  char *line = NULL;
#endif
  int status = -1, nservers = 0, nsort = 0;
  struct server_state *servers = NULL;
  struct apattern *sortlist = NULL;

#ifdef WIN32

  if (channel->nservers > -1)  /* don't override ARES_OPT_SERVER */
     return ARES_SUCCESS;

  if (get_DNS_Windows(&line))
  {
    status = config_nameserver(&servers, &nservers, line);
    free(line);
  }

  if (status == ARES_SUCCESS)
    status = ARES_EOF;
  else
    /* Catch the case when all the above checks fail (which happens when there
       is no network card or the cable is unplugged) */
    status = ARES_EFILE;

#elif defined(__riscos__)

  /* Under RISC OS, name servers are listed in the
     system variable Inet$Resolvers, space separated. */

  line = getenv("Inet$Resolvers");
  status = ARES_EOF;
  if (line) {
    char *resolvers = strdup(line), *pos, *space;

    if (!resolvers)
      return ARES_ENOMEM;

    pos = resolvers;
    do {
      space = strchr(pos, ' ');
      if (space)
        *space = '\0';
      status = config_nameserver(&servers, &nservers, pos);
      if (status != ARES_SUCCESS)
        break;
      pos = space + 1;
    } while (space);

    if (status == ARES_SUCCESS)
      status = ARES_EOF;

    free(resolvers);
  }

#elif defined(WATT32)
  int i;

  sock_init();
  for (i = 0; def_nameservers[i]; i++)
      ;
  if (i == 0)
    return ARES_SUCCESS; /* use localhost DNS server */

  nservers = i;
  servers = calloc(i, sizeof(struct server_state));
  if (!servers)
     return ARES_ENOMEM;

  for (i = 0; def_nameservers[i]; i++)
  {
    servers[i].addr.addrV4.s_addr = htonl(def_nameservers[i]);
    servers[i].addr.family = AF_INET;
  }
  status = ARES_EOF;

#elif defined(ANDROID) || defined(__ANDROID__)
  unsigned int i;
  char propname[PROP_NAME_MAX];
  char propvalue[PROP_VALUE_MAX]="";

  for (i = 1; i <= MAX_DNS_PROPERTIES; i++) {
    snprintf(propname, sizeof(propname), "%s%u", DNS_PROP_NAME_PREFIX, i);
    if (__system_property_get(propname, propvalue) < 1) {
      status = ARES_EOF;
      break;
    }
    status = config_nameserver(&servers, &nservers, propvalue);
    if (status != ARES_SUCCESS)
      break;
    status = ARES_EOF;
  }
#else
  {
    char *p;
    FILE *fp;
    size_t linesize;
    int error;
    int update_domains;

    /* Don't read resolv.conf and friends if we don't have to */
    if (ARES_CONFIG_CHECK(channel))
        return ARES_SUCCESS;

    /* Only update search domains if they're not already specified */
    update_domains = (channel->ndomains == -1);

    fp = fopen(PATH_RESOLV_CONF, "r");
    if (fp) {
      while ((status = ares__read_line(fp, &line, &linesize)) == ARES_SUCCESS)
      {
        if ((p = try_config(line, "domain", ';')) && update_domains)
          status = config_domain(channel, p);
        else if ((p = try_config(line, "lookup", ';')) && !channel->lookups)
          status = config_lookup(channel, p, "bind", "file");
        else if ((p = try_config(line, "search", ';')) && update_domains)
          status = set_search(channel, p);
        else if ((p = try_config(line, "nameserver", ';')) &&
                 channel->nservers == -1)
          status = config_nameserver(&servers, &nservers, p);
        else if ((p = try_config(line, "sortlist", ';')) &&
                 channel->nsort == -1)
          status = config_sortlist(&sortlist, &nsort, p);
        else if ((p = try_config(line, "options", ';')))
          status = set_options(channel, p);
        else
          status = ARES_SUCCESS;
        if (status != ARES_SUCCESS)
          break;
      }
      fclose(fp);
    }
    else {
      error = ERRNO;
      switch(error) {
      case ENOENT:
      case ESRCH:
        status = ARES_EOF;
        break;
      default:
        DEBUGF(fprintf(stderr, "fopen() failed with error: %d %s\n",
                       error, strerror(error)));
        DEBUGF(fprintf(stderr, "Error opening file: %s\n", PATH_RESOLV_CONF));
        status = ARES_EFILE;
      }
    }

    if ((status == ARES_EOF) && (!channel->lookups)) {
      /* Many systems (Solaris, Linux, BSD's) use nsswitch.conf */
      fp = fopen("/etc/nsswitch.conf", "r");
      if (fp) {
        while ((status = ares__read_line(fp, &line, &linesize)) ==
               ARES_SUCCESS)
        {
          if ((p = try_config(line, "hosts:", '\0')) && !channel->lookups)
            /* ignore errors */
            (void)config_lookup(channel, p, "dns", "files");
        }
        fclose(fp);
      }
      else {
        error = ERRNO;
        switch(error) {
        case ENOENT:
        case ESRCH:
          status = ARES_EOF;
          break;
        default:
          DEBUGF(fprintf(stderr, "fopen() failed with error: %d %s\n",
                         error, strerror(error)));
          DEBUGF(fprintf(stderr, "Error opening file: %s\n",
                         "/etc/nsswitch.conf"));
          status = ARES_EFILE;
        }
      }
    }

    if ((status == ARES_EOF) && (!channel->lookups)) {
      /* Linux / GNU libc 2.x and possibly others have host.conf */
      fp = fopen("/etc/host.conf", "r");
      if (fp) {
        while ((status = ares__read_line(fp, &line, &linesize)) ==
               ARES_SUCCESS)
        {
          if ((p = try_config(line, "order", '\0')) && !channel->lookups)
            /* ignore errors */
            (void)config_lookup(channel, p, "bind", "hosts");
        }
        fclose(fp);
      }
      else {
        error = ERRNO;
        switch(error) {
        case ENOENT:
        case ESRCH:
          status = ARES_EOF;
          break;
        default:
          DEBUGF(fprintf(stderr, "fopen() failed with error: %d %s\n",
                         error, strerror(error)));
          DEBUGF(fprintf(stderr, "Error opening file: %s\n",
                         "/etc/host.conf"));
          status = ARES_EFILE;
        }
      }
    }

    if ((status == ARES_EOF) && (!channel->lookups)) {
      /* Tru64 uses /etc/svc.conf */
      fp = fopen("/etc/svc.conf", "r");
      if (fp) {
        while ((status = ares__read_line(fp, &line, &linesize)) ==
               ARES_SUCCESS)
        {
          if ((p = try_config(line, "hosts=", '\0')) && !channel->lookups)
            /* ignore errors */
            (void)config_lookup(channel, p, "bind", "local");
        }
        fclose(fp);
      }
      else {
        error = ERRNO;
        switch(error) {
        case ENOENT:
        case ESRCH:
          status = ARES_EOF;
          break;
        default:
          DEBUGF(fprintf(stderr, "fopen() failed with error: %d %s\n",
                         error, strerror(error)));
          DEBUGF(fprintf(stderr, "Error opening file: %s\n", "/etc/svc.conf"));
          status = ARES_EFILE;
        }
      }
    }

    if(line)
      free(line);
  }

#endif

  /* Handle errors. */
  if (status != ARES_EOF)
    {
      if (servers != NULL)
        free(servers);
      if (sortlist != NULL)
        free(sortlist);
      return status;
    }

  /* If we got any name server entries, fill them in. */
  if (servers)
    {
      channel->servers = servers;
      channel->nservers = nservers;
    }

  /* If we got any sortlist entries, fill them in. */
  if (sortlist)
    {
      channel->sortlist = sortlist;
      channel->nsort = nsort;
    }

  return ARES_SUCCESS;
}

static int init_by_defaults(ares_channel channel)
{
  char *hostname = NULL;
  int rc = ARES_SUCCESS;
#ifdef HAVE_GETHOSTNAME
  char *dot;
#endif

  if (channel->flags == -1)
    channel->flags = 0;
  if (channel->timeout == -1)
    channel->timeout = DEFAULT_TIMEOUT;
  if (channel->tries == -1)
    channel->tries = DEFAULT_TRIES;
  if (channel->ndots == -1)
    channel->ndots = 1;
  if (channel->rotate == -1)
    channel->rotate = 0;
  if (channel->udp_port == -1)
    channel->udp_port = htons(NAMESERVER_PORT);
  if (channel->tcp_port == -1)
    channel->tcp_port = htons(NAMESERVER_PORT);

  if (channel->ednspsz == -1)
    channel->ednspsz = EDNSPACKETSZ;

  if (channel->nservers == -1) {
    /* If nobody specified servers, try a local named. */
    channel->servers = malloc(sizeof(struct server_state));
    if (!channel->servers) {
      rc = ARES_ENOMEM;
      goto error;
    }
    channel->servers[0].addr.family = AF_INET;
    channel->servers[0].addr.addrV4.s_addr = htonl(INADDR_LOOPBACK);
    channel->nservers = 1;
  }

#if defined(USE_WINSOCK)
#define toolong(x) (x == -1) &&  (SOCKERRNO == WSAEFAULT)
#elif defined(ENAMETOOLONG)
#define toolong(x) (x == -1) && ((SOCKERRNO == ENAMETOOLONG) || \
                                 (SOCKERRNO == EINVAL))
#else
#define toolong(x) (x == -1) &&  (SOCKERRNO == EINVAL)
#endif

  if (channel->ndomains == -1) {
    /* Derive a default domain search list from the kernel hostname,
     * or set it to empty if the hostname isn't helpful.
     */
#ifndef HAVE_GETHOSTNAME
    channel->ndomains = 0; /* default to none */
#else
    GETHOSTNAME_TYPE_ARG2 lenv = 64;
    size_t len = 64;
    int res;
    channel->ndomains = 0; /* default to none */

    hostname = malloc(len);
    if(!hostname) {
      rc = ARES_ENOMEM;
      goto error;
    }

    do {
      res = gethostname(hostname, lenv);

      if(toolong(res)) {
        char *p;
        len *= 2;
        lenv *= 2;
        p = realloc(hostname, len);
        if(!p) {
          rc = ARES_ENOMEM;
          goto error;
        }
        hostname = p;
        continue;
      }
      else if(res) {
        rc = ARES_EBADNAME;
        goto error;
      }

    } while (res != 0);

    dot = strchr(hostname, '.');
    if (dot) {
      /* a dot was found */
      channel->domains = malloc(sizeof(char *));
      if (!channel->domains) {
        rc = ARES_ENOMEM;
        goto error;
      }
      channel->domains[0] = strdup(dot + 1);
      if (!channel->domains[0]) {
        rc = ARES_ENOMEM;
        goto error;
      }
      channel->ndomains = 1;
    }
#endif
  }

  if (channel->nsort == -1) {
    channel->sortlist = NULL;
    channel->nsort = 0;
  }

  if (!channel->lookups) {
    channel->lookups = strdup("fb");
    if (!channel->lookups)
      rc = ARES_ENOMEM;
  }

  error:
  if(rc) {
    if(channel->servers) {
      free(channel->servers);
      channel->servers = NULL;
    }

    if(channel->domains && channel->domains[0])
      free(channel->domains[0]);
    if(channel->domains) {
      free(channel->domains);
      channel->domains = NULL;
    }

    if(channel->lookups) {
      free(channel->lookups);
      channel->lookups = NULL;
    }
  }

  if(hostname)
    free(hostname);

  return rc;
}

#if !defined(WIN32) && !defined(WATT32) && \
    !defined(ANDROID) && !defined(__ANDROID__)
static int config_domain(ares_channel channel, char *str)
{
  char *q;

  /* Set a single search domain. */
  q = str;
  while (*q && !ISSPACE(*q))
    q++;
  *q = '\0';
  return set_search(channel, str);
}

#if defined(__INTEL_COMPILER) && (__INTEL_COMPILER == 910) && \
    defined(__OPTIMIZE__) && defined(__unix__) &&  defined(__i386__)
  /* workaround icc 9.1 optimizer issue */
# define vqualifier volatile
#else
# define vqualifier
#endif

static int config_lookup(ares_channel channel, const char *str,
                         const char *bindch, const char *filech)
{
  char lookups[3], *l;
  const char *vqualifier p;

  /* Set the lookup order.  Only the first letter of each work
   * is relevant, and it has to be "b" for DNS or "f" for the
   * host file.  Ignore everything else.
   */
  l = lookups;
  p = str;
  while (*p)
    {
      if ((*p == *bindch || *p == *filech) && l < lookups + 2) {
        if (*p == *bindch) *l++ = 'b';
        else *l++ = 'f';
      }
      while (*p && !ISSPACE(*p) && (*p != ','))
        p++;
      while (*p && (ISSPACE(*p) || (*p == ',')))
        p++;
    }
  *l = '\0';
  channel->lookups = strdup(lookups);
  return (channel->lookups) ? ARES_SUCCESS : ARES_ENOMEM;
}
#endif  /* !WIN32 & !WATT32 & !ANDROID & !__ANDROID__ */

#ifndef WATT32
static int config_nameserver(struct server_state **servers, int *nservers,
                             char *str)
{
  struct ares_addr host;
  struct server_state *newserv;
  char *p, *txtaddr;
  /* On Windows, there may be more than one nameserver specified in the same
   * registry key, so we parse input as a space or comma seperated list.
   */
  for (p = str; p;)
    {
      /* Skip whitespace and commas. */
      while (*p && (ISSPACE(*p) || (*p == ',')))
        p++;
      if (!*p)
        /* No more input, done. */
        break;

      /* Pointer to start of IPv4 or IPv6 address part. */
      txtaddr = p;

      /* Advance past this address. */
      while (*p && !ISSPACE(*p) && (*p != ','))
        p++;
      if (*p)
        /* Null terminate this address. */
        *p++ = '\0';
      else
        /* Reached end of input, done when this address is processed. */
        p = NULL;

      /* Convert textual address to binary format. */
      if (ares_inet_pton(AF_INET, txtaddr, &host.addrV4) == 1)
        host.family = AF_INET;
      else if (ares_inet_pton(AF_INET6, txtaddr, &host.addrV6) == 1)
        host.family = AF_INET6;
      else
        continue;

      /* Resize servers state array. */
      newserv = realloc(*servers, (*nservers + 1) *
                        sizeof(struct server_state));
      if (!newserv)
        return ARES_ENOMEM;

      /* Store address data. */
      newserv[*nservers].addr.family = host.family;
      if (host.family == AF_INET)
        memcpy(&newserv[*nservers].addr.addrV4, &host.addrV4,
               sizeof(host.addrV4));
      else
        memcpy(&newserv[*nservers].addr.addrV6, &host.addrV6,
               sizeof(host.addrV6));

      /* Update arguments. */
      *servers = newserv;
      *nservers += 1;
    }

  return ARES_SUCCESS;
}

#if !defined(WIN32) && !defined(ANDROID) && !defined(__ANDROID__)
static int config_sortlist(struct apattern **sortlist, int *nsort,
                           const char *str)
{
  struct apattern pat;
  const char *q;

  /* Add sortlist entries. */
  while (*str && *str != ';')
    {
      int bits;
      char ipbuf[16], ipbufpfx[32];
      /* Find just the IP */
      q = str;
      while (*q && *q != '/' && *q != ';' && !ISSPACE(*q))
        q++;
      memcpy(ipbuf, str, q-str);
      ipbuf[q-str] = '\0';
      /* Find the prefix */
      if (*q == '/')
        {
          const char *str2 = q+1;
          while (*q && *q != ';' && !ISSPACE(*q))
            q++;
          memcpy(ipbufpfx, str, q-str);
          ipbufpfx[q-str] = '\0';
          str = str2;
        }
      else
        ipbufpfx[0] = '\0';
      /* Lets see if it is CIDR */
      /* First we'll try IPv6 */
      if ((bits = ares_inet_net_pton(AF_INET6, ipbufpfx[0] ? ipbufpfx : ipbuf,
                                     &pat.addrV6,
                                     sizeof(pat.addrV6))) > 0)
        {
          pat.type = PATTERN_CIDR;
          pat.mask.bits = (unsigned short)bits;
          pat.family = AF_INET6;
          if (!sortlist_alloc(sortlist, nsort, &pat))
            return ARES_ENOMEM;
        }
      else if (ipbufpfx[0] &&
               (bits = ares_inet_net_pton(AF_INET, ipbufpfx, &pat.addrV4,
                                          sizeof(pat.addrV4))) > 0)
        {
          pat.type = PATTERN_CIDR;
          pat.mask.bits = (unsigned short)bits;
          pat.family = AF_INET;
          if (!sortlist_alloc(sortlist, nsort, &pat))
            return ARES_ENOMEM;
        }
      /* See if it is just a regular IP */
      else if (ip_addr(ipbuf, q-str, &pat.addrV4) == 0)
        {
          if (ipbufpfx[0])
            {
              memcpy(ipbuf, str, q-str);
              ipbuf[q-str] = '\0';
              if (ip_addr(ipbuf, q-str, &pat.mask.addr4) != 0)
                natural_mask(&pat);
            }
          else
            natural_mask(&pat);
          pat.family = AF_INET;
          pat.type = PATTERN_MASK;
          if (!sortlist_alloc(sortlist, nsort, &pat))
            return ARES_ENOMEM;
        }
      else
        {
          while (*q && *q != ';' && !ISSPACE(*q))
            q++;
        }
      str = q;
      while (ISSPACE(*str))
        str++;
    }

  return ARES_SUCCESS;
}
#endif  /* !WIN32 & !ANDROID & !__ANDROID__ */
#endif  /* !WATT32 */

static int set_search(ares_channel channel, const char *str)
{
  int n;
  const char *p, *q;

  if(channel->ndomains != -1) {
    /* if we already have some domains present, free them first */
    for(n=0; n < channel->ndomains; n++)
      free(channel->domains[n]);
    free(channel->domains);
    channel->domains = NULL;
    channel->ndomains = -1;
  }

  /* Count the domains given. */
  n = 0;
  p = str;
  while (*p)
    {
      while (*p && !ISSPACE(*p))
        p++;
      while (ISSPACE(*p))
        p++;
      n++;
    }

  if (!n)
    {
      channel->ndomains = 0;
      return ARES_SUCCESS;
    }

  channel->domains = malloc(n * sizeof(char *));
  if (!channel->domains)
    return ARES_ENOMEM;

  /* Now copy the domains. */
  n = 0;
  p = str;
  while (*p)
    {
      channel->ndomains = n;
      q = p;
      while (*q && !ISSPACE(*q))
        q++;
      channel->domains[n] = malloc(q - p + 1);
      if (!channel->domains[n])
        return ARES_ENOMEM;
      memcpy(channel->domains[n], p, q - p);
      channel->domains[n][q - p] = 0;
      p = q;
      while (ISSPACE(*p))
        p++;
      n++;
    }
  channel->ndomains = n;

  return ARES_SUCCESS;
}

static int set_options(ares_channel channel, const char *str)
{
  const char *p, *q, *val;

  p = str;
  while (*p)
    {
      q = p;
      while (*q && !ISSPACE(*q))
        q++;
      val = try_option(p, q, "ndots:");
      if (val && channel->ndots == -1)
        channel->ndots = aresx_sltosi(strtol(val, NULL, 10));
      val = try_option(p, q, "retrans:");
      if (val && channel->timeout == -1)
        channel->timeout = aresx_sltosi(strtol(val, NULL, 10));
      val = try_option(p, q, "retry:");
      if (val && channel->tries == -1)
        channel->tries = aresx_sltosi(strtol(val, NULL, 10));
      val = try_option(p, q, "rotate");
      if (val && channel->rotate == -1)
        channel->rotate = 1;
      p = q;
      while (ISSPACE(*p))
        p++;
    }

  return ARES_SUCCESS;
}

static const char *try_option(const char *p, const char *q, const char *opt)
{
  size_t len = strlen(opt);
  return ((size_t)(q - p) >= len && !strncmp(p, opt, len)) ? &p[len] : NULL;
}

#if !defined(WIN32) && !defined(WATT32) && \
    !defined(ANDROID) && !defined(__ANDROID__)
static char *try_config(char *s, const char *opt, char scc)
{
  size_t len;
  char *p;
  char *q;

  if (!s || !opt)
    /* no line or no option */
    return NULL;

  /* Hash '#' character is always used as primary comment char, additionally
     a not-NUL secondary comment char will be considered when specified. */

  /* trim line comment */
  p = s;
  if(scc)
    while (*p && (*p != '#') && (*p != scc))
      p++;
  else
    while (*p && (*p != '#'))
      p++;
  *p = '\0';

  /* trim trailing whitespace */
  q = p - 1;
  while ((q >= s) && ISSPACE(*q))
    q--;
  *++q = '\0';

  /* skip leading whitespace */
  p = s;
  while (*p && ISSPACE(*p))
    p++;

  if (!*p)
    /* empty line */
    return NULL;

  if ((len = strlen(opt)) == 0)
    /* empty option */
    return NULL;

  if (strncmp(p, opt, len) != 0)
    /* line and option do not match */
    return NULL;

  /* skip over given option name */
  p += len;

  if (!*p)
    /* no option value */
    return NULL;

  if ((opt[len-1] != ':') && (opt[len-1] != '=') && !ISSPACE(*p))
    /* whitespace between option name and value is mandatory
       for given option names which do not end with ':' or '=' */
    return NULL;

  /* skip over whitespace */
  while (*p && ISSPACE(*p))
    p++;

  if (!*p)
    /* no option value */
    return NULL;

  /* return pointer to option value */
  return p;
}

static int sortlist_alloc(struct apattern **sortlist, int *nsort,
                          struct apattern *pat)
{
  struct apattern *newsort;
  newsort = realloc(*sortlist, (*nsort + 1) * sizeof(struct apattern));
  if (!newsort)
    return 0;
  newsort[*nsort] = *pat;
  *sortlist = newsort;
  (*nsort)++;
  return 1;
}

static int ip_addr(const char *ipbuf, ssize_t len, struct in_addr *addr)
{

  /* Four octets and three periods yields at most 15 characters. */
  if (len > 15)
    return -1;

  addr->s_addr = inet_addr(ipbuf);
  if (addr->s_addr == INADDR_NONE && strcmp(ipbuf, "255.255.255.255") != 0)
    return -1;
  return 0;
}

static void natural_mask(struct apattern *pat)
{
  struct in_addr addr;

  /* Store a host-byte-order copy of pat in a struct in_addr.  Icky,
   * but portable.
   */
  addr.s_addr = ntohl(pat->addrV4.s_addr);

  /* This is out of date in the CIDR world, but some people might
   * still rely on it.
   */
  if (IN_CLASSA(addr.s_addr))
    pat->mask.addr4.s_addr = htonl(IN_CLASSA_NET);
  else if (IN_CLASSB(addr.s_addr))
    pat->mask.addr4.s_addr = htonl(IN_CLASSB_NET);
  else
    pat->mask.addr4.s_addr = htonl(IN_CLASSC_NET);
}
#endif  /* !WIN32 & !WATT32 & !ANDROID & !__ANDROID__ */

/* initialize an rc4 key. If possible a cryptographically secure random key
   is generated using a suitable function (for example win32's RtlGenRandom as
   described in
   http://blogs.msdn.com/michael_howard/archive/2005/01/14/353379.aspx
   otherwise the code defaults to cross-platform albeit less secure mechanism
   using rand
*/
static void randomize_key(unsigned char* key,int key_data_len)
{
  int randomized = 0;
  int counter=0;
#ifdef WIN32
  BOOLEAN res;
  if (ares_fpSystemFunction036)
    {
      res = (*ares_fpSystemFunction036) (key, key_data_len);
      if (res)
        randomized = 1;
    }
#else /* !WIN32 */
#ifdef RANDOM_FILE
  FILE *f = fopen(RANDOM_FILE, "rb");
  if(f) {
    counter = aresx_uztosi(fread(key, 1, key_data_len, f));
    fclose(f);
  }
#endif
#endif /* WIN32 */

  if (!randomized) {
    for (;counterstate[0];
  for(counter = 0; counter < 256; counter++)
    /* unnecessary AND but it keeps some compilers happier */
    state[counter] = (unsigned char)(counter & 0xff);
  randomize_key(key->state,key_data_len);
  key->x = 0;
  key->y = 0;
  index1 = 0;
  index2 = 0;
  for(counter = 0; counter < 256; counter++)
  {
    index2 = (unsigned char)((key_data_ptr[index1] + state[counter] +
                              index2) % 256);
    ARES_SWAP_BYTE(&state[counter], &state[index2]);

    index1 = (unsigned char)((index1 + 1) % key_data_len);
  }
  free(key_data_ptr);
  return ARES_SUCCESS;
}

void ares_set_local_ip4(ares_channel channel, unsigned int local_ip)
{
  channel->local_ip4 = local_ip;
}

/* local_ip6 should be 16 bytes in length */
void ares_set_local_ip6(ares_channel channel,
                        const unsigned char* local_ip6)
{
  memcpy(&channel->local_ip6, local_ip6, sizeof(channel->local_ip6));
}

/* local_dev_name should be null terminated. */
void ares_set_local_dev(ares_channel channel,
                        const char* local_dev_name)
{
  strncpy(channel->local_dev_name, local_dev_name,
          sizeof(channel->local_dev_name));
  channel->local_dev_name[sizeof(channel->local_dev_name) - 1] = 0;
}


void ares_set_socket_callback(ares_channel channel,
                              ares_sock_create_callback cb,
                              void *data)
{
  channel->sock_create_cb = cb;
  channel->sock_create_cb_data = data;
}

void ares__init_servers_state(ares_channel channel)
{
  struct server_state *server;
  int i;

  for (i = 0; i < channel->nservers; i++)
    {
      server = &channel->servers[i];
      server->udp_socket = ARES_SOCKET_BAD;
      server->tcp_socket = ARES_SOCKET_BAD;
      server->tcp_connection_generation = ++channel->tcp_connection_generation;
      server->tcp_lenbuf_pos = 0;
      server->tcp_buffer_pos = 0;
      server->tcp_buffer = NULL;
      server->tcp_length = 0;
      server->qhead = NULL;
      server->qtail = NULL;
      ares__init_list_head(&server->queries_to_server);
      server->channel = channel;
      server->is_broken = 0;
    }
}
node-v4.8.2/deps/cares/src/ares_iphlpapi.h000644 000766 000024 00000013466 13070706730 020575 0ustar00iojsstaff000000 000000 #ifndef HEADER_CARES_IPHLPAPI_H
#define HEADER_CARES_IPHLPAPI_H

/* Copyright 1998 by the Massachusetts Institute of Technology.
 * Copyright (C) 2004 - 2011 by Daniel Stenberg et al
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#if defined(USE_WINSOCK)

#ifndef INET_ADDRSTRLEN
#define INET_ADDRSTRLEN  22
#endif

#ifndef INET6_ADDRSTRLEN
#define INET6_ADDRSTRLEN 65
#endif

/* ---------------------------------- */
#if !defined(_WS2DEF_)           && \
    !defined(__CSADDR_DEFINED__) && \
    !defined(__CSADDR_T_DEFINED)
/* ---------------------------------- */

typedef struct _SOCKET_ADDRESS {
  LPSOCKADDR lpSockaddr;
  INT iSockaddrLength;
} SOCKET_ADDRESS, *PSOCKET_ADDRESS;

typedef struct _CSADDR_INFO {
  SOCKET_ADDRESS LocalAddr;
  SOCKET_ADDRESS RemoteAddr;
  INT iSocketType;
  INT iProtocol;
} CSADDR_INFO, *PCSADDR_INFO;

/* --------------------------------- */
#endif /* ! _WS2DEF_           && \  */
/*        ! __CSADDR_DEFINED__ && \  */
/*        ! __CSADDR_T_DEFINED       */
/* --------------------------------- */

/* ------------------------------- */
#if !defined(IP_ADAPTER_DDNS_ENABLED)
/* ------------------------------- */

#define IP_ADAPTER_ADDRESS_DNS_ELIGIBLE  0x0001
#define IP_ADAPTER_ADDRESS_TRANSIENT     0x0002

#define IP_ADAPTER_DDNS_ENABLED                0x0001
#define IP_ADAPTER_REGISTER_ADAPTER_SUFFIX     0x0002
#define IP_ADAPTER_DHCP_ENABLED                0x0004
#define IP_ADAPTER_RECEIVE_ONLY                0x0008
#define IP_ADAPTER_NO_MULTICAST                0x0010
#define IP_ADAPTER_IPV6_OTHER_STATEFUL_CONFIG  0x0020

#define GAA_FLAG_SKIP_UNICAST        0x0001
#define GAA_FLAG_SKIP_ANYCAST        0x0002
#define GAA_FLAG_SKIP_MULTICAST      0x0004
#define GAA_FLAG_SKIP_DNS_SERVER     0x0008
#define GAA_FLAG_INCLUDE_PREFIX      0x0010
#define GAA_FLAG_SKIP_FRIENDLY_NAME  0x0020

typedef enum {
  IpPrefixOriginOther = 0,
  IpPrefixOriginManual,
  IpPrefixOriginWellKnown,
  IpPrefixOriginDhcp,
  IpPrefixOriginRouterAdvertisement
} IP_PREFIX_ORIGIN;

typedef enum {
  IpSuffixOriginOther = 0,
  IpSuffixOriginManual,
  IpSuffixOriginWellKnown,
  IpSuffixOriginDhcp,
  IpSuffixOriginLinkLayerAddress,
  IpSuffixOriginRandom
} IP_SUFFIX_ORIGIN;

typedef enum {
  IpDadStateInvalid = 0,
  IpDadStateTentative,
  IpDadStateDuplicate,
  IpDadStateDeprecated,
  IpDadStatePreferred
} IP_DAD_STATE;

typedef enum {
  IfOperStatusUp = 1,
  IfOperStatusDown,
  IfOperStatusTesting,
  IfOperStatusUnknown,
  IfOperStatusDormant,
  IfOperStatusNotPresent,
  IfOperStatusLowerLayerDown
} IF_OPER_STATUS;

typedef enum {
  ScopeLevelInterface    = 0x0001,
  ScopeLevelLink         = 0x0002,
  ScopeLevelSubnet       = 0x0003,
  ScopeLevelAdmin        = 0x0004,
  ScopeLevelSite         = 0x0005,
  ScopeLevelOrganization = 0x0008,
  ScopeLevelGlobal       = 0x000E
} SCOPE_LEVEL;

typedef struct _IP_ADAPTER_UNICAST_ADDRESS {
  union {
    ULONGLONG Alignment;
    struct {
      ULONG Length;
      DWORD Flags;
    } s;
  } u;
  struct _IP_ADAPTER_UNICAST_ADDRESS *Next;
  SOCKET_ADDRESS Address;
  IP_PREFIX_ORIGIN PrefixOrigin;
  IP_SUFFIX_ORIGIN SuffixOrigin;
  IP_DAD_STATE DadState;
  ULONG ValidLifetime;
  ULONG PreferredLifetime;
  ULONG LeaseLifetime;
} IP_ADAPTER_UNICAST_ADDRESS, *PIP_ADAPTER_UNICAST_ADDRESS;

typedef struct _IP_ADAPTER_ANYCAST_ADDRESS {
  union {
    ULONGLONG Alignment;
    struct {
      ULONG Length;
      DWORD Flags;
    } s;
  } u;
  struct _IP_ADAPTER_ANYCAST_ADDRESS *Next;
  SOCKET_ADDRESS Address;
} IP_ADAPTER_ANYCAST_ADDRESS, *PIP_ADAPTER_ANYCAST_ADDRESS;

typedef struct _IP_ADAPTER_MULTICAST_ADDRESS {
  union {
    ULONGLONG Alignment;
    struct {
      ULONG Length;
      DWORD Flags;
    } s;
  } u;
  struct _IP_ADAPTER_MULTICAST_ADDRESS *Next;
  SOCKET_ADDRESS Address;
} IP_ADAPTER_MULTICAST_ADDRESS, *PIP_ADAPTER_MULTICAST_ADDRESS;

typedef struct _IP_ADAPTER_DNS_SERVER_ADDRESS {
  union {
    ULONGLONG Alignment;
    struct {
      ULONG Length;
      DWORD Reserved;
    } s;
  } u;
  struct _IP_ADAPTER_DNS_SERVER_ADDRESS *Next;
  SOCKET_ADDRESS Address;
} IP_ADAPTER_DNS_SERVER_ADDRESS, *PIP_ADAPTER_DNS_SERVER_ADDRESS;

typedef struct _IP_ADAPTER_PREFIX {
  union {
    ULONGLONG Alignment;
    struct {
      ULONG Length;
      DWORD Flags;
    } s;
  } u;
  struct _IP_ADAPTER_PREFIX *Next;
  SOCKET_ADDRESS Address;
  ULONG PrefixLength;
} IP_ADAPTER_PREFIX, *PIP_ADAPTER_PREFIX;

typedef struct _IP_ADAPTER_ADDRESSES {
  union {
    ULONGLONG Alignment;
    struct {
      ULONG Length;
      DWORD IfIndex;
    } s;
  } u;
  struct _IP_ADAPTER_ADDRESSES *Next;
  PCHAR AdapterName;
  PIP_ADAPTER_UNICAST_ADDRESS FirstUnicastAddress;
  PIP_ADAPTER_ANYCAST_ADDRESS FirstAnycastAddress;
  PIP_ADAPTER_MULTICAST_ADDRESS FirstMulticastAddress;
  PIP_ADAPTER_DNS_SERVER_ADDRESS FirstDnsServerAddress;
  PWCHAR DnsSuffix;
  PWCHAR Description;
  PWCHAR FriendlyName;
  BYTE PhysicalAddress[MAX_ADAPTER_ADDRESS_LENGTH];
  DWORD PhysicalAddressLength;
  DWORD Flags;
  DWORD Mtu;
  DWORD IfType;
  IF_OPER_STATUS OperStatus;
  DWORD Ipv6IfIndex;
  DWORD ZoneIndices[16];
  PIP_ADAPTER_PREFIX FirstPrefix;
} IP_ADAPTER_ADDRESSES, *PIP_ADAPTER_ADDRESSES;

/* -------------------------------- */
#endif /* ! IP_ADAPTER_DDNS_ENABLED */
/* -------------------------------- */

#endif /* USE_WINSOCK */

#endif /* HEADER_CARES_IPHLPAPI_H */
node-v4.8.2/deps/cares/src/ares_ipv6.h000644 000766 000024 00000003636 13070706730 017651 0ustar00iojsstaff000000 000000 
/* Copyright (C) 2005 by Dominick Meglio
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#ifndef ARES_IPV6_H
#define ARES_IPV6_H

#ifndef HAVE_PF_INET6
#define PF_INET6 AF_INET6
#endif

#ifndef HAVE_STRUCT_SOCKADDR_IN6
struct sockaddr_in6
{
  unsigned short       sin6_family;
  unsigned short       sin6_port;
  unsigned long        sin6_flowinfo;
  struct ares_in6_addr sin6_addr;
  unsigned int         sin6_scope_id;
};
#endif

#ifndef HAVE_STRUCT_ADDRINFO
struct addrinfo
{
  int              ai_flags;
  int              ai_family;
  int              ai_socktype;
  int              ai_protocol;
  ares_socklen_t   ai_addrlen;   /* Follow rfc3493 struct addrinfo */
  char            *ai_canonname;
  struct sockaddr *ai_addr;
  struct addrinfo *ai_next;
};
#endif

#ifndef NS_IN6ADDRSZ
#if SIZEOF_STRUCT_IN6_ADDR == 0
/* We cannot have it set to zero, so we pick a fixed value here */
#define NS_IN6ADDRSZ 16
#else
#define NS_IN6ADDRSZ SIZEOF_STRUCT_IN6_ADDR
#endif
#endif

#ifndef NS_INADDRSZ
#define NS_INADDRSZ SIZEOF_STRUCT_IN_ADDR
#endif

#ifndef NS_INT16SZ
#define NS_INT16SZ 2
#endif

#ifndef IF_NAMESIZE
#ifdef IFNAMSIZ
#define IF_NAMESIZE IFNAMSIZ
#else
#define IF_NAMESIZE 256
#endif
#endif

/* Defined in inet_net_pton.c for no particular reason. */
extern const struct ares_in6_addr ares_in6addr_any; /* :: */


#endif /* ARES_IPV6_H */
node-v4.8.2/deps/cares/src/ares_library_init.c000644 000766 000024 00000006654 13070706730 021452 0ustar00iojsstaff000000 000000 
/* Copyright 1998 by the Massachusetts Institute of Technology.
 * Copyright (C) 2004-2009 by Daniel Stenberg
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"

#include "ares.h"
#include "ares_library_init.h"
#include "ares_private.h"

/* library-private global and unique instance vars */

#ifdef USE_WINSOCK
fpGetNetworkParams_t ares_fpGetNetworkParams = ZERO_NULL;
fpSystemFunction036_t ares_fpSystemFunction036 = ZERO_NULL;
fpGetAdaptersAddresses_t ares_fpGetAdaptersAddresses = ZERO_NULL;
#endif

/* library-private global vars with source visibility restricted to this file */

static unsigned int ares_initialized;
static int          ares_init_flags;

#ifdef USE_WINSOCK
static HMODULE hnd_iphlpapi;
static HMODULE hnd_advapi32;
#endif


static int ares_win32_init(void)
{
#ifdef USE_WINSOCK

  hnd_iphlpapi = 0;
  hnd_iphlpapi = LoadLibraryW(L"iphlpapi.dll");
  if (!hnd_iphlpapi)
    return ARES_ELOADIPHLPAPI;

  ares_fpGetNetworkParams = (fpGetNetworkParams_t)
    GetProcAddress(hnd_iphlpapi, "GetNetworkParams");
  if (!ares_fpGetNetworkParams)
    {
      FreeLibrary(hnd_iphlpapi);
      return ARES_EADDRGETNETWORKPARAMS;
    }

  ares_fpGetAdaptersAddresses = (fpGetAdaptersAddresses_t)
    GetProcAddress(hnd_iphlpapi, "GetAdaptersAddresses");
  if (!ares_fpGetAdaptersAddresses)
    {
      /* This can happen on clients before WinXP, I don't
         think it should be an error, unless we don't want to
         support Windows 2000 anymore */
    }

  /*
   * When advapi32.dll is unavailable or advapi32.dll has no SystemFunction036,
   * also known as RtlGenRandom, which is the case for Windows versions prior
   * to WinXP then c-ares uses portable rand() function. Then don't error here.
   */

  hnd_advapi32 = 0;
  hnd_advapi32 = LoadLibraryW(L"advapi32.dll");
  if (hnd_advapi32)
    {
      ares_fpSystemFunction036 = (fpSystemFunction036_t)
        GetProcAddress(hnd_advapi32, "SystemFunction036");
    }

#endif
  return ARES_SUCCESS;
}


static void ares_win32_cleanup(void)
{
#ifdef USE_WINSOCK
  if (hnd_advapi32)
    FreeLibrary(hnd_advapi32);
  if (hnd_iphlpapi)
    FreeLibrary(hnd_iphlpapi);
#endif
}


int ares_library_init(int flags)
{
  int res;

  if (ares_initialized)
    {
      ares_initialized++;
      return ARES_SUCCESS;
    }
  ares_initialized++;

  if (flags & ARES_LIB_INIT_WIN32)
    {
      res = ares_win32_init();
      if (res != ARES_SUCCESS)
        return res;
    }

  ares_init_flags = flags;

  return ARES_SUCCESS;
}


void ares_library_cleanup(void)
{
  if (!ares_initialized)
    return;
  ares_initialized--;
  if (ares_initialized)
    return;

  if (ares_init_flags & ARES_LIB_INIT_WIN32)
    ares_win32_cleanup();

  ares_init_flags = ARES_LIB_INIT_NONE;
}


int ares_library_initialized(void)
{
#ifdef USE_WINSOCK
  if (!ares_initialized)
    return ARES_ENOTINITIALIZED;
#endif
  return ARES_SUCCESS;
}


node-v4.8.2/deps/cares/src/ares_library_init.h000644 000766 000024 00000003003 13070706730 021440 0ustar00iojsstaff000000 000000 #ifndef HEADER_CARES_LIBRARY_INIT_H
#define HEADER_CARES_LIBRARY_INIT_H


/* Copyright 1998 by the Massachusetts Institute of Technology.
 * Copyright (C) 2004-2011 by Daniel Stenberg
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"

#ifdef USE_WINSOCK

#include 
#include 

typedef DWORD (WINAPI *fpGetNetworkParams_t) (FIXED_INFO*, DWORD*);
typedef BOOLEAN (APIENTRY *fpSystemFunction036_t) (void*, ULONG);
typedef ULONG (WINAPI *fpGetAdaptersAddresses_t) ( ULONG, ULONG, void*, IP_ADAPTER_ADDRESSES*, ULONG* );

/* Forward-declaration of variables defined in ares_library_init.c */
/* that are global and unique instances for whole c-ares library.  */

extern fpGetNetworkParams_t ares_fpGetNetworkParams;
extern fpSystemFunction036_t ares_fpSystemFunction036;
extern fpGetAdaptersAddresses_t ares_fpGetAdaptersAddresses;

#endif /* USE_WINSOCK */

#endif /* HEADER_CARES_LIBRARY_INIT_H */

node-v4.8.2/deps/cares/src/ares_llist.c000644 000766 000024 00000003507 13070706730 020104 0ustar00iojsstaff000000 000000 
/* Copyright 1998 by the Massachusetts Institute of Technology.
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"

#include "ares.h"
#include "ares_private.h"

/* Routines for managing doubly-linked circular linked lists with a
 * dummy head.
 */

/* Initialize a new head node */
void ares__init_list_head(struct list_node* head) {
  head->prev = head;
  head->next = head;
  head->data = NULL;
}

/* Initialize a list node */
void ares__init_list_node(struct list_node* node, void* d) {
  node->prev = NULL;
  node->next = NULL;
  node->data = d;
}

/* Returns true iff the given list is empty */
int ares__is_list_empty(struct list_node* head) {
  return ((head->next == head) && (head->prev == head));
}

/* Inserts new_node before old_node */
void ares__insert_in_list(struct list_node* new_node,
                          struct list_node* old_node) {
  new_node->next = old_node;
  new_node->prev = old_node->prev;
  old_node->prev->next = new_node;
  old_node->prev = new_node;
}

/* Removes the node from the list it's in, if any */
void ares__remove_from_list(struct list_node* node) {
  if (node->next != NULL) {
    node->prev->next = node->next;
    node->next->prev = node->prev;
    node->prev = NULL;
    node->next = NULL;
  }
}

node-v4.8.2/deps/cares/src/ares_llist.h000644 000766 000024 00000002345 13070706730 020110 0ustar00iojsstaff000000 000000 #ifndef __ARES_LLIST_H
#define __ARES_LLIST_H


/* Copyright 1998 by the Massachusetts Institute of Technology.
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */


/* Node definition for circular, doubly-linked list */
struct list_node {
  struct list_node *prev;
  struct list_node *next;
  void* data;
};

void ares__init_list_head(struct list_node* head);

void ares__init_list_node(struct list_node* node, void* d);

int ares__is_list_empty(struct list_node* head);

void ares__insert_in_list(struct list_node* new_node,
                          struct list_node* old_node);

void ares__remove_from_list(struct list_node* node);

#endif /* __ARES_LLIST_H */
node-v4.8.2/deps/cares/src/ares_mkquery.c000644 000766 000024 00000001704 13070706730 020447 0ustar00iojsstaff000000 000000 
/* Copyright 1998 by the Massachusetts Institute of Technology.
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"
#include "ares.h"

int ares_mkquery(const char *name, int dnsclass, int type, unsigned short id,
                 int rd, unsigned char **buf, int *buflen)
{
  return ares_create_query(name, dnsclass, type, id, rd, buf, buflen, 0);
}
node-v4.8.2/deps/cares/src/ares_nowarn.c000644 000766 000024 00000014021 13070706730 020252 0ustar00iojsstaff000000 000000 
/* Copyright (C) 2010-2013 by Daniel Stenberg
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */


#include "ares_setup.h"

#ifdef HAVE_ASSERT_H
#  include 
#endif

#ifdef HAVE_LIMITS_H
#include 
#endif

#if defined(__INTEL_COMPILER) && defined(__unix__)

#ifdef HAVE_NETINET_IN_H
#  include 
#endif
#ifdef HAVE_ARPA_INET_H
#  include 
#endif

#endif /* __INTEL_COMPILER && __unix__ */

#define BUILDING_ARES_NOWARN_C 1

#include "ares_nowarn.h"

#if (SIZEOF_SHORT == 2)
#  define CARES_MASK_SSHORT  0x7FFF
#  define CARES_MASK_USHORT  0xFFFF
#elif (SIZEOF_SHORT == 4)
#  define CARES_MASK_SSHORT  0x7FFFFFFF
#  define CARES_MASK_USHORT  0xFFFFFFFF
#elif (SIZEOF_SHORT == 8)
#  define CARES_MASK_SSHORT  0x7FFFFFFFFFFFFFFF
#  define CARES_MASK_USHORT  0xFFFFFFFFFFFFFFFF
#else
#  error "SIZEOF_SHORT not defined"
#endif

#if (SIZEOF_INT == 2)
#  define CARES_MASK_SINT  0x7FFF
#  define CARES_MASK_UINT  0xFFFF
#elif (SIZEOF_INT == 4)
#  define CARES_MASK_SINT  0x7FFFFFFF
#  define CARES_MASK_UINT  0xFFFFFFFF
#elif (SIZEOF_INT == 8)
#  define CARES_MASK_SINT  0x7FFFFFFFFFFFFFFF
#  define CARES_MASK_UINT  0xFFFFFFFFFFFFFFFF
#elif (SIZEOF_INT == 16)
#  define CARES_MASK_SINT  0x7FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
#  define CARES_MASK_UINT  0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
#else
#  error "SIZEOF_INT not defined"
#endif

#ifndef HAVE_LIMITS_H
/* systems without  we guess have 32 bit longs */
#define CARES_MASK_SLONG  0x7FFFFFFFL
#define CARES_MASK_ULONG  0xFFFFFFFFUL
#else
#define CARES_MASK_ULONG  ULONG_MAX
#define CARES_MASK_SLONG  LONG_MAX
#endif

/*
** unsigned size_t to signed long
*/

long aresx_uztosl(size_t uznum)
{
#ifdef __INTEL_COMPILER
#  pragma warning(push)
#  pragma warning(disable:810) /* conversion may lose significant bits */
#endif

  return (long)(uznum & (size_t) CARES_MASK_SLONG);

#ifdef __INTEL_COMPILER
#  pragma warning(pop)
#endif
}

/*
** unsigned size_t to signed int
*/

int aresx_uztosi(size_t uznum)
{
#ifdef __INTEL_COMPILER
#  pragma warning(push)
#  pragma warning(disable:810) /* conversion may lose significant bits */
#endif

  return (int)(uznum & (size_t) CARES_MASK_SINT);

#ifdef __INTEL_COMPILER
#  pragma warning(pop)
#endif
}

/*
** unsigned size_t to signed short
*/

short aresx_uztoss(size_t uznum)
{
#ifdef __INTEL_COMPILER
#  pragma warning(push)
#  pragma warning(disable:810) /* conversion may lose significant bits */
#endif

  return (short)(uznum & (size_t) CARES_MASK_SSHORT);

#ifdef __INTEL_COMPILER
#  pragma warning(pop)
#endif
}

/*
** signed int to signed short
*/

short aresx_sitoss(int sinum)
{
#ifdef __INTEL_COMPILER
#  pragma warning(push)
#  pragma warning(disable:810) /* conversion may lose significant bits */
#endif

  DEBUGASSERT(sinum >= 0);
  return (short)(sinum & (int) CARES_MASK_SSHORT);

#ifdef __INTEL_COMPILER
#  pragma warning(pop)
#endif
}

/*
** signed long to signed int
*/

int aresx_sltosi(long slnum)
{
#ifdef __INTEL_COMPILER
#  pragma warning(push)
#  pragma warning(disable:810) /* conversion may lose significant bits */
#endif

  DEBUGASSERT(slnum >= 0);
  return (int)(slnum & (long) CARES_MASK_SINT);

#ifdef __INTEL_COMPILER
#  pragma warning(pop)
#endif
}

/*
** signed ssize_t to signed int
*/

int aresx_sztosi(ssize_t sznum)
{
#ifdef __INTEL_COMPILER
#  pragma warning(push)
#  pragma warning(disable:810) /* conversion may lose significant bits */
#endif

  DEBUGASSERT(sznum >= 0);
  return (int)(sznum & (ssize_t) CARES_MASK_SINT);

#ifdef __INTEL_COMPILER
#  pragma warning(pop)
#endif
}

/*
** signed ssize_t to unsigned int
*/

unsigned int aresx_sztoui(ssize_t sznum)
{
#ifdef __INTEL_COMPILER
#  pragma warning(push)
#  pragma warning(disable:810) /* conversion may lose significant bits */
#endif

  DEBUGASSERT(sznum >= 0);
  return (unsigned int)(sznum & (ssize_t) CARES_MASK_UINT);

#ifdef __INTEL_COMPILER
#  pragma warning(pop)
#endif
}

/*
** signed int to unsigned short
*/

unsigned short aresx_sitous(int sinum)
{
#ifdef __INTEL_COMPILER
#  pragma warning(push)
#  pragma warning(disable:810) /* conversion may lose significant bits */
#endif

  DEBUGASSERT(sinum >= 0);
  return (unsigned short)(sinum & (int) CARES_MASK_USHORT);

#ifdef __INTEL_COMPILER
#  pragma warning(pop)
#endif
}

#if defined(__INTEL_COMPILER) && defined(__unix__)

int aresx_FD_ISSET(int fd, fd_set *fdset)
{
  #pragma warning(push)
  #pragma warning(disable:1469) /* clobber ignored */
  return FD_ISSET(fd, fdset);
  #pragma warning(pop)
}

void aresx_FD_SET(int fd, fd_set *fdset)
{
  #pragma warning(push)
  #pragma warning(disable:1469) /* clobber ignored */
  FD_SET(fd, fdset);
  #pragma warning(pop)
}

void aresx_FD_ZERO(fd_set *fdset)
{
  #pragma warning(push)
  #pragma warning(disable:593) /* variable was set but never used */
  FD_ZERO(fdset);
  #pragma warning(pop)
}

unsigned short aresx_htons(unsigned short usnum)
{
#if (__INTEL_COMPILER == 910) && defined(__i386__)
  return (unsigned short)(((usnum << 8) & 0xFF00) | ((usnum >> 8) & 0x00FF));
#else
  #pragma warning(push)
  #pragma warning(disable:810) /* conversion may lose significant bits */
  return htons(usnum);
  #pragma warning(pop)
#endif
}

unsigned short aresx_ntohs(unsigned short usnum)
{
#if (__INTEL_COMPILER == 910) && defined(__i386__)
  return (unsigned short)(((usnum << 8) & 0xFF00) | ((usnum >> 8) & 0x00FF));
#else
  #pragma warning(push)
  #pragma warning(disable:810) /* conversion may lose significant bits */
  return ntohs(usnum);
  #pragma warning(pop)
#endif
}

#endif /* __INTEL_COMPILER && __unix__ */
node-v4.8.2/deps/cares/src/ares_nowarn.h000644 000766 000024 00000003304 13070706730 020261 0ustar00iojsstaff000000 000000 #ifndef HEADER_CARES_NOWARN_H
#define HEADER_CARES_NOWARN_H


/* Copyright (C) 2010-2012 by Daniel Stenberg
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

long  aresx_uztosl(size_t uznum);
int   aresx_uztosi(size_t uznum);
short aresx_uztoss(size_t uznum);

short aresx_sitoss(int sinum);

int aresx_sltosi(long slnum);

int aresx_sztosi(ssize_t sznum);

unsigned int aresx_sztoui(ssize_t sznum);

unsigned short aresx_sitous(int sinum);

#if defined(__INTEL_COMPILER) && defined(__unix__)

int aresx_FD_ISSET(int fd, fd_set *fdset);

void aresx_FD_SET(int fd, fd_set *fdset);

void aresx_FD_ZERO(fd_set *fdset);

unsigned short aresx_htons(unsigned short usnum);

unsigned short aresx_ntohs(unsigned short usnum);

#ifndef BUILDING_ARES_NOWARN_C
#  undef  FD_ISSET
#  define FD_ISSET(a,b) aresx_FD_ISSET((a),(b))
#  undef  FD_SET
#  define FD_SET(a,b)   aresx_FD_SET((a),(b))
#  undef  FD_ZERO
#  define FD_ZERO(a)    aresx_FD_ZERO((a))
#  undef  htons
#  define htons(a)      aresx_htons((a))
#  undef  ntohs
#  define ntohs(a)      aresx_ntohs((a))
#endif

#endif /* __INTEL_COMPILER && __unix__ */

#endif /* HEADER_CARES_NOWARN_H */
node-v4.8.2/deps/cares/src/ares_options.c000644 000766 000024 00000016623 13070706730 020453 0ustar00iojsstaff000000 000000 
/* Copyright 1998 by the Massachusetts Institute of Technology.
 * Copyright (C) 2008-2013 by Daniel Stenberg
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */


#include "ares_setup.h"

#ifdef HAVE_ARPA_INET_H
#  include 
#endif

#include "ares.h"
#include "ares_data.h"
#include "ares_inet_net_pton.h"
#include "ares_private.h"


int ares_get_servers(ares_channel channel,
                     struct ares_addr_node **servers)
{
  struct ares_addr_node *srvr_head = NULL;
  struct ares_addr_node *srvr_last = NULL;
  struct ares_addr_node *srvr_curr;
  int status = ARES_SUCCESS;
  int i;

  if (!channel)
    return ARES_ENODATA;

  for (i = 0; i < channel->nservers; i++)
    {
      /* Allocate storage for this server node appending it to the list */
      srvr_curr = ares_malloc_data(ARES_DATATYPE_ADDR_NODE);
      if (!srvr_curr)
        {
          status = ARES_ENOMEM;
          break;
        }
      if (srvr_last)
        {
          srvr_last->next = srvr_curr;
        }
      else
        {
          srvr_head = srvr_curr;
        }
      srvr_last = srvr_curr;

      /* Fill this server node data */
      srvr_curr->family = channel->servers[i].addr.family;
      if (srvr_curr->family == AF_INET)
        memcpy(&srvr_curr->addrV4, &channel->servers[i].addr.addrV4,
               sizeof(srvr_curr->addrV4));
      else
        memcpy(&srvr_curr->addrV6, &channel->servers[i].addr.addrV6,
               sizeof(srvr_curr->addrV6));
    }

  if (status != ARES_SUCCESS)
    {
      if (srvr_head)
        {
          ares_free_data(srvr_head);
          srvr_head = NULL;
        }
    }

  *servers = srvr_head;

  return status;
}


int ares_set_servers(ares_channel channel,
                     struct ares_addr_node *servers)
{
  struct ares_addr_node *srvr;
  int num_srvrs = 0;
  int i;

  if (ares_library_initialized() != ARES_SUCCESS)
    return ARES_ENOTINITIALIZED;

  if (!channel)
    return ARES_ENODATA;

  ares__destroy_servers_state(channel);

  for (srvr = servers; srvr; srvr = srvr->next)
    {
      num_srvrs++;
    }

  if (num_srvrs > 0)
    {
      /* Allocate storage for servers state */
      channel->servers = malloc(num_srvrs * sizeof(struct server_state));
      if (!channel->servers)
        {
          return ARES_ENOMEM;
        }
      channel->nservers = num_srvrs;
      /* Fill servers state address data */
      for (i = 0, srvr = servers; srvr; i++, srvr = srvr->next)
        {
          channel->servers[i].addr.family = srvr->family;
          if (srvr->family == AF_INET)
            memcpy(&channel->servers[i].addr.addrV4, &srvr->addrV4,
                   sizeof(srvr->addrV4));
          else
            memcpy(&channel->servers[i].addr.addrV6, &srvr->addrV6,
                   sizeof(srvr->addrV6));
        }
      /* Initialize servers state remaining data */
      ares__init_servers_state(channel);
    }

  return ARES_SUCCESS;
}

/* Incomming string format: host[:port][,host[:port]]... */
/* IPv6 addresses with ports require square brackets [fe80::1%lo0]:53 */
int ares_set_servers_csv(ares_channel channel,
                         const char* _csv)
{
  size_t i;
  char* csv = NULL;
  char* ptr;
  char* start_host;
  int cc = 0;
  int rv = ARES_SUCCESS;
  struct ares_addr_node *servers = NULL;
  struct ares_addr_node *last = NULL;

  if (ares_library_initialized() != ARES_SUCCESS)
    return ARES_ENOTINITIALIZED;

  if (!channel)
    return ARES_ENODATA;

  ares__destroy_servers_state(channel);

  i = strlen(_csv);
  if (i == 0)
     return ARES_SUCCESS; /* blank all servers */

  csv = malloc(i + 2);
  if (!csv)
    return ARES_ENOMEM;

  strcpy(csv, _csv);
  if (csv[i-1] != ',') { /* make parsing easier by ensuring ending ',' */
    csv[i] = ',';
    csv[i+1] = 0;
  }

  start_host = csv;
  for (ptr = csv; *ptr; ptr++) {
    if (*ptr == ':') {
      /* count colons to determine if we have an IPv6 number or IPv4 with
         port */
      cc++;
    }
    else if (*ptr == '[') {
      /* move start_host if an open square bracket is found wrapping an IPv6
         address */
      start_host = ptr + 1;
    }
    else if (*ptr == ',') {
      char* pp = ptr - 1;
      char* p = ptr;
      struct in_addr in4;
      struct ares_in6_addr in6;
      struct ares_addr_node *s = NULL;

      *ptr = 0; /* null terminate host:port string */
      /* Got an entry..see if the port was specified. */
      if (cc > 0) {
        while (pp > start_host) {
          /* a single close square bracket followed by a colon, ']:' indicates
             an IPv6 address with port */
          if ((*pp == ']') && (*p == ':'))
            break; /* found port */
          /* a single colon, ':' indicates an IPv4 address with port */
          if ((*pp == ':') && (cc == 1))
            break; /* found port */
          if (!(ISDIGIT(*pp) || (*pp == ':'))) {
            /* Found end of digits before we found :, so wasn't a port */
            /* must allow ':' for IPv6 case of ']:' indicates we found a port */
            pp = p = ptr;
            break;
          }
          pp--;
          p--;
        }
        if ((pp != start_host) && ((pp + 1) < ptr)) {
          /* Found it. Parse over the port number */
          /* when an IPv6 address is wrapped with square brackets the port
             starts at pp + 2 */
          if (*pp == ']')
            p++; /* move p before ':' */
          /* p will point to the start of the port */
          (void)strtol(p, NULL, 10);
          *pp = 0; /* null terminate host */
        }
      }
      /* resolve host, try ipv4 first, rslt is in network byte order */
      rv = ares_inet_pton(AF_INET, start_host, &in4);
      if (!rv) {
        /* Ok, try IPv6 then */
        rv = ares_inet_pton(AF_INET6, start_host, &in6);
        if (!rv) {
          rv = ARES_EBADSTR;
          goto out;
        }
        /* was ipv6, add new server */
        s = malloc(sizeof(*s));
        if (!s) {
          rv = ARES_ENOMEM;
          goto out;
        }
        s->family = AF_INET6;
        memcpy(&s->addr, &in6, sizeof(struct ares_in6_addr));
      }
      else {
        /* was ipv4, add new server */
        s = malloc(sizeof(*s));
        if (!s) {
          rv = ARES_ENOMEM;
          goto out;
        }
        s->family = AF_INET;
        memcpy(&s->addr, &in4, sizeof(struct in_addr));
      }
      if (s) {
        /* TODO:  Add port to ares_addr_node and assign it here. */

        s->next = NULL;
        if (last) {
          last->next = s;
          /* need to move last to maintain the linked list */
          last = last->next;
        }
        else {
          servers = s;
          last = s;
        }
      }

      /* Set up for next one */
      start_host = ptr + 1;
      cc = 0;
    }
  }

  rv = ares_set_servers(channel, servers);

  out:
  if (csv)
    free(csv);
  while (servers) {
    struct ares_addr_node *s = servers;
    servers = servers->next;
    free(s);
  }

  return rv;
}
node-v4.8.2/deps/cares/src/ares_parse_a_reply.c000644 000766 000024 00000016536 13070706730 021610 0ustar00iojsstaff000000 000000 
/* Copyright 1998 by the Massachusetts Institute of Technology.
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"

#ifdef HAVE_NETINET_IN_H
#  include 
#endif
#ifdef HAVE_NETDB_H
#  include 
#endif
#ifdef HAVE_ARPA_INET_H
#  include 
#endif
#ifdef HAVE_ARPA_NAMESER_H
#  include 
#else
#  include "nameser.h"
#endif
#ifdef HAVE_ARPA_NAMESER_COMPAT_H
#  include 
#endif

#ifdef HAVE_STRINGS_H
#  include 
#endif

#ifdef HAVE_LIMITS_H
#  include 
#endif

#include "ares.h"
#include "ares_dns.h"
#include "ares_private.h"

int ares_parse_a_reply(const unsigned char *abuf, int alen,
                       struct hostent **host,
                       struct ares_addrttl *addrttls, int *naddrttls)
{
  unsigned int qdcount, ancount;
  int status, i, rr_type, rr_class, rr_len, rr_ttl, naddrs;
  int cname_ttl = INT_MAX;  /* the TTL imposed by the CNAME chain */
  int naliases;
  long len;
  const unsigned char *aptr;
  char *hostname, *rr_name, *rr_data, **aliases;
  struct in_addr *addrs;
  struct hostent *hostent;
  const int max_addr_ttls = (addrttls && naddrttls) ? *naddrttls : 0;

  /* Set *host to NULL for all failure cases. */
  if (host)
    *host = NULL;
  /* Same with *naddrttls. */
  if (naddrttls)
    *naddrttls = 0;

  /* Give up if abuf doesn't have room for a header. */
  if (alen < HFIXEDSZ)
    return ARES_EBADRESP;

  /* Fetch the question and answer count from the header. */
  qdcount = DNS_HEADER_QDCOUNT(abuf);
  ancount = DNS_HEADER_ANCOUNT(abuf);
  if (qdcount != 1)
    return ARES_EBADRESP;

  /* Expand the name from the question, and skip past the question. */
  aptr = abuf + HFIXEDSZ;
  status = ares__expand_name_for_response(aptr, abuf, alen, &hostname, &len);
  if (status != ARES_SUCCESS)
    return status;
  if (aptr + len + QFIXEDSZ > abuf + alen)
    {
      free(hostname);
      return ARES_EBADRESP;
    }
  aptr += len + QFIXEDSZ;

  if (host)
    {
      /* Allocate addresses and aliases; ancount gives an upper bound for
         both. */
      addrs = malloc(ancount * sizeof(struct in_addr));
      if (!addrs)
        {
          free(hostname);
          return ARES_ENOMEM;
        }
      aliases = malloc((ancount + 1) * sizeof(char *));
      if (!aliases)
        {
          free(hostname);
          free(addrs);
          return ARES_ENOMEM;
        }
    }
  else
    {
      addrs = NULL;
      aliases = NULL;
    }

  naddrs = 0;
  naliases = 0;

  /* Examine each answer resource record (RR) in turn. */
  for (i = 0; i < (int)ancount; i++)
    {
      /* Decode the RR up to the data field. */
      status = ares__expand_name_for_response(aptr, abuf, alen, &rr_name, &len);
      if (status != ARES_SUCCESS)
        break;
      aptr += len;
      if (aptr + RRFIXEDSZ > abuf + alen)
        {
          free(rr_name);
          status = ARES_EBADRESP;
          break;
        }
      rr_type = DNS_RR_TYPE(aptr);
      rr_class = DNS_RR_CLASS(aptr);
      rr_len = DNS_RR_LEN(aptr);
      rr_ttl = DNS_RR_TTL(aptr);
      aptr += RRFIXEDSZ;
      if (aptr + rr_len > abuf + alen)
        {
          free(rr_name);
          status = ARES_EBADRESP;
          break;
        }

      if (rr_class == C_IN && rr_type == T_A
          && rr_len == sizeof(struct in_addr)
          && strcasecmp(rr_name, hostname) == 0)
        {
          if (addrs)
            {
              if (aptr + sizeof(struct in_addr) > abuf + alen)
              {
                free(rr_name);
                status = ARES_EBADRESP;
                break;
              }
              memcpy(&addrs[naddrs], aptr, sizeof(struct in_addr));
            }
          if (naddrs < max_addr_ttls)
            {
              struct ares_addrttl * const at = &addrttls[naddrs];
              if (aptr + sizeof(struct in_addr) > abuf + alen)
              {
                free(rr_name);
                status = ARES_EBADRESP;
                break;
              }
              memcpy(&at->ipaddr, aptr,  sizeof(struct in_addr));
              at->ttl = rr_ttl;
            }
          naddrs++;
          status = ARES_SUCCESS;
        }

      if (rr_class == C_IN && rr_type == T_CNAME)
        {
          /* Record the RR name as an alias. */
          if (aliases)
            aliases[naliases] = rr_name;
          else
            free(rr_name);
          naliases++;

          /* Decode the RR data and replace the hostname with it. */
          status = ares__expand_name_for_response(aptr, abuf, alen, &rr_data,
                                                  &len);
          if (status != ARES_SUCCESS)
            break;
          free(hostname);
          hostname = rr_data;

          /* Take the min of the TTLs we see in the CNAME chain. */
          if (cname_ttl > rr_ttl)
            cname_ttl = rr_ttl;
        }
      else
        free(rr_name);

      aptr += rr_len;
      if (aptr > abuf + alen)
        {
          status = ARES_EBADRESP;
          break;
        }
    }

  if (status == ARES_SUCCESS && naddrs == 0 && naliases == 0)
    /* the check for naliases to be zero is to make sure CNAME responses
       don't get caught here */
    status = ARES_ENODATA;
  if (status == ARES_SUCCESS)
    {
      /* We got our answer. */
      if (naddrttls)
        {
          const int n = naddrs < max_addr_ttls ? naddrs : max_addr_ttls;
          for (i = 0; i < n; i++)
            {
              /* Ensure that each A TTL is no larger than the CNAME TTL. */
              if (addrttls[i].ttl > cname_ttl)
                addrttls[i].ttl = cname_ttl;
            }
          *naddrttls = n;
        }
      if (aliases)
        aliases[naliases] = NULL;
      if (host)
        {
          /* Allocate memory to build the host entry. */
          hostent = malloc(sizeof(struct hostent));
          if (hostent)
            {
              hostent->h_addr_list = malloc((naddrs + 1) * sizeof(char *));
              if (hostent->h_addr_list)
                {
                  /* Fill in the hostent and return successfully. */
                  hostent->h_name = hostname;
                  hostent->h_aliases = aliases;
                  hostent->h_addrtype = AF_INET;
                  hostent->h_length = sizeof(struct in_addr);
                  for (i = 0; i < naddrs; i++)
                    hostent->h_addr_list[i] = (char *) &addrs[i];
                  hostent->h_addr_list[naddrs] = NULL;
                  if (!naddrs && addrs)
                    free(addrs);
                  *host = hostent;
                  return ARES_SUCCESS;
                }
              free(hostent);
            }
          status = ARES_ENOMEM;
        }
     }
  if (aliases)
    {
      for (i = 0; i < naliases; i++)
        free(aliases[i]);
      free(aliases);
    }
  free(addrs);
  free(hostname);
  return status;
}
node-v4.8.2/deps/cares/src/ares_parse_aaaa_reply.c000644 000766 000024 00000016715 13070706730 022252 0ustar00iojsstaff000000 000000 
/* Copyright 1998 by the Massachusetts Institute of Technology.
 * Copyright 2005 Dominick Meglio
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"

#ifdef HAVE_NETINET_IN_H
#  include 
#endif
#ifdef HAVE_NETDB_H
#  include 
#endif
#ifdef HAVE_ARPA_INET_H
#  include 
#endif
#ifdef HAVE_ARPA_NAMESER_H
#  include 
#else
#  include "nameser.h"
#endif
#ifdef HAVE_ARPA_NAMESER_COMPAT_H
#  include 
#endif

#ifdef HAVE_STRINGS_H
#  include 
#endif

#ifdef HAVE_LIMITS_H
#  include 
#endif

#include "ares.h"
#include "ares_dns.h"
#include "ares_inet_net_pton.h"
#include "ares_private.h"

int ares_parse_aaaa_reply(const unsigned char *abuf, int alen,
                          struct hostent **host, struct ares_addr6ttl *addrttls,
                          int *naddrttls)
{
  unsigned int qdcount, ancount;
  int status, i, rr_type, rr_class, rr_len, rr_ttl, naddrs;
  int cname_ttl = INT_MAX;  /* the TTL imposed by the CNAME chain */
  int naliases;
  long len;
  const unsigned char *aptr;
  char *hostname, *rr_name, *rr_data, **aliases;
  struct ares_in6_addr *addrs;
  struct hostent *hostent;
  const int max_addr_ttls = (addrttls && naddrttls) ? *naddrttls : 0;

  /* Set *host to NULL for all failure cases. */
  if (host)
    *host = NULL;
  /* Same with *naddrttls. */
  if (naddrttls)
    *naddrttls = 0;

  /* Give up if abuf doesn't have room for a header. */
  if (alen < HFIXEDSZ)
    return ARES_EBADRESP;

  /* Fetch the question and answer count from the header. */
  qdcount = DNS_HEADER_QDCOUNT(abuf);
  ancount = DNS_HEADER_ANCOUNT(abuf);
  if (qdcount != 1)
    return ARES_EBADRESP;

  /* Expand the name from the question, and skip past the question. */
  aptr = abuf + HFIXEDSZ;
  status = ares__expand_name_for_response(aptr, abuf, alen, &hostname, &len);
  if (status != ARES_SUCCESS)
    return status;
  if (aptr + len + QFIXEDSZ > abuf + alen)
    {
      free(hostname);
      return ARES_EBADRESP;
    }
  aptr += len + QFIXEDSZ;

  /* Allocate addresses and aliases; ancount gives an upper bound for both. */
  if (host)
    {
      addrs = malloc(ancount * sizeof(struct ares_in6_addr));
      if (!addrs)
        {
          free(hostname);
          return ARES_ENOMEM;
        }
      aliases = malloc((ancount + 1) * sizeof(char *));
      if (!aliases)
        {
          free(hostname);
          free(addrs);
          return ARES_ENOMEM;
        }
    }
  else
    {
      addrs = NULL;
      aliases = NULL;
    }
  naddrs = 0;
  naliases = 0;

  /* Examine each answer resource record (RR) in turn. */
  for (i = 0; i < (int)ancount; i++)
    {
      /* Decode the RR up to the data field. */
      status = ares__expand_name_for_response(aptr, abuf, alen, &rr_name, &len);
      if (status != ARES_SUCCESS)
        break;
      aptr += len;
      if (aptr + RRFIXEDSZ > abuf + alen)
        {
          free(rr_name);
          status = ARES_EBADRESP;
          break;
        }
      rr_type = DNS_RR_TYPE(aptr);
      rr_class = DNS_RR_CLASS(aptr);
      rr_len = DNS_RR_LEN(aptr);
      rr_ttl = DNS_RR_TTL(aptr);
      aptr += RRFIXEDSZ;
      if (aptr + rr_len > abuf + alen)
        {
          free(rr_name);
          status = ARES_EBADRESP;
          break;
        }

      if (rr_class == C_IN && rr_type == T_AAAA
          && rr_len == sizeof(struct ares_in6_addr)
          && strcasecmp(rr_name, hostname) == 0)
        {
          if (addrs)
            {
              if (aptr + sizeof(struct ares_in6_addr) > abuf + alen)
              {
                free(rr_name);
                status = ARES_EBADRESP;
                break;
              }
              memcpy(&addrs[naddrs], aptr, sizeof(struct ares_in6_addr));
            }
          if (naddrs < max_addr_ttls)
            {
              struct ares_addr6ttl * const at = &addrttls[naddrs];
              if (aptr + sizeof(struct ares_in6_addr) > abuf + alen)
              {
                free(rr_name);
                status = ARES_EBADRESP;
                break;
              }
              memcpy(&at->ip6addr, aptr,  sizeof(struct ares_in6_addr));
              at->ttl = rr_ttl;
            }
          naddrs++;
          status = ARES_SUCCESS;
        }

      if (rr_class == C_IN && rr_type == T_CNAME)
        {
          /* Record the RR name as an alias. */
          if (aliases)
            aliases[naliases] = rr_name;
          else
            free(rr_name);
          naliases++;

          /* Decode the RR data and replace the hostname with it. */
          status = ares__expand_name_for_response(aptr, abuf, alen, &rr_data,
                                                  &len);
          if (status != ARES_SUCCESS)
            break;
          free(hostname);
          hostname = rr_data;

          /* Take the min of the TTLs we see in the CNAME chain. */
          if (cname_ttl > rr_ttl)
            cname_ttl = rr_ttl;
        }
      else
        free(rr_name);

      aptr += rr_len;
      if (aptr > abuf + alen)
        {
          status = ARES_EBADRESP;
          break;
        }
    }

  /* the check for naliases to be zero is to make sure CNAME responses
     don't get caught here */
  if (status == ARES_SUCCESS && naddrs == 0 && naliases == 0)
    status = ARES_ENODATA;
  if (status == ARES_SUCCESS)
    {
      /* We got our answer. */
      if (naddrttls)
        {
          const int n = naddrs < max_addr_ttls ? naddrs : max_addr_ttls;
          for (i = 0; i < n; i++)
            {
              /* Ensure that each A TTL is no larger than the CNAME TTL. */
              if (addrttls[i].ttl > cname_ttl)
                addrttls[i].ttl = cname_ttl;
            }
          *naddrttls = n;
        }
      if (aliases)
        aliases[naliases] = NULL;
      if (host)
        {
          /* Allocate memory to build the host entry. */
          hostent = malloc(sizeof(struct hostent));
          if (hostent)
            {
              hostent->h_addr_list = malloc((naddrs + 1) * sizeof(char *));
              if (hostent->h_addr_list)
                {
                  /* Fill in the hostent and return successfully. */
                  hostent->h_name = hostname;
                  hostent->h_aliases = aliases;
                  hostent->h_addrtype = AF_INET6;
                  hostent->h_length = sizeof(struct ares_in6_addr);
                  for (i = 0; i < naddrs; i++)
                    hostent->h_addr_list[i] = (char *) &addrs[i];
                  hostent->h_addr_list[naddrs] = NULL;
                  if (!naddrs && addrs)
                    free(addrs);
                  *host = hostent;
                  return ARES_SUCCESS;
                }
              free(hostent);
            }
          status = ARES_ENOMEM;
        }
    }
  if (aliases)
    {
      for (i = 0; i < naliases; i++)
        free(aliases[i]);
      free(aliases);
    }
  free(addrs);
  free(hostname);
  return status;
}
node-v4.8.2/deps/cares/src/ares_parse_mx_reply.c000644 000766 000024 00000010557 13070706730 022011 0ustar00iojsstaff000000 000000 
/* Copyright 1998 by the Massachusetts Institute of Technology.
 * Copyright (C) 2010 Jeremy Lal 
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"

#ifdef HAVE_NETINET_IN_H
#  include 
#endif
#ifdef HAVE_NETDB_H
#  include 
#endif
#ifdef HAVE_ARPA_INET_H
#  include 
#endif
#ifdef HAVE_ARPA_NAMESER_H
#  include 
#else
#  include "nameser.h"
#endif
#ifdef HAVE_ARPA_NAMESER_COMPAT_H
#  include 
#endif

#include "ares.h"
#include "ares_dns.h"
#include "ares_data.h"
#include "ares_private.h"

int
ares_parse_mx_reply (const unsigned char *abuf, int alen,
                     struct ares_mx_reply **mx_out)
{
  unsigned int qdcount, ancount, i;
  const unsigned char *aptr, *vptr;
  int status, rr_type, rr_class, rr_len;
  long len;
  char *hostname = NULL, *rr_name = NULL;
  struct ares_mx_reply *mx_head = NULL;
  struct ares_mx_reply *mx_last = NULL;
  struct ares_mx_reply *mx_curr;

  /* Set *mx_out to NULL for all failure cases. */
  *mx_out = NULL;

  /* Give up if abuf doesn't have room for a header. */
  if (alen < HFIXEDSZ)
    return ARES_EBADRESP;

  /* Fetch the question and answer count from the header. */
  qdcount = DNS_HEADER_QDCOUNT (abuf);
  ancount = DNS_HEADER_ANCOUNT (abuf);
  if (qdcount != 1)
    return ARES_EBADRESP;
  if (ancount == 0)
    return ARES_ENODATA;

  /* Expand the name from the question, and skip past the question. */
  aptr = abuf + HFIXEDSZ;
  status = ares_expand_name (aptr, abuf, alen, &hostname, &len);
  if (status != ARES_SUCCESS)
    return status;

  if (aptr + len + QFIXEDSZ > abuf + alen)
    {
      free (hostname);
      return ARES_EBADRESP;
    }
  aptr += len + QFIXEDSZ;

  /* Examine each answer resource record (RR) in turn. */
  for (i = 0; i < ancount; i++)
    {
      /* Decode the RR up to the data field. */
      status = ares_expand_name (aptr, abuf, alen, &rr_name, &len);
      if (status != ARES_SUCCESS)
        {
          break;
        }
      aptr += len;
      if (aptr + RRFIXEDSZ > abuf + alen)
        {
          status = ARES_EBADRESP;
          break;
        }
      rr_type = DNS_RR_TYPE (aptr);
      rr_class = DNS_RR_CLASS (aptr);
      rr_len = DNS_RR_LEN (aptr);
      aptr += RRFIXEDSZ;
      if (aptr + rr_len > abuf + alen)
        {
          status = ARES_EBADRESP;
          break;
        }

      /* Check if we are really looking at a MX record */
      if (rr_class == C_IN && rr_type == T_MX)
        {
          /* parse the MX record itself */
          if (rr_len < 2)
            {
              status = ARES_EBADRESP;
              break;
            }

          /* Allocate storage for this MX answer appending it to the list */
          mx_curr = ares_malloc_data(ARES_DATATYPE_MX_REPLY);
          if (!mx_curr)
            {
              status = ARES_ENOMEM;
              break;
            }
          if (mx_last)
            {
              mx_last->next = mx_curr;
            }
          else
            {
              mx_head = mx_curr;
            }
          mx_last = mx_curr;

          vptr = aptr;
          mx_curr->priority = DNS__16BIT(vptr);
          vptr += sizeof(unsigned short);

          status = ares_expand_name (vptr, abuf, alen, &mx_curr->host, &len);
          if (status != ARES_SUCCESS)
            break;
        }

      /* Don't lose memory in the next iteration */
      free (rr_name);
      rr_name = NULL;

      /* Move on to the next record */
      aptr += rr_len;
    }

  if (hostname)
    free (hostname);
  if (rr_name)
    free (rr_name);

  /* clean up on error */
  if (status != ARES_SUCCESS)
    {
      if (mx_head)
        ares_free_data (mx_head);
      return status;
    }

  /* everything looks fine, return the data */
  *mx_out = mx_head;

  return ARES_SUCCESS;
}
node-v4.8.2/deps/cares/src/ares_parse_naptr_reply.c000644 000766 000024 00000012035 13070706730 022502 0ustar00iojsstaff000000 000000 
/* Copyright 1998 by the Massachusetts Institute of Technology.
 * Copyright (C) 2009 by Jakub Hrozek 
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"

#ifdef HAVE_NETINET_IN_H
#  include 
#endif
#ifdef HAVE_NETDB_H
#  include 
#endif
#ifdef HAVE_ARPA_INET_H
#  include 
#endif
#ifdef HAVE_ARPA_NAMESER_H
#  include 
#else
#  include "nameser.h"
#endif
#ifdef HAVE_ARPA_NAMESER_COMPAT_H
#  include 
#endif

#include "ares.h"
#include "ares_dns.h"
#include "ares_data.h"
#include "ares_private.h"

/* AIX portability check */
#ifndef T_NAPTR
	#define T_NAPTR 35 /* naming authority pointer */
#endif

int
ares_parse_naptr_reply (const unsigned char *abuf, int alen,
                        struct ares_naptr_reply **naptr_out)
{
  unsigned int qdcount, ancount, i;
  const unsigned char *aptr, *vptr;
  int status, rr_type, rr_class, rr_len;
  long len;
  char *hostname = NULL, *rr_name = NULL;
  struct ares_naptr_reply *naptr_head = NULL;
  struct ares_naptr_reply *naptr_last = NULL;
  struct ares_naptr_reply *naptr_curr;

  /* Set *naptr_out to NULL for all failure cases. */
  *naptr_out = NULL;

  /* Give up if abuf doesn't have room for a header. */
  if (alen < HFIXEDSZ)
    return ARES_EBADRESP;

  /* Fetch the question and answer count from the header. */
  qdcount = DNS_HEADER_QDCOUNT (abuf);
  ancount = DNS_HEADER_ANCOUNT (abuf);
  if (qdcount != 1)
    return ARES_EBADRESP;
  if (ancount == 0)
    return ARES_ENODATA;

  /* Expand the name from the question, and skip past the question. */
  aptr = abuf + HFIXEDSZ;
  status = ares_expand_name (aptr, abuf, alen, &hostname, &len);
  if (status != ARES_SUCCESS)
    return status;

  if (aptr + len + QFIXEDSZ > abuf + alen)
    {
      free (hostname);
      return ARES_EBADRESP;
    }
  aptr += len + QFIXEDSZ;

  /* Examine each answer resource record (RR) in turn. */
  for (i = 0; i < ancount; i++)
    {
      /* Decode the RR up to the data field. */
      status = ares_expand_name (aptr, abuf, alen, &rr_name, &len);
      if (status != ARES_SUCCESS)
        {
          break;
        }
      aptr += len;
      if (aptr + RRFIXEDSZ > abuf + alen)
        {
          status = ARES_EBADRESP;
          break;
        }
      rr_type = DNS_RR_TYPE (aptr);
      rr_class = DNS_RR_CLASS (aptr);
      rr_len = DNS_RR_LEN (aptr);
      aptr += RRFIXEDSZ;
      if (aptr + rr_len > abuf + alen)
        {
          status = ARES_EBADRESP;
          break;
        }

      /* Check if we are really looking at a NAPTR record */
      if (rr_class == C_IN && rr_type == T_NAPTR)
        {
          /* parse the NAPTR record itself */

          /* Allocate storage for this NAPTR answer appending it to the list */
          naptr_curr = ares_malloc_data(ARES_DATATYPE_NAPTR_REPLY);
          if (!naptr_curr)
            {
              status = ARES_ENOMEM;
              break;
            }
          if (naptr_last)
            {
              naptr_last->next = naptr_curr;
            }
          else
            {
              naptr_head = naptr_curr;
            }
          naptr_last = naptr_curr;

          vptr = aptr;
          naptr_curr->order = DNS__16BIT(vptr);
          vptr += sizeof(unsigned short);
          naptr_curr->preference = DNS__16BIT(vptr);
          vptr += sizeof(unsigned short);

          status = ares_expand_string(vptr, abuf, alen, &naptr_curr->flags, &len);
          if (status != ARES_SUCCESS)
            break;
          vptr += len;

          status = ares_expand_string(vptr, abuf, alen, &naptr_curr->service, &len);
          if (status != ARES_SUCCESS)
            break;
          vptr += len;

          status = ares_expand_string(vptr, abuf, alen, &naptr_curr->regexp, &len);
          if (status != ARES_SUCCESS)
            break;
          vptr += len;

          status = ares_expand_name(vptr, abuf, alen, &naptr_curr->replacement, &len);
          if (status != ARES_SUCCESS)
            break;
        }

      /* Don't lose memory in the next iteration */
      free (rr_name);
      rr_name = NULL;

      /* Move on to the next record */
      aptr += rr_len;
    }

  if (hostname)
    free (hostname);
  if (rr_name)
    free (rr_name);

  /* clean up on error */
  if (status != ARES_SUCCESS)
    {
      if (naptr_head)
        ares_free_data (naptr_head);
      return status;
    }

  /* everything looks fine, return the data */
  *naptr_out = naptr_head;

  return ARES_SUCCESS;
}

node-v4.8.2/deps/cares/src/ares_parse_ns_reply.c000644 000766 000024 00000011521 13070706730 021775 0ustar00iojsstaff000000 000000 /* Copyright 1998 by the Massachusetts Institute of Technology.
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

/*
 * ares_parse_ns_reply created by Vlad Dinulescu 
 *      on behalf of AVIRA Gmbh - http://www.avira.com
 */

#include "ares_setup.h"

#ifdef HAVE_NETINET_IN_H
#  include 
#endif
#ifdef HAVE_NETDB_H
#  include 
#endif
#ifdef HAVE_ARPA_INET_H
#  include 
#endif
#ifdef HAVE_ARPA_NAMESER_H
#  include 
#else
#  include "nameser.h"
#endif
#ifdef HAVE_ARPA_NAMESER_COMPAT_H
#  include 
#endif

#include "ares.h"
#include "ares_dns.h"
#include "ares_private.h"

int ares_parse_ns_reply( const unsigned char* abuf, int alen,
                         struct hostent** host )
{
  unsigned int qdcount, ancount;
  int status, i, rr_type, rr_class, rr_len;
  int nameservers_num;
  long len;
  const unsigned char *aptr;
  char* hostname, *rr_name, *rr_data, **nameservers;
  struct hostent *hostent;

  /* Set *host to NULL for all failure cases. */
  *host = NULL;

  /* Give up if abuf doesn't have room for a header. */
  if ( alen < HFIXEDSZ )
    return ARES_EBADRESP;

  /* Fetch the question and answer count from the header. */
  qdcount = DNS_HEADER_QDCOUNT( abuf );
  ancount = DNS_HEADER_ANCOUNT( abuf );
  if ( qdcount != 1 )
    return ARES_EBADRESP;

  /* Expand the name from the question, and skip past the question. */
  aptr = abuf + HFIXEDSZ;
  status = ares__expand_name_for_response( aptr, abuf, alen, &hostname, &len);
  if ( status != ARES_SUCCESS )
    return status;
  if ( aptr + len + QFIXEDSZ > abuf + alen )
  {
    free( hostname );
    return ARES_EBADRESP;
  }
  aptr += len + QFIXEDSZ;

  /* Allocate nameservers array; ancount gives an upper bound */
  nameservers = malloc( ( ancount + 1 ) * sizeof( char * ) );
  if ( !nameservers )
  {
    free( hostname );
    return ARES_ENOMEM;
  }
  nameservers_num = 0;

  /* Examine each answer resource record (RR) in turn. */
  for ( i = 0; i < ( int ) ancount; i++ )
  {
    /* Decode the RR up to the data field. */
    status = ares__expand_name_for_response( aptr, abuf, alen, &rr_name, &len );
    if ( status != ARES_SUCCESS )
      break;
    aptr += len;
    if ( aptr + RRFIXEDSZ > abuf + alen )
    {
      status = ARES_EBADRESP;
      free(rr_name);
      break;
    }
    rr_type = DNS_RR_TYPE( aptr );
    rr_class = DNS_RR_CLASS( aptr );
    rr_len = DNS_RR_LEN( aptr );
    aptr += RRFIXEDSZ;
    if (aptr + rr_len > abuf + alen)
      {
        free(rr_name);
        status = ARES_EBADRESP;
        break;
      }

    if ( rr_class == C_IN && rr_type == T_NS )
    {
      /* Decode the RR data and add it to the nameservers list */
      status = ares__expand_name_for_response( aptr, abuf, alen, &rr_data,
                                               &len);
      if ( status != ARES_SUCCESS )
      {
        free(rr_name);
        break;
      }

      nameservers[nameservers_num] = malloc(strlen(rr_data)+1);

      if (nameservers[nameservers_num]==NULL)
      {
        free(rr_name);
        free(rr_data);
        status=ARES_ENOMEM;
        break;
      }
      strcpy(nameservers[nameservers_num],rr_data);
      free(rr_data);

      nameservers_num++;
    }

    free( rr_name );

    aptr += rr_len;
    if ( aptr > abuf + alen )
    {
      status = ARES_EBADRESP;
      break;
    }
  }

  if ( status == ARES_SUCCESS && nameservers_num == 0 )
  {
    status = ARES_ENODATA;
  }
  if ( status == ARES_SUCCESS )
  {
    /* We got our answer.  Allocate memory to build the host entry. */
    nameservers[nameservers_num] = NULL;
    hostent = malloc( sizeof( struct hostent ) );
    if ( hostent )
    {
      hostent->h_addr_list = malloc( 1 * sizeof( char * ) );
      if ( hostent->h_addr_list )
      {
        /* Fill in the hostent and return successfully. */
        hostent->h_name = hostname;
        hostent->h_aliases = nameservers;
        hostent->h_addrtype = AF_INET;
        hostent->h_length = sizeof( struct in_addr );
        hostent->h_addr_list[0] = NULL;
        *host = hostent;
        return ARES_SUCCESS;
      }
      free( hostent );
    }
    status = ARES_ENOMEM;
  }
  for ( i = 0; i < nameservers_num; i++ )
    free( nameservers[i] );
  free( nameservers );
  free( hostname );
  return status;
}
node-v4.8.2/deps/cares/src/ares_parse_ptr_reply.c000644 000766 000024 00000014637 13070706730 022175 0ustar00iojsstaff000000 000000 
/* Copyright 1998 by the Massachusetts Institute of Technology.
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"

#ifdef HAVE_NETINET_IN_H
#  include 
#endif
#ifdef HAVE_NETDB_H
#  include 
#endif
#ifdef HAVE_ARPA_NAMESER_H
#  include 
#else
#  include "nameser.h"
#endif
#ifdef HAVE_ARPA_NAMESER_COMPAT_H
#  include 
#endif

#ifdef HAVE_STRINGS_H
#  include 
#endif

#include "ares.h"
#include "ares_dns.h"
#include "ares_nowarn.h"
#include "ares_private.h"

int ares_parse_ptr_reply(const unsigned char *abuf, int alen, const void *addr,
                         int addrlen, int family, struct hostent **host)
{
  unsigned int qdcount, ancount;
  int status, i, rr_type, rr_class, rr_len;
  long len;
  const unsigned char *aptr;
  char *ptrname, *hostname, *rr_name, *rr_data;
  struct hostent *hostent;
  int aliascnt = 0;
  int alias_alloc = 8;
  char ** aliases;

  /* Set *host to NULL for all failure cases. */
  *host = NULL;

  /* Give up if abuf doesn't have room for a header. */
  if (alen < HFIXEDSZ)
    return ARES_EBADRESP;

  /* Fetch the question and answer count from the header. */
  qdcount = DNS_HEADER_QDCOUNT(abuf);
  ancount = DNS_HEADER_ANCOUNT(abuf);
  if (qdcount != 1)
    return ARES_EBADRESP;

  /* Expand the name from the question, and skip past the question. */
  aptr = abuf + HFIXEDSZ;
  status = ares__expand_name_for_response(aptr, abuf, alen, &ptrname, &len);
  if (status != ARES_SUCCESS)
    return status;
  if (aptr + len + QFIXEDSZ > abuf + alen)
    {
      free(ptrname);
      return ARES_EBADRESP;
    }
  aptr += len + QFIXEDSZ;

  /* Examine each answer resource record (RR) in turn. */
  hostname = NULL;
  aliases = malloc(alias_alloc * sizeof(char *));
  if (!aliases)
    {
      free(ptrname);
      return ARES_ENOMEM;
    }
  for (i = 0; i < (int)ancount; i++)
    {
      /* Decode the RR up to the data field. */
      status = ares__expand_name_for_response(aptr, abuf, alen, &rr_name, &len);
      if (status != ARES_SUCCESS)
        break;
      aptr += len;
      if (aptr + RRFIXEDSZ > abuf + alen)
        {
          free(rr_name);
          status = ARES_EBADRESP;
          break;
        }
      rr_type = DNS_RR_TYPE(aptr);
      rr_class = DNS_RR_CLASS(aptr);
      rr_len = DNS_RR_LEN(aptr);
      aptr += RRFIXEDSZ;
      if (aptr + rr_len > abuf + alen)
        {
          free(rr_name);
          status = ARES_EBADRESP;
          break;
        }

      if (rr_class == C_IN && rr_type == T_PTR
          && strcasecmp(rr_name, ptrname) == 0)
        {
          /* Decode the RR data and set hostname to it. */
          status = ares__expand_name_for_response(aptr, abuf, alen, &rr_data,
                                                  &len);
          if (status != ARES_SUCCESS)
            {
              free(rr_name);
              break;
            }
          if (hostname)
            free(hostname);
          hostname = rr_data;
          aliases[aliascnt] = malloc((strlen(rr_data)+1) * sizeof(char));
          if (!aliases[aliascnt])
            {
              free(rr_name);
              status = ARES_ENOMEM;
              break;
            }
          strncpy(aliases[aliascnt], rr_data, strlen(rr_data)+1);
          aliascnt++;
          if (aliascnt >= alias_alloc) {
            char **ptr;
            alias_alloc *= 2;
            ptr = realloc(aliases, alias_alloc * sizeof(char *));
            if(!ptr) {
              free(rr_name);
              status = ARES_ENOMEM;
              break;
            }
            aliases = ptr;
          }
        }

      if (rr_class == C_IN && rr_type == T_CNAME)
        {
          /* Decode the RR data and replace ptrname with it. */
          status = ares__expand_name_for_response(aptr, abuf, alen, &rr_data,
                                                  &len);
          if (status != ARES_SUCCESS)
            {
              free(rr_name);
              break;
            }
          free(ptrname);
          ptrname = rr_data;
        }

      free(rr_name);
      aptr += rr_len;
      if (aptr > abuf + alen)
        {
          status = ARES_EBADRESP;
          break;
        }
    }

  if (status == ARES_SUCCESS && !hostname)
    status = ARES_ENODATA;
  if (status == ARES_SUCCESS)
    {
      /* We got our answer.  Allocate memory to build the host entry. */
      hostent = malloc(sizeof(struct hostent));
      if (hostent)
        {
          hostent->h_addr_list = malloc(2 * sizeof(char *));
          if (hostent->h_addr_list)
            {
              hostent->h_addr_list[0] = malloc(addrlen);
              if (hostent->h_addr_list[0])
                {
                  hostent->h_aliases = malloc((aliascnt+1) * sizeof (char *));
                  if (hostent->h_aliases)
                    {
                      /* Fill in the hostent and return successfully. */
                      hostent->h_name = hostname;
                      for (i=0 ; ih_aliases[i] = aliases[i];
                      hostent->h_aliases[aliascnt] = NULL;
                      hostent->h_addrtype = aresx_sitoss(family);
                      hostent->h_length = aresx_sitoss(addrlen);
                      memcpy(hostent->h_addr_list[0], addr, addrlen);
                      hostent->h_addr_list[1] = NULL;
                      *host = hostent;
                      free(aliases);
                      free(ptrname);
                      return ARES_SUCCESS;
                    }
                  free(hostent->h_addr_list[0]);
                }
              free(hostent->h_addr_list);
            }
          free(hostent);
        }
      status = ARES_ENOMEM;
    }
  for (i=0 ; i
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"

#ifdef HAVE_NETINET_IN_H
#  include 
#endif
#ifdef HAVE_NETDB_H
#  include 
#endif
#ifdef HAVE_ARPA_INET_H
#  include 
#endif
#ifdef HAVE_ARPA_NAMESER_H
#  include 
#else
#  include "nameser.h"
#endif
#ifdef HAVE_ARPA_NAMESER_COMPAT_H
#  include 
#endif

#include "ares.h"
#include "ares_dns.h"
#include "ares_data.h"
#include "ares_private.h"

int
ares_parse_soa_reply(const unsigned char *abuf, int alen,
		     struct ares_soa_reply **soa_out)
{
  const unsigned char *aptr;
  long len;
  char *qname = NULL, *rr_name = NULL;
  struct ares_soa_reply *soa = NULL;
  int qdcount, ancount;
  int status;

  if (alen < HFIXEDSZ)
    return ARES_EBADRESP;

  /* parse message header */
  qdcount = DNS_HEADER_QDCOUNT(abuf);
  ancount = DNS_HEADER_ANCOUNT(abuf);
  if (qdcount != 1 || ancount != 1)
    return ARES_EBADRESP;
  aptr = abuf + HFIXEDSZ;

  /* query name */
  status = ares__expand_name_for_response(aptr, abuf, alen, &qname, &len);
  if (status != ARES_SUCCESS)
    goto failed_stat;
  aptr += len;

  /* skip qtype & qclass */
  if (aptr + QFIXEDSZ > abuf + alen)
    goto failed;
  aptr += QFIXEDSZ;

  /* rr_name */
  status = ares__expand_name_for_response(aptr, abuf, alen, &rr_name, &len);
  if (status != ARES_SUCCESS)
    goto failed_stat;
  aptr += len;

  /* skip rr_type, rr_class, rr_ttl, rr_rdlen */
  if (aptr + RRFIXEDSZ > abuf + alen)
    goto failed;
  aptr += RRFIXEDSZ;

  /* allocate result struct */
  soa = ares_malloc_data(ARES_DATATYPE_SOA_REPLY);
  if (!soa)
    {
      status = ARES_ENOMEM;
      goto failed_stat;
    }

  /* nsname */
  status = ares__expand_name_for_response(aptr, abuf, alen, &soa->nsname, &len);
  if (status != ARES_SUCCESS)
    goto failed_stat;
  aptr += len;

  /* hostmaster */
  status = ares__expand_name_for_response(aptr, abuf, alen, &soa->hostmaster, &len);
  if (status != ARES_SUCCESS)
    goto failed_stat;
  aptr += len;

  /* integer fields */
  if (aptr + 5 * 4 > abuf + alen)
    goto failed;
  soa->serial = DNS__32BIT(aptr + 0 * 4);
  soa->refresh = DNS__32BIT(aptr + 1 * 4);
  soa->retry = DNS__32BIT(aptr + 2 * 4);
  soa->expire = DNS__32BIT(aptr + 3 * 4);
  soa->minttl = DNS__32BIT(aptr + 4 * 4);

  free(qname);
  free(rr_name);

  *soa_out = soa;

  return ARES_SUCCESS;

failed:
  status = ARES_EBADRESP;

failed_stat:
  ares_free_data(soa);
  if (qname)
    free(qname);
  if (rr_name)
    free(rr_name);
  return status;
}

node-v4.8.2/deps/cares/src/ares_parse_srv_reply.c000644 000766 000024 00000011241 13070706730 022166 0ustar00iojsstaff000000 000000 
/* Copyright 1998 by the Massachusetts Institute of Technology.
 * Copyright (C) 2009 by Jakub Hrozek 
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"

#ifdef HAVE_NETINET_IN_H
#  include 
#endif
#ifdef HAVE_NETDB_H
#  include 
#endif
#ifdef HAVE_ARPA_INET_H
#  include 
#endif
#ifdef HAVE_ARPA_NAMESER_H
#  include 
#else
#  include "nameser.h"
#endif
#ifdef HAVE_ARPA_NAMESER_COMPAT_H
#  include 
#endif

#include "ares.h"
#include "ares_dns.h"
#include "ares_data.h"
#include "ares_private.h"

/* AIX portability check */
#ifndef T_SRV
#  define T_SRV 33 /* server selection */
#endif

int
ares_parse_srv_reply (const unsigned char *abuf, int alen,
                      struct ares_srv_reply **srv_out)
{
  unsigned int qdcount, ancount, i;
  const unsigned char *aptr, *vptr;
  int status, rr_type, rr_class, rr_len;
  long len;
  char *hostname = NULL, *rr_name = NULL;
  struct ares_srv_reply *srv_head = NULL;
  struct ares_srv_reply *srv_last = NULL;
  struct ares_srv_reply *srv_curr;

  /* Set *srv_out to NULL for all failure cases. */
  *srv_out = NULL;

  /* Give up if abuf doesn't have room for a header. */
  if (alen < HFIXEDSZ)
    return ARES_EBADRESP;

  /* Fetch the question and answer count from the header. */
  qdcount = DNS_HEADER_QDCOUNT (abuf);
  ancount = DNS_HEADER_ANCOUNT (abuf);
  if (qdcount != 1)
    return ARES_EBADRESP;
  if (ancount == 0)
    return ARES_ENODATA;

  /* Expand the name from the question, and skip past the question. */
  aptr = abuf + HFIXEDSZ;
  status = ares_expand_name (aptr, abuf, alen, &hostname, &len);
  if (status != ARES_SUCCESS)
    return status;

  if (aptr + len + QFIXEDSZ > abuf + alen)
    {
      free (hostname);
      return ARES_EBADRESP;
    }
  aptr += len + QFIXEDSZ;

  /* Examine each answer resource record (RR) in turn. */
  for (i = 0; i < ancount; i++)
    {
      /* Decode the RR up to the data field. */
      status = ares_expand_name (aptr, abuf, alen, &rr_name, &len);
      if (status != ARES_SUCCESS)
        {
          break;
        }
      aptr += len;
      if (aptr + RRFIXEDSZ > abuf + alen)
        {
          status = ARES_EBADRESP;
          break;
        }
      rr_type = DNS_RR_TYPE (aptr);
      rr_class = DNS_RR_CLASS (aptr);
      rr_len = DNS_RR_LEN (aptr);
      aptr += RRFIXEDSZ;
      if (aptr + rr_len > abuf + alen)
        {
          status = ARES_EBADRESP;
          break;
        }

      /* Check if we are really looking at a SRV record */
      if (rr_class == C_IN && rr_type == T_SRV)
        {
          /* parse the SRV record itself */
          if (rr_len < 6)
            {
              status = ARES_EBADRESP;
              break;
            }

          /* Allocate storage for this SRV answer appending it to the list */
          srv_curr = ares_malloc_data(ARES_DATATYPE_SRV_REPLY);
          if (!srv_curr)
            {
              status = ARES_ENOMEM;
              break;
            }
          if (srv_last)
            {
              srv_last->next = srv_curr;
            }
          else
            {
              srv_head = srv_curr;
            }
          srv_last = srv_curr;

          vptr = aptr;
          srv_curr->priority = DNS__16BIT(vptr);
          vptr += sizeof(unsigned short);
          srv_curr->weight = DNS__16BIT(vptr);
          vptr += sizeof(unsigned short);
          srv_curr->port = DNS__16BIT(vptr);
          vptr += sizeof(unsigned short);

          status = ares_expand_name (vptr, abuf, alen, &srv_curr->host, &len);
          if (status != ARES_SUCCESS)
            break;
        }

      /* Don't lose memory in the next iteration */
      free (rr_name);
      rr_name = NULL;

      /* Move on to the next record */
      aptr += rr_len;
    }

  if (hostname)
    free (hostname);
  if (rr_name)
    free (rr_name);

  /* clean up on error */
  if (status != ARES_SUCCESS)
    {
      if (srv_head)
        ares_free_data (srv_head);
      return status;
    }

  /* everything looks fine, return the data */
  *srv_out = srv_head;

  return ARES_SUCCESS;
}
node-v4.8.2/deps/cares/src/ares_parse_txt_reply.c000644 000766 000024 00000012533 13070706730 022200 0ustar00iojsstaff000000 000000 
/* Copyright 1998 by the Massachusetts Institute of Technology.
 * Copyright (C) 2009 by Jakub Hrozek 
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"

#ifdef HAVE_NETINET_IN_H
#  include 
#endif
#ifdef HAVE_NETDB_H
#  include 
#endif
#ifdef HAVE_ARPA_INET_H
#  include 
#endif
#ifdef HAVE_ARPA_NAMESER_H
#  include 
#else
#  include "nameser.h"
#endif
#ifdef HAVE_ARPA_NAMESER_COMPAT_H
#  include 
#endif

#ifdef HAVE_STRINGS_H
#  include 
#endif

#include "ares.h"
#include "ares_dns.h"
#include "ares_data.h"
#include "ares_private.h"

int
ares_parse_txt_reply (const unsigned char *abuf, int alen,
                      struct ares_txt_reply **txt_out)
{
  size_t substr_len;
  unsigned int qdcount, ancount, i;
  const unsigned char *aptr;
  const unsigned char *strptr;
  int status, rr_type, rr_class, rr_len;
  long len;
  char *hostname = NULL, *rr_name = NULL;
  struct ares_txt_reply *txt_head = NULL;
  struct ares_txt_reply *txt_last = NULL;
  struct ares_txt_reply *txt_curr;

  /* Set *txt_out to NULL for all failure cases. */
  *txt_out = NULL;

  /* Give up if abuf doesn't have room for a header. */
  if (alen < HFIXEDSZ)
    return ARES_EBADRESP;

  /* Fetch the question and answer count from the header. */
  qdcount = DNS_HEADER_QDCOUNT (abuf);
  ancount = DNS_HEADER_ANCOUNT (abuf);
  if (qdcount != 1)
    return ARES_EBADRESP;
  if (ancount == 0)
    return ARES_ENODATA;

  /* Expand the name from the question, and skip past the question. */
  aptr = abuf + HFIXEDSZ;
  status = ares_expand_name (aptr, abuf, alen, &hostname, &len);
  if (status != ARES_SUCCESS)
    return status;

  if (aptr + len + QFIXEDSZ > abuf + alen)
    {
      free (hostname);
      return ARES_EBADRESP;
    }
  aptr += len + QFIXEDSZ;

  /* Examine each answer resource record (RR) in turn. */
  for (i = 0; i < ancount; i++)
    {
      /* Decode the RR up to the data field. */
      status = ares_expand_name (aptr, abuf, alen, &rr_name, &len);
      if (status != ARES_SUCCESS)
        {
          break;
        }
      aptr += len;
      if (aptr + RRFIXEDSZ > abuf + alen)
        {
          status = ARES_EBADRESP;
          break;
        }
      rr_type = DNS_RR_TYPE (aptr);
      rr_class = DNS_RR_CLASS (aptr);
      rr_len = DNS_RR_LEN (aptr);
      aptr += RRFIXEDSZ;
      if (aptr + rr_len > abuf + alen)
        {
          status = ARES_EBADRESP;
          break;
        }

      /* Check if we are really looking at a TXT record */
      if (rr_class == C_IN && rr_type == T_TXT)
        {
          /*
           * There may be multiple substrings in a single TXT record. Each
           * substring may be up to 255 characters in length, with a
           * "length byte" indicating the size of the substring payload.
           * RDATA contains both the length-bytes and payloads of all
           * substrings contained therein.
           */

          strptr = aptr;
          while (strptr < (aptr + rr_len))
            {
              substr_len = (unsigned char)*strptr;
              if (strptr + substr_len + 1 > aptr + rr_len)
                {
                  status = ARES_EBADRESP;
                  break;
                }

              /* Allocate storage for this TXT answer appending it to the list */
              txt_curr = ares_malloc_data(ARES_DATATYPE_TXT_REPLY);
              if (!txt_curr)
                {
                  status = ARES_ENOMEM;
                  break;
                }
              if (txt_last)
                {
                  txt_last->next = txt_curr;
                }
              else
                {
                  txt_head = txt_curr;
                }
              txt_last = txt_curr;

              txt_curr->record_start = strptr == aptr;
              txt_curr->length = substr_len;
              txt_curr->txt = malloc (substr_len + 1/* Including null byte */);
              if (txt_curr->txt == NULL)
                {
                  status = ARES_ENOMEM;
                  break;
                }

              ++strptr;
              memcpy ((char *) txt_curr->txt, strptr, substr_len);

              /* Make sure we NULL-terminate */
              txt_curr->txt[substr_len] = 0;

              strptr += substr_len;
            }
        }

      /* Don't lose memory in the next iteration */
      free (rr_name);
      rr_name = NULL;

      /* Move on to the next record */
      aptr += rr_len;
    }

  if (hostname)
    free (hostname);
  if (rr_name)
    free (rr_name);

  /* clean up on error */
  if (status != ARES_SUCCESS)
    {
      if (txt_head)
        ares_free_data (txt_head);
      return status;
    }

  /* everything looks fine, return the data */
  *txt_out = txt_head;

  return ARES_SUCCESS;
}
node-v4.8.2/deps/cares/src/ares_platform.c000644 000766 000024 00001702610 13070706730 020603 0ustar00iojsstaff000000 000000 

/* Copyright 1998 by the Massachusetts Institute of Technology.
 * Copyright (C) 2004 - 2011 by Daniel Stenberg et al
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"

#include "ares.h"
#include "ares_platform.h"
#include "ares_nowarn.h"
#include "ares_private.h"

#if defined(WIN32) && !defined(MSDOS)

#define V_PLATFORM_WIN32s         0
#define V_PLATFORM_WIN32_WINDOWS  1
#define V_PLATFORM_WIN32_NT       2
#define V_PLATFORM_WIN32_CE       3

win_platform ares__getplatform(void)
{
  OSVERSIONINFOEX OsvEx;

  memset(&OsvEx, 0, sizeof(OsvEx));
  OsvEx.dwOSVersionInfoSize = sizeof(OSVERSIONINFOEX);
  if (!GetVersionEx((void *)&OsvEx))
    {
      memset(&OsvEx, 0, sizeof(OsvEx));
      OsvEx.dwOSVersionInfoSize = sizeof(OSVERSIONINFO);
      if (!GetVersionEx((void *)&OsvEx))
        return WIN_UNKNOWN;
    }

  switch(OsvEx.dwPlatformId)
    {
      case V_PLATFORM_WIN32s:
        return WIN_3X;

      case V_PLATFORM_WIN32_WINDOWS:
        return WIN_9X;

      case V_PLATFORM_WIN32_NT:
        return WIN_NT;

      case V_PLATFORM_WIN32_CE:
        return WIN_CE;

      default:
        return WIN_UNKNOWN;
    }
}

#endif /* WIN32 && ! MSDOS */

#if defined(_WIN32_WCE)

/* IANA Well Known Ports are in range 0-1023 */
#define USE_IANA_WELL_KNOWN_PORTS 1

/* IANA Registered Ports are in range 1024-49151 */
#define USE_IANA_REGISTERED_PORTS 1

struct pvt_servent {
  char           *s_name;
  char          **s_aliases;
  unsigned short  s_port;
  char           *s_proto;
};

/*
 * Ref: http://www.iana.org/assignments/port-numbers
 */

static struct pvt_servent IANAports[] = {
#ifdef USE_IANA_WELL_KNOWN_PORTS
{"tcpmux",             {NULL}, 1, "tcp"},
{"tcpmux",             {NULL}, 1, "udp"},
{"compressnet",        {NULL}, 2, "tcp"},
{"compressnet",        {NULL}, 2, "udp"},
{"compressnet",        {NULL}, 3, "tcp"},
{"compressnet",        {NULL}, 3, "udp"},
{"rje",                {NULL}, 5, "tcp"},
{"rje",                {NULL}, 5, "udp"},
{"echo",               {NULL}, 7, "tcp"},
{"echo",               {NULL}, 7, "udp"},
{"discard",            {NULL}, 9, "tcp"},
{"discard",            {NULL}, 9, "udp"},
{"discard",            {NULL}, 9, "sctp"},
{"discard",            {NULL}, 9, "dccp"},
{"systat",             {NULL}, 11, "tcp"},
{"systat",             {NULL}, 11, "udp"},
{"daytime",            {NULL}, 13, "tcp"},
{"daytime",            {NULL}, 13, "udp"},
{"qotd",               {NULL}, 17, "tcp"},
{"qotd",               {NULL}, 17, "udp"},
{"msp",                {NULL}, 18, "tcp"},
{"msp",                {NULL}, 18, "udp"},
{"chargen",            {NULL}, 19, "tcp"},
{"chargen",            {NULL}, 19, "udp"},
{"ftp-data",           {NULL}, 20, "tcp"},
{"ftp-data",           {NULL}, 20, "udp"},
{"ftp-data",           {NULL}, 20, "sctp"},
{"ftp",                {NULL}, 21, "tcp"},
{"ftp",                {NULL}, 21, "udp"},
{"ftp",                {NULL}, 21, "sctp"},
{"ssh",                {NULL}, 22, "tcp"},
{"ssh",                {NULL}, 22, "udp"},
{"ssh",                {NULL}, 22, "sctp"},
{"telnet",             {NULL}, 23, "tcp"},
{"telnet",             {NULL}, 23, "udp"},
{"smtp",               {NULL}, 25, "tcp"},
{"smtp",               {NULL}, 25, "udp"},
{"nsw-fe",             {NULL}, 27, "tcp"},
{"nsw-fe",             {NULL}, 27, "udp"},
{"msg-icp",            {NULL}, 29, "tcp"},
{"msg-icp",            {NULL}, 29, "udp"},
{"msg-auth",           {NULL}, 31, "tcp"},
{"msg-auth",           {NULL}, 31, "udp"},
{"dsp",                {NULL}, 33, "tcp"},
{"dsp",                {NULL}, 33, "udp"},
{"time",               {NULL}, 37, "tcp"},
{"time",               {NULL}, 37, "udp"},
{"rap",                {NULL}, 38, "tcp"},
{"rap",                {NULL}, 38, "udp"},
{"rlp",                {NULL}, 39, "tcp"},
{"rlp",                {NULL}, 39, "udp"},
{"graphics",           {NULL}, 41, "tcp"},
{"graphics",           {NULL}, 41, "udp"},
{"name",               {NULL}, 42, "tcp"},
{"name",               {NULL}, 42, "udp"},
{"nameserver",         {NULL}, 42, "tcp"},
{"nameserver",         {NULL}, 42, "udp"},
{"nicname",            {NULL}, 43, "tcp"},
{"nicname",            {NULL}, 43, "udp"},
{"mpm-flags",          {NULL}, 44, "tcp"},
{"mpm-flags",          {NULL}, 44, "udp"},
{"mpm",                {NULL}, 45, "tcp"},
{"mpm",                {NULL}, 45, "udp"},
{"mpm-snd",            {NULL}, 46, "tcp"},
{"mpm-snd",            {NULL}, 46, "udp"},
{"ni-ftp",             {NULL}, 47, "tcp"},
{"ni-ftp",             {NULL}, 47, "udp"},
{"auditd",             {NULL}, 48, "tcp"},
{"auditd",             {NULL}, 48, "udp"},
{"tacacs",             {NULL}, 49, "tcp"},
{"tacacs",             {NULL}, 49, "udp"},
{"re-mail-ck",         {NULL}, 50, "tcp"},
{"re-mail-ck",         {NULL}, 50, "udp"},
{"la-maint",           {NULL}, 51, "tcp"},
{"la-maint",           {NULL}, 51, "udp"},
{"xns-time",           {NULL}, 52, "tcp"},
{"xns-time",           {NULL}, 52, "udp"},
{"domain",             {NULL}, 53, "tcp"},
{"domain",             {NULL}, 53, "udp"},
{"xns-ch",             {NULL}, 54, "tcp"},
{"xns-ch",             {NULL}, 54, "udp"},
{"isi-gl",             {NULL}, 55, "tcp"},
{"isi-gl",             {NULL}, 55, "udp"},
{"xns-auth",           {NULL}, 56, "tcp"},
{"xns-auth",           {NULL}, 56, "udp"},
{"xns-mail",           {NULL}, 58, "tcp"},
{"xns-mail",           {NULL}, 58, "udp"},
{"ni-mail",            {NULL}, 61, "tcp"},
{"ni-mail",            {NULL}, 61, "udp"},
{"acas",               {NULL}, 62, "tcp"},
{"acas",               {NULL}, 62, "udp"},
{"whois++",            {NULL}, 63, "tcp"},
{"whois++",            {NULL}, 63, "udp"},
{"covia",              {NULL}, 64, "tcp"},
{"covia",              {NULL}, 64, "udp"},
{"tacacs-ds",          {NULL}, 65, "tcp"},
{"tacacs-ds",          {NULL}, 65, "udp"},
{"sql*net",            {NULL}, 66, "tcp"},
{"sql*net",            {NULL}, 66, "udp"},
{"bootps",             {NULL}, 67, "tcp"},
{"bootps",             {NULL}, 67, "udp"},
{"bootpc",             {NULL}, 68, "tcp"},
{"bootpc",             {NULL}, 68, "udp"},
{"tftp",               {NULL}, 69, "tcp"},
{"tftp",               {NULL}, 69, "udp"},
{"gopher",             {NULL}, 70, "tcp"},
{"gopher",             {NULL}, 70, "udp"},
{"netrjs-1",           {NULL}, 71, "tcp"},
{"netrjs-1",           {NULL}, 71, "udp"},
{"netrjs-2",           {NULL}, 72, "tcp"},
{"netrjs-2",           {NULL}, 72, "udp"},
{"netrjs-3",           {NULL}, 73, "tcp"},
{"netrjs-3",           {NULL}, 73, "udp"},
{"netrjs-4",           {NULL}, 74, "tcp"},
{"netrjs-4",           {NULL}, 74, "udp"},
{"deos",               {NULL}, 76, "tcp"},
{"deos",               {NULL}, 76, "udp"},
{"vettcp",             {NULL}, 78, "tcp"},
{"vettcp",             {NULL}, 78, "udp"},
{"finger",             {NULL}, 79, "tcp"},
{"finger",             {NULL}, 79, "udp"},
{"http",               {NULL}, 80, "tcp"},
{"http",               {NULL}, 80, "udp"},
{"www",                {NULL}, 80, "tcp"},
{"www",                {NULL}, 80, "udp"},
{"www-http",           {NULL}, 80, "tcp"},
{"www-http",           {NULL}, 80, "udp"},
{"http",               {NULL}, 80, "sctp"},
{"xfer",               {NULL}, 82, "tcp"},
{"xfer",               {NULL}, 82, "udp"},
{"mit-ml-dev",         {NULL}, 83, "tcp"},
{"mit-ml-dev",         {NULL}, 83, "udp"},
{"ctf",                {NULL}, 84, "tcp"},
{"ctf",                {NULL}, 84, "udp"},
{"mit-ml-dev",         {NULL}, 85, "tcp"},
{"mit-ml-dev",         {NULL}, 85, "udp"},
{"mfcobol",            {NULL}, 86, "tcp"},
{"mfcobol",            {NULL}, 86, "udp"},
{"kerberos",           {NULL}, 88, "tcp"},
{"kerberos",           {NULL}, 88, "udp"},
{"su-mit-tg",          {NULL}, 89, "tcp"},
{"su-mit-tg",          {NULL}, 89, "udp"},
{"dnsix",              {NULL}, 90, "tcp"},
{"dnsix",              {NULL}, 90, "udp"},
{"mit-dov",            {NULL}, 91, "tcp"},
{"mit-dov",            {NULL}, 91, "udp"},
{"npp",                {NULL}, 92, "tcp"},
{"npp",                {NULL}, 92, "udp"},
{"dcp",                {NULL}, 93, "tcp"},
{"dcp",                {NULL}, 93, "udp"},
{"objcall",            {NULL}, 94, "tcp"},
{"objcall",            {NULL}, 94, "udp"},
{"supdup",             {NULL}, 95, "tcp"},
{"supdup",             {NULL}, 95, "udp"},
{"dixie",              {NULL}, 96, "tcp"},
{"dixie",              {NULL}, 96, "udp"},
{"swift-rvf",          {NULL}, 97, "tcp"},
{"swift-rvf",          {NULL}, 97, "udp"},
{"tacnews",            {NULL}, 98, "tcp"},
{"tacnews",            {NULL}, 98, "udp"},
{"metagram",           {NULL}, 99, "tcp"},
{"metagram",           {NULL}, 99, "udp"},
{"newacct",            {NULL}, 100, "tcp"},
{"hostname",           {NULL}, 101, "tcp"},
{"hostname",           {NULL}, 101, "udp"},
{"iso-tsap",           {NULL}, 102, "tcp"},
{"iso-tsap",           {NULL}, 102, "udp"},
{"gppitnp",            {NULL}, 103, "tcp"},
{"gppitnp",            {NULL}, 103, "udp"},
{"acr-nema",           {NULL}, 104, "tcp"},
{"acr-nema",           {NULL}, 104, "udp"},
{"cso",                {NULL}, 105, "tcp"},
{"cso",                {NULL}, 105, "udp"},
{"csnet-ns",           {NULL}, 105, "tcp"},
{"csnet-ns",           {NULL}, 105, "udp"},
{"3com-tsmux",         {NULL}, 106, "tcp"},
{"3com-tsmux",         {NULL}, 106, "udp"},
{"rtelnet",            {NULL}, 107, "tcp"},
{"rtelnet",            {NULL}, 107, "udp"},
{"snagas",             {NULL}, 108, "tcp"},
{"snagas",             {NULL}, 108, "udp"},
{"pop2",               {NULL}, 109, "tcp"},
{"pop2",               {NULL}, 109, "udp"},
{"pop3",               {NULL}, 110, "tcp"},
{"pop3",               {NULL}, 110, "udp"},
{"sunrpc",             {NULL}, 111, "tcp"},
{"sunrpc",             {NULL}, 111, "udp"},
{"mcidas",             {NULL}, 112, "tcp"},
{"mcidas",             {NULL}, 112, "udp"},
{"ident",              {NULL}, 113, "tcp"},
{"auth",               {NULL}, 113, "tcp"},
{"auth",               {NULL}, 113, "udp"},
{"sftp",               {NULL}, 115, "tcp"},
{"sftp",               {NULL}, 115, "udp"},
{"ansanotify",         {NULL}, 116, "tcp"},
{"ansanotify",         {NULL}, 116, "udp"},
{"uucp-path",          {NULL}, 117, "tcp"},
{"uucp-path",          {NULL}, 117, "udp"},
{"sqlserv",            {NULL}, 118, "tcp"},
{"sqlserv",            {NULL}, 118, "udp"},
{"nntp",               {NULL}, 119, "tcp"},
{"nntp",               {NULL}, 119, "udp"},
{"cfdptkt",            {NULL}, 120, "tcp"},
{"cfdptkt",            {NULL}, 120, "udp"},
{"erpc",               {NULL}, 121, "tcp"},
{"erpc",               {NULL}, 121, "udp"},
{"smakynet",           {NULL}, 122, "tcp"},
{"smakynet",           {NULL}, 122, "udp"},
{"ntp",                {NULL}, 123, "tcp"},
{"ntp",                {NULL}, 123, "udp"},
{"ansatrader",         {NULL}, 124, "tcp"},
{"ansatrader",         {NULL}, 124, "udp"},
{"locus-map",          {NULL}, 125, "tcp"},
{"locus-map",          {NULL}, 125, "udp"},
{"nxedit",             {NULL}, 126, "tcp"},
{"nxedit",             {NULL}, 126, "udp"},
{"locus-con",          {NULL}, 127, "tcp"},
{"locus-con",          {NULL}, 127, "udp"},
{"gss-xlicen",         {NULL}, 128, "tcp"},
{"gss-xlicen",         {NULL}, 128, "udp"},
{"pwdgen",             {NULL}, 129, "tcp"},
{"pwdgen",             {NULL}, 129, "udp"},
{"cisco-fna",          {NULL}, 130, "tcp"},
{"cisco-fna",          {NULL}, 130, "udp"},
{"cisco-tna",          {NULL}, 131, "tcp"},
{"cisco-tna",          {NULL}, 131, "udp"},
{"cisco-sys",          {NULL}, 132, "tcp"},
{"cisco-sys",          {NULL}, 132, "udp"},
{"statsrv",            {NULL}, 133, "tcp"},
{"statsrv",            {NULL}, 133, "udp"},
{"ingres-net",         {NULL}, 134, "tcp"},
{"ingres-net",         {NULL}, 134, "udp"},
{"epmap",              {NULL}, 135, "tcp"},
{"epmap",              {NULL}, 135, "udp"},
{"profile",            {NULL}, 136, "tcp"},
{"profile",            {NULL}, 136, "udp"},
{"netbios-ns",         {NULL}, 137, "tcp"},
{"netbios-ns",         {NULL}, 137, "udp"},
{"netbios-dgm",        {NULL}, 138, "tcp"},
{"netbios-dgm",        {NULL}, 138, "udp"},
{"netbios-ssn",        {NULL}, 139, "tcp"},
{"netbios-ssn",        {NULL}, 139, "udp"},
{"emfis-data",         {NULL}, 140, "tcp"},
{"emfis-data",         {NULL}, 140, "udp"},
{"emfis-cntl",         {NULL}, 141, "tcp"},
{"emfis-cntl",         {NULL}, 141, "udp"},
{"bl-idm",             {NULL}, 142, "tcp"},
{"bl-idm",             {NULL}, 142, "udp"},
{"imap",               {NULL}, 143, "tcp"},
{"imap",               {NULL}, 143, "udp"},
{"uma",                {NULL}, 144, "tcp"},
{"uma",                {NULL}, 144, "udp"},
{"uaac",               {NULL}, 145, "tcp"},
{"uaac",               {NULL}, 145, "udp"},
{"iso-tp0",            {NULL}, 146, "tcp"},
{"iso-tp0",            {NULL}, 146, "udp"},
{"iso-ip",             {NULL}, 147, "tcp"},
{"iso-ip",             {NULL}, 147, "udp"},
{"jargon",             {NULL}, 148, "tcp"},
{"jargon",             {NULL}, 148, "udp"},
{"aed-512",            {NULL}, 149, "tcp"},
{"aed-512",            {NULL}, 149, "udp"},
{"sql-net",            {NULL}, 150, "tcp"},
{"sql-net",            {NULL}, 150, "udp"},
{"hems",               {NULL}, 151, "tcp"},
{"hems",               {NULL}, 151, "udp"},
{"bftp",               {NULL}, 152, "tcp"},
{"bftp",               {NULL}, 152, "udp"},
{"sgmp",               {NULL}, 153, "tcp"},
{"sgmp",               {NULL}, 153, "udp"},
{"netsc-prod",         {NULL}, 154, "tcp"},
{"netsc-prod",         {NULL}, 154, "udp"},
{"netsc-dev",          {NULL}, 155, "tcp"},
{"netsc-dev",          {NULL}, 155, "udp"},
{"sqlsrv",             {NULL}, 156, "tcp"},
{"sqlsrv",             {NULL}, 156, "udp"},
{"knet-cmp",           {NULL}, 157, "tcp"},
{"knet-cmp",           {NULL}, 157, "udp"},
{"pcmail-srv",         {NULL}, 158, "tcp"},
{"pcmail-srv",         {NULL}, 158, "udp"},
{"nss-routing",        {NULL}, 159, "tcp"},
{"nss-routing",        {NULL}, 159, "udp"},
{"sgmp-traps",         {NULL}, 160, "tcp"},
{"sgmp-traps",         {NULL}, 160, "udp"},
{"snmp",               {NULL}, 161, "tcp"},
{"snmp",               {NULL}, 161, "udp"},
{"snmptrap",           {NULL}, 162, "tcp"},
{"snmptrap",           {NULL}, 162, "udp"},
{"cmip-man",           {NULL}, 163, "tcp"},
{"cmip-man",           {NULL}, 163, "udp"},
{"cmip-agent",         {NULL}, 164, "tcp"},
{"cmip-agent",         {NULL}, 164, "udp"},
{"xns-courier",        {NULL}, 165, "tcp"},
{"xns-courier",        {NULL}, 165, "udp"},
{"s-net",              {NULL}, 166, "tcp"},
{"s-net",              {NULL}, 166, "udp"},
{"namp",               {NULL}, 167, "tcp"},
{"namp",               {NULL}, 167, "udp"},
{"rsvd",               {NULL}, 168, "tcp"},
{"rsvd",               {NULL}, 168, "udp"},
{"send",               {NULL}, 169, "tcp"},
{"send",               {NULL}, 169, "udp"},
{"print-srv",          {NULL}, 170, "tcp"},
{"print-srv",          {NULL}, 170, "udp"},
{"multiplex",          {NULL}, 171, "tcp"},
{"multiplex",          {NULL}, 171, "udp"},
{"cl/1",               {NULL}, 172, "tcp"},
{"cl/1",               {NULL}, 172, "udp"},
{"xyplex-mux",         {NULL}, 173, "tcp"},
{"xyplex-mux",         {NULL}, 173, "udp"},
{"mailq",              {NULL}, 174, "tcp"},
{"mailq",              {NULL}, 174, "udp"},
{"vmnet",              {NULL}, 175, "tcp"},
{"vmnet",              {NULL}, 175, "udp"},
{"genrad-mux",         {NULL}, 176, "tcp"},
{"genrad-mux",         {NULL}, 176, "udp"},
{"xdmcp",              {NULL}, 177, "tcp"},
{"xdmcp",              {NULL}, 177, "udp"},
{"nextstep",           {NULL}, 178, "tcp"},
{"nextstep",           {NULL}, 178, "udp"},
{"bgp",                {NULL}, 179, "tcp"},
{"bgp",                {NULL}, 179, "udp"},
{"bgp",                {NULL}, 179, "sctp"},
{"ris",                {NULL}, 180, "tcp"},
{"ris",                {NULL}, 180, "udp"},
{"unify",              {NULL}, 181, "tcp"},
{"unify",              {NULL}, 181, "udp"},
{"audit",              {NULL}, 182, "tcp"},
{"audit",              {NULL}, 182, "udp"},
{"ocbinder",           {NULL}, 183, "tcp"},
{"ocbinder",           {NULL}, 183, "udp"},
{"ocserver",           {NULL}, 184, "tcp"},
{"ocserver",           {NULL}, 184, "udp"},
{"remote-kis",         {NULL}, 185, "tcp"},
{"remote-kis",         {NULL}, 185, "udp"},
{"kis",                {NULL}, 186, "tcp"},
{"kis",                {NULL}, 186, "udp"},
{"aci",                {NULL}, 187, "tcp"},
{"aci",                {NULL}, 187, "udp"},
{"mumps",              {NULL}, 188, "tcp"},
{"mumps",              {NULL}, 188, "udp"},
{"qft",                {NULL}, 189, "tcp"},
{"qft",                {NULL}, 189, "udp"},
{"gacp",               {NULL}, 190, "tcp"},
{"gacp",               {NULL}, 190, "udp"},
{"prospero",           {NULL}, 191, "tcp"},
{"prospero",           {NULL}, 191, "udp"},
{"osu-nms",            {NULL}, 192, "tcp"},
{"osu-nms",            {NULL}, 192, "udp"},
{"srmp",               {NULL}, 193, "tcp"},
{"srmp",               {NULL}, 193, "udp"},
{"irc",                {NULL}, 194, "tcp"},
{"irc",                {NULL}, 194, "udp"},
{"dn6-nlm-aud",        {NULL}, 195, "tcp"},
{"dn6-nlm-aud",        {NULL}, 195, "udp"},
{"dn6-smm-red",        {NULL}, 196, "tcp"},
{"dn6-smm-red",        {NULL}, 196, "udp"},
{"dls",                {NULL}, 197, "tcp"},
{"dls",                {NULL}, 197, "udp"},
{"dls-mon",            {NULL}, 198, "tcp"},
{"dls-mon",            {NULL}, 198, "udp"},
{"smux",               {NULL}, 199, "tcp"},
{"smux",               {NULL}, 199, "udp"},
{"src",                {NULL}, 200, "tcp"},
{"src",                {NULL}, 200, "udp"},
{"at-rtmp",            {NULL}, 201, "tcp"},
{"at-rtmp",            {NULL}, 201, "udp"},
{"at-nbp",             {NULL}, 202, "tcp"},
{"at-nbp",             {NULL}, 202, "udp"},
{"at-3",               {NULL}, 203, "tcp"},
{"at-3",               {NULL}, 203, "udp"},
{"at-echo",            {NULL}, 204, "tcp"},
{"at-echo",            {NULL}, 204, "udp"},
{"at-5",               {NULL}, 205, "tcp"},
{"at-5",               {NULL}, 205, "udp"},
{"at-zis",             {NULL}, 206, "tcp"},
{"at-zis",             {NULL}, 206, "udp"},
{"at-7",               {NULL}, 207, "tcp"},
{"at-7",               {NULL}, 207, "udp"},
{"at-8",               {NULL}, 208, "tcp"},
{"at-8",               {NULL}, 208, "udp"},
{"qmtp",               {NULL}, 209, "tcp"},
{"qmtp",               {NULL}, 209, "udp"},
{"z39.50",             {NULL}, 210, "tcp"},
{"z39.50",             {NULL}, 210, "udp"},
{"914c/g",             {NULL}, 211, "tcp"},
{"914c/g",             {NULL}, 211, "udp"},
{"anet",               {NULL}, 212, "tcp"},
{"anet",               {NULL}, 212, "udp"},
{"ipx",                {NULL}, 213, "tcp"},
{"ipx",                {NULL}, 213, "udp"},
{"vmpwscs",            {NULL}, 214, "tcp"},
{"vmpwscs",            {NULL}, 214, "udp"},
{"softpc",             {NULL}, 215, "tcp"},
{"softpc",             {NULL}, 215, "udp"},
{"CAIlic",             {NULL}, 216, "tcp"},
{"CAIlic",             {NULL}, 216, "udp"},
{"dbase",              {NULL}, 217, "tcp"},
{"dbase",              {NULL}, 217, "udp"},
{"mpp",                {NULL}, 218, "tcp"},
{"mpp",                {NULL}, 218, "udp"},
{"uarps",              {NULL}, 219, "tcp"},
{"uarps",              {NULL}, 219, "udp"},
{"imap3",              {NULL}, 220, "tcp"},
{"imap3",              {NULL}, 220, "udp"},
{"fln-spx",            {NULL}, 221, "tcp"},
{"fln-spx",            {NULL}, 221, "udp"},
{"rsh-spx",            {NULL}, 222, "tcp"},
{"rsh-spx",            {NULL}, 222, "udp"},
{"cdc",                {NULL}, 223, "tcp"},
{"cdc",                {NULL}, 223, "udp"},
{"masqdialer",         {NULL}, 224, "tcp"},
{"masqdialer",         {NULL}, 224, "udp"},
{"direct",             {NULL}, 242, "tcp"},
{"direct",             {NULL}, 242, "udp"},
{"sur-meas",           {NULL}, 243, "tcp"},
{"sur-meas",           {NULL}, 243, "udp"},
{"inbusiness",         {NULL}, 244, "tcp"},
{"inbusiness",         {NULL}, 244, "udp"},
{"link",               {NULL}, 245, "tcp"},
{"link",               {NULL}, 245, "udp"},
{"dsp3270",            {NULL}, 246, "tcp"},
{"dsp3270",            {NULL}, 246, "udp"},
{"subntbcst_tftp",     {NULL}, 247, "tcp"},
{"subntbcst_tftp",     {NULL}, 247, "udp"},
{"bhfhs",              {NULL}, 248, "tcp"},
{"bhfhs",              {NULL}, 248, "udp"},
{"rap",                {NULL}, 256, "tcp"},
{"rap",                {NULL}, 256, "udp"},
{"set",                {NULL}, 257, "tcp"},
{"set",                {NULL}, 257, "udp"},
{"esro-gen",           {NULL}, 259, "tcp"},
{"esro-gen",           {NULL}, 259, "udp"},
{"openport",           {NULL}, 260, "tcp"},
{"openport",           {NULL}, 260, "udp"},
{"nsiiops",            {NULL}, 261, "tcp"},
{"nsiiops",            {NULL}, 261, "udp"},
{"arcisdms",           {NULL}, 262, "tcp"},
{"arcisdms",           {NULL}, 262, "udp"},
{"hdap",               {NULL}, 263, "tcp"},
{"hdap",               {NULL}, 263, "udp"},
{"bgmp",               {NULL}, 264, "tcp"},
{"bgmp",               {NULL}, 264, "udp"},
{"x-bone-ctl",         {NULL}, 265, "tcp"},
{"x-bone-ctl",         {NULL}, 265, "udp"},
{"sst",                {NULL}, 266, "tcp"},
{"sst",                {NULL}, 266, "udp"},
{"td-service",         {NULL}, 267, "tcp"},
{"td-service",         {NULL}, 267, "udp"},
{"td-replica",         {NULL}, 268, "tcp"},
{"td-replica",         {NULL}, 268, "udp"},
{"manet",              {NULL}, 269, "tcp"},
{"manet",              {NULL}, 269, "udp"},
{"gist",               {NULL}, 270, "udp"},
{"http-mgmt",          {NULL}, 280, "tcp"},
{"http-mgmt",          {NULL}, 280, "udp"},
{"personal-link",      {NULL}, 281, "tcp"},
{"personal-link",      {NULL}, 281, "udp"},
{"cableport-ax",       {NULL}, 282, "tcp"},
{"cableport-ax",       {NULL}, 282, "udp"},
{"rescap",             {NULL}, 283, "tcp"},
{"rescap",             {NULL}, 283, "udp"},
{"corerjd",            {NULL}, 284, "tcp"},
{"corerjd",            {NULL}, 284, "udp"},
{"fxp",                {NULL}, 286, "tcp"},
{"fxp",                {NULL}, 286, "udp"},
{"k-block",            {NULL}, 287, "tcp"},
{"k-block",            {NULL}, 287, "udp"},
{"novastorbakcup",     {NULL}, 308, "tcp"},
{"novastorbakcup",     {NULL}, 308, "udp"},
{"entrusttime",        {NULL}, 309, "tcp"},
{"entrusttime",        {NULL}, 309, "udp"},
{"bhmds",              {NULL}, 310, "tcp"},
{"bhmds",              {NULL}, 310, "udp"},
{"asip-webadmin",      {NULL}, 311, "tcp"},
{"asip-webadmin",      {NULL}, 311, "udp"},
{"vslmp",              {NULL}, 312, "tcp"},
{"vslmp",              {NULL}, 312, "udp"},
{"magenta-logic",      {NULL}, 313, "tcp"},
{"magenta-logic",      {NULL}, 313, "udp"},
{"opalis-robot",       {NULL}, 314, "tcp"},
{"opalis-robot",       {NULL}, 314, "udp"},
{"dpsi",               {NULL}, 315, "tcp"},
{"dpsi",               {NULL}, 315, "udp"},
{"decauth",            {NULL}, 316, "tcp"},
{"decauth",            {NULL}, 316, "udp"},
{"zannet",             {NULL}, 317, "tcp"},
{"zannet",             {NULL}, 317, "udp"},
{"pkix-timestamp",     {NULL}, 318, "tcp"},
{"pkix-timestamp",     {NULL}, 318, "udp"},
{"ptp-event",          {NULL}, 319, "tcp"},
{"ptp-event",          {NULL}, 319, "udp"},
{"ptp-general",        {NULL}, 320, "tcp"},
{"ptp-general",        {NULL}, 320, "udp"},
{"pip",                {NULL}, 321, "tcp"},
{"pip",                {NULL}, 321, "udp"},
{"rtsps",              {NULL}, 322, "tcp"},
{"rtsps",              {NULL}, 322, "udp"},
{"texar",              {NULL}, 333, "tcp"},
{"texar",              {NULL}, 333, "udp"},
{"pdap",               {NULL}, 344, "tcp"},
{"pdap",               {NULL}, 344, "udp"},
{"pawserv",            {NULL}, 345, "tcp"},
{"pawserv",            {NULL}, 345, "udp"},
{"zserv",              {NULL}, 346, "tcp"},
{"zserv",              {NULL}, 346, "udp"},
{"fatserv",            {NULL}, 347, "tcp"},
{"fatserv",            {NULL}, 347, "udp"},
{"csi-sgwp",           {NULL}, 348, "tcp"},
{"csi-sgwp",           {NULL}, 348, "udp"},
{"mftp",               {NULL}, 349, "tcp"},
{"mftp",               {NULL}, 349, "udp"},
{"matip-type-a",       {NULL}, 350, "tcp"},
{"matip-type-a",       {NULL}, 350, "udp"},
{"matip-type-b",       {NULL}, 351, "tcp"},
{"matip-type-b",       {NULL}, 351, "udp"},
{"bhoetty",            {NULL}, 351, "tcp"},
{"bhoetty",            {NULL}, 351, "udp"},
{"dtag-ste-sb",        {NULL}, 352, "tcp"},
{"dtag-ste-sb",        {NULL}, 352, "udp"},
{"bhoedap4",           {NULL}, 352, "tcp"},
{"bhoedap4",           {NULL}, 352, "udp"},
{"ndsauth",            {NULL}, 353, "tcp"},
{"ndsauth",            {NULL}, 353, "udp"},
{"bh611",              {NULL}, 354, "tcp"},
{"bh611",              {NULL}, 354, "udp"},
{"datex-asn",          {NULL}, 355, "tcp"},
{"datex-asn",          {NULL}, 355, "udp"},
{"cloanto-net-1",      {NULL}, 356, "tcp"},
{"cloanto-net-1",      {NULL}, 356, "udp"},
{"bhevent",            {NULL}, 357, "tcp"},
{"bhevent",            {NULL}, 357, "udp"},
{"shrinkwrap",         {NULL}, 358, "tcp"},
{"shrinkwrap",         {NULL}, 358, "udp"},
{"nsrmp",              {NULL}, 359, "tcp"},
{"nsrmp",              {NULL}, 359, "udp"},
{"scoi2odialog",       {NULL}, 360, "tcp"},
{"scoi2odialog",       {NULL}, 360, "udp"},
{"semantix",           {NULL}, 361, "tcp"},
{"semantix",           {NULL}, 361, "udp"},
{"srssend",            {NULL}, 362, "tcp"},
{"srssend",            {NULL}, 362, "udp"},
{"rsvp_tunnel",        {NULL}, 363, "tcp"},
{"rsvp_tunnel",        {NULL}, 363, "udp"},
{"aurora-cmgr",        {NULL}, 364, "tcp"},
{"aurora-cmgr",        {NULL}, 364, "udp"},
{"dtk",                {NULL}, 365, "tcp"},
{"dtk",                {NULL}, 365, "udp"},
{"odmr",               {NULL}, 366, "tcp"},
{"odmr",               {NULL}, 366, "udp"},
{"mortgageware",       {NULL}, 367, "tcp"},
{"mortgageware",       {NULL}, 367, "udp"},
{"qbikgdp",            {NULL}, 368, "tcp"},
{"qbikgdp",            {NULL}, 368, "udp"},
{"rpc2portmap",        {NULL}, 369, "tcp"},
{"rpc2portmap",        {NULL}, 369, "udp"},
{"codaauth2",          {NULL}, 370, "tcp"},
{"codaauth2",          {NULL}, 370, "udp"},
{"clearcase",          {NULL}, 371, "tcp"},
{"clearcase",          {NULL}, 371, "udp"},
{"ulistproc",          {NULL}, 372, "tcp"},
{"ulistproc",          {NULL}, 372, "udp"},
{"legent-1",           {NULL}, 373, "tcp"},
{"legent-1",           {NULL}, 373, "udp"},
{"legent-2",           {NULL}, 374, "tcp"},
{"legent-2",           {NULL}, 374, "udp"},
{"hassle",             {NULL}, 375, "tcp"},
{"hassle",             {NULL}, 375, "udp"},
{"nip",                {NULL}, 376, "tcp"},
{"nip",                {NULL}, 376, "udp"},
{"tnETOS",             {NULL}, 377, "tcp"},
{"tnETOS",             {NULL}, 377, "udp"},
{"dsETOS",             {NULL}, 378, "tcp"},
{"dsETOS",             {NULL}, 378, "udp"},
{"is99c",              {NULL}, 379, "tcp"},
{"is99c",              {NULL}, 379, "udp"},
{"is99s",              {NULL}, 380, "tcp"},
{"is99s",              {NULL}, 380, "udp"},
{"hp-collector",       {NULL}, 381, "tcp"},
{"hp-collector",       {NULL}, 381, "udp"},
{"hp-managed-node",    {NULL}, 382, "tcp"},
{"hp-managed-node",    {NULL}, 382, "udp"},
{"hp-alarm-mgr",       {NULL}, 383, "tcp"},
{"hp-alarm-mgr",       {NULL}, 383, "udp"},
{"arns",               {NULL}, 384, "tcp"},
{"arns",               {NULL}, 384, "udp"},
{"ibm-app",            {NULL}, 385, "tcp"},
{"ibm-app",            {NULL}, 385, "udp"},
{"asa",                {NULL}, 386, "tcp"},
{"asa",                {NULL}, 386, "udp"},
{"aurp",               {NULL}, 387, "tcp"},
{"aurp",               {NULL}, 387, "udp"},
{"unidata-ldm",        {NULL}, 388, "tcp"},
{"unidata-ldm",        {NULL}, 388, "udp"},
{"ldap",               {NULL}, 389, "tcp"},
{"ldap",               {NULL}, 389, "udp"},
{"uis",                {NULL}, 390, "tcp"},
{"uis",                {NULL}, 390, "udp"},
{"synotics-relay",     {NULL}, 391, "tcp"},
{"synotics-relay",     {NULL}, 391, "udp"},
{"synotics-broker",    {NULL}, 392, "tcp"},
{"synotics-broker",    {NULL}, 392, "udp"},
{"meta5",              {NULL}, 393, "tcp"},
{"meta5",              {NULL}, 393, "udp"},
{"embl-ndt",           {NULL}, 394, "tcp"},
{"embl-ndt",           {NULL}, 394, "udp"},
{"netcp",              {NULL}, 395, "tcp"},
{"netcp",              {NULL}, 395, "udp"},
{"netware-ip",         {NULL}, 396, "tcp"},
{"netware-ip",         {NULL}, 396, "udp"},
{"mptn",               {NULL}, 397, "tcp"},
{"mptn",               {NULL}, 397, "udp"},
{"kryptolan",          {NULL}, 398, "tcp"},
{"kryptolan",          {NULL}, 398, "udp"},
{"iso-tsap-c2",        {NULL}, 399, "tcp"},
{"iso-tsap-c2",        {NULL}, 399, "udp"},
{"osb-sd",             {NULL}, 400, "tcp"},
{"osb-sd",             {NULL}, 400, "udp"},
{"ups",                {NULL}, 401, "tcp"},
{"ups",                {NULL}, 401, "udp"},
{"genie",              {NULL}, 402, "tcp"},
{"genie",              {NULL}, 402, "udp"},
{"decap",              {NULL}, 403, "tcp"},
{"decap",              {NULL}, 403, "udp"},
{"nced",               {NULL}, 404, "tcp"},
{"nced",               {NULL}, 404, "udp"},
{"ncld",               {NULL}, 405, "tcp"},
{"ncld",               {NULL}, 405, "udp"},
{"imsp",               {NULL}, 406, "tcp"},
{"imsp",               {NULL}, 406, "udp"},
{"timbuktu",           {NULL}, 407, "tcp"},
{"timbuktu",           {NULL}, 407, "udp"},
{"prm-sm",             {NULL}, 408, "tcp"},
{"prm-sm",             {NULL}, 408, "udp"},
{"prm-nm",             {NULL}, 409, "tcp"},
{"prm-nm",             {NULL}, 409, "udp"},
{"decladebug",         {NULL}, 410, "tcp"},
{"decladebug",         {NULL}, 410, "udp"},
{"rmt",                {NULL}, 411, "tcp"},
{"rmt",                {NULL}, 411, "udp"},
{"synoptics-trap",     {NULL}, 412, "tcp"},
{"synoptics-trap",     {NULL}, 412, "udp"},
{"smsp",               {NULL}, 413, "tcp"},
{"smsp",               {NULL}, 413, "udp"},
{"infoseek",           {NULL}, 414, "tcp"},
{"infoseek",           {NULL}, 414, "udp"},
{"bnet",               {NULL}, 415, "tcp"},
{"bnet",               {NULL}, 415, "udp"},
{"silverplatter",      {NULL}, 416, "tcp"},
{"silverplatter",      {NULL}, 416, "udp"},
{"onmux",              {NULL}, 417, "tcp"},
{"onmux",              {NULL}, 417, "udp"},
{"hyper-g",            {NULL}, 418, "tcp"},
{"hyper-g",            {NULL}, 418, "udp"},
{"ariel1",             {NULL}, 419, "tcp"},
{"ariel1",             {NULL}, 419, "udp"},
{"smpte",              {NULL}, 420, "tcp"},
{"smpte",              {NULL}, 420, "udp"},
{"ariel2",             {NULL}, 421, "tcp"},
{"ariel2",             {NULL}, 421, "udp"},
{"ariel3",             {NULL}, 422, "tcp"},
{"ariel3",             {NULL}, 422, "udp"},
{"opc-job-start",      {NULL}, 423, "tcp"},
{"opc-job-start",      {NULL}, 423, "udp"},
{"opc-job-track",      {NULL}, 424, "tcp"},
{"opc-job-track",      {NULL}, 424, "udp"},
{"icad-el",            {NULL}, 425, "tcp"},
{"icad-el",            {NULL}, 425, "udp"},
{"smartsdp",           {NULL}, 426, "tcp"},
{"smartsdp",           {NULL}, 426, "udp"},
{"svrloc",             {NULL}, 427, "tcp"},
{"svrloc",             {NULL}, 427, "udp"},
{"ocs_cmu",            {NULL}, 428, "tcp"},
{"ocs_cmu",            {NULL}, 428, "udp"},
{"ocs_amu",            {NULL}, 429, "tcp"},
{"ocs_amu",            {NULL}, 429, "udp"},
{"utmpsd",             {NULL}, 430, "tcp"},
{"utmpsd",             {NULL}, 430, "udp"},
{"utmpcd",             {NULL}, 431, "tcp"},
{"utmpcd",             {NULL}, 431, "udp"},
{"iasd",               {NULL}, 432, "tcp"},
{"iasd",               {NULL}, 432, "udp"},
{"nnsp",               {NULL}, 433, "tcp"},
{"nnsp",               {NULL}, 433, "udp"},
{"mobileip-agent",     {NULL}, 434, "tcp"},
{"mobileip-agent",     {NULL}, 434, "udp"},
{"mobilip-mn",         {NULL}, 435, "tcp"},
{"mobilip-mn",         {NULL}, 435, "udp"},
{"dna-cml",            {NULL}, 436, "tcp"},
{"dna-cml",            {NULL}, 436, "udp"},
{"comscm",             {NULL}, 437, "tcp"},
{"comscm",             {NULL}, 437, "udp"},
{"dsfgw",              {NULL}, 438, "tcp"},
{"dsfgw",              {NULL}, 438, "udp"},
{"dasp",               {NULL}, 439, "tcp"},
{"dasp",               {NULL}, 439, "udp"},
{"sgcp",               {NULL}, 440, "tcp"},
{"sgcp",               {NULL}, 440, "udp"},
{"decvms-sysmgt",      {NULL}, 441, "tcp"},
{"decvms-sysmgt",      {NULL}, 441, "udp"},
{"cvc_hostd",          {NULL}, 442, "tcp"},
{"cvc_hostd",          {NULL}, 442, "udp"},
{"https",              {NULL}, 443, "tcp"},
{"https",              {NULL}, 443, "udp"},
{"https",              {NULL}, 443, "sctp"},
{"snpp",               {NULL}, 444, "tcp"},
{"snpp",               {NULL}, 444, "udp"},
{"microsoft-ds",       {NULL}, 445, "tcp"},
{"microsoft-ds",       {NULL}, 445, "udp"},
{"ddm-rdb",            {NULL}, 446, "tcp"},
{"ddm-rdb",            {NULL}, 446, "udp"},
{"ddm-dfm",            {NULL}, 447, "tcp"},
{"ddm-dfm",            {NULL}, 447, "udp"},
{"ddm-ssl",            {NULL}, 448, "tcp"},
{"ddm-ssl",            {NULL}, 448, "udp"},
{"as-servermap",       {NULL}, 449, "tcp"},
{"as-servermap",       {NULL}, 449, "udp"},
{"tserver",            {NULL}, 450, "tcp"},
{"tserver",            {NULL}, 450, "udp"},
{"sfs-smp-net",        {NULL}, 451, "tcp"},
{"sfs-smp-net",        {NULL}, 451, "udp"},
{"sfs-config",         {NULL}, 452, "tcp"},
{"sfs-config",         {NULL}, 452, "udp"},
{"creativeserver",     {NULL}, 453, "tcp"},
{"creativeserver",     {NULL}, 453, "udp"},
{"contentserver",      {NULL}, 454, "tcp"},
{"contentserver",      {NULL}, 454, "udp"},
{"creativepartnr",     {NULL}, 455, "tcp"},
{"creativepartnr",     {NULL}, 455, "udp"},
{"macon-tcp",          {NULL}, 456, "tcp"},
{"macon-udp",          {NULL}, 456, "udp"},
{"scohelp",            {NULL}, 457, "tcp"},
{"scohelp",            {NULL}, 457, "udp"},
{"appleqtc",           {NULL}, 458, "tcp"},
{"appleqtc",           {NULL}, 458, "udp"},
{"ampr-rcmd",          {NULL}, 459, "tcp"},
{"ampr-rcmd",          {NULL}, 459, "udp"},
{"skronk",             {NULL}, 460, "tcp"},
{"skronk",             {NULL}, 460, "udp"},
{"datasurfsrv",        {NULL}, 461, "tcp"},
{"datasurfsrv",        {NULL}, 461, "udp"},
{"datasurfsrvsec",     {NULL}, 462, "tcp"},
{"datasurfsrvsec",     {NULL}, 462, "udp"},
{"alpes",              {NULL}, 463, "tcp"},
{"alpes",              {NULL}, 463, "udp"},
{"kpasswd",            {NULL}, 464, "tcp"},
{"kpasswd",            {NULL}, 464, "udp"},
{"urd",                {NULL}, 465, "tcp"},
{"igmpv3lite",         {NULL}, 465, "udp"},
{"digital-vrc",        {NULL}, 466, "tcp"},
{"digital-vrc",        {NULL}, 466, "udp"},
{"mylex-mapd",         {NULL}, 467, "tcp"},
{"mylex-mapd",         {NULL}, 467, "udp"},
{"photuris",           {NULL}, 468, "tcp"},
{"photuris",           {NULL}, 468, "udp"},
{"rcp",                {NULL}, 469, "tcp"},
{"rcp",                {NULL}, 469, "udp"},
{"scx-proxy",          {NULL}, 470, "tcp"},
{"scx-proxy",          {NULL}, 470, "udp"},
{"mondex",             {NULL}, 471, "tcp"},
{"mondex",             {NULL}, 471, "udp"},
{"ljk-login",          {NULL}, 472, "tcp"},
{"ljk-login",          {NULL}, 472, "udp"},
{"hybrid-pop",         {NULL}, 473, "tcp"},
{"hybrid-pop",         {NULL}, 473, "udp"},
{"tn-tl-w1",           {NULL}, 474, "tcp"},
{"tn-tl-w2",           {NULL}, 474, "udp"},
{"tcpnethaspsrv",      {NULL}, 475, "tcp"},
{"tcpnethaspsrv",      {NULL}, 475, "udp"},
{"tn-tl-fd1",          {NULL}, 476, "tcp"},
{"tn-tl-fd1",          {NULL}, 476, "udp"},
{"ss7ns",              {NULL}, 477, "tcp"},
{"ss7ns",              {NULL}, 477, "udp"},
{"spsc",               {NULL}, 478, "tcp"},
{"spsc",               {NULL}, 478, "udp"},
{"iafserver",          {NULL}, 479, "tcp"},
{"iafserver",          {NULL}, 479, "udp"},
{"iafdbase",           {NULL}, 480, "tcp"},
{"iafdbase",           {NULL}, 480, "udp"},
{"ph",                 {NULL}, 481, "tcp"},
{"ph",                 {NULL}, 481, "udp"},
{"bgs-nsi",            {NULL}, 482, "tcp"},
{"bgs-nsi",            {NULL}, 482, "udp"},
{"ulpnet",             {NULL}, 483, "tcp"},
{"ulpnet",             {NULL}, 483, "udp"},
{"integra-sme",        {NULL}, 484, "tcp"},
{"integra-sme",        {NULL}, 484, "udp"},
{"powerburst",         {NULL}, 485, "tcp"},
{"powerburst",         {NULL}, 485, "udp"},
{"avian",              {NULL}, 486, "tcp"},
{"avian",              {NULL}, 486, "udp"},
{"saft",               {NULL}, 487, "tcp"},
{"saft",               {NULL}, 487, "udp"},
{"gss-http",           {NULL}, 488, "tcp"},
{"gss-http",           {NULL}, 488, "udp"},
{"nest-protocol",      {NULL}, 489, "tcp"},
{"nest-protocol",      {NULL}, 489, "udp"},
{"micom-pfs",          {NULL}, 490, "tcp"},
{"micom-pfs",          {NULL}, 490, "udp"},
{"go-login",           {NULL}, 491, "tcp"},
{"go-login",           {NULL}, 491, "udp"},
{"ticf-1",             {NULL}, 492, "tcp"},
{"ticf-1",             {NULL}, 492, "udp"},
{"ticf-2",             {NULL}, 493, "tcp"},
{"ticf-2",             {NULL}, 493, "udp"},
{"pov-ray",            {NULL}, 494, "tcp"},
{"pov-ray",            {NULL}, 494, "udp"},
{"intecourier",        {NULL}, 495, "tcp"},
{"intecourier",        {NULL}, 495, "udp"},
{"pim-rp-disc",        {NULL}, 496, "tcp"},
{"pim-rp-disc",        {NULL}, 496, "udp"},
{"dantz",              {NULL}, 497, "tcp"},
{"dantz",              {NULL}, 497, "udp"},
{"siam",               {NULL}, 498, "tcp"},
{"siam",               {NULL}, 498, "udp"},
{"iso-ill",            {NULL}, 499, "tcp"},
{"iso-ill",            {NULL}, 499, "udp"},
{"isakmp",             {NULL}, 500, "tcp"},
{"isakmp",             {NULL}, 500, "udp"},
{"stmf",               {NULL}, 501, "tcp"},
{"stmf",               {NULL}, 501, "udp"},
{"asa-appl-proto",     {NULL}, 502, "tcp"},
{"asa-appl-proto",     {NULL}, 502, "udp"},
{"intrinsa",           {NULL}, 503, "tcp"},
{"intrinsa",           {NULL}, 503, "udp"},
{"citadel",            {NULL}, 504, "tcp"},
{"citadel",            {NULL}, 504, "udp"},
{"mailbox-lm",         {NULL}, 505, "tcp"},
{"mailbox-lm",         {NULL}, 505, "udp"},
{"ohimsrv",            {NULL}, 506, "tcp"},
{"ohimsrv",            {NULL}, 506, "udp"},
{"crs",                {NULL}, 507, "tcp"},
{"crs",                {NULL}, 507, "udp"},
{"xvttp",              {NULL}, 508, "tcp"},
{"xvttp",              {NULL}, 508, "udp"},
{"snare",              {NULL}, 509, "tcp"},
{"snare",              {NULL}, 509, "udp"},
{"fcp",                {NULL}, 510, "tcp"},
{"fcp",                {NULL}, 510, "udp"},
{"passgo",             {NULL}, 511, "tcp"},
{"passgo",             {NULL}, 511, "udp"},
{"exec",               {NULL}, 512, "tcp"},
{"comsat",             {NULL}, 512, "udp"},
{"biff",               {NULL}, 512, "udp"},
{"login",              {NULL}, 513, "tcp"},
{"who",                {NULL}, 513, "udp"},
{"shell",              {NULL}, 514, "tcp"},
{"syslog",             {NULL}, 514, "udp"},
{"printer",            {NULL}, 515, "tcp"},
{"printer",            {NULL}, 515, "udp"},
{"videotex",           {NULL}, 516, "tcp"},
{"videotex",           {NULL}, 516, "udp"},
{"talk",               {NULL}, 517, "tcp"},
{"talk",               {NULL}, 517, "udp"},
{"ntalk",              {NULL}, 518, "tcp"},
{"ntalk",              {NULL}, 518, "udp"},
{"utime",              {NULL}, 519, "tcp"},
{"utime",              {NULL}, 519, "udp"},
{"efs",                {NULL}, 520, "tcp"},
{"router",             {NULL}, 520, "udp"},
{"ripng",              {NULL}, 521, "tcp"},
{"ripng",              {NULL}, 521, "udp"},
{"ulp",                {NULL}, 522, "tcp"},
{"ulp",                {NULL}, 522, "udp"},
{"ibm-db2",            {NULL}, 523, "tcp"},
{"ibm-db2",            {NULL}, 523, "udp"},
{"ncp",                {NULL}, 524, "tcp"},
{"ncp",                {NULL}, 524, "udp"},
{"timed",              {NULL}, 525, "tcp"},
{"timed",              {NULL}, 525, "udp"},
{"tempo",              {NULL}, 526, "tcp"},
{"tempo",              {NULL}, 526, "udp"},
{"stx",                {NULL}, 527, "tcp"},
{"stx",                {NULL}, 527, "udp"},
{"custix",             {NULL}, 528, "tcp"},
{"custix",             {NULL}, 528, "udp"},
{"irc-serv",           {NULL}, 529, "tcp"},
{"irc-serv",           {NULL}, 529, "udp"},
{"courier",            {NULL}, 530, "tcp"},
{"courier",            {NULL}, 530, "udp"},
{"conference",         {NULL}, 531, "tcp"},
{"conference",         {NULL}, 531, "udp"},
{"netnews",            {NULL}, 532, "tcp"},
{"netnews",            {NULL}, 532, "udp"},
{"netwall",            {NULL}, 533, "tcp"},
{"netwall",            {NULL}, 533, "udp"},
{"windream",           {NULL}, 534, "tcp"},
{"windream",           {NULL}, 534, "udp"},
{"iiop",               {NULL}, 535, "tcp"},
{"iiop",               {NULL}, 535, "udp"},
{"opalis-rdv",         {NULL}, 536, "tcp"},
{"opalis-rdv",         {NULL}, 536, "udp"},
{"nmsp",               {NULL}, 537, "tcp"},
{"nmsp",               {NULL}, 537, "udp"},
{"gdomap",             {NULL}, 538, "tcp"},
{"gdomap",             {NULL}, 538, "udp"},
{"apertus-ldp",        {NULL}, 539, "tcp"},
{"apertus-ldp",        {NULL}, 539, "udp"},
{"uucp",               {NULL}, 540, "tcp"},
{"uucp",               {NULL}, 540, "udp"},
{"uucp-rlogin",        {NULL}, 541, "tcp"},
{"uucp-rlogin",        {NULL}, 541, "udp"},
{"commerce",           {NULL}, 542, "tcp"},
{"commerce",           {NULL}, 542, "udp"},
{"klogin",             {NULL}, 543, "tcp"},
{"klogin",             {NULL}, 543, "udp"},
{"kshell",             {NULL}, 544, "tcp"},
{"kshell",             {NULL}, 544, "udp"},
{"appleqtcsrvr",       {NULL}, 545, "tcp"},
{"appleqtcsrvr",       {NULL}, 545, "udp"},
{"dhcpv6-client",      {NULL}, 546, "tcp"},
{"dhcpv6-client",      {NULL}, 546, "udp"},
{"dhcpv6-server",      {NULL}, 547, "tcp"},
{"dhcpv6-server",      {NULL}, 547, "udp"},
{"afpovertcp",         {NULL}, 548, "tcp"},
{"afpovertcp",         {NULL}, 548, "udp"},
{"idfp",               {NULL}, 549, "tcp"},
{"idfp",               {NULL}, 549, "udp"},
{"new-rwho",           {NULL}, 550, "tcp"},
{"new-rwho",           {NULL}, 550, "udp"},
{"cybercash",          {NULL}, 551, "tcp"},
{"cybercash",          {NULL}, 551, "udp"},
{"devshr-nts",         {NULL}, 552, "tcp"},
{"devshr-nts",         {NULL}, 552, "udp"},
{"pirp",               {NULL}, 553, "tcp"},
{"pirp",               {NULL}, 553, "udp"},
{"rtsp",               {NULL}, 554, "tcp"},
{"rtsp",               {NULL}, 554, "udp"},
{"dsf",                {NULL}, 555, "tcp"},
{"dsf",                {NULL}, 555, "udp"},
{"remotefs",           {NULL}, 556, "tcp"},
{"remotefs",           {NULL}, 556, "udp"},
{"openvms-sysipc",     {NULL}, 557, "tcp"},
{"openvms-sysipc",     {NULL}, 557, "udp"},
{"sdnskmp",            {NULL}, 558, "tcp"},
{"sdnskmp",            {NULL}, 558, "udp"},
{"teedtap",            {NULL}, 559, "tcp"},
{"teedtap",            {NULL}, 559, "udp"},
{"rmonitor",           {NULL}, 560, "tcp"},
{"rmonitor",           {NULL}, 560, "udp"},
{"monitor",            {NULL}, 561, "tcp"},
{"monitor",            {NULL}, 561, "udp"},
{"chshell",            {NULL}, 562, "tcp"},
{"chshell",            {NULL}, 562, "udp"},
{"nntps",              {NULL}, 563, "tcp"},
{"nntps",              {NULL}, 563, "udp"},
{"9pfs",               {NULL}, 564, "tcp"},
{"9pfs",               {NULL}, 564, "udp"},
{"whoami",             {NULL}, 565, "tcp"},
{"whoami",             {NULL}, 565, "udp"},
{"streettalk",         {NULL}, 566, "tcp"},
{"streettalk",         {NULL}, 566, "udp"},
{"banyan-rpc",         {NULL}, 567, "tcp"},
{"banyan-rpc",         {NULL}, 567, "udp"},
{"ms-shuttle",         {NULL}, 568, "tcp"},
{"ms-shuttle",         {NULL}, 568, "udp"},
{"ms-rome",            {NULL}, 569, "tcp"},
{"ms-rome",            {NULL}, 569, "udp"},
{"meter",              {NULL}, 570, "tcp"},
{"meter",              {NULL}, 570, "udp"},
{"meter",              {NULL}, 571, "tcp"},
{"meter",              {NULL}, 571, "udp"},
{"sonar",              {NULL}, 572, "tcp"},
{"sonar",              {NULL}, 572, "udp"},
{"banyan-vip",         {NULL}, 573, "tcp"},
{"banyan-vip",         {NULL}, 573, "udp"},
{"ftp-agent",          {NULL}, 574, "tcp"},
{"ftp-agent",          {NULL}, 574, "udp"},
{"vemmi",              {NULL}, 575, "tcp"},
{"vemmi",              {NULL}, 575, "udp"},
{"ipcd",               {NULL}, 576, "tcp"},
{"ipcd",               {NULL}, 576, "udp"},
{"vnas",               {NULL}, 577, "tcp"},
{"vnas",               {NULL}, 577, "udp"},
{"ipdd",               {NULL}, 578, "tcp"},
{"ipdd",               {NULL}, 578, "udp"},
{"decbsrv",            {NULL}, 579, "tcp"},
{"decbsrv",            {NULL}, 579, "udp"},
{"sntp-heartbeat",     {NULL}, 580, "tcp"},
{"sntp-heartbeat",     {NULL}, 580, "udp"},
{"bdp",                {NULL}, 581, "tcp"},
{"bdp",                {NULL}, 581, "udp"},
{"scc-security",       {NULL}, 582, "tcp"},
{"scc-security",       {NULL}, 582, "udp"},
{"philips-vc",         {NULL}, 583, "tcp"},
{"philips-vc",         {NULL}, 583, "udp"},
{"keyserver",          {NULL}, 584, "tcp"},
{"keyserver",          {NULL}, 584, "udp"},
{"password-chg",       {NULL}, 586, "tcp"},
{"password-chg",       {NULL}, 586, "udp"},
{"submission",         {NULL}, 587, "tcp"},
{"submission",         {NULL}, 587, "udp"},
{"cal",                {NULL}, 588, "tcp"},
{"cal",                {NULL}, 588, "udp"},
{"eyelink",            {NULL}, 589, "tcp"},
{"eyelink",            {NULL}, 589, "udp"},
{"tns-cml",            {NULL}, 590, "tcp"},
{"tns-cml",            {NULL}, 590, "udp"},
{"http-alt",           {NULL}, 591, "tcp"},
{"http-alt",           {NULL}, 591, "udp"},
{"eudora-set",         {NULL}, 592, "tcp"},
{"eudora-set",         {NULL}, 592, "udp"},
{"http-rpc-epmap",     {NULL}, 593, "tcp"},
{"http-rpc-epmap",     {NULL}, 593, "udp"},
{"tpip",               {NULL}, 594, "tcp"},
{"tpip",               {NULL}, 594, "udp"},
{"cab-protocol",       {NULL}, 595, "tcp"},
{"cab-protocol",       {NULL}, 595, "udp"},
{"smsd",               {NULL}, 596, "tcp"},
{"smsd",               {NULL}, 596, "udp"},
{"ptcnameservice",     {NULL}, 597, "tcp"},
{"ptcnameservice",     {NULL}, 597, "udp"},
{"sco-websrvrmg3",     {NULL}, 598, "tcp"},
{"sco-websrvrmg3",     {NULL}, 598, "udp"},
{"acp",                {NULL}, 599, "tcp"},
{"acp",                {NULL}, 599, "udp"},
{"ipcserver",          {NULL}, 600, "tcp"},
{"ipcserver",          {NULL}, 600, "udp"},
{"syslog-conn",        {NULL}, 601, "tcp"},
{"syslog-conn",        {NULL}, 601, "udp"},
{"xmlrpc-beep",        {NULL}, 602, "tcp"},
{"xmlrpc-beep",        {NULL}, 602, "udp"},
{"idxp",               {NULL}, 603, "tcp"},
{"idxp",               {NULL}, 603, "udp"},
{"tunnel",             {NULL}, 604, "tcp"},
{"tunnel",             {NULL}, 604, "udp"},
{"soap-beep",          {NULL}, 605, "tcp"},
{"soap-beep",          {NULL}, 605, "udp"},
{"urm",                {NULL}, 606, "tcp"},
{"urm",                {NULL}, 606, "udp"},
{"nqs",                {NULL}, 607, "tcp"},
{"nqs",                {NULL}, 607, "udp"},
{"sift-uft",           {NULL}, 608, "tcp"},
{"sift-uft",           {NULL}, 608, "udp"},
{"npmp-trap",          {NULL}, 609, "tcp"},
{"npmp-trap",          {NULL}, 609, "udp"},
{"npmp-local",         {NULL}, 610, "tcp"},
{"npmp-local",         {NULL}, 610, "udp"},
{"npmp-gui",           {NULL}, 611, "tcp"},
{"npmp-gui",           {NULL}, 611, "udp"},
{"hmmp-ind",           {NULL}, 612, "tcp"},
{"hmmp-ind",           {NULL}, 612, "udp"},
{"hmmp-op",            {NULL}, 613, "tcp"},
{"hmmp-op",            {NULL}, 613, "udp"},
{"sshell",             {NULL}, 614, "tcp"},
{"sshell",             {NULL}, 614, "udp"},
{"sco-inetmgr",        {NULL}, 615, "tcp"},
{"sco-inetmgr",        {NULL}, 615, "udp"},
{"sco-sysmgr",         {NULL}, 616, "tcp"},
{"sco-sysmgr",         {NULL}, 616, "udp"},
{"sco-dtmgr",          {NULL}, 617, "tcp"},
{"sco-dtmgr",          {NULL}, 617, "udp"},
{"dei-icda",           {NULL}, 618, "tcp"},
{"dei-icda",           {NULL}, 618, "udp"},
{"compaq-evm",         {NULL}, 619, "tcp"},
{"compaq-evm",         {NULL}, 619, "udp"},
{"sco-websrvrmgr",     {NULL}, 620, "tcp"},
{"sco-websrvrmgr",     {NULL}, 620, "udp"},
{"escp-ip",            {NULL}, 621, "tcp"},
{"escp-ip",            {NULL}, 621, "udp"},
{"collaborator",       {NULL}, 622, "tcp"},
{"collaborator",       {NULL}, 622, "udp"},
{"oob-ws-http",        {NULL}, 623, "tcp"},
{"asf-rmcp",           {NULL}, 623, "udp"},
{"cryptoadmin",        {NULL}, 624, "tcp"},
{"cryptoadmin",        {NULL}, 624, "udp"},
{"dec_dlm",            {NULL}, 625, "tcp"},
{"dec_dlm",            {NULL}, 625, "udp"},
{"asia",               {NULL}, 626, "tcp"},
{"asia",               {NULL}, 626, "udp"},
{"passgo-tivoli",      {NULL}, 627, "tcp"},
{"passgo-tivoli",      {NULL}, 627, "udp"},
{"qmqp",               {NULL}, 628, "tcp"},
{"qmqp",               {NULL}, 628, "udp"},
{"3com-amp3",          {NULL}, 629, "tcp"},
{"3com-amp3",          {NULL}, 629, "udp"},
{"rda",                {NULL}, 630, "tcp"},
{"rda",                {NULL}, 630, "udp"},
{"ipp",                {NULL}, 631, "tcp"},
{"ipp",                {NULL}, 631, "udp"},
{"bmpp",               {NULL}, 632, "tcp"},
{"bmpp",               {NULL}, 632, "udp"},
{"servstat",           {NULL}, 633, "tcp"},
{"servstat",           {NULL}, 633, "udp"},
{"ginad",              {NULL}, 634, "tcp"},
{"ginad",              {NULL}, 634, "udp"},
{"rlzdbase",           {NULL}, 635, "tcp"},
{"rlzdbase",           {NULL}, 635, "udp"},
{"ldaps",              {NULL}, 636, "tcp"},
{"ldaps",              {NULL}, 636, "udp"},
{"lanserver",          {NULL}, 637, "tcp"},
{"lanserver",          {NULL}, 637, "udp"},
{"mcns-sec",           {NULL}, 638, "tcp"},
{"mcns-sec",           {NULL}, 638, "udp"},
{"msdp",               {NULL}, 639, "tcp"},
{"msdp",               {NULL}, 639, "udp"},
{"entrust-sps",        {NULL}, 640, "tcp"},
{"entrust-sps",        {NULL}, 640, "udp"},
{"repcmd",             {NULL}, 641, "tcp"},
{"repcmd",             {NULL}, 641, "udp"},
{"esro-emsdp",         {NULL}, 642, "tcp"},
{"esro-emsdp",         {NULL}, 642, "udp"},
{"sanity",             {NULL}, 643, "tcp"},
{"sanity",             {NULL}, 643, "udp"},
{"dwr",                {NULL}, 644, "tcp"},
{"dwr",                {NULL}, 644, "udp"},
{"pssc",               {NULL}, 645, "tcp"},
{"pssc",               {NULL}, 645, "udp"},
{"ldp",                {NULL}, 646, "tcp"},
{"ldp",                {NULL}, 646, "udp"},
{"dhcp-failover",      {NULL}, 647, "tcp"},
{"dhcp-failover",      {NULL}, 647, "udp"},
{"rrp",                {NULL}, 648, "tcp"},
{"rrp",                {NULL}, 648, "udp"},
{"cadview-3d",         {NULL}, 649, "tcp"},
{"cadview-3d",         {NULL}, 649, "udp"},
{"obex",               {NULL}, 650, "tcp"},
{"obex",               {NULL}, 650, "udp"},
{"ieee-mms",           {NULL}, 651, "tcp"},
{"ieee-mms",           {NULL}, 651, "udp"},
{"hello-port",         {NULL}, 652, "tcp"},
{"hello-port",         {NULL}, 652, "udp"},
{"repscmd",            {NULL}, 653, "tcp"},
{"repscmd",            {NULL}, 653, "udp"},
{"aodv",               {NULL}, 654, "tcp"},
{"aodv",               {NULL}, 654, "udp"},
{"tinc",               {NULL}, 655, "tcp"},
{"tinc",               {NULL}, 655, "udp"},
{"spmp",               {NULL}, 656, "tcp"},
{"spmp",               {NULL}, 656, "udp"},
{"rmc",                {NULL}, 657, "tcp"},
{"rmc",                {NULL}, 657, "udp"},
{"tenfold",            {NULL}, 658, "tcp"},
{"tenfold",            {NULL}, 658, "udp"},
{"mac-srvr-admin",     {NULL}, 660, "tcp"},
{"mac-srvr-admin",     {NULL}, 660, "udp"},
{"hap",                {NULL}, 661, "tcp"},
{"hap",                {NULL}, 661, "udp"},
{"pftp",               {NULL}, 662, "tcp"},
{"pftp",               {NULL}, 662, "udp"},
{"purenoise",          {NULL}, 663, "tcp"},
{"purenoise",          {NULL}, 663, "udp"},
{"oob-ws-https",       {NULL}, 664, "tcp"},
{"asf-secure-rmcp",    {NULL}, 664, "udp"},
{"sun-dr",             {NULL}, 665, "tcp"},
{"sun-dr",             {NULL}, 665, "udp"},
{"mdqs",               {NULL}, 666, "tcp"},
{"mdqs",               {NULL}, 666, "udp"},
{"doom",               {NULL}, 666, "tcp"},
{"doom",               {NULL}, 666, "udp"},
{"disclose",           {NULL}, 667, "tcp"},
{"disclose",           {NULL}, 667, "udp"},
{"mecomm",             {NULL}, 668, "tcp"},
{"mecomm",             {NULL}, 668, "udp"},
{"meregister",         {NULL}, 669, "tcp"},
{"meregister",         {NULL}, 669, "udp"},
{"vacdsm-sws",         {NULL}, 670, "tcp"},
{"vacdsm-sws",         {NULL}, 670, "udp"},
{"vacdsm-app",         {NULL}, 671, "tcp"},
{"vacdsm-app",         {NULL}, 671, "udp"},
{"vpps-qua",           {NULL}, 672, "tcp"},
{"vpps-qua",           {NULL}, 672, "udp"},
{"cimplex",            {NULL}, 673, "tcp"},
{"cimplex",            {NULL}, 673, "udp"},
{"acap",               {NULL}, 674, "tcp"},
{"acap",               {NULL}, 674, "udp"},
{"dctp",               {NULL}, 675, "tcp"},
{"dctp",               {NULL}, 675, "udp"},
{"vpps-via",           {NULL}, 676, "tcp"},
{"vpps-via",           {NULL}, 676, "udp"},
{"vpp",                {NULL}, 677, "tcp"},
{"vpp",                {NULL}, 677, "udp"},
{"ggf-ncp",            {NULL}, 678, "tcp"},
{"ggf-ncp",            {NULL}, 678, "udp"},
{"mrm",                {NULL}, 679, "tcp"},
{"mrm",                {NULL}, 679, "udp"},
{"entrust-aaas",       {NULL}, 680, "tcp"},
{"entrust-aaas",       {NULL}, 680, "udp"},
{"entrust-aams",       {NULL}, 681, "tcp"},
{"entrust-aams",       {NULL}, 681, "udp"},
{"xfr",                {NULL}, 682, "tcp"},
{"xfr",                {NULL}, 682, "udp"},
{"corba-iiop",         {NULL}, 683, "tcp"},
{"corba-iiop",         {NULL}, 683, "udp"},
{"corba-iiop-ssl",     {NULL}, 684, "tcp"},
{"corba-iiop-ssl",     {NULL}, 684, "udp"},
{"mdc-portmapper",     {NULL}, 685, "tcp"},
{"mdc-portmapper",     {NULL}, 685, "udp"},
{"hcp-wismar",         {NULL}, 686, "tcp"},
{"hcp-wismar",         {NULL}, 686, "udp"},
{"asipregistry",       {NULL}, 687, "tcp"},
{"asipregistry",       {NULL}, 687, "udp"},
{"realm-rusd",         {NULL}, 688, "tcp"},
{"realm-rusd",         {NULL}, 688, "udp"},
{"nmap",               {NULL}, 689, "tcp"},
{"nmap",               {NULL}, 689, "udp"},
{"vatp",               {NULL}, 690, "tcp"},
{"vatp",               {NULL}, 690, "udp"},
{"msexch-routing",     {NULL}, 691, "tcp"},
{"msexch-routing",     {NULL}, 691, "udp"},
{"hyperwave-isp",      {NULL}, 692, "tcp"},
{"hyperwave-isp",      {NULL}, 692, "udp"},
{"connendp",           {NULL}, 693, "tcp"},
{"connendp",           {NULL}, 693, "udp"},
{"ha-cluster",         {NULL}, 694, "tcp"},
{"ha-cluster",         {NULL}, 694, "udp"},
{"ieee-mms-ssl",       {NULL}, 695, "tcp"},
{"ieee-mms-ssl",       {NULL}, 695, "udp"},
{"rushd",              {NULL}, 696, "tcp"},
{"rushd",              {NULL}, 696, "udp"},
{"uuidgen",            {NULL}, 697, "tcp"},
{"uuidgen",            {NULL}, 697, "udp"},
{"olsr",               {NULL}, 698, "tcp"},
{"olsr",               {NULL}, 698, "udp"},
{"accessnetwork",      {NULL}, 699, "tcp"},
{"accessnetwork",      {NULL}, 699, "udp"},
{"epp",                {NULL}, 700, "tcp"},
{"epp",                {NULL}, 700, "udp"},
{"lmp",                {NULL}, 701, "tcp"},
{"lmp",                {NULL}, 701, "udp"},
{"iris-beep",          {NULL}, 702, "tcp"},
{"iris-beep",          {NULL}, 702, "udp"},
{"elcsd",              {NULL}, 704, "tcp"},
{"elcsd",              {NULL}, 704, "udp"},
{"agentx",             {NULL}, 705, "tcp"},
{"agentx",             {NULL}, 705, "udp"},
{"silc",               {NULL}, 706, "tcp"},
{"silc",               {NULL}, 706, "udp"},
{"borland-dsj",        {NULL}, 707, "tcp"},
{"borland-dsj",        {NULL}, 707, "udp"},
{"entrust-kmsh",       {NULL}, 709, "tcp"},
{"entrust-kmsh",       {NULL}, 709, "udp"},
{"entrust-ash",        {NULL}, 710, "tcp"},
{"entrust-ash",        {NULL}, 710, "udp"},
{"cisco-tdp",          {NULL}, 711, "tcp"},
{"cisco-tdp",          {NULL}, 711, "udp"},
{"tbrpf",              {NULL}, 712, "tcp"},
{"tbrpf",              {NULL}, 712, "udp"},
{"iris-xpc",           {NULL}, 713, "tcp"},
{"iris-xpc",           {NULL}, 713, "udp"},
{"iris-xpcs",          {NULL}, 714, "tcp"},
{"iris-xpcs",          {NULL}, 714, "udp"},
{"iris-lwz",           {NULL}, 715, "tcp"},
{"iris-lwz",           {NULL}, 715, "udp"},
{"pana",               {NULL}, 716, "udp"},
{"netviewdm1",         {NULL}, 729, "tcp"},
{"netviewdm1",         {NULL}, 729, "udp"},
{"netviewdm2",         {NULL}, 730, "tcp"},
{"netviewdm2",         {NULL}, 730, "udp"},
{"netviewdm3",         {NULL}, 731, "tcp"},
{"netviewdm3",         {NULL}, 731, "udp"},
{"netgw",              {NULL}, 741, "tcp"},
{"netgw",              {NULL}, 741, "udp"},
{"netrcs",             {NULL}, 742, "tcp"},
{"netrcs",             {NULL}, 742, "udp"},
{"flexlm",             {NULL}, 744, "tcp"},
{"flexlm",             {NULL}, 744, "udp"},
{"fujitsu-dev",        {NULL}, 747, "tcp"},
{"fujitsu-dev",        {NULL}, 747, "udp"},
{"ris-cm",             {NULL}, 748, "tcp"},
{"ris-cm",             {NULL}, 748, "udp"},
{"kerberos-adm",       {NULL}, 749, "tcp"},
{"kerberos-adm",       {NULL}, 749, "udp"},
{"rfile",              {NULL}, 750, "tcp"},
{"loadav",             {NULL}, 750, "udp"},
{"kerberos-iv",        {NULL}, 750, "udp"},
{"pump",               {NULL}, 751, "tcp"},
{"pump",               {NULL}, 751, "udp"},
{"qrh",                {NULL}, 752, "tcp"},
{"qrh",                {NULL}, 752, "udp"},
{"rrh",                {NULL}, 753, "tcp"},
{"rrh",                {NULL}, 753, "udp"},
{"tell",               {NULL}, 754, "tcp"},
{"tell",               {NULL}, 754, "udp"},
{"nlogin",             {NULL}, 758, "tcp"},
{"nlogin",             {NULL}, 758, "udp"},
{"con",                {NULL}, 759, "tcp"},
{"con",                {NULL}, 759, "udp"},
{"ns",                 {NULL}, 760, "tcp"},
{"ns",                 {NULL}, 760, "udp"},
{"rxe",                {NULL}, 761, "tcp"},
{"rxe",                {NULL}, 761, "udp"},
{"quotad",             {NULL}, 762, "tcp"},
{"quotad",             {NULL}, 762, "udp"},
{"cycleserv",          {NULL}, 763, "tcp"},
{"cycleserv",          {NULL}, 763, "udp"},
{"omserv",             {NULL}, 764, "tcp"},
{"omserv",             {NULL}, 764, "udp"},
{"webster",            {NULL}, 765, "tcp"},
{"webster",            {NULL}, 765, "udp"},
{"phonebook",          {NULL}, 767, "tcp"},
{"phonebook",          {NULL}, 767, "udp"},
{"vid",                {NULL}, 769, "tcp"},
{"vid",                {NULL}, 769, "udp"},
{"cadlock",            {NULL}, 770, "tcp"},
{"cadlock",            {NULL}, 770, "udp"},
{"rtip",               {NULL}, 771, "tcp"},
{"rtip",               {NULL}, 771, "udp"},
{"cycleserv2",         {NULL}, 772, "tcp"},
{"cycleserv2",         {NULL}, 772, "udp"},
{"submit",             {NULL}, 773, "tcp"},
{"notify",             {NULL}, 773, "udp"},
{"rpasswd",            {NULL}, 774, "tcp"},
{"acmaint_dbd",        {NULL}, 774, "udp"},
{"entomb",             {NULL}, 775, "tcp"},
{"acmaint_transd",     {NULL}, 775, "udp"},
{"wpages",             {NULL}, 776, "tcp"},
{"wpages",             {NULL}, 776, "udp"},
{"multiling-http",     {NULL}, 777, "tcp"},
{"multiling-http",     {NULL}, 777, "udp"},
{"wpgs",               {NULL}, 780, "tcp"},
{"wpgs",               {NULL}, 780, "udp"},
{"mdbs_daemon",        {NULL}, 800, "tcp"},
{"mdbs_daemon",        {NULL}, 800, "udp"},
{"device",             {NULL}, 801, "tcp"},
{"device",             {NULL}, 801, "udp"},
{"fcp-udp",            {NULL}, 810, "tcp"},
{"fcp-udp",            {NULL}, 810, "udp"},
{"itm-mcell-s",        {NULL}, 828, "tcp"},
{"itm-mcell-s",        {NULL}, 828, "udp"},
{"pkix-3-ca-ra",       {NULL}, 829, "tcp"},
{"pkix-3-ca-ra",       {NULL}, 829, "udp"},
{"netconf-ssh",        {NULL}, 830, "tcp"},
{"netconf-ssh",        {NULL}, 830, "udp"},
{"netconf-beep",       {NULL}, 831, "tcp"},
{"netconf-beep",       {NULL}, 831, "udp"},
{"netconfsoaphttp",    {NULL}, 832, "tcp"},
{"netconfsoaphttp",    {NULL}, 832, "udp"},
{"netconfsoapbeep",    {NULL}, 833, "tcp"},
{"netconfsoapbeep",    {NULL}, 833, "udp"},
{"dhcp-failover2",     {NULL}, 847, "tcp"},
{"dhcp-failover2",     {NULL}, 847, "udp"},
{"gdoi",               {NULL}, 848, "tcp"},
{"gdoi",               {NULL}, 848, "udp"},
{"iscsi",              {NULL}, 860, "tcp"},
{"iscsi",              {NULL}, 860, "udp"},
{"owamp-control",      {NULL}, 861, "tcp"},
{"owamp-control",      {NULL}, 861, "udp"},
{"twamp-control",      {NULL}, 862, "tcp"},
{"twamp-control",      {NULL}, 862, "udp"},
{"rsync",              {NULL}, 873, "tcp"},
{"rsync",              {NULL}, 873, "udp"},
{"iclcnet-locate",     {NULL}, 886, "tcp"},
{"iclcnet-locate",     {NULL}, 886, "udp"},
{"iclcnet_svinfo",     {NULL}, 887, "tcp"},
{"iclcnet_svinfo",     {NULL}, 887, "udp"},
{"accessbuilder",      {NULL}, 888, "tcp"},
{"accessbuilder",      {NULL}, 888, "udp"},
{"cddbp",              {NULL}, 888, "tcp"},
{"omginitialrefs",     {NULL}, 900, "tcp"},
{"omginitialrefs",     {NULL}, 900, "udp"},
{"smpnameres",         {NULL}, 901, "tcp"},
{"smpnameres",         {NULL}, 901, "udp"},
{"ideafarm-door",      {NULL}, 902, "tcp"},
{"ideafarm-door",      {NULL}, 902, "udp"},
{"ideafarm-panic",     {NULL}, 903, "tcp"},
{"ideafarm-panic",     {NULL}, 903, "udp"},
{"kink",               {NULL}, 910, "tcp"},
{"kink",               {NULL}, 910, "udp"},
{"xact-backup",        {NULL}, 911, "tcp"},
{"xact-backup",        {NULL}, 911, "udp"},
{"apex-mesh",          {NULL}, 912, "tcp"},
{"apex-mesh",          {NULL}, 912, "udp"},
{"apex-edge",          {NULL}, 913, "tcp"},
{"apex-edge",          {NULL}, 913, "udp"},
{"ftps-data",          {NULL}, 989, "tcp"},
{"ftps-data",          {NULL}, 989, "udp"},
{"ftps",               {NULL}, 990, "tcp"},
{"ftps",               {NULL}, 990, "udp"},
{"nas",                {NULL}, 991, "tcp"},
{"nas",                {NULL}, 991, "udp"},
{"telnets",            {NULL}, 992, "tcp"},
{"telnets",            {NULL}, 992, "udp"},
{"imaps",              {NULL}, 993, "tcp"},
{"imaps",              {NULL}, 993, "udp"},
{"ircs",               {NULL}, 994, "tcp"},
{"ircs",               {NULL}, 994, "udp"},
{"pop3s",              {NULL}, 995, "tcp"},
{"pop3s",              {NULL}, 995, "udp"},
{"vsinet",             {NULL}, 996, "tcp"},
{"vsinet",             {NULL}, 996, "udp"},
{"maitrd",             {NULL}, 997, "tcp"},
{"maitrd",             {NULL}, 997, "udp"},
{"busboy",             {NULL}, 998, "tcp"},
{"puparp",             {NULL}, 998, "udp"},
{"garcon",             {NULL}, 999, "tcp"},
{"applix",             {NULL}, 999, "udp"},
{"puprouter",          {NULL}, 999, "tcp"},
{"puprouter",          {NULL}, 999, "udp"},
{"cadlock2",           {NULL}, 1000, "tcp"},
{"cadlock2",           {NULL}, 1000, "udp"},
{"surf",               {NULL}, 1010, "tcp"},
{"surf",               {NULL}, 1010, "udp"},
{"exp1",               {NULL}, 1021, "tcp"},
{"exp1",               {NULL}, 1021, "udp"},
{"exp2",               {NULL}, 1022, "tcp"},
{"exp2",               {NULL}, 1022, "udp"},
#endif /* USE_IANA_WELL_KNOWN_PORTS */
#ifdef USE_IANA_REGISTERED_PORTS
{"blackjack",          {NULL}, 1025, "tcp"},
{"blackjack",          {NULL}, 1025, "udp"},
{"cap",                {NULL}, 1026, "tcp"},
{"cap",                {NULL}, 1026, "udp"},
{"solid-mux",          {NULL}, 1029, "tcp"},
{"solid-mux",          {NULL}, 1029, "udp"},
{"iad1",               {NULL}, 1030, "tcp"},
{"iad1",               {NULL}, 1030, "udp"},
{"iad2",               {NULL}, 1031, "tcp"},
{"iad2",               {NULL}, 1031, "udp"},
{"iad3",               {NULL}, 1032, "tcp"},
{"iad3",               {NULL}, 1032, "udp"},
{"netinfo-local",      {NULL}, 1033, "tcp"},
{"netinfo-local",      {NULL}, 1033, "udp"},
{"activesync",         {NULL}, 1034, "tcp"},
{"activesync",         {NULL}, 1034, "udp"},
{"mxxrlogin",          {NULL}, 1035, "tcp"},
{"mxxrlogin",          {NULL}, 1035, "udp"},
{"nsstp",              {NULL}, 1036, "tcp"},
{"nsstp",              {NULL}, 1036, "udp"},
{"ams",                {NULL}, 1037, "tcp"},
{"ams",                {NULL}, 1037, "udp"},
{"mtqp",               {NULL}, 1038, "tcp"},
{"mtqp",               {NULL}, 1038, "udp"},
{"sbl",                {NULL}, 1039, "tcp"},
{"sbl",                {NULL}, 1039, "udp"},
{"netarx",             {NULL}, 1040, "tcp"},
{"netarx",             {NULL}, 1040, "udp"},
{"danf-ak2",           {NULL}, 1041, "tcp"},
{"danf-ak2",           {NULL}, 1041, "udp"},
{"afrog",              {NULL}, 1042, "tcp"},
{"afrog",              {NULL}, 1042, "udp"},
{"boinc-client",       {NULL}, 1043, "tcp"},
{"boinc-client",       {NULL}, 1043, "udp"},
{"dcutility",          {NULL}, 1044, "tcp"},
{"dcutility",          {NULL}, 1044, "udp"},
{"fpitp",              {NULL}, 1045, "tcp"},
{"fpitp",              {NULL}, 1045, "udp"},
{"wfremotertm",        {NULL}, 1046, "tcp"},
{"wfremotertm",        {NULL}, 1046, "udp"},
{"neod1",              {NULL}, 1047, "tcp"},
{"neod1",              {NULL}, 1047, "udp"},
{"neod2",              {NULL}, 1048, "tcp"},
{"neod2",              {NULL}, 1048, "udp"},
{"td-postman",         {NULL}, 1049, "tcp"},
{"td-postman",         {NULL}, 1049, "udp"},
{"cma",                {NULL}, 1050, "tcp"},
{"cma",                {NULL}, 1050, "udp"},
{"optima-vnet",        {NULL}, 1051, "tcp"},
{"optima-vnet",        {NULL}, 1051, "udp"},
{"ddt",                {NULL}, 1052, "tcp"},
{"ddt",                {NULL}, 1052, "udp"},
{"remote-as",          {NULL}, 1053, "tcp"},
{"remote-as",          {NULL}, 1053, "udp"},
{"brvread",            {NULL}, 1054, "tcp"},
{"brvread",            {NULL}, 1054, "udp"},
{"ansyslmd",           {NULL}, 1055, "tcp"},
{"ansyslmd",           {NULL}, 1055, "udp"},
{"vfo",                {NULL}, 1056, "tcp"},
{"vfo",                {NULL}, 1056, "udp"},
{"startron",           {NULL}, 1057, "tcp"},
{"startron",           {NULL}, 1057, "udp"},
{"nim",                {NULL}, 1058, "tcp"},
{"nim",                {NULL}, 1058, "udp"},
{"nimreg",             {NULL}, 1059, "tcp"},
{"nimreg",             {NULL}, 1059, "udp"},
{"polestar",           {NULL}, 1060, "tcp"},
{"polestar",           {NULL}, 1060, "udp"},
{"kiosk",              {NULL}, 1061, "tcp"},
{"kiosk",              {NULL}, 1061, "udp"},
{"veracity",           {NULL}, 1062, "tcp"},
{"veracity",           {NULL}, 1062, "udp"},
{"kyoceranetdev",      {NULL}, 1063, "tcp"},
{"kyoceranetdev",      {NULL}, 1063, "udp"},
{"jstel",              {NULL}, 1064, "tcp"},
{"jstel",              {NULL}, 1064, "udp"},
{"syscomlan",          {NULL}, 1065, "tcp"},
{"syscomlan",          {NULL}, 1065, "udp"},
{"fpo-fns",            {NULL}, 1066, "tcp"},
{"fpo-fns",            {NULL}, 1066, "udp"},
{"instl_boots",        {NULL}, 1067, "tcp"},
{"instl_boots",        {NULL}, 1067, "udp"},
{"instl_bootc",        {NULL}, 1068, "tcp"},
{"instl_bootc",        {NULL}, 1068, "udp"},
{"cognex-insight",     {NULL}, 1069, "tcp"},
{"cognex-insight",     {NULL}, 1069, "udp"},
{"gmrupdateserv",      {NULL}, 1070, "tcp"},
{"gmrupdateserv",      {NULL}, 1070, "udp"},
{"bsquare-voip",       {NULL}, 1071, "tcp"},
{"bsquare-voip",       {NULL}, 1071, "udp"},
{"cardax",             {NULL}, 1072, "tcp"},
{"cardax",             {NULL}, 1072, "udp"},
{"bridgecontrol",      {NULL}, 1073, "tcp"},
{"bridgecontrol",      {NULL}, 1073, "udp"},
{"warmspotMgmt",       {NULL}, 1074, "tcp"},
{"warmspotMgmt",       {NULL}, 1074, "udp"},
{"rdrmshc",            {NULL}, 1075, "tcp"},
{"rdrmshc",            {NULL}, 1075, "udp"},
{"dab-sti-c",          {NULL}, 1076, "tcp"},
{"dab-sti-c",          {NULL}, 1076, "udp"},
{"imgames",            {NULL}, 1077, "tcp"},
{"imgames",            {NULL}, 1077, "udp"},
{"avocent-proxy",      {NULL}, 1078, "tcp"},
{"avocent-proxy",      {NULL}, 1078, "udp"},
{"asprovatalk",        {NULL}, 1079, "tcp"},
{"asprovatalk",        {NULL}, 1079, "udp"},
{"socks",              {NULL}, 1080, "tcp"},
{"socks",              {NULL}, 1080, "udp"},
{"pvuniwien",          {NULL}, 1081, "tcp"},
{"pvuniwien",          {NULL}, 1081, "udp"},
{"amt-esd-prot",       {NULL}, 1082, "tcp"},
{"amt-esd-prot",       {NULL}, 1082, "udp"},
{"ansoft-lm-1",        {NULL}, 1083, "tcp"},
{"ansoft-lm-1",        {NULL}, 1083, "udp"},
{"ansoft-lm-2",        {NULL}, 1084, "tcp"},
{"ansoft-lm-2",        {NULL}, 1084, "udp"},
{"webobjects",         {NULL}, 1085, "tcp"},
{"webobjects",         {NULL}, 1085, "udp"},
{"cplscrambler-lg",    {NULL}, 1086, "tcp"},
{"cplscrambler-lg",    {NULL}, 1086, "udp"},
{"cplscrambler-in",    {NULL}, 1087, "tcp"},
{"cplscrambler-in",    {NULL}, 1087, "udp"},
{"cplscrambler-al",    {NULL}, 1088, "tcp"},
{"cplscrambler-al",    {NULL}, 1088, "udp"},
{"ff-annunc",          {NULL}, 1089, "tcp"},
{"ff-annunc",          {NULL}, 1089, "udp"},
{"ff-fms",             {NULL}, 1090, "tcp"},
{"ff-fms",             {NULL}, 1090, "udp"},
{"ff-sm",              {NULL}, 1091, "tcp"},
{"ff-sm",              {NULL}, 1091, "udp"},
{"obrpd",              {NULL}, 1092, "tcp"},
{"obrpd",              {NULL}, 1092, "udp"},
{"proofd",             {NULL}, 1093, "tcp"},
{"proofd",             {NULL}, 1093, "udp"},
{"rootd",              {NULL}, 1094, "tcp"},
{"rootd",              {NULL}, 1094, "udp"},
{"nicelink",           {NULL}, 1095, "tcp"},
{"nicelink",           {NULL}, 1095, "udp"},
{"cnrprotocol",        {NULL}, 1096, "tcp"},
{"cnrprotocol",        {NULL}, 1096, "udp"},
{"sunclustermgr",      {NULL}, 1097, "tcp"},
{"sunclustermgr",      {NULL}, 1097, "udp"},
{"rmiactivation",      {NULL}, 1098, "tcp"},
{"rmiactivation",      {NULL}, 1098, "udp"},
{"rmiregistry",        {NULL}, 1099, "tcp"},
{"rmiregistry",        {NULL}, 1099, "udp"},
{"mctp",               {NULL}, 1100, "tcp"},
{"mctp",               {NULL}, 1100, "udp"},
{"pt2-discover",       {NULL}, 1101, "tcp"},
{"pt2-discover",       {NULL}, 1101, "udp"},
{"adobeserver-1",      {NULL}, 1102, "tcp"},
{"adobeserver-1",      {NULL}, 1102, "udp"},
{"adobeserver-2",      {NULL}, 1103, "tcp"},
{"adobeserver-2",      {NULL}, 1103, "udp"},
{"xrl",                {NULL}, 1104, "tcp"},
{"xrl",                {NULL}, 1104, "udp"},
{"ftranhc",            {NULL}, 1105, "tcp"},
{"ftranhc",            {NULL}, 1105, "udp"},
{"isoipsigport-1",     {NULL}, 1106, "tcp"},
{"isoipsigport-1",     {NULL}, 1106, "udp"},
{"isoipsigport-2",     {NULL}, 1107, "tcp"},
{"isoipsigport-2",     {NULL}, 1107, "udp"},
{"ratio-adp",          {NULL}, 1108, "tcp"},
{"ratio-adp",          {NULL}, 1108, "udp"},
{"webadmstart",        {NULL}, 1110, "tcp"},
{"nfsd-keepalive",     {NULL}, 1110, "udp"},
{"lmsocialserver",     {NULL}, 1111, "tcp"},
{"lmsocialserver",     {NULL}, 1111, "udp"},
{"icp",                {NULL}, 1112, "tcp"},
{"icp",                {NULL}, 1112, "udp"},
{"ltp-deepspace",      {NULL}, 1113, "tcp"},
{"ltp-deepspace",      {NULL}, 1113, "udp"},
{"mini-sql",           {NULL}, 1114, "tcp"},
{"mini-sql",           {NULL}, 1114, "udp"},
{"ardus-trns",         {NULL}, 1115, "tcp"},
{"ardus-trns",         {NULL}, 1115, "udp"},
{"ardus-cntl",         {NULL}, 1116, "tcp"},
{"ardus-cntl",         {NULL}, 1116, "udp"},
{"ardus-mtrns",        {NULL}, 1117, "tcp"},
{"ardus-mtrns",        {NULL}, 1117, "udp"},
{"sacred",             {NULL}, 1118, "tcp"},
{"sacred",             {NULL}, 1118, "udp"},
{"bnetgame",           {NULL}, 1119, "tcp"},
{"bnetgame",           {NULL}, 1119, "udp"},
{"bnetfile",           {NULL}, 1120, "tcp"},
{"bnetfile",           {NULL}, 1120, "udp"},
{"rmpp",               {NULL}, 1121, "tcp"},
{"rmpp",               {NULL}, 1121, "udp"},
{"availant-mgr",       {NULL}, 1122, "tcp"},
{"availant-mgr",       {NULL}, 1122, "udp"},
{"murray",             {NULL}, 1123, "tcp"},
{"murray",             {NULL}, 1123, "udp"},
{"hpvmmcontrol",       {NULL}, 1124, "tcp"},
{"hpvmmcontrol",       {NULL}, 1124, "udp"},
{"hpvmmagent",         {NULL}, 1125, "tcp"},
{"hpvmmagent",         {NULL}, 1125, "udp"},
{"hpvmmdata",          {NULL}, 1126, "tcp"},
{"hpvmmdata",          {NULL}, 1126, "udp"},
{"kwdb-commn",         {NULL}, 1127, "tcp"},
{"kwdb-commn",         {NULL}, 1127, "udp"},
{"saphostctrl",        {NULL}, 1128, "tcp"},
{"saphostctrl",        {NULL}, 1128, "udp"},
{"saphostctrls",       {NULL}, 1129, "tcp"},
{"saphostctrls",       {NULL}, 1129, "udp"},
{"casp",               {NULL}, 1130, "tcp"},
{"casp",               {NULL}, 1130, "udp"},
{"caspssl",            {NULL}, 1131, "tcp"},
{"caspssl",            {NULL}, 1131, "udp"},
{"kvm-via-ip",         {NULL}, 1132, "tcp"},
{"kvm-via-ip",         {NULL}, 1132, "udp"},
{"dfn",                {NULL}, 1133, "tcp"},
{"dfn",                {NULL}, 1133, "udp"},
{"aplx",               {NULL}, 1134, "tcp"},
{"aplx",               {NULL}, 1134, "udp"},
{"omnivision",         {NULL}, 1135, "tcp"},
{"omnivision",         {NULL}, 1135, "udp"},
{"hhb-gateway",        {NULL}, 1136, "tcp"},
{"hhb-gateway",        {NULL}, 1136, "udp"},
{"trim",               {NULL}, 1137, "tcp"},
{"trim",               {NULL}, 1137, "udp"},
{"encrypted_admin",    {NULL}, 1138, "tcp"},
{"encrypted_admin",    {NULL}, 1138, "udp"},
{"evm",                {NULL}, 1139, "tcp"},
{"evm",                {NULL}, 1139, "udp"},
{"autonoc",            {NULL}, 1140, "tcp"},
{"autonoc",            {NULL}, 1140, "udp"},
{"mxomss",             {NULL}, 1141, "tcp"},
{"mxomss",             {NULL}, 1141, "udp"},
{"edtools",            {NULL}, 1142, "tcp"},
{"edtools",            {NULL}, 1142, "udp"},
{"imyx",               {NULL}, 1143, "tcp"},
{"imyx",               {NULL}, 1143, "udp"},
{"fuscript",           {NULL}, 1144, "tcp"},
{"fuscript",           {NULL}, 1144, "udp"},
{"x9-icue",            {NULL}, 1145, "tcp"},
{"x9-icue",            {NULL}, 1145, "udp"},
{"audit-transfer",     {NULL}, 1146, "tcp"},
{"audit-transfer",     {NULL}, 1146, "udp"},
{"capioverlan",        {NULL}, 1147, "tcp"},
{"capioverlan",        {NULL}, 1147, "udp"},
{"elfiq-repl",         {NULL}, 1148, "tcp"},
{"elfiq-repl",         {NULL}, 1148, "udp"},
{"bvtsonar",           {NULL}, 1149, "tcp"},
{"bvtsonar",           {NULL}, 1149, "udp"},
{"blaze",              {NULL}, 1150, "tcp"},
{"blaze",              {NULL}, 1150, "udp"},
{"unizensus",          {NULL}, 1151, "tcp"},
{"unizensus",          {NULL}, 1151, "udp"},
{"winpoplanmess",      {NULL}, 1152, "tcp"},
{"winpoplanmess",      {NULL}, 1152, "udp"},
{"c1222-acse",         {NULL}, 1153, "tcp"},
{"c1222-acse",         {NULL}, 1153, "udp"},
{"resacommunity",      {NULL}, 1154, "tcp"},
{"resacommunity",      {NULL}, 1154, "udp"},
{"nfa",                {NULL}, 1155, "tcp"},
{"nfa",                {NULL}, 1155, "udp"},
{"iascontrol-oms",     {NULL}, 1156, "tcp"},
{"iascontrol-oms",     {NULL}, 1156, "udp"},
{"iascontrol",         {NULL}, 1157, "tcp"},
{"iascontrol",         {NULL}, 1157, "udp"},
{"dbcontrol-oms",      {NULL}, 1158, "tcp"},
{"dbcontrol-oms",      {NULL}, 1158, "udp"},
{"oracle-oms",         {NULL}, 1159, "tcp"},
{"oracle-oms",         {NULL}, 1159, "udp"},
{"olsv",               {NULL}, 1160, "tcp"},
{"olsv",               {NULL}, 1160, "udp"},
{"health-polling",     {NULL}, 1161, "tcp"},
{"health-polling",     {NULL}, 1161, "udp"},
{"health-trap",        {NULL}, 1162, "tcp"},
{"health-trap",        {NULL}, 1162, "udp"},
{"sddp",               {NULL}, 1163, "tcp"},
{"sddp",               {NULL}, 1163, "udp"},
{"qsm-proxy",          {NULL}, 1164, "tcp"},
{"qsm-proxy",          {NULL}, 1164, "udp"},
{"qsm-gui",            {NULL}, 1165, "tcp"},
{"qsm-gui",            {NULL}, 1165, "udp"},
{"qsm-remote",         {NULL}, 1166, "tcp"},
{"qsm-remote",         {NULL}, 1166, "udp"},
{"cisco-ipsla",        {NULL}, 1167, "tcp"},
{"cisco-ipsla",        {NULL}, 1167, "udp"},
{"cisco-ipsla",        {NULL}, 1167, "sctp"},
{"vchat",              {NULL}, 1168, "tcp"},
{"vchat",              {NULL}, 1168, "udp"},
{"tripwire",           {NULL}, 1169, "tcp"},
{"tripwire",           {NULL}, 1169, "udp"},
{"atc-lm",             {NULL}, 1170, "tcp"},
{"atc-lm",             {NULL}, 1170, "udp"},
{"atc-appserver",      {NULL}, 1171, "tcp"},
{"atc-appserver",      {NULL}, 1171, "udp"},
{"dnap",               {NULL}, 1172, "tcp"},
{"dnap",               {NULL}, 1172, "udp"},
{"d-cinema-rrp",       {NULL}, 1173, "tcp"},
{"d-cinema-rrp",       {NULL}, 1173, "udp"},
{"fnet-remote-ui",     {NULL}, 1174, "tcp"},
{"fnet-remote-ui",     {NULL}, 1174, "udp"},
{"dossier",            {NULL}, 1175, "tcp"},
{"dossier",            {NULL}, 1175, "udp"},
{"indigo-server",      {NULL}, 1176, "tcp"},
{"indigo-server",      {NULL}, 1176, "udp"},
{"dkmessenger",        {NULL}, 1177, "tcp"},
{"dkmessenger",        {NULL}, 1177, "udp"},
{"sgi-storman",        {NULL}, 1178, "tcp"},
{"sgi-storman",        {NULL}, 1178, "udp"},
{"b2n",                {NULL}, 1179, "tcp"},
{"b2n",                {NULL}, 1179, "udp"},
{"mc-client",          {NULL}, 1180, "tcp"},
{"mc-client",          {NULL}, 1180, "udp"},
{"3comnetman",         {NULL}, 1181, "tcp"},
{"3comnetman",         {NULL}, 1181, "udp"},
{"accelenet",          {NULL}, 1182, "tcp"},
{"accelenet-data",     {NULL}, 1182, "udp"},
{"llsurfup-http",      {NULL}, 1183, "tcp"},
{"llsurfup-http",      {NULL}, 1183, "udp"},
{"llsurfup-https",     {NULL}, 1184, "tcp"},
{"llsurfup-https",     {NULL}, 1184, "udp"},
{"catchpole",          {NULL}, 1185, "tcp"},
{"catchpole",          {NULL}, 1185, "udp"},
{"mysql-cluster",      {NULL}, 1186, "tcp"},
{"mysql-cluster",      {NULL}, 1186, "udp"},
{"alias",              {NULL}, 1187, "tcp"},
{"alias",              {NULL}, 1187, "udp"},
{"hp-webadmin",        {NULL}, 1188, "tcp"},
{"hp-webadmin",        {NULL}, 1188, "udp"},
{"unet",               {NULL}, 1189, "tcp"},
{"unet",               {NULL}, 1189, "udp"},
{"commlinx-avl",       {NULL}, 1190, "tcp"},
{"commlinx-avl",       {NULL}, 1190, "udp"},
{"gpfs",               {NULL}, 1191, "tcp"},
{"gpfs",               {NULL}, 1191, "udp"},
{"caids-sensor",       {NULL}, 1192, "tcp"},
{"caids-sensor",       {NULL}, 1192, "udp"},
{"fiveacross",         {NULL}, 1193, "tcp"},
{"fiveacross",         {NULL}, 1193, "udp"},
{"openvpn",            {NULL}, 1194, "tcp"},
{"openvpn",            {NULL}, 1194, "udp"},
{"rsf-1",              {NULL}, 1195, "tcp"},
{"rsf-1",              {NULL}, 1195, "udp"},
{"netmagic",           {NULL}, 1196, "tcp"},
{"netmagic",           {NULL}, 1196, "udp"},
{"carrius-rshell",     {NULL}, 1197, "tcp"},
{"carrius-rshell",     {NULL}, 1197, "udp"},
{"cajo-discovery",     {NULL}, 1198, "tcp"},
{"cajo-discovery",     {NULL}, 1198, "udp"},
{"dmidi",              {NULL}, 1199, "tcp"},
{"dmidi",              {NULL}, 1199, "udp"},
{"scol",               {NULL}, 1200, "tcp"},
{"scol",               {NULL}, 1200, "udp"},
{"nucleus-sand",       {NULL}, 1201, "tcp"},
{"nucleus-sand",       {NULL}, 1201, "udp"},
{"caiccipc",           {NULL}, 1202, "tcp"},
{"caiccipc",           {NULL}, 1202, "udp"},
{"ssslic-mgr",         {NULL}, 1203, "tcp"},
{"ssslic-mgr",         {NULL}, 1203, "udp"},
{"ssslog-mgr",         {NULL}, 1204, "tcp"},
{"ssslog-mgr",         {NULL}, 1204, "udp"},
{"accord-mgc",         {NULL}, 1205, "tcp"},
{"accord-mgc",         {NULL}, 1205, "udp"},
{"anthony-data",       {NULL}, 1206, "tcp"},
{"anthony-data",       {NULL}, 1206, "udp"},
{"metasage",           {NULL}, 1207, "tcp"},
{"metasage",           {NULL}, 1207, "udp"},
{"seagull-ais",        {NULL}, 1208, "tcp"},
{"seagull-ais",        {NULL}, 1208, "udp"},
{"ipcd3",              {NULL}, 1209, "tcp"},
{"ipcd3",              {NULL}, 1209, "udp"},
{"eoss",               {NULL}, 1210, "tcp"},
{"eoss",               {NULL}, 1210, "udp"},
{"groove-dpp",         {NULL}, 1211, "tcp"},
{"groove-dpp",         {NULL}, 1211, "udp"},
{"lupa",               {NULL}, 1212, "tcp"},
{"lupa",               {NULL}, 1212, "udp"},
{"mpc-lifenet",        {NULL}, 1213, "tcp"},
{"mpc-lifenet",        {NULL}, 1213, "udp"},
{"kazaa",              {NULL}, 1214, "tcp"},
{"kazaa",              {NULL}, 1214, "udp"},
{"scanstat-1",         {NULL}, 1215, "tcp"},
{"scanstat-1",         {NULL}, 1215, "udp"},
{"etebac5",            {NULL}, 1216, "tcp"},
{"etebac5",            {NULL}, 1216, "udp"},
{"hpss-ndapi",         {NULL}, 1217, "tcp"},
{"hpss-ndapi",         {NULL}, 1217, "udp"},
{"aeroflight-ads",     {NULL}, 1218, "tcp"},
{"aeroflight-ads",     {NULL}, 1218, "udp"},
{"aeroflight-ret",     {NULL}, 1219, "tcp"},
{"aeroflight-ret",     {NULL}, 1219, "udp"},
{"qt-serveradmin",     {NULL}, 1220, "tcp"},
{"qt-serveradmin",     {NULL}, 1220, "udp"},
{"sweetware-apps",     {NULL}, 1221, "tcp"},
{"sweetware-apps",     {NULL}, 1221, "udp"},
{"nerv",               {NULL}, 1222, "tcp"},
{"nerv",               {NULL}, 1222, "udp"},
{"tgp",                {NULL}, 1223, "tcp"},
{"tgp",                {NULL}, 1223, "udp"},
{"vpnz",               {NULL}, 1224, "tcp"},
{"vpnz",               {NULL}, 1224, "udp"},
{"slinkysearch",       {NULL}, 1225, "tcp"},
{"slinkysearch",       {NULL}, 1225, "udp"},
{"stgxfws",            {NULL}, 1226, "tcp"},
{"stgxfws",            {NULL}, 1226, "udp"},
{"dns2go",             {NULL}, 1227, "tcp"},
{"dns2go",             {NULL}, 1227, "udp"},
{"florence",           {NULL}, 1228, "tcp"},
{"florence",           {NULL}, 1228, "udp"},
{"zented",             {NULL}, 1229, "tcp"},
{"zented",             {NULL}, 1229, "udp"},
{"periscope",          {NULL}, 1230, "tcp"},
{"periscope",          {NULL}, 1230, "udp"},
{"menandmice-lpm",     {NULL}, 1231, "tcp"},
{"menandmice-lpm",     {NULL}, 1231, "udp"},
{"univ-appserver",     {NULL}, 1233, "tcp"},
{"univ-appserver",     {NULL}, 1233, "udp"},
{"search-agent",       {NULL}, 1234, "tcp"},
{"search-agent",       {NULL}, 1234, "udp"},
{"mosaicsyssvc1",      {NULL}, 1235, "tcp"},
{"mosaicsyssvc1",      {NULL}, 1235, "udp"},
{"bvcontrol",          {NULL}, 1236, "tcp"},
{"bvcontrol",          {NULL}, 1236, "udp"},
{"tsdos390",           {NULL}, 1237, "tcp"},
{"tsdos390",           {NULL}, 1237, "udp"},
{"hacl-qs",            {NULL}, 1238, "tcp"},
{"hacl-qs",            {NULL}, 1238, "udp"},
{"nmsd",               {NULL}, 1239, "tcp"},
{"nmsd",               {NULL}, 1239, "udp"},
{"instantia",          {NULL}, 1240, "tcp"},
{"instantia",          {NULL}, 1240, "udp"},
{"nessus",             {NULL}, 1241, "tcp"},
{"nessus",             {NULL}, 1241, "udp"},
{"nmasoverip",         {NULL}, 1242, "tcp"},
{"nmasoverip",         {NULL}, 1242, "udp"},
{"serialgateway",      {NULL}, 1243, "tcp"},
{"serialgateway",      {NULL}, 1243, "udp"},
{"isbconference1",     {NULL}, 1244, "tcp"},
{"isbconference1",     {NULL}, 1244, "udp"},
{"isbconference2",     {NULL}, 1245, "tcp"},
{"isbconference2",     {NULL}, 1245, "udp"},
{"payrouter",          {NULL}, 1246, "tcp"},
{"payrouter",          {NULL}, 1246, "udp"},
{"visionpyramid",      {NULL}, 1247, "tcp"},
{"visionpyramid",      {NULL}, 1247, "udp"},
{"hermes",             {NULL}, 1248, "tcp"},
{"hermes",             {NULL}, 1248, "udp"},
{"mesavistaco",        {NULL}, 1249, "tcp"},
{"mesavistaco",        {NULL}, 1249, "udp"},
{"swldy-sias",         {NULL}, 1250, "tcp"},
{"swldy-sias",         {NULL}, 1250, "udp"},
{"servergraph",        {NULL}, 1251, "tcp"},
{"servergraph",        {NULL}, 1251, "udp"},
{"bspne-pcc",          {NULL}, 1252, "tcp"},
{"bspne-pcc",          {NULL}, 1252, "udp"},
{"q55-pcc",            {NULL}, 1253, "tcp"},
{"q55-pcc",            {NULL}, 1253, "udp"},
{"de-noc",             {NULL}, 1254, "tcp"},
{"de-noc",             {NULL}, 1254, "udp"},
{"de-cache-query",     {NULL}, 1255, "tcp"},
{"de-cache-query",     {NULL}, 1255, "udp"},
{"de-server",          {NULL}, 1256, "tcp"},
{"de-server",          {NULL}, 1256, "udp"},
{"shockwave2",         {NULL}, 1257, "tcp"},
{"shockwave2",         {NULL}, 1257, "udp"},
{"opennl",             {NULL}, 1258, "tcp"},
{"opennl",             {NULL}, 1258, "udp"},
{"opennl-voice",       {NULL}, 1259, "tcp"},
{"opennl-voice",       {NULL}, 1259, "udp"},
{"ibm-ssd",            {NULL}, 1260, "tcp"},
{"ibm-ssd",            {NULL}, 1260, "udp"},
{"mpshrsv",            {NULL}, 1261, "tcp"},
{"mpshrsv",            {NULL}, 1261, "udp"},
{"qnts-orb",           {NULL}, 1262, "tcp"},
{"qnts-orb",           {NULL}, 1262, "udp"},
{"dka",                {NULL}, 1263, "tcp"},
{"dka",                {NULL}, 1263, "udp"},
{"prat",               {NULL}, 1264, "tcp"},
{"prat",               {NULL}, 1264, "udp"},
{"dssiapi",            {NULL}, 1265, "tcp"},
{"dssiapi",            {NULL}, 1265, "udp"},
{"dellpwrappks",       {NULL}, 1266, "tcp"},
{"dellpwrappks",       {NULL}, 1266, "udp"},
{"epc",                {NULL}, 1267, "tcp"},
{"epc",                {NULL}, 1267, "udp"},
{"propel-msgsys",      {NULL}, 1268, "tcp"},
{"propel-msgsys",      {NULL}, 1268, "udp"},
{"watilapp",           {NULL}, 1269, "tcp"},
{"watilapp",           {NULL}, 1269, "udp"},
{"opsmgr",             {NULL}, 1270, "tcp"},
{"opsmgr",             {NULL}, 1270, "udp"},
{"excw",               {NULL}, 1271, "tcp"},
{"excw",               {NULL}, 1271, "udp"},
{"cspmlockmgr",        {NULL}, 1272, "tcp"},
{"cspmlockmgr",        {NULL}, 1272, "udp"},
{"emc-gateway",        {NULL}, 1273, "tcp"},
{"emc-gateway",        {NULL}, 1273, "udp"},
{"t1distproc",         {NULL}, 1274, "tcp"},
{"t1distproc",         {NULL}, 1274, "udp"},
{"ivcollector",        {NULL}, 1275, "tcp"},
{"ivcollector",        {NULL}, 1275, "udp"},
{"ivmanager",          {NULL}, 1276, "tcp"},
{"ivmanager",          {NULL}, 1276, "udp"},
{"miva-mqs",           {NULL}, 1277, "tcp"},
{"miva-mqs",           {NULL}, 1277, "udp"},
{"dellwebadmin-1",     {NULL}, 1278, "tcp"},
{"dellwebadmin-1",     {NULL}, 1278, "udp"},
{"dellwebadmin-2",     {NULL}, 1279, "tcp"},
{"dellwebadmin-2",     {NULL}, 1279, "udp"},
{"pictrography",       {NULL}, 1280, "tcp"},
{"pictrography",       {NULL}, 1280, "udp"},
{"healthd",            {NULL}, 1281, "tcp"},
{"healthd",            {NULL}, 1281, "udp"},
{"emperion",           {NULL}, 1282, "tcp"},
{"emperion",           {NULL}, 1282, "udp"},
{"productinfo",        {NULL}, 1283, "tcp"},
{"productinfo",        {NULL}, 1283, "udp"},
{"iee-qfx",            {NULL}, 1284, "tcp"},
{"iee-qfx",            {NULL}, 1284, "udp"},
{"neoiface",           {NULL}, 1285, "tcp"},
{"neoiface",           {NULL}, 1285, "udp"},
{"netuitive",          {NULL}, 1286, "tcp"},
{"netuitive",          {NULL}, 1286, "udp"},
{"routematch",         {NULL}, 1287, "tcp"},
{"routematch",         {NULL}, 1287, "udp"},
{"navbuddy",           {NULL}, 1288, "tcp"},
{"navbuddy",           {NULL}, 1288, "udp"},
{"jwalkserver",        {NULL}, 1289, "tcp"},
{"jwalkserver",        {NULL}, 1289, "udp"},
{"winjaserver",        {NULL}, 1290, "tcp"},
{"winjaserver",        {NULL}, 1290, "udp"},
{"seagulllms",         {NULL}, 1291, "tcp"},
{"seagulllms",         {NULL}, 1291, "udp"},
{"dsdn",               {NULL}, 1292, "tcp"},
{"dsdn",               {NULL}, 1292, "udp"},
{"pkt-krb-ipsec",      {NULL}, 1293, "tcp"},
{"pkt-krb-ipsec",      {NULL}, 1293, "udp"},
{"cmmdriver",          {NULL}, 1294, "tcp"},
{"cmmdriver",          {NULL}, 1294, "udp"},
{"ehtp",               {NULL}, 1295, "tcp"},
{"ehtp",               {NULL}, 1295, "udp"},
{"dproxy",             {NULL}, 1296, "tcp"},
{"dproxy",             {NULL}, 1296, "udp"},
{"sdproxy",            {NULL}, 1297, "tcp"},
{"sdproxy",            {NULL}, 1297, "udp"},
{"lpcp",               {NULL}, 1298, "tcp"},
{"lpcp",               {NULL}, 1298, "udp"},
{"hp-sci",             {NULL}, 1299, "tcp"},
{"hp-sci",             {NULL}, 1299, "udp"},
{"h323hostcallsc",     {NULL}, 1300, "tcp"},
{"h323hostcallsc",     {NULL}, 1300, "udp"},
{"ci3-software-1",     {NULL}, 1301, "tcp"},
{"ci3-software-1",     {NULL}, 1301, "udp"},
{"ci3-software-2",     {NULL}, 1302, "tcp"},
{"ci3-software-2",     {NULL}, 1302, "udp"},
{"sftsrv",             {NULL}, 1303, "tcp"},
{"sftsrv",             {NULL}, 1303, "udp"},
{"boomerang",          {NULL}, 1304, "tcp"},
{"boomerang",          {NULL}, 1304, "udp"},
{"pe-mike",            {NULL}, 1305, "tcp"},
{"pe-mike",            {NULL}, 1305, "udp"},
{"re-conn-proto",      {NULL}, 1306, "tcp"},
{"re-conn-proto",      {NULL}, 1306, "udp"},
{"pacmand",            {NULL}, 1307, "tcp"},
{"pacmand",            {NULL}, 1307, "udp"},
{"odsi",               {NULL}, 1308, "tcp"},
{"odsi",               {NULL}, 1308, "udp"},
{"jtag-server",        {NULL}, 1309, "tcp"},
{"jtag-server",        {NULL}, 1309, "udp"},
{"husky",              {NULL}, 1310, "tcp"},
{"husky",              {NULL}, 1310, "udp"},
{"rxmon",              {NULL}, 1311, "tcp"},
{"rxmon",              {NULL}, 1311, "udp"},
{"sti-envision",       {NULL}, 1312, "tcp"},
{"sti-envision",       {NULL}, 1312, "udp"},
{"bmc_patroldb",       {NULL}, 1313, "tcp"},
{"bmc_patroldb",       {NULL}, 1313, "udp"},
{"pdps",               {NULL}, 1314, "tcp"},
{"pdps",               {NULL}, 1314, "udp"},
{"els",                {NULL}, 1315, "tcp"},
{"els",                {NULL}, 1315, "udp"},
{"exbit-escp",         {NULL}, 1316, "tcp"},
{"exbit-escp",         {NULL}, 1316, "udp"},
{"vrts-ipcserver",     {NULL}, 1317, "tcp"},
{"vrts-ipcserver",     {NULL}, 1317, "udp"},
{"krb5gatekeeper",     {NULL}, 1318, "tcp"},
{"krb5gatekeeper",     {NULL}, 1318, "udp"},
{"amx-icsp",           {NULL}, 1319, "tcp"},
{"amx-icsp",           {NULL}, 1319, "udp"},
{"amx-axbnet",         {NULL}, 1320, "tcp"},
{"amx-axbnet",         {NULL}, 1320, "udp"},
{"pip",                {NULL}, 1321, "tcp"},
{"pip",                {NULL}, 1321, "udp"},
{"novation",           {NULL}, 1322, "tcp"},
{"novation",           {NULL}, 1322, "udp"},
{"brcd",               {NULL}, 1323, "tcp"},
{"brcd",               {NULL}, 1323, "udp"},
{"delta-mcp",          {NULL}, 1324, "tcp"},
{"delta-mcp",          {NULL}, 1324, "udp"},
{"dx-instrument",      {NULL}, 1325, "tcp"},
{"dx-instrument",      {NULL}, 1325, "udp"},
{"wimsic",             {NULL}, 1326, "tcp"},
{"wimsic",             {NULL}, 1326, "udp"},
{"ultrex",             {NULL}, 1327, "tcp"},
{"ultrex",             {NULL}, 1327, "udp"},
{"ewall",              {NULL}, 1328, "tcp"},
{"ewall",              {NULL}, 1328, "udp"},
{"netdb-export",       {NULL}, 1329, "tcp"},
{"netdb-export",       {NULL}, 1329, "udp"},
{"streetperfect",      {NULL}, 1330, "tcp"},
{"streetperfect",      {NULL}, 1330, "udp"},
{"intersan",           {NULL}, 1331, "tcp"},
{"intersan",           {NULL}, 1331, "udp"},
{"pcia-rxp-b",         {NULL}, 1332, "tcp"},
{"pcia-rxp-b",         {NULL}, 1332, "udp"},
{"passwrd-policy",     {NULL}, 1333, "tcp"},
{"passwrd-policy",     {NULL}, 1333, "udp"},
{"writesrv",           {NULL}, 1334, "tcp"},
{"writesrv",           {NULL}, 1334, "udp"},
{"digital-notary",     {NULL}, 1335, "tcp"},
{"digital-notary",     {NULL}, 1335, "udp"},
{"ischat",             {NULL}, 1336, "tcp"},
{"ischat",             {NULL}, 1336, "udp"},
{"menandmice-dns",     {NULL}, 1337, "tcp"},
{"menandmice-dns",     {NULL}, 1337, "udp"},
{"wmc-log-svc",        {NULL}, 1338, "tcp"},
{"wmc-log-svc",        {NULL}, 1338, "udp"},
{"kjtsiteserver",      {NULL}, 1339, "tcp"},
{"kjtsiteserver",      {NULL}, 1339, "udp"},
{"naap",               {NULL}, 1340, "tcp"},
{"naap",               {NULL}, 1340, "udp"},
{"qubes",              {NULL}, 1341, "tcp"},
{"qubes",              {NULL}, 1341, "udp"},
{"esbroker",           {NULL}, 1342, "tcp"},
{"esbroker",           {NULL}, 1342, "udp"},
{"re101",              {NULL}, 1343, "tcp"},
{"re101",              {NULL}, 1343, "udp"},
{"icap",               {NULL}, 1344, "tcp"},
{"icap",               {NULL}, 1344, "udp"},
{"vpjp",               {NULL}, 1345, "tcp"},
{"vpjp",               {NULL}, 1345, "udp"},
{"alta-ana-lm",        {NULL}, 1346, "tcp"},
{"alta-ana-lm",        {NULL}, 1346, "udp"},
{"bbn-mmc",            {NULL}, 1347, "tcp"},
{"bbn-mmc",            {NULL}, 1347, "udp"},
{"bbn-mmx",            {NULL}, 1348, "tcp"},
{"bbn-mmx",            {NULL}, 1348, "udp"},
{"sbook",              {NULL}, 1349, "tcp"},
{"sbook",              {NULL}, 1349, "udp"},
{"editbench",          {NULL}, 1350, "tcp"},
{"editbench",          {NULL}, 1350, "udp"},
{"equationbuilder",    {NULL}, 1351, "tcp"},
{"equationbuilder",    {NULL}, 1351, "udp"},
{"lotusnote",          {NULL}, 1352, "tcp"},
{"lotusnote",          {NULL}, 1352, "udp"},
{"relief",             {NULL}, 1353, "tcp"},
{"relief",             {NULL}, 1353, "udp"},
{"XSIP-network",       {NULL}, 1354, "tcp"},
{"XSIP-network",       {NULL}, 1354, "udp"},
{"intuitive-edge",     {NULL}, 1355, "tcp"},
{"intuitive-edge",     {NULL}, 1355, "udp"},
{"cuillamartin",       {NULL}, 1356, "tcp"},
{"cuillamartin",       {NULL}, 1356, "udp"},
{"pegboard",           {NULL}, 1357, "tcp"},
{"pegboard",           {NULL}, 1357, "udp"},
{"connlcli",           {NULL}, 1358, "tcp"},
{"connlcli",           {NULL}, 1358, "udp"},
{"ftsrv",              {NULL}, 1359, "tcp"},
{"ftsrv",              {NULL}, 1359, "udp"},
{"mimer",              {NULL}, 1360, "tcp"},
{"mimer",              {NULL}, 1360, "udp"},
{"linx",               {NULL}, 1361, "tcp"},
{"linx",               {NULL}, 1361, "udp"},
{"timeflies",          {NULL}, 1362, "tcp"},
{"timeflies",          {NULL}, 1362, "udp"},
{"ndm-requester",      {NULL}, 1363, "tcp"},
{"ndm-requester",      {NULL}, 1363, "udp"},
{"ndm-server",         {NULL}, 1364, "tcp"},
{"ndm-server",         {NULL}, 1364, "udp"},
{"adapt-sna",          {NULL}, 1365, "tcp"},
{"adapt-sna",          {NULL}, 1365, "udp"},
{"netware-csp",        {NULL}, 1366, "tcp"},
{"netware-csp",        {NULL}, 1366, "udp"},
{"dcs",                {NULL}, 1367, "tcp"},
{"dcs",                {NULL}, 1367, "udp"},
{"screencast",         {NULL}, 1368, "tcp"},
{"screencast",         {NULL}, 1368, "udp"},
{"gv-us",              {NULL}, 1369, "tcp"},
{"gv-us",              {NULL}, 1369, "udp"},
{"us-gv",              {NULL}, 1370, "tcp"},
{"us-gv",              {NULL}, 1370, "udp"},
{"fc-cli",             {NULL}, 1371, "tcp"},
{"fc-cli",             {NULL}, 1371, "udp"},
{"fc-ser",             {NULL}, 1372, "tcp"},
{"fc-ser",             {NULL}, 1372, "udp"},
{"chromagrafx",        {NULL}, 1373, "tcp"},
{"chromagrafx",        {NULL}, 1373, "udp"},
{"molly",              {NULL}, 1374, "tcp"},
{"molly",              {NULL}, 1374, "udp"},
{"bytex",              {NULL}, 1375, "tcp"},
{"bytex",              {NULL}, 1375, "udp"},
{"ibm-pps",            {NULL}, 1376, "tcp"},
{"ibm-pps",            {NULL}, 1376, "udp"},
{"cichlid",            {NULL}, 1377, "tcp"},
{"cichlid",            {NULL}, 1377, "udp"},
{"elan",               {NULL}, 1378, "tcp"},
{"elan",               {NULL}, 1378, "udp"},
{"dbreporter",         {NULL}, 1379, "tcp"},
{"dbreporter",         {NULL}, 1379, "udp"},
{"telesis-licman",     {NULL}, 1380, "tcp"},
{"telesis-licman",     {NULL}, 1380, "udp"},
{"apple-licman",       {NULL}, 1381, "tcp"},
{"apple-licman",       {NULL}, 1381, "udp"},
{"udt_os",             {NULL}, 1382, "tcp"},
{"udt_os",             {NULL}, 1382, "udp"},
{"gwha",               {NULL}, 1383, "tcp"},
{"gwha",               {NULL}, 1383, "udp"},
{"os-licman",          {NULL}, 1384, "tcp"},
{"os-licman",          {NULL}, 1384, "udp"},
{"atex_elmd",          {NULL}, 1385, "tcp"},
{"atex_elmd",          {NULL}, 1385, "udp"},
{"checksum",           {NULL}, 1386, "tcp"},
{"checksum",           {NULL}, 1386, "udp"},
{"cadsi-lm",           {NULL}, 1387, "tcp"},
{"cadsi-lm",           {NULL}, 1387, "udp"},
{"objective-dbc",      {NULL}, 1388, "tcp"},
{"objective-dbc",      {NULL}, 1388, "udp"},
{"iclpv-dm",           {NULL}, 1389, "tcp"},
{"iclpv-dm",           {NULL}, 1389, "udp"},
{"iclpv-sc",           {NULL}, 1390, "tcp"},
{"iclpv-sc",           {NULL}, 1390, "udp"},
{"iclpv-sas",          {NULL}, 1391, "tcp"},
{"iclpv-sas",          {NULL}, 1391, "udp"},
{"iclpv-pm",           {NULL}, 1392, "tcp"},
{"iclpv-pm",           {NULL}, 1392, "udp"},
{"iclpv-nls",          {NULL}, 1393, "tcp"},
{"iclpv-nls",          {NULL}, 1393, "udp"},
{"iclpv-nlc",          {NULL}, 1394, "tcp"},
{"iclpv-nlc",          {NULL}, 1394, "udp"},
{"iclpv-wsm",          {NULL}, 1395, "tcp"},
{"iclpv-wsm",          {NULL}, 1395, "udp"},
{"dvl-activemail",     {NULL}, 1396, "tcp"},
{"dvl-activemail",     {NULL}, 1396, "udp"},
{"audio-activmail",    {NULL}, 1397, "tcp"},
{"audio-activmail",    {NULL}, 1397, "udp"},
{"video-activmail",    {NULL}, 1398, "tcp"},
{"video-activmail",    {NULL}, 1398, "udp"},
{"cadkey-licman",      {NULL}, 1399, "tcp"},
{"cadkey-licman",      {NULL}, 1399, "udp"},
{"cadkey-tablet",      {NULL}, 1400, "tcp"},
{"cadkey-tablet",      {NULL}, 1400, "udp"},
{"goldleaf-licman",    {NULL}, 1401, "tcp"},
{"goldleaf-licman",    {NULL}, 1401, "udp"},
{"prm-sm-np",          {NULL}, 1402, "tcp"},
{"prm-sm-np",          {NULL}, 1402, "udp"},
{"prm-nm-np",          {NULL}, 1403, "tcp"},
{"prm-nm-np",          {NULL}, 1403, "udp"},
{"igi-lm",             {NULL}, 1404, "tcp"},
{"igi-lm",             {NULL}, 1404, "udp"},
{"ibm-res",            {NULL}, 1405, "tcp"},
{"ibm-res",            {NULL}, 1405, "udp"},
{"netlabs-lm",         {NULL}, 1406, "tcp"},
{"netlabs-lm",         {NULL}, 1406, "udp"},
{"dbsa-lm",            {NULL}, 1407, "tcp"},
{"dbsa-lm",            {NULL}, 1407, "udp"},
{"sophia-lm",          {NULL}, 1408, "tcp"},
{"sophia-lm",          {NULL}, 1408, "udp"},
{"here-lm",            {NULL}, 1409, "tcp"},
{"here-lm",            {NULL}, 1409, "udp"},
{"hiq",                {NULL}, 1410, "tcp"},
{"hiq",                {NULL}, 1410, "udp"},
{"af",                 {NULL}, 1411, "tcp"},
{"af",                 {NULL}, 1411, "udp"},
{"innosys",            {NULL}, 1412, "tcp"},
{"innosys",            {NULL}, 1412, "udp"},
{"innosys-acl",        {NULL}, 1413, "tcp"},
{"innosys-acl",        {NULL}, 1413, "udp"},
{"ibm-mqseries",       {NULL}, 1414, "tcp"},
{"ibm-mqseries",       {NULL}, 1414, "udp"},
{"dbstar",             {NULL}, 1415, "tcp"},
{"dbstar",             {NULL}, 1415, "udp"},
{"novell-lu6.2",       {NULL}, 1416, "tcp"},
{"novell-lu6.2",       {NULL}, 1416, "udp"},
{"timbuktu-srv1",      {NULL}, 1417, "tcp"},
{"timbuktu-srv1",      {NULL}, 1417, "udp"},
{"timbuktu-srv2",      {NULL}, 1418, "tcp"},
{"timbuktu-srv2",      {NULL}, 1418, "udp"},
{"timbuktu-srv3",      {NULL}, 1419, "tcp"},
{"timbuktu-srv3",      {NULL}, 1419, "udp"},
{"timbuktu-srv4",      {NULL}, 1420, "tcp"},
{"timbuktu-srv4",      {NULL}, 1420, "udp"},
{"gandalf-lm",         {NULL}, 1421, "tcp"},
{"gandalf-lm",         {NULL}, 1421, "udp"},
{"autodesk-lm",        {NULL}, 1422, "tcp"},
{"autodesk-lm",        {NULL}, 1422, "udp"},
{"essbase",            {NULL}, 1423, "tcp"},
{"essbase",            {NULL}, 1423, "udp"},
{"hybrid",             {NULL}, 1424, "tcp"},
{"hybrid",             {NULL}, 1424, "udp"},
{"zion-lm",            {NULL}, 1425, "tcp"},
{"zion-lm",            {NULL}, 1425, "udp"},
{"sais",               {NULL}, 1426, "tcp"},
{"sais",               {NULL}, 1426, "udp"},
{"mloadd",             {NULL}, 1427, "tcp"},
{"mloadd",             {NULL}, 1427, "udp"},
{"informatik-lm",      {NULL}, 1428, "tcp"},
{"informatik-lm",      {NULL}, 1428, "udp"},
{"nms",                {NULL}, 1429, "tcp"},
{"nms",                {NULL}, 1429, "udp"},
{"tpdu",               {NULL}, 1430, "tcp"},
{"tpdu",               {NULL}, 1430, "udp"},
{"rgtp",               {NULL}, 1431, "tcp"},
{"rgtp",               {NULL}, 1431, "udp"},
{"blueberry-lm",       {NULL}, 1432, "tcp"},
{"blueberry-lm",       {NULL}, 1432, "udp"},
{"ms-sql-s",           {NULL}, 1433, "tcp"},
{"ms-sql-s",           {NULL}, 1433, "udp"},
{"ms-sql-m",           {NULL}, 1434, "tcp"},
{"ms-sql-m",           {NULL}, 1434, "udp"},
{"ibm-cics",           {NULL}, 1435, "tcp"},
{"ibm-cics",           {NULL}, 1435, "udp"},
{"saism",              {NULL}, 1436, "tcp"},
{"saism",              {NULL}, 1436, "udp"},
{"tabula",             {NULL}, 1437, "tcp"},
{"tabula",             {NULL}, 1437, "udp"},
{"eicon-server",       {NULL}, 1438, "tcp"},
{"eicon-server",       {NULL}, 1438, "udp"},
{"eicon-x25",          {NULL}, 1439, "tcp"},
{"eicon-x25",          {NULL}, 1439, "udp"},
{"eicon-slp",          {NULL}, 1440, "tcp"},
{"eicon-slp",          {NULL}, 1440, "udp"},
{"cadis-1",            {NULL}, 1441, "tcp"},
{"cadis-1",            {NULL}, 1441, "udp"},
{"cadis-2",            {NULL}, 1442, "tcp"},
{"cadis-2",            {NULL}, 1442, "udp"},
{"ies-lm",             {NULL}, 1443, "tcp"},
{"ies-lm",             {NULL}, 1443, "udp"},
{"marcam-lm",          {NULL}, 1444, "tcp"},
{"marcam-lm",          {NULL}, 1444, "udp"},
{"proxima-lm",         {NULL}, 1445, "tcp"},
{"proxima-lm",         {NULL}, 1445, "udp"},
{"ora-lm",             {NULL}, 1446, "tcp"},
{"ora-lm",             {NULL}, 1446, "udp"},
{"apri-lm",            {NULL}, 1447, "tcp"},
{"apri-lm",            {NULL}, 1447, "udp"},
{"oc-lm",              {NULL}, 1448, "tcp"},
{"oc-lm",              {NULL}, 1448, "udp"},
{"peport",             {NULL}, 1449, "tcp"},
{"peport",             {NULL}, 1449, "udp"},
{"dwf",                {NULL}, 1450, "tcp"},
{"dwf",                {NULL}, 1450, "udp"},
{"infoman",            {NULL}, 1451, "tcp"},
{"infoman",            {NULL}, 1451, "udp"},
{"gtegsc-lm",          {NULL}, 1452, "tcp"},
{"gtegsc-lm",          {NULL}, 1452, "udp"},
{"genie-lm",           {NULL}, 1453, "tcp"},
{"genie-lm",           {NULL}, 1453, "udp"},
{"interhdl_elmd",      {NULL}, 1454, "tcp"},
{"interhdl_elmd",      {NULL}, 1454, "udp"},
{"esl-lm",             {NULL}, 1455, "tcp"},
{"esl-lm",             {NULL}, 1455, "udp"},
{"dca",                {NULL}, 1456, "tcp"},
{"dca",                {NULL}, 1456, "udp"},
{"valisys-lm",         {NULL}, 1457, "tcp"},
{"valisys-lm",         {NULL}, 1457, "udp"},
{"nrcabq-lm",          {NULL}, 1458, "tcp"},
{"nrcabq-lm",          {NULL}, 1458, "udp"},
{"proshare1",          {NULL}, 1459, "tcp"},
{"proshare1",          {NULL}, 1459, "udp"},
{"proshare2",          {NULL}, 1460, "tcp"},
{"proshare2",          {NULL}, 1460, "udp"},
{"ibm_wrless_lan",     {NULL}, 1461, "tcp"},
{"ibm_wrless_lan",     {NULL}, 1461, "udp"},
{"world-lm",           {NULL}, 1462, "tcp"},
{"world-lm",           {NULL}, 1462, "udp"},
{"nucleus",            {NULL}, 1463, "tcp"},
{"nucleus",            {NULL}, 1463, "udp"},
{"msl_lmd",            {NULL}, 1464, "tcp"},
{"msl_lmd",            {NULL}, 1464, "udp"},
{"pipes",              {NULL}, 1465, "tcp"},
{"pipes",              {NULL}, 1465, "udp"},
{"oceansoft-lm",       {NULL}, 1466, "tcp"},
{"oceansoft-lm",       {NULL}, 1466, "udp"},
{"csdmbase",           {NULL}, 1467, "tcp"},
{"csdmbase",           {NULL}, 1467, "udp"},
{"csdm",               {NULL}, 1468, "tcp"},
{"csdm",               {NULL}, 1468, "udp"},
{"aal-lm",             {NULL}, 1469, "tcp"},
{"aal-lm",             {NULL}, 1469, "udp"},
{"uaiact",             {NULL}, 1470, "tcp"},
{"uaiact",             {NULL}, 1470, "udp"},
{"csdmbase",           {NULL}, 1471, "tcp"},
{"csdmbase",           {NULL}, 1471, "udp"},
{"csdm",               {NULL}, 1472, "tcp"},
{"csdm",               {NULL}, 1472, "udp"},
{"openmath",           {NULL}, 1473, "tcp"},
{"openmath",           {NULL}, 1473, "udp"},
{"telefinder",         {NULL}, 1474, "tcp"},
{"telefinder",         {NULL}, 1474, "udp"},
{"taligent-lm",        {NULL}, 1475, "tcp"},
{"taligent-lm",        {NULL}, 1475, "udp"},
{"clvm-cfg",           {NULL}, 1476, "tcp"},
{"clvm-cfg",           {NULL}, 1476, "udp"},
{"ms-sna-server",      {NULL}, 1477, "tcp"},
{"ms-sna-server",      {NULL}, 1477, "udp"},
{"ms-sna-base",        {NULL}, 1478, "tcp"},
{"ms-sna-base",        {NULL}, 1478, "udp"},
{"dberegister",        {NULL}, 1479, "tcp"},
{"dberegister",        {NULL}, 1479, "udp"},
{"pacerforum",         {NULL}, 1480, "tcp"},
{"pacerforum",         {NULL}, 1480, "udp"},
{"airs",               {NULL}, 1481, "tcp"},
{"airs",               {NULL}, 1481, "udp"},
{"miteksys-lm",        {NULL}, 1482, "tcp"},
{"miteksys-lm",        {NULL}, 1482, "udp"},
{"afs",                {NULL}, 1483, "tcp"},
{"afs",                {NULL}, 1483, "udp"},
{"confluent",          {NULL}, 1484, "tcp"},
{"confluent",          {NULL}, 1484, "udp"},
{"lansource",          {NULL}, 1485, "tcp"},
{"lansource",          {NULL}, 1485, "udp"},
{"nms_topo_serv",      {NULL}, 1486, "tcp"},
{"nms_topo_serv",      {NULL}, 1486, "udp"},
{"localinfosrvr",      {NULL}, 1487, "tcp"},
{"localinfosrvr",      {NULL}, 1487, "udp"},
{"docstor",            {NULL}, 1488, "tcp"},
{"docstor",            {NULL}, 1488, "udp"},
{"dmdocbroker",        {NULL}, 1489, "tcp"},
{"dmdocbroker",        {NULL}, 1489, "udp"},
{"insitu-conf",        {NULL}, 1490, "tcp"},
{"insitu-conf",        {NULL}, 1490, "udp"},
{"stone-design-1",     {NULL}, 1492, "tcp"},
{"stone-design-1",     {NULL}, 1492, "udp"},
{"netmap_lm",          {NULL}, 1493, "tcp"},
{"netmap_lm",          {NULL}, 1493, "udp"},
{"ica",                {NULL}, 1494, "tcp"},
{"ica",                {NULL}, 1494, "udp"},
{"cvc",                {NULL}, 1495, "tcp"},
{"cvc",                {NULL}, 1495, "udp"},
{"liberty-lm",         {NULL}, 1496, "tcp"},
{"liberty-lm",         {NULL}, 1496, "udp"},
{"rfx-lm",             {NULL}, 1497, "tcp"},
{"rfx-lm",             {NULL}, 1497, "udp"},
{"sybase-sqlany",      {NULL}, 1498, "tcp"},
{"sybase-sqlany",      {NULL}, 1498, "udp"},
{"fhc",                {NULL}, 1499, "tcp"},
{"fhc",                {NULL}, 1499, "udp"},
{"vlsi-lm",            {NULL}, 1500, "tcp"},
{"vlsi-lm",            {NULL}, 1500, "udp"},
{"saiscm",             {NULL}, 1501, "tcp"},
{"saiscm",             {NULL}, 1501, "udp"},
{"shivadiscovery",     {NULL}, 1502, "tcp"},
{"shivadiscovery",     {NULL}, 1502, "udp"},
{"imtc-mcs",           {NULL}, 1503, "tcp"},
{"imtc-mcs",           {NULL}, 1503, "udp"},
{"evb-elm",            {NULL}, 1504, "tcp"},
{"evb-elm",            {NULL}, 1504, "udp"},
{"funkproxy",          {NULL}, 1505, "tcp"},
{"funkproxy",          {NULL}, 1505, "udp"},
{"utcd",               {NULL}, 1506, "tcp"},
{"utcd",               {NULL}, 1506, "udp"},
{"symplex",            {NULL}, 1507, "tcp"},
{"symplex",            {NULL}, 1507, "udp"},
{"diagmond",           {NULL}, 1508, "tcp"},
{"diagmond",           {NULL}, 1508, "udp"},
{"robcad-lm",          {NULL}, 1509, "tcp"},
{"robcad-lm",          {NULL}, 1509, "udp"},
{"mvx-lm",             {NULL}, 1510, "tcp"},
{"mvx-lm",             {NULL}, 1510, "udp"},
{"3l-l1",              {NULL}, 1511, "tcp"},
{"3l-l1",              {NULL}, 1511, "udp"},
{"wins",               {NULL}, 1512, "tcp"},
{"wins",               {NULL}, 1512, "udp"},
{"fujitsu-dtc",        {NULL}, 1513, "tcp"},
{"fujitsu-dtc",        {NULL}, 1513, "udp"},
{"fujitsu-dtcns",      {NULL}, 1514, "tcp"},
{"fujitsu-dtcns",      {NULL}, 1514, "udp"},
{"ifor-protocol",      {NULL}, 1515, "tcp"},
{"ifor-protocol",      {NULL}, 1515, "udp"},
{"vpad",               {NULL}, 1516, "tcp"},
{"vpad",               {NULL}, 1516, "udp"},
{"vpac",               {NULL}, 1517, "tcp"},
{"vpac",               {NULL}, 1517, "udp"},
{"vpvd",               {NULL}, 1518, "tcp"},
{"vpvd",               {NULL}, 1518, "udp"},
{"vpvc",               {NULL}, 1519, "tcp"},
{"vpvc",               {NULL}, 1519, "udp"},
{"atm-zip-office",     {NULL}, 1520, "tcp"},
{"atm-zip-office",     {NULL}, 1520, "udp"},
{"ncube-lm",           {NULL}, 1521, "tcp"},
{"ncube-lm",           {NULL}, 1521, "udp"},
{"ricardo-lm",         {NULL}, 1522, "tcp"},
{"ricardo-lm",         {NULL}, 1522, "udp"},
{"cichild-lm",         {NULL}, 1523, "tcp"},
{"cichild-lm",         {NULL}, 1523, "udp"},
{"ingreslock",         {NULL}, 1524, "tcp"},
{"ingreslock",         {NULL}, 1524, "udp"},
{"orasrv",             {NULL}, 1525, "tcp"},
{"orasrv",             {NULL}, 1525, "udp"},
{"prospero-np",        {NULL}, 1525, "tcp"},
{"prospero-np",        {NULL}, 1525, "udp"},
{"pdap-np",            {NULL}, 1526, "tcp"},
{"pdap-np",            {NULL}, 1526, "udp"},
{"tlisrv",             {NULL}, 1527, "tcp"},
{"tlisrv",             {NULL}, 1527, "udp"},
{"coauthor",           {NULL}, 1529, "tcp"},
{"coauthor",           {NULL}, 1529, "udp"},
{"rap-service",        {NULL}, 1530, "tcp"},
{"rap-service",        {NULL}, 1530, "udp"},
{"rap-listen",         {NULL}, 1531, "tcp"},
{"rap-listen",         {NULL}, 1531, "udp"},
{"miroconnect",        {NULL}, 1532, "tcp"},
{"miroconnect",        {NULL}, 1532, "udp"},
{"virtual-places",     {NULL}, 1533, "tcp"},
{"virtual-places",     {NULL}, 1533, "udp"},
{"micromuse-lm",       {NULL}, 1534, "tcp"},
{"micromuse-lm",       {NULL}, 1534, "udp"},
{"ampr-info",          {NULL}, 1535, "tcp"},
{"ampr-info",          {NULL}, 1535, "udp"},
{"ampr-inter",         {NULL}, 1536, "tcp"},
{"ampr-inter",         {NULL}, 1536, "udp"},
{"sdsc-lm",            {NULL}, 1537, "tcp"},
{"sdsc-lm",            {NULL}, 1537, "udp"},
{"3ds-lm",             {NULL}, 1538, "tcp"},
{"3ds-lm",             {NULL}, 1538, "udp"},
{"intellistor-lm",     {NULL}, 1539, "tcp"},
{"intellistor-lm",     {NULL}, 1539, "udp"},
{"rds",                {NULL}, 1540, "tcp"},
{"rds",                {NULL}, 1540, "udp"},
{"rds2",               {NULL}, 1541, "tcp"},
{"rds2",               {NULL}, 1541, "udp"},
{"gridgen-elmd",       {NULL}, 1542, "tcp"},
{"gridgen-elmd",       {NULL}, 1542, "udp"},
{"simba-cs",           {NULL}, 1543, "tcp"},
{"simba-cs",           {NULL}, 1543, "udp"},
{"aspeclmd",           {NULL}, 1544, "tcp"},
{"aspeclmd",           {NULL}, 1544, "udp"},
{"vistium-share",      {NULL}, 1545, "tcp"},
{"vistium-share",      {NULL}, 1545, "udp"},
{"abbaccuray",         {NULL}, 1546, "tcp"},
{"abbaccuray",         {NULL}, 1546, "udp"},
{"laplink",            {NULL}, 1547, "tcp"},
{"laplink",            {NULL}, 1547, "udp"},
{"axon-lm",            {NULL}, 1548, "tcp"},
{"axon-lm",            {NULL}, 1548, "udp"},
{"shivahose",          {NULL}, 1549, "tcp"},
{"shivasound",         {NULL}, 1549, "udp"},
{"3m-image-lm",        {NULL}, 1550, "tcp"},
{"3m-image-lm",        {NULL}, 1550, "udp"},
{"hecmtl-db",          {NULL}, 1551, "tcp"},
{"hecmtl-db",          {NULL}, 1551, "udp"},
{"pciarray",           {NULL}, 1552, "tcp"},
{"pciarray",           {NULL}, 1552, "udp"},
{"sna-cs",             {NULL}, 1553, "tcp"},
{"sna-cs",             {NULL}, 1553, "udp"},
{"caci-lm",            {NULL}, 1554, "tcp"},
{"caci-lm",            {NULL}, 1554, "udp"},
{"livelan",            {NULL}, 1555, "tcp"},
{"livelan",            {NULL}, 1555, "udp"},
{"veritas_pbx",        {NULL}, 1556, "tcp"},
{"veritas_pbx",        {NULL}, 1556, "udp"},
{"arbortext-lm",       {NULL}, 1557, "tcp"},
{"arbortext-lm",       {NULL}, 1557, "udp"},
{"xingmpeg",           {NULL}, 1558, "tcp"},
{"xingmpeg",           {NULL}, 1558, "udp"},
{"web2host",           {NULL}, 1559, "tcp"},
{"web2host",           {NULL}, 1559, "udp"},
{"asci-val",           {NULL}, 1560, "tcp"},
{"asci-val",           {NULL}, 1560, "udp"},
{"facilityview",       {NULL}, 1561, "tcp"},
{"facilityview",       {NULL}, 1561, "udp"},
{"pconnectmgr",        {NULL}, 1562, "tcp"},
{"pconnectmgr",        {NULL}, 1562, "udp"},
{"cadabra-lm",         {NULL}, 1563, "tcp"},
{"cadabra-lm",         {NULL}, 1563, "udp"},
{"pay-per-view",       {NULL}, 1564, "tcp"},
{"pay-per-view",       {NULL}, 1564, "udp"},
{"winddlb",            {NULL}, 1565, "tcp"},
{"winddlb",            {NULL}, 1565, "udp"},
{"corelvideo",         {NULL}, 1566, "tcp"},
{"corelvideo",         {NULL}, 1566, "udp"},
{"jlicelmd",           {NULL}, 1567, "tcp"},
{"jlicelmd",           {NULL}, 1567, "udp"},
{"tsspmap",            {NULL}, 1568, "tcp"},
{"tsspmap",            {NULL}, 1568, "udp"},
{"ets",                {NULL}, 1569, "tcp"},
{"ets",                {NULL}, 1569, "udp"},
{"orbixd",             {NULL}, 1570, "tcp"},
{"orbixd",             {NULL}, 1570, "udp"},
{"rdb-dbs-disp",       {NULL}, 1571, "tcp"},
{"rdb-dbs-disp",       {NULL}, 1571, "udp"},
{"chip-lm",            {NULL}, 1572, "tcp"},
{"chip-lm",            {NULL}, 1572, "udp"},
{"itscomm-ns",         {NULL}, 1573, "tcp"},
{"itscomm-ns",         {NULL}, 1573, "udp"},
{"mvel-lm",            {NULL}, 1574, "tcp"},
{"mvel-lm",            {NULL}, 1574, "udp"},
{"oraclenames",        {NULL}, 1575, "tcp"},
{"oraclenames",        {NULL}, 1575, "udp"},
{"moldflow-lm",        {NULL}, 1576, "tcp"},
{"moldflow-lm",        {NULL}, 1576, "udp"},
{"hypercube-lm",       {NULL}, 1577, "tcp"},
{"hypercube-lm",       {NULL}, 1577, "udp"},
{"jacobus-lm",         {NULL}, 1578, "tcp"},
{"jacobus-lm",         {NULL}, 1578, "udp"},
{"ioc-sea-lm",         {NULL}, 1579, "tcp"},
{"ioc-sea-lm",         {NULL}, 1579, "udp"},
{"tn-tl-r1",           {NULL}, 1580, "tcp"},
{"tn-tl-r2",           {NULL}, 1580, "udp"},
{"mil-2045-47001",     {NULL}, 1581, "tcp"},
{"mil-2045-47001",     {NULL}, 1581, "udp"},
{"msims",              {NULL}, 1582, "tcp"},
{"msims",              {NULL}, 1582, "udp"},
{"simbaexpress",       {NULL}, 1583, "tcp"},
{"simbaexpress",       {NULL}, 1583, "udp"},
{"tn-tl-fd2",          {NULL}, 1584, "tcp"},
{"tn-tl-fd2",          {NULL}, 1584, "udp"},
{"intv",               {NULL}, 1585, "tcp"},
{"intv",               {NULL}, 1585, "udp"},
{"ibm-abtact",         {NULL}, 1586, "tcp"},
{"ibm-abtact",         {NULL}, 1586, "udp"},
{"pra_elmd",           {NULL}, 1587, "tcp"},
{"pra_elmd",           {NULL}, 1587, "udp"},
{"triquest-lm",        {NULL}, 1588, "tcp"},
{"triquest-lm",        {NULL}, 1588, "udp"},
{"vqp",                {NULL}, 1589, "tcp"},
{"vqp",                {NULL}, 1589, "udp"},
{"gemini-lm",          {NULL}, 1590, "tcp"},
{"gemini-lm",          {NULL}, 1590, "udp"},
{"ncpm-pm",            {NULL}, 1591, "tcp"},
{"ncpm-pm",            {NULL}, 1591, "udp"},
{"commonspace",        {NULL}, 1592, "tcp"},
{"commonspace",        {NULL}, 1592, "udp"},
{"mainsoft-lm",        {NULL}, 1593, "tcp"},
{"mainsoft-lm",        {NULL}, 1593, "udp"},
{"sixtrak",            {NULL}, 1594, "tcp"},
{"sixtrak",            {NULL}, 1594, "udp"},
{"radio",              {NULL}, 1595, "tcp"},
{"radio",              {NULL}, 1595, "udp"},
{"radio-sm",           {NULL}, 1596, "tcp"},
{"radio-bc",           {NULL}, 1596, "udp"},
{"orbplus-iiop",       {NULL}, 1597, "tcp"},
{"orbplus-iiop",       {NULL}, 1597, "udp"},
{"picknfs",            {NULL}, 1598, "tcp"},
{"picknfs",            {NULL}, 1598, "udp"},
{"simbaservices",      {NULL}, 1599, "tcp"},
{"simbaservices",      {NULL}, 1599, "udp"},
{"issd",               {NULL}, 1600, "tcp"},
{"issd",               {NULL}, 1600, "udp"},
{"aas",                {NULL}, 1601, "tcp"},
{"aas",                {NULL}, 1601, "udp"},
{"inspect",            {NULL}, 1602, "tcp"},
{"inspect",            {NULL}, 1602, "udp"},
{"picodbc",            {NULL}, 1603, "tcp"},
{"picodbc",            {NULL}, 1603, "udp"},
{"icabrowser",         {NULL}, 1604, "tcp"},
{"icabrowser",         {NULL}, 1604, "udp"},
{"slp",                {NULL}, 1605, "tcp"},
{"slp",                {NULL}, 1605, "udp"},
{"slm-api",            {NULL}, 1606, "tcp"},
{"slm-api",            {NULL}, 1606, "udp"},
{"stt",                {NULL}, 1607, "tcp"},
{"stt",                {NULL}, 1607, "udp"},
{"smart-lm",           {NULL}, 1608, "tcp"},
{"smart-lm",           {NULL}, 1608, "udp"},
{"isysg-lm",           {NULL}, 1609, "tcp"},
{"isysg-lm",           {NULL}, 1609, "udp"},
{"taurus-wh",          {NULL}, 1610, "tcp"},
{"taurus-wh",          {NULL}, 1610, "udp"},
{"ill",                {NULL}, 1611, "tcp"},
{"ill",                {NULL}, 1611, "udp"},
{"netbill-trans",      {NULL}, 1612, "tcp"},
{"netbill-trans",      {NULL}, 1612, "udp"},
{"netbill-keyrep",     {NULL}, 1613, "tcp"},
{"netbill-keyrep",     {NULL}, 1613, "udp"},
{"netbill-cred",       {NULL}, 1614, "tcp"},
{"netbill-cred",       {NULL}, 1614, "udp"},
{"netbill-auth",       {NULL}, 1615, "tcp"},
{"netbill-auth",       {NULL}, 1615, "udp"},
{"netbill-prod",       {NULL}, 1616, "tcp"},
{"netbill-prod",       {NULL}, 1616, "udp"},
{"nimrod-agent",       {NULL}, 1617, "tcp"},
{"nimrod-agent",       {NULL}, 1617, "udp"},
{"skytelnet",          {NULL}, 1618, "tcp"},
{"skytelnet",          {NULL}, 1618, "udp"},
{"xs-openstorage",     {NULL}, 1619, "tcp"},
{"xs-openstorage",     {NULL}, 1619, "udp"},
{"faxportwinport",     {NULL}, 1620, "tcp"},
{"faxportwinport",     {NULL}, 1620, "udp"},
{"softdataphone",      {NULL}, 1621, "tcp"},
{"softdataphone",      {NULL}, 1621, "udp"},
{"ontime",             {NULL}, 1622, "tcp"},
{"ontime",             {NULL}, 1622, "udp"},
{"jaleosnd",           {NULL}, 1623, "tcp"},
{"jaleosnd",           {NULL}, 1623, "udp"},
{"udp-sr-port",        {NULL}, 1624, "tcp"},
{"udp-sr-port",        {NULL}, 1624, "udp"},
{"svs-omagent",        {NULL}, 1625, "tcp"},
{"svs-omagent",        {NULL}, 1625, "udp"},
{"shockwave",          {NULL}, 1626, "tcp"},
{"shockwave",          {NULL}, 1626, "udp"},
{"t128-gateway",       {NULL}, 1627, "tcp"},
{"t128-gateway",       {NULL}, 1627, "udp"},
{"lontalk-norm",       {NULL}, 1628, "tcp"},
{"lontalk-norm",       {NULL}, 1628, "udp"},
{"lontalk-urgnt",      {NULL}, 1629, "tcp"},
{"lontalk-urgnt",      {NULL}, 1629, "udp"},
{"oraclenet8cman",     {NULL}, 1630, "tcp"},
{"oraclenet8cman",     {NULL}, 1630, "udp"},
{"visitview",          {NULL}, 1631, "tcp"},
{"visitview",          {NULL}, 1631, "udp"},
{"pammratc",           {NULL}, 1632, "tcp"},
{"pammratc",           {NULL}, 1632, "udp"},
{"pammrpc",            {NULL}, 1633, "tcp"},
{"pammrpc",            {NULL}, 1633, "udp"},
{"loaprobe",           {NULL}, 1634, "tcp"},
{"loaprobe",           {NULL}, 1634, "udp"},
{"edb-server1",        {NULL}, 1635, "tcp"},
{"edb-server1",        {NULL}, 1635, "udp"},
{"isdc",               {NULL}, 1636, "tcp"},
{"isdc",               {NULL}, 1636, "udp"},
{"islc",               {NULL}, 1637, "tcp"},
{"islc",               {NULL}, 1637, "udp"},
{"ismc",               {NULL}, 1638, "tcp"},
{"ismc",               {NULL}, 1638, "udp"},
{"cert-initiator",     {NULL}, 1639, "tcp"},
{"cert-initiator",     {NULL}, 1639, "udp"},
{"cert-responder",     {NULL}, 1640, "tcp"},
{"cert-responder",     {NULL}, 1640, "udp"},
{"invision",           {NULL}, 1641, "tcp"},
{"invision",           {NULL}, 1641, "udp"},
{"isis-am",            {NULL}, 1642, "tcp"},
{"isis-am",            {NULL}, 1642, "udp"},
{"isis-ambc",          {NULL}, 1643, "tcp"},
{"isis-ambc",          {NULL}, 1643, "udp"},
{"saiseh",             {NULL}, 1644, "tcp"},
{"sightline",          {NULL}, 1645, "tcp"},
{"sightline",          {NULL}, 1645, "udp"},
{"sa-msg-port",        {NULL}, 1646, "tcp"},
{"sa-msg-port",        {NULL}, 1646, "udp"},
{"rsap",               {NULL}, 1647, "tcp"},
{"rsap",               {NULL}, 1647, "udp"},
{"concurrent-lm",      {NULL}, 1648, "tcp"},
{"concurrent-lm",      {NULL}, 1648, "udp"},
{"kermit",             {NULL}, 1649, "tcp"},
{"kermit",             {NULL}, 1649, "udp"},
{"nkd",                {NULL}, 1650, "tcp"},
{"nkd",                {NULL}, 1650, "udp"},
{"shiva_confsrvr",     {NULL}, 1651, "tcp"},
{"shiva_confsrvr",     {NULL}, 1651, "udp"},
{"xnmp",               {NULL}, 1652, "tcp"},
{"xnmp",               {NULL}, 1652, "udp"},
{"alphatech-lm",       {NULL}, 1653, "tcp"},
{"alphatech-lm",       {NULL}, 1653, "udp"},
{"stargatealerts",     {NULL}, 1654, "tcp"},
{"stargatealerts",     {NULL}, 1654, "udp"},
{"dec-mbadmin",        {NULL}, 1655, "tcp"},
{"dec-mbadmin",        {NULL}, 1655, "udp"},
{"dec-mbadmin-h",      {NULL}, 1656, "tcp"},
{"dec-mbadmin-h",      {NULL}, 1656, "udp"},
{"fujitsu-mmpdc",      {NULL}, 1657, "tcp"},
{"fujitsu-mmpdc",      {NULL}, 1657, "udp"},
{"sixnetudr",          {NULL}, 1658, "tcp"},
{"sixnetudr",          {NULL}, 1658, "udp"},
{"sg-lm",              {NULL}, 1659, "tcp"},
{"sg-lm",              {NULL}, 1659, "udp"},
{"skip-mc-gikreq",     {NULL}, 1660, "tcp"},
{"skip-mc-gikreq",     {NULL}, 1660, "udp"},
{"netview-aix-1",      {NULL}, 1661, "tcp"},
{"netview-aix-1",      {NULL}, 1661, "udp"},
{"netview-aix-2",      {NULL}, 1662, "tcp"},
{"netview-aix-2",      {NULL}, 1662, "udp"},
{"netview-aix-3",      {NULL}, 1663, "tcp"},
{"netview-aix-3",      {NULL}, 1663, "udp"},
{"netview-aix-4",      {NULL}, 1664, "tcp"},
{"netview-aix-4",      {NULL}, 1664, "udp"},
{"netview-aix-5",      {NULL}, 1665, "tcp"},
{"netview-aix-5",      {NULL}, 1665, "udp"},
{"netview-aix-6",      {NULL}, 1666, "tcp"},
{"netview-aix-6",      {NULL}, 1666, "udp"},
{"netview-aix-7",      {NULL}, 1667, "tcp"},
{"netview-aix-7",      {NULL}, 1667, "udp"},
{"netview-aix-8",      {NULL}, 1668, "tcp"},
{"netview-aix-8",      {NULL}, 1668, "udp"},
{"netview-aix-9",      {NULL}, 1669, "tcp"},
{"netview-aix-9",      {NULL}, 1669, "udp"},
{"netview-aix-10",     {NULL}, 1670, "tcp"},
{"netview-aix-10",     {NULL}, 1670, "udp"},
{"netview-aix-11",     {NULL}, 1671, "tcp"},
{"netview-aix-11",     {NULL}, 1671, "udp"},
{"netview-aix-12",     {NULL}, 1672, "tcp"},
{"netview-aix-12",     {NULL}, 1672, "udp"},
{"proshare-mc-1",      {NULL}, 1673, "tcp"},
{"proshare-mc-1",      {NULL}, 1673, "udp"},
{"proshare-mc-2",      {NULL}, 1674, "tcp"},
{"proshare-mc-2",      {NULL}, 1674, "udp"},
{"pdp",                {NULL}, 1675, "tcp"},
{"pdp",                {NULL}, 1675, "udp"},
{"netcomm1",           {NULL}, 1676, "tcp"},
{"netcomm2",           {NULL}, 1676, "udp"},
{"groupwise",          {NULL}, 1677, "tcp"},
{"groupwise",          {NULL}, 1677, "udp"},
{"prolink",            {NULL}, 1678, "tcp"},
{"prolink",            {NULL}, 1678, "udp"},
{"darcorp-lm",         {NULL}, 1679, "tcp"},
{"darcorp-lm",         {NULL}, 1679, "udp"},
{"microcom-sbp",       {NULL}, 1680, "tcp"},
{"microcom-sbp",       {NULL}, 1680, "udp"},
{"sd-elmd",            {NULL}, 1681, "tcp"},
{"sd-elmd",            {NULL}, 1681, "udp"},
{"lanyon-lantern",     {NULL}, 1682, "tcp"},
{"lanyon-lantern",     {NULL}, 1682, "udp"},
{"ncpm-hip",           {NULL}, 1683, "tcp"},
{"ncpm-hip",           {NULL}, 1683, "udp"},
{"snaresecure",        {NULL}, 1684, "tcp"},
{"snaresecure",        {NULL}, 1684, "udp"},
{"n2nremote",          {NULL}, 1685, "tcp"},
{"n2nremote",          {NULL}, 1685, "udp"},
{"cvmon",              {NULL}, 1686, "tcp"},
{"cvmon",              {NULL}, 1686, "udp"},
{"nsjtp-ctrl",         {NULL}, 1687, "tcp"},
{"nsjtp-ctrl",         {NULL}, 1687, "udp"},
{"nsjtp-data",         {NULL}, 1688, "tcp"},
{"nsjtp-data",         {NULL}, 1688, "udp"},
{"firefox",            {NULL}, 1689, "tcp"},
{"firefox",            {NULL}, 1689, "udp"},
{"ng-umds",            {NULL}, 1690, "tcp"},
{"ng-umds",            {NULL}, 1690, "udp"},
{"empire-empuma",      {NULL}, 1691, "tcp"},
{"empire-empuma",      {NULL}, 1691, "udp"},
{"sstsys-lm",          {NULL}, 1692, "tcp"},
{"sstsys-lm",          {NULL}, 1692, "udp"},
{"rrirtr",             {NULL}, 1693, "tcp"},
{"rrirtr",             {NULL}, 1693, "udp"},
{"rrimwm",             {NULL}, 1694, "tcp"},
{"rrimwm",             {NULL}, 1694, "udp"},
{"rrilwm",             {NULL}, 1695, "tcp"},
{"rrilwm",             {NULL}, 1695, "udp"},
{"rrifmm",             {NULL}, 1696, "tcp"},
{"rrifmm",             {NULL}, 1696, "udp"},
{"rrisat",             {NULL}, 1697, "tcp"},
{"rrisat",             {NULL}, 1697, "udp"},
{"rsvp-encap-1",       {NULL}, 1698, "tcp"},
{"rsvp-encap-1",       {NULL}, 1698, "udp"},
{"rsvp-encap-2",       {NULL}, 1699, "tcp"},
{"rsvp-encap-2",       {NULL}, 1699, "udp"},
{"mps-raft",           {NULL}, 1700, "tcp"},
{"mps-raft",           {NULL}, 1700, "udp"},
{"l2f",                {NULL}, 1701, "tcp"},
{"l2f",                {NULL}, 1701, "udp"},
{"l2tp",               {NULL}, 1701, "tcp"},
{"l2tp",               {NULL}, 1701, "udp"},
{"deskshare",          {NULL}, 1702, "tcp"},
{"deskshare",          {NULL}, 1702, "udp"},
{"hb-engine",          {NULL}, 1703, "tcp"},
{"hb-engine",          {NULL}, 1703, "udp"},
{"bcs-broker",         {NULL}, 1704, "tcp"},
{"bcs-broker",         {NULL}, 1704, "udp"},
{"slingshot",          {NULL}, 1705, "tcp"},
{"slingshot",          {NULL}, 1705, "udp"},
{"jetform",            {NULL}, 1706, "tcp"},
{"jetform",            {NULL}, 1706, "udp"},
{"vdmplay",            {NULL}, 1707, "tcp"},
{"vdmplay",            {NULL}, 1707, "udp"},
{"gat-lmd",            {NULL}, 1708, "tcp"},
{"gat-lmd",            {NULL}, 1708, "udp"},
{"centra",             {NULL}, 1709, "tcp"},
{"centra",             {NULL}, 1709, "udp"},
{"impera",             {NULL}, 1710, "tcp"},
{"impera",             {NULL}, 1710, "udp"},
{"pptconference",      {NULL}, 1711, "tcp"},
{"pptconference",      {NULL}, 1711, "udp"},
{"registrar",          {NULL}, 1712, "tcp"},
{"registrar",          {NULL}, 1712, "udp"},
{"conferencetalk",     {NULL}, 1713, "tcp"},
{"conferencetalk",     {NULL}, 1713, "udp"},
{"sesi-lm",            {NULL}, 1714, "tcp"},
{"sesi-lm",            {NULL}, 1714, "udp"},
{"houdini-lm",         {NULL}, 1715, "tcp"},
{"houdini-lm",         {NULL}, 1715, "udp"},
{"xmsg",               {NULL}, 1716, "tcp"},
{"xmsg",               {NULL}, 1716, "udp"},
{"fj-hdnet",           {NULL}, 1717, "tcp"},
{"fj-hdnet",           {NULL}, 1717, "udp"},
{"h323gatedisc",       {NULL}, 1718, "tcp"},
{"h323gatedisc",       {NULL}, 1718, "udp"},
{"h323gatestat",       {NULL}, 1719, "tcp"},
{"h323gatestat",       {NULL}, 1719, "udp"},
{"h323hostcall",       {NULL}, 1720, "tcp"},
{"h323hostcall",       {NULL}, 1720, "udp"},
{"caicci",             {NULL}, 1721, "tcp"},
{"caicci",             {NULL}, 1721, "udp"},
{"hks-lm",             {NULL}, 1722, "tcp"},
{"hks-lm",             {NULL}, 1722, "udp"},
{"pptp",               {NULL}, 1723, "tcp"},
{"pptp",               {NULL}, 1723, "udp"},
{"csbphonemaster",     {NULL}, 1724, "tcp"},
{"csbphonemaster",     {NULL}, 1724, "udp"},
{"iden-ralp",          {NULL}, 1725, "tcp"},
{"iden-ralp",          {NULL}, 1725, "udp"},
{"iberiagames",        {NULL}, 1726, "tcp"},
{"iberiagames",        {NULL}, 1726, "udp"},
{"winddx",             {NULL}, 1727, "tcp"},
{"winddx",             {NULL}, 1727, "udp"},
{"telindus",           {NULL}, 1728, "tcp"},
{"telindus",           {NULL}, 1728, "udp"},
{"citynl",             {NULL}, 1729, "tcp"},
{"citynl",             {NULL}, 1729, "udp"},
{"roketz",             {NULL}, 1730, "tcp"},
{"roketz",             {NULL}, 1730, "udp"},
{"msiccp",             {NULL}, 1731, "tcp"},
{"msiccp",             {NULL}, 1731, "udp"},
{"proxim",             {NULL}, 1732, "tcp"},
{"proxim",             {NULL}, 1732, "udp"},
{"siipat",             {NULL}, 1733, "tcp"},
{"siipat",             {NULL}, 1733, "udp"},
{"cambertx-lm",        {NULL}, 1734, "tcp"},
{"cambertx-lm",        {NULL}, 1734, "udp"},
{"privatechat",        {NULL}, 1735, "tcp"},
{"privatechat",        {NULL}, 1735, "udp"},
{"street-stream",      {NULL}, 1736, "tcp"},
{"street-stream",      {NULL}, 1736, "udp"},
{"ultimad",            {NULL}, 1737, "tcp"},
{"ultimad",            {NULL}, 1737, "udp"},
{"gamegen1",           {NULL}, 1738, "tcp"},
{"gamegen1",           {NULL}, 1738, "udp"},
{"webaccess",          {NULL}, 1739, "tcp"},
{"webaccess",          {NULL}, 1739, "udp"},
{"encore",             {NULL}, 1740, "tcp"},
{"encore",             {NULL}, 1740, "udp"},
{"cisco-net-mgmt",     {NULL}, 1741, "tcp"},
{"cisco-net-mgmt",     {NULL}, 1741, "udp"},
{"3Com-nsd",           {NULL}, 1742, "tcp"},
{"3Com-nsd",           {NULL}, 1742, "udp"},
{"cinegrfx-lm",        {NULL}, 1743, "tcp"},
{"cinegrfx-lm",        {NULL}, 1743, "udp"},
{"ncpm-ft",            {NULL}, 1744, "tcp"},
{"ncpm-ft",            {NULL}, 1744, "udp"},
{"remote-winsock",     {NULL}, 1745, "tcp"},
{"remote-winsock",     {NULL}, 1745, "udp"},
{"ftrapid-1",          {NULL}, 1746, "tcp"},
{"ftrapid-1",          {NULL}, 1746, "udp"},
{"ftrapid-2",          {NULL}, 1747, "tcp"},
{"ftrapid-2",          {NULL}, 1747, "udp"},
{"oracle-em1",         {NULL}, 1748, "tcp"},
{"oracle-em1",         {NULL}, 1748, "udp"},
{"aspen-services",     {NULL}, 1749, "tcp"},
{"aspen-services",     {NULL}, 1749, "udp"},
{"sslp",               {NULL}, 1750, "tcp"},
{"sslp",               {NULL}, 1750, "udp"},
{"swiftnet",           {NULL}, 1751, "tcp"},
{"swiftnet",           {NULL}, 1751, "udp"},
{"lofr-lm",            {NULL}, 1752, "tcp"},
{"lofr-lm",            {NULL}, 1752, "udp"},
{"oracle-em2",         {NULL}, 1754, "tcp"},
{"oracle-em2",         {NULL}, 1754, "udp"},
{"ms-streaming",       {NULL}, 1755, "tcp"},
{"ms-streaming",       {NULL}, 1755, "udp"},
{"capfast-lmd",        {NULL}, 1756, "tcp"},
{"capfast-lmd",        {NULL}, 1756, "udp"},
{"cnhrp",              {NULL}, 1757, "tcp"},
{"cnhrp",              {NULL}, 1757, "udp"},
{"tftp-mcast",         {NULL}, 1758, "tcp"},
{"tftp-mcast",         {NULL}, 1758, "udp"},
{"spss-lm",            {NULL}, 1759, "tcp"},
{"spss-lm",            {NULL}, 1759, "udp"},
{"www-ldap-gw",        {NULL}, 1760, "tcp"},
{"www-ldap-gw",        {NULL}, 1760, "udp"},
{"cft-0",              {NULL}, 1761, "tcp"},
{"cft-0",              {NULL}, 1761, "udp"},
{"cft-1",              {NULL}, 1762, "tcp"},
{"cft-1",              {NULL}, 1762, "udp"},
{"cft-2",              {NULL}, 1763, "tcp"},
{"cft-2",              {NULL}, 1763, "udp"},
{"cft-3",              {NULL}, 1764, "tcp"},
{"cft-3",              {NULL}, 1764, "udp"},
{"cft-4",              {NULL}, 1765, "tcp"},
{"cft-4",              {NULL}, 1765, "udp"},
{"cft-5",              {NULL}, 1766, "tcp"},
{"cft-5",              {NULL}, 1766, "udp"},
{"cft-6",              {NULL}, 1767, "tcp"},
{"cft-6",              {NULL}, 1767, "udp"},
{"cft-7",              {NULL}, 1768, "tcp"},
{"cft-7",              {NULL}, 1768, "udp"},
{"bmc-net-adm",        {NULL}, 1769, "tcp"},
{"bmc-net-adm",        {NULL}, 1769, "udp"},
{"bmc-net-svc",        {NULL}, 1770, "tcp"},
{"bmc-net-svc",        {NULL}, 1770, "udp"},
{"vaultbase",          {NULL}, 1771, "tcp"},
{"vaultbase",          {NULL}, 1771, "udp"},
{"essweb-gw",          {NULL}, 1772, "tcp"},
{"essweb-gw",          {NULL}, 1772, "udp"},
{"kmscontrol",         {NULL}, 1773, "tcp"},
{"kmscontrol",         {NULL}, 1773, "udp"},
{"global-dtserv",      {NULL}, 1774, "tcp"},
{"global-dtserv",      {NULL}, 1774, "udp"},
{"femis",              {NULL}, 1776, "tcp"},
{"femis",              {NULL}, 1776, "udp"},
{"powerguardian",      {NULL}, 1777, "tcp"},
{"powerguardian",      {NULL}, 1777, "udp"},
{"prodigy-intrnet",    {NULL}, 1778, "tcp"},
{"prodigy-intrnet",    {NULL}, 1778, "udp"},
{"pharmasoft",         {NULL}, 1779, "tcp"},
{"pharmasoft",         {NULL}, 1779, "udp"},
{"dpkeyserv",          {NULL}, 1780, "tcp"},
{"dpkeyserv",          {NULL}, 1780, "udp"},
{"answersoft-lm",      {NULL}, 1781, "tcp"},
{"answersoft-lm",      {NULL}, 1781, "udp"},
{"hp-hcip",            {NULL}, 1782, "tcp"},
{"hp-hcip",            {NULL}, 1782, "udp"},
{"finle-lm",           {NULL}, 1784, "tcp"},
{"finle-lm",           {NULL}, 1784, "udp"},
{"windlm",             {NULL}, 1785, "tcp"},
{"windlm",             {NULL}, 1785, "udp"},
{"funk-logger",        {NULL}, 1786, "tcp"},
{"funk-logger",        {NULL}, 1786, "udp"},
{"funk-license",       {NULL}, 1787, "tcp"},
{"funk-license",       {NULL}, 1787, "udp"},
{"psmond",             {NULL}, 1788, "tcp"},
{"psmond",             {NULL}, 1788, "udp"},
{"hello",              {NULL}, 1789, "tcp"},
{"hello",              {NULL}, 1789, "udp"},
{"nmsp",               {NULL}, 1790, "tcp"},
{"nmsp",               {NULL}, 1790, "udp"},
{"ea1",                {NULL}, 1791, "tcp"},
{"ea1",                {NULL}, 1791, "udp"},
{"ibm-dt-2",           {NULL}, 1792, "tcp"},
{"ibm-dt-2",           {NULL}, 1792, "udp"},
{"rsc-robot",          {NULL}, 1793, "tcp"},
{"rsc-robot",          {NULL}, 1793, "udp"},
{"cera-bcm",           {NULL}, 1794, "tcp"},
{"cera-bcm",           {NULL}, 1794, "udp"},
{"dpi-proxy",          {NULL}, 1795, "tcp"},
{"dpi-proxy",          {NULL}, 1795, "udp"},
{"vocaltec-admin",     {NULL}, 1796, "tcp"},
{"vocaltec-admin",     {NULL}, 1796, "udp"},
{"uma",                {NULL}, 1797, "tcp"},
{"uma",                {NULL}, 1797, "udp"},
{"etp",                {NULL}, 1798, "tcp"},
{"etp",                {NULL}, 1798, "udp"},
{"netrisk",            {NULL}, 1799, "tcp"},
{"netrisk",            {NULL}, 1799, "udp"},
{"ansys-lm",           {NULL}, 1800, "tcp"},
{"ansys-lm",           {NULL}, 1800, "udp"},
{"msmq",               {NULL}, 1801, "tcp"},
{"msmq",               {NULL}, 1801, "udp"},
{"concomp1",           {NULL}, 1802, "tcp"},
{"concomp1",           {NULL}, 1802, "udp"},
{"hp-hcip-gwy",        {NULL}, 1803, "tcp"},
{"hp-hcip-gwy",        {NULL}, 1803, "udp"},
{"enl",                {NULL}, 1804, "tcp"},
{"enl",                {NULL}, 1804, "udp"},
{"enl-name",           {NULL}, 1805, "tcp"},
{"enl-name",           {NULL}, 1805, "udp"},
{"musiconline",        {NULL}, 1806, "tcp"},
{"musiconline",        {NULL}, 1806, "udp"},
{"fhsp",               {NULL}, 1807, "tcp"},
{"fhsp",               {NULL}, 1807, "udp"},
{"oracle-vp2",         {NULL}, 1808, "tcp"},
{"oracle-vp2",         {NULL}, 1808, "udp"},
{"oracle-vp1",         {NULL}, 1809, "tcp"},
{"oracle-vp1",         {NULL}, 1809, "udp"},
{"jerand-lm",          {NULL}, 1810, "tcp"},
{"jerand-lm",          {NULL}, 1810, "udp"},
{"scientia-sdb",       {NULL}, 1811, "tcp"},
{"scientia-sdb",       {NULL}, 1811, "udp"},
{"radius",             {NULL}, 1812, "tcp"},
{"radius",             {NULL}, 1812, "udp"},
{"radius-acct",        {NULL}, 1813, "tcp"},
{"radius-acct",        {NULL}, 1813, "udp"},
{"tdp-suite",          {NULL}, 1814, "tcp"},
{"tdp-suite",          {NULL}, 1814, "udp"},
{"mmpft",              {NULL}, 1815, "tcp"},
{"mmpft",              {NULL}, 1815, "udp"},
{"harp",               {NULL}, 1816, "tcp"},
{"harp",               {NULL}, 1816, "udp"},
{"rkb-oscs",           {NULL}, 1817, "tcp"},
{"rkb-oscs",           {NULL}, 1817, "udp"},
{"etftp",              {NULL}, 1818, "tcp"},
{"etftp",              {NULL}, 1818, "udp"},
{"plato-lm",           {NULL}, 1819, "tcp"},
{"plato-lm",           {NULL}, 1819, "udp"},
{"mcagent",            {NULL}, 1820, "tcp"},
{"mcagent",            {NULL}, 1820, "udp"},
{"donnyworld",         {NULL}, 1821, "tcp"},
{"donnyworld",         {NULL}, 1821, "udp"},
{"es-elmd",            {NULL}, 1822, "tcp"},
{"es-elmd",            {NULL}, 1822, "udp"},
{"unisys-lm",          {NULL}, 1823, "tcp"},
{"unisys-lm",          {NULL}, 1823, "udp"},
{"metrics-pas",        {NULL}, 1824, "tcp"},
{"metrics-pas",        {NULL}, 1824, "udp"},
{"direcpc-video",      {NULL}, 1825, "tcp"},
{"direcpc-video",      {NULL}, 1825, "udp"},
{"ardt",               {NULL}, 1826, "tcp"},
{"ardt",               {NULL}, 1826, "udp"},
{"asi",                {NULL}, 1827, "tcp"},
{"asi",                {NULL}, 1827, "udp"},
{"itm-mcell-u",        {NULL}, 1828, "tcp"},
{"itm-mcell-u",        {NULL}, 1828, "udp"},
{"optika-emedia",      {NULL}, 1829, "tcp"},
{"optika-emedia",      {NULL}, 1829, "udp"},
{"net8-cman",          {NULL}, 1830, "tcp"},
{"net8-cman",          {NULL}, 1830, "udp"},
{"myrtle",             {NULL}, 1831, "tcp"},
{"myrtle",             {NULL}, 1831, "udp"},
{"tht-treasure",       {NULL}, 1832, "tcp"},
{"tht-treasure",       {NULL}, 1832, "udp"},
{"udpradio",           {NULL}, 1833, "tcp"},
{"udpradio",           {NULL}, 1833, "udp"},
{"ardusuni",           {NULL}, 1834, "tcp"},
{"ardusuni",           {NULL}, 1834, "udp"},
{"ardusmul",           {NULL}, 1835, "tcp"},
{"ardusmul",           {NULL}, 1835, "udp"},
{"ste-smsc",           {NULL}, 1836, "tcp"},
{"ste-smsc",           {NULL}, 1836, "udp"},
{"csoft1",             {NULL}, 1837, "tcp"},
{"csoft1",             {NULL}, 1837, "udp"},
{"talnet",             {NULL}, 1838, "tcp"},
{"talnet",             {NULL}, 1838, "udp"},
{"netopia-vo1",        {NULL}, 1839, "tcp"},
{"netopia-vo1",        {NULL}, 1839, "udp"},
{"netopia-vo2",        {NULL}, 1840, "tcp"},
{"netopia-vo2",        {NULL}, 1840, "udp"},
{"netopia-vo3",        {NULL}, 1841, "tcp"},
{"netopia-vo3",        {NULL}, 1841, "udp"},
{"netopia-vo4",        {NULL}, 1842, "tcp"},
{"netopia-vo4",        {NULL}, 1842, "udp"},
{"netopia-vo5",        {NULL}, 1843, "tcp"},
{"netopia-vo5",        {NULL}, 1843, "udp"},
{"direcpc-dll",        {NULL}, 1844, "tcp"},
{"direcpc-dll",        {NULL}, 1844, "udp"},
{"altalink",           {NULL}, 1845, "tcp"},
{"altalink",           {NULL}, 1845, "udp"},
{"tunstall-pnc",       {NULL}, 1846, "tcp"},
{"tunstall-pnc",       {NULL}, 1846, "udp"},
{"slp-notify",         {NULL}, 1847, "tcp"},
{"slp-notify",         {NULL}, 1847, "udp"},
{"fjdocdist",          {NULL}, 1848, "tcp"},
{"fjdocdist",          {NULL}, 1848, "udp"},
{"alpha-sms",          {NULL}, 1849, "tcp"},
{"alpha-sms",          {NULL}, 1849, "udp"},
{"gsi",                {NULL}, 1850, "tcp"},
{"gsi",                {NULL}, 1850, "udp"},
{"ctcd",               {NULL}, 1851, "tcp"},
{"ctcd",               {NULL}, 1851, "udp"},
{"virtual-time",       {NULL}, 1852, "tcp"},
{"virtual-time",       {NULL}, 1852, "udp"},
{"vids-avtp",          {NULL}, 1853, "tcp"},
{"vids-avtp",          {NULL}, 1853, "udp"},
{"buddy-draw",         {NULL}, 1854, "tcp"},
{"buddy-draw",         {NULL}, 1854, "udp"},
{"fiorano-rtrsvc",     {NULL}, 1855, "tcp"},
{"fiorano-rtrsvc",     {NULL}, 1855, "udp"},
{"fiorano-msgsvc",     {NULL}, 1856, "tcp"},
{"fiorano-msgsvc",     {NULL}, 1856, "udp"},
{"datacaptor",         {NULL}, 1857, "tcp"},
{"datacaptor",         {NULL}, 1857, "udp"},
{"privateark",         {NULL}, 1858, "tcp"},
{"privateark",         {NULL}, 1858, "udp"},
{"gammafetchsvr",      {NULL}, 1859, "tcp"},
{"gammafetchsvr",      {NULL}, 1859, "udp"},
{"sunscalar-svc",      {NULL}, 1860, "tcp"},
{"sunscalar-svc",      {NULL}, 1860, "udp"},
{"lecroy-vicp",        {NULL}, 1861, "tcp"},
{"lecroy-vicp",        {NULL}, 1861, "udp"},
{"mysql-cm-agent",     {NULL}, 1862, "tcp"},
{"mysql-cm-agent",     {NULL}, 1862, "udp"},
{"msnp",               {NULL}, 1863, "tcp"},
{"msnp",               {NULL}, 1863, "udp"},
{"paradym-31port",     {NULL}, 1864, "tcp"},
{"paradym-31port",     {NULL}, 1864, "udp"},
{"entp",               {NULL}, 1865, "tcp"},
{"entp",               {NULL}, 1865, "udp"},
{"swrmi",              {NULL}, 1866, "tcp"},
{"swrmi",              {NULL}, 1866, "udp"},
{"udrive",             {NULL}, 1867, "tcp"},
{"udrive",             {NULL}, 1867, "udp"},
{"viziblebrowser",     {NULL}, 1868, "tcp"},
{"viziblebrowser",     {NULL}, 1868, "udp"},
{"transact",           {NULL}, 1869, "tcp"},
{"transact",           {NULL}, 1869, "udp"},
{"sunscalar-dns",      {NULL}, 1870, "tcp"},
{"sunscalar-dns",      {NULL}, 1870, "udp"},
{"canocentral0",       {NULL}, 1871, "tcp"},
{"canocentral0",       {NULL}, 1871, "udp"},
{"canocentral1",       {NULL}, 1872, "tcp"},
{"canocentral1",       {NULL}, 1872, "udp"},
{"fjmpjps",            {NULL}, 1873, "tcp"},
{"fjmpjps",            {NULL}, 1873, "udp"},
{"fjswapsnp",          {NULL}, 1874, "tcp"},
{"fjswapsnp",          {NULL}, 1874, "udp"},
{"westell-stats",      {NULL}, 1875, "tcp"},
{"westell-stats",      {NULL}, 1875, "udp"},
{"ewcappsrv",          {NULL}, 1876, "tcp"},
{"ewcappsrv",          {NULL}, 1876, "udp"},
{"hp-webqosdb",        {NULL}, 1877, "tcp"},
{"hp-webqosdb",        {NULL}, 1877, "udp"},
{"drmsmc",             {NULL}, 1878, "tcp"},
{"drmsmc",             {NULL}, 1878, "udp"},
{"nettgain-nms",       {NULL}, 1879, "tcp"},
{"nettgain-nms",       {NULL}, 1879, "udp"},
{"vsat-control",       {NULL}, 1880, "tcp"},
{"vsat-control",       {NULL}, 1880, "udp"},
{"ibm-mqseries2",      {NULL}, 1881, "tcp"},
{"ibm-mqseries2",      {NULL}, 1881, "udp"},
{"ecsqdmn",            {NULL}, 1882, "tcp"},
{"ecsqdmn",            {NULL}, 1882, "udp"},
{"ibm-mqisdp",         {NULL}, 1883, "tcp"},
{"ibm-mqisdp",         {NULL}, 1883, "udp"},
{"idmaps",             {NULL}, 1884, "tcp"},
{"idmaps",             {NULL}, 1884, "udp"},
{"vrtstrapserver",     {NULL}, 1885, "tcp"},
{"vrtstrapserver",     {NULL}, 1885, "udp"},
{"leoip",              {NULL}, 1886, "tcp"},
{"leoip",              {NULL}, 1886, "udp"},
{"filex-lport",        {NULL}, 1887, "tcp"},
{"filex-lport",        {NULL}, 1887, "udp"},
{"ncconfig",           {NULL}, 1888, "tcp"},
{"ncconfig",           {NULL}, 1888, "udp"},
{"unify-adapter",      {NULL}, 1889, "tcp"},
{"unify-adapter",      {NULL}, 1889, "udp"},
{"wilkenlistener",     {NULL}, 1890, "tcp"},
{"wilkenlistener",     {NULL}, 1890, "udp"},
{"childkey-notif",     {NULL}, 1891, "tcp"},
{"childkey-notif",     {NULL}, 1891, "udp"},
{"childkey-ctrl",      {NULL}, 1892, "tcp"},
{"childkey-ctrl",      {NULL}, 1892, "udp"},
{"elad",               {NULL}, 1893, "tcp"},
{"elad",               {NULL}, 1893, "udp"},
{"o2server-port",      {NULL}, 1894, "tcp"},
{"o2server-port",      {NULL}, 1894, "udp"},
{"b-novative-ls",      {NULL}, 1896, "tcp"},
{"b-novative-ls",      {NULL}, 1896, "udp"},
{"metaagent",          {NULL}, 1897, "tcp"},
{"metaagent",          {NULL}, 1897, "udp"},
{"cymtec-port",        {NULL}, 1898, "tcp"},
{"cymtec-port",        {NULL}, 1898, "udp"},
{"mc2studios",         {NULL}, 1899, "tcp"},
{"mc2studios",         {NULL}, 1899, "udp"},
{"ssdp",               {NULL}, 1900, "tcp"},
{"ssdp",               {NULL}, 1900, "udp"},
{"fjicl-tep-a",        {NULL}, 1901, "tcp"},
{"fjicl-tep-a",        {NULL}, 1901, "udp"},
{"fjicl-tep-b",        {NULL}, 1902, "tcp"},
{"fjicl-tep-b",        {NULL}, 1902, "udp"},
{"linkname",           {NULL}, 1903, "tcp"},
{"linkname",           {NULL}, 1903, "udp"},
{"fjicl-tep-c",        {NULL}, 1904, "tcp"},
{"fjicl-tep-c",        {NULL}, 1904, "udp"},
{"sugp",               {NULL}, 1905, "tcp"},
{"sugp",               {NULL}, 1905, "udp"},
{"tpmd",               {NULL}, 1906, "tcp"},
{"tpmd",               {NULL}, 1906, "udp"},
{"intrastar",          {NULL}, 1907, "tcp"},
{"intrastar",          {NULL}, 1907, "udp"},
{"dawn",               {NULL}, 1908, "tcp"},
{"dawn",               {NULL}, 1908, "udp"},
{"global-wlink",       {NULL}, 1909, "tcp"},
{"global-wlink",       {NULL}, 1909, "udp"},
{"ultrabac",           {NULL}, 1910, "tcp"},
{"ultrabac",           {NULL}, 1910, "udp"},
{"mtp",                {NULL}, 1911, "tcp"},
{"mtp",                {NULL}, 1911, "udp"},
{"rhp-iibp",           {NULL}, 1912, "tcp"},
{"rhp-iibp",           {NULL}, 1912, "udp"},
{"armadp",             {NULL}, 1913, "tcp"},
{"armadp",             {NULL}, 1913, "udp"},
{"elm-momentum",       {NULL}, 1914, "tcp"},
{"elm-momentum",       {NULL}, 1914, "udp"},
{"facelink",           {NULL}, 1915, "tcp"},
{"facelink",           {NULL}, 1915, "udp"},
{"persona",            {NULL}, 1916, "tcp"},
{"persona",            {NULL}, 1916, "udp"},
{"noagent",            {NULL}, 1917, "tcp"},
{"noagent",            {NULL}, 1917, "udp"},
{"can-nds",            {NULL}, 1918, "tcp"},
{"can-nds",            {NULL}, 1918, "udp"},
{"can-dch",            {NULL}, 1919, "tcp"},
{"can-dch",            {NULL}, 1919, "udp"},
{"can-ferret",         {NULL}, 1920, "tcp"},
{"can-ferret",         {NULL}, 1920, "udp"},
{"noadmin",            {NULL}, 1921, "tcp"},
{"noadmin",            {NULL}, 1921, "udp"},
{"tapestry",           {NULL}, 1922, "tcp"},
{"tapestry",           {NULL}, 1922, "udp"},
{"spice",              {NULL}, 1923, "tcp"},
{"spice",              {NULL}, 1923, "udp"},
{"xiip",               {NULL}, 1924, "tcp"},
{"xiip",               {NULL}, 1924, "udp"},
{"discovery-port",     {NULL}, 1925, "tcp"},
{"discovery-port",     {NULL}, 1925, "udp"},
{"egs",                {NULL}, 1926, "tcp"},
{"egs",                {NULL}, 1926, "udp"},
{"videte-cipc",        {NULL}, 1927, "tcp"},
{"videte-cipc",        {NULL}, 1927, "udp"},
{"emsd-port",          {NULL}, 1928, "tcp"},
{"emsd-port",          {NULL}, 1928, "udp"},
{"bandwiz-system",     {NULL}, 1929, "tcp"},
{"bandwiz-system",     {NULL}, 1929, "udp"},
{"driveappserver",     {NULL}, 1930, "tcp"},
{"driveappserver",     {NULL}, 1930, "udp"},
{"amdsched",           {NULL}, 1931, "tcp"},
{"amdsched",           {NULL}, 1931, "udp"},
{"ctt-broker",         {NULL}, 1932, "tcp"},
{"ctt-broker",         {NULL}, 1932, "udp"},
{"xmapi",              {NULL}, 1933, "tcp"},
{"xmapi",              {NULL}, 1933, "udp"},
{"xaapi",              {NULL}, 1934, "tcp"},
{"xaapi",              {NULL}, 1934, "udp"},
{"macromedia-fcs",     {NULL}, 1935, "tcp"},
{"macromedia-fcs",     {NULL}, 1935, "udp"},
{"jetcmeserver",       {NULL}, 1936, "tcp"},
{"jetcmeserver",       {NULL}, 1936, "udp"},
{"jwserver",           {NULL}, 1937, "tcp"},
{"jwserver",           {NULL}, 1937, "udp"},
{"jwclient",           {NULL}, 1938, "tcp"},
{"jwclient",           {NULL}, 1938, "udp"},
{"jvserver",           {NULL}, 1939, "tcp"},
{"jvserver",           {NULL}, 1939, "udp"},
{"jvclient",           {NULL}, 1940, "tcp"},
{"jvclient",           {NULL}, 1940, "udp"},
{"dic-aida",           {NULL}, 1941, "tcp"},
{"dic-aida",           {NULL}, 1941, "udp"},
{"res",                {NULL}, 1942, "tcp"},
{"res",                {NULL}, 1942, "udp"},
{"beeyond-media",      {NULL}, 1943, "tcp"},
{"beeyond-media",      {NULL}, 1943, "udp"},
{"close-combat",       {NULL}, 1944, "tcp"},
{"close-combat",       {NULL}, 1944, "udp"},
{"dialogic-elmd",      {NULL}, 1945, "tcp"},
{"dialogic-elmd",      {NULL}, 1945, "udp"},
{"tekpls",             {NULL}, 1946, "tcp"},
{"tekpls",             {NULL}, 1946, "udp"},
{"sentinelsrm",        {NULL}, 1947, "tcp"},
{"sentinelsrm",        {NULL}, 1947, "udp"},
{"eye2eye",            {NULL}, 1948, "tcp"},
{"eye2eye",            {NULL}, 1948, "udp"},
{"ismaeasdaqlive",     {NULL}, 1949, "tcp"},
{"ismaeasdaqlive",     {NULL}, 1949, "udp"},
{"ismaeasdaqtest",     {NULL}, 1950, "tcp"},
{"ismaeasdaqtest",     {NULL}, 1950, "udp"},
{"bcs-lmserver",       {NULL}, 1951, "tcp"},
{"bcs-lmserver",       {NULL}, 1951, "udp"},
{"mpnjsc",             {NULL}, 1952, "tcp"},
{"mpnjsc",             {NULL}, 1952, "udp"},
{"rapidbase",          {NULL}, 1953, "tcp"},
{"rapidbase",          {NULL}, 1953, "udp"},
{"abr-api",            {NULL}, 1954, "tcp"},
{"abr-api",            {NULL}, 1954, "udp"},
{"abr-secure",         {NULL}, 1955, "tcp"},
{"abr-secure",         {NULL}, 1955, "udp"},
{"vrtl-vmf-ds",        {NULL}, 1956, "tcp"},
{"vrtl-vmf-ds",        {NULL}, 1956, "udp"},
{"unix-status",        {NULL}, 1957, "tcp"},
{"unix-status",        {NULL}, 1957, "udp"},
{"dxadmind",           {NULL}, 1958, "tcp"},
{"dxadmind",           {NULL}, 1958, "udp"},
{"simp-all",           {NULL}, 1959, "tcp"},
{"simp-all",           {NULL}, 1959, "udp"},
{"nasmanager",         {NULL}, 1960, "tcp"},
{"nasmanager",         {NULL}, 1960, "udp"},
{"bts-appserver",      {NULL}, 1961, "tcp"},
{"bts-appserver",      {NULL}, 1961, "udp"},
{"biap-mp",            {NULL}, 1962, "tcp"},
{"biap-mp",            {NULL}, 1962, "udp"},
{"webmachine",         {NULL}, 1963, "tcp"},
{"webmachine",         {NULL}, 1963, "udp"},
{"solid-e-engine",     {NULL}, 1964, "tcp"},
{"solid-e-engine",     {NULL}, 1964, "udp"},
{"tivoli-npm",         {NULL}, 1965, "tcp"},
{"tivoli-npm",         {NULL}, 1965, "udp"},
{"slush",              {NULL}, 1966, "tcp"},
{"slush",              {NULL}, 1966, "udp"},
{"sns-quote",          {NULL}, 1967, "tcp"},
{"sns-quote",          {NULL}, 1967, "udp"},
{"lipsinc",            {NULL}, 1968, "tcp"},
{"lipsinc",            {NULL}, 1968, "udp"},
{"lipsinc1",           {NULL}, 1969, "tcp"},
{"lipsinc1",           {NULL}, 1969, "udp"},
{"netop-rc",           {NULL}, 1970, "tcp"},
{"netop-rc",           {NULL}, 1970, "udp"},
{"netop-school",       {NULL}, 1971, "tcp"},
{"netop-school",       {NULL}, 1971, "udp"},
{"intersys-cache",     {NULL}, 1972, "tcp"},
{"intersys-cache",     {NULL}, 1972, "udp"},
{"dlsrap",             {NULL}, 1973, "tcp"},
{"dlsrap",             {NULL}, 1973, "udp"},
{"drp",                {NULL}, 1974, "tcp"},
{"drp",                {NULL}, 1974, "udp"},
{"tcoflashagent",      {NULL}, 1975, "tcp"},
{"tcoflashagent",      {NULL}, 1975, "udp"},
{"tcoregagent",        {NULL}, 1976, "tcp"},
{"tcoregagent",        {NULL}, 1976, "udp"},
{"tcoaddressbook",     {NULL}, 1977, "tcp"},
{"tcoaddressbook",     {NULL}, 1977, "udp"},
{"unisql",             {NULL}, 1978, "tcp"},
{"unisql",             {NULL}, 1978, "udp"},
{"unisql-java",        {NULL}, 1979, "tcp"},
{"unisql-java",        {NULL}, 1979, "udp"},
{"pearldoc-xact",      {NULL}, 1980, "tcp"},
{"pearldoc-xact",      {NULL}, 1980, "udp"},
{"p2pq",               {NULL}, 1981, "tcp"},
{"p2pq",               {NULL}, 1981, "udp"},
{"estamp",             {NULL}, 1982, "tcp"},
{"estamp",             {NULL}, 1982, "udp"},
{"lhtp",               {NULL}, 1983, "tcp"},
{"lhtp",               {NULL}, 1983, "udp"},
{"bb",                 {NULL}, 1984, "tcp"},
{"bb",                 {NULL}, 1984, "udp"},
{"hsrp",               {NULL}, 1985, "tcp"},
{"hsrp",               {NULL}, 1985, "udp"},
{"licensedaemon",      {NULL}, 1986, "tcp"},
{"licensedaemon",      {NULL}, 1986, "udp"},
{"tr-rsrb-p1",         {NULL}, 1987, "tcp"},
{"tr-rsrb-p1",         {NULL}, 1987, "udp"},
{"tr-rsrb-p2",         {NULL}, 1988, "tcp"},
{"tr-rsrb-p2",         {NULL}, 1988, "udp"},
{"tr-rsrb-p3",         {NULL}, 1989, "tcp"},
{"tr-rsrb-p3",         {NULL}, 1989, "udp"},
{"mshnet",             {NULL}, 1989, "tcp"},
{"mshnet",             {NULL}, 1989, "udp"},
{"stun-p1",            {NULL}, 1990, "tcp"},
{"stun-p1",            {NULL}, 1990, "udp"},
{"stun-p2",            {NULL}, 1991, "tcp"},
{"stun-p2",            {NULL}, 1991, "udp"},
{"stun-p3",            {NULL}, 1992, "tcp"},
{"stun-p3",            {NULL}, 1992, "udp"},
{"ipsendmsg",          {NULL}, 1992, "tcp"},
{"ipsendmsg",          {NULL}, 1992, "udp"},
{"snmp-tcp-port",      {NULL}, 1993, "tcp"},
{"snmp-tcp-port",      {NULL}, 1993, "udp"},
{"stun-port",          {NULL}, 1994, "tcp"},
{"stun-port",          {NULL}, 1994, "udp"},
{"perf-port",          {NULL}, 1995, "tcp"},
{"perf-port",          {NULL}, 1995, "udp"},
{"tr-rsrb-port",       {NULL}, 1996, "tcp"},
{"tr-rsrb-port",       {NULL}, 1996, "udp"},
{"gdp-port",           {NULL}, 1997, "tcp"},
{"gdp-port",           {NULL}, 1997, "udp"},
{"x25-svc-port",       {NULL}, 1998, "tcp"},
{"x25-svc-port",       {NULL}, 1998, "udp"},
{"tcp-id-port",        {NULL}, 1999, "tcp"},
{"tcp-id-port",        {NULL}, 1999, "udp"},
{"cisco-sccp",         {NULL}, 2000, "tcp"},
{"cisco-sccp",         {NULL}, 2000, "udp"},
{"dc",                 {NULL}, 2001, "tcp"},
{"wizard",             {NULL}, 2001, "udp"},
{"globe",              {NULL}, 2002, "tcp"},
{"globe",              {NULL}, 2002, "udp"},
{"brutus",             {NULL}, 2003, "tcp"},
{"brutus",             {NULL}, 2003, "udp"},
{"mailbox",            {NULL}, 2004, "tcp"},
{"emce",               {NULL}, 2004, "udp"},
{"berknet",            {NULL}, 2005, "tcp"},
{"oracle",             {NULL}, 2005, "udp"},
{"invokator",          {NULL}, 2006, "tcp"},
{"raid-cd",            {NULL}, 2006, "udp"},
{"dectalk",            {NULL}, 2007, "tcp"},
{"raid-am",            {NULL}, 2007, "udp"},
{"conf",               {NULL}, 2008, "tcp"},
{"terminaldb",         {NULL}, 2008, "udp"},
{"news",               {NULL}, 2009, "tcp"},
{"whosockami",         {NULL}, 2009, "udp"},
{"search",             {NULL}, 2010, "tcp"},
{"pipe_server",        {NULL}, 2010, "udp"},
{"raid-cc",            {NULL}, 2011, "tcp"},
{"servserv",           {NULL}, 2011, "udp"},
{"ttyinfo",            {NULL}, 2012, "tcp"},
{"raid-ac",            {NULL}, 2012, "udp"},
{"raid-am",            {NULL}, 2013, "tcp"},
{"raid-cd",            {NULL}, 2013, "udp"},
{"troff",              {NULL}, 2014, "tcp"},
{"raid-sf",            {NULL}, 2014, "udp"},
{"cypress",            {NULL}, 2015, "tcp"},
{"raid-cs",            {NULL}, 2015, "udp"},
{"bootserver",         {NULL}, 2016, "tcp"},
{"bootserver",         {NULL}, 2016, "udp"},
{"cypress-stat",       {NULL}, 2017, "tcp"},
{"bootclient",         {NULL}, 2017, "udp"},
{"terminaldb",         {NULL}, 2018, "tcp"},
{"rellpack",           {NULL}, 2018, "udp"},
{"whosockami",         {NULL}, 2019, "tcp"},
{"about",              {NULL}, 2019, "udp"},
{"xinupageserver",     {NULL}, 2020, "tcp"},
{"xinupageserver",     {NULL}, 2020, "udp"},
{"servexec",           {NULL}, 2021, "tcp"},
{"xinuexpansion1",     {NULL}, 2021, "udp"},
{"down",               {NULL}, 2022, "tcp"},
{"xinuexpansion2",     {NULL}, 2022, "udp"},
{"xinuexpansion3",     {NULL}, 2023, "tcp"},
{"xinuexpansion3",     {NULL}, 2023, "udp"},
{"xinuexpansion4",     {NULL}, 2024, "tcp"},
{"xinuexpansion4",     {NULL}, 2024, "udp"},
{"ellpack",            {NULL}, 2025, "tcp"},
{"xribs",              {NULL}, 2025, "udp"},
{"scrabble",           {NULL}, 2026, "tcp"},
{"scrabble",           {NULL}, 2026, "udp"},
{"shadowserver",       {NULL}, 2027, "tcp"},
{"shadowserver",       {NULL}, 2027, "udp"},
{"submitserver",       {NULL}, 2028, "tcp"},
{"submitserver",       {NULL}, 2028, "udp"},
{"hsrpv6",             {NULL}, 2029, "tcp"},
{"hsrpv6",             {NULL}, 2029, "udp"},
{"device2",            {NULL}, 2030, "tcp"},
{"device2",            {NULL}, 2030, "udp"},
{"mobrien-chat",       {NULL}, 2031, "tcp"},
{"mobrien-chat",       {NULL}, 2031, "udp"},
{"blackboard",         {NULL}, 2032, "tcp"},
{"blackboard",         {NULL}, 2032, "udp"},
{"glogger",            {NULL}, 2033, "tcp"},
{"glogger",            {NULL}, 2033, "udp"},
{"scoremgr",           {NULL}, 2034, "tcp"},
{"scoremgr",           {NULL}, 2034, "udp"},
{"imsldoc",            {NULL}, 2035, "tcp"},
{"imsldoc",            {NULL}, 2035, "udp"},
{"e-dpnet",            {NULL}, 2036, "tcp"},
{"e-dpnet",            {NULL}, 2036, "udp"},
{"applus",             {NULL}, 2037, "tcp"},
{"applus",             {NULL}, 2037, "udp"},
{"objectmanager",      {NULL}, 2038, "tcp"},
{"objectmanager",      {NULL}, 2038, "udp"},
{"prizma",             {NULL}, 2039, "tcp"},
{"prizma",             {NULL}, 2039, "udp"},
{"lam",                {NULL}, 2040, "tcp"},
{"lam",                {NULL}, 2040, "udp"},
{"interbase",          {NULL}, 2041, "tcp"},
{"interbase",          {NULL}, 2041, "udp"},
{"isis",               {NULL}, 2042, "tcp"},
{"isis",               {NULL}, 2042, "udp"},
{"isis-bcast",         {NULL}, 2043, "tcp"},
{"isis-bcast",         {NULL}, 2043, "udp"},
{"rimsl",              {NULL}, 2044, "tcp"},
{"rimsl",              {NULL}, 2044, "udp"},
{"cdfunc",             {NULL}, 2045, "tcp"},
{"cdfunc",             {NULL}, 2045, "udp"},
{"sdfunc",             {NULL}, 2046, "tcp"},
{"sdfunc",             {NULL}, 2046, "udp"},
{"dls",                {NULL}, 2047, "tcp"},
{"dls",                {NULL}, 2047, "udp"},
{"dls-monitor",        {NULL}, 2048, "tcp"},
{"dls-monitor",        {NULL}, 2048, "udp"},
{"shilp",              {NULL}, 2049, "tcp"},
{"shilp",              {NULL}, 2049, "udp"},
{"nfs",                {NULL}, 2049, "tcp"},
{"nfs",                {NULL}, 2049, "udp"},
{"nfs",                {NULL}, 2049, "sctp"},
{"av-emb-config",      {NULL}, 2050, "tcp"},
{"av-emb-config",      {NULL}, 2050, "udp"},
{"epnsdp",             {NULL}, 2051, "tcp"},
{"epnsdp",             {NULL}, 2051, "udp"},
{"clearvisn",          {NULL}, 2052, "tcp"},
{"clearvisn",          {NULL}, 2052, "udp"},
{"lot105-ds-upd",      {NULL}, 2053, "tcp"},
{"lot105-ds-upd",      {NULL}, 2053, "udp"},
{"weblogin",           {NULL}, 2054, "tcp"},
{"weblogin",           {NULL}, 2054, "udp"},
{"iop",                {NULL}, 2055, "tcp"},
{"iop",                {NULL}, 2055, "udp"},
{"omnisky",            {NULL}, 2056, "tcp"},
{"omnisky",            {NULL}, 2056, "udp"},
{"rich-cp",            {NULL}, 2057, "tcp"},
{"rich-cp",            {NULL}, 2057, "udp"},
{"newwavesearch",      {NULL}, 2058, "tcp"},
{"newwavesearch",      {NULL}, 2058, "udp"},
{"bmc-messaging",      {NULL}, 2059, "tcp"},
{"bmc-messaging",      {NULL}, 2059, "udp"},
{"teleniumdaemon",     {NULL}, 2060, "tcp"},
{"teleniumdaemon",     {NULL}, 2060, "udp"},
{"netmount",           {NULL}, 2061, "tcp"},
{"netmount",           {NULL}, 2061, "udp"},
{"icg-swp",            {NULL}, 2062, "tcp"},
{"icg-swp",            {NULL}, 2062, "udp"},
{"icg-bridge",         {NULL}, 2063, "tcp"},
{"icg-bridge",         {NULL}, 2063, "udp"},
{"icg-iprelay",        {NULL}, 2064, "tcp"},
{"icg-iprelay",        {NULL}, 2064, "udp"},
{"dlsrpn",             {NULL}, 2065, "tcp"},
{"dlsrpn",             {NULL}, 2065, "udp"},
{"aura",               {NULL}, 2066, "tcp"},
{"aura",               {NULL}, 2066, "udp"},
{"dlswpn",             {NULL}, 2067, "tcp"},
{"dlswpn",             {NULL}, 2067, "udp"},
{"avauthsrvprtcl",     {NULL}, 2068, "tcp"},
{"avauthsrvprtcl",     {NULL}, 2068, "udp"},
{"event-port",         {NULL}, 2069, "tcp"},
{"event-port",         {NULL}, 2069, "udp"},
{"ah-esp-encap",       {NULL}, 2070, "tcp"},
{"ah-esp-encap",       {NULL}, 2070, "udp"},
{"acp-port",           {NULL}, 2071, "tcp"},
{"acp-port",           {NULL}, 2071, "udp"},
{"msync",              {NULL}, 2072, "tcp"},
{"msync",              {NULL}, 2072, "udp"},
{"gxs-data-port",      {NULL}, 2073, "tcp"},
{"gxs-data-port",      {NULL}, 2073, "udp"},
{"vrtl-vmf-sa",        {NULL}, 2074, "tcp"},
{"vrtl-vmf-sa",        {NULL}, 2074, "udp"},
{"newlixengine",       {NULL}, 2075, "tcp"},
{"newlixengine",       {NULL}, 2075, "udp"},
{"newlixconfig",       {NULL}, 2076, "tcp"},
{"newlixconfig",       {NULL}, 2076, "udp"},
{"tsrmagt",            {NULL}, 2077, "tcp"},
{"tsrmagt",            {NULL}, 2077, "udp"},
{"tpcsrvr",            {NULL}, 2078, "tcp"},
{"tpcsrvr",            {NULL}, 2078, "udp"},
{"idware-router",      {NULL}, 2079, "tcp"},
{"idware-router",      {NULL}, 2079, "udp"},
{"autodesk-nlm",       {NULL}, 2080, "tcp"},
{"autodesk-nlm",       {NULL}, 2080, "udp"},
{"kme-trap-port",      {NULL}, 2081, "tcp"},
{"kme-trap-port",      {NULL}, 2081, "udp"},
{"infowave",           {NULL}, 2082, "tcp"},
{"infowave",           {NULL}, 2082, "udp"},
{"radsec",             {NULL}, 2083, "tcp"},
{"radsec",             {NULL}, 2083, "udp"},
{"sunclustergeo",      {NULL}, 2084, "tcp"},
{"sunclustergeo",      {NULL}, 2084, "udp"},
{"ada-cip",            {NULL}, 2085, "tcp"},
{"ada-cip",            {NULL}, 2085, "udp"},
{"gnunet",             {NULL}, 2086, "tcp"},
{"gnunet",             {NULL}, 2086, "udp"},
{"eli",                {NULL}, 2087, "tcp"},
{"eli",                {NULL}, 2087, "udp"},
{"ip-blf",             {NULL}, 2088, "tcp"},
{"ip-blf",             {NULL}, 2088, "udp"},
{"sep",                {NULL}, 2089, "tcp"},
{"sep",                {NULL}, 2089, "udp"},
{"lrp",                {NULL}, 2090, "tcp"},
{"lrp",                {NULL}, 2090, "udp"},
{"prp",                {NULL}, 2091, "tcp"},
{"prp",                {NULL}, 2091, "udp"},
{"descent3",           {NULL}, 2092, "tcp"},
{"descent3",           {NULL}, 2092, "udp"},
{"nbx-cc",             {NULL}, 2093, "tcp"},
{"nbx-cc",             {NULL}, 2093, "udp"},
{"nbx-au",             {NULL}, 2094, "tcp"},
{"nbx-au",             {NULL}, 2094, "udp"},
{"nbx-ser",            {NULL}, 2095, "tcp"},
{"nbx-ser",            {NULL}, 2095, "udp"},
{"nbx-dir",            {NULL}, 2096, "tcp"},
{"nbx-dir",            {NULL}, 2096, "udp"},
{"jetformpreview",     {NULL}, 2097, "tcp"},
{"jetformpreview",     {NULL}, 2097, "udp"},
{"dialog-port",        {NULL}, 2098, "tcp"},
{"dialog-port",        {NULL}, 2098, "udp"},
{"h2250-annex-g",      {NULL}, 2099, "tcp"},
{"h2250-annex-g",      {NULL}, 2099, "udp"},
{"amiganetfs",         {NULL}, 2100, "tcp"},
{"amiganetfs",         {NULL}, 2100, "udp"},
{"rtcm-sc104",         {NULL}, 2101, "tcp"},
{"rtcm-sc104",         {NULL}, 2101, "udp"},
{"zephyr-srv",         {NULL}, 2102, "tcp"},
{"zephyr-srv",         {NULL}, 2102, "udp"},
{"zephyr-clt",         {NULL}, 2103, "tcp"},
{"zephyr-clt",         {NULL}, 2103, "udp"},
{"zephyr-hm",          {NULL}, 2104, "tcp"},
{"zephyr-hm",          {NULL}, 2104, "udp"},
{"minipay",            {NULL}, 2105, "tcp"},
{"minipay",            {NULL}, 2105, "udp"},
{"mzap",               {NULL}, 2106, "tcp"},
{"mzap",               {NULL}, 2106, "udp"},
{"bintec-admin",       {NULL}, 2107, "tcp"},
{"bintec-admin",       {NULL}, 2107, "udp"},
{"comcam",             {NULL}, 2108, "tcp"},
{"comcam",             {NULL}, 2108, "udp"},
{"ergolight",          {NULL}, 2109, "tcp"},
{"ergolight",          {NULL}, 2109, "udp"},
{"umsp",               {NULL}, 2110, "tcp"},
{"umsp",               {NULL}, 2110, "udp"},
{"dsatp",              {NULL}, 2111, "tcp"},
{"dsatp",              {NULL}, 2111, "udp"},
{"idonix-metanet",     {NULL}, 2112, "tcp"},
{"idonix-metanet",     {NULL}, 2112, "udp"},
{"hsl-storm",          {NULL}, 2113, "tcp"},
{"hsl-storm",          {NULL}, 2113, "udp"},
{"newheights",         {NULL}, 2114, "tcp"},
{"newheights",         {NULL}, 2114, "udp"},
{"kdm",                {NULL}, 2115, "tcp"},
{"kdm",                {NULL}, 2115, "udp"},
{"ccowcmr",            {NULL}, 2116, "tcp"},
{"ccowcmr",            {NULL}, 2116, "udp"},
{"mentaclient",        {NULL}, 2117, "tcp"},
{"mentaclient",        {NULL}, 2117, "udp"},
{"mentaserver",        {NULL}, 2118, "tcp"},
{"mentaserver",        {NULL}, 2118, "udp"},
{"gsigatekeeper",      {NULL}, 2119, "tcp"},
{"gsigatekeeper",      {NULL}, 2119, "udp"},
{"qencp",              {NULL}, 2120, "tcp"},
{"qencp",              {NULL}, 2120, "udp"},
{"scientia-ssdb",      {NULL}, 2121, "tcp"},
{"scientia-ssdb",      {NULL}, 2121, "udp"},
{"caupc-remote",       {NULL}, 2122, "tcp"},
{"caupc-remote",       {NULL}, 2122, "udp"},
{"gtp-control",        {NULL}, 2123, "tcp"},
{"gtp-control",        {NULL}, 2123, "udp"},
{"elatelink",          {NULL}, 2124, "tcp"},
{"elatelink",          {NULL}, 2124, "udp"},
{"lockstep",           {NULL}, 2125, "tcp"},
{"lockstep",           {NULL}, 2125, "udp"},
{"pktcable-cops",      {NULL}, 2126, "tcp"},
{"pktcable-cops",      {NULL}, 2126, "udp"},
{"index-pc-wb",        {NULL}, 2127, "tcp"},
{"index-pc-wb",        {NULL}, 2127, "udp"},
{"net-steward",        {NULL}, 2128, "tcp"},
{"net-steward",        {NULL}, 2128, "udp"},
{"cs-live",            {NULL}, 2129, "tcp"},
{"cs-live",            {NULL}, 2129, "udp"},
{"xds",                {NULL}, 2130, "tcp"},
{"xds",                {NULL}, 2130, "udp"},
{"avantageb2b",        {NULL}, 2131, "tcp"},
{"avantageb2b",        {NULL}, 2131, "udp"},
{"solera-epmap",       {NULL}, 2132, "tcp"},
{"solera-epmap",       {NULL}, 2132, "udp"},
{"zymed-zpp",          {NULL}, 2133, "tcp"},
{"zymed-zpp",          {NULL}, 2133, "udp"},
{"avenue",             {NULL}, 2134, "tcp"},
{"avenue",             {NULL}, 2134, "udp"},
{"gris",               {NULL}, 2135, "tcp"},
{"gris",               {NULL}, 2135, "udp"},
{"appworxsrv",         {NULL}, 2136, "tcp"},
{"appworxsrv",         {NULL}, 2136, "udp"},
{"connect",            {NULL}, 2137, "tcp"},
{"connect",            {NULL}, 2137, "udp"},
{"unbind-cluster",     {NULL}, 2138, "tcp"},
{"unbind-cluster",     {NULL}, 2138, "udp"},
{"ias-auth",           {NULL}, 2139, "tcp"},
{"ias-auth",           {NULL}, 2139, "udp"},
{"ias-reg",            {NULL}, 2140, "tcp"},
{"ias-reg",            {NULL}, 2140, "udp"},
{"ias-admind",         {NULL}, 2141, "tcp"},
{"ias-admind",         {NULL}, 2141, "udp"},
{"tdmoip",             {NULL}, 2142, "tcp"},
{"tdmoip",             {NULL}, 2142, "udp"},
{"lv-jc",              {NULL}, 2143, "tcp"},
{"lv-jc",              {NULL}, 2143, "udp"},
{"lv-ffx",             {NULL}, 2144, "tcp"},
{"lv-ffx",             {NULL}, 2144, "udp"},
{"lv-pici",            {NULL}, 2145, "tcp"},
{"lv-pici",            {NULL}, 2145, "udp"},
{"lv-not",             {NULL}, 2146, "tcp"},
{"lv-not",             {NULL}, 2146, "udp"},
{"lv-auth",            {NULL}, 2147, "tcp"},
{"lv-auth",            {NULL}, 2147, "udp"},
{"veritas-ucl",        {NULL}, 2148, "tcp"},
{"veritas-ucl",        {NULL}, 2148, "udp"},
{"acptsys",            {NULL}, 2149, "tcp"},
{"acptsys",            {NULL}, 2149, "udp"},
{"dynamic3d",          {NULL}, 2150, "tcp"},
{"dynamic3d",          {NULL}, 2150, "udp"},
{"docent",             {NULL}, 2151, "tcp"},
{"docent",             {NULL}, 2151, "udp"},
{"gtp-user",           {NULL}, 2152, "tcp"},
{"gtp-user",           {NULL}, 2152, "udp"},
{"ctlptc",             {NULL}, 2153, "tcp"},
{"ctlptc",             {NULL}, 2153, "udp"},
{"stdptc",             {NULL}, 2154, "tcp"},
{"stdptc",             {NULL}, 2154, "udp"},
{"brdptc",             {NULL}, 2155, "tcp"},
{"brdptc",             {NULL}, 2155, "udp"},
{"trp",                {NULL}, 2156, "tcp"},
{"trp",                {NULL}, 2156, "udp"},
{"xnds",               {NULL}, 2157, "tcp"},
{"xnds",               {NULL}, 2157, "udp"},
{"touchnetplus",       {NULL}, 2158, "tcp"},
{"touchnetplus",       {NULL}, 2158, "udp"},
{"gdbremote",          {NULL}, 2159, "tcp"},
{"gdbremote",          {NULL}, 2159, "udp"},
{"apc-2160",           {NULL}, 2160, "tcp"},
{"apc-2160",           {NULL}, 2160, "udp"},
{"apc-2161",           {NULL}, 2161, "tcp"},
{"apc-2161",           {NULL}, 2161, "udp"},
{"navisphere",         {NULL}, 2162, "tcp"},
{"navisphere",         {NULL}, 2162, "udp"},
{"navisphere-sec",     {NULL}, 2163, "tcp"},
{"navisphere-sec",     {NULL}, 2163, "udp"},
{"ddns-v3",            {NULL}, 2164, "tcp"},
{"ddns-v3",            {NULL}, 2164, "udp"},
{"x-bone-api",         {NULL}, 2165, "tcp"},
{"x-bone-api",         {NULL}, 2165, "udp"},
{"iwserver",           {NULL}, 2166, "tcp"},
{"iwserver",           {NULL}, 2166, "udp"},
{"raw-serial",         {NULL}, 2167, "tcp"},
{"raw-serial",         {NULL}, 2167, "udp"},
{"easy-soft-mux",      {NULL}, 2168, "tcp"},
{"easy-soft-mux",      {NULL}, 2168, "udp"},
{"brain",              {NULL}, 2169, "tcp"},
{"brain",              {NULL}, 2169, "udp"},
{"eyetv",              {NULL}, 2170, "tcp"},
{"eyetv",              {NULL}, 2170, "udp"},
{"msfw-storage",       {NULL}, 2171, "tcp"},
{"msfw-storage",       {NULL}, 2171, "udp"},
{"msfw-s-storage",     {NULL}, 2172, "tcp"},
{"msfw-s-storage",     {NULL}, 2172, "udp"},
{"msfw-replica",       {NULL}, 2173, "tcp"},
{"msfw-replica",       {NULL}, 2173, "udp"},
{"msfw-array",         {NULL}, 2174, "tcp"},
{"msfw-array",         {NULL}, 2174, "udp"},
{"airsync",            {NULL}, 2175, "tcp"},
{"airsync",            {NULL}, 2175, "udp"},
{"rapi",               {NULL}, 2176, "tcp"},
{"rapi",               {NULL}, 2176, "udp"},
{"qwave",              {NULL}, 2177, "tcp"},
{"qwave",              {NULL}, 2177, "udp"},
{"bitspeer",           {NULL}, 2178, "tcp"},
{"bitspeer",           {NULL}, 2178, "udp"},
{"vmrdp",              {NULL}, 2179, "tcp"},
{"vmrdp",              {NULL}, 2179, "udp"},
{"mc-gt-srv",          {NULL}, 2180, "tcp"},
{"mc-gt-srv",          {NULL}, 2180, "udp"},
{"eforward",           {NULL}, 2181, "tcp"},
{"eforward",           {NULL}, 2181, "udp"},
{"cgn-stat",           {NULL}, 2182, "tcp"},
{"cgn-stat",           {NULL}, 2182, "udp"},
{"cgn-config",         {NULL}, 2183, "tcp"},
{"cgn-config",         {NULL}, 2183, "udp"},
{"nvd",                {NULL}, 2184, "tcp"},
{"nvd",                {NULL}, 2184, "udp"},
{"onbase-dds",         {NULL}, 2185, "tcp"},
{"onbase-dds",         {NULL}, 2185, "udp"},
{"gtaua",              {NULL}, 2186, "tcp"},
{"gtaua",              {NULL}, 2186, "udp"},
{"ssmc",               {NULL}, 2187, "tcp"},
{"ssmd",               {NULL}, 2187, "udp"},
{"tivoconnect",        {NULL}, 2190, "tcp"},
{"tivoconnect",        {NULL}, 2190, "udp"},
{"tvbus",              {NULL}, 2191, "tcp"},
{"tvbus",              {NULL}, 2191, "udp"},
{"asdis",              {NULL}, 2192, "tcp"},
{"asdis",              {NULL}, 2192, "udp"},
{"drwcs",              {NULL}, 2193, "tcp"},
{"drwcs",              {NULL}, 2193, "udp"},
{"mnp-exchange",       {NULL}, 2197, "tcp"},
{"mnp-exchange",       {NULL}, 2197, "udp"},
{"onehome-remote",     {NULL}, 2198, "tcp"},
{"onehome-remote",     {NULL}, 2198, "udp"},
{"onehome-help",       {NULL}, 2199, "tcp"},
{"onehome-help",       {NULL}, 2199, "udp"},
{"ici",                {NULL}, 2200, "tcp"},
{"ici",                {NULL}, 2200, "udp"},
{"ats",                {NULL}, 2201, "tcp"},
{"ats",                {NULL}, 2201, "udp"},
{"imtc-map",           {NULL}, 2202, "tcp"},
{"imtc-map",           {NULL}, 2202, "udp"},
{"b2-runtime",         {NULL}, 2203, "tcp"},
{"b2-runtime",         {NULL}, 2203, "udp"},
{"b2-license",         {NULL}, 2204, "tcp"},
{"b2-license",         {NULL}, 2204, "udp"},
{"jps",                {NULL}, 2205, "tcp"},
{"jps",                {NULL}, 2205, "udp"},
{"hpocbus",            {NULL}, 2206, "tcp"},
{"hpocbus",            {NULL}, 2206, "udp"},
{"hpssd",              {NULL}, 2207, "tcp"},
{"hpssd",              {NULL}, 2207, "udp"},
{"hpiod",              {NULL}, 2208, "tcp"},
{"hpiod",              {NULL}, 2208, "udp"},
{"rimf-ps",            {NULL}, 2209, "tcp"},
{"rimf-ps",            {NULL}, 2209, "udp"},
{"noaaport",           {NULL}, 2210, "tcp"},
{"noaaport",           {NULL}, 2210, "udp"},
{"emwin",              {NULL}, 2211, "tcp"},
{"emwin",              {NULL}, 2211, "udp"},
{"leecoposserver",     {NULL}, 2212, "tcp"},
{"leecoposserver",     {NULL}, 2212, "udp"},
{"kali",               {NULL}, 2213, "tcp"},
{"kali",               {NULL}, 2213, "udp"},
{"rpi",                {NULL}, 2214, "tcp"},
{"rpi",                {NULL}, 2214, "udp"},
{"ipcore",             {NULL}, 2215, "tcp"},
{"ipcore",             {NULL}, 2215, "udp"},
{"vtu-comms",          {NULL}, 2216, "tcp"},
{"vtu-comms",          {NULL}, 2216, "udp"},
{"gotodevice",         {NULL}, 2217, "tcp"},
{"gotodevice",         {NULL}, 2217, "udp"},
{"bounzza",            {NULL}, 2218, "tcp"},
{"bounzza",            {NULL}, 2218, "udp"},
{"netiq-ncap",         {NULL}, 2219, "tcp"},
{"netiq-ncap",         {NULL}, 2219, "udp"},
{"netiq",              {NULL}, 2220, "tcp"},
{"netiq",              {NULL}, 2220, "udp"},
{"rockwell-csp1",      {NULL}, 2221, "tcp"},
{"rockwell-csp1",      {NULL}, 2221, "udp"},
{"EtherNet/IP-1",      {NULL}, 2222, "tcp"},
{"EtherNet/IP-1",      {NULL}, 2222, "udp"},
{"rockwell-csp2",      {NULL}, 2223, "tcp"},
{"rockwell-csp2",      {NULL}, 2223, "udp"},
{"efi-mg",             {NULL}, 2224, "tcp"},
{"efi-mg",             {NULL}, 2224, "udp"},
{"rcip-itu",           {NULL}, 2225, "tcp"},
{"rcip-itu",           {NULL}, 2225, "sctp"},
{"di-drm",             {NULL}, 2226, "tcp"},
{"di-drm",             {NULL}, 2226, "udp"},
{"di-msg",             {NULL}, 2227, "tcp"},
{"di-msg",             {NULL}, 2227, "udp"},
{"ehome-ms",           {NULL}, 2228, "tcp"},
{"ehome-ms",           {NULL}, 2228, "udp"},
{"datalens",           {NULL}, 2229, "tcp"},
{"datalens",           {NULL}, 2229, "udp"},
{"queueadm",           {NULL}, 2230, "tcp"},
{"queueadm",           {NULL}, 2230, "udp"},
{"wimaxasncp",         {NULL}, 2231, "tcp"},
{"wimaxasncp",         {NULL}, 2231, "udp"},
{"ivs-video",          {NULL}, 2232, "tcp"},
{"ivs-video",          {NULL}, 2232, "udp"},
{"infocrypt",          {NULL}, 2233, "tcp"},
{"infocrypt",          {NULL}, 2233, "udp"},
{"directplay",         {NULL}, 2234, "tcp"},
{"directplay",         {NULL}, 2234, "udp"},
{"sercomm-wlink",      {NULL}, 2235, "tcp"},
{"sercomm-wlink",      {NULL}, 2235, "udp"},
{"nani",               {NULL}, 2236, "tcp"},
{"nani",               {NULL}, 2236, "udp"},
{"optech-port1-lm",    {NULL}, 2237, "tcp"},
{"optech-port1-lm",    {NULL}, 2237, "udp"},
{"aviva-sna",          {NULL}, 2238, "tcp"},
{"aviva-sna",          {NULL}, 2238, "udp"},
{"imagequery",         {NULL}, 2239, "tcp"},
{"imagequery",         {NULL}, 2239, "udp"},
{"recipe",             {NULL}, 2240, "tcp"},
{"recipe",             {NULL}, 2240, "udp"},
{"ivsd",               {NULL}, 2241, "tcp"},
{"ivsd",               {NULL}, 2241, "udp"},
{"foliocorp",          {NULL}, 2242, "tcp"},
{"foliocorp",          {NULL}, 2242, "udp"},
{"magicom",            {NULL}, 2243, "tcp"},
{"magicom",            {NULL}, 2243, "udp"},
{"nmsserver",          {NULL}, 2244, "tcp"},
{"nmsserver",          {NULL}, 2244, "udp"},
{"hao",                {NULL}, 2245, "tcp"},
{"hao",                {NULL}, 2245, "udp"},
{"pc-mta-addrmap",     {NULL}, 2246, "tcp"},
{"pc-mta-addrmap",     {NULL}, 2246, "udp"},
{"antidotemgrsvr",     {NULL}, 2247, "tcp"},
{"antidotemgrsvr",     {NULL}, 2247, "udp"},
{"ums",                {NULL}, 2248, "tcp"},
{"ums",                {NULL}, 2248, "udp"},
{"rfmp",               {NULL}, 2249, "tcp"},
{"rfmp",               {NULL}, 2249, "udp"},
{"remote-collab",      {NULL}, 2250, "tcp"},
{"remote-collab",      {NULL}, 2250, "udp"},
{"dif-port",           {NULL}, 2251, "tcp"},
{"dif-port",           {NULL}, 2251, "udp"},
{"njenet-ssl",         {NULL}, 2252, "tcp"},
{"njenet-ssl",         {NULL}, 2252, "udp"},
{"dtv-chan-req",       {NULL}, 2253, "tcp"},
{"dtv-chan-req",       {NULL}, 2253, "udp"},
{"seispoc",            {NULL}, 2254, "tcp"},
{"seispoc",            {NULL}, 2254, "udp"},
{"vrtp",               {NULL}, 2255, "tcp"},
{"vrtp",               {NULL}, 2255, "udp"},
{"pcc-mfp",            {NULL}, 2256, "tcp"},
{"pcc-mfp",            {NULL}, 2256, "udp"},
{"simple-tx-rx",       {NULL}, 2257, "tcp"},
{"simple-tx-rx",       {NULL}, 2257, "udp"},
{"rcts",               {NULL}, 2258, "tcp"},
{"rcts",               {NULL}, 2258, "udp"},
{"acd-pm",             {NULL}, 2259, "tcp"},
{"acd-pm",             {NULL}, 2259, "udp"},
{"apc-2260",           {NULL}, 2260, "tcp"},
{"apc-2260",           {NULL}, 2260, "udp"},
{"comotionmaster",     {NULL}, 2261, "tcp"},
{"comotionmaster",     {NULL}, 2261, "udp"},
{"comotionback",       {NULL}, 2262, "tcp"},
{"comotionback",       {NULL}, 2262, "udp"},
{"ecwcfg",             {NULL}, 2263, "tcp"},
{"ecwcfg",             {NULL}, 2263, "udp"},
{"apx500api-1",        {NULL}, 2264, "tcp"},
{"apx500api-1",        {NULL}, 2264, "udp"},
{"apx500api-2",        {NULL}, 2265, "tcp"},
{"apx500api-2",        {NULL}, 2265, "udp"},
{"mfserver",           {NULL}, 2266, "tcp"},
{"mfserver",           {NULL}, 2266, "udp"},
{"ontobroker",         {NULL}, 2267, "tcp"},
{"ontobroker",         {NULL}, 2267, "udp"},
{"amt",                {NULL}, 2268, "tcp"},
{"amt",                {NULL}, 2268, "udp"},
{"mikey",              {NULL}, 2269, "tcp"},
{"mikey",              {NULL}, 2269, "udp"},
{"starschool",         {NULL}, 2270, "tcp"},
{"starschool",         {NULL}, 2270, "udp"},
{"mmcals",             {NULL}, 2271, "tcp"},
{"mmcals",             {NULL}, 2271, "udp"},
{"mmcal",              {NULL}, 2272, "tcp"},
{"mmcal",              {NULL}, 2272, "udp"},
{"mysql-im",           {NULL}, 2273, "tcp"},
{"mysql-im",           {NULL}, 2273, "udp"},
{"pcttunnell",         {NULL}, 2274, "tcp"},
{"pcttunnell",         {NULL}, 2274, "udp"},
{"ibridge-data",       {NULL}, 2275, "tcp"},
{"ibridge-data",       {NULL}, 2275, "udp"},
{"ibridge-mgmt",       {NULL}, 2276, "tcp"},
{"ibridge-mgmt",       {NULL}, 2276, "udp"},
{"bluectrlproxy",      {NULL}, 2277, "tcp"},
{"bluectrlproxy",      {NULL}, 2277, "udp"},
{"s3db",               {NULL}, 2278, "tcp"},
{"s3db",               {NULL}, 2278, "udp"},
{"xmquery",            {NULL}, 2279, "tcp"},
{"xmquery",            {NULL}, 2279, "udp"},
{"lnvpoller",          {NULL}, 2280, "tcp"},
{"lnvpoller",          {NULL}, 2280, "udp"},
{"lnvconsole",         {NULL}, 2281, "tcp"},
{"lnvconsole",         {NULL}, 2281, "udp"},
{"lnvalarm",           {NULL}, 2282, "tcp"},
{"lnvalarm",           {NULL}, 2282, "udp"},
{"lnvstatus",          {NULL}, 2283, "tcp"},
{"lnvstatus",          {NULL}, 2283, "udp"},
{"lnvmaps",            {NULL}, 2284, "tcp"},
{"lnvmaps",            {NULL}, 2284, "udp"},
{"lnvmailmon",         {NULL}, 2285, "tcp"},
{"lnvmailmon",         {NULL}, 2285, "udp"},
{"nas-metering",       {NULL}, 2286, "tcp"},
{"nas-metering",       {NULL}, 2286, "udp"},
{"dna",                {NULL}, 2287, "tcp"},
{"dna",                {NULL}, 2287, "udp"},
{"netml",              {NULL}, 2288, "tcp"},
{"netml",              {NULL}, 2288, "udp"},
{"dict-lookup",        {NULL}, 2289, "tcp"},
{"dict-lookup",        {NULL}, 2289, "udp"},
{"sonus-logging",      {NULL}, 2290, "tcp"},
{"sonus-logging",      {NULL}, 2290, "udp"},
{"eapsp",              {NULL}, 2291, "tcp"},
{"eapsp",              {NULL}, 2291, "udp"},
{"mib-streaming",      {NULL}, 2292, "tcp"},
{"mib-streaming",      {NULL}, 2292, "udp"},
{"npdbgmngr",          {NULL}, 2293, "tcp"},
{"npdbgmngr",          {NULL}, 2293, "udp"},
{"konshus-lm",         {NULL}, 2294, "tcp"},
{"konshus-lm",         {NULL}, 2294, "udp"},
{"advant-lm",          {NULL}, 2295, "tcp"},
{"advant-lm",          {NULL}, 2295, "udp"},
{"theta-lm",           {NULL}, 2296, "tcp"},
{"theta-lm",           {NULL}, 2296, "udp"},
{"d2k-datamover1",     {NULL}, 2297, "tcp"},
{"d2k-datamover1",     {NULL}, 2297, "udp"},
{"d2k-datamover2",     {NULL}, 2298, "tcp"},
{"d2k-datamover2",     {NULL}, 2298, "udp"},
{"pc-telecommute",     {NULL}, 2299, "tcp"},
{"pc-telecommute",     {NULL}, 2299, "udp"},
{"cvmmon",             {NULL}, 2300, "tcp"},
{"cvmmon",             {NULL}, 2300, "udp"},
{"cpq-wbem",           {NULL}, 2301, "tcp"},
{"cpq-wbem",           {NULL}, 2301, "udp"},
{"binderysupport",     {NULL}, 2302, "tcp"},
{"binderysupport",     {NULL}, 2302, "udp"},
{"proxy-gateway",      {NULL}, 2303, "tcp"},
{"proxy-gateway",      {NULL}, 2303, "udp"},
{"attachmate-uts",     {NULL}, 2304, "tcp"},
{"attachmate-uts",     {NULL}, 2304, "udp"},
{"mt-scaleserver",     {NULL}, 2305, "tcp"},
{"mt-scaleserver",     {NULL}, 2305, "udp"},
{"tappi-boxnet",       {NULL}, 2306, "tcp"},
{"tappi-boxnet",       {NULL}, 2306, "udp"},
{"pehelp",             {NULL}, 2307, "tcp"},
{"pehelp",             {NULL}, 2307, "udp"},
{"sdhelp",             {NULL}, 2308, "tcp"},
{"sdhelp",             {NULL}, 2308, "udp"},
{"sdserver",           {NULL}, 2309, "tcp"},
{"sdserver",           {NULL}, 2309, "udp"},
{"sdclient",           {NULL}, 2310, "tcp"},
{"sdclient",           {NULL}, 2310, "udp"},
{"messageservice",     {NULL}, 2311, "tcp"},
{"messageservice",     {NULL}, 2311, "udp"},
{"wanscaler",          {NULL}, 2312, "tcp"},
{"wanscaler",          {NULL}, 2312, "udp"},
{"iapp",               {NULL}, 2313, "tcp"},
{"iapp",               {NULL}, 2313, "udp"},
{"cr-websystems",      {NULL}, 2314, "tcp"},
{"cr-websystems",      {NULL}, 2314, "udp"},
{"precise-sft",        {NULL}, 2315, "tcp"},
{"precise-sft",        {NULL}, 2315, "udp"},
{"sent-lm",            {NULL}, 2316, "tcp"},
{"sent-lm",            {NULL}, 2316, "udp"},
{"attachmate-g32",     {NULL}, 2317, "tcp"},
{"attachmate-g32",     {NULL}, 2317, "udp"},
{"cadencecontrol",     {NULL}, 2318, "tcp"},
{"cadencecontrol",     {NULL}, 2318, "udp"},
{"infolibria",         {NULL}, 2319, "tcp"},
{"infolibria",         {NULL}, 2319, "udp"},
{"siebel-ns",          {NULL}, 2320, "tcp"},
{"siebel-ns",          {NULL}, 2320, "udp"},
{"rdlap",              {NULL}, 2321, "tcp"},
{"rdlap",              {NULL}, 2321, "udp"},
{"ofsd",               {NULL}, 2322, "tcp"},
{"ofsd",               {NULL}, 2322, "udp"},
{"3d-nfsd",            {NULL}, 2323, "tcp"},
{"3d-nfsd",            {NULL}, 2323, "udp"},
{"cosmocall",          {NULL}, 2324, "tcp"},
{"cosmocall",          {NULL}, 2324, "udp"},
{"ansysli",            {NULL}, 2325, "tcp"},
{"ansysli",            {NULL}, 2325, "udp"},
{"idcp",               {NULL}, 2326, "tcp"},
{"idcp",               {NULL}, 2326, "udp"},
{"xingcsm",            {NULL}, 2327, "tcp"},
{"xingcsm",            {NULL}, 2327, "udp"},
{"netrix-sftm",        {NULL}, 2328, "tcp"},
{"netrix-sftm",        {NULL}, 2328, "udp"},
{"nvd",                {NULL}, 2329, "tcp"},
{"nvd",                {NULL}, 2329, "udp"},
{"tscchat",            {NULL}, 2330, "tcp"},
{"tscchat",            {NULL}, 2330, "udp"},
{"agentview",          {NULL}, 2331, "tcp"},
{"agentview",          {NULL}, 2331, "udp"},
{"rcc-host",           {NULL}, 2332, "tcp"},
{"rcc-host",           {NULL}, 2332, "udp"},
{"snapp",              {NULL}, 2333, "tcp"},
{"snapp",              {NULL}, 2333, "udp"},
{"ace-client",         {NULL}, 2334, "tcp"},
{"ace-client",         {NULL}, 2334, "udp"},
{"ace-proxy",          {NULL}, 2335, "tcp"},
{"ace-proxy",          {NULL}, 2335, "udp"},
{"appleugcontrol",     {NULL}, 2336, "tcp"},
{"appleugcontrol",     {NULL}, 2336, "udp"},
{"ideesrv",            {NULL}, 2337, "tcp"},
{"ideesrv",            {NULL}, 2337, "udp"},
{"norton-lambert",     {NULL}, 2338, "tcp"},
{"norton-lambert",     {NULL}, 2338, "udp"},
{"3com-webview",       {NULL}, 2339, "tcp"},
{"3com-webview",       {NULL}, 2339, "udp"},
{"wrs_registry",       {NULL}, 2340, "tcp"},
{"wrs_registry",       {NULL}, 2340, "udp"},
{"xiostatus",          {NULL}, 2341, "tcp"},
{"xiostatus",          {NULL}, 2341, "udp"},
{"manage-exec",        {NULL}, 2342, "tcp"},
{"manage-exec",        {NULL}, 2342, "udp"},
{"nati-logos",         {NULL}, 2343, "tcp"},
{"nati-logos",         {NULL}, 2343, "udp"},
{"fcmsys",             {NULL}, 2344, "tcp"},
{"fcmsys",             {NULL}, 2344, "udp"},
{"dbm",                {NULL}, 2345, "tcp"},
{"dbm",                {NULL}, 2345, "udp"},
{"redstorm_join",      {NULL}, 2346, "tcp"},
{"redstorm_join",      {NULL}, 2346, "udp"},
{"redstorm_find",      {NULL}, 2347, "tcp"},
{"redstorm_find",      {NULL}, 2347, "udp"},
{"redstorm_info",      {NULL}, 2348, "tcp"},
{"redstorm_info",      {NULL}, 2348, "udp"},
{"redstorm_diag",      {NULL}, 2349, "tcp"},
{"redstorm_diag",      {NULL}, 2349, "udp"},
{"psbserver",          {NULL}, 2350, "tcp"},
{"psbserver",          {NULL}, 2350, "udp"},
{"psrserver",          {NULL}, 2351, "tcp"},
{"psrserver",          {NULL}, 2351, "udp"},
{"pslserver",          {NULL}, 2352, "tcp"},
{"pslserver",          {NULL}, 2352, "udp"},
{"pspserver",          {NULL}, 2353, "tcp"},
{"pspserver",          {NULL}, 2353, "udp"},
{"psprserver",         {NULL}, 2354, "tcp"},
{"psprserver",         {NULL}, 2354, "udp"},
{"psdbserver",         {NULL}, 2355, "tcp"},
{"psdbserver",         {NULL}, 2355, "udp"},
{"gxtelmd",            {NULL}, 2356, "tcp"},
{"gxtelmd",            {NULL}, 2356, "udp"},
{"unihub-server",      {NULL}, 2357, "tcp"},
{"unihub-server",      {NULL}, 2357, "udp"},
{"futrix",             {NULL}, 2358, "tcp"},
{"futrix",             {NULL}, 2358, "udp"},
{"flukeserver",        {NULL}, 2359, "tcp"},
{"flukeserver",        {NULL}, 2359, "udp"},
{"nexstorindltd",      {NULL}, 2360, "tcp"},
{"nexstorindltd",      {NULL}, 2360, "udp"},
{"tl1",                {NULL}, 2361, "tcp"},
{"tl1",                {NULL}, 2361, "udp"},
{"digiman",            {NULL}, 2362, "tcp"},
{"digiman",            {NULL}, 2362, "udp"},
{"mediacntrlnfsd",     {NULL}, 2363, "tcp"},
{"mediacntrlnfsd",     {NULL}, 2363, "udp"},
{"oi-2000",            {NULL}, 2364, "tcp"},
{"oi-2000",            {NULL}, 2364, "udp"},
{"dbref",              {NULL}, 2365, "tcp"},
{"dbref",              {NULL}, 2365, "udp"},
{"qip-login",          {NULL}, 2366, "tcp"},
{"qip-login",          {NULL}, 2366, "udp"},
{"service-ctrl",       {NULL}, 2367, "tcp"},
{"service-ctrl",       {NULL}, 2367, "udp"},
{"opentable",          {NULL}, 2368, "tcp"},
{"opentable",          {NULL}, 2368, "udp"},
{"l3-hbmon",           {NULL}, 2370, "tcp"},
{"l3-hbmon",           {NULL}, 2370, "udp"},
{"worldwire",          {NULL}, 2371, "tcp"},
{"worldwire",          {NULL}, 2371, "udp"},
{"lanmessenger",       {NULL}, 2372, "tcp"},
{"lanmessenger",       {NULL}, 2372, "udp"},
{"remographlm",        {NULL}, 2373, "tcp"},
{"hydra",              {NULL}, 2374, "tcp"},
{"compaq-https",       {NULL}, 2381, "tcp"},
{"compaq-https",       {NULL}, 2381, "udp"},
{"ms-olap3",           {NULL}, 2382, "tcp"},
{"ms-olap3",           {NULL}, 2382, "udp"},
{"ms-olap4",           {NULL}, 2383, "tcp"},
{"ms-olap4",           {NULL}, 2383, "udp"},
{"sd-request",         {NULL}, 2384, "tcp"},
{"sd-capacity",        {NULL}, 2384, "udp"},
{"sd-data",            {NULL}, 2385, "tcp"},
{"sd-data",            {NULL}, 2385, "udp"},
{"virtualtape",        {NULL}, 2386, "tcp"},
{"virtualtape",        {NULL}, 2386, "udp"},
{"vsamredirector",     {NULL}, 2387, "tcp"},
{"vsamredirector",     {NULL}, 2387, "udp"},
{"mynahautostart",     {NULL}, 2388, "tcp"},
{"mynahautostart",     {NULL}, 2388, "udp"},
{"ovsessionmgr",       {NULL}, 2389, "tcp"},
{"ovsessionmgr",       {NULL}, 2389, "udp"},
{"rsmtp",              {NULL}, 2390, "tcp"},
{"rsmtp",              {NULL}, 2390, "udp"},
{"3com-net-mgmt",      {NULL}, 2391, "tcp"},
{"3com-net-mgmt",      {NULL}, 2391, "udp"},
{"tacticalauth",       {NULL}, 2392, "tcp"},
{"tacticalauth",       {NULL}, 2392, "udp"},
{"ms-olap1",           {NULL}, 2393, "tcp"},
{"ms-olap1",           {NULL}, 2393, "udp"},
{"ms-olap2",           {NULL}, 2394, "tcp"},
{"ms-olap2",           {NULL}, 2394, "udp"},
{"lan900_remote",      {NULL}, 2395, "tcp"},
{"lan900_remote",      {NULL}, 2395, "udp"},
{"wusage",             {NULL}, 2396, "tcp"},
{"wusage",             {NULL}, 2396, "udp"},
{"ncl",                {NULL}, 2397, "tcp"},
{"ncl",                {NULL}, 2397, "udp"},
{"orbiter",            {NULL}, 2398, "tcp"},
{"orbiter",            {NULL}, 2398, "udp"},
{"fmpro-fdal",         {NULL}, 2399, "tcp"},
{"fmpro-fdal",         {NULL}, 2399, "udp"},
{"opequus-server",     {NULL}, 2400, "tcp"},
{"opequus-server",     {NULL}, 2400, "udp"},
{"cvspserver",         {NULL}, 2401, "tcp"},
{"cvspserver",         {NULL}, 2401, "udp"},
{"taskmaster2000",     {NULL}, 2402, "tcp"},
{"taskmaster2000",     {NULL}, 2402, "udp"},
{"taskmaster2000",     {NULL}, 2403, "tcp"},
{"taskmaster2000",     {NULL}, 2403, "udp"},
{"iec-104",            {NULL}, 2404, "tcp"},
{"iec-104",            {NULL}, 2404, "udp"},
{"trc-netpoll",        {NULL}, 2405, "tcp"},
{"trc-netpoll",        {NULL}, 2405, "udp"},
{"jediserver",         {NULL}, 2406, "tcp"},
{"jediserver",         {NULL}, 2406, "udp"},
{"orion",              {NULL}, 2407, "tcp"},
{"orion",              {NULL}, 2407, "udp"},
{"optimanet",          {NULL}, 2408, "tcp"},
{"optimanet",          {NULL}, 2408, "udp"},
{"sns-protocol",       {NULL}, 2409, "tcp"},
{"sns-protocol",       {NULL}, 2409, "udp"},
{"vrts-registry",      {NULL}, 2410, "tcp"},
{"vrts-registry",      {NULL}, 2410, "udp"},
{"netwave-ap-mgmt",    {NULL}, 2411, "tcp"},
{"netwave-ap-mgmt",    {NULL}, 2411, "udp"},
{"cdn",                {NULL}, 2412, "tcp"},
{"cdn",                {NULL}, 2412, "udp"},
{"orion-rmi-reg",      {NULL}, 2413, "tcp"},
{"orion-rmi-reg",      {NULL}, 2413, "udp"},
{"beeyond",            {NULL}, 2414, "tcp"},
{"beeyond",            {NULL}, 2414, "udp"},
{"codima-rtp",         {NULL}, 2415, "tcp"},
{"codima-rtp",         {NULL}, 2415, "udp"},
{"rmtserver",          {NULL}, 2416, "tcp"},
{"rmtserver",          {NULL}, 2416, "udp"},
{"composit-server",    {NULL}, 2417, "tcp"},
{"composit-server",    {NULL}, 2417, "udp"},
{"cas",                {NULL}, 2418, "tcp"},
{"cas",                {NULL}, 2418, "udp"},
{"attachmate-s2s",     {NULL}, 2419, "tcp"},
{"attachmate-s2s",     {NULL}, 2419, "udp"},
{"dslremote-mgmt",     {NULL}, 2420, "tcp"},
{"dslremote-mgmt",     {NULL}, 2420, "udp"},
{"g-talk",             {NULL}, 2421, "tcp"},
{"g-talk",             {NULL}, 2421, "udp"},
{"crmsbits",           {NULL}, 2422, "tcp"},
{"crmsbits",           {NULL}, 2422, "udp"},
{"rnrp",               {NULL}, 2423, "tcp"},
{"rnrp",               {NULL}, 2423, "udp"},
{"kofax-svr",          {NULL}, 2424, "tcp"},
{"kofax-svr",          {NULL}, 2424, "udp"},
{"fjitsuappmgr",       {NULL}, 2425, "tcp"},
{"fjitsuappmgr",       {NULL}, 2425, "udp"},
{"mgcp-gateway",       {NULL}, 2427, "tcp"},
{"mgcp-gateway",       {NULL}, 2427, "udp"},
{"ott",                {NULL}, 2428, "tcp"},
{"ott",                {NULL}, 2428, "udp"},
{"ft-role",            {NULL}, 2429, "tcp"},
{"ft-role",            {NULL}, 2429, "udp"},
{"venus",              {NULL}, 2430, "tcp"},
{"venus",              {NULL}, 2430, "udp"},
{"venus-se",           {NULL}, 2431, "tcp"},
{"venus-se",           {NULL}, 2431, "udp"},
{"codasrv",            {NULL}, 2432, "tcp"},
{"codasrv",            {NULL}, 2432, "udp"},
{"codasrv-se",         {NULL}, 2433, "tcp"},
{"codasrv-se",         {NULL}, 2433, "udp"},
{"pxc-epmap",          {NULL}, 2434, "tcp"},
{"pxc-epmap",          {NULL}, 2434, "udp"},
{"optilogic",          {NULL}, 2435, "tcp"},
{"optilogic",          {NULL}, 2435, "udp"},
{"topx",               {NULL}, 2436, "tcp"},
{"topx",               {NULL}, 2436, "udp"},
{"unicontrol",         {NULL}, 2437, "tcp"},
{"unicontrol",         {NULL}, 2437, "udp"},
{"msp",                {NULL}, 2438, "tcp"},
{"msp",                {NULL}, 2438, "udp"},
{"sybasedbsynch",      {NULL}, 2439, "tcp"},
{"sybasedbsynch",      {NULL}, 2439, "udp"},
{"spearway",           {NULL}, 2440, "tcp"},
{"spearway",           {NULL}, 2440, "udp"},
{"pvsw-inet",          {NULL}, 2441, "tcp"},
{"pvsw-inet",          {NULL}, 2441, "udp"},
{"netangel",           {NULL}, 2442, "tcp"},
{"netangel",           {NULL}, 2442, "udp"},
{"powerclientcsf",     {NULL}, 2443, "tcp"},
{"powerclientcsf",     {NULL}, 2443, "udp"},
{"btpp2sectrans",      {NULL}, 2444, "tcp"},
{"btpp2sectrans",      {NULL}, 2444, "udp"},
{"dtn1",               {NULL}, 2445, "tcp"},
{"dtn1",               {NULL}, 2445, "udp"},
{"bues_service",       {NULL}, 2446, "tcp"},
{"bues_service",       {NULL}, 2446, "udp"},
{"ovwdb",              {NULL}, 2447, "tcp"},
{"ovwdb",              {NULL}, 2447, "udp"},
{"hpppssvr",           {NULL}, 2448, "tcp"},
{"hpppssvr",           {NULL}, 2448, "udp"},
{"ratl",               {NULL}, 2449, "tcp"},
{"ratl",               {NULL}, 2449, "udp"},
{"netadmin",           {NULL}, 2450, "tcp"},
{"netadmin",           {NULL}, 2450, "udp"},
{"netchat",            {NULL}, 2451, "tcp"},
{"netchat",            {NULL}, 2451, "udp"},
{"snifferclient",      {NULL}, 2452, "tcp"},
{"snifferclient",      {NULL}, 2452, "udp"},
{"madge-ltd",          {NULL}, 2453, "tcp"},
{"madge-ltd",          {NULL}, 2453, "udp"},
{"indx-dds",           {NULL}, 2454, "tcp"},
{"indx-dds",           {NULL}, 2454, "udp"},
{"wago-io-system",     {NULL}, 2455, "tcp"},
{"wago-io-system",     {NULL}, 2455, "udp"},
{"altav-remmgt",       {NULL}, 2456, "tcp"},
{"altav-remmgt",       {NULL}, 2456, "udp"},
{"rapido-ip",          {NULL}, 2457, "tcp"},
{"rapido-ip",          {NULL}, 2457, "udp"},
{"griffin",            {NULL}, 2458, "tcp"},
{"griffin",            {NULL}, 2458, "udp"},
{"community",          {NULL}, 2459, "tcp"},
{"community",          {NULL}, 2459, "udp"},
{"ms-theater",         {NULL}, 2460, "tcp"},
{"ms-theater",         {NULL}, 2460, "udp"},
{"qadmifoper",         {NULL}, 2461, "tcp"},
{"qadmifoper",         {NULL}, 2461, "udp"},
{"qadmifevent",        {NULL}, 2462, "tcp"},
{"qadmifevent",        {NULL}, 2462, "udp"},
{"lsi-raid-mgmt",      {NULL}, 2463, "tcp"},
{"lsi-raid-mgmt",      {NULL}, 2463, "udp"},
{"direcpc-si",         {NULL}, 2464, "tcp"},
{"direcpc-si",         {NULL}, 2464, "udp"},
{"lbm",                {NULL}, 2465, "tcp"},
{"lbm",                {NULL}, 2465, "udp"},
{"lbf",                {NULL}, 2466, "tcp"},
{"lbf",                {NULL}, 2466, "udp"},
{"high-criteria",      {NULL}, 2467, "tcp"},
{"high-criteria",      {NULL}, 2467, "udp"},
{"qip-msgd",           {NULL}, 2468, "tcp"},
{"qip-msgd",           {NULL}, 2468, "udp"},
{"mti-tcs-comm",       {NULL}, 2469, "tcp"},
{"mti-tcs-comm",       {NULL}, 2469, "udp"},
{"taskman-port",       {NULL}, 2470, "tcp"},
{"taskman-port",       {NULL}, 2470, "udp"},
{"seaodbc",            {NULL}, 2471, "tcp"},
{"seaodbc",            {NULL}, 2471, "udp"},
{"c3",                 {NULL}, 2472, "tcp"},
{"c3",                 {NULL}, 2472, "udp"},
{"aker-cdp",           {NULL}, 2473, "tcp"},
{"aker-cdp",           {NULL}, 2473, "udp"},
{"vitalanalysis",      {NULL}, 2474, "tcp"},
{"vitalanalysis",      {NULL}, 2474, "udp"},
{"ace-server",         {NULL}, 2475, "tcp"},
{"ace-server",         {NULL}, 2475, "udp"},
{"ace-svr-prop",       {NULL}, 2476, "tcp"},
{"ace-svr-prop",       {NULL}, 2476, "udp"},
{"ssm-cvs",            {NULL}, 2477, "tcp"},
{"ssm-cvs",            {NULL}, 2477, "udp"},
{"ssm-cssps",          {NULL}, 2478, "tcp"},
{"ssm-cssps",          {NULL}, 2478, "udp"},
{"ssm-els",            {NULL}, 2479, "tcp"},
{"ssm-els",            {NULL}, 2479, "udp"},
{"powerexchange",      {NULL}, 2480, "tcp"},
{"powerexchange",      {NULL}, 2480, "udp"},
{"giop",               {NULL}, 2481, "tcp"},
{"giop",               {NULL}, 2481, "udp"},
{"giop-ssl",           {NULL}, 2482, "tcp"},
{"giop-ssl",           {NULL}, 2482, "udp"},
{"ttc",                {NULL}, 2483, "tcp"},
{"ttc",                {NULL}, 2483, "udp"},
{"ttc-ssl",            {NULL}, 2484, "tcp"},
{"ttc-ssl",            {NULL}, 2484, "udp"},
{"netobjects1",        {NULL}, 2485, "tcp"},
{"netobjects1",        {NULL}, 2485, "udp"},
{"netobjects2",        {NULL}, 2486, "tcp"},
{"netobjects2",        {NULL}, 2486, "udp"},
{"pns",                {NULL}, 2487, "tcp"},
{"pns",                {NULL}, 2487, "udp"},
{"moy-corp",           {NULL}, 2488, "tcp"},
{"moy-corp",           {NULL}, 2488, "udp"},
{"tsilb",              {NULL}, 2489, "tcp"},
{"tsilb",              {NULL}, 2489, "udp"},
{"qip-qdhcp",          {NULL}, 2490, "tcp"},
{"qip-qdhcp",          {NULL}, 2490, "udp"},
{"conclave-cpp",       {NULL}, 2491, "tcp"},
{"conclave-cpp",       {NULL}, 2491, "udp"},
{"groove",             {NULL}, 2492, "tcp"},
{"groove",             {NULL}, 2492, "udp"},
{"talarian-mqs",       {NULL}, 2493, "tcp"},
{"talarian-mqs",       {NULL}, 2493, "udp"},
{"bmc-ar",             {NULL}, 2494, "tcp"},
{"bmc-ar",             {NULL}, 2494, "udp"},
{"fast-rem-serv",      {NULL}, 2495, "tcp"},
{"fast-rem-serv",      {NULL}, 2495, "udp"},
{"dirgis",             {NULL}, 2496, "tcp"},
{"dirgis",             {NULL}, 2496, "udp"},
{"quaddb",             {NULL}, 2497, "tcp"},
{"quaddb",             {NULL}, 2497, "udp"},
{"odn-castraq",        {NULL}, 2498, "tcp"},
{"odn-castraq",        {NULL}, 2498, "udp"},
{"unicontrol",         {NULL}, 2499, "tcp"},
{"unicontrol",         {NULL}, 2499, "udp"},
{"rtsserv",            {NULL}, 2500, "tcp"},
{"rtsserv",            {NULL}, 2500, "udp"},
{"rtsclient",          {NULL}, 2501, "tcp"},
{"rtsclient",          {NULL}, 2501, "udp"},
{"kentrox-prot",       {NULL}, 2502, "tcp"},
{"kentrox-prot",       {NULL}, 2502, "udp"},
{"nms-dpnss",          {NULL}, 2503, "tcp"},
{"nms-dpnss",          {NULL}, 2503, "udp"},
{"wlbs",               {NULL}, 2504, "tcp"},
{"wlbs",               {NULL}, 2504, "udp"},
{"ppcontrol",          {NULL}, 2505, "tcp"},
{"ppcontrol",          {NULL}, 2505, "udp"},
{"jbroker",            {NULL}, 2506, "tcp"},
{"jbroker",            {NULL}, 2506, "udp"},
{"spock",              {NULL}, 2507, "tcp"},
{"spock",              {NULL}, 2507, "udp"},
{"jdatastore",         {NULL}, 2508, "tcp"},
{"jdatastore",         {NULL}, 2508, "udp"},
{"fjmpss",             {NULL}, 2509, "tcp"},
{"fjmpss",             {NULL}, 2509, "udp"},
{"fjappmgrbulk",       {NULL}, 2510, "tcp"},
{"fjappmgrbulk",       {NULL}, 2510, "udp"},
{"metastorm",          {NULL}, 2511, "tcp"},
{"metastorm",          {NULL}, 2511, "udp"},
{"citrixima",          {NULL}, 2512, "tcp"},
{"citrixima",          {NULL}, 2512, "udp"},
{"citrixadmin",        {NULL}, 2513, "tcp"},
{"citrixadmin",        {NULL}, 2513, "udp"},
{"facsys-ntp",         {NULL}, 2514, "tcp"},
{"facsys-ntp",         {NULL}, 2514, "udp"},
{"facsys-router",      {NULL}, 2515, "tcp"},
{"facsys-router",      {NULL}, 2515, "udp"},
{"maincontrol",        {NULL}, 2516, "tcp"},
{"maincontrol",        {NULL}, 2516, "udp"},
{"call-sig-trans",     {NULL}, 2517, "tcp"},
{"call-sig-trans",     {NULL}, 2517, "udp"},
{"willy",              {NULL}, 2518, "tcp"},
{"willy",              {NULL}, 2518, "udp"},
{"globmsgsvc",         {NULL}, 2519, "tcp"},
{"globmsgsvc",         {NULL}, 2519, "udp"},
{"pvsw",               {NULL}, 2520, "tcp"},
{"pvsw",               {NULL}, 2520, "udp"},
{"adaptecmgr",         {NULL}, 2521, "tcp"},
{"adaptecmgr",         {NULL}, 2521, "udp"},
{"windb",              {NULL}, 2522, "tcp"},
{"windb",              {NULL}, 2522, "udp"},
{"qke-llc-v3",         {NULL}, 2523, "tcp"},
{"qke-llc-v3",         {NULL}, 2523, "udp"},
{"optiwave-lm",        {NULL}, 2524, "tcp"},
{"optiwave-lm",        {NULL}, 2524, "udp"},
{"ms-v-worlds",        {NULL}, 2525, "tcp"},
{"ms-v-worlds",        {NULL}, 2525, "udp"},
{"ema-sent-lm",        {NULL}, 2526, "tcp"},
{"ema-sent-lm",        {NULL}, 2526, "udp"},
{"iqserver",           {NULL}, 2527, "tcp"},
{"iqserver",           {NULL}, 2527, "udp"},
{"ncr_ccl",            {NULL}, 2528, "tcp"},
{"ncr_ccl",            {NULL}, 2528, "udp"},
{"utsftp",             {NULL}, 2529, "tcp"},
{"utsftp",             {NULL}, 2529, "udp"},
{"vrcommerce",         {NULL}, 2530, "tcp"},
{"vrcommerce",         {NULL}, 2530, "udp"},
{"ito-e-gui",          {NULL}, 2531, "tcp"},
{"ito-e-gui",          {NULL}, 2531, "udp"},
{"ovtopmd",            {NULL}, 2532, "tcp"},
{"ovtopmd",            {NULL}, 2532, "udp"},
{"snifferserver",      {NULL}, 2533, "tcp"},
{"snifferserver",      {NULL}, 2533, "udp"},
{"combox-web-acc",     {NULL}, 2534, "tcp"},
{"combox-web-acc",     {NULL}, 2534, "udp"},
{"madcap",             {NULL}, 2535, "tcp"},
{"madcap",             {NULL}, 2535, "udp"},
{"btpp2audctr1",       {NULL}, 2536, "tcp"},
{"btpp2audctr1",       {NULL}, 2536, "udp"},
{"upgrade",            {NULL}, 2537, "tcp"},
{"upgrade",            {NULL}, 2537, "udp"},
{"vnwk-prapi",         {NULL}, 2538, "tcp"},
{"vnwk-prapi",         {NULL}, 2538, "udp"},
{"vsiadmin",           {NULL}, 2539, "tcp"},
{"vsiadmin",           {NULL}, 2539, "udp"},
{"lonworks",           {NULL}, 2540, "tcp"},
{"lonworks",           {NULL}, 2540, "udp"},
{"lonworks2",          {NULL}, 2541, "tcp"},
{"lonworks2",          {NULL}, 2541, "udp"},
{"udrawgraph",         {NULL}, 2542, "tcp"},
{"udrawgraph",         {NULL}, 2542, "udp"},
{"reftek",             {NULL}, 2543, "tcp"},
{"reftek",             {NULL}, 2543, "udp"},
{"novell-zen",         {NULL}, 2544, "tcp"},
{"novell-zen",         {NULL}, 2544, "udp"},
{"sis-emt",            {NULL}, 2545, "tcp"},
{"sis-emt",            {NULL}, 2545, "udp"},
{"vytalvaultbrtp",     {NULL}, 2546, "tcp"},
{"vytalvaultbrtp",     {NULL}, 2546, "udp"},
{"vytalvaultvsmp",     {NULL}, 2547, "tcp"},
{"vytalvaultvsmp",     {NULL}, 2547, "udp"},
{"vytalvaultpipe",     {NULL}, 2548, "tcp"},
{"vytalvaultpipe",     {NULL}, 2548, "udp"},
{"ipass",              {NULL}, 2549, "tcp"},
{"ipass",              {NULL}, 2549, "udp"},
{"ads",                {NULL}, 2550, "tcp"},
{"ads",                {NULL}, 2550, "udp"},
{"isg-uda-server",     {NULL}, 2551, "tcp"},
{"isg-uda-server",     {NULL}, 2551, "udp"},
{"call-logging",       {NULL}, 2552, "tcp"},
{"call-logging",       {NULL}, 2552, "udp"},
{"efidiningport",      {NULL}, 2553, "tcp"},
{"efidiningport",      {NULL}, 2553, "udp"},
{"vcnet-link-v10",     {NULL}, 2554, "tcp"},
{"vcnet-link-v10",     {NULL}, 2554, "udp"},
{"compaq-wcp",         {NULL}, 2555, "tcp"},
{"compaq-wcp",         {NULL}, 2555, "udp"},
{"nicetec-nmsvc",      {NULL}, 2556, "tcp"},
{"nicetec-nmsvc",      {NULL}, 2556, "udp"},
{"nicetec-mgmt",       {NULL}, 2557, "tcp"},
{"nicetec-mgmt",       {NULL}, 2557, "udp"},
{"pclemultimedia",     {NULL}, 2558, "tcp"},
{"pclemultimedia",     {NULL}, 2558, "udp"},
{"lstp",               {NULL}, 2559, "tcp"},
{"lstp",               {NULL}, 2559, "udp"},
{"labrat",             {NULL}, 2560, "tcp"},
{"labrat",             {NULL}, 2560, "udp"},
{"mosaixcc",           {NULL}, 2561, "tcp"},
{"mosaixcc",           {NULL}, 2561, "udp"},
{"delibo",             {NULL}, 2562, "tcp"},
{"delibo",             {NULL}, 2562, "udp"},
{"cti-redwood",        {NULL}, 2563, "tcp"},
{"cti-redwood",        {NULL}, 2563, "udp"},
{"hp-3000-telnet",     {NULL}, 2564, "tcp"},
{"coord-svr",          {NULL}, 2565, "tcp"},
{"coord-svr",          {NULL}, 2565, "udp"},
{"pcs-pcw",            {NULL}, 2566, "tcp"},
{"pcs-pcw",            {NULL}, 2566, "udp"},
{"clp",                {NULL}, 2567, "tcp"},
{"clp",                {NULL}, 2567, "udp"},
{"spamtrap",           {NULL}, 2568, "tcp"},
{"spamtrap",           {NULL}, 2568, "udp"},
{"sonuscallsig",       {NULL}, 2569, "tcp"},
{"sonuscallsig",       {NULL}, 2569, "udp"},
{"hs-port",            {NULL}, 2570, "tcp"},
{"hs-port",            {NULL}, 2570, "udp"},
{"cecsvc",             {NULL}, 2571, "tcp"},
{"cecsvc",             {NULL}, 2571, "udp"},
{"ibp",                {NULL}, 2572, "tcp"},
{"ibp",                {NULL}, 2572, "udp"},
{"trustestablish",     {NULL}, 2573, "tcp"},
{"trustestablish",     {NULL}, 2573, "udp"},
{"blockade-bpsp",      {NULL}, 2574, "tcp"},
{"blockade-bpsp",      {NULL}, 2574, "udp"},
{"hl7",                {NULL}, 2575, "tcp"},
{"hl7",                {NULL}, 2575, "udp"},
{"tclprodebugger",     {NULL}, 2576, "tcp"},
{"tclprodebugger",     {NULL}, 2576, "udp"},
{"scipticslsrvr",      {NULL}, 2577, "tcp"},
{"scipticslsrvr",      {NULL}, 2577, "udp"},
{"rvs-isdn-dcp",       {NULL}, 2578, "tcp"},
{"rvs-isdn-dcp",       {NULL}, 2578, "udp"},
{"mpfoncl",            {NULL}, 2579, "tcp"},
{"mpfoncl",            {NULL}, 2579, "udp"},
{"tributary",          {NULL}, 2580, "tcp"},
{"tributary",          {NULL}, 2580, "udp"},
{"argis-te",           {NULL}, 2581, "tcp"},
{"argis-te",           {NULL}, 2581, "udp"},
{"argis-ds",           {NULL}, 2582, "tcp"},
{"argis-ds",           {NULL}, 2582, "udp"},
{"mon",                {NULL}, 2583, "tcp"},
{"mon",                {NULL}, 2583, "udp"},
{"cyaserv",            {NULL}, 2584, "tcp"},
{"cyaserv",            {NULL}, 2584, "udp"},
{"netx-server",        {NULL}, 2585, "tcp"},
{"netx-server",        {NULL}, 2585, "udp"},
{"netx-agent",         {NULL}, 2586, "tcp"},
{"netx-agent",         {NULL}, 2586, "udp"},
{"masc",               {NULL}, 2587, "tcp"},
{"masc",               {NULL}, 2587, "udp"},
{"privilege",          {NULL}, 2588, "tcp"},
{"privilege",          {NULL}, 2588, "udp"},
{"quartus-tcl",        {NULL}, 2589, "tcp"},
{"quartus-tcl",        {NULL}, 2589, "udp"},
{"idotdist",           {NULL}, 2590, "tcp"},
{"idotdist",           {NULL}, 2590, "udp"},
{"maytagshuffle",      {NULL}, 2591, "tcp"},
{"maytagshuffle",      {NULL}, 2591, "udp"},
{"netrek",             {NULL}, 2592, "tcp"},
{"netrek",             {NULL}, 2592, "udp"},
{"mns-mail",           {NULL}, 2593, "tcp"},
{"mns-mail",           {NULL}, 2593, "udp"},
{"dts",                {NULL}, 2594, "tcp"},
{"dts",                {NULL}, 2594, "udp"},
{"worldfusion1",       {NULL}, 2595, "tcp"},
{"worldfusion1",       {NULL}, 2595, "udp"},
{"worldfusion2",       {NULL}, 2596, "tcp"},
{"worldfusion2",       {NULL}, 2596, "udp"},
{"homesteadglory",     {NULL}, 2597, "tcp"},
{"homesteadglory",     {NULL}, 2597, "udp"},
{"citriximaclient",    {NULL}, 2598, "tcp"},
{"citriximaclient",    {NULL}, 2598, "udp"},
{"snapd",              {NULL}, 2599, "tcp"},
{"snapd",              {NULL}, 2599, "udp"},
{"hpstgmgr",           {NULL}, 2600, "tcp"},
{"hpstgmgr",           {NULL}, 2600, "udp"},
{"discp-client",       {NULL}, 2601, "tcp"},
{"discp-client",       {NULL}, 2601, "udp"},
{"discp-server",       {NULL}, 2602, "tcp"},
{"discp-server",       {NULL}, 2602, "udp"},
{"servicemeter",       {NULL}, 2603, "tcp"},
{"servicemeter",       {NULL}, 2603, "udp"},
{"nsc-ccs",            {NULL}, 2604, "tcp"},
{"nsc-ccs",            {NULL}, 2604, "udp"},
{"nsc-posa",           {NULL}, 2605, "tcp"},
{"nsc-posa",           {NULL}, 2605, "udp"},
{"netmon",             {NULL}, 2606, "tcp"},
{"netmon",             {NULL}, 2606, "udp"},
{"connection",         {NULL}, 2607, "tcp"},
{"connection",         {NULL}, 2607, "udp"},
{"wag-service",        {NULL}, 2608, "tcp"},
{"wag-service",        {NULL}, 2608, "udp"},
{"system-monitor",     {NULL}, 2609, "tcp"},
{"system-monitor",     {NULL}, 2609, "udp"},
{"versa-tek",          {NULL}, 2610, "tcp"},
{"versa-tek",          {NULL}, 2610, "udp"},
{"lionhead",           {NULL}, 2611, "tcp"},
{"lionhead",           {NULL}, 2611, "udp"},
{"qpasa-agent",        {NULL}, 2612, "tcp"},
{"qpasa-agent",        {NULL}, 2612, "udp"},
{"smntubootstrap",     {NULL}, 2613, "tcp"},
{"smntubootstrap",     {NULL}, 2613, "udp"},
{"neveroffline",       {NULL}, 2614, "tcp"},
{"neveroffline",       {NULL}, 2614, "udp"},
{"firepower",          {NULL}, 2615, "tcp"},
{"firepower",          {NULL}, 2615, "udp"},
{"appswitch-emp",      {NULL}, 2616, "tcp"},
{"appswitch-emp",      {NULL}, 2616, "udp"},
{"cmadmin",            {NULL}, 2617, "tcp"},
{"cmadmin",            {NULL}, 2617, "udp"},
{"priority-e-com",     {NULL}, 2618, "tcp"},
{"priority-e-com",     {NULL}, 2618, "udp"},
{"bruce",              {NULL}, 2619, "tcp"},
{"bruce",              {NULL}, 2619, "udp"},
{"lpsrecommender",     {NULL}, 2620, "tcp"},
{"lpsrecommender",     {NULL}, 2620, "udp"},
{"miles-apart",        {NULL}, 2621, "tcp"},
{"miles-apart",        {NULL}, 2621, "udp"},
{"metricadbc",         {NULL}, 2622, "tcp"},
{"metricadbc",         {NULL}, 2622, "udp"},
{"lmdp",               {NULL}, 2623, "tcp"},
{"lmdp",               {NULL}, 2623, "udp"},
{"aria",               {NULL}, 2624, "tcp"},
{"aria",               {NULL}, 2624, "udp"},
{"blwnkl-port",        {NULL}, 2625, "tcp"},
{"blwnkl-port",        {NULL}, 2625, "udp"},
{"gbjd816",            {NULL}, 2626, "tcp"},
{"gbjd816",            {NULL}, 2626, "udp"},
{"moshebeeri",         {NULL}, 2627, "tcp"},
{"moshebeeri",         {NULL}, 2627, "udp"},
{"dict",               {NULL}, 2628, "tcp"},
{"dict",               {NULL}, 2628, "udp"},
{"sitaraserver",       {NULL}, 2629, "tcp"},
{"sitaraserver",       {NULL}, 2629, "udp"},
{"sitaramgmt",         {NULL}, 2630, "tcp"},
{"sitaramgmt",         {NULL}, 2630, "udp"},
{"sitaradir",          {NULL}, 2631, "tcp"},
{"sitaradir",          {NULL}, 2631, "udp"},
{"irdg-post",          {NULL}, 2632, "tcp"},
{"irdg-post",          {NULL}, 2632, "udp"},
{"interintelli",       {NULL}, 2633, "tcp"},
{"interintelli",       {NULL}, 2633, "udp"},
{"pk-electronics",     {NULL}, 2634, "tcp"},
{"pk-electronics",     {NULL}, 2634, "udp"},
{"backburner",         {NULL}, 2635, "tcp"},
{"backburner",         {NULL}, 2635, "udp"},
{"solve",              {NULL}, 2636, "tcp"},
{"solve",              {NULL}, 2636, "udp"},
{"imdocsvc",           {NULL}, 2637, "tcp"},
{"imdocsvc",           {NULL}, 2637, "udp"},
{"sybaseanywhere",     {NULL}, 2638, "tcp"},
{"sybaseanywhere",     {NULL}, 2638, "udp"},
{"aminet",             {NULL}, 2639, "tcp"},
{"aminet",             {NULL}, 2639, "udp"},
{"sai_sentlm",         {NULL}, 2640, "tcp"},
{"sai_sentlm",         {NULL}, 2640, "udp"},
{"hdl-srv",            {NULL}, 2641, "tcp"},
{"hdl-srv",            {NULL}, 2641, "udp"},
{"tragic",             {NULL}, 2642, "tcp"},
{"tragic",             {NULL}, 2642, "udp"},
{"gte-samp",           {NULL}, 2643, "tcp"},
{"gte-samp",           {NULL}, 2643, "udp"},
{"travsoft-ipx-t",     {NULL}, 2644, "tcp"},
{"travsoft-ipx-t",     {NULL}, 2644, "udp"},
{"novell-ipx-cmd",     {NULL}, 2645, "tcp"},
{"novell-ipx-cmd",     {NULL}, 2645, "udp"},
{"and-lm",             {NULL}, 2646, "tcp"},
{"and-lm",             {NULL}, 2646, "udp"},
{"syncserver",         {NULL}, 2647, "tcp"},
{"syncserver",         {NULL}, 2647, "udp"},
{"upsnotifyprot",      {NULL}, 2648, "tcp"},
{"upsnotifyprot",      {NULL}, 2648, "udp"},
{"vpsipport",          {NULL}, 2649, "tcp"},
{"vpsipport",          {NULL}, 2649, "udp"},
{"eristwoguns",        {NULL}, 2650, "tcp"},
{"eristwoguns",        {NULL}, 2650, "udp"},
{"ebinsite",           {NULL}, 2651, "tcp"},
{"ebinsite",           {NULL}, 2651, "udp"},
{"interpathpanel",     {NULL}, 2652, "tcp"},
{"interpathpanel",     {NULL}, 2652, "udp"},
{"sonus",              {NULL}, 2653, "tcp"},
{"sonus",              {NULL}, 2653, "udp"},
{"corel_vncadmin",     {NULL}, 2654, "tcp"},
{"corel_vncadmin",     {NULL}, 2654, "udp"},
{"unglue",             {NULL}, 2655, "tcp"},
{"unglue",             {NULL}, 2655, "udp"},
{"kana",               {NULL}, 2656, "tcp"},
{"kana",               {NULL}, 2656, "udp"},
{"sns-dispatcher",     {NULL}, 2657, "tcp"},
{"sns-dispatcher",     {NULL}, 2657, "udp"},
{"sns-admin",          {NULL}, 2658, "tcp"},
{"sns-admin",          {NULL}, 2658, "udp"},
{"sns-query",          {NULL}, 2659, "tcp"},
{"sns-query",          {NULL}, 2659, "udp"},
{"gcmonitor",          {NULL}, 2660, "tcp"},
{"gcmonitor",          {NULL}, 2660, "udp"},
{"olhost",             {NULL}, 2661, "tcp"},
{"olhost",             {NULL}, 2661, "udp"},
{"bintec-capi",        {NULL}, 2662, "tcp"},
{"bintec-capi",        {NULL}, 2662, "udp"},
{"bintec-tapi",        {NULL}, 2663, "tcp"},
{"bintec-tapi",        {NULL}, 2663, "udp"},
{"patrol-mq-gm",       {NULL}, 2664, "tcp"},
{"patrol-mq-gm",       {NULL}, 2664, "udp"},
{"patrol-mq-nm",       {NULL}, 2665, "tcp"},
{"patrol-mq-nm",       {NULL}, 2665, "udp"},
{"extensis",           {NULL}, 2666, "tcp"},
{"extensis",           {NULL}, 2666, "udp"},
{"alarm-clock-s",      {NULL}, 2667, "tcp"},
{"alarm-clock-s",      {NULL}, 2667, "udp"},
{"alarm-clock-c",      {NULL}, 2668, "tcp"},
{"alarm-clock-c",      {NULL}, 2668, "udp"},
{"toad",               {NULL}, 2669, "tcp"},
{"toad",               {NULL}, 2669, "udp"},
{"tve-announce",       {NULL}, 2670, "tcp"},
{"tve-announce",       {NULL}, 2670, "udp"},
{"newlixreg",          {NULL}, 2671, "tcp"},
{"newlixreg",          {NULL}, 2671, "udp"},
{"nhserver",           {NULL}, 2672, "tcp"},
{"nhserver",           {NULL}, 2672, "udp"},
{"firstcall42",        {NULL}, 2673, "tcp"},
{"firstcall42",        {NULL}, 2673, "udp"},
{"ewnn",               {NULL}, 2674, "tcp"},
{"ewnn",               {NULL}, 2674, "udp"},
{"ttc-etap",           {NULL}, 2675, "tcp"},
{"ttc-etap",           {NULL}, 2675, "udp"},
{"simslink",           {NULL}, 2676, "tcp"},
{"simslink",           {NULL}, 2676, "udp"},
{"gadgetgate1way",     {NULL}, 2677, "tcp"},
{"gadgetgate1way",     {NULL}, 2677, "udp"},
{"gadgetgate2way",     {NULL}, 2678, "tcp"},
{"gadgetgate2way",     {NULL}, 2678, "udp"},
{"syncserverssl",      {NULL}, 2679, "tcp"},
{"syncserverssl",      {NULL}, 2679, "udp"},
{"pxc-sapxom",         {NULL}, 2680, "tcp"},
{"pxc-sapxom",         {NULL}, 2680, "udp"},
{"mpnjsomb",           {NULL}, 2681, "tcp"},
{"mpnjsomb",           {NULL}, 2681, "udp"},
{"ncdloadbalance",     {NULL}, 2683, "tcp"},
{"ncdloadbalance",     {NULL}, 2683, "udp"},
{"mpnjsosv",           {NULL}, 2684, "tcp"},
{"mpnjsosv",           {NULL}, 2684, "udp"},
{"mpnjsocl",           {NULL}, 2685, "tcp"},
{"mpnjsocl",           {NULL}, 2685, "udp"},
{"mpnjsomg",           {NULL}, 2686, "tcp"},
{"mpnjsomg",           {NULL}, 2686, "udp"},
{"pq-lic-mgmt",        {NULL}, 2687, "tcp"},
{"pq-lic-mgmt",        {NULL}, 2687, "udp"},
{"md-cg-http",         {NULL}, 2688, "tcp"},
{"md-cg-http",         {NULL}, 2688, "udp"},
{"fastlynx",           {NULL}, 2689, "tcp"},
{"fastlynx",           {NULL}, 2689, "udp"},
{"hp-nnm-data",        {NULL}, 2690, "tcp"},
{"hp-nnm-data",        {NULL}, 2690, "udp"},
{"itinternet",         {NULL}, 2691, "tcp"},
{"itinternet",         {NULL}, 2691, "udp"},
{"admins-lms",         {NULL}, 2692, "tcp"},
{"admins-lms",         {NULL}, 2692, "udp"},
{"pwrsevent",          {NULL}, 2694, "tcp"},
{"pwrsevent",          {NULL}, 2694, "udp"},
{"vspread",            {NULL}, 2695, "tcp"},
{"vspread",            {NULL}, 2695, "udp"},
{"unifyadmin",         {NULL}, 2696, "tcp"},
{"unifyadmin",         {NULL}, 2696, "udp"},
{"oce-snmp-trap",      {NULL}, 2697, "tcp"},
{"oce-snmp-trap",      {NULL}, 2697, "udp"},
{"mck-ivpip",          {NULL}, 2698, "tcp"},
{"mck-ivpip",          {NULL}, 2698, "udp"},
{"csoft-plusclnt",     {NULL}, 2699, "tcp"},
{"csoft-plusclnt",     {NULL}, 2699, "udp"},
{"tqdata",             {NULL}, 2700, "tcp"},
{"tqdata",             {NULL}, 2700, "udp"},
{"sms-rcinfo",         {NULL}, 2701, "tcp"},
{"sms-rcinfo",         {NULL}, 2701, "udp"},
{"sms-xfer",           {NULL}, 2702, "tcp"},
{"sms-xfer",           {NULL}, 2702, "udp"},
{"sms-chat",           {NULL}, 2703, "tcp"},
{"sms-chat",           {NULL}, 2703, "udp"},
{"sms-remctrl",        {NULL}, 2704, "tcp"},
{"sms-remctrl",        {NULL}, 2704, "udp"},
{"sds-admin",          {NULL}, 2705, "tcp"},
{"sds-admin",          {NULL}, 2705, "udp"},
{"ncdmirroring",       {NULL}, 2706, "tcp"},
{"ncdmirroring",       {NULL}, 2706, "udp"},
{"emcsymapiport",      {NULL}, 2707, "tcp"},
{"emcsymapiport",      {NULL}, 2707, "udp"},
{"banyan-net",         {NULL}, 2708, "tcp"},
{"banyan-net",         {NULL}, 2708, "udp"},
{"supermon",           {NULL}, 2709, "tcp"},
{"supermon",           {NULL}, 2709, "udp"},
{"sso-service",        {NULL}, 2710, "tcp"},
{"sso-service",        {NULL}, 2710, "udp"},
{"sso-control",        {NULL}, 2711, "tcp"},
{"sso-control",        {NULL}, 2711, "udp"},
{"aocp",               {NULL}, 2712, "tcp"},
{"aocp",               {NULL}, 2712, "udp"},
{"raventbs",           {NULL}, 2713, "tcp"},
{"raventbs",           {NULL}, 2713, "udp"},
{"raventdm",           {NULL}, 2714, "tcp"},
{"raventdm",           {NULL}, 2714, "udp"},
{"hpstgmgr2",          {NULL}, 2715, "tcp"},
{"hpstgmgr2",          {NULL}, 2715, "udp"},
{"inova-ip-disco",     {NULL}, 2716, "tcp"},
{"inova-ip-disco",     {NULL}, 2716, "udp"},
{"pn-requester",       {NULL}, 2717, "tcp"},
{"pn-requester",       {NULL}, 2717, "udp"},
{"pn-requester2",      {NULL}, 2718, "tcp"},
{"pn-requester2",      {NULL}, 2718, "udp"},
{"scan-change",        {NULL}, 2719, "tcp"},
{"scan-change",        {NULL}, 2719, "udp"},
{"wkars",              {NULL}, 2720, "tcp"},
{"wkars",              {NULL}, 2720, "udp"},
{"smart-diagnose",     {NULL}, 2721, "tcp"},
{"smart-diagnose",     {NULL}, 2721, "udp"},
{"proactivesrvr",      {NULL}, 2722, "tcp"},
{"proactivesrvr",      {NULL}, 2722, "udp"},
{"watchdog-nt",        {NULL}, 2723, "tcp"},
{"watchdog-nt",        {NULL}, 2723, "udp"},
{"qotps",              {NULL}, 2724, "tcp"},
{"qotps",              {NULL}, 2724, "udp"},
{"msolap-ptp2",        {NULL}, 2725, "tcp"},
{"msolap-ptp2",        {NULL}, 2725, "udp"},
{"tams",               {NULL}, 2726, "tcp"},
{"tams",               {NULL}, 2726, "udp"},
{"mgcp-callagent",     {NULL}, 2727, "tcp"},
{"mgcp-callagent",     {NULL}, 2727, "udp"},
{"sqdr",               {NULL}, 2728, "tcp"},
{"sqdr",               {NULL}, 2728, "udp"},
{"tcim-control",       {NULL}, 2729, "tcp"},
{"tcim-control",       {NULL}, 2729, "udp"},
{"nec-raidplus",       {NULL}, 2730, "tcp"},
{"nec-raidplus",       {NULL}, 2730, "udp"},
{"fyre-messanger",     {NULL}, 2731, "tcp"},
{"fyre-messanger",     {NULL}, 2731, "udp"},
{"g5m",                {NULL}, 2732, "tcp"},
{"g5m",                {NULL}, 2732, "udp"},
{"signet-ctf",         {NULL}, 2733, "tcp"},
{"signet-ctf",         {NULL}, 2733, "udp"},
{"ccs-software",       {NULL}, 2734, "tcp"},
{"ccs-software",       {NULL}, 2734, "udp"},
{"netiq-mc",           {NULL}, 2735, "tcp"},
{"netiq-mc",           {NULL}, 2735, "udp"},
{"radwiz-nms-srv",     {NULL}, 2736, "tcp"},
{"radwiz-nms-srv",     {NULL}, 2736, "udp"},
{"srp-feedback",       {NULL}, 2737, "tcp"},
{"srp-feedback",       {NULL}, 2737, "udp"},
{"ndl-tcp-ois-gw",     {NULL}, 2738, "tcp"},
{"ndl-tcp-ois-gw",     {NULL}, 2738, "udp"},
{"tn-timing",          {NULL}, 2739, "tcp"},
{"tn-timing",          {NULL}, 2739, "udp"},
{"alarm",              {NULL}, 2740, "tcp"},
{"alarm",              {NULL}, 2740, "udp"},
{"tsb",                {NULL}, 2741, "tcp"},
{"tsb",                {NULL}, 2741, "udp"},
{"tsb2",               {NULL}, 2742, "tcp"},
{"tsb2",               {NULL}, 2742, "udp"},
{"murx",               {NULL}, 2743, "tcp"},
{"murx",               {NULL}, 2743, "udp"},
{"honyaku",            {NULL}, 2744, "tcp"},
{"honyaku",            {NULL}, 2744, "udp"},
{"urbisnet",           {NULL}, 2745, "tcp"},
{"urbisnet",           {NULL}, 2745, "udp"},
{"cpudpencap",         {NULL}, 2746, "tcp"},
{"cpudpencap",         {NULL}, 2746, "udp"},
{"fjippol-swrly",      {NULL}, 2747, "tcp"},
{"fjippol-swrly",      {NULL}, 2747, "udp"},
{"fjippol-polsvr",     {NULL}, 2748, "tcp"},
{"fjippol-polsvr",     {NULL}, 2748, "udp"},
{"fjippol-cnsl",       {NULL}, 2749, "tcp"},
{"fjippol-cnsl",       {NULL}, 2749, "udp"},
{"fjippol-port1",      {NULL}, 2750, "tcp"},
{"fjippol-port1",      {NULL}, 2750, "udp"},
{"fjippol-port2",      {NULL}, 2751, "tcp"},
{"fjippol-port2",      {NULL}, 2751, "udp"},
{"rsisysaccess",       {NULL}, 2752, "tcp"},
{"rsisysaccess",       {NULL}, 2752, "udp"},
{"de-spot",            {NULL}, 2753, "tcp"},
{"de-spot",            {NULL}, 2753, "udp"},
{"apollo-cc",          {NULL}, 2754, "tcp"},
{"apollo-cc",          {NULL}, 2754, "udp"},
{"expresspay",         {NULL}, 2755, "tcp"},
{"expresspay",         {NULL}, 2755, "udp"},
{"simplement-tie",     {NULL}, 2756, "tcp"},
{"simplement-tie",     {NULL}, 2756, "udp"},
{"cnrp",               {NULL}, 2757, "tcp"},
{"cnrp",               {NULL}, 2757, "udp"},
{"apollo-status",      {NULL}, 2758, "tcp"},
{"apollo-status",      {NULL}, 2758, "udp"},
{"apollo-gms",         {NULL}, 2759, "tcp"},
{"apollo-gms",         {NULL}, 2759, "udp"},
{"sabams",             {NULL}, 2760, "tcp"},
{"sabams",             {NULL}, 2760, "udp"},
{"dicom-iscl",         {NULL}, 2761, "tcp"},
{"dicom-iscl",         {NULL}, 2761, "udp"},
{"dicom-tls",          {NULL}, 2762, "tcp"},
{"dicom-tls",          {NULL}, 2762, "udp"},
{"desktop-dna",        {NULL}, 2763, "tcp"},
{"desktop-dna",        {NULL}, 2763, "udp"},
{"data-insurance",     {NULL}, 2764, "tcp"},
{"data-insurance",     {NULL}, 2764, "udp"},
{"qip-audup",          {NULL}, 2765, "tcp"},
{"qip-audup",          {NULL}, 2765, "udp"},
{"compaq-scp",         {NULL}, 2766, "tcp"},
{"compaq-scp",         {NULL}, 2766, "udp"},
{"uadtc",              {NULL}, 2767, "tcp"},
{"uadtc",              {NULL}, 2767, "udp"},
{"uacs",               {NULL}, 2768, "tcp"},
{"uacs",               {NULL}, 2768, "udp"},
{"exce",               {NULL}, 2769, "tcp"},
{"exce",               {NULL}, 2769, "udp"},
{"veronica",           {NULL}, 2770, "tcp"},
{"veronica",           {NULL}, 2770, "udp"},
{"vergencecm",         {NULL}, 2771, "tcp"},
{"vergencecm",         {NULL}, 2771, "udp"},
{"auris",              {NULL}, 2772, "tcp"},
{"auris",              {NULL}, 2772, "udp"},
{"rbakcup1",           {NULL}, 2773, "tcp"},
{"rbakcup1",           {NULL}, 2773, "udp"},
{"rbakcup2",           {NULL}, 2774, "tcp"},
{"rbakcup2",           {NULL}, 2774, "udp"},
{"smpp",               {NULL}, 2775, "tcp"},
{"smpp",               {NULL}, 2775, "udp"},
{"ridgeway1",          {NULL}, 2776, "tcp"},
{"ridgeway1",          {NULL}, 2776, "udp"},
{"ridgeway2",          {NULL}, 2777, "tcp"},
{"ridgeway2",          {NULL}, 2777, "udp"},
{"gwen-sonya",         {NULL}, 2778, "tcp"},
{"gwen-sonya",         {NULL}, 2778, "udp"},
{"lbc-sync",           {NULL}, 2779, "tcp"},
{"lbc-sync",           {NULL}, 2779, "udp"},
{"lbc-control",        {NULL}, 2780, "tcp"},
{"lbc-control",        {NULL}, 2780, "udp"},
{"whosells",           {NULL}, 2781, "tcp"},
{"whosells",           {NULL}, 2781, "udp"},
{"everydayrc",         {NULL}, 2782, "tcp"},
{"everydayrc",         {NULL}, 2782, "udp"},
{"aises",              {NULL}, 2783, "tcp"},
{"aises",              {NULL}, 2783, "udp"},
{"www-dev",            {NULL}, 2784, "tcp"},
{"www-dev",            {NULL}, 2784, "udp"},
{"aic-np",             {NULL}, 2785, "tcp"},
{"aic-np",             {NULL}, 2785, "udp"},
{"aic-oncrpc",         {NULL}, 2786, "tcp"},
{"aic-oncrpc",         {NULL}, 2786, "udp"},
{"piccolo",            {NULL}, 2787, "tcp"},
{"piccolo",            {NULL}, 2787, "udp"},
{"fryeserv",           {NULL}, 2788, "tcp"},
{"fryeserv",           {NULL}, 2788, "udp"},
{"media-agent",        {NULL}, 2789, "tcp"},
{"media-agent",        {NULL}, 2789, "udp"},
{"plgproxy",           {NULL}, 2790, "tcp"},
{"plgproxy",           {NULL}, 2790, "udp"},
{"mtport-regist",      {NULL}, 2791, "tcp"},
{"mtport-regist",      {NULL}, 2791, "udp"},
{"f5-globalsite",      {NULL}, 2792, "tcp"},
{"f5-globalsite",      {NULL}, 2792, "udp"},
{"initlsmsad",         {NULL}, 2793, "tcp"},
{"initlsmsad",         {NULL}, 2793, "udp"},
{"livestats",          {NULL}, 2795, "tcp"},
{"livestats",          {NULL}, 2795, "udp"},
{"ac-tech",            {NULL}, 2796, "tcp"},
{"ac-tech",            {NULL}, 2796, "udp"},
{"esp-encap",          {NULL}, 2797, "tcp"},
{"esp-encap",          {NULL}, 2797, "udp"},
{"tmesis-upshot",      {NULL}, 2798, "tcp"},
{"tmesis-upshot",      {NULL}, 2798, "udp"},
{"icon-discover",      {NULL}, 2799, "tcp"},
{"icon-discover",      {NULL}, 2799, "udp"},
{"acc-raid",           {NULL}, 2800, "tcp"},
{"acc-raid",           {NULL}, 2800, "udp"},
{"igcp",               {NULL}, 2801, "tcp"},
{"igcp",               {NULL}, 2801, "udp"},
{"veritas-tcp1",       {NULL}, 2802, "tcp"},
{"veritas-udp1",       {NULL}, 2802, "udp"},
{"btprjctrl",          {NULL}, 2803, "tcp"},
{"btprjctrl",          {NULL}, 2803, "udp"},
{"dvr-esm",            {NULL}, 2804, "tcp"},
{"dvr-esm",            {NULL}, 2804, "udp"},
{"wta-wsp-s",          {NULL}, 2805, "tcp"},
{"wta-wsp-s",          {NULL}, 2805, "udp"},
{"cspuni",             {NULL}, 2806, "tcp"},
{"cspuni",             {NULL}, 2806, "udp"},
{"cspmulti",           {NULL}, 2807, "tcp"},
{"cspmulti",           {NULL}, 2807, "udp"},
{"j-lan-p",            {NULL}, 2808, "tcp"},
{"j-lan-p",            {NULL}, 2808, "udp"},
{"corbaloc",           {NULL}, 2809, "tcp"},
{"corbaloc",           {NULL}, 2809, "udp"},
{"netsteward",         {NULL}, 2810, "tcp"},
{"netsteward",         {NULL}, 2810, "udp"},
{"gsiftp",             {NULL}, 2811, "tcp"},
{"gsiftp",             {NULL}, 2811, "udp"},
{"atmtcp",             {NULL}, 2812, "tcp"},
{"atmtcp",             {NULL}, 2812, "udp"},
{"llm-pass",           {NULL}, 2813, "tcp"},
{"llm-pass",           {NULL}, 2813, "udp"},
{"llm-csv",            {NULL}, 2814, "tcp"},
{"llm-csv",            {NULL}, 2814, "udp"},
{"lbc-measure",        {NULL}, 2815, "tcp"},
{"lbc-measure",        {NULL}, 2815, "udp"},
{"lbc-watchdog",       {NULL}, 2816, "tcp"},
{"lbc-watchdog",       {NULL}, 2816, "udp"},
{"nmsigport",          {NULL}, 2817, "tcp"},
{"nmsigport",          {NULL}, 2817, "udp"},
{"rmlnk",              {NULL}, 2818, "tcp"},
{"rmlnk",              {NULL}, 2818, "udp"},
{"fc-faultnotify",     {NULL}, 2819, "tcp"},
{"fc-faultnotify",     {NULL}, 2819, "udp"},
{"univision",          {NULL}, 2820, "tcp"},
{"univision",          {NULL}, 2820, "udp"},
{"vrts-at-port",       {NULL}, 2821, "tcp"},
{"vrts-at-port",       {NULL}, 2821, "udp"},
{"ka0wuc",             {NULL}, 2822, "tcp"},
{"ka0wuc",             {NULL}, 2822, "udp"},
{"cqg-netlan",         {NULL}, 2823, "tcp"},
{"cqg-netlan",         {NULL}, 2823, "udp"},
{"cqg-netlan-1",       {NULL}, 2824, "tcp"},
{"cqg-netlan-1",       {NULL}, 2824, "udp"},
{"slc-systemlog",      {NULL}, 2826, "tcp"},
{"slc-systemlog",      {NULL}, 2826, "udp"},
{"slc-ctrlrloops",     {NULL}, 2827, "tcp"},
{"slc-ctrlrloops",     {NULL}, 2827, "udp"},
{"itm-lm",             {NULL}, 2828, "tcp"},
{"itm-lm",             {NULL}, 2828, "udp"},
{"silkp1",             {NULL}, 2829, "tcp"},
{"silkp1",             {NULL}, 2829, "udp"},
{"silkp2",             {NULL}, 2830, "tcp"},
{"silkp2",             {NULL}, 2830, "udp"},
{"silkp3",             {NULL}, 2831, "tcp"},
{"silkp3",             {NULL}, 2831, "udp"},
{"silkp4",             {NULL}, 2832, "tcp"},
{"silkp4",             {NULL}, 2832, "udp"},
{"glishd",             {NULL}, 2833, "tcp"},
{"glishd",             {NULL}, 2833, "udp"},
{"evtp",               {NULL}, 2834, "tcp"},
{"evtp",               {NULL}, 2834, "udp"},
{"evtp-data",          {NULL}, 2835, "tcp"},
{"evtp-data",          {NULL}, 2835, "udp"},
{"catalyst",           {NULL}, 2836, "tcp"},
{"catalyst",           {NULL}, 2836, "udp"},
{"repliweb",           {NULL}, 2837, "tcp"},
{"repliweb",           {NULL}, 2837, "udp"},
{"starbot",            {NULL}, 2838, "tcp"},
{"starbot",            {NULL}, 2838, "udp"},
{"nmsigport",          {NULL}, 2839, "tcp"},
{"nmsigport",          {NULL}, 2839, "udp"},
{"l3-exprt",           {NULL}, 2840, "tcp"},
{"l3-exprt",           {NULL}, 2840, "udp"},
{"l3-ranger",          {NULL}, 2841, "tcp"},
{"l3-ranger",          {NULL}, 2841, "udp"},
{"l3-hawk",            {NULL}, 2842, "tcp"},
{"l3-hawk",            {NULL}, 2842, "udp"},
{"pdnet",              {NULL}, 2843, "tcp"},
{"pdnet",              {NULL}, 2843, "udp"},
{"bpcp-poll",          {NULL}, 2844, "tcp"},
{"bpcp-poll",          {NULL}, 2844, "udp"},
{"bpcp-trap",          {NULL}, 2845, "tcp"},
{"bpcp-trap",          {NULL}, 2845, "udp"},
{"aimpp-hello",        {NULL}, 2846, "tcp"},
{"aimpp-hello",        {NULL}, 2846, "udp"},
{"aimpp-port-req",     {NULL}, 2847, "tcp"},
{"aimpp-port-req",     {NULL}, 2847, "udp"},
{"amt-blc-port",       {NULL}, 2848, "tcp"},
{"amt-blc-port",       {NULL}, 2848, "udp"},
{"fxp",                {NULL}, 2849, "tcp"},
{"fxp",                {NULL}, 2849, "udp"},
{"metaconsole",        {NULL}, 2850, "tcp"},
{"metaconsole",        {NULL}, 2850, "udp"},
{"webemshttp",         {NULL}, 2851, "tcp"},
{"webemshttp",         {NULL}, 2851, "udp"},
{"bears-01",           {NULL}, 2852, "tcp"},
{"bears-01",           {NULL}, 2852, "udp"},
{"ispipes",            {NULL}, 2853, "tcp"},
{"ispipes",            {NULL}, 2853, "udp"},
{"infomover",          {NULL}, 2854, "tcp"},
{"infomover",          {NULL}, 2854, "udp"},
{"msrp",               {NULL}, 2855, "tcp"},
{"msrp",               {NULL}, 2855, "udp"},
{"cesdinv",            {NULL}, 2856, "tcp"},
{"cesdinv",            {NULL}, 2856, "udp"},
{"simctlp",            {NULL}, 2857, "tcp"},
{"simctlp",            {NULL}, 2857, "udp"},
{"ecnp",               {NULL}, 2858, "tcp"},
{"ecnp",               {NULL}, 2858, "udp"},
{"activememory",       {NULL}, 2859, "tcp"},
{"activememory",       {NULL}, 2859, "udp"},
{"dialpad-voice1",     {NULL}, 2860, "tcp"},
{"dialpad-voice1",     {NULL}, 2860, "udp"},
{"dialpad-voice2",     {NULL}, 2861, "tcp"},
{"dialpad-voice2",     {NULL}, 2861, "udp"},
{"ttg-protocol",       {NULL}, 2862, "tcp"},
{"ttg-protocol",       {NULL}, 2862, "udp"},
{"sonardata",          {NULL}, 2863, "tcp"},
{"sonardata",          {NULL}, 2863, "udp"},
{"astromed-main",      {NULL}, 2864, "tcp"},
{"astromed-main",      {NULL}, 2864, "udp"},
{"pit-vpn",            {NULL}, 2865, "tcp"},
{"pit-vpn",            {NULL}, 2865, "udp"},
{"iwlistener",         {NULL}, 2866, "tcp"},
{"iwlistener",         {NULL}, 2866, "udp"},
{"esps-portal",        {NULL}, 2867, "tcp"},
{"esps-portal",        {NULL}, 2867, "udp"},
{"npep-messaging",     {NULL}, 2868, "tcp"},
{"npep-messaging",     {NULL}, 2868, "udp"},
{"icslap",             {NULL}, 2869, "tcp"},
{"icslap",             {NULL}, 2869, "udp"},
{"daishi",             {NULL}, 2870, "tcp"},
{"daishi",             {NULL}, 2870, "udp"},
{"msi-selectplay",     {NULL}, 2871, "tcp"},
{"msi-selectplay",     {NULL}, 2871, "udp"},
{"radix",              {NULL}, 2872, "tcp"},
{"radix",              {NULL}, 2872, "udp"},
{"dxmessagebase1",     {NULL}, 2874, "tcp"},
{"dxmessagebase1",     {NULL}, 2874, "udp"},
{"dxmessagebase2",     {NULL}, 2875, "tcp"},
{"dxmessagebase2",     {NULL}, 2875, "udp"},
{"sps-tunnel",         {NULL}, 2876, "tcp"},
{"sps-tunnel",         {NULL}, 2876, "udp"},
{"bluelance",          {NULL}, 2877, "tcp"},
{"bluelance",          {NULL}, 2877, "udp"},
{"aap",                {NULL}, 2878, "tcp"},
{"aap",                {NULL}, 2878, "udp"},
{"ucentric-ds",        {NULL}, 2879, "tcp"},
{"ucentric-ds",        {NULL}, 2879, "udp"},
{"synapse",            {NULL}, 2880, "tcp"},
{"synapse",            {NULL}, 2880, "udp"},
{"ndsp",               {NULL}, 2881, "tcp"},
{"ndsp",               {NULL}, 2881, "udp"},
{"ndtp",               {NULL}, 2882, "tcp"},
{"ndtp",               {NULL}, 2882, "udp"},
{"ndnp",               {NULL}, 2883, "tcp"},
{"ndnp",               {NULL}, 2883, "udp"},
{"flashmsg",           {NULL}, 2884, "tcp"},
{"flashmsg",           {NULL}, 2884, "udp"},
{"topflow",            {NULL}, 2885, "tcp"},
{"topflow",            {NULL}, 2885, "udp"},
{"responselogic",      {NULL}, 2886, "tcp"},
{"responselogic",      {NULL}, 2886, "udp"},
{"aironetddp",         {NULL}, 2887, "tcp"},
{"aironetddp",         {NULL}, 2887, "udp"},
{"spcsdlobby",         {NULL}, 2888, "tcp"},
{"spcsdlobby",         {NULL}, 2888, "udp"},
{"rsom",               {NULL}, 2889, "tcp"},
{"rsom",               {NULL}, 2889, "udp"},
{"cspclmulti",         {NULL}, 2890, "tcp"},
{"cspclmulti",         {NULL}, 2890, "udp"},
{"cinegrfx-elmd",      {NULL}, 2891, "tcp"},
{"cinegrfx-elmd",      {NULL}, 2891, "udp"},
{"snifferdata",        {NULL}, 2892, "tcp"},
{"snifferdata",        {NULL}, 2892, "udp"},
{"vseconnector",       {NULL}, 2893, "tcp"},
{"vseconnector",       {NULL}, 2893, "udp"},
{"abacus-remote",      {NULL}, 2894, "tcp"},
{"abacus-remote",      {NULL}, 2894, "udp"},
{"natuslink",          {NULL}, 2895, "tcp"},
{"natuslink",          {NULL}, 2895, "udp"},
{"ecovisiong6-1",      {NULL}, 2896, "tcp"},
{"ecovisiong6-1",      {NULL}, 2896, "udp"},
{"citrix-rtmp",        {NULL}, 2897, "tcp"},
{"citrix-rtmp",        {NULL}, 2897, "udp"},
{"appliance-cfg",      {NULL}, 2898, "tcp"},
{"appliance-cfg",      {NULL}, 2898, "udp"},
{"powergemplus",       {NULL}, 2899, "tcp"},
{"powergemplus",       {NULL}, 2899, "udp"},
{"quicksuite",         {NULL}, 2900, "tcp"},
{"quicksuite",         {NULL}, 2900, "udp"},
{"allstorcns",         {NULL}, 2901, "tcp"},
{"allstorcns",         {NULL}, 2901, "udp"},
{"netaspi",            {NULL}, 2902, "tcp"},
{"netaspi",            {NULL}, 2902, "udp"},
{"suitcase",           {NULL}, 2903, "tcp"},
{"suitcase",           {NULL}, 2903, "udp"},
{"m2ua",               {NULL}, 2904, "tcp"},
{"m2ua",               {NULL}, 2904, "udp"},
{"m2ua",               {NULL}, 2904, "sctp"},
{"m3ua",               {NULL}, 2905, "tcp"},
{"m3ua",               {NULL}, 2905, "sctp"},
{"caller9",            {NULL}, 2906, "tcp"},
{"caller9",            {NULL}, 2906, "udp"},
{"webmethods-b2b",     {NULL}, 2907, "tcp"},
{"webmethods-b2b",     {NULL}, 2907, "udp"},
{"mao",                {NULL}, 2908, "tcp"},
{"mao",                {NULL}, 2908, "udp"},
{"funk-dialout",       {NULL}, 2909, "tcp"},
{"funk-dialout",       {NULL}, 2909, "udp"},
{"tdaccess",           {NULL}, 2910, "tcp"},
{"tdaccess",           {NULL}, 2910, "udp"},
{"blockade",           {NULL}, 2911, "tcp"},
{"blockade",           {NULL}, 2911, "udp"},
{"epicon",             {NULL}, 2912, "tcp"},
{"epicon",             {NULL}, 2912, "udp"},
{"boosterware",        {NULL}, 2913, "tcp"},
{"boosterware",        {NULL}, 2913, "udp"},
{"gamelobby",          {NULL}, 2914, "tcp"},
{"gamelobby",          {NULL}, 2914, "udp"},
{"tksocket",           {NULL}, 2915, "tcp"},
{"tksocket",           {NULL}, 2915, "udp"},
{"elvin_server",       {NULL}, 2916, "tcp"},
{"elvin_server",       {NULL}, 2916, "udp"},
{"elvin_client",       {NULL}, 2917, "tcp"},
{"elvin_client",       {NULL}, 2917, "udp"},
{"kastenchasepad",     {NULL}, 2918, "tcp"},
{"kastenchasepad",     {NULL}, 2918, "udp"},
{"roboer",             {NULL}, 2919, "tcp"},
{"roboer",             {NULL}, 2919, "udp"},
{"roboeda",            {NULL}, 2920, "tcp"},
{"roboeda",            {NULL}, 2920, "udp"},
{"cesdcdman",          {NULL}, 2921, "tcp"},
{"cesdcdman",          {NULL}, 2921, "udp"},
{"cesdcdtrn",          {NULL}, 2922, "tcp"},
{"cesdcdtrn",          {NULL}, 2922, "udp"},
{"wta-wsp-wtp-s",      {NULL}, 2923, "tcp"},
{"wta-wsp-wtp-s",      {NULL}, 2923, "udp"},
{"precise-vip",        {NULL}, 2924, "tcp"},
{"precise-vip",        {NULL}, 2924, "udp"},
{"mobile-file-dl",     {NULL}, 2926, "tcp"},
{"mobile-file-dl",     {NULL}, 2926, "udp"},
{"unimobilectrl",      {NULL}, 2927, "tcp"},
{"unimobilectrl",      {NULL}, 2927, "udp"},
{"redstone-cpss",      {NULL}, 2928, "tcp"},
{"redstone-cpss",      {NULL}, 2928, "udp"},
{"amx-webadmin",       {NULL}, 2929, "tcp"},
{"amx-webadmin",       {NULL}, 2929, "udp"},
{"amx-weblinx",        {NULL}, 2930, "tcp"},
{"amx-weblinx",        {NULL}, 2930, "udp"},
{"circle-x",           {NULL}, 2931, "tcp"},
{"circle-x",           {NULL}, 2931, "udp"},
{"incp",               {NULL}, 2932, "tcp"},
{"incp",               {NULL}, 2932, "udp"},
{"4-tieropmgw",        {NULL}, 2933, "tcp"},
{"4-tieropmgw",        {NULL}, 2933, "udp"},
{"4-tieropmcli",       {NULL}, 2934, "tcp"},
{"4-tieropmcli",       {NULL}, 2934, "udp"},
{"qtp",                {NULL}, 2935, "tcp"},
{"qtp",                {NULL}, 2935, "udp"},
{"otpatch",            {NULL}, 2936, "tcp"},
{"otpatch",            {NULL}, 2936, "udp"},
{"pnaconsult-lm",      {NULL}, 2937, "tcp"},
{"pnaconsult-lm",      {NULL}, 2937, "udp"},
{"sm-pas-1",           {NULL}, 2938, "tcp"},
{"sm-pas-1",           {NULL}, 2938, "udp"},
{"sm-pas-2",           {NULL}, 2939, "tcp"},
{"sm-pas-2",           {NULL}, 2939, "udp"},
{"sm-pas-3",           {NULL}, 2940, "tcp"},
{"sm-pas-3",           {NULL}, 2940, "udp"},
{"sm-pas-4",           {NULL}, 2941, "tcp"},
{"sm-pas-4",           {NULL}, 2941, "udp"},
{"sm-pas-5",           {NULL}, 2942, "tcp"},
{"sm-pas-5",           {NULL}, 2942, "udp"},
{"ttnrepository",      {NULL}, 2943, "tcp"},
{"ttnrepository",      {NULL}, 2943, "udp"},
{"megaco-h248",        {NULL}, 2944, "tcp"},
{"megaco-h248",        {NULL}, 2944, "udp"},
{"megaco-h248",        {NULL}, 2944, "sctp"},
{"h248-binary",        {NULL}, 2945, "tcp"},
{"h248-binary",        {NULL}, 2945, "udp"},
{"h248-binary",        {NULL}, 2945, "sctp"},
{"fjsvmpor",           {NULL}, 2946, "tcp"},
{"fjsvmpor",           {NULL}, 2946, "udp"},
{"gpsd",               {NULL}, 2947, "tcp"},
{"gpsd",               {NULL}, 2947, "udp"},
{"wap-push",           {NULL}, 2948, "tcp"},
{"wap-push",           {NULL}, 2948, "udp"},
{"wap-pushsecure",     {NULL}, 2949, "tcp"},
{"wap-pushsecure",     {NULL}, 2949, "udp"},
{"esip",               {NULL}, 2950, "tcp"},
{"esip",               {NULL}, 2950, "udp"},
{"ottp",               {NULL}, 2951, "tcp"},
{"ottp",               {NULL}, 2951, "udp"},
{"mpfwsas",            {NULL}, 2952, "tcp"},
{"mpfwsas",            {NULL}, 2952, "udp"},
{"ovalarmsrv",         {NULL}, 2953, "tcp"},
{"ovalarmsrv",         {NULL}, 2953, "udp"},
{"ovalarmsrv-cmd",     {NULL}, 2954, "tcp"},
{"ovalarmsrv-cmd",     {NULL}, 2954, "udp"},
{"csnotify",           {NULL}, 2955, "tcp"},
{"csnotify",           {NULL}, 2955, "udp"},
{"ovrimosdbman",       {NULL}, 2956, "tcp"},
{"ovrimosdbman",       {NULL}, 2956, "udp"},
{"jmact5",             {NULL}, 2957, "tcp"},
{"jmact5",             {NULL}, 2957, "udp"},
{"jmact6",             {NULL}, 2958, "tcp"},
{"jmact6",             {NULL}, 2958, "udp"},
{"rmopagt",            {NULL}, 2959, "tcp"},
{"rmopagt",            {NULL}, 2959, "udp"},
{"dfoxserver",         {NULL}, 2960, "tcp"},
{"dfoxserver",         {NULL}, 2960, "udp"},
{"boldsoft-lm",        {NULL}, 2961, "tcp"},
{"boldsoft-lm",        {NULL}, 2961, "udp"},
{"iph-policy-cli",     {NULL}, 2962, "tcp"},
{"iph-policy-cli",     {NULL}, 2962, "udp"},
{"iph-policy-adm",     {NULL}, 2963, "tcp"},
{"iph-policy-adm",     {NULL}, 2963, "udp"},
{"bullant-srap",       {NULL}, 2964, "tcp"},
{"bullant-srap",       {NULL}, 2964, "udp"},
{"bullant-rap",        {NULL}, 2965, "tcp"},
{"bullant-rap",        {NULL}, 2965, "udp"},
{"idp-infotrieve",     {NULL}, 2966, "tcp"},
{"idp-infotrieve",     {NULL}, 2966, "udp"},
{"ssc-agent",          {NULL}, 2967, "tcp"},
{"ssc-agent",          {NULL}, 2967, "udp"},
{"enpp",               {NULL}, 2968, "tcp"},
{"enpp",               {NULL}, 2968, "udp"},
{"essp",               {NULL}, 2969, "tcp"},
{"essp",               {NULL}, 2969, "udp"},
{"index-net",          {NULL}, 2970, "tcp"},
{"index-net",          {NULL}, 2970, "udp"},
{"netclip",            {NULL}, 2971, "tcp"},
{"netclip",            {NULL}, 2971, "udp"},
{"pmsm-webrctl",       {NULL}, 2972, "tcp"},
{"pmsm-webrctl",       {NULL}, 2972, "udp"},
{"svnetworks",         {NULL}, 2973, "tcp"},
{"svnetworks",         {NULL}, 2973, "udp"},
{"signal",             {NULL}, 2974, "tcp"},
{"signal",             {NULL}, 2974, "udp"},
{"fjmpcm",             {NULL}, 2975, "tcp"},
{"fjmpcm",             {NULL}, 2975, "udp"},
{"cns-srv-port",       {NULL}, 2976, "tcp"},
{"cns-srv-port",       {NULL}, 2976, "udp"},
{"ttc-etap-ns",        {NULL}, 2977, "tcp"},
{"ttc-etap-ns",        {NULL}, 2977, "udp"},
{"ttc-etap-ds",        {NULL}, 2978, "tcp"},
{"ttc-etap-ds",        {NULL}, 2978, "udp"},
{"h263-video",         {NULL}, 2979, "tcp"},
{"h263-video",         {NULL}, 2979, "udp"},
{"wimd",               {NULL}, 2980, "tcp"},
{"wimd",               {NULL}, 2980, "udp"},
{"mylxamport",         {NULL}, 2981, "tcp"},
{"mylxamport",         {NULL}, 2981, "udp"},
{"iwb-whiteboard",     {NULL}, 2982, "tcp"},
{"iwb-whiteboard",     {NULL}, 2982, "udp"},
{"netplan",            {NULL}, 2983, "tcp"},
{"netplan",            {NULL}, 2983, "udp"},
{"hpidsadmin",         {NULL}, 2984, "tcp"},
{"hpidsadmin",         {NULL}, 2984, "udp"},
{"hpidsagent",         {NULL}, 2985, "tcp"},
{"hpidsagent",         {NULL}, 2985, "udp"},
{"stonefalls",         {NULL}, 2986, "tcp"},
{"stonefalls",         {NULL}, 2986, "udp"},
{"identify",           {NULL}, 2987, "tcp"},
{"identify",           {NULL}, 2987, "udp"},
{"hippad",             {NULL}, 2988, "tcp"},
{"hippad",             {NULL}, 2988, "udp"},
{"zarkov",             {NULL}, 2989, "tcp"},
{"zarkov",             {NULL}, 2989, "udp"},
{"boscap",             {NULL}, 2990, "tcp"},
{"boscap",             {NULL}, 2990, "udp"},
{"wkstn-mon",          {NULL}, 2991, "tcp"},
{"wkstn-mon",          {NULL}, 2991, "udp"},
{"avenyo",             {NULL}, 2992, "tcp"},
{"avenyo",             {NULL}, 2992, "udp"},
{"veritas-vis1",       {NULL}, 2993, "tcp"},
{"veritas-vis1",       {NULL}, 2993, "udp"},
{"veritas-vis2",       {NULL}, 2994, "tcp"},
{"veritas-vis2",       {NULL}, 2994, "udp"},
{"idrs",               {NULL}, 2995, "tcp"},
{"idrs",               {NULL}, 2995, "udp"},
{"vsixml",             {NULL}, 2996, "tcp"},
{"vsixml",             {NULL}, 2996, "udp"},
{"rebol",              {NULL}, 2997, "tcp"},
{"rebol",              {NULL}, 2997, "udp"},
{"realsecure",         {NULL}, 2998, "tcp"},
{"realsecure",         {NULL}, 2998, "udp"},
{"remoteware-un",      {NULL}, 2999, "tcp"},
{"remoteware-un",      {NULL}, 2999, "udp"},
{"hbci",               {NULL}, 3000, "tcp"},
{"hbci",               {NULL}, 3000, "udp"},
{"remoteware-cl",      {NULL}, 3000, "tcp"},
{"remoteware-cl",      {NULL}, 3000, "udp"},
{"exlm-agent",         {NULL}, 3002, "tcp"},
{"exlm-agent",         {NULL}, 3002, "udp"},
{"remoteware-srv",     {NULL}, 3002, "tcp"},
{"remoteware-srv",     {NULL}, 3002, "udp"},
{"cgms",               {NULL}, 3003, "tcp"},
{"cgms",               {NULL}, 3003, "udp"},
{"csoftragent",        {NULL}, 3004, "tcp"},
{"csoftragent",        {NULL}, 3004, "udp"},
{"geniuslm",           {NULL}, 3005, "tcp"},
{"geniuslm",           {NULL}, 3005, "udp"},
{"ii-admin",           {NULL}, 3006, "tcp"},
{"ii-admin",           {NULL}, 3006, "udp"},
{"lotusmtap",          {NULL}, 3007, "tcp"},
{"lotusmtap",          {NULL}, 3007, "udp"},
{"midnight-tech",      {NULL}, 3008, "tcp"},
{"midnight-tech",      {NULL}, 3008, "udp"},
{"pxc-ntfy",           {NULL}, 3009, "tcp"},
{"pxc-ntfy",           {NULL}, 3009, "udp"},
{"gw",                 {NULL}, 3010, "tcp"},
{"ping-pong",          {NULL}, 3010, "udp"},
{"trusted-web",        {NULL}, 3011, "tcp"},
{"trusted-web",        {NULL}, 3011, "udp"},
{"twsdss",             {NULL}, 3012, "tcp"},
{"twsdss",             {NULL}, 3012, "udp"},
{"gilatskysurfer",     {NULL}, 3013, "tcp"},
{"gilatskysurfer",     {NULL}, 3013, "udp"},
{"broker_service",     {NULL}, 3014, "tcp"},
{"broker_service",     {NULL}, 3014, "udp"},
{"nati-dstp",          {NULL}, 3015, "tcp"},
{"nati-dstp",          {NULL}, 3015, "udp"},
{"notify_srvr",        {NULL}, 3016, "tcp"},
{"notify_srvr",        {NULL}, 3016, "udp"},
{"event_listener",     {NULL}, 3017, "tcp"},
{"event_listener",     {NULL}, 3017, "udp"},
{"srvc_registry",      {NULL}, 3018, "tcp"},
{"srvc_registry",      {NULL}, 3018, "udp"},
{"resource_mgr",       {NULL}, 3019, "tcp"},
{"resource_mgr",       {NULL}, 3019, "udp"},
{"cifs",               {NULL}, 3020, "tcp"},
{"cifs",               {NULL}, 3020, "udp"},
{"agriserver",         {NULL}, 3021, "tcp"},
{"agriserver",         {NULL}, 3021, "udp"},
{"csregagent",         {NULL}, 3022, "tcp"},
{"csregagent",         {NULL}, 3022, "udp"},
{"magicnotes",         {NULL}, 3023, "tcp"},
{"magicnotes",         {NULL}, 3023, "udp"},
{"nds_sso",            {NULL}, 3024, "tcp"},
{"nds_sso",            {NULL}, 3024, "udp"},
{"arepa-raft",         {NULL}, 3025, "tcp"},
{"arepa-raft",         {NULL}, 3025, "udp"},
{"agri-gateway",       {NULL}, 3026, "tcp"},
{"agri-gateway",       {NULL}, 3026, "udp"},
{"LiebDevMgmt_C",      {NULL}, 3027, "tcp"},
{"LiebDevMgmt_C",      {NULL}, 3027, "udp"},
{"LiebDevMgmt_DM",     {NULL}, 3028, "tcp"},
{"LiebDevMgmt_DM",     {NULL}, 3028, "udp"},
{"LiebDevMgmt_A",      {NULL}, 3029, "tcp"},
{"LiebDevMgmt_A",      {NULL}, 3029, "udp"},
{"arepa-cas",          {NULL}, 3030, "tcp"},
{"arepa-cas",          {NULL}, 3030, "udp"},
{"eppc",               {NULL}, 3031, "tcp"},
{"eppc",               {NULL}, 3031, "udp"},
{"redwood-chat",       {NULL}, 3032, "tcp"},
{"redwood-chat",       {NULL}, 3032, "udp"},
{"pdb",                {NULL}, 3033, "tcp"},
{"pdb",                {NULL}, 3033, "udp"},
{"osmosis-aeea",       {NULL}, 3034, "tcp"},
{"osmosis-aeea",       {NULL}, 3034, "udp"},
{"fjsv-gssagt",        {NULL}, 3035, "tcp"},
{"fjsv-gssagt",        {NULL}, 3035, "udp"},
{"hagel-dump",         {NULL}, 3036, "tcp"},
{"hagel-dump",         {NULL}, 3036, "udp"},
{"hp-san-mgmt",        {NULL}, 3037, "tcp"},
{"hp-san-mgmt",        {NULL}, 3037, "udp"},
{"santak-ups",         {NULL}, 3038, "tcp"},
{"santak-ups",         {NULL}, 3038, "udp"},
{"cogitate",           {NULL}, 3039, "tcp"},
{"cogitate",           {NULL}, 3039, "udp"},
{"tomato-springs",     {NULL}, 3040, "tcp"},
{"tomato-springs",     {NULL}, 3040, "udp"},
{"di-traceware",       {NULL}, 3041, "tcp"},
{"di-traceware",       {NULL}, 3041, "udp"},
{"journee",            {NULL}, 3042, "tcp"},
{"journee",            {NULL}, 3042, "udp"},
{"brp",                {NULL}, 3043, "tcp"},
{"brp",                {NULL}, 3043, "udp"},
{"epp",                {NULL}, 3044, "tcp"},
{"epp",                {NULL}, 3044, "udp"},
{"responsenet",        {NULL}, 3045, "tcp"},
{"responsenet",        {NULL}, 3045, "udp"},
{"di-ase",             {NULL}, 3046, "tcp"},
{"di-ase",             {NULL}, 3046, "udp"},
{"hlserver",           {NULL}, 3047, "tcp"},
{"hlserver",           {NULL}, 3047, "udp"},
{"pctrader",           {NULL}, 3048, "tcp"},
{"pctrader",           {NULL}, 3048, "udp"},
{"nsws",               {NULL}, 3049, "tcp"},
{"nsws",               {NULL}, 3049, "udp"},
{"gds_db",             {NULL}, 3050, "tcp"},
{"gds_db",             {NULL}, 3050, "udp"},
{"galaxy-server",      {NULL}, 3051, "tcp"},
{"galaxy-server",      {NULL}, 3051, "udp"},
{"apc-3052",           {NULL}, 3052, "tcp"},
{"apc-3052",           {NULL}, 3052, "udp"},
{"dsom-server",        {NULL}, 3053, "tcp"},
{"dsom-server",        {NULL}, 3053, "udp"},
{"amt-cnf-prot",       {NULL}, 3054, "tcp"},
{"amt-cnf-prot",       {NULL}, 3054, "udp"},
{"policyserver",       {NULL}, 3055, "tcp"},
{"policyserver",       {NULL}, 3055, "udp"},
{"cdl-server",         {NULL}, 3056, "tcp"},
{"cdl-server",         {NULL}, 3056, "udp"},
{"goahead-fldup",      {NULL}, 3057, "tcp"},
{"goahead-fldup",      {NULL}, 3057, "udp"},
{"videobeans",         {NULL}, 3058, "tcp"},
{"videobeans",         {NULL}, 3058, "udp"},
{"qsoft",              {NULL}, 3059, "tcp"},
{"qsoft",              {NULL}, 3059, "udp"},
{"interserver",        {NULL}, 3060, "tcp"},
{"interserver",        {NULL}, 3060, "udp"},
{"cautcpd",            {NULL}, 3061, "tcp"},
{"cautcpd",            {NULL}, 3061, "udp"},
{"ncacn-ip-tcp",       {NULL}, 3062, "tcp"},
{"ncacn-ip-tcp",       {NULL}, 3062, "udp"},
{"ncadg-ip-udp",       {NULL}, 3063, "tcp"},
{"ncadg-ip-udp",       {NULL}, 3063, "udp"},
{"rprt",               {NULL}, 3064, "tcp"},
{"rprt",               {NULL}, 3064, "udp"},
{"slinterbase",        {NULL}, 3065, "tcp"},
{"slinterbase",        {NULL}, 3065, "udp"},
{"netattachsdmp",      {NULL}, 3066, "tcp"},
{"netattachsdmp",      {NULL}, 3066, "udp"},
{"fjhpjp",             {NULL}, 3067, "tcp"},
{"fjhpjp",             {NULL}, 3067, "udp"},
{"ls3bcast",           {NULL}, 3068, "tcp"},
{"ls3bcast",           {NULL}, 3068, "udp"},
{"ls3",                {NULL}, 3069, "tcp"},
{"ls3",                {NULL}, 3069, "udp"},
{"mgxswitch",          {NULL}, 3070, "tcp"},
{"mgxswitch",          {NULL}, 3070, "udp"},
{"csd-mgmt-port",      {NULL}, 3071, "tcp"},
{"csd-mgmt-port",      {NULL}, 3071, "udp"},
{"csd-monitor",        {NULL}, 3072, "tcp"},
{"csd-monitor",        {NULL}, 3072, "udp"},
{"vcrp",               {NULL}, 3073, "tcp"},
{"vcrp",               {NULL}, 3073, "udp"},
{"xbox",               {NULL}, 3074, "tcp"},
{"xbox",               {NULL}, 3074, "udp"},
{"orbix-locator",      {NULL}, 3075, "tcp"},
{"orbix-locator",      {NULL}, 3075, "udp"},
{"orbix-config",       {NULL}, 3076, "tcp"},
{"orbix-config",       {NULL}, 3076, "udp"},
{"orbix-loc-ssl",      {NULL}, 3077, "tcp"},
{"orbix-loc-ssl",      {NULL}, 3077, "udp"},
{"orbix-cfg-ssl",      {NULL}, 3078, "tcp"},
{"orbix-cfg-ssl",      {NULL}, 3078, "udp"},
{"lv-frontpanel",      {NULL}, 3079, "tcp"},
{"lv-frontpanel",      {NULL}, 3079, "udp"},
{"stm_pproc",          {NULL}, 3080, "tcp"},
{"stm_pproc",          {NULL}, 3080, "udp"},
{"tl1-lv",             {NULL}, 3081, "tcp"},
{"tl1-lv",             {NULL}, 3081, "udp"},
{"tl1-raw",            {NULL}, 3082, "tcp"},
{"tl1-raw",            {NULL}, 3082, "udp"},
{"tl1-telnet",         {NULL}, 3083, "tcp"},
{"tl1-telnet",         {NULL}, 3083, "udp"},
{"itm-mccs",           {NULL}, 3084, "tcp"},
{"itm-mccs",           {NULL}, 3084, "udp"},
{"pcihreq",            {NULL}, 3085, "tcp"},
{"pcihreq",            {NULL}, 3085, "udp"},
{"jdl-dbkitchen",      {NULL}, 3086, "tcp"},
{"jdl-dbkitchen",      {NULL}, 3086, "udp"},
{"asoki-sma",          {NULL}, 3087, "tcp"},
{"asoki-sma",          {NULL}, 3087, "udp"},
{"xdtp",               {NULL}, 3088, "tcp"},
{"xdtp",               {NULL}, 3088, "udp"},
{"ptk-alink",          {NULL}, 3089, "tcp"},
{"ptk-alink",          {NULL}, 3089, "udp"},
{"stss",               {NULL}, 3090, "tcp"},
{"stss",               {NULL}, 3090, "udp"},
{"1ci-smcs",           {NULL}, 3091, "tcp"},
{"1ci-smcs",           {NULL}, 3091, "udp"},
{"rapidmq-center",     {NULL}, 3093, "tcp"},
{"rapidmq-center",     {NULL}, 3093, "udp"},
{"rapidmq-reg",        {NULL}, 3094, "tcp"},
{"rapidmq-reg",        {NULL}, 3094, "udp"},
{"panasas",            {NULL}, 3095, "tcp"},
{"panasas",            {NULL}, 3095, "udp"},
{"ndl-aps",            {NULL}, 3096, "tcp"},
{"ndl-aps",            {NULL}, 3096, "udp"},
{"itu-bicc-stc",       {NULL}, 3097, "sctp"},
{"umm-port",           {NULL}, 3098, "tcp"},
{"umm-port",           {NULL}, 3098, "udp"},
{"chmd",               {NULL}, 3099, "tcp"},
{"chmd",               {NULL}, 3099, "udp"},
{"opcon-xps",          {NULL}, 3100, "tcp"},
{"opcon-xps",          {NULL}, 3100, "udp"},
{"hp-pxpib",           {NULL}, 3101, "tcp"},
{"hp-pxpib",           {NULL}, 3101, "udp"},
{"slslavemon",         {NULL}, 3102, "tcp"},
{"slslavemon",         {NULL}, 3102, "udp"},
{"autocuesmi",         {NULL}, 3103, "tcp"},
{"autocuesmi",         {NULL}, 3103, "udp"},
{"autocuelog",         {NULL}, 3104, "tcp"},
{"autocuetime",        {NULL}, 3104, "udp"},
{"cardbox",            {NULL}, 3105, "tcp"},
{"cardbox",            {NULL}, 3105, "udp"},
{"cardbox-http",       {NULL}, 3106, "tcp"},
{"cardbox-http",       {NULL}, 3106, "udp"},
{"business",           {NULL}, 3107, "tcp"},
{"business",           {NULL}, 3107, "udp"},
{"geolocate",          {NULL}, 3108, "tcp"},
{"geolocate",          {NULL}, 3108, "udp"},
{"personnel",          {NULL}, 3109, "tcp"},
{"personnel",          {NULL}, 3109, "udp"},
{"sim-control",        {NULL}, 3110, "tcp"},
{"sim-control",        {NULL}, 3110, "udp"},
{"wsynch",             {NULL}, 3111, "tcp"},
{"wsynch",             {NULL}, 3111, "udp"},
{"ksysguard",          {NULL}, 3112, "tcp"},
{"ksysguard",          {NULL}, 3112, "udp"},
{"cs-auth-svr",        {NULL}, 3113, "tcp"},
{"cs-auth-svr",        {NULL}, 3113, "udp"},
{"ccmad",              {NULL}, 3114, "tcp"},
{"ccmad",              {NULL}, 3114, "udp"},
{"mctet-master",       {NULL}, 3115, "tcp"},
{"mctet-master",       {NULL}, 3115, "udp"},
{"mctet-gateway",      {NULL}, 3116, "tcp"},
{"mctet-gateway",      {NULL}, 3116, "udp"},
{"mctet-jserv",        {NULL}, 3117, "tcp"},
{"mctet-jserv",        {NULL}, 3117, "udp"},
{"pkagent",            {NULL}, 3118, "tcp"},
{"pkagent",            {NULL}, 3118, "udp"},
{"d2000kernel",        {NULL}, 3119, "tcp"},
{"d2000kernel",        {NULL}, 3119, "udp"},
{"d2000webserver",     {NULL}, 3120, "tcp"},
{"d2000webserver",     {NULL}, 3120, "udp"},
{"vtr-emulator",       {NULL}, 3122, "tcp"},
{"vtr-emulator",       {NULL}, 3122, "udp"},
{"edix",               {NULL}, 3123, "tcp"},
{"edix",               {NULL}, 3123, "udp"},
{"beacon-port",        {NULL}, 3124, "tcp"},
{"beacon-port",        {NULL}, 3124, "udp"},
{"a13-an",             {NULL}, 3125, "tcp"},
{"a13-an",             {NULL}, 3125, "udp"},
{"ctx-bridge",         {NULL}, 3127, "tcp"},
{"ctx-bridge",         {NULL}, 3127, "udp"},
{"ndl-aas",            {NULL}, 3128, "tcp"},
{"ndl-aas",            {NULL}, 3128, "udp"},
{"netport-id",         {NULL}, 3129, "tcp"},
{"netport-id",         {NULL}, 3129, "udp"},
{"icpv2",              {NULL}, 3130, "tcp"},
{"icpv2",              {NULL}, 3130, "udp"},
{"netbookmark",        {NULL}, 3131, "tcp"},
{"netbookmark",        {NULL}, 3131, "udp"},
{"ms-rule-engine",     {NULL}, 3132, "tcp"},
{"ms-rule-engine",     {NULL}, 3132, "udp"},
{"prism-deploy",       {NULL}, 3133, "tcp"},
{"prism-deploy",       {NULL}, 3133, "udp"},
{"ecp",                {NULL}, 3134, "tcp"},
{"ecp",                {NULL}, 3134, "udp"},
{"peerbook-port",      {NULL}, 3135, "tcp"},
{"peerbook-port",      {NULL}, 3135, "udp"},
{"grubd",              {NULL}, 3136, "tcp"},
{"grubd",              {NULL}, 3136, "udp"},
{"rtnt-1",             {NULL}, 3137, "tcp"},
{"rtnt-1",             {NULL}, 3137, "udp"},
{"rtnt-2",             {NULL}, 3138, "tcp"},
{"rtnt-2",             {NULL}, 3138, "udp"},
{"incognitorv",        {NULL}, 3139, "tcp"},
{"incognitorv",        {NULL}, 3139, "udp"},
{"ariliamulti",        {NULL}, 3140, "tcp"},
{"ariliamulti",        {NULL}, 3140, "udp"},
{"vmodem",             {NULL}, 3141, "tcp"},
{"vmodem",             {NULL}, 3141, "udp"},
{"rdc-wh-eos",         {NULL}, 3142, "tcp"},
{"rdc-wh-eos",         {NULL}, 3142, "udp"},
{"seaview",            {NULL}, 3143, "tcp"},
{"seaview",            {NULL}, 3143, "udp"},
{"tarantella",         {NULL}, 3144, "tcp"},
{"tarantella",         {NULL}, 3144, "udp"},
{"csi-lfap",           {NULL}, 3145, "tcp"},
{"csi-lfap",           {NULL}, 3145, "udp"},
{"bears-02",           {NULL}, 3146, "tcp"},
{"bears-02",           {NULL}, 3146, "udp"},
{"rfio",               {NULL}, 3147, "tcp"},
{"rfio",               {NULL}, 3147, "udp"},
{"nm-game-admin",      {NULL}, 3148, "tcp"},
{"nm-game-admin",      {NULL}, 3148, "udp"},
{"nm-game-server",     {NULL}, 3149, "tcp"},
{"nm-game-server",     {NULL}, 3149, "udp"},
{"nm-asses-admin",     {NULL}, 3150, "tcp"},
{"nm-asses-admin",     {NULL}, 3150, "udp"},
{"nm-assessor",        {NULL}, 3151, "tcp"},
{"nm-assessor",        {NULL}, 3151, "udp"},
{"feitianrockey",      {NULL}, 3152, "tcp"},
{"feitianrockey",      {NULL}, 3152, "udp"},
{"s8-client-port",     {NULL}, 3153, "tcp"},
{"s8-client-port",     {NULL}, 3153, "udp"},
{"ccmrmi",             {NULL}, 3154, "tcp"},
{"ccmrmi",             {NULL}, 3154, "udp"},
{"jpegmpeg",           {NULL}, 3155, "tcp"},
{"jpegmpeg",           {NULL}, 3155, "udp"},
{"indura",             {NULL}, 3156, "tcp"},
{"indura",             {NULL}, 3156, "udp"},
{"e3consultants",      {NULL}, 3157, "tcp"},
{"e3consultants",      {NULL}, 3157, "udp"},
{"stvp",               {NULL}, 3158, "tcp"},
{"stvp",               {NULL}, 3158, "udp"},
{"navegaweb-port",     {NULL}, 3159, "tcp"},
{"navegaweb-port",     {NULL}, 3159, "udp"},
{"tip-app-server",     {NULL}, 3160, "tcp"},
{"tip-app-server",     {NULL}, 3160, "udp"},
{"doc1lm",             {NULL}, 3161, "tcp"},
{"doc1lm",             {NULL}, 3161, "udp"},
{"sflm",               {NULL}, 3162, "tcp"},
{"sflm",               {NULL}, 3162, "udp"},
{"res-sap",            {NULL}, 3163, "tcp"},
{"res-sap",            {NULL}, 3163, "udp"},
{"imprs",              {NULL}, 3164, "tcp"},
{"imprs",              {NULL}, 3164, "udp"},
{"newgenpay",          {NULL}, 3165, "tcp"},
{"newgenpay",          {NULL}, 3165, "udp"},
{"sossecollector",     {NULL}, 3166, "tcp"},
{"sossecollector",     {NULL}, 3166, "udp"},
{"nowcontact",         {NULL}, 3167, "tcp"},
{"nowcontact",         {NULL}, 3167, "udp"},
{"poweronnud",         {NULL}, 3168, "tcp"},
{"poweronnud",         {NULL}, 3168, "udp"},
{"serverview-as",      {NULL}, 3169, "tcp"},
{"serverview-as",      {NULL}, 3169, "udp"},
{"serverview-asn",     {NULL}, 3170, "tcp"},
{"serverview-asn",     {NULL}, 3170, "udp"},
{"serverview-gf",      {NULL}, 3171, "tcp"},
{"serverview-gf",      {NULL}, 3171, "udp"},
{"serverview-rm",      {NULL}, 3172, "tcp"},
{"serverview-rm",      {NULL}, 3172, "udp"},
{"serverview-icc",     {NULL}, 3173, "tcp"},
{"serverview-icc",     {NULL}, 3173, "udp"},
{"armi-server",        {NULL}, 3174, "tcp"},
{"armi-server",        {NULL}, 3174, "udp"},
{"t1-e1-over-ip",      {NULL}, 3175, "tcp"},
{"t1-e1-over-ip",      {NULL}, 3175, "udp"},
{"ars-master",         {NULL}, 3176, "tcp"},
{"ars-master",         {NULL}, 3176, "udp"},
{"phonex-port",        {NULL}, 3177, "tcp"},
{"phonex-port",        {NULL}, 3177, "udp"},
{"radclientport",      {NULL}, 3178, "tcp"},
{"radclientport",      {NULL}, 3178, "udp"},
{"h2gf-w-2m",          {NULL}, 3179, "tcp"},
{"h2gf-w-2m",          {NULL}, 3179, "udp"},
{"mc-brk-srv",         {NULL}, 3180, "tcp"},
{"mc-brk-srv",         {NULL}, 3180, "udp"},
{"bmcpatrolagent",     {NULL}, 3181, "tcp"},
{"bmcpatrolagent",     {NULL}, 3181, "udp"},
{"bmcpatrolrnvu",      {NULL}, 3182, "tcp"},
{"bmcpatrolrnvu",      {NULL}, 3182, "udp"},
{"cops-tls",           {NULL}, 3183, "tcp"},
{"cops-tls",           {NULL}, 3183, "udp"},
{"apogeex-port",       {NULL}, 3184, "tcp"},
{"apogeex-port",       {NULL}, 3184, "udp"},
{"smpppd",             {NULL}, 3185, "tcp"},
{"smpppd",             {NULL}, 3185, "udp"},
{"iiw-port",           {NULL}, 3186, "tcp"},
{"iiw-port",           {NULL}, 3186, "udp"},
{"odi-port",           {NULL}, 3187, "tcp"},
{"odi-port",           {NULL}, 3187, "udp"},
{"brcm-comm-port",     {NULL}, 3188, "tcp"},
{"brcm-comm-port",     {NULL}, 3188, "udp"},
{"pcle-infex",         {NULL}, 3189, "tcp"},
{"pcle-infex",         {NULL}, 3189, "udp"},
{"csvr-proxy",         {NULL}, 3190, "tcp"},
{"csvr-proxy",         {NULL}, 3190, "udp"},
{"csvr-sslproxy",      {NULL}, 3191, "tcp"},
{"csvr-sslproxy",      {NULL}, 3191, "udp"},
{"firemonrcc",         {NULL}, 3192, "tcp"},
{"firemonrcc",         {NULL}, 3192, "udp"},
{"spandataport",       {NULL}, 3193, "tcp"},
{"spandataport",       {NULL}, 3193, "udp"},
{"magbind",            {NULL}, 3194, "tcp"},
{"magbind",            {NULL}, 3194, "udp"},
{"ncu-1",              {NULL}, 3195, "tcp"},
{"ncu-1",              {NULL}, 3195, "udp"},
{"ncu-2",              {NULL}, 3196, "tcp"},
{"ncu-2",              {NULL}, 3196, "udp"},
{"embrace-dp-s",       {NULL}, 3197, "tcp"},
{"embrace-dp-s",       {NULL}, 3197, "udp"},
{"embrace-dp-c",       {NULL}, 3198, "tcp"},
{"embrace-dp-c",       {NULL}, 3198, "udp"},
{"dmod-workspace",     {NULL}, 3199, "tcp"},
{"dmod-workspace",     {NULL}, 3199, "udp"},
{"tick-port",          {NULL}, 3200, "tcp"},
{"tick-port",          {NULL}, 3200, "udp"},
{"cpq-tasksmart",      {NULL}, 3201, "tcp"},
{"cpq-tasksmart",      {NULL}, 3201, "udp"},
{"intraintra",         {NULL}, 3202, "tcp"},
{"intraintra",         {NULL}, 3202, "udp"},
{"netwatcher-mon",     {NULL}, 3203, "tcp"},
{"netwatcher-mon",     {NULL}, 3203, "udp"},
{"netwatcher-db",      {NULL}, 3204, "tcp"},
{"netwatcher-db",      {NULL}, 3204, "udp"},
{"isns",               {NULL}, 3205, "tcp"},
{"isns",               {NULL}, 3205, "udp"},
{"ironmail",           {NULL}, 3206, "tcp"},
{"ironmail",           {NULL}, 3206, "udp"},
{"vx-auth-port",       {NULL}, 3207, "tcp"},
{"vx-auth-port",       {NULL}, 3207, "udp"},
{"pfu-prcallback",     {NULL}, 3208, "tcp"},
{"pfu-prcallback",     {NULL}, 3208, "udp"},
{"netwkpathengine",    {NULL}, 3209, "tcp"},
{"netwkpathengine",    {NULL}, 3209, "udp"},
{"flamenco-proxy",     {NULL}, 3210, "tcp"},
{"flamenco-proxy",     {NULL}, 3210, "udp"},
{"avsecuremgmt",       {NULL}, 3211, "tcp"},
{"avsecuremgmt",       {NULL}, 3211, "udp"},
{"surveyinst",         {NULL}, 3212, "tcp"},
{"surveyinst",         {NULL}, 3212, "udp"},
{"neon24x7",           {NULL}, 3213, "tcp"},
{"neon24x7",           {NULL}, 3213, "udp"},
{"jmq-daemon-1",       {NULL}, 3214, "tcp"},
{"jmq-daemon-1",       {NULL}, 3214, "udp"},
{"jmq-daemon-2",       {NULL}, 3215, "tcp"},
{"jmq-daemon-2",       {NULL}, 3215, "udp"},
{"ferrari-foam",       {NULL}, 3216, "tcp"},
{"ferrari-foam",       {NULL}, 3216, "udp"},
{"unite",              {NULL}, 3217, "tcp"},
{"unite",              {NULL}, 3217, "udp"},
{"smartpackets",       {NULL}, 3218, "tcp"},
{"smartpackets",       {NULL}, 3218, "udp"},
{"wms-messenger",      {NULL}, 3219, "tcp"},
{"wms-messenger",      {NULL}, 3219, "udp"},
{"xnm-ssl",            {NULL}, 3220, "tcp"},
{"xnm-ssl",            {NULL}, 3220, "udp"},
{"xnm-clear-text",     {NULL}, 3221, "tcp"},
{"xnm-clear-text",     {NULL}, 3221, "udp"},
{"glbp",               {NULL}, 3222, "tcp"},
{"glbp",               {NULL}, 3222, "udp"},
{"digivote",           {NULL}, 3223, "tcp"},
{"digivote",           {NULL}, 3223, "udp"},
{"aes-discovery",      {NULL}, 3224, "tcp"},
{"aes-discovery",      {NULL}, 3224, "udp"},
{"fcip-port",          {NULL}, 3225, "tcp"},
{"fcip-port",          {NULL}, 3225, "udp"},
{"isi-irp",            {NULL}, 3226, "tcp"},
{"isi-irp",            {NULL}, 3226, "udp"},
{"dwnmshttp",          {NULL}, 3227, "tcp"},
{"dwnmshttp",          {NULL}, 3227, "udp"},
{"dwmsgserver",        {NULL}, 3228, "tcp"},
{"dwmsgserver",        {NULL}, 3228, "udp"},
{"global-cd-port",     {NULL}, 3229, "tcp"},
{"global-cd-port",     {NULL}, 3229, "udp"},
{"sftdst-port",        {NULL}, 3230, "tcp"},
{"sftdst-port",        {NULL}, 3230, "udp"},
{"vidigo",             {NULL}, 3231, "tcp"},
{"vidigo",             {NULL}, 3231, "udp"},
{"mdtp",               {NULL}, 3232, "tcp"},
{"mdtp",               {NULL}, 3232, "udp"},
{"whisker",            {NULL}, 3233, "tcp"},
{"whisker",            {NULL}, 3233, "udp"},
{"alchemy",            {NULL}, 3234, "tcp"},
{"alchemy",            {NULL}, 3234, "udp"},
{"mdap-port",          {NULL}, 3235, "tcp"},
{"mdap-port",          {NULL}, 3235, "udp"},
{"apparenet-ts",       {NULL}, 3236, "tcp"},
{"apparenet-ts",       {NULL}, 3236, "udp"},
{"apparenet-tps",      {NULL}, 3237, "tcp"},
{"apparenet-tps",      {NULL}, 3237, "udp"},
{"apparenet-as",       {NULL}, 3238, "tcp"},
{"apparenet-as",       {NULL}, 3238, "udp"},
{"apparenet-ui",       {NULL}, 3239, "tcp"},
{"apparenet-ui",       {NULL}, 3239, "udp"},
{"triomotion",         {NULL}, 3240, "tcp"},
{"triomotion",         {NULL}, 3240, "udp"},
{"sysorb",             {NULL}, 3241, "tcp"},
{"sysorb",             {NULL}, 3241, "udp"},
{"sdp-id-port",        {NULL}, 3242, "tcp"},
{"sdp-id-port",        {NULL}, 3242, "udp"},
{"timelot",            {NULL}, 3243, "tcp"},
{"timelot",            {NULL}, 3243, "udp"},
{"onesaf",             {NULL}, 3244, "tcp"},
{"onesaf",             {NULL}, 3244, "udp"},
{"vieo-fe",            {NULL}, 3245, "tcp"},
{"vieo-fe",            {NULL}, 3245, "udp"},
{"dvt-system",         {NULL}, 3246, "tcp"},
{"dvt-system",         {NULL}, 3246, "udp"},
{"dvt-data",           {NULL}, 3247, "tcp"},
{"dvt-data",           {NULL}, 3247, "udp"},
{"procos-lm",          {NULL}, 3248, "tcp"},
{"procos-lm",          {NULL}, 3248, "udp"},
{"ssp",                {NULL}, 3249, "tcp"},
{"ssp",                {NULL}, 3249, "udp"},
{"hicp",               {NULL}, 3250, "tcp"},
{"hicp",               {NULL}, 3250, "udp"},
{"sysscanner",         {NULL}, 3251, "tcp"},
{"sysscanner",         {NULL}, 3251, "udp"},
{"dhe",                {NULL}, 3252, "tcp"},
{"dhe",                {NULL}, 3252, "udp"},
{"pda-data",           {NULL}, 3253, "tcp"},
{"pda-data",           {NULL}, 3253, "udp"},
{"pda-sys",            {NULL}, 3254, "tcp"},
{"pda-sys",            {NULL}, 3254, "udp"},
{"semaphore",          {NULL}, 3255, "tcp"},
{"semaphore",          {NULL}, 3255, "udp"},
{"cpqrpm-agent",       {NULL}, 3256, "tcp"},
{"cpqrpm-agent",       {NULL}, 3256, "udp"},
{"cpqrpm-server",      {NULL}, 3257, "tcp"},
{"cpqrpm-server",      {NULL}, 3257, "udp"},
{"ivecon-port",        {NULL}, 3258, "tcp"},
{"ivecon-port",        {NULL}, 3258, "udp"},
{"epncdp2",            {NULL}, 3259, "tcp"},
{"epncdp2",            {NULL}, 3259, "udp"},
{"iscsi-target",       {NULL}, 3260, "tcp"},
{"iscsi-target",       {NULL}, 3260, "udp"},
{"winshadow",          {NULL}, 3261, "tcp"},
{"winshadow",          {NULL}, 3261, "udp"},
{"necp",               {NULL}, 3262, "tcp"},
{"necp",               {NULL}, 3262, "udp"},
{"ecolor-imager",      {NULL}, 3263, "tcp"},
{"ecolor-imager",      {NULL}, 3263, "udp"},
{"ccmail",             {NULL}, 3264, "tcp"},
{"ccmail",             {NULL}, 3264, "udp"},
{"altav-tunnel",       {NULL}, 3265, "tcp"},
{"altav-tunnel",       {NULL}, 3265, "udp"},
{"ns-cfg-server",      {NULL}, 3266, "tcp"},
{"ns-cfg-server",      {NULL}, 3266, "udp"},
{"ibm-dial-out",       {NULL}, 3267, "tcp"},
{"ibm-dial-out",       {NULL}, 3267, "udp"},
{"msft-gc",            {NULL}, 3268, "tcp"},
{"msft-gc",            {NULL}, 3268, "udp"},
{"msft-gc-ssl",        {NULL}, 3269, "tcp"},
{"msft-gc-ssl",        {NULL}, 3269, "udp"},
{"verismart",          {NULL}, 3270, "tcp"},
{"verismart",          {NULL}, 3270, "udp"},
{"csoft-prev",         {NULL}, 3271, "tcp"},
{"csoft-prev",         {NULL}, 3271, "udp"},
{"user-manager",       {NULL}, 3272, "tcp"},
{"user-manager",       {NULL}, 3272, "udp"},
{"sxmp",               {NULL}, 3273, "tcp"},
{"sxmp",               {NULL}, 3273, "udp"},
{"ordinox-server",     {NULL}, 3274, "tcp"},
{"ordinox-server",     {NULL}, 3274, "udp"},
{"samd",               {NULL}, 3275, "tcp"},
{"samd",               {NULL}, 3275, "udp"},
{"maxim-asics",        {NULL}, 3276, "tcp"},
{"maxim-asics",        {NULL}, 3276, "udp"},
{"awg-proxy",          {NULL}, 3277, "tcp"},
{"awg-proxy",          {NULL}, 3277, "udp"},
{"lkcmserver",         {NULL}, 3278, "tcp"},
{"lkcmserver",         {NULL}, 3278, "udp"},
{"admind",             {NULL}, 3279, "tcp"},
{"admind",             {NULL}, 3279, "udp"},
{"vs-server",          {NULL}, 3280, "tcp"},
{"vs-server",          {NULL}, 3280, "udp"},
{"sysopt",             {NULL}, 3281, "tcp"},
{"sysopt",             {NULL}, 3281, "udp"},
{"datusorb",           {NULL}, 3282, "tcp"},
{"datusorb",           {NULL}, 3282, "udp"},
{"net-assistant",      {NULL}, 3283, "tcp"},
{"net-assistant",      {NULL}, 3283, "udp"},
{"4talk",              {NULL}, 3284, "tcp"},
{"4talk",              {NULL}, 3284, "udp"},
{"plato",              {NULL}, 3285, "tcp"},
{"plato",              {NULL}, 3285, "udp"},
{"e-net",              {NULL}, 3286, "tcp"},
{"e-net",              {NULL}, 3286, "udp"},
{"directvdata",        {NULL}, 3287, "tcp"},
{"directvdata",        {NULL}, 3287, "udp"},
{"cops",               {NULL}, 3288, "tcp"},
{"cops",               {NULL}, 3288, "udp"},
{"enpc",               {NULL}, 3289, "tcp"},
{"enpc",               {NULL}, 3289, "udp"},
{"caps-lm",            {NULL}, 3290, "tcp"},
{"caps-lm",            {NULL}, 3290, "udp"},
{"sah-lm",             {NULL}, 3291, "tcp"},
{"sah-lm",             {NULL}, 3291, "udp"},
{"cart-o-rama",        {NULL}, 3292, "tcp"},
{"cart-o-rama",        {NULL}, 3292, "udp"},
{"fg-fps",             {NULL}, 3293, "tcp"},
{"fg-fps",             {NULL}, 3293, "udp"},
{"fg-gip",             {NULL}, 3294, "tcp"},
{"fg-gip",             {NULL}, 3294, "udp"},
{"dyniplookup",        {NULL}, 3295, "tcp"},
{"dyniplookup",        {NULL}, 3295, "udp"},
{"rib-slm",            {NULL}, 3296, "tcp"},
{"rib-slm",            {NULL}, 3296, "udp"},
{"cytel-lm",           {NULL}, 3297, "tcp"},
{"cytel-lm",           {NULL}, 3297, "udp"},
{"deskview",           {NULL}, 3298, "tcp"},
{"deskview",           {NULL}, 3298, "udp"},
{"pdrncs",             {NULL}, 3299, "tcp"},
{"pdrncs",             {NULL}, 3299, "udp"},
{"mcs-fastmail",       {NULL}, 3302, "tcp"},
{"mcs-fastmail",       {NULL}, 3302, "udp"},
{"opsession-clnt",     {NULL}, 3303, "tcp"},
{"opsession-clnt",     {NULL}, 3303, "udp"},
{"opsession-srvr",     {NULL}, 3304, "tcp"},
{"opsession-srvr",     {NULL}, 3304, "udp"},
{"odette-ftp",         {NULL}, 3305, "tcp"},
{"odette-ftp",         {NULL}, 3305, "udp"},
{"mysql",              {NULL}, 3306, "tcp"},
{"mysql",              {NULL}, 3306, "udp"},
{"opsession-prxy",     {NULL}, 3307, "tcp"},
{"opsession-prxy",     {NULL}, 3307, "udp"},
{"tns-server",         {NULL}, 3308, "tcp"},
{"tns-server",         {NULL}, 3308, "udp"},
{"tns-adv",            {NULL}, 3309, "tcp"},
{"tns-adv",            {NULL}, 3309, "udp"},
{"dyna-access",        {NULL}, 3310, "tcp"},
{"dyna-access",        {NULL}, 3310, "udp"},
{"mcns-tel-ret",       {NULL}, 3311, "tcp"},
{"mcns-tel-ret",       {NULL}, 3311, "udp"},
{"appman-server",      {NULL}, 3312, "tcp"},
{"appman-server",      {NULL}, 3312, "udp"},
{"uorb",               {NULL}, 3313, "tcp"},
{"uorb",               {NULL}, 3313, "udp"},
{"uohost",             {NULL}, 3314, "tcp"},
{"uohost",             {NULL}, 3314, "udp"},
{"cdid",               {NULL}, 3315, "tcp"},
{"cdid",               {NULL}, 3315, "udp"},
{"aicc-cmi",           {NULL}, 3316, "tcp"},
{"aicc-cmi",           {NULL}, 3316, "udp"},
{"vsaiport",           {NULL}, 3317, "tcp"},
{"vsaiport",           {NULL}, 3317, "udp"},
{"ssrip",              {NULL}, 3318, "tcp"},
{"ssrip",              {NULL}, 3318, "udp"},
{"sdt-lmd",            {NULL}, 3319, "tcp"},
{"sdt-lmd",            {NULL}, 3319, "udp"},
{"officelink2000",     {NULL}, 3320, "tcp"},
{"officelink2000",     {NULL}, 3320, "udp"},
{"vnsstr",             {NULL}, 3321, "tcp"},
{"vnsstr",             {NULL}, 3321, "udp"},
{"sftu",               {NULL}, 3326, "tcp"},
{"sftu",               {NULL}, 3326, "udp"},
{"bbars",              {NULL}, 3327, "tcp"},
{"bbars",              {NULL}, 3327, "udp"},
{"egptlm",             {NULL}, 3328, "tcp"},
{"egptlm",             {NULL}, 3328, "udp"},
{"hp-device-disc",     {NULL}, 3329, "tcp"},
{"hp-device-disc",     {NULL}, 3329, "udp"},
{"mcs-calypsoicf",     {NULL}, 3330, "tcp"},
{"mcs-calypsoicf",     {NULL}, 3330, "udp"},
{"mcs-messaging",      {NULL}, 3331, "tcp"},
{"mcs-messaging",      {NULL}, 3331, "udp"},
{"mcs-mailsvr",        {NULL}, 3332, "tcp"},
{"mcs-mailsvr",        {NULL}, 3332, "udp"},
{"dec-notes",          {NULL}, 3333, "tcp"},
{"dec-notes",          {NULL}, 3333, "udp"},
{"directv-web",        {NULL}, 3334, "tcp"},
{"directv-web",        {NULL}, 3334, "udp"},
{"directv-soft",       {NULL}, 3335, "tcp"},
{"directv-soft",       {NULL}, 3335, "udp"},
{"directv-tick",       {NULL}, 3336, "tcp"},
{"directv-tick",       {NULL}, 3336, "udp"},
{"directv-catlg",      {NULL}, 3337, "tcp"},
{"directv-catlg",      {NULL}, 3337, "udp"},
{"anet-b",             {NULL}, 3338, "tcp"},
{"anet-b",             {NULL}, 3338, "udp"},
{"anet-l",             {NULL}, 3339, "tcp"},
{"anet-l",             {NULL}, 3339, "udp"},
{"anet-m",             {NULL}, 3340, "tcp"},
{"anet-m",             {NULL}, 3340, "udp"},
{"anet-h",             {NULL}, 3341, "tcp"},
{"anet-h",             {NULL}, 3341, "udp"},
{"webtie",             {NULL}, 3342, "tcp"},
{"webtie",             {NULL}, 3342, "udp"},
{"ms-cluster-net",     {NULL}, 3343, "tcp"},
{"ms-cluster-net",     {NULL}, 3343, "udp"},
{"bnt-manager",        {NULL}, 3344, "tcp"},
{"bnt-manager",        {NULL}, 3344, "udp"},
{"influence",          {NULL}, 3345, "tcp"},
{"influence",          {NULL}, 3345, "udp"},
{"trnsprntproxy",      {NULL}, 3346, "tcp"},
{"trnsprntproxy",      {NULL}, 3346, "udp"},
{"phoenix-rpc",        {NULL}, 3347, "tcp"},
{"phoenix-rpc",        {NULL}, 3347, "udp"},
{"pangolin-laser",     {NULL}, 3348, "tcp"},
{"pangolin-laser",     {NULL}, 3348, "udp"},
{"chevinservices",     {NULL}, 3349, "tcp"},
{"chevinservices",     {NULL}, 3349, "udp"},
{"findviatv",          {NULL}, 3350, "tcp"},
{"findviatv",          {NULL}, 3350, "udp"},
{"btrieve",            {NULL}, 3351, "tcp"},
{"btrieve",            {NULL}, 3351, "udp"},
{"ssql",               {NULL}, 3352, "tcp"},
{"ssql",               {NULL}, 3352, "udp"},
{"fatpipe",            {NULL}, 3353, "tcp"},
{"fatpipe",            {NULL}, 3353, "udp"},
{"suitjd",             {NULL}, 3354, "tcp"},
{"suitjd",             {NULL}, 3354, "udp"},
{"ordinox-dbase",      {NULL}, 3355, "tcp"},
{"ordinox-dbase",      {NULL}, 3355, "udp"},
{"upnotifyps",         {NULL}, 3356, "tcp"},
{"upnotifyps",         {NULL}, 3356, "udp"},
{"adtech-test",        {NULL}, 3357, "tcp"},
{"adtech-test",        {NULL}, 3357, "udp"},
{"mpsysrmsvr",         {NULL}, 3358, "tcp"},
{"mpsysrmsvr",         {NULL}, 3358, "udp"},
{"wg-netforce",        {NULL}, 3359, "tcp"},
{"wg-netforce",        {NULL}, 3359, "udp"},
{"kv-server",          {NULL}, 3360, "tcp"},
{"kv-server",          {NULL}, 3360, "udp"},
{"kv-agent",           {NULL}, 3361, "tcp"},
{"kv-agent",           {NULL}, 3361, "udp"},
{"dj-ilm",             {NULL}, 3362, "tcp"},
{"dj-ilm",             {NULL}, 3362, "udp"},
{"nati-vi-server",     {NULL}, 3363, "tcp"},
{"nati-vi-server",     {NULL}, 3363, "udp"},
{"creativeserver",     {NULL}, 3364, "tcp"},
{"creativeserver",     {NULL}, 3364, "udp"},
{"contentserver",      {NULL}, 3365, "tcp"},
{"contentserver",      {NULL}, 3365, "udp"},
{"creativepartnr",     {NULL}, 3366, "tcp"},
{"creativepartnr",     {NULL}, 3366, "udp"},
{"tip2",               {NULL}, 3372, "tcp"},
{"tip2",               {NULL}, 3372, "udp"},
{"lavenir-lm",         {NULL}, 3373, "tcp"},
{"lavenir-lm",         {NULL}, 3373, "udp"},
{"cluster-disc",       {NULL}, 3374, "tcp"},
{"cluster-disc",       {NULL}, 3374, "udp"},
{"vsnm-agent",         {NULL}, 3375, "tcp"},
{"vsnm-agent",         {NULL}, 3375, "udp"},
{"cdbroker",           {NULL}, 3376, "tcp"},
{"cdbroker",           {NULL}, 3376, "udp"},
{"cogsys-lm",          {NULL}, 3377, "tcp"},
{"cogsys-lm",          {NULL}, 3377, "udp"},
{"wsicopy",            {NULL}, 3378, "tcp"},
{"wsicopy",            {NULL}, 3378, "udp"},
{"socorfs",            {NULL}, 3379, "tcp"},
{"socorfs",            {NULL}, 3379, "udp"},
{"sns-channels",       {NULL}, 3380, "tcp"},
{"sns-channels",       {NULL}, 3380, "udp"},
{"geneous",            {NULL}, 3381, "tcp"},
{"geneous",            {NULL}, 3381, "udp"},
{"fujitsu-neat",       {NULL}, 3382, "tcp"},
{"fujitsu-neat",       {NULL}, 3382, "udp"},
{"esp-lm",             {NULL}, 3383, "tcp"},
{"esp-lm",             {NULL}, 3383, "udp"},
{"hp-clic",            {NULL}, 3384, "tcp"},
{"hp-clic",            {NULL}, 3384, "udp"},
{"qnxnetman",          {NULL}, 3385, "tcp"},
{"qnxnetman",          {NULL}, 3385, "udp"},
{"gprs-data",          {NULL}, 3386, "tcp"},
{"gprs-sig",           {NULL}, 3386, "udp"},
{"backroomnet",        {NULL}, 3387, "tcp"},
{"backroomnet",        {NULL}, 3387, "udp"},
{"cbserver",           {NULL}, 3388, "tcp"},
{"cbserver",           {NULL}, 3388, "udp"},
{"ms-wbt-server",      {NULL}, 3389, "tcp"},
{"ms-wbt-server",      {NULL}, 3389, "udp"},
{"dsc",                {NULL}, 3390, "tcp"},
{"dsc",                {NULL}, 3390, "udp"},
{"savant",             {NULL}, 3391, "tcp"},
{"savant",             {NULL}, 3391, "udp"},
{"efi-lm",             {NULL}, 3392, "tcp"},
{"efi-lm",             {NULL}, 3392, "udp"},
{"d2k-tapestry1",      {NULL}, 3393, "tcp"},
{"d2k-tapestry1",      {NULL}, 3393, "udp"},
{"d2k-tapestry2",      {NULL}, 3394, "tcp"},
{"d2k-tapestry2",      {NULL}, 3394, "udp"},
{"dyna-lm",            {NULL}, 3395, "tcp"},
{"dyna-lm",            {NULL}, 3395, "udp"},
{"printer_agent",      {NULL}, 3396, "tcp"},
{"printer_agent",      {NULL}, 3396, "udp"},
{"cloanto-lm",         {NULL}, 3397, "tcp"},
{"cloanto-lm",         {NULL}, 3397, "udp"},
{"mercantile",         {NULL}, 3398, "tcp"},
{"mercantile",         {NULL}, 3398, "udp"},
{"csms",               {NULL}, 3399, "tcp"},
{"csms",               {NULL}, 3399, "udp"},
{"csms2",              {NULL}, 3400, "tcp"},
{"csms2",              {NULL}, 3400, "udp"},
{"filecast",           {NULL}, 3401, "tcp"},
{"filecast",           {NULL}, 3401, "udp"},
{"fxaengine-net",      {NULL}, 3402, "tcp"},
{"fxaengine-net",      {NULL}, 3402, "udp"},
{"nokia-ann-ch1",      {NULL}, 3405, "tcp"},
{"nokia-ann-ch1",      {NULL}, 3405, "udp"},
{"nokia-ann-ch2",      {NULL}, 3406, "tcp"},
{"nokia-ann-ch2",      {NULL}, 3406, "udp"},
{"ldap-admin",         {NULL}, 3407, "tcp"},
{"ldap-admin",         {NULL}, 3407, "udp"},
{"BESApi",             {NULL}, 3408, "tcp"},
{"BESApi",             {NULL}, 3408, "udp"},
{"networklens",        {NULL}, 3409, "tcp"},
{"networklens",        {NULL}, 3409, "udp"},
{"networklenss",       {NULL}, 3410, "tcp"},
{"networklenss",       {NULL}, 3410, "udp"},
{"biolink-auth",       {NULL}, 3411, "tcp"},
{"biolink-auth",       {NULL}, 3411, "udp"},
{"xmlblaster",         {NULL}, 3412, "tcp"},
{"xmlblaster",         {NULL}, 3412, "udp"},
{"svnet",              {NULL}, 3413, "tcp"},
{"svnet",              {NULL}, 3413, "udp"},
{"wip-port",           {NULL}, 3414, "tcp"},
{"wip-port",           {NULL}, 3414, "udp"},
{"bcinameservice",     {NULL}, 3415, "tcp"},
{"bcinameservice",     {NULL}, 3415, "udp"},
{"commandport",        {NULL}, 3416, "tcp"},
{"commandport",        {NULL}, 3416, "udp"},
{"csvr",               {NULL}, 3417, "tcp"},
{"csvr",               {NULL}, 3417, "udp"},
{"rnmap",              {NULL}, 3418, "tcp"},
{"rnmap",              {NULL}, 3418, "udp"},
{"softaudit",          {NULL}, 3419, "tcp"},
{"softaudit",          {NULL}, 3419, "udp"},
{"ifcp-port",          {NULL}, 3420, "tcp"},
{"ifcp-port",          {NULL}, 3420, "udp"},
{"bmap",               {NULL}, 3421, "tcp"},
{"bmap",               {NULL}, 3421, "udp"},
{"rusb-sys-port",      {NULL}, 3422, "tcp"},
{"rusb-sys-port",      {NULL}, 3422, "udp"},
{"xtrm",               {NULL}, 3423, "tcp"},
{"xtrm",               {NULL}, 3423, "udp"},
{"xtrms",              {NULL}, 3424, "tcp"},
{"xtrms",              {NULL}, 3424, "udp"},
{"agps-port",          {NULL}, 3425, "tcp"},
{"agps-port",          {NULL}, 3425, "udp"},
{"arkivio",            {NULL}, 3426, "tcp"},
{"arkivio",            {NULL}, 3426, "udp"},
{"websphere-snmp",     {NULL}, 3427, "tcp"},
{"websphere-snmp",     {NULL}, 3427, "udp"},
{"twcss",              {NULL}, 3428, "tcp"},
{"twcss",              {NULL}, 3428, "udp"},
{"gcsp",               {NULL}, 3429, "tcp"},
{"gcsp",               {NULL}, 3429, "udp"},
{"ssdispatch",         {NULL}, 3430, "tcp"},
{"ssdispatch",         {NULL}, 3430, "udp"},
{"ndl-als",            {NULL}, 3431, "tcp"},
{"ndl-als",            {NULL}, 3431, "udp"},
{"osdcp",              {NULL}, 3432, "tcp"},
{"osdcp",              {NULL}, 3432, "udp"},
{"alta-smp",           {NULL}, 3433, "tcp"},
{"alta-smp",           {NULL}, 3433, "udp"},
{"opencm",             {NULL}, 3434, "tcp"},
{"opencm",             {NULL}, 3434, "udp"},
{"pacom",              {NULL}, 3435, "tcp"},
{"pacom",              {NULL}, 3435, "udp"},
{"gc-config",          {NULL}, 3436, "tcp"},
{"gc-config",          {NULL}, 3436, "udp"},
{"autocueds",          {NULL}, 3437, "tcp"},
{"autocueds",          {NULL}, 3437, "udp"},
{"spiral-admin",       {NULL}, 3438, "tcp"},
{"spiral-admin",       {NULL}, 3438, "udp"},
{"hri-port",           {NULL}, 3439, "tcp"},
{"hri-port",           {NULL}, 3439, "udp"},
{"ans-console",        {NULL}, 3440, "tcp"},
{"ans-console",        {NULL}, 3440, "udp"},
{"connect-client",     {NULL}, 3441, "tcp"},
{"connect-client",     {NULL}, 3441, "udp"},
{"connect-server",     {NULL}, 3442, "tcp"},
{"connect-server",     {NULL}, 3442, "udp"},
{"ov-nnm-websrv",      {NULL}, 3443, "tcp"},
{"ov-nnm-websrv",      {NULL}, 3443, "udp"},
{"denali-server",      {NULL}, 3444, "tcp"},
{"denali-server",      {NULL}, 3444, "udp"},
{"monp",               {NULL}, 3445, "tcp"},
{"monp",               {NULL}, 3445, "udp"},
{"3comfaxrpc",         {NULL}, 3446, "tcp"},
{"3comfaxrpc",         {NULL}, 3446, "udp"},
{"directnet",          {NULL}, 3447, "tcp"},
{"directnet",          {NULL}, 3447, "udp"},
{"dnc-port",           {NULL}, 3448, "tcp"},
{"dnc-port",           {NULL}, 3448, "udp"},
{"hotu-chat",          {NULL}, 3449, "tcp"},
{"hotu-chat",          {NULL}, 3449, "udp"},
{"castorproxy",        {NULL}, 3450, "tcp"},
{"castorproxy",        {NULL}, 3450, "udp"},
{"asam",               {NULL}, 3451, "tcp"},
{"asam",               {NULL}, 3451, "udp"},
{"sabp-signal",        {NULL}, 3452, "tcp"},
{"sabp-signal",        {NULL}, 3452, "udp"},
{"pscupd",             {NULL}, 3453, "tcp"},
{"pscupd",             {NULL}, 3453, "udp"},
{"mira",               {NULL}, 3454, "tcp"},
{"prsvp",              {NULL}, 3455, "tcp"},
{"prsvp",              {NULL}, 3455, "udp"},
{"vat",                {NULL}, 3456, "tcp"},
{"vat",                {NULL}, 3456, "udp"},
{"vat-control",        {NULL}, 3457, "tcp"},
{"vat-control",        {NULL}, 3457, "udp"},
{"d3winosfi",          {NULL}, 3458, "tcp"},
{"d3winosfi",          {NULL}, 3458, "udp"},
{"integral",           {NULL}, 3459, "tcp"},
{"integral",           {NULL}, 3459, "udp"},
{"edm-manager",        {NULL}, 3460, "tcp"},
{"edm-manager",        {NULL}, 3460, "udp"},
{"edm-stager",         {NULL}, 3461, "tcp"},
{"edm-stager",         {NULL}, 3461, "udp"},
{"edm-std-notify",     {NULL}, 3462, "tcp"},
{"edm-std-notify",     {NULL}, 3462, "udp"},
{"edm-adm-notify",     {NULL}, 3463, "tcp"},
{"edm-adm-notify",     {NULL}, 3463, "udp"},
{"edm-mgr-sync",       {NULL}, 3464, "tcp"},
{"edm-mgr-sync",       {NULL}, 3464, "udp"},
{"edm-mgr-cntrl",      {NULL}, 3465, "tcp"},
{"edm-mgr-cntrl",      {NULL}, 3465, "udp"},
{"workflow",           {NULL}, 3466, "tcp"},
{"workflow",           {NULL}, 3466, "udp"},
{"rcst",               {NULL}, 3467, "tcp"},
{"rcst",               {NULL}, 3467, "udp"},
{"ttcmremotectrl",     {NULL}, 3468, "tcp"},
{"ttcmremotectrl",     {NULL}, 3468, "udp"},
{"pluribus",           {NULL}, 3469, "tcp"},
{"pluribus",           {NULL}, 3469, "udp"},
{"jt400",              {NULL}, 3470, "tcp"},
{"jt400",              {NULL}, 3470, "udp"},
{"jt400-ssl",          {NULL}, 3471, "tcp"},
{"jt400-ssl",          {NULL}, 3471, "udp"},
{"jaugsremotec-1",     {NULL}, 3472, "tcp"},
{"jaugsremotec-1",     {NULL}, 3472, "udp"},
{"jaugsremotec-2",     {NULL}, 3473, "tcp"},
{"jaugsremotec-2",     {NULL}, 3473, "udp"},
{"ttntspauto",         {NULL}, 3474, "tcp"},
{"ttntspauto",         {NULL}, 3474, "udp"},
{"genisar-port",       {NULL}, 3475, "tcp"},
{"genisar-port",       {NULL}, 3475, "udp"},
{"nppmp",              {NULL}, 3476, "tcp"},
{"nppmp",              {NULL}, 3476, "udp"},
{"ecomm",              {NULL}, 3477, "tcp"},
{"ecomm",              {NULL}, 3477, "udp"},
{"stun",               {NULL}, 3478, "tcp"},
{"stun",               {NULL}, 3478, "udp"},
{"turn",               {NULL}, 3478, "tcp"},
{"turn",               {NULL}, 3478, "udp"},
{"stun-behavior",      {NULL}, 3478, "tcp"},
{"stun-behavior",      {NULL}, 3478, "udp"},
{"twrpc",              {NULL}, 3479, "tcp"},
{"twrpc",              {NULL}, 3479, "udp"},
{"plethora",           {NULL}, 3480, "tcp"},
{"plethora",           {NULL}, 3480, "udp"},
{"cleanerliverc",      {NULL}, 3481, "tcp"},
{"cleanerliverc",      {NULL}, 3481, "udp"},
{"vulture",            {NULL}, 3482, "tcp"},
{"vulture",            {NULL}, 3482, "udp"},
{"slim-devices",       {NULL}, 3483, "tcp"},
{"slim-devices",       {NULL}, 3483, "udp"},
{"gbs-stp",            {NULL}, 3484, "tcp"},
{"gbs-stp",            {NULL}, 3484, "udp"},
{"celatalk",           {NULL}, 3485, "tcp"},
{"celatalk",           {NULL}, 3485, "udp"},
{"ifsf-hb-port",       {NULL}, 3486, "tcp"},
{"ifsf-hb-port",       {NULL}, 3486, "udp"},
{"ltctcp",             {NULL}, 3487, "tcp"},
{"ltcudp",             {NULL}, 3487, "udp"},
{"fs-rh-srv",          {NULL}, 3488, "tcp"},
{"fs-rh-srv",          {NULL}, 3488, "udp"},
{"dtp-dia",            {NULL}, 3489, "tcp"},
{"dtp-dia",            {NULL}, 3489, "udp"},
{"colubris",           {NULL}, 3490, "tcp"},
{"colubris",           {NULL}, 3490, "udp"},
{"swr-port",           {NULL}, 3491, "tcp"},
{"swr-port",           {NULL}, 3491, "udp"},
{"tvdumtray-port",     {NULL}, 3492, "tcp"},
{"tvdumtray-port",     {NULL}, 3492, "udp"},
{"nut",                {NULL}, 3493, "tcp"},
{"nut",                {NULL}, 3493, "udp"},
{"ibm3494",            {NULL}, 3494, "tcp"},
{"ibm3494",            {NULL}, 3494, "udp"},
{"seclayer-tcp",       {NULL}, 3495, "tcp"},
{"seclayer-tcp",       {NULL}, 3495, "udp"},
{"seclayer-tls",       {NULL}, 3496, "tcp"},
{"seclayer-tls",       {NULL}, 3496, "udp"},
{"ipether232port",     {NULL}, 3497, "tcp"},
{"ipether232port",     {NULL}, 3497, "udp"},
{"dashpas-port",       {NULL}, 3498, "tcp"},
{"dashpas-port",       {NULL}, 3498, "udp"},
{"sccip-media",        {NULL}, 3499, "tcp"},
{"sccip-media",        {NULL}, 3499, "udp"},
{"rtmp-port",          {NULL}, 3500, "tcp"},
{"rtmp-port",          {NULL}, 3500, "udp"},
{"isoft-p2p",          {NULL}, 3501, "tcp"},
{"isoft-p2p",          {NULL}, 3501, "udp"},
{"avinstalldisc",      {NULL}, 3502, "tcp"},
{"avinstalldisc",      {NULL}, 3502, "udp"},
{"lsp-ping",           {NULL}, 3503, "tcp"},
{"lsp-ping",           {NULL}, 3503, "udp"},
{"ironstorm",          {NULL}, 3504, "tcp"},
{"ironstorm",          {NULL}, 3504, "udp"},
{"ccmcomm",            {NULL}, 3505, "tcp"},
{"ccmcomm",            {NULL}, 3505, "udp"},
{"apc-3506",           {NULL}, 3506, "tcp"},
{"apc-3506",           {NULL}, 3506, "udp"},
{"nesh-broker",        {NULL}, 3507, "tcp"},
{"nesh-broker",        {NULL}, 3507, "udp"},
{"interactionweb",     {NULL}, 3508, "tcp"},
{"interactionweb",     {NULL}, 3508, "udp"},
{"vt-ssl",             {NULL}, 3509, "tcp"},
{"vt-ssl",             {NULL}, 3509, "udp"},
{"xss-port",           {NULL}, 3510, "tcp"},
{"xss-port",           {NULL}, 3510, "udp"},
{"webmail-2",          {NULL}, 3511, "tcp"},
{"webmail-2",          {NULL}, 3511, "udp"},
{"aztec",              {NULL}, 3512, "tcp"},
{"aztec",              {NULL}, 3512, "udp"},
{"arcpd",              {NULL}, 3513, "tcp"},
{"arcpd",              {NULL}, 3513, "udp"},
{"must-p2p",           {NULL}, 3514, "tcp"},
{"must-p2p",           {NULL}, 3514, "udp"},
{"must-backplane",     {NULL}, 3515, "tcp"},
{"must-backplane",     {NULL}, 3515, "udp"},
{"smartcard-port",     {NULL}, 3516, "tcp"},
{"smartcard-port",     {NULL}, 3516, "udp"},
{"802-11-iapp",        {NULL}, 3517, "tcp"},
{"802-11-iapp",        {NULL}, 3517, "udp"},
{"artifact-msg",       {NULL}, 3518, "tcp"},
{"artifact-msg",       {NULL}, 3518, "udp"},
{"nvmsgd",             {NULL}, 3519, "tcp"},
{"galileo",            {NULL}, 3519, "udp"},
{"galileolog",         {NULL}, 3520, "tcp"},
{"galileolog",         {NULL}, 3520, "udp"},
{"mc3ss",              {NULL}, 3521, "tcp"},
{"mc3ss",              {NULL}, 3521, "udp"},
{"nssocketport",       {NULL}, 3522, "tcp"},
{"nssocketport",       {NULL}, 3522, "udp"},
{"odeumservlink",      {NULL}, 3523, "tcp"},
{"odeumservlink",      {NULL}, 3523, "udp"},
{"ecmport",            {NULL}, 3524, "tcp"},
{"ecmport",            {NULL}, 3524, "udp"},
{"eisport",            {NULL}, 3525, "tcp"},
{"eisport",            {NULL}, 3525, "udp"},
{"starquiz-port",      {NULL}, 3526, "tcp"},
{"starquiz-port",      {NULL}, 3526, "udp"},
{"beserver-msg-q",     {NULL}, 3527, "tcp"},
{"beserver-msg-q",     {NULL}, 3527, "udp"},
{"jboss-iiop",         {NULL}, 3528, "tcp"},
{"jboss-iiop",         {NULL}, 3528, "udp"},
{"jboss-iiop-ssl",     {NULL}, 3529, "tcp"},
{"jboss-iiop-ssl",     {NULL}, 3529, "udp"},
{"gf",                 {NULL}, 3530, "tcp"},
{"gf",                 {NULL}, 3530, "udp"},
{"joltid",             {NULL}, 3531, "tcp"},
{"joltid",             {NULL}, 3531, "udp"},
{"raven-rmp",          {NULL}, 3532, "tcp"},
{"raven-rmp",          {NULL}, 3532, "udp"},
{"raven-rdp",          {NULL}, 3533, "tcp"},
{"raven-rdp",          {NULL}, 3533, "udp"},
{"urld-port",          {NULL}, 3534, "tcp"},
{"urld-port",          {NULL}, 3534, "udp"},
{"ms-la",              {NULL}, 3535, "tcp"},
{"ms-la",              {NULL}, 3535, "udp"},
{"snac",               {NULL}, 3536, "tcp"},
{"snac",               {NULL}, 3536, "udp"},
{"ni-visa-remote",     {NULL}, 3537, "tcp"},
{"ni-visa-remote",     {NULL}, 3537, "udp"},
{"ibm-diradm",         {NULL}, 3538, "tcp"},
{"ibm-diradm",         {NULL}, 3538, "udp"},
{"ibm-diradm-ssl",     {NULL}, 3539, "tcp"},
{"ibm-diradm-ssl",     {NULL}, 3539, "udp"},
{"pnrp-port",          {NULL}, 3540, "tcp"},
{"pnrp-port",          {NULL}, 3540, "udp"},
{"voispeed-port",      {NULL}, 3541, "tcp"},
{"voispeed-port",      {NULL}, 3541, "udp"},
{"hacl-monitor",       {NULL}, 3542, "tcp"},
{"hacl-monitor",       {NULL}, 3542, "udp"},
{"qftest-lookup",      {NULL}, 3543, "tcp"},
{"qftest-lookup",      {NULL}, 3543, "udp"},
{"teredo",             {NULL}, 3544, "tcp"},
{"teredo",             {NULL}, 3544, "udp"},
{"camac",              {NULL}, 3545, "tcp"},
{"camac",              {NULL}, 3545, "udp"},
{"symantec-sim",       {NULL}, 3547, "tcp"},
{"symantec-sim",       {NULL}, 3547, "udp"},
{"interworld",         {NULL}, 3548, "tcp"},
{"interworld",         {NULL}, 3548, "udp"},
{"tellumat-nms",       {NULL}, 3549, "tcp"},
{"tellumat-nms",       {NULL}, 3549, "udp"},
{"ssmpp",              {NULL}, 3550, "tcp"},
{"ssmpp",              {NULL}, 3550, "udp"},
{"apcupsd",            {NULL}, 3551, "tcp"},
{"apcupsd",            {NULL}, 3551, "udp"},
{"taserver",           {NULL}, 3552, "tcp"},
{"taserver",           {NULL}, 3552, "udp"},
{"rbr-discovery",      {NULL}, 3553, "tcp"},
{"rbr-discovery",      {NULL}, 3553, "udp"},
{"questnotify",        {NULL}, 3554, "tcp"},
{"questnotify",        {NULL}, 3554, "udp"},
{"razor",              {NULL}, 3555, "tcp"},
{"razor",              {NULL}, 3555, "udp"},
{"sky-transport",      {NULL}, 3556, "tcp"},
{"sky-transport",      {NULL}, 3556, "udp"},
{"personalos-001",     {NULL}, 3557, "tcp"},
{"personalos-001",     {NULL}, 3557, "udp"},
{"mcp-port",           {NULL}, 3558, "tcp"},
{"mcp-port",           {NULL}, 3558, "udp"},
{"cctv-port",          {NULL}, 3559, "tcp"},
{"cctv-port",          {NULL}, 3559, "udp"},
{"iniserve-port",      {NULL}, 3560, "tcp"},
{"iniserve-port",      {NULL}, 3560, "udp"},
{"bmc-onekey",         {NULL}, 3561, "tcp"},
{"bmc-onekey",         {NULL}, 3561, "udp"},
{"sdbproxy",           {NULL}, 3562, "tcp"},
{"sdbproxy",           {NULL}, 3562, "udp"},
{"watcomdebug",        {NULL}, 3563, "tcp"},
{"watcomdebug",        {NULL}, 3563, "udp"},
{"esimport",           {NULL}, 3564, "tcp"},
{"esimport",           {NULL}, 3564, "udp"},
{"m2pa",               {NULL}, 3565, "tcp"},
{"m2pa",               {NULL}, 3565, "sctp"},
{"quest-data-hub",     {NULL}, 3566, "tcp"},
{"oap",                {NULL}, 3567, "tcp"},
{"oap",                {NULL}, 3567, "udp"},
{"oap-s",              {NULL}, 3568, "tcp"},
{"oap-s",              {NULL}, 3568, "udp"},
{"mbg-ctrl",           {NULL}, 3569, "tcp"},
{"mbg-ctrl",           {NULL}, 3569, "udp"},
{"mccwebsvr-port",     {NULL}, 3570, "tcp"},
{"mccwebsvr-port",     {NULL}, 3570, "udp"},
{"megardsvr-port",     {NULL}, 3571, "tcp"},
{"megardsvr-port",     {NULL}, 3571, "udp"},
{"megaregsvrport",     {NULL}, 3572, "tcp"},
{"megaregsvrport",     {NULL}, 3572, "udp"},
{"tag-ups-1",          {NULL}, 3573, "tcp"},
{"tag-ups-1",          {NULL}, 3573, "udp"},
{"dmaf-server",        {NULL}, 3574, "tcp"},
{"dmaf-caster",        {NULL}, 3574, "udp"},
{"ccm-port",           {NULL}, 3575, "tcp"},
{"ccm-port",           {NULL}, 3575, "udp"},
{"cmc-port",           {NULL}, 3576, "tcp"},
{"cmc-port",           {NULL}, 3576, "udp"},
{"config-port",        {NULL}, 3577, "tcp"},
{"config-port",        {NULL}, 3577, "udp"},
{"data-port",          {NULL}, 3578, "tcp"},
{"data-port",          {NULL}, 3578, "udp"},
{"ttat3lb",            {NULL}, 3579, "tcp"},
{"ttat3lb",            {NULL}, 3579, "udp"},
{"nati-svrloc",        {NULL}, 3580, "tcp"},
{"nati-svrloc",        {NULL}, 3580, "udp"},
{"kfxaclicensing",     {NULL}, 3581, "tcp"},
{"kfxaclicensing",     {NULL}, 3581, "udp"},
{"press",              {NULL}, 3582, "tcp"},
{"press",              {NULL}, 3582, "udp"},
{"canex-watch",        {NULL}, 3583, "tcp"},
{"canex-watch",        {NULL}, 3583, "udp"},
{"u-dbap",             {NULL}, 3584, "tcp"},
{"u-dbap",             {NULL}, 3584, "udp"},
{"emprise-lls",        {NULL}, 3585, "tcp"},
{"emprise-lls",        {NULL}, 3585, "udp"},
{"emprise-lsc",        {NULL}, 3586, "tcp"},
{"emprise-lsc",        {NULL}, 3586, "udp"},
{"p2pgroup",           {NULL}, 3587, "tcp"},
{"p2pgroup",           {NULL}, 3587, "udp"},
{"sentinel",           {NULL}, 3588, "tcp"},
{"sentinel",           {NULL}, 3588, "udp"},
{"isomair",            {NULL}, 3589, "tcp"},
{"isomair",            {NULL}, 3589, "udp"},
{"wv-csp-sms",         {NULL}, 3590, "tcp"},
{"wv-csp-sms",         {NULL}, 3590, "udp"},
{"gtrack-server",      {NULL}, 3591, "tcp"},
{"gtrack-server",      {NULL}, 3591, "udp"},
{"gtrack-ne",          {NULL}, 3592, "tcp"},
{"gtrack-ne",          {NULL}, 3592, "udp"},
{"bpmd",               {NULL}, 3593, "tcp"},
{"bpmd",               {NULL}, 3593, "udp"},
{"mediaspace",         {NULL}, 3594, "tcp"},
{"mediaspace",         {NULL}, 3594, "udp"},
{"shareapp",           {NULL}, 3595, "tcp"},
{"shareapp",           {NULL}, 3595, "udp"},
{"iw-mmogame",         {NULL}, 3596, "tcp"},
{"iw-mmogame",         {NULL}, 3596, "udp"},
{"a14",                {NULL}, 3597, "tcp"},
{"a14",                {NULL}, 3597, "udp"},
{"a15",                {NULL}, 3598, "tcp"},
{"a15",                {NULL}, 3598, "udp"},
{"quasar-server",      {NULL}, 3599, "tcp"},
{"quasar-server",      {NULL}, 3599, "udp"},
{"trap-daemon",        {NULL}, 3600, "tcp"},
{"trap-daemon",        {NULL}, 3600, "udp"},
{"visinet-gui",        {NULL}, 3601, "tcp"},
{"visinet-gui",        {NULL}, 3601, "udp"},
{"infiniswitchcl",     {NULL}, 3602, "tcp"},
{"infiniswitchcl",     {NULL}, 3602, "udp"},
{"int-rcv-cntrl",      {NULL}, 3603, "tcp"},
{"int-rcv-cntrl",      {NULL}, 3603, "udp"},
{"bmc-jmx-port",       {NULL}, 3604, "tcp"},
{"bmc-jmx-port",       {NULL}, 3604, "udp"},
{"comcam-io",          {NULL}, 3605, "tcp"},
{"comcam-io",          {NULL}, 3605, "udp"},
{"splitlock",          {NULL}, 3606, "tcp"},
{"splitlock",          {NULL}, 3606, "udp"},
{"precise-i3",         {NULL}, 3607, "tcp"},
{"precise-i3",         {NULL}, 3607, "udp"},
{"trendchip-dcp",      {NULL}, 3608, "tcp"},
{"trendchip-dcp",      {NULL}, 3608, "udp"},
{"cpdi-pidas-cm",      {NULL}, 3609, "tcp"},
{"cpdi-pidas-cm",      {NULL}, 3609, "udp"},
{"echonet",            {NULL}, 3610, "tcp"},
{"echonet",            {NULL}, 3610, "udp"},
{"six-degrees",        {NULL}, 3611, "tcp"},
{"six-degrees",        {NULL}, 3611, "udp"},
{"hp-dataprotect",     {NULL}, 3612, "tcp"},
{"hp-dataprotect",     {NULL}, 3612, "udp"},
{"alaris-disc",        {NULL}, 3613, "tcp"},
{"alaris-disc",        {NULL}, 3613, "udp"},
{"sigma-port",         {NULL}, 3614, "tcp"},
{"sigma-port",         {NULL}, 3614, "udp"},
{"start-network",      {NULL}, 3615, "tcp"},
{"start-network",      {NULL}, 3615, "udp"},
{"cd3o-protocol",      {NULL}, 3616, "tcp"},
{"cd3o-protocol",      {NULL}, 3616, "udp"},
{"sharp-server",       {NULL}, 3617, "tcp"},
{"sharp-server",       {NULL}, 3617, "udp"},
{"aairnet-1",          {NULL}, 3618, "tcp"},
{"aairnet-1",          {NULL}, 3618, "udp"},
{"aairnet-2",          {NULL}, 3619, "tcp"},
{"aairnet-2",          {NULL}, 3619, "udp"},
{"ep-pcp",             {NULL}, 3620, "tcp"},
{"ep-pcp",             {NULL}, 3620, "udp"},
{"ep-nsp",             {NULL}, 3621, "tcp"},
{"ep-nsp",             {NULL}, 3621, "udp"},
{"ff-lr-port",         {NULL}, 3622, "tcp"},
{"ff-lr-port",         {NULL}, 3622, "udp"},
{"haipe-discover",     {NULL}, 3623, "tcp"},
{"haipe-discover",     {NULL}, 3623, "udp"},
{"dist-upgrade",       {NULL}, 3624, "tcp"},
{"dist-upgrade",       {NULL}, 3624, "udp"},
{"volley",             {NULL}, 3625, "tcp"},
{"volley",             {NULL}, 3625, "udp"},
{"bvcdaemon-port",     {NULL}, 3626, "tcp"},
{"bvcdaemon-port",     {NULL}, 3626, "udp"},
{"jamserverport",      {NULL}, 3627, "tcp"},
{"jamserverport",      {NULL}, 3627, "udp"},
{"ept-machine",        {NULL}, 3628, "tcp"},
{"ept-machine",        {NULL}, 3628, "udp"},
{"escvpnet",           {NULL}, 3629, "tcp"},
{"escvpnet",           {NULL}, 3629, "udp"},
{"cs-remote-db",       {NULL}, 3630, "tcp"},
{"cs-remote-db",       {NULL}, 3630, "udp"},
{"cs-services",        {NULL}, 3631, "tcp"},
{"cs-services",        {NULL}, 3631, "udp"},
{"distcc",             {NULL}, 3632, "tcp"},
{"distcc",             {NULL}, 3632, "udp"},
{"wacp",               {NULL}, 3633, "tcp"},
{"wacp",               {NULL}, 3633, "udp"},
{"hlibmgr",            {NULL}, 3634, "tcp"},
{"hlibmgr",            {NULL}, 3634, "udp"},
{"sdo",                {NULL}, 3635, "tcp"},
{"sdo",                {NULL}, 3635, "udp"},
{"servistaitsm",       {NULL}, 3636, "tcp"},
{"servistaitsm",       {NULL}, 3636, "udp"},
{"scservp",            {NULL}, 3637, "tcp"},
{"scservp",            {NULL}, 3637, "udp"},
{"ehp-backup",         {NULL}, 3638, "tcp"},
{"ehp-backup",         {NULL}, 3638, "udp"},
{"xap-ha",             {NULL}, 3639, "tcp"},
{"xap-ha",             {NULL}, 3639, "udp"},
{"netplay-port1",      {NULL}, 3640, "tcp"},
{"netplay-port1",      {NULL}, 3640, "udp"},
{"netplay-port2",      {NULL}, 3641, "tcp"},
{"netplay-port2",      {NULL}, 3641, "udp"},
{"juxml-port",         {NULL}, 3642, "tcp"},
{"juxml-port",         {NULL}, 3642, "udp"},
{"audiojuggler",       {NULL}, 3643, "tcp"},
{"audiojuggler",       {NULL}, 3643, "udp"},
{"ssowatch",           {NULL}, 3644, "tcp"},
{"ssowatch",           {NULL}, 3644, "udp"},
{"cyc",                {NULL}, 3645, "tcp"},
{"cyc",                {NULL}, 3645, "udp"},
{"xss-srv-port",       {NULL}, 3646, "tcp"},
{"xss-srv-port",       {NULL}, 3646, "udp"},
{"splitlock-gw",       {NULL}, 3647, "tcp"},
{"splitlock-gw",       {NULL}, 3647, "udp"},
{"fjcp",               {NULL}, 3648, "tcp"},
{"fjcp",               {NULL}, 3648, "udp"},
{"nmmp",               {NULL}, 3649, "tcp"},
{"nmmp",               {NULL}, 3649, "udp"},
{"prismiq-plugin",     {NULL}, 3650, "tcp"},
{"prismiq-plugin",     {NULL}, 3650, "udp"},
{"xrpc-registry",      {NULL}, 3651, "tcp"},
{"xrpc-registry",      {NULL}, 3651, "udp"},
{"vxcrnbuport",        {NULL}, 3652, "tcp"},
{"vxcrnbuport",        {NULL}, 3652, "udp"},
{"tsp",                {NULL}, 3653, "tcp"},
{"tsp",                {NULL}, 3653, "udp"},
{"vaprtm",             {NULL}, 3654, "tcp"},
{"vaprtm",             {NULL}, 3654, "udp"},
{"abatemgr",           {NULL}, 3655, "tcp"},
{"abatemgr",           {NULL}, 3655, "udp"},
{"abatjss",            {NULL}, 3656, "tcp"},
{"abatjss",            {NULL}, 3656, "udp"},
{"immedianet-bcn",     {NULL}, 3657, "tcp"},
{"immedianet-bcn",     {NULL}, 3657, "udp"},
{"ps-ams",             {NULL}, 3658, "tcp"},
{"ps-ams",             {NULL}, 3658, "udp"},
{"apple-sasl",         {NULL}, 3659, "tcp"},
{"apple-sasl",         {NULL}, 3659, "udp"},
{"can-nds-ssl",        {NULL}, 3660, "tcp"},
{"can-nds-ssl",        {NULL}, 3660, "udp"},
{"can-ferret-ssl",     {NULL}, 3661, "tcp"},
{"can-ferret-ssl",     {NULL}, 3661, "udp"},
{"pserver",            {NULL}, 3662, "tcp"},
{"pserver",            {NULL}, 3662, "udp"},
{"dtp",                {NULL}, 3663, "tcp"},
{"dtp",                {NULL}, 3663, "udp"},
{"ups-engine",         {NULL}, 3664, "tcp"},
{"ups-engine",         {NULL}, 3664, "udp"},
{"ent-engine",         {NULL}, 3665, "tcp"},
{"ent-engine",         {NULL}, 3665, "udp"},
{"eserver-pap",        {NULL}, 3666, "tcp"},
{"eserver-pap",        {NULL}, 3666, "udp"},
{"infoexch",           {NULL}, 3667, "tcp"},
{"infoexch",           {NULL}, 3667, "udp"},
{"dell-rm-port",       {NULL}, 3668, "tcp"},
{"dell-rm-port",       {NULL}, 3668, "udp"},
{"casanswmgmt",        {NULL}, 3669, "tcp"},
{"casanswmgmt",        {NULL}, 3669, "udp"},
{"smile",              {NULL}, 3670, "tcp"},
{"smile",              {NULL}, 3670, "udp"},
{"efcp",               {NULL}, 3671, "tcp"},
{"efcp",               {NULL}, 3671, "udp"},
{"lispworks-orb",      {NULL}, 3672, "tcp"},
{"lispworks-orb",      {NULL}, 3672, "udp"},
{"mediavault-gui",     {NULL}, 3673, "tcp"},
{"mediavault-gui",     {NULL}, 3673, "udp"},
{"wininstall-ipc",     {NULL}, 3674, "tcp"},
{"wininstall-ipc",     {NULL}, 3674, "udp"},
{"calltrax",           {NULL}, 3675, "tcp"},
{"calltrax",           {NULL}, 3675, "udp"},
{"va-pacbase",         {NULL}, 3676, "tcp"},
{"va-pacbase",         {NULL}, 3676, "udp"},
{"roverlog",           {NULL}, 3677, "tcp"},
{"roverlog",           {NULL}, 3677, "udp"},
{"ipr-dglt",           {NULL}, 3678, "tcp"},
{"ipr-dglt",           {NULL}, 3678, "udp"},
{"newton-dock",        {NULL}, 3679, "tcp"},
{"newton-dock",        {NULL}, 3679, "udp"},
{"npds-tracker",       {NULL}, 3680, "tcp"},
{"npds-tracker",       {NULL}, 3680, "udp"},
{"bts-x73",            {NULL}, 3681, "tcp"},
{"bts-x73",            {NULL}, 3681, "udp"},
{"cas-mapi",           {NULL}, 3682, "tcp"},
{"cas-mapi",           {NULL}, 3682, "udp"},
{"bmc-ea",             {NULL}, 3683, "tcp"},
{"bmc-ea",             {NULL}, 3683, "udp"},
{"faxstfx-port",       {NULL}, 3684, "tcp"},
{"faxstfx-port",       {NULL}, 3684, "udp"},
{"dsx-agent",          {NULL}, 3685, "tcp"},
{"dsx-agent",          {NULL}, 3685, "udp"},
{"tnmpv2",             {NULL}, 3686, "tcp"},
{"tnmpv2",             {NULL}, 3686, "udp"},
{"simple-push",        {NULL}, 3687, "tcp"},
{"simple-push",        {NULL}, 3687, "udp"},
{"simple-push-s",      {NULL}, 3688, "tcp"},
{"simple-push-s",      {NULL}, 3688, "udp"},
{"daap",               {NULL}, 3689, "tcp"},
{"daap",               {NULL}, 3689, "udp"},
{"svn",                {NULL}, 3690, "tcp"},
{"svn",                {NULL}, 3690, "udp"},
{"magaya-network",     {NULL}, 3691, "tcp"},
{"magaya-network",     {NULL}, 3691, "udp"},
{"intelsync",          {NULL}, 3692, "tcp"},
{"intelsync",          {NULL}, 3692, "udp"},
{"bmc-data-coll",      {NULL}, 3695, "tcp"},
{"bmc-data-coll",      {NULL}, 3695, "udp"},
{"telnetcpcd",         {NULL}, 3696, "tcp"},
{"telnetcpcd",         {NULL}, 3696, "udp"},
{"nw-license",         {NULL}, 3697, "tcp"},
{"nw-license",         {NULL}, 3697, "udp"},
{"sagectlpanel",       {NULL}, 3698, "tcp"},
{"sagectlpanel",       {NULL}, 3698, "udp"},
{"kpn-icw",            {NULL}, 3699, "tcp"},
{"kpn-icw",            {NULL}, 3699, "udp"},
{"lrs-paging",         {NULL}, 3700, "tcp"},
{"lrs-paging",         {NULL}, 3700, "udp"},
{"netcelera",          {NULL}, 3701, "tcp"},
{"netcelera",          {NULL}, 3701, "udp"},
{"ws-discovery",       {NULL}, 3702, "tcp"},
{"ws-discovery",       {NULL}, 3702, "udp"},
{"adobeserver-3",      {NULL}, 3703, "tcp"},
{"adobeserver-3",      {NULL}, 3703, "udp"},
{"adobeserver-4",      {NULL}, 3704, "tcp"},
{"adobeserver-4",      {NULL}, 3704, "udp"},
{"adobeserver-5",      {NULL}, 3705, "tcp"},
{"adobeserver-5",      {NULL}, 3705, "udp"},
{"rt-event",           {NULL}, 3706, "tcp"},
{"rt-event",           {NULL}, 3706, "udp"},
{"rt-event-s",         {NULL}, 3707, "tcp"},
{"rt-event-s",         {NULL}, 3707, "udp"},
{"sun-as-iiops",       {NULL}, 3708, "tcp"},
{"sun-as-iiops",       {NULL}, 3708, "udp"},
{"ca-idms",            {NULL}, 3709, "tcp"},
{"ca-idms",            {NULL}, 3709, "udp"},
{"portgate-auth",      {NULL}, 3710, "tcp"},
{"portgate-auth",      {NULL}, 3710, "udp"},
{"edb-server2",        {NULL}, 3711, "tcp"},
{"edb-server2",        {NULL}, 3711, "udp"},
{"sentinel-ent",       {NULL}, 3712, "tcp"},
{"sentinel-ent",       {NULL}, 3712, "udp"},
{"tftps",              {NULL}, 3713, "tcp"},
{"tftps",              {NULL}, 3713, "udp"},
{"delos-dms",          {NULL}, 3714, "tcp"},
{"delos-dms",          {NULL}, 3714, "udp"},
{"anoto-rendezv",      {NULL}, 3715, "tcp"},
{"anoto-rendezv",      {NULL}, 3715, "udp"},
{"wv-csp-sms-cir",     {NULL}, 3716, "tcp"},
{"wv-csp-sms-cir",     {NULL}, 3716, "udp"},
{"wv-csp-udp-cir",     {NULL}, 3717, "tcp"},
{"wv-csp-udp-cir",     {NULL}, 3717, "udp"},
{"opus-services",      {NULL}, 3718, "tcp"},
{"opus-services",      {NULL}, 3718, "udp"},
{"itelserverport",     {NULL}, 3719, "tcp"},
{"itelserverport",     {NULL}, 3719, "udp"},
{"ufastro-instr",      {NULL}, 3720, "tcp"},
{"ufastro-instr",      {NULL}, 3720, "udp"},
{"xsync",              {NULL}, 3721, "tcp"},
{"xsync",              {NULL}, 3721, "udp"},
{"xserveraid",         {NULL}, 3722, "tcp"},
{"xserveraid",         {NULL}, 3722, "udp"},
{"sychrond",           {NULL}, 3723, "tcp"},
{"sychrond",           {NULL}, 3723, "udp"},
{"blizwow",            {NULL}, 3724, "tcp"},
{"blizwow",            {NULL}, 3724, "udp"},
{"na-er-tip",          {NULL}, 3725, "tcp"},
{"na-er-tip",          {NULL}, 3725, "udp"},
{"array-manager",      {NULL}, 3726, "tcp"},
{"array-manager",      {NULL}, 3726, "udp"},
{"e-mdu",              {NULL}, 3727, "tcp"},
{"e-mdu",              {NULL}, 3727, "udp"},
{"e-woa",              {NULL}, 3728, "tcp"},
{"e-woa",              {NULL}, 3728, "udp"},
{"fksp-audit",         {NULL}, 3729, "tcp"},
{"fksp-audit",         {NULL}, 3729, "udp"},
{"client-ctrl",        {NULL}, 3730, "tcp"},
{"client-ctrl",        {NULL}, 3730, "udp"},
{"smap",               {NULL}, 3731, "tcp"},
{"smap",               {NULL}, 3731, "udp"},
{"m-wnn",              {NULL}, 3732, "tcp"},
{"m-wnn",              {NULL}, 3732, "udp"},
{"multip-msg",         {NULL}, 3733, "tcp"},
{"multip-msg",         {NULL}, 3733, "udp"},
{"synel-data",         {NULL}, 3734, "tcp"},
{"synel-data",         {NULL}, 3734, "udp"},
{"pwdis",              {NULL}, 3735, "tcp"},
{"pwdis",              {NULL}, 3735, "udp"},
{"rs-rmi",             {NULL}, 3736, "tcp"},
{"rs-rmi",             {NULL}, 3736, "udp"},
{"xpanel",             {NULL}, 3737, "tcp"},
{"versatalk",          {NULL}, 3738, "tcp"},
{"versatalk",          {NULL}, 3738, "udp"},
{"launchbird-lm",      {NULL}, 3739, "tcp"},
{"launchbird-lm",      {NULL}, 3739, "udp"},
{"heartbeat",          {NULL}, 3740, "tcp"},
{"heartbeat",          {NULL}, 3740, "udp"},
{"wysdma",             {NULL}, 3741, "tcp"},
{"wysdma",             {NULL}, 3741, "udp"},
{"cst-port",           {NULL}, 3742, "tcp"},
{"cst-port",           {NULL}, 3742, "udp"},
{"ipcs-command",       {NULL}, 3743, "tcp"},
{"ipcs-command",       {NULL}, 3743, "udp"},
{"sasg",               {NULL}, 3744, "tcp"},
{"sasg",               {NULL}, 3744, "udp"},
{"gw-call-port",       {NULL}, 3745, "tcp"},
{"gw-call-port",       {NULL}, 3745, "udp"},
{"linktest",           {NULL}, 3746, "tcp"},
{"linktest",           {NULL}, 3746, "udp"},
{"linktest-s",         {NULL}, 3747, "tcp"},
{"linktest-s",         {NULL}, 3747, "udp"},
{"webdata",            {NULL}, 3748, "tcp"},
{"webdata",            {NULL}, 3748, "udp"},
{"cimtrak",            {NULL}, 3749, "tcp"},
{"cimtrak",            {NULL}, 3749, "udp"},
{"cbos-ip-port",       {NULL}, 3750, "tcp"},
{"cbos-ip-port",       {NULL}, 3750, "udp"},
{"gprs-cube",          {NULL}, 3751, "tcp"},
{"gprs-cube",          {NULL}, 3751, "udp"},
{"vipremoteagent",     {NULL}, 3752, "tcp"},
{"vipremoteagent",     {NULL}, 3752, "udp"},
{"nattyserver",        {NULL}, 3753, "tcp"},
{"nattyserver",        {NULL}, 3753, "udp"},
{"timestenbroker",     {NULL}, 3754, "tcp"},
{"timestenbroker",     {NULL}, 3754, "udp"},
{"sas-remote-hlp",     {NULL}, 3755, "tcp"},
{"sas-remote-hlp",     {NULL}, 3755, "udp"},
{"canon-capt",         {NULL}, 3756, "tcp"},
{"canon-capt",         {NULL}, 3756, "udp"},
{"grf-port",           {NULL}, 3757, "tcp"},
{"grf-port",           {NULL}, 3757, "udp"},
{"apw-registry",       {NULL}, 3758, "tcp"},
{"apw-registry",       {NULL}, 3758, "udp"},
{"exapt-lmgr",         {NULL}, 3759, "tcp"},
{"exapt-lmgr",         {NULL}, 3759, "udp"},
{"adtempusclient",     {NULL}, 3760, "tcp"},
{"adtempusclient",     {NULL}, 3760, "udp"},
{"gsakmp",             {NULL}, 3761, "tcp"},
{"gsakmp",             {NULL}, 3761, "udp"},
{"gbs-smp",            {NULL}, 3762, "tcp"},
{"gbs-smp",            {NULL}, 3762, "udp"},
{"xo-wave",            {NULL}, 3763, "tcp"},
{"xo-wave",            {NULL}, 3763, "udp"},
{"mni-prot-rout",      {NULL}, 3764, "tcp"},
{"mni-prot-rout",      {NULL}, 3764, "udp"},
{"rtraceroute",        {NULL}, 3765, "tcp"},
{"rtraceroute",        {NULL}, 3765, "udp"},
{"listmgr-port",       {NULL}, 3767, "tcp"},
{"listmgr-port",       {NULL}, 3767, "udp"},
{"rblcheckd",          {NULL}, 3768, "tcp"},
{"rblcheckd",          {NULL}, 3768, "udp"},
{"haipe-otnk",         {NULL}, 3769, "tcp"},
{"haipe-otnk",         {NULL}, 3769, "udp"},
{"cindycollab",        {NULL}, 3770, "tcp"},
{"cindycollab",        {NULL}, 3770, "udp"},
{"paging-port",        {NULL}, 3771, "tcp"},
{"paging-port",        {NULL}, 3771, "udp"},
{"ctp",                {NULL}, 3772, "tcp"},
{"ctp",                {NULL}, 3772, "udp"},
{"ctdhercules",        {NULL}, 3773, "tcp"},
{"ctdhercules",        {NULL}, 3773, "udp"},
{"zicom",              {NULL}, 3774, "tcp"},
{"zicom",              {NULL}, 3774, "udp"},
{"ispmmgr",            {NULL}, 3775, "tcp"},
{"ispmmgr",            {NULL}, 3775, "udp"},
{"dvcprov-port",       {NULL}, 3776, "tcp"},
{"dvcprov-port",       {NULL}, 3776, "udp"},
{"jibe-eb",            {NULL}, 3777, "tcp"},
{"jibe-eb",            {NULL}, 3777, "udp"},
{"c-h-it-port",        {NULL}, 3778, "tcp"},
{"c-h-it-port",        {NULL}, 3778, "udp"},
{"cognima",            {NULL}, 3779, "tcp"},
{"cognima",            {NULL}, 3779, "udp"},
{"nnp",                {NULL}, 3780, "tcp"},
{"nnp",                {NULL}, 3780, "udp"},
{"abcvoice-port",      {NULL}, 3781, "tcp"},
{"abcvoice-port",      {NULL}, 3781, "udp"},
{"iso-tp0s",           {NULL}, 3782, "tcp"},
{"iso-tp0s",           {NULL}, 3782, "udp"},
{"bim-pem",            {NULL}, 3783, "tcp"},
{"bim-pem",            {NULL}, 3783, "udp"},
{"bfd-control",        {NULL}, 3784, "tcp"},
{"bfd-control",        {NULL}, 3784, "udp"},
{"bfd-echo",           {NULL}, 3785, "tcp"},
{"bfd-echo",           {NULL}, 3785, "udp"},
{"upstriggervsw",      {NULL}, 3786, "tcp"},
{"upstriggervsw",      {NULL}, 3786, "udp"},
{"fintrx",             {NULL}, 3787, "tcp"},
{"fintrx",             {NULL}, 3787, "udp"},
{"isrp-port",          {NULL}, 3788, "tcp"},
{"isrp-port",          {NULL}, 3788, "udp"},
{"remotedeploy",       {NULL}, 3789, "tcp"},
{"remotedeploy",       {NULL}, 3789, "udp"},
{"quickbooksrds",      {NULL}, 3790, "tcp"},
{"quickbooksrds",      {NULL}, 3790, "udp"},
{"tvnetworkvideo",     {NULL}, 3791, "tcp"},
{"tvnetworkvideo",     {NULL}, 3791, "udp"},
{"sitewatch",          {NULL}, 3792, "tcp"},
{"sitewatch",          {NULL}, 3792, "udp"},
{"dcsoftware",         {NULL}, 3793, "tcp"},
{"dcsoftware",         {NULL}, 3793, "udp"},
{"jaus",               {NULL}, 3794, "tcp"},
{"jaus",               {NULL}, 3794, "udp"},
{"myblast",            {NULL}, 3795, "tcp"},
{"myblast",            {NULL}, 3795, "udp"},
{"spw-dialer",         {NULL}, 3796, "tcp"},
{"spw-dialer",         {NULL}, 3796, "udp"},
{"idps",               {NULL}, 3797, "tcp"},
{"idps",               {NULL}, 3797, "udp"},
{"minilock",           {NULL}, 3798, "tcp"},
{"minilock",           {NULL}, 3798, "udp"},
{"radius-dynauth",     {NULL}, 3799, "tcp"},
{"radius-dynauth",     {NULL}, 3799, "udp"},
{"pwgpsi",             {NULL}, 3800, "tcp"},
{"pwgpsi",             {NULL}, 3800, "udp"},
{"ibm-mgr",            {NULL}, 3801, "tcp"},
{"ibm-mgr",            {NULL}, 3801, "udp"},
{"vhd",                {NULL}, 3802, "tcp"},
{"vhd",                {NULL}, 3802, "udp"},
{"soniqsync",          {NULL}, 3803, "tcp"},
{"soniqsync",          {NULL}, 3803, "udp"},
{"iqnet-port",         {NULL}, 3804, "tcp"},
{"iqnet-port",         {NULL}, 3804, "udp"},
{"tcpdataserver",      {NULL}, 3805, "tcp"},
{"tcpdataserver",      {NULL}, 3805, "udp"},
{"wsmlb",              {NULL}, 3806, "tcp"},
{"wsmlb",              {NULL}, 3806, "udp"},
{"spugna",             {NULL}, 3807, "tcp"},
{"spugna",             {NULL}, 3807, "udp"},
{"sun-as-iiops-ca",    {NULL}, 3808, "tcp"},
{"sun-as-iiops-ca",    {NULL}, 3808, "udp"},
{"apocd",              {NULL}, 3809, "tcp"},
{"apocd",              {NULL}, 3809, "udp"},
{"wlanauth",           {NULL}, 3810, "tcp"},
{"wlanauth",           {NULL}, 3810, "udp"},
{"amp",                {NULL}, 3811, "tcp"},
{"amp",                {NULL}, 3811, "udp"},
{"neto-wol-server",    {NULL}, 3812, "tcp"},
{"neto-wol-server",    {NULL}, 3812, "udp"},
{"rap-ip",             {NULL}, 3813, "tcp"},
{"rap-ip",             {NULL}, 3813, "udp"},
{"neto-dcs",           {NULL}, 3814, "tcp"},
{"neto-dcs",           {NULL}, 3814, "udp"},
{"lansurveyorxml",     {NULL}, 3815, "tcp"},
{"lansurveyorxml",     {NULL}, 3815, "udp"},
{"sunlps-http",        {NULL}, 3816, "tcp"},
{"sunlps-http",        {NULL}, 3816, "udp"},
{"tapeware",           {NULL}, 3817, "tcp"},
{"tapeware",           {NULL}, 3817, "udp"},
{"crinis-hb",          {NULL}, 3818, "tcp"},
{"crinis-hb",          {NULL}, 3818, "udp"},
{"epl-slp",            {NULL}, 3819, "tcp"},
{"epl-slp",            {NULL}, 3819, "udp"},
{"scp",                {NULL}, 3820, "tcp"},
{"scp",                {NULL}, 3820, "udp"},
{"pmcp",               {NULL}, 3821, "tcp"},
{"pmcp",               {NULL}, 3821, "udp"},
{"acp-discovery",      {NULL}, 3822, "tcp"},
{"acp-discovery",      {NULL}, 3822, "udp"},
{"acp-conduit",        {NULL}, 3823, "tcp"},
{"acp-conduit",        {NULL}, 3823, "udp"},
{"acp-policy",         {NULL}, 3824, "tcp"},
{"acp-policy",         {NULL}, 3824, "udp"},
{"ffserver",           {NULL}, 3825, "tcp"},
{"ffserver",           {NULL}, 3825, "udp"},
{"wormux",             {NULL}, 3826, "tcp"},
{"wormux",             {NULL}, 3826, "udp"},
{"netmpi",             {NULL}, 3827, "tcp"},
{"netmpi",             {NULL}, 3827, "udp"},
{"neteh",              {NULL}, 3828, "tcp"},
{"neteh",              {NULL}, 3828, "udp"},
{"neteh-ext",          {NULL}, 3829, "tcp"},
{"neteh-ext",          {NULL}, 3829, "udp"},
{"cernsysmgmtagt",     {NULL}, 3830, "tcp"},
{"cernsysmgmtagt",     {NULL}, 3830, "udp"},
{"dvapps",             {NULL}, 3831, "tcp"},
{"dvapps",             {NULL}, 3831, "udp"},
{"xxnetserver",        {NULL}, 3832, "tcp"},
{"xxnetserver",        {NULL}, 3832, "udp"},
{"aipn-auth",          {NULL}, 3833, "tcp"},
{"aipn-auth",          {NULL}, 3833, "udp"},
{"spectardata",        {NULL}, 3834, "tcp"},
{"spectardata",        {NULL}, 3834, "udp"},
{"spectardb",          {NULL}, 3835, "tcp"},
{"spectardb",          {NULL}, 3835, "udp"},
{"markem-dcp",         {NULL}, 3836, "tcp"},
{"markem-dcp",         {NULL}, 3836, "udp"},
{"mkm-discovery",      {NULL}, 3837, "tcp"},
{"mkm-discovery",      {NULL}, 3837, "udp"},
{"sos",                {NULL}, 3838, "tcp"},
{"sos",                {NULL}, 3838, "udp"},
{"amx-rms",            {NULL}, 3839, "tcp"},
{"amx-rms",            {NULL}, 3839, "udp"},
{"flirtmitmir",        {NULL}, 3840, "tcp"},
{"flirtmitmir",        {NULL}, 3840, "udp"},
{"zfirm-shiprush3",    {NULL}, 3841, "tcp"},
{"zfirm-shiprush3",    {NULL}, 3841, "udp"},
{"nhci",               {NULL}, 3842, "tcp"},
{"nhci",               {NULL}, 3842, "udp"},
{"quest-agent",        {NULL}, 3843, "tcp"},
{"quest-agent",        {NULL}, 3843, "udp"},
{"rnm",                {NULL}, 3844, "tcp"},
{"rnm",                {NULL}, 3844, "udp"},
{"v-one-spp",          {NULL}, 3845, "tcp"},
{"v-one-spp",          {NULL}, 3845, "udp"},
{"an-pcp",             {NULL}, 3846, "tcp"},
{"an-pcp",             {NULL}, 3846, "udp"},
{"msfw-control",       {NULL}, 3847, "tcp"},
{"msfw-control",       {NULL}, 3847, "udp"},
{"item",               {NULL}, 3848, "tcp"},
{"item",               {NULL}, 3848, "udp"},
{"spw-dnspreload",     {NULL}, 3849, "tcp"},
{"spw-dnspreload",     {NULL}, 3849, "udp"},
{"qtms-bootstrap",     {NULL}, 3850, "tcp"},
{"qtms-bootstrap",     {NULL}, 3850, "udp"},
{"spectraport",        {NULL}, 3851, "tcp"},
{"spectraport",        {NULL}, 3851, "udp"},
{"sse-app-config",     {NULL}, 3852, "tcp"},
{"sse-app-config",     {NULL}, 3852, "udp"},
{"sscan",              {NULL}, 3853, "tcp"},
{"sscan",              {NULL}, 3853, "udp"},
{"stryker-com",        {NULL}, 3854, "tcp"},
{"stryker-com",        {NULL}, 3854, "udp"},
{"opentrac",           {NULL}, 3855, "tcp"},
{"opentrac",           {NULL}, 3855, "udp"},
{"informer",           {NULL}, 3856, "tcp"},
{"informer",           {NULL}, 3856, "udp"},
{"trap-port",          {NULL}, 3857, "tcp"},
{"trap-port",          {NULL}, 3857, "udp"},
{"trap-port-mom",      {NULL}, 3858, "tcp"},
{"trap-port-mom",      {NULL}, 3858, "udp"},
{"nav-port",           {NULL}, 3859, "tcp"},
{"nav-port",           {NULL}, 3859, "udp"},
{"sasp",               {NULL}, 3860, "tcp"},
{"sasp",               {NULL}, 3860, "udp"},
{"winshadow-hd",       {NULL}, 3861, "tcp"},
{"winshadow-hd",       {NULL}, 3861, "udp"},
{"giga-pocket",        {NULL}, 3862, "tcp"},
{"giga-pocket",        {NULL}, 3862, "udp"},
{"asap-tcp",           {NULL}, 3863, "tcp"},
{"asap-udp",           {NULL}, 3863, "udp"},
{"asap-sctp",          {NULL}, 3863, "sctp"},
{"asap-tcp-tls",       {NULL}, 3864, "tcp"},
{"asap-sctp-tls",      {NULL}, 3864, "sctp"},
{"xpl",                {NULL}, 3865, "tcp"},
{"xpl",                {NULL}, 3865, "udp"},
{"dzdaemon",           {NULL}, 3866, "tcp"},
{"dzdaemon",           {NULL}, 3866, "udp"},
{"dzoglserver",        {NULL}, 3867, "tcp"},
{"dzoglserver",        {NULL}, 3867, "udp"},
{"diameter",           {NULL}, 3868, "tcp"},
{"diameter",           {NULL}, 3868, "sctp"},
{"ovsam-mgmt",         {NULL}, 3869, "tcp"},
{"ovsam-mgmt",         {NULL}, 3869, "udp"},
{"ovsam-d-agent",      {NULL}, 3870, "tcp"},
{"ovsam-d-agent",      {NULL}, 3870, "udp"},
{"avocent-adsap",      {NULL}, 3871, "tcp"},
{"avocent-adsap",      {NULL}, 3871, "udp"},
{"oem-agent",          {NULL}, 3872, "tcp"},
{"oem-agent",          {NULL}, 3872, "udp"},
{"fagordnc",           {NULL}, 3873, "tcp"},
{"fagordnc",           {NULL}, 3873, "udp"},
{"sixxsconfig",        {NULL}, 3874, "tcp"},
{"sixxsconfig",        {NULL}, 3874, "udp"},
{"pnbscada",           {NULL}, 3875, "tcp"},
{"pnbscada",           {NULL}, 3875, "udp"},
{"dl_agent",           {NULL}, 3876, "tcp"},
{"dl_agent",           {NULL}, 3876, "udp"},
{"xmpcr-interface",    {NULL}, 3877, "tcp"},
{"xmpcr-interface",    {NULL}, 3877, "udp"},
{"fotogcad",           {NULL}, 3878, "tcp"},
{"fotogcad",           {NULL}, 3878, "udp"},
{"appss-lm",           {NULL}, 3879, "tcp"},
{"appss-lm",           {NULL}, 3879, "udp"},
{"igrs",               {NULL}, 3880, "tcp"},
{"igrs",               {NULL}, 3880, "udp"},
{"idac",               {NULL}, 3881, "tcp"},
{"idac",               {NULL}, 3881, "udp"},
{"msdts1",             {NULL}, 3882, "tcp"},
{"msdts1",             {NULL}, 3882, "udp"},
{"vrpn",               {NULL}, 3883, "tcp"},
{"vrpn",               {NULL}, 3883, "udp"},
{"softrack-meter",     {NULL}, 3884, "tcp"},
{"softrack-meter",     {NULL}, 3884, "udp"},
{"topflow-ssl",        {NULL}, 3885, "tcp"},
{"topflow-ssl",        {NULL}, 3885, "udp"},
{"nei-management",     {NULL}, 3886, "tcp"},
{"nei-management",     {NULL}, 3886, "udp"},
{"ciphire-data",       {NULL}, 3887, "tcp"},
{"ciphire-data",       {NULL}, 3887, "udp"},
{"ciphire-serv",       {NULL}, 3888, "tcp"},
{"ciphire-serv",       {NULL}, 3888, "udp"},
{"dandv-tester",       {NULL}, 3889, "tcp"},
{"dandv-tester",       {NULL}, 3889, "udp"},
{"ndsconnect",         {NULL}, 3890, "tcp"},
{"ndsconnect",         {NULL}, 3890, "udp"},
{"rtc-pm-port",        {NULL}, 3891, "tcp"},
{"rtc-pm-port",        {NULL}, 3891, "udp"},
{"pcc-image-port",     {NULL}, 3892, "tcp"},
{"pcc-image-port",     {NULL}, 3892, "udp"},
{"cgi-starapi",        {NULL}, 3893, "tcp"},
{"cgi-starapi",        {NULL}, 3893, "udp"},
{"syam-agent",         {NULL}, 3894, "tcp"},
{"syam-agent",         {NULL}, 3894, "udp"},
{"syam-smc",           {NULL}, 3895, "tcp"},
{"syam-smc",           {NULL}, 3895, "udp"},
{"sdo-tls",            {NULL}, 3896, "tcp"},
{"sdo-tls",            {NULL}, 3896, "udp"},
{"sdo-ssh",            {NULL}, 3897, "tcp"},
{"sdo-ssh",            {NULL}, 3897, "udp"},
{"senip",              {NULL}, 3898, "tcp"},
{"senip",              {NULL}, 3898, "udp"},
{"itv-control",        {NULL}, 3899, "tcp"},
{"itv-control",        {NULL}, 3899, "udp"},
{"udt_os",             {NULL}, 3900, "tcp"},
{"udt_os",             {NULL}, 3900, "udp"},
{"nimsh",              {NULL}, 3901, "tcp"},
{"nimsh",              {NULL}, 3901, "udp"},
{"nimaux",             {NULL}, 3902, "tcp"},
{"nimaux",             {NULL}, 3902, "udp"},
{"charsetmgr",         {NULL}, 3903, "tcp"},
{"charsetmgr",         {NULL}, 3903, "udp"},
{"omnilink-port",      {NULL}, 3904, "tcp"},
{"omnilink-port",      {NULL}, 3904, "udp"},
{"mupdate",            {NULL}, 3905, "tcp"},
{"mupdate",            {NULL}, 3905, "udp"},
{"topovista-data",     {NULL}, 3906, "tcp"},
{"topovista-data",     {NULL}, 3906, "udp"},
{"imoguia-port",       {NULL}, 3907, "tcp"},
{"imoguia-port",       {NULL}, 3907, "udp"},
{"hppronetman",        {NULL}, 3908, "tcp"},
{"hppronetman",        {NULL}, 3908, "udp"},
{"surfcontrolcpa",     {NULL}, 3909, "tcp"},
{"surfcontrolcpa",     {NULL}, 3909, "udp"},
{"prnrequest",         {NULL}, 3910, "tcp"},
{"prnrequest",         {NULL}, 3910, "udp"},
{"prnstatus",          {NULL}, 3911, "tcp"},
{"prnstatus",          {NULL}, 3911, "udp"},
{"gbmt-stars",         {NULL}, 3912, "tcp"},
{"gbmt-stars",         {NULL}, 3912, "udp"},
{"listcrt-port",       {NULL}, 3913, "tcp"},
{"listcrt-port",       {NULL}, 3913, "udp"},
{"listcrt-port-2",     {NULL}, 3914, "tcp"},
{"listcrt-port-2",     {NULL}, 3914, "udp"},
{"agcat",              {NULL}, 3915, "tcp"},
{"agcat",              {NULL}, 3915, "udp"},
{"wysdmc",             {NULL}, 3916, "tcp"},
{"wysdmc",             {NULL}, 3916, "udp"},
{"aftmux",             {NULL}, 3917, "tcp"},
{"aftmux",             {NULL}, 3917, "udp"},
{"pktcablemmcops",     {NULL}, 3918, "tcp"},
{"pktcablemmcops",     {NULL}, 3918, "udp"},
{"hyperip",            {NULL}, 3919, "tcp"},
{"hyperip",            {NULL}, 3919, "udp"},
{"exasoftport1",       {NULL}, 3920, "tcp"},
{"exasoftport1",       {NULL}, 3920, "udp"},
{"herodotus-net",      {NULL}, 3921, "tcp"},
{"herodotus-net",      {NULL}, 3921, "udp"},
{"sor-update",         {NULL}, 3922, "tcp"},
{"sor-update",         {NULL}, 3922, "udp"},
{"symb-sb-port",       {NULL}, 3923, "tcp"},
{"symb-sb-port",       {NULL}, 3923, "udp"},
{"mpl-gprs-port",      {NULL}, 3924, "tcp"},
{"mpl-gprs-port",      {NULL}, 3924, "udp"},
{"zmp",                {NULL}, 3925, "tcp"},
{"zmp",                {NULL}, 3925, "udp"},
{"winport",            {NULL}, 3926, "tcp"},
{"winport",            {NULL}, 3926, "udp"},
{"natdataservice",     {NULL}, 3927, "tcp"},
{"natdataservice",     {NULL}, 3927, "udp"},
{"netboot-pxe",        {NULL}, 3928, "tcp"},
{"netboot-pxe",        {NULL}, 3928, "udp"},
{"smauth-port",        {NULL}, 3929, "tcp"},
{"smauth-port",        {NULL}, 3929, "udp"},
{"syam-webserver",     {NULL}, 3930, "tcp"},
{"syam-webserver",     {NULL}, 3930, "udp"},
{"msr-plugin-port",    {NULL}, 3931, "tcp"},
{"msr-plugin-port",    {NULL}, 3931, "udp"},
{"dyn-site",           {NULL}, 3932, "tcp"},
{"dyn-site",           {NULL}, 3932, "udp"},
{"plbserve-port",      {NULL}, 3933, "tcp"},
{"plbserve-port",      {NULL}, 3933, "udp"},
{"sunfm-port",         {NULL}, 3934, "tcp"},
{"sunfm-port",         {NULL}, 3934, "udp"},
{"sdp-portmapper",     {NULL}, 3935, "tcp"},
{"sdp-portmapper",     {NULL}, 3935, "udp"},
{"mailprox",           {NULL}, 3936, "tcp"},
{"mailprox",           {NULL}, 3936, "udp"},
{"dvbservdsc",         {NULL}, 3937, "tcp"},
{"dvbservdsc",         {NULL}, 3937, "udp"},
{"dbcontrol_agent",    {NULL}, 3938, "tcp"},
{"dbcontrol_agent",    {NULL}, 3938, "udp"},
{"aamp",               {NULL}, 3939, "tcp"},
{"aamp",               {NULL}, 3939, "udp"},
{"xecp-node",          {NULL}, 3940, "tcp"},
{"xecp-node",          {NULL}, 3940, "udp"},
{"homeportal-web",     {NULL}, 3941, "tcp"},
{"homeportal-web",     {NULL}, 3941, "udp"},
{"srdp",               {NULL}, 3942, "tcp"},
{"srdp",               {NULL}, 3942, "udp"},
{"tig",                {NULL}, 3943, "tcp"},
{"tig",                {NULL}, 3943, "udp"},
{"sops",               {NULL}, 3944, "tcp"},
{"sops",               {NULL}, 3944, "udp"},
{"emcads",             {NULL}, 3945, "tcp"},
{"emcads",             {NULL}, 3945, "udp"},
{"backupedge",         {NULL}, 3946, "tcp"},
{"backupedge",         {NULL}, 3946, "udp"},
{"ccp",                {NULL}, 3947, "tcp"},
{"ccp",                {NULL}, 3947, "udp"},
{"apdap",              {NULL}, 3948, "tcp"},
{"apdap",              {NULL}, 3948, "udp"},
{"drip",               {NULL}, 3949, "tcp"},
{"drip",               {NULL}, 3949, "udp"},
{"namemunge",          {NULL}, 3950, "tcp"},
{"namemunge",          {NULL}, 3950, "udp"},
{"pwgippfax",          {NULL}, 3951, "tcp"},
{"pwgippfax",          {NULL}, 3951, "udp"},
{"i3-sessionmgr",      {NULL}, 3952, "tcp"},
{"i3-sessionmgr",      {NULL}, 3952, "udp"},
{"xmlink-connect",     {NULL}, 3953, "tcp"},
{"xmlink-connect",     {NULL}, 3953, "udp"},
{"adrep",              {NULL}, 3954, "tcp"},
{"adrep",              {NULL}, 3954, "udp"},
{"p2pcommunity",       {NULL}, 3955, "tcp"},
{"p2pcommunity",       {NULL}, 3955, "udp"},
{"gvcp",               {NULL}, 3956, "tcp"},
{"gvcp",               {NULL}, 3956, "udp"},
{"mqe-broker",         {NULL}, 3957, "tcp"},
{"mqe-broker",         {NULL}, 3957, "udp"},
{"mqe-agent",          {NULL}, 3958, "tcp"},
{"mqe-agent",          {NULL}, 3958, "udp"},
{"treehopper",         {NULL}, 3959, "tcp"},
{"treehopper",         {NULL}, 3959, "udp"},
{"bess",               {NULL}, 3960, "tcp"},
{"bess",               {NULL}, 3960, "udp"},
{"proaxess",           {NULL}, 3961, "tcp"},
{"proaxess",           {NULL}, 3961, "udp"},
{"sbi-agent",          {NULL}, 3962, "tcp"},
{"sbi-agent",          {NULL}, 3962, "udp"},
{"thrp",               {NULL}, 3963, "tcp"},
{"thrp",               {NULL}, 3963, "udp"},
{"sasggprs",           {NULL}, 3964, "tcp"},
{"sasggprs",           {NULL}, 3964, "udp"},
{"ati-ip-to-ncpe",     {NULL}, 3965, "tcp"},
{"ati-ip-to-ncpe",     {NULL}, 3965, "udp"},
{"bflckmgr",           {NULL}, 3966, "tcp"},
{"bflckmgr",           {NULL}, 3966, "udp"},
{"ppsms",              {NULL}, 3967, "tcp"},
{"ppsms",              {NULL}, 3967, "udp"},
{"ianywhere-dbns",     {NULL}, 3968, "tcp"},
{"ianywhere-dbns",     {NULL}, 3968, "udp"},
{"landmarks",          {NULL}, 3969, "tcp"},
{"landmarks",          {NULL}, 3969, "udp"},
{"lanrevagent",        {NULL}, 3970, "tcp"},
{"lanrevagent",        {NULL}, 3970, "udp"},
{"lanrevserver",       {NULL}, 3971, "tcp"},
{"lanrevserver",       {NULL}, 3971, "udp"},
{"iconp",              {NULL}, 3972, "tcp"},
{"iconp",              {NULL}, 3972, "udp"},
{"progistics",         {NULL}, 3973, "tcp"},
{"progistics",         {NULL}, 3973, "udp"},
{"citysearch",         {NULL}, 3974, "tcp"},
{"citysearch",         {NULL}, 3974, "udp"},
{"airshot",            {NULL}, 3975, "tcp"},
{"airshot",            {NULL}, 3975, "udp"},
{"opswagent",          {NULL}, 3976, "tcp"},
{"opswagent",          {NULL}, 3976, "udp"},
{"opswmanager",        {NULL}, 3977, "tcp"},
{"opswmanager",        {NULL}, 3977, "udp"},
{"secure-cfg-svr",     {NULL}, 3978, "tcp"},
{"secure-cfg-svr",     {NULL}, 3978, "udp"},
{"smwan",              {NULL}, 3979, "tcp"},
{"smwan",              {NULL}, 3979, "udp"},
{"acms",               {NULL}, 3980, "tcp"},
{"acms",               {NULL}, 3980, "udp"},
{"starfish",           {NULL}, 3981, "tcp"},
{"starfish",           {NULL}, 3981, "udp"},
{"eis",                {NULL}, 3982, "tcp"},
{"eis",                {NULL}, 3982, "udp"},
{"eisp",               {NULL}, 3983, "tcp"},
{"eisp",               {NULL}, 3983, "udp"},
{"mapper-nodemgr",     {NULL}, 3984, "tcp"},
{"mapper-nodemgr",     {NULL}, 3984, "udp"},
{"mapper-mapethd",     {NULL}, 3985, "tcp"},
{"mapper-mapethd",     {NULL}, 3985, "udp"},
{"mapper-ws_ethd",     {NULL}, 3986, "tcp"},
{"mapper-ws_ethd",     {NULL}, 3986, "udp"},
{"centerline",         {NULL}, 3987, "tcp"},
{"centerline",         {NULL}, 3987, "udp"},
{"dcs-config",         {NULL}, 3988, "tcp"},
{"dcs-config",         {NULL}, 3988, "udp"},
{"bv-queryengine",     {NULL}, 3989, "tcp"},
{"bv-queryengine",     {NULL}, 3989, "udp"},
{"bv-is",              {NULL}, 3990, "tcp"},
{"bv-is",              {NULL}, 3990, "udp"},
{"bv-smcsrv",          {NULL}, 3991, "tcp"},
{"bv-smcsrv",          {NULL}, 3991, "udp"},
{"bv-ds",              {NULL}, 3992, "tcp"},
{"bv-ds",              {NULL}, 3992, "udp"},
{"bv-agent",           {NULL}, 3993, "tcp"},
{"bv-agent",           {NULL}, 3993, "udp"},
{"iss-mgmt-ssl",       {NULL}, 3995, "tcp"},
{"iss-mgmt-ssl",       {NULL}, 3995, "udp"},
{"abcsoftware",        {NULL}, 3996, "tcp"},
{"abcsoftware",        {NULL}, 3996, "udp"},
{"agentsease-db",      {NULL}, 3997, "tcp"},
{"agentsease-db",      {NULL}, 3997, "udp"},
{"dnx",                {NULL}, 3998, "tcp"},
{"dnx",                {NULL}, 3998, "udp"},
{"nvcnet",             {NULL}, 3999, "tcp"},
{"nvcnet",             {NULL}, 3999, "udp"},
{"terabase",           {NULL}, 4000, "tcp"},
{"terabase",           {NULL}, 4000, "udp"},
{"newoak",             {NULL}, 4001, "tcp"},
{"newoak",             {NULL}, 4001, "udp"},
{"pxc-spvr-ft",        {NULL}, 4002, "tcp"},
{"pxc-spvr-ft",        {NULL}, 4002, "udp"},
{"pxc-splr-ft",        {NULL}, 4003, "tcp"},
{"pxc-splr-ft",        {NULL}, 4003, "udp"},
{"pxc-roid",           {NULL}, 4004, "tcp"},
{"pxc-roid",           {NULL}, 4004, "udp"},
{"pxc-pin",            {NULL}, 4005, "tcp"},
{"pxc-pin",            {NULL}, 4005, "udp"},
{"pxc-spvr",           {NULL}, 4006, "tcp"},
{"pxc-spvr",           {NULL}, 4006, "udp"},
{"pxc-splr",           {NULL}, 4007, "tcp"},
{"pxc-splr",           {NULL}, 4007, "udp"},
{"netcheque",          {NULL}, 4008, "tcp"},
{"netcheque",          {NULL}, 4008, "udp"},
{"chimera-hwm",        {NULL}, 4009, "tcp"},
{"chimera-hwm",        {NULL}, 4009, "udp"},
{"samsung-unidex",     {NULL}, 4010, "tcp"},
{"samsung-unidex",     {NULL}, 4010, "udp"},
{"altserviceboot",     {NULL}, 4011, "tcp"},
{"altserviceboot",     {NULL}, 4011, "udp"},
{"pda-gate",           {NULL}, 4012, "tcp"},
{"pda-gate",           {NULL}, 4012, "udp"},
{"acl-manager",        {NULL}, 4013, "tcp"},
{"acl-manager",        {NULL}, 4013, "udp"},
{"taiclock",           {NULL}, 4014, "tcp"},
{"taiclock",           {NULL}, 4014, "udp"},
{"talarian-mcast1",    {NULL}, 4015, "tcp"},
{"talarian-mcast1",    {NULL}, 4015, "udp"},
{"talarian-mcast2",    {NULL}, 4016, "tcp"},
{"talarian-mcast2",    {NULL}, 4016, "udp"},
{"talarian-mcast3",    {NULL}, 4017, "tcp"},
{"talarian-mcast3",    {NULL}, 4017, "udp"},
{"talarian-mcast4",    {NULL}, 4018, "tcp"},
{"talarian-mcast4",    {NULL}, 4018, "udp"},
{"talarian-mcast5",    {NULL}, 4019, "tcp"},
{"talarian-mcast5",    {NULL}, 4019, "udp"},
{"trap",               {NULL}, 4020, "tcp"},
{"trap",               {NULL}, 4020, "udp"},
{"nexus-portal",       {NULL}, 4021, "tcp"},
{"nexus-portal",       {NULL}, 4021, "udp"},
{"dnox",               {NULL}, 4022, "tcp"},
{"dnox",               {NULL}, 4022, "udp"},
{"esnm-zoning",        {NULL}, 4023, "tcp"},
{"esnm-zoning",        {NULL}, 4023, "udp"},
{"tnp1-port",          {NULL}, 4024, "tcp"},
{"tnp1-port",          {NULL}, 4024, "udp"},
{"partimage",          {NULL}, 4025, "tcp"},
{"partimage",          {NULL}, 4025, "udp"},
{"as-debug",           {NULL}, 4026, "tcp"},
{"as-debug",           {NULL}, 4026, "udp"},
{"bxp",                {NULL}, 4027, "tcp"},
{"bxp",                {NULL}, 4027, "udp"},
{"dtserver-port",      {NULL}, 4028, "tcp"},
{"dtserver-port",      {NULL}, 4028, "udp"},
{"ip-qsig",            {NULL}, 4029, "tcp"},
{"ip-qsig",            {NULL}, 4029, "udp"},
{"jdmn-port",          {NULL}, 4030, "tcp"},
{"jdmn-port",          {NULL}, 4030, "udp"},
{"suucp",              {NULL}, 4031, "tcp"},
{"suucp",              {NULL}, 4031, "udp"},
{"vrts-auth-port",     {NULL}, 4032, "tcp"},
{"vrts-auth-port",     {NULL}, 4032, "udp"},
{"sanavigator",        {NULL}, 4033, "tcp"},
{"sanavigator",        {NULL}, 4033, "udp"},
{"ubxd",               {NULL}, 4034, "tcp"},
{"ubxd",               {NULL}, 4034, "udp"},
{"wap-push-http",      {NULL}, 4035, "tcp"},
{"wap-push-http",      {NULL}, 4035, "udp"},
{"wap-push-https",     {NULL}, 4036, "tcp"},
{"wap-push-https",     {NULL}, 4036, "udp"},
{"ravehd",             {NULL}, 4037, "tcp"},
{"ravehd",             {NULL}, 4037, "udp"},
{"fazzt-ptp",          {NULL}, 4038, "tcp"},
{"fazzt-ptp",          {NULL}, 4038, "udp"},
{"fazzt-admin",        {NULL}, 4039, "tcp"},
{"fazzt-admin",        {NULL}, 4039, "udp"},
{"yo-main",            {NULL}, 4040, "tcp"},
{"yo-main",            {NULL}, 4040, "udp"},
{"houston",            {NULL}, 4041, "tcp"},
{"houston",            {NULL}, 4041, "udp"},
{"ldxp",               {NULL}, 4042, "tcp"},
{"ldxp",               {NULL}, 4042, "udp"},
{"nirp",               {NULL}, 4043, "tcp"},
{"nirp",               {NULL}, 4043, "udp"},
{"ltp",                {NULL}, 4044, "tcp"},
{"ltp",                {NULL}, 4044, "udp"},
{"npp",                {NULL}, 4045, "tcp"},
{"npp",                {NULL}, 4045, "udp"},
{"acp-proto",          {NULL}, 4046, "tcp"},
{"acp-proto",          {NULL}, 4046, "udp"},
{"ctp-state",          {NULL}, 4047, "tcp"},
{"ctp-state",          {NULL}, 4047, "udp"},
{"wafs",               {NULL}, 4049, "tcp"},
{"wafs",               {NULL}, 4049, "udp"},
{"cisco-wafs",         {NULL}, 4050, "tcp"},
{"cisco-wafs",         {NULL}, 4050, "udp"},
{"cppdp",              {NULL}, 4051, "tcp"},
{"cppdp",              {NULL}, 4051, "udp"},
{"interact",           {NULL}, 4052, "tcp"},
{"interact",           {NULL}, 4052, "udp"},
{"ccu-comm-1",         {NULL}, 4053, "tcp"},
{"ccu-comm-1",         {NULL}, 4053, "udp"},
{"ccu-comm-2",         {NULL}, 4054, "tcp"},
{"ccu-comm-2",         {NULL}, 4054, "udp"},
{"ccu-comm-3",         {NULL}, 4055, "tcp"},
{"ccu-comm-3",         {NULL}, 4055, "udp"},
{"lms",                {NULL}, 4056, "tcp"},
{"lms",                {NULL}, 4056, "udp"},
{"wfm",                {NULL}, 4057, "tcp"},
{"wfm",                {NULL}, 4057, "udp"},
{"kingfisher",         {NULL}, 4058, "tcp"},
{"kingfisher",         {NULL}, 4058, "udp"},
{"dlms-cosem",         {NULL}, 4059, "tcp"},
{"dlms-cosem",         {NULL}, 4059, "udp"},
{"dsmeter_iatc",       {NULL}, 4060, "tcp"},
{"dsmeter_iatc",       {NULL}, 4060, "udp"},
{"ice-location",       {NULL}, 4061, "tcp"},
{"ice-location",       {NULL}, 4061, "udp"},
{"ice-slocation",      {NULL}, 4062, "tcp"},
{"ice-slocation",      {NULL}, 4062, "udp"},
{"ice-router",         {NULL}, 4063, "tcp"},
{"ice-router",         {NULL}, 4063, "udp"},
{"ice-srouter",        {NULL}, 4064, "tcp"},
{"ice-srouter",        {NULL}, 4064, "udp"},
{"avanti_cdp",         {NULL}, 4065, "tcp"},
{"avanti_cdp",         {NULL}, 4065, "udp"},
{"pmas",               {NULL}, 4066, "tcp"},
{"pmas",               {NULL}, 4066, "udp"},
{"idp",                {NULL}, 4067, "tcp"},
{"idp",                {NULL}, 4067, "udp"},
{"ipfltbcst",          {NULL}, 4068, "tcp"},
{"ipfltbcst",          {NULL}, 4068, "udp"},
{"minger",             {NULL}, 4069, "tcp"},
{"minger",             {NULL}, 4069, "udp"},
{"tripe",              {NULL}, 4070, "tcp"},
{"tripe",              {NULL}, 4070, "udp"},
{"aibkup",             {NULL}, 4071, "tcp"},
{"aibkup",             {NULL}, 4071, "udp"},
{"zieto-sock",         {NULL}, 4072, "tcp"},
{"zieto-sock",         {NULL}, 4072, "udp"},
{"iRAPP",              {NULL}, 4073, "tcp"},
{"iRAPP",              {NULL}, 4073, "udp"},
{"cequint-cityid",     {NULL}, 4074, "tcp"},
{"cequint-cityid",     {NULL}, 4074, "udp"},
{"perimlan",           {NULL}, 4075, "tcp"},
{"perimlan",           {NULL}, 4075, "udp"},
{"seraph",             {NULL}, 4076, "tcp"},
{"seraph",             {NULL}, 4076, "udp"},
{"ascomalarm",         {NULL}, 4077, "udp"},
{"cssp",               {NULL}, 4078, "tcp"},
{"santools",           {NULL}, 4079, "tcp"},
{"santools",           {NULL}, 4079, "udp"},
{"lorica-in",          {NULL}, 4080, "tcp"},
{"lorica-in",          {NULL}, 4080, "udp"},
{"lorica-in-sec",      {NULL}, 4081, "tcp"},
{"lorica-in-sec",      {NULL}, 4081, "udp"},
{"lorica-out",         {NULL}, 4082, "tcp"},
{"lorica-out",         {NULL}, 4082, "udp"},
{"lorica-out-sec",     {NULL}, 4083, "tcp"},
{"lorica-out-sec",     {NULL}, 4083, "udp"},
{"fortisphere-vm",     {NULL}, 4084, "udp"},
{"ezmessagesrv",       {NULL}, 4085, "tcp"},
{"ftsync",             {NULL}, 4086, "udp"},
{"applusservice",      {NULL}, 4087, "tcp"},
{"npsp",               {NULL}, 4088, "tcp"},
{"opencore",           {NULL}, 4089, "tcp"},
{"opencore",           {NULL}, 4089, "udp"},
{"omasgport",          {NULL}, 4090, "tcp"},
{"omasgport",          {NULL}, 4090, "udp"},
{"ewinstaller",        {NULL}, 4091, "tcp"},
{"ewinstaller",        {NULL}, 4091, "udp"},
{"ewdgs",              {NULL}, 4092, "tcp"},
{"ewdgs",              {NULL}, 4092, "udp"},
{"pvxpluscs",          {NULL}, 4093, "tcp"},
{"pvxpluscs",          {NULL}, 4093, "udp"},
{"sysrqd",             {NULL}, 4094, "tcp"},
{"sysrqd",             {NULL}, 4094, "udp"},
{"xtgui",              {NULL}, 4095, "tcp"},
{"xtgui",              {NULL}, 4095, "udp"},
{"bre",                {NULL}, 4096, "tcp"},
{"bre",                {NULL}, 4096, "udp"},
{"patrolview",         {NULL}, 4097, "tcp"},
{"patrolview",         {NULL}, 4097, "udp"},
{"drmsfsd",            {NULL}, 4098, "tcp"},
{"drmsfsd",            {NULL}, 4098, "udp"},
{"dpcp",               {NULL}, 4099, "tcp"},
{"dpcp",               {NULL}, 4099, "udp"},
{"igo-incognito",      {NULL}, 4100, "tcp"},
{"igo-incognito",      {NULL}, 4100, "udp"},
{"brlp-0",             {NULL}, 4101, "tcp"},
{"brlp-0",             {NULL}, 4101, "udp"},
{"brlp-1",             {NULL}, 4102, "tcp"},
{"brlp-1",             {NULL}, 4102, "udp"},
{"brlp-2",             {NULL}, 4103, "tcp"},
{"brlp-2",             {NULL}, 4103, "udp"},
{"brlp-3",             {NULL}, 4104, "tcp"},
{"brlp-3",             {NULL}, 4104, "udp"},
{"shofarplayer",       {NULL}, 4105, "tcp"},
{"shofarplayer",       {NULL}, 4105, "udp"},
{"synchronite",        {NULL}, 4106, "tcp"},
{"synchronite",        {NULL}, 4106, "udp"},
{"j-ac",               {NULL}, 4107, "tcp"},
{"j-ac",               {NULL}, 4107, "udp"},
{"accel",              {NULL}, 4108, "tcp"},
{"accel",              {NULL}, 4108, "udp"},
{"izm",                {NULL}, 4109, "tcp"},
{"izm",                {NULL}, 4109, "udp"},
{"g2tag",              {NULL}, 4110, "tcp"},
{"g2tag",              {NULL}, 4110, "udp"},
{"xgrid",              {NULL}, 4111, "tcp"},
{"xgrid",              {NULL}, 4111, "udp"},
{"apple-vpns-rp",      {NULL}, 4112, "tcp"},
{"apple-vpns-rp",      {NULL}, 4112, "udp"},
{"aipn-reg",           {NULL}, 4113, "tcp"},
{"aipn-reg",           {NULL}, 4113, "udp"},
{"jomamqmonitor",      {NULL}, 4114, "tcp"},
{"jomamqmonitor",      {NULL}, 4114, "udp"},
{"cds",                {NULL}, 4115, "tcp"},
{"cds",                {NULL}, 4115, "udp"},
{"smartcard-tls",      {NULL}, 4116, "tcp"},
{"smartcard-tls",      {NULL}, 4116, "udp"},
{"hillrserv",          {NULL}, 4117, "tcp"},
{"hillrserv",          {NULL}, 4117, "udp"},
{"netscript",          {NULL}, 4118, "tcp"},
{"netscript",          {NULL}, 4118, "udp"},
{"assuria-slm",        {NULL}, 4119, "tcp"},
{"assuria-slm",        {NULL}, 4119, "udp"},
{"e-builder",          {NULL}, 4121, "tcp"},
{"e-builder",          {NULL}, 4121, "udp"},
{"fprams",             {NULL}, 4122, "tcp"},
{"fprams",             {NULL}, 4122, "udp"},
{"z-wave",             {NULL}, 4123, "tcp"},
{"z-wave",             {NULL}, 4123, "udp"},
{"tigv2",              {NULL}, 4124, "tcp"},
{"tigv2",              {NULL}, 4124, "udp"},
{"opsview-envoy",      {NULL}, 4125, "tcp"},
{"opsview-envoy",      {NULL}, 4125, "udp"},
{"ddrepl",             {NULL}, 4126, "tcp"},
{"ddrepl",             {NULL}, 4126, "udp"},
{"unikeypro",          {NULL}, 4127, "tcp"},
{"unikeypro",          {NULL}, 4127, "udp"},
{"nufw",               {NULL}, 4128, "tcp"},
{"nufw",               {NULL}, 4128, "udp"},
{"nuauth",             {NULL}, 4129, "tcp"},
{"nuauth",             {NULL}, 4129, "udp"},
{"fronet",             {NULL}, 4130, "tcp"},
{"fronet",             {NULL}, 4130, "udp"},
{"stars",              {NULL}, 4131, "tcp"},
{"stars",              {NULL}, 4131, "udp"},
{"nuts_dem",           {NULL}, 4132, "tcp"},
{"nuts_dem",           {NULL}, 4132, "udp"},
{"nuts_bootp",         {NULL}, 4133, "tcp"},
{"nuts_bootp",         {NULL}, 4133, "udp"},
{"nifty-hmi",          {NULL}, 4134, "tcp"},
{"nifty-hmi",          {NULL}, 4134, "udp"},
{"cl-db-attach",       {NULL}, 4135, "tcp"},
{"cl-db-attach",       {NULL}, 4135, "udp"},
{"cl-db-request",      {NULL}, 4136, "tcp"},
{"cl-db-request",      {NULL}, 4136, "udp"},
{"cl-db-remote",       {NULL}, 4137, "tcp"},
{"cl-db-remote",       {NULL}, 4137, "udp"},
{"nettest",            {NULL}, 4138, "tcp"},
{"nettest",            {NULL}, 4138, "udp"},
{"thrtx",              {NULL}, 4139, "tcp"},
{"thrtx",              {NULL}, 4139, "udp"},
{"cedros_fds",         {NULL}, 4140, "tcp"},
{"cedros_fds",         {NULL}, 4140, "udp"},
{"oirtgsvc",           {NULL}, 4141, "tcp"},
{"oirtgsvc",           {NULL}, 4141, "udp"},
{"oidocsvc",           {NULL}, 4142, "tcp"},
{"oidocsvc",           {NULL}, 4142, "udp"},
{"oidsr",              {NULL}, 4143, "tcp"},
{"oidsr",              {NULL}, 4143, "udp"},
{"vvr-control",        {NULL}, 4145, "tcp"},
{"vvr-control",        {NULL}, 4145, "udp"},
{"tgcconnect",         {NULL}, 4146, "tcp"},
{"tgcconnect",         {NULL}, 4146, "udp"},
{"vrxpservman",        {NULL}, 4147, "tcp"},
{"vrxpservman",        {NULL}, 4147, "udp"},
{"hhb-handheld",       {NULL}, 4148, "tcp"},
{"hhb-handheld",       {NULL}, 4148, "udp"},
{"agslb",              {NULL}, 4149, "tcp"},
{"agslb",              {NULL}, 4149, "udp"},
{"PowerAlert-nsa",     {NULL}, 4150, "tcp"},
{"PowerAlert-nsa",     {NULL}, 4150, "udp"},
{"menandmice_noh",     {NULL}, 4151, "tcp"},
{"menandmice_noh",     {NULL}, 4151, "udp"},
{"idig_mux",           {NULL}, 4152, "tcp"},
{"idig_mux",           {NULL}, 4152, "udp"},
{"mbl-battd",          {NULL}, 4153, "tcp"},
{"mbl-battd",          {NULL}, 4153, "udp"},
{"atlinks",            {NULL}, 4154, "tcp"},
{"atlinks",            {NULL}, 4154, "udp"},
{"bzr",                {NULL}, 4155, "tcp"},
{"bzr",                {NULL}, 4155, "udp"},
{"stat-results",       {NULL}, 4156, "tcp"},
{"stat-results",       {NULL}, 4156, "udp"},
{"stat-scanner",       {NULL}, 4157, "tcp"},
{"stat-scanner",       {NULL}, 4157, "udp"},
{"stat-cc",            {NULL}, 4158, "tcp"},
{"stat-cc",            {NULL}, 4158, "udp"},
{"nss",                {NULL}, 4159, "tcp"},
{"nss",                {NULL}, 4159, "udp"},
{"jini-discovery",     {NULL}, 4160, "tcp"},
{"jini-discovery",     {NULL}, 4160, "udp"},
{"omscontact",         {NULL}, 4161, "tcp"},
{"omscontact",         {NULL}, 4161, "udp"},
{"omstopology",        {NULL}, 4162, "tcp"},
{"omstopology",        {NULL}, 4162, "udp"},
{"silverpeakpeer",     {NULL}, 4163, "tcp"},
{"silverpeakpeer",     {NULL}, 4163, "udp"},
{"silverpeakcomm",     {NULL}, 4164, "tcp"},
{"silverpeakcomm",     {NULL}, 4164, "udp"},
{"altcp",              {NULL}, 4165, "tcp"},
{"altcp",              {NULL}, 4165, "udp"},
{"joost",              {NULL}, 4166, "tcp"},
{"joost",              {NULL}, 4166, "udp"},
{"ddgn",               {NULL}, 4167, "tcp"},
{"ddgn",               {NULL}, 4167, "udp"},
{"pslicser",           {NULL}, 4168, "tcp"},
{"pslicser",           {NULL}, 4168, "udp"},
{"iadt",               {NULL}, 4169, "tcp"},
{"iadt-disc",          {NULL}, 4169, "udp"},
{"d-cinema-csp",       {NULL}, 4170, "tcp"},
{"ml-svnet",           {NULL}, 4171, "tcp"},
{"pcoip",              {NULL}, 4172, "tcp"},
{"pcoip",              {NULL}, 4172, "udp"},
{"smcluster",          {NULL}, 4174, "tcp"},
{"bccp",               {NULL}, 4175, "tcp"},
{"tl-ipcproxy",        {NULL}, 4176, "tcp"},
{"wello",              {NULL}, 4177, "tcp"},
{"wello",              {NULL}, 4177, "udp"},
{"storman",            {NULL}, 4178, "tcp"},
{"storman",            {NULL}, 4178, "udp"},
{"MaxumSP",            {NULL}, 4179, "tcp"},
{"MaxumSP",            {NULL}, 4179, "udp"},
{"httpx",              {NULL}, 4180, "tcp"},
{"httpx",              {NULL}, 4180, "udp"},
{"macbak",             {NULL}, 4181, "tcp"},
{"macbak",             {NULL}, 4181, "udp"},
{"pcptcpservice",      {NULL}, 4182, "tcp"},
{"pcptcpservice",      {NULL}, 4182, "udp"},
{"gmmp",               {NULL}, 4183, "tcp"},
{"gmmp",               {NULL}, 4183, "udp"},
{"universe_suite",     {NULL}, 4184, "tcp"},
{"universe_suite",     {NULL}, 4184, "udp"},
{"wcpp",               {NULL}, 4185, "tcp"},
{"wcpp",               {NULL}, 4185, "udp"},
{"boxbackupstore",     {NULL}, 4186, "tcp"},
{"csc_proxy",          {NULL}, 4187, "tcp"},
{"vatata",             {NULL}, 4188, "tcp"},
{"vatata",             {NULL}, 4188, "udp"},
{"pcep",               {NULL}, 4189, "tcp"},
{"sieve",              {NULL}, 4190, "tcp"},
{"dsmipv6",            {NULL}, 4191, "udp"},
{"azeti",              {NULL}, 4192, "tcp"},
{"azeti-bd",           {NULL}, 4192, "udp"},
{"pvxplusio",          {NULL}, 4193, "tcp"},
{"eims-admin",         {NULL}, 4199, "tcp"},
{"eims-admin",         {NULL}, 4199, "udp"},
{"corelccam",          {NULL}, 4300, "tcp"},
{"corelccam",          {NULL}, 4300, "udp"},
{"d-data",             {NULL}, 4301, "tcp"},
{"d-data",             {NULL}, 4301, "udp"},
{"d-data-control",     {NULL}, 4302, "tcp"},
{"d-data-control",     {NULL}, 4302, "udp"},
{"srcp",               {NULL}, 4303, "tcp"},
{"srcp",               {NULL}, 4303, "udp"},
{"owserver",           {NULL}, 4304, "tcp"},
{"owserver",           {NULL}, 4304, "udp"},
{"batman",             {NULL}, 4305, "tcp"},
{"batman",             {NULL}, 4305, "udp"},
{"pinghgl",            {NULL}, 4306, "tcp"},
{"pinghgl",            {NULL}, 4306, "udp"},
{"visicron-vs",        {NULL}, 4307, "tcp"},
{"visicron-vs",        {NULL}, 4307, "udp"},
{"compx-lockview",     {NULL}, 4308, "tcp"},
{"compx-lockview",     {NULL}, 4308, "udp"},
{"dserver",            {NULL}, 4309, "tcp"},
{"dserver",            {NULL}, 4309, "udp"},
{"mirrtex",            {NULL}, 4310, "tcp"},
{"mirrtex",            {NULL}, 4310, "udp"},
{"p6ssmc",             {NULL}, 4311, "tcp"},
{"pscl-mgt",           {NULL}, 4312, "tcp"},
{"perrla",             {NULL}, 4313, "tcp"},
{"fdt-rcatp",          {NULL}, 4320, "tcp"},
{"fdt-rcatp",          {NULL}, 4320, "udp"},
{"rwhois",             {NULL}, 4321, "tcp"},
{"rwhois",             {NULL}, 4321, "udp"},
{"trim-event",         {NULL}, 4322, "tcp"},
{"trim-event",         {NULL}, 4322, "udp"},
{"trim-ice",           {NULL}, 4323, "tcp"},
{"trim-ice",           {NULL}, 4323, "udp"},
{"balour",             {NULL}, 4324, "tcp"},
{"balour",             {NULL}, 4324, "udp"},
{"geognosisman",       {NULL}, 4325, "tcp"},
{"geognosisman",       {NULL}, 4325, "udp"},
{"geognosis",          {NULL}, 4326, "tcp"},
{"geognosis",          {NULL}, 4326, "udp"},
{"jaxer-web",          {NULL}, 4327, "tcp"},
{"jaxer-web",          {NULL}, 4327, "udp"},
{"jaxer-manager",      {NULL}, 4328, "tcp"},
{"jaxer-manager",      {NULL}, 4328, "udp"},
{"publiqare-sync",     {NULL}, 4329, "tcp"},
{"gaia",               {NULL}, 4340, "tcp"},
{"gaia",               {NULL}, 4340, "udp"},
{"lisp-data",          {NULL}, 4341, "tcp"},
{"lisp-data",          {NULL}, 4341, "udp"},
{"lisp-cons",          {NULL}, 4342, "tcp"},
{"lisp-control",       {NULL}, 4342, "udp"},
{"unicall",            {NULL}, 4343, "tcp"},
{"unicall",            {NULL}, 4343, "udp"},
{"vinainstall",        {NULL}, 4344, "tcp"},
{"vinainstall",        {NULL}, 4344, "udp"},
{"m4-network-as",      {NULL}, 4345, "tcp"},
{"m4-network-as",      {NULL}, 4345, "udp"},
{"elanlm",             {NULL}, 4346, "tcp"},
{"elanlm",             {NULL}, 4346, "udp"},
{"lansurveyor",        {NULL}, 4347, "tcp"},
{"lansurveyor",        {NULL}, 4347, "udp"},
{"itose",              {NULL}, 4348, "tcp"},
{"itose",              {NULL}, 4348, "udp"},
{"fsportmap",          {NULL}, 4349, "tcp"},
{"fsportmap",          {NULL}, 4349, "udp"},
{"net-device",         {NULL}, 4350, "tcp"},
{"net-device",         {NULL}, 4350, "udp"},
{"plcy-net-svcs",      {NULL}, 4351, "tcp"},
{"plcy-net-svcs",      {NULL}, 4351, "udp"},
{"pjlink",             {NULL}, 4352, "tcp"},
{"pjlink",             {NULL}, 4352, "udp"},
{"f5-iquery",          {NULL}, 4353, "tcp"},
{"f5-iquery",          {NULL}, 4353, "udp"},
{"qsnet-trans",        {NULL}, 4354, "tcp"},
{"qsnet-trans",        {NULL}, 4354, "udp"},
{"qsnet-workst",       {NULL}, 4355, "tcp"},
{"qsnet-workst",       {NULL}, 4355, "udp"},
{"qsnet-assist",       {NULL}, 4356, "tcp"},
{"qsnet-assist",       {NULL}, 4356, "udp"},
{"qsnet-cond",         {NULL}, 4357, "tcp"},
{"qsnet-cond",         {NULL}, 4357, "udp"},
{"qsnet-nucl",         {NULL}, 4358, "tcp"},
{"qsnet-nucl",         {NULL}, 4358, "udp"},
{"omabcastltkm",       {NULL}, 4359, "tcp"},
{"omabcastltkm",       {NULL}, 4359, "udp"},
{"matrix_vnet",        {NULL}, 4360, "tcp"},
{"nacnl",              {NULL}, 4361, "udp"},
{"afore-vdp-disc",     {NULL}, 4362, "udp"},
{"wxbrief",            {NULL}, 4368, "tcp"},
{"wxbrief",            {NULL}, 4368, "udp"},
{"epmd",               {NULL}, 4369, "tcp"},
{"epmd",               {NULL}, 4369, "udp"},
{"elpro_tunnel",       {NULL}, 4370, "tcp"},
{"elpro_tunnel",       {NULL}, 4370, "udp"},
{"l2c-control",        {NULL}, 4371, "tcp"},
{"l2c-disc",           {NULL}, 4371, "udp"},
{"l2c-data",           {NULL}, 4372, "tcp"},
{"l2c-data",           {NULL}, 4372, "udp"},
{"remctl",             {NULL}, 4373, "tcp"},
{"remctl",             {NULL}, 4373, "udp"},
{"psi-ptt",            {NULL}, 4374, "tcp"},
{"tolteces",           {NULL}, 4375, "tcp"},
{"tolteces",           {NULL}, 4375, "udp"},
{"bip",                {NULL}, 4376, "tcp"},
{"bip",                {NULL}, 4376, "udp"},
{"cp-spxsvr",          {NULL}, 4377, "tcp"},
{"cp-spxsvr",          {NULL}, 4377, "udp"},
{"cp-spxdpy",          {NULL}, 4378, "tcp"},
{"cp-spxdpy",          {NULL}, 4378, "udp"},
{"ctdb",               {NULL}, 4379, "tcp"},
{"ctdb",               {NULL}, 4379, "udp"},
{"xandros-cms",        {NULL}, 4389, "tcp"},
{"xandros-cms",        {NULL}, 4389, "udp"},
{"wiegand",            {NULL}, 4390, "tcp"},
{"wiegand",            {NULL}, 4390, "udp"},
{"apwi-imserver",      {NULL}, 4391, "tcp"},
{"apwi-rxserver",      {NULL}, 4392, "tcp"},
{"apwi-rxspooler",     {NULL}, 4393, "tcp"},
{"apwi-disc",          {NULL}, 4394, "udp"},
{"omnivisionesx",      {NULL}, 4395, "tcp"},
{"omnivisionesx",      {NULL}, 4395, "udp"},
{"fly",                {NULL}, 4396, "tcp"},
{"ds-srv",             {NULL}, 4400, "tcp"},
{"ds-srv",             {NULL}, 4400, "udp"},
{"ds-srvr",            {NULL}, 4401, "tcp"},
{"ds-srvr",            {NULL}, 4401, "udp"},
{"ds-clnt",            {NULL}, 4402, "tcp"},
{"ds-clnt",            {NULL}, 4402, "udp"},
{"ds-user",            {NULL}, 4403, "tcp"},
{"ds-user",            {NULL}, 4403, "udp"},
{"ds-admin",           {NULL}, 4404, "tcp"},
{"ds-admin",           {NULL}, 4404, "udp"},
{"ds-mail",            {NULL}, 4405, "tcp"},
{"ds-mail",            {NULL}, 4405, "udp"},
{"ds-slp",             {NULL}, 4406, "tcp"},
{"ds-slp",             {NULL}, 4406, "udp"},
{"nacagent",           {NULL}, 4407, "tcp"},
{"slscc",              {NULL}, 4408, "tcp"},
{"netcabinet-com",     {NULL}, 4409, "tcp"},
{"itwo-server",        {NULL}, 4410, "tcp"},
{"netrockey6",         {NULL}, 4425, "tcp"},
{"netrockey6",         {NULL}, 4425, "udp"},
{"beacon-port-2",      {NULL}, 4426, "tcp"},
{"beacon-port-2",      {NULL}, 4426, "udp"},
{"drizzle",            {NULL}, 4427, "tcp"},
{"omviserver",         {NULL}, 4428, "tcp"},
{"omviagent",          {NULL}, 4429, "tcp"},
{"rsqlserver",         {NULL}, 4430, "tcp"},
{"rsqlserver",         {NULL}, 4430, "udp"},
{"wspipe",             {NULL}, 4431, "tcp"},
{"netblox",            {NULL}, 4441, "udp"},
{"saris",              {NULL}, 4442, "tcp"},
{"saris",              {NULL}, 4442, "udp"},
{"pharos",             {NULL}, 4443, "tcp"},
{"pharos",             {NULL}, 4443, "udp"},
{"krb524",             {NULL}, 4444, "tcp"},
{"krb524",             {NULL}, 4444, "udp"},
{"nv-video",           {NULL}, 4444, "tcp"},
{"nv-video",           {NULL}, 4444, "udp"},
{"upnotifyp",          {NULL}, 4445, "tcp"},
{"upnotifyp",          {NULL}, 4445, "udp"},
{"n1-fwp",             {NULL}, 4446, "tcp"},
{"n1-fwp",             {NULL}, 4446, "udp"},
{"n1-rmgmt",           {NULL}, 4447, "tcp"},
{"n1-rmgmt",           {NULL}, 4447, "udp"},
{"asc-slmd",           {NULL}, 4448, "tcp"},
{"asc-slmd",           {NULL}, 4448, "udp"},
{"privatewire",        {NULL}, 4449, "tcp"},
{"privatewire",        {NULL}, 4449, "udp"},
{"camp",               {NULL}, 4450, "tcp"},
{"camp",               {NULL}, 4450, "udp"},
{"ctisystemmsg",       {NULL}, 4451, "tcp"},
{"ctisystemmsg",       {NULL}, 4451, "udp"},
{"ctiprogramload",     {NULL}, 4452, "tcp"},
{"ctiprogramload",     {NULL}, 4452, "udp"},
{"nssalertmgr",        {NULL}, 4453, "tcp"},
{"nssalertmgr",        {NULL}, 4453, "udp"},
{"nssagentmgr",        {NULL}, 4454, "tcp"},
{"nssagentmgr",        {NULL}, 4454, "udp"},
{"prchat-user",        {NULL}, 4455, "tcp"},
{"prchat-user",        {NULL}, 4455, "udp"},
{"prchat-server",      {NULL}, 4456, "tcp"},
{"prchat-server",      {NULL}, 4456, "udp"},
{"prRegister",         {NULL}, 4457, "tcp"},
{"prRegister",         {NULL}, 4457, "udp"},
{"mcp",                {NULL}, 4458, "tcp"},
{"mcp",                {NULL}, 4458, "udp"},
{"hpssmgmt",           {NULL}, 4484, "tcp"},
{"hpssmgmt",           {NULL}, 4484, "udp"},
{"assyst-dr",          {NULL}, 4485, "tcp"},
{"icms",               {NULL}, 4486, "tcp"},
{"icms",               {NULL}, 4486, "udp"},
{"prex-tcp",           {NULL}, 4487, "tcp"},
{"awacs-ice",          {NULL}, 4488, "tcp"},
{"awacs-ice",          {NULL}, 4488, "udp"},
{"ipsec-nat-t",        {NULL}, 4500, "tcp"},
{"ipsec-nat-t",        {NULL}, 4500, "udp"},
{"ehs",                {NULL}, 4535, "tcp"},
{"ehs",                {NULL}, 4535, "udp"},
{"ehs-ssl",            {NULL}, 4536, "tcp"},
{"ehs-ssl",            {NULL}, 4536, "udp"},
{"wssauthsvc",         {NULL}, 4537, "tcp"},
{"wssauthsvc",         {NULL}, 4537, "udp"},
{"swx-gate",           {NULL}, 4538, "tcp"},
{"swx-gate",           {NULL}, 4538, "udp"},
{"worldscores",        {NULL}, 4545, "tcp"},
{"worldscores",        {NULL}, 4545, "udp"},
{"sf-lm",              {NULL}, 4546, "tcp"},
{"sf-lm",              {NULL}, 4546, "udp"},
{"lanner-lm",          {NULL}, 4547, "tcp"},
{"lanner-lm",          {NULL}, 4547, "udp"},
{"synchromesh",        {NULL}, 4548, "tcp"},
{"synchromesh",        {NULL}, 4548, "udp"},
{"aegate",             {NULL}, 4549, "tcp"},
{"aegate",             {NULL}, 4549, "udp"},
{"gds-adppiw-db",      {NULL}, 4550, "tcp"},
{"gds-adppiw-db",      {NULL}, 4550, "udp"},
{"ieee-mih",           {NULL}, 4551, "tcp"},
{"ieee-mih",           {NULL}, 4551, "udp"},
{"menandmice-mon",     {NULL}, 4552, "tcp"},
{"menandmice-mon",     {NULL}, 4552, "udp"},
{"icshostsvc",         {NULL}, 4553, "tcp"},
{"msfrs",              {NULL}, 4554, "tcp"},
{"msfrs",              {NULL}, 4554, "udp"},
{"rsip",               {NULL}, 4555, "tcp"},
{"rsip",               {NULL}, 4555, "udp"},
{"dtn-bundle-tcp",     {NULL}, 4556, "tcp"},
{"dtn-bundle-udp",     {NULL}, 4556, "udp"},
{"mtcevrunqss",        {NULL}, 4557, "udp"},
{"mtcevrunqman",       {NULL}, 4558, "udp"},
{"hylafax",            {NULL}, 4559, "tcp"},
{"hylafax",            {NULL}, 4559, "udp"},
{"kwtc",               {NULL}, 4566, "tcp"},
{"kwtc",               {NULL}, 4566, "udp"},
{"tram",               {NULL}, 4567, "tcp"},
{"tram",               {NULL}, 4567, "udp"},
{"bmc-reporting",      {NULL}, 4568, "tcp"},
{"bmc-reporting",      {NULL}, 4568, "udp"},
{"iax",                {NULL}, 4569, "tcp"},
{"iax",                {NULL}, 4569, "udp"},
{"rid",                {NULL}, 4590, "tcp"},
{"l3t-at-an",          {NULL}, 4591, "tcp"},
{"l3t-at-an",          {NULL}, 4591, "udp"},
{"hrpd-ith-at-an",     {NULL}, 4592, "udp"},
{"ipt-anri-anri",      {NULL}, 4593, "tcp"},
{"ipt-anri-anri",      {NULL}, 4593, "udp"},
{"ias-session",        {NULL}, 4594, "tcp"},
{"ias-session",        {NULL}, 4594, "udp"},
{"ias-paging",         {NULL}, 4595, "tcp"},
{"ias-paging",         {NULL}, 4595, "udp"},
{"ias-neighbor",       {NULL}, 4596, "tcp"},
{"ias-neighbor",       {NULL}, 4596, "udp"},
{"a21-an-1xbs",        {NULL}, 4597, "tcp"},
{"a21-an-1xbs",        {NULL}, 4597, "udp"},
{"a16-an-an",          {NULL}, 4598, "tcp"},
{"a16-an-an",          {NULL}, 4598, "udp"},
{"a17-an-an",          {NULL}, 4599, "tcp"},
{"a17-an-an",          {NULL}, 4599, "udp"},
{"piranha1",           {NULL}, 4600, "tcp"},
{"piranha1",           {NULL}, 4600, "udp"},
{"piranha2",           {NULL}, 4601, "tcp"},
{"piranha2",           {NULL}, 4601, "udp"},
{"mtsserver",          {NULL}, 4602, "tcp"},
{"menandmice-upg",     {NULL}, 4603, "tcp"},
{"playsta2-app",       {NULL}, 4658, "tcp"},
{"playsta2-app",       {NULL}, 4658, "udp"},
{"playsta2-lob",       {NULL}, 4659, "tcp"},
{"playsta2-lob",       {NULL}, 4659, "udp"},
{"smaclmgr",           {NULL}, 4660, "tcp"},
{"smaclmgr",           {NULL}, 4660, "udp"},
{"kar2ouche",          {NULL}, 4661, "tcp"},
{"kar2ouche",          {NULL}, 4661, "udp"},
{"oms",                {NULL}, 4662, "tcp"},
{"oms",                {NULL}, 4662, "udp"},
{"noteit",             {NULL}, 4663, "tcp"},
{"noteit",             {NULL}, 4663, "udp"},
{"ems",                {NULL}, 4664, "tcp"},
{"ems",                {NULL}, 4664, "udp"},
{"contclientms",       {NULL}, 4665, "tcp"},
{"contclientms",       {NULL}, 4665, "udp"},
{"eportcomm",          {NULL}, 4666, "tcp"},
{"eportcomm",          {NULL}, 4666, "udp"},
{"mmacomm",            {NULL}, 4667, "tcp"},
{"mmacomm",            {NULL}, 4667, "udp"},
{"mmaeds",             {NULL}, 4668, "tcp"},
{"mmaeds",             {NULL}, 4668, "udp"},
{"eportcommdata",      {NULL}, 4669, "tcp"},
{"eportcommdata",      {NULL}, 4669, "udp"},
{"light",              {NULL}, 4670, "tcp"},
{"light",              {NULL}, 4670, "udp"},
{"acter",              {NULL}, 4671, "tcp"},
{"acter",              {NULL}, 4671, "udp"},
{"rfa",                {NULL}, 4672, "tcp"},
{"rfa",                {NULL}, 4672, "udp"},
{"cxws",               {NULL}, 4673, "tcp"},
{"cxws",               {NULL}, 4673, "udp"},
{"appiq-mgmt",         {NULL}, 4674, "tcp"},
{"appiq-mgmt",         {NULL}, 4674, "udp"},
{"dhct-status",        {NULL}, 4675, "tcp"},
{"dhct-status",        {NULL}, 4675, "udp"},
{"dhct-alerts",        {NULL}, 4676, "tcp"},
{"dhct-alerts",        {NULL}, 4676, "udp"},
{"bcs",                {NULL}, 4677, "tcp"},
{"bcs",                {NULL}, 4677, "udp"},
{"traversal",          {NULL}, 4678, "tcp"},
{"traversal",          {NULL}, 4678, "udp"},
{"mgesupervision",     {NULL}, 4679, "tcp"},
{"mgesupervision",     {NULL}, 4679, "udp"},
{"mgemanagement",      {NULL}, 4680, "tcp"},
{"mgemanagement",      {NULL}, 4680, "udp"},
{"parliant",           {NULL}, 4681, "tcp"},
{"parliant",           {NULL}, 4681, "udp"},
{"finisar",            {NULL}, 4682, "tcp"},
{"finisar",            {NULL}, 4682, "udp"},
{"spike",              {NULL}, 4683, "tcp"},
{"spike",              {NULL}, 4683, "udp"},
{"rfid-rp1",           {NULL}, 4684, "tcp"},
{"rfid-rp1",           {NULL}, 4684, "udp"},
{"autopac",            {NULL}, 4685, "tcp"},
{"autopac",            {NULL}, 4685, "udp"},
{"msp-os",             {NULL}, 4686, "tcp"},
{"msp-os",             {NULL}, 4686, "udp"},
{"nst",                {NULL}, 4687, "tcp"},
{"nst",                {NULL}, 4687, "udp"},
{"mobile-p2p",         {NULL}, 4688, "tcp"},
{"mobile-p2p",         {NULL}, 4688, "udp"},
{"altovacentral",      {NULL}, 4689, "tcp"},
{"altovacentral",      {NULL}, 4689, "udp"},
{"prelude",            {NULL}, 4690, "tcp"},
{"prelude",            {NULL}, 4690, "udp"},
{"mtn",                {NULL}, 4691, "tcp"},
{"mtn",                {NULL}, 4691, "udp"},
{"conspiracy",         {NULL}, 4692, "tcp"},
{"conspiracy",         {NULL}, 4692, "udp"},
{"netxms-agent",       {NULL}, 4700, "tcp"},
{"netxms-agent",       {NULL}, 4700, "udp"},
{"netxms-mgmt",        {NULL}, 4701, "tcp"},
{"netxms-mgmt",        {NULL}, 4701, "udp"},
{"netxms-sync",        {NULL}, 4702, "tcp"},
{"netxms-sync",        {NULL}, 4702, "udp"},
{"npqes-test",         {NULL}, 4703, "tcp"},
{"assuria-ins",        {NULL}, 4704, "tcp"},
{"truckstar",          {NULL}, 4725, "tcp"},
{"truckstar",          {NULL}, 4725, "udp"},
{"a26-fap-fgw",        {NULL}, 4726, "udp"},
{"fcis",               {NULL}, 4727, "tcp"},
{"fcis-disc",          {NULL}, 4727, "udp"},
{"capmux",             {NULL}, 4728, "tcp"},
{"capmux",             {NULL}, 4728, "udp"},
{"gsmtap",             {NULL}, 4729, "udp"},
{"gearman",            {NULL}, 4730, "tcp"},
{"gearman",            {NULL}, 4730, "udp"},
{"remcap",             {NULL}, 4731, "tcp"},
{"ohmtrigger",         {NULL}, 4732, "udp"},
{"resorcs",            {NULL}, 4733, "tcp"},
{"ipdr-sp",            {NULL}, 4737, "tcp"},
{"ipdr-sp",            {NULL}, 4737, "udp"},
{"solera-lpn",         {NULL}, 4738, "tcp"},
{"solera-lpn",         {NULL}, 4738, "udp"},
{"ipfix",              {NULL}, 4739, "tcp"},
{"ipfix",              {NULL}, 4739, "udp"},
{"ipfix",              {NULL}, 4739, "sctp"},
{"ipfixs",             {NULL}, 4740, "tcp"},
{"ipfixs",             {NULL}, 4740, "sctp"},
{"ipfixs",             {NULL}, 4740, "udp"},
{"lumimgrd",           {NULL}, 4741, "tcp"},
{"lumimgrd",           {NULL}, 4741, "udp"},
{"sicct",              {NULL}, 4742, "tcp"},
{"sicct-sdp",          {NULL}, 4742, "udp"},
{"openhpid",           {NULL}, 4743, "tcp"},
{"openhpid",           {NULL}, 4743, "udp"},
{"ifsp",               {NULL}, 4744, "tcp"},
{"ifsp",               {NULL}, 4744, "udp"},
{"fmp",                {NULL}, 4745, "tcp"},
{"fmp",                {NULL}, 4745, "udp"},
{"profilemac",         {NULL}, 4749, "tcp"},
{"profilemac",         {NULL}, 4749, "udp"},
{"ssad",               {NULL}, 4750, "tcp"},
{"ssad",               {NULL}, 4750, "udp"},
{"spocp",              {NULL}, 4751, "tcp"},
{"spocp",              {NULL}, 4751, "udp"},
{"snap",               {NULL}, 4752, "tcp"},
{"snap",               {NULL}, 4752, "udp"},
{"bfd-multi-ctl",      {NULL}, 4784, "tcp"},
{"bfd-multi-ctl",      {NULL}, 4784, "udp"},
{"cncp",               {NULL}, 4785, "udp"},
{"smart-install",      {NULL}, 4786, "tcp"},
{"sia-ctrl-plane",     {NULL}, 4787, "tcp"},
{"iims",               {NULL}, 4800, "tcp"},
{"iims",               {NULL}, 4800, "udp"},
{"iwec",               {NULL}, 4801, "tcp"},
{"iwec",               {NULL}, 4801, "udp"},
{"ilss",               {NULL}, 4802, "tcp"},
{"ilss",               {NULL}, 4802, "udp"},
{"notateit",           {NULL}, 4803, "tcp"},
{"notateit-disc",      {NULL}, 4803, "udp"},
{"aja-ntv4-disc",      {NULL}, 4804, "udp"},
{"htcp",               {NULL}, 4827, "tcp"},
{"htcp",               {NULL}, 4827, "udp"},
{"varadero-0",         {NULL}, 4837, "tcp"},
{"varadero-0",         {NULL}, 4837, "udp"},
{"varadero-1",         {NULL}, 4838, "tcp"},
{"varadero-1",         {NULL}, 4838, "udp"},
{"varadero-2",         {NULL}, 4839, "tcp"},
{"varadero-2",         {NULL}, 4839, "udp"},
{"opcua-tcp",          {NULL}, 4840, "tcp"},
{"opcua-udp",          {NULL}, 4840, "udp"},
{"quosa",              {NULL}, 4841, "tcp"},
{"quosa",              {NULL}, 4841, "udp"},
{"gw-asv",             {NULL}, 4842, "tcp"},
{"gw-asv",             {NULL}, 4842, "udp"},
{"opcua-tls",          {NULL}, 4843, "tcp"},
{"opcua-tls",          {NULL}, 4843, "udp"},
{"gw-log",             {NULL}, 4844, "tcp"},
{"gw-log",             {NULL}, 4844, "udp"},
{"wcr-remlib",         {NULL}, 4845, "tcp"},
{"wcr-remlib",         {NULL}, 4845, "udp"},
{"contamac_icm",       {NULL}, 4846, "tcp"},
{"contamac_icm",       {NULL}, 4846, "udp"},
{"wfc",                {NULL}, 4847, "tcp"},
{"wfc",                {NULL}, 4847, "udp"},
{"appserv-http",       {NULL}, 4848, "tcp"},
{"appserv-http",       {NULL}, 4848, "udp"},
{"appserv-https",      {NULL}, 4849, "tcp"},
{"appserv-https",      {NULL}, 4849, "udp"},
{"sun-as-nodeagt",     {NULL}, 4850, "tcp"},
{"sun-as-nodeagt",     {NULL}, 4850, "udp"},
{"derby-repli",        {NULL}, 4851, "tcp"},
{"derby-repli",        {NULL}, 4851, "udp"},
{"unify-debug",        {NULL}, 4867, "tcp"},
{"unify-debug",        {NULL}, 4867, "udp"},
{"phrelay",            {NULL}, 4868, "tcp"},
{"phrelay",            {NULL}, 4868, "udp"},
{"phrelaydbg",         {NULL}, 4869, "tcp"},
{"phrelaydbg",         {NULL}, 4869, "udp"},
{"cc-tracking",        {NULL}, 4870, "tcp"},
{"cc-tracking",        {NULL}, 4870, "udp"},
{"wired",              {NULL}, 4871, "tcp"},
{"wired",              {NULL}, 4871, "udp"},
{"tritium-can",        {NULL}, 4876, "tcp"},
{"tritium-can",        {NULL}, 4876, "udp"},
{"lmcs",               {NULL}, 4877, "tcp"},
{"lmcs",               {NULL}, 4877, "udp"},
{"inst-discovery",     {NULL}, 4878, "udp"},
{"wsdl-event",         {NULL}, 4879, "tcp"},
{"hislip",             {NULL}, 4880, "tcp"},
{"socp-t",             {NULL}, 4881, "udp"},
{"socp-c",             {NULL}, 4882, "udp"},
{"wmlserver",          {NULL}, 4883, "tcp"},
{"hivestor",           {NULL}, 4884, "tcp"},
{"hivestor",           {NULL}, 4884, "udp"},
{"abbs",               {NULL}, 4885, "tcp"},
{"abbs",               {NULL}, 4885, "udp"},
{"lyskom",             {NULL}, 4894, "tcp"},
{"lyskom",             {NULL}, 4894, "udp"},
{"radmin-port",        {NULL}, 4899, "tcp"},
{"radmin-port",        {NULL}, 4899, "udp"},
{"hfcs",               {NULL}, 4900, "tcp"},
{"hfcs",               {NULL}, 4900, "udp"},
{"flr_agent",          {NULL}, 4901, "tcp"},
{"magiccontrol",       {NULL}, 4902, "tcp"},
{"lutap",              {NULL}, 4912, "tcp"},
{"lutcp",              {NULL}, 4913, "tcp"},
{"bones",              {NULL}, 4914, "tcp"},
{"bones",              {NULL}, 4914, "udp"},
{"frcs",               {NULL}, 4915, "tcp"},
{"atsc-mh-ssc",        {NULL}, 4937, "udp"},
{"eq-office-4940",     {NULL}, 4940, "tcp"},
{"eq-office-4940",     {NULL}, 4940, "udp"},
{"eq-office-4941",     {NULL}, 4941, "tcp"},
{"eq-office-4941",     {NULL}, 4941, "udp"},
{"eq-office-4942",     {NULL}, 4942, "tcp"},
{"eq-office-4942",     {NULL}, 4942, "udp"},
{"munin",              {NULL}, 4949, "tcp"},
{"munin",              {NULL}, 4949, "udp"},
{"sybasesrvmon",       {NULL}, 4950, "tcp"},
{"sybasesrvmon",       {NULL}, 4950, "udp"},
{"pwgwims",            {NULL}, 4951, "tcp"},
{"pwgwims",            {NULL}, 4951, "udp"},
{"sagxtsds",           {NULL}, 4952, "tcp"},
{"sagxtsds",           {NULL}, 4952, "udp"},
{"dbsyncarbiter",      {NULL}, 4953, "tcp"},
{"ccss-qmm",           {NULL}, 4969, "tcp"},
{"ccss-qmm",           {NULL}, 4969, "udp"},
{"ccss-qsm",           {NULL}, 4970, "tcp"},
{"ccss-qsm",           {NULL}, 4970, "udp"},
{"webyast",            {NULL}, 4984, "tcp"},
{"gerhcs",             {NULL}, 4985, "tcp"},
{"mrip",               {NULL}, 4986, "tcp"},
{"mrip",               {NULL}, 4986, "udp"},
{"smar-se-port1",      {NULL}, 4987, "tcp"},
{"smar-se-port1",      {NULL}, 4987, "udp"},
{"smar-se-port2",      {NULL}, 4988, "tcp"},
{"smar-se-port2",      {NULL}, 4988, "udp"},
{"parallel",           {NULL}, 4989, "tcp"},
{"parallel",           {NULL}, 4989, "udp"},
{"busycal",            {NULL}, 4990, "tcp"},
{"busycal",            {NULL}, 4990, "udp"},
{"vrt",                {NULL}, 4991, "tcp"},
{"vrt",                {NULL}, 4991, "udp"},
{"hfcs-manager",       {NULL}, 4999, "tcp"},
{"hfcs-manager",       {NULL}, 4999, "udp"},
{"commplex-main",      {NULL}, 5000, "tcp"},
{"commplex-main",      {NULL}, 5000, "udp"},
{"commplex-link",      {NULL}, 5001, "tcp"},
{"commplex-link",      {NULL}, 5001, "udp"},
{"rfe",                {NULL}, 5002, "tcp"},
{"rfe",                {NULL}, 5002, "udp"},
{"fmpro-internal",     {NULL}, 5003, "tcp"},
{"fmpro-internal",     {NULL}, 5003, "udp"},
{"avt-profile-1",      {NULL}, 5004, "tcp"},
{"avt-profile-1",      {NULL}, 5004, "udp"},
{"avt-profile-1",      {NULL}, 5004, "dccp"},
{"avt-profile-2",      {NULL}, 5005, "tcp"},
{"avt-profile-2",      {NULL}, 5005, "udp"},
{"avt-profile-2",      {NULL}, 5005, "dccp"},
{"wsm-server",         {NULL}, 5006, "tcp"},
{"wsm-server",         {NULL}, 5006, "udp"},
{"wsm-server-ssl",     {NULL}, 5007, "tcp"},
{"wsm-server-ssl",     {NULL}, 5007, "udp"},
{"synapsis-edge",      {NULL}, 5008, "tcp"},
{"synapsis-edge",      {NULL}, 5008, "udp"},
{"winfs",              {NULL}, 5009, "tcp"},
{"winfs",              {NULL}, 5009, "udp"},
{"telelpathstart",     {NULL}, 5010, "tcp"},
{"telelpathstart",     {NULL}, 5010, "udp"},
{"telelpathattack",    {NULL}, 5011, "tcp"},
{"telelpathattack",    {NULL}, 5011, "udp"},
{"nsp",                {NULL}, 5012, "tcp"},
{"nsp",                {NULL}, 5012, "udp"},
{"fmpro-v6",           {NULL}, 5013, "tcp"},
{"fmpro-v6",           {NULL}, 5013, "udp"},
{"onpsocket",          {NULL}, 5014, "udp"},
{"fmwp",               {NULL}, 5015, "tcp"},
{"zenginkyo-1",        {NULL}, 5020, "tcp"},
{"zenginkyo-1",        {NULL}, 5020, "udp"},
{"zenginkyo-2",        {NULL}, 5021, "tcp"},
{"zenginkyo-2",        {NULL}, 5021, "udp"},
{"mice",               {NULL}, 5022, "tcp"},
{"mice",               {NULL}, 5022, "udp"},
{"htuilsrv",           {NULL}, 5023, "tcp"},
{"htuilsrv",           {NULL}, 5023, "udp"},
{"scpi-telnet",        {NULL}, 5024, "tcp"},
{"scpi-telnet",        {NULL}, 5024, "udp"},
{"scpi-raw",           {NULL}, 5025, "tcp"},
{"scpi-raw",           {NULL}, 5025, "udp"},
{"strexec-d",          {NULL}, 5026, "tcp"},
{"strexec-d",          {NULL}, 5026, "udp"},
{"strexec-s",          {NULL}, 5027, "tcp"},
{"strexec-s",          {NULL}, 5027, "udp"},
{"qvr",                {NULL}, 5028, "tcp"},
{"infobright",         {NULL}, 5029, "tcp"},
{"infobright",         {NULL}, 5029, "udp"},
{"surfpass",           {NULL}, 5030, "tcp"},
{"surfpass",           {NULL}, 5030, "udp"},
{"dmp",                {NULL}, 5031, "udp"},
{"asnaacceler8db",     {NULL}, 5042, "tcp"},
{"asnaacceler8db",     {NULL}, 5042, "udp"},
{"swxadmin",           {NULL}, 5043, "tcp"},
{"swxadmin",           {NULL}, 5043, "udp"},
{"lxi-evntsvc",        {NULL}, 5044, "tcp"},
{"lxi-evntsvc",        {NULL}, 5044, "udp"},
{"osp",                {NULL}, 5045, "tcp"},
{"vpm-udp",            {NULL}, 5046, "udp"},
{"iscape",             {NULL}, 5047, "udp"},
{"texai",              {NULL}, 5048, "tcp"},
{"ivocalize",          {NULL}, 5049, "tcp"},
{"ivocalize",          {NULL}, 5049, "udp"},
{"mmcc",               {NULL}, 5050, "tcp"},
{"mmcc",               {NULL}, 5050, "udp"},
{"ita-agent",          {NULL}, 5051, "tcp"},
{"ita-agent",          {NULL}, 5051, "udp"},
{"ita-manager",        {NULL}, 5052, "tcp"},
{"ita-manager",        {NULL}, 5052, "udp"},
{"rlm",                {NULL}, 5053, "tcp"},
{"rlm-admin",          {NULL}, 5054, "tcp"},
{"unot",               {NULL}, 5055, "tcp"},
{"unot",               {NULL}, 5055, "udp"},
{"intecom-ps1",        {NULL}, 5056, "tcp"},
{"intecom-ps1",        {NULL}, 5056, "udp"},
{"intecom-ps2",        {NULL}, 5057, "tcp"},
{"intecom-ps2",        {NULL}, 5057, "udp"},
{"locus-disc",         {NULL}, 5058, "udp"},
{"sds",                {NULL}, 5059, "tcp"},
{"sds",                {NULL}, 5059, "udp"},
{"sip",                {NULL}, 5060, "tcp"},
{"sip",                {NULL}, 5060, "udp"},
{"sip-tls",            {NULL}, 5061, "tcp"},
{"sip-tls",            {NULL}, 5061, "udp"},
{"na-localise",        {NULL}, 5062, "tcp"},
{"na-localise",        {NULL}, 5062, "udp"},
{"csrpc",              {NULL}, 5063, "tcp"},
{"ca-1",               {NULL}, 5064, "tcp"},
{"ca-1",               {NULL}, 5064, "udp"},
{"ca-2",               {NULL}, 5065, "tcp"},
{"ca-2",               {NULL}, 5065, "udp"},
{"stanag-5066",        {NULL}, 5066, "tcp"},
{"stanag-5066",        {NULL}, 5066, "udp"},
{"authentx",           {NULL}, 5067, "tcp"},
{"authentx",           {NULL}, 5067, "udp"},
{"bitforestsrv",       {NULL}, 5068, "tcp"},
{"i-net-2000-npr",     {NULL}, 5069, "tcp"},
{"i-net-2000-npr",     {NULL}, 5069, "udp"},
{"vtsas",              {NULL}, 5070, "tcp"},
{"vtsas",              {NULL}, 5070, "udp"},
{"powerschool",        {NULL}, 5071, "tcp"},
{"powerschool",        {NULL}, 5071, "udp"},
{"ayiya",              {NULL}, 5072, "tcp"},
{"ayiya",              {NULL}, 5072, "udp"},
{"tag-pm",             {NULL}, 5073, "tcp"},
{"tag-pm",             {NULL}, 5073, "udp"},
{"alesquery",          {NULL}, 5074, "tcp"},
{"alesquery",          {NULL}, 5074, "udp"},
{"cp-spxrpts",         {NULL}, 5079, "udp"},
{"onscreen",           {NULL}, 5080, "tcp"},
{"onscreen",           {NULL}, 5080, "udp"},
{"sdl-ets",            {NULL}, 5081, "tcp"},
{"sdl-ets",            {NULL}, 5081, "udp"},
{"qcp",                {NULL}, 5082, "tcp"},
{"qcp",                {NULL}, 5082, "udp"},
{"qfp",                {NULL}, 5083, "tcp"},
{"qfp",                {NULL}, 5083, "udp"},
{"llrp",               {NULL}, 5084, "tcp"},
{"llrp",               {NULL}, 5084, "udp"},
{"encrypted-llrp",     {NULL}, 5085, "tcp"},
{"encrypted-llrp",     {NULL}, 5085, "udp"},
{"aprigo-cs",          {NULL}, 5086, "tcp"},
{"car",                {NULL}, 5090, "sctp"},
{"cxtp",               {NULL}, 5091, "sctp"},
{"magpie",             {NULL}, 5092, "udp"},
{"sentinel-lm",        {NULL}, 5093, "tcp"},
{"sentinel-lm",        {NULL}, 5093, "udp"},
{"hart-ip",            {NULL}, 5094, "tcp"},
{"hart-ip",            {NULL}, 5094, "udp"},
{"sentlm-srv2srv",     {NULL}, 5099, "tcp"},
{"sentlm-srv2srv",     {NULL}, 5099, "udp"},
{"socalia",            {NULL}, 5100, "tcp"},
{"socalia",            {NULL}, 5100, "udp"},
{"talarian-tcp",       {NULL}, 5101, "tcp"},
{"talarian-udp",       {NULL}, 5101, "udp"},
{"oms-nonsecure",      {NULL}, 5102, "tcp"},
{"oms-nonsecure",      {NULL}, 5102, "udp"},
{"actifio-c2c",        {NULL}, 5103, "tcp"},
{"tinymessage",        {NULL}, 5104, "udp"},
{"hughes-ap",          {NULL}, 5105, "udp"},
{"taep-as-svc",        {NULL}, 5111, "tcp"},
{"taep-as-svc",        {NULL}, 5111, "udp"},
{"pm-cmdsvr",          {NULL}, 5112, "tcp"},
{"pm-cmdsvr",          {NULL}, 5112, "udp"},
{"ev-services",        {NULL}, 5114, "tcp"},
{"autobuild",          {NULL}, 5115, "tcp"},
{"emb-proj-cmd",       {NULL}, 5116, "udp"},
{"gradecam",           {NULL}, 5117, "tcp"},
{"nbt-pc",             {NULL}, 5133, "tcp"},
{"nbt-pc",             {NULL}, 5133, "udp"},
{"ppactivation",       {NULL}, 5134, "tcp"},
{"erp-scale",          {NULL}, 5135, "tcp"},
{"minotaur-sa",        {NULL}, 5136, "udp"},
{"ctsd",               {NULL}, 5137, "tcp"},
{"ctsd",               {NULL}, 5137, "udp"},
{"rmonitor_secure",    {NULL}, 5145, "tcp"},
{"rmonitor_secure",    {NULL}, 5145, "udp"},
{"social-alarm",       {NULL}, 5146, "tcp"},
{"atmp",               {NULL}, 5150, "tcp"},
{"atmp",               {NULL}, 5150, "udp"},
{"esri_sde",           {NULL}, 5151, "tcp"},
{"esri_sde",           {NULL}, 5151, "udp"},
{"sde-discovery",      {NULL}, 5152, "tcp"},
{"sde-discovery",      {NULL}, 5152, "udp"},
{"toruxserver",        {NULL}, 5153, "tcp"},
{"bzflag",             {NULL}, 5154, "tcp"},
{"bzflag",             {NULL}, 5154, "udp"},
{"asctrl-agent",       {NULL}, 5155, "tcp"},
{"asctrl-agent",       {NULL}, 5155, "udp"},
{"rugameonline",       {NULL}, 5156, "tcp"},
{"mediat",             {NULL}, 5157, "tcp"},
{"snmpssh",            {NULL}, 5161, "tcp"},
{"snmpssh-trap",       {NULL}, 5162, "tcp"},
{"sbackup",            {NULL}, 5163, "tcp"},
{"vpa",                {NULL}, 5164, "tcp"},
{"vpa-disc",           {NULL}, 5164, "udp"},
{"ife_icorp",          {NULL}, 5165, "tcp"},
{"ife_icorp",          {NULL}, 5165, "udp"},
{"winpcs",             {NULL}, 5166, "tcp"},
{"winpcs",             {NULL}, 5166, "udp"},
{"scte104",            {NULL}, 5167, "tcp"},
{"scte104",            {NULL}, 5167, "udp"},
{"scte30",             {NULL}, 5168, "tcp"},
{"scte30",             {NULL}, 5168, "udp"},
{"aol",                {NULL}, 5190, "tcp"},
{"aol",                {NULL}, 5190, "udp"},
{"aol-1",              {NULL}, 5191, "tcp"},
{"aol-1",              {NULL}, 5191, "udp"},
{"aol-2",              {NULL}, 5192, "tcp"},
{"aol-2",              {NULL}, 5192, "udp"},
{"aol-3",              {NULL}, 5193, "tcp"},
{"aol-3",              {NULL}, 5193, "udp"},
{"cpscomm",            {NULL}, 5194, "tcp"},
{"targus-getdata",     {NULL}, 5200, "tcp"},
{"targus-getdata",     {NULL}, 5200, "udp"},
{"targus-getdata1",    {NULL}, 5201, "tcp"},
{"targus-getdata1",    {NULL}, 5201, "udp"},
{"targus-getdata2",    {NULL}, 5202, "tcp"},
{"targus-getdata2",    {NULL}, 5202, "udp"},
{"targus-getdata3",    {NULL}, 5203, "tcp"},
{"targus-getdata3",    {NULL}, 5203, "udp"},
{"3exmp",              {NULL}, 5221, "tcp"},
{"xmpp-client",        {NULL}, 5222, "tcp"},
{"hpvirtgrp",          {NULL}, 5223, "tcp"},
{"hpvirtgrp",          {NULL}, 5223, "udp"},
{"hpvirtctrl",         {NULL}, 5224, "tcp"},
{"hpvirtctrl",         {NULL}, 5224, "udp"},
{"hp-server",          {NULL}, 5225, "tcp"},
{"hp-server",          {NULL}, 5225, "udp"},
{"hp-status",          {NULL}, 5226, "tcp"},
{"hp-status",          {NULL}, 5226, "udp"},
{"perfd",              {NULL}, 5227, "tcp"},
{"perfd",              {NULL}, 5227, "udp"},
{"hpvroom",            {NULL}, 5228, "tcp"},
{"csedaemon",          {NULL}, 5232, "tcp"},
{"enfs",               {NULL}, 5233, "tcp"},
{"eenet",              {NULL}, 5234, "tcp"},
{"eenet",              {NULL}, 5234, "udp"},
{"galaxy-network",     {NULL}, 5235, "tcp"},
{"galaxy-network",     {NULL}, 5235, "udp"},
{"padl2sim",           {NULL}, 5236, "tcp"},
{"padl2sim",           {NULL}, 5236, "udp"},
{"mnet-discovery",     {NULL}, 5237, "tcp"},
{"mnet-discovery",     {NULL}, 5237, "udp"},
{"downtools",          {NULL}, 5245, "tcp"},
{"downtools-disc",     {NULL}, 5245, "udp"},
{"capwap-control",     {NULL}, 5246, "udp"},
{"capwap-data",        {NULL}, 5247, "udp"},
{"caacws",             {NULL}, 5248, "tcp"},
{"caacws",             {NULL}, 5248, "udp"},
{"caaclang2",          {NULL}, 5249, "tcp"},
{"caaclang2",          {NULL}, 5249, "udp"},
{"soagateway",         {NULL}, 5250, "tcp"},
{"soagateway",         {NULL}, 5250, "udp"},
{"caevms",             {NULL}, 5251, "tcp"},
{"caevms",             {NULL}, 5251, "udp"},
{"movaz-ssc",          {NULL}, 5252, "tcp"},
{"movaz-ssc",          {NULL}, 5252, "udp"},
{"kpdp",               {NULL}, 5253, "tcp"},
{"3com-njack-1",       {NULL}, 5264, "tcp"},
{"3com-njack-1",       {NULL}, 5264, "udp"},
{"3com-njack-2",       {NULL}, 5265, "tcp"},
{"3com-njack-2",       {NULL}, 5265, "udp"},
{"xmpp-server",        {NULL}, 5269, "tcp"},
{"xmp",                {NULL}, 5270, "tcp"},
{"xmp",                {NULL}, 5270, "udp"},
{"cuelink",            {NULL}, 5271, "tcp"},
{"cuelink-disc",       {NULL}, 5271, "udp"},
{"pk",                 {NULL}, 5272, "tcp"},
{"pk",                 {NULL}, 5272, "udp"},
{"xmpp-bosh",          {NULL}, 5280, "tcp"},
{"undo-lm",            {NULL}, 5281, "tcp"},
{"transmit-port",      {NULL}, 5282, "tcp"},
{"transmit-port",      {NULL}, 5282, "udp"},
{"presence",           {NULL}, 5298, "tcp"},
{"presence",           {NULL}, 5298, "udp"},
{"nlg-data",           {NULL}, 5299, "tcp"},
{"nlg-data",           {NULL}, 5299, "udp"},
{"hacl-hb",            {NULL}, 5300, "tcp"},
{"hacl-hb",            {NULL}, 5300, "udp"},
{"hacl-gs",            {NULL}, 5301, "tcp"},
{"hacl-gs",            {NULL}, 5301, "udp"},
{"hacl-cfg",           {NULL}, 5302, "tcp"},
{"hacl-cfg",           {NULL}, 5302, "udp"},
{"hacl-probe",         {NULL}, 5303, "tcp"},
{"hacl-probe",         {NULL}, 5303, "udp"},
{"hacl-local",         {NULL}, 5304, "tcp"},
{"hacl-local",         {NULL}, 5304, "udp"},
{"hacl-test",          {NULL}, 5305, "tcp"},
{"hacl-test",          {NULL}, 5305, "udp"},
{"sun-mc-grp",         {NULL}, 5306, "tcp"},
{"sun-mc-grp",         {NULL}, 5306, "udp"},
{"sco-aip",            {NULL}, 5307, "tcp"},
{"sco-aip",            {NULL}, 5307, "udp"},
{"cfengine",           {NULL}, 5308, "tcp"},
{"cfengine",           {NULL}, 5308, "udp"},
{"jprinter",           {NULL}, 5309, "tcp"},
{"jprinter",           {NULL}, 5309, "udp"},
{"outlaws",            {NULL}, 5310, "tcp"},
{"outlaws",            {NULL}, 5310, "udp"},
{"permabit-cs",        {NULL}, 5312, "tcp"},
{"permabit-cs",        {NULL}, 5312, "udp"},
{"rrdp",               {NULL}, 5313, "tcp"},
{"rrdp",               {NULL}, 5313, "udp"},
{"opalis-rbt-ipc",     {NULL}, 5314, "tcp"},
{"opalis-rbt-ipc",     {NULL}, 5314, "udp"},
{"hacl-poll",          {NULL}, 5315, "tcp"},
{"hacl-poll",          {NULL}, 5315, "udp"},
{"hpdevms",            {NULL}, 5316, "tcp"},
{"hpdevms",            {NULL}, 5316, "udp"},
{"bsfserver-zn",       {NULL}, 5320, "tcp"},
{"bsfsvr-zn-ssl",      {NULL}, 5321, "tcp"},
{"kfserver",           {NULL}, 5343, "tcp"},
{"kfserver",           {NULL}, 5343, "udp"},
{"xkotodrcp",          {NULL}, 5344, "tcp"},
{"xkotodrcp",          {NULL}, 5344, "udp"},
{"stuns",              {NULL}, 5349, "tcp"},
{"stuns",              {NULL}, 5349, "udp"},
{"turns",              {NULL}, 5349, "tcp"},
{"turns",              {NULL}, 5349, "udp"},
{"stun-behaviors",     {NULL}, 5349, "tcp"},
{"stun-behaviors",     {NULL}, 5349, "udp"},
{"nat-pmp-status",     {NULL}, 5350, "tcp"},
{"nat-pmp-status",     {NULL}, 5350, "udp"},
{"nat-pmp",            {NULL}, 5351, "tcp"},
{"nat-pmp",            {NULL}, 5351, "udp"},
{"dns-llq",            {NULL}, 5352, "tcp"},
{"dns-llq",            {NULL}, 5352, "udp"},
{"mdns",               {NULL}, 5353, "tcp"},
{"mdns",               {NULL}, 5353, "udp"},
{"mdnsresponder",      {NULL}, 5354, "tcp"},
{"mdnsresponder",      {NULL}, 5354, "udp"},
{"llmnr",              {NULL}, 5355, "tcp"},
{"llmnr",              {NULL}, 5355, "udp"},
{"ms-smlbiz",          {NULL}, 5356, "tcp"},
{"ms-smlbiz",          {NULL}, 5356, "udp"},
{"wsdapi",             {NULL}, 5357, "tcp"},
{"wsdapi",             {NULL}, 5357, "udp"},
{"wsdapi-s",           {NULL}, 5358, "tcp"},
{"wsdapi-s",           {NULL}, 5358, "udp"},
{"ms-alerter",         {NULL}, 5359, "tcp"},
{"ms-alerter",         {NULL}, 5359, "udp"},
{"ms-sideshow",        {NULL}, 5360, "tcp"},
{"ms-sideshow",        {NULL}, 5360, "udp"},
{"ms-s-sideshow",      {NULL}, 5361, "tcp"},
{"ms-s-sideshow",      {NULL}, 5361, "udp"},
{"serverwsd2",         {NULL}, 5362, "tcp"},
{"serverwsd2",         {NULL}, 5362, "udp"},
{"net-projection",     {NULL}, 5363, "tcp"},
{"net-projection",     {NULL}, 5363, "udp"},
{"stresstester",       {NULL}, 5397, "tcp"},
{"stresstester",       {NULL}, 5397, "udp"},
{"elektron-admin",     {NULL}, 5398, "tcp"},
{"elektron-admin",     {NULL}, 5398, "udp"},
{"securitychase",      {NULL}, 5399, "tcp"},
{"securitychase",      {NULL}, 5399, "udp"},
{"excerpt",            {NULL}, 5400, "tcp"},
{"excerpt",            {NULL}, 5400, "udp"},
{"excerpts",           {NULL}, 5401, "tcp"},
{"excerpts",           {NULL}, 5401, "udp"},
{"mftp",               {NULL}, 5402, "tcp"},
{"mftp",               {NULL}, 5402, "udp"},
{"hpoms-ci-lstn",      {NULL}, 5403, "tcp"},
{"hpoms-ci-lstn",      {NULL}, 5403, "udp"},
{"hpoms-dps-lstn",     {NULL}, 5404, "tcp"},
{"hpoms-dps-lstn",     {NULL}, 5404, "udp"},
{"netsupport",         {NULL}, 5405, "tcp"},
{"netsupport",         {NULL}, 5405, "udp"},
{"systemics-sox",      {NULL}, 5406, "tcp"},
{"systemics-sox",      {NULL}, 5406, "udp"},
{"foresyte-clear",     {NULL}, 5407, "tcp"},
{"foresyte-clear",     {NULL}, 5407, "udp"},
{"foresyte-sec",       {NULL}, 5408, "tcp"},
{"foresyte-sec",       {NULL}, 5408, "udp"},
{"salient-dtasrv",     {NULL}, 5409, "tcp"},
{"salient-dtasrv",     {NULL}, 5409, "udp"},
{"salient-usrmgr",     {NULL}, 5410, "tcp"},
{"salient-usrmgr",     {NULL}, 5410, "udp"},
{"actnet",             {NULL}, 5411, "tcp"},
{"actnet",             {NULL}, 5411, "udp"},
{"continuus",          {NULL}, 5412, "tcp"},
{"continuus",          {NULL}, 5412, "udp"},
{"wwiotalk",           {NULL}, 5413, "tcp"},
{"wwiotalk",           {NULL}, 5413, "udp"},
{"statusd",            {NULL}, 5414, "tcp"},
{"statusd",            {NULL}, 5414, "udp"},
{"ns-server",          {NULL}, 5415, "tcp"},
{"ns-server",          {NULL}, 5415, "udp"},
{"sns-gateway",        {NULL}, 5416, "tcp"},
{"sns-gateway",        {NULL}, 5416, "udp"},
{"sns-agent",          {NULL}, 5417, "tcp"},
{"sns-agent",          {NULL}, 5417, "udp"},
{"mcntp",              {NULL}, 5418, "tcp"},
{"mcntp",              {NULL}, 5418, "udp"},
{"dj-ice",             {NULL}, 5419, "tcp"},
{"dj-ice",             {NULL}, 5419, "udp"},
{"cylink-c",           {NULL}, 5420, "tcp"},
{"cylink-c",           {NULL}, 5420, "udp"},
{"netsupport2",        {NULL}, 5421, "tcp"},
{"netsupport2",        {NULL}, 5421, "udp"},
{"salient-mux",        {NULL}, 5422, "tcp"},
{"salient-mux",        {NULL}, 5422, "udp"},
{"virtualuser",        {NULL}, 5423, "tcp"},
{"virtualuser",        {NULL}, 5423, "udp"},
{"beyond-remote",      {NULL}, 5424, "tcp"},
{"beyond-remote",      {NULL}, 5424, "udp"},
{"br-channel",         {NULL}, 5425, "tcp"},
{"br-channel",         {NULL}, 5425, "udp"},
{"devbasic",           {NULL}, 5426, "tcp"},
{"devbasic",           {NULL}, 5426, "udp"},
{"sco-peer-tta",       {NULL}, 5427, "tcp"},
{"sco-peer-tta",       {NULL}, 5427, "udp"},
{"telaconsole",        {NULL}, 5428, "tcp"},
{"telaconsole",        {NULL}, 5428, "udp"},
{"base",               {NULL}, 5429, "tcp"},
{"base",               {NULL}, 5429, "udp"},
{"radec-corp",         {NULL}, 5430, "tcp"},
{"radec-corp",         {NULL}, 5430, "udp"},
{"park-agent",         {NULL}, 5431, "tcp"},
{"park-agent",         {NULL}, 5431, "udp"},
{"postgresql",         {NULL}, 5432, "tcp"},
{"postgresql",         {NULL}, 5432, "udp"},
{"pyrrho",             {NULL}, 5433, "tcp"},
{"pyrrho",             {NULL}, 5433, "udp"},
{"sgi-arrayd",         {NULL}, 5434, "tcp"},
{"sgi-arrayd",         {NULL}, 5434, "udp"},
{"sceanics",           {NULL}, 5435, "tcp"},
{"sceanics",           {NULL}, 5435, "udp"},
{"pmip6-cntl",         {NULL}, 5436, "udp"},
{"pmip6-data",         {NULL}, 5437, "udp"},
{"spss",               {NULL}, 5443, "tcp"},
{"spss",               {NULL}, 5443, "udp"},
{"surebox",            {NULL}, 5453, "tcp"},
{"surebox",            {NULL}, 5453, "udp"},
{"apc-5454",           {NULL}, 5454, "tcp"},
{"apc-5454",           {NULL}, 5454, "udp"},
{"apc-5455",           {NULL}, 5455, "tcp"},
{"apc-5455",           {NULL}, 5455, "udp"},
{"apc-5456",           {NULL}, 5456, "tcp"},
{"apc-5456",           {NULL}, 5456, "udp"},
{"silkmeter",          {NULL}, 5461, "tcp"},
{"silkmeter",          {NULL}, 5461, "udp"},
{"ttl-publisher",      {NULL}, 5462, "tcp"},
{"ttl-publisher",      {NULL}, 5462, "udp"},
{"ttlpriceproxy",      {NULL}, 5463, "tcp"},
{"ttlpriceproxy",      {NULL}, 5463, "udp"},
{"quailnet",           {NULL}, 5464, "tcp"},
{"quailnet",           {NULL}, 5464, "udp"},
{"netops-broker",      {NULL}, 5465, "tcp"},
{"netops-broker",      {NULL}, 5465, "udp"},
{"fcp-addr-srvr1",     {NULL}, 5500, "tcp"},
{"fcp-addr-srvr1",     {NULL}, 5500, "udp"},
{"fcp-addr-srvr2",     {NULL}, 5501, "tcp"},
{"fcp-addr-srvr2",     {NULL}, 5501, "udp"},
{"fcp-srvr-inst1",     {NULL}, 5502, "tcp"},
{"fcp-srvr-inst1",     {NULL}, 5502, "udp"},
{"fcp-srvr-inst2",     {NULL}, 5503, "tcp"},
{"fcp-srvr-inst2",     {NULL}, 5503, "udp"},
{"fcp-cics-gw1",       {NULL}, 5504, "tcp"},
{"fcp-cics-gw1",       {NULL}, 5504, "udp"},
{"checkoutdb",         {NULL}, 5505, "tcp"},
{"checkoutdb",         {NULL}, 5505, "udp"},
{"amc",                {NULL}, 5506, "tcp"},
{"amc",                {NULL}, 5506, "udp"},
{"sgi-eventmond",      {NULL}, 5553, "tcp"},
{"sgi-eventmond",      {NULL}, 5553, "udp"},
{"sgi-esphttp",        {NULL}, 5554, "tcp"},
{"sgi-esphttp",        {NULL}, 5554, "udp"},
{"personal-agent",     {NULL}, 5555, "tcp"},
{"personal-agent",     {NULL}, 5555, "udp"},
{"freeciv",            {NULL}, 5556, "tcp"},
{"freeciv",            {NULL}, 5556, "udp"},
{"farenet",            {NULL}, 5557, "tcp"},
{"westec-connect",     {NULL}, 5566, "tcp"},
{"m-oap",              {NULL}, 5567, "tcp"},
{"m-oap",              {NULL}, 5567, "udp"},
{"sdt",                {NULL}, 5568, "tcp"},
{"sdt",                {NULL}, 5568, "udp"},
{"sdmmp",              {NULL}, 5573, "tcp"},
{"sdmmp",              {NULL}, 5573, "udp"},
{"lsi-bobcat",         {NULL}, 5574, "tcp"},
{"ora-oap",            {NULL}, 5575, "tcp"},
{"fdtracks",           {NULL}, 5579, "tcp"},
{"tmosms0",            {NULL}, 5580, "tcp"},
{"tmosms0",            {NULL}, 5580, "udp"},
{"tmosms1",            {NULL}, 5581, "tcp"},
{"tmosms1",            {NULL}, 5581, "udp"},
{"fac-restore",        {NULL}, 5582, "tcp"},
{"fac-restore",        {NULL}, 5582, "udp"},
{"tmo-icon-sync",      {NULL}, 5583, "tcp"},
{"tmo-icon-sync",      {NULL}, 5583, "udp"},
{"bis-web",            {NULL}, 5584, "tcp"},
{"bis-web",            {NULL}, 5584, "udp"},
{"bis-sync",           {NULL}, 5585, "tcp"},
{"bis-sync",           {NULL}, 5585, "udp"},
{"ininmessaging",      {NULL}, 5597, "tcp"},
{"ininmessaging",      {NULL}, 5597, "udp"},
{"mctfeed",            {NULL}, 5598, "tcp"},
{"mctfeed",            {NULL}, 5598, "udp"},
{"esinstall",          {NULL}, 5599, "tcp"},
{"esinstall",          {NULL}, 5599, "udp"},
{"esmmanager",         {NULL}, 5600, "tcp"},
{"esmmanager",         {NULL}, 5600, "udp"},
{"esmagent",           {NULL}, 5601, "tcp"},
{"esmagent",           {NULL}, 5601, "udp"},
{"a1-msc",             {NULL}, 5602, "tcp"},
{"a1-msc",             {NULL}, 5602, "udp"},
{"a1-bs",              {NULL}, 5603, "tcp"},
{"a1-bs",              {NULL}, 5603, "udp"},
{"a3-sdunode",         {NULL}, 5604, "tcp"},
{"a3-sdunode",         {NULL}, 5604, "udp"},
{"a4-sdunode",         {NULL}, 5605, "tcp"},
{"a4-sdunode",         {NULL}, 5605, "udp"},
{"ninaf",              {NULL}, 5627, "tcp"},
{"ninaf",              {NULL}, 5627, "udp"},
{"htrust",             {NULL}, 5628, "tcp"},
{"htrust",             {NULL}, 5628, "udp"},
{"symantec-sfdb",      {NULL}, 5629, "tcp"},
{"symantec-sfdb",      {NULL}, 5629, "udp"},
{"precise-comm",       {NULL}, 5630, "tcp"},
{"precise-comm",       {NULL}, 5630, "udp"},
{"pcanywheredata",     {NULL}, 5631, "tcp"},
{"pcanywheredata",     {NULL}, 5631, "udp"},
{"pcanywherestat",     {NULL}, 5632, "tcp"},
{"pcanywherestat",     {NULL}, 5632, "udp"},
{"beorl",              {NULL}, 5633, "tcp"},
{"beorl",              {NULL}, 5633, "udp"},
{"xprtld",             {NULL}, 5634, "tcp"},
{"xprtld",             {NULL}, 5634, "udp"},
{"sfmsso",             {NULL}, 5635, "tcp"},
{"sfm-db-server",      {NULL}, 5636, "tcp"},
{"cssc",               {NULL}, 5637, "tcp"},
{"amqps",              {NULL}, 5671, "tcp"},
{"amqps",              {NULL}, 5671, "udp"},
{"amqp",               {NULL}, 5672, "tcp"},
{"amqp",               {NULL}, 5672, "udp"},
{"amqp",               {NULL}, 5672, "sctp"},
{"jms",                {NULL}, 5673, "tcp"},
{"jms",                {NULL}, 5673, "udp"},
{"hyperscsi-port",     {NULL}, 5674, "tcp"},
{"hyperscsi-port",     {NULL}, 5674, "udp"},
{"v5ua",               {NULL}, 5675, "tcp"},
{"v5ua",               {NULL}, 5675, "udp"},
{"v5ua",               {NULL}, 5675, "sctp"},
{"raadmin",            {NULL}, 5676, "tcp"},
{"raadmin",            {NULL}, 5676, "udp"},
{"questdb2-lnchr",     {NULL}, 5677, "tcp"},
{"questdb2-lnchr",     {NULL}, 5677, "udp"},
{"rrac",               {NULL}, 5678, "tcp"},
{"rrac",               {NULL}, 5678, "udp"},
{"dccm",               {NULL}, 5679, "tcp"},
{"dccm",               {NULL}, 5679, "udp"},
{"auriga-router",      {NULL}, 5680, "tcp"},
{"auriga-router",      {NULL}, 5680, "udp"},
{"ncxcp",              {NULL}, 5681, "tcp"},
{"ncxcp",              {NULL}, 5681, "udp"},
{"brightcore",         {NULL}, 5682, "udp"},
{"ggz",                {NULL}, 5688, "tcp"},
{"ggz",                {NULL}, 5688, "udp"},
{"qmvideo",            {NULL}, 5689, "tcp"},
{"qmvideo",            {NULL}, 5689, "udp"},
{"proshareaudio",      {NULL}, 5713, "tcp"},
{"proshareaudio",      {NULL}, 5713, "udp"},
{"prosharevideo",      {NULL}, 5714, "tcp"},
{"prosharevideo",      {NULL}, 5714, "udp"},
{"prosharedata",       {NULL}, 5715, "tcp"},
{"prosharedata",       {NULL}, 5715, "udp"},
{"prosharerequest",    {NULL}, 5716, "tcp"},
{"prosharerequest",    {NULL}, 5716, "udp"},
{"prosharenotify",     {NULL}, 5717, "tcp"},
{"prosharenotify",     {NULL}, 5717, "udp"},
{"dpm",                {NULL}, 5718, "tcp"},
{"dpm",                {NULL}, 5718, "udp"},
{"dpm-agent",          {NULL}, 5719, "tcp"},
{"dpm-agent",          {NULL}, 5719, "udp"},
{"ms-licensing",       {NULL}, 5720, "tcp"},
{"ms-licensing",       {NULL}, 5720, "udp"},
{"dtpt",               {NULL}, 5721, "tcp"},
{"dtpt",               {NULL}, 5721, "udp"},
{"msdfsr",             {NULL}, 5722, "tcp"},
{"msdfsr",             {NULL}, 5722, "udp"},
{"omhs",               {NULL}, 5723, "tcp"},
{"omhs",               {NULL}, 5723, "udp"},
{"omsdk",              {NULL}, 5724, "tcp"},
{"omsdk",              {NULL}, 5724, "udp"},
{"ms-ilm",             {NULL}, 5725, "tcp"},
{"ms-ilm-sts",         {NULL}, 5726, "tcp"},
{"asgenf",             {NULL}, 5727, "tcp"},
{"io-dist-data",       {NULL}, 5728, "tcp"},
{"io-dist-group",      {NULL}, 5728, "udp"},
{"openmail",           {NULL}, 5729, "tcp"},
{"openmail",           {NULL}, 5729, "udp"},
{"unieng",             {NULL}, 5730, "tcp"},
{"unieng",             {NULL}, 5730, "udp"},
{"ida-discover1",      {NULL}, 5741, "tcp"},
{"ida-discover1",      {NULL}, 5741, "udp"},
{"ida-discover2",      {NULL}, 5742, "tcp"},
{"ida-discover2",      {NULL}, 5742, "udp"},
{"watchdoc-pod",       {NULL}, 5743, "tcp"},
{"watchdoc-pod",       {NULL}, 5743, "udp"},
{"watchdoc",           {NULL}, 5744, "tcp"},
{"watchdoc",           {NULL}, 5744, "udp"},
{"fcopy-server",       {NULL}, 5745, "tcp"},
{"fcopy-server",       {NULL}, 5745, "udp"},
{"fcopys-server",      {NULL}, 5746, "tcp"},
{"fcopys-server",      {NULL}, 5746, "udp"},
{"tunatic",            {NULL}, 5747, "tcp"},
{"tunatic",            {NULL}, 5747, "udp"},
{"tunalyzer",          {NULL}, 5748, "tcp"},
{"tunalyzer",          {NULL}, 5748, "udp"},
{"rscd",               {NULL}, 5750, "tcp"},
{"rscd",               {NULL}, 5750, "udp"},
{"openmailg",          {NULL}, 5755, "tcp"},
{"openmailg",          {NULL}, 5755, "udp"},
{"x500ms",             {NULL}, 5757, "tcp"},
{"x500ms",             {NULL}, 5757, "udp"},
{"openmailns",         {NULL}, 5766, "tcp"},
{"openmailns",         {NULL}, 5766, "udp"},
{"s-openmail",         {NULL}, 5767, "tcp"},
{"s-openmail",         {NULL}, 5767, "udp"},
{"openmailpxy",        {NULL}, 5768, "tcp"},
{"openmailpxy",        {NULL}, 5768, "udp"},
{"spramsca",           {NULL}, 5769, "tcp"},
{"spramsca",           {NULL}, 5769, "udp"},
{"spramsd",            {NULL}, 5770, "tcp"},
{"spramsd",            {NULL}, 5770, "udp"},
{"netagent",           {NULL}, 5771, "tcp"},
{"netagent",           {NULL}, 5771, "udp"},
{"dali-port",          {NULL}, 5777, "tcp"},
{"dali-port",          {NULL}, 5777, "udp"},
{"vts-rpc",            {NULL}, 5780, "tcp"},
{"3par-evts",          {NULL}, 5781, "tcp"},
{"3par-evts",          {NULL}, 5781, "udp"},
{"3par-mgmt",          {NULL}, 5782, "tcp"},
{"3par-mgmt",          {NULL}, 5782, "udp"},
{"3par-mgmt-ssl",      {NULL}, 5783, "tcp"},
{"3par-mgmt-ssl",      {NULL}, 5783, "udp"},
{"ibar",               {NULL}, 5784, "udp"},
{"3par-rcopy",         {NULL}, 5785, "tcp"},
{"3par-rcopy",         {NULL}, 5785, "udp"},
{"cisco-redu",         {NULL}, 5786, "udp"},
{"waascluster",        {NULL}, 5787, "udp"},
{"xtreamx",            {NULL}, 5793, "tcp"},
{"xtreamx",            {NULL}, 5793, "udp"},
{"spdp",               {NULL}, 5794, "udp"},
{"icmpd",              {NULL}, 5813, "tcp"},
{"icmpd",              {NULL}, 5813, "udp"},
{"spt-automation",     {NULL}, 5814, "tcp"},
{"spt-automation",     {NULL}, 5814, "udp"},
{"wherehoo",           {NULL}, 5859, "tcp"},
{"wherehoo",           {NULL}, 5859, "udp"},
{"ppsuitemsg",         {NULL}, 5863, "tcp"},
{"ppsuitemsg",         {NULL}, 5863, "udp"},
{"rfb",                {NULL}, 5900, "tcp"},
{"rfb",                {NULL}, 5900, "udp"},
{"cm",                 {NULL}, 5910, "tcp"},
{"cm",                 {NULL}, 5910, "udp"},
{"cpdlc",              {NULL}, 5911, "tcp"},
{"cpdlc",              {NULL}, 5911, "udp"},
{"fis",                {NULL}, 5912, "tcp"},
{"fis",                {NULL}, 5912, "udp"},
{"ads-c",              {NULL}, 5913, "tcp"},
{"ads-c",              {NULL}, 5913, "udp"},
{"indy",               {NULL}, 5963, "tcp"},
{"indy",               {NULL}, 5963, "udp"},
{"mppolicy-v5",        {NULL}, 5968, "tcp"},
{"mppolicy-v5",        {NULL}, 5968, "udp"},
{"mppolicy-mgr",       {NULL}, 5969, "tcp"},
{"mppolicy-mgr",       {NULL}, 5969, "udp"},
{"couchdb",            {NULL}, 5984, "tcp"},
{"couchdb",            {NULL}, 5984, "udp"},
{"wsman",              {NULL}, 5985, "tcp"},
{"wsman",              {NULL}, 5985, "udp"},
{"wsmans",             {NULL}, 5986, "tcp"},
{"wsmans",             {NULL}, 5986, "udp"},
{"wbem-rmi",           {NULL}, 5987, "tcp"},
{"wbem-rmi",           {NULL}, 5987, "udp"},
{"wbem-http",          {NULL}, 5988, "tcp"},
{"wbem-http",          {NULL}, 5988, "udp"},
{"wbem-https",         {NULL}, 5989, "tcp"},
{"wbem-https",         {NULL}, 5989, "udp"},
{"wbem-exp-https",     {NULL}, 5990, "tcp"},
{"wbem-exp-https",     {NULL}, 5990, "udp"},
{"nuxsl",              {NULL}, 5991, "tcp"},
{"nuxsl",              {NULL}, 5991, "udp"},
{"consul-insight",     {NULL}, 5992, "tcp"},
{"consul-insight",     {NULL}, 5992, "udp"},
{"cvsup",              {NULL}, 5999, "tcp"},
{"cvsup",              {NULL}, 5999, "udp"},
{"ndl-ahp-svc",        {NULL}, 6064, "tcp"},
{"ndl-ahp-svc",        {NULL}, 6064, "udp"},
{"winpharaoh",         {NULL}, 6065, "tcp"},
{"winpharaoh",         {NULL}, 6065, "udp"},
{"ewctsp",             {NULL}, 6066, "tcp"},
{"ewctsp",             {NULL}, 6066, "udp"},
{"gsmp",               {NULL}, 6068, "tcp"},
{"gsmp",               {NULL}, 6068, "udp"},
{"trip",               {NULL}, 6069, "tcp"},
{"trip",               {NULL}, 6069, "udp"},
{"messageasap",        {NULL}, 6070, "tcp"},
{"messageasap",        {NULL}, 6070, "udp"},
{"ssdtp",              {NULL}, 6071, "tcp"},
{"ssdtp",              {NULL}, 6071, "udp"},
{"diagnose-proc",      {NULL}, 6072, "tcp"},
{"diagnose-proc",      {NULL}, 6072, "udp"},
{"directplay8",        {NULL}, 6073, "tcp"},
{"directplay8",        {NULL}, 6073, "udp"},
{"max",                {NULL}, 6074, "tcp"},
{"max",                {NULL}, 6074, "udp"},
{"dpm-acm",            {NULL}, 6075, "tcp"},
{"miami-bcast",        {NULL}, 6083, "udp"},
{"p2p-sip",            {NULL}, 6084, "tcp"},
{"konspire2b",         {NULL}, 6085, "tcp"},
{"konspire2b",         {NULL}, 6085, "udp"},
{"pdtp",               {NULL}, 6086, "tcp"},
{"pdtp",               {NULL}, 6086, "udp"},
{"ldss",               {NULL}, 6087, "tcp"},
{"ldss",               {NULL}, 6087, "udp"},
{"raxa-mgmt",          {NULL}, 6099, "tcp"},
{"synchronet-db",      {NULL}, 6100, "tcp"},
{"synchronet-db",      {NULL}, 6100, "udp"},
{"synchronet-rtc",     {NULL}, 6101, "tcp"},
{"synchronet-rtc",     {NULL}, 6101, "udp"},
{"synchronet-upd",     {NULL}, 6102, "tcp"},
{"synchronet-upd",     {NULL}, 6102, "udp"},
{"rets",               {NULL}, 6103, "tcp"},
{"rets",               {NULL}, 6103, "udp"},
{"dbdb",               {NULL}, 6104, "tcp"},
{"dbdb",               {NULL}, 6104, "udp"},
{"primaserver",        {NULL}, 6105, "tcp"},
{"primaserver",        {NULL}, 6105, "udp"},
{"mpsserver",          {NULL}, 6106, "tcp"},
{"mpsserver",          {NULL}, 6106, "udp"},
{"etc-control",        {NULL}, 6107, "tcp"},
{"etc-control",        {NULL}, 6107, "udp"},
{"sercomm-scadmin",    {NULL}, 6108, "tcp"},
{"sercomm-scadmin",    {NULL}, 6108, "udp"},
{"globecast-id",       {NULL}, 6109, "tcp"},
{"globecast-id",       {NULL}, 6109, "udp"},
{"softcm",             {NULL}, 6110, "tcp"},
{"softcm",             {NULL}, 6110, "udp"},
{"spc",                {NULL}, 6111, "tcp"},
{"spc",                {NULL}, 6111, "udp"},
{"dtspcd",             {NULL}, 6112, "tcp"},
{"dtspcd",             {NULL}, 6112, "udp"},
{"dayliteserver",      {NULL}, 6113, "tcp"},
{"wrspice",            {NULL}, 6114, "tcp"},
{"xic",                {NULL}, 6115, "tcp"},
{"xtlserv",            {NULL}, 6116, "tcp"},
{"daylitetouch",       {NULL}, 6117, "tcp"},
{"spdy",               {NULL}, 6121, "tcp"},
{"bex-webadmin",       {NULL}, 6122, "tcp"},
{"bex-webadmin",       {NULL}, 6122, "udp"},
{"backup-express",     {NULL}, 6123, "tcp"},
{"backup-express",     {NULL}, 6123, "udp"},
{"pnbs",               {NULL}, 6124, "tcp"},
{"pnbs",               {NULL}, 6124, "udp"},
{"nbt-wol",            {NULL}, 6133, "tcp"},
{"nbt-wol",            {NULL}, 6133, "udp"},
{"pulsonixnls",        {NULL}, 6140, "tcp"},
{"pulsonixnls",        {NULL}, 6140, "udp"},
{"meta-corp",          {NULL}, 6141, "tcp"},
{"meta-corp",          {NULL}, 6141, "udp"},
{"aspentec-lm",        {NULL}, 6142, "tcp"},
{"aspentec-lm",        {NULL}, 6142, "udp"},
{"watershed-lm",       {NULL}, 6143, "tcp"},
{"watershed-lm",       {NULL}, 6143, "udp"},
{"statsci1-lm",        {NULL}, 6144, "tcp"},
{"statsci1-lm",        {NULL}, 6144, "udp"},
{"statsci2-lm",        {NULL}, 6145, "tcp"},
{"statsci2-lm",        {NULL}, 6145, "udp"},
{"lonewolf-lm",        {NULL}, 6146, "tcp"},
{"lonewolf-lm",        {NULL}, 6146, "udp"},
{"montage-lm",         {NULL}, 6147, "tcp"},
{"montage-lm",         {NULL}, 6147, "udp"},
{"ricardo-lm",         {NULL}, 6148, "tcp"},
{"ricardo-lm",         {NULL}, 6148, "udp"},
{"tal-pod",            {NULL}, 6149, "tcp"},
{"tal-pod",            {NULL}, 6149, "udp"},
{"efb-aci",            {NULL}, 6159, "tcp"},
{"patrol-ism",         {NULL}, 6161, "tcp"},
{"patrol-ism",         {NULL}, 6161, "udp"},
{"patrol-coll",        {NULL}, 6162, "tcp"},
{"patrol-coll",        {NULL}, 6162, "udp"},
{"pscribe",            {NULL}, 6163, "tcp"},
{"pscribe",            {NULL}, 6163, "udp"},
{"lm-x",               {NULL}, 6200, "tcp"},
{"lm-x",               {NULL}, 6200, "udp"},
{"radmind",            {NULL}, 6222, "tcp"},
{"radmind",            {NULL}, 6222, "udp"},
{"jeol-nsdtp-1",       {NULL}, 6241, "tcp"},
{"jeol-nsddp-1",       {NULL}, 6241, "udp"},
{"jeol-nsdtp-2",       {NULL}, 6242, "tcp"},
{"jeol-nsddp-2",       {NULL}, 6242, "udp"},
{"jeol-nsdtp-3",       {NULL}, 6243, "tcp"},
{"jeol-nsddp-3",       {NULL}, 6243, "udp"},
{"jeol-nsdtp-4",       {NULL}, 6244, "tcp"},
{"jeol-nsddp-4",       {NULL}, 6244, "udp"},
{"tl1-raw-ssl",        {NULL}, 6251, "tcp"},
{"tl1-raw-ssl",        {NULL}, 6251, "udp"},
{"tl1-ssh",            {NULL}, 6252, "tcp"},
{"tl1-ssh",            {NULL}, 6252, "udp"},
{"crip",               {NULL}, 6253, "tcp"},
{"crip",               {NULL}, 6253, "udp"},
{"gld",                {NULL}, 6267, "tcp"},
{"grid",               {NULL}, 6268, "tcp"},
{"grid",               {NULL}, 6268, "udp"},
{"grid-alt",           {NULL}, 6269, "tcp"},
{"grid-alt",           {NULL}, 6269, "udp"},
{"bmc-grx",            {NULL}, 6300, "tcp"},
{"bmc-grx",            {NULL}, 6300, "udp"},
{"bmc_ctd_ldap",       {NULL}, 6301, "tcp"},
{"bmc_ctd_ldap",       {NULL}, 6301, "udp"},
{"ufmp",               {NULL}, 6306, "tcp"},
{"ufmp",               {NULL}, 6306, "udp"},
{"scup",               {NULL}, 6315, "tcp"},
{"scup-disc",          {NULL}, 6315, "udp"},
{"abb-escp",           {NULL}, 6316, "tcp"},
{"abb-escp",           {NULL}, 6316, "udp"},
{"repsvc",             {NULL}, 6320, "tcp"},
{"repsvc",             {NULL}, 6320, "udp"},
{"emp-server1",        {NULL}, 6321, "tcp"},
{"emp-server1",        {NULL}, 6321, "udp"},
{"emp-server2",        {NULL}, 6322, "tcp"},
{"emp-server2",        {NULL}, 6322, "udp"},
{"sflow",              {NULL}, 6343, "tcp"},
{"sflow",              {NULL}, 6343, "udp"},
{"gnutella-svc",       {NULL}, 6346, "tcp"},
{"gnutella-svc",       {NULL}, 6346, "udp"},
{"gnutella-rtr",       {NULL}, 6347, "tcp"},
{"gnutella-rtr",       {NULL}, 6347, "udp"},
{"adap",               {NULL}, 6350, "tcp"},
{"adap",               {NULL}, 6350, "udp"},
{"pmcs",               {NULL}, 6355, "tcp"},
{"pmcs",               {NULL}, 6355, "udp"},
{"metaedit-mu",        {NULL}, 6360, "tcp"},
{"metaedit-mu",        {NULL}, 6360, "udp"},
{"metaedit-se",        {NULL}, 6370, "tcp"},
{"metaedit-se",        {NULL}, 6370, "udp"},
{"metatude-mds",       {NULL}, 6382, "tcp"},
{"metatude-mds",       {NULL}, 6382, "udp"},
{"clariion-evr01",     {NULL}, 6389, "tcp"},
{"clariion-evr01",     {NULL}, 6389, "udp"},
{"metaedit-ws",        {NULL}, 6390, "tcp"},
{"metaedit-ws",        {NULL}, 6390, "udp"},
{"faxcomservice",      {NULL}, 6417, "tcp"},
{"faxcomservice",      {NULL}, 6417, "udp"},
{"syserverremote",     {NULL}, 6418, "tcp"},
{"svdrp",              {NULL}, 6419, "tcp"},
{"nim-vdrshell",       {NULL}, 6420, "tcp"},
{"nim-vdrshell",       {NULL}, 6420, "udp"},
{"nim-wan",            {NULL}, 6421, "tcp"},
{"nim-wan",            {NULL}, 6421, "udp"},
{"pgbouncer",          {NULL}, 6432, "tcp"},
{"sun-sr-https",       {NULL}, 6443, "tcp"},
{"sun-sr-https",       {NULL}, 6443, "udp"},
{"sge_qmaster",        {NULL}, 6444, "tcp"},
{"sge_qmaster",        {NULL}, 6444, "udp"},
{"sge_execd",          {NULL}, 6445, "tcp"},
{"sge_execd",          {NULL}, 6445, "udp"},
{"mysql-proxy",        {NULL}, 6446, "tcp"},
{"mysql-proxy",        {NULL}, 6446, "udp"},
{"skip-cert-recv",     {NULL}, 6455, "tcp"},
{"skip-cert-send",     {NULL}, 6456, "udp"},
{"lvision-lm",         {NULL}, 6471, "tcp"},
{"lvision-lm",         {NULL}, 6471, "udp"},
{"sun-sr-http",        {NULL}, 6480, "tcp"},
{"sun-sr-http",        {NULL}, 6480, "udp"},
{"servicetags",        {NULL}, 6481, "tcp"},
{"servicetags",        {NULL}, 6481, "udp"},
{"ldoms-mgmt",         {NULL}, 6482, "tcp"},
{"ldoms-mgmt",         {NULL}, 6482, "udp"},
{"SunVTS-RMI",         {NULL}, 6483, "tcp"},
{"SunVTS-RMI",         {NULL}, 6483, "udp"},
{"sun-sr-jms",         {NULL}, 6484, "tcp"},
{"sun-sr-jms",         {NULL}, 6484, "udp"},
{"sun-sr-iiop",        {NULL}, 6485, "tcp"},
{"sun-sr-iiop",        {NULL}, 6485, "udp"},
{"sun-sr-iiops",       {NULL}, 6486, "tcp"},
{"sun-sr-iiops",       {NULL}, 6486, "udp"},
{"sun-sr-iiop-aut",    {NULL}, 6487, "tcp"},
{"sun-sr-iiop-aut",    {NULL}, 6487, "udp"},
{"sun-sr-jmx",         {NULL}, 6488, "tcp"},
{"sun-sr-jmx",         {NULL}, 6488, "udp"},
{"sun-sr-admin",       {NULL}, 6489, "tcp"},
{"sun-sr-admin",       {NULL}, 6489, "udp"},
{"boks",               {NULL}, 6500, "tcp"},
{"boks",               {NULL}, 6500, "udp"},
{"boks_servc",         {NULL}, 6501, "tcp"},
{"boks_servc",         {NULL}, 6501, "udp"},
{"boks_servm",         {NULL}, 6502, "tcp"},
{"boks_servm",         {NULL}, 6502, "udp"},
{"boks_clntd",         {NULL}, 6503, "tcp"},
{"boks_clntd",         {NULL}, 6503, "udp"},
{"badm_priv",          {NULL}, 6505, "tcp"},
{"badm_priv",          {NULL}, 6505, "udp"},
{"badm_pub",           {NULL}, 6506, "tcp"},
{"badm_pub",           {NULL}, 6506, "udp"},
{"bdir_priv",          {NULL}, 6507, "tcp"},
{"bdir_priv",          {NULL}, 6507, "udp"},
{"bdir_pub",           {NULL}, 6508, "tcp"},
{"bdir_pub",           {NULL}, 6508, "udp"},
{"mgcs-mfp-port",      {NULL}, 6509, "tcp"},
{"mgcs-mfp-port",      {NULL}, 6509, "udp"},
{"mcer-port",          {NULL}, 6510, "tcp"},
{"mcer-port",          {NULL}, 6510, "udp"},
{"netconf-tls",        {NULL}, 6513, "tcp"},
{"syslog-tls",         {NULL}, 6514, "tcp"},
{"syslog-tls",         {NULL}, 6514, "udp"},
{"syslog-tls",         {NULL}, 6514, "dccp"},
{"elipse-rec",         {NULL}, 6515, "tcp"},
{"elipse-rec",         {NULL}, 6515, "udp"},
{"lds-distrib",        {NULL}, 6543, "tcp"},
{"lds-distrib",        {NULL}, 6543, "udp"},
{"lds-dump",           {NULL}, 6544, "tcp"},
{"lds-dump",           {NULL}, 6544, "udp"},
{"apc-6547",           {NULL}, 6547, "tcp"},
{"apc-6547",           {NULL}, 6547, "udp"},
{"apc-6548",           {NULL}, 6548, "tcp"},
{"apc-6548",           {NULL}, 6548, "udp"},
{"apc-6549",           {NULL}, 6549, "tcp"},
{"apc-6549",           {NULL}, 6549, "udp"},
{"fg-sysupdate",       {NULL}, 6550, "tcp"},
{"fg-sysupdate",       {NULL}, 6550, "udp"},
{"sum",                {NULL}, 6551, "tcp"},
{"sum",                {NULL}, 6551, "udp"},
{"xdsxdm",             {NULL}, 6558, "tcp"},
{"xdsxdm",             {NULL}, 6558, "udp"},
{"sane-port",          {NULL}, 6566, "tcp"},
{"sane-port",          {NULL}, 6566, "udp"},
{"esp",                {NULL}, 6567, "tcp"},
{"esp",                {NULL}, 6567, "udp"},
{"canit_store",        {NULL}, 6568, "tcp"},
{"rp-reputation",      {NULL}, 6568, "udp"},
{"affiliate",          {NULL}, 6579, "tcp"},
{"affiliate",          {NULL}, 6579, "udp"},
{"parsec-master",      {NULL}, 6580, "tcp"},
{"parsec-master",      {NULL}, 6580, "udp"},
{"parsec-peer",        {NULL}, 6581, "tcp"},
{"parsec-peer",        {NULL}, 6581, "udp"},
{"parsec-game",        {NULL}, 6582, "tcp"},
{"parsec-game",        {NULL}, 6582, "udp"},
{"joaJewelSuite",      {NULL}, 6583, "tcp"},
{"joaJewelSuite",      {NULL}, 6583, "udp"},
{"mshvlm",             {NULL}, 6600, "tcp"},
{"mstmg-sstp",         {NULL}, 6601, "tcp"},
{"wsscomfrmwk",        {NULL}, 6602, "tcp"},
{"odette-ftps",        {NULL}, 6619, "tcp"},
{"odette-ftps",        {NULL}, 6619, "udp"},
{"kftp-data",          {NULL}, 6620, "tcp"},
{"kftp-data",          {NULL}, 6620, "udp"},
{"kftp",               {NULL}, 6621, "tcp"},
{"kftp",               {NULL}, 6621, "udp"},
{"mcftp",              {NULL}, 6622, "tcp"},
{"mcftp",              {NULL}, 6622, "udp"},
{"ktelnet",            {NULL}, 6623, "tcp"},
{"ktelnet",            {NULL}, 6623, "udp"},
{"datascaler-db",      {NULL}, 6624, "tcp"},
{"datascaler-ctl",     {NULL}, 6625, "tcp"},
{"wago-service",       {NULL}, 6626, "tcp"},
{"wago-service",       {NULL}, 6626, "udp"},
{"nexgen",             {NULL}, 6627, "tcp"},
{"nexgen",             {NULL}, 6627, "udp"},
{"afesc-mc",           {NULL}, 6628, "tcp"},
{"afesc-mc",           {NULL}, 6628, "udp"},
{"mxodbc-connect",     {NULL}, 6632, "tcp"},
{"pcs-sf-ui-man",      {NULL}, 6655, "tcp"},
{"emgmsg",             {NULL}, 6656, "tcp"},
{"palcom-disc",        {NULL}, 6657, "udp"},
{"vocaltec-gold",      {NULL}, 6670, "tcp"},
{"vocaltec-gold",      {NULL}, 6670, "udp"},
{"p4p-portal",         {NULL}, 6671, "tcp"},
{"p4p-portal",         {NULL}, 6671, "udp"},
{"vision_server",      {NULL}, 6672, "tcp"},
{"vision_server",      {NULL}, 6672, "udp"},
{"vision_elmd",        {NULL}, 6673, "tcp"},
{"vision_elmd",        {NULL}, 6673, "udp"},
{"vfbp",               {NULL}, 6678, "tcp"},
{"vfbp-disc",          {NULL}, 6678, "udp"},
{"osaut",              {NULL}, 6679, "tcp"},
{"osaut",              {NULL}, 6679, "udp"},
{"clever-ctrace",      {NULL}, 6687, "tcp"},
{"clever-tcpip",       {NULL}, 6688, "tcp"},
{"tsa",                {NULL}, 6689, "tcp"},
{"tsa",                {NULL}, 6689, "udp"},
{"babel",              {NULL}, 6697, "udp"},
{"kti-icad-srvr",      {NULL}, 6701, "tcp"},
{"kti-icad-srvr",      {NULL}, 6701, "udp"},
{"e-design-net",       {NULL}, 6702, "tcp"},
{"e-design-net",       {NULL}, 6702, "udp"},
{"e-design-web",       {NULL}, 6703, "tcp"},
{"e-design-web",       {NULL}, 6703, "udp"},
{"frc-hp",             {NULL}, 6704, "sctp"},
{"frc-mp",             {NULL}, 6705, "sctp"},
{"frc-lp",             {NULL}, 6706, "sctp"},
{"ibprotocol",         {NULL}, 6714, "tcp"},
{"ibprotocol",         {NULL}, 6714, "udp"},
{"fibotrader-com",     {NULL}, 6715, "tcp"},
{"fibotrader-com",     {NULL}, 6715, "udp"},
{"bmc-perf-agent",     {NULL}, 6767, "tcp"},
{"bmc-perf-agent",     {NULL}, 6767, "udp"},
{"bmc-perf-mgrd",      {NULL}, 6768, "tcp"},
{"bmc-perf-mgrd",      {NULL}, 6768, "udp"},
{"adi-gxp-srvprt",     {NULL}, 6769, "tcp"},
{"adi-gxp-srvprt",     {NULL}, 6769, "udp"},
{"plysrv-http",        {NULL}, 6770, "tcp"},
{"plysrv-http",        {NULL}, 6770, "udp"},
{"plysrv-https",       {NULL}, 6771, "tcp"},
{"plysrv-https",       {NULL}, 6771, "udp"},
{"dgpf-exchg",         {NULL}, 6785, "tcp"},
{"dgpf-exchg",         {NULL}, 6785, "udp"},
{"smc-jmx",            {NULL}, 6786, "tcp"},
{"smc-jmx",            {NULL}, 6786, "udp"},
{"smc-admin",          {NULL}, 6787, "tcp"},
{"smc-admin",          {NULL}, 6787, "udp"},
{"smc-http",           {NULL}, 6788, "tcp"},
{"smc-http",           {NULL}, 6788, "udp"},
{"smc-https",          {NULL}, 6789, "tcp"},
{"smc-https",          {NULL}, 6789, "udp"},
{"hnmp",               {NULL}, 6790, "tcp"},
{"hnmp",               {NULL}, 6790, "udp"},
{"hnm",                {NULL}, 6791, "tcp"},
{"hnm",                {NULL}, 6791, "udp"},
{"acnet",              {NULL}, 6801, "tcp"},
{"acnet",              {NULL}, 6801, "udp"},
{"pentbox-sim",        {NULL}, 6817, "tcp"},
{"ambit-lm",           {NULL}, 6831, "tcp"},
{"ambit-lm",           {NULL}, 6831, "udp"},
{"netmo-default",      {NULL}, 6841, "tcp"},
{"netmo-default",      {NULL}, 6841, "udp"},
{"netmo-http",         {NULL}, 6842, "tcp"},
{"netmo-http",         {NULL}, 6842, "udp"},
{"iccrushmore",        {NULL}, 6850, "tcp"},
{"iccrushmore",        {NULL}, 6850, "udp"},
{"acctopus-cc",        {NULL}, 6868, "tcp"},
{"acctopus-st",        {NULL}, 6868, "udp"},
{"muse",               {NULL}, 6888, "tcp"},
{"muse",               {NULL}, 6888, "udp"},
{"jetstream",          {NULL}, 6901, "tcp"},
{"xsmsvc",             {NULL}, 6936, "tcp"},
{"xsmsvc",             {NULL}, 6936, "udp"},
{"bioserver",          {NULL}, 6946, "tcp"},
{"bioserver",          {NULL}, 6946, "udp"},
{"otlp",               {NULL}, 6951, "tcp"},
{"otlp",               {NULL}, 6951, "udp"},
{"jmact3",             {NULL}, 6961, "tcp"},
{"jmact3",             {NULL}, 6961, "udp"},
{"jmevt2",             {NULL}, 6962, "tcp"},
{"jmevt2",             {NULL}, 6962, "udp"},
{"swismgr1",           {NULL}, 6963, "tcp"},
{"swismgr1",           {NULL}, 6963, "udp"},
{"swismgr2",           {NULL}, 6964, "tcp"},
{"swismgr2",           {NULL}, 6964, "udp"},
{"swistrap",           {NULL}, 6965, "tcp"},
{"swistrap",           {NULL}, 6965, "udp"},
{"swispol",            {NULL}, 6966, "tcp"},
{"swispol",            {NULL}, 6966, "udp"},
{"acmsoda",            {NULL}, 6969, "tcp"},
{"acmsoda",            {NULL}, 6969, "udp"},
{"MobilitySrv",        {NULL}, 6997, "tcp"},
{"MobilitySrv",        {NULL}, 6997, "udp"},
{"iatp-highpri",       {NULL}, 6998, "tcp"},
{"iatp-highpri",       {NULL}, 6998, "udp"},
{"iatp-normalpri",     {NULL}, 6999, "tcp"},
{"iatp-normalpri",     {NULL}, 6999, "udp"},
{"afs3-fileserver",    {NULL}, 7000, "tcp"},
{"afs3-fileserver",    {NULL}, 7000, "udp"},
{"afs3-callback",      {NULL}, 7001, "tcp"},
{"afs3-callback",      {NULL}, 7001, "udp"},
{"afs3-prserver",      {NULL}, 7002, "tcp"},
{"afs3-prserver",      {NULL}, 7002, "udp"},
{"afs3-vlserver",      {NULL}, 7003, "tcp"},
{"afs3-vlserver",      {NULL}, 7003, "udp"},
{"afs3-kaserver",      {NULL}, 7004, "tcp"},
{"afs3-kaserver",      {NULL}, 7004, "udp"},
{"afs3-volser",        {NULL}, 7005, "tcp"},
{"afs3-volser",        {NULL}, 7005, "udp"},
{"afs3-errors",        {NULL}, 7006, "tcp"},
{"afs3-errors",        {NULL}, 7006, "udp"},
{"afs3-bos",           {NULL}, 7007, "tcp"},
{"afs3-bos",           {NULL}, 7007, "udp"},
{"afs3-update",        {NULL}, 7008, "tcp"},
{"afs3-update",        {NULL}, 7008, "udp"},
{"afs3-rmtsys",        {NULL}, 7009, "tcp"},
{"afs3-rmtsys",        {NULL}, 7009, "udp"},
{"ups-onlinet",        {NULL}, 7010, "tcp"},
{"ups-onlinet",        {NULL}, 7010, "udp"},
{"talon-disc",         {NULL}, 7011, "tcp"},
{"talon-disc",         {NULL}, 7011, "udp"},
{"talon-engine",       {NULL}, 7012, "tcp"},
{"talon-engine",       {NULL}, 7012, "udp"},
{"microtalon-dis",     {NULL}, 7013, "tcp"},
{"microtalon-dis",     {NULL}, 7013, "udp"},
{"microtalon-com",     {NULL}, 7014, "tcp"},
{"microtalon-com",     {NULL}, 7014, "udp"},
{"talon-webserver",    {NULL}, 7015, "tcp"},
{"talon-webserver",    {NULL}, 7015, "udp"},
{"dpserve",            {NULL}, 7020, "tcp"},
{"dpserve",            {NULL}, 7020, "udp"},
{"dpserveadmin",       {NULL}, 7021, "tcp"},
{"dpserveadmin",       {NULL}, 7021, "udp"},
{"ctdp",               {NULL}, 7022, "tcp"},
{"ctdp",               {NULL}, 7022, "udp"},
{"ct2nmcs",            {NULL}, 7023, "tcp"},
{"ct2nmcs",            {NULL}, 7023, "udp"},
{"vmsvc",              {NULL}, 7024, "tcp"},
{"vmsvc",              {NULL}, 7024, "udp"},
{"vmsvc-2",            {NULL}, 7025, "tcp"},
{"vmsvc-2",            {NULL}, 7025, "udp"},
{"op-probe",           {NULL}, 7030, "tcp"},
{"op-probe",           {NULL}, 7030, "udp"},
{"arcp",               {NULL}, 7070, "tcp"},
{"arcp",               {NULL}, 7070, "udp"},
{"iwg1",               {NULL}, 7071, "tcp"},
{"iwg1",               {NULL}, 7071, "udp"},
{"empowerid",          {NULL}, 7080, "tcp"},
{"empowerid",          {NULL}, 7080, "udp"},
{"lazy-ptop",          {NULL}, 7099, "tcp"},
{"lazy-ptop",          {NULL}, 7099, "udp"},
{"font-service",       {NULL}, 7100, "tcp"},
{"font-service",       {NULL}, 7100, "udp"},
{"elcn",               {NULL}, 7101, "tcp"},
{"elcn",               {NULL}, 7101, "udp"},
{"aes-x170",           {NULL}, 7107, "udp"},
{"virprot-lm",         {NULL}, 7121, "tcp"},
{"virprot-lm",         {NULL}, 7121, "udp"},
{"scenidm",            {NULL}, 7128, "tcp"},
{"scenidm",            {NULL}, 7128, "udp"},
{"scenccs",            {NULL}, 7129, "tcp"},
{"scenccs",            {NULL}, 7129, "udp"},
{"cabsm-comm",         {NULL}, 7161, "tcp"},
{"cabsm-comm",         {NULL}, 7161, "udp"},
{"caistoragemgr",      {NULL}, 7162, "tcp"},
{"caistoragemgr",      {NULL}, 7162, "udp"},
{"cacsambroker",       {NULL}, 7163, "tcp"},
{"cacsambroker",       {NULL}, 7163, "udp"},
{"fsr",                {NULL}, 7164, "tcp"},
{"fsr",                {NULL}, 7164, "udp"},
{"doc-server",         {NULL}, 7165, "tcp"},
{"doc-server",         {NULL}, 7165, "udp"},
{"aruba-server",       {NULL}, 7166, "tcp"},
{"aruba-server",       {NULL}, 7166, "udp"},
{"casrmagent",         {NULL}, 7167, "tcp"},
{"cnckadserver",       {NULL}, 7168, "tcp"},
{"ccag-pib",           {NULL}, 7169, "tcp"},
{"ccag-pib",           {NULL}, 7169, "udp"},
{"nsrp",               {NULL}, 7170, "tcp"},
{"nsrp",               {NULL}, 7170, "udp"},
{"drm-production",     {NULL}, 7171, "tcp"},
{"drm-production",     {NULL}, 7171, "udp"},
{"zsecure",            {NULL}, 7173, "tcp"},
{"clutild",            {NULL}, 7174, "tcp"},
{"clutild",            {NULL}, 7174, "udp"},
{"fodms",              {NULL}, 7200, "tcp"},
{"fodms",              {NULL}, 7200, "udp"},
{"dlip",               {NULL}, 7201, "tcp"},
{"dlip",               {NULL}, 7201, "udp"},
{"ramp",               {NULL}, 7227, "tcp"},
{"ramp",               {NULL}, 7227, "udp"},
{"citrixupp",          {NULL}, 7228, "tcp"},
{"citrixuppg",         {NULL}, 7229, "tcp"},
{"pads",               {NULL}, 7237, "tcp"},
{"cnap",               {NULL}, 7262, "tcp"},
{"cnap",               {NULL}, 7262, "udp"},
{"watchme-7272",       {NULL}, 7272, "tcp"},
{"watchme-7272",       {NULL}, 7272, "udp"},
{"oma-rlp",            {NULL}, 7273, "tcp"},
{"oma-rlp",            {NULL}, 7273, "udp"},
{"oma-rlp-s",          {NULL}, 7274, "tcp"},
{"oma-rlp-s",          {NULL}, 7274, "udp"},
{"oma-ulp",            {NULL}, 7275, "tcp"},
{"oma-ulp",            {NULL}, 7275, "udp"},
{"oma-ilp",            {NULL}, 7276, "tcp"},
{"oma-ilp",            {NULL}, 7276, "udp"},
{"oma-ilp-s",          {NULL}, 7277, "tcp"},
{"oma-ilp-s",          {NULL}, 7277, "udp"},
{"oma-dcdocbs",        {NULL}, 7278, "tcp"},
{"oma-dcdocbs",        {NULL}, 7278, "udp"},
{"ctxlic",             {NULL}, 7279, "tcp"},
{"ctxlic",             {NULL}, 7279, "udp"},
{"itactionserver1",    {NULL}, 7280, "tcp"},
{"itactionserver1",    {NULL}, 7280, "udp"},
{"itactionserver2",    {NULL}, 7281, "tcp"},
{"itactionserver2",    {NULL}, 7281, "udp"},
{"mzca-action",        {NULL}, 7282, "tcp"},
{"mzca-alert",         {NULL}, 7282, "udp"},
{"lcm-server",         {NULL}, 7365, "tcp"},
{"lcm-server",         {NULL}, 7365, "udp"},
{"mindfilesys",        {NULL}, 7391, "tcp"},
{"mindfilesys",        {NULL}, 7391, "udp"},
{"mrssrendezvous",     {NULL}, 7392, "tcp"},
{"mrssrendezvous",     {NULL}, 7392, "udp"},
{"nfoldman",           {NULL}, 7393, "tcp"},
{"nfoldman",           {NULL}, 7393, "udp"},
{"fse",                {NULL}, 7394, "tcp"},
{"fse",                {NULL}, 7394, "udp"},
{"winqedit",           {NULL}, 7395, "tcp"},
{"winqedit",           {NULL}, 7395, "udp"},
{"hexarc",             {NULL}, 7397, "tcp"},
{"hexarc",             {NULL}, 7397, "udp"},
{"rtps-discovery",     {NULL}, 7400, "tcp"},
{"rtps-discovery",     {NULL}, 7400, "udp"},
{"rtps-dd-ut",         {NULL}, 7401, "tcp"},
{"rtps-dd-ut",         {NULL}, 7401, "udp"},
{"rtps-dd-mt",         {NULL}, 7402, "tcp"},
{"rtps-dd-mt",         {NULL}, 7402, "udp"},
{"ionixnetmon",        {NULL}, 7410, "tcp"},
{"ionixnetmon",        {NULL}, 7410, "udp"},
{"mtportmon",          {NULL}, 7421, "tcp"},
{"mtportmon",          {NULL}, 7421, "udp"},
{"pmdmgr",             {NULL}, 7426, "tcp"},
{"pmdmgr",             {NULL}, 7426, "udp"},
{"oveadmgr",           {NULL}, 7427, "tcp"},
{"oveadmgr",           {NULL}, 7427, "udp"},
{"ovladmgr",           {NULL}, 7428, "tcp"},
{"ovladmgr",           {NULL}, 7428, "udp"},
{"opi-sock",           {NULL}, 7429, "tcp"},
{"opi-sock",           {NULL}, 7429, "udp"},
{"xmpv7",              {NULL}, 7430, "tcp"},
{"xmpv7",              {NULL}, 7430, "udp"},
{"pmd",                {NULL}, 7431, "tcp"},
{"pmd",                {NULL}, 7431, "udp"},
{"faximum",            {NULL}, 7437, "tcp"},
{"faximum",            {NULL}, 7437, "udp"},
{"oracleas-https",     {NULL}, 7443, "tcp"},
{"oracleas-https",     {NULL}, 7443, "udp"},
{"rise",               {NULL}, 7473, "tcp"},
{"rise",               {NULL}, 7473, "udp"},
{"telops-lmd",         {NULL}, 7491, "tcp"},
{"telops-lmd",         {NULL}, 7491, "udp"},
{"silhouette",         {NULL}, 7500, "tcp"},
{"silhouette",         {NULL}, 7500, "udp"},
{"ovbus",              {NULL}, 7501, "tcp"},
{"ovbus",              {NULL}, 7501, "udp"},
{"acplt",              {NULL}, 7509, "tcp"},
{"ovhpas",             {NULL}, 7510, "tcp"},
{"ovhpas",             {NULL}, 7510, "udp"},
{"pafec-lm",           {NULL}, 7511, "tcp"},
{"pafec-lm",           {NULL}, 7511, "udp"},
{"saratoga",           {NULL}, 7542, "tcp"},
{"saratoga",           {NULL}, 7542, "udp"},
{"atul",               {NULL}, 7543, "tcp"},
{"atul",               {NULL}, 7543, "udp"},
{"nta-ds",             {NULL}, 7544, "tcp"},
{"nta-ds",             {NULL}, 7544, "udp"},
{"nta-us",             {NULL}, 7545, "tcp"},
{"nta-us",             {NULL}, 7545, "udp"},
{"cfs",                {NULL}, 7546, "tcp"},
{"cfs",                {NULL}, 7546, "udp"},
{"cwmp",               {NULL}, 7547, "tcp"},
{"cwmp",               {NULL}, 7547, "udp"},
{"tidp",               {NULL}, 7548, "tcp"},
{"tidp",               {NULL}, 7548, "udp"},
{"nls-tl",             {NULL}, 7549, "tcp"},
{"nls-tl",             {NULL}, 7549, "udp"},
{"sncp",               {NULL}, 7560, "tcp"},
{"sncp",               {NULL}, 7560, "udp"},
{"cfw",                {NULL}, 7563, "tcp"},
{"vsi-omega",          {NULL}, 7566, "tcp"},
{"vsi-omega",          {NULL}, 7566, "udp"},
{"dell-eql-asm",       {NULL}, 7569, "tcp"},
{"aries-kfinder",      {NULL}, 7570, "tcp"},
{"aries-kfinder",      {NULL}, 7570, "udp"},
{"sun-lm",             {NULL}, 7588, "tcp"},
{"sun-lm",             {NULL}, 7588, "udp"},
{"indi",               {NULL}, 7624, "tcp"},
{"indi",               {NULL}, 7624, "udp"},
{"simco",              {NULL}, 7626, "tcp"},
{"simco",              {NULL}, 7626, "sctp"},
{"soap-http",          {NULL}, 7627, "tcp"},
{"soap-http",          {NULL}, 7627, "udp"},
{"zen-pawn",           {NULL}, 7628, "tcp"},
{"zen-pawn",           {NULL}, 7628, "udp"},
{"xdas",               {NULL}, 7629, "tcp"},
{"xdas",               {NULL}, 7629, "udp"},
{"hawk",               {NULL}, 7630, "tcp"},
{"tesla-sys-msg",      {NULL}, 7631, "tcp"},
{"pmdfmgt",            {NULL}, 7633, "tcp"},
{"pmdfmgt",            {NULL}, 7633, "udp"},
{"cuseeme",            {NULL}, 7648, "tcp"},
{"cuseeme",            {NULL}, 7648, "udp"},
{"imqstomp",           {NULL}, 7672, "tcp"},
{"imqstomps",          {NULL}, 7673, "tcp"},
{"imqtunnels",         {NULL}, 7674, "tcp"},
{"imqtunnels",         {NULL}, 7674, "udp"},
{"imqtunnel",          {NULL}, 7675, "tcp"},
{"imqtunnel",          {NULL}, 7675, "udp"},
{"imqbrokerd",         {NULL}, 7676, "tcp"},
{"imqbrokerd",         {NULL}, 7676, "udp"},
{"sun-user-https",     {NULL}, 7677, "tcp"},
{"sun-user-https",     {NULL}, 7677, "udp"},
{"pando-pub",          {NULL}, 7680, "tcp"},
{"pando-pub",          {NULL}, 7680, "udp"},
{"collaber",           {NULL}, 7689, "tcp"},
{"collaber",           {NULL}, 7689, "udp"},
{"klio",               {NULL}, 7697, "tcp"},
{"klio",               {NULL}, 7697, "udp"},
{"em7-secom",          {NULL}, 7700, "tcp"},
{"sync-em7",           {NULL}, 7707, "tcp"},
{"sync-em7",           {NULL}, 7707, "udp"},
{"scinet",             {NULL}, 7708, "tcp"},
{"scinet",             {NULL}, 7708, "udp"},
{"medimageportal",     {NULL}, 7720, "tcp"},
{"medimageportal",     {NULL}, 7720, "udp"},
{"nsdeepfreezectl",    {NULL}, 7724, "tcp"},
{"nsdeepfreezectl",    {NULL}, 7724, "udp"},
{"nitrogen",           {NULL}, 7725, "tcp"},
{"nitrogen",           {NULL}, 7725, "udp"},
{"freezexservice",     {NULL}, 7726, "tcp"},
{"freezexservice",     {NULL}, 7726, "udp"},
{"trident-data",       {NULL}, 7727, "tcp"},
{"trident-data",       {NULL}, 7727, "udp"},
{"smip",               {NULL}, 7734, "tcp"},
{"smip",               {NULL}, 7734, "udp"},
{"aiagent",            {NULL}, 7738, "tcp"},
{"aiagent",            {NULL}, 7738, "udp"},
{"scriptview",         {NULL}, 7741, "tcp"},
{"scriptview",         {NULL}, 7741, "udp"},
{"msss",               {NULL}, 7742, "tcp"},
{"sstp-1",             {NULL}, 7743, "tcp"},
{"sstp-1",             {NULL}, 7743, "udp"},
{"raqmon-pdu",         {NULL}, 7744, "tcp"},
{"raqmon-pdu",         {NULL}, 7744, "udp"},
{"prgp",               {NULL}, 7747, "tcp"},
{"prgp",               {NULL}, 7747, "udp"},
{"cbt",                {NULL}, 7777, "tcp"},
{"cbt",                {NULL}, 7777, "udp"},
{"interwise",          {NULL}, 7778, "tcp"},
{"interwise",          {NULL}, 7778, "udp"},
{"vstat",              {NULL}, 7779, "tcp"},
{"vstat",              {NULL}, 7779, "udp"},
{"accu-lmgr",          {NULL}, 7781, "tcp"},
{"accu-lmgr",          {NULL}, 7781, "udp"},
{"minivend",           {NULL}, 7786, "tcp"},
{"minivend",           {NULL}, 7786, "udp"},
{"popup-reminders",    {NULL}, 7787, "tcp"},
{"popup-reminders",    {NULL}, 7787, "udp"},
{"office-tools",       {NULL}, 7789, "tcp"},
{"office-tools",       {NULL}, 7789, "udp"},
{"q3ade",              {NULL}, 7794, "tcp"},
{"q3ade",              {NULL}, 7794, "udp"},
{"pnet-conn",          {NULL}, 7797, "tcp"},
{"pnet-conn",          {NULL}, 7797, "udp"},
{"pnet-enc",           {NULL}, 7798, "tcp"},
{"pnet-enc",           {NULL}, 7798, "udp"},
{"altbsdp",            {NULL}, 7799, "tcp"},
{"altbsdp",            {NULL}, 7799, "udp"},
{"asr",                {NULL}, 7800, "tcp"},
{"asr",                {NULL}, 7800, "udp"},
{"ssp-client",         {NULL}, 7801, "tcp"},
{"ssp-client",         {NULL}, 7801, "udp"},
{"rbt-wanopt",         {NULL}, 7810, "tcp"},
{"rbt-wanopt",         {NULL}, 7810, "udp"},
{"apc-7845",           {NULL}, 7845, "tcp"},
{"apc-7845",           {NULL}, 7845, "udp"},
{"apc-7846",           {NULL}, 7846, "tcp"},
{"apc-7846",           {NULL}, 7846, "udp"},
{"mobileanalyzer",     {NULL}, 7869, "tcp"},
{"rbt-smc",            {NULL}, 7870, "tcp"},
{"pss",                {NULL}, 7880, "tcp"},
{"pss",                {NULL}, 7880, "udp"},
{"ubroker",            {NULL}, 7887, "tcp"},
{"ubroker",            {NULL}, 7887, "udp"},
{"mevent",             {NULL}, 7900, "tcp"},
{"mevent",             {NULL}, 7900, "udp"},
{"tnos-sp",            {NULL}, 7901, "tcp"},
{"tnos-sp",            {NULL}, 7901, "udp"},
{"tnos-dp",            {NULL}, 7902, "tcp"},
{"tnos-dp",            {NULL}, 7902, "udp"},
{"tnos-dps",           {NULL}, 7903, "tcp"},
{"tnos-dps",           {NULL}, 7903, "udp"},
{"qo-secure",          {NULL}, 7913, "tcp"},
{"qo-secure",          {NULL}, 7913, "udp"},
{"t2-drm",             {NULL}, 7932, "tcp"},
{"t2-drm",             {NULL}, 7932, "udp"},
{"t2-brm",             {NULL}, 7933, "tcp"},
{"t2-brm",             {NULL}, 7933, "udp"},
{"supercell",          {NULL}, 7967, "tcp"},
{"supercell",          {NULL}, 7967, "udp"},
{"micromuse-ncps",     {NULL}, 7979, "tcp"},
{"micromuse-ncps",     {NULL}, 7979, "udp"},
{"quest-vista",        {NULL}, 7980, "tcp"},
{"quest-vista",        {NULL}, 7980, "udp"},
{"sossd-collect",      {NULL}, 7981, "tcp"},
{"sossd-agent",        {NULL}, 7982, "tcp"},
{"sossd-disc",         {NULL}, 7982, "udp"},
{"pushns",             {NULL}, 7997, "tcp"},
{"usicontentpush",     {NULL}, 7998, "udp"},
{"irdmi2",             {NULL}, 7999, "tcp"},
{"irdmi2",             {NULL}, 7999, "udp"},
{"irdmi",              {NULL}, 8000, "tcp"},
{"irdmi",              {NULL}, 8000, "udp"},
{"vcom-tunnel",        {NULL}, 8001, "tcp"},
{"vcom-tunnel",        {NULL}, 8001, "udp"},
{"teradataordbms",     {NULL}, 8002, "tcp"},
{"teradataordbms",     {NULL}, 8002, "udp"},
{"mcreport",           {NULL}, 8003, "tcp"},
{"mcreport",           {NULL}, 8003, "udp"},
{"mxi",                {NULL}, 8005, "tcp"},
{"mxi",                {NULL}, 8005, "udp"},
{"http-alt",           {NULL}, 8008, "tcp"},
{"http-alt",           {NULL}, 8008, "udp"},
{"qbdb",               {NULL}, 8019, "tcp"},
{"qbdb",               {NULL}, 8019, "udp"},
{"intu-ec-svcdisc",    {NULL}, 8020, "tcp"},
{"intu-ec-svcdisc",    {NULL}, 8020, "udp"},
{"intu-ec-client",     {NULL}, 8021, "tcp"},
{"intu-ec-client",     {NULL}, 8021, "udp"},
{"oa-system",          {NULL}, 8022, "tcp"},
{"oa-system",          {NULL}, 8022, "udp"},
{"ca-audit-da",        {NULL}, 8025, "tcp"},
{"ca-audit-da",        {NULL}, 8025, "udp"},
{"ca-audit-ds",        {NULL}, 8026, "tcp"},
{"ca-audit-ds",        {NULL}, 8026, "udp"},
{"pro-ed",             {NULL}, 8032, "tcp"},
{"pro-ed",             {NULL}, 8032, "udp"},
{"mindprint",          {NULL}, 8033, "tcp"},
{"mindprint",          {NULL}, 8033, "udp"},
{"vantronix-mgmt",     {NULL}, 8034, "tcp"},
{"vantronix-mgmt",     {NULL}, 8034, "udp"},
{"ampify",             {NULL}, 8040, "tcp"},
{"ampify",             {NULL}, 8040, "udp"},
{"fs-agent",           {NULL}, 8042, "tcp"},
{"fs-server",          {NULL}, 8043, "tcp"},
{"fs-mgmt",            {NULL}, 8044, "tcp"},
{"senomix01",          {NULL}, 8052, "tcp"},
{"senomix01",          {NULL}, 8052, "udp"},
{"senomix02",          {NULL}, 8053, "tcp"},
{"senomix02",          {NULL}, 8053, "udp"},
{"senomix03",          {NULL}, 8054, "tcp"},
{"senomix03",          {NULL}, 8054, "udp"},
{"senomix04",          {NULL}, 8055, "tcp"},
{"senomix04",          {NULL}, 8055, "udp"},
{"senomix05",          {NULL}, 8056, "tcp"},
{"senomix05",          {NULL}, 8056, "udp"},
{"senomix06",          {NULL}, 8057, "tcp"},
{"senomix06",          {NULL}, 8057, "udp"},
{"senomix07",          {NULL}, 8058, "tcp"},
{"senomix07",          {NULL}, 8058, "udp"},
{"senomix08",          {NULL}, 8059, "tcp"},
{"senomix08",          {NULL}, 8059, "udp"},
{"gadugadu",           {NULL}, 8074, "tcp"},
{"gadugadu",           {NULL}, 8074, "udp"},
{"http-alt",           {NULL}, 8080, "tcp"},
{"http-alt",           {NULL}, 8080, "udp"},
{"sunproxyadmin",      {NULL}, 8081, "tcp"},
{"sunproxyadmin",      {NULL}, 8081, "udp"},
{"us-cli",             {NULL}, 8082, "tcp"},
{"us-cli",             {NULL}, 8082, "udp"},
{"us-srv",             {NULL}, 8083, "tcp"},
{"us-srv",             {NULL}, 8083, "udp"},
{"d-s-n",              {NULL}, 8086, "tcp"},
{"d-s-n",              {NULL}, 8086, "udp"},
{"simplifymedia",      {NULL}, 8087, "tcp"},
{"simplifymedia",      {NULL}, 8087, "udp"},
{"radan-http",         {NULL}, 8088, "tcp"},
{"radan-http",         {NULL}, 8088, "udp"},
{"jamlink",            {NULL}, 8091, "tcp"},
{"sac",                {NULL}, 8097, "tcp"},
{"sac",                {NULL}, 8097, "udp"},
{"xprint-server",      {NULL}, 8100, "tcp"},
{"xprint-server",      {NULL}, 8100, "udp"},
{"ldoms-migr",         {NULL}, 8101, "tcp"},
{"mtl8000-matrix",     {NULL}, 8115, "tcp"},
{"mtl8000-matrix",     {NULL}, 8115, "udp"},
{"cp-cluster",         {NULL}, 8116, "tcp"},
{"cp-cluster",         {NULL}, 8116, "udp"},
{"privoxy",            {NULL}, 8118, "tcp"},
{"privoxy",            {NULL}, 8118, "udp"},
{"apollo-data",        {NULL}, 8121, "tcp"},
{"apollo-data",        {NULL}, 8121, "udp"},
{"apollo-admin",       {NULL}, 8122, "tcp"},
{"apollo-admin",       {NULL}, 8122, "udp"},
{"paycash-online",     {NULL}, 8128, "tcp"},
{"paycash-online",     {NULL}, 8128, "udp"},
{"paycash-wbp",        {NULL}, 8129, "tcp"},
{"paycash-wbp",        {NULL}, 8129, "udp"},
{"indigo-vrmi",        {NULL}, 8130, "tcp"},
{"indigo-vrmi",        {NULL}, 8130, "udp"},
{"indigo-vbcp",        {NULL}, 8131, "tcp"},
{"indigo-vbcp",        {NULL}, 8131, "udp"},
{"dbabble",            {NULL}, 8132, "tcp"},
{"dbabble",            {NULL}, 8132, "udp"},
{"isdd",               {NULL}, 8148, "tcp"},
{"isdd",               {NULL}, 8148, "udp"},
{"patrol",             {NULL}, 8160, "tcp"},
{"patrol",             {NULL}, 8160, "udp"},
{"patrol-snmp",        {NULL}, 8161, "tcp"},
{"patrol-snmp",        {NULL}, 8161, "udp"},
{"vmware-fdm",         {NULL}, 8182, "tcp"},
{"vmware-fdm",         {NULL}, 8182, "udp"},
{"proremote",          {NULL}, 8183, "tcp"},
{"itach",              {NULL}, 8184, "tcp"},
{"itach",              {NULL}, 8184, "udp"},
{"spytechphone",       {NULL}, 8192, "tcp"},
{"spytechphone",       {NULL}, 8192, "udp"},
{"blp1",               {NULL}, 8194, "tcp"},
{"blp1",               {NULL}, 8194, "udp"},
{"blp2",               {NULL}, 8195, "tcp"},
{"blp2",               {NULL}, 8195, "udp"},
{"vvr-data",           {NULL}, 8199, "tcp"},
{"vvr-data",           {NULL}, 8199, "udp"},
{"trivnet1",           {NULL}, 8200, "tcp"},
{"trivnet1",           {NULL}, 8200, "udp"},
{"trivnet2",           {NULL}, 8201, "tcp"},
{"trivnet2",           {NULL}, 8201, "udp"},
{"lm-perfworks",       {NULL}, 8204, "tcp"},
{"lm-perfworks",       {NULL}, 8204, "udp"},
{"lm-instmgr",         {NULL}, 8205, "tcp"},
{"lm-instmgr",         {NULL}, 8205, "udp"},
{"lm-dta",             {NULL}, 8206, "tcp"},
{"lm-dta",             {NULL}, 8206, "udp"},
{"lm-sserver",         {NULL}, 8207, "tcp"},
{"lm-sserver",         {NULL}, 8207, "udp"},
{"lm-webwatcher",      {NULL}, 8208, "tcp"},
{"lm-webwatcher",      {NULL}, 8208, "udp"},
{"rexecj",             {NULL}, 8230, "tcp"},
{"rexecj",             {NULL}, 8230, "udp"},
{"synapse-nhttps",     {NULL}, 8243, "tcp"},
{"synapse-nhttps",     {NULL}, 8243, "udp"},
{"pando-sec",          {NULL}, 8276, "tcp"},
{"pando-sec",          {NULL}, 8276, "udp"},
{"synapse-nhttp",      {NULL}, 8280, "tcp"},
{"synapse-nhttp",      {NULL}, 8280, "udp"},
{"blp3",               {NULL}, 8292, "tcp"},
{"blp3",               {NULL}, 8292, "udp"},
{"hiperscan-id",       {NULL}, 8293, "tcp"},
{"blp4",               {NULL}, 8294, "tcp"},
{"blp4",               {NULL}, 8294, "udp"},
{"tmi",                {NULL}, 8300, "tcp"},
{"tmi",                {NULL}, 8300, "udp"},
{"amberon",            {NULL}, 8301, "tcp"},
{"amberon",            {NULL}, 8301, "udp"},
{"tnp-discover",       {NULL}, 8320, "tcp"},
{"tnp-discover",       {NULL}, 8320, "udp"},
{"tnp",                {NULL}, 8321, "tcp"},
{"tnp",                {NULL}, 8321, "udp"},
{"server-find",        {NULL}, 8351, "tcp"},
{"server-find",        {NULL}, 8351, "udp"},
{"cruise-enum",        {NULL}, 8376, "tcp"},
{"cruise-enum",        {NULL}, 8376, "udp"},
{"cruise-swroute",     {NULL}, 8377, "tcp"},
{"cruise-swroute",     {NULL}, 8377, "udp"},
{"cruise-config",      {NULL}, 8378, "tcp"},
{"cruise-config",      {NULL}, 8378, "udp"},
{"cruise-diags",       {NULL}, 8379, "tcp"},
{"cruise-diags",       {NULL}, 8379, "udp"},
{"cruise-update",      {NULL}, 8380, "tcp"},
{"cruise-update",      {NULL}, 8380, "udp"},
{"m2mservices",        {NULL}, 8383, "tcp"},
{"m2mservices",        {NULL}, 8383, "udp"},
{"cvd",                {NULL}, 8400, "tcp"},
{"cvd",                {NULL}, 8400, "udp"},
{"sabarsd",            {NULL}, 8401, "tcp"},
{"sabarsd",            {NULL}, 8401, "udp"},
{"abarsd",             {NULL}, 8402, "tcp"},
{"abarsd",             {NULL}, 8402, "udp"},
{"admind",             {NULL}, 8403, "tcp"},
{"admind",             {NULL}, 8403, "udp"},
{"svcloud",            {NULL}, 8404, "tcp"},
{"svbackup",           {NULL}, 8405, "tcp"},
{"espeech",            {NULL}, 8416, "tcp"},
{"espeech",            {NULL}, 8416, "udp"},
{"espeech-rtp",        {NULL}, 8417, "tcp"},
{"espeech-rtp",        {NULL}, 8417, "udp"},
{"cybro-a-bus",        {NULL}, 8442, "tcp"},
{"cybro-a-bus",        {NULL}, 8442, "udp"},
{"pcsync-https",       {NULL}, 8443, "tcp"},
{"pcsync-https",       {NULL}, 8443, "udp"},
{"pcsync-http",        {NULL}, 8444, "tcp"},
{"pcsync-http",        {NULL}, 8444, "udp"},
{"npmp",               {NULL}, 8450, "tcp"},
{"npmp",               {NULL}, 8450, "udp"},
{"cisco-avp",          {NULL}, 8470, "tcp"},
{"pim-port",           {NULL}, 8471, "tcp"},
{"pim-port",           {NULL}, 8471, "sctp"},
{"otv",                {NULL}, 8472, "tcp"},
{"otv",                {NULL}, 8472, "udp"},
{"vp2p",               {NULL}, 8473, "tcp"},
{"vp2p",               {NULL}, 8473, "udp"},
{"noteshare",          {NULL}, 8474, "tcp"},
{"noteshare",          {NULL}, 8474, "udp"},
{"fmtp",               {NULL}, 8500, "tcp"},
{"fmtp",               {NULL}, 8500, "udp"},
{"rtsp-alt",           {NULL}, 8554, "tcp"},
{"rtsp-alt",           {NULL}, 8554, "udp"},
{"d-fence",            {NULL}, 8555, "tcp"},
{"d-fence",            {NULL}, 8555, "udp"},
{"oap-admin",          {NULL}, 8567, "tcp"},
{"oap-admin",          {NULL}, 8567, "udp"},
{"asterix",            {NULL}, 8600, "tcp"},
{"asterix",            {NULL}, 8600, "udp"},
{"canon-mfnp",         {NULL}, 8610, "tcp"},
{"canon-mfnp",         {NULL}, 8610, "udp"},
{"canon-bjnp1",        {NULL}, 8611, "tcp"},
{"canon-bjnp1",        {NULL}, 8611, "udp"},
{"canon-bjnp2",        {NULL}, 8612, "tcp"},
{"canon-bjnp2",        {NULL}, 8612, "udp"},
{"canon-bjnp3",        {NULL}, 8613, "tcp"},
{"canon-bjnp3",        {NULL}, 8613, "udp"},
{"canon-bjnp4",        {NULL}, 8614, "tcp"},
{"canon-bjnp4",        {NULL}, 8614, "udp"},
{"sun-as-jmxrmi",      {NULL}, 8686, "tcp"},
{"sun-as-jmxrmi",      {NULL}, 8686, "udp"},
{"vnyx",               {NULL}, 8699, "tcp"},
{"vnyx",               {NULL}, 8699, "udp"},
{"dtp-net",            {NULL}, 8732, "udp"},
{"ibus",               {NULL}, 8733, "tcp"},
{"ibus",               {NULL}, 8733, "udp"},
{"mc-appserver",       {NULL}, 8763, "tcp"},
{"mc-appserver",       {NULL}, 8763, "udp"},
{"openqueue",          {NULL}, 8764, "tcp"},
{"openqueue",          {NULL}, 8764, "udp"},
{"ultraseek-http",     {NULL}, 8765, "tcp"},
{"ultraseek-http",     {NULL}, 8765, "udp"},
{"dpap",               {NULL}, 8770, "tcp"},
{"dpap",               {NULL}, 8770, "udp"},
{"msgclnt",            {NULL}, 8786, "tcp"},
{"msgclnt",            {NULL}, 8786, "udp"},
{"msgsrvr",            {NULL}, 8787, "tcp"},
{"msgsrvr",            {NULL}, 8787, "udp"},
{"sunwebadmin",        {NULL}, 8800, "tcp"},
{"sunwebadmin",        {NULL}, 8800, "udp"},
{"truecm",             {NULL}, 8804, "tcp"},
{"truecm",             {NULL}, 8804, "udp"},
{"dxspider",           {NULL}, 8873, "tcp"},
{"dxspider",           {NULL}, 8873, "udp"},
{"cddbp-alt",          {NULL}, 8880, "tcp"},
{"cddbp-alt",          {NULL}, 8880, "udp"},
{"secure-mqtt",        {NULL}, 8883, "tcp"},
{"secure-mqtt",        {NULL}, 8883, "udp"},
{"ddi-tcp-1",          {NULL}, 8888, "tcp"},
{"ddi-udp-1",          {NULL}, 8888, "udp"},
{"ddi-tcp-2",          {NULL}, 8889, "tcp"},
{"ddi-udp-2",          {NULL}, 8889, "udp"},
{"ddi-tcp-3",          {NULL}, 8890, "tcp"},
{"ddi-udp-3",          {NULL}, 8890, "udp"},
{"ddi-tcp-4",          {NULL}, 8891, "tcp"},
{"ddi-udp-4",          {NULL}, 8891, "udp"},
{"ddi-tcp-5",          {NULL}, 8892, "tcp"},
{"ddi-udp-5",          {NULL}, 8892, "udp"},
{"ddi-tcp-6",          {NULL}, 8893, "tcp"},
{"ddi-udp-6",          {NULL}, 8893, "udp"},
{"ddi-tcp-7",          {NULL}, 8894, "tcp"},
{"ddi-udp-7",          {NULL}, 8894, "udp"},
{"ospf-lite",          {NULL}, 8899, "tcp"},
{"ospf-lite",          {NULL}, 8899, "udp"},
{"jmb-cds1",           {NULL}, 8900, "tcp"},
{"jmb-cds1",           {NULL}, 8900, "udp"},
{"jmb-cds2",           {NULL}, 8901, "tcp"},
{"jmb-cds2",           {NULL}, 8901, "udp"},
{"manyone-http",       {NULL}, 8910, "tcp"},
{"manyone-http",       {NULL}, 8910, "udp"},
{"manyone-xml",        {NULL}, 8911, "tcp"},
{"manyone-xml",        {NULL}, 8911, "udp"},
{"wcbackup",           {NULL}, 8912, "tcp"},
{"wcbackup",           {NULL}, 8912, "udp"},
{"dragonfly",          {NULL}, 8913, "tcp"},
{"dragonfly",          {NULL}, 8913, "udp"},
{"twds",               {NULL}, 8937, "tcp"},
{"cumulus-admin",      {NULL}, 8954, "tcp"},
{"cumulus-admin",      {NULL}, 8954, "udp"},
{"sunwebadmins",       {NULL}, 8989, "tcp"},
{"sunwebadmins",       {NULL}, 8989, "udp"},
{"http-wmap",          {NULL}, 8990, "tcp"},
{"http-wmap",          {NULL}, 8990, "udp"},
{"https-wmap",         {NULL}, 8991, "tcp"},
{"https-wmap",         {NULL}, 8991, "udp"},
{"bctp",               {NULL}, 8999, "tcp"},
{"bctp",               {NULL}, 8999, "udp"},
{"cslistener",         {NULL}, 9000, "tcp"},
{"cslistener",         {NULL}, 9000, "udp"},
{"etlservicemgr",      {NULL}, 9001, "tcp"},
{"etlservicemgr",      {NULL}, 9001, "udp"},
{"dynamid",            {NULL}, 9002, "tcp"},
{"dynamid",            {NULL}, 9002, "udp"},
{"ogs-client",         {NULL}, 9007, "udp"},
{"ogs-server",         {NULL}, 9008, "tcp"},
{"pichat",             {NULL}, 9009, "tcp"},
{"pichat",             {NULL}, 9009, "udp"},
{"sdr",                {NULL}, 9010, "tcp"},
{"tambora",            {NULL}, 9020, "tcp"},
{"tambora",            {NULL}, 9020, "udp"},
{"panagolin-ident",    {NULL}, 9021, "tcp"},
{"panagolin-ident",    {NULL}, 9021, "udp"},
{"paragent",           {NULL}, 9022, "tcp"},
{"paragent",           {NULL}, 9022, "udp"},
{"swa-1",              {NULL}, 9023, "tcp"},
{"swa-1",              {NULL}, 9023, "udp"},
{"swa-2",              {NULL}, 9024, "tcp"},
{"swa-2",              {NULL}, 9024, "udp"},
{"swa-3",              {NULL}, 9025, "tcp"},
{"swa-3",              {NULL}, 9025, "udp"},
{"swa-4",              {NULL}, 9026, "tcp"},
{"swa-4",              {NULL}, 9026, "udp"},
{"versiera",           {NULL}, 9050, "tcp"},
{"fio-cmgmt",          {NULL}, 9051, "tcp"},
{"glrpc",              {NULL}, 9080, "tcp"},
{"glrpc",              {NULL}, 9080, "udp"},
{"lcs-ap",             {NULL}, 9082, "sctp"},
{"emc-pp-mgmtsvc",     {NULL}, 9083, "tcp"},
{"aurora",             {NULL}, 9084, "tcp"},
{"aurora",             {NULL}, 9084, "udp"},
{"aurora",             {NULL}, 9084, "sctp"},
{"ibm-rsyscon",        {NULL}, 9085, "tcp"},
{"ibm-rsyscon",        {NULL}, 9085, "udp"},
{"net2display",        {NULL}, 9086, "tcp"},
{"net2display",        {NULL}, 9086, "udp"},
{"classic",            {NULL}, 9087, "tcp"},
{"classic",            {NULL}, 9087, "udp"},
{"sqlexec",            {NULL}, 9088, "tcp"},
{"sqlexec",            {NULL}, 9088, "udp"},
{"sqlexec-ssl",        {NULL}, 9089, "tcp"},
{"sqlexec-ssl",        {NULL}, 9089, "udp"},
{"websm",              {NULL}, 9090, "tcp"},
{"websm",              {NULL}, 9090, "udp"},
{"xmltec-xmlmail",     {NULL}, 9091, "tcp"},
{"xmltec-xmlmail",     {NULL}, 9091, "udp"},
{"XmlIpcRegSvc",       {NULL}, 9092, "tcp"},
{"XmlIpcRegSvc",       {NULL}, 9092, "udp"},
{"hp-pdl-datastr",     {NULL}, 9100, "tcp"},
{"hp-pdl-datastr",     {NULL}, 9100, "udp"},
{"pdl-datastream",     {NULL}, 9100, "tcp"},
{"pdl-datastream",     {NULL}, 9100, "udp"},
{"bacula-dir",         {NULL}, 9101, "tcp"},
{"bacula-dir",         {NULL}, 9101, "udp"},
{"bacula-fd",          {NULL}, 9102, "tcp"},
{"bacula-fd",          {NULL}, 9102, "udp"},
{"bacula-sd",          {NULL}, 9103, "tcp"},
{"bacula-sd",          {NULL}, 9103, "udp"},
{"peerwire",           {NULL}, 9104, "tcp"},
{"peerwire",           {NULL}, 9104, "udp"},
{"xadmin",             {NULL}, 9105, "tcp"},
{"xadmin",             {NULL}, 9105, "udp"},
{"astergate",          {NULL}, 9106, "tcp"},
{"astergate-disc",     {NULL}, 9106, "udp"},
{"astergatefax",       {NULL}, 9107, "tcp"},
{"mxit",               {NULL}, 9119, "tcp"},
{"mxit",               {NULL}, 9119, "udp"},
{"dddp",               {NULL}, 9131, "tcp"},
{"dddp",               {NULL}, 9131, "udp"},
{"apani1",             {NULL}, 9160, "tcp"},
{"apani1",             {NULL}, 9160, "udp"},
{"apani2",             {NULL}, 9161, "tcp"},
{"apani2",             {NULL}, 9161, "udp"},
{"apani3",             {NULL}, 9162, "tcp"},
{"apani3",             {NULL}, 9162, "udp"},
{"apani4",             {NULL}, 9163, "tcp"},
{"apani4",             {NULL}, 9163, "udp"},
{"apani5",             {NULL}, 9164, "tcp"},
{"apani5",             {NULL}, 9164, "udp"},
{"sun-as-jpda",        {NULL}, 9191, "tcp"},
{"sun-as-jpda",        {NULL}, 9191, "udp"},
{"wap-wsp",            {NULL}, 9200, "tcp"},
{"wap-wsp",            {NULL}, 9200, "udp"},
{"wap-wsp-wtp",        {NULL}, 9201, "tcp"},
{"wap-wsp-wtp",        {NULL}, 9201, "udp"},
{"wap-wsp-s",          {NULL}, 9202, "tcp"},
{"wap-wsp-s",          {NULL}, 9202, "udp"},
{"wap-wsp-wtp-s",      {NULL}, 9203, "tcp"},
{"wap-wsp-wtp-s",      {NULL}, 9203, "udp"},
{"wap-vcard",          {NULL}, 9204, "tcp"},
{"wap-vcard",          {NULL}, 9204, "udp"},
{"wap-vcal",           {NULL}, 9205, "tcp"},
{"wap-vcal",           {NULL}, 9205, "udp"},
{"wap-vcard-s",        {NULL}, 9206, "tcp"},
{"wap-vcard-s",        {NULL}, 9206, "udp"},
{"wap-vcal-s",         {NULL}, 9207, "tcp"},
{"wap-vcal-s",         {NULL}, 9207, "udp"},
{"rjcdb-vcards",       {NULL}, 9208, "tcp"},
{"rjcdb-vcards",       {NULL}, 9208, "udp"},
{"almobile-system",    {NULL}, 9209, "tcp"},
{"almobile-system",    {NULL}, 9209, "udp"},
{"oma-mlp",            {NULL}, 9210, "tcp"},
{"oma-mlp",            {NULL}, 9210, "udp"},
{"oma-mlp-s",          {NULL}, 9211, "tcp"},
{"oma-mlp-s",          {NULL}, 9211, "udp"},
{"serverviewdbms",     {NULL}, 9212, "tcp"},
{"serverviewdbms",     {NULL}, 9212, "udp"},
{"serverstart",        {NULL}, 9213, "tcp"},
{"serverstart",        {NULL}, 9213, "udp"},
{"ipdcesgbs",          {NULL}, 9214, "tcp"},
{"ipdcesgbs",          {NULL}, 9214, "udp"},
{"insis",              {NULL}, 9215, "tcp"},
{"insis",              {NULL}, 9215, "udp"},
{"acme",               {NULL}, 9216, "tcp"},
{"acme",               {NULL}, 9216, "udp"},
{"fsc-port",           {NULL}, 9217, "tcp"},
{"fsc-port",           {NULL}, 9217, "udp"},
{"teamcoherence",      {NULL}, 9222, "tcp"},
{"teamcoherence",      {NULL}, 9222, "udp"},
{"mon",                {NULL}, 9255, "tcp"},
{"mon",                {NULL}, 9255, "udp"},
{"pegasus",            {NULL}, 9278, "tcp"},
{"pegasus",            {NULL}, 9278, "udp"},
{"pegasus-ctl",        {NULL}, 9279, "tcp"},
{"pegasus-ctl",        {NULL}, 9279, "udp"},
{"pgps",               {NULL}, 9280, "tcp"},
{"pgps",               {NULL}, 9280, "udp"},
{"swtp-port1",         {NULL}, 9281, "tcp"},
{"swtp-port1",         {NULL}, 9281, "udp"},
{"swtp-port2",         {NULL}, 9282, "tcp"},
{"swtp-port2",         {NULL}, 9282, "udp"},
{"callwaveiam",        {NULL}, 9283, "tcp"},
{"callwaveiam",        {NULL}, 9283, "udp"},
{"visd",               {NULL}, 9284, "tcp"},
{"visd",               {NULL}, 9284, "udp"},
{"n2h2server",         {NULL}, 9285, "tcp"},
{"n2h2server",         {NULL}, 9285, "udp"},
{"n2receive",          {NULL}, 9286, "udp"},
{"cumulus",            {NULL}, 9287, "tcp"},
{"cumulus",            {NULL}, 9287, "udp"},
{"armtechdaemon",      {NULL}, 9292, "tcp"},
{"armtechdaemon",      {NULL}, 9292, "udp"},
{"storview",           {NULL}, 9293, "tcp"},
{"storview",           {NULL}, 9293, "udp"},
{"armcenterhttp",      {NULL}, 9294, "tcp"},
{"armcenterhttp",      {NULL}, 9294, "udp"},
{"armcenterhttps",     {NULL}, 9295, "tcp"},
{"armcenterhttps",     {NULL}, 9295, "udp"},
{"vrace",              {NULL}, 9300, "tcp"},
{"vrace",              {NULL}, 9300, "udp"},
{"sphinxql",           {NULL}, 9306, "tcp"},
{"sphinxapi",          {NULL}, 9312, "tcp"},
{"secure-ts",          {NULL}, 9318, "tcp"},
{"secure-ts",          {NULL}, 9318, "udp"},
{"guibase",            {NULL}, 9321, "tcp"},
{"guibase",            {NULL}, 9321, "udp"},
{"mpidcmgr",           {NULL}, 9343, "tcp"},
{"mpidcmgr",           {NULL}, 9343, "udp"},
{"mphlpdmc",           {NULL}, 9344, "tcp"},
{"mphlpdmc",           {NULL}, 9344, "udp"},
{"ctechlicensing",     {NULL}, 9346, "tcp"},
{"ctechlicensing",     {NULL}, 9346, "udp"},
{"fjdmimgr",           {NULL}, 9374, "tcp"},
{"fjdmimgr",           {NULL}, 9374, "udp"},
{"boxp",               {NULL}, 9380, "tcp"},
{"boxp",               {NULL}, 9380, "udp"},
{"d2dconfig",          {NULL}, 9387, "tcp"},
{"d2ddatatrans",       {NULL}, 9388, "tcp"},
{"adws",               {NULL}, 9389, "tcp"},
{"otp",                {NULL}, 9390, "tcp"},
{"fjinvmgr",           {NULL}, 9396, "tcp"},
{"fjinvmgr",           {NULL}, 9396, "udp"},
{"mpidcagt",           {NULL}, 9397, "tcp"},
{"mpidcagt",           {NULL}, 9397, "udp"},
{"sec-t4net-srv",      {NULL}, 9400, "tcp"},
{"sec-t4net-srv",      {NULL}, 9400, "udp"},
{"sec-t4net-clt",      {NULL}, 9401, "tcp"},
{"sec-t4net-clt",      {NULL}, 9401, "udp"},
{"sec-pc2fax-srv",     {NULL}, 9402, "tcp"},
{"sec-pc2fax-srv",     {NULL}, 9402, "udp"},
{"git",                {NULL}, 9418, "tcp"},
{"git",                {NULL}, 9418, "udp"},
{"tungsten-https",     {NULL}, 9443, "tcp"},
{"tungsten-https",     {NULL}, 9443, "udp"},
{"wso2esb-console",    {NULL}, 9444, "tcp"},
{"wso2esb-console",    {NULL}, 9444, "udp"},
{"sntlkeyssrvr",       {NULL}, 9450, "tcp"},
{"sntlkeyssrvr",       {NULL}, 9450, "udp"},
{"ismserver",          {NULL}, 9500, "tcp"},
{"ismserver",          {NULL}, 9500, "udp"},
{"sma-spw",            {NULL}, 9522, "udp"},
{"mngsuite",           {NULL}, 9535, "tcp"},
{"mngsuite",           {NULL}, 9535, "udp"},
{"laes-bf",            {NULL}, 9536, "tcp"},
{"laes-bf",            {NULL}, 9536, "udp"},
{"trispen-sra",        {NULL}, 9555, "tcp"},
{"trispen-sra",        {NULL}, 9555, "udp"},
{"ldgateway",          {NULL}, 9592, "tcp"},
{"ldgateway",          {NULL}, 9592, "udp"},
{"cba8",               {NULL}, 9593, "tcp"},
{"cba8",               {NULL}, 9593, "udp"},
{"msgsys",             {NULL}, 9594, "tcp"},
{"msgsys",             {NULL}, 9594, "udp"},
{"pds",                {NULL}, 9595, "tcp"},
{"pds",                {NULL}, 9595, "udp"},
{"mercury-disc",       {NULL}, 9596, "tcp"},
{"mercury-disc",       {NULL}, 9596, "udp"},
{"pd-admin",           {NULL}, 9597, "tcp"},
{"pd-admin",           {NULL}, 9597, "udp"},
{"vscp",               {NULL}, 9598, "tcp"},
{"vscp",               {NULL}, 9598, "udp"},
{"robix",              {NULL}, 9599, "tcp"},
{"robix",              {NULL}, 9599, "udp"},
{"micromuse-ncpw",     {NULL}, 9600, "tcp"},
{"micromuse-ncpw",     {NULL}, 9600, "udp"},
{"streamcomm-ds",      {NULL}, 9612, "tcp"},
{"streamcomm-ds",      {NULL}, 9612, "udp"},
{"iadt-tls",           {NULL}, 9614, "tcp"},
{"erunbook_agent",     {NULL}, 9616, "tcp"},
{"erunbook_server",    {NULL}, 9617, "tcp"},
{"condor",             {NULL}, 9618, "tcp"},
{"condor",             {NULL}, 9618, "udp"},
{"odbcpathway",        {NULL}, 9628, "tcp"},
{"odbcpathway",        {NULL}, 9628, "udp"},
{"uniport",            {NULL}, 9629, "tcp"},
{"uniport",            {NULL}, 9629, "udp"},
{"peoctlr",            {NULL}, 9630, "tcp"},
{"peocoll",            {NULL}, 9631, "tcp"},
{"mc-comm",            {NULL}, 9632, "udp"},
{"pqsflows",           {NULL}, 9640, "tcp"},
{"xmms2",              {NULL}, 9667, "tcp"},
{"xmms2",              {NULL}, 9667, "udp"},
{"tec5-sdctp",         {NULL}, 9668, "tcp"},
{"tec5-sdctp",         {NULL}, 9668, "udp"},
{"client-wakeup",      {NULL}, 9694, "tcp"},
{"client-wakeup",      {NULL}, 9694, "udp"},
{"ccnx",               {NULL}, 9695, "tcp"},
{"ccnx",               {NULL}, 9695, "udp"},
{"board-roar",         {NULL}, 9700, "tcp"},
{"board-roar",         {NULL}, 9700, "udp"},
{"l5nas-parchan",      {NULL}, 9747, "tcp"},
{"l5nas-parchan",      {NULL}, 9747, "udp"},
{"board-voip",         {NULL}, 9750, "tcp"},
{"board-voip",         {NULL}, 9750, "udp"},
{"rasadv",             {NULL}, 9753, "tcp"},
{"rasadv",             {NULL}, 9753, "udp"},
{"tungsten-http",      {NULL}, 9762, "tcp"},
{"tungsten-http",      {NULL}, 9762, "udp"},
{"davsrc",             {NULL}, 9800, "tcp"},
{"davsrc",             {NULL}, 9800, "udp"},
{"sstp-2",             {NULL}, 9801, "tcp"},
{"sstp-2",             {NULL}, 9801, "udp"},
{"davsrcs",            {NULL}, 9802, "tcp"},
{"davsrcs",            {NULL}, 9802, "udp"},
{"sapv1",              {NULL}, 9875, "tcp"},
{"sapv1",              {NULL}, 9875, "udp"},
{"sd",                 {NULL}, 9876, "tcp"},
{"sd",                 {NULL}, 9876, "udp"},
{"cyborg-systems",     {NULL}, 9888, "tcp"},
{"cyborg-systems",     {NULL}, 9888, "udp"},
{"gt-proxy",           {NULL}, 9889, "tcp"},
{"gt-proxy",           {NULL}, 9889, "udp"},
{"monkeycom",          {NULL}, 9898, "tcp"},
{"monkeycom",          {NULL}, 9898, "udp"},
{"sctp-tunneling",     {NULL}, 9899, "tcp"},
{"sctp-tunneling",     {NULL}, 9899, "udp"},
{"iua",                {NULL}, 9900, "tcp"},
{"iua",                {NULL}, 9900, "udp"},
{"iua",                {NULL}, 9900, "sctp"},
{"enrp",               {NULL}, 9901, "udp"},
{"enrp-sctp",          {NULL}, 9901, "sctp"},
{"enrp-sctp-tls",      {NULL}, 9902, "sctp"},
{"domaintime",         {NULL}, 9909, "tcp"},
{"domaintime",         {NULL}, 9909, "udp"},
{"sype-transport",     {NULL}, 9911, "tcp"},
{"sype-transport",     {NULL}, 9911, "udp"},
{"apc-9950",           {NULL}, 9950, "tcp"},
{"apc-9950",           {NULL}, 9950, "udp"},
{"apc-9951",           {NULL}, 9951, "tcp"},
{"apc-9951",           {NULL}, 9951, "udp"},
{"apc-9952",           {NULL}, 9952, "tcp"},
{"apc-9952",           {NULL}, 9952, "udp"},
{"acis",               {NULL}, 9953, "tcp"},
{"acis",               {NULL}, 9953, "udp"},
{"odnsp",              {NULL}, 9966, "tcp"},
{"odnsp",              {NULL}, 9966, "udp"},
{"dsm-scm-target",     {NULL}, 9987, "tcp"},
{"dsm-scm-target",     {NULL}, 9987, "udp"},
{"nsesrvr",            {NULL}, 9988, "tcp"},
{"osm-appsrvr",        {NULL}, 9990, "tcp"},
{"osm-appsrvr",        {NULL}, 9990, "udp"},
{"osm-oev",            {NULL}, 9991, "tcp"},
{"osm-oev",            {NULL}, 9991, "udp"},
{"palace-1",           {NULL}, 9992, "tcp"},
{"palace-1",           {NULL}, 9992, "udp"},
{"palace-2",           {NULL}, 9993, "tcp"},
{"palace-2",           {NULL}, 9993, "udp"},
{"palace-3",           {NULL}, 9994, "tcp"},
{"palace-3",           {NULL}, 9994, "udp"},
{"palace-4",           {NULL}, 9995, "tcp"},
{"palace-4",           {NULL}, 9995, "udp"},
{"palace-5",           {NULL}, 9996, "tcp"},
{"palace-5",           {NULL}, 9996, "udp"},
{"palace-6",           {NULL}, 9997, "tcp"},
{"palace-6",           {NULL}, 9997, "udp"},
{"distinct32",         {NULL}, 9998, "tcp"},
{"distinct32",         {NULL}, 9998, "udp"},
{"distinct",           {NULL}, 9999, "tcp"},
{"distinct",           {NULL}, 9999, "udp"},
{"ndmp",               {NULL}, 10000, "tcp"},
{"ndmp",               {NULL}, 10000, "udp"},
{"scp-config",         {NULL}, 10001, "tcp"},
{"scp-config",         {NULL}, 10001, "udp"},
{"documentum",         {NULL}, 10002, "tcp"},
{"documentum",         {NULL}, 10002, "udp"},
{"documentum_s",       {NULL}, 10003, "tcp"},
{"documentum_s",       {NULL}, 10003, "udp"},
{"emcrmirccd",         {NULL}, 10004, "tcp"},
{"emcrmird",           {NULL}, 10005, "tcp"},
{"mvs-capacity",       {NULL}, 10007, "tcp"},
{"mvs-capacity",       {NULL}, 10007, "udp"},
{"octopus",            {NULL}, 10008, "tcp"},
{"octopus",            {NULL}, 10008, "udp"},
{"swdtp-sv",           {NULL}, 10009, "tcp"},
{"swdtp-sv",           {NULL}, 10009, "udp"},
{"rxapi",              {NULL}, 10010, "tcp"},
{"zabbix-agent",       {NULL}, 10050, "tcp"},
{"zabbix-agent",       {NULL}, 10050, "udp"},
{"zabbix-trapper",     {NULL}, 10051, "tcp"},
{"zabbix-trapper",     {NULL}, 10051, "udp"},
{"qptlmd",             {NULL}, 10055, "tcp"},
{"amanda",             {NULL}, 10080, "tcp"},
{"amanda",             {NULL}, 10080, "udp"},
{"famdc",              {NULL}, 10081, "tcp"},
{"famdc",              {NULL}, 10081, "udp"},
{"itap-ddtp",          {NULL}, 10100, "tcp"},
{"itap-ddtp",          {NULL}, 10100, "udp"},
{"ezmeeting-2",        {NULL}, 10101, "tcp"},
{"ezmeeting-2",        {NULL}, 10101, "udp"},
{"ezproxy-2",          {NULL}, 10102, "tcp"},
{"ezproxy-2",          {NULL}, 10102, "udp"},
{"ezrelay",            {NULL}, 10103, "tcp"},
{"ezrelay",            {NULL}, 10103, "udp"},
{"swdtp",              {NULL}, 10104, "tcp"},
{"swdtp",              {NULL}, 10104, "udp"},
{"bctp-server",        {NULL}, 10107, "tcp"},
{"bctp-server",        {NULL}, 10107, "udp"},
{"nmea-0183",          {NULL}, 10110, "tcp"},
{"nmea-0183",          {NULL}, 10110, "udp"},
{"netiq-endpoint",     {NULL}, 10113, "tcp"},
{"netiq-endpoint",     {NULL}, 10113, "udp"},
{"netiq-qcheck",       {NULL}, 10114, "tcp"},
{"netiq-qcheck",       {NULL}, 10114, "udp"},
{"netiq-endpt",        {NULL}, 10115, "tcp"},
{"netiq-endpt",        {NULL}, 10115, "udp"},
{"netiq-voipa",        {NULL}, 10116, "tcp"},
{"netiq-voipa",        {NULL}, 10116, "udp"},
{"iqrm",               {NULL}, 10117, "tcp"},
{"iqrm",               {NULL}, 10117, "udp"},
{"bmc-perf-sd",        {NULL}, 10128, "tcp"},
{"bmc-perf-sd",        {NULL}, 10128, "udp"},
{"bmc-gms",            {NULL}, 10129, "tcp"},
{"qb-db-server",       {NULL}, 10160, "tcp"},
{"qb-db-server",       {NULL}, 10160, "udp"},
{"snmptls",            {NULL}, 10161, "tcp"},
{"snmpdtls",           {NULL}, 10161, "udp"},
{"snmptls-trap",       {NULL}, 10162, "tcp"},
{"snmpdtls-trap",      {NULL}, 10162, "udp"},
{"trisoap",            {NULL}, 10200, "tcp"},
{"trisoap",            {NULL}, 10200, "udp"},
{"rsms",               {NULL}, 10201, "tcp"},
{"rscs",               {NULL}, 10201, "udp"},
{"apollo-relay",       {NULL}, 10252, "tcp"},
{"apollo-relay",       {NULL}, 10252, "udp"},
{"axis-wimp-port",     {NULL}, 10260, "tcp"},
{"axis-wimp-port",     {NULL}, 10260, "udp"},
{"blocks",             {NULL}, 10288, "tcp"},
{"blocks",             {NULL}, 10288, "udp"},
{"cosir",              {NULL}, 10321, "tcp"},
{"hip-nat-t",          {NULL}, 10500, "udp"},
{"MOS-lower",          {NULL}, 10540, "tcp"},
{"MOS-lower",          {NULL}, 10540, "udp"},
{"MOS-upper",          {NULL}, 10541, "tcp"},
{"MOS-upper",          {NULL}, 10541, "udp"},
{"MOS-aux",            {NULL}, 10542, "tcp"},
{"MOS-aux",            {NULL}, 10542, "udp"},
{"MOS-soap",           {NULL}, 10543, "tcp"},
{"MOS-soap",           {NULL}, 10543, "udp"},
{"MOS-soap-opt",       {NULL}, 10544, "tcp"},
{"MOS-soap-opt",       {NULL}, 10544, "udp"},
{"gap",                {NULL}, 10800, "tcp"},
{"gap",                {NULL}, 10800, "udp"},
{"lpdg",               {NULL}, 10805, "tcp"},
{"lpdg",               {NULL}, 10805, "udp"},
{"nbd",                {NULL}, 10809, "tcp"},
{"nmc-disc",           {NULL}, 10810, "udp"},
{"helix",              {NULL}, 10860, "tcp"},
{"helix",              {NULL}, 10860, "udp"},
{"rmiaux",             {NULL}, 10990, "tcp"},
{"rmiaux",             {NULL}, 10990, "udp"},
{"irisa",              {NULL}, 11000, "tcp"},
{"irisa",              {NULL}, 11000, "udp"},
{"metasys",            {NULL}, 11001, "tcp"},
{"metasys",            {NULL}, 11001, "udp"},
{"netapp-icmgmt",      {NULL}, 11104, "tcp"},
{"netapp-icdata",      {NULL}, 11105, "tcp"},
{"sgi-lk",             {NULL}, 11106, "tcp"},
{"sgi-lk",             {NULL}, 11106, "udp"},
{"vce",                {NULL}, 11111, "tcp"},
{"vce",                {NULL}, 11111, "udp"},
{"dicom",              {NULL}, 11112, "tcp"},
{"dicom",              {NULL}, 11112, "udp"},
{"suncacao-snmp",      {NULL}, 11161, "tcp"},
{"suncacao-snmp",      {NULL}, 11161, "udp"},
{"suncacao-jmxmp",     {NULL}, 11162, "tcp"},
{"suncacao-jmxmp",     {NULL}, 11162, "udp"},
{"suncacao-rmi",       {NULL}, 11163, "tcp"},
{"suncacao-rmi",       {NULL}, 11163, "udp"},
{"suncacao-csa",       {NULL}, 11164, "tcp"},
{"suncacao-csa",       {NULL}, 11164, "udp"},
{"suncacao-websvc",    {NULL}, 11165, "tcp"},
{"suncacao-websvc",    {NULL}, 11165, "udp"},
{"snss",               {NULL}, 11171, "udp"},
{"oemcacao-jmxmp",     {NULL}, 11172, "tcp"},
{"oemcacao-rmi",       {NULL}, 11174, "tcp"},
{"oemcacao-websvc",    {NULL}, 11175, "tcp"},
{"smsqp",              {NULL}, 11201, "tcp"},
{"smsqp",              {NULL}, 11201, "udp"},
{"wifree",             {NULL}, 11208, "tcp"},
{"wifree",             {NULL}, 11208, "udp"},
{"memcache",           {NULL}, 11211, "tcp"},
{"memcache",           {NULL}, 11211, "udp"},
{"imip",               {NULL}, 11319, "tcp"},
{"imip",               {NULL}, 11319, "udp"},
{"imip-channels",      {NULL}, 11320, "tcp"},
{"imip-channels",      {NULL}, 11320, "udp"},
{"arena-server",       {NULL}, 11321, "tcp"},
{"arena-server",       {NULL}, 11321, "udp"},
{"atm-uhas",           {NULL}, 11367, "tcp"},
{"atm-uhas",           {NULL}, 11367, "udp"},
{"hkp",                {NULL}, 11371, "tcp"},
{"hkp",                {NULL}, 11371, "udp"},
{"asgcypresstcps",     {NULL}, 11489, "tcp"},
{"tempest-port",       {NULL}, 11600, "tcp"},
{"tempest-port",       {NULL}, 11600, "udp"},
{"h323callsigalt",     {NULL}, 11720, "tcp"},
{"h323callsigalt",     {NULL}, 11720, "udp"},
{"intrepid-ssl",       {NULL}, 11751, "tcp"},
{"intrepid-ssl",       {NULL}, 11751, "udp"},
{"xoraya",             {NULL}, 11876, "tcp"},
{"xoraya",             {NULL}, 11876, "udp"},
{"x2e-disc",           {NULL}, 11877, "udp"},
{"sysinfo-sp",         {NULL}, 11967, "tcp"},
{"sysinfo-sp",         {NULL}, 11967, "udp"},
{"wmereceiving",       {NULL}, 11997, "sctp"},
{"wmedistribution",    {NULL}, 11998, "sctp"},
{"wmereporting",       {NULL}, 11999, "sctp"},
{"entextxid",          {NULL}, 12000, "tcp"},
{"entextxid",          {NULL}, 12000, "udp"},
{"entextnetwk",        {NULL}, 12001, "tcp"},
{"entextnetwk",        {NULL}, 12001, "udp"},
{"entexthigh",         {NULL}, 12002, "tcp"},
{"entexthigh",         {NULL}, 12002, "udp"},
{"entextmed",          {NULL}, 12003, "tcp"},
{"entextmed",          {NULL}, 12003, "udp"},
{"entextlow",          {NULL}, 12004, "tcp"},
{"entextlow",          {NULL}, 12004, "udp"},
{"dbisamserver1",      {NULL}, 12005, "tcp"},
{"dbisamserver1",      {NULL}, 12005, "udp"},
{"dbisamserver2",      {NULL}, 12006, "tcp"},
{"dbisamserver2",      {NULL}, 12006, "udp"},
{"accuracer",          {NULL}, 12007, "tcp"},
{"accuracer",          {NULL}, 12007, "udp"},
{"accuracer-dbms",     {NULL}, 12008, "tcp"},
{"accuracer-dbms",     {NULL}, 12008, "udp"},
{"edbsrvr",            {NULL}, 12010, "tcp"},
{"vipera",             {NULL}, 12012, "tcp"},
{"vipera",             {NULL}, 12012, "udp"},
{"vipera-ssl",         {NULL}, 12013, "tcp"},
{"vipera-ssl",         {NULL}, 12013, "udp"},
{"rets-ssl",           {NULL}, 12109, "tcp"},
{"rets-ssl",           {NULL}, 12109, "udp"},
{"nupaper-ss",         {NULL}, 12121, "tcp"},
{"nupaper-ss",         {NULL}, 12121, "udp"},
{"cawas",              {NULL}, 12168, "tcp"},
{"cawas",              {NULL}, 12168, "udp"},
{"hivep",              {NULL}, 12172, "tcp"},
{"hivep",              {NULL}, 12172, "udp"},
{"linogridengine",     {NULL}, 12300, "tcp"},
{"linogridengine",     {NULL}, 12300, "udp"},
{"warehouse-sss",      {NULL}, 12321, "tcp"},
{"warehouse-sss",      {NULL}, 12321, "udp"},
{"warehouse",          {NULL}, 12322, "tcp"},
{"warehouse",          {NULL}, 12322, "udp"},
{"italk",              {NULL}, 12345, "tcp"},
{"italk",              {NULL}, 12345, "udp"},
{"tsaf",               {NULL}, 12753, "tcp"},
{"tsaf",               {NULL}, 12753, "udp"},
{"i-zipqd",            {NULL}, 13160, "tcp"},
{"i-zipqd",            {NULL}, 13160, "udp"},
{"bcslogc",            {NULL}, 13216, "tcp"},
{"bcslogc",            {NULL}, 13216, "udp"},
{"rs-pias",            {NULL}, 13217, "tcp"},
{"rs-pias",            {NULL}, 13217, "udp"},
{"emc-vcas-tcp",       {NULL}, 13218, "tcp"},
{"emc-vcas-udp",       {NULL}, 13218, "udp"},
{"powwow-client",      {NULL}, 13223, "tcp"},
{"powwow-client",      {NULL}, 13223, "udp"},
{"powwow-server",      {NULL}, 13224, "tcp"},
{"powwow-server",      {NULL}, 13224, "udp"},
{"doip-data",          {NULL}, 13400, "tcp"},
{"doip-disc",          {NULL}, 13400, "udp"},
{"bprd",               {NULL}, 13720, "tcp"},
{"bprd",               {NULL}, 13720, "udp"},
{"bpdbm",              {NULL}, 13721, "tcp"},
{"bpdbm",              {NULL}, 13721, "udp"},
{"bpjava-msvc",        {NULL}, 13722, "tcp"},
{"bpjava-msvc",        {NULL}, 13722, "udp"},
{"vnetd",              {NULL}, 13724, "tcp"},
{"vnetd",              {NULL}, 13724, "udp"},
{"bpcd",               {NULL}, 13782, "tcp"},
{"bpcd",               {NULL}, 13782, "udp"},
{"vopied",             {NULL}, 13783, "tcp"},
{"vopied",             {NULL}, 13783, "udp"},
{"nbdb",               {NULL}, 13785, "tcp"},
{"nbdb",               {NULL}, 13785, "udp"},
{"nomdb",              {NULL}, 13786, "tcp"},
{"nomdb",              {NULL}, 13786, "udp"},
{"dsmcc-config",       {NULL}, 13818, "tcp"},
{"dsmcc-config",       {NULL}, 13818, "udp"},
{"dsmcc-session",      {NULL}, 13819, "tcp"},
{"dsmcc-session",      {NULL}, 13819, "udp"},
{"dsmcc-passthru",     {NULL}, 13820, "tcp"},
{"dsmcc-passthru",     {NULL}, 13820, "udp"},
{"dsmcc-download",     {NULL}, 13821, "tcp"},
{"dsmcc-download",     {NULL}, 13821, "udp"},
{"dsmcc-ccp",          {NULL}, 13822, "tcp"},
{"dsmcc-ccp",          {NULL}, 13822, "udp"},
{"bmdss",              {NULL}, 13823, "tcp"},
{"dta-systems",        {NULL}, 13929, "tcp"},
{"dta-systems",        {NULL}, 13929, "udp"},
{"medevolve",          {NULL}, 13930, "tcp"},
{"scotty-ft",          {NULL}, 14000, "tcp"},
{"scotty-ft",          {NULL}, 14000, "udp"},
{"sua",                {NULL}, 14001, "tcp"},
{"sua",                {NULL}, 14001, "udp"},
{"sua",                {NULL}, 14001, "sctp"},
{"sage-best-com1",     {NULL}, 14033, "tcp"},
{"sage-best-com1",     {NULL}, 14033, "udp"},
{"sage-best-com2",     {NULL}, 14034, "tcp"},
{"sage-best-com2",     {NULL}, 14034, "udp"},
{"vcs-app",            {NULL}, 14141, "tcp"},
{"vcs-app",            {NULL}, 14141, "udp"},
{"icpp",               {NULL}, 14142, "tcp"},
{"icpp",               {NULL}, 14142, "udp"},
{"gcm-app",            {NULL}, 14145, "tcp"},
{"gcm-app",            {NULL}, 14145, "udp"},
{"vrts-tdd",           {NULL}, 14149, "tcp"},
{"vrts-tdd",           {NULL}, 14149, "udp"},
{"vcscmd",             {NULL}, 14150, "tcp"},
{"vad",                {NULL}, 14154, "tcp"},
{"vad",                {NULL}, 14154, "udp"},
{"cps",                {NULL}, 14250, "tcp"},
{"cps",                {NULL}, 14250, "udp"},
{"ca-web-update",      {NULL}, 14414, "tcp"},
{"ca-web-update",      {NULL}, 14414, "udp"},
{"hde-lcesrvr-1",      {NULL}, 14936, "tcp"},
{"hde-lcesrvr-1",      {NULL}, 14936, "udp"},
{"hde-lcesrvr-2",      {NULL}, 14937, "tcp"},
{"hde-lcesrvr-2",      {NULL}, 14937, "udp"},
{"hydap",              {NULL}, 15000, "tcp"},
{"hydap",              {NULL}, 15000, "udp"},
{"xpilot",             {NULL}, 15345, "tcp"},
{"xpilot",             {NULL}, 15345, "udp"},
{"3link",              {NULL}, 15363, "tcp"},
{"3link",              {NULL}, 15363, "udp"},
{"cisco-snat",         {NULL}, 15555, "tcp"},
{"cisco-snat",         {NULL}, 15555, "udp"},
{"bex-xr",             {NULL}, 15660, "tcp"},
{"bex-xr",             {NULL}, 15660, "udp"},
{"ptp",                {NULL}, 15740, "tcp"},
{"ptp",                {NULL}, 15740, "udp"},
{"2ping",              {NULL}, 15998, "udp"},
{"programmar",         {NULL}, 15999, "tcp"},
{"fmsas",              {NULL}, 16000, "tcp"},
{"fmsascon",           {NULL}, 16001, "tcp"},
{"gsms",               {NULL}, 16002, "tcp"},
{"alfin",              {NULL}, 16003, "udp"},
{"jwpc",               {NULL}, 16020, "tcp"},
{"jwpc-bin",           {NULL}, 16021, "tcp"},
{"sun-sea-port",       {NULL}, 16161, "tcp"},
{"sun-sea-port",       {NULL}, 16161, "udp"},
{"solaris-audit",      {NULL}, 16162, "tcp"},
{"etb4j",              {NULL}, 16309, "tcp"},
{"etb4j",              {NULL}, 16309, "udp"},
{"pduncs",             {NULL}, 16310, "tcp"},
{"pduncs",             {NULL}, 16310, "udp"},
{"pdefmns",            {NULL}, 16311, "tcp"},
{"pdefmns",            {NULL}, 16311, "udp"},
{"netserialext1",      {NULL}, 16360, "tcp"},
{"netserialext1",      {NULL}, 16360, "udp"},
{"netserialext2",      {NULL}, 16361, "tcp"},
{"netserialext2",      {NULL}, 16361, "udp"},
{"netserialext3",      {NULL}, 16367, "tcp"},
{"netserialext3",      {NULL}, 16367, "udp"},
{"netserialext4",      {NULL}, 16368, "tcp"},
{"netserialext4",      {NULL}, 16368, "udp"},
{"connected",          {NULL}, 16384, "tcp"},
{"connected",          {NULL}, 16384, "udp"},
{"xoms",               {NULL}, 16619, "tcp"},
{"newbay-snc-mc",      {NULL}, 16900, "tcp"},
{"newbay-snc-mc",      {NULL}, 16900, "udp"},
{"sgcip",              {NULL}, 16950, "tcp"},
{"sgcip",              {NULL}, 16950, "udp"},
{"intel-rci-mp",       {NULL}, 16991, "tcp"},
{"intel-rci-mp",       {NULL}, 16991, "udp"},
{"amt-soap-http",      {NULL}, 16992, "tcp"},
{"amt-soap-http",      {NULL}, 16992, "udp"},
{"amt-soap-https",     {NULL}, 16993, "tcp"},
{"amt-soap-https",     {NULL}, 16993, "udp"},
{"amt-redir-tcp",      {NULL}, 16994, "tcp"},
{"amt-redir-tcp",      {NULL}, 16994, "udp"},
{"amt-redir-tls",      {NULL}, 16995, "tcp"},
{"amt-redir-tls",      {NULL}, 16995, "udp"},
{"isode-dua",          {NULL}, 17007, "tcp"},
{"isode-dua",          {NULL}, 17007, "udp"},
{"soundsvirtual",      {NULL}, 17185, "tcp"},
{"soundsvirtual",      {NULL}, 17185, "udp"},
{"chipper",            {NULL}, 17219, "tcp"},
{"chipper",            {NULL}, 17219, "udp"},
{"integrius-stp",      {NULL}, 17234, "tcp"},
{"integrius-stp",      {NULL}, 17234, "udp"},
{"ssh-mgmt",           {NULL}, 17235, "tcp"},
{"ssh-mgmt",           {NULL}, 17235, "udp"},
{"db-lsp",             {NULL}, 17500, "tcp"},
{"db-lsp-disc",        {NULL}, 17500, "udp"},
{"ea",                 {NULL}, 17729, "tcp"},
{"ea",                 {NULL}, 17729, "udp"},
{"zep",                {NULL}, 17754, "tcp"},
{"zep",                {NULL}, 17754, "udp"},
{"zigbee-ip",          {NULL}, 17755, "tcp"},
{"zigbee-ip",          {NULL}, 17755, "udp"},
{"zigbee-ips",         {NULL}, 17756, "tcp"},
{"zigbee-ips",         {NULL}, 17756, "udp"},
{"sw-orion",           {NULL}, 17777, "tcp"},
{"biimenu",            {NULL}, 18000, "tcp"},
{"biimenu",            {NULL}, 18000, "udp"},
{"radpdf",             {NULL}, 18104, "tcp"},
{"racf",               {NULL}, 18136, "tcp"},
{"opsec-cvp",          {NULL}, 18181, "tcp"},
{"opsec-cvp",          {NULL}, 18181, "udp"},
{"opsec-ufp",          {NULL}, 18182, "tcp"},
{"opsec-ufp",          {NULL}, 18182, "udp"},
{"opsec-sam",          {NULL}, 18183, "tcp"},
{"opsec-sam",          {NULL}, 18183, "udp"},
{"opsec-lea",          {NULL}, 18184, "tcp"},
{"opsec-lea",          {NULL}, 18184, "udp"},
{"opsec-omi",          {NULL}, 18185, "tcp"},
{"opsec-omi",          {NULL}, 18185, "udp"},
{"ohsc",               {NULL}, 18186, "tcp"},
{"ohsc",               {NULL}, 18186, "udp"},
{"opsec-ela",          {NULL}, 18187, "tcp"},
{"opsec-ela",          {NULL}, 18187, "udp"},
{"checkpoint-rtm",     {NULL}, 18241, "tcp"},
{"checkpoint-rtm",     {NULL}, 18241, "udp"},
{"gv-pf",              {NULL}, 18262, "tcp"},
{"gv-pf",              {NULL}, 18262, "udp"},
{"ac-cluster",         {NULL}, 18463, "tcp"},
{"ac-cluster",         {NULL}, 18463, "udp"},
{"rds-ib",             {NULL}, 18634, "tcp"},
{"rds-ib",             {NULL}, 18634, "udp"},
{"rds-ip",             {NULL}, 18635, "tcp"},
{"rds-ip",             {NULL}, 18635, "udp"},
{"ique",               {NULL}, 18769, "tcp"},
{"ique",               {NULL}, 18769, "udp"},
{"infotos",            {NULL}, 18881, "tcp"},
{"infotos",            {NULL}, 18881, "udp"},
{"apc-necmp",          {NULL}, 18888, "tcp"},
{"apc-necmp",          {NULL}, 18888, "udp"},
{"igrid",              {NULL}, 19000, "tcp"},
{"igrid",              {NULL}, 19000, "udp"},
{"j-link",             {NULL}, 19020, "tcp"},
{"opsec-uaa",          {NULL}, 19191, "tcp"},
{"opsec-uaa",          {NULL}, 19191, "udp"},
{"ua-secureagent",     {NULL}, 19194, "tcp"},
{"ua-secureagent",     {NULL}, 19194, "udp"},
{"keysrvr",            {NULL}, 19283, "tcp"},
{"keysrvr",            {NULL}, 19283, "udp"},
{"keyshadow",          {NULL}, 19315, "tcp"},
{"keyshadow",          {NULL}, 19315, "udp"},
{"mtrgtrans",          {NULL}, 19398, "tcp"},
{"mtrgtrans",          {NULL}, 19398, "udp"},
{"hp-sco",             {NULL}, 19410, "tcp"},
{"hp-sco",             {NULL}, 19410, "udp"},
{"hp-sca",             {NULL}, 19411, "tcp"},
{"hp-sca",             {NULL}, 19411, "udp"},
{"hp-sessmon",         {NULL}, 19412, "tcp"},
{"hp-sessmon",         {NULL}, 19412, "udp"},
{"fxuptp",             {NULL}, 19539, "tcp"},
{"fxuptp",             {NULL}, 19539, "udp"},
{"sxuptp",             {NULL}, 19540, "tcp"},
{"sxuptp",             {NULL}, 19540, "udp"},
{"jcp",                {NULL}, 19541, "tcp"},
{"jcp",                {NULL}, 19541, "udp"},
{"iec-104-sec",        {NULL}, 19998, "tcp"},
{"dnp-sec",            {NULL}, 19999, "tcp"},
{"dnp-sec",            {NULL}, 19999, "udp"},
{"dnp",                {NULL}, 20000, "tcp"},
{"dnp",                {NULL}, 20000, "udp"},
{"microsan",           {NULL}, 20001, "tcp"},
{"microsan",           {NULL}, 20001, "udp"},
{"commtact-http",      {NULL}, 20002, "tcp"},
{"commtact-http",      {NULL}, 20002, "udp"},
{"commtact-https",     {NULL}, 20003, "tcp"},
{"commtact-https",     {NULL}, 20003, "udp"},
{"openwebnet",         {NULL}, 20005, "tcp"},
{"openwebnet",         {NULL}, 20005, "udp"},
{"ss-idi-disc",        {NULL}, 20012, "udp"},
{"ss-idi",             {NULL}, 20013, "tcp"},
{"opendeploy",         {NULL}, 20014, "tcp"},
{"opendeploy",         {NULL}, 20014, "udp"},
{"nburn_id",           {NULL}, 20034, "tcp"},
{"nburn_id",           {NULL}, 20034, "udp"},
{"tmophl7mts",         {NULL}, 20046, "tcp"},
{"tmophl7mts",         {NULL}, 20046, "udp"},
{"mountd",             {NULL}, 20048, "tcp"},
{"mountd",             {NULL}, 20048, "udp"},
{"nfsrdma",            {NULL}, 20049, "tcp"},
{"nfsrdma",            {NULL}, 20049, "udp"},
{"nfsrdma",            {NULL}, 20049, "sctp"},
{"tolfab",             {NULL}, 20167, "tcp"},
{"tolfab",             {NULL}, 20167, "udp"},
{"ipdtp-port",         {NULL}, 20202, "tcp"},
{"ipdtp-port",         {NULL}, 20202, "udp"},
{"ipulse-ics",         {NULL}, 20222, "tcp"},
{"ipulse-ics",         {NULL}, 20222, "udp"},
{"emwavemsg",          {NULL}, 20480, "tcp"},
{"emwavemsg",          {NULL}, 20480, "udp"},
{"track",              {NULL}, 20670, "tcp"},
{"track",              {NULL}, 20670, "udp"},
{"athand-mmp",         {NULL}, 20999, "tcp"},
{"athand-mmp",         {NULL}, 20999, "udp"},
{"irtrans",            {NULL}, 21000, "tcp"},
{"irtrans",            {NULL}, 21000, "udp"},
{"dfserver",           {NULL}, 21554, "tcp"},
{"dfserver",           {NULL}, 21554, "udp"},
{"vofr-gateway",       {NULL}, 21590, "tcp"},
{"vofr-gateway",       {NULL}, 21590, "udp"},
{"tvpm",               {NULL}, 21800, "tcp"},
{"tvpm",               {NULL}, 21800, "udp"},
{"webphone",           {NULL}, 21845, "tcp"},
{"webphone",           {NULL}, 21845, "udp"},
{"netspeak-is",        {NULL}, 21846, "tcp"},
{"netspeak-is",        {NULL}, 21846, "udp"},
{"netspeak-cs",        {NULL}, 21847, "tcp"},
{"netspeak-cs",        {NULL}, 21847, "udp"},
{"netspeak-acd",       {NULL}, 21848, "tcp"},
{"netspeak-acd",       {NULL}, 21848, "udp"},
{"netspeak-cps",       {NULL}, 21849, "tcp"},
{"netspeak-cps",       {NULL}, 21849, "udp"},
{"snapenetio",         {NULL}, 22000, "tcp"},
{"snapenetio",         {NULL}, 22000, "udp"},
{"optocontrol",        {NULL}, 22001, "tcp"},
{"optocontrol",        {NULL}, 22001, "udp"},
{"optohost002",        {NULL}, 22002, "tcp"},
{"optohost002",        {NULL}, 22002, "udp"},
{"optohost003",        {NULL}, 22003, "tcp"},
{"optohost003",        {NULL}, 22003, "udp"},
{"optohost004",        {NULL}, 22004, "tcp"},
{"optohost004",        {NULL}, 22004, "udp"},
{"optohost004",        {NULL}, 22005, "tcp"},
{"optohost004",        {NULL}, 22005, "udp"},
{"dcap",               {NULL}, 22125, "tcp"},
{"gsidcap",            {NULL}, 22128, "tcp"},
{"wnn6",               {NULL}, 22273, "tcp"},
{"wnn6",               {NULL}, 22273, "udp"},
{"cis",                {NULL}, 22305, "tcp"},
{"cis",                {NULL}, 22305, "udp"},
{"cis-secure",         {NULL}, 22343, "tcp"},
{"cis-secure",         {NULL}, 22343, "udp"},
{"WibuKey",            {NULL}, 22347, "tcp"},
{"WibuKey",            {NULL}, 22347, "udp"},
{"CodeMeter",          {NULL}, 22350, "tcp"},
{"CodeMeter",          {NULL}, 22350, "udp"},
{"vocaltec-wconf",     {NULL}, 22555, "tcp"},
{"vocaltec-phone",     {NULL}, 22555, "udp"},
{"talikaserver",       {NULL}, 22763, "tcp"},
{"talikaserver",       {NULL}, 22763, "udp"},
{"aws-brf",            {NULL}, 22800, "tcp"},
{"aws-brf",            {NULL}, 22800, "udp"},
{"brf-gw",             {NULL}, 22951, "tcp"},
{"brf-gw",             {NULL}, 22951, "udp"},
{"inovaport1",         {NULL}, 23000, "tcp"},
{"inovaport1",         {NULL}, 23000, "udp"},
{"inovaport2",         {NULL}, 23001, "tcp"},
{"inovaport2",         {NULL}, 23001, "udp"},
{"inovaport3",         {NULL}, 23002, "tcp"},
{"inovaport3",         {NULL}, 23002, "udp"},
{"inovaport4",         {NULL}, 23003, "tcp"},
{"inovaport4",         {NULL}, 23003, "udp"},
{"inovaport5",         {NULL}, 23004, "tcp"},
{"inovaport5",         {NULL}, 23004, "udp"},
{"inovaport6",         {NULL}, 23005, "tcp"},
{"inovaport6",         {NULL}, 23005, "udp"},
{"s102",               {NULL}, 23272, "udp"},
{"elxmgmt",            {NULL}, 23333, "tcp"},
{"elxmgmt",            {NULL}, 23333, "udp"},
{"novar-dbase",        {NULL}, 23400, "tcp"},
{"novar-dbase",        {NULL}, 23400, "udp"},
{"novar-alarm",        {NULL}, 23401, "tcp"},
{"novar-alarm",        {NULL}, 23401, "udp"},
{"novar-global",       {NULL}, 23402, "tcp"},
{"novar-global",       {NULL}, 23402, "udp"},
{"aequus",             {NULL}, 23456, "tcp"},
{"aequus-alt",         {NULL}, 23457, "tcp"},
{"med-ltp",            {NULL}, 24000, "tcp"},
{"med-ltp",            {NULL}, 24000, "udp"},
{"med-fsp-rx",         {NULL}, 24001, "tcp"},
{"med-fsp-rx",         {NULL}, 24001, "udp"},
{"med-fsp-tx",         {NULL}, 24002, "tcp"},
{"med-fsp-tx",         {NULL}, 24002, "udp"},
{"med-supp",           {NULL}, 24003, "tcp"},
{"med-supp",           {NULL}, 24003, "udp"},
{"med-ovw",            {NULL}, 24004, "tcp"},
{"med-ovw",            {NULL}, 24004, "udp"},
{"med-ci",             {NULL}, 24005, "tcp"},
{"med-ci",             {NULL}, 24005, "udp"},
{"med-net-svc",        {NULL}, 24006, "tcp"},
{"med-net-svc",        {NULL}, 24006, "udp"},
{"filesphere",         {NULL}, 24242, "tcp"},
{"filesphere",         {NULL}, 24242, "udp"},
{"vista-4gl",          {NULL}, 24249, "tcp"},
{"vista-4gl",          {NULL}, 24249, "udp"},
{"ild",                {NULL}, 24321, "tcp"},
{"ild",                {NULL}, 24321, "udp"},
{"intel_rci",          {NULL}, 24386, "tcp"},
{"intel_rci",          {NULL}, 24386, "udp"},
{"tonidods",           {NULL}, 24465, "tcp"},
{"tonidods",           {NULL}, 24465, "udp"},
{"binkp",              {NULL}, 24554, "tcp"},
{"binkp",              {NULL}, 24554, "udp"},
{"canditv",            {NULL}, 24676, "tcp"},
{"canditv",            {NULL}, 24676, "udp"},
{"flashfiler",         {NULL}, 24677, "tcp"},
{"flashfiler",         {NULL}, 24677, "udp"},
{"proactivate",        {NULL}, 24678, "tcp"},
{"proactivate",        {NULL}, 24678, "udp"},
{"tcc-http",           {NULL}, 24680, "tcp"},
{"tcc-http",           {NULL}, 24680, "udp"},
{"cslg",               {NULL}, 24754, "tcp"},
{"find",               {NULL}, 24922, "tcp"},
{"find",               {NULL}, 24922, "udp"},
{"icl-twobase1",       {NULL}, 25000, "tcp"},
{"icl-twobase1",       {NULL}, 25000, "udp"},
{"icl-twobase2",       {NULL}, 25001, "tcp"},
{"icl-twobase2",       {NULL}, 25001, "udp"},
{"icl-twobase3",       {NULL}, 25002, "tcp"},
{"icl-twobase3",       {NULL}, 25002, "udp"},
{"icl-twobase4",       {NULL}, 25003, "tcp"},
{"icl-twobase4",       {NULL}, 25003, "udp"},
{"icl-twobase5",       {NULL}, 25004, "tcp"},
{"icl-twobase5",       {NULL}, 25004, "udp"},
{"icl-twobase6",       {NULL}, 25005, "tcp"},
{"icl-twobase6",       {NULL}, 25005, "udp"},
{"icl-twobase7",       {NULL}, 25006, "tcp"},
{"icl-twobase7",       {NULL}, 25006, "udp"},
{"icl-twobase8",       {NULL}, 25007, "tcp"},
{"icl-twobase8",       {NULL}, 25007, "udp"},
{"icl-twobase9",       {NULL}, 25008, "tcp"},
{"icl-twobase9",       {NULL}, 25008, "udp"},
{"icl-twobase10",      {NULL}, 25009, "tcp"},
{"icl-twobase10",      {NULL}, 25009, "udp"},
{"rna",                {NULL}, 25471, "sctp"},
{"sauterdongle",       {NULL}, 25576, "tcp"},
{"vocaltec-hos",       {NULL}, 25793, "tcp"},
{"vocaltec-hos",       {NULL}, 25793, "udp"},
{"tasp-net",           {NULL}, 25900, "tcp"},
{"tasp-net",           {NULL}, 25900, "udp"},
{"niobserver",         {NULL}, 25901, "tcp"},
{"niobserver",         {NULL}, 25901, "udp"},
{"nilinkanalyst",      {NULL}, 25902, "tcp"},
{"nilinkanalyst",      {NULL}, 25902, "udp"},
{"niprobe",            {NULL}, 25903, "tcp"},
{"niprobe",            {NULL}, 25903, "udp"},
{"quake",              {NULL}, 26000, "tcp"},
{"quake",              {NULL}, 26000, "udp"},
{"scscp",              {NULL}, 26133, "tcp"},
{"scscp",              {NULL}, 26133, "udp"},
{"wnn6-ds",            {NULL}, 26208, "tcp"},
{"wnn6-ds",            {NULL}, 26208, "udp"},
{"ezproxy",            {NULL}, 26260, "tcp"},
{"ezproxy",            {NULL}, 26260, "udp"},
{"ezmeeting",          {NULL}, 26261, "tcp"},
{"ezmeeting",          {NULL}, 26261, "udp"},
{"k3software-svr",     {NULL}, 26262, "tcp"},
{"k3software-svr",     {NULL}, 26262, "udp"},
{"k3software-cli",     {NULL}, 26263, "tcp"},
{"k3software-cli",     {NULL}, 26263, "udp"},
{"exoline-tcp",        {NULL}, 26486, "tcp"},
{"exoline-udp",        {NULL}, 26486, "udp"},
{"exoconfig",          {NULL}, 26487, "tcp"},
{"exoconfig",          {NULL}, 26487, "udp"},
{"exonet",             {NULL}, 26489, "tcp"},
{"exonet",             {NULL}, 26489, "udp"},
{"imagepump",          {NULL}, 27345, "tcp"},
{"imagepump",          {NULL}, 27345, "udp"},
{"jesmsjc",            {NULL}, 27442, "tcp"},
{"jesmsjc",            {NULL}, 27442, "udp"},
{"kopek-httphead",     {NULL}, 27504, "tcp"},
{"kopek-httphead",     {NULL}, 27504, "udp"},
{"ars-vista",          {NULL}, 27782, "tcp"},
{"ars-vista",          {NULL}, 27782, "udp"},
{"tw-auth-key",        {NULL}, 27999, "tcp"},
{"tw-auth-key",        {NULL}, 27999, "udp"},
{"nxlmd",              {NULL}, 28000, "tcp"},
{"nxlmd",              {NULL}, 28000, "udp"},
{"pqsp",               {NULL}, 28001, "tcp"},
{"siemensgsm",         {NULL}, 28240, "tcp"},
{"siemensgsm",         {NULL}, 28240, "udp"},
{"sgsap",              {NULL}, 29118, "sctp"},
{"otmp",               {NULL}, 29167, "tcp"},
{"otmp",               {NULL}, 29167, "udp"},
{"sbcap",              {NULL}, 29168, "sctp"},
{"iuhsctpassoc",       {NULL}, 29169, "sctp"},
{"pago-services1",     {NULL}, 30001, "tcp"},
{"pago-services1",     {NULL}, 30001, "udp"},
{"pago-services2",     {NULL}, 30002, "tcp"},
{"pago-services2",     {NULL}, 30002, "udp"},
{"kingdomsonline",     {NULL}, 30260, "tcp"},
{"kingdomsonline",     {NULL}, 30260, "udp"},
{"ovobs",              {NULL}, 30999, "tcp"},
{"ovobs",              {NULL}, 30999, "udp"},
{"autotrac-acp",       {NULL}, 31020, "tcp"},
{"yawn",               {NULL}, 31029, "udp"},
{"xqosd",              {NULL}, 31416, "tcp"},
{"xqosd",              {NULL}, 31416, "udp"},
{"tetrinet",           {NULL}, 31457, "tcp"},
{"tetrinet",           {NULL}, 31457, "udp"},
{"lm-mon",             {NULL}, 31620, "tcp"},
{"lm-mon",             {NULL}, 31620, "udp"},
{"dsx_monitor",        {NULL}, 31685, "tcp"},
{"gamesmith-port",     {NULL}, 31765, "tcp"},
{"gamesmith-port",     {NULL}, 31765, "udp"},
{"iceedcp_tx",         {NULL}, 31948, "tcp"},
{"iceedcp_tx",         {NULL}, 31948, "udp"},
{"iceedcp_rx",         {NULL}, 31949, "tcp"},
{"iceedcp_rx",         {NULL}, 31949, "udp"},
{"iracinghelper",      {NULL}, 32034, "tcp"},
{"iracinghelper",      {NULL}, 32034, "udp"},
{"t1distproc60",       {NULL}, 32249, "tcp"},
{"t1distproc60",       {NULL}, 32249, "udp"},
{"apm-link",           {NULL}, 32483, "tcp"},
{"apm-link",           {NULL}, 32483, "udp"},
{"sec-ntb-clnt",       {NULL}, 32635, "tcp"},
{"sec-ntb-clnt",       {NULL}, 32635, "udp"},
{"DMExpress",          {NULL}, 32636, "tcp"},
{"DMExpress",          {NULL}, 32636, "udp"},
{"filenet-powsrm",     {NULL}, 32767, "tcp"},
{"filenet-powsrm",     {NULL}, 32767, "udp"},
{"filenet-tms",        {NULL}, 32768, "tcp"},
{"filenet-tms",        {NULL}, 32768, "udp"},
{"filenet-rpc",        {NULL}, 32769, "tcp"},
{"filenet-rpc",        {NULL}, 32769, "udp"},
{"filenet-nch",        {NULL}, 32770, "tcp"},
{"filenet-nch",        {NULL}, 32770, "udp"},
{"filenet-rmi",        {NULL}, 32771, "tcp"},
{"filenet-rmi",        {NULL}, 32771, "udp"},
{"filenet-pa",         {NULL}, 32772, "tcp"},
{"filenet-pa",         {NULL}, 32772, "udp"},
{"filenet-cm",         {NULL}, 32773, "tcp"},
{"filenet-cm",         {NULL}, 32773, "udp"},
{"filenet-re",         {NULL}, 32774, "tcp"},
{"filenet-re",         {NULL}, 32774, "udp"},
{"filenet-pch",        {NULL}, 32775, "tcp"},
{"filenet-pch",        {NULL}, 32775, "udp"},
{"filenet-peior",      {NULL}, 32776, "tcp"},
{"filenet-peior",      {NULL}, 32776, "udp"},
{"filenet-obrok",      {NULL}, 32777, "tcp"},
{"filenet-obrok",      {NULL}, 32777, "udp"},
{"mlsn",               {NULL}, 32801, "tcp"},
{"mlsn",               {NULL}, 32801, "udp"},
{"retp",               {NULL}, 32811, "tcp"},
{"idmgratm",           {NULL}, 32896, "tcp"},
{"idmgratm",           {NULL}, 32896, "udp"},
{"aurora-balaena",     {NULL}, 33123, "tcp"},
{"aurora-balaena",     {NULL}, 33123, "udp"},
{"diamondport",        {NULL}, 33331, "tcp"},
{"diamondport",        {NULL}, 33331, "udp"},
{"dgi-serv",           {NULL}, 33333, "tcp"},
{"traceroute",         {NULL}, 33434, "tcp"},
{"traceroute",         {NULL}, 33434, "udp"},
{"snip-slave",         {NULL}, 33656, "tcp"},
{"snip-slave",         {NULL}, 33656, "udp"},
{"turbonote-2",        {NULL}, 34249, "tcp"},
{"turbonote-2",        {NULL}, 34249, "udp"},
{"p-net-local",        {NULL}, 34378, "tcp"},
{"p-net-local",        {NULL}, 34378, "udp"},
{"p-net-remote",       {NULL}, 34379, "tcp"},
{"p-net-remote",       {NULL}, 34379, "udp"},
{"dhanalakshmi",       {NULL}, 34567, "tcp"},
{"profinet-rt",        {NULL}, 34962, "tcp"},
{"profinet-rt",        {NULL}, 34962, "udp"},
{"profinet-rtm",       {NULL}, 34963, "tcp"},
{"profinet-rtm",       {NULL}, 34963, "udp"},
{"profinet-cm",        {NULL}, 34964, "tcp"},
{"profinet-cm",        {NULL}, 34964, "udp"},
{"ethercat",           {NULL}, 34980, "tcp"},
{"ethercat",           {NULL}, 34980, "udp"},
{"allpeers",           {NULL}, 36001, "tcp"},
{"allpeers",           {NULL}, 36001, "udp"},
{"s1-control",         {NULL}, 36412, "sctp"},
{"x2-control",         {NULL}, 36422, "sctp"},
{"m2ap",               {NULL}, 36443, "sctp"},
{"m3ap",               {NULL}, 36444, "sctp"},
{"kastenxpipe",        {NULL}, 36865, "tcp"},
{"kastenxpipe",        {NULL}, 36865, "udp"},
{"neckar",             {NULL}, 37475, "tcp"},
{"neckar",             {NULL}, 37475, "udp"},
{"unisys-eportal",     {NULL}, 37654, "tcp"},
{"unisys-eportal",     {NULL}, 37654, "udp"},
{"galaxy7-data",       {NULL}, 38201, "tcp"},
{"galaxy7-data",       {NULL}, 38201, "udp"},
{"fairview",           {NULL}, 38202, "tcp"},
{"fairview",           {NULL}, 38202, "udp"},
{"agpolicy",           {NULL}, 38203, "tcp"},
{"agpolicy",           {NULL}, 38203, "udp"},
{"turbonote-1",        {NULL}, 39681, "tcp"},
{"turbonote-1",        {NULL}, 39681, "udp"},
{"safetynetp",         {NULL}, 40000, "tcp"},
{"safetynetp",         {NULL}, 40000, "udp"},
{"cscp",               {NULL}, 40841, "tcp"},
{"cscp",               {NULL}, 40841, "udp"},
{"csccredir",          {NULL}, 40842, "tcp"},
{"csccredir",          {NULL}, 40842, "udp"},
{"csccfirewall",       {NULL}, 40843, "tcp"},
{"csccfirewall",       {NULL}, 40843, "udp"},
{"ortec-disc",         {NULL}, 40853, "udp"},
{"fs-qos",             {NULL}, 41111, "tcp"},
{"fs-qos",             {NULL}, 41111, "udp"},
{"tentacle",           {NULL}, 41121, "tcp"},
{"crestron-cip",       {NULL}, 41794, "tcp"},
{"crestron-cip",       {NULL}, 41794, "udp"},
{"crestron-ctp",       {NULL}, 41795, "tcp"},
{"crestron-ctp",       {NULL}, 41795, "udp"},
{"candp",              {NULL}, 42508, "tcp"},
{"candp",              {NULL}, 42508, "udp"},
{"candrp",             {NULL}, 42509, "tcp"},
{"candrp",             {NULL}, 42509, "udp"},
{"caerpc",             {NULL}, 42510, "tcp"},
{"caerpc",             {NULL}, 42510, "udp"},
{"reachout",           {NULL}, 43188, "tcp"},
{"reachout",           {NULL}, 43188, "udp"},
{"ndm-agent-port",     {NULL}, 43189, "tcp"},
{"ndm-agent-port",     {NULL}, 43189, "udp"},
{"ip-provision",       {NULL}, 43190, "tcp"},
{"ip-provision",       {NULL}, 43190, "udp"},
{"noit-transport",     {NULL}, 43191, "tcp"},
{"ew-mgmt",            {NULL}, 43440, "tcp"},
{"ew-disc-cmd",        {NULL}, 43440, "udp"},
{"ciscocsdb",          {NULL}, 43441, "tcp"},
{"ciscocsdb",          {NULL}, 43441, "udp"},
{"pmcd",               {NULL}, 44321, "tcp"},
{"pmcd",               {NULL}, 44321, "udp"},
{"pmcdproxy",          {NULL}, 44322, "tcp"},
{"pmcdproxy",          {NULL}, 44322, "udp"},
{"pcp",                {NULL}, 44323, "udp"},
{"rbr-debug",          {NULL}, 44553, "tcp"},
{"rbr-debug",          {NULL}, 44553, "udp"},
{"EtherNet/IP-2",      {NULL}, 44818, "tcp"},
{"EtherNet/IP-2",      {NULL}, 44818, "udp"},
{"invision-ag",        {NULL}, 45054, "tcp"},
{"invision-ag",        {NULL}, 45054, "udp"},
{"eba",                {NULL}, 45678, "tcp"},
{"eba",                {NULL}, 45678, "udp"},
{"qdb2service",        {NULL}, 45825, "tcp"},
{"qdb2service",        {NULL}, 45825, "udp"},
{"ssr-servermgr",      {NULL}, 45966, "tcp"},
{"ssr-servermgr",      {NULL}, 45966, "udp"},
{"mediabox",           {NULL}, 46999, "tcp"},
{"mediabox",           {NULL}, 46999, "udp"},
{"mbus",               {NULL}, 47000, "tcp"},
{"mbus",               {NULL}, 47000, "udp"},
{"winrm",              {NULL}, 47001, "tcp"},
{"dbbrowse",           {NULL}, 47557, "tcp"},
{"dbbrowse",           {NULL}, 47557, "udp"},
{"directplaysrvr",     {NULL}, 47624, "tcp"},
{"directplaysrvr",     {NULL}, 47624, "udp"},
{"ap",                 {NULL}, 47806, "tcp"},
{"ap",                 {NULL}, 47806, "udp"},
{"bacnet",             {NULL}, 47808, "tcp"},
{"bacnet",             {NULL}, 47808, "udp"},
{"nimcontroller",      {NULL}, 48000, "tcp"},
{"nimcontroller",      {NULL}, 48000, "udp"},
{"nimspooler",         {NULL}, 48001, "tcp"},
{"nimspooler",         {NULL}, 48001, "udp"},
{"nimhub",             {NULL}, 48002, "tcp"},
{"nimhub",             {NULL}, 48002, "udp"},
{"nimgtw",             {NULL}, 48003, "tcp"},
{"nimgtw",             {NULL}, 48003, "udp"},
{"nimbusdb",           {NULL}, 48004, "tcp"},
{"nimbusdbctrl",       {NULL}, 48005, "tcp"},
{"3gpp-cbsp",          {NULL}, 48049, "tcp"},
{"isnetserv",          {NULL}, 48128, "tcp"},
{"isnetserv",          {NULL}, 48128, "udp"},
{"blp5",               {NULL}, 48129, "tcp"},
{"blp5",               {NULL}, 48129, "udp"},
{"com-bardac-dw",      {NULL}, 48556, "tcp"},
{"com-bardac-dw",      {NULL}, 48556, "udp"},
{"iqobject",           {NULL}, 48619, "tcp"},
{"iqobject",           {NULL}, 48619, "udp"},
#endif /* USE_IANA_REGISTERED_PORTS */
{ NULL,                {NULL}, 0, NULL }
};

struct servent *getservbyport(int port, const char *proto)
{
  unsigned short u_port;
  const char *protocol = NULL;
  int i, error = 0;

  u_port = ntohs((unsigned short)port);

  if (proto)
    {
      switch (strlen(proto)) {
      case 3:
        if (!strncasecmp(proto, "tcp", 3))
          protocol = "tcp";
        else if (!strncasecmp(proto, "udp", 3))
          protocol = "udp";
        else
          error = WSAEFAULT;
        break;
      case 4:
        if (!strncasecmp(proto, "sctp", 4))
          protocol = "sctp";
        else if (!strncasecmp(proto, "dccp", 4))
          protocol = "dccp";
        else
          error = WSAEFAULT;
        break;
      default:
        error = WSAEFAULT;
      }
    }

  if (!error)
    {
      for (i = 0; i < (sizeof(IANAports) / sizeof(IANAports[0])) - 1; i++)
        {
          if (u_port == IANAports[i].s_port)
            {
              if (!protocol || !strcasecmp(protocol, IANAports[i].s_proto))
                return (struct servent *)&IANAports[i];
            }
        }
      error = WSANO_DATA;
    }

  SET_SOCKERRNO(error);
  return NULL;
}

#endif /* _WIN32_WCE */
node-v4.8.2/deps/cares/src/ares_platform.h000644 000766 000024 00000002201 13070706730 020574 0ustar00iojsstaff000000 000000 #ifndef HEADER_CARES_PLATFORM_H
#define HEADER_CARES_PLATFORM_H


/* Copyright 1998 by the Massachusetts Institute of Technology.
 * Copyright (C) 2004 - 2011 by Daniel Stenberg et al
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"

#if defined(WIN32) && !defined(MSDOS)

typedef enum {
  WIN_UNKNOWN,
  WIN_3X,
  WIN_9X,
  WIN_NT,
  WIN_CE
} win_platform;

win_platform ares__getplatform(void);

#endif

#if defined(_WIN32_WCE)

struct servent *getservbyport(int port, const char *proto);

#endif

#endif /* HEADER_CARES_PLATFORM_H */
node-v4.8.2/deps/cares/src/ares_private.h000644 000766 000024 00000023540 13070706730 020433 0ustar00iojsstaff000000 000000 #ifndef __ARES_PRIVATE_H
#define __ARES_PRIVATE_H


/* Copyright 1998 by the Massachusetts Institute of Technology.
 * Copyright (C) 2004-2010 by Daniel Stenberg
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

/*
 * Define WIN32 when build target is Win32 API
 */

#if (defined(_WIN32) || defined(__WIN32__)) && !defined(WIN32)
#define WIN32
#endif

#ifdef HAVE_NETINET_IN_H
#include 
#endif

#ifdef WATT32
#include 
#include 
#define writev(s,v,c)     writev_s(s,v,c)
#define HAVE_WRITEV 1
#endif

#define DEFAULT_TIMEOUT         5000 /* milliseconds */
#define DEFAULT_TRIES           4
#ifndef INADDR_NONE
#define INADDR_NONE 0xffffffff
#endif

#if defined(WIN32) && !defined(WATT32)

#define WIN_NS_9X      "System\\CurrentControlSet\\Services\\VxD\\MSTCP"
#define WIN_NS_NT_KEY  "System\\CurrentControlSet\\Services\\Tcpip\\Parameters"
#define NAMESERVER     "NameServer"
#define DHCPNAMESERVER "DhcpNameServer"
#define DATABASEPATH   "DatabasePath"
#define WIN_PATH_HOSTS  "\\hosts"

#elif defined(WATT32)

#define PATH_RESOLV_CONF "/dev/ENV/etc/resolv.conf"

#elif defined(NETWARE)

#define PATH_RESOLV_CONF "sys:/etc/resolv.cfg"
#define PATH_HOSTS              "sys:/etc/hosts"

#elif defined(__riscos__)

#define PATH_HOSTS             "InetDBase:Hosts"

#else

#define PATH_RESOLV_CONF        "/etc/resolv.conf"
#ifdef ETC_INET
#define PATH_HOSTS              "/etc/inet/hosts"
#else
#define PATH_HOSTS              "/etc/hosts"
#endif

#endif

#define ARES_ID_KEY_LEN 31

#include "ares_ipv6.h"
#include "ares_llist.h"

#ifndef HAVE_GETENV
#  include "ares_getenv.h"
#  define getenv(ptr) ares_getenv(ptr)
#endif

#ifndef HAVE_STRDUP
#  include "ares_strdup.h"
#  define strdup(ptr) ares_strdup(ptr)
#endif

#ifndef HAVE_STRCASECMP
#  include "ares_strcasecmp.h"
#  define strcasecmp(p1,p2) ares_strcasecmp(p1,p2)
#endif

#ifndef HAVE_STRNCASECMP
#  include "ares_strcasecmp.h"
#  define strncasecmp(p1,p2,n) ares_strncasecmp(p1,p2,n)
#endif

#ifndef HAVE_WRITEV
#  include "ares_writev.h"
#  define writev(s,ptr,cnt) ares_writev(s,ptr,cnt)
#endif

/********* EDNS defines section ******/
#define EDNSPACKETSZ   1280  /* Reasonable UDP payload size, as suggested
                                in RFC2671 */
#define MAXENDSSZ      4096  /* Maximum (local) limit for edns packet size */
#define EDNSFIXEDSZ    11    /* Size of EDNS header */
/********* EDNS defines section ******/

struct ares_addr {
  int family;
  union {
    struct in_addr       addr4;
    struct ares_in6_addr addr6;
  } addr;
};
#define addrV4 addr.addr4
#define addrV6 addr.addr6

struct query;

struct send_request {
  /* Remaining data to send */
  const unsigned char *data;
  size_t len;

  /* The query for which we're sending this data */
  struct query* owner_query;
  /* The buffer we're using, if we have our own copy of the packet */
  unsigned char *data_storage;

  /* Next request in queue */
  struct send_request *next;
};

struct server_state {
  struct ares_addr addr;
  ares_socket_t udp_socket;
  ares_socket_t tcp_socket;

  /* Mini-buffer for reading the length word */
  unsigned char tcp_lenbuf[2];
  int tcp_lenbuf_pos;
  int tcp_length;

  /* Buffer for reading actual TCP data */
  unsigned char *tcp_buffer;
  int tcp_buffer_pos;

  /* TCP output queue */
  struct send_request *qhead;
  struct send_request *qtail;

  /* Which incarnation of this connection is this? We don't want to
   * retransmit requests into the very same socket, but if the server
   * closes on us and we re-open the connection, then we do want to
   * re-send. */
  int tcp_connection_generation;

  /* Circular, doubly-linked list of outstanding queries to this server */
  struct list_node queries_to_server;

  /* Link back to owning channel */
  ares_channel channel;

  /* Is this server broken? We mark connections as broken when a
   * request that is queued for sending times out.
   */
  int is_broken;
};

/* State to represent a DNS query */
struct query {
  /* Query ID from qbuf, for faster lookup, and current timeout */
  unsigned short qid;
  struct timeval timeout;

  /*
   * Links for the doubly-linked lists in which we insert a query.
   * These circular, doubly-linked lists that are hash-bucketed based
   * the attributes we care about, help making most important
   * operations O(1).
   */
  struct list_node queries_by_qid;    /* hopefully in same cache line as qid */
  struct list_node queries_by_timeout;
  struct list_node queries_to_server;
  struct list_node all_queries;

  /* Query buf with length at beginning, for TCP transmission */
  unsigned char *tcpbuf;
  int tcplen;

  /* Arguments passed to ares_send() (qbuf points into tcpbuf) */
  const unsigned char *qbuf;
  int qlen;
  ares_callback callback;
  void *arg;

  /* Query status */
  int try_count; /* Number of times we tried this query already. */
  int server; /* Server this query has last been sent to. */
  struct query_server_info *server_info;   /* per-server state */
  int using_tcp;
  int error_status;
  int timeouts; /* number of timeouts we saw for this request */
};

/* Per-server state for a query */
struct query_server_info {
  int skip_server;  /* should we skip server, due to errors, etc? */
  int tcp_connection_generation;  /* into which TCP connection did we send? */
};

/* An IP address pattern; matches an IP address X if X & mask == addr */
#define PATTERN_MASK 0x1
#define PATTERN_CIDR 0x2

struct apattern {
  union
  {
    struct in_addr       addr4;
    struct ares_in6_addr addr6;
  } addr;
  union
  {
    struct in_addr       addr4;
    struct ares_in6_addr addr6;
    unsigned short       bits;
  } mask;
  int family;
  unsigned short type;
};

typedef struct rc4_key
{
  unsigned char state[256];
  unsigned char x;
  unsigned char y;
} rc4_key;

struct ares_channeldata {
  /* Configuration data */
  int flags;
  int timeout; /* in milliseconds */
  int tries;
  int ndots;
  int rotate; /* if true, all servers specified are used */
  int udp_port;
  int tcp_port;
  int socket_send_buffer_size;
  int socket_receive_buffer_size;
  char **domains;
  int ndomains;
  struct apattern *sortlist;
  int nsort;
  char *lookups;
  int ednspsz;

  /* For binding to local devices and/or IP addresses.  Leave
   * them null/zero for no binding.
   */
  char local_dev_name[32];
  unsigned int local_ip4;
  unsigned char local_ip6[16];

  int optmask; /* the option bitfield passed in at init time */

  /* Server addresses and communications state */
  struct server_state *servers;
  int nservers;

  /* ID to use for next query */
  unsigned short next_id;
  /* key to use when generating new ids */
  rc4_key id_key;

  /* Generation number to use for the next TCP socket open/close */
  int tcp_connection_generation;

  /* The time at which we last called process_timeouts(). Uses integer seconds
     just to draw the line somewhere. */
  time_t last_timeout_processed;

  /* Last server we sent a query to. */
  int last_server;

  /* Circular, doubly-linked list of queries, bucketed various ways.... */
  /* All active queries in a single list: */
  struct list_node all_queries;
  /* Queries bucketed by qid, for quickly dispatching DNS responses: */
#define ARES_QID_TABLE_SIZE 2048
  struct list_node queries_by_qid[ARES_QID_TABLE_SIZE];
  /* Queries bucketed by timeout, for quickly handling timeouts: */
#define ARES_TIMEOUT_TABLE_SIZE 1024
  struct list_node queries_by_timeout[ARES_TIMEOUT_TABLE_SIZE];

  ares_sock_state_cb sock_state_cb;
  void *sock_state_cb_data;

  ares_sock_create_callback sock_create_cb;
  void *sock_create_cb_data;
};

/* return true if now is exactly check time or later */
int ares__timedout(struct timeval *now,
                   struct timeval *check);

/* returns ARES_SUCCESS if library has been initialized */
int ares_library_initialized(void);
void ares__send_query(ares_channel channel, struct query *query,
                      struct timeval *now);
void ares__close_sockets(ares_channel channel, struct server_state *server);
int ares__get_hostent(FILE *fp, int family, struct hostent **host);
int ares__read_line(FILE *fp, char **buf, size_t *bufsize);
void ares__free_query(struct query *query);
unsigned short ares__generate_new_id(rc4_key* key);
struct timeval ares__tvnow(void);
int ares__expand_name_for_response(const unsigned char *encoded,
                                   const unsigned char *abuf, int alen,
                                   char **s, long *enclen);
void ares__init_servers_state(ares_channel channel);
void ares__destroy_servers_state(ares_channel channel);
#if 0 /* Not used */
long ares__tvdiff(struct timeval t1, struct timeval t2);
#endif

#define ARES_SWAP_BYTE(a,b) \
  { unsigned char swapByte = *(a);  *(a) = *(b);  *(b) = swapByte; }

#define SOCK_STATE_CALLBACK(c, s, r, w)                                 \
  do {                                                                  \
    if ((c)->sock_state_cb)                                             \
      (c)->sock_state_cb((c)->sock_state_cb_data, (s), (r), (w));       \
  } WHILE_FALSE

#ifdef CURLDEBUG
/* This is low-level hard-hacking memory leak tracking and similar. Using the
   libcurl lowlevel code from within library is ugly and only works when
   c-ares is built and linked with a similarly curldebug-enabled libcurl,
   but we do this anyway for convenience. */
#define HEADER_CURL_SETUP_ONCE_H
#include "../lib/memdebug.h"
#endif

#endif /* __ARES_PRIVATE_H */
node-v4.8.2/deps/cares/src/ares_process.c000644 000766 000024 00000121362 13070706730 020433 0ustar00iojsstaff000000 000000 
/* Copyright 1998 by the Massachusetts Institute of Technology.
 * Copyright (C) 2004-2013 by Daniel Stenberg
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"

#ifdef HAVE_SYS_UIO_H
#  include 
#endif
#ifdef HAVE_NETINET_IN_H
#  include 
#endif
#ifdef HAVE_NETINET_TCP_H
#  include 
#endif
#ifdef HAVE_NETDB_H
#  include 
#endif
#ifdef HAVE_ARPA_NAMESER_H
#  include 
#else
#  include "nameser.h"
#endif
#ifdef HAVE_ARPA_NAMESER_COMPAT_H
#  include 
#endif

#ifdef HAVE_STRINGS_H
#  include 
#endif
#ifdef HAVE_SYS_IOCTL_H
#  include 
#endif
#ifdef NETWARE
#  include 
#endif

#include 
#include 

#include "ares.h"
#include "ares_dns.h"
#include "ares_nowarn.h"
#include "ares_private.h"


static int try_again(int errnum);
static void write_tcp_data(ares_channel channel, fd_set *write_fds,
                           ares_socket_t write_fd, struct timeval *now);
static void read_tcp_data(ares_channel channel, fd_set *read_fds,
                          ares_socket_t read_fd, struct timeval *now);
static void read_udp_packets(ares_channel channel, fd_set *read_fds,
                             ares_socket_t read_fd, struct timeval *now);
static void advance_tcp_send_queue(ares_channel channel, int whichserver,
                                   ssize_t num_bytes);
static void process_timeouts(ares_channel channel, struct timeval *now);
static void process_broken_connections(ares_channel channel,
                                       struct timeval *now);
static void process_answer(ares_channel channel, unsigned char *abuf,
                           int alen, int whichserver, int tcp,
                           struct timeval *now);
static void handle_error(ares_channel channel, int whichserver,
                         struct timeval *now);
static void skip_server(ares_channel channel, struct query *query,
                        int whichserver);
static void next_server(ares_channel channel, struct query *query,
                        struct timeval *now);
static int open_tcp_socket(ares_channel channel, struct server_state *server);
static int open_udp_socket(ares_channel channel, struct server_state *server);
static int same_questions(const unsigned char *qbuf, int qlen,
                          const unsigned char *abuf, int alen);
static int same_address(struct sockaddr *sa, struct ares_addr *aa);
static void end_query(ares_channel channel, struct query *query, int status,
                      unsigned char *abuf, int alen);

/* return true if now is exactly check time or later */
int ares__timedout(struct timeval *now,
                   struct timeval *check)
{
  long secs = (now->tv_sec - check->tv_sec);

  if(secs > 0)
    return 1; /* yes, timed out */
  if(secs < 0)
    return 0; /* nope, not timed out */

  /* if the full seconds were identical, check the sub second parts */
  return (now->tv_usec - check->tv_usec >= 0);
}

/* add the specific number of milliseconds to the time in the first argument */
static void timeadd(struct timeval *now, int millisecs)
{
  now->tv_sec += millisecs/1000;
  now->tv_usec += (millisecs%1000)*1000;

  if(now->tv_usec >= 1000000) {
    ++(now->tv_sec);
    now->tv_usec -= 1000000;
  }
}

/*
 * generic process function
 */
static void processfds(ares_channel channel,
                       fd_set *read_fds, ares_socket_t read_fd,
                       fd_set *write_fds, ares_socket_t write_fd)
{
  struct timeval now = ares__tvnow();

  write_tcp_data(channel, write_fds, write_fd, &now);
  read_tcp_data(channel, read_fds, read_fd, &now);
  read_udp_packets(channel, read_fds, read_fd, &now);
  process_timeouts(channel, &now);
  process_broken_connections(channel, &now);
}

/* Something interesting happened on the wire, or there was a timeout.
 * See what's up and respond accordingly.
 */
void ares_process(ares_channel channel, fd_set *read_fds, fd_set *write_fds)
{
  processfds(channel, read_fds, ARES_SOCKET_BAD, write_fds, ARES_SOCKET_BAD);
}

/* Something interesting happened on the wire, or there was a timeout.
 * See what's up and respond accordingly.
 */
void ares_process_fd(ares_channel channel,
                     ares_socket_t read_fd, /* use ARES_SOCKET_BAD or valid
                                               file descriptors */
                     ares_socket_t write_fd)
{
  processfds(channel, NULL, read_fd, NULL, write_fd);
}


/* Return 1 if the specified error number describes a readiness error, or 0
 * otherwise. This is mostly for HP-UX, which could return EAGAIN or
 * EWOULDBLOCK. See this man page
 *
 * http://devrsrc1.external.hp.com/STKS/cgi-bin/man2html?
 *     manpage=/usr/share/man/man2.Z/send.2
 */
static int try_again(int errnum)
{
#if !defined EWOULDBLOCK && !defined EAGAIN
#error "Neither EWOULDBLOCK nor EAGAIN defined"
#endif
  switch (errnum)
    {
#ifdef EWOULDBLOCK
    case EWOULDBLOCK:
      return 1;
#endif
#if defined EAGAIN && EAGAIN != EWOULDBLOCK
    case EAGAIN:
      return 1;
#endif
    }
  return 0;
}

/* If any TCP sockets select true for writing, write out queued data
 * we have for them.
 */
static void write_tcp_data(ares_channel channel,
                           fd_set *write_fds,
                           ares_socket_t write_fd,
                           struct timeval *now)
{
  struct server_state *server;
  struct send_request *sendreq;
  struct iovec *vec;
  int i;
  ssize_t scount;
  ssize_t wcount;
  size_t n;

  if(!write_fds && (write_fd == ARES_SOCKET_BAD))
    /* no possible action */
    return;

  for (i = 0; i < channel->nservers; i++)
    {
      /* Make sure server has data to send and is selected in write_fds or
         write_fd. */
      server = &channel->servers[i];
      if (!server->qhead || server->tcp_socket == ARES_SOCKET_BAD ||
          server->is_broken)
        continue;

      if(write_fds) {
        if(!FD_ISSET(server->tcp_socket, write_fds))
          continue;
      }
      else {
        if(server->tcp_socket != write_fd)
          continue;
      }

      if(write_fds)
        /* If there's an error and we close this socket, then open
         * another with the same fd to talk to another server, then we
         * don't want to think that it was the new socket that was
         * ready. This is not disastrous, but is likely to result in
         * extra system calls and confusion. */
        FD_CLR(server->tcp_socket, write_fds);

      /* Count the number of send queue items. */
      n = 0;
      for (sendreq = server->qhead; sendreq; sendreq = sendreq->next)
        n++;

      /* Allocate iovecs so we can send all our data at once. */
      vec = malloc(n * sizeof(struct iovec));
      if (vec)
        {
          /* Fill in the iovecs and send. */
          n = 0;
          for (sendreq = server->qhead; sendreq; sendreq = sendreq->next)
            {
              vec[n].iov_base = (char *) sendreq->data;
              vec[n].iov_len = sendreq->len;
              n++;
            }
          wcount = (ssize_t)writev(server->tcp_socket, vec, (int)n);
          free(vec);
          if (wcount < 0)
            {
              if (!try_again(SOCKERRNO))
                handle_error(channel, i, now);
              continue;
            }

          /* Advance the send queue by as many bytes as we sent. */
          advance_tcp_send_queue(channel, i, wcount);
        }
      else
        {
          /* Can't allocate iovecs; just send the first request. */
          sendreq = server->qhead;

          scount = swrite(server->tcp_socket, sendreq->data, sendreq->len);
          if (scount < 0)
            {
              if (!try_again(SOCKERRNO))
                handle_error(channel, i, now);
              continue;
            }

          /* Advance the send queue by as many bytes as we sent. */
          advance_tcp_send_queue(channel, i, scount);
        }
    }
}

/* Consume the given number of bytes from the head of the TCP send queue. */
static void advance_tcp_send_queue(ares_channel channel, int whichserver,
                                   ssize_t num_bytes)
{
  struct send_request *sendreq;
  struct server_state *server = &channel->servers[whichserver];
  while (num_bytes > 0) {
    sendreq = server->qhead;
    if ((size_t)num_bytes >= sendreq->len) {
      num_bytes -= sendreq->len;
      server->qhead = sendreq->next;
      if (sendreq->data_storage)
        free(sendreq->data_storage);
      free(sendreq);
      if (server->qhead == NULL) {
        SOCK_STATE_CALLBACK(channel, server->tcp_socket, 1, 0);
        server->qtail = NULL;

        /* qhead is NULL so we cannot continue this loop */
        break;
      }
    }
    else {
      sendreq->data += num_bytes;
      sendreq->len -= num_bytes;
      num_bytes = 0;
    }
  }
}

/* If any TCP socket selects true for reading, read some data,
 * allocate a buffer if we finish reading the length word, and process
 * a packet if we finish reading one.
 */
static void read_tcp_data(ares_channel channel, fd_set *read_fds,
                          ares_socket_t read_fd, struct timeval *now)
{
  struct server_state *server;
  int i;
  ssize_t count;

  if(!read_fds && (read_fd == ARES_SOCKET_BAD))
    /* no possible action */
    return;

  for (i = 0; i < channel->nservers; i++)
    {
      /* Make sure the server has a socket and is selected in read_fds. */
      server = &channel->servers[i];
      if (server->tcp_socket == ARES_SOCKET_BAD || server->is_broken)
        continue;

      if(read_fds) {
        if(!FD_ISSET(server->tcp_socket, read_fds))
          continue;
      }
      else {
        if(server->tcp_socket != read_fd)
          continue;
      }

      if(read_fds)
        /* If there's an error and we close this socket, then open another
         * with the same fd to talk to another server, then we don't want to
         * think that it was the new socket that was ready. This is not
         * disastrous, but is likely to result in extra system calls and
         * confusion. */
        FD_CLR(server->tcp_socket, read_fds);

      if (server->tcp_lenbuf_pos != 2)
        {
          /* We haven't yet read a length word, so read that (or
           * what's left to read of it).
           */
          count = sread(server->tcp_socket,
                        server->tcp_lenbuf + server->tcp_lenbuf_pos,
                        2 - server->tcp_lenbuf_pos);
          if (count <= 0)
            {
              if (!(count == -1 && try_again(SOCKERRNO)))
                handle_error(channel, i, now);
              continue;
            }

          server->tcp_lenbuf_pos += (int)count;
          if (server->tcp_lenbuf_pos == 2)
            {
              /* We finished reading the length word.  Decode the
               * length and allocate a buffer for the data.
               */
              server->tcp_length = server->tcp_lenbuf[0] << 8
                | server->tcp_lenbuf[1];
              server->tcp_buffer = malloc(server->tcp_length);
              if (!server->tcp_buffer)
                handle_error(channel, i, now);
              server->tcp_buffer_pos = 0;
            }
        }
      else
        {
          /* Read data into the allocated buffer. */
          count = sread(server->tcp_socket,
                        server->tcp_buffer + server->tcp_buffer_pos,
                        server->tcp_length - server->tcp_buffer_pos);
          if (count <= 0)
            {
              if (!(count == -1 && try_again(SOCKERRNO)))
                handle_error(channel, i, now);
              continue;
            }

          server->tcp_buffer_pos += (int)count;
          if (server->tcp_buffer_pos == server->tcp_length)
            {
              /* We finished reading this answer; process it and
               * prepare to read another length word.
               */
              process_answer(channel, server->tcp_buffer, server->tcp_length,
                             i, 1, now);
          if (server->tcp_buffer)
                        free(server->tcp_buffer);
              server->tcp_buffer = NULL;
              server->tcp_lenbuf_pos = 0;
              server->tcp_buffer_pos = 0;
            }
        }
    }
}

/* If any UDP sockets select true for reading, process them. */
static void read_udp_packets(ares_channel channel, fd_set *read_fds,
                             ares_socket_t read_fd, struct timeval *now)
{
  struct server_state *server;
  int i;
  ssize_t count;
  unsigned char buf[MAXENDSSZ + 1];
#ifdef HAVE_RECVFROM
  ares_socklen_t fromlen;
  union {
    struct sockaddr     sa;
    struct sockaddr_in  sa4;
    struct sockaddr_in6 sa6;
  } from;
#endif

  if(!read_fds && (read_fd == ARES_SOCKET_BAD))
    /* no possible action */
    return;

  for (i = 0; i < channel->nservers; i++)
    {
      /* Make sure the server has a socket and is selected in read_fds. */
      server = &channel->servers[i];

      if (server->udp_socket == ARES_SOCKET_BAD || server->is_broken)
        continue;

      if(read_fds) {
        if(!FD_ISSET(server->udp_socket, read_fds))
          continue;
      }
      else {
        if(server->udp_socket != read_fd)
          continue;
      }

      if(read_fds)
        /* If there's an error and we close this socket, then open
         * another with the same fd to talk to another server, then we
         * don't want to think that it was the new socket that was
         * ready. This is not disastrous, but is likely to result in
         * extra system calls and confusion. */
        FD_CLR(server->udp_socket, read_fds);

      /* To reduce event loop overhead, read and process as many
       * packets as we can. */
      do {
        if (server->udp_socket == ARES_SOCKET_BAD)
          count = 0;

        else {
#ifdef HAVE_RECVFROM
          if (server->addr.family == AF_INET)
            fromlen = sizeof(from.sa4);
          else
            fromlen = sizeof(from.sa6);
          count = (ssize_t)recvfrom(server->udp_socket, (void *)buf,
                                    sizeof(buf), 0, &from.sa, &fromlen);
#else
          count = sread(server->udp_socket, buf, sizeof(buf));
#endif
        }

        if (count == -1 && try_again(SOCKERRNO))
          continue;
        else if (count <= 0)
          handle_error(channel, i, now);
#ifdef HAVE_RECVFROM
        else if (!same_address(&from.sa, &server->addr))
          /* The address the response comes from does not match the address we
           * sent the request to. Someone may be attempting to perform a cache
           * poisoning attack. */
          break;
#endif
        else
          process_answer(channel, buf, (int)count, i, 0, now);
       } while (count > 0);
    }
}

/* If any queries have timed out, note the timeout and move them on. */
static void process_timeouts(ares_channel channel, struct timeval *now)
{
  time_t t;  /* the time of the timeouts we're processing */
  struct query *query;
  struct list_node* list_head;
  struct list_node* list_node;

  /* Process all the timeouts that have fired since the last time we processed
   * timeouts. If things are going well, then we'll have hundreds/thousands of
   * queries that fall into future buckets, and only a handful of requests
   * that fall into the "now" bucket, so this should be quite quick.
   */
  for (t = channel->last_timeout_processed; t <= now->tv_sec; t++)
    {
      list_head = &(channel->queries_by_timeout[t % ARES_TIMEOUT_TABLE_SIZE]);
      for (list_node = list_head->next; list_node != list_head; )
        {
          query = list_node->data;
          list_node = list_node->next;  /* in case the query gets deleted */
          if (query->timeout.tv_sec && ares__timedout(now, &query->timeout))
            {
              query->error_status = ARES_ETIMEOUT;
              ++query->timeouts;
              next_server(channel, query, now);
            }
        }
     }
  channel->last_timeout_processed = now->tv_sec;
}

/* Handle an answer from a server. */
static void process_answer(ares_channel channel, unsigned char *abuf,
                           int alen, int whichserver, int tcp,
                           struct timeval *now)
{
  int tc, rcode, packetsz;
  unsigned short id;
  struct query *query;
  struct list_node* list_head;
  struct list_node* list_node;

  /* If there's no room in the answer for a header, we can't do much
   * with it. */
  if (alen < HFIXEDSZ)
    return;

  /* Grab the query ID, truncate bit, and response code from the packet. */
  id = DNS_HEADER_QID(abuf);
  tc = DNS_HEADER_TC(abuf);
  rcode = DNS_HEADER_RCODE(abuf);

  /* Find the query corresponding to this packet. The queries are
   * hashed/bucketed by query id, so this lookup should be quick.  Note that
   * both the query id and the questions must be the same; when the query id
   * wraps around we can have multiple outstanding queries with the same query
   * id, so we need to check both the id and question.
   */
  query = NULL;
  list_head = &(channel->queries_by_qid[id % ARES_QID_TABLE_SIZE]);
  for (list_node = list_head->next; list_node != list_head;
       list_node = list_node->next)
    {
      struct query *q = list_node->data;
      if ((q->qid == id) && same_questions(q->qbuf, q->qlen, abuf, alen))
        {
          query = q;
          break;
        }
    }
  if (!query)
    return;

  packetsz = PACKETSZ;
  /* If we use EDNS and server answers with one of these RCODES, the protocol
   * extension is not understood by the responder. We must retry the query
   * without EDNS enabled.
   */
  if (channel->flags & ARES_FLAG_EDNS)
  {
      packetsz = channel->ednspsz;
      if (rcode == NOTIMP || rcode == FORMERR || rcode == SERVFAIL)
      {
          int qlen = alen - EDNSFIXEDSZ;
          channel->flags ^= ARES_FLAG_EDNS;
          query->tcplen -= EDNSFIXEDSZ;
          query->qlen -= EDNSFIXEDSZ;
          query->tcpbuf[0] = (unsigned char)((qlen >> 8) & 0xff);
          query->tcpbuf[1] = (unsigned char)(qlen & 0xff);
          DNS_HEADER_SET_ARCOUNT(query->tcpbuf + 2, 0);
          query->tcpbuf = realloc(query->tcpbuf, query->tcplen);
          ares__send_query(channel, query, now);
          return;
      }
  }

  /* If we got a truncated UDP packet and are not ignoring truncation,
   * don't accept the packet, and switch the query to TCP if we hadn't
   * done so already.
   */
  if ((tc || alen > packetsz) && !tcp && !(channel->flags & ARES_FLAG_IGNTC))
    {
      if (!query->using_tcp)
        {
          query->using_tcp = 1;
          ares__send_query(channel, query, now);
        }
      return;
    }

  /* Limit alen to PACKETSZ if we aren't using TCP (only relevant if we
   * are ignoring truncation.
   */
  if (alen > packetsz && !tcp)
      alen = packetsz;

  /* If we aren't passing through all error packets, discard packets
   * with SERVFAIL, NOTIMP, or REFUSED response codes.
   */
  if (!(channel->flags & ARES_FLAG_NOCHECKRESP))
    {
      if (rcode == SERVFAIL || rcode == NOTIMP || rcode == REFUSED)
        {
          skip_server(channel, query, whichserver);
          if (query->server == whichserver)
            next_server(channel, query, now);
          return;
        }
    }

  end_query(channel, query, ARES_SUCCESS, abuf, alen);
}

/* Close all the connections that are no longer usable. */
static void process_broken_connections(ares_channel channel,
                                       struct timeval *now)
{
  int i;
  for (i = 0; i < channel->nservers; i++)
    {
      struct server_state *server = &channel->servers[i];
      if (server->is_broken)
        {
          handle_error(channel, i, now);
        }
    }
}

/* Swap the contents of two lists */
static void swap_lists(struct list_node* head_a,
                       struct list_node* head_b)
{
  int is_a_empty = ares__is_list_empty(head_a);
  int is_b_empty = ares__is_list_empty(head_b);
  struct list_node old_a = *head_a;
  struct list_node old_b = *head_b;

  if (is_a_empty) {
    ares__init_list_head(head_b);
  } else {
    *head_b = old_a;
    old_a.next->prev = head_b;
    old_a.prev->next = head_b;
  }
  if (is_b_empty) {
    ares__init_list_head(head_a);
  } else {
    *head_a = old_b;
    old_b.next->prev = head_a;
    old_b.prev->next = head_a;
  }
}

static void handle_error(ares_channel channel, int whichserver,
                         struct timeval *now)
{
  struct server_state *server;
  struct query *query;
  struct list_node list_head;
  struct list_node* list_node;

  server = &channel->servers[whichserver];

  /* Reset communications with this server. */
  ares__close_sockets(channel, server);

  /* Tell all queries talking to this server to move on and not try this
   * server again. We steal the current list of queries that were in-flight to
   * this server, since when we call next_server this can cause the queries to
   * be re-sent to this server, which will re-insert these queries in that
   * same server->queries_to_server list.
   */
  ares__init_list_head(&list_head);
  swap_lists(&list_head, &(server->queries_to_server));
  for (list_node = list_head.next; list_node != &list_head; )
    {
      query = list_node->data;
      list_node = list_node->next;  /* in case the query gets deleted */
      assert(query->server == whichserver);
      skip_server(channel, query, whichserver);
      next_server(channel, query, now);
    }
  /* Each query should have removed itself from our temporary list as
   * it re-sent itself or finished up...
   */
  assert(ares__is_list_empty(&list_head));
}

static void skip_server(ares_channel channel, struct query *query,
                        int whichserver)
{
  /* The given server gave us problems with this query, so if we have the
   * luxury of using other servers, then let's skip the potentially broken
   * server and just use the others. If we only have one server and we need to
   * retry then we should just go ahead and re-use that server, since it's our
   * only hope; perhaps we just got unlucky, and retrying will work (eg, the
   * server timed out our TCP connection just as we were sending another
   * request).
   */
  if (channel->nservers > 1)
    {
      query->server_info[whichserver].skip_server = 1;
    }
}

static void next_server(ares_channel channel, struct query *query,
                        struct timeval *now)
{
  /* We need to try each server channel->tries times. We have channel->nservers
   * servers to try. In total, we need to do channel->nservers * channel->tries
   * attempts. Use query->try to remember how many times we already attempted
   * this query. Use modular arithmetic to find the next server to try. */
  while (++(query->try_count) < (channel->nservers * channel->tries))
    {
      struct server_state *server;

      /* Move on to the next server. */
      query->server = (query->server + 1) % channel->nservers;
      server = &channel->servers[query->server];

      /* We don't want to use this server if (1) we decided this connection is
       * broken, and thus about to be closed, (2) we've decided to skip this
       * server because of earlier errors we encountered, or (3) we already
       * sent this query over this exact connection.
       */
      if (!server->is_broken &&
           !query->server_info[query->server].skip_server &&
           !(query->using_tcp &&
             (query->server_info[query->server].tcp_connection_generation ==
              server->tcp_connection_generation)))
        {
           ares__send_query(channel, query, now);
           return;
        }

      /* You might think that with TCP we only need one try. However, even
       * when using TCP, servers can time-out our connection just as we're
       * sending a request, or close our connection because they die, or never
       * send us a reply because they get wedged or tickle a bug that drops
       * our request.
       */
    }

  /* If we are here, all attempts to perform query failed. */
  end_query(channel, query, query->error_status, NULL, 0);
}

void ares__send_query(ares_channel channel, struct query *query,
                      struct timeval *now)
{
  struct send_request *sendreq;
  struct server_state *server;
  int timeplus;

  server = &channel->servers[query->server];
  if (query->using_tcp)
    {
      /* Make sure the TCP socket for this server is set up and queue
       * a send request.
       */
      if (server->tcp_socket == ARES_SOCKET_BAD)
        {
          if (open_tcp_socket(channel, server) == -1)
            {
              skip_server(channel, query, query->server);
              next_server(channel, query, now);
              return;
            }
        }
      sendreq = calloc(1, sizeof(struct send_request));
      if (!sendreq)
        {
        end_query(channel, query, ARES_ENOMEM, NULL, 0);
          return;
        }
      /* To make the common case fast, we avoid copies by using the query's
       * tcpbuf for as long as the query is alive. In the rare case where the
       * query ends while it's queued for transmission, then we give the
       * sendreq its own copy of the request packet and put it in
       * sendreq->data_storage.
       */
      sendreq->data_storage = NULL;
      sendreq->data = query->tcpbuf;
      sendreq->len = query->tcplen;
      sendreq->owner_query = query;
      sendreq->next = NULL;
      if (server->qtail)
        server->qtail->next = sendreq;
      else
        {
          SOCK_STATE_CALLBACK(channel, server->tcp_socket, 1, 1);
          server->qhead = sendreq;
        }
      server->qtail = sendreq;
      query->server_info[query->server].tcp_connection_generation =
        server->tcp_connection_generation;
    }
  else
    {
      if (server->udp_socket == ARES_SOCKET_BAD)
        {
          if (open_udp_socket(channel, server) == -1)
            {
              skip_server(channel, query, query->server);
              next_server(channel, query, now);
              return;
            }
        }
      if (swrite(server->udp_socket, query->qbuf, query->qlen) == -1)
        {
          /* FIXME: Handle EAGAIN here since it likely can happen. */
          skip_server(channel, query, query->server);
          next_server(channel, query, now);
          return;
        }
    }
    timeplus = channel->timeout << (query->try_count / channel->nservers);
    timeplus = (timeplus * (9 + (rand () & 7))) / 16;
    query->timeout = *now;
    timeadd(&query->timeout, timeplus);
    /* Keep track of queries bucketed by timeout, so we can process
     * timeout events quickly.
     */
    ares__remove_from_list(&(query->queries_by_timeout));
    ares__insert_in_list(
        &(query->queries_by_timeout),
        &(channel->queries_by_timeout[query->timeout.tv_sec %
                                      ARES_TIMEOUT_TABLE_SIZE]));

    /* Keep track of queries bucketed by server, so we can process server
     * errors quickly.
     */
    ares__remove_from_list(&(query->queries_to_server));
    ares__insert_in_list(&(query->queries_to_server),
                         &(server->queries_to_server));
}

/*
 * setsocknonblock sets the given socket to either blocking or non-blocking
 * mode based on the 'nonblock' boolean argument. This function is highly
 * portable.
 */
static int setsocknonblock(ares_socket_t sockfd,    /* operate on this */
                    int nonblock   /* TRUE or FALSE */)
{
#if defined(USE_BLOCKING_SOCKETS)

  return 0; /* returns success */

#elif defined(HAVE_FCNTL_O_NONBLOCK)

  /* most recent unix versions */
  int flags;
  flags = fcntl(sockfd, F_GETFL, 0);
  if (FALSE != nonblock)
    return fcntl(sockfd, F_SETFL, flags | O_NONBLOCK);
  else
    return fcntl(sockfd, F_SETFL, flags & (~O_NONBLOCK));

#elif defined(HAVE_IOCTL_FIONBIO)

  /* older unix versions */
  int flags = nonblock ? 1 : 0;
  return ioctl(sockfd, FIONBIO, &flags);

#elif defined(HAVE_IOCTLSOCKET_FIONBIO)

#ifdef WATT32
  char flags = nonblock ? 1 : 0;
#else
  /* Windows */
  unsigned long flags = nonblock ? 1UL : 0UL;
#endif
  return ioctlsocket(sockfd, FIONBIO, &flags);

#elif defined(HAVE_IOCTLSOCKET_CAMEL_FIONBIO)

  /* Amiga */
  long flags = nonblock ? 1L : 0L;
  return IoctlSocket(sockfd, FIONBIO, flags);

#elif defined(HAVE_SETSOCKOPT_SO_NONBLOCK)

  /* BeOS */
  long b = nonblock ? 1L : 0L;
  return setsockopt(sockfd, SOL_SOCKET, SO_NONBLOCK, &b, sizeof(b));

#else
#  error "no non-blocking method was found/used/set"
#endif
}

static int configure_socket(ares_socket_t s, int family, ares_channel channel)
{
  union {
    struct sockaddr     sa;
    struct sockaddr_in  sa4;
    struct sockaddr_in6 sa6;
  } local;

  setsocknonblock(s, TRUE);

#if defined(FD_CLOEXEC) && !defined(MSDOS)
  /* Configure the socket fd as close-on-exec. */
  if (fcntl(s, F_SETFD, FD_CLOEXEC) == -1)
    return -1;
#endif

  /* Set the socket's send and receive buffer sizes. */
  if ((channel->socket_send_buffer_size > 0) &&
      setsockopt(s, SOL_SOCKET, SO_SNDBUF,
                 (void *)&channel->socket_send_buffer_size,
                 sizeof(channel->socket_send_buffer_size)) == -1)
    return -1;

  if ((channel->socket_receive_buffer_size > 0) &&
      setsockopt(s, SOL_SOCKET, SO_RCVBUF,
                 (void *)&channel->socket_receive_buffer_size,
                 sizeof(channel->socket_receive_buffer_size)) == -1)
    return -1;

#ifdef SO_BINDTODEVICE
  if (channel->local_dev_name[0]) {
    if (setsockopt(s, SOL_SOCKET, SO_BINDTODEVICE,
                   channel->local_dev_name, sizeof(channel->local_dev_name))) {
      /* Only root can do this, and usually not fatal if it doesn't work, so */
      /* just continue on. */
    }
  }
#endif

  if (family == AF_INET) {
    if (channel->local_ip4) {
      memset(&local.sa4, 0, sizeof(local.sa4));
      local.sa4.sin_family = AF_INET;
      local.sa4.sin_addr.s_addr = htonl(channel->local_ip4);
      if (bind(s, &local.sa, sizeof(local.sa4)) < 0)
        return -1;
    }
  }
  else if (family == AF_INET6) {
    if (memcmp(channel->local_ip6, &ares_in6addr_any,
               sizeof(channel->local_ip6)) != 0) {
      memset(&local.sa6, 0, sizeof(local.sa6));
      local.sa6.sin6_family = AF_INET6;
      memcpy(&local.sa6.sin6_addr, channel->local_ip6,
             sizeof(channel->local_ip6));
      if (bind(s, &local.sa, sizeof(local.sa6)) < 0)
        return -1;
    }
  }

  return 0;
}

static int open_tcp_socket(ares_channel channel, struct server_state *server)
{
  ares_socket_t s;
  int opt;
  ares_socklen_t salen;
  union {
    struct sockaddr_in  sa4;
    struct sockaddr_in6 sa6;
  } saddr;
  struct sockaddr *sa;

  switch (server->addr.family)
    {
      case AF_INET:
        sa = (void *)&saddr.sa4;
        salen = sizeof(saddr.sa4);
        memset(sa, 0, salen);
        saddr.sa4.sin_family = AF_INET;
        saddr.sa4.sin_port = aresx_sitous(channel->tcp_port);
        memcpy(&saddr.sa4.sin_addr, &server->addr.addrV4,
               sizeof(server->addr.addrV4));
        break;
      case AF_INET6:
        sa = (void *)&saddr.sa6;
        salen = sizeof(saddr.sa6);
        memset(sa, 0, salen);
        saddr.sa6.sin6_family = AF_INET6;
        saddr.sa6.sin6_port = aresx_sitous(channel->tcp_port);
        memcpy(&saddr.sa6.sin6_addr, &server->addr.addrV6,
               sizeof(server->addr.addrV6));
        break;
      default:
        return -1;
    }

  /* Acquire a socket. */
  s = socket(server->addr.family, SOCK_STREAM, 0);
  if (s == ARES_SOCKET_BAD)
    return -1;

  /* Configure it. */
  if (configure_socket(s, server->addr.family, channel) < 0)
    {
       sclose(s);
       return -1;
    }

#ifdef TCP_NODELAY
  /*
   * Disable the Nagle algorithm (only relevant for TCP sockets, and thus not
   * in configure_socket). In general, in DNS lookups we're pretty much
   * interested in firing off a single request and then waiting for a reply,
   * so batching isn't very interesting.
   */
  opt = 1;
  if (setsockopt(s, IPPROTO_TCP, TCP_NODELAY,
                 (void *)&opt, sizeof(opt)) == -1)
    {
       sclose(s);
       return -1;
    }
#endif

  /* Connect to the server. */
  if (connect(s, sa, salen) == -1)
    {
      int err = SOCKERRNO;

      if (err != EINPROGRESS && err != EWOULDBLOCK)
        {
          sclose(s);
          return -1;
        }
    }

  if (channel->sock_create_cb)
    {
      int err = channel->sock_create_cb(s, SOCK_STREAM,
                                        channel->sock_create_cb_data);
      if (err < 0)
        {
          sclose(s);
          return err;
        }
    }

  SOCK_STATE_CALLBACK(channel, s, 1, 0);
  server->tcp_buffer_pos = 0;
  server->tcp_socket = s;
  server->tcp_connection_generation = ++channel->tcp_connection_generation;
  return 0;
}

static int open_udp_socket(ares_channel channel, struct server_state *server)
{
  ares_socket_t s;
  ares_socklen_t salen;
  union {
    struct sockaddr_in  sa4;
    struct sockaddr_in6 sa6;
  } saddr;
  struct sockaddr *sa;

  switch (server->addr.family)
    {
      case AF_INET:
        sa = (void *)&saddr.sa4;
        salen = sizeof(saddr.sa4);
        memset(sa, 0, salen);
        saddr.sa4.sin_family = AF_INET;
        saddr.sa4.sin_port = aresx_sitous(channel->udp_port);
        memcpy(&saddr.sa4.sin_addr, &server->addr.addrV4,
               sizeof(server->addr.addrV4));
        break;
      case AF_INET6:
        sa = (void *)&saddr.sa6;
        salen = sizeof(saddr.sa6);
        memset(sa, 0, salen);
        saddr.sa6.sin6_family = AF_INET6;
        saddr.sa6.sin6_port = aresx_sitous(channel->udp_port);
        memcpy(&saddr.sa6.sin6_addr, &server->addr.addrV6,
               sizeof(server->addr.addrV6));
        break;
      default:
        return -1;
    }

  /* Acquire a socket. */
  s = socket(server->addr.family, SOCK_DGRAM, 0);
  if (s == ARES_SOCKET_BAD)
    return -1;

  /* Set the socket non-blocking. */
  if (configure_socket(s, server->addr.family, channel) < 0)
    {
       sclose(s);
       return -1;
    }

  /* Connect to the server. */
  if (connect(s, sa, salen) == -1)
    {
      int err = SOCKERRNO;

      if (err != EINPROGRESS && err != EWOULDBLOCK)
        {
          sclose(s);
          return -1;
        }
    }

  if (channel->sock_create_cb)
    {
      int err = channel->sock_create_cb(s, SOCK_DGRAM,
                                        channel->sock_create_cb_data);
      if (err < 0)
        {
          sclose(s);
          return err;
        }
    }

  SOCK_STATE_CALLBACK(channel, s, 1, 0);

  server->udp_socket = s;
  return 0;
}

static int same_questions(const unsigned char *qbuf, int qlen,
                          const unsigned char *abuf, int alen)
{
  struct {
    const unsigned char *p;
    int qdcount;
    char *name;
    long namelen;
    int type;
    int dnsclass;
  } q, a;
  int i, j;

  if (qlen < HFIXEDSZ || alen < HFIXEDSZ)
    return 0;

  /* Extract qdcount from the request and reply buffers and compare them. */
  q.qdcount = DNS_HEADER_QDCOUNT(qbuf);
  a.qdcount = DNS_HEADER_QDCOUNT(abuf);
  if (q.qdcount != a.qdcount)
    return 0;

  /* For each question in qbuf, find it in abuf. */
  q.p = qbuf + HFIXEDSZ;
  for (i = 0; i < q.qdcount; i++)
    {
      /* Decode the question in the query. */
      if (ares_expand_name(q.p, qbuf, qlen, &q.name, &q.namelen)
          != ARES_SUCCESS)
        return 0;
      q.p += q.namelen;
      if (q.p + QFIXEDSZ > qbuf + qlen)
        {
          free(q.name);
          return 0;
        }
      q.type = DNS_QUESTION_TYPE(q.p);
      q.dnsclass = DNS_QUESTION_CLASS(q.p);
      q.p += QFIXEDSZ;

      /* Search for this question in the answer. */
      a.p = abuf + HFIXEDSZ;
      for (j = 0; j < a.qdcount; j++)
        {
          /* Decode the question in the answer. */
          if (ares_expand_name(a.p, abuf, alen, &a.name, &a.namelen)
              != ARES_SUCCESS)
            {
              free(q.name);
              return 0;
            }
          a.p += a.namelen;
          if (a.p + QFIXEDSZ > abuf + alen)
            {
              free(q.name);
              free(a.name);
              return 0;
            }
          a.type = DNS_QUESTION_TYPE(a.p);
          a.dnsclass = DNS_QUESTION_CLASS(a.p);
          a.p += QFIXEDSZ;

          /* Compare the decoded questions. */
          if (strcasecmp(q.name, a.name) == 0 && q.type == a.type
              && q.dnsclass == a.dnsclass)
            {
              free(a.name);
              break;
            }
          free(a.name);
        }

      free(q.name);
      if (j == a.qdcount)
        return 0;
    }
  return 1;
}

static int same_address(struct sockaddr *sa, struct ares_addr *aa)
{
  void *addr1;
  void *addr2;

  if (sa->sa_family == aa->family)
    {
      switch (aa->family)
        {
          case AF_INET:
            addr1 = &aa->addrV4;
            addr2 = &((struct sockaddr_in *)sa)->sin_addr;
            if (memcmp(addr1, addr2, sizeof(aa->addrV4)) == 0)
              return 1; /* match */
            break;
          case AF_INET6:
            addr1 = &aa->addrV6;
            addr2 = &((struct sockaddr_in6 *)sa)->sin6_addr;
            if (memcmp(addr1, addr2, sizeof(aa->addrV6)) == 0)
              return 1; /* match */
            break;
          default:
            break;
        }
    }
  return 0; /* different */
}

static void end_query (ares_channel channel, struct query *query, int status,
                       unsigned char *abuf, int alen)
{
  int i;

  /* First we check to see if this query ended while one of our send
   * queues still has pointers to it.
   */
  for (i = 0; i < channel->nservers; i++)
    {
      struct server_state *server = &channel->servers[i];
      struct send_request *sendreq;
      for (sendreq = server->qhead; sendreq; sendreq = sendreq->next)
        if (sendreq->owner_query == query)
          {
            sendreq->owner_query = NULL;
            assert(sendreq->data_storage == NULL);
            if (status == ARES_SUCCESS)
              {
                /* We got a reply for this query, but this queued sendreq
                 * points into this soon-to-be-gone query's tcpbuf. Probably
                 * this means we timed out and queued the query for
                 * retransmission, then received a response before actually
                 * retransmitting. This is perfectly fine, so we want to keep
                 * the connection running smoothly if we can. But in the worst
                 * case we may have sent only some prefix of the query, with
                 * some suffix of the query left to send. Also, the buffer may
                 * be queued on multiple queues. To prevent dangling pointers
                 * to the query's tcpbuf and handle these cases, we just give
                 * such sendreqs their own copy of the query packet.
                 */
               sendreq->data_storage = malloc(sendreq->len);
               if (sendreq->data_storage != NULL)
                 {
                   memcpy(sendreq->data_storage, sendreq->data, sendreq->len);
                   sendreq->data = sendreq->data_storage;
                 }
              }
            if ((status != ARES_SUCCESS) || (sendreq->data_storage == NULL))
              {
                /* We encountered an error (probably a timeout, suggesting the
                 * DNS server we're talking to is probably unreachable,
                 * wedged, or severely overloaded) or we couldn't copy the
                 * request, so mark the connection as broken. When we get to
                 * process_broken_connections() we'll close the connection and
                 * try to re-send requests to another server.
                 */
               server->is_broken = 1;
               /* Just to be paranoid, zero out this sendreq... */
               sendreq->data = NULL;
               sendreq->len = 0;
             }
          }
    }

  /* Invoke the callback */
  query->callback(query->arg, status, query->timeouts, abuf, alen);
  ares__free_query(query);

  /* Simple cleanup policy: if no queries are remaining, close all network
   * sockets unless STAYOPEN is set.
   */
  if (!(channel->flags & ARES_FLAG_STAYOPEN) &&
      ares__is_list_empty(&(channel->all_queries)))
    {
      for (i = 0; i < channel->nservers; i++)
        ares__close_sockets(channel, &channel->servers[i]);
    }
}

void ares__free_query(struct query *query)
{
  /* Remove the query from all the lists in which it is linked */
  ares__remove_from_list(&(query->queries_by_qid));
  ares__remove_from_list(&(query->queries_by_timeout));
  ares__remove_from_list(&(query->queries_to_server));
  ares__remove_from_list(&(query->all_queries));
  /* Zero out some important stuff, to help catch bugs */
  query->callback = NULL;
  query->arg = NULL;
  /* Deallocate the memory associated with the query */
  free(query->tcpbuf);
  free(query->server_info);
  free(query);
}
node-v4.8.2/deps/cares/src/ares_query.c000644 000766 000024 00000011660 13070706730 020121 0ustar00iojsstaff000000 000000 
/* Copyright 1998 by the Massachusetts Institute of Technology.
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"

#ifdef HAVE_NETINET_IN_H
#  include 
#endif
#ifdef HAVE_ARPA_NAMESER_H
#  include 
#else
#  include "nameser.h"
#endif
#ifdef HAVE_ARPA_NAMESER_COMPAT_H
#  include 
#endif

#include "ares.h"
#include "ares_dns.h"
#include "ares_private.h"

struct qquery {
  ares_callback callback;
  void *arg;
};

static void qcallback(void *arg, int status, int timeouts, unsigned char *abuf, int alen);

static void rc4(rc4_key* key, unsigned char *buffer_ptr, int buffer_len)
{
  unsigned char x;
  unsigned char y;
  unsigned char* state;
  unsigned char xorIndex;
  short counter;

  x = key->x;
  y = key->y;

  state = &key->state[0];
  for(counter = 0; counter < buffer_len; counter ++)
  {
    x = (unsigned char)((x + 1) % 256);
    y = (unsigned char)((state[x] + y) % 256);
    ARES_SWAP_BYTE(&state[x], &state[y]);

    xorIndex = (unsigned char)((state[x] + state[y]) % 256);

    buffer_ptr[counter] = (unsigned char)(buffer_ptr[counter]^state[xorIndex]);
  }
  key->x = x;
  key->y = y;
}

static struct query* find_query_by_id(ares_channel channel, unsigned short id)
{
  unsigned short qid;
  struct list_node* list_head;
  struct list_node* list_node;
  DNS_HEADER_SET_QID(((unsigned char*)&qid), id);

  /* Find the query corresponding to this packet. */
  list_head = &(channel->queries_by_qid[qid % ARES_QID_TABLE_SIZE]);
  for (list_node = list_head->next; list_node != list_head;
       list_node = list_node->next)
    {
       struct query *q = list_node->data;
       if (q->qid == qid)
	  return q;
    }
  return NULL;
}


/* a unique query id is generated using an rc4 key. Since the id may already
   be used by a running query (as infrequent as it may be), a lookup is
   performed per id generation. In practice this search should happen only
   once per newly generated id
*/
static unsigned short generate_unique_id(ares_channel channel)
{
  unsigned short id;

  do {
    id = ares__generate_new_id(&channel->id_key);
  } while (find_query_by_id(channel, id));

  return (unsigned short)id;
}

unsigned short ares__generate_new_id(rc4_key* key)
{
  unsigned short r=0;
  rc4(key, (unsigned char *)&r, sizeof(r));
  return r;
}

void ares_query(ares_channel channel, const char *name, int dnsclass,
                int type, ares_callback callback, void *arg)
{
  struct qquery *qquery;
  unsigned char *qbuf;
  int qlen, rd, status;

  /* Compose the query. */
  rd = !(channel->flags & ARES_FLAG_NORECURSE);
  status = ares_create_query(name, dnsclass, type, channel->next_id, rd, &qbuf,
              &qlen, (channel->flags & ARES_FLAG_EDNS) ? channel->ednspsz : 0);
  if (status != ARES_SUCCESS)
    {
      if (qbuf != NULL) free(qbuf);
      callback(arg, status, 0, NULL, 0);
      return;
    }

  channel->next_id = generate_unique_id(channel);

  /* Allocate and fill in the query structure. */
  qquery = malloc(sizeof(struct qquery));
  if (!qquery)
    {
      ares_free_string(qbuf);
      callback(arg, ARES_ENOMEM, 0, NULL, 0);
      return;
    }
  qquery->callback = callback;
  qquery->arg = arg;

  /* Send it off.  qcallback will be called when we get an answer. */
  ares_send(channel, qbuf, qlen, qcallback, qquery);
  ares_free_string(qbuf);
}

static void qcallback(void *arg, int status, int timeouts, unsigned char *abuf, int alen)
{
  struct qquery *qquery = (struct qquery *) arg;
  unsigned int ancount;
  int rcode;

  if (status != ARES_SUCCESS)
    qquery->callback(qquery->arg, status, timeouts, abuf, alen);
  else
    {
      /* Pull the response code and answer count from the packet. */
      rcode = DNS_HEADER_RCODE(abuf);
      ancount = DNS_HEADER_ANCOUNT(abuf);

      /* Convert errors. */
      switch (rcode)
        {
        case NOERROR:
          status = (ancount > 0) ? ARES_SUCCESS : ARES_ENODATA;
          break;
        case FORMERR:
          status = ARES_EFORMERR;
          break;
        case SERVFAIL:
          status = ARES_ESERVFAIL;
          break;
        case NXDOMAIN:
          status = ARES_ENOTFOUND;
          break;
        case NOTIMP:
          status = ARES_ENOTIMP;
          break;
        case REFUSED:
          status = ARES_EREFUSED;
          break;
        }
      qquery->callback(qquery->arg, status, timeouts, abuf, alen);
    }
  free(qquery);
}
node-v4.8.2/deps/cares/src/ares_rules.h000644 000766 000024 00000010534 13070706730 020112 0ustar00iojsstaff000000 000000 #ifndef __CARES_RULES_H
#define __CARES_RULES_H


/* Copyright (C) 2009 by Daniel Stenberg et al
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation for any purpose and without fee is hereby granted, provided
 * that the above copyright notice appear in all copies and that both that
 * copyright notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in advertising or
 * publicity pertaining to distribution of the software without specific,
 * written prior permission.  M.I.T. makes no representations about the
 * suitability of this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

/* ================================================================ */
/*                    COMPILE TIME SANITY CHECKS                    */
/* ================================================================ */

/*
 * NOTE 1:
 * -------
 *
 * All checks done in this file are intentionally placed in a public
 * header file which is pulled by ares.h when an application is
 * being built using an already built c-ares library. Additionally
 * this file is also included and used when building the library.
 *
 * If compilation fails on this file it is certainly sure that the
 * problem is elsewhere. It could be a problem in the ares_build.h
 * header file, or simply that you are using different compilation
 * settings than those used to build the library.
 *
 * Nothing in this file is intended to be modified or adjusted by the
 * c-ares library user nor by the c-ares library builder.
 *
 * Do not deactivate any check, these are done to make sure that the
 * library is properly built and used.
 *
 * You can find further help on the c-ares development mailing list:
 * http://cool.haxx.se/mailman/listinfo/c-ares/
 *
 * NOTE 2
 * ------
 *
 * Some of the following compile time checks are based on the fact
 * that the dimension of a constant array can not be a negative one.
 * In this way if the compile time verification fails, the compilation
 * will fail issuing an error. The error description wording is compiler
 * dependent but it will be quite similar to one of the following:
 *
 *   "negative subscript or subscript is too large"
 *   "array must have at least one element"
 *   "-1 is an illegal array size"
 *   "size of array is negative"
 *
 * If you are building an application which tries to use an already
 * built c-ares library and you are getting this kind of errors on
 * this file, it is a clear indication that there is a mismatch between
 * how the library was built and how you are trying to use it for your
 * application. Your already compiled or binary library provider is the
 * only one who can give you the details you need to properly use it.
 */

/*
 * Verify that some macros are actually defined.
 */

#ifndef CARES_TYPEOF_ARES_SOCKLEN_T
#  error "CARES_TYPEOF_ARES_SOCKLEN_T definition is missing!"
   Error Compilation_aborted_CARES_TYPEOF_ARES_SOCKLEN_T_is_missing
#endif

#ifndef CARES_SIZEOF_ARES_SOCKLEN_T
#  error "CARES_SIZEOF_ARES_SOCKLEN_T definition is missing!"
   Error Compilation_aborted_CARES_SIZEOF_ARES_SOCKLEN_T_is_missing
#endif

/*
 * Macros private to this header file.
 */

#define CareschkszEQ(t, s) sizeof(t) == s ? 1 : -1

#define CareschkszGE(t1, t2) sizeof(t1) >= sizeof(t2) ? 1 : -1

/*
 * Verify that the size previously defined and expected for
 * ares_socklen_t is actually the the same as the one reported
 * by sizeof() at compile time.
 */

typedef char
  __cares_rule_02__
    [CareschkszEQ(ares_socklen_t, CARES_SIZEOF_ARES_SOCKLEN_T)];

/*
 * Verify at compile time that the size of ares_socklen_t as reported
 * by sizeof() is greater or equal than the one reported for int for
 * the current compilation.
 */

typedef char
  __cares_rule_03__
    [CareschkszGE(ares_socklen_t, int)];

/* ================================================================ */
/*          EXTERNALLY AND INTERNALLY VISIBLE DEFINITIONS           */
/* ================================================================ */

/*
 * Get rid of macros private to this header file.
 */

#undef CareschkszEQ
#undef CareschkszGE

/*
 * Get rid of macros not intended to exist beyond this point.
 */

#undef CARES_PULL_WS2TCPIP_H
#undef CARES_PULL_SYS_TYPES_H
#undef CARES_PULL_SYS_SOCKET_H

#undef CARES_TYPEOF_ARES_SOCKLEN_T

#endif /* __CARES_RULES_H */
node-v4.8.2/deps/cares/src/ares_search.c000644 000766 000024 00000022565 13070706730 020227 0ustar00iojsstaff000000 000000 
/* Copyright 1998 by the Massachusetts Institute of Technology.
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"

#ifdef HAVE_STRINGS_H
#  include 
#endif

#include "ares.h"
#include "ares_private.h"

struct search_query {
  /* Arguments passed to ares_search */
  ares_channel channel;
  char *name;                   /* copied into an allocated buffer */
  int dnsclass;
  int type;
  ares_callback callback;
  void *arg;

  int status_as_is;             /* error status from trying as-is */
  int next_domain;              /* next search domain to try */
  int trying_as_is;             /* current query is for name as-is */
  int timeouts;                 /* number of timeouts we saw for this request */
  int ever_got_nodata;          /* did we ever get ARES_ENODATA along the way? */
};

static void search_callback(void *arg, int status, int timeouts,
                            unsigned char *abuf, int alen);
static void end_squery(struct search_query *squery, int status,
                       unsigned char *abuf, int alen);
static int cat_domain(const char *name, const char *domain, char **s);
static int single_domain(ares_channel channel, const char *name, char **s);

void ares_search(ares_channel channel, const char *name, int dnsclass,
                 int type, ares_callback callback, void *arg)
{
  struct search_query *squery;
  char *s;
  const char *p;
  int status, ndots;

  /* If name only yields one domain to search, then we don't have
   * to keep extra state, so just do an ares_query().
   */
  status = single_domain(channel, name, &s);
  if (status != ARES_SUCCESS)
    {
      callback(arg, status, 0, NULL, 0);
      return;
    }
  if (s)
    {
      ares_query(channel, s, dnsclass, type, callback, arg);
      free(s);
      return;
    }

  /* Allocate a search_query structure to hold the state necessary for
   * doing multiple lookups.
   */
  squery = malloc(sizeof(struct search_query));
  if (!squery)
    {
      callback(arg, ARES_ENOMEM, 0, NULL, 0);
      return;
    }
  squery->channel = channel;
  squery->name = strdup(name);
  if (!squery->name)
    {
      free(squery);
      callback(arg, ARES_ENOMEM, 0, NULL, 0);
      return;
    }
  squery->dnsclass = dnsclass;
  squery->type = type;
  squery->status_as_is = -1;
  squery->callback = callback;
  squery->arg = arg;
  squery->timeouts = 0;
  squery->ever_got_nodata = 0;

  /* Count the number of dots in name. */
  ndots = 0;
  for (p = name; *p; p++)
    {
      if (*p == '.')
        ndots++;
    }

  /* If ndots is at least the channel ndots threshold (usually 1),
   * then we try the name as-is first.  Otherwise, we try the name
   * as-is last.
   */
  if (ndots >= channel->ndots)
    {
      /* Try the name as-is first. */
      squery->next_domain = 0;
      squery->trying_as_is = 1;
      ares_query(channel, name, dnsclass, type, search_callback, squery);
    }
  else
    {
      /* Try the name as-is last; start with the first search domain. */
      squery->next_domain = 1;
      squery->trying_as_is = 0;
      status = cat_domain(name, channel->domains[0], &s);
      if (status == ARES_SUCCESS)
        {
          ares_query(channel, s, dnsclass, type, search_callback, squery);
          free(s);
        }
      else
      {
        /* failed, free the malloc()ed memory */
        free(squery->name);
        free(squery);
        callback(arg, status, 0, NULL, 0);
      }
    }
}

static void search_callback(void *arg, int status, int timeouts,
                            unsigned char *abuf, int alen)
{
  struct search_query *squery = (struct search_query *) arg;
  ares_channel channel = squery->channel;
  char *s;

  squery->timeouts += timeouts;

  /* Stop searching unless we got a non-fatal error. */
  if (status != ARES_ENODATA && status != ARES_ESERVFAIL
      && status != ARES_ENOTFOUND)
    end_squery(squery, status, abuf, alen);
  else
    {
      /* Save the status if we were trying as-is. */
      if (squery->trying_as_is)
        squery->status_as_is = status;

      /*
       * If we ever get ARES_ENODATA along the way, record that; if the search
       * should run to the very end and we got at least one ARES_ENODATA,
       * then callers like ares_gethostbyname() may want to try a T_A search
       * even if the last domain we queried for T_AAAA resource records
       * returned ARES_ENOTFOUND.
       */
      if (status == ARES_ENODATA)
        squery->ever_got_nodata = 1;

      if (squery->next_domain < channel->ndomains)
        {
          /* Try the next domain. */
          status = cat_domain(squery->name,
                              channel->domains[squery->next_domain], &s);
          if (status != ARES_SUCCESS)
            end_squery(squery, status, NULL, 0);
          else
            {
              squery->trying_as_is = 0;
              squery->next_domain++;
              ares_query(channel, s, squery->dnsclass, squery->type,
                         search_callback, squery);
              free(s);
            }
        }
      else if (squery->status_as_is == -1)
        {
          /* Try the name as-is at the end. */
          squery->trying_as_is = 1;
          ares_query(channel, squery->name, squery->dnsclass, squery->type,
                     search_callback, squery);
        }
      else {
        if (squery->status_as_is == ARES_ENOTFOUND && squery->ever_got_nodata) {
          end_squery(squery, ARES_ENODATA, NULL, 0);
        }
        else
          end_squery(squery, squery->status_as_is, NULL, 0);
      }
    }
}

static void end_squery(struct search_query *squery, int status,
                       unsigned char *abuf, int alen)
{
  squery->callback(squery->arg, status, squery->timeouts, abuf, alen);
  free(squery->name);
  free(squery);
}

/* Concatenate two domains. */
static int cat_domain(const char *name, const char *domain, char **s)
{
  size_t nlen = strlen(name);
  size_t dlen = strlen(domain);

  *s = malloc(nlen + 1 + dlen + 1);
  if (!*s)
    return ARES_ENOMEM;
  memcpy(*s, name, nlen);
  (*s)[nlen] = '.';
  memcpy(*s + nlen + 1, domain, dlen);
  (*s)[nlen + 1 + dlen] = 0;
  return ARES_SUCCESS;
}

/* Determine if this name only yields one query.  If it does, set *s to
 * the string we should query, in an allocated buffer.  If not, set *s
 * to NULL.
 */
static int single_domain(ares_channel channel, const char *name, char **s)
{
  size_t len = strlen(name);
  const char *hostaliases;
  FILE *fp;
  char *line = NULL;
  int status;
  size_t linesize;
  const char *p, *q;
  int error;

  /* If the name contains a trailing dot, then the single query is the name
   * sans the trailing dot.
   */
  if ((len > 0) && (name[len - 1] == '.'))
    {
      *s = strdup(name);
      return (*s) ? ARES_SUCCESS : ARES_ENOMEM;
    }

  if (!(channel->flags & ARES_FLAG_NOALIASES) && !strchr(name, '.'))
    {
      /* The name might be a host alias. */
      hostaliases = getenv("HOSTALIASES");
      if (hostaliases)
        {
          fp = fopen(hostaliases, "r");
          if (fp)
            {
              while ((status = ares__read_line(fp, &line, &linesize))
                     == ARES_SUCCESS)
                {
                  if (strncasecmp(line, name, len) != 0 ||
                      !ISSPACE(line[len]))
                    continue;
                  p = line + len;
                  while (ISSPACE(*p))
                    p++;
                  if (*p)
                    {
                      q = p + 1;
                      while (*q && !ISSPACE(*q))
                        q++;
                      *s = malloc(q - p + 1);
                      if (*s)
                        {
                          memcpy(*s, p, q - p);
                          (*s)[q - p] = 0;
                        }
                      free(line);
                      fclose(fp);
                      return (*s) ? ARES_SUCCESS : ARES_ENOMEM;
                    }
                }
              free(line);
              fclose(fp);
              if (status != ARES_SUCCESS && status != ARES_EOF)
                return status;
            }
          else
            {
              error = ERRNO;
              switch(error)
                {
                case ENOENT:
                case ESRCH:
                  break;
                default:
                  DEBUGF(fprintf(stderr, "fopen() failed with error: %d %s\n",
                                 error, strerror(error)));
                  DEBUGF(fprintf(stderr, "Error opening file: %s\n",
                                 hostaliases));
                  *s = NULL;
                  return ARES_EFILE;
                }
            }
        }
    }

  if (channel->flags & ARES_FLAG_NOSEARCH || channel->ndomains == 0)
    {
      /* No domain search to do; just try the name as-is. */
      *s = strdup(name);
      return (*s) ? ARES_SUCCESS : ARES_ENOMEM;
    }

  *s = NULL;
  return ARES_SUCCESS;
}
node-v4.8.2/deps/cares/src/ares_send.c000644 000766 000024 00000007644 13070706730 017714 0ustar00iojsstaff000000 000000 
/* Copyright 1998 by the Massachusetts Institute of Technology.
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"

#ifdef HAVE_NETINET_IN_H
#  include 
#endif
#ifdef HAVE_ARPA_NAMESER_H
#  include 
#else
#  include "nameser.h"
#endif
#ifdef HAVE_ARPA_NAMESER_COMPAT_H
#  include 
#endif

#include "ares.h"
#include "ares_dns.h"
#include "ares_private.h"

void ares_send(ares_channel channel, const unsigned char *qbuf, int qlen,
               ares_callback callback, void *arg)
{
  struct query *query;
  int i, packetsz;
  struct timeval now;

  /* Verify that the query is at least long enough to hold the header. */
  if (qlen < HFIXEDSZ || qlen >= (1 << 16))
    {
      callback(arg, ARES_EBADQUERY, 0, NULL, 0);
      return;
    }

  /* Allocate space for query and allocated fields. */
  query = malloc(sizeof(struct query));
  if (!query)
    {
      callback(arg, ARES_ENOMEM, 0, NULL, 0);
      return;
    }
  query->tcpbuf = malloc(qlen + 2);
  if (!query->tcpbuf)
    {
      free(query);
      callback(arg, ARES_ENOMEM, 0, NULL, 0);
      return;
    }
  query->server_info = malloc(channel->nservers *
                              sizeof(query->server_info[0]));
  if (!query->server_info)
    {
      free(query->tcpbuf);
      free(query);
      callback(arg, ARES_ENOMEM, 0, NULL, 0);
      return;
    }

  /* Compute the query ID.  Start with no timeout. */
  query->qid = DNS_HEADER_QID(qbuf);
  query->timeout.tv_sec = 0;
  query->timeout.tv_usec = 0;

  /* Form the TCP query buffer by prepending qlen (as two
   * network-order bytes) to qbuf.
   */
  query->tcpbuf[0] = (unsigned char)((qlen >> 8) & 0xff);
  query->tcpbuf[1] = (unsigned char)(qlen & 0xff);
  memcpy(query->tcpbuf + 2, qbuf, qlen);
  query->tcplen = qlen + 2;

  /* Fill in query arguments. */
  query->qbuf = query->tcpbuf + 2;
  query->qlen = qlen;
  query->callback = callback;
  query->arg = arg;

  /* Initialize query status. */
  query->try_count = 0;

  /* Choose the server to send the query to. If rotation is enabled, keep track
   * of the next server we want to use. */
  query->server = channel->last_server;
  if (channel->rotate == 1)
    channel->last_server = (channel->last_server + 1) % channel->nservers;

  for (i = 0; i < channel->nservers; i++)
    {
      query->server_info[i].skip_server = 0;
      query->server_info[i].tcp_connection_generation = 0;
    }

  packetsz = (channel->flags & ARES_FLAG_EDNS) ? channel->ednspsz : PACKETSZ;
  query->using_tcp = (channel->flags & ARES_FLAG_USEVC) || qlen > packetsz;

  query->error_status = ARES_ECONNREFUSED;
  query->timeouts = 0;

  /* Initialize our list nodes. */
  ares__init_list_node(&(query->queries_by_qid),     query);
  ares__init_list_node(&(query->queries_by_timeout), query);
  ares__init_list_node(&(query->queries_to_server),  query);
  ares__init_list_node(&(query->all_queries),        query);

  /* Chain the query into the list of all queries. */
  ares__insert_in_list(&(query->all_queries), &(channel->all_queries));
  /* Keep track of queries bucketed by qid, so we can process DNS
   * responses quickly.
   */
  ares__insert_in_list(
    &(query->queries_by_qid),
    &(channel->queries_by_qid[query->qid % ARES_QID_TABLE_SIZE]));

  /* Perform the first query action. */
  now = ares__tvnow();
  ares__send_query(channel, query, &now);
}
node-v4.8.2/deps/cares/src/ares_setup.h000644 000766 000024 00000013567 13070706730 020131 0ustar00iojsstaff000000 000000 #ifndef HEADER_CARES_SETUP_H
#define HEADER_CARES_SETUP_H


/* Copyright (C) 2004 - 2012 by Daniel Stenberg et al
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation for any purpose and without fee is hereby granted, provided
 * that the above copyright notice appear in all copies and that both that
 * copyright notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in advertising or
 * publicity pertaining to distribution of the software without specific,
 * written prior permission.  M.I.T. makes no representations about the
 * suitability of this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

/*
 * Define WIN32 when build target is Win32 API
 */

#if (defined(_WIN32) || defined(__WIN32__)) && !defined(WIN32)
#define WIN32
#endif

/*
 * Include configuration script results or hand-crafted
 * configuration file for platforms which lack config tool.
 */

#ifdef HAVE_CONFIG_H
#include "ares_config.h"
#else

#ifdef WIN32
#include "config-win32.h"
#endif

#endif /* HAVE_CONFIG_H */

/* ================================================================ */
/* Definition of preprocessor macros/symbols which modify compiler  */
/* behaviour or generated code characteristics must be done here,   */
/* as appropriate, before any system header file is included. It is */
/* also possible to have them defined in the config file included   */
/* before this point. As a result of all this we frown inclusion of */
/* system header files in our config files, avoid this at any cost. */
/* ================================================================ */

/*
 * AIX 4.3 and newer needs _THREAD_SAFE defined to build
 * proper reentrant code. Others may also need it.
 */

#ifdef NEED_THREAD_SAFE
#  ifndef _THREAD_SAFE
#    define _THREAD_SAFE
#  endif
#endif

/*
 * Tru64 needs _REENTRANT set for a few function prototypes and
 * things to appear in the system header files. Unixware needs it
 * to build proper reentrant code. Others may also need it.
 */

#ifdef NEED_REENTRANT
#  ifndef _REENTRANT
#    define _REENTRANT
#  endif
#endif

/* ================================================================ */
/*  If you need to include a system header file for your platform,  */
/*  please, do it beyond the point further indicated in this file.  */
/* ================================================================ */

#if 1
# define SIZEOF_SHORT 2
#else  /* Disabled for the gyp-ified build. */
/*
 * c-ares external interface definitions are also used internally,
 * and might also include required system header files to define them.
 */

#include 

/*
 * Compile time sanity checks must also be done when building the library.
 */

#include 
#endif

/* ================================================================= */
/* No system header file shall be included in this file before this  */
/* point. The only allowed ones are those included from ares_build.h */
/* ================================================================= */

/*
 * Include header files for windows builds before redefining anything.
 * Use this preproessor block only to include or exclude windows.h,
 * winsock2.h, ws2tcpip.h or winsock.h. Any other windows thing belongs
 * to any other further and independent block.  Under Cygwin things work
 * just as under linux (e.g. ) and the winsock headers should
 * never be included when __CYGWIN__ is defined.  configure script takes
 * care of this, not defining HAVE_WINDOWS_H, HAVE_WINSOCK_H, HAVE_WINSOCK2_H,
 * neither HAVE_WS2TCPIP_H when __CYGWIN__ is defined.
 */

#ifdef HAVE_WINDOWS_H
#  ifndef WIN32_LEAN_AND_MEAN
#    define WIN32_LEAN_AND_MEAN
#  endif
#  include 
#  ifdef HAVE_WINSOCK2_H
#    include 
#    ifdef HAVE_WS2TCPIP_H
#       include 
#    endif
#  else
#    ifdef HAVE_WINSOCK_H
#      include 
#    endif
#  endif
#endif

/*
 * Define USE_WINSOCK to 2 if we have and use WINSOCK2 API, else
 * define USE_WINSOCK to 1 if we have and use WINSOCK  API, else
 * undefine USE_WINSOCK.
 */

#undef USE_WINSOCK

#ifdef HAVE_WINSOCK2_H
#  define USE_WINSOCK 2
#else
#  ifdef HAVE_WINSOCK_H
#    define USE_WINSOCK 1
#  endif
#endif

/*
 * Work-arounds for systems without configure support
 */

#ifndef HAVE_CONFIG_H

#if !defined(HAVE_SYS_TIME_H) && !defined(_MSC_VER) && !defined(__WATCOMC__)
#define HAVE_SYS_TIME_H
#endif

#if !defined(HAVE_UNISTD_H) && !defined(_MSC_VER)
#define HAVE_UNISTD_H 1
#endif

#if !defined(HAVE_SYS_UIO_H) && !defined(WIN32) && !defined(MSDOS)
#define HAVE_SYS_UIO_H
#endif

#endif /* HAVE_CONFIG_H */

/*
 * Arg 2 type for gethostname in case it hasn't been defined in config file.
 */

#ifndef GETHOSTNAME_TYPE_ARG2
#  ifdef USE_WINSOCK
#    define GETHOSTNAME_TYPE_ARG2 int
#  else
#    define GETHOSTNAME_TYPE_ARG2 size_t
#  endif
#endif

#ifdef __POCC__
#  include 
#  include 
#  define ESRCH 3
#endif

/*
 * Android does have the arpa/nameser.h header which is detected by configure
 * but it appears to be empty with recent NDK r7b / r7c, so we undefine here.
 */
#if (defined(ANDROID) || defined(__ANDROID__)) && defined(HAVE_ARPA_NAMESER_H)
#  undef HAVE_ARPA_NAMESER_H
#endif

/*
 * Recent autoconf versions define these symbols in ares_config.h. We don't
 * want them (since they collide with the libcurl ones when we build
 *  --enable-debug) so we undef them again here.
 */

#undef PACKAGE_STRING
#undef PACKAGE_TARNAME
#undef PACKAGE_VERSION
#undef PACKAGE_BUGREPORT
#undef PACKAGE_NAME
#undef VERSION
#undef PACKAGE

/* IPv6 compatibility */
#if !defined(HAVE_AF_INET6)
#if defined(HAVE_PF_INET6)
#define AF_INET6 PF_INET6
#else
#define AF_INET6 AF_MAX+1
#endif
#endif

/*
 * Include macros and defines that should only be processed once.
 */

#ifndef __SETUP_ONCE_H
#include "setup_once.h"
#endif

#endif /* HEADER_CARES_SETUP_H */
node-v4.8.2/deps/cares/src/ares_strcasecmp.c000644 000766 000024 00000003150 13070706730 021113 0ustar00iojsstaff000000 000000 

/* Copyright 1998 by the Massachusetts Institute of Technology.
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"
#include "ares_strcasecmp.h"

#ifndef HAVE_STRCASECMP
int ares_strcasecmp(const char *a, const char *b)
{
#if defined(HAVE_STRCMPI)
  return strcmpi(a, b);
#elif defined(HAVE_STRICMP)
  return stricmp(a, b);
#else
  size_t i;

  for (i = 0; i < (size_t)-1; i++) {
    int c1 = ISUPPER(a[i]) ? tolower(a[i]) : a[i];
    int c2 = ISUPPER(b[i]) ? tolower(b[i]) : b[i];
    if (c1 != c2)
      return c1-c2;
    if (!c1)
      break;
  }
  return 0;
#endif
}
#endif

#ifndef HAVE_STRNCASECMP
int ares_strncasecmp(const char *a, const char *b, size_t n)
{
#if defined(HAVE_STRNCMPI)
  return strncmpi(a, b, n);
#elif defined(HAVE_STRNICMP)
  return strnicmp(a, b, n);
#else
  size_t i;

  for (i = 0; i < n; i++) {
    int c1 = ISUPPER(a[i]) ? tolower(a[i]) : a[i];
    int c2 = ISUPPER(b[i]) ? tolower(b[i]) : b[i];
    if (c1 != c2)
      return c1-c2;
    if (!c1)
      break;
  }
  return 0;
#endif
}
#endif

node-v4.8.2/deps/cares/src/ares_strcasecmp.h000644 000766 000024 00000002007 13070706730 021120 0ustar00iojsstaff000000 000000 #ifndef HEADER_CARES_STRCASECMP_H
#define HEADER_CARES_STRCASECMP_H


/* Copyright 1998 by the Massachusetts Institute of Technology.
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"

#ifndef HAVE_STRCASECMP
extern int ares_strcasecmp(const char *a, const char *b);
#endif

#ifndef HAVE_STRNCASECMP
extern int ares_strncasecmp(const char *a, const char *b, size_t n);
#endif

#endif /* HEADER_CARES_STRCASECMP_H */
node-v4.8.2/deps/cares/src/ares_strdup.c000644 000766 000024 00000002162 13070706730 020272 0ustar00iojsstaff000000 000000 

/* Copyright 1998 by the Massachusetts Institute of Technology.
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"
#include "ares_strdup.h"

#ifndef HAVE_STRDUP
char *ares_strdup(const char *s1)
{
  size_t sz;
  char * s2;

  if(s1) {
    sz = strlen(s1);
    if(sz < (size_t)-1) {
      sz++;
      if(sz < ((size_t)-1) / sizeof(char)) {
        s2 = malloc(sz * sizeof(char));
        if(s2) {
          memcpy(s2, s1, sz * sizeof(char));
          return s2;
        }
      }
    }
  }
  return (char *)NULL;
}
#endif
node-v4.8.2/deps/cares/src/ares_strdup.h000644 000766 000024 00000001601 13070706730 020274 0ustar00iojsstaff000000 000000 #ifndef HEADER_CARES_STRDUP_H
#define HEADER_CARES_STRDUP_H


/* Copyright 1998 by the Massachusetts Institute of Technology.
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"

#ifndef HAVE_STRDUP
extern char *ares_strdup(const char *s1);
#endif

#endif /* HEADER_CARES_STRDUP_H */
node-v4.8.2/deps/cares/src/ares_strerror.c000644 000766 000024 00000003553 13070706730 020640 0ustar00iojsstaff000000 000000 
/* Copyright 1998 by the Massachusetts Institute of Technology.
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"
#include 
#include "ares.h"

const char *ares_strerror(int code)
{
  /* Return a string literal from a table. */
  const char *errtext[] = {
    "Successful completion",
    "DNS server returned answer with no data",
    "DNS server claims query was misformatted",
    "DNS server returned general failure",
    "Domain name not found",
    "DNS server does not implement requested operation",
    "DNS server refused query",
    "Misformatted DNS query",
    "Misformatted domain name",
    "Unsupported address family",
    "Misformatted DNS reply",
    "Could not contact DNS servers",
    "Timeout while contacting DNS servers",
    "End of file",
    "Error reading file",
    "Out of memory",
    "Channel is being destroyed",
    "Misformatted string",
    "Illegal flags specified",
    "Given hostname is not numeric",
    "Illegal hints flags specified",
    "c-ares library initialization not yet performed",
    "Error loading iphlpapi.dll",
    "Could not find GetNetworkParams function",
    "DNS query cancelled"
  };

  if(code >= 0 && code < (int)(sizeof(errtext) / sizeof(*errtext)))
    return errtext[code];
  else
    return "unknown";
}
node-v4.8.2/deps/cares/src/ares_timeout.c000644 000766 000024 00000005270 13070706730 020442 0ustar00iojsstaff000000 000000 
/* Copyright 1998 by the Massachusetts Institute of Technology.
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"

#ifdef HAVE_LIMITS_H
#include 
#endif

#include "ares.h"
#include "ares_private.h"

/* return time offset between now and (future) check, in milliseconds */
static long timeoffset(struct timeval *now, struct timeval *check)
{
  return (check->tv_sec - now->tv_sec)*1000 +
         (check->tv_usec - now->tv_usec)/1000;
}

/* WARNING: Beware that this is linear in the number of outstanding
 * requests! You are probably far better off just calling ares_process()
 * once per second, rather than calling ares_timeout() to figure out
 * when to next call ares_process().
 */
struct timeval *ares_timeout(ares_channel channel, struct timeval *maxtv,
                             struct timeval *tvbuf)
{
  struct query *query;
  struct list_node* list_head;
  struct list_node* list_node;
  struct timeval now;
  struct timeval nextstop;
  long offset, min_offset;

  /* No queries, no timeout (and no fetch of the current time). */
  if (ares__is_list_empty(&(channel->all_queries)))
    return maxtv;

  /* Find the minimum timeout for the current set of queries. */
  now = ares__tvnow();
  min_offset = -1;

  list_head = &(channel->all_queries);
  for (list_node = list_head->next; list_node != list_head;
       list_node = list_node->next)
    {
      query = list_node->data;
      if (query->timeout.tv_sec == 0)
        continue;
      offset = timeoffset(&now, &query->timeout);
      if (offset < 0)
        offset = 0;
      if (min_offset == -1 || offset < min_offset)
        min_offset = offset;
    }

  /* If we found a minimum timeout and it's sooner than the one specified in
   * maxtv (if any), return it.  Otherwise go with maxtv.
   */
  if (min_offset != -1)
    {
      int ioffset = (min_offset > (long)INT_MAX) ? INT_MAX : (int)min_offset;

      nextstop.tv_sec = ioffset/1000;
      nextstop.tv_usec = (ioffset%1000)*1000;

      if (!maxtv || ares__timedout(maxtv, &nextstop))
        {
          *tvbuf = nextstop;
          return tvbuf;
        }
    }

  return maxtv;
}
node-v4.8.2/deps/cares/src/ares_version.c000644 000766 000024 00000000236 13070706730 020436 0ustar00iojsstaff000000 000000 
#include "ares_setup.h"
#include "ares.h"

const char *ares_version(int *version)
{
  if(version)
    *version = ARES_VERSION;

  return ARES_VERSION_STR;
}
node-v4.8.2/deps/cares/src/ares_writev.c000644 000766 000024 00000003363 13070706730 020275 0ustar00iojsstaff000000 000000 

/* Copyright 1998 by the Massachusetts Institute of Technology.
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"

#ifdef HAVE_LIMITS_H
#  include 
#endif

#include "ares.h"
#include "ares_private.h"

#ifndef HAVE_WRITEV
ssize_t ares_writev(ares_socket_t s, const struct iovec *iov, int iovcnt)
{
  char *buffer, *bp;
  int i;
  size_t bytes = 0;
  ssize_t result;

  /* Validate iovcnt */
  if (iovcnt <= 0)
  {
    SET_ERRNO(EINVAL);
    return (-1);
  }

  /* Validate and find the sum of the iov_len values in the iov array */
  for (i = 0; i < iovcnt; i++)
  {
    if (iov[i].iov_len > INT_MAX - bytes)
    {
      SET_ERRNO(EINVAL);
      return (-1);
    }
    bytes += iov[i].iov_len;
  }

  if (bytes == 0)
    return (0);

  /* Allocate a temporary buffer to hold the data */
  buffer = malloc(bytes);
  if (!buffer)
  {
    SET_ERRNO(ENOMEM);
    return (-1);
  }

  /* Copy the data into buffer */
  for (bp = buffer, i = 0; i < iovcnt; ++i)
  {
    memcpy (bp, iov[i].iov_base, iov[i].iov_len);
    bp += iov[i].iov_len;
  }

  /* Send buffer contents */
  result = swrite(s, buffer, bytes);

  free(buffer);

  return (result);
}
#endif

node-v4.8.2/deps/cares/src/ares_writev.h000644 000766 000024 00000002114 13070706730 020273 0ustar00iojsstaff000000 000000 #ifndef HEADER_CARES_WRITEV_H
#define HEADER_CARES_WRITEV_H


/* Copyright 1998 by the Massachusetts Institute of Technology.
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#include "ares_setup.h"
#include "ares.h"

#ifndef HAVE_WRITEV

/* Structure for scatter/gather I/O. */
struct iovec
{
  void *iov_base;  /* Pointer to data. */
  size_t iov_len;  /* Length of data.  */
};

extern ssize_t ares_writev(ares_socket_t s, const struct iovec *iov, int iovcnt);

#endif

#endif /* HEADER_CARES_WRITEV_H */
node-v4.8.2/deps/cares/src/AUTHORS000644 000766 000024 00000001566 13070706730 016652 0ustar00iojsstaff000000 000000 c-ares is based on ares, and these are the people that have worked on it since
the fork was made:

Albert Chin
Alexander Lazic
Alexey Simak
Andreas Rieke
Andrew C. Morrow
Ashish Sharma
Ben Greear
Ben Noordhuis
BogDan Vatra
Brad House
Brad Spencer
Bram Matthys
Dan Fandrich
Daniel Johnson
Daniel Stenberg
David Stuart
Denis Bilenko
Dima Tisnek
Dirk Manske
Dominick Meglio
Doug Goldstein
Duncan Wilcox
Eino Tuominen
Erik Kline
George Neill
Gisle Vanem
Guenter Knauf
Guilherme Balena Versiani
Gunter Knauf
Henrik Stoerner
Jakub Hrozek
James Bursa
Jérémy Lal
Marko Kreen
Michael Wallner
Mike Crowe
Nick Alcock
Nick Mathewson
Patrik Thunstrom
Peter Pentchev
Phil Blundell
Poul Thomas Lomholt
Ravi Pratap
Robin Cornelius
Sebastian at basti79.de
Shmulik Regev
Stefan Bühler
Steinar H. Gunderson
Tofu Linden
Tom Hughes
Tor Arntsen
Vlad Dinulescu
William Ahern
Yang Tse
liren at vivisimo.com
node-v4.8.2/deps/cares/src/bitncmp.c000644 000766 000024 00000003137 13070706730 017376 0ustar00iojsstaff000000 000000 
/*
 * Copyright (c) 2004 by Internet Systems Consortium, Inc. ("ISC")
 * Copyright (c) 1996,1999 by Internet Software Consortium.
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
 * OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#ifndef HAVE_BITNCMP

#include "ares_setup.h"
#include "bitncmp.h"

/*
 * int
 * bitncmp(l, r, n)
 *	compare bit masks l and r, for n bits.
 * return:
 *	-1, 1, or 0 in the libc tradition.
 * note:
 *	network byte order assumed.  this means 192.5.5.240/28 has
 *	0x11110000 in its fourth octet.
 * author:
 *	Paul Vixie (ISC), June 1996
 */
int ares__bitncmp(const void *l, const void *r, int n)
{
  unsigned int lb, rb;
  int x, b;

  b = n / 8;
  x = memcmp(l, r, b);
  if (x || (n % 8) == 0)
    return (x);

  lb = ((const unsigned char *)l)[b];
  rb = ((const unsigned char *)r)[b];
  for (b = n % 8; b > 0; b--) {
    if ((lb & 0x80) != (rb & 0x80)) {
      if (lb & 0x80)
        return (1);
      return (-1);
    }
    lb <<= 1;
    rb <<= 1;
  }
  return (0);
}
#endif
node-v4.8.2/deps/cares/src/bitncmp.h000644 000766 000024 00000001611 13070706730 017376 0ustar00iojsstaff000000 000000 #ifndef __ARES_BITNCMP_H
#define __ARES_BITNCMP_H


/* Copyright (C) 2005, 2013 by Dominick Meglio
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#ifndef HAVE_BITNCMP
int ares__bitncmp(const void *l, const void *r, int n);
#else
#define ares__bitncmp(x,y,z) bitncmp(x,y,z)
#endif

#endif /* __ARES_BITNCMP_H */
node-v4.8.2/deps/cares/src/config-win32.h000644 000766 000024 00000027522 13070706730 020160 0ustar00iojsstaff000000 000000 #ifndef HEADER_CARES_CONFIG_WIN32_H
#define HEADER_CARES_CONFIG_WIN32_H

/* Copyright (C) 2004 - 2011 by Daniel Stenberg et al
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation for any purpose and without fee is hereby granted, provided
 * that the above copyright notice appear in all copies and that both that
 * copyright notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in advertising or
 * publicity pertaining to distribution of the software without specific,
 * written prior permission.  M.I.T. makes no representations about the
 * suitability of this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

/* ================================================================ */
/*   c-ares/config-win32.h - Hand crafted config file for Windows   */
/* ================================================================ */

/* ---------------------------------------------------------------- */
/*                          HEADER FILES                            */
/* ---------------------------------------------------------------- */

/* Define if you have the  header file. */
#define HAVE_ASSERT_H 1

/* Define if you have the  header file. */
#define HAVE_ERRNO_H 1

/* Define if you have the  header file. */
#if defined(__MINGW32__) || defined(__POCC__)
#define HAVE_GETOPT_H 1
#endif

/* Define if you have the  header file. */
#define HAVE_LIMITS_H 1

/* Define if you have the  header file. */
#ifndef __SALFORDC__
#define HAVE_PROCESS_H 1
#endif

/* Define if you have the  header file. */
#define HAVE_SIGNAL_H 1

/* Define if you have the  header file */
/* #define HAVE_SYS_TIME_H 1 */

/* Define if you have the  header file. */
#define HAVE_TIME_H 1

/* Define if you have the  header file. */
#if defined(__MINGW32__) || defined(__WATCOMC__) || defined(__LCC__) || \
    defined(__POCC__)
#define HAVE_UNISTD_H 1
#endif

/* Define if you have the  header file. */
#define HAVE_WINDOWS_H 1

/* Define if you have the  header file. */
#define HAVE_WINSOCK_H 1

/* Define if you have the  header file. */
#ifndef __SALFORDC__
#define HAVE_WINSOCK2_H 1
#endif

/* Define if you have the  header file. */
#ifndef __SALFORDC__
#define HAVE_WS2TCPIP_H 1
#endif

/* ---------------------------------------------------------------- */
/*                        OTHER HEADER INFO                         */
/* ---------------------------------------------------------------- */

/* Define if sig_atomic_t is an available typedef. */
#define HAVE_SIG_ATOMIC_T 1

/* Define if you have the ANSI C header files. */
#define STDC_HEADERS 1

/* Define if you can safely include both  and . */
/* #define TIME_WITH_SYS_TIME 1 */

/* ---------------------------------------------------------------- */
/*                             FUNCTIONS                            */
/* ---------------------------------------------------------------- */

/* Define if you have the closesocket function. */
#define HAVE_CLOSESOCKET 1

/* Define if you have the getenv function. */
#define HAVE_GETENV 1

/* Define if you have the gethostname function. */
#define HAVE_GETHOSTNAME 1

/* Define if you have the ioctlsocket function. */
#define HAVE_IOCTLSOCKET 1

/* Define if you have a working ioctlsocket FIONBIO function. */
#define HAVE_IOCTLSOCKET_FIONBIO 1

/* Define if you have the strcasecmp function. */
/* #define HAVE_STRCASECMP 1 */

/* Define if you have the strdup function. */
#define HAVE_STRDUP 1

/* Define if you have the stricmp function. */
#define HAVE_STRICMP 1

/* Define if you have the strncasecmp function. */
/* #define HAVE_STRNCASECMP 1 */

/* Define if you have the strnicmp function. */
#define HAVE_STRNICMP 1

/* Define if you have the recv function. */
#define HAVE_RECV 1

/* Define to the type of arg 1 for recv. */
#define RECV_TYPE_ARG1 SOCKET

/* Define to the type of arg 2 for recv. */
#define RECV_TYPE_ARG2 char *

/* Define to the type of arg 3 for recv. */
#define RECV_TYPE_ARG3 int

/* Define to the type of arg 4 for recv. */
#define RECV_TYPE_ARG4 int

/* Define to the function return type for recv. */
#define RECV_TYPE_RETV int

/* Define if you have the recvfrom function. */
#define HAVE_RECVFROM 1

/* Define to the type of arg 1 for recvfrom. */
#define RECVFROM_TYPE_ARG1 SOCKET

/* Define to the type pointed by arg 2 for recvfrom. */
#define RECVFROM_TYPE_ARG2 char

/* Define to the type of arg 3 for recvfrom. */
#define RECVFROM_TYPE_ARG3 int

/* Define to the type of arg 4 for recvfrom. */
#define RECVFROM_TYPE_ARG4 int

/* Define to the type pointed by arg 5 for recvfrom. */
#define RECVFROM_TYPE_ARG5 struct sockaddr

/* Define to the type pointed by arg 6 for recvfrom. */
#define RECVFROM_TYPE_ARG6 int

/* Define to the function return type for recvfrom. */
#define RECVFROM_TYPE_RETV int

/* Define if you have the send function. */
#define HAVE_SEND 1

/* Define to the type of arg 1 for send. */
#define SEND_TYPE_ARG1 SOCKET

/* Define to the type qualifier of arg 2 for send. */
#define SEND_QUAL_ARG2 const

/* Define to the type of arg 2 for send. */
#define SEND_TYPE_ARG2 char *

/* Define to the type of arg 3 for send. */
#define SEND_TYPE_ARG3 int

/* Define to the type of arg 4 for send. */
#define SEND_TYPE_ARG4 int

/* Define to the function return type for send. */
#define SEND_TYPE_RETV int

/* Specifics for the Watt-32 tcp/ip stack. */
#ifdef WATT32
  #define SOCKET              int
  #define NS_INADDRSZ         4
  #define HAVE_ARPA_NAMESER_H 1
  #define HAVE_ARPA_INET_H    1
  #define HAVE_NETDB_H        1
  #define HAVE_NETINET_IN_H   1
  #define HAVE_SYS_SOCKET_H   1
  #define HAVE_NETINET_TCP_H  1
  #define HAVE_AF_INET6       1
  #define HAVE_PF_INET6       1
  #define HAVE_STRUCT_IN6_ADDR     1
  #define HAVE_STRUCT_SOCKADDR_IN6 1
  #undef HAVE_WINSOCK_H
  #undef HAVE_WINSOCK2_H
  #undef HAVE_WS2TCPIP_H
#endif

/* ---------------------------------------------------------------- */
/*                       TYPEDEF REPLACEMENTS                       */
/* ---------------------------------------------------------------- */

/* Define if in_addr_t is not an available 'typedefed' type. */
#define in_addr_t unsigned long

/* Define to the return type of signal handlers (int or void). */
#define RETSIGTYPE void

/* Define if ssize_t is not an available 'typedefed' type. */
#ifndef _SSIZE_T_DEFINED
#  if (defined(__WATCOMC__) && (__WATCOMC__ >= 1240)) || \
      defined(__POCC__) || \
      defined(__MINGW32__)
#  elif defined(_WIN64)
#    define _SSIZE_T_DEFINED
#    define ssize_t __int64
#  else
#    define _SSIZE_T_DEFINED
#    define ssize_t int
#  endif
#endif

/* ---------------------------------------------------------------- */
/*                            TYPE SIZES                            */
/* ---------------------------------------------------------------- */

/* Define to the size of `int', as computed by sizeof. */
#define SIZEOF_INT 4

/* Define to the size of `short', as computed by sizeof. */
#define SIZEOF_SHORT 2

/* Define to the size of `size_t', as computed by sizeof. */
#if defined(_WIN64)
#  define SIZEOF_SIZE_T 8
#else
#  define SIZEOF_SIZE_T 4
#endif

/* ---------------------------------------------------------------- */
/*                          STRUCT RELATED                          */
/* ---------------------------------------------------------------- */

/* Define if you have struct addrinfo. */
#define HAVE_STRUCT_ADDRINFO 1

/* Define if you have struct sockaddr_storage. */
#if !defined(__SALFORDC__) && !defined(__BORLANDC__)
#define HAVE_STRUCT_SOCKADDR_STORAGE 1
#endif

/* Define if you have struct timeval. */
#define HAVE_STRUCT_TIMEVAL 1

/* ---------------------------------------------------------------- */
/*                        COMPILER SPECIFIC                         */
/* ---------------------------------------------------------------- */

/* Define to avoid VS2005 complaining about portable C functions. */
#if defined(_MSC_VER) && (_MSC_VER >= 1400)
#  define _CRT_SECURE_NO_DEPRECATE 1
#  define _CRT_NONSTDC_NO_DEPRECATE 1
#endif

/* Officially, Microsoft's Windows SDK versions 6.X do not support Windows
   2000 as a supported build target. VS2008 default installations provide
   an embedded Windows SDK v6.0A along with the claim that Windows 2000 is
   a valid build target for VS2008. Popular belief is that binaries built
   with VS2008 using Windows SDK versions 6.X and Windows 2000 as a build
   target are functional. */
#if defined(_MSC_VER) && (_MSC_VER >= 1500)
#  define VS2008_MIN_TARGET 0x0500
#endif

/* When no build target is specified VS2008 default build target is Windows
   Vista, which leaves out even Winsows XP. If no build target has been given
   for VS2008 we will target the minimum Officially supported build target,
   which happens to be Windows XP. */
#if defined(_MSC_VER) && (_MSC_VER >= 1500)
#  define VS2008_DEF_TARGET  0x0501
#endif

/* VS2008 default target settings and minimum build target check. */
#if defined(_MSC_VER) && (_MSC_VER >= 1500)
#  ifndef _WIN32_WINNT
#    define _WIN32_WINNT VS2008_DEF_TARGET
#  endif
#  ifndef WINVER
#    define WINVER VS2008_DEF_TARGET
#  endif
#  if (_WIN32_WINNT < VS2008_MIN_TARGET) || (WINVER < VS2008_MIN_TARGET)
#    error VS2008 does not support Windows build targets prior to Windows 2000
#  endif
#endif

/* When no build target is specified Pelles C 5.00 and later default build
   target is Windows Vista. We override default target to be Windows 2000. */
#if defined(__POCC__) && (__POCC__ >= 500)
#  ifndef _WIN32_WINNT
#    define _WIN32_WINNT 0x0500
#  endif
#  ifndef WINVER
#    define WINVER 0x0500
#  endif
#endif

/* Availability of freeaddrinfo, getaddrinfo and getnameinfo functions is
   quite convoluted, compiler dependent and even build target dependent. */
#if defined(HAVE_WS2TCPIP_H)
#  if defined(__POCC__)
#    define HAVE_FREEADDRINFO 1
#    define HAVE_GETADDRINFO  1
#    define HAVE_GETNAMEINFO  1
#  elif defined(_WIN32_WINNT) && (_WIN32_WINNT >= 0x0501)
#    define HAVE_FREEADDRINFO 1
#    define HAVE_GETADDRINFO  1
#    define HAVE_GETNAMEINFO  1
#  elif defined(_MSC_VER) && (_MSC_VER >= 1200)
#    define HAVE_FREEADDRINFO 1
#    define HAVE_GETADDRINFO  1
#    define HAVE_GETNAMEINFO  1
#  endif
#endif

#if defined(__POCC__)
#  ifndef _MSC_VER
#    error Microsoft extensions /Ze compiler option is required
#  endif
#  ifndef __POCC__OLDNAMES
#    error Compatibility names /Go compiler option is required
#  endif
#endif

/* ---------------------------------------------------------------- */
/*                         IPV6 COMPATIBILITY                       */
/* ---------------------------------------------------------------- */

/* Define if you have address family AF_INET6. */
#ifdef HAVE_WINSOCK2_H
#define HAVE_AF_INET6 1
#endif

/* Define if you have protocol family PF_INET6. */
#ifdef HAVE_WINSOCK2_H
#define HAVE_PF_INET6 1
#endif

/* Define if you have struct in6_addr. */
#ifdef HAVE_WS2TCPIP_H
#define HAVE_STRUCT_IN6_ADDR 1
#endif

/* Define if you have struct sockaddr_in6. */
#ifdef HAVE_WS2TCPIP_H
#define HAVE_STRUCT_SOCKADDR_IN6 1
#endif

/* Define if you have sockaddr_in6 with scopeid. */
#ifdef HAVE_WS2TCPIP_H
#define HAVE_SOCKADDR_IN6_SIN6_SCOPE_ID 1
#endif

/* ---------------------------------------------------------------- */
/*                              Win CE                              */
/* ---------------------------------------------------------------- */

/* FIXME: A proper config-win32ce.h should be created to hold these */

/*
 *  System error codes for Windows CE
 */

#if defined(_WIN32_WCE) && !defined(HAVE_ERRNO_H)
#  define ENOENT    ERROR_FILE_NOT_FOUND
#  define ESRCH     ERROR_PATH_NOT_FOUND
#  define ENOMEM    ERROR_NOT_ENOUGH_MEMORY
#  define ENOSPC    ERROR_INVALID_PARAMETER
#endif

#endif /* HEADER_CARES_CONFIG_WIN32_H */
node-v4.8.2/deps/cares/src/inet_net_pton.c000644 000766 000024 00000026201 13070706730 020604 0ustar00iojsstaff000000 000000 
/*
 * Copyright (c) 2004 by Internet Systems Consortium, Inc. ("ISC")
 * Copyright (c) 1996,1999 by Internet Software Consortium.
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
 * OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#include "ares_setup.h"

#ifdef HAVE_NETINET_IN_H
#  include 
#endif
#ifdef HAVE_ARPA_INET_H
#  include 
#endif
#ifdef HAVE_ARPA_NAMESER_H
#  include 
#else
#  include "nameser.h"
#endif
#ifdef HAVE_ARPA_NAMESER_COMPAT_H
#  include 
#endif

#include "ares.h"
#include "ares_ipv6.h"
#include "ares_nowarn.h"
#include "ares_inet_net_pton.h"


const struct ares_in6_addr ares_in6addr_any = { { { 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0 } } };


#ifndef HAVE_INET_NET_PTON

/*
 * static int
 * inet_net_pton_ipv4(src, dst, size)
 *      convert IPv4 network number from presentation to network format.
 *      accepts hex octets, hex strings, decimal octets, and /CIDR.
 *      "size" is in bytes and describes "dst".
 * return:
 *      number of bits, either imputed classfully or specified with /CIDR,
 *      or -1 if some failure occurred (check errno).  ENOENT means it was
 *      not an IPv4 network specification.
 * note:
 *      network byte order assumed.  this means 192.5.5.240/28 has
 *      0b11110000 in its fourth octet.
 * note:
 *      On Windows we store the error in the thread errno, not
 *      in the winsock error code. This is to avoid loosing the
 *      actual last winsock error. So use macro ERRNO to fetch the
 *      errno this funtion sets when returning (-1), not SOCKERRNO.
 * author:
 *      Paul Vixie (ISC), June 1996
 */
static int
inet_net_pton_ipv4(const char *src, unsigned char *dst, size_t size)
{
  static const char xdigits[] = "0123456789abcdef";
  static const char digits[] = "0123456789";
  int n, ch, tmp = 0, dirty, bits;
  const unsigned char *odst = dst;

  ch = *src++;
  if (ch == '0' && (src[0] == 'x' || src[0] == 'X')
      && ISASCII(src[1])
      && ISXDIGIT(src[1])) {
    /* Hexadecimal: Eat nybble string. */
    if (!size)
      goto emsgsize;
    dirty = 0;
    src++;  /* skip x or X. */
    while ((ch = *src++) != '\0' && ISASCII(ch) && ISXDIGIT(ch)) {
      if (ISUPPER(ch))
        ch = tolower(ch);
      n = aresx_sztosi(strchr(xdigits, ch) - xdigits);
      if (dirty == 0)
        tmp = n;
      else
        tmp = (tmp << 4) | n;
      if (++dirty == 2) {
        if (!size--)
          goto emsgsize;
        *dst++ = (unsigned char) tmp;
        dirty = 0;
      }
    }
    if (dirty) {  /* Odd trailing nybble? */
      if (!size--)
        goto emsgsize;
      *dst++ = (unsigned char) (tmp << 4);
    }
  } else if (ISASCII(ch) && ISDIGIT(ch)) {
    /* Decimal: eat dotted digit string. */
    for (;;) {
      tmp = 0;
      do {
        n = aresx_sztosi(strchr(digits, ch) - digits);
        tmp *= 10;
        tmp += n;
        if (tmp > 255)
          goto enoent;
      } while ((ch = *src++) != '\0' &&
               ISASCII(ch) && ISDIGIT(ch));
      if (!size--)
        goto emsgsize;
      *dst++ = (unsigned char) tmp;
      if (ch == '\0' || ch == '/')
        break;
      if (ch != '.')
        goto enoent;
      ch = *src++;
      if (!ISASCII(ch) || !ISDIGIT(ch))
        goto enoent;
    }
  } else
    goto enoent;

  bits = -1;
  if (ch == '/' && ISASCII(src[0]) &&
      ISDIGIT(src[0]) && dst > odst) {
    /* CIDR width specifier.  Nothing can follow it. */
    ch = *src++;    /* Skip over the /. */
    bits = 0;
    do {
      n = aresx_sztosi(strchr(digits, ch) - digits);
      bits *= 10;
      bits += n;
      if (bits > 32)
        goto enoent;
    } while ((ch = *src++) != '\0' && ISASCII(ch) && ISDIGIT(ch));
    if (ch != '\0')
      goto enoent;
  }

  /* Firey death and destruction unless we prefetched EOS. */
  if (ch != '\0')
    goto enoent;

  /* If nothing was written to the destination, we found no address. */
  if (dst == odst)
    goto enoent;
  /* If no CIDR spec was given, infer width from net class. */
  if (bits == -1) {
    if (*odst >= 240)       /* Class E */
      bits = 32;
    else if (*odst >= 224)  /* Class D */
      bits = 8;
    else if (*odst >= 192)  /* Class C */
      bits = 24;
    else if (*odst >= 128)  /* Class B */
      bits = 16;
    else                    /* Class A */
      bits = 8;
    /* If imputed mask is narrower than specified octets, widen. */
    if (bits < ((dst - odst) * 8))
      bits = aresx_sztosi(dst - odst) * 8;
    /*
     * If there are no additional bits specified for a class D
     * address adjust bits to 4.
     */
    if (bits == 8 && *odst == 224)
      bits = 4;
  }
  /* Extend network to cover the actual mask. */
  while (bits > ((dst - odst) * 8)) {
    if (!size--)
      goto emsgsize;
    *dst++ = '\0';
  }
  return (bits);

  enoent:
  SET_ERRNO(ENOENT);
  return (-1);

  emsgsize:
  SET_ERRNO(EMSGSIZE);
  return (-1);
}

static int
getbits(const char *src, int *bitsp)
{
  static const char digits[] = "0123456789";
  int n;
  int val;
  char ch;

  val = 0;
  n = 0;
  while ((ch = *src++) != '\0') {
    const char *pch;

    pch = strchr(digits, ch);
    if (pch != NULL) {
      if (n++ != 0 && val == 0)       /* no leading zeros */
        return (0);
      val *= 10;
      val += aresx_sztosi(pch - digits);
      if (val > 128)                  /* range */
        return (0);
      continue;
    }
    return (0);
  }
  if (n == 0)
    return (0);
  *bitsp = val;
  return (1);
}

static int
getv4(const char *src, unsigned char *dst, int *bitsp)
{
  static const char digits[] = "0123456789";
  unsigned char *odst = dst;
  int n;
  unsigned int val;
  char ch;

  val = 0;
  n = 0;
  while ((ch = *src++) != '\0') {
    const char *pch;

    pch = strchr(digits, ch);
    if (pch != NULL) {
      if (n++ != 0 && val == 0)       /* no leading zeros */
        return (0);
      val *= 10;
      val += aresx_sztoui(pch - digits);
      if (val > 255)                  /* range */
        return (0);
      continue;
    }
    if (ch == '.' || ch == '/') {
      if (dst - odst > 3)             /* too many octets? */
        return (0);
      *dst++ = (unsigned char)val;
      if (ch == '/')
        return (getbits(src, bitsp));
      val = 0;
      n = 0;
      continue;
    }
    return (0);
  }
  if (n == 0)
    return (0);
  if (dst - odst > 3)             /* too many octets? */
    return (0);
  *dst = (unsigned char)val;
  return 1;
}

static int
inet_net_pton_ipv6(const char *src, unsigned char *dst, size_t size)
{
  static const char xdigits_l[] = "0123456789abcdef",
    xdigits_u[] = "0123456789ABCDEF";
  unsigned char tmp[NS_IN6ADDRSZ], *tp, *endp, *colonp;
  const char *xdigits, *curtok;
  int ch, saw_xdigit;
  unsigned int val;
  int digits;
  int bits;
  size_t bytes;
  int words;
  int ipv4;

  memset((tp = tmp), '\0', NS_IN6ADDRSZ);
  endp = tp + NS_IN6ADDRSZ;
  colonp = NULL;
  /* Leading :: requires some special handling. */
  if (*src == ':')
    if (*++src != ':')
      goto enoent;
  curtok = src;
  saw_xdigit = 0;
  val = 0;
  digits = 0;
  bits = -1;
  ipv4 = 0;
  while ((ch = *src++) != '\0') {
    const char *pch;

    if ((pch = strchr((xdigits = xdigits_l), ch)) == NULL)
      pch = strchr((xdigits = xdigits_u), ch);
    if (pch != NULL) {
      val <<= 4;
      val |= aresx_sztoui(pch - xdigits);
      if (++digits > 4)
        goto enoent;
      saw_xdigit = 1;
      continue;
    }
    if (ch == ':') {
      curtok = src;
      if (!saw_xdigit) {
        if (colonp)
          goto enoent;
        colonp = tp;
        continue;
      } else if (*src == '\0')
        goto enoent;
      if (tp + NS_INT16SZ > endp)
        return (0);
      *tp++ = (unsigned char)((val >> 8) & 0xff);
      *tp++ = (unsigned char)(val & 0xff);
      saw_xdigit = 0;
      digits = 0;
      val = 0;
      continue;
    }
    if (ch == '.' && ((tp + NS_INADDRSZ) <= endp) &&
        getv4(curtok, tp, &bits) > 0) {
      tp += NS_INADDRSZ;
      saw_xdigit = 0;
      ipv4 = 1;
      break;  /* '\0' was seen by inet_pton4(). */
    }
    if (ch == '/' && getbits(src, &bits) > 0)
      break;
    goto enoent;
  }
  if (saw_xdigit) {
    if (tp + NS_INT16SZ > endp)
      goto enoent;
    *tp++ = (unsigned char)((val >> 8) & 0xff);
    *tp++ = (unsigned char)(val & 0xff);
  }
  if (bits == -1)
    bits = 128;

  words = (bits + 15) / 16;
  if (words < 2)
    words = 2;
  if (ipv4)
    words = 8;
  endp =  tmp + 2 * words;

  if (colonp != NULL) {
    /*
     * Since some memmove()'s erroneously fail to handle
     * overlapping regions, we'll do the shift by hand.
     */
    const ssize_t n = tp - colonp;
    ssize_t i;

    if (tp == endp)
      goto enoent;
    for (i = 1; i <= n; i++) {
      *(endp - i) = *(colonp + n - i);
      *(colonp + n - i) = 0;
    }
    tp = endp;
  }
  if (tp != endp)
    goto enoent;

  bytes = (bits + 7) / 8;
  if (bytes > size)
    goto emsgsize;
  memcpy(dst, tmp, bytes);
  return (bits);

  enoent:
  SET_ERRNO(ENOENT);
  return (-1);

  emsgsize:
  SET_ERRNO(EMSGSIZE);
  return (-1);
}

/*
 * int
 * inet_net_pton(af, src, dst, size)
 *      convert network number from presentation to network format.
 *      accepts hex octets, hex strings, decimal octets, and /CIDR.
 *      "size" is in bytes and describes "dst".
 * return:
 *      number of bits, either imputed classfully or specified with /CIDR,
 *      or -1 if some failure occurred (check errno).  ENOENT means it was
 *      not a valid network specification.
 * note:
 *      On Windows we store the error in the thread errno, not
 *      in the winsock error code. This is to avoid loosing the
 *      actual last winsock error. So use macro ERRNO to fetch the
 *      errno this funtion sets when returning (-1), not SOCKERRNO.
 * author:
 *      Paul Vixie (ISC), June 1996
 */
int
ares_inet_net_pton(int af, const char *src, void *dst, size_t size)
{
  switch (af) {
  case AF_INET:
    return (inet_net_pton_ipv4(src, dst, size));
  case AF_INET6:
    return (inet_net_pton_ipv6(src, dst, size));
  default:
    SET_ERRNO(EAFNOSUPPORT);
    return (-1);
  }
}

#endif /* HAVE_INET_NET_PTON */

#ifndef HAVE_INET_PTON
int ares_inet_pton(int af, const char *src, void *dst)
{
  int result;
  size_t size;

  if (af == AF_INET)
    size = sizeof(struct in_addr);
  else if (af == AF_INET6)
    size = sizeof(struct ares_in6_addr);
  else
  {
    SET_ERRNO(EAFNOSUPPORT);
    return -1;
  }
  result = ares_inet_net_pton(af, src, dst, size);
  if (result == -1 && ERRNO == ENOENT)
    return 0;
  return (result > -1 ? 1 : -1);
}
#else /* HAVE_INET_PTON */
int ares_inet_pton(int af, const char *src, void *dst)
{
  /* just relay this to the underlying function */
  return inet_pton(af, src, dst);
}

#endif
node-v4.8.2/deps/cares/src/inet_ntop.c000644 000766 000024 00000013404 13070706730 017737 0ustar00iojsstaff000000 000000 /*
 * Copyright (c) 2004 by Internet Systems Consortium, Inc. ("ISC")
 * Copyright (c) 1996-1999 by Internet Software Consortium.
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
 * OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#include "ares_setup.h"

#ifdef HAVE_NETINET_IN_H
#  include 
#endif
#ifdef HAVE_ARPA_INET_H
#  include 
#endif
#ifdef HAVE_ARPA_NAMESER_H
#  include 
#else
#  include "nameser.h"
#endif
#ifdef HAVE_ARPA_NAMESER_COMPAT_H
#  include 
#endif

#include "ares.h"
#include "ares_ipv6.h"

#ifndef HAVE_INET_NTOP

/*
 * WARNING: Don't even consider trying to compile this on a system where
 * sizeof(int) < 4.  sizeof(int) > 4 is fine; all the world's not a VAX.
 */

static const char *inet_ntop4(const unsigned char *src, char *dst, size_t size);
static const char *inet_ntop6(const unsigned char *src, char *dst, size_t size);

/* char *
 * inet_ntop(af, src, dst, size)
 *     convert a network format address to presentation format.
 * return:
 *     pointer to presentation format address (`dst'), or NULL (see errno).
 * note:
 *     On Windows we store the error in the thread errno, not
 *     in the winsock error code. This is to avoid loosing the
 *     actual last winsock error. So use macro ERRNO to fetch the
 *     errno this funtion sets when returning NULL, not SOCKERRNO.
 * author:
 *     Paul Vixie, 1996.
 */
const char *
ares_inet_ntop(int af, const void *src, char *dst, ares_socklen_t size)
{
  switch (af) {
  case AF_INET:
    return (inet_ntop4(src, dst, (size_t)size));
  case AF_INET6:
    return (inet_ntop6(src, dst, (size_t)size));
  default:
    SET_ERRNO(EAFNOSUPPORT);
    return (NULL);
  }
  /* NOTREACHED */
}

/* const char *
 * inet_ntop4(src, dst, size)
 *     format an IPv4 address
 * return:
 *     `dst' (as a const)
 * notes:
 *     (1) uses no statics
 *     (2) takes a unsigned char* not an in_addr as input
 * author:
 *     Paul Vixie, 1996.
 */
static const char *
inet_ntop4(const unsigned char *src, char *dst, size_t size)
{
  static const char fmt[] = "%u.%u.%u.%u";
  char tmp[sizeof("255.255.255.255")];

  if ((size_t)sprintf(tmp, fmt, src[0], src[1], src[2], src[3]) >= size) {
    SET_ERRNO(ENOSPC);
    return (NULL);
  }
  strcpy(dst, tmp);
  return (dst);
}

/* const char *
 * inet_ntop6(src, dst, size)
 *     convert IPv6 binary address into presentation (printable) format
 * author:
 *     Paul Vixie, 1996.
 */
static const char *
inet_ntop6(const unsigned char *src, char *dst, size_t size)
{
  /*
   * Note that int32_t and int16_t need only be "at least" large enough
   * to contain a value of the specified size.  On some systems, like
   * Crays, there is no such thing as an integer variable with 16 bits.
   * Keep this in mind if you think this function should have been coded
   * to use pointer overlays.  All the world's not a VAX.
   */
  char tmp[sizeof("ffff:ffff:ffff:ffff:ffff:ffff:255.255.255.255")];
  char *tp;
  struct { int base, len; } best, cur;
  unsigned int words[NS_IN6ADDRSZ / NS_INT16SZ];
  int i;

  /*
   * Preprocess:
   *  Copy the input (bytewise) array into a wordwise array.
   *  Find the longest run of 0x00's in src[] for :: shorthanding.
   */
  memset(words, '\0', sizeof(words));
  for (i = 0; i < NS_IN6ADDRSZ; i++)
    words[i / 2] |= (src[i] << ((1 - (i % 2)) << 3));
  best.base = -1;
  best.len = 0;
  cur.base = -1;
  cur.len = 0;
  for (i = 0; i < (NS_IN6ADDRSZ / NS_INT16SZ); i++) {
    if (words[i] == 0) {
      if (cur.base == -1)
        cur.base = i, cur.len = 1;
      else
        cur.len++;
    } else {
      if (cur.base != -1) {
        if (best.base == -1 || cur.len > best.len)
          best = cur;
        cur.base = -1;
      }
    }
  }
  if (cur.base != -1) {
    if (best.base == -1 || cur.len > best.len)
      best = cur;
  }
  if (best.base != -1 && best.len < 2)
    best.base = -1;

  /*
   * Format the result.
   */
  tp = tmp;
  for (i = 0; i < (NS_IN6ADDRSZ / NS_INT16SZ); i++) {
    /* Are we inside the best run of 0x00's? */
    if (best.base != -1 && i >= best.base &&
        i < (best.base + best.len)) {
      if (i == best.base)
        *tp++ = ':';
      continue;
    }
    /* Are we following an initial run of 0x00s or any real hex? */
    if (i != 0)
      *tp++ = ':';
    /* Is this address an encapsulated IPv4? */
    if (i == 6 && best.base == 0 && (best.len == 6 ||
        (best.len == 7 && words[7] != 0x0001) ||
        (best.len == 5 && words[5] == 0xffff))) {
      if (!inet_ntop4(src+12, tp, sizeof(tmp) - (tp - tmp)))
        return (NULL);
      tp += strlen(tp);
      break;
    }
    tp += sprintf(tp, "%x", words[i]);
  }
  /* Was it a trailing run of 0x00's? */
  if (best.base != -1 && (best.base + best.len) == 
      (NS_IN6ADDRSZ / NS_INT16SZ))
    *tp++ = ':';
  *tp++ = '\0';

  /*
   * Check for overflow, copy, and we're done.
   */
  if ((size_t)(tp - tmp) > size) {
    SET_ERRNO(ENOSPC);
    return (NULL);
  }
  strcpy(dst, tmp);
  return (dst);
}

#else /* HAVE_INET_NTOP */

const char *
ares_inet_ntop(int af, const void *src, char *dst, ares_socklen_t size)
{
  /* just relay this to the underlying function */
  return inet_ntop(af, src, dst, size);
}

#endif /* HAVE_INET_NTOP */
node-v4.8.2/deps/cares/src/NEWS000644 000766 000024 00000001526 13070706730 016275 0ustar00iojsstaff000000 000000 Major changes since:
* see the CHANGES file

Major changes in release 1.1.1:
* ares should now compile as C++ code (no longer uses reserved word
  "class").
* Added SRV support to adig test program.
* Fixed a few error handling bugs in query processing.

Major changes in release 1.1.0:
* Added ares_free_string() function so that memory can be freed in the
  same layer as it is allocated, a desirable feature in some
  environments.
* A few of the ares_dns.h macros are fixed to use the proper bitwise
  operator.
* Fixed a couple of fenceposts fixed in ares_expand_name()'s
  bounds-checking.
* In process_timeouts(), extract query->next before calling
  next_server() and possibly freeing the query structure.
* Casted arguments to ctype macros casted to unsigned char, since not
  all char values are valid inputs to those macros according to ANSI.
node-v4.8.2/deps/cares/src/README000644 000766 000024 00000005003 13070706730 016450 0ustar00iojsstaff000000 000000 c-ares
======

This is c-ares, an asynchronous resolver library.  It is intended for
applications which need to perform DNS queries without blocking, or need to
perform multiple DNS queries in parallel.  The primary examples of such
applications are servers which communicate with multiple clients and programs
with graphical user interfaces.

The full source code is available in the 'c-ares' release archives, and in a
git repository: http://github.com/bagder/c-ares

If you find bugs, correct flaws, have questions or have comments in general in
regard to c-ares (or by all means the original ares too), get in touch with us
on the c-ares mailing list: http://cool.haxx.se/mailman/listinfo/c-ares

c-ares is of course distributed under the same MIT-style license as the
original ares.

You'll find all c-ares details and news here:

        http://c-ares.haxx.se/


NOTES FOR C-ARES HACKERS

* The distributed ares_build.h file is only intended to be used on systems
  which can not run the also distributed configure script.

* The distributed ares_build.h file is generated as a copy of ares_build.h.dist
  when the c-ares source code distribution archive file is originally created.

* If you check out from git on a non-configure platform, you must run the
  appropriate buildconf* script to set up ares_build.h and other local files
  before being able of compiling the library.

* On systems capable of running the configure script, the configure process
  will overwrite the distributed ares_build.h file with one that is suitable
  and specific to the library being configured and built, this new file is
  generated from the ares_build.h.in template file.

* If you intend to distribute an already compiled c-ares library you _MUST_
  also distribute along with it the generated ares_build.h which has been
  used to compile it. Otherwise the library will be of no use for the users of
  the library that you have built. It is _your_ responsibility to provide this
  file. No one at the c-ares project can know how you have built the library.

* File ares_build.h includes platform and configuration dependent info,
  and must not be modified by anyone. Configure script generates it for you.

* We cannot assume anything else but very basic compiler features being
  present. While c-ares requires an ANSI C compiler to build, some of the
  earlier ANSI compilers clearly can't deal with some preprocessor operators.

* Newlines must remain unix-style for older compilers' sake.

* Comments must be written in the old-style /* unnested C-fashion */

node-v4.8.2/deps/cares/src/README.cares000644 000766 000024 00000001027 13070706730 017546 0ustar00iojsstaff000000 000000 c-ares
======

This package is based on ares 1.1.1 (written by Greg Hudson). I decided to
fork and release a separate project since the ares author didn't want the
improvements that were vital for our use of it.

This package is dubbed 'c-ares' since I (Daniel Stenberg) wanted this for use
within the curl project (hence the letter C) and it makes a nice pun. Also,
c-ares is not API compatible with ares: a new name makes that more obvious to
the public.

The original libares was distributed at athena-dist.mit.edu:pub/ATHENA/ares.
node-v4.8.2/deps/cares/src/README.msvc000644 000766 000024 00000012526 13070706730 017427 0ustar00iojsstaff000000 000000 

                          ___       __ _ _ __ ___  ___ 
                         / __| ___ / _` | '__/ _ \/ __|
                        | (_  |___| (_| | | |  __/\__ \
                         \___|     \__,_|_|  \___||___/


                How to build c-ares using MSVC or Visual Studio
               =================================================



  How to build using MSVC from the command line
  ---------------------------------------------

  Open a command prompt window and ensure that the environment is properly
  set up in order to use MSVC or Visual Studio compiler tools.

  Change to c-ares source folder where Makefile.msvc file is located and run:

  > nmake -f Makefile.msvc

  This will build all c-ares libraries as well as three sample programs.

  Once the above command has finished a new folder named MSVCXX will exist
  below the folder where makefile.msvc is found. The name of the folder
  depends on the MSVC compiler version being used to build c-ares.

  Below the MSVCXX folder there will exist four folders named 'cares',
  'ahost', 'acountry', and 'adig'. The 'cares' folder is the one that
  holds the c-ares libraries you have just generated, the other three
  hold sample programs that use the libraries.

  The above command builds four versions of the c-ares library, dynamic
  and static versions and each one in release and debug flavours. Each
  of these is found in folders named dll-release, dll-debug, lib-release,
  and lib-debug, which hang from the 'cares' folder mentioned above. Each
  sample program also has folders with the same names to reflect which
  library version it is using.


  How to install using MSVC from the command line
  -----------------------------------------------

  In order to allow easy usage of c-ares libraries it may be convenient to
  install c-ares libraries and header files to a common subdirectory tree.

  Once that c-ares libraries have been built using procedure described above,
  use same command prompt window to define environment variable INSTALL_DIR
  to designate the top subdirectory where installation of c-ares libraries and
  header files will be done.

  > set INSTALL_DIR=c:\c-ares

  Afterwards, run following command to actually perform the installation:

  > nmake -f Makefile.msvc install

  Installation procedure will copy c-ares libraries to subdirectory 'lib' and
  c-ares header files to subdirectory 'include' below the INSTALL_DIR subdir.

  When environment variable INSTALL_DIR is not defined, installation is done
  to c-ares source folder where Makefile.msvc file is located.


  How to build using Visual Studio 6 IDE
  --------------------------------------

  A VC++ 6.0 reference workspace (vc6aws.dsw) is available within the 'vc'
  folder to allow proper building of the library and sample programs.

  1) Open the vc6aws.dsw workspace with MSVC6's IDE.
  2) Select 'Build' from top menu.
  3) Select 'Batch Build' from dropdown menu.
  4) Make sure that the sixteen project configurations are 'checked'.
  5) Click on the 'Build' button.
  6) Once the sixteen project configurations are built you are done.

  Dynamic and static c-ares libraries are built in debug and release flavours,
  and can be located each one in its own subdirectory, dll-debug, dll-release,
  lib-debug and lib-release, all of them below the 'vc\cares' subdirectory.

  In the same way four executable versions of each sample program are built,
  each using its respective library. The resulting sample executables are
  located in its own subdirectory, dll-debug, dll-release, lib-debug and
  lib-release, below the 'vc\acountry', 'vc\adig' and 'vc\ahost'folders.

  These reference VC++ 6.0 configurations are generated using the dynamic CRT.


  How to build using Visual Studio 2003 or newer IDE
  --------------------------------------------------

  First you have to convert the VC++ 6.0 reference workspace and project files
  to the Visual Studio IDE version you are using, following next steps:

  1) Open vc\vc6aws.dsw with VS20XX.
  2) Allow VS20XX to update all projects and workspaces.
  3) Save ALL and close VS20XX.
  4) Open vc\vc6aws.sln with VS20XX.
  5) Select batch build, check 'all' projects and click 'build' button.

  Same comments relative to generated files and folders as done above for
  Visual Studio 6 IDE apply here.


  Relationship between c-ares library file names and versions
  -----------------------------------------------------------

  c-ares static release library version files:

      libcares.lib -> static release library

  c-ares static debug library version files:

      libcaresd.lib -> static debug library

  c-ares dynamic release library version files:

      cares.dll -> dynamic release library
      cares.lib -> import library for the dynamic release library
      cares.exp -> export file for the dynamic release library

  c-ares dynamic debug library version files:

      caresd.dll -> dynamic debug library
      caresd.lib -> import library for the dynamic debug library
      caresd.exp -> export file for the dynamic debug library
      caresd.pdb -> debug symbol file for the dynamic debug library


  How to use c-ares static libraries
  ----------------------------------

  When using the c-ares static library in your program, you will have to
  define preprocessor symbol CARES_STATICLIB while building your program,
  otherwise you will get errors at linkage stage.


Have Fun!
 
node-v4.8.2/deps/cares/src/RELEASE-NOTES000644 000766 000024 00000002447 13070706730 017472 0ustar00iojsstaff000000 000000 c-ares version 1.10.0

Changes:

 o Added ares_create_query(), to be used instead of ares_mkquery()
 o ares_inet_ntop() and ares_inet_pton() are now recognized c-ares functions

Bug fixes:

 o include the ares_parse_soa_reply.* files in the tarball
 o read_udp_packets: bail out loop on bad sockets
 o get_DNS_AdaptersAddresses: fix IPv6 parsing
 o adig: perror() doesn't work for socket errors on windows
 o ares_parse_aaaa_reply: fix memory leak
 o setup_once.h: HP-UX  issue workaround
 o configure: several fixes
 o config-dos.h: define strerror() to strerror_s_() for High-C
 o config-dos.h: define HAVE_CLOSE_S for MSDOS/Watt-32
 o ares_build.h.dist: enhance non-configure GCC ABI detection logic
 o ares.h: stricter CARES_EXTERN linkage decorations logic
 o ares_cancel(): cancel requests safely
 o protocol parsing: check input data stricter
 o library init: be recursive, reference count inits/cleanups
 o ares_parse_txt_reply: return a ares_txt_reply node for each sub-string
 o ares_set_servers_csv: fixed IPv6 address parsing
 o build: fix build on msvc11
 
Thanks go to these friendly people for their efforts and contributions:

 Eugeny Gladkih, Yang Tse, Gisle Vanem, Guenter Knauf, Horatiu Popescu,
 Alexander Klauer, Patrick Valsecchi, Paul Saab, Keith Shaw,
 Alex Loukissas
 

Have fun!
node-v4.8.2/deps/cares/src/setup_once.h000644 000766 000024 00000036007 13070706730 020115 0ustar00iojsstaff000000 000000 #ifndef __SETUP_ONCE_H
#define __SETUP_ONCE_H


/* Copyright (C) 2004 - 2013 by Daniel Stenberg et al
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation for any purpose and without fee is hereby granted, provided
 * that the above copyright notice appear in all copies and that both that
 * copyright notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in advertising or
 * publicity pertaining to distribution of the software without specific,
 * written prior permission.  M.I.T. makes no representations about the
 * suitability of this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */


/********************************************************************
 *                              NOTICE                              *
 *                             ========                             *
 *                                                                  *
 *  Content of header files lib/setup_once.h and ares/setup_once.h  *
 *  must be kept in sync. Modify the other one if you change this.  *
 *                                                                  *
 ********************************************************************/


/*
 * Inclusion of common header files.
 */

#include 
#include 
#include 
#include 
#include 

#ifdef HAVE_ERRNO_H
#include 
#endif

#ifdef HAVE_SYS_TYPES_H
#include 
#endif

#ifdef NEED_MALLOC_H
#include 
#endif

#ifdef NEED_MEMORY_H
#include 
#endif

#ifdef HAVE_SYS_STAT_H
#include 
#endif

#ifdef HAVE_SYS_TIME_H
#include 
#ifdef TIME_WITH_SYS_TIME
#include 
#endif
#else
#ifdef HAVE_TIME_H
#include 
#endif
#endif

#ifdef WIN32
#include 
#include 
#endif

#if defined(HAVE_STDBOOL_H) && defined(HAVE_BOOL_T)
#include 
#endif

#ifdef HAVE_UNISTD_H
#include 
#endif

#ifdef __hpux
#  if !defined(_XOPEN_SOURCE_EXTENDED) || defined(_KERNEL)
#    ifdef _APP32_64BIT_OFF_T
#      define OLD_APP32_64BIT_OFF_T _APP32_64BIT_OFF_T
#      undef _APP32_64BIT_OFF_T
#    else
#      undef OLD_APP32_64BIT_OFF_T
#    endif
#  endif
#endif

#ifdef HAVE_SYS_SOCKET_H
#include 
#endif

#ifdef __hpux
#  if !defined(_XOPEN_SOURCE_EXTENDED) || defined(_KERNEL)
#    ifdef OLD_APP32_64BIT_OFF_T
#      define _APP32_64BIT_OFF_T OLD_APP32_64BIT_OFF_T
#      undef OLD_APP32_64BIT_OFF_T
#    endif
#  endif
#endif


/*
 * Definition of timeval struct for platforms that don't have it.
 */

#ifndef HAVE_STRUCT_TIMEVAL
struct timeval {
 long tv_sec;
 long tv_usec;
};
#endif


/*
 * If we have the MSG_NOSIGNAL define, make sure we use
 * it as the fourth argument of function send()
 */

#ifdef HAVE_MSG_NOSIGNAL
#define SEND_4TH_ARG MSG_NOSIGNAL
#else
#define SEND_4TH_ARG 0
#endif


#if defined(__minix)
/* Minix doesn't support recv on TCP sockets */
#define sread(x,y,z) (ssize_t)read((RECV_TYPE_ARG1)(x), \
                                   (RECV_TYPE_ARG2)(y), \
                                   (RECV_TYPE_ARG3)(z))

#elif defined(HAVE_RECV)
/*
 * The definitions for the return type and arguments types
 * of functions recv() and send() belong and come from the
 * configuration file. Do not define them in any other place.
 *
 * HAVE_RECV is defined if you have a function named recv()
 * which is used to read incoming data from sockets. If your
 * function has another name then don't define HAVE_RECV.
 *
 * If HAVE_RECV is defined then RECV_TYPE_ARG1, RECV_TYPE_ARG2,
 * RECV_TYPE_ARG3, RECV_TYPE_ARG4 and RECV_TYPE_RETV must also
 * be defined.
 *
 * HAVE_SEND is defined if you have a function named send()
 * which is used to write outgoing data on a connected socket.
 * If yours has another name then don't define HAVE_SEND.
 *
 * If HAVE_SEND is defined then SEND_TYPE_ARG1, SEND_QUAL_ARG2,
 * SEND_TYPE_ARG2, SEND_TYPE_ARG3, SEND_TYPE_ARG4 and
 * SEND_TYPE_RETV must also be defined.
 */

#if !defined(RECV_TYPE_ARG1) || \
    !defined(RECV_TYPE_ARG2) || \
    !defined(RECV_TYPE_ARG3) || \
    !defined(RECV_TYPE_ARG4) || \
    !defined(RECV_TYPE_RETV)
  /* */
  Error Missing_definition_of_return_and_arguments_types_of_recv
  /* */
#else
#define sread(x,y,z) (ssize_t)recv((RECV_TYPE_ARG1)(x), \
                                   (RECV_TYPE_ARG2)(y), \
                                   (RECV_TYPE_ARG3)(z), \
                                   (RECV_TYPE_ARG4)(0))
#endif
#else /* HAVE_RECV */
#ifndef sread
  /* */
  Error Missing_definition_of_macro_sread
  /* */
#endif
#endif /* HAVE_RECV */


#if defined(__minix)
/* Minix doesn't support send on TCP sockets */
#define swrite(x,y,z) (ssize_t)write((SEND_TYPE_ARG1)(x), \
                                    (SEND_TYPE_ARG2)(y), \
                                    (SEND_TYPE_ARG3)(z))

#elif defined(HAVE_SEND)
#if !defined(SEND_TYPE_ARG1) || \
    !defined(SEND_QUAL_ARG2) || \
    !defined(SEND_TYPE_ARG2) || \
    !defined(SEND_TYPE_ARG3) || \
    !defined(SEND_TYPE_ARG4) || \
    !defined(SEND_TYPE_RETV)
  /* */
  Error Missing_definition_of_return_and_arguments_types_of_send
  /* */
#else
#define swrite(x,y,z) (ssize_t)send((SEND_TYPE_ARG1)(x), \
                                    (SEND_TYPE_ARG2)(y), \
                                    (SEND_TYPE_ARG3)(z), \
                                    (SEND_TYPE_ARG4)(SEND_4TH_ARG))
#endif
#else /* HAVE_SEND */
#ifndef swrite
  /* */
  Error Missing_definition_of_macro_swrite
  /* */
#endif
#endif /* HAVE_SEND */


#if 0
#if defined(HAVE_RECVFROM)
/*
 * Currently recvfrom is only used on udp sockets.
 */
#if !defined(RECVFROM_TYPE_ARG1) || \
    !defined(RECVFROM_TYPE_ARG2) || \
    !defined(RECVFROM_TYPE_ARG3) || \
    !defined(RECVFROM_TYPE_ARG4) || \
    !defined(RECVFROM_TYPE_ARG5) || \
    !defined(RECVFROM_TYPE_ARG6) || \
    !defined(RECVFROM_TYPE_RETV)
  /* */
  Error Missing_definition_of_return_and_arguments_types_of_recvfrom
  /* */
#else
#define sreadfrom(s,b,bl,f,fl) (ssize_t)recvfrom((RECVFROM_TYPE_ARG1)  (s),  \
                                                 (RECVFROM_TYPE_ARG2 *)(b),  \
                                                 (RECVFROM_TYPE_ARG3)  (bl), \
                                                 (RECVFROM_TYPE_ARG4)  (0),  \
                                                 (RECVFROM_TYPE_ARG5 *)(f),  \
                                                 (RECVFROM_TYPE_ARG6 *)(fl))
#endif
#else /* HAVE_RECVFROM */
#ifndef sreadfrom
  /* */
  Error Missing_definition_of_macro_sreadfrom
  /* */
#endif
#endif /* HAVE_RECVFROM */


#ifdef RECVFROM_TYPE_ARG6_IS_VOID
#  define RECVFROM_ARG6_T int
#else
#  define RECVFROM_ARG6_T RECVFROM_TYPE_ARG6
#endif
#endif /* if 0 */


/*
 * Function-like macro definition used to close a socket.
 */

#if defined(HAVE_CLOSESOCKET)
#  define sclose(x)  closesocket((x))
#elif defined(HAVE_CLOSESOCKET_CAMEL)
#  define sclose(x)  CloseSocket((x))
#elif defined(HAVE_CLOSE_S)
#  define sclose(x)  close_s((x))
#else
#  define sclose(x)  close((x))
#endif


/*
 * Uppercase macro versions of ANSI/ISO is*() functions/macros which
 * avoid negative number inputs with argument byte codes > 127.
 */

#define ISSPACE(x)  (isspace((int)  ((unsigned char)x)))
#define ISDIGIT(x)  (isdigit((int)  ((unsigned char)x)))
#define ISALNUM(x)  (isalnum((int)  ((unsigned char)x)))
#define ISXDIGIT(x) (isxdigit((int) ((unsigned char)x)))
#define ISGRAPH(x)  (isgraph((int)  ((unsigned char)x)))
#define ISALPHA(x)  (isalpha((int)  ((unsigned char)x)))
#define ISPRINT(x)  (isprint((int)  ((unsigned char)x)))
#define ISUPPER(x)  (isupper((int)  ((unsigned char)x)))
#define ISLOWER(x)  (islower((int)  ((unsigned char)x)))
#define ISASCII(x)  (isascii((int)  ((unsigned char)x)))

#define ISBLANK(x)  (int)((((unsigned char)x) == ' ') || \
                          (((unsigned char)x) == '\t'))

#define TOLOWER(x)  (tolower((int)  ((unsigned char)x)))


/*
 * 'bool' stuff compatible with HP-UX headers.
 */

#if defined(__hpux) && !defined(HAVE_BOOL_T)
   typedef int bool;
#  define false 0
#  define true 1
#  define HAVE_BOOL_T
#endif


/*
 * 'bool' exists on platforms with , i.e. C99 platforms.
 * On non-C99 platforms there's no bool, so define an enum for that.
 * On C99 platforms 'false' and 'true' also exist. Enum uses a
 * global namespace though, so use bool_false and bool_true.
 */

#ifndef HAVE_BOOL_T
  typedef enum {
      bool_false = 0,
      bool_true  = 1
  } bool;

/*
 * Use a define to let 'true' and 'false' use those enums.  There
 * are currently no use of true and false in libcurl proper, but
 * there are some in the examples. This will cater for any later
 * code happening to use true and false.
 */
#  define false bool_false
#  define true  bool_true
#  define HAVE_BOOL_T
#endif


/*
 * Redefine TRUE and FALSE too, to catch current use. With this
 * change, 'bool found = 1' will give a warning on MIPSPro, but
 * 'bool found = TRUE' will not. Change tested on IRIX/MIPSPro,
 * AIX 5.1/Xlc, Tru64 5.1/cc, w/make test too.
 */

#ifndef TRUE
#define TRUE true
#endif
#ifndef FALSE
#define FALSE false
#endif


/*
 * Macro WHILE_FALSE may be used to build single-iteration do-while loops,
 * avoiding compiler warnings. Mostly intended for other macro definitions.
 */

#define WHILE_FALSE  while(0)

#if defined(_MSC_VER) && !defined(__POCC__)
#  undef WHILE_FALSE
#  if (_MSC_VER < 1500)
#    define WHILE_FALSE  while(1, 0)
#  else
#    define WHILE_FALSE \
__pragma(warning(push)) \
__pragma(warning(disable:4127)) \
while(0) \
__pragma(warning(pop))
#  endif
#endif


/*
 * Typedef to 'int' if sig_atomic_t is not an available 'typedefed' type.
 */

#ifndef HAVE_SIG_ATOMIC_T
typedef int sig_atomic_t;
#define HAVE_SIG_ATOMIC_T
#endif


/*
 * Convenience SIG_ATOMIC_T definition
 */

#ifdef HAVE_SIG_ATOMIC_T_VOLATILE
#define SIG_ATOMIC_T static sig_atomic_t
#else
#define SIG_ATOMIC_T static volatile sig_atomic_t
#endif


/*
 * Default return type for signal handlers.
 */

#ifndef RETSIGTYPE
#define RETSIGTYPE void
#endif


/*
 * Macro used to include code only in debug builds.
 */

#ifdef DEBUGBUILD
#define DEBUGF(x) x
#else
#define DEBUGF(x) do { } WHILE_FALSE
#endif


/*
 * Macro used to include assertion code only in debug builds.
 */

#if defined(DEBUGBUILD) && defined(HAVE_ASSERT_H)
#define DEBUGASSERT(x) assert(x)
#else
#define DEBUGASSERT(x) do { } WHILE_FALSE
#endif


/*
 * Macro SOCKERRNO / SET_SOCKERRNO() returns / sets the *socket-related* errno
 * (or equivalent) on this platform to hide platform details to code using it.
 */

#ifdef USE_WINSOCK
#define SOCKERRNO         ((int)WSAGetLastError())
#define SET_SOCKERRNO(x)  (WSASetLastError((int)(x)))
#else
#define SOCKERRNO         (errno)
#define SET_SOCKERRNO(x)  (errno = (x))
#endif


/*
 * Macro ERRNO / SET_ERRNO() returns / sets the NOT *socket-related* errno
 * (or equivalent) on this platform to hide platform details to code using it.
 */

#if defined(WIN32) && !defined(WATT32)
#define ERRNO         ((int)GetLastError())
#define SET_ERRNO(x)  (SetLastError((DWORD)(x)))
#else
#define ERRNO         (errno)
#define SET_ERRNO(x)  (errno = (x))
#endif


/*
 * Portable error number symbolic names defined to Winsock error codes.
 */

#ifdef USE_WINSOCK
#undef  EBADF            /* override definition in errno.h */
#define EBADF            WSAEBADF
#undef  EINTR            /* override definition in errno.h */
#define EINTR            WSAEINTR
#undef  EINVAL           /* override definition in errno.h */
#define EINVAL           WSAEINVAL
#undef  EWOULDBLOCK      /* override definition in errno.h */
#define EWOULDBLOCK      WSAEWOULDBLOCK
#undef  EINPROGRESS      /* override definition in errno.h */
#define EINPROGRESS      WSAEINPROGRESS
#undef  EALREADY         /* override definition in errno.h */
#define EALREADY         WSAEALREADY
#undef  ENOTSOCK         /* override definition in errno.h */
#define ENOTSOCK         WSAENOTSOCK
#undef  EDESTADDRREQ     /* override definition in errno.h */
#define EDESTADDRREQ     WSAEDESTADDRREQ
#undef  EMSGSIZE         /* override definition in errno.h */
#define EMSGSIZE         WSAEMSGSIZE
#undef  EPROTOTYPE       /* override definition in errno.h */
#define EPROTOTYPE       WSAEPROTOTYPE
#undef  ENOPROTOOPT      /* override definition in errno.h */
#define ENOPROTOOPT      WSAENOPROTOOPT
#undef  EPROTONOSUPPORT  /* override definition in errno.h */
#define EPROTONOSUPPORT  WSAEPROTONOSUPPORT
#define ESOCKTNOSUPPORT  WSAESOCKTNOSUPPORT
#undef  EOPNOTSUPP       /* override definition in errno.h */
#define EOPNOTSUPP       WSAEOPNOTSUPP
#define EPFNOSUPPORT     WSAEPFNOSUPPORT
#undef  EAFNOSUPPORT     /* override definition in errno.h */
#define EAFNOSUPPORT     WSAEAFNOSUPPORT
#undef  EADDRINUSE       /* override definition in errno.h */
#define EADDRINUSE       WSAEADDRINUSE
#undef  EADDRNOTAVAIL    /* override definition in errno.h */
#define EADDRNOTAVAIL    WSAEADDRNOTAVAIL
#undef  ENETDOWN         /* override definition in errno.h */
#define ENETDOWN         WSAENETDOWN
#undef  ENETUNREACH      /* override definition in errno.h */
#define ENETUNREACH      WSAENETUNREACH
#undef  ENETRESET        /* override definition in errno.h */
#define ENETRESET        WSAENETRESET
#undef  ECONNABORTED     /* override definition in errno.h */
#define ECONNABORTED     WSAECONNABORTED
#undef  ECONNRESET       /* override definition in errno.h */
#define ECONNRESET       WSAECONNRESET
#undef  ENOBUFS          /* override definition in errno.h */
#define ENOBUFS          WSAENOBUFS
#undef  EISCONN          /* override definition in errno.h */
#define EISCONN          WSAEISCONN
#undef  ENOTCONN         /* override definition in errno.h */
#define ENOTCONN         WSAENOTCONN
#define ESHUTDOWN        WSAESHUTDOWN
#define ETOOMANYREFS     WSAETOOMANYREFS
#undef  ETIMEDOUT        /* override definition in errno.h */
#define ETIMEDOUT        WSAETIMEDOUT
#undef  ECONNREFUSED     /* override definition in errno.h */
#define ECONNREFUSED     WSAECONNREFUSED
#undef  ELOOP            /* override definition in errno.h */
#define ELOOP            WSAELOOP
#ifndef ENAMETOOLONG     /* possible previous definition in errno.h */
#define ENAMETOOLONG     WSAENAMETOOLONG
#endif
#define EHOSTDOWN        WSAEHOSTDOWN
#undef  EHOSTUNREACH     /* override definition in errno.h */
#define EHOSTUNREACH     WSAEHOSTUNREACH
#ifndef ENOTEMPTY        /* possible previous definition in errno.h */
#define ENOTEMPTY        WSAENOTEMPTY
#endif
#define EPROCLIM         WSAEPROCLIM
#define EUSERS           WSAEUSERS
#define EDQUOT           WSAEDQUOT
#define ESTALE           WSAESTALE
#define EREMOTE          WSAEREMOTE
#endif


/*
 *  Actually use __32_getpwuid() on 64-bit VMS builds for getpwuid()
 */

#if defined(__VMS) && \
    defined(__INITIAL_POINTER_SIZE) && (__INITIAL_POINTER_SIZE == 64)
#define getpwuid __32_getpwuid
#endif


/*
 * Macro argv_item_t hides platform details to code using it.
 */

#ifdef __VMS
#define argv_item_t  __char_ptr32
#else
#define argv_item_t  char *
#endif


/*
 * We use this ZERO_NULL to avoid picky compiler warnings,
 * when assigning a NULL pointer to a function pointer var.
 */

#define ZERO_NULL 0


#endif /* __SETUP_ONCE_H */
node-v4.8.2/deps/cares/src/TODO000644 000766 000024 00000001327 13070706730 016265 0ustar00iojsstaff000000 000000 TODO
====

ares_reinit()

- To allow an app to force a re-read of /etc/resolv.conf etc, pretty much
  like the res_init() resolver function offers

ares_gethostbyname

- When built to support IPv6, it needs to also support PF_UNSPEC or similar,
  so that an application can ask for any protocol and then c-ares would return
  all known resolves and not just explicitly IPv4 _or_ IPv6 resolves.

ares_process

- Upon next ABI breakage ares_process() should be changed to return 'int'
  and return ARES_ENOTINITIALIZED if ares_library_init() has not been called.

ares_process_fd

- Upon next ABI breakage ares_process_fd() should be changed to return
  'int' and return ARES_ENOTINITIALIZED if library has not been initialized.
node-v4.8.2/deps/cares/src/windows_port.c000644 000766 000024 00000000623 13070706730 020475 0ustar00iojsstaff000000 000000 #include "ares_setup.h"


/* only do the following on windows
 */
#if (defined(WIN32) || defined(WATT32)) && !defined(MSDOS)

#ifdef __WATCOMC__
/*
 * Watcom needs a DllMain() in order to initialise the clib startup code.
 */
BOOL
WINAPI DllMain (HINSTANCE hnd, DWORD reason, LPVOID reserved)
{
  (void) hnd;
  (void) reason;
  (void) reserved;
  return (TRUE);
}
#endif

#endif /* WIN32 builds only */
node-v4.8.2/deps/cares/include/ares.h000644 000766 000024 00000050052 13070706730 017533 0ustar00iojsstaff000000 000000 
/* Copyright 1998 by the Massachusetts Institute of Technology.
 * Copyright (C) 2007-2013 by Daniel Stenberg
 *
 * Permission to use, copy, modify, and distribute this
 * software and its documentation for any purpose and without
 * fee is hereby granted, provided that the above copyright
 * notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting
 * documentation, and that the name of M.I.T. not be used in
 * advertising or publicity pertaining to distribution of the
 * software without specific, written prior permission.
 * M.I.T. makes no representations about the suitability of
 * this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 */

#ifndef ARES__H
#define ARES__H

#include "ares_version.h"  /* c-ares version defines   */

/*
 * Define WIN32 when build target is Win32 API
 */

#if (defined(_WIN32) || defined(__WIN32__)) && \
   !defined(WIN32) && !defined(__SYMBIAN32__)
#  define WIN32
#endif

/* Data type definition of ares_socklen_t. */
typedef unsigned ares_socklen_t;

#include 

/* HP-UX systems version 9, 10 and 11 lack sys/select.h and so does oldish
   libc5-based Linux systems. Only include it on system that are known to
   require it! */
#if defined(_AIX) || defined(__NOVELL_LIBC__) || defined(__NetBSD__) || \
    defined(__minix) || defined(__SYMBIAN32__) || defined(__INTEGRITY) || \
    defined(ANDROID) || defined(__ANDROID__) || defined(__OpenBSD__)
#include 
#endif
#if (defined(NETWARE) && !defined(__NOVELL_LIBC__))
#include 
#endif

#if defined(WATT32)
#  include 
#  include 
#  include 
#elif defined(_WIN32_WCE)
#  ifndef WIN32_LEAN_AND_MEAN
#    define WIN32_LEAN_AND_MEAN
#  endif
#  include 
#  include 
#elif defined(WIN32)
#  ifndef WIN32_LEAN_AND_MEAN
#    define WIN32_LEAN_AND_MEAN
#  endif
#  include 
#  include 
#  include 
#else
#  include 
#  include 
#endif

#ifdef  __cplusplus
extern "C" {
#endif

/*
** c-ares external API function linkage decorations.
*/

#ifdef CARES_STATICLIB
#  define CARES_EXTERN
#elif defined(WIN32) || defined(_WIN32) || defined(__SYMBIAN32__)
#  if defined(CARES_BUILDING_LIBRARY)
#    define CARES_EXTERN  __declspec(dllexport)
#  else
#    define CARES_EXTERN  __declspec(dllimport)
#  endif
#elif defined(CARES_BUILDING_LIBRARY) && defined(CARES_SYMBOL_HIDING)
#  define CARES_EXTERN CARES_SYMBOL_SCOPE_EXTERN
#else
#  define CARES_EXTERN
#endif


#define ARES_SUCCESS            0

/* Server error codes (ARES_ENODATA indicates no relevant answer) */
#define ARES_ENODATA            1
#define ARES_EFORMERR           2
#define ARES_ESERVFAIL          3
#define ARES_ENOTFOUND          4
#define ARES_ENOTIMP            5
#define ARES_EREFUSED           6

/* Locally generated error codes */
#define ARES_EBADQUERY          7
#define ARES_EBADNAME           8
#define ARES_EBADFAMILY         9
#define ARES_EBADRESP           10
#define ARES_ECONNREFUSED       11
#define ARES_ETIMEOUT           12
#define ARES_EOF                13
#define ARES_EFILE              14
#define ARES_ENOMEM             15
#define ARES_EDESTRUCTION       16
#define ARES_EBADSTR            17

/* ares_getnameinfo error codes */
#define ARES_EBADFLAGS          18

/* ares_getaddrinfo error codes */
#define ARES_ENONAME            19
#define ARES_EBADHINTS          20

/* Uninitialized library error code */
#define ARES_ENOTINITIALIZED    21          /* introduced in 1.7.0 */

/* ares_library_init error codes */
#define ARES_ELOADIPHLPAPI           22     /* introduced in 1.7.0 */
#define ARES_EADDRGETNETWORKPARAMS   23     /* introduced in 1.7.0 */

/* More error codes */
#define ARES_ECANCELLED         24          /* introduced in 1.7.0 */

/* Flag values */
#define ARES_FLAG_USEVC         (1 << 0)
#define ARES_FLAG_PRIMARY       (1 << 1)
#define ARES_FLAG_IGNTC         (1 << 2)
#define ARES_FLAG_NORECURSE     (1 << 3)
#define ARES_FLAG_STAYOPEN      (1 << 4)
#define ARES_FLAG_NOSEARCH      (1 << 5)
#define ARES_FLAG_NOALIASES     (1 << 6)
#define ARES_FLAG_NOCHECKRESP   (1 << 7)
#define ARES_FLAG_EDNS          (1 << 8)

/* Option mask values */
#define ARES_OPT_FLAGS          (1 << 0)
#define ARES_OPT_TIMEOUT        (1 << 1)
#define ARES_OPT_TRIES          (1 << 2)
#define ARES_OPT_NDOTS          (1 << 3)
#define ARES_OPT_UDP_PORT       (1 << 4)
#define ARES_OPT_TCP_PORT       (1 << 5)
#define ARES_OPT_SERVERS        (1 << 6)
#define ARES_OPT_DOMAINS        (1 << 7)
#define ARES_OPT_LOOKUPS        (1 << 8)
#define ARES_OPT_SOCK_STATE_CB  (1 << 9)
#define ARES_OPT_SORTLIST       (1 << 10)
#define ARES_OPT_SOCK_SNDBUF    (1 << 11)
#define ARES_OPT_SOCK_RCVBUF    (1 << 12)
#define ARES_OPT_TIMEOUTMS      (1 << 13)
#define ARES_OPT_ROTATE         (1 << 14)
#define ARES_OPT_EDNSPSZ        (1 << 15)

/* Nameinfo flag values */
#define ARES_NI_NOFQDN                  (1 << 0)
#define ARES_NI_NUMERICHOST             (1 << 1)
#define ARES_NI_NAMEREQD                (1 << 2)
#define ARES_NI_NUMERICSERV             (1 << 3)
#define ARES_NI_DGRAM                   (1 << 4)
#define ARES_NI_TCP                     0
#define ARES_NI_UDP                     ARES_NI_DGRAM
#define ARES_NI_SCTP                    (1 << 5)
#define ARES_NI_DCCP                    (1 << 6)
#define ARES_NI_NUMERICSCOPE            (1 << 7)
#define ARES_NI_LOOKUPHOST              (1 << 8)
#define ARES_NI_LOOKUPSERVICE           (1 << 9)
/* Reserved for future use */
#define ARES_NI_IDN                     (1 << 10)
#define ARES_NI_IDN_ALLOW_UNASSIGNED    (1 << 11)
#define ARES_NI_IDN_USE_STD3_ASCII_RULES (1 << 12)

/* Addrinfo flag values */
#define ARES_AI_CANONNAME               (1 << 0)
#define ARES_AI_NUMERICHOST             (1 << 1)
#define ARES_AI_PASSIVE                 (1 << 2)
#define ARES_AI_NUMERICSERV             (1 << 3)
#define ARES_AI_V4MAPPED                (1 << 4)
#define ARES_AI_ALL                     (1 << 5)
#define ARES_AI_ADDRCONFIG              (1 << 6)
/* Reserved for future use */
#define ARES_AI_IDN                     (1 << 10)
#define ARES_AI_IDN_ALLOW_UNASSIGNED    (1 << 11)
#define ARES_AI_IDN_USE_STD3_ASCII_RULES (1 << 12)
#define ARES_AI_CANONIDN                (1 << 13)

#define ARES_AI_MASK (ARES_AI_CANONNAME|ARES_AI_NUMERICHOST|ARES_AI_PASSIVE| \
                      ARES_AI_NUMERICSERV|ARES_AI_V4MAPPED|ARES_AI_ALL| \
                      ARES_AI_ADDRCONFIG)
#define ARES_GETSOCK_MAXNUM 16 /* ares_getsock() can return info about this
                                  many sockets */
#define ARES_GETSOCK_READABLE(bits,num) (bits & (1<< (num)))
#define ARES_GETSOCK_WRITABLE(bits,num) (bits & (1 << ((num) + \
                                         ARES_GETSOCK_MAXNUM)))

/* c-ares library initialization flag values */
#define ARES_LIB_INIT_NONE   (0)
#define ARES_LIB_INIT_WIN32  (1 << 0)
#define ARES_LIB_INIT_ALL    (ARES_LIB_INIT_WIN32)


/*
 * Typedef our socket type
 */

#ifndef ares_socket_typedef
#ifdef WIN32
typedef SOCKET ares_socket_t;
#define ARES_SOCKET_BAD INVALID_SOCKET
#else
typedef int ares_socket_t;
#define ARES_SOCKET_BAD -1
#endif
#define ares_socket_typedef
#endif /* ares_socket_typedef */

typedef void (*ares_sock_state_cb)(void *data,
                                   ares_socket_t socket_fd,
                                   int readable,
                                   int writable);

struct apattern;

/* NOTE about the ares_options struct to users and developers.

   This struct will remain looking like this. It will not be extended nor
   shrunk in future releases, but all new options will be set by ares_set_*()
   options instead of with the ares_init_options() function.

   Eventually (in a galaxy far far away), all options will be settable by
   ares_set_*() options and the ares_init_options() function will become
   deprecated.

   When new options are added to c-ares, they are not added to this
   struct. And they are not "saved" with the ares_save_options() function but
   instead we encourage the use of the ares_dup() function. Needless to say,
   if you add config options to c-ares you need to make sure ares_dup()
   duplicates this new option.

 */
struct ares_options {
  int flags;
  int timeout; /* in seconds or milliseconds, depending on options */
  int tries;
  int ndots;
  unsigned short udp_port;
  unsigned short tcp_port;
  int socket_send_buffer_size;
  int socket_receive_buffer_size;
  struct in_addr *servers;
  int nservers;
  char **domains;
  int ndomains;
  char *lookups;
  ares_sock_state_cb sock_state_cb;
  void *sock_state_cb_data;
  struct apattern *sortlist;
  int nsort;
  int ednspsz;
};

struct hostent;
struct timeval;
struct sockaddr;
struct ares_channeldata;

typedef struct ares_channeldata *ares_channel;

typedef void (*ares_callback)(void *arg,
                              int status,
                              int timeouts,
                              unsigned char *abuf,
                              int alen);

typedef void (*ares_host_callback)(void *arg,
                                   int status,
                                   int timeouts,
                                   struct hostent *hostent);

typedef void (*ares_nameinfo_callback)(void *arg,
                                       int status,
                                       int timeouts,
                                       char *node,
                                       char *service);

typedef int  (*ares_sock_create_callback)(ares_socket_t socket_fd,
                                          int type,
                                          void *data);

CARES_EXTERN int ares_library_init(int flags);

CARES_EXTERN void ares_library_cleanup(void);

CARES_EXTERN const char *ares_version(int *version);

CARES_EXTERN int ares_init(ares_channel *channelptr);

CARES_EXTERN int ares_init_options(ares_channel *channelptr,
                                   struct ares_options *options,
                                   int optmask);

CARES_EXTERN int ares_save_options(ares_channel channel,
                                   struct ares_options *options,
                                   int *optmask);

CARES_EXTERN void ares_destroy_options(struct ares_options *options);

CARES_EXTERN int ares_dup(ares_channel *dest,
                          ares_channel src);

CARES_EXTERN void ares_destroy(ares_channel channel);

CARES_EXTERN void ares_cancel(ares_channel channel);

/* These next 3 configure local binding for the out-going socket
 * connection.  Use these to specify source IP and/or network device
 * on multi-homed systems.
 */
CARES_EXTERN void ares_set_local_ip4(ares_channel channel, unsigned int local_ip);

/* local_ip6 should be 16 bytes in length */
CARES_EXTERN void ares_set_local_ip6(ares_channel channel,
                                     const unsigned char* local_ip6);

/* local_dev_name should be null terminated. */
CARES_EXTERN void ares_set_local_dev(ares_channel channel,
                                     const char* local_dev_name);

CARES_EXTERN void ares_set_socket_callback(ares_channel channel,
                                           ares_sock_create_callback callback,
                                           void *user_data);

CARES_EXTERN void ares_send(ares_channel channel,
                            const unsigned char *qbuf,
                            int qlen,
                            ares_callback callback,
                            void *arg);

CARES_EXTERN void ares_query(ares_channel channel,
                             const char *name,
                             int dnsclass,
                             int type,
                             ares_callback callback,
                             void *arg);

CARES_EXTERN void ares_search(ares_channel channel,
                              const char *name,
                              int dnsclass,
                              int type,
                              ares_callback callback,
                              void *arg);

CARES_EXTERN void ares_gethostbyname(ares_channel channel,
                                     const char *name,
                                     int family,
                                     ares_host_callback callback,
                                     void *arg);

CARES_EXTERN int ares_gethostbyname_file(ares_channel channel,
                                         const char *name,
                                         int family,
                                         struct hostent **host);

CARES_EXTERN void ares_gethostbyaddr(ares_channel channel,
                                     const void *addr,
                                     int addrlen,
                                     int family,
                                     ares_host_callback callback,
                                     void *arg);

CARES_EXTERN void ares_getnameinfo(ares_channel channel,
                                   const struct sockaddr *sa,
                                   ares_socklen_t salen,
                                   int flags,
                                   ares_nameinfo_callback callback,
                                   void *arg);

CARES_EXTERN int ares_fds(ares_channel channel,
                          fd_set *read_fds,
                          fd_set *write_fds);

CARES_EXTERN int ares_getsock(ares_channel channel,
                              ares_socket_t *socks,
                              int numsocks);

CARES_EXTERN struct timeval *ares_timeout(ares_channel channel,
                                          struct timeval *maxtv,
                                          struct timeval *tv);

CARES_EXTERN void ares_process(ares_channel channel,
                               fd_set *read_fds,
                               fd_set *write_fds);

CARES_EXTERN void ares_process_fd(ares_channel channel,
                                  ares_socket_t read_fd,
                                  ares_socket_t write_fd);

CARES_EXTERN int ares_create_query(const char *name,
                                   int dnsclass,
                                   int type,
                                   unsigned short id,
                                   int rd,
                                   unsigned char **buf,
                                   int *buflen,
                                   int max_udp_size);

CARES_EXTERN int ares_mkquery(const char *name,
                              int dnsclass,
                              int type,
                              unsigned short id,
                              int rd,
                              unsigned char **buf,
                              int *buflen);

CARES_EXTERN int ares_expand_name(const unsigned char *encoded,
                                  const unsigned char *abuf,
                                  int alen,
                                  char **s,
                                  long *enclen);

CARES_EXTERN int ares_expand_string(const unsigned char *encoded,
                                    const unsigned char *abuf,
                                    int alen,
                                    unsigned char **s,
                                    long *enclen);

/*
 * NOTE: before c-ares 1.7.0 we would most often use the system in6_addr
 * struct below when ares itself was built, but many apps would use this
 * private version since the header checked a HAVE_* define for it. Starting
 * with 1.7.0 we always declare and use our own to stop relying on the
 * system's one.
 */
struct ares_in6_addr {
  union {
    unsigned char _S6_u8[16];
  } _S6_un;
};

struct ares_addrttl {
  struct in_addr ipaddr;
  int            ttl;
};

struct ares_addr6ttl {
  struct ares_in6_addr ip6addr;
  int             ttl;
};

struct ares_srv_reply {
  struct ares_srv_reply  *next;
  char                   *host;
  unsigned short          priority;
  unsigned short          weight;
  unsigned short          port;
};

struct ares_mx_reply {
  struct ares_mx_reply   *next;
  char                   *host;
  unsigned short          priority;
};

struct ares_txt_reply {
  struct ares_txt_reply  *next;
  unsigned char          *txt;
  size_t                  length;  /* length excludes null termination */
  unsigned char           record_start;  /* 1 - if start of new record
                                          * 0 - if a chunk in the same record */
};

struct ares_naptr_reply {
  struct ares_naptr_reply *next;
  unsigned char           *flags;
  unsigned char           *service;
  unsigned char           *regexp;
  char                    *replacement;
  unsigned short           order;
  unsigned short           preference;
};

struct ares_soa_reply {
  char        *nsname;
  char        *hostmaster;
  unsigned int serial;
  unsigned int refresh;
  unsigned int retry;
  unsigned int expire;
  unsigned int minttl;
};

/*
** Parse the buffer, starting at *abuf and of length alen bytes, previously
** obtained from an ares_search call.  Put the results in *host, if nonnull.
** Also, if addrttls is nonnull, put up to *naddrttls IPv4 addresses along with
** their TTLs in that array, and set *naddrttls to the number of addresses
** so written.
*/

CARES_EXTERN int ares_parse_a_reply(const unsigned char *abuf,
                                    int alen,
                                    struct hostent **host,
                                    struct ares_addrttl *addrttls,
                                    int *naddrttls);

CARES_EXTERN int ares_parse_aaaa_reply(const unsigned char *abuf,
                                       int alen,
                                       struct hostent **host,
                                       struct ares_addr6ttl *addrttls,
                                       int *naddrttls);

CARES_EXTERN int ares_parse_ptr_reply(const unsigned char *abuf,
                                      int alen,
                                      const void *addr,
                                      int addrlen,
                                      int family,
                                      struct hostent **host);

CARES_EXTERN int ares_parse_ns_reply(const unsigned char *abuf,
                                     int alen,
                                     struct hostent **host);

CARES_EXTERN int ares_parse_srv_reply(const unsigned char* abuf,
                                      int alen,
                                      struct ares_srv_reply** srv_out);

CARES_EXTERN int ares_parse_mx_reply(const unsigned char* abuf,
                                      int alen,
                                      struct ares_mx_reply** mx_out);

CARES_EXTERN int ares_parse_txt_reply(const unsigned char* abuf,
                                      int alen,
                                      struct ares_txt_reply** txt_out);

CARES_EXTERN int ares_parse_naptr_reply(const unsigned char* abuf,
                                        int alen,
                                        struct ares_naptr_reply** naptr_out);

CARES_EXTERN int ares_parse_soa_reply(const unsigned char* abuf,
				      int alen,
				      struct ares_soa_reply** soa_out);

CARES_EXTERN void ares_free_string(void *str);

CARES_EXTERN void ares_free_hostent(struct hostent *host);

CARES_EXTERN void ares_free_data(void *dataptr);

CARES_EXTERN const char *ares_strerror(int code);

/* TODO:  Hold port here as well. */
struct ares_addr_node {
  struct ares_addr_node *next;
  int family;
  union {
    struct in_addr       addr4;
    struct ares_in6_addr addr6;
  } addr;
};

CARES_EXTERN int ares_set_servers(ares_channel channel,
                                  struct ares_addr_node *servers);

/* Incomming string format: host[:port][,host[:port]]... */
CARES_EXTERN int ares_set_servers_csv(ares_channel channel,
                                      const char* servers);

CARES_EXTERN int ares_get_servers(ares_channel channel,
                                  struct ares_addr_node **servers);

CARES_EXTERN const char *ares_inet_ntop(int af, const void *src, char *dst,
                                        ares_socklen_t size);

CARES_EXTERN int ares_inet_pton(int af, const char *src, void *dst);


#ifdef  __cplusplus
}
#endif

#endif /* ARES__H */
node-v4.8.2/deps/cares/include/ares_version.h000644 000766 000024 00000001214 13070706730 021274 0ustar00iojsstaff000000 000000 
#ifndef ARES__VERSION_H
#define ARES__VERSION_H

/* This is the global package copyright */
#define ARES_COPYRIGHT "2004 - 2013 Daniel Stenberg, ."

#define ARES_VERSION_MAJOR 1
#define ARES_VERSION_MINOR 10
#define ARES_VERSION_PATCH 1
#define ARES_VERSION ((ARES_VERSION_MAJOR<<16)|\
                       (ARES_VERSION_MINOR<<8)|\
                       (ARES_VERSION_PATCH))
#define ARES_VERSION_STR "1.10.1-DEV"

#if (ARES_VERSION >= 0x010700)
#  define CARES_HAVE_ARES_LIBRARY_INIT 1
#  define CARES_HAVE_ARES_LIBRARY_CLEANUP 1
#else
#  undef CARES_HAVE_ARES_LIBRARY_INIT
#  undef CARES_HAVE_ARES_LIBRARY_CLEANUP
#endif

#endif
node-v4.8.2/deps/cares/include/nameser.h000644 000766 000024 00000020365 13070706730 020237 0ustar00iojsstaff000000 000000 
#ifndef ARES_NAMESER_H
#define ARES_NAMESER_H

/* header file provided by liren@vivisimo.com */

#ifndef HAVE_ARPA_NAMESER_H

#define NS_PACKETSZ     512   /* maximum packet size */
#define NS_MAXDNAME     256   /* maximum domain name */
#define NS_MAXCDNAME    255   /* maximum compressed domain name */
#define NS_MAXLABEL     63
#define NS_HFIXEDSZ     12    /* #/bytes of fixed data in header */
#define NS_QFIXEDSZ     4     /* #/bytes of fixed data in query */
#define NS_RRFIXEDSZ    10    /* #/bytes of fixed data in r record */
#define NS_INT16SZ      2
#define NS_INADDRSZ     4
#define NS_IN6ADDRSZ    16
#define NS_CMPRSFLGS    0xc0  /* Flag bits indicating name compression. */
#define NS_DEFAULTPORT  53    /* For both TCP and UDP. */

typedef enum __ns_class {
    ns_c_invalid = 0,       /* Cookie. */
    ns_c_in = 1,            /* Internet. */
    ns_c_2 = 2,             /* unallocated/unsupported. */
    ns_c_chaos = 3,         /* MIT Chaos-net. */
    ns_c_hs = 4,            /* MIT Hesiod. */
    /* Query class values which do not appear in resource records */
    ns_c_none = 254,        /* for prereq. sections in update requests */
    ns_c_any = 255,         /* Wildcard match. */
    ns_c_max = 65536
} ns_class;

typedef enum __ns_type {
    ns_t_invalid = 0,       /* Cookie. */
    ns_t_a = 1,             /* Host address. */
    ns_t_ns = 2,            /* Authoritative server. */
    ns_t_md = 3,            /* Mail destination. */
    ns_t_mf = 4,            /* Mail forwarder. */
    ns_t_cname = 5,         /* Canonical name. */
    ns_t_soa = 6,           /* Start of authority zone. */
    ns_t_mb = 7,            /* Mailbox domain name. */
    ns_t_mg = 8,            /* Mail group member. */
    ns_t_mr = 9,            /* Mail rename name. */
    ns_t_null = 10,         /* Null resource record. */
    ns_t_wks = 11,          /* Well known service. */
    ns_t_ptr = 12,          /* Domain name pointer. */
    ns_t_hinfo = 13,        /* Host information. */
    ns_t_minfo = 14,        /* Mailbox information. */
    ns_t_mx = 15,           /* Mail routing information. */
    ns_t_txt = 16,          /* Text strings. */
    ns_t_rp = 17,           /* Responsible person. */
    ns_t_afsdb = 18,        /* AFS cell database. */
    ns_t_x25 = 19,          /* X_25 calling address. */
    ns_t_isdn = 20,         /* ISDN calling address. */
    ns_t_rt = 21,           /* Router. */
    ns_t_nsap = 22,         /* NSAP address. */
    ns_t_nsap_ptr = 23,     /* Reverse NSAP lookup (deprecated). */
    ns_t_sig = 24,          /* Security signature. */
    ns_t_key = 25,          /* Security key. */
    ns_t_px = 26,           /* X.400 mail mapping. */
    ns_t_gpos = 27,         /* Geographical position (withdrawn). */
    ns_t_aaaa = 28,         /* Ip6 Address. */
    ns_t_loc = 29,          /* Location Information. */
    ns_t_nxt = 30,          /* Next domain (security). */
    ns_t_eid = 31,          /* Endpoint identifier. */
    ns_t_nimloc = 32,       /* Nimrod Locator. */
    ns_t_srv = 33,          /* Server Selection. */
    ns_t_atma = 34,         /* ATM Address */
    ns_t_naptr = 35,        /* Naming Authority PoinTeR */
    ns_t_kx = 36,           /* Key Exchange */
    ns_t_cert = 37,         /* Certification record */
    ns_t_a6 = 38,           /* IPv6 address (deprecates AAAA) */
    ns_t_dname = 39,        /* Non-terminal DNAME (for IPv6) */
    ns_t_sink = 40,         /* Kitchen sink (experimentatl) */
    ns_t_opt = 41,          /* EDNS0 option (meta-RR) */
    ns_t_apl = 42,          /* Address prefix list (RFC3123) */
    ns_t_ds = 43,           /* Delegation Signer (RFC4034) */
    ns_t_sshfp = 44,        /* SSH Key Fingerprint (RFC4255) */
    ns_t_rrsig = 46,        /* Resource Record Signature (RFC4034) */
    ns_t_nsec = 47,         /* Next Secure (RFC4034) */
    ns_t_dnskey = 48,       /* DNS Public Key (RFC4034) */
    ns_t_tkey = 249,        /* Transaction key */
    ns_t_tsig = 250,        /* Transaction signature. */
    ns_t_ixfr = 251,        /* Incremental zone transfer. */
    ns_t_axfr = 252,        /* Transfer zone of authority. */
    ns_t_mailb = 253,       /* Transfer mailbox records. */
    ns_t_maila = 254,       /* Transfer mail agent records. */
    ns_t_any = 255,         /* Wildcard match. */
    ns_t_zxfr = 256,        /* BIND-specific, nonstandard. */
    ns_t_max = 65536
} ns_type;

typedef enum __ns_opcode {
    ns_o_query = 0,         /* Standard query. */
    ns_o_iquery = 1,        /* Inverse query (deprecated/unsupported). */
    ns_o_status = 2,        /* Name server status query (unsupported). */
                                /* Opcode 3 is undefined/reserved. */
    ns_o_notify = 4,        /* Zone change notification. */
    ns_o_update = 5,        /* Zone update message. */
    ns_o_max = 6
} ns_opcode;

typedef enum __ns_rcode {
    ns_r_noerror = 0,       /* No error occurred. */
    ns_r_formerr = 1,       /* Format error. */
    ns_r_servfail = 2,      /* Server failure. */
    ns_r_nxdomain = 3,      /* Name error. */
    ns_r_notimpl = 4,       /* Unimplemented. */
    ns_r_refused = 5,       /* Operation refused. */
    /* these are for BIND_UPDATE */
    ns_r_yxdomain = 6,      /* Name exists */
    ns_r_yxrrset = 7,       /* RRset exists */
    ns_r_nxrrset = 8,       /* RRset does not exist */
    ns_r_notauth = 9,       /* Not authoritative for zone */
    ns_r_notzone = 10,      /* Zone of record different from zone section */
    ns_r_max = 11,
    /* The following are TSIG extended errors */
    ns_r_badsig = 16,
    ns_r_badkey = 17,
    ns_r_badtime = 18
} ns_rcode;

#endif /* HAVE_ARPA_NAMESER_H */

#ifndef HAVE_ARPA_NAMESER_COMPAT_H

#define PACKETSZ         NS_PACKETSZ
#define MAXDNAME         NS_MAXDNAME
#define MAXCDNAME        NS_MAXCDNAME
#define MAXLABEL         NS_MAXLABEL
#define HFIXEDSZ         NS_HFIXEDSZ
#define QFIXEDSZ         NS_QFIXEDSZ
#define RRFIXEDSZ        NS_RRFIXEDSZ
#define INDIR_MASK       NS_CMPRSFLGS
#define NAMESERVER_PORT  NS_DEFAULTPORT

#define QUERY           ns_o_query

#define SERVFAIL        ns_r_servfail
#define NOTIMP          ns_r_notimpl
#define REFUSED         ns_r_refused
#undef NOERROR /* it seems this is already defined in winerror.h */
#define NOERROR         ns_r_noerror
#define FORMERR         ns_r_formerr
#define NXDOMAIN        ns_r_nxdomain

#define C_IN            ns_c_in
#define C_CHAOS         ns_c_chaos
#define C_HS            ns_c_hs
#define C_NONE          ns_c_none
#define C_ANY           ns_c_any

#define T_A             ns_t_a
#define T_NS            ns_t_ns
#define T_MD            ns_t_md
#define T_MF            ns_t_mf
#define T_CNAME         ns_t_cname
#define T_SOA           ns_t_soa
#define T_MB            ns_t_mb
#define T_MG            ns_t_mg
#define T_MR            ns_t_mr
#define T_NULL          ns_t_null
#define T_WKS           ns_t_wks
#define T_PTR           ns_t_ptr
#define T_HINFO         ns_t_hinfo
#define T_MINFO         ns_t_minfo
#define T_MX            ns_t_mx
#define T_TXT           ns_t_txt
#define T_RP            ns_t_rp
#define T_AFSDB         ns_t_afsdb
#define T_X25           ns_t_x25
#define T_ISDN          ns_t_isdn
#define T_RT            ns_t_rt
#define T_NSAP          ns_t_nsap
#define T_NSAP_PTR      ns_t_nsap_ptr
#define T_SIG           ns_t_sig
#define T_KEY           ns_t_key
#define T_PX            ns_t_px
#define T_GPOS          ns_t_gpos
#define T_AAAA          ns_t_aaaa
#define T_LOC           ns_t_loc
#define T_NXT           ns_t_nxt
#define T_EID           ns_t_eid
#define T_NIMLOC        ns_t_nimloc
#define T_SRV           ns_t_srv
#define T_ATMA          ns_t_atma
#define T_NAPTR         ns_t_naptr
#define T_KX            ns_t_kx
#define T_CERT          ns_t_cert
#define T_A6            ns_t_a6
#define T_DNAME         ns_t_dname
#define T_SINK          ns_t_sink
#define T_OPT           ns_t_opt
#define T_APL           ns_t_apl
#define T_DS            ns_t_ds
#define T_SSHFP         ns_t_sshfp
#define T_RRSIG         ns_t_rrsig
#define T_NSEC          ns_t_nsec
#define T_DNSKEY        ns_t_dnskey
#define T_TKEY          ns_t_tkey
#define T_TSIG          ns_t_tsig
#define T_IXFR          ns_t_ixfr
#define T_AXFR          ns_t_axfr
#define T_MAILB         ns_t_mailb
#define T_MAILA         ns_t_maila
#define T_ANY           ns_t_any

#endif /* HAVE_ARPA_NAMESER_COMPAT_H */

#endif /* ARES_NAMESER_H */
node-v4.8.2/deps/cares/config/aix/000755 000766 000024 00000000000 13070706730 017031 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/cares/config/android/000755 000766 000024 00000000000 13070706730 017670 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/cares/config/cygwin/000755 000766 000024 00000000000 13070706730 017550 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/cares/config/darwin/000755 000766 000024 00000000000 13070706730 017534 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/cares/config/freebsd/000755 000766 000024 00000000000 13070706730 017662 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/cares/config/linux/000755 000766 000024 00000000000 13070706730 017407 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/cares/config/netbsd/000755 000766 000024 00000000000 13070706730 017527 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/cares/config/openbsd/000755 000766 000024 00000000000 13070706730 017702 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/cares/config/sunos/000755 000766 000024 00000000000 13070706730 017417 5ustar00iojsstaff000000 000000 node-v4.8.2/deps/cares/config/sunos/ares_config.h000644 000766 000024 00000034615 13070706730 022060 0ustar00iojsstaff000000 000000 /* ares_config.h.  Generated from ares_config.h.in by configure.  */
/* ares_config.h.in.  Generated from configure.ac by autoheader.  */

/* Define if building universal (internal helper macro) */
/* #undef AC_APPLE_UNIVERSAL_BUILD */

/* define this if ares is built for a big endian system */
/* #undef ARES_BIG_ENDIAN */

/* when building as static part of libcurl */
/* #undef BUILDING_LIBCURL */

/* when building c-ares library */
/* #undef CARES_BUILDING_LIBRARY */

/* when not building a shared library */
/* #undef CARES_STATICLIB */

/* Define to 1 to enable hiding of library internal symbols. */
/* #undef CARES_SYMBOL_HIDING */

/* Definition to make a library symbol externally visible. */
/* #undef CARES_SYMBOL_SCOPE_EXTERN */

/* if a /etc/inet dir is being used */
#define ETC_INET 1

/* Define to the type qualifier of arg 1 for getnameinfo. */
#define GETNAMEINFO_QUAL_ARG1 const

/* Define to the type of arg 1 for getnameinfo. */
#define GETNAMEINFO_TYPE_ARG1 struct sockaddr *

/* Define to the type of arg 2 for getnameinfo. */
#define GETNAMEINFO_TYPE_ARG2 socklen_t

/* Define to the type of args 4 and 6 for getnameinfo. */
#define GETNAMEINFO_TYPE_ARG46 size_t

/* Define to the type of arg 7 for getnameinfo. */
#define GETNAMEINFO_TYPE_ARG7 int

/* Specifies the number of arguments to getservbyport_r */
#define GETSERVBYPORT_R_ARGS 5

/* Specifies the size of the buffer to pass to getservbyport_r */
#define GETSERVBYPORT_R_BUFSIZE 4096

/* Define to 1 if you have AF_INET6. */
#define HAVE_AF_INET6 1

/* Define to 1 if you have the  header file. */
#define HAVE_ARPA_INET_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_ARPA_NAMESER_COMPAT_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_ARPA_NAMESER_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_ASSERT_H 1

/* Define to 1 if you have the `bitncmp' function. */
/* #undef HAVE_BITNCMP */

/* Define to 1 if bool is an available type. */
#define HAVE_BOOL_T 1

/* Define to 1 if you have the clock_gettime function and monotonic timer. */
#define HAVE_CLOCK_GETTIME_MONOTONIC 1

/* Define to 1 if you have the closesocket function. */
/* #undef HAVE_CLOSESOCKET */

/* Define to 1 if you have the CloseSocket camel case function. */
/* #undef HAVE_CLOSESOCKET_CAMEL */

/* Define to 1 if you have the connect function. */
#define HAVE_CONNECT 1

/* Define to 1 if you have the  header file. */
#define HAVE_DLFCN_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_ERRNO_H 1

/* Define to 1 if you have the fcntl function. */
#define HAVE_FCNTL 1

/* Define to 1 if you have the  header file. */
#define HAVE_FCNTL_H 1

/* Define to 1 if you have a working fcntl O_NONBLOCK function. */
#define HAVE_FCNTL_O_NONBLOCK 1

/* Define to 1 if you have the freeaddrinfo function. */
#define HAVE_FREEADDRINFO 1

/* Define to 1 if you have a working getaddrinfo function. */
#define HAVE_GETADDRINFO 1

/* Define to 1 if the getaddrinfo function is threadsafe. */
#define HAVE_GETADDRINFO_THREADSAFE 1

/* Define to 1 if you have the gethostbyaddr function. */
#define HAVE_GETHOSTBYADDR 1

/* Define to 1 if you have the gethostbyname function. */
#define HAVE_GETHOSTBYNAME 1

/* Define to 1 if you have the gethostname function. */
#define HAVE_GETHOSTNAME 1

/* Define to 1 if you have the getnameinfo function. */
#define HAVE_GETNAMEINFO 1

/* Define to 1 if you have the getservbyport_r function. */
#define HAVE_GETSERVBYPORT_R 1

/* Define to 1 if you have the `gettimeofday' function. */
#define HAVE_GETTIMEOFDAY 1

/* Define to 1 if you have the `if_indextoname' function. */
#define HAVE_IF_INDEXTONAME 1

/* Define to 1 if you have the `inet_net_pton' function. */
/* #undef HAVE_INET_NET_PTON */

/* Define to 1 if inet_net_pton supports IPv6. */
/* #undef HAVE_INET_NET_PTON_IPV6 */

/* Define to 1 if you have a IPv6 capable working inet_ntop function. */
#define HAVE_INET_NTOP 1

/* Define to 1 if you have a IPv6 capable working inet_pton function. */
#define HAVE_INET_PTON 1

/* Define to 1 if you have the  header file. */
#define HAVE_INTTYPES_H 1

/* Define to 1 if you have the ioctl function. */
#define HAVE_IOCTL 1

/* Define to 1 if you have the ioctlsocket function. */
/* #undef HAVE_IOCTLSOCKET */

/* Define to 1 if you have the IoctlSocket camel case function. */
/* #undef HAVE_IOCTLSOCKET_CAMEL */

/* Define to 1 if you have a working IoctlSocket camel case FIONBIO function.
   */
/* #undef HAVE_IOCTLSOCKET_CAMEL_FIONBIO */

/* Define to 1 if you have a working ioctlsocket FIONBIO function. */
/* #undef HAVE_IOCTLSOCKET_FIONBIO */

/* Define to 1 if you have a working ioctl FIONBIO function. */
/* #undef HAVE_IOCTL_FIONBIO */

/* Define to 1 if you have a working ioctl SIOCGIFADDR function. */
/* #undef HAVE_IOCTL_SIOCGIFADDR */

/* Define to 1 if you have the `resolve' library (-lresolve). */
/* #undef HAVE_LIBRESOLVE */

/* Define to 1 if you have the  header file. */
#define HAVE_LIMITS_H 1

/* if your compiler supports LL */
#define HAVE_LL 1

/* Define to 1 if the compiler supports the 'long long' data type. */
#define HAVE_LONGLONG 1

/* Define to 1 if you have the malloc.h header file. */
#define HAVE_MALLOC_H 1

/* Define to 1 if you have the memory.h header file. */
#define HAVE_MEMORY_H 1

/* Define to 1 if you have the MSG_NOSIGNAL flag. */
/* #undef HAVE_MSG_NOSIGNAL */

/* Define to 1 if you have the  header file. */
#define HAVE_NETDB_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_NETINET_IN_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_NETINET_TCP_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_NET_IF_H 1

/* Define to 1 if you have PF_INET6. */
#define HAVE_PF_INET6 1

/* Define to 1 if you have the recv function. */
#define HAVE_RECV 1

/* Define to 1 if you have the recvfrom function. */
#define HAVE_RECVFROM 1

/* Define to 1 if you have the send function. */
#define HAVE_SEND 1

/* Define to 1 if you have the setsockopt function. */
#define HAVE_SETSOCKOPT 1

/* Define to 1 if you have a working setsockopt SO_NONBLOCK function. */
/* #undef HAVE_SETSOCKOPT_SO_NONBLOCK */

/* Define to 1 if you have the  header file. */
#define HAVE_SIGNAL_H 1

/* Define to 1 if sig_atomic_t is an available typedef. */
#define HAVE_SIG_ATOMIC_T 1

/* Define to 1 if sig_atomic_t is already defined as volatile. */
/* #undef HAVE_SIG_ATOMIC_T_VOLATILE */

/* Define to 1 if your struct sockaddr_in6 has sin6_scope_id. */
#define HAVE_SOCKADDR_IN6_SIN6_SCOPE_ID 1

/* Define to 1 if you have the socket function. */
#define HAVE_SOCKET 1

/* Define to 1 if you have the  header file. */
/* #undef HAVE_SOCKET_H */

/* Define to 1 if you have the  header file. */
#define HAVE_STDBOOL_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_STDINT_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_STDLIB_H 1

/* Define to 1 if you have the strcasecmp function. */
#define HAVE_STRCASECMP 1

/* Define to 1 if you have the strcmpi function. */
/* #undef HAVE_STRCMPI */

/* Define to 1 if you have the strdup function. */
#define HAVE_STRDUP 1

/* Define to 1 if you have the stricmp function. */
/* #undef HAVE_STRICMP */

/* Define to 1 if you have the  header file. */
#define HAVE_STRINGS_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_STRING_H 1

/* Define to 1 if you have the strncasecmp function. */
#define HAVE_STRNCASECMP 1

/* Define to 1 if you have the strncmpi function. */
/* #undef HAVE_STRNCMPI */

/* Define to 1 if you have the strnicmp function. */
/* #undef HAVE_STRNICMP */

/* Define to 1 if you have the  header file. */
#define HAVE_STROPTS_H 1

/* Define to 1 if you have struct addrinfo. */
#define HAVE_STRUCT_ADDRINFO 1

/* Define to 1 if you have struct in6_addr. */
#define HAVE_STRUCT_IN6_ADDR 1

/* Define to 1 if you have struct sockaddr_in6. */
#define HAVE_STRUCT_SOCKADDR_IN6 1

/* if struct sockaddr_storage is defined */
#define HAVE_STRUCT_SOCKADDR_STORAGE 1

/* Define to 1 if you have the timeval struct. */
#define HAVE_STRUCT_TIMEVAL 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_IOCTL_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_PARAM_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_SELECT_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_SOCKET_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_STAT_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_TIME_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_TYPES_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_UIO_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_TIME_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_UNISTD_H 1

/* Define to 1 if you have the windows.h header file. */
/* #undef HAVE_WINDOWS_H */

/* Define to 1 if you have the winsock2.h header file. */
/* #undef HAVE_WINSOCK2_H */

/* Define to 1 if you have the winsock.h header file. */
/* #undef HAVE_WINSOCK_H */

/* Define to 1 if you have the writev function. */
#define HAVE_WRITEV 1

/* Define to 1 if you have the ws2tcpip.h header file. */
/* #undef HAVE_WS2TCPIP_H */

/* Define to the sub-directory in which libtool stores uninstalled libraries.
   */
#define LT_OBJDIR ".libs/"

/* Define to 1 if you are building a native Windows target. */
/* #undef NATIVE_WINDOWS */

/* Define to 1 if you need the malloc.h header file even with stdlib.h */
/* #undef NEED_MALLOC_H */

/* Define to 1 if you need the memory.h header file even with stdlib.h */
/* #undef NEED_MEMORY_H */

/* Define to 1 if _REENTRANT preprocessor symbol must be defined. */
#define NEED_REENTRANT 1

/* Define to 1 if _THREAD_SAFE preprocessor symbol must be defined. */
/* #undef NEED_THREAD_SAFE */

/* Define to 1 if your C compiler doesn't accept -c and -o together. */
/* #undef NO_MINUS_C_MINUS_O */

/* cpu-machine-OS */
#define OS "i386-pc-solaris2.11"

/* Name of package */
#define PACKAGE "c-ares"

/* Define to the address where bug reports for this package should be sent. */
#define PACKAGE_BUGREPORT "c-ares mailing list => http://cool.haxx.se/mailman/listinfo/c-ares"

/* Define to the full name of this package. */
#define PACKAGE_NAME "c-ares"

/* Define to the full name and version of this package. */
#define PACKAGE_STRING "c-ares 1.7.1"

/* Define to the one symbol short name of this package. */
#define PACKAGE_TARNAME "c-ares"

/* Define to the home page for this package. */
#define PACKAGE_URL ""

/* Define to the version of this package. */
#define PACKAGE_VERSION "1.7.1"

/* a suitable file/device to read random data from */
#define RANDOM_FILE "/dev/urandom"

/* Define to the type of arg 1 for recvfrom. */
#define RECVFROM_TYPE_ARG1 int

/* Define to the type pointed by arg 2 for recvfrom. */
#define RECVFROM_TYPE_ARG2 void

/* Define to 1 if the type pointed by arg 2 for recvfrom is void. */
#define RECVFROM_TYPE_ARG2_IS_VOID 1

/* Define to the type of arg 3 for recvfrom. */
#define RECVFROM_TYPE_ARG3 size_t

/* Define to the type of arg 4 for recvfrom. */
#define RECVFROM_TYPE_ARG4 int

/* Define to the type pointed by arg 5 for recvfrom. */
#define RECVFROM_TYPE_ARG5 struct sockaddr

/* Define to 1 if the type pointed by arg 5 for recvfrom is void. */
/* #undef RECVFROM_TYPE_ARG5_IS_VOID */

/* Define to the type pointed by arg 6 for recvfrom. */
#define RECVFROM_TYPE_ARG6 void

/* Define to 1 if the type pointed by arg 6 for recvfrom is void. */
#define RECVFROM_TYPE_ARG6_IS_VOID 1

/* Define to the function return type for recvfrom. */
#define RECVFROM_TYPE_RETV int

/* Define to the type of arg 1 for recv. */
#define RECV_TYPE_ARG1 int

/* Define to the type of arg 2 for recv. */
#define RECV_TYPE_ARG2 void *

/* Define to the type of arg 3 for recv. */
#define RECV_TYPE_ARG3 size_t

/* Define to the type of arg 4 for recv. */
#define RECV_TYPE_ARG4 int

/* Define to the function return type for recv. */
#define RECV_TYPE_RETV int

/* Define as the return type of signal handlers (`int' or `void'). */
#define RETSIGTYPE void

/* Define to the type qualifier of arg 2 for send. */
#define SEND_QUAL_ARG2 const

/* Define to the type of arg 1 for send. */
#define SEND_TYPE_ARG1 int

/* Define to the type of arg 2 for send. */
#define SEND_TYPE_ARG2 void *

/* Define to the type of arg 3 for send. */
#define SEND_TYPE_ARG3 size_t

/* Define to the type of arg 4 for send. */
#define SEND_TYPE_ARG4 int

/* Define to the function return type for send. */
#define SEND_TYPE_RETV int

/* The size of `int', as computed by sizeof. */
#define SIZEOF_INT 4

/* The size of `long', as computed by sizeof. */
#define SIZEOF_LONG 4

/* The size of `size_t', as computed by sizeof. */
#define SIZEOF_SIZE_T 4

/* The size of `struct in6_addr', as computed by sizeof. */
#define SIZEOF_STRUCT_IN6_ADDR 16

/* The size of `struct in_addr', as computed by sizeof. */
#define SIZEOF_STRUCT_IN_ADDR 4

/* The size of `time_t', as computed by sizeof. */
#define SIZEOF_TIME_T 4

/* Define to 1 if you have the ANSI C header files. */
#define STDC_HEADERS 1

/* Define to 1 if you can safely include both  and . */
#define TIME_WITH_SYS_TIME 1

/* Define to disable non-blocking sockets. */
/* #undef USE_BLOCKING_SOCKETS */

/* Version number of package */
#define VERSION "1.7.1"

/* Define WORDS_BIGENDIAN to 1 if your processor stores words with the most
   significant byte first (like Motorola and SPARC, unlike Intel). */
#if defined AC_APPLE_UNIVERSAL_BUILD
# if defined __BIG_ENDIAN__
#  define WORDS_BIGENDIAN 1
# endif
#else
# ifndef WORDS_BIGENDIAN
/* #  undef WORDS_BIGENDIAN */
# endif
#endif

/* Define to 1 if OS is AIX. */
#ifndef _ALL_SOURCE
/* #  undef _ALL_SOURCE */
#endif

/* Number of bits in a file offset, on hosts where this is settable. */
#define _FILE_OFFSET_BITS 64

/* Define for large files, on AIX-style hosts. */
/* #undef _LARGE_FILES */

/* Define to empty if `const' does not conform to ANSI C. */
/* #undef const */

/* Type to use in place of in_addr_t when system does not provide it. */
/* #undef in_addr_t */

/* Define to `unsigned int' if  does not define. */
/* #undef size_t */

/* the signed version of size_t */
/* #undef ssize_t */

#define HAVE_GETENV 1
node-v4.8.2/deps/cares/config/openbsd/ares_config.h000644 000766 000024 00000034670 13070706730 022344 0ustar00iojsstaff000000 000000 /* ares_config.h.  Generated from ares_config.h.in by configure.  */
/* ares_config.h.in.  Generated from configure.ac by autoheader.  */

/* Define if building universal (internal helper macro) */
/* #undef AC_APPLE_UNIVERSAL_BUILD */

/* define this if ares is built for a big endian system */
/* #undef ARES_BIG_ENDIAN */

/* when building as static part of libcurl */
/* #undef BUILDING_LIBCURL */

/* when building c-ares library */
/* #undef CARES_BUILDING_LIBRARY */

/* when not building a shared library */
/* #undef CARES_STATICLIB */

/* Define to 1 to enable hiding of library internal symbols. */
/* #undef CARES_SYMBOL_HIDING */

/* Definition to make a library symbol externally visible. */
/* #undef CARES_SYMBOL_SCOPE_EXTERN */

/* if a /etc/inet dir is being used */
/* #undef ETC_INET */

/* Define to the type qualifier of arg 1 for getnameinfo. */
#define GETNAMEINFO_QUAL_ARG1 const

/* Define to the type of arg 1 for getnameinfo. */
#define GETNAMEINFO_TYPE_ARG1 struct sockaddr *

/* Define to the type of arg 2 for getnameinfo. */
#define GETNAMEINFO_TYPE_ARG2 socklen_t

/* Define to the type of args 4 and 6 for getnameinfo. */
#define GETNAMEINFO_TYPE_ARG46 size_t

/* Define to the type of arg 7 for getnameinfo. */
#define GETNAMEINFO_TYPE_ARG7 int

/* Specifies the number of arguments to getservbyport_r */
#define GETSERVBYPORT_R_ARGS 4

/* Specifies the size of the buffer to pass to getservbyport_r */
#define GETSERVBYPORT_R_BUFSIZE sizeof(struct servent_data)

/* Define to 1 if you have AF_INET6. */
#define HAVE_AF_INET6 1

/* Define to 1 if you have the  header file. */
#define HAVE_ARPA_INET_H 1

/* Define to 1 if you have the  header file. */
/* #undef HAVE_ARPA_NAMESER_COMPAT_H */

/* Define to 1 if you have the  header file. */
#define HAVE_ARPA_NAMESER_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_ASSERT_H 1

/* Define to 1 if you have the `bitncmp' function. */
/* #undef HAVE_BITNCMP */

/* Define to 1 if bool is an available type. */
#define HAVE_BOOL_T 1

/* Define to 1 if you have the clock_gettime function and monotonic timer. */
#define HAVE_CLOCK_GETTIME_MONOTONIC 1

/* Define to 1 if you have the closesocket function. */
/* #undef HAVE_CLOSESOCKET */

/* Define to 1 if you have the CloseSocket camel case function. */
/* #undef HAVE_CLOSESOCKET_CAMEL */

/* Define to 1 if you have the connect function. */
#define HAVE_CONNECT 1

/* Define to 1 if you have the  header file. */
#define HAVE_DLFCN_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_ERRNO_H 1

/* Define to 1 if you have the fcntl function. */
#define HAVE_FCNTL 1

/* Define to 1 if you have the  header file. */
#define HAVE_FCNTL_H 1

/* Define to 1 if you have a working fcntl O_NONBLOCK function. */
#define HAVE_FCNTL_O_NONBLOCK 1

/* Define to 1 if you have the freeaddrinfo function. */
#define HAVE_FREEADDRINFO 1

/* Define to 1 if you have a working getaddrinfo function. */
#define HAVE_GETADDRINFO 1

/* Define to 1 if the getaddrinfo function is threadsafe. */
/* #undef HAVE_GETADDRINFO_THREADSAFE */

/* Define to 1 if you have the gethostbyaddr function. */
#define HAVE_GETHOSTBYADDR 1

/* Define to 1 if you have the gethostbyname function. */
#define HAVE_GETHOSTBYNAME 1

/* Define to 1 if you have the gethostname function. */
#define HAVE_GETHOSTNAME 1

/* Define to 1 if you have the getnameinfo function. */
#define HAVE_GETNAMEINFO 1

/* Define to 1 if you have the getservbyport_r function. */
#define HAVE_GETSERVBYPORT_R 1

/* Define to 1 if you have the `gettimeofday' function. */
#define HAVE_GETTIMEOFDAY 1

/* Define to 1 if you have the `if_indextoname' function. */
#define HAVE_IF_INDEXTONAME 1

/* Define to 1 if you have the `inet_net_pton' function. */
#define HAVE_INET_NET_PTON 1

/* Define to 1 if inet_net_pton supports IPv6. */
/* #undef HAVE_INET_NET_PTON_IPV6 */

/* Define to 1 if you have a IPv6 capable working inet_ntop function. */
#define HAVE_INET_NTOP 1

/* Define to 1 if you have a IPv6 capable working inet_pton function. */
#define HAVE_INET_PTON 1

/* Define to 1 if you have the  header file. */
#define HAVE_INTTYPES_H 1

/* Define to 1 if you have the ioctl function. */
#define HAVE_IOCTL 1

/* Define to 1 if you have the ioctlsocket function. */
/* #undef HAVE_IOCTLSOCKET */

/* Define to 1 if you have the IoctlSocket camel case function. */
/* #undef HAVE_IOCTLSOCKET_CAMEL */

/* Define to 1 if you have a working IoctlSocket camel case FIONBIO function.
   */
/* #undef HAVE_IOCTLSOCKET_CAMEL_FIONBIO */

/* Define to 1 if you have a working ioctlsocket FIONBIO function. */
/* #undef HAVE_IOCTLSOCKET_FIONBIO */

/* Define to 1 if you have a working ioctl FIONBIO function. */
#define HAVE_IOCTL_FIONBIO 1

/* Define to 1 if you have a working ioctl SIOCGIFADDR function. */
#define HAVE_IOCTL_SIOCGIFADDR 1

/* Define to 1 if you have the `resolve' library (-lresolve). */
/* #undef HAVE_LIBRESOLVE */

/* Define to 1 if you have the  header file. */
#define HAVE_LIMITS_H 1

/* if your compiler supports LL */
#define HAVE_LL 1

/* Define to 1 if the compiler supports the 'long long' data type. */
#define HAVE_LONGLONG 1

/* Define to 1 if you have the malloc.h header file. */
#define HAVE_MALLOC_H 1

/* Define to 1 if you have the memory.h header file. */
#define HAVE_MEMORY_H 1

/* Define to 1 if you have the MSG_NOSIGNAL flag. */
/* #undef HAVE_MSG_NOSIGNAL */

/* Define to 1 if you have the  header file. */
#define HAVE_NETDB_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_NETINET_IN_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_NETINET_TCP_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_NET_IF_H 1

/* Define to 1 if you have PF_INET6. */
#define HAVE_PF_INET6 1

/* Define to 1 if you have the recv function. */
#define HAVE_RECV 1

/* Define to 1 if you have the recvfrom function. */
#define HAVE_RECVFROM 1

/* Define to 1 if you have the send function. */
#define HAVE_SEND 1

/* Define to 1 if you have the setsockopt function. */
#define HAVE_SETSOCKOPT 1

/* Define to 1 if you have a working setsockopt SO_NONBLOCK function. */
/* #undef HAVE_SETSOCKOPT_SO_NONBLOCK */

/* Define to 1 if you have the  header file. */
#define HAVE_SIGNAL_H 1

/* Define to 1 if sig_atomic_t is an available typedef. */
#define HAVE_SIG_ATOMIC_T 1

/* Define to 1 if sig_atomic_t is already defined as volatile. */
/* #undef HAVE_SIG_ATOMIC_T_VOLATILE */

/* Define to 1 if your struct sockaddr_in6 has sin6_scope_id. */
#define HAVE_SOCKADDR_IN6_SIN6_SCOPE_ID 1

/* Define to 1 if you have the socket function. */
#define HAVE_SOCKET 1

/* Define to 1 if you have the  header file. */
/* #undef HAVE_SOCKET_H */

/* Define to 1 if you have the  header file. */
#define HAVE_STDBOOL_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_STDINT_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_STDLIB_H 1

/* Define to 1 if you have the strcasecmp function. */
#define HAVE_STRCASECMP 1

/* Define to 1 if you have the strcmpi function. */
/* #undef HAVE_STRCMPI */

/* Define to 1 if you have the strdup function. */
#define HAVE_STRDUP 1

/* Define to 1 if you have the stricmp function. */
/* #undef HAVE_STRICMP */

/* Define to 1 if you have the  header file. */
#define HAVE_STRINGS_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_STRING_H 1

/* Define to 1 if you have the strncasecmp function. */
#define HAVE_STRNCASECMP 1

/* Define to 1 if you have the strncmpi function. */
/* #undef HAVE_STRNCMPI */

/* Define to 1 if you have the strnicmp function. */
/* #undef HAVE_STRNICMP */

/* Define to 1 if you have the  header file. */
/* #undef HAVE_STROPTS_H */

/* Define to 1 if you have struct addrinfo. */
#define HAVE_STRUCT_ADDRINFO 1

/* Define to 1 if you have struct in6_addr. */
#define HAVE_STRUCT_IN6_ADDR 1

/* Define to 1 if you have struct sockaddr_in6. */
#define HAVE_STRUCT_SOCKADDR_IN6 1

/* if struct sockaddr_storage is defined */
#define HAVE_STRUCT_SOCKADDR_STORAGE 1

/* Define to 1 if you have the timeval struct. */
#define HAVE_STRUCT_TIMEVAL 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_IOCTL_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_PARAM_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_SELECT_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_SOCKET_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_STAT_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_TIME_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_TYPES_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_UIO_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_TIME_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_UNISTD_H 1

/* Define to 1 if you have the windows.h header file. */
/* #undef HAVE_WINDOWS_H */

/* Define to 1 if you have the winsock2.h header file. */
/* #undef HAVE_WINSOCK2_H */

/* Define to 1 if you have the winsock.h header file. */
/* #undef HAVE_WINSOCK_H */

/* Define to 1 if you have the writev function. */
#define HAVE_WRITEV 1

/* Define to 1 if you have the ws2tcpip.h header file. */
/* #undef HAVE_WS2TCPIP_H */

/* Define to the sub-directory in which libtool stores uninstalled libraries.
   */
#define LT_OBJDIR ".libs/"

/* Define to 1 if you are building a native Windows target. */
/* #undef NATIVE_WINDOWS */

/* Define to 1 if you need the malloc.h header file even with stdlib.h */
/* #undef NEED_MALLOC_H */

/* Define to 1 if you need the memory.h header file even with stdlib.h */
/* #undef NEED_MEMORY_H */

/* Define to 1 if _REENTRANT preprocessor symbol must be defined. */
/* #undef NEED_REENTRANT */

/* Define to 1 if _THREAD_SAFE preprocessor symbol must be defined. */
/* #undef NEED_THREAD_SAFE */

/* Define to 1 if your C compiler doesn't accept -c and -o together. */
/* #undef NO_MINUS_C_MINUS_O */

/* cpu-machine-OS */
#define OS "i386-unknown-openbsd4.7"

/* Name of package */
#define PACKAGE "c-ares"

/* Define to the address where bug reports for this package should be sent. */
#define PACKAGE_BUGREPORT "c-ares mailing list => http://cool.haxx.se/mailman/listinfo/c-ares"

/* Define to the full name of this package. */
#define PACKAGE_NAME "c-ares"

/* Define to the full name and version of this package. */
#define PACKAGE_STRING "c-ares 1.7.1"

/* Define to the one symbol short name of this package. */
#define PACKAGE_TARNAME "c-ares"

/* Define to the home page for this package. */
#define PACKAGE_URL ""

/* Define to the version of this package. */
#define PACKAGE_VERSION "1.7.1"

/* a suitable file/device to read random data from */
#define RANDOM_FILE "/dev/urandom"

/* Define to the type of arg 1 for recvfrom. */
#define RECVFROM_TYPE_ARG1 int

/* Define to the type pointed by arg 2 for recvfrom. */
#define RECVFROM_TYPE_ARG2 void

/* Define to 1 if the type pointed by arg 2 for recvfrom is void. */
#define RECVFROM_TYPE_ARG2_IS_VOID 1

/* Define to the type of arg 3 for recvfrom. */
#define RECVFROM_TYPE_ARG3 size_t

/* Define to the type of arg 4 for recvfrom. */
#define RECVFROM_TYPE_ARG4 int

/* Define to the type pointed by arg 5 for recvfrom. */
#define RECVFROM_TYPE_ARG5 struct sockaddr

/* Define to 1 if the type pointed by arg 5 for recvfrom is void. */
/* #undef RECVFROM_TYPE_ARG5_IS_VOID */

/* Define to the type pointed by arg 6 for recvfrom. */
#define RECVFROM_TYPE_ARG6 socklen_t

/* Define to 1 if the type pointed by arg 6 for recvfrom is void. */
/* #undef RECVFROM_TYPE_ARG6_IS_VOID */

/* Define to the function return type for recvfrom. */
#define RECVFROM_TYPE_RETV int

/* Define to the type of arg 1 for recv. */
#define RECV_TYPE_ARG1 int

/* Define to the type of arg 2 for recv. */
#define RECV_TYPE_ARG2 void *

/* Define to the type of arg 3 for recv. */
#define RECV_TYPE_ARG3 size_t

/* Define to the type of arg 4 for recv. */
#define RECV_TYPE_ARG4 int

/* Define to the function return type for recv. */
#define RECV_TYPE_RETV int

/* Define as the return type of signal handlers (`int' or `void'). */
#define RETSIGTYPE void

/* Define to the type qualifier of arg 2 for send. */
#define SEND_QUAL_ARG2 const

/* Define to the type of arg 1 for send. */
#define SEND_TYPE_ARG1 int

/* Define to the type of arg 2 for send. */
#define SEND_TYPE_ARG2 void *

/* Define to the type of arg 3 for send. */
#define SEND_TYPE_ARG3 size_t

/* Define to the type of arg 4 for send. */
#define SEND_TYPE_ARG4 int

/* Define to the function return type for send. */
#define SEND_TYPE_RETV int

/* The size of `int', as computed by sizeof. */
#define SIZEOF_INT 4

/* The size of `long', as computed by sizeof. */
#define SIZEOF_LONG 4

/* The size of `size_t', as computed by sizeof. */
#define SIZEOF_SIZE_T 4

/* The size of `struct in6_addr', as computed by sizeof. */
#define SIZEOF_STRUCT_IN6_ADDR 16

/* The size of `struct in_addr', as computed by sizeof. */
#define SIZEOF_STRUCT_IN_ADDR 4

/* The size of `time_t', as computed by sizeof. */
#define SIZEOF_TIME_T 4

/* Define to 1 if you have the ANSI C header files. */
#define STDC_HEADERS 1

/* Define to 1 if you can safely include both  and . */
#define TIME_WITH_SYS_TIME 1

/* Define to disable non-blocking sockets. */
/* #undef USE_BLOCKING_SOCKETS */

/* Version number of package */
#define VERSION "1.7.1"

/* Define WORDS_BIGENDIAN to 1 if your processor stores words with the most
   significant byte first (like Motorola and SPARC, unlike Intel). */
#if defined AC_APPLE_UNIVERSAL_BUILD
# if defined __BIG_ENDIAN__
#  define WORDS_BIGENDIAN 1
# endif
#else
# ifndef WORDS_BIGENDIAN
/* #  undef WORDS_BIGENDIAN */
# endif
#endif

/* Define to 1 if OS is AIX. */
#ifndef _ALL_SOURCE
/* #  undef _ALL_SOURCE */
#endif

/* Number of bits in a file offset, on hosts where this is settable. */
/* #undef _FILE_OFFSET_BITS */

/* Define for large files, on AIX-style hosts. */
/* #undef _LARGE_FILES */

/* Define to empty if `const' does not conform to ANSI C. */
/* #undef const */

/* Type to use in place of in_addr_t when system does not provide it. */
/* #undef in_addr_t */

/* Define to `unsigned int' if  does not define. */
/* #undef size_t */

/* the signed version of size_t */
/* #undef ssize_t */

#define HAVE_GETENV 1
node-v4.8.2/deps/cares/config/netbsd/ares_config.h000644 000766 000024 00000034670 13070706730 022171 0ustar00iojsstaff000000 000000 /* ares_config.h.  Generated from ares_config.h.in by configure.  */
/* ares_config.h.in.  Generated from configure.ac by autoheader.  */

/* Define if building universal (internal helper macro) */
/* #undef AC_APPLE_UNIVERSAL_BUILD */

/* define this if ares is built for a big endian system */
/* #undef ARES_BIG_ENDIAN */

/* when building as static part of libcurl */
/* #undef BUILDING_LIBCURL */

/* when building c-ares library */
/* #undef CARES_BUILDING_LIBRARY */

/* when not building a shared library */
/* #undef CARES_STATICLIB */

/* Define to 1 to enable hiding of library internal symbols. */
/* #undef CARES_SYMBOL_HIDING */

/* Definition to make a library symbol externally visible. */
/* #undef CARES_SYMBOL_SCOPE_EXTERN */

/* if a /etc/inet dir is being used */
/* #undef ETC_INET */

/* Define to the type qualifier of arg 1 for getnameinfo. */
#define GETNAMEINFO_QUAL_ARG1 const

/* Define to the type of arg 1 for getnameinfo. */
#define GETNAMEINFO_TYPE_ARG1 struct sockaddr *

/* Define to the type of arg 2 for getnameinfo. */
#define GETNAMEINFO_TYPE_ARG2 socklen_t

/* Define to the type of args 4 and 6 for getnameinfo. */
#define GETNAMEINFO_TYPE_ARG46 size_t

/* Define to the type of arg 7 for getnameinfo. */
#define GETNAMEINFO_TYPE_ARG7 int

/* Specifies the number of arguments to getservbyport_r */
#define GETSERVBYPORT_R_ARGS 4

/* Specifies the size of the buffer to pass to getservbyport_r */
#define GETSERVBYPORT_R_BUFSIZE sizeof(struct servent_data)

/* Define to 1 if you have AF_INET6. */
#define HAVE_AF_INET6 1

/* Define to 1 if you have the  header file. */
#define HAVE_ARPA_INET_H 1

/* Define to 1 if you have the  header file. */
/* #undef HAVE_ARPA_NAMESER_COMPAT_H */

/* Define to 1 if you have the  header file. */
#define HAVE_ARPA_NAMESER_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_ASSERT_H 1

/* Define to 1 if you have the `bitncmp' function. */
/* #undef HAVE_BITNCMP */

/* Define to 1 if bool is an available type. */
#define HAVE_BOOL_T 1

/* Define to 1 if you have the clock_gettime function and monotonic timer. */
#define HAVE_CLOCK_GETTIME_MONOTONIC 1

/* Define to 1 if you have the closesocket function. */
/* #undef HAVE_CLOSESOCKET */

/* Define to 1 if you have the CloseSocket camel case function. */
/* #undef HAVE_CLOSESOCKET_CAMEL */

/* Define to 1 if you have the connect function. */
#define HAVE_CONNECT 1

/* Define to 1 if you have the  header file. */
#define HAVE_DLFCN_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_ERRNO_H 1

/* Define to 1 if you have the fcntl function. */
#define HAVE_FCNTL 1

/* Define to 1 if you have the  header file. */
#define HAVE_FCNTL_H 1

/* Define to 1 if you have a working fcntl O_NONBLOCK function. */
#define HAVE_FCNTL_O_NONBLOCK 1

/* Define to 1 if you have the freeaddrinfo function. */
#define HAVE_FREEADDRINFO 1

/* Define to 1 if you have a working getaddrinfo function. */
#define HAVE_GETADDRINFO 1

/* Define to 1 if the getaddrinfo function is threadsafe. */
/* #undef HAVE_GETADDRINFO_THREADSAFE */

/* Define to 1 if you have the gethostbyaddr function. */
#define HAVE_GETHOSTBYADDR 1

/* Define to 1 if you have the gethostbyname function. */
#define HAVE_GETHOSTBYNAME 1

/* Define to 1 if you have the gethostname function. */
#define HAVE_GETHOSTNAME 1

/* Define to 1 if you have the getnameinfo function. */
#define HAVE_GETNAMEINFO 1

/* Define to 1 if you have the getservbyport_r function. */
#define HAVE_GETSERVBYPORT_R 1

/* Define to 1 if you have the `gettimeofday' function. */
#define HAVE_GETTIMEOFDAY 1

/* Define to 1 if you have the `if_indextoname' function. */
#define HAVE_IF_INDEXTONAME 1

/* Define to 1 if you have the `inet_net_pton' function. */
#define HAVE_INET_NET_PTON 1

/* Define to 1 if inet_net_pton supports IPv6. */
/* #undef HAVE_INET_NET_PTON_IPV6 */

/* Define to 1 if you have a IPv6 capable working inet_ntop function. */
#define HAVE_INET_NTOP 1

/* Define to 1 if you have a IPv6 capable working inet_pton function. */
#define HAVE_INET_PTON 1

/* Define to 1 if you have the  header file. */
#define HAVE_INTTYPES_H 1

/* Define to 1 if you have the ioctl function. */
#define HAVE_IOCTL 1

/* Define to 1 if you have the ioctlsocket function. */
/* #undef HAVE_IOCTLSOCKET */

/* Define to 1 if you have the IoctlSocket camel case function. */
/* #undef HAVE_IOCTLSOCKET_CAMEL */

/* Define to 1 if you have a working IoctlSocket camel case FIONBIO function.
   */
/* #undef HAVE_IOCTLSOCKET_CAMEL_FIONBIO */

/* Define to 1 if you have a working ioctlsocket FIONBIO function. */
/* #undef HAVE_IOCTLSOCKET_FIONBIO */

/* Define to 1 if you have a working ioctl FIONBIO function. */
#define HAVE_IOCTL_FIONBIO 1

/* Define to 1 if you have a working ioctl SIOCGIFADDR function. */
#define HAVE_IOCTL_SIOCGIFADDR 1

/* Define to 1 if you have the `resolve' library (-lresolve). */
/* #undef HAVE_LIBRESOLVE */

/* Define to 1 if you have the  header file. */
#define HAVE_LIMITS_H 1

/* if your compiler supports LL */
#define HAVE_LL 1

/* Define to 1 if the compiler supports the 'long long' data type. */
#define HAVE_LONGLONG 1

/* Define to 1 if you have the malloc.h header file. */
#define HAVE_MALLOC_H 1

/* Define to 1 if you have the memory.h header file. */
#define HAVE_MEMORY_H 1

/* Define to 1 if you have the MSG_NOSIGNAL flag. */
/* #undef HAVE_MSG_NOSIGNAL */

/* Define to 1 if you have the  header file. */
#define HAVE_NETDB_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_NETINET_IN_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_NETINET_TCP_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_NET_IF_H 1

/* Define to 1 if you have PF_INET6. */
#define HAVE_PF_INET6 1

/* Define to 1 if you have the recv function. */
#define HAVE_RECV 1

/* Define to 1 if you have the recvfrom function. */
#define HAVE_RECVFROM 1

/* Define to 1 if you have the send function. */
#define HAVE_SEND 1

/* Define to 1 if you have the setsockopt function. */
#define HAVE_SETSOCKOPT 1

/* Define to 1 if you have a working setsockopt SO_NONBLOCK function. */
/* #undef HAVE_SETSOCKOPT_SO_NONBLOCK */

/* Define to 1 if you have the  header file. */
#define HAVE_SIGNAL_H 1

/* Define to 1 if sig_atomic_t is an available typedef. */
#define HAVE_SIG_ATOMIC_T 1

/* Define to 1 if sig_atomic_t is already defined as volatile. */
/* #undef HAVE_SIG_ATOMIC_T_VOLATILE */

/* Define to 1 if your struct sockaddr_in6 has sin6_scope_id. */
#define HAVE_SOCKADDR_IN6_SIN6_SCOPE_ID 1

/* Define to 1 if you have the socket function. */
#define HAVE_SOCKET 1

/* Define to 1 if you have the  header file. */
/* #undef HAVE_SOCKET_H */

/* Define to 1 if you have the  header file. */
#define HAVE_STDBOOL_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_STDINT_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_STDLIB_H 1

/* Define to 1 if you have the strcasecmp function. */
#define HAVE_STRCASECMP 1

/* Define to 1 if you have the strcmpi function. */
/* #undef HAVE_STRCMPI */

/* Define to 1 if you have the strdup function. */
#define HAVE_STRDUP 1

/* Define to 1 if you have the stricmp function. */
/* #undef HAVE_STRICMP */

/* Define to 1 if you have the  header file. */
#define HAVE_STRINGS_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_STRING_H 1

/* Define to 1 if you have the strncasecmp function. */
#define HAVE_STRNCASECMP 1

/* Define to 1 if you have the strncmpi function. */
/* #undef HAVE_STRNCMPI */

/* Define to 1 if you have the strnicmp function. */
/* #undef HAVE_STRNICMP */

/* Define to 1 if you have the  header file. */
/* #undef HAVE_STROPTS_H */

/* Define to 1 if you have struct addrinfo. */
#define HAVE_STRUCT_ADDRINFO 1

/* Define to 1 if you have struct in6_addr. */
#define HAVE_STRUCT_IN6_ADDR 1

/* Define to 1 if you have struct sockaddr_in6. */
#define HAVE_STRUCT_SOCKADDR_IN6 1

/* if struct sockaddr_storage is defined */
#define HAVE_STRUCT_SOCKADDR_STORAGE 1

/* Define to 1 if you have the timeval struct. */
#define HAVE_STRUCT_TIMEVAL 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_IOCTL_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_PARAM_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_SELECT_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_SOCKET_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_STAT_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_TIME_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_TYPES_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_UIO_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_TIME_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_UNISTD_H 1

/* Define to 1 if you have the windows.h header file. */
/* #undef HAVE_WINDOWS_H */

/* Define to 1 if you have the winsock2.h header file. */
/* #undef HAVE_WINSOCK2_H */

/* Define to 1 if you have the winsock.h header file. */
/* #undef HAVE_WINSOCK_H */

/* Define to 1 if you have the writev function. */
#define HAVE_WRITEV 1

/* Define to 1 if you have the ws2tcpip.h header file. */
/* #undef HAVE_WS2TCPIP_H */

/* Define to the sub-directory in which libtool stores uninstalled libraries.
   */
#define LT_OBJDIR ".libs/"

/* Define to 1 if you are building a native Windows target. */
/* #undef NATIVE_WINDOWS */

/* Define to 1 if you need the malloc.h header file even with stdlib.h */
/* #undef NEED_MALLOC_H */

/* Define to 1 if you need the memory.h header file even with stdlib.h */
/* #undef NEED_MEMORY_H */

/* Define to 1 if _REENTRANT preprocessor symbol must be defined. */
/* #undef NEED_REENTRANT */

/* Define to 1 if _THREAD_SAFE preprocessor symbol must be defined. */
/* #undef NEED_THREAD_SAFE */

/* Define to 1 if your C compiler doesn't accept -c and -o together. */
/* #undef NO_MINUS_C_MINUS_O */

/* cpu-machine-OS */
#define OS "i386-unknown-openbsd4.7"

/* Name of package */
#define PACKAGE "c-ares"

/* Define to the address where bug reports for this package should be sent. */
#define PACKAGE_BUGREPORT "c-ares mailing list => http://cool.haxx.se/mailman/listinfo/c-ares"

/* Define to the full name of this package. */
#define PACKAGE_NAME "c-ares"

/* Define to the full name and version of this package. */
#define PACKAGE_STRING "c-ares 1.7.1"

/* Define to the one symbol short name of this package. */
#define PACKAGE_TARNAME "c-ares"

/* Define to the home page for this package. */
#define PACKAGE_URL ""

/* Define to the version of this package. */
#define PACKAGE_VERSION "1.7.1"

/* a suitable file/device to read random data from */
#define RANDOM_FILE "/dev/urandom"

/* Define to the type of arg 1 for recvfrom. */
#define RECVFROM_TYPE_ARG1 int

/* Define to the type pointed by arg 2 for recvfrom. */
#define RECVFROM_TYPE_ARG2 void

/* Define to 1 if the type pointed by arg 2 for recvfrom is void. */
#define RECVFROM_TYPE_ARG2_IS_VOID 1

/* Define to the type of arg 3 for recvfrom. */
#define RECVFROM_TYPE_ARG3 size_t

/* Define to the type of arg 4 for recvfrom. */
#define RECVFROM_TYPE_ARG4 int

/* Define to the type pointed by arg 5 for recvfrom. */
#define RECVFROM_TYPE_ARG5 struct sockaddr

/* Define to 1 if the type pointed by arg 5 for recvfrom is void. */
/* #undef RECVFROM_TYPE_ARG5_IS_VOID */

/* Define to the type pointed by arg 6 for recvfrom. */
#define RECVFROM_TYPE_ARG6 socklen_t

/* Define to 1 if the type pointed by arg 6 for recvfrom is void. */
/* #undef RECVFROM_TYPE_ARG6_IS_VOID */

/* Define to the function return type for recvfrom. */
#define RECVFROM_TYPE_RETV int

/* Define to the type of arg 1 for recv. */
#define RECV_TYPE_ARG1 int

/* Define to the type of arg 2 for recv. */
#define RECV_TYPE_ARG2 void *

/* Define to the type of arg 3 for recv. */
#define RECV_TYPE_ARG3 size_t

/* Define to the type of arg 4 for recv. */
#define RECV_TYPE_ARG4 int

/* Define to the function return type for recv. */
#define RECV_TYPE_RETV int

/* Define as the return type of signal handlers (`int' or `void'). */
#define RETSIGTYPE void

/* Define to the type qualifier of arg 2 for send. */
#define SEND_QUAL_ARG2 const

/* Define to the type of arg 1 for send. */
#define SEND_TYPE_ARG1 int

/* Define to the type of arg 2 for send. */
#define SEND_TYPE_ARG2 void *

/* Define to the type of arg 3 for send. */
#define SEND_TYPE_ARG3 size_t

/* Define to the type of arg 4 for send. */
#define SEND_TYPE_ARG4 int

/* Define to the function return type for send. */
#define SEND_TYPE_RETV int

/* The size of `int', as computed by sizeof. */
#define SIZEOF_INT 4

/* The size of `long', as computed by sizeof. */
#define SIZEOF_LONG 4

/* The size of `size_t', as computed by sizeof. */
#define SIZEOF_SIZE_T 4

/* The size of `struct in6_addr', as computed by sizeof. */
#define SIZEOF_STRUCT_IN6_ADDR 16

/* The size of `struct in_addr', as computed by sizeof. */
#define SIZEOF_STRUCT_IN_ADDR 4

/* The size of `time_t', as computed by sizeof. */
#define SIZEOF_TIME_T 4

/* Define to 1 if you have the ANSI C header files. */
#define STDC_HEADERS 1

/* Define to 1 if you can safely include both  and . */
#define TIME_WITH_SYS_TIME 1

/* Define to disable non-blocking sockets. */
/* #undef USE_BLOCKING_SOCKETS */

/* Version number of package */
#define VERSION "1.7.1"

/* Define WORDS_BIGENDIAN to 1 if your processor stores words with the most
   significant byte first (like Motorola and SPARC, unlike Intel). */
#if defined AC_APPLE_UNIVERSAL_BUILD
# if defined __BIG_ENDIAN__
#  define WORDS_BIGENDIAN 1
# endif
#else
# ifndef WORDS_BIGENDIAN
/* #  undef WORDS_BIGENDIAN */
# endif
#endif

/* Define to 1 if OS is AIX. */
#ifndef _ALL_SOURCE
/* #  undef _ALL_SOURCE */
#endif

/* Number of bits in a file offset, on hosts where this is settable. */
/* #undef _FILE_OFFSET_BITS */

/* Define for large files, on AIX-style hosts. */
/* #undef _LARGE_FILES */

/* Define to empty if `const' does not conform to ANSI C. */
/* #undef const */

/* Type to use in place of in_addr_t when system does not provide it. */
/* #undef in_addr_t */

/* Define to `unsigned int' if  does not define. */
/* #undef size_t */

/* the signed version of size_t */
/* #undef ssize_t */

#define HAVE_GETENV 1
node-v4.8.2/deps/cares/config/linux/ares_config.h000644 000766 000024 00000034672 13070706730 022053 0ustar00iojsstaff000000 000000 /* ares_config.h.  Generated from ares_config.h.in by configure.  */
/* ares_config.h.in.  Generated from configure.ac by autoheader.  */

/* Define if building universal (internal helper macro) */
/* #undef AC_APPLE_UNIVERSAL_BUILD */

/* define this if ares is built for a big endian system */
/* #undef ARES_BIG_ENDIAN */

/* when building as static part of libcurl */
/* #undef BUILDING_LIBCURL */

/* when building c-ares library */
/* #undef CARES_BUILDING_LIBRARY */

/* when not building a shared library */
/* #undef CARES_STATICLIB */

/* Define to 1 to enable hiding of library internal symbols. */
#define CARES_SYMBOL_HIDING 1

/* Definition to make a library symbol externally visible. */
#define CARES_SYMBOL_SCOPE_EXTERN __attribute__ ((visibility ("default")))

/* if a /etc/inet dir is being used */
/* #undef ETC_INET */

/* Define to the type qualifier of arg 1 for getnameinfo. */
#define GETNAMEINFO_QUAL_ARG1 const

/* Define to the type of arg 1 for getnameinfo. */
#define GETNAMEINFO_TYPE_ARG1 struct sockaddr *

/* Define to the type of arg 2 for getnameinfo. */
#define GETNAMEINFO_TYPE_ARG2 socklen_t

/* Define to the type of args 4 and 6 for getnameinfo. */
#define GETNAMEINFO_TYPE_ARG46 size_t

/* Define to the type of arg 7 for getnameinfo. */
#define GETNAMEINFO_TYPE_ARG7 unsigned int

/* Specifies the number of arguments to getservbyport_r */
#define GETSERVBYPORT_R_ARGS 6

/* Specifies the size of the buffer to pass to getservbyport_r */
#define GETSERVBYPORT_R_BUFSIZE 4096

/* Define to 1 if you have AF_INET6. */
#define HAVE_AF_INET6 1

/* Define to 1 if you have the  header file. */
#define HAVE_ARPA_INET_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_ARPA_NAMESER_COMPAT_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_ARPA_NAMESER_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_ASSERT_H 1

/* Define to 1 if you have the `bitncmp' function. */
/* #undef HAVE_BITNCMP */

/* Define to 1 if bool is an available type. */
#define HAVE_BOOL_T 1

/* Define to 1 if you have the clock_gettime function and monotonic timer. */
#define HAVE_CLOCK_GETTIME_MONOTONIC 1

/* Define to 1 if you have the closesocket function. */
/* #undef HAVE_CLOSESOCKET */

/* Define to 1 if you have the CloseSocket camel case function. */
/* #undef HAVE_CLOSESOCKET_CAMEL */

/* Define to 1 if you have the connect function. */
#define HAVE_CONNECT 1

/* Define to 1 if you have the  header file. */
#define HAVE_DLFCN_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_ERRNO_H 1

/* Define to 1 if you have the fcntl function. */
#define HAVE_FCNTL 1

/* Define to 1 if you have the  header file. */
#define HAVE_FCNTL_H 1

/* Define to 1 if you have a working fcntl O_NONBLOCK function. */
#define HAVE_FCNTL_O_NONBLOCK 1

/* Define to 1 if you have the freeaddrinfo function. */
#define HAVE_FREEADDRINFO 1

/* Define to 1 if you have a working getaddrinfo function. */
#define HAVE_GETADDRINFO 1

/* Define to 1 if the getaddrinfo function is threadsafe. */
#define HAVE_GETADDRINFO_THREADSAFE 1

/* Define to 1 if you have the gethostbyaddr function. */
#define HAVE_GETHOSTBYADDR 1

/* Define to 1 if you have the gethostbyname function. */
#define HAVE_GETHOSTBYNAME 1

/* Define to 1 if you have the gethostname function. */
#define HAVE_GETHOSTNAME 1

/* Define to 1 if you have the getnameinfo function. */
#define HAVE_GETNAMEINFO 1

/* Define to 1 if you have the getservbyport_r function. */
#define HAVE_GETSERVBYPORT_R 1

/* Define to 1 if you have the `gettimeofday' function. */
#define HAVE_GETTIMEOFDAY 1

/* Define to 1 if you have the `if_indextoname' function. */
#define HAVE_IF_INDEXTONAME 1

/* Define to 1 if you have the `inet_net_pton' function. */
/* #undef HAVE_INET_NET_PTON */

/* Define to 1 if inet_net_pton supports IPv6. */
/* #undef HAVE_INET_NET_PTON_IPV6 */

/* Define to 1 if you have a IPv6 capable working inet_ntop function. */
#define HAVE_INET_NTOP 1

/* Define to 1 if you have a IPv6 capable working inet_pton function. */
#define HAVE_INET_PTON 1

/* Define to 1 if you have the  header file. */
#define HAVE_INTTYPES_H 1

/* Define to 1 if you have the ioctl function. */
#define HAVE_IOCTL 1

/* Define to 1 if you have the ioctlsocket function. */
/* #undef HAVE_IOCTLSOCKET */

/* Define to 1 if you have the IoctlSocket camel case function. */
/* #undef HAVE_IOCTLSOCKET_CAMEL */

/* Define to 1 if you have a working IoctlSocket camel case FIONBIO function.
   */
/* #undef HAVE_IOCTLSOCKET_CAMEL_FIONBIO */

/* Define to 1 if you have a working ioctlsocket FIONBIO function. */
/* #undef HAVE_IOCTLSOCKET_FIONBIO */

/* Define to 1 if you have a working ioctl FIONBIO function. */
#define HAVE_IOCTL_FIONBIO 1

/* Define to 1 if you have a working ioctl SIOCGIFADDR function. */
#define HAVE_IOCTL_SIOCGIFADDR 1

/* Define to 1 if you have the `resolve' library (-lresolve). */
/* #undef HAVE_LIBRESOLVE */

/* Define to 1 if you have the  header file. */
#define HAVE_LIMITS_H 1

/* if your compiler supports LL */
#define HAVE_LL 1

/* Define to 1 if the compiler supports the 'long long' data type. */
#define HAVE_LONGLONG 1

/* Define to 1 if you have the malloc.h header file. */
#define HAVE_MALLOC_H 1

/* Define to 1 if you have the memory.h header file. */
#define HAVE_MEMORY_H 1

/* Define to 1 if you have the MSG_NOSIGNAL flag. */
#define HAVE_MSG_NOSIGNAL 1

/* Define to 1 if you have the  header file. */
#define HAVE_NETDB_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_NETINET_IN_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_NETINET_TCP_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_NET_IF_H 1

/* Define to 1 if you have PF_INET6. */
#define HAVE_PF_INET6 1

/* Define to 1 if you have the recv function. */
#define HAVE_RECV 1

/* Define to 1 if you have the recvfrom function. */
#define HAVE_RECVFROM 1

/* Define to 1 if you have the send function. */
#define HAVE_SEND 1

/* Define to 1 if you have the setsockopt function. */
#define HAVE_SETSOCKOPT 1

/* Define to 1 if you have a working setsockopt SO_NONBLOCK function. */
/* #undef HAVE_SETSOCKOPT_SO_NONBLOCK */

/* Define to 1 if you have the  header file. */
#define HAVE_SIGNAL_H 1

/* Define to 1 if sig_atomic_t is an available typedef. */
#define HAVE_SIG_ATOMIC_T 1

/* Define to 1 if sig_atomic_t is already defined as volatile. */
/* #undef HAVE_SIG_ATOMIC_T_VOLATILE */

/* Define to 1 if your struct sockaddr_in6 has sin6_scope_id. */
#define HAVE_SOCKADDR_IN6_SIN6_SCOPE_ID 1

/* Define to 1 if you have the socket function. */
#define HAVE_SOCKET 1

/* Define to 1 if you have the  header file. */
/* #undef HAVE_SOCKET_H */

/* Define to 1 if you have the  header file. */
#define HAVE_STDBOOL_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_STDINT_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_STDLIB_H 1

/* Define to 1 if you have the strcasecmp function. */
#define HAVE_STRCASECMP 1

/* Define to 1 if you have the strcmpi function. */
/* #undef HAVE_STRCMPI */

/* Define to 1 if you have the strdup function. */
#define HAVE_STRDUP 1

/* Define to 1 if you have the stricmp function. */
/* #undef HAVE_STRICMP */

/* Define to 1 if you have the  header file. */
#define HAVE_STRINGS_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_STRING_H 1

/* Define to 1 if you have the strncasecmp function. */
#define HAVE_STRNCASECMP 1

/* Define to 1 if you have the strncmpi function. */
/* #undef HAVE_STRNCMPI */

/* Define to 1 if you have the strnicmp function. */
/* #undef HAVE_STRNICMP */

/* Define to 1 if you have the  header file. */
#define HAVE_STROPTS_H 1

/* Define to 1 if you have struct addrinfo. */
#define HAVE_STRUCT_ADDRINFO 1

/* Define to 1 if you have struct in6_addr. */
#define HAVE_STRUCT_IN6_ADDR 1

/* Define to 1 if you have struct sockaddr_in6. */
#define HAVE_STRUCT_SOCKADDR_IN6 1

/* if struct sockaddr_storage is defined */
#define HAVE_STRUCT_SOCKADDR_STORAGE 1

/* Define to 1 if you have the timeval struct. */
#define HAVE_STRUCT_TIMEVAL 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_IOCTL_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_PARAM_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_SELECT_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_SOCKET_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_STAT_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_TIME_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_TYPES_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_UIO_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_TIME_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_UNISTD_H 1

/* Define to 1 if you have the windows.h header file. */
/* #undef HAVE_WINDOWS_H */

/* Define to 1 if you have the winsock2.h header file. */
/* #undef HAVE_WINSOCK2_H */

/* Define to 1 if you have the winsock.h header file. */
/* #undef HAVE_WINSOCK_H */

/* Define to 1 if you have the writev function. */
#define HAVE_WRITEV 1

/* Define to 1 if you have the ws2tcpip.h header file. */
/* #undef HAVE_WS2TCPIP_H */

/* Define to the sub-directory in which libtool stores uninstalled libraries.
   */
#define LT_OBJDIR ".libs/"

/* Define to 1 if you are building a native Windows target. */
/* #undef NATIVE_WINDOWS */

/* Define to 1 if you need the malloc.h header file even with stdlib.h */
/* #undef NEED_MALLOC_H */

/* Define to 1 if you need the memory.h header file even with stdlib.h */
/* #undef NEED_MEMORY_H */

/* Define to 1 if _REENTRANT preprocessor symbol must be defined. */
/* #undef NEED_REENTRANT */

/* Define to 1 if _THREAD_SAFE preprocessor symbol must be defined. */
/* #undef NEED_THREAD_SAFE */

/* Define to 1 if your C compiler doesn't accept -c and -o together. */
/* #undef NO_MINUS_C_MINUS_O */

/* cpu-machine-OS */
#define OS "i686-pc-linux-gnu"

/* Name of package */
#define PACKAGE "c-ares"

/* Define to the address where bug reports for this package should be sent. */
#define PACKAGE_BUGREPORT "c-ares mailing list => http://cool.haxx.se/mailman/listinfo/c-ares"

/* Define to the full name of this package. */
#define PACKAGE_NAME "c-ares"

/* Define to the full name and version of this package. */
#define PACKAGE_STRING "c-ares 1.7.1"

/* Define to the one symbol short name of this package. */
#define PACKAGE_TARNAME "c-ares"

/* Define to the home page for this package. */
#define PACKAGE_URL ""

/* Define to the version of this package. */
#define PACKAGE_VERSION "1.7.1"

/* a suitable file/device to read random data from */
#define RANDOM_FILE "/dev/urandom"

/* Define to the type of arg 1 for recvfrom. */
#define RECVFROM_TYPE_ARG1 int

/* Define to the type pointed by arg 2 for recvfrom. */
#define RECVFROM_TYPE_ARG2 void

/* Define to 1 if the type pointed by arg 2 for recvfrom is void. */
#define RECVFROM_TYPE_ARG2_IS_VOID 1

/* Define to the type of arg 3 for recvfrom. */
#define RECVFROM_TYPE_ARG3 size_t

/* Define to the type of arg 4 for recvfrom. */
#define RECVFROM_TYPE_ARG4 int

/* Define to the type pointed by arg 5 for recvfrom. */
#define RECVFROM_TYPE_ARG5 struct sockaddr

/* Define to 1 if the type pointed by arg 5 for recvfrom is void. */
/* #undef RECVFROM_TYPE_ARG5_IS_VOID */

/* Define to the type pointed by arg 6 for recvfrom. */
#define RECVFROM_TYPE_ARG6 socklen_t

/* Define to 1 if the type pointed by arg 6 for recvfrom is void. */
/* #undef RECVFROM_TYPE_ARG6_IS_VOID */

/* Define to the function return type for recvfrom. */
#define RECVFROM_TYPE_RETV int

/* Define to the type of arg 1 for recv. */
#define RECV_TYPE_ARG1 int

/* Define to the type of arg 2 for recv. */
#define RECV_TYPE_ARG2 void *

/* Define to the type of arg 3 for recv. */
#define RECV_TYPE_ARG3 size_t

/* Define to the type of arg 4 for recv. */
#define RECV_TYPE_ARG4 int

/* Define to the function return type for recv. */
#define RECV_TYPE_RETV int

/* Define as the return type of signal handlers (`int' or `void'). */
#define RETSIGTYPE void

/* Define to the type qualifier of arg 2 for send. */
#define SEND_QUAL_ARG2 const

/* Define to the type of arg 1 for send. */
#define SEND_TYPE_ARG1 int

/* Define to the type of arg 2 for send. */
#define SEND_TYPE_ARG2 void *

/* Define to the type of arg 3 for send. */
#define SEND_TYPE_ARG3 size_t

/* Define to the type of arg 4 for send. */
#define SEND_TYPE_ARG4 int

/* Define to the function return type for send. */
#define SEND_TYPE_RETV int

/* The size of `int', as computed by sizeof. */
#define SIZEOF_INT 4

/* The size of `long', as computed by sizeof. */
#define SIZEOF_LONG 4

/* The size of `size_t', as computed by sizeof. */
#define SIZEOF_SIZE_T 4

/* The size of `struct in6_addr', as computed by sizeof. */
#define SIZEOF_STRUCT_IN6_ADDR 16

/* The size of `struct in_addr', as computed by sizeof. */
#define SIZEOF_STRUCT_IN_ADDR 4

/* The size of `time_t', as computed by sizeof. */
#define SIZEOF_TIME_T 4

/* Define to 1 if you have the ANSI C header files. */
#define STDC_HEADERS 1

/* Define to 1 if you can safely include both  and . */
#define TIME_WITH_SYS_TIME 1

/* Define to disable non-blocking sockets. */
/* #undef USE_BLOCKING_SOCKETS */

/* Version number of package */
#define VERSION "1.7.1"

/* Define WORDS_BIGENDIAN to 1 if your processor stores words with the most
   significant byte first (like Motorola and SPARC, unlike Intel). */
#if defined AC_APPLE_UNIVERSAL_BUILD
# if defined __BIG_ENDIAN__
#  define WORDS_BIGENDIAN 1
# endif
#else
# ifndef WORDS_BIGENDIAN
/* #  undef WORDS_BIGENDIAN */
# endif
#endif

/* Define to 1 if OS is AIX. */
#ifndef _ALL_SOURCE
/* #  undef _ALL_SOURCE */
#endif

/* Number of bits in a file offset, on hosts where this is settable. */
#define _FILE_OFFSET_BITS 64

/* Define for large files, on AIX-style hosts. */
/* #undef _LARGE_FILES */

/* Define to empty if `const' does not conform to ANSI C. */
/* #undef const */

/* Type to use in place of in_addr_t when system does not provide it. */
/* #undef in_addr_t */

/* Define to `unsigned int' if  does not define. */
/* #undef size_t */

/* the signed version of size_t */
/* #undef ssize_t */

#define HAVE_GETENV 1
node-v4.8.2/deps/cares/config/freebsd/ares_config.h000644 000766 000024 00000034674 13070706730 022330 0ustar00iojsstaff000000 000000 /* ares_config.h.  Generated from ares_config.h.in by configure.  */
/* ares_config.h.in.  Generated from configure.ac by autoheader.  */

/* Define if building universal (internal helper macro) */
/* #undef AC_APPLE_UNIVERSAL_BUILD */

/* define this if ares is built for a big endian system */
/* #undef ARES_BIG_ENDIAN */

/* when building as static part of libcurl */
/* #undef BUILDING_LIBCURL */

/* when building c-ares library */
/* #undef CARES_BUILDING_LIBRARY */

/* when not building a shared library */
/* #undef CARES_STATICLIB */

/* Define to 1 to enable hiding of library internal symbols. */
#define CARES_SYMBOL_HIDING 1

/* Definition to make a library symbol externally visible. */
#define CARES_SYMBOL_SCOPE_EXTERN __attribute__ ((visibility ("default")))

/* if a /etc/inet dir is being used */
/* #undef ETC_INET */

/* Define to the type qualifier of arg 1 for getnameinfo. */
#define GETNAMEINFO_QUAL_ARG1 const

/* Define to the type of arg 1 for getnameinfo. */
#define GETNAMEINFO_TYPE_ARG1 struct sockaddr *

/* Define to the type of arg 2 for getnameinfo. */
#define GETNAMEINFO_TYPE_ARG2 socklen_t

/* Define to the type of args 4 and 6 for getnameinfo. */
#define GETNAMEINFO_TYPE_ARG46 size_t

/* Define to the type of arg 7 for getnameinfo. */
#define GETNAMEINFO_TYPE_ARG7 int

/* Specifies the number of arguments to getservbyport_r */
#define GETSERVBYPORT_R_ARGS 6

/* Specifies the size of the buffer to pass to getservbyport_r */
#define GETSERVBYPORT_R_BUFSIZE 4096

/* Define to 1 if you have AF_INET6. */
#define HAVE_AF_INET6 1

/* Define to 1 if you have the  header file. */
#define HAVE_ARPA_INET_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_ARPA_NAMESER_COMPAT_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_ARPA_NAMESER_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_ASSERT_H 1

/* Define to 1 if you have the `bitncmp' function. */
/* #undef HAVE_BITNCMP */

/* Define to 1 if bool is an available type. */
#define HAVE_BOOL_T 1

/* Define to 1 if you have the clock_gettime function and monotonic timer. */
#define HAVE_CLOCK_GETTIME_MONOTONIC 1

/* Define to 1 if you have the closesocket function. */
/* #undef HAVE_CLOSESOCKET */

/* Define to 1 if you have the CloseSocket camel case function. */
/* #undef HAVE_CLOSESOCKET_CAMEL */

/* Define to 1 if you have the connect function. */
#define HAVE_CONNECT 1

/* Define to 1 if you have the  header file. */
#define HAVE_DLFCN_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_ERRNO_H 1

/* Define to 1 if you have the fcntl function. */
#define HAVE_FCNTL 1

/* Define to 1 if you have the  header file. */
#define HAVE_FCNTL_H 1

/* Define to 1 if you have a working fcntl O_NONBLOCK function. */
#define HAVE_FCNTL_O_NONBLOCK 1

/* Define to 1 if you have the freeaddrinfo function. */
#define HAVE_FREEADDRINFO 1

/* Define to 1 if you have a working getaddrinfo function. */
#define HAVE_GETADDRINFO 1

/* Define to 1 if the getaddrinfo function is threadsafe. */
#define HAVE_GETADDRINFO_THREADSAFE 1

/* Define to 1 if you have the gethostbyaddr function. */
#define HAVE_GETHOSTBYADDR 1

/* Define to 1 if you have the gethostbyname function. */
#define HAVE_GETHOSTBYNAME 1

/* Define to 1 if you have the gethostname function. */
#define HAVE_GETHOSTNAME 1

/* Define to 1 if you have the getnameinfo function. */
#define HAVE_GETNAMEINFO 1

/* Define to 1 if you have the getservbyport_r function. */
#define HAVE_GETSERVBYPORT_R 1

/* Define to 1 if you have the `gettimeofday' function. */
#define HAVE_GETTIMEOFDAY 1

/* Define to 1 if you have the `if_indextoname' function. */
#define HAVE_IF_INDEXTONAME 1

/* Define to 1 if you have the `inet_net_pton' function. */
#define HAVE_INET_NET_PTON 1

/* Define to 1 if inet_net_pton supports IPv6. */
/* #undef HAVE_INET_NET_PTON_IPV6 */

/* Define to 1 if you have a IPv6 capable working inet_ntop function. */
#define HAVE_INET_NTOP 1

/* Define to 1 if you have a IPv6 capable working inet_pton function. */
#define HAVE_INET_PTON 1

/* Define to 1 if you have the  header file. */
#define HAVE_INTTYPES_H 1

/* Define to 1 if you have the ioctl function. */
#define HAVE_IOCTL 1

/* Define to 1 if you have the ioctlsocket function. */
/* #undef HAVE_IOCTLSOCKET */

/* Define to 1 if you have the IoctlSocket camel case function. */
/* #undef HAVE_IOCTLSOCKET_CAMEL */

/* Define to 1 if you have a working IoctlSocket camel case FIONBIO function.
   */
/* #undef HAVE_IOCTLSOCKET_CAMEL_FIONBIO */

/* Define to 1 if you have a working ioctlsocket FIONBIO function. */
/* #undef HAVE_IOCTLSOCKET_FIONBIO */

/* Define to 1 if you have a working ioctl FIONBIO function. */
#define HAVE_IOCTL_FIONBIO 1

/* Define to 1 if you have a working ioctl SIOCGIFADDR function. */
#define HAVE_IOCTL_SIOCGIFADDR 1

/* Define to 1 if you have the `resolve' library (-lresolve). */
/* #undef HAVE_LIBRESOLVE */

/* Define to 1 if you have the  header file. */
#define HAVE_LIMITS_H 1

/* if your compiler supports LL */
#define HAVE_LL 1

/* Define to 1 if the compiler supports the 'long long' data type. */
#define HAVE_LONGLONG 1

/* Define to 1 if you have the malloc.h header file. */
/* #undef HAVE_MALLOC_H */

/* Define to 1 if you have the memory.h header file. */
#define HAVE_MEMORY_H 1

/* Define to 1 if you have the MSG_NOSIGNAL flag. */
#define HAVE_MSG_NOSIGNAL 1

/* Define to 1 if you have the  header file. */
#define HAVE_NETDB_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_NETINET_IN_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_NETINET_TCP_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_NET_IF_H 1

/* Define to 1 if you have PF_INET6. */
#define HAVE_PF_INET6 1

/* Define to 1 if you have the recv function. */
#define HAVE_RECV 1

/* Define to 1 if you have the recvfrom function. */
#define HAVE_RECVFROM 1

/* Define to 1 if you have the send function. */
#define HAVE_SEND 1

/* Define to 1 if you have the setsockopt function. */
#define HAVE_SETSOCKOPT 1

/* Define to 1 if you have a working setsockopt SO_NONBLOCK function. */
/* #undef HAVE_SETSOCKOPT_SO_NONBLOCK */

/* Define to 1 if you have the  header file. */
#define HAVE_SIGNAL_H 1

/* Define to 1 if sig_atomic_t is an available typedef. */
#define HAVE_SIG_ATOMIC_T 1

/* Define to 1 if sig_atomic_t is already defined as volatile. */
/* #undef HAVE_SIG_ATOMIC_T_VOLATILE */

/* Define to 1 if your struct sockaddr_in6 has sin6_scope_id. */
#define HAVE_SOCKADDR_IN6_SIN6_SCOPE_ID 1

/* Define to 1 if you have the socket function. */
#define HAVE_SOCKET 1

/* Define to 1 if you have the  header file. */
/* #undef HAVE_SOCKET_H */

/* Define to 1 if you have the  header file. */
#define HAVE_STDBOOL_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_STDINT_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_STDLIB_H 1

/* Define to 1 if you have the strcasecmp function. */
#define HAVE_STRCASECMP 1

/* Define to 1 if you have the strcmpi function. */
/* #undef HAVE_STRCMPI */

/* Define to 1 if you have the strdup function. */
#define HAVE_STRDUP 1

/* Define to 1 if you have the stricmp function. */
/* #undef HAVE_STRICMP */

/* Define to 1 if you have the  header file. */
#define HAVE_STRINGS_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_STRING_H 1

/* Define to 1 if you have the strncasecmp function. */
#define HAVE_STRNCASECMP 1

/* Define to 1 if you have the strncmpi function. */
/* #undef HAVE_STRNCMPI */

/* Define to 1 if you have the strnicmp function. */
/* #undef HAVE_STRNICMP */

/* Define to 1 if you have the  header file. */
/* #undef HAVE_STROPTS_H */

/* Define to 1 if you have struct addrinfo. */
#define HAVE_STRUCT_ADDRINFO 1

/* Define to 1 if you have struct in6_addr. */
#define HAVE_STRUCT_IN6_ADDR 1

/* Define to 1 if you have struct sockaddr_in6. */
#define HAVE_STRUCT_SOCKADDR_IN6 1

/* if struct sockaddr_storage is defined */
#define HAVE_STRUCT_SOCKADDR_STORAGE 1

/* Define to 1 if you have the timeval struct. */
#define HAVE_STRUCT_TIMEVAL 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_IOCTL_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_PARAM_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_SELECT_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_SOCKET_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_STAT_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_TIME_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_TYPES_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_UIO_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_TIME_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_UNISTD_H 1

/* Define to 1 if you have the windows.h header file. */
/* #undef HAVE_WINDOWS_H */

/* Define to 1 if you have the winsock2.h header file. */
/* #undef HAVE_WINSOCK2_H */

/* Define to 1 if you have the winsock.h header file. */
/* #undef HAVE_WINSOCK_H */

/* Define to 1 if you have the writev function. */
#define HAVE_WRITEV 1

/* Define to 1 if you have the ws2tcpip.h header file. */
/* #undef HAVE_WS2TCPIP_H */

/* Define to the sub-directory in which libtool stores uninstalled libraries.
   */
#define LT_OBJDIR ".libs/"

/* Define to 1 if you are building a native Windows target. */
/* #undef NATIVE_WINDOWS */

/* Define to 1 if you need the malloc.h header file even with stdlib.h */
/* #undef NEED_MALLOC_H */

/* Define to 1 if you need the memory.h header file even with stdlib.h */
/* #undef NEED_MEMORY_H */

/* Define to 1 if _REENTRANT preprocessor symbol must be defined. */
/* #undef NEED_REENTRANT */

/* Define to 1 if _THREAD_SAFE preprocessor symbol must be defined. */
/* #undef NEED_THREAD_SAFE */

/* Define to 1 if your C compiler doesn't accept -c and -o together. */
/* #undef NO_MINUS_C_MINUS_O */

/* cpu-machine-OS */
#define OS "i386-portbld-freebsd8.0"

/* Name of package */
#define PACKAGE "c-ares"

/* Define to the address where bug reports for this package should be sent. */
#define PACKAGE_BUGREPORT "c-ares mailing list => http://cool.haxx.se/mailman/listinfo/c-ares"

/* Define to the full name of this package. */
#define PACKAGE_NAME "c-ares"

/* Define to the full name and version of this package. */
#define PACKAGE_STRING "c-ares 1.7.1"

/* Define to the one symbol short name of this package. */
#define PACKAGE_TARNAME "c-ares"

/* Define to the home page for this package. */
#define PACKAGE_URL ""

/* Define to the version of this package. */
#define PACKAGE_VERSION "1.7.1"

/* a suitable file/device to read random data from */
#define RANDOM_FILE "/dev/urandom"

/* Define to the type of arg 1 for recvfrom. */
#define RECVFROM_TYPE_ARG1 int

/* Define to the type pointed by arg 2 for recvfrom. */
#define RECVFROM_TYPE_ARG2 void

/* Define to 1 if the type pointed by arg 2 for recvfrom is void. */
#define RECVFROM_TYPE_ARG2_IS_VOID 1

/* Define to the type of arg 3 for recvfrom. */
#define RECVFROM_TYPE_ARG3 size_t

/* Define to the type of arg 4 for recvfrom. */
#define RECVFROM_TYPE_ARG4 int

/* Define to the type pointed by arg 5 for recvfrom. */
#define RECVFROM_TYPE_ARG5 struct sockaddr

/* Define to 1 if the type pointed by arg 5 for recvfrom is void. */
/* #undef RECVFROM_TYPE_ARG5_IS_VOID */

/* Define to the type pointed by arg 6 for recvfrom. */
#define RECVFROM_TYPE_ARG6 socklen_t

/* Define to 1 if the type pointed by arg 6 for recvfrom is void. */
/* #undef RECVFROM_TYPE_ARG6_IS_VOID */

/* Define to the function return type for recvfrom. */
#define RECVFROM_TYPE_RETV int

/* Define to the type of arg 1 for recv. */
#define RECV_TYPE_ARG1 int

/* Define to the type of arg 2 for recv. */
#define RECV_TYPE_ARG2 void *

/* Define to the type of arg 3 for recv. */
#define RECV_TYPE_ARG3 size_t

/* Define to the type of arg 4 for recv. */
#define RECV_TYPE_ARG4 int

/* Define to the function return type for recv. */
#define RECV_TYPE_RETV int

/* Define as the return type of signal handlers (`int' or `void'). */
#define RETSIGTYPE void

/* Define to the type qualifier of arg 2 for send. */
#define SEND_QUAL_ARG2 const

/* Define to the type of arg 1 for send. */
#define SEND_TYPE_ARG1 int

/* Define to the type of arg 2 for send. */
#define SEND_TYPE_ARG2 void *

/* Define to the type of arg 3 for send. */
#define SEND_TYPE_ARG3 size_t

/* Define to the type of arg 4 for send. */
#define SEND_TYPE_ARG4 int

/* Define to the function return type for send. */
#define SEND_TYPE_RETV int

/* The size of `int', as computed by sizeof. */
#define SIZEOF_INT 4

/* The size of `long', as computed by sizeof. */
#define SIZEOF_LONG 4

/* The size of `size_t', as computed by sizeof. */
#define SIZEOF_SIZE_T 4

/* The size of `struct in6_addr', as computed by sizeof. */
#define SIZEOF_STRUCT_IN6_ADDR 16

/* The size of `struct in_addr', as computed by sizeof. */
#define SIZEOF_STRUCT_IN_ADDR 4

/* The size of `time_t', as computed by sizeof. */
#define SIZEOF_TIME_T 4

/* Define to 1 if you have the ANSI C header files. */
#define STDC_HEADERS 1

/* Define to 1 if you can safely include both  and . */
#define TIME_WITH_SYS_TIME 1

/* Define to disable non-blocking sockets. */
/* #undef USE_BLOCKING_SOCKETS */

/* Version number of package */
#define VERSION "1.7.1"

/* Define WORDS_BIGENDIAN to 1 if your processor stores words with the most
   significant byte first (like Motorola and SPARC, unlike Intel). */
#if defined AC_APPLE_UNIVERSAL_BUILD
# if defined __BIG_ENDIAN__
#  define WORDS_BIGENDIAN 1
# endif
#else
# ifndef WORDS_BIGENDIAN
/* #  undef WORDS_BIGENDIAN */
# endif
#endif

/* Define to 1 if OS is AIX. */
#ifndef _ALL_SOURCE
/* #  undef _ALL_SOURCE */
#endif

/* Number of bits in a file offset, on hosts where this is settable. */
/* #undef _FILE_OFFSET_BITS */

/* Define for large files, on AIX-style hosts. */
/* #undef _LARGE_FILES */

/* Define to empty if `const' does not conform to ANSI C. */
/* #undef const */

/* Type to use in place of in_addr_t when system does not provide it. */
/* #undef in_addr_t */

/* Define to `unsigned int' if  does not define. */
/* #undef size_t */

/* the signed version of size_t */
/* #undef ssize_t */

#define HAVE_GETENV 1
node-v4.8.2/deps/cares/config/darwin/ares_config.h000644 000766 000024 00000034723 13070706730 022175 0ustar00iojsstaff000000 000000 /* ares_config.h.  Generated from ares_config.h.in by configure.  */
/* ares_config.h.in.  Generated from configure.ac by autoheader.  */

/* Define if building universal (internal helper macro) */
/* #undef AC_APPLE_UNIVERSAL_BUILD */

/* define this if ares is built for a big endian system */
/* #undef ARES_BIG_ENDIAN */

/* when building as static part of libcurl */
/* #undef BUILDING_LIBCURL */

/* when building c-ares library */
/* #undef CARES_BUILDING_LIBRARY */

/* when not building a shared library */
/* #undef CARES_STATICLIB */

/* Define to 1 to enable hiding of library internal symbols. */
#define CARES_SYMBOL_HIDING 1

/* Definition to make a library symbol externally visible. */
#define CARES_SYMBOL_SCOPE_EXTERN __attribute__ ((visibility ("default")))

/* if a /etc/inet dir is being used */
/* #undef ETC_INET */

/* Define to the type qualifier of arg 1 for getnameinfo. */
#define GETNAMEINFO_QUAL_ARG1 const

/* Define to the type of arg 1 for getnameinfo. */
#define GETNAMEINFO_TYPE_ARG1 struct sockaddr *

/* Define to the type of arg 2 for getnameinfo. */
#define GETNAMEINFO_TYPE_ARG2 socklen_t

/* Define to the type of args 4 and 6 for getnameinfo. */
#define GETNAMEINFO_TYPE_ARG46 socklen_t

/* Define to the type of arg 7 for getnameinfo. */
#define GETNAMEINFO_TYPE_ARG7 int

/* Specifies the number of arguments to getservbyport_r */
/* #undef GETSERVBYPORT_R_ARGS */

/* Specifies the size of the buffer to pass to getservbyport_r */
/* #undef GETSERVBYPORT_R_BUFSIZE */

/* Define to 1 if you have AF_INET6. */
#define HAVE_AF_INET6 1

/* Define to 1 if you have the  header file. */
#define HAVE_ARPA_INET_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_ARPA_NAMESER_COMPAT_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_ARPA_NAMESER_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_ASSERT_H 1

/* Define to 1 if you have the `bitncmp' function. */
/* #undef HAVE_BITNCMP */

/* Define to 1 if bool is an available type. */
#define HAVE_BOOL_T 1

/* Define to 1 if you have the clock_gettime function and monotonic timer. */
/* #undef HAVE_CLOCK_GETTIME_MONOTONIC */

/* Define to 1 if you have the closesocket function. */
/* #undef HAVE_CLOSESOCKET */

/* Define to 1 if you have the CloseSocket camel case function. */
/* #undef HAVE_CLOSESOCKET_CAMEL */

/* Define to 1 if you have the connect function. */
#define HAVE_CONNECT 1

/* Define to 1 if you have the  header file. */
#define HAVE_DLFCN_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_ERRNO_H 1

/* Define to 1 if you have the fcntl function. */
#define HAVE_FCNTL 1

/* Define to 1 if you have the  header file. */
#define HAVE_FCNTL_H 1

/* Define to 1 if you have a working fcntl O_NONBLOCK function. */
#define HAVE_FCNTL_O_NONBLOCK 1

/* Define to 1 if you have the freeaddrinfo function. */
#define HAVE_FREEADDRINFO 1

/* Define to 1 if you have a working getaddrinfo function. */
#define HAVE_GETADDRINFO 1

/* Define to 1 if the getaddrinfo function is threadsafe. */
#define HAVE_GETADDRINFO_THREADSAFE 1

/* Define to 1 if you have the gethostbyaddr function. */
#define HAVE_GETHOSTBYADDR 1

/* Define to 1 if you have the gethostbyname function. */
#define HAVE_GETHOSTBYNAME 1

/* Define to 1 if you have the gethostname function. */
#define HAVE_GETHOSTNAME 1

/* Define to 1 if you have the getnameinfo function. */
#define HAVE_GETNAMEINFO 1

/* Define to 1 if you have the getservbyport_r function. */
/* #undef HAVE_GETSERVBYPORT_R */

/* Define to 1 if you have the `gettimeofday' function. */
#define HAVE_GETTIMEOFDAY 1

/* Define to 1 if you have the `if_indextoname' function. */
#define HAVE_IF_INDEXTONAME 1

/* Define to 1 if you have the `inet_net_pton' function. */
#define HAVE_INET_NET_PTON 1

/* Define to 1 if inet_net_pton supports IPv6. */
#define HAVE_INET_NET_PTON_IPV6 1

/* Define to 1 if you have a IPv6 capable working inet_ntop function. */
#define HAVE_INET_NTOP 1

/* Define to 1 if you have a IPv6 capable working inet_pton function. */
#define HAVE_INET_PTON 1

/* Define to 1 if you have the  header file. */
#define HAVE_INTTYPES_H 1

/* Define to 1 if you have the ioctl function. */
#define HAVE_IOCTL 1

/* Define to 1 if you have the ioctlsocket function. */
/* #undef HAVE_IOCTLSOCKET */

/* Define to 1 if you have the IoctlSocket camel case function. */
/* #undef HAVE_IOCTLSOCKET_CAMEL */

/* Define to 1 if you have a working IoctlSocket camel case FIONBIO function.
   */
/* #undef HAVE_IOCTLSOCKET_CAMEL_FIONBIO */

/* Define to 1 if you have a working ioctlsocket FIONBIO function. */
/* #undef HAVE_IOCTLSOCKET_FIONBIO */

/* Define to 1 if you have a working ioctl FIONBIO function. */
#define HAVE_IOCTL_FIONBIO 1

/* Define to 1 if you have a working ioctl SIOCGIFADDR function. */
#define HAVE_IOCTL_SIOCGIFADDR 1

/* Define to 1 if you have the `resolve' library (-lresolve). */
/* #undef HAVE_LIBRESOLVE */

/* Define to 1 if you have the  header file. */
#define HAVE_LIMITS_H 1

/* if your compiler supports LL */
#define HAVE_LL 1

/* Define to 1 if the compiler supports the 'long long' data type. */
#define HAVE_LONGLONG 1

/* Define to 1 if you have the malloc.h header file. */
/* #undef HAVE_MALLOC_H */

/* Define to 1 if you have the memory.h header file. */
#define HAVE_MEMORY_H 1

/* Define to 1 if you have the MSG_NOSIGNAL flag. */
/* #undef HAVE_MSG_NOSIGNAL */

/* Define to 1 if you have the  header file. */
#define HAVE_NETDB_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_NETINET_IN_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_NETINET_TCP_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_NET_IF_H 1

/* Define to 1 if you have PF_INET6. */
#define HAVE_PF_INET6 1

/* Define to 1 if you have the recv function. */
#define HAVE_RECV 1

/* Define to 1 if you have the recvfrom function. */
#define HAVE_RECVFROM 1

/* Define to 1 if you have the send function. */
#define HAVE_SEND 1

/* Define to 1 if you have the setsockopt function. */
#define HAVE_SETSOCKOPT 1

/* Define to 1 if you have a working setsockopt SO_NONBLOCK function. */
/* #undef HAVE_SETSOCKOPT_SO_NONBLOCK */

/* Define to 1 if you have the  header file. */
#define HAVE_SIGNAL_H 1

/* Define to 1 if sig_atomic_t is an available typedef. */
#define HAVE_SIG_ATOMIC_T 1

/* Define to 1 if sig_atomic_t is already defined as volatile. */
/* #undef HAVE_SIG_ATOMIC_T_VOLATILE */

/* Define to 1 if your struct sockaddr_in6 has sin6_scope_id. */
#define HAVE_SOCKADDR_IN6_SIN6_SCOPE_ID 1

/* Define to 1 if you have the socket function. */
#define HAVE_SOCKET 1

/* Define to 1 if you have the  header file. */
/* #undef HAVE_SOCKET_H */

/* Define to 1 if you have the  header file. */
#define HAVE_STDBOOL_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_STDINT_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_STDLIB_H 1

/* Define to 1 if you have the strcasecmp function. */
#define HAVE_STRCASECMP 1

/* Define to 1 if you have the strcmpi function. */
/* #undef HAVE_STRCMPI */

/* Define to 1 if you have the strdup function. */
#define HAVE_STRDUP 1

/* Define to 1 if you have the stricmp function. */
/* #undef HAVE_STRICMP */

/* Define to 1 if you have the  header file. */
#define HAVE_STRINGS_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_STRING_H 1

/* Define to 1 if you have the strncasecmp function. */
#define HAVE_STRNCASECMP 1

/* Define to 1 if you have the strncmpi function. */
/* #undef HAVE_STRNCMPI */

/* Define to 1 if you have the strnicmp function. */
/* #undef HAVE_STRNICMP */

/* Define to 1 if you have the  header file. */
/* #undef HAVE_STROPTS_H */

/* Define to 1 if you have struct addrinfo. */
#define HAVE_STRUCT_ADDRINFO 1

/* Define to 1 if you have struct in6_addr. */
#define HAVE_STRUCT_IN6_ADDR 1

/* Define to 1 if you have struct sockaddr_in6. */
#define HAVE_STRUCT_SOCKADDR_IN6 1

/* if struct sockaddr_storage is defined */
#define HAVE_STRUCT_SOCKADDR_STORAGE 1

/* Define to 1 if you have the timeval struct. */
#define HAVE_STRUCT_TIMEVAL 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_IOCTL_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_PARAM_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_SELECT_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_SOCKET_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_STAT_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_TIME_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_TYPES_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_UIO_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_TIME_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_UNISTD_H 1

/* Define to 1 if you have the windows.h header file. */
/* #undef HAVE_WINDOWS_H */

/* Define to 1 if you have the winsock2.h header file. */
/* #undef HAVE_WINSOCK2_H */

/* Define to 1 if you have the winsock.h header file. */
/* #undef HAVE_WINSOCK_H */

/* Define to 1 if you have the writev function. */
#define HAVE_WRITEV 1

/* Define to 1 if you have the ws2tcpip.h header file. */
/* #undef HAVE_WS2TCPIP_H */

/* Define to the sub-directory in which libtool stores uninstalled libraries.
   */
#define LT_OBJDIR ".libs/"

/* Define to 1 if you are building a native Windows target. */
/* #undef NATIVE_WINDOWS */

/* Define to 1 if you need the malloc.h header file even with stdlib.h */
/* #undef NEED_MALLOC_H */

/* Define to 1 if you need the memory.h header file even with stdlib.h */
/* #undef NEED_MEMORY_H */

/* Define to 1 if _REENTRANT preprocessor symbol must be defined. */
/* #undef NEED_REENTRANT */

/* Define to 1 if _THREAD_SAFE preprocessor symbol must be defined. */
/* #undef NEED_THREAD_SAFE */

/* Define to 1 if your C compiler doesn't accept -c and -o together. */
/* #undef NO_MINUS_C_MINUS_O */

/* cpu-machine-OS */
#define OS "i386-apple-darwin9.8.0"

/* Name of package */
#define PACKAGE "c-ares"

/* Define to the address where bug reports for this package should be sent. */
#define PACKAGE_BUGREPORT "c-ares mailing list => http://cool.haxx.se/mailman/listinfo/c-ares"

/* Define to the full name of this package. */
#define PACKAGE_NAME "c-ares"

/* Define to the full name and version of this package. */
#define PACKAGE_STRING "c-ares 1.7.1"

/* Define to the one symbol short name of this package. */
#define PACKAGE_TARNAME "c-ares"

/* Define to the home page for this package. */
#define PACKAGE_URL ""

/* Define to the version of this package. */
#define PACKAGE_VERSION "1.7.1"

/* a suitable file/device to read random data from */
#define RANDOM_FILE "/dev/urandom"

/* Define to the type of arg 1 for recvfrom. */
#define RECVFROM_TYPE_ARG1 int

/* Define to the type pointed by arg 2 for recvfrom. */
#define RECVFROM_TYPE_ARG2 void

/* Define to 1 if the type pointed by arg 2 for recvfrom is void. */
#define RECVFROM_TYPE_ARG2_IS_VOID 1

/* Define to the type of arg 3 for recvfrom. */
#define RECVFROM_TYPE_ARG3 size_t

/* Define to the type of arg 4 for recvfrom. */
#define RECVFROM_TYPE_ARG4 int

/* Define to the type pointed by arg 5 for recvfrom. */
#define RECVFROM_TYPE_ARG5 struct sockaddr

/* Define to 1 if the type pointed by arg 5 for recvfrom is void. */
/* #undef RECVFROM_TYPE_ARG5_IS_VOID */

/* Define to the type pointed by arg 6 for recvfrom. */
#define RECVFROM_TYPE_ARG6 socklen_t

/* Define to 1 if the type pointed by arg 6 for recvfrom is void. */
/* #undef RECVFROM_TYPE_ARG6_IS_VOID */

/* Define to the function return type for recvfrom. */
#define RECVFROM_TYPE_RETV ssize_t

/* Define to the type of arg 1 for recv. */
#define RECV_TYPE_ARG1 int

/* Define to the type of arg 2 for recv. */
#define RECV_TYPE_ARG2 void *

/* Define to the type of arg 3 for recv. */
#define RECV_TYPE_ARG3 size_t

/* Define to the type of arg 4 for recv. */
#define RECV_TYPE_ARG4 int

/* Define to the function return type for recv. */
#define RECV_TYPE_RETV ssize_t

/* Define as the return type of signal handlers (`int' or `void'). */
#define RETSIGTYPE void

/* Define to the type qualifier of arg 2 for send. */
#define SEND_QUAL_ARG2 const

/* Define to the type of arg 1 for send. */
#define SEND_TYPE_ARG1 int

/* Define to the type of arg 2 for send. */
#define SEND_TYPE_ARG2 void *

/* Define to the type of arg 3 for send. */
#define SEND_TYPE_ARG3 size_t

/* Define to the type of arg 4 for send. */
#define SEND_TYPE_ARG4 int

/* Define to the function return type for send. */
#define SEND_TYPE_RETV ssize_t

/* The size of `int', as computed by sizeof. */
#define SIZEOF_INT 4

/* The size of `long', as computed by sizeof. */
#define SIZEOF_LONG 4

/* The size of `size_t', as computed by sizeof. */
#define SIZEOF_SIZE_T 4

/* The size of `struct in6_addr', as computed by sizeof. */
#define SIZEOF_STRUCT_IN6_ADDR 16

/* The size of `struct in_addr', as computed by sizeof. */
#define SIZEOF_STRUCT_IN_ADDR 4

/* The size of `time_t', as computed by sizeof. */
#define SIZEOF_TIME_T 4

/* Define to 1 if you have the ANSI C header files. */
#define STDC_HEADERS 1

/* Define to 1 if you can safely include both  and . */
#define TIME_WITH_SYS_TIME 1

/* Define to disable non-blocking sockets. */
/* #undef USE_BLOCKING_SOCKETS */

/* Version number of package */
#define VERSION "1.7.1"

/* Define WORDS_BIGENDIAN to 1 if your processor stores words with the most
   significant byte first (like Motorola and SPARC, unlike Intel). */
#if defined AC_APPLE_UNIVERSAL_BUILD
# if defined __BIG_ENDIAN__
#  define WORDS_BIGENDIAN 1
# endif
#else
# ifndef WORDS_BIGENDIAN
/* #  undef WORDS_BIGENDIAN */
# endif
#endif

/* Define to 1 if OS is AIX. */
#ifndef _ALL_SOURCE
/* #  undef _ALL_SOURCE */
#endif

/* Number of bits in a file offset, on hosts where this is settable. */
/* #undef _FILE_OFFSET_BITS */

/* Define for large files, on AIX-style hosts. */
/* #undef _LARGE_FILES */

/* Define to empty if `const' does not conform to ANSI C. */
/* #undef const */

/* Type to use in place of in_addr_t when system does not provide it. */
/* #undef in_addr_t */

/* Define to `unsigned int' if  does not define. */
/* #undef size_t */

/* the signed version of size_t */
/* #undef ssize_t */

#define HAVE_GETENV 1
node-v4.8.2/deps/cares/config/cygwin/ares_config.h000644 000766 000024 00000034674 13070706730 022216 0ustar00iojsstaff000000 000000 /* ares_config.h.  Generated from ares_config.h.in by configure.  */
/* ares_config.h.in.  Generated from configure.ac by autoheader.  */

/* Define if building universal (internal helper macro) */
/* #undef AC_APPLE_UNIVERSAL_BUILD */

/* define this if ares is built for a big endian system */
/* #undef ARES_BIG_ENDIAN */

/* when building as static part of libcurl */
/* #undef BUILDING_LIBCURL */

/* when building c-ares library */
/* #undef CARES_BUILDING_LIBRARY */

/* when not building a shared library */
/* #undef CARES_STATICLIB */

/* Define to 1 to enable hiding of library internal symbols. */
#define CARES_SYMBOL_HIDING 1

/* Definition to make a library symbol externally visible. */
#define CARES_SYMBOL_SCOPE_EXTERN __attribute__ ((visibility ("default")))

/* if a /etc/inet dir is being used */
/* #undef ETC_INET */

/* Define to the type qualifier of arg 1 for getnameinfo. */
#define GETNAMEINFO_QUAL_ARG1 const

/* Define to the type of arg 1 for getnameinfo. */
#define GETNAMEINFO_TYPE_ARG1 struct sockaddr *

/* Define to the type of arg 2 for getnameinfo. */
#define GETNAMEINFO_TYPE_ARG2 socklen_t

/* Define to the type of args 4 and 6 for getnameinfo. */
#define GETNAMEINFO_TYPE_ARG46 int

/* Define to the type of arg 7 for getnameinfo. */
#define GETNAMEINFO_TYPE_ARG7 int

/* Specifies the number of arguments to getservbyport_r */
/* #undef GETSERVBYPORT_R_ARGS */

/* Specifies the size of the buffer to pass to getservbyport_r */
/* #undef GETSERVBYPORT_R_BUFSIZE */

/* Define to 1 if you have AF_INET6. */
#define HAVE_AF_INET6 1

/* Define to 1 if you have the  header file. */
#define HAVE_ARPA_INET_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_ARPA_NAMESER_COMPAT_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_ARPA_NAMESER_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_ASSERT_H 1

/* Define to 1 if you have the `bitncmp' function. */
/* #undef HAVE_BITNCMP */

/* Define to 1 if bool is an available type. */
#define HAVE_BOOL_T 1

/* Define to 1 if you have the clock_gettime function and monotonic timer. */
/* #undef HAVE_CLOCK_GETTIME_MONOTONIC */

/* Define to 1 if you have the closesocket function. */
/* #undef HAVE_CLOSESOCKET */

/* Define to 1 if you have the CloseSocket camel case function. */
/* #undef HAVE_CLOSESOCKET_CAMEL */

/* Define to 1 if you have the connect function. */
#define HAVE_CONNECT 1

/* Define to 1 if you have the  header file. */
#define HAVE_DLFCN_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_ERRNO_H 1

/* Define to 1 if you have the fcntl function. */
#define HAVE_FCNTL 1

/* Define to 1 if you have the  header file. */
#define HAVE_FCNTL_H 1

/* Define to 1 if you have a working fcntl O_NONBLOCK function. */
#define HAVE_FCNTL_O_NONBLOCK 1

/* Define to 1 if you have the freeaddrinfo function. */
#define HAVE_FREEADDRINFO 1

/* Define to 1 if you have a working getaddrinfo function. */
#define HAVE_GETADDRINFO 1

/* Define to 1 if the getaddrinfo function is threadsafe. */
/* #undef HAVE_GETADDRINFO_THREADSAFE */

/* Define to 1 if you have the gethostbyaddr function. */
#define HAVE_GETHOSTBYADDR 1

/* Define to 1 if you have the gethostbyname function. */
#define HAVE_GETHOSTBYNAME 1

/* Define to 1 if you have the gethostname function. */
#define HAVE_GETHOSTNAME 1

/* Define to 1 if you have the getnameinfo function. */
#define HAVE_GETNAMEINFO 1

/* Define to 1 if you have the getservbyport_r function. */
/* #undef HAVE_GETSERVBYPORT_R */

/* Define to 1 if you have the `gettimeofday' function. */
#define HAVE_GETTIMEOFDAY 1

/* Define to 1 if you have the `if_indextoname' function. */
#define HAVE_IF_INDEXTONAME 1

/* Define to 1 if you have the `inet_net_pton' function. */
/* #undef HAVE_INET_NET_PTON */

/* Define to 1 if inet_net_pton supports IPv6. */
/* #undef HAVE_INET_NET_PTON_IPV6 */

/* Define to 1 if you have a IPv6 capable working inet_ntop function. */
#define HAVE_INET_NTOP 1

/* Define to 1 if you have a IPv6 capable working inet_pton function. */
#define HAVE_INET_PTON 1

/* Define to 1 if you have the  header file. */
#define HAVE_INTTYPES_H 1

/* Define to 1 if you have the ioctl function. */
#define HAVE_IOCTL 1

/* Define to 1 if you have the ioctlsocket function. */
/* #undef HAVE_IOCTLSOCKET */

/* Define to 1 if you have the IoctlSocket camel case function. */
/* #undef HAVE_IOCTLSOCKET_CAMEL */

/* Define to 1 if you have a working IoctlSocket camel case FIONBIO function.
   */
/* #undef HAVE_IOCTLSOCKET_CAMEL_FIONBIO */

/* Define to 1 if you have a working ioctlsocket FIONBIO function. */
/* #undef HAVE_IOCTLSOCKET_FIONBIO */

/* Define to 1 if you have a working ioctl FIONBIO function. */
#define HAVE_IOCTL_FIONBIO 1

/* Define to 1 if you have a working ioctl SIOCGIFADDR function. */
#define HAVE_IOCTL_SIOCGIFADDR 1

/* Define to 1 if you have the `resolve' library (-lresolve). */
/* #undef HAVE_LIBRESOLVE */

/* Define to 1 if you have the  header file. */
#define HAVE_LIMITS_H 1

/* if your compiler supports LL */
#define HAVE_LL 1

/* Define to 1 if the compiler supports the 'long long' data type. */
#define HAVE_LONGLONG 1

/* Define to 1 if you have the malloc.h header file. */
#define HAVE_MALLOC_H 1

/* Define to 1 if you have the memory.h header file. */
#define HAVE_MEMORY_H 1

/* Define to 1 if you have the MSG_NOSIGNAL flag. */
#define HAVE_MSG_NOSIGNAL 1

/* Define to 1 if you have the  header file. */
#define HAVE_NETDB_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_NETINET_IN_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_NETINET_TCP_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_NET_IF_H 1

/* Define to 1 if you have PF_INET6. */
#define HAVE_PF_INET6 1

/* Define to 1 if you have the recv function. */
#define HAVE_RECV 1

/* Define to 1 if you have the recvfrom function. */
#define HAVE_RECVFROM 1

/* Define to 1 if you have the send function. */
#define HAVE_SEND 1

/* Define to 1 if you have the setsockopt function. */
#define HAVE_SETSOCKOPT 1

/* Define to 1 if you have a working setsockopt SO_NONBLOCK function. */
/* #undef HAVE_SETSOCKOPT_SO_NONBLOCK */

/* Define to 1 if you have the  header file. */
#define HAVE_SIGNAL_H 1

/* Define to 1 if sig_atomic_t is an available typedef. */
#define HAVE_SIG_ATOMIC_T 1

/* Define to 1 if sig_atomic_t is already defined as volatile. */
/* #undef HAVE_SIG_ATOMIC_T_VOLATILE */

/* Define to 1 if your struct sockaddr_in6 has sin6_scope_id. */
#define HAVE_SOCKADDR_IN6_SIN6_SCOPE_ID 1

/* Define to 1 if you have the socket function. */
#define HAVE_SOCKET 1

/* Define to 1 if you have the  header file. */
/* #undef HAVE_SOCKET_H */

/* Define to 1 if you have the  header file. */
#define HAVE_STDBOOL_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_STDINT_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_STDLIB_H 1

/* Define to 1 if you have the strcasecmp function. */
#define HAVE_STRCASECMP 1

/* Define to 1 if you have the strcmpi function. */
/* #undef HAVE_STRCMPI */

/* Define to 1 if you have the strdup function. */
#define HAVE_STRDUP 1

/* Define to 1 if you have the stricmp function. */
/* #undef HAVE_STRICMP */

/* Define to 1 if you have the  header file. */
#define HAVE_STRINGS_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_STRING_H 1

/* Define to 1 if you have the strncasecmp function. */
#define HAVE_STRNCASECMP 1

/* Define to 1 if you have the strncmpi function. */
/* #undef HAVE_STRNCMPI */

/* Define to 1 if you have the strnicmp function. */
/* #undef HAVE_STRNICMP */

/* Define to 1 if you have the  header file. */
/* #undef HAVE_STROPTS_H */

/* Define to 1 if you have struct addrinfo. */
#define HAVE_STRUCT_ADDRINFO 1

/* Define to 1 if you have struct in6_addr. */
#define HAVE_STRUCT_IN6_ADDR 1

/* Define to 1 if you have struct sockaddr_in6. */
#define HAVE_STRUCT_SOCKADDR_IN6 1

/* if struct sockaddr_storage is defined */
#define HAVE_STRUCT_SOCKADDR_STORAGE 1

/* Define to 1 if you have the timeval struct. */
#define HAVE_STRUCT_TIMEVAL 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_IOCTL_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_PARAM_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_SELECT_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_SOCKET_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_STAT_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_TIME_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_TYPES_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_UIO_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_TIME_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_UNISTD_H 1

/* Define to 1 if you have the windows.h header file. */
/* #undef HAVE_WINDOWS_H */

/* Define to 1 if you have the winsock2.h header file. */
/* #undef HAVE_WINSOCK2_H */

/* Define to 1 if you have the winsock.h header file. */
/* #undef HAVE_WINSOCK_H */

/* Define to 1 if you have the writev function. */
#define HAVE_WRITEV 1

/* Define to 1 if you have the ws2tcpip.h header file. */
/* #undef HAVE_WS2TCPIP_H */

/* Define to the sub-directory in which libtool stores uninstalled libraries.
   */
#define LT_OBJDIR ".libs/"

/* Define to 1 if you are building a native Windows target. */
/* #undef NATIVE_WINDOWS */

/* Define to 1 if you need the malloc.h header file even with stdlib.h */
/* #undef NEED_MALLOC_H */

/* Define to 1 if you need the memory.h header file even with stdlib.h */
/* #undef NEED_MEMORY_H */

/* Define to 1 if _REENTRANT preprocessor symbol must be defined. */
/* #undef NEED_REENTRANT */

/* Define to 1 if _THREAD_SAFE preprocessor symbol must be defined. */
/* #undef NEED_THREAD_SAFE */

/* Define to 1 if your C compiler doesn't accept -c and -o together. */
/* #undef NO_MINUS_C_MINUS_O */

/* cpu-machine-OS */
#define OS "i686-pc-cygwin"

/* Name of package */
#define PACKAGE "c-ares"

/* Define to the address where bug reports for this package should be sent. */
#define PACKAGE_BUGREPORT "c-ares mailing list => http://cool.haxx.se/mailman/listinfo/c-ares"

/* Define to the full name of this package. */
#define PACKAGE_NAME "c-ares"

/* Define to the full name and version of this package. */
#define PACKAGE_STRING "c-ares 1.7.1"

/* Define to the one symbol short name of this package. */
#define PACKAGE_TARNAME "c-ares"

/* Define to the home page for this package. */
#define PACKAGE_URL ""

/* Define to the version of this package. */
#define PACKAGE_VERSION "1.7.1"

/* a suitable file/device to read random data from */
#define RANDOM_FILE "/dev/urandom"

/* Define to the type of arg 1 for recvfrom. */
#define RECVFROM_TYPE_ARG1 int

/* Define to the type pointed by arg 2 for recvfrom. */
#define RECVFROM_TYPE_ARG2 void

/* Define to 1 if the type pointed by arg 2 for recvfrom is void. */
#define RECVFROM_TYPE_ARG2_IS_VOID 1

/* Define to the type of arg 3 for recvfrom. */
#define RECVFROM_TYPE_ARG3 size_t

/* Define to the type of arg 4 for recvfrom. */
#define RECVFROM_TYPE_ARG4 int

/* Define to the type pointed by arg 5 for recvfrom. */
#define RECVFROM_TYPE_ARG5 struct sockaddr

/* Define to 1 if the type pointed by arg 5 for recvfrom is void. */
/* #undef RECVFROM_TYPE_ARG5_IS_VOID */

/* Define to the type pointed by arg 6 for recvfrom. */
#define RECVFROM_TYPE_ARG6 socklen_t

/* Define to 1 if the type pointed by arg 6 for recvfrom is void. */
/* #undef RECVFROM_TYPE_ARG6_IS_VOID */

/* Define to the function return type for recvfrom. */
#define RECVFROM_TYPE_RETV int

/* Define to the type of arg 1 for recv. */
#define RECV_TYPE_ARG1 int

/* Define to the type of arg 2 for recv. */
#define RECV_TYPE_ARG2 void *

/* Define to the type of arg 3 for recv. */
#define RECV_TYPE_ARG3 size_t

/* Define to the type of arg 4 for recv. */
#define RECV_TYPE_ARG4 int

/* Define to the function return type for recv. */
#define RECV_TYPE_RETV int

/* Define as the return type of signal handlers (`int' or `void'). */
#define RETSIGTYPE void

/* Define to the type qualifier of arg 2 for send. */
#define SEND_QUAL_ARG2 const

/* Define to the type of arg 1 for send. */
#define SEND_TYPE_ARG1 int

/* Define to the type of arg 2 for send. */
#define SEND_TYPE_ARG2 void *

/* Define to the type of arg 3 for send. */
#define SEND_TYPE_ARG3 size_t

/* Define to the type of arg 4 for send. */
#define SEND_TYPE_ARG4 int

/* Define to the function return type for send. */
#define SEND_TYPE_RETV int

/* The size of `int', as computed by sizeof. */
#define SIZEOF_INT 4

/* The size of `long', as computed by sizeof. */
#define SIZEOF_LONG 4

/* The size of `size_t', as computed by sizeof. */
#define SIZEOF_SIZE_T 4

/* The size of `struct in6_addr', as computed by sizeof. */
#define SIZEOF_STRUCT_IN6_ADDR 16

/* The size of `struct in_addr', as computed by sizeof. */
#define SIZEOF_STRUCT_IN_ADDR 4

/* The size of `time_t', as computed by sizeof. */
#define SIZEOF_TIME_T 4

/* Define to 1 if you have the ANSI C header files. */
#define STDC_HEADERS 1

/* Define to 1 if you can safely include both  and . */
#define TIME_WITH_SYS_TIME 1

/* Define to disable non-blocking sockets. */
/* #undef USE_BLOCKING_SOCKETS */

/* Version number of package */
#define VERSION "1.7.1"

/* Define WORDS_BIGENDIAN to 1 if your processor stores words with the most
   significant byte first (like Motorola and SPARC, unlike Intel). */
#if defined AC_APPLE_UNIVERSAL_BUILD
# if defined __BIG_ENDIAN__
#  define WORDS_BIGENDIAN 1
# endif
#else
# ifndef WORDS_BIGENDIAN
/* #  undef WORDS_BIGENDIAN */
# endif
#endif

/* Define to 1 if OS is AIX. */
#ifndef _ALL_SOURCE
/* #  undef _ALL_SOURCE */
#endif

/* Number of bits in a file offset, on hosts where this is settable. */
/* #undef _FILE_OFFSET_BITS */

/* Define for large files, on AIX-style hosts. */
/* #undef _LARGE_FILES */

/* Define to empty if `const' does not conform to ANSI C. */
/* #undef const */

/* Type to use in place of in_addr_t when system does not provide it. */
/* #undef in_addr_t */

/* Define to `unsigned int' if  does not define. */
/* #undef size_t */

/* the signed version of size_t */
/* #undef ssize_t */

#define HAVE_GETENV 1
node-v4.8.2/deps/cares/config/android/ares_config.h000644 000766 000024 00000034676 13070706730 022340 0ustar00iojsstaff000000 000000 /* ares_config.h.  Generated from ares_config.h.in by configure.  */
/* ares_config.h.in.  Generated from configure.ac by autoheader.  */

/* Define if building universal (internal helper macro) */
/* #undef AC_APPLE_UNIVERSAL_BUILD */

/* define this if ares is built for a big endian system */
/* #undef ARES_BIG_ENDIAN */

/* when building as static part of libcurl */
/* #undef BUILDING_LIBCURL */

/* when building c-ares library */
/* #undef CARES_BUILDING_LIBRARY */

/* when not building a shared library */
/* #undef CARES_STATICLIB */

/* Define to 1 to enable hiding of library internal symbols. */
#define CARES_SYMBOL_HIDING 1

/* Definition to make a library symbol externally visible. */
#define CARES_SYMBOL_SCOPE_EXTERN __attribute__ ((visibility ("default")))

/* if a /etc/inet dir is being used */
/* #undef ETC_INET */

/* Define to the type qualifier of arg 1 for getnameinfo. */
#define GETNAMEINFO_QUAL_ARG1 const

/* Define to the type of arg 1 for getnameinfo. */
#define GETNAMEINFO_TYPE_ARG1 struct sockaddr *

/* Define to the type of arg 2 for getnameinfo. */
#define GETNAMEINFO_TYPE_ARG2 socklen_t

/* Define to the type of args 4 and 6 for getnameinfo. */
#define GETNAMEINFO_TYPE_ARG46 size_t

/* Define to the type of arg 7 for getnameinfo. */
#define GETNAMEINFO_TYPE_ARG7 unsigned int

/* Specifies the number of arguments to getservbyport_r */
#define GETSERVBYPORT_R_ARGS 6

/* Specifies the size of the buffer to pass to getservbyport_r */
#define GETSERVBYPORT_R_BUFSIZE 4096

/* Define to 1 if you have AF_INET6. */
#define HAVE_AF_INET6 1

/* Define to 1 if you have the  header file. */
#define HAVE_ARPA_INET_H 1

/* Define to 1 if you have the  header file. */
//#define HAVE_ARPA_NAMESER_COMPAT_H 1

/* Define to 1 if you have the  header file. */
//#define HAVE_ARPA_NAMESER_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_ASSERT_H 1

/* Define to 1 if you have the `bitncmp' function. */
/* #undef HAVE_BITNCMP */

/* Define to 1 if bool is an available type. */
#define HAVE_BOOL_T 1

/* Define to 1 if you have the clock_gettime function and monotonic timer. */
#define HAVE_CLOCK_GETTIME_MONOTONIC 1

/* Define to 1 if you have the closesocket function. */
/* #undef HAVE_CLOSESOCKET */

/* Define to 1 if you have the CloseSocket camel case function. */
/* #undef HAVE_CLOSESOCKET_CAMEL */

/* Define to 1 if you have the connect function. */
#define HAVE_CONNECT 1

/* Define to 1 if you have the  header file. */
#define HAVE_DLFCN_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_ERRNO_H 1

/* Define to 1 if you have the fcntl function. */
#define HAVE_FCNTL 1

/* Define to 1 if you have the  header file. */
#define HAVE_FCNTL_H 1

/* Define to 1 if you have a working fcntl O_NONBLOCK function. */
#define HAVE_FCNTL_O_NONBLOCK 1

/* Define to 1 if you have the freeaddrinfo function. */
#define HAVE_FREEADDRINFO 1

/* Define to 1 if you have a working getaddrinfo function. */
#define HAVE_GETADDRINFO 1

/* Define to 1 if the getaddrinfo function is threadsafe. */
#define HAVE_GETADDRINFO_THREADSAFE 1

/* Define to 1 if you have the gethostbyaddr function. */
#define HAVE_GETHOSTBYADDR 1

/* Define to 1 if you have the gethostbyname function. */
#define HAVE_GETHOSTBYNAME 1

/* Define to 1 if you have the gethostname function. */
#define HAVE_GETHOSTNAME 1

/* Define to 1 if you have the getnameinfo function. */
#define HAVE_GETNAMEINFO 1

/* Define to 1 if you have the getservbyport_r function. */
#define HAVE_GETSERVBYPORT_R 1

/* Define to 1 if you have the `gettimeofday' function. */
#define HAVE_GETTIMEOFDAY 1

/* Define to 1 if you have the `if_indextoname' function. */
#define HAVE_IF_INDEXTONAME 1

/* Define to 1 if you have the `inet_net_pton' function. */
/* #undef HAVE_INET_NET_PTON */

/* Define to 1 if inet_net_pton supports IPv6. */
/* #undef HAVE_INET_NET_PTON_IPV6 */

/* Define to 1 if you have a IPv6 capable working inet_ntop function. */
#define HAVE_INET_NTOP 1

/* Define to 1 if you have a IPv6 capable working inet_pton function. */
#define HAVE_INET_PTON 1

/* Define to 1 if you have the  header file. */
#define HAVE_INTTYPES_H 1

/* Define to 1 if you have the ioctl function. */
#define HAVE_IOCTL 1

/* Define to 1 if you have the ioctlsocket function. */
/* #undef HAVE_IOCTLSOCKET */

/* Define to 1 if you have the IoctlSocket camel case function. */
/* #undef HAVE_IOCTLSOCKET_CAMEL */

/* Define to 1 if you have a working IoctlSocket camel case FIONBIO function.
   */
/* #undef HAVE_IOCTLSOCKET_CAMEL_FIONBIO */

/* Define to 1 if you have a working ioctlsocket FIONBIO function. */
/* #undef HAVE_IOCTLSOCKET_FIONBIO */

/* Define to 1 if you have a working ioctl FIONBIO function. */
#define HAVE_IOCTL_FIONBIO 1

/* Define to 1 if you have a working ioctl SIOCGIFADDR function. */
#define HAVE_IOCTL_SIOCGIFADDR 1

/* Define to 1 if you have the `resolve' library (-lresolve). */
/* #undef HAVE_LIBRESOLVE */

/* Define to 1 if you have the  header file. */
#define HAVE_LIMITS_H 1

/* if your compiler supports LL */
#define HAVE_LL 1

/* Define to 1 if the compiler supports the 'long long' data type. */
#define HAVE_LONGLONG 1

/* Define to 1 if you have the malloc.h header file. */
#define HAVE_MALLOC_H 1

/* Define to 1 if you have the memory.h header file. */
#define HAVE_MEMORY_H 1

/* Define to 1 if you have the MSG_NOSIGNAL flag. */
#define HAVE_MSG_NOSIGNAL 1

/* Define to 1 if you have the  header file. */
#define HAVE_NETDB_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_NETINET_IN_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_NETINET_TCP_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_NET_IF_H 1

/* Define to 1 if you have PF_INET6. */
#define HAVE_PF_INET6 1

/* Define to 1 if you have the recv function. */
#define HAVE_RECV 1

/* Define to 1 if you have the recvfrom function. */
#define HAVE_RECVFROM 1

/* Define to 1 if you have the send function. */
#define HAVE_SEND 1

/* Define to 1 if you have the setsockopt function. */
#define HAVE_SETSOCKOPT 1

/* Define to 1 if you have a working setsockopt SO_NONBLOCK function. */
/* #undef HAVE_SETSOCKOPT_SO_NONBLOCK */

/* Define to 1 if you have the  header file. */
#define HAVE_SIGNAL_H 1

/* Define to 1 if sig_atomic_t is an available typedef. */
#define HAVE_SIG_ATOMIC_T 1

/* Define to 1 if sig_atomic_t is already defined as volatile. */
/* #undef HAVE_SIG_ATOMIC_T_VOLATILE */

/* Define to 1 if your struct sockaddr_in6 has sin6_scope_id. */
#define HAVE_SOCKADDR_IN6_SIN6_SCOPE_ID 1

/* Define to 1 if you have the socket function. */
#define HAVE_SOCKET 1

/* Define to 1 if you have the  header file. */
/* #undef HAVE_SOCKET_H */

/* Define to 1 if you have the  header file. */
#define HAVE_STDBOOL_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_STDINT_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_STDLIB_H 1

/* Define to 1 if you have the strcasecmp function. */
#define HAVE_STRCASECMP 1

/* Define to 1 if you have the strcmpi function. */
/* #undef HAVE_STRCMPI */

/* Define to 1 if you have the strdup function. */
#define HAVE_STRDUP 1

/* Define to 1 if you have the stricmp function. */
/* #undef HAVE_STRICMP */

/* Define to 1 if you have the  header file. */
#define HAVE_STRINGS_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_STRING_H 1

/* Define to 1 if you have the strncasecmp function. */
#define HAVE_STRNCASECMP 1

/* Define to 1 if you have the strncmpi function. */
/* #undef HAVE_STRNCMPI */

/* Define to 1 if you have the strnicmp function. */
/* #undef HAVE_STRNICMP */

/* Define to 1 if you have the  header file. */
#define HAVE_STROPTS_H 1

/* Define to 1 if you have struct addrinfo. */
#define HAVE_STRUCT_ADDRINFO 1

/* Define to 1 if you have struct in6_addr. */
#define HAVE_STRUCT_IN6_ADDR 1

/* Define to 1 if you have struct sockaddr_in6. */
#define HAVE_STRUCT_SOCKADDR_IN6 1

/* if struct sockaddr_storage is defined */
#define HAVE_STRUCT_SOCKADDR_STORAGE 1

/* Define to 1 if you have the timeval struct. */
#define HAVE_STRUCT_TIMEVAL 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_IOCTL_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_PARAM_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_SELECT_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_SOCKET_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_STAT_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_TIME_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_TYPES_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_UIO_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_TIME_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_UNISTD_H 1

/* Define to 1 if you have the windows.h header file. */
/* #undef HAVE_WINDOWS_H */

/* Define to 1 if you have the winsock2.h header file. */
/* #undef HAVE_WINSOCK2_H */

/* Define to 1 if you have the winsock.h header file. */
/* #undef HAVE_WINSOCK_H */

/* Define to 1 if you have the writev function. */
#define HAVE_WRITEV 1

/* Define to 1 if you have the ws2tcpip.h header file. */
/* #undef HAVE_WS2TCPIP_H */

/* Define to the sub-directory in which libtool stores uninstalled libraries.
   */
#define LT_OBJDIR ".libs/"

/* Define to 1 if you are building a native Windows target. */
/* #undef NATIVE_WINDOWS */

/* Define to 1 if you need the malloc.h header file even with stdlib.h */
/* #undef NEED_MALLOC_H */

/* Define to 1 if you need the memory.h header file even with stdlib.h */
/* #undef NEED_MEMORY_H */

/* Define to 1 if _REENTRANT preprocessor symbol must be defined. */
/* #undef NEED_REENTRANT */

/* Define to 1 if _THREAD_SAFE preprocessor symbol must be defined. */
/* #undef NEED_THREAD_SAFE */

/* Define to 1 if your C compiler doesn't accept -c and -o together. */
/* #undef NO_MINUS_C_MINUS_O */

/* cpu-machine-OS */
#define OS "i686-pc-linux-gnu"

/* Name of package */
#define PACKAGE "c-ares"

/* Define to the address where bug reports for this package should be sent. */
#define PACKAGE_BUGREPORT "c-ares mailing list => http://cool.haxx.se/mailman/listinfo/c-ares"

/* Define to the full name of this package. */
#define PACKAGE_NAME "c-ares"

/* Define to the full name and version of this package. */
#define PACKAGE_STRING "c-ares 1.7.1"

/* Define to the one symbol short name of this package. */
#define PACKAGE_TARNAME "c-ares"

/* Define to the home page for this package. */
#define PACKAGE_URL ""

/* Define to the version of this package. */
#define PACKAGE_VERSION "1.7.1"

/* a suitable file/device to read random data from */
#define RANDOM_FILE "/dev/urandom"

/* Define to the type of arg 1 for recvfrom. */
#define RECVFROM_TYPE_ARG1 int

/* Define to the type pointed by arg 2 for recvfrom. */
#define RECVFROM_TYPE_ARG2 void

/* Define to 1 if the type pointed by arg 2 for recvfrom is void. */
#define RECVFROM_TYPE_ARG2_IS_VOID 1

/* Define to the type of arg 3 for recvfrom. */
#define RECVFROM_TYPE_ARG3 size_t

/* Define to the type of arg 4 for recvfrom. */
#define RECVFROM_TYPE_ARG4 int

/* Define to the type pointed by arg 5 for recvfrom. */
#define RECVFROM_TYPE_ARG5 struct sockaddr

/* Define to 1 if the type pointed by arg 5 for recvfrom is void. */
/* #undef RECVFROM_TYPE_ARG5_IS_VOID */

/* Define to the type pointed by arg 6 for recvfrom. */
#define RECVFROM_TYPE_ARG6 socklen_t

/* Define to 1 if the type pointed by arg 6 for recvfrom is void. */
/* #undef RECVFROM_TYPE_ARG6_IS_VOID */

/* Define to the function return type for recvfrom. */
#define RECVFROM_TYPE_RETV int

/* Define to the type of arg 1 for recv. */
#define RECV_TYPE_ARG1 int

/* Define to the type of arg 2 for recv. */
#define RECV_TYPE_ARG2 void *

/* Define to the type of arg 3 for recv. */
#define RECV_TYPE_ARG3 size_t

/* Define to the type of arg 4 for recv. */
#define RECV_TYPE_ARG4 int

/* Define to the function return type for recv. */
#define RECV_TYPE_RETV int

/* Define as the return type of signal handlers (`int' or `void'). */
#define RETSIGTYPE void

/* Define to the type qualifier of arg 2 for send. */
#define SEND_QUAL_ARG2 const

/* Define to the type of arg 1 for send. */
#define SEND_TYPE_ARG1 int

/* Define to the type of arg 2 for send. */
#define SEND_TYPE_ARG2 void *

/* Define to the type of arg 3 for send. */
#define SEND_TYPE_ARG3 size_t

/* Define to the type of arg 4 for send. */
#define SEND_TYPE_ARG4 int

/* Define to the function return type for send. */
#define SEND_TYPE_RETV int

/* The size of `int', as computed by sizeof. */
#define SIZEOF_INT 4

/* The size of `long', as computed by sizeof. */
#define SIZEOF_LONG 4

/* The size of `size_t', as computed by sizeof. */
#define SIZEOF_SIZE_T 4

/* The size of `struct in6_addr', as computed by sizeof. */
#define SIZEOF_STRUCT_IN6_ADDR 16

/* The size of `struct in_addr', as computed by sizeof. */
#define SIZEOF_STRUCT_IN_ADDR 4

/* The size of `time_t', as computed by sizeof. */
#define SIZEOF_TIME_T 4

/* Define to 1 if you have the ANSI C header files. */
#define STDC_HEADERS 1

/* Define to 1 if you can safely include both  and . */
#define TIME_WITH_SYS_TIME 1

/* Define to disable non-blocking sockets. */
/* #undef USE_BLOCKING_SOCKETS */

/* Version number of package */
#define VERSION "1.7.1"

/* Define WORDS_BIGENDIAN to 1 if your processor stores words with the most
   significant byte first (like Motorola and SPARC, unlike Intel). */
#if defined AC_APPLE_UNIVERSAL_BUILD
# if defined __BIG_ENDIAN__
#  define WORDS_BIGENDIAN 1
# endif
#else
# ifndef WORDS_BIGENDIAN
/* #  undef WORDS_BIGENDIAN */
# endif
#endif

/* Define to 1 if OS is AIX. */
#ifndef _ALL_SOURCE
/* #  undef _ALL_SOURCE */
#endif

/* Number of bits in a file offset, on hosts where this is settable. */
#define _FILE_OFFSET_BITS 64

/* Define for large files, on AIX-style hosts. */
/* #undef _LARGE_FILES */

/* Define to empty if `const' does not conform to ANSI C. */
/* #undef const */

/* Type to use in place of in_addr_t when system does not provide it. */
/* #undef in_addr_t */

/* Define to `unsigned int' if  does not define. */
/* #undef size_t */

/* the signed version of size_t */
/* #undef ssize_t */

#define HAVE_GETENV 1
node-v4.8.2/deps/cares/config/aix/ares_config.h000644 000766 000024 00000035040 13070706730 021463 0ustar00iojsstaff000000 000000 /* ares_config.h.  Generated from ares_config.h.in by configure.  */
/* ares_config.h.in.  Generated from configure.ac by autoheader.  */

/* Define if building universal (internal helper macro) */
/* #undef AC_APPLE_UNIVERSAL_BUILD */

/* define this if ares is built for a big endian system */
#define ARES_BIG_ENDIAN 1

/* when building as static part of libcurl */
/* #undef BUILDING_LIBCURL */

/* when building c-ares library */
/* #undef CARES_BUILDING_LIBRARY */

/* when not building a shared library */
/* #undef CARES_STATICLIB */

/* Define to 1 to enable hiding of library internal symbols. */
#define CARES_SYMBOL_HIDING 1

/* Definition to make a library symbol externally visible. */
#define CARES_SYMBOL_SCOPE_EXTERN __attribute__ ((visibility ("default")))

/* if a /etc/inet dir is being used */
/* #undef ETC_INET */

/* Define to the type qualifier of arg 1 for getnameinfo. */
#define GETNAMEINFO_QUAL_ARG1 const

/* Define to the type of arg 1 for getnameinfo. */
#define GETNAMEINFO_TYPE_ARG1 struct sockaddr *

/* Define to the type of arg 2 for getnameinfo. */
#define GETNAMEINFO_TYPE_ARG2 socklen_t

/* Define to the type of args 4 and 6 for getnameinfo. */
#define GETNAMEINFO_TYPE_ARG46 size_t

/* Define to the type of arg 7 for getnameinfo. */
#define GETNAMEINFO_TYPE_ARG7 int

/* Specifies the number of arguments to getservbyport_r */
#define GETSERVBYPORT_R_ARGS 4

/* Specifies the size of the buffer to pass to getservbyport_r */
#define GETSERVBYPORT_R_BUFSIZE sizeof(struct servent_data)

/* Define to 1 if you have AF_INET6. */
#define HAVE_AF_INET6 1

/* Define to 1 if you have the  header file. */
#define HAVE_ARPA_INET_H 1

/* Define to 1 if you have the  header file. */
/* #undef HAVE_ARPA_NAMESER_COMPAT_H */

/* Define to 1 if you have the  header file. */
#define HAVE_ARPA_NAMESER_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_ASSERT_H 1

/* Define to 1 if you have the `bitncmp' function. */
/* #undef HAVE_BITNCMP */

/* Define to 1 if bool is an available type. */
#define HAVE_BOOL_T 1

/* Define to 1 if you have the clock_gettime function and monotonic timer. */
#define HAVE_CLOCK_GETTIME_MONOTONIC 1

/* Define to 1 if you have the closesocket function. */
/* #undef HAVE_CLOSESOCKET */

/* Define to 1 if you have the CloseSocket camel case function. */
/* #undef HAVE_CLOSESOCKET_CAMEL */

/* Define to 1 if you have the connect function. */
#define HAVE_CONNECT 1

/* Define to 1 if you have the  header file. */
#define HAVE_DLFCN_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_ERRNO_H 1

/* Define to 1 if you have the fcntl function. */
#define HAVE_FCNTL 1

/* Define to 1 if you have the  header file. */
#define HAVE_FCNTL_H 1

/* Define to 1 if you have a working fcntl O_NONBLOCK function. */
#define HAVE_FCNTL_O_NONBLOCK 1

/* Define to 1 if you have the freeaddrinfo function. */
#define HAVE_FREEADDRINFO 1

/* Define to 1 if you have a working getaddrinfo function. */
#define HAVE_GETADDRINFO 1

/* Define to 1 if the getaddrinfo function is threadsafe. */
#define HAVE_GETADDRINFO_THREADSAFE 1

/* Define to 1 if you have the gethostbyaddr function. */
#define HAVE_GETHOSTBYADDR 1

/* Define to 1 if you have the gethostbyname function. */
#define HAVE_GETHOSTBYNAME 1

/* Define to 1 if you have the gethostname function. */
#define HAVE_GETHOSTNAME 1

/* Define to 1 if you have the getnameinfo function. */
#define HAVE_GETNAMEINFO 1

/* Define to 1 if you have the getservbyport_r function. */
#define HAVE_GETSERVBYPORT_R 1

/* Define to 1 if you have the `gettimeofday' function. */
#define HAVE_GETTIMEOFDAY 1

/* Define to 1 if you have the `if_indextoname' function. */
#define HAVE_IF_INDEXTONAME 1

/* Define to 1 if you have the `inet_net_pton' function. */
#define HAVE_INET_NET_PTON 1

/* Define to 1 if inet_net_pton supports IPv6. */
/* #undef HAVE_INET_NET_PTON_IPV6 */

/* Define to 1 if you have a IPv6 capable working inet_ntop function. */
#define HAVE_INET_NTOP 1

/* Define to 1 if you have a IPv6 capable working inet_pton function. */
#define HAVE_INET_PTON 1

/* Define to 1 if you have the  header file. */
#define HAVE_INTTYPES_H 1

/* Define to 1 if you have the ioctl function. */
#define HAVE_IOCTL 1

/* Define to 1 if you have the ioctlsocket function. */
/* #undef HAVE_IOCTLSOCKET */

/* Define to 1 if you have the IoctlSocket camel case function. */
/* #undef HAVE_IOCTLSOCKET_CAMEL */

/* Define to 1 if you have a working IoctlSocket camel case FIONBIO function.
   */
/* #undef HAVE_IOCTLSOCKET_CAMEL_FIONBIO */

/* Define to 1 if you have a working ioctlsocket FIONBIO function. */
/* #undef HAVE_IOCTLSOCKET_FIONBIO */

/* Define to 1 if you have a working ioctl FIONBIO function. */
#define HAVE_IOCTL_FIONBIO 1

/* Define to 1 if you have a working ioctl SIOCGIFADDR function. */
#define HAVE_IOCTL_SIOCGIFADDR 1

/* Define to 1 if you have the `resolve' library (-lresolve). */
/* #undef HAVE_LIBRESOLVE */

/* Define to 1 if you have the  header file. */
#define HAVE_LIMITS_H 1

/* if your compiler supports LL */
#define HAVE_LL 1

/* Define to 1 if the compiler supports the 'long long' data type. */
#define HAVE_LONGLONG 1

/* Define to 1 if you have the malloc.h header file. */
#define HAVE_MALLOC_H 1

/* Define to 1 if you have the memory.h header file. */
#define HAVE_MEMORY_H 1

/* Define to 1 if you have the MSG_NOSIGNAL flag. */
#define HAVE_MSG_NOSIGNAL 1

/* Define to 1 if you have the  header file. */
#define HAVE_NETDB_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_NETINET_IN_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_NETINET_TCP_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_NET_IF_H 1

/* Define to 1 if you have PF_INET6. */
#define HAVE_PF_INET6 1

/* Define to 1 if you have the recv function. */
#define HAVE_RECV 1

/* Define to 1 if you have the recvfrom function. */
#define HAVE_RECVFROM 1

/* Define to 1 if you have the send function. */
#define HAVE_SEND 1

/* Define to 1 if you have the setsockopt function. */
#define HAVE_SETSOCKOPT 1

/* Define to 1 if you have a working setsockopt SO_NONBLOCK function. */
/* #undef HAVE_SETSOCKOPT_SO_NONBLOCK */

/* Define to 1 if you have the  header file. */
#define HAVE_SIGNAL_H 1

/* Define to 1 if sig_atomic_t is an available typedef. */
#define HAVE_SIG_ATOMIC_T 1

/* Define to 1 if sig_atomic_t is already defined as volatile. */
/* #undef HAVE_SIG_ATOMIC_T_VOLATILE */

/* Define to 1 if your struct sockaddr_in6 has sin6_scope_id. */
#define HAVE_SOCKADDR_IN6_SIN6_SCOPE_ID 1

/* Define to 1 if you have the socket function. */
#define HAVE_SOCKET 1

/* Define to 1 if you have the  header file. */
/* #undef HAVE_SOCKET_H */

/* Define to 1 if you have the  header file. */
#define HAVE_STDBOOL_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_STDINT_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_STDLIB_H 1

/* Define to 1 if you have the strcasecmp function. */
#define HAVE_STRCASECMP 1

/* Define to 1 if you have the strcmpi function. */
/* #undef HAVE_STRCMPI */

/* Define to 1 if you have the strdup function. */
#define HAVE_STRDUP 1

/* Define to 1 if you have the stricmp function. */
/* #undef HAVE_STRICMP */

/* Define to 1 if you have the  header file. */
#define HAVE_STRINGS_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_STRING_H 1

/* Define to 1 if you have the strncasecmp function. */
#define HAVE_STRNCASECMP 1

/* Define to 1 if you have the strncmpi function. */
/* #undef HAVE_STRNCMPI */

/* Define to 1 if you have the strnicmp function. */
/* #undef HAVE_STRNICMP */

/* Define to 1 if you have the  header file. */
#define HAVE_STROPTS_H 1

/* Define to 1 if you have struct addrinfo. */
#define HAVE_STRUCT_ADDRINFO 1

/* Define to 1 if you have struct in6_addr. */
#define HAVE_STRUCT_IN6_ADDR 1

/* Define to 1 if you have struct sockaddr_in6. */
#define HAVE_STRUCT_SOCKADDR_IN6 1

/* if struct sockaddr_storage is defined */
#define HAVE_STRUCT_SOCKADDR_STORAGE 1

/* Define to 1 if you have the timeval struct. */
#define HAVE_STRUCT_TIMEVAL 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_IOCTL_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_PARAM_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_SELECT_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_SOCKET_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_STAT_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_TIME_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_TYPES_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_SYS_UIO_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_TIME_H 1

/* Define to 1 if you have the  header file. */
#define HAVE_UNISTD_H 1

/* Define to 1 if you have the windows.h header file. */
/* #undef HAVE_WINDOWS_H */

/* Define to 1 if you have the winsock2.h header file. */
/* #undef HAVE_WINSOCK2_H */

/* Define to 1 if you have the winsock.h header file. */
/* #undef HAVE_WINSOCK_H */

/* Define to 1 if you have the writev function. */
#define HAVE_WRITEV 1

/* Define to 1 if you have the ws2tcpip.h header file. */
/* #undef HAVE_WS2TCPIP_H */

/* Define to the sub-directory in which libtool stores uninstalled libraries.
   */
#define LT_OBJDIR ".libs/"

/* Define to 1 if you are building a native Windows target. */
/* #undef NATIVE_WINDOWS */

/* Define to 1 if you need the malloc.h header file even with stdlib.h */
/* #undef NEED_MALLOC_H */

/* Define to 1 if you need the memory.h header file even with stdlib.h */
/* #undef NEED_MEMORY_H */

/* Define to 1 if _REENTRANT preprocessor symbol must be defined. */
/* #undef NEED_REENTRANT */

/* Define to 1 if _THREAD_SAFE preprocessor symbol must be defined. */
#define NEED_THREAD_SAFE 1

/* Define to 1 if your C compiler doesn't accept -c and -o together. */
/* #undef NO_MINUS_C_MINUS_O */

/* cpu-machine-OS */
#define OS "rs6000-ibm-aix"

/* Name of package */
#define PACKAGE "c-ares"

/* Define to the address where bug reports for this package should be sent. */
#define PACKAGE_BUGREPORT "c-ares mailing list => http://cool.haxx.se/mailman/listinfo/c-ares"

/* Define to the full name of this package. */
#define PACKAGE_NAME "c-ares"

/* Define to the full name and version of this package. */
#define PACKAGE_STRING "c-ares 1.7.1"

/* Define to the one symbol short name of this package. */
#define PACKAGE_TARNAME "c-ares"

/* Define to the home page for this package. */
#define PACKAGE_URL ""

/* Define to the version of this package. */
#define PACKAGE_VERSION "1.7.1"

/* a suitable file/device to read random data from */
#define RANDOM_FILE "/dev/urandom"

/* Define to the type of arg 1 for recvfrom. */
#define RECVFROM_TYPE_ARG1 int

/* Define to the type pointed by arg 2 for recvfrom. */
#define RECVFROM_TYPE_ARG2 void

/* Define to 1 if the type pointed by arg 2 for recvfrom is void. */
#define RECVFROM_TYPE_ARG2_IS_VOID 1

/* Define to the type of arg 3 for recvfrom. */
#define RECVFROM_TYPE_ARG3 size_t

/* Define to the type of arg 4 for recvfrom. */
#define RECVFROM_TYPE_ARG4 int

/* Define to the type pointed by arg 5 for recvfrom. */
#define RECVFROM_TYPE_ARG5 struct sockaddr

/* Define to 1 if the type pointed by arg 5 for recvfrom is void. */
/* #undef RECVFROM_TYPE_ARG5_IS_VOID */

/* Define to the type pointed by arg 6 for recvfrom. */
#define RECVFROM_TYPE_ARG6 socklen_t

/* Define to 1 if the type pointed by arg 6 for recvfrom is void. */
/* #undef RECVFROM_TYPE_ARG6_IS_VOID */

/* Define to the function return type for recvfrom. */
#define RECVFROM_TYPE_RETV ssize_t

/* Define to the type of arg 1 for recv. */
#define RECV_TYPE_ARG1 int

/* Define to the type of arg 2 for recv. */
#define RECV_TYPE_ARG2 void *

/* Define to the type of arg 3 for recv. */
#define RECV_TYPE_ARG3 size_t

/* Define to the type of arg 4 for recv. */
#define RECV_TYPE_ARG4 int

/* Define to the function return type for recv. */
#define RECV_TYPE_RETV ssize_t

/* Define as the return type of signal handlers (`int' or `void'). */
#define RETSIGTYPE void

/* Define to the type qualifier of arg 2 for send. */
#define SEND_QUAL_ARG2 const

/* Define to the type of arg 1 for send. */
#define SEND_TYPE_ARG1 int

/* Define to the type of arg 2 for send. */
#define SEND_TYPE_ARG2 void *

/* Define to the type of arg 3 for send. */
#define SEND_TYPE_ARG3 size_t

/* Define to the type of arg 4 for send. */
#define SEND_TYPE_ARG4 int

/* Define to the function return type for send. */
#define SEND_TYPE_RETV ssize_t

/* The size of `int', as computed by sizeof. */
#define SIZEOF_INT 4

/* The size of `long', as computed by sizeof. */
#define SIZEOF_LONG 4

/* The size of `size_t', as computed by sizeof. */
#define SIZEOF_SIZE_T 4

/* The size of `struct in6_addr', as computed by sizeof. */
#define SIZEOF_STRUCT_IN6_ADDR 16

/* The size of `struct in_addr', as computed by sizeof. */
#define SIZEOF_STRUCT_IN_ADDR 4

/* The size of `time_t', as computed by sizeof. */
#define SIZEOF_TIME_T 4

/* Define to 1 if you have the ANSI C header files. */
#define STDC_HEADERS 1

/* Define to 1 if you can safely include both  and . */
#define TIME_WITH_SYS_TIME 1

/* Define to disable non-blocking sockets. */
/* #undef USE_BLOCKING_SOCKETS */

/* Version number of package */
#define VERSION "1.7.1"

/* Define to avoid automatic inclusion of winsock.h */
/* #undef WIN32_LEAN_AND_MEAN */

/* Define WORDS_BIGENDIAN to 1 if your processor stores words with the most
   significant byte first (like Motorola and SPARC, unlike Intel). */
#if defined AC_APPLE_UNIVERSAL_BUILD
# if defined __BIG_ENDIAN__
#  define WORDS_BIGENDIAN 1
# endif
#else
# ifndef WORDS_BIGENDIAN
/* #  undef WORDS_BIGENDIAN */
# endif
#endif

/* Define to 1 if OS is AIX. */
#ifndef _ALL_SOURCE
#  define _ALL_SOURCE 1
#endif

/* Number of bits in a file offset, on hosts where this is settable. */
/* #undef _FILE_OFFSET_BITS */

/* Define for large files, on AIX-style hosts. */
#define _LARGE_FILES 1

/* Define to empty if `const' does not conform to ANSI C. */
/* #undef const */

/* Type to use in place of in_addr_t when system does not provide it. */
/* #undef in_addr_t */

/* Define to `unsigned int' if  does not define. */
/* #undef size_t */

/* the signed version of size_t */
/* #undef ssize_t */

#define HAVE_GETENV 1
node-v4.8.2/deps/cares/build/gcc_version.py000644 000766 000024 00000000575 13070706730 020764 0ustar00iojsstaff000000 000000 #!/usr/bin/env python

import os
import re
import subprocess
import sys


def DoMain(*args):
  cc = os.environ.get('CC', 'gcc')
  stdin, stderr = os.pipe()
  subprocess.call([cc, '-v'], stderr=stderr)
  output = os.read(stdin, 4096)
  match = re.search("\ngcc version (\d+\.\d+\.\d+)", output)
  if match:
    print(match.group(1))


if __name__ == '__main__':
  DoMain(*sys.argv)
node-v4.8.2/benchmark/arrays/000755 000766 000024 00000000000 13070706730 016206 5ustar00iojsstaff000000 000000 node-v4.8.2/benchmark/assert/000755 000766 000024 00000000000 13070706730 016206 5ustar00iojsstaff000000 000000 node-v4.8.2/benchmark/buffers/000755 000766 000024 00000000000 13070706730 016341 5ustar00iojsstaff000000 000000 node-v4.8.2/benchmark/child_process/000755 000766 000024 00000000000 13070706730 017526 5ustar00iojsstaff000000 000000 node-v4.8.2/benchmark/common.js000644 000766 000024 00000014611 13070706730 016536 0ustar00iojsstaff000000 000000 'use strict';
var assert = require('assert');
var fs = require('fs');
var path = require('path');
var child_process = require('child_process');

var outputFormat = process.env.OUTPUT_FORMAT ||
                   (+process.env.NODE_BENCH_SILENT ? 'silent' : false) ||
                   'default';

// verify outputFormat
if (['default', 'csv', 'silent'].indexOf(outputFormat) == -1) {
  throw new Error('OUTPUT_FORMAT set to invalid value');
}

exports.PORT = process.env.PORT || 12346;

// If this is the main module, then run the benchmarks
if (module === require.main) {
  var type = process.argv[2];
  var testFilter = process.argv[3];
  if (!type) {
    console.error('usage:\n ./node benchmark/common.js  [testFilter]');
    process.exit(1);
  }

  var dir = path.join(__dirname, type);
  var tests = fs.readdirSync(dir);

  if (testFilter) {
    var filteredTests = tests.filter(function(item) {
      if (item.lastIndexOf(testFilter) >= 0) {
        return item;
      }
    });

    if (filteredTests.length === 0) {
      console.error('%s is not found in \n %j', testFilter, tests);
      return;
    }
    tests = filteredTests;
  }

  runBenchmarks();
}

function hasWrk() {
  var result = child_process.spawnSync('wrk', ['-h']);
  if (result.error && result.error.code === 'ENOENT') {
    console.error('Couldn\'t locate `wrk` which is needed for running ' +
      'benchmarks. Check benchmark/README.md for further instructions.');
    process.exit(-1);
  }
}

function runBenchmarks() {
  var test = tests.shift();
  if (!test)
    return;

  if (test.match(/^[\._]/))
    return process.nextTick(runBenchmarks);

  if (outputFormat == 'default')
    console.error(type + '/' + test);

  test = path.resolve(dir, test);

  var a = (process.execArgv || []).concat(test);
  var child = child_process.spawn(process.execPath, a, { stdio: 'inherit' });
  child.on('close', function(code) {
    if (code) {
      process.exit(code);
    } else {
      console.log('');
      runBenchmarks();
    }
  });
}

exports.createBenchmark = function(fn, options) {
  return new Benchmark(fn, options);
};

function Benchmark(fn, options) {
  this.fn = fn;
  this.options = options;
  this.config = parseOpts(options);
  this._name = require.main.filename.split(/benchmark[\/\\]/).pop();
  this._start = [0, 0];
  this._started = false;

  var self = this;

  process.nextTick(function() {
    self._run();
  });
}

// benchmark an http server.
Benchmark.prototype.http = function(p, args, cb) {
  hasWrk();
  var self = this;
  var regexp = /Requests\/sec:[ \t]+([0-9\.]+)/;
  var url = 'http://127.0.0.1:' + exports.PORT + p;

  args = args.concat(url);

  var out = '';
  var child = child_process.spawn('wrk', args);

  child.stdout.setEncoding('utf8');

  child.stdout.on('data', function(chunk) {
    out += chunk;
  });

  child.on('close', function(code) {
    if (cb)
      cb(code);

    if (code) {
      console.error('wrk failed with ' + code);
      process.exit(code);
    }
    var match = out.match(regexp);
    var qps = match && +match[1];
    if (!qps) {
      console.error('%j', out);
      console.error('wrk produced strange output');
      process.exit(1);
    }
    self.report(+qps);
  });
};

Benchmark.prototype._run = function() {
  if (this.config)
    return this.fn(this.config);

  // some options weren't set.
  // run with all combinations
  var main = require.main.filename;
  var options = this.options;

  var queue = Object.keys(options).reduce(function(set, key) {
    var vals = options[key];
    assert(Array.isArray(vals));

    // match each item in the set with each item in the list
    var newSet = new Array(set.length * vals.length);
    var j = 0;
    set.forEach(function(s) {
      vals.forEach(function(val) {
        if (typeof val !== 'number' && typeof val !== 'string') {
          throw new TypeError(`configuration "${key}" had type ${typeof val}`);
        }

        newSet[j++] = s.concat(key + '=' + val);
      });
    });
    return newSet;
  }, [[main]]);

  // output csv heading
  if (outputFormat == 'csv')
    console.log('filename,' + Object.keys(options).join(',') + ',result');

  var node = process.execPath;
  var i = 0;
  function run() {
    var argv = queue[i++];
    if (!argv)
      return;
    argv = process.execArgv.concat(argv);
    var child = child_process.spawn(node, argv, { stdio: 'inherit' });
    child.on('close', function(code, signal) {
      if (code)
        console.error('child process exited with code ' + code);
      else
        run();
    });
  }
  run();
};

function parseOpts(options) {
  // verify that there's an option provided for each of the options
  // if they're not *all* specified, then we return null.
  var keys = Object.keys(options);
  var num = keys.length;
  var conf = {};
  for (var i = 2; i < process.argv.length; i++) {
    var match = process.argv[i].match(/^(.+)=(.+)$/);
    if (!match || !match[1] || !match[2] || !options[match[1]]) {
      return null;
    } else {
      conf[match[1]] = isFinite(match[2]) ? +match[2] : match[2];
      num--;
    }
  }
  // still go ahead and set whatever WAS set, if it was.
  if (num !== 0) {
    Object.keys(conf).forEach(function(k) {
      options[k] = [conf[k]];
    });
  }
  return num === 0 ? conf : null;
}

Benchmark.prototype.start = function() {
  if (this._started)
    throw new Error('Called start more than once in a single benchmark');

  this._started = true;
  this._start = process.hrtime();
};

Benchmark.prototype.end = function(operations) {
  var elapsed = process.hrtime(this._start);

  if (!this._started)
    throw new Error('called end without start');
  if (typeof operations !== 'number')
    throw new Error('called end() without specifying operation count');

  var time = elapsed[0] + elapsed[1] / 1e9;
  var rate = operations / time;
  this.report(rate);
};

Benchmark.prototype.report = function(value) {
  var heading = this.getHeading();

  if (outputFormat == 'default')
    console.log('%s: %s', heading, value.toFixed(5));
  else if (outputFormat == 'csv')
    console.log('%s,%s', heading, value.toFixed(5));

  process.exit(0);
};

Benchmark.prototype.getHeading = function() {
  var conf = this.config;

  if (outputFormat == 'default') {
    return this._name + ' ' + Object.keys(conf).map(function(key) {
      return key + '=' + conf[key];
    }).join(' ');
  } else if (outputFormat == 'csv') {
    return this._name + ',' + Object.keys(conf).map(function(key) {
      return conf[key];
    }).join(',');
  }
};
node-v4.8.2/benchmark/compare.js000644 000766 000024 00000010267 13070706730 016677 0ustar00iojsstaff000000 000000 'use strict';
var usage = 'node benchmark/compare.js ' +
            '  ' +
            '[--html] [--red|-r] [--green|-g] ' +
            '[--  [testFilter]]';

var show = 'both';
var nodes = [];
var html = false;
var benchmarks;

for (var i = 2; i < process.argv.length; i++) {
  var arg = process.argv[i];
  switch (arg) {
    case '--red': case '-r':
      show = show === 'green' ? 'both' : 'red';
      break;
    case '--green': case '-g':
      show = show === 'red' ? 'both' : 'green';
      break;
    case '--html':
      html = true;
      break;
    case '-h': case '-?': case '--help':
      console.log(usage);
      process.exit(0);
      break;
    case '--':
      benchmarks = [];
      break;
    default:
      if (Array.isArray(benchmarks))
        benchmarks.push(arg);
      else
        nodes.push(arg);
      break;
  }
}

var start, green, red, reset, end;
if (!html) {
  start = '';
  green = '\u001b[1;32m';
  red = '\u001b[1;31m';
  reset = '\u001b[m';
  end = '';
} else {
  start = '
';
  green = '';
  red = '';
  reset = '';
  end = '
';
}

var runBench = process.env.NODE_BENCH || 'bench';

if (nodes.length !== 2)
  return console.error('usage:\n  %s', usage);

var spawn = require('child_process').spawn;
var results = {};
var toggle = 1;
var r = (+process.env.NODE_BENCH_RUNS || 1) * 2;

run();
function run() {
  if (--r < 0)
    return compare();
  toggle = ++toggle % 2;

  var node = nodes[toggle];
  console.error('running %s', node);
  var env = {};
  for (var i in process.env)
    env[i] = process.env[i];
  env.NODE = node;

  var out = '';
  var child;
  if (Array.isArray(benchmarks) && benchmarks.length) {
    child = spawn(
      node,
      ['benchmark/common.js'].concat(benchmarks),
      { env: env }
    );
  } else {
    child = spawn('make', [runBench], { env: env });
  }
  child.stdout.setEncoding('utf8');
  child.stdout.on('data', function(c) {
    out += c;
  });

  child.stderr.pipe(process.stderr);

  child.on('close', function(code) {
    if (code) {
      console.error('%s exited with code=%d', node, code);
      process.exit(code);
    } else {
      out.trim().split(/\r?\n/).forEach(function(line) {
        line = line.trim();
        if (!line)
          return;

        var s = line.split(':');
        var num = +s.pop();
        if (!num && num !== 0)
          return;

        line = s.join(':');
        var res = results[line] = results[line] || {};
        res[node] = res[node] || [];
        res[node].push(num);
      });

      run();
    }
  });
}

function compare() {
  // each result is an object with {"foo.js arg=bar":12345,...}
  // compare each thing, and show which node did the best.
  // node[0] is shown in green, node[1] shown in red.
  var maxLen = -Infinity;
  var util = require('util');
  console.log(start);

  Object.keys(results).map(function(bench) {
    var res = results[bench];
    var n0 = avg(res[nodes[0]]);
    var n1 = avg(res[nodes[1]]);

    var pct = ((n0 - n1) / n1 * 100).toFixed(2);

    var g = n0 > n1 ? green : '';
    var r = n0 > n1 ? '' : red;
    var c = r || g;

    if (show === 'green' && !g || show === 'red' && !r)
      return;

    var r0 = util.format(
      '%s%s: %d%s',
      g,
      nodes[0],
      n0.toPrecision(5), g ? reset : ''
    );
    var r1 = util.format(
      '%s%s: %d%s',
      r,
      nodes[1],
      n1.toPrecision(5), r ? reset : ''
    );
    pct = c + pct + '%' + reset;

    var l = util.format('%s: %s %s', bench, r0, r1);
    maxLen = Math.max(l.length + pct.length, maxLen);
    return [l, pct];
  }).filter(function(l) {
    return l;
  }).forEach(function(line) {
    var l = line[0];
    var pct = line[1];
    var dotLen = maxLen - l.length - pct.length + 2;
    var dots = ' ' + new Array(Math.max(0, dotLen)).join('.') + ' ';
    console.log(l + dots + pct);
  });
  console.log(end);
}

function avg(list) {
  if (list.length >= 3) {
    list = list.sort();
    var q = Math.floor(list.length / 4) || 1;
    list = list.slice(q, -q);
  }
  return list.reduce(function(a, b) {
    return a + b;
  }, 0) / list.length;
}
node-v4.8.2/benchmark/crypto/000755 000766 000024 00000000000 13070706730 016225 5ustar00iojsstaff000000 000000 node-v4.8.2/benchmark/dgram/000755 000766 000024 00000000000 13070706730 015777 5ustar00iojsstaff000000 000000 node-v4.8.2/benchmark/domain/000755 000766 000024 00000000000 13070706730 016154 5ustar00iojsstaff000000 000000 node-v4.8.2/benchmark/es/000755 000766 000024 00000000000 13070706730 015314 5ustar00iojsstaff000000 000000 node-v4.8.2/benchmark/events/000755 000766 000024 00000000000 13070706730 016211 5ustar00iojsstaff000000 000000 node-v4.8.2/benchmark/fixtures/000755 000766 000024 00000000000 13070706730 016556 5ustar00iojsstaff000000 000000 node-v4.8.2/benchmark/fs/000755 000766 000024 00000000000 13070706730 015315 5ustar00iojsstaff000000 000000 node-v4.8.2/benchmark/fs-write-stream-throughput.js000644 000766 000024 00000004554 13070706730 022513 0ustar00iojsstaff000000 000000 // If there are no args, then this is the root.  Run all the benchmarks!
'use strict';
if (!process.argv[2])
  parent();
else
  runTest(+process.argv[2], +process.argv[3], process.argv[4]);

function parent() {
  var types = [ 'string', 'buffer' ];
  var durs = [ 1, 5 ];
  var sizes = [ 1, 10, 100, 2048, 10240 ];
  var queue = [];
  types.forEach(function(t) {
    durs.forEach(function(d) {
      sizes.forEach(function(s) {
        queue.push([__filename, d, s, t]);
      });
    });
  });

  var spawn = require('child_process').spawn;
  var node = process.execPath;

  run();

  function run() {
    var args = queue.shift();
    if (!args)
      return;
    var child = spawn(node, args, { stdio: 'inherit' });
    child.on('close', function(code, signal) {
      if (code)
        throw new Error('Benchmark failed: ' + args.slice(1));
      run();
    });
  }
}

function runTest(dur, size, type) {
  if (type !== 'string')
    type = 'buffer';
  var chunk;
  switch (type) {
    case 'string':
      chunk = new Array(size + 1).join('a');
      break;
    case 'buffer':
      chunk = new Buffer(size);
      chunk.fill('a');
      break;
  }

  var fs = require('fs');
  try { fs.unlinkSync('write_stream_throughput'); } catch (e) {}

  var start;
  var end;
  function done() {
    var time = end[0] + end[1] / 1E9;
    var written = fs.statSync('write_stream_throughput').size / 1024;
    var rate = (written / time).toFixed(2);
    console.log('fs_write_stream_dur_%d_size_%d_type_%s: %d',
                dur, size, type, rate);

    try { fs.unlinkSync('write_stream_throughput'); } catch (e) {}
  }

  var f = require('fs').createWriteStream('write_stream_throughput');
  f.on('drain', write);
  f.on('open', write);
  f.on('close', done);

  // streams2 fs.WriteStreams will let you send a lot of writes into the
  // buffer before returning false, so capture the *actual* end time when
  // all the bytes have been written to the disk, indicated by 'finish'
  f.on('finish', function() {
    end = process.hrtime(start);
  });

  var ending = false;
  function write() {
    // don't try to write after we end, even if a 'drain' event comes.
    // v0.8 streams are so sloppy!
    if (ending)
      return;

    start = start || process.hrtime();
    while (false !== f.write(chunk));
    end = process.hrtime(start);

    if (end[0] >= dur) {
      ending = true;
      f.end();
    }
  }
}
node-v4.8.2/benchmark/http/000755 000766 000024 00000000000 13070706730 015664 5ustar00iojsstaff000000 000000 node-v4.8.2/benchmark/http-flamegraph.sh000644 000766 000024 00000005454 13070706730 020334 0ustar00iojsstaff000000 000000 #!/bin/bash
cd "$(dirname "$(dirname $0)")"

node=${NODE:-./node}

name=${NAME:-stacks}

if type sysctl &>/dev/null; then
  # darwin and linux
  sudo sysctl -w net.inet.ip.portrange.first=12000
  sudo sysctl -w net.inet.tcp.msl=1000
  sudo sysctl -w kern.maxfiles=1000000 kern.maxfilesperproc=1000000
elif type /usr/sbin/ndd &>/dev/null; then
  # sunos
  /usr/sbin/ndd -set /dev/tcp tcp_smallest_anon_port 12000
  /usr/sbin/ndd -set /dev/tcp tcp_largest_anon_port 65535
  /usr/sbin/ndd -set /dev/tcp tcp_max_buf 2097152
  /usr/sbin/ndd -set /dev/tcp tcp_xmit_hiwat 1048576
  /usr/sbin/ndd -set /dev/tcp tcp_recv_hiwat 1048576
fi

ulimit -n 100000
$node benchmark/http_simple.js &
nodepid=$!
echo "node pid = $nodepid"
sleep 1

# has to stay alive until dtrace exits
dtrace -n 'profile-97/pid == '$nodepid' && arg1/{ @[jstack(150, 8000)] = count(); } tick-60s { exit(0); }' \
  | grep -v _ZN2v88internalL21Builtin_HandleApiCallENS0_12_GLOBAL__N_116BuiltinA \
  > "$name".src &

dtracepid=$!

echo "dtrace pid = $dtracepid"

sleep 1

test () {
  c=$1
  t=$2
  l=$3
  k=$4
  ab $k -t 10 -c $c http://127.0.0.1:8000/$t/$l \
    2>&1 | grep Req
}

#test 100 bytes 1024
#test 10  bytes 100 -k
#test 100 bytes 1024 -k
#test 100 bytes 1024 -k
#test 100 bytes 1024 -k

echo 'Keep going until dtrace stops listening...'
while pargs $dtracepid &>/dev/null; do
  test 100 bytes ${LENGTH:-1} -k
done

kill $nodepid

echo 'Turn the stacks into a svg'
stackvis dtrace flamegraph-svg < "$name".src > "$name".raw.svg

echo 'Prune tiny stacks out of the graph'
node -e '
var infile = process.argv[1];
var outfile = process.argv[2];
var output = "";
var fs = require("fs");
var input = fs.readFileSync(infile, "utf8");

input = input.split("id=\"details\" > ");
var head = input.shift() + "id=\"details\" > ";
input = input.join("id=\"details\" > ");

var tail = "";
input = input.split("")[0];

var minyKept = Infinity;
var minyOverall = Infinity;
var rects = input.trim().split(/\n/).filter(function(rect) {
  var my = rect.match(/y="([0-9\.]+)"/);

  if (!my)
    return false;
  var y = +my[1];
  if (!y)
    return false;
  minyOverall = Math.min(minyOverall, y);

  // pluck off everything that will be less than one pixel.
  var mw = rect.match(/width="([0-9\.]+)"/)
  if (mw) {
    var width = +mw[1];
    if (!(width >= 1))
      return false;
  }
  minyKept = Math.min(minyKept, y);
  return true;
});

// move everything up to the top of the page.
var ydiff = minyKept - minyOverall;
rects = rects.map(function(rect) {
  var my = rect.match(/y="([0-9\.]+)"/);
  var y = +my[1];
  var newy = y - ydiff;
  rect = rect.replace(/y="([0-9\.]+)"/, "y=\"" + newy + "\"");
  return rect;
});

fs.writeFileSync(outfile, head + "\n" + rects.join("\n") + "\n" + tail);
' "$name".raw.svg "$name".svg

echo ''
echo 'done. Results in '"$name"'.svg'
node-v4.8.2/benchmark/http.sh000755 000766 000024 00000002023 13070706730 016220 0ustar00iojsstaff000000 000000 #!/bin/bash
cd "$(dirname "$(dirname $0)")"

if type sysctl &>/dev/null; then
  # darwin and linux
  sudo sysctl -w net.ipv4.ip_local_port_range="12000 65535"
  sudo sysctl -w net.inet.ip.portrange.first=12000
  sudo sysctl -w net.inet.tcp.msl=1000
  sudo sysctl -w kern.maxfiles=1000000 kern.maxfilesperproc=1000000
elif type /usr/sbin/ndd &>/dev/null; then
  # sunos
  /usr/sbin/ndd -set /dev/tcp tcp_smallest_anon_port 12000
  /usr/sbin/ndd -set /dev/tcp tcp_largest_anon_port 65535
  /usr/sbin/ndd -set /dev/tcp tcp_max_buf 2097152
  /usr/sbin/ndd -set /dev/tcp tcp_xmit_hiwat 1048576
  /usr/sbin/ndd -set /dev/tcp tcp_recv_hiwat 1048576
fi

ulimit -n 100000

k=${KEEPALIVE}
if [ "$k" = "no" ]; then
  k=""
else
  k="-k"
fi
node=${NODE:-./node}

$node benchmark/http_simple.js &
npid=$!

sleep 1

if [ "$k" = "-k" ]; then
  echo "using keepalive"
fi

for i in a a a a a a a a a a a a a a a a a a a a; do
  ab $k -t 10 -c 100 http://127.0.0.1:8000/${TYPE:-bytes}/${LENGTH:-1024} \
    2>&1 | grep Req | egrep -o '[0-9\.]+'
done

kill $npid
node-v4.8.2/benchmark/http_bench.js000644 000766 000024 00000005460 13070706730 017366 0ustar00iojsstaff000000 000000 'use strict';
var spawn = require('child_process').spawn;
var cluster = require('cluster');
var http = require('http');

var options = {
  mode: 'master',
  host: '127.0.0.1',
  port: 22344,
  path: '/',
  servers: 1,
  clients: 1,
  clientConcurrentRequests: 2
};

for (var i = 2; i < process.argv.length; ++i) {
  var args = process.argv[i].split('=', 2);
  var key = args[0];
  var val = args[1];
  options[key] = val;
}

switch (options.mode) {
  case 'master': startMaster(); break;
  case 'server': startServer(); break;
  case 'client': startClient(); break;
  default: throw new Error('Bad mode: ' + options.mode);
}

process.title = 'http_bench[' + options.mode + ']';

// monkey-patch the log functions so they include name + pid
console.log = patch(console.log);
console.trace = patch(console.trace);
console.error = patch(console.error);

function patch(fun) {
  var prefix = process.title + '[' + process.pid + '] ';
  return function() {
    var args = Array.prototype.slice.call(arguments);
    args[0] = prefix + args[0];
    return fun.apply(console, args);
  };
}

function startMaster() {
  if (!cluster.isMaster) return startServer();

  var forkCount = 0;

  cluster.on('online', function() {
    forkCount = forkCount + 1;
    if (forkCount === ~~options.servers) {
      var args = [
        __filename,
        'mode=client',
        'clientConcurrentRequests=' + options.clientConcurrentRequests
      ];
      for (var i = ~~options.clients; i > 0; --i) {
        var cp = spawn(process.execPath, args);
        cp.stdout.pipe(process.stdout);
        cp.stderr.pipe(process.stderr);
      }
    }
  });

  for (var i = ~~options.servers; i > 0; --i) cluster.fork();
}

function startServer() {
  http.createServer(onRequest).listen(options.port, options.host);

  var body = Array(1024).join('x');
  var headers = {'Content-Length': '' + body.length};

  function onRequest(req, res) {
    req.on('error', onError);
    res.on('error', onError);
    res.writeHead(200, headers);
    res.end(body);
  }

  function onError(err) {
    console.error(err.stack);
  }
}

function startClient() {
  // send off a bunch of concurrent requests
  for (var i = ~~options.clientConcurrentRequests; i > 0; --i) {
    sendRequest();
  }

  function sendRequest() {
    var req = http.request(options, onConnection);
    req.on('error', onError);
    req.end();
  }

  // add a little back-off to prevent EADDRNOTAVAIL errors, it's pretty easy
  // to exhaust the available port range
  function relaxedSendRequest() {
    setTimeout(sendRequest, 1);
  }

  function onConnection(res) {
    res.on('error', onError);
    res.on('data', onData);
    res.on('end', relaxedSendRequest);
  }

  function onError(err) {
    console.error(err.stack);
    relaxedSendRequest();
  }

  function onData(data) {
    // this space intentionally left blank
  }
}
node-v4.8.2/benchmark/http_server_lag.js000644 000766 000024 00000000674 13070706730 020442 0ustar00iojsstaff000000 000000 'use strict';

var http = require('http');
var port = parseInt(process.env.PORT, 10) || 8000;
var defaultLag = parseInt(process.argv[2], 10) || 100;

http.createServer(function(req, res) {
  res.writeHead(200, { 'content-type': 'text/plain',
                       'content-length': '2' });

  var lag = parseInt(req.url.split('/').pop(), 10) || defaultLag;
  setTimeout(function() {
    res.end('ok');
  }, lag);
}).listen(port, 'localhost');
node-v4.8.2/benchmark/http_simple.js000644 000766 000024 00000005436 13070706730 017603 0ustar00iojsstaff000000 000000 'use strict';

var http = require('http');

var port = parseInt(process.env.PORT || 8000);

var fixed = 'C'.repeat(20 * 1024),
  storedBytes = {},
  storedBuffer = {},
  storedUnicode = {};

var useDomains = process.env.NODE_USE_DOMAINS;

// set up one global domain.
if (useDomains) {
  var domain = require('domain');
  var gdom = domain.create();
  gdom.on('error', function(er) {
    console.error('Error on global domain', er);
    throw er;
  });
  gdom.enter();
}

var server = module.exports = http.createServer(function(req, res) {
  if (useDomains) {
    var dom = domain.create();
    dom.add(req);
    dom.add(res);
  }

  var commands = req.url.split('/');
  var command = commands[1];
  var body = '';
  var arg = commands[2];
  var n_chunks = parseInt(commands[3], 10);
  var status = 200;

  var n, i;
  if (command == 'bytes') {
    n = ~~arg;
    if (n <= 0)
      throw new Error('bytes called with n <= 0');
    if (storedBytes[n] === undefined) {
      storedBytes[n] = 'C'.repeat(n);
    }
    body = storedBytes[n];

  } else if (command == 'buffer') {
    n = ~~arg;
    if (n <= 0)
      throw new Error('buffer called with n <= 0');
    if (storedBuffer[n] === undefined) {
      storedBuffer[n] = new Buffer(n);
      for (i = 0; i < n; i++) {
        storedBuffer[n][i] = 'C'.charCodeAt(0);
      }
    }
    body = storedBuffer[n];

  } else if (command == 'unicode') {
    n = ~~arg;
    if (n <= 0)
      throw new Error('unicode called with n <= 0');
    if (storedUnicode[n] === undefined) {
      storedUnicode[n] = '\u263A'.repeat(n);
    }
    body = storedUnicode[n];

  } else if (command == 'quit') {
    res.connection.server.close();
    body = 'quitting';

  } else if (command == 'fixed') {
    body = fixed;

  } else if (command == 'echo') {
    res.writeHead(200, { 'Content-Type': 'text/plain',
                         'Transfer-Encoding': 'chunked' });
    req.pipe(res);
    return;

  } else {
    status = 404;
    body = 'not found\n';
  }

  // example: http://localhost:port/bytes/512/4
  // sends a 512 byte body in 4 chunks of 128 bytes
  if (n_chunks > 0) {
    res.writeHead(status, { 'Content-Type': 'text/plain',
                            'Transfer-Encoding': 'chunked' });
    // send body in chunks
    var len = body.length;
    var step = Math.floor(len / n_chunks) || 1;

    for (i = 0, n = (n_chunks - 1); i < n; ++i) {
      res.write(body.slice(i * step, i * step + step));
    }
    res.end(body.slice((n_chunks - 1) * step));
  } else {
    var content_length = body.length.toString();

    res.writeHead(status, { 'Content-Type': 'text/plain',
                            'Content-Length': content_length });
    res.end(body);
  }
});

server.listen(port, function() {
  if (module === require.main)
    console.error('Listening at http://127.0.0.1:' + port + '/');
});
node-v4.8.2/benchmark/http_simple.rb000644 000766 000024 00000004330 13070706730 017562 0ustar00iojsstaff000000 000000 DIR = File.dirname(__FILE__)

def fib(n)
  return 1 if n <= 1
  fib(n-1) + fib(n-2)
end

def wait(seconds)
  n = (seconds / 0.01).to_i
  n.times do
    sleep(0.01)
    #File.read(DIR + '/yahoo.html')
  end
end

class SimpleApp
  @@responses = {}

  def initialize
    @count = 0
  end

  def deferred?(env)
    false
  end

  def call(env)
    path = env['PATH_INFO'] || env['REQUEST_URI']
    commands = path.split('/')

    @count += 1
    if commands.include?('periodical_activity') and @count % 10 != 1
      return [200, {'Content-Type'=>'text/plain'}, "quick response!\r\n"]
    end

    if commands.include?('fibonacci')
      n = commands.last.to_i
      raise "fibonacci called with n <= 0" if n <= 0
      body = (1..n).to_a.map { |i| fib(i).to_s }.join(' ')
      status = 200

    elsif commands.include?('wait')
      n = commands.last.to_f
      raise "wait called with n <= 0" if n <= 0
      wait(n)
      body = "waited about #{n} seconds"
      status = 200

    elsif commands.include?('bytes')
      n = commands.last.to_i
      raise "bytes called with n <= 0" if n <= 0
      body = @@responses[n] || "C"*n
      status = 200

    elsif commands.include?('fixed')
      n = 20 * 1024;
      body = @@responses[n] || "C"*n
      status = 200

    elsif commands.include?('test_post_length')
      input_body = ""
      while chunk = env['rack.input'].read(512)
        input_body << chunk
      end
      if env['CONTENT_LENGTH'].to_i == input_body.length
        body = "Content-Length matches input length"
        status = 200
      else
        body = "Content-Length doesn't matches input length!
          content_length = #{env['CONTENT_LENGTH'].to_i}
          input_body.length = #{input_body.length}"
        status = 500
      end
    else
      status = 404
      body = "Undefined url"
    end

    body += "\r\n"
    headers = {'Content-Type' => 'text/plain', 'Content-Length' => body.length.to_s }
    [status, headers, [body]]
  end
end


if $0 == __FILE__
  #require DIR + '/../lib/ebb'
  require 'rubygems'
  require 'rack'
  require 'thin'
  require 'ebb'
#  Rack::Handler::Mongrel.run(SimpleApp.new, :Port => 8000)
  Thin::Server.start("0.0.0.0", 8000, SimpleApp.new)
#  Ebb::start_server(SimpleApp.new, :port => 8000)
end
node-v4.8.2/benchmark/http_simple_auto.js000644 000766 000024 00000006227 13070706730 020632 0ustar00iojsstaff000000 000000 //
// Usage:
//   node benchmark/http_simple_auto.js  
//
// Where:
//      Arguments to pass to `ab`.
//    Target to benchmark, e.g. `bytes/1024` or `buffer/8192`.
//
'use strict';

var http = require('http');
var spawn = require('child_process').spawn;

var port = parseInt(process.env.PORT || 8000);

var fixed = 'C'.repeat(20 * 1024);

var stored = {};
var storedBuffer = {};

var server = http.createServer(function(req, res) {
  var commands = req.url.split('/');
  var command = commands[1];
  var body = '';
  var arg = commands[2];
  var n_chunks = parseInt(commands[3], 10);
  var status = 200;
  var n;
  var i;

  if (command == 'bytes') {
    n = parseInt(arg, 10);
    if (n <= 0)
      throw new Error('bytes called with n <= 0');
    if (stored[n] === undefined) {
      stored[n] = 'C'.repeat(n);
    }
    body = stored[n];
  } else if (command == 'buffer') {
    n = parseInt(arg, 10);
    if (n <= 0) throw new Error('bytes called with n <= 0');
    if (storedBuffer[n] === undefined) {
      storedBuffer[n] = new Buffer(n);
      for (i = 0; i < n; i++) {
        storedBuffer[n][i] = 'C'.charCodeAt(0);
      }
    }
    body = storedBuffer[n];

  } else if (command == 'quit') {
    res.connection.server.close();
    body = 'quitting';

  } else if (command == 'fixed') {
    body = fixed;

  } else if (command == 'echo') {
    res.writeHead(200, { 'Content-Type': 'text/plain',
                         'Transfer-Encoding': 'chunked' });
    req.pipe(res);
    return;

  } else {
    status = 404;
    body = 'not found\n';
  }

  // example: http://localhost:port/bytes/512/4
  // sends a 512 byte body in 4 chunks of 128 bytes
  if (n_chunks > 0) {
    res.writeHead(status, { 'Content-Type': 'text/plain',
                            'Transfer-Encoding': 'chunked' });
    // send body in chunks
    var len = body.length;
    var step = Math.floor(len / n_chunks) || 1;

    for (i = 0, n = (n_chunks - 1); i < n; ++i) {
      res.write(body.slice(i * step, i * step + step));
    }
    res.end(body.slice((n_chunks - 1) * step));
  } else {
    var content_length = body.length.toString();

    res.writeHead(status, { 'Content-Type': 'text/plain',
                            'Content-Length': content_length });
    res.end(body);
  }

});

server.listen(port, function() {
  var url = 'http://127.0.0.1:' + port + '/';

  var n = process.argv.length - 1;
  process.argv[n] = url + process.argv[n];

  var cp = spawn('ab', process.argv.slice(2));
  cp.stdout.pipe(process.stdout);
  cp.stderr.pipe(process.stderr);
  cp.on('exit', function() {
    server.close();
    process.nextTick(dump_mm_stats);
  });
});

function dump_mm_stats() {
  if (typeof global.gc != 'function') return;

  var before = process.memoryUsage();
  for (var i = 0; i < 10; ++i) global.gc();
  var after = process.memoryUsage();
  setTimeout(print_stats, 250); // give GC time to settle

  function print_stats() {
    console.log('\nBEFORE / AFTER GC');
    ['rss', 'heapTotal', 'heapUsed'].forEach(function(key) {
      var a = before[key] / (1024 * 1024);
      var b = after[key] / (1024 * 1024);
      console.log('%sM / %sM %s', a.toFixed(2), b.toFixed(2), key);
    });
  }
}
node-v4.8.2/benchmark/http_simple_bench.sh000755 000766 000024 00000002676 13070706730 020746 0ustar00iojsstaff000000 000000 #!/bin/bash

SERVER=127.0.0.1
PORT=${PORT:=8000}

# You may want to configure your TCP settings to make many ports available
# to node and ab. On macintosh use:
#   sudo sysctl -w net.inet.ip.portrange.first=32768
#   sudo sysctl -w net.inet.tcp.msl=1000

if [ ! -d benchmark/ ]; then
  echo "Run this script from the node root directory"
  exit 1
fi

if [ $SERVER == "127.0.0.1" ]; then
  ./node benchmark/http_simple.js &
  node_pid=$!
  sleep 1
fi

date=`date "+%Y%m%d%H%M%S"`

ab_hello_world() {
  local type="$1"
  local ressize="$2"
  if [ $type == "string" ]; then
    local uri="bytes/$ressize"
  else
    local uri="buffer/$ressize"
  fi


  name="ab-hello-world-$type-$ressize"

  dir=".benchmark_reports/$name/$rev/"
  if [ ! -d $dir ]; then
    mkdir -p $dir
  fi

  summary_fn="$dir/$date.summary"
  data_fn="$dir/$date.data"

  echo "Bench $name starts in 3 seconds..."
  # let things calm down
  sleep 3

  # hammer that as hard as it can for 10 seconds.
  ab -g $data_fn -c 100 -t 10 http://$SERVER:$PORT/$uri > $summary_fn

  # add our data about the server
  echo >> $summary_fn
  echo >> $summary_fn
  echo "webserver-rev: $rev" >> $summary_fn
  echo "webserver-uname: $uname" >> $summary_fn

  grep Req $summary_fn

  echo "Summary: $summary_fn"
  echo
}

# 1k
ab_hello_world 'string' '1024'
ab_hello_world 'buffer' '1024'

# 100k
ab_hello_world 'string' '102400'
ab_hello_world 'buffer' '102400'


if [ ! -z $node_pid ]; then
  kill -9 $node_pid
fi
node-v4.8.2/benchmark/http_simple_cluster.js000644 000766 000024 00000000475 13070706730 021342 0ustar00iojsstaff000000 000000 'use strict';
const cluster = require('cluster');
const os = require('os');
const path = require('path');

if (cluster.isMaster) {
  console.log('master running on pid %d', process.pid);
  for (var i = 0, n = os.cpus().length; i < n; ++i) cluster.fork();
} else {
  require(path.join(__dirname, 'http_simple.js'));
}
node-v4.8.2/benchmark/idle_clients.js000644 000766 000024 00000001564 13070706730 017707 0ustar00iojsstaff000000 000000 'use strict';
const net = require('net');

var errors = 0, connections = 0;

function connect() {
  process.nextTick(function() {
    var s = net.Stream();
    var gotConnected = false;
    s.connect(9000);

    s.on('connect', function() {
      gotConnected = true;
      connections++;
      connect();
    });

    s.on('close', function() {
      if (gotConnected) connections--;
    });

    s.on('error', function() {
      errors++;
    });
  });
}

connect();


var oldConnections, oldErrors;

// Try to start new connections every so often
setInterval(connect, 5000);

setInterval(function() {
  if (oldConnections != connections) {
    oldConnections = connections;
    console.log('CLIENT %d connections: %d', process.pid, connections);
  }

  if (oldErrors != errors) {
    oldErrors = errors;
    console.log('CLIENT %d errors: %d', process.pid, errors);
  }
}, 1000);

node-v4.8.2/benchmark/idle_server.js000644 000766 000024 00000001077 13070706730 017553 0ustar00iojsstaff000000 000000 'use strict';

const net = require('net');
var errors = 0;

var server = net.Server(function(socket) {

  socket.on('error', function() {
    errors++;
  });

});

//server.maxConnections = 128;

server.listen(9000);

var oldConnections, oldErrors;

setInterval(function() {
  if (oldConnections != server.connections) {
    oldConnections = server.connections;
    console.log('SERVER %d connections: %d', process.pid, server.connections);
  }

  if (oldErrors != errors) {
    oldErrors = errors;
    console.log('SERVER %d errors: %d', process.pid, errors);
  }
}, 1000);
node-v4.8.2/benchmark/io.c000644 000766 000024 00000004201 13070706730 015455 0ustar00iojsstaff000000 000000 /**
 * gcc -o iotest io.c
 */

#include 
#include 
#include 
#include 
#include 
#include 
#include 
#include 
#include 
 
static int c = 0;
static int tsize = 1000 * 1048576;
static const char* path = "/tmp/wt.dat";
static char buf[65536];

static uint64_t now(void) {
  struct timeval tv;

  if (gettimeofday(&tv, NULL))
    abort();

  return tv.tv_sec * 1000000ULL + tv.tv_usec;
}

static void writetest(int size, size_t bsize)
{
  int i;
  uint64_t start, end;
  double elapsed;
  double mbps;

  assert(bsize <= sizeof buf);

  int fd = open(path, O_CREAT|O_WRONLY, 0644);
  if (fd < 0) {
    perror("open failed");
    exit(254);
  }

  start = now();

  for (i = 0; i < size; i += bsize) {
    int rv = write(fd, buf, bsize);
    if (rv < 0) {
      perror("write failed");
      exit(254);
    }
  }

#ifndef NSYNC
# ifdef __linux__
  fdatasync(fd);
# else
  fsync(fd);
# endif
#endif /* SYNC */

  close(fd);

  end = now();
  elapsed = (end - start) / 1e6;
  mbps = ((tsize/elapsed)) / 1048576;

  fprintf(stderr, "Wrote %d bytes in %03fs using %ld byte buffers: %03f\n", size, elapsed, bsize, mbps);
}

void readtest(int size, size_t bsize)
{
  int i;
  uint64_t start, end;
  double elapsed;
  double mbps;

  assert(bsize <= sizeof buf);

  int fd = open(path, O_RDONLY, 0644);
  if (fd < 0) {
    perror("open failed");
    exit(254);
  }

  start = now();

  for (i = 0; i < size; i += bsize) {
    int rv = read(fd, buf, bsize);
    if (rv < 0) {
      perror("write failed");
      exit(254);
    }
  }
  close(fd);

  end = now();
  elapsed = (end - start) / 1e6;
  mbps = ((tsize/elapsed)) / 1048576;

  fprintf(stderr, "Read %d bytes in %03fs using %ld byte buffers: %03fmB/s\n", size, elapsed, bsize, mbps);
}

void cleanup() {
  unlink(path);
}

int main(int argc, char** argv)
{
  int i;
  int bsizes[] = {1024, 4096, 8192, 16384, 32768, 65536, 0};

  if (argc > 1) path = argv[1];

  for (i = 0; bsizes[i] != 0; i++) {
    writetest(tsize, bsizes[i]);
  }
  for (i = 0; bsizes[i] != 0; i++) {
    readtest(tsize, bsizes[i]);
  }
  atexit(cleanup);
  return 0;
}
node-v4.8.2/benchmark/misc/000755 000766 000024 00000000000 13070706730 015640 5ustar00iojsstaff000000 000000 node-v4.8.2/benchmark/module/000755 000766 000024 00000000000 13070706730 016172 5ustar00iojsstaff000000 000000 node-v4.8.2/benchmark/net/000755 000766 000024 00000000000 13070706730 015473 5ustar00iojsstaff000000 000000 node-v4.8.2/benchmark/path/000755 000766 000024 00000000000 13070706730 015641 5ustar00iojsstaff000000 000000 node-v4.8.2/benchmark/plot.R000755 000766 000024 00000004237 13070706730 016017 0ustar00iojsstaff000000 000000 #!/usr/bin/env Rscript

# To use this script you'll need to install R: http://www.r-project.org/
# and a library for R called ggplot2
# Which can be done by starting R and typing install.packages("ggplot2")
# like this:
#
#     shell% R
#     R version 2.11.0 beta (2010-04-12 r51689)
#     >  install.packages("ggplot2")
#     (follow prompt)
#
# Then you can try this script by providing a full path to .data file
# outputed from 'make bench'
#
#     > cd ~/src/node
#     > make bench
#     ...
#     > ./benchmark/plot.R .benchmark_reports/ab-hello-world-buffer-1024/ff456b38862de3fd0118c6ac6b3f46edb1fbb87f/20101013162056.data
#
# This will generate a PNG file which you can view
#
#
# Hopefully these steps will be automated in the future.



library(ggplot2)

args <- commandArgs(TRUE)

ab.load <- function (filename, name) {
  raw <- data.frame(read.csv(filename, sep="\t", header=T), server=name)
  raw <- data.frame(raw, time=raw$seconds-min(raw$seconds))
  raw <- data.frame(raw, time_s=raw$time/1000000)
  raw
}

#ab.tsPoint <- function (d) {
#  qplot(time_s, ttime, data=d, facets=server~.,
#        geom="point", alpha=I(1/15), ylab="response time (ms)",
#        xlab="time (s)", main="c=30, res=26kb",
#        ylim=c(0,100))
#}
#
#ab.tsLine <- function (d) {
#  qplot(time_s, ttime, data=d, facets=server~.,
#        geom="line", ylab="response time (ms)",
#        xlab="time (s)", main="c=30, res=26kb",
#        ylim=c(0,100))
#}


filename <- args[0:1]
data <- ab.load(filename, "node")


# histogram

#hist_png_filename <- gsub(".data", "_hist.png", filename)
hist_png_filename <- "hist.png"

png(filename = hist_png_filename, width = 480, height = 380, units = "px")

qplot(ttime, data=data, geom="histogram",
      main="xxx",
      binwidth=1, xlab="response time (ms)",
      xlim=c(0,100))

print(hist_png_filename)



# time series

#ts_png_filename <- gsub(".data", "_ts.png", filename)
ts_png_filename = "ts.png"

png(filename = ts_png_filename, width = 480, height = 380, units = "px")

qplot(time, ttime, data=data, facets=server~.,
      geom="point", alpha=I(1/15), ylab="response time (ms)",
      xlab="time (s)", main="xxx",
      ylim=c(0,100))

print(ts_png_filename)
node-v4.8.2/benchmark/plot_csv.R000755 000766 000024 00000002051 13070706730 016662 0ustar00iojsstaff000000 000000 #!/usr/bin/env Rscript

# To use this to graph some benchmarks, install R (http://www.r-project.org/)
# and ggplot (http://ggplot2.org/).
#
# Once installed, you can generate some CSV output with a command like this:
#
#     $ OUTPUT_FORMAT=csv node benchmark/http/client-request-body.js > data.csv
#     $ ./benchmark/plot_csv.R data.csv data.png bytes type
#
# Where the 3rd argument to this script is the graph's X coordinate, the 4th is
# how the output is grouped, and the Y coordinate defaults to result.

library(methods)
library(ggplot2)

# get info from arguments
args <- commandArgs(TRUE)

csvFilename <- args[1]
graphFilename <- args[2]

xCoordinate <- args[3]
groupBy <- args[4]

# read data
data <- read.csv(file = csvFilename, head = TRUE)

# plot and save
plot <- ggplot(data = data, aes_string(x = xCoordinate, y = 'result', col = groupBy)) +
        geom_point(size = 5) +
        ggtitle(data$filename)

png(filename = graphFilename, width = 560, height = 480, units = 'px')
print(plot)
graphics.off()

cat(paste('Saved to', graphFilename, '\n'))
node-v4.8.2/benchmark/process/000755 000766 000024 00000000000 13070706730 016363 5ustar00iojsstaff000000 000000 node-v4.8.2/benchmark/querystring/000755 000766 000024 00000000000 13070706730 017301 5ustar00iojsstaff000000 000000 node-v4.8.2/benchmark/README.md000644 000766 000024 00000007714 13070706730 016175 0ustar00iojsstaff000000 000000 # Node.js core benchmark tests

This folder contains benchmark tests to measure the performance for certain
Node.js APIs.

## Prerequisites

Most of the http benchmarks require [`wrk`][wrk] and [`ab`][ab] (ApacheBench) being installed.
These may be available through your preferred package manager.

If they are not available:
- `wrk` may easily be built [from source][wrk] via `make`.
- `ab` is sometimes bundled in a package called `apache2-utils`.

[wrk]: https://github.com/wg/wrk
[ab]: http://httpd.apache.org/docs/2.2/programs/ab.html

## How to run tests

There are three ways to run benchmark tests:

### Run all tests of a given type

For example, buffers:

```bash
node benchmark/common.js buffers
```

The above command will find all scripts under `buffers` directory and require
each of them as a module. When a test script is required, it creates an instance
of `Benchmark` (a class defined in common.js). In the next tick, the `Benchmark`
constructor iterates through the configuration object property values and runs
the test function with each of the combined arguments in spawned processes. For
example, buffers/buffer-read.js has the following configuration:

```js
var bench = common.createBenchmark(main, {
    noAssert: [false, true],
    buffer: ['fast', 'slow'],
    type: ['UInt8', 'UInt16LE', 'UInt16BE',
        'UInt32LE', 'UInt32BE',
        'Int8', 'Int16LE', 'Int16BE',
        'Int32LE', 'Int32BE',
        'FloatLE', 'FloatBE',
        'DoubleLE', 'DoubleBE'],
        millions: [1]
});
```
The runner takes one item from each of the property array value to build a list
of arguments to run the main function. The main function will receive the conf
object as follows:

- first run:
```js
    {   noAssert: false,
        buffer: 'fast',
        type: 'UInt8',
        millions: 1
    }
```
- second run:
```js
    {
        noAssert: false,
        buffer: 'fast',
        type: 'UInt16LE',
        millions: 1
    }
```
...

In this case, the main function will run 2*2*14*1 = 56 times. The console output
looks like the following:

```
buffers//buffer-read.js
buffers/buffer-read.js noAssert=false buffer=fast type=UInt8 millions=1: 271.83
buffers/buffer-read.js noAssert=false buffer=fast type=UInt16LE millions=1: 239.43
buffers/buffer-read.js noAssert=false buffer=fast type=UInt16BE millions=1: 244.57
...
```

The last number is the rate of operations. Higher is better.

### Run an individual test

For example, buffer-slice.js:

```bash
node benchmark/buffers/buffer-read.js
```
The output:
```
buffers/buffer-read.js noAssert=false buffer=fast type=UInt8 millions=1: 246.79
buffers/buffer-read.js noAssert=false buffer=fast type=UInt16LE millions=1: 240.11
buffers/buffer-read.js noAssert=false buffer=fast type=UInt16BE millions=1: 245.91
...
```

### Run tests with options

This example will run only the first type of url test, with one iteration.
(Note: benchmarks require __many__ iterations to be statistically accurate.)


```bash
node benchmark/url/url-parse.js type=one n=1
```
Output:
```
url/url-parse.js type=one n=1: 1663.74402
```

## How to write a benchmark test

The benchmark tests are grouped by types. Each type corresponds to a subdirectory,
such as `arrays`, `buffers`, or `fs`.

Let's add a benchmark test for Buffer.slice function. We first create a file
buffers/buffer-slice.js.

### The code snippet

```js
var common = require('../common.js'); // Load the test runner

var SlowBuffer = require('buffer').SlowBuffer;

// Create a benchmark test for function `main` and the configuration variants
var bench = common.createBenchmark(main, {
  type: ['fast', 'slow'], // Two types of buffer
  n: [512] // Number of times (each unit is 1024) to call the slice API
});

function main(conf) {
  // Read the parameters from the configuration
  var n = +conf.n;
  var b = conf.type === 'fast' ? buf : slowBuf;
  bench.start(); // Start benchmarking
  for (var i = 0; i < n * 1024; i++) {
    // Add your test here
    b.slice(10, 256);
  }
  bench.end(n); // End benchmarking
}
```
node-v4.8.2/benchmark/report-startup-memory.js000644 000766 000024 00000000066 13070706730 021566 0ustar00iojsstaff000000 000000 'use strict';
console.log(process.memoryUsage().rss);
node-v4.8.2/benchmark/static_http_server.js000644 000766 000024 00000001345 13070706730 021162 0ustar00iojsstaff000000 000000 'use strict';
var http = require('http');

var concurrency = 30;
var port = 12346;
var n = 700;
var bytes = 1024 * 5;

var responses = 0;

var body = 'C'.repeat(bytes);

var server = http.createServer(function(req, res) {
  res.writeHead(200, {
    'Content-Type': 'text/plain',
    'Content-Length': body.length
  });
  res.end(body);
});

server.listen(port, function() {
  var agent = new http.Agent();
  agent.maxSockets = concurrency;

  for (var i = 0; i < n; i++) {
    var req = http.get({
      port:  port,
      path:  '/',
      agent: agent
    }, function(res) {
      res.resume();
      res.on('end', function() {
        if (++responses === n) {
          server.close();
        }
      });
    });
    req.id = i;
  }
});
node-v4.8.2/benchmark/string_decoder/000755 000766 000024 00000000000 13070706730 017700 5ustar00iojsstaff000000 000000 node-v4.8.2/benchmark/timers/000755 000766 000024 00000000000 13070706730 016210 5ustar00iojsstaff000000 000000 node-v4.8.2/benchmark/tls/000755 000766 000024 00000000000 13070706730 015507 5ustar00iojsstaff000000 000000 node-v4.8.2/benchmark/url/000755 000766 000024 00000000000 13070706730 015507 5ustar00iojsstaff000000 000000 node-v4.8.2/benchmark/util/000755 000766 000024 00000000000 13070706730 015662 5ustar00iojsstaff000000 000000 node-v4.8.2/benchmark/util/format.js000644 000766 000024 00000001607 13070706730 017514 0ustar00iojsstaff000000 000000 'use strict';

const util = require('util');
const common = require('../common');
const v8 = require('v8');
const bench = common.createBenchmark(main, {
  n: [1e6]
, type: ['string',
         'number',
         'object',
         'unknown',
         'no-replace']
});

const inputs = {
  'string': ['Hello, my name is %s', 'fred'],
  'number': ['Hi, I was born in %d', 1942],
  'object': ['An error occurred %j', {msg: 'This is an error', code: 'ERR'}],
  'unknown': ['hello %a', 'test'],
  'no-replace': [1, 2]
};

function main(conf) {
  const n = conf.n | 0;
  const type = conf.type;

  const input = inputs[type];

  v8.setFlagsFromString('--allow_natives_syntax');

  util.format(input[0], input[1]);
  eval('%OptimizeFunctionOnNextCall(util.format)');
  util.format(input[0], input[1]);

  bench.start();
  for (var i = 0; i < n; i++) {
    util.format(input[0], input[1]);
  }
  bench.end(n);
}
node-v4.8.2/benchmark/util/inspect.js000644 000766 000024 00000000464 13070706730 017671 0ustar00iojsstaff000000 000000 'use strict';
var util = require('util');

var common = require('../common.js');

var bench = common.createBenchmark(main, {n: [5e6]});

function main(conf) {
  var n = conf.n | 0;

  bench.start();
  for (var i = 0; i < n; i += 1) {
    util.inspect({a: 'a', b: 'b', c: 'c', d: 'd'});
  }
  bench.end(n);
}
node-v4.8.2/benchmark/url/url-format.js000644 000766 000024 00000001451 13070706730 020136 0ustar00iojsstaff000000 000000 'use strict';
const common = require('../common.js');
const url = require('url');
const v8 = require('v8');

const bench = common.createBenchmark(main, {
  type: 'one two'.split(' '),
  n: [25e6]
});

function main(conf) {
  const type = conf.type;
  const n = conf.n | 0;

  const inputs = {
    one: {slashes: true, host: 'localhost'},
    two: {protocol: 'file:', pathname: '/foo'},
  };
  const input = inputs[type] || '';

  // Force-optimize url.format() so that the benchmark doesn't get
  // disrupted by the optimizer kicking in halfway through.
  for (const name in inputs)
    url.format(inputs[name]);

  v8.setFlagsFromString('--allow_natives_syntax');
  eval('%OptimizeFunctionOnNextCall(url.format)');

  bench.start();
  for (var i = 0; i < n; i += 1)
    url.format(input);
  bench.end(n);
}
node-v4.8.2/benchmark/url/url-parse.js000644 000766 000024 00000002027 13070706730 017760 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var url = require('url');
var v8 = require('v8');

var bench = common.createBenchmark(main, {
  type: 'one two three four five six'.split(' '),
  n: [25e4]
});

function main(conf) {
  var type = conf.type;
  var n = conf.n | 0;

  var inputs = {
    one: 'http://nodejs.org/docs/latest/api/url.html#url_url_format_urlobj',
    two: 'http://blog.nodejs.org/',
    three: 'https://encrypted.google.com/search?q=url&q=site:npmjs.org&hl=en',
    four: 'javascript:alert("node is awesome");',
    five: 'some.ran/dom/url.thing?oh=yes#whoo',
    six: 'https://user:pass@example.com/',
  };
  var input = inputs[type] || '';

  // Force-optimize url.parse() so that the benchmark doesn't get
  // disrupted by the optimizer kicking in halfway through.
  for (var name in inputs)
    url.parse(inputs[name]);

  v8.setFlagsFromString('--allow_natives_syntax');
  eval('%OptimizeFunctionOnNextCall(url.parse)');

  bench.start();
  for (var i = 0; i < n; i += 1)
    url.parse(input);
  bench.end(n);
}
node-v4.8.2/benchmark/url/url-resolve.js000644 000766 000024 00000002117 13070706730 020325 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var url = require('url');
var v8 = require('v8');

var hrefs = [
  'http://example.com/',
  'http://nodejs.org/docs/latest/api/url.html#url_url_format_urlobj',
  'http://blog.nodejs.org/',
  'https://encrypted.google.com/search?q=url&q=site:npmjs.org&hl=en',
  'javascript:alert("node is awesome");',
  'some.ran/dom/url.thing?oh=yes#whoo'
];


var paths = [
  '../../../../../etc/passwd',
  '../foo/bar?baz=boom',
  'foo/bar',
  'http://nodejs.org',
  './foo/bar?baz'
];

var bench = common.createBenchmark(main, {
  href: Object.keys(hrefs),
  path: Object.keys(paths),
  n: [1e5]
});

function main(conf) {
  var n = conf.n | 0;
  var href = hrefs[conf.href];
  var path = paths[conf.path];

  // Force-optimize url.resolve() so that the benchmark doesn't get
  // disrupted by the optimizer kicking in halfway through.
  url.resolve(href, path);
  v8.setFlagsFromString('--allow_natives_syntax');
  eval('%OptimizeFunctionOnNextCall(url.resolve)');

  bench.start();
  for (var i = 0; i < n; i += 1)
    url.resolve(href, path);
  bench.end(n);
}
node-v4.8.2/benchmark/url/url.js000644 000766 000024 00000001744 13070706730 016655 0ustar00iojsstaff000000 000000 'use strict';
var url = require('url');
var n = 25 * 100;

var urls = [
  'http://nodejs.org/docs/latest/api/url.html#url_url_format_urlobj',
  'http://blog.nodejs.org/',
  'https://encrypted.google.com/search?q=url&q=site:npmjs.org&hl=en',
  'javascript:alert("node is awesome");',
  'some.ran/dom/url.thing?oh=yes#whoo'
];

var paths = [
  '../foo/bar?baz=boom',
  'foo/bar',
  'http://nodejs.org',
  './foo/bar?baz'
];

benchmark('parse()', url.parse);
benchmark('format()', url.format);
paths.forEach(function(p) {
  benchmark('resolve("' + p + '")', function(u) {
    url.resolve(u, p);
  });
});

function benchmark(name, fun) {
  var timestamp = process.hrtime();
  for (var i = 0; i < n; ++i) {
    for (var j = 0, k = urls.length; j < k; ++j) fun(urls[j]);
  }
  timestamp = process.hrtime(timestamp);

  var seconds = timestamp[0];
  var nanos = timestamp[1];
  var time = seconds + nanos / 1e9;
  var rate = n / time;

  console.log('misc/url.js %s: %s', name, rate.toPrecision(5));
}
node-v4.8.2/benchmark/tls/throughput.js000644 000766 000024 00000003353 13070706730 020262 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var bench = common.createBenchmark(main, {
  dur: [5],
  type: ['buf', 'asc', 'utf'],
  size: [2, 1024, 1024 * 1024]
});

var dur, type, encoding, size;
var server;

var path = require('path');
var fs = require('fs');
var cert_dir = path.resolve(__dirname, '../../test/fixtures');
var options;
var tls = require('tls');

function main(conf) {
  dur = +conf.dur;
  type = conf.type;
  size = +conf.size;

  var chunk;
  switch (type) {
    case 'buf':
      chunk = new Buffer(size);
      chunk.fill('b');
      break;
    case 'asc':
      chunk = new Array(size + 1).join('a');
      encoding = 'ascii';
      break;
    case 'utf':
      chunk = new Array(size / 2 + 1).join('ü');
      encoding = 'utf8';
      break;
    default:
      throw new Error('invalid type');
  }

  options = { key: fs.readFileSync(cert_dir + '/test_key.pem'),
              cert: fs.readFileSync(cert_dir + '/test_cert.pem'),
              ca: [ fs.readFileSync(cert_dir + '/test_ca.pem') ],
              ciphers: 'AES256-GCM-SHA384' };

  server = tls.createServer(options, onConnection);
  setTimeout(done, dur * 1000);
  var conn;
  server.listen(common.PORT, function() {
    var opt = { port: common.PORT, rejectUnauthorized: false };
    conn = tls.connect(opt, function() {
      bench.start();
      conn.on('drain', write);
      write();
    });

    function write() {
      while (false !== conn.write(chunk, encoding));
    }
  });

  var received = 0;
  function onConnection(conn) {
    conn.on('data', function(chunk) {
      received += chunk.length;
    });
  }

  function done() {
    var mbits = (received * 8) / (1024 * 1024);
    bench.end(mbits);
    if (conn)
      conn.destroy();
    server.close();
  }
}

node-v4.8.2/benchmark/tls/tls-connect.js000644 000766 000024 00000003141 13070706730 020275 0ustar00iojsstaff000000 000000 'use strict';
var fs = require('fs'),
  path = require('path'),
  tls = require('tls');

var common = require('../common.js');
var bench = common.createBenchmark(main, {
  concurrency: [1, 10],
  dur: [5]
});

var clientConn = 0;
var serverConn = 0;
var server;
var dur;
var concurrency;
var running = true;

function main(conf) {
  dur = +conf.dur;
  concurrency = +conf.concurrency;

  var cert_dir = path.resolve(__dirname, '../../test/fixtures'),
    options = { key: fs.readFileSync(cert_dir + '/test_key.pem'),
                cert: fs.readFileSync(cert_dir + '/test_cert.pem'),
                ca: [ fs.readFileSync(cert_dir + '/test_ca.pem') ],
                ciphers: 'AES256-GCM-SHA384' };

  server = tls.createServer(options, onConnection);
  server.listen(common.PORT, onListening);
}

function onListening() {
  setTimeout(done, dur * 1000);
  bench.start();
  for (var i = 0; i < concurrency; i++)
    makeConnection();
}

function onConnection(conn) {
  serverConn++;
}

function makeConnection() {
  var conn = tls.connect({ port: common.PORT,
                           rejectUnauthorized: false }, function() {
    clientConn++;
    conn.on('error', function(er) {
      console.error('client error', er);
      throw er;
    });
    conn.end();
    if (running) makeConnection();
  });
}

function done() {
  running = false;
  // it's only an established connection if they both saw it.
  // because we destroy the server somewhat abruptly, these
  // don't always match.  Generally, serverConn will be
  // the smaller number, but take the min just to be sure.
  bench.end(Math.min(serverConn, clientConn));
}
node-v4.8.2/benchmark/timers/timers-breadth.js000644 000766 000024 00000000525 13070706730 021462 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');

var bench = common.createBenchmark(main, {
  thousands: [500],
});

function main(conf) {
  var N = +conf.thousands * 1e3;
  var n = 0;
  bench.start();
  function cb() {
    n++;
    if (n === N)
      bench.end(N / 1e3);
  }
  for (var i = 0; i < N; i++) {
    setTimeout(cb, 1);
  }
}
node-v4.8.2/benchmark/timers/timers-cancel-pooled.js000644 000766 000024 00000001151 13070706730 022552 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var assert = require('assert');

var bench = common.createBenchmark(main, {
  thousands: [500],
});

function main(conf) {
  var iterations = +conf.thousands * 1e3;

  var timer = setTimeout(() => {}, 1);
  for (var i = 0; i < iterations; i++) {
    setTimeout(cb, 1);
  }
  var next = timer._idlePrev;
  clearTimeout(timer);

  bench.start();

  for (var j = 0; j < iterations; j++) {
    timer = next;
    next = timer._idlePrev;
    clearTimeout(timer);
  }

  bench.end(iterations / 1e3);
}

function cb() {
  assert(false, 'Timer should not call callback');
}
node-v4.8.2/benchmark/timers/timers-cancel-unpooled.js000644 000766 000024 00000001057 13070706730 023122 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var assert = require('assert');

var bench = common.createBenchmark(main, {
  thousands: [100],
});

function main(conf) {
  var iterations = +conf.thousands * 1e3;

  var timersList = [];
  for (var i = 0; i < iterations; i++) {
    timersList.push(setTimeout(cb, i + 1));
  }

  bench.start();
  for (var j = 0; j < iterations + 1; j++) {
    clearTimeout(timersList[j]);
  }
  bench.end(iterations / 1e3);
}

function cb() {
  assert(false, 'Timer ' + this._idleTimeout + ' should not call callback');
}
node-v4.8.2/benchmark/timers/timers-depth.js000644 000766 000024 00000000517 13070706730 021156 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');

var bench = common.createBenchmark(main, {
  thousands: [1],
});

function main(conf) {
  var N = +conf.thousands * 1e3;
  var n = 0;
  bench.start();
  setTimeout(cb, 1);
  function cb() {
    n++;
    if (n === N)
      bench.end(N / 1e3);
    else
      setTimeout(cb, 1);
  }
}
node-v4.8.2/benchmark/timers/timers-insert-pooled.js000644 000766 000024 00000000470 13070706730 022634 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');

var bench = common.createBenchmark(main, {
  thousands: [500],
});

function main(conf) {
  var iterations = +conf.thousands * 1e3;

  bench.start();

  for (var i = 0; i < iterations; i++) {
    setTimeout(() => {}, 1);
  }

  bench.end(iterations / 1e3);
}
node-v4.8.2/benchmark/timers/timers-insert-unpooled.js000644 000766 000024 00000001060 13070706730 023173 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var assert = require('assert');

var bench = common.createBenchmark(main, {
  thousands: [100],
});

function main(conf) {
  var iterations = +conf.thousands * 1e3;

  var timersList = [];

  bench.start();
  for (var i = 0; i < iterations; i++) {
    timersList.push(setTimeout(cb, i + 1));
  }
  bench.end(iterations / 1e3);

  for (var j = 0; j < iterations + 1; j++) {
    clearTimeout(timersList[j]);
  }
}

function cb() {
  assert(false, 'Timer ' + this._idleTimeout + ' should not call callback');
}
node-v4.8.2/benchmark/timers/timers-timeout-pooled.js000644 000766 000024 00000000610 13070706730 023012 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');

var bench = common.createBenchmark(main, {
  thousands: [500],
});

function main(conf) {
  var iterations = +conf.thousands * 1e3;
  var count = 0;

  for (var i = 0; i < iterations; i++) {
    setTimeout(cb, 1);
  }

  bench.start();

  function cb() {
    count++;
    if (count === iterations)
      bench.end(iterations / 1e3);
  }
}
node-v4.8.2/benchmark/string_decoder/string-decoder.js000644 000766 000024 00000003102 13070706730 023143 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var StringDecoder = require('string_decoder').StringDecoder;

var bench = common.createBenchmark(main, {
  encoding: ['ascii', 'utf8', 'base64-utf8', 'base64-ascii'],
  inlen: [32, 128, 1024],
  chunk: [16, 64, 256, 1024],
  n: [25e4]
});

var UTF_ALPHA = 'Blbrsyltety';
var ASC_ALPHA = 'Blueberry jam';

function main(conf) {
  var encoding = conf.encoding;
  var inLen = conf.inlen | 0;
  var chunkLen = conf.chunk | 0;
  var n = conf.n | 0;

  var alpha;
  var chunks = [];
  var str = '';
  var isBase64 = (encoding === 'base64-ascii' || encoding === 'base64-utf8');
  var i;

  if (encoding === 'ascii' || encoding === 'base64-ascii')
    alpha = ASC_ALPHA;
  else if (encoding === 'utf8' || encoding === 'base64-utf8')
    alpha = UTF_ALPHA;
  else
    throw new Error('Bad encoding');

  var sd = new StringDecoder(isBase64 ? 'base64' : encoding);

  for (i = 0; i < inLen; ++i) {
    if (i > 0 && (i % chunkLen) === 0 && !isBase64) {
      chunks.push(new Buffer(str, encoding));
      str = '';
    }
    str += alpha[i % alpha.length];
  }
  if (str.length > 0 && !isBase64)
    chunks.push(new Buffer(str, encoding));
  if (isBase64) {
    str = new Buffer(str, 'utf8').toString('base64');
    while (str.length > 0) {
      var len = Math.min(chunkLen, str.length);
      chunks.push(new Buffer(str.substring(0, len), 'utf8'));
      str = str.substring(len);
    }
  }

  var nChunks = chunks.length;

  bench.start();
  for (i = 0; i < n; ++i) {
    for (var j = 0; j < nChunks; ++j)
      sd.write(chunks[j]);
  }
  bench.end(n);
}
node-v4.8.2/benchmark/querystring/querystring-parse.js000644 000766 000024 00000002203 13070706730 023340 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var querystring = require('querystring');
var v8 = require('v8');

var bench = common.createBenchmark(main, {
  type: ['noencode', 'encodemany', 'encodelast', 'multivalue'],
  n: [1e6],
});

function main(conf) {
  var type = conf.type;
  var n = conf.n | 0;

  var inputs = {
    noencode: 'foo=bar&baz=quux&xyzzy=thud',
    encodemany: '%66%6F%6F=bar&%62%61%7A=quux&xyzzy=%74h%75d',
    encodelast: 'foo=bar&baz=quux&xyzzy=thu%64',
    multivalue: 'foo=bar&foo=baz&foo=quux&quuy=quuz'
  };
  var input = inputs[type];

  // Force-optimize querystring.parse() so that the benchmark doesn't get
  // disrupted by the optimizer kicking in halfway through.
  for (var name in inputs)
    querystring.parse(inputs[name]);

  v8.setFlagsFromString('--allow_natives_syntax');
  eval('%OptimizeFunctionOnNextCall(querystring.parse)');

  var i;
  if (type !== 'multicharsep') {
    bench.start();
    for (i = 0; i < n; i += 1)
      querystring.parse(input);
    bench.end(n);
  } else {
    bench.start();
    for (i = 0; i < n; i += 1)
      querystring.parse(input, '&&&&&&&&&&');
    bench.end(n);
  }
}
node-v4.8.2/benchmark/querystring/querystring-stringify.js000644 000766 000024 00000002050 13070706730 024244 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var querystring = require('querystring');
var v8 = require('v8');

var bench = common.createBenchmark(main, {
  type: ['noencode', 'encodemany', 'encodelast'],
  n: [1e6],
});

function main(conf) {
  var type = conf.type;
  var n = conf.n | 0;

  var inputs = {
    noencode: {
      foo: 'bar',
      baz: 'quux',
      xyzzy: 'thud'
    },
    encodemany: {
      '\u0080\u0083\u0089': 'bar',
      '\u008C\u008E\u0099': 'quux',
      xyzzy: '\u00A5q\u00A3r'
    },
    encodelast: {
      foo: 'bar',
      baz: 'quux',
      xyzzy: 'thu\u00AC'
    }
  };
  var input = inputs[type];

  // Force-optimize querystring.stringify() so that the benchmark doesn't get
  // disrupted by the optimizer kicking in halfway through.
  for (var name in inputs)
    querystring.stringify(inputs[name]);

  v8.setFlagsFromString('--allow_natives_syntax');
  eval('%OptimizeFunctionOnNextCall(querystring.stringify)');

  bench.start();
  for (var i = 0; i < n; i += 1)
    querystring.stringify(input);
  bench.end(n);
}
node-v4.8.2/benchmark/process/next-tick-breadth-args.js000644 000766 000024 00000001237 13070706730 023173 0ustar00iojsstaff000000 000000 'use strict';

var common = require('../common.js');
var bench = common.createBenchmark(main, {
  millions: [2]
});

function main(conf) {
  var N = +conf.millions * 1e6;
  var n = 0;

  function cb1(arg1) {
    n++;
    if (n === N)
      bench.end(n / 1e6);
  }
  function cb2(arg1, arg2) {
    n++;
    if (n === N)
      bench.end(n / 1e6);
  }
  function cb3(arg1, arg2, arg3) {
    n++;
    if (n === N)
      bench.end(n / 1e6);
  }

  bench.start();
  for (var i = 0; i < N; i++) {
    if (i % 3 === 0)
      process.nextTick(cb3, 512, true, null);
    else if (i % 2 === 0)
      process.nextTick(cb2, false, 5.1);
    else
      process.nextTick(cb1, 0);
  }
}
node-v4.8.2/benchmark/process/next-tick-breadth.js000644 000766 000024 00000000525 13070706730 022240 0ustar00iojsstaff000000 000000 'use strict';

var common = require('../common.js');
var bench = common.createBenchmark(main, {
  millions: [2]
});

function main(conf) {
  var N = +conf.millions * 1e6;
  var n = 0;

  function cb() {
    n++;
    if (n === N)
      bench.end(n / 1e6);
  }

  bench.start();
  for (var i = 0; i < N; i++) {
    process.nextTick(cb);
  }
}
node-v4.8.2/benchmark/process/next-tick-depth-args.js000644 000766 000024 00000002105 13070706730 022661 0ustar00iojsstaff000000 000000 'use strict';

var common = require('../common.js');
var bench = common.createBenchmark(main, {
  millions: [2]
});

process.maxTickDepth = Infinity;

function main(conf) {
  var n = +conf.millions * 1e6;

  function cb3(arg1, arg2, arg3) {
    if (--n) {
      if (n % 3 === 0)
        process.nextTick(cb3, 512, true, null);
      else if (n % 2 === 0)
        process.nextTick(cb2, false, 5.1);
      else
        process.nextTick(cb1, 0);
    } else
      bench.end(+conf.millions);
  }
  function cb2(arg1, arg2) {
    if (--n) {
      if (n % 3 === 0)
        process.nextTick(cb3, 512, true, null);
      else if (n % 2 === 0)
        process.nextTick(cb2, false, 5.1);
      else
        process.nextTick(cb1, 0);
    } else
      bench.end(+conf.millions);
  }
  function cb1(arg1) {
    if (--n) {
      if (n % 3 === 0)
        process.nextTick(cb3, 512, true, null);
      else if (n % 2 === 0)
        process.nextTick(cb2, false, 5.1);
      else
        process.nextTick(cb1, 0);
    } else
      bench.end(+conf.millions);
  }
  bench.start();
  process.nextTick(cb1, true);
}
node-v4.8.2/benchmark/process/next-tick-depth.js000644 000766 000024 00000000571 13070706730 021734 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var bench = common.createBenchmark(main, {
  millions: [2]
});

process.maxTickDepth = Infinity;

function main(conf) {
  var n = +conf.millions * 1e6;

  bench.start();
  process.nextTick(onNextTick);
  function onNextTick() {
    if (--n)
      process.nextTick(onNextTick);
    else
      bench.end(+conf.millions);
  }
}
node-v4.8.2/benchmark/path/basename.js000644 000766 000024 00000001253 13070706730 017753 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var path = require('path');
var v8 = require('v8');

var bench = common.createBenchmark(main, {
  type: ['win32', 'posix'],
  n: [1e6],
});

function main(conf) {
  var n = +conf.n;
  var p = path[conf.type];

  // Force optimization before starting the benchmark
  p.basename('/foo/bar/baz/asdf/quux.html');
  v8.setFlagsFromString('--allow_natives_syntax');
  eval('%OptimizeFunctionOnNextCall(p.basename)');
  p.basename('/foo/bar/baz/asdf/quux.html');

  bench.start();
  for (var i = 0; i < n; i++) {
    p.basename('/foo/bar/baz/asdf/quux.html');
    p.basename('/foo/bar/baz/asdf/quux.html', '.html');
  }
  bench.end(n);
}
node-v4.8.2/benchmark/path/dirname.js000644 000766 000024 00000001140 13070706730 017612 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var path = require('path');
var v8 = require('v8');

var bench = common.createBenchmark(main, {
  type: ['win32', 'posix'],
  n: [1e6],
});

function main(conf) {
  var n = +conf.n;
  var p = path[conf.type];

  // Force optimization before starting the benchmark
  p.dirname('/foo/bar/baz/asdf/quux');
  v8.setFlagsFromString('--allow_natives_syntax');
  eval('%OptimizeFunctionOnNextCall(p.dirname)');
  p.dirname('/foo/bar/baz/asdf/quux');

  bench.start();
  for (var i = 0; i < n; i++) {
    p.dirname('/foo/bar/baz/asdf/quux');
  }
  bench.end(n);
}
node-v4.8.2/benchmark/path/extname.js000644 000766 000024 00000001124 13070706730 017636 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var path = require('path');
var v8 = require('v8');

var bench = common.createBenchmark(main, {
  type: ['win32', 'posix'],
  n: [1e6],
});

function main(conf) {
  var n = +conf.n;
  var p = path[conf.type];

  // Force optimization before starting the benchmark
  p.extname('index.html');
  v8.setFlagsFromString('--allow_natives_syntax');
  eval('%OptimizeFunctionOnNextCall(p.extname)');
  p.extname('index.html');

  bench.start();
  for (var i = 0; i < n; i++) {
    p.extname('index.html');
    p.extname('index');
  }
  bench.end(n);
}
node-v4.8.2/benchmark/path/format.js000644 000766 000024 00000001442 13070706730 017470 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var path = require('path');
var v8 = require('v8');

var bench = common.createBenchmark(main, {
  type: ['win32', 'posix'],
  n: [1e7],
});

function main(conf) {
  var n = +conf.n;
  var p = path[conf.type];
  var test = conf.type === 'win32' ? {
    root: 'C:\\',
    dir: 'C:\\path\\dir',
    base: 'index.html',
    ext: '.html',
    name: 'index'
  } : {
    root: '/',
    dir: '/home/user/dir',
    base: 'index.html',
    ext: '.html',
    name: 'index'
  };

  // Force optimization before starting the benchmark
  p.format(test);
  v8.setFlagsFromString('--allow_natives_syntax');
  eval('%OptimizeFunctionOnNextCall(p.format)');
  p.format(test);

  bench.start();
  for (var i = 0; i < n; i++) {
    p.format(test);
  }
  bench.end(n);
}
node-v4.8.2/benchmark/path/isAbsolute.js000644 000766 000024 00000001452 13070706730 020313 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var path = require('path');
var v8 = require('v8');

var bench = common.createBenchmark(main, {
  type: ['win32', 'posix'],
  n: [1e6],
});

function main(conf) {
  var n = +conf.n;
  var p = path[conf.type];
  var tests = conf.type === 'win32'
    ? ['//server', 'C:\\baz\\..', 'bar\\baz', '.']
    : ['/foo/bar', '/baz/..', 'bar/baz', '.'];

  // Force optimization before starting the benchmark
  p.isAbsolute(tests[0]);
  v8.setFlagsFromString('--allow_natives_syntax');
  eval('%OptimizeFunctionOnNextCall(p.isAbsolute)');
  p.isAbsolute(tests[0]);

  bench.start();
  for (var i = 0; i < n; i++) {
    runTests(p, tests);
  }
  bench.end(n);
}

function runTests(p, tests) {
  for (var i = 0; i < tests.length; i++) {
    p.isAbsolute(tests[i]);
  }
}
node-v4.8.2/benchmark/path/join.js000644 000766 000024 00000001215 13070706730 017135 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var path = require('path');
var v8 = require('v8');

var bench = common.createBenchmark(main, {
  type: ['win32', 'posix'],
  n: [1e6],
});

function main(conf) {
  var n = +conf.n;
  var p = path[conf.type];

  // Force optimization before starting the benchmark
  p.join('/foo', 'bar', '', 'baz/asdf', 'quux', '..');
  v8.setFlagsFromString('--allow_natives_syntax');
  eval('%OptimizeFunctionOnNextCall(p.join)');
  p.join('/foo', 'bar', '', 'baz/asdf', 'quux', '..');

  bench.start();
  for (var i = 0; i < n; i++) {
    p.join('/foo', 'bar', '', 'baz/asdf', 'quux', '..');
  }
  bench.end(n);
}
node-v4.8.2/benchmark/path/normalize.js000644 000766 000024 00000001164 13070706730 020201 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var path = require('path');
var v8 = require('v8');

var bench = common.createBenchmark(main, {
  type: ['win32', 'posix'],
  n: [1e6],
});

function main(conf) {
  var n = +conf.n;
  var p = path[conf.type];

  // Force optimization before starting the benchmark
  p.normalize('/foo/bar//baz/asdf/quux/..');
  v8.setFlagsFromString('--allow_natives_syntax');
  eval('%OptimizeFunctionOnNextCall(p.normalize)');
  p.normalize('/foo/bar//baz/asdf/quux/..');

  bench.start();
  for (var i = 0; i < n; i++) {
    p.normalize('/foo/bar//baz/asdf/quux/..');
  }
  bench.end(n);
}
node-v4.8.2/benchmark/path/parse.js000644 000766 000024 00000001204 13070706730 017306 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var path = require('path');
var v8 = require('v8');

var bench = common.createBenchmark(main, {
  type: ['win32', 'posix'],
  n: [1e6],
});

function main(conf) {
  var n = +conf.n;
  var p = path[conf.type];
  var test = conf.type === 'win32'
    ? 'C:\\path\\dir\\index.html'
    : '/home/user/dir/index.html';

  // Force optimization before starting the benchmark
  p.parse(test);
  v8.setFlagsFromString('--allow_natives_syntax');
  eval('%OptimizeFunctionOnNextCall(p.parse)');
  p.parse(test);

  bench.start();
  for (var i = 0; i < n; i++) {
    p.parse(test);
  }
  bench.end(n);
}
node-v4.8.2/benchmark/path/relative.js000644 000766 000024 00000001433 13070706730 020013 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var path = require('path');
var v8 = require('v8');

var bench = common.createBenchmark(main, {
  type: ['win32', 'posix'],
  n: [1e5],
});

function main(conf) {
  var n = +conf.n;
  var runTest = conf.type === 'win32' ? runWin32Test : runPosixTest;

  // Force optimization before starting the benchmark
  runTest();
  v8.setFlagsFromString('--allow_natives_syntax');
  eval('%OptimizeFunctionOnNextCall(path[conf.type].relative)');
  runTest();

  bench.start();
  for (var i = 0; i < n; i++) {
    runTest();
  }
  bench.end(n);
}

function runWin32Test() {
  path.win32.relative('C:\\orandea\\test\\aaa', 'C:\\orandea\\impl\\bbb');
}

function runPosixTest() {
  path.posix.relative('/data/orandea/test/aaa', '/data/orandea/impl/bbb');
}
node-v4.8.2/benchmark/path/resolve.js000644 000766 000024 00000001237 13070706730 017661 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var path = require('path');
var v8 = require('v8');

var bench = common.createBenchmark(main, {
  type: ['win32', 'posix'],
  n: [1e6],
});

function main(conf) {
  var n = +conf.n;
  var p = path[conf.type];

  // Force optimization before starting the benchmark
  p.resolve('foo/bar', '/tmp/file/', '..', 'a/../subfile');
  v8.setFlagsFromString('--allow_natives_syntax');
  eval('%OptimizeFunctionOnNextCall(p.resolve)');
  p.resolve('foo/bar', '/tmp/file/', '..', 'a/../subfile');

  bench.start();
  for (var i = 0; i < n; i++) {
    p.resolve('foo/bar', '/tmp/file/', '..', 'a/../subfile');
  }
  bench.end(n);
}
node-v4.8.2/benchmark/net/dgram.js000644 000766 000024 00000002370 13070706730 017125 0ustar00iojsstaff000000 000000 'use strict';
// test UDP send/recv throughput

var common = require('../common.js');
var PORT = common.PORT;

// `num` is the number of send requests to queue up each time.
// Keep it reasonably high (>10) otherwise you're benchmarking the speed of
// event loop cycles more than anything else.
var bench = common.createBenchmark(main, {
  len: [1, 64, 256, 1024],
  num: [100],
  type: ['send', 'recv'],
  dur: [5]
});

var dur;
var len;
var num;
var type;
var chunk;

function main(conf) {
  dur = +conf.dur;
  len = +conf.len;
  num = +conf.num;
  type = conf.type;
  chunk = new Buffer(len);
  server();
}

var dgram = require('dgram');

function server() {
  var sent = 0;
  var received = 0;
  var socket = dgram.createSocket('udp4');

  function onsend() {
    if (sent++ % num == 0)
      for (var i = 0; i < num; i++)
        socket.send(chunk, 0, chunk.length, PORT, '127.0.0.1', onsend);
  }

  socket.on('listening', function() {
    bench.start();
    onsend();

    setTimeout(function() {
      var bytes = (type === 'send' ? sent : received) * chunk.length;
      var gbits = (bytes * 8) / (1024 * 1024 * 1024);
      bench.end(gbits);
    }, dur * 1000);
  });

  socket.on('message', function(buf, rinfo) {
    received++;
  });

  socket.bind(PORT);
}
node-v4.8.2/benchmark/net/net-c2s-cork.js000644 000766 000024 00000003526 13070706730 020246 0ustar00iojsstaff000000 000000 // test the speed of .pipe() with sockets
'use strict';

var common = require('../common.js');
var PORT = common.PORT;

var bench = common.createBenchmark(main, {
  len: [4, 8, 16, 32, 64, 128, 512, 1024],
  type: ['buf'],
  dur: [5],
});

var dur;
var len;
var type;
var chunk;
var encoding;

function main(conf) {
  dur = +conf.dur;
  len = +conf.len;
  type = conf.type;

  switch (type) {
    case 'buf':
      chunk = new Buffer(len);
      chunk.fill('x');
      break;
    case 'utf':
      encoding = 'utf8';
      chunk = new Array(len / 2 + 1).join('ü');
      break;
    case 'asc':
      encoding = 'ascii';
      chunk = new Array(len + 1).join('x');
      break;
    default:
      throw new Error('invalid type: ' + type);
  }

  server();
}

var net = require('net');

function Writer() {
  this.received = 0;
  this.writable = true;
}

Writer.prototype.write = function(chunk, encoding, cb) {
  this.received += chunk.length;

  if (typeof encoding === 'function')
    encoding();
  else if (typeof cb === 'function')
    cb();

  return true;
};

// doesn't matter, never emits anything.
Writer.prototype.on = function() {};
Writer.prototype.once = function() {};
Writer.prototype.emit = function() {};

function server() {
  var writer = new Writer();

  // the actual benchmark.
  var server = net.createServer(function(socket) {
    socket.pipe(writer);
  });

  server.listen(PORT, function() {
    var socket = net.connect(PORT);
    socket.on('connect', function() {
      bench.start();

      socket.on('drain', send);
      send();

      setTimeout(function() {
        var bytes = writer.received;
        var gbits = (bytes * 8) / (1024 * 1024 * 1024);
        bench.end(gbits);
      }, dur * 1000);

      function send() {
        socket.cork();
        while (socket.write(chunk, encoding)) {}
        socket.uncork();
      }
    });
  });
}
node-v4.8.2/benchmark/net/net-c2s.js000644 000766 000024 00000004100 13070706730 017277 0ustar00iojsstaff000000 000000 // test the speed of .pipe() with sockets
'use strict';

var common = require('../common.js');
var PORT = common.PORT;

var bench = common.createBenchmark(main, {
  len: [102400, 1024 * 1024 * 16],
  type: ['utf', 'asc', 'buf'],
  dur: [5],
});

var dur;
var len;
var type;
var chunk;
var encoding;

function main(conf) {
  dur = +conf.dur;
  len = +conf.len;
  type = conf.type;

  switch (type) {
    case 'buf':
      chunk = new Buffer(len);
      chunk.fill('x');
      break;
    case 'utf':
      encoding = 'utf8';
      chunk = new Array(len / 2 + 1).join('ü');
      break;
    case 'asc':
      encoding = 'ascii';
      chunk = new Array(len + 1).join('x');
      break;
    default:
      throw new Error('invalid type: ' + type);
  }

  server();
}

var net = require('net');

function Writer() {
  this.received = 0;
  this.writable = true;
}

Writer.prototype.write = function(chunk, encoding, cb) {
  this.received += chunk.length;

  if (typeof encoding === 'function')
    encoding();
  else if (typeof cb === 'function')
    cb();

  return true;
};

// doesn't matter, never emits anything.
Writer.prototype.on = function() {};
Writer.prototype.once = function() {};
Writer.prototype.emit = function() {};


function flow() {
  var dest = this.dest;
  var res = dest.write(chunk, encoding);
  if (!res)
    dest.once('drain', this.flow);
  else
    process.nextTick(this.flow);
}

function Reader() {
  this.flow = flow.bind(this);
  this.readable = true;
}

Reader.prototype.pipe = function(dest) {
  this.dest = dest;
  this.flow();
  return dest;
};


function server() {
  var reader = new Reader();
  var writer = new Writer();

  // the actual benchmark.
  var server = net.createServer(function(socket) {
    socket.pipe(writer);
  });

  server.listen(PORT, function() {
    var socket = net.connect(PORT);
    socket.on('connect', function() {
      bench.start();

      reader.pipe(socket);

      setTimeout(function() {
        var bytes = writer.received;
        var gbits = (bytes * 8) / (1024 * 1024 * 1024);
        bench.end(gbits);
      }, dur * 1000);
    });
  });
}
node-v4.8.2/benchmark/net/net-pipe.js000644 000766 000024 00000004276 13070706730 017563 0ustar00iojsstaff000000 000000 // test the speed of .pipe() with sockets
'use strict';

var common = require('../common.js');
var PORT = common.PORT;

var bench = common.createBenchmark(main, {
  len: [102400, 1024 * 1024 * 16],
  type: ['utf', 'asc', 'buf'],
  dur: [5],
});

var dur;
var len;
var type;
var chunk;
var encoding;

function main(conf) {
  dur = +conf.dur;
  len = +conf.len;
  type = conf.type;

  switch (type) {
    case 'buf':
      chunk = new Buffer(len);
      chunk.fill('x');
      break;
    case 'utf':
      encoding = 'utf8';
      chunk = new Array(len / 2 + 1).join('ü');
      break;
    case 'asc':
      encoding = 'ascii';
      chunk = new Array(len + 1).join('x');
      break;
    default:
      throw new Error('invalid type: ' + type);
  }

  server();
}

var net = require('net');

function Writer() {
  this.received = 0;
  this.writable = true;
}

Writer.prototype.write = function(chunk, encoding, cb) {
  this.received += chunk.length;

  if (typeof encoding === 'function')
    encoding();
  else if (typeof cb === 'function')
    cb();

  return true;
};

// doesn't matter, never emits anything.
Writer.prototype.on = function() {};
Writer.prototype.once = function() {};
Writer.prototype.emit = function() {};


function flow() {
  var dest = this.dest;
  var res = dest.write(chunk, encoding);
  if (!res)
    dest.once('drain', this.flow);
  else
    process.nextTick(this.flow);
}

function Reader() {
  this.flow = flow.bind(this);
  this.readable = true;
}

Reader.prototype.pipe = function(dest) {
  this.dest = dest;
  this.flow();
  return dest;
};


function server() {
  var reader = new Reader();
  var writer = new Writer();

  // the actual benchmark.
  var server = net.createServer(function(socket) {
    socket.pipe(socket);
  });

  server.listen(PORT, function() {
    var socket = net.connect(PORT);
    socket.on('connect', function() {
      bench.start();

      reader.pipe(socket);
      socket.pipe(writer);

      setTimeout(function() {
        // multiply by 2 since we're sending it first one way
        // then then back again.
        var bytes = writer.received * 2;
        var gbits = (bytes * 8) / (1024 * 1024 * 1024);
        bench.end(gbits);
      }, dur * 1000);
    });
  });
}
node-v4.8.2/benchmark/net/net-s2c.js000644 000766 000024 00000004077 13070706730 017314 0ustar00iojsstaff000000 000000 // test the speed of .pipe() with sockets
'use strict';

var common = require('../common.js');
var PORT = common.PORT;

var bench = common.createBenchmark(main, {
  len: [102400, 1024 * 1024 * 16],
  type: ['utf', 'asc', 'buf'],
  dur: [5]
});

var dur;
var len;
var type;
var chunk;
var encoding;

function main(conf) {
  dur = +conf.dur;
  len = +conf.len;
  type = conf.type;

  switch (type) {
    case 'buf':
      chunk = new Buffer(len);
      chunk.fill('x');
      break;
    case 'utf':
      encoding = 'utf8';
      chunk = new Array(len / 2 + 1).join('ü');
      break;
    case 'asc':
      encoding = 'ascii';
      chunk = new Array(len + 1).join('x');
      break;
    default:
      throw new Error('invalid type: ' + type);
  }

  server();
}

var net = require('net');

function Writer() {
  this.received = 0;
  this.writable = true;
}

Writer.prototype.write = function(chunk, encoding, cb) {
  this.received += chunk.length;

  if (typeof encoding === 'function')
    encoding();
  else if (typeof cb === 'function')
    cb();

  return true;
};

// doesn't matter, never emits anything.
Writer.prototype.on = function() {};
Writer.prototype.once = function() {};
Writer.prototype.emit = function() {};


function flow() {
  var dest = this.dest;
  var res = dest.write(chunk, encoding);
  if (!res)
    dest.once('drain', this.flow);
  else
    process.nextTick(this.flow);
}

function Reader() {
  this.flow = flow.bind(this);
  this.readable = true;
}

Reader.prototype.pipe = function(dest) {
  this.dest = dest;
  this.flow();
  return dest;
};


function server() {
  var reader = new Reader();
  var writer = new Writer();

  // the actual benchmark.
  var server = net.createServer(function(socket) {
    reader.pipe(socket);
  });

  server.listen(PORT, function() {
    var socket = net.connect(PORT);
    socket.on('connect', function() {
      bench.start();

      socket.pipe(writer);

      setTimeout(function() {
        var bytes = writer.received;
        var gbits = (bytes * 8) / (1024 * 1024 * 1024);
        bench.end(gbits);
      }, dur * 1000);
    });
  });
}
node-v4.8.2/benchmark/net/tcp-raw-c2s.js000644 000766 000024 00000006045 13070706730 020100 0ustar00iojsstaff000000 000000 // In this benchmark, we connect a client to the server, and write
// as many bytes as we can in the specified time (default = 10s)
'use strict';

var common = require('../common.js');
var util = require('util');

// if there are --dur=N and --len=N args, then
// run the function with those settings.
// if not, then queue up a bunch of child processes.
var bench = common.createBenchmark(main, {
  len: [102400, 1024 * 1024 * 16],
  type: ['utf', 'asc', 'buf'],
  dur: [5]
});

var TCP = process.binding('tcp_wrap').TCP;
var TCPConnectWrap = process.binding('tcp_wrap').TCPConnectWrap;
var WriteWrap = process.binding('stream_wrap').WriteWrap;
var PORT = common.PORT;

var dur;
var len;
var type;

function main(conf) {
  dur = +conf.dur;
  len = +conf.len;
  type = conf.type;
  server();
}


function fail(err, syscall) {
  throw util._errnoException(err, syscall);
}

function server() {
  var serverHandle = new TCP();
  var err = serverHandle.bind('127.0.0.1', PORT);
  if (err)
    fail(err, 'bind');

  err = serverHandle.listen(511);
  if (err)
    fail(err, 'listen');

  serverHandle.onconnection = function(err, clientHandle) {
    if (err)
      fail(err, 'connect');

    // the meat of the benchmark is right here:
    bench.start();
    var bytes = 0;

    setTimeout(function() {
      // report in Gb/sec
      bench.end((bytes * 8) / (1024 * 1024 * 1024));
    }, dur * 1000);

    clientHandle.onread = function(nread, buffer) {
      // we're not expecting to ever get an EOF from the client.
      // just lots of data forever.
      if (nread < 0)
        fail(nread, 'read');

      // don't slice the buffer.  the point of this is to isolate, not
      // simulate real traffic.
      bytes += buffer.length;
    };

    clientHandle.readStart();
  };

  client();
}

function client() {
  var chunk;
  switch (type) {
    case 'buf':
      chunk = new Buffer(len);
      chunk.fill('x');
      break;
    case 'utf':
      chunk = new Array(len / 2 + 1).join('ü');
      break;
    case 'asc':
      chunk = new Array(len + 1).join('x');
      break;
    default:
      throw new Error('invalid type: ' + type);
  }

  var clientHandle = new TCP();
  var connectReq = new TCPConnectWrap();
  var err = clientHandle.connect(connectReq, '127.0.0.1', PORT);

  if (err)
    fail(err, 'connect');

  clientHandle.readStart();

  connectReq.oncomplete = function(err) {
    if (err)
      fail(err, 'connect');

    while (clientHandle.writeQueueSize === 0)
      write();
  };

  function write() {
    var writeReq = new WriteWrap();
    writeReq.oncomplete = afterWrite;
    var err;
    switch (type) {
      case 'buf':
        err = clientHandle.writeBuffer(writeReq, chunk);
        break;
      case 'utf':
        err = clientHandle.writeUtf8String(writeReq, chunk);
        break;
      case 'asc':
        err = clientHandle.writeAsciiString(writeReq, chunk);
        break;
    }

    if (err)
      fail(err, 'write');
  }

  function afterWrite(err, handle, req) {
    if (err)
      fail(err, 'write');

    while (clientHandle.writeQueueSize === 0)
      write();
  }
}
node-v4.8.2/benchmark/net/tcp-raw-pipe.js000644 000766 000024 00000006527 13070706730 020353 0ustar00iojsstaff000000 000000 // In this benchmark, we connect a client to the server, and write
// as many bytes as we can in the specified time (default = 10s)
'use strict';

var common = require('../common.js');
var util = require('util');

// if there are --dur=N and --len=N args, then
// run the function with those settings.
// if not, then queue up a bunch of child processes.
var bench = common.createBenchmark(main, {
  len: [102400, 1024 * 1024 * 16],
  type: ['utf', 'asc', 'buf'],
  dur: [5]
});

var TCP = process.binding('tcp_wrap').TCP;
var TCPConnectWrap = process.binding('tcp_wrap').TCPConnectWrap;
var WriteWrap = process.binding('stream_wrap').WriteWrap;
var PORT = common.PORT;

var dur;
var len;
var type;

function main(conf) {
  dur = +conf.dur;
  len = +conf.len;
  type = conf.type;
  server();
}

function fail(err, syscall) {
  throw util._errnoException(err, syscall);
}

function server() {
  var serverHandle = new TCP();
  var err = serverHandle.bind('127.0.0.1', PORT);
  if (err)
    fail(err, 'bind');

  err = serverHandle.listen(511);
  if (err)
    fail(err, 'listen');

  serverHandle.onconnection = function(err, clientHandle) {
    if (err)
      fail(err, 'connect');

    clientHandle.onread = function(nread, buffer) {
      // we're not expecting to ever get an EOF from the client.
      // just lots of data forever.
      if (nread < 0)
        fail(nread, 'read');

      var writeReq = new WriteWrap();
      writeReq.async = false;
      err = clientHandle.writeBuffer(writeReq, buffer);

      if (err)
        fail(err, 'write');

      writeReq.oncomplete = function(status, handle, req, err) {
        if (err)
          fail(err, 'write');
      };
    };

    clientHandle.readStart();
  };

  client();
}

function client() {
  var chunk;
  switch (type) {
    case 'buf':
      chunk = new Buffer(len);
      chunk.fill('x');
      break;
    case 'utf':
      chunk = new Array(len / 2 + 1).join('ü');
      break;
    case 'asc':
      chunk = new Array(len + 1).join('x');
      break;
    default:
      throw new Error('invalid type: ' + type);
  }

  var clientHandle = new TCP();
  var connectReq = new TCPConnectWrap();
  var err = clientHandle.connect(connectReq, '127.0.0.1', PORT);
  var bytes = 0;

  if (err)
    fail(err, 'connect');

  clientHandle.readStart();

  clientHandle.onread = function(nread, buffer) {
    if (nread < 0)
      fail(nread, 'read');

    bytes += buffer.length;
  };

  connectReq.oncomplete = function(err) {
    if (err)
      fail(err, 'connect');

    bench.start();

    setTimeout(function() {
      // multiply by 2 since we're sending it first one way
      // then then back again.
      bench.end(2 * (bytes * 8) / (1024 * 1024 * 1024));
    }, dur * 1000);

    while (clientHandle.writeQueueSize === 0)
      write();
  };

  function write() {
    var writeReq = new WriteWrap();
    writeReq.oncomplete = afterWrite;
    var err;
    switch (type) {
      case 'buf':
        err = clientHandle.writeBuffer(writeReq, chunk);
        break;
      case 'utf':
        err = clientHandle.writeUtf8String(writeReq, chunk);
        break;
      case 'asc':
        err = clientHandle.writeAsciiString(writeReq, chunk);
        break;
    }

    if (err)
      fail(err, 'write');
  }

  function afterWrite(err, handle, req) {
    if (err)
      fail(err, 'write');

    while (clientHandle.writeQueueSize === 0)
      write();
  }
}
node-v4.8.2/benchmark/net/tcp-raw-s2c.js000644 000766 000024 00000006375 13070706730 020106 0ustar00iojsstaff000000 000000 // In this benchmark, we connect a client to the server, and write
// as many bytes as we can in the specified time (default = 10s)
'use strict';

var common = require('../common.js');
var util = require('util');

// if there are dur=N and len=N args, then
// run the function with those settings.
// if not, then queue up a bunch of child processes.
var bench = common.createBenchmark(main, {
  len: [102400, 1024 * 1024 * 16],
  type: ['utf', 'asc', 'buf'],
  dur: [5]
});

var TCP = process.binding('tcp_wrap').TCP;
var TCPConnectWrap = process.binding('tcp_wrap').TCPConnectWrap;
var WriteWrap = process.binding('stream_wrap').WriteWrap;
var PORT = common.PORT;

var dur;
var len;
var type;

function main(conf) {
  dur = +conf.dur;
  len = +conf.len;
  type = conf.type;
  server();
}

function fail(err, syscall) {
  throw util._errnoException(err, syscall);
}

function server() {
  var serverHandle = new TCP();
  var err = serverHandle.bind('127.0.0.1', PORT);
  if (err)
    fail(err, 'bind');

  err = serverHandle.listen(511);
  if (err)
    fail(err, 'listen');

  serverHandle.onconnection = function(err, clientHandle) {
    if (err)
      fail(err, 'connect');

    var chunk;
    switch (type) {
      case 'buf':
        chunk = new Buffer(len);
        chunk.fill('x');
        break;
      case 'utf':
        chunk = new Array(len / 2 + 1).join('ü');
        break;
      case 'asc':
        chunk = new Array(len + 1).join('x');
        break;
      default:
        throw new Error('invalid type: ' + type);
    }

    clientHandle.readStart();

    while (clientHandle.writeQueueSize === 0)
      write();

    function write() {
      var writeReq = new WriteWrap();
      writeReq.async = false;
      writeReq.oncomplete = afterWrite;
      var err;
      switch (type) {
        case 'buf':
          err = clientHandle.writeBuffer(writeReq, chunk);
          break;
        case 'utf':
          err = clientHandle.writeUtf8String(writeReq, chunk);
          break;
        case 'asc':
          err = clientHandle.writeAsciiString(writeReq, chunk);
          break;
      }

      if (err) {
        fail(err, 'write');
      } else if (!writeReq.async) {
        process.nextTick(function() {
          afterWrite(null, clientHandle, writeReq);
        });
      }
    }

    function afterWrite(status, handle, req, err) {
      if (err)
        fail(err, 'write');

      while (clientHandle.writeQueueSize === 0)
        write();
    }
  };

  client();
}

function client() {
  var clientHandle = new TCP();
  var connectReq = new TCPConnectWrap();
  var err = clientHandle.connect(connectReq, '127.0.0.1', PORT);

  if (err)
    fail(err, 'connect');

  connectReq.oncomplete = function() {
    var bytes = 0;
    clientHandle.onread = function(nread, buffer) {
      // we're not expecting to ever get an EOF from the client.
      // just lots of data forever.
      if (nread < 0)
        fail(nread, 'read');

      // don't slice the buffer.  the point of this is to isolate, not
      // simulate real traffic.
      bytes += buffer.length;
    };

    clientHandle.readStart();

    // the meat of the benchmark is right here:
    bench.start();

    setTimeout(function() {
      // report in Gb/sec
      bench.end((bytes * 8) / (1024 * 1024 * 1024));
    }, dur * 1000);
  };
}
node-v4.8.2/benchmark/module/module-loader.js000644 000766 000024 00000002446 13070706730 021267 0ustar00iojsstaff000000 000000 'use strict';
var fs = require('fs');
var path = require('path');
var common = require('../common.js');

var tmpDirectory = path.join(__dirname, '..', 'tmp');
var benchmarkDirectory = path.join(tmpDirectory, 'nodejs-benchmark-module');

var bench = common.createBenchmark(main, {
  thousands: [50]
});

function main(conf) {
  rmrf(tmpDirectory);
  try { fs.mkdirSync(tmpDirectory); } catch (e) {}
  try { fs.mkdirSync(benchmarkDirectory); } catch (e) {}

  var n = +conf.thousands * 1e3;
  for (var i = 0; i <= n; i++) {
    fs.mkdirSync(benchmarkDirectory + i);
    fs.writeFileSync(
      benchmarkDirectory + i + '/package.json',
      '{"main": "index.js"}'
    );
    fs.writeFileSync(
      benchmarkDirectory + i + '/index.js',
      'module.exports = "";'
    );
  }

  measure(n);
}

function measure(n) {
  bench.start();
  for (var i = 0; i <= n; i++) {
    require(benchmarkDirectory + i);
  }
  bench.end(n / 1e3);
}

function rmrf(location) {
  try {
    var things = fs.readdirSync(location);
    things.forEach(function(thing) {
      var cur = path.join(location, thing),
        isDirectory = fs.statSync(cur).isDirectory();
      if (isDirectory) {
        rmrf(cur);
        return;
      }
      fs.unlinkSync(cur);
    });
    fs.rmdirSync(location);
  } catch (err) {
    // Ignore error
  }
}
node-v4.8.2/benchmark/misc/freelist.js000644 000766 000024 00000001266 13070706730 020020 0ustar00iojsstaff000000 000000 'use strict';

var common = require('../common.js');
var FreeList = require('internal/freelist').FreeList;

var bench = common.createBenchmark(main, {
  n: [100000]
});

function main(conf) {
  var n = conf.n;
  var poolSize = 1000;
  var list = new FreeList('test', poolSize, Object);
  var i;
  var j;
  var used = [];

  // First, alloc `poolSize` items
  for (j = 0; j < poolSize; j++) {
    used.push(list.alloc());
  }

  bench.start();

  for (i = 0; i < n; i++) {
    // Return all the items to the pool
    for (j = 0; j < poolSize; j++) {
      list.free(used[j]);
    }

    // Re-alloc from pool
    for (j = 0; j < poolSize; j++) {
      list.alloc();
    }
  }

  bench.end(n);
}
node-v4.8.2/benchmark/misc/function_call/000755 000766 000024 00000000000 13070706730 020460 5ustar00iojsstaff000000 000000 node-v4.8.2/benchmark/misc/object-property-bench.js000644 000766 000024 00000002710 13070706730 022403 0ustar00iojsstaff000000 000000 'use strict';

const common = require('../common.js');

const bench = common.createBenchmark(main, {
  method: ['property', 'string', 'variable', 'symbol'],
  millions: [1000]
});

function runProperty(n) {
  const object = {};
  var i = 0;
  bench.start();
  for (; i < n; i++) {
    object.p1 = 21;
    object.p2 = 21;
    object.p1 += object.p2;
  }
  bench.end(n / 1e6);
}

function runString(n) {
  const object = {};
  var i = 0;
  bench.start();
  for (; i < n; i++) {
    object['p1'] = 21;
    object['p2'] = 21;
    object['p1'] += object['p2'];
  }
  bench.end(n / 1e6);
}

function runVariable(n) {
  const object = {};
  const var1 = 'p1';
  const var2 = 'p2';
  var i = 0;
  bench.start();
  for (; i < n; i++) {
    object[var1] = 21;
    object[var2] = 21;
    object[var1] += object[var2];
  }
  bench.end(n / 1e6);
}

function runSymbol(n) {
  const object = {};
  const symbol1 = Symbol('p1');
  const symbol2 = Symbol('p2');
  var i = 0;
  bench.start();
  for (; i < n; i++) {
    object[symbol1] = 21;
    object[symbol2] = 21;
    object[symbol1] += object[symbol2];
  }
  bench.end(n / 1e6);
}

function main(conf) {
  const n = +conf.millions * 1e6;

  switch (conf.method) {
    case 'property':
      runProperty(n);
      break;
    case 'string':
      runString(n);
      break;
    case 'variable':
      runVariable(n);
      break;
    case 'symbol':
      runSymbol(n);
      break;
    default:
      throw new Error('Unexpected method');
  }
}
node-v4.8.2/benchmark/misc/startup.js000644 000766 000024 00000001402 13070706730 017675 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var spawn = require('child_process').spawn;
var path = require('path');
var emptyJsFile = path.resolve(__dirname, '../../test/fixtures/semicolon.js');

var bench = common.createBenchmark(startNode, {
  dur: [1]
});

function startNode(conf) {
  var dur = +conf.dur;
  var go = true;
  var starts = 0;

  setTimeout(function() {
    go = false;
  }, dur * 1000);

  bench.start();
  start();

  function start() {
    var node = spawn(process.execPath || process.argv[0], [emptyJsFile]);
    node.on('exit', function(exitCode) {
      if (exitCode !== 0) {
        throw new Error('Error during node startup');
      }
      starts++;

      if (go)
        start();
      else
        bench.end(starts);
    });
  }
}
node-v4.8.2/benchmark/misc/string-creation.js000644 000766 000024 00000000452 13070706730 021307 0ustar00iojsstaff000000 000000 'use strict';

var common = require('../common.js');
var bench = common.createBenchmark(main, {
  millions: [100]
});

function main(conf) {
  var n = +conf.millions * 1e6;
  bench.start();
  var s;
  for (var i = 0; i < n; i++) {
    s = '01234567890';
    s[1] = 'a';
  }
  bench.end(n / 1e6);
}
node-v4.8.2/benchmark/misc/v8-bench.js000644 000766 000024 00000001311 13070706730 017604 0ustar00iojsstaff000000 000000 // compare with "google-chrome deps/v8/benchmarks/run.html"
'use strict';
var fs = require('fs');
var path = require('path');
var vm = require('vm');

var dir = path.join(__dirname, '..', '..', 'deps', 'v8', 'benchmarks');

global.print = function(s) {
  if (s === '----') return;
  console.log('misc/v8_bench.js %s', s);
};

global.load = function(filename) {
  var source = fs.readFileSync(path.join(dir, filename), 'utf8');
  // deps/v8/benchmarks/regexp.js breaks console.log() because it clobbers
  // the RegExp global,  Restore the original when the script is done.
  var $RegExp = global.RegExp;
  vm.runInThisContext(source, { filename: filename });
  global.RegExp = $RegExp;
};

global.load('run.js');
node-v4.8.2/benchmark/misc/function_call/.gitignore000644 000766 000024 00000000007 13070706730 022445 0ustar00iojsstaff000000 000000 build/
node-v4.8.2/benchmark/misc/function_call/binding.cc000644 000766 000024 00000000512 13070706730 022377 0ustar00iojsstaff000000 000000 #include 
#include 

using namespace v8;

static int c = 0;

void Hello(const FunctionCallbackInfo& args) {
  args.GetReturnValue().Set(c++);
}

extern "C" void init (Local target) {
  HandleScope scope(Isolate::GetCurrent());
  NODE_SET_METHOD(target, "hello", Hello);
}

NODE_MODULE(binding, init);
node-v4.8.2/benchmark/misc/function_call/binding.gyp000644 000766 000024 00000000145 13070706730 022613 0ustar00iojsstaff000000 000000 {
  'targets': [
    {
      'target_name': 'binding',
      'sources': [ 'binding.cc' ]
    }
  ]
}
node-v4.8.2/benchmark/misc/function_call/index.js000644 000766 000024 00000001740 13070706730 022127 0ustar00iojsstaff000000 000000 // show the difference between calling a short js function
// relative to a comparable C++ function.
// Reports millions of calls per second.
// Note that JS speed goes up, while cxx speed stays about the same.
'use strict';

var assert = require('assert');
var common = require('../../common.js');

// this fails when we try to open with a different version of node,
// which is quite common for benchmarks.  so in that case, just
// abort quietly.

try {
  var binding = require('./build/Release/binding');
} catch (er) {
  console.error('misc/function_call.js Binding failed to load');
  process.exit(0);
}
var cxx = binding.hello;

var c = 0;
function js() {
  return c++;
}

assert(js() === cxx());

var bench = common.createBenchmark(main, {
  type: ['js', 'cxx'],
  millions: [1, 10, 50]
});

function main(conf) {
  var n = +conf.millions * 1e6;

  var fn = conf.type === 'cxx' ? cxx : js;
  bench.start();
  for (var i = 0; i < n; i++) {
    fn();
  }
  bench.end(+conf.millions);
}
node-v4.8.2/benchmark/misc/function_call/Makefile000644 000766 000024 00000000056 13070706730 022121 0ustar00iojsstaff000000 000000 binding:
	node-gyp rebuild --nodedir=../../..
node-v4.8.2/benchmark/http/_chunky_http_client.js000644 000766 000024 00000005635 13070706730 022270 0ustar00iojsstaff000000 000000 'use strict';

// test HTTP throughput in fragmented header case
var common = require('../common.js');
var net = require('net');
var test = require('../../test/common.js');

var bench = common.createBenchmark(main, {
  len:  [1, 4, 8, 16, 32, 64, 128],
  num:  [5, 50, 500, 2000],
  type: ['send'],
});


function main(conf) {
  var len = +conf.len;
  var num = +conf.num;
  var todo = [];
  var headers = [];
  // Chose 7 because 9 showed "Connection error" / "Connection closed"
  // An odd number could result in a better length dispersion.
  for (var i = 7; i <= 7 * 7 * 7; i *= 7)
    headers.push(Array(i + 1).join('o'));

  function WriteHTTPHeaders(channel, has_keep_alive, extra_header_count) {
    todo = [];
    todo.push('GET / HTTP/1.1');
    todo.push('Host: localhost');
    todo.push('Connection: keep-alive');
    todo.push('Accept: text/html,application/xhtml+xml,' +
              'application/xml;q=0.9,image/webp,*/*;q=0.8');
    todo.push('User-Agent: Mozilla/5.0 (X11; Linux x86_64) ' +
              'AppleWebKit/537.36 (KHTML, like Gecko) ' +
              'Chrome/39.0.2171.71 Safari/537.36');
    todo.push('Accept-Encoding: gzip, deflate, sdch');
    todo.push('Accept-Language: en-US,en;q=0.8');
    for (var i = 0; i < extra_header_count; i++) {
      // Utilize first three powers of a small integer for an odd cycle and
      // because the fourth power of some integers overloads the server.
      todo.push('X-Header-' + i + ': ' + headers[i % 3]);
    }
    todo.push('');
    todo.push('');
    todo = todo.join('\r\n');
    // Using odd numbers in many places may increase length coverage.
    var chunksize = 37;
    for (i = 0; i < todo.length; i += chunksize) {
      var cur = todo.slice(i, i + chunksize);
      channel.write(cur);
    }
  }

  var min = 10;
  var size = 0;
  var mod = 317;
  var mult = 17;
  var add = 11;
  var count = 0;
  var PIPE = test.PIPE;
  var socket = net.connect(PIPE, function() {
    bench.start();
    WriteHTTPHeaders(socket, 1, len);
    socket.setEncoding('utf8');
    socket.on('data', function(d) {
      var did = false;
      var pattern = 'HTTP/1.1 200 OK\r\n';
      if ((d.length === pattern.length && d === pattern) ||
          (d.length > pattern.length &&
           d.slice(0, pattern.length) === pattern)) {
        did = true;
      } else {
        pattern = 'HTTP/1.1 ';
        if ((d.length === pattern.length && d === pattern) ||
            (d.length > pattern.length &&
             d.slice(0, pattern.length) === pattern)) {
          did = true;
        }
      }
      size = (size * mult + add) % mod;
      if (did) {
        count += 1;
        if (count === num) {
          bench.end(count);
        } else {
          WriteHTTPHeaders(socket, 1, min + size);
        }
      }
    });
    socket.on('close', function() {
      console.log('Connection closed');
    });

    socket.on('error', function() {
      throw new Error('Connection error');
    });
  });
}
node-v4.8.2/benchmark/http/check_is_http_token.js000644 000766 000024 00000001746 13070706730 022241 0ustar00iojsstaff000000 000000 'use strict';

const common = require('../common.js');
const _checkIsHttpToken = require('_http_common')._checkIsHttpToken;

const bench = common.createBenchmark(main, {
  key: [
    'TCN',
    'ETag',
    'date',
    'Vary',
    'server',
    'Server',
    'status',
    'version',
    'Expires',
    'alt-svc',
    'location',
    'Connection',
    'Keep-Alive',
    'content-type',
    'Content-Type',
    'Cache-Control',
    'Last-Modified',
    'Accept-Ranges',
    'content-length',
    'x-frame-options',
    'x-xss-protection',
    'Content-Encoding',
    'Content-Location',
    'Transfer-Encoding',
    'alternate-protocol',
    ':', // invalid input
    '@@',
    '中文呢', // unicode
    '((((())))', // invalid
    ':alternate-protocol', // fast bailout
    'alternate-protocol:' // slow bailout
  ],
  n: [1e6],
});

function main(conf) {
  var n = +conf.n;
  var key = conf.key;

  bench.start();
  for (var i = 0; i < n; i++) {
    _checkIsHttpToken(key);
  }
  bench.end(n);
}
node-v4.8.2/benchmark/http/chunked.js000644 000766 000024 00000001776 13070706730 017656 0ustar00iojsstaff000000 000000 // When calling .end(buffer) right away, this triggers a "hot path"
// optimization in http.js, to avoid an extra write call.
//
// However, the overhead of copying a large buffer is higher than
// the overhead of an extra write() call, so the hot path was not
// always as hot as it could be.
//
// Verify that our assumptions are valid.
'use strict';

var common = require('../common.js');

var bench = common.createBenchmark(main, {
  num: [1, 4, 8, 16],
  size: [1, 64, 256],
  c: [100]
});

function main(conf) {
  const http = require('http');
  var chunk = new Buffer(conf.size);
  chunk.fill('8');

  var args = ['-d', '10s', '-t', 8, '-c', conf.c];

  var server = http.createServer(function(req, res) {
    function send(left) {
      if (left === 0) return res.end();
      res.write(chunk);
      setTimeout(function() {
        send(left - 1);
      }, 0);
    }
    send(conf.num);
  });

  server.listen(common.PORT, function() {
    bench.http('/', args, function() {
      server.close();
    });
  });
}
node-v4.8.2/benchmark/http/client-request-body.js000644 000766 000024 00000002715 13070706730 022126 0ustar00iojsstaff000000 000000 // Measure the time it takes for the HTTP client to send a request body.
'use strict';

var common = require('../common.js');
var http = require('http');

var bench = common.createBenchmark(main, {
  dur: [5],
  type: ['asc', 'utf', 'buf'],
  bytes: [32, 256, 1024],
  method: ['write', 'end']
});

function main(conf) {
  var dur = +conf.dur;
  var len = +conf.bytes;

  var encoding;
  var chunk;
  switch (conf.type) {
    case 'buf':
      chunk = new Buffer(len);
      chunk.fill('x');
      break;
    case 'utf':
      encoding = 'utf8';
      chunk = new Array(len / 2 + 1).join('ü');
      break;
    case 'asc':
      chunk = new Array(len + 1).join('a');
      break;
  }

  var nreqs = 0;
  var options = {
    headers: { 'Connection': 'keep-alive', 'Transfer-Encoding': 'chunked' },
    agent: new http.Agent({ maxSockets: 1 }),
    host: '127.0.0.1',
    port: common.PORT,
    path: '/',
    method: 'POST'
  };

  var server = http.createServer(function(req, res) {
    res.end();
  });
  server.listen(options.port, options.host, function() {
    setTimeout(done, dur * 1000);
    bench.start();
    pummel();
  });

  function pummel() {
    var req = http.request(options, function(res) {
      nreqs++;
      pummel();  // Line up next request.
      res.resume();
    });
    if (conf.method === 'write') {
      req.write(chunk, encoding);
      req.end();
    } else {
      req.end(chunk, encoding);
    }
  }

  function done() {
    bench.end(nreqs);
  }
}
node-v4.8.2/benchmark/http/cluster.js000644 000766 000024 00000001455 13070706730 017710 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var PORT = common.PORT;

var cluster = require('cluster');
if (cluster.isMaster) {
  var bench = common.createBenchmark(main, {
    // unicode confuses ab on os x.
    type: ['bytes', 'buffer'],
    length: [4, 1024, 102400],
    c: [50, 500]
  });
} else {
  require('../http_simple.js');
}

function main(conf) {
  process.env.PORT = PORT;
  var workers = 0;
  var w1 = cluster.fork();
  var w2 = cluster.fork();

  cluster.on('listening', function() {
    workers++;
    if (workers < 2)
      return;

    setTimeout(function() {
      var path = '/' + conf.type + '/' + conf.length;
      var args = ['-d', '10s', '-t', 8, '-c', conf.c];

      bench.http(path, args, function() {
        w1.destroy();
        w2.destroy();
      });
    }, 100);
  });
}
node-v4.8.2/benchmark/http/end-vs-write-end.js000644 000766 000024 00000002440 13070706730 021312 0ustar00iojsstaff000000 000000 // When calling .end(buffer) right away, this triggers a "hot path"
// optimization in http.js, to avoid an extra write call.
//
// However, the overhead of copying a large buffer is higher than
// the overhead of an extra write() call, so the hot path was not
// always as hot as it could be.
//
// Verify that our assumptions are valid.
'use strict';

var common = require('../common.js');

var bench = common.createBenchmark(main, {
  type: ['asc', 'utf', 'buf'],
  kb: [64, 128, 256, 1024],
  c: [100],
  method: ['write', 'end']
});

function main(conf) {
  const http = require('http');
  var chunk;
  var len = conf.kb * 1024;
  switch (conf.type) {
    case 'buf':
      chunk = new Buffer(len);
      chunk.fill('x');
      break;
    case 'utf':
      chunk = new Array(len / 2 + 1).join('ü');
      break;
    case 'asc':
      chunk = new Array(len + 1).join('a');
      break;
  }

  function write(res) {
    res.write(chunk);
    res.end();
  }

  function end(res) {
    res.end(chunk);
  }

  var method = conf.method === 'write' ? write : end;
  var args = ['-d', '10s', '-t', 8, '-c', conf.c];

  var server = http.createServer(function(req, res) {
    method(res);
  });

  server.listen(common.PORT, function() {
    bench.http('/', args, function() {
      server.close();
    });
  });
}
node-v4.8.2/benchmark/http/http_server_for_chunky_client.js000644 000766 000024 00000002102 13070706730 024347 0ustar00iojsstaff000000 000000 'use strict';

var path = require('path');
var http = require('http');
var fs = require('fs');
var spawn = require('child_process').spawn;
require('../common.js');
var test = require('../../test/common.js');
var pep = path.dirname(process.argv[1]) + '/_chunky_http_client.js';
var PIPE = test.PIPE;

try {
  fs.accessSync(test.tmpDir, fs.F_OK);
} catch (e) {
  fs.mkdirSync(test.tmpDir);
}

var server;
try {
  fs.unlinkSync(PIPE);
} catch (e) { /* ignore */ }

server = http.createServer(function(req, res) {
  res.writeHead(200, { 'content-type': 'text/plain',
                       'content-length': '2' });
  res.end('ok');
});

server.on('error', function(err) {
  throw new Error('server error: ' + err);
});

try {
  var child;

  server.listen(PIPE);

  child = spawn(process.execPath, [pep], { });

  child.on('error', function(err) {
    throw new Error('spawn error: ' + err);
  });

  child.stdout.pipe(process.stdout);
  child.stderr.pipe(process.stderr);

  child.on('close', function(exitCode) {
    server.close();
  });

} catch (e) {
  throw new Error('error: ' + e);
}

node-v4.8.2/benchmark/http/simple.js000644 000766 000024 00000001161 13070706730 017512 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var PORT = common.PORT;

var bench = common.createBenchmark(main, {
  // unicode confuses ab on os x.
  type: ['bytes', 'buffer'],
  length: [4, 1024, 102400],
  chunks: [0, 1, 4],  // chunks=0 means 'no chunked encoding'.
  c: [50, 500]
});

function main(conf) {
  process.env.PORT = PORT;
  var server = require('../http_simple.js');
  setTimeout(function() {
    var path = '/' + conf.type + '/' + conf.length + '/' + conf.chunks;
    var args = ['-d', '10s', '-t', 8, '-c', conf.c];

    bench.http(path, args, function() {
      server.close();
    });
  }, 2000);
}
node-v4.8.2/benchmark/fs/bench-stat.js000644 000766 000024 00000000611 13070706730 017701 0ustar00iojsstaff000000 000000 'use strict';

const common = require('../common');
const fs = require('fs');

const bench = common.createBenchmark(main, {
  n: [1e4],
  kind: ['lstat', 'stat']
});


function main(conf) {
  const n = conf.n >>> 0;

  bench.start();
  (function r(cntr, fn) {
    if (cntr-- <= 0)
      return bench.end(n);
    fn(__filename, function() {
      r(cntr, fn);
    });
  }(n, fs[conf.kind]));
}
node-v4.8.2/benchmark/fs/bench-statSync.js000644 000766 000024 00000000530 13070706730 020536 0ustar00iojsstaff000000 000000 'use strict';

const common = require('../common');
const fs = require('fs');

const bench = common.createBenchmark(main, {
  n: [1e4],
  kind: ['lstatSync', 'statSync']
});


function main(conf) {
  const n = conf.n >>> 0;
  const fn = fs[conf.kind];

  bench.start();
  for (var i = 0; i < n; i++) {
    fn(__filename);
  }
  bench.end(n);
}
node-v4.8.2/benchmark/fs/read-stream-throughput.js000644 000766 000024 00000003406 13070706730 022271 0ustar00iojsstaff000000 000000 // test the throughput of the fs.WriteStream class.
'use strict';

var path = require('path');
var common = require('../common.js');
var filename = path.resolve(__dirname, '.removeme-benchmark-garbage');
var fs = require('fs');
var filesize = 1000 * 1024 * 1024;
var assert = require('assert');

var type, encoding, size;

var bench = common.createBenchmark(main, {
  type: ['buf', 'asc', 'utf'],
  size: [1024, 4096, 65535, 1024 * 1024]
});

function main(conf) {
  type = conf.type;
  size = +conf.size;

  switch (type) {
    case 'buf':
      encoding = null;
      break;
    case 'asc':
      encoding = 'ascii';
      break;
    case 'utf':
      encoding = 'utf8';
      break;
    default:
      throw new Error('invalid type');
  }

  makeFile(runTest);
}

function runTest() {
  assert(fs.statSync(filename).size === filesize);
  var rs = fs.createReadStream(filename, {
    highWaterMark: size,
    encoding: encoding
  });

  rs.on('open', function() {
    bench.start();
  });

  var bytes = 0;
  rs.on('data', function(chunk) {
    bytes += chunk.length;
  });

  rs.on('end', function() {
    try { fs.unlinkSync(filename); } catch (e) {}
    // MB/sec
    bench.end(bytes / (1024 * 1024));
  });
}

function makeFile() {
  var buf = new Buffer(filesize / 1024);
  if (encoding === 'utf8') {
    // ü
    for (var i = 0; i < buf.length; i++) {
      buf[i] = i % 2 === 0 ? 0xC3 : 0xBC;
    }
  } else if (encoding === 'ascii') {
    buf.fill('a');
  } else {
    buf.fill('x');
  }

  try { fs.unlinkSync(filename); } catch (e) {}
  var w = 1024;
  var ws = fs.createWriteStream(filename);
  ws.on('close', runTest);
  ws.on('drain', write);
  write();
  function write() {
    do {
      w--;
    } while (false !== ws.write(buf) && w > 0);
    if (w === 0)
      ws.end();
  }
}
node-v4.8.2/benchmark/fs/readfile.js000644 000766 000024 00000002112 13070706730 017422 0ustar00iojsstaff000000 000000 // Call fs.readFile over and over again really fast.
// Then see how many times it got called.
// Yes, this is a silly benchmark.  Most benchmarks are silly.
'use strict';

var path = require('path');
var common = require('../common.js');
var filename = path.resolve(__dirname, '.removeme-benchmark-garbage');
var fs = require('fs');

var bench = common.createBenchmark(main, {
  dur: [5],
  len: [1024, 16 * 1024 * 1024],
  concurrent: [1, 10]
});

function main(conf) {
  var len = +conf.len;
  try { fs.unlinkSync(filename); } catch (e) {}
  var data = new Buffer(len);
  data.fill('x');
  fs.writeFileSync(filename, data);
  data = null;

  var reads = 0;
  bench.start();
  setTimeout(function() {
    bench.end(reads);
    try { fs.unlinkSync(filename); } catch (e) {}
  }, +conf.dur * 1000);

  function read() {
    fs.readFile(filename, afterRead);
  }

  function afterRead(er, data) {
    if (er)
      throw er;

    if (data.length !== len)
      throw new Error('wrong number of bytes returned');

    reads++;
    read();
  }

  var cur = +conf.concurrent;
  while (cur--) read();
}
node-v4.8.2/benchmark/fs/write-stream-throughput.js000644 000766 000024 00000003241 13070706730 022505 0ustar00iojsstaff000000 000000 // test the throughput of the fs.WriteStream class.
'use strict';

var path = require('path');
var common = require('../common.js');
var filename = path.resolve(__dirname, '.removeme-benchmark-garbage');
var fs = require('fs');

var bench = common.createBenchmark(main, {
  dur: [5],
  type: ['buf', 'asc', 'utf'],
  size: [2, 1024, 65535, 1024 * 1024]
});

function main(conf) {
  var dur = +conf.dur;
  var type = conf.type;
  var size = +conf.size;
  var encoding;

  var chunk;
  switch (type) {
    case 'buf':
      chunk = new Buffer(size);
      chunk.fill('b');
      break;
    case 'asc':
      chunk = new Array(size + 1).join('a');
      encoding = 'ascii';
      break;
    case 'utf':
      chunk = new Array(Math.ceil(size / 2) + 1).join('ü');
      encoding = 'utf8';
      break;
    default:
      throw new Error('invalid type');
  }

  try { fs.unlinkSync(filename); } catch (e) {}

  var started = false;
  var ending = false;
  var ended = false;
  setTimeout(function() {
    ending = true;
    f.end();
  }, dur * 1000);

  var f = fs.createWriteStream(filename);
  f.on('drain', write);
  f.on('open', write);
  f.on('close', done);
  f.on('finish', function() {
    ended = true;
    var written = fs.statSync(filename).size / 1024;
    try { fs.unlinkSync(filename); } catch (e) {}
    bench.end(written / 1024);
  });


  function write() {
    // don't try to write after we end, even if a 'drain' event comes.
    // v0.8 streams are so sloppy!
    if (ending)
      return;

    if (!started) {
      started = true;
      bench.start();
    }

    while (false !== f.write(chunk, encoding));
  }

  function done() {
    if (!ended)
      f.emit('finish');
  }
}
node-v4.8.2/benchmark/events/ee-add-remove.js000644 000766 000024 00000001114 13070706730 021156 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var events = require('events');

var bench = common.createBenchmark(main, {n: [25e4]});

function main(conf) {
  var n = conf.n | 0;

  var ee = new events.EventEmitter();
  var listeners = [];

  var k;
  for (k = 0; k < 10; k += 1)
    listeners.push(function() {});

  bench.start();
  for (var i = 0; i < n; i += 1) {
    for (k = listeners.length; --k >= 0; /* empty */)
      ee.on('dummy', listeners[k]);
    for (k = listeners.length; --k >= 0; /* empty */)
      ee.removeListener('dummy', listeners[k]);
  }
  bench.end(n);
}
node-v4.8.2/benchmark/events/ee-emit-multi-args.js000644 000766 000024 00000000633 13070706730 022160 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var EventEmitter = require('events').EventEmitter;

var bench = common.createBenchmark(main, {n: [2e6]});

function main(conf) {
  var n = conf.n | 0;

  var ee = new EventEmitter();

  for (var k = 0; k < 10; k += 1)
    ee.on('dummy', function() {});

  bench.start();
  for (var i = 0; i < n; i += 1) {
    ee.emit('dummy', 5, true);
  }
  bench.end(n);
}
node-v4.8.2/benchmark/events/ee-emit.js000644 000766 000024 00000000622 13070706730 020074 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var EventEmitter = require('events').EventEmitter;

var bench = common.createBenchmark(main, {n: [2e6]});

function main(conf) {
  var n = conf.n | 0;

  var ee = new EventEmitter();

  for (var k = 0; k < 10; k += 1)
    ee.on('dummy', function() {});

  bench.start();
  for (var i = 0; i < n; i += 1) {
    ee.emit('dummy');
  }
  bench.end(n);
}
node-v4.8.2/benchmark/events/ee-listener-count-on-prototype.js000644 000766 000024 00000000633 13070706730 024570 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var EventEmitter = require('events').EventEmitter;

var bench = common.createBenchmark(main, {n: [5e7]});

function main(conf) {
  var n = conf.n | 0;

  var ee = new EventEmitter();

  for (var k = 0; k < 10; k += 1)
    ee.on('dummy', function() {});

  bench.start();
  for (var i = 0; i < n; i += 1) {
    ee.listenerCount('dummy');
  }
  bench.end(n);
}
node-v4.8.2/benchmark/events/ee-listeners-many.js000644 000766 000024 00000000663 13070706730 022115 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var EventEmitter = require('events').EventEmitter;

var bench = common.createBenchmark(main, {n: [5e6]});

function main(conf) {
  var n = conf.n | 0;

  var ee = new EventEmitter();
  ee.setMaxListeners(101);

  for (var k = 0; k < 100; k += 1)
    ee.on('dummy', function() {});

  bench.start();
  for (var i = 0; i < n; i += 1) {
    ee.listeners('dummy');
  }
  bench.end(n);
}
node-v4.8.2/benchmark/events/ee-listeners.js000644 000766 000024 00000000627 13070706730 021153 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var EventEmitter = require('events').EventEmitter;

var bench = common.createBenchmark(main, {n: [5e6]});

function main(conf) {
  var n = conf.n | 0;

  var ee = new EventEmitter();

  for (var k = 0; k < 10; k += 1)
    ee.on('dummy', function() {});

  bench.start();
  for (var i = 0; i < n; i += 1) {
    ee.listeners('dummy');
  }
  bench.end(n);
}
node-v4.8.2/benchmark/es/map-bench.js000644 000766 000024 00000003714 13070706730 017511 0ustar00iojsstaff000000 000000 'use strict';

const common = require('../common.js');
const assert = require('assert');

const bench = common.createBenchmark(main, {
  method: ['object', 'nullProtoObject', 'fakeMap', 'map'],
  millions: [1]
});

function runObject(n) {
  const m = {};
  var i = 0;
  bench.start();
  for (; i < n; i++) {
    m['i' + i] = i;
    m['s' + i] = String(i);
    assert.equal(m['i' + i], m['s' + i]);
    m['i' + i] = undefined;
    m['s' + i] = undefined;
  }
  bench.end(n / 1e6);
}

function runNullProtoObject(n) {
  const m = Object.create(null);
  var i = 0;
  bench.start();
  for (; i < n; i++) {
    m['i' + i] = i;
    m['s' + i] = String(i);
    assert.equal(m['i' + i], m['s' + i]);
    m['i' + i] = undefined;
    m['s' + i] = undefined;
  }
  bench.end(n / 1e6);
}

function fakeMap() {
  const m = {};
  return {
    get(key) { return m['$' + key]; },
    set(key, val) { m['$' + key] = val; },
    get size() { return Object.keys(m).length; },
    has(key) { return Object.prototype.hasOwnProperty.call(m, '$' + key); }
  };
}

function runFakeMap(n) {
  const m = fakeMap();
  var i = 0;
  bench.start();
  for (; i < n; i++) {
    m.set('i' + i, i);
    m.set('s' + i, String(i));
    assert.equal(m.get('i' + i), m.get('s' + i));
    m.set('i' + i, undefined);
    m.set('s' + i, undefined);
  }
  bench.end(n / 1e6);
}

function runMap(n) {
  const m = new Map();
  var i = 0;
  bench.start();
  for (; i < n; i++) {
    m.set('i' + i, i);
    m.set('s' + i, String(i));
    assert.equal(m.get('i' + i), m.get('s' + i));
    m.set('i' + i, undefined);
    m.set('s' + i, undefined);
  }
  bench.end(n / 1e6);
}

function main(conf) {
  const n = +conf.millions * 1e6;

  switch (conf.method) {
    case 'object':
      runObject(n);
      break;
    case 'nullProtoObject':
      runNullProtoObject(n);
      break;
    case 'fakeMap':
      runFakeMap(n);
      break;
    case 'map':
      runMap(n);
      break;
    default:
      throw new Error('Unexpected method');
  }
}
node-v4.8.2/benchmark/domain/domain-fn-args.js000644 000766 000024 00000001303 13070706730 021311 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var domain = require('domain');

var bench = common.createBenchmark(main, {
  arguments: [0, 1, 2, 3],
  n: [10]
});

var bdomain = domain.create();
var gargs = [1, 2, 3];

function main(conf) {

  var args, n = +conf.n;
  var myArguments = gargs.slice(0, conf.arguments);
  bench.start();

  bdomain.enter();
  for (var i = 0; i < n; i++) {
    if (myArguments.length >= 2) {
      args = Array.prototype.slice.call(myArguments, 1);
      fn.apply(this, args);
    } else {
      fn.call(this);
    }
  }
  bdomain.exit();

  bench.end(n);
}

function fn(a, b, c) {
  if (!a)
    a = 1;

  if (!b)
    b = 2;

  if (!c)
    c = 3;

  return a + b + c;
}
node-v4.8.2/benchmark/dgram/bind-params.js000644 000766 000024 00000001665 13070706730 020542 0ustar00iojsstaff000000 000000 'use strict';

const common = require('../common.js');
const dgram = require('dgram');

const configs = {
  n: [1e4],
  port: ['true', 'false'],
  address: ['true', 'false'],
};

const bench = common.createBenchmark(main, configs);

function main(conf) {
  const n = +conf.n;
  const port = conf.port === 'true' ? 0 : undefined;
  const address = conf.address === 'true' ? '0.0.0.0' : undefined;

  if (port !== undefined && address !== undefined) {
    bench.start();
    for (let i = 0; i < n; i++) {
      dgram.createSocket('udp4').bind(port, address).unref();
    }
    bench.end(n);
  } else if (port !== undefined) {
    bench.start();
    for (let i = 0; i < n; i++) {
      dgram.createSocket('udp4').bind(port).unref();
    }
    bench.end(n);
  } else if (port === undefined && address === undefined) {
    bench.start();
    for (let i = 0; i < n; i++) {
      dgram.createSocket('udp4').bind().unref();
    }
    bench.end(n);
  }
}
node-v4.8.2/benchmark/crypto/aes-gcm-throughput.js000644 000766 000024 00000002264 13070706730 022312 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var crypto = require('crypto');
var keylen = {'aes-128-gcm': 16, 'aes-192-gcm': 24, 'aes-256-gcm': 32};
var bench = common.createBenchmark(main, {
  n: [500],
  cipher: ['aes-128-gcm', 'aes-192-gcm', 'aes-256-gcm'],
  len: [1024, 4 * 1024, 16 * 1024, 64 * 1024, 256 * 1024, 1024 * 1024]
});

function main(conf) {
  var message = (new Buffer(conf.len)).fill('b');
  var key = crypto.randomBytes(keylen[conf.cipher]);
  var iv = crypto.randomBytes(12);
  var associate_data = (new Buffer(16)).fill('z');
  bench.start();
  AEAD_Bench(conf.cipher, message, associate_data, key, iv, conf.n, conf.len);
}

function AEAD_Bench(cipher, message, associate_data, key, iv, n, len) {
  var written = n * len;
  var bits = written * 8;
  var mbits = bits / (1024 * 1024);

  for (var i = 0; i < n; i++) {
    var alice = crypto.createCipheriv(cipher, key, iv);
    alice.setAAD(associate_data);
    var enc = alice.update(message);
    alice.final();
    var tag = alice.getAuthTag();
    var bob = crypto.createDecipheriv(cipher, key, iv);
    bob.setAuthTag(tag);
    bob.setAAD(associate_data);
    bob.update(enc);
    bob.final();
  }

  bench.end(mbits);
}
node-v4.8.2/benchmark/crypto/cipher-stream.js000644 000766 000024 00000005152 13070706730 021331 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');

var bench = common.createBenchmark(main, {
  writes: [500],
  cipher: [ 'AES192', 'AES256' ],
  type: ['asc', 'utf', 'buf'],
  len: [2, 1024, 102400, 1024 * 1024],
  api: ['legacy', 'stream']
});

function main(conf) {
  var api = conf.api;
  if (api === 'stream' && process.version.match(/^v0\.[0-8]\./)) {
    console.error('Crypto streams not available until v0.10');
    // use the legacy, just so that we can compare them.
    api = 'legacy';
  }

  var crypto = require('crypto');
  var assert = require('assert');
  var alice = crypto.getDiffieHellman('modp5');
  var bob = crypto.getDiffieHellman('modp5');

  alice.generateKeys();
  bob.generateKeys();


  var pubEnc = /^v0\.[0-8]/.test(process.version) ? 'binary' : null;
  var alice_secret = alice.computeSecret(bob.getPublicKey(), pubEnc, 'hex');
  var bob_secret = bob.computeSecret(alice.getPublicKey(), pubEnc, 'hex');

  // alice_secret and bob_secret should be the same
  assert(alice_secret == bob_secret);

  var alice_cipher = crypto.createCipher(conf.cipher, alice_secret);
  var bob_cipher = crypto.createDecipher(conf.cipher, bob_secret);

  var message;
  var encoding;
  switch (conf.type) {
    case 'asc':
      message = new Array(conf.len + 1).join('a');
      encoding = 'ascii';
      break;
    case 'utf':
      message = new Array(conf.len / 2 + 1).join('ü');
      encoding = 'utf8';
      break;
    case 'buf':
      message = new Buffer(conf.len);
      message.fill('b');
      break;
    default:
      throw new Error('unknown message type: ' + conf.type);
  }

  var fn = api === 'stream' ? streamWrite : legacyWrite;

  // write data as fast as possible to alice, and have bob decrypt.
  // use old API for comparison to v0.8
  bench.start();
  fn(alice_cipher, bob_cipher, message, encoding, conf.writes);
}

function streamWrite(alice, bob, message, encoding, writes) {
  var written = 0;
  bob.on('data', function(c) {
    written += c.length;
  });

  bob.on('end', function() {
    // Gbits
    var bits = written * 8;
    var gbits = bits / (1024 * 1024 * 1024);
    bench.end(gbits);
  });

  alice.pipe(bob);

  while (writes-- > 0)
    alice.write(message, encoding);

  alice.end();
}

function legacyWrite(alice, bob, message, encoding, writes) {
  var written = 0;
  var enc, dec;
  for (var i = 0; i < writes; i++) {
    enc = alice.update(message, encoding);
    dec = bob.update(enc);
    written += dec.length;
  }
  enc = alice.final();
  dec = bob.update(enc);
  written += dec.length;
  dec = bob.final();
  written += dec.length;
  var gbits = written / (1024 * 1024 * 1024);
  bench.end(gbits);
}
node-v4.8.2/benchmark/crypto/hash-stream-creation.js000644 000766 000024 00000004065 13070706730 022606 0ustar00iojsstaff000000 000000 // throughput benchmark
// creates a single hasher, then pushes a bunch of data through it
'use strict';
var common = require('../common.js');
var crypto = require('crypto');

var bench = common.createBenchmark(main, {
  writes: [500],
  algo: [ 'sha256', 'md5' ],
  type: ['asc', 'utf', 'buf'],
  out: ['hex', 'binary', 'buffer'],
  len: [2, 1024, 102400, 1024 * 1024],
  api: ['legacy', 'stream']
});

function main(conf) {
  var api = conf.api;
  if (api === 'stream' && process.version.match(/^v0\.[0-8]\./)) {
    console.error('Crypto streams not available until v0.10');
    // use the legacy, just so that we can compare them.
    api = 'legacy';
  }

  var message;
  var encoding;
  switch (conf.type) {
    case 'asc':
      message = new Array(conf.len + 1).join('a');
      encoding = 'ascii';
      break;
    case 'utf':
      message = new Array(conf.len / 2 + 1).join('ü');
      encoding = 'utf8';
      break;
    case 'buf':
      message = new Buffer(conf.len);
      message.fill('b');
      break;
    default:
      throw new Error('unknown message type: ' + conf.type);
  }

  var fn = api === 'stream' ? streamWrite : legacyWrite;

  bench.start();
  fn(conf.algo, message, encoding, conf.writes, conf.len, conf.out);
}

function legacyWrite(algo, message, encoding, writes, len, outEnc) {
  var written = writes * len;
  var bits = written * 8;
  var gbits = bits / (1024 * 1024 * 1024);

  while (writes-- > 0) {
    var h = crypto.createHash(algo);
    h.update(message, encoding);
    var res = h.digest(outEnc);

    // include buffer creation costs for older versions
    if (outEnc === 'buffer' && typeof res === 'string')
      res = new Buffer(res, 'binary');
  }

  bench.end(gbits);
}

function streamWrite(algo, message, encoding, writes, len, outEnc) {
  var written = writes * len;
  var bits = written * 8;
  var gbits = bits / (1024 * 1024 * 1024);

  while (writes-- > 0) {
    var h = crypto.createHash(algo);

    if (outEnc !== 'buffer')
      h.setEncoding(outEnc);

    h.write(message, encoding);
    h.end();
    h.read();
  }

  bench.end(gbits);
}
node-v4.8.2/benchmark/crypto/hash-stream-throughput.js000644 000766 000024 00000003410 13070706730 023204 0ustar00iojsstaff000000 000000 // throughput benchmark
// creates a single hasher, then pushes a bunch of data through it
'use strict';
var common = require('../common.js');
var crypto = require('crypto');

var bench = common.createBenchmark(main, {
  writes: [500],
  algo: ['sha1', 'sha256', 'sha512'],
  type: ['asc', 'utf', 'buf'],
  len: [2, 1024, 102400, 1024 * 1024],
  api: ['legacy', 'stream']
});

function main(conf) {
  var api = conf.api;
  if (api === 'stream' && process.version.match(/^v0\.[0-8]\./)) {
    console.error('Crypto streams not available until v0.10');
    // use the legacy, just so that we can compare them.
    api = 'legacy';
  }

  var message;
  var encoding;
  switch (conf.type) {
    case 'asc':
      message = new Array(conf.len + 1).join('a');
      encoding = 'ascii';
      break;
    case 'utf':
      message = new Array(conf.len / 2 + 1).join('ü');
      encoding = 'utf8';
      break;
    case 'buf':
      message = new Buffer(conf.len);
      message.fill('b');
      break;
    default:
      throw new Error('unknown message type: ' + conf.type);
  }

  var fn = api === 'stream' ? streamWrite : legacyWrite;

  bench.start();
  fn(conf.algo, message, encoding, conf.writes, conf.len);
}

function legacyWrite(algo, message, encoding, writes, len) {
  var written = writes * len;
  var bits = written * 8;
  var gbits = bits / (1024 * 1024 * 1024);
  var h = crypto.createHash(algo);

  while (writes-- > 0)
    h.update(message, encoding);

  h.digest();

  bench.end(gbits);
}

function streamWrite(algo, message, encoding, writes, len) {
  var written = writes * len;
  var bits = written * 8;
  var gbits = bits / (1024 * 1024 * 1024);
  var h = crypto.createHash(algo);

  while (writes-- > 0)
    h.write(message, encoding);

  h.end();
  h.read();

  bench.end(gbits);
}
node-v4.8.2/benchmark/crypto/rsa-encrypt-decrypt-throughput.js000644 000766 000024 00000002417 13070706730 024715 0ustar00iojsstaff000000 000000 'use strict';
// throughput benchmark in signing and verifying
var common = require('../common.js');
var crypto = require('crypto');
var fs = require('fs');
var path = require('path');
var fixtures_keydir = path.resolve(__dirname, '../../test/fixtures/keys/');
var keylen_list = ['1024', '2048', '4096'];
var RSA_PublicPem = {};
var RSA_PrivatePem = {};

keylen_list.forEach(function(key) {
  RSA_PublicPem[key] = fs.readFileSync(fixtures_keydir +
                                       '/rsa_public_' + key + '.pem');
  RSA_PrivatePem[key] = fs.readFileSync(fixtures_keydir +
                                        '/rsa_private_' + key + '.pem');
});

var bench = common.createBenchmark(main, {
  n: [500],
  keylen: keylen_list,
  len: [16, 32, 64]
});

function main(conf) {
  var message = (new Buffer(conf.len)).fill('b');

  bench.start();
  StreamWrite(conf.algo, conf.keylen, message, conf.n, conf.len);
}

function StreamWrite(algo, keylen, message, n, len) {
  var written = n * len;
  var bits = written * 8;
  var kbits = bits / (1024);

  var privateKey = RSA_PrivatePem[keylen];
  var publicKey = RSA_PublicPem[keylen];
  for (var i = 0; i < n; i++) {
    var enc = crypto.privateEncrypt(privateKey, message);
    crypto.publicDecrypt(publicKey, enc);
  }

  bench.end(kbits);
}
node-v4.8.2/benchmark/crypto/rsa-sign-verify-throughput.js000644 000766 000024 00000002652 13070706730 024024 0ustar00iojsstaff000000 000000 'use strict';
// throughput benchmark in signing and verifying
var common = require('../common.js');
var crypto = require('crypto');
var fs = require('fs');
var path = require('path');
var fixtures_keydir = path.resolve(__dirname, '../../test/fixtures/keys/');
var keylen_list = ['1024', '2048'];
var RSA_PublicPem = {};
var RSA_PrivatePem = {};

keylen_list.forEach(function(key) {
  RSA_PublicPem[key] = fs.readFileSync(fixtures_keydir +
                                       '/rsa_public_' + key + '.pem');
  RSA_PrivatePem[key] = fs.readFileSync(fixtures_keydir +
                                        '/rsa_private_' + key + '.pem');
});

var bench = common.createBenchmark(main, {
  writes: [500],
  algo: ['RSA-SHA1', 'RSA-SHA224', 'RSA-SHA256', 'RSA-SHA384', 'RSA-SHA512'],
  keylen: keylen_list,
  len: [1024, 102400, 2 * 102400, 3 * 102400, 1024 * 1024]
});

function main(conf) {
  var message = (new Buffer(conf.len)).fill('b');

  bench.start();
  StreamWrite(conf.algo, conf.keylen, message, conf.writes, conf.len);
}

function StreamWrite(algo, keylen, message, writes, len) {
  var written = writes * len;
  var bits = written * 8;
  var kbits = bits / (1024);

  var privateKey = RSA_PrivatePem[keylen];
  var s = crypto.createSign(algo);
  var v = crypto.createVerify(algo);

  while (writes-- > 0) {
    s.update(message);
    v.update(message);
  }

  s.sign(privateKey, 'binary');
  s.end();
  v.end();

  bench.end(kbits);
}
node-v4.8.2/benchmark/child_process/child-process-exec-stdout.js000644 000766 000024 00000001505 13070706730 025066 0ustar00iojsstaff000000 000000 'use strict';
const common = require('../common.js');

var messagesLength = [64, 256, 1024, 4096];
// Windows does not support that long arguments
if (process.platform !== 'win32')
  messagesLength.push(32768);
const bench = common.createBenchmark(main, {
  len: messagesLength,
  dur: [5]
});

const exec = require('child_process').exec;
function main(conf) {
  bench.start();

  const dur = +conf.dur;
  const len = +conf.len;

  const msg = `"${'.'.repeat(len)}"`;
  msg.match(/./);
  const options = {'stdio': ['ignore', 'pipe', 'ignore']};
  // NOTE: Command below assumes bash shell.
  const child = exec(`while\n  echo ${msg}\ndo :; done\n`, options);

  var bytes = 0;
  child.stdout.on('data', function(msg) {
    bytes += msg.length;
  });

  setTimeout(function() {
    child.kill();
    bench.end(bytes);
  }, dur * 1000);
}
node-v4.8.2/benchmark/child_process/child-process-read.js000644 000766 000024 00000001235 13070706730 023535 0ustar00iojsstaff000000 000000 'use strict';
const common = require('../common.js');
const bench = common.createBenchmark(main, {
  len: [64, 256, 1024, 4096, 32768],
  dur: [5]
});

const spawn = require('child_process').spawn;
function main(conf) {
  bench.start();

  const dur = +conf.dur;
  const len = +conf.len;

  const msg = '"' + Array(len).join('.') + '"';
  const options = {'stdio': ['ignore', 'ipc', 'ignore']};
  const child = spawn('yes', [msg], options);

  var bytes = 0;
  child.on('message', function(msg) {
    bytes += msg.length;
  });

  setTimeout(function() {
    child.kill();
    const gbits = (bytes * 8) / (1024 * 1024 * 1024);
    bench.end(gbits);
  }, dur * 1000);
}
node-v4.8.2/benchmark/child_process/spawn-echo.js000644 000766 000024 00000000735 13070706730 022135 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var bench = common.createBenchmark(main, {
  thousands: [1]
});

var spawn = require('child_process').spawn;
function main(conf) {
  var len = +conf.thousands * 1000;

  bench.start();
  go(len, len);
}

function go(n, left) {
  if (--left === 0)
    return bench.end(n);

  var child = spawn('echo', ['hello']);
  child.on('exit', function(code) {
    if (code)
      process.exit(code);
    else
      go(n, left);
  });
}
node-v4.8.2/benchmark/buffers/buffer-base64-decode.js000644 000766 000024 00000000671 13070706730 022457 0ustar00iojsstaff000000 000000 'use strict';
const assert = require('assert');
const common = require('../common.js');

const bench = common.createBenchmark(main, {});

function main(conf) {
  const s = 'abcd'.repeat(8 << 20);
  s.match(/./);  // Flatten string.
  assert.equal(s.length % 4, 0);
  const b = Buffer(s.length / 4 * 3);
  b.write(s, 0, s.length, 'base64');
  bench.start();
  for (var i = 0; i < 32; i += 1) b.base64Write(s, 0, s.length);
  bench.end(32);
}
node-v4.8.2/benchmark/buffers/buffer-base64-encode.js000644 000766 000024 00000000614 13070706730 022466 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');

var bench = common.createBenchmark(main, {});

function main(conf) {
  var N = 64 * 1024 * 1024;
  var b = Buffer(N);
  var s = '';
  var i;
  for (i = 0; i < 256; ++i) s += String.fromCharCode(i);
  for (i = 0; i < N; i += 256) b.write(s, i, 256, 'ascii');
  bench.start();
  for (i = 0; i < 32; ++i) b.toString('base64');
  bench.end(64);
}
node-v4.8.2/benchmark/buffers/buffer-bytelength.js000644 000766 000024 00000002673 13070706730 022323 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common');

var bench = common.createBenchmark(main, {
  encoding: ['utf8', 'base64'],
  len: [1, 2, 4, 16, 64, 256], // x16
  n: [5e6]
});

// 16 chars each
var chars = [
  'hello brendan!!!', // 1 byte
  'ΰαβγδεζηθικλμνξο', // 2 bytes
  '挰挱挲挳挴挵挶挷挸挹挺挻挼挽挾挿', // 3 bytes
  '𠜎𠜱𠝹𠱓𠱸𠲖𠳏𠳕𠴕𠵼𠵿𠸎𠸏𠹷𠺝𠺢' // 4 bytes
];

function main(conf) {
  var n = conf.n | 0;
  var len = conf.len | 0;
  var encoding = conf.encoding;

  var strings = [];
  for (var string of chars) {
    // Strings must be built differently, depending on encoding
    var data = buildString(string, len);
    if (encoding === 'utf8') {
      strings.push(data);
    } else if (encoding === 'base64') {
      // Base64 strings will be much longer than their UTF8 counterparts
      strings.push(new Buffer(data, 'utf8').toString('base64'));
    }
  }

  // Check the result to ensure it is *properly* optimized
  var results = strings.map(function(val) {
    return Buffer.byteLength(val, encoding);
  });

  bench.start();
  for (var i = 0; i < n; i++) {
    var index = n % strings.length;
    // Go!
    var r = Buffer.byteLength(strings[index], encoding);

    if (r !== results[index])
      throw new Error('incorrect return value');
  }
  bench.end(n);
}

function buildString(str, times) {
  if (times == 1) return str;

  return str + buildString(str, times - 1);
}
node-v4.8.2/benchmark/buffers/buffer-compare-instance-method.js000644 000766 000024 00000001275 13070706730 024661 0ustar00iojsstaff000000 000000 'use strict';
const common = require('../common.js');
const v8 = require('v8');

const bench = common.createBenchmark(main, {
  size: [16, 512, 1024, 4096, 16386],
  millions: [1]
});

function main(conf) {
  const iter = (conf.millions >>> 0) * 1e6;
  const size = (conf.size >>> 0);
  const b0 = new Buffer(size).fill('a');
  const b1 = new Buffer(size).fill('a');

  b1[size - 1] = 'b'.charCodeAt(0);

  // Force optimization before starting the benchmark
  b0.compare(b1);
  v8.setFlagsFromString('--allow_natives_syntax');
  eval('%OptimizeFunctionOnNextCall(b0.compare)');
  b0.compare(b1);

  bench.start();
  for (var i = 0; i < iter; i++) {
    b0.compare(b1);
  }
  bench.end(iter / 1e6);
}
node-v4.8.2/benchmark/buffers/buffer-compare.js000644 000766 000024 00000000736 13070706730 021602 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');

var bench = common.createBenchmark(main, {
  size: [16, 512, 1024, 4096, 16386],
  millions: [1]
});

function main(conf) {
  var iter = (conf.millions >>> 0) * 1e6;
  var size = (conf.size >>> 0);
  var b0 = new Buffer(size).fill('a');
  var b1 = new Buffer(size).fill('a');

  b1[size - 1] = 'b'.charCodeAt(0);

  bench.start();
  for (var i = 0; i < iter; i++) {
    Buffer.compare(b0, b1);
  }
  bench.end(iter / 1e6);
}
node-v4.8.2/benchmark/buffers/buffer-concat.js000644 000766 000024 00000001063 13070706730 021415 0ustar00iojsstaff000000 000000 'use strict';
const common = require('../common.js');

const bench = common.createBenchmark(main, {
  pieces: [1, 4, 16],
  pieceSize: [1, 16, 256],
  withTotalLength: [0, 1],
  n: [1024]
});

function main(conf) {
  const n = +conf.n;
  const size = +conf.pieceSize;
  const pieces = +conf.pieces;

  const list = new Array(pieces);
  list.fill(Buffer.allocUnsafe(size));

  const totalLength = conf.withTotalLength ? pieces * size : undefined;

  bench.start();
  for (var i = 0; i < n * 1024; i++) {
    Buffer.concat(list, totalLength);
  }
  bench.end(n);
}
node-v4.8.2/benchmark/buffers/buffer-creation.js000644 000766 000024 00000000653 13070706730 021756 0ustar00iojsstaff000000 000000 'use strict';
const SlowBuffer = require('buffer').SlowBuffer;

var common = require('../common.js');
var bench = common.createBenchmark(main, {
  type: ['fast', 'slow'],
  len: [10, 1024],
  n: [1024]
});

function main(conf) {
  var len = +conf.len;
  var n = +conf.n;
  var clazz = conf.type === 'fast' ? Buffer : SlowBuffer;
  bench.start();
  for (var i = 0; i < n * 1024; i++) {
    new clazz(len);
  }
  bench.end(n);
}
node-v4.8.2/benchmark/buffers/buffer-hex.js000644 000766 000024 00000000700 13070706730 020727 0ustar00iojsstaff000000 000000 'use strict';

const common = require('../common.js');

const bench = common.createBenchmark(main, {
  len: [0, 1, 64, 1024],
  n: [1e7]
});

function main(conf) {
  const len = conf.len | 0;
  const n = conf.n | 0;
  const buf = Buffer.alloc(len);

  for (let i = 0; i < buf.length; i++)
    buf[i] = i & 0xff;

  const hex = buf.toString('hex');

  bench.start();

  for (let i = 0; i < n; i += 1)
    Buffer.from(hex, 'hex');

  bench.end(n);
}
node-v4.8.2/benchmark/buffers/buffer-indexof.js000644 000766 000024 00000002225 13070706730 021603 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var fs = require('fs');
const path = require('path');

var bench = common.createBenchmark(main, {
  search: ['@', 'SQ', '10x', '--l', 'Alice', 'Gryphon', 'Panther',
           'Ou est ma chatte?', 'found it very', 'among mad people',
           'neighbouring pool', 'Soo--oop', 'aaaaaaaaaaaaaaaaa',
           'venture to go near the house till she had brought herself down to',
           ' to the Caterpillar'],
  encoding: ['undefined', 'utf8', 'ucs2', 'binary'],
  type: ['buffer', 'string'],
  iter: [1]
});

function main(conf) {
  var iter = (conf.iter) * 100000;
  var aliceBuffer = fs.readFileSync(
    path.resolve(__dirname, '../fixtures/alice.html')
  );
  var search = conf.search;
  var encoding = conf.encoding;

  if (encoding === 'undefined') {
    encoding = undefined;
  }

  if (encoding === 'ucs2') {
    aliceBuffer = new Buffer(aliceBuffer.toString(), encoding);
  }

  if (conf.type === 'buffer') {
    search = new Buffer(new Buffer(search).toString(), encoding);
  }

  bench.start();
  for (var i = 0; i < iter; i++) {
    aliceBuffer.indexOf(search, 0, encoding);
  }
  bench.end(iter);
}
node-v4.8.2/benchmark/buffers/buffer-iterate.js000644 000766 000024 00000002225 13070706730 021604 0ustar00iojsstaff000000 000000 'use strict';
var SlowBuffer = require('buffer').SlowBuffer;
var common = require('../common.js');
var assert = require('assert');

var bench = common.createBenchmark(main, {
  size: [16, 512, 1024, 4096, 16386],
  type: ['fast', 'slow'],
  method: ['for', 'forOf', 'iterator'],
  n: [1e3]
});

var methods = {
  'for': benchFor,
  'forOf': benchForOf,
  'iterator': benchIterator
};

function main(conf) {
  var len = +conf.size;
  var clazz = conf.type === 'fast' ? Buffer : SlowBuffer;
  var buffer = new clazz(len);
  buffer.fill(0);

  methods[conf.method](buffer, conf.n);
}


function benchFor(buffer, n) {
  bench.start();

  for (var k = 0; k < n; k++)
    for (var i = 0; i < buffer.length; i++)
      assert(buffer[i] === 0);

  bench.end(n);
}

function benchForOf(buffer, n) {
  bench.start();

  for (var k = 0; k < n; k++)
    for (var b of buffer)
      assert(b === 0);

  bench.end(n);
}

function benchIterator(buffer, n) {
  bench.start();

  for (var k = 0; k < n; k++) {
    var iter = buffer[Symbol.iterator]();
    var cur = iter.next();

    while (!cur.done) {
      assert(cur.value === 0);
      cur = iter.next();
    }

  }

  bench.end(n);
}
node-v4.8.2/benchmark/buffers/buffer-read.js000644 000766 000024 00000001607 13070706730 021065 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');

var bench = common.createBenchmark(main, {
  noAssert: ['false', 'true'],
  buffer: ['fast', 'slow'],
  type: ['UInt8', 'UInt16LE', 'UInt16BE',
         'UInt32LE', 'UInt32BE',
         'Int8', 'Int16LE', 'Int16BE',
         'Int32LE', 'Int32BE',
         'FloatLE', 'FloatBE',
         'DoubleLE', 'DoubleBE'],
  millions: [1]
});

function main(conf) {
  var noAssert = conf.noAssert === 'true';
  var len = +conf.millions * 1e6;
  var clazz = conf.buf === 'fast' ? Buffer : require('buffer').SlowBuffer;
  var buff = new clazz(8);
  var fn = 'read' + conf.type;

  buff.writeDoubleLE(0, 0, noAssert);
  var testFunction = new Function('buff', [
    'for (var i = 0; i !== ' + len + '; i++) {',
    '  buff.' + fn + '(0, ' + JSON.stringify(noAssert) + ');',
    '}'
  ].join('\n'));
  bench.start();
  testFunction(buff);
  bench.end(len / 1e6);
}
node-v4.8.2/benchmark/buffers/buffer-slice.js000644 000766 000024 00000000670 13070706730 021250 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var SlowBuffer = require('buffer').SlowBuffer;

var bench = common.createBenchmark(main, {
  type: ['fast', 'slow'],
  n: [1024]
});

var buf = new Buffer(1024);
var slowBuf = new SlowBuffer(1024);

function main(conf) {
  var n = +conf.n;
  var b = conf.type === 'fast' ? buf : slowBuf;
  bench.start();
  for (var i = 0; i < n * 1024; i++) {
    b.slice(10, 256);
  }
  bench.end(n);
}
node-v4.8.2/benchmark/buffers/buffer-tojson.js000644 000766 000024 00000000474 13070706730 021467 0ustar00iojsstaff000000 000000 'use strict';

const common = require('../common.js');

const bench = common.createBenchmark(main, {
  n: [1e4],
  len: [0, 10, 256, 4 * 1024]
});

function main(conf) {
  var n = +conf.n;
  var buf = Buffer.allocUnsafe(+conf.len);

  bench.start();
  for (var i = 0; i < n; ++i)
    buf.toJSON();
  bench.end(n);
}
node-v4.8.2/benchmark/buffers/buffer-tostring.js000644 000766 000024 00000000762 13070706730 022024 0ustar00iojsstaff000000 000000 'use strict';

const common = require('../common.js');

const bench = common.createBenchmark(main, {
  arg: ['true', 'false'],
  len: [0, 1, 64, 1024],
  n: [1e7]
});

function main(conf) {
  const arg = conf.arg === 'true';
  const len = conf.len | 0;
  const n = conf.n | 0;
  const buf = Buffer(len).fill(42);

  var i;
  bench.start();
  if (arg) {
    for (i = 0; i < n; i += 1)
      buf.toString('utf8');
  } else {
    for (i = 0; i < n; i += 1)
      buf.toString();
  }
  bench.end(n);
}
node-v4.8.2/benchmark/buffers/buffer-write.js000644 000766 000024 00000003336 13070706730 021305 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var bench = common.createBenchmark(main, {
  noAssert: ['false', 'true'],
  buffer: ['fast', 'slow'],
  type: ['UInt8', 'UInt16LE', 'UInt16BE',
         'UInt32LE', 'UInt32BE',
         'Int8', 'Int16LE', 'Int16BE',
         'Int32LE', 'Int32BE',
         'FloatLE', 'FloatBE',
         'DoubleLE', 'DoubleBE'],
  millions: [1]
});

const INT8   = 0x7f;
const INT16  = 0x7fff;
const INT32  = 0x7fffffff;
const UINT8  = (INT8 * 2) + 1;
const UINT16 = (INT16 * 2) + 1;
const UINT32 = INT32;

var mod = {
  writeInt8: INT8,
  writeInt16BE: INT16,
  writeInt16LE: INT16,
  writeInt32BE: INT32,
  writeInt32LE: INT32,
  writeUInt8: UINT8,
  writeUInt16BE: UINT16,
  writeUInt16LE: UINT16,
  writeUInt32BE: UINT32,
  writeUInt32LE: UINT32
};

function main(conf) {
  var noAssert = conf.noAssert === 'true';
  var len = +conf.millions * 1e6;
  var clazz = conf.buf === 'fast' ? Buffer : require('buffer').SlowBuffer;
  var buff = new clazz(8);
  var fn = 'write' + conf.type;

  if (fn.match(/Int/))
    benchInt(buff, fn, len, noAssert);
  else
    benchFloat(buff, fn, len, noAssert);
}

function benchInt(buff, fn, len, noAssert) {
  var m = mod[fn];
  var testFunction = new Function('buff', [
    'for (var i = 0; i !== ' + len + '; i++) {',
    '  buff.' + fn + '(i & ' + m + ', 0, ' + JSON.stringify(noAssert) + ');',
    '}'
  ].join('\n'));
  bench.start();
  testFunction(buff);
  bench.end(len / 1e6);
}

function benchFloat(buff, fn, len, noAssert) {
  var testFunction = new Function('buff', [
    'for (var i = 0; i !== ' + len + '; i++) {',
    '  buff.' + fn + '(i, 0, ' + JSON.stringify(noAssert) + ');',
    '}'
  ].join('\n'));
  bench.start();
  testFunction(buff);
  bench.end(len / 1e6);
}
node-v4.8.2/benchmark/buffers/buffer_zero.js000644 000766 000024 00000000440 13070706730 021205 0ustar00iojsstaff000000 000000 'use strict';

const common = require('../common.js');

const bench = common.createBenchmark(main, {
  n: [1024]
});

const zero = new Buffer(0);

function main(conf) {
  var n = +conf.n;
  bench.start();
  for (let i = 0; i < n * 1024; i++) {
    new Buffer(zero);
  }
  bench.end(n);
}
node-v4.8.2/benchmark/buffers/dataview-set.js000644 000766 000024 00000002424 13070706730 021276 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var bench = common.createBenchmark(main, {
  type: ['Uint8', 'Uint16LE', 'Uint16BE',
         'Uint32LE', 'Uint32BE',
         'Int8', 'Int16LE', 'Int16BE',
         'Int32LE', 'Int32BE',
         'Float32LE', 'Float32BE',
         'Float64LE', 'Float64BE'],
  millions: [1]
});

const INT8   = 0x7f;
const INT16  = 0x7fff;
const INT32  = 0x7fffffff;
const UINT8  = INT8 * 2;
const UINT16 = INT16 * 2;
const UINT32 = INT32 * 2;

var mod = {
  setInt8: INT8,
  setInt16: INT16,
  setInt32: INT32,
  setUint8: UINT8,
  setUint16: UINT16,
  setUint32: UINT32
};

function main(conf) {
  var len = +conf.millions * 1e6;
  var ab = new ArrayBuffer(8);
  var dv = new DataView(ab, 0, 8);
  var le = /LE$/.test(conf.type);
  var fn = 'set' + conf.type.replace(/[LB]E$/, '');

  if (/int/i.test(fn))
    benchInt(dv, fn, len, le);
  else
    benchFloat(dv, fn, len, le);
}

function benchInt(dv, fn, len, le) {
  const m = mod[fn];
  const method = dv[fn];
  bench.start();
  for (var i = 0; i < len; i++) {
    method.call(dv, 0, i % m, le);
  }
  bench.end(len / 1e6);
}

function benchFloat(dv, fn, len, le) {
  const method = dv[fn];
  bench.start();
  for (var i = 0; i < len; i++) {
    method.call(dv, 0, i * 0.1, le);
  }
  bench.end(len / 1e6);
}
node-v4.8.2/benchmark/assert/deepequal-prims-and-objs-big-array.js000644 000766 000024 00000001413 13070706730 025206 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var assert = require('assert');

const primValues = {
  'null': null,
  'undefined': undefined,
  'string': 'a',
  'number': 1,
  'boolean': true,
  'object': { 0: 'a' },
  'array': [1, 2, 3],
  'new-array': new Array([1, 2, 3])
};

var bench = common.createBenchmark(main, {
  prim: Object.keys(primValues),
  n: [25]
});

function main(conf) {
  var prim = primValues[conf.prim];
  var n = +conf.n;
  var primArray;
  var primArrayCompare;
  var x;

  primArray = new Array();
  primArrayCompare = new Array();
  for (x = 0; x < (1e5); x++) {
    primArray.push(prim);
    primArrayCompare.push(prim);
  }

  bench.start();
  for (x = 0; x < n; x++) {
    assert.deepEqual(primArray, primArrayCompare);
  }
  bench.end(n);
}
node-v4.8.2/benchmark/assert/deepequal-prims-and-objs-big-loop.js000644 000766 000024 00000001121 13070706730 025035 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var assert = require('assert');

const primValues = {
  'null': null,
  'undefined': undefined,
  'string': 'a',
  'number': 1,
  'boolean': true,
  'object': { 0: 'a' },
  'array': [1, 2, 3],
  'new-array': new Array([1, 2, 3])
};

var bench = common.createBenchmark(main, {
  prim: Object.keys(primValues),
  n: [1e5]
});

function main(conf) {
  var prim = primValues[conf.prim];
  var n = +conf.n;
  var x;

  bench.start();

  for (x = 0; x < n; x++) {
    assert.deepEqual(new Array([prim]), new Array([prim]));
  }

  bench.end(n);
}
node-v4.8.2/benchmark/assert/deepequal-typedarrays.js000644 000766 000024 00000001016 13070706730 023054 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var assert = require('assert');
var bench = common.createBenchmark(main, {
  type: ('Int8Array Uint8Array Int16Array Uint16Array Int32Array Uint32Array ' +
    'Float32Array Float64Array Uint8ClampedArray').split(' '),
  n: [1]
});

function main(conf) {
  var type = conf.type;
  var clazz = global[type];
  var n = +conf.n;

  bench.start();
  var actual = new clazz(n * 1e6);
  var expected = new clazz(n * 1e6);

  assert.deepEqual(actual, expected);

  bench.end(n);
}
node-v4.8.2/benchmark/arrays/var-int.js000644 000766 000024 00000001056 13070706730 020126 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var bench = common.createBenchmark(main, {
  type: ['Array', 'Buffer', 'Int8Array', 'Uint8Array', 'Int16Array',
         'Uint16Array', 'Int32Array', 'Uint32Array', 'Float32Array',
         'Float64Array'],
  n: [25]
});

function main(conf) {
  var type = conf.type;
  var clazz = global[type];
  var n = +conf.n;

  bench.start();
  var arr = new clazz(n * 1e6);
  for (var i = 0; i < 10; ++i) {
    for (var j = 0, k = arr.length; j < k; ++j) {
      arr[j] = (j ^ k) & 127;
    }
  }
  bench.end(n);
}
node-v4.8.2/benchmark/arrays/zero-float.js000644 000766 000024 00000001044 13070706730 020625 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var bench = common.createBenchmark(main, {
  type: ['Array', 'Buffer', 'Int8Array', 'Uint8Array', 'Int16Array',
         'Uint16Array', 'Int32Array', 'Uint32Array', 'Float32Array',
         'Float64Array'],
  n: [25]
});

function main(conf) {
  var type = conf.type;
  var clazz = global[type];
  var n = +conf.n;

  bench.start();
  var arr = new clazz(n * 1e6);
  for (var i = 0; i < 10; ++i) {
    for (var j = 0, k = arr.length; j < k; ++j) {
      arr[j] = 0.0;
    }
  }
  bench.end(n);
}
node-v4.8.2/benchmark/arrays/zero-int.js000644 000766 000024 00000001042 13070706730 020310 0ustar00iojsstaff000000 000000 'use strict';
var common = require('../common.js');
var bench = common.createBenchmark(main, {
  type: ['Array', 'Buffer', 'Int8Array', 'Uint8Array', 'Int16Array',
         'Uint16Array', 'Int32Array', 'Uint32Array', 'Float32Array',
         'Float64Array'],
  n: [25]
});

function main(conf) {
  var type = conf.type;
  var clazz = global[type];
  var n = +conf.n;

  bench.start();
  var arr = new clazz(n * 1e6);
  for (var i = 0; i < 10; ++i) {
    for (var j = 0, k = arr.length; j < k; ++j) {
      arr[j] = 0;
    }
  }
  bench.end(n);
}